@aptos-scp/scp-component-store-selling-features-domain-model 1.41.2 → 1.42.0

package/lib/domain/model/extensibilityForm/IExtensibilityForm.d.ts

@@ -6,3 +6,12 @@ export interface IExtensibilityForm {
 export interface IExtensibilityFormFields {
     [k: string]: any;
 }
+export declare enum ExtensibilityFormTypeOfDataEnum {
+    StringData = "StringData",
+    IntegerData = "IntegerData",
+    BooleanData = "BooleanData",
+    DateData = "DateData",
+    TimeData = "TimeData",
+    DateTimeData = "DateTimeData",
+    Unknown = "Unknown"
+}

package/lib/domain/model/extensibilityForm/IExtensibilityForm.js

@@ -1,3 +1,13 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+var ExtensibilityFormTypeOfDataEnum;
+(function (ExtensibilityFormTypeOfDataEnum) {
+    ExtensibilityFormTypeOfDataEnum["StringData"] = "StringData";
+    ExtensibilityFormTypeOfDataEnum["IntegerData"] = "IntegerData";
+    ExtensibilityFormTypeOfDataEnum["BooleanData"] = "BooleanData";
+    ExtensibilityFormTypeOfDataEnum["DateData"] = "DateData";
+    ExtensibilityFormTypeOfDataEnum["TimeData"] = "TimeData";
+    ExtensibilityFormTypeOfDataEnum["DateTimeData"] = "DateTimeData";
+    ExtensibilityFormTypeOfDataEnum["Unknown"] = "Unknown";
+})(ExtensibilityFormTypeOfDataEnum = exports.ExtensibilityFormTypeOfDataEnum || (exports.ExtensibilityFormTypeOfDataEnum = {}));
 //# sourceMappingURL=IExtensibilityForm.js.map

package/lib/domain/model/extensibilityForm/index.js

@@ -3,6 +3,7 @@ function __export(m) {
     for (var p in m) if (!exports.hasOwnProperty(p)) exports[p] = m[p];
 }
 Object.defineProperty(exports, "__esModule", { value: true });
+__export(require("./IExtensibilityForm"));
 __export(require("./ExtensibilityFormDataLine"));
 __export(require("./VoidedExtensibilityFormDataLineDecorator"));
 __export(require("./BaseExtensibilityFormDataLineDecorator"));

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

@@ -7,6 +7,8 @@ import { ITransactionLineTaxes } from "../item";
 import { TaxOverrideLine } from "../taxOverride/TaxOverrideLine";
 import { IFeeLine, IFeeSubline, IFulfillmentGroupFee } from "./IFeeLine";
 export declare abstract class BaseFeeLineDecorator extends BaseLineDecorator<IFeeLine> implements IFeeLine {
+    private _lineSavings;
+    static getLineSavingsFromJsonObject(transactionLineJsonObject: any): Money;
     static getSublinesFromJsonObject(transactionLineJsonObject: any): IFeeSubline[];
     setTransactionLineTaxes(transactionLineTaxes: ITransactionLineTaxes, extendedAmount?: Money): IFeeLine;
     setSublines(sublines: IFeeSubline[]): IFeeLine;
@@ -20,8 +22,10 @@ export declare abstract class BaseFeeLineDecorator extends BaseLineDecorator<IFe
     get feeType(): FeeType;
     get feeId(): string;
     get extendedAmount(): Money;
+    get extendedAmountAdjustment(): Money;
     get extendedAmountExcludingTax(): Money;
     get extendedAmountIncludingTax(): Money;
+    get lineSavings(): Money;
     get couldAffectPricing(): boolean;
     get unitAmount(): Money;
     get description(): string;
@@ -49,7 +53,7 @@ export declare abstract class BaseFeeLineDecorator extends BaseLineDecorator<IFe
     get sublineIndexFromReturnCanonicalTransaction(): number;
     get originalTransactionLineReference(): ITransactionLineReferenceType;
     get taxIndicatorOnReceipt(): string;
-    protected constructor(lineDecoratorType: string, decoratedTransactionLine: IFeeLine, annotationDescription: string, annotationSourceType: string, annotationSourceLineNumber?: number, couldDecoratorAffectPricing?: boolean, couldDecoratorAffectTaxation?: boolean);
+    protected constructor(lineDecoratorType: string, decoratedTransactionLine: IFeeLine, annotationDescription: string, annotationSourceType: string, annotationSourceLineNumber?: number, couldDecoratorAffectPricing?: boolean, couldDecoratorAffectTaxation?: boolean, lineSavings?: Money);
     get taxGroupId(): string;
     get taxByAuthority(): IAppliedTax[];
     get taxExemptDisplayName(): string;

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

@@ -4,6 +4,15 @@ const scp_component_business_core_1 = require("@aptos-scp/scp-component-business
 const scp_types_commerce_transaction_1 = require("@aptos-scp/scp-types-commerce-transaction");
 const BaseLineDecorator_1 = require("../../model/BaseLineDecorator");
 class BaseFeeLineDecorator extends BaseLineDecorator_1.BaseLineDecorator {
+    constructor(lineDecoratorType, decoratedTransactionLine, annotationDescription, annotationSourceType, annotationSourceLineNumber, couldDecoratorAffectPricing, couldDecoratorAffectTaxation, lineSavings) {
+        super(lineDecoratorType, decoratedTransactionLine, annotationDescription, annotationSourceType, annotationSourceLineNumber, couldDecoratorAffectPricing, couldDecoratorAffectTaxation);
+        this._lineSavings = lineSavings;
+    }
+    static getLineSavingsFromJsonObject(transactionLineJsonObject) {
+        if (transactionLineJsonObject._lineSavings) {
+            return new scp_component_business_core_1.Money(transactionLineJsonObject._lineSavings);
+        }
+    }
     static getSublinesFromJsonObject(transactionLineJsonObject) {
         var _a;
         return (_a = transactionLineJsonObject._sublines) === null || _a === void 0 ? void 0 : _a.map((subline) => {
@@ -54,12 +63,22 @@ class BaseFeeLineDecorator extends BaseLineDecorator_1.BaseLineDecorator {
     get extendedAmount() {
         return this.decoratedTransactionLine.extendedAmount;
     }
+    get extendedAmountAdjustment() {
+        var _a;
+        return this.decoratedTransactionLine.extendedAmount
+            ? (_a = this.extendedAmount) === null || _a === void 0 ? void 0 : _a.minus(this.decoratedTransactionLine.extendedAmount) : this.extendedAmount;
+    }
     get extendedAmountExcludingTax() {
         return this.decoratedTransactionLine.extendedAmountExcludingTax;
     }
     get extendedAmountIncludingTax() {
         return this.decoratedTransactionLine.extendedAmountIncludingTax;
     }
+    get lineSavings() {
+        var _a;
+        return this._lineSavings
+            ? (_a = this.decoratedTransactionLine.lineSavings) === null || _a === void 0 ? void 0 : _a.plus(this._lineSavings) : this.decoratedTransactionLine.lineSavings;
+    }
     get couldAffectPricing() {
         return this.decoratedTransactionLine.couldAffectPricing;
     }
@@ -141,9 +160,6 @@ class BaseFeeLineDecorator extends BaseLineDecorator_1.BaseLineDecorator {
     get taxIndicatorOnReceipt() {
         return this.decoratedTransactionLine.taxIndicatorOnReceipt;
     }
-    constructor(lineDecoratorType, decoratedTransactionLine, annotationDescription, annotationSourceType, annotationSourceLineNumber, couldDecoratorAffectPricing, couldDecoratorAffectTaxation) {
-        super(lineDecoratorType, decoratedTransactionLine, annotationDescription, annotationSourceType, annotationSourceLineNumber, couldDecoratorAffectPricing, couldDecoratorAffectTaxation);
-    }
     get taxGroupId() {
         return this.decoratedTransactionLine.taxGroupId;
     }
@@ -194,6 +210,7 @@ class BaseFeeLineDecorator extends BaseLineDecorator_1.BaseLineDecorator {
     }
     clone() {
         const newBaseFeeLineDecorator = super.clone();
+        newBaseFeeLineDecorator._lineSavings = this._lineSavings;
         return newBaseFeeLineDecorator;
     }
 }

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

@@ -60,6 +60,9 @@ export declare class FeeLine extends BaseTransactionLine implements IFeeLine, IC
     private _lineNumberFromReturnTransaction?;
     private _originalTaxOverride?;
     private _taxIndicatorOnReceipt?;
+    private _accountingCurrency?;
+    private _extendedAmountAdjustment?;
+    private _lineSavings?;
     static isPickupFulfilmentTransaction?: boolean;
     /**
      * The create method is called by the transaction line factory to create an instance and initialize it from the
@@ -75,6 +78,9 @@ export declare class FeeLine extends BaseTransactionLine implements IFeeLine, IC
     static create(lineNumber: number, lineType: string, uiBusinessEvent: UiBusinessEvent, collectedData: Readonly<Map<string, any>>): FeeLine;
     static createFromJsonObject(transactionLineJsonObj: any): FeeLine;
     get quantity(): Quantity;
+    get accountingCurrency(): string;
+    get extendedAmountAdjustment(): Money;
+    get lineSavings(): Money;
     get unitPrice(): Price;
     /**
      * @deprecated This will no longer be used in the future. Use the direct line instead.
@@ -146,6 +152,7 @@ export declare class FeeLine extends BaseTransactionLine implements IFeeLine, IC
     get sublines(): IFeeSubline[];
     get prepaidAmount(): Money;
     get prepaidTaxAmount(): Money;
+    static lineSavingsFromJsonObject(transactionLineJsonObj: any): Money;
     static feeTypeFromJsonObject(transactionLineJsonObj: any): FeeType;
     static feeTypeFromCollectedData(collectedData: Readonly<Map<string, any>>): FeeType;
     static taxGroupIdFromJsonObject(transactionLineJsonObj: any): string;
@@ -167,7 +174,7 @@ export declare class FeeLine extends BaseTransactionLine implements IFeeLine, IC
     setTransactionLineTaxes(transactionLineTaxes: ITransactionLineTaxes, extendedAmount?: Money): IFeeLine;
     updateExtendedAmountExcludingTax(amount: Money): ITransactionLine;
     updateExtendedAmountIncludingTax(amount: Money): ITransactionLine;
-    protected constructor(lineNumber: number, lineType: string, feeType: FeeType, extendedAmount?: Money, extendedAmountExcludingTax?: Money, extendedAmountIncludingTax?: Money, feeId?: string, customFeeType?: string, unitAmount?: Money, quantity?: Quantity, description?: string, externalId?: string, longDescription?: string, departmentId?: string, departmentGroupId?: string, orderReferenceId?: string, feesByFulfillmentGroup?: IFulfillmentGroupFee[], fulfillmentGroupIds?: string[], taxGroupId?: string, autoApplied?: boolean, quantityAllowed?: boolean, itemLineReference?: ISameTransactionLineReference, percent?: string, maximumAmount?: Money, returnRule?: string);
+    protected constructor(lineNumber: number, lineType: string, feeType: FeeType, extendedAmount?: Money, extendedAmountExcludingTax?: Money, extendedAmountIncludingTax?: Money, accountingCurrency?: string, feeId?: string, customFeeType?: string, unitAmount?: Money, quantity?: Quantity, description?: string, externalId?: string, longDescription?: string, departmentId?: string, departmentGroupId?: string, orderReferenceId?: string, feesByFulfillmentGroup?: IFulfillmentGroupFee[], fulfillmentGroupIds?: string[], taxGroupId?: string, autoApplied?: boolean, quantityAllowed?: boolean, itemLineReference?: ISameTransactionLineReference, percent?: string, maximumAmount?: Money, returnRule?: string, lineSavings?: Money);
     protected clone(): BaseTransactionLine;
     protected newTransactionLine(): BaseTransactionLine;
     protected loadFromJsonObject(transactionLineJsonObj: any): void;

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

@@ -11,8 +11,9 @@ 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) {
+    constructor(lineNumber, lineType, feeType, extendedAmount, extendedAmountExcludingTax, extendedAmountIncludingTax, accountingCurrency, feeId, customFeeType, unitAmount, quantity, description, externalId, longDescription, departmentId, departmentGroupId, orderReferenceId, feesByFulfillmentGroup, fulfillmentGroupIds, taxGroupId, autoApplied, quantityAllowed, itemLineReference, percent, maximumAmount, returnRule, lineSavings) {
         super(lineNumber, lineType, extendedAmount, extendedAmountExcludingTax, extendedAmountIncludingTax);
+        this._accountingCurrency = accountingCurrency;
         this._feeType = feeType;
         this._feeId = feeId;
         this._customFeeType = customFeeType;
@@ -37,6 +38,7 @@ class FeeLine extends BaseTransactionLine_1.BaseTransactionLine {
         this._sublines = undefined;
         this._prepaidAmount = undefined;
         this._prepaidTaxAmount = undefined;
+        this._lineSavings = lineSavings;
     }
     /**
      * The create method is called by the transaction line factory to create an instance and initialize it from the
@@ -50,29 +52,49 @@ class FeeLine extends BaseTransactionLine_1.BaseTransactionLine {
      * @return {FeeLine}
      */
     static create(lineNumber, lineType, uiBusinessEvent, collectedData) {
+        var _a;
         this.isPickupFulfilmentTransaction = uiBusinessEvent.type === UIBusinessEventTypes_1.ORDER_ITEM_PICKUP_EVENT;
         const extendedAmount = this.getExtendedAmountFromCollectedData(collectedData);
         const extendedAmountExcludingTax = this.getExtendedAmountExcludingTaxFromCollectedData(collectedData);
         const extendedAmountIncludingTax = this.getExtendedAmountIncludingTaxFromCollectedData(collectedData);
         const feeType = this.feeTypeFromCollectedData(collectedData);
-        let feeLine = new FeeLine(lineNumber, lineType, feeType, extendedAmount, extendedAmountExcludingTax, extendedAmountIncludingTax);
+        let accountingCurrency = collectedData.get("accountingCurrency");
+        accountingCurrency = ((_a = extendedAmount) === null || _a === void 0 ? void 0 : _a.currency) || accountingCurrency;
+        let feeLine = new FeeLine(lineNumber, lineType, feeType, extendedAmount, extendedAmountExcludingTax, extendedAmountIncludingTax, accountingCurrency);
         feeLine.loadFromCollectedData(collectedData);
         return feeLine;
     }
     static createFromJsonObject(transactionLineJsonObj) {
+        var _a, _b;
         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);
+        const accountingCurrency = ((_a = extendedAmount) === null || _a === void 0 ? void 0 : _a.currency) || ((_b = FeeLine.lineSavingsFromJsonObject(transactionLineJsonObj)) === null || _b === void 0 ? void 0 : _b.currency);
+        const feeLine = new FeeLine(lineNumber, lineType, feeType, extendedAmount, extendedAmountExcludingTax, extendedAmountIncludingTax, accountingCurrency);
         feeLine.loadFromJsonObject(transactionLineJsonObj);
         return feeLine;
     }
     get quantity() {
         return this._quantity;
     }
+    get accountingCurrency() {
+        return this._accountingCurrency;
+    }
+    get extendedAmountAdjustment() {
+        if (!this._extendedAmountAdjustment && this._accountingCurrency) {
+            this._extendedAmountAdjustment = new scp_component_business_core_1.Money(0, this._accountingCurrency);
+        }
+        return this._extendedAmountAdjustment;
+    }
+    get lineSavings() {
+        if (!this._lineSavings && this._accountingCurrency) {
+            this._lineSavings = new scp_component_business_core_1.Money(0, this._accountingCurrency);
+        }
+        return this._lineSavings;
+    }
     get unitPrice() {
         return this._unitPrice;
     }
@@ -255,6 +277,11 @@ class FeeLine extends BaseTransactionLine_1.BaseTransactionLine {
     get prepaidTaxAmount() {
         return this._prepaidTaxAmount;
     }
+    static lineSavingsFromJsonObject(transactionLineJsonObj) {
+        return transactionLineJsonObj._lineSavings
+            ? scp_component_business_core_1.Money.fromJSON(transactionLineJsonObj._lineSavings)
+            : undefined;
+    }
     static feeTypeFromJsonObject(transactionLineJsonObj) {
         return transactionLineJsonObj._feeType;
     }
@@ -435,10 +462,11 @@ class FeeLine extends BaseTransactionLine_1.BaseTransactionLine {
         newTransactionFeeLine._lineNumberFromReturnTransaction = this._lineNumberFromReturnTransaction;
         newTransactionFeeLine._originalTaxOverride = this._originalTaxOverride;
         newTransactionFeeLine._taxIndicatorOnReceipt = this._taxIndicatorOnReceipt;
+        newTransactionFeeLine._lineSavings = this._lineSavings;
         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);
+        return new FeeLine(this.lineNumber, this.lineType, this._feeType, this.extendedAmount, this.extendedAmountExcludingTax, this.extendedAmountIncludingTax, this._accountingCurrency, 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, this._lineSavings);
     }
     loadFromJsonObject(transactionLineJsonObj) {
         super.loadFromJsonObject(transactionLineJsonObj);
@@ -507,6 +535,9 @@ class FeeLine extends BaseTransactionLine_1.BaseTransactionLine {
             ? new scp_component_business_core_1.Money(transactionLineJsonObj._prepaidTaxAmount)
             : undefined;
         this.loadFeesByFulfillmentGroupFromJsonObject(transactionLineJsonObj);
+        if (!this._lineSavings && transactionLineJsonObj._lineSavings) {
+            this._lineSavings = scp_component_business_core_1.Money.fromJSON(transactionLineJsonObj._lineSavings);
+        }
     }
     loadTaxInformation(transactionLineJsonObj) {
         this._taxGroupId = transactionLineJsonObj._taxGroupId;

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

@@ -0,0 +1,65 @@
+import { Money, Price } from "@aptos-scp/scp-component-business-core";
+import { VerboseDiscountType } from "@aptos-scp/scp-component-pricing";
+import { BaseFeeLineDecorator } from "./BaseFeeLineDecorator";
+import { IFeeLine, IFeeSubline } from "./IFeeLine";
+export declare type DiscountType = VerboseDiscountType;
+export declare class FeeLineBaseDiscountDecorator extends BaseFeeLineDecorator {
+    /**
+     * Line savings amount just for this decorator, not including cumulative line savings from child decorated lines.
+     */
+    adjustmentAmount: Money;
+    private _ruleId;
+    private _percent;
+    private _discountAmount;
+    private _sublines;
+    private _newExtendedAmount;
+    private _discountName;
+    private _discountDescription;
+    private _discountType;
+    private _replacementUnitPrice;
+    private _replacementAmount;
+    private _isEmployeeDiscount;
+    private _extendedAmountBeforeAdjustment;
+    private _isFastDiscount;
+    private _presentation;
+    private _aggregationId;
+    constructor(decoratorType: string, replacementUnitPrice: Price, newExtendedAmount: Money, feeLine: IFeeLine, lineSavings: Money, adjustmentAmount: Money, annotationDescription: string, annotationSourceType: string, discountAmount?: Money, percent?: string, discountName?: string, discountDescription?: string, discountType?: VerboseDiscountType, sublines?: IFeeSubline[], replacementAmount?: Money, isEmployeeDiscount?: boolean, ruleId?: string, extendedAmountBeforeAdjustment?: Money, isFastDiscount?: boolean, presentation?: IFeeLine, aggregationId?: string);
+    get unitPriceBeforeDiscounts(): Price;
+    /**
+     * Percent adjustment if a percentage was applied
+     * @returns {number}
+     */
+    get percentAdjustment(): string;
+    /**
+     * The amount of the modification, applied to the extended amount, if an amount off discount was applied
+     * @returns {Money}
+     */
+    get discountAmountAdjustment(): Money;
+    setSublines(sublines: IFeeSubline[]): IFeeLine;
+    get sublines(): IFeeSubline[];
+    get discountName(): string;
+    get discountDescription(): string;
+    get discountType(): DiscountType;
+    get discountAmount(): Money;
+    get replacementUnitPrice(): Price;
+    get replacementAmount(): Money;
+    get newExtendedAmount(): Money;
+    get percent(): string;
+    get unitPrice(): Price;
+    get unitPriceExcludingTransactionDiscounts(): Price;
+    get extendedAmount(): Money;
+    get extendedAmountExcludingTax(): Money;
+    get extendedAmountIncludingTax(): Money;
+    get ruleId(): string;
+    get isEmployeeDiscount(): boolean;
+    get isFastDiscount(): boolean;
+    /**
+     * Extended amount of the line before this pricing adjustment.
+     */
+    get extendedAmountBeforeAdjustment(): Money;
+    get presentation(): IFeeLine;
+    get aggregationId(): string;
+    updateDecoratedTransactionLine(transactionLine: IFeeLine): IFeeLine;
+    protected clone(): FeeLineBaseDiscountDecorator;
+    protected newTransactionLine(): FeeLineBaseDiscountDecorator;
+}

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

@@ -0,0 +1,155 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const scp_component_store_selling_core_1 = require("@aptos-scp/scp-component-store-selling-core");
+const ErrorCodes_1 = require("../../../config/ErrorCodes");
+const BaseFeeLineDecorator_1 = require("./BaseFeeLineDecorator");
+class FeeLineBaseDiscountDecorator extends BaseFeeLineDecorator_1.BaseFeeLineDecorator {
+    constructor(decoratorType, replacementUnitPrice, newExtendedAmount, feeLine, lineSavings, adjustmentAmount, annotationDescription, annotationSourceType, discountAmount, percent, discountName, discountDescription, discountType, sublines, replacementAmount, isEmployeeDiscount, ruleId, extendedAmountBeforeAdjustment, isFastDiscount, presentation, aggregationId) {
+        super(decoratorType, feeLine, annotationDescription, annotationSourceType, undefined, undefined, undefined, lineSavings);
+        if (!replacementUnitPrice) {
+            throw new scp_component_store_selling_core_1.PosError(`The replacement unit price is required on FeeLineBaseDiscountDecorator.`, ErrorCodes_1.SSF_DECORATOR_ERROR_CODE);
+        }
+        if (!newExtendedAmount) {
+            throw new scp_component_store_selling_core_1.PosError(`The new extended amount is required on FeeLineBaseDiscountDecorator.`, ErrorCodes_1.SSF_DECORATOR_ERROR_CODE);
+        }
+        if (!annotationSourceType) {
+            throw new scp_component_store_selling_core_1.PosError(`The annotated source type is required on FeeLineBaseDiscountDecorator.`, ErrorCodes_1.SSF_DECORATOR_ERROR_CODE);
+        }
+        this.adjustmentAmount = adjustmentAmount;
+        this._replacementUnitPrice = replacementUnitPrice;
+        if (replacementAmount) {
+            this._replacementAmount = replacementAmount;
+        }
+        this._newExtendedAmount = newExtendedAmount;
+        this._discountName = discountName;
+        this._discountDescription = discountDescription;
+        this._discountType = discountType;
+        this._discountAmount = discountAmount;
+        this._percent = percent;
+        this._sublines = sublines;
+        this._isEmployeeDiscount = isEmployeeDiscount;
+        this._ruleId = ruleId;
+        this._extendedAmountBeforeAdjustment = extendedAmountBeforeAdjustment;
+        this._isFastDiscount = isFastDiscount;
+        this._presentation = presentation;
+        this._aggregationId = aggregationId;
+    }
+    get unitPriceBeforeDiscounts() {
+        if (this.decoratedTransactionLine instanceof FeeLineBaseDiscountDecorator) {
+            return this.decoratedTransactionLine.unitPriceBeforeDiscounts;
+        }
+        else {
+            return this.decoratedTransactionLine.unitPrice;
+        }
+    }
+    /**
+     * Percent adjustment if a percentage was applied
+     * @returns {number}
+     */
+    get percentAdjustment() {
+        return this._percent;
+    }
+    /**
+     * The amount of the modification, applied to the extended amount, if an amount off discount was applied
+     * @returns {Money}
+     */
+    get discountAmountAdjustment() {
+        return this._discountAmount;
+    }
+    setSublines(sublines) {
+        const newLine = this.clone();
+        newLine._sublines = sublines;
+        return newLine;
+    }
+    get sublines() {
+        return this._sublines;
+    }
+    get discountName() {
+        return this._discountName;
+    }
+    get discountDescription() {
+        return this._discountDescription;
+    }
+    get discountType() {
+        return this._discountType;
+    }
+    get discountAmount() {
+        return this._discountAmount;
+    }
+    get replacementUnitPrice() {
+        return this._replacementUnitPrice;
+    }
+    get replacementAmount() {
+        return this._replacementAmount;
+    }
+    get newExtendedAmount() {
+        return this._newExtendedAmount;
+    }
+    get percent() {
+        return this._percent;
+    }
+    get unitPrice() {
+        return this._replacementUnitPrice;
+    }
+    get unitPriceExcludingTransactionDiscounts() {
+        return this.unitPrice;
+    }
+    get extendedAmount() {
+        return this._newExtendedAmount;
+    }
+    get extendedAmountExcludingTax() {
+        return this.decoratedTransactionLine.extendedAmountExcludingTax;
+    }
+    get extendedAmountIncludingTax() {
+        return this.decoratedTransactionLine.extendedAmountIncludingTax;
+    }
+    get ruleId() {
+        return this._ruleId;
+    }
+    get isEmployeeDiscount() {
+        return this._isEmployeeDiscount;
+    }
+    get isFastDiscount() {
+        return this._isFastDiscount;
+    }
+    /**
+     * Extended amount of the line before this pricing adjustment.
+     */
+    get extendedAmountBeforeAdjustment() {
+        return this._extendedAmountBeforeAdjustment;
+    }
+    get presentation() {
+        return this._presentation;
+    }
+    get aggregationId() {
+        return this._aggregationId;
+    }
+    updateDecoratedTransactionLine(transactionLine) {
+        const feeLine = super.updateDecoratedTransactionLine(transactionLine);
+        return feeLine;
+    }
+    clone() {
+        const newFeeLineBaseDiscountDecorator = super.clone();
+        newFeeLineBaseDiscountDecorator._replacementUnitPrice = this._replacementUnitPrice;
+        newFeeLineBaseDiscountDecorator._replacementAmount = this._replacementAmount;
+        newFeeLineBaseDiscountDecorator._newExtendedAmount = this._newExtendedAmount;
+        newFeeLineBaseDiscountDecorator._discountName = this._discountName;
+        newFeeLineBaseDiscountDecorator._discountDescription = this._discountDescription;
+        newFeeLineBaseDiscountDecorator._discountType = this._discountType;
+        newFeeLineBaseDiscountDecorator._discountAmount = this._discountAmount;
+        newFeeLineBaseDiscountDecorator._percent = this._percent;
+        newFeeLineBaseDiscountDecorator._sublines = this._sublines;
+        newFeeLineBaseDiscountDecorator._ruleId = this._ruleId;
+        newFeeLineBaseDiscountDecorator._isEmployeeDiscount = this._isEmployeeDiscount;
+        newFeeLineBaseDiscountDecorator._extendedAmountBeforeAdjustment = this._extendedAmountBeforeAdjustment;
+        newFeeLineBaseDiscountDecorator._isFastDiscount = this._isFastDiscount;
+        newFeeLineBaseDiscountDecorator._presentation = this._presentation;
+        newFeeLineBaseDiscountDecorator._aggregationId = this._aggregationId;
+        return newFeeLineBaseDiscountDecorator;
+    }
+    newTransactionLine() {
+        return new FeeLineBaseDiscountDecorator(this.lineDecoratorType, this._replacementUnitPrice, this._newExtendedAmount, this.decoratedTransactionLine, this.lineSavings, this.adjustmentAmount, this.annotationDescription, this.annotationSourceType, this._discountAmount, this._percent, this._discountName, this._discountDescription, this._discountType, this._sublines, this._replacementAmount, this._isEmployeeDiscount, this._ruleId, this._extendedAmountBeforeAdjustment, this._isFastDiscount, this._presentation, this._aggregationId);
+    }
+}
+exports.FeeLineBaseDiscountDecorator = FeeLineBaseDiscountDecorator;
+//# sourceMappingURL=FeeLineBaseDiscountDecorator.js.map

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

@@ -0,0 +1,41 @@
+import { Money, Price } from "@aptos-scp/scp-component-business-core";
+import { ITransactionLine, ITransactionLineFactory } from "@aptos-scp/scp-component-store-selling-core";
+import { SourceIndicator } from "@aptos-scp/scp-types-commerce-transaction";
+import { ICampaignInformation } from "@aptos-scp/scp-component-pricing";
+import { IFeeLine, IFeeSubline } from "./IFeeLine";
+import { DiscountType, FeeLineBaseDiscountDecorator } from "./FeeLineBaseDiscountDecorator";
+export declare const DECORATOR_TYPE_FEE_LINE_PROMO: string;
+export declare function isFeeLinePromotionDecorator(transactionLine: ITransactionLine): transactionLine is FeeLinePromotionDecorator;
+export declare class FeeLinePromotionDecorator extends FeeLineBaseDiscountDecorator {
+    private _promoName;
+    private _promoDescription;
+    private _promotionId;
+    private _promotionType;
+    private _couponCode;
+    private _isAutoCoupon;
+    private _singleUseCoupon;
+    private _campaign?;
+    /**
+     * @obsolete
+     */
+    private _rewardCouponId;
+    private _sourceIndicator;
+    static createFromJsonObject(transactionLineJsonObj: any, transactionLineFactory: ITransactionLineFactory): FeeLinePromotionDecorator;
+    constructor(ruleId: string, promotionType: string, replacementUnitPrice: Price, newExtendedAmount: Money, feeLine: IFeeLine, lineSavings: Money, adjustmentAmount: Money, annotationDescription: string, annotationSourceType: string, promoName?: string, promoDescription?: string, promotionId?: string, discountAmount?: Money, percent?: string, discountName?: string, discountDescription?: string, discountType?: DiscountType, rewardCouponId?: string, sublines?: IFeeSubline[], replacementAmount?: Money, couponCode?: string, isAutoCoupon?: boolean, sourceIndicator?: SourceIndicator, extendedAmountBeforeAdjustment?: Money, singleUseCoupon?: string, presentation?: IFeeLine, aggregationId?: string, isEmployeeDiscount?: boolean, campaign?: ICampaignInformation);
+    get sourceIndicator(): SourceIndicator;
+    get promoName(): string;
+    get promoDescription(): string;
+    get promotionId(): string;
+    get promotionType(): string;
+    /**
+     * @obsolete the ID of the coupon that triggered the promo
+     * @returns {string}
+     */
+    get rewardCouponId(): string;
+    get couponCode(): string;
+    get isAutoCoupon(): boolean;
+    get campaign(): ICampaignInformation;
+    get singleUseCoupon(): string;
+    protected clone(): FeeLinePromotionDecorator;
+    protected newTransactionLine(): FeeLinePromotionDecorator;
+}

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

@@ -0,0 +1,126 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const scp_component_business_core_1 = require("@aptos-scp/scp-component-business-core");
+const BaseFeeLineDecorator_1 = require("./BaseFeeLineDecorator");
+const FeeLineBaseDiscountDecorator_1 = require("./FeeLineBaseDiscountDecorator");
+exports.DECORATOR_TYPE_FEE_LINE_PROMO = "FEE_LINE_PROMO_DECORATOR";
+function isFeeLinePromotionDecorator(transactionLine) {
+    return transactionLine.lineDecoratorType === exports.DECORATOR_TYPE_FEE_LINE_PROMO;
+}
+exports.isFeeLinePromotionDecorator = isFeeLinePromotionDecorator;
+class FeeLinePromotionDecorator extends FeeLineBaseDiscountDecorator_1.FeeLineBaseDiscountDecorator {
+    constructor(ruleId, promotionType, replacementUnitPrice, newExtendedAmount, feeLine, lineSavings, adjustmentAmount, annotationDescription, annotationSourceType, promoName, promoDescription, promotionId, discountAmount, percent, discountName, discountDescription, discountType, rewardCouponId, sublines, replacementAmount, couponCode, isAutoCoupon, sourceIndicator, extendedAmountBeforeAdjustment, singleUseCoupon, presentation, aggregationId, isEmployeeDiscount, campaign) {
+        super(exports.DECORATOR_TYPE_FEE_LINE_PROMO, replacementUnitPrice, newExtendedAmount, feeLine, lineSavings, adjustmentAmount, annotationDescription, annotationSourceType, discountAmount, percent, discountName, discountDescription, discountType, sublines, replacementAmount, isEmployeeDiscount, ruleId, extendedAmountBeforeAdjustment, undefined, presentation, aggregationId);
+        this.adjustmentAmount = adjustmentAmount;
+        this._promoName = promoName;
+        this._promoDescription = promoDescription;
+        this._promotionId = promotionId;
+        this._promotionType = promotionType;
+        this._rewardCouponId = rewardCouponId;
+        this._couponCode = couponCode;
+        this._isAutoCoupon = isAutoCoupon;
+        this._sourceIndicator = sourceIndicator;
+        this._singleUseCoupon = singleUseCoupon;
+        this._campaign = campaign;
+    }
+    static createFromJsonObject(transactionLineJsonObj, transactionLineFactory) {
+        const decoratedTransactionLineJsonObj = BaseFeeLineDecorator_1.BaseFeeLineDecorator.getDecoratedTransactionLineJsonObjectFromJsonObject(transactionLineJsonObj);
+        const decoratedFeeLine = transactionLineFactory.createTransactionLineFromJsonObj(decoratedTransactionLineJsonObj);
+        let adjustmentAmount;
+        if (transactionLineJsonObj.adjustmentAmount) {
+            adjustmentAmount = scp_component_business_core_1.Money.fromIMoney(transactionLineJsonObj.adjustmentAmount);
+        }
+        const promoName = transactionLineJsonObj._promoName;
+        const promoDescription = transactionLineJsonObj._promoDescription;
+        const promotionId = transactionLineJsonObj._promotionId;
+        const promotionType = transactionLineJsonObj._promotionType;
+        const replacementUnitPrice = scp_component_business_core_1.Price.fromJSON(transactionLineJsonObj._replacementUnitPrice);
+        let replacementAmount;
+        if (transactionLineJsonObj._replacementAmount) {
+            replacementAmount = scp_component_business_core_1.Money.fromJSON(transactionLineJsonObj._replacementAmount);
+        }
+        const newExtendedAmount = new scp_component_business_core_1.Money(transactionLineJsonObj._newExtendedAmount);
+        const ruleId = transactionLineJsonObj._ruleId;
+        const discountName = transactionLineJsonObj._discountName;
+        const discountDescription = transactionLineJsonObj._discountDescription;
+        const discountType = transactionLineJsonObj._discountType;
+        let discountAmount;
+        if (transactionLineJsonObj._discountAmount) {
+            discountAmount = scp_component_business_core_1.Money.fromJSON(transactionLineJsonObj._discountAmount);
+        }
+        const percent = transactionLineJsonObj._percent;
+        const rewardCouponId = transactionLineJsonObj._rewardCouponId;
+        const lineSavings = BaseFeeLineDecorator_1.BaseFeeLineDecorator.getLineSavingsFromJsonObject(transactionLineJsonObj);
+        const annotationDescription = BaseFeeLineDecorator_1.BaseFeeLineDecorator.getAnnotationDescriptionFromJsonObject(transactionLineJsonObj);
+        const annotationSourceType = BaseFeeLineDecorator_1.BaseFeeLineDecorator.getAnnotationSourceTypeFromJsonObject(transactionLineJsonObj);
+        const sublines = BaseFeeLineDecorator_1.BaseFeeLineDecorator.getSublinesFromJsonObject(transactionLineJsonObj);
+        const couponCode = transactionLineJsonObj._couponCode;
+        const isAutoCoupon = transactionLineJsonObj._isAutoCoupon;
+        const singleUseCoupon = transactionLineJsonObj._singleUseCoupon;
+        const sourceIndicator = transactionLineJsonObj._sourceIndicator;
+        const extendedAmountBeforeAdjustment = transactionLineJsonObj._extendedAmountBeforeAdjustment
+            ? scp_component_business_core_1.Money.fromJSON(transactionLineJsonObj._extendedAmountBeforeAdjustment)
+            : undefined;
+        const presentation = transactionLineJsonObj._presentation
+            ? FeeLinePromotionDecorator.createFromJsonObject(transactionLineJsonObj._presentation, transactionLineFactory)
+            : undefined;
+        const aggregationId = transactionLineJsonObj._aggregationId;
+        const isEmployeeDiscount = transactionLineJsonObj._isEmployeeDiscount;
+        const campaign = transactionLineJsonObj._campaign;
+        const feeLinePromotionDecorator = new FeeLinePromotionDecorator(ruleId, promotionType, replacementUnitPrice, newExtendedAmount, decoratedFeeLine, lineSavings, adjustmentAmount, annotationDescription, annotationSourceType, promoName, promoDescription, promotionId, discountAmount, percent, discountName, discountDescription, discountType, rewardCouponId, sublines, replacementAmount, couponCode, isAutoCoupon, sourceIndicator, extendedAmountBeforeAdjustment, singleUseCoupon, presentation, aggregationId, isEmployeeDiscount, campaign);
+        return feeLinePromotionDecorator;
+    }
+    get sourceIndicator() {
+        return this._sourceIndicator;
+    }
+    get promoName() {
+        return this._promoName;
+    }
+    get promoDescription() {
+        return this._promoDescription;
+    }
+    get promotionId() {
+        return this._promotionId; // can be undefined
+    }
+    get promotionType() {
+        return this._promotionType;
+    }
+    /**
+     * @obsolete the ID of the coupon that triggered the promo
+     * @returns {string}
+     */
+    get rewardCouponId() {
+        return this._rewardCouponId;
+    }
+    get couponCode() {
+        return this._couponCode;
+    }
+    get isAutoCoupon() {
+        return this._isAutoCoupon;
+    }
+    get campaign() {
+        return this._campaign;
+    }
+    get singleUseCoupon() {
+        return this._singleUseCoupon;
+    }
+    clone() {
+        const newFeeLinePromotionDecorator = super.clone();
+        newFeeLinePromotionDecorator._promoName = this._promoName;
+        newFeeLinePromotionDecorator._promoDescription = this._promoDescription;
+        newFeeLinePromotionDecorator._promotionId = this._promotionId;
+        newFeeLinePromotionDecorator._promotionType = this._promotionType;
+        newFeeLinePromotionDecorator._rewardCouponId = this._rewardCouponId;
+        newFeeLinePromotionDecorator._couponCode = this._couponCode;
+        newFeeLinePromotionDecorator._isAutoCoupon = this._isAutoCoupon;
+        newFeeLinePromotionDecorator._singleUseCoupon = this._singleUseCoupon;
+        newFeeLinePromotionDecorator._sourceIndicator = this._sourceIndicator;
+        newFeeLinePromotionDecorator._campaign = this._campaign;
+        return newFeeLinePromotionDecorator;
+    }
+    newTransactionLine() {
+        return new FeeLinePromotionDecorator(this.ruleId, this._promotionType, this.replacementUnitPrice, this.newExtendedAmount, this.decoratedTransactionLine, this.lineSavings, this.adjustmentAmount, this.annotationDescription, this.annotationSourceType, this._promoName, this._promoDescription, this._promotionId, this.discountAmount, this.percent, this.discountName, this.discountDescription, this.discountType, this._rewardCouponId, this.sublines, this.replacementAmount, this.couponCode, this.isAutoCoupon, this.sourceIndicator, this.extendedAmountBeforeAdjustment, this.singleUseCoupon, this.presentation, this.aggregationId, this.isEmployeeDiscount, this.campaign);
+    }
+}
+exports.FeeLinePromotionDecorator = FeeLinePromotionDecorator;
+//# sourceMappingURL=FeeLinePromotionDecorator.js.map

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

@@ -68,6 +68,8 @@ export interface IFeeLine extends ITransactionLine, IVoidableLine {
     readonly lineNumberFromReturnTransaction?: number;
     readonly unitAmountBeforeOverride?: Money;
     readonly taxIndicatorOnReceipt?: string;
+    readonly lineSavings?: Money;
+    readonly extendedAmountAdjustment?: Money;
     setTransactionLineTaxes(transactionLineTaxes: ITransactionLineTaxes, extendedAmount?: Money): IFeeLine;
     setSublines(sublines: IFeeSubline[]): IFeeLine;
     setTaxExemptInformation(taxExemptLine: ItemTaxExemptLine | TransactionTaxExemptLine, preTaxExemptDetails: IAppliedTax[]): IFeeLine;

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

@@ -11,3 +11,4 @@ export * from "./FeeLineTaxExemptDecorator";
 export * from "./FeeLineTaxOverrideDecorator";
 export * from "./FeeLinePricingExtendedAmountDecorator";
 export * from "./FeeLineOriginalPricingAdjustmentDecorator";
+export * from "./FeeLinePromotionDecorator";

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

@@ -14,4 +14,5 @@ __export(require("./FeeLineTaxExemptDecorator"));
 __export(require("./FeeLineTaxOverrideDecorator"));
 __export(require("./FeeLinePricingExtendedAmountDecorator"));
 __export(require("./FeeLineOriginalPricingAdjustmentDecorator"));
+__export(require("./FeeLinePromotionDecorator"));
 //# sourceMappingURL=index.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aptos-scp/scp-component-store-selling-features-domain-model",
-  "version": "1.41.2",
+  "version": "1.42.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",
@@ -54,7 +54,7 @@
   "peerDependencies": {
     "@aptos-scp/scp-component-business-core": "^1.12.7",
     "@aptos-scp/scp-component-logging": "^2.1.16",
-    "@aptos-scp/scp-component-pricing": "^7.61.0",
+    "@aptos-scp/scp-component-pricing": "^7.62.0",
     "@aptos-scp/scp-component-store-items": "^1.19.0",
     "@aptos-scp/scp-component-store-selling-core": "^18.9.3",
     "@aptos-scp/scp-component-taxation": "^5.27.3",
@@ -62,7 +62,7 @@
     "@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.9.0",
-    "@aptos-scp/scp-types-commerce-transaction": "^1.69.1",
+    "@aptos-scp/scp-types-commerce-transaction": "^1.70.0",
     "@aptos-scp/scp-types-customer": "^3.7.0",
     "@aptos-scp/scp-types-einvoice": "^1.17.0",
     "@aptos-scp/scp-types-inventory": "^2.0.0",
@@ -76,7 +76,7 @@
     "@aptos-scp/scp-component-business-core": "^1.12.7",
     "@aptos-scp/scp-component-commit-configs": "^4.1.3",
     "@aptos-scp/scp-component-logging": "^2.1.16",
-    "@aptos-scp/scp-component-pricing": "^7.61.0",
+    "@aptos-scp/scp-component-pricing": "^7.62.0",
     "@aptos-scp/scp-component-rn-circuit-breaker": "^1.0.15",
     "@aptos-scp/scp-component-store-items": "^1.19.0",
     "@aptos-scp/scp-component-store-selling-core": "^18.9.3",
@@ -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.9.0",
-    "@aptos-scp/scp-types-commerce-transaction": "^1.69.1",
+    "@aptos-scp/scp-types-commerce-transaction": "^1.70.0",
     "@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",