@artu-ai/compliance-sdk 0.0.6 → 0.3.0

package/src/models/mex/index.ts

@@ -0,0 +1,57 @@
+/**
+ * Mexico Models
+ */
+
+// Mexico jurisdiction client
+export { MexClient, type MexClientData, isMexClient } from "./MexClient";
+
+// Mexico jurisdiction transaction
+export {
+  MexTransaction,
+  type MexTransactionData,
+  isMexTransaction,
+} from "./MexTransaction";
+
+// Mexico bank account
+export {
+  MexBankAccount,
+  type MexBankAccountData,
+  isMexBankAccount,
+} from "./MexBankAccount";
+
+// Mexico address
+export { MexAddress, type MexAddressData, isMexAddress } from "./MexAddress";
+
+// Mexico documents with typed field accessors
+export {
+  MexDocument,
+  MexIneFrontDocument,
+  MexIneBackDocument,
+  MexPassportDocument,
+  MexCurpDocument,
+  MexRfcConstanciaDocument,
+  MexAddressProofDocument,
+  MexActaConstitutivaDocument,
+  MexPoderNotarialDocument,
+  // Type guards
+  isMexDocument,
+  isMexIneFront,
+  isMexIneBack,
+  isMexPassport,
+  isMexCurp,
+  isMexRfcConstancia,
+  isMexAddressProof,
+  isMexActaConstitutiva,
+  isMexPoderNotarial,
+} from "./MexDocument";
+
+// Mexico jurisdiction report
+export { MexReport, type MexReportData, isMexReport } from "./MexReport";
+export {
+  MexReportItem,
+  type MexReportItemData,
+  isMexReportItem,
+} from "./MexReportItem";
+
+// Activity-specific models
+export * from "./actividad-vulnerable";

package/src/models/types.ts

@@ -0,0 +1,196 @@
+/**
+ * Model Type Definitions
+ *
+ * Union types and type aliases for the model hierarchy.
+ */
+
+import type { Address } from "./Address";
+import type { BankAccount } from "./BankAccount";
+import type { Client } from "./Client";
+import type { Report } from "./Report";
+import type { ReportItem } from "./ReportItem";
+import type { Transaction } from "./Transaction";
+import type { MexAddress } from "./mex/MexAddress";
+import type { MexBankAccount } from "./mex/MexBankAccount";
+import type { MexClient } from "./mex/MexClient";
+import type { MexReport } from "./mex/MexReport";
+import type { MexReportItem } from "./mex/MexReportItem";
+import type { MexTransaction } from "./mex/MexTransaction";
+import type {
+  MexActividadVulnerableClient,
+  MexActividadVulnerableTransaction,
+  MexActividadVulnerableReport,
+  MexActividadVulnerableReportItem,
+  MexAVIClient,
+  MexJYSClient,
+  MexTSCClient,
+  MexAVITransaction,
+  MexJYSTransaction,
+  MexTSCTransaction,
+  MexAVIReport,
+  MexJYSReport,
+  MexTSCReport,
+  MexAVIReportItem,
+  MexJYSReportItem,
+  MexTSCReportItem,
+} from "./mex/actividad-vulnerable";
+
+// ===========================
+// Client Model Types
+// ===========================
+
+/**
+ * Union of all client model types.
+ * Used for smart instantiation return type.
+ */
+export type ClientModel =
+  | Client
+  | MexClient
+  | MexActividadVulnerableClient
+  | MexAVIClient
+  | MexJYSClient
+  | MexTSCClient;
+
+/**
+ * Union of Mexico-specific client types
+ */
+export type MexClientModel =
+  | MexClient
+  | MexActividadVulnerableClient
+  | MexAVIClient
+  | MexJYSClient
+  | MexTSCClient;
+
+/**
+ * Union of Actividad Vulnerable client types
+ */
+export type ActividadVulnerableClientModel =
+  | MexActividadVulnerableClient
+  | MexAVIClient
+  | MexJYSClient
+  | MexTSCClient;
+
+// ===========================
+// Transaction Model Types
+// ===========================
+
+/**
+ * Union of all transaction model types.
+ * Used for smart instantiation return type.
+ */
+export type TransactionModel =
+  | Transaction
+  | MexTransaction
+  | MexActividadVulnerableTransaction
+  | MexAVITransaction
+  | MexJYSTransaction
+  | MexTSCTransaction;
+
+/**
+ * Union of Mexico-specific transaction types
+ */
+export type MexTransactionModel =
+  | MexTransaction
+  | MexActividadVulnerableTransaction
+  | MexAVITransaction
+  | MexJYSTransaction
+  | MexTSCTransaction;
+
+/**
+ * Union of Actividad Vulnerable transaction types
+ */
+export type ActividadVulnerableTransactionModel =
+  | MexActividadVulnerableTransaction
+  | MexAVITransaction
+  | MexJYSTransaction
+  | MexTSCTransaction;
+
+// ===========================
+// Address Model Types
+// ===========================
+
+/**
+ * Union of all address model types.
+ * Used for smart instantiation return type.
+ */
+export type AddressModel = Address | MexAddress;
+
+// ===========================
+// Bank Account Model Types
+// ===========================
+
+/**
+ * Union of all bank account model types.
+ * Used for smart instantiation return type.
+ */
+export type BankAccountModel = BankAccount | MexBankAccount;
+
+// ===========================
+// Report Model Types
+// ===========================
+
+/**
+ * Union of all report model types.
+ * Used for smart instantiation return type.
+ */
+export type ReportModel =
+  | Report
+  | MexReport
+  | MexActividadVulnerableReport
+  | MexAVIReport
+  | MexJYSReport
+  | MexTSCReport;
+
+/**
+ * Union of Mexico-specific report types
+ */
+export type MexReportModel =
+  | MexReport
+  | MexActividadVulnerableReport
+  | MexAVIReport
+  | MexJYSReport
+  | MexTSCReport;
+
+/**
+ * Union of Actividad Vulnerable report types
+ */
+export type ActividadVulnerableReportModel =
+  | MexActividadVulnerableReport
+  | MexAVIReport
+  | MexJYSReport
+  | MexTSCReport;
+
+// ===========================
+// Report Item Model Types
+// ===========================
+
+/**
+ * Union of all report item model types.
+ * Used for smart instantiation return type.
+ */
+export type ReportItemModel =
+  | ReportItem
+  | MexReportItem
+  | MexActividadVulnerableReportItem
+  | MexAVIReportItem
+  | MexJYSReportItem
+  | MexTSCReportItem;
+
+/**
+ * Union of Mexico-specific report item types
+ */
+export type MexReportItemModel =
+  | MexReportItem
+  | MexActividadVulnerableReportItem
+  | MexAVIReportItem
+  | MexJYSReportItem
+  | MexTSCReportItem;
+
+/**
+ * Union of Actividad Vulnerable report item types
+ */
+export type ActividadVulnerableReportItemModel =
+  | MexActividadVulnerableReportItem
+  | MexAVIReportItem
+  | MexJYSReportItem
+  | MexTSCReportItem;

package/src/namespaces/index.ts

@@ -0,0 +1,29 @@
+/**
+ * Namespace exports
+ *
+ * Jurisdiction-based namespaces containing all related functionality.
+ * This keeps the SDK organized as it grows to support more jurisdictions.
+ *
+ * @example
+ * ```ts
+ * import { Mexico } from "@artu/compliance-sdk";
+ *
+ * // All Mexico functionality under one namespace
+ * Mexico.Enums.ActividadEconomica
+ * Mexico.Validators.Rfc.validate(...)
+ * Mexico.Models.Client
+ * Mexico.Resources.Clients
+ * Mexico.TypeGuards.isClient(...)
+ *
+ * // Actividad Vulnerable (nested)
+ * Mexico.ActividadVulnerable.Enums.CodigoActividad
+ * Mexico.ActividadVulnerable.AVI.Models.Client
+ * Mexico.AVI.Enums.TipoOperacion.Buy  // shortcut
+ * ```
+ */
+
+// Jurisdiction namespaces
+export { Mexico, ActividadVulnerable, AVI, JYS, TSC } from "./mexico";
+
+// Future: export { US } from "./us";
+// Future: export { EU } from "./eu";

package/src/namespaces/mexico/actividad-vulnerable/avi/index.ts

@@ -0,0 +1,62 @@
+/**
+ * AVI (Activos Virtuales) namespace
+ */
+
+import { avi } from "@artu-ai/shared";
+import {
+  MexAVIClient,
+  MexAVITransaction,
+  MexAVIReport,
+  MexAVIReportItem,
+  isMexAVIClient,
+  isMexAVITransaction,
+  isMexAVIReport,
+  isMexAVIReportItem,
+} from "../../../../models";
+import {
+  AVIClientsResource,
+  AVITransactionsResource,
+  AVIReportsResource,
+} from "../../../../resources";
+
+export const Enums = {
+  // Enum values
+  TipoOperacion: avi.TipoOperacion,
+  TipoAlerta: avi.TipoAlerta,
+  InstrumentoMonetario: avi.InstrumentoMonetario,
+  ActivoVirtual: avi.ActivoVirtual,
+  // Enum utilities (with .enum, .map, .codes, .options, .schema())
+  TiposOperacion: avi.TiposOperacion,
+  TiposAlerta: avi.TiposAlerta,
+  InstrumentosMonetarios: avi.InstrumentosMonetarios,
+  ActivosVirtuales: avi.ActivosVirtuales,
+} as const;
+
+export const Models = {
+  Client: MexAVIClient,
+  Transaction: MexAVITransaction,
+  Report: MexAVIReport,
+  ReportItem: MexAVIReportItem,
+} as const;
+
+export const Resources = {
+  Clients: AVIClientsResource,
+  Transactions: AVITransactionsResource,
+  Reports: AVIReportsResource,
+} as const;
+
+export const TypeGuards = {
+  isClient: isMexAVIClient,
+  isTransaction: isMexAVITransaction,
+  isReport: isMexAVIReport,
+  isReportItem: isMexAVIReportItem,
+} as const;
+
+export const AVI = {
+  Enums,
+  Models,
+  Resources,
+  TypeGuards,
+} as const;
+
+export default AVI;

package/src/namespaces/mexico/actividad-vulnerable/index.ts

@@ -0,0 +1,79 @@
+/**
+ * Actividad Vulnerable namespace
+ *
+ * Mexican AML compliance activities (Ley Federal para la Prevención e
+ * Identificación de Operaciones con Recursos de Procedencia Ilícita).
+ */
+
+import {
+  CodigoActividad,
+  CodigosActividad,
+  Moneda,
+  Monedas,
+  TipoIdentificacion,
+  TiposIdentificacion,
+  Prioridad,
+  Prioridades,
+} from "@artu-ai/shared";
+import {
+  MexActividadVulnerableClient,
+  MexActividadVulnerableTransaction,
+  MexActividadVulnerableReport,
+  MexActividadVulnerableReportItem,
+  isActividadVulnerable,
+  isActividadVulnerableTransaction,
+  isActividadVulnerableReport,
+  isActividadVulnerableReportItem,
+} from "../../../models";
+
+// Activity-specific namespaces
+import { AVI } from "./avi";
+import { JYS } from "./jys";
+import { TSC } from "./tsc";
+
+// Re-export activity namespaces
+export { AVI } from "./avi";
+export { JYS } from "./jys";
+export { TSC } from "./tsc";
+
+/** Base Actividad Vulnerable enums (shared across activities) */
+export const Enums = {
+  // Enum values
+  CodigoActividad,
+  Moneda,
+  TipoIdentificacion,
+  Prioridad,
+  // Enum utilities (with .enum, .map, .codes, .options, .schema())
+  CodigosActividad,
+  Monedas,
+  TiposIdentificacion,
+  Prioridades,
+} as const;
+
+/** Base Actividad Vulnerable models */
+export const Models = {
+  Client: MexActividadVulnerableClient,
+  Transaction: MexActividadVulnerableTransaction,
+  Report: MexActividadVulnerableReport,
+  ReportItem: MexActividadVulnerableReportItem,
+} as const;
+
+/** Base Actividad Vulnerable type guards */
+export const TypeGuards = {
+  isClient: isActividadVulnerable,
+  isTransaction: isActividadVulnerableTransaction,
+  isReport: isActividadVulnerableReport,
+  isReportItem: isActividadVulnerableReportItem,
+} as const;
+
+/** Actividad Vulnerable namespace */
+export const ActividadVulnerable = {
+  Enums,
+  Models,
+  TypeGuards,
+  AVI,
+  JYS,
+  TSC,
+} as const;
+
+export default ActividadVulnerable;

package/src/namespaces/mexico/actividad-vulnerable/jys/index.ts

@@ -0,0 +1,72 @@
+/**
+ * JYS (Juegos y Sorteos) namespace
+ */
+
+import { jys } from "@artu-ai/shared";
+import {
+  MexJYSClient,
+  MexJYSTransaction,
+  MexJYSReport,
+  MexJYSReportItem,
+  isMexJYSClient,
+  isMexJYSTransaction,
+  isMexJYSReport,
+  isMexJYSReportItem,
+} from "../../../../models";
+import {
+  JYSClientsResource,
+  JYSTransactionsResource,
+  JYSReportsResource,
+} from "../../../../resources";
+
+export const Enums = {
+  // Enum values
+  TipoOperacion: jys.TipoOperacion,
+  TipoAlerta: jys.TipoAlerta,
+  InstrumentoMonetario: jys.InstrumentoMonetario,
+  LineaNegocio: jys.LineaNegocio,
+  MedioOperacion: jys.MedioOperacion,
+  TipoBien: jys.TipoBien,
+  TipoInmueble: jys.TipoInmueble,
+  TipoLiquidacion: jys.TipoLiquidacion,
+  TipoSucursal: jys.TipoSucursal,
+  // Enum utilities (with .enum, .map, .codes, .options, .schema())
+  TiposOperacion: jys.TiposOperacion,
+  TiposAlerta: jys.TiposAlerta,
+  InstrumentosMonetarios: jys.InstrumentosMonetarios,
+  LineasNegocio: jys.LineasNegocio,
+  MediosOperacion: jys.MediosOperacion,
+  TiposBien: jys.TiposBien,
+  TiposInmueble: jys.TiposInmueble,
+  TiposLiquidacion: jys.TiposLiquidacion,
+  TiposSucursal: jys.TiposSucursal,
+} as const;
+
+export const Models = {
+  Client: MexJYSClient,
+  Transaction: MexJYSTransaction,
+  Report: MexJYSReport,
+  ReportItem: MexJYSReportItem,
+} as const;
+
+export const Resources = {
+  Clients: JYSClientsResource,
+  Transactions: JYSTransactionsResource,
+  Reports: JYSReportsResource,
+} as const;
+
+export const TypeGuards = {
+  isClient: isMexJYSClient,
+  isTransaction: isMexJYSTransaction,
+  isReport: isMexJYSReport,
+  isReportItem: isMexJYSReportItem,
+} as const;
+
+export const JYS = {
+  Enums,
+  Models,
+  Resources,
+  TypeGuards,
+} as const;
+
+export default JYS;

package/src/namespaces/mexico/actividad-vulnerable/tsc/index.ts

@@ -0,0 +1,60 @@
+/**
+ * TSC (Tarjetas de Servicio y Crédito) namespace
+ */
+
+import { tsc } from "@artu-ai/shared";
+import {
+  MexTSCClient,
+  MexTSCTransaction,
+  MexTSCReport,
+  MexTSCReportItem,
+  isMexTSCClient,
+  isMexTSCTransaction,
+  isMexTSCReport,
+  isMexTSCReportItem,
+} from "../../../../models";
+import {
+  TSCClientsResource,
+  TSCTransactionsResource,
+  TSCReportsResource,
+} from "../../../../resources";
+
+export const Enums = {
+  // Enum values
+  TipoOperacion: tsc.TipoOperacion,
+  TipoAlerta: tsc.TipoAlerta,
+  TipoTarjeta: tsc.TipoTarjeta,
+  // Enum utilities (with .enum, .map, .codes, .options, .schema())
+  TiposOperacion: tsc.TiposOperacion,
+  TiposAlerta: tsc.TiposAlerta,
+  TiposTarjeta: tsc.TiposTarjeta,
+} as const;
+
+export const Models = {
+  Client: MexTSCClient,
+  Transaction: MexTSCTransaction,
+  Report: MexTSCReport,
+  ReportItem: MexTSCReportItem,
+} as const;
+
+export const Resources = {
+  Clients: TSCClientsResource,
+  Transactions: TSCTransactionsResource,
+  Reports: TSCReportsResource,
+} as const;
+
+export const TypeGuards = {
+  isClient: isMexTSCClient,
+  isTransaction: isMexTSCTransaction,
+  isReport: isMexTSCReport,
+  isReportItem: isMexTSCReportItem,
+} as const;
+
+export const TSC = {
+  Enums,
+  Models,
+  Resources,
+  TypeGuards,
+} as const;
+
+export default TSC;