@pisell/pisellos 0.0.568 → 0.0.570

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

@@ -0,0 +1,394 @@
+import type { Discount } from '../../modules/Discount/types';
+import { OrderModule, ProductList, QuotationModule, SalesSummaryModule, ScanOrderLoggerModule as BaseSalesLoggerModule, ScheduleModule } from '../../modules';
+import type { ScanOrderLogInput as BaseSalesLogInput, ScanOrderLoggerProviderConfig as BaseSalesLoggerProviderConfig, ScanOrderLoggerProviderType as BaseSalesLoggerProviderType } from '../../modules/ScanOrderLogger/types';
+import type { QuantityCheckResult, QuantityLimitResult } from '../../model/strategy/adapter/itemRule';
+import type { QuotationCustomerScopeInfo } from '../../modules/Quotation/types';
+/**
+ * BaseSales 流程 hook 后缀。
+ * 完整事件名应由当前模块名动态拼接，避免多个实例共享固定事件 key。
+ */
+export declare const BaseSalesHookNames: {
+    readonly onInited: "onInited";
+    readonly onDestroy: "onDestroy";
+    readonly onRetryInit: "onRetryInit";
+    readonly onRefresh: "onRefresh";
+    readonly onCartValidationChanged: "onCartValidationChanged";
+    readonly onPaymentSyncStart: "onPaymentSyncStart";
+    readonly onPaymentSyncEnd: "onPaymentSyncEnd";
+    readonly onDepositPaymentSyncEnd: "onDepositPaymentSyncEnd";
+};
+export declare type BaseSalesHookName = typeof BaseSalesHookNames[keyof typeof BaseSalesHookNames];
+export declare function createBaseSalesHook(moduleName: string, hookName: BaseSalesHookName): string;
+export declare type BaseSalesStatus = 'idle' | 'initializing' | 'ready' | 'error';
+export declare type BaseSalesPaymentStatus = 'paid' | 'partially_paid' | 'unpaid' | 'payment_processing' | string;
+export interface BaseSalesEntryContext {
+    biz: string;
+    mode: 'scan' | 'append';
+    resourceId?: string;
+    sourceOrderId?: string;
+}
+export interface BaseSalesConfig {
+    orderSource: 'local' | 'remote';
+    scanTimeout: number;
+    allowAppend: boolean;
+    maxAppendCount: number;
+    features: {
+        autoMerge: boolean;
+        verifyResource: boolean;
+    };
+}
+export interface BaseSalesOrderProductIdentity {
+    product_id: number | null;
+    product_variant_id: number;
+    /** @deprecated 行级唯一值统一使用 metadata.unique_identification_number */
+    identity_key?: string;
+    unique_identification_number?: string;
+    /** 参与合并/匹配；与 remove 通配语义见 isSkuOnlyDeleteIdentity */
+    product_sku?: BaseSalesProductSku;
+    product_bundle?: any[];
+}
+export interface BaseSalesProductSku {
+    option: any[];
+    [key: string]: any;
+}
+export interface BaseSalesLocalizedText {
+    [locale: string]: string | null;
+}
+export interface BaseSalesUpdateOrderProductQuantityParams extends BaseSalesOrderProductIdentity {
+    num: number;
+}
+export interface BaseSalesOrderProduct extends BaseSalesOrderProductIdentity {
+    order_detail_id: number | null;
+    num: number;
+    product_sku: BaseSalesProductSku;
+    /**
+     * 券后 **行 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[];
+    /** 关联 booking.metadata.unique_identification_number */
+    booking_uid?: string;
+    /** 多语言商品标题快照，随 tempOrder 提交到 checkout。 */
+    product_title?: BaseSalesLocalizedText;
+    /** 商品封面图快照，随 tempOrder 提交到 checkout。 */
+    product_cover?: string;
+    /**
+     * 行级扩展 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;
+    /** @deprecated UI/SDK 运行态数据迁移到 tempOrder._extend */
+    _origin?: Record<string, any>;
+}
+/**
+ * 出站 payload 版本的商品行。
+ *
+ * 与 tempOrder 内部 `BaseSalesOrderProduct` 的字段差异：
+ * - `product_sku.option[*]`：内部直接维护统一 Sales 协议字段；
+ *   提交时仅规范 `add_price`，保留传入/恢复得到的展示字段。
+ * - `product_bundle[*].option[*]`：同上重命名规则。
+ *
+ * 运行时（UI 显示、加购合并、指纹、持久化）与提交边界统一消费字段名
+ * `option_group_item_id`，保持 tempOrder 与后端协议一致。
+ */
+export interface BaseSalesSubmitProduct extends Omit<BaseSalesOrderProduct, '_origin' | 'identity_key'> {
+    /**
+     * 出站兼容字段：SDK 内部不再消费 payment_price，
+     * 仅在提交后端时由 selling_price 派生，保持原有后端契约。
+     * 新语义 v2 下 selling_price 是 composite（含 option、含 bundle、含主商品折扣），
+     * 因此 payment_price 同样是 composite。
+     */
+    payment_price: string;
+}
+export interface BaseSalesSummary {
+    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;
+    surcharges?: any[];
+    discount_amount: string;
+    deposit_amount: string;
+    deposit?: {
+        total: string;
+        deposit_policy_ids: number[];
+        deposit_policy_data?: any[];
+        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;
+}
+/**
+ * BaseSales 临时订单（runtime-clean 版本）
+ * 只保留运行时字段，不包含任何 __comment 字段
+ */
+export interface BaseSalesTempOrder {
+    order_id: number | null;
+    /** @deprecated 资源运行态迁移到 Solution store */
+    relation_id?: string;
+    /** @deprecated 资源运行态迁移到 Solution store */
+    table_form_id?: string;
+    /** @deprecated 资源运行态迁移到 Solution store */
+    resource_id?: string;
+    external_sale_number: string;
+    order_number: string;
+    shop_order_number: string;
+    shop_full_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;
+    request_unique_idempotency_token?: string;
+    products: BaseSalesOrderProduct[];
+    bookings: any[];
+    payments: any[];
+    surcharges: any[];
+    discount_list: any[];
+    relation_forms: any[];
+    contacts: any[];
+    contacts_info: Record<string, any> | null;
+    holder: Record<string, any> | null;
+    metadata: Record<string, any>;
+    _extend?: {
+        productsByUid?: Record<string, Record<string, any>>;
+        [key: string]: any;
+    };
+}
+export interface BaseSalesSubmitPayload extends Omit<BaseSalesTempOrder, 'platform' | 'products' | '_extend' | 'shop_full_order_number'> {
+    platform: string;
+    request_unique_idempotency_token?: string;
+    form_record_ids?: Array<{
+        form_id: number | string;
+        form_record_id: number | string;
+    }>;
+    products: BaseSalesSubmitProduct[];
+}
+export interface BaseSalesQuotationDurationConfig {
+    type: string;
+    value: number;
+    flexible_config?: {
+        is_enable_minimum_duration?: 0 | 1;
+        warning_threshold?: number;
+        block_threshold?: number;
+    };
+}
+export interface BaseSalesCalculateProductBookingPriceParams {
+    product: Record<string, any>;
+    booking?: {
+        start_date?: string;
+        start_time?: string;
+        end_date?: string;
+        end_time?: string;
+        [key: string]: any;
+    };
+    duration?: BaseSalesQuotationDurationConfig;
+    customer_id?: number | string;
+    fallback_price?: number | string;
+    datetime?: string;
+    channel?: string;
+}
+export declare type BaseSalesProductBookingPriceSegmentSource = 'quotation' | 'fallback';
+export interface BaseSalesProductBookingPriceSegment {
+    start_datetime: string;
+    end_datetime?: string;
+    time_point: string;
+    unit_price: string;
+    quantity: number;
+    total_price: string;
+    quotation_shelf_id: number;
+    source: BaseSalesProductBookingPriceSegmentSource;
+}
+export interface BaseSalesBundleProductBookingPriceResult {
+    bundle_id?: number;
+    group_id?: number;
+    bundle_group_id?: number;
+    bundle_product_id: number | null;
+    bundle_variant_id: number;
+    unit_price: string;
+    total_price: string;
+    quantity: number;
+    quotation_shelf_id: number;
+    source: BaseSalesProductBookingPriceSegmentSource;
+    segments: BaseSalesProductBookingPriceSegment[];
+}
+export interface BaseSalesProductBookingPriceResult {
+    product_id: number | null;
+    product_variant_id: number;
+    customer_id?: number | string;
+    unit_price: string;
+    total_price: string;
+    quantity: number;
+    duration?: BaseSalesQuotationDurationConfig;
+    quotation_shelf_id: number;
+    segments: BaseSalesProductBookingPriceSegment[];
+    product_bundle?: BaseSalesBundleProductBookingPriceResult[];
+}
+export declare type BaseSalesQuotationCustomerScopeInfo = QuotationCustomerScopeInfo;
+export interface BaseSalesPriceRecalculationContextChange {
+    previousCustomerId?: number | string | null;
+    nextCustomerId?: number | string | null;
+    [key: string]: any;
+}
+export declare type BaseSalesAvailabilityMode = 'idle' | 'shop_closed' | 'submit_disabled' | 'resource_busy' | 'additional_order_with_code' | 'additional_order';
+export interface BaseSalesTableFormRecord {
+    policy?: string | null;
+    partyroom_booking?: string | null;
+    capacity?: number | string | null;
+    [key: string]: any;
+}
+export interface BaseSalesAvailabilityInfo {
+    mode: BaseSalesAvailabilityMode;
+    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?: BaseSalesTableFormRecord | 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 BaseSalesResourceCapacitySlot {
+    start_at?: string;
+    end_at?: string;
+    pax?: number | string;
+}
+export interface BaseSalesResourceCapacity {
+    capacity?: number | string;
+    capacity_list?: BaseSalesResourceCapacitySlot[];
+}
+/** `/order/resource/occupy-detail` 单条 `occupy_details[i]` */
+export interface BaseSalesResourceOccupyDetail {
+    form_record_id?: number | string | null;
+    form_id?: number | string | null;
+    order_id?: number | string | null;
+    last_order_id?: number | string | null;
+    resource_capacity?: BaseSalesResourceCapacity[] | null;
+    form_record?: BaseSalesTableFormRecord | null;
+    [key: string]: any;
+}
+export interface BaseSalesResourceOccupyDetailApiResponse {
+    status?: boolean;
+    code?: number;
+    message?: string;
+    data?: {
+        occupy_details?: BaseSalesResourceOccupyDetail[] | null;
+    } | null;
+}
+export declare type BaseSalesResourceSelectType = 'single' | 'multiple' | 'capacity';
+export interface BaseSalesResourceState extends BaseSalesAvailabilityInfo {
+    relationId?: string;
+    tableFormId?: string;
+    currentOrderId?: string;
+    lastOrderId?: string;
+    allowSnack: boolean;
+    deskmateValid: boolean;
+    isExclusive: boolean;
+    isFull: boolean;
+    /** 来自首个预约规则商品 product_resource.resources 中与 form_id 匹配的 resource type */
+    resourceSelectType?: BaseSalesResourceSelectType;
+    raw: BaseSalesResourceOccupyDetail | null;
+}
+export interface BaseSalesState {
+    entryContext: BaseSalesEntryContext | null;
+    status: BaseSalesStatus;
+    config: Record<string, any> | null;
+    resource: BaseSalesResourceState | null;
+    flow: Record<string, any>;
+    error: string | null;
+    products?: ProductList;
+    order?: OrderModule;
+    quotation?: QuotationModule;
+    salesSummary?: SalesSummaryModule;
+    baseSalesLogger?: BaseSalesLoggerModule;
+    schedule?: ScheduleModule;
+    itemRuleQuantityLimits: QuantityLimitResult[];
+    cartValidation: {
+        passed: boolean | null;
+        failures: QuantityCheckResult[];
+    };
+    entryPaxNumber: number | null;
+}
+export interface BaseSalesLoggerRuntimeConfig {
+    provider?: BaseSalesLoggerProviderType;
+    providerConfig?: BaseSalesLoggerProviderConfig;
+}
+export interface BaseSalesAddLogParams extends BaseSalesLogInput {
+}
+/** BaseSales.scanPromotionCode 对外的轻量结果（UI 可用 getDiscountList 或 scannedDiscountList 补 Holder） */
+export interface BaseSalesScanCodeResult {
+    isAvailable: boolean;
+    type?: 'server' | string;
+    unavailableReason?: 'time_limit' | string;
+    /** batchSearch 原始结果；isAvailable=false 时 discountList 可能未写入 store，Holder 补全需读此字段 */
+    scannedDiscountList?: Discount[];
+}

package/dist/solution/BaseSales/types.js

@@ -0,0 +1,40 @@
+/**
+ * BaseSales 流程 hook 后缀。
+ * 完整事件名应由当前模块名动态拼接，避免多个实例共享固定事件 key。
+ */
+export var BaseSalesHookNames = {
+  onInited: 'onInited',
+  onDestroy: 'onDestroy',
+  onRetryInit: 'onRetryInit',
+  onRefresh: 'onRefresh',
+  onCartValidationChanged: 'onCartValidationChanged',
+  onPaymentSyncStart: 'onPaymentSyncStart',
+  onPaymentSyncEnd: 'onPaymentSyncEnd',
+  onDepositPaymentSyncEnd: 'onDepositPaymentSyncEnd'
+};
+export function createBaseSalesHook(moduleName, hookName) {
+  return "".concat(moduleName, ":").concat(hookName);
+}
+
+/**
+ * 出站 payload 版本的商品行。
+ *
+ * 与 tempOrder 内部 `BaseSalesOrderProduct` 的字段差异：
+ * - `product_sku.option[*]`：内部直接维护统一 Sales 协议字段；
+ *   提交时仅规范 `add_price`，保留传入/恢复得到的展示字段。
+ * - `product_bundle[*].option[*]`：同上重命名规则。
+ *
+ * 运行时（UI 显示、加购合并、指纹、持久化）与提交边界统一消费字段名
+ * `option_group_item_id`，保持 tempOrder 与后端协议一致。
+ */
+
+/**
+ * BaseSales 临时订单（runtime-clean 版本）
+ * 只保留运行时字段，不包含任何 __comment 字段
+ */
+
+/** `resource_capacity[i].capacity_list[j]` */
+
+/** `/order/resource/occupy-detail` 单条 `occupy_details[i]` */
+
+/** BaseSales.scanPromotionCode 对外的轻量结果（UI 可用 getDiscountList 或 scannedDiscountList 补 Holder） */