@aptos-scp/scp-component-store-selling-features-domain-model 2.46.0 → 2.48.0

package/lib/domain/UIBusinessEventTypes.js

@@ -53,7 +53,7 @@ exports.ITEM_TAX_OVERRIDE_EVENT = "ItemTaxOverride";
 exports.SELL_ITEM_NOT_ON_FILE_EVENT = "SellItemNotOnFile";
 exports.ORDER_ITEM_NOT_ON_FILE_EVENT = "OrderItemNotOnFile";
 exports.ORDER_ITEM_CANCELLATION_EVENT = "OrderItemCancellation";
-exports.FINALIZE_ORDER_ITEM_CANCELLATION_EVENT = "FinalizeOrderItemCancellation";
+exports.FINALIZE_ORDER_ITEM_CANCELLATION_EVENT = "FinalizeOrderItemCancellation"; //Deprecated
 exports.ORDER_ITEM_RESTORE_EVENT = "OrderItemRestore";
 exports.RESERVED_ORDER_ITEM_CANCELLATION_EVENT = "ReservedOrderItemCancellation";
 exports.ORDER_ITEM_PICKUP_EVENT = "OrderItemPickup";

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

@@ -333,6 +333,10 @@ export declare enum UiInputKey {
     MAPPED_REFUND_TENDER_TYPE_NAME = "input_mappedRefundTenderTypeName",
     MAPPED_REFUND_CARD_TYPE_NAME = "input_mappedRefundCardTypeName",
     PRE_AUTH = "input_preAuth",
+    /**
+     * When true, APPLY_TENDER (routed to refund) is reversing tender held as authorization only (e.g. order cancel).
+     */
+    PRE_AUTHORIZATION_REVERSAL = "input_preAuthorizationReversal",
     EXCLUDED_REFUND_CARD_TYPE_NAMES = "input_excludedRefundCardTypeNames",
     TRANSACTION_NUMBER_FIELD = "input_transactionNumberField",
     TRANSACTION_REFERENCE_NUMBER_FIELD = "input_referenceNumberField",
@@ -472,7 +476,8 @@ export declare enum UiInputKey {
     SELECTED_RETURN_ITEMS = "input_selectedReturnItems",
     FEE_LINE_FOR_REFUND = "input_feeLineForRefund",
     FEE_REFUND_SOURCE = "input_feeRefundSource",
-    FEE_REFUNDABLE_AMOUNT = "input_feeRefundableAmount"
+    FEE_REFUNDABLE_AMOUNT = "input_feeRefundableAmount",
+    ITEM_TERMS_AND_CONDITIONS_ACCEPTED = "input_itemTermsAndConditionsAccepted"
 }
 export declare enum CollectedDataKey {
     Abort = "abort",
@@ -985,6 +990,11 @@ export declare enum CollectedDataKey {
     PrepaidTaxAmount = "prepaidTaxAmount",
     PrepaidSavingsAmount = "prepaidSavingsAmount",
     PreviouslyCollectedTender = "previouslyCollectedTender",
+    /**
+     * When ToBeStarted (or legacy boolean true) as collected data with TenderAuthResponse,
+     * merges IAuthorizationResponse.preAuthorizationReversalStatus.
+     */
+    PreAuthorizationReversal = "PreAuthorizationReversal",
     PresetRateExemption = "presetRateExemption",
     PresetExemptionCategory = "presetExemptionCategory",
     PresetExemptionRate = "presetExemptionRate",

package/lib/domain/model/Constants.js

@@ -334,6 +334,10 @@ var UiInputKey;
     UiInputKey["MAPPED_REFUND_TENDER_TYPE_NAME"] = "input_mappedRefundTenderTypeName";
     UiInputKey["MAPPED_REFUND_CARD_TYPE_NAME"] = "input_mappedRefundCardTypeName";
     UiInputKey["PRE_AUTH"] = "input_preAuth";
+    /**
+     * When true, APPLY_TENDER (routed to refund) is reversing tender held as authorization only (e.g. order cancel).
+     */
+    UiInputKey["PRE_AUTHORIZATION_REVERSAL"] = "input_preAuthorizationReversal";
     UiInputKey["EXCLUDED_REFUND_CARD_TYPE_NAMES"] = "input_excludedRefundCardTypeNames";
     UiInputKey["TRANSACTION_NUMBER_FIELD"] = "input_transactionNumberField";
     UiInputKey["TRANSACTION_REFERENCE_NUMBER_FIELD"] = "input_referenceNumberField";
@@ -474,6 +478,7 @@ var UiInputKey;
     UiInputKey["FEE_LINE_FOR_REFUND"] = "input_feeLineForRefund";
     UiInputKey["FEE_REFUND_SOURCE"] = "input_feeRefundSource";
     UiInputKey["FEE_REFUNDABLE_AMOUNT"] = "input_feeRefundableAmount";
+    UiInputKey["ITEM_TERMS_AND_CONDITIONS_ACCEPTED"] = "input_itemTermsAndConditionsAccepted";
 })(UiInputKey = exports.UiInputKey || (exports.UiInputKey = {}));
 //
 // Keys for use in relaying data collectedData (qualification) and nonContextualData (action).
@@ -992,6 +997,11 @@ var CollectedDataKey;
     CollectedDataKey["PrepaidTaxAmount"] = "prepaidTaxAmount";
     CollectedDataKey["PrepaidSavingsAmount"] = "prepaidSavingsAmount";
     CollectedDataKey["PreviouslyCollectedTender"] = "previouslyCollectedTender";
+    /**
+     * When ToBeStarted (or legacy boolean true) as collected data with TenderAuthResponse,
+     * merges IAuthorizationResponse.preAuthorizationReversalStatus.
+     */
+    CollectedDataKey["PreAuthorizationReversal"] = "PreAuthorizationReversal";
     CollectedDataKey["PresetRateExemption"] = "presetRateExemption";
     CollectedDataKey["PresetExemptionCategory"] = "presetExemptionCategory";
     CollectedDataKey["PresetExemptionRate"] = "presetExemptionRate";

package/lib/domain/model/TenderType.js

@@ -352,10 +352,13 @@ class TenderType {
         return tenderType;
     }
     signatureRequired(tenderAmount, authResponse) {
-        var _a;
+        var _a, _b;
         let sigRequired = false;
+        if (((_a = authResponse) === null || _a === void 0 ? void 0 : _a.preAuthorizationReversalStatus) != null) {
+            return false;
+        }
         //if the auth type is updateAuthorization then use signatureCapturePolicyForCallForAuth
-        const signatureCapturePolicy = ((_a = authResponse) === null || _a === void 0 ? void 0 : _a.requestType) === scp_types_commerce_devices_1.PaymentRequestType.UpdateAuthorization
+        const signatureCapturePolicy = ((_b = authResponse) === null || _b === void 0 ? void 0 : _b.requestType) === scp_types_commerce_devices_1.PaymentRequestType.UpdateAuthorization
             ? this.signatureCapturePolicyForCallForAuth
             : this.signatureCapturePolicy;
         switch (signatureCapturePolicy) {

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

@@ -1,9 +1,14 @@
+import { ConditionType, IConditionalAttributeBehaviorRuleAttributeGroups } from "./IConditionalAttributeBehaviorRuleConfig";
+import { ITranslatableMessage } from "./IFeatureAccessConfig";
 export interface ICustomerConfig {
     loyalty: ILoyaltyConfig;
 }
 export interface ILoyaltyConfig {
     readonly enabled: boolean;
     readonly realTimePoints: IRealTimePointConfig;
+    readonly enrollment?: IEnrollmentConfig;
+    readonly displayBehavior?: IDisplayBehavior;
+    readonly redemption?: IRedemptionConfig;
     readonly applyPermanentMembershipDiscounts?: boolean;
 }
 export declare enum LoyaltyQualifyingTransactions {
@@ -18,6 +23,7 @@ export interface IDisplayBehavior {
     readonly showCurrentTransactionTotalPoints: boolean;
     readonly showCurrentTransactionRegularPoints: boolean;
     readonly showCurrentTransactionConditionalPoints: boolean;
+    readonly hiddenLoyaltyPlanIds: string[];
 }
 export interface IRealTimePointConfig {
     readonly qualifyingTransactions: LoyaltyQualifyingTransactions;
@@ -29,3 +35,88 @@ export declare enum AssignCustomerFromOriginalSaleForReturns {
     AssignWithPrompt = "AssignWithPrompt",
     AssignWithoutPrompt = "AssignWithoutPrompt"
 }
+export interface IEnrollmentConfig {
+    readonly hiddenMembershipTypeCodes?: string[];
+    readonly manualEnrollment?: IEnabledConfig;
+    readonly customerFields?: ICustomerFieldsConfig;
+    readonly enrollmentPrompt?: IEnrollmentPromptConfig;
+    readonly minimumAgeValidation?: MinimumAgeValidation;
+    readonly customOptIn?: ICustomOptInConfig;
+}
+export interface IEnabledConfig {
+    readonly enabled?: boolean;
+}
+export interface ICustomerFieldsConfig {
+    readonly emailAddress?: ILoyaltyEnrollmentFieldConfig;
+    readonly attributes?: ILoyaltyScreenAttributesConfig;
+}
+export interface ILoyaltyScreenAttributesConfig {
+    readonly attributeGroupCodes?: string[];
+    readonly conditionsToDisableEnrollment?: IConditionalAttributeBehaviorRuleAttributeGroups;
+    readonly conditionType?: ConditionType;
+}
+export interface ILoyaltyEnrollmentFieldConfig {
+    readonly usage?: FieldUsage;
+    readonly displayBehavior?: DisplayBehavior;
+    readonly editableBehavior?: DisplayBehavior;
+}
+export interface IEnrollmentPromptConfig {
+    readonly appliesTo?: AppliesTo;
+    readonly deferralButton?: IDeferralButtonConfig;
+}
+export interface IDeferralButtonConfig {
+    readonly enabled?: boolean;
+    readonly deferralDays?: number;
+}
+export interface ICustomOptInConfig {
+    readonly customOptInDetails: ICustomOptInDetailsConfig;
+    readonly conditionsToDisableEnrollment?: IConditionalAttributeBehaviorRuleAttributeGroups;
+    readonly conditionType?: ConditionType;
+    readonly customerConfirmation?: ICustomerConfirmationConfig;
+}
+export interface ICustomOptInDetailsConfig {
+    readonly [key: string]: ICustomOptInContentConfig;
+}
+export interface ICustomOptInContentConfig {
+    readonly customOptInTitle: ITranslatableMessage;
+    readonly customOptInLink?: ITranslatableMessage;
+    readonly customOptInFullDetails?: ITranslatableMessage;
+    readonly optInResponseLabel?: ITranslatableMessage;
+    readonly customOptInSummary?: ITranslatableMessage;
+    readonly customOptInLinks?: ICustomOptInLinksConfig;
+}
+export interface ICustomOptInLinksConfig {
+    readonly [key: string]: ITranslatableMessage;
+}
+export interface ICustomerConfirmationConfig {
+    readonly enabled: boolean;
+    readonly allowBypassConfirmationUponDeviceError: boolean;
+}
+export interface IRedemptionConfig {
+    readonly calculateMaxVariableDiscount: boolean;
+    readonly automaticLoyaltyRedemptionBehavior: RedemptionBehavior;
+}
+export declare enum AppliesTo {
+    None = "None",
+    AllQualifyingCustomers = "AllQualifyingCustomers",
+    NewCustomersOnly = "NewCustomersOnly"
+}
+export declare enum MinimumAgeValidation {
+    NoValidation = "NoValidation",
+    PreventEnrollingMinors = "PreventEnrollingMinors",
+    PreventEnrollAndSaveWithCustomerTypeMinor = "PreventEnrollAndSaveWithCustomerTypeMinor"
+}
+export declare enum FieldUsage {
+    Required = "Required",
+    Optional = "Optional",
+    NotUsed = "NotUsed"
+}
+export declare enum DisplayBehavior {
+    Always = "Always",
+    OnlyIfEmpty = "OnlyIfEmpty"
+}
+export declare enum RedemptionBehavior {
+    Disabled = "Disabled",
+    Prompt = "Prompt",
+    ApplyWithoutPrompting = "ApplyWithoutPrompting"
+}

package/lib/domain/model/configuration/ICustomerConfig.js

@@ -12,4 +12,33 @@ var AssignCustomerFromOriginalSaleForReturns;
     AssignCustomerFromOriginalSaleForReturns["AssignWithPrompt"] = "AssignWithPrompt";
     AssignCustomerFromOriginalSaleForReturns["AssignWithoutPrompt"] = "AssignWithoutPrompt";
 })(AssignCustomerFromOriginalSaleForReturns = exports.AssignCustomerFromOriginalSaleForReturns || (exports.AssignCustomerFromOriginalSaleForReturns = {}));
+var AppliesTo;
+(function (AppliesTo) {
+    AppliesTo["None"] = "None";
+    AppliesTo["AllQualifyingCustomers"] = "AllQualifyingCustomers";
+    AppliesTo["NewCustomersOnly"] = "NewCustomersOnly";
+})(AppliesTo = exports.AppliesTo || (exports.AppliesTo = {}));
+var MinimumAgeValidation;
+(function (MinimumAgeValidation) {
+    MinimumAgeValidation["NoValidation"] = "NoValidation";
+    MinimumAgeValidation["PreventEnrollingMinors"] = "PreventEnrollingMinors";
+    MinimumAgeValidation["PreventEnrollAndSaveWithCustomerTypeMinor"] = "PreventEnrollAndSaveWithCustomerTypeMinor";
+})(MinimumAgeValidation = exports.MinimumAgeValidation || (exports.MinimumAgeValidation = {}));
+var FieldUsage;
+(function (FieldUsage) {
+    FieldUsage["Required"] = "Required";
+    FieldUsage["Optional"] = "Optional";
+    FieldUsage["NotUsed"] = "NotUsed";
+})(FieldUsage = exports.FieldUsage || (exports.FieldUsage = {}));
+var DisplayBehavior;
+(function (DisplayBehavior) {
+    DisplayBehavior["Always"] = "Always";
+    DisplayBehavior["OnlyIfEmpty"] = "OnlyIfEmpty";
+})(DisplayBehavior = exports.DisplayBehavior || (exports.DisplayBehavior = {}));
+var RedemptionBehavior;
+(function (RedemptionBehavior) {
+    RedemptionBehavior["Disabled"] = "Disabled";
+    RedemptionBehavior["Prompt"] = "Prompt";
+    RedemptionBehavior["ApplyWithoutPrompting"] = "ApplyWithoutPrompting";
+})(RedemptionBehavior = exports.RedemptionBehavior || (exports.RedemptionBehavior = {}));
 //# sourceMappingURL=ICustomerConfig.js.map

package/lib/domain/model/tender/BaseTenderLineDecorator.d.ts

@@ -27,6 +27,7 @@ export declare abstract class BaseTenderLineDecorator extends BaseLineDecorator<
     get transactionLineReference(): ITransactionLineReferenceType;
     get refundedLineReference(): ITransactionLineReferenceType;
     get originalTenderReferences(): IOriginalTenderReference[];
+    get isPreAuthorizationReversal(): boolean;
     get refunded(): boolean;
     signatureRequired(): boolean;
     printDeclineDetails(): boolean;

package/lib/domain/model/tender/BaseTenderLineDecorator.js

@@ -51,6 +51,9 @@ class BaseTenderLineDecorator extends BaseLineDecorator_1.BaseLineDecorator {
     get originalTenderReferences() {
         return this.decoratedTransactionLine.originalTenderReferences;
     }
+    get isPreAuthorizationReversal() {
+        return this.decoratedTransactionLine.isPreAuthorizationReversal;
+    }
     get refunded() {
         return this.decoratedTransactionLine.refunded;
     }

package/lib/domain/model/tender/ITenderLine.d.ts

@@ -26,6 +26,8 @@ export interface ITenderLine extends ITransactionLine, IVoidableLine {
     readonly adjustmentType?: TenderAdjustmentType;
     readonly originalTenderReferences?: IOriginalTenderReference[];
     readonly actionType?: ActionType;
+    /** True when this TenderRefund reverses an authorization-only hold (see IAuthorizationResponse.preAuthorizationReversalStatus). */
+    readonly isPreAuthorizationReversal?: boolean;
     readonly tax?: Money;
     /**
      * The amount given before the conversion

package/lib/domain/model/tender/TenderLine.d.ts

@@ -78,6 +78,10 @@ export declare class TenderLine extends BaseTransactionLine implements ITenderLi
     get preventsTransactionVoid(): boolean;
     get forfeitTenderChangeConfirmed(): boolean;
     get isPreviouslyCollected(): boolean;
+    /**
+     * True when this TenderRefund line reverses a tender that was only pre-authorized (authorization reversal).
+     */
+    get isPreAuthorizationReversal(): boolean;
     get allowVoid(): boolean;
     get adjustmentType(): TenderAdjustmentType;
     get voidingLine(): boolean;

package/lib/domain/model/tender/TenderLine.js

@@ -61,7 +61,19 @@ class TenderLine extends BaseTransactionLine_1.BaseTransactionLine {
         // The tender could (in the future) be a foreign tender with a currency other than the accounting currency.
         const accountingCurrency = collectedData.get("accountingCurrency");
         const extendedAmount = TenderLine.determineExtendedAmount(lineType, tenderAmount, accountingCurrency);
-        const authResponse = collectedData.get(Constants_1.CollectedDataKey.TenderAuthResponse);
+        // Auth payload from qualification (e.g. device response). When PreAuthorizationReversal is collected
+        // (order-cancel apply of OMS pre-auth), copy and stamp preAuthorizationReversalStatus so posting/display
+        // treat the line as a reversal; default requestType to Refund if none was supplied.
+        let mergedAuthResponse = collectedData.get(Constants_1.CollectedDataKey.TenderAuthResponse);
+        const rawPreAuthReversal = collectedData.get(Constants_1.CollectedDataKey.PreAuthorizationReversal);
+        const preAuthorizationReversalCollected = rawPreAuthReversal === true || rawPreAuthReversal === scp_types_commerce_devices_1.PreAuthorizationReversalStatus.ToBeStarted;
+        if (preAuthorizationReversalCollected) {
+            mergedAuthResponse = Object.assign({}, (mergedAuthResponse || {}));
+            mergedAuthResponse.preAuthorizationReversalStatus = scp_types_commerce_devices_1.PreAuthorizationReversalStatus.ToBeStarted;
+            if (mergedAuthResponse.requestType === undefined) {
+                mergedAuthResponse.requestType = scp_types_commerce_devices_1.PaymentRequestType.Refund;
+            }
+        }
         const authorizationDeviceId = collectedData.get(Constants_1.CollectedDataKey.AuthorizationDeviceId);
         const preventsTransactionVoid = !!collectedData.get(Constants_1.CollectedDataKey.TenderPreventsTransactionVoid);
         const adjustmentType = collectedData.get(Constants_1.CollectedDataKey.TenderAdjustmentType);
@@ -81,7 +93,7 @@ class TenderLine extends BaseTransactionLine_1.BaseTransactionLine {
         const previouslyCollectedTender = collectedData.get(Constants_1.CollectedDataKey.PreviouslyCollectedTender)
             ? collectedData.get(Constants_1.CollectedDataKey.PreviouslyCollectedTender)
             : false;
-        return new TenderLine(lineNumber, lineType, extendedAmount, tenderAuthCategory, tenderType, tenderAmount, authResponse, authorizationDeviceId, preventsTransactionVoid, adjustmentType, transactionLineReference, refundedLineReference, referenceNumber, residentLimit, promptRuleType, originalTenderReferences, actionType, supervisorOverrideLineReference, tax, foreignTenderAmount, exchangeRateValue, exchangeRateManualEntryLineReference, forfeitTenderChangeConfirmed, previouslyCollectedTender);
+        return new TenderLine(lineNumber, lineType, extendedAmount, tenderAuthCategory, tenderType, tenderAmount, mergedAuthResponse, authorizationDeviceId, preventsTransactionVoid, adjustmentType, transactionLineReference, refundedLineReference, referenceNumber, residentLimit, promptRuleType, originalTenderReferences, actionType, supervisorOverrideLineReference, tax, foreignTenderAmount, exchangeRateValue, exchangeRateManualEntryLineReference, forfeitTenderChangeConfirmed, previouslyCollectedTender);
     }
     static createFromJsonObject(transactionLineJsonObj) {
         const lineNumber = BaseTransactionLine_1.BaseTransactionLine.lineNumberFromJsonObject(transactionLineJsonObj);
@@ -210,12 +222,20 @@ class TenderLine extends BaseTransactionLine_1.BaseTransactionLine {
     get isPreviouslyCollected() {
         return this._previouslyCollectedTender;
     }
+    /**
+     * True when this TenderRefund line reverses a tender that was only pre-authorized (authorization reversal).
+     */
+    get isPreAuthorizationReversal() {
+        var _a;
+        return ((_a = this._authResponse) === null || _a === void 0 ? void 0 : _a.preAuthorizationReversalStatus) != null;
+    }
     get allowVoid() {
         var _a;
         if (this.authResponse &&
-            this.authResponse.paymentProvider === scp_types_commerce_devices_1.PaymentProvider.Adyen &&
             this.lineType === exports.TENDER_REFUND_LINE_TYPE &&
-            ((_a = this.tenderType) === null || _a === void 0 ? void 0 : _a.cardType) !== scp_types_commerce_devices_1.CardType.Gift) {
+            ((this.authResponse.paymentProvider === scp_types_commerce_devices_1.PaymentProvider.Adyen &&
+                ((_a = this.tenderType) === null || _a === void 0 ? void 0 : _a.cardType) !== scp_types_commerce_devices_1.CardType.Gift) ||
+                this.authResponse.preAuthorizationReversalStatus != null)) {
             //a payment provider was used for a refund that can't be voided, so don't allow voiding
             return false;
         }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aptos-scp/scp-component-store-selling-features-domain-model",
-  "version": "2.46.0",
+  "version": "2.48.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",
@@ -85,8 +85,8 @@
     "@aptos-scp/scp-component-taxation": "^5.28.0",
     "@aptos-scp/scp-component-user": "^1.4.0",
     "@aptos-scp/scp-types-client-registration": "^1.4.0",
-    "@aptos-scp/scp-types-commerce-devices": "^6.10.0",
-    "@aptos-scp/scp-types-commerce-transaction": "^1.93.0",
+    "@aptos-scp/scp-types-commerce-devices": "^6.12.0",
+    "@aptos-scp/scp-types-commerce-transaction": "^1.94.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",