@artu-ai/compliance-sdk 0.0.5 → 0.2.0

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

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

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

@@ -0,0 +1,178 @@
+/**
+ * Mexico JYS (Juegos y Sorteos) Transaction
+ *
+ * Specialized for gaming and lottery transactions.
+ */
+
+import { jys } from "@artu-ai/shared";
+import { MexActividadVulnerableTransaction } from "../MexActividadVulnerableTransaction";
+
+// ===========================
+// MexJYSTransaction Model
+// ===========================
+
+/**
+ * Mexico JYS Transaction Model.
+ *
+ * Provides typed accessors for gaming/lottery transaction data.
+ *
+ * @example
+ * ```typescript
+ * if (txn instanceof MexJYSTransaction) {
+ *   console.log(`Operation: ${txn.operationType}`);
+ *   console.log(`Settlement: ${txn.settlementType}`);
+ * }
+ * ```
+ */
+export class MexJYSTransaction extends MexActividadVulnerableTransaction {
+  // ─────────────────────────────────────────────────────────────────
+  // JYS-Specific Data
+  // ─────────────────────────────────────────────────────────────────
+
+  /**
+   * JYS-specific transaction data
+   */
+  protected get jysData(): jys.JYSTransactionData | undefined {
+    return this.mexicoData?.actividadVulnerable?.JYS;
+  }
+
+  // ─────────────────────────────────────────────────────────────────
+  // Operation Fields
+  // ─────────────────────────────────────────────────────────────────
+
+  /**
+   * Operation type (e.g., bet, prize, purchase)
+   */
+  get operationType(): string | undefined {
+    return this.jysData?.operationType;
+  }
+
+  /**
+   * Business line (e.g., casino, lottery, sports betting)
+   */
+  get businessLine(): string | undefined {
+    return this.jysData?.businessLine;
+  }
+
+  /**
+   * Operation method (e.g., in-individual, online)
+   */
+  get operationMethod(): string | undefined {
+    return this.jysData?.operationMethod;
+  }
+
+  // ─────────────────────────────────────────────────────────────────
+  // Branch Information
+  // ─────────────────────────────────────────────────────────────────
+
+  /**
+   * Branch information where the transaction occurred
+   */
+  get branchInfo(): jys.BranchInformation | undefined {
+    const data = this.jysData;
+    if (!data) return undefined;
+    return data.branchInformation;
+  }
+
+  /**
+   * Branch postal code
+   */
+  get branchPostalCode(): string | undefined {
+    return this.branchInfo?.postalCode;
+  }
+
+  /**
+   * Whether this is an operator branch (vs own branch)
+   */
+  get isOperatorBranch(): boolean {
+    return this.branchInfo?.type === jys.TipoSucursal.Operator;
+  }
+
+  /**
+   * Operator name (if operator branch)
+   */
+  get operatorName(): string | undefined {
+    const info = this.branchInfo;
+    if (info?.type === jys.TipoSucursal.Operator) {
+      return info.operatorName;
+    }
+    return undefined;
+  }
+
+  // ─────────────────────────────────────────────────────────────────
+  // Settlement Information
+  // ─────────────────────────────────────────────────────────────────
+
+  /**
+   * Settlement type (cash or in-kind)
+   */
+  get settlementType(): jys.TipoLiquidacion | undefined {
+    const data = this.jysData;
+    if (!data || !("settlementType" in data)) return undefined;
+    return data.settlementType;
+  }
+
+  /**
+   * Whether this is a cash settlement
+   */
+  get isCashSettlement(): boolean {
+    return this.settlementType === jys.TipoLiquidacion.Cash;
+  }
+
+  /**
+   * Whether this is an in-kind settlement (assets)
+   */
+  get isInKindSettlement(): boolean {
+    return this.settlementType === jys.TipoLiquidacion.InKind;
+  }
+
+  /**
+   * Monetary instrument (for cash settlements)
+   */
+  get monetaryInstrument(): string | undefined {
+    const data = this.jysData;
+    if (!data || !("monetaryInstrument" in data)) return undefined;
+    return data.monetaryInstrument as string;
+  }
+
+  /**
+   * Asset type (for in-kind settlements)
+   */
+  get assetType(): string | undefined {
+    const data = this.jysData;
+    if (!data || !("assetType" in data)) return undefined;
+    return data.assetType as string;
+  }
+
+  /**
+   * Real estate type (for real estate in-kind settlements)
+   */
+  get realEstateType(): string | undefined {
+    const data = this.jysData;
+    if (!data || !("realEstateType" in data)) return undefined;
+    return data.realEstateType as string;
+  }
+
+  // ─────────────────────────────────────────────────────────────────
+  // String Representation
+  // ─────────────────────────────────────────────────────────────────
+
+  override toString(): string {
+    return `MexJYSTransaction(${this.id}, ${this.formattedAmount}, ${this.operationType ?? "unknown"})`;
+  }
+}
+
+// ===========================
+// Type Guards
+// ===========================
+
+import type { TransactionModel } from "../../../types";
+
+/**
+ * Check if transaction is a JYS (Juegos y Sorteos) transaction
+ */
+export function isMexJYSTransaction(
+  txn: TransactionModel
+): txn is MexJYSTransaction {
+  return txn instanceof MexJYSTransaction;
+}

package/src/models/mex/actividad-vulnerable/tsc/MexTSCClient.ts

@@ -0,0 +1,73 @@
+/**
+ * Mexico TSC (Tarjetas de Servicio y Crédito) Client
+ *
+ * Specialized for service and credit card operations.
+ */
+
+import type { ClientRelationshipType, tsc } from "@artu-ai/shared";
+import { MexActividadVulnerableClient } from "../MexActividadVulnerableClient";
+
+// ===========================
+// MexTSCClient Model
+// ===========================
+
+/**
+ * Mexico TSC Client Model.
+ *
+ * Provides typed accessors for service/credit card specific data.
+ *
+ * @example
+ * ```typescript
+ * if (client instanceof MexTSCClient) {
+ *   console.log(`TSC Client: ${client.name}`);
+ * }
+ * ```
+ */
+export class MexTSCClient extends MexActividadVulnerableClient {
+  // ─────────────────────────────────────────────────────────────────
+  // TSC-Specific Data
+  // ─────────────────────────────────────────────────────────────────
+
+  /**
+   * TSC-specific activity data
+   */
+  protected get tscData(): tsc.TSCClientData | undefined {
+    return this.mexicoData?.actividadVulnerable?.TSC;
+  }
+
+  // ─────────────────────────────────────────────────────────────────
+  // String Representation
+  // ─────────────────────────────────────────────────────────────────
+
+  override toString(): string {
+    return `MexTSCClient(${this.id}, ${this.name})`;
+  }
+
+  /**
+   * Linked clients (if included) instantiated as MexTSCClient
+   */
+  override get linkedClients():
+    | {
+        relationshipType: ClientRelationshipType;
+        client: MexTSCClient;
+      }[]
+    | undefined {
+    return (this._data.linkedClients ?? []).map((l) => ({
+      relationshipType: l.relationshipType,
+      client: new MexTSCClient(l.client),
+    }));
+  }
+}
+
+// ===========================
+// Type Guards
+// ===========================
+
+import type { ClientModel } from "../../../types";
+
+/**
+ * Check if client is a TSC (Tarjetas de Servicio y Crédito) client
+ */
+export function isMexTSCClient(client: ClientModel): client is MexTSCClient {
+  return client instanceof MexTSCClient;
+}

package/src/models/mex/actividad-vulnerable/tsc/MexTSCReport.ts

@@ -0,0 +1,114 @@
+/**
+ * Mexico TSC Report Model
+ *
+ * Report model for Tarjetas de Servicio y Crédito (Service and Credit Cards) activity.
+ */
+
+import {
+  MexActividadVulnerableReport,
+  type MexActividadVulnerableReportData,
+} from "../MexActividadVulnerableReport";
+import type { tsc } from "@artu-ai/shared";
+
+// ===========================
+// Types
+// ===========================
+
+/**
+ * TSC report data
+ */
+export interface MexTSCReportData extends MexActividadVulnerableReportData {
+  jurisdictions?: {
+    MX?: {
+      actividadVulnerable?: {
+        TSC?: tsc.TSCReportData;
+      };
+    };
+    [key: string]: unknown;
+  };
+}
+
+// ===========================
+// MexTSCReport Model
+// ===========================
+
+/**
+ * Mexico TSC Report Model.
+ *
+ * Provides typed accessors for TSC-specific report data.
+ *
+ * @example
+ * ```typescript
+ * if (report instanceof MexTSCReport) {
+ *   console.log(`Period: ${report.mesReportado}`);
+ * }
+ * ```
+ */
+export class MexTSCReport extends MexActividadVulnerableReport {
+  // ─────────────────────────────────────────────────────────────────
+  // TSC Data
+  // ─────────────────────────────────────────────────────────────────
+
+  /**
+   * TSC-specific report data
+   */
+  protected get tscData(): tsc.TSCReportData | undefined {
+    return this.actividadVulnerableData?.TSC;
+  }
+
+  /**
+   * Reporting period (YYYYMM format)
+   */
+  get mesReportado(): string | undefined {
+    return this.tscData?.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 `MexTSCReport(${this.id}, ${this.mesReportado ?? "N/A"})`;
+  }
+}
+
+// ===========================
+// Type Guards
+// ===========================
+
+import type { ReportModel } from "../../../types";
+
+/**
+ * Check if report is a TSC (Tarjetas de Servicio y Crédito) report
+ */
+export function isMexTSCReport(report: ReportModel): report is MexTSCReport {
+  return report instanceof MexTSCReport;
+}

package/src/models/mex/actividad-vulnerable/tsc/MexTSCReportItem.ts

@@ -0,0 +1,105 @@
+/**
+ * Mexico TSC Report Item Model
+ *
+ * Report item model for Tarjetas de Servicio y Crédito (Service and Credit Cards) activity.
+ */
+
+import {
+  MexActividadVulnerableReportItem,
+  type MexActividadVulnerableReportItemData,
+} from "../MexActividadVulnerableReportItem";
+import type { tsc } from "@artu-ai/shared";
+
+// ===========================
+// Types
+// ===========================
+
+/**
+ * TSC report item data
+ */
+export interface MexTSCReportItemData
+  extends MexActividadVulnerableReportItemData {
+  jurisdictions?: {
+    MX?: {
+      actividadVulnerable?: {
+        TSC?: tsc.TSCReportItemData;
+      };
+    };
+    [key: string]: unknown;
+  };
+}
+
+// ===========================
+// MexTSCReportItem Model
+// ===========================
+
+/**
+ * Mexico TSC Report Item Model.
+ *
+ * Provides typed accessors for TSC-specific report item data.
+ */
+export class MexTSCReportItem extends MexActividadVulnerableReportItem {
+  // ─────────────────────────────────────────────────────────────────
+  // TSC Data
+  // ─────────────────────────────────────────────────────────────────
+
+  /**
+   * TSC-specific report item data
+   */
+  protected get tscData(): tsc.TSCReportItemData | undefined {
+    return this.actividadVulnerableData?.TSC;
+  }
+
+  /**
+   * Alert type code
+   * - "100" for monthly reports
+   * - Other codes for unusual activity
+   */
+  get alertType(): tsc.TipoAlerta | undefined {
+    return this.tscData?.alertType;
+  }
+
+  /**
+   * Alert description (for unusual activity)
+   */
+  get alertDescription(): string | undefined {
+    return this.tscData?.alertDescription;
+  }
+
+  /**
+   * Amendment data for corrections
+   */
+  get amendment(): tsc.Amendment | undefined {
+    return this.tscData?.amendment;
+  }
+
+  /**
+   * Whether this item is an amendment
+   */
+  get isAmendment(): boolean {
+    return !!this.tscData?.amendment;
+  }
+
+  // ─────────────────────────────────────────────────────────────────
+  // String Representation
+  // ─────────────────────────────────────────────────────────────────
+
+  override toString(): string {
+    return `MexTSCReportItem(${this.id}, ${this.clientName ?? "Unknown"}, Alert: ${this.alertType ?? "N/A"})`;
+  }
+}
+
+// ===========================
+// Type Guards
+// ===========================
+
+import type { ReportItemModel } from "../../../types";
+
+/**
+ * Check if report item is a TSC (Tarjetas de Servicio y Crédito) report item
+ */
+export function isMexTSCReportItem(
+  item: ReportItemModel
+): item is MexTSCReportItem {
+  return item instanceof MexTSCReportItem;
+}

package/src/models/mex/actividad-vulnerable/tsc/MexTSCTransaction.ts

@@ -0,0 +1,104 @@
+/**
+ * Mexico TSC (Tarjetas de Servicio y Crédito) Transaction
+ *
+ * Specialized for service and credit card transactions.
+ */
+
+import { tsc } from "@artu-ai/shared";
+import { MexActividadVulnerableTransaction } from "../MexActividadVulnerableTransaction";
+
+// ===========================
+// MexTSCTransaction Model
+// ===========================
+
+/**
+ * Mexico TSC Transaction Model.
+ *
+ * Provides typed accessors for service/credit card transaction data.
+ *
+ * @example
+ * ```typescript
+ * if (txn instanceof MexTSCTransaction) {
+ *   console.log(`Card: ${txn.cardType}`);
+ *   console.log(`ID: ${txn.idNumber}`);
+ * }
+ * ```
+ */
+export class MexTSCTransaction extends MexActividadVulnerableTransaction {
+  // ─────────────────────────────────────────────────────────────────
+  // TSC-Specific Data
+  // ─────────────────────────────────────────────────────────────────
+
+  /**
+   * TSC-specific transaction data
+   */
+  protected get tscData(): tsc.TSCTransactionData | undefined {
+    return this.mexicoData?.actividadVulnerable?.TSC;
+  }
+
+  // ─────────────────────────────────────────────────────────────────
+  // Card Fields
+  // ─────────────────────────────────────────────────────────────────
+
+  /**
+   * Card type (service or credit)
+   */
+  get cardType(): string | undefined {
+    return this.tscData?.cardType;
+  }
+
+  /**
+   * Card/account identifier
+   */
+  get idNumber(): string | undefined {
+    return this.tscData?.idNumber;
+  }
+
+  /**
+   * Operation type (typically card consumption)
+   */
+  get operationType(): string | undefined {
+    return this.tscData?.operationType;
+  }
+
+  // ─────────────────────────────────────────────────────────────────
+  // Helpers
+  // ─────────────────────────────────────────────────────────────────
+
+  /**
+   * Whether this is a service card transaction
+   */
+  get isServiceCard(): boolean {
+    return this.cardType === tsc.TiposTarjeta.enum.ServiceCard;
+  }
+
+  /**
+   * Whether this is a credit card transaction
+   */
+  get isCreditCard(): boolean {
+    return this.cardType === tsc.TiposTarjeta.enum.CreditCard;
+  }
+
+  // ─────────────────────────────────────────────────────────────────
+  // String Representation
+  // ─────────────────────────────────────────────────────────────────
+
+  override toString(): string {
+    return `MexTSCTransaction(${this.id}, ${this.formattedAmount}, ${this.cardType ?? "unknown"})`;
+  }
+}
+
+// ===========================
+// Type Guards
+// ===========================
+
+import type { TransactionModel } from "../../../types";
+
+/**
+ * Check if transaction is a TSC (Tarjetas de Servicio y Crédito) transaction
+ */
+export function isMexTSCTransaction(
+  txn: TransactionModel
+): txn is MexTSCTransaction {
+  return txn instanceof MexTSCTransaction;
+}