@aptos-scp/scp-component-store-selling-features-domain-model 2.24.0-patch.2 → 2.24.0-patch.7

package/README.md

@@ -9,6 +9,7 @@ Examine the variables and edit as necessary/appropriate for your workstation env
 cp .env.example .env
 ```
 
+
 ## Installation
 
 First, make sure you are logged-in to the private NPM registry:

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

@@ -703,6 +703,7 @@ export declare enum CollectedDataKey {
     PaymentAccountHolderMismatchAction = "paymentAccountHolderMismatchAction",
     PaymentAccountHolderValidationLineReference = "paymentAccountHolderValidationLineReference",
     PaymentAccountLookupLineReference = "paymentAccountLookupLineReference",
+    PaymentFunction = "paymentFunction",
     PaidOutReference = "paidOutReference",
     PhoneNumber = "phoneNumber",
     Percent = "percentage",
@@ -1101,7 +1102,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

@@ -710,6 +710,7 @@ var CollectedDataKey;
     CollectedDataKey["PaymentAccountHolderMismatchAction"] = "paymentAccountHolderMismatchAction";
     CollectedDataKey["PaymentAccountHolderValidationLineReference"] = "paymentAccountHolderValidationLineReference";
     CollectedDataKey["PaymentAccountLookupLineReference"] = "paymentAccountLookupLineReference";
+    CollectedDataKey["PaymentFunction"] = "paymentFunction";
     CollectedDataKey["PaidOutReference"] = "paidOutReference";
     CollectedDataKey["PhoneNumber"] = "phoneNumber";
     CollectedDataKey["Percent"] = "percentage";
@@ -1109,6 +1110,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/TenderType.d.ts

@@ -95,6 +95,7 @@ export declare class TenderType {
     private _eligibleForTaxLottery?;
     private _cashoutThreshold?;
     static getActiveConfiguredTenders(container: Container, accountingCurrency: string): TenderType[];
+    static getAllConfiguredTenders(container: Container, accountingCurrency: string): TenderType[];
     static getActiveRefundConfiguredTenders(container: Container, accountingCurrency: string, withTransaction: boolean, withOfflineTransaction: boolean): TenderType[];
     static getActiveSuggestedRefundTenders(container: Container, accountingCurrency: string, withMappedTender?: boolean): TenderType[];
     static getActiveConfiguredTenderGroups(container: Container, accountingCurrency: string, activeTenders: TenderType[]): ITenderGroup[];
@@ -152,6 +153,7 @@ export declare class TenderType {
     get subscriptionEntryMethods(): EntryMethod[];
     get cashoutThreshold(): Money;
     private static getActiveTenders;
+    private static mapTenderDefinitionToTenderType;
     private static filterActiveTenderIds;
     private static tenderAuthCategoryIsActive;
     private static tenderTypeIsActive;

package/lib/domain/model/TenderType.js

@@ -72,6 +72,13 @@ class TenderType {
     static getActiveConfiguredTenders(container, accountingCurrency) {
         return TenderType.getActiveTenders(container, accountingCurrency, false, false, false, false);
     }
+    static getAllConfiguredTenders(container, accountingCurrency) {
+        const configurationManager = container.get(scp_component_store_selling_core_1.DI_TYPES.IConfigurationManager);
+        const configuredTenders = configurationManager.getTendersValues().tenderDefinitions;
+        return configuredTenders
+            .filter((configuredTender) => configuredTender != null)
+            .map((configuredTender) => TenderType.mapTenderDefinitionToTenderType(configuredTender, accountingCurrency));
+    }
     static getActiveRefundConfiguredTenders(container, accountingCurrency, withTransaction, withOfflineTransaction) {
         return TenderType.getActiveTenders(container, accountingCurrency, true, withTransaction, false, false, withOfflineTransaction);
     }
@@ -519,12 +526,15 @@ class TenderType {
         const configuredTenders = configurationManager.getTendersValues().tenderDefinitions;
         const activeTenders = configuredTenders
             .filter((configuredTender) => tenderIsActive(configuredTender, isRefund, withTransaction, withReference, withMappedTender, withOfflineTransaction, accountingCurrency))
-            .map((configuredTender) => new TenderType(configuredTender.tenderId, configuredTender.tenderName, configuredTender.tenderType, Constants_1.TenderAuthCategory[configuredTender.tenderAuthCategory], configuredTender.additionalTenderAuthCategories, scp_types_commerce_devices_1.CardType[configuredTender.cardType], TenderSignatureCapturePolicy[configuredTender.signatureCapturePolicy], configuredTender.hasOwnProperty("signatureCaptureFloorLimit")
+            .map((configuredTender) => TenderType.mapTenderDefinitionToTenderType(configuredTender, accountingCurrency));
+        return activeTenders;
+    }
+    static mapTenderDefinitionToTenderType(configuredTender, accountingCurrency) {
+        return new TenderType(configuredTender.tenderId, configuredTender.tenderName, configuredTender.tenderType, Constants_1.TenderAuthCategory[configuredTender.tenderAuthCategory], configuredTender.additionalTenderAuthCategories, scp_types_commerce_devices_1.CardType[configuredTender.cardType], TenderSignatureCapturePolicy[configuredTender.signatureCapturePolicy], configuredTender.hasOwnProperty("signatureCaptureFloorLimit")
             ? new scp_component_business_core_1.Money(configuredTender.signatureCaptureFloorLimit, accountingCurrency)
             : undefined, configuredTender.printDeclineTenderDetails, configuredTender.printDeclineTenderReceipt, configuredTender.printStoreTenderReceipt, configuredTender.allowPostVoid, configuredTender.allowCallForAuthorization !== false, configuredTender.allowRefund, configuredTender.pluralTenderName, configuredTender.fiscalCode, configuredTender.fiscalType, configuredTender.tenderLabel, configuredTender.actions, configuredTender.overTenderRule && Constants_1.OverTenderRule[configuredTender.overTenderRule], configuredTender.subType, configuredTender.customCardType, configuredTender.promptOnPartialApproval, configuredTender.pinRules, configuredTender.subscriptionEntryMethods, configuredTender.changeBehavior, configuredTender.isForeignTender, configuredTender.currencyCode, configuredTender.eligibleForTaxLottery, configuredTender.printVoidTenderDetails, configuredTender.printVoidTenderReceipt, configuredTender.hasOwnProperty("cashoutThreshold")
             ? new scp_component_business_core_1.Money(configuredTender.cashoutThreshold, accountingCurrency)
-            : undefined, TenderSignatureCapturePolicy[configuredTender.signatureCapturePolicyForCallForAuth]));
-        return activeTenders;
+            : undefined, TenderSignatureCapturePolicy[configuredTender.signatureCapturePolicyForCallForAuth]);
     }
     static filterActiveTenderIds(tenderIds, configuredTenders, isRefund, withTransaction, withOfflineTransaction, accountingCurrency) {
         return (tenderIds &&

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

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

package/lib/domain/model/index.js

@@ -95,4 +95,5 @@ __export(require("./taxRecord/"));
 __export(require("./taxLottery/"));
 __export(require("./lottery/"));
 __export(require("./OrderHandlingSession"));
+__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-patch.2",
+  "version": "2.24.0-patch.7",
   "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",