@artu-ai/compliance-sdk 0.13.4 → 0.17.0

package/dist/models/mx/av/veh/MexVEHAlert.js

@@ -0,0 +1,77 @@
+/**
+ * Mexico VEH Alert Model
+ *
+ * Alert model for Vehículos activity.
+ */
+import { MexAVAlert } from "../MexAVAlert";
+// ===========================
+// MexVEHAlert Model
+// ===========================
+/**
+ * Mexico VEH Alert Model.
+ *
+ * Provides typed accessors for VEH-specific alert data.
+ *
+ * @example
+ * ```typescript
+ * if (alert instanceof MexVEHAlert) {
+ *   console.log(`Period: ${alert.mesReportado}`);
+ * }
+ * ```
+ */
+export class MexVEHAlert extends MexAVAlert {
+    // ─────────────────────────────────────────────────────────────────
+    // VEH Data
+    // ─────────────────────────────────────────────────────────────────
+    /**
+     * VEH-specific alert data
+     */
+    get vehData() {
+        return this.actividadVulnerableData?.VEH;
+    }
+    /**
+     * Reporting period (YYYYMM format)
+     * Lives at the AV level: scopeData.MX.actividadVulnerable.mesReportado
+     */
+    get mesReportado() {
+        const avData = this.actividadVulnerableData;
+        return avData?.mesReportado ?? undefined;
+    }
+    /**
+     * Reporting period as a formatted string (e.g., "January 2024")
+     */
+    get formattedPeriod() {
+        const mes = this.mesReportado;
+        if (!mes)
+            return undefined;
+        const year = mes.slice(0, 4);
+        const month = parseInt(mes.slice(4, 6), 10);
+        const monthNames = [
+            "January",
+            "February",
+            "March",
+            "April",
+            "May",
+            "June",
+            "July",
+            "August",
+            "September",
+            "October",
+            "November",
+            "December",
+        ];
+        return `${monthNames[month - 1]} ${year}`;
+    }
+    // ─────────────────────────────────────────────────────────────────
+    // String Representation
+    // ─────────────────────────────────────────────────────────────────
+    toString() {
+        return `MexVEHAlert(${this.id}, ${this.mesReportado ?? "N/A"})`;
+    }
+}
+/**
+ * Check if alert is a VEH (Vehículos) alert
+ */
+export function isMexVEHAlert(alert) {
+    return alert instanceof MexVEHAlert;
+}

package/dist/models/mx/av/veh/MexVEHAlertClientItem.d.ts

@@ -0,0 +1,58 @@
+/**
+ * Mexico VEH Alert Client Item Model
+ *
+ * Alert client item model for Vehículos activity.
+ * Provides BOTH client-side and alert-item-side VEH-specific accessors.
+ */
+import type { veh } from "@artu-ai/shared";
+import { MexAVAlertClientItem, type MexAVAlertClientItemData } from "../MexAVAlertClientItem";
+/**
+ * VEH alert client item data
+ */
+export type MexVEHAlertClientItemData = MexAVAlertClientItemData & {
+    alertItemScopeData?: {
+        MX?: {
+            actividadVulnerable?: {
+                VEH?: veh.VEHAlertItemData;
+            };
+        };
+        [key: string]: unknown;
+    };
+};
+/**
+ * Mexico VEH Alert Client Item Model.
+ *
+ * Provides typed accessors for both:
+ * - Client-side VEH data
+ * - Alert-item-side VEH data (alertType, amendment, etc.)
+ */
+export declare class MexVEHAlertClientItem extends MexAVAlertClientItem {
+    /**
+     * VEH-specific alert item data
+     */
+    protected get vehData(): veh.VEHAlertItemData | undefined;
+    /**
+     * Alert type code
+     */
+    get alertType(): veh.VEHTipoAlerta | undefined;
+    /**
+     * Alert description (for unusual activity)
+     * Lives at the AV level: alertItemScopeData.MX.actividadVulnerable.alertDescription
+     */
+    get alertDescription(): string | undefined;
+    /**
+     * Amendment data for corrections
+     * Lives at the AV level: alertItemScopeData.MX.actividadVulnerable.amendment
+     */
+    get amendment(): veh.Amendment | undefined;
+    /**
+     * Whether this item is an amendment
+     */
+    get isAmendment(): boolean;
+    toString(): string;
+}
+import type { AlertClientItemModel } from "../../../types";
+/**
+ * Check if alert client item is a VEH (Vehículos) alert client item
+ */
+export declare function isMexVEHAlertClientItem(item: AlertClientItemModel): item is MexVEHAlertClientItem;

package/dist/models/mx/av/veh/MexVEHAlertClientItem.js

@@ -0,0 +1,66 @@
+/**
+ * Mexico VEH Alert Client Item Model
+ *
+ * Alert client item model for Vehículos activity.
+ * Provides BOTH client-side and alert-item-side VEH-specific accessors.
+ */
+import { MexAVAlertClientItem, } from "../MexAVAlertClientItem";
+// ===========================
+// MexVEHAlertClientItem Model
+// ===========================
+/**
+ * Mexico VEH Alert Client Item Model.
+ *
+ * Provides typed accessors for both:
+ * - Client-side VEH data
+ * - Alert-item-side VEH data (alertType, amendment, etc.)
+ */
+export class MexVEHAlertClientItem extends MexAVAlertClientItem {
+    // ─────────────────────────────────────────────────────────────────
+    // Alert Item-Side VEH Data
+    // ─────────────────────────────────────────────────────────────────
+    /**
+     * VEH-specific alert item data
+     */
+    get vehData() {
+        return this.alertItemActividadVulnerableData?.VEH;
+    }
+    /**
+     * Alert type code
+     */
+    get alertType() {
+        return this.vehData?.alertType;
+    }
+    /**
+     * Alert description (for unusual activity)
+     * Lives at the AV level: alertItemScopeData.MX.actividadVulnerable.alertDescription
+     */
+    get alertDescription() {
+        return this.alertItemActividadVulnerableData?.alertDescription;
+    }
+    /**
+     * Amendment data for corrections
+     * Lives at the AV level: alertItemScopeData.MX.actividadVulnerable.amendment
+     */
+    get amendment() {
+        return this.alertItemActividadVulnerableData?.amendment;
+    }
+    /**
+     * Whether this item is an amendment
+     */
+    get isAmendment() {
+        return !!this.alertItemActividadVulnerableData?.amendment;
+    }
+    // ─────────────────────────────────────────────────────────────────
+    // String Representation
+    // ─────────────────────────────────────────────────────────────────
+    toString() {
+        return `MexVEHAlertClientItem(${this.id}, ${this.name}, alertItem=${this.alertItemId ?? "indirect"}, alertType=${this.alertType ?? "N/A"})`;
+    }
+}
+/**
+ * Check if alert client item is a VEH (Vehículos) alert client item
+ */
+export function isMexVEHAlertClientItem(item) {
+    return item instanceof MexVEHAlertClientItem;
+}

package/dist/models/mx/av/veh/MexVEHAlertItem.d.ts

@@ -0,0 +1,55 @@
+/**
+ * Mexico VEH Alert Item Model
+ *
+ * Alert item model for Vehículos activity.
+ */
+import type { veh } from "@artu-ai/shared";
+import { MexAVAlertItem, type MexAVAlertItemData } from "../MexAVAlertItem";
+/**
+ * VEH alert item data
+ */
+export interface MexVEHAlertItemData extends MexAVAlertItemData {
+    scopeData?: {
+        MX?: {
+            actividadVulnerable?: {
+                VEH?: veh.VEHAlertItemData;
+            };
+        };
+        [key: string]: unknown;
+    };
+}
+/**
+ * Mexico VEH Alert Item Model.
+ *
+ * Provides typed accessors for VEH-specific alert item data.
+ */
+export declare class MexVEHAlertItem extends MexAVAlertItem {
+    /**
+     * VEH-specific alert item data
+     */
+    protected get vehData(): veh.VEHAlertItemData | undefined;
+    /**
+     * Alert type code
+     */
+    get alertType(): veh.VEHTipoAlerta | undefined;
+    /**
+     * Alert description (for unusual activity)
+     * Lives at the AV level: scopeData.MX.actividadVulnerable.alertDescription
+     */
+    get alertDescription(): string | undefined;
+    /**
+     * Amendment data for corrections
+     * Lives at the AV level: scopeData.MX.actividadVulnerable.amendment
+     */
+    get amendment(): veh.Amendment | undefined;
+    /**
+     * Whether this item is an amendment
+     */
+    get isAmendment(): boolean;
+    toString(): string;
+}
+import type { AlertItemModel } from "../../../types";
+/**
+ * Check if alert item is a VEH (Vehículos) alert item
+ */
+export declare function isMexVEHAlertItem(item: AlertItemModel): item is MexVEHAlertItem;

package/dist/models/mx/av/veh/MexVEHAlertItem.js

@@ -0,0 +1,65 @@
+/**
+ * Mexico VEH Alert Item Model
+ *
+ * Alert item model for Vehículos activity.
+ */
+import { MexAVAlertItem } from "../MexAVAlertItem";
+// ===========================
+// MexVEHAlertItem Model
+// ===========================
+/**
+ * Mexico VEH Alert Item Model.
+ *
+ * Provides typed accessors for VEH-specific alert item data.
+ */
+export class MexVEHAlertItem extends MexAVAlertItem {
+    // ─────────────────────────────────────────────────────────────────
+    // VEH Data
+    // ─────────────────────────────────────────────────────────────────
+    /**
+     * VEH-specific alert item data
+     */
+    get vehData() {
+        return this.actividadVulnerableData?.VEH;
+    }
+    /**
+     * Alert type code
+     */
+    get alertType() {
+        return this.vehData?.alertType;
+    }
+    /**
+     * Alert description (for unusual activity)
+     * Lives at the AV level: scopeData.MX.actividadVulnerable.alertDescription
+     */
+    get alertDescription() {
+        const avData = this.actividadVulnerableData;
+        return avData?.alertDescription ?? undefined;
+    }
+    /**
+     * Amendment data for corrections
+     * Lives at the AV level: scopeData.MX.actividadVulnerable.amendment
+     */
+    get amendment() {
+        const avData = this.actividadVulnerableData;
+        return avData?.amendment ?? undefined;
+    }
+    /**
+     * Whether this item is an amendment
+     */
+    get isAmendment() {
+        return !!this.amendment;
+    }
+    // ─────────────────────────────────────────────────────────────────
+    // String Representation
+    // ─────────────────────────────────────────────────────────────────
+    toString() {
+        return `MexVEHAlertItem(${this.id}, ${this.clientNames?.join(", ") ?? "Unknown"}, Alert: ${this.alertType ?? "N/A"})`;
+    }
+}
+/**
+ * Check if alert item is a VEH (Vehículos) alert item
+ */
+export function isMexVEHAlertItem(item) {
+    return item instanceof MexVEHAlertItem;
+}

package/dist/models/mx/av/veh/MexVEHAlertTransactionItem.d.ts

@@ -0,0 +1,90 @@
+/**
+ * Mexico VEH Alert Transaction Item Model
+ *
+ * Alert transaction item model for Vehículos activity.
+ * Provides BOTH transaction-side VEH getters and alert-item-side VEH getters.
+ */
+import type { veh } from "@artu-ai/shared";
+import { MexAVAlertTransactionItem, type MexAVAlertTransactionItemData } from "../MexAVAlertTransactionItem";
+/**
+ * VEH alert transaction item data
+ */
+export interface MexVEHAlertTransactionItemData extends MexAVAlertTransactionItemData {
+    alertItemScopeData?: {
+        MX?: {
+            actividadVulnerable?: {
+                VEH?: veh.VEHAlertItemData;
+            };
+        };
+        [key: string]: unknown;
+    };
+}
+/**
+ * Mexico VEH Alert Transaction Item Model.
+ *
+ * Provides typed accessors for both:
+ * - Transaction-side VEH data (operation, postal code, vehicles, payments)
+ * - Alert-item-side VEH data (alert type, description, amendment)
+ */
+export declare class MexVEHAlertTransactionItem extends MexAVAlertTransactionItem {
+    /**
+     * VEH-specific transaction data
+     */
+    protected get vehTxData(): veh.VEHTransactionData | undefined;
+    /**
+     * Operation type
+     */
+    get operationType(): string | undefined;
+    /**
+     * Postal code where the operation took place
+     */
+    get postalCode(): string | undefined;
+    /**
+     * Vehicles involved in this transaction.
+     */
+    get vehicles(): veh.Vehicle[];
+    /**
+     * Payments (datos_liquidacion) for this transaction.
+     */
+    get payments(): veh.VEHPaymentData[];
+    /**
+     * Whether this transaction has any payments
+     */
+    get hasPayments(): boolean;
+    /**
+     * Total number of payments in this transaction
+     */
+    get paymentsCount(): number;
+    /**
+     * Total payment amount across all payments
+     */
+    get totalPaymentAmount(): number;
+    /**
+     * VEH-specific alert item data
+     */
+    protected get alertItemVehData(): veh.VEHAlertItemData | undefined;
+    /**
+     * Alert type code
+     */
+    get alertType(): veh.VEHTipoAlerta | undefined;
+    /**
+     * Alert description (for unusual activity)
+     * Lives at the AV level: alertItemScopeData.MX.actividadVulnerable.alertDescription
+     */
+    get alertDescription(): string | undefined;
+    /**
+     * Amendment data for corrections
+     * Lives at the AV level: alertItemScopeData.MX.actividadVulnerable.amendment
+     */
+    get amendment(): veh.Amendment | undefined;
+    /**
+     * Whether this item is an amendment
+     */
+    get isAmendment(): boolean;
+    toString(): string;
+}
+import type { AlertTransactionItemModel } from "../../../types";
+/**
+ * Check if alert transaction item is a VEH (Vehículos) alert transaction item
+ */
+export declare function isMexVEHAlertTransactionItem(item: AlertTransactionItemModel): item is MexVEHAlertTransactionItem;

package/dist/models/mx/av/veh/MexVEHAlertTransactionItem.js

@@ -0,0 +1,117 @@
+/**
+ * Mexico VEH Alert Transaction Item Model
+ *
+ * Alert transaction item model for Vehículos activity.
+ * Provides BOTH transaction-side VEH getters and alert-item-side VEH getters.
+ */
+import { MexAVAlertTransactionItem, } from "../MexAVAlertTransactionItem";
+// ===========================
+// MexVEHAlertTransactionItem Model
+// ===========================
+/**
+ * Mexico VEH Alert Transaction Item Model.
+ *
+ * Provides typed accessors for both:
+ * - Transaction-side VEH data (operation, postal code, vehicles, payments)
+ * - Alert-item-side VEH data (alert type, description, amendment)
+ */
+export class MexVEHAlertTransactionItem extends MexAVAlertTransactionItem {
+    // ─────────────────────────────────────────────────────────────────
+    // Transaction-Side VEH Data
+    // ─────────────────────────────────────────────────────────────────
+    /**
+     * VEH-specific transaction data
+     */
+    get vehTxData() {
+        return this.actividadVulnerableData?.VEH;
+    }
+    /**
+     * Operation type
+     */
+    get operationType() {
+        return this.vehTxData?.operationType;
+    }
+    /**
+     * Postal code where the operation took place
+     */
+    get postalCode() {
+        return this.vehTxData?.postalCode;
+    }
+    /**
+     * Vehicles involved in this transaction.
+     */
+    get vehicles() {
+        return this.vehTxData?.vehicles ?? [];
+    }
+    /**
+     * Payments (datos_liquidacion) for this transaction.
+     */
+    get payments() {
+        return this.vehTxData?.payments ?? [];
+    }
+    /**
+     * Whether this transaction has any payments
+     */
+    get hasPayments() {
+        return this.payments.length > 0;
+    }
+    /**
+     * Total number of payments in this transaction
+     */
+    get paymentsCount() {
+        return this.payments.length;
+    }
+    /**
+     * Total payment amount across all payments
+     */
+    get totalPaymentAmount() {
+        return this.payments.reduce((sum, p) => sum + Number(p.amount), 0);
+    }
+    // ─────────────────────────────────────────────────────────────────
+    // Alert Item-Side VEH Data
+    // ─────────────────────────────────────────────────────────────────
+    /**
+     * VEH-specific alert item data
+     */
+    get alertItemVehData() {
+        return this.alertItemActividadVulnerableData?.VEH;
+    }
+    /**
+     * Alert type code
+     */
+    get alertType() {
+        return this.alertItemVehData?.alertType;
+    }
+    /**
+     * Alert description (for unusual activity)
+     * Lives at the AV level: alertItemScopeData.MX.actividadVulnerable.alertDescription
+     */
+    get alertDescription() {
+        return this.alertItemActividadVulnerableData?.alertDescription;
+    }
+    /**
+     * Amendment data for corrections
+     * Lives at the AV level: alertItemScopeData.MX.actividadVulnerable.amendment
+     */
+    get amendment() {
+        return this.alertItemActividadVulnerableData?.amendment;
+    }
+    /**
+     * Whether this item is an amendment
+     */
+    get isAmendment() {
+        return !!this.alertItemActividadVulnerableData?.amendment;
+    }
+    // ─────────────────────────────────────────────────────────────────
+    // String Representation
+    // ─────────────────────────────────────────────────────────────────
+    toString() {
+        return `MexVEHAlertTransactionItem(${this.id}, ${this.formattedAmount}, alertItem=${this.alertItemId}, alertType=${this.alertType ?? "N/A"})`;
+    }
+}
+/**
+ * Check if alert transaction item is a VEH (Vehículos) alert transaction item
+ */
+export function isMexVEHAlertTransactionItem(item) {
+    return item instanceof MexVEHAlertTransactionItem;
+}

package/dist/models/mx/av/veh/MexVEHClient.d.ts

@@ -0,0 +1,25 @@
+/**
+ * Mexico VEH (Vehículos) Client
+ *
+ * Specialized for vehicle sale/exchange activity.
+ */
+import type { ClientRelationshipType, veh } from "@artu-ai/shared";
+import { MexAVClient } from "../MexAVClient";
+/**
+ * Mexico VEH Client Model.
+ *
+ * VEH clients have no activity-specific fields beyond the base.
+ */
+export declare class MexVEHClient extends MexAVClient {
+    /** VEH-specific activity data */
+    protected get vehData(): veh.VEHClientData | undefined;
+    toString(): string;
+    /** Linked clients (if included) instantiated as MexVEHClient */
+    get linkedClients(): {
+        relationshipType: ClientRelationshipType;
+        client: MexVEHClient;
+    }[] | undefined;
+}
+import type { ClientModel } from "../../../types";
+/** Check if client is a VEH (Vehículos) client */
+export declare function isMexVEHClient(client: ClientModel): client is MexVEHClient;

package/dist/models/mx/av/veh/MexVEHClient.js

@@ -0,0 +1,31 @@
+/**
+ * Mexico VEH (Vehículos) Client
+ *
+ * Specialized for vehicle sale/exchange activity.
+ */
+import { MexAVClient } from "../MexAVClient";
+/**
+ * Mexico VEH Client Model.
+ *
+ * VEH clients have no activity-specific fields beyond the base.
+ */
+export class MexVEHClient extends MexAVClient {
+    /** VEH-specific activity data */
+    get vehData() {
+        return this.mexicoData?.actividadVulnerable?.VEH;
+    }
+    toString() {
+        return `MexVEHClient(${this.id}, ${this.name})`;
+    }
+    /** Linked clients (if included) instantiated as MexVEHClient */
+    get linkedClients() {
+        return (this._data.linkedClients ?? []).map((l) => ({
+            relationshipType: l.relationshipType,
+            client: new MexVEHClient(l.client),
+        }));
+    }
+}
+/** Check if client is a VEH (Vehículos) client */
+export function isMexVEHClient(client) {
+    return client instanceof MexVEHClient;
+}

package/dist/models/mx/av/veh/MexVEHProduct.d.ts

@@ -0,0 +1,24 @@
+/**
+ * Mexico VEH (Vehículos) Product
+ *
+ * Specialized for vehicle sale/exchange product templates.
+ */
+import type { VEHProductData } from "@artu-ai/shared";
+import { MexAVProduct } from "../MexAVProduct";
+/**
+ * Mexico VEH Product Model.
+ *
+ * VEH products carry their default operation type. There is no collateral
+ * default (VEH has no collateral); vehicle/payment details are captured at
+ * transaction creation time.
+ */
+export declare class MexVEHProduct extends MexAVProduct {
+    /** VEH-specific product data */
+    protected get vehData(): VEHProductData | undefined;
+    /** Operation type */
+    get operationType(): string | undefined;
+    toString(): string;
+}
+import type { Product } from "../../../Product";
+/** Check if product is a VEH (Vehículos) product */
+export declare function isMexVEHProduct(product: Product): product is MexVEHProduct;

package/dist/models/mx/av/veh/MexVEHProduct.js

@@ -0,0 +1,30 @@
+/**
+ * Mexico VEH (Vehículos) Product
+ *
+ * Specialized for vehicle sale/exchange product templates.
+ */
+import { MexAVProduct } from "../MexAVProduct";
+/**
+ * Mexico VEH Product Model.
+ *
+ * VEH products carry their default operation type. There is no collateral
+ * default (VEH has no collateral); vehicle/payment details are captured at
+ * transaction creation time.
+ */
+export class MexVEHProduct extends MexAVProduct {
+    /** VEH-specific product data */
+    get vehData() {
+        return this.actividadVulnerableData?.VEH;
+    }
+    /** Operation type */
+    get operationType() {
+        return this.vehData?.operationType;
+    }
+    toString() {
+        return `MexVEHProduct(${this.id}, ${this.name}, operationType: ${this.operationType ?? "N/A"})`;
+    }
+}
+/** Check if product is a VEH (Vehículos) product */
+export function isMexVEHProduct(product) {
+    return product instanceof MexVEHProduct;
+}

package/dist/models/mx/av/veh/MexVEHTransaction.d.ts

@@ -0,0 +1,40 @@
+/**
+ * Mexico VEH (Vehículos) Transaction
+ *
+ * Specialized for vehicle sale/exchange transactions.
+ */
+import type { veh } from "@artu-ai/shared";
+import { MexAVTransaction } from "../MexAVTransaction";
+/**
+ * Mexico VEH Transaction Model.
+ *
+ * VEH transactions carry a `vehicles[]` array (a 3-variant discriminated union:
+ * terrestre / maritimo / aereo) and an optional `payments[]` array
+ * (datos_liquidacion), required unless operationType === "805" (Intercambio).
+ */
+export declare class MexVEHTransaction extends MexAVTransaction {
+    /** VEH-specific transaction data */
+    protected get vehData(): veh.VEHTransactionData | undefined;
+    /** Operation type: "801" (Venta nuevo), "802" (Venta usado), "805" (Intercambio) */
+    get operationType(): string | undefined;
+    /** Postal code where the operation took place */
+    get postalCode(): string | undefined;
+    /** Vehicles involved in this transaction (>= 1 on a valid create). */
+    get vehicles(): veh.Vehicle[];
+    /** Whether this transaction has any vehicles. */
+    get hasVehicles(): boolean;
+    /** Total number of vehicles. */
+    get vehicleCount(): number;
+    /** Payments (datos_liquidacion) for this transaction. Empty for 805. */
+    get payments(): veh.VEHPaymentData[];
+    /** Whether this transaction has any payments. */
+    get hasPayments(): boolean;
+    /** Total number of payments. */
+    get paymentsCount(): number;
+    /** Total payment amount across all payments. */
+    get totalPaymentAmount(): number;
+    toString(): string;
+}
+import type { TransactionModel } from "../../../types";
+/** Check if transaction is a VEH (Vehículos) transaction */
+export declare function isMexVEHTransaction(txn: TransactionModel): txn is MexVEHTransaction;