@aptos-scp/scp-component-store-selling-features-domain-model 1.10.1 → 1.10.3

package/lib/domain/UIBusinessEventTypes.d.ts

@@ -282,7 +282,7 @@ export declare const TAX_REFUND_VOID_EVENT: string;
 export declare const START_TAX_REFUND_DEFERRED_EVENT: string;
 export declare const TAX_REFUND_DEFERRED_EVENT: string;
 export declare const START_OPEN_CASH_DRAWER_EVENT: string;
-export declare const START_OPEN_TENDER_EXCHANGE_CASH_DRAWER_EVENT: string;
+export declare const TENDER_EXCHANGE_VALIDATE_CASH_DRAWER_EVENT: string;
 export declare const CAPTURE_LOTTERY_CODE_EVENT: string;
 export declare const APPLY_ITEM_SUBSCRIPTION_EVENT: string;
 export declare const ADD_ITEM_SUBSCRIPTION_EVENT: string;

package/lib/domain/UIBusinessEventTypes.js

@@ -289,7 +289,7 @@ exports.TAX_REFUND_VOID_EVENT = "TaxRefundVoid";
 exports.START_TAX_REFUND_DEFERRED_EVENT = "StartTaxRefundDeferred";
 exports.TAX_REFUND_DEFERRED_EVENT = "TaxRefundDeferred";
 exports.START_OPEN_CASH_DRAWER_EVENT = "StartOpenCashDrawer";
-exports.START_OPEN_TENDER_EXCHANGE_CASH_DRAWER_EVENT = "StartOpenTenderExchangeCashDrawer";
+exports.TENDER_EXCHANGE_VALIDATE_CASH_DRAWER_EVENT = "TenderExchangeValidateCashDrawer";
 exports.CAPTURE_LOTTERY_CODE_EVENT = "CaptureLotteryCode";
 exports.APPLY_ITEM_SUBSCRIPTION_EVENT = "ApplyItemSubscription";
 exports.ADD_ITEM_SUBSCRIPTION_EVENT = "AddItemSubscription";

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

@@ -496,8 +496,12 @@ export declare enum CollectedDataKey {
     FeeDepartmentGroup = "feeDepartmentGroup",
     FeeDescription = "feeDescription",
     FeeExternalId = "feeExternalId",
+    FeeExtendedAmount = "feeExtendedAmount",
+    FeeExtendedAmountExcludingTax = "FeeExtendedAmountExcludingTax",
+    FeeExtendedAmountIncludingTax = "FeeExtendedAmountIncludingTax",
     FeeId = "feeId",
     FeeLongDescription = "feeLongDescription",
+    FeeSublines = "FeeSublines",
     FeeQuantity = "feeQuantity",
     PrevFeeQuantity = "prevFeeQuantity",
     FeeLineReference = "feeLineReference",
@@ -680,6 +684,7 @@ export declare enum CollectedDataKey {
     TaxExemptType = "taxExemptType",
     TaxGroupId = "taxGroupId",
     TaxOverrideType = "taxOverrideType",
+    TaxByAuthority = "taxByAuthority",
     TenderAdjustmentType = "TenderAdjustmentType",
     TenderAmount = "TenderAmount",
     TenderAmountOriginal = "TenderAmountOriginal",
@@ -896,7 +901,8 @@ export declare enum CollectedDataKey {
     MembershipTypeName = "membershipTypeName",
     MembershipTypeDescription = "membershipTypeDescription",
     IsPermanentMembershipDiscount = "isPermanentMembershipDiscount",
-    TerminalForceClosed = "TerminalForceClosed"
+    TerminalForceClosed = "TerminalForceClosed",
+    TotalLineTax = "totalLineTax"
 }
 export declare enum ItemLookupType {
     ProductInquiryDetail = "ProductInquiryDetail",
@@ -923,6 +929,7 @@ export declare const TRANSACTION_RESUMING_ON_STARTUP_EVENT: string;
 export declare const STORED_VALUE_REVERSAL_COMPLETED_EVENT_TYPE: string;
 export declare const STORED_VALUE_CERTIFICATE_REVERSAL_COMPLETED_EVENT_TYPE: string;
 export declare const TENDER_CHANGE_CANCEL_EVENT_TYPE: string;
+export declare const CASH_DRAWER_SELECTED_EVENT: string;
 export declare const CASH_DRAWER_OPEN_REQUESTED_EVENT: string;
 export interface ICashDrawerEventData {
     cashDrawerKey: string;

package/lib/domain/model/Constants.js

@@ -505,8 +505,12 @@ var CollectedDataKey;
     CollectedDataKey["FeeDepartmentGroup"] = "feeDepartmentGroup";
     CollectedDataKey["FeeDescription"] = "feeDescription";
     CollectedDataKey["FeeExternalId"] = "feeExternalId";
+    CollectedDataKey["FeeExtendedAmount"] = "feeExtendedAmount";
+    CollectedDataKey["FeeExtendedAmountExcludingTax"] = "FeeExtendedAmountExcludingTax";
+    CollectedDataKey["FeeExtendedAmountIncludingTax"] = "FeeExtendedAmountIncludingTax";
     CollectedDataKey["FeeId"] = "feeId";
     CollectedDataKey["FeeLongDescription"] = "feeLongDescription";
+    CollectedDataKey["FeeSublines"] = "FeeSublines";
     CollectedDataKey["FeeQuantity"] = "feeQuantity";
     CollectedDataKey["PrevFeeQuantity"] = "prevFeeQuantity";
     CollectedDataKey["FeeLineReference"] = "feeLineReference";
@@ -689,6 +693,7 @@ var CollectedDataKey;
     CollectedDataKey["TaxExemptType"] = "taxExemptType";
     CollectedDataKey["TaxGroupId"] = "taxGroupId";
     CollectedDataKey["TaxOverrideType"] = "taxOverrideType";
+    CollectedDataKey["TaxByAuthority"] = "taxByAuthority";
     CollectedDataKey["TenderAdjustmentType"] = "TenderAdjustmentType";
     CollectedDataKey["TenderAmount"] = "TenderAmount";
     CollectedDataKey["TenderAmountOriginal"] = "TenderAmountOriginal";
@@ -906,6 +911,7 @@ var CollectedDataKey;
     CollectedDataKey["MembershipTypeDescription"] = "membershipTypeDescription";
     CollectedDataKey["IsPermanentMembershipDiscount"] = "isPermanentMembershipDiscount";
     CollectedDataKey["TerminalForceClosed"] = "TerminalForceClosed";
+    CollectedDataKey["TotalLineTax"] = "totalLineTax";
 })(CollectedDataKey = exports.CollectedDataKey || (exports.CollectedDataKey = {}));
 var ItemLookupType;
 (function (ItemLookupType) {
@@ -936,6 +942,7 @@ exports.TRANSACTION_RESUMING_ON_STARTUP_EVENT = "Transaction.ResumingOnStartup";
 exports.STORED_VALUE_REVERSAL_COMPLETED_EVENT_TYPE = "StoredValue.ReversalCompleted";
 exports.STORED_VALUE_CERTIFICATE_REVERSAL_COMPLETED_EVENT_TYPE = "StoredValueCertificate.ReversalCompleted";
 exports.TENDER_CHANGE_CANCEL_EVENT_TYPE = "TenderChange.Cancel";
+exports.CASH_DRAWER_SELECTED_EVENT = "CashDrawer.Selected";
 exports.CASH_DRAWER_OPEN_REQUESTED_EVENT = "CashDrawer.OpenRequested";
 exports.ITEM_QUANTITY_CHANGE_EVENT = "Item.QuantityChange";
 exports.CANCEL_TRANSACTION_ITEM_EVENT = "Item.CancelTransaction";

package/lib/domain/model/cashDrawer/CashDrawerSession.d.ts

@@ -39,6 +39,7 @@ export declare class CashDrawerSession implements IState {
     recordIsForGiftCertificate(giftCertState: GiftCertificateState): CashDrawerSession;
     confirmingCashDrawerClosed(cashDrawerKey: string, lineNumber: number): CashDrawerSession;
     skipConfirmCashDrawerClosed(): CashDrawerSession;
+    selectCashDrawer(cashDrawerKey: string, inputSource: string): CashDrawerSession;
     openingCashDrawer(cashDrawerKey: string, inputSource: string, lineNumber: number): CashDrawerSession;
     promptUserInteractionToSelectCashDrawer(): CashDrawerSession;
     recordStatusCode(incomingStatusCode: CashDrawerStatusCode): CashDrawerSession;

package/lib/domain/model/cashDrawer/CashDrawerSession.js

@@ -85,6 +85,10 @@ class CashDrawerSession {
         logger.traceEntry("checkDrawerClosedRequestSent");
         return new CashDrawerSession(CashDrawerSessionState.Closed, this._cashDrawerStatusCode, this.cashDrawerKey, this._expectedAmounts, this._inputSource, undefined, true, this._giftCertificateState, this._expectedFloatAmounts);
     }
+    selectCashDrawer(cashDrawerKey, inputSource) {
+        logger.traceEntry("selectCashDrawer");
+        return new CashDrawerSession(CashDrawerSessionState.Closed, this._cashDrawerStatusCode, cashDrawerKey, this._expectedAmounts, inputSource, undefined, this._skipConfirmClose, this._giftCertificateState, this._expectedFloatAmounts);
+    }
     openingCashDrawer(cashDrawerKey, inputSource, lineNumber) {
         logger.traceEntry("openCashDrawerRequestSent");
         return new CashDrawerSession(CashDrawerSessionState.WaitingForOpenDrawerResponse, this._cashDrawerStatusCode, cashDrawerKey, this._expectedAmounts, inputSource, lineNumber, this._skipConfirmClose, this._giftCertificateState, this._expectedFloatAmounts);

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

@@ -57,6 +57,7 @@ export declare class FeeLine extends BaseTransactionLine implements IFeeLine, IC
     private _sublineIndexFromReturnCanonicalTransaction?;
     private _lineNumberFromReturnTransaction?;
     private _originalTaxOverride?;
+    static isPickupFulfilmentTransaction?: boolean;
     /**
      * 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.
@@ -142,6 +143,9 @@ export declare class FeeLine extends BaseTransactionLine implements IFeeLine, IC
     static feeTypeFromJsonObject(transactionLineJsonObj: any): FeeType;
     static feeTypeFromCollectedData(collectedData: Readonly<Map<string, any>>): FeeType;
     static taxGroupIdFromJsonObject(transactionLineJsonObj: any): string;
+    static getExtendedAmountFromCollectedData(collectedData: Readonly<Map<string, any>>): Money;
+    static getExtendedAmountExcludingTaxFromCollectedData(collectedData: Readonly<Map<string, any>>): Money;
+    static getExtendedAmountIncludingTaxFromCollectedData(collectedData: Readonly<Map<string, any>>): Money;
     copyLineWithNewLineNumber(newLineNumber: number): FeeLine;
     /**
      * This method should be implemented only in decorator and not in the Fee line.

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

@@ -5,6 +5,7 @@ const scp_types_commerce_transaction_1 = require("@aptos-scp/scp-types-commerce-
 const BaseTransactionLine_1 = require("../BaseTransactionLine");
 const Constants_1 = require("../Constants");
 const ItemLine_1 = require("../item/ItemLine");
+const UIBusinessEventTypes_1 = require("../../UIBusinessEventTypes");
 exports.TRANSACTION_FEE_LINE_TYPE = "TransactionFee";
 exports.TRANSACTION_FEE_REFUND_LINE_TYPE = "TransactionFeeRefund";
 exports.ITEM_FEE_LINE_TYPE = "ItemFee";
@@ -47,8 +48,12 @@ class FeeLine extends BaseTransactionLine_1.BaseTransactionLine {
      * @return {FeeLine}
      */
     static create(lineNumber, lineType, uiBusinessEvent, collectedData) {
+        this.isPickupFulfilmentTransaction = uiBusinessEvent.type === UIBusinessEventTypes_1.ORDER_ITEM_PICKUP_EVENT;
+        const extendedAmount = this.getExtendedAmountFromCollectedData(collectedData);
+        const extendedAmountExcludingTax = this.getExtendedAmountExcludingTaxFromCollectedData(collectedData);
+        const extendedAmountIncludingTax = this.getExtendedAmountIncludingTaxFromCollectedData(collectedData);
         const feeType = this.feeTypeFromCollectedData(collectedData);
-        let feeLine = new FeeLine(lineNumber, lineType, feeType);
+        let feeLine = new FeeLine(lineNumber, lineType, feeType, extendedAmount, extendedAmountExcludingTax, extendedAmountIncludingTax);
         feeLine.loadFromCollectedData(collectedData);
         return feeLine;
     }
@@ -88,10 +93,16 @@ class FeeLine extends BaseTransactionLine_1.BaseTransactionLine {
         return this._feeId;
     }
     get couldAffectPricing() {
+        if (FeeLine.isPickupFulfilmentTransaction) {
+            return false;
+        }
         return true;
     }
     get couldAffectTaxation() {
-        if (this._sublineFromOriginalItemFee !== undefined) {
+        if (FeeLine.isPickupFulfilmentTransaction) {
+            return false;
+        }
+        else if (this._sublineFromOriginalItemFee !== undefined) {
             return true;
         }
         return this.couldAffectPricing;
@@ -248,6 +259,26 @@ class FeeLine extends BaseTransactionLine_1.BaseTransactionLine {
     static taxGroupIdFromJsonObject(transactionLineJsonObj) {
         return transactionLineJsonObj._taxGroupId;
     }
+    static getExtendedAmountFromCollectedData(collectedData) {
+        if (collectedData.has(Constants_1.CollectedDataKey.FeeExtendedAmount) && FeeLine.isPickupFulfilmentTransaction) {
+            return collectedData.get(Constants_1.CollectedDataKey.FeeExtendedAmount);
+        }
+        undefined;
+    }
+    static getExtendedAmountExcludingTaxFromCollectedData(collectedData) {
+        if (collectedData.has(Constants_1.CollectedDataKey.FeeExtendedAmountExcludingTax) &&
+            FeeLine.isPickupFulfilmentTransaction) {
+            return collectedData.get(Constants_1.CollectedDataKey.FeeExtendedAmountExcludingTax);
+        }
+        undefined;
+    }
+    static getExtendedAmountIncludingTaxFromCollectedData(collectedData) {
+        if (collectedData.has(Constants_1.CollectedDataKey.FeeExtendedAmountIncludingTax) &&
+            FeeLine.isPickupFulfilmentTransaction) {
+            return collectedData.get(Constants_1.CollectedDataKey.FeeExtendedAmountIncludingTax);
+        }
+        undefined;
+    }
     copyLineWithNewLineNumber(newLineNumber) {
         const clonedItem = this.clone();
         return clonedItem.updateLineNumber(newLineNumber);
@@ -257,6 +288,11 @@ class FeeLine extends BaseTransactionLine_1.BaseTransactionLine {
      * @param sublines fee's sublines
      */
     setSublines(sublines) {
+        if (FeeLine.isPickupFulfilmentTransaction) {
+            const newLine = this.clone();
+            newLine._sublines = sublines;
+            return newLine;
+        }
         throw new Error("Method not implemented.");
     }
     setItemLineReference(itemLineReference) {
@@ -554,6 +590,17 @@ class FeeLine extends BaseTransactionLine_1.BaseTransactionLine {
         if (collectedData.has(Constants_1.CollectedDataKey.LineNumberFromReturnTransaction)) {
             this._lineNumberFromReturnTransaction = collectedData.get(Constants_1.CollectedDataKey.LineNumberFromReturnTransaction);
         }
+        if (FeeLine.isPickupFulfilmentTransaction) {
+            if (!this._totalLineTax && collectedData.has(Constants_1.CollectedDataKey.TotalLineTax)) {
+                this._totalLineTax = collectedData.get(Constants_1.CollectedDataKey.TotalLineTax);
+            }
+            if (!this._quantity && collectedData.has(Constants_1.CollectedDataKey.FeeQuantity)) {
+                this._quantity = collectedData.get(Constants_1.CollectedDataKey.FeeQuantity);
+            }
+            if (!this.taxByAuthority && collectedData.has(Constants_1.CollectedDataKey.TaxByAuthority)) {
+                this._taxByAuthority = collectedData.get(Constants_1.CollectedDataKey.TaxByAuthority);
+            }
+        }
         if (collectedData.has(Constants_1.CollectedDataKey.OriginalTaxOverride)) {
             const originalTaxOverride = collectedData.get(Constants_1.CollectedDataKey.OriginalTaxOverride);
             if (originalTaxOverride) {
@@ -565,8 +612,11 @@ class FeeLine extends BaseTransactionLine_1.BaseTransactionLine {
         if (collectedData.has(Constants_1.CollectedDataKey.SublineIndexFromReturnItem)) {
             this._sublineIndexFromReturnCanonicalTransaction = collectedData.get(Constants_1.CollectedDataKey.SublineIndexFromReturnItem);
         }
-        // initial value for sublines, will be replaced when taxes are calculated
-        if (this._itemLineReference && this._quantity) {
+        if (collectedData.has(Constants_1.CollectedDataKey.FeeSublines) && FeeLine.isPickupFulfilmentTransaction) {
+            this._sublines = collectedData.get(Constants_1.CollectedDataKey.FeeSublines);
+        }
+        else if (this._itemLineReference && this._quantity) {
+            // initial value for sublines, will be replaced when taxes are calculated
             this._sublines = [
                 {
                     quantity: this._quantity.amount,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aptos-scp/scp-component-store-selling-features-domain-model",
-  "version": "1.10.1",
+  "version": "1.10.3",
   "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",