@fiado/type-kit 3.503.0 → 3.505.0

package/_test_/unit/retailCommission/commissionRules.test.ts

@@ -24,6 +24,10 @@ describe('retailCommission — enums de las reglas', () => {
         expect(Object.values(RetailCommission.CommissionOperatorEnum)).toEqual(['GTE', 'LTE', 'LT', 'GT', 'BETWEEN', 'IN']);
     });
 
+    it('una regla cuenta piezas o ventas', () => {
+        expect(Object.values(RetailCommission.CommissionCountByEnum)).toEqual(['PIECE', 'SALE']);
+    });
+
     it('expone las ventanas del corte', () => {
         expect(Object.values(RetailCommission.CommissionWindowEnum)).toEqual(['SEMANA_OPERATIVA', 'ROLLING_7D', 'MES']);
     });

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

@@ -107,7 +107,7 @@ export interface CommissionAppliedBonus {
     name: string;
     lineId: string;
     sku: string;
-    /** Posición de la pieza en el contador de la regla dentro del periodo. */
+    /** Posición de la pieza (o de la venta, si la regla cuenta ventas) en el contador de la regla dentro del periodo. */
     position: number;
     mode: CommissionBonusModeEnum;
     amountCents: number;

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

@@ -5,6 +5,7 @@ import type { CommissionAccrual, CommissionAppliedBonus, CommissionSaleInput, Co
 import type { CommissionAdjustment, CommissionAppliedMultiplier, CommissionAppliedThreshold, CommissionPayout, CommissionPayoutSeller, CommissionSellerBreakdown } from './CommissionPayout';
 import type { CommissionPolicies, CommissionRule, CommissionRuleCondition, CommissionRuleLevers, CommissionRuleScope, CommissionRuleSetSnapshot } from './CommissionRule';
 import type { CommissionWindowEnum } from '../enums/CommissionWindowEnum';
+import type { CommissionCountByEnum } from '../enums/CommissionCountByEnum';
 import type { CommissionAggregateByEnum } from '../enums/CommissionAggregateByEnum';
 import type { CommissionSeriesByEnum } from '../enums/CommissionSeriesByEnum';
 import type { CommissionAccrualStatusEnum } from '../enums/CommissionAccrualStatusEnum';
@@ -194,6 +195,8 @@ export interface CommissionRuleInput {
     effectiveTo: string | null;
     priority: number;
     replacesOthers: boolean;
+    /** Si la regla cuenta piezas o ventas. Ausente = `PIECE`. */
+    countBy?: CommissionCountByEnum;
 }
 /** `POST /backoffice/commissions/rules` — la regla nace en borrador. */
 export type CreateRuleRequest = CommissionRuleInput;
@@ -370,6 +373,8 @@ export interface CommissionRuleView {
     condition: CommissionRuleCondition | null;
     effectiveFrom: string;
     effectiveTo: string | null;
+    /** Si la regla cuenta piezas o ventas. Ausente = `PIECE`. */
+    countBy?: CommissionCountByEnum;
 }
 /** Lo pagado en varios cortes. */
 export interface MyCommissionsTotals {

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

@@ -1,4 +1,5 @@
 import type { CommissionPayoutStatusEnum } from '../enums/CommissionPayoutStatusEnum';
+import type { CommissionCountByEnum } from '../enums/CommissionCountByEnum';
 /**
  * El corte semanal y todo lo que cuelga de él.
  * SureKeep Fase 3 — pista Retail.
@@ -77,8 +78,10 @@ export interface CommissionAdjustment {
 export interface CommissionRuleContribution {
     ruleId: string;
     name: string;
-    /** Piezas que pagaron esta regla. */
+    /** Piezas que pagaron esta regla; ventas, si la regla cuenta ventas. */
     unitsCount: number;
+    /** Si la regla cuenta piezas o ventas. Ausente = `PIECE`. */
+    countBy?: CommissionCountByEnum;
     bonusCents: number;
     /** Su parte del multiplicador, en proporción a su bono. */
     multiplierShareCents: number;

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

@@ -1,6 +1,7 @@
 import type { ProductCategoryEnum } from '../../retailCatalog/enums/ProductCategoryEnum';
 import type { ProductTierEnum } from '../../retailCatalog/enums/ProductTierEnum';
 import type { CommissionBonusModeEnum } from '../enums/CommissionBonusModeEnum';
+import type { CommissionCountByEnum } from '../enums/CommissionCountByEnum';
 import type { CommissionMetricEnum } from '../enums/CommissionMetricEnum';
 import type { CommissionOperatorEnum } from '../enums/CommissionOperatorEnum';
 import type { CommissionRuleStatusEnum } from '../enums/CommissionRuleStatusEnum';
@@ -72,6 +73,8 @@ export interface CommissionRule {
     priority: number;
     /** Solo con multiplicador: si dispara, es el único multiplicador del corte. */
     replacesOthers: boolean;
+    /** Si la regla cuenta piezas o ventas. Ausente = `PIECE`. */
+    countBy?: CommissionCountByEnum;
     /** Sube en cada guardado. */
     version: number;
     /** La versión que está en el plan vigente. `null` si nunca se publicó. */

package/bin/retailCommission/enums/CommissionBonusModeEnum.d.ts

@@ -1,8 +1,8 @@
 /**
  * Cómo se calcula un bono.
  *
- * FIXED - Monto fijo en centavos por pieza.
- * PERCENT - Puntos base sobre el precio neto de la pieza (10000 = 100%).
+ * FIXED - Monto fijo en centavos por pieza, o por venta si la regla cuenta ventas.
+ * PERCENT - Puntos base sobre el precio neto de la pieza, o de las piezas de la venta en el alcance si la regla cuenta ventas (10000 = 100%).
  */
 export declare enum CommissionBonusModeEnum {
     FIXED = "FIXED",

package/bin/retailCommission/enums/CommissionBonusModeEnum.js

@@ -4,8 +4,8 @@ exports.CommissionBonusModeEnum = void 0;
 /**
  * Cómo se calcula un bono.
  *
- * FIXED - Monto fijo en centavos por pieza.
- * PERCENT - Puntos base sobre el precio neto de la pieza (10000 = 100%).
+ * FIXED - Monto fijo en centavos por pieza, o por venta si la regla cuenta ventas.
+ * PERCENT - Puntos base sobre el precio neto de la pieza, o de las piezas de la venta en el alcance si la regla cuenta ventas (10000 = 100%).
  */
 var CommissionBonusModeEnum;
 (function (CommissionBonusModeEnum) {

package/bin/retailCommission/enums/CommissionCountByEnum.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Qué cuenta una regla para su posición y su bono por venta.
+ *
+ * PIECE - Cada pieza vendida: una venta con teléfono y funda son dos.
+ * SALE - Cada venta (ticket), sin importar cuántas piezas lleve.
+ */
+export declare enum CommissionCountByEnum {
+    PIECE = "PIECE",
+    SALE = "SALE"
+}

package/bin/retailCommission/enums/CommissionCountByEnum.js

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CommissionCountByEnum = void 0;
+/**
+ * Qué cuenta una regla para su posición y su bono por venta.
+ *
+ * PIECE - Cada pieza vendida: una venta con teléfono y funda son dos.
+ * SALE - Cada venta (ticket), sin importar cuántas piezas lleve.
+ */
+var CommissionCountByEnum;
+(function (CommissionCountByEnum) {
+    CommissionCountByEnum["PIECE"] = "PIECE";
+    CommissionCountByEnum["SALE"] = "SALE";
+})(CommissionCountByEnum || (exports.CommissionCountByEnum = CommissionCountByEnum = {}));

package/bin/retailCommission/enums/CommissionMetricEnum.d.ts

@@ -1,7 +1,7 @@
 /**
  * Métricas de la condición de una regla.
  *
- * POSICION_VENTA_EN_PERIODO - Lugar de la pieza entre las del vendedor en el periodo que caen en el alcance de la regla.
+ * POSICION_VENTA_EN_PERIODO - Lugar de la pieza (o de la venta, si la regla cuenta ventas) entre las del vendedor en el periodo que caen en el alcance de la regla.
  * COLOCACION_PERIODO - Suma del precio neto de todo lo que el vendedor vendió en el periodo, en centavos.
  * NPI_M30_VENDEDOR - Proporción de créditos del vendedor con primer impago a 30 días, en bps. Viene del crédito.
  * SKUS_DISTINTOS_PERIODO - Cuántos SKUs distintos vendió el vendedor en el periodo.

package/bin/retailCommission/enums/CommissionMetricEnum.js

@@ -4,7 +4,7 @@ exports.CommissionMetricEnum = void 0;
 /**
  * Métricas de la condición de una regla.
  *
- * POSICION_VENTA_EN_PERIODO - Lugar de la pieza entre las del vendedor en el periodo que caen en el alcance de la regla.
+ * POSICION_VENTA_EN_PERIODO - Lugar de la pieza (o de la venta, si la regla cuenta ventas) entre las del vendedor en el periodo que caen en el alcance de la regla.
  * COLOCACION_PERIODO - Suma del precio neto de todo lo que el vendedor vendió en el periodo, en centavos.
  * NPI_M30_VENDEDOR - Proporción de créditos del vendedor con primer impago a 30 días, en bps. Viene del crédito.
  * SKUS_DISTINTOS_PERIODO - Cuántos SKUs distintos vendió el vendedor en el periodo.

package/bin/retailCommission/index.d.ts

@@ -16,6 +16,7 @@ export * from './enums/CommissionBonusModeEnum';
 export * from './enums/CommissionMetricEnum';
 export * from './enums/CommissionOperatorEnum';
 export * from './enums/CommissionWindowEnum';
+export * from './enums/CommissionCountByEnum';
 export * from './enums/CommissionAggregateByEnum';
 export * from './enums/CommissionSeriesByEnum';
 export * from './enums/CommissionSimulationSkipEnum';

package/bin/retailCommission/index.js

@@ -33,6 +33,7 @@ __exportStar(require("./enums/CommissionBonusModeEnum"), exports);
 __exportStar(require("./enums/CommissionMetricEnum"), exports);
 __exportStar(require("./enums/CommissionOperatorEnum"), exports);
 __exportStar(require("./enums/CommissionWindowEnum"), exports);
+__exportStar(require("./enums/CommissionCountByEnum"), exports);
 __exportStar(require("./enums/CommissionAggregateByEnum"), exports);
 __exportStar(require("./enums/CommissionSeriesByEnum"), exports);
 __exportStar(require("./enums/CommissionSimulationSkipEnum"), exports);

package/package.json

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

package/src/retailCommission/dtos/CommissionAccrual.ts

@@ -112,7 +112,7 @@ export interface CommissionAppliedBonus {
     name: string;
     lineId: string;
     sku: string;
-    /** Posición de la pieza en el contador de la regla dentro del periodo. */
+    /** Posición de la pieza (o de la venta, si la regla cuenta ventas) en el contador de la regla dentro del periodo. */
     position: number;
     mode: CommissionBonusModeEnum;
     amountCents: number;

package/src/retailCommission/dtos/CommissionApi.ts

@@ -24,6 +24,7 @@ import type {
     CommissionRuleSetSnapshot,
 } from './CommissionRule';
 import type { CommissionWindowEnum } from '../enums/CommissionWindowEnum';
+import type { CommissionCountByEnum } from '../enums/CommissionCountByEnum';
 import type { CommissionAggregateByEnum } from '../enums/CommissionAggregateByEnum';
 import type { CommissionSeriesByEnum } from '../enums/CommissionSeriesByEnum';
 import type { CommissionAccrualStatusEnum } from '../enums/CommissionAccrualStatusEnum';
@@ -251,6 +252,8 @@ export interface CommissionRuleInput {
     effectiveTo: string | null;
     priority: number;
     replacesOthers: boolean;
+    /** Si la regla cuenta piezas o ventas. Ausente = `PIECE`. */
+    countBy?: CommissionCountByEnum;
 }
 
 /** `POST /backoffice/commissions/rules` — la regla nace en borrador. */
@@ -447,6 +450,8 @@ export interface CommissionRuleView {
     condition: CommissionRuleCondition | null;
     effectiveFrom: string;
     effectiveTo: string | null;
+    /** Si la regla cuenta piezas o ventas. Ausente = `PIECE`. */
+    countBy?: CommissionCountByEnum;
 }
 
 /** Lo pagado en varios cortes. */

package/src/retailCommission/dtos/CommissionPayout.ts

@@ -1,4 +1,5 @@
 import type { CommissionPayoutStatusEnum } from '../enums/CommissionPayoutStatusEnum';
+import type { CommissionCountByEnum } from '../enums/CommissionCountByEnum';
 
 /**
  * El corte semanal y todo lo que cuelga de él.
@@ -81,8 +82,10 @@ export interface CommissionAdjustment {
 export interface CommissionRuleContribution {
     ruleId: string;
     name: string;
-    /** Piezas que pagaron esta regla. */
+    /** Piezas que pagaron esta regla; ventas, si la regla cuenta ventas. */
     unitsCount: number;
+    /** Si la regla cuenta piezas o ventas. Ausente = `PIECE`. */
+    countBy?: CommissionCountByEnum;
     bonusCents: number;
     /** Su parte del multiplicador, en proporción a su bono. */
     multiplierShareCents: number;

package/src/retailCommission/dtos/CommissionRule.ts

@@ -1,6 +1,7 @@
 import type { ProductCategoryEnum } from '../../retailCatalog/enums/ProductCategoryEnum';
 import type { ProductTierEnum } from '../../retailCatalog/enums/ProductTierEnum';
 import type { CommissionBonusModeEnum } from '../enums/CommissionBonusModeEnum';
+import type { CommissionCountByEnum } from '../enums/CommissionCountByEnum';
 import type { CommissionMetricEnum } from '../enums/CommissionMetricEnum';
 import type { CommissionOperatorEnum } from '../enums/CommissionOperatorEnum';
 import type { CommissionRuleStatusEnum } from '../enums/CommissionRuleStatusEnum';
@@ -81,6 +82,8 @@ export interface CommissionRule {
     priority: number;
     /** Solo con multiplicador: si dispara, es el único multiplicador del corte. */
     replacesOthers: boolean;
+    /** Si la regla cuenta piezas o ventas. Ausente = `PIECE`. */
+    countBy?: CommissionCountByEnum;
     /** Sube en cada guardado. */
     version: number;
     /** La versión que está en el plan vigente. `null` si nunca se publicó. */

package/src/retailCommission/enums/CommissionBonusModeEnum.ts

@@ -1,8 +1,8 @@
 /**
  * Cómo se calcula un bono.
  *
- * FIXED - Monto fijo en centavos por pieza.
- * PERCENT - Puntos base sobre el precio neto de la pieza (10000 = 100%).
+ * FIXED - Monto fijo en centavos por pieza, o por venta si la regla cuenta ventas.
+ * PERCENT - Puntos base sobre el precio neto de la pieza, o de las piezas de la venta en el alcance si la regla cuenta ventas (10000 = 100%).
  */
 export enum CommissionBonusModeEnum {
     FIXED = 'FIXED',

package/src/retailCommission/enums/CommissionCountByEnum.ts

@@ -0,0 +1,10 @@
+/**
+ * Qué cuenta una regla para su posición y su bono por venta.
+ *
+ * PIECE - Cada pieza vendida: una venta con teléfono y funda son dos.
+ * SALE - Cada venta (ticket), sin importar cuántas piezas lleve.
+ */
+export enum CommissionCountByEnum {
+    PIECE = 'PIECE',
+    SALE = 'SALE',
+}

package/src/retailCommission/enums/CommissionMetricEnum.ts

@@ -1,7 +1,7 @@
 /**
  * Métricas de la condición de una regla.
  *
- * POSICION_VENTA_EN_PERIODO - Lugar de la pieza entre las del vendedor en el periodo que caen en el alcance de la regla.
+ * POSICION_VENTA_EN_PERIODO - Lugar de la pieza (o de la venta, si la regla cuenta ventas) entre las del vendedor en el periodo que caen en el alcance de la regla.
  * COLOCACION_PERIODO - Suma del precio neto de todo lo que el vendedor vendió en el periodo, en centavos.
  * NPI_M30_VENDEDOR - Proporción de créditos del vendedor con primer impago a 30 días, en bps. Viene del crédito.
  * SKUS_DISTINTOS_PERIODO - Cuántos SKUs distintos vendió el vendedor en el periodo.

package/src/retailCommission/index.ts

@@ -17,6 +17,7 @@ export * from './enums/CommissionBonusModeEnum';
 export * from './enums/CommissionMetricEnum';
 export * from './enums/CommissionOperatorEnum';
 export * from './enums/CommissionWindowEnum';
+export * from './enums/CommissionCountByEnum';
 export * from './enums/CommissionAggregateByEnum';
 export * from './enums/CommissionSeriesByEnum';
 export * from './enums/CommissionSimulationSkipEnum';