@trusted-solutions/sdit.models 0.19.0-alpha.0 → 0.19.0-alpha.3

package/lambda/contract.d.ts

@@ -1,11 +1,72 @@
-import { PlanLimit } from '../models/contract';
-export interface GetContractLimitsRequest {
+import { Contract, PlanLimits, Plan } from '../models/contract';
+/**
+ * Get Store Contract use case
+ */
+export interface GetStoreContractRequest {
     storeId: string;
+}
+export interface GetStoreContractResponse {
+    currentContract: Contract;
+    originalContract: Contract;
+    upcomingContract: Contract;
+}
+/**
+ * Get Current Store Contract use case
+ */
+export interface GetCurrentStoreContractLimitRequest {
+    contractId: string;
     /**
      * 沒給的話，回傳全部的limit
      */
     limitKeys?: string[];
 }
-export interface GetContractLimitsResponse {
-    eachLimits: PlanLimit[];
+export interface GetCurrentStoreContractLimitResponse {
+    storeId: string;
+    contractId: string;
+    eachLimits: PlanLimits;
+}
+/**
+ * Create Contract use case
+ */
+export declare type CreateContractRequest = Contract;
+export declare type CreateContractResponse = Contract;
+/**
+ * Update Contract Duration use case
+ */
+export interface UpdateContractDurationRequest {
+    contractId: string;
+    startedAt: number;
+    endedAt: number;
+}
+export declare type UpdateContractDurationResponse = null;
+/**
+ * Update Contract Plan use case
+ */
+export interface UpdateContractPlanRequest {
+    contractId: string;
+    planId: string;
+}
+export declare type UpdateContractPlanResponse = null;
+/**
+ * Update Contract ForStore use case
+ */
+export interface UpdateContractForStoreRequest {
+    contractId: string;
+    forStoreId: string;
+}
+export declare type UpdateContractForStoreResponse = null;
+/**
+ * Update Contract Owner use case
+ */
+export interface UpdateContractOwnerRequest {
+    contractId: string;
+    ownerCognitoUserId: string;
+}
+export declare type UpdateContractOwnerResponse = null;
+/**
+ * Get Plan
+ */
+export interface GetPlanRequest {
+    planId: string;
 }
+export declare type GetPlanResponse = Plan;

package/lambda/index.d.ts

@@ -4,3 +4,4 @@ export * from './response';
 export * from './online-integration';
 export * from './online-ordering';
 export * from './line-notify';
+export * from './contract';

package/lambda/index.js

@@ -7,4 +7,5 @@ tslib_1.__exportStar(require("./response"), exports);
 tslib_1.__exportStar(require("./online-integration"), exports);
 tslib_1.__exportStar(require("./online-ordering"), exports);
 tslib_1.__exportStar(require("./line-notify"), exports);
+tslib_1.__exportStar(require("./contract"), exports);
 //# sourceMappingURL=index.js.map

package/lambda/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../projects/sdit-model-lib/src/lambda/index.ts"],"names":[],"mappings":";;;AAAA,kDAAwB;AACxB,oDAA0B;AAC1B,qDAA2B;AAG3B,+DAAqC;AACrC,4DAAkC;AAElC,wDAA8B"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../projects/sdit-model-lib/src/lambda/index.ts"],"names":[],"mappings":";;;AAAA,kDAAwB;AACxB,oDAA0B;AAC1B,qDAA2B;AAG3B,+DAAqC;AACrC,4DAAkC;AAElC,wDAA8B;AAE9B,qDAA2B"}

package/models/contract.d.ts

@@ -1,143 +1,29 @@
-import { Customer, DiscountMethod, OnlinePlatformType, Operator, OrderDiscount, Product, Receipt, Tax } from '.';
-import { OrderItemPaidStatus, OrderSourceType, OrderStatus } from '../enums';
-export interface PlanLimit {
-    key: string;
-    value: boolean | number;
+import { Operator } from './store';
+export declare type PlanValueType = boolean | number;
+export interface PlanLimits {
+    [key: string]: PlanValueType;
 }
-export interface Plan extends Product {
-    version?: string;
-    eachLimits: PlanLimit[];
+export interface Plan {
+    id: string;
+    name: string;
+    description?: string;
+    planLimits?: PlanLimits;
+    /** 方案的生效天數 */
     rangeDays?: number;
 }
-/**
- * extends OrderItem
- */
 export interface Contract {
-    id: string;
+    /** createContractRequest 不用給 id */
+    id?: string;
     name: string;
-    productId: string;
-    /** amount of single plan */
-    productAmount: number;
-    productTax: Tax;
-    attributes?: Contract[];
-    /**
-     * 做為attribute 時的金額
-     */
-    additionalAmount: number;
-    /**
-     * 經由註記調整價格後的一個品項金額
-     * 原價 `productAmount` + 註記總價 `Sum(attribute.additionalAmount)`
-     */
-    subtotal?: number;
-    /**
-     * 一個品項的手動折扣方式
-     */
-    manualDiscountMethod?: DiscountMethod;
-    /**
-     * 一個品項的折扣金額，為`subtotal`與`discountMethod`計算後結果
-     */
-    discountAmount?: number;
-    quantity: number;
-    /**
-     * （`subtotal` - `discountAmount`) * `quantity`
-     */
-    amount: number;
-    /** 所屬第x次出單的品項，初始為undefined，第一次出單為0，每出單一次+1 */
-    round?: number;
-    changelogs?: ContractChangelog[];
     note?: string;
-    paidStatus?: OrderItemPaidStatus;
-    /** 建立時間 */
     createdAt?: number;
-    startAt: number;
-    endAt?: number;
-    rangeDays?: number;
+    startedAt: number;
+    endedAt: number;
     createdBy?: Operator;
-    deletedBy?: Operator;
-    /**
-     * aggregated eachLimits of product(plan) and attributes(additionalPlan)
-     */
-    eachLimits: PlanLimit[];
+    planId: string;
+    /** createContractRequest 不用給 plan */
+    plan?: Plan;
     contractProofImageUrls?: string[];
     forStoreId: string;
-    forStoreName: string;
-}
-export interface ContractLimits {
-    /**
-     * aggregated eachLimits of product(plan) and attributes(additionalPlan)
-     */
-    eachLimits: PlanLimit[];
-    forStoreId: string;
-    planName: string;
-    startAt: string;
-    endAt: string;
-}
-export interface ContractChangelog {
-    timestamp: number;
-    quantity?: number;
-    amount?: number;
-    attributes?: Contract[];
-    note?: string;
-    manualDiscountMethod?: DiscountMethod;
-    discountAmount?: number;
-    modifiedBy?: Operator;
-}
-export interface ContractOrder {
-    id: string;
-    source: OrderSourceType;
-    status?: OrderStatus;
-    customerId?: string;
-    customer?: Customer;
-    contracts: Contract[];
-    /** sigma(items.amount) */
-    subtotal: number;
-    /** subtotal - sigma(discount.discountReferences.orderItemId === null) */
-    totalAmount: number;
-    salesAmountExcludeTax: number;
-    exemptTaxSalesAmount: number;
-    zeroTaxSalesAmount: number;
-    taxAmount: number;
-    discount?: OrderDiscount;
-    note?: string;
-    createdAt: number;
-    multipleReceipts?: ContractReceipt[];
-    /** POS刪除時間 */
-    deletedAt?: number;
-    createdBy?: Operator;
-    deletedBy?: Operator;
-    /** 此訂單來自線上點餐平台 */
-    onlinePlatformType?: OnlinePlatformType.SDIT;
-    /** 外部線上點餐平台訂單ID */
-    onlinePlatformOrderId?: string;
-    /** onlinePlatform 取消時間 */
-    canceledAt?: number;
-    /** 拒絕外部訂單操作人 */
-    rejectedBy?: Operator;
-    /** 取消外部訂單操作人 */
-    canceledBy?: Operator;
-    /** 拒絕外部訂單理由 */
-    rejectedReasonCode?: ContractReasonCode;
-    /** 拒絕外部訂單理由 */
-    rejectedReason?: string;
-    /** 取消外部訂單理由 */
-    canceledReasonCode?: ContractReasonCode;
-    /** 取消外部訂單理由 */
-    canceledReason?: string;
-    /**
-     * 線上訂單。
-     * 若消費者要打統編，會記錄在這裡
-     */
-    buyerId?: string;
-}
-export interface ContractReceipt extends Receipt {
-    /**
-     * 有值代表「線上訂單 & 線上付款」。
-     * 若是「線上訂單 & 線上付款」，會走線上取消訂單並退款流程。
-     * 若是「現場付款」，則會走現場退款流程。
-     */
-    onlinePlatformType?: OnlinePlatformType.SDIT;
-}
-export declare enum ContractReasonCode {
-    PAYMENT_EXPIRED = "PAYMENT_EXPIRED",
-    OTHER = "OTHER"
+    ownerCognitoUserId: string;
 }

package/models/contract.js

@@ -1,10 +1,3 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ContractReasonCode = void 0;
-;
-var ContractReasonCode;
-(function (ContractReasonCode) {
-    ContractReasonCode["PAYMENT_EXPIRED"] = "PAYMENT_EXPIRED";
-    ContractReasonCode["OTHER"] = "OTHER";
-})(ContractReasonCode = exports.ContractReasonCode || (exports.ContractReasonCode = {}));
 //# sourceMappingURL=contract.js.map

package/models/contract.js.map

@@ -1 +1 @@
-{"version":3,"file":"contract.js","sourceRoot":"","sources":["../../../projects/sdit-model-lib/src/models/contract.ts"],"names":[],"mappings":";;;AA6FC,CAAC;AAgEF,IAAY,kBAGX;AAHD,WAAY,kBAAkB;IAC5B,yDAAmC,CAAA;IACnC,qCAAe,CAAA;AACjB,CAAC,EAHW,kBAAkB,GAAlB,0BAAkB,KAAlB,0BAAkB,QAG7B"}
+{"version":3,"file":"contract.js","sourceRoot":"","sources":["../../../projects/sdit-model-lib/src/models/contract.ts"],"names":[],"mappings":""}

package/models/index.d.ts

@@ -33,6 +33,7 @@ export * from './csv';
 export * from './appointment';
 export * from './utils';
 export * from './permission';
+export * from './contract';
 export * from './json';
 export * from './online-integration';
 export * from './online-ordering';

package/models/index.js

@@ -36,6 +36,7 @@ tslib_1.__exportStar(require("./csv"), exports);
 tslib_1.__exportStar(require("./appointment"), exports);
 tslib_1.__exportStar(require("./utils"), exports);
 tslib_1.__exportStar(require("./permission"), exports);
+tslib_1.__exportStar(require("./contract"), exports);
 tslib_1.__exportStar(require("./json"), exports);
 tslib_1.__exportStar(require("./online-integration"), exports);
 tslib_1.__exportStar(require("./online-ordering"), exports);

package/models/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../projects/sdit-model-lib/src/models/index.ts"],"names":[],"mappings":";;;AAAA,2DAAiC;AACjC,oDAA0B;AAC1B,kDAAwB;AACxB,iDAAuB;AACvB,kDAAwB;AACxB,2DAAiC;AACjC,oDAA0B;AAC1B,kDAAwB;AACxB,6DAAmC;AACnC,+DAAqC;AACrC,kDAAwB;AACxB,iDAAuB;AACvB,2DAAiC;AACjC,+DAAqC;AACrC,qDAA2B;AAC3B,qDAA2B;AAC3B,6DAAmC;AACnC,4DAAkC;AAClC,4DAAkC;AAClC,kDAAwB;AACxB,2DAAiC;AACjC,4DAAkC;AAClC,qDAA2B;AAC3B,kDAAwB;AACxB,4DAAkC;AAClC,oDAA0B;AAC1B,oDAA0B;AAC1B,kDAAwB;AACxB,kEAAwC;AACxC,mDAAyB;AACzB,sDAA4B;AAC5B,gDAAsB;AACtB,wDAA8B;AAC9B,kDAAwB;AACxB,uDAA6B;AAE7B,iDAAuB;AACvB,+DAAqC;AACrC,4DAAkC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../projects/sdit-model-lib/src/models/index.ts"],"names":[],"mappings":";;;AAAA,2DAAiC;AACjC,oDAA0B;AAC1B,kDAAwB;AACxB,iDAAuB;AACvB,kDAAwB;AACxB,2DAAiC;AACjC,oDAA0B;AAC1B,kDAAwB;AACxB,6DAAmC;AACnC,+DAAqC;AACrC,kDAAwB;AACxB,iDAAuB;AACvB,2DAAiC;AACjC,+DAAqC;AACrC,qDAA2B;AAC3B,qDAA2B;AAC3B,6DAAmC;AACnC,4DAAkC;AAClC,4DAAkC;AAClC,kDAAwB;AACxB,2DAAiC;AACjC,4DAAkC;AAClC,qDAA2B;AAC3B,kDAAwB;AACxB,4DAAkC;AAClC,oDAA0B;AAC1B,oDAA0B;AAC1B,kDAAwB;AACxB,kEAAwC;AACxC,mDAAyB;AACzB,sDAA4B;AAC5B,gDAAsB;AACtB,wDAA8B;AAC9B,kDAAwB;AACxB,uDAA6B;AAC7B,qDAA2B;AAE3B,iDAAuB;AACvB,+DAAqC;AACrC,4DAAkC"}

package/models/order.d.ts

@@ -13,7 +13,65 @@ import { Operator } from './store';
 import { OnlinePlatformType, OOReasonCode, OnlineOrderMappingWarningCode } from './online-integration';
 import { SOEater, SOOperateParty } from './online-ordering';
 import { DiscountMethod } from './discount-module';
-export interface Order {
+export interface BaseOrder {
+    id?: string;
+    source: OrderSourceType;
+    customerId?: string;
+    customer?: Customer;
+    /** 此訂單來自線上點餐XX平台 */
+    onlinePlatformType?: OnlinePlatformType;
+    /** 外部線上點餐平台訂單ID */
+    onlinePlatformOrderId?: string;
+    items: OrderItem[];
+    /** sigma(items.amount) */
+    subtotal: number;
+    /** subtotal - sigma(discount.discountReferences.orderItemId === null) */
+    totalAmount: number;
+    salesAmountExcludeTax: number;
+    exemptTaxSalesAmount: number;
+    zeroTaxSalesAmount: number;
+    taxAmount: number;
+    discount?: OrderDiscount;
+    /** 由KIOSK、線上點餐、..端給定的序號 */
+    serialNumber: string;
+    note?: string;
+    createdAt: number;
+    multipleReceipts?: Receipt[];
+    /** 接受時間 */
+    acceptedAt?: number;
+    /** 拒絕時間 */
+    rejectedAt?: number;
+    /** KIOSK, onlinePlatform 取消時間 */
+    canceledAt?: number;
+    /** 拒絕外部訂單操作人 */
+    rejectedBy?: Operator;
+    /** 取消外部訂單操作人，若第三方系統取消，則為undefined */
+    canceledBy?: Operator;
+    /** 拒絕外部訂單理由 */
+    rejectedReasonCode?: string;
+    /** 拒絕外部訂單理由 */
+    rejectedReason?: string;
+    /** 取消外部訂單理由 */
+    canceledReasonCode?: string;
+    /** 取消外部訂單理由 */
+    canceledReason?: string;
+    /**
+     * 線上訂單。
+     * 若消費者要打統編，會記錄在這裡
+     */
+    buyerId?: string;
+    /** 線上訂購人 */
+    onlineBuyer?: SOEater;
+    /** 訂單取消方 */
+    canceledByParty?: SOOperateParty;
+    /**
+     * 線上點餐、UberEats等等外送平台，線上成功收款後的
+     * Transaction會暫時存在這個Property，待POS接單後，
+     * 再將這個Transaction包成Receipt
+     */
+    externalPayment?: Transaction;
+}
+export interface Order extends BaseOrder {
     id?: string;
     source: OrderSourceType;
     status?: OrderStatus;

package/package.json

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