@aptos-scp/scp-component-store-selling-features-domain-model 3.3.0 → 3.4.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

@@ -288,6 +288,7 @@ export declare enum UiInputKey {
     SINGLE_USE_COUPON_NUMBER = "input_singleUseCouponNumber",
     SKIP_PASSWORD_CHANGE = "input_skipPasswordChange",
     SKIP_CONFIRM_CLOSE = "input_skipConfirmClose",
+    STORE_COUNTRY_DISPLAY_NAME = "storeCountryDisplayName",
     STORE_ITEM = "input_item",
     STORE_ITEM_KEY = "input_itemKey",
     STORE_ITEM_KEY_TYPE = "input_itemKeyType",
@@ -477,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",
@@ -940,6 +943,7 @@ export declare enum CollectedDataKey {
     DeviceId = "deviceId",
     RetailLocationId = "retailLocationId",
     TenantId = "tenantId",
+    StoreCountryDisplayName = "storeCountryDisplayName",
     StoreName = "storeName",
     TransactionStartDateTime = "transactionStartDateTime",
     TransactionEndDateTime = "transactionEndDateTime",
@@ -1026,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",
@@ -1053,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

@@ -289,6 +289,7 @@ var UiInputKey;
     UiInputKey["SINGLE_USE_COUPON_NUMBER"] = "input_singleUseCouponNumber";
     UiInputKey["SKIP_PASSWORD_CHANGE"] = "input_skipPasswordChange";
     UiInputKey["SKIP_CONFIRM_CLOSE"] = "input_skipConfirmClose";
+    UiInputKey["STORE_COUNTRY_DISPLAY_NAME"] = "storeCountryDisplayName";
     UiInputKey["STORE_ITEM"] = "input_item";
     UiInputKey["STORE_ITEM_KEY"] = "input_itemKey";
     UiInputKey["STORE_ITEM_KEY_TYPE"] = "input_itemKeyType";
@@ -479,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).
@@ -947,6 +950,7 @@ var CollectedDataKey;
     CollectedDataKey["DeviceId"] = "deviceId";
     CollectedDataKey["RetailLocationId"] = "retailLocationId";
     CollectedDataKey["TenantId"] = "tenantId";
+    CollectedDataKey["StoreCountryDisplayName"] = "storeCountryDisplayName";
     CollectedDataKey["StoreName"] = "storeName";
     CollectedDataKey["TransactionStartDateTime"] = "transactionStartDateTime";
     CollectedDataKey["TransactionEndDateTime"] = "transactionEndDateTime";
@@ -1034,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) {
@@ -1064,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/MerchandiseTransaction.d.ts

@@ -176,8 +176,9 @@ export declare class MerchandiseTransaction extends RetailTransaction implements
     private _fiscalError?;
     private _countryBoxFiscalError?;
     private _hasFiscalizationCompleted?;
+    private _storeCountryNameForReceipt?;
     static createFromJsonObj(transactionJsonObj: any, transactionLineFactory: ITransactionLineFactory, transactionReferenceFormatter: ITransactionReferenceFormatter): MerchandiseTransaction;
-    constructor(deviceIdentity: DeviceIdentity, businessDayDate: string, transactionNumber: number, accountingCurrency: string, transactionReferenceFormatter: ITransactionReferenceFormatter, governmentIssuedIds?: GovernmentBusinessId[], performingUser?: IUser, transactionId?: string, giftReceiptMode?: GiftReceiptMode, giftReceipt?: boolean, totalsBeforeVoid?: TotalsBeforeVoid, unusedCoupons?: Coupon[], employeeCustomer?: IEmployee, invoiceNumber?: string, invoiceSequenceNumber?: number, taxLotteryNumber?: string, order?: Order, invoiceSequenceNumberGenerator?: string, taxLotteryCustomerCode?: string, taxScanCodeData?: string, fiscalSignature?: IFiscalSignature, requiresVoid?: boolean, eInvoiceReference?: string, prepaidTendersToApply?: IPrepaidTenderToApply[], digestValue?: string, potentialPromotions?: PotentialPromotion[]);
+    constructor(deviceIdentity: DeviceIdentity, businessDayDate: string, transactionNumber: number, accountingCurrency: string, transactionReferenceFormatter: ITransactionReferenceFormatter, governmentIssuedIds?: GovernmentBusinessId[], performingUser?: IUser, transactionId?: string, giftReceiptMode?: GiftReceiptMode, giftReceipt?: boolean, totalsBeforeVoid?: TotalsBeforeVoid, unusedCoupons?: Coupon[], employeeCustomer?: IEmployee, invoiceNumber?: string, invoiceSequenceNumber?: number, taxLotteryNumber?: string, order?: Order, invoiceSequenceNumberGenerator?: string, taxLotteryCustomerCode?: string, taxScanCodeData?: string, fiscalSignature?: IFiscalSignature, requiresVoid?: boolean, eInvoiceReference?: string, prepaidTendersToApply?: IPrepaidTenderToApply[], digestValue?: string, potentialPromotions?: PotentialPromotion[], storeCountryNameForReceipt?: string);
     clone(): ITransaction;
     addLine(line: ITransactionLine): ITransaction;
     createOrUpdateOrder(order: Order): ITransaction;
@@ -266,6 +267,7 @@ export declare class MerchandiseTransaction extends RetailTransaction implements
     get fiscalError(): IFiscalError;
     get countryBoxFiscalError(): ICountryBoxFiscalError;
     get hasFiscalizationCompleted(): boolean;
+    get storeCountryNameForReceipt(): string | undefined;
     get tradeType(): MerchandiseTransactionTradeType;
     get taxLotteryNumber(): string;
     get taxLotteryCustomerCode(): string;
@@ -313,6 +315,7 @@ export declare class MerchandiseTransaction extends RetailTransaction implements
     setFiscalError(fiscalError: IFiscalError): ITransaction;
     setCountryBoxFiscalError(countryBoxFiscalError: ICountryBoxFiscalError): ITransaction;
     setHasFiscalizationCompleted(hasFiscalizationCompleted: boolean): ITransaction;
+    assignStoreCountryNameForReceipt(storeCountryNameForReceipt: string): ITransaction;
     assignOrderReferenceSequenceNumber(orderReferenceSequenceNumber: number, orderReferenceSequenceNumberGenerator: string): ITransaction;
     assignInvoiceFiscalTransactionNumber(invoiceTransactionNumber: number, invoiceFiscalTransactionNumber: string): ITransaction;
     assignTaxlotteryNumber(taxLotteryNumber: string): ITransaction;

package/lib/domain/model/MerchandiseTransaction.js

@@ -24,7 +24,7 @@ exports.isMerchandiseTransaction = (transaction) => {
     Ensure that any new property needs to added here as well toJSON methods as well.
  */
 class MerchandiseTransaction extends RetailTransaction_1.RetailTransaction {
-    constructor(deviceIdentity, businessDayDate, transactionNumber, accountingCurrency, transactionReferenceFormatter, governmentIssuedIds, performingUser, transactionId, giftReceiptMode, giftReceipt, totalsBeforeVoid, unusedCoupons, employeeCustomer, invoiceNumber, invoiceSequenceNumber, taxLotteryNumber, order, invoiceSequenceNumberGenerator, taxLotteryCustomerCode, taxScanCodeData, fiscalSignature, requiresVoid, eInvoiceReference, prepaidTendersToApply, digestValue, potentialPromotions) {
+    constructor(deviceIdentity, businessDayDate, transactionNumber, accountingCurrency, transactionReferenceFormatter, governmentIssuedIds, performingUser, transactionId, giftReceiptMode, giftReceipt, totalsBeforeVoid, unusedCoupons, employeeCustomer, invoiceNumber, invoiceSequenceNumber, taxLotteryNumber, order, invoiceSequenceNumberGenerator, taxLotteryCustomerCode, taxScanCodeData, fiscalSignature, requiresVoid, eInvoiceReference, prepaidTendersToApply, digestValue, potentialPromotions, storeCountryNameForReceipt) {
         super(deviceIdentity, businessDayDate, transactionNumber, exports.MERCHANDISE_TRANSACTION_TYPE, performingUser, transactionId);
         this._accountingCurrency = accountingCurrency;
         this._transactionTotalDeliveryFee = new scp_component_business_core_1.Money(0, accountingCurrency);
@@ -88,6 +88,7 @@ class MerchandiseTransaction extends RetailTransaction_1.RetailTransaction {
         this._fiscalError = undefined;
         this._countryBoxFiscalError = undefined;
         this._hasFiscalizationCompleted = false;
+        this._storeCountryNameForReceipt = storeCountryNameForReceipt;
         this._tradeType = undefined;
         this._denominationRounding = new scp_component_business_core_1.Money(0, accountingCurrency);
         this._order = order;
@@ -208,6 +209,7 @@ class MerchandiseTransaction extends RetailTransaction_1.RetailTransaction {
             transaction._fiscalError = this._fiscalError;
             transaction._countryBoxFiscalError = this._countryBoxFiscalError;
             transaction._hasFiscalizationCompleted = this._hasFiscalizationCompleted;
+            transaction._storeCountryNameForReceipt = this._storeCountryNameForReceipt;
             transaction._tradeType = this._tradeType;
             transaction._taxLotteryNumber = this._taxLotteryNumber;
             transaction._denominationRounding = this._denominationRounding;
@@ -515,6 +517,9 @@ class MerchandiseTransaction extends RetailTransaction_1.RetailTransaction {
     get hasFiscalizationCompleted() {
         return this._hasFiscalizationCompleted;
     }
+    get storeCountryNameForReceipt() {
+        return this._storeCountryNameForReceipt;
+    }
     get tradeType() {
         return this._tradeType;
     }
@@ -745,6 +750,11 @@ class MerchandiseTransaction extends RetailTransaction_1.RetailTransaction {
         newTransaction._hasFiscalizationCompleted = hasFiscalizationCompleted;
         return newTransaction;
     }
+    assignStoreCountryNameForReceipt(storeCountryNameForReceipt) {
+        const newTransaction = this.clone();
+        newTransaction._storeCountryNameForReceipt = storeCountryNameForReceipt.trim();
+        return newTransaction;
+    }
     assignOrderReferenceSequenceNumber(orderReferenceSequenceNumber, orderReferenceSequenceNumberGenerator) {
         const newTransaction = this.clone();
         newTransaction._orderReferenceSequenceNumber = orderReferenceSequenceNumber;
@@ -1107,7 +1117,7 @@ class MerchandiseTransaction extends RetailTransaction_1.RetailTransaction {
         };
     }
     newTransaction() {
-        return new MerchandiseTransaction(this.deviceIdentity, this.businessDayDate, this.transactionNumber, this._accountingCurrency, this._transactionReferenceFormatter, this._governmentIssuedIds, this.performingUser, this.transactionId, undefined, undefined, undefined, undefined, this._employeeCustomer, this._invoiceNumber, this._invoiceSequenceNumber, this._taxLotteryNumber, this.order, this._invoiceSequenceNumberGenerator, this._taxLotteryCustomerCode, this.taxScanCodeData, this._fiscalSignature, this._requiresVoid, this._eInvoiceReference, this.prepaidTendersToApply, this._digestValue);
+        return new MerchandiseTransaction(this.deviceIdentity, this.businessDayDate, this.transactionNumber, this._accountingCurrency, this._transactionReferenceFormatter, this._governmentIssuedIds, this.performingUser, this.transactionId, undefined, undefined, undefined, undefined, this._employeeCustomer, this._invoiceNumber, this._invoiceSequenceNumber, this._taxLotteryNumber, this.order, this._invoiceSequenceNumberGenerator, this._taxLotteryCustomerCode, this.taxScanCodeData, this._fiscalSignature, this._requiresVoid, this._eInvoiceReference, this.prepaidTendersToApply, this._digestValue, this._potentialPromotions, this._storeCountryNameForReceipt);
     }
     // eslint-disable-next-line complexity
     loadFromJsonObject(transactionJsonObj, transactionLineFactory) {

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

@@ -0,0 +1,23 @@
+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",
+    Completed = "Completed"
+}
+export declare class PaymentNotificationSession implements IState {
+    private readonly _type;
+    private readonly _state;
+    private readonly _paymentAuthorizationResponse;
+    static createFromJsonObject(paymentNotificationSessionJsonObj: any): PaymentNotificationSession;
+    static create(): PaymentNotificationSession;
+    get type(): string;
+    get state(): PaymentNotificationSessionState;
+    get paymentAuthorizationResponse(): any;
+    get stateValues(): Readonly<Map<string, any>>;
+    initialize(): PaymentNotificationSession;
+    inProgress(lastPaymentAuthorizationResponse?: any): PaymentNotificationSession;
+    complete(): PaymentNotificationSession;
+    private constructor();
+}

package/lib/domain/model/PaymentNotificationSession.js

@@ -0,0 +1,59 @@
+"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["Completed"] = "Completed";
+})(PaymentNotificationSessionState = exports.PaymentNotificationSessionState || (exports.PaymentNotificationSessionState = {}));
+class PaymentNotificationSession {
+    constructor(state, paymentAuthorizationResponse) {
+        this._type = exports.PAYMENT_NOTIFICATION_SESSION;
+        this._state = state;
+        if (state === PaymentNotificationSessionState.Initializing ||
+            state === PaymentNotificationSessionState.Completed) {
+            this._paymentAuthorizationResponse = undefined;
+        }
+        else if (paymentAuthorizationResponse) {
+            this._paymentAuthorizationResponse = paymentAuthorizationResponse;
+        }
+    }
+    static createFromJsonObject(paymentNotificationSessionJsonObj) {
+        logger.traceEntry("createFromJsonObject");
+        return new PaymentNotificationSession(paymentNotificationSessionJsonObj._state, paymentNotificationSessionJsonObj._paymentAuthorizationResponse);
+    }
+    static create() {
+        logger.traceEntry("create");
+        return new PaymentNotificationSession(PaymentNotificationSessionState.Inactive);
+    }
+    get type() {
+        return this._type;
+    }
+    get state() {
+        return this._state;
+    }
+    get paymentAuthorizationResponse() {
+        return this._paymentAuthorizationResponse;
+    }
+    get stateValues() {
+        return new Map([
+            ["PaymentNotificationSession.state", this._state],
+            ["PaymentNotificationSession.paymentAuthorizationResponse", this._paymentAuthorizationResponse],
+        ]);
+    }
+    initialize() {
+        return new PaymentNotificationSession(PaymentNotificationSessionState.Initializing);
+    }
+    inProgress(lastPaymentAuthorizationResponse) {
+        return new PaymentNotificationSession(PaymentNotificationSessionState.InProgress, lastPaymentAuthorizationResponse);
+    }
+    complete() {
+        return new PaymentNotificationSession(PaymentNotificationSessionState.Completed);
+    }
+}
+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/lib/domain/model/tender/valueCard/Interfaces.d.ts

@@ -48,10 +48,10 @@ export declare enum ValueCardAction {
     Inquiry = "inquiry",
     Redeem = "redeem",
     AddValue = "addValue",
-    /** AO `valueCardServiceBehaviors.enabledActions` — add-value path during refund (DSS-34771). */
+    /** AO `valueCardServiceBehaviors.enabledActions` — add-value path during refund. */
     AddValueDuringRefund = "addValueDuringRefund",
     Issue = "issue",
-    /** AO `valueCardServiceBehaviors.enabledActions` — issue path during refund (DSS-34771). */
+    /** AO `valueCardServiceBehaviors.enabledActions` — issue path during refund. */
     IssueDuringRefund = "issueDuringRefund",
     VoidRedeem = "voidRedeem",
     VoidIssue = "voidIssue",

package/lib/domain/model/tender/valueCard/Interfaces.js

@@ -17,10 +17,10 @@ var ValueCardAction;
     ValueCardAction["Inquiry"] = "inquiry";
     ValueCardAction["Redeem"] = "redeem";
     ValueCardAction["AddValue"] = "addValue";
-    /** AO `valueCardServiceBehaviors.enabledActions` — add-value path during refund (DSS-34771). */
+    /** AO `valueCardServiceBehaviors.enabledActions` — add-value path during refund. */
     ValueCardAction["AddValueDuringRefund"] = "addValueDuringRefund";
     ValueCardAction["Issue"] = "issue";
-    /** AO `valueCardServiceBehaviors.enabledActions` — issue path during refund (DSS-34771). */
+    /** AO `valueCardServiceBehaviors.enabledActions` — issue path during refund. */
     ValueCardAction["IssueDuringRefund"] = "issueDuringRefund";
     ValueCardAction["VoidRedeem"] = "voidRedeem";
     ValueCardAction["VoidIssue"] = "voidIssue";

package/package.json

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