@thryveai/theme-interfaces 2.4.11 → 2.4.13

package/README.md

@@ -1,29 +1,29 @@
-#V8 Theme Interfaces 
-
-interfaces for all MI9 Retailer Themes.
-
-###icons.interfaces
-List of all icons used inside the ui projects.
-
-###retailer-settings.interfaces
-more info here
-https://mi9retail.atlassian.net/wiki/spaces/FDS/pages/1594065051/Storefront+configuration+-+from+theme+repo
-###theme.interfaces
-The interface for each theme, colors, fonts, sizes and other css properties.
-
-#To Build Project
-
-```
-npm install
-npm run build
-```
-
-#To Publish npm package
-```
-npm login
-npm publish
-```
-or
-```
-npm run push
-```
+#V8 Theme Interfaces 
+
+interfaces for all MI9 Retailer Themes.
+
+###icons.interfaces
+List of all icons used inside the ui projects.
+
+###retailer-settings.interfaces
+more info here
+https://mi9retail.atlassian.net/wiki/spaces/FDS/pages/1594065051/Storefront+configuration+-+from+theme+repo
+###theme.interfaces
+The interface for each theme, colors, fonts, sizes and other css properties.
+
+#To Build Project
+
+```
+npm install
+npm run build
+```
+
+#To Publish npm package
+```
+npm login
+npm publish
+```
+or
+```
+npm run push
+```

package/dist/index.d.ts

@@ -13,13 +13,15 @@ import { IAdminTemplateInputTypes, IAdminSettingsTemplate, IAdminSettingsTemplat
 import { IAdminImagesControls, ISecondaryFaviconType } from "./interfaces/admin-images-interfaces";
 import { IDefaultRetailerSettingsVersion2 } from "./interfaces/default-settings.interfaces";
 import { IDefaultStsSettings } from "./interfaces/sts-settings.interfaces";
-import { IAdvertsData, PdpDetailsElementLayout, IScreenType, IProductCardLayoutObjects, IProductCardILayoutVersions, IProductCardILayoutTypes, ISearchPreview, IRetailerSettings, ISecondTierAuthorization, IFlippConfig, IFlippConfigV2, IFlippScriptUrls, IAllSettings, ISMSConfig, ICtaButtons, IAddressesSettings, IAccountPageSettings, ILayoutSettings, ILoggingLevel, IDefaultSearchParams, IDefaultStoreLocation, IDefaultCounty, IRetailerCountry, IRestrictMapPlaces, IValidationType, INutritionZone, IFooterTypes, IRegistrationFieldTypes, IRegistrationFieldNames, IValidateLength, IValidateMultipleLengths, IValidateDateRange, IRegistrationField, ICheckoutValidation, ISearchPreviewVisibility, IPaymentCards, IGlobalAnimations, ILayoutAnimationsConfetti, IGlobalCheckoutProps, IAddressIntegration, IAddressFinderType, IAdvertLeaderboards, IAdvertProductGrid, IAdvertSkyScrapers, IPageNamesForAdverts, IAddressValidationTypes, IAdvertSettings, IGoogleAutocompleteSettings, ITimeslotModalSettings, ISodiumWarning, IProductCardsProps, IProductDetailsPageLayout, ICartSummaryLayout, ISmartBanner, ICouponGalleryLayout, IPageAdvertsRow, IEntryModalVersion, IShoppingRuleControl, IAdminOnlyV2, IAccountPageV2, IAddressesSettingsV2, ICartSummaryV2, ICheckoutSettingsV2, IFeaturesV2, IPdpSettingsV2, IProductCardSettingsV2, ISiteSettingsV2 } from "./interfaces/retailer-settings.interfaces";
+import { IAdvertsData, PdpDetailsElementLayout, IScreenType, IProductCardLayoutObjects, IProductCardILayoutVersions, IProductCardILayoutTypes, ISearchPreview, IRetailerSettings, ISecondTierAuthorization, IFlippConfig, IFlippConfigV2, IFlippScriptUrls, IAllSettings, ISMSConfig, ICtaButtons, IAddressesSettings, IAccountPageSettings, ILayoutSettings, ILoggingLevel, IDefaultSearchParams, IDefaultStoreLocation, IDefaultCounty, IRetailerCountry, IRestrictMapPlaces, IValidationType, INutritionZone, IFooterTypes, IRegistrationFieldTypes, IRegistrationFieldNames, IValidateLength, IValidateMultipleLengths, IValidateDateRange, IRegistrationField, ICheckoutValidation, ISearchPreviewVisibility, IPaymentCards, IGlobalAnimations, ILayoutAnimationsConfetti, IGlobalCheckoutProps, IAddressIntegration, IAddressFinderType, IAdvertLeaderboards, IAdvertProductGrid, IAdvertSkyScrapers, IPageNamesForAdverts, IAddressValidationTypes, IAdvertSettings, IGoogleAutocompleteSettings, ITimeslotModalSettings, ISodiumWarning, IProductCardsProps, IProductDetailsPageLayout, ICartSummaryLayout, ISmartBanner, ICouponGalleryLayout, IPageAdvertsRow, IEntryModalVersion, IShoppingRuleControl, IAdminOnlyV2, IAccountPageV2, IAddressesSettingsV2, ICartSummaryV2, ICheckoutSettingsV2, IFeaturesV2, IPdpSettingsV2, IProductCardSettingsV2, ISiteSettingsV2, IUseContentEngineV2Components } from "./interfaces/retailer-settings.interfaces";
 import { IIconsObject, PaymentTypesLogos, PaymentCards, IconNames } from "./interfaces/icons.interfaces";
 import { ITheme, IThemeScripts, IThemeImages, IThemeMetadata, IThemeFavicons, IThemeLogoPosition, IThemeLogoHeightsProps, IThemeLogoHeights, ISTSThemeInterface, IThemeFavicon, IThemeMetadataItem, IThemeInterface, IGlobalTheme, IColors, IInitializedEmptyTheme, IThemeAnimationConfettiPlaces, IThemeGlobalAnimations, IThemeAnimationsConfettiPlacesTypes, IThemeAnimationsConfettiProps, IEmbeddedFont, IEmbeddedFontSource } from "./interfaces/theme.interfaces";
 import { IDefaultTheme, IDefaultThemeScripts, IDefaultThemeImages, IDefaultThemeMetadata, IDefaultThemeFavicons, IDefaultThemeLogoPosition, IDefaultThemeLogoHeightsProps, IDefaultThemeLogoHeights, ISTSDefaultThemeInterface, IDefaultThemeFavicon, IDefaultThemeMetadataItem, IDefaultThemeInterface, IGlobalDefaultTheme, IDefaultColors, IBrandColors, IUiColors, IInitializedEmptyDefaultTheme, IDefaultThemeAnimationConfettiPlaces, IDefaultThemeGlobalAnimations, IDefaultThemeAnimationsConfettiPlacesTypes, IDefaultThemeAnimationsConfettiProps, IDefaultEmbeddedFont, IDefaultEmbeddedFontSource, IIconPosition } from "./interfaces/default-theme.interface";
+import { CMSComponentNames, CMSNames } from "./storefront/contentEngineComponents";
 export { DefaultConfigSFUI, DefaultConfigSTS, AllThemeTemplates, DefaultThemeSFUI, globalTheme, DefaultThemeColors, DefaultImagesSFUI, AdminSettingsTemplateSFUI, AdminSettingsTemplateSTS, AdminTemplateInputTypes, AdminImagesTemplateSFUI, AdminThemeTemplateSFUI, AdminThemeTemplateOptions, AdminImagesTemplateSTS, IconNamesToFiles, };
+export { CMSComponentNames, CMSNames };
 export { IAdminTemplateInputTypes, IAdminSettingsTemplate, IAdminSettingsTemplateSTS, IAdminControl, IAdminControlType, IThemeGenerator, IAdminImagesTemplateSFUI, IAdminImagesTemplateSTS, IAdminThemeTemplateSFUI, IAdminThemeTemplateOptions, IAdminImagesControls, ISecondaryFaviconType, };
 export { IDefaultRetailerSettingsVersion2, IDefaultStsSettings };
 export { IDefaultTheme, IDefaultThemeScripts, IDefaultThemeImages, IDefaultThemeMetadata, IDefaultThemeFavicons, IDefaultThemeLogoPosition, IDefaultThemeLogoHeightsProps, IDefaultThemeLogoHeights, ISTSDefaultThemeInterface, IDefaultThemeFavicon, IDefaultThemeMetadataItem, IDefaultThemeInterface, IGlobalDefaultTheme, IDefaultColors, IBrandColors, IUiColors, IInitializedEmptyDefaultTheme, IDefaultThemeAnimationConfettiPlaces, IDefaultThemeGlobalAnimations, IDefaultThemeAnimationsConfettiPlacesTypes, IDefaultThemeAnimationsConfettiProps, IDefaultEmbeddedFont, IDefaultEmbeddedFontSource, ITheme, IThemeScripts, IThemeImages, IThemeMetadata, IThemeFavicons, IThemeLogoPosition, IThemeLogoHeightsProps, IThemeLogoHeights, ISTSThemeInterface, IThemeFavicon, IThemeMetadataItem, IThemeInterface, IGlobalTheme, IColors, IInitializedEmptyTheme, IThemeAnimationConfettiPlaces, IThemeGlobalAnimations, IThemeAnimationsConfettiPlacesTypes, IThemeAnimationsConfettiProps, IEmbeddedFont, IEmbeddedFontSource, IIconPosition, };
 export { IIconsObject, PaymentTypesLogos, PaymentCards, IconNames };
-export { PdpDetailsElementLayout, ISearchPreview, IRetailerSettings, ISecondTierAuthorization, IFlippConfig, IFlippConfigV2, IFlippScriptUrls, IAllSettings, ISMSConfig, ICtaButtons, IAddressesSettings, IAccountPageSettings, ILayoutSettings, ILoggingLevel, IDefaultSearchParams, IDefaultStoreLocation, IDefaultCounty, IRetailerCountry, IRestrictMapPlaces, IValidationType, INutritionZone, IFooterTypes, IRegistrationFieldTypes, IRegistrationFieldNames, IValidateLength, IValidateMultipleLengths, IValidateDateRange, IRegistrationField, ICheckoutValidation, ISearchPreviewVisibility, IPaymentCards, IGlobalAnimations, ILayoutAnimationsConfetti, IGlobalCheckoutProps, IAddressIntegration, IAddressFinderType, IAdvertLeaderboards, IAdvertProductGrid, IAdvertSkyScrapers, IPageNamesForAdverts, IAddressValidationTypes, IAdvertSettings, IGoogleAutocompleteSettings, ITimeslotModalSettings, ISodiumWarning, IProductCardsProps, IProductDetailsPageLayout, ICartSummaryLayout, ISmartBanner, IEntryModalVersion, IShoppingRuleControl, ICouponGalleryLayout, IPageAdvertsRow, IScreenType, IProductCardLayoutObjects, IProductCardILayoutVersions, IProductCardILayoutTypes, IAdvertsData, IAdminOnlyV2, IAccountPageV2, IAddressesSettingsV2, ICartSummaryV2, ICheckoutSettingsV2, IFeaturesV2, IPdpSettingsV2, IProductCardSettingsV2, ISiteSettingsV2, };
+export { PdpDetailsElementLayout, ISearchPreview, IRetailerSettings, ISecondTierAuthorization, IFlippConfig, IFlippConfigV2, IFlippScriptUrls, IAllSettings, ISMSConfig, ICtaButtons, IAddressesSettings, IAccountPageSettings, ILayoutSettings, ILoggingLevel, IDefaultSearchParams, IDefaultStoreLocation, IDefaultCounty, IRetailerCountry, IRestrictMapPlaces, IValidationType, INutritionZone, IFooterTypes, IRegistrationFieldTypes, IRegistrationFieldNames, IValidateLength, IValidateMultipleLengths, IValidateDateRange, IRegistrationField, ICheckoutValidation, ISearchPreviewVisibility, IPaymentCards, IGlobalAnimations, ILayoutAnimationsConfetti, IGlobalCheckoutProps, IAddressIntegration, IAddressFinderType, IAdvertLeaderboards, IAdvertProductGrid, IAdvertSkyScrapers, IPageNamesForAdverts, IAddressValidationTypes, IUseContentEngineV2Components, IAdvertSettings, IGoogleAutocompleteSettings, ITimeslotModalSettings, ISodiumWarning, IProductCardsProps, IProductDetailsPageLayout, ICartSummaryLayout, ISmartBanner, IEntryModalVersion, IShoppingRuleControl, ICouponGalleryLayout, IPageAdvertsRow, IScreenType, IProductCardLayoutObjects, IProductCardILayoutVersions, IProductCardILayoutTypes, IAdvertsData, IAdminOnlyV2, IAccountPageV2, IAddressesSettingsV2, ICartSummaryV2, ICheckoutSettingsV2, IFeaturesV2, IPdpSettingsV2, IProductCardSettingsV2, ISiteSettingsV2, };

package/dist/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.IconNamesToFiles = exports.AdminImagesTemplateSTS = exports.AdminThemeTemplateOptions = exports.AdminThemeTemplateSFUI = exports.AdminImagesTemplateSFUI = exports.AdminTemplateInputTypes = exports.AdminSettingsTemplateSTS = exports.AdminSettingsTemplateSFUI = exports.DefaultImagesSFUI = exports.DefaultThemeColors = exports.globalTheme = exports.DefaultThemeSFUI = exports.AllThemeTemplates = exports.DefaultConfigSTS = exports.DefaultConfigSFUI = void 0;
+exports.CMSComponentNames = exports.IconNamesToFiles = exports.AdminImagesTemplateSTS = exports.AdminThemeTemplateOptions = exports.AdminThemeTemplateSFUI = exports.AdminImagesTemplateSFUI = exports.AdminTemplateInputTypes = exports.AdminSettingsTemplateSTS = exports.AdminSettingsTemplateSFUI = exports.DefaultImagesSFUI = exports.DefaultThemeColors = exports.globalTheme = exports.DefaultThemeSFUI = exports.AllThemeTemplates = exports.DefaultConfigSTS = exports.DefaultConfigSFUI = void 0;
 var defaultImagesStorefront_1 = require("./storefront/defaultImagesStorefront");
 exports.DefaultImagesSFUI = defaultImagesStorefront_1.default;
 var defaultSettingsStorefront_1 = require("./storefront/defaultSettingsStorefront");
@@ -27,3 +27,5 @@ var icons_interfaces_1 = require("./interfaces/icons.interfaces");
 Object.defineProperty(exports, "IconNamesToFiles", { enumerable: true, get: function () { return icons_interfaces_1.IconNamesToFiles; } });
 var theme_templates_1 = require("./theme-templates");
 exports.AllThemeTemplates = theme_templates_1.default;
+var contentEngineComponents_1 = require("./storefront/contentEngineComponents");
+Object.defineProperty(exports, "CMSComponentNames", { enumerable: true, get: function () { return contentEngineComponents_1.CMSComponentNames; } });

package/dist/interfaces/retailer-settings.interfaces.d.ts

@@ -1,3 +1,4 @@
+import { CMSNames } from "../storefront/contentEngineComponents";
 import { IconNames, PaymentCards } from "./icons.interfaces";
 export interface IRetailerSettings {
     accountPage?: IAccountPageSettings;
@@ -163,6 +164,8 @@ export interface IFlippConfigV2 {
     merchantId: string;
     accessToken: string;
     zoom: number;
+    locale: string;
+    hideHeader: boolean;
 }
 export declare type IFlippScriptUrls = "circulars.priceritemarketplace" | "circulars.dearbornmarket" | "flyers.v8.commerce.mi9cloud" | "flyers.stg.v8.mywebgrocer" | "flyers.saveonfoods";
 export declare type IAllSettings = {
@@ -343,7 +346,11 @@ export interface ISiteSettingsV2 {
     searchPreview: ISearchPreviewVisibility;
     subHeaderHeight: number;
     timeslotModalSettings: ITimeslotModalSettings;
+    useContentEngineV2Components: IUseContentEngineV2Components;
 }
+export declare type IUseContentEngineV2Components = {
+    [key in CMSNames]: boolean;
+};
 export interface IAccountPageSettings {
     loyaltyTab: {
         disabledEdit?: boolean;
@@ -483,8 +490,8 @@ export interface IProductCardsProps {
     };
 }
 export declare type IProductCardLayouts = {
-    ContainersGrid: "default";
-    ContainersCarousel: "default";
+    ContainersGrid: "default" | "pce-centered";
+    ContainersCarousel: "default" | "pce-centered";
 };
 export declare type IProductCardLayoutObjects<T> = {
     [Place in keyof IProductCardLayouts]: {

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

@@ -1,3 +1,14 @@
-import { IAdminSettingsTemplate, IAdminTemplateInputTypes } from "../interfaces/admin-settings-interfaces";
+import { IAdminControlType, IAdminSettingsTemplate, IAdminTemplateInputTypes } from "../interfaces/admin-settings-interfaces";
+import { CMSNames } from "./contentEngineComponents";
 export declare const AdminTemplateInputTypes: IAdminTemplateInputTypes;
+export declare type IUseContentEngineV2ComponentsAdmin = {
+    [key in CMSNames]: IContentEngineAdminTypes;
+};
+interface IContentEngineAdminTypes {
+    title: string;
+    description: string;
+    helpLink: string;
+    type: IAdminControlType;
+}
 export declare const AdminSettingsTemplateSFUI: IAdminSettingsTemplate;
+export {};

package/dist/storefront/SFUISettingsTemplate.AdminUi.js

@@ -235,6 +235,16 @@ var FeatureSettingsChildren = {
                 type: exports.AdminTemplateInputTypes.dropdown,
                 options: [100, 95, 90, 85, 80, 75, 70, 65, 60],
             },
+            locale: {
+                title: "Locale",
+                description: "The locale of flipp flyers",
+                type: exports.AdminTemplateInputTypes.inputChar,
+            },
+            hideHeader: {
+                title: "hideHeader",
+                description: "Setting to toggle visibility of the flipp navigation header",
+                type: exports.AdminTemplateInputTypes.checkbox,
+            },
         },
     },
     smartbanner: {
@@ -306,6 +316,14 @@ var FeatureSettingsChildren = {
         },
     },
 };
+var ContentEngineV2Components = {
+    HeroBanner: {
+        description: "Use HeroBanner V2",
+        helpLink: "https://mi9retail.atlassian.net/wiki/spaces/FDS/pages/3478946114/Hero+Banner",
+        title: "Enable HeroBanner V2 component",
+        type: "checkbox",
+    },
+};
 var SiteSettingsChildren = {
     anonymousCart: {
         title: "Anonymous Cart",
@@ -439,6 +457,13 @@ var SiteSettingsChildren = {
             },
         },
     },
+    useContentEngineV2Components: {
+        title: "Use Content Engine V2 Components",
+        description: "(work in progress)",
+        helpLink: "https://mi9retail.atlassian.net/wiki/spaces/FDS/pages/3478618892/Content+Engine+V2+Components",
+        type: exports.AdminTemplateInputTypes.object,
+        value: ContentEngineV2Components,
+    },
 };
 var AccountPageSettingsChildren = {
     loyaltyTab: {

package/dist/storefront/contentEngineComponents.d.ts

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

package/dist/storefront/contentEngineComponents.js

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

package/dist/storefront/defaultSettingsStorefront.js

@@ -251,6 +251,28 @@ var DefaultConfigSFUI = {
             timeslotRequiredToAddToCart: false,
             timeslotRequiredToViewCartReview: false,
         },
+        useContentEngineV2Components: {
+            Carousel: false,
+            SmallCarousel: false,
+            Freeform: false,
+            ContactUs: false,
+            HeroBanner: false,
+            Image: false,
+            Video: false,
+            VideoWithContent: false,
+            ImageWithContent: false,
+            ImageTextButton: false,
+            SmallPromotion: false,
+            SmallImageWithContent: false,
+            LargePromotion: false,
+            TwoBannerContainer: false,
+            ThreeBannerContainer: false,
+            Sale: false,
+            SmallBannerWithBackgroundImage: false,
+            SmallBannerWithSupportingImage: false,
+            ProductCardStory: false,
+            Recipe: false,
+        },
     },
 };
 exports.default = DefaultConfigSFUI;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@thryveai/theme-interfaces",
-  "version": "2.4.11",
+  "version": "2.4.13",
   "description": "Shared interfaces and defaults for all Wynshop themed apps.",
   "scripts": {
     "build": "tsc",