@fiado/type-kit 3.8.1 → 3.11.0

package/bin/credit/enums/CollectionFrequencyEnum.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CollectionFrequencyEnum = void 0;
+var CollectionFrequencyEnum;
+(function (CollectionFrequencyEnum) {
+    CollectionFrequencyEnum["WEEKLY"] = "WEEKLY";
+    CollectionFrequencyEnum["BIWEEKLY"] = "BIWEEKLY";
+    CollectionFrequencyEnum["MONTHLY"] = "MONTHLY";
+})(CollectionFrequencyEnum || (exports.CollectionFrequencyEnum = CollectionFrequencyEnum = {}));

package/bin/credit/enums/CreditOperationEnum.d.ts

@@ -0,0 +1,11 @@
+export declare enum CreditOperationEnum {
+    DISBURSEMENT = "DISBURSEMENT",
+    COLLECTION = "COLLECTION",
+    COLLECTION_PARTIAL = "COLLECTION_PARTIAL",
+    COLLECTION_LIEN = "COLLECTION_LIEN",
+    EARLY_PAYMENT = "EARLY_PAYMENT",
+    TRANSFER_LOANCO = "TRANSFER_LOANCO",
+    REVERSAL = "REVERSAL",
+    INTEREST_ACCRUAL = "INTEREST_ACCRUAL",
+    FEE_CHARGE = "FEE_CHARGE"
+}

package/bin/credit/enums/CreditOperationEnum.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CreditOperationEnum = void 0;
+var CreditOperationEnum;
+(function (CreditOperationEnum) {
+    CreditOperationEnum["DISBURSEMENT"] = "DISBURSEMENT";
+    CreditOperationEnum["COLLECTION"] = "COLLECTION";
+    CreditOperationEnum["COLLECTION_PARTIAL"] = "COLLECTION_PARTIAL";
+    CreditOperationEnum["COLLECTION_LIEN"] = "COLLECTION_LIEN";
+    CreditOperationEnum["EARLY_PAYMENT"] = "EARLY_PAYMENT";
+    CreditOperationEnum["TRANSFER_LOANCO"] = "TRANSFER_LOANCO";
+    CreditOperationEnum["REVERSAL"] = "REVERSAL";
+    CreditOperationEnum["INTEREST_ACCRUAL"] = "INTEREST_ACCRUAL";
+    CreditOperationEnum["FEE_CHARGE"] = "FEE_CHARGE";
+})(CreditOperationEnum || (exports.CreditOperationEnum = CreditOperationEnum = {}));

package/bin/credit/enums/CreditStatusEnum.d.ts

@@ -0,0 +1,12 @@
+export declare enum CreditStatusEnum {
+    PENDING_APPROVAL = "PENDING_APPROVAL",
+    APPROVED = "APPROVED",
+    ACTIVE = "ACTIVE",
+    CURRENT = "CURRENT",
+    DELINQUENT = "DELINQUENT",
+    DEFAULTED = "DEFAULTED",
+    PAID_OFF = "PAID_OFF",
+    CANCELLED = "CANCELLED",
+    RETURNED_TO_LOANCO = "RETURNED_TO_LOANCO",
+    WRITTEN_OFF = "WRITTEN_OFF"
+}

package/bin/credit/enums/CreditStatusEnum.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CreditStatusEnum = void 0;
+var CreditStatusEnum;
+(function (CreditStatusEnum) {
+    CreditStatusEnum["PENDING_APPROVAL"] = "PENDING_APPROVAL";
+    CreditStatusEnum["APPROVED"] = "APPROVED";
+    CreditStatusEnum["ACTIVE"] = "ACTIVE";
+    CreditStatusEnum["CURRENT"] = "CURRENT";
+    CreditStatusEnum["DELINQUENT"] = "DELINQUENT";
+    CreditStatusEnum["DEFAULTED"] = "DEFAULTED";
+    CreditStatusEnum["PAID_OFF"] = "PAID_OFF";
+    CreditStatusEnum["CANCELLED"] = "CANCELLED";
+    CreditStatusEnum["RETURNED_TO_LOANCO"] = "RETURNED_TO_LOANCO";
+    CreditStatusEnum["WRITTEN_OFF"] = "WRITTEN_OFF";
+})(CreditStatusEnum || (exports.CreditStatusEnum = CreditStatusEnum = {}));

package/bin/credit/enums/DelinquencyLevelEnum.d.ts

@@ -0,0 +1,9 @@
+export declare enum DelinquencyLevelEnum {
+    CURRENT = "CURRENT",
+    EARLY_1_7 = "EARLY_1_7",
+    EARLY_8_14 = "EARLY_8_14",
+    LATE_15_30 = "LATE_15_30",
+    LATE_31_60 = "LATE_31_60",
+    SEVERE_61_90 = "SEVERE_61_90",
+    DEFAULT_90_PLUS = "DEFAULT_90_PLUS"
+}

package/bin/credit/enums/DelinquencyLevelEnum.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DelinquencyLevelEnum = void 0;
+var DelinquencyLevelEnum;
+(function (DelinquencyLevelEnum) {
+    DelinquencyLevelEnum["CURRENT"] = "CURRENT";
+    DelinquencyLevelEnum["EARLY_1_7"] = "EARLY_1_7";
+    DelinquencyLevelEnum["EARLY_8_14"] = "EARLY_8_14";
+    DelinquencyLevelEnum["LATE_15_30"] = "LATE_15_30";
+    DelinquencyLevelEnum["LATE_31_60"] = "LATE_31_60";
+    DelinquencyLevelEnum["SEVERE_61_90"] = "SEVERE_61_90";
+    DelinquencyLevelEnum["DEFAULT_90_PLUS"] = "DEFAULT_90_PLUS";
+})(DelinquencyLevelEnum || (exports.DelinquencyLevelEnum = DelinquencyLevelEnum = {}));

package/bin/credit/enums/DocumentTypeEnum.d.ts

@@ -0,0 +1,8 @@
+export declare enum DocumentTypeEnum {
+    CREDIT_CONTRACT = "CREDIT_CONTRACT",
+    CREDIT_STATEMENT = "CREDIT_STATEMENT",
+    CREDIT_AMORTIZATION = "CREDIT_AMORTIZATION",
+    CREDIT_COVER_SHEET = "CREDIT_COVER_SHEET",
+    ONBOARDING_CONTRACT = "ONBOARDING_CONTRACT",
+    ONBOARDING_IFPE = "ONBOARDING_IFPE"
+}

package/bin/credit/enums/DocumentTypeEnum.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DocumentTypeEnum = void 0;
+var DocumentTypeEnum;
+(function (DocumentTypeEnum) {
+    DocumentTypeEnum["CREDIT_CONTRACT"] = "CREDIT_CONTRACT";
+    DocumentTypeEnum["CREDIT_STATEMENT"] = "CREDIT_STATEMENT";
+    DocumentTypeEnum["CREDIT_AMORTIZATION"] = "CREDIT_AMORTIZATION";
+    DocumentTypeEnum["CREDIT_COVER_SHEET"] = "CREDIT_COVER_SHEET";
+    DocumentTypeEnum["ONBOARDING_CONTRACT"] = "ONBOARDING_CONTRACT";
+    DocumentTypeEnum["ONBOARDING_IFPE"] = "ONBOARDING_IFPE";
+})(DocumentTypeEnum || (exports.DocumentTypeEnum = DocumentTypeEnum = {}));

package/bin/credit/enums/OfferStatusEnum.d.ts

@@ -0,0 +1,8 @@
+export declare enum OfferStatusEnum {
+    NOT_ELIGIBLE = "NOT_ELIGIBLE",
+    PRE_QUALIFIED = "PRE_QUALIFIED",
+    OFFER_AVAILABLE = "OFFER_AVAILABLE",
+    OFFER_CONFIGURED = "OFFER_CONFIGURED",
+    OFFER_ACCEPTED = "OFFER_ACCEPTED",
+    OFFER_EXPIRED = "OFFER_EXPIRED"
+}

package/bin/credit/enums/OfferStatusEnum.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.OfferStatusEnum = void 0;
+var OfferStatusEnum;
+(function (OfferStatusEnum) {
+    OfferStatusEnum["NOT_ELIGIBLE"] = "NOT_ELIGIBLE";
+    OfferStatusEnum["PRE_QUALIFIED"] = "PRE_QUALIFIED";
+    OfferStatusEnum["OFFER_AVAILABLE"] = "OFFER_AVAILABLE";
+    OfferStatusEnum["OFFER_CONFIGURED"] = "OFFER_CONFIGURED";
+    OfferStatusEnum["OFFER_ACCEPTED"] = "OFFER_ACCEPTED";
+    OfferStatusEnum["OFFER_EXPIRED"] = "OFFER_EXPIRED";
+})(OfferStatusEnum || (exports.OfferStatusEnum = OfferStatusEnum = {}));

package/bin/credit/enums/PaymentTypeEnum.d.ts

@@ -0,0 +1,9 @@
+export declare enum PaymentTypeEnum {
+    REGULAR = "REGULAR",
+    PARTIAL = "PARTIAL",
+    EARLY_ANTICIPATED = "EARLY_ANTICIPATED",
+    EARLY_ADVANCED = "EARLY_ADVANCED",
+    EARLY_SETTLEMENT = "EARLY_SETTLEMENT",
+    LIEN = "LIEN",
+    REVERSAL = "REVERSAL"
+}

package/bin/credit/enums/PaymentTypeEnum.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PaymentTypeEnum = void 0;
+var PaymentTypeEnum;
+(function (PaymentTypeEnum) {
+    PaymentTypeEnum["REGULAR"] = "REGULAR";
+    PaymentTypeEnum["PARTIAL"] = "PARTIAL";
+    PaymentTypeEnum["EARLY_ANTICIPATED"] = "EARLY_ANTICIPATED";
+    PaymentTypeEnum["EARLY_ADVANCED"] = "EARLY_ADVANCED";
+    PaymentTypeEnum["EARLY_SETTLEMENT"] = "EARLY_SETTLEMENT";
+    PaymentTypeEnum["LIEN"] = "LIEN";
+    PaymentTypeEnum["REVERSAL"] = "REVERSAL";
+})(PaymentTypeEnum || (exports.PaymentTypeEnum = PaymentTypeEnum = {}));

package/bin/credit/enums/ReconciliationStatusEnum.d.ts

@@ -0,0 +1,6 @@
+export declare enum ReconciliationStatusEnum {
+    PENDING = "PENDING",
+    MATCHED = "MATCHED",
+    DISCREPANCY = "DISCREPANCY",
+    RESOLVED = "RESOLVED"
+}

package/bin/credit/enums/ReconciliationStatusEnum.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ReconciliationStatusEnum = void 0;
+var ReconciliationStatusEnum;
+(function (ReconciliationStatusEnum) {
+    ReconciliationStatusEnum["PENDING"] = "PENDING";
+    ReconciliationStatusEnum["MATCHED"] = "MATCHED";
+    ReconciliationStatusEnum["DISCREPANCY"] = "DISCREPANCY";
+    ReconciliationStatusEnum["RESOLVED"] = "RESOLVED";
+})(ReconciliationStatusEnum || (exports.ReconciliationStatusEnum = ReconciliationStatusEnum = {}));

package/bin/credit/enums/TransferStatusEnum.d.ts

@@ -0,0 +1,8 @@
+export declare enum TransferStatusEnum {
+    PENDING = "PENDING",
+    APPROVED = "APPROVED",
+    IN_PROGRESS = "IN_PROGRESS",
+    COMPLETED = "COMPLETED",
+    FAILED = "FAILED",
+    REJECTED = "REJECTED"
+}

package/bin/credit/enums/TransferStatusEnum.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TransferStatusEnum = void 0;
+var TransferStatusEnum;
+(function (TransferStatusEnum) {
+    TransferStatusEnum["PENDING"] = "PENDING";
+    TransferStatusEnum["APPROVED"] = "APPROVED";
+    TransferStatusEnum["IN_PROGRESS"] = "IN_PROGRESS";
+    TransferStatusEnum["COMPLETED"] = "COMPLETED";
+    TransferStatusEnum["FAILED"] = "FAILED";
+    TransferStatusEnum["REJECTED"] = "REJECTED";
+})(TransferStatusEnum || (exports.TransferStatusEnum = TransferStatusEnum = {}));

package/package.json

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

package/src/benefitCenter/dtos/AuthorizeBenefitsMarketplaceTransactionRequest.ts

@@ -0,0 +1,101 @@
+import {
+    IsLatitude,
+    IsLongitude,
+    IsNotEmpty,
+    IsNumber,
+    IsObject,
+    IsOptional,
+    IsPositive,
+    IsString,
+    Length,
+    MaxLength,
+} from "class-validator";
+
+/**
+ * Request del endpoint nuevo `POST /authorizeBenefitsMarketplaceTransaction`
+ * en `transaction-processor-business` (PublicController). Lo invoca la app
+ * para todos los flujos del Centro de Beneficios.
+ *
+ * NO se reusa `AuthorizePaymentTransactionRequest` ni similares: este DTO
+ * es dedicado, sin sub-objetos opcionales, con los campos del Centro como
+ * ciudadanos de primera clase.
+ *
+ * Los endpoints `authorize*Transaction` actuales del procesador no se tocan
+ * y siguen recibiendo su tráfico legacy. Ver doc Fase 2 §5.1.
+ */
+export class AuthorizeBenefitsMarketplaceTransactionRequest {
+    /**
+     * Reusa entradas existentes en `ProductCatalog_GT` del procesador
+     * (`MEX_TOPUP`, `MEX_SERVICE_PAYMENT`, …). No se agregan entradas nuevas
+     * en Fase 2 (ver doc §10).
+     */
+    @IsString()
+    @IsNotEmpty()
+    @MaxLength(64)
+    productCatalogId!: string;
+
+    /**
+     * Idempotency key generada por la **app** (UUID por intento).
+     * Lo consume el decorador `@IdempotencyController` del procesador para
+     * deduplicar reintentos del cliente.
+     *
+     * Distinto de `BenefitPaymentRequest.transactionNumber` que el procesador
+     * genera internamente al crear la transacción y envía al marketplace y
+     * al conector como idempotency key del lado del proveedor. La app NO
+     * debe generar `transactionNumber` — por eso este DTO no lo expone.
+     */
+    @IsString()
+    @IsNotEmpty()
+    @MaxLength(64)
+    idempotencyKey!: string;
+
+    @IsNumber()
+    @IsPositive()
+    amount!: number;
+
+    /** ISO numeric (3 chars). Ej: "484" (MXN), "840" (USD). */
+    @IsString()
+    @Length(3, 3)
+    currencyId!: string;
+
+    // Campos del Centro de Beneficios — first-class, no opcionales
+
+    @IsString()
+    @IsNotEmpty()
+    @MaxLength(64)
+    benefitId!: string;
+
+    @IsString()
+    @IsNotEmpty()
+    @MaxLength(256)
+    leafId!: string;
+
+    @IsString()
+    @IsNotEmpty()
+    @MaxLength(64)
+    productId!: string;
+
+    @IsString()
+    @IsNotEmpty()
+    @MaxLength(128)
+    reference!: string;
+
+    /** Decide a qué conector apuntar dentro del marketplace. */
+    @IsString()
+    @IsNotEmpty()
+    @MaxLength(128)
+    moduleName!: string;
+
+    /** Inputs dinámicos del leaf — opcionales según el servicio. */
+    @IsOptional()
+    @IsObject()
+    inputs?: Record<string, string | number | boolean>;
+
+    @IsOptional()
+    @IsLatitude()
+    latitude?: number;
+
+    @IsOptional()
+    @IsLongitude()
+    longitude?: number;
+}

package/src/benefitCenter/dtos/BenefitPaymentRequest.ts

@@ -0,0 +1,78 @@
+import {
+    IsLatitude,
+    IsLongitude,
+    IsNotEmpty,
+    IsNumber,
+    IsObject,
+    IsOptional,
+    IsPositive,
+    IsString,
+    MaxLength,
+} from "class-validator";
+
+/**
+ * Request del endpoint privado `POST /pay/{moduleName}` del marketplace
+ * (`benefits-marketplace-business`). Lo invoca el procesador desde
+ * `IBenefitsMarketplaceApi.pay(...)` cuando entra una transacción por el
+ * endpoint `authorizeBenefitsMarketplaceTransaction`.
+ *
+ * Es el MISMO contrato que reciben los conectores en su `POST /pay/standard`
+ * — el marketplace lo reenvía sin transformar (sin mappers legacy).
+ *
+ * Ver doc Fase 2 §4.1 y §8.1.
+ */
+export class BenefitPaymentRequest {
+    @IsString()
+    @IsNotEmpty()
+    @MaxLength(64)
+    directoryId!: string;
+
+    @IsString()
+    @IsNotEmpty()
+    @MaxLength(64)
+    benefitId!: string;
+
+    @IsString()
+    @IsNotEmpty()
+    @MaxLength(256)
+    leafId!: string;
+
+    @IsString()
+    @IsNotEmpty()
+    @MaxLength(64)
+    productId!: string;
+
+    @IsString()
+    @IsNotEmpty()
+    @MaxLength(128)
+    reference!: string;
+
+    @IsNumber()
+    @IsPositive()
+    amount!: number;
+
+    /**
+     * Idempotency key del pago (la genera el procesador y la usa el conector
+     * para no re-cobrar si el request se repite).
+     */
+    @IsString()
+    @IsNotEmpty()
+    @MaxLength(64)
+    transactionNumber!: string;
+
+    /**
+     * Inputs dinámicos del leaf (definidos por su `inputSchema`). Opcionales
+     * según el servicio.
+     */
+    @IsOptional()
+    @IsObject()
+    inputs?: Record<string, string | number | boolean>;
+
+    @IsOptional()
+    @IsLatitude()
+    latitude?: number;
+
+    @IsOptional()
+    @IsLongitude()
+    longitude?: number;
+}

package/src/benefitCenter/dtos/BenefitPaymentResponse.ts

@@ -0,0 +1,28 @@
+import { BenefitPaymentErrorCodeEnum } from "../enums/BenefitPaymentErrorCodeEnum";
+import { BenefitPaymentStatusEnum } from "../enums/BenefitPaymentStatusEnum";
+
+/**
+ * Respuesta uniforme del marketplace al procesador, devuelta por el endpoint
+ * `POST /pay/{moduleName}`. La emite el marketplace tras invocar al conector
+ * — su shape NO depende del conector (el mapping interno → estándar lo hace
+ * el propio conector en `/pay/standard`).
+ *
+ * Sin decoradores `class-validator`: el procesador la consume tal cual viene
+ * por la red, no la valida. Ver doc Fase 2 §8.2.
+ */
+export class BenefitPaymentResponse {
+    /** Estado final del pago. APPROVED dispara el upsert del favorito in-process. */
+    status: BenefitPaymentStatusEnum;
+
+    /** Tracking del proveedor externo (ej. STP authNum). Útil para auditoría. */
+    providerReference?: string;
+
+    /** Código en bruto del proveedor — sirve solo para debug. */
+    rawCode?: string;
+
+    /** Código canónico mapeado (cuando `status !== APPROVED`). */
+    errorCode?: BenefitPaymentErrorCodeEnum;
+
+    /** Mensaje legible asociado al error o al status. */
+    message?: string;
+}

package/src/benefitCenter/dtos/FavoriteUpsertContext.ts

@@ -0,0 +1,26 @@
+/**
+ * Contexto que el `PaymentManager` del marketplace pasa a
+ * `FavoriteManager.upsertFromPayment(...)` para crear/actualizar el favorito
+ * tras un pago APPROVED.
+ *
+ * NO ES UN DTO DE REQUEST HTTP: vive solo dentro del proceso del lambda
+ * `benefits-marketplace-business`. Por eso no lleva decoradores de
+ * `class-validator` — nunca se deserializa desde un body HTTP.
+ *
+ * El procesador NO conoce este tipo (no participa en la lógica de favoritos).
+ * Ver doc Fase 2 §4.3 y §8.4.
+ */
+export class FavoriteUpsertContext {
+    directoryId: string;
+    benefitId: string;
+    leafId: string;
+    productId: string;
+    reference: string;
+    amount: number;
+
+    /** Idempotency key del pago — alimenta el GSI `transactionNumber-index`. */
+    transactionNumber: string;
+
+    /** Epoch ms — cuándo cerró la transacción exitosa en el conector. */
+    occurredAt: number;
+}

package/src/benefitCenter/enums/BenefitPaymentErrorCodeEnum.ts

@@ -0,0 +1,17 @@
+/**
+ * Códigos canónicos de error del pago. Cada conector mapea sus errores internos
+ * a esta lista antes de devolverle al marketplace. Solo se popula cuando
+ * `status === REJECTED` (o `PENDING` si el conector quiere comunicar la causa
+ * de la espera).
+ *
+ * Lista canónica documentada en doc Fase 2 §6.5.
+ */
+export enum BenefitPaymentErrorCodeEnum {
+    LEAF_NOT_FOUND = "LEAF_NOT_FOUND",
+    LEAF_DISABLED = "LEAF_DISABLED",
+    LEAF_NOT_VISIBLE = "LEAF_NOT_VISIBLE",
+    PRODUCT_NOT_FOUND = "PRODUCT_NOT_FOUND",
+    PROVIDER_REJECTED = "PROVIDER_REJECTED",
+    PROVIDER_TIMEOUT = "PROVIDER_TIMEOUT",
+    INSUFFICIENT_FUNDS = "INSUFFICIENT_FUNDS",
+}

package/src/benefitCenter/enums/BenefitPaymentStatusEnum.ts

@@ -0,0 +1,12 @@
+/**
+ * Estado del pago devuelto por el marketplace al procesador.
+ *
+ * Lo decide el conector (STP, Multicomm, donaciones, etc.) en su `/pay/standard`;
+ * el marketplace lo reenvía sin transformar. APPROVED dispara el upsert in-process
+ * del favorito (ver doc Fase 2 §4.3); REJECTED y PENDING no.
+ */
+export enum BenefitPaymentStatusEnum {
+    APPROVED = "APPROVED",
+    REJECTED = "REJECTED",
+    PENDING = "PENDING",
+}

package/src/benefitCenter/index.ts

@@ -9,6 +9,8 @@ export * from "./enums/BannerLocaleEnum";
 export * from "./enums/BannerScreenEnum";
 export * from "./enums/BannerTemplateVariantEnum";
 export * from "./enums/FavoriteDisabledReasonEnum";
+export * from "./enums/BenefitPaymentStatusEnum";
+export * from "./enums/BenefitPaymentErrorCodeEnum";
 
 //DTOs
 export * from "./dtos/BenefitItem";
@@ -51,3 +53,8 @@ export * from "./dtos/FavoriteValidationResult";
 export * from "./dtos/FavoriteDetailResponse";
 export * from "./dtos/FavoriteUpdateRequest";
 export * from "./dtos/FavoriteReorderRequest";
+//Phase 2 — Payments + favorite upsert context (v3.9.0)
+export * from "./dtos/BenefitPaymentRequest";
+export * from "./dtos/BenefitPaymentResponse";
+export * from "./dtos/AuthorizeBenefitsMarketplaceTransactionRequest";
+export * from "./dtos/FavoriteUpsertContext";