@artu-ai/compliance-sdk 0.13.4 → 0.17.0

package/dist/resources/mx/av/inm/clients.js

@@ -0,0 +1,292 @@
+/**
+ * INM (Inmuebles - Real Estate Sale/Purchase) Clients Resource
+ *
+ * Extends MexClientsResource with INM-specific behavior.
+ * INM clients support Individual, Company, and Trust discriminated union types.
+ * Returns MexINMClient models.
+ */
+import { CodigoActividad, createINMClientInputSchema, inmClientSortingFieldMapping, linkedClientSchema, transformSort, updateINMClientInputSchema, upsertINMClientInputSchema, } from "@artu-ai/shared";
+import { z } from "zod";
+import { MexINMClient, } from "../../../../models";
+import { AVClientsResource } from "../clients";
+// ===========================
+// INMClientsResource
+// ===========================
+/**
+ * INM (Inmuebles - Real Estate Sale/Purchase) scoped clients resource.
+ *
+ * @example
+ * ```typescript
+ * const inmSdk = new ComplianceSDK({
+ *   apiKey,
+ *   environment: "test",
+ *   scope: "MX:AV:INM",
+ * });
+ *
+ * const client = await inmSdk.clients.create({
+ *   type: ClientType.Person,
+ *   name: "Juan García",
+ *   rfc: "GAJL850101ABC",
+ * });
+ *
+ * // Returns MexINMClient
+ * ```
+ */
+export class INMClientsResource extends AVClientsResource {
+    relatedPartyParent() {
+        return this.makeRelatedPartyParent((input) => this.transformToNested(this.validate(createINMClientInputSchema, input)));
+    }
+    // ─────────────────────────────────────────────────────────────────
+    // CRUD Operations
+    // ─────────────────────────────────────────────────────────────────
+    async create(data) {
+        const validated = this.validate(createINMClientInputSchema, data);
+        const nestedData = this.transformToNested(validated);
+        const response = await this.execute(() => this.trpc.clients.create.mutate(nestedData));
+        return this.instantiate(response);
+    }
+    async retrieve(id, options) {
+        const response = await this.execute(() => this.trpc.clients.retrieve.query({
+            id,
+            include: options?.include,
+            requireScope: this.buildRequireScope(options?.crossScope),
+        }));
+        return this.instantiate(response);
+    }
+    async retrieveByExternalId(externalId, opts) {
+        const response = await this.execute(() => this.trpc.clients.retrieveByExternalId.query({
+            externalId,
+            requireScope: this.buildRequireScope(opts?.crossScope),
+        }));
+        return this.instantiate(response);
+    }
+    async update(id, data) {
+        const validated = this.validate(updateINMClientInputSchema, data);
+        const nestedData = this.transformUpdateToNested(validated);
+        const response = await this.execute(() => this.trpc.clients.update.mutate({ id, data: nestedData }));
+        return this.instantiate(response);
+    }
+    // ─────────────────────────────────────────────────────────────────
+    // List & Pagination
+    // ─────────────────────────────────────────────────────────────────
+    async list(options) {
+        const { crossScope, ...rest } = options ?? {};
+        const scopedFilter = this.applyAutoScope(this.applyScopeToFilter(rest.filter), crossScope);
+        const scopedSort = this.applyScopeToSort(rest.sort);
+        const response = await this.execute(() => this.trpc.clients.list.query({
+            ...rest,
+            filter: scopedFilter,
+            sort: scopedSort,
+        }));
+        return {
+            data: response.data.map((c) => this.instantiate(c)),
+            pagination: response.pagination,
+        };
+    }
+    iterate(options) {
+        // Do NOT apply scope here — createIterator calls this.list(), which
+        // applies the flatten transform AND auto-scope exactly once. Pre-applying
+        // either here would double-inject.
+        return this.createIterator({
+            filter: options?.filter,
+            sort: options?.sort,
+            pageSize: options?.pageSize,
+            crossScope: options?.crossScope,
+        });
+    }
+    async count(filter, options) {
+        const scopedFilter = this.applyAutoScope(this.applyScopeToFilter(filter), options?.crossScope);
+        const response = await this.execute(() => this.trpc.clients.count.query({
+            filter: scopedFilter,
+            includeNonPrimary: options?.includeNonPrimary,
+        }));
+        return response.count;
+    }
+    async createMany(clients, options = {}) {
+        const atomic = options.atomic ?? true;
+        const validated = this.validate(z.array(createINMClientInputSchema), clients);
+        const nestedClients = validated.map((c) => this.transformToNested(c));
+        const response = await this.execute(() => this.trpc.clients.createMany.mutate({ items: nestedClients, atomic }));
+        if (response.atomic) {
+            return {
+                atomic: true,
+                data: response.data.map((c) => this.instantiate(c)),
+            };
+        }
+        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: updateINMClientInputSchema,
+        });
+        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.clients.updateMany.mutate({ items: nestedUpdates, atomic }));
+        if (response.atomic) {
+            return {
+                atomic: true,
+                data: response.data.map((c) => this.instantiate(c)),
+            };
+        }
+        else {
+            return {
+                atomic: false,
+                succeeded: response.succeeded.map((item) => ({
+                    index: item.index,
+                    data: this.instantiate(item.data),
+                })),
+                failed: response.failed,
+            };
+        }
+    }
+    // ─────────────────────────────────────────────────────────────────
+    // Upsert Operations
+    // ─────────────────────────────────────────────────────────────────
+    async upsertByExternalId(data) {
+        const validated = this.validate(upsertINMClientInputSchema, data);
+        const nestedData = this.transformToNested(validated);
+        const response = await this.execute(() => this.trpc.clients.upsertByExternalId.mutate(nestedData));
+        return {
+            data: this.instantiate(response.data),
+            action: response.action,
+        };
+    }
+    async upsertManyByExternalId(clients, options = {}) {
+        const atomic = options.atomic ?? true;
+        const validated = this.validate(z.array(upsertINMClientInputSchema), clients);
+        const nestedItems = validated.map((c) => this.transformToNested(c));
+        const response = await this.execute(() => this.trpc.clients.upsertManyByExternalId.mutate({
+            items: nestedItems,
+            atomic,
+        }));
+        if (response.atomic) {
+            return {
+                atomic: true,
+                data: response.data.map((item) => ({
+                    data: this.instantiate(item.data),
+                    action: item.action,
+                })),
+            };
+        }
+        else {
+            return {
+                atomic: false,
+                succeeded: response.succeeded.map((item) => ({
+                    index: item.index,
+                    data: {
+                        data: this.instantiate(item.data.data),
+                        action: item.data.action,
+                    },
+                })),
+                failed: response.failed,
+            };
+        }
+    }
+    // ─────────────────────────────────────────────────────────────────
+    // Client-to-Client Relationship Management
+    // ─────────────────────────────────────────────────────────────────
+    async linkClient(parentClientId, childClientId, relationshipType, metadata) {
+        const response = await this.execute(() => this.trpc.clients.linkClient.mutate({
+            parentClientId,
+            childClientId,
+            relationshipType,
+            metadata,
+        }));
+        return this.instantiate(response);
+    }
+    async unlinkClient(parentClientId, childClientId, relationshipType) {
+        const response = await this.execute(() => this.trpc.clients.unlinkClient.mutate({
+            parentClientId,
+            childClientId,
+            relationshipType,
+        }));
+        return this.instantiate(response);
+    }
+    async listLinkedClients(parentClientId, relationshipType) {
+        return super.listLinkedClients(parentClientId, relationshipType);
+    }
+    async setLinkedClients(parentClientId, linkedClients) {
+        const validated = this.validate(z.array(linkedClientSchema), linkedClients);
+        const response = await this.execute(() => this.trpc.clients.setLinkedClients.mutate({
+            parentClientId,
+            linkedClients: validated,
+        }));
+        return this.instantiate(response);
+    }
+    async syncAll(clientId, data, options) {
+        const transformedClient = data.client
+            ? clientId
+                ? this.transformUpdateToNested(data.client)
+                : this.transformToNested(data.client)
+            : undefined;
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any
+        const result = await super.syncAll(clientId, {
+            ...data,
+            client: transformedClient,
+        }, options);
+        return {
+            ...result,
+            client: this.instantiate(result.client),
+        };
+    }
+    // ─────────────────────────────────────────────────────────────────
+    // Protected Helpers
+    // ─────────────────────────────────────────────────────────────────
+    transformToNested(data) {
+        const nested = super.transformToNested(data);
+        const mexData = nested.scopeData?.MX;
+        return {
+            ...nested,
+            scopes: ["MX", "MX:AV", "MX:AV:INM"],
+            scopeData: {
+                MX: {
+                    ...mexData,
+                    actividadVulnerable: {
+                        [CodigoActividad.INM]: {},
+                    },
+                },
+            },
+        };
+    }
+    transformUpdateToNested(data) {
+        const nested = super.transformUpdateToNested(data);
+        const mexData = (nested.scopeData?.MX ??
+            {});
+        mexData.actividadVulnerable = {
+            ...mexData.actividadVulnerable,
+            [CodigoActividad.INM]: {},
+        };
+        return {
+            ...nested,
+            scopes: ["MX", "MX:AV", "MX:AV:INM"],
+            scopeData: { MX: mexData },
+        };
+    }
+    instantiate(data) {
+        return new MexINMClient(data);
+    }
+    /** Materializes a raw payload into a {@link MexINMClient} (return type narrowed via the `instantiate` override). */
+    materialize(data) {
+        return this.instantiate(data);
+    }
+    applyScopeToSort(sort) {
+        if (!sort || sort.length === 0) {
+            return undefined;
+        }
+        return transformSort(sort, inmClientSortingFieldMapping);
+    }
+}

package/dist/resources/mx/av/inm/index.d.ts

@@ -0,0 +1,7 @@
+/**
+ * INM (Inmuebles - Real Estate Sale/Purchase) Scoped ResourceUtils
+ */
+export { INMAlertsResource } from "./alerts";
+export { INMClientsResource } from "./clients";
+export { INMProductsResource } from "./products";
+export { INMTransactionsResource } from "./transactions";

package/dist/resources/mx/av/inm/index.js

@@ -0,0 +1,7 @@
+/**
+ * INM (Inmuebles - Real Estate Sale/Purchase) Scoped ResourceUtils
+ */
+export { INMAlertsResource } from "./alerts";
+export { INMClientsResource } from "./clients";
+export { INMProductsResource } from "./products";
+export { INMTransactionsResource } from "./transactions";

package/dist/resources/mx/av/inm/products.d.ts

@@ -0,0 +1,68 @@
+/**
+ * INM (Inmuebles - Real Estate Sale/Purchase) Products Resource
+ *
+ * Extends MexProductsResource with INM-specific behavior:
+ * - Accepts flattened CreateINMProductInput (INM fields at root level)
+ * - Returns MexINMProduct models
+ * - Handles inmueble defaults (inmuebles[0]) and payment defaults (payments[0])
+ */
+import type { CreateINMProductInput, CreateProductInput, ListOptions, PaginatedResponse, ProductFilter, ProductSort, UpdateINMProductInput, UpdateProductInput, UpsertINMProductInput, UpsertResult } from "@artu-ai/shared";
+import { MexINMProduct, type ProductData } from "../../../../models";
+import { AVProductsResource } from "../products";
+/**
+ * INM (Inmuebles - Real Estate Sale/Purchase) scoped products resource.
+ *
+ * @example
+ * ```typescript
+ * const inmSdk = new ComplianceSDK({
+ *   apiKey,
+ *   environment: "test",
+ *   scope: "MX:AV:INM",
+ * });
+ *
+ * const product = await inmSdk.products.create({
+ *   name: "Standard Property",
+ *   operationType: "501",
+ *   inmuebles: [{
+ *     type: "1",
+ *     value: "5000000",
+ *     colonia: "Roma Norte",
+ *     calle: "Alvaro Obregon",
+ *     numeroExterior: "100",
+ *     postalCode: "06700",
+ *   }],
+ *   payments: [{
+ *     paymentForm: "1",
+ *     monetaryInstrument: "8",
+ *   }],
+ * });
+ * ```
+ */
+export declare class INMProductsResource extends AVProductsResource {
+    create(data: CreateINMProductInput): Promise<MexINMProduct>;
+    retrieve(id: string, opts?: {
+        crossScope?: boolean;
+    }): Promise<MexINMProduct>;
+    retrieveByExternalId(externalId: string, opts?: {
+        crossScope?: boolean;
+    }): Promise<MexINMProduct>;
+    update(id: string, data: UpdateINMProductInput): Promise<MexINMProduct>;
+    list(options?: ListOptions<ProductFilter, ProductSort> & {
+        crossScope?: boolean;
+    }): Promise<PaginatedResponse<MexINMProduct>>;
+    count(filter?: ProductFilter, options?: {
+        crossScope?: boolean;
+    }): Promise<number>;
+    iterate(options?: {
+        filter?: ProductFilter;
+        sort?: ProductSort;
+        pageSize?: number;
+        crossScope?: boolean;
+    }): AsyncGenerator<MexINMProduct, void, undefined>;
+    upsertByExternalId(data: UpsertINMProductInput): Promise<UpsertResult<MexINMProduct>>;
+    protected transformToNested(data: CreateINMProductInput): CreateProductInput;
+    protected transformUpdateToNested(data: UpdateINMProductInput): UpdateProductInput;
+    protected instantiate(data: ProductData): MexINMProduct;
+    /** Materializes a raw payload into a {@link MexINMProduct} (return type narrowed via the `instantiate` override). */
+    materialize(data: ProductData): MexINMProduct;
+}

package/dist/resources/mx/av/inm/products.js

@@ -0,0 +1,179 @@
+/**
+ * INM (Inmuebles - Real Estate Sale/Purchase) Products Resource
+ *
+ * Extends MexProductsResource with INM-specific behavior:
+ * - Accepts flattened CreateINMProductInput (INM fields at root level)
+ * - Returns MexINMProduct models
+ * - Handles inmueble defaults (inmuebles[0]) and payment defaults (payments[0])
+ */
+import { CodigoActividad, createINMProductInputSchema, updateINMProductInputSchema, upsertINMProductInputSchema, } from "@artu-ai/shared";
+import { MexINMProduct } from "../../../../models";
+import { AVProductsResource } from "../products";
+// ===========================
+// INMProductsResource
+// ===========================
+/**
+ * INM (Inmuebles - Real Estate Sale/Purchase) scoped products resource.
+ *
+ * @example
+ * ```typescript
+ * const inmSdk = new ComplianceSDK({
+ *   apiKey,
+ *   environment: "test",
+ *   scope: "MX:AV:INM",
+ * });
+ *
+ * const product = await inmSdk.products.create({
+ *   name: "Standard Property",
+ *   operationType: "501",
+ *   inmuebles: [{
+ *     type: "1",
+ *     value: "5000000",
+ *     colonia: "Roma Norte",
+ *     calle: "Alvaro Obregon",
+ *     numeroExterior: "100",
+ *     postalCode: "06700",
+ *   }],
+ *   payments: [{
+ *     paymentForm: "1",
+ *     monetaryInstrument: "8",
+ *   }],
+ * });
+ * ```
+ */
+export class INMProductsResource extends AVProductsResource {
+    // ─────────────────────────────────────────────────────────────────
+    // CRUD Operations
+    // ─────────────────────────────────────────────────────────────────
+    async create(data) {
+        const validated = this.validate(createINMProductInputSchema, data);
+        const nestedData = this.transformToNested(validated);
+        const response = await this.execute(() => this.trpc.products.create.mutate(nestedData));
+        return this.instantiate(response);
+    }
+    async retrieve(id, opts) {
+        const response = await this.execute(() => this.trpc.products.retrieve.query({
+            id,
+            requireScope: this.buildRequireScope(opts?.crossScope),
+        }));
+        return this.instantiate(response);
+    }
+    async retrieveByExternalId(externalId, opts) {
+        const response = await this.execute(() => this.trpc.products.retrieveByExternalId.query({
+            externalId,
+            requireScope: this.buildRequireScope(opts?.crossScope),
+        }));
+        return this.instantiate(response);
+    }
+    async update(id, data) {
+        const validated = this.validate(updateINMProductInputSchema, data);
+        const nestedData = this.transformUpdateToNested(validated);
+        const response = await this.execute(() => this.trpc.products.update.mutate({ id, data: nestedData }));
+        return this.instantiate(response);
+    }
+    // ─────────────────────────────────────────────────────────────────
+    // List & Pagination
+    // ─────────────────────────────────────────────────────────────────
+    async list(options) {
+        const { crossScope, ...rest } = options ?? {};
+        const filter = this.applyAutoScope(rest.filter, crossScope);
+        const response = await this.execute(() => this.trpc.products.list.query({ ...rest, filter }));
+        return {
+            data: response.data.map((p) => this.instantiate(p)),
+            pagination: response.pagination,
+        };
+    }
+    async count(filter, options) {
+        const scopedFilter = this.applyAutoScope(filter, options?.crossScope);
+        const response = await this.execute(() => this.trpc.products.count.query({ filter: scopedFilter }));
+        return response.count;
+    }
+    iterate(options) {
+        return this.createIterator({
+            filter: options?.filter,
+            sort: options?.sort,
+            pageSize: options?.pageSize,
+            crossScope: options?.crossScope,
+        });
+    }
+    // ─────────────────────────────────────────────────────────────────
+    // Upsert Operations
+    // ─────────────────────────────────────────────────────────────────
+    async upsertByExternalId(data) {
+        const validated = this.validate(upsertINMProductInputSchema, data);
+        const nestedData = this.transformToNested(validated);
+        const response = await this.execute(() => this.trpc.products.upsertByExternalId.mutate(nestedData));
+        return {
+            data: this.instantiate(response.data),
+            action: response.action,
+        };
+    }
+    // ─────────────────────────────────────────────────────────────────
+    // Protected Helpers
+    // ─────────────────────────────────────────────────────────────────
+    transformToNested(data) {
+        const { name, description, externalId, metadata, operationType, inmuebles, payments, } = data;
+        const baseFields = { name };
+        if (description !== undefined)
+            baseFields.description = description;
+        if (externalId !== undefined)
+            baseFields.externalId = externalId;
+        if (metadata !== undefined)
+            baseFields.metadata = metadata;
+        const inmData = {};
+        if (operationType !== undefined)
+            inmData.operationType = operationType;
+        if (inmuebles !== undefined)
+            inmData.inmuebles = inmuebles;
+        if (payments !== undefined)
+            inmData.payments = payments;
+        return {
+            ...baseFields,
+            scopes: ["MX", "MX:AV", "MX:AV:INM"],
+            scopeData: {
+                MX: {
+                    actividadVulnerable: {
+                        [CodigoActividad.INM]: inmData,
+                    },
+                },
+            },
+        };
+    }
+    transformUpdateToNested(data) {
+        const input = data;
+        const { name, description, externalId, metadata, operationType, inmuebles, payments, } = input;
+        const result = {};
+        if (name !== undefined)
+            result.name = name;
+        if (description !== undefined)
+            result.description = description;
+        if (externalId !== undefined)
+            result.externalId = externalId;
+        if (metadata !== undefined)
+            result.metadata = metadata;
+        const inmData = {};
+        if (operationType !== undefined)
+            inmData.operationType = operationType;
+        if (inmuebles !== undefined)
+            inmData.inmuebles = inmuebles;
+        if (payments !== undefined)
+            inmData.payments = payments;
+        const resultRecord = result;
+        resultRecord.scopes = ["MX", "MX:AV", "MX:AV:INM"];
+        resultRecord.scopeData = {
+            MX: {
+                actividadVulnerable: {
+                    [CodigoActividad.INM]: inmData,
+                },
+            },
+        };
+        return result;
+    }
+    instantiate(data) {
+        return new MexINMProduct(data);
+    }
+    /** Materializes a raw payload into a {@link MexINMProduct} (return type narrowed via the `instantiate` override). */
+    materialize(data) {
+        return this.instantiate(data);
+    }
+}

package/dist/resources/mx/av/inm/tenant.d.ts

@@ -0,0 +1,29 @@
+/**
+ * INM Tenant Resource
+ *
+ * Extends MexTenantResource with INM-specific fields flattened to root.
+ */
+import type { TenantResponse } from "@artu-ai/shared";
+import type { MexUpdateTenantInput } from "../../tenant";
+import { AVTenantResource } from "../tenant";
+export interface INMUpdateTenantInput extends Omit<MexUpdateTenantInput, "actividadVulnerable"> {
+    /** Collegiate entity code */
+    collegiateEntityCode?: string;
+    /** Whether the entity is exempt */
+    exempt?: boolean;
+}
+/**
+ * INM-scoped tenant resource.
+ *
+ * @example
+ * ```typescript
+ * await inmSdk.tenant.update({
+ *   rfc: "ABC123456789",
+ *   collegiateEntityCode: "12345",
+ *   exempt: false,
+ * });
+ * ```
+ */
+export declare class INMTenantResource extends AVTenantResource {
+    update(data: INMUpdateTenantInput): Promise<TenantResponse>;
+}

package/dist/resources/mx/av/inm/tenant.js

@@ -0,0 +1,36 @@
+/**
+ * INM Tenant Resource
+ *
+ * Extends MexTenantResource with INM-specific fields flattened to root.
+ */
+import { AVTenantResource } from "../tenant";
+// ===========================
+// INMTenantResource
+// ===========================
+/**
+ * INM-scoped tenant resource.
+ *
+ * @example
+ * ```typescript
+ * await inmSdk.tenant.update({
+ *   rfc: "ABC123456789",
+ *   collegiateEntityCode: "12345",
+ *   exempt: false,
+ * });
+ * ```
+ */
+export class INMTenantResource extends AVTenantResource {
+    async update(data) {
+        const { collegiateEntityCode, exempt, ...rest } = data;
+        const scopeData = {};
+        if (collegiateEntityCode !== undefined)
+            scopeData.collegiateEntityCode = collegiateEntityCode;
+        if (exempt !== undefined)
+            scopeData.exempt = exempt;
+        const mexInput = { ...rest };
+        if (Object.keys(scopeData).length > 0) {
+            mexInput.actividadVulnerable = { INM: scopeData };
+        }
+        return super.update(mexInput);
+    }
+}