@artu-ai/compliance-sdk 0.0.6 → 0.3.0

package/src/resources/mex/transactions.ts

@@ -0,0 +1,422 @@
+/**
+ * Mexico Transactions Resource
+ *
+ * Extends TransactionsResource with Mexico-specific behavior:
+ * - Accepts flattened CreateMexTransactionInput (MX fields at root level)
+ * - Automatically sets primaryJurisdiction to Mexico
+ * - Filters list/iterate to Mexico transactions only
+ * - Returns MexTransaction models
+ */
+
+import { z } from "zod";
+import type {
+  CreateTransactionInput,
+  UpdateTransactionInput,
+  TransactionFilter,
+  TransactionSort,
+  ListOptions,
+  PaginatedResponse,
+  CreateMexTransactionInput,
+  UpdateMexTransactionInput,
+  AtomicBatchResult,
+  PartialBatchResult,
+  RelatedClient,
+  MexTransactionFilter,
+  MexTransactionSort,
+} from "@artu-ai/shared";
+import {
+  Jurisdiction,
+  createMexTransactionInputSchema,
+  updateMexTransactionInputSchema,
+  ClientRole,
+  transformSort,
+  mexTransactionFieldMapping,
+} from "@artu-ai/shared";
+import { TransactionsResource } from "../transactions";
+import { type BatchOptions } from "../clients";
+import { MexTransaction, type TransactionData } from "../../models";
+
+// ===========================
+// MexTransactionsResource
+// ===========================
+
+/**
+ * Mexico-scoped transactions resource.
+ *
+ * Provides the same operations as TransactionsResource but with:
+ * - Flattened input types (MX fields at root level)
+ * - Automatic jurisdiction scoping
+ * - MexTransaction model return type
+ *
+ * @example
+ * ```typescript
+ * const mexSdk = new ComplianceSDK({
+ *   apiKey,
+ *   environment: "test",
+ *   jurisdiction: Jurisdiction.Mexico,
+ * });
+ *
+ * // Create with flattened input
+ * const txn = await mexSdk.transactions.create({
+ *   amount: 50000,
+ *   currency: "MXN",
+ *   timestamp: new Date(),
+ *   actividadVulnerable: {
+ *     AVI: { tipoOperacion: "compra" },
+ *   },
+ * });
+ *
+ * // List returns only Mexico transactions
+ * const { data } = await mexSdk.transactions.list();
+ * // data is MexTransaction[]
+ * ```
+ */
+export class MexTransactionsResource<
+  TSort = MexTransactionSort,
+> extends TransactionsResource<TSort> {
+  // ─────────────────────────────────────────────────────────────────
+  // CRUD Operations (override with flattened input types)
+  // ─────────────────────────────────────────────────────────────────
+
+  /**
+   * Creates a new Mexico transaction with flattened input.
+   */
+  async create(data: CreateMexTransactionInput): Promise<MexTransaction> {
+    const validated = this.validate(createMexTransactionInputSchema, data);
+    const nestedData = this.transformToNested(validated);
+
+    const response = await this.execute(() =>
+      this.trpc.transactions.create.mutate(nestedData)
+    );
+
+    return this.instantiate(response);
+  }
+
+  /**
+   * Retrieves a transaction by ID.
+   */
+  async retrieve(id: string): Promise<MexTransaction> {
+    const response = await this.execute(() =>
+      this.trpc.transactions.retrieve.query({ id })
+    );
+    return this.instantiate(response);
+  }
+
+  async retrieveByMetadata(
+    key: string,
+    value: string
+  ): Promise<MexTransaction> {
+    const response = await this.execute(() =>
+      this.trpc.transactions.retrieveByMetadata.query({ key, value })
+    );
+    return this.instantiate(response);
+  }
+
+  async retrieveByExternalId(externalId: string): Promise<MexTransaction> {
+    const response = await this.execute(() =>
+      this.trpc.transactions.retrieveByExternalId.query({ externalId })
+    );
+    return this.instantiate(response);
+  }
+
+  /**
+   * Updates a Mexico transaction with flattened input.
+   */
+  async update(
+    id: string,
+    data: UpdateMexTransactionInput
+  ): Promise<MexTransaction> {
+    const validated = this.validate(updateMexTransactionInputSchema, 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 (scoped to Mexico)
+  // ─────────────────────────────────────────────────────────────────
+
+  /**
+   * Lists Mexico transactions with optional filtering.
+   *
+   * Accepts flattened MX filter (future MX-specific transaction fields at root level).
+   */
+  async list(
+    options?: ListOptions<MexTransactionFilter, TSort>
+  ): Promise<PaginatedResponse<MexTransaction>> {
+    const scopedFilter = this.applyScopeToFilter(options?.filter);
+    const scopedSort = this.applyScopeToSort(options?.sort);
+
+    const response = await this.execute(() =>
+      this.trpc.transactions.list.query({
+        ...options,
+        filter: scopedFilter,
+        sort: scopedSort,
+      })
+    );
+
+    return {
+      data: response.data.map((t) => this.instantiate(t)),
+      pagination: response.pagination,
+    };
+  }
+
+  /**
+   * Iterates over Mexico transactions.
+   *
+   * Accepts flattened MX filter (future MX-specific transaction fields at root level).
+   */
+  iterate(
+    filter?: MexTransactionFilter
+  ): AsyncGenerator<MexTransaction, void, undefined> {
+    const scopedFilter = this.applyScopeToFilter(filter);
+    return this.createIterator<MexTransaction>({ filter: scopedFilter });
+  }
+
+  // ─────────────────────────────────────────────────────────────────
+  // Client Relationship Management (scoped returns)
+  // ─────────────────────────────────────────────────────────────────
+
+  async listByClient(
+    clientId: string,
+    options?: { cursor?: string; limit?: number }
+  ): Promise<PaginatedResponse<MexTransaction>> {
+    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<MexTransaction> {
+    const response = await this.execute(() =>
+      this.trpc.transactions.linkClient.mutate({
+        transactionId,
+        clientId,
+        role,
+      })
+    );
+    return this.instantiate(response);
+  }
+
+  async unlinkClient(
+    transactionId: string,
+    clientId: string
+  ): Promise<MexTransaction> {
+    const response = await this.execute(() =>
+      this.trpc.transactions.unlinkClient.mutate({
+        transactionId,
+        clientId,
+      })
+    );
+    return this.instantiate(response);
+  }
+
+  async setClients(
+    transactionId: string,
+    clients: RelatedClient[]
+  ): Promise<MexTransaction> {
+    const response = await this.execute(() =>
+      this.trpc.transactions.setClients.mutate({
+        transactionId,
+        clients,
+      })
+    );
+    return this.instantiate(response);
+  }
+
+  // ─────────────────────────────────────────────────────────────────
+  // Batch Operations
+  // ─────────────────────────────────────────────────────────────────
+
+  async createMany(
+    transactions: CreateMexTransactionInput[],
+    options?: { atomic?: true }
+  ): Promise<AtomicBatchResult<MexTransaction>>;
+  async createMany(
+    transactions: CreateMexTransactionInput[],
+    options: { atomic: false }
+  ): Promise<PartialBatchResult<MexTransaction>>;
+  async createMany(
+    transactions: CreateMexTransactionInput[],
+    options: BatchOptions = {}
+  ): Promise<
+    AtomicBatchResult<MexTransaction> | PartialBatchResult<MexTransaction>
+  > {
+    const atomic = options.atomic ?? true;
+    const validated = this.validate(
+      z.array(createMexTransactionInputSchema),
+      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: UpdateMexTransactionInput }[],
+    options?: { atomic?: true }
+  ): Promise<AtomicBatchResult<MexTransaction>>;
+  async updateMany(
+    updates: { id: string; data: UpdateMexTransactionInput }[],
+    options: { atomic: false }
+  ): Promise<PartialBatchResult<MexTransaction>>;
+  async updateMany(
+    updates: { id: string; data: UpdateMexTransactionInput }[],
+    options: BatchOptions = {}
+  ): Promise<
+    AtomicBatchResult<MexTransaction> | PartialBatchResult<MexTransaction>
+  > {
+    const atomic = options.atomic ?? true;
+    const updateItemSchema = z.object({
+      id: z.uuid(),
+      data: updateMexTransactionInputSchema,
+    });
+
+    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
+  // ─────────────────────────────────────────────────────────────────
+
+  /**
+   * Applies Mexico jurisdiction filter.
+   *
+   * Currently MexTransactionFilter has the same fields as the base filter,
+   * but this method ensures the jurisdiction scope is applied.
+   */
+  protected applyScopeToFilter(filter?: MexTransactionFilter): TransactionFilter {
+    if (!filter) {
+      return {
+        availableJurisdictions: Jurisdiction.Mexico,
+      };
+    }
+
+    // Currently no MX-specific transaction filter fields to nest
+    // Just pass through and add jurisdiction scope
+    return {
+      ...filter,
+      availableJurisdictions: Jurisdiction.Mexico,
+    } as TransactionFilter;
+  }
+
+  /**
+   * Transforms a flattened MexTransactionSort to nested TransactionSort format.
+   *
+   * Maps flattened field names to their full API paths.
+   *
+   * Note: Uses unknown parameter to allow derived classes to override with their own sort types.
+   */
+  protected applyScopeToSort(sort?: TSort): TransactionSort | undefined {
+    if (!sort || !Array.isArray(sort) || sort.length === 0) {
+      return undefined;
+    }
+    return transformSort(sort as MexTransactionSort, mexTransactionFieldMapping);
+  }
+
+  /**
+   * Transforms flattened MX input to nested API format.
+   */
+  protected transformToNested(
+    data: CreateMexTransactionInput
+  ): CreateTransactionInput {
+    const { actividadVulnerable, ...baseFields } = data;
+
+    // Build MX jurisdiction data
+    const mexData: Record<string, unknown> = {};
+    if (actividadVulnerable !== undefined) {
+      mexData.actividadVulnerable = actividadVulnerable;
+    }
+
+    return {
+      ...baseFields,
+      primaryJurisdiction: Jurisdiction.Mexico,
+      jurisdictions:
+        Object.keys(mexData).length > 0
+          ? {
+              MX: mexData,
+            }
+          : undefined,
+    } as CreateTransactionInput;
+  }
+
+  /**
+   * Transforms flattened MX update input to nested API format.
+   */
+  protected transformUpdateToNested(
+    data: UpdateMexTransactionInput
+  ): UpdateTransactionInput {
+    const { actividadVulnerable, ...baseFields } = data;
+
+    if (actividadVulnerable === undefined) {
+      return baseFields as UpdateTransactionInput;
+    }
+
+    return {
+      ...baseFields,
+      jurisdictions: {
+        MX: { actividadVulnerable },
+      },
+    } as UpdateTransactionInput;
+  }
+
+  /**
+   * Instantiates a MexTransaction model.
+   */
+  protected override instantiate(data: TransactionData): MexTransaction {
+    return new MexTransaction(data);
+  }
+}