feat: implement ProductModifier class with validation logic for order modifiers

VuXfi · VuXfi · commit a624b3437bbe · 2025-04-11T09:27:45.000+07:00
diff --git a/adapters/index.d.ts b/adapters/index.d.ts
@@ -36,7 +36,7 @@ export declare class Adapter {
     private static instancePromotionAdapter;
     private static instanceDeliveryAdapter;
     private static instanceMF;
-    static WEBRESTO_MODULES_PATH: any;
+    static WEBRESTO_MODULES_PATH: string;
     static getOTPAdapter(adapterName?: string): Promise<OTPAdapter>;
     static getPromotionAdapter(adapter?: string | PromotionAdapter, initParams?: {
         [key: string]: string | number | boolean;
diff --git a/adapters/mediafile/default/local.d.ts b/adapters/mediafile/default/local.d.ts
@@ -39,8 +39,8 @@ export default class LocalMediaFileAdapter extends MediaFileAdapter {
     loadMediaFilesProcessQueue: LoadMediaFilesProcess[];
     constructor(config: BaseConfig);
     getNameByUrl(url: string, ext: string, options?: any, salt?: string): string;
-    protected getPrefix(type?: MediaFileTypes, absolute?: boolean): any;
-    getOriginalFilePath(url: string, type: MediaFileTypes, absolute?: boolean): any;
+    protected getPrefix(type?: MediaFileTypes, absolute?: boolean): string;
+    getOriginalFilePath(url: string, type: MediaFileTypes, absolute?: boolean): string;
     protected download(loadMediaFilesProcess: LoadMediaFilesProcess): Promise<string>;
     private loadMediaFiles;
 }
diff --git a/interfaces/Modifier.d.ts b/interfaces/Modifier.d.ts
@@ -1,5 +1,15 @@
 import { DishRecord } from "../models/Dish";
 import { GroupRecord } from "../models/Group";
+export interface OrderModifier {
+    id: string;
+    /**
+     * Default for amount is 1
+     * This will be changed in a future version to have stricter rules
+     */
+    amount?: number;
+    dish?: DishRecord;
+    modifierId?: string;
+}
 interface BaseModifier {
     /**
      * restocore dishId
@@ -20,16 +30,6 @@ interface BaseModifier {
      */
     freeOfChargeAmount?: number | null;
 }
-export interface OrderModifier {
-    id: string;
-    /**
-     * Default for amount is 1
-     * This will be changed in a future version to have stricter rules
-     */
-    amount?: number;
-    dish?: DishRecord;
-    modifierId?: string;
-}
 export interface Modifier extends BaseModifier {
     /**
     * rmsId
diff --git a/interfaces/Modifier.ts b/interfaces/Modifier.ts
@@ -4,6 +4,19 @@
 import { DishRecord } from "../models/Dish";
 import { GroupRecord } from "../models/Group";
 
+export interface OrderModifier {
+  id: string // means rmsId
+  /**
+   * Default for amount is 1
+   * This will be changed in a future version to have stricter rules
+   */
+  amount?: number
+  dish?: DishRecord  // TODO:  refactor to delete it from OrderModifier
+  modifierId?: string // TODO:  refactor to delete it from OrderModifier
+}
+
+
+
 interface BaseModifier {
   /**
    * restocore dishId
@@ -25,16 +38,6 @@ interface BaseModifier {
   freeOfChargeAmount?: number | null;
 }
 
-export interface OrderModifier {
-  id: string // means rmsId
-  /**
-   * Default for amount is 1
-   * This will be changed in a future version to have stricter rules
-   */
-  amount?: number
-  dish?: DishRecord  // TODO:  refactor to delete it from OrderModifier
-  modifierId?: string // TODO:  refactor to delete it from OrderModifier
-}
 
 export interface Modifier extends BaseModifier {
   /**
@@ -43,6 +46,7 @@ export interface Modifier extends BaseModifier {
   id: string;
 }
 
+
 export interface GroupModifier extends BaseModifier {
   id?: string; // id не обязательный для поддержки вирутальных групп
   childModifiers: Modifier[];
diff --git a/interfaces/index.d.ts b/interfaces/index.d.ts
@@ -29,7 +29,7 @@ export declare class Adapter {
     private static instancePromotionAdapter;
     private static instanceDeliveryAdapter;
     private static instanceMF;
-    static WEBRESTO_MODULES_PATH: any;
+    static WEBRESTO_MODULES_PATH: string;
     static getOTPAdapter(adapterName?: string): Promise<OTPAdapter>;
     static getPromotionAdapter(adapter?: string | PromotionAdapter, initParams?: {
         [key: string]: string | number | boolean;
diff --git a/libs/BackupHandler.d.ts b/libs/BackupHandler.d.ts
@@ -1,3 +1,4 @@
+import * as tar from 'tar';
 interface BaseOptions {
     isDeleted: boolean;
     concepts: string[];
@@ -12,7 +13,7 @@ export declare class BackupHandler {
     private groups;
     private dishes;
     workDir: string;
-    tar: any;
+    tar: typeof tar;
     exportToTar(filePath: string, options?: Partial<BackupOptions>): Promise<void>;
     importFromTar(filePath: string, options?: Partial<RestoreOptions>): Promise<void>;
     private createJSON;
diff --git a/libs/ProductModifier.d.ts b/libs/ProductModifier.d.ts
@@ -0,0 +1,7 @@
+import { GroupModifier, OrderModifier } from "../interfaces/Modifier";
+export declare class ProductModifier {
+    private productModifiers;
+    constructor(productModifiers: GroupModifier[]);
+    validate(orderModifiers: OrderModifier[]): void;
+    private validateGroupOrThrow;
+}
diff --git a/libs/ProductModifier.js b/libs/ProductModifier.js
@@ -0,0 +1,26 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ProductModifier = void 0;
+class ProductModifier {
+    constructor(productModifiers) {
+        this.productModifiers = productModifiers;
+    }
+    validate(orderModifiers) {
+        for (const group of this.productModifiers) {
+            this.validateGroupOrThrow(group, orderModifiers);
+        }
+    }
+    validateGroupOrThrow(group, orderModifiers) {
+        const { id: groupId, childModifiers, minAmount = 0, maxAmount = Infinity } = group;
+        const allowedModifierIds = new Set(childModifiers.map(m => m.id));
+        const relevantOrderMods = orderModifiers.filter(mod => allowedModifierIds.has(mod.id));
+        const selectedAmount = relevantOrderMods.reduce((sum, mod) => sum + (mod.amount ?? 1), 0);
+        if (selectedAmount < minAmount) {
+            throw new Error(`Group ${groupId ?? '[no id]'}: minimum required modifiers is ${minAmount}, but got ${selectedAmount}`);
+        }
+        if (selectedAmount > maxAmount) {
+            throw new Error(`Group ${groupId ?? '[no id]'}: maximum allowed modifiers is ${maxAmount}, but got ${selectedAmount}`);
+        }
+    }
+}
+exports.ProductModifier = ProductModifier;
diff --git a/libs/ProductModifier.ts b/libs/ProductModifier.ts
@@ -0,0 +1,37 @@
+import { GroupModifier, OrderModifier } from "../interfaces/Modifier";
+
+export class ProductModifier {
+  private productModifiers: GroupModifier[];
+
+  constructor(productModifiers: GroupModifier[]) {
+    this.productModifiers = productModifiers;
+  }
+
+  validate(orderModifiers: OrderModifier[]): void {
+    for (const group of this.productModifiers) {
+      this.validateGroupOrThrow(group, orderModifiers);
+    }
+  }
+
+  private validateGroupOrThrow(group: GroupModifier, orderModifiers: OrderModifier[]): void {
+    const { id: groupId, childModifiers, minAmount = 0, maxAmount = Infinity } = group;
+
+    const allowedModifierIds = new Set(childModifiers.map(m => m.id));  
+
+    const relevantOrderMods = orderModifiers.filter(mod => allowedModifierIds.has(mod.id));
+
+    const selectedAmount = relevantOrderMods.reduce((sum, mod) => sum + (mod.amount ?? 1), 0);
+
+    if (selectedAmount < minAmount) {
+      throw new Error(
+        `Group ${groupId ?? '[no id]'}: minimum required modifiers is ${minAmount}, but got ${selectedAmount}`
+      );
+    }
+
+    if (selectedAmount > maxAmount) {
+      throw new Error(
+        `Group ${groupId ?? '[no id]'}: maximum allowed modifiers is ${maxAmount}, but got ${selectedAmount}`
+      );
+    }
+  }
+}
diff --git a/libs/adminpanel/models/bind.d.ts b/libs/adminpanel/models/bind.d.ts
@@ -9,20 +9,20 @@ export declare const models: {
         title: string;
         icon: string;
         list: {
-            fields: FieldsModels;
+            fields: import("sails-adminpanel/interfaces/adminpanelConfig").FieldsModels;
         };
-        edit: CreateUpdateConfig;
-        add: CreateUpdateConfig;
+        edit: import("sails-adminpanel/interfaces/adminpanelConfig").CreateUpdateConfig;
+        add: import("sails-adminpanel/interfaces/adminpanelConfig").CreateUpdateConfig;
     };
     groups: {
         model: string;
         title: string;
         icon: string;
         list: {
-            fields: FieldsModels;
+            fields: import("sails-adminpanel/interfaces/adminpanelConfig").FieldsModels;
         };
-        edit: CreateUpdateConfig;
-        add: CreateUpdateConfig;
+        edit: import("sails-adminpanel/interfaces/adminpanelConfig").CreateUpdateConfig;
+        add: import("sails-adminpanel/interfaces/adminpanelConfig").CreateUpdateConfig;
     };
     orders: {
         model: string;
diff --git a/models/Maintenance.d.ts b/models/Maintenance.d.ts
@@ -30,7 +30,7 @@ declare let Model: {
     afterDestroy: (maintenance: MaintenanceRecord, cb: (err?: string) => void) => void;
     beforeCreate: (maintenance: MaintenanceRecord, cb: (err?: string) => void) => void;
     siteIsOff: () => Promise<boolean>;
-    getActiveMaintenance: (date?: string) => Promise<any>;
+    getActiveMaintenance: (date?: string) => Promise<Maintenance>;
 };
 declare global {
     const Maintenance: typeof Model & ORMModel<Maintenance, null>;
diff --git a/models/Order.js b/models/Order.js
@@ -8,6 +8,7 @@ const decimal_js_1 = __importDefault(require("decimal.js"));
 const phoneValidByMask_1 = require("../libs/phoneValidByMask");
 const OrderHelper_1 = require("../libs/helpers/OrderHelper");
 const isValue_1 = require("../utils/isValue");
+const ProductModifier_1 = require("../libs/ProductModifier");
 let attributes = {
     /** Id  */
     id: {
@@ -320,6 +321,10 @@ let Model = {
         if (dishObj.modifier) {
             throw new Error(`Dish [${dishObj.id}] is modifier`);
         }
+        if (process.env.EXPERIMENTAL) {
+            const productModifier = new ProductModifier_1.ProductModifier(dishObj.modifiers);
+            productModifier.validate(modifiers);
+        }
         /**
          * Add default modifiers in add
          */
diff --git a/models/Order.ts b/models/Order.ts
@@ -25,6 +25,7 @@ import { PaymentDocumentRecord } from "./PaymentDocument";
 import ToInitialize from "../hook/initialize";
 import { or } from "ajv/dist/compile/codegen";
 import { BonusTransaction } from "../adapters/bonusprogram/BonusProgramAdapter";
+import { ProductModifier, validateGroupModifier } from "../libs/ProductModifier";
 
 export interface PromotionState {
   type: string;
@@ -407,7 +408,6 @@ let Model = {
     let dishObj: DishRecord;
 
     if (!addedBy) addedBy = "user";
-
     if (typeof dish === "string") {
       dishObj = (await Dish.find({ id: dish }).limit(1))[0];
 
@@ -430,6 +430,12 @@ let Model = {
       throw new Error(`Dish [${dishObj.id}] is modifier`)
     }
 
+
+    if(process.env.EXPERIMENTAL) {
+      const productModifier = new ProductModifier(dishObj.modifiers)  
+      productModifier.validate(modifiers)
+    }
+
     /**
      * Add default modifiers in add
      */
diff --git a/package.json b/package.json
@@ -89,7 +89,7 @@
     "test:init": "cd ./test/fixture && npm i --no-package-lock --prefix ./ ",
     "test:install": "cd ./test/fixture && npm i --no-package-lock --prefix ./",
     "test": "mocha -r ts-node/register test/bootstrap.ts './test/{,!(fixture)/**}/*.test.ts' --exit",
-    "test:pattern": "mocha -r ts-node/register test/bootstrap.ts './test/{,!(fixture)/**}/*.test.ts' --exit --grep=${PATTERN}",
+    "test:pattern": "mocha -r ts-node/register test/bootstrap.ts './test/{,!(fixture)/**}/*.test.ts' --exit --grep=modifier",
     "test:updb": "cd ./test/fixture && db-migrate up",
     "test:release": "DATASTORE=postgres PG_HOST=127.0.0.1 mocha -r ts-node/register test/bootstrap.ts './test/{,!(fixture)/**}/*.test.ts' --exit --grep=${PATTERN}",
     "build": "tsc",
diff --git a/test/fixture/package.json b/test/fixture/package.json
@@ -7,8 +7,8 @@
   "dependencies": {
     "@webresto/core": "file:../..",
     "async": "^3.2.4",
-    "muddy-water": "^1.0.0",
     "include-all": "^4.0.3",
+    "muddy-water": "^1.0.0",
     "patch-package": "^8.0.0",
     "rc": "^1.0.1",
     "request": "^2.88.2",
diff --git a/test/unit/modifierValidator/modifierValidator.test.d.ts b/test/unit/modifierValidator/modifierValidator.test.d.ts
@@ -0,0 +1 @@
+export {};
diff --git a/test/unit/modifierValidator/modifierValidator.test.js b/test/unit/modifierValidator/modifierValidator.test.js
@@ -0,0 +1,48 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const chai_1 = require("chai");
+const ProductModifier_1 = require("../../../libs/ProductModifier");
+describe('ProductModifier', () => {
+    const childModifiers = [
+        { id: 'm1', modifierId: 'mod1' },
+        { id: 'm2', modifierId: 'mod2' },
+    ];
+    const group = {
+        id: 'g1',
+        childModifiers,
+        minAmount: 1,
+        maxAmount: 2,
+        modifierId: ''
+    };
+    it('is valid when one modifier is selected', () => {
+        const order = [{ id: 'm1', amount: 1 }];
+        const validator = new ProductModifier_1.ProductModifier([group]);
+        (0, chai_1.expect)(() => validator.validate(order)).not.to.throw();
+    });
+    it('is valid when two modifiers are selected', () => {
+        const order = [
+            { id: 'm1', amount: 1 },
+            { id: 'm2', amount: 1 },
+        ];
+        const validator = new ProductModifier_1.ProductModifier([group]);
+        (0, chai_1.expect)(() => validator.validate(order)).not.to.throw();
+    });
+    it('is invalid when no modifiers are selected', () => {
+        const order = [];
+        const validator = new ProductModifier_1.ProductModifier([group]);
+        (0, chai_1.expect)(() => validator.validate(order)).to.throw(/minimum/i);
+    });
+    it('is invalid when maxAmount is exceeded', () => {
+        const order = [
+            { id: 'm1', amount: 2 },
+            { id: 'm2', amount: 1 },
+        ];
+        const validator = new ProductModifier_1.ProductModifier([group]);
+        (0, chai_1.expect)(() => validator.validate(order)).to.throw(/maximum/i);
+    });
+    it('ignores modifiers not in this group', () => {
+        const order = [{ id: 'not-in-group', amount: 10 }];
+        const validator = new ProductModifier_1.ProductModifier([group]);
+        (0, chai_1.expect)(() => validator.validate(order)).to.throw(/minimum/i);
+    });
+});
diff --git a/test/unit/modifierValidator/modifierValidator.test.ts b/test/unit/modifierValidator/modifierValidator.test.ts
