@artu-ai/compliance-sdk 0.0.6 → 0.2.0

package/src/exports/index.ts

@@ -0,0 +1,187 @@
+/**
+ * @artu/compliance-sdk
+ *
+ * TypeScript SDK for the Global Compliance API
+ *
+ * @example
+ * ```typescript
+ * import { ComplianceSDK, ClientType, Jurisdiction, Mexico } from "@artu/compliance-sdk";
+ *
+ * const sdk = new ComplianceSDK({
+ *   apiKey: process.env.COMPLIANCE_API_KEY!,
+ *   environment: "test",
+ * });
+ *
+ * // Create a client
+ * const client = await sdk.clients.create({
+ *   type: ClientType.Person,
+ *   name: "Juan García",
+ *   primaryJurisdiction: Jurisdiction.Mexico,
+ * });
+ *
+ * // List transactions
+ * for await (const txn of sdk.transactions.iterate()) {
+ *   console.log(txn.id, txn.amount);
+ * }
+ *
+ * // Access Mexico-specific functionality via namespace
+ * Mexico.Enums.ActividadEconomica
+ * Mexico.Validators.Rfc.validate("...")
+ * ```
+ */
+
+// ===========================
+// SDK
+// ===========================
+
+export {
+  ComplianceSDK,
+  type ComplianceSDKOptions,
+  type ComplianceSDKConstructor,
+  type SDKScope,
+  type UnscopedComplianceSDK,
+  type SessionInfo,
+} from "../sdk";
+
+// ===========================
+// Enums
+// ===========================
+
+export {
+  // Enum values
+  ClientType,
+  Jurisdiction,
+  AddressType,
+  ContactMethodType,
+  TransactionStatus,
+  DocumentStatus,
+  DocumentCategory,
+  ReportStatus,
+  BankAccountType,
+  ClientRole,
+  ClientRelationshipType,
+  Country,
+  Currency,
+  // Enum utilities (with .enum, .map, .codes, .options, .schema())
+  ClientTypes,
+  Jurisdictions,
+  AddressTypes,
+  ContactMethodTypes,
+  TransactionStatuses,
+  DocumentStatuses,
+  DocumentCategories,
+  ReportStatuses,
+  BankAccountTypes,
+  ClientRoles,
+  ClientRelationshipTypes,
+} from "@artu-ai/shared";
+
+// ===========================
+// Jurisdiction Namespaces
+// ===========================
+
+export { Mexico } from "../namespaces/mexico";
+
+// ===========================
+// Base Resources
+// ===========================
+
+export {
+  BaseResource,
+  ReadOnlyResource,
+  type ResourceConfig,
+  ClientsResource,
+  TransactionsResource,
+  type RelatedClient,
+  BankAccountsResource,
+  ReportsResource,
+  type ReportFilter,
+  type ReportItemFilter,
+  type AddItemsResult,
+  DocumentsResource,
+  type CreateDocumentResult,
+} from "../resources";
+
+// ===========================
+// Base Models
+// ===========================
+
+export {
+  BaseModel,
+  Client,
+  type ClientData,
+  Transaction,
+  type TransactionData,
+  Report,
+  type ReportData,
+  ReportItem,
+  type ReportItemData,
+  BankAccount,
+  type BankAccountData,
+  LinkedClient,
+  type LinkedClientData,
+  type ClientModel,
+  type TransactionModel,
+  type BankAccountModel,
+  type ReportModel,
+  type ReportItemModel,
+  isClient,
+  isIndividual,
+  isCompany,
+  isTrust,
+  isTransaction,
+  isBankAccount,
+  isReport,
+  isReportItem,
+  isLinkedClient,
+} from "../models";
+
+// ===========================
+// Schema Types (raw API types)
+// ===========================
+
+export type {
+  BaseClient,
+  Address as AddressSchema,
+  BaseTransaction,
+  Document as DocumentSchema,
+  ContactMethod as ContactMethodSchema,
+  Report as ReportSchema,
+  ReportItem as ReportItemSchema,
+  BankAccount as BankAccountSchema,
+  // Value types
+  CountryIso2,
+  CountryIso3,
+  CurrencyCode,
+} from "@artu-ai/shared";
+
+// ===========================
+// Scoped Types (base scope)
+// ===========================
+
+export type {
+  // Client types
+  CreateClientInput,
+  UpdateClientInput,
+  // Transaction types
+  CreateTransactionInput,
+  UpdateTransactionInput,
+  // Report types
+  CreateReportInput,
+  UpdateReportInput,
+  CreateReportItemInput,
+  ReportValidationError,
+  ValidationSummary,
+  ValidationResult,
+  GenerateResult,
+  SubmissionResult,
+  // Bank account types
+  CreateBankAccountInput,
+  UpdateBankAccountInput,
+} from "@artu-ai/shared";
+
+// ===========================
+// Base Exports (errors, utilities, etc.)
+// ===========================
+
+export * from "./base";

package/src/exports/mexico/actividad-vulnerable/avi.ts

@@ -0,0 +1,207 @@
+/**
+ * @artu/compliance-sdk/mexico/actividad-vulnerable/avi
+ *
+ * AVI (Activos Virtuales) scoped SDK entry point.
+ * Import from here for virtual asset compliance workflows.
+ *
+ * @example
+ * ```typescript
+ * import {
+ *   ComplianceSDK,
+ *   Enums,
+ *   Validators,
+ *   Models,
+ *   Resources,
+ *   TypeGuards,
+ * } from "@artu/compliance-sdk/mexico/actividad-vulnerable/avi";
+ *
+ * const sdk = new ComplianceSDK({
+ *   apiKey: process.env.COMPLIANCE_API_KEY!,
+ *   jurisdiction: "MX",
+ *   actividadVulnerable: "AVI",
+ * });
+ *
+ * // AVI-specific enums (flat, no nesting)
+ * Enums.TipoOperacion.Buy
+ * Enums.TipoAlerta.Inusual
+ *
+ * // Validators
+ * Validators.Rfc.validate("GOAP820528H00")
+ * ```
+ */
+
+import {
+  avi,
+  CodigoActividad,
+  CodigosActividad,
+  Moneda,
+  Monedas,
+  TipoIdentificacion,
+  TiposIdentificacion,
+  Prioridad,
+  Prioridades,
+  Rfc,
+  Curp,
+  Clabe,
+} from "@artu-ai/shared";
+
+import {
+  MexAVIClient,
+  MexAVITransaction,
+  MexAVIReport,
+  MexAVIReportItem,
+  isMexAVIClient,
+  isMexAVITransaction,
+  isMexAVIReport,
+  isMexAVIReportItem,
+  MexBankAccount,
+  type MexBankAccountData,
+} from "../../../models";
+
+import {
+  AVIClientsResource,
+  AVITransactionsResource,
+  AVIReportsResource,
+  MexBankAccountsResource,
+} from "../../../resources";
+
+// ===========================
+// SDK
+// ===========================
+
+import {
+  AVIComplianceSDKScoped,
+  type AVIScopedSDKOptions,
+} from "../../../sdk/mex/actividad-vulnerable/avi";
+
+/** Options for AVI-scoped SDK */
+export type ComplianceSDKOptions = AVIScopedSDKOptions;
+
+/** AVI-scoped ComplianceSDK - re-exported from sdk */
+export { AVIComplianceSDKScoped as ComplianceSDK };
+
+// ===========================
+// Enums (flat - AVI specific + Actividad Vulnerable base)
+// ===========================
+
+export const Enums = {
+  // AVI-specific enum values
+  TipoOperacion: avi.TipoOperacion,
+  TipoAlerta: avi.TipoAlerta,
+  InstrumentoMonetario: avi.InstrumentoMonetario,
+  ActivoVirtual: avi.ActivoVirtual,
+  // AVI-specific enum utilities
+  TiposOperacion: avi.TiposOperacion,
+  TiposAlerta: avi.TiposAlerta,
+  InstrumentosMonetarios: avi.InstrumentosMonetarios,
+  ActivosVirtuales: avi.ActivosVirtuales,
+  // Actividad Vulnerable base enum values
+  CodigoActividad,
+  Moneda,
+  TipoIdentificacion,
+  Prioridad,
+  // Actividad Vulnerable base enum utilities
+  CodigosActividad,
+  Monedas,
+  TiposIdentificacion,
+  Prioridades,
+} as const;
+
+// ===========================
+// Validators
+// ===========================
+
+export const Validators = {
+  Rfc,
+  Curp,
+  Clabe,
+} as const;
+
+// ===========================
+// Models (flat)
+// ===========================
+
+export const Models = {
+  Client: MexAVIClient,
+  Transaction: MexAVITransaction,
+  Report: MexAVIReport,
+  ReportItem: MexAVIReportItem,
+  BankAccount: MexBankAccount,
+} as const;
+
+export {
+  MexAVIClient as Client,
+  MexAVITransaction as Transaction,
+  MexAVIReport as Report,
+  MexAVIReportItem as ReportItem,
+  MexBankAccount as BankAccount,
+  type MexBankAccountData as BankAccountData,
+};
+
+// ===========================
+// Resources (scoped + base for non-scoped)
+// ===========================
+
+export const Resources = {
+  Clients: AVIClientsResource,
+  Transactions: AVITransactionsResource,
+  Reports: AVIReportsResource,
+  BankAccounts: MexBankAccountsResource,
+} as const;
+
+export {
+  AVIClientsResource as ClientsResource,
+  AVITransactionsResource as TransactionsResource,
+  AVIReportsResource as ReportsResource,
+  MexBankAccountsResource as BankAccountsResource,
+};
+
+// ===========================
+// TypeGuards (flat)
+// ===========================
+
+export const TypeGuards = {
+  isClient: isMexAVIClient,
+  isTransaction: isMexAVITransaction,
+  isReport: isMexAVIReport,
+  isReportItem: isMexAVIReportItem,
+} as const;
+
+export {
+  isMexAVIClient as isClient,
+  isMexAVITransaction as isTransaction,
+  isMexAVIReport as isReport,
+  isMexAVIReportItem as isReportItem,
+};
+
+// ===========================
+// Scoped Types (AVI) - aliased for convenience
+// ===========================
+
+export type {
+  // Client types
+  CreateAVIClientInput as CreateClientInput,
+  UpdateAVIClientInput as UpdateClientInput,
+  // Transaction types
+  CreateAVITransactionInput as CreateTransactionInput,
+  UpdateAVITransactionInput as UpdateTransactionInput,
+  // Report types
+  CreateAVIReportInput as CreateReportInput,
+  UpdateAVIReportInput as UpdateReportInput,
+  CreateAVIReportItemInput as CreateReportItemInput,
+  UpdateAVIReportItemInput as UpdateReportItemInput,
+  ReportValidationError,
+  ValidationSummary,
+  ValidationResult,
+  GenerateResult,
+  SubmissionResult,
+  // Bank account types (uses Mexico scope)
+  CreateMexBankAccountInput as CreateBankAccountInput,
+  UpdateMexBankAccountInput as UpdateBankAccountInput,
+} from "@artu-ai/shared";
+
+// ===========================
+// Base Exports (errors, utilities, base models/resources)
+// ===========================
+
+export * from "../../base";

package/src/exports/mexico/actividad-vulnerable/jys.ts

@@ -0,0 +1,214 @@
+/**
+ * @artu/compliance-sdk/mexico/actividad-vulnerable/jys
+ *
+ * JYS (Juegos y Sorteos) scoped SDK entry point.
+ * Import from here for gaming and lottery compliance workflows.
+ *
+ * @example
+ * ```typescript
+ * import {
+ *   ComplianceSDK,
+ *   Enums,
+ *   Validators,
+ *   Models,
+ *   Resources,
+ *   TypeGuards,
+ * } from "@artu/compliance-sdk/mexico/actividad-vulnerable/jys";
+ *
+ * const sdk = new ComplianceSDK({
+ *   apiKey: process.env.COMPLIANCE_API_KEY!,
+ *   jurisdiction: "MX",
+ *   actividadVulnerable: "JYS",
+ * });
+ *
+ * // JYS-specific enums (flat, no nesting)
+ * Enums.TipoOperacion.TicketSale
+ * Enums.TipoBien.Inmueble
+ * ```
+ */
+
+import {
+  jys,
+  CodigoActividad,
+  CodigosActividad,
+  Moneda,
+  Monedas,
+  TipoIdentificacion,
+  TiposIdentificacion,
+  Prioridad,
+  Prioridades,
+  Rfc,
+  Curp,
+  Clabe,
+} from "@artu-ai/shared";
+
+import {
+  MexJYSClient,
+  MexJYSTransaction,
+  MexJYSReport,
+  MexJYSReportItem,
+  isMexJYSClient,
+  isMexJYSTransaction,
+  isMexJYSReport,
+  isMexJYSReportItem,
+  MexBankAccount,
+  type MexBankAccountData,
+} from "../../../models";
+
+import {
+  JYSClientsResource,
+  JYSTransactionsResource,
+  JYSReportsResource,
+  MexBankAccountsResource,
+} from "../../../resources";
+
+// ===========================
+// SDK
+// ===========================
+
+import {
+  JYSComplianceSDKScoped,
+  type JYSScopedSDKOptions,
+} from "../../../sdk/mex/actividad-vulnerable/jys";
+
+/** Options for JYS-scoped SDK */
+export type ComplianceSDKOptions = JYSScopedSDKOptions;
+
+/** JYS-scoped ComplianceSDK - re-exported from sdk */
+export { JYSComplianceSDKScoped as ComplianceSDK };
+
+// ===========================
+// Enums (flat - JYS specific + Actividad Vulnerable base)
+// ===========================
+
+export const Enums = {
+  // JYS-specific 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,
+  // JYS-specific enum utilities
+  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,
+  // Actividad Vulnerable base enum values
+  CodigoActividad,
+  Moneda,
+  TipoIdentificacion,
+  Prioridad,
+  // Actividad Vulnerable base enum utilities
+  CodigosActividad,
+  Monedas,
+  TiposIdentificacion,
+  Prioridades,
+} as const;
+
+// ===========================
+// Validators
+// ===========================
+
+export const Validators = {
+  Rfc,
+  Curp,
+  Clabe,
+} as const;
+
+// ===========================
+// Models (flat)
+// ===========================
+
+export const Models = {
+  Client: MexJYSClient,
+  Transaction: MexJYSTransaction,
+  Report: MexJYSReport,
+  ReportItem: MexJYSReportItem,
+  BankAccount: MexBankAccount,
+} as const;
+
+export {
+  MexJYSClient as Client,
+  MexJYSTransaction as Transaction,
+  MexJYSReport as Report,
+  MexJYSReportItem as ReportItem,
+  MexBankAccount as BankAccount,
+  type MexBankAccountData as BankAccountData,
+};
+
+// ===========================
+// Resources (scoped + base for non-scoped)
+// ===========================
+
+export const Resources = {
+  Clients: JYSClientsResource,
+  Transactions: JYSTransactionsResource,
+  Reports: JYSReportsResource,
+  BankAccounts: MexBankAccountsResource,
+} as const;
+
+export {
+  JYSClientsResource as ClientsResource,
+  JYSTransactionsResource as TransactionsResource,
+  JYSReportsResource as ReportsResource,
+  MexBankAccountsResource as BankAccountsResource,
+};
+
+// ===========================
+// TypeGuards (flat)
+// ===========================
+
+export const TypeGuards = {
+  isClient: isMexJYSClient,
+  isTransaction: isMexJYSTransaction,
+  isReport: isMexJYSReport,
+  isReportItem: isMexJYSReportItem,
+} as const;
+
+export {
+  isMexJYSClient as isClient,
+  isMexJYSTransaction as isTransaction,
+  isMexJYSReport as isReport,
+  isMexJYSReportItem as isReportItem,
+};
+
+// ===========================
+// Scoped Types (JYS) - aliased for convenience
+// ===========================
+
+export type {
+  // Client types
+  CreateJYSClientInput as CreateClientInput,
+  UpdateJYSClientInput as UpdateClientInput,
+  // Transaction types
+  CreateJYSTransactionInput as CreateTransactionInput,
+  UpdateJYSTransactionInput as UpdateTransactionInput,
+  // Report types
+  CreateJYSReportInput as CreateReportInput,
+  UpdateJYSReportInput as UpdateReportInput,
+  CreateJYSReportItemInput as CreateReportItemInput,
+  UpdateJYSReportItemInput as UpdateReportItemInput,
+  ReportValidationError,
+  ValidationSummary,
+  ValidationResult,
+  GenerateResult,
+  SubmissionResult,
+  // Bank account types (uses Mexico scope)
+  CreateMexBankAccountInput as CreateBankAccountInput,
+  UpdateMexBankAccountInput as UpdateBankAccountInput,
+} from "@artu-ai/shared";
+
+// ===========================
+// Base Exports (errors, utilities, base models/resources)
+// ===========================
+
+export * from "../../base";