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

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

@@ -472,7 +472,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",

package/lib/domain/model/Constants.js

@@ -474,6 +474,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).

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/package.json

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