@aptos-scp/scp-component-store-selling-features-domain-model 2.48.1 → 2.49.0

package/lib/domain/model/configuration/IFeatureAccessConfig.d.ts

@@ -40,7 +40,6 @@ export interface IFeatureAccessConfig {
     tender?: {
         autoPopulateCardNumberFromCustomer?: boolean;
         allowEmployee?: boolean;
-        issueNewOnRefundAuthFailure?: boolean;
     };
     errorMessages?: {
         [errorCode: string]: {

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

@@ -2,7 +2,7 @@ import { Money, Price, Quantity } from "@aptos-scp/scp-component-business-core";
 import { IUser } from "@aptos-scp/scp-component-store-selling-core";
 import { IAppliedTax } from "@aptos-scp/scp-component-taxation";
 import { IAuthorizationResponse } from "@aptos-scp/scp-types-commerce-devices";
-import { ActionType, IPriceChange, ISubline as IPostableSubline, ITaxByTaxRule, ITaxExempt, ITaxOverride, ITaxOverrideDetails, ItemType, ITransactionLineReferenceType, SourceIndicator, UnitPriceSourceIndicator, StyleTypeEnum } from "@aptos-scp/scp-types-commerce-transaction";
+import { ActionType, IPriceChange, ISubline as IPostableSubline, ITaxByTaxRule, ITaxExempt, ITaxOverride, ITaxOverrideDetails, ItemType, ITransactionLineReferenceType, SourceIndicator, UnitPriceSourceIndicator, StyleTypeEnum, ITimeInterval } from "@aptos-scp/scp-types-commerce-transaction";
 import { ItemSubType } from "@aptos-scp/scp-types-store-items";
 import { ISublinePricingAdjustmentWithSource } from "./ISerializedPriceCalculationResultsWithSource";
 import { BaseLineDecorator } from "../../model/BaseLineDecorator";
@@ -130,6 +130,9 @@ export declare abstract class BaseItemLineDecorator extends BaseLineDecorator<II
     get presentation(): IItemLine;
     get extendedPresentationAmount(): Money;
     get subscriptionFrequencyCodes(): string[];
+    get deliveryCode(): string | undefined;
+    get deliveryInterval(): ITimeInterval | undefined;
+    get deliveryFrequencyText(): string | undefined;
     get subType(): ItemSubType;
     get autoSubscribe(): boolean;
     get cancelled(): boolean;

package/lib/domain/model/item/BaseItemLineDecorator.js

@@ -339,6 +339,15 @@ class BaseItemLineDecorator extends BaseLineDecorator_1.BaseLineDecorator {
     get subscriptionFrequencyCodes() {
         return this.decoratedTransactionLine.subscriptionFrequencyCodes;
     }
+    get deliveryCode() {
+        return this.decoratedTransactionLine.deliveryCode;
+    }
+    get deliveryInterval() {
+        return this.decoratedTransactionLine.deliveryInterval;
+    }
+    get deliveryFrequencyText() {
+        return this.decoratedTransactionLine.deliveryFrequencyText;
+    }
     get subType() {
         return this.decoratedTransactionLine.subType;
     }

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

@@ -2,7 +2,7 @@ import { Money, Price, Quantity } from "@aptos-scp/scp-component-business-core";
 import { ITransactionLine, IUser } from "@aptos-scp/scp-component-store-selling-core";
 import { IAppliedTax } from "@aptos-scp/scp-component-taxation";
 import { IAuthorizationResponse } from "@aptos-scp/scp-types-commerce-devices";
-import { ActionType, IPriceChange, ISubline as IPostableSubline, ITaxByTaxAuthority, ITaxByTaxRule, ITaxExempt, ITaxOverride, ITaxOverrideDetails, ItemType, ITransactionLineReferenceType, IUser as IPostedUser, LoyaltyRedemptionType, SourceIndicator, UnitPriceSourceIndicator, ICompetitivePriceInformation, IProratedItemLineReference, IReason, StyleTypeEnum } from "@aptos-scp/scp-types-commerce-transaction";
+import { ActionType, IPriceChange, ISubline as IPostableSubline, ITaxByTaxAuthority, ITaxByTaxRule, ITaxExempt, ITaxOverride, ITaxOverrideDetails, ItemType, ITransactionLineReferenceType, IUser as IPostedUser, LoyaltyRedemptionType, SourceIndicator, UnitPriceSourceIndicator, ICompetitivePriceInformation, IProratedItemLineReference, IReason, StyleTypeEnum, ITimeInterval } from "@aptos-scp/scp-types-commerce-transaction";
 import { ItemSubType } from "@aptos-scp/scp-types-store-items";
 import { ISerializedSublinePricingAdjustmentWithSource, ISublinePricingAdjustmentWithSource } from "./ISerializedPriceCalculationResultsWithSource";
 import { SecurityAuthorizationStatusType } from "../Constants";
@@ -270,6 +270,19 @@ export interface IItemLine extends ITransactionLine, IVoidableLine, IPriceProvid
      * For pre-order items, the available date of the item.
      */
     readonly preOrderAvailableDate?: string;
+    /**
+     * For subscription items, the delivery code of the item.
+     */
+    readonly deliveryCode?: string;
+    /**
+     * For subscription items, the delivery interval of the item.
+     * This is the interval of the subscription frequency code.
+     */
+    readonly deliveryInterval?: ITimeInterval;
+    /**
+     * For subscription items, the delivery frequency text of the item.
+     */
+    readonly deliveryFrequencyText?: string;
     setTransactionLineTaxes(transactionLineTaxes: ITransactionLineTaxes, extendedAmount?: Money): IItemLine;
     setSublines(sublines: IItemSubline[]): IItemLine;
     setTaxExemptInformation(taxExemptLine: ItemTaxExemptLine | TransactionTaxExemptLine, preTaxExemptDetails: IAppliedTax[]): IItemLine;

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

@@ -3,7 +3,7 @@ import { ICopyableLine } from "@aptos-scp/scp-component-store-selling-core/lib/d
 import { IExtendedAmountMaintainer, ITransactionLine, IUser, UiBusinessEvent } from "@aptos-scp/scp-component-store-selling-core";
 import { IAppliedTax } from "@aptos-scp/scp-component-taxation";
 import { IAuthorizationResponse } from "@aptos-scp/scp-types-commerce-devices";
-import { ActionType, ISameTransactionLineReference, ISubline as IPostableSubline, ITaxByTaxRule, ITaxExempt, ITaxOverride, ITaxOverrideDetails, ItemType, ITransactionLineReferenceType, SourceIndicator, UnitPriceSourceIndicator, IPriceChange, IReason, StyleTypeEnum } from "@aptos-scp/scp-types-commerce-transaction";
+import { ActionType, ISameTransactionLineReference, ISubline as IPostableSubline, ITaxByTaxRule, ITaxExempt, ITaxOverride, ITaxOverrideDetails, ItemType, ITransactionLineReferenceType, SourceIndicator, UnitPriceSourceIndicator, IPriceChange, IReason, StyleTypeEnum, ITimeInterval } from "@aptos-scp/scp-types-commerce-transaction";
 import { ItemSubType } from "@aptos-scp/scp-types-store-items";
 import { ISublinePricingAdjustmentWithSource } from "./ISerializedPriceCalculationResultsWithSource";
 import { ItemTaxExemptLine, TransactionTaxExemptLine } from "../../model/taxExempt";
@@ -118,6 +118,9 @@ export declare class ItemLine extends BaseTransactionLine implements IItemLine,
     private _rewardCardTenders?;
     private _preOrder?;
     private _preOrderAvailableDate?;
+    private _deliveryCode?;
+    private _deliveryInterval?;
+    private _deliveryFrequencyText?;
     /**
      * The create method is called by the transaction line factory to create an instance and initialize it from the
      * data collected during the qualification process.
@@ -279,6 +282,9 @@ export declare class ItemLine extends BaseTransactionLine implements IItemLine,
     get extendedAmountAfterTaxAdjustment(): Money;
     get unitPriceAfterTaxAdjustment(): Price;
     get rewardCardTenders(): IRewardCardTender[];
+    get deliveryCode(): string;
+    get deliveryInterval(): ITimeInterval;
+    get deliveryFrequencyText(): string;
     updateExtendedAmount(amount: Money): ITransactionLine;
     updateExtendedAmountExcludingTax(amount: Money): ITransactionLine;
     updateExtendedAmountIncludingTax(amount: Money): ITransactionLine;

package/lib/domain/model/item/ItemLine.js

@@ -3,6 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const scp_component_business_core_1 = require("@aptos-scp/scp-component-business-core");
 const scp_types_commerce_transaction_1 = require("@aptos-scp/scp-types-commerce-transaction");
 const orderUtils_1 = require("../../../domain/utility/orderUtils");
+const subscriptionFrequencyUtils_1 = require("../../../domain/utility/subscriptionFrequencyUtils");
 const BaseTransactionLine_1 = require("../BaseTransactionLine");
 const Constants_1 = require("../Constants");
 const Customer_1 = require("../Customer");
@@ -39,7 +40,7 @@ class ItemLine extends BaseTransactionLine_1.BaseTransactionLine {
     // tslint:disable-next-line:cyclomatic-complexity
     // eslint-disable-next-line complexity
     static create(lineNumber, lineType, uiBusinessEvent, collectedData) {
-        var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k;
+        var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m;
         let accountingCurrency = collectedData.get("accountingCurrency");
         const additionalItemInfo = collectedData.get("additionalItemInfo");
         const authResponse = collectedData.get(Constants_1.CollectedDataKey.TenderAuthResponse);
@@ -106,6 +107,15 @@ class ItemLine extends BaseTransactionLine_1.BaseTransactionLine {
         itemLine._subscriptionFrequencyCodes = storeItem.subscriptionFrequencyCodes;
         itemLine._subType = (_d = storeItem) === null || _d === void 0 ? void 0 : _d.subType;
         itemLine._autoSubscribe = (_e = storeItem) === null || _e === void 0 ? void 0 : _e.autoSubscribe;
+        const isLoyaltyMembershipNonMerchSubscription = storeItem.itemType === scp_types_commerce_transaction_1.ItemType.NonMerch && storeItem.subType === "LoyaltyMembership";
+        const intervalFromSubscriptionCode = isLoyaltyMembershipNonMerchSubscription && ((_f = storeItem.subscriptionFrequencyCodes) === null || _f === void 0 ? void 0 : _f[0])
+            ? subscriptionFrequencyUtils_1.buildTimeIntervalFromCode((_g = storeItem.subscriptionFrequencyCodes) === null || _g === void 0 ? void 0 : _g[0])
+            : undefined;
+        if (intervalFromSubscriptionCode && isLoyaltyMembershipNonMerchSubscription) {
+            itemLine._deliveryCode = `${intervalFromSubscriptionCode.value}${intervalFromSubscriptionCode.unit}`;
+            itemLine._deliveryInterval = intervalFromSubscriptionCode;
+            itemLine._deliveryFrequencyText = subscriptionFrequencyUtils_1.buildDeliveryFrequencyTextFromTimeInterval(intervalFromSubscriptionCode);
+        }
         if (collectedData.get(Constants_1.CollectedDataKey.OriginalAlternativeLookupCodesExternalItem)) {
             itemLine._itemLookupKeys = ItemLine.getItemLookupKeyFromCollectedData(collectedData.get(Constants_1.CollectedDataKey.OriginalAlternativeLookupCodesExternalItem));
         }
@@ -204,13 +214,13 @@ class ItemLine extends BaseTransactionLine_1.BaseTransactionLine {
             if (taxIndicatorOnReceipt) {
                 itemLine._taxIndicatorOnReceipt = taxIndicatorOnReceipt;
             }
-            if (((_f = originalLoyaltyInformation) === null || _f === void 0 ? void 0 : _f.length) > 0) {
+            if (((_h = originalLoyaltyInformation) === null || _h === void 0 ? void 0 : _h.length) > 0) {
                 itemLine._originalLoyaltyInformation = originalLoyaltyInformation;
             }
             if (originalCompetitivePriceInformation) {
                 itemLine._originalCompetitivePriceInformation = originalCompetitivePriceInformation;
             }
-            if (((_g = originalSupervisorOverrideInformation) === null || _g === void 0 ? void 0 : _g.length) > 0) {
+            if (((_j = originalSupervisorOverrideInformation) === null || _j === void 0 ? void 0 : _j.length) > 0) {
                 itemLine._originalSupervisorOverrideInformation = originalSupervisorOverrideInformation;
             }
             if (originalTaxOverride) {
@@ -218,7 +228,7 @@ class ItemLine extends BaseTransactionLine_1.BaseTransactionLine {
                 itemLine._taxOverride = originalTaxOverride.taxOverride;
                 itemLine._preTaxOverrideDetails = originalTaxOverride.preTaxOverrideDetails;
             }
-            if (((_h = originalRewardCardTenders) === null || _h === void 0 ? void 0 : _h.length) > 0) {
+            if (((_k = originalRewardCardTenders) === null || _k === void 0 ? void 0 : _k.length) > 0) {
                 itemLine._originalRewardCardTenders = originalRewardCardTenders;
             }
         }
@@ -252,11 +262,11 @@ class ItemLine extends BaseTransactionLine_1.BaseTransactionLine {
             itemLine._originalAdjustments = originalAdjustments;
         }
         const originalRedemptionLoyaltyTransactionKeys = collectedData.get(Constants_1.CollectedDataKey.OriginalRedemptionLoyaltyTransactionKeys);
-        if (((_j = originalRedemptionLoyaltyTransactionKeys) === null || _j === void 0 ? void 0 : _j.length) > 0) {
+        if (((_l = originalRedemptionLoyaltyTransactionKeys) === null || _l === void 0 ? void 0 : _l.length) > 0) {
             itemLine._originalRedemptionLoyaltyTransactionKeys = originalRedemptionLoyaltyTransactionKeys;
         }
         const originalSaleLoyaltyTransactionKeys = collectedData.get(Constants_1.CollectedDataKey.OriginalSaleLoyaltyTransactionKeys);
-        if (((_k = originalSaleLoyaltyTransactionKeys) === null || _k === void 0 ? void 0 : _k.length) > 0) {
+        if (((_m = originalSaleLoyaltyTransactionKeys) === null || _m === void 0 ? void 0 : _m.length) > 0) {
             itemLine._originalSaleLoyaltyTransactionKeys = originalSaleLoyaltyTransactionKeys;
         }
         const originalTransactionLineReference = collectedData.get(Constants_1.CollectedDataKey.OriginalTransactionLineReference);
@@ -751,6 +761,15 @@ class ItemLine extends BaseTransactionLine_1.BaseTransactionLine {
     get rewardCardTenders() {
         return this._rewardCardTenders;
     }
+    get deliveryCode() {
+        return this._deliveryCode;
+    }
+    get deliveryInterval() {
+        return this._deliveryInterval;
+    }
+    get deliveryFrequencyText() {
+        return this._deliveryFrequencyText;
+    }
     updateExtendedAmount(amount) {
         amount = adjustSignForLineType(this.lineType, amount);
         return this.updateExtendedAmountValue(amount).setExtendedAmountExcludingAndIncludingTax();
@@ -979,6 +998,9 @@ class ItemLine extends BaseTransactionLine_1.BaseTransactionLine {
         newItemLine._originalAdjustments = this._originalAdjustments;
         newItemLine._originalRewardCardTenders = this._originalRewardCardTenders;
         newItemLine._rewardCardTenders = this._rewardCardTenders;
+        newItemLine._deliveryCode = this._deliveryCode;
+        newItemLine._deliveryInterval = this._deliveryInterval;
+        newItemLine._deliveryFrequencyText = this._deliveryFrequencyText;
         return newItemLine;
     }
     // eslint-disable-next-line complexity
@@ -1128,6 +1150,9 @@ class ItemLine extends BaseTransactionLine_1.BaseTransactionLine {
         this._originalAdjustments = transactionLineJsonObj._originalAdjustments;
         this._originalRewardCardTenders = transactionLineJsonObj._originalRewardCardTenders;
         this._rewardCardTenders = transactionLineJsonObj._rewardCardTenders;
+        this._deliveryCode = transactionLineJsonObj._deliveryCode;
+        this._deliveryInterval = transactionLineJsonObj._deliveryInterval;
+        this._deliveryFrequencyText = transactionLineJsonObj._deliveryFrequencyText;
     }
     newTransactionLine() {
         return new ItemLine(this.lineNumber, this.lineType, this._accountingCurrency);

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

@@ -3,3 +3,4 @@ export * from "./orderUtils";
 export * from "./orderFeeUtils";
 export * from "./itemImageUtils";
 export * from "./feeRefundUtils";
+export * from "./subscriptionFrequencyUtils";

package/lib/domain/utility/index.js

@@ -8,4 +8,5 @@ __export(require("./orderUtils"));
 __export(require("./orderFeeUtils"));
 __export(require("./itemImageUtils"));
 __export(require("./feeRefundUtils"));
+__export(require("./subscriptionFrequencyUtils"));
 //# sourceMappingURL=index.js.map

package/lib/domain/utility/subscriptionFrequencyUtils.d.ts

@@ -0,0 +1,3 @@
+import { ITimeInterval } from "@aptos-scp/scp-types-commerce-transaction";
+export declare function buildTimeIntervalFromCode(code: string): ITimeInterval | undefined;
+export declare function buildDeliveryFrequencyTextFromTimeInterval(interval: ITimeInterval): string;

package/lib/domain/utility/subscriptionFrequencyUtils.js

@@ -0,0 +1,40 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const UNIT_SUFFIX_MAP = {
+    d: "Day",
+    w: "Week",
+    m: "Month",
+    y: "Year",
+    day: "Day",
+    week: "Week",
+    month: "Month",
+    year: "Year",
+};
+function buildTimeIntervalFromCode(code) {
+    var _a;
+    const match = (_a = code) === null || _a === void 0 ? void 0 : _a.match(/^(\d+)([a-zA-Z]+)$/);
+    if (!match) {
+        return undefined;
+    }
+    const value = parseInt(match[1], 10);
+    const suffix = match[2].toLowerCase();
+    const unit = UNIT_SUFFIX_MAP[suffix];
+    return unit ? { unit, value } : undefined;
+}
+exports.buildTimeIntervalFromCode = buildTimeIntervalFromCode;
+function buildDeliveryFrequencyTextFromTimeInterval(interval) {
+    var _a;
+    const labels = {
+        Day: ["day", "days"],
+        Week: ["week", "weeks"],
+        Month: ["month", "months"],
+        Year: ["year", "years"],
+    };
+    const [singular, plural] = (_a = labels[interval.unit], (_a !== null && _a !== void 0 ? _a : [
+        interval.unit.toLowerCase(),
+        `${interval.unit.toLowerCase()}s`,
+    ]));
+    return interval.value === 1 ? `Every ${singular}` : `Every ${interval.value} ${plural}`;
+}
+exports.buildDeliveryFrequencyTextFromTimeInterval = buildDeliveryFrequencyTextFromTimeInterval;
+//# sourceMappingURL=subscriptionFrequencyUtils.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aptos-scp/scp-component-store-selling-features-domain-model",
-  "version": "2.48.1",
+  "version": "2.49.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",
@@ -64,7 +64,7 @@
     "@aptos-scp/scp-types-client-registration": "^1.4.0",
     "@aptos-scp/scp-types-core-config": "^2.2.1",
     "@aptos-scp/scp-types-commerce-devices": "^6.10.0",
-    "@aptos-scp/scp-types-commerce-transaction": "^1.93.0",
+    "@aptos-scp/scp-types-commerce-transaction": "^1.95.0",
     "@aptos-scp/scp-types-customer": "^3.7.0",
     "@aptos-scp/scp-types-einvoice": "^1.17.0",
     "@aptos-scp/scp-types-inventory": "^2.0.0",
@@ -86,7 +86,7 @@
     "@aptos-scp/scp-component-user": "^1.4.0",
     "@aptos-scp/scp-types-client-registration": "^1.4.0",
     "@aptos-scp/scp-types-commerce-devices": "^6.12.0",
-    "@aptos-scp/scp-types-commerce-transaction": "^1.94.0",
+    "@aptos-scp/scp-types-commerce-transaction": "^1.95.0",
     "@aptos-scp/scp-types-core": "^1.0.5",
     "@aptos-scp/scp-types-core-config": "^2.2.1",
     "@aptos-scp/scp-types-currency-conversion": "^1.2.0",