@trusted-solutions/sdit.models 0.15.0-alpha.0

package/models/online-integration.d.ts

@@ -0,0 +1,68 @@
+import { UbMenuConfiguration, UbMenuEntity, UbMenuItem, UbMenuModifierGroup } from '../third-party-api/uber-eats';
+export declare enum OnlineOrderMappingWarningCode {
+    ROOT_ITEM = "ROOT_ITEM",
+    ITEM_ATTRIBUTE = "ITEM_ATTRIBUTE",
+    PAYMENT = "PAYMENT"
+}
+export declare enum OMMItemContextType {
+    MENU = 0,
+    ITEM = 1,
+    MODIFIER_GROUP = 2
+}
+export declare enum OMMItemContentEntityType {
+    PRODUCT = "PRODUCT",
+    PRODUCT_ATTRIBUTE = "PRODUCT_ATTRIBUTE"
+}
+export declare enum OnlinePlatformType {
+    UBER_EATS = "UBER_EATS",
+    FOOD_PANDA = "FOOD_PANDA",
+    SDIT = "SDIT"
+}
+export declare enum OOReasonCode {
+    RESTAURANT_TOO_BUSY = "RESTAURANT_TOO_BUSY",
+    KITCHEN_CLOSED = "KITCHEN_CLOSED",
+    OUT_OF_ITEMS = "OUT_OF_ITEMS",
+    CUSTOMER_CALLED_TO_CANCEL = "CUSTOMER_CALLED_TO_CANCEL",
+    CANNOT_COMPLETE_CUSTOMER_NOTE = "CANNOT_COMPLETE_CUSTOMER_NOTE",
+    OTHER = "OTHER"
+}
+export declare enum OMEntityType {
+    ITEM = "ITEM",
+    MODIFIER_GROUP = "MODIFIER_GROUP"
+}
+export declare type OMMMenuEntity = UbMenuEntity;
+export interface OMMItem extends UbMenuItem {
+    external_data: OMMItemContent[];
+}
+export interface OMMModifierGroup extends UbMenuModifierGroup {
+    external_data: OMMItemContent[];
+}
+export interface OMMConfig extends UbMenuConfiguration {
+    items: OMMItem[];
+    modifier_groups: OMMModifierGroup[];
+}
+export interface OMMItemContent {
+    overrideId?: {
+        contextType: OMMItemContextType;
+        contextValue: string;
+    };
+    content: {
+        entityName: OMMItemContentEntityType;
+        entityId: string;
+    };
+}
+export interface OMMContent {
+    id: string;
+    entityName: 'Product' | 'ProductAttribute';
+}
+/** ========  OnlinePlatformStore ============= */
+export interface SOPSContent {
+    content?: {
+        customPaymentConfigName?: string;
+    };
+}
+export interface StoreOnlinePlatformStore extends SOPSContent {
+    storeId: string;
+    onlinePlatformType: OnlinePlatformType;
+    onlinePlatformStoreId: string;
+}

package/models/online-integration.js

@@ -0,0 +1,41 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.OMEntityType = exports.OOReasonCode = exports.OnlinePlatformType = exports.OMMItemContentEntityType = exports.OMMItemContextType = exports.OnlineOrderMappingWarningCode = void 0;
+var OnlineOrderMappingWarningCode;
+(function (OnlineOrderMappingWarningCode) {
+    OnlineOrderMappingWarningCode["ROOT_ITEM"] = "ROOT_ITEM";
+    OnlineOrderMappingWarningCode["ITEM_ATTRIBUTE"] = "ITEM_ATTRIBUTE";
+    OnlineOrderMappingWarningCode["PAYMENT"] = "PAYMENT";
+})(OnlineOrderMappingWarningCode = exports.OnlineOrderMappingWarningCode || (exports.OnlineOrderMappingWarningCode = {}));
+var OMMItemContextType;
+(function (OMMItemContextType) {
+    OMMItemContextType[OMMItemContextType["MENU"] = 0] = "MENU";
+    OMMItemContextType[OMMItemContextType["ITEM"] = 1] = "ITEM";
+    OMMItemContextType[OMMItemContextType["MODIFIER_GROUP"] = 2] = "MODIFIER_GROUP";
+})(OMMItemContextType = exports.OMMItemContextType || (exports.OMMItemContextType = {}));
+var OMMItemContentEntityType;
+(function (OMMItemContentEntityType) {
+    OMMItemContentEntityType["PRODUCT"] = "PRODUCT";
+    OMMItemContentEntityType["PRODUCT_ATTRIBUTE"] = "PRODUCT_ATTRIBUTE";
+})(OMMItemContentEntityType = exports.OMMItemContentEntityType || (exports.OMMItemContentEntityType = {}));
+var OnlinePlatformType;
+(function (OnlinePlatformType) {
+    OnlinePlatformType["UBER_EATS"] = "UBER_EATS";
+    OnlinePlatformType["FOOD_PANDA"] = "FOOD_PANDA";
+    OnlinePlatformType["SDIT"] = "SDIT";
+})(OnlinePlatformType = exports.OnlinePlatformType || (exports.OnlinePlatformType = {}));
+var OOReasonCode;
+(function (OOReasonCode) {
+    OOReasonCode["RESTAURANT_TOO_BUSY"] = "RESTAURANT_TOO_BUSY";
+    OOReasonCode["KITCHEN_CLOSED"] = "KITCHEN_CLOSED";
+    OOReasonCode["OUT_OF_ITEMS"] = "OUT_OF_ITEMS";
+    OOReasonCode["CUSTOMER_CALLED_TO_CANCEL"] = "CUSTOMER_CALLED_TO_CANCEL";
+    OOReasonCode["CANNOT_COMPLETE_CUSTOMER_NOTE"] = "CANNOT_COMPLETE_CUSTOMER_NOTE";
+    OOReasonCode["OTHER"] = "OTHER";
+})(OOReasonCode = exports.OOReasonCode || (exports.OOReasonCode = {}));
+var OMEntityType;
+(function (OMEntityType) {
+    OMEntityType["ITEM"] = "ITEM";
+    OMEntityType["MODIFIER_GROUP"] = "MODIFIER_GROUP";
+})(OMEntityType = exports.OMEntityType || (exports.OMEntityType = {}));
+//# sourceMappingURL=online-integration.js.map

package/models/online-integration.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"online-integration.js","sourceRoot":"","sources":["../../../projects/sdit-model-lib/src/models/online-integration.ts"],"names":[],"mappings":";;;AAEA,IAAY,6BAIX;AAJD,WAAY,6BAA6B;IACvC,wDAAuB,CAAA;IACvB,kEAAiC,CAAA;IACjC,oDAAmB,CAAA;AACrB,CAAC,EAJW,6BAA6B,GAA7B,qCAA6B,KAA7B,qCAA6B,QAIxC;AAID,IAAY,kBAIX;AAJD,WAAY,kBAAkB;IAC5B,2DAAQ,CAAA;IACR,2DAAQ,CAAA;IACR,+EAAkB,CAAA;AACpB,CAAC,EAJW,kBAAkB,GAAlB,0BAAkB,KAAlB,0BAAkB,QAI7B;AAGD,IAAY,wBAGX;AAHD,WAAY,wBAAwB;IAClC,+CAAmB,CAAA;IACnB,mEAAuC,CAAA;AACzC,CAAC,EAHW,wBAAwB,GAAxB,gCAAwB,KAAxB,gCAAwB,QAGnC;AAED,IAAY,kBAIX;AAJD,WAAY,kBAAkB;IAC5B,6CAAuB,CAAA;IACvB,+CAAyB,CAAA;IACzB,mCAAa,CAAA;AACf,CAAC,EAJW,kBAAkB,GAAlB,0BAAkB,KAAlB,0BAAkB,QAI7B;AAED,IAAY,YAOX;AAPD,WAAY,YAAY;IACtB,2DAA2C,CAAA;IAC3C,iDAAiC,CAAA;IACjC,6CAA6B,CAAA;IAC7B,uEAAuD,CAAA;IACvD,+EAA+D,CAAA;IAC/D,+BAAe,CAAA;AACjB,CAAC,EAPW,YAAY,GAAZ,oBAAY,KAAZ,oBAAY,QAOvB;AAID,IAAY,YAGX;AAHD,WAAY,YAAY;IACtB,6BAAa,CAAA;IACb,iDAAiC,CAAA;AACnC,CAAC,EAHW,YAAY,GAAZ,oBAAY,KAAZ,oBAAY,QAGvB"}

package/models/online-ordering.d.ts

@@ -0,0 +1,217 @@
+import { PaymentServiceProvider, PaymentType, ServeType } from '../enums';
+import { MultiLanguageText, OrderDiscount, Quantity, OOReasonCode } from '../models';
+import { DayOfWeekTimePeriod } from './store';
+export interface SOOrderError {
+    type: SOOrderErrorType;
+    /**
+     * 不可販賣的品項
+     */
+    unavailableCartItems?: SOUnavailableCartItem[];
+}
+export declare enum SOOrderErrorType {
+    itemSoldOut = "itemSoldOut",
+    amountChanged = "amountChanged",
+    storeNotOpening = "storeNotOpening",
+    storeNotEnabled = "storeNotEnabled"
+}
+export interface SOPaymentMethod {
+    paymentServiceProvider: PaymentServiceProvider;
+    paymentType: PaymentType;
+}
+export interface SOCartItem {
+    /** cart item Id (timestamp ms) */
+    id: string;
+    productCategoryId: string;
+    productId: string;
+    /** 原單價 */
+    productAmount: number;
+    /** 數量 */
+    quantity: number;
+    name: string;
+    selectedAttributes: SOCartAttributes[];
+    notes?: string;
+    /** (attrs + product amount) * quantity */
+    subtotal: number;
+    /** sigma(discount.discountReferences.orderItemId === id)) */
+    discountAmount: number;
+    /** (subtotal - discountAmount) */
+    amount: number;
+}
+export interface SOCartAttributes {
+    attributeCategoryId: string;
+    attributeId: string;
+    name: string;
+    additionalAmount: number;
+    quantity: number;
+    totalAmount: number;
+}
+export interface SOEater {
+    id: string;
+    name: string;
+    phone: string;
+    email?: string;
+    buyerId?: string;
+}
+export declare enum SOOperateParty {
+    store = "store",
+    buyer = "buyer"
+}
+export interface SOCart {
+    items: SOCartItem[];
+    notes?: string;
+}
+export interface SOOrder {
+    id?: string;
+    storeId: string;
+    displayId: string;
+    state: SOOrderState;
+    serveType: ServeType;
+    /** 訂購人 */
+    eater: SOEater;
+    /**  品項們 */
+    cart: SOCart;
+    /** 包裝、免洗餐具  */
+    includeDisposableItems: boolean;
+    /** 購買人預期取餐時間 */
+    expectedPickupAt: number;
+    /** 店家端預計餐點完成時間 */
+    estimatedReadyForPickupAt: number;
+    /** 訂單建立時間 */
+    createdAt: number;
+    /** 訂單接受時間 */
+    acceptedAt: number;
+    /** 訂單拒絕時間 */
+    rejectedAt: number;
+    /** 訂單取消時間 */
+    canceledAt: number;
+    /** 訂單完成時間 = order.leftAt */
+    doneAt: number;
+    subtotal: number;
+    discount: OrderDiscount;
+    totalDiscountAmount: number;
+    taxAmount: number;
+    salesAmountExcludeTax: number;
+    exemptTaxSalesAmount: number;
+    zeroTaxSalesAmount: number;
+    totalAmount: number;
+    /** 訂單取消方 */
+    canceledByParty: SOOperateParty;
+    /** 店家方拒絕理由 */
+    rejectedReasonCode?: OOReasonCode;
+    /** 店家方拒絕理由 */
+    rejectedReason?: string;
+    /** 店家方取消理由 */
+    canceledReasonCode?: OOReasonCode;
+    /** 店家方取消理由 */
+    canceledReason?: string;
+    /** 消費者預計付款方式 */
+    expectedPaymentMethod: SOPaymentMethod;
+    /** 消費者實際付款方式 */
+    actualPaymentMethod?: SOPaymentMethod;
+    /** 消費者付款時間 undefined為未付款 */
+    paidAt?: number;
+}
+export interface SOUnavailableCartItem {
+    menuItemType: 'product' | 'attribute';
+    /**
+     * 線上品項或Attr Id
+     */
+    menuItemId: string;
+}
+export declare enum SOUnavailableCartItemReasonCode {
+    soldOut = "soldOut",
+    amountChanged = "amountChanged"
+}
+export interface SOValidateCart {
+    items: SOValidateCartItem[];
+    notes?: string;
+}
+export interface SOValidateCartItem {
+    /** 前端決定 cart item Id (timestamp ms) */
+    id: string;
+    productCategoryId: string;
+    productId: string;
+    /** 原單價 */
+    productAmount: number;
+    /** 數量 */
+    quantity: number;
+    selectedAttributes: SOValidateCartItemAttribute[];
+    notes?: string;
+}
+export interface SOValidateCartItemAttribute {
+    attributeCategoryId: string;
+    attributeId: string;
+    name: string;
+    additionalAmount: number;
+    quantity: number;
+}
+export declare enum SOOrderState {
+    created = "created",
+    accepted = "accepted",
+    denied = "denied",
+    canceled = "canceled",
+    finished = "finished"
+}
+export interface SOPublicMenu {
+    id: string;
+    name: MultiLanguageText;
+    /**
+     * 可販賣時間
+     */
+    availableTime?: DayOfWeekTimePeriod;
+    soPublicCategoryIds: string[];
+    sort: number;
+}
+export interface SOPublicCategory {
+    id: string;
+    name: MultiLanguageText;
+    description: MultiLanguageText;
+    soPublicProductIds: string[];
+}
+export interface SOPublicProduct {
+    id: string;
+    /**
+     *  線上自定義名稱，若無定義，則回傳原始商品名稱
+     */
+    name: MultiLanguageText;
+    description: MultiLanguageText;
+    /**
+     *  線上自定義價格，若無定義，則回傳原始商品價格
+     */
+    amount: number;
+    imageUrl?: string;
+    sort: number;
+    attributeIds: string[];
+    /**
+     *  線上售完
+     */
+    soldOut: boolean;
+}
+export interface SOPublicProductAttributeCategory {
+    /**
+     * productAttributeCategoryId
+     */
+    id: string;
+    name: MultiLanguageText;
+    sort: number;
+    multiSelect?: boolean;
+    quantity?: Quantity;
+    storeTemplateId?: string;
+}
+export interface SOPublicProductAttribute {
+    /**
+     * productAttributeId
+     */
+    id: string;
+    /**
+     * productCategoryAttributeId
+     */
+    categoryId: string;
+    name: MultiLanguageText;
+    additionalAmount: number;
+    sort: number;
+    /**
+     *  線上售完
+     */
+    soldOut: boolean;
+}

package/models/online-ordering.js

@@ -0,0 +1,29 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SOOrderState = exports.SOUnavailableCartItemReasonCode = exports.SOOperateParty = exports.SOOrderErrorType = void 0;
+var SOOrderErrorType;
+(function (SOOrderErrorType) {
+    SOOrderErrorType["itemSoldOut"] = "itemSoldOut";
+    SOOrderErrorType["amountChanged"] = "amountChanged";
+    SOOrderErrorType["storeNotOpening"] = "storeNotOpening";
+    SOOrderErrorType["storeNotEnabled"] = "storeNotEnabled";
+})(SOOrderErrorType = exports.SOOrderErrorType || (exports.SOOrderErrorType = {}));
+var SOOperateParty;
+(function (SOOperateParty) {
+    SOOperateParty["store"] = "store";
+    SOOperateParty["buyer"] = "buyer";
+})(SOOperateParty = exports.SOOperateParty || (exports.SOOperateParty = {}));
+var SOUnavailableCartItemReasonCode;
+(function (SOUnavailableCartItemReasonCode) {
+    SOUnavailableCartItemReasonCode["soldOut"] = "soldOut";
+    SOUnavailableCartItemReasonCode["amountChanged"] = "amountChanged";
+})(SOUnavailableCartItemReasonCode = exports.SOUnavailableCartItemReasonCode || (exports.SOUnavailableCartItemReasonCode = {}));
+var SOOrderState;
+(function (SOOrderState) {
+    SOOrderState["created"] = "created";
+    SOOrderState["accepted"] = "accepted";
+    SOOrderState["denied"] = "denied";
+    SOOrderState["canceled"] = "canceled";
+    SOOrderState["finished"] = "finished";
+})(SOOrderState = exports.SOOrderState || (exports.SOOrderState = {}));
+//# sourceMappingURL=online-ordering.js.map

package/models/online-ordering.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"online-ordering.js","sourceRoot":"","sources":["../../../projects/sdit-model-lib/src/models/online-ordering.ts"],"names":[],"mappings":";;;AAeA,IAAY,gBAKX;AALD,WAAY,gBAAgB;IAC1B,+CAA2B,CAAA;IAC3B,mDAA+B,CAAA;IAC/B,uDAAmC,CAAA;IACnC,uDAAmC,CAAA;AACrC,CAAC,EALW,gBAAgB,GAAhB,wBAAgB,KAAhB,wBAAgB,QAK3B;AAgDD,IAAY,cAGX;AAHD,WAAY,cAAc;IACxB,iCAAe,CAAA;IACf,iCAAe,CAAA;AACjB,CAAC,EAHW,cAAc,GAAd,sBAAc,KAAd,sBAAc,QAGzB;AAiFD,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;AA4BD,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-action.d.ts

@@ -0,0 +1,11 @@
+import { OrderActionNameEnum } from "../enums/order-action-name";
+export interface OrderAction {
+    name: OrderActionNameEnum;
+    payload: any;
+}
+export interface CompleteAction extends OrderAction {
+    name: OrderActionNameEnum.complete;
+}
+export interface CancelAction extends OrderAction {
+    name: OrderActionNameEnum.cancel;
+}

package/models/order-action.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=order-action.js.map

package/models/order-action.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"order-action.js","sourceRoot":"","sources":["../../../projects/sdit-model-lib/src/models/order-action.ts"],"names":[],"mappings":""}