@pisell/pisellos 0.10.14 → 0.10.16

package/lib/server/modules/order/types.js

@@ -1,35 +1,124 @@
-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/server/modules/order/types.ts
-var types_exports = {};
-__export(types_exports, {
-  OrderHooks: () => OrderHooks
-});
-module.exports = __toCommonJS(types_exports);
-var OrderHooks = /* @__PURE__ */ ((OrderHooks2) => {
-  OrderHooks2["onOrdersLoaded"] = "order:onOrdersLoaded";
-  OrderHooks2["onOrdersChanged"] = "order:onOrdersChanged";
-  OrderHooks2["onRemoteProductMembershipChanged"] = "order:onRemoteProductMembershipChanged";
-  OrderHooks2["onOrdersSyncCompleted"] = "order:onOrdersSyncCompleted";
-  return OrderHooks2;
-})(OrderHooks || {});
-// Annotate the CommonJS export names for ESM import in node:
-0 && (module.exports = {
-  OrderHooks
+Object.defineProperty(exports, "__esModule", {
+  value: true
 });
+exports.OrderHooks = void 0;
+/**
+ * Order 模块主键类型（对齐标准 Sales 协议的 order_id）
+ */
+/**
+ * 协议中金额类字段多为 string 快照（交易时价格不可从基准商品重算）
+ */
+// ─────────────────────────────────────────────────────────────────
+// 订单类型 / 平台 / 渠道（Sales 协议枚举，保留 string 并置常用字面量）
+// ─────────────────────────────────────────────────────────────────
+/** 订单类型。文档：appointment_booking / ticket / virtual。来源：Order.type */
+/**
+ * 来源平台。文档：shop / pos / kiosk / h5 / app / mini-program。
+ * 来源：Order.platform
+ */
+/** 订单状态（仅输出）。文档：open / completed / cancelled。来源：Order.status */
+/** 支付状态。来源：Order.payment_status */
+/** 发货状态（仅输出）。来源：Order.shipping_status */
+/**
+ * 预约子事件状态（仅输出）。
+ * 文档：new / confirmed / arrived / started / completed / cancelled。
+ * 来源：ScheduleEvent.appointment_status
+ */
+/** 折扣类型：shop（整单）/ product（商品）。来源：Discount.type */
+/** 支付记录状态：paid / voided / payment_pending 等。来源：OrderPayment.status */
+/** 附加费类型。来源：OrderSurcharge.type */
+// ─────────────────────────────────────────────────────────────────
+// 3.3 products / 3.3.1 discount_list / 3.3.2 product_bundle
+// ─────────────────────────────────────────────────────────────────
+/** 商品折扣 metadata，常含 unique_identification_number */
+/**
+ * 商品折扣项（3.3.1 discount_list）
+ */
+/**
+ * 套餐子商品（3.3.2 product_bundle）
+ */
+/** 商品行 metadata，常含 unique_identification_number */
+/**
+ * 订单级商品行（3.3 products）。
+ * 订单级别的非预约关联商品；预约关联商品在 bookings 内。
+ * product_id 为关联 ID，展示信息从本地基准数据取；价格为交易快照须保留在 Sales 数据中。
+ */
+// ─────────────────────────────────────────────────────────────────
+// 3.4 bookings
+// ─────────────────────────────────────────────────────────────────
+/** 预约条目 metadata，常含 unique_identification_number */
+/**
+ * 单条预约（子 schedule_event，parent_id != 0）。
+ * product 结构同 products 单项；relation_products 结构同 products 数组。
+ */
+// ─────────────────────────────────────────────────────────────────
+// 3.5 payments
+// ─────────────────────────────────────────────────────────────────
+/** 支付记录 metadata */
+/**
+ * 支付记录（3.5 payments）
+ */
+// ─────────────────────────────────────────────────────────────────
+// 3.6 surcharges
+// ─────────────────────────────────────────────────────────────────
+/**
+ * 订单附加费（3.6 surcharges）
+ */
+// ─────────────────────────────────────────────────────────────────
+// 3.7 summary（仅输出，由 OrderV2Service::computeOrderSummaryData 计算）
+// ─────────────────────────────────────────────────────────────────
+/**
+ * 订单数据结构（Server 侧对齐《统一 Sales 数据协议》）
+ */
+/** 去掉 bookings 后的订单快照；展开预约行时挂在 {@link BookingData.order} 上 */
+/**
+ * 展开后的单条预约视图：协议 {@link OrderBookingItem} 平铺字段 + 所属订单（不含 bookings）+
+ * 当前预约归属的商品行（由订单 products 按 schedule_event_id / relation_items 归集，不修改 order）
+ */
+/**
+ * 订单列表筛选条件（与 order.ts getFilterButtonList 等 UI 对齐）
+ */
+/**
+ * 预约展开列表筛选条件（订单级条件匹配 booking.order.*，预约级匹配 booking 自身）
+ */
+/** 分页筛选结果通用结构 */
+/** 单条筛选未命中说明（用于排查过滤原因） */
+/** 未通过筛选的订单及首个未满足条件（与过滤短路顺序一致） */
+/**
+ * SSE 同步配置
+ */
+/**
+ * Ably 事件类型
+ */
+/**
+ * Ably 事件载荷
+ */
+/**
+ * 订单变更广播载荷。
+ * 用于保留原有全量列表通知能力，同时让订阅方可按 changedOrders 做增量处理。
+ *
+ * @example
+ * const changedOrders = payload.changedOrders
+ */
+/**
+ * 远端订单快照相对本地订单产生商品成员增删时的广播载荷。
+ * 只表达商品行成员关系变化，不包含数量、价格、备注等字段级修改。
+ */
+/**
+ * OrderSyncMessage - pubsub 同步消息结构
+ */
+/**
+ * Order 模块状态
+ */
+/**
+ * Order 模块钩子
+ */
+let OrderHooks = exports.OrderHooks = /*#__PURE__*/function (OrderHooks) {
+  OrderHooks["onOrdersLoaded"] = "order:onOrdersLoaded";
+  OrderHooks["onOrdersChanged"] = "order:onOrdersChanged";
+  OrderHooks["onRemoteProductMembershipChanged"] = "order:onRemoteProductMembershipChanged";
+  OrderHooks["onOrdersSyncCompleted"] = "order:onOrdersSyncCompleted";
+  return OrderHooks;
+}({});