@fiado/type-kit 3.480.0 → 3.481.0

package/_test_/unit/loanOfferings/segmentCatalog.test.ts

@@ -0,0 +1,54 @@
+import 'reflect-metadata';
+import { plainToInstance } from 'class-transformer';
+import { validate } from 'class-validator';
+import {
+  ListSegmentCatalogQuery,
+  SegmentCatalogItem,
+  SegmentCatalogResponse,
+  SegmentFilterIdEnum,
+  SegmentStatusEnum,
+} from '../../../src/loanOfferings/index';
+
+const errorProperties = async (raw: Record<string, unknown>): Promise<string[]> => {
+  const instance = plainToInstance(ListSegmentCatalogQuery, raw, { excludeExtraneousValues: true });
+  return (await validate(instance as object)).map((error) => error.property);
+};
+
+describe('ListSegmentCatalogQuery', () => {
+  it('valida con solo el tenantId', async () => {
+    expect(await errorProperties({ tenantId: 'tenant-1' })).toEqual([]);
+  });
+
+  it('conserva el filtro de estado', async () => {
+    const dto = plainToInstance(
+      ListSegmentCatalogQuery,
+      { tenantId: 'tenant-1', status: SegmentStatusEnum.ARCHIVED },
+      { excludeExtraneousValues: true },
+    );
+    expect(await validate(dto as object)).toHaveLength(0);
+    expect(dto.status).toBe(SegmentStatusEnum.ARCHIVED);
+  });
+
+  it('exige tenantId no vacío', async () => {
+    expect(await errorProperties({})).toEqual(['tenantId']);
+    expect(await errorProperties({ tenantId: '' })).toEqual(['tenantId']);
+  });
+
+  it('rechaza un estado fuera del enum', async () => {
+    expect(await errorProperties({ tenantId: 'tenant-1', status: 'DELETED' })).toEqual(['status']);
+  });
+});
+
+describe('SegmentCatalogResponse', () => {
+  it('tipa cada segmento del catálogo', () => {
+    const item: SegmentCatalogItem = {
+      segmentId: 'seg-1',
+      name: 'Nuevos',
+      status: SegmentStatusEnum.ACTIVE,
+      filterIds: Object.values(SegmentFilterIdEnum).slice(0, 1),
+      isDefault: false,
+    };
+    const response: SegmentCatalogResponse = { segments: [item] };
+    expect(response.segments[0].segmentId).toBe('seg-1');
+  });
+});

package/_test_/unit/retailPromotions/salePromotionSegments.test.ts

@@ -0,0 +1,9 @@
+import { SalePromotionSegmentItem, SalePromotionSegmentsResponse } from '../../../src/retailPromotions/index';
+
+describe('SalePromotionSegmentsResponse', () => {
+  it('tipa cada segmento seleccionable en una promo de venta', () => {
+    const item: SalePromotionSegmentItem = { segmentId: 'seg-1', name: 'Nuevos', dependsOnFacts: true, isDefault: false };
+    const response: SalePromotionSegmentsResponse = { segments: [item] };
+    expect(response.segments).toEqual([item]);
+  });
+});

package/bin/loanOfferings/dtos/requests/ListSegmentCatalogQuery.d.ts

@@ -0,0 +1,6 @@
+import { SegmentStatusEnum } from '../../enums/SegmentStatusEnum';
+/** Query de GET /private/segments: catálogo de segmentos de un tenant, filtrable por estado. */
+export declare class ListSegmentCatalogQuery {
+    tenantId: string;
+    status?: SegmentStatusEnum;
+}

package/bin/loanOfferings/dtos/requests/ListSegmentCatalogQuery.js

@@ -0,0 +1,31 @@
+"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.ListSegmentCatalogQuery = void 0;
+const class_transformer_1 = require("class-transformer");
+const class_validator_1 = require("class-validator");
+const SegmentStatusEnum_1 = require("../../enums/SegmentStatusEnum");
+/** Query de GET /private/segments: catálogo de segmentos de un tenant, filtrable por estado. */
+class ListSegmentCatalogQuery {
+}
+exports.ListSegmentCatalogQuery = ListSegmentCatalogQuery;
+__decorate([
+    (0, class_transformer_1.Expose)(),
+    (0, class_validator_1.IsString)(),
+    (0, class_validator_1.IsNotEmpty)(),
+    __metadata("design:type", String)
+], ListSegmentCatalogQuery.prototype, "tenantId", void 0);
+__decorate([
+    (0, class_transformer_1.Expose)(),
+    (0, class_validator_1.IsOptional)(),
+    (0, class_validator_1.IsEnum)(SegmentStatusEnum_1.SegmentStatusEnum),
+    __metadata("design:type", String)
+], ListSegmentCatalogQuery.prototype, "status", void 0);

package/bin/loanOfferings/dtos/responses/SegmentCatalogResponse.d.ts

@@ -0,0 +1,15 @@
+import { SegmentFilterIdEnum } from '../../enums/SegmentFilterIdEnum';
+import { SegmentStatusEnum } from '../../enums/SegmentStatusEnum';
+/** Un segmento como lo necesita un selector: sin miembros ni metadatos de edición. */
+export interface SegmentCatalogItem {
+    segmentId: string;
+    name: string;
+    status: SegmentStatusEnum;
+    filterIds: SegmentFilterIdEnum[];
+    /** `true` solo en el catch-all, que el resolve nunca devuelve. */
+    isDefault: boolean;
+}
+/** Respuesta de GET /private/segments. */
+export interface SegmentCatalogResponse {
+    segments: SegmentCatalogItem[];
+}

package/bin/loanOfferings/dtos/responses/SegmentCatalogResponse.js

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

package/bin/loanOfferings/index.d.ts

@@ -42,6 +42,7 @@ export * from './dtos/requests/UpdateSegmentRequest';
 export * from './dtos/requests/ChangeSegmentStatusRequest';
 export * from './dtos/requests/ResolveCustomerSegmentsRequest';
 export * from './dtos/requests/ComputeAmortizationScheduleRequest';
+export * from './dtos/requests/ListSegmentCatalogQuery';
 export * from './dtos/responses/CreditPlanResponse';
 export * from './dtos/responses/FinancierResponse';
 export * from './dtos/responses/RetailerCreditPlanResponse';
@@ -57,6 +58,7 @@ export * from './dtos/responses/ScopeWidePromotionsResponse';
 export * from './dtos/responses/StorePolicyResponse';
 export * from './dtos/responses/SegmentResponse';
 export * from './dtos/responses/SegmentFilterResponse';
+export * from './dtos/responses/SegmentCatalogResponse';
 export * from './dtos/responses/ResolveCustomerSegmentsResponse';
 export * from './dtos/responses/AmortizationScheduleRow';
 export * from './dtos/responses/AmortizationScheduleResponse';

package/bin/loanOfferings/index.js

@@ -61,6 +61,7 @@ __exportStar(require("./dtos/requests/UpdateSegmentRequest"), exports);
 __exportStar(require("./dtos/requests/ChangeSegmentStatusRequest"), exports);
 __exportStar(require("./dtos/requests/ResolveCustomerSegmentsRequest"), exports);
 __exportStar(require("./dtos/requests/ComputeAmortizationScheduleRequest"), exports);
+__exportStar(require("./dtos/requests/ListSegmentCatalogQuery"), exports);
 // Response DTOs
 __exportStar(require("./dtos/responses/CreditPlanResponse"), exports);
 __exportStar(require("./dtos/responses/FinancierResponse"), exports);
@@ -77,6 +78,7 @@ __exportStar(require("./dtos/responses/ScopeWidePromotionsResponse"), exports);
 __exportStar(require("./dtos/responses/StorePolicyResponse"), exports);
 __exportStar(require("./dtos/responses/SegmentResponse"), exports);
 __exportStar(require("./dtos/responses/SegmentFilterResponse"), exports);
+__exportStar(require("./dtos/responses/SegmentCatalogResponse"), exports);
 __exportStar(require("./dtos/responses/ResolveCustomerSegmentsResponse"), exports);
 __exportStar(require("./dtos/responses/AmortizationScheduleRow"), exports);
 __exportStar(require("./dtos/responses/AmortizationScheduleResponse"), exports);

package/bin/retailPromotions/dtos/responses/SalePromotionSegmentsResponse.d.ts

@@ -0,0 +1,11 @@
+/** Un segmento seleccionable al configurar una promo de venta. */
+export interface SalePromotionSegmentItem {
+    segmentId: string;
+    name: string;
+    dependsOnFacts: boolean;
+    isDefault: boolean;
+}
+/** Respuesta de GET /public/segments. */
+export interface SalePromotionSegmentsResponse {
+    segments: SalePromotionSegmentItem[];
+}

package/bin/retailPromotions/dtos/responses/SalePromotionSegmentsResponse.js

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

package/bin/retailPromotions/index.d.ts

@@ -50,3 +50,4 @@ export * from './dtos/responses/SalePromotionCrudResponses';
 export * from './dtos/responses/DiscountCodeResponses';
 export * from './dtos/responses/WizardSalePromotionResponses';
 export * from './dtos/responses/SkuSalePromotionsResponse';
+export * from './dtos/responses/SalePromotionSegmentsResponse';

package/bin/retailPromotions/index.js

@@ -71,3 +71,4 @@ __exportStar(require("./dtos/responses/SalePromotionCrudResponses"), exports);
 __exportStar(require("./dtos/responses/DiscountCodeResponses"), exports);
 __exportStar(require("./dtos/responses/WizardSalePromotionResponses"), exports);
 __exportStar(require("./dtos/responses/SkuSalePromotionsResponse"), exports);
+__exportStar(require("./dtos/responses/SalePromotionSegmentsResponse"), exports);

package/package.json

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

package/src/loanOfferings/dtos/requests/ListSegmentCatalogQuery.ts

@@ -0,0 +1,16 @@
+import { Expose } from 'class-transformer';
+import { IsEnum, IsNotEmpty, IsOptional, IsString } from 'class-validator';
+import { SegmentStatusEnum } from '../../enums/SegmentStatusEnum';
+
+/** Query de GET /private/segments: catálogo de segmentos de un tenant, filtrable por estado. */
+export class ListSegmentCatalogQuery {
+    @Expose()
+    @IsString()
+    @IsNotEmpty()
+    tenantId!: string;
+
+    @Expose()
+    @IsOptional()
+    @IsEnum(SegmentStatusEnum)
+    status?: SegmentStatusEnum;
+}

package/src/loanOfferings/dtos/responses/SegmentCatalogResponse.ts

@@ -0,0 +1,17 @@
+import { SegmentFilterIdEnum } from '../../enums/SegmentFilterIdEnum';
+import { SegmentStatusEnum } from '../../enums/SegmentStatusEnum';
+
+/** Un segmento como lo necesita un selector: sin miembros ni metadatos de edición. */
+export interface SegmentCatalogItem {
+    segmentId: string;
+    name: string;
+    status: SegmentStatusEnum;
+    filterIds: SegmentFilterIdEnum[];
+    /** `true` solo en el catch-all, que el resolve nunca devuelve. */
+    isDefault: boolean;
+}
+
+/** Respuesta de GET /private/segments. */
+export interface SegmentCatalogResponse {
+    segments: SegmentCatalogItem[];
+}

package/src/loanOfferings/index.ts

@@ -47,6 +47,7 @@ export * from './dtos/requests/UpdateSegmentRequest';
 export * from './dtos/requests/ChangeSegmentStatusRequest';
 export * from './dtos/requests/ResolveCustomerSegmentsRequest';
 export * from './dtos/requests/ComputeAmortizationScheduleRequest';
+export * from './dtos/requests/ListSegmentCatalogQuery';
 
 // Response DTOs
 export * from './dtos/responses/CreditPlanResponse';
@@ -64,6 +65,7 @@ export * from './dtos/responses/ScopeWidePromotionsResponse';
 export * from './dtos/responses/StorePolicyResponse';
 export * from './dtos/responses/SegmentResponse';
 export * from './dtos/responses/SegmentFilterResponse';
+export * from './dtos/responses/SegmentCatalogResponse';
 export * from './dtos/responses/ResolveCustomerSegmentsResponse';
 export * from './dtos/responses/AmortizationScheduleRow';
 export * from './dtos/responses/AmortizationScheduleResponse';

package/src/retailPromotions/dtos/responses/SalePromotionSegmentsResponse.ts

@@ -0,0 +1,12 @@
+/** Un segmento seleccionable al configurar una promo de venta. */
+export interface SalePromotionSegmentItem {
+    segmentId: string;
+    name: string;
+    dependsOnFacts: boolean;
+    isDefault: boolean;
+}
+
+/** Respuesta de GET /public/segments. */
+export interface SalePromotionSegmentsResponse {
+    segments: SalePromotionSegmentItem[];
+}

package/src/retailPromotions/index.ts

@@ -59,3 +59,4 @@ export * from './dtos/responses/SalePromotionCrudResponses';
 export * from './dtos/responses/DiscountCodeResponses';
 export * from './dtos/responses/WizardSalePromotionResponses';
 export * from './dtos/responses/SkuSalePromotionsResponse';
+export * from './dtos/responses/SalePromotionSegmentsResponse';