@artu-ai/compliance-sdk 0.0.5 → 0.2.0

package/dist/resources/mex/transactions.js

@@ -0,0 +1,259 @@
+/**
+ * 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 { Jurisdiction, createMexTransactionInputSchema, updateMexTransactionInputSchema, } from "@artu-ai/shared";
+import { TransactionsResource } from "../transactions";
+import { MexTransaction } 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 extends TransactionsResource {
+    // ─────────────────────────────────────────────────────────────────
+    // CRUD Operations (override with flattened input types)
+    // ─────────────────────────────────────────────────────────────────
+    /**
+     * Creates a new Mexico transaction with flattened input.
+     */
+    async create(data) {
+        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) {
+        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 retrieveByExternalId(externalId) {
+        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, data) {
+        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) {
+        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 Mexico transactions.
+     *
+     * Accepts flattened MX filter (future MX-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(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, options = {}) {
+        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.
+     */
+    applyScopeToFilter(filter) {
+        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,
+        };
+    }
+    /**
+     * 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,
+            primaryJurisdiction: Jurisdiction.Mexico,
+            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 MexTransaction model.
+     */
+    instantiate(data) {
+        return new MexTransaction(data);
+    }
+}

package/dist/resources/reports.d.ts

@@ -0,0 +1,217 @@
+/**
+ * Reports Resource
+ *
+ * CRUD operations, report items management, validation, and generation.
+ *
+ * This is the base (unscoped) resource. For jurisdiction-scoped SDKs, use:
+ * - MexReportsResource - Mexico-scoped with flattened MX fields
+ * - AVIReportsResource - Mexico AVI-scoped with flattened AVI fields
+ * - JYSReportsResource - Mexico JYS-scoped with flattened JYS fields
+ * - TSCReportsResource - Mexico TSC-scoped with flattened TSC fields
+ */
+import type { CreateReportInput, UpdateReportInput, CreateReportItemInput, UpdateReportItemInput, ReportFilter, ReportItemFilter, ValidationResult, GenerateResult, SubmitReportInput, SubmissionResult, ListOptions, PaginatedResponse, AtomicBatchResult, PartialBatchResult, ValidateReportInput } from "@artu-ai/shared";
+import { BaseResource } from "./base";
+import { Report, ReportItem, type ReportData, type ReportItemData } from "../models";
+export type { ReportFilter, ReportItemFilter };
+/**
+ * Add items result
+ */
+export interface AddItemsResult {
+    added: number;
+    items: ReportItem[];
+}
+/**
+ * Base resource manager for report operations.
+ *
+ * Provides:
+ * - CRUD operations (create, retrieve, update, delete)
+ * - Report items management (add, update, remove items)
+ * - Validation and generation
+ *
+ * @example
+ * ```typescript
+ * // Create a report with full nested format
+ * const report = await sdk.reports.create({
+ *   jurisdictions: {
+ *     MX: {
+ *       actividadVulnerable: {
+ *         AVI: { mesReportado: "202401" }
+ *       }
+ *     }
+ *   }
+ * });
+ *
+ * // Add items to the report
+ * await sdk.reports.addItem(report.id, {
+ *   transactionId: "txn_123",
+ * });
+ *
+ * // Validate the report
+ * const result = await sdk.reports.validate(report.id);
+ * if (result.valid) {
+ *   // Generate XML
+ *   const xml = await sdk.reports.generate(report.id);
+ * }
+ * ```
+ */
+export declare class ReportsResource extends BaseResource<Report, CreateReportInput, UpdateReportInput, ReportFilter> {
+    /**
+     * Creates a new report.
+     *
+     * @param data - Report creation data in nested format
+     * @returns The created report model
+     */
+    create(data: CreateReportInput): Promise<Report>;
+    /**
+     * Retrieves a report by ID.
+     */
+    retrieve(id: string): Promise<Report>;
+    /**
+     * Retrieves a report by metadata key/value.
+     */
+    retrieveByMetadata(key: string, value: string): Promise<Report>;
+    /**
+     * Retrieves a report by externalId.
+     */
+    retrieveByExternalId(externalId: string): Promise<Report>;
+    /**
+     * Updates a report.
+     */
+    update(id: string, data: UpdateReportInput): Promise<Report>;
+    /**
+     * Deletes a report.
+     */
+    delete(id: string): Promise<void>;
+    /**
+     * Lists reports with optional filtering and pagination.
+     */
+    list(options?: ListOptions<ReportFilter>): Promise<PaginatedResponse<Report>>;
+    /**
+     * Returns an async iterator over all reports matching the filter.
+     */
+    iterate(filter?: ReportFilter): AsyncGenerator<Report, void, undefined>;
+    /**
+     * Adds an item to a report.
+     */
+    addItem(reportId: string, data: CreateReportItemInput): Promise<ReportItem>;
+    /**
+     * Gets a specific report item.
+     */
+    getItem(reportId: string, itemId: string): Promise<ReportItem>;
+    /**
+     * Updates a report item.
+     */
+    updateItem(reportId: string, itemId: string, data: UpdateReportItemInput): Promise<ReportItem>;
+    /**
+     * Removes an item from a report.
+     */
+    removeItem(reportId: string, itemId: string): Promise<void>;
+    /**
+     * Lists items in a report.
+     */
+    listItems(reportId: string, options?: ListOptions<ReportItemFilter>): Promise<PaginatedResponse<ReportItem>>;
+    /**
+     * Adds multiple items to a report.
+     * Validates all items upfront - fails fast if any item is invalid.
+     */
+    addItems(reportId: string, items: CreateReportItemInput[]): Promise<AddItemsResult>;
+    /**
+     * Removes multiple items from a report.
+     */
+    removeItems(reportId: string, itemIds: string[]): Promise<{
+        removed: number;
+    }>;
+    /**
+     * Validates a report and its items.
+     *
+     * Requires jurisdiction and activity-specific defaults.
+     * For scoped SDKs, use the scoped resource which provides a simpler API.
+     *
+     * @example
+     * ```typescript
+     * const result = await sdk.reports.validateReport({
+     *   reportId: report.id,
+     *   jurisdiction: "MX",
+     *   actividadVulnerable: "AVI",
+     *   defaults: {
+     *     rfc: "ABC200101XXX",
+     *     platformDomain: "https://example.com",
+     *   },
+     * });
+     * ```
+     */
+    validateReport(input: ValidateReportInput): Promise<ValidationResult>;
+    /**
+     * Generates the report output (e.g., XML for Mexico reports).
+     *
+     * Requires the same input as validateReport since generation uses
+     * the same transformation and defaults.
+     *
+     * @example
+     * ```typescript
+     * const result = await sdk.reports.generate({
+     *   reportId: report.id,
+     *   jurisdiction: "MX",
+     *   actividadVulnerable: "AVI",
+     *   defaults: {
+     *     rfc: "ABC200101XXX",
+     *     platformDomain: "https://example.com",
+     *   },
+     * });
+     * ```
+     */
+    generate(input: ValidateReportInput): Promise<GenerateResult>;
+    /**
+     * Submits a validated report.
+     *
+     * The report must be in "valid" status. After submission, the report
+     * is locked and cannot be edited.
+     *
+     * @param reportId - The report ID
+     * @param input - Submission data with jurisdiction-specific structure
+     */
+    submit(input: SubmitReportInput): Promise<SubmissionResult>;
+    /**
+     * Creates multiple reports in a single request.
+     *
+     * @param reports - Array of report creation data
+     * @param options - Batch options (atomic: true by default)
+     * @returns Atomic result with data array, or partial result with succeeded/failed
+     */
+    createMany(reports: CreateReportInput[], options?: {
+        atomic?: true;
+    }): Promise<AtomicBatchResult<Report>>;
+    createMany(reports: CreateReportInput[], options: {
+        atomic: false;
+    }): Promise<PartialBatchResult<Report>>;
+    /**
+     * Updates multiple reports in a single request.
+     *
+     * @param updates - Array of { id, data } updates
+     * @param options - Batch options (atomic: true by default)
+     * @returns Atomic result with data array, or partial result with succeeded/failed
+     */
+    updateMany(updates: {
+        id: string;
+        data: UpdateReportInput;
+    }[], options?: {
+        atomic?: true;
+    }): Promise<AtomicBatchResult<Report>>;
+    updateMany(updates: {
+        id: string;
+        data: UpdateReportInput;
+    }[], options: {
+        atomic: false;
+    }): Promise<PartialBatchResult<Report>>;
+    /**
+     * Instantiates a Report model from API response data.
+     * Subclasses override this to return their specific model type.
+     */
+    protected instantiate(data: ReportData): Report;
+    /**
+     * Instantiates a ReportItem model from API response data.
+     * Subclasses override this to return their specific model type.
+     */
+    protected instantiateItem(data: ReportItemData): ReportItem;
+}
+//# sourceMappingURL=reports.d.ts.map

package/dist/resources/reports.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"reports.d.ts","sourceRoot":"","sources":["../../src/resources/reports.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;GAUG;AAGH,OAAO,KAAK,EACV,iBAAiB,EACjB,iBAAiB,EACjB,qBAAqB,EACrB,qBAAqB,EACrB,YAAY,EACZ,gBAAgB,EAChB,gBAAgB,EAChB,cAAc,EACd,iBAAiB,EACjB,gBAAgB,EAChB,WAAW,EACX,iBAAiB,EACjB,iBAAiB,EACjB,kBAAkB,EAClB,mBAAmB,EACpB,MAAM,iBAAiB,CAAC;AAUzB,OAAO,EAAE,YAAY,EAAE,MAAM,QAAQ,CAAC;AACtC,OAAO,EACL,MAAM,EACN,UAAU,EACV,KAAK,UAAU,EACf,KAAK,cAAc,EACpB,MAAM,WAAW,CAAC;AAOnB,YAAY,EAAE,YAAY,EAAE,gBAAgB,EAAE,CAAC;AAE/C;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,UAAU,EAAE,CAAC;CACrB;AAMD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiCG;AACH,qBAAa,eAAgB,SAAQ,YAAY,CAC/C,MAAM,EACN,iBAAiB,EACjB,iBAAiB,EACjB,YAAY,CACb;IAKC;;;;;OAKG;IACG,MAAM,CAAC,IAAI,EAAE,iBAAiB,GAAG,OAAO,CAAC,MAAM,CAAC;IAUtD;;OAEG;IACG,QAAQ,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAO3C;;OAEG;IACG,kBAAkB,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAOrE;;OAEG;IACG,oBAAoB,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAO/D;;OAEG;IACG,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,iBAAiB,GAAG,OAAO,CAAC,MAAM,CAAC;IASlE;;OAEG;IACG,MAAM,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAIvC;;OAEG;IACG,IAAI,CACR,OAAO,CAAC,EAAE,WAAW,CAAC,YAAY,CAAC,GAClC,OAAO,CAAC,iBAAiB,CAAC,MAAM,CAAC,CAAC;IAWrC;;OAEG;IACH,OAAO,CAAC,MAAM,CAAC,EAAE,YAAY,GAAG,cAAc,CAAC,MAAM,EAAE,IAAI,EAAE,SAAS,CAAC;IAQvE;;OAEG;IACG,OAAO,CACX,QAAQ,EAAE,MAAM,EAChB,IAAI,EAAE,qBAAqB,GAC1B,OAAO,CAAC,UAAU,CAAC;IAUtB;;OAEG;IACG,OAAO,CAAC,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,UAAU,CAAC;IAOpE;;OAEG;IACG,UAAU,CACd,QAAQ,EAAE,MAAM,EAChB,MAAM,EAAE,MAAM,EACd,IAAI,EAAE,qBAAqB,GAC1B,OAAO,CAAC,UAAU,CAAC;IAStB;;OAEG;IACG,UAAU,CAAC,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAMjE;;OAEG;IACG,SAAS,CACb,QAAQ,EAAE,MAAM,EAChB,OAAO,CAAC,EAAE,WAAW,CAAC,gBAAgB,CAAC,GACtC,OAAO,CAAC,iBAAiB,CAAC,UAAU,CAAC,CAAC;IAczC;;;OAGG;IACG,QAAQ,CACZ,QAAQ,EAAE,MAAM,EAChB,KAAK,EAAE,qBAAqB,EAAE,GAC7B,OAAO,CAAC,cAAc,CAAC;IAgB1B;;OAEG;IACG,WAAW,CACf,QAAQ,EAAE,MAAM,EAChB,OAAO,EAAE,MAAM,EAAE,GAChB,OAAO,CAAC;QAAE,OAAO,EAAE,MAAM,CAAA;KAAE,CAAC;IAU/B;;;;;;;;;;;;;;;;;;OAkBG;IACG,cAAc,CAAC,KAAK,EAAE,mBAAmB,GAAG,OAAO,CAAC,gBAAgB,CAAC;IAK3E;;;;;;;;;;;;;;;;;;OAkBG;IACG,QAAQ,CAAC,KAAK,EAAE,mBAAmB,GAAG,OAAO,CAAC,cAAc,CAAC;IASnE;;;;;;;;OAQG;IACG,MAAM,CAAC,KAAK,EAAE,iBAAiB,GAAG,OAAO,CAAC,gBAAgB,CAAC;IASjE;;;;;;OAMG;IACG,UAAU,CACd,OAAO,EAAE,iBAAiB,EAAE,EAC5B,OAAO,CAAC,EAAE;QAAE,MAAM,CAAC,EAAE,IAAI,CAAA;KAAE,GAC1B,OAAO,CAAC,iBAAiB,CAAC,MAAM,CAAC,CAAC;IAC/B,UAAU,CACd,OAAO,EAAE,iBAAiB,EAAE,EAC5B,OAAO,EAAE;QAAE,MAAM,EAAE,KAAK,CAAA;KAAE,GACzB,OAAO,CAAC,kBAAkB,CAAC,MAAM,CAAC,CAAC;IA6BtC;;;;;;OAMG;IACG,UAAU,CACd,OAAO,EAAE;QAAE,EAAE,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,iBAAiB,CAAA;KAAE,EAAE,EAClD,OAAO,CAAC,EAAE;QAAE,MAAM,CAAC,EAAE,IAAI,CAAA;KAAE,GAC1B,OAAO,CAAC,iBAAiB,CAAC,MAAM,CAAC,CAAC;IAC/B,UAAU,CACd,OAAO,EAAE;QAAE,EAAE,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,iBAAiB,CAAA;KAAE,EAAE,EAClD,OAAO,EAAE;QAAE,MAAM,EAAE,KAAK,CAAA;KAAE,GACzB,OAAO,CAAC,kBAAkB,CAAC,MAAM,CAAC,CAAC;IAsCtC;;;OAGG;IACH,SAAS,CAAC,WAAW,CAAC,IAAI,EAAE,UAAU,GAAG,MAAM;IAI/C;;;OAGG;IACH,SAAS,CAAC,eAAe,CAAC,IAAI,EAAE,cAAc,GAAG,UAAU;CAG5D"}