@fiado/type-kit 3.434.0 → 3.435.0

package/_test_/unit/messagesConnector/messageLogListContract.test.ts

@@ -0,0 +1,106 @@
+import 'reflect-metadata';
+import { plainToInstance } from 'class-transformer';
+import { validate, ValidationError } from 'class-validator';
+import * as MessagesConnectorBarrel from '../../../src/messagesConnector/index';
+import { MessageLogListRequest } from '../../../src/messagesConnector/dtos/MessageLogListRequest';
+import { MessageLogListResponse } from '../../../src/messagesConnector/dtos/MessageLogListResponse';
+import { MessageLogItem } from '../../../src/messagesConnector/dtos/MessageLogItem';
+import { MessageLogStatusEnum } from '../../../src/messagesConnector/enums/MessageLogStatusEnum';
+import { DeliveryChannelExtendedEnum } from '../../../src/messagesConnector/enums/DeliveryChannelExtendedEnum';
+import {
+    MESSAGE_LOG_MAX_WINDOW_DAYS,
+    MESSAGE_LOG_NEXT_TOKEN_MAX_LENGTH,
+    MESSAGE_LOG_PAGE_SIZE,
+} from '../../../src/messagesConnector/constants/MessageLogListLimits';
+
+const validQuery = {
+    tenantId: 'SUREKEEP',
+    directoryId: '01M0B5D7FQA3T06K4REEVPRM33',
+    from: '2026-09-01T00:00:00.000Z',
+    to: '2026-09-15T23:59:59.999Z',
+};
+
+const validateQuery = async (payload: Record<string, unknown>): Promise<ValidationError[]> =>
+    validate(plainToInstance(MessageLogListRequest, { ...validQuery, ...payload }), { whitelist: true });
+
+const hasError = (errors: ValidationError[], property: string): boolean =>
+    errors.some((error) => error.property === property);
+
+describe('MessageLogListRequest', () => {
+    it('acepta la primera página sin nextToken', async () => {
+        expect(await validateQuery({})).toEqual([]);
+    });
+
+    it('acepta el nextToken de la página anterior', async () => {
+        expect(await validateQuery({ nextToken: 'eyJpZCI6ImEifQ' })).toEqual([]);
+    });
+
+    it.each(['tenantId', 'directoryId', 'from', 'to'])('rechaza el query sin %s', async (property) => {
+        expect(hasError(await validateQuery({ [property]: undefined }), property)).toBe(true);
+    });
+
+    it.each(['tenantId', 'directoryId'])('rechaza %s vacío', async (property) => {
+        expect(hasError(await validateQuery({ [property]: '' }), property)).toBe(true);
+    });
+
+    it('rechaza un from que no es ISO 8601', async () => {
+        expect(hasError(await validateQuery({ from: '15/09/2026' }), 'from')).toBe(true);
+    });
+
+    it.each(['2026-W37-2', '2026-258', '2026-09-15'])('rechaza %s: la ventana lleva fecha de calendario y hora', async (from) => {
+        expect(hasError(await validateQuery({ from }), 'from')).toBe(true);
+    });
+
+    it('acepta la hora con offset', async () => {
+        expect(await validateQuery({ to: '2026-09-15T18:00:00-06:00' })).toEqual([]);
+    });
+
+    it('rechaza un to que no es ISO 8601', async () => {
+        expect(hasError(await validateQuery({ to: 'ayer' }), 'to')).toBe(true);
+    });
+
+    it('rechaza un nextToken por encima del largo máximo', async () => {
+        const nextToken = 'a'.repeat(MESSAGE_LOG_NEXT_TOKEN_MAX_LENGTH + 1);
+
+        expect(hasError(await validateQuery({ nextToken }), 'nextToken')).toBe(true);
+    });
+});
+
+describe('MessageLogListResponse', () => {
+    it('el item no expone destination, variables ni otpCode', () => {
+        const item: MessageLogItem = {
+            id: 'b3c1f0a2-0000-4000-8000-000000000001',
+            channelType: DeliveryChannelExtendedEnum.SMS,
+            messageType: 'PAYMENT_REMINDER',
+            templatePk: 'SUREKEEP#PAYMENT_REMINDER#SMS#es#MX',
+            referenceMessageId: 'credit#01M0B5D7FQA3T06K4REEVPRM33#PM-003',
+            status: MessageLogStatusEnum.COMPLETED,
+            renderedMessage: 'Tu pago vence mañana.',
+            failureCode: null,
+            createdAt: '2026-09-14T15:00:00.000Z',
+        };
+        const response: MessageLogListResponse = { items: [item], nextToken: null };
+
+        expect(Object.keys(response.items[0]).sort()).toEqual([
+            'channelType', 'createdAt', 'failureCode', 'id', 'messageType',
+            'referenceMessageId', 'renderedMessage', 'status', 'templatePk',
+        ]);
+    });
+
+    it('el enum de estado trae los estados que escribe messages-business', () => {
+        expect(Object.values(MessageLogStatusEnum).sort()).toEqual(
+            ['CANCEL', 'COMPLETED', 'CREATED', 'PENDING', 'REJECTED', 'VALIDATED'],
+        );
+    });
+
+    it('los límites del listado son positivos', () => {
+        expect(MESSAGE_LOG_PAGE_SIZE).toBeGreaterThan(0);
+        expect(MESSAGE_LOG_MAX_WINDOW_DAYS).toBeGreaterThan(0);
+    });
+
+    it('el barrel exporta el contrato', () => {
+        expect(MessagesConnectorBarrel.MessageLogListRequest).toBe(MessageLogListRequest);
+        expect(MessagesConnectorBarrel.MessageLogStatusEnum).toBe(MessageLogStatusEnum);
+        expect(MessagesConnectorBarrel.MESSAGE_LOG_PAGE_SIZE).toBe(MESSAGE_LOG_PAGE_SIZE);
+    });
+});

package/bin/messagesConnector/constants/MessageLogListLimits.d.ts

@@ -0,0 +1,8 @@
+/** Mensajes evaluados por página de la lectura privada de mensajes. */
+export declare const MESSAGE_LOG_PAGE_SIZE = 50;
+/** Ventana máxima entre `from` y `to`; más amplia se rechaza con 400. */
+export declare const MESSAGE_LOG_MAX_WINDOW_DAYS = 366;
+/** Largo máximo del `nextToken` opaco que devuelve la página anterior. */
+export declare const MESSAGE_LOG_NEXT_TOKEN_MAX_LENGTH = 1024;
+/** Fecha de calendario con hora: ISO 8601 también admite semanas y ordinales que `Date.parse` no lee. */
+export declare const MESSAGE_LOG_DATE_TIME_PATTERN: RegExp;

package/bin/messagesConnector/constants/MessageLogListLimits.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MESSAGE_LOG_DATE_TIME_PATTERN = exports.MESSAGE_LOG_NEXT_TOKEN_MAX_LENGTH = exports.MESSAGE_LOG_MAX_WINDOW_DAYS = exports.MESSAGE_LOG_PAGE_SIZE = void 0;
+/** Mensajes evaluados por página de la lectura privada de mensajes. */
+exports.MESSAGE_LOG_PAGE_SIZE = 50;
+/** Ventana máxima entre `from` y `to`; más amplia se rechaza con 400. */
+exports.MESSAGE_LOG_MAX_WINDOW_DAYS = 366;
+/** Largo máximo del `nextToken` opaco que devuelve la página anterior. */
+exports.MESSAGE_LOG_NEXT_TOKEN_MAX_LENGTH = 1024;
+/** Fecha de calendario con hora: ISO 8601 también admite semanas y ordinales que `Date.parse` no lee. */
+exports.MESSAGE_LOG_DATE_TIME_PATTERN = /^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}/;

package/bin/messagesConnector/dtos/MessageLogItem.d.ts

@@ -0,0 +1,17 @@
+import { DeliveryChannelExtendedEnum } from '../enums/DeliveryChannelExtendedEnum';
+import { MessageLogStatusEnum } from '../enums/MessageLogStatusEnum';
+/** Un mensaje enviado, sin datos personales: ni destino, ni variables, ni código OTP. */
+export declare class MessageLogItem {
+    id: string;
+    channelType: DeliveryChannelExtendedEnum;
+    /** Momento del catálogo o tipo de aviso MDM; cada canal trae el suyo. */
+    messageType: string;
+    templatePk: string;
+    referenceMessageId: string | null;
+    status: MessageLogStatusEnum;
+    /** Texto que recibió el destinatario. */
+    renderedMessage: string | null;
+    failureCode: string | null;
+    /** ISO 8601. */
+    createdAt: string;
+}

package/bin/messagesConnector/dtos/MessageLogItem.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MessageLogItem = void 0;
+/** Un mensaje enviado, sin datos personales: ni destino, ni variables, ni código OTP. */
+class MessageLogItem {
+}
+exports.MessageLogItem = MessageLogItem;

package/bin/messagesConnector/dtos/MessageLogListRequest.d.ts

@@ -0,0 +1,11 @@
+/** Query string de la lectura privada de mensajes de un destinatario en una ventana. */
+export declare class MessageLogListRequest {
+    tenantId: string;
+    directoryId: string;
+    /** Inicio de la ventana sobre `createdAt`, ISO 8601 con hora, inclusivo. */
+    from: string;
+    /** Fin de la ventana sobre `createdAt`, ISO 8601 con hora, inclusivo. */
+    to: string;
+    /** Token opaco de la página anterior. */
+    nextToken?: string;
+}

package/bin/messagesConnector/dtos/MessageLogListRequest.js

@@ -0,0 +1,50 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MessageLogListRequest = void 0;
+const class_transformer_1 = require("class-transformer");
+const class_validator_1 = require("class-validator");
+const MessageLogListLimits_1 = require("../constants/MessageLogListLimits");
+/** Query string de la lectura privada de mensajes de un destinatario en una ventana. */
+class MessageLogListRequest {
+}
+exports.MessageLogListRequest = MessageLogListRequest;
+__decorate([
+    (0, class_transformer_1.Expose)(),
+    (0, class_validator_1.IsString)(),
+    (0, class_validator_1.IsNotEmpty)(),
+    __metadata("design:type", String)
+], MessageLogListRequest.prototype, "tenantId", void 0);
+__decorate([
+    (0, class_transformer_1.Expose)(),
+    (0, class_validator_1.IsString)(),
+    (0, class_validator_1.IsNotEmpty)(),
+    __metadata("design:type", String)
+], MessageLogListRequest.prototype, "directoryId", void 0);
+__decorate([
+    (0, class_transformer_1.Expose)(),
+    (0, class_validator_1.IsISO8601)({ strict: true }),
+    (0, class_validator_1.Matches)(MessageLogListLimits_1.MESSAGE_LOG_DATE_TIME_PATTERN),
+    __metadata("design:type", String)
+], MessageLogListRequest.prototype, "from", void 0);
+__decorate([
+    (0, class_transformer_1.Expose)(),
+    (0, class_validator_1.IsISO8601)({ strict: true }),
+    (0, class_validator_1.Matches)(MessageLogListLimits_1.MESSAGE_LOG_DATE_TIME_PATTERN),
+    __metadata("design:type", String)
+], MessageLogListRequest.prototype, "to", void 0);
+__decorate([
+    (0, class_transformer_1.Expose)(),
+    (0, class_validator_1.IsOptional)(),
+    (0, class_validator_1.IsString)(),
+    (0, class_validator_1.MaxLength)(MessageLogListLimits_1.MESSAGE_LOG_NEXT_TOKEN_MAX_LENGTH),
+    __metadata("design:type", String)
+], MessageLogListRequest.prototype, "nextToken", void 0);

package/bin/messagesConnector/dtos/MessageLogListResponse.d.ts

@@ -0,0 +1,6 @@
+import { MessageLogItem } from './MessageLogItem';
+/** Página de mensajes, del más nuevo al más viejo. `nextToken` en null: no hay más. */
+export declare class MessageLogListResponse {
+    items: MessageLogItem[];
+    nextToken: string | null;
+}

package/bin/messagesConnector/dtos/MessageLogListResponse.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MessageLogListResponse = void 0;
+/** Página de mensajes, del más nuevo al más viejo. `nextToken` en null: no hay más. */
+class MessageLogListResponse {
+}
+exports.MessageLogListResponse = MessageLogListResponse;

package/bin/messagesConnector/enums/MessageLogStatusEnum.d.ts

@@ -0,0 +1,9 @@
+/** Estado de un mensaje en `MessageLogs_GT`, tal como lo escribe messages-business. */
+export declare enum MessageLogStatusEnum {
+    CREATED = "CREATED",
+    VALIDATED = "VALIDATED",
+    COMPLETED = "COMPLETED",
+    REJECTED = "REJECTED",
+    PENDING = "PENDING",
+    CANCEL = "CANCEL"
+}

package/bin/messagesConnector/enums/MessageLogStatusEnum.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MessageLogStatusEnum = void 0;
+/** Estado de un mensaje en `MessageLogs_GT`, tal como lo escribe messages-business. */
+var MessageLogStatusEnum;
+(function (MessageLogStatusEnum) {
+    MessageLogStatusEnum["CREATED"] = "CREATED";
+    MessageLogStatusEnum["VALIDATED"] = "VALIDATED";
+    MessageLogStatusEnum["COMPLETED"] = "COMPLETED";
+    MessageLogStatusEnum["REJECTED"] = "REJECTED";
+    MessageLogStatusEnum["PENDING"] = "PENDING";
+    MessageLogStatusEnum["CANCEL"] = "CANCEL";
+})(MessageLogStatusEnum || (exports.MessageLogStatusEnum = MessageLogStatusEnum = {}));

package/bin/messagesConnector/index.d.ts

@@ -28,3 +28,8 @@ export * from './dtos/MdmNotifyQueueMessageRequest';
 export * from './dtos/MdmNotifyResponse';
 export * from './dtos/MdmNotifyBatchResponse';
 export * from './constants/MessageIdempotencyLimits';
+export * from './constants/MessageLogListLimits';
+export * from './enums/MessageLogStatusEnum';
+export * from './dtos/MessageLogListRequest';
+export * from './dtos/MessageLogItem';
+export * from './dtos/MessageLogListResponse';

package/bin/messagesConnector/index.js

@@ -44,3 +44,8 @@ __exportStar(require("./dtos/MdmNotifyQueueMessageRequest"), exports);
 __exportStar(require("./dtos/MdmNotifyResponse"), exports);
 __exportStar(require("./dtos/MdmNotifyBatchResponse"), exports);
 __exportStar(require("./constants/MessageIdempotencyLimits"), exports);
+__exportStar(require("./constants/MessageLogListLimits"), exports);
+__exportStar(require("./enums/MessageLogStatusEnum"), exports);
+__exportStar(require("./dtos/MessageLogListRequest"), exports);
+__exportStar(require("./dtos/MessageLogItem"), exports);
+__exportStar(require("./dtos/MessageLogListResponse"), exports);

package/package.json

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

package/src/messagesConnector/constants/MessageLogListLimits.ts

@@ -0,0 +1,11 @@
+/** Mensajes evaluados por página de la lectura privada de mensajes. */
+export const MESSAGE_LOG_PAGE_SIZE = 50;
+
+/** Ventana máxima entre `from` y `to`; más amplia se rechaza con 400. */
+export const MESSAGE_LOG_MAX_WINDOW_DAYS = 366;
+
+/** Largo máximo del `nextToken` opaco que devuelve la página anterior. */
+export const MESSAGE_LOG_NEXT_TOKEN_MAX_LENGTH = 1024;
+
+/** Fecha de calendario con hora: ISO 8601 también admite semanas y ordinales que `Date.parse` no lee. */
+export const MESSAGE_LOG_DATE_TIME_PATTERN = /^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}/;

package/src/messagesConnector/dtos/MessageLogItem.ts

@@ -0,0 +1,18 @@
+import { DeliveryChannelExtendedEnum } from '../enums/DeliveryChannelExtendedEnum';
+import { MessageLogStatusEnum } from '../enums/MessageLogStatusEnum';
+
+/** Un mensaje enviado, sin datos personales: ni destino, ni variables, ni código OTP. */
+export class MessageLogItem {
+    id!: string;
+    channelType!: DeliveryChannelExtendedEnum;
+    /** Momento del catálogo o tipo de aviso MDM; cada canal trae el suyo. */
+    messageType!: string;
+    templatePk!: string;
+    referenceMessageId!: string | null;
+    status!: MessageLogStatusEnum;
+    /** Texto que recibió el destinatario. */
+    renderedMessage!: string | null;
+    failureCode!: string | null;
+    /** ISO 8601. */
+    createdAt!: string;
+}

package/src/messagesConnector/dtos/MessageLogListRequest.ts

@@ -0,0 +1,15 @@
+import { Expose } from 'class-transformer';
+import { IsISO8601, IsNotEmpty, IsOptional, IsString, Matches, MaxLength } from 'class-validator';
+import { MESSAGE_LOG_DATE_TIME_PATTERN, MESSAGE_LOG_NEXT_TOKEN_MAX_LENGTH } from '../constants/MessageLogListLimits';
+
+/** Query string de la lectura privada de mensajes de un destinatario en una ventana. */
+export class MessageLogListRequest {
+    @Expose() @IsString() @IsNotEmpty() tenantId!: string;
+    @Expose() @IsString() @IsNotEmpty() directoryId!: string;
+    /** Inicio de la ventana sobre `createdAt`, ISO 8601 con hora, inclusivo. */
+    @Expose() @IsISO8601({ strict: true }) @Matches(MESSAGE_LOG_DATE_TIME_PATTERN) from!: string;
+    /** Fin de la ventana sobre `createdAt`, ISO 8601 con hora, inclusivo. */
+    @Expose() @IsISO8601({ strict: true }) @Matches(MESSAGE_LOG_DATE_TIME_PATTERN) to!: string;
+    /** Token opaco de la página anterior. */
+    @Expose() @IsOptional() @IsString() @MaxLength(MESSAGE_LOG_NEXT_TOKEN_MAX_LENGTH) nextToken?: string;
+}

package/src/messagesConnector/dtos/MessageLogListResponse.ts

@@ -0,0 +1,7 @@
+import { MessageLogItem } from './MessageLogItem';
+
+/** Página de mensajes, del más nuevo al más viejo. `nextToken` en null: no hay más. */
+export class MessageLogListResponse {
+    items!: MessageLogItem[];
+    nextToken!: string | null;
+}

package/src/messagesConnector/enums/MessageLogStatusEnum.ts

@@ -0,0 +1,9 @@
+/** Estado de un mensaje en `MessageLogs_GT`, tal como lo escribe messages-business. */
+export enum MessageLogStatusEnum {
+    CREATED = 'CREATED',
+    VALIDATED = 'VALIDATED',
+    COMPLETED = 'COMPLETED',
+    REJECTED = 'REJECTED',
+    PENDING = 'PENDING',
+    CANCEL = 'CANCEL',
+}

package/src/messagesConnector/index.ts

@@ -28,3 +28,8 @@ export * from './dtos/MdmNotifyQueueMessageRequest';
 export * from './dtos/MdmNotifyResponse';
 export * from './dtos/MdmNotifyBatchResponse';
 export * from './constants/MessageIdempotencyLimits';
+export * from './constants/MessageLogListLimits';
+export * from './enums/MessageLogStatusEnum';
+export * from './dtos/MessageLogListRequest';
+export * from './dtos/MessageLogItem';
+export * from './dtos/MessageLogListResponse';