refactor(nestjs): wip

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

@@ -0,0 +1,22 @@
+import { Body, Controller, Post } from '@nestjs/common';
+import { PlaidApplication } from './PlaidApplication';
+import { PlaidItemDto } from './dtos/PlaidItem.dto';
+import { ApiOperation, ApiTags } from '@nestjs/swagger';
+
+@Controller('banking/plaid')
+@ApiTags('banking-plaid')
+export class BankingPlaidController {
+  constructor(private readonly plaidApplication: PlaidApplication) {}
+
+  @Post('link-token')
+  @ApiOperation({ summary: 'Get Plaid link token' })
+  getLinkToken() {
+    return this.plaidApplication.getLinkToken();
+  }
+
+  @Post('exchange-token')
+  @ApiOperation({ summary: 'Exchange Plaid access token' })
+  exchangeToken(@Body() itemDTO: PlaidItemDto) {
+    return this.plaidApplication.exchangeToken(itemDTO);
+  }
+}

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

@@ -15,6 +15,7 @@ import { PlaidItemService } from './command/PlaidItem';
 import { TenancyContext } from '../Tenancy/TenancyContext.service';
 import { InjectSystemModel } from '../System/SystemModels/SystemModels.module';
 import { SystemPlaidItem } from './models/SystemPlaidItem';
+import { BankingPlaidController } from './BankingPlaid.controller';
 
 const models = [RegisterTenancyModel(PlaidItem)];
 
@@ -38,5 +39,6 @@ const models = [RegisterTenancyModel(PlaidItem)];
     TenancyContext,
   ],
   exports: [...models],
+  controllers: [BankingPlaidController]
 })
 export class BankingPlaidModule {}

packages/server/src/modules/BankingPlaid/PlaidApplication.ts

@@ -3,6 +3,7 @@ import { PlaidItemService } from './command/PlaidItem';
 import { PlaidWebooks } from './command/PlaidWebhooks';
 import { Injectable } from '@nestjs/common';
 import { PlaidItemDTO } from './types/BankingPlaid.types';
+import { PlaidItemDto } from './dtos/PlaidItem.dto';
 
 @Injectable()
 export class PlaidApplication {
@@ -25,7 +26,7 @@ export class PlaidApplication {
    * @param {PlaidItemDTO} itemDTO
    * @returns
    */
-  public exchangeToken(itemDTO: PlaidItemDTO): Promise<void> {
+  public exchangeToken(itemDTO: PlaidItemDto): Promise<void> {
     return this.plaidItemService.item(itemDTO);
   }
 

packages/server/src/modules/BankingPlaid/command/PlaidItem.ts

@@ -6,11 +6,9 @@ import { EventEmitter2 } from '@nestjs/event-emitter';
 import { events } from '@/common/events/events';
 import { SystemPlaidItem } from '../models/SystemPlaidItem';
 import { TenancyContext } from '@/modules/Tenancy/TenancyContext.service';
-import {
-  IPlaidItemCreatedEventPayload,
-  PlaidItemDTO,
-} from '../types/BankingPlaid.types';
+import { IPlaidItemCreatedEventPayload } from '../types/BankingPlaid.types';
 import { TenantModelProxy } from '@/modules/System/models/TenantBaseModel';
+import { PlaidItemDto } from '../dtos/PlaidItem.dto';
 
 @Injectable()
 export class PlaidItemService {
@@ -33,10 +31,10 @@ export class PlaidItemService {
   /**
    * Exchanges the public token to get access token and item id and then creates
    * a new Plaid item.
-   * @param {PlaidItemDTO} itemDTO - Plaid item data transfer object.
+   * @param {PlaidItemDto} itemDTO - Plaid item data transfer object.
    * @returns {Promise<void>}
    */
-  public async item(itemDTO: PlaidItemDTO): Promise<void> {
+  public async item(itemDTO: PlaidItemDto): Promise<void> {
     const { publicToken, institutionId } = itemDTO;
 
     const tenant = await this.tenancyContext.getTenant();

packages/server/src/modules/BankingPlaid/command/PlaidUpdateTransactions.ts

@@ -15,6 +15,13 @@ import { TenantModelProxy } from '@/modules/System/models/TenantBaseModel';
 
 @Injectable()
 export class PlaidUpdateTransactions {
+  /**
+   * Constructor method.
+   * @param {PlaidSyncDb} plaidSync - Plaid sync service.
+   * @param {UnitOfWork} uow - Unit of work.
+   * @param {TenantModelProxy<typeof PlaidItem>} plaidItemModel - Plaid item model.
+   * @param {PlaidApi} plaidClient - Plaid client.
+   */
   constructor(
     private readonly plaidSync: PlaidSyncDb,
     private readonly uow: UnitOfWork,
@@ -28,8 +35,7 @@ export class PlaidUpdateTransactions {
 
   /**
    * Handles sync the Plaid item to Bigcaptial under UOW.
-   * @param {number} tenantId - Tenant id.
-   * @param {number} plaidItemId - Plaid item id.
+   * @param {string} plaidItemId - Plaid item id.
    * @returns {Promise<{ addedCount: number; modifiedCount: number; removedCount: number; }>}
    */
   public async updateTransactions(plaidItemId: string) {
@@ -44,9 +50,9 @@ export class PlaidUpdateTransactions {
    *  - New bank accounts.
    *  - Last accounts feeds updated at.
    *  - Turn on the accounts feed flag.
-   * @param {number} tenantId - Tenant ID.
    * @param {string} plaidItemId - The Plaid ID for the item.
-   * @returns {Promise<{  addedCount: number; modifiedCount: number; removedCount: number; }>}
+   * @param {Knex.Transaction} trx - Knex transaction.
+   * @returns {Promise<{ addedCount: number; modifiedCount: number; removedCount: number; }>}
    */
   public async updateTransactionsWork(
     plaidItemId: string,

packages/server/src/modules/BankingPlaid/dtos/PlaidItem.dto.ts

@@ -0,0 +1,11 @@
+import { IsNotEmpty, IsString } from 'class-validator';
+
+export class PlaidItemDto {
+  @IsString()
+  @IsNotEmpty()
+  publicToken: string;
+
+  @IsString()
+  @IsNotEmpty()
+  institutionId: string;
+}