@fiado/type-kit 3.590.0 → 3.591.0

package/_test_/unit/messageMoments/MessageMomentCatalog.test.ts

@@ -8,20 +8,68 @@ import {
     MessageMomentBlockEnum,
     MessageMomentEnum,
     OTP_MOMENT_VARIABLES,
+    REFERRAL_BONUS_ALWAYS_VARIABLES,
+    REFERRAL_BONUS_CONDITIONAL_VARIABLES,
+    REFERRAL_COUPON_ALWAYS_VARIABLES,
+    REFERRAL_COUPON_CONDITIONAL_VARIABLES,
     RESTRUCTURE_MOMENT_VARIABLES,
     TEMPLATE_PLACEHOLDER_PATTERN,
     momentByMessageType,
     momentByTemplateId,
 } from '../../../src/messageMoments/index';
 
+const NON_CREDIT_MOMENTS = new Set<string>([
+    MessageMomentEnum.OTP_CODE,
+    MessageMomentEnum.REFERRAL_BONUS_CREDITED,
+    MessageMomentEnum.REFERRAL_COUPON_ISSUED,
+]);
+
 describe('MESSAGE_MOMENT_CATALOG', () => {
-    it('trae los 38 momentos del recorrido del crédito', () => {
-        expect(MESSAGE_MOMENT_CATALOG).toHaveLength(38);
+    it('trae los 38 momentos del crédito más los 2 de referidos', () => {
+        expect(MESSAGE_MOMENT_CATALOG).toHaveLength(40);
     });
 
     it('ni el templateId ni el messageType se repiten', () => {
-        expect(momentByTemplateId.size).toBe(38);
-        expect(momentByMessageType.size).toBe(38);
+        expect(momentByTemplateId.size).toBe(40);
+        expect(momentByMessageType.size).toBe(40);
+    });
+
+    it('los momentos de referidos cierran el catálogo, en su bloque', () => {
+        expect(MESSAGE_MOMENT_CATALOG.slice(-2).map((m) => [m.templateId, m.messageType, m.blockId])).toEqual([
+            ['PM-080', MessageMomentEnum.REFERRAL_BONUS_CREDITED, MessageMomentBlockEnum.REFERRALS],
+            ['PM-081', MessageMomentEnum.REFERRAL_COUPON_ISSUED, MessageMomentBlockEnum.REFERRALS],
+        ]);
+        expect(MessageMomentBlockEnum.REFERRALS).toBe('referrals');
+    });
+
+    it('el premio abonado ofrece cliente y monto, y el nombre del referido cuando se conoce', () => {
+        const bonus = momentByTemplateId.get('PM-080');
+        expect(REFERRAL_BONUS_ALWAYS_VARIABLES).toEqual(['cliente_nombre', 'monto']);
+        expect(REFERRAL_BONUS_CONDITIONAL_VARIABLES).toEqual(['referido_nombre']);
+        expect(bonus?.alwaysVariables).toEqual(REFERRAL_BONUS_ALWAYS_VARIABLES);
+        expect(bonus?.conditionalVariables).toEqual(REFERRAL_BONUS_CONDITIONAL_VARIABLES);
+    });
+
+    it('el cupón emitido ofrece código, descuento y vigencia, y la tienda cuando no aplica en todas', () => {
+        const coupon = momentByTemplateId.get('PM-081');
+        expect(REFERRAL_COUPON_ALWAYS_VARIABLES).toEqual(['cliente_nombre', 'codigo', 'descuento', 'vigencia']);
+        expect(REFERRAL_COUPON_CONDITIONAL_VARIABLES).toEqual(['tienda']);
+        expect(coupon?.alwaysVariables).toEqual(REFERRAL_COUPON_ALWAYS_VARIABLES);
+        expect(coupon?.conditionalVariables).toEqual(REFERRAL_COUPON_CONDITIONAL_VARIABLES);
+    });
+
+    it('los momentos de referidos no ofrecen variables del crédito', () => {
+        const credit = new Set([...CREDIT_MOMENT_ALWAYS_VARIABLES, ...CREDIT_MOMENT_CONDITIONAL_VARIABLES].filter((n) => n !== 'cliente_nombre' && n !== 'monto' && n !== 'tienda'));
+        for (const moment of MESSAGE_MOMENT_CATALOG.filter((m) => m.blockId === MessageMomentBlockEnum.REFERRALS)) {
+            expect([...moment.alwaysVariables, ...moment.conditionalVariables].filter((n) => credit.has(n))).toEqual([]);
+        }
+    });
+
+    it('en ningún momento una variable es siempre y condicional a la vez', () => {
+        for (const moment of MESSAGE_MOMENT_CATALOG) {
+            const always = new Set(moment.alwaysVariables);
+            expect(moment.conditionalVariables.filter((n) => always.has(n))).toEqual([]);
+        }
     });
 
     it('todo templateId tiene la forma PM-NNN', () => {
@@ -47,8 +95,8 @@ describe('MESSAGE_MOMENT_CATALOG', () => {
         expect(otp?.conditionalVariables).toEqual([]);
     });
 
-    it('los demás momentos ofrecen las variables del crédito más las propias del momento', () => {
-        for (const moment of MESSAGE_MOMENT_CATALOG.filter((m) => m.messageType !== MessageMomentEnum.OTP_CODE)) {
+    it('los momentos del crédito ofrecen sus variables más las propias del momento', () => {
+        for (const moment of MESSAGE_MOMENT_CATALOG.filter((m) => !NON_CREDIT_MOMENTS.has(m.messageType))) {
             const own = MOMENT_SPECIFIC_VARIABLES[moment.messageType] ?? [];
             expect(moment.alwaysVariables).toEqual([...CREDIT_MOMENT_ALWAYS_VARIABLES, ...own]);
             expect(moment.conditionalVariables).toEqual(CREDIT_MOMENT_CONDITIONAL_VARIABLES);
@@ -70,7 +118,7 @@ describe('MESSAGE_MOMENT_CATALOG', () => {
     it('una variable propia no se cuela en otro momento', () => {
         const own = new Set(Object.values(MOMENT_SPECIFIC_VARIABLES).flat());
         const owners = new Set(Object.keys(MOMENT_SPECIFIC_VARIABLES));
-        for (const moment of MESSAGE_MOMENT_CATALOG.filter((m) => !owners.has(m.messageType))) {
+        for (const moment of MESSAGE_MOMENT_CATALOG.filter((m) => !owners.has(m.messageType) && !NON_CREDIT_MOMENTS.has(m.messageType))) {
             expect(moment.alwaysVariables.filter((name) => own.has(name))).toEqual([]);
         }
     });

package/bin/messageMoments/constants/MessageMomentCatalog.d.ts

@@ -10,7 +10,7 @@ export interface MessageMomentIdentity {
     alwaysVariables: readonly string[];
     conditionalVariables: readonly string[];
 }
-/** Los 38 momentos EN ORDEN de recorrido del crédito. `PM-071` apunta al OTP de plataforma. */
+/** Los 38 momentos del crédito EN ORDEN de recorrido y al final los de referidos. `PM-071` apunta al OTP de plataforma. */
 export declare const MESSAGE_MOMENT_CATALOG: readonly MessageMomentIdentity[];
 /** La identidad por id de ficha (`PM-030`). */
 export declare const momentByTemplateId: ReadonlyMap<string, MessageMomentIdentity>;

package/bin/messageMoments/constants/MessageMomentCatalog.js

@@ -14,9 +14,13 @@ function creditMoment(templateId, messageType, blockId) {
         conditionalVariables: MessageMomentVariables_1.CREDIT_MOMENT_CONDITIONAL_VARIABLES,
     };
 }
+/** Un momento fuera del crédito: solo las variables que su emisor manda. */
+function standaloneMoment(templateId, messageType, blockId, alwaysVariables, conditionalVariables = []) {
+    return { templateId, messageType, blockId, alwaysVariables, conditionalVariables };
+}
 const B = MessageMomentBlockEnum_1.MessageMomentBlockEnum;
 const M = MessageMomentEnum_1.MessageMomentEnum;
-/** Los 38 momentos EN ORDEN de recorrido del crédito. `PM-071` apunta al OTP de plataforma. */
+/** Los 38 momentos del crédito EN ORDEN de recorrido y al final los de referidos. `PM-071` apunta al OTP de plataforma. */
 exports.MESSAGE_MOMENT_CATALOG = [
     creditMoment('PM-001', M.APPLICATION_APPROVED, B.ORIGINATION),
     creditMoment('PM-002', M.APPLICATION_REJECTED, B.ORIGINATION),
@@ -50,18 +54,14 @@ exports.MESSAGE_MOMENT_CATALOG = [
     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: MessageMomentVariables_1.OTP_MOMENT_VARIABLES,
-        conditionalVariables: [],
-    },
+    standaloneMoment('PM-071', M.OTP_CODE, B.SERVICE, MessageMomentVariables_1.OTP_MOMENT_VARIABLES),
     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),
+    standaloneMoment('PM-080', M.REFERRAL_BONUS_CREDITED, B.REFERRALS, MessageMomentVariables_1.REFERRAL_BONUS_ALWAYS_VARIABLES, MessageMomentVariables_1.REFERRAL_BONUS_CONDITIONAL_VARIABLES),
+    standaloneMoment('PM-081', M.REFERRAL_COUPON_ISSUED, B.REFERRALS, MessageMomentVariables_1.REFERRAL_COUPON_ALWAYS_VARIABLES, MessageMomentVariables_1.REFERRAL_COUPON_CONDITIONAL_VARIABLES),
 ];
 /** La identidad por id de ficha (`PM-030`). */
 exports.momentByTemplateId = new Map(exports.MESSAGE_MOMENT_CATALOG.map((moment) => [moment.templateId, moment]));

package/bin/messageMoments/constants/MessageMomentVariables.d.ts

@@ -5,6 +5,14 @@ export declare const CREDIT_MOMENT_ALWAYS_VARIABLES: readonly string[];
 export declare const CREDIT_MOMENT_CONDITIONAL_VARIABLES: readonly string[];
 /** El OTP lo arma messages-business: llena `code` y su alias posicional `var1`. */
 export declare const OTP_MOMENT_VARIABLES: readonly string[];
+/** Premio de referido abonado a la cuenta PCF: a quién y cuánto. */
+export declare const REFERRAL_BONUS_ALWAYS_VARIABLES: readonly string[];
+/** El referido solo se nombra cuando el premio es de quien recomendó. */
+export declare const REFERRAL_BONUS_CONDITIONAL_VARIABLES: readonly string[];
+/** Cupón de referido emitido: el código, su descuento ya formateado y hasta cuándo vale. */
+export declare const REFERRAL_COUPON_ALWAYS_VARIABLES: readonly string[];
+/** La tienda solo viaja cuando el cupón no vale en todas. */
+export declare const REFERRAL_COUPON_CONDITIONAL_VARIABLES: readonly string[];
 /** Lo que el plan nuevo de una reestructura le dice al cliente. */
 export declare const RESTRUCTURE_MOMENT_VARIABLES: readonly string[];
 /** Variables que solo emite su momento, siempre con valor. */

package/bin/messageMoments/constants/MessageMomentVariables.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.MOMENT_SPECIFIC_VARIABLES = exports.RESTRUCTURE_MOMENT_VARIABLES = exports.OTP_MOMENT_VARIABLES = exports.CREDIT_MOMENT_CONDITIONAL_VARIABLES = exports.CREDIT_MOMENT_ALWAYS_VARIABLES = void 0;
+exports.MOMENT_SPECIFIC_VARIABLES = exports.RESTRUCTURE_MOMENT_VARIABLES = exports.REFERRAL_COUPON_CONDITIONAL_VARIABLES = exports.REFERRAL_COUPON_ALWAYS_VARIABLES = exports.REFERRAL_BONUS_CONDITIONAL_VARIABLES = exports.REFERRAL_BONUS_ALWAYS_VARIABLES = exports.OTP_MOMENT_VARIABLES = exports.CREDIT_MOMENT_CONDITIONAL_VARIABLES = exports.CREDIT_MOMENT_ALWAYS_VARIABLES = void 0;
 const MessageMomentEnum_1 = require("../enums/MessageMomentEnum");
 /** Variables del crédito que el emisor manda siempre con valor. */
 exports.CREDIT_MOMENT_ALWAYS_VARIABLES = [
@@ -29,6 +29,14 @@ exports.CREDIT_MOMENT_CONDITIONAL_VARIABLES = [
 ];
 /** El OTP lo arma messages-business: llena `code` y su alias posicional `var1`. */
 exports.OTP_MOMENT_VARIABLES = ['code', 'var1'];
+/** Premio de referido abonado a la cuenta PCF: a quién y cuánto. */
+exports.REFERRAL_BONUS_ALWAYS_VARIABLES = ['cliente_nombre', 'monto'];
+/** El referido solo se nombra cuando el premio es de quien recomendó. */
+exports.REFERRAL_BONUS_CONDITIONAL_VARIABLES = ['referido_nombre'];
+/** Cupón de referido emitido: el código, su descuento ya formateado y hasta cuándo vale. */
+exports.REFERRAL_COUPON_ALWAYS_VARIABLES = ['cliente_nombre', 'codigo', 'descuento', 'vigencia'];
+/** La tienda solo viaja cuando el cupón no vale en todas. */
+exports.REFERRAL_COUPON_CONDITIONAL_VARIABLES = ['tienda'];
 /** Lo que el plan nuevo de una reestructura le dice al cliente. */
 exports.RESTRUCTURE_MOMENT_VARIABLES = ['plazo_nuevo', 'cuota_nueva', 'saldo_nuevo'];
 /** Variables que solo emite su momento, siempre con valor. */

package/bin/messageMoments/enums/MessageMomentBlockEnum.d.ts

@@ -7,5 +7,6 @@ export declare enum MessageMomentBlockEnum {
     DEVICE_LOCK = "deviceLock",
     EXCEPTIONS = "exceptions",
     CLOSURE = "closure",
-    SERVICE = "service"
+    SERVICE = "service",
+    REFERRALS = "referrals"
 }

package/bin/messageMoments/enums/MessageMomentBlockEnum.js

@@ -12,4 +12,5 @@ var MessageMomentBlockEnum;
     MessageMomentBlockEnum["EXCEPTIONS"] = "exceptions";
     MessageMomentBlockEnum["CLOSURE"] = "closure";
     MessageMomentBlockEnum["SERVICE"] = "service";
+    MessageMomentBlockEnum["REFERRALS"] = "referrals";
 })(MessageMomentBlockEnum || (exports.MessageMomentBlockEnum = MessageMomentBlockEnum = {}));

package/bin/messageMoments/enums/MessageMomentEnum.d.ts

@@ -38,5 +38,7 @@ export declare enum MessageMomentEnum {
     PROFILE_CHANGE_CONFIRMED = "PROFILE_CHANGE_CONFIRMED",
     MONTHLY_STATEMENT = "MONTHLY_STATEMENT",
     CAT_TERMS_NOTICE = "CAT_TERMS_NOTICE",
-    PRIVACY_ARCO_NOTICE = "PRIVACY_ARCO_NOTICE"
+    PRIVACY_ARCO_NOTICE = "PRIVACY_ARCO_NOTICE",
+    REFERRAL_BONUS_CREDITED = "REFERRAL_BONUS_CREDITED",
+    REFERRAL_COUPON_ISSUED = "REFERRAL_COUPON_ISSUED"
 }

package/bin/messageMoments/enums/MessageMomentEnum.js

@@ -43,4 +43,6 @@ var MessageMomentEnum;
     MessageMomentEnum["MONTHLY_STATEMENT"] = "MONTHLY_STATEMENT";
     MessageMomentEnum["CAT_TERMS_NOTICE"] = "CAT_TERMS_NOTICE";
     MessageMomentEnum["PRIVACY_ARCO_NOTICE"] = "PRIVACY_ARCO_NOTICE";
+    MessageMomentEnum["REFERRAL_BONUS_CREDITED"] = "REFERRAL_BONUS_CREDITED";
+    MessageMomentEnum["REFERRAL_COUPON_ISSUED"] = "REFERRAL_COUPON_ISSUED";
 })(MessageMomentEnum || (exports.MessageMomentEnum = MessageMomentEnum = {}));

package/package.json

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

package/src/messageMoments/constants/MessageMomentCatalog.ts

@@ -5,6 +5,10 @@ import {
     CREDIT_MOMENT_CONDITIONAL_VARIABLES,
     MOMENT_SPECIFIC_VARIABLES,
     OTP_MOMENT_VARIABLES,
+    REFERRAL_BONUS_ALWAYS_VARIABLES,
+    REFERRAL_BONUS_CONDITIONAL_VARIABLES,
+    REFERRAL_COUPON_ALWAYS_VARIABLES,
+    REFERRAL_COUPON_CONDITIONAL_VARIABLES,
 } from './MessageMomentVariables';
 
 /** Quién es un momento: su id de ficha, su plantilla, su bloque y las variables que emite. */
@@ -29,10 +33,21 @@ function creditMoment(templateId: string, messageType: MessageMomentEnum, blockI
     };
 }
 
+/** Un momento fuera del crédito: solo las variables que su emisor manda. */
+function standaloneMoment(
+    templateId: string,
+    messageType: MessageMomentEnum,
+    blockId: MessageMomentBlockEnum,
+    alwaysVariables: readonly string[],
+    conditionalVariables: readonly string[] = [],
+): MessageMomentIdentity {
+    return { templateId, messageType, blockId, alwaysVariables, conditionalVariables };
+}
+
 const B = MessageMomentBlockEnum;
 const M = MessageMomentEnum;
 
-/** Los 38 momentos EN ORDEN de recorrido del crédito. `PM-071` apunta al OTP de plataforma. */
+/** Los 38 momentos del crédito EN ORDEN de recorrido y al final los de referidos. `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),
@@ -66,18 +81,14 @@ export const MESSAGE_MOMENT_CATALOG: readonly MessageMomentIdentity[] = [
     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: [],
-    },
+    standaloneMoment('PM-071', M.OTP_CODE, B.SERVICE, OTP_MOMENT_VARIABLES),
     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),
+    standaloneMoment('PM-080', M.REFERRAL_BONUS_CREDITED, B.REFERRALS, REFERRAL_BONUS_ALWAYS_VARIABLES, REFERRAL_BONUS_CONDITIONAL_VARIABLES),
+    standaloneMoment('PM-081', M.REFERRAL_COUPON_ISSUED, B.REFERRALS, REFERRAL_COUPON_ALWAYS_VARIABLES, REFERRAL_COUPON_CONDITIONAL_VARIABLES),
 ];
 
 /** La identidad por id de ficha (`PM-030`). */

package/src/messageMoments/constants/MessageMomentVariables.ts

@@ -30,6 +30,18 @@ export const CREDIT_MOMENT_CONDITIONAL_VARIABLES: readonly string[] = [
 /** El OTP lo arma messages-business: llena `code` y su alias posicional `var1`. */
 export const OTP_MOMENT_VARIABLES: readonly string[] = ['code', 'var1'];
 
+/** Premio de referido abonado a la cuenta PCF: a quién y cuánto. */
+export const REFERRAL_BONUS_ALWAYS_VARIABLES: readonly string[] = ['cliente_nombre', 'monto'];
+
+/** El referido solo se nombra cuando el premio es de quien recomendó. */
+export const REFERRAL_BONUS_CONDITIONAL_VARIABLES: readonly string[] = ['referido_nombre'];
+
+/** Cupón de referido emitido: el código, su descuento ya formateado y hasta cuándo vale. */
+export const REFERRAL_COUPON_ALWAYS_VARIABLES: readonly string[] = ['cliente_nombre', 'codigo', 'descuento', 'vigencia'];
+
+/** La tienda solo viaja cuando el cupón no vale en todas. */
+export const REFERRAL_COUPON_CONDITIONAL_VARIABLES: readonly string[] = ['tienda'];
+
 /** 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'];
 

package/src/messageMoments/enums/MessageMomentBlockEnum.ts

@@ -8,4 +8,5 @@ export enum MessageMomentBlockEnum {
     EXCEPTIONS = 'exceptions',
     CLOSURE = 'closure',
     SERVICE = 'service',
+    REFERRALS = 'referrals',
 }

package/src/messageMoments/enums/MessageMomentEnum.ts

@@ -47,4 +47,7 @@ export enum MessageMomentEnum {
     MONTHLY_STATEMENT = 'MONTHLY_STATEMENT',
     CAT_TERMS_NOTICE = 'CAT_TERMS_NOTICE',
     PRIVACY_ARCO_NOTICE = 'PRIVACY_ARCO_NOTICE',
+
+    REFERRAL_BONUS_CREDITED = 'REFERRAL_BONUS_CREDITED',
+    REFERRAL_COUPON_ISSUED = 'REFERRAL_COUPON_ISSUED',
 }