@fiado/type-kit 3.205.0 → 3.207.0

package/bin/loanCredit/dtos/LoanContract.d.ts

@@ -11,7 +11,9 @@ export declare class LoanContract {
     contractId: string;
     creditId: string;
     type: ContractTypeEnum;
-    /** Key del PDF en el bucket del tenant (`loan-{tenant}-{env}`). Ausente hasta generar (AS-09). */
+    /** Id del documento en document-generator (para getDocumentUrl). Ausente hasta generar. */
+    documentId?: string;
+    /** Key del PDF en el storage de document-generator. Ausente hasta generar. */
     pdfS3Key?: string;
     /** Hash SHA-256 del PDF firmado (trazabilidad FES — M2 §4.4). Ausente hasta generar. */
     sha256?: string;

package/bin/loanCredit/dtos/LoanContract.js

@@ -40,6 +40,12 @@ __decorate([
     (0, class_validator_1.IsEnum)(ContractTypeEnum_1.ContractTypeEnum),
     __metadata("design:type", String)
 ], LoanContract.prototype, "type", void 0);
+__decorate([
+    (0, class_transformer_1.Expose)(),
+    (0, class_validator_1.IsOptional)(),
+    (0, class_validator_1.IsString)(),
+    __metadata("design:type", String)
+], LoanContract.prototype, "documentId", void 0);
 __decorate([
     (0, class_transformer_1.Expose)(),
     (0, class_validator_1.IsOptional)(),

package/bin/loanCredit/dtos/requests/SignLoanCreditRequest.d.ts

@@ -20,6 +20,13 @@ export declare class SignLoanCreditRequest {
      * hidratado en el borrower). El OTP se genera/verifica keyeado a este id (D5).
      */
     otpDirectoryId?: string;
+    /**
+     * SOLO en el inicio de firma (tiempo 1): variables del TEMPLATE del contrato que el motor no
+     * posee (PII TRANSITORIA del cliente — nombreAcreditado, curp, domicilio, lugar de firma...).
+     * Las aporta el WIZARD (dueño del dato); el motor las mezcla con las financieras (monto,
+     * pagos, tasa) y las pasa a document-generator. NO se persisten ni loggean (silo PII-zero).
+     */
+    contractData?: Record<string, string>;
     /**
      * SOLO en el inicio de firma (tiempo 1) con el OTP REAL: el teléfono destino del SMS (E.164).
      * PII TRANSITORIA: el motor la pasa a messages-business y NO la persiste ni loggea (silo

package/bin/loanCredit/dtos/requests/SignLoanCreditRequest.js

@@ -41,6 +41,12 @@ __decorate([
     (0, class_validator_1.IsString)(),
     __metadata("design:type", String)
 ], SignLoanCreditRequest.prototype, "otpDirectoryId", void 0);
+__decorate([
+    (0, class_transformer_1.Expose)(),
+    (0, class_validator_1.IsOptional)(),
+    (0, class_validator_1.IsObject)(),
+    __metadata("design:type", Object)
+], SignLoanCreditRequest.prototype, "contractData", void 0);
 __decorate([
     (0, class_transformer_1.Expose)(),
     (0, class_validator_1.IsOptional)(),

package/bin/loanCredit/dtos/responses/LoanContractResponse.d.ts

@@ -6,6 +6,7 @@ export interface LoanContractResponse {
     contractId: string;
     creditId: string;
     type: ContractTypeEnum;
+    documentId?: string;
     pdfS3Key?: string;
     sha256?: string;
     otpVerified: boolean;

package/bin/retailWizard/dtos/responses/KycPrepareResponse.d.ts

@@ -0,0 +1,59 @@
+import { KycModalityEnum } from '../../../retailCustomer/enums/KycModalityEnum';
+/**
+ * Metadata que el wizard entrega al SDK de Metamap para que la verificación quede correlacionada
+ * con la identidad Fiado. Viaja base64 dentro de `KycPrepareResponse.metadata`.
+ *
+ * **La arma el wizard, no el front** (`loan-backoffice-webapp/.env.example`): el front no conoce
+ * `peopleId` ni `typeOfDirectoryId` — los resuelve el wizard al crear/reusar la identidad.
+ *
+ * Espeja `kyc-verifications-business/src/core/entities/Metadata.ts`. Es la ÚNICA correlación entre
+ * la verificación de Metamap y el cliente Fiado: el webhook crea la fila desde acá (D18/D19).
+ *
+ * ⚠️ `typeOfDocumentId` e `isPartial` van OPCIONALES a propósito: el tipo del productor los declara
+ * requeridos, pero están ausentes en el 100% de los 311 bloques de metadata observados en dev
+ * (spec KYC F2 §14.1). Todo indica que los completa el SDK/backend de Metamap. Marcarlos requeridos
+ * acá obligaría al wizard a inventar valores. Se cierra cuando el dueño del SDK lo confirme.
+ */
+export interface KycSdkMetadata {
+    directoryId: string;
+    typeOfDirectoryId: string;
+    peopleId: string;
+    countryId: string;
+    phoneNumber: string;
+    typeOfDocumentId?: string;
+    isPartial?: boolean;
+    customInput?: boolean;
+    userPhotoLink?: string;
+    userPhotoLinkHash?: string;
+}
+/**
+ * POST /wizard/sessions/:id/kyc/prepare — respuesta.
+ *
+ * **Bifurca por modalidad**, por eso todo es opcional salvo `modality`:
+ * - `STORE_DEVICE` → `clientId` + `flowId` + `metadata` para que el front monte el
+ *   `<metamap-button>` en la tablet. Única excepción a la regla puente (D25): el widget es un SDK
+ *   de un SaaS de terceros que corre en el dispositivo del cliente y habla con Metamap, no con Fiado.
+ * - `CUSTOMER_LINK` → `shortUrl` para el QR / SMS al teléfono del cliente.
+ *
+ * `alreadyVerified` corta el flujo antes de cualquiera de las dos: cuando la consolidación del spec
+ * KYC F2 §8.2 ya da `VERIFIED` para ese directorio, no hay identidad que capturar.
+ *
+ * SureKeep Fase 2 — pista Retail.
+ */
+export interface KycPrepareResponse {
+    /**
+     * `MANUAL` NO es una modalidad de `prepare`: la captura manual es su propio endpoint
+     * (`KycManualRequest`). Por eso el tipo se estrecha a las dos que el SDK puede ejecutar.
+     */
+    modality: KycModalityEnum.CUSTOMER_LINK | KycModalityEnum.STORE_DEVICE;
+    /** STORE_DEVICE — clientId de la cuenta Metamap (mismo valor en prod y dev). */
+    clientId?: string;
+    /** STORE_DEVICE — flow de Metamap por país; sale de la configuración del wizard. */
+    flowId?: string;
+    /** STORE_DEVICE — `KycSdkMetadata` serializada en base64. */
+    metadata?: string;
+    /** CUSTOMER_LINK — link corto para el QR o el SMS. */
+    shortUrl?: string;
+    /** El cliente ya tiene una identidad verificada vigente: no hay nada que capturar. */
+    alreadyVerified?: boolean;
+}

package/bin/retailWizard/dtos/responses/KycPrepareResponse.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/bin/retailWizard/index.d.ts

@@ -49,6 +49,7 @@ export * from './dtos/requests/CreateProspectRequest';
 export * from './dtos/requests/UpdateProspectRequest';
 export * from './dtos/requests/MarkProspectLostRequest';
 export * from './dtos/requests/CancelSaleRequest';
+export * from './dtos/responses/KycPrepareResponse';
 export * from './events/SaleCompletedV1';
 export * from './events/SaleCancelledV1';
 export * from './events/SessionExpiredV1';

package/bin/retailWizard/index.js

@@ -70,6 +70,8 @@ __exportStar(require("./dtos/requests/CreateProspectRequest"), exports);
 __exportStar(require("./dtos/requests/UpdateProspectRequest"), exports);
 __exportStar(require("./dtos/requests/MarkProspectLostRequest"), exports);
 __exportStar(require("./dtos/requests/CancelSaleRequest"), exports);
+// Response DTOs (output tipado por endpoint)
+__exportStar(require("./dtos/responses/KycPrepareResponse"), exports);
 // Contratos de eventos (PascalCase + sufijo V1)
 __exportStar(require("./events/SaleCompletedV1"), exports);
 __exportStar(require("./events/SaleCancelledV1"), exports);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fiado/type-kit",
-  "version": "3.205.0",
+  "version": "3.207.0",
   "description": "",
   "main": "bin/index.js",
   "types": "bin/index.d.ts",

package/src/loanCredit/dtos/LoanContract.ts

@@ -24,7 +24,13 @@ export class LoanContract {
     @IsEnum(ContractTypeEnum)
     type!: ContractTypeEnum;
 
-    /** Key del PDF en el bucket del tenant (`loan-{tenant}-{env}`). Ausente hasta generar (AS-09). */
+    /** Id del documento en document-generator (para getDocumentUrl). Ausente hasta generar. */
+    @Expose()
+    @IsOptional()
+    @IsString()
+    documentId?: string;
+
+    /** Key del PDF en el storage de document-generator. Ausente hasta generar. */
     @Expose()
     @IsOptional()
     @IsString()

package/src/loanCredit/dtos/requests/SignLoanCreditRequest.ts

@@ -1,5 +1,5 @@
 import { Expose } from 'class-transformer';
-import { IsOptional, IsString, Length } from 'class-validator';
+import { IsObject, IsOptional, IsString, Length } from 'class-validator';
 
 /**
  * Body de `POST /private/credits/:creditId/sign` (loan-credit-business — wizard paso 08, firma FES
@@ -32,6 +32,17 @@ export class SignLoanCreditRequest {
     @IsString()
     otpDirectoryId?: string;
 
+    /**
+     * SOLO en el inicio de firma (tiempo 1): variables del TEMPLATE del contrato que el motor no
+     * posee (PII TRANSITORIA del cliente — nombreAcreditado, curp, domicilio, lugar de firma...).
+     * Las aporta el WIZARD (dueño del dato); el motor las mezcla con las financieras (monto,
+     * pagos, tasa) y las pasa a document-generator. NO se persisten ni loggean (silo PII-zero).
+     */
+    @Expose()
+    @IsOptional()
+    @IsObject()
+    contractData?: Record<string, string>;
+
     /**
      * SOLO en el inicio de firma (tiempo 1) con el OTP REAL: el teléfono destino del SMS (E.164).
      * PII TRANSITORIA: el motor la pasa a messages-business y NO la persiste ni loggea (silo

package/src/loanCredit/dtos/responses/LoanContractResponse.ts

@@ -7,6 +7,7 @@ export interface LoanContractResponse {
     contractId: string;
     creditId: string;
     type: ContractTypeEnum;
+    documentId?: string;
     pdfS3Key?: string;
     sha256?: string;
     otpVerified: boolean;

package/src/retailWizard/dtos/responses/KycPrepareResponse.ts

@@ -0,0 +1,61 @@
+import { KycModalityEnum } from '../../../retailCustomer/enums/KycModalityEnum';
+
+/**
+ * Metadata que el wizard entrega al SDK de Metamap para que la verificación quede correlacionada
+ * con la identidad Fiado. Viaja base64 dentro de `KycPrepareResponse.metadata`.
+ *
+ * **La arma el wizard, no el front** (`loan-backoffice-webapp/.env.example`): el front no conoce
+ * `peopleId` ni `typeOfDirectoryId` — los resuelve el wizard al crear/reusar la identidad.
+ *
+ * Espeja `kyc-verifications-business/src/core/entities/Metadata.ts`. Es la ÚNICA correlación entre
+ * la verificación de Metamap y el cliente Fiado: el webhook crea la fila desde acá (D18/D19).
+ *
+ * ⚠️ `typeOfDocumentId` e `isPartial` van OPCIONALES a propósito: el tipo del productor los declara
+ * requeridos, pero están ausentes en el 100% de los 311 bloques de metadata observados en dev
+ * (spec KYC F2 §14.1). Todo indica que los completa el SDK/backend de Metamap. Marcarlos requeridos
+ * acá obligaría al wizard a inventar valores. Se cierra cuando el dueño del SDK lo confirme.
+ */
+export interface KycSdkMetadata {
+    directoryId: string;
+    typeOfDirectoryId: string;
+    peopleId: string;
+    countryId: string;
+    phoneNumber: string;
+    typeOfDocumentId?: string;
+    isPartial?: boolean;
+    customInput?: boolean;
+    userPhotoLink?: string;
+    userPhotoLinkHash?: string;
+}
+
+/**
+ * POST /wizard/sessions/:id/kyc/prepare — respuesta.
+ *
+ * **Bifurca por modalidad**, por eso todo es opcional salvo `modality`:
+ * - `STORE_DEVICE` → `clientId` + `flowId` + `metadata` para que el front monte el
+ *   `<metamap-button>` en la tablet. Única excepción a la regla puente (D25): el widget es un SDK
+ *   de un SaaS de terceros que corre en el dispositivo del cliente y habla con Metamap, no con Fiado.
+ * - `CUSTOMER_LINK` → `shortUrl` para el QR / SMS al teléfono del cliente.
+ *
+ * `alreadyVerified` corta el flujo antes de cualquiera de las dos: cuando la consolidación del spec
+ * KYC F2 §8.2 ya da `VERIFIED` para ese directorio, no hay identidad que capturar.
+ *
+ * SureKeep Fase 2 — pista Retail.
+ */
+export interface KycPrepareResponse {
+    /**
+     * `MANUAL` NO es una modalidad de `prepare`: la captura manual es su propio endpoint
+     * (`KycManualRequest`). Por eso el tipo se estrecha a las dos que el SDK puede ejecutar.
+     */
+    modality: KycModalityEnum.CUSTOMER_LINK | KycModalityEnum.STORE_DEVICE;
+    /** STORE_DEVICE — clientId de la cuenta Metamap (mismo valor en prod y dev). */
+    clientId?: string;
+    /** STORE_DEVICE — flow de Metamap por país; sale de la configuración del wizard. */
+    flowId?: string;
+    /** STORE_DEVICE — `KycSdkMetadata` serializada en base64. */
+    metadata?: string;
+    /** CUSTOMER_LINK — link corto para el QR o el SMS. */
+    shortUrl?: string;
+    /** El cliente ya tiene una identidad verificada vigente: no hay nada que capturar. */
+    alreadyVerified?: boolean;
+}

package/src/retailWizard/index.ts

@@ -59,6 +59,9 @@ export * from './dtos/requests/UpdateProspectRequest';
 export * from './dtos/requests/MarkProspectLostRequest';
 export * from './dtos/requests/CancelSaleRequest';
 
+// Response DTOs (output tipado por endpoint)
+export * from './dtos/responses/KycPrepareResponse';
+
 // Contratos de eventos (PascalCase + sufijo V1)
 export * from './events/SaleCompletedV1';
 export * from './events/SaleCancelledV1';