feat(api): add alert endpoints for transfer check (#484)

packages/app-builder/src/models/transfer-alert.ts

@@ -0,0 +1,100 @@
+import {
+  type CreateTransferAlertDto,
+  type TransferAlertDto,
+  type UpdateTransferAlertDto,
+} from 'marble-api/generated/transfercheck-api';
+
+export type TransferAlerStatus = 'unread' | 'read' | 'archived';
+
+export type TransferAlertType = 'sender' | 'beneficiary';
+
+export interface TransferAlert {
+  id: string;
+  type: TransferAlertType;
+  transferId: string;
+  senderPartnerId: string;
+  beneficiaryPartnerId: string;
+  createdAt: string;
+  status: TransferAlerStatus;
+  message: string;
+  transferEndToEndId: string;
+  beneficiaryIban: string;
+  senderIban: string;
+}
+
+export function adaptTransferAlert(
+  dto: TransferAlertDto,
+  partnerId: string,
+): TransferAlert {
+  let type: TransferAlertType;
+  if (dto.sender_partner_id === partnerId) {
+    type = 'sender';
+  } else if (dto.beneficiary_partner_id === partnerId) {
+    type = 'beneficiary';
+  } else {
+    throw new Error('Invalid partner id');
+  }
+  return {
+    id: dto.id,
+    transferId: dto.transfer_id,
+    type,
+    senderPartnerId: dto.sender_partner_id,
+    beneficiaryPartnerId: dto.beneficiary_partner_id,
+    createdAt: dto.created_at,
+    status: dto.status,
+    message: dto.message,
+    transferEndToEndId: dto.transfer_end_to_end_id,
+    beneficiaryIban: dto.beneficiary_iban,
+    senderIban: dto.sender_iban,
+  };
+}
+
+export interface CreateTransferAlert {
+  transferId: string;
+  message: string;
+  transferEndToEndId: string;
+  beneficiaryIban: string;
+  senderIban: string;
+}
+
+export function adaptCreateTransferAlertDto(
+  createTransferAlert: CreateTransferAlert,
+): CreateTransferAlertDto {
+  return {
+    transfer_id: createTransferAlert.transferId,
+    message: createTransferAlert.message,
+    transfer_end_to_end_id: createTransferAlert.transferEndToEndId,
+    beneficiary_iban: createTransferAlert.beneficiaryIban,
+    sender_iban: createTransferAlert.senderIban,
+  };
+}
+
+export type UpdateTransferAlert =
+  | {
+      type: 'sender';
+      message: string;
+      transferEndToEndId: string;
+      beneficiaryIban: string;
+      senderIban: string;
+    }
+  | {
+      type: 'beneficiary';
+      status: TransferAlerStatus;
+    };
+
+export function adaptUpdateTransferAlertDto(
+  updateTransferAlert: UpdateTransferAlert,
+): UpdateTransferAlertDto {
+  if (updateTransferAlert.type === 'sender') {
+    return {
+      message: updateTransferAlert.message,
+      transfer_end_to_end_id: updateTransferAlert.transferEndToEndId,
+      beneficiary_iban: updateTransferAlert.beneficiaryIban,
+      sender_iban: updateTransferAlert.senderIban,
+    };
+  } else {
+    return {
+      status: updateTransferAlert.status,
+    };
+  }
+}

packages/app-builder/src/models/transfer.ts

@@ -3,6 +3,8 @@ import {
   type TransferDto,
 } from 'marble-api/generated/transfercheck-api';
 
+export type TransferStatus = 'neutral' | 'suspected_fraud' | 'confirmed_fraud';
+
 export interface TransferData {
   beneficiaryBic: string;
   beneficiaryIban: string;
@@ -14,7 +16,7 @@ export interface TransferData {
   senderBic: string;
   senderDevice: string;
   senderIp: string;
-  status: 'neutral' | 'suspected_fraud' | 'confirmed_fraud';
+  status: TransferStatus;
   timezone: string;
   partnerTransferId: string;
   transferRequestedAt: string;
@@ -62,5 +64,5 @@ export function adaptTransfer(transferDto: TransferDto): Transfer {
 }
 
 export interface TransferUpdateBody {
-  status: 'neutral' | 'suspected_fraud' | 'confirmed_fraud';
+  status: TransferStatus;
 }

packages/app-builder/src/repositories/TransferAlertRepository.ts

@@ -0,0 +1,66 @@
+import { type TransfercheckApi } from '@app-builder/infra/transfercheck-api';
+import {
+  adaptCreateTransferAlertDto,
+  adaptTransferAlert,
+  adaptUpdateTransferAlertDto,
+  type CreateTransferAlert,
+  type TransferAlert,
+  type UpdateTransferAlert,
+} from '@app-builder/models/transfer-alert';
+import invariant from 'tiny-invariant';
+
+export interface TransferAlertRepository {
+  listAlerts(): Promise<TransferAlert[]>;
+  createAlert(args: CreateTransferAlert): Promise<TransferAlert>;
+  getAlert(args: { alertId: string }): Promise<TransferAlert>;
+  updateAlert(
+    alertId: string,
+    updateTransferAlert: UpdateTransferAlert,
+  ): Promise<TransferAlert>;
+}
+
+export function makeGetTransferAlertRepository() {
+  return (
+    transfercheckApi: TransfercheckApi,
+    // TODO: make partnerId required (need to split init.server.ts into multiple files)
+    partnerId?: string,
+  ): TransferAlertRepository => ({
+    listAlerts: async () => {
+      // TODO: make partnerId required (need to split init.server.ts into multiple files)
+      invariant(partnerId, 'partnerId is required');
+
+      const { alerts } = await transfercheckApi.listAlerts();
+
+      return alerts.map((alert) => adaptTransferAlert(alert, partnerId));
+    },
+    createAlert: async (createTransferAlert) => {
+      // TODO: make partnerId required (need to split init.server.ts into multiple files)
+      invariant(partnerId, 'partnerId is required');
+
+      const { alert } = await transfercheckApi.createAlert(
+        adaptCreateTransferAlertDto(createTransferAlert),
+      );
+
+      return adaptTransferAlert(alert, partnerId);
+    },
+    getAlert: async ({ alertId }) => {
+      // TODO: make partnerId required (need to split init.server.ts into multiple files)
+      invariant(partnerId, 'partnerId is required');
+
+      const { alert } = await transfercheckApi.getAlert(alertId);
+
+      return adaptTransferAlert(alert, partnerId);
+    },
+    updateAlert: async (alertId, updateTransferAlert) => {
+      // TODO: make partnerId required (need to split init.server.ts into multiple files)
+      invariant(partnerId, 'partnerId is required');
+
+      const { alert } = await transfercheckApi.updateAlert(
+        alertId,
+        adaptUpdateTransferAlertDto(updateTransferAlert),
+      );
+
+      return adaptTransferAlert(alert, partnerId);
+    },
+  });
+}

packages/app-builder/src/repositories/init.server.ts

@@ -20,6 +20,7 @@ import {
   getToastStorageRepository,
   type SessionStorageRepositoryOptions,
 } from './SessionStorageRepositories';
+import { makeGetTransferAlertRepository } from './TransferAlertRepository';
 import { makeGetTransferRepository } from './TransferRepository';
 import { makeGetUserRepository } from './UserRepository';
 
@@ -60,6 +61,7 @@ export function makeServerRepositories({
     getAnalyticsRepository: makeGetAnalyticsRepository(),
     getTransferRepository: makeGetTransferRepository(),
     getPartnerRepository: makeGetPartnerRepository(),
+    getTransferAlertRepository: makeGetTransferAlertRepository(),
     licenseRepository: getLicenseRepository(licenseAPIClient, devEnvironment),
   };
 }

packages/app-builder/src/services/auth/auth.server.ts

@@ -23,6 +23,7 @@ import { type OrganizationRepository } from '@app-builder/repositories/Organizat
 import { type PartnerRepository } from '@app-builder/repositories/PartnerRepository';
 import { type ScenarioIterationRuleRepository } from '@app-builder/repositories/ScenarioIterationRuleRepository';
 import { type ScenarioRepository } from '@app-builder/repositories/ScenarioRepository';
+import { type TransferAlertRepository } from '@app-builder/repositories/TransferAlertRepository';
 import { type TransferRepository } from '@app-builder/repositories/TransferRepository';
 import { type UserRepository } from '@app-builder/repositories/UserRepository';
 import { getServerEnv } from '@app-builder/utils/environment';
@@ -49,6 +50,7 @@ interface AuthenticatedInfo {
   analytics: AnalyticsRepository;
   transferRepository: TransferRepository;
   partnerRepository: PartnerRepository;
+  transferAlertRepository: TransferAlertRepository;
   organization: OrganizationRepository;
   scenario: ScenarioRepository;
   scenarioIterationRuleRepository: ScenarioIterationRuleRepository;
@@ -130,6 +132,10 @@ interface MakeAuthenticationServerServiceArgs {
   getPartnerRepository: (
     transfercheckApi: TransfercheckApi,
   ) => PartnerRepository;
+  getTransferAlertRepository: (
+    transfercheckApi: TransfercheckApi,
+    partnerId?: string,
+  ) => TransferAlertRepository;
   authSessionService: SessionService<AuthData, AuthFlashData>;
   csrfService: CSRF;
 }
@@ -150,6 +156,7 @@ export function makeAuthenticationServerService({
   getAnalyticsRepository,
   getTransferRepository,
   getPartnerRepository,
+  getTransferAlertRepository,
   authSessionService,
   csrfService,
 }: MakeAuthenticationServerServiceArgs) {
@@ -324,6 +331,10 @@ export function makeAuthenticationServerService({
       analytics: getAnalyticsRepository(marbleCoreApiClient),
       transferRepository: getTransferRepository(transfercheckAPIClient),
       partnerRepository: getPartnerRepository(transfercheckAPIClient),
+      transferAlertRepository: getTransferAlertRepository(
+        transfercheckAPIClient,
+        user.partnerId,
+      ),
       user,
       inbox: getInboxRepository(marbleCoreApiClient),
     };