@thryveai/theme-interfaces 2.2.1 → 2.3.0-beta

package/dist/index.d.ts

@@ -1,21 +1,25 @@
-import { IAdminTemplateInputTypes, IAdminSettingsTemplate, IAdminSettingsTemplateSTS, IAdminImagesTemplateSFUI, IAdminImagesTemplateSTS, IAdminControl, IAdminControlType } from "./interfaces/admin-settings-interfaces";
-import { IAdminImagesControls, ISecondaryFaviconType } from "./interfaces/admin-images-interfaces";
-import { IDefaultRetailerSettings } from "./interfaces/default-settings.interfaces";
-import { IDefaultStsSettings } from "./interfaces/sts-settings.interfaces";
-import DefaultConfigSFUI from "./Storefront/defaultSettingsStorefront";
-import DefaultImagesSFUI from "./Storefront/defaultImagesStorefront";
+import DefaultImagesSFUI from './storefront/defaultImagesStorefront';
+import DefaultConfigSFUI from "./storefront/defaultSettingsStorefront";
+import DefaultThemeSFUI, { globalTheme, DefaultThemeColors } from "./storefront/defaultThemeStorefront";
 import DefaultConfigSTS from "./sts/defaultSettingsSts";
-import { AdminTemplateInputTypes, AdminSettingsTemplateSFUI } from "./Storefront/SFUISettingsTemplate.AdminUi";
+import { AdminTemplateInputTypes, AdminSettingsTemplateSFUI } from "./storefront/SFUISettingsTemplate.AdminUi";
 import { AdminSettingsTemplateSTS } from "./sts/STSSettingsTemplate.AdminUi";
 import { AdminImagesTemplateSFUI } from "./storefront/SFUIImagesTemplate.AdminUi";
+import { AdminThemeTemplateSFUI, AdminThemeTemplateOptions } from "./storefront/SFUIThemesTemplate.AdminUi";
 import { AdminImagesTemplateSTS } from "./sts/STSImagesTemplate.AdminUi";
+import { IconNamesToFiles } from "./interfaces/icons.interfaces";
+import AllThemeTemplates from '../src/theme-templates';
+import { IAdminTemplateInputTypes, IAdminSettingsTemplate, IAdminSettingsTemplateSTS, IAdminImagesTemplateSFUI, IAdminThemeTemplateSFUI, IAdminThemeTemplateOptions, IAdminImagesTemplateSTS, IAdminControl, IAdminControlType, IThemeGenerator } from "./interfaces/admin-settings-interfaces";
+import { IAdminImagesControls, ISecondaryFaviconType } from "./interfaces/admin-images-interfaces";
+import { IDefaultRetailerSettings } 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 } from "./interfaces/retailer-settings.interfaces";
-import { IIconsObject, PaymentTypesLogos, PaymentCards, IconNames, IconNamesToFiles } from "./interfaces/icons.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, IInitializedEmptyDefaultTheme, IDefaultThemeAnimationConfettiPlaces, IDefaultThemeGlobalAnimations, IDefaultThemeAnimationsConfettiPlacesTypes, IDefaultThemeAnimationsConfettiProps, IDefaultEmbeddedFont, IDefaultEmbeddedFontSource, IIconPosition } from "./interfaces/default-theme.interface";
-export { DefaultConfigSFUI, DefaultConfigSTS, DefaultImagesSFUI, AdminSettingsTemplateSFUI, AdminSettingsTemplateSTS, AdminTemplateInputTypes, AdminImagesTemplateSFUI, AdminImagesTemplateSTS };
-export { IAdminTemplateInputTypes, IAdminSettingsTemplate, IAdminSettingsTemplateSTS, IAdminControl, IAdminControlType, IAdminImagesTemplateSFUI, IAdminImagesTemplateSTS, IAdminImagesControls, ISecondaryFaviconType };
+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";
+export { DefaultConfigSFUI, DefaultConfigSTS, AllThemeTemplates, DefaultThemeSFUI, globalTheme, DefaultThemeColors, DefaultImagesSFUI, AdminSettingsTemplateSFUI, AdminSettingsTemplateSTS, AdminTemplateInputTypes, AdminImagesTemplateSFUI, AdminThemeTemplateSFUI, AdminThemeTemplateOptions, AdminImagesTemplateSTS, IconNamesToFiles };
+export { IAdminTemplateInputTypes, IAdminSettingsTemplate, IAdminSettingsTemplateSTS, IAdminControl, IAdminControlType, IThemeGenerator, IAdminImagesTemplateSFUI, IAdminImagesTemplateSTS, IAdminThemeTemplateSFUI, IAdminThemeTemplateOptions, IAdminImagesControls, ISecondaryFaviconType };
 export { IDefaultRetailerSettings, IDefaultStsSettings };
-export { IDefaultTheme, IDefaultThemeScripts, IDefaultThemeImages, IDefaultThemeMetadata, IDefaultThemeFavicons, IDefaultThemeLogoPosition, IDefaultThemeLogoHeightsProps, IDefaultThemeLogoHeights, ISTSDefaultThemeInterface, IDefaultThemeFavicon, IDefaultThemeMetadataItem, IDefaultThemeInterface, IGlobalDefaultTheme, IDefaultColors, 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, IconNamesToFiles, };
+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, ICouponGalleryLayout, IPageAdvertsRow, IScreenType, IProductCardLayoutObjects, IProductCardILayoutVersions, IProductCardILayoutTypes, IAdvertsData, };

package/dist/index.js

@@ -1,20 +1,29 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.IconNamesToFiles = exports.AdminImagesTemplateSTS = exports.AdminImagesTemplateSFUI = exports.AdminTemplateInputTypes = exports.AdminSettingsTemplateSTS = exports.AdminSettingsTemplateSFUI = exports.DefaultImagesSFUI = exports.DefaultConfigSTS = exports.DefaultConfigSFUI = void 0;
-var defaultSettingsStorefront_1 = require("./Storefront/defaultSettingsStorefront");
-exports.DefaultConfigSFUI = defaultSettingsStorefront_1.default;
-var defaultImagesStorefront_1 = require("./Storefront/defaultImagesStorefront");
+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");
+exports.DefaultConfigSFUI = defaultSettingsStorefront_1.default;
+var defaultThemeStorefront_1 = require("./storefront/defaultThemeStorefront");
+exports.DefaultThemeSFUI = defaultThemeStorefront_1.default;
+Object.defineProperty(exports, "globalTheme", { enumerable: true, get: function () { return defaultThemeStorefront_1.globalTheme; } });
+Object.defineProperty(exports, "DefaultThemeColors", { enumerable: true, get: function () { return defaultThemeStorefront_1.DefaultThemeColors; } });
 var defaultSettingsSts_1 = require("./sts/defaultSettingsSts");
 exports.DefaultConfigSTS = defaultSettingsSts_1.default;
-var SFUISettingsTemplate_AdminUi_1 = require("./Storefront/SFUISettingsTemplate.AdminUi");
+var SFUISettingsTemplate_AdminUi_1 = require("./storefront/SFUISettingsTemplate.AdminUi");
 Object.defineProperty(exports, "AdminTemplateInputTypes", { enumerable: true, get: function () { return SFUISettingsTemplate_AdminUi_1.AdminTemplateInputTypes; } });
 Object.defineProperty(exports, "AdminSettingsTemplateSFUI", { enumerable: true, get: function () { return SFUISettingsTemplate_AdminUi_1.AdminSettingsTemplateSFUI; } });
 var STSSettingsTemplate_AdminUi_1 = require("./sts/STSSettingsTemplate.AdminUi");
 Object.defineProperty(exports, "AdminSettingsTemplateSTS", { enumerable: true, get: function () { return STSSettingsTemplate_AdminUi_1.AdminSettingsTemplateSTS; } });
 var SFUIImagesTemplate_AdminUi_1 = require("./storefront/SFUIImagesTemplate.AdminUi");
 Object.defineProperty(exports, "AdminImagesTemplateSFUI", { enumerable: true, get: function () { return SFUIImagesTemplate_AdminUi_1.AdminImagesTemplateSFUI; } });
+var SFUIThemesTemplate_AdminUi_1 = require("./storefront/SFUIThemesTemplate.AdminUi");
+Object.defineProperty(exports, "AdminThemeTemplateSFUI", { enumerable: true, get: function () { return SFUIThemesTemplate_AdminUi_1.AdminThemeTemplateSFUI; } });
+Object.defineProperty(exports, "AdminThemeTemplateOptions", { enumerable: true, get: function () { return SFUIThemesTemplate_AdminUi_1.AdminThemeTemplateOptions; } });
 var STSImagesTemplate_AdminUi_1 = require("./sts/STSImagesTemplate.AdminUi");
 Object.defineProperty(exports, "AdminImagesTemplateSTS", { enumerable: true, get: function () { return STSImagesTemplate_AdminUi_1.AdminImagesTemplateSTS; } });
 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("../src/theme-templates");
+exports.AllThemeTemplates = theme_templates_1.default;

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

@@ -1,4 +1,5 @@
 import { IDefaultCounty, IValidationType } from "./retailer-settings.interfaces";
+import { IDefaultColors, IDefaultThemeInterface } from "./default-theme.interface";
 export declare type IAdminTemplateInputTypes = {
     [key in IAdminControlType]: IAdminControlType;
 };
@@ -71,6 +72,21 @@ export declare type IAdminImagesTemplateSTS = {
 export declare type IAdminImagesTemplateSFUI = {
     [key in IAdminImagesKeys]: IAdminControl;
 };
+export declare type IAdminThemeTemplateSFUI = {
+    [key in IAdminThemeKeys]: IAdminControl;
+};
+declare type IAdminThemeKeys = 'colors';
 declare type IAdminImagesKeysSTS = "logos" | "stsCheckBox" | "stsFavicon";
 declare type IAdminImagesKeys = "icons" | "logos" | "confirmationPageImage" | "stsCheckBox" | "stsFavicon" | "favicon" | "rewards" | "verifySiteImage" | "missingImg";
+export interface IAdminThemeTemplateOptions {
+    title: string;
+    description: string;
+    options: string[];
+    helpLink: string;
+}
+export declare type IAllThemeTemplates = {
+    [key in SupportThemeTemplates]: IThemeGenerator;
+};
+declare type SupportThemeTemplates = 'Default' | 'PriceRite';
+export declare type IThemeGenerator = (colors: IDefaultColors) => IDefaultThemeInterface;
 export {};

package/dist/interfaces/default-theme.interface.d.ts

@@ -515,7 +515,7 @@ export interface IGlobalDefaultTheme {
     bodyBackgroundColor: string;
 }
 export declare type IDefaultColors = IBrandColors & IUiColors;
-interface IBrandColors {
+export interface IBrandColors {
     primary1: string;
     primary2: string;
     primary3: string;
@@ -532,7 +532,7 @@ interface IBrandColors {
     tertiary4: string;
     tertiary5: string;
 }
-interface IUiColors {
+export interface IUiColors {
     success: string;
     successDark: string;
     successLight: string;

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

@@ -0,0 +1,3 @@
+import { IAdminThemeTemplateOptions, IAdminThemeTemplateSFUI } from "../interfaces/admin-settings-interfaces";
+export declare const AdminThemeTemplateSFUI: IAdminThemeTemplateSFUI;
+export declare const AdminThemeTemplateOptions: IAdminThemeTemplateOptions;

package/dist/storefront/SFUIThemesTemplate.AdminUi.js

@@ -0,0 +1,53 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AdminThemeTemplateOptions = exports.AdminThemeTemplateSFUI = void 0;
+var SFUISettingsTemplate_AdminUi_1 = require("./SFUISettingsTemplate.AdminUi");
+exports.AdminThemeTemplateSFUI = {
+    colors: {
+        title: "Colors",
+        description: "",
+        type: SFUISettingsTemplate_AdminUi_1.AdminTemplateInputTypes.object,
+        value: {
+            uiColors: {
+                title: "UI Colors",
+                description: "This is the logo used on desktop in the storefront and most other apps",
+                type: SFUISettingsTemplate_AdminUi_1.AdminTemplateInputTypes.collapsableObject,
+                value: {
+                    alert: {
+                        title: "Alert",
+                        description: "This is the logo used on mobile in the storefront and most other apps",
+                        type: SFUISettingsTemplate_AdminUi_1.AdminTemplateInputTypes.color,
+                    },
+                    alertDark: {
+                        title: "Alert Dark",
+                        description: "This is the logo used on mobile in the storefront and most other apps",
+                        type: SFUISettingsTemplate_AdminUi_1.AdminTemplateInputTypes.color,
+                    },
+                }
+            },
+            brandColors: {
+                title: "Brand Colors",
+                description: "This is the logo used on desktop in the storefront and most other apps",
+                type: SFUISettingsTemplate_AdminUi_1.AdminTemplateInputTypes.collapsableObject,
+                value: {
+                    primary1: {
+                        title: "Primary1",
+                        description: "This is the logo used on mobile in the storefront and most other apps",
+                        type: SFUISettingsTemplate_AdminUi_1.AdminTemplateInputTypes.color,
+                    },
+                    primary2: {
+                        title: "Primary2",
+                        description: "This is the logo used on mobile in the storefront and most other apps",
+                        type: SFUISettingsTemplate_AdminUi_1.AdminTemplateInputTypes.color,
+                    },
+                }
+            },
+        },
+    }
+};
+exports.AdminThemeTemplateOptions = {
+    title: 'Retailer Theme Template',
+    description: 'Please read the documentation before selecting a template.',
+    helpLink: 'https://mi9retail.atlassian.net/wiki/spaces/FDS/pages/3304521749/Admin+UI+Themes',
+    options: ['Default', 'PriceRite'],
+};

package/dist/{Storefront → storefront}/defaultImagesStorefront.js

@@ -2,7 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 var imageBucket = "https://www";
 var DefaultImagesSFUI = {
-    icons: "".concat(imageBucket, "/icons.js"),
+    icons: "/assets/icons.js",
     logos: {
         primary: "".concat(imageBucket, "/img/primary-logo.png"),
         primaryMobile: "".concat(imageBucket, "/img/primary-logo.png"),

package/dist/storefront/defaultThemeStorefront.d.ts

@@ -0,0 +1,5 @@
+import { IDefaultColors, IDefaultThemeInterface, IGlobalDefaultTheme } from "../interfaces/default-theme.interface";
+declare const DefaultThemeSFUI: (colors?: IDefaultColors) => IDefaultThemeInterface;
+export default DefaultThemeSFUI;
+export declare const globalTheme: IGlobalDefaultTheme;
+export declare const DefaultThemeColors: IDefaultColors;