@aptos-scp/scp-component-store-selling-features-domain-model 1.22.0 → 1.23.0

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

@@ -96,7 +96,11 @@ export declare class TenderType {
     static getActiveSuggestedRefundTenders(container: Container, accountingCurrency: string, withMappedTender?: boolean): TenderType[];
     static getActiveConfiguredTenderGroups(container: Container, accountingCurrency: string, activeTenders: TenderType[]): ITenderGroup[];
     static getActiveRefundConfiguredTenderGroups(container: Container, accountingCurrency: string, withTransaction: boolean, activeTenders: TenderType[], originalTransactionsDetails: IOriginalTransactionDetails[], withOfflineTransaction: boolean): ITenderGroup[];
-    static getOriginalRefundableTenders(container: Container, accountingCurrency: string, originalTransactionsDetails: IOriginalTransactionDetails[], balanceDue: Money, itemTypes?: string[], orderTypes?: string[], isRefund?: boolean, productAttributeTypes?: string[]): IOriginalTender[];
+    static tenderIsCreditOrDebit(tenderType: any): boolean;
+    static getWithoutTransactionTotal(displayInfo: any, accountingCurrency: string): Money;
+    static getWithTransactionTotal(displayInfo: any, accountingCurrency: string): Money;
+    static getWithOfflineTransactionTotal(displayInfo: any, accountingCurrency: string): Money;
+    static getOriginalRefundableTenders(container: Container, accountingCurrency: string, originalTransactionsDetails: IOriginalTransactionDetails[], balanceDue: Money, itemTypes?: string[], orderTypes?: string[], isRefund?: boolean, productAttributeTypes?: string[], displayInfo?: any): IOriginalTender[];
     static getDefaultConfiguredTenderType(container: Container, accountingCurrency: string): TenderType;
     static createFromJsonObject(tenderTypeFromJson: any): TenderType;
     constructor(id: string, tenderName: string, tenderTypeName: string, tenderAuthCategory: TenderAuthCategory, additionalTenderAuthCategories: TenderAuthCategory[], cardType: CardType, signatureCapturePolicy: TenderSignatureCapturePolicy, signatureCaptureFloorLimit: Money, printDeclineTenderDetails: boolean, printDeclineTenderReceipt: boolean, printStoreTenderReceipt: boolean, allowPostVoid: boolean, allowCallForAuthorization: boolean, allowRefund: AllowRefund[], pluralTenderName?: string, fiscalCode?: string, fiscalType?: string, tenderLabel?: ILabel, actions?: ITenderActions, overTenderRule?: OverTenderRule, subType?: TenderSubType, customCardType?: string, promptOnPartialApproval?: string, pinRules?: IPinRules, subscriptionEntryMethods?: EntryMethod[], changeBehavior?: string, isForeignTender?: boolean, currencyCode?: string, eligibleForTaxLottery?: boolean, printVoidTenderDetails?: boolean, printVoidTenderReceipt?: boolean, cashoutThreshold?: Money);

package/lib/domain/model/TenderType.js

@@ -83,40 +83,103 @@ class TenderType {
     static getActiveRefundConfiguredTenderGroups(container, accountingCurrency, withTransaction, activeTenders, originalTransactionsDetails, withOfflineTransaction) {
         return TenderType.getActiveTenderGroupings(container, accountingCurrency, true, withTransaction, activeTenders, originalTransactionsDetails, withOfflineTransaction);
     }
-    static getOriginalRefundableTenders(container, accountingCurrency, originalTransactionsDetails, balanceDue, itemTypes, orderTypes, isRefund, productAttributeTypes) {
+    static tenderIsCreditOrDebit(tenderType) {
+        var _a, _b;
+        return (((_a = tenderType) === null || _a === void 0 ? void 0 : _a.tenderType) === scp_types_commerce_devices_1.TenderType.Credit || ((_b = tenderType) === null || _b === void 0 ? void 0 : _b.tenderTyp) === scp_types_commerce_devices_1.TenderType.Debit);
+    }
+    static getWithoutTransactionTotal(displayInfo, accountingCurrency) {
+        var _a, _b;
+        let withoutTransactionTotal = new scp_component_business_core_1.Money(0, accountingCurrency);
+        (_b = (_a = displayInfo) === null || _a === void 0 ? void 0 : _a.itemDisplayLines) === null || _b === void 0 ? void 0 : _b.forEach((itemDisplayLine) => {
+            if ((itemDisplayLine.lineType === scp_types_commerce_transaction_1.LineType.ItemOrder && itemDisplayLine.cancelled) ||
+                (itemDisplayLine.lineType === scp_types_commerce_transaction_1.LineType.ItemReturn &&
+                    _.isEmpty(itemDisplayLine.lineNumberFromReturnTransaction) &&
+                    _.isEmpty(itemDisplayLine.sublineIndexFromReturnItem))) {
+                withoutTransactionTotal = withoutTransactionTotal.plus(itemDisplayLine.extendedAmount.abs());
+                withoutTransactionTotal = !_.isEmpty(itemDisplayLine.totalLineTax)
+                    ? withoutTransactionTotal.plus(itemDisplayLine.totalLineTax.abs())
+                    : withoutTransactionTotal;
+            }
+        });
+        return withoutTransactionTotal;
+    }
+    static getWithTransactionTotal(displayInfo, accountingCurrency) {
+        var _a, _b;
+        let withTransactionTotal = new scp_component_business_core_1.Money(0, accountingCurrency);
+        (_b = (_a = displayInfo) === null || _a === void 0 ? void 0 : _a.itemDisplayLines) === null || _b === void 0 ? void 0 : _b.forEach((itemDisplayLine) => {
+            if (itemDisplayLine.lineType === scp_types_commerce_transaction_1.LineType.ItemCancel ||
+                (itemDisplayLine.lineType === scp_types_commerce_transaction_1.LineType.ItemReturn &&
+                    !_.isEmpty(itemDisplayLine.lineNumberFromReturnTransaction) &&
+                    !_.isEmpty(itemDisplayLine.sublineIndexFromReturnItem))) {
+                withTransactionTotal = withTransactionTotal.plus(itemDisplayLine.extendedAmount.abs());
+                withTransactionTotal = !_.isEmpty(itemDisplayLine.totalLineTax)
+                    ? withTransactionTotal.plus(itemDisplayLine.totalLineTax.abs())
+                    : withTransactionTotal;
+            }
+        });
+        return withTransactionTotal;
+    }
+    static getWithOfflineTransactionTotal(displayInfo, accountingCurrency) {
+        var _a, _b;
+        let withOfflineTransactionTotal = new scp_component_business_core_1.Money(0, accountingCurrency);
+        (_b = (_a = displayInfo) === null || _a === void 0 ? void 0 : _a.itemDisplayLines) === null || _b === void 0 ? void 0 : _b.forEach((itemDisplayLine) => {
+            var _a, _b;
+            if (itemDisplayLine.lineType === scp_types_commerce_transaction_1.LineType.ItemReturn &&
+                !_.isEmpty(itemDisplayLine.offlineReturnReferenceNumber)) {
+                withOfflineTransactionTotal = withOfflineTransactionTotal.plus((_a = itemDisplayLine.extendedAmount) === null || _a === void 0 ? void 0 : _a.abs());
+                withOfflineTransactionTotal = !_.isEmpty(itemDisplayLine.totalLineTax)
+                    ? withOfflineTransactionTotal.plus((_b = itemDisplayLine.totalLineTax) === null || _b === void 0 ? void 0 : _b.abs())
+                    : undefined;
+            }
+        });
+        return withOfflineTransactionTotal;
+    }
+    static getOriginalRefundableTenders(container, accountingCurrency, originalTransactionsDetails, balanceDue, itemTypes, orderTypes, isRefund, productAttributeTypes, displayInfo) {
         var _a, _b, _c, _d;
         const configurationManager = container.get(scp_component_store_selling_core_1.DI_TYPES.IConfigurationManager);
         const suggestedRefundTenders = TenderType.getActiveSuggestedRefundTenders(container, accountingCurrency);
         let originalRefundableTenders = [];
         let originalReferencedTenders = [];
+        const withoutTransactionTotal = this.getWithoutTransactionTotal(displayInfo, accountingCurrency);
+        const withTransactionTotal = this.getWithTransactionTotal(displayInfo, accountingCurrency);
+        const offlineTransactionTotal = this.getWithOfflineTransactionTotal(displayInfo, accountingCurrency);
         const originalUnreferencedAndMappedTenders = [];
         (_a = originalTransactionsDetails) === null || _a === void 0 ? void 0 : _a.forEach((origTranDetail) => {
             var _a;
-            if ((_a = origTranDetail.originalTenders) === null || _a === void 0 ? void 0 : _a.length) {
-                origTranDetail.originalTenders.forEach((originalTender) => {
-                    var _a, _b;
-                    if (originalTender.refundAllowed) {
-                        const configuredTransactionReferenceTender = (_a = suggestedRefundTenders) === null || _a === void 0 ? void 0 : _a.find((tender) => tender.id === originalTender.tenderId);
-                        if (configuredTransactionReferenceTender) {
-                            if (originalTender.showReference) {
-                                originalReferencedTenders.push(originalTender);
-                            }
-                            else if (originalTender.tenderAuthCategory !== Constants_1.TenderAuthCategory.LoyaltyVoucherService) {
-                                combineOriginalUnreferencedAndMappedTenders(originalTender, originalUnreferencedAndMappedTenders);
-                            }
+            (_a = origTranDetail.originalTenders) === null || _a === void 0 ? void 0 : _a.forEach((originalTender) => {
+                var _a, _b;
+                if (originalTender.refundAllowed) {
+                    const configuredTransactionReferenceTender = (_a = suggestedRefundTenders) === null || _a === void 0 ? void 0 : _a.find((tender) => tender.id === originalTender.tenderId);
+                    if (configuredTransactionReferenceTender) {
+                        if (originalTender.showReference) {
+                            originalReferencedTenders.push(originalTender);
+                        }
+                        else if (originalTender.tenderAuthCategory !== Constants_1.TenderAuthCategory.LoyaltyVoucherService) {
+                            combineOriginalUnreferencedAndMappedTenders(originalTender, originalUnreferencedAndMappedTenders);
                         }
-                        const configuredMappedTenders = getConfiguredMappedTenders(originalTender, configurationManager, origTranDetail.originalTransactionId, originalTransactionsDetails, balanceDue);
-                        (_b = configuredMappedTenders) === null || _b === void 0 ? void 0 : _b.forEach((mappedTender) => {
-                            combineOriginalUnreferencedAndMappedTenders(mappedTender, originalUnreferencedAndMappedTenders);
-                        });
                     }
-                });
-            }
+                    const configuredMappedTenders = getConfiguredMappedTenders(originalTender, configurationManager, origTranDetail.originalTransactionId, originalTransactionsDetails, balanceDue);
+                    (_b = configuredMappedTenders) === null || _b === void 0 ? void 0 : _b.forEach((mappedTender) => {
+                        combineOriginalUnreferencedAndMappedTenders(mappedTender, originalUnreferencedAndMappedTenders);
+                    });
+                }
+            });
         });
         originalReferencedTenders = sortOriginalTenders(originalReferencedTenders);
         originalRefundableTenders = [...originalReferencedTenders, ...originalUnreferencedAndMappedTenders];
         originalRefundableTenders.forEach((tender) => {
-            tender.refundableAmount = getOriginalTenderRefundableAmount(tender, balanceDue, originalTransactionsDetails);
+            var _a, _b, _c, _d, _e, _f, _g, _h, _j;
+            const configuredTender = getConfiguredTender(tender, configurationManager);
+            const withoutTransaction = ((_b = (_a = configuredTender) === null || _a === void 0 ? void 0 : _a.allowRefund) === null || _b === void 0 ? void 0 : _b.indexOf(ITendersConfig_1.AllowRefund.WithoutTransaction)) >= 0;
+            const withTransaction = ((_d = (_c = configuredTender) === null || _c === void 0 ? void 0 : _c.allowRefund) === null || _d === void 0 ? void 0 : _d.indexOf(ITendersConfig_1.AllowRefund.WithTransaction)) >= 0;
+            const withOfflineTransaction = ((_f = (_e = configuredTender) === null || _e === void 0 ? void 0 : _e.allowRefund) === null || _f === void 0 ? void 0 : _f.indexOf(ITendersConfig_1.AllowRefund.WithOfflineTransaction)) >= 0;
+            tender.refundableAmount = getOriginalTenderRefundableAmount(tender, balanceDue, originalTransactionsDetails, withoutTransaction && ((_g = withoutTransactionTotal) === null || _g === void 0 ? void 0 : _g.gt(new scp_component_business_core_1.Money(0, accountingCurrency)))
+                ? withoutTransactionTotal
+                : undefined, withTransaction && ((_h = withTransactionTotal) === null || _h === void 0 ? void 0 : _h.gt(new scp_component_business_core_1.Money(0, accountingCurrency)))
+                ? withTransactionTotal
+                : undefined, withOfflineTransaction && ((_j = offlineTransactionTotal) === null || _j === void 0 ? void 0 : _j.gt(new scp_component_business_core_1.Money(0, accountingCurrency)))
+                ? offlineTransactionTotal
+                : undefined);
         });
         //Check if original tender is restricted by item/order type
         if ((((_b = itemTypes) === null || _b === void 0 ? void 0 : _b.length) > 0 || ((_c = orderTypes) === null || _c === void 0 ? void 0 : _c.length) > 0 || ((_d = productAttributeTypes) === null || _d === void 0 ? void 0 : _d.length) > 0) && !isRefund) {
@@ -494,45 +557,54 @@ function combineOriginalUnreferencedAndMappedTenders(tender, unreferencedAndMapp
         unreferencedAndMappedTenders.push(tender);
     }
 }
-function getOriginalTenderRefundableAmount(originalTender, refundDue, originalTransactionDetails) {
+function getOriginalTenderRefundableAmount(originalTender, refundDue, originalTransactionDetails, withTransactionTotal, withoutTransactionTotal, withOfflineTransactionTotal) {
     var _a;
     if (!originalTender) {
         return undefined;
     }
     let refundableAmount = new scp_component_business_core_1.Money(0, refundDue.currency);
-    const mergedTransactionReferences = [];
-    if (((_a = originalTender.originalTransactionReferences) === null || _a === void 0 ? void 0 : _a.length) > 0) {
-        originalTender.originalTransactionReferences.forEach((ref) => {
-            const matchingRef = mergedTransactionReferences.find((matching) => matching.transactionLineReference.transactionId === ref.transactionLineReference.transactionId);
-            if (matchingRef) {
-                matchingRef.refundableAmount = matchingRef.refundableAmount.plus(ref.refundableAmount);
-            }
-            else {
-                mergedTransactionReferences.push(Object.assign({}, ref));
-            }
-        });
-        mergedTransactionReferences.forEach((origTranRef) => {
-            var _a, _b;
-            const originalTenderReferenceTranId = (_a = origTranRef.transactionLineReference) === null || _a === void 0 ? void 0 : _a.transactionId;
-            const originalTran = (_b = originalTransactionDetails) === null || _b === void 0 ? void 0 : _b.find((origTran) => origTran.originalTransactionId === originalTenderReferenceTranId);
-            if (refundDue) {
-                const returnTotalAmount = getReturnOrCancelTotalAmount(originalTran);
-                // If transaction was partially returned, tranRef.refundableAmount will have the full original tender amount, default to the partial return total amount
-                const originalTenderAmount = getLowestRefundDue(undefined, returnTotalAmount, adjustAmount(origTranRef.refundableAmount, originalTender.adjustmentAmount));
-                // Mapped tenders will only use their transaction references for refund amount calculation, if they have been fully tendered,
-                // they will not have transaction references, do not subtract refunded amount
-                const currentTranRefundableAmount = calculateRefundableAmount(originalTenderAmount, originalTender.isMappedTender ? undefined : originalTender.refundedAmount, returnTotalAmount, refundDue);
-                // Multi receipt transactions with the same mapped tender will have have multiple transaction references, refundDue will be the total
-                // of the current transaction, returnTotal amount is the original total of the individual transactions. Do not allow refundable amount
-                // to be greater than the refundDue, do not account for the individual original totals here or the amounts won't be combined
-                refundableAmount = getLowestRefundDue(refundableAmount.plus(currentTranRefundableAmount), undefined, refundDue);
-            }
-        });
+    if (!originalTender.showReference && !_.isUndefined(withTransactionTotal)) {
+        refundableAmount = refundableAmount.plus(withTransactionTotal);
+    }
+    if (!originalTender.showReference && !_.isUndefined(withoutTransactionTotal)) {
+        refundableAmount = refundableAmount.plus(withoutTransactionTotal);
+    }
+    if (!originalTender.showReference && !_.isUndefined(withOfflineTransactionTotal)) {
+        refundableAmount = refundableAmount.plus(withOfflineTransactionTotal);
     }
+    const mergedTransactionReferences = [];
+    (_a = originalTender.originalTransactionReferences) === null || _a === void 0 ? void 0 : _a.forEach((ref) => {
+        const matchingRef = mergedTransactionReferences.find((matching) => matching.transactionLineReference.transactionId === ref.transactionLineReference.transactionId);
+        if (matchingRef) {
+            matchingRef.refundableAmount = matchingRef.refundableAmount.plus(ref.refundableAmount);
+        }
+        else {
+            mergedTransactionReferences.push(Object.assign({}, ref));
+        }
+    });
+    mergedTransactionReferences.forEach((origTranRef) => {
+        var _a, _b;
+        const originalTenderReferenceTranId = (_a = origTranRef.transactionLineReference) === null || _a === void 0 ? void 0 : _a.transactionId;
+        const originalTran = (_b = originalTransactionDetails) === null || _b === void 0 ? void 0 : _b.find((origTran) => origTran.originalTransactionId === originalTenderReferenceTranId);
+        if (refundDue) {
+            const returnTotalAmount = getReturnOrCancelTotalAmount(originalTran);
+            // If transaction was partially returned, tranRef.refundableAmount will have the full original tender amount, default to the partial return total amount
+            const originalTenderAmount = getLowestRefundDue(undefined, returnTotalAmount, adjustAmount(origTranRef.refundableAmount, originalTender.adjustmentAmount));
+            // Mapped tenders will only use their transaction references for refund amount calculation, if they have been fully tendered,
+            // they will not have transaction references, do not subtract refunded amount
+            const currentTranRefundableAmount = calculateRefundableAmount(originalTenderAmount, originalTender.isMappedTender ? undefined : originalTender.refundedAmount, returnTotalAmount, refundDue);
+            // Multi receipt transactions with the same mapped tender will have have multiple transaction references, refundDue will be the total
+            // of the current transaction, returnTotal amount is the original total of the individual transactions. Do not allow refundable amount
+            // to be greater than the refundDue, do not account for the individual original totals here or the amounts won't be combined
+            refundableAmount = getLowestRefundDue(refundableAmount.plus(currentTranRefundableAmount), undefined, refundDue);
+        }
+    });
+    refundableAmount = getLowestRefundDue(refundableAmount, undefined, refundDue);
     return originalTender.isMappedTender
         ? refundableAmount
-        : (refundableAmount.ne(new scp_component_business_core_1.Money(0, refundDue.currency)) && refundableAmount) ||
-            originalTender.refundedAmount;
+        : refundableAmount.ne(new scp_component_business_core_1.Money(0, refundDue.currency))
+            ? refundableAmount
+            : originalTender.refundedAmount;
 }
 function getLowestRefundDue(refundDue, returnTotalAmount, remainingTenderAmount) {
     const lowestRefundDue = returnTotalAmount && refundDue && returnTotalAmount.gt(refundDue)
@@ -547,15 +619,20 @@ function calculateRefundableAmount(originalTenderAmount, refundedAmount, returnT
         originalTenderAmount;
     return getLowestRefundDue(refundDue, returnTotalAmount, remainingTenderAmount);
 }
+function getConfiguredTender(originalTender, configurationManager) {
+    var _a, _b;
+    return (_b = (_a = configurationManager
+        .getTendersValues()) === null || _a === void 0 ? void 0 : _a.tenderDefinitions) === null || _b === void 0 ? void 0 : _b.find((tender) => tender.tenderId === originalTender.tenderId);
+}
 function getConfiguredMappedTenders(originalTender, configurationManager, transactionId, originalTransactions, refundDue) {
-    var _a, _b, _c, _d, _e, _f, _g;
+    var _a, _b, _c, _d, _e, _f;
     const mappedTenders = [];
     const tenderConfig = (_a = configurationManager) === null || _a === void 0 ? void 0 : _a.getTendersValues();
     const tenderTypeBehaviors = (_c = (_b = tenderConfig) === null || _b === void 0 ? void 0 : _b.tenderBehaviors) === null || _c === void 0 ? void 0 : _c.tenderTypeBehaviors;
     const tenderDefinitions = (_d = tenderConfig) === null || _d === void 0 ? void 0 : _d.tenderDefinitions;
-    const configuredTender = (_e = tenderDefinitions) === null || _e === void 0 ? void 0 : _e.find((tender) => tender.tenderId === originalTender.tenderId);
+    const configuredTender = getConfiguredTender(originalTender, configurationManager);
     const tenderTypeBehavior = configuredTender && tenderTypeBehaviors && tenderTypeBehaviors[configuredTender.tenderType];
-    const refundTenderTypes = (_f = tenderTypeBehavior) === null || _f === void 0 ? void 0 : _f.refundTenderTypes;
+    const refundTenderTypes = (_e = tenderTypeBehavior) === null || _e === void 0 ? void 0 : _e.refundTenderTypes;
     const mappedTenderTypeNames = refundTenderTypes &&
         Object.keys(refundTenderTypes).filter((tenderType) => {
             const mappedRefundTenderType = refundTenderTypes[tenderType];
@@ -564,7 +641,7 @@ function getConfiguredMappedTenders(originalTender, configurationManager, transa
                 allowMappedTender(tenderType, tenderConfig) &&
                 isOriginalTenderAmountAllowed(originalTender, mappedRefundTenderType, originalTransactions, refundDue));
         });
-    (_g = mappedTenderTypeNames) === null || _g === void 0 ? void 0 : _g.forEach((tenderType) => {
+    (_f = mappedTenderTypeNames) === null || _f === void 0 ? void 0 : _f.forEach((tenderType) => {
         var _a;
         // For TenderAuthCategory: None tenders and Value certificate tenders need to have a tenderId, so we'll have one mapped tender for each
         // of those tenders.

package/package.json

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