@artu-ai/compliance-sdk 0.0.6 → 0.2.0

package/src/resources/mex/actividad-vulnerable/tsc/transactions.ts

@@ -0,0 +1,386 @@
+/**
+ * TSC (Tarjetas de Servicio y Crédito) Transactions Resource
+ *
+ * Extends MexTransactionsResource with TSC-specific behavior:
+ * - Accepts flattened CreateTSCTransactionInput (TSC fields at root level)
+ * - Returns MexTSCTransaction models
+ */
+
+import { z } from "zod";
+import type {
+  CreateTransactionInput,
+  UpdateTransactionInput,
+  ListOptions,
+  PaginatedResponse,
+  CreateTSCTransactionInput,
+  UpdateTSCTransactionInput,
+  AtomicBatchResult,
+  PartialBatchResult,
+  RelatedClient,
+  TSCTransactionFilter,
+} from "@artu-ai/shared";
+import {
+  Jurisdiction,
+  CodigoActividad,
+  createTSCTransactionInputSchema,
+  updateTSCTransactionInputSchema,
+  ClientRole,
+} from "@artu-ai/shared";
+import { MexTransactionsResource } from "../../transactions";
+import { type BatchOptions } from "../../../clients";
+import { MexTSCTransaction, type TransactionData } from "../../../../models";
+
+// ===========================
+// TSCTransactionsResource
+// ===========================
+
+/**
+ * TSC (Tarjetas de Servicio y Crédito) scoped transactions resource.
+ *
+ * @example
+ * ```typescript
+ * const tscSdk = new ComplianceSDK({
+ *   apiKey,
+ *   jurisdiction: Jurisdiction.Mexico,
+ *   actividadVulnerable: CodigoActividad.TSC,
+ * });
+ *
+ * // Create with fully flattened input
+ * const txn = await tscSdk.transactions.create({
+ *   amount: 10000,
+ *   currency: "MXN",
+ *   timestamp: new Date(),
+ *   cardType: "credit",
+ *   idNumber: "4111111111111111",
+ *   operationType: "cardConsumption",
+ * });
+ *
+ * // Returns MexTSCTransaction
+ * console.log(txn.cardType);
+ * ```
+ */
+export class TSCTransactionsResource extends MexTransactionsResource {
+  // ─────────────────────────────────────────────────────────────────
+  // CRUD Operations
+  // ─────────────────────────────────────────────────────────────────
+
+  async create(data: CreateTSCTransactionInput): Promise<MexTSCTransaction> {
+    const validated = this.validate(createTSCTransactionInputSchema, data);
+    const nestedData = this.transformToNested(validated);
+
+    const response = await this.execute(() =>
+      this.trpc.transactions.create.mutate(nestedData)
+    );
+
+    return this.instantiate(response);
+  }
+
+  async retrieve(id: string): Promise<MexTSCTransaction> {
+    const response = await this.execute(() =>
+      this.trpc.transactions.retrieve.query({ id })
+    );
+    return this.instantiate(response);
+  }
+
+  async retrieveByMetadata(
+    key: string,
+    value: string
+  ): Promise<MexTSCTransaction> {
+    const response = await this.execute(() =>
+      this.trpc.transactions.retrieveByMetadata.query({ key, value })
+    );
+    return this.instantiate(response);
+  }
+
+  async update(
+    id: string,
+    data: UpdateTSCTransactionInput
+  ): Promise<MexTSCTransaction> {
+    const validated = this.validate(updateTSCTransactionInputSchema, data);
+    const nestedData = this.transformUpdateToNested(validated);
+
+    const response = await this.execute(() =>
+      this.trpc.transactions.update.mutate({ id, data: nestedData })
+    );
+    return this.instantiate(response);
+  }
+
+  // ─────────────────────────────────────────────────────────────────
+  // List & Pagination
+  // ─────────────────────────────────────────────────────────────────
+
+  /**
+   * Lists TSC transactions with optional filtering.
+   *
+   * Accepts flattened TSC filter (future TSC-specific transaction fields at root level).
+   */
+  async list(
+    options?: ListOptions<TSCTransactionFilter>
+  ): Promise<PaginatedResponse<MexTSCTransaction>> {
+    const scopedFilter = this.applyScopeToFilter(options?.filter);
+
+    const response = await this.execute(() =>
+      this.trpc.transactions.list.query({
+        ...options,
+        filter: scopedFilter,
+      })
+    );
+
+    return {
+      data: response.data.map((t) => this.instantiate(t)),
+      pagination: response.pagination,
+    };
+  }
+
+  /**
+   * Iterates over TSC transactions.
+   *
+   * Accepts flattened TSC filter (future TSC-specific transaction fields at root level).
+   */
+  iterate(
+    filter?: TSCTransactionFilter
+  ): AsyncGenerator<MexTSCTransaction, void, undefined> {
+    const scopedFilter = this.applyScopeToFilter(filter);
+    return this.createIterator<MexTSCTransaction>({ filter: scopedFilter });
+  }
+
+  // ─────────────────────────────────────────────────────────────────
+  // Client Relationship Management (scoped returns)
+  // ─────────────────────────────────────────────────────────────────
+
+  async listByClient(
+    clientId: string,
+    options?: { cursor?: string; limit?: number }
+  ): Promise<PaginatedResponse<MexTSCTransaction>> {
+    const response = await this.execute(() =>
+      this.trpc.transactions.listByClient.query({ clientId, ...options })
+    );
+
+    return {
+      data: response.data.map((t) => this.instantiate(t)),
+      pagination: response.pagination,
+    };
+  }
+
+  async linkClient(
+    transactionId: string,
+    clientId: string,
+    role?: ClientRole
+  ): Promise<MexTSCTransaction> {
+    const response = await this.execute(() =>
+      this.trpc.transactions.linkClient.mutate({
+        transactionId,
+        clientId,
+        role,
+      })
+    );
+    return this.instantiate(response);
+  }
+
+  async unlinkClient(
+    transactionId: string,
+    clientId: string
+  ): Promise<MexTSCTransaction> {
+    const response = await this.execute(() =>
+      this.trpc.transactions.unlinkClient.mutate({
+        transactionId,
+        clientId,
+      })
+    );
+    return this.instantiate(response);
+  }
+
+  async setClients(
+    transactionId: string,
+    clients: RelatedClient[]
+  ): Promise<MexTSCTransaction> {
+    const response = await this.execute(() =>
+      this.trpc.transactions.setClients.mutate({
+        transactionId,
+        clients,
+      })
+    );
+    return this.instantiate(response);
+  }
+
+  // ─────────────────────────────────────────────────────────────────
+  // Batch Operations
+  // ─────────────────────────────────────────────────────────────────
+
+  async createMany(
+    transactions: CreateTSCTransactionInput[],
+    options?: { atomic?: true }
+  ): Promise<AtomicBatchResult<MexTSCTransaction>>;
+  async createMany(
+    transactions: CreateTSCTransactionInput[],
+    options: { atomic: false }
+  ): Promise<PartialBatchResult<MexTSCTransaction>>;
+  async createMany(
+    transactions: CreateTSCTransactionInput[],
+    options: BatchOptions = {}
+  ): Promise<
+    AtomicBatchResult<MexTSCTransaction> | PartialBatchResult<MexTSCTransaction>
+  > {
+    const atomic = options.atomic ?? true;
+    const validated = this.validate(
+      z.array(createTSCTransactionInputSchema),
+      transactions
+    );
+    const nestedItems = validated.map((t) => this.transformToNested(t));
+
+    const response = await this.execute(() =>
+      this.trpc.transactions.createMany.mutate({ items: nestedItems, atomic })
+    );
+
+    if (response.atomic) {
+      return {
+        atomic: true,
+        data: response.data.map((t) => this.instantiate(t)),
+      };
+    } else {
+      return {
+        atomic: false,
+        succeeded: response.succeeded.map((item) => ({
+          index: item.index,
+          data: this.instantiate(item.data),
+        })),
+        failed: response.failed,
+      };
+    }
+  }
+
+  async updateMany(
+    updates: { id: string; data: UpdateTSCTransactionInput }[],
+    options?: { atomic?: true }
+  ): Promise<AtomicBatchResult<MexTSCTransaction>>;
+  async updateMany(
+    updates: { id: string; data: UpdateTSCTransactionInput }[],
+    options: { atomic: false }
+  ): Promise<PartialBatchResult<MexTSCTransaction>>;
+  async updateMany(
+    updates: { id: string; data: UpdateTSCTransactionInput }[],
+    options: BatchOptions = {}
+  ): Promise<
+    AtomicBatchResult<MexTSCTransaction> | PartialBatchResult<MexTSCTransaction>
+  > {
+    const atomic = options.atomic ?? true;
+    const updateItemSchema = z.object({
+      id: z.uuid(),
+      data: updateTSCTransactionInputSchema,
+    });
+
+    const validated = this.validate(z.array(updateItemSchema), updates);
+    const nestedUpdates = validated.map((u) => ({
+      id: u.id,
+      data: this.transformUpdateToNested(u.data),
+    }));
+
+    const response = await this.execute(() =>
+      this.trpc.transactions.updateMany.mutate({ items: nestedUpdates, atomic })
+    );
+
+    if (response.atomic) {
+      return {
+        atomic: true,
+        data: response.data.map((t) => this.instantiate(t)),
+      };
+    } else {
+      return {
+        atomic: false,
+        succeeded: response.succeeded.map((item) => ({
+          index: item.index,
+          data: this.instantiate(item.data),
+        })),
+        failed: response.failed,
+      };
+    }
+  }
+
+  // ─────────────────────────────────────────────────────────────────
+  // Protected Helpers
+  // ─────────────────────────────────────────────────────────────────
+
+  protected override transformToNested(
+    data: CreateTSCTransactionInput
+  ): CreateTransactionInput {
+    const {
+      amount,
+      currency,
+      timestamp,
+      relatedClientIds,
+      description,
+      externalId,
+      metadata,
+      cardType,
+      idNumber,
+      operationType,
+    } = data;
+
+    // Build base fields (relatedClientIds is required)
+    const baseFields: Record<string, unknown> = {
+      amount,
+      currency,
+      timestamp,
+      relatedClientIds,
+    };
+    if (description !== undefined) baseFields.description = description;
+    if (externalId !== undefined) baseFields.externalId = externalId;
+    if (metadata !== undefined) baseFields.metadata = metadata;
+
+    // TSC-specific fields (operationType has a default from schema)
+    const tscFields: Record<string, unknown> = {
+      cardType,
+      idNumber,
+      operationType,
+    };
+
+    return {
+      ...baseFields,
+      primaryJurisdiction: Jurisdiction.Mexico,
+      jurisdictions: {
+        MX: {
+          actividadVulnerable: {
+            [CodigoActividad.TSC]: tscFields,
+          },
+        },
+      },
+    } as CreateTransactionInput;
+  }
+
+  protected override transformUpdateToNested(
+    data: UpdateTSCTransactionInput
+  ): UpdateTransactionInput {
+    // Cast to access fields - Zod validation ensures correctness
+    const input = data as Record<string, unknown>;
+    const { status, description, externalId, metadata, primaryJurisdiction, cardType, idNumber, operationType } = input;
+
+    // Build base update fields
+    const result: UpdateTransactionInput = {};
+    if (status !== undefined) result.status = status as UpdateTransactionInput["status"];
+    if (description !== undefined) result.description = description as string;
+    if (externalId !== undefined) result.externalId = externalId as string;
+    if (metadata !== undefined) result.metadata = metadata as Record<string, unknown>;
+    if (primaryJurisdiction !== undefined) result.primaryJurisdiction = primaryJurisdiction as UpdateTransactionInput["primaryJurisdiction"];
+
+    // If TSC fields are present (all-or-nothing), nest them in jurisdictions
+    if (cardType !== undefined) {
+      (result as Record<string, unknown>).jurisdictions = {
+        MX: {
+          actividadVulnerable: {
+            [CodigoActividad.TSC]: {
+              cardType,
+              idNumber,
+              operationType,
+            },
+          },
+        },
+      };
+    }
+
+    return result;
+  }
+
+  protected override instantiate(data: TransactionData): MexTSCTransaction {
+    return new MexTSCTransaction(data);
+  }
+}