@artu-ai/compliance-sdk 0.4.1 → 0.4.2

package/src/exports/mexico/index.ts

@@ -1,215 +0,0 @@
-/**
- * @artu/compliance-sdk/mexico
- *
- * Mexico-scoped SDK entry point.
- * Import from here for Mexico-specific compliance workflows.
- *
- * @example
- * ```typescript
- * import {
- *   ComplianceSDK,
- *   ActividadVulnerable,
- *   Enums,
- *   Validators,
- *   Models,
- *   Resources,
- *   TypeGuards,
- * } from "@artu/compliance-sdk/mexico";
- *
- * const sdk = new ComplianceSDK({
- *   apiKey: process.env.COMPLIANCE_API_KEY!,
- *   jurisdiction: "MX",
- * });
- *
- * // Access Mexico-specific enums directly
- * Enums.ActividadEconomica.Comercio
- * Enums.DocumentType.INE
- *
- * // Validate Mexican identifiers
- * Validators.Rfc.validate("GOAP820528H00")
- *
- * // Actividad Vulnerable namespace for AML compliance
- * ActividadVulnerable.AVI.Enums.TipoOperacion.Buy
- * ```
- */
-
-// ===========================
-// SDK
-// ===========================
-
-import {
-  MexicoComplianceSDKScoped,
-  type MexicoScopedSDKOptions,
-} from "../../sdk/mex";
-
-/** Options for Mexico-scoped SDK */
-export type ComplianceSDKOptions = MexicoScopedSDKOptions;
-
-/** Mexico-scoped ComplianceSDK - re-exported from sdk */
-export { MexicoComplianceSDKScoped as ComplianceSDK };
-
-// ===========================
-// Mexico Namespace Contents (flat exports)
-// ===========================
-
-export {
-  Enums,
-  Validators,
-  Models,
-  Resources,
-  TypeGuards,
-  type Types,
-} from "../../namespaces/mexico";
-
-// ===========================
-// Actividad Vulnerable Namespace
-// ===========================
-
-export { ActividadVulnerable, AVI, JYS, TSC } from "../../namespaces/mexico";
-
-// ===========================
-// Types
-// ===========================
-
-export type {
-  MexJurisdictionData,
-  MexPersonJurisdictionData,
-  MexCompanyJurisdictionData,
-  MexTrustJurisdictionData,
-  ActividadVulnerableClientData,
-  MexBankAccountData,
-  MexDocument,
-  CreateMexDocumentInput,
-  UpdateMexDocumentInput,
-  // Document field types
-  IneFrontFields,
-  IneBackFields,
-  CurpDocumentFields,
-  RfcConstanciaFields,
-  AddressProofFields,
-  ActaConstitutivaFields,
-  PoderNotarialFields,
-  // Create input types per document type
-  CreateMexIneFrontInput,
-  CreateMexIneBackInput,
-  CreateMexPassportInput,
-  CreateMexCurpInput,
-  CreateMexRfcConstanciaInput,
-  CreateMexAddressProofInput,
-  CreateMexActaConstitutivaInput,
-  CreateMexPoderNotarialInput,
-  // Update input types per document type
-  UpdateMexIneFrontInput,
-  UpdateMexIneBackInput,
-  UpdateMexPassportInput,
-  UpdateMexCurpInput,
-  UpdateMexRfcConstanciaInput,
-  UpdateMexAddressProofInput,
-  UpdateMexActaConstitutivaInput,
-  UpdateMexPoderNotarialInput,
-} from "../../namespaces/mexico";
-
-// ===========================
-// Models (Mexico scoped) - direct exports
-// ===========================
-
-export {
-  MexClient as Client,
-  MexTransaction as Transaction,
-  MexBankAccount as BankAccount,
-  MexAddress as Address,
-  MexReport as Report,
-  MexReportItem as ReportItem,
-  // Document models
-  MexDocument as Document,
-  MexIneFrontDocument as IneFrontDocument,
-  MexIneBackDocument as IneBackDocument,
-  MexPassportDocument as PassportDocument,
-  MexCurpDocument as CurpDocument,
-  MexRfcConstanciaDocument as RfcConstanciaDocument,
-  MexAddressProofDocument as AddressProofDocument,
-  MexActaConstitutivaDocument as ActaConstitutivaDocument,
-  MexPoderNotarialDocument as PoderNotarialDocument,
-  // Types
-  type MexClientData as ClientData,
-  type MexTransactionData as TransactionData,
-  type MexBankAccountData as BankAccountData,
-  type MexAddressData as AddressData,
-  type MexReportData as ReportData,
-  type MexReportItemData as ReportItemData,
-} from "../../models";
-
-// ===========================
-// Resources (Mexico scoped) - direct exports
-// ===========================
-
-export {
-  MexClientsResource as ClientsResource,
-  MexTransactionsResource as TransactionsResource,
-  MexBankAccountsResource as BankAccountsResource,
-  MexReportsResource as ReportsResource,
-  // EBR (Evaluación Basada en Riesgos) resource
-  EBRResource,
-  type EBRResourceContext,
-  type EBRPresetsResource,
-  type EBRWeightsResource,
-  type EBRThresholdsResource,
-  type EBRRiskLevelResource,
-  type WeightPreset,
-  type PresetConfidence,
-} from "../../resources";
-
-// ===========================
-// TypeGuards (Mexico scoped) - direct exports
-// ===========================
-
-export {
-  isMexClient as isClient,
-  isMexTransaction as isTransaction,
-  isMexBankAccount as isBankAccount,
-  isMexAddress as isAddress,
-  isMexReport as isReport,
-  isMexReportItem as isReportItem,
-  // Document guards
-  isMexDocument as isDocument,
-  isMexIneFront as isIneFront,
-  isMexIneBack as isIneBack,
-  isMexPassport as isPassport,
-  isMexCurp as isCurp,
-  isMexRfcConstancia as isRfcConstancia,
-  isMexAddressProof as isAddressProof,
-  isMexActaConstitutiva as isActaConstitutiva,
-  isMexPoderNotarial as isPoderNotarial,
-} from "../../models";
-
-// ===========================
-// Scoped Types (Mexico) - aliased for convenience
-// ===========================
-
-export type {
-  // Client types
-  CreateMexClientInput as CreateClientInput,
-  UpdateMexClientInput as UpdateClientInput,
-  // Transaction types
-  CreateMexTransactionInput as CreateTransactionInput,
-  UpdateMexTransactionInput as UpdateTransactionInput,
-  // Report types
-  CreateMexReportInput as CreateReportInput,
-  UpdateMexReportInput as UpdateReportInput,
-  CreateMexReportItemInput as CreateReportItemInput,
-  UpdateMexReportItemInput as UpdateReportItemInput,
-  ReportValidationError,
-  ValidationSummary,
-  ValidationResult,
-  GenerateResult,
-  SubmissionResult,
-  // Bank account types
-  CreateMexBankAccountInput as CreateBankAccountInput,
-  UpdateMexBankAccountInput as UpdateBankAccountInput,
-} from "@artu-ai/shared";
-
-// ===========================
-// Base Exports (errors, utilities, base models/resources)
-// ===========================
-
-export * from "../base";

package/src/models/Address.ts

@@ -1,235 +0,0 @@
-/**
- * Address Model
- *
- * Physical or mailing address for a client.
- */
-
-import {
-  AddressType,
-  type Address as AddressSchema,
-  type CountryIso2,
-} from "@artu-ai/shared";
-import { BaseModel } from "./base";
-
-// ===========================
-// Types
-// ===========================
-
-/**
- * Address data structure from the API
- */
-export interface AddressData extends AddressSchema {
-  id: string;
-  createdAt: string;
-  updatedAt: string;
-}
-
-// ===========================
-// Address Model
-// ===========================
-
-/**
- * Address Model.
- *
- * Provides typed accessors for address data with formatting helpers.
- *
- * @example
- * ```typescript
- * const addresses = await sdk.addresses.listByClient("client_123");
- * for (const addr of addresses) {
- *   console.log(addr.formatted);
- *   console.log(`Primary: ${addr.isPrimary}`);
- * }
- * ```
- */
-export class Address extends BaseModel<AddressData> {
-  // ─────────────────────────────────────────────────────────────────
-  // Core Properties
-  // ─────────────────────────────────────────────────────────────────
-
-  /**
-   * Unique address identifier
-   */
-  get id(): string {
-    return this._data.id;
-  }
-
-  /**
-   * ID of the client this address belongs to
-   */
-  get clientId(): string {
-    return this._data.clientId;
-  }
-
-  /**
-   * Address type (home, business, mailing, legal, other)
-   */
-  get type(): AddressType {
-    return this._data.type;
-  }
-
-  /**
-   * Whether this is the primary address
-   */
-  get isPrimary(): boolean {
-    return this._data.isPrimary ?? false;
-  }
-
-  // ─────────────────────────────────────────────────────────────────
-  // Address Fields
-  // ─────────────────────────────────────────────────────────────────
-
-  /**
-   * Street address line
-   */
-  get street(): string {
-    return this._data.street;
-  }
-
-  /**
-   * City name
-   */
-  get city(): string {
-    return this._data.city;
-  }
-
-  /**
-   * State or province
-   */
-  get state(): string {
-    return this._data.state;
-  }
-
-  /**
-   * Postal/ZIP code
-   */
-  get postalCode(): string {
-    return this._data.postalCode;
-  }
-
-  /**
-   * Country code (ISO 3166-1 alpha-2)
-   */
-  get country(): CountryIso2 {
-    return this._data.country;
-  }
-
-  // ─────────────────────────────────────────────────────────────────
-  // Jurisdictions & Metadata
-  // ─────────────────────────────────────────────────────────────────
-
-  /**
-   * Jurisdiction-scoped data
-   * (e.g., Mexico: exteriorNumber, neighborhood)
-   */
-  get jurisdictions(): AddressSchema["jurisdictions"] {
-    return this._data.jurisdictions;
-  }
-
-  /**
-   * External ID
-   */
-  get externalId(): string | undefined {
-    return this._data.externalId;
-  }
-
-  /**
-   * Additional metadata
-   */
-  get metadata(): Record<string, unknown> | undefined {
-    return this._data.metadata;
-  }
-
-  /**
-   * When the address was created
-   */
-  get createdAt(): Date {
-    return new Date(this._data.createdAt);
-  }
-
-  /**
-   * When the address was last updated
-   */
-  get updatedAt(): Date {
-    return new Date(this._data.updatedAt);
-  }
-
-  // ─────────────────────────────────────────────────────────────────
-  // Type Helpers
-  // ─────────────────────────────────────────────────────────────────
-
-  /**
-   * Whether this is a home address
-   */
-  get isHome(): boolean {
-    return this.type === AddressType.Home;
-  }
-
-  /**
-   * Whether this is a business address
-   */
-  get isBusiness(): boolean {
-    return this.type === AddressType.Business;
-  }
-
-  /**
-   * Whether this is a mailing address
-   */
-  get isMailing(): boolean {
-    return this.type === AddressType.Mailing;
-  }
-
-  /**
-   * Whether this is a legal address
-   */
-  get isLegal(): boolean {
-    return this.type === AddressType.Legal;
-  }
-
-  // ─────────────────────────────────────────────────────────────────
-  // Formatting
-  // ─────────────────────────────────────────────────────────────────
-
-  /**
-   * Returns a formatted single-line address string
-   */
-  get formatted(): string {
-    const parts = [
-      this.street,
-      `${this.city}, ${this.state} ${this.postalCode}`,
-      this.country,
-    ].filter(Boolean);
-    return parts.join(", ");
-  }
-
-  /**
-   * Returns a formatted multi-line address string
-   */
-  get formattedMultiLine(): string {
-    const lines = [
-      this.street,
-      `${this.city}, ${this.state} ${this.postalCode}`,
-      this.country,
-    ].filter(Boolean);
-    return lines.join("\n");
-  }
-
-  // ─────────────────────────────────────────────────────────────────
-  // String Representation
-  // ─────────────────────────────────────────────────────────────────
-
-  override toString(): string {
-    return `Address(${this.id}, ${this.type}, ${this.city})`;
-  }
-}
-
-// ===========================
-// Type Guards
-// ===========================
-
-/**
- * Check if value is any type of Address model
- */
-export function isAddress(value: unknown): value is Address {
-  return value instanceof Address;
-}

package/src/models/BankAccount.ts

@@ -1,235 +0,0 @@
-/**
- * BankAccount Model
- *
- * Bank account information for a client.
- * Uses discriminated union based on `country` field.
- */
-
-import {
-  BankAccountType,
-  type BankAccount as BankAccountSchema,
-  type CurrencyCode,
-} from "@artu-ai/shared";
-import { BaseModel } from "./base";
-
-// ===========================
-// Types
-// ===========================
-
-/**
- * Bank account data structure from the API (discriminated union)
- */
-export type BankAccountData = BankAccountSchema;
-
-// ===========================
-// BankAccount Model
-// ===========================
-
-/**
- * BankAccount Model.
- *
- * Base class for bank account data. The concrete type depends on
- * the `country` field:
- * - `country === "MX"` → MexBankAccount with clabe, codigoBanco, codigoPlaza
- * - Other countries → GenericBankAccount
- *
- * @example
- * ```typescript
- * const account = await sdk.bankAccounts.retrieve(id);
- *
- * // Check country for type narrowing
- * if (account.country === "MX") {
- *   console.log(account.clabe); // MexBankAccount
- * }
- * ```
- */
-export class BankAccount extends BaseModel<BankAccountData> {
-  // ─────────────────────────────────────────────────────────────────
-  // Core Properties
-  // ─────────────────────────────────────────────────────────────────
-
-  /**
-   * Unique bank account identifier
-   */
-  get id(): string {
-    return this._data.id;
-  }
-
-  /**
-   * ID of the client this bank account belongs to
-   */
-  get clientId(): string {
-    return this._data.clientId;
-  }
-
-  /**
-   * Account number
-   */
-  get accountNumber(): string {
-    return this._data.accountNumber;
-  }
-
-  /**
-   * Bank name
-   */
-  get bankName(): string {
-    return this._data.bankName;
-  }
-
-  /**
-   * Bank code (e.g., SWIFT, routing number)
-   */
-  get bankCode(): string | undefined {
-    return this._data.bankCode;
-  }
-
-  /**
-   * Country where the bank account is held (ISO 3166-1 alpha-2)
-   *
-   * This is the discriminator field - determines which fields are available.
-   */
-  get country(): string {
-    return this._data.country;
-  }
-
-  /**
-   * Account type (checking, savings, investment, other)
-   */
-  get type(): BankAccountType {
-    return this._data.type;
-  }
-
-  /**
-   * Account currency (ISO 4217 code)
-   */
-  get currency(): CurrencyCode {
-    return this._data.currency;
-  }
-
-  // ─────────────────────────────────────────────────────────────────
-  // Status
-  // ─────────────────────────────────────────────────────────────────
-
-  /**
-   * Whether this is the primary bank account
-   */
-  get isPrimary(): boolean {
-    return this._data.isPrimary ?? false;
-  }
-
-  /**
-   * Whether this account is active
-   */
-  get isActive(): boolean {
-    return this._data.isActive ?? true;
-  }
-
-  // ─────────────────────────────────────────────────────────────────
-  // Metadata
-  // ─────────────────────────────────────────────────────────────────
-
-  /**
-   * Optional label (e.g., "Personal Checking")
-   */
-  get label(): string | undefined {
-    return this._data.label;
-  }
-
-  /**
-   * External ID
-   */
-  get externalId(): string | undefined {
-    return this._data.externalId;
-  }
-
-  /**
-   * Additional metadata
-   */
-  get metadata(): Record<string, unknown> | undefined {
-    return this._data.metadata;
-  }
-
-  /**
-   * When the bank account was created
-   */
-  get createdAt(): Date {
-    return new Date(this._data.createdAt);
-  }
-
-  /**
-   * When the bank account was last updated
-   */
-  get updatedAt(): Date {
-    return new Date(this._data.updatedAt);
-  }
-
-  // ─────────────────────────────────────────────────────────────────
-  // Type Helpers
-  // ─────────────────────────────────────────────────────────────────
-
-  /**
-   * Whether this is a checking account
-   */
-  get isChecking(): boolean {
-    return this.type === BankAccountType.Checking;
-  }
-
-  /**
-   * Whether this is a savings account
-   */
-  get isSavings(): boolean {
-    return this.type === BankAccountType.Savings;
-  }
-
-  /**
-   * Whether this is an investment account
-   */
-  get isInvestment(): boolean {
-    return this.type === BankAccountType.Investment;
-  }
-
-  /**
-   * Whether this is a Mexican bank account
-   */
-  get isMexican(): boolean {
-    return this.country === "MX";
-  }
-
-  // ─────────────────────────────────────────────────────────────────
-  // Formatting
-  // ─────────────────────────────────────────────────────────────────
-
-  /**
-   * Returns a masked account number (shows last 4 digits)
-   */
-  get maskedAccountNumber(): string {
-    const lastFour = this.accountNumber.slice(-4);
-    return `****${lastFour}`;
-  }
-
-  /**
-   * Returns a display string with bank name and masked account
-   */
-  get display(): string {
-    return `${this.bankName} (${this.maskedAccountNumber})`;
-  }
-
-  // ─────────────────────────────────────────────────────────────────
-  // String Representation
-  // ─────────────────────────────────────────────────────────────────
-
-  override toString(): string {
-    return `BankAccount(${this.id}, ${this.bankName}, ${this.country})`;
-  }
-}
-
-// ===========================
-// Type Guards
-// ===========================
-
-/**
- * Check if value is any type of BankAccount model
- */
-export function isBankAccount(value: unknown): value is BankAccount {
-  return value instanceof BankAccount;
-}