@thryveai/theme-interfaces 2.6.8 → 2.7.1

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

@@ -1,48 +1,54 @@
-import { IDefaultCounty, IValidationType } from "./retailer-settings.interfaces";
+import { IDefaultCounty, IValidationType, LinkTarget } from "./retailer-settings.interfaces";
 import { IDefaultColors, IDefaultThemeInterface } from "./default-theme.interface";
+import { IDefaultRetailerSettingsVersion2 } from "./default-settings.interfaces";
+import { IThemeImages } from "./theme.interfaces";
+/**
+ * Helper types
+ */
+export declare type ITemplateObject<T> = {
+    [key in keyof T]: IAdminControl<Flatten<T[key]>>;
+};
+declare type Flatten<Type> = Type extends Array<infer Item> ? Item : Type;
+declare type IPartialKeys<T> = {
+    [key in keyof T]: Partial<T[key]>;
+};
+declare type IAdminAvailableSettings = IPartialKeys<Omit<IDefaultRetailerSettingsVersion2, "pdpSettings" | "productCard">>;
+/** ===== */
+export interface IMessageProps {
+    caption?: string | string[];
+    type?: IMessageTypes;
+    showLabel?: boolean;
+}
+declare type IMessageTypes = "info" | "success" | "note" | "warning" | "error" | "notification";
+export declare type IAdminSettingsTemplate = ITemplateObject<IAdminAvailableSettings>;
 export declare type IAdminTemplateInputTypes = {
     [key in IAdminControlType]: IAdminControlType;
 };
-export interface IAdminSettingsTemplate {
-    adminPanelOnly: IAdminControl;
-    accountPage: IAdminControl;
-    addressSettings: IAdminControl;
-    cartSummary: IAdminControl;
-    checkout: IAdminControl;
-    features: IAdminControl;
-    pdpSettings: IAdminControl;
-    productCard: IAdminControl;
-    siteSettings: IAdminControl;
-}
-export interface IAdminControl {
+export interface IAdminControl<T> {
     title: string;
     description: string;
-    helpLink?: string;
     type: IAdminControlType;
-    options?: string[] | number[] | IDefaultCounty[] | IValidationType[];
-    value?: {
-        [key: string]: IAdminControl;
-    };
+    visible?: boolean;
+    group?: IAdminGroupType;
+    message?: IMessageProps;
+    helpLink?: string;
+    options?: string[] | number[] | IDefaultCounty[] | IValidationType[] | LinkTarget;
+    value?: ITemplateObject<T>;
+}
+export interface IAdminGroupType {
+    id: number;
+    name: string;
 }
-export declare type IAdminControlType = "checkbox" | "collapsableObject" | "color" | "dropdown" | "inputChar" | "inputNumber" | "multiDropdown" | "nullObject" | "object" | "images" | "string";
+export declare type IAdminControlType = "checkbox" | "collapsableObject" | "color" | "dropdown" | "inputChar" | "inputNumber" | "multiDropdown" | "nullObject" | "object" | "images" | "string" | "array";
 export interface IAdminSettingsTemplateSTS {
-    hasEUTerms: IAdminControl;
-    hasTwoStepRegistration: IAdminControl;
-    customTermPolicy: IAdminControl;
-    gtmId: IAdminControl;
+    hasEUTerms: IAdminControl<boolean>;
+    hasTwoStepRegistration: IAdminControl<boolean>;
+    customTermPolicy: IAdminControl<string>;
+    gtmId: IAdminControl<string>;
 }
-export declare type IAdminImagesTemplateSTS = {
-    [key in IAdminImagesKeysSTS]: IAdminControl;
-};
-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 declare type IAdminImagesTemplateSTS = ITemplateObject<IPartialKeys<Pick<IThemeImages, "logos" | "stsCheckBox" | "stsFavicon">>>;
+export declare type IAdminImagesTemplateSFUI = ITemplateObject<IPartialKeys<IThemeImages>>;
+export declare type IAdminThemeTemplateSFUI = ITemplateObject<IPartialKeys<Pick<IDefaultThemeInterface, "colors">>>;
 export interface IAdminThemeTemplateOptions {
     title: string;
     description: string;

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

@@ -1,4 +1,4 @@
-import { IAccountPageSettings, IAccountPageV2, IAddressValidationTypes, IAddressesSettings, IAddressesSettingsV2, IAdminOnlyV2, IAdvertSettings, ICartSummaryV2, ICheckoutSettingsV2, ICheckoutValidation, ICtaButtons, IDefaultCounty, IDefaultSearchParams, IDefaultStoreLocation, IFeatureSwitch, IFeaturesV2, IFlippConfig, IFlippConfigV2, IGlobalAnimations, IGlobalCheckoutProps, IGlobalLayouts, IGoogleAutocompleteSettings, ILayoutSettings, ILoggingLevel, INutritionZone, IPaymentCards, IPdpSettingsV2, IProductCardSettingsV2, IProductCardsProps, IProductDetailsPageLayout, IRegistrationField, IRestrictMapPlaces, IRetailerCountry, ISMSConfig, ISearchPreviewVisibility, ISecondTierAuthorization, ISiteSettings, ISiteSettingsV2, ISodiumWarning, ITimeslotModalSettings } from "./retailer-settings.interfaces";
+import { IAccountPageSettings, IAccountPageV2, IAddressValidationTypes, IAddressesSettings, IAddressesSettingsV2, IAdminOnlyV2, IAdvertSettings, ICartSummaryV2, ICheckoutSettingsV2, ICheckoutValidation, ICtaButtons, IDefaultCounty, IDefaultSearchParams, IDefaultStoreLocation, IFeatureSwitch, IFeaturesV2, IFlippConfig, IFlippConfigV2, IGlobalAnimations, IGlobalCheckoutProps, IGlobalLayouts, IGoogleAutocompleteSettings, ILayoutSettings, ILoggingLevel, INutritionZone, IPaymentCards, IPdpSettingsV2, IProductCardSettingsV2, IProductCardsProps, IProductDetailsPageLayout, IRegistrationField, IRestrictMapPlaces, IRetailerCountry, ISMSConfig, ISearchPreviewVisibility, ISecondTierAuthorization, ISiteSettings, ISiteSettingsV2, ISodiumWarning, ITimeslotModalSettings, IWelcomeModalV2 } from "./retailer-settings.interfaces";
 export interface IDefaultRetailerSettings {
     adminPanelOnly: {
         bannerName: string;
@@ -87,4 +87,5 @@ export interface IDefaultRetailerSettingsVersion2 {
     pdpSettings: IPdpSettingsV2;
     productCard: IProductCardSettingsV2;
     siteSettings: ISiteSettingsV2;
+    welcomeModal: IWelcomeModalV2[];
 }

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

@@ -374,6 +374,12 @@ export interface ISiteSettingsV2 {
     timeslotModalSettings: ITimeslotModalSettings;
     useContentEngineV2Components: IUseContentEngineV2Components;
 }
+export interface IWelcomeModalV2 {
+    label: string;
+    href: string;
+    target: LinkTarget;
+    icon: string;
+}
 export declare type IUseContentEngineV2Components = {
     [key in CMSNames]: boolean;
 };