@aptos-scp/scp-component-store-selling-features-domain-model 1.0.12 → 1.1.0

package/lib/domain/UIBusinessEventTypes.d.ts

@@ -158,6 +158,7 @@ export declare const ITEM_PICKUP_SIGNATURE_EVENT: string;
 export declare const TERMINAL_STATE_SYNC_EVENT: string;
 export declare const TRANSACTION_FEE_CHANGE_QUANTITY_EVENT = "ChangeTransactionFeeQuantity";
 export declare const TRANSACTION_FEE_EVENT = "TransactionFee";
+export declare const TRANSACTION_FEE_REFUND_EVENT: string;
 export declare const MAKE_DONATION_EVENT = "MakeDonation";
 export declare const TRANSACTION_RECEIPTS_EVENT = "TransactionReceipts";
 export declare const TRANSACTION_TAX_EXEMPT_EVENT = "TransactionTaxExempt";

package/lib/domain/UIBusinessEventTypes.js

@@ -161,6 +161,7 @@ exports.ITEM_PICKUP_SIGNATURE_EVENT = "ItemPickupSignature";
 exports.TERMINAL_STATE_SYNC_EVENT = "TerminalStatusSync";
 exports.TRANSACTION_FEE_CHANGE_QUANTITY_EVENT = "ChangeTransactionFeeQuantity";
 exports.TRANSACTION_FEE_EVENT = "TransactionFee";
+exports.TRANSACTION_FEE_REFUND_EVENT = "TransactionRefundFee";
 exports.MAKE_DONATION_EVENT = "MakeDonation";
 exports.TRANSACTION_RECEIPTS_EVENT = "TransactionReceipts";
 exports.TRANSACTION_TAX_EXEMPT_EVENT = "TransactionTaxExempt";

package/lib/domain/model/Constants.d.ts

@@ -249,6 +249,7 @@ export declare enum UiInputKey {
     SALESPERSON_ID = "input_salespersonId",
     SELECTED_ORDER_ITEMS = "input_selectedOrderItems",
     CANCELLED_ORDER_ITEM_LINE_NUMBER = "input_cancelledOrderItemLineNumber",
+    FEE_DETAILS = "input_feeDetails",
     SUBSCRIPTIONS = "input_subscriptions",
     VAT_NUMBER = "input_vatNumber",
     CUSTOMER_TYPE = "input_customerType",

package/lib/domain/model/Constants.js

@@ -252,6 +252,7 @@ var UiInputKey;
     UiInputKey["SALESPERSON_ID"] = "input_salespersonId";
     UiInputKey["SELECTED_ORDER_ITEMS"] = "input_selectedOrderItems";
     UiInputKey["CANCELLED_ORDER_ITEM_LINE_NUMBER"] = "input_cancelledOrderItemLineNumber";
+    UiInputKey["FEE_DETAILS"] = "input_feeDetails";
     UiInputKey["SUBSCRIPTIONS"] = "input_subscriptions";
     UiInputKey["VAT_NUMBER"] = "input_vatNumber";
     UiInputKey["CUSTOMER_TYPE"] = "input_customerType";

package/lib/domain/model/configuration/IFeesConfig.d.ts

@@ -43,7 +43,8 @@ export declare enum DisplayRules {
 }
 export declare enum ReturnRule {
     WithItem = "WithItem",
-    NonReturnable = "NonReturnable"
+    NonReturnable = "NonReturnable",
+    OnOrderCancel = "OnOrderCancel"
 }
 export declare enum Taxability {
     FollowItemTax = "FollowItemTax"

package/lib/domain/model/configuration/IFeesConfig.js

@@ -19,6 +19,7 @@ var ReturnRule;
 (function (ReturnRule) {
     ReturnRule["WithItem"] = "WithItem";
     ReturnRule["NonReturnable"] = "NonReturnable";
+    ReturnRule["OnOrderCancel"] = "OnOrderCancel";
 })(ReturnRule = exports.ReturnRule || (exports.ReturnRule = {}));
 var Taxability;
 (function (Taxability) {

package/lib/domain/model/fee/IFee.d.ts

@@ -0,0 +1,13 @@
+import { Money } from "@aptos-scp/scp-component-business-core";
+import { FeeType } from "@aptos-scp/scp-types-commerce-transaction/lib/TransactionLine";
+export interface IFee {
+    unitAmount: Money;
+    extendedNetAmount: Money;
+    feeType: FeeType;
+    feeId?: string;
+    alternativeFeeId?: string;
+    description?: string;
+    shortDescription?: string;
+    longDescription?: string;
+    customFeeType?: FeeType;
+}

package/lib/domain/model/fee/IFee.js

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

package/lib/domain/model/fee/index.d.ts

@@ -1,5 +1,6 @@
 export * from "./FeeLine";
 export * from "./IFeeLine";
+export * from "./IFee";
 export * from "./VoidedFeeLineDecorator";
 export * from "./FeeLineChangeQuantityDecorator";
 export * from "./BaseFeeLineDecorator";

package/lib/domain/model/transaction/order/OrderReferenceLine.d.ts

@@ -1,9 +1,11 @@
 import { ITransactionLine, UiBusinessEvent } from "@aptos-scp/scp-component-store-selling-core";
 import { IOrderReferenceInfo } from "@aptos-scp/scp-types-commerce-transaction";
+import { CustomerOrder } from "@aptos-scp/scp-types-orders";
 import { BaseTransactionLine } from "../../BaseTransactionLine";
 export declare const ORDER_REFERENCE_LINE_TYPE: string;
 export declare class OrderReferenceLine extends BaseTransactionLine {
     private _orderReference;
+    private _order;
     /**
      * The create method is called by the transaction line factory to create an instance and initialize it from the
      * data collected during the qualification process.
@@ -19,7 +21,13 @@ export declare class OrderReferenceLine extends BaseTransactionLine {
     static createFromJsonObject(transactionLineJsonObj: any): OrderReferenceLine;
     get couldAffectPricing(): boolean;
     get orderReference(): IOrderReferenceInfo;
-    protected constructor(lineNumber: number, lineType: string, orderReference: IOrderReferenceInfo);
+    /**
+     * This is the order from OMS.
+     * It is provided here for reference within the app.
+     * It MUST NOT be included in the internal/postable transaction.
+     */
+    get order(): CustomerOrder;
+    protected constructor(lineNumber: number, lineType: string, orderReference: IOrderReferenceInfo, omsOrder: CustomerOrder);
     protected newTransactionLine(): BaseTransactionLine;
 }
 export declare function isOrderReferenceLine(transactionLine: ITransactionLine): transactionLine is OrderReferenceLine;

package/lib/domain/model/transaction/order/OrderReferenceLine.js

@@ -5,9 +5,10 @@ const Constants_1 = require("../../Constants");
 exports.ORDER_REFERENCE_LINE_TYPE = "OrderReference";
 class OrderReferenceLine extends BaseTransactionLine_1.BaseTransactionLine {
     // Since the constructor is only called from the create methods it is made protected to prevent use by others.
-    constructor(lineNumber, lineType, orderReference) {
+    constructor(lineNumber, lineType, orderReference, omsOrder) {
         super(lineNumber, lineType);
         this._orderReference = orderReference;
+        this._order = omsOrder;
     }
     /**
      * The create method is called by the transaction line factory to create an instance and initialize it from the
@@ -22,14 +23,16 @@ class OrderReferenceLine extends BaseTransactionLine_1.BaseTransactionLine {
      */
     static create(lineNumber, lineType, uiBusinessEvent, collectedData) {
         const orderReference = collectedData.get(Constants_1.CollectedDataKey.OrderReference);
-        const orderReferenceLine = new OrderReferenceLine(lineNumber, lineType, orderReference);
+        const order = collectedData.get(Constants_1.CollectedDataKey.Order);
+        const orderReferenceLine = new OrderReferenceLine(lineNumber, lineType, orderReference, order);
         return orderReferenceLine;
     }
     static createFromJsonObject(transactionLineJsonObj) {
         const lineNumber = BaseTransactionLine_1.BaseTransactionLine.lineNumberFromJsonObject(transactionLineJsonObj);
         const lineType = BaseTransactionLine_1.BaseTransactionLine.lineTypeFromJsonObject(transactionLineJsonObj);
         const orderReference = transactionLineJsonObj._orderReference;
-        const orderReferenceLine = new OrderReferenceLine(lineNumber, lineType, orderReference);
+        const order = transactionLineJsonObj._order;
+        const orderReferenceLine = new OrderReferenceLine(lineNumber, lineType, orderReference, order);
         return orderReferenceLine;
     }
     get couldAffectPricing() {
@@ -38,8 +41,16 @@ class OrderReferenceLine extends BaseTransactionLine_1.BaseTransactionLine {
     get orderReference() {
         return this._orderReference;
     }
+    /**
+     * This is the order from OMS.
+     * It is provided here for reference within the app.
+     * It MUST NOT be included in the internal/postable transaction.
+     */
+    get order() {
+        return this._order;
+    }
     newTransactionLine() {
-        return new OrderReferenceLine(this.lineNumber, this.lineType, this._orderReference);
+        return new OrderReferenceLine(this.lineNumber, this.lineType, this._orderReference, this._order);
     }
 }
 exports.OrderReferenceLine = OrderReferenceLine;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aptos-scp/scp-component-store-selling-features-domain-model",
-  "version": "1.0.12",
+  "version": "1.1.0",
   "description": "This component library provides the common components to handle the coordination of processing the business events from the UI.",
   "private": false,
   "license": "SEE LICENSE IN LICENSE.md",