@aptos-scp/scp-component-store-selling-features-domain-model 3.3.1 → 3.5.0

package/lib/domain/UIBusinessEventTypes.d.ts

@@ -343,3 +343,4 @@ export declare const COUNTRY_BOX_START_TRANSACTION_EVENT: string;
 export declare const COUNTRY_BOX_FINISH_TRANSACTION_EVENT: string;
 export declare const FULFILLMENT_AUTHORIZATION_EVENT: string;
 export declare const COUNTRY_BOX_REPORT_GENERATION_EVENT: string;
+export declare const PAYMENT_NOTIFICATION_START_EVENT: string;

package/lib/domain/UIBusinessEventTypes.js

@@ -350,4 +350,5 @@ exports.COUNTRY_BOX_START_TRANSACTION_EVENT = "CountryBoxStartTransactionEvent";
 exports.COUNTRY_BOX_FINISH_TRANSACTION_EVENT = "CountryBoxFinishTransactionEvent";
 exports.FULFILLMENT_AUTHORIZATION_EVENT = "FulfillmentAuthorization";
 exports.COUNTRY_BOX_REPORT_GENERATION_EVENT = "CountryBoxReportGenerationEvent";
+exports.PAYMENT_NOTIFICATION_START_EVENT = "PaymentNotificationStart";
 //# sourceMappingURL=UIBusinessEventTypes.js.map

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

@@ -478,7 +478,9 @@ export declare enum UiInputKey {
     FEE_LINE_FOR_REFUND = "input_feeLineForRefund",
     FEE_REFUND_SOURCE = "input_feeRefundSource",
     FEE_REFUNDABLE_AMOUNT = "input_feeRefundableAmount",
-    ITEM_TERMS_AND_CONDITIONS_ACCEPTED = "input_itemTermsAndConditionsAccepted"
+    ITEM_TERMS_AND_CONDITIONS_ACCEPTED = "input_itemTermsAndConditionsAccepted",
+    PAYMENT_AUTHORIZATION_REQUEST = "input_paymentAuthorizationRequest",
+    PAYMENT_AUTHORIZATION_RESPONSE = "input_paymentAuthorizationResponse"
 }
 export declare enum CollectedDataKey {
     Abort = "abort",
@@ -1028,7 +1030,8 @@ export declare enum CollectedDataKey {
     CustomerInputMode = "customerInputMode",
     PreAuthCapture = "preAuthCapture",
     PreOrder = "preOrder",
-    PreOrderAvailableDate = "preOrderAvailableDate"
+    PreOrderAvailableDate = "preOrderAvailableDate",
+    PaymentAuthorizationResponse = "paymentAuthorizationResponse"
 }
 export declare enum ItemLookupType {
     ProductInquiryDetail = "ProductInquiryDetail",
@@ -1055,6 +1058,7 @@ export declare const TRANSACTION_RESUMING_ON_STARTUP_EVENT: string;
 export declare const STORED_VALUE_REVERSAL_COMPLETED_EVENT_TYPE: string;
 export declare const STORED_VALUE_CERTIFICATE_REVERSAL_COMPLETED_EVENT_TYPE: string;
 export declare const PAYMENT_AUTH_INITIALIZE_START_EVENT_TYPE: string;
+export declare const PAYMENT_AUTH_CANCEL_START_EVENT_TYPE: string;
 export declare const PAYMENT_AUTH_START_EVENT_TYPE: string;
 export declare const TENDER_CHANGE_CANCEL_EVENT_TYPE: string;
 export declare const CASH_DRAWER_SELECTED_EVENT: string;

package/lib/domain/model/Constants.js

@@ -480,6 +480,8 @@ var UiInputKey;
     UiInputKey["FEE_REFUND_SOURCE"] = "input_feeRefundSource";
     UiInputKey["FEE_REFUNDABLE_AMOUNT"] = "input_feeRefundableAmount";
     UiInputKey["ITEM_TERMS_AND_CONDITIONS_ACCEPTED"] = "input_itemTermsAndConditionsAccepted";
+    UiInputKey["PAYMENT_AUTHORIZATION_REQUEST"] = "input_paymentAuthorizationRequest";
+    UiInputKey["PAYMENT_AUTHORIZATION_RESPONSE"] = "input_paymentAuthorizationResponse";
 })(UiInputKey = exports.UiInputKey || (exports.UiInputKey = {}));
 //
 // Keys for use in relaying data collectedData (qualification) and nonContextualData (action).
@@ -1036,6 +1038,7 @@ var CollectedDataKey;
     CollectedDataKey["PreAuthCapture"] = "preAuthCapture";
     CollectedDataKey["PreOrder"] = "preOrder";
     CollectedDataKey["PreOrderAvailableDate"] = "preOrderAvailableDate";
+    CollectedDataKey["PaymentAuthorizationResponse"] = "paymentAuthorizationResponse";
 })(CollectedDataKey = exports.CollectedDataKey || (exports.CollectedDataKey = {}));
 var ItemLookupType;
 (function (ItemLookupType) {
@@ -1066,6 +1069,7 @@ exports.TRANSACTION_RESUMING_ON_STARTUP_EVENT = "Transaction.ResumingOnStartup";
 exports.STORED_VALUE_REVERSAL_COMPLETED_EVENT_TYPE = "StoredValue.ReversalCompleted";
 exports.STORED_VALUE_CERTIFICATE_REVERSAL_COMPLETED_EVENT_TYPE = "StoredValueCertificate.ReversalCompleted";
 exports.PAYMENT_AUTH_INITIALIZE_START_EVENT_TYPE = "PaymentAuth.InitializeStart";
+exports.PAYMENT_AUTH_CANCEL_START_EVENT_TYPE = "PaymentAuth.CancelStart";
 exports.PAYMENT_AUTH_START_EVENT_TYPE = "PaymentAuth.Start";
 exports.TENDER_CHANGE_CANCEL_EVENT_TYPE = "TenderChange.Cancel";
 exports.CASH_DRAWER_SELECTED_EVENT = "CashDrawer.Selected";

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

@@ -0,0 +1,31 @@
+import { IState } from "@aptos-scp/scp-component-store-selling-core";
+export declare const PAYMENT_NOTIFICATION_SESSION: string;
+export declare enum PaymentNotificationSessionState {
+    Inactive = "Inactive",
+    Initializing = "Initializing",
+    InProgress = "InProgress",
+    Cancelled = "Cancelled",
+    Completed = "Completed"
+}
+export declare class PaymentNotificationSession implements IState {
+    private readonly _type;
+    private readonly _state;
+    private readonly _paymentAuthorizationResponse;
+    private readonly _authorizationServiceRequestId;
+    static createFromJsonObject(paymentNotificationSessionJsonObj: any): PaymentNotificationSession;
+    /**
+     * @param requestId Optional idempotency key (`serviceProcessing.requestID`) for pay-by-link before an authorization response exists.
+     */
+    static create(requestId?: string): PaymentNotificationSession;
+    get type(): string;
+    get state(): PaymentNotificationSessionState;
+    get paymentAuthorizationResponse(): any;
+    get authorizationServiceRequestId(): string | undefined;
+    get isCancelled(): boolean;
+    get stateValues(): Readonly<Map<string, any>>;
+    initialize(): PaymentNotificationSession;
+    inProgress(lastPaymentAuthorizationResponse?: any): PaymentNotificationSession;
+    complete(): PaymentNotificationSession;
+    cancelled(): PaymentNotificationSession;
+    private constructor();
+}

package/lib/domain/model/PaymentNotificationSession.js

@@ -0,0 +1,83 @@
+"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.PaymentNotificationSession");
+exports.PAYMENT_NOTIFICATION_SESSION = "PaymentNotificationSession";
+var PaymentNotificationSessionState;
+(function (PaymentNotificationSessionState) {
+    PaymentNotificationSessionState["Inactive"] = "Inactive";
+    PaymentNotificationSessionState["Initializing"] = "Initializing";
+    PaymentNotificationSessionState["InProgress"] = "InProgress";
+    PaymentNotificationSessionState["Cancelled"] = "Cancelled";
+    PaymentNotificationSessionState["Completed"] = "Completed";
+})(PaymentNotificationSessionState = exports.PaymentNotificationSessionState || (exports.PaymentNotificationSessionState = {}));
+class PaymentNotificationSession {
+    constructor(state, paymentAuthorizationResponse, authorizationServiceRequestId) {
+        this._type = exports.PAYMENT_NOTIFICATION_SESSION;
+        this._state = state;
+        if (state === PaymentNotificationSessionState.Initializing ||
+            state === PaymentNotificationSessionState.Completed) {
+            this._paymentAuthorizationResponse = undefined;
+            this._authorizationServiceRequestId = undefined;
+        }
+        else if (state === PaymentNotificationSessionState.Cancelled) {
+            this._paymentAuthorizationResponse = undefined;
+            this._authorizationServiceRequestId = authorizationServiceRequestId;
+        }
+        else if (paymentAuthorizationResponse) {
+            this._paymentAuthorizationResponse = paymentAuthorizationResponse;
+            this._authorizationServiceRequestId = authorizationServiceRequestId;
+        }
+        else {
+            this._paymentAuthorizationResponse = undefined;
+            this._authorizationServiceRequestId = authorizationServiceRequestId;
+        }
+    }
+    static createFromJsonObject(paymentNotificationSessionJsonObj) {
+        logger.traceEntry("createFromJsonObject");
+        return new PaymentNotificationSession(paymentNotificationSessionJsonObj._state, paymentNotificationSessionJsonObj._paymentAuthorizationResponse, paymentNotificationSessionJsonObj._authorizationServiceRequestId);
+    }
+    /**
+     * @param requestId Optional idempotency key (`serviceProcessing.requestID`) for pay-by-link before an authorization response exists.
+     */
+    static create(requestId) {
+        logger.traceEntry("create");
+        return new PaymentNotificationSession(PaymentNotificationSessionState.Inactive, undefined, requestId);
+    }
+    get type() {
+        return this._type;
+    }
+    get state() {
+        return this._state;
+    }
+    get paymentAuthorizationResponse() {
+        return this._paymentAuthorizationResponse;
+    }
+    get authorizationServiceRequestId() {
+        return this._authorizationServiceRequestId;
+    }
+    get isCancelled() {
+        return this._state === PaymentNotificationSessionState.Cancelled;
+    }
+    get stateValues() {
+        return new Map([
+            ["PaymentNotificationSession.state", this._state],
+            ["PaymentNotificationSession.paymentAuthorizationResponse", this._paymentAuthorizationResponse],
+            ["PaymentNotificationSession.authorizationServiceRequestId", this._authorizationServiceRequestId],
+        ]);
+    }
+    initialize() {
+        return new PaymentNotificationSession(PaymentNotificationSessionState.Initializing);
+    }
+    inProgress(lastPaymentAuthorizationResponse) {
+        return new PaymentNotificationSession(PaymentNotificationSessionState.InProgress, lastPaymentAuthorizationResponse, this._authorizationServiceRequestId);
+    }
+    complete() {
+        return new PaymentNotificationSession(PaymentNotificationSessionState.Completed);
+    }
+    cancelled() {
+        return new PaymentNotificationSession(PaymentNotificationSessionState.Cancelled, undefined, this._authorizationServiceRequestId);
+    }
+}
+exports.PaymentNotificationSession = PaymentNotificationSession;
+//# sourceMappingURL=PaymentNotificationSession.js.map

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

@@ -38,6 +38,7 @@ export * from "./MerchandiseTransaction";
 export * from "./TenderControlTransaction";
 export * from "./ApplicationControlTransaction";
 export * from "./ReceiptSession";
+export * from "./PaymentNotificationSession";
 export * from "./ReprintReceiptTransaction";
 export * from "./ResumeTransactionSession";
 export * from "./StoredValueCardSession";

package/lib/domain/model/index.js

@@ -40,6 +40,7 @@ __export(require("./MerchandiseTransaction"));
 __export(require("./TenderControlTransaction"));
 __export(require("./ApplicationControlTransaction"));
 __export(require("./ReceiptSession"));
+__export(require("./PaymentNotificationSession"));
 __export(require("./ReprintReceiptTransaction"));
 __export(require("./ResumeTransactionSession"));
 __export(require("./StoredValueCardSession"));

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aptos-scp/scp-component-store-selling-features-domain-model",
-  "version": "3.3.1",
+  "version": "3.5.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",