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

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

@@ -0,0 +1,385 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const scp_component_business_core_1 = require("@aptos-scp/scp-component-business-core");
+// This dependency should be removed. See ZSPFLD-2346.
+const scp_types_commerce_devices_1 = require("@aptos-scp/scp-types-commerce-devices");
+const BaseTransactionLine_1 = require("../BaseTransactionLine");
+const Constants_1 = require("../Constants");
+const TenderType_1 = require("../TenderType");
+exports.TENDER_PAYMENT_LINE_TYPE = "TenderPayment";
+exports.TENDER_REFUND_LINE_TYPE = "TenderRefund";
+exports.TENDER_CHANGE_LINE_TYPE = "TenderChange";
+exports.TENDER_DECLINE_LINE_TYPE = "TenderDecline";
+exports.TENDER_ADJUSTMENT_LINE_TYPE = "TenderAdjustment";
+exports.TENDER_EXCHANGE_IN_LINE_TYPE = "TenderExchangeIn";
+exports.TENDER_EXCHANGE_OUT_LINE_TYPE = "TenderExchangeOut";
+exports.TENDER_CASHOUT_LINE_TYPE = "TenderCashout";
+exports.TENDER_AUTHORIZATION_TOKEN_LINE_TYPE = "TenderAuthorizationToken";
+exports.TENDER_TRANSFER_FROM_ACCOUNT_LINE_TYPE = "TenderTransferFromAccount";
+class TenderLine extends BaseTransactionLine_1.BaseTransactionLine {
+    constructor(lineNumber, lineType, extendedAmount, tenderAuthCategory, tenderType, tenderAmount, authResponse, authorizationDeviceId, preventsTransactionVoid, adjustmentType, transactionLineReference, refundedLineReference, referenceNumber, residentLimit, promptRuleType, originalTenderReferences, actionType, supervisorOverrideLineReference, tax, foreignTenderAmount, exchangeRateValue, exchangeRateManualEntryLineReference, forfeitTenderChangeConfirmed, previouslyCollectedTender) {
+        super(lineNumber, lineType, extendedAmount);
+        this._tenderAuthCategory = tenderAuthCategory;
+        this._tenderType = tenderType;
+        this._tenderAmount = tenderAmount;
+        this._authResponse = authResponse;
+        this._authorizationDeviceId = authorizationDeviceId;
+        this._preventsTransactionVoid = preventsTransactionVoid;
+        this._adjustmentType = adjustmentType;
+        this._transactionLineReference = transactionLineReference;
+        this._refundedLineReference = refundedLineReference;
+        this._referenceNumber = referenceNumber;
+        this._residentLimit = residentLimit;
+        this._promptRuleType = promptRuleType;
+        this._originalTenderReferences = originalTenderReferences;
+        this._actionType = actionType;
+        this._supervisorOverrideLineReference = supervisorOverrideLineReference;
+        this._tax = tax;
+        this._foreignTenderAmount = foreignTenderAmount;
+        this._exchangeRateValue = exchangeRateValue;
+        this._exchangeRateManualEntryLineReference = exchangeRateManualEntryLineReference;
+        this._forfeitTenderChangeConfirmed = forfeitTenderChangeConfirmed;
+        this._previouslyCollectedTender = 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, lineType, uiBusinessEvent, collectedData) {
+        const tenderType = collectedData.get(Constants_1.CollectedDataKey.TenderType);
+        const tenderAuthCategory = tenderType
+            ? tenderType.tenderAuthCategory
+            : collectedData.get(Constants_1.CollectedDataKey.TenderAuthCategory);
+        const tenderAmount = collectedData.get(Constants_1.CollectedDataKey.TenderAmount);
+        // The tender could (in the future) be a foreign tender with a currency other than the accounting currency.
+        const accountingCurrency = collectedData.get("accountingCurrency");
+        const extendedAmount = TenderLine.determineExtendedAmount(lineType, tenderAmount, accountingCurrency);
+        const authResponse = collectedData.get(Constants_1.CollectedDataKey.TenderAuthResponse);
+        const authorizationDeviceId = collectedData.get(Constants_1.CollectedDataKey.AuthorizationDeviceId);
+        const preventsTransactionVoid = !!collectedData.get(Constants_1.CollectedDataKey.TenderPreventsTransactionVoid);
+        const adjustmentType = collectedData.get(Constants_1.CollectedDataKey.TenderAdjustmentType);
+        const transactionLineReference = collectedData.get(Constants_1.CollectedDataKey.TransactionLineReference);
+        const refundedLineReference = collectedData.get(Constants_1.CollectedDataKey.RefundedLineReference);
+        const referenceNumber = collectedData.get(Constants_1.CollectedDataKey.ReferenceNumber);
+        const residentLimit = collectedData.get(Constants_1.CollectedDataKey.ResidentLimit);
+        const promptRuleType = collectedData.get(Constants_1.CollectedDataKey.PromptRuleType);
+        const originalTenderReferences = collectedData.get(Constants_1.CollectedDataKey.OriginalTenderReferences);
+        const actionType = collectedData.get(Constants_1.CollectedDataKey.ActionType);
+        const supervisorOverrideLineReference = collectedData.get(Constants_1.CollectedDataKey.SupervisorOverrideLineReference) || undefined;
+        const tax = collectedData.get(Constants_1.CollectedDataKey.TenderTax);
+        const foreignTenderAmount = collectedData.get(Constants_1.CollectedDataKey.ForeignTenderAmount);
+        const exchangeRateValue = collectedData.get(Constants_1.CollectedDataKey.ExchangeRateValue);
+        const exchangeRateManualEntryLineReference = collectedData.get(Constants_1.CollectedDataKey.ExchangeRateManualEntryLineReference);
+        const forfeitTenderChangeConfirmed = !!collectedData.get(Constants_1.CollectedDataKey.ForfeitChangeConfirmation);
+        const previouslyCollectedTender = collectedData.get(Constants_1.CollectedDataKey.PreviouslyCollectedTender)
+            ? collectedData.get(Constants_1.CollectedDataKey.PreviouslyCollectedTender)
+            : false;
+        return new TenderLine(lineNumber, lineType, extendedAmount, tenderAuthCategory, tenderType, tenderAmount, authResponse, authorizationDeviceId, preventsTransactionVoid, adjustmentType, transactionLineReference, refundedLineReference, referenceNumber, residentLimit, promptRuleType, originalTenderReferences, actionType, supervisorOverrideLineReference, tax, foreignTenderAmount, exchangeRateValue, exchangeRateManualEntryLineReference, forfeitTenderChangeConfirmed, previouslyCollectedTender);
+    }
+    static createFromJsonObject(transactionLineJsonObj) {
+        const lineNumber = BaseTransactionLine_1.BaseTransactionLine.lineNumberFromJsonObject(transactionLineJsonObj);
+        const lineType = BaseTransactionLine_1.BaseTransactionLine.lineTypeFromJsonObject(transactionLineJsonObj);
+        const extendedAmount = BaseTransactionLine_1.BaseTransactionLine.extendedAmountFromJsonObject(transactionLineJsonObj);
+        const tenderAuthCategory = Constants_1.TenderAuthCategory[transactionLineJsonObj._tenderAuthCategory];
+        const tenderType = TenderType_1.TenderType.createFromJsonObject(transactionLineJsonObj._tenderType);
+        const transactionLineReference = transactionLineJsonObj._transactionLineReference;
+        const refundedLineReference = transactionLineJsonObj._refundedLineReference;
+        const referenceNumber = transactionLineJsonObj._referenceNumber;
+        const promptRuleType = transactionLineJsonObj._promptRuleType;
+        const actionType = transactionLineJsonObj._actionType;
+        const supervisorOverrideLineReference = transactionLineJsonObj._supervisorOverrideLineReference;
+        const originalTenderReferences = transactionLineJsonObj._originalTenderReferences;
+        const exchangeRateValue = transactionLineJsonObj._exchangeRateValue;
+        let tenderAmount;
+        if (transactionLineJsonObj._tenderAmount) {
+            tenderAmount = new scp_component_business_core_1.Money(transactionLineJsonObj._tenderAmount);
+        }
+        let tax;
+        if (transactionLineJsonObj._tax) {
+            tax = new scp_component_business_core_1.Money(transactionLineJsonObj._tax);
+        }
+        let foreignTenderAmount;
+        if (transactionLineJsonObj._foreignTenderAmount) {
+            foreignTenderAmount = new scp_component_business_core_1.Money(transactionLineJsonObj._foreignTenderAmount);
+        }
+        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 authorizationDeviceId = transactionLineJsonObj._authorizationDeviceId;
+        const preventsTransactionVoid = !!transactionLineJsonObj._preventsTransactionVoid;
+        const adjustmentType = transactionLineJsonObj._adjustmentType;
+        const residentLimit = transactionLineJsonObj._residentLimit;
+        const exchangeRateManualEntryLineReference = transactionLineJsonObj._exchangeRateManualEntryLineReference;
+        const forfeitTenderChangeConfirmed = !!transactionLineJsonObj._forfeitTenderChangeConfirmed;
+        const previouslyCollectedTender = !!transactionLineJsonObj._previouslyCollectedTender;
+        const tenderLine = new TenderLine(lineNumber, lineType, extendedAmount, tenderAuthCategory, tenderType, tenderAmount, authResponse, authorizationDeviceId, preventsTransactionVoid, adjustmentType, transactionLineReference, refundedLineReference, referenceNumber, residentLimit, promptRuleType, originalTenderReferences, actionType, supervisorOverrideLineReference, tax, foreignTenderAmount, exchangeRateValue, exchangeRateManualEntryLineReference, forfeitTenderChangeConfirmed, previouslyCollectedTender);
+        tenderLine.loadFromJsonObject(transactionLineJsonObj);
+        return tenderLine;
+    }
+    get couldAffectPricing() {
+        return false;
+    }
+    get couldAffectTaxation() {
+        return false;
+    }
+    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 tenderAmount() {
+        return this._tenderAmount;
+    }
+    get tax() {
+        return this._tax;
+    }
+    get foreignTenderAmount() {
+        return this._foreignTenderAmount;
+    }
+    get exchangeRateValue() {
+        return this._exchangeRateValue;
+    }
+    get exchangeRateManualEntryLineReference() {
+        return this._exchangeRateManualEntryLineReference;
+    }
+    get authResponse() {
+        return this._authResponse;
+    }
+    get voided() {
+        return false;
+    }
+    get refunded() {
+        return false;
+    }
+    get voidSource() {
+        return undefined;
+    }
+    get authorizationDeviceId() {
+        return this._authorizationDeviceId;
+    }
+    get referenceNumber() {
+        return this._referenceNumber;
+    }
+    get promptRuleType() {
+        return this._promptRuleType;
+    }
+    get originalTenderReferences() {
+        return this._originalTenderReferences;
+    }
+    get actionType() {
+        return this._actionType;
+    }
+    get supervisorOverrideLineReference() {
+        return this._supervisorOverrideLineReference;
+    }
+    get isAuthorized() {
+        return this.authResponse ? true : false;
+    }
+    get preventsTransactionVoid() {
+        return this._preventsTransactionVoid;
+    }
+    get forfeitTenderChangeConfirmed() {
+        return this._forfeitTenderChangeConfirmed;
+    }
+    get isPreviouslyCollected() {
+        return this._previouslyCollectedTender;
+    }
+    get allowVoid() {
+        var _a;
+        if (this.authResponse &&
+            this.authResponse.paymentProvider === scp_types_commerce_devices_1.PaymentProvider.Adyen &&
+            this.lineType === exports.TENDER_REFUND_LINE_TYPE &&
+            ((_a = this.tenderType) === null || _a === void 0 ? void 0 : _a.cardType) !== scp_types_commerce_devices_1.CardType.Gift) {
+            //a payment provider was used for a refund that can't be voided, so don't allow voiding
+            return false;
+        }
+        return true;
+    }
+    get adjustmentType() {
+        return this._adjustmentType;
+    }
+    get voidingLine() {
+        return isSameTransactionTenderRefundLine(this);
+    }
+    get transactionLineReference() {
+        return this._transactionLineReference;
+    }
+    get refundedLineReference() {
+        return this._refundedLineReference;
+    }
+    get fiscalCode() {
+        return this.tenderType ? this.tenderType.fiscalCode : undefined;
+    }
+    get fiscalType() {
+        return this.tenderType ? this.tenderType.fiscalType : undefined;
+    }
+    get residentLimit() {
+        return this._residentLimit;
+    }
+    signatureRequired() {
+        return this.tenderType && this.tenderType.signatureRequired(this.tenderAmount, this.authResponse);
+    }
+    printDeclineDetails() {
+        return (this.tenderType &&
+            this.tenderType.printDeclineTenderDetails &&
+            this.authResponse &&
+            !!this.authResponse.receiptData);
+    }
+    printDeclineReceipt() {
+        return (this.tenderType &&
+            this.tenderType.printDeclineTenderReceipt &&
+            this.authResponse &&
+            !!this.authResponse.receiptData);
+    }
+    printVoidTenderDetails() {
+        var _a;
+        return this.voided && !!((_a = this.tenderType) === null || _a === void 0 ? void 0 : _a.printVoidTenderDetails);
+    }
+    printVoidTenderReceipt() {
+        return this.tenderType.printVoidTenderReceipt;
+    }
+    /**
+     * Print store receipt if tender requires store receipts
+     * Authorized tenders require merchantReceiptData to allow printing of store receipts for tenders
+     */
+    printStoreReceipt() {
+        if (this.lineType === exports.TENDER_DECLINE_LINE_TYPE ||
+            this.lineType === exports.TENDER_AUTHORIZATION_TOKEN_LINE_TYPE) {
+            return false;
+        }
+        return this.tenderType && this.tenderType.printStoreTenderReceipt;
+    }
+    newTransactionLine() {
+        return new TenderLine(this.lineNumber, this.lineType, this.extendedAmount, this._tenderAuthCategory, this._tenderType, this._tenderAmount, this._authResponse, this._authorizationDeviceId, this._preventsTransactionVoid, this._adjustmentType, this._transactionLineReference, this._refundedLineReference, this._referenceNumber, this._residentLimit, this._promptRuleType, this._originalTenderReferences, this._actionType, this._supervisorOverrideLineReference, this._tax, this._foreignTenderAmount, this.exchangeRateValue, this._exchangeRateManualEntryLineReference, this._forfeitTenderChangeConfirmed, this._previouslyCollectedTender);
+    }
+    /* Since all properties are copied by the constructor in newTransactionLine, this just calls
+       super.loadFromJsonObject().
+       This is left here commented-out as a reminder that, if properties are added that are not handled by the
+       constructor, then this needs to be implemented.
+    protected loadFromJsonObject(transactionLineJsonObj: any): void {
+      super.loadFromJsonObject(transactionLineJsonObj);
+  
+      // These are already handled by the constructor
+      // this._tenderId = transactionLineJsonObj._tenderId;
+      // this._tenderName = transactionLineJsonObj._tenderName;
+      // this._tenderAmount = new Money(transactionLineJsonObj._tenderAmount);
+    }
+    */
+    static determineExtendedAmount(lineType, tenderAmount, accountingCurrency) {
+        let extendedAmount;
+        const currency = tenderAmount ? tenderAmount.currency : accountingCurrency;
+        switch (lineType) {
+            case exports.TENDER_PAYMENT_LINE_TYPE:
+            case exports.TENDER_TRANSFER_FROM_ACCOUNT_LINE_TYPE:
+            case exports.TENDER_EXCHANGE_IN_LINE_TYPE:
+            case exports.TENDER_CASHOUT_LINE_TYPE:
+                extendedAmount = tenderAmount.times(-1);
+                break;
+            case exports.TENDER_REFUND_LINE_TYPE:
+            case exports.TENDER_CHANGE_LINE_TYPE:
+            case exports.TENDER_ADJUSTMENT_LINE_TYPE:
+            case exports.TENDER_EXCHANGE_OUT_LINE_TYPE:
+                extendedAmount = tenderAmount;
+                break;
+            default:
+                // Other line types do not have financial impact on the transaction, so the extended amount of the line is zero.
+                extendedAmount = new scp_component_business_core_1.Money("0", currency);
+                break;
+        }
+        return extendedAmount;
+    }
+}
+exports.TenderLine = TenderLine;
+function isTenderLine(transactionLine) {
+    return (transactionLine instanceof TenderLine ||
+        // These lineType checks allow for decorators of a TenderLine (as well as POJS objects used in testing) to be
+        // identified as a TenderLine.  We should, probably, use an interface (with its own guard function), not the
+        // TenderLine class, when we want to work with TenderLine decorators, but for now, this is sufficient.
+        transactionLine.lineType === exports.TENDER_PAYMENT_LINE_TYPE ||
+        transactionLine.lineType === exports.TENDER_REFUND_LINE_TYPE ||
+        transactionLine.lineType === exports.TENDER_CHANGE_LINE_TYPE ||
+        transactionLine.lineType === exports.TENDER_DECLINE_LINE_TYPE ||
+        transactionLine.lineType === exports.TENDER_ADJUSTMENT_LINE_TYPE ||
+        transactionLine.lineType === exports.TENDER_EXCHANGE_IN_LINE_TYPE ||
+        transactionLine.lineType === exports.TENDER_EXCHANGE_OUT_LINE_TYPE ||
+        transactionLine.lineType === exports.TENDER_AUTHORIZATION_TOKEN_LINE_TYPE ||
+        transactionLine.lineType === exports.TENDER_TRANSFER_FROM_ACCOUNT_LINE_TYPE ||
+        transactionLine.lineType === exports.TENDER_CASHOUT_LINE_TYPE);
+    // Note: The tenderId should not be part of the guard function; it should be checked by the callers that need it.
+}
+exports.isTenderLine = isTenderLine;
+function isTenderDeclineLine(transactionLine) {
+    return transactionLine.lineType === exports.TENDER_DECLINE_LINE_TYPE;
+}
+exports.isTenderDeclineLine = isTenderDeclineLine;
+function isTenderPaymentLine(transactionLine) {
+    return (transactionLine.lineType === exports.TENDER_PAYMENT_LINE_TYPE ||
+        transactionLine.lineType === exports.TENDER_REFUND_LINE_TYPE ||
+        transactionLine.lineType === exports.TENDER_ADJUSTMENT_LINE_TYPE ||
+        transactionLine.lineType === exports.TENDER_TRANSFER_FROM_ACCOUNT_LINE_TYPE ||
+        transactionLine.lineType === exports.TENDER_CASHOUT_LINE_TYPE);
+}
+exports.isTenderPaymentLine = isTenderPaymentLine;
+function isTenderAdjustmentLine(transactionLine) {
+    return transactionLine.lineType === exports.TENDER_ADJUSTMENT_LINE_TYPE;
+}
+exports.isTenderAdjustmentLine = isTenderAdjustmentLine;
+function isTenderChangeLine(transactionLine) {
+    return transactionLine.lineType === exports.TENDER_CHANGE_LINE_TYPE;
+}
+exports.isTenderChangeLine = isTenderChangeLine;
+function isTenderTokenLine(transactionLine) {
+    return transactionLine.lineType === exports.TENDER_AUTHORIZATION_TOKEN_LINE_TYPE;
+}
+exports.isTenderTokenLine = isTenderTokenLine;
+function isTenderExchangeLine(transactionLine) {
+    return (transactionLine.lineType === exports.TENDER_EXCHANGE_IN_LINE_TYPE ||
+        transactionLine.lineType === exports.TENDER_EXCHANGE_OUT_LINE_TYPE);
+}
+exports.isTenderExchangeLine = isTenderExchangeLine;
+function isSameTransactionTenderRefundLine(transactionLine) {
+    return (isTenderLine(transactionLine) &&
+        transactionLine.lineType === exports.TENDER_REFUND_LINE_TYPE &&
+        transactionLine.refundedLineReference &&
+        !transactionLine.refundedLineReference.transactionId);
+}
+exports.isSameTransactionTenderRefundLine = isSameTransactionTenderRefundLine;
+function isTenderPaymentOnlyLine(transactionLine) {
+    return transactionLine.lineType === exports.TENDER_PAYMENT_LINE_TYPE;
+}
+exports.isTenderPaymentOnlyLine = isTenderPaymentOnlyLine;
+function isTenderRefundOnlyLine(transactionLine) {
+    return transactionLine.lineType === exports.TENDER_REFUND_LINE_TYPE;
+}
+exports.isTenderRefundOnlyLine = isTenderRefundOnlyLine;
+function isTenderTransferFromAccountLine(transactionLine) {
+    return transactionLine.lineType === exports.TENDER_TRANSFER_FROM_ACCOUNT_LINE_TYPE;
+}
+exports.isTenderTransferFromAccountLine = isTenderTransferFromAccountLine;
+//# sourceMappingURL=TenderLine.js.map

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

@@ -0,0 +1,29 @@
+import { ITransactionLine, UiBusinessEvent } from "@aptos-scp/scp-component-store-selling-core";
+import { BaseTransactionLine } from "../BaseTransactionLine";
+export declare const TENDER_SIGNATURE_LINE_TYPE = "TenderSignature";
+export declare class TenderSignatureLine extends BaseTransactionLine {
+    private _tenderLineNumber;
+    private _signature;
+    private _signaturePoints;
+    /**
+     * 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 {TenderSignatureLine}
+     */
+    static create(lineNumber: number, lineType: string, uiBusinessEvent: UiBusinessEvent, collectedData: Readonly<Map<string, any>>): TenderSignatureLine;
+    static createFromJsonObject(transactionLineJsonObj: any): TenderSignatureLine;
+    get couldAffectPricing(): boolean;
+    get voided(): boolean;
+    get tenderLineNumber(): number;
+    get signature(): string;
+    get signaturePoints(): string;
+    protected constructor(lineNumber: number, lineType: string, tenderLineNumber: number, signature: string, signaturePoints: string);
+    protected newTransactionLine(): BaseTransactionLine;
+}
+export declare function isTenderSignatureLine(transactionLine: ITransactionLine): transactionLine is TenderSignatureLine;

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

@@ -0,0 +1,66 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const BaseTransactionLine_1 = require("../BaseTransactionLine");
+exports.TENDER_SIGNATURE_LINE_TYPE = "TenderSignature";
+class TenderSignatureLine extends BaseTransactionLine_1.BaseTransactionLine {
+    constructor(lineNumber, lineType, tenderLineNumber, signature, signaturePoints) {
+        super(lineNumber, lineType);
+        this._tenderLineNumber = tenderLineNumber;
+        this._signature = signature;
+        this._signaturePoints = signaturePoints;
+    }
+    /**
+     * 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 {TenderSignatureLine}
+     */
+    static create(lineNumber, lineType, uiBusinessEvent, collectedData) {
+        const tenderLineNumber = collectedData.get("tenderLineNumber");
+        const signature = collectedData.get("signature");
+        const signaturePoints = collectedData.get("signaturePoints");
+        return new TenderSignatureLine(lineNumber, lineType, tenderLineNumber, signature, signaturePoints);
+    }
+    static createFromJsonObject(transactionLineJsonObj) {
+        const lineNumber = BaseTransactionLine_1.BaseTransactionLine.lineNumberFromJsonObject(transactionLineJsonObj);
+        const lineType = BaseTransactionLine_1.BaseTransactionLine.lineTypeFromJsonObject(transactionLineJsonObj);
+        const tenderLineNumber = transactionLineJsonObj._tenderLineNumber;
+        const signature = transactionLineJsonObj._signature;
+        const signaturePoints = transactionLineJsonObj._signaturePoints;
+        const tenderSignatureLine = new TenderSignatureLine(lineNumber, lineType, tenderLineNumber, signature, signaturePoints);
+        tenderSignatureLine.loadFromJsonObject(transactionLineJsonObj);
+        return tenderSignatureLine;
+    }
+    get couldAffectPricing() {
+        return false;
+    }
+    get voided() {
+        return false;
+    }
+    get tenderLineNumber() {
+        return this._tenderLineNumber;
+    }
+    get signature() {
+        return this._signature;
+    }
+    get signaturePoints() {
+        return this._signaturePoints;
+    }
+    newTransactionLine() {
+        return new TenderSignatureLine(this.lineNumber, this.lineType, this._tenderLineNumber, this._signature, this._signaturePoints);
+    }
+}
+exports.TenderSignatureLine = TenderSignatureLine;
+function isTenderSignatureLine(transactionLine) {
+    return (transactionLine instanceof TenderSignatureLine ||
+        (transactionLine.lineType === exports.TENDER_SIGNATURE_LINE_TYPE &&
+            (transactionLine.signature !== undefined ||
+                transactionLine.signaturePoints !== undefined)));
+}
+exports.isTenderSignatureLine = isTenderSignatureLine;
+//# sourceMappingURL=TenderSignatureLine.js.map

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

@@ -0,0 +1,12 @@
+import { ITransactionLineFactory } from "@aptos-scp/scp-component-store-selling-core";
+import { Money } from "@aptos-scp/scp-component-business-core";
+import { BaseTenderLineDecorator } from "./BaseTenderLineDecorator";
+import { TenderLine } from "./TenderLine";
+export declare const DECORATOR_TYPE_TENDER_TAX_LINE: string;
+export declare class TenderTaxLineDecorator extends BaseTenderLineDecorator {
+    private _tax;
+    static createFromJsonObject(transactionLineJsonObj: any, transactionLineFactory: ITransactionLineFactory): TenderTaxLineDecorator;
+    constructor(tax: Money, tenderLine: TenderLine, annotationSourceLineNumber: number);
+    get tax(): Money;
+    protected newTransactionLine(): TenderTaxLineDecorator;
+}

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

@@ -0,0 +1,29 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const BaseLineDecorator_1 = require("../BaseLineDecorator");
+const BaseTenderLineDecorator_1 = require("./BaseTenderLineDecorator");
+const TENDER_TAX_ANNOTATION_SOURCE_TYPE = "TenderTax";
+const DECORATOR_DESCRIPTION_TENDER_TAX = "TENDER_TAX";
+exports.DECORATOR_TYPE_TENDER_TAX_LINE = "TENDER_TAX_LINE_DECORATOR";
+class TenderTaxLineDecorator extends BaseTenderLineDecorator_1.BaseTenderLineDecorator {
+    constructor(tax, tenderLine, annotationSourceLineNumber) {
+        super(exports.DECORATOR_TYPE_TENDER_TAX_LINE, tenderLine, DECORATOR_DESCRIPTION_TENDER_TAX, TENDER_TAX_ANNOTATION_SOURCE_TYPE, annotationSourceLineNumber);
+        this._tax = tax;
+    }
+    static createFromJsonObject(transactionLineJsonObj, transactionLineFactory) {
+        const decoratedTransactionLineJsonObj = BaseLineDecorator_1.BaseLineDecorator.getDecoratedTransactionLineJsonObjectFromJsonObject(transactionLineJsonObj);
+        const decoratedItemLine = transactionLineFactory.createTransactionLineFromJsonObj(decoratedTransactionLineJsonObj);
+        const annotationSourceLineNumber = BaseLineDecorator_1.BaseLineDecorator.getAnnotationSourceLineNumberFromJsonObject(transactionLineJsonObj);
+        const tax = transactionLineJsonObj._tax;
+        const tenderTaxLineDecorator = new TenderTaxLineDecorator(tax, decoratedItemLine, annotationSourceLineNumber);
+        return tenderTaxLineDecorator;
+    }
+    get tax() {
+        return this._tax;
+    }
+    newTransactionLine() {
+        return new TenderTaxLineDecorator(this._tax, this.decoratedTransactionLine, this.annotationSourceLineNumber);
+    }
+}
+exports.TenderTaxLineDecorator = TenderTaxLineDecorator;
+//# sourceMappingURL=TenderTaxLineDecorator.js.map

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

@@ -0,0 +1,9 @@
+import { IActionContext, ITransactionLine } from "@aptos-scp/scp-component-store-selling-core";
+import { PaymentRequestType } from "@aptos-scp/scp-types-commerce-devices";
+import { TenderAuthorizationStatus } from "@aptos-scp/scp-types-commerce-transaction";
+import { TenderAuthCategory } from "..";
+import { TenderAuthorizationStatusLine } from "./TenderAuthorizationStatusLine";
+import { TenderLine } from "./TenderLine";
+export declare function isVoidStatus(status: TenderAuthorizationStatus): boolean;
+export declare function getReferencedLine(statusLine: TenderAuthorizationStatusLine | TenderLine, context: IActionContext): ITransactionLine;
+export declare function statusToPaymentRequestType(tenderAuthCategory: TenderAuthCategory, existingCard?: boolean): Map<TenderAuthorizationStatus, PaymentRequestType>;

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

@@ -0,0 +1,43 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+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 __1 = require("..");
+function isVoidStatus(status) {
+    return (status === scp_types_commerce_transaction_1.TenderAuthorizationStatus.VoidStarted ||
+        status === scp_types_commerce_transaction_1.TenderAuthorizationStatus.ReversalStarted ||
+        status === scp_types_commerce_transaction_1.TenderAuthorizationStatus.VoidTransactionStarted ||
+        status === scp_types_commerce_transaction_1.TenderAuthorizationStatus.CancelPartialApproval);
+}
+exports.isVoidStatus = isVoidStatus;
+function getReferencedLine(statusLine, context) {
+    const lineToVoidNumber = statusLine.transactionLineReference && statusLine.transactionLineReference.lineNumber;
+    return context.transaction.findLineByLineNumber(lineToVoidNumber);
+}
+exports.getReferencedLine = getReferencedLine;
+function statusToPaymentRequestType(tenderAuthCategory, existingCard) {
+    return new Map([
+        [scp_types_commerce_transaction_1.TenderAuthorizationStatus.BalanceInquiryStarted, scp_types_commerce_devices_1.PaymentRequestType.GiftCardBalanceInquiry],
+        [scp_types_commerce_transaction_1.TenderAuthorizationStatus.RefundStarted, mapRefundStartedRequestType(tenderAuthCategory, existingCard)],
+        [scp_types_commerce_transaction_1.TenderAuthorizationStatus.GiftCardIssueStarted, scp_types_commerce_devices_1.PaymentRequestType.GiftCardIssue],
+        [scp_types_commerce_transaction_1.TenderAuthorizationStatus.GiftCardReloadStarted, scp_types_commerce_devices_1.PaymentRequestType.GiftCardReload],
+        [scp_types_commerce_transaction_1.TenderAuthorizationStatus.GiftCardRedeemStarted, scp_types_commerce_devices_1.PaymentRequestType.GiftCardRedeem],
+        [scp_types_commerce_transaction_1.TenderAuthorizationStatus.RedeemStarted, scp_types_commerce_devices_1.PaymentRequestType.Redeem],
+        [scp_types_commerce_transaction_1.TenderAuthorizationStatus.VoidStarted, scp_types_commerce_devices_1.PaymentRequestType.Void],
+        [scp_types_commerce_transaction_1.TenderAuthorizationStatus.VoidTransactionStarted, scp_types_commerce_devices_1.PaymentRequestType.Void],
+        [scp_types_commerce_transaction_1.TenderAuthorizationStatus.CancelPartialApproval, scp_types_commerce_devices_1.PaymentRequestType.Void],
+        [scp_types_commerce_transaction_1.TenderAuthorizationStatus.GiftCertificateIssueStarted, scp_types_commerce_devices_1.PaymentRequestType.Issue],
+        [scp_types_commerce_transaction_1.TenderAuthorizationStatus.StoreCreditIssueStarted, scp_types_commerce_devices_1.PaymentRequestType.Issue],
+        [scp_types_commerce_transaction_1.TenderAuthorizationStatus.CashoutStarted, scp_types_commerce_devices_1.PaymentRequestType.GiftCardCashout],
+    ]);
+}
+exports.statusToPaymentRequestType = statusToPaymentRequestType;
+function mapRefundStartedRequestType(tenderAuthCategory, existingCard) {
+    if (tenderAuthCategory === __1.TenderAuthCategory.StoredValueCertificateService) {
+        return scp_types_commerce_devices_1.PaymentRequestType.Issue;
+    }
+    else {
+        return existingCard ? scp_types_commerce_devices_1.PaymentRequestType.GiftCardReload : scp_types_commerce_devices_1.PaymentRequestType.GiftCardIssue;
+    }
+}
+//# sourceMappingURL=TenderUtils.js.map

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

@@ -0,0 +1,13 @@
+import { ITransactionLineFactory } from "@aptos-scp/scp-component-store-selling-core";
+import { VoidSource } from "../Constants";
+import { BaseTenderLineDecorator } from "./BaseTenderLineDecorator";
+import { TenderLine } from "./TenderLine";
+export declare const DECORATOR_TYPE_VOIDED_TENDER_LINE: string;
+export declare class VoidedTenderLineDecorator extends BaseTenderLineDecorator {
+    private _voidSource;
+    static createFromJsonObject(transactionLineJsonObj: any, transactionLineFactory: ITransactionLineFactory): VoidedTenderLineDecorator;
+    constructor(voidSource: VoidSource, tenderLine: TenderLine, annotationSourceLineNumber: number);
+    get voided(): boolean;
+    get voidSource(): VoidSource;
+    protected newTransactionLine(): VoidedTenderLineDecorator;
+}

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

@@ -0,0 +1,43 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const BaseLineDecorator_1 = require("../BaseLineDecorator");
+const VoidedLineDecorator_1 = require("../void/VoidedLineDecorator");
+const BaseTenderLineDecorator_1 = require("./BaseTenderLineDecorator");
+const VOIDED_TENDER_ANNOTATION_SOURCE_TYPE = "VoidedTender";
+exports.DECORATOR_TYPE_VOIDED_TENDER_LINE = "VOIDED_TENDER_LINE_DECORATOR";
+class VoidedTenderLineDecorator extends BaseTenderLineDecorator_1.BaseTenderLineDecorator {
+    constructor(voidSource, tenderLine, annotationSourceLineNumber) {
+        super(exports.DECORATOR_TYPE_VOIDED_TENDER_LINE, tenderLine, VoidedLineDecorator_1.DECORATOR_DESCRIPTION_VOIDED, VOIDED_TENDER_ANNOTATION_SOURCE_TYPE, annotationSourceLineNumber);
+        // We use an amount of zero (in the original currency), so that this line does not impact the transaction totals.
+        //this._newTenderAmount = new Money(0.0, this.decoratedTransactionLine.tenderAmount.currency.toString());
+        this._voidSource = voidSource;
+    }
+    static createFromJsonObject(transactionLineJsonObj, transactionLineFactory) {
+        const decoratedTransactionLineJsonObj = BaseLineDecorator_1.BaseLineDecorator.getDecoratedTransactionLineJsonObjectFromJsonObject(transactionLineJsonObj);
+        const decoratedItemLine = transactionLineFactory.createTransactionLineFromJsonObj(decoratedTransactionLineJsonObj);
+        const annotationSourceLineNumber = BaseLineDecorator_1.BaseLineDecorator.getAnnotationSourceLineNumberFromJsonObject(transactionLineJsonObj);
+        const voidSource = transactionLineJsonObj._voidSource;
+        const voidedItemLineDecorator = new VoidedTenderLineDecorator(voidSource, decoratedItemLine, annotationSourceLineNumber);
+        return voidedItemLineDecorator;
+    }
+    /* 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(): VoidedItemLineDecorator {
+      let newVoidedItemLineDecorator: VoidedItemLineDecorator = super.clone<VoidedItemLineDecorator>();
+  
+      return newVoidedItemLineDecorator;
+    }
+    */
+    get voided() {
+        return true;
+    }
+    get voidSource() {
+        return this._voidSource;
+    }
+    newTransactionLine() {
+        return new VoidedTenderLineDecorator(this._voidSource, this.decoratedTransactionLine, this.annotationSourceLineNumber);
+    }
+}
+exports.VoidedTenderLineDecorator = VoidedTenderLineDecorator;
+//# sourceMappingURL=VoidedTenderLineDecorator.js.map