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

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",
@@ -940,6 +941,7 @@ export declare enum CollectedDataKey {
     DeviceId = "deviceId",
     RetailLocationId = "retailLocationId",
     TenantId = "tenantId",
+    StoreCountryDisplayName = "storeCountryDisplayName",
     StoreName = "storeName",
     TransactionStartDateTime = "transactionStartDateTime",
     TransactionEndDateTime = "transactionEndDateTime",

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";
@@ -947,6 +948,7 @@ var CollectedDataKey;
     CollectedDataKey["DeviceId"] = "deviceId";
     CollectedDataKey["RetailLocationId"] = "retailLocationId";
     CollectedDataKey["TenantId"] = "tenantId";
+    CollectedDataKey["StoreCountryDisplayName"] = "storeCountryDisplayName";
     CollectedDataKey["StoreName"] = "storeName";
     CollectedDataKey["TransactionStartDateTime"] = "transactionStartDateTime";
     CollectedDataKey["TransactionEndDateTime"] = "transactionEndDateTime";

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/tender/valueCard/Interfaces.d.ts

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

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

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

package/package.json

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