@artu-ai/compliance-sdk 0.13.4 → 0.17.0

package/dist/resources/mx/av/ari/alerts.js

@@ -20,7 +20,7 @@ import { AVAlertsResource } from "../alerts";
  * ```typescript
  * const ariSdk = new ComplianceSDK({
  *   apiKey,
- *   jurisdiction: Jurisdiction.Mexico,
+ *   scope: "MX",
  *   actividadVulnerable: CodigoActividad.ARI,
  * });
  *
@@ -42,16 +42,26 @@ export class ARIAlertsResource extends AVAlertsResource {
         const response = await this.execute(() => this.trpc.alerts.create.mutate(nestedData));
         return this.instantiate(response);
     }
-    async retrieve(id) {
-        const response = await this.execute(() => this.trpc.alerts.retrieve.query({ id }));
+    async retrieve(id, opts) {
+        const response = await this.execute(() => this.trpc.alerts.retrieve.query({
+            id,
+            requireScope: this.buildRequireScope(opts?.crossScope),
+        }));
         return this.instantiate(response);
     }
-    async retrieveByMetadata(key, value) {
-        const response = await this.execute(() => this.trpc.alerts.retrieveByMetadata.query({ key, value }));
+    async retrieveByMetadata(key, value, opts) {
+        const response = await this.execute(() => this.trpc.alerts.retrieveByMetadata.query({
+            key,
+            value,
+            requireScope: this.buildRequireScope(opts?.crossScope),
+        }));
         return this.instantiate(response);
     }
-    async retrieveByExternalId(externalId) {
-        const response = await this.execute(() => this.trpc.alerts.retrieveByExternalId.query({ externalId }));
+    async retrieveByExternalId(externalId, opts) {
+        const response = await this.execute(() => this.trpc.alerts.retrieveByExternalId.query({
+            externalId,
+            requireScope: this.buildRequireScope(opts?.crossScope),
+        }));
         return this.instantiate(response);
     }
     async update(id, data) {
@@ -64,10 +74,11 @@ export class ARIAlertsResource extends AVAlertsResource {
     // List & Pagination
     // ─────────────────────────────────────────────────────────────────
     async list(options) {
-        const scopedFilter = this.applyScopeToFilter(options?.filter);
-        const scopedSort = this.applyScopeToSort(options?.sort);
+        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.alerts.list.query({
-            ...options,
+            ...rest,
             filter: scopedFilter,
             sort: scopedSort,
         }));
@@ -77,15 +88,17 @@ export class ARIAlertsResource extends AVAlertsResource {
         };
     }
     iterate(options) {
-        const scopedFilter = this.applyScopeToFilter(options?.filter);
+        // Note: filter/sort are passed through - createIterator calls list() which
+        // handles scope transformation and auto-scope injection.
         return this.createIterator({
-            filter: scopedFilter,
+            filter: options?.filter,
             sort: options?.sort,
             pageSize: options?.pageSize,
+            crossScope: options?.crossScope,
         });
     }
-    async count(filter) {
-        const scopedFilter = this.applyScopeToFilter(filter);
+    async count(filter, options) {
+        const scopedFilter = this.applyAutoScope(this.applyScopeToFilter(filter), options?.crossScope);
         const response = await this.execute(() => this.trpc.alerts.count.query({ filter: scopedFilter }));
         return response.count;
     }
@@ -235,7 +248,7 @@ export class ARIAlertsResource extends AVAlertsResource {
             avFilter.alertDescription = alertDescription;
         return {
             ...baseFields,
-            jurisdictions: {
+            scopeData: {
                 MX: {
                     actividadVulnerable: {
                         ...avFilter,
@@ -299,7 +312,7 @@ export class ARIAlertsResource extends AVAlertsResource {
         return {
             ...baseFields,
             scope: "MX:AV:ARI",
-            jurisdictions: {
+            scopeData: {
                 MX: {
                     actividadVulnerable: {
                         // mesReportado lives at AV level (not subcategory)
@@ -315,7 +328,7 @@ export class ARIAlertsResource extends AVAlertsResource {
         return {
             ...data,
             scope: "MX:AV:ARI",
-            jurisdictions: {
+            scopeData: {
                 MX: {
                     actividadVulnerable: {
                         [CodigoActividad.ARI]: {},
@@ -327,6 +340,10 @@ export class ARIAlertsResource extends AVAlertsResource {
     instantiate(data) {
         return new MexARIAlert(data);
     }
+    /** Materializes a raw payload into a {@link MexARIAlert} (return type narrowed via the `instantiate` override). */
+    materialize(data) {
+        return this.instantiate(data);
+    }
     instantiateItem(data) {
         return new MexARIAlertItem(data);
     }
@@ -350,7 +367,7 @@ export class ARIAlertsResource extends AVAlertsResource {
             avData.amendment = amendment;
         return {
             ...baseFields,
-            jurisdictions: {
+            scopeData: {
                 MX: {
                     actividadVulnerable: {
                         ...avData,
@@ -379,7 +396,7 @@ export class ARIAlertsResource extends AVAlertsResource {
         }
         return {
             ...baseFields,
-            jurisdictions: {
+            scopeData: {
                 MX: {
                     actividadVulnerable: {
                         ...avData,
@@ -409,7 +426,7 @@ export class ARIAlertsResource extends AVAlertsResource {
             alertId,
             reportType: ReportType.MexActividadVulnerableARI,
             defaults: {
-                jurisdictions: {
+                scopeData: {
                     MX: {
                         actividadVulnerable: {
                             rfc,

package/dist/resources/mx/av/ari/clients.d.ts

@@ -8,6 +8,7 @@
 import type { ARIClientFilter, ARIClientSort, AtomicBatchResult, ClientRelationshipType, ClientSort, CreateARIClientInput, CreateBankAccountInput, CreateClientInput, CreateContactMethodInput, CreateMexAddressInput, LinkedClient as LinkedClientInput, ListOptions, PaginatedResponse, PartialBatchResult, SyncCreateDocumentInput, SyncItem, SyncResult, SyncUpdateDocumentInput, UpdateARIClientInput, UpdateBankAccountInput, UpdateClientInput, UpdateContactMethodInput, UpdateMexAddressInput, UpsertARIClientInput, UpsertResult } from "@artu-ai/shared";
 import { type ClientData, ContactMethod, Document, LinkedClient, MexAddress, MexARIClient, MexBankAccount } from "../../../../models";
 import { type ClientIncludeMap } from "../../../clients";
+import type { RelatedPartyParent, RelatedPartySubresource } from "../../../related-parties/base";
 import { AVClientsResource } from "../clients";
 /**
  * ARI (Arrendamiento de Inmuebles) scoped clients resource.
@@ -17,7 +18,7 @@ import { AVClientsResource } from "../clients";
  * const ariSdk = new ComplianceSDK({
  *   apiKey,
  *   environment: "test",
- *   jurisdiction: Jurisdiction.Mexico,
+ *   scope: "MX",
  *   actividadVulnerable: CodigoActividad.ARI,
  * });
  *
@@ -31,19 +32,33 @@ import { AVClientsResource } from "../clients";
  * ```
  */
 export declare class ARIClientsResource extends AVClientsResource {
+    readonly legalRepresentatives: RelatedPartySubresource<MexARIClient, CreateARIClientInput>;
+    readonly controllingBeneficiaries: RelatedPartySubresource<MexARIClient, CreateARIClientInput>;
+    protected relatedPartyParent(): RelatedPartyParent<MexARIClient, CreateARIClientInput>;
     create(data: CreateARIClientInput): Promise<MexARIClient>;
-    retrieve(id: string, include?: ClientIncludeMap): Promise<MexARIClient>;
-    retrieveByExternalId(externalId: string): Promise<MexARIClient>;
+    retrieve(id: string, options?: {
+        include?: ClientIncludeMap;
+        crossScope?: boolean;
+    }): Promise<MexARIClient>;
+    retrieveByExternalId(externalId: string, opts?: {
+        crossScope?: boolean;
+    }): Promise<MexARIClient>;
     update(id: string, data: UpdateARIClientInput): Promise<MexARIClient>;
     list(options?: ListOptions<ARIClientFilter, ARIClientSort> & {
         includePrimaryContacts?: boolean;
+        includeNonPrimary?: boolean;
+        crossScope?: boolean;
     }): Promise<PaginatedResponse<MexARIClient>>;
     iterate(options?: {
         filter?: ARIClientFilter;
         sort?: ARIClientSort;
         pageSize?: number;
+        crossScope?: boolean;
     }): AsyncGenerator<MexARIClient, void, undefined>;
-    count(filter?: ARIClientFilter): Promise<number>;
+    count(filter?: ARIClientFilter, options?: {
+        includeNonPrimary?: boolean;
+        crossScope?: boolean;
+    }): Promise<number>;
     createMany(clients: CreateARIClientInput[], options?: {
         atomic?: true;
     }): Promise<AtomicBatchResult<MexARIClient>>;
@@ -124,6 +139,7 @@ export declare class ARIClientsResource extends AVClientsResource {
     protected transformToNested(data: CreateARIClientInput): CreateClientInput;
     protected transformUpdateToNested(data: UpdateARIClientInput): UpdateClientInput;
     protected instantiate(data: ClientData): MexARIClient;
+    /** Materializes a raw payload into a {@link MexARIClient} (return type narrowed via the `instantiate` override). */
+    materialize(data: ClientData): MexARIClient;
     protected applyScopeToSort(sort?: ARIClientSort): ClientSort | undefined;
 }
-//# sourceMappingURL=clients.d.ts.map

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

@@ -20,7 +20,7 @@ import { AVClientsResource } from "../clients";
  * const ariSdk = new ComplianceSDK({
  *   apiKey,
  *   environment: "test",
- *   jurisdiction: Jurisdiction.Mexico,
+ *   scope: "MX",
  *   actividadVulnerable: CodigoActividad.ARI,
  * });
  *
@@ -34,6 +34,9 @@ import { AVClientsResource } from "../clients";
  * ```
  */
 export class ARIClientsResource extends AVClientsResource {
+    relatedPartyParent() {
+        return this.makeRelatedPartyParent((input) => this.transformToNested(this.validate(createARIClientInputSchema, input)));
+    }
     // ─────────────────────────────────────────────────────────────────
     // CRUD Operations
     // ─────────────────────────────────────────────────────────────────
@@ -43,12 +46,19 @@ export class ARIClientsResource extends AVClientsResource {
         const response = await this.execute(() => this.trpc.clients.create.mutate(nestedData));
         return this.instantiate(response);
     }
-    async retrieve(id, include) {
-        const response = await this.execute(() => this.trpc.clients.retrieve.query({ id, include }));
+    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) {
-        const response = await this.execute(() => this.trpc.clients.retrieveByExternalId.query({ externalId }));
+    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) {
@@ -61,10 +71,11 @@ export class ARIClientsResource extends AVClientsResource {
     // List & Pagination
     // ─────────────────────────────────────────────────────────────────
     async list(options) {
-        const scopedFilter = this.applyScopeToFilter(options?.filter);
-        const scopedSort = this.applyScopeToSort(options?.sort);
+        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({
-            ...options,
+            ...rest,
             filter: scopedFilter,
             sort: scopedSort,
         }));
@@ -74,16 +85,22 @@ export class ARIClientsResource extends AVClientsResource {
         };
     }
     iterate(options) {
-        const scopedFilter = this.applyScopeToFilter(options?.filter);
+        // 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: scopedFilter,
+            filter: options?.filter,
             sort: options?.sort,
             pageSize: options?.pageSize,
+            crossScope: options?.crossScope,
         });
     }
-    async count(filter) {
-        const scopedFilter = this.applyScopeToFilter(filter);
-        const response = await this.execute(() => this.trpc.clients.count.query({ filter: scopedFilter }));
+    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 = {}) {
@@ -232,11 +249,11 @@ export class ARIClientsResource extends AVClientsResource {
     // ─────────────────────────────────────────────────────────────────
     transformToNested(data) {
         const nested = super.transformToNested(data);
-        const mexData = nested.jurisdictions?.MX;
+        const mexData = nested.scopeData?.MX;
         return {
             ...nested,
             scopes: ["MX", "MX:AV", "MX:AV:ARI"],
-            jurisdictions: {
+            scopeData: {
                 MX: {
                     ...mexData,
                     actividadVulnerable: {
@@ -248,7 +265,7 @@ export class ARIClientsResource extends AVClientsResource {
     }
     transformUpdateToNested(data) {
         const nested = super.transformUpdateToNested(data);
-        const mexData = (nested.jurisdictions?.MX ??
+        const mexData = (nested.scopeData?.MX ??
             {});
         mexData.actividadVulnerable = {
             ...mexData.actividadVulnerable,
@@ -257,12 +274,16 @@ export class ARIClientsResource extends AVClientsResource {
         return {
             ...nested,
             scopes: ["MX", "MX:AV", "MX:AV:ARI"],
-            jurisdictions: { MX: mexData },
+            scopeData: { MX: mexData },
         };
     }
     instantiate(data) {
         return new MexARIClient(data);
     }
+    /** Materializes a raw payload into a {@link MexARIClient} (return type narrowed via the `instantiate` override). */
+    materialize(data) {
+        return this.instantiate(data);
+    }
     applyScopeToSort(sort) {
         if (!sort || sort.length === 0) {
             return undefined;

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

@@ -5,4 +5,3 @@ export { ARIAlertsResource } from "./alerts";
 export { ARIClientsResource } from "./clients";
 export { ARIProductsResource } from "./products";
 export { ARITransactionsResource } from "./transactions";
-//# sourceMappingURL=index.d.ts.map

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

@@ -36,19 +36,29 @@ import { AVProductsResource } from "../products";
  */
 export declare class ARIProductsResource extends AVProductsResource {
     create(data: CreateARIProductInput): Promise<MexARIProduct>;
-    retrieve(id: string): Promise<MexARIProduct>;
-    retrieveByExternalId(externalId: string): Promise<MexARIProduct>;
+    retrieve(id: string, opts?: {
+        crossScope?: boolean;
+    }): Promise<MexARIProduct>;
+    retrieveByExternalId(externalId: string, opts?: {
+        crossScope?: boolean;
+    }): Promise<MexARIProduct>;
     update(id: string, data: UpdateARIProductInput): Promise<MexARIProduct>;
-    list(options?: ListOptions<ProductFilter, ProductSort>): Promise<PaginatedResponse<MexARIProduct>>;
-    count(filter?: ProductFilter): Promise<number>;
+    list(options?: ListOptions<ProductFilter, ProductSort> & {
+        crossScope?: boolean;
+    }): Promise<PaginatedResponse<MexARIProduct>>;
+    count(filter?: ProductFilter, options?: {
+        crossScope?: boolean;
+    }): Promise<number>;
     iterate(options?: {
         filter?: ProductFilter;
         sort?: ProductSort;
         pageSize?: number;
+        crossScope?: boolean;
     }): AsyncGenerator<MexARIProduct, void, undefined>;
     upsertByExternalId(data: UpsertARIProductInput): Promise<UpsertResult<MexARIProduct>>;
     protected transformToNested(data: CreateARIProductInput): CreateProductInput;
     protected transformUpdateToNested(data: UpdateARIProductInput): UpdateProductInput;
     protected instantiate(data: ProductData): MexARIProduct;
+    /** Materializes a raw payload into a {@link MexARIProduct} (return type narrowed via the `instantiate` override). */
+    materialize(data: ProductData): MexARIProduct;
 }
-//# sourceMappingURL=products.d.ts.map

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

@@ -47,12 +47,18 @@ export class ARIProductsResource extends AVProductsResource {
         const response = await this.execute(() => this.trpc.products.create.mutate(nestedData));
         return this.instantiate(response);
     }
-    async retrieve(id) {
-        const response = await this.execute(() => this.trpc.products.retrieve.query({ id }));
+    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) {
-        const response = await this.execute(() => this.trpc.products.retrieveByExternalId.query({ externalId }));
+    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) {
@@ -65,14 +71,17 @@ export class ARIProductsResource extends AVProductsResource {
     // List & Pagination
     // ─────────────────────────────────────────────────────────────────
     async list(options) {
-        const response = await this.execute(() => this.trpc.products.list.query(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) {
-        const response = await this.execute(() => this.trpc.products.count.query({ filter }));
+    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) {
@@ -80,6 +89,7 @@ export class ARIProductsResource extends AVProductsResource {
             filter: options?.filter,
             sort: options?.sort,
             pageSize: options?.pageSize,
+            crossScope: options?.crossScope,
         });
     }
     // ─────────────────────────────────────────────────────────────────
@@ -118,7 +128,7 @@ export class ARIProductsResource extends AVProductsResource {
         return {
             ...baseFields,
             scopes: ["MX", "MX:AV", "MX:AV:ARI"],
-            jurisdictions: {
+            scopeData: {
                 MX: {
                     actividadVulnerable: {
                         [CodigoActividad.ARI]: ariData,
@@ -150,7 +160,7 @@ export class ARIProductsResource extends AVProductsResource {
             ariData.monetaryInstrument = monetaryInstrument;
         const resultRecord = result;
         resultRecord.scopes = ["MX", "MX:AV", "MX:AV:ARI"];
-        resultRecord.jurisdictions = {
+        resultRecord.scopeData = {
             MX: {
                 actividadVulnerable: {
                     [CodigoActividad.ARI]: ariData,
@@ -162,4 +172,8 @@ export class ARIProductsResource extends AVProductsResource {
     instantiate(data) {
         return new MexARIProduct(data);
     }
+    /** Materializes a raw payload into a {@link MexARIProduct} (return type narrowed via the `instantiate` override). */
+    materialize(data) {
+        return this.instantiate(data);
+    }
 }

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

@@ -27,4 +27,3 @@ export interface ARIUpdateTenantInput extends Omit<MexUpdateTenantInput, "activi
 export declare class ARITenantResource extends AVTenantResource {
     update(data: ARIUpdateTenantInput): Promise<TenantResponse>;
 }
-//# sourceMappingURL=tenant.d.ts.map

package/dist/resources/mx/av/ari/transactions.d.ts

@@ -16,7 +16,7 @@ import { AVTransactionsResource } from "../transactions";
  * ```typescript
  * const ariSdk = new ComplianceSDK({
  *   apiKey,
- *   jurisdiction: Jurisdiction.Mexico,
+ *   scope: "MX",
  *   actividadVulnerable: CodigoActividad.ARI,
  * });
  *
@@ -46,16 +46,25 @@ import { AVTransactionsResource } from "../transactions";
 export declare class ARITransactionsResource extends AVTransactionsResource {
     protected static readonly SCOPE_PATH: string[];
     create(data: CreateARITransactionInput): Promise<MexARITransaction>;
-    retrieve(id: string): Promise<MexARITransaction>;
-    retrieveByMetadata(key: string, value: string): Promise<MexARITransaction>;
+    retrieve(id: string, opts?: {
+        crossScope?: boolean;
+    }): Promise<MexARITransaction>;
+    retrieveByMetadata(key: string, value: string, opts?: {
+        crossScope?: boolean;
+    }): Promise<MexARITransaction>;
     update(id: string, data: UpdateARITransactionInput): Promise<MexARITransaction>;
-    list(options?: ListOptions<ARITransactionFilter, ARITransactionSort>): Promise<PaginatedResponse<MexARITransaction>>;
+    list(options?: ListOptions<ARITransactionFilter, ARITransactionSort> & {
+        crossScope?: boolean;
+    }): Promise<PaginatedResponse<MexARITransaction>>;
     iterate(options?: {
         filter?: ARITransactionFilter;
         sort?: ARITransactionSort;
         pageSize?: number;
+        crossScope?: boolean;
     }): AsyncGenerator<MexARITransaction, void, undefined>;
-    count(filter?: ARITransactionFilter): Promise<number>;
+    count(filter?: ARITransactionFilter, options?: {
+        crossScope?: boolean;
+    }): Promise<number>;
     listByClient(clientId: string, options?: {
         cursor?: string;
         limit?: number;
@@ -91,6 +100,7 @@ export declare class ARITransactionsResource extends AVTransactionsResource {
     protected transformToNested(data: CreateARITransactionInput): CreateTransactionInput;
     protected transformUpdateToNested(data: UpdateARITransactionInput): UpdateTransactionInput;
     protected instantiate(data: TransactionData): MexARITransaction;
+    /** Materializes a raw payload into a {@link MexARITransaction} (return type narrowed via the `instantiate` override). */
+    materialize(data: TransactionData): MexARITransaction;
     protected applyScopeToSort(sort?: ARITransactionSort): TransactionSort | undefined;
 }
-//# sourceMappingURL=transactions.d.ts.map