@artu-ai/compliance-sdk 0.0.6 → 0.3.0

package/dist/models/mex/MexDocument.js

@@ -0,0 +1,687 @@
+/**
+ * Mexico Document Models
+ *
+ * Type-specific document models with typed field accessors.
+ * Provides helpers for accessing extracted document data.
+ */
+import { Document } from "../Document";
+import { MexDocumentType, } from "@artu-ai/shared";
+// ─────────────────────────────────────────────────────────────────
+// Base Mexico Document
+// ─────────────────────────────────────────────────────────────────
+/**
+ * Mexico document model - base class for all Mexico documents
+ */
+export class MexDocument extends Document {
+    /**
+     * Mexico document type
+     */
+    get type() {
+        return this._data.type;
+    }
+    /**
+     * Document fields - typed as union of all Mexico document field types
+     *
+     * For specific field types, use type-specific document classes:
+     * - MexIneFrontDocument.ineFields
+     * - MexPassportDocument.passportFields
+     * - etc.
+     */
+    get fields() {
+        return this._data.fields;
+    }
+    /**
+     * Check if this is an INE front document
+     */
+    get isIneFront() {
+        return this.type === MexDocumentType.IneFront;
+    }
+    /**
+     * Check if this is an INE back document
+     */
+    get isIneBack() {
+        return this.type === MexDocumentType.IneBack;
+    }
+    /**
+     * Check if this is a passport document
+     */
+    get isPassport() {
+        return this.type === MexDocumentType.Passport;
+    }
+    /**
+     * Check if this is a CURP document
+     */
+    get isCurp() {
+        return this.type === MexDocumentType.Curp;
+    }
+    /**
+     * Check if this is an RFC constancia document
+     */
+    get isRfcConstancia() {
+        return this.type === MexDocumentType.RfcConstancia;
+    }
+    /**
+     * Check if this is an address proof document
+     */
+    get isAddressProof() {
+        return this.type === MexDocumentType.AddressProof;
+    }
+    /**
+     * Check if this is an acta constitutiva document
+     */
+    get isActaConstitutiva() {
+        return this.type === MexDocumentType.ActaConstitutiva;
+    }
+    /**
+     * Check if this is a poder notarial document
+     */
+    get isPoderNotarial() {
+        return this.type === MexDocumentType.PoderNotarial;
+    }
+}
+// ─────────────────────────────────────────────────────────────────
+// INE Front Document
+// ─────────────────────────────────────────────────────────────────
+/**
+ * INE Front document model with typed field accessors
+ *
+ * @example
+ * ```typescript
+ * const doc = await sdk.mex.documents.retrieve(id) as MexIneFrontDocument;
+ *
+ * if (doc.isIneFront) {
+ *   console.log(doc.claveElector);  // Typed accessor
+ *   console.log(doc.curp);
+ *   console.log(doc.fullName);
+ * }
+ * ```
+ */
+export class MexIneFrontDocument extends MexDocument {
+    /**
+     * Typed INE front fields
+     */
+    get ineFields() {
+        return this.fields;
+    }
+    /** Voter ID number (Clave de Elector) */
+    get claveElector() {
+        return this.ineFields?.claveElector;
+    }
+    /** CURP */
+    get curp() {
+        return this.ineFields?.curp;
+    }
+    /** Full name as shown on INE */
+    get fullName() {
+        return this.ineFields?.fullName;
+    }
+    /** Paternal surname */
+    get paternalSurname() {
+        return this.ineFields?.paternalSurname;
+    }
+    /** Maternal surname */
+    get maternalSurname() {
+        return this.ineFields?.maternalSurname;
+    }
+    /** Given name(s) */
+    get givenNames() {
+        return this.ineFields?.givenNames;
+    }
+    /** Date of birth */
+    get dateOfBirth() {
+        const val = this.ineFields?.dateOfBirth;
+        return val ? new Date(val) : undefined;
+    }
+    /** Gender (H = Hombre, M = Mujer) */
+    get gender() {
+        return this.ineFields?.gender;
+    }
+    /** State of birth */
+    get birthState() {
+        return this.ineFields?.birthState;
+    }
+    /** Electoral section */
+    get section() {
+        return this.ineFields?.section;
+    }
+    /** Registration year */
+    get registrationYear() {
+        return this.ineFields?.registrationYear;
+    }
+    /** Expiration year */
+    get expirationYear() {
+        return this.ineFields?.expirationYear;
+    }
+    /** Full address from INE */
+    get address() {
+        return {
+            street: this.ineFields?.street,
+            exteriorNumber: this.ineFields?.exteriorNumber,
+            interiorNumber: this.ineFields?.interiorNumber,
+            neighborhood: this.ineFields?.neighborhood,
+            municipality: this.ineFields?.municipality,
+            state: this.ineFields?.state,
+            postalCode: this.ineFields?.postalCode,
+        };
+    }
+}
+// ─────────────────────────────────────────────────────────────────
+// INE Back Document
+// ─────────────────────────────────────────────────────────────────
+/**
+ * INE Back document model with typed field accessors
+ */
+export class MexIneBackDocument extends MexDocument {
+    /**
+     * Typed INE back fields
+     */
+    get ineBackFields() {
+        return this.fields;
+    }
+    /** OCR number */
+    get ocrNumber() {
+        return this.ineBackFields?.ocrNumber;
+    }
+    /** CIC number */
+    get cicNumber() {
+        return this.ineBackFields?.cicNumber;
+    }
+    /** Citizen ID (9 digits) */
+    get citizenId() {
+        return this.ineBackFields?.citizenId;
+    }
+    /** MRZ lines (Machine Readable Zone) */
+    get mrz() {
+        return {
+            line1: this.ineBackFields?.mrzLine1,
+            line2: this.ineBackFields?.mrzLine2,
+            line3: this.ineBackFields?.mrzLine3,
+        };
+    }
+}
+// ─────────────────────────────────────────────────────────────────
+// Passport Document
+// ─────────────────────────────────────────────────────────────────
+/**
+ * Passport document model with typed field accessors
+ */
+export class MexPassportDocument extends MexDocument {
+    /**
+     * Typed passport fields
+     */
+    get passportFields() {
+        return this.fields;
+    }
+    /** Passport number */
+    get passportNumber() {
+        return this.passportFields?.passportNumber;
+    }
+    /** Issuing country */
+    get issuingCountry() {
+        return this.passportFields?.issuingCountry;
+    }
+    /** Nationality */
+    get nationality() {
+        return this.passportFields?.nationality;
+    }
+    /** Full name as shown on passport */
+    get fullName() {
+        return this.passportFields?.fullName;
+    }
+    /** Given name(s) */
+    get givenNames() {
+        return this.passportFields?.givenNames;
+    }
+    /** Surname(s) */
+    get surnames() {
+        return this.passportFields?.surnames;
+    }
+    /** Date of birth */
+    get dateOfBirth() {
+        const val = this.passportFields?.dateOfBirth;
+        return val ? new Date(val) : undefined;
+    }
+    /** Place of birth */
+    get placeOfBirth() {
+        return this.passportFields?.placeOfBirth;
+    }
+    /** Gender */
+    get gender() {
+        return this.passportFields?.gender;
+    }
+    /** Issue date */
+    get issueDate() {
+        const val = this.passportFields?.issueDate;
+        return val ? new Date(val) : undefined;
+    }
+    /** Expiration date */
+    get passportExpirationDate() {
+        const val = this.passportFields?.expirationDate;
+        return val ? new Date(val) : undefined;
+    }
+    /** MRZ lines */
+    get mrz() {
+        return {
+            line1: this.passportFields?.mrzLine1,
+            line2: this.passportFields?.mrzLine2,
+        };
+    }
+}
+// ─────────────────────────────────────────────────────────────────
+// CURP Document
+// ─────────────────────────────────────────────────────────────────
+/**
+ * CURP document model with typed field accessors
+ */
+export class MexCurpDocument extends MexDocument {
+    /**
+     * Typed CURP fields
+     */
+    get curpFields() {
+        return this.fields;
+    }
+    /** CURP (18 character ID) */
+    get curp() {
+        return this.curpFields?.curp;
+    }
+    /** Full name */
+    get fullName() {
+        return this.curpFields?.fullName;
+    }
+    /** Paternal surname */
+    get paternalSurname() {
+        return this.curpFields?.paternalSurname;
+    }
+    /** Maternal surname */
+    get maternalSurname() {
+        return this.curpFields?.maternalSurname;
+    }
+    /** Given name(s) */
+    get givenNames() {
+        return this.curpFields?.givenNames;
+    }
+    /** Date of birth */
+    get dateOfBirth() {
+        const val = this.curpFields?.dateOfBirth;
+        return val ? new Date(val) : undefined;
+    }
+    /** Gender */
+    get gender() {
+        return this.curpFields?.gender;
+    }
+    /** State of birth */
+    get birthState() {
+        return this.curpFields?.birthState;
+    }
+    /** Verification URL */
+    get verificationUrl() {
+        return this.curpFields?.verificationUrl;
+    }
+}
+// ─────────────────────────────────────────────────────────────────
+// RFC Constancia Document
+// ─────────────────────────────────────────────────────────────────
+/**
+ * RFC Constancia document model with typed field accessors
+ */
+export class MexRfcConstanciaDocument extends MexDocument {
+    /**
+     * Typed RFC fields
+     */
+    get rfcFields() {
+        return this.fields;
+    }
+    /** RFC (tax ID) */
+    get rfc() {
+        return this.rfcFields?.rfc;
+    }
+    /** Full name or business name */
+    get fullName() {
+        return this.rfcFields?.fullName;
+    }
+    /** CURP (for individuals) */
+    get curp() {
+        return this.rfcFields?.curp;
+    }
+    /** Tax regime(s) */
+    get taxRegimes() {
+        return this.rfcFields?.taxRegimes;
+    }
+    /** Economic activities */
+    get economicActivities() {
+        return this.rfcFields?.economicActivities;
+    }
+    /** Tax obligations */
+    get taxObligations() {
+        return this.rfcFields?.taxObligations;
+    }
+    /** Registration date */
+    get registrationDate() {
+        const val = this.rfcFields?.registrationDate;
+        return val ? new Date(val) : undefined;
+    }
+    /** Registered address */
+    get address() {
+        return {
+            street: this.rfcFields?.street,
+            exteriorNumber: this.rfcFields?.exteriorNumber,
+            interiorNumber: this.rfcFields?.interiorNumber,
+            neighborhood: this.rfcFields?.neighborhood,
+            municipality: this.rfcFields?.municipality,
+            state: this.rfcFields?.state,
+            postalCode: this.rfcFields?.postalCode,
+        };
+    }
+}
+// ─────────────────────────────────────────────────────────────────
+// Address Proof Document
+// ─────────────────────────────────────────────────────────────────
+/**
+ * Address proof document model with typed field accessors
+ * (Comprobante de Domicilio, Recibo de Luz/Agua, Estado de Cuenta)
+ */
+export class MexAddressProofDocument extends MexDocument {
+    /**
+     * Typed address proof fields
+     */
+    get addressProofFields() {
+        return this.fields;
+    }
+    /** Account holder name */
+    get accountHolderName() {
+        return this.addressProofFields?.accountHolderName;
+    }
+    /** Service type */
+    get serviceType() {
+        return this.addressProofFields?.serviceType;
+    }
+    /** Provider name */
+    get providerName() {
+        return this.addressProofFields?.providerName;
+    }
+    /** Account/contract number */
+    get accountNumber() {
+        return this.addressProofFields?.accountNumber;
+    }
+    /** Statement date */
+    get statementDate() {
+        const val = this.addressProofFields?.statementDate;
+        return val ? new Date(val) : undefined;
+    }
+    /** Service address */
+    get serviceAddress() {
+        return {
+            street: this.addressProofFields?.street,
+            exteriorNumber: this.addressProofFields?.exteriorNumber,
+            interiorNumber: this.addressProofFields?.interiorNumber,
+            neighborhood: this.addressProofFields?.neighborhood,
+            municipality: this.addressProofFields?.municipality,
+            state: this.addressProofFields?.state,
+            postalCode: this.addressProofFields?.postalCode,
+        };
+    }
+}
+// ─────────────────────────────────────────────────────────────────
+// Acta Constitutiva Document
+// ─────────────────────────────────────────────────────────────────
+/**
+ * Acta Constitutiva (Articles of Incorporation) document model
+ * with typed field accessors
+ */
+export class MexActaConstitutivaDocument extends MexDocument {
+    /**
+     * Typed acta constitutiva fields
+     */
+    get actaFields() {
+        return this.fields;
+    }
+    /** Company legal name (Denominación o Razón Social) */
+    get companyName() {
+        return this.actaFields?.companyName;
+    }
+    /** Company RFC (tax ID) */
+    get companyRfc() {
+        return this.actaFields?.companyRfc;
+    }
+    /** Type of legal entity */
+    get entityType() {
+        return this.actaFields?.entityType;
+    }
+    /** Notary number (Número de Notaría) */
+    get notaryNumber() {
+        return this.actaFields?.notaryNumber;
+    }
+    /** Notary name */
+    get notaryName() {
+        return this.actaFields?.notaryName;
+    }
+    /** Notary state/city */
+    get notaryLocation() {
+        return this.actaFields?.notaryLocation;
+    }
+    /** Instrument number (Número de Escritura) */
+    get instrumentNumber() {
+        return this.actaFields?.instrumentNumber;
+    }
+    /** Book number (Número de Libro) */
+    get bookNumber() {
+        return this.actaFields?.bookNumber;
+    }
+    /** Volume number (Número de Volumen) */
+    get volumeNumber() {
+        return this.actaFields?.volumeNumber;
+    }
+    /** Date of incorporation */
+    get incorporationDate() {
+        const val = this.actaFields?.incorporationDate;
+        return val ? new Date(val) : undefined;
+    }
+    /** Registration number at Public Registry of Commerce */
+    get publicRegistryNumber() {
+        return this.actaFields?.publicRegistryNumber;
+    }
+    /** Public Registry of Commerce location */
+    get publicRegistryLocation() {
+        return this.actaFields?.publicRegistryLocation;
+    }
+    /** Registration date at Public Registry */
+    get publicRegistryDate() {
+        const val = this.actaFields?.publicRegistryDate;
+        return val ? new Date(val) : undefined;
+    }
+    /** Corporate purpose (Objeto Social) */
+    get corporatePurpose() {
+        return this.actaFields?.corporatePurpose;
+    }
+    /** Duration of the company */
+    get duration() {
+        return this.actaFields?.duration;
+    }
+    /** Initial capital (Capital Social Inicial) */
+    get initialCapital() {
+        return this.actaFields?.initialCapital;
+    }
+    /** Capital currency */
+    get capitalCurrency() {
+        return this.actaFields?.capitalCurrency;
+    }
+    /** List of founding partners/shareholders */
+    get founders() {
+        return this.actaFields?.founders;
+    }
+    /** Legal representatives mentioned */
+    get legalRepresentatives() {
+        return this.actaFields?.legalRepresentatives;
+    }
+    /** Registered address */
+    get registeredAddress() {
+        return {
+            street: this.actaFields?.street,
+            exteriorNumber: this.actaFields?.exteriorNumber,
+            interiorNumber: this.actaFields?.interiorNumber,
+            neighborhood: this.actaFields?.neighborhood,
+            municipality: this.actaFields?.municipality,
+            state: this.actaFields?.state,
+            postalCode: this.actaFields?.postalCode,
+        };
+    }
+}
+// ─────────────────────────────────────────────────────────────────
+// Poder Notarial Document
+// ─────────────────────────────────────────────────────────────────
+/**
+ * Poder Notarial (Notarized Power of Attorney) document model
+ * with typed field accessors
+ */
+export class MexPoderNotarialDocument extends MexDocument {
+    /**
+     * Typed poder notarial fields
+     */
+    get poderFields() {
+        return this.fields;
+    }
+    /** Type of power granted */
+    get powerType() {
+        return this.poderFields?.powerType;
+    }
+    /** Grantor name (Poderdante - individual/company giving power) */
+    get grantorName() {
+        return this.poderFields?.grantorName;
+    }
+    /** Grantor RFC */
+    get grantorRfc() {
+        return this.poderFields?.grantorRfc;
+    }
+    /** Grantor type */
+    get grantorType() {
+        return this.poderFields?.grantorType;
+    }
+    /** Attorney-in-fact name (Apoderado - individual receiving power) */
+    get attorneyName() {
+        return this.poderFields?.attorneyName;
+    }
+    /** Attorney RFC */
+    get attorneyRfc() {
+        return this.poderFields?.attorneyRfc;
+    }
+    /** Attorney CURP */
+    get attorneyCurp() {
+        return this.poderFields?.attorneyCurp;
+    }
+    /** Notary number */
+    get notaryNumber() {
+        return this.poderFields?.notaryNumber;
+    }
+    /** Notary name */
+    get notaryName() {
+        return this.poderFields?.notaryName;
+    }
+    /** Notary state/city */
+    get notaryLocation() {
+        return this.poderFields?.notaryLocation;
+    }
+    /** Instrument number (Número de Escritura) */
+    get instrumentNumber() {
+        return this.poderFields?.instrumentNumber;
+    }
+    /** Book number */
+    get bookNumber() {
+        return this.poderFields?.bookNumber;
+    }
+    /** Volume number */
+    get volumeNumber() {
+        return this.poderFields?.volumeNumber;
+    }
+    /** Date power was granted */
+    get grantDate() {
+        const val = this.poderFields?.grantDate;
+        return val ? new Date(val) : undefined;
+    }
+    /** Expiration date (if applicable) */
+    get poderExpirationDate() {
+        const val = this.poderFields?.expirationDate;
+        return val ? new Date(val) : undefined;
+    }
+    /** Whether the power is revocable */
+    get isRevocable() {
+        return this.poderFields?.isRevocable;
+    }
+    /** Scope/limitations of the power */
+    get scope() {
+        return this.poderFields?.scope;
+    }
+    /** Specific acts authorized (for special powers) */
+    get authorizedActs() {
+        return this.poderFields?.authorizedActs;
+    }
+    /** Registration number (if registered) */
+    get registrationNumber() {
+        return this.poderFields?.registrationNumber;
+    }
+    /** Whether this power has been revoked */
+    get isRevoked() {
+        return this.poderFields?.isRevoked;
+    }
+    /** Revocation date */
+    get revocationDate() {
+        const val = this.poderFields?.revocationDate;
+        return val ? new Date(val) : undefined;
+    }
+}
+// ─────────────────────────────────────────────────────────────────
+// Type Guards
+// ─────────────────────────────────────────────────────────────────
+/**
+ * Check if document is a Mexico document
+ */
+export function isMexDocument(doc) {
+    return doc.isMexico;
+}
+/**
+ * Check if document is INE front
+ */
+export function isMexIneFront(doc) {
+    return doc.isMexico && doc.type === MexDocumentType.IneFront;
+}
+/**
+ * Check if document is INE back
+ */
+export function isMexIneBack(doc) {
+    return doc.isMexico && doc.type === MexDocumentType.IneBack;
+}
+/**
+ * Check if document is a passport
+ */
+export function isMexPassport(doc) {
+    return doc.isMexico && doc.type === MexDocumentType.Passport;
+}
+/**
+ * Check if document is a CURP
+ */
+export function isMexCurp(doc) {
+    return doc.isMexico && doc.type === MexDocumentType.Curp;
+}
+/**
+ * Check if document is an RFC constancia
+ */
+export function isMexRfcConstancia(doc) {
+    return doc.isMexico && doc.type === MexDocumentType.RfcConstancia;
+}
+/**
+ * Check if document is an address proof
+ */
+export function isMexAddressProof(doc) {
+    return doc.isMexico && doc.type === MexDocumentType.AddressProof;
+}
+/**
+ * Check if document is an acta constitutiva
+ */
+export function isMexActaConstitutiva(doc) {
+    return doc.isMexico && doc.type === MexDocumentType.ActaConstitutiva;
+}
+/**
+ * Check if document is a poder notarial
+ */
+export function isMexPoderNotarial(doc) {
+    return doc.isMexico && doc.type === MexDocumentType.PoderNotarial;
+}