@fiado/type-kit 3.637.0 → 3.638.0

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

@@ -1,4 +1,5 @@
 import type { CommissionPlanStatusEnum } from '../enums/CommissionPlanStatusEnum';
+import type { CommissionRuleStatusEnum } from '../enums/CommissionRuleStatusEnum';
 import type { CommissionPayoutStatusEnum } from '../enums/CommissionPayoutStatusEnum';
 import type { CommissionAddOn, CommissionCategory, CommissionPlanSnapshot, CommissionQuota } from './CommissionPlan';
 import type { CommissionAccrual, CommissionAppliedBonus, CommissionSaleInput, CommissionSaleLine } from './CommissionAccrual';
@@ -227,12 +228,74 @@ export interface RuleActionResponse {
     rule: CommissionRule;
     snapshotId: string;
 }
+/** Un campo de la regla que cambió de una versión a la siguiente, con su valor antes y después. */
+export type CommissionRuleChange = {
+    field: 'name';
+    before: string;
+    after: string;
+} | {
+    field: 'description';
+    before: string | null;
+    after: string | null;
+} | {
+    field: 'levers';
+    before: CommissionRuleLevers;
+    after: CommissionRuleLevers;
+} | {
+    field: 'scope';
+    before: CommissionRuleScope;
+    after: CommissionRuleScope;
+} | {
+    field: 'condition';
+    before: CommissionRuleCondition | null;
+    after: CommissionRuleCondition | null;
+} | {
+    field: 'effectiveFrom';
+    before: string;
+    after: string;
+} | {
+    field: 'effectiveTo';
+    before: string | null;
+    after: string | null;
+} | {
+    field: 'priority';
+    before: number;
+    after: number;
+} | {
+    field: 'replacesOthers';
+    before: boolean;
+    after: boolean;
+} | {
+    field: 'countBy';
+    before: CommissionCountByEnum;
+    after: CommissionCountByEnum;
+} | {
+    field: 'payTiming';
+    before: CommissionPayTimingEnum;
+    after: CommissionPayTimingEnum;
+} | {
+    field: 'onSaleAdvanceBps';
+    before: number | null;
+    after: number | null;
+};
 /** Un evento del historial de una regla. */
 export interface CommissionRuleEvent {
     at: string;
     action: string;
     performedBy: string;
     version: number | null;
+    /**
+     * Solo en ediciones: lo que cambió respecto a la versión anterior; vacío si no cambió ningún campo.
+     * Ausente si no hay versión anterior con qué comparar, y en motores anteriores.
+     */
+    changes?: CommissionRuleChange[];
+    /** Junto a `changes`: si la versión editada cuenta piezas o ventas, para leer sus palancas y su condición. */
+    countBy?: CommissionCountByEnum;
+    /** El estado que tenía la regla y el que le dejó el evento; `null` si no lo cambió o no se sabe. Ausente en motores anteriores. */
+    statusChange?: {
+        from: CommissionRuleStatusEnum;
+        to: CommissionRuleStatusEnum;
+    } | null;
 }
 /** `GET /backoffice/commissions/rules/{ruleId}/history` — del más nuevo al más viejo. */
 export interface RuleHistoryResponse {

package/package.json

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

package/src/retailCommission/dtos/CommissionApi.ts

@@ -1,4 +1,5 @@
 import type { CommissionPlanStatusEnum } from '../enums/CommissionPlanStatusEnum';
+import type { CommissionRuleStatusEnum } from '../enums/CommissionRuleStatusEnum';
 import type { CommissionPayoutStatusEnum } from '../enums/CommissionPayoutStatusEnum';
 import type {
     CommissionAddOn,
@@ -295,12 +296,36 @@ export interface RuleActionResponse {
     snapshotId: string;
 }
 
+/** Un campo de la regla que cambió de una versión a la siguiente, con su valor antes y después. */
+export type CommissionRuleChange =
+    | { field: 'name'; before: string; after: string }
+    | { field: 'description'; before: string | null; after: string | null }
+    | { field: 'levers'; before: CommissionRuleLevers; after: CommissionRuleLevers }
+    | { field: 'scope'; before: CommissionRuleScope; after: CommissionRuleScope }
+    | { field: 'condition'; before: CommissionRuleCondition | null; after: CommissionRuleCondition | null }
+    | { field: 'effectiveFrom'; before: string; after: string }
+    | { field: 'effectiveTo'; before: string | null; after: string | null }
+    | { field: 'priority'; before: number; after: number }
+    | { field: 'replacesOthers'; before: boolean; after: boolean }
+    | { field: 'countBy'; before: CommissionCountByEnum; after: CommissionCountByEnum }
+    | { field: 'payTiming'; before: CommissionPayTimingEnum; after: CommissionPayTimingEnum }
+    | { field: 'onSaleAdvanceBps'; before: number | null; after: number | null };
+
 /** Un evento del historial de una regla. */
 export interface CommissionRuleEvent {
     at: string;
     action: string;
     performedBy: string;
     version: number | null;
+    /**
+     * Solo en ediciones: lo que cambió respecto a la versión anterior; vacío si no cambió ningún campo.
+     * Ausente si no hay versión anterior con qué comparar, y en motores anteriores.
+     */
+    changes?: CommissionRuleChange[];
+    /** Junto a `changes`: si la versión editada cuenta piezas o ventas, para leer sus palancas y su condición. */
+    countBy?: CommissionCountByEnum;
+    /** El estado que tenía la regla y el que le dejó el evento; `null` si no lo cambió o no se sabe. Ausente en motores anteriores. */
+    statusChange?: { from: CommissionRuleStatusEnum; to: CommissionRuleStatusEnum } | null;
 }
 
 /** `GET /backoffice/commissions/rules/{ruleId}/history` — del más nuevo al más viejo. */