@thryveai/theme-interfaces 2.7.13 → 2.7.15-3.beta

package/dist/storefront/SFUISettingsTemplate.AdminUi.js

@@ -14,6 +14,7 @@ exports.AdminTemplateInputTypes = {
     images: "images",
     string: "string",
     array: "array",
+    storeSelection: "storeSelection",
 };
 exports.validationTypes = [
     "luhnValidation",
@@ -58,6 +59,72 @@ exports.AdminSettingsTemplateSFUI = {
             },
         },
     },
+    accountPage: {
+        title: "My account",
+        description: "",
+        type: exports.AdminTemplateInputTypes.collapsableObject,
+        helpLink: "https://mi9retail.atlassian.net/wiki/spaces/FDS/pages/3275784302/Account+Page",
+        value: {
+            profileTab: {
+                title: "Profile tab",
+                description: "",
+                type: exports.AdminTemplateInputTypes.collapsableObject,
+                value: {
+                    deleteAccountButton: {
+                        title: "Delete account button",
+                        description: "This allows the customer to delete their account from the My Account screen on the Storefront.",
+                        helpLink: "https://mi9retail.atlassian.net/wiki/spaces/FDS/pages/3486023742/Delete+account+button",
+                        type: exports.AdminTemplateInputTypes.checkbox,
+                    },
+                },
+            },
+            loyaltyTab: {
+                title: "Loyalty tab",
+                description: "",
+                type: exports.AdminTemplateInputTypes.collapsableObject,
+                value: {
+                    enabled: {
+                        title: "Enable loyalty tab",
+                        description: "This will display the loyalty tab in the My Account section on the Storefront.",
+                        type: exports.AdminTemplateInputTypes.checkbox,
+                    },
+                    disabledEdit: {
+                        title: "Disable loyalty number editing",
+                        description: "This will prevent users from being able to edit their loyalty number on the Storefront.",
+                        type: exports.AdminTemplateInputTypes.checkbox,
+                    },
+                    loyaltyNumberLength: {
+                        title: "Loyalty number length",
+                        description: "This is the number of digits required for a loyalty number to be deemed valid.",
+                        type: exports.AdminTemplateInputTypes.inputNumber,
+                    },
+                    loyaltyNumberPrefix: {
+                        title: "Loyalty number prefix",
+                        description: "This is a series of hardcoded digits that appear at the beginning of every loyalty number. Adding these digits here means the customer doesn’t have to on the Storefront. ",
+                        type: exports.AdminTemplateInputTypes.inputChar,
+                    },
+                    loyaltyValidationType: {
+                        title: "Loyalty number validation",
+                        description: "Select the types of validations you would like the loyalty number to require.",
+                        type: exports.AdminTemplateInputTypes.multiDropdown,
+                        options: exports.validationTypes,
+                    },
+                    barcodeSettings: {
+                        title: "Barcode",
+                        description: "",
+                        type: exports.AdminTemplateInputTypes.collapsableObject,
+                        value: {
+                            enabled: {
+                                title: "Enable barcode",
+                                description: "This will display the customers loyalty card barcode on the Storefront.",
+                                type: exports.AdminTemplateInputTypes.checkbox,
+                            },
+                        },
+                    },
+                },
+            },
+        },
+    },
     // accountPage: {
     //   title: "Account Page",
     //   description: "Account page settings",
@@ -329,6 +396,20 @@ exports.AdminSettingsTemplateSFUI = {
                 type: exports.AdminTemplateInputTypes.checkbox,
                 group: { id: 1, name: "General Features" },
             },
+            subscriptions: {
+                title: "Display subscriptions",
+                description: "Enable subscriptions functionality",
+                helpLink: "https://mi9retail.atlassian.net/wiki/spaces/FDS/pages/3274637365/Subscriptions",
+                type: exports.AdminTemplateInputTypes.checkbox,
+                group: { id: 1, name: "General Features" },
+            },
+            creditBalance: {
+                title: "Display creditBalance to customer",
+                description: "Enable creditBalance functionality",
+                helpLink: "https://mi9retail.atlassian.net/wiki/spaces/FDS/pages/3274637365/creditBalance",
+                type: exports.AdminTemplateInputTypes.checkbox,
+                group: { id: 1, name: "General Features" },
+            },
             // additionalCharges: {
             //   title: "Additional Charges",
             //   description:
@@ -468,25 +549,25 @@ exports.AdminSettingsTemplateSFUI = {
             //     "https://mi9retail.atlassian.net/wiki/spaces/FDS/pages/3344302081/Entry+Modal+Version",
             // },
             hideAlcoholRule: {
-                title: "Set if shopping rule modals appears for alcohol",
+                title: "Alcohol messaging",
                 description: "Set boolean to control if shopping rule modals appears for alcohol.",
                 type: exports.AdminTemplateInputTypes.collapsableObject,
                 value: {
                     pdp: {
-                        title: "Disable warning box",
-                        description: "Disable alcohol warning box on pdp.",
+                        title: "Disable product details page messaging for alcohol",
+                        description: "This will hide the alcohol shopping rule messaging in the Storefront product details page for items containing alcohol.",
                         type: exports.AdminTemplateInputTypes.checkbox,
                         helpLink: "https://mi9retail.atlassian.net/wiki/spaces/FDS/pages/3344302081/Hide+Alcohol+Rule",
                     },
                     modal: {
-                        title: "Disable warning modal",
-                        description: "Disable alcohol warning modal popup.",
+                        title: "Disable alcohol warning modal",
+                        description: "This will hide the alcohol shopping rule warning modal when an item containing alcohol is added to the cart.",
                         type: exports.AdminTemplateInputTypes.checkbox,
                         helpLink: "https://mi9retail.atlassian.net/wiki/spaces/FDS/pages/3344302081/Hide+Alcohol+Rule",
                     },
                     productCard: {
-                        title: "Disable shopping rule label",
-                        description: "Disable alchohol rule label in Product Cards.",
+                        title: "Disable product card messaging for alcohol",
+                        description: "This will hide the alcohol shopping rule messaging in the Storefront product card for items containing alcohol.",
                         type: exports.AdminTemplateInputTypes.checkbox,
                         helpLink: "https://mi9retail.atlassian.net/wiki/spaces/FDS/pages/3344302081/Hide+Alcohol+Rule",
                     },
@@ -644,11 +725,44 @@ exports.AdminSettingsTemplateSFUI = {
             },
         },
     },
-    // pdpSettings: {
-    //   title: "Product Details Page Settings",
-    //   description: "Coming Soon",
-    //   type: AdminTemplateInputTypes.nullObject,
-    // },
+    pdpSettings: {
+        title: "Products",
+        description: "",
+        type: exports.AdminTemplateInputTypes.collapsableObject,
+        value: {
+            externalContent: {
+                title: "External content",
+                description: "",
+                message: {
+                    caption: [
+                        "Display enhanced product content on the product details page.",
+                        "You can change the order providers that the content will appear in.",
+                    ],
+                },
+                type: exports.AdminTemplateInputTypes.collapsableObject,
+                value: {
+                    enabled: {
+                        title: "Enable external content providers",
+                        description: "This will display any available content from the providers listed below on the product details page.",
+                        type: exports.AdminTemplateInputTypes.checkbox,
+                    },
+                    contentProviders: {
+                        title: "",
+                        description: "Allows the user to give the priority of showing content",
+                        type: exports.AdminTemplateInputTypes.array,
+                        value: {
+                            provider: {
+                                title: "Content Provider of External Content",
+                                description: "Allows the user to give type of provider",
+                                type: exports.AdminTemplateInputTypes.dropdown,
+                                uniqueOptions: ["syndigo", "brandbank"],
+                            },
+                        },
+                    },
+                },
+            },
+        },
+    },
     // productCard: {
     //   title: "Product Card Settings",
     //   description: "Coming Soon",
@@ -666,6 +780,12 @@ exports.AdminSettingsTemplateSFUI = {
                 helpLink: "https://mi9retail.atlassian.net/wiki/spaces/FDS/pages/3327983631/clientSideOrderModify",
                 type: exports.AdminTemplateInputTypes.checkbox,
             },
+            advertProductView: {
+                title: "turn advertProductView api call on/off",
+                description: "Sends the api call for advert ProductView when a user opens pdp or pdp modal",
+                helpLink: "https://mi9retail.atlassian.net/wiki/spaces/FDS/pages/3327983631/advertProductView",
+                type: exports.AdminTemplateInputTypes.checkbox,
+            },
             anonymousCart: {
                 title: "Anonymous Cart",
                 description: "⚠️ Allows the customer to add to cart without being logged in.⚠️ (Setting has side effects)",
@@ -682,6 +802,10 @@ exports.AdminSettingsTemplateSFUI = {
                 description: "Time in days to remain signed in in the app",
                 helpLink: "https://mi9retail.atlassian.net/wiki/spaces/FDS/pages/1594065051/Storefront+configuration+-+from+theme+repo",
                 type: exports.AdminTemplateInputTypes.inputNumber,
+                options: {
+                    min: 1,
+                    max: 999,
+                },
             },
             defaultCountry: {
                 title: "Default country",
@@ -704,6 +828,12 @@ exports.AdminSettingsTemplateSFUI = {
                 type: exports.AdminTemplateInputTypes.dropdown,
                 options: ["listView", "mapView"],
             },
+            showChangeCustomerEmail: {
+                title: "Show EDit Customer Email Button",
+                description: "Allows users to change their email address",
+                helpLink: "https://mi9retail.atlassian.net/wiki/spaces/FDS/pages/3708780694/Default+Tab+View",
+                type: exports.AdminTemplateInputTypes.checkbox,
+            },
             disableTprPrice: {
                 title: "Disable TPR Price",
                 description: "Disable the display of tpr pricing",
@@ -799,7 +929,7 @@ exports.AdminSettingsTemplateSFUI = {
             //     },
             //     sections: {
             //       title: "Sections",
-            //       description: "TODO",
+            //       description:
             //       type: AdminTemplateInputTypes.checkbox,
             //     },
             //   },
@@ -844,6 +974,30 @@ exports.AdminSettingsTemplateSFUI = {
                         description: "Force a timeslot selection in order to view checkout",
                         type: exports.AdminTemplateInputTypes.checkbox,
                     },
+                    enableSelectToContinueText: {
+                        title: "Show a message on timeslot selection",
+                        description: "When enabled, a message will be showed to the users to indicate 'something'",
+                        type: exports.AdminTemplateInputTypes.checkbox,
+                    },
+                },
+            },
+            headerLinks: {
+                title: "HeaderLinks",
+                description: "Allows the user to minimize header links icon text for favorites/past purchases/coupon gallery.",
+                helpLink: "https://mi9retail.atlassian.net/wiki/spaces/FDS/pages/3327983631/headerLinks",
+                type: exports.AdminTemplateInputTypes.collapsableObject,
+                group: { id: 1, name: "General Features" },
+                value: {
+                    enabled: {
+                        title: "Enable HeaderLinks settings",
+                        description: "Enable HeaderLinks settings for minimizing header links text",
+                        type: exports.AdminTemplateInputTypes.checkbox,
+                    },
+                    dimension: {
+                        title: "Value for viewport pixel size",
+                        description: "Dimension viewport pixel value at which you want the minimization of header link text to occur",
+                        type: exports.AdminTemplateInputTypes.checkbox,
+                    },
                 },
             },
             // useContentEngineV2Components: {
@@ -852,7 +1006,6 @@ exports.AdminSettingsTemplateSFUI = {
             //   helpLink:
             //     "https://mi9retail.atlassian.net/wiki/spaces/FDS/pages/3478618892/Content+Engine+V2+Components",
             //   type: AdminTemplateInputTypes.object,
-            //   // todo
             //   value: {
             //     HeroBanner: {
             //       description: "Use HeroBanner V2",
@@ -863,6 +1016,47 @@ exports.AdminSettingsTemplateSFUI = {
             //     },
             //   } as any,
             // },
+            scrollToTopButton: {
+                title: "Back to top button",
+                description: "Back to top button settings.",
+                type: exports.AdminTemplateInputTypes.collapsableObject,
+                value: {
+                    enabled: {
+                        title: "Enable back to top button",
+                        description: "You can select whether a back to top button will appear on the Storefront once the customer begins to scroll down the screen.",
+                        type: exports.AdminTemplateInputTypes.checkbox,
+                    },
+                    percentOffset: {
+                        title: "",
+                        description: "",
+                        type: exports.AdminTemplateInputTypes.collapsableObject,
+                        value: {
+                            bottom: {
+                                title: "Offset bottom",
+                                description: "This is the percentage of the height of the screen that the button will appear from the bottom.",
+                                type: exports.AdminTemplateInputTypes.inputNumber,
+                            },
+                            right: {
+                                title: "Offset right",
+                                description: "This is the percentage of the width of the screen that the button will appear from the right.",
+                                type: exports.AdminTemplateInputTypes.inputNumber,
+                            },
+                        },
+                    },
+                },
+            },
+            showShopAllLink: {
+                title: "Shop all link in mega menu",
+                description: "You can select whether each subcategory in the desktop mega menu should have a “Shop All XXX” link at the top of the list.",
+                type: exports.AdminTemplateInputTypes.collapsableObject,
+                value: {
+                    enabled: {
+                        title: "Enable Shop all link in mega menu",
+                        description: 'This will display a "Shop All" link at the top of the list of subcategories in the desktop megamenu as is shown on mobile and tablet.',
+                        type: exports.AdminTemplateInputTypes.checkbox,
+                    },
+                },
+            },
         },
     },
     welcomeModal: {
@@ -893,12 +1087,23 @@ exports.AdminSettingsTemplateSFUI = {
                 title: "Open in",
                 description: "",
                 type: exports.AdminTemplateInputTypes.dropdown,
-                options: ["_blank", "_self", "_parent", "_top"],
+                options: [
+                    {
+                        value: "_blank",
+                        label: "New tab",
+                    },
+                    {
+                        value: "_self",
+                        label: "Same tab",
+                    },
+                ],
             },
             icon: {
                 title: "Icon",
                 description: "",
                 type: exports.AdminTemplateInputTypes.images,
+                options: { requiredFormat: ["svg"] },
+                optional: false,
             },
         },
     },

package/dist/storefront/SFUISharedSettingsTemplate.AdminUi.d.ts

@@ -0,0 +1,4 @@
+import { IAdminTemplateInputTypes } from "../interfaces/admin-settings-interfaces";
+import { IAdminSharedSettingsTemplate } from "../interfaces/shared-settings-interfaces";
+export declare const AdminSharedTemplateInputTypes: IAdminTemplateInputTypes;
+export declare const AdminSharedSettingsTemplateSFUI: IAdminSharedSettingsTemplate;

package/dist/storefront/SFUISharedSettingsTemplate.AdminUi.js

@@ -0,0 +1,168 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AdminSharedSettingsTemplateSFUI = exports.AdminSharedTemplateInputTypes = void 0;
+exports.AdminSharedTemplateInputTypes = {
+    checkbox: "checkbox",
+    collapsableObject: "collapsableObject",
+    color: "color",
+    dropdown: "dropdown",
+    inputChar: "inputChar",
+    inputNumber: "inputNumber",
+    multiDropdown: "multiDropdown",
+    nullObject: "nullObject",
+    object: "object",
+    images: "images",
+    string: "string",
+    array: "array",
+    storeSelection: "storeSelection",
+};
+exports.AdminSharedSettingsTemplateSFUI = {
+    adminPanelOnly: {
+        title: "Retailer Details",
+        description: "Only used to identify the banner in the admin panel",
+        type: exports.AdminSharedTemplateInputTypes.collapsableObject,
+        value: {
+            bannerName: {
+                title: "Retailer Name",
+                description: "Set the banner name here.",
+                type: exports.AdminSharedTemplateInputTypes.inputChar,
+            },
+            logoUrl: {
+                title: "Retailer Logo",
+                description: "Set a logo here to help identify the banner.",
+                type: exports.AdminSharedTemplateInputTypes.images,
+            },
+        },
+    },
+    features: {
+        title: "Shared Features",
+        description: "Global Features for the website and app",
+        type: exports.AdminSharedTemplateInputTypes.collapsableObject,
+        value: {
+            // multilingual: {
+            //   title: "Multilingual",
+            //   description:
+            //     "This will enable the option for customers to select their preferred language for the site.",
+            //   type: AdminSharedTemplateInputTypes.checkbox,
+            // },
+            specialRequestItems: {
+                title: "Special Request Items",
+                description: "",
+                message: {
+                    caption: [
+                        "This will allow customers to add items to their cart that they cannot find in the catalogue",
+                        "Entering a Store ID into the “Exclude stores” field will ensure that this feature will not appear on that store.",
+                    ],
+                },
+                type: exports.AdminSharedTemplateInputTypes.collapsableObject,
+                value: {
+                    enable: {
+                        title: "Display special requests items link",
+                        description: "This will display a link at the bottom of product listing screens.",
+                        helpLink: "https://mi9retail.atlassian.net/wiki/spaces/FDS/pages/3327983631/specialRequestItems",
+                        type: exports.AdminSharedTemplateInputTypes.checkbox,
+                    },
+                    excludeStores: {
+                        title: "Exclude stores",
+                        description: "Allows you to select specific stores you wish to exlude from offering that ability to purchase special request items.",
+                        helpLink: "https://mi9retail.atlassian.net/wiki/spaces/FDS/pages/3327983631/specialRequestItems",
+                        type: exports.AdminSharedTemplateInputTypes.storeSelection,
+                    },
+                },
+            },
+            //TO BE UNCOMMENTED ONCE FEATURE IS COMPLETE
+            // recommendedSubstitutions: {
+            //   title: "Recommended Substitutions",
+            //   description: "",
+            //   message: {
+            //     caption: [
+            //       "This will allow customers to select from a list of substitution items when opting to enabled substitutions for a product.",
+            //       "Entering a Store ID into the stores” field will ensure that this feature will appear on that store.",
+            //     ],
+            //   },
+            //   type: AdminSharedTemplateInputTypes.collapsableObject,
+            //   value: {
+            //     enable: {
+            //       title: "Display recommended substitutions",
+            //       description:
+            //         "This will display a modal with recommended substitutions to the user.",
+            //       helpLink:
+            //         "https://mi9retail.atlassian.net/wiki/spaces/FDS/pages/3327983631/recommendedSubstitutions",
+            //       type: AdminSharedTemplateInputTypes.checkbox,
+            //     },
+            //     stores: {
+            //       title: "Stores",
+            //       description:
+            //         "Allows you to select specific stores you wish to include in offering recommended substitutions.",
+            //       helpLink:
+            //         "https://mi9retail.atlassian.net/wiki/spaces/FDS/pages/3327983631/recommendedSubstitutions",
+            //       type: AdminSharedTemplateInputTypes.storeSelection,
+            //     },
+            //   },
+            // },
+            //TO BE UNCOMMENTED ONCE FEATURE IS COMPLETE
+            // couponGallery: {
+            //   title: "Coupon Gallery",
+            //   description: "",
+            //   type: AdminSharedTemplateInputTypes.collapsableObject,
+            //   value: {
+            //     enabled: {
+            //       title: "Enable coupon gallery",
+            //       description:
+            //         "This will display a fully integrated coupon gallery on the storefront and mobile app.",
+            //       type: AdminSharedTemplateInputTypes.checkbox,
+            //     },
+            //     showClipAllCouponsButton: {
+            //       title: "Show Clip All Coupons Button",
+            //       description:
+            //         "This will display the Clip All Coupons Button in the coupon gallery.",
+            //       type: AdminSharedTemplateInputTypes.checkbox,
+            //     },
+            //   },
+            // }
+        },
+    },
+    checkout: {
+        title: "Checkout",
+        description: "Shared checkout settings",
+        type: exports.AdminSharedTemplateInputTypes.collapsableObject,
+        value: {
+            preserveOrderNote: {
+                title: "Order Instructions",
+                description: "",
+                type: exports.AdminSharedTemplateInputTypes.collapsableObject,
+                value: {
+                    enabled: {
+                        title: "Enable order instructions saving",
+                        description: "This will display a checkbox below the order instrucitons comment box in the checkout. If selected the text entered in the comment box will be saved for the customer next order.",
+                        type: exports.AdminSharedTemplateInputTypes.checkbox,
+                    },
+                },
+            },
+        },
+    },
+    general: {
+        title: "General settings",
+        description: "",
+        type: exports.AdminSharedTemplateInputTypes.collapsableObject,
+        value: {
+            enableStoreSelectorList: {
+                title: "Display list of stores in store selector modal (Planning & Picking)",
+                description: "This will display the list of available stores for the planning and pickup store selector modals prior to the user entering their address.",
+                type: exports.AdminSharedTemplateInputTypes.checkbox,
+            },
+            skipStoreSelection: {
+                title: "Skip store selection",
+                description: "This will skip the enter nearest store modal in the first time user flow if no store is returned. The corporate store will be selected if available otherwise the default store will be used.",
+                type: exports.AdminSharedTemplateInputTypes.checkbox,
+                helpLink: "https://mi9retail.atlassian.net/wiki/spaces/FDS/pages/4039704585/Skip+Nearest+Store+Suggestion",
+            },
+            // addressConfirmationModal: {
+            //   title: "Enable address confirmation modal",
+            //   description:
+            //     "This will display a modal when the customer selects an address from the list of suggestions which will allow them to confirm that they have made the correct selection and complete any remaining required fields. The address finder integration needs to be enabled.",
+            //   type: AdminSharedTemplateInputTypes.checkbox,
+            // },
+        },
+    },
+};

package/dist/storefront/contentEngineComponents.d.ts

@@ -1,23 +1,25 @@
 export declare const CMSComponentNames: {
     Carousel: string;
-    SmallCarousel: string;
-    Freeform: string;
     ContactUs: string;
+    Freeform: string;
     HeroBanner: string;
     Image: string;
-    Video: string;
-    VideoWithContent: string;
-    ImageWithContent: string;
     ImageTextButton: string;
-    SmallPromotion: string;
-    SmallImageWithContent: string;
+    ImageWithContent: string;
     LargePromotion: string;
-    TwoBannerContainer: string;
-    ThreeBannerContainer: string;
+    LayoutExtraLargeBanner2: string;
+    PageTopperWithFullBackground: string;
+    ProductCardStory: string;
+    Recipe: string;
     Sale: string;
     SmallBannerWithBackgroundImage: string;
     SmallBannerWithSupportingImage: string;
-    ProductCardStory: string;
-    Recipe: string;
+    SmallCarousel: string;
+    SmallImageWithContent: string;
+    SmallPromotion: string;
+    ThreeBannerContainer: string;
+    TwoBannerContainer: string;
+    Video: string;
+    VideoWithContent: string;
 };
 export declare type CMSNames = keyof typeof CMSComponentNames;

package/dist/storefront/contentEngineComponents.js

@@ -3,23 +3,25 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.CMSComponentNames = void 0;
 exports.CMSComponentNames = {
     Carousel: "Carousel",
-    SmallCarousel: "CarouselSmall",
-    Freeform: "Freeform",
     ContactUs: "ContactUs",
+    Freeform: "Freeform",
     HeroBanner: "HeroBanner",
     Image: "Image",
-    Video: "Video",
-    VideoWithContent: "VideoWithContent",
-    ImageWithContent: "StandardContentBlock3",
     ImageTextButton: "ImageTextButton",
-    SmallPromotion: "SmallPromotion",
-    SmallImageWithContent: "StackedContentBlock",
+    ImageWithContent: "StandardContentBlock3",
     LargePromotion: "LargePromotion",
-    TwoBannerContainer: "TwoBannerContainer",
-    ThreeBannerContainer: "ThreeBannerContainer",
+    LayoutExtraLargeBanner2: "LayoutExtraLargeBanner2",
+    PageTopperWithFullBackground: "PageTopperWithFullBackground",
+    ProductCardStory: "ProductCardStory",
+    Recipe: "Recipe",
     Sale: "Sale",
     SmallBannerWithBackgroundImage: "StandardContentBlock1",
     SmallBannerWithSupportingImage: "StandardContentBlock2",
-    ProductCardStory: "ProductCardStory",
-    Recipe: "Recipe",
+    SmallCarousel: "CarouselSmall",
+    SmallImageWithContent: "StackedContentBlock",
+    SmallPromotion: "SmallPromotion",
+    ThreeBannerContainer: "ThreeBannerContainer",
+    TwoBannerContainer: "TwoBannerContainer",
+    Video: "Video",
+    VideoWithContent: "VideoWithContent",
 };