@aptos-scp/scp-component-store-selling-features-domain-model 1.17.0 → 1.18.0

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

@@ -273,6 +273,9 @@ export declare enum UiInputKey {
     SUSPEND_TRANSACTION_RESUME_TOKEN = "input_suspendResumeToken",
     SUBSCRIPTION_PAYMENT_TENDER_LINE = "input_subscriptionInputTenderLine",
     TAX_CUSTOMER = "input_taxCustomer",
+    /**
+     * @deprecated TAX_EXEMPT_CERTIFICATE_ID will be removed in future releases, use TAX_EXEMPT_CERTIFICATE instead
+     */
     TAX_EXEMPT_CERTIFICATE_ID = "input_taxExemptCertificateId",
     TAX_EXEMPT_CERTIFICATE = "input_taxExemptCertificate",
     TAX_EXEMPT_LINE_NUMBER = "input_taxExemptLineNumber",
@@ -448,6 +451,9 @@ export declare enum CollectedDataKey {
     CashDrawerStatus = "CashDrawerStatus",
     CashDrawerStatusChangeSuccess = "cashDrawerStatusChangeSuccess",
     CashDrawerRequestType = "cashDrawerRequestType",
+    /**
+     * @deprecated CertificateId will be removed in future releases, use Certificate instead
+     */
     CertificateId = "CertificateId",
     Certificate = "Certificate",
     CustomFeeType = "CustomFeeType",

package/lib/domain/model/Constants.js

@@ -276,6 +276,9 @@ var UiInputKey;
     UiInputKey["SUSPEND_TRANSACTION_RESUME_TOKEN"] = "input_suspendResumeToken";
     UiInputKey["SUBSCRIPTION_PAYMENT_TENDER_LINE"] = "input_subscriptionInputTenderLine";
     UiInputKey["TAX_CUSTOMER"] = "input_taxCustomer";
+    /**
+     * @deprecated TAX_EXEMPT_CERTIFICATE_ID will be removed in future releases, use TAX_EXEMPT_CERTIFICATE instead
+     */
     UiInputKey["TAX_EXEMPT_CERTIFICATE_ID"] = "input_taxExemptCertificateId";
     UiInputKey["TAX_EXEMPT_CERTIFICATE"] = "input_taxExemptCertificate";
     UiInputKey["TAX_EXEMPT_LINE_NUMBER"] = "input_taxExemptLineNumber";
@@ -457,6 +460,9 @@ var CollectedDataKey;
     CollectedDataKey["CashDrawerStatus"] = "CashDrawerStatus";
     CollectedDataKey["CashDrawerStatusChangeSuccess"] = "cashDrawerStatusChangeSuccess";
     CollectedDataKey["CashDrawerRequestType"] = "cashDrawerRequestType";
+    /**
+     * @deprecated CertificateId will be removed in future releases, use Certificate instead
+     */
     CollectedDataKey["CertificateId"] = "CertificateId";
     CollectedDataKey["Certificate"] = "Certificate";
     CollectedDataKey["CustomFeeType"] = "CustomFeeType";

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

@@ -2,6 +2,7 @@ import { Money } from "@aptos-scp/scp-component-business-core";
 import { DeviceIdentity, ITransaction, ITransactionLine, ITransactionLineFactory, IUser } from "@aptos-scp/scp-component-store-selling-core";
 import { IBaseTransactionTaxCalculationResults } from "@aptos-scp/scp-component-taxation";
 import { IFiscalSignature, ITaxByTaxAuthority, ITaxByTaxRule, ITaxOverride, MerchandiseTransactionReservationStatus, MerchandiseTransactionTradeType, TaxCalculationSystem } from "@aptos-scp/scp-types-commerce-transaction";
+import { PotentialPromotion } from "@aptos-scp/scp-types-pricing";
 import { GiftReceiptMode } from "./Constants";
 import { Coupon } from "./Coupon";
 import { Customer } from "./Customer";
@@ -118,6 +119,7 @@ export declare class MerchandiseTransaction extends RetailTransaction implements
     private _transactionReferenceFormatter;
     private _totalsBeforeVoid;
     private _unusedCoupons?;
+    private _potentialPromotions?;
     private _employeeCustomer;
     private _governmentIssuedIds;
     private _invoiceNumber?;
@@ -157,7 +159,7 @@ export declare class MerchandiseTransaction extends RetailTransaction implements
     private _transactionTotalExcludingPreviouslyCollected;
     private _transactionSubTotalExcludingPreviouslyCollectedExcludingTax;
     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);
+    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[]);
     clone(): ITransaction;
     addLine(line: ITransactionLine): ITransaction;
     createOrUpdateOrder(order: Order): ITransaction;
@@ -231,6 +233,7 @@ export declare class MerchandiseTransaction extends RetailTransaction implements
     get employeeCustomer(): IEmployee;
     get referenceNumber(): string;
     get unusedCoupons(): Coupon[];
+    get potentialPromotions(): PotentialPromotion[];
     get governmentIssuedIds(): GovernmentBusinessId[];
     get invoiceNumber(): string;
     get orderReferenceNumber(): string;
@@ -267,6 +270,7 @@ export declare class MerchandiseTransaction extends RetailTransaction implements
     get digestValue(): string;
     updateUnusedCoupons(unusedCoupons: Coupon[]): ITransaction;
     updateGovernmentIssuedIds(governmentIssuedIds: GovernmentBusinessId[]): ITransaction;
+    updatePotentialPromotions(potentialPromotions: PotentialPromotion[]): ITransaction;
     assignCustomer(customer: Customer): ITransaction;
     assignTaxCustomer(taxCustomer: TaxCustomerLine): ITransaction;
     assignTradeType(transactionTradeType: MerchandiseTransactionTradeType): 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) {
+    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) {
         super(deviceIdentity, businessDayDate, transactionNumber, exports.MERCHANDISE_TRANSACTION_TYPE, performingUser, transactionId);
         this._accountingCurrency = accountingCurrency;
         this._transactionTotalDeliveryFee = new scp_component_business_core_1.Money(0, accountingCurrency);
@@ -73,6 +73,7 @@ class MerchandiseTransaction extends RetailTransaction_1.RetailTransaction {
         this._giftReceipt = giftReceipt;
         this._totalsBeforeVoid = totalsBeforeVoid;
         this._unusedCoupons = unusedCoupons;
+        this._potentialPromotions = potentialPromotions;
         this._employeeCustomer = employeeCustomer;
         this._governmentIssuedIds = governmentIssuedIds;
         this._invoiceNumber = invoiceNumber;
@@ -112,6 +113,7 @@ class MerchandiseTransaction extends RetailTransaction_1.RetailTransaction {
         const giftReceipt = transactionJsonObj._giftReceipt;
         const totalsBeforeVoid = transactionJsonObj._totalsBeforeVoid;
         const unusedCoupons = transactionJsonObj._unusedCoupons;
+        const potentialPromotions = transactionJsonObj._potentialPromotions;
         const employeeCustomer = Employee_1.Employee.createFromJsonObject(transactionJsonObj._employeeCustomer);
         const gbns = transactionJsonObj._governmentIssuedIds;
         const invoiceNumber = transactionJsonObj._invoiceNumber;
@@ -124,7 +126,7 @@ class MerchandiseTransaction extends RetailTransaction_1.RetailTransaction {
         const eInvoiceReference = transactionJsonObj._eInvoiceReference;
         const digestValue = transactionJsonObj._digestValue;
         const prepaidTendersToApply = transactionJsonObj._prepaidTendersToApply;
-        const merchandiseTransaction = new MerchandiseTransaction(deviceIdentity, businessDayDate, transactionNumber, accountingCurrency, transactionReferenceFormatter, gbns, performingUser, transactionId, giftReceiptMode, giftReceipt, totalsBeforeVoid, unusedCoupons, employeeCustomer, invoiceNumber, invoiceSequenceNumber, taxLotteryNumber, order, invoiceSequenceNumberGenerator, taxLotteryCustomerCode, taxScanCodeData, undefined, undefined, eInvoiceReference, prepaidTendersToApply, digestValue);
+        const merchandiseTransaction = new MerchandiseTransaction(deviceIdentity, businessDayDate, transactionNumber, accountingCurrency, transactionReferenceFormatter, gbns, performingUser, transactionId, giftReceiptMode, giftReceipt, totalsBeforeVoid, unusedCoupons, employeeCustomer, invoiceNumber, invoiceSequenceNumber, taxLotteryNumber, order, invoiceSequenceNumberGenerator, taxLotteryCustomerCode, taxScanCodeData, undefined, undefined, eInvoiceReference, prepaidTendersToApply, digestValue, potentialPromotions);
         merchandiseTransaction.loadFromJsonObject(transactionJsonObj, transactionLineFactory);
         return merchandiseTransaction;
     }
@@ -185,6 +187,7 @@ class MerchandiseTransaction extends RetailTransaction_1.RetailTransaction {
             transaction._salesperson = this._salesperson;
             transaction._totalsBeforeVoid = this._totalsBeforeVoid;
             transaction._unusedCoupons = this._unusedCoupons;
+            transaction._potentialPromotions = this._potentialPromotions;
             transaction._employeeCustomer = this._employeeCustomer;
             transaction._governmentIssuedIds = this._governmentIssuedIds;
             transaction._invoiceNumber = this._invoiceNumber;
@@ -452,6 +455,9 @@ class MerchandiseTransaction extends RetailTransaction_1.RetailTransaction {
     get unusedCoupons() {
         return this._unusedCoupons;
     }
+    get potentialPromotions() {
+        return this._potentialPromotions;
+    }
     get governmentIssuedIds() {
         return this._governmentIssuedIds;
     }
@@ -566,6 +572,11 @@ class MerchandiseTransaction extends RetailTransaction_1.RetailTransaction {
         newTransaction._governmentIssuedIds = governmentIssuedIds;
         return newTransaction;
     }
+    updatePotentialPromotions(potentialPromotions) {
+        const newTransaction = this.clone();
+        newTransaction._potentialPromotions = potentialPromotions;
+        return newTransaction;
+    }
     assignCustomer(customer) {
         const newTransaction = this.clone();
         newTransaction._customer = customer;
@@ -853,6 +864,7 @@ class MerchandiseTransaction extends RetailTransaction_1.RetailTransaction {
             ["transaction.salesperson", this._salesperson],
             ["transaction.totalsBeforeVoid", this._totalsBeforeVoid],
             ["transaction.unusedCoupons", this._unusedCoupons],
+            ["transaction.potentialPromotions", this._potentialPromotions],
             ["transaction.transactionLevelSavings", this._transactionLevelSavings],
             [
                 "transaction.subTotalExcludingTransactionDiscounts",
@@ -977,6 +989,7 @@ class MerchandiseTransaction extends RetailTransaction_1.RetailTransaction {
             _salesperson: this.salesperson,
             _totalsBeforeVoid: this.transactionTotalsBeforeVoid,
             _unusedCoupons: this.unusedCoupons,
+            _potentialPromotions: this.potentialPromotions,
             _transactionSubTotalExcludingTransactionDiscounts: this.transactionSubTotalExcludingTransactionDiscounts,
             _transactionLevelSavings: this.transactionLevelSavings,
             _governmentIssuedIds: this._governmentIssuedIds,
@@ -1119,6 +1132,7 @@ class MerchandiseTransaction extends RetailTransaction_1.RetailTransaction {
         this._giftReceipt = transactionJsonObj._giftReceipt;
         this._salesperson = Employee_1.Employee.createFromJsonObject(transactionJsonObj._salesperson);
         this._unusedCoupons = transactionJsonObj._unusedCoupons;
+        this._potentialPromotions = transactionJsonObj._potentialPromotions;
         this._employeeCustomer = Employee_1.Employee.createFromJsonObject(transactionJsonObj._employeeCustomer);
         this._transactionSubTotalExcludingTransactionDiscounts =
             transactionJsonObj._transactionSubTotalExcludingTransactionDiscounts &&

package/lib/domain/model/item/ISerializedPriceCalculationResultsWithSource.d.ts

@@ -1,11 +1,13 @@
 import { IPricingMetadataPersistanceObject, ISerializedLinePricingAdjustment, ISerializedSubline, ISerializedSublinePricingAdjustment, ISublinePricingAdjustment, RewardIssue } from "@aptos-scp/scp-component-pricing";
 import { ISerializedNonFinancialReward } from "@aptos-scp/scp-component-pricing/lib/interfaces/ILineNonFinancialReward";
 import { ICompetitivePriceInformation, ILoyaltyInformation, ISupervisorOverrideInformation, SourceIndicator } from "@aptos-scp/scp-types-commerce-transaction";
+import { PotentialPromotion } from "@aptos-scp/scp-types-pricing";
 export interface ISerializedPriceCalculationResultsWithSource {
     readonly lineAdjustments: ISerializedLinePricingAdjustmentWithSource[];
     readonly sublines?: ISerializedSublineWithSource[];
     readonly issues: RewardIssue[];
     readonly nonFinancialRewards?: ISerializedNonFinancialRewardWithSource[];
+    readonly potentialPromotions?: PotentialPromotion[];
     metadata?: IPricingMetadataPersistanceObject;
 }
 export interface ISerializedLinePricingAdjustmentWithSource extends ISerializedLinePricingAdjustment {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aptos-scp/scp-component-store-selling-features-domain-model",
-  "version": "1.17.0",
+  "version": "1.18.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",
@@ -94,7 +94,7 @@
     "@aptos-scp/scp-types-inventory": "^2.0.0",
     "@aptos-scp/scp-types-loyalty-memberships": "^2.3.0",
     "@aptos-scp/scp-types-orders": "^4.11.0",
-    "@aptos-scp/scp-types-pricing": "^4.23.0",
+    "@aptos-scp/scp-types-pricing": "^4.24.0",
     "@aptos-scp/scp-types-ss-transaction-history": "^1.6.0",
     "@aptos-scp/scp-types-store-items": "^1.23.0",
     "@aptos-scp/scp-types-terminal-settings": "^1.3.0",