feat(nestjs): migrate to NestJS

2026-02-16 12:50:38 +00:00 · 2025-04-07 11:51:24 +02:00
parent f068218a16
commit 55fcc908ef
3779 changed files with 631 additions and 195332 deletions
--- a/packages/server/src/modules/BankingPlaid/command/PlaidWebhooks.ts
+++ b/packages/server/src/modules/BankingPlaid/command/PlaidWebhooks.ts
@@ -0,0 +1,152 @@
+import { PlaidItem } from '../models/PlaidItem';
+import { PlaidUpdateTransactions } from './PlaidUpdateTransactions';
+import { Inject, Injectable } from '@nestjs/common';
+
+@Injectable()
+export class PlaidWebooks {
+  constructor(
+    private readonly updateTransactionsService: PlaidUpdateTransactions,
+
+    @Inject(PlaidItem.name)
+    private readonly plaidItemModel: typeof PlaidItem,
+  ) {}
+
+  /**
+   * Listens to Plaid webhooks
+   * @param {string} webhookType - Webhook type.
+   * @param {string} plaidItemId - Plaid item Id.
+   * @param {string} webhookCode - webhook code.
+   */
+  public async webhooks(
+    plaidItemId: string,
+    webhookType: string,
+    webhookCode: string,
+  ): Promise<void> {
+    const _webhookType = webhookType.toLowerCase();
+
+    // There are five types of webhooks: AUTH, TRANSACTIONS, ITEM, INCOME, and ASSETS.
+    // @TODO implement handling for remaining webhook types.
+    const webhookHandlerMap = {
+      transactions: this.handleTransactionsWebooks.bind(this),
+      item: this.itemsHandler.bind(this),
+    };
+    const webhookHandler =
+      webhookHandlerMap[_webhookType] || this.unhandledWebhook;
+
+    await webhookHandler(plaidItemId, webhookCode);
+  }
+
+  /**
+   * Handles all unhandled/not yet implemented webhook events.
+   * @param {string} webhookType - Webhook type.
+   * @param {string} webhookCode - Webhook code.
+   * @param {string} plaidItemId - Plaid item id.
+   */
+  private async unhandledWebhook(
+    webhookType: string,
+    webhookCode: string,
+    plaidItemId: string,
+  ): Promise<void> {
+    console.log(
+      `UNHANDLED ${webhookType} WEBHOOK: ${webhookCode}: Plaid item id ${plaidItemId}: unhandled webhook type received.`,
+    );
+  }
+
+  /**
+   * Logs to console and emits to socket
+   * @param {string} additionalInfo - Additional info.
+   * @param {string} webhookCode - Webhook code.
+   * @param {string} plaidItemId - Plaid item id.
+   */
+  private serverLogAndEmitSocket(
+    additionalInfo: string,
+    webhookCode: string,
+    plaidItemId: string,
+  ): void {
+    console.log(
+      `PLAID WEBHOOK: TRANSACTIONS: ${webhookCode}: Plaid_item_id ${plaidItemId}: ${additionalInfo}`,
+    );
+  }
+
+  /**
+   * Handles all transaction webhook events. The transaction webhook notifies
+   * you that a single item has new transactions available.
+   * @param {string} plaidItemId - Plaid item id.
+   * @param {string} webhookCode - Webhook code.
+   * @returns {Promise<void>}
+   */
+  public async handleTransactionsWebooks(
+    tenantId: number,
+    plaidItemId: string,
+    webhookCode: string,
+  ): Promise<void> {
+    const plaidItem = await this.plaidItemModel
+      .query()
+      .findOne({ plaidItemId })
+      .throwIfNotFound();
+
+    switch (webhookCode) {
+      case 'SYNC_UPDATES_AVAILABLE': {
+        if (plaidItem.isPaused) {
+          this.serverLogAndEmitSocket(
+            'Plaid item syncing is paused.',
+            webhookCode,
+            plaidItemId,
+          );
+          return;
+        }
+        // Fired when new transactions data becomes available.
+        const { addedCount, modifiedCount, removedCount } =
+          await this.updateTransactionsService.updateTransactions(plaidItemId);
+
+        this.serverLogAndEmitSocket(
+          `Transactions: ${addedCount} added, ${modifiedCount} modified, ${removedCount} removed`,
+          webhookCode,
+          plaidItemId,
+        );
+        break;
+      }
+      case 'DEFAULT_UPDATE':
+      case 'INITIAL_UPDATE':
+      case 'HISTORICAL_UPDATE':
+        /* ignore - not needed if using sync endpoint + webhook */
+        break;
+      default:
+        this.serverLogAndEmitSocket(
+          `unhandled webhook type received.`,
+          webhookCode,
+          plaidItemId,
+        );
+    }
+  }
+
+  /**
+   * Handles all Item webhook events.
+   * @param {number} tenantId - Tenant ID
+   * @param {string} webhookCode - The webhook code
+   * @param {string} plaidItemId - The Plaid ID for the item
+   * @returns {Promise<void>}
+   */
+  public async itemsHandler(
+    plaidItemId: string,
+    webhookCode: string,
+  ): Promise<void> {
+    switch (webhookCode) {
+      case 'WEBHOOK_UPDATE_ACKNOWLEDGED':
+        this.serverLogAndEmitSocket('is updated', webhookCode, plaidItemId);
+        break;
+      case 'ERROR': {
+        break;
+      }
+      case 'PENDING_EXPIRATION': {
+        break;
+      }
+      default:
+        this.serverLogAndEmitSocket(
+          'unhandled webhook type received.',
+          webhookCode,
+          plaidItemId,
+        );
+    }
+  }
+}