@fiado/type-kit 3.521.0 → 3.522.0

package/src/messageMoments/constants/MessageMomentCatalog.ts

@@ -0,0 +1,91 @@
+import { MessageMomentEnum } from '../enums/MessageMomentEnum';
+import { MessageMomentBlockEnum } from '../enums/MessageMomentBlockEnum';
+import {
+    CREDIT_MOMENT_ALWAYS_VARIABLES,
+    CREDIT_MOMENT_CONDITIONAL_VARIABLES,
+    MOMENT_SPECIFIC_VARIABLES,
+    OTP_MOMENT_VARIABLES,
+} from './MessageMomentVariables';
+
+/** Quién es un momento: su id de ficha, su plantilla, su bloque y las variables que emite. */
+export interface MessageMomentIdentity {
+    /** Id del momento (`PM-001`); en minúsculas es el prefijo de sus keys en la ficha. */
+    templateId: string;
+    messageType: MessageMomentEnum;
+    /** Bloque del árbol. La ficha lo puede pisar; este es el respaldo cuando su key falta. */
+    blockId: MessageMomentBlockEnum;
+    alwaysVariables: readonly string[];
+    conditionalVariables: readonly string[];
+}
+
+/** Un momento del crédito: las variables del crédito más las que solo emite él. */
+function creditMoment(templateId: string, messageType: MessageMomentEnum, blockId: MessageMomentBlockEnum): MessageMomentIdentity {
+    return {
+        templateId,
+        messageType,
+        blockId,
+        alwaysVariables: [...CREDIT_MOMENT_ALWAYS_VARIABLES, ...(MOMENT_SPECIFIC_VARIABLES[messageType] ?? [])],
+        conditionalVariables: CREDIT_MOMENT_CONDITIONAL_VARIABLES,
+    };
+}
+
+const B = MessageMomentBlockEnum;
+const M = MessageMomentEnum;
+
+/** Los 38 momentos EN ORDEN de recorrido del crédito. `PM-071` apunta al OTP de plataforma. */
+export const MESSAGE_MOMENT_CATALOG: readonly MessageMomentIdentity[] = [
+    creditMoment('PM-001', M.APPLICATION_APPROVED, B.ORIGINATION),
+    creditMoment('PM-002', M.APPLICATION_REJECTED, B.ORIGINATION),
+    creditMoment('PM-003', M.DOWN_PAYMENT_RECEIVED, B.ORIGINATION),
+    creditMoment('PM-004', M.CONTRACT_SIGNED, B.ORIGINATION),
+    creditMoment('PM-005', M.MDM_ACTIVATED, B.ORIGINATION),
+    creditMoment('PM-010', M.REMINDER_T_MINUS_3, B.REMINDERS),
+    creditMoment('PM-011', M.REMINDER_T_MINUS_2, B.REMINDERS),
+    creditMoment('PM-012', M.REMINDER_T_MINUS_1, B.REMINDERS),
+    creditMoment('PM-020', M.PAYMENT_APPLIED, B.PAYMENTS),
+    creditMoment('PM-021', M.PAYMENT_PARTIAL, B.PAYMENTS),
+    creditMoment('PM-022', M.PAYMENT_REJECTED, B.PAYMENTS),
+    creditMoment('PM-023', M.PAYMENT_EARLY, B.PAYMENTS),
+    creditMoment('PM-030', M.COLLECTION_T_PLUS_1, B.COLLECTIONS),
+    creditMoment('PM-031', M.COLLECTION_T_PLUS_3, B.COLLECTIONS),
+    creditMoment('PM-032', M.COLLECTION_T_PLUS_5, B.COLLECTIONS),
+    creditMoment('PM-033', M.COLLECTION_T_PLUS_15, B.COLLECTIONS),
+    creditMoment('PM-034', M.COLLECTION_T_PLUS_60_BUREAU, B.COLLECTIONS),
+    creditMoment('PM-040', M.MDM_LOCK_APPLIED, B.DEVICE_LOCK),
+    creditMoment('PM-041', M.MDM_UNLOCKED, B.DEVICE_LOCK),
+    creditMoment('PM-050', M.F1_RESTRUCTURE_PROPOSED, B.EXCEPTIONS),
+    creditMoment('PM-051', M.F1_RESTRUCTURE_APPROVED, B.EXCEPTIONS),
+    creditMoment('PM-052', M.F2_CANCELLATION_PROCESSED, B.EXCEPTIONS),
+    creditMoment('PM-053', M.F3_DISCOUNT_APPLIED, B.EXCEPTIONS),
+    creditMoment('PM-054', M.F4_CORRECTION_APPLIED, B.EXCEPTIONS),
+    creditMoment('PM-055', M.F5_FRAUD_CONFIRMED, B.EXCEPTIONS),
+    creditMoment('PM-056', M.PAYMENT_PROMISE_REGISTERED, B.EXCEPTIONS),
+    creditMoment('PM-057', M.PAYMENT_PROMISE_BROKEN, B.EXCEPTIONS),
+    creditMoment('PM-060', M.LAST_INSTALLMENT, B.CLOSURE),
+    creditMoment('PM-061', M.SETTLEMENT_COMPLETED, B.CLOSURE),
+    creditMoment('PM-062', M.SETTLEMENT_BUREAU_NOTICE, B.CLOSURE),
+    creditMoment('PM-063', M.REENTRY_INVITATION, B.CLOSURE),
+    creditMoment('PM-070', M.APP_WELCOME, B.SERVICE),
+    {
+        templateId: 'PM-071',
+        messageType: M.OTP_CODE,
+        blockId: B.SERVICE,
+        alwaysVariables: OTP_MOMENT_VARIABLES,
+        conditionalVariables: [],
+    },
+    creditMoment('PM-072', M.SECURITY_ALERT, B.SERVICE),
+    creditMoment('PM-073', M.PROFILE_CHANGE_CONFIRMED, B.SERVICE),
+    creditMoment('PM-074', M.MONTHLY_STATEMENT, B.SERVICE),
+    creditMoment('PM-075', M.CAT_TERMS_NOTICE, B.SERVICE),
+    creditMoment('PM-076', M.PRIVACY_ARCO_NOTICE, B.SERVICE),
+];
+
+/** La identidad por id de ficha (`PM-030`). */
+export const momentByTemplateId: ReadonlyMap<string, MessageMomentIdentity> = new Map(
+    MESSAGE_MOMENT_CATALOG.map((moment) => [moment.templateId, moment]),
+);
+
+/** La identidad por messageType de la plantilla. */
+export const momentByMessageType: ReadonlyMap<string, MessageMomentIdentity> = new Map(
+    MESSAGE_MOMENT_CATALOG.map((moment) => [moment.messageType, moment]),
+);

package/src/messageMoments/constants/MessageMomentVariables.ts

@@ -0,0 +1,42 @@
+import { MessageMomentEnum } from '../enums/MessageMomentEnum';
+
+/** Variables del crédito que el emisor manda siempre con valor. */
+export const CREDIT_MOMENT_ALWAYS_VARIABLES: readonly string[] = [
+    'cliente_nombre',
+    'credito_id',
+    'monto_credito',
+    'monto_enganche',
+    'cuota_total',
+    'saldo_actual',
+];
+
+/** Variables que dependen del dato: viajan siempre, con `""` cuando no aplican. */
+export const CREDIT_MOMENT_CONDITIONAL_VARIABLES: readonly string[] = [
+    'tienda',
+    'equipo',
+    'cat',
+    'fecha_primer_venc',
+    'fecha_liquidacion',
+    'dias_atraso',
+    'cuota_n',
+    'monto',
+    'saldo_pendiente',
+    'fecha_venc',
+    'proxima_venc',
+    'folio',
+    'forma_pago',
+];
+
+/** El OTP lo arma messages-business: llena `code` y su alias posicional `var1`. */
+export const OTP_MOMENT_VARIABLES: readonly string[] = ['code', 'var1'];
+
+/** Lo que el plan nuevo de una reestructura le dice al cliente. */
+export const RESTRUCTURE_MOMENT_VARIABLES: readonly string[] = ['plazo_nuevo', 'cuota_nueva', 'saldo_nuevo'];
+
+/** Variables que solo emite su momento, siempre con valor. */
+export const MOMENT_SPECIFIC_VARIABLES: Readonly<Partial<Record<MessageMomentEnum, readonly string[]>>> = {
+    [MessageMomentEnum.F1_RESTRUCTURE_PROPOSED]: RESTRUCTURE_MOMENT_VARIABLES,
+    [MessageMomentEnum.F1_RESTRUCTURE_APPROVED]: RESTRUCTURE_MOMENT_VARIABLES,
+    [MessageMomentEnum.PROFILE_CHANGE_CONFIRMED]: ['campo_cambiado'],
+    [MessageMomentEnum.MONTHLY_STATEMENT]: ['fecha_corte'],
+};

package/src/messageMoments/constants/TemplatePlaceholder.ts

@@ -0,0 +1,3 @@
+/** Un placeholder doble `{{monto}}` o simple `{monto}`, igual que `applyVariables` de messages-business. La doble va primero.
+ * Es global y compartido: úsalo solo con `matchAll`/`replace`; para `.test()` o `.exec()` crea `new RegExp(TEMPLATE_PLACEHOLDER_PATTERN.source)`. */
+export const TEMPLATE_PLACEHOLDER_PATTERN = /\{\{(\w+)\}\}|\{(\w+)\}/g;

package/src/messageMoments/enums/MessageMomentBlockEnum.ts

@@ -0,0 +1,11 @@
+/** Bloques del árbol de la pantalla; el mismo vocabulario que la key `pm-xxx.block` de la ficha. */
+export enum MessageMomentBlockEnum {
+    ORIGINATION = 'origination',
+    REMINDERS = 'reminders',
+    PAYMENTS = 'payments',
+    COLLECTIONS = 'collections',
+    DEVICE_LOCK = 'deviceLock',
+    EXCEPTIONS = 'exceptions',
+    CLOSURE = 'closure',
+    SERVICE = 'service',
+}

package/src/messageMoments/enums/MessageMomentEnum.ts

@@ -0,0 +1,50 @@
+/** Los momentos de mensaje que el emisor sabe entregar. Es el messageType de la plantilla. */
+export enum MessageMomentEnum {
+    OTP_CODE = 'OTP_CODE',
+    ISSUED_CARD_SMS = 'ISSUED_CARD_SMS',
+
+    APPLICATION_APPROVED = 'APPLICATION_APPROVED',
+    APPLICATION_REJECTED = 'APPLICATION_REJECTED',
+    DOWN_PAYMENT_RECEIVED = 'DOWN_PAYMENT_RECEIVED',
+    CONTRACT_SIGNED = 'CONTRACT_SIGNED',
+    MDM_ACTIVATED = 'MDM_ACTIVATED',
+
+    REMINDER_T_MINUS_3 = 'REMINDER_T_MINUS_3',
+    REMINDER_T_MINUS_2 = 'REMINDER_T_MINUS_2',
+    REMINDER_T_MINUS_1 = 'REMINDER_T_MINUS_1',
+
+    PAYMENT_APPLIED = 'PAYMENT_APPLIED',
+    PAYMENT_PARTIAL = 'PAYMENT_PARTIAL',
+    PAYMENT_REJECTED = 'PAYMENT_REJECTED',
+    PAYMENT_EARLY = 'PAYMENT_EARLY',
+
+    COLLECTION_T_PLUS_1 = 'COLLECTION_T_PLUS_1',
+    COLLECTION_T_PLUS_3 = 'COLLECTION_T_PLUS_3',
+    COLLECTION_T_PLUS_5 = 'COLLECTION_T_PLUS_5',
+    COLLECTION_T_PLUS_15 = 'COLLECTION_T_PLUS_15',
+    COLLECTION_T_PLUS_60_BUREAU = 'COLLECTION_T_PLUS_60_BUREAU',
+
+    MDM_LOCK_APPLIED = 'MDM_LOCK_APPLIED',
+    MDM_UNLOCKED = 'MDM_UNLOCKED',
+
+    F1_RESTRUCTURE_PROPOSED = 'F1_RESTRUCTURE_PROPOSED',
+    F1_RESTRUCTURE_APPROVED = 'F1_RESTRUCTURE_APPROVED',
+    F2_CANCELLATION_PROCESSED = 'F2_CANCELLATION_PROCESSED',
+    F3_DISCOUNT_APPLIED = 'F3_DISCOUNT_APPLIED',
+    F4_CORRECTION_APPLIED = 'F4_CORRECTION_APPLIED',
+    F5_FRAUD_CONFIRMED = 'F5_FRAUD_CONFIRMED',
+    PAYMENT_PROMISE_REGISTERED = 'PAYMENT_PROMISE_REGISTERED',
+    PAYMENT_PROMISE_BROKEN = 'PAYMENT_PROMISE_BROKEN',
+
+    LAST_INSTALLMENT = 'LAST_INSTALLMENT',
+    SETTLEMENT_COMPLETED = 'SETTLEMENT_COMPLETED',
+    SETTLEMENT_BUREAU_NOTICE = 'SETTLEMENT_BUREAU_NOTICE',
+    REENTRY_INVITATION = 'REENTRY_INVITATION',
+
+    APP_WELCOME = 'APP_WELCOME',
+    SECURITY_ALERT = 'SECURITY_ALERT',
+    PROFILE_CHANGE_CONFIRMED = 'PROFILE_CHANGE_CONFIRMED',
+    MONTHLY_STATEMENT = 'MONTHLY_STATEMENT',
+    CAT_TERMS_NOTICE = 'CAT_TERMS_NOTICE',
+    PRIVACY_ARCO_NOTICE = 'PRIVACY_ARCO_NOTICE',
+}

package/src/messageMoments/index.ts

@@ -0,0 +1,5 @@
+export * from './enums/MessageMomentEnum';
+export * from './enums/MessageMomentBlockEnum';
+export * from './constants/MessageMomentVariables';
+export * from './constants/MessageMomentCatalog';
+export * from './constants/TemplatePlaceholder';

package/src/messagesConnector/dtos/SendMessageRequest.ts

@@ -29,4 +29,6 @@ export class SendMessageRequest {
     @Expose() @IsOptional() @IsUUID() referenceMessageId?: string;
     @Expose() @IsOptional() @IsString() transactionNumber?: string;
     @Expose() @IsOptional() @IsEnum(OtpMessagePurposeEnum) purpose?: OtpMessagePurposeEnum;
+    // Tenant emisor: decide plantilla e identidad de envío. Sin él messages-business cae a FIADO.
+    @Expose() @IsOptional() @IsString() @IsNotEmpty() tenantId?: string;
 }

package/src/messagesConnector/dtos/TemplateMessageCreateRequest.ts

@@ -68,4 +68,10 @@ export class TemplateMessageCreateRequest {
     @IsArray()
     @IsString({ each: true })
     slotVariables?: string[];
+
+    /** Quién hizo el cambio. Lo pone el proxy de loan-config con el operador autenticado. */
+    @Expose()
+    @IsOptional()
+    @IsString()
+    updatedBy?: string;
 }

package/src/messagesConnector/dtos/TemplateMessageUpdateRequest.ts

@@ -49,4 +49,10 @@ export class TemplateMessageUpdateRequest {
     @IsArray()
     @IsString({ each: true })
     slotVariables?: string[];
+
+    /** Quién hizo el cambio. Lo pone el proxy de loan-config con el operador autenticado. */
+    @Expose()
+    @IsOptional()
+    @IsString()
+    updatedBy?: string;
 }

package/src/notificationMessages/constants/MomentTemplateLimits.ts

@@ -0,0 +1,5 @@
+/** Tope de momentos por lectura en lote: el de BatchGetItem de DynamoDB. */
+export const MOMENT_TEMPLATE_LIST_MAX = 100;
+
+/** Forma de un messageType de momento: mayúsculas, dígitos y guion bajo. */
+export const MOMENT_MESSAGE_TYPE_PATTERN = /^[A-Z0-9_]+$/;

package/src/notificationMessages/dtos/MomentTemplateListResponse.ts

@@ -0,0 +1,9 @@
+import { Expose, Type } from 'class-transformer';
+import { MomentTemplateResponse } from './MomentTemplateResponse';
+
+/** Respuesta del listado en lote: solo vienen las plantillas que existen. */
+export class MomentTemplateListResponse {
+    @Expose()
+    @Type(() => MomentTemplateResponse)
+    items!: MomentTemplateResponse[];
+}

package/src/notificationMessages/dtos/MomentTemplateResponse.ts

@@ -0,0 +1,34 @@
+import { Expose } from 'class-transformer';
+import { NotificationTemplateOriginEnum } from '../enums/NotificationTemplateOriginEnum';
+
+/** Una plantilla push de momento tal como la devuelve notification-messages-business. */
+export class MomentTemplateResponse {
+    @Expose()
+    messageType!: string;
+
+    /** Id de la fila: `ES_<messageType>`. */
+    @Expose()
+    templateId!: string;
+
+    @Expose()
+    title!: string;
+
+    @Expose()
+    body!: string;
+
+    @Expose()
+    templateVariables!: string[];
+
+    /** Ausente cuando la fila existe pero es del wallet. */
+    @Expose()
+    origin?: NotificationTemplateOriginEnum;
+
+    @Expose()
+    updatedAt?: number;
+
+    @Expose()
+    createdBy?: string;
+
+    @Expose()
+    updatedBy?: string;
+}

package/src/notificationMessages/dtos/MomentTemplateUpsertRequest.ts

@@ -0,0 +1,24 @@
+import { Expose } from 'class-transformer';
+import { IsNotEmpty, IsString, Matches } from 'class-validator';
+
+const NOT_BLANK = /\S/;
+
+/** Body de PUT /private/moment-templates/{messageType}: el texto de la push y quién lo escribió. */
+export class MomentTemplateUpsertRequest {
+    @Expose()
+    @IsString()
+    @IsNotEmpty()
+    @Matches(NOT_BLANK)
+    title!: string;
+
+    @Expose()
+    @IsString()
+    @IsNotEmpty()
+    @Matches(NOT_BLANK)
+    body!: string;
+
+    @Expose()
+    @IsString()
+    @IsNotEmpty()
+    updatedBy!: string;
+}

package/src/notificationMessages/dtos/NotificationQueueMessageRequest.ts

@@ -5,4 +5,6 @@ export class NotificationQueueMessageRequest {
     broadcast?: boolean; // Si el mensaje es masivo o no (a todos los dispositivos registrados)
     destinations: QueueMessageDestination[]; // Grupo de destinos (directory y variables)
     data?: any; // Informacion adicional a enviar al destino
-}
+    /** Llave de idempotencia del productor; con ella el consumidor no repite la push por destino. */
+    eventId?: string;
+}

package/src/notificationMessages/enums/NotificationTemplateOriginEnum.ts

@@ -0,0 +1,4 @@
+/** Quién es dueño de una fila de NotificationTemplates_GT. Sin origen, la fila es del wallet. */
+export enum NotificationTemplateOriginEnum {
+    MESSAGING_MOMENT = 'MESSAGING_MOMENT',
+}

package/src/notificationMessages/index.ts

@@ -2,7 +2,11 @@ export * from './dtos/NotificationQueueMessageRequest';
 export * from './dtos/QueueMessageDestination';
 export * from './dtos/QueueMessageVariableValues';
 export * from './dtos/NotificationTemplate';
-
+export * from './dtos/MomentTemplateUpsertRequest';
+export * from './dtos/MomentTemplateResponse';
+export * from './dtos/MomentTemplateListResponse';
+export * from './constants/MomentTemplateLimits';
 
 export * from "./enums/NotificationId";
-export * from "./enums/NotificationType";
+export * from "./enums/NotificationType";
+export * from './enums/NotificationTemplateOriginEnum';

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

@@ -1,4 +1,5 @@
 import type { ProductCategoryEnum } from '../../../retailCatalog/enums/ProductCategoryEnum';
+import type { StoreMixCategoryEnum } from '../../enums/StoreMixCategoryEnum';
 
 /** Colocación de una semana de 7 días; ISO, ambos extremos incluidos. */
 export interface StoreWeeklyPlacement {
@@ -10,7 +11,8 @@ export interface StoreWeeklyPlacement {
 
 /** Lo vendido de una categoría en la ventana. `category: null` = venta sin líneas de producto. */
 export interface StoreCategoryMixEntry {
-    category: ProductCategoryEnum | null;
+    /** Acepta ProductCategoryEnum para no romper a quien ya lo asigna; SERVICE solo existe en StoreMixCategoryEnum. */
+    category: StoreMixCategoryEnum | ProductCategoryEnum | null;
     units: number;
     placedCents: number;
 }

package/src/retailWizard/enums/StoreMixCategoryEnum.ts

@@ -0,0 +1,9 @@
+/** Categoría del mix de una tienda: las de producto (mismos strings que ProductCategoryEnum) más SERVICE. */
+export enum StoreMixCategoryEnum {
+    PHONE = 'PHONE',
+    SIM = 'SIM',
+    MODEM = 'MODEM',
+    ACCESSORY = 'ACCESSORY',
+    BUNDLE = 'BUNDLE',
+    SERVICE = 'SERVICE',
+}

package/src/retailWizard/index.ts

@@ -165,6 +165,7 @@ export * from './dtos/responses/BackofficeSellerTableResponse';
 export * from './dtos/responses/BackofficeCustomerTableResponse';
 export * from './enums/StoreKindEnum';
 export * from './dtos/responses/BackofficeStoreTableResponse';
+export * from './enums/StoreMixCategoryEnum';
 export * from './dtos/responses/BackofficeStoreDetailResponse';
 
 // Contratos de eventos (PascalCase + sufijo V1)