@aptos-scp/scp-component-store-selling-features-domain-model 1.33.0 → 1.35.0

package/lib/domain/model/TenderControlTransaction.d.ts

@@ -2,6 +2,7 @@ import { DeviceIdentity, ITransaction, ITransactionLine, ITransactionLineFactory
 import { ITransactionReferenceFormatter } from "../service";
 import { RetailTransaction } from "./RetailTransaction";
 import { IFiscalSignature } from "@aptos-scp/scp-types-commerce-transaction";
+import { IFiscalError } from "./MerchandiseTransaction";
 export declare const TENDER_CONTROL_TRANSACTION_TYPE = "TenderControlTransaction";
 export declare class TenderControlTransaction extends RetailTransaction {
     private _accountingCurrency;
@@ -9,11 +10,13 @@ export declare class TenderControlTransaction extends RetailTransaction {
     private _transactionReferenceFormatter;
     private _fiscalTransactionNumber;
     private _fiscalSignature;
+    private _fiscalError?;
     static createFromJsonObj(transactionJsonObj: any, transactionLineFactory: ITransactionLineFactory, transactionReferenceFormatter: ITransactionReferenceFormatter): TenderControlTransaction;
     constructor(deviceIdentity: DeviceIdentity, businessDayDate: string, transactionNumber: number, user?: IUser, transactionId?: string, accountingCurrency?: string, transactionReferenceFormatter?: ITransactionReferenceFormatter, fiscalTransactionNumber?: string, fiscalSignature?: IFiscalSignature);
     clone(): ITransaction;
     assignFiscalSignature(signatureData: IFiscalSignature): ITransaction;
     assignFiscalTransactionNumber(fiscalTransactionNumber: string): ITransaction;
+    setFiscalError(fiscalError: IFiscalError): ITransaction;
     get accountingCurrency(): string;
     get referenceNumber(): string;
     get isTenderExchangeTransaction(): boolean;
@@ -21,6 +24,7 @@ export declare class TenderControlTransaction extends RetailTransaction {
     get transactionStateValues(): Readonly<Map<string, any>>;
     get fiscalTransactionNumber(): string;
     get fiscalSignature(): IFiscalSignature;
+    get fiscalError(): IFiscalError;
     findLineByLineNumber(lineNumber: number): ITransactionLine;
     toJSON(): object;
     protected newTransaction(): RetailTransaction;

package/lib/domain/model/TenderControlTransaction.js

@@ -12,6 +12,7 @@ class TenderControlTransaction extends RetailTransaction_1.RetailTransaction {
         this._transactionReferenceFormatter = transactionReferenceFormatter;
         this._fiscalTransactionNumber = fiscalTransactionNumber;
         this._fiscalSignature = fiscalSignature;
+        this._fiscalError = undefined;
     }
     static createFromJsonObj(transactionJsonObj, transactionLineFactory, transactionReferenceFormatter) {
         const transactionId = RetailTransaction_1.RetailTransaction.getTransactionIdFromJsonObject(transactionJsonObj);
@@ -33,6 +34,7 @@ class TenderControlTransaction extends RetailTransaction_1.RetailTransaction {
             transaction._referenceNumber = this._referenceNumber;
             transaction._fiscalTransactionNumber = this._fiscalTransactionNumber;
             transaction._fiscalSignature = this._fiscalSignature;
+            transaction._fiscalError = this._fiscalError;
         }
         else {
             throw new scp_component_store_selling_core_1.PosError("Cannot clone TenderControlTransaction, because new " + "instance is not a TenderControlTransaction.", config_1.SSF_TRANSACTION_ERROR_CODE);
@@ -49,6 +51,11 @@ class TenderControlTransaction extends RetailTransaction_1.RetailTransaction {
         newTransaction._fiscalTransactionNumber = fiscalTransactionNumber;
         return newTransaction;
     }
+    setFiscalError(fiscalError) {
+        const newTransaction = this.clone();
+        newTransaction._fiscalError = fiscalError;
+        return newTransaction;
+    }
     get accountingCurrency() {
         return this._accountingCurrency;
     }
@@ -72,6 +79,7 @@ class TenderControlTransaction extends RetailTransaction_1.RetailTransaction {
             ["transaction.referenceNumber", this._referenceNumber],
             ["transaction.accountingCurrency", this._accountingCurrency],
             ["transaction.isTenderExchangeTransaction", this.isTenderExchangeTransaction],
+            ["transaction.fiscalError", this._fiscalError],
         ]);
     }
     get fiscalTransactionNumber() {
@@ -80,6 +88,9 @@ class TenderControlTransaction extends RetailTransaction_1.RetailTransaction {
     get fiscalSignature() {
         return this._fiscalSignature;
     }
+    get fiscalError() {
+        return this._fiscalError;
+    }
     findLineByLineNumber(lineNumber) {
         if (lineNumber && super.lines.length > 0) {
             return super.findLineByLineNumber(lineNumber);
@@ -109,13 +120,14 @@ class TenderControlTransaction extends RetailTransaction_1.RetailTransaction {
             _referenceNumber: this.referenceNumber,
             _fiscalTransactionNumber: this.fiscalTransactionNumber,
             _fiscalSignature: this.fiscalSignature,
+            _fiscalError: this._fiscalError,
         };
     }
     newTransaction() {
         return new TenderControlTransaction(this.deviceIdentity, this.businessDayDate, this.transactionNumber, this.performingUser, this.transactionId, this.accountingCurrency, this._transactionReferenceFormatter, this.fiscalTransactionNumber, this.fiscalSignature);
     }
     loadFromJsonObject(transactionJsonObj, transactionLineFactory) {
-        var _a, _b;
+        var _a, _b, _c;
         super.loadFromJsonObject(transactionJsonObj, transactionLineFactory);
         this._referenceNumber = transactionJsonObj._referenceNumber;
         if ((_a = transactionJsonObj) === null || _a === void 0 ? void 0 : _a._fiscalTransactionNumber) {
@@ -124,6 +136,9 @@ class TenderControlTransaction extends RetailTransaction_1.RetailTransaction {
         if ((_b = transactionJsonObj) === null || _b === void 0 ? void 0 : _b._fiscalSignature) {
             this._fiscalSignature = transactionJsonObj._fiscalSignature;
         }
+        if ((_c = transactionJsonObj) === null || _c === void 0 ? void 0 : _c._fiscalError) {
+            this._fiscalError = transactionJsonObj._fiscalError;
+        }
     }
     generateTransactionReferenceNumber(transaction) {
         this._referenceNumber = this._transactionReferenceFormatter.generateTransactionReference(transaction);

package/lib/domain/model/TillControlTransaction.d.ts

@@ -1,10 +1,12 @@
 import { DeviceIdentity, ITransaction, ITransactionLine, ITransactionLineFactory, IUser } from "@aptos-scp/scp-component-store-selling-core";
 import { RetailTransaction } from "./RetailTransaction";
 import { IFiscalSignature } from "@aptos-scp/scp-types-commerce-transaction";
+import { IFiscalError } from "./MerchandiseTransaction";
 export declare const TILL_CONTROL_TRANSACTION_TYPE = "TillControlTransaction";
 export declare class TillControlTransaction extends RetailTransaction {
     private _fiscalSignature;
     private _fiscalTransactionNumber;
+    private _fiscalError?;
     static createFromJsonObj(transactionJsonObj: any, transactionLineFactory: ITransactionLineFactory): TillControlTransaction;
     constructor(deviceIdentity: DeviceIdentity, businessDayDate: string, transactionNumber: number, user?: IUser, transactionId?: string, fiscalSignature?: IFiscalSignature, fiscalTransactionNumber?: string);
     clone(): ITransaction;
@@ -13,6 +15,8 @@ export declare class TillControlTransaction extends RetailTransaction {
     get transactionStateValues(): Readonly<Map<string, any>>;
     assignFiscalSignature(signatureData: IFiscalSignature): ITransaction;
     assignFiscalTransactionNumber(fiscalTransactionNumber: string): ITransaction;
+    setFiscalError(fiscalError: IFiscalError): ITransaction;
+    get fiscalError(): IFiscalError;
     findLineByLineNumber(lineNumber: number): ITransactionLine;
     protected newTransaction(): RetailTransaction;
     protected loadFromJsonObject(transactionJsonObj: any, transactionLineFactory: ITransactionLineFactory): void;

package/lib/domain/model/TillControlTransaction.js

@@ -9,6 +9,7 @@ class TillControlTransaction extends RetailTransaction_1.RetailTransaction {
         super(deviceIdentity, businessDayDate, transactionNumber, exports.TILL_CONTROL_TRANSACTION_TYPE, user, transactionId);
         this._fiscalSignature = fiscalSignature;
         this._fiscalTransactionNumber = fiscalTransactionNumber;
+        this._fiscalError = undefined;
     }
     static createFromJsonObj(transactionJsonObj, transactionLineFactory) {
         const transactionId = RetailTransaction_1.RetailTransaction.getTransactionIdFromJsonObject(transactionJsonObj);
@@ -26,6 +27,7 @@ class TillControlTransaction extends RetailTransaction_1.RetailTransaction {
         if (exports.isTillControlTransaction(transaction)) {
             transaction._fiscalSignature = this._fiscalSignature;
             transaction._fiscalTransactionNumber = this._fiscalTransactionNumber;
+            transaction._fiscalError = this._fiscalError;
         }
         else {
             throw new scp_component_store_selling_core_1.PosError("Cannot clone TillControlTransaction, because new " + "instance is not a TillControlTransaction.", config_1.SSF_TRANSACTION_ERROR_CODE);
@@ -39,7 +41,10 @@ class TillControlTransaction extends RetailTransaction_1.RetailTransaction {
         return this._fiscalTransactionNumber;
     }
     get transactionStateValues() {
-        return new Map([...super.transactionStateValues.entries()]);
+        return new Map([
+            ...super.transactionStateValues.entries(),
+            ["transaction.fiscalError", this._fiscalError],
+        ]);
     }
     assignFiscalSignature(signatureData) {
         const newTransaction = this.clone();
@@ -51,6 +56,14 @@ class TillControlTransaction extends RetailTransaction_1.RetailTransaction {
         newTransaction._fiscalTransactionNumber = fiscalTransactionNumber;
         return newTransaction;
     }
+    setFiscalError(fiscalError) {
+        const newTransaction = this.clone();
+        newTransaction._fiscalError = fiscalError;
+        return newTransaction;
+    }
+    get fiscalError() {
+        return this._fiscalError;
+    }
     findLineByLineNumber(lineNumber) {
         if (lineNumber && super.lines.length > 0) {
             return super.findLineByLineNumber(lineNumber);
@@ -61,7 +74,7 @@ class TillControlTransaction extends RetailTransaction_1.RetailTransaction {
         return new TillControlTransaction(this.deviceIdentity, this.businessDayDate, this.transactionNumber, this.performingUser, this.transactionId, this._fiscalSignature, this._fiscalTransactionNumber);
     }
     loadFromJsonObject(transactionJsonObj, transactionLineFactory) {
-        var _a, _b;
+        var _a, _b, _c;
         super.loadFromJsonObject(transactionJsonObj, transactionLineFactory);
         if ((_a = transactionJsonObj) === null || _a === void 0 ? void 0 : _a._fiscalSignature) {
             this._fiscalSignature = transactionJsonObj._fiscalSignature;
@@ -69,6 +82,9 @@ class TillControlTransaction extends RetailTransaction_1.RetailTransaction {
         if ((_b = transactionJsonObj) === null || _b === void 0 ? void 0 : _b._fiscalTransactionNumber) {
             this._fiscalTransactionNumber = transactionJsonObj._fiscalTransactionNumber;
         }
+        if ((_c = transactionJsonObj) === null || _c === void 0 ? void 0 : _c._fiscalError) {
+            this._fiscalError = transactionJsonObj._fiscalError;
+        }
     }
 }
 exports.TillControlTransaction = TillControlTransaction;

package/lib/domain/model/item/BasePriceChangeLineDecorator.d.ts

@@ -13,6 +13,7 @@ export declare abstract class BasePriceChangeLineDecorator extends BaseLineDecor
     get extendedAmountIncludingTax(): Money;
     get couldAffectPricing(): boolean;
     get unitPrice(): Price;
+    get superseded(): boolean;
     get preventsTransactionVoid(): boolean;
     get allowVoid(): boolean;
     protected constructor(lineDecoratorType: string, decoratedTransactionLine: ItemPriceChangeLine, annotationDescription: string, annotationSourceType: string, annotationSourceLineNumber?: number);

package/lib/domain/model/item/BasePriceChangeLineDecorator.js

@@ -32,6 +32,9 @@ class BasePriceChangeLineDecorator extends BaseLineDecorator_1.BaseLineDecorator
     get unitPrice() {
         return this.decoratedTransactionLine.unitPrice;
     }
+    get superseded() {
+        return this.decoratedTransactionLine.superseded;
+    }
     get preventsTransactionVoid() {
         return false;
     }

package/lib/domain/model/item/ItemPriceChangeLine.d.ts

@@ -12,6 +12,7 @@ export declare class ItemPriceChangeLine extends BaseTransactionLine implements
     private _reasonDescription;
     private _supervisorOverrideLineReference;
     private _copiedFromLineNumber;
+    private _superseded;
     /**
      * 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.
@@ -37,7 +38,8 @@ export declare class ItemPriceChangeLine extends BaseTransactionLine implements
     get allowVoid(): boolean;
     get copiedFromLineNumber(): number;
     copyLineWithNewLineNumber(newLineNumber: number, linePropertyOverrides?: Readonly<Map<string, any>>): ItemPriceChangeLine;
-    protected constructor(changeLineNumber: number, price: Price, reasonCode: string, reasonListType: string, reasonDescription: string, lineNumber: number, lineType: string, supervisorOverrideLineReference: ITransactionLineReferenceType, extendedAmount?: Money, extendedAmountExcludingTax?: Money, extendedAmountIncludingTax?: Money, copiedFromLineNumber?: number);
+    get superseded(): boolean;
+    protected constructor(changeLineNumber: number, price: Price, reasonCode: string, reasonListType: string, reasonDescription: string, lineNumber: number, lineType: string, supervisorOverrideLineReference: ITransactionLineReferenceType, extendedAmount?: Money, extendedAmountExcludingTax?: Money, extendedAmountIncludingTax?: Money, copiedFromLineNumber?: number, superseded?: boolean);
     protected clone(): BaseTransactionLine;
     protected newTransactionLine(): BaseTransactionLine;
 }

package/lib/domain/model/item/ItemPriceChangeLine.js

@@ -9,7 +9,7 @@ exports.CHANGE_ITEM_PRICE_LINE_TYPE = "ChangeItemPrice";
 class ItemPriceChangeLine extends BaseTransactionLine_1.BaseTransactionLine {
     // The constructor is only used by the create methods, which should be used instead of the constructor to create an
     // instance.
-    constructor(changeLineNumber, price, reasonCode, reasonListType, reasonDescription, lineNumber, lineType, supervisorOverrideLineReference, extendedAmount, extendedAmountExcludingTax, extendedAmountIncludingTax, copiedFromLineNumber) {
+    constructor(changeLineNumber, price, reasonCode, reasonListType, reasonDescription, lineNumber, lineType, supervisorOverrideLineReference, extendedAmount, extendedAmountExcludingTax, extendedAmountIncludingTax, copiedFromLineNumber, superseded) {
         super(lineNumber, lineType, extendedAmount, extendedAmountExcludingTax, extendedAmountIncludingTax);
         this._changeLineNumber = changeLineNumber;
         this._price = price;
@@ -18,6 +18,7 @@ class ItemPriceChangeLine extends BaseTransactionLine_1.BaseTransactionLine {
         this._reasonDescription = reasonDescription;
         this._supervisorOverrideLineReference = supervisorOverrideLineReference;
         this._copiedFromLineNumber = copiedFromLineNumber;
+        this._superseded = superseded;
     }
     /**
      * The create method is called by the transaction line factory to create an instance and initialize it from the
@@ -55,7 +56,9 @@ class ItemPriceChangeLine extends BaseTransactionLine_1.BaseTransactionLine {
         const reasonListType = transactionLineJsonObj._reasonListType;
         const reasonDescription = transactionLineJsonObj._reasonDescription;
         const supervisorOverrideLineReference = transactionLineJsonObj._supervisorOverrideLineReference;
-        const itemPriceChangeLine = new ItemPriceChangeLine(changeLineNumber, price, reasonCode, reasonListType, reasonDescription, lineNumber, lineType, supervisorOverrideLineReference, extendedAmount, extendedAmountExcludingTax, extendedAmountIncludingTax);
+        const copiedFromLineNumber = transactionLineJsonObj._copiedFromLineNumber;
+        const superseded = transactionLineJsonObj._superseded;
+        const itemPriceChangeLine = new ItemPriceChangeLine(changeLineNumber, price, reasonCode, reasonListType, reasonDescription, lineNumber, lineType, supervisorOverrideLineReference, extendedAmount, extendedAmountExcludingTax, extendedAmountIncludingTax, copiedFromLineNumber, superseded);
         itemPriceChangeLine.loadFromJsonObject(transactionLineJsonObj);
         return itemPriceChangeLine;
     }
@@ -100,6 +103,9 @@ class ItemPriceChangeLine extends BaseTransactionLine_1.BaseTransactionLine {
         clonedItem._copiedFromLineNumber = (_b = linePropertyOverrides) === null || _b === void 0 ? void 0 : _b.get(Constants_1.LinePropertyOverrides.CopiedFromLineNumber);
         return clonedItem.updateLineNumber(newLineNumber);
     }
+    get superseded() {
+        return this._superseded;
+    }
     clone() {
         const newTransactionLine = super.clone();
         // These are handled by the constructor called by newTransactionLine().
@@ -120,7 +126,7 @@ class ItemPriceChangeLine extends BaseTransactionLine_1.BaseTransactionLine {
     }
     */
     newTransactionLine() {
-        return new ItemPriceChangeLine(this._changeLineNumber, this._price, this._reasonCode, this._reasonListType, this._reasonDescription, this.lineNumber, this.lineType, this._supervisorOverrideLineReference, this.extendedAmount, this.extendedAmountExcludingTax, this.extendedAmountIncludingTax, this._copiedFromLineNumber);
+        return new ItemPriceChangeLine(this._changeLineNumber, this._price, this._reasonCode, this._reasonListType, this._reasonDescription, this.lineNumber, this.lineType, this._supervisorOverrideLineReference, this.extendedAmount, this.extendedAmountExcludingTax, this.extendedAmountIncludingTax, this._copiedFromLineNumber, this._superseded);
     }
 }
 exports.ItemPriceChangeLine = ItemPriceChangeLine;

package/lib/domain/model/item/SupersededPriceChangeLineDecorator.d.ts

@@ -0,0 +1,11 @@
+import { ITransactionLine, ITransactionLineFactory } from "@aptos-scp/scp-component-store-selling-core";
+import { BasePriceChangeLineDecorator } from "./BasePriceChangeLineDecorator";
+import { ItemPriceChangeLine } from "./ItemPriceChangeLine";
+export declare const DECORATOR_TYPE_SUPERSEDED_PRICE_CHANGE_LINE: string;
+export declare class SupersededPriceChangeLineDecorator extends BasePriceChangeLineDecorator {
+    static createFromJsonObject(transactionLineJsonObj: any, transactionLineFactory: ITransactionLineFactory): SupersededPriceChangeLineDecorator;
+    constructor(priceChangeLine: ItemPriceChangeLine, annotationSourceType: string, annotationSourceLineNumber: number);
+    get superseded(): boolean;
+    protected newTransactionLine(): SupersededPriceChangeLineDecorator;
+}
+export declare function isSupersededPriceChangeLineDecorator(transactionLine: ITransactionLine): transactionLine is SupersededPriceChangeLineDecorator;

package/lib/domain/model/item/SupersededPriceChangeLineDecorator.js

@@ -0,0 +1,31 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const BaseLineDecorator_1 = require("../BaseLineDecorator");
+const BasePriceChangeLineDecorator_1 = require("./BasePriceChangeLineDecorator");
+exports.DECORATOR_TYPE_SUPERSEDED_PRICE_CHANGE_LINE = "SUPERSEDED_PRICE_CHANGE_LINE_DECORATOR";
+class SupersededPriceChangeLineDecorator extends BasePriceChangeLineDecorator_1.BasePriceChangeLineDecorator {
+    static createFromJsonObject(transactionLineJsonObj, transactionLineFactory) {
+        const decoratedTransactionLineJsonObj = BaseLineDecorator_1.BaseLineDecorator.getDecoratedTransactionLineJsonObjectFromJsonObject(transactionLineJsonObj);
+        const decoratedPriceChangeLine = transactionLineFactory.createTransactionLineFromJsonObj(decoratedTransactionLineJsonObj);
+        const annotationSourceType = BaseLineDecorator_1.BaseLineDecorator.getAnnotationSourceTypeFromJsonObject(transactionLineJsonObj);
+        const annotationSourceLineNumber = BaseLineDecorator_1.BaseLineDecorator.getAnnotationSourceLineNumberFromJsonObject(transactionLineJsonObj);
+        const supersededPriceChangeLineDecorator = new SupersededPriceChangeLineDecorator(decoratedPriceChangeLine, annotationSourceType, annotationSourceLineNumber);
+        return supersededPriceChangeLineDecorator;
+    }
+    constructor(priceChangeLine, annotationSourceType, annotationSourceLineNumber) {
+        super(exports.DECORATOR_TYPE_SUPERSEDED_PRICE_CHANGE_LINE, priceChangeLine, undefined, annotationSourceType, annotationSourceLineNumber);
+    }
+    get superseded() {
+        return true;
+    }
+    newTransactionLine() {
+        return new SupersededPriceChangeLineDecorator(this.decoratedTransactionLine, this.annotationSourceType, this.annotationSourceLineNumber);
+    }
+}
+exports.SupersededPriceChangeLineDecorator = SupersededPriceChangeLineDecorator;
+function isSupersededPriceChangeLineDecorator(transactionLine) {
+    return (transactionLine.lineDecoratorType ===
+        exports.DECORATOR_TYPE_SUPERSEDED_PRICE_CHANGE_LINE);
+}
+exports.isSupersededPriceChangeLineDecorator = isSupersededPriceChangeLineDecorator;
+//# sourceMappingURL=SupersededPriceChangeLineDecorator.js.map

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

@@ -35,3 +35,4 @@ export * from "./ItemLineNonFinancialRewardDecorator";
 export * from "./IAllLinePricingAdjustments";
 export * from "./ISerializedPriceCalculationResultsWithSource";
 export * from "./ItemLineExtensibilityFormDataDecorator";
+export * from "./SupersededPriceChangeLineDecorator";

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

@@ -38,4 +38,5 @@ __export(require("./ItemLineTaxOverrideDecorator"));
 __export(require("./ItemLineNonFinancialRewardDecorator"));
 __export(require("./IAllLinePricingAdjustments"));
 __export(require("./ItemLineExtensibilityFormDataDecorator"));
+__export(require("./SupersededPriceChangeLineDecorator"));
 //# sourceMappingURL=index.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aptos-scp/scp-component-store-selling-features-domain-model",
-  "version": "1.33.0",
+  "version": "1.35.0",
   "description": "This component library provides the common components to handle the coordination of processing the business events from the UI.",
   "private": false,
   "license": "SEE LICENSE IN LICENSE.md",