@artu-ai/compliance-sdk 0.0.6 → 0.3.0

package/dist/resources/mex/actividad-vulnerable/tsc/transactions.js

@@ -0,0 +1,259 @@
+/**
+ * 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 { Jurisdiction, CodigoActividad, createTSCTransactionInputSchema, updateTSCTransactionInputSchema, transformSort, tscTransactionFieldMapping, } from "@artu-ai/shared";
+import { MexTransactionsResource } from "../../transactions";
+import { MexTSCTransaction } 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) {
+        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) {
+        const response = await this.execute(() => this.trpc.transactions.retrieve.query({ id }));
+        return this.instantiate(response);
+    }
+    async retrieveByMetadata(key, value) {
+        const response = await this.execute(() => this.trpc.transactions.retrieveByMetadata.query({ key, value }));
+        return this.instantiate(response);
+    }
+    async update(id, data) {
+        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) {
+        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 TSC transactions.
+     *
+     * Accepts flattened TSC filter (future TSC-specific transaction fields at root level).
+     */
+    iterate(filter) {
+        const scopedFilter = this.applyScopeToFilter(filter);
+        return this.createIterator({ filter: scopedFilter });
+    }
+    // ─────────────────────────────────────────────────────────────────
+    // Client Relationship Management (scoped returns)
+    // ─────────────────────────────────────────────────────────────────
+    async listByClient(clientId, options) {
+        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, clientId, role) {
+        const response = await this.execute(() => this.trpc.transactions.linkClient.mutate({
+            transactionId,
+            clientId,
+            role,
+        }));
+        return this.instantiate(response);
+    }
+    async unlinkClient(transactionId, clientId) {
+        const response = await this.execute(() => this.trpc.transactions.unlinkClient.mutate({
+            transactionId,
+            clientId,
+        }));
+        return this.instantiate(response);
+    }
+    async setClients(transactionId, clients) {
+        const response = await this.execute(() => this.trpc.transactions.setClients.mutate({
+            transactionId,
+            clients,
+        }));
+        return this.instantiate(response);
+    }
+    async createMany(transactions, options = {}) {
+        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, options = {}) {
+        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
+    // ─────────────────────────────────────────────────────────────────
+    transformToNested(data) {
+        const { amount, currency, timestamp, relatedClientIds, description, externalId, metadata, cardType, idNumber, operationType, } = data;
+        // Build base fields (relatedClientIds is required)
+        const baseFields = {
+            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 = {
+            cardType,
+            idNumber,
+            operationType,
+        };
+        return {
+            ...baseFields,
+            primaryJurisdiction: Jurisdiction.Mexico,
+            jurisdictions: {
+                MX: {
+                    actividadVulnerable: {
+                        [CodigoActividad.TSC]: tscFields,
+                    },
+                },
+            },
+        };
+    }
+    transformUpdateToNested(data) {
+        // Cast to access fields - Zod validation ensures correctness
+        const input = data;
+        const { status, description, externalId, metadata, primaryJurisdiction, cardType, idNumber, operationType } = input;
+        // Build base update fields
+        const result = {};
+        if (status !== undefined)
+            result.status = status;
+        if (description !== undefined)
+            result.description = description;
+        if (externalId !== undefined)
+            result.externalId = externalId;
+        if (metadata !== undefined)
+            result.metadata = metadata;
+        if (primaryJurisdiction !== undefined)
+            result.primaryJurisdiction = primaryJurisdiction;
+        // If TSC fields are present (all-or-nothing), nest them in jurisdictions
+        if (cardType !== undefined) {
+            result.jurisdictions = {
+                MX: {
+                    actividadVulnerable: {
+                        [CodigoActividad.TSC]: {
+                            cardType,
+                            idNumber,
+                            operationType,
+                        },
+                    },
+                },
+            };
+        }
+        return result;
+    }
+    instantiate(data) {
+        return new MexTSCTransaction(data);
+    }
+    /**
+     * Transforms a flattened TSCTransactionSort to nested TransactionSort format.
+     *
+     * Maps flattened field names to their full API paths using TSC-specific field mapping.
+     */
+    applyScopeToSort(sort) {
+        if (!sort || sort.length === 0) {
+            return undefined;
+        }
+        return transformSort(sort, tscTransactionFieldMapping);
+    }
+}

package/dist/resources/mex/addresses.d.ts

@@ -0,0 +1,143 @@
+/**
+ * Mexico Addresses Resource
+ *
+ * Extends AddressesResource with Mexico-specific behavior:
+ * - Accepts flattened CreateMexAddressInput (MX fields at root level)
+ * - Returns MexAddress models with Mexico-specific accessors
+ *
+ * Note: Mexican address format can be used for addresses in any country.
+ */
+import type { CreateAddressInput, UpdateAddressInput, AddressFilter, AddressSort, AddressType, ListOptions, PaginatedResponse, CreateMexAddressInput, UpdateMexAddressInput, AtomicBatchResult, PartialBatchResult, SyncItem, SyncResult, MexAddressFilter, MexAddressSort } from "@artu-ai/shared";
+import { AddressesResource } from "../addresses";
+import { MexAddress, type AddressData } from "../../models";
+/**
+ * Mexico-scoped addresses resource.
+ *
+ * Provides the same operations as AddressesResource but with:
+ * - Flattened input types (MX fields like exteriorNumber, neighborhood at root level)
+ * - MexAddress model return type with Mexico-specific accessors
+ *
+ * @example
+ * ```typescript
+ * const mexSdk = new ComplianceSDK({
+ *   apiKey,
+ *   environment: "test",
+ *   jurisdiction: Jurisdiction.Mexico,
+ * });
+ *
+ * // Create with flattened input
+ * const address = await mexSdk.addresses.create({
+ *   clientId: "client_123",
+ *   street: "Paseo de la Reforma",
+ *   exteriorNumber: "222",
+ *   interiorNumber: "Piso 5",
+ *   neighborhood: "Juárez",
+ *   city: "Ciudad de México",
+ *   state: "CDMX",
+ *   postalCode: "06600",
+ *   country: "MX",
+ *   type: "home",
+ * });
+ *
+ * // Returns MexAddress
+ * console.log(address.exteriorNumber);
+ * console.log(address.formattedMexican);
+ * ```
+ */
+export declare class MexAddressesResource<TSort = MexAddressSort> extends AddressesResource<TSort> {
+    /**
+     * Creates a new address with Mexico-format fields.
+     */
+    create(data: CreateMexAddressInput): Promise<MexAddress>;
+    /**
+     * Retrieves an address by ID.
+     */
+    retrieve(id: string): Promise<MexAddress>;
+    retrieveByMetadata(key: string, value: string): Promise<MexAddress>;
+    retrieveByExternalId(externalId: string): Promise<MexAddress>;
+    /**
+     * Updates an address with Mexico-format fields.
+     */
+    update(id: string, data: UpdateMexAddressInput): Promise<MexAddress>;
+    /**
+     * Lists addresses with optional filtering.
+     *
+     * Accepts flattened MX filter (MX-specific fields at root level).
+     */
+    list(options?: ListOptions<MexAddressFilter, TSort>): Promise<PaginatedResponse<MexAddress>>;
+    /**
+     * Lists all addresses for a specific client.
+     */
+    listByClient(clientId: string, options?: {
+        cursor?: string;
+        limit?: number;
+    }): Promise<PaginatedResponse<MexAddress>>;
+    /**
+     * Gets the primary address for a client.
+     */
+    getPrimary(clientId: string, type?: AddressType): Promise<MexAddress | null>;
+    /**
+     * Iterates over addresses.
+     *
+     * Accepts flattened MX filter (MX-specific fields at root level).
+     */
+    iterate(filter?: MexAddressFilter): AsyncGenerator<MexAddress, void, undefined>;
+    createMany(addresses: CreateMexAddressInput[], options?: {
+        atomic?: true;
+    }): Promise<AtomicBatchResult<MexAddress>>;
+    createMany(addresses: CreateMexAddressInput[], options: {
+        atomic: false;
+    }): Promise<PartialBatchResult<MexAddress>>;
+    updateMany(updates: {
+        id: string;
+        data: UpdateMexAddressInput;
+    }[], options?: {
+        atomic?: true;
+    }): Promise<AtomicBatchResult<MexAddress>>;
+    updateMany(updates: {
+        id: string;
+        data: UpdateMexAddressInput;
+    }[], options: {
+        atomic: false;
+    }): Promise<PartialBatchResult<MexAddress>>;
+    /**
+     * Syncs addresses for a client with Mexico-format flattened input.
+     */
+    sync(clientId: string, items: SyncItem<CreateMexAddressInput>[], options: {
+        replaceMode: true;
+    }): Promise<SyncResult<MexAddress>>;
+    sync(clientId: string, items: SyncItem<UpdateMexAddressInput>[], options?: {
+        replaceMode?: boolean;
+    }): Promise<SyncResult<MexAddress>>;
+    /**
+     * Transforms flattened MX filter to nested API format.
+     *
+     * Mexico-specific filter fields (neighborhood, municipality) are stored
+     * in `jurisdictions.MX`. Base fields pass through unchanged.
+     */
+    protected applyScopeToFilter(filter?: MexAddressFilter): AddressFilter;
+    /**
+     * Transforms a flattened MexAddressSort to nested AddressSort 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): AddressSort | undefined;
+    /**
+     * Transforms flattened MX input to nested API format.
+     *
+     * Mexico-specific fields (exteriorNumber, interiorNumber, neighborhood, etc.)
+     * are stored in `jurisdictions.MX`. The base `street` field is passed through.
+     */
+    protected transformToNested(data: CreateMexAddressInput): CreateAddressInput;
+    /**
+     * Transforms flattened MX update input to nested API format.
+     */
+    protected transformUpdateToNested(data: UpdateMexAddressInput): UpdateAddressInput;
+    /**
+     * Instantiates a MexAddress model.
+     */
+    protected instantiate(data: AddressData): MexAddress;
+}
+//# sourceMappingURL=addresses.d.ts.map

package/dist/resources/mex/addresses.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"addresses.d.ts","sourceRoot":"","sources":["../../../src/resources/mex/addresses.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAGH,OAAO,KAAK,EACV,kBAAkB,EAClB,kBAAkB,EAClB,aAAa,EACb,WAAW,EACX,WAAW,EACX,WAAW,EACX,iBAAiB,EACjB,qBAAqB,EACrB,qBAAqB,EACrB,iBAAiB,EACjB,kBAAkB,EAClB,QAAQ,EACR,UAAU,EACV,gBAAgB,EAChB,cAAc,EACf,MAAM,iBAAiB,CAAC;AAQzB,OAAO,EAAE,iBAAiB,EAAE,MAAM,cAAc,CAAC;AAEjD,OAAO,EAAE,UAAU,EAAE,KAAK,WAAW,EAAE,MAAM,cAAc,CAAC;AAM5D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiCG;AACH,qBAAa,oBAAoB,CAC/B,KAAK,GAAG,cAAc,CACtB,SAAQ,iBAAiB,CAAC,KAAK,CAAC;IAKhC;;OAEG;IACG,MAAM,CAAC,IAAI,EAAE,qBAAqB,GAAG,OAAO,CAAC,UAAU,CAAC;IAW9D;;OAEG;IACG,QAAQ,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,UAAU,CAAC;IAOzC,kBAAkB,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,UAAU,CAAC;IAOnE,oBAAoB,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,UAAU,CAAC;IAOnE;;OAEG;IACG,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,qBAAqB,GAAG,OAAO,CAAC,UAAU,CAAC;IAc1E;;;;OAIG;IACG,IAAI,CACR,OAAO,CAAC,EAAE,WAAW,CAAC,gBAAgB,EAAE,KAAK,CAAC,GAC7C,OAAO,CAAC,iBAAiB,CAAC,UAAU,CAAC,CAAC;IAkBzC;;OAEG;IACG,YAAY,CAChB,QAAQ,EAAE,MAAM,EAChB,OAAO,CAAC,EAAE;QAAE,MAAM,CAAC,EAAE,MAAM,CAAC;QAAC,KAAK,CAAC,EAAE,MAAM,CAAA;KAAE,GAC5C,OAAO,CAAC,iBAAiB,CAAC,UAAU,CAAC,CAAC;IAWzC;;OAEG;IACG,UAAU,CACd,QAAQ,EAAE,MAAM,EAChB,IAAI,CAAC,EAAE,WAAW,GACjB,OAAO,CAAC,UAAU,GAAG,IAAI,CAAC;IAO7B;;;;OAIG;IACH,OAAO,CAAC,MAAM,CAAC,EAAE,gBAAgB,GAAG,cAAc,CAAC,UAAU,EAAE,IAAI,EAAE,SAAS,CAAC;IASzE,UAAU,CACd,SAAS,EAAE,qBAAqB,EAAE,EAClC,OAAO,CAAC,EAAE;QAAE,MAAM,CAAC,EAAE,IAAI,CAAA;KAAE,GAC1B,OAAO,CAAC,iBAAiB,CAAC,UAAU,CAAC,CAAC;IACnC,UAAU,CACd,SAAS,EAAE,qBAAqB,EAAE,EAClC,OAAO,EAAE;QAAE,MAAM,EAAE,KAAK,CAAA;KAAE,GACzB,OAAO,CAAC,kBAAkB,CAAC,UAAU,CAAC,CAAC;IAiCpC,UAAU,CACd,OAAO,EAAE;QAAE,EAAE,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,qBAAqB,CAAA;KAAE,EAAE,EACtD,OAAO,CAAC,EAAE;QAAE,MAAM,CAAC,EAAE,IAAI,CAAA;KAAE,GAC1B,OAAO,CAAC,iBAAiB,CAAC,UAAU,CAAC,CAAC;IACnC,UAAU,CACd,OAAO,EAAE;QAAE,EAAE,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,qBAAqB,CAAA;KAAE,EAAE,EACtD,OAAO,EAAE;QAAE,MAAM,EAAE,KAAK,CAAA;KAAE,GACzB,OAAO,CAAC,kBAAkB,CAAC,UAAU,CAAC,CAAC;IA0C1C;;OAEG;IACG,IAAI,CACR,QAAQ,EAAE,MAAM,EAChB,KAAK,EAAE,QAAQ,CAAC,qBAAqB,CAAC,EAAE,EACxC,OAAO,EAAE;QAAE,WAAW,EAAE,IAAI,CAAA;KAAE,GAC7B,OAAO,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC;IAC5B,IAAI,CACR,QAAQ,EAAE,MAAM,EAChB,KAAK,EAAE,QAAQ,CAAC,qBAAqB,CAAC,EAAE,EACxC,OAAO,CAAC,EAAE;QAAE,WAAW,CAAC,EAAE,OAAO,CAAA;KAAE,GAClC,OAAO,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC;IAwDlC;;;;;OAKG;IACH,SAAS,CAAC,kBAAkB,CAAC,MAAM,CAAC,EAAE,gBAAgB,GAAG,aAAa;IAqBtE;;;;;;OAMG;IACH,SAAS,CAAC,gBAAgB,CAAC,IAAI,CAAC,EAAE,KAAK,GAAG,WAAW,GAAG,SAAS;IAOjE;;;;;OAKG;IACH,SAAS,CAAC,iBAAiB,CAAC,IAAI,EAAE,qBAAqB,GAAG,kBAAkB;IA8B5E;;OAEG;IACH,SAAS,CAAC,uBAAuB,CAC/B,IAAI,EAAE,qBAAqB,GAC1B,kBAAkB;IAuCrB;;OAEG;cACgB,WAAW,CAAC,IAAI,EAAE,WAAW,GAAG,UAAU;CAG9D"}