@artu-ai/compliance-sdk 0.0.6 → 0.2.0

package/src/models/mex/actividad-vulnerable/avi/MexAVIReport.ts

@@ -0,0 +1,114 @@
+/**
+ * Mexico AVI Report Model
+ *
+ * Report model for Activos Virtuales (Virtual Assets) activity.
+ */
+
+import {
+  MexActividadVulnerableReport,
+  type MexActividadVulnerableReportData,
+} from "../MexActividadVulnerableReport";
+import type { avi } from "@artu-ai/shared";
+
+// ===========================
+// Types
+// ===========================
+
+/**
+ * AVI report data
+ */
+export interface MexAVIReportData extends MexActividadVulnerableReportData {
+  jurisdictions?: {
+    MX?: {
+      actividadVulnerable?: {
+        AVI?: avi.AVIReportData;
+      };
+    };
+    [key: string]: unknown;
+  };
+}
+
+// ===========================
+// MexAVIReport Model
+// ===========================
+
+/**
+ * Mexico AVI Report Model.
+ *
+ * Provides typed accessors for AVI-specific report data.
+ *
+ * @example
+ * ```typescript
+ * if (report instanceof MexAVIReport) {
+ *   console.log(`Period: ${report.mesReportado}`);
+ * }
+ * ```
+ */
+export class MexAVIReport extends MexActividadVulnerableReport {
+  // ─────────────────────────────────────────────────────────────────
+  // AVI Data
+  // ─────────────────────────────────────────────────────────────────
+
+  /**
+   * AVI-specific report data
+   */
+  protected get aviData(): avi.AVIReportData | undefined {
+    return this.actividadVulnerableData?.AVI;
+  }
+
+  /**
+   * Reporting period (YYYYMM format)
+   */
+  get mesReportado(): string | undefined {
+    return this.aviData?.mesReportado;
+  }
+
+  /**
+   * Reporting period as a formatted string (e.g., "January 2024")
+   */
+  get formattedPeriod(): string | undefined {
+    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
+  // ─────────────────────────────────────────────────────────────────
+
+  override toString(): string {
+    return `MexAVIReport(${this.id}, ${this.mesReportado ?? "N/A"})`;
+  }
+}
+
+// ===========================
+// Type Guards
+// ===========================
+
+import type { ReportModel } from "../../../types";
+
+/**
+ * Check if report is an AVI (Activos Virtuales) report
+ */
+export function isMexAVIReport(report: ReportModel): report is MexAVIReport {
+  return report instanceof MexAVIReport;
+}

package/src/models/mex/actividad-vulnerable/avi/MexAVIReportItem.ts

@@ -0,0 +1,105 @@
+/**
+ * Mexico AVI Report Item Model
+ *
+ * Report item model for Activos Virtuales (Virtual Assets) activity.
+ */
+
+import {
+  MexActividadVulnerableReportItem,
+  type MexActividadVulnerableReportItemData,
+} from "../MexActividadVulnerableReportItem";
+import type { avi } from "@artu-ai/shared";
+
+// ===========================
+// Types
+// ===========================
+
+/**
+ * AVI report item data
+ */
+export interface MexAVIReportItemData
+  extends MexActividadVulnerableReportItemData {
+  jurisdictions?: {
+    MX?: {
+      actividadVulnerable?: {
+        AVI?: avi.AVIReportItemData;
+      };
+    };
+    [key: string]: unknown;
+  };
+}
+
+// ===========================
+// MexAVIReportItem Model
+// ===========================
+
+/**
+ * Mexico AVI Report Item Model.
+ *
+ * Provides typed accessors for AVI-specific report item data.
+ */
+export class MexAVIReportItem extends MexActividadVulnerableReportItem {
+  // ─────────────────────────────────────────────────────────────────
+  // AVI Data
+  // ─────────────────────────────────────────────────────────────────
+
+  /**
+   * AVI-specific report item data
+   */
+  protected get aviData(): avi.AVIReportItemData | undefined {
+    return this.actividadVulnerableData?.AVI;
+  }
+
+  /**
+   * Alert type code
+   * - "100" for monthly reports
+   * - Other codes for unusual activity
+   */
+  get alertType(): avi.TipoAlerta | undefined {
+    return this.aviData?.alertType;
+  }
+
+  /**
+   * Alert description (for unusual activity)
+   */
+  get alertDescription(): string | undefined {
+    return this.aviData?.alertDescription;
+  }
+
+  /**
+   * Amendment data for corrections
+   */
+  get amendment(): avi.Amendment | undefined {
+    return this.aviData?.amendment;
+  }
+
+  /**
+   * Whether this item is an amendment
+   */
+  get isAmendment(): boolean {
+    return !!this.aviData?.amendment;
+  }
+
+  // ─────────────────────────────────────────────────────────────────
+  // String Representation
+  // ─────────────────────────────────────────────────────────────────
+
+  override toString(): string {
+    return `MexAVIReportItem(${this.id}, ${this.clientName ?? "Unknown"}, Alert: ${this.alertType ?? "N/A"})`;
+  }
+}
+
+// ===========================
+// Type Guards
+// ===========================
+
+import type { ReportItemModel } from "../../../types";
+
+/**
+ * Check if report item is an AVI (Activos Virtuales) report item
+ */
+export function isMexAVIReportItem(
+  item: ReportItemModel
+): item is MexAVIReportItem {
+  return item instanceof MexAVIReportItem;
+}

package/src/models/mex/actividad-vulnerable/avi/MexAVITransaction.ts

@@ -0,0 +1,157 @@
+/**
+ * Mexico AVI (Activos Virtuales) Transaction
+ *
+ * Specialized for virtual asset / cryptocurrency transactions.
+ */
+
+import { avi } from "@artu-ai/shared";
+import { MexActividadVulnerableTransaction } from "../MexActividadVulnerableTransaction";
+
+// ===========================
+// MexAVITransaction Model
+// ===========================
+
+/**
+ * Mexico AVI Transaction Model.
+ *
+ * Provides typed accessors for virtual asset transaction data.
+ *
+ * @example
+ * ```typescript
+ * if (txn instanceof MexAVITransaction) {
+ *   console.log(`Operation: ${txn.operationType}`);
+ *   console.log(`Crypto: ${txn.crypto}`);
+ * }
+ * ```
+ */
+export class MexAVITransaction extends MexActividadVulnerableTransaction {
+  // ─────────────────────────────────────────────────────────────────
+  // AVI-Specific Data
+  // ─────────────────────────────────────────────────────────────────
+
+  /**
+   * AVI-specific transaction data
+   */
+  protected get aviData(): avi.AVITransactionData | undefined {
+    return this.mexicoData?.actividadVulnerable?.AVI;
+  }
+
+  /**
+   * Operation type (buy, sell, exchange, transfer, deposit, withdrawal)
+   */
+  get operationType(): string | undefined {
+    return this.aviData?.operationType;
+  }
+
+  /**
+   * Cryptocurrency/virtual asset code (for buy, sell, transfer operations)
+   */
+  get crypto(): string | undefined {
+    const data = this.aviData;
+    if (!data) return undefined;
+    if ("crypto" in data) {
+      return data.crypto;
+    }
+    return undefined;
+  }
+
+  /**
+   * Amount of virtual asset (for buy, sell, transfer operations)
+   */
+  get cryptoAmount(): number | undefined {
+    const data = this.aviData;
+    if (!data) return undefined;
+    if ("cryptoAmount" in data) {
+      return data.cryptoAmount;
+    }
+    return undefined;
+  }
+
+  /**
+   * Exchange rate to MXN (for buy, sell, transfer operations)
+   */
+  get cryptoExchangeRate(): string | undefined {
+    const data = this.aviData;
+    if (!data) return undefined;
+    if ("cryptoExchangeRate" in data) {
+      return data.cryptoExchangeRate;
+    }
+    return undefined;
+  }
+
+  /**
+   * Description of the virtual asset (for buy, sell, transfer operations)
+   */
+  get cryptoDescription(): string | undefined {
+    const data = this.aviData;
+    if (!data) return undefined;
+    if ("cryptoDescription" in data) {
+      return data.cryptoDescription;
+    }
+    return undefined;
+  }
+
+  /**
+   * Transaction hash (for blockchain operations)
+   */
+  get hash(): string | undefined {
+    const data = this.aviData;
+    if (!data) return undefined;
+    if ("hash" in data) {
+      return data.hash;
+    }
+    return undefined;
+  }
+
+  /**
+   * Monetary instrument (for deposit/withdrawal operations)
+   */
+  get monetaryInstrument(): string | undefined {
+    const data = this.aviData;
+    if (!data) return undefined;
+    if ("monetaryInstrument" in data) {
+      return data.monetaryInstrument;
+    }
+    return undefined;
+  }
+
+  /**
+   * Exchange data (for exchange operations)
+   */
+  get exchangeData():
+    | Omit<AVIExchangeTransaction, "operationType" | "hash">
+    | undefined {
+    const data = this.aviData;
+    if (!data || data.operationType !== avi.TipoOperacion.Exchange)
+      return undefined;
+    if ("sent" in data && "received" in data) {
+      return { sent: data.sent, received: data.received };
+    }
+    return undefined;
+  }
+
+  // ─────────────────────────────────────────────────────────────────
+  // String Representation
+  // ─────────────────────────────────────────────────────────────────
+
+  override toString(): string {
+    return `MexAVITransaction(${this.id}, ${this.formattedAmount}, ${this.operationType ?? "unknown"})`;
+  }
+}
+
+// ===========================
+// Type Guards
+// ===========================
+
+import type { TransactionModel } from "../../../types";
+
+type AVIExchangeTransaction = avi.AVIExchangeTransaction;
+
+/**
+ * Check if transaction is an AVI (Activos Virtuales) transaction
+ */
+export function isMexAVITransaction(
+  txn: TransactionModel
+): txn is MexAVITransaction {
+  return txn instanceof MexAVITransaction;
+}

package/src/models/mex/actividad-vulnerable/index.ts

@@ -0,0 +1,78 @@
+/**
+ * Mexico Actividad Vulnerable Models
+ */
+
+// Base activity client
+export {
+  MexActividadVulnerableClient,
+  isActividadVulnerable,
+} from "./MexActividadVulnerableClient";
+
+// Base activity transaction
+export {
+  MexActividadVulnerableTransaction,
+  isActividadVulnerableTransaction,
+} from "./MexActividadVulnerableTransaction";
+
+// Base activity report
+export {
+  MexActividadVulnerableReport,
+  type MexActividadVulnerableReportData,
+  isActividadVulnerableReport,
+} from "./MexActividadVulnerableReport";
+export {
+  MexActividadVulnerableReportItem,
+  type MexActividadVulnerableReportItemData,
+  isActividadVulnerableReportItem,
+} from "./MexActividadVulnerableReportItem";
+
+// Activity-specific clients
+export { MexAVIClient, isMexAVIClient } from "./avi/MexAVIClient";
+export { MexJYSClient, isMexJYSClient } from "./jys/MexJYSClient";
+export { MexTSCClient, isMexTSCClient } from "./tsc/MexTSCClient";
+
+// Activity-specific transactions
+export {
+  MexAVITransaction,
+  isMexAVITransaction,
+} from "./avi/MexAVITransaction";
+export {
+  MexJYSTransaction,
+  isMexJYSTransaction,
+} from "./jys/MexJYSTransaction";
+export {
+  MexTSCTransaction,
+  isMexTSCTransaction,
+} from "./tsc/MexTSCTransaction";
+
+// Activity-specific reports
+export {
+  MexAVIReport,
+  type MexAVIReportData,
+  isMexAVIReport,
+} from "./avi/MexAVIReport";
+export {
+  MexAVIReportItem,
+  type MexAVIReportItemData,
+  isMexAVIReportItem,
+} from "./avi/MexAVIReportItem";
+export {
+  MexJYSReport,
+  type MexJYSReportData,
+  isMexJYSReport,
+} from "./jys/MexJYSReport";
+export {
+  MexJYSReportItem,
+  type MexJYSReportItemData,
+  isMexJYSReportItem,
+} from "./jys/MexJYSReportItem";
+export {
+  MexTSCReport,
+  type MexTSCReportData,
+  isMexTSCReport,
+} from "./tsc/MexTSCReport";
+export {
+  MexTSCReportItem,
+  type MexTSCReportItemData,
+  isMexTSCReportItem,
+} from "./tsc/MexTSCReportItem";

package/src/models/mex/actividad-vulnerable/jys/MexJYSClient.ts

@@ -0,0 +1,73 @@
+/**
+ * Mexico JYS (Juegos y Sorteos) Client
+ *
+ * Specialized for gaming and lottery operations.
+ */
+
+import type { ClientRelationshipType, jys } from "@artu-ai/shared";
+import { MexActividadVulnerableClient } from "../MexActividadVulnerableClient";
+
+// ===========================
+// MexJYSClient Model
+// ===========================
+
+/**
+ * Mexico JYS Client Model.
+ *
+ * Provides typed accessors for gaming/lottery specific data.
+ *
+ * @example
+ * ```typescript
+ * if (client instanceof MexJYSClient) {
+ *   console.log(`JYS Client: ${client.name}`);
+ * }
+ * ```
+ */
+export class MexJYSClient extends MexActividadVulnerableClient {
+  // ─────────────────────────────────────────────────────────────────
+  // JYS-Specific Data
+  // ─────────────────────────────────────────────────────────────────
+
+  /**
+   * JYS-specific activity data
+   */
+  protected get jysData(): jys.JYSClientData | undefined {
+    return this.mexicoData?.actividadVulnerable?.JYS;
+  }
+
+  // ─────────────────────────────────────────────────────────────────
+  // String Representation
+  // ─────────────────────────────────────────────────────────────────
+
+  override toString(): string {
+    return `MexJYSClient(${this.id}, ${this.name})`;
+  }
+
+  /**
+   * Linked clients (if included) instantiated as MexJYSClient
+   */
+  override get linkedClients():
+    | {
+        relationshipType: ClientRelationshipType;
+        client: MexJYSClient;
+      }[]
+    | undefined {
+    return (this._data.linkedClients ?? []).map((l) => ({
+      relationshipType: l.relationshipType,
+      client: new MexJYSClient(l.client),
+    }));
+  }
+}
+
+// ===========================
+// Type Guards
+// ===========================
+
+import type { ClientModel } from "../../../types";
+
+/**
+ * Check if client is a JYS (Juegos y Sorteos) client
+ */
+export function isMexJYSClient(client: ClientModel): client is MexJYSClient {
+  return client instanceof MexJYSClient;
+}

package/src/models/mex/actividad-vulnerable/jys/MexJYSReport.ts

@@ -0,0 +1,114 @@
+/**
+ * Mexico JYS Report Model
+ *
+ * Report model for Juegos y Sorteos (Games and Raffles) activity.
+ */
+
+import {
+  MexActividadVulnerableReport,
+  type MexActividadVulnerableReportData,
+} from "../MexActividadVulnerableReport";
+import type { jys } from "@artu-ai/shared";
+
+// ===========================
+// Types
+// ===========================
+
+/**
+ * JYS report data
+ */
+export interface MexJYSReportData extends MexActividadVulnerableReportData {
+  jurisdictions?: {
+    MX?: {
+      actividadVulnerable?: {
+        JYS?: jys.JYSReportData;
+      };
+    };
+    [key: string]: unknown;
+  };
+}
+
+// ===========================
+// MexJYSReport Model
+// ===========================
+
+/**
+ * Mexico JYS Report Model.
+ *
+ * Provides typed accessors for JYS-specific report data.
+ *
+ * @example
+ * ```typescript
+ * if (report instanceof MexJYSReport) {
+ *   console.log(`Period: ${report.mesReportado}`);
+ * }
+ * ```
+ */
+export class MexJYSReport extends MexActividadVulnerableReport {
+  // ─────────────────────────────────────────────────────────────────
+  // JYS Data
+  // ─────────────────────────────────────────────────────────────────
+
+  /**
+   * JYS-specific report data
+   */
+  protected get jysData(): jys.JYSReportData | undefined {
+    return this.actividadVulnerableData?.JYS;
+  }
+
+  /**
+   * Reporting period (YYYYMM format)
+   */
+  get mesReportado(): string | undefined {
+    return this.jysData?.mesReportado;
+  }
+
+  /**
+   * Reporting period as a formatted string (e.g., "January 2024")
+   */
+  get formattedPeriod(): string | undefined {
+    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
+  // ─────────────────────────────────────────────────────────────────
+
+  override toString(): string {
+    return `MexJYSReport(${this.id}, ${this.mesReportado ?? "N/A"})`;
+  }
+}
+
+// ===========================
+// Type Guards
+// ===========================
+
+import type { ReportModel } from "../../../types";
+
+/**
+ * Check if report is a JYS (Juegos y Sorteos) report
+ */
+export function isMexJYSReport(report: ReportModel): report is MexJYSReport {
+  return report instanceof MexJYSReport;
+}