@aptos-scp/scp-component-store-selling-features-domain-model 2.7.2 → 2.8.0

package/lib/domain/UIBusinessEventTypes.d.ts

@@ -139,6 +139,8 @@ export declare const SHIPPING_FEE_CHANGE_EVENT = "ShippingFeeChange";
 export declare const ADD_SHIPPING_FEE_EVENT = "AddShippingFee";
 export declare const APPLY_FEE_DISCOUNT_EVENT = "ApplyFeeDiscount";
 export declare const PAYMENT_ACCOUNT_HOLDER_MISMATCH_STATUS_EVENT: string;
+export declare const CUSTOMER_INPUT_EVENT: string;
+export declare const CUSTOMER_INPUT_RESULT_EVENT: string;
 export declare const PAYMENT_ACCOUNT_HOLDER_VALIDATE_EVENT: string;
 export declare const SHIPPING_FEE_REFUND_EVENT: string;
 export declare const RETURN_ITEM_EVENT: string;

package/lib/domain/UIBusinessEventTypes.js

@@ -142,6 +142,8 @@ exports.SHIPPING_FEE_CHANGE_EVENT = "ShippingFeeChange";
 exports.ADD_SHIPPING_FEE_EVENT = "AddShippingFee";
 exports.APPLY_FEE_DISCOUNT_EVENT = "ApplyFeeDiscount";
 exports.PAYMENT_ACCOUNT_HOLDER_MISMATCH_STATUS_EVENT = "PaymentAccountHolderMismatchStatus";
+exports.CUSTOMER_INPUT_EVENT = "CustomerInput";
+exports.CUSTOMER_INPUT_RESULT_EVENT = "CustomerInputResult";
 exports.PAYMENT_ACCOUNT_HOLDER_VALIDATE_EVENT = "PaymentAccountHolderValidate";
 exports.SHIPPING_FEE_REFUND_EVENT = "ShippingFeeRefund";
 exports.RETURN_ITEM_EVENT = "ReturnItem";

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

@@ -1,5 +1,6 @@
 import { Quantity } from "@aptos-scp/scp-component-business-core";
-import { EntryMethod } from "@aptos-scp/scp-types-commerce-devices";
+import { EntryMethod, ICustomerInputScreen } from "@aptos-scp/scp-types-commerce-devices";
+import { ICustomerInputSource } from "@aptos-scp/scp-types-commerce-transaction";
 export interface ILabel {
     i18nCode?: string;
     default?: string;
@@ -125,6 +126,7 @@ export declare enum UiInputKey {
     DONATION_AMOUNT = "input_donationAmount",
     DONATION_CODE = "input_donationCode",
     DONATION_AMOUNT_TYPE = "input_donationAmountType",
+    CUSTOMER_INPUT_RESPONSE = "input_customerInputResponse",
     EXCHANGE_RATE = "input_exchangeRate",
     EMPLOYEE_DISCOUNT_EVENT = "input_discountEvent",
     EMPLOYEE_SERVICE_RESPONSE = "input_employeeServiceResponse",
@@ -220,6 +222,7 @@ export declare enum UiInputKey {
     ORIGINAL_TRANSACTION_LINE_REFERENCES = "input_originalTransactionLineReferences",
     PAYMENT_ACCOUNT_HOLDER_MISMATCH_ACTION = "input_paymentAccountHolderMismatchAction",
     PAYMENT_ACCOUNT_HOLDER_VALIDATE = "input_paymentAccountHolderValidate",
+    CUSTOMER_INPUT_DEVICE_ID = "input_customerInputDeviceId",
     PAID_AMOUNT = "input_paidAmount",
     PAID_OUT_REFERENCE = "input_paidOutReference",
     ATTACHMENTS = "input_attachments",
@@ -449,7 +452,8 @@ export declare enum UiInputKey {
     TENDER_KEYED_ENTRY = "input_tenderKeyedEntry",
     PAY_BY_LINK_CUSTOMER = "input_payByLinkCustomer",
     FISCAL_RETRY = "input_fiscalRetry",
-    MAX_FISCAL_RETRY = "input_maxFiscalRetry"
+    MAX_FISCAL_RETRY = "input_maxFiscalRetry",
+    CUSTOMER_INPUT_SCREENS = "input_customerInputScreens"
 }
 export declare enum CollectedDataKey {
     Abort = "abort",
@@ -511,6 +515,8 @@ export declare enum CollectedDataKey {
     DonationName = "donationName",
     DonationExternalId = "donationExternalId",
     DuplicateFlag = "duplicateFlag",
+    CustomerInputResponse = "customerInputResponse",
+    CustomerInputSourceType = "customerInputSourceType",
     EmailAddress = "emailAddress",
     EmployeeCustomer = "employeeCustomer",
     EmployeeCustomerDiscountDefinitionKey = "employeeCustomerDiscountDefinitionKey",
@@ -666,6 +672,7 @@ export declare enum CollectedDataKey {
     TenderPaymentIsCompleted = "tenderPaymentIsCompleted",
     PaginationMetadata = "paginationMetadata",
     PaidAmount = "PaidAmount",
+    CustomerInputDeviceId = "customerInputDeviceId",
     PaymentAccountHolderMismatchAction = "paymentAccountHolderMismatchAction",
     PaymentAccountHolderValidationLineReference = "paymentAccountHolderValidationLineReference",
     PaymentAccountLookupLineReference = "paymentAccountLookupLineReference",
@@ -959,7 +966,8 @@ export declare enum CollectedDataKey {
     MembershipTypeDescription = "membershipTypeDescription",
     IsPermanentMembershipDiscount = "isPermanentMembershipDiscount",
     TerminalForceClosed = "TerminalForceClosed",
-    TotalLineTax = "totalLineTax"
+    TotalLineTax = "totalLineTax",
+    CustomerInputScreens = "customerInputScreens"
 }
 export declare enum ItemLookupType {
     ProductInquiryDetail = "ProductInquiryDetail",
@@ -1069,3 +1077,8 @@ export interface ICancelPaymentFunctionData {
     reason?: string;
 }
 export declare const DELIVERY_SHIPPING_FEE_UPDATED_EVENT: string;
+export declare const CUSTOMER_INPUT_REQUESTED_EVENT: string;
+export interface ICustomerInputRequestedEventData {
+    customerInputSource: ICustomerInputSource;
+    screens: ICustomerInputScreen[];
+}

package/lib/domain/model/Constants.js

@@ -127,6 +127,7 @@ var UiInputKey;
     UiInputKey["DONATION_AMOUNT"] = "input_donationAmount";
     UiInputKey["DONATION_CODE"] = "input_donationCode";
     UiInputKey["DONATION_AMOUNT_TYPE"] = "input_donationAmountType";
+    UiInputKey["CUSTOMER_INPUT_RESPONSE"] = "input_customerInputResponse";
     UiInputKey["EXCHANGE_RATE"] = "input_exchangeRate";
     UiInputKey["EMPLOYEE_DISCOUNT_EVENT"] = "input_discountEvent";
     UiInputKey["EMPLOYEE_SERVICE_RESPONSE"] = "input_employeeServiceResponse";
@@ -222,6 +223,7 @@ var UiInputKey;
     UiInputKey["ORIGINAL_TRANSACTION_LINE_REFERENCES"] = "input_originalTransactionLineReferences";
     UiInputKey["PAYMENT_ACCOUNT_HOLDER_MISMATCH_ACTION"] = "input_paymentAccountHolderMismatchAction";
     UiInputKey["PAYMENT_ACCOUNT_HOLDER_VALIDATE"] = "input_paymentAccountHolderValidate";
+    UiInputKey["CUSTOMER_INPUT_DEVICE_ID"] = "input_customerInputDeviceId";
     UiInputKey["PAID_AMOUNT"] = "input_paidAmount";
     UiInputKey["PAID_OUT_REFERENCE"] = "input_paidOutReference";
     UiInputKey["ATTACHMENTS"] = "input_attachments";
@@ -452,6 +454,7 @@ var UiInputKey;
     UiInputKey["PAY_BY_LINK_CUSTOMER"] = "input_payByLinkCustomer";
     UiInputKey["FISCAL_RETRY"] = "input_fiscalRetry";
     UiInputKey["MAX_FISCAL_RETRY"] = "input_maxFiscalRetry";
+    UiInputKey["CUSTOMER_INPUT_SCREENS"] = "input_customerInputScreens";
 })(UiInputKey = exports.UiInputKey || (exports.UiInputKey = {}));
 //
 // Keys for use in relaying data collectedData (qualification) and nonContextualData (action).
@@ -519,6 +522,8 @@ var CollectedDataKey;
     CollectedDataKey["DonationName"] = "donationName";
     CollectedDataKey["DonationExternalId"] = "donationExternalId";
     CollectedDataKey["DuplicateFlag"] = "duplicateFlag";
+    CollectedDataKey["CustomerInputResponse"] = "customerInputResponse";
+    CollectedDataKey["CustomerInputSourceType"] = "customerInputSourceType";
     CollectedDataKey["EmailAddress"] = "emailAddress";
     CollectedDataKey["EmployeeCustomer"] = "employeeCustomer";
     CollectedDataKey["EmployeeCustomerDiscountDefinitionKey"] = "employeeCustomerDiscountDefinitionKey";
@@ -674,6 +679,7 @@ var CollectedDataKey;
     CollectedDataKey["TenderPaymentIsCompleted"] = "tenderPaymentIsCompleted";
     CollectedDataKey["PaginationMetadata"] = "paginationMetadata";
     CollectedDataKey["PaidAmount"] = "PaidAmount";
+    CollectedDataKey["CustomerInputDeviceId"] = "customerInputDeviceId";
     CollectedDataKey["PaymentAccountHolderMismatchAction"] = "paymentAccountHolderMismatchAction";
     CollectedDataKey["PaymentAccountHolderValidationLineReference"] = "paymentAccountHolderValidationLineReference";
     CollectedDataKey["PaymentAccountLookupLineReference"] = "paymentAccountLookupLineReference";
@@ -968,6 +974,7 @@ var CollectedDataKey;
     CollectedDataKey["IsPermanentMembershipDiscount"] = "isPermanentMembershipDiscount";
     CollectedDataKey["TerminalForceClosed"] = "TerminalForceClosed";
     CollectedDataKey["TotalLineTax"] = "totalLineTax";
+    CollectedDataKey["CustomerInputScreens"] = "customerInputScreens";
 })(CollectedDataKey = exports.CollectedDataKey || (exports.CollectedDataKey = {}));
 var ItemLookupType;
 (function (ItemLookupType) {
@@ -1067,4 +1074,5 @@ exports.DELIVERY_CONTACT_UPDATED_EVENT = "Delivery.ContactUpdated";
 exports.PAYMENT_ACCOUNT_LOOKUP_EVENT = "PaymentAccount.Lookup";
 exports.CANCEL_PAYMENT_FUNCTION_EVENT = "Cancel.PaymentFunction";
 exports.DELIVERY_SHIPPING_FEE_UPDATED_EVENT = "Delivery.ShippingFeeUpdated";
+exports.CUSTOMER_INPUT_REQUESTED_EVENT = "CustomerInput.Requested";
 //# sourceMappingURL=Constants.js.map

package/lib/domain/model/configuration/IDonationBehaviorsConfig.d.ts

@@ -5,5 +5,7 @@ export interface IDonationDefinitions {
 export interface IDonationDefinition {
     readonly donationName: ILabel;
     readonly donationImage: string;
+    readonly donationPromptTextLine1?: ILabel;
+    readonly donationPromptTextLine2?: ILabel;
     readonly externalId?: string;
 }

package/lib/domain/model/configuration/IFeatureAccessConfig.d.ts

@@ -117,6 +117,10 @@ export interface IDonationButton {
     donationAmountType: DonationAmountType;
     donationAmount: string;
 }
+export declare enum CaptureDevice {
+    PaymentDevice = "PaymentDevice",
+    StoreSellingDevice = "StoreSellingDevice"
+}
 export declare type DiscountLimits = {
     [key in InputLimitsAllowedDiscountTypes]?: IInputLimit;
 };

package/lib/domain/model/configuration/IFeatureAccessConfig.js

@@ -27,6 +27,11 @@ var AllowedOverrideTypes;
     AllowedOverrideTypes["amount"] = "amount";
     AllowedOverrideTypes["percent"] = "percent";
 })(AllowedOverrideTypes = exports.AllowedOverrideTypes || (exports.AllowedOverrideTypes = {}));
+var CaptureDevice;
+(function (CaptureDevice) {
+    CaptureDevice["PaymentDevice"] = "PaymentDevice";
+    CaptureDevice["StoreSellingDevice"] = "StoreSellingDevice";
+})(CaptureDevice = exports.CaptureDevice || (exports.CaptureDevice = {}));
 var InputLimitsAllowedDiscountTypes;
 (function (InputLimitsAllowedDiscountTypes) {
     InputLimitsAllowedDiscountTypes["reasonCode"] = "reasonCode";

package/lib/domain/model/customerInput/CustomerInputLine.d.ts

@@ -0,0 +1,20 @@
+import { ITransactionLine, UiBusinessEvent } from "@aptos-scp/scp-component-store-selling-core";
+import { ICustomerInputStatus, IDonationCustomerInputData } from "@aptos-scp/scp-types-commerce-devices";
+import { ICustomerInputSource } from "@aptos-scp/scp-types-commerce-transaction";
+import { BaseTransactionLine } from "../BaseTransactionLine";
+import { ICustomerInputLine } from "./ICustomerInputLine";
+export declare const CUSTOMER_INPUT_LINE_TYPE: string;
+export declare class CustomerInputLine extends BaseTransactionLine implements ICustomerInputLine {
+    private readonly _customerInputSource;
+    private readonly _status;
+    private readonly _donationCustomerInputData;
+    static create(lineNumber: number, lineType: string, uiBusinessEvent: UiBusinessEvent, collectedData: Readonly<Map<string, any>>): CustomerInputLine;
+    static createFromJsonObject(transactionLineJsonObj: any): CustomerInputLine;
+    get couldAffectPricing(): boolean;
+    get customerInputSource(): ICustomerInputSource;
+    get status(): ICustomerInputStatus;
+    get donationCustomerInputData(): IDonationCustomerInputData;
+    constructor(lineNumber: number, lineType: string, customerInputSource: ICustomerInputSource, status: ICustomerInputStatus, donationCustomerInputData: IDonationCustomerInputData);
+    protected newTransactionLine(): CustomerInputLine;
+}
+export declare function isCustomerInputLine(transactionLine: ITransactionLine): transactionLine is CustomerInputLine;

package/lib/domain/model/customerInput/CustomerInputLine.js

@@ -0,0 +1,55 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const BaseTransactionLine_1 = require("../BaseTransactionLine");
+const Constants_1 = require("../Constants");
+exports.CUSTOMER_INPUT_LINE_TYPE = "CustomerInput";
+class CustomerInputLine extends BaseTransactionLine_1.BaseTransactionLine {
+    constructor(lineNumber, lineType, customerInputSource, status, donationCustomerInputData) {
+        super(lineNumber, lineType);
+        this._customerInputSource = customerInputSource;
+        this._status = status;
+        this._donationCustomerInputData = donationCustomerInputData;
+    }
+    static create(lineNumber, lineType, uiBusinessEvent, collectedData) {
+        var _a, _b;
+        const response = collectedData.get(Constants_1.CollectedDataKey.CustomerInputResponse);
+        const deviceId = collectedData.get(Constants_1.CollectedDataKey.CustomerInputDeviceId);
+        const customerInputSourceType = collectedData.get(Constants_1.CollectedDataKey.CustomerInputSourceType);
+        const customerInputSource = {
+            deviceid: deviceId,
+            sourceType: customerInputSourceType,
+        };
+        const status = (_a = response) === null || _a === void 0 ? void 0 : _a.status;
+        const donationCustomerInputData = (_b = response) === null || _b === void 0 ? void 0 : _b.donationCustomerInputData;
+        return new CustomerInputLine(lineNumber, lineType, customerInputSource, status, donationCustomerInputData);
+    }
+    static createFromJsonObject(transactionLineJsonObj) {
+        const lineNumber = BaseTransactionLine_1.BaseTransactionLine.lineNumberFromJsonObject(transactionLineJsonObj);
+        const lineType = BaseTransactionLine_1.BaseTransactionLine.lineTypeFromJsonObject(transactionLineJsonObj);
+        const status = transactionLineJsonObj._status;
+        const customerInputSource = transactionLineJsonObj._customerInputSource;
+        const donationCustomerInputData = transactionLineJsonObj._donationCustomerInputData;
+        return new CustomerInputLine(lineNumber, lineType, customerInputSource, status, donationCustomerInputData);
+    }
+    get couldAffectPricing() {
+        return false;
+    }
+    get customerInputSource() {
+        return this._customerInputSource;
+    }
+    get status() {
+        return this._status;
+    }
+    get donationCustomerInputData() {
+        return this._donationCustomerInputData;
+    }
+    newTransactionLine() {
+        return new CustomerInputLine(this.lineNumber, this.lineType, this._customerInputSource, this._status, this._donationCustomerInputData);
+    }
+}
+exports.CustomerInputLine = CustomerInputLine;
+function isCustomerInputLine(transactionLine) {
+    return (transactionLine instanceof CustomerInputLine || transactionLine.lineType === exports.CUSTOMER_INPUT_LINE_TYPE);
+}
+exports.isCustomerInputLine = isCustomerInputLine;
+//# sourceMappingURL=CustomerInputLine.js.map

package/lib/domain/model/customerInput/ICustomerInputLine.d.ts

@@ -0,0 +1,8 @@
+import { ITransactionLine } from "@aptos-scp/scp-component-store-selling-core";
+import { ICustomerInputStatus, IDonationCustomerInputData } from "@aptos-scp/scp-types-commerce-devices";
+import { ICustomerInputSource } from "@aptos-scp/scp-types-commerce-transaction";
+export interface ICustomerInputLine extends ITransactionLine {
+    readonly customerInputSource: ICustomerInputSource;
+    readonly status: ICustomerInputStatus;
+    readonly donationCustomerInputData: IDonationCustomerInputData;
+}

package/lib/domain/model/customerInput/ICustomerInputLine.js

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

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

@@ -0,0 +1,2 @@
+export * from "./ICustomerInputLine";
+export * from "./CustomerInputLine";

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

@@ -0,0 +1,7 @@
+"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("./CustomerInputLine"));
+//# sourceMappingURL=index.js.map

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

@@ -2,6 +2,7 @@ export * from "./account";
 export * from "./cashDrawer";
 export * from "./configuration/";
 export * from "./customer/";
+export * from "./customerInput";
 export * from "./discounts/";
 export * from "./giftCard/";
 export * from "./item/";

package/lib/domain/model/index.js

@@ -7,6 +7,7 @@ __export(require("./account"));
 __export(require("./cashDrawer"));
 __export(require("./configuration/"));
 __export(require("./customer/"));
+__export(require("./customerInput"));
 __export(require("./discounts/"));
 __export(require("./giftCard/"));
 __export(require("./item/"));

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aptos-scp/scp-component-store-selling-features-domain-model",
-  "version": "2.7.2",
+  "version": "2.8.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",
@@ -83,8 +83,8 @@
     "@aptos-scp/scp-component-taxation": "^5.28.0",
     "@aptos-scp/scp-component-user": "^1.4.0",
     "@aptos-scp/scp-types-client-registration": "^1.4.0",
-    "@aptos-scp/scp-types-commerce-devices": "^6.0.0",
-    "@aptos-scp/scp-types-commerce-transaction": "^1.78.0",
+    "@aptos-scp/scp-types-commerce-devices": "^6.2.0",
+    "@aptos-scp/scp-types-commerce-transaction": "^1.79.0",
     "@aptos-scp/scp-types-core": "^1.0.5",
     "@aptos-scp/scp-types-core-config": "^2.2.1",
     "@aptos-scp/scp-types-currency-conversion": "^1.2.0",