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

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

@@ -0,0 +1,63 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const scp_component_business_core_1 = require("@aptos-scp/scp-component-business-core");
+const FeeLineExtendedAmountDecorator_1 = require("./FeeLineExtendedAmountDecorator");
+const BaseFeeLineDecorator_1 = require("./BaseFeeLineDecorator");
+const FeeLineBaseTaxAdjustmentDecorator_1 = require("./FeeLineBaseTaxAdjustmentDecorator");
+exports.DECORATOR_TYPE_FEE_LINE_TAX_OVERRIDE = "FEE_LINE_TAX_OVERRIDE_DECORATOR";
+class FeeLineTaxOverrideDecorator extends FeeLineBaseTaxAdjustmentDecorator_1.FeeLineBaseTaxAdjustmentDecorator {
+    constructor(decoratedLine, annotationSourceLineNumber, taxOverride, preTaxOverrideDetails, feeTaxAdjustmentAmount, extendedAmountAfterTaxAdjustment, unitAmountAfterTaxAdjustment, extendedAmountFields, sublines) {
+        super(exports.DECORATOR_TYPE_FEE_LINE_TAX_OVERRIDE, decoratedLine, undefined, FeeLineBaseTaxAdjustmentDecorator_1.FEE_TAX_ANNOTATION_SOURCE_TYPE, annotationSourceLineNumber, extendedAmountAfterTaxAdjustment, unitAmountAfterTaxAdjustment, extendedAmountFields, sublines);
+        this._taxOverride = taxOverride;
+        this._preTaxOverrideDetails = preTaxOverrideDetails;
+        this._feeTaxAdjustmentAmount = feeTaxAdjustmentAmount;
+    }
+    static createFromJsonObject(transactionLineJsonObj, transactionLineFactory) {
+        const decoratedTransactionLineJsonObj = BaseFeeLineDecorator_1.BaseFeeLineDecorator.getDecoratedTransactionLineJsonObjectFromJsonObject(transactionLineJsonObj);
+        const decoratedItemLine = transactionLineFactory.createTransactionLineFromJsonObj(decoratedTransactionLineJsonObj);
+        const taxOverride = transactionLineJsonObj._taxOverride;
+        const preTaxOverrideDetails = transactionLineJsonObj._preTaxOverrideDetails;
+        const feeTaxAdjustmentAmount = transactionLineJsonObj._feeTaxAdjustmentAmount
+            ? scp_component_business_core_1.Money.fromJSON(transactionLineJsonObj._feeTaxAdjustmentAmount)
+            : undefined;
+        const extendedAmountAfterTaxAdjustment = FeeLineBaseTaxAdjustmentDecorator_1.FeeLineBaseTaxAdjustmentDecorator.getExtendedAmountAfterTaxAdjustmentFromJsonObject(transactionLineJsonObj);
+        const unitAmountAfterTaxAdjustment = FeeLineBaseTaxAdjustmentDecorator_1.FeeLineBaseTaxAdjustmentDecorator.getUnitAmountAfterTaxAdjustmentFromJsonObject(transactionLineJsonObj);
+        const annotationSourceLineNumber = BaseFeeLineDecorator_1.BaseFeeLineDecorator.getAnnotationSourceLineNumberFromJsonObject(transactionLineJsonObj);
+        const extendedAmountFields = FeeLineExtendedAmountDecorator_1.FeeLineExtendedAmountDecorator.getExtendedAmountFieldsFromJsonObject(transactionLineJsonObj);
+        const sublines = FeeLineBaseTaxAdjustmentDecorator_1.FeeLineBaseTaxAdjustmentDecorator.getSublinesFromJsonObject(transactionLineJsonObj);
+        const transactionFeeLineTaxOverrideDecorator = new FeeLineTaxOverrideDecorator(decoratedItemLine, annotationSourceLineNumber, taxOverride, preTaxOverrideDetails, feeTaxAdjustmentAmount, extendedAmountAfterTaxAdjustment, unitAmountAfterTaxAdjustment, extendedAmountFields, sublines);
+        return transactionFeeLineTaxOverrideDecorator;
+    }
+    get taxOverride() {
+        return this._taxOverride;
+    }
+    get preTaxOverrideDetails() {
+        return this._preTaxOverrideDetails;
+    }
+    get feeTaxAdjustmentAmount() {
+        return this._feeTaxAdjustmentAmount;
+    }
+    clone() {
+        const transactionFeeLineTaxOverrideDecorator = super.clone();
+        transactionFeeLineTaxOverrideDecorator._taxOverride = this._taxOverride;
+        transactionFeeLineTaxOverrideDecorator._preTaxOverrideDetails = this._preTaxOverrideDetails;
+        transactionFeeLineTaxOverrideDecorator._feeTaxAdjustmentAmount = this._feeTaxAdjustmentAmount;
+        return transactionFeeLineTaxOverrideDecorator;
+    }
+    newTransactionLine() {
+        return new FeeLineTaxOverrideDecorator(this.decoratedTransactionLine, this.annotationSourceLineNumber, this._taxOverride, this._preTaxOverrideDetails, this._feeTaxAdjustmentAmount, this.extendedAmountAfterTaxAdjustment, this.unitAmountAfterTaxAdjustment, {
+            extendedAmount: this.extendedAmount,
+            extendedAmountExcludingTax: this.extendedAmountExcludingTax,
+            extendedAmountIncludingTax: this.extendedAmountIncludingTax,
+            taxByAuthority: this.taxByAuthority,
+            totalLineTax: this.totalLineTax,
+        }, this.sublines);
+    }
+}
+exports.FeeLineTaxOverrideDecorator = FeeLineTaxOverrideDecorator;
+function isFeeLineTaxOverrideDecorator(transactionLine) {
+    return (transactionLine.lineDecoratorType ===
+        exports.DECORATOR_TYPE_FEE_LINE_TAX_OVERRIDE);
+}
+exports.isFeeLineTaxOverrideDecorator = isFeeLineTaxOverrideDecorator;
+//# sourceMappingURL=FeeLineTaxOverrideDecorator.js.map

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

@@ -0,0 +1,19 @@
+import { Quantity } from "@aptos-scp/scp-component-business-core";
+import { ITransactionLine } from "@aptos-scp/scp-component-store-selling-core";
+import { ISameTransactionLineReference } from "@aptos-scp/scp-types-commerce-transaction";
+import { BaseTransactionLine } from "../BaseTransactionLine";
+export declare const TRANSACTION_FEE_QUANTITY_CHANGE_LINE_TYPE = "TransactionFeeQuantityChange";
+export declare class FeeQuantityChangeLine extends BaseTransactionLine {
+    protected _quantity: Quantity;
+    protected _prevQuantity: Quantity;
+    protected _feeLineReference: ISameTransactionLineReference;
+    static create(lineNumber: number, lineType: string, collectedData: Readonly<Map<string, any>>): FeeQuantityChangeLine;
+    static createFromJsonObject(transactionLineJsonObj: any): FeeQuantityChangeLine;
+    protected constructor(lineNumber: number, lineType: string, quantity: Quantity, prevQuantity: Quantity, feeLineReference: ISameTransactionLineReference);
+    get couldAffectPricing(): boolean;
+    protected newTransactionLine(): BaseTransactionLine;
+    get feeLineReference(): ISameTransactionLineReference;
+    get quantity(): Quantity;
+    get prevQuantity(): Quantity;
+}
+export declare function isTransactionFeeQuantityChangeLine(transactionLine: ITransactionLine): transactionLine is FeeQuantityChangeLine;

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

@@ -0,0 +1,52 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const BaseTransactionLine_1 = require("../BaseTransactionLine");
+const Constants_1 = require("../Constants");
+exports.TRANSACTION_FEE_QUANTITY_CHANGE_LINE_TYPE = "TransactionFeeQuantityChange";
+class FeeQuantityChangeLine extends BaseTransactionLine_1.BaseTransactionLine {
+    constructor(lineNumber, lineType, quantity, prevQuantity, feeLineReference) {
+        super(lineNumber, lineType);
+        this._quantity = quantity;
+        this._prevQuantity = prevQuantity;
+        this._feeLineReference = feeLineReference;
+    }
+    static create(lineNumber, lineType, collectedData) {
+        const quantity = collectedData.get(Constants_1.CollectedDataKey.Quantity);
+        const prevQuantity = collectedData.get(Constants_1.CollectedDataKey.PrevFeeQuantity);
+        const feeLineReference = collectedData.get(Constants_1.CollectedDataKey.FeeLineReference);
+        const transactionFeeQuantityChangeLine = new FeeQuantityChangeLine(lineNumber, lineType, quantity, prevQuantity, feeLineReference);
+        return transactionFeeQuantityChangeLine;
+    }
+    static createFromJsonObject(transactionLineJsonObj) {
+        const lineNumber = BaseTransactionLine_1.BaseTransactionLine.lineNumberFromJsonObject(transactionLineJsonObj);
+        const lineType = BaseTransactionLine_1.BaseTransactionLine.lineTypeFromJsonObject(transactionLineJsonObj);
+        const feeLineReference = transactionLineJsonObj._feeLineReference;
+        const quantity = transactionLineJsonObj._quantity;
+        const prevQuantity = transactionLineJsonObj._prevQuantity;
+        const transactionFeeQuantityChangeLine = new FeeQuantityChangeLine(lineNumber, lineType, quantity, prevQuantity, feeLineReference);
+        transactionFeeQuantityChangeLine.loadFromJsonObject(transactionLineJsonObj);
+        return transactionFeeQuantityChangeLine;
+    }
+    get couldAffectPricing() {
+        return true;
+    }
+    newTransactionLine() {
+        return new FeeQuantityChangeLine(this.lineNumber, this.lineType, this._quantity, this._prevQuantity, this._feeLineReference);
+    }
+    get feeLineReference() {
+        return this._feeLineReference;
+    }
+    get quantity() {
+        return this._quantity;
+    }
+    get prevQuantity() {
+        return this._prevQuantity;
+    }
+}
+exports.FeeQuantityChangeLine = FeeQuantityChangeLine;
+function isTransactionFeeQuantityChangeLine(transactionLine) {
+    return (transactionLine instanceof FeeQuantityChangeLine ||
+        transactionLine.lineType === exports.TRANSACTION_FEE_QUANTITY_CHANGE_LINE_TYPE);
+}
+exports.isTransactionFeeQuantityChangeLine = isTransactionFeeQuantityChangeLine;
+//# sourceMappingURL=FeeQuantityChangeLine.js.map

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

@@ -0,0 +1,104 @@
+import { Money, Price, Quantity } from "@aptos-scp/scp-component-business-core";
+import { ITransactionLine } from "@aptos-scp/scp-component-store-selling-core";
+import { IAppliedTax } from "@aptos-scp/scp-component-taxation";
+import { FeeType, ISameTransactionLineReference, ITransactionLineReferenceType, ITaxByTaxAuthority, ITaxByTaxRule, ITaxExempt, ITaxOverride, IFeeSubline as IPostableFeeSubline, SourceIndicator, ITaxOverrideDetails } from "@aptos-scp/scp-types-commerce-transaction";
+import { ItemTaxExemptLine, TaxOverrideLine, TransactionTaxExemptLine } from "..";
+import { ITransactionLineTaxes } from "../item/IItemLine";
+import { IVoidableLine } from "../VoidInterfaces";
+export interface IFeeLine extends ITransactionLine, IVoidableLine {
+    readonly feeType: FeeType;
+    readonly feeId: string;
+    readonly unitPrice: Price;
+    readonly quantity: Quantity;
+    readonly customFeeType?: string;
+    readonly unitAmount?: Money;
+    readonly description: string;
+    readonly externalId: string;
+    readonly departmentGroupId: string;
+    readonly longDescription: string;
+    readonly departmentId: string;
+    readonly orderReferenceId?: string;
+    /**
+     * This will no longer be used in the future. Use the direct line instead. DSS-17031
+     */
+    readonly feesByFulfillmentGroup?: IFulfillmentGroupFee[];
+    readonly fulfillmentGroupIds?: string[];
+    readonly taxGroupId: string;
+    readonly taxByAuthority: IAppliedTax[];
+    readonly taxExemptDisplayName: string;
+    readonly taxExempt: ITaxExempt;
+    readonly preTaxExemptDetails?: IAppliedTax[];
+    readonly taxOverride?: ITaxOverride;
+    readonly preTaxOverrideDetails?: ITaxByTaxRule[];
+    readonly taxationCalculationSourceIndicator?: SourceIndicator;
+    readonly taxationDataSourceIndicator?: SourceIndicator;
+    readonly pricingCalculationSourceIndicator?: SourceIndicator;
+    readonly pricingDataSourceIndicator?: SourceIndicator;
+    readonly totalLineTax: Money;
+    readonly feeTaxExemptAmount?: Money;
+    readonly feeTaxAdjustmentAmount?: Money;
+    readonly extendedAmountAfterTaxAdjustment?: Money;
+    readonly unitAmountAfterTaxAdjustment?: Money;
+    readonly autoApplied?: boolean;
+    readonly quantityAllowed?: boolean;
+    readonly itemLineReference?: ISameTransactionLineReference;
+    readonly percent?: string;
+    readonly maximumAmount?: Money;
+    readonly returnRule?: string;
+    readonly sublines?: IFeeSubline[];
+    readonly originalTaxOverride?: ITaxOverrideDetails;
+    readonly originalTransactionLineReference?: ITransactionLineReferenceType;
+    /**
+     * For returnWithTransaction, the subLine of the item fee being return from the original transaction.
+     */
+    readonly sublineFromOriginalItemFee?: IPostableFeeSubline;
+    /**
+     * For returnWithTransaction, the sequence number of the item fee being return from the original Canonical transaction.
+     */
+    readonly lineNumberFromReturnCanonicalTransaction?: number;
+    /**
+     * For returnWithTransaction, sequence number of the subFee on the item fee being return from the original Canonical transaction.
+     */
+    readonly sublineIndexFromReturnCanonicalTransaction?: number;
+    /**
+     * For returnWithTransaction, the line number of the item being return from the original merchandise transaction.
+     */
+    readonly lineNumberFromReturnTransaction?: number;
+    readonly unitAmountBeforeOverride?: Money;
+    setTransactionLineTaxes(transactionLineTaxes: ITransactionLineTaxes, extendedAmount?: Money): IFeeLine;
+    setSublines(sublines: IFeeSubline[]): IFeeLine;
+    setTaxExemptInformation(taxExemptLine: ItemTaxExemptLine | TransactionTaxExemptLine, preTaxExemptDetails: IAppliedTax[]): IFeeLine;
+    setTaxOverrideInformation(taxOverrideLine: TaxOverrideLine, preTaxOverrideDetails: ITaxByTaxRule[]): IFeeLine;
+    setTaxationSourceIndicator(calculationSourceIndicator?: SourceIndicator, dataSourceIndicator?: SourceIndicator): IFeeLine;
+    setPricingSourceIndicator(calculationSourceIndicator?: SourceIndicator, dataSourceIndicator?: SourceIndicator): IFeeLine;
+}
+/**
+ * @deprecated This will no longer be used in the future. Use the direct line instead. DSS-17031
+ */
+export interface IFulfillmentGroupFee {
+    readonly fulfillmentGroupId?: string;
+    readonly feeId: string;
+    readonly description: string;
+    readonly externalId?: string;
+    readonly longDescription: string;
+    readonly departmentId?: string;
+    readonly departmentGroupId?: string;
+    readonly unitAmount: Money;
+    readonly quantity: Quantity;
+    readonly extendedAmount: Money;
+    readonly extendedAmountIncludingTax: Money;
+    readonly extendedAmountExcludingTax: Money;
+}
+export interface IFeeSubline {
+    readonly quantity: number;
+    readonly itemSublineIndex: number;
+    readonly taxByAuthority: ITaxByTaxAuthority[];
+    readonly extendedAmountExcludingTax?: Money;
+    readonly extendedAmountIncludingTax?: Money;
+    readonly replacementUnitPrice?: Price;
+    readonly extendedAmount?: Money;
+    readonly taxExemptDisplayName?: string;
+    readonly taxOverride?: ITaxOverride;
+    readonly preTaxOverrideDetails?: ITaxByTaxRule[];
+    readonly extendedAmountAfterTaxAdjustment?: Money;
+}

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

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

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

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

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

@@ -0,0 +1,38 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const BaseLineDecorator_1 = require("../../model/BaseLineDecorator");
+const VoidedLineDecorator_1 = require("../void/VoidedLineDecorator");
+const BaseFeeLineDecorator_1 = require("./BaseFeeLineDecorator");
+const VOIDED_FEE_ANNOTATION_SOURCE_TYPE = "VoidedFee";
+exports.DECORATOR_TYPE_VOIDED_FEE_LINE = "VOIDED_FEE_LINE_DECORATOR";
+class VoidedFeeLineDecorator extends BaseFeeLineDecorator_1.BaseFeeLineDecorator {
+    constructor(voidSource, feeLine, annotationSourceLineNumber) {
+        super(exports.DECORATOR_TYPE_VOIDED_FEE_LINE, feeLine, VoidedLineDecorator_1.DECORATOR_DESCRIPTION_VOIDED, VOIDED_FEE_ANNOTATION_SOURCE_TYPE, annotationSourceLineNumber);
+        this._voidSource = voidSource;
+    }
+    static createFromJsonObject(transactionLineJsonObj, transactionLineFactory) {
+        const decoratedTransactionLineJsonObj = BaseLineDecorator_1.BaseLineDecorator.getDecoratedTransactionLineJsonObjectFromJsonObject(transactionLineJsonObj);
+        const decoratedFeeLine = transactionLineFactory.createTransactionLineFromJsonObj(decoratedTransactionLineJsonObj);
+        const annotationSourceLineNumber = BaseLineDecorator_1.BaseLineDecorator.getAnnotationSourceLineNumberFromJsonObject(transactionLineJsonObj);
+        const voidSource = transactionLineJsonObj._voidSource;
+        const voidedFeeLineDecorator = new VoidedFeeLineDecorator(voidSource, decoratedFeeLine, annotationSourceLineNumber);
+        return voidedFeeLineDecorator;
+    }
+    get preventsTransactionVoid() {
+        return false;
+    }
+    get allowVoid() {
+        return true;
+    }
+    get voided() {
+        return true;
+    }
+    get voidSource() {
+        return this._voidSource;
+    }
+    newTransactionLine() {
+        return new VoidedFeeLineDecorator(this._voidSource, this.decoratedTransactionLine, this.annotationSourceLineNumber);
+    }
+}
+exports.VoidedFeeLineDecorator = VoidedFeeLineDecorator;
+//# sourceMappingURL=VoidedFeeLineDecorator.js.map

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

@@ -0,0 +1,12 @@
+export * from "./FeeLine";
+export * from "./IFeeLine";
+export * from "./VoidedFeeLineDecorator";
+export * from "./FeeLineChangeQuantityDecorator";
+export * from "./BaseFeeLineDecorator";
+export * from "./FeeQuantityChangeLine";
+export * from "./FeeLineExtendedAmountDecorator";
+export * from "./FeeLineBaseTaxAdjustmentDecorator";
+export * from "./FeeLineTaxExemptDecorator";
+export * from "./FeeLineTaxOverrideDecorator";
+export * from "./FeeLinePricingExtendedAmountDecorator";
+export * from "./FeeLineOriginalPricingAdjustmentDecorator";

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

@@ -0,0 +1,17 @@
+"use strict";
+function __export(m) {
+    for (var p in m) if (!exports.hasOwnProperty(p)) exports[p] = m[p];
+}
+Object.defineProperty(exports, "__esModule", { value: true });
+__export(require("./FeeLine"));
+__export(require("./VoidedFeeLineDecorator"));
+__export(require("./FeeLineChangeQuantityDecorator"));
+__export(require("./BaseFeeLineDecorator"));
+__export(require("./FeeQuantityChangeLine"));
+__export(require("./FeeLineExtendedAmountDecorator"));
+__export(require("./FeeLineBaseTaxAdjustmentDecorator"));
+__export(require("./FeeLineTaxExemptDecorator"));
+__export(require("./FeeLineTaxOverrideDecorator"));
+__export(require("./FeeLinePricingExtendedAmountDecorator"));
+__export(require("./FeeLineOriginalPricingAdjustmentDecorator"));
+//# sourceMappingURL=index.js.map

package/lib/domain/model/fiscalDevice/FiscalDeviceManagementLine.d.ts

@@ -0,0 +1,34 @@
+import { ITransactionLine, UiBusinessEvent } from "@aptos-scp/scp-component-store-selling-core";
+import { ITransactionLineReferenceType } from "@aptos-scp/scp-types-commerce-transaction";
+import { BaseTransactionLine } from "../BaseTransactionLine";
+/**
+ * This line type to record that a request for the fiscal device info was made and
+ * which fiscal device it is working with.
+ */
+export declare const FISCAL_DEVICE_INFORMATION_LINE_TYPE: string;
+export declare const FISCAL_DEVICE_REPLACEMENT_LINE_TYPE: string;
+export declare const FISCAL_DEVICE_SETUP_LINE_TYPE: string;
+export declare const PRINTER_REPLACEMENT_LINE_TYPE: string;
+export declare class FiscalDeviceManagementLine extends BaseTransactionLine {
+    private _peripheralDeviceId;
+    private _supervisorOverrideLineReference?;
+    /**
+     * 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 {FiscalDeviceManagementLine}
+     */
+    static create(lineNumber: number, lineType: string, uiBusinessEvent: UiBusinessEvent, collectedData: Readonly<Map<string, any>>): FiscalDeviceManagementLine;
+    static createFromJsonObject(transactionLineJsonObj: any): FiscalDeviceManagementLine;
+    get couldAffectPricing(): boolean;
+    get peripheralDeviceId(): string;
+    get supervisorOverrideLineReference(): ITransactionLineReferenceType;
+    protected constructor(lineNumber: number, lineType: string, peripheralDeviceId: string, supervisorOverrideLineReference?: ITransactionLineReferenceType);
+    protected newTransactionLine(): BaseTransactionLine;
+}
+export declare function isFiscalDeviceManagementLine(transactionLine: ITransactionLine): transactionLine is FiscalDeviceManagementLine;

package/lib/domain/model/fiscalDevice/FiscalDeviceManagementLine.js

@@ -0,0 +1,69 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const BaseTransactionLine_1 = require("../BaseTransactionLine");
+const Constants_1 = require("../Constants");
+/**
+ * This line type to record that a request for the fiscal device info was made and
+ * which fiscal device it is working with.
+ */
+exports.FISCAL_DEVICE_INFORMATION_LINE_TYPE = "FiscalDeviceInformation";
+exports.FISCAL_DEVICE_REPLACEMENT_LINE_TYPE = "FiscalDeviceReplacement";
+exports.FISCAL_DEVICE_SETUP_LINE_TYPE = "FiscalDeviceSetup";
+exports.PRINTER_REPLACEMENT_LINE_TYPE = "PrinterReplacement";
+class FiscalDeviceManagementLine extends BaseTransactionLine_1.BaseTransactionLine {
+    // Since the constructor is only called from the create methods it is made protected to prevent use by others.
+    constructor(lineNumber, lineType, peripheralDeviceId, supervisorOverrideLineReference) {
+        super(lineNumber, lineType);
+        this._peripheralDeviceId = peripheralDeviceId;
+        this._supervisorOverrideLineReference = supervisorOverrideLineReference;
+    }
+    /**
+     * 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 {FiscalDeviceManagementLine}
+     */
+    static create(lineNumber, lineType, uiBusinessEvent, collectedData) {
+        const peripheralDeviceId = collectedData.get(Constants_1.CollectedDataKey.PeripheralDeviceId);
+        const supervisorOverrideLineReference = collectedData.get(Constants_1.CollectedDataKey.SupervisorOverrideLineReference) || undefined;
+        const fiscalDeviceManagementLine = new FiscalDeviceManagementLine(lineNumber, lineType, peripheralDeviceId, supervisorOverrideLineReference);
+        return fiscalDeviceManagementLine;
+    }
+    static createFromJsonObject(transactionLineJsonObj) {
+        const lineNumber = BaseTransactionLine_1.BaseTransactionLine.lineNumberFromJsonObject(transactionLineJsonObj);
+        const lineType = BaseTransactionLine_1.BaseTransactionLine.lineTypeFromJsonObject(transactionLineJsonObj);
+        const peripheralDeviceId = transactionLineJsonObj._peripheralDeviceId;
+        const supervisorOverrideLineReference = transactionLineJsonObj._supervisorOverrideLineReference;
+        const fiscalDeviceManagementLine = new FiscalDeviceManagementLine(lineNumber, lineType, peripheralDeviceId, supervisorOverrideLineReference);
+        fiscalDeviceManagementLine.loadFromJsonObject(transactionLineJsonObj);
+        return fiscalDeviceManagementLine;
+    }
+    get couldAffectPricing() {
+        return false;
+    }
+    get peripheralDeviceId() {
+        return this._peripheralDeviceId;
+    }
+    get supervisorOverrideLineReference() {
+        return this._supervisorOverrideLineReference;
+    }
+    newTransactionLine() {
+        return new FiscalDeviceManagementLine(this.lineNumber, this.lineType, this._peripheralDeviceId, this.supervisorOverrideLineReference);
+    }
+}
+exports.FiscalDeviceManagementLine = FiscalDeviceManagementLine;
+function isFiscalDeviceManagementLine(transactionLine) {
+    return (transactionLine &&
+        (transactionLine instanceof FiscalDeviceManagementLine ||
+            transactionLine.lineType === exports.FISCAL_DEVICE_INFORMATION_LINE_TYPE ||
+            transactionLine.lineType === exports.FISCAL_DEVICE_REPLACEMENT_LINE_TYPE ||
+            transactionLine.lineType === exports.FISCAL_DEVICE_SETUP_LINE_TYPE ||
+            transactionLine.lineType === exports.PRINTER_REPLACEMENT_LINE_TYPE));
+}
+exports.isFiscalDeviceManagementLine = isFiscalDeviceManagementLine;
+//# sourceMappingURL=FiscalDeviceManagementLine.js.map

package/lib/domain/model/fiscalDevice/FiscalDeviceManagementRetryLine.d.ts

@@ -0,0 +1,15 @@
+import { ITransactionLine, UiBusinessEvent } from "@aptos-scp/scp-component-store-selling-core";
+import { BaseTransactionLine } from "../BaseTransactionLine";
+export declare const FISCAL_DEVICE_REPLACEMENT_RETRY_LINE_TYPE: string;
+export declare const FISCAL_DEVICE_SETUP_RETRY_LINE_TYPE: string;
+export declare const PRINTER_REPLACEMENT_RETRY_LINE_TYPE: string;
+export declare class FiscalDeviceManagementRetryLine extends BaseTransactionLine {
+    private _peripheralDeviceId;
+    static create(lineNumber: number, lineType: string, uiBusinessEvent: UiBusinessEvent, collectedData: Readonly<Map<string, any>>): FiscalDeviceManagementRetryLine;
+    static createFromJsonObject(transactionLineJsonObj: any): FiscalDeviceManagementRetryLine;
+    protected constructor(lineNumber: number, lineType: string, peripheralDeviceId: string);
+    protected newTransactionLine(): BaseTransactionLine;
+    get couldAffectPricing(): boolean;
+    get peripheralDeviceId(): string;
+}
+export declare function isFiscalDeviceManagementRetryLine(transactionLine: ITransactionLine): transactionLine is FiscalDeviceManagementRetryLine;

package/lib/domain/model/fiscalDevice/FiscalDeviceManagementRetryLine.js

@@ -0,0 +1,45 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const BaseTransactionLine_1 = require("../BaseTransactionLine");
+const Constants_1 = require("../Constants");
+exports.FISCAL_DEVICE_REPLACEMENT_RETRY_LINE_TYPE = "FiscalDeviceReplacementRetry";
+exports.FISCAL_DEVICE_SETUP_RETRY_LINE_TYPE = "FiscalDeviceSetupRetry";
+exports.PRINTER_REPLACEMENT_RETRY_LINE_TYPE = "PrinterReplacementRetry";
+class FiscalDeviceManagementRetryLine extends BaseTransactionLine_1.BaseTransactionLine {
+    constructor(lineNumber, lineType, peripheralDeviceId) {
+        super(lineNumber, lineType);
+        this._peripheralDeviceId = peripheralDeviceId;
+    }
+    static create(lineNumber, lineType, uiBusinessEvent, collectedData) {
+        const peripheralDeviceId = collectedData.get(Constants_1.CollectedDataKey.PeripheralDeviceId);
+        const fiscalDeviceManagementRetryLine = new FiscalDeviceManagementRetryLine(lineNumber, lineType, peripheralDeviceId);
+        return fiscalDeviceManagementRetryLine;
+    }
+    static createFromJsonObject(transactionLineJsonObj) {
+        const lineNumber = BaseTransactionLine_1.BaseTransactionLine.lineNumberFromJsonObject(transactionLineJsonObj);
+        const lineType = BaseTransactionLine_1.BaseTransactionLine.lineTypeFromJsonObject(transactionLineJsonObj);
+        const peripheralDeviceId = transactionLineJsonObj._peripheralDeviceId;
+        const fiscalDeviceManagementRetryLine = new FiscalDeviceManagementRetryLine(lineNumber, lineType, peripheralDeviceId);
+        fiscalDeviceManagementRetryLine.loadFromJsonObject(transactionLineJsonObj);
+        return fiscalDeviceManagementRetryLine;
+    }
+    newTransactionLine() {
+        return new FiscalDeviceManagementRetryLine(this.lineNumber, exports.FISCAL_DEVICE_REPLACEMENT_RETRY_LINE_TYPE, this._peripheralDeviceId);
+    }
+    get couldAffectPricing() {
+        return false;
+    }
+    get peripheralDeviceId() {
+        return this._peripheralDeviceId;
+    }
+}
+exports.FiscalDeviceManagementRetryLine = FiscalDeviceManagementRetryLine;
+function isFiscalDeviceManagementRetryLine(transactionLine) {
+    return (transactionLine &&
+        (transactionLine instanceof FiscalDeviceManagementRetryLine ||
+            transactionLine.lineType === exports.FISCAL_DEVICE_REPLACEMENT_RETRY_LINE_TYPE ||
+            transactionLine.lineType === exports.FISCAL_DEVICE_SETUP_RETRY_LINE_TYPE ||
+            transactionLine.lineType === exports.PRINTER_REPLACEMENT_RETRY_LINE_TYPE));
+}
+exports.isFiscalDeviceManagementRetryLine = isFiscalDeviceManagementRetryLine;
+//# sourceMappingURL=FiscalDeviceManagementRetryLine.js.map

package/lib/domain/model/fiscalDevice/FiscalDeviceStatusLine.d.ts

@@ -0,0 +1,35 @@
+import { ITransactionLine, UiBusinessEvent } from "@aptos-scp/scp-component-store-selling-core";
+import { IFiscalDeviceInformation, IFiscalTransactionInformation } from "@aptos-scp/scp-types-commerce-devices";
+import { ITransactionLineReferenceType } from "@aptos-scp/scp-types-commerce-transaction";
+import { IDeviceActivityResult } from "@aptos-scp/scp-types-commerce-transaction/lib/IDeviceActivityResult";
+import { BaseTransactionLine } from "../BaseTransactionLine";
+export declare const FISCAL_DEVICE_STATUS_LINE_TYPE: string;
+export declare class FiscalDeviceStatusLine extends BaseTransactionLine {
+    private _peripheralDeviceId;
+    private _fiscalDeviceActivityResult;
+    private _transactionLineReference?;
+    private _fiscalDeviceInformation?;
+    private _fiscalTransactionInformation?;
+    /**
+     * 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 {FiscalDeviceStatusLine}
+     */
+    static create(lineNumber: number, lineType: string, uiBusinessEvent: UiBusinessEvent, collectedData: Readonly<Map<string, any>>): FiscalDeviceStatusLine;
+    static createFromJsonObject(transactionLineJsonObj: any): FiscalDeviceStatusLine;
+    get couldAffectPricing(): boolean;
+    get transactionLineReference(): ITransactionLineReferenceType;
+    get peripheralDeviceId(): string;
+    get fiscalDeviceActivityResult(): IDeviceActivityResult;
+    get fiscalDeviceInformation(): IFiscalDeviceInformation;
+    get fiscalTransactionInformation(): IFiscalTransactionInformation;
+    protected constructor(lineNumber: number, lineType: string, peripheralDeviceId: string, fiscalDeviceActivityResult: IDeviceActivityResult, transactionLineReference?: ITransactionLineReferenceType, fiscalDeviceInformation?: IFiscalDeviceInformation, fiscalTransactionInformation?: IFiscalTransactionInformation);
+    protected newTransactionLine(): BaseTransactionLine;
+}
+export declare function isFiscalDeviceStatusLine(transactionLine: ITransactionLine): transactionLine is FiscalDeviceStatusLine;

package/lib/domain/model/fiscalDevice/FiscalDeviceStatusLine.js

@@ -0,0 +1,87 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const BaseTransactionLine_1 = require("../BaseTransactionLine");
+const Constants_1 = require("../Constants");
+exports.FISCAL_DEVICE_STATUS_LINE_TYPE = "FiscalDeviceStatus";
+class FiscalDeviceStatusLine extends BaseTransactionLine_1.BaseTransactionLine {
+    // Since the constructor is only called from the create methods it is made protected to prevent use by others.
+    constructor(lineNumber, lineType, peripheralDeviceId, fiscalDeviceActivityResult, transactionLineReference, fiscalDeviceInformation, fiscalTransactionInformation) {
+        super(lineNumber, lineType);
+        this._peripheralDeviceId = peripheralDeviceId;
+        this._fiscalDeviceActivityResult = fiscalDeviceActivityResult;
+        this._transactionLineReference = transactionLineReference;
+        this._fiscalDeviceInformation = fiscalDeviceInformation;
+        this._fiscalTransactionInformation = fiscalTransactionInformation;
+    }
+    /**
+     * 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 {FiscalDeviceStatusLine}
+     */
+    static create(lineNumber, lineType, uiBusinessEvent, collectedData) {
+        var _a;
+        const peripheralDeviceId = collectedData.get(Constants_1.CollectedDataKey.PeripheralDeviceId);
+        const fiscalDeviceActivityResult = {
+            successful: false,
+            errorCode: undefined,
+            errorDescription: undefined,
+        };
+        fiscalDeviceActivityResult.successful = (_a = collectedData.get(Constants_1.CollectedDataKey.FiscalDeviceActivitySuccessful), (_a !== null && _a !== void 0 ? _a : false));
+        if (!fiscalDeviceActivityResult.successful) {
+            fiscalDeviceActivityResult.errorCode = collectedData.get(Constants_1.CollectedDataKey.FiscalDeviceErrorCode);
+            fiscalDeviceActivityResult.errorDescription = collectedData.get(Constants_1.CollectedDataKey.FiscalDeviceErrorDescription);
+        }
+        const transactionLineReference = collectedData.get(Constants_1.CollectedDataKey.TransactionLineReference);
+        const fiscalDeviceInformation = collectedData.get(Constants_1.CollectedDataKey.FiscalDeviceInformation);
+        const fiscalTransactionInformation = collectedData.get(Constants_1.CollectedDataKey.FiscalTransactionInformation);
+        const fiscalDeviceStatusLine = new FiscalDeviceStatusLine(lineNumber, lineType, peripheralDeviceId, fiscalDeviceActivityResult, transactionLineReference, fiscalDeviceInformation, fiscalTransactionInformation);
+        return fiscalDeviceStatusLine;
+    }
+    static createFromJsonObject(transactionLineJsonObj) {
+        const lineNumber = BaseTransactionLine_1.BaseTransactionLine.lineNumberFromJsonObject(transactionLineJsonObj);
+        const lineType = BaseTransactionLine_1.BaseTransactionLine.lineTypeFromJsonObject(transactionLineJsonObj);
+        const peripheralDeviceId = transactionLineJsonObj._peripheralDeviceId;
+        const fiscalDeviceActivityResult = transactionLineJsonObj._fiscalDeviceActivityResult;
+        const transactionLineReference = transactionLineJsonObj._transactionLineReference;
+        const fiscalDeviceInformation = transactionLineJsonObj._fiscalDeviceInformation;
+        const fiscalTransactionInformation = transactionLineJsonObj._fiscalTransactionInformation;
+        const fiscalDeviceStatusLine = new FiscalDeviceStatusLine(lineNumber, lineType, peripheralDeviceId, fiscalDeviceActivityResult, transactionLineReference, fiscalDeviceInformation, fiscalTransactionInformation);
+        fiscalDeviceStatusLine.loadFromJsonObject(transactionLineJsonObj);
+        return fiscalDeviceStatusLine;
+    }
+    get couldAffectPricing() {
+        return false;
+    }
+    get transactionLineReference() {
+        return this._transactionLineReference;
+    }
+    get peripheralDeviceId() {
+        return this._peripheralDeviceId;
+    }
+    get fiscalDeviceActivityResult() {
+        return this._fiscalDeviceActivityResult;
+    }
+    get fiscalDeviceInformation() {
+        return this._fiscalDeviceInformation;
+    }
+    get fiscalTransactionInformation() {
+        return this._fiscalTransactionInformation;
+    }
+    newTransactionLine() {
+        return new FiscalDeviceStatusLine(this.lineNumber, this.lineType, this._peripheralDeviceId, this._fiscalDeviceActivityResult, this._transactionLineReference, this._fiscalDeviceInformation, this._fiscalTransactionInformation);
+    }
+}
+exports.FiscalDeviceStatusLine = FiscalDeviceStatusLine;
+function isFiscalDeviceStatusLine(transactionLine) {
+    return (transactionLine &&
+        (transactionLine instanceof FiscalDeviceStatusLine ||
+            transactionLine.lineType === exports.FISCAL_DEVICE_STATUS_LINE_TYPE));
+}
+exports.isFiscalDeviceStatusLine = isFiscalDeviceStatusLine;
+//# sourceMappingURL=FiscalDeviceStatusLine.js.map

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

@@ -0,0 +1,3 @@
+export * from "./FiscalDeviceManagementLine";
+export * from "./FiscalDeviceStatusLine";
+export * from "./FiscalDeviceManagementRetryLine";

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

@@ -0,0 +1,9 @@
+"use strict";
+function __export(m) {
+    for (var p in m) if (!exports.hasOwnProperty(p)) exports[p] = m[p];
+}
+Object.defineProperty(exports, "__esModule", { value: true });
+__export(require("./FiscalDeviceManagementLine"));
+__export(require("./FiscalDeviceStatusLine"));
+__export(require("./FiscalDeviceManagementRetryLine"));
+//# sourceMappingURL=index.js.map