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

package/lib/domain/model/tender/RefundedTenderLineDecorator.d.ts

@@ -0,0 +1,12 @@
+import { ITransactionLineFactory } from "@aptos-scp/scp-component-store-selling-core";
+import { BaseTenderLineDecorator } from "./BaseTenderLineDecorator";
+import { TenderLine } from "./TenderLine";
+export declare const DECORATOR_TYPE_REFUNDED_TENDER_LINE: string;
+export declare class RefundedTenderLineDecorator extends BaseTenderLineDecorator {
+    static createFromJsonObject(transactionLineJsonObj: any, transactionLineFactory: ITransactionLineFactory): RefundedTenderLineDecorator;
+    constructor(tenderLine: TenderLine, annotationSourceLineNumber: number);
+    get refunded(): boolean;
+    get preventsTransactionVoid(): boolean;
+    get allowVoid(): boolean;
+    protected newTransactionLine(): RefundedTenderLineDecorator;
+}

package/lib/domain/model/tender/RefundedTenderLineDecorator.js

@@ -0,0 +1,42 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const BaseLineDecorator_1 = require("../BaseLineDecorator");
+const BaseTenderLineDecorator_1 = require("./BaseTenderLineDecorator");
+const REFUND_TENDER_ANNOTATION_SOURCE_TYPE = "RefundedTender";
+const DECORATOR_DESCRIPTION_REFUNDED = "REFUNDED";
+exports.DECORATOR_TYPE_REFUNDED_TENDER_LINE = "REFUNDED_TENDER_LINE_DECORATOR";
+class RefundedTenderLineDecorator extends BaseTenderLineDecorator_1.BaseTenderLineDecorator {
+    static createFromJsonObject(transactionLineJsonObj, transactionLineFactory) {
+        const decoratedTransactionLineJsonObj = BaseLineDecorator_1.BaseLineDecorator.getDecoratedTransactionLineJsonObjectFromJsonObject(transactionLineJsonObj);
+        const decoratedTenderLine = transactionLineFactory.createTransactionLineFromJsonObj(decoratedTransactionLineJsonObj);
+        const annotationSourceLineNumber = BaseLineDecorator_1.BaseLineDecorator.getAnnotationSourceLineNumberFromJsonObject(transactionLineJsonObj);
+        const refundedTenderLineDecorator = new RefundedTenderLineDecorator(decoratedTenderLine, annotationSourceLineNumber);
+        return refundedTenderLineDecorator;
+    }
+    constructor(tenderLine, annotationSourceLineNumber) {
+        super(exports.DECORATOR_TYPE_REFUNDED_TENDER_LINE, tenderLine, DECORATOR_DESCRIPTION_REFUNDED, REFUND_TENDER_ANNOTATION_SOURCE_TYPE, annotationSourceLineNumber);
+    }
+    /* Since this just calls super.clone(), we don't need this implemented here.
+       This is left her, commented out, so that if future changes add any properties that are not handled by the
+       constructor, it will be a reminder to include it.
+    public clone(): RefundedTenderLineDecorator {
+      let newRefundedTenderLineDecorator: RefundedTenderLineDecorator = super.clone<RefundedTenderLineDecorator>();
+  
+      return newRefundedTenderLineDecorator;
+    }
+    */
+    get refunded() {
+        return true;
+    }
+    get preventsTransactionVoid() {
+        return false;
+    }
+    get allowVoid() {
+        return true;
+    }
+    newTransactionLine() {
+        return new RefundedTenderLineDecorator(this.decoratedTransactionLine, this.annotationSourceLineNumber);
+    }
+}
+exports.RefundedTenderLineDecorator = RefundedTenderLineDecorator;
+//# sourceMappingURL=RefundedTenderLineDecorator.js.map

package/lib/domain/model/tender/TenderAuthorizationStatusLine.d.ts

@@ -0,0 +1,65 @@
+import { Money } from "@aptos-scp/scp-component-business-core";
+import { ITransactionLine, UiBusinessEvent } from "@aptos-scp/scp-component-store-selling-core";
+import { EntryMethod, IAuthorizationResponse, TenderSubType } from "@aptos-scp/scp-types-commerce-devices";
+import { ActionType, ITransactionLineReference, ITransactionLineReferenceType, TenderAuthFailureReasonCode, TenderAuthorizationStatus } from "@aptos-scp/scp-types-commerce-transaction";
+import { IOriginalTransactionRefundReference } from "..";
+import { BaseTransactionLine } from "../BaseTransactionLine";
+import { TenderAuthCategory } from "../Constants";
+import { TenderType } from "../TenderType";
+export declare const TENDER_AUTH_STATUS_LINE_TYPE: string;
+export declare class TenderAuthorizationStatusLine extends BaseTransactionLine implements ITransactionLineReference {
+    private _status;
+    private _tenderAmount;
+    private _authResponse;
+    private _failureReasonCode;
+    private _authorizationDeviceId;
+    private _isTenderAuthorizationFallback;
+    private _forcedAuthorizationApproval;
+    private _cardNumber;
+    private _giftCardPin;
+    private _valueCertificateNumber;
+    private _transactionLineReference;
+    private _offlineApprovalCode;
+    private _offlineAuthorizationCode;
+    private _tenderAuthCategory;
+    private _tenderType;
+    private _entryMethod;
+    private _tenderReversalFailed;
+    private _actionType;
+    private _originalTenderLineReferences;
+    private _mappedRefundTenderTypeName;
+    private _subType;
+    private readonly _isChangeProcessing;
+    static create(lineNumber: number, lineType: string, uiBusinessEvent: UiBusinessEvent, collectedData: Readonly<Map<string, any>>): TenderAuthorizationStatusLine;
+    static createFromJsonObject(transactionLineJsonObj: any): TenderAuthorizationStatusLine;
+    get couldAffectPricing(): boolean;
+    get status(): TenderAuthorizationStatus;
+    get tenderAmount(): Money;
+    get authResponse(): IAuthorizationResponse;
+    get failureReasonCode(): TenderAuthFailureReasonCode;
+    get authorizationDeviceId(): string;
+    get forcedAuthorizationApproval(): boolean;
+    get cardNumber(): string;
+    get giftCardPin(): string;
+    get valueCertificateNumber(): string;
+    get transactionLineReference(): ITransactionLineReferenceType;
+    get originalTenderLineReferences(): IOriginalTransactionRefundReference[];
+    get offlineApprovalCode(): string;
+    get offlineAuthorizationCode(): string;
+    get tenderId(): string;
+    get tenderName(): string;
+    get tenderTypeName(): string;
+    get tenderAuthCategory(): TenderAuthCategory;
+    get tenderType(): TenderType;
+    get entryMethod(): EntryMethod;
+    get tenderReversalFailed(): boolean;
+    get isChangeProcessing(): boolean;
+    get actionType(): ActionType;
+    get subType(): TenderSubType;
+    get mappedRefundTenderTypeName(): string;
+    get isTenderAuthorizationFallback(): boolean;
+    protected constructor(lineNumber: number, lineType: string, status: TenderAuthorizationStatus, tenderAmount: Money, authResponse: IAuthorizationResponse, failureReasonCode: TenderAuthFailureReasonCode, authorizationDeviceId: string, transactionLineReference: ITransactionLineReferenceType, forcedAuthorizationApproval: boolean, cardNumber: string, giftCardPin: string, valueCertificateNumber: string, offlineAuthorizationCode: string, offlineApprovalCode: string, tenderAuthCategory: TenderAuthCategory, tenderType: TenderType, entryMethod: EntryMethod, tenderReversalFailed: boolean, originalTenderLineReferences: IOriginalTransactionRefundReference[], actionType: ActionType, mappedRefundTenderTypeName: string, subType: TenderSubType, isChangeProcessing: boolean, isTenderAuthorizationFallback: boolean);
+    protected newTransactionLine(): TenderAuthorizationStatusLine;
+}
+export declare function isTenderAuthorizationStatusLine(transactionLine: ITransactionLine): transactionLine is TenderAuthorizationStatusLine;
+export declare function isTimeoutStatusLine(transactionLine: TenderAuthorizationStatusLine): boolean;

package/lib/domain/model/tender/TenderAuthorizationStatusLine.js

@@ -0,0 +1,220 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const scp_component_business_core_1 = require("@aptos-scp/scp-component-business-core");
+const scp_component_store_selling_core_1 = require("@aptos-scp/scp-component-store-selling-core");
+const scp_types_commerce_devices_1 = require("@aptos-scp/scp-types-commerce-devices");
+const scp_types_commerce_transaction_1 = require("@aptos-scp/scp-types-commerce-transaction");
+const BaseTransactionLine_1 = require("../BaseTransactionLine");
+const Constants_1 = require("../Constants");
+const TenderType_1 = require("../TenderType");
+exports.TENDER_AUTH_STATUS_LINE_TYPE = "TenderAuthorizationStatus";
+class TenderAuthorizationStatusLine extends BaseTransactionLine_1.BaseTransactionLine {
+    constructor(lineNumber, lineType, status, tenderAmount, authResponse, failureReasonCode, authorizationDeviceId, transactionLineReference, forcedAuthorizationApproval, cardNumber, giftCardPin, valueCertificateNumber, offlineAuthorizationCode, offlineApprovalCode, tenderAuthCategory, tenderType, entryMethod, tenderReversalFailed, originalTenderLineReferences, actionType, mappedRefundTenderTypeName, subType, isChangeProcessing, isTenderAuthorizationFallback) {
+        super(lineNumber, lineType);
+        this._status = status;
+        this._tenderAmount = tenderAmount;
+        this._authResponse = authResponse;
+        this._failureReasonCode = failureReasonCode;
+        this._authorizationDeviceId = authorizationDeviceId;
+        this._transactionLineReference = transactionLineReference;
+        this._offlineApprovalCode = offlineApprovalCode;
+        this._offlineAuthorizationCode = offlineAuthorizationCode;
+        this._forcedAuthorizationApproval = forcedAuthorizationApproval;
+        this._cardNumber = cardNumber;
+        this._giftCardPin = giftCardPin;
+        this._valueCertificateNumber = valueCertificateNumber;
+        this._tenderAuthCategory = tenderAuthCategory;
+        this._tenderType = tenderType;
+        this._entryMethod = entryMethod;
+        this._tenderReversalFailed = tenderReversalFailed;
+        this._originalTenderLineReferences = originalTenderLineReferences;
+        this._actionType = actionType;
+        this._mappedRefundTenderTypeName = mappedRefundTenderTypeName;
+        this._subType = subType;
+        this._isChangeProcessing = isChangeProcessing;
+        this._isTenderAuthorizationFallback = isTenderAuthorizationFallback;
+    }
+    static create(lineNumber, lineType, uiBusinessEvent, collectedData) {
+        const status = collectedData.get(Constants_1.CollectedDataKey.TenderAuthorizationStatus);
+        const tenderAmount = collectedData.get(Constants_1.CollectedDataKey.TenderAmount);
+        const authResponse = collectedData.get(Constants_1.CollectedDataKey.TenderAuthResponse);
+        const failureReasonCode = collectedData.get(Constants_1.CollectedDataKey.TenderAuthFailureReasonCode);
+        const authorizationDeviceId = collectedData.get(Constants_1.CollectedDataKey.AuthorizationDeviceId);
+        const offlineApprovalCode = collectedData.get(Constants_1.CollectedDataKey.OfflineApprovalCode);
+        const offlineAuthorizationCode = collectedData.get(Constants_1.CollectedDataKey.OfflineAuthorizationCode);
+        const forcedAuthorizationApproval = collectedData.get(Constants_1.CollectedDataKey.ForcedAuthorizationApproval);
+        const cardNumber = collectedData.get(Constants_1.CollectedDataKey.CardNumber);
+        const giftCardPin = collectedData.get(Constants_1.CollectedDataKey.GiftCardPin);
+        const valueCertificateNumber = collectedData.get(Constants_1.CollectedDataKey.ValueCertificateNumber);
+        const transactionLineReference = collectedData.get(Constants_1.CollectedDataKey.TransactionLineReference);
+        const originalTenderLineReferences = collectedData.get(Constants_1.CollectedDataKey.OriginalTenderLineReferences);
+        const tenderType = collectedData.get(Constants_1.CollectedDataKey.TenderType);
+        const tenderAuthCategory = tenderType
+            ? tenderType.tenderAuthCategory
+            : collectedData.get(Constants_1.CollectedDataKey.TenderAuthCategory);
+        const entryMethod = collectedData.get(Constants_1.CollectedDataKey.EntryMethod) ||
+            mapInputSourceToEntryMethod(collectedData.get(Constants_1.CollectedDataKey.InputSource));
+        const tenderReversalFailed = collectedData.get(Constants_1.CollectedDataKey.TenderReversalFailed);
+        const actionType = collectedData.get(Constants_1.CollectedDataKey.ActionType);
+        const mappedRefundTenderTypeName = collectedData.get(Constants_1.CollectedDataKey.MappedRefundTenderTypeName);
+        const subType = collectedData.get(Constants_1.CollectedDataKey.TenderSubType);
+        const isChangeProcessing = collectedData.get(Constants_1.CollectedDataKey.IsChangeProcessing);
+        const isTenderAuthorizationFallback = collectedData.get(Constants_1.CollectedDataKey.IsTenderFallback);
+        return new TenderAuthorizationStatusLine(lineNumber, lineType, status, tenderAmount, authResponse, failureReasonCode, authorizationDeviceId, transactionLineReference, forcedAuthorizationApproval, cardNumber, giftCardPin, valueCertificateNumber, offlineAuthorizationCode, offlineApprovalCode, tenderAuthCategory, tenderType, entryMethod, tenderReversalFailed, originalTenderLineReferences, actionType, mappedRefundTenderTypeName, subType, isChangeProcessing, isTenderAuthorizationFallback);
+    }
+    static createFromJsonObject(transactionLineJsonObj) {
+        const lineNumber = BaseTransactionLine_1.BaseTransactionLine.lineNumberFromJsonObject(transactionLineJsonObj);
+        const lineType = BaseTransactionLine_1.BaseTransactionLine.lineTypeFromJsonObject(transactionLineJsonObj);
+        const authorizationDeviceId = transactionLineJsonObj._authorizationDeviceId;
+        const forcedAuthorizationApproval = transactionLineJsonObj._forcedAuthorizationApproval;
+        const cardNumber = transactionLineJsonObj._cardNumber;
+        const giftCardPin = transactionLineJsonObj._giftCardPin;
+        const valueCertificateNumber = transactionLineJsonObj._valueCertificateNumber;
+        const offlineApprovalCode = transactionLineJsonObj._offlineApprovalCode;
+        const offlineAuthorizationCode = transactionLineJsonObj._offlineAuthorizationCode;
+        const transactionLineReference = transactionLineJsonObj._transactionLineReference;
+        const originalTenderLineReferences = transactionLineJsonObj._originalTenderLineReferences;
+        const tenderAuthCategory = Constants_1.TenderAuthCategory[transactionLineJsonObj._tenderAuthCategory];
+        const tenderType = TenderType_1.TenderType.createFromJsonObject(transactionLineJsonObj._tenderType);
+        const entryMethod = transactionLineJsonObj._entryMethod;
+        const tenderReversalFailed = transactionLineJsonObj._tenderReversalFailed;
+        const actionType = transactionLineJsonObj._actionType;
+        const mappedRefundTenderTypeName = transactionLineJsonObj._mappedRefundTenderTypeName;
+        const subType = transactionLineJsonObj._subType;
+        const isChangeProcessing = transactionLineJsonObj._isChangeProcessing;
+        const isTenderAuthorizationFallback = transactionLineJsonObj._isTenderAuthorizationFallback;
+        let tenderAmount;
+        if (transactionLineJsonObj._tenderAmount) {
+            tenderAmount = new scp_component_business_core_1.Money(transactionLineJsonObj._tenderAmount);
+        }
+        const authResponse = transactionLineJsonObj._authResponse;
+        if (transactionLineJsonObj._authResponse) {
+            if (transactionLineJsonObj._authResponse.balance) {
+                authResponse.balance = new scp_component_business_core_1.Money(transactionLineJsonObj._authResponse.balance);
+            }
+            if (transactionLineJsonObj._authResponse.amount) {
+                authResponse.amount = new scp_component_business_core_1.Money(transactionLineJsonObj._authResponse.amount);
+            }
+            if (transactionLineJsonObj._authResponse.approvedAmount) {
+                authResponse.approvedAmount = new scp_component_business_core_1.Money(transactionLineJsonObj._authResponse.approvedAmount);
+            }
+        }
+        const status = scp_types_commerce_transaction_1.TenderAuthorizationStatus[transactionLineJsonObj._status];
+        const failureReasonCode = scp_types_commerce_transaction_1.TenderAuthFailureReasonCode[transactionLineJsonObj._failureReasonCode];
+        const tenderAuthorizationStatusLine = new TenderAuthorizationStatusLine(lineNumber, lineType, status, tenderAmount, authResponse, failureReasonCode, authorizationDeviceId, transactionLineReference, forcedAuthorizationApproval, cardNumber, giftCardPin, valueCertificateNumber, offlineAuthorizationCode, offlineApprovalCode, tenderAuthCategory, tenderType, entryMethod, tenderReversalFailed, originalTenderLineReferences, actionType, mappedRefundTenderTypeName, subType, isChangeProcessing, isTenderAuthorizationFallback);
+        tenderAuthorizationStatusLine.loadFromJsonObject(transactionLineJsonObj);
+        return tenderAuthorizationStatusLine;
+    }
+    get couldAffectPricing() {
+        return false;
+    }
+    get status() {
+        return this._status;
+    }
+    get tenderAmount() {
+        return this._tenderAmount;
+    }
+    get authResponse() {
+        return this._authResponse;
+    }
+    get failureReasonCode() {
+        return this._failureReasonCode;
+    }
+    get authorizationDeviceId() {
+        return this._authorizationDeviceId;
+    }
+    get forcedAuthorizationApproval() {
+        return this._forcedAuthorizationApproval;
+    }
+    get cardNumber() {
+        return this._cardNumber;
+    }
+    get giftCardPin() {
+        return this._giftCardPin;
+    }
+    get valueCertificateNumber() {
+        return this._valueCertificateNumber;
+    }
+    get transactionLineReference() {
+        return this._transactionLineReference;
+    }
+    get originalTenderLineReferences() {
+        return this._originalTenderLineReferences;
+    }
+    get offlineApprovalCode() {
+        return this._offlineApprovalCode;
+    }
+    get offlineAuthorizationCode() {
+        return this._offlineAuthorizationCode;
+    }
+    get tenderId() {
+        return this.tenderType ? this.tenderType.id : undefined;
+    }
+    get tenderName() {
+        return this.tenderType ? this.tenderType.tenderName : undefined;
+    }
+    get tenderTypeName() {
+        return this.tenderType ? this.tenderType.tenderTypeName : undefined;
+    }
+    get tenderAuthCategory() {
+        return this._tenderAuthCategory;
+    }
+    get tenderType() {
+        return this._tenderType;
+    }
+    get entryMethod() {
+        return this._entryMethod;
+    }
+    get tenderReversalFailed() {
+        return this._tenderReversalFailed;
+    }
+    get isChangeProcessing() {
+        return this._isChangeProcessing;
+    }
+    get actionType() {
+        return this._actionType;
+    }
+    get subType() {
+        return this._subType;
+    }
+    get mappedRefundTenderTypeName() {
+        return this._mappedRefundTenderTypeName;
+    }
+    get isTenderAuthorizationFallback() {
+        return this._isTenderAuthorizationFallback;
+    }
+    newTransactionLine() {
+        return new TenderAuthorizationStatusLine(this.lineNumber, this.lineType, this.status, this.tenderAmount, this.authResponse, this.failureReasonCode, this.authorizationDeviceId, this.transactionLineReference, this.forcedAuthorizationApproval, this.cardNumber, this.giftCardPin, this._valueCertificateNumber, this.offlineAuthorizationCode, this.offlineApprovalCode, this.tenderAuthCategory, this._tenderType, this._entryMethod, this._tenderReversalFailed, this._originalTenderLineReferences, this._actionType, this._mappedRefundTenderTypeName, this._subType, this._isChangeProcessing, this._isTenderAuthorizationFallback);
+    }
+}
+exports.TenderAuthorizationStatusLine = TenderAuthorizationStatusLine;
+function mapInputSourceToEntryMethod(inputSource) {
+    let entryMethod;
+    switch (inputSource) {
+        case scp_component_store_selling_core_1.UIINPUT_SOURCE_BARCODE: {
+            entryMethod = scp_types_commerce_devices_1.EntryMethod.Scanned;
+            break;
+        }
+        case scp_component_store_selling_core_1.UIINPUT_SOURCE_KEYBOARD: {
+            entryMethod = scp_types_commerce_devices_1.EntryMethod.Keyed;
+            break;
+        }
+        default: {
+            entryMethod = scp_types_commerce_devices_1.EntryMethod.Unknown;
+            break;
+        }
+    }
+    return entryMethod;
+}
+function isTenderAuthorizationStatusLine(transactionLine) {
+    return (transactionLine instanceof TenderAuthorizationStatusLine ||
+        transactionLine.lineType === exports.TENDER_AUTH_STATUS_LINE_TYPE);
+}
+exports.isTenderAuthorizationStatusLine = isTenderAuthorizationStatusLine;
+function isTimeoutStatusLine(transactionLine) {
+    var _a, _b;
+    return (((_a = transactionLine) === null || _a === void 0 ? void 0 : _a.status) === scp_types_commerce_transaction_1.TenderAuthorizationStatus.Timeout ||
+        ((_b = transactionLine) === null || _b === void 0 ? void 0 : _b.failureReasonCode) === scp_types_commerce_transaction_1.TenderAuthFailureReasonCode.AuthorizationTimedOut);
+}
+exports.isTimeoutStatusLine = isTimeoutStatusLine;
+//# sourceMappingURL=TenderAuthorizationStatusLine.js.map

package/lib/domain/model/tender/TenderChangeCancelLine.d.ts

@@ -0,0 +1,25 @@
+import { ITransactionLine, UiBusinessEvent } from "@aptos-scp/scp-component-store-selling-core";
+import { BaseTransactionLine } from "../BaseTransactionLine";
+import { TenderType } from "../TenderType";
+export declare const TENDER_CHANGE_CANCEL_LINE_TYPE: string;
+export declare class TenderChangeCancelLine extends BaseTransactionLine {
+    private _tenderType?;
+    /**
+     * 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 {TenderChangeCancelLine}
+     */
+    static create(lineNumber: number, lineType: string, uiBusinessEvent: UiBusinessEvent, collectedData: Readonly<Map<string, any>>): TenderChangeCancelLine;
+    static createFromJsonObject(transactionLineJsonObj: any): TenderChangeCancelLine;
+    get couldAffectPricing(): boolean;
+    get tenderType(): TenderType;
+    protected constructor(lineNumber: number, lineType: string, tenderType: TenderType);
+    protected newTransactionLine(): BaseTransactionLine;
+}
+export declare function isTenderChangeCancelLine(transactionLine: ITransactionLine): transactionLine is TenderChangeCancelLine;

package/lib/domain/model/tender/TenderChangeCancelLine.js

@@ -0,0 +1,51 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const BaseTransactionLine_1 = require("../BaseTransactionLine");
+const Constants_1 = require("../Constants");
+exports.TENDER_CHANGE_CANCEL_LINE_TYPE = "TenderChangeCancel";
+class TenderChangeCancelLine 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, tenderType) {
+        super(lineNumber, lineType);
+        this._tenderType = tenderType;
+    }
+    /**
+     * 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 {TenderChangeCancelLine}
+     */
+    static create(lineNumber, lineType, uiBusinessEvent, collectedData) {
+        const tenderType = collectedData.get(Constants_1.CollectedDataKey.TenderType);
+        return new TenderChangeCancelLine(lineNumber, lineType, tenderType);
+    }
+    static createFromJsonObject(transactionLineJsonObj) {
+        const lineNumber = BaseTransactionLine_1.BaseTransactionLine.lineNumberFromJsonObject(transactionLineJsonObj);
+        const lineType = BaseTransactionLine_1.BaseTransactionLine.lineTypeFromJsonObject(transactionLineJsonObj);
+        const tenderType = transactionLineJsonObj._tenderType;
+        const tenderChangeCancelLine = new TenderChangeCancelLine(lineNumber, lineType, tenderType);
+        tenderChangeCancelLine.loadFromJsonObject(transactionLineJsonObj);
+        return tenderChangeCancelLine;
+    }
+    get couldAffectPricing() {
+        return false;
+    }
+    get tenderType() {
+        return this._tenderType;
+    }
+    newTransactionLine() {
+        return new TenderChangeCancelLine(this.lineNumber, this.lineType, this.tenderType);
+    }
+}
+exports.TenderChangeCancelLine = TenderChangeCancelLine;
+function isTenderChangeCancelLine(transactionLine) {
+    return (transactionLine instanceof TenderChangeCancelLine ||
+        transactionLine.lineType === exports.TENDER_CHANGE_CANCEL_LINE_TYPE);
+}
+exports.isTenderChangeCancelLine = isTenderChangeCancelLine;
+//# sourceMappingURL=TenderChangeCancelLine.js.map

package/lib/domain/model/tender/TenderLine.d.ts

@@ -0,0 +1,113 @@
+import { Money } from "@aptos-scp/scp-component-business-core";
+import { IAuthorizationResponse } from "@aptos-scp/scp-types-commerce-devices";
+import { ActionType, IOriginalTenderReference, IResidentLimit, ISameTransactionLineReference, ITransactionLineReference, ITransactionLineReferenceType } from "@aptos-scp/scp-types-commerce-transaction";
+import { ITransactionLine, UiBusinessEvent } from "@aptos-scp/scp-component-store-selling-core";
+import { BaseTransactionLine } from "../BaseTransactionLine";
+import { TenderAdjustmentType, TenderAuthCategory, VoidSource } from "../Constants";
+import { TenderType } from "../TenderType";
+import { IVoidableLine, IVoidingLine } from "../VoidInterfaces";
+import { ITenderLine } from "./ITenderLine";
+export declare const TENDER_PAYMENT_LINE_TYPE = "TenderPayment";
+export declare const TENDER_REFUND_LINE_TYPE = "TenderRefund";
+export declare const TENDER_CHANGE_LINE_TYPE = "TenderChange";
+export declare const TENDER_DECLINE_LINE_TYPE = "TenderDecline";
+export declare const TENDER_ADJUSTMENT_LINE_TYPE = "TenderAdjustment";
+export declare const TENDER_EXCHANGE_IN_LINE_TYPE = "TenderExchangeIn";
+export declare const TENDER_EXCHANGE_OUT_LINE_TYPE = "TenderExchangeOut";
+export declare const TENDER_CASHOUT_LINE_TYPE = "TenderCashout";
+export declare const TENDER_AUTHORIZATION_TOKEN_LINE_TYPE = "TenderAuthorizationToken";
+export declare const TENDER_TRANSFER_FROM_ACCOUNT_LINE_TYPE = "TenderTransferFromAccount";
+export declare class TenderLine extends BaseTransactionLine implements ITenderLine, IVoidableLine, ITransactionLineReference, IVoidingLine {
+    private _tenderAuthCategory;
+    private _tenderType;
+    private _tenderAmount;
+    private _authResponse;
+    private _authorizationDeviceId;
+    private _preventsTransactionVoid;
+    private _adjustmentType;
+    private _transactionLineReference;
+    private _refundedLineReference;
+    private _referenceNumber;
+    private _residentLimit;
+    private _promptRuleType;
+    private _originalTenderReferences;
+    private _actionType;
+    private _supervisorOverrideLineReference;
+    private _tax;
+    private _foreignTenderAmount;
+    private _exchangeRateValue;
+    private _exchangeRateManualEntryLineReference?;
+    private _forfeitTenderChangeConfirmed?;
+    private _previouslyCollectedTender?;
+    /**
+     * 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 {TenderLine}
+     */
+    static create(lineNumber: number, lineType: string, uiBusinessEvent: UiBusinessEvent, collectedData: Readonly<Map<string, any>>): TenderLine;
+    static createFromJsonObject(transactionLineJsonObj: any): TenderLine;
+    get couldAffectPricing(): boolean;
+    get couldAffectTaxation(): boolean;
+    get tenderId(): string;
+    get tenderName(): string;
+    get tenderTypeName(): string;
+    get tenderAuthCategory(): TenderAuthCategory;
+    get tenderType(): TenderType;
+    get tenderAmount(): Money;
+    get tax(): Money;
+    get foreignTenderAmount(): Money;
+    get exchangeRateValue(): string;
+    get exchangeRateManualEntryLineReference(): ISameTransactionLineReference;
+    get authResponse(): IAuthorizationResponse;
+    get voided(): boolean;
+    get refunded(): boolean;
+    get voidSource(): VoidSource;
+    get authorizationDeviceId(): string;
+    get referenceNumber(): string;
+    get promptRuleType(): string;
+    get originalTenderReferences(): IOriginalTenderReference[];
+    get actionType(): ActionType;
+    get supervisorOverrideLineReference(): ITransactionLineReferenceType;
+    get isAuthorized(): boolean;
+    get preventsTransactionVoid(): boolean;
+    get forfeitTenderChangeConfirmed(): boolean;
+    get isPreviouslyCollected(): boolean;
+    get allowVoid(): boolean;
+    get adjustmentType(): TenderAdjustmentType;
+    get voidingLine(): boolean;
+    get transactionLineReference(): ITransactionLineReferenceType;
+    get refundedLineReference(): ITransactionLineReferenceType;
+    get fiscalCode(): string;
+    get fiscalType(): string;
+    get residentLimit(): IResidentLimit;
+    signatureRequired(): boolean;
+    printDeclineDetails(): boolean;
+    printDeclineReceipt(): boolean;
+    printVoidTenderDetails(): boolean;
+    printVoidTenderReceipt(): boolean;
+    /**
+     * Print store receipt if tender requires store receipts
+     * Authorized tenders require merchantReceiptData to allow printing of store receipts for tenders
+     */
+    printStoreReceipt(): boolean;
+    protected constructor(lineNumber: number, lineType: string, extendedAmount: Money, tenderAuthCategory: TenderAuthCategory, tenderType: TenderType, tenderAmount: Money, authResponse: IAuthorizationResponse, authorizationDeviceId: string, preventsTransactionVoid: boolean, adjustmentType: TenderAdjustmentType, transactionLineReference: ITransactionLineReferenceType, refundedLineReference: ITransactionLineReferenceType, referenceNumber: string, residentLimit: IResidentLimit, promptRuleType: string, originalTenderReferences: IOriginalTenderReference[], actionType: ActionType, supervisorOverrideLineReference: ITransactionLineReferenceType, tax: Money, foreignTenderAmount: Money, exchangeRateValue: string, exchangeRateManualEntryLineReference?: ISameTransactionLineReference, forfeitTenderChangeConfirmed?: boolean, previouslyCollectedTender?: boolean);
+    protected newTransactionLine(): TenderLine;
+    private static determineExtendedAmount;
+}
+export declare function isTenderLine(transactionLine: ITransactionLine): transactionLine is TenderLine;
+export declare function isTenderDeclineLine(transactionLine: ITransactionLine): transactionLine is TenderLine;
+export declare function isTenderPaymentLine(transactionLine: ITransactionLine): transactionLine is TenderLine;
+export declare function isTenderAdjustmentLine(transactionLine: ITransactionLine): transactionLine is TenderLine;
+export declare function isTenderChangeLine(transactionLine: ITransactionLine): transactionLine is TenderLine;
+export declare function isTenderTokenLine(transactionLine: ITransactionLine): transactionLine is TenderLine;
+export declare function isTenderExchangeLine(transactionLine: ITransactionLine): transactionLine is TenderLine;
+export declare function isSameTransactionTenderRefundLine(transactionLine: ITransactionLine): transactionLine is TenderLine;
+export declare function isTenderPaymentOnlyLine(transactionLine: ITransactionLine): transactionLine is TenderLine;
+export declare function isTenderRefundOnlyLine(transactionLine: ITransactionLine): transactionLine is TenderLine;
+export declare function isTenderTransferFromAccountLine(transactionLine: ITransactionLine): transactionLine is TenderLine;