@artu-ai/compliance-sdk 0.0.5 → 0.2.0

package/src/models/mex/MexReport.ts

@@ -0,0 +1,99 @@
+/**
+ * Mexico Report Model
+ *
+ * Extends base Report with Mexico-specific accessors.
+ */
+
+import { Report, type ReportData } from "../Report";
+import type { MexReportJurisdictionData } from "@artu-ai/shared";
+
+// ===========================
+// Types
+// ===========================
+
+/**
+ * Report data with Mexico jurisdiction
+ */
+export interface MexReportData extends ReportData {
+  jurisdictions?: {
+    MX?: MexReportJurisdictionData;
+    [key: string]: unknown;
+  };
+}
+
+// ===========================
+// MexReport Model
+// ===========================
+
+/**
+ * Mexico Report Model.
+ *
+ * Provides typed accessors for Mexico-specific data.
+ * Extended by MexActividadVulnerableReport.
+ *
+ * @example
+ * ```typescript
+ * if (report instanceof MexReport) {
+ *   console.log(`Activities: ${report.activityCodes.join(", ")}`);
+ * }
+ * ```
+ */
+export class MexReport extends Report {
+  // ─────────────────────────────────────────────────────────────────
+  // Mexico Jurisdiction Data
+  // ─────────────────────────────────────────────────────────────────
+
+  /**
+   * Mexico-specific jurisdiction data
+   */
+  protected get mexicoData(): MexReportJurisdictionData | undefined {
+    return (this._data as MexReportData).jurisdictions?.MX;
+  }
+
+  // ─────────────────────────────────────────────────────────────────
+  // Actividad Vulnerable
+  // ─────────────────────────────────────────────────────────────────
+
+  /**
+   * Whether this report is for an Actividad Vulnerable
+   */
+  get isActividadVulnerable(): boolean {
+    const av = this.mexicoData?.actividadVulnerable;
+    if (!av) return false;
+    return !!(av.AVI || av.JYS || av.TSC);
+  }
+
+  /**
+   * Activity codes with data in this report
+   */
+  get activityCodes(): string[] {
+    const av = this.mexicoData?.actividadVulnerable;
+    if (!av) return [];
+    const codes: string[] = [];
+    if (av.AVI) codes.push("AVI");
+    if (av.JYS) codes.push("JYS");
+    if (av.TSC) codes.push("TSC");
+    return codes;
+  }
+
+  // ─────────────────────────────────────────────────────────────────
+  // String Representation
+  // ─────────────────────────────────────────────────────────────────
+
+  override toString(): string {
+    return `MexReport(${this.id}, ${this.status})`;
+  }
+}
+
+// ===========================
+// Type Guards
+// ===========================
+
+import type { ReportModel } from "../types";
+
+/**
+ * Check if report is a Mexico report
+ */
+export function isMexReport(report: ReportModel): report is MexReport {
+  return report instanceof MexReport;
+}

package/src/models/mex/MexReportItem.ts

@@ -0,0 +1,79 @@
+/**
+ * Mexico Report Item Model
+ *
+ * Extends base ReportItem with Mexico-specific accessors.
+ */
+
+import { ReportItem, type ReportItemData } from "../ReportItem";
+import type { MexReportItemJurisdictionData } from "@artu-ai/shared";
+
+// ===========================
+// Types
+// ===========================
+
+/**
+ * Report item data with Mexico jurisdiction
+ */
+export interface MexReportItemData extends ReportItemData {
+  jurisdictions?: {
+    MX?: MexReportItemJurisdictionData;
+    [key: string]: unknown;
+  };
+}
+
+// ===========================
+// MexReportItem Model
+// ===========================
+
+/**
+ * Mexico Report Item Model.
+ *
+ * Provides typed accessors for Mexico-specific data.
+ * Extended by MexActividadVulnerableReportItem.
+ */
+export class MexReportItem extends ReportItem {
+  // ─────────────────────────────────────────────────────────────────
+  // Mexico Jurisdiction Data
+  // ─────────────────────────────────────────────────────────────────
+
+  /**
+   * Mexico-specific jurisdiction data
+   */
+  protected get mexicoData(): MexReportItemJurisdictionData | undefined {
+    return (this._data as MexReportItemData).jurisdictions?.MX;
+  }
+
+  // ─────────────────────────────────────────────────────────────────
+  // Actividad Vulnerable
+  // ─────────────────────────────────────────────────────────────────
+
+  /**
+   * Whether this item has Actividad Vulnerable data
+   */
+  get isActividadVulnerable(): boolean {
+    const av = this.mexicoData?.actividadVulnerable;
+    if (!av) return false;
+    return !!(av.AVI || av.JYS || av.TSC);
+  }
+
+  // ─────────────────────────────────────────────────────────────────
+  // String Representation
+  // ─────────────────────────────────────────────────────────────────
+
+  override toString(): string {
+    return `MexReportItem(${this.id}, ${this.clientName ?? "Unknown"})`;
+  }
+}
+
+// ===========================
+// Type Guards
+// ===========================
+
+import type { ReportItemModel } from "../types";
+
+/**
+ * Check if report item is a Mexico report item
+ */
+export function isMexReportItem(item: ReportItemModel): item is MexReportItem {
+  return item instanceof MexReportItem;
+}

package/src/models/mex/MexTransaction.ts

@@ -0,0 +1,105 @@
+/**
+ * Mexico Transaction Model
+ *
+ * Extends base Transaction with Mexico-specific accessors.
+ */
+
+import { Transaction, type TransactionData } from "../Transaction";
+import type { MexTransactionJurisdictionData } from "@artu-ai/shared";
+
+// ===========================
+// Types
+// ===========================
+
+/**
+ * Transaction data with Mexico jurisdiction
+ */
+export interface MexTransactionData extends TransactionData {
+  jurisdictions?: {
+    MX?: MexTransactionJurisdictionData;
+    [key: string]: unknown;
+  };
+}
+
+// ===========================
+// MexTransaction Model
+// ===========================
+
+/**
+ * Mexico Transaction Model.
+ *
+ * Provides typed accessors for Mexico-specific transaction data.
+ *
+ * @example
+ * ```typescript
+ * if (txn instanceof MexTransaction) {
+ *   console.log(`Activities: ${txn.activityCodes.join(", ")}`);
+ * }
+ * ```
+ */
+export class MexTransaction extends Transaction {
+  // ─────────────────────────────────────────────────────────────────
+  // Mexico Jurisdiction Data
+  // ─────────────────────────────────────────────────────────────────
+
+  /**
+   * Mexico-specific jurisdiction data
+   */
+  protected get mexicoData(): MexTransactionJurisdictionData | undefined {
+    return (this._data as MexTransactionData).jurisdictions?.MX;
+  }
+
+  // ─────────────────────────────────────────────────────────────────
+  // Actividades Vulnerables
+  // ─────────────────────────────────────────────────────────────────
+
+  /**
+   * Whether transaction is related to any Actividad Vulnerable
+   */
+  get isActividadVulnerable(): boolean {
+    const av = this.mexicoData?.actividadVulnerable;
+    if (!av) return false;
+    return !!(av.AVI || av.JYS || av.TSC);
+  }
+
+  /**
+   * Activity codes this transaction is associated with
+   */
+  get activityCodes(): string[] {
+    const av = this.mexicoData?.actividadVulnerable;
+    if (!av) return [];
+    const codes: string[] = [];
+    if (av.AVI) codes.push("AVI");
+    if (av.JYS) codes.push("JYS");
+    if (av.TSC) codes.push("TSC");
+    return codes;
+  }
+
+  /**
+   * Checks if transaction is for a specific activity
+   */
+  hasActivity(code: "AVI" | "JYS" | "TSC"): boolean {
+    return this.activityCodes.includes(code);
+  }
+
+  // ─────────────────────────────────────────────────────────────────
+  // String Representation
+  // ─────────────────────────────────────────────────────────────────
+
+  override toString(): string {
+    return `MexTransaction(${this.id}, ${this.formattedAmount}, Activities: [${this.activityCodes.join(", ")}])`;
+  }
+}
+
+// ===========================
+// Type Guards
+// ===========================
+
+import type { TransactionModel } from "../types";
+
+/**
+ * Check if transaction is a Mexico transaction
+ */
+export function isMexTransaction(txn: TransactionModel): txn is MexTransaction {
+  return txn instanceof MexTransaction;
+}

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

@@ -0,0 +1,66 @@
+/**
+ * Mexico Actividad Vulnerable Base Client
+ *
+ * Common functionality for all Actividad Vulnerable clients.
+ * Extended by activity-specific models (AVI, JYS, TSC).
+ */
+
+import { MexClient } from "../MexClient";
+import type { ClientRelationshipType } from "@artu-ai/shared";
+
+// ===========================
+// MexActividadVulnerableClient Model
+// ===========================
+
+/**
+ * Base model for Mexico Actividad Vulnerable clients.
+ *
+ * Provides common accessors for all activity types.
+ * Extended by MexAVIClient, MexJYSClient, MexTSCClient.
+ *
+ * @example
+ * ```typescript
+ * if (client instanceof MexActividadVulnerableClient) {
+ *   console.log(`Activities: ${client.activityCodes.join(", ")}`);
+ * }
+ * ```
+ */
+export class MexActividadVulnerableClient extends MexClient {
+  // ─────────────────────────────────────────────────────────────────
+  // String Representation
+  // ─────────────────────────────────────────────────────────────────
+
+  override toString(): string {
+    return `MexActividadVulnerableClient(${this.id}, ${this.name}, Activities: [${this.activityCodes.join(", ")}])`;
+  }
+
+  /**
+   * Linked clients (if included) instantiated as MexActividadVulnerableClient
+   */
+  override get linkedClients():
+    | {
+        relationshipType: ClientRelationshipType;
+        client: MexActividadVulnerableClient;
+      }[]
+    | undefined {
+    return (this._data.linkedClients ?? []).map((l) => ({
+      relationshipType: l.relationshipType,
+      client: new MexActividadVulnerableClient(l.client),
+    }));
+  }
+}
+
+// ===========================
+// Type Guards
+// ===========================
+
+import type { ClientModel } from "../../types";
+
+/**
+ * Check if client is registered for any Actividad Vulnerable
+ */
+export function isActividadVulnerable(
+  client: ClientModel
+): client is MexActividadVulnerableClient {
+  return client instanceof MexActividadVulnerableClient;
+}

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

@@ -0,0 +1,73 @@
+/**
+ * Mexico Actividad Vulnerable Base Report
+ *
+ * Common functionality for all Actividad Vulnerable reports.
+ * Extended by activity-specific models (AVI, JYS, TSC).
+ */
+
+import { MexReport, type MexReportData } from "../MexReport";
+import type { ActividadVulnerableReportData } from "@artu-ai/shared";
+
+// ===========================
+// Types
+// ===========================
+
+/**
+ * Report data with Actividad Vulnerable data
+ */
+export interface MexActividadVulnerableReportData extends MexReportData {
+  jurisdictions?: {
+    MX?: {
+      actividadVulnerable?: ActividadVulnerableReportData;
+    };
+    [key: string]: unknown;
+  };
+}
+
+// ===========================
+// MexActividadVulnerableReport Model
+// ===========================
+
+/**
+ * Base model for Mexico Actividad Vulnerable reports.
+ *
+ * Provides common accessors for all activity types.
+ * Extended by MexAVIReport, MexJYSReport, MexTSCReport.
+ */
+export class MexActividadVulnerableReport extends MexReport {
+  // ─────────────────────────────────────────────────────────────────
+  // Activity Data
+  // ─────────────────────────────────────────────────────────────────
+
+  /**
+   * Actividad Vulnerable data
+   */
+  protected get actividadVulnerableData():
+    | ActividadVulnerableReportData
+    | undefined {
+    return this.mexicoData?.actividadVulnerable;
+  }
+
+  // ─────────────────────────────────────────────────────────────────
+  // String Representation
+  // ─────────────────────────────────────────────────────────────────
+
+  override toString(): string {
+    return `MexActividadVulnerableReport(${this.id}, ${this.status})`;
+  }
+}
+
+// ===========================
+// Type Guards
+// ===========================
+
+import type { ReportModel } from "../../types";
+
+/**
+ * Check if report is for any Actividad Vulnerable
+ */
+export function isActividadVulnerableReport(
+  report: ReportModel
+): report is MexActividadVulnerableReport {
+  return report instanceof MexActividadVulnerableReport;
+}

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

@@ -0,0 +1,74 @@
+/**
+ * Mexico Actividad Vulnerable Base Report Item
+ *
+ * Common functionality for all Actividad Vulnerable report items.
+ * Extended by activity-specific models (AVI, JYS, TSC).
+ */
+
+import { MexReportItem, type MexReportItemData } from "../MexReportItem";
+import type { ActividadVulnerableReportItemData } from "@artu-ai/shared";
+
+// ===========================
+// Types
+// ===========================
+
+/**
+ * Report item data with Actividad Vulnerable data
+ */
+export interface MexActividadVulnerableReportItemData
+  extends MexReportItemData {
+  jurisdictions?: {
+    MX?: {
+      actividadVulnerable?: ActividadVulnerableReportItemData;
+    };
+    [key: string]: unknown;
+  };
+}
+
+// ===========================
+// MexActividadVulnerableReportItem Model
+// ===========================
+
+/**
+ * Base model for Mexico Actividad Vulnerable report items.
+ *
+ * Provides common accessors for all activity types.
+ * Extended by MexAVIReportItem, MexJYSReportItem, MexTSCReportItem.
+ */
+export class MexActividadVulnerableReportItem extends MexReportItem {
+  // ─────────────────────────────────────────────────────────────────
+  // Activity Data
+  // ─────────────────────────────────────────────────────────────────
+
+  /**
+   * Actividad Vulnerable data
+   */
+  protected get actividadVulnerableData():
+    | ActividadVulnerableReportItemData
+    | undefined {
+    return this.mexicoData?.actividadVulnerable;
+  }
+
+  // ─────────────────────────────────────────────────────────────────
+  // String Representation
+  // ─────────────────────────────────────────────────────────────────
+
+  override toString(): string {
+    return `MexActividadVulnerableReportItem(${this.id}, ${this.clientName ?? "Unknown"})`;
+  }
+}
+
+// ===========================
+// Type Guards
+// ===========================
+
+import type { ReportItemModel } from "../../types";
+
+/**
+ * Check if report item is for any Actividad Vulnerable
+ */
+export function isActividadVulnerableReportItem(
+  item: ReportItemModel
+): item is MexActividadVulnerableReportItem {
+  return item instanceof MexActividadVulnerableReportItem;
+}

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

@@ -0,0 +1,50 @@
+/**
+ * Mexico Actividad Vulnerable Transaction Base
+ *
+ * Common functionality for all Actividad Vulnerable transactions.
+ * Extended by activity-specific models (AVI, JYS, TSC).
+ */
+
+import { MexTransaction } from "../MexTransaction";
+
+// ===========================
+// MexActividadVulnerableTransaction Model
+// ===========================
+
+/**
+ * Base model for Mexico Actividad Vulnerable transactions.
+ *
+ * Provides common accessors for all activity types.
+ * Extended by MexAVITransaction, MexJYSTransaction, MexTSCTransaction.
+ *
+ * @example
+ * ```typescript
+ * if (txn instanceof MexActividadVulnerableTransaction) {
+ *   console.log(`Activities: ${txn.activityCodes.join(", ")}`);
+ * }
+ * ```
+ */
+export class MexActividadVulnerableTransaction extends MexTransaction {
+  // ─────────────────────────────────────────────────────────────────
+  // String Representation
+  // ─────────────────────────────────────────────────────────────────
+
+  override toString(): string {
+    return `MexActividadVulnerableTransaction(${this.id}, ${this.formattedAmount}, Activities: [${this.activityCodes.join(", ")}])`;
+  }
+}
+
+// ===========================
+// Type Guards
+// ===========================
+
+import type { TransactionModel } from "../../types";
+
+/**
+ * Check if transaction is for any Actividad Vulnerable
+ */
+export function isActividadVulnerableTransaction(
+  txn: TransactionModel
+): txn is MexActividadVulnerableTransaction {
+  return txn instanceof MexActividadVulnerableTransaction;
+}

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

@@ -0,0 +1,80 @@
+/**
+ * Mexico AVI (Activos Virtuales) Client
+ *
+ * Specialized for virtual asset / cryptocurrency operations.
+ */
+
+import type { ClientRelationshipType, avi } from "@artu-ai/shared";
+import { MexActividadVulnerableClient } from "../MexActividadVulnerableClient";
+
+// ===========================
+// MexAVIClient Model
+// ===========================
+
+/**
+ * Mexico AVI Client Model.
+ *
+ * Provides typed accessors for virtual asset specific data.
+ *
+ * @example
+ * ```typescript
+ * if (client instanceof MexAVIClient) {
+ *   console.log(`Username: ${client.aviUsername}`);
+ * }
+ * ```
+ */
+export class MexAVIClient extends MexActividadVulnerableClient {
+  // ─────────────────────────────────────────────────────────────────
+  // AVI-Specific Data
+  // ─────────────────────────────────────────────────────────────────
+
+  /**
+   * AVI-specific activity data
+   */
+  protected get aviData(): avi.AVIClientData | undefined {
+    return this.mexicoData?.actividadVulnerable?.AVI;
+  }
+
+  /**
+   * Platform username for virtual asset operations
+   */
+  get username(): string | undefined {
+    return this.aviData?.username;
+  }
+
+  // ─────────────────────────────────────────────────────────────────
+  // String Representation
+  // ─────────────────────────────────────────────────────────────────
+
+  override toString(): string {
+    return `MexAVIClient(${this.id}, ${this.name}, Username: ${this.username ?? "N/A"})`;
+  }
+
+  /**
+   * Linked clients (if included) instantiated as MexAVIClient
+   */
+  override get linkedClients():
+    | {
+        relationshipType: ClientRelationshipType;
+        client: MexAVIClient;
+      }[]
+    | undefined {
+    return (this._data.linkedClients ?? []).map((l) => ({
+      relationshipType: l.relationshipType,
+      client: new MexAVIClient(l.client),
+    }));
+  }
+}
+
+// ===========================
+// Type Guards
+// ===========================
+
+import type { ClientModel } from "../../../types";
+
+/**
+ * Check if client is an AVI (Activos Virtuales) client
+ */
+export function isMexAVIClient(client: ClientModel): client is MexAVIClient {
+  return client instanceof MexAVIClient;
+}