@artu-ai/compliance-sdk 0.0.5 → 0.2.0

package/dist/resources/mex/reports.js

@@ -0,0 +1,404 @@
+/**
+ * Mexico Reports Resource
+ *
+ * Extends ReportsResource with Mexico-specific behavior:
+ * - Accepts flattened CreateMexReportInput (MX fields at root level)
+ * - Filters list/iterate to Mexico reports only
+ * - Returns MexReport models
+ */
+import { z } from "zod";
+import { Jurisdiction, createMexReportInputSchema, updateMexReportInputSchema, createMexReportItemInputSchema, updateMexReportItemInputSchema, mexValidateReportInputSchema, mexSubmitReportInputSchema, } from "@artu-ai/shared";
+import { ReportsResource } from "../reports";
+import { MexReport } from "../../models";
+import { MexReportItem } from "../../models/mex";
+// ===========================
+// MexReportsResource
+// ===========================
+/**
+ * Mexico-scoped reports resource.
+ *
+ * Provides the same operations as ReportsResource but with:
+ * - Flattened input types (MX fields at root level)
+ * - Automatic jurisdiction scoping
+ * - MexReport model return type
+ *
+ * @example
+ * ```typescript
+ * const mexSdk = new ComplianceSDK({
+ *   apiKey,
+ *   environment: "test",
+ *   jurisdiction: Jurisdiction.Mexico,
+ * });
+ *
+ * // Create with flattened input
+ * const report = await mexSdk.reports.create({
+ *   actividadVulnerable: {
+ *     AVI: { mesReportado: "202401" },
+ *   },
+ * });
+ *
+ * // List returns only Mexico reports
+ * const { data } = await mexSdk.reports.list();
+ * // data is MexReport[]
+ * ```
+ */
+export class MexReportsResource extends ReportsResource {
+    // ─────────────────────────────────────────────────────────────────
+    // Report CRUD (override with flattened input types)
+    // ─────────────────────────────────────────────────────────────────
+    /**
+     * Creates a new Mexico report with flattened input.
+     */
+    async create(data) {
+        const validated = this.validate(createMexReportInputSchema, data);
+        const nestedData = this.transformToNested(validated);
+        const response = await this.execute(() => this.trpc.reports.create.mutate(nestedData));
+        return this.instantiate(response);
+    }
+    /**
+     * Retrieves a report by ID.
+     */
+    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);
+    }
+    /**
+     * Updates a Mexico report with flattened input.
+     */
+    async update(id, data) {
+        const validated = this.validate(updateMexReportInputSchema, 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 (scoped to Mexico)
+    // ─────────────────────────────────────────────────────────────────
+    /**
+     * Lists Mexico reports with optional filtering.
+     *
+     * Accepts flattened MX filter (future MX-specific report fields at root level).
+     * Automatically filters to reports with Mexico jurisdiction data.
+     */
+    async list(options) {
+        const scopedFilter = this.applyScopeToFilter(options?.filter);
+        const response = await this.execute(() => this.trpc.reports.list.query({
+            ...options,
+            filter: scopedFilter,
+        }));
+        return {
+            data: response.data.map((r) => this.instantiate(r)),
+            pagination: response.pagination,
+        };
+    }
+    /**
+     * Iterates over Mexico reports.
+     *
+     * Accepts flattened MX filter (future MX-specific report fields at root level).
+     * Automatically filters to reports with Mexico jurisdiction data.
+     */
+    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(createMexReportInputSchema), 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: updateMexReportInputSchema,
+        });
+        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
+    // ─────────────────────────────────────────────────────────────────
+    /**
+     * Adds an item to a report with flattened Mexico input.
+     */
+    async addItem(reportId, data) {
+        const validated = this.validate(createMexReportItemInputSchema, data);
+        const nestedData = this.transformItemToNested(validated);
+        const response = await this.execute(() => this.trpc.reports.addItem.mutate({ reportId, data: nestedData }));
+        return this.instantiateItem(response);
+    }
+    /**
+     * Gets a specific report item.
+     */
+    async getItem(reportId, itemId) {
+        const response = await this.execute(() => this.trpc.reports.getItem.query({ reportId, itemId }));
+        return this.instantiateItem(response);
+    }
+    /**
+     * Updates a report item with flattened Mexico input.
+     */
+    async updateItem(reportId, itemId, data) {
+        const validated = this.validate(updateMexReportItemInputSchema, data);
+        const nestedData = this.transformItemUpdateToNested(validated);
+        const response = await this.execute(() => this.trpc.reports.updateItem.mutate({
+            reportId,
+            itemId,
+            data: nestedData,
+        }));
+        return this.instantiateItem(response);
+    }
+    /**
+     * Lists items in a report.
+     */
+    async listItems(reportId, options) {
+        const response = await this.execute(() => this.trpc.reports.listItems.query({
+            reportId,
+            ...options,
+        }));
+        return {
+            data: response.data.map((i) => this.instantiateItem(i)),
+            pagination: response.pagination,
+        };
+    }
+    /**
+     * Adds multiple items to a report with flattened Mexico input.
+     */
+    async addItems(reportId, items) {
+        const validated = this.validate(z.array(createMexReportItemInputSchema), 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 a Mexico report.
+     *
+     * Uses Mexico-scoped validation input (jurisdiction is implicit).
+     *
+     * @example
+     * ```typescript
+     * const result = await mexSdk.reports.validateReport({
+     *   reportId: report.id,
+     *   actividadVulnerable: "AVI",
+     *   defaults: {
+     *     rfc: "ABC200101XXX",
+     *     platformDomain: "https://example.com",
+     *   },
+     * });
+     * ```
+     */
+    async validateReport(input) {
+        const validated = this.validate(mexValidateReportInputSchema, input);
+        return this.execute(() => this.trpc.reports.validate.mutate(validated));
+    }
+    // ─────────────────────────────────────────────────────────────────
+    // Generation
+    // ─────────────────────────────────────────────────────────────────
+    /**
+     * Generates XML for a Mexico report.
+     *
+     * Uses the same input as validateReport since generation requires
+     * the same transformation and defaults.
+     *
+     * @example
+     * ```typescript
+     * const result = await mexSdk.reports.generateReport({
+     *   reportId: report.id,
+     *   actividadVulnerable: "AVI",
+     *   defaults: {
+     *     rfc: "ABC200101XXX",
+     *     platformDomain: "https://example.com",
+     *   },
+     * });
+     * console.log(result.xml);
+     * ```
+     */
+    async generateReport(input) {
+        const validated = this.validate(mexValidateReportInputSchema, input);
+        return this.execute(() => this.trpc.reports.generate.mutate(validated));
+    }
+    // ─────────────────────────────────────────────────────────────────
+    // Submission
+    // ─────────────────────────────────────────────────────────────────
+    /**
+     * Submits a validated Mexico report.
+     *
+     * The report must be in "valid" status. After submission, the report
+     * is locked and cannot be edited (except rejected reports which can
+     * be edited and resubmitted).
+     *
+     * @param reportId - The report ID
+     * @param actividadVulnerable - The activity type (AVI, JYS, or TSC)
+     * @param data - Optional submission data (acuseRecibo, notes)
+     *
+     * @example
+     * ```typescript
+     * const result = await mexSdk.reports.submitReport(
+     *   report.id,
+     *   "AVI",
+     *   { acuseRecibo: "SAT-12345", notes: "Submitted via portal" }
+     * );
+     * ```
+     */
+    async submit(input) {
+        const validated = this.validate(mexSubmitReportInputSchema, input);
+        const jurisdictions = {
+            MX: {
+                actividadVulnerable: validated.actividadVulnerable,
+            },
+        };
+        return this.execute(() => this.trpc.reports.submit.mutate({
+            reportId: validated.reportId,
+            jurisdictions,
+        }));
+    }
+    // ─────────────────────────────────────────────────────────────────
+    // Protected Helpers
+    // ─────────────────────────────────────────────────────────────────
+    /**
+     * Applies Mexico jurisdiction filter.
+     *
+     * Currently MexReportFilter has the same fields as the base filter,
+     * but this method ensures the jurisdiction scope is applied.
+     * Uses `availableJurisdictions` to find any report that includes Mexico.
+     */
+    applyScopeToFilter(filter) {
+        if (!filter) {
+            return {
+                availableJurisdictions: Jurisdiction.Mexico,
+            };
+        }
+        // Currently no MX-specific report filter fields to nest
+        // Just pass through and add jurisdiction scope
+        return {
+            ...filter,
+            availableJurisdictions: Jurisdiction.Mexico,
+        };
+    }
+    /**
+     * Transforms flattened MX input to nested API format.
+     */
+    transformToNested(data) {
+        const { actividadVulnerable, ...baseFields } = data;
+        // Build MX jurisdiction data
+        const mexData = {};
+        if (actividadVulnerable !== undefined) {
+            mexData.actividadVulnerable = actividadVulnerable;
+        }
+        return {
+            ...baseFields,
+            jurisdictions: Object.keys(mexData).length > 0
+                ? {
+                    MX: mexData,
+                }
+                : undefined,
+        };
+    }
+    /**
+     * Transforms flattened MX update input to nested API format.
+     */
+    transformUpdateToNested(data) {
+        const { actividadVulnerable, ...baseFields } = data;
+        if (actividadVulnerable === undefined) {
+            return baseFields;
+        }
+        return {
+            ...baseFields,
+            jurisdictions: {
+                MX: { actividadVulnerable },
+            },
+        };
+    }
+    /**
+     * Instantiates a MexReport model.
+     */
+    instantiate(data) {
+        return new MexReport(data);
+    }
+    /**
+     * Instantiates a MexReportItem model.
+     */
+    instantiateItem(data) {
+        return new MexReportItem(data);
+    }
+    /**
+     * Transforms flattened MX report item input to nested API format.
+     */
+    transformItemToNested(data) {
+        const { actividadVulnerable, ...baseFields } = data;
+        if (actividadVulnerable === undefined) {
+            return baseFields;
+        }
+        return {
+            ...baseFields,
+            jurisdictions: {
+                MX: { actividadVulnerable },
+            },
+        };
+    }
+    /**
+     * Transforms flattened MX report item update input to nested API format.
+     */
+    transformItemUpdateToNested(data) {
+        const { actividadVulnerable, ...baseFields } = data;
+        if (actividadVulnerable === undefined) {
+            return baseFields;
+        }
+        return {
+            ...baseFields,
+            jurisdictions: {
+                MX: { actividadVulnerable },
+            },
+        };
+    }
+}

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

@@ -0,0 +1,117 @@
+/**
+ * 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 type { CreateTransactionInput, UpdateTransactionInput, TransactionFilter, ListOptions, PaginatedResponse, CreateMexTransactionInput, UpdateMexTransactionInput, AtomicBatchResult, PartialBatchResult, RelatedClient, MexTransactionFilter } from "@artu-ai/shared";
+import { ClientRole } from "@artu-ai/shared";
+import { TransactionsResource } from "../transactions";
+import { MexTransaction, type TransactionData } from "../../models";
+/**
+ * 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 declare class MexTransactionsResource extends TransactionsResource {
+    /**
+     * Creates a new Mexico transaction with flattened input.
+     */
+    create(data: CreateMexTransactionInput): Promise<MexTransaction>;
+    /**
+     * Retrieves a transaction by ID.
+     */
+    retrieve(id: string): Promise<MexTransaction>;
+    retrieveByMetadata(key: string, value: string): Promise<MexTransaction>;
+    retrieveByExternalId(externalId: string): Promise<MexTransaction>;
+    /**
+     * Updates a Mexico transaction with flattened input.
+     */
+    update(id: string, data: UpdateMexTransactionInput): Promise<MexTransaction>;
+    /**
+     * Lists Mexico transactions with optional filtering.
+     *
+     * Accepts flattened MX filter (future MX-specific transaction fields at root level).
+     */
+    list(options?: ListOptions<MexTransactionFilter>): Promise<PaginatedResponse<MexTransaction>>;
+    /**
+     * Iterates over Mexico transactions.
+     *
+     * Accepts flattened MX filter (future MX-specific transaction fields at root level).
+     */
+    iterate(filter?: MexTransactionFilter): AsyncGenerator<MexTransaction, void, undefined>;
+    listByClient(clientId: string, options?: {
+        cursor?: string;
+        limit?: number;
+    }): Promise<PaginatedResponse<MexTransaction>>;
+    linkClient(transactionId: string, clientId: string, role?: ClientRole): Promise<MexTransaction>;
+    unlinkClient(transactionId: string, clientId: string): Promise<MexTransaction>;
+    setClients(transactionId: string, clients: RelatedClient[]): Promise<MexTransaction>;
+    createMany(transactions: CreateMexTransactionInput[], options?: {
+        atomic?: true;
+    }): Promise<AtomicBatchResult<MexTransaction>>;
+    createMany(transactions: CreateMexTransactionInput[], options: {
+        atomic: false;
+    }): Promise<PartialBatchResult<MexTransaction>>;
+    updateMany(updates: {
+        id: string;
+        data: UpdateMexTransactionInput;
+    }[], options?: {
+        atomic?: true;
+    }): Promise<AtomicBatchResult<MexTransaction>>;
+    updateMany(updates: {
+        id: string;
+        data: UpdateMexTransactionInput;
+    }[], options: {
+        atomic: false;
+    }): Promise<PartialBatchResult<MexTransaction>>;
+    /**
+     * 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;
+    /**
+     * Transforms flattened MX input to nested API format.
+     */
+    protected transformToNested(data: CreateMexTransactionInput): CreateTransactionInput;
+    /**
+     * Transforms flattened MX update input to nested API format.
+     */
+    protected transformUpdateToNested(data: UpdateMexTransactionInput): UpdateTransactionInput;
+    /**
+     * Instantiates a MexTransaction model.
+     */
+    protected instantiate(data: TransactionData): MexTransaction;
+}
+//# sourceMappingURL=transactions.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"transactions.d.ts","sourceRoot":"","sources":["../../../src/resources/mex/transactions.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAGH,OAAO,KAAK,EACV,sBAAsB,EACtB,sBAAsB,EACtB,iBAAiB,EACjB,WAAW,EACX,iBAAiB,EACjB,yBAAyB,EACzB,yBAAyB,EACzB,iBAAiB,EACjB,kBAAkB,EAClB,aAAa,EACb,oBAAoB,EACrB,MAAM,iBAAiB,CAAC;AACzB,OAAO,EAIL,UAAU,EACX,MAAM,iBAAiB,CAAC;AACzB,OAAO,EAAE,oBAAoB,EAAE,MAAM,iBAAiB,CAAC;AAEvD,OAAO,EAAE,cAAc,EAAE,KAAK,eAAe,EAAE,MAAM,cAAc,CAAC;AAMpE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8BG;AACH,qBAAa,uBAAwB,SAAQ,oBAAoB;IAK/D;;OAEG;IACG,MAAM,CAAC,IAAI,EAAE,yBAAyB,GAAG,OAAO,CAAC,cAAc,CAAC;IAWtE;;OAEG;IACG,QAAQ,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,cAAc,CAAC;IAO7C,kBAAkB,CACtB,GAAG,EAAE,MAAM,EACX,KAAK,EAAE,MAAM,GACZ,OAAO,CAAC,cAAc,CAAC;IAOpB,oBAAoB,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,cAAc,CAAC;IAOvE;;OAEG;IACG,MAAM,CACV,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,yBAAyB,GAC9B,OAAO,CAAC,cAAc,CAAC;IAc1B;;;;OAIG;IACG,IAAI,CACR,OAAO,CAAC,EAAE,WAAW,CAAC,oBAAoB,CAAC,GAC1C,OAAO,CAAC,iBAAiB,CAAC,cAAc,CAAC,CAAC;IAgB7C;;;;OAIG;IACH,OAAO,CACL,MAAM,CAAC,EAAE,oBAAoB,GAC5B,cAAc,CAAC,cAAc,EAAE,IAAI,EAAE,SAAS,CAAC;IAS5C,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,cAAc,CAAC,CAAC;IAWvC,UAAU,CACd,aAAa,EAAE,MAAM,EACrB,QAAQ,EAAE,MAAM,EAChB,IAAI,CAAC,EAAE,UAAU,GAChB,OAAO,CAAC,cAAc,CAAC;IAWpB,YAAY,CAChB,aAAa,EAAE,MAAM,EACrB,QAAQ,EAAE,MAAM,GACf,OAAO,CAAC,cAAc,CAAC;IAUpB,UAAU,CACd,aAAa,EAAE,MAAM,EACrB,OAAO,EAAE,aAAa,EAAE,GACvB,OAAO,CAAC,cAAc,CAAC;IAcpB,UAAU,CACd,YAAY,EAAE,yBAAyB,EAAE,EACzC,OAAO,CAAC,EAAE;QAAE,MAAM,CAAC,EAAE,IAAI,CAAA;KAAE,GAC1B,OAAO,CAAC,iBAAiB,CAAC,cAAc,CAAC,CAAC;IACvC,UAAU,CACd,YAAY,EAAE,yBAAyB,EAAE,EACzC,OAAO,EAAE;QAAE,MAAM,EAAE,KAAK,CAAA;KAAE,GACzB,OAAO,CAAC,kBAAkB,CAAC,cAAc,CAAC,CAAC;IAmCxC,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,cAAc,CAAC,CAAC;IACvC,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,cAAc,CAAC,CAAC;IA4C9C;;;;;OAKG;IACH,SAAS,CAAC,kBAAkB,CAAC,MAAM,CAAC,EAAE,oBAAoB,GAAG,iBAAiB;IAe9E;;OAEG;IACH,SAAS,CAAC,iBAAiB,CACzB,IAAI,EAAE,yBAAyB,GAC9B,sBAAsB;IAqBzB;;OAEG;IACH,SAAS,CAAC,uBAAuB,CAC/B,IAAI,EAAE,yBAAyB,GAC9B,sBAAsB;IAezB;;OAEG;cACgB,WAAW,CAAC,IAAI,EAAE,eAAe,GAAG,cAAc;CAGtE"}