@aptos-scp/scp-component-store-selling-features-domain-model 1.0.0

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

@@ -0,0 +1,660 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const scp_component_business_core_1 = require("@aptos-scp/scp-component-business-core");
+const scp_types_commerce_transaction_1 = require("@aptos-scp/scp-types-commerce-transaction");
+const BaseTransactionLine_1 = require("../BaseTransactionLine");
+const Constants_1 = require("../Constants");
+const ItemLine_1 = require("../item/ItemLine");
+exports.TRANSACTION_FEE_LINE_TYPE = "TransactionFee";
+exports.TRANSACTION_FEE_REFUND_LINE_TYPE = "TransactionFeeRefund";
+exports.ITEM_FEE_LINE_TYPE = "ItemFee";
+exports.ITEM_FEE_REFUND_LINE_TYPE = "ItemFeeRefund";
+class FeeLine extends BaseTransactionLine_1.BaseTransactionLine {
+    constructor(lineNumber, lineType, feeType, extendedAmount, extendedAmountExcludingTax, extendedAmountIncludingTax, feeId, customFeeType, unitAmount, quantity, description, externalId, longDescription, departmentId, departmentGroupId, orderReferenceId, feesByFulfillmentGroup, fulfillmentGroupIds, taxGroupId, autoApplied, quantityAllowed, itemLineReference, percent, maximumAmount, returnRule) {
+        super(lineNumber, lineType, extendedAmount, extendedAmountExcludingTax, extendedAmountIncludingTax);
+        this._feeType = feeType;
+        this._feeId = feeId;
+        this._customFeeType = customFeeType;
+        this._unitAmount = unitAmount;
+        this._quantity = quantity;
+        this._description = description;
+        this._externalId = externalId;
+        this._longDescription = longDescription;
+        this._departmentId = departmentId;
+        this._departmentGroupId = departmentGroupId;
+        this._orderReferenceId = orderReferenceId;
+        this._feesByFulfillmentGroup = feesByFulfillmentGroup;
+        this._fulfillmentGroupIds = fulfillmentGroupIds;
+        this._taxGroupId = taxGroupId;
+        this._autoApplied = autoApplied;
+        this._quantityAllowed = quantityAllowed;
+        this._itemLineReference = itemLineReference;
+        this._percent = percent;
+        this._maximumAmount = maximumAmount;
+        this._returnRule = returnRule;
+        this._unitPrice = undefined;
+        this._sublines = undefined;
+    }
+    /**
+     * 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.
+     *
+     * @param {number} lineNumber                        The line number of this line in the transaction
+     * @param {string} lineType                          The type of line
+     * @param {UiBusinessEvent} uiBusinessEvent          The UI business event that led to the creation of this line
+     * @param {Readonly<Map<string, any>>} collectedData The data collected during the qualification process
+     *
+     * @return {FeeLine}
+     */
+    static create(lineNumber, lineType, uiBusinessEvent, collectedData) {
+        const feeType = this.feeTypeFromCollectedData(collectedData);
+        let feeLine = new FeeLine(lineNumber, lineType, feeType);
+        feeLine.loadFromCollectedData(collectedData);
+        return feeLine;
+    }
+    static createFromJsonObject(transactionLineJsonObj) {
+        const lineNumber = BaseTransactionLine_1.BaseTransactionLine.lineNumberFromJsonObject(transactionLineJsonObj);
+        const lineType = BaseTransactionLine_1.BaseTransactionLine.lineTypeFromJsonObject(transactionLineJsonObj);
+        const feeType = FeeLine.feeTypeFromJsonObject(transactionLineJsonObj);
+        const extendedAmount = BaseTransactionLine_1.BaseTransactionLine.extendedAmountFromJsonObject(transactionLineJsonObj);
+        const extendedAmountExcludingTax = BaseTransactionLine_1.BaseTransactionLine.extendedAmountExcludingTaxFromJsonObject(transactionLineJsonObj);
+        const extendedAmountIncludingTax = BaseTransactionLine_1.BaseTransactionLine.extendedAmountIncludingTaxFromJsonObject(transactionLineJsonObj);
+        const feeLine = new FeeLine(lineNumber, lineType, feeType, extendedAmount, extendedAmountExcludingTax, extendedAmountIncludingTax);
+        feeLine.loadFromJsonObject(transactionLineJsonObj);
+        return feeLine;
+    }
+    get quantity() {
+        return this._quantity;
+    }
+    get unitPrice() {
+        return this._unitPrice;
+    }
+    /**
+     * @deprecated This will no longer be used in the future. Use the direct line instead.
+     */
+    get feesByFulfillmentGroup() {
+        return this._feesByFulfillmentGroup;
+    }
+    get fulfillmentGroupIds() {
+        return this._fulfillmentGroupIds;
+    }
+    get originalTaxOverride() {
+        return this._originalTaxOverride;
+    }
+    get feeType() {
+        return this._feeType;
+    }
+    get feeId() {
+        return this._feeId;
+    }
+    get couldAffectPricing() {
+        return true;
+    }
+    get couldAffectTaxation() {
+        if (this._sublineFromOriginalItemFee !== undefined) {
+            return true;
+        }
+        return this.couldAffectPricing;
+    }
+    get sublineFromOriginalItemFee() {
+        return this._sublineFromOriginalItemFee;
+    }
+    get originalTransactionLineReference() {
+        return this._originalTransactionLineReference;
+    }
+    get lineNumberFromReturnCanonicalTransaction() {
+        return this._lineNumberFromReturnCanonicalTransaction;
+    }
+    get lineNumberFromReturnTransaction() {
+        return this._lineNumberFromReturnTransaction;
+    }
+    get sublineIndexFromReturnCanonicalTransaction() {
+        return this._sublineIndexFromReturnCanonicalTransaction;
+    }
+    get customFeeType() {
+        return this._customFeeType;
+    }
+    get unitAmount() {
+        return this._unitAmount;
+    }
+    get description() {
+        return this._description;
+    }
+    get externalId() {
+        return this._externalId;
+    }
+    get longDescription() {
+        return this._longDescription;
+    }
+    get departmentId() {
+        return this._departmentId;
+    }
+    get departmentGroupId() {
+        return this._departmentGroupId;
+    }
+    get orderReferenceId() {
+        return this._orderReferenceId;
+    }
+    get voided() {
+        return false;
+    }
+    get voidSource() {
+        return undefined;
+    }
+    get preventsTransactionVoid() {
+        return false;
+    }
+    get allowVoid() {
+        return true;
+    }
+    get taxGroupId() {
+        return this._taxGroupId;
+    }
+    get taxByAuthority() {
+        return this._taxByAuthority;
+    }
+    get taxExemptDisplayName() {
+        return this._taxExemptDisplayName;
+    }
+    get totalLineTax() {
+        return this._totalLineTax;
+    }
+    /**
+     * This could return the taxByAuthority,
+     * but that would suggest that there was a void.  Instead this returns undefined to indicate that there was
+     * no void.
+     *
+     * @return {IAppliedTax}
+     */
+    get taxByAuthorityBeforeVoid() {
+        return undefined;
+    }
+    /**
+     * This could return the totalLineTax,
+     * but that would suggest that there was a void.  Instead this returns undefined to indicate that there was
+     * no void.
+     *
+     * @return {Money}
+     */
+    get totalLineTaxBeforeVoid() {
+        return undefined;
+    }
+    get unitAmountBeforeOverride() {
+        return undefined;
+    }
+    get taxExempt() {
+        return this._taxExempt;
+    }
+    get preTaxExemptDetails() {
+        return this._preTaxExemptDetails;
+    }
+    get taxOverride() {
+        return this._taxOverride;
+    }
+    get preTaxOverrideDetails() {
+        return this._preTaxOverrideDetails;
+    }
+    get taxationCalculationSourceIndicator() {
+        return this._taxationCalculationSourceIndicator;
+    }
+    get taxationDataSourceIndicator() {
+        return this._taxationDataSourceIndicator;
+    }
+    get pricingCalculationSourceIndicator() {
+        return this._pricingCalculationSourceIndicator;
+    }
+    get pricingDataSourceIndicator() {
+        return this._pricingDataSourceIndicator;
+    }
+    get feeTaxExemptAmount() {
+        return this._feeTaxExemptAmount;
+    }
+    get feeTaxAdjustmentAmount() {
+        return this._feeTaxAdjustmentAmount;
+    }
+    get extendedAmountAfterTaxAdjustment() {
+        return this._extendedAmountAfterTaxAdjustment;
+    }
+    get unitAmountAfterTaxAdjustment() {
+        return this._unitAmountAfterTaxAdjustment;
+    }
+    get autoApplied() {
+        return this._autoApplied;
+    }
+    get quantityAllowed() {
+        return this._quantityAllowed;
+    }
+    get itemLineReference() {
+        return this._itemLineReference;
+    }
+    get percent() {
+        return this._percent;
+    }
+    get maximumAmount() {
+        return this._maximumAmount;
+    }
+    get returnRule() {
+        return this._returnRule;
+    }
+    get sublines() {
+        return this._sublines;
+    }
+    static feeTypeFromJsonObject(transactionLineJsonObj) {
+        return transactionLineJsonObj._feeType;
+    }
+    static feeTypeFromCollectedData(collectedData) {
+        return collectedData.get(Constants_1.CollectedDataKey.FeeType);
+    }
+    static taxGroupIdFromJsonObject(transactionLineJsonObj) {
+        return transactionLineJsonObj._taxGroupId;
+    }
+    copyLineWithNewLineNumber(newLineNumber) {
+        const clonedItem = this.clone();
+        return clonedItem.updateLineNumber(newLineNumber);
+    }
+    /**
+     * This method should be implemented only in decorator and not in the Fee line.
+     * @param sublines fee's sublines
+     */
+    setSublines(sublines) {
+        throw new Error("Method not implemented.");
+    }
+    setItemLineReference(itemLineReference) {
+        if (this.lineType === exports.ITEM_FEE_LINE_TYPE) {
+            const newLine = this.clone();
+            newLine._itemLineReference = itemLineReference;
+            return newLine;
+        }
+        else {
+            return this;
+        }
+    }
+    setPricingSourceIndicator(calculationSourceIndicator, dataSourceIndicator) {
+        const newLine = this.clone();
+        if (calculationSourceIndicator) {
+            newLine._pricingCalculationSourceIndicator = calculationSourceIndicator;
+        }
+        if (dataSourceIndicator && !newLine._pricingDataSourceIndicator) {
+            newLine._pricingDataSourceIndicator = dataSourceIndicator;
+        }
+        return newLine;
+    }
+    setTaxationSourceIndicator(calculationSourceIndicator, dataSourceIndicator) {
+        const newLine = this.clone();
+        if (calculationSourceIndicator) {
+            newLine._taxationCalculationSourceIndicator = calculationSourceIndicator;
+        }
+        if (dataSourceIndicator && !newLine._taxationDataSourceIndicator) {
+            newLine._taxationDataSourceIndicator = dataSourceIndicator;
+        }
+        return newLine;
+    }
+    setTaxExemptInformation(taxExemptLine, preTaxExemptDetails) {
+        var _a;
+        const newLine = this.clone();
+        if (taxExemptLine) {
+            newLine._taxExempt = {
+                taxExemptLineReference: ItemLine_1.makeTaxExemptLineReference(taxExemptLine.lineNumber),
+                taxExemptType: taxExemptLine.taxExemptType,
+                reasonCode: taxExemptLine.reasonCode,
+                reasonDescription: taxExemptLine.reasonDescription,
+                reasonListType: taxExemptLine.reasonListType,
+                certificateId: taxExemptLine.certificateId,
+            };
+            newLine._taxExemptDisplayName = taxExemptLine.displayName;
+        }
+        else {
+            newLine._taxExempt = undefined;
+            newLine._taxExemptDisplayName = undefined;
+        }
+        newLine._preTaxExemptDetails = ((_a = preTaxExemptDetails) === null || _a === void 0 ? void 0 : _a.length) > 0 ? preTaxExemptDetails : undefined;
+        return newLine;
+    }
+    setTaxOverrideInformation(taxOverrideLine, preTaxOverrideDetails) {
+        var _a;
+        const newLine = this.clone();
+        if (taxOverrideLine) {
+            newLine._taxOverride = {
+                taxOverrideType: taxOverrideLine.taxOverrideType,
+                taxRate: taxOverrideLine.newTaxRate,
+                taxAmount: (_a = taxOverrideLine.newTaxAmount) === null || _a === void 0 ? void 0 : _a.toIMoney(),
+                reasonCode: taxOverrideLine.reasonCode,
+                reasonListType: taxOverrideLine.reasonListType,
+                reasonDescription: taxOverrideLine.reasonDescription,
+                supervisorOverrideLineReference: taxOverrideLine.supervisorOverrideLineReference,
+            };
+            newLine._preTaxOverrideDetails = preTaxOverrideDetails;
+        }
+        else {
+            newLine._taxOverride = undefined;
+            newLine._preTaxOverrideDetails = undefined;
+        }
+        return newLine;
+    }
+    setTransactionLineTaxes(transactionLineTaxes, extendedAmount) {
+        const newLine = this.clone();
+        newLine._taxByAuthority = transactionLineTaxes.taxByAuthority;
+        newLine._totalLineTax = transactionLineTaxes.totalLineTax;
+        return newLine.setExtendedAmountExcludingAndIncludingTax(extendedAmount);
+    }
+    updateExtendedAmountExcludingTax(amount) {
+        amount = adjustSignForFeeLineType(this.lineType, amount);
+        return this.updateExtendedAmountExcludingTaxValue(amount);
+    }
+    updateExtendedAmountIncludingTax(amount) {
+        amount = adjustSignForFeeLineType(this.lineType, amount);
+        return this.updateExtendedAmountIncludingTaxValue(amount);
+    }
+    clone() {
+        const newTransactionFeeLine = super.clone();
+        newTransactionFeeLine._feeType = this._feeType;
+        newTransactionFeeLine._feeId = this._feeId;
+        newTransactionFeeLine._quantity = this._quantity;
+        newTransactionFeeLine._unitPrice = this._unitPrice;
+        newTransactionFeeLine._customFeeType = this._customFeeType;
+        newTransactionFeeLine._unitAmount = this._unitAmount;
+        newTransactionFeeLine._description = this._description;
+        newTransactionFeeLine._externalId = this._externalId;
+        newTransactionFeeLine._longDescription = this._longDescription;
+        newTransactionFeeLine._departmentId = this._departmentId;
+        newTransactionFeeLine._departmentGroupId = this._departmentGroupId;
+        newTransactionFeeLine._orderReferenceId = this._orderReferenceId;
+        newTransactionFeeLine._feesByFulfillmentGroup = this._feesByFulfillmentGroup;
+        newTransactionFeeLine._fulfillmentGroupIds = this._fulfillmentGroupIds;
+        newTransactionFeeLine._autoApplied = this._autoApplied;
+        newTransactionFeeLine._quantityAllowed = this._quantityAllowed;
+        newTransactionFeeLine._itemLineReference = this._itemLineReference;
+        newTransactionFeeLine._percent = this._percent;
+        newTransactionFeeLine._maximumAmount = this._maximumAmount;
+        newTransactionFeeLine._returnRule = this._returnRule;
+        newTransactionFeeLine._sublines = this._sublines;
+        newTransactionFeeLine._taxGroupId = this._taxGroupId;
+        newTransactionFeeLine._taxByAuthority = this._taxByAuthority;
+        newTransactionFeeLine._taxExemptDisplayName = this._taxExemptDisplayName;
+        newTransactionFeeLine._taxExempt = this._taxExempt;
+        newTransactionFeeLine._preTaxExemptDetails = this._preTaxExemptDetails;
+        newTransactionFeeLine._taxOverride = this._taxOverride;
+        newTransactionFeeLine._preTaxOverrideDetails = this._preTaxOverrideDetails;
+        newTransactionFeeLine._taxationCalculationSourceIndicator = this._taxationCalculationSourceIndicator;
+        newTransactionFeeLine._taxationDataSourceIndicator = this._taxationDataSourceIndicator;
+        newTransactionFeeLine._pricingCalculationSourceIndicator = this._pricingCalculationSourceIndicator;
+        newTransactionFeeLine._pricingDataSourceIndicator = this._pricingDataSourceIndicator;
+        newTransactionFeeLine._totalLineTax = this._totalLineTax;
+        newTransactionFeeLine._sublineFromOriginalItemFee = this._sublineFromOriginalItemFee;
+        newTransactionFeeLine._originalTransactionLineReference = this._originalTransactionLineReference;
+        newTransactionFeeLine._lineNumberFromReturnCanonicalTransaction =
+            this._lineNumberFromReturnCanonicalTransaction;
+        newTransactionFeeLine._sublineIndexFromReturnCanonicalTransaction =
+            this._sublineIndexFromReturnCanonicalTransaction;
+        newTransactionFeeLine._lineNumberFromReturnTransaction = this._lineNumberFromReturnTransaction;
+        newTransactionFeeLine._originalTaxOverride = this._originalTaxOverride;
+        return newTransactionFeeLine;
+    }
+    newTransactionLine() {
+        return new FeeLine(this.lineNumber, this.lineType, this._feeType, this.extendedAmount, this.extendedAmountExcludingTax, this.extendedAmountIncludingTax, this._feeId, this._customFeeType, this._unitAmount, this._quantity, this._description, this._externalId, this._longDescription, this._departmentId, this._departmentGroupId, this._orderReferenceId, this._feesByFulfillmentGroup, this._fulfillmentGroupIds, this._taxGroupId, this._autoApplied, this._quantityAllowed, this._itemLineReference, this._percent, this._maximumAmount, this._returnRule);
+    }
+    loadFromJsonObject(transactionLineJsonObj) {
+        super.loadFromJsonObject(transactionLineJsonObj);
+        if (!this._unitAmount && transactionLineJsonObj._unitAmount) {
+            this._unitAmount = transactionLineJsonObj._unitAmount && new scp_component_business_core_1.Money(transactionLineJsonObj._unitAmount);
+        }
+        if (!this._feeId && transactionLineJsonObj._feeId) {
+            this._feeId = transactionLineJsonObj._feeId;
+        }
+        if (!this._customFeeType && transactionLineJsonObj._customFeeType) {
+            this._customFeeType = transactionLineJsonObj._customFeeType;
+        }
+        if (!this._description && transactionLineJsonObj._description) {
+            this._description = transactionLineJsonObj._description;
+        }
+        if (!this._externalId && transactionLineJsonObj._externalId) {
+            this._externalId = transactionLineJsonObj._externalId;
+        }
+        if (!this._quantity && transactionLineJsonObj._quantity) {
+            this._quantity = scp_component_business_core_1.Quantity.fromJSON(transactionLineJsonObj._quantity);
+        }
+        if (!this._unitPrice && transactionLineJsonObj._unitPrice) {
+            this._unitPrice = scp_component_business_core_1.Price.fromJSON(transactionLineJsonObj._unitPrice);
+        }
+        if (!this._longDescription && transactionLineJsonObj._longDescription) {
+            this._longDescription = transactionLineJsonObj._longDescription;
+        }
+        if (!this._departmentId && transactionLineJsonObj._departmentId) {
+            this._departmentId = transactionLineJsonObj._departmentId;
+        }
+        if (!this._departmentGroupId && transactionLineJsonObj._departmentGroupId) {
+            this._departmentGroupId = transactionLineJsonObj._departmentGroupId;
+        }
+        if (!this._orderReferenceId && transactionLineJsonObj._orderReferenceId) {
+            this._orderReferenceId = transactionLineJsonObj._orderReferenceId;
+        }
+        this._pricingCalculationSourceIndicator = transactionLineJsonObj._pricingCalculationSourceIndicator;
+        this._pricingDataSourceIndicator = transactionLineJsonObj._pricingDataSourceIndicator;
+        this._autoApplied = transactionLineJsonObj._autoApplied;
+        this._quantityAllowed = transactionLineJsonObj._quantityAllowed;
+        this._itemLineReference = transactionLineJsonObj._itemLineReference;
+        this._percent = transactionLineJsonObj._percent;
+        if (!this._maximumAmount && transactionLineJsonObj._maximumAmount) {
+            this._maximumAmount =
+                transactionLineJsonObj._maximumAmount && new scp_component_business_core_1.Money(transactionLineJsonObj._maximumAmount);
+        }
+        this._returnRule = transactionLineJsonObj._returnRule;
+        this._sublines = transactionLineJsonObj._sublines;
+        this._sublineFromOriginalItemFee = transactionLineJsonObj._sublineFromOriginalItemFee;
+        this._originalTransactionLineReference = transactionLineJsonObj._originalTransactionLineReference;
+        this._lineNumberFromReturnCanonicalTransaction =
+            transactionLineJsonObj._lineNumberFromReturnCanonicalTransaction;
+        this._lineNumberFromReturnTransaction = transactionLineJsonObj._lineNumberFromReturnTransaction;
+        this._sublineIndexFromReturnCanonicalTransaction =
+            transactionLineJsonObj._sublineIndexFromReturnCanonicalTransaction;
+        this._originalTaxOverride = transactionLineJsonObj._originalTaxOverride;
+        this.loadTaxInformation(transactionLineJsonObj);
+        if (!this._fulfillmentGroupIds && transactionLineJsonObj._fulfillmentGroupIds) {
+            this._fulfillmentGroupIds = transactionLineJsonObj._fulfillmentGroupIds;
+        }
+        this.loadFeesByFulfillmentGroupFromJsonObject(transactionLineJsonObj);
+    }
+    loadTaxInformation(transactionLineJsonObj) {
+        this._taxGroupId = transactionLineJsonObj._taxGroupId;
+        this._taxByAuthority = transactionLineJsonObj._taxByAuthority;
+        this._taxExemptDisplayName = transactionLineJsonObj._taxExemptDisplayName;
+        this._totalLineTax = transactionLineJsonObj._totalLineTax
+            ? new scp_component_business_core_1.Money(transactionLineJsonObj._totalLineTax)
+            : undefined;
+        this._taxExempt = transactionLineJsonObj._taxExempt;
+        this._preTaxExemptDetails = transactionLineJsonObj._preTaxExemptDetails;
+        this._taxOverride = transactionLineJsonObj._taxOverride;
+        this._preTaxOverrideDetails = transactionLineJsonObj._preTaxOverrideDetails;
+        this._taxationCalculationSourceIndicator = transactionLineJsonObj._taxationCalculationSourceIndicator;
+        this._taxationDataSourceIndicator = transactionLineJsonObj._taxationDataSourceIndicator;
+    }
+    loadFeesByFulfillmentGroupFromJsonObject(transactionLineJsonObj) {
+        if (!this._feesByFulfillmentGroup && transactionLineJsonObj._feesByFulfillmentGroup) {
+            transactionLineJsonObj._feesByFulfillmentGroup.forEach((group) => {
+                if (group.unitAmount) {
+                    group.unitAmount = scp_component_business_core_1.Money.fromJSON(group.unitAmount);
+                }
+                if (group.extendedAmount) {
+                    group.extendedAmount = scp_component_business_core_1.Money.fromJSON(group.extendedAmount);
+                }
+                if (group.extendedAmountExcludingTax) {
+                    group.extendedAmountExcludingTax = scp_component_business_core_1.Money.fromJSON(group.extendedAmountExcludingTax);
+                }
+                if (group.extendedAmountIncludingTax) {
+                    group.extendedAmountIncludingTax = scp_component_business_core_1.Money.fromJSON(group.extendedAmountIncludingTax);
+                }
+            });
+            this._feesByFulfillmentGroup = transactionLineJsonObj._feesByFulfillmentGroup;
+        }
+    }
+    loadFromCollectedData(collectedData) {
+        if (!this._feeId && collectedData.has(Constants_1.CollectedDataKey.FeeId)) {
+            this._feeId = collectedData.get(Constants_1.CollectedDataKey.FeeId);
+        }
+        if (!this._customFeeType && collectedData.has(Constants_1.CollectedDataKey.CustomFeeType)) {
+            this._customFeeType = collectedData.get(Constants_1.CollectedDataKey.CustomFeeType);
+        }
+        if (!this._unitAmount && collectedData.has(Constants_1.CollectedDataKey.FeeUnitAmount)) {
+            this._unitAmount = collectedData.get(Constants_1.CollectedDataKey.FeeUnitAmount);
+        }
+        if (!this._quantity && collectedData.has(Constants_1.CollectedDataKey.FeeQuantity)) {
+            this._quantity = collectedData.get(Constants_1.CollectedDataKey.FeeQuantity);
+        }
+        if (!this._unitPrice && collectedData.has(Constants_1.CollectedDataKey.Price)) {
+            this._unitPrice = collectedData.get(Constants_1.CollectedDataKey.Price);
+        }
+        if (!this._description && collectedData.has(Constants_1.CollectedDataKey.FeeDescription)) {
+            this._description = collectedData.get(Constants_1.CollectedDataKey.FeeDescription);
+        }
+        if (!this._externalId && collectedData.has(Constants_1.CollectedDataKey.FeeExternalId)) {
+            this._externalId = collectedData.get(Constants_1.CollectedDataKey.FeeExternalId);
+        }
+        if (!this._longDescription && collectedData.has(Constants_1.CollectedDataKey.FeeLongDescription)) {
+            this._longDescription = collectedData.get(Constants_1.CollectedDataKey.FeeLongDescription);
+        }
+        if (!this._departmentId && collectedData.has(Constants_1.CollectedDataKey.FeeDepartment)) {
+            this._departmentId = collectedData.get(Constants_1.CollectedDataKey.FeeDepartment);
+        }
+        if (!this._departmentGroupId && collectedData.has(Constants_1.CollectedDataKey.FeeDepartmentGroup)) {
+            this._departmentGroupId = collectedData.get(Constants_1.CollectedDataKey.FeeDepartmentGroup);
+        }
+        if (!this._orderReferenceId && collectedData.has(Constants_1.CollectedDataKey.OrderReferenceId)) {
+            this._orderReferenceId = collectedData.get(Constants_1.CollectedDataKey.OrderReferenceId);
+        }
+        if (collectedData.has(Constants_1.CollectedDataKey.AutoApplied)) {
+            this._autoApplied = collectedData.get(Constants_1.CollectedDataKey.AutoApplied);
+        }
+        if (collectedData.has(Constants_1.CollectedDataKey.FeeQuantityAllowed)) {
+            this._quantityAllowed = collectedData.get(Constants_1.CollectedDataKey.FeeQuantityAllowed);
+        }
+        if (collectedData.has(Constants_1.CollectedDataKey.FeeItemItemLineReference)) {
+            this._itemLineReference = collectedData.get(Constants_1.CollectedDataKey.FeeItemItemLineReference);
+        }
+        if (collectedData.has(Constants_1.CollectedDataKey.Percent)) {
+            this._percent = collectedData.get(Constants_1.CollectedDataKey.Percent);
+        }
+        if (collectedData.has(Constants_1.CollectedDataKey.MaximumAmount)) {
+            this._maximumAmount = collectedData.get(Constants_1.CollectedDataKey.MaximumAmount);
+        }
+        if (collectedData.has(Constants_1.CollectedDataKey.FeeReturnRule)) {
+            this._returnRule = collectedData.get(Constants_1.CollectedDataKey.FeeReturnRule);
+        }
+        if (collectedData.has(Constants_1.CollectedDataKey.OriginalSublineFromExternalItem)) {
+            const sublineFromOriginalItemFee = collectedData.get(Constants_1.CollectedDataKey.OriginalSublineFromExternalItem);
+            if (sublineFromOriginalItemFee) {
+                this._sublineFromOriginalItemFee = sublineFromOriginalItemFee;
+            }
+        }
+        if (collectedData.has(Constants_1.CollectedDataKey.OriginalTransactionLineReference)) {
+            this._originalTransactionLineReference = collectedData.get(Constants_1.CollectedDataKey.OriginalTransactionLineReference);
+        }
+        if (collectedData.has(Constants_1.CollectedDataKey.LineNumberFromReturnCanonicalTransaction)) {
+            this._lineNumberFromReturnCanonicalTransaction = collectedData.get(Constants_1.CollectedDataKey.LineNumberFromReturnCanonicalTransaction);
+        }
+        if (collectedData.has(Constants_1.CollectedDataKey.LineNumberFromReturnTransaction)) {
+            this._lineNumberFromReturnTransaction = collectedData.get(Constants_1.CollectedDataKey.LineNumberFromReturnTransaction);
+        }
+        if (collectedData.has(Constants_1.CollectedDataKey.OriginalTaxOverride)) {
+            const originalTaxOverride = collectedData.get(Constants_1.CollectedDataKey.OriginalTaxOverride);
+            if (originalTaxOverride) {
+                this._originalTaxOverride = originalTaxOverride;
+                this._taxOverride = originalTaxOverride.taxOverride;
+                this._preTaxOverrideDetails = originalTaxOverride.preTaxOverrideDetails;
+            }
+        }
+        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) {
+            this._sublines = [
+                {
+                    quantity: this._quantity.amount,
+                    itemSublineIndex: 0,
+                    taxByAuthority: [],
+                },
+            ];
+        }
+        if (!this._fulfillmentGroupIds && collectedData.has(Constants_1.CollectedDataKey.FulfillmentGroupId)) {
+            this._fulfillmentGroupIds = collectedData.get(Constants_1.CollectedDataKey.FulfillmentGroupId);
+        }
+        this.loadFeesByFulfillmentGroupFromCollectedData(collectedData);
+        this.taxGroupIdFromCollectedData(collectedData);
+    }
+    loadFeesByFulfillmentGroupFromCollectedData(collectedData) {
+        if (!this._feesByFulfillmentGroup && collectedData.has(Constants_1.CollectedDataKey.FeesByFulfillmentGroup)) {
+            this._feesByFulfillmentGroup = collectedData.get(Constants_1.CollectedDataKey.FeesByFulfillmentGroup);
+        }
+    }
+    taxGroupIdFromCollectedData(collectedData) {
+        if (!this._taxGroupId && collectedData.has(Constants_1.CollectedDataKey.TaxGroupId)) {
+            this._taxGroupId = collectedData.get(Constants_1.CollectedDataKey.TaxGroupId);
+        }
+    }
+    setExtendedAmountExcludingAndIncludingTax(extendedAmount) {
+        let transactionFeeLine = this.clone();
+        const { extendedAmountExcludingTax, extendedAmountIncludingTax } = ItemLine_1.getExtendedAmountExcludingAndIncludingTax(transactionFeeLine.taxByAuthority, extendedAmount || transactionFeeLine.extendedAmount, transactionFeeLine.totalLineTax);
+        transactionFeeLine = transactionFeeLine.updateExtendedAmountExcludingTax(extendedAmountExcludingTax);
+        transactionFeeLine = transactionFeeLine.updateExtendedAmountIncludingTax(extendedAmountIncludingTax);
+        return transactionFeeLine;
+    }
+}
+exports.FeeLine = FeeLine;
+function isFeeLine(transactionLine) {
+    return (transactionLine instanceof FeeLine ||
+        (transactionLine &&
+            (transactionLine.lineType === exports.TRANSACTION_FEE_LINE_TYPE ||
+                transactionLine.lineType === exports.TRANSACTION_FEE_REFUND_LINE_TYPE ||
+                transactionLine.lineType === exports.ITEM_FEE_REFUND_LINE_TYPE ||
+                transactionLine.lineType === exports.ITEM_FEE_LINE_TYPE)));
+}
+exports.isFeeLine = isFeeLine;
+function isTransactionFeeLine(transactionLine) {
+    return (transactionLine instanceof FeeLine ||
+        (transactionLine && transactionLine.lineType === exports.TRANSACTION_FEE_LINE_TYPE));
+}
+exports.isTransactionFeeLine = isTransactionFeeLine;
+function isTransactionFeeRefundLine(transactionLine) {
+    return (transactionLine instanceof FeeLine ||
+        (transactionLine && transactionLine.lineType === exports.TRANSACTION_FEE_REFUND_LINE_TYPE));
+}
+exports.isTransactionFeeRefundLine = isTransactionFeeRefundLine;
+function isBagFeeLine(transactionLine) {
+    return isTransactionFeeLine(transactionLine) && transactionLine.feeType === scp_types_commerce_transaction_1.FeeType.Bag;
+}
+exports.isBagFeeLine = isBagFeeLine;
+function isShippingFeeLine(transactionLine) {
+    return isTransactionFeeLine(transactionLine) && transactionLine.feeType === scp_types_commerce_transaction_1.FeeType.Shipping;
+}
+exports.isShippingFeeLine = isShippingFeeLine;
+function isDeliveryFeeLine(transactionLine) {
+    return isTransactionFeeLine(transactionLine) && transactionLine.feeType === scp_types_commerce_transaction_1.FeeType.Delivery;
+}
+exports.isDeliveryFeeLine = isDeliveryFeeLine;
+function isItemFeeLine(transactionLine) {
+    return transactionLine && transactionLine.lineType === exports.ITEM_FEE_LINE_TYPE;
+}
+exports.isItemFeeLine = isItemFeeLine;
+function isItemFeeRefundLine(transactionLine) {
+    return transactionLine && transactionLine.lineType === exports.ITEM_FEE_REFUND_LINE_TYPE;
+}
+exports.isItemFeeRefundLine = isItemFeeRefundLine;
+function adjustSignForFeeLineType(lineType, amount) {
+    if (amount && amount.isPositive()) {
+        amount = amount.times(getFeeLinePriceSignAdjuster(lineType));
+    }
+    return amount;
+}
+exports.adjustSignForFeeLineType = adjustSignForFeeLineType;
+function getFeeLinePriceSignAdjuster(lineType) {
+    switch (lineType) {
+        case exports.TRANSACTION_FEE_REFUND_LINE_TYPE:
+            return -1;
+        case exports.TRANSACTION_FEE_LINE_TYPE:
+        case exports.ITEM_FEE_LINE_TYPE:
+        default:
+            return 1;
+    }
+}
+exports.getFeeLinePriceSignAdjuster = getFeeLinePriceSignAdjuster;
+//# sourceMappingURL=FeeLine.js.map

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

@@ -0,0 +1,18 @@
+import { Money } from "@aptos-scp/scp-component-business-core";
+import { FeeLineExtendedAmountDecorator, IExtendedAmountFields } from "./FeeLineExtendedAmountDecorator";
+import { IFeeLine, IFeeSubline } from "./IFeeLine";
+import { BaseFeeLineDecorator } from "./BaseFeeLineDecorator";
+export declare const FEE_TAX_ANNOTATION_SOURCE_TYPE: string;
+export declare class FeeLineBaseTaxAdjustmentDecorator extends FeeLineExtendedAmountDecorator {
+    private _extendedAmountAfterTaxAdjustment?;
+    private _unitAmountAfterTaxAdjustment?;
+    private _sublines?;
+    static getExtendedAmountAfterTaxAdjustmentFromJsonObject(transactionLineJsonObject: any): Money;
+    static getUnitAmountAfterTaxAdjustmentFromJsonObject(transactionLineJsonObject: any): Money;
+    get extendedAmountAfterTaxAdjustment(): Money;
+    get unitAmountAfterTaxAdjustment(): Money;
+    get sublines(): IFeeSubline[];
+    constructor(decoratorType: string, decoratedLine: IFeeLine, annotationDescription: string, annotationSourceType: string, annotationSourceLineNumber: number, extendedAmountAfterTaxAdjustment?: Money, unitAmountAfterTaxAdjustment?: Money, extendedAmountFields?: IExtendedAmountFields, sublines?: IFeeSubline[]);
+    protected clone(): BaseFeeLineDecorator;
+    protected newTransactionLine(): BaseFeeLineDecorator;
+}