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

package/lib/domain/model/taxRefund/TaxRefundSession.js

@@ -0,0 +1,214 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const scp_component_logging_1 = require("@aptos-scp/scp-component-logging");
+const logger = scp_component_logging_1.LogManager.getLogger("com.aptos.storesellingfeatures.domain.model.TaxRefund.TaxRefundSession");
+exports.TAX_REFUND_SESSION = "TAX_REFUND_SESSION";
+exports.TAX_REFUND_CHANNEL = "TAX_REFUND_CHANNEL";
+exports.TAX_REFUND_ISSUING_STARTED = "TAX_REFUND_ISSUING_STARTED";
+var TaxRefundState;
+(function (TaxRefundState) {
+    TaxRefundState["Inactive"] = "Inactive";
+    TaxRefundState["Completed"] = "Completed";
+    TaxRefundState["Connecting"] = "Connecting";
+    TaxRefundState["Connected"] = "Connected";
+    TaxRefundState["Active"] = "Active";
+})(TaxRefundState = exports.TaxRefundState || (exports.TaxRefundState = {}));
+var TaxRefundIssuingState;
+(function (TaxRefundIssuingState) {
+    TaxRefundIssuingState["Inactive"] = "Inactive";
+    TaxRefundIssuingState["Issuing"] = "Issuing";
+    TaxRefundIssuingState["Printing"] = "Printing";
+    TaxRefundIssuingState["Completed"] = "Completed";
+    TaxRefundIssuingState["Voiding"] = "Voiding";
+})(TaxRefundIssuingState = exports.TaxRefundIssuingState || (exports.TaxRefundIssuingState = {}));
+class TaxRefundSession {
+    constructor(token, state, sender, groupId, skipTaxRefund, shopId, deskId, issuingState, contentAsDataUrl, documentIdentifier, grossAmount, taxFreeInvoiceNumber, taxFreeInvoiceSequenceNumber, taxFreeInvoiceSequenceNumberGenerator, taxFreeCreditNoteNumber, taxFreeCreditNoteSequenceNumber, taxFreeCreditNoteSequenceNumberGenerator, error) {
+        this._type = exports.TAX_REFUND_SESSION;
+        this._token = token;
+        this._state = state;
+        this._sender = sender;
+        this._groupId = groupId;
+        this._skipTaxRefund = skipTaxRefund;
+        this._issuingState = issuingState;
+        this._error = error;
+        this._shopId = shopId;
+        this._deskId = deskId;
+        this._contentAsDataUrl = contentAsDataUrl;
+        this._documentIdentifier = documentIdentifier;
+        this._grossAmount = grossAmount;
+        this._taxFreeInvoiceNumber = taxFreeInvoiceNumber;
+        this._taxFreeInvoiceSequenceNumber = taxFreeInvoiceSequenceNumber;
+        this._taxFreeInvoiceSequenceNumberGenerator = taxFreeInvoiceSequenceNumberGenerator;
+        this._taxFreeCreditNoteNumber = taxFreeCreditNoteNumber;
+        this._taxFreeCreditNoteSequenceNumber = taxFreeCreditNoteSequenceNumber;
+        this._taxFreeCreditNoteSequenceNumberGenerator = taxFreeCreditNoteSequenceNumberGenerator;
+    }
+    static createFromJsonObject(taxRefundSessionJsonObj) {
+        logger.traceEntry("createFromJsonObject");
+        const token = taxRefundSessionJsonObj._token;
+        const state = taxRefundSessionJsonObj._state;
+        const sender = taxRefundSessionJsonObj._sender;
+        const groupId = taxRefundSessionJsonObj._groupId;
+        const skipTaxRefund = taxRefundSessionJsonObj._skipTaxRefund;
+        const error = taxRefundSessionJsonObj._error;
+        const issuingState = taxRefundSessionJsonObj._issuingState;
+        const shopId = taxRefundSessionJsonObj._shopId;
+        const deskId = taxRefundSessionJsonObj._deskId;
+        const contentAsDataUrl = taxRefundSessionJsonObj._contentAsDataUrl;
+        const documentIdentifier = taxRefundSessionJsonObj._documentIdentifier;
+        const grossAmount = taxRefundSessionJsonObj._grossAmount;
+        const taxFreeInvoiceNumber = taxRefundSessionJsonObj._taxFreeInvoiceNumber;
+        const taxFreeInvoiceSequenceNumber = taxRefundSessionJsonObj._taxFreeInvoiceSequenceNumber;
+        const taxFreeInvoiceSequenceNumberGenerator = taxRefundSessionJsonObj._taxFreeInvoiceSequenceNumberGenerator;
+        const taxFreeCreditNoteNumber = taxRefundSessionJsonObj._taxFreeCreditNoteNumber;
+        const taxFreeCreditNoteSequenceNumber = taxRefundSessionJsonObj._taxFreeCreditNoteSequenceNumber;
+        const taxFreeCreditNoteSequenceNumberGenerator = taxRefundSessionJsonObj._taxFreeCreditNoteSequenceNumberGenerator;
+        return new TaxRefundSession(token, state, sender, groupId, skipTaxRefund, shopId, deskId, issuingState, contentAsDataUrl, documentIdentifier, grossAmount, taxFreeInvoiceNumber, taxFreeInvoiceSequenceNumber, taxFreeInvoiceSequenceNumberGenerator, taxFreeCreditNoteNumber, taxFreeCreditNoteSequenceNumber, taxFreeCreditNoteSequenceNumberGenerator, error);
+    }
+    static create() {
+        logger.traceEntry("create");
+        return new TaxRefundSession(undefined, TaxRefundState.Inactive, undefined, undefined, undefined, undefined, undefined, TaxRefundIssuingState.Inactive, undefined, undefined, undefined);
+    }
+    reset() {
+        return new TaxRefundSession(undefined, TaxRefundState.Inactive, undefined, undefined, undefined, undefined, undefined, TaxRefundIssuingState.Inactive, undefined, undefined, undefined);
+    }
+    recordToken(token) {
+        return new TaxRefundSession(token, this._state, this._sender, this._groupId, this._skipTaxRefund, this._shopId, this._deskId, this._issuingState, this._contentAsDataUrl, this._documentIdentifier, this._grossAmount);
+    }
+    startConnection(token, sender, groupId, shopId, deskId, grossAmount) {
+        return new TaxRefundSession(token, TaxRefundState.Connecting, sender, groupId, undefined, shopId, deskId, this._issuingState, this._contentAsDataUrl, this._documentIdentifier, grossAmount);
+    }
+    recordConnected() {
+        return new TaxRefundSession(this._token, TaxRefundState.Connected, this._sender, this._groupId, undefined, this._shopId, this._deskId, this._issuingState, this._contentAsDataUrl, this._documentIdentifier, this._grossAmount, this._taxFreeInvoiceNumber, this._taxFreeInvoiceSequenceNumber, this._taxFreeInvoiceSequenceNumberGenerator, this._taxFreeCreditNoteNumber, this._taxFreeCreditNoteSequenceNumber, this._taxFreeCreditNoteSequenceNumberGenerator);
+    }
+    startSession(token, shopId, deskId, documentIdentifier) {
+        return new TaxRefundSession(token, TaxRefundState.Active, this._sender, this._groupId, undefined, shopId, deskId, this._issuingState, this._contentAsDataUrl, documentIdentifier, this._grossAmount);
+    }
+    recordError(error) {
+        return new TaxRefundSession(this._token, this.state, this._sender, this._groupId, this._skipTaxRefund, this._shopId, this._deskId, this._issuingState, this._contentAsDataUrl, this._documentIdentifier, undefined, undefined, undefined, undefined, undefined, undefined, undefined, error);
+    }
+    startIssuing() {
+        return new TaxRefundSession(this._token, this._state, this._sender, this._groupId, this._skipTaxRefund, this._shopId, this._deskId, TaxRefundIssuingState.Issuing, this._contentAsDataUrl, this._documentIdentifier, this._grossAmount, this._taxFreeInvoiceNumber, this._taxFreeInvoiceSequenceNumber, this._taxFreeInvoiceSequenceNumberGenerator, this._taxFreeCreditNoteNumber, this._taxFreeCreditNoteSequenceNumber, this._taxFreeCreditNoteSequenceNumberGenerator);
+    }
+    startPrinting(contentAsDataUrl, documentIdentifier) {
+        return new TaxRefundSession(this._token, this._state, this._sender, this._groupId, this._skipTaxRefund, this._shopId, this._deskId, TaxRefundIssuingState.Printing, contentAsDataUrl, documentIdentifier, this._grossAmount, this._taxFreeInvoiceNumber, this._taxFreeInvoiceSequenceNumber, this._taxFreeInvoiceSequenceNumberGenerator, this._taxFreeCreditNoteNumber, this._taxFreeCreditNoteSequenceNumber, this._taxFreeCreditNoteSequenceNumberGenerator);
+    }
+    startVoiding() {
+        return new TaxRefundSession(this._token, this._state, this._sender, this._groupId, this._skipTaxRefund, this._shopId, this._deskId, TaxRefundIssuingState.Voiding, this._contentAsDataUrl, this._documentIdentifier, this._grossAmount);
+    }
+    recordCompleted() {
+        return new TaxRefundSession(this._token, TaxRefundState.Completed, this._sender, this._groupId, this._skipTaxRefund, this._shopId, this._deskId, TaxRefundIssuingState.Completed, this._contentAsDataUrl, this._documentIdentifier, this._grossAmount, this._taxFreeInvoiceNumber, this._taxFreeInvoiceSequenceNumber, this._taxFreeInvoiceSequenceNumberGenerator, this._taxFreeCreditNoteNumber, this._taxFreeCreditNoteSequenceNumber, this._taxFreeCreditNoteSequenceNumberGenerator, this._error);
+    }
+    skipTaxRefundIssuing() {
+        return new TaxRefundSession(undefined, this._state, undefined, undefined, true, undefined, undefined, TaxRefundIssuingState.Inactive, undefined, undefined, undefined);
+    }
+    recordDocumentIdentifier(documentIdentifier) {
+        return new TaxRefundSession(this._token, this._state, this._sender, this._groupId, this._skipTaxRefund, this._shopId, this._deskId, this._issuingState, this._contentAsDataUrl, documentIdentifier, this._grossAmount, this._taxFreeInvoiceNumber, this._taxFreeInvoiceSequenceNumber, this._taxFreeInvoiceSequenceNumberGenerator, this._taxFreeCreditNoteNumber, this._taxFreeCreditNoteSequenceNumber, this._taxFreeCreditNoteSequenceNumberGenerator, this._error);
+    }
+    recordTaxFreeInvoiceNumber(invoiceNumber, sequenceNumber, sequenceNumberGenerator) {
+        return new TaxRefundSession(this._token, this._state, this._sender, this._groupId, this._skipTaxRefund, this._shopId, this._deskId, this._issuingState, this._contentAsDataUrl, this._documentIdentifier, this._grossAmount, invoiceNumber, sequenceNumber, sequenceNumberGenerator, undefined, undefined, undefined, this._error);
+    }
+    recordTaxFreeCreditNoteNumber(creditNoteNumber, sequenceNumber, sequenceNumberGenerator) {
+        return new TaxRefundSession(this._token, this._state, this._sender, this._groupId, this._skipTaxRefund, this._shopId, this._deskId, this._issuingState, this._contentAsDataUrl, this._documentIdentifier, this._grossAmount, undefined, undefined, undefined, creditNoteNumber, sequenceNumber, sequenceNumberGenerator, this._error);
+    }
+    get stateValues() {
+        logger.traceEntry("get stateValues");
+        return new Map([
+            ["TaxRefundSession.token", this.token],
+            ["TaxRefundSession.state", this.state],
+            ["TaxRefundSession.sender", this.sender],
+            ["TaxRefundSession.groupId", this.groupId],
+            ["TaxRefundSession.skipTaxRefund", this.skipTaxRefund],
+            ["TaxRefundSession.isConnected", this.isConnected],
+            ["TaxRefundSession.isCompletedOrSkipped", this.isCompletedOrSkipped],
+            ["TaxRefundSession.issuingState", this.issuingState],
+            ["TaxRefundSession.error", this.error],
+            ["TaxRefundSession.contentAsDataUrl", this.contentAsDataUrl],
+            ["TaxRefundSession.isPrinting", this.isPrinting],
+            ["TaxRefundSession.documentIdentifier", this.documentIdentifier],
+            ["TaxRefundSession.isActive", this.isActive],
+            ["TaxRefundSession.isCompleted", this.isCompleted],
+            ["TaxRefundSession.isVoiding", this.isVoiding],
+        ]);
+    }
+    get token() {
+        return this._token;
+    }
+    get type() {
+        return this._type;
+    }
+    get state() {
+        return this._state;
+    }
+    get sender() {
+        return this._sender;
+    }
+    get groupId() {
+        return this._groupId;
+    }
+    get skipTaxRefund() {
+        return this._skipTaxRefund;
+    }
+    get error() {
+        return this._error;
+    }
+    get issuingState() {
+        return this._issuingState;
+    }
+    get deskId() {
+        return this._deskId;
+    }
+    get shopId() {
+        return this._shopId;
+    }
+    get contentAsDataUrl() {
+        return this._contentAsDataUrl;
+    }
+    get documentIdentifier() {
+        return this._documentIdentifier;
+    }
+    get taxFreeInvoiceNumber() {
+        return this._taxFreeInvoiceNumber;
+    }
+    get taxFreeInvoiceSequenceNumber() {
+        return this._taxFreeInvoiceSequenceNumber;
+    }
+    get taxFreeInvoiceSequenceNumberGenerator() {
+        return this._taxFreeInvoiceSequenceNumberGenerator;
+    }
+    get taxFreeCreditNoteNumber() {
+        return this._taxFreeCreditNoteNumber;
+    }
+    get taxFreeCreditNoteSequenceNumber() {
+        return this._taxFreeCreditNoteSequenceNumber;
+    }
+    get taxFreeCreditNoteSequenceNumberGenerator() {
+        return this._taxFreeCreditNoteSequenceNumberGenerator;
+    }
+    get grossAmount() {
+        return this._grossAmount;
+    }
+    get isConnected() {
+        return this._state === TaxRefundState.Connected;
+    }
+    get isCompletedOrSkipped() {
+        return this._state === TaxRefundState.Completed || this._skipTaxRefund;
+    }
+    get isPrinting() {
+        return this._issuingState === TaxRefundIssuingState.Printing;
+    }
+    get isActive() {
+        return this._state === TaxRefundState.Active;
+    }
+    get isCompleted() {
+        return this._state === TaxRefundState.Completed;
+    }
+    get isVoiding() {
+        return this._issuingState === TaxRefundIssuingState.Voiding;
+    }
+    get isInactive() {
+        return this._state === TaxRefundState.Inactive;
+    }
+}
+exports.TaxRefundSession = TaxRefundSession;
+//# sourceMappingURL=TaxRefundSession.js.map

package/lib/domain/model/taxRefund/VoidTaxRefundLine.d.ts

@@ -0,0 +1,30 @@
+import { ITransactionLine, UiBusinessEvent } from "@aptos-scp/scp-component-store-selling-core";
+import { IServiceResult, ITransactionLineReferenceType, ITransactionReferenceLine } from "@aptos-scp/scp-types-commerce-transaction";
+import { BaseTransactionLine } from "../BaseTransactionLine";
+export declare const VOID_TAX_REFUND_LINE_TYPE = "TaxRefundVoid";
+export declare class VoidTaxRefundLine extends BaseTransactionLine {
+    private _originalTransactionReference;
+    private _serviceResult?;
+    private _supervisorOverrideFailureLineReference?;
+    /**
+     * 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 {VoidTaxRefundLine}
+     */
+    static create(lineNumber: number, lineType: string, uiBusinessEvent: UiBusinessEvent, collectedData: Readonly<Map<string, any>>): VoidTaxRefundLine;
+    static createFromJsonObject(transactionLineJsonObj: any): VoidTaxRefundLine;
+    get couldAffectPricing(): boolean;
+    get originalTransactionReference(): ITransactionReferenceLine;
+    get serviceResult(): IServiceResult;
+    get supervisorOverrideFailureLineReference(): ITransactionLineReferenceType;
+    setSupervisorOverrideFailureLineReferenceReference(supervisorOverrideFailureLineReference: ITransactionLineReferenceType): VoidTaxRefundLine;
+    protected constructor(lineNumber: number, lineType: string, originalTransactionReference: ITransactionReferenceLine, serviceResult?: IServiceResult, supervisorOverrideFailureLineReference?: ITransactionLineReferenceType);
+    protected newTransactionLine(): BaseTransactionLine;
+}
+export declare function isVoidTaxRefundLine(transactionLine: ITransactionLine): transactionLine is VoidTaxRefundLine;

package/lib/domain/model/taxRefund/VoidTaxRefundLine.js

@@ -0,0 +1,71 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const _ = require("lodash");
+const BaseTransactionLine_1 = require("../BaseTransactionLine");
+const Constants_1 = require("../Constants");
+exports.VOID_TAX_REFUND_LINE_TYPE = "TaxRefundVoid";
+class VoidTaxRefundLine 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, originalTransactionReference, serviceResult, supervisorOverrideFailureLineReference) {
+        super(lineNumber, lineType);
+        this._originalTransactionReference = originalTransactionReference;
+        this._serviceResult = serviceResult;
+        this._supervisorOverrideFailureLineReference = supervisorOverrideFailureLineReference;
+    }
+    /**
+     * 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 {VoidTaxRefundLine}
+     */
+    static create(lineNumber, lineType, uiBusinessEvent, collectedData) {
+        const originalTransactionReference = collectedData.get(Constants_1.CollectedDataKey.OriginalTransactionReference);
+        const serviceResult = collectedData.get(Constants_1.CollectedDataKey.ServiceResult);
+        const voidTaxRefundLine = new VoidTaxRefundLine(lineNumber, lineType, originalTransactionReference, serviceResult);
+        return voidTaxRefundLine;
+    }
+    static createFromJsonObject(transactionLineJsonObj) {
+        const lineNumber = BaseTransactionLine_1.BaseTransactionLine.lineNumberFromJsonObject(transactionLineJsonObj);
+        const lineType = BaseTransactionLine_1.BaseTransactionLine.lineTypeFromJsonObject(transactionLineJsonObj);
+        const originalTransactionReference = transactionLineJsonObj._originalTransactionReference;
+        const serviceResult = transactionLineJsonObj._serviceResult;
+        const supervisorOverrideFailureLineReference = transactionLineJsonObj._supervisorOverrideFailureLineReference;
+        const voidTaxRefundLine = new VoidTaxRefundLine(lineNumber, lineType, originalTransactionReference, serviceResult, supervisorOverrideFailureLineReference);
+        voidTaxRefundLine.loadFromJsonObject(transactionLineJsonObj);
+        return voidTaxRefundLine;
+    }
+    get couldAffectPricing() {
+        return false;
+    }
+    get originalTransactionReference() {
+        return this._originalTransactionReference;
+    }
+    get serviceResult() {
+        return this._serviceResult;
+    }
+    get supervisorOverrideFailureLineReference() {
+        return this._supervisorOverrideFailureLineReference;
+    }
+    setSupervisorOverrideFailureLineReferenceReference(supervisorOverrideFailureLineReference) {
+        const newLine = this.clone();
+        newLine._supervisorOverrideFailureLineReference = !_.isEmpty(supervisorOverrideFailureLineReference)
+            ? supervisorOverrideFailureLineReference
+            : undefined;
+        return newLine;
+    }
+    newTransactionLine() {
+        return new VoidTaxRefundLine(this.lineNumber, this.lineType, this.originalTransactionReference, this._serviceResult, this._supervisorOverrideFailureLineReference);
+    }
+}
+exports.VoidTaxRefundLine = VoidTaxRefundLine;
+function isVoidTaxRefundLine(transactionLine) {
+    return (transactionLine instanceof VoidTaxRefundLine ||
+        (transactionLine && transactionLine.lineType === exports.VOID_TAX_REFUND_LINE_TYPE));
+}
+exports.isVoidTaxRefundLine = isVoidTaxRefundLine;
+//# sourceMappingURL=VoidTaxRefundLine.js.map

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

@@ -0,0 +1,6 @@
+export * from "./TaxRefundInterfaces";
+export * from "./TaxRefundSession";
+export * from "./TaxRefundLine";
+export * from "./StartTaxRefundLine";
+export * from "./ReprintTaxRefundLine";
+export * from "./VoidTaxRefundLine";

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

@@ -0,0 +1,12 @@
+"use strict";
+function __export(m) {
+    for (var p in m) if (!exports.hasOwnProperty(p)) exports[p] = m[p];
+}
+Object.defineProperty(exports, "__esModule", { value: true });
+__export(require("./TaxRefundInterfaces"));
+__export(require("./TaxRefundSession"));
+__export(require("./TaxRefundLine"));
+__export(require("./StartTaxRefundLine"));
+__export(require("./ReprintTaxRefundLine"));
+__export(require("./VoidTaxRefundLine"));
+//# sourceMappingURL=index.js.map

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

@@ -0,0 +1,47 @@
+import { Money } from "@aptos-scp/scp-component-business-core";
+import { IAuthorizationResponse } from "@aptos-scp/scp-types-commerce-devices";
+import { IOriginalTenderReference, ITransactionLineReferenceType } from "@aptos-scp/scp-types-commerce-transaction";
+import { BaseLineDecorator } from "../../model/BaseLineDecorator";
+import { TenderAdjustmentType, TenderAuthCategory } from "../Constants";
+import { TenderType } from "../TenderType";
+import { ITenderLine } from "./ITenderLine";
+import { TenderLine } from "./TenderLine";
+/**
+ * This class acts as the base class for all TenderLine decorators.  It implements all methods on TenderLine, and
+ * passes them through to the decorated TenderLine, which might be the original TenderLine, or another decorator.
+ * This class allows each concrete decorator class to implement only the methods that it needs to change, and keeps it
+ * from having to implement all of the methods.
+ */
+export declare abstract class BaseTenderLineDecorator extends BaseLineDecorator<ITenderLine> implements ITenderLine {
+    get tenderId(): string;
+    get tenderName(): string;
+    get tenderTypeName(): string;
+    get tenderAuthCategory(): TenderAuthCategory;
+    get tenderType(): TenderType;
+    get tenderAmount(): Money;
+    get authResponse(): IAuthorizationResponse;
+    get authorizationDeviceId(): string;
+    get preventsTransactionVoid(): boolean;
+    get forfeitTenderChangeConfirmed(): boolean;
+    get allowVoid(): boolean;
+    get transactionLineReference(): ITransactionLineReferenceType;
+    get refundedLineReference(): ITransactionLineReferenceType;
+    get originalTenderReferences(): IOriginalTenderReference[];
+    get refunded(): boolean;
+    signatureRequired(): boolean;
+    printDeclineDetails(): boolean;
+    printDeclineReceipt(): boolean;
+    printStoreReceipt(): boolean;
+    printVoidTenderDetails(): boolean;
+    printVoidTenderReceipt(): boolean;
+    get fiscalCode(): string;
+    get fiscalType(): string;
+    get referenceNumber(): string;
+    get promptRuleType(): string;
+    get adjustmentType(): TenderAdjustmentType;
+    get tax(): Money;
+    get foreignTenderAmount(): Money;
+    get exchangeRateValue(): string;
+    protected constructor(lineDecoratorType: string, decoratedTransactionLine: TenderLine, annotationDescription: string, annotationSourceType: string, annotationSourceLineNumber?: number);
+    protected clone(): BaseTenderLineDecorator;
+}

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

@@ -0,0 +1,110 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const BaseLineDecorator_1 = require("../../model/BaseLineDecorator");
+/**
+ * This class acts as the base class for all TenderLine decorators.  It implements all methods on TenderLine, and
+ * passes them through to the decorated TenderLine, which might be the original TenderLine, or another decorator.
+ * This class allows each concrete decorator class to implement only the methods that it needs to change, and keeps it
+ * from having to implement all of the methods.
+ */
+class BaseTenderLineDecorator extends BaseLineDecorator_1.BaseLineDecorator {
+    // TenderLine API --------------------------------------------------------------
+    get tenderId() {
+        return this.decoratedTransactionLine.tenderId;
+    }
+    get tenderName() {
+        return this.decoratedTransactionLine.tenderName;
+    }
+    get tenderTypeName() {
+        return this.decoratedTransactionLine.tenderTypeName;
+    }
+    get tenderAuthCategory() {
+        return this.decoratedTransactionLine.tenderAuthCategory;
+    }
+    get tenderType() {
+        return this.decoratedTransactionLine.tenderType;
+    }
+    get tenderAmount() {
+        return this.decoratedTransactionLine.tenderAmount;
+    }
+    get authResponse() {
+        return this.decoratedTransactionLine.authResponse;
+    }
+    get authorizationDeviceId() {
+        return this.decoratedTransactionLine.authorizationDeviceId;
+    }
+    get preventsTransactionVoid() {
+        return this.decoratedTransactionLine.preventsTransactionVoid;
+    }
+    get forfeitTenderChangeConfirmed() {
+        return this.decoratedTransactionLine.forfeitTenderChangeConfirmed;
+    }
+    get allowVoid() {
+        return true;
+    }
+    get transactionLineReference() {
+        return this.decoratedTransactionLine.transactionLineReference;
+    }
+    get refundedLineReference() {
+        return this.decoratedTransactionLine.refundedLineReference;
+    }
+    get originalTenderReferences() {
+        return this.decoratedTransactionLine.originalTenderReferences;
+    }
+    get refunded() {
+        return this.decoratedTransactionLine.refunded;
+    }
+    signatureRequired() {
+        return this.decoratedTransactionLine.signatureRequired();
+    }
+    printDeclineDetails() {
+        return this.decoratedTransactionLine.printDeclineDetails();
+    }
+    printDeclineReceipt() {
+        return this.decoratedTransactionLine.printDeclineReceipt();
+    }
+    printStoreReceipt() {
+        return this.decoratedTransactionLine.printStoreReceipt();
+    }
+    printVoidTenderDetails() {
+        var _a;
+        return this.voided && !!((_a = this.tenderType) === null || _a === void 0 ? void 0 : _a.printVoidTenderDetails);
+    }
+    printVoidTenderReceipt() {
+        return this.tenderType.printVoidTenderReceipt;
+    }
+    get fiscalCode() {
+        return this.decoratedTransactionLine.fiscalCode;
+    }
+    get fiscalType() {
+        return this.decoratedTransactionLine.fiscalType;
+    }
+    get referenceNumber() {
+        return this.decoratedTransactionLine.referenceNumber;
+    }
+    get promptRuleType() {
+        return this.decoratedTransactionLine.promptRuleType;
+    }
+    get adjustmentType() {
+        return this.decoratedTransactionLine.adjustmentType;
+    }
+    get tax() {
+        return this.decoratedTransactionLine.tax;
+    }
+    get foreignTenderAmount() {
+        return this.decoratedTransactionLine.foreignTenderAmount;
+    }
+    get exchangeRateValue() {
+        return this.decoratedTransactionLine.exchangeRateValue;
+    }
+    // End of TenderLine API -------------------------------------------------------
+    constructor(lineDecoratorType, decoratedTransactionLine, annotationDescription, annotationSourceType, annotationSourceLineNumber) {
+        super(lineDecoratorType, decoratedTransactionLine, annotationDescription, annotationSourceType, annotationSourceLineNumber);
+    }
+    clone() {
+        const newBaseTenderLineDecorator = super.clone();
+        return newBaseTenderLineDecorator;
+    }
+}
+exports.BaseTenderLineDecorator = BaseTenderLineDecorator;
+//# sourceMappingURL=BaseTenderLineDecorator.js.map

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

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

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

@@ -0,0 +1,32 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const BaseTransactionLine_1 = require("../BaseTransactionLine");
+exports.CANCEL_SUBSCRIPTION_TOKEN_LINE_TYPE = "CancelSubscriptionToken";
+class CancelSubscriptionTokenLine extends BaseTransactionLine_1.BaseTransactionLine {
+    static create(lineNumber, lineType, uiBusinessEvent, collectedData) {
+        return new CancelSubscriptionTokenLine(lineNumber, lineType);
+    }
+    static createFromJsonObject(transactionLineJsonObj) {
+        const lineNumber = BaseTransactionLine_1.BaseTransactionLine.lineNumberFromJsonObject(transactionLineJsonObj);
+        const lineType = BaseTransactionLine_1.BaseTransactionLine.lineTypeFromJsonObject(transactionLineJsonObj);
+        const cancelSubscriptionTokenLine = new CancelSubscriptionTokenLine(lineNumber, lineType);
+        cancelSubscriptionTokenLine.loadFromJsonObject(transactionLineJsonObj);
+        return cancelSubscriptionTokenLine;
+    }
+    get couldAffectPricing() {
+        return false;
+    }
+    constructor(lineNumber, lineType) {
+        super(lineNumber, lineType);
+    }
+    newTransactionLine() {
+        return new CancelSubscriptionTokenLine(this.lineNumber, this.lineType);
+    }
+}
+exports.CancelSubscriptionTokenLine = CancelSubscriptionTokenLine;
+function isCancelSubscriptionTokenLine(transactionLine) {
+    return (transactionLine instanceof CancelSubscriptionTokenLine ||
+        transactionLine.lineType === exports.CANCEL_SUBSCRIPTION_TOKEN_LINE_TYPE);
+}
+exports.isCancelSubscriptionTokenLine = isCancelSubscriptionTokenLine;
+//# sourceMappingURL=CancelSubscriptionTokenLine.js.map

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

@@ -0,0 +1,45 @@
+import { Money } from "@aptos-scp/scp-component-business-core";
+import { ITransactionLine } from "@aptos-scp/scp-component-store-selling-core";
+import { IAuthorizationResponse } from "@aptos-scp/scp-types-commerce-devices";
+import { ActionType, IOriginalTenderReference, ITransactionLineReferenceType } from "@aptos-scp/scp-types-commerce-transaction";
+import { TenderAdjustmentType, TenderAuthCategory } from "../Constants";
+import { TenderType } from "../TenderType";
+import { IVoidableLine } from "../VoidInterfaces";
+export interface ITenderLine extends ITransactionLine, IVoidableLine {
+    readonly tenderAuthCategory: TenderAuthCategory;
+    readonly tenderType: TenderType;
+    readonly tenderAmount: Money;
+    readonly authResponse: IAuthorizationResponse;
+    readonly authorizationDeviceId: string;
+    readonly preventsTransactionVoid: boolean;
+    readonly forfeitTenderChangeConfirmed: boolean;
+    readonly transactionLineReference: ITransactionLineReferenceType;
+    readonly refundedLineReference: ITransactionLineReferenceType;
+    readonly refunded: boolean;
+    readonly tenderId: string;
+    readonly tenderName: string;
+    readonly tenderTypeName: string;
+    readonly referenceNumber: string;
+    readonly promptRuleType: string;
+    readonly fiscalCode?: string;
+    readonly fiscalType?: string;
+    readonly adjustmentType?: TenderAdjustmentType;
+    readonly originalTenderReferences?: IOriginalTenderReference[];
+    readonly actionType?: ActionType;
+    readonly tax?: Money;
+    /**
+     * The amount given before the conversion
+     */
+    readonly foreignTenderAmount?: Money;
+    /**
+     * The exchange rate value used for the conversion.
+     * Expected to be a double precision string.
+     */
+    readonly exchangeRateValue?: string;
+    signatureRequired(): boolean;
+    printDeclineDetails(): boolean;
+    printDeclineReceipt(): boolean;
+    printStoreReceipt(): boolean;
+    printVoidTenderDetails(): boolean;
+    printVoidTenderReceipt(): boolean;
+}

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

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

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

@@ -0,0 +1,17 @@
+import { Money } from "@aptos-scp/scp-component-business-core";
+import { PaymentRequestType } from "@aptos-scp/scp-types-commerce-devices";
+export interface IOfflineAuthorizationFields {
+    maskedCardNumber: string;
+    originalRequestType: PaymentRequestType;
+    phoneNumber: string;
+    authorizationAmount: Money;
+}
+/**
+ * Approval code validation is only currently supported based on Aurus offline approval code algorithm as follows
+ * Digits 1-4: Last 4 digits of the card being used
+ * Digit 5: IVR transaction type, Sale (1) Return (2) - Aurus recommends allowing any digit
+ * Digit 6: Checksum digit
+ * @param offlineApprovalCode
+ * @param offlineAuthorizationFields
+ */
+export declare function validateOfflineApprovalCode(offlineApprovalCode: string, offlineAuthorizationFields: IOfflineAuthorizationFields): boolean;

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

@@ -0,0 +1,47 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+/**
+ * Approval code validation is only currently supported based on Aurus offline approval code algorithm as follows
+ * Digits 1-4: Last 4 digits of the card being used
+ * Digit 5: IVR transaction type, Sale (1) Return (2) - Aurus recommends allowing any digit
+ * Digit 6: Checksum digit
+ * @param offlineApprovalCode
+ * @param offlineAuthorizationFields
+ */
+function validateOfflineApprovalCode(offlineApprovalCode, offlineAuthorizationFields) {
+    if (offlineAuthorizationFields &&
+        offlineAuthorizationFields.maskedCardNumber &&
+        offlineAuthorizationFields.maskedCardNumber.length >= 4) {
+        const lastFour = offlineAuthorizationFields.maskedCardNumber &&
+            offlineAuthorizationFields.maskedCardNumber.substring(offlineAuthorizationFields.maskedCardNumber.length - 4, offlineAuthorizationFields.maskedCardNumber.length);
+        const ivrTransactionType = getDigitByIndex(offlineApprovalCode, 5);
+        const checkSum = String(lastFour + ivrTransactionType)
+            .split("")
+            .reduce((a, v, i) => a + sumDigits(convertToInteger(v) * getWeight(i)), 0);
+        return offlineApprovalCode === lastFour + ivrTransactionType + ((checkSum * 9) % 10);
+    }
+    return false;
+}
+exports.validateOfflineApprovalCode = validateOfflineApprovalCode;
+function getDigitByIndex(value, index) {
+    return convertToInteger(value.charAt(index - 1));
+}
+function sumDigits(result) {
+    return ((result - 1) % 9) + 1;
+}
+function getWeight(index) {
+    return ((index + 1) % 2) + 1;
+}
+function convertToInteger(input) {
+    if (!input) {
+        return undefined;
+    }
+    const output = Number(input);
+    if (isNaN(output)) {
+        return undefined;
+    }
+    else {
+        return output;
+    }
+}
+//# sourceMappingURL=OfflineAuthorization.js.map