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

package/lib/domain/model/taxExempt/ITaxExemptLine.d.ts

@@ -0,0 +1,22 @@
+import { ITransactionLine } from "@aptos-scp/scp-component-store-selling-core";
+import { ITaxAuthorityForExemption, ITransactionLineReferenceType, TaxExemptType } from "@aptos-scp/scp-types-commerce-transaction";
+import { IVoidableLine } from "../VoidInterfaces";
+export interface ITaxExemptLine extends ITransactionLine, IVoidableLine {
+    readonly taxExemptType: TaxExemptType;
+    readonly certificateId: string;
+    readonly reasonCode: string;
+    readonly reasonDescription: string;
+    readonly reasonListType: string;
+    readonly originalCertificateId?: string;
+    readonly originalReasonCode?: string;
+    readonly originalReasonDescription?: string;
+    readonly supervisorOverrideLineReference: ITransactionLineReferenceType;
+    readonly displayName?: string;
+    readonly originalDisplayName?: string;
+    readonly exemptedTaxAuthorities?: ITaxAuthorityForExemption[];
+    readonly originalExemptedTaxAuthorities?: ITaxAuthorityForExemption[];
+    readonly exemptedItemLineReferences?: ITransactionLineReferenceType[];
+    readonly presetRateExemption?: boolean;
+    readonly presetExemptionCategory?: string;
+    readonly presetExemptionRate?: string;
+}

package/lib/domain/model/taxExempt/ITaxExemptLine.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=ITaxExemptLine.js.map

package/lib/domain/model/taxExempt/ItemTaxExemptLine.d.ts

@@ -0,0 +1,23 @@
+import { ITransactionLine, UiBusinessEvent } from "@aptos-scp/scp-component-store-selling-core";
+import { ITaxAuthorityForExemption, ITransactionLineReferenceType, TaxExemptType } from "@aptos-scp/scp-types-commerce-transaction";
+import { BaseTransactionLine } from "../BaseTransactionLine";
+import { BaseTaxExemptLine } from "./BaseTaxExemptLine";
+export declare const ITEM_TAX_EXEMPT_LINE_TYPE = "ItemTaxExempt";
+export declare class ItemTaxExemptLine extends BaseTaxExemptLine {
+    /**
+     * 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 {ItemTaxExemptLine}
+     */
+    static create(lineNumber: number, lineType: string, uiBusinessEvent: UiBusinessEvent, collectedData: Readonly<Map<string, any>>): ItemTaxExemptLine;
+    static createFromJsonObject(transactionLineJsonObj: any): ItemTaxExemptLine;
+    protected constructor(lineNumber: number, lineType: string, taxExemptType: TaxExemptType, certificateId: string, reasonCode?: string, reasonDescription?: string, reasonType?: string, supervisorOverrideLineReference?: ITransactionLineReferenceType, displayName?: string, exemptedTaxAuthorities?: ITaxAuthorityForExemption[], exemptedItemLineReferences?: ITransactionLineReferenceType[], presetRateExemption?: boolean, presetExemptionCategory?: string, presetExemptionRate?: string);
+    protected newTransactionLine(): BaseTransactionLine;
+}
+export declare function isItemTaxExemptLine(transactionLine: ITransactionLine): transactionLine is ItemTaxExemptLine;

package/lib/domain/model/taxExempt/ItemTaxExemptLine.js

@@ -0,0 +1,47 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const BaseTransactionLine_1 = require("../BaseTransactionLine");
+const BaseTaxExemptLine_1 = require("./BaseTaxExemptLine");
+exports.ITEM_TAX_EXEMPT_LINE_TYPE = "ItemTaxExempt";
+class ItemTaxExemptLine extends BaseTaxExemptLine_1.BaseTaxExemptLine {
+    /**
+     * 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 {ItemTaxExemptLine}
+     */
+    static create(lineNumber, lineType, uiBusinessEvent, collectedData) {
+        const taxExemptType = BaseTaxExemptLine_1.BaseTaxExemptLine.taxExemptTypeFromCollectedData(collectedData);
+        const certificateId = BaseTaxExemptLine_1.BaseTaxExemptLine.certificateIdFromCollectedData(collectedData);
+        const taxExemptLine = new ItemTaxExemptLine(lineNumber, lineType, taxExemptType, certificateId);
+        taxExemptLine.loadFromCollectedData(collectedData);
+        return taxExemptLine;
+    }
+    static createFromJsonObject(transactionLineJsonObj) {
+        const lineNumber = BaseTransactionLine_1.BaseTransactionLine.lineNumberFromJsonObject(transactionLineJsonObj);
+        const lineType = BaseTransactionLine_1.BaseTransactionLine.lineTypeFromJsonObject(transactionLineJsonObj);
+        const taxExemptType = BaseTaxExemptLine_1.BaseTaxExemptLine.taxExemptTypeFromJsonObject(transactionLineJsonObj);
+        const certificateId = BaseTaxExemptLine_1.BaseTaxExemptLine.certificateIdFromJsonObject(transactionLineJsonObj);
+        const taxExemptLine = new ItemTaxExemptLine(lineNumber, lineType, taxExemptType, certificateId);
+        taxExemptLine.loadFromJsonObject(transactionLineJsonObj);
+        return taxExemptLine;
+    }
+    constructor(lineNumber, lineType, taxExemptType, certificateId, reasonCode, reasonDescription, reasonType, supervisorOverrideLineReference, displayName, exemptedTaxAuthorities, exemptedItemLineReferences, presetRateExemption, presetExemptionCategory, presetExemptionRate) {
+        super(lineNumber, lineType, taxExemptType, certificateId, reasonCode, reasonDescription, reasonType, supervisorOverrideLineReference, displayName, exemptedTaxAuthorities, exemptedItemLineReferences, presetRateExemption, presetExemptionCategory, presetExemptionRate, certificateId, reasonCode, reasonDescription, displayName, exemptedTaxAuthorities);
+    }
+    newTransactionLine() {
+        return new ItemTaxExemptLine(this.lineNumber, this.lineType, this._taxExemptType, this._certificateId, this._reasonCode, this._reasonDescription, this._reasonListType, this._supervisorOverrideLineReference, this._displayName, this._exemptedTaxAuthorities, this._exemptedItemLineReferences, this._presetRateExemption, this._presetExemptionCategory, this._presetExemptionRate);
+    }
+}
+exports.ItemTaxExemptLine = ItemTaxExemptLine;
+function isItemTaxExemptLine(transactionLine) {
+    return (transactionLine instanceof ItemTaxExemptLine ||
+        (transactionLine && transactionLine.lineType === exports.ITEM_TAX_EXEMPT_LINE_TYPE));
+}
+exports.isItemTaxExemptLine = isItemTaxExemptLine;
+//# sourceMappingURL=ItemTaxExemptLine.js.map

package/lib/domain/model/taxExempt/ItemTaxExemptLineModificationDecorator.d.ts

@@ -0,0 +1,32 @@
+import { ITransactionLine, ITransactionLineFactory } from "@aptos-scp/scp-component-store-selling-core";
+import { ITaxAuthorityForExemption, TaxExemptType } from "@aptos-scp/scp-types-commerce-transaction";
+import { BaseTaxExemptLineDecorator } from "./BaseTaxExemptLineDecorator";
+import { ItemTaxExemptLine } from "./ItemTaxExemptLine";
+export declare const DECORATOR_TYPE_ITEM_TAX_EXEMPT_CHANGE: string;
+export declare function isItemTaxExemptLineModificationDecorator(transactionLine: ITransactionLine): transactionLine is ItemTaxExemptLineModificationDecorator;
+export declare class ItemTaxExemptLineModificationDecorator extends BaseTaxExemptLineDecorator {
+    private _newTaxExemptType;
+    private _newCertificateId;
+    private _newReasonCode;
+    private _newReasonDescription;
+    private _newReasonListType;
+    private _newDisplayName?;
+    private _newExemptedTaxAuthorities?;
+    private _newPresetRateExemption?;
+    private _newPresetExemptionCategory?;
+    private _newPresetExemptionRate?;
+    static createFromJsonObject(transactionLineJsonObj: any, transactionLineFactory: ITransactionLineFactory): ItemTaxExemptLineModificationDecorator;
+    constructor(itemTaxExemptLine: ItemTaxExemptLine, annotationSourceLineNumber: number, newTaxExemptType: TaxExemptType, newCertificateId: string, newReasonCode?: string, newReasonDescription?: string, newReasonListType?: string, newDisplayName?: string, newExemptedTaxAuthorities?: ITaxAuthorityForExemption[], newPresetRateExemption?: boolean, newPresetExemptionCategory?: string, newPresetExemptionRate?: string);
+    get taxExemptType(): TaxExemptType;
+    get certificateId(): string;
+    get reasonCode(): string;
+    get reasonDescription(): string;
+    get reasonListType(): string;
+    get displayName(): string;
+    get exemptedTaxAuthorities(): ITaxAuthorityForExemption[];
+    get presetRateExemption(): boolean;
+    get presetExemptionCategory(): string;
+    get presetExemptionRate(): string;
+    protected clone(): BaseTaxExemptLineDecorator;
+    protected newTransactionLine(): BaseTaxExemptLineDecorator;
+}

package/lib/domain/model/taxExempt/ItemTaxExemptLineModificationDecorator.js

@@ -0,0 +1,91 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const BaseTaxExemptLineDecorator_1 = require("./BaseTaxExemptLineDecorator");
+const ITEM_TAX_EXEMPT_ANNOTATION_SOURCE_TYPE = "ModifyItemTaxExempt";
+exports.DECORATOR_TYPE_ITEM_TAX_EXEMPT_CHANGE = "ITEM_TAX_EXEMPT_CHANGE_DECORATOR_TYPE";
+function isItemTaxExemptLineModificationDecorator(transactionLine) {
+    return (transactionLine.lineDecoratorType ===
+        exports.DECORATOR_TYPE_ITEM_TAX_EXEMPT_CHANGE);
+}
+exports.isItemTaxExemptLineModificationDecorator = isItemTaxExemptLineModificationDecorator;
+class ItemTaxExemptLineModificationDecorator extends BaseTaxExemptLineDecorator_1.BaseTaxExemptLineDecorator {
+    constructor(itemTaxExemptLine, annotationSourceLineNumber, newTaxExemptType, newCertificateId, newReasonCode, newReasonDescription, newReasonListType, newDisplayName, newExemptedTaxAuthorities, newPresetRateExemption, newPresetExemptionCategory, newPresetExemptionRate) {
+        super(exports.DECORATOR_TYPE_ITEM_TAX_EXEMPT_CHANGE, itemTaxExemptLine, undefined, ITEM_TAX_EXEMPT_ANNOTATION_SOURCE_TYPE, annotationSourceLineNumber);
+        this._newTaxExemptType = newTaxExemptType;
+        this._newCertificateId = newCertificateId;
+        this._newReasonCode = newReasonCode;
+        this._newReasonDescription = newReasonDescription;
+        this._newReasonListType = newReasonListType;
+        this._newDisplayName = newDisplayName;
+        this._newExemptedTaxAuthorities = newExemptedTaxAuthorities;
+        this._newPresetRateExemption = newPresetRateExemption;
+        this._newPresetExemptionCategory = newPresetExemptionCategory;
+        this._newPresetExemptionRate = newPresetExemptionRate;
+    }
+    static createFromJsonObject(transactionLineJsonObj, transactionLineFactory) {
+        const decoratedTransactionLineJsonObj = BaseTaxExemptLineDecorator_1.BaseTaxExemptLineDecorator.getDecoratedTransactionLineJsonObjectFromJsonObject(transactionLineJsonObj);
+        const decoratedItemTaxExemptLine = transactionLineFactory.createTransactionLineFromJsonObj(decoratedTransactionLineJsonObj);
+        const newTaxExemptType = transactionLineJsonObj._newTaxExemptType;
+        const newCertificateId = transactionLineJsonObj._newCertificateId;
+        const newReasonCode = transactionLineJsonObj._newReasonCode;
+        const newReasonDescription = transactionLineJsonObj._newReasonDescription;
+        const newReasonListType = transactionLineJsonObj._newReasonListType;
+        const newDisplayName = transactionLineJsonObj._newDisplayName;
+        const newExemptedTaxAuthorities = transactionLineJsonObj._newExemptedTaxAuthorities;
+        const newPresetRateExemption = transactionLineJsonObj._newPresetRateExemption;
+        const newPresetExemptionCategory = transactionLineJsonObj._newPresetExemptionCategory;
+        const newPresetExemptionRate = transactionLineJsonObj._newPresetExemptionRate;
+        const annotationSourceLineNumber = BaseTaxExemptLineDecorator_1.BaseTaxExemptLineDecorator.getAnnotationSourceLineNumberFromJsonObject(transactionLineJsonObj);
+        const itemTaxExemptLineModificationDecorator = new ItemTaxExemptLineModificationDecorator(decoratedItemTaxExemptLine, annotationSourceLineNumber, newTaxExemptType, newCertificateId, newReasonCode, newReasonDescription, newReasonListType, newDisplayName, newExemptedTaxAuthorities, newPresetRateExemption, newPresetExemptionCategory, newPresetExemptionRate);
+        return itemTaxExemptLineModificationDecorator;
+    }
+    get taxExemptType() {
+        return this._newTaxExemptType || this.decoratedTransactionLine.taxExemptType;
+    }
+    get certificateId() {
+        return this._newCertificateId;
+    }
+    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 displayName() {
+        return this._newDisplayName;
+    }
+    get exemptedTaxAuthorities() {
+        return this._newExemptedTaxAuthorities;
+    }
+    get presetRateExemption() {
+        return this._newPresetRateExemption;
+    }
+    get presetExemptionCategory() {
+        return this._newPresetExemptionCategory;
+    }
+    get presetExemptionRate() {
+        return this._newPresetExemptionRate;
+    }
+    clone() {
+        const newItemTaxExemptLineModificationDecorator = super.clone();
+        newItemTaxExemptLineModificationDecorator._newTaxExemptType = this._newTaxExemptType;
+        newItemTaxExemptLineModificationDecorator._newCertificateId = this._newCertificateId;
+        newItemTaxExemptLineModificationDecorator._newReasonCode = this._newReasonCode;
+        newItemTaxExemptLineModificationDecorator._newReasonDescription = this._newReasonDescription;
+        newItemTaxExemptLineModificationDecorator._newReasonListType = this._newReasonListType;
+        newItemTaxExemptLineModificationDecorator._newDisplayName = this._newDisplayName;
+        newItemTaxExemptLineModificationDecorator._newExemptedTaxAuthorities = this._newExemptedTaxAuthorities;
+        newItemTaxExemptLineModificationDecorator._newPresetRateExemption = this._newPresetRateExemption;
+        newItemTaxExemptLineModificationDecorator._newPresetExemptionCategory = this._newPresetExemptionCategory;
+        newItemTaxExemptLineModificationDecorator._newPresetExemptionRate = this._newPresetExemptionRate;
+        return newItemTaxExemptLineModificationDecorator;
+    }
+    newTransactionLine() {
+        return new ItemTaxExemptLineModificationDecorator(this.decoratedTransactionLine, this.annotationSourceLineNumber, this._newTaxExemptType, this._newCertificateId, this._newReasonCode, this._newReasonDescription, this._newReasonListType, this._newDisplayName, this._newExemptedTaxAuthorities, this._newPresetRateExemption, this._newPresetExemptionCategory, this._newPresetExemptionRate);
+    }
+}
+exports.ItemTaxExemptLineModificationDecorator = ItemTaxExemptLineModificationDecorator;
+//# sourceMappingURL=ItemTaxExemptLineModificationDecorator.js.map

package/lib/domain/model/taxExempt/ModifyItemTaxExemptLine.d.ts

@@ -0,0 +1,28 @@
+import { ITransactionLine, UiBusinessEvent } from "@aptos-scp/scp-component-store-selling-core";
+import { ISameTransactionLineReference, ITaxAuthorityForExemption, ITransactionLineReferenceType, TaxExemptType } from "@aptos-scp/scp-types-commerce-transaction";
+import { BaseTransactionLine } from "../BaseTransactionLine";
+import { BaseTaxExemptLine } from "./BaseTaxExemptLine";
+export declare const MODIFY_ITEM_TAX_EXEMPT_LINE_TYPE = "ModifyItemTaxExempt";
+/**
+ * The ModifyTransactionTaxExemptLine Captures the action by the user to modify a transaction tax exempt line
+ */
+export declare class ModifyItemTaxExemptLine extends BaseTaxExemptLine {
+    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 {ModifyTransactionTaxExemptLine}
+     */
+    static create(lineNumber: number, lineType: string, uiBusinessEvent: UiBusinessEvent, collectedData: Readonly<Map<string, any>>): ModifyItemTaxExemptLine;
+    static createFromJsonObject(transactionLineJsonObj: any): ModifyItemTaxExemptLine;
+    get modifiedLineNumber(): ISameTransactionLineReference;
+    protected constructor(lineNumber: number, lineType: string, modifiedLineNumber: ISameTransactionLineReference, taxExemptType: TaxExemptType, certificateId: string, reasonCode?: string, reasonDescription?: string, reasonType?: string, supervisorOverrideLineReference?: ITransactionLineReferenceType, displayName?: string, exemptedTaxAuthorities?: ITaxAuthorityForExemption[], exemptedItemLineReferences?: ITransactionLineReferenceType[], presetRateExemption?: boolean, presetExemptionCategory?: string, presetExemptionRate?: string);
+    protected newTransactionLine(): BaseTransactionLine;
+}
+export declare function isModifyItemTaxExemptLine(transactionLine: ITransactionLine): transactionLine is ModifyItemTaxExemptLine;

package/lib/domain/model/taxExempt/ModifyItemTaxExemptLine.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 BaseTransactionLine_1 = require("../BaseTransactionLine");
+const Constants_1 = require("../Constants");
+const BaseTaxExemptLine_1 = require("./BaseTaxExemptLine");
+exports.MODIFY_ITEM_TAX_EXEMPT_LINE_TYPE = "ModifyItemTaxExempt";
+/**
+ * The ModifyTransactionTaxExemptLine Captures the action by the user to modify a transaction tax exempt line
+ */
+class ModifyItemTaxExemptLine extends BaseTaxExemptLine_1.BaseTaxExemptLine {
+    constructor(lineNumber, lineType, modifiedLineNumber, taxExemptType, certificateId, reasonCode, reasonDescription, reasonType, supervisorOverrideLineReference, displayName, exemptedTaxAuthorities, exemptedItemLineReferences, presetRateExemption, presetExemptionCategory, presetExemptionRate) {
+        super(lineNumber, lineType, taxExemptType, certificateId, reasonCode, reasonDescription, reasonType, supervisorOverrideLineReference, displayName, exemptedTaxAuthorities, exemptedItemLineReferences, presetRateExemption, presetExemptionCategory, presetExemptionRate);
+        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 {ModifyTransactionTaxExemptLine}
+     */
+    static create(lineNumber, lineType, uiBusinessEvent, collectedData) {
+        if (!(lineType === exports.MODIFY_ITEM_TAX_EXEMPT_LINE_TYPE)) {
+            throw new scp_component_store_selling_core_1.PosError(`The line type "${lineType}" is not supported by ModifyTransactionTaxExemptLine`, config_1.SSF_LINE_TYPE_ERROR_CODE);
+        }
+        const modifiedLineNumber = collectedData.get(Constants_1.CollectedDataKey.LineNumberReference);
+        const taxExemptType = BaseTaxExemptLine_1.BaseTaxExemptLine.taxExemptTypeFromCollectedData(collectedData);
+        const certificateId = BaseTaxExemptLine_1.BaseTaxExemptLine.certificateIdFromCollectedData(collectedData);
+        const modifyTaxExemptLine = new ModifyItemTaxExemptLine(lineNumber, lineType, modifiedLineNumber, taxExemptType, certificateId);
+        modifyTaxExemptLine.loadFromCollectedData(collectedData);
+        return modifyTaxExemptLine;
+    }
+    static createFromJsonObject(transactionLineJsonObj) {
+        const lineNumber = BaseTransactionLine_1.BaseTransactionLine.lineNumberFromJsonObject(transactionLineJsonObj);
+        const lineType = BaseTransactionLine_1.BaseTransactionLine.lineTypeFromJsonObject(transactionLineJsonObj);
+        const taxExemptType = BaseTaxExemptLine_1.BaseTaxExemptLine.taxExemptTypeFromJsonObject(transactionLineJsonObj);
+        const certificateId = BaseTaxExemptLine_1.BaseTaxExemptLine.certificateIdFromJsonObject(transactionLineJsonObj);
+        const modifiedLineNumber = transactionLineJsonObj._modifiedLineNumber;
+        const modifyTaxExemptLine = new ModifyItemTaxExemptLine(lineNumber, lineType, modifiedLineNumber, taxExemptType, certificateId);
+        modifyTaxExemptLine.loadFromJsonObject(transactionLineJsonObj);
+        return modifyTaxExemptLine;
+    }
+    get modifiedLineNumber() {
+        return this._modifiedLineNumber;
+    }
+    newTransactionLine() {
+        return new ModifyItemTaxExemptLine(this.lineNumber, this.lineType, this._modifiedLineNumber, this._taxExemptType, this._certificateId, this._reasonCode, this._reasonDescription, this._reasonListType, this._supervisorOverrideLineReference, this._displayName, this._exemptedTaxAuthorities, this._exemptedItemLineReferences, this._presetRateExemption, this._presetExemptionCategory, this._presetExemptionRate);
+    }
+}
+exports.ModifyItemTaxExemptLine = ModifyItemTaxExemptLine;
+function isModifyItemTaxExemptLine(transactionLine) {
+    return (transactionLine instanceof ModifyItemTaxExemptLine ||
+        (transactionLine && transactionLine.lineType === exports.MODIFY_ITEM_TAX_EXEMPT_LINE_TYPE));
+}
+exports.isModifyItemTaxExemptLine = isModifyItemTaxExemptLine;
+//# sourceMappingURL=ModifyItemTaxExemptLine.js.map

package/lib/domain/model/taxExempt/ModifyTransactionTaxExemptLine.d.ts

@@ -0,0 +1,28 @@
+import { ITransactionLine, UiBusinessEvent } from "@aptos-scp/scp-component-store-selling-core";
+import { ISameTransactionLineReference, ITaxAuthorityForExemption, ITransactionLineReferenceType, TaxExemptType } from "@aptos-scp/scp-types-commerce-transaction";
+import { BaseTransactionLine } from "../BaseTransactionLine";
+import { BaseTaxExemptLine } from "./BaseTaxExemptLine";
+export declare const MODIFY_TRANSACTION_TAX_EXEMPT_LINE_TYPE = "ModifyTransactionTaxExempt";
+/**
+ * The ModifyTransactionTaxExemptLine Captures the action by the user to modify a transaction tax exempt line
+ */
+export declare class ModifyTransactionTaxExemptLine extends BaseTaxExemptLine {
+    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 {ModifyTransactionTaxExemptLine}
+     */
+    static create(lineNumber: number, lineType: string, uiBusinessEvent: UiBusinessEvent, collectedData: Readonly<Map<string, any>>): ModifyTransactionTaxExemptLine;
+    static createFromJsonObject(transactionLineJsonObj: any): ModifyTransactionTaxExemptLine;
+    get modifiedLineNumber(): ISameTransactionLineReference;
+    protected constructor(lineNumber: number, lineType: string, modifiedLineNumber: ISameTransactionLineReference, taxExemptType: TaxExemptType, certificateId: string, reasonCode?: string, reasonDescription?: string, reasonType?: string, supervisorOverrideLineReference?: ITransactionLineReferenceType, displayName?: string, exemptedTaxAuthorities?: ITaxAuthorityForExemption[], presetRateExemption?: boolean, presetExemptionCategory?: string, presetExemptionRate?: string);
+    protected newTransactionLine(): BaseTransactionLine;
+}
+export declare function isModifyTransactionTaxExemptLine(transactionLine: ITransactionLine): transactionLine is ModifyTransactionTaxExemptLine;

package/lib/domain/model/taxExempt/ModifyTransactionTaxExemptLine.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 BaseTransactionLine_1 = require("../BaseTransactionLine");
+const Constants_1 = require("../Constants");
+const BaseTaxExemptLine_1 = require("./BaseTaxExemptLine");
+exports.MODIFY_TRANSACTION_TAX_EXEMPT_LINE_TYPE = "ModifyTransactionTaxExempt";
+/**
+ * The ModifyTransactionTaxExemptLine Captures the action by the user to modify a transaction tax exempt line
+ */
+class ModifyTransactionTaxExemptLine extends BaseTaxExemptLine_1.BaseTaxExemptLine {
+    constructor(lineNumber, lineType, modifiedLineNumber, taxExemptType, certificateId, reasonCode, reasonDescription, reasonType, supervisorOverrideLineReference, displayName, exemptedTaxAuthorities, presetRateExemption, presetExemptionCategory, presetExemptionRate) {
+        super(lineNumber, lineType, taxExemptType, certificateId, reasonCode, reasonDescription, reasonType, supervisorOverrideLineReference, displayName, exemptedTaxAuthorities, undefined, presetRateExemption, presetExemptionCategory, presetExemptionRate);
+        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 {ModifyTransactionTaxExemptLine}
+     */
+    static create(lineNumber, lineType, uiBusinessEvent, collectedData) {
+        if (!(lineType === exports.MODIFY_TRANSACTION_TAX_EXEMPT_LINE_TYPE)) {
+            throw new scp_component_store_selling_core_1.PosError(`The line type "${lineType}" is not supported by ModifyTransactionTaxExemptLine`, config_1.SSF_LINE_TYPE_ERROR_CODE);
+        }
+        const modifiedLineNumber = collectedData.get(Constants_1.CollectedDataKey.LineNumberReference);
+        const taxExemptType = BaseTaxExemptLine_1.BaseTaxExemptLine.taxExemptTypeFromCollectedData(collectedData);
+        const certificateId = BaseTaxExemptLine_1.BaseTaxExemptLine.certificateIdFromCollectedData(collectedData);
+        const modifyTransactionTaxExemptLine = new ModifyTransactionTaxExemptLine(lineNumber, lineType, modifiedLineNumber, taxExemptType, certificateId);
+        modifyTransactionTaxExemptLine.loadFromCollectedData(collectedData);
+        return modifyTransactionTaxExemptLine;
+    }
+    static createFromJsonObject(transactionLineJsonObj) {
+        const lineNumber = BaseTransactionLine_1.BaseTransactionLine.lineNumberFromJsonObject(transactionLineJsonObj);
+        const lineType = BaseTransactionLine_1.BaseTransactionLine.lineTypeFromJsonObject(transactionLineJsonObj);
+        const taxExemptType = BaseTaxExemptLine_1.BaseTaxExemptLine.taxExemptTypeFromJsonObject(transactionLineJsonObj);
+        const certificateId = BaseTaxExemptLine_1.BaseTaxExemptLine.certificateIdFromJsonObject(transactionLineJsonObj);
+        const modifiedLineNumber = transactionLineJsonObj._modifiedLineNumber;
+        const modifyTransactionTaxExemptLine = new ModifyTransactionTaxExemptLine(lineNumber, lineType, modifiedLineNumber, taxExemptType, certificateId);
+        modifyTransactionTaxExemptLine.loadFromJsonObject(transactionLineJsonObj);
+        return modifyTransactionTaxExemptLine;
+    }
+    get modifiedLineNumber() {
+        return this._modifiedLineNumber;
+    }
+    newTransactionLine() {
+        return new ModifyTransactionTaxExemptLine(this.lineNumber, this.lineType, this._modifiedLineNumber, this._taxExemptType, this._certificateId, this._reasonCode, this._reasonDescription, this._reasonListType, this._supervisorOverrideLineReference, this._displayName, this._exemptedTaxAuthorities, this._presetRateExemption, this._presetExemptionCategory, this._presetExemptionRate);
+    }
+}
+exports.ModifyTransactionTaxExemptLine = ModifyTransactionTaxExemptLine;
+function isModifyTransactionTaxExemptLine(transactionLine) {
+    return (transactionLine instanceof ModifyTransactionTaxExemptLine ||
+        (transactionLine && transactionLine.lineType === exports.MODIFY_TRANSACTION_TAX_EXEMPT_LINE_TYPE));
+}
+exports.isModifyTransactionTaxExemptLine = isModifyTransactionTaxExemptLine;
+//# sourceMappingURL=ModifyTransactionTaxExemptLine.js.map

package/lib/domain/model/taxExempt/TransactionTaxExemptLine.d.ts

@@ -0,0 +1,23 @@
+import { ITransactionLine, UiBusinessEvent } from "@aptos-scp/scp-component-store-selling-core";
+import { ITaxAuthorityForExemption, ITransactionLineReferenceType, TaxExemptType } from "@aptos-scp/scp-types-commerce-transaction";
+import { BaseTransactionLine } from "../BaseTransactionLine";
+import { BaseTaxExemptLine } from "./BaseTaxExemptLine";
+export declare const TRANSACTION_TAX_EXEMPT_LINE_TYPE = "TransactionTaxExempt";
+export declare class TransactionTaxExemptLine extends BaseTaxExemptLine {
+    /**
+     * 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 {TransactionTaxExemptLine}
+     */
+    static create(lineNumber: number, lineType: string, uiBusinessEvent: UiBusinessEvent, collectedData: Readonly<Map<string, any>>): TransactionTaxExemptLine;
+    static createFromJsonObject(transactionLineJsonObj: any): TransactionTaxExemptLine;
+    protected constructor(lineNumber: number, lineType: string, taxExemptType: TaxExemptType, certificateId: string, reasonCode?: string, reasonDescription?: string, reasonType?: string, supervisorOverrideLineReference?: ITransactionLineReferenceType, displayName?: string, exemptedTaxAuthorities?: ITaxAuthorityForExemption[], presetRateExemption?: boolean, presetExemptionCategory?: string, presetExemptionRate?: string);
+    protected newTransactionLine(): BaseTransactionLine;
+}
+export declare function isTransactionTaxExemptLine(transactionLine: ITransactionLine): transactionLine is TransactionTaxExemptLine;

package/lib/domain/model/taxExempt/TransactionTaxExemptLine.js

@@ -0,0 +1,47 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const BaseTransactionLine_1 = require("../BaseTransactionLine");
+const BaseTaxExemptLine_1 = require("./BaseTaxExemptLine");
+exports.TRANSACTION_TAX_EXEMPT_LINE_TYPE = "TransactionTaxExempt";
+class TransactionTaxExemptLine extends BaseTaxExemptLine_1.BaseTaxExemptLine {
+    /**
+     * 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 {TransactionTaxExemptLine}
+     */
+    static create(lineNumber, lineType, uiBusinessEvent, collectedData) {
+        const taxExemptType = BaseTaxExemptLine_1.BaseTaxExemptLine.taxExemptTypeFromCollectedData(collectedData);
+        const certificateId = BaseTaxExemptLine_1.BaseTaxExemptLine.certificateIdFromCollectedData(collectedData);
+        const transactionTaxExemptLine = new TransactionTaxExemptLine(lineNumber, lineType, taxExemptType, certificateId);
+        transactionTaxExemptLine.loadFromCollectedData(collectedData);
+        return transactionTaxExemptLine;
+    }
+    static createFromJsonObject(transactionLineJsonObj) {
+        const lineNumber = BaseTransactionLine_1.BaseTransactionLine.lineNumberFromJsonObject(transactionLineJsonObj);
+        const lineType = BaseTransactionLine_1.BaseTransactionLine.lineTypeFromJsonObject(transactionLineJsonObj);
+        const taxExemptType = BaseTaxExemptLine_1.BaseTaxExemptLine.taxExemptTypeFromJsonObject(transactionLineJsonObj);
+        const certificateId = BaseTaxExemptLine_1.BaseTaxExemptLine.certificateIdFromJsonObject(transactionLineJsonObj);
+        const taxExemptLine = new TransactionTaxExemptLine(lineNumber, lineType, taxExemptType, certificateId);
+        taxExemptLine.loadFromJsonObject(transactionLineJsonObj);
+        return taxExemptLine;
+    }
+    constructor(lineNumber, lineType, taxExemptType, certificateId, reasonCode, reasonDescription, reasonType, supervisorOverrideLineReference, displayName, exemptedTaxAuthorities, presetRateExemption, presetExemptionCategory, presetExemptionRate) {
+        super(lineNumber, lineType, taxExemptType, certificateId, reasonCode, reasonDescription, reasonType, supervisorOverrideLineReference, displayName, exemptedTaxAuthorities, undefined, presetRateExemption, presetExemptionCategory, presetExemptionRate, certificateId, reasonCode, reasonDescription, displayName, exemptedTaxAuthorities);
+    }
+    newTransactionLine() {
+        return new TransactionTaxExemptLine(this.lineNumber, this.lineType, this._taxExemptType, this._certificateId, this._reasonCode, this._reasonDescription, this._reasonListType, this._supervisorOverrideLineReference, this._displayName, this._exemptedTaxAuthorities, this._presetRateExemption, this._presetExemptionCategory, this._presetExemptionRate);
+    }
+}
+exports.TransactionTaxExemptLine = TransactionTaxExemptLine;
+function isTransactionTaxExemptLine(transactionLine) {
+    return (transactionLine instanceof TransactionTaxExemptLine ||
+        (transactionLine && transactionLine.lineType === exports.TRANSACTION_TAX_EXEMPT_LINE_TYPE));
+}
+exports.isTransactionTaxExemptLine = isTransactionTaxExemptLine;
+//# sourceMappingURL=TransactionTaxExemptLine.js.map

package/lib/domain/model/taxExempt/TransactionTaxExemptLineModificationDecorator.d.ts

@@ -0,0 +1,32 @@
+import { ITransactionLine, ITransactionLineFactory } from "@aptos-scp/scp-component-store-selling-core";
+import { ITaxAuthorityForExemption, TaxExemptType } from "@aptos-scp/scp-types-commerce-transaction";
+import { BaseTaxExemptLineDecorator } from "./BaseTaxExemptLineDecorator";
+import { TransactionTaxExemptLine } from "./TransactionTaxExemptLine";
+export declare const DECORATOR_TYPE_TRANSACTION_TAX_EXEMPT_CHANGE: string;
+export declare function isTransactionTaxExemptLineModificationDecorator(transactionLine: ITransactionLine): transactionLine is TransactionTaxExemptLineModificationDecorator;
+export declare class TransactionTaxExemptLineModificationDecorator extends BaseTaxExemptLineDecorator {
+    private _newTaxExemptType;
+    private _newCertificateId;
+    private _newReasonCode;
+    private _newReasonDescription;
+    private _newReasonListType;
+    private _newDisplayName?;
+    private _newExemptedTaxAuthorities?;
+    private _newPresetRateExemption?;
+    private _newPresetExemptionCategory?;
+    private _newPresetExemptionRate?;
+    static createFromJsonObject(transactionLineJsonObj: any, transactionLineFactory: ITransactionLineFactory): TransactionTaxExemptLineModificationDecorator;
+    constructor(transactionTaxExemptLine: TransactionTaxExemptLine, annotationSourceLineNumber: number, newTaxExemptType: TaxExemptType, newCertificateId: string, newReasonCode?: string, newReasonDescription?: string, newReasonListType?: string, newDisplayName?: string, newExemptedTaxAuthorities?: ITaxAuthorityForExemption[], newPresetRateExemption?: boolean, newPresetExemptionCategory?: string, newPresetExemptionRate?: string);
+    get taxExemptType(): TaxExemptType;
+    get certificateId(): string;
+    get reasonCode(): string;
+    get reasonDescription(): string;
+    get reasonListType(): string;
+    get displayName(): string;
+    get exemptedTaxAuthorities(): ITaxAuthorityForExemption[];
+    get presetRateExemption(): boolean;
+    get presetExemptionCategory(): string;
+    get presetExemptionRate(): string;
+    protected clone(): BaseTaxExemptLineDecorator;
+    protected newTransactionLine(): BaseTaxExemptLineDecorator;
+}

package/lib/domain/model/taxExempt/TransactionTaxExemptLineModificationDecorator.js

@@ -0,0 +1,93 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const BaseTaxExemptLineDecorator_1 = require("./BaseTaxExemptLineDecorator");
+const TRANSACTION_TAX_EXEMPT_ANNOTATION_SOURCE_TYPE = "ModifyTransactionTaxExempt";
+exports.DECORATOR_TYPE_TRANSACTION_TAX_EXEMPT_CHANGE = "TRANSACTION_TAX_EXEMPT_CHANGE_DECORATOR_TYPE";
+function isTransactionTaxExemptLineModificationDecorator(transactionLine) {
+    return (transactionLine.lineDecoratorType ===
+        exports.DECORATOR_TYPE_TRANSACTION_TAX_EXEMPT_CHANGE);
+}
+exports.isTransactionTaxExemptLineModificationDecorator = isTransactionTaxExemptLineModificationDecorator;
+class TransactionTaxExemptLineModificationDecorator extends BaseTaxExemptLineDecorator_1.BaseTaxExemptLineDecorator {
+    constructor(transactionTaxExemptLine, annotationSourceLineNumber, newTaxExemptType, newCertificateId, newReasonCode, newReasonDescription, newReasonListType, newDisplayName, newExemptedTaxAuthorities, newPresetRateExemption, newPresetExemptionCategory, newPresetExemptionRate) {
+        super(exports.DECORATOR_TYPE_TRANSACTION_TAX_EXEMPT_CHANGE, transactionTaxExemptLine, undefined, TRANSACTION_TAX_EXEMPT_ANNOTATION_SOURCE_TYPE, annotationSourceLineNumber);
+        this._newTaxExemptType = newTaxExemptType;
+        this._newCertificateId = newCertificateId;
+        this._newReasonCode = newReasonCode;
+        this._newReasonDescription = newReasonDescription;
+        this._newReasonListType = newReasonListType;
+        this._newDisplayName = newDisplayName;
+        this._newExemptedTaxAuthorities = newExemptedTaxAuthorities;
+        this._newPresetRateExemption = newPresetRateExemption;
+        this._newPresetExemptionCategory = newPresetExemptionCategory;
+        this._newPresetExemptionRate = newPresetExemptionRate;
+    }
+    static createFromJsonObject(transactionLineJsonObj, transactionLineFactory) {
+        const decoratedTransactionLineJsonObj = BaseTaxExemptLineDecorator_1.BaseTaxExemptLineDecorator.getDecoratedTransactionLineJsonObjectFromJsonObject(transactionLineJsonObj);
+        const decoratedTransactionTaxExemptLine = transactionLineFactory.createTransactionLineFromJsonObj(decoratedTransactionLineJsonObj);
+        const newTaxExemptType = transactionLineJsonObj._newTaxExemptType;
+        const newCertificateId = transactionLineJsonObj._newCertificateId;
+        const newReasonCode = transactionLineJsonObj._newReasonCode;
+        const newReasonDescription = transactionLineJsonObj._newReasonDescription;
+        const newReasonListType = transactionLineJsonObj._newReasonListType;
+        const newDisplayName = transactionLineJsonObj._newDisplayName;
+        const newExemptedTaxAuthorities = transactionLineJsonObj._newExemptedTaxAuthorities;
+        const newPresetRateExemption = transactionLineJsonObj._newPresetRateExemption;
+        const newPresetExemptionCategory = transactionLineJsonObj._newPresetExemptionCategory;
+        const newPresetExemptionRate = transactionLineJsonObj._newPresetExemptionRate;
+        const annotationSourceLineNumber = BaseTaxExemptLineDecorator_1.BaseTaxExemptLineDecorator.getAnnotationSourceLineNumberFromJsonObject(transactionLineJsonObj);
+        const transactionTaxExemptLineModificationDecorator = new TransactionTaxExemptLineModificationDecorator(decoratedTransactionTaxExemptLine, annotationSourceLineNumber, newTaxExemptType, newCertificateId, newReasonCode, newReasonDescription, newReasonListType, newDisplayName, newExemptedTaxAuthorities, newPresetRateExemption, newPresetExemptionCategory, newPresetExemptionRate);
+        return transactionTaxExemptLineModificationDecorator;
+    }
+    get taxExemptType() {
+        return this._newTaxExemptType || this.decoratedTransactionLine.taxExemptType;
+    }
+    get certificateId() {
+        return this._newCertificateId;
+    }
+    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 displayName() {
+        return this._newDisplayName;
+    }
+    get exemptedTaxAuthorities() {
+        return this._newExemptedTaxAuthorities;
+    }
+    get presetRateExemption() {
+        return this._newPresetRateExemption;
+    }
+    get presetExemptionCategory() {
+        return this._newPresetExemptionCategory;
+    }
+    get presetExemptionRate() {
+        return this._newPresetExemptionRate;
+    }
+    clone() {
+        const newTransactionTaxExemptLineModificationDecorator = super.clone();
+        newTransactionTaxExemptLineModificationDecorator._newTaxExemptType = this._newTaxExemptType;
+        newTransactionTaxExemptLineModificationDecorator._newCertificateId = this._newCertificateId;
+        newTransactionTaxExemptLineModificationDecorator._newReasonCode = this._newReasonCode;
+        newTransactionTaxExemptLineModificationDecorator._newReasonDescription = this._newReasonDescription;
+        newTransactionTaxExemptLineModificationDecorator._newReasonListType = this._newReasonListType;
+        newTransactionTaxExemptLineModificationDecorator._newDisplayName = this._newDisplayName;
+        newTransactionTaxExemptLineModificationDecorator._newExemptedTaxAuthorities =
+            this._newExemptedTaxAuthorities;
+        newTransactionTaxExemptLineModificationDecorator._newPresetRateExemption = this._newPresetRateExemption;
+        newTransactionTaxExemptLineModificationDecorator._newPresetExemptionCategory =
+            this._newPresetExemptionCategory;
+        newTransactionTaxExemptLineModificationDecorator._newPresetExemptionRate = this._newPresetExemptionRate;
+        return newTransactionTaxExemptLineModificationDecorator;
+    }
+    newTransactionLine() {
+        return new TransactionTaxExemptLineModificationDecorator(this.decoratedTransactionLine, this.annotationSourceLineNumber, this._newTaxExemptType, this._newCertificateId, this._newReasonCode, this._newReasonDescription, this._newReasonListType, this._newDisplayName, this._newExemptedTaxAuthorities, this._newPresetRateExemption, this._newPresetExemptionCategory, this._newPresetExemptionRate);
+    }
+}
+exports.TransactionTaxExemptLineModificationDecorator = TransactionTaxExemptLineModificationDecorator;
+//# sourceMappingURL=TransactionTaxExemptLineModificationDecorator.js.map

package/lib/domain/model/taxExempt/VoidedItemTaxExemptLineDecorator.d.ts

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