@aptos-scp/scp-component-store-selling-features-domain-model 2.2.0 → 2.3.0

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

@@ -99,6 +99,7 @@ export declare enum UiInputKey {
     ASSIGN_CUSTOMER = "input_assignCustomer",
     ASSIGN_TO_TRANSACTION = "input_assignToTransaction",
     AUTHORIZATION_DEVICE_ID = "input_authorizationDeviceId",
+    AMOUNT_DUE = "input_amountDue",
     BUSINESS_DAY_DATE = "input_businessDayDate",
     SAME_AS_BILLTO = "input_sameAsBillTo",
     BILLING = "input_billing",
@@ -462,6 +463,7 @@ export declare enum CollectedDataKey {
     ApplyDiscountToBasePrice = "ApplyDiscountToBasePrice",
     AuthorizationDeviceId = "AuthorizationDeviceId",
     AutoApplied = "AutoApplied",
+    AmountDue = "AmountDue",
     BalanceInquiry = "BalanceInquiry",
     Billing = "Billing",
     SameAsBillTo = "SameAsBillTo",

package/lib/domain/model/Constants.js

@@ -101,6 +101,7 @@ var UiInputKey;
     UiInputKey["ASSIGN_CUSTOMER"] = "input_assignCustomer";
     UiInputKey["ASSIGN_TO_TRANSACTION"] = "input_assignToTransaction";
     UiInputKey["AUTHORIZATION_DEVICE_ID"] = "input_authorizationDeviceId";
+    UiInputKey["AMOUNT_DUE"] = "input_amountDue";
     UiInputKey["BUSINESS_DAY_DATE"] = "input_businessDayDate";
     UiInputKey["SAME_AS_BILLTO"] = "input_sameAsBillTo";
     UiInputKey["BILLING"] = "input_billing";
@@ -470,6 +471,7 @@ var CollectedDataKey;
     CollectedDataKey["ApplyDiscountToBasePrice"] = "ApplyDiscountToBasePrice";
     CollectedDataKey["AuthorizationDeviceId"] = "AuthorizationDeviceId";
     CollectedDataKey["AutoApplied"] = "AutoApplied";
+    CollectedDataKey["AmountDue"] = "AmountDue";
     CollectedDataKey["BalanceInquiry"] = "BalanceInquiry";
     CollectedDataKey["Billing"] = "Billing";
     CollectedDataKey["SameAsBillTo"] = "SameAsBillTo";

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

@@ -1,3 +1,4 @@
+import { Money } from "@aptos-scp/scp-component-business-core";
 import { DeviceIdentity, ITransaction, ITransactionLine, ITransactionLineFactory, IUser } from "@aptos-scp/scp-component-store-selling-core";
 import { IFiscalSignature } from "@aptos-scp/scp-types-commerce-transaction";
 import { ITransactionReferenceFormatter } from "../service";
@@ -27,6 +28,7 @@ export declare class TenderControlTransaction extends RetailTransaction {
     get fiscalTransactionNumber(): string;
     get fiscalSignature(): IFiscalSignature;
     get fiscalError(): IFiscalError;
+    get transactionChangeDue(): Money | undefined;
     findLineByLineNumber(lineNumber: number): ITransactionLine;
     toJSON(): object;
     protected newTransaction(): RetailTransaction;
@@ -34,3 +36,5 @@ export declare class TenderControlTransaction extends RetailTransaction {
     private generateTransactionReferenceNumber;
 }
 export declare const isTenderControlTransaction: (transaction: ITransaction) => transaction is TenderControlTransaction;
+export declare const isPayOnAccountTransaction: (transaction: ITransaction) => transaction is TenderControlTransaction;
+export declare const isCompletePayOnAccountTransaction: (transaction: ITransaction) => transaction is TenderControlTransaction;

package/lib/domain/model/TenderControlTransaction.js

@@ -1,6 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+const _ = require("lodash");
+const scp_component_business_core_1 = require("@aptos-scp/scp-component-business-core");
 const scp_component_store_selling_core_1 = require("@aptos-scp/scp-component-store-selling-core");
+const scp_types_commerce_devices_1 = require("@aptos-scp/scp-types-commerce-devices");
 const scp_types_commerce_transaction_1 = require("@aptos-scp/scp-types-commerce-transaction");
 const config_1 = require("../../config");
 const RetailTransaction_1 = require("./RetailTransaction");
@@ -102,6 +105,33 @@ class TenderControlTransaction extends RetailTransaction_1.RetailTransaction {
     get fiscalError() {
         return this._fiscalError;
     }
+    get transactionChangeDue() {
+        var _a, _b;
+        let changeDue;
+        // For Account payments there are 3 possible amounts but only 2 that need to be considered:
+        //   1. the amount the customer wants to pay on the account (requestedAmount in the TenderAuthStatus result line)
+        //     - this could be less than the tendered amount and/or more than the amount actually applied to the account for partial approvals (unlikely with cash)
+        //   2. the amount of Cash tendered (tenderAmount in the TenderExchangeInLine)
+        //     - amount tendered by the customer, could be more than the requested amount.
+        //     - amount approved by the processor, could be less than both the requested and tendered amounts
+        //   3. approved amount (tenderAmount in the TenderExchangeOutLine)
+        //     - amount approved by the processor, could be less than both the requested and tendered amounts
+        // To calculate the change due, we need the difference between the tendered amount #3 and the applied amount #2.
+        if (this.isAccountPaymentTransaction && !_.isEmpty(this.lines)) {
+            const tenderExchangeInLine = _.last(this.lines.filter((line) => line.lineType === tender_1.TENDER_EXCHANGE_IN_LINE_TYPE));
+            if (((_a = tenderExchangeInLine) === null || _a === void 0 ? void 0 : _a.tenderTypeName) === scp_types_commerce_devices_1.TenderType.Cash &&
+                tenderExchangeInLine.tenderAmount && ((_b = tenderExchangeInLine.transactionLineReference) === null || _b === void 0 ? void 0 : _b.lineNumber)) {
+                const tenderExchangeOutLine = _.last(this.lines.filter((line) => line.lineType === tender_1.TENDER_EXCHANGE_OUT_LINE_TYPE));
+                if (tenderExchangeOutLine) {
+                    changeDue = tenderExchangeInLine.tenderAmount.minus(tenderExchangeOutLine.tenderAmount);
+                }
+            }
+        }
+        if (!changeDue && this._accountingCurrency) {
+            changeDue = new scp_component_business_core_1.Money(0, this._accountingCurrency);
+        }
+        return changeDue;
+    }
     findLineByLineNumber(lineNumber) {
         if (lineNumber && super.lines.length > 0) {
             return super.findLineByLineNumber(lineNumber);
@@ -161,4 +191,10 @@ exports.isTenderControlTransaction = (transaction) => {
     return (transaction instanceof TenderControlTransaction ||
         ((_a = transaction) === null || _a === void 0 ? void 0 : _a.transactionType) === exports.TENDER_CONTROL_TRANSACTION_TYPE);
 };
+exports.isPayOnAccountTransaction = (transaction) => {
+    return exports.isTenderControlTransaction(transaction) && transaction.isAccountPaymentTransaction;
+};
+exports.isCompletePayOnAccountTransaction = (transaction) => {
+    return exports.isTenderControlTransaction(transaction) && transaction.isCompleteAccountPaymentTransaction;
+};
 //# sourceMappingURL=TenderControlTransaction.js.map

package/lib/domain/model/tender/TenderAuthorizationStatusLine.d.ts

@@ -10,6 +10,7 @@ export declare const TENDER_AUTH_STATUS_LINE_TYPE: string;
 export declare class TenderAuthorizationStatusLine extends BaseTransactionLine implements ITransactionLineReference {
     private _status;
     private _tenderAmount;
+    private _amountDue;
     private _authResponse;
     private _failureReasonCode;
     private _authorizationDeviceId;
@@ -40,6 +41,7 @@ export declare class TenderAuthorizationStatusLine extends BaseTransactionLine i
     get couldAffectPricing(): boolean;
     get status(): TenderAuthorizationStatus;
     get tenderAmount(): Money;
+    get amountDue(): Money;
     get authResponse(): IAuthorizationResponse;
     get failureReasonCode(): TenderAuthFailureReasonCode;
     get authorizationDeviceId(): string;
@@ -67,7 +69,7 @@ export declare class TenderAuthorizationStatusLine extends BaseTransactionLine i
     get isTenderAuthorizationFallback(): boolean;
     get payByLinkCustomer(): IPayByLinkCustomer;
     get storeLanguage(): string;
-    protected constructor(lineNumber: number, lineType: string, status: TenderAuthorizationStatus, tenderAmount: Money, authResponse: IAuthorizationResponse, failureReasonCode: TenderAuthFailureReasonCode, authorizationDeviceId: string, transactionLineReference: ITransactionLineReferenceType, forcedAuthorizationApproval: boolean, cardNumber: string, giftCardPin: string, valueCertificateNumber: string, offlineAuthorizationCode: string, offlineApprovalCode: string, tenderAuthCategory: TenderAuthCategory, tenderType: TenderType, tenderTypeName: string, entryMethod: EntryMethod, tenderReversalFailed: boolean, originalTenderLineReferences: IOriginalTransactionRefundReference[], actionType: ActionType, mappedRefundTenderTypeName: string, mappedRefundCardTypeName: string, excludedRefundCardTypeNames: string[], subType: TenderSubType, isChangeProcessing: boolean, isTenderAuthorizationFallback: boolean, payByLinkCustomer: IPayByLinkCustomer, storeLanguage: string);
+    protected constructor(lineNumber: number, lineType: string, status: TenderAuthorizationStatus, tenderAmount: Money, amountDue: Money, authResponse: IAuthorizationResponse, failureReasonCode: TenderAuthFailureReasonCode, authorizationDeviceId: string, transactionLineReference: ITransactionLineReferenceType, forcedAuthorizationApproval: boolean, cardNumber: string, giftCardPin: string, valueCertificateNumber: string, offlineAuthorizationCode: string, offlineApprovalCode: string, tenderAuthCategory: TenderAuthCategory, tenderType: TenderType, tenderTypeName: string, entryMethod: EntryMethod, tenderReversalFailed: boolean, originalTenderLineReferences: IOriginalTransactionRefundReference[], actionType: ActionType, mappedRefundTenderTypeName: string, mappedRefundCardTypeName: string, excludedRefundCardTypeNames: string[], subType: TenderSubType, isChangeProcessing: boolean, isTenderAuthorizationFallback: boolean, payByLinkCustomer: IPayByLinkCustomer, storeLanguage: string);
     protected newTransactionLine(): TenderAuthorizationStatusLine;
 }
 export declare function isTenderAuthorizationStatusLine(transactionLine: ITransactionLine): transactionLine is TenderAuthorizationStatusLine;

package/lib/domain/model/tender/TenderAuthorizationStatusLine.js

@@ -9,10 +9,11 @@ const Constants_1 = require("../Constants");
 const TenderType_1 = require("../TenderType");
 exports.TENDER_AUTH_STATUS_LINE_TYPE = "TenderAuthorizationStatus";
 class TenderAuthorizationStatusLine extends BaseTransactionLine_1.BaseTransactionLine {
-    constructor(lineNumber, lineType, status, tenderAmount, authResponse, failureReasonCode, authorizationDeviceId, transactionLineReference, forcedAuthorizationApproval, cardNumber, giftCardPin, valueCertificateNumber, offlineAuthorizationCode, offlineApprovalCode, tenderAuthCategory, tenderType, tenderTypeName, entryMethod, tenderReversalFailed, originalTenderLineReferences, actionType, mappedRefundTenderTypeName, mappedRefundCardTypeName, excludedRefundCardTypeNames, subType, isChangeProcessing, isTenderAuthorizationFallback, payByLinkCustomer, storeLanguage) {
+    constructor(lineNumber, lineType, status, tenderAmount, amountDue, authResponse, failureReasonCode, authorizationDeviceId, transactionLineReference, forcedAuthorizationApproval, cardNumber, giftCardPin, valueCertificateNumber, offlineAuthorizationCode, offlineApprovalCode, tenderAuthCategory, tenderType, tenderTypeName, entryMethod, tenderReversalFailed, originalTenderLineReferences, actionType, mappedRefundTenderTypeName, mappedRefundCardTypeName, excludedRefundCardTypeNames, subType, isChangeProcessing, isTenderAuthorizationFallback, payByLinkCustomer, storeLanguage) {
         super(lineNumber, lineType);
         this._status = status;
         this._tenderAmount = tenderAmount;
+        this._amountDue = amountDue;
         this._authResponse = authResponse;
         this._failureReasonCode = failureReasonCode;
         this._authorizationDeviceId = authorizationDeviceId;
@@ -43,6 +44,7 @@ class TenderAuthorizationStatusLine extends BaseTransactionLine_1.BaseTransactio
         var _a;
         const status = collectedData.get(Constants_1.CollectedDataKey.TenderAuthorizationStatus);
         const tenderAmount = collectedData.get(Constants_1.CollectedDataKey.TenderAmount);
+        const amountDue = collectedData.get(Constants_1.CollectedDataKey.AmountDue);
         const authResponse = collectedData.get(Constants_1.CollectedDataKey.TenderAuthResponse);
         const failureReasonCode = collectedData.get(Constants_1.CollectedDataKey.TenderAuthFailureReasonCode);
         const authorizationDeviceId = collectedData.get(Constants_1.CollectedDataKey.AuthorizationDeviceId);
@@ -71,7 +73,7 @@ class TenderAuthorizationStatusLine extends BaseTransactionLine_1.BaseTransactio
         const isTenderAuthorizationFallback = collectedData.get(Constants_1.CollectedDataKey.IsTenderFallback);
         const payByLinkCustomer = collectedData.get(Constants_1.CollectedDataKey.PayByLinkCustomer);
         const storeLanguage = collectedData.get(Constants_1.CollectedDataKey.PrimaryLanguage);
-        return new TenderAuthorizationStatusLine(lineNumber, lineType, status, tenderAmount, authResponse, failureReasonCode, authorizationDeviceId, transactionLineReference, forcedAuthorizationApproval, cardNumber, giftCardPin, valueCertificateNumber, offlineAuthorizationCode, offlineApprovalCode, tenderAuthCategory, tenderType, tenderTypeName, entryMethod, tenderReversalFailed, originalTenderLineReferences, actionType, mappedRefundTenderTypeName, mappedRefundCardTypeNames, excludedRefundCardTypeNames, subType, isChangeProcessing, isTenderAuthorizationFallback, payByLinkCustomer, storeLanguage);
+        return new TenderAuthorizationStatusLine(lineNumber, lineType, status, tenderAmount, amountDue, authResponse, failureReasonCode, authorizationDeviceId, transactionLineReference, forcedAuthorizationApproval, cardNumber, giftCardPin, valueCertificateNumber, offlineAuthorizationCode, offlineApprovalCode, tenderAuthCategory, tenderType, tenderTypeName, entryMethod, tenderReversalFailed, originalTenderLineReferences, actionType, mappedRefundTenderTypeName, mappedRefundCardTypeNames, excludedRefundCardTypeNames, subType, isChangeProcessing, isTenderAuthorizationFallback, payByLinkCustomer, storeLanguage);
     }
     static createFromJsonObject(transactionLineJsonObj) {
         const lineNumber = BaseTransactionLine_1.BaseTransactionLine.lineNumberFromJsonObject(transactionLineJsonObj);
@@ -101,6 +103,10 @@ class TenderAuthorizationStatusLine extends BaseTransactionLine_1.BaseTransactio
         if (transactionLineJsonObj._tenderAmount) {
             tenderAmount = new scp_component_business_core_1.Money(transactionLineJsonObj._tenderAmount);
         }
+        let amountDue;
+        if (transactionLineJsonObj._amountDue) {
+            amountDue = new scp_component_business_core_1.Money(transactionLineJsonObj._amountDue);
+        }
         const authResponse = transactionLineJsonObj._authResponse;
         if (transactionLineJsonObj._authResponse) {
             if (transactionLineJsonObj._authResponse.balance) {
@@ -117,7 +123,7 @@ class TenderAuthorizationStatusLine extends BaseTransactionLine_1.BaseTransactio
         const failureReasonCode = scp_types_commerce_transaction_1.TenderAuthFailureReasonCode[transactionLineJsonObj._failureReasonCode];
         const payByLinkCustomer = transactionLineJsonObj._payByLinkCustomer;
         const storeLanguage = transactionLineJsonObj._storeLanguage;
-        const tenderAuthorizationStatusLine = new TenderAuthorizationStatusLine(lineNumber, lineType, status, tenderAmount, authResponse, failureReasonCode, authorizationDeviceId, transactionLineReference, forcedAuthorizationApproval, cardNumber, giftCardPin, valueCertificateNumber, offlineAuthorizationCode, offlineApprovalCode, tenderAuthCategory, tenderType, tenderTypeName, entryMethod, tenderReversalFailed, originalTenderLineReferences, actionType, mappedRefundTenderTypeName, mappedRefundCardTypeName, excludedRefundCardTypeNames, subType, isChangeProcessing, isTenderAuthorizationFallback, payByLinkCustomer, storeLanguage);
+        const tenderAuthorizationStatusLine = new TenderAuthorizationStatusLine(lineNumber, lineType, status, tenderAmount, amountDue, authResponse, failureReasonCode, authorizationDeviceId, transactionLineReference, forcedAuthorizationApproval, cardNumber, giftCardPin, valueCertificateNumber, offlineAuthorizationCode, offlineApprovalCode, tenderAuthCategory, tenderType, tenderTypeName, entryMethod, tenderReversalFailed, originalTenderLineReferences, actionType, mappedRefundTenderTypeName, mappedRefundCardTypeName, excludedRefundCardTypeNames, subType, isChangeProcessing, isTenderAuthorizationFallback, payByLinkCustomer, storeLanguage);
         tenderAuthorizationStatusLine.loadFromJsonObject(transactionLineJsonObj);
         return tenderAuthorizationStatusLine;
     }
@@ -130,6 +136,9 @@ class TenderAuthorizationStatusLine extends BaseTransactionLine_1.BaseTransactio
     get tenderAmount() {
         return this._tenderAmount;
     }
+    get amountDue() {
+        return this._amountDue;
+    }
     get authResponse() {
         return this._authResponse;
     }
@@ -212,7 +221,7 @@ class TenderAuthorizationStatusLine extends BaseTransactionLine_1.BaseTransactio
         return this._storeLanguage;
     }
     newTransactionLine() {
-        return new TenderAuthorizationStatusLine(this.lineNumber, this.lineType, this.status, this.tenderAmount, this.authResponse, this.failureReasonCode, this.authorizationDeviceId, this.transactionLineReference, this.forcedAuthorizationApproval, this.cardNumber, this.giftCardPin, this._valueCertificateNumber, this.offlineAuthorizationCode, this.offlineApprovalCode, this.tenderAuthCategory, this._tenderType, this.tenderTypeName, this._entryMethod, this._tenderReversalFailed, this._originalTenderLineReferences, this._actionType, this._mappedRefundTenderTypeName, this._mappedRefundCardTypeName, this._excludedRefundCardTypeNames, this._subType, this._isChangeProcessing, this._isTenderAuthorizationFallback, this._payByLinkCustomer, this._storeLanguage);
+        return new TenderAuthorizationStatusLine(this.lineNumber, this.lineType, this.status, this.tenderAmount, this.amountDue, this.authResponse, this.failureReasonCode, this.authorizationDeviceId, this.transactionLineReference, this.forcedAuthorizationApproval, this.cardNumber, this.giftCardPin, this._valueCertificateNumber, this.offlineAuthorizationCode, this.offlineApprovalCode, this.tenderAuthCategory, this._tenderType, this.tenderTypeName, this._entryMethod, this._tenderReversalFailed, this._originalTenderLineReferences, this._actionType, this._mappedRefundTenderTypeName, this._mappedRefundCardTypeName, this._excludedRefundCardTypeNames, this._subType, this._isChangeProcessing, this._isTenderAuthorizationFallback, this._payByLinkCustomer, this._storeLanguage);
     }
 }
 exports.TenderAuthorizationStatusLine = TenderAuthorizationStatusLine;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aptos-scp/scp-component-store-selling-features-domain-model",
-  "version": "2.2.0",
+  "version": "2.3.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",
@@ -55,7 +55,7 @@
     "@aptos-scp/scp-component-business-core": "^1.12.7",
     "@aptos-scp/scp-component-logging": "^2.1.16",
     "@aptos-scp/scp-component-pricing": "^7.62.0",
-    "@aptos-scp/scp-component-store-items": "^1.20.0",
+    "@aptos-scp/scp-component-store-items": "^1.21.0",
     "@aptos-scp/scp-component-store-selling-core": "^18.9.3",
     "@aptos-scp/scp-component-taxation": "^5.28.0",
     "@aptos-scp/scp-component-user": "^1.4.0",