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

package/enums/payment-type.d.ts

@@ -13,6 +13,8 @@ export declare enum PaymentType {
     oPay = "oPay",
     taiwanPay = "taiwanPay",
     eSunWallet = "eSunWallet",
+    /** TWQR（線下版） */
+    twqr = "twqr",
     aliPay = "aliPay",
     weixin = "weixin",
     hana = "hana",
@@ -52,6 +54,10 @@ export declare enum PaymentType {
     pxpayplusOn = "pxpayplusOn",
     /** 全盈 */
     pluspayOn = "pluspayOn",
+    /** TWQR */
+    twqrOn = "twqrOn",
+    /** 玉山 Wallet（線上版） */
+    eSunWalletOn = "eSunWalletOn",
     weixinOn = "weixinOn",
     aliOn = "aliOn",
     /**

package/enums/payment-type.js

@@ -17,6 +17,8 @@ var PaymentType;
     PaymentType["oPay"] = "oPay";
     PaymentType["taiwanPay"] = "taiwanPay";
     PaymentType["eSunWallet"] = "eSunWallet";
+    /** TWQR（線下版） */
+    PaymentType["twqr"] = "twqr";
     PaymentType["aliPay"] = "aliPay";
     PaymentType["weixin"] = "weixin";
     PaymentType["hana"] = "hana";
@@ -56,6 +58,10 @@ var PaymentType;
     PaymentType["pxpayplusOn"] = "pxpayplusOn";
     /** 全盈 */
     PaymentType["pluspayOn"] = "pluspayOn";
+    /** TWQR */
+    PaymentType["twqrOn"] = "twqrOn";
+    /** 玉山 Wallet（線上版） */
+    PaymentType["eSunWalletOn"] = "eSunWalletOn";
     PaymentType["weixinOn"] = "weixinOn";
     PaymentType["aliOn"] = "aliOn";
     /**

package/enums/payment-type.js.map

@@ -1 +1 @@
-{"version":3,"file":"payment-type.js","sourceRoot":"","sources":["../../../projects/sdit-model-lib/src/enums/payment-type.ts"],"names":[],"mappings":";;;AAAA,IAAY,WAyEX;AAzED,WAAY,WAAW;IACrB,oCAAqB,CAAA;IACrB,8BAAe,CAAA;IACf,8BAAe,CAAA;IACf,sCAAuB,CAAA;IAEvB,wCAAyB,CAAA;IACzB,8CAA+B,CAAA;IAE/B,kCAAmB,CAAA;IACnB,kCAAmB,CAAA;IACnB,kCAAmB,CAAA;IACnB,kCAAmB,CAAA;IACnB,wBAAS,CAAA;IACT,4BAAa,CAAA;IACb,sCAAuB,CAAA;IACvB,wCAAyB,CAAA;IACzB,gCAAiB,CAAA;IACjB,gCAAiB,CAAA;IACjB,4BAAa,CAAA;IACb,wCAAyB,CAAA;IACzB,oCAAqB,CAAA;IACrB,sCAAuB,CAAA;IACvB,SAAS;IACT,kCAAmB,CAAA;IACnB,eAAe;IACf,wCAAyB,CAAA;IACzB,sCAAsC;IACtC,4CAA6B,CAAA;IAC7B,iCAAiC;IACjC,8BAAe,CAAA;IACf,8BAA8B;IAC9B,gCAAiB,CAAA;IACjB,+BAA+B;IAC/B,gCAAiB,CAAA;IACjB,gCAAgC;IAChC,kCAAmB,CAAA;IACnB,gCAAgC;IAChC,kCAAmB,CAAA;IAEnB,kCAAmB,CAAA;IACnB,gCAAiB,CAAA;IACjB,4BAAa,CAAA;IAEb,0BAAW,CAAA;IAEX,kCAAmB,CAAA;IAGnB;;OAEG;IACH,sCAAuB,CAAA;IACvB,4BAAa,CAAA;IACb,gCAAiB,CAAA;IACjB,4CAA6B,CAAA;IAC7B,4CAA6B,CAAA;IAC7B,wCAAyB,CAAA;IACzB,0CAA2B,CAAA;IAC3B,SAAS;IACT,sCAAuB,CAAA;IAGvB,oCAAqB,CAAA;IACrB,8BAAe,CAAA;IAEd;;MAEE;IACF,oCAAqB,CAAA;IAErB,qCAAqC;IACrC,sDAAuC,CAAA;AAC1C,CAAC,EAzEW,WAAW,GAAX,mBAAW,KAAX,mBAAW,QAyEtB"}
+{"version":3,"file":"payment-type.js","sourceRoot":"","sources":["../../../projects/sdit-model-lib/src/enums/payment-type.ts"],"names":[],"mappings":";;;AAAA,IAAY,WA+EX;AA/ED,WAAY,WAAW;IACrB,oCAAqB,CAAA;IACrB,8BAAe,CAAA;IACf,8BAAe,CAAA;IACf,sCAAuB,CAAA;IAEvB,wCAAyB,CAAA;IACzB,8CAA+B,CAAA;IAE/B,kCAAmB,CAAA;IACnB,kCAAmB,CAAA;IACnB,kCAAmB,CAAA;IACnB,kCAAmB,CAAA;IACnB,wBAAS,CAAA;IACT,4BAAa,CAAA;IACb,sCAAuB,CAAA;IACvB,wCAAyB,CAAA;IACzB,gBAAgB;IAChB,4BAAa,CAAA;IACb,gCAAiB,CAAA;IACjB,gCAAiB,CAAA;IACjB,4BAAa,CAAA;IACb,wCAAyB,CAAA;IACzB,oCAAqB,CAAA;IACrB,sCAAuB,CAAA;IACvB,SAAS;IACT,kCAAmB,CAAA;IACnB,eAAe;IACf,wCAAyB,CAAA;IACzB,sCAAsC;IACtC,4CAA6B,CAAA;IAC7B,iCAAiC;IACjC,8BAAe,CAAA;IACf,8BAA8B;IAC9B,gCAAiB,CAAA;IACjB,+BAA+B;IAC/B,gCAAiB,CAAA;IACjB,gCAAgC;IAChC,kCAAmB,CAAA;IACnB,gCAAgC;IAChC,kCAAmB,CAAA;IAEnB,kCAAmB,CAAA;IACnB,gCAAiB,CAAA;IACjB,4BAAa,CAAA;IAEb,0BAAW,CAAA;IAEX,kCAAmB,CAAA;IAGnB;;OAEG;IACH,sCAAuB,CAAA;IACvB,4BAAa,CAAA;IACb,gCAAiB,CAAA;IACjB,4CAA6B,CAAA;IAC7B,4CAA6B,CAAA;IAC7B,wCAAyB,CAAA;IACzB,0CAA2B,CAAA;IAC3B,SAAS;IACT,sCAAuB,CAAA;IACvB,WAAW;IACX,gCAAiB,CAAA;IACjB,qBAAqB;IACrB,4CAA6B,CAAA;IAG7B,oCAAqB,CAAA;IACrB,8BAAe,CAAA;IAEd;;MAEE;IACF,oCAAqB,CAAA;IAErB,qCAAqC;IACrC,sDAAuC,CAAA;AAC1C,CAAC,EA/EW,WAAW,GAAX,mBAAW,KAAX,mBAAW,QA+EtB"}

package/lambda/online-ordering.d.ts

@@ -403,9 +403,17 @@ export interface SOSendOrderRequest {
      * 不給值 = 盡快
      */
     expectedPickupAt?: number;
-    /** 外送地址 serveType === deliveryByStore 時有效 */
+    /**
+     * 消費者收件地址。
+     *
+     * serveType === deliveryByStore 時有效。
+     */
     deliveryAddress?: Address;
-    /** 外送地址經緯度，格式固定為 [longitude, latitude]；serveType === deliveryByStore 時建議送出 */
+    /**
+     * 消費者收件地址經緯度，格式固定為 [longitude, latitude]。
+     *
+     * 這是消費者收件位置，不應從店家設定推導；serveType === deliveryByStore 時建議送出。
+     */
     deliveryAddressLonLat?: number[];
     /** 內用桌ID serveType === dineIn 時有效 */
     tableId?: string;

package/models/online-ordering.d.ts

@@ -94,23 +94,72 @@ export interface SOCart {
     items: SOCartItem[];
     notes?: string;
 }
+/**
+ * 外送地點。
+ *
+ * address 為結構化地址；lonLat 格式固定為 [longitude, latitude]。
+ */
+export interface DeliveryLocation {
+    /** 地址，地址備註使用 address.note */
+    address: Address;
+    /** 經緯度，固定格式為 [longitude, latitude] */
+    lonLat: number[];
+}
+/**
+ * 外送取貨方，也就是店家。
+ *
+ * POS 可直接使用這組資料建立第三方配送任務，不需要再次查詢店家資料。
+ */
+export interface DeliverySender {
+    /** 店家名稱 */
+    name: string;
+    /** 店家電話 */
+    phone: string;
+    /** 店家位置 */
+    location: DeliveryLocation;
+}
+/** 外送收件方，也就是消費者。 */
+export interface DeliveryRecipient {
+    /** 收件人姓名 */
+    name: string;
+    /** 收件人電話 */
+    phone: string;
+    /** 收件人位置 */
+    location: DeliveryLocation;
+    /** 收件人或配送指示，例如到了請打電話給收件人 */
+    note?: string;
+}
+/**
+ * 建立外送時需要的完整固定資料。
+ *
+ * delivery 只描述配送雙方與地址，不包含第三方配送狀態。
+ */
+export interface Delivery {
+    sender: DeliverySender;
+    recipient: DeliveryRecipient;
+}
+/**
+ * 給線上點餐消費者顯示的配送狀態。
+ *
+ * 這是由後端從 POS Order.deliveryTask 轉換後產生的安全 response。
+ */
 export interface SODeliveryTask {
-    /** 外送服務商 */
+    /** 外送服務商，目前為 METE */
     provider: DeliveryProvider;
     /** 後端標準化後的外送狀態 */
     normalizedStatus?: DeliveryTaskStatus;
-    /** 此物流狀態發生時間，timestamp ms */
+    /** 配送狀態發生時間，timestamp ms */
     statusAt?: number;
-    /** 第三方提供的追蹤連結 */
+    /** 第三方追蹤網址 */
     trackUrl?: string;
     /** 司機資訊 */
     courier?: {
         name?: string;
         phone?: string;
     };
-    /** 後端最後更新 deliveryTask 的時間，timestamp ms */
+    /** 後端最後更新配送狀態的時間，timestamp ms */
     updatedAt?: number;
-    /** 配送狀態異常提示 */
+    /** 可顯示給消費者的配送異常提示 */
     statusIssue?: DeliveryTaskStatusIssue;
 }
 export declare enum DeliveryProvider {
@@ -131,9 +180,9 @@ export declare enum DeliveryTaskStatus {
     D501 = "D501"
 }
 export interface DeliveryTaskStatusIssue {
-    /** 狀態異常代碼，前端可依 code 決定提示文案 */
+    /** 前端依 code 決定顯示文案 */
     code: DeliveryTaskStatusIssueCode;
-    /** 後端提供的產品化提示文字，可顯示給消費者 */
+    /** 後端提供的產品化提示文字 */
     message: string;
     /** 異常發生時間，timestamp ms */
     occurredAt?: number;
@@ -148,6 +197,11 @@ export declare enum DeliveryTaskStatusIssueCode {
     /** 未知問題 */
     unknown = "unknown"
 }
+/**
+ * POS/backend 使用的完整第三方配送任務資料。
+ *
+ * statusCode、status 與 error 等原始資料不應直接暴露給消費者前端。
+ */
 export interface DeliveryTask {
     /** 外送服務商，目前只有 METE */
     provider: DeliveryProvider;
@@ -194,6 +248,7 @@ export interface DeliveryTaskError {
     raw?: unknown;
     occurredAt: number;
 }
+export declare type SOPaymentFlowState = 'payable' | 'onlinePaymentActive' | 'paymentFailed' | 'paidProcessing' | 'paidAfterExpired' | 'placed' | 'expired' | 'refunded' | 'failedAfterPosNotified' | 'onsitePayment';
 export interface SOOrder {
     id?: string;
     storeId: string;
@@ -223,6 +278,10 @@ export interface SOOrder {
     estimatedReadyForPickupAt: number;
     /** 訂單建立時間 */
     createdAt: number;
+    /** 等待線上付款逾時時間，超過時間未付款則視為取消 */
+    expiredAt?: number;
+    /** 線上付款流程狀態，供前端判斷付款頁重開、等待、過期或退款狀態 */
+    paymentFlowState?: SOPaymentFlowState;
     /** 訂單接受時間 */
     acceptedAt: number;
     /** 訂單拒絕時間 */
@@ -262,11 +321,9 @@ export interface SOOrder {
     paidAt?: number;
     /** 訂單被取消或拒絕後，已付款的退款時間 undefined 為未退款 */
     refundedAt?: number;
-    /** 外送地址 */
+    /** 消費者收件地址 */
     deliveryAddress?: Address;
-    /** 外送地址經緯度，格式固定為 [longitude, latitude] */
-    deliveryAddressLonLat?: number[];
-    /** 第三方外送任務 */
+    /** 第三方外送配送狀態。店家自己配送時，此欄位不存在。 */
     deliveryTask?: SODeliveryTask;
     /** 付款中的Transaction用來反查付款結果 */
     transactionId?: string;

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;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"}
+{"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;AAsFD,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;AA6LD,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 { DeliveryTask, SOEater, SOOperateParty } from './online-ordering';
+import { Delivery, DeliveryTask, SOEater, SOOperateParty } from './online-ordering';
 import { DiscountMethod } from './discount-module';
 export interface BaseOrder {
     id?: string;
@@ -186,11 +186,15 @@ export interface Order extends BaseOrder {
     expectedPickupAt?: number;
     /** 訂單取消方 */
     canceledByParty?: SOOperateParty;
-    /** 外送地址 */
+    /** 消費者收件地址 */
     deliveryAddress?: Address;
-    /** 外送地址經緯度，格式固定為 [longitude, latitude] */
-    deliveryAddressLonLat?: number[];
-    /** 第三方外送任務。只有使用 METE 等第三方外送時才會有；店家自己送不會有。 */
+    /** 完整建立配送所需的固定資料。 */
+    delivery?: Delivery;
+    /**
+     * 米特建立後產生的完整配送任務。
+     *
+     * 店家自行配送時不建立空物件，直接不提供此欄位。
+     */
     deliveryTask?: DeliveryTask;
     /**
      * 線上點餐、UberEats等等外送平台，線上成功收款後的

package/models/payment-config.d.ts

@@ -4,7 +4,7 @@ export interface MultiplePaymentConfig {
     name: string;
     paymentConfigs: PaymentConfig[];
 }
-export declare type PaymentConfig = BasePaymentConfig | EasyCardConfig | TSBankCreditCardConfig | OnePayConfig | ESunMPayConfig | CustomPaymentConfig | CashPaymentConfig | NcccV3pPaymentConfig | NcccD200PaymentConfig | NcccVX520PaymentConfig | SgSmoochpayOnlineConfig;
+export declare type PaymentConfig = BasePaymentConfig | EasyCardConfig | TSBankCreditCardConfig | OnePayConfig | ESunMPayConfig | CustomPaymentConfig | CashPaymentConfig | NcccV3pPaymentConfig | NcccD200PaymentConfig | NcccVX520PaymentConfig | MyPayPayPagePaymentConfig | SgSmoochpayOnlineConfig | DdpayOnlineConfig | DdpayConfig | LinepayOnlineConfig | NewebpayOnlineConfig | NewebpayConfig;
 export interface BasePaymentConfig {
     provider: PaymentServiceProvider;
     type: PaymentType;
@@ -97,7 +97,7 @@ export interface LinepayOnlineConfig extends BasePaymentConfig {
 }
 export interface NewebpayOnlineConfig extends BasePaymentConfig {
     provider: PaymentServiceProvider.newebpayOnline;
-    type: PaymentType.creditCardOn;
+    type: PaymentType.creditCardOn | PaymentType.linePayOn | PaymentType.eSunWallet | PaymentType.taiwanPay | PaymentType.twqrOn | PaymentType.aliOn | PaymentType.weixinOn | PaymentType.unknown;
     merchantId: string;
     hashKey: string;
     hashIV: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@trusted-solutions/sdit.models",
-  "version": "0.65.2-alpha.2",
+  "version": "0.65.2-alpha.5",
   "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": {