@trusted-solutions/sdit.models 0.65.1-alpha.1 → 0.65.2-alpha.2

package/lambda/online-ordering.d.ts

@@ -405,6 +405,8 @@ export interface SOSendOrderRequest {
     expectedPickupAt?: number;
     /** 外送地址 serveType === deliveryByStore 時有效 */
     deliveryAddress?: Address;
+    /** 外送地址經緯度，格式固定為 [longitude, latitude]；serveType === deliveryByStore 時建議送出 */
+    deliveryAddressLonLat?: number[];
     /** 內用桌ID serveType === dineIn 時有效 */
     tableId?: string;
     /** 折抵點數 */

package/models/online-ordering.d.ts

@@ -94,6 +94,106 @@ export interface SOCart {
     items: SOCartItem[];
     notes?: string;
 }
+export interface SODeliveryTask {
+    /** 外送服務商 */
+    provider: DeliveryProvider;
+    /** 後端標準化後的外送狀態 */
+    normalizedStatus?: DeliveryTaskStatus;
+    /** 此物流狀態發生時間，timestamp ms */
+    statusAt?: number;
+    /** 第三方提供的追蹤連結 */
+    trackUrl?: string;
+    /** 司機資訊 */
+    courier?: {
+        name?: string;
+        phone?: string;
+    };
+    /** 後端最後更新 deliveryTask 的時間，timestamp ms */
+    updatedAt?: number;
+    /** 配送狀態異常提示 */
+    statusIssue?: DeliveryTaskStatusIssue;
+}
+export declare enum DeliveryProvider {
+    METE = "METE"
+}
+export declare enum DeliveryTaskStatus {
+    /** 等待司機接單 */
+    D100 = "D100",
+    /** 司機接單 */
+    D200 = "D200",
+    /** 取貨完成 */
+    D300 = "D300",
+    /** 貨品送達 */
+    D400 = "D400",
+    /** 托運方取消訂單 */
+    D500 = "D500",
+    /** 店家方取消託運單 */
+    D501 = "D501"
+}
+export interface DeliveryTaskStatusIssue {
+    /** 狀態異常代碼，前端可依 code 決定提示文案 */
+    code: DeliveryTaskStatusIssueCode;
+    /** 後端提供的產品化提示文字，可顯示給消費者 */
+    message: string;
+    /** 異常發生時間，timestamp ms */
+    occurredAt?: number;
+}
+export declare enum DeliveryTaskStatusIssueCode {
+    /** 配送狀態同步失敗 */
+    statusSyncFailed = "statusSyncFailed",
+    /** 第三方外送服務暫時不可用 */
+    providerUnavailable = "providerUnavailable",
+    /** 第三方回傳未知狀態 */
+    unknownStatus = "unknownStatus",
+    /** 未知問題 */
+    unknown = "unknown"
+}
+export interface DeliveryTask {
+    /** 外送服務商，目前只有 METE */
+    provider: DeliveryProvider;
+    /** 我們給第三方的訂單 ID。目前 METE 使用 POS Order.id 當 client_order_id */
+    clientOrderId: string;
+    /** 第三方平台自己的配送單號。例如 METE createOrder 回傳的 order_id */
+    providerOrderId?: string;
+    /** 第三方原始狀態碼，例如 METE ST01 / ST02 / ST04。只供後台、POS、debug 使用 */
+    statusCode?: string;
+    /** 第三方原始狀態文字。只供後台、POS、debug 使用 */
+    status?: string;
+    /** 後端標準化後的外送狀態。前端流程判斷請以這個欄位為主 */
+    normalizedStatus?: DeliveryTaskStatus;
+    /** 此物流狀態發生時間，timestamp ms */
+    statusAt?: number;
+    /** 第三方回傳的外送費。消費者前端不要用這個取代訂單 deliveryCharge */
+    fee?: number;
+    /** 第三方回傳的外送距離 */
+    distance?: number;
+    /** 第三方提供的追蹤連結 */
+    trackUrl?: string;
+    /** 司機資訊 */
+    courier?: DeliveryTaskCourier;
+    /** 後端最後更新 deliveryTask 的時間，timestamp ms */
+    updatedAt?: number;
+    /** 最後一次同步第三方狀態的時間，timestamp ms */
+    lastSyncedAt?: number;
+    /** 配送進入終態的時間，例如送達或取消，timestamp ms */
+    terminalAt?: number;
+    /** 給消費者前端可顯示的產品化狀態異常提示 */
+    statusIssue?: DeliveryTaskStatusIssue;
+    /** 後台、POS、debug 用的原始錯誤資訊。消費者前端不應直接顯示 raw error */
+    error?: DeliveryTaskError;
+}
+export interface DeliveryTaskCourier {
+    name?: string;
+    phone?: string;
+    /** 第三方原始司機資訊，格式不保證固定 */
+    raw?: string;
+}
+export interface DeliveryTaskError {
+    code?: string;
+    message: string;
+    raw?: unknown;
+    occurredAt: number;
+}
 export interface SOOrder {
     id?: string;
     storeId: string;
@@ -164,6 +264,10 @@ export interface SOOrder {
     refundedAt?: number;
     /** 外送地址 */
     deliveryAddress?: Address;
+    /** 外送地址經緯度，格式固定為 [longitude, latitude] */
+    deliveryAddressLonLat?: number[];
+    /** 第三方外送任務 */
+    deliveryTask?: SODeliveryTask;
     /** 付款中的Transaction用來反查付款結果 */
     transactionId?: string;
     paymentServiceProvider?: PaymentServiceProvider;
@@ -270,9 +374,9 @@ export interface SOPublicProduct {
         benefit: DiscountLabel;
     }[];
     mainStoreProductId?: string;
+    onlineAvailability?: OnlineAvailability;
     type?: ProductType;
     isComboOnly?: boolean;
-    onlineAvailability?: OnlineAvailability;
 }
 export interface SOPublicProductWithContext {
     menuId: string;

package/models/online-ordering.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.SOOrderState = exports.SOUnavailableCartItemReasonCode = exports.SOOperateParty = exports.SOOrderErrorType = void 0;
+exports.SOOrderState = exports.SOUnavailableCartItemReasonCode = exports.DeliveryTaskStatusIssueCode = exports.DeliveryTaskStatus = exports.DeliveryProvider = exports.SOOperateParty = exports.SOOrderErrorType = void 0;
 var SOOrderErrorType;
 (function (SOOrderErrorType) {
     /** 未啟用菜單 */
@@ -28,6 +28,36 @@ var SOOperateParty;
     SOOperateParty["buyer"] = "buyer";
     SOOperateParty["system"] = "system";
 })(SOOperateParty = exports.SOOperateParty || (exports.SOOperateParty = {}));
+var DeliveryProvider;
+(function (DeliveryProvider) {
+    DeliveryProvider["METE"] = "METE";
+})(DeliveryProvider = exports.DeliveryProvider || (exports.DeliveryProvider = {}));
+var DeliveryTaskStatus;
+(function (DeliveryTaskStatus) {
+    /** 等待司機接單 */
+    DeliveryTaskStatus["D100"] = "D100";
+    /** 司機接單 */
+    DeliveryTaskStatus["D200"] = "D200";
+    /** 取貨完成 */
+    DeliveryTaskStatus["D300"] = "D300";
+    /** 貨品送達 */
+    DeliveryTaskStatus["D400"] = "D400";
+    /** 托運方取消訂單 */
+    DeliveryTaskStatus["D500"] = "D500";
+    /** 店家方取消託運單 */
+    DeliveryTaskStatus["D501"] = "D501";
+})(DeliveryTaskStatus = exports.DeliveryTaskStatus || (exports.DeliveryTaskStatus = {}));
+var DeliveryTaskStatusIssueCode;
+(function (DeliveryTaskStatusIssueCode) {
+    /** 配送狀態同步失敗 */
+    DeliveryTaskStatusIssueCode["statusSyncFailed"] = "statusSyncFailed";
+    /** 第三方外送服務暫時不可用 */
+    DeliveryTaskStatusIssueCode["providerUnavailable"] = "providerUnavailable";
+    /** 第三方回傳未知狀態 */
+    DeliveryTaskStatusIssueCode["unknownStatus"] = "unknownStatus";
+    /** 未知問題 */
+    DeliveryTaskStatusIssueCode["unknown"] = "unknown";
+})(DeliveryTaskStatusIssueCode = exports.DeliveryTaskStatusIssueCode || (exports.DeliveryTaskStatusIssueCode = {}));
 var SOUnavailableCartItemReasonCode;
 (function (SOUnavailableCartItemReasonCode) {
     SOUnavailableCartItemReasonCode["soldOut"] = "soldOut";

package/models/online-ordering.js.map

@@ -1 +1 @@
-{"version":3,"file":"online-ordering.js","sourceRoot":"","sources":["../../../projects/sdit-model-lib/src/models/online-ordering.ts"],"names":[],"mappings":";;;AAeA,IAAY,gBAmBX;AAnBD,WAAY,gBAAgB;IAC1B,YAAY;IACZ,qDAAiC,CAAA;IACjC,eAAe;IACf,iEAA6C,CAAA;IAC7C,WAAW;IACX,+CAA2B,CAAA;IAC3B,aAAa;IACb,mDAA+B,CAAA;IAC/B,YAAY;IACZ,uDAAmC,CAAA;IACnC,gBAAgB;IAChB,uDAAmC,CAAA;IACnC,YAAY;IACZ,6DAAyC,CAAA;IACzC,YAAY;IACZ,2DAAuC,CAAA;IACvC,cAAc;IACd,2DAAuC,CAAA;AACzC,CAAC,EAnBW,gBAAgB,GAAhB,wBAAgB,KAAhB,wBAAgB,QAmB3B;AAoED,IAAY,cAIX;AAJD,WAAY,cAAc;IACxB,iCAAe,CAAA;IACf,iCAAe,CAAA;IACf,mCAAiB,CAAA;AACnB,CAAC,EAJW,cAAc,GAAd,sBAAc,KAAd,sBAAc,QAIzB;AAyHD,IAAY,+BAGX;AAHD,WAAY,+BAA+B;IACzC,sDAAmB,CAAA;IACnB,kEAA+B,CAAA;AACjC,CAAC,EAHW,+BAA+B,GAA/B,uCAA+B,KAA/B,uCAA+B,QAG1C;AAuCD,IAAY,YAMX;AAND,WAAY,YAAY;IACtB,mCAAmB,CAAA;IACnB,qCAAqB,CAAA;IACrB,iCAAiB,CAAA;IACjB,qCAAqB,CAAA;IACrB,qCAAqB,CAAA;AACvB,CAAC,EANW,YAAY,GAAZ,oBAAY,KAAZ,oBAAY,QAMvB"}
+{"version":3,"file":"online-ordering.js","sourceRoot":"","sources":["../../../projects/sdit-model-lib/src/models/online-ordering.ts"],"names":[],"mappings":";;;AAeA,IAAY,gBAmBX;AAnBD,WAAY,gBAAgB;IAC1B,YAAY;IACZ,qDAAiC,CAAA;IACjC,eAAe;IACf,iEAA6C,CAAA;IAC7C,WAAW;IACX,+CAA2B,CAAA;IAC3B,aAAa;IACb,mDAA+B,CAAA;IAC/B,YAAY;IACZ,uDAAmC,CAAA;IACnC,gBAAgB;IAChB,uDAAmC,CAAA;IACnC,YAAY;IACZ,6DAAyC,CAAA;IACzC,YAAY;IACZ,2DAAuC,CAAA;IACvC,cAAc;IACd,2DAAuC,CAAA;AACzC,CAAC,EAnBW,gBAAgB,GAAhB,wBAAgB,KAAhB,wBAAgB,QAmB3B;AAoED,IAAY,cAIX;AAJD,WAAY,cAAc;IACxB,iCAAe,CAAA;IACf,iCAAe,CAAA;IACf,mCAAiB,CAAA;AACnB,CAAC,EAJW,cAAc,GAAd,sBAAc,KAAd,sBAAc,QAIzB;AA2BD,IAAY,gBAEX;AAFD,WAAY,gBAAgB;IAC1B,iCAAa,CAAA;AACf,CAAC,EAFW,gBAAgB,GAAhB,wBAAgB,KAAhB,wBAAgB,QAE3B;AAED,IAAY,kBAaX;AAbD,WAAY,kBAAkB;IAC5B,aAAa;IACb,mCAAa,CAAA;IACb,WAAW;IACX,mCAAa,CAAA;IACb,WAAW;IACX,mCAAa,CAAA;IACb,WAAW;IACX,mCAAa,CAAA;IACb,cAAc;IACd,mCAAa,CAAA;IACb,eAAe;IACf,mCAAa,CAAA;AACf,CAAC,EAbW,kBAAkB,GAAlB,0BAAkB,KAAlB,0BAAkB,QAa7B;AAWD,IAAY,2BASX;AATD,WAAY,2BAA2B;IACrC,eAAe;IACf,oEAAqC,CAAA;IACrC,mBAAmB;IACnB,0EAA2C,CAAA;IAC3C,gBAAgB;IAChB,8DAA+B,CAAA;IAC/B,WAAW;IACX,kDAAmB,CAAA;AACrB,CAAC,EATW,2BAA2B,GAA3B,mCAA2B,KAA3B,mCAA2B,QAStC;AA2KD,IAAY,+BAGX;AAHD,WAAY,+BAA+B;IACzC,sDAAmB,CAAA;IACnB,kEAA+B,CAAA;AACjC,CAAC,EAHW,+BAA+B,GAA/B,uCAA+B,KAA/B,uCAA+B,QAG1C;AAuCD,IAAY,YAMX;AAND,WAAY,YAAY;IACtB,mCAAmB,CAAA;IACnB,qCAAqB,CAAA;IACrB,iCAAiB,CAAA;IACjB,qCAAqB,CAAA;IACrB,qCAAqB,CAAA;AACvB,CAAC,EANW,YAAY,GAAZ,oBAAY,KAAZ,oBAAY,QAMvB"}

package/models/order.d.ts

@@ -11,7 +11,7 @@ import { Receipt, Transaction } from './receipt';
 import { Customer, CustomerPointDetail } from './customer';
 import { Address, Operator } from './store';
 import { OnlinePlatformType, OOReasonCode, OnlineOrderMappingWarningCode } from './online-integration';
-import { SOEater, SOOperateParty } from './online-ordering';
+import { DeliveryTask, SOEater, SOOperateParty } from './online-ordering';
 import { DiscountMethod } from './discount-module';
 export interface BaseOrder {
     id?: string;
@@ -188,6 +188,10 @@ export interface Order extends BaseOrder {
     canceledByParty?: SOOperateParty;
     /** 外送地址 */
     deliveryAddress?: Address;
+    /** 外送地址經緯度，格式固定為 [longitude, latitude] */
+    deliveryAddressLonLat?: number[];
+    /** 第三方外送任務。只有使用 METE 等第三方外送時才會有；店家自己送不會有。 */
+    deliveryTask?: DeliveryTask;
     /**
      * 線上點餐、UberEats等等外送平台，線上成功收款後的
      * Transaction會暫時存在這個Property，待POS接單後，

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@trusted-solutions/sdit.models",
-  "version": "0.65.1-alpha.1",
+  "version": "0.65.2-alpha.2",
   "description": "TODO: Give a short introduction of your project. Let this section explain the objectives or the motivation behind this project.",
   "main": "index.js",
   "scripts": {