@fiado/type-kit 3.572.0 → 3.574.0

package/_test_/unit/rules/populationDtos.test.ts

@@ -56,3 +56,25 @@ describe('population DTOs', () => {
         expect(Object.keys(Rules.PopulationExecutionStatusEnum)).toEqual(['RUNNING', 'SUCCEEDED', 'FAILED', 'CANCELLED']);
     });
 });
+
+describe('rutas de columna (SEGMENT_COLUMN_PATH_PATTERN)', () => {
+    const colCond = (column: string) => ({ kind: 'COLUMN', table: 'riskprofile', column, op: 'GT', value: 1 });
+    it.each(['score', 'riskfactors.income.value', 'a.b.c.d.e.f.g.h'])('column "%s" válida -> 0 errores', async (column) => {
+        expect(await errorsOf(Rules.SegmentColumnCondition, colCond(column))).toBe(0);
+    });
+    it.each(['a.b.c.d.e.f.g.h.i', 'Riskfactors.income', 'a..b', 'a.', '.a', 'a.1b', 'a-b.c'])('column "%s" inválida -> error', async (column) => {
+        expect(await errorsOf(Rules.SegmentColumnCondition, colCond(column))).toBeGreaterThan(0);
+    });
+    it('table con punto sigue inválida', async () => {
+        expect(await errorsOf(Rules.SegmentColumnCondition, { ...colCond('score'), table: 'a.b' })).toBeGreaterThan(0);
+    });
+    it('dateColumn anidada válida y SEGMENT_MAX_PATH_DEPTH = 8', async () => {
+        expect(await errorsOf(Rules.SegmentWindow, { dateColumn: 'riskfactors.income.evaluationat', days: 30 })).toBe(0);
+        expect(Rules.SEGMENT_MAX_PATH_DEPTH).toBe(8);
+    });
+    it('aggregate column anidada válida', async () => {
+        const agg = { kind: 'AGGREGATE', table: 'tx', fn: 'SUM', column: 'a.b.c', op: 'GT', value: 1 };
+        const errs = await validate(plainToInstance(Rules.SegmentAggregateCondition, agg, { excludeExtraneousValues: true }));
+        expect(errs.filter((e) => e.property === 'column')).toHaveLength(0);
+    });
+});

package/bin/retailCommission/dtos/CommissionApi.d.ts

@@ -395,6 +395,26 @@ export interface MyCommissionsTotals {
     unitsCount: number;
     netCents: number;
 }
+/**
+ * Lo que un cierre todavía abierto va a mover en el saldo del vendedor, calculado al momento con la
+ * misma cuenta del cierre: cada venta con el «Cuándo se paga» de su plan, menos lo ya acreditado al
+ * momento, más los ajustes del corte.
+ */
+export interface MyCommissionsUpcomingCut {
+    periodId: string;
+    periodStart: string;
+    periodEnd: string;
+    /** Día del cierre en México (`yyyy-mm-dd`): el lunes siguiente al domingo del corte. */
+    cutDate: string;
+    /** Lo que el cierre deja por depositar; negativo si descuenta. */
+    payableCents: number;
+    /** De `payableCents`, lo que viene de ajustes del corte. */
+    adjustmentsCents: number;
+    /** Lo que el cierre retiene hasta el día 1. */
+    retainedCents: number;
+    /** Día en que se libera lo retenido (`yyyy-mm-dd`); `null` si no retiene. */
+    releaseDate: string | null;
+}
 /**
  * `GET /commissions/me?weeks=` — las comisiones del vendedor que llama. El vendedor sale del token;
  * no se puede pedir el de otro.
@@ -412,6 +432,11 @@ export interface GetMyCommissionsResponse {
     };
     /** El corte en curso; `null` si todavía no tiene ventas, renta ni ajustes. */
     week: CommissionSellerBreakdown | null;
+    /**
+     * Los cierres pendientes con algo que mover: el del corte anterior si todavía no cierra y el del
+     * corte en curso, del más próximo al más lejano. Ausente en motores anteriores.
+     */
+    upcomingCuts?: MyCommissionsUpcomingCut[];
     /** Cortes cuya semana empieza en el mes de hoy: cerrados, el anterior aún sin cerrar y el en curso. */
     month: MyCommissionsTotals;
     /** Cortes cuya semana empieza en el año de hoy: cerrados, el anterior aún sin cerrar y el en curso. */

package/bin/rules/constants/SegmentLimits.d.ts

@@ -1,5 +1,8 @@
 /** Identificador SQL permitido para tabla/columna (A§4.3 paso 1): minusculas, digitos y guion bajo; nunca texto libre. */
 export declare const SEGMENT_IDENTIFIER_PATTERN: RegExp;
+/** Ruta a una hoja de columna struct de Glue (`riskfactors.income.value`): segmentos separados por punto, maximo SEGMENT_MAX_PATH_DEPTH. Una columna plana es una ruta de 1 segmento. */
+export declare const SEGMENT_COLUMN_PATH_PATTERN: RegExp;
+export declare const SEGMENT_MAX_PATH_DEPTH = 8;
 export declare const SEGMENT_MAX_DAYS = 365;
 export declare const SEGMENT_MAX_PARAMS = 40;
 export declare const SEGMENT_MAX_AGGREGATES = 8;

package/bin/rules/constants/SegmentLimits.js

@@ -1,8 +1,11 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.SEGMENT_MAX_AGGREGATES = exports.SEGMENT_MAX_PARAMS = exports.SEGMENT_MAX_DAYS = exports.SEGMENT_IDENTIFIER_PATTERN = void 0;
+exports.SEGMENT_MAX_AGGREGATES = exports.SEGMENT_MAX_PARAMS = exports.SEGMENT_MAX_DAYS = exports.SEGMENT_MAX_PATH_DEPTH = exports.SEGMENT_COLUMN_PATH_PATTERN = exports.SEGMENT_IDENTIFIER_PATTERN = void 0;
 /** Identificador SQL permitido para tabla/columna (A§4.3 paso 1): minusculas, digitos y guion bajo; nunca texto libre. */
 exports.SEGMENT_IDENTIFIER_PATTERN = /^[a-z_][a-z0-9_]*$/;
+/** Ruta a una hoja de columna struct de Glue (`riskfactors.income.value`): segmentos separados por punto, maximo SEGMENT_MAX_PATH_DEPTH. Una columna plana es una ruta de 1 segmento. */
+exports.SEGMENT_COLUMN_PATH_PATTERN = /^[a-z_][a-z0-9_]*(\.[a-z_][a-z0-9_]*){0,7}$/;
+exports.SEGMENT_MAX_PATH_DEPTH = 8;
 exports.SEGMENT_MAX_DAYS = 365;
 exports.SEGMENT_MAX_PARAMS = 40;
 exports.SEGMENT_MAX_AGGREGATES = 8;

package/bin/rules/dtos/population/SegmentAggregateCondition.js

@@ -40,7 +40,7 @@ __decorate([
 __decorate([
     (0, class_transformer_1.Expose)(),
     (0, class_validator_1.IsOptional)(),
-    (0, class_validator_1.Matches)(SegmentLimits_1.SEGMENT_IDENTIFIER_PATTERN),
+    (0, class_validator_1.Matches)(SegmentLimits_1.SEGMENT_COLUMN_PATH_PATTERN),
     __metadata("design:type", String)
 ], SegmentAggregateCondition.prototype, "column", void 0);
 __decorate([

package/bin/rules/dtos/population/SegmentColumnCondition.js

@@ -31,7 +31,7 @@ __decorate([
 ], SegmentColumnCondition.prototype, "table", void 0);
 __decorate([
     (0, class_transformer_1.Expose)(),
-    (0, class_validator_1.Matches)(SegmentLimits_1.SEGMENT_IDENTIFIER_PATTERN),
+    (0, class_validator_1.Matches)(SegmentLimits_1.SEGMENT_COLUMN_PATH_PATTERN),
     __metadata("design:type", String)
 ], SegmentColumnCondition.prototype, "column", void 0);
 __decorate([

package/bin/rules/dtos/population/SegmentTableSchemaResponse.d.ts

@@ -1,6 +1,8 @@
 import { SegmentOperatorEnum } from '../../enums/SegmentOperatorEnum';
 export declare class SegmentColumnSchemaResponse {
     name: string;
+    /** Columna raiz de Glue cuando `name` es una ruta a una hoja de struct (agrupa en la UI). */
+    root?: string;
     type: string;
     isDate: boolean;
     operators: SegmentOperatorEnum[];

package/bin/rules/dtos/population/SegmentWindow.js

@@ -19,7 +19,7 @@ class SegmentWindow {
 exports.SegmentWindow = SegmentWindow;
 __decorate([
     (0, class_transformer_1.Expose)(),
-    (0, class_validator_1.Matches)(SegmentLimits_1.SEGMENT_IDENTIFIER_PATTERN),
+    (0, class_validator_1.Matches)(SegmentLimits_1.SEGMENT_COLUMN_PATH_PATTERN),
     __metadata("design:type", String)
 ], SegmentWindow.prototype, "dateColumn", void 0);
 __decorate([

package/package.json

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

package/src/retailCommission/dtos/CommissionApi.ts

@@ -476,6 +476,27 @@ export interface MyCommissionsTotals {
     netCents: number;
 }
 
+/**
+ * Lo que un cierre todavía abierto va a mover en el saldo del vendedor, calculado al momento con la
+ * misma cuenta del cierre: cada venta con el «Cuándo se paga» de su plan, menos lo ya acreditado al
+ * momento, más los ajustes del corte.
+ */
+export interface MyCommissionsUpcomingCut {
+    periodId: string;
+    periodStart: string;
+    periodEnd: string;
+    /** Día del cierre en México (`yyyy-mm-dd`): el lunes siguiente al domingo del corte. */
+    cutDate: string;
+    /** Lo que el cierre deja por depositar; negativo si descuenta. */
+    payableCents: number;
+    /** De `payableCents`, lo que viene de ajustes del corte. */
+    adjustmentsCents: number;
+    /** Lo que el cierre retiene hasta el día 1. */
+    retainedCents: number;
+    /** Día en que se libera lo retenido (`yyyy-mm-dd`); `null` si no retiene. */
+    releaseDate: string | null;
+}
+
 /**
  * `GET /commissions/me?weeks=` — las comisiones del vendedor que llama. El vendedor sale del token;
  * no se puede pedir el de otro.
@@ -485,6 +506,11 @@ export interface GetMyCommissionsResponse {
     period: { periodId: string; periodStart: string; periodEnd: string };
     /** El corte en curso; `null` si todavía no tiene ventas, renta ni ajustes. */
     week: CommissionSellerBreakdown | null;
+    /**
+     * Los cierres pendientes con algo que mover: el del corte anterior si todavía no cierra y el del
+     * corte en curso, del más próximo al más lejano. Ausente en motores anteriores.
+     */
+    upcomingCuts?: MyCommissionsUpcomingCut[];
     /** Cortes cuya semana empieza en el mes de hoy: cerrados, el anterior aún sin cerrar y el en curso. */
     month: MyCommissionsTotals;
     /** Cortes cuya semana empieza en el año de hoy: cerrados, el anterior aún sin cerrar y el en curso. */

package/src/rules/constants/SegmentLimits.ts

@@ -1,5 +1,8 @@
 /** Identificador SQL permitido para tabla/columna (A§4.3 paso 1): minusculas, digitos y guion bajo; nunca texto libre. */
 export const SEGMENT_IDENTIFIER_PATTERN = /^[a-z_][a-z0-9_]*$/;
+/** Ruta a una hoja de columna struct de Glue (`riskfactors.income.value`): segmentos separados por punto, maximo SEGMENT_MAX_PATH_DEPTH. Una columna plana es una ruta de 1 segmento. */
+export const SEGMENT_COLUMN_PATH_PATTERN = /^[a-z_][a-z0-9_]*(\.[a-z_][a-z0-9_]*){0,7}$/;
+export const SEGMENT_MAX_PATH_DEPTH = 8;
 export const SEGMENT_MAX_DAYS = 365;
 export const SEGMENT_MAX_PARAMS = 40;
 export const SEGMENT_MAX_AGGREGATES = 8;

package/src/rules/dtos/population/SegmentAggregateCondition.ts

@@ -1,6 +1,6 @@
 import { Expose, Type } from 'class-transformer';
 import { ArrayMaxSize, Equals, IsArray, IsEnum, IsNumber, IsOptional, Matches, ValidateNested } from 'class-validator';
-import { SEGMENT_IDENTIFIER_PATTERN } from '../../constants/SegmentLimits';
+import { SEGMENT_COLUMN_PATH_PATTERN, SEGMENT_IDENTIFIER_PATTERN } from '../../constants/SegmentLimits';
 import { SegmentAggregateFnEnum } from '../../enums/SegmentAggregateFnEnum';
 import { SegmentConditionKindEnum } from '../../enums/SegmentConditionKindEnum';
 import { SegmentOperatorEnum } from '../../enums/SegmentOperatorEnum';
@@ -13,7 +13,7 @@ export class SegmentAggregateCondition {
     @Expose() @Matches(SEGMENT_IDENTIFIER_PATTERN) table: string;
     @Expose() @IsEnum(SegmentAggregateFnEnum) fn: SegmentAggregateFnEnum;
     /** Solo SUM. */
-    @Expose() @IsOptional() @Matches(SEGMENT_IDENTIFIER_PATTERN) column?: string;
+    @Expose() @IsOptional() @Matches(SEGMENT_COLUMN_PATH_PATTERN) column?: string;
     /** COUNT y SUM; EXISTS no lleva. */
     @Expose() @IsOptional() @IsEnum(SegmentOperatorEnum) op?: SegmentOperatorEnum;
     @Expose() @IsOptional() @IsNumber() value?: number;

package/src/rules/dtos/population/SegmentColumnCondition.ts

@@ -1,7 +1,7 @@
 import { Expose } from 'class-transformer';
 import { Equals, IsEnum, IsOptional, Matches } from 'class-validator';
 import { JsonValue } from '../../../common';
-import { SEGMENT_IDENTIFIER_PATTERN } from '../../constants/SegmentLimits';
+import { SEGMENT_COLUMN_PATH_PATTERN, SEGMENT_IDENTIFIER_PATTERN } from '../../constants/SegmentLimits';
 import { SegmentConditionKindEnum } from '../../enums/SegmentConditionKindEnum';
 import { SegmentOperatorEnum } from '../../enums/SegmentOperatorEnum';
 
@@ -9,7 +9,7 @@ import { SegmentOperatorEnum } from '../../enums/SegmentOperatorEnum';
 export class SegmentColumnCondition {
     @Expose() @Equals(SegmentConditionKindEnum.COLUMN) kind: SegmentConditionKindEnum.COLUMN;
     @Expose() @Matches(SEGMENT_IDENTIFIER_PATTERN) table: string;
-    @Expose() @Matches(SEGMENT_IDENTIFIER_PATTERN) column: string;
+    @Expose() @Matches(SEGMENT_COLUMN_PATH_PATTERN) column: string;
     @Expose() @IsEnum(SegmentOperatorEnum) op: SegmentOperatorEnum;
     @Expose() @IsOptional() value?: JsonValue;
 }

package/src/rules/dtos/population/SegmentTableSchemaResponse.ts

@@ -2,6 +2,8 @@ import { SegmentOperatorEnum } from '../../enums/SegmentOperatorEnum';
 
 export class SegmentColumnSchemaResponse {
     name: string;
+    /** Columna raiz de Glue cuando `name` es una ruta a una hoja de struct (agrupa en la UI). */
+    root?: string;
     type: string;
     isDate: boolean;
     operators: SegmentOperatorEnum[];

package/src/rules/dtos/population/SegmentWindow.ts

@@ -1,9 +1,9 @@
 import { Expose } from 'class-transformer';
 import { IsInt, Matches, Max, Min } from 'class-validator';
-import { SEGMENT_IDENTIFIER_PATTERN, SEGMENT_MAX_DAYS } from '../../constants/SegmentLimits';
+import { SEGMENT_COLUMN_PATH_PATTERN, SEGMENT_MAX_DAYS } from '../../constants/SegmentLimits';
 
 /** Ventana relativa [referenceAt - days, referenceAt) sobre una columna de fecha (A§4.1). */
 export class SegmentWindow {
-    @Expose() @Matches(SEGMENT_IDENTIFIER_PATTERN) dateColumn: string;
+    @Expose() @Matches(SEGMENT_COLUMN_PATH_PATTERN) dateColumn: string;
     @Expose() @IsInt() @Min(1) @Max(SEGMENT_MAX_DAYS) days: number;
 }