@aptos-scp/scp-component-store-selling-features-domain-model 1.54.0 → 1.55.0

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

@@ -1,4 +1,5 @@
 import { Quantity } from "@aptos-scp/scp-component-business-core";
+import { EntryMethod } from "@aptos-scp/scp-types-commerce-devices";
 export interface ILabel {
     i18nCode?: string;
     default?: string;
@@ -130,6 +131,7 @@ export declare enum UiInputKey {
     EMPLOYEE_DISCOUNT_OVERRIDE = "input_employeeDiscountOverride",
     EXCHANGE_RATE_VALUE = "input_exchangeRateValue",
     EMPLOYEE_ID = "input_employeeId",
+    ENTRY_METHOD = "input_entryMethod",
     EXEMPTED_TAX_AUTHORITIES = "input_exemptedTaxAuthorities",
     EXISTING_GIFT_CARD = "input_existingGiftCard",
     EXPIRED_COUPON_OVERRIDE = "input_expiredCouponOverride",
@@ -1048,6 +1050,7 @@ export declare enum AssignCustomerForReturnAction {
 export declare const DELIVERY_CONTACT_UPDATED_EVENT: string;
 export declare const PAYMENT_ACCOUNT_LOOKUP_EVENT: string;
 export interface IPaymentAccountLookupEventData {
-    deviceIds: string[];
+    deviceId: string;
+    entryMethod?: EntryMethod;
 }
 export declare const DELIVERY_SHIPPING_FEE_UPDATED_EVENT: string;

package/lib/domain/model/Constants.js

@@ -133,6 +133,7 @@ var UiInputKey;
     UiInputKey["EMPLOYEE_DISCOUNT_OVERRIDE"] = "input_employeeDiscountOverride";
     UiInputKey["EXCHANGE_RATE_VALUE"] = "input_exchangeRateValue";
     UiInputKey["EMPLOYEE_ID"] = "input_employeeId";
+    UiInputKey["ENTRY_METHOD"] = "input_entryMethod";
     UiInputKey["EXEMPTED_TAX_AUTHORITIES"] = "input_exemptedTaxAuthorities";
     UiInputKey["EXISTING_GIFT_CARD"] = "input_existingGiftCard";
     UiInputKey["EXPIRED_COUPON_OVERRIDE"] = "input_expiredCouponOverride";

package/lib/domain/model/account/IPaymentAccountLookupLine.d.ts

@@ -1,3 +1,4 @@
+import { IMoney } from "@aptos-scp/scp-component-business-core";
 import { ITransactionLine } from "@aptos-scp/scp-component-store-selling-core";
 import { ICardHolder } from "@aptos-scp/scp-types-commerce-devices";
 import { PaymentAccountLookupResult } from "@aptos-scp/scp-types-commerce-transaction";
@@ -9,4 +10,5 @@ export interface IPaymentAccountLookupLine extends ITransactionLine {
     readonly cardToken?: string;
     readonly referenceNumber?: string;
     readonly authorizationDeviceId?: string;
+    readonly accountBalance?: IMoney;
 }

package/lib/domain/model/account/PaymentAccountLookupLine.d.ts

@@ -3,6 +3,7 @@ import { PaymentAccountLookupResult } from "@aptos-scp/scp-types-commerce-transa
 import { ICardHolder, ResponseCodes } from "@aptos-scp/scp-types-commerce-devices";
 import { BaseTransactionLine } from "../BaseTransactionLine";
 import { IPaymentAccountLookupLine } from "./IPaymentAccountLookupLine";
+import { IMoney } from "@aptos-scp/scp-component-business-core";
 export declare const PAYMENT_ACCOUNT_LOOKUP_LINE_TYPE: string;
 export declare class PaymentAccountLookupLine extends BaseTransactionLine implements IPaymentAccountLookupLine {
     private readonly _cardHolder;
@@ -12,6 +13,7 @@ export declare class PaymentAccountLookupLine extends BaseTransactionLine implem
     private readonly _cardToken?;
     private readonly _referenceNumber?;
     private readonly _authorizationDeviceId?;
+    private readonly _accountBalance?;
     static create(lineNumber: number, lineType: string, uiBusinessEvent: UiBusinessEvent, collectedData: Readonly<Map<string, any>>): PaymentAccountLookupLine;
     static createFromJsonObject(transactionLineJsonObj: any): PaymentAccountLookupLine;
     get couldAffectPricing(): boolean;
@@ -22,8 +24,9 @@ export declare class PaymentAccountLookupLine extends BaseTransactionLine implem
     get cardToken(): string;
     get referenceNumber(): string;
     get authorizationDeviceId(): string;
-    protected constructor(lineNumber: number, lineType: string, cardHolder: ICardHolder, lookupResult?: PaymentAccountLookupResult, lookupResultReason?: string, accountNumber?: string, cardToken?: string, referenceNumber?: string, authorizationDeviceId?: string);
+    get accountBalance(): IMoney;
+    protected constructor(lineNumber: number, lineType: string, cardHolder: ICardHolder, lookupResult?: PaymentAccountLookupResult, lookupResultReason?: string, accountNumber?: string, cardToken?: string, referenceNumber?: string, authorizationDeviceId?: string, accountBalance?: IMoney);
     protected newTransactionLine(): PaymentAccountLookupLine;
 }
-export declare function isAccountLookupLine(transactionLine: ITransactionLine): transactionLine is PaymentAccountLookupLine;
+export declare function isPaymentAccountLookupLine(transactionLine: ITransactionLine): transactionLine is PaymentAccountLookupLine;
 export declare function convertLookupResultToResponseCode(lookupResult: PaymentAccountLookupResult): ResponseCodes;

package/lib/domain/model/account/PaymentAccountLookupLine.js

@@ -6,7 +6,7 @@ const BaseTransactionLine_1 = require("../BaseTransactionLine");
 const Constants_1 = require("../Constants");
 exports.PAYMENT_ACCOUNT_LOOKUP_LINE_TYPE = "PaymentAccountLookup";
 class PaymentAccountLookupLine extends BaseTransactionLine_1.BaseTransactionLine {
-    constructor(lineNumber, lineType, cardHolder, lookupResult, lookupResultReason, accountNumber, cardToken, referenceNumber, authorizationDeviceId) {
+    constructor(lineNumber, lineType, cardHolder, lookupResult, lookupResultReason, accountNumber, cardToken, referenceNumber, authorizationDeviceId, accountBalance) {
         super(lineNumber, lineType);
         this._cardHolder = cardHolder;
         this._lookupResult = lookupResult;
@@ -15,9 +15,10 @@ class PaymentAccountLookupLine extends BaseTransactionLine_1.BaseTransactionLine
         this._cardToken = cardToken;
         this._referenceNumber = referenceNumber;
         this._authorizationDeviceId = authorizationDeviceId;
+        this._accountBalance = accountBalance;
     }
     static create(lineNumber, lineType, uiBusinessEvent, collectedData) {
-        var _a, _b, _c, _d, _e, _f;
+        var _a, _b, _c, _d, _e, _f, _g;
         const accountLookupResponse = collectedData.get(Constants_1.CollectedDataKey.TenderAuthResponse);
         const lookupResult = convertResponseCodeToLookupResult((_a = accountLookupResponse) === null || _a === void 0 ? void 0 : _a.responseCode);
         const lookupResultReason = (_b = accountLookupResponse) === null || _b === void 0 ? void 0 : _b.status;
@@ -25,8 +26,9 @@ class PaymentAccountLookupLine extends BaseTransactionLine_1.BaseTransactionLine
         const accountNumber = (_d = accountLookupResponse) === null || _d === void 0 ? void 0 : _d.cardNumber;
         const cardToken = (_e = accountLookupResponse) === null || _e === void 0 ? void 0 : _e.cardToken;
         const referenceNumber = (_f = accountLookupResponse) === null || _f === void 0 ? void 0 : _f.referenceNumber;
+        const accountBalance = (_g = accountLookupResponse) === null || _g === void 0 ? void 0 : _g.balance;
         const authorizationDeviceId = collectedData.get(Constants_1.CollectedDataKey.AuthorizationDeviceId);
-        return new PaymentAccountLookupLine(lineNumber, lineType, cardHolder, lookupResult, lookupResultReason, accountNumber, cardToken, referenceNumber, authorizationDeviceId);
+        return new PaymentAccountLookupLine(lineNumber, lineType, cardHolder, lookupResult, lookupResultReason, accountNumber, cardToken, referenceNumber, authorizationDeviceId, accountBalance);
     }
     static createFromJsonObject(transactionLineJsonObj) {
         const lineNumber = BaseTransactionLine_1.BaseTransactionLine.lineNumberFromJsonObject(transactionLineJsonObj);
@@ -38,7 +40,8 @@ class PaymentAccountLookupLine extends BaseTransactionLine_1.BaseTransactionLine
         const cardToken = transactionLineJsonObj._cardToken;
         const referenceNumber = transactionLineJsonObj._referenceNumber;
         const authorizationDeviceId = transactionLineJsonObj._authorizationDeviceId;
-        const accountLookupLine = new PaymentAccountLookupLine(lineNumber, lineType, cardHolder, lookupResult, lookupResultReason, accountNumber, cardToken, referenceNumber, authorizationDeviceId);
+        const accountBalance = transactionLineJsonObj._accountBalance;
+        const accountLookupLine = new PaymentAccountLookupLine(lineNumber, lineType, cardHolder, lookupResult, lookupResultReason, accountNumber, cardToken, referenceNumber, authorizationDeviceId, accountBalance);
         accountLookupLine.loadFromJsonObject(transactionLineJsonObj);
         return accountLookupLine;
     }
@@ -66,16 +69,20 @@ class PaymentAccountLookupLine extends BaseTransactionLine_1.BaseTransactionLine
     get authorizationDeviceId() {
         return this._authorizationDeviceId;
     }
+    get accountBalance() {
+        return this._accountBalance;
+    }
     newTransactionLine() {
-        return new PaymentAccountLookupLine(this.lineNumber, this.lineType, this._cardHolder, this._lookupResult, this._lookupResultReason, this._accountNumber, this._cardToken, this._referenceNumber, this._authorizationDeviceId);
+        return new PaymentAccountLookupLine(this.lineNumber, this.lineType, this._cardHolder, this._lookupResult, this._lookupResultReason, this._accountNumber, this._cardToken, this._referenceNumber, this._authorizationDeviceId, this._accountBalance);
     }
 }
 exports.PaymentAccountLookupLine = PaymentAccountLookupLine;
-function isAccountLookupLine(transactionLine) {
-    return (transactionLine instanceof PaymentAccountLookupLine ||
-        transactionLine.lineType === exports.PAYMENT_ACCOUNT_LOOKUP_LINE_TYPE);
+function isPaymentAccountLookupLine(transactionLine) {
+    return (transactionLine &&
+        (transactionLine instanceof PaymentAccountLookupLine ||
+            transactionLine.lineType === exports.PAYMENT_ACCOUNT_LOOKUP_LINE_TYPE));
 }
-exports.isAccountLookupLine = isAccountLookupLine;
+exports.isPaymentAccountLookupLine = isPaymentAccountLookupLine;
 function convertResponseCodeToLookupResult(responseCode) {
     switch (responseCode) {
         case scp_types_commerce_devices_1.ResponseCodes.Approved:

package/lib/domain/model/account/PaymentAccountSession.d.ts

@@ -0,0 +1,21 @@
+import { IState } from "@aptos-scp/scp-component-store-selling-core";
+export declare const PAYMENT_ACCOUNT_SESSION: string;
+export declare enum PaymentAccountSessionState {
+    Completed = "Completed",
+    LookupInProgress = "LookupInProgress"
+}
+export declare class PaymentAccountSession implements IState {
+    private readonly _type;
+    private readonly _state;
+    private readonly _deviceId;
+    static createFromJsonObject(paymentAccountSessionJsonObj: any): PaymentAccountSession;
+    static create(): PaymentAccountSession;
+    get type(): string;
+    get deviceId(): string | undefined;
+    get stateValues(): Readonly<Map<string, any>>;
+    complete(): PaymentAccountSession;
+    get inProgress(): boolean;
+    get inLookupInProgress(): boolean;
+    startLookup(deviceId: string): PaymentAccountSession;
+    private constructor();
+}

package/lib/domain/model/account/PaymentAccountSession.js

@@ -0,0 +1,48 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PAYMENT_ACCOUNT_SESSION = "PaymentAccountSession";
+var PaymentAccountSessionState;
+(function (PaymentAccountSessionState) {
+    PaymentAccountSessionState["Completed"] = "Completed";
+    PaymentAccountSessionState["LookupInProgress"] = "LookupInProgress";
+})(PaymentAccountSessionState = exports.PaymentAccountSessionState || (exports.PaymentAccountSessionState = {}));
+class PaymentAccountSession {
+    constructor(state, deviceId) {
+        this._type = "PaymentAccountSession";
+        this._state = state;
+        this._deviceId = deviceId;
+    }
+    static createFromJsonObject(paymentAccountSessionJsonObj) {
+        const state = paymentAccountSessionJsonObj._state;
+        const deviceId = paymentAccountSessionJsonObj._deviceId;
+        return new PaymentAccountSession(state, deviceId);
+    }
+    static create() {
+        return new PaymentAccountSession(PaymentAccountSessionState.Completed);
+    }
+    get type() {
+        return this._type;
+    }
+    get deviceId() {
+        return this._deviceId;
+    }
+    get stateValues() {
+        return new Map([["PaymentAccountSession.state", this._state]]);
+    }
+    complete() {
+        return new PaymentAccountSession(PaymentAccountSessionState.Completed);
+    }
+    get inProgress() {
+        return this._state === PaymentAccountSessionState.LookupInProgress;
+    }
+    get inLookupInProgress() {
+        return this._state === PaymentAccountSessionState.LookupInProgress;
+    }
+    startLookup(deviceId) {
+        return this.inLookupInProgress
+            ? this
+            : new PaymentAccountSession(PaymentAccountSessionState.LookupInProgress, deviceId);
+    }
+}
+exports.PaymentAccountSession = PaymentAccountSession;
+//# sourceMappingURL=PaymentAccountSession.js.map

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

@@ -1,4 +1,5 @@
 export * from "./PaymentAccountLookupLine";
 export * from "./IPaymentAccountLookupLine";
+export * from "./PaymentAccountSession";
 export * from "./PaymentAccountHolderValidationLine";
 export * from "./IPaymentAccountHolderValidationLine";

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

@@ -4,5 +4,6 @@ function __export(m) {
 }
 Object.defineProperty(exports, "__esModule", { value: true });
 __export(require("./PaymentAccountLookupLine"));
+__export(require("./PaymentAccountSession"));
 __export(require("./PaymentAccountHolderValidationLine"));
 //# sourceMappingURL=index.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aptos-scp/scp-component-store-selling-features-domain-model",
-  "version": "1.54.0",
+  "version": "1.55.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",
@@ -61,7 +61,7 @@
     "@aptos-scp/scp-component-user": "^1.4.0",
     "@aptos-scp/scp-types-client-registration": "^1.4.0",
     "@aptos-scp/scp-types-core-config": "^2.2.1",
-    "@aptos-scp/scp-types-commerce-devices": "^3.14.0",
+    "@aptos-scp/scp-types-commerce-devices": "^4.1.0",
     "@aptos-scp/scp-types-commerce-transaction": "^1.75.0",
     "@aptos-scp/scp-types-customer": "^3.7.0",
     "@aptos-scp/scp-types-einvoice": "^1.17.0",
@@ -83,7 +83,7 @@
     "@aptos-scp/scp-component-taxation": "^5.27.3",
     "@aptos-scp/scp-component-user": "^1.4.0",
     "@aptos-scp/scp-types-client-registration": "^1.4.0",
-    "@aptos-scp/scp-types-commerce-devices": "^3.14.0",
+    "@aptos-scp/scp-types-commerce-devices": "^4.1.0",
     "@aptos-scp/scp-types-commerce-transaction": "^1.75.0",
     "@aptos-scp/scp-types-core": "^1.0.5",
     "@aptos-scp/scp-types-core-config": "^2.2.1",