@aptos-scp/scp-component-store-selling-features-domain-model 1.34.0 → 1.36.0

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

@@ -427,7 +427,8 @@ export declare enum UiInputKey {
     ORIGINAL_TENDER = "input_originalTender",
     REFUNDABLE_TENDERS = "input_refundableTenders",
     BEST_REDEMPTION_PROMPT_STATUS = "input_bestRedemptionPromptStatus",
-    TENDER_IS_ORIGINAL_TENDER = "input_tenderIsOriginalTender"
+    TENDER_IS_ORIGINAL_TENDER = "input_tenderIsOriginalTender",
+    TENDER_KEYED_ENTRY = "input_tenderKeyedEntry"
 }
 export declare enum CollectedDataKey {
     Abort = "abort",

package/lib/domain/model/Constants.js

@@ -431,6 +431,7 @@ var UiInputKey;
     UiInputKey["REFUNDABLE_TENDERS"] = "input_refundableTenders";
     UiInputKey["BEST_REDEMPTION_PROMPT_STATUS"] = "input_bestRedemptionPromptStatus";
     UiInputKey["TENDER_IS_ORIGINAL_TENDER"] = "input_tenderIsOriginalTender";
+    UiInputKey["TENDER_KEYED_ENTRY"] = "input_tenderKeyedEntry";
 })(UiInputKey = exports.UiInputKey || (exports.UiInputKey = {}));
 //
 // Keys for use in relaying data collectedData (qualification) and nonContextualData (action).

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

@@ -12,6 +12,7 @@ export declare enum TenderAuthorizationState {
     BalanceInquiryInProgress = "BalanceInquiryInProgress",
     GiftCardIssueInProgress = "GiftCardIssueInProgress",
     GiftCardRefundInProgress = "GiftCardRefundInProgress",
+    ManualEntryInProgress = "ManualEntryInProgress",
     WaitingForPartialAuthorizationApproval = "waitingForPartialAuthorizationApproval",
     WaitingForRetryLastAuthorization = "WaitingForRetryLastAuthorization",
     WaitingForNonIntegratedInput = "WaitingForNonIntegratedInput",
@@ -73,6 +74,7 @@ export declare class TenderAuthorizationSession implements IState {
     get inBalanceInquiryInProgress(): boolean;
     get inGiftCardIssueInProgress(): boolean;
     get inGiftCardRefundInProgress(): boolean;
+    get inManualEntryInProgress(): boolean;
     get inWaitingForPartialAuthorizationApproval(): boolean;
     get inWaitingForTransactionVoid(): boolean;
     get inWaitingForNonIntegratedInput(): boolean;
@@ -82,6 +84,7 @@ export declare class TenderAuthorizationSession implements IState {
     startAuthorization(lineNumber: number, tenderAuthCategory?: TenderAuthCategory): TenderAuthorizationSession;
     startInProgress(lineNumber: number, tenderAuthCategory: TenderAuthCategory, authorizationMode?: AuthorizationMode): TenderAuthorizationSession;
     startTenderVoid(lineNumber: number, tenderAuthCategory: TenderAuthCategory): TenderAuthorizationSession;
+    startManualEntry(lineNumber: number): TenderAuthorizationSession;
     startBalanceInquiry(lineNumber: number): TenderAuthorizationSession;
     startGiftCardIssue(lineNumber: number): TenderAuthorizationSession;
     startGiftCardRefund(lineNumber: number): TenderAuthorizationSession;

package/lib/domain/model/TenderAuthorizationSession.js

@@ -15,6 +15,7 @@ var TenderAuthorizationState;
     TenderAuthorizationState["BalanceInquiryInProgress"] = "BalanceInquiryInProgress";
     TenderAuthorizationState["GiftCardIssueInProgress"] = "GiftCardIssueInProgress";
     TenderAuthorizationState["GiftCardRefundInProgress"] = "GiftCardRefundInProgress";
+    TenderAuthorizationState["ManualEntryInProgress"] = "ManualEntryInProgress";
     TenderAuthorizationState["WaitingForPartialAuthorizationApproval"] = "waitingForPartialAuthorizationApproval";
     TenderAuthorizationState["WaitingForRetryLastAuthorization"] = "WaitingForRetryLastAuthorization";
     TenderAuthorizationState["WaitingForNonIntegratedInput"] = "WaitingForNonIntegratedInput";
@@ -41,6 +42,7 @@ const TenderAuthorizationStateNumericMap = {
     8: "waitingForPartialAuthorizationApproval",
     9: "GiftCardRefundInProgress",
     10: "TenderVoidInProgress",
+    11: "ManualEntryInProgress",
 };
 exports.TENDER_AUTH_SESSION = "TenderAuthSession";
 class TenderAuthorizationSession {
@@ -181,6 +183,9 @@ class TenderAuthorizationSession {
     get inGiftCardRefundInProgress() {
         return this._state === TenderAuthorizationState.GiftCardRefundInProgress;
     }
+    get inManualEntryInProgress() {
+        return this._state === TenderAuthorizationState.ManualEntryInProgress;
+    }
     get inWaitingForPartialAuthorizationApproval() {
         return this._state === TenderAuthorizationState.WaitingForPartialAuthorizationApproval;
     }
@@ -199,6 +204,7 @@ class TenderAuthorizationSession {
     get isAuthorizationDeviceActive() {
         return (this.inGiftCardIssueInProgress ||
             this.inBalanceInquiryInProgress ||
+            this.inManualEntryInProgress ||
             this.inWaitingForReversal ||
             this.inWaitingForTransactionVoid ||
             this.inCancelInProgress ||
@@ -228,6 +234,12 @@ class TenderAuthorizationSession {
             ? this
             : new TenderAuthorizationSession(TenderAuthorizationState.TenderVoidInProgress, lineNumber, undefined, undefined, undefined, undefined, undefined, undefined, undefined, tenderAuthCategory);
     }
+    startManualEntry(lineNumber) {
+        logger.traceEntry("startManualEntry");
+        return this.inManualEntryInProgress
+            ? this
+            : new TenderAuthorizationSession(TenderAuthorizationState.ManualEntryInProgress, lineNumber, undefined, undefined);
+    }
     startBalanceInquiry(lineNumber) {
         logger.traceEntry("startBalanceInquiry");
         return this.inBalanceInquiryInProgress

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.34.0",
+  "version": "1.36.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",