@artu-ai/compliance-sdk 0.0.6 → 0.3.0

package/dist/resources/mex/actividad-vulnerable/avi/reports.js

@@ -0,0 +1,401 @@
+/**
+ * AVI (Activos Virtuales) Reports Resource
+ *
+ * Extends MexReportsResource with AVI-specific behavior:
+ * - Accepts flattened CreateAVIReportInput (AVI fields at root level)
+ * - Returns MexAVIReport models
+ */
+import { z } from "zod";
+import { CodigoActividad, createAVIReportInputSchema, updateAVIReportInputSchema, createAVIReportItemInputSchema, updateAVIReportItemInputSchema, aviDefaultsInputSchema, submitAVIReportInputSchema, transformSort, aviReportFieldMapping, } from "@artu-ai/shared";
+import { MexReportsResource } from "../../reports";
+import { MexAVIReport, MexAVIReportItem, } from "../../../../models";
+// ===========================
+// AVIReportsResource
+// ===========================
+/**
+ * AVI (Activos Virtuales) scoped reports resource.
+ *
+ * @example
+ * ```typescript
+ * const aviSdk = new ComplianceSDK({
+ *   apiKey,
+ *   jurisdiction: Jurisdiction.Mexico,
+ *   actividadVulnerable: CodigoActividad.AVI,
+ * });
+ *
+ * // Create with fully flattened input
+ * const report = await aviSdk.reports.create({
+ *   mesReportado: "202401",
+ * });
+ *
+ * // Returns MexAVIReport
+ * console.log(report.mesReportado);
+ * ```
+ */
+export class AVIReportsResource extends MexReportsResource {
+    // ─────────────────────────────────────────────────────────────────
+    // Report CRUD
+    // ─────────────────────────────────────────────────────────────────
+    async create(data) {
+        const validated = this.validate(createAVIReportInputSchema, data);
+        const nestedData = this.transformToNested(validated);
+        const response = await this.execute(() => this.trpc.reports.create.mutate(nestedData));
+        return this.instantiate(response);
+    }
+    async retrieve(id) {
+        const response = await this.execute(() => this.trpc.reports.retrieve.query({ id }));
+        return this.instantiate(response);
+    }
+    async retrieveByMetadata(key, value) {
+        const response = await this.execute(() => this.trpc.reports.retrieveByMetadata.query({ key, value }));
+        return this.instantiate(response);
+    }
+    async retrieveByExternalId(externalId) {
+        const response = await this.execute(() => this.trpc.reports.retrieveByExternalId.query({ externalId }));
+        return this.instantiate(response);
+    }
+    async update(id, data) {
+        const validated = this.validate(updateAVIReportInputSchema, data);
+        const nestedData = this.transformUpdateToNested(validated);
+        const response = await this.execute(() => this.trpc.reports.update.mutate({ id, data: nestedData }));
+        return this.instantiate(response);
+    }
+    // ─────────────────────────────────────────────────────────────────
+    // List & Pagination
+    // ─────────────────────────────────────────────────────────────────
+    /**
+     * Lists AVI reports with optional filtering.
+     *
+     * Accepts flattened AVI filter (future AVI-specific report 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.reports.list.query({
+            ...options,
+            filter: scopedFilter,
+            sort: scopedSort,
+        }));
+        return {
+            data: response.data.map((r) => this.instantiate(r)),
+            pagination: response.pagination,
+        };
+    }
+    /**
+     * Iterates over AVI reports.
+     *
+     * Accepts flattened AVI filter (future AVI-specific report fields at root level).
+     */
+    iterate(filter) {
+        const scopedFilter = this.applyScopeToFilter(filter);
+        return this.createIterator({ filter: scopedFilter });
+    }
+    async createMany(reports, options = {}) {
+        const atomic = options.atomic ?? true;
+        const validated = this.validate(z.array(createAVIReportInputSchema), reports);
+        const nestedItems = validated.map((r) => this.transformToNested(r));
+        const response = await this.execute(() => this.trpc.reports.createMany.mutate({ items: nestedItems, atomic }));
+        if (response.atomic) {
+            return {
+                atomic: true,
+                data: response.data.map((r) => this.instantiate(r)),
+            };
+        }
+        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: updateAVIReportInputSchema,
+        });
+        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.reports.updateMany.mutate({ items: nestedUpdates, atomic }));
+        if (response.atomic) {
+            return {
+                atomic: true,
+                data: response.data.map((r) => this.instantiate(r)),
+            };
+        }
+        else {
+            return {
+                atomic: false,
+                succeeded: response.succeeded.map((item) => ({
+                    index: item.index,
+                    data: this.instantiate(item.data),
+                })),
+                failed: response.failed,
+            };
+        }
+    }
+    // ─────────────────────────────────────────────────────────────────
+    // Report Items
+    // ─────────────────────────────────────────────────────────────────
+    async addItem(reportId, data) {
+        const validated = this.validate(createAVIReportItemInputSchema, data);
+        const nestedData = this.transformItemToNested(validated);
+        const response = await this.execute(() => this.trpc.reports.addItem.mutate({ reportId, data: nestedData }));
+        return this.instantiateItem(response);
+    }
+    async getItem(reportId, itemId) {
+        const response = await this.execute(() => this.trpc.reports.getItem.query({ reportId, itemId }));
+        return this.instantiateItem(response);
+    }
+    async updateItem(reportId, itemId, data) {
+        const validated = this.validate(updateAVIReportItemInputSchema, data);
+        const nestedData = this.transformItemUpdateToNested(validated);
+        const response = await this.execute(() => this.trpc.reports.updateItem.mutate({
+            reportId,
+            itemId,
+            data: nestedData,
+        }));
+        return this.instantiateItem(response);
+    }
+    async listItems(reportId, options) {
+        // Transform flattened AVI filter to nested format
+        const scopedFilter = this.applyScopeToItemFilter(options?.filter);
+        const response = await this.execute(() => this.trpc.reports.listItems.query({
+            reportId,
+            ...options,
+            filter: scopedFilter,
+        }));
+        return {
+            data: response.data.map((i) => this.instantiateItem(i)),
+            pagination: response.pagination,
+        };
+    }
+    /**
+     * Transforms a flattened AVIReportItemFilter to nested ReportItemFilter format.
+     */
+    applyScopeToItemFilter(filter) {
+        if (!filter)
+            return undefined;
+        const { alertType, alertDescription, ...baseFields } = filter;
+        // If no AVI-specific fields, return base filter as-is
+        if (alertType === undefined && alertDescription === undefined) {
+            return baseFields;
+        }
+        // Build nested filter structure
+        const aviFilter = {};
+        if (alertType !== undefined)
+            aviFilter.alertType = alertType;
+        if (alertDescription !== undefined)
+            aviFilter.alertDescription = alertDescription;
+        return {
+            ...baseFields,
+            jurisdictions: {
+                MX: {
+                    actividadVulnerable: {
+                        AVI: aviFilter,
+                    },
+                },
+            },
+        };
+    }
+    async addItems(reportId, items) {
+        const validated = this.validate(z.array(createAVIReportItemInputSchema), items);
+        const nestedItems = validated.map((i) => this.transformItemToNested(i));
+        const response = await this.execute(() => this.trpc.reports.addItems.mutate({ reportId, items: nestedItems }));
+        return {
+            added: response.added,
+            items: response.items.map((i) => this.instantiateItem(i)),
+        };
+    }
+    // ─────────────────────────────────────────────────────────────────
+    // Validation
+    // ─────────────────────────────────────────────────────────────────
+    /**
+     * Validates an AVI report.
+     *
+     * Uses AVI-scoped validation input (jurisdiction and activity are implicit).
+     *
+     * @param reportId - The report ID to validate
+     * @param defaults - AVI report defaults including rfc, platformDomain, alertType, etc.
+     *
+     * @example
+     * ```typescript
+     * const result = await aviSdk.reports.validateReport(report.id, {
+     *   rfc: "ABC200101XXX",
+     *   platformDomain: "https://example.com",
+     *   alertType: "100",
+     * });
+     * ```
+     */
+    async validateReport(reportId, defaults) {
+        const validated = this.validate(aviDefaultsInputSchema, defaults);
+        const nestedInput = this.transformAviDefaultsToNested(reportId, validated);
+        return this.execute(() => this.trpc.reports.validate.mutate(nestedInput));
+    }
+    // ─────────────────────────────────────────────────────────────────
+    // Generation
+    // ─────────────────────────────────────────────────────────────────
+    /**
+     * Generates XML for an AVI report.
+     *
+     * Uses the same input as validateReport.
+     *
+     * @param reportId - The report ID to generate XML for
+     * @param defaults - AVI report defaults including rfc, platformDomain, alertType, etc.
+     *
+     * @example
+     * ```typescript
+     * const result = await aviSdk.reports.generateReport(report.id, {
+     *   rfc: "ABC200101XXX",
+     *   platformDomain: "https://example.com",
+     *   alertType: "100",
+     * });
+     * console.log(result.xml);
+     * ```
+     */
+    async generateReport(reportId, defaults) {
+        const validated = this.validate(aviDefaultsInputSchema, defaults);
+        const nestedInput = this.transformAviDefaultsToNested(reportId, validated);
+        return this.execute(() => this.trpc.reports.generate.mutate(nestedInput));
+    }
+    // ─────────────────────────────────────────────────────────────────
+    // Submission
+    // ─────────────────────────────────────────────────────────────────
+    /**
+     * Submits a validated AVI report.
+     *
+     * Uses AVI-scoped submission input (activity is implicit).
+     *
+     * @example
+     * ```typescript
+     * const result = await aviSdk.reports.submit({
+     *   reportId: report.id,
+     *   acuseRecibo: "SAT-12345",
+     *   notes: "Submitted via portal",
+     * });
+     * ```
+     */
+    async submit(input) {
+        const validated = this.validate(submitAVIReportInputSchema, input);
+        const jurisdictions = {
+            MX: {
+                actividadVulnerable: {
+                    [CodigoActividad.AVI]: {
+                        acuseRecibo: validated.acuseRecibo,
+                        notes: validated.notes,
+                    },
+                },
+            },
+        };
+        return this.execute(() => this.trpc.reports.submit.mutate({
+            reportId: validated.reportId,
+            jurisdictions,
+        }));
+    }
+    // ─────────────────────────────────────────────────────────────────
+    // Protected Helpers
+    // ─────────────────────────────────────────────────────────────────
+    /**
+     * Transforms a flattened AVIReportSort to nested ReportSort format.
+     *
+     * Maps flattened field names to their full API paths.
+     */
+    applyScopeToSort(sort) {
+        if (!sort || sort.length === 0) {
+            return undefined;
+        }
+        return transformSort(sort, aviReportFieldMapping);
+    }
+    transformToNested(data) {
+        const { mesReportado, ...baseFields } = data;
+        return {
+            ...baseFields,
+            jurisdictions: {
+                MX: {
+                    actividadVulnerable: {
+                        [CodigoActividad.AVI]: { mesReportado },
+                    },
+                },
+            },
+        };
+    }
+    transformUpdateToNested(data) {
+        return data;
+    }
+    instantiate(data) {
+        return new MexAVIReport(data);
+    }
+    instantiateItem(data) {
+        return new MexAVIReportItem(data);
+    }
+    transformItemToNested(data) {
+        const { alertType, alertDescription, amendment, ...baseFields } = data;
+        const aviData = {};
+        if (alertType !== undefined)
+            aviData.alertType = alertType;
+        if (alertDescription !== undefined)
+            aviData.alertDescription = alertDescription;
+        if (amendment !== undefined)
+            aviData.amendment = amendment;
+        return {
+            ...baseFields,
+            jurisdictions: {
+                MX: {
+                    actividadVulnerable: {
+                        [CodigoActividad.AVI]: aviData,
+                    },
+                },
+            },
+        };
+    }
+    transformItemUpdateToNested(data) {
+        const { alertType, alertDescription, amendment, ...baseFields } = data;
+        const aviData = {};
+        if (alertType !== undefined)
+            aviData.alertType = alertType;
+        if (alertDescription !== undefined)
+            aviData.alertDescription = alertDescription;
+        if (amendment !== undefined)
+            aviData.amendment = amendment;
+        if (Object.keys(aviData).length === 0) {
+            return baseFields;
+        }
+        return {
+            ...baseFields,
+            jurisdictions: {
+                MX: {
+                    actividadVulnerable: {
+                        [CodigoActividad.AVI]: aviData,
+                    },
+                },
+            },
+        };
+    }
+    /**
+     * Transforms AVI defaults to nested API format for validate/generate.
+     */
+    transformAviDefaultsToNested(reportId, defaults) {
+        const { rfc, collegiateEntityCode, exempt, priority, ...aviFields } = defaults;
+        return {
+            reportId,
+            jurisdictions: {
+                MX: {
+                    actividadVulnerable: {
+                        rfc,
+                        collegiateEntityCode,
+                        exempt,
+                        priority,
+                        [CodigoActividad.AVI]: aviFields,
+                    },
+                },
+            },
+        };
+    }
+}

package/dist/resources/mex/actividad-vulnerable/avi/transactions.d.ts

@@ -0,0 +1,89 @@
+/**
+ * AVI (Activos Virtuales) Transactions Resource
+ *
+ * Extends MexTransactionsResource with AVI-specific behavior:
+ * - Accepts flattened CreateAVITransactionInput (AVI fields at root level)
+ * - Returns MexAVITransaction models
+ */
+import type { CreateTransactionInput, UpdateTransactionInput, TransactionSort, ListOptions, PaginatedResponse, CreateAVITransactionInput, UpdateAVITransactionInput, AtomicBatchResult, PartialBatchResult, RelatedClient, AVITransactionFilter, AVITransactionSort } from "@artu-ai/shared";
+import { ClientRole } from "@artu-ai/shared";
+import { MexTransactionsResource } from "../../transactions";
+import { MexAVITransaction, type TransactionData } from "../../../../models";
+/**
+ * AVI (Activos Virtuales) scoped transactions resource.
+ *
+ * @example
+ * ```typescript
+ * const aviSdk = new ComplianceSDK({
+ *   apiKey,
+ *   jurisdiction: Jurisdiction.Mexico,
+ *   actividadVulnerable: CodigoActividad.AVI,
+ * });
+ *
+ * // Create with fully flattened input
+ * const txn = await aviSdk.transactions.create({
+ *   amount: 50000,
+ *   currency: "MXN",
+ *   timestamp: new Date(),
+ *   operationType: "buy",
+ *   crypto: "BTC",
+ *   hash: "ABC123DEF456",
+ * });
+ *
+ * // Returns MexAVITransaction
+ * console.log(txn.operationType);
+ * ```
+ */
+export declare class AVITransactionsResource extends MexTransactionsResource<AVITransactionSort> {
+    create(data: CreateAVITransactionInput): Promise<MexAVITransaction>;
+    retrieve(id: string): Promise<MexAVITransaction>;
+    retrieveByMetadata(key: string, value: string): Promise<MexAVITransaction>;
+    update(id: string, data: UpdateAVITransactionInput): Promise<MexAVITransaction>;
+    /**
+     * Lists AVI transactions with optional filtering.
+     *
+     * Accepts flattened AVI filter (future AVI-specific transaction fields at root level).
+     */
+    list(options?: ListOptions<AVITransactionFilter, AVITransactionSort>): Promise<PaginatedResponse<MexAVITransaction>>;
+    /**
+     * Iterates over AVI transactions.
+     *
+     * Accepts flattened AVI filter (future AVI-specific transaction fields at root level).
+     */
+    iterate(filter?: AVITransactionFilter): AsyncGenerator<MexAVITransaction, void, undefined>;
+    listByClient(clientId: string, options?: {
+        cursor?: string;
+        limit?: number;
+    }): Promise<PaginatedResponse<MexAVITransaction>>;
+    linkClient(transactionId: string, clientId: string, role?: ClientRole): Promise<MexAVITransaction>;
+    unlinkClient(transactionId: string, clientId: string): Promise<MexAVITransaction>;
+    setClients(transactionId: string, clients: RelatedClient[]): Promise<MexAVITransaction>;
+    createMany(transactions: CreateAVITransactionInput[], options?: {
+        atomic?: true;
+    }): Promise<AtomicBatchResult<MexAVITransaction>>;
+    createMany(transactions: CreateAVITransactionInput[], options: {
+        atomic: false;
+    }): Promise<PartialBatchResult<MexAVITransaction>>;
+    updateMany(updates: {
+        id: string;
+        data: UpdateAVITransactionInput;
+    }[], options?: {
+        atomic?: true;
+    }): Promise<AtomicBatchResult<MexAVITransaction>>;
+    updateMany(updates: {
+        id: string;
+        data: UpdateAVITransactionInput;
+    }[], options: {
+        atomic: false;
+    }): Promise<PartialBatchResult<MexAVITransaction>>;
+    /**
+     * Transforms a flattened AVITransactionSort to nested TransactionSort format.
+     *
+     * Maps flattened field names to their full API paths.
+     */
+    protected applyScopeToSort(sort?: AVITransactionSort): TransactionSort | undefined;
+    protected transformToNested(data: CreateAVITransactionInput): CreateTransactionInput;
+    protected transformUpdateToNested(data: UpdateAVITransactionInput): UpdateTransactionInput;
+    protected instantiate(data: TransactionData): MexAVITransaction;
+}
+//# sourceMappingURL=transactions.d.ts.map

package/dist/resources/mex/actividad-vulnerable/avi/transactions.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"transactions.d.ts","sourceRoot":"","sources":["../../../../../src/resources/mex/actividad-vulnerable/avi/transactions.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAGH,OAAO,KAAK,EACV,sBAAsB,EACtB,sBAAsB,EACtB,eAAe,EACf,WAAW,EACX,iBAAiB,EACjB,yBAAyB,EACzB,yBAAyB,EACzB,iBAAiB,EACjB,kBAAkB,EAClB,aAAa,EACb,oBAAoB,EACpB,kBAAkB,EACnB,MAAM,iBAAiB,CAAC;AACzB,OAAO,EAKL,UAAU,EAGX,MAAM,iBAAiB,CAAC;AACzB,OAAO,EAAE,uBAAuB,EAAE,MAAM,oBAAoB,CAAC;AAE7D,OAAO,EAAE,iBAAiB,EAAE,KAAK,eAAe,EAAE,MAAM,oBAAoB,CAAC;AAM7E;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,qBAAa,uBAAwB,SAAQ,uBAAuB,CAAC,kBAAkB,CAAC;IAKhF,MAAM,CAAC,IAAI,EAAE,yBAAyB,GAAG,OAAO,CAAC,iBAAiB,CAAC;IAWnE,QAAQ,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,iBAAiB,CAAC;IAOhD,kBAAkB,CACtB,GAAG,EAAE,MAAM,EACX,KAAK,EAAE,MAAM,GACZ,OAAO,CAAC,iBAAiB,CAAC;IAOvB,MAAM,CACV,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,yBAAyB,GAC9B,OAAO,CAAC,iBAAiB,CAAC;IAc7B;;;;OAIG;IACG,IAAI,CACR,OAAO,CAAC,EAAE,WAAW,CAAC,oBAAoB,EAAE,kBAAkB,CAAC,GAC9D,OAAO,CAAC,iBAAiB,CAAC,iBAAiB,CAAC,CAAC;IAkBhD;;;;OAIG;IACH,OAAO,CACL,MAAM,CAAC,EAAE,oBAAoB,GAC5B,cAAc,CAAC,iBAAiB,EAAE,IAAI,EAAE,SAAS,CAAC;IAS/C,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,iBAAiB,CAAC,CAAC;IAW1C,UAAU,CACd,aAAa,EAAE,MAAM,EACrB,QAAQ,EAAE,MAAM,EAChB,IAAI,CAAC,EAAE,UAAU,GAChB,OAAO,CAAC,iBAAiB,CAAC;IAWvB,YAAY,CAChB,aAAa,EAAE,MAAM,EACrB,QAAQ,EAAE,MAAM,GACf,OAAO,CAAC,iBAAiB,CAAC;IAUvB,UAAU,CACd,aAAa,EAAE,MAAM,EACrB,OAAO,EAAE,aAAa,EAAE,GACvB,OAAO,CAAC,iBAAiB,CAAC;IAcvB,UAAU,CACd,YAAY,EAAE,yBAAyB,EAAE,EACzC,OAAO,CAAC,EAAE;QAAE,MAAM,CAAC,EAAE,IAAI,CAAA;KAAE,GAC1B,OAAO,CAAC,iBAAiB,CAAC,iBAAiB,CAAC,CAAC;IAC1C,UAAU,CACd,YAAY,EAAE,yBAAyB,EAAE,EACzC,OAAO,EAAE;QAAE,MAAM,EAAE,KAAK,CAAA;KAAE,GACzB,OAAO,CAAC,kBAAkB,CAAC,iBAAiB,CAAC,CAAC;IAmC3C,UAAU,CACd,OAAO,EAAE;QAAE,EAAE,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,yBAAyB,CAAA;KAAE,EAAE,EAC1D,OAAO,CAAC,EAAE;QAAE,MAAM,CAAC,EAAE,IAAI,CAAA;KAAE,GAC1B,OAAO,CAAC,iBAAiB,CAAC,iBAAiB,CAAC,CAAC;IAC1C,UAAU,CACd,OAAO,EAAE;QAAE,EAAE,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,yBAAyB,CAAA;KAAE,EAAE,EAC1D,OAAO,EAAE;QAAE,MAAM,EAAE,KAAK,CAAA;KAAE,GACzB,OAAO,CAAC,kBAAkB,CAAC,iBAAiB,CAAC,CAAC;IA4CjD;;;;OAIG;cACgB,gBAAgB,CAAC,IAAI,CAAC,EAAE,kBAAkB,GAAG,eAAe,GAAG,SAAS;cAOxE,iBAAiB,CAClC,IAAI,EAAE,yBAAyB,GAC9B,sBAAsB;cAqCN,uBAAuB,CACxC,IAAI,EAAE,yBAAyB,GAC9B,sBAAsB;cAuCN,WAAW,CAAC,IAAI,EAAE,eAAe,GAAG,iBAAiB;CAGzE"}