@aptos-scp/scp-component-store-selling-features-domain-model 2.24.0 → 2.26.0

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

@@ -575,6 +575,7 @@ export declare enum CollectedDataKey {
     FiscalDeviceActivitySuccessful = "fiscalDeviceActivitySuccessful",
     VoidedInProcessFlag = "voidedInProcessFlag",
     FiscalDeviceInformation = "fiscalDeviceInformation",
+    FiscalDeviceAdditionalData = "fiscalDeviceAdditionalData",
     FiscalTransactionInformation = "fiscalTransactionInformation",
     FiscalVarianceInformation = "FiscalVarianceInformation",
     FiscalDeviceErrorCode = "fiscalDeviceErrorCode",
@@ -695,6 +696,7 @@ export declare enum CollectedDataKey {
     PaymentAccountHolderMismatchAction = "paymentAccountHolderMismatchAction",
     PaymentAccountHolderValidationLineReference = "paymentAccountHolderValidationLineReference",
     PaymentAccountLookupLineReference = "paymentAccountLookupLineReference",
+    PaymentFunction = "paymentFunction",
     PaidOutReference = "paidOutReference",
     PhoneNumber = "phoneNumber",
     Percent = "percentage",
@@ -1093,7 +1095,8 @@ export declare enum PaymentFunction {
     AccountSummaryDisplay = "AccountSummaryDisplay",
     CustomerInput = "CustomerInput",
     DonationPrompt = "DonationPrompt",
-    TenderAuthorization = "TenderAuthorization"
+    TenderAuthorization = "TenderAuthorization",
+    OptInConfirmation = "OptInConfirmation"
 }
 export declare const DELIVERY_CONTACT_UPDATED_EVENT: string;
 export declare const DELIVERY_ITEM_UPDATED_EVENT: string;

package/lib/domain/model/Constants.js

@@ -582,6 +582,7 @@ var CollectedDataKey;
     CollectedDataKey["FiscalDeviceActivitySuccessful"] = "fiscalDeviceActivitySuccessful";
     CollectedDataKey["VoidedInProcessFlag"] = "voidedInProcessFlag";
     CollectedDataKey["FiscalDeviceInformation"] = "fiscalDeviceInformation";
+    CollectedDataKey["FiscalDeviceAdditionalData"] = "fiscalDeviceAdditionalData";
     CollectedDataKey["FiscalTransactionInformation"] = "fiscalTransactionInformation";
     CollectedDataKey["FiscalVarianceInformation"] = "FiscalVarianceInformation";
     CollectedDataKey["FiscalDeviceErrorCode"] = "fiscalDeviceErrorCode";
@@ -702,6 +703,7 @@ var CollectedDataKey;
     CollectedDataKey["PaymentAccountHolderMismatchAction"] = "paymentAccountHolderMismatchAction";
     CollectedDataKey["PaymentAccountHolderValidationLineReference"] = "paymentAccountHolderValidationLineReference";
     CollectedDataKey["PaymentAccountLookupLineReference"] = "paymentAccountLookupLineReference";
+    CollectedDataKey["PaymentFunction"] = "paymentFunction";
     CollectedDataKey["PaidOutReference"] = "paidOutReference";
     CollectedDataKey["PhoneNumber"] = "phoneNumber";
     CollectedDataKey["Percent"] = "percentage";
@@ -1101,6 +1103,7 @@ var PaymentFunction;
     PaymentFunction["CustomerInput"] = "CustomerInput";
     PaymentFunction["DonationPrompt"] = "DonationPrompt";
     PaymentFunction["TenderAuthorization"] = "TenderAuthorization";
+    PaymentFunction["OptInConfirmation"] = "OptInConfirmation";
 })(PaymentFunction = exports.PaymentFunction || (exports.PaymentFunction = {}));
 exports.DELIVERY_CONTACT_UPDATED_EVENT = "Delivery.ContactUpdated";
 exports.DELIVERY_ITEM_UPDATED_EVENT = "Delivery.ItemUpdated";

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

@@ -0,0 +1,23 @@
+import { IState } from "@aptos-scp/scp-component-store-selling-core";
+import { PaymentFunction } from "./Constants";
+export declare const PAYMENT_FUNCTION_SESSION: string;
+export declare enum PaymentFunctionSessionState {
+    Completed = "Completed",
+    InProgress = "InProgress"
+}
+export declare class PaymentFunctionSession implements IState {
+    private readonly _type;
+    private readonly _state;
+    private readonly _deviceId;
+    private readonly _paymentFunction;
+    static createFromJsonObject(paymentFunctionSessionJsonObj: any): PaymentFunctionSession;
+    static create(): PaymentFunctionSession;
+    get type(): string;
+    get deviceId(): string | undefined;
+    get paymentFunction(): PaymentFunction | undefined;
+    get stateValues(): Readonly<Map<string, any>>;
+    get inProgress(): boolean;
+    startPaymentFunction(paymentFunction: PaymentFunction, deviceId: string): PaymentFunctionSession;
+    complete(): PaymentFunctionSession;
+    private constructor();
+}

package/lib/domain/model/PaymentFunctionSession.js

@@ -0,0 +1,51 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PAYMENT_FUNCTION_SESSION = "PaymentFunctionSession";
+var PaymentFunctionSessionState;
+(function (PaymentFunctionSessionState) {
+    PaymentFunctionSessionState["Completed"] = "Completed";
+    PaymentFunctionSessionState["InProgress"] = "InProgress";
+})(PaymentFunctionSessionState = exports.PaymentFunctionSessionState || (exports.PaymentFunctionSessionState = {}));
+class PaymentFunctionSession {
+    constructor(state, paymentFunction, deviceId) {
+        this._type = exports.PAYMENT_FUNCTION_SESSION;
+        this._state = state;
+        this._deviceId = deviceId;
+        this._paymentFunction = paymentFunction;
+    }
+    static createFromJsonObject(paymentFunctionSessionJsonObj) {
+        const state = paymentFunctionSessionJsonObj._state;
+        const deviceId = paymentFunctionSessionJsonObj._deviceId;
+        const paymentFunction = paymentFunctionSessionJsonObj._paymentFunction;
+        return new PaymentFunctionSession(state, paymentFunction, deviceId);
+    }
+    static create() {
+        return new PaymentFunctionSession(PaymentFunctionSessionState.Completed);
+    }
+    get type() {
+        return this._type;
+    }
+    get deviceId() {
+        return this._deviceId;
+    }
+    get paymentFunction() {
+        return this._paymentFunction;
+    }
+    get stateValues() {
+        return new Map([
+            ["PaymentFunctionSession.state", this._state],
+            ["PaymentFunctionSession.paymentFunction", this._paymentFunction],
+        ]);
+    }
+    get inProgress() {
+        return this._state === PaymentFunctionSessionState.InProgress;
+    }
+    startPaymentFunction(paymentFunction, deviceId) {
+        return new PaymentFunctionSession(PaymentFunctionSessionState.InProgress, paymentFunction, deviceId);
+    }
+    complete() {
+        return new PaymentFunctionSession(PaymentFunctionSessionState.Completed);
+    }
+}
+exports.PaymentFunctionSession = PaymentFunctionSession;
+//# sourceMappingURL=PaymentFunctionSession.js.map

package/lib/domain/model/fiscalDevice/FiscalDeviceStatusLine.d.ts

@@ -2,6 +2,7 @@ import { ITransactionLine, UiBusinessEvent } from "@aptos-scp/scp-component-stor
 import { IFiscalDeviceInformation, IFiscalTransactionInformation } from "@aptos-scp/scp-types-commerce-devices";
 import { ITransactionLineReferenceType } from "@aptos-scp/scp-types-commerce-transaction";
 import { IDeviceActivityResult } from "@aptos-scp/scp-types-commerce-transaction/lib/IDeviceActivityResult";
+import { AdditionalData } from "@aptos-scp/scp-types-country-box";
 import { BaseTransactionLine } from "../BaseTransactionLine";
 export declare const FISCAL_DEVICE_STATUS_LINE_TYPE: string;
 export declare class FiscalDeviceStatusLine extends BaseTransactionLine {
@@ -12,6 +13,7 @@ export declare class FiscalDeviceStatusLine extends BaseTransactionLine {
     private _fiscalTransactionInformation?;
     private _fiscalVarianceInformation?;
     private _voidedInProcessFlag?;
+    private _fiscalDeviceAdditionalData?;
     /**
      * 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.
@@ -32,8 +34,9 @@ export declare class FiscalDeviceStatusLine extends BaseTransactionLine {
     get voidedInProcessFlag(): boolean;
     get fiscalDeviceInformation(): IFiscalDeviceInformation;
     get fiscalTransactionInformation(): IFiscalTransactionInformation;
+    get fiscalDeviceAdditionalData(): AdditionalData[];
     get fiscalVarianceInformation(): IFiscalTransactionInformation;
-    protected constructor(lineNumber: number, lineType: string, peripheralDeviceId: string, fiscalDeviceActivityResult: IDeviceActivityResult, transactionLineReference?: ITransactionLineReferenceType, fiscalDeviceInformation?: IFiscalDeviceInformation, fiscalTransactionInformation?: IFiscalTransactionInformation, fiscalVarianceInformation?: IFiscalTransactionInformation, voidedInProcessFlag?: boolean);
+    protected constructor(lineNumber: number, lineType: string, peripheralDeviceId: string, fiscalDeviceActivityResult: IDeviceActivityResult, transactionLineReference?: ITransactionLineReferenceType, fiscalDeviceInformation?: IFiscalDeviceInformation, fiscalTransactionInformation?: IFiscalTransactionInformation, fiscalVarianceInformation?: IFiscalTransactionInformation, voidedInProcessFlag?: boolean, fiscalDeviceAdditionalData?: AdditionalData[]);
     protected newTransactionLine(): BaseTransactionLine;
 }
 export declare function isFiscalDeviceStatusLine(transactionLine: ITransactionLine): transactionLine is FiscalDeviceStatusLine;

package/lib/domain/model/fiscalDevice/FiscalDeviceStatusLine.js

@@ -5,7 +5,7 @@ const Constants_1 = require("../Constants");
 exports.FISCAL_DEVICE_STATUS_LINE_TYPE = "FiscalDeviceStatus";
 class FiscalDeviceStatusLine 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, peripheralDeviceId, fiscalDeviceActivityResult, transactionLineReference, fiscalDeviceInformation, fiscalTransactionInformation, fiscalVarianceInformation, voidedInProcessFlag) {
+    constructor(lineNumber, lineType, peripheralDeviceId, fiscalDeviceActivityResult, transactionLineReference, fiscalDeviceInformation, fiscalTransactionInformation, fiscalVarianceInformation, voidedInProcessFlag, fiscalDeviceAdditionalData) {
         super(lineNumber, lineType);
         this._peripheralDeviceId = peripheralDeviceId;
         this._fiscalDeviceActivityResult = fiscalDeviceActivityResult;
@@ -14,6 +14,7 @@ class FiscalDeviceStatusLine extends BaseTransactionLine_1.BaseTransactionLine {
         this._fiscalTransactionInformation = fiscalTransactionInformation;
         this._fiscalVarianceInformation = fiscalVarianceInformation;
         this._voidedInProcessFlag = voidedInProcessFlag;
+        this._fiscalDeviceAdditionalData = fiscalDeviceAdditionalData;
     }
     /**
      * The create method is called by the transaction line factory to create an instance and initialize it from the
@@ -46,7 +47,8 @@ class FiscalDeviceStatusLine extends BaseTransactionLine_1.BaseTransactionLine {
         const fiscalTransactionInformation = collectedData.get(Constants_1.CollectedDataKey.FiscalTransactionInformation);
         const fiscalVarianceInformation = collectedData.get(Constants_1.CollectedDataKey.FiscalVarianceInformation);
         const voidedInProcessFlag = collectedData.get(Constants_1.CollectedDataKey.VoidedInProcessFlag);
-        const fiscalDeviceStatusLine = new FiscalDeviceStatusLine(lineNumber, lineType, peripheralDeviceId, fiscalDeviceActivityResult, transactionLineReference, fiscalDeviceInformation, fiscalTransactionInformation, fiscalVarianceInformation, voidedInProcessFlag);
+        const fiscalDeviceAdditionalData = collectedData.get(Constants_1.CollectedDataKey.FiscalDeviceAdditionalData);
+        const fiscalDeviceStatusLine = new FiscalDeviceStatusLine(lineNumber, lineType, peripheralDeviceId, fiscalDeviceActivityResult, transactionLineReference, fiscalDeviceInformation, fiscalTransactionInformation, fiscalVarianceInformation, voidedInProcessFlag, fiscalDeviceAdditionalData);
         return fiscalDeviceStatusLine;
     }
     static createFromJsonObject(transactionLineJsonObj) {
@@ -59,7 +61,8 @@ class FiscalDeviceStatusLine extends BaseTransactionLine_1.BaseTransactionLine {
         const fiscalTransactionInformation = transactionLineJsonObj._fiscalTransactionInformation;
         const fiscalVarianceInformation = transactionLineJsonObj._fiscalVarianceInformation;
         const voidedInProcessFlag = transactionLineJsonObj._voidedInProcessFlag;
-        const fiscalDeviceStatusLine = new FiscalDeviceStatusLine(lineNumber, lineType, peripheralDeviceId, fiscalDeviceActivityResult, transactionLineReference, fiscalDeviceInformation, fiscalTransactionInformation, fiscalVarianceInformation, voidedInProcessFlag);
+        const fiscalDeviceAdditionalData = transactionLineJsonObj._fiscalDeviceAdditionalData;
+        const fiscalDeviceStatusLine = new FiscalDeviceStatusLine(lineNumber, lineType, peripheralDeviceId, fiscalDeviceActivityResult, transactionLineReference, fiscalDeviceInformation, fiscalTransactionInformation, fiscalVarianceInformation, voidedInProcessFlag, fiscalDeviceAdditionalData);
         fiscalDeviceStatusLine.loadFromJsonObject(transactionLineJsonObj);
         return fiscalDeviceStatusLine;
     }
@@ -84,11 +87,14 @@ class FiscalDeviceStatusLine extends BaseTransactionLine_1.BaseTransactionLine {
     get fiscalTransactionInformation() {
         return this._fiscalTransactionInformation;
     }
+    get fiscalDeviceAdditionalData() {
+        return this._fiscalDeviceAdditionalData;
+    }
     get fiscalVarianceInformation() {
         return this._fiscalVarianceInformation;
     }
     newTransactionLine() {
-        return new FiscalDeviceStatusLine(this.lineNumber, this.lineType, this._peripheralDeviceId, this._fiscalDeviceActivityResult, this._transactionLineReference, this._fiscalDeviceInformation, this._fiscalTransactionInformation, this._fiscalVarianceInformation, this._voidedInProcessFlag);
+        return new FiscalDeviceStatusLine(this.lineNumber, this.lineType, this._peripheralDeviceId, this._fiscalDeviceActivityResult, this._transactionLineReference, this._fiscalDeviceInformation, this._fiscalTransactionInformation, this._fiscalVarianceInformation, this._voidedInProcessFlag, this._fiscalDeviceAdditionalData);
     }
 }
 exports.FiscalDeviceStatusLine = FiscalDeviceStatusLine;

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

@@ -110,3 +110,4 @@ export * from "./ITransactionMetadataPersistanceObject";
 export * from "./IReceipt";
 export * from "./storeGoals/";
 export * from "./IStoreItemSummary";
+export * from "./PaymentFunctionSession";

package/lib/domain/model/index.js

@@ -94,4 +94,5 @@ __export(require("./CreateEinvoiceLine"));
 __export(require("./taxRecord/"));
 __export(require("./taxLottery/"));
 __export(require("./lottery/"));
+__export(require("./PaymentFunctionSession"));
 //# sourceMappingURL=index.js.map

package/package.json

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