@pisell/pisellos 0.10.14 → 0.10.16

package/lib/model/strategy/adapter/itemRule/examples.js

@@ -1,257 +1,317 @@
-var __defProp = Object.defineProperty;
-var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
-var __getOwnPropNames = Object.getOwnPropertyNames;
-var __hasOwnProp = Object.prototype.hasOwnProperty;
-var __export = (target, all) => {
-  for (var name in all)
-    __defProp(target, name, { get: all[name], enumerable: true });
-};
-var __copyProps = (to, from, except, desc) => {
-  if (from && typeof from === "object" || typeof from === "function") {
-    for (let key of __getOwnPropNames(from))
-      if (!__hasOwnProp.call(to, key) && key !== except)
-        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
-  }
-  return to;
-};
-var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+"use strict";
 
-// src/model/strategy/adapter/itemRule/examples.ts
-var examples_exports = {};
-__export(examples_exports, {
-  HOTPOT_BASE_PICK_ONE_STRATEGY: () => HOTPOT_BASE_PICK_ONE_STRATEGY,
-  HOTPOT_BASE_REQUIRED_STRATEGY: () => HOTPOT_BASE_REQUIRED_STRATEGY,
-  MAX_BUNS_PER_TABLE_STRATEGY: () => MAX_BUNS_PER_TABLE_STRATEGY,
-  MIN_CONDIMENT_PER_PERSON_STRATEGY: () => MIN_CONDIMENT_PER_PERSON_STRATEGY,
-  quickUseItemRuleEvaluator: () => quickUseItemRuleEvaluator,
-  runItemRuleEvaluatorDemo: () => runItemRuleEvaluatorDemo
+Object.defineProperty(exports, "__esModule", {
+  value: true
 });
-module.exports = __toCommonJS(examples_exports);
-var import_evaluator = require("./evaluator");
-var import_type = require("./type");
-var MIN_CONDIMENT_PER_PERSON_STRATEGY = {
+exports.MIN_CONDIMENT_PER_PERSON_STRATEGY = exports.MAX_BUNS_PER_TABLE_STRATEGY = exports.HOTPOT_BASE_REQUIRED_STRATEGY = exports.HOTPOT_BASE_PICK_ONE_STRATEGY = void 0;
+exports.quickUseItemRuleEvaluator = quickUseItemRuleEvaluator;
+exports.runItemRuleEvaluatorDemo = runItemRuleEvaluatorDemo;
+var _evaluator = require("./evaluator");
+var _type = require("./type");
+// ============================================
+// 示例 1：每人至少一份小料 (Minimum Per Person)
+// ============================================
+
+/**
+ * 场景：火锅店扫码点餐，要求小料数量 >= 成人人数，自动添加到购物车
+ *
+ * WHEN: Always active
+ * THEN:
+ *   - Quantity Check: 小料最少数量 = Adult Pax
+ *   - Prefill Cart: 自动添加小料 x Adult Pax
+ */
+const MIN_CONDIMENT_PER_PERSON_STRATEGY = exports.MIN_CONDIMENT_PER_PERSON_STRATEGY = {
   metadata: {
-    id: "RULE_MIN_CONDIMENT_PER_PERSON",
+    id: 'RULE_MIN_CONDIMENT_PER_PERSON',
     name: {
-      "zh-CN": "每人至少一份小料",
-      en: "Min 1 Condiment per person"
+      'zh-CN': '每人至少一份小料',
+      en: 'Min 1 Condiment per person'
     },
-    type: "item_rule",
+    type: 'item_rule',
     description: {
-      "zh-CN": "火锅小料数量不少于成人人数，自动添加",
-      en: "Condiment count must be at least adult pax, auto-added to cart"
+      'zh-CN': '火锅小料数量不少于成人人数，自动添加',
+      en: 'Condiment count must be at least adult pax, auto-added to cart'
     }
   },
   conditions: {
-    operator: "and",
+    operator: 'and',
     rules: [],
-    actionIds: ["quantity_check_condiment", "prefill_condiment"]
+    actionIds: ['quantity_check_condiment', 'prefill_condiment']
   },
-  actions: [
-    {
-      id: "quantity_check_condiment",
-      type: import_type.ITEM_RULE_ACTION_TYPES.QUANTITY_CHECK,
-      value: null,
-      target: "cart",
-      priority: 10,
-      config: {
-        targetType: "product",
-        targets: [{ product_id: 10001 }, { product_id: 10002 }],
-        quantityRules: [
-          { comparison: "minimum", source: "total_pax" }
-        ],
-        scope: "first_submission_only",
-        validationMessage: {
-          "zh-CN": "小料至少需要 {min} 份（每位成人一份）",
-          en: "Condiment requires at least {min} items (one per adult)"
-        }
-      }
-    },
-    {
-      id: "prefill_condiment",
-      type: import_type.ITEM_RULE_ACTION_TYPES.PREFILL_CART,
-      value: null,
-      target: "cart",
-      priority: 5,
-      config: {
-        products: [
-          {
-            product_id: 10001,
-            quantityFrom: "total_pax"
-          }
-        ]
+  actions: [{
+    id: 'quantity_check_condiment',
+    type: _type.ITEM_RULE_ACTION_TYPES.QUANTITY_CHECK,
+    value: null,
+    target: 'cart',
+    priority: 10,
+    config: {
+      targetType: 'product',
+      targets: [{
+        product_id: 10001
+      }, {
+        product_id: 10002
+      }],
+      quantityRules: [{
+        comparison: 'minimum',
+        source: 'total_pax'
+      }],
+      scope: 'first_submission_only',
+      validationMessage: {
+        'zh-CN': '小料至少需要 {min} 份（每位成人一份）',
+        en: 'Condiment requires at least {min} items (one per adult)'
       }
     }
-  ]
+  }, {
+    id: 'prefill_condiment',
+    type: _type.ITEM_RULE_ACTION_TYPES.PREFILL_CART,
+    value: null,
+    target: 'cart',
+    priority: 5,
+    config: {
+      products: [{
+        product_id: 10001,
+        quantityFrom: 'total_pax'
+      }]
+    }
+  }]
 };
-var MAX_BUNS_PER_TABLE_STRATEGY = {
+
+// ============================================
+// 示例 2：每桌限量3份包子 (Maximum Per Table)
+// ============================================
+
+/**
+ * 场景：包子限量供应，每桌最多3份（含加单累计），肉包和菜包合计
+ *
+ * WHEN: Always active
+ * THEN:
+ *   - Quantity Check: 肉包 + 菜包 合计 <= 3，scope=cumulative
+ */
+const MAX_BUNS_PER_TABLE_STRATEGY = exports.MAX_BUNS_PER_TABLE_STRATEGY = {
   metadata: {
-    id: "RULE_MAX_BUNS_PER_TABLE",
+    id: 'RULE_MAX_BUNS_PER_TABLE',
     name: {
-      "zh-CN": "每桌限量供应3份包子",
-      en: "3 Buns limit per table"
+      'zh-CN': '每桌限量供应3份包子',
+      en: '3 Buns limit per table'
     },
-    type: "item_rule",
+    type: 'item_rule',
     description: {
-      "zh-CN": "肉包和菜包合计每桌不超过3份，含加单累计",
-      en: "Max 3 buns per table (pork + veggie combined, cumulative)"
+      'zh-CN': '肉包和菜包合计每桌不超过3份，含加单累计',
+      en: 'Max 3 buns per table (pork + veggie combined, cumulative)'
     }
   },
   conditions: {
-    operator: "and",
+    operator: 'and',
     rules: [],
-    actionIds: ["quantity_check_buns"]
+    actionIds: ['quantity_check_buns']
   },
-  actions: [
-    {
-      id: "quantity_check_buns",
-      type: import_type.ITEM_RULE_ACTION_TYPES.QUANTITY_CHECK,
-      value: null,
-      target: "cart",
-      priority: 10,
-      config: {
-        targetType: "product",
-        targets: [
-          { product_id: 20001 },
-          { product_id: 20002 }
-        ],
-        quantityRules: [
-          { comparison: "maximum", source: "fixed", value: 3 }
-        ],
-        scope: "cumulative",
-        validationMessage: {
-          "zh-CN": "包子每桌限量 {max} 份（含加单累计）",
-          en: "Buns are limited to {max} per table (cumulative)"
-        }
+  actions: [{
+    id: 'quantity_check_buns',
+    type: _type.ITEM_RULE_ACTION_TYPES.QUANTITY_CHECK,
+    value: null,
+    target: 'cart',
+    priority: 10,
+    config: {
+      targetType: 'product',
+      targets: [{
+        product_id: 20001
+      }, {
+        product_id: 20002
+      }],
+      quantityRules: [{
+        comparison: 'maximum',
+        source: 'fixed',
+        value: 3
+      }],
+      scope: 'cumulative',
+      validationMessage: {
+        'zh-CN': '包子每桌限量 {max} 份（含加单累计）',
+        en: 'Buns are limited to {max} per table (cumulative)'
       }
     }
-  ]
+  }]
 };
-var HOTPOT_BASE_REQUIRED_STRATEGY = {
+
+// ============================================
+// 示例 3：锅底必选 (Must Include - Conditional)
+// ============================================
+
+/**
+ * 场景：堂食必须选择一个锅底（按商品匹配），自动预填默认锅底
+ *
+ * WHEN: Service Type = Dine-in
+ * THEN:
+ *   - Quantity Check: 指定锅底商品精确1份
+ *   - Prefill Cart: 自动添加默认锅底 x 1
+ */
+const HOTPOT_BASE_REQUIRED_STRATEGY = exports.HOTPOT_BASE_REQUIRED_STRATEGY = {
   metadata: {
-    id: "RULE_HOTPOT_BASE_REQUIRED",
+    id: 'RULE_HOTPOT_BASE_REQUIRED',
     name: {
-      "zh-CN": "锅底必选",
-      en: "Hotpot base required"
+      'zh-CN': '锅底必选',
+      en: 'Hotpot base required'
     },
-    type: "item_rule",
+    type: 'item_rule',
     description: {
-      "zh-CN": "堂食必须选择一个锅底",
-      en: "Hotpot base is mandatory for dine-in"
+      'zh-CN': '堂食必须选择一个锅底',
+      en: 'Hotpot base is mandatory for dine-in'
     }
   },
   conditions: {
-    operator: "and",
-    rules: [
-      {
-        type: "operator",
-        dimension: "context",
-        field: "serviceType",
-        operator: "=",
-        value: "dine-in"
-      }
-    ],
-    actionIds: ["quantity_check_base", "prefill_base"]
+    operator: 'and',
+    rules: [{
+      type: 'operator',
+      dimension: 'context',
+      field: 'serviceType',
+      operator: '=',
+      value: 'dine-in'
+    }],
+    actionIds: ['quantity_check_base', 'prefill_base']
   },
-  actions: [
-    {
-      id: "quantity_check_base",
-      type: import_type.ITEM_RULE_ACTION_TYPES.QUANTITY_CHECK,
-      value: null,
-      target: "cart",
-      priority: 10,
-      config: {
-        targetType: "product",
-        targets: [{ product_id: 30001 }],
-        quantityRules: [
-          { comparison: "exact", source: "fixed", value: 1 }
-        ],
-        scope: "first_submission_only",
-        validationMessage: {
-          "zh-CN": "请选择 {exact} 个锅底",
-          en: "Please select exactly {exact} hotpot base"
-        }
-      }
-    },
-    {
-      id: "prefill_base",
-      type: import_type.ITEM_RULE_ACTION_TYPES.PREFILL_CART,
-      value: null,
-      target: "cart",
-      priority: 5,
-      config: {
-        products: [
-          {
-            product_id: 30001,
-            quantityFrom: "fixed",
-            quantity: 1
-          }
-        ]
+  actions: [{
+    id: 'quantity_check_base',
+    type: _type.ITEM_RULE_ACTION_TYPES.QUANTITY_CHECK,
+    value: null,
+    target: 'cart',
+    priority: 10,
+    config: {
+      targetType: 'product',
+      targets: [{
+        product_id: 30001
+      }],
+      quantityRules: [{
+        comparison: 'exact',
+        source: 'fixed',
+        value: 1
+      }],
+      scope: 'first_submission_only',
+      validationMessage: {
+        'zh-CN': '请选择 {exact} 个锅底',
+        en: 'Please select exactly {exact} hotpot base'
       }
     }
-  ]
+  }, {
+    id: 'prefill_base',
+    type: _type.ITEM_RULE_ACTION_TYPES.PREFILL_CART,
+    value: null,
+    target: 'cart',
+    priority: 5,
+    config: {
+      products: [{
+        product_id: 30001,
+        quantityFrom: 'fixed',
+        quantity: 1
+      }]
+    }
+  }]
 };
-var HOTPOT_BASE_PICK_ONE_STRATEGY = {
+
+// ============================================
+// 示例 4：锅底四选一（Multi-target OR 组至少 1 份）
+// ============================================
+
+/**
+ * 场景：4 款锅底里任选至少 1 款，不自动预填，不限制多选上限
+ *
+ * WHEN: Always active
+ * THEN:
+ *   - Quantity Check: 4 个锅底商品合计数量 >= 1 （OR 组语义）
+ *
+ * 说明：
+ *   - targets 里放多个 product_id 时，ItemRuleAdapter 会把它们视为 OR 组，
+ *     仅校验「合计数量」，不会要求每款各自满足 min。
+ *   - ScanOrder 工具层 buildQuantityLimitIndex 会跳过多目标规则的
+ *     单品索引，避免 UI 把组级 min 误当作每张商品卡的减号下限，
+ *     锁死用户切换锅底的操作。
+ */
+const HOTPOT_BASE_PICK_ONE_STRATEGY = exports.HOTPOT_BASE_PICK_ONE_STRATEGY = {
   metadata: {
-    id: "RULE_HOTPOT_BASE_PICK_ONE",
+    id: 'RULE_HOTPOT_BASE_PICK_ONE',
     name: {
-      "zh-CN": "锅底必选（四选一）",
-      en: "Hotpot base required (pick any)"
+      'zh-CN': '锅底必选（四选一）',
+      en: 'Hotpot base required (pick any)'
     },
-    type: "item_rule",
+    type: 'item_rule',
     description: {
-      "zh-CN": "4 款锅底任选至少 1 份",
-      en: "Pick at least 1 hotpot base from the available options"
+      'zh-CN': '4 款锅底任选至少 1 份',
+      en: 'Pick at least 1 hotpot base from the available options'
     }
   },
   conditions: {
-    operator: "and",
+    operator: 'and',
     rules: [],
-    actionIds: ["quantity_check_hotpot_base_group"]
+    actionIds: ['quantity_check_hotpot_base_group']
   },
-  actions: [
-    {
-      id: "quantity_check_hotpot_base_group",
-      type: import_type.ITEM_RULE_ACTION_TYPES.QUANTITY_CHECK,
-      value: null,
-      target: "cart",
-      priority: 10,
-      config: {
-        targetType: "product",
-        targets: [
-          { product_id: 30001 },
-          { product_id: 30002 },
-          { product_id: 30003 },
-          { product_id: 30004 }
-        ],
-        quantityRules: [
-          { comparison: "minimum", source: "fixed", value: 1 }
-        ],
-        scope: "first_submission_only",
-        validationMessage: {
-          "zh-CN": "请至少选择 {min} 款锅底",
-          en: "Please select at least {min} hotpot base"
-        }
+  actions: [{
+    id: 'quantity_check_hotpot_base_group',
+    type: _type.ITEM_RULE_ACTION_TYPES.QUANTITY_CHECK,
+    value: null,
+    target: 'cart',
+    priority: 10,
+    config: {
+      targetType: 'product',
+      targets: [{
+        product_id: 30001
+      }, {
+        product_id: 30002
+      }, {
+        product_id: 30003
+      }, {
+        product_id: 30004
+      }],
+      quantityRules: [{
+        comparison: 'minimum',
+        source: 'fixed',
+        value: 1
+      }],
+      scope: 'first_submission_only',
+      validationMessage: {
+        'zh-CN': '请至少选择 {min} 款锅底',
+        en: 'Please select at least {min} hotpot base'
       }
     }
-  ]
+  }]
 };
+
+// ============================================
+// 示例 5：ItemRuleEvaluator 用法（简洁调用 + 完整 Demo）
+// ============================================
+
+/**
+ * ItemRuleEvaluator 简洁调用示例
+ *
+ * 覆盖方法：
+ * - setStrategyConfigs
+ * - getStrategyConfigs
+ * - evaluate
+ * - getQuantityLimits
+ * - validateCart
+ * - getPrefillItems
+ */
 function quickUseItemRuleEvaluator() {
-  const evaluator = new import_evaluator.ItemRuleEvaluator();
-  evaluator.setStrategyConfigs([
-    MIN_CONDIMENT_PER_PERSON_STRATEGY,
-    MAX_BUNS_PER_TABLE_STRATEGY,
-    HOTPOT_BASE_REQUIRED_STRATEGY
-  ]);
+  const evaluator = new _evaluator.ItemRuleEvaluator();
+  evaluator.setStrategyConfigs([MIN_CONDIMENT_PER_PERSON_STRATEGY, MAX_BUNS_PER_TABLE_STRATEGY, HOTPOT_BASE_REQUIRED_STRATEGY]);
   const businessData = {
-    pax: { total: 3, adult: 3, child: 0 },
-    serviceType: "dine-in",
-    cartItems: [
-      { product_id: 10001, quantity: 1 },
-      { product_id: 20001, quantity: 2 },
-      { product_id: 20002, quantity: 1 }
-    ],
-    historicalItems: [{ product_id: 20001, quantity: 1 }],
+    pax: {
+      total: 3,
+      adult: 3,
+      child: 0
+    },
+    serviceType: 'dine-in',
+    cartItems: [{
+      product_id: 10001,
+      quantity: 1
+    }, {
+      product_id: 20001,
+      quantity: 2
+    }, {
+      product_id: 20002,
+      quantity: 1
+    }],
+    historicalItems: [{
+      product_id: 20001,
+      quantity: 1
+    }],
     submissionIndex: 0
   };
   return {
@@ -262,23 +322,40 @@ function quickUseItemRuleEvaluator() {
     prefillItems: evaluator.getPrefillItems(businessData)
   };
 }
+
+/**
+ * ItemRuleEvaluator 完整可运行 Demo
+ *
+ * 说明：
+ * 1) 首次提交：触发 first_submission_only + cumulative + 条件规则
+ * 2) 追加提交：演示 first_submission_only 不再触发
+ * 3) 覆盖 strategyConfigs 临时传入：演示按需仅评估部分规则
+ */
 function runItemRuleEvaluatorDemo() {
-  const evaluator = new import_evaluator.ItemRuleEvaluator();
-  evaluator.setStrategyConfigs([
-    MIN_CONDIMENT_PER_PERSON_STRATEGY
-    // MAX_BUNS_PER_TABLE_STRATEGY,
-    // HOTPOT_BASE_REQUIRED_STRATEGY,
+  const evaluator = new _evaluator.ItemRuleEvaluator();
+  evaluator.setStrategyConfigs([MIN_CONDIMENT_PER_PERSON_STRATEGY
+  // MAX_BUNS_PER_TABLE_STRATEGY,
+  // HOTPOT_BASE_REQUIRED_STRATEGY,
   ]);
   const firstSubmissionData = {
-    pax: { total: 4, adult: 3, child: 1 },
-    serviceType: "dine-in",
+    pax: {
+      total: 4,
+      adult: 3,
+      child: 1
+    },
+    serviceType: 'dine-in',
     submissionIndex: 0,
-    cartItems: [
-      { product_id: 10001, quantity: 3 }
-      // { product_id: 20001, quantity: 2 },
-      // { product_id: 20002, quantity: 1 },
+    cartItems: [{
+      product_id: 10001,
+      quantity: 3
+    }
+    // { product_id: 20001, quantity: 2 },
+    // { product_id: 20002, quantity: 1 },
     ],
-    historicalItems: [{ product_id: 20001, quantity: 1 }]
+    historicalItems: [{
+      product_id: 20001,
+      quantity: 1
+    }]
   };
   const additionalSubmissionData = {
     ...firstSubmissionData,
@@ -289,6 +366,8 @@ function runItemRuleEvaluatorDemo() {
   const quantityLimits = evaluator.getQuantityLimits(firstSubmissionData);
   const validateResult = evaluator.validateCart(firstSubmissionData);
   const prefillItems = evaluator.getPrefillItems(firstSubmissionData);
+
+  // 按需覆盖策略：仅评估“锅底必选”规则
   const baseOnlyEvaluation = evaluator.evaluate({
     ...firstSubmissionData,
     strategyConfigs: [HOTPOT_BASE_REQUIRED_STRATEGY]
@@ -304,13 +383,4 @@ function runItemRuleEvaluatorDemo() {
     prefillItems
     // baseOnlyEvaluation,
   };
-}
-// Annotate the CommonJS export names for ESM import in node:
-0 && (module.exports = {
-  HOTPOT_BASE_PICK_ONE_STRATEGY,
-  HOTPOT_BASE_REQUIRED_STRATEGY,
-  MAX_BUNS_PER_TABLE_STRATEGY,
-  MIN_CONDIMENT_PER_PERSON_STRATEGY,
-  quickUseItemRuleEvaluator,
-  runItemRuleEvaluatorDemo
-});
+}