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

package/lib/domain/model/discounts/ManualDiscountLineModificationDecorator.js

@@ -0,0 +1,143 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const scp_component_business_core_1 = require("@aptos-scp/scp-component-business-core");
+const BaseManualDiscountLineDecorator_1 = require("./BaseManualDiscountLineDecorator");
+const DISCOUNT_AMOUNT_ANNOTATION_SOURCE_TYPE = "DiscountAmount";
+exports.DECORATOR_TYPE_MANUAL_DISCOUNT_CHANGE = "MANUAL_DISCOUNT_CHANGE_DECORATOR_TYPE";
+function isManualDiscountModificationDecorator(transactionLine) {
+    return (transactionLine.lineDecoratorType ===
+        exports.DECORATOR_TYPE_MANUAL_DISCOUNT_CHANGE);
+}
+exports.isManualDiscountModificationDecorator = isManualDiscountModificationDecorator;
+class ManualDiscountLineModificationDecorator extends BaseManualDiscountLineDecorator_1.BaseManualDiscountLineDecorator {
+    constructor(manualDiscountLine, annotationSourceLineNumber, newAmount, newPercent, newReplacementUnitPrice, newDiscountType, newReasonCode, newReasonDescription, newReasonListType, newCouponCode, newPricingRuleId, newCompetitivePrice, newCompetitor, newFormOfProof, newCustomCompetitorName, newCustomFormOfProof, newCompetitorCode, newFormOfProofCode, newSupervisorOverrideLineReference, newEntryType) {
+        super(exports.DECORATOR_TYPE_MANUAL_DISCOUNT_CHANGE, manualDiscountLine, undefined, DISCOUNT_AMOUNT_ANNOTATION_SOURCE_TYPE, annotationSourceLineNumber);
+        this._newAmount = newAmount;
+        this._newPercent = newPercent;
+        this._newDiscountType = newDiscountType;
+        this._newReasonCode = newReasonCode;
+        this._newCouponCode = newCouponCode;
+        this._newReasonDescription = newReasonDescription;
+        this._newReasonListType = newReasonListType;
+        this._newPricingRuleId = newPricingRuleId;
+        this._newReplacementUnitPrice = newReplacementUnitPrice;
+        this._newCompetitivePrice = newCompetitivePrice;
+        this._newCompetitor = newCompetitor;
+        this._newFormOfProof = newFormOfProof;
+        this._newCompetitorCode = newCompetitorCode;
+        this._newFormOfProofCode = newFormOfProofCode;
+        this._newCustomCompetitorName = newCustomCompetitorName;
+        this._newCustomFormOfProof = newCustomFormOfProof;
+        this._newSupervisorOverrideLineReference = newSupervisorOverrideLineReference;
+        this._newEntryType = newEntryType;
+    }
+    static createFromJsonObject(transactionLineJsonObj, transactionLineFactory) {
+        const decoratedTransactionLineJsonObj = BaseManualDiscountLineDecorator_1.BaseManualDiscountLineDecorator.getDecoratedTransactionLineJsonObjectFromJsonObject(transactionLineJsonObj);
+        const decoratedItemLine = transactionLineFactory.createTransactionLineFromJsonObj(decoratedTransactionLineJsonObj);
+        const newAmount = transactionLineJsonObj._newAmount && scp_component_business_core_1.Money.fromJSON(transactionLineJsonObj._newAmount);
+        const newPercent = transactionLineJsonObj._newPercent;
+        const newDiscountType = transactionLineJsonObj._newDiscountType;
+        const newReasonCode = transactionLineJsonObj._newReasonCode;
+        const newReasonDescription = transactionLineJsonObj._newReasonDescription;
+        const newReasonListType = transactionLineJsonObj._newReasonListType;
+        const newCouponCode = transactionLineJsonObj._newCouponCode;
+        const newPricingRuleId = transactionLineJsonObj._newPricingRuleId;
+        const newReplacementUnitPrice = transactionLineJsonObj._newReplacementUnitPrice &&
+            scp_component_business_core_1.Price.fromJSON(transactionLineJsonObj._newReplacementUnitPrice);
+        const newCompetitivePrice = transactionLineJsonObj._newCompetitivePrice &&
+            scp_component_business_core_1.Price.fromJSON(transactionLineJsonObj._newCompetitivePrice);
+        const newCompetitor = transactionLineJsonObj._newCompetitor;
+        const newFormOfProof = transactionLineJsonObj._newFormOfProof;
+        const newCompetitorCode = transactionLineJsonObj._newCompetitorCode;
+        const newFormOfProofCode = transactionLineJsonObj._newFormOfProofCode;
+        const newCustomCompetitorName = transactionLineJsonObj._newCustomCompetitorName;
+        const newCustomFormOfProof = transactionLineJsonObj._newCustomFormOfProof;
+        const newSupervisorOverrideLineReference = transactionLineJsonObj._newSupervisorOverrideLineReference;
+        const newEntryType = transactionLineJsonObj._newEntryType;
+        const annotationSourceLineNumber = BaseManualDiscountLineDecorator_1.BaseManualDiscountLineDecorator.getAnnotationSourceLineNumberFromJsonObject(transactionLineJsonObj);
+        const manualDiscountLineModificationDecorator = new ManualDiscountLineModificationDecorator(decoratedItemLine, annotationSourceLineNumber, newAmount, newPercent, newReplacementUnitPrice, newDiscountType, newReasonCode, newReasonDescription, newReasonListType, newCouponCode, newPricingRuleId, newCompetitivePrice, newCompetitor, newFormOfProof, newCustomCompetitorName, newCustomFormOfProof, newCompetitorCode, newFormOfProofCode, newSupervisorOverrideLineReference, newEntryType);
+        return manualDiscountLineModificationDecorator;
+    }
+    get amount() {
+        return this._newAmount;
+    }
+    get percent() {
+        return this._newPercent;
+    }
+    get pricingRuleId() {
+        return this._newPricingRuleId || this.decoratedTransactionLine.pricingRuleId;
+    }
+    get reasonCode() {
+        return this._newReasonCode || this.decoratedTransactionLine.reasonCode;
+    }
+    get reasonDescription() {
+        return this._newReasonDescription || this.decoratedTransactionLine.reasonDescription;
+    }
+    get reasonListType() {
+        return this._newReasonListType || this.decoratedTransactionLine.reasonListType;
+    }
+    get couponCode() {
+        return this._newCouponCode || this.decoratedTransactionLine.couponCode;
+    }
+    get discountType() {
+        return this._newDiscountType || this.decoratedTransactionLine.discountType;
+    }
+    get replacementUnitPrice() {
+        return this._newReplacementUnitPrice || this.decoratedTransactionLine.replacementUnitPrice;
+    }
+    get competitivePrice() {
+        return this._newCompetitivePrice || this.decoratedTransactionLine.competitivePrice;
+    }
+    get competitor() {
+        return this._newCompetitor || this.decoratedTransactionLine.competitor;
+    }
+    get formOfProof() {
+        return this._newFormOfProof || this.decoratedTransactionLine.formOfProof;
+    }
+    get competitorCode() {
+        return this._newCompetitorCode || this.decoratedTransactionLine.competitorCode;
+    }
+    get formOfProofCode() {
+        return this._newFormOfProofCode || this.decoratedTransactionLine.formOfProofCode;
+    }
+    get customCompetitorName() {
+        return this._newCustomCompetitorName;
+    }
+    get customFormOfProof() {
+        return this._newCustomFormOfProof;
+    }
+    get supervisorOverrideLineReference() {
+        return this._newSupervisorOverrideLineReference;
+    }
+    get entryType() {
+        return this._newEntryType || this.decoratedTransactionLine.entryType;
+    }
+    clone() {
+        const newManualDiscountLineModificationDecorator = super.clone();
+        newManualDiscountLineModificationDecorator._newAmount = this._newAmount;
+        newManualDiscountLineModificationDecorator._newCouponCode = this._newCouponCode;
+        newManualDiscountLineModificationDecorator._newDiscountType = this._newDiscountType;
+        newManualDiscountLineModificationDecorator._newPercent = this._newPercent;
+        newManualDiscountLineModificationDecorator._newReasonCode = this._newReasonCode;
+        newManualDiscountLineModificationDecorator._newReasonDescription = this._newReasonDescription;
+        newManualDiscountLineModificationDecorator._newReasonListType = this._newReasonListType;
+        newManualDiscountLineModificationDecorator._newPricingRuleId = this._newPricingRuleId;
+        newManualDiscountLineModificationDecorator._newReplacementUnitPrice = this._newReplacementUnitPrice;
+        newManualDiscountLineModificationDecorator._newCompetitivePrice = this._newCompetitivePrice;
+        newManualDiscountLineModificationDecorator._newCompetitor = this._newCompetitor;
+        newManualDiscountLineModificationDecorator._newFormOfProof = this._newFormOfProof;
+        newManualDiscountLineModificationDecorator._newCompetitorCode = this._newCompetitorCode;
+        newManualDiscountLineModificationDecorator._newFormOfProofCode = this._newFormOfProofCode;
+        newManualDiscountLineModificationDecorator._newCustomCompetitorName = this._newCustomCompetitorName;
+        newManualDiscountLineModificationDecorator._newCustomFormOfProof = this._newCustomFormOfProof;
+        newManualDiscountLineModificationDecorator._newSupervisorOverrideLineReference =
+            this._newSupervisorOverrideLineReference;
+        newManualDiscountLineModificationDecorator._newEntryType = this._newEntryType;
+        return newManualDiscountLineModificationDecorator;
+    }
+    newTransactionLine() {
+        return new ManualDiscountLineModificationDecorator(this.decoratedTransactionLine, this.annotationSourceLineNumber, this._newAmount, this._newPercent, this._newReplacementUnitPrice, this._newDiscountType, this._newReasonCode, this._newReasonDescription, this._newReasonListType, this._newCouponCode, this._newPricingRuleId, this._newCompetitivePrice, this._newCompetitor, this._newFormOfProof, this._newCustomCompetitorName, this._newCustomFormOfProof, this._newCompetitorCode, this._newFormOfProofCode, this._newSupervisorOverrideLineReference, this._newEntryType);
+    }
+}
+exports.ManualDiscountLineModificationDecorator = ManualDiscountLineModificationDecorator;
+//# sourceMappingURL=ManualDiscountLineModificationDecorator.js.map

package/lib/domain/model/discounts/ManualDiscountLineTotalDecorator.d.ts

@@ -0,0 +1,15 @@
+import { Money } from "@aptos-scp/scp-component-business-core";
+import { ITransactionLineFactory } from "@aptos-scp/scp-component-store-selling-core";
+import { BaseManualDiscountLineDecorator } from "./BaseManualDiscountLineDecorator";
+import { IManualDiscountLine } from "./IManualDiscountLine";
+export declare const DECORATOR_TYPE_TRANSACTION_DISCOUNT_TOTAL: string;
+export declare const DECORATOR_TYPE_ITEM_DISCOUNT_TOTAL: string;
+export declare const ITEM_TOTAL_DISCOUNT_ANNOTATION_SOURCE: string;
+export declare const TRANS_TOTAL_DISCOUNT_ANNOTATION_SOURCE: string;
+export declare class ManualDiscountLineTotalDecorator extends BaseManualDiscountLineDecorator {
+    private _totalDiscount;
+    static createFromJsonObject(transactionLineJsonObj: any, transactionLineFactory: ITransactionLineFactory): ManualDiscountLineTotalDecorator;
+    get totalDiscount(): Money;
+    constructor(decoratorLineType: string, decoratedTransactionLine: IManualDiscountLine, annotationDescription: string, annotationSourceType: string, totalDiscount: Money, annotationSourceLineNumber?: number);
+    protected newTransactionLine(): BaseManualDiscountLineDecorator;
+}

package/lib/domain/model/discounts/ManualDiscountLineTotalDecorator.js

@@ -0,0 +1,32 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const scp_component_business_core_1 = require("@aptos-scp/scp-component-business-core");
+const BaseManualDiscountLineDecorator_1 = require("./BaseManualDiscountLineDecorator");
+exports.DECORATOR_TYPE_TRANSACTION_DISCOUNT_TOTAL = "TRANSACTION_DISCOUNT_TOTAL_DECORATOR";
+exports.DECORATOR_TYPE_ITEM_DISCOUNT_TOTAL = "ITEM_DISCOUNT_TOTAL_DECORATOR";
+exports.ITEM_TOTAL_DISCOUNT_ANNOTATION_SOURCE = "ITEM_TOTAL_DISCOUNT";
+exports.TRANS_TOTAL_DISCOUNT_ANNOTATION_SOURCE = "TRANS_TOTAL_DISCOUNT";
+class ManualDiscountLineTotalDecorator extends BaseManualDiscountLineDecorator_1.BaseManualDiscountLineDecorator {
+    constructor(decoratorLineType, decoratedTransactionLine, annotationDescription, annotationSourceType, totalDiscount, annotationSourceLineNumber) {
+        super(decoratorLineType, decoratedTransactionLine, annotationDescription, annotationSourceType, annotationSourceLineNumber);
+        this._totalDiscount = totalDiscount;
+    }
+    static createFromJsonObject(transactionLineJsonObj, transactionLineFactory) {
+        const decoratedTransactionLineJsonObj = this.getDecoratedTransactionLineJsonObjectFromJsonObject(transactionLineJsonObj);
+        const decoratedLine = transactionLineFactory.createTransactionLineFromJsonObj(decoratedTransactionLineJsonObj);
+        const totalDiscount = scp_component_business_core_1.Money.fromJSON(transactionLineJsonObj._totalDiscount);
+        const annotationSourceLineNumber = this.getAnnotationSourceLineNumberFromJsonObject(transactionLineJsonObj);
+        const annotationDescription = this.getAnnotationDescriptionFromJsonObject(transactionLineJsonObj);
+        const annotationSourceType = this.getAnnotationSourceTypeFromJsonObject(transactionLineJsonObj);
+        const decoratorType = this.getLineDecoratorTypeFromJsonObject(transactionLineJsonObj);
+        return new ManualDiscountLineTotalDecorator(decoratorType, decoratedLine, annotationDescription, annotationSourceType, totalDiscount, annotationSourceLineNumber);
+    }
+    get totalDiscount() {
+        return this._totalDiscount;
+    }
+    newTransactionLine() {
+        return new ManualDiscountLineTotalDecorator(this.lineDecoratorType, this.decoratedTransactionLine, this.annotationDescription, this.annotationSourceType, this.totalDiscount, this.annotationSourceLineNumber);
+    }
+}
+exports.ManualDiscountLineTotalDecorator = ManualDiscountLineTotalDecorator;
+//# sourceMappingURL=ManualDiscountLineTotalDecorator.js.map

package/lib/domain/model/discounts/ManualItemDiscountLine.d.ts

@@ -0,0 +1,27 @@
+import { Money, Price } from "@aptos-scp/scp-component-business-core";
+import { UiBusinessEvent } from "@aptos-scp/scp-component-store-selling-core";
+import { DiscountEntryType, ISameTransactionLineReference, ITransactionLineReferenceType, ManualDiscountType } from "@aptos-scp/scp-types-commerce-transaction";
+import { BaseTransactionLine } from "../BaseTransactionLine";
+import { BaseManualDiscountLine } from "./BaseManualDiscountLine";
+import { IManualItemDiscountLine } from "./IManualDiscountLine";
+export declare class ManualItemDiscountLine extends BaseManualDiscountLine implements IManualItemDiscountLine {
+    private _itemLineReference;
+    private _isSubscriptionDiscount;
+    /**
+     * 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 {ManualItemDiscountLine}
+     */
+    static create(lineNumber: number, lineType: string, uiBusinessEvent: UiBusinessEvent, collectedData: Readonly<Map<string, any>>): ManualItemDiscountLine;
+    static createFromJsonObject(transactionLineJsonObj: any): ManualItemDiscountLine;
+    get itemLineReference(): ISameTransactionLineReference;
+    get isSubscriptionDiscount(): boolean;
+    protected constructor(lineNumber: number, lineType: string, discountType: ManualDiscountType, itemLineReference: ISameTransactionLineReference, isSubscriptionDiscount: boolean, pricingRuleId?: string, amount?: Money, percent?: string, replacementUnitPrice?: Price, reasonCode?: string, reasonDesc?: string, reasonType?: string, couponCode?: string, supervisorOverrideLineReference?: ITransactionLineReferenceType, isEmployeeDiscount?: boolean, isFastDiscount?: boolean, competitivePrice?: Price, competitor?: string, formOfProof?: string, customCompetitorName?: string, customFormOfProof?: string, competitorCode?: string, formOfProofCode?: string, entryType?: DiscountEntryType);
+    protected newTransactionLine(): BaseTransactionLine;
+}

package/lib/domain/model/discounts/ManualItemDiscountLine.js

@@ -0,0 +1,53 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const BaseTransactionLine_1 = require("../BaseTransactionLine");
+const Constants_1 = require("../Constants");
+const BaseManualDiscountLine_1 = require("./BaseManualDiscountLine");
+class ManualItemDiscountLine extends BaseManualDiscountLine_1.BaseManualDiscountLine {
+    // Since the constructor is only called from the create methods it is made protected to prevent use by others.
+    constructor(lineNumber, lineType, discountType, itemLineReference, isSubscriptionDiscount, pricingRuleId, amount, percent, replacementUnitPrice, reasonCode, reasonDesc, reasonType, couponCode, supervisorOverrideLineReference, isEmployeeDiscount, isFastDiscount, competitivePrice, competitor, formOfProof, customCompetitorName, customFormOfProof, competitorCode, formOfProofCode, entryType) {
+        super(lineNumber, lineType, discountType, pricingRuleId, amount, percent, replacementUnitPrice, reasonCode, reasonDesc, reasonType, couponCode, supervisorOverrideLineReference, isEmployeeDiscount, isFastDiscount, false, competitivePrice, competitor, formOfProof, customCompetitorName, customFormOfProof, competitorCode, formOfProofCode, entryType);
+        this._itemLineReference = itemLineReference;
+        this._isSubscriptionDiscount = isSubscriptionDiscount;
+    }
+    /**
+     * 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 {ManualItemDiscountLine}
+     */
+    static create(lineNumber, lineType, uiBusinessEvent, collectedData) {
+        const itemLineReference = collectedData.get(Constants_1.CollectedDataKey.ItemLineReference);
+        const isSubscriptionDiscount = collectedData.get(Constants_1.CollectedDataKey.ManualSubscriptionDiscountFlag);
+        const discountType = BaseManualDiscountLine_1.BaseManualDiscountLine.discountTypeFromCollectedData(collectedData);
+        const discountLine = new ManualItemDiscountLine(lineNumber, lineType, discountType, itemLineReference, isSubscriptionDiscount);
+        discountLine.loadFromCollectedData(collectedData);
+        return discountLine;
+    }
+    static createFromJsonObject(transactionLineJsonObj) {
+        const lineNumber = BaseTransactionLine_1.BaseTransactionLine.lineNumberFromJsonObject(transactionLineJsonObj);
+        const lineType = BaseTransactionLine_1.BaseTransactionLine.lineTypeFromJsonObject(transactionLineJsonObj);
+        const discountType = BaseManualDiscountLine_1.BaseManualDiscountLine.discountTypeFromJsonObject(transactionLineJsonObj);
+        const itemLineReference = transactionLineJsonObj._itemLineReference;
+        const isSubscriptionDiscount = transactionLineJsonObj._isSubscriptionDiscount;
+        const discountLine = new ManualItemDiscountLine(lineNumber, lineType, discountType, itemLineReference, isSubscriptionDiscount);
+        discountLine.loadFromJsonObject(transactionLineJsonObj);
+        return discountLine;
+    }
+    get itemLineReference() {
+        return this._itemLineReference;
+    }
+    get isSubscriptionDiscount() {
+        return this._isSubscriptionDiscount;
+    }
+    newTransactionLine() {
+        return new ManualItemDiscountLine(this.lineNumber, this.lineType, this._discountType, this._itemLineReference, this._isSubscriptionDiscount, this._pricingRuleId, this._amount, this._percent, this._replacementUnitPrice, this._reasonCode, this._reasonDescription, this._reasonListType, this._couponCode, this._supervisorOverrideLineReference, this._isEmployeeDiscount, this._isFastDiscount, this._competitivePrice, this._competitor, this._formOfProof, this._customCompetitorName, this._customFormOfProof, this._competitorCode, this._formOfProofCode, this._entryType);
+    }
+}
+exports.ManualItemDiscountLine = ManualItemDiscountLine;
+//# sourceMappingURL=ManualItemDiscountLine.js.map

package/lib/domain/model/discounts/ManualTransactionDiscountLine.d.ts

@@ -0,0 +1,22 @@
+import { Money, Price } from "@aptos-scp/scp-component-business-core";
+import { UiBusinessEvent } from "@aptos-scp/scp-component-store-selling-core";
+import { DiscountEntryType, ITransactionLineReferenceType, ManualDiscountType } from "@aptos-scp/scp-types-commerce-transaction";
+import { BaseTransactionLine } from "../BaseTransactionLine";
+import { BaseManualDiscountLine } from "./BaseManualDiscountLine";
+export declare class ManualTransactionDiscountLine extends BaseManualDiscountLine {
+    /**
+     * 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 {ManualTransactionDiscountLine}
+     */
+    static create(lineNumber: number, lineType: string, uiBusinessEvent: UiBusinessEvent, collectedData: Readonly<Map<string, any>>): ManualTransactionDiscountLine;
+    static createFromJsonObject(transactionLineJsonObj: any): ManualTransactionDiscountLine;
+    protected constructor(lineNumber: number, lineType: string, discountType: ManualDiscountType, pricingRuleId?: string, amount?: Money, percent?: string, replacementUnitPrice?: Price, reasonCode?: string, reasonDesc?: string, reasonType?: string, couponCode?: string, supervisorOverrideLineReference?: ITransactionLineReferenceType, isEmployeeDiscount?: boolean, isFastDiscount?: boolean, isLoyaltyDiscount?: boolean, competitivePrice?: Price, competitor?: string, formOfProof?: string, customCompetitorName?: string, customFormOfProof?: string, competitorCode?: string, formOfProofCode?: string, entryType?: DiscountEntryType, autoApplied?: boolean);
+    protected newTransactionLine(): BaseTransactionLine;
+}

package/lib/domain/model/discounts/ManualTransactionDiscountLine.js

@@ -0,0 +1,40 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const BaseTransactionLine_1 = require("../BaseTransactionLine");
+const BaseManualDiscountLine_1 = require("./BaseManualDiscountLine");
+class ManualTransactionDiscountLine extends BaseManualDiscountLine_1.BaseManualDiscountLine {
+    /**
+     * 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 {ManualTransactionDiscountLine}
+     */
+    static create(lineNumber, lineType, uiBusinessEvent, collectedData) {
+        const discountType = BaseManualDiscountLine_1.BaseManualDiscountLine.discountTypeFromCollectedData(collectedData);
+        const discountLine = new ManualTransactionDiscountLine(lineNumber, lineType, discountType);
+        discountLine.loadFromCollectedData(collectedData);
+        return discountLine;
+    }
+    static createFromJsonObject(transactionLineJsonObj) {
+        const lineNumber = BaseTransactionLine_1.BaseTransactionLine.lineNumberFromJsonObject(transactionLineJsonObj);
+        const lineType = BaseTransactionLine_1.BaseTransactionLine.lineTypeFromJsonObject(transactionLineJsonObj);
+        const discountType = BaseManualDiscountLine_1.BaseManualDiscountLine.discountTypeFromJsonObject(transactionLineJsonObj);
+        const discountLine = new ManualTransactionDiscountLine(lineNumber, lineType, discountType);
+        discountLine.loadFromJsonObject(transactionLineJsonObj);
+        return discountLine;
+    }
+    // Since the constructor is only called from the create methods it is made protected to prevent use by others.
+    constructor(lineNumber, lineType, discountType, pricingRuleId, amount, percent, replacementUnitPrice, reasonCode, reasonDesc, reasonType, couponCode, supervisorOverrideLineReference, isEmployeeDiscount, isFastDiscount, isLoyaltyDiscount, competitivePrice, competitor, formOfProof, customCompetitorName, customFormOfProof, competitorCode, formOfProofCode, entryType, autoApplied) {
+        super(lineNumber, lineType, discountType, pricingRuleId, amount, percent, replacementUnitPrice, reasonCode, reasonDesc, reasonType, couponCode, supervisorOverrideLineReference, isEmployeeDiscount, isFastDiscount, isLoyaltyDiscount, competitivePrice, competitor, formOfProof, customCompetitorName, customFormOfProof, competitorCode, formOfProofCode, entryType, autoApplied);
+    }
+    newTransactionLine() {
+        return new ManualTransactionDiscountLine(this.lineNumber, this.lineType, this._discountType, this.pricingRuleId, this._amount, this._percent, this._replacementUnitPrice, this._reasonCode, this._reasonDescription, this._reasonListType, this._couponCode, this._supervisorOverrideLineReference, this._isEmployeeDiscount, this.isFastDiscount, this.isLoyaltyDiscount, this.competitivePrice, this.competitor, this.formOfProof, this.customCompetitorName, this.customFormOfProof, this.competitorCode, this.formOfProofCode, this.entryType, this.autoApplied);
+    }
+}
+exports.ManualTransactionDiscountLine = ManualTransactionDiscountLine;
+//# sourceMappingURL=ManualTransactionDiscountLine.js.map

package/lib/domain/model/discounts/ModifyManualDiscountLine.d.ts

@@ -0,0 +1,29 @@
+import { Money, Price } from "@aptos-scp/scp-component-business-core";
+import { ITransactionLine, UiBusinessEvent } from "@aptos-scp/scp-component-store-selling-core";
+import { DiscountEntryType, ISameTransactionLineReference, ITransactionLineReferenceType, ManualDiscountType } from "@aptos-scp/scp-types-commerce-transaction";
+import { BaseTransactionLine } from "../BaseTransactionLine";
+import { BaseManualDiscountLine } from "./BaseManualDiscountLine";
+export declare const MODIFY_DISCOUNT_LINE_TYPE: string;
+/**
+ * The ModifyManualDiscountLine Captures the action by the user to modify a manual discount line
+ */
+export declare class ModifyManualDiscountLine extends BaseManualDiscountLine {
+    private _modifiedLineNumber;
+    /**
+     * 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 {ModifyManualDiscountLine}
+     */
+    static create(lineNumber: number, lineType: string, uiBusinessEvent: UiBusinessEvent, collectedData: Readonly<Map<string, any>>): ModifyManualDiscountLine;
+    static createFromJsonObject(transactionLineJsonObj: any): ModifyManualDiscountLine;
+    get modifiedLineNumber(): ISameTransactionLineReference;
+    protected constructor(lineNumber: number, lineType: string, modifiedLineNumber: ISameTransactionLineReference, discountType: ManualDiscountType, amount?: Money, percent?: string, replacementUnitPrice?: Price, reasonCode?: string, reasonDesc?: string, reasonListType?: string, couponCode?: string, pricingRuleId?: string, supervisorOverrideLineReference?: ITransactionLineReferenceType, isEmployeeDiscount?: boolean, isFastDiscount?: boolean, isLoyaltyDiscount?: boolean, competitivePrice?: Price, competitor?: string, formOfProof?: string, customCompetitorName?: string, customFormOfProof?: string, competitorCode?: string, formOfProofCode?: string, entryType?: DiscountEntryType, autoApplied?: boolean);
+    protected newTransactionLine(): BaseTransactionLine;
+}
+export declare function isModifyManualDiscountLine(transactionLine: ITransactionLine): transactionLine is ModifyManualDiscountLine;

package/lib/domain/model/discounts/ModifyManualDiscountLine.js

@@ -0,0 +1,62 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const scp_component_store_selling_core_1 = require("@aptos-scp/scp-component-store-selling-core");
+const config_1 = require("../../../config");
+const Constants_1 = require("../Constants");
+const BaseManualDiscountLine_1 = require("./BaseManualDiscountLine");
+exports.MODIFY_DISCOUNT_LINE_TYPE = "modifyManualDiscount";
+/**
+ * The ModifyManualDiscountLine Captures the action by the user to modify a manual discount line
+ */
+class ModifyManualDiscountLine extends BaseManualDiscountLine_1.BaseManualDiscountLine {
+    // Since the constructor is only called from the create methods it is made protected to prevent use by others.
+    constructor(lineNumber, lineType, modifiedLineNumber, discountType, amount, percent, replacementUnitPrice, reasonCode, reasonDesc, reasonListType, couponCode, pricingRuleId, supervisorOverrideLineReference, isEmployeeDiscount, isFastDiscount, isLoyaltyDiscount, competitivePrice, competitor, formOfProof, customCompetitorName, customFormOfProof, competitorCode, formOfProofCode, entryType, autoApplied) {
+        super(lineNumber, lineType, discountType, pricingRuleId, amount, percent, replacementUnitPrice, reasonCode, reasonDesc, reasonListType, couponCode, supervisorOverrideLineReference, isEmployeeDiscount, isFastDiscount, isLoyaltyDiscount, competitivePrice, competitor, formOfProof, customCompetitorName, customFormOfProof, competitorCode, formOfProofCode, entryType, autoApplied);
+        this._modifiedLineNumber = modifiedLineNumber;
+    }
+    /**
+     * 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 {ModifyManualDiscountLine}
+     */
+    static create(lineNumber, lineType, uiBusinessEvent, collectedData) {
+        if (!(lineType === exports.MODIFY_DISCOUNT_LINE_TYPE)) {
+            throw new scp_component_store_selling_core_1.PosError(`The line type "${lineType}" is not supported by ModifyManualDiscountLine`, config_1.SSF_LINE_TYPE_ERROR_CODE);
+        }
+        const modifiedLineNumber = collectedData.get(Constants_1.CollectedDataKey.LineNumberReference);
+        const discountType = BaseManualDiscountLine_1.BaseManualDiscountLine.discountTypeFromCollectedData(collectedData);
+        const discountLine = new ModifyManualDiscountLine(lineNumber, lineType, modifiedLineNumber, discountType);
+        discountLine.loadFromCollectedData(collectedData);
+        return discountLine;
+    }
+    static createFromJsonObject(transactionLineJsonObj) {
+        const lineNumber = BaseManualDiscountLine_1.BaseManualDiscountLine.lineNumberFromJsonObject(transactionLineJsonObj);
+        const lineType = BaseManualDiscountLine_1.BaseManualDiscountLine.lineTypeFromJsonObject(transactionLineJsonObj);
+        const discountType = BaseManualDiscountLine_1.BaseManualDiscountLine.discountTypeFromJsonObject(transactionLineJsonObj);
+        const modifiedLineNumber = transactionLineJsonObj._modifiedLineNumber;
+        const modifyManualDiscountLine = new ModifyManualDiscountLine(lineNumber, lineType, modifiedLineNumber, discountType);
+        modifyManualDiscountLine.loadFromJsonObject(transactionLineJsonObj);
+        return modifyManualDiscountLine;
+    }
+    get modifiedLineNumber() {
+        return this._modifiedLineNumber;
+    }
+    newTransactionLine() {
+        return new ModifyManualDiscountLine(this.lineNumber, this.lineType, this._modifiedLineNumber, this._discountType, this._amount, this._percent, this._replacementUnitPrice, this._reasonCode, this._reasonDescription, this._reasonListType, this._couponCode, this._pricingRuleId, this._supervisorOverrideLineReference, this._isEmployeeDiscount, this._isFastDiscount, this._isLoyaltyDiscount, this._competitivePrice, this._competitor, this._formOfProof, this._customCompetitorName, this._customFormOfProof, this._competitorCode, this._formOfProofCode, this._entryType, this._autoApplied);
+    }
+}
+exports.ModifyManualDiscountLine = ModifyManualDiscountLine;
+// Instead of using this guard function, consider, using isVoidingLine from the VoidInterfaced.
+// This is useful, when you need to know you are working with this class, and not just a voidable/voiding line.
+function isModifyManualDiscountLine(transactionLine) {
+    return (transactionLine instanceof ModifyManualDiscountLine ||
+        transactionLine.lineType === exports.MODIFY_DISCOUNT_LINE_TYPE);
+}
+exports.isModifyManualDiscountLine = isModifyManualDiscountLine;
+//# sourceMappingURL=ModifyManualDiscountLine.js.map

package/lib/domain/model/discounts/PromotionCouponLine.d.ts

@@ -0,0 +1,22 @@
+import { ITransactionLine, UiBusinessEvent } from "@aptos-scp/scp-component-store-selling-core";
+import { ICouponAuthorizationServiceResult, ITransactionLineReferenceType } from "@aptos-scp/scp-types-commerce-transaction";
+import { BaseTransactionLine } from "../BaseTransactionLine";
+import { BasePromotionCouponLine } from "./BasePromotionCouponLine";
+export declare const APPLY_PROMOTION_COUPON_LINE_TYPE = "PromotionCouponApplied";
+export declare const APPLY_PROMOTION_SINGLE_USE_COUPON_LINE_TYPE = "PromotionSingleUseCouponApplied";
+export declare const APPLY_PROMOTION_AUTO_COUPON_LINE_TYPE = "PromotionAutoCouponApplied";
+export declare const RETURN_PROMOTION_COUPON_LINE_TYPE = "PromotionCouponReturned";
+export declare const PROMOTION_COUPON_FAILED_LINE_TYPE = "PromotionCouponFailed";
+export declare class PromotionCouponLine extends BasePromotionCouponLine {
+    static create(lineNumber: number, lineType: string, uiBusinessEvent: UiBusinessEvent, collectedData: Readonly<Map<string, any>>): PromotionCouponLine;
+    static createFromJsonObject(transactionLineJsonObj: any): PromotionCouponLine;
+    protected constructor(lineNumber: number, lineType: string, couponNumber: string, internalCouponNumber?: string, couponAuthorizationServiceResult?: ICouponAuthorizationServiceResult, supervisorOverrideLineReference?: ITransactionLineReferenceType);
+    protected newTransactionLine(): BaseTransactionLine;
+    get couldAffectPricing(): boolean;
+}
+export declare const isApplyPromotionCouponLine: (transactionLine: ITransactionLine) => transactionLine is PromotionCouponLine;
+export declare const isApplyPromotionSingleUseCouponLine: (transactionLine: ITransactionLine) => transactionLine is PromotionCouponLine;
+export declare const isApplyPromotionAutoCouponLine: (transactionLine: ITransactionLine) => transactionLine is PromotionCouponLine;
+export declare const isPromotionCouponLine: (transactionLine: ITransactionLine) => transactionLine is PromotionCouponLine;
+export declare const isReturnPromotionCouponLine: (transactionLine: ITransactionLine) => transactionLine is PromotionCouponLine;
+export declare const isPromotionCouponFailedLine: (transactionLine: ITransactionLine) => transactionLine is PromotionCouponLine;

package/lib/domain/model/discounts/PromotionCouponLine.js

@@ -0,0 +1,59 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const BaseTransactionLine_1 = require("../BaseTransactionLine");
+const Constants_1 = require("../Constants");
+const BasePromotionCouponLine_1 = require("./BasePromotionCouponLine");
+exports.APPLY_PROMOTION_COUPON_LINE_TYPE = "PromotionCouponApplied";
+exports.APPLY_PROMOTION_SINGLE_USE_COUPON_LINE_TYPE = "PromotionSingleUseCouponApplied";
+exports.APPLY_PROMOTION_AUTO_COUPON_LINE_TYPE = "PromotionAutoCouponApplied";
+exports.RETURN_PROMOTION_COUPON_LINE_TYPE = "PromotionCouponReturned";
+exports.PROMOTION_COUPON_FAILED_LINE_TYPE = "PromotionCouponFailed";
+class PromotionCouponLine extends BasePromotionCouponLine_1.BasePromotionCouponLine {
+    static create(lineNumber, lineType, uiBusinessEvent, collectedData) {
+        const couponNumber = collectedData.get(Constants_1.CollectedDataKey.CouponNumber);
+        const internalCouponNumber = collectedData.get(Constants_1.CollectedDataKey.InternalCouponNumber) || undefined;
+        const couponAuthorizationServiceResult = collectedData.get(Constants_1.CollectedDataKey.CouponServiceResult) || undefined;
+        const supervisorOverrideLineReference = collectedData.get(Constants_1.CollectedDataKey.SupervisorOverrideLineReference) || undefined;
+        return new PromotionCouponLine(lineNumber, lineType, couponNumber, internalCouponNumber, couponAuthorizationServiceResult, supervisorOverrideLineReference);
+    }
+    static createFromJsonObject(transactionLineJsonObj) {
+        const lineNumber = BaseTransactionLine_1.BaseTransactionLine.lineNumberFromJsonObject(transactionLineJsonObj);
+        const couponNumber = transactionLineJsonObj._couponNumber;
+        const internalCouponNumber = transactionLineJsonObj._internalCouponNumber;
+        const couponAuthorizationServiceResult = transactionLineJsonObj._couponAuthorizationServiceResult;
+        const lineType = BaseTransactionLine_1.BaseTransactionLine.lineTypeFromJsonObject(transactionLineJsonObj);
+        const supervisorOverrideLineReference = transactionLineJsonObj._supervisorOverrideLineReference;
+        return new PromotionCouponLine(lineNumber, lineType, couponNumber, internalCouponNumber, couponAuthorizationServiceResult, supervisorOverrideLineReference);
+    }
+    constructor(lineNumber, lineType, couponNumber, internalCouponNumber, couponAuthorizationServiceResult, supervisorOverrideLineReference) {
+        super(lineNumber, lineType, couponNumber, lineType === exports.APPLY_PROMOTION_AUTO_COUPON_LINE_TYPE, internalCouponNumber, couponAuthorizationServiceResult, supervisorOverrideLineReference);
+    }
+    newTransactionLine() {
+        return new PromotionCouponLine(this.lineNumber, this.lineType, this._couponNumber, this._internalCouponNumber, this._couponAuthorizationServiceResult, this._supervisorOverrideLineReference);
+    }
+    get couldAffectPricing() {
+        return this.lineType === exports.RETURN_PROMOTION_COUPON_LINE_TYPE ? false : super.couldAffectPricing;
+    }
+}
+exports.PromotionCouponLine = PromotionCouponLine;
+exports.isApplyPromotionCouponLine = (transactionLine) => {
+    return transactionLine.lineType === exports.APPLY_PROMOTION_COUPON_LINE_TYPE;
+};
+exports.isApplyPromotionSingleUseCouponLine = (transactionLine) => {
+    return transactionLine.lineType === exports.APPLY_PROMOTION_SINGLE_USE_COUPON_LINE_TYPE;
+};
+exports.isApplyPromotionAutoCouponLine = (transactionLine) => {
+    return transactionLine.lineType === exports.APPLY_PROMOTION_AUTO_COUPON_LINE_TYPE;
+};
+exports.isPromotionCouponLine = (transactionLine) => {
+    return (transactionLine.lineType === exports.APPLY_PROMOTION_COUPON_LINE_TYPE ||
+        transactionLine.lineType === exports.APPLY_PROMOTION_SINGLE_USE_COUPON_LINE_TYPE ||
+        transactionLine.lineType === exports.APPLY_PROMOTION_AUTO_COUPON_LINE_TYPE);
+};
+exports.isReturnPromotionCouponLine = (transactionLine) => {
+    return transactionLine.lineType === exports.RETURN_PROMOTION_COUPON_LINE_TYPE;
+};
+exports.isPromotionCouponFailedLine = (transactionLine) => {
+    return transactionLine.lineType === exports.PROMOTION_COUPON_FAILED_LINE_TYPE;
+};
+//# sourceMappingURL=PromotionCouponLine.js.map

package/lib/domain/model/discounts/VoidedDiscountLineDecorator.d.ts

@@ -0,0 +1,15 @@
+import { ITransactionLineFactory } from "@aptos-scp/scp-component-store-selling-core";
+import { VoidSource } from "../Constants";
+import { BaseManualDiscountLine } from "./BaseManualDiscountLine";
+import { BaseManualDiscountLineDecorator } from "./BaseManualDiscountLineDecorator";
+export declare const DECORATOR_TYPE_VOIDED_DISCOUNT_LINE: string;
+export declare class VoidedDiscountLineDecorator extends BaseManualDiscountLineDecorator {
+    private _voidSource;
+    static createFromJsonObject(transactionLineJsonObj: any, transactionLineFactory: ITransactionLineFactory): VoidedDiscountLineDecorator;
+    constructor(voidSource: VoidSource, discountLine: BaseManualDiscountLine, annotationSourceLineNumber: number);
+    get voided(): boolean;
+    get voidSource(): VoidSource;
+    get preventsTransactionVoid(): boolean;
+    get allowVoid(): boolean;
+    protected newTransactionLine(): VoidedDiscountLineDecorator;
+}

package/lib/domain/model/discounts/VoidedDiscountLineDecorator.js

@@ -0,0 +1,38 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const BaseLineDecorator_1 = require("../BaseLineDecorator");
+const VoidedLineDecorator_1 = require("../void/VoidedLineDecorator");
+const BaseManualDiscountLineDecorator_1 = require("./BaseManualDiscountLineDecorator");
+const VOIDED_DISCOUNT_ANNOTATION_SOURCE_TYPE = "VoidedDiscount";
+exports.DECORATOR_TYPE_VOIDED_DISCOUNT_LINE = "VOIDED_DISCOUNT_LINE_DECORATOR";
+class VoidedDiscountLineDecorator extends BaseManualDiscountLineDecorator_1.BaseManualDiscountLineDecorator {
+    constructor(voidSource, discountLine, annotationSourceLineNumber) {
+        super(exports.DECORATOR_TYPE_VOIDED_DISCOUNT_LINE, discountLine, VoidedLineDecorator_1.DECORATOR_DESCRIPTION_VOIDED, VOIDED_DISCOUNT_ANNOTATION_SOURCE_TYPE, annotationSourceLineNumber);
+        this._voidSource = voidSource;
+    }
+    static createFromJsonObject(transactionLineJsonObj, transactionLineFactory) {
+        const decoratedTransactionLineJsonObj = BaseLineDecorator_1.BaseLineDecorator.getDecoratedTransactionLineJsonObjectFromJsonObject(transactionLineJsonObj);
+        const decoratedDiscountLine = transactionLineFactory.createTransactionLineFromJsonObj(decoratedTransactionLineJsonObj);
+        const annotationSourceLineNumber = BaseLineDecorator_1.BaseLineDecorator.getAnnotationSourceLineNumberFromJsonObject(transactionLineJsonObj);
+        const voidSource = transactionLineJsonObj._voidSource;
+        const voidedDiscountLineDecorator = new VoidedDiscountLineDecorator(voidSource, decoratedDiscountLine, annotationSourceLineNumber);
+        return voidedDiscountLineDecorator;
+    }
+    get voided() {
+        return true;
+    }
+    get voidSource() {
+        return this._voidSource;
+    }
+    get preventsTransactionVoid() {
+        return this.decoratedTransactionLine.preventsTransactionVoid;
+    }
+    get allowVoid() {
+        return true;
+    }
+    newTransactionLine() {
+        return new VoidedDiscountLineDecorator(this._voidSource, this.decoratedTransactionLine, this.annotationSourceLineNumber);
+    }
+}
+exports.VoidedDiscountLineDecorator = VoidedDiscountLineDecorator;
+//# sourceMappingURL=VoidedDiscountLineDecorator.js.map

package/lib/domain/model/discounts/VoidedLoyaltyDiscountLineDecorator.d.ts

@@ -0,0 +1,18 @@
+import { ITransactionLineFactory } from "@aptos-scp/scp-component-store-selling-core";
+import { LoyaltyRedemptionType } from "@aptos-scp/scp-types-commerce-transaction";
+import { VoidSource } from "../Constants";
+import { LoyaltyDiscountLine } from "./LoyaltyDiscountLine";
+import { VoidedDiscountLineDecorator } from "./VoidedDiscountLineDecorator";
+export declare class VoidedLoyaltyDiscountLineDecorator extends VoidedDiscountLineDecorator {
+    static createFromJsonObject(transactionLineJsonObj: any, transactionLineFactory: ITransactionLineFactory): VoidedLoyaltyDiscountLineDecorator;
+    constructor(voidSource: VoidSource, discountLine: LoyaltyDiscountLine, annotationSourceLineNumber: number);
+    get loyaltyPlanKey(): string;
+    get redemptionType(): LoyaltyRedemptionType;
+    get loyaltyActivityId(): string;
+    get isPermanentMembershipDiscount(): boolean;
+    get autoApplied(): boolean;
+    get membershipTypeKey(): string;
+    get membershipTypeName(): string;
+    get membershipTypeDescription(): string;
+    protected newTransactionLine(): VoidedLoyaltyDiscountLineDecorator;
+}