refactor(nestjs): contacts module

packages/server/src/modules/Contacts/Contacts.constants.ts

@@ -0,0 +1,6 @@
+
+
+export const ERRORS = {
+  CONTACT_ALREADY_ACTIVE: 'CONTACT_ALREADY_ACTIVE',
+  CONTACT_ALREADY_INACTIVE: 'CONTACT_ALREADY_INACTIVE'
+}

packages/server/src/modules/Contacts/Contacts.controller.ts

@@ -0,0 +1,45 @@
+import {
+  Controller,
+  Get,
+  Query,
+  Param,
+  Post,
+  ParseIntPipe,
+} from '@nestjs/common';
+import { ApiTags, ApiOperation, ApiParam } from '@nestjs/swagger';
+import { GetContactsAutoCompleteQuery } from './dtos/GetContactsAutoCompleteQuery.dto';
+import { GetAutoCompleteContactsService } from './queries/GetAutoCompleteContacts.service';
+import { ActivateContactService } from './commands/ActivateContact.service';
+import { InactivateContactService } from './commands/InactivateContact.service';
+
+@Controller('contacts')
+@ApiTags('contacts')
+export class ContactsController {
+  constructor(
+    private readonly getAutoCompleteService: GetAutoCompleteContactsService,
+    private readonly activateContactService: ActivateContactService,
+    private readonly inactivateContactService: InactivateContactService,
+  ) {}
+
+  @Get('auto-complete')
+  @ApiOperation({ summary: 'Get the auto-complete contacts' })
+  getAutoComplete(@Query() query: GetContactsAutoCompleteQuery) {
+    return this.getAutoCompleteService.autocompleteContacts(query);
+  }
+
+  @Post(':id/activate')
+  @ApiOperation({ summary: 'Activate a contact' })
+  @ApiParam({ name: 'id', type: 'number', description: 'Contact ID' })
+  async activateContact(@Param('id', ParseIntPipe) contactId: number) {
+    await this.activateContactService.activateContact(contactId);
+    return { id: contactId, activated: true };
+  }
+
+  @Post(':id/inactivate')
+  @ApiOperation({ summary: 'Inactivate a contact' })
+  @ApiParam({ name: 'id', type: 'number', description: 'Contact ID' })
+  async inactivateContact(@Param('id', ParseIntPipe) contactId: number) {
+    await this.inactivateContactService.inactivateContact(contactId);
+    return { id: contactId, inactivated: true };
+  }
+}

packages/server/src/modules/Contacts/Contacts.module.ts

@@ -0,0 +1,15 @@
+import { Module } from '@nestjs/common';
+import { GetAutoCompleteContactsService } from './queries/GetAutoCompleteContacts.service';
+import { ContactsController } from './Contacts.controller';
+import { ActivateContactService } from './commands/ActivateContact.service';
+import { InactivateContactService } from './commands/InactivateContact.service';
+
+@Module({
+  providers: [
+    GetAutoCompleteContactsService,
+    ActivateContactService,
+    InactivateContactService,
+  ],
+  controllers: [ContactsController],
+})
+export class ContactsModule {}

packages/server/src/modules/Contacts/Contacts.types.ts

@@ -0,0 +1,14 @@
+import { IFilterRole } from '../DynamicListing/DynamicFilter/DynamicFilter.types';
+
+export interface IContactsAutoCompleteFilter {
+  limit: number;
+  keyword: string;
+  filterRoles?: IFilterRole[];
+  columnSortBy: string;
+  sortOrder: string;
+}
+
+export interface IContactAutoCompleteItem {
+  displayName: string;
+  contactService: string;
+}

packages/server/src/modules/Contacts/commands/ActivateContact.service.ts

@@ -0,0 +1,28 @@
+import { ServiceError } from '@/modules/Items/ServiceError';
+import { Contact } from '../models/Contact';
+import { TenantModelProxy } from '@/modules/System/models/TenantBaseModel';
+import { Inject, Injectable } from '@nestjs/common';
+import { ERRORS } from '../Contacts.constants';
+
+@Injectable()
+export class ActivateContactService {
+  constructor(
+    @Inject(Contact.name)
+    private readonly contactModel: TenantModelProxy<typeof Contact>,
+  ) {}
+
+  async activateContact(contactId: number) {
+    const contact = await this.contactModel()
+      .query()
+      .findById(contactId)
+      .throwIfNotFound();
+
+    if (contact.active) {
+      throw new ServiceError(ERRORS.CONTACT_ALREADY_ACTIVE);
+    }
+    await this.contactModel()
+      .query()
+      .findById(contactId)
+      .update({ active: true });
+  }
+}

packages/server/src/modules/Contacts/commands/InactivateContact.service.ts

@@ -0,0 +1,28 @@
+import { Inject, Injectable } from '@nestjs/common';
+import { ServiceError } from '@/modules/Items/ServiceError';
+import { Contact } from '../models/Contact';
+import { TenantModelProxy } from '@/modules/System/models/TenantBaseModel';
+import { ERRORS } from '../Contacts.constants';
+
+@Injectable()
+export class InactivateContactService {
+  constructor(
+    @Inject(Contact.name)
+    private readonly contactModel: TenantModelProxy<typeof Contact>,
+  ) {}
+
+  async inactivateContact(contactId: number) {
+    const contact = await this.contactModel()
+      .query()
+      .findById(contactId)
+      .throwIfNotFound();
+
+    if (!contact.active) {
+      throw new ServiceError(ERRORS.CONTACT_ALREADY_INACTIVE);
+    }
+    await this.contactModel()
+      .query()
+      .findById(contactId)
+      .update({ active: false });
+  }
+}

packages/server/src/modules/Contacts/dtos/GetContactsAutoCompleteQuery.dto.ts

@@ -0,0 +1,11 @@
+import { IsNumber, IsOptional, IsString } from 'class-validator';
+
+export class GetContactsAutoCompleteQuery {
+  @IsNumber()
+  @IsOptional()
+  limit: number;
+
+  @IsString()
+  @IsOptional()
+  keyword: string;
+}

packages/server/src/modules/Contacts/queries/GetAutoCompleteContacts.service.ts

@@ -0,0 +1,39 @@
+import { TenantModelProxy } from '@/modules/System/models/TenantBaseModel';
+import { Contact } from '../models/Contact';
+import { Inject, Injectable } from '@nestjs/common';
+import { IContactsAutoCompleteFilter } from '../Contacts.types';
+import { GetContactsAutoCompleteQuery } from '../dtos/GetContactsAutoCompleteQuery.dto';
+
+@Injectable()
+export class GetAutoCompleteContactsService {
+  constructor(
+    @Inject(Contact.name)
+    private readonly contactModel: TenantModelProxy<typeof Contact>,
+  ) {}
+
+  /**
+   * Retrieve auto-complete contacts list.
+   * @param {number} tenantId -
+   * @param {IContactsAutoCompleteFilter} contactsFilter -
+   * @return {IContactAutoCompleteItem}
+   */
+  async autocompleteContacts(queryDto: GetContactsAutoCompleteQuery) {
+    const _queryDto = {
+      filterRoles: [],
+      sortOrder: 'asc',
+      columnSortBy: 'display_name',
+      limit: 10,
+      ...queryDto,
+    };
+    // Retrieve contacts list by the given query.
+    const contacts = await this.contactModel()
+      .query()
+      .onBuild((builder) => {
+        if (_queryDto.keyword) {
+          builder.where('display_name', 'LIKE', `%${_queryDto.keyword}%`);
+        }
+        builder.limit(_queryDto.limit);
+      });
+    return contacts;
+  }
+}