@pisell/pisellos 3.0.90 → 3.0.91

package/dist/solution/ScanOrder/types.d.ts

@@ -0,0 +1,306 @@
+import { OrderModule, ProductList, SalesSummaryModule, ScanOrderLogInput, ScanOrderLoggerModule, ScanOrderLoggerProviderConfig, ScanOrderLoggerProviderType, ScheduleModule } from '../../modules';
+import type { QuantityCheckResult, QuantityLimitResult } from '../../model/strategy/adapter/itemRule';
+/**
+ * 扫码下单流程 hook
+ */
+export declare enum ScanOrderHooks {
+    onInited = "scanOrder:onInited",
+    onDestroy = "scanOrder:onDestroy",
+    onRetryInit = "scanOrder:onRetryInit",
+    onRefresh = "scanOrder:onRefresh",
+    onCartValidationChanged = "scanOrder:onCartValidationChanged"
+}
+export type ScanOrderStatus = 'idle' | 'initializing' | 'ready' | 'error';
+export type ScanOrderEntryContext = {
+    biz: string;
+    mode: 'scan' | 'append';
+    resourceId?: string;
+    sourceOrderId?: string;
+};
+export interface ScanOrderConfig {
+    orderSource: 'local' | 'remote';
+    scanTimeout: number;
+    allowAppend: boolean;
+    maxAppendCount: number;
+    features: {
+        autoMerge: boolean;
+        verifyResource: boolean;
+    };
+}
+export interface ScanOrderOrderProductIdentity {
+    product_id: number | null;
+    product_variant_id: number;
+    identity_key?: string;
+    /** 参与合并/匹配；与 remove 通配语义见 isSkuOnlyDeleteIdentity */
+    product_option_item?: any[];
+    product_bundle?: any[];
+}
+export interface ScanOrderOrderProduct extends ScanOrderOrderProductIdentity {
+    order_detail_id: number | null;
+    num: number;
+    product_option_item: any[];
+    /**
+     * 券后 **行 composite 单价** = `metadata.main_product_selling_price`
+     *   + Σ((bundle.bundle_selling_price ?? bundle.price) × (bundle.num ?? 1))
+     *
+     * 新语义 v2 下 `metadata.main_product_selling_price` 已经**含 option**、含主商品折扣，
+     * 因此本字段不再叠加 option。未应用券时等同 `original_price`。
+     * Rules 钩子、主商品计税、Summary 统一读 metadata，不以此字段反推。
+     */
+    selling_price: string;
+    /**
+     * 券前 **行 composite 单价** = `metadata.main_product_original_price`
+     *   + Σ(bundle 原价 × num)
+     *
+     * 新语义 v2 下 `metadata.main_product_original_price` 已经**含 option**、不含折扣。
+     * 不承载后台划线价语义。
+     */
+    original_price: string;
+    tax_fee: string;
+    is_charge_tax: number;
+    discount_list: any[];
+    product_bundle: any[];
+    /**
+     * 行级扩展 metadata。价格相关的权威字段：
+     *
+     * - `source_product_price`：主商品/variant 基础价（已应用报价单），**不含 option、不含折扣**。
+     *   是派生 `main_product_*` 的唯一源。variant 分支优先读 `metadata.origin.variant[vid].price`。
+     * - `main_product_original_price` = `source_product_price + Σ(option.price × option.num)`，
+     *   **含 option、不含折扣**。
+     * - `main_product_selling_price` = `main_product_original_price − 主商品券 per-unit amount`，
+     *   **含 option、含主商品折扣**。Rules 钩子 / Summary / 计税均以此为主商品权威源。
+     * - `price_schema_version`（当前 = 2）：schema 版本 sentinel，用于跨端协商价格口径、
+     *   区分 v1 旧缓存以便 `normalizeOrderProduct` 触发迁移。
+     */
+    metadata: Record<string, any>;
+    /** 商品行备注（如顾客对单品的特殊要求） */
+    note?: string;
+    _origin?: Record<string, any>;
+}
+/**
+ * 出站 payload 版本的商品行。
+ *
+ * 与 tempOrder 内部 `ScanOrderOrderProduct` 的字段差异：
+ * - `product_option_item[*]`：内部为 `{ product_option_item_id, option_group_id, num, price, ... }`，
+ *   出站由 `normalizeSubmitProduct` 重命名为 `{ option_group_item_id, option_group_id, num }`
+ *   （后端 checkout 协议；丢弃 `price` 等运行时辅助字段）。
+ * - `product_bundle[*].option[*]`：同上重命名规则。
+ *
+ * 运行时（UI 显示、加购合并、指纹、持久化）全部消费内部字段名 `product_option_item_id`，
+ * 仅在 SDK 提交边界做一次出站映射，不影响 opaque identity 契约。
+ */
+export interface ScanOrderSubmitProduct extends Omit<ScanOrderOrderProduct, '_origin' | 'identity_key'> {
+    /**
+     * 出站兼容字段：SDK 内部不再消费 payment_price，
+     * 仅在提交后端时由 selling_price 派生，保持原有后端契约。
+     * 新语义 v2 下 selling_price 是 composite（含 option、含 bundle、含主商品折扣），
+     * 因此 payment_price 同样是 composite。
+     */
+    payment_price: string;
+}
+export interface ScanOrderSummary {
+    product_quantity: number;
+    product_original_amount: string;
+    product_amount: string;
+    product_expect_amount: string;
+    product_tax_fee: string;
+    shipping_fee: string;
+    shipping_tax_fee: string;
+    tax_fee: string;
+    surcharge_fee: string;
+    discount_amount: string;
+    deposit_amount: string;
+    deposit?: {
+        total: string;
+        deposit_policy_ids: number[];
+        hasDeposit: boolean;
+    };
+    expect_amount: string;
+    total_amount: string;
+    amount_gap: string;
+    rounding_amount: string;
+    pay_service_charge_amount: string;
+    tax_title?: string;
+    tax_rate?: number;
+}
+/**
+ * ScanOrder 临时订单（runtime-clean 版本）
+ * 只保留运行时字段，不包含任何 __comment 字段
+ */
+export interface ScanOrderTempOrder {
+    order_id: number | null;
+    relation_id?: string;
+    table_form_id?: string;
+    resource_id?: string;
+    order_number: string;
+    shop_order_number: string;
+    type: string;
+    business_code: string;
+    platform: string;
+    sales_channel: string;
+    order_sales_channel: string;
+    status: string;
+    payment_status: string;
+    shipping_status: string;
+    customer_id: number | null;
+    customer_name: string;
+    country_calling_code: string;
+    phone: string;
+    email: string;
+    is_price_include_tax: number;
+    tax_title: string;
+    tax_country_code: string;
+    currency_code: string;
+    currency_symbol: string;
+    currency_format: string;
+    is_deposit: number;
+    deposit_amount: string;
+    shop_discount: string;
+    surcharge_fee: string;
+    note: string;
+    buzzer?: string;
+    delivery_type?: string;
+    table_number?: Record<string, any>;
+    schedule_date: string;
+    created_at: string;
+    products: ScanOrderOrderProduct[];
+    bookings: any[];
+    payments: any[];
+    surcharges: any[];
+    discount_list: any[];
+    relation_forms: any[];
+    contacts: any[];
+    contacts_info: any[];
+    holder: Record<string, any> | null;
+    summary: ScanOrderSummary;
+    metadata: Record<string, any>;
+    lastOrderInfo?: Record<string, any>;
+}
+export interface ScanOrderSubmitPayload extends Omit<ScanOrderTempOrder, 'platform' | 'products' | 'created_at' | 'summary' | 'surcharges'> {
+    platform: 'H5' | 'PC';
+    request_unique_idempotency_token?: string;
+    form_record_ids?: Array<{
+        form_id: number | string;
+        form_record_id: number | string;
+    }>;
+    products: ScanOrderSubmitProduct[];
+}
+export type ScanOrderAvailabilityMode = 'idle' | 'shop_closed' | 'submit_disabled' | 'resource_busy' | 'multiple_orders' | 'additional_order_with_code' | 'additional_order';
+export interface ScanOrderTableFormRecord {
+    policy?: string | null;
+    partyroom_booking?: string | null;
+    capacity?: number | string | null;
+    [key: string]: any;
+}
+export interface ScanOrderAvailabilityInfo {
+    mode: ScanOrderAvailabilityMode;
+    order_id?: string;
+    relation_id?: string;
+    table_form_id?: string;
+    deskmate_valid?: boolean;
+    errorTips?: string;
+    /** 透传 `availability.closed_behavior`，便于 UI 识别拦截类型（如 show_menu_disabled） */
+    closed_behavior?: string;
+    /** `/order/resource/occupy-detail` 返回的 `form_record` 原样透出 */
+    table_form_record?: ScanOrderTableFormRecord | null;
+    policy?: string | null;
+    partyroom_booking?: string | null;
+    /** 预约规则关联商品存在 custom 容量时，由 checkResourceAvailable 置为 1 */
+    requestEntryPax?: number;
+    /** 首个 `capacity.type === 'custom'` 商品里 `custom[0]` 的 min（人数下限） */
+    requestPaxMin?: number;
+    /** 首个 `capacity.type === 'custom'` 商品里 `custom[0]` 的 max（人数上限） */
+    requestPaxMax?: number;
+}
+/** `resource_capacity[i].capacity_list[j]` */
+export interface ScanOrderResourceCapacitySlot {
+    start_at?: string;
+    end_at?: string;
+    pax?: number | string;
+}
+export interface ScanOrderResourceCapacity {
+    capacity?: number | string;
+    capacity_list?: ScanOrderResourceCapacitySlot[];
+}
+/** `/order/resource/occupy-detail` 单条 `occupy_details[i]` */
+export interface ScanOrderResourceOccupyDetail {
+    form_record_id?: number | string | null;
+    form_id?: number | string | null;
+    order_id?: number | string | null;
+    last_order_id?: number | string | null;
+    order_list?: Array<{
+        id?: number | string | null;
+        [key: string]: any;
+    }> | null;
+    resource_capacity?: ScanOrderResourceCapacity[] | null;
+    form_record?: ScanOrderTableFormRecord | null;
+    [key: string]: any;
+}
+export interface ScanOrderResourceOccupyDetailApiResponse {
+    status?: boolean;
+    code?: number;
+    message?: string;
+    data?: {
+        occupy_details?: ScanOrderResourceOccupyDetail[] | null;
+    } | null;
+}
+export type ScanOrderResourceSelectType = 'single' | 'multiple' | 'capacity';
+export interface ScanOrderReservationResourceSelectInfo {
+    resourceSelectType?: ScanOrderResourceSelectType;
+    isSingleReservation: boolean;
+    isMultipleReservation: boolean;
+    isCapacityReservation: boolean;
+}
+export interface ScanOrderAllowAddItemsInfo {
+    enabled: boolean;
+}
+export type ScanOrderSyncAdditionalOrderReason = 'missing_resource_id' | 'no_order' | 'multiple_orders' | 'add_items_disabled' | 'invalid_order_id';
+export interface ScanOrderSyncAdditionalOrderResult {
+    matched: boolean;
+    order_id?: string;
+    reason?: ScanOrderSyncAdditionalOrderReason;
+}
+export interface ScanOrderResourceState extends ScanOrderAvailabilityInfo {
+    relationId?: string;
+    tableFormId?: string;
+    currentOrderId?: string;
+    lastOrderId?: string;
+    allowSnack: boolean;
+    deskmateValid: boolean;
+    isExclusive: boolean;
+    isFull: boolean;
+    /** 来自首个预约规则商品 product_resource.resources 中与 form_id 匹配的 resource type */
+    resourceSelectType?: ScanOrderResourceSelectType;
+    raw: ScanOrderResourceOccupyDetail | null;
+}
+export interface ScanOrderState {
+    entryContext: ScanOrderEntryContext | null;
+    status: ScanOrderStatus;
+    config: Record<string, any> | null;
+    resource: ScanOrderResourceState | null;
+    flow: Record<string, any>;
+    error: string | null;
+    products?: ProductList;
+    order?: OrderModule;
+    salesSummary?: SalesSummaryModule;
+    scanOrderLogger?: ScanOrderLoggerModule;
+    schedule?: ScheduleModule;
+    itemRuleQuantityLimits: QuantityLimitResult[];
+    cartValidation: {
+        passed: boolean | null;
+        failures: QuantityCheckResult[];
+    };
+    entryPaxNumber: number | null;
+}
+export interface ScanOrderLoggerRuntimeConfig {
+    provider?: ScanOrderLoggerProviderType;
+    providerConfig?: ScanOrderLoggerProviderConfig;
+}
+export interface ScanOrderAddLogParams extends ScanOrderLogInput {
+}
+/** ScanOrder.scanCode 对外的轻量结果（不含 discountList，UI 在 resolve 后调 getDiscountList） */
+export interface ScanOrderScanCodeResult {
+    isAvailable: boolean;
+    type?: 'server' | string;
+    unavailableReason?: 'time_limit' | string;
+}

package/dist/solution/ScanOrder/types.js

@@ -0,0 +1,35 @@
+/**
+ * 扫码下单流程 hook
+ */
+export var ScanOrderHooks = /*#__PURE__*/function (ScanOrderHooks) {
+  ScanOrderHooks["onInited"] = "scanOrder:onInited";
+  ScanOrderHooks["onDestroy"] = "scanOrder:onDestroy";
+  ScanOrderHooks["onRetryInit"] = "scanOrder:onRetryInit";
+  ScanOrderHooks["onRefresh"] = "scanOrder:onRefresh";
+  ScanOrderHooks["onCartValidationChanged"] = "scanOrder:onCartValidationChanged";
+  return ScanOrderHooks;
+}({});
+
+/**
+ * 出站 payload 版本的商品行。
+ *
+ * 与 tempOrder 内部 `ScanOrderOrderProduct` 的字段差异：
+ * - `product_option_item[*]`：内部为 `{ product_option_item_id, option_group_id, num, price, ... }`，
+ *   出站由 `normalizeSubmitProduct` 重命名为 `{ option_group_item_id, option_group_id, num }`
+ *   （后端 checkout 协议；丢弃 `price` 等运行时辅助字段）。
+ * - `product_bundle[*].option[*]`：同上重命名规则。
+ *
+ * 运行时（UI 显示、加购合并、指纹、持久化）全部消费内部字段名 `product_option_item_id`，
+ * 仅在 SDK 提交边界做一次出站映射，不影响 opaque identity 契约。
+ */
+
+/**
+ * ScanOrder 临时订单（runtime-clean 版本）
+ * 只保留运行时字段，不包含任何 __comment 字段
+ */
+
+/** `resource_capacity[i].capacity_list[j]` */
+
+/** `/order/resource/occupy-detail` 单条 `occupy_details[i]` */
+
+/** ScanOrder.scanCode 对外的轻量结果（不含 discountList，UI 在 resolve 后调 getDiscountList） */

package/dist/solution/ScanOrder/utils.d.ts

@@ -0,0 +1,172 @@
+import { ScanOrderOrderProduct, ScanOrderOrderProductIdentity, ScanOrderResourceCapacitySlot, ScanOrderResourceSelectType, ScanOrderSummary, ScanOrderTempOrder } from './types';
+import type { CartItemSummary, ItemRuleBusinessData, PaxInfo, QuantityLimitResult } from '../../model/strategy/adapter/itemRule';
+import type { StrategyConfig } from '../../model/strategy/type';
+import type { ProductData } from '../../modules/Product/types';
+/**
+ * 构建金额全为 0 的空 summary。
+ * 作为尚未计算金额时的兜底默认值，避免下游因 undefined 报错。
+ */
+export declare function createEmptySummary(): ScanOrderSummary;
+/**
+ * 商品数量安全取值。
+ * - NaN / undefined / < 1 均视作 1（最低起订量）
+ * - 有值时取整（不支持小数数量）
+ */
+export declare function getSafeProductNum(num?: number): number;
+/**
+ * 宽松布尔值转换。
+ * 兼容后端/配置中心常见的 boolean / number / string 表达，统一归一成 true/false。
+ */
+export declare function toBoolean(value: unknown): boolean;
+/**
+ * 将值归一化为有效的正向字符串。
+ * null / undefined / 空串 / '0' / 'null' 统一视为无效值并返回 undefined。
+ */
+export declare function toPositiveString(value: unknown): string | undefined;
+/**
+ * 归一化 item rule 策略模型 ID 列表。
+ * - 支持 string / number 混合输入
+ * - 仅保留 > 0 的合法数字
+ * - 自动去重
+ */
+export declare function normalizeEnabledItemRuleIds(rawIds: unknown): number[];
+/**
+ * 从 tableConfig 中提取合法策略模型 ID 列表。
+ */
+export declare function extractStrategyModelIdsFromTableConfig(tableConfig: Record<string, any> | null | undefined): number[];
+/**
+ * 仅保留 item_rule 类型策略。
+ */
+export declare function normalizeItemRuleStrategies(configs: unknown): StrategyConfig[];
+export declare function toNonNegativeNumber(value: unknown): number;
+export declare function toNonNegativeInt(value: unknown): number;
+export declare function toPriceString(value: unknown, fallback?: string): string;
+export declare function buildProductKey(productId: number, productVariantId: number): string;
+export declare function getTopLevelProductId(product: Record<string, any>): number | null;
+export declare function getTopLevelVariantId(product: Record<string, any>): number | null;
+export declare function buildQuantityLimitIndex(limits: QuantityLimitResult[]): {
+    exactLimitMap: Map<string, QuantityLimitResult[]>;
+    productLimitMap: Map<number, QuantityLimitResult[]>;
+};
+export declare function resolveSkuMatchedQuantityLimits(params: {
+    productId: number;
+    variantId: number | null;
+    limitIndex: {
+        exactLimitMap: Map<string, QuantityLimitResult[]>;
+        productLimitMap: Map<number, QuantityLimitResult[]>;
+    };
+}): QuantityLimitResult[];
+export declare function aggregateItemRuleLimit(matchedLimits: QuantityLimitResult[]): {
+    min: number | undefined;
+    max: number | undefined;
+    remainingMax: number | undefined;
+    exact: number | undefined;
+    mustInclude: boolean;
+    validationMessage: string | undefined;
+    rawValidationMessage: string | Record<string, string> | undefined;
+    maxValidationMessage: string | undefined;
+    rawMaxValidationMessage: string | Record<string, string> | undefined;
+    minValidationMessage: string | undefined;
+    rawMinValidationMessage: string | Record<string, string> | undefined;
+} | null;
+export declare function buildItemRuleBusinessData(params: {
+    tempOrder: ScanOrderTempOrder;
+    runtimeConfig: {
+        pax?: Partial<PaxInfo>;
+        historicalItems?: CartItemSummary[];
+        serviceType?: string;
+        submissionIndex?: number;
+        custom?: Record<string, any>;
+    };
+    itemRuleConfigs: StrategyConfig[];
+}): ItemRuleBusinessData;
+export declare function attachItemRuleLimitsToTopLevelProducts<T>(productList: T, limits: QuantityLimitResult[]): T;
+/**
+ * 将选项行 / 套餐行归一成稳定 JSON，用于「同 SKU 是否合并」判断。
+ * 数组元素先按主键排序再序列化，避免顺序差异导致误判为不同行。
+ */
+export declare function buildProductLineFingerprint(productOptionItem?: unknown, productBundle?: unknown): string;
+/**
+ * removeProductFromOrder 仅传 SKU 时的通配 identity（对象上未声明选项键）。
+ * 与显式 `product_option_item: []` 区分：后者只匹配「无选项」行。
+ */
+export declare function isSkuOnlyDeleteIdentity(x: ScanOrderOrderProductIdentity): boolean;
+/**
+ * 判断两个商品 identity 是否匹配（不透明 identity 契约）。
+ *
+ * 调用约定：始终 `isIdentityMatch(line, callerIdentity)`。
+ * - 若 SKU（product_id + product_variant_id）不一致 → 不匹配。
+ * - **双方都带** `identity_key` → 严格字符串相等比较（不再猜测合成 key / metadata 桥接）。
+ *   这是 opaque identity 契约的标准路径：UI 删改时透传 SDK 回灌的 identity_key。
+ * - 否则（即至少一侧未声明 identity_key）→ 进入「SKU 通配 / 显式空选项 / 指纹」回退路径，
+ *   忽略线侧 identity_key，按内容语义匹配。这给「行已 opaque、调用方却想按 SKU 通配 / 选项指纹删除」留兼容入口。
+ */
+export declare function isIdentityMatch(a: ScanOrderOrderProductIdentity, b: ScanOrderOrderProductIdentity): boolean;
+/**
+ * 根据 identity 在商品列表中定位下标。
+ * 用于判断商品是否已存在（已存在则累加数量，否则新增）。
+ */
+export declare function getProductIdentityIndex(products: ScanOrderOrderProduct[], identity: ScanOrderOrderProductIdentity): number;
+/**
+ * 对外部传入的商品对象做归一化（v2 composite 语义）：
+ * - 补全可选字段默认值（未传则使用兜底值，避免后续计算时因 undefined 导致异常）
+ * - 对 num 调用 getSafeProductNum 做安全处理
+ * - 保留 _origin 供后续业务流程（如促销规则）使用
+ *
+ * 价格字段语义（metadata 权威源 + composite 派生）：
+ * - `metadata.source_product_price`：主商品/variant 基础价（已应用报价单），**不含 option**、
+ *   **不含折扣**。是推导 main_product_* 的起点。variant 分支优先读 `metadata.origin.variant[vid].price`。
+ * - `metadata.main_product_original_price`：`source + Σ(option.price × option.num)`，**含 option**、
+ *   **不含折扣**。
+ * - `metadata.main_product_selling_price`：`main_product_original_price - 主商品券 per-unit amount`，
+ *   **含 option**、**含折扣**。
+ * - 行级 `selling_price` = `main_product_selling_price + Σ(bundle_selling_price × num)`。
+ * - 行级 `original_price` = `main_product_original_price + Σ(bundle 原价 × num)`。
+ *
+ * 迁移与幂等：
+ * - `metadata.price_schema_version === 2` → 已新语义归一化，保留 main_product_* 原值（保留折扣）。
+ * - 其它情况（v1 / 缺字段 / 无 metadata）→ 按"main_product_selling_price 曾是 main-only"的旧约定
+ *   反推 legacyDiscount，再以新 source + options 基准重算。最终统一打上 `price_schema_version: 2`。
+ * - 因此多次 normalize 不会重复叠加 option/bundle。
+ */
+export declare function normalizeOrderProduct(product: Partial<ScanOrderOrderProduct> & ScanOrderOrderProductIdentity): ScanOrderOrderProduct;
+/**
+ * 从 reservation.enabled_reservation_rules 中收集 type=link 的商品 id。
+ */
+export declare function collectLinkProductIdsFromReservationRules(rules: unknown): number[];
+/**
+ * 找到第一个归属指定桌台的预约规则商品。
+ * 归属判断基于商品资源中的 default_resource / optional_resource。
+ */
+export declare function findReservationRuleProductByResourceId(products: ProductData[], resourceId: string | number | null | undefined): ProductData | undefined;
+/**
+ * 返回列表中第一个带有效 duration.value（分钟）的商品时长。
+ */
+export declare function pickFirstDurationMinutesFromProducts(products: ProductData[]): number | undefined;
+/** 是否存在 capacity.type === 'custom' 的商品 */
+export declare function hasCustomCapacityProduct(products: ProductData[]): boolean;
+/**
+ * 根据预约规则商品的 resource.type 计算桌台是否已被"占满"。
+ * - single：只要有 `lastOrderId` 即视为占用
+ * - multiple：当前时间落在 `capacity_list[i]` 的 `[start_at, end_at]`（inclusive）内的 pax 之和 >= 总容量
+ * - 其他（'capacity' / undefined）：返回 false，不施加限制
+ */
+export declare function computeResourceIsFull(params: {
+    resourceSelectType?: ScanOrderResourceSelectType;
+    lastOrderId?: string;
+    capacityList?: ScanOrderResourceCapacitySlot[];
+    capacity?: number | string | null;
+}): boolean;
+/**
+ * 在商品列表中找到第一个 `capacity.type === 'custom'` 的商品，取其 `custom` 数组第一项的 min/max。
+ * 仅返回有限数字字段；若均无法解析则返回 `undefined`。
+ */
+export declare function pickFirstCustomCapacityPaxBounds(products: ProductData[]): {
+    min?: number;
+    max?: number;
+} | undefined;
+/**
+ * 第一个 `capacity.type === 'custom'` 的商品，取其 `custom[0].id`（提交 booking metadata.capacity 维度 id）。
+ * 无匹配时返回 `undefined`，调用方应回退为 `0`。
+ */
+export declare function pickFirstCustomCapacityDimensionId(products: ProductData[]): string | number | undefined;