@aptos-scp/scp-component-store-selling-features-domain-model 1.11.2 → 1.11.4

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

@@ -45,6 +45,7 @@ export interface TotalsBeforeVoid {
     transactionTotalDeliveryFee?: Money;
     transactionTotalBagFee?: Money;
     transactionTotalPublicImprovementFee?: Money;
+    transactionTotalPreviouslyPaidItemFee?: Money;
     transactionTotalCustomFeeByType?: CustomFeeTotal[];
     transactionTotalShippingFee?: Money;
     transactionTotalDonations?: Money;
@@ -95,6 +96,7 @@ export declare class MerchandiseTransaction extends RetailTransaction implements
     private _transactionTotalDeliveryFee;
     private _transactionTotalBagFee;
     private _transactionTotalPublicImprovementFee;
+    private _transactionTotalPreviouslyPaidItemFee;
     private _transactionTotalCustomFeeByType;
     private _transactionTotalShippingFee;
     private _returnSubTotal;
@@ -206,6 +208,7 @@ export declare class MerchandiseTransaction extends RetailTransaction implements
     get transactionTotalDeliveryFee(): Money;
     get transactionTotalBagFee(): Money;
     get transactionTotalPublicImprovementFee(): Money;
+    get transactionTotalPreviouslyPaidItemFee(): Money;
     get transactionTotalCustomFeeByType(): CustomFeeTotal[];
     get transactionTotalShippingFee(): Money;
     get returnSubTotal(): Money;

package/lib/domain/model/MerchandiseTransaction.js

@@ -30,6 +30,7 @@ class MerchandiseTransaction extends RetailTransaction_1.RetailTransaction {
         this._transactionTotalDeliveryFee = new scp_component_business_core_1.Money(0, accountingCurrency);
         this._transactionTotalBagFee = new scp_component_business_core_1.Money(0, accountingCurrency);
         this._transactionTotalPublicImprovementFee = new scp_component_business_core_1.Money(0, accountingCurrency);
+        this._transactionTotalPreviouslyPaidItemFee = new scp_component_business_core_1.Money(0, accountingCurrency);
         this._transactionTotalCustomFeeByType = undefined;
         this._transactionTotalShippingFee = new scp_component_business_core_1.Money(0, accountingCurrency);
         this._transactionSubTotal = new scp_component_business_core_1.Money(0, accountingCurrency);
@@ -162,6 +163,7 @@ class MerchandiseTransaction extends RetailTransaction_1.RetailTransaction {
             transaction._transactionTotalDeliveryFee = this._transactionTotalDeliveryFee;
             transaction._transactionTotalBagFee = this._transactionTotalBagFee;
             transaction._transactionTotalPublicImprovementFee = this._transactionTotalPublicImprovementFee;
+            transaction._transactionTotalPreviouslyPaidItemFee = this._transactionTotalPreviouslyPaidItemFee;
             transaction._transactionTotalCustomFeeByType = this._transactionTotalCustomFeeByType;
             transaction._transactionTotalShippingFee = this._transactionTotalShippingFee;
             transaction._returnSubTotal = this._returnSubTotal;
@@ -384,6 +386,9 @@ class MerchandiseTransaction extends RetailTransaction_1.RetailTransaction {
     get transactionTotalPublicImprovementFee() {
         return this._transactionTotalPublicImprovementFee;
     }
+    get transactionTotalPreviouslyPaidItemFee() {
+        return this._transactionTotalPreviouslyPaidItemFee;
+    }
     get transactionTotalCustomFeeByType() {
         return this._transactionTotalCustomFeeByType;
     }
@@ -584,7 +589,7 @@ class MerchandiseTransaction extends RetailTransaction_1.RetailTransaction {
         return this._salesperson;
     }
     updateTransactionTotalsBeforeVoid(totalsBeforeVoid) {
-        var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o, _p, _q, _r, _s, _t, _u, _v, _w, _x, _y, _z, _0;
+        var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o, _p, _q, _r, _s, _t, _u, _v, _w, _x, _y, _z, _0, _1;
         const newTransaction = this.clone();
         //make sure all the Money entries in totalsBeforeVoid are the correct type
         if (totalsBeforeVoid) {
@@ -609,7 +614,8 @@ class MerchandiseTransaction extends RetailTransaction_1.RetailTransaction {
             totalsBeforeVoid.transactionTotalDeliveryFee = this.convertAmountToAccountingCurrency((_s = totalsBeforeVoid.transactionTotalDeliveryFee) === null || _s === void 0 ? void 0 : _s.amount);
             totalsBeforeVoid.transactionTotalBagFee = this.convertAmountToAccountingCurrency((_t = totalsBeforeVoid.transactionTotalBagFee) === null || _t === void 0 ? void 0 : _t.amount);
             totalsBeforeVoid.transactionTotalPublicImprovementFee = this.convertAmountToAccountingCurrency((_u = totalsBeforeVoid.transactionTotalPublicImprovementFee) === null || _u === void 0 ? void 0 : _u.amount);
-            totalsBeforeVoid.transactionTotalCustomFeeByType = (_v = totalsBeforeVoid.transactionTotalCustomFeeByType) === null || _v === void 0 ? void 0 : _v.map((fee) => {
+            totalsBeforeVoid.transactionTotalPreviouslyPaidItemFee = this.convertAmountToAccountingCurrency((_v = totalsBeforeVoid.transactionTotalPreviouslyPaidItemFee) === null || _v === void 0 ? void 0 : _v.amount);
+            totalsBeforeVoid.transactionTotalCustomFeeByType = (_w = totalsBeforeVoid.transactionTotalCustomFeeByType) === null || _w === void 0 ? void 0 : _w.map((fee) => {
                 var _a;
                 return {
                     feeId: fee.feeId,
@@ -618,11 +624,11 @@ class MerchandiseTransaction extends RetailTransaction_1.RetailTransaction {
                     amount: this.convertAmountToAccountingCurrency((_a = fee.amount) === null || _a === void 0 ? void 0 : _a.amount),
                 };
             });
-            totalsBeforeVoid.transactionTotalShippingFee = this.convertAmountToAccountingCurrency((_w = totalsBeforeVoid.transactionTotalShippingFee) === null || _w === void 0 ? void 0 : _w.amount);
-            totalsBeforeVoid.transactionTax = this.convertAmountToAccountingCurrency((_x = totalsBeforeVoid.transactionTax) === null || _x === void 0 ? void 0 : _x.amount);
-            totalsBeforeVoid.transactionTaxableAmount = this.convertAmountToAccountingCurrency((_y = totalsBeforeVoid.transactionTaxableAmount) === null || _y === void 0 ? void 0 : _y.amount);
-            totalsBeforeVoid.transactionTotalTendered = this.convertAmountToAccountingCurrency((_z = totalsBeforeVoid.transactionTotalTendered) === null || _z === void 0 ? void 0 : _z.amount);
-            totalsBeforeVoid.transactionTotalExcludingTax = this.convertAmountToAccountingCurrency((_0 = totalsBeforeVoid.transactionTotalExcludingTax) === null || _0 === void 0 ? void 0 : _0.amount);
+            totalsBeforeVoid.transactionTotalShippingFee = this.convertAmountToAccountingCurrency((_x = totalsBeforeVoid.transactionTotalShippingFee) === null || _x === void 0 ? void 0 : _x.amount);
+            totalsBeforeVoid.transactionTax = this.convertAmountToAccountingCurrency((_y = totalsBeforeVoid.transactionTax) === null || _y === void 0 ? void 0 : _y.amount);
+            totalsBeforeVoid.transactionTaxableAmount = this.convertAmountToAccountingCurrency((_z = totalsBeforeVoid.transactionTaxableAmount) === null || _z === void 0 ? void 0 : _z.amount);
+            totalsBeforeVoid.transactionTotalTendered = this.convertAmountToAccountingCurrency((_0 = totalsBeforeVoid.transactionTotalTendered) === null || _0 === void 0 ? void 0 : _0.amount);
+            totalsBeforeVoid.transactionTotalExcludingTax = this.convertAmountToAccountingCurrency((_1 = totalsBeforeVoid.transactionTotalExcludingTax) === null || _1 === void 0 ? void 0 : _1.amount);
         }
         newTransaction._totalsBeforeVoid = totalsBeforeVoid;
         return newTransaction;
@@ -740,13 +746,13 @@ class MerchandiseTransaction extends RetailTransaction_1.RetailTransaction {
     }
     // Calculated totals
     get transactionTotal() {
-        return this.getTransactionTotal(this.transactionTax, this.transactionSubTotal);
+        return this.getTransactionTotal(this.transactionTax, this.transactionSubTotal, this.transactionTotalPreviouslyPaidItemFee);
     }
     get transactionTotalExcludingPreviouslyCollected() {
         return this.getTransactionTotal(this.transactionTotalTaxExcludingPreviouslyCollected, this.transactionSubTotalExcludingPreviouslyCollected);
     }
     get transactionBalanceDue() {
-        return this.getTransactionBalanceDue(this.transactionTotal, this.transactionTotalTendered, true);
+        return this.getTransactionBalanceDue(this.transactionTotal, this.transactionTotalTendered, true, this.transactionTotalPreviouslyPaidItemFee);
     }
     get transactionBalanceDueExcludingPreviouslyCollected() {
         return this.getTransactionBalanceDue(this.transactionTotalExcludingPreviouslyCollected, this.transactionTotalTenderedExcludingPreviouslyCollected, true);
@@ -789,6 +795,7 @@ class MerchandiseTransaction extends RetailTransaction_1.RetailTransaction {
             ["transaction.deliveryFee", this._transactionTotalDeliveryFee],
             ["transaction.bagFee", this._transactionTotalBagFee],
             ["transaction.publicImprovementFee", this._transactionTotalPublicImprovementFee],
+            ["transaction.transactionTotalPreviouslyPaidItemFee", this._transactionTotalPreviouslyPaidItemFee],
             ["transaction.customFeeByType", this._transactionTotalCustomFeeByType],
             ["transaction.shippingFee", this._transactionTotalShippingFee],
             ["transaction.subTotal", this._transactionSubTotal],
@@ -917,6 +924,7 @@ class MerchandiseTransaction extends RetailTransaction_1.RetailTransaction {
             _transactionTotalDeliveryFee: this.transactionTotalDeliveryFee,
             _transactionTotalBagFee: this._transactionTotalBagFee,
             _transactionTotalPublicImprovementFee: this._transactionTotalPublicImprovementFee,
+            _transactionTotalPreviouslyPaidItemFee: this.transactionTotalPreviouslyPaidItemFee,
             _transactionTotalCustomFeeByType: this._transactionTotalCustomFeeByType,
             _transactionTotalShippingFee: this._transactionTotalShippingFee,
             _transactionSubTotal: this.transactionSubTotal,
@@ -1010,6 +1018,9 @@ class MerchandiseTransaction extends RetailTransaction_1.RetailTransaction {
         this._transactionTotalPublicImprovementFee =
             transactionJsonObj._transactionTotalPublicImprovementFee &&
                 new scp_component_business_core_1.Money(transactionJsonObj._transactionTotalPublicImprovementFee);
+        this._transactionTotalPreviouslyPaidItemFee =
+            transactionJsonObj._transactionTotalPreviouslyPaidItemFee &&
+                new scp_component_business_core_1.Money(transactionJsonObj._transactionTotalPreviouslyPaidItemFee);
         this._transactionTotalCustomFeeByType = transactionJsonObj._transactionTotalCustomFeeByType;
         this._transactionTotalShippingFee =
             transactionJsonObj._transactionTotalShippingFee &&
@@ -1207,6 +1218,8 @@ class MerchandiseTransaction extends RetailTransaction_1.RetailTransaction {
                 new scp_component_business_core_1.Money(transactionJsonObj._totalsBeforeVoid.transactionTotalBagFee),
             transactionTotalPublicImprovementFee: transactionJsonObj._totalsBeforeVoid.transactionTotalPublicImprovementFee &&
                 new scp_component_business_core_1.Money(transactionJsonObj._totalsBeforeVoid.transactionTotalPublicImprovementFee),
+            transactionTotalPreviouslyPaidItemFee: transactionJsonObj._totalsBeforeVoid.transactionTotalPreviouslyPaidItemFee &&
+                new scp_component_business_core_1.Money(transactionJsonObj._totalsBeforeVoid.transactionTotalPreviouslyPaidItemFee),
             transactionTotalCustomFeeByType: transactionJsonObj._totalsBeforeVoid.transactionTotalCustomFeeByType,
             transactionTotalShippingFee: transactionJsonObj._totalsBeforeVoid.transactionTotalShippingFee &&
                 new scp_component_business_core_1.Money(transactionJsonObj._totalsBeforeVoid.transactionTotalShippingFee),
@@ -1232,7 +1245,7 @@ class MerchandiseTransaction extends RetailTransaction_1.RetailTransaction {
             return new scp_component_business_core_1.Money(amount, this.accountingCurrency);
         }
     }
-    getTransactionTotal(taxAmount, subTotalAmount) {
+    getTransactionTotal(taxAmount, subTotalAmount, transactionTotalPreviouslyPaidItemFee) {
         let taxToAddToTotal = taxAmount;
         if (this.taxIncludedInPrice()) {
             taxToAddToTotal = new scp_component_business_core_1.Money("0", this._accountingCurrency);
@@ -1243,13 +1256,23 @@ class MerchandiseTransaction extends RetailTransaction_1.RetailTransaction {
                 taxToAddToTotal = taxToAddToTotal.minus(this.transactionTaxAdjustmentAmount);
             }
         }
+        if (!transactionTotalPreviouslyPaidItemFee) {
+            transactionTotalPreviouslyPaidItemFee = new scp_component_business_core_1.Money("0", this._accountingCurrency);
+        }
         return subTotalAmount
             .plus(taxToAddToTotal)
             .plus(this.transactionTotalFee)
-            .plus(this.transactionTotalDonations);
+            .plus(this.transactionTotalDonations)
+            .plus(transactionTotalPreviouslyPaidItemFee);
     }
-    getTransactionBalanceDue(totalAmount, totalTendered, removeTotalTendered) {
-        let balanceDue = totalAmount;
+    getTransactionBalanceDue(totalAmount, totalTendered, removeTotalTendered, transactionTotalPreviouslyPaidItemFee) {
+        let balanceDue;
+        if (transactionTotalPreviouslyPaidItemFee) {
+            balanceDue = totalAmount.plus(transactionTotalPreviouslyPaidItemFee);
+        }
+        else {
+            balanceDue = totalAmount;
+        }
         if (removeTotalTendered) {
             balanceDue = balanceDue.minus(totalTendered.plus(this.denominationRounding));
         }

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

@@ -48,6 +48,8 @@ export declare class FeeLine extends BaseTransactionLine implements IFeeLine, IC
     private _quantityAllowed?;
     private _itemLineReference?;
     private _percent?;
+    private _prepaidAmount?;
+    private _prepaidTaxAmount?;
     private _maximumAmount?;
     private _returnRule?;
     private _sublines?;
@@ -142,6 +144,8 @@ export declare class FeeLine extends BaseTransactionLine implements IFeeLine, IC
     get maximumAmount(): Money;
     get returnRule(): string;
     get sublines(): IFeeSubline[];
+    get prepaidAmount(): Money;
+    get prepaidTaxAmount(): Money;
     static feeTypeFromJsonObject(transactionLineJsonObj: any): FeeType;
     static feeTypeFromCollectedData(collectedData: Readonly<Map<string, any>>): FeeType;
     static taxGroupIdFromJsonObject(transactionLineJsonObj: any): string;

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

@@ -35,6 +35,8 @@ class FeeLine extends BaseTransactionLine_1.BaseTransactionLine {
         this._returnRule = returnRule;
         this._unitPrice = undefined;
         this._sublines = undefined;
+        this._prepaidAmount = undefined;
+        this._prepaidTaxAmount = undefined;
     }
     /**
      * The create method is called by the transaction line factory to create an instance and initialize it from the
@@ -96,16 +98,10 @@ class FeeLine extends BaseTransactionLine_1.BaseTransactionLine {
         return this._feeId;
     }
     get couldAffectPricing() {
-        if (FeeLine.isPickupFulfilmentTransaction) {
-            return false;
-        }
         return true;
     }
     get couldAffectTaxation() {
-        if (FeeLine.isPickupFulfilmentTransaction) {
-            return false;
-        }
-        else if (this._sublineFromOriginalItemFee !== undefined) {
+        if (this._sublineFromOriginalItemFee !== undefined) {
             return true;
         }
         return this.couldAffectPricing;
@@ -253,6 +249,12 @@ class FeeLine extends BaseTransactionLine_1.BaseTransactionLine {
     get sublines() {
         return this._sublines;
     }
+    get prepaidAmount() {
+        return this._prepaidAmount;
+    }
+    get prepaidTaxAmount() {
+        return this._prepaidTaxAmount;
+    }
     static feeTypeFromJsonObject(transactionLineJsonObj) {
         return transactionLineJsonObj._feeType;
     }
@@ -414,6 +416,8 @@ class FeeLine extends BaseTransactionLine_1.BaseTransactionLine {
         newTransactionFeeLine._sublines = this._sublines;
         newTransactionFeeLine._taxGroupId = this._taxGroupId;
         newTransactionFeeLine._taxByAuthority = this._taxByAuthority;
+        newTransactionFeeLine._prepaidAmount = this._prepaidAmount;
+        newTransactionFeeLine._prepaidTaxAmount = this._prepaidTaxAmount;
         newTransactionFeeLine._taxExemptDisplayName = this._taxExemptDisplayName;
         newTransactionFeeLine._taxExempt = this._taxExempt;
         newTransactionFeeLine._preTaxExemptDetails = this._preTaxExemptDetails;
@@ -498,6 +502,12 @@ class FeeLine extends BaseTransactionLine_1.BaseTransactionLine {
         if (!this._fulfillmentGroupIds && transactionLineJsonObj._fulfillmentGroupIds) {
             this._fulfillmentGroupIds = transactionLineJsonObj._fulfillmentGroupIds;
         }
+        this._prepaidAmount = transactionLineJsonObj._prepaidAmount
+            ? new scp_component_business_core_1.Money(transactionLineJsonObj._prepaidAmount)
+            : undefined;
+        this._prepaidTaxAmount = transactionLineJsonObj._prepaidTaxAmount
+            ? new scp_component_business_core_1.Money(transactionLineJsonObj._prepaidTaxAmount)
+            : undefined;
         this.loadFeesByFulfillmentGroupFromJsonObject(transactionLineJsonObj);
     }
     loadTaxInformation(transactionLineJsonObj) {
@@ -534,6 +544,7 @@ class FeeLine extends BaseTransactionLine_1.BaseTransactionLine {
         }
     }
     loadFromCollectedData(collectedData) {
+        const accountingCurrency = collectedData.get(Constants_1.CollectedDataKey.AccountingCurrency);
         if (!this._feeId && collectedData.has(Constants_1.CollectedDataKey.FeeId)) {
             this._feeId = collectedData.get(Constants_1.CollectedDataKey.FeeId);
         }
@@ -610,6 +621,18 @@ class FeeLine extends BaseTransactionLine_1.BaseTransactionLine {
             if (!this.taxByAuthority && collectedData.has(Constants_1.CollectedDataKey.TaxByAuthority)) {
                 this._taxByAuthority = collectedData.get(Constants_1.CollectedDataKey.TaxByAuthority);
             }
+            if (collectedData.has(Constants_1.CollectedDataKey.PrepaidAmount)) {
+                this._prepaidAmount = collectedData.get(Constants_1.CollectedDataKey.PrepaidAmount);
+            }
+            else {
+                this._prepaidAmount = new scp_component_business_core_1.Money(0, accountingCurrency);
+            }
+            if (collectedData.has(Constants_1.CollectedDataKey.PrepaidTaxAmount)) {
+                this._prepaidTaxAmount = collectedData.get(Constants_1.CollectedDataKey.PrepaidTaxAmount);
+            }
+            else {
+                this._prepaidTaxAmount = new scp_component_business_core_1.Money(0, accountingCurrency);
+            }
         }
         if (collectedData.has(Constants_1.CollectedDataKey.OriginalTaxOverride)) {
             const originalTaxOverride = collectedData.get(Constants_1.CollectedDataKey.OriginalTaxOverride);

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

@@ -43,6 +43,8 @@ export interface IFeeLine extends ITransactionLine, IVoidableLine {
     readonly quantityAllowed?: boolean;
     readonly itemLineReference?: ISameTransactionLineReference;
     readonly percent?: string;
+    readonly prepaidAmount?: Money;
+    readonly prepaidTaxAmount?: Money;
     readonly maximumAmount?: Money;
     readonly returnRule?: string;
     readonly sublines?: IFeeSubline[];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aptos-scp/scp-component-store-selling-features-domain-model",
-  "version": "1.11.2",
+  "version": "1.11.4",
   "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",
@@ -27,8 +27,8 @@
     "build": "npm run build:ci",
     "lint": "eslint -c .eslintrc.json --ext .ts \"@(src|test)/**/*.ts?(x)\"",
     "pretest": "npm run clean:test",
-    "test:ci": "LOG_LEVEL=ALL nyc mocha $NODE_DEBUG_OPTION --no-opts --no-config",
-    "test": "LOG_LEVEL=OFF nyc mocha $NODE_DEBUG_OPTION --no-opts --no-config --reporter mocha-junit-reporter --reporter-options mochaFile=./reports/test-results.xml",
+    "test:ci": "LOG_LEVEL=ALL nyc mocha $NODE_DEBUG_OPTION --no-opts --no-config --reporter mocha-junit-reporter --reporter-options mochaFile=./reports/test-results.xml",
+    "test": "LOG_LEVEL=OFF nyc mocha $NODE_DEBUG_OPTION --no-opts --no-config",
     "test:no-coverage": "LOG_LEVEL=OFF mocha $NODE_DEBUG_OPTION --no-opts --no-config",
     "sonar:ci": "./sonar.sh",
     "publishPacts:ci": "node test-js/test/test-helpers/publish-pacts",
@@ -57,12 +57,12 @@
     "@aptos-scp/scp-component-pricing": "^7.54.1",
     "@aptos-scp/scp-component-store-items": "^1.19.0",
     "@aptos-scp/scp-component-store-selling-core": "^18.8.2",
-    "@aptos-scp/scp-component-taxation": "^5.25.0",
+    "@aptos-scp/scp-component-taxation": "^5.27.2",
     "@aptos-scp/scp-component-user": "^1.4.0",
     "@aptos-scp/scp-types-client-registration": "^1.4.0",
     "@aptos-scp/scp-types-core-config": "^2.2.1",
     "@aptos-scp/scp-types-commerce-devices": "^3.2.0",
-    "@aptos-scp/scp-types-commerce-transaction": "^1.60.0",
+    "@aptos-scp/scp-types-commerce-transaction": "^1.62.1",
     "@aptos-scp/scp-types-customer": "^3.7.0",
     "@aptos-scp/scp-types-einvoice": "^1.17.0",
     "@aptos-scp/scp-types-inventory": "^2.0.0",
@@ -84,7 +84,7 @@
     "@aptos-scp/scp-component-user": "^1.4.0",
     "@aptos-scp/scp-types-client-registration": "^1.4.0",
     "@aptos-scp/scp-types-commerce-devices": "^3.2.0",
-    "@aptos-scp/scp-types-commerce-transaction": "^1.60.0",
+    "@aptos-scp/scp-types-commerce-transaction": "^1.62.1",
     "@aptos-scp/scp-types-core": "^1.0.5",
     "@aptos-scp/scp-types-core-config": "^2.2.1",
     "@aptos-scp/scp-types-currency-conversion": "^1.2.0",
@@ -176,6 +176,9 @@
     "extension": [
       ".ts"
     ],
+    "require": [
+      "ts-node/register"
+    ],
     "reporter": [
       "text-summary",
       "html",
@@ -186,9 +189,9 @@
     "instrument": true,
     "check-coverage": true,
     "lines": 65,
-    "statements": 65,
-    "functions": 40,
-    "branches": 50
+    "statements": 66,
+    "functions": 41,
+    "branches": 52
   },
   "husky": {
     "hooks": {