@thryveai/theme-interfaces 1.4.11 → 1.5.0

package/theme.interfaces.d.ts

@@ -0,0 +1,649 @@
+import { IconNames } from "./icons.interfaces";
+export interface ITheme extends IInitializedEmptyTheme {
+    theme?: IThemeInterface;
+    images?: IThemeImages;
+}
+export declare type IThemeMetadata = IThemeMetadataItem[];
+export declare type IThemeFavicons = IThemeFavicon[];
+export declare type IThemeLogoPosition = "header" | "modal" | "content";
+export declare type IIconPosition = "left" | "right";
+export interface IThemeLogoHeightsProps {
+    desktop?: string;
+    tablet?: string;
+    mobile?: string;
+}
+export declare type IThemeLogoHeights = {
+    [key in IThemeLogoPosition]?: IThemeLogoHeightsProps;
+};
+export interface ISTSThemeInterface {
+    headerHeight?: string;
+}
+export interface IThemeFavicon {
+    rel?: string;
+    sizes?: string;
+    href?: string;
+}
+export interface IThemeMetadataItem {
+    name?: string;
+    content?: string;
+}
+export interface IThemeImages {
+    favicon?: string;
+    logos?: {
+        primary?: string;
+        primaryMobile?: string;
+        secondary?: string;
+        loyaltyCard?: string;
+        sts?: string;
+        stsMobile?: string;
+    };
+    stsCheckBox?: {
+        empty?: string;
+        primary?: string;
+        success?: string;
+    };
+    confirmationPageImage?: string;
+    rewards?: string;
+    missingImg?: {
+        recipes?: string;
+        x2?: string;
+        x3?: string;
+        square?: string;
+    };
+    verifySiteImage?: string;
+    favicons?: IThemeFavicons;
+}
+export interface IThemeInterface {
+    colors?: {
+        brandColors?: IBrandColors;
+        uiColors?: IUiColors;
+    };
+    header?: {
+        topMenu?: INavStyles;
+        mainMenu?: INavStyles;
+        bottomMenu?: INavBottom;
+        mobileMenu?: INavStyles;
+        accountPopover?: {
+            backgroundColor?: string;
+            borderColor?: string;
+            borderRadius?: string;
+            color?: string;
+            links?: {
+                color?: {
+                    static?: string;
+                    hover?: string;
+                    visited?: string;
+                };
+            };
+        };
+        storePopover?: {
+            backgroundColor?: string;
+            activeBackgroundColor?: string;
+            color?: string;
+            activeColor?: string;
+            borderColor?: string;
+            borderRadius?: string;
+            reserveTimeIconPosition?: ITextPosition;
+        };
+        search?: {
+            borderColor?: string;
+            borderRadius?: string;
+            clearBtnColor?: string;
+            searchButton?: {
+                desktop?: {
+                    static?: {
+                        color?: string;
+                        backgroundColor?: string;
+                    };
+                    hover?: {
+                        color?: string;
+                        backgroundColor?: string;
+                    };
+                    clicked?: {
+                        color?: string;
+                        backgroundColor?: string;
+                    };
+                };
+                tablet?: {
+                    static?: {
+                        color?: string;
+                    };
+                    clicked?: {
+                        color?: string;
+                    };
+                };
+                mobile?: {
+                    static?: {
+                        color?: string;
+                    };
+                };
+            };
+            suggestions?: {
+                links?: {
+                    color?: {
+                        static?: string;
+                        hover?: string;
+                        visited?: string;
+                    };
+                };
+            };
+            multisearchBtn?: {
+                static?: {
+                    color?: string;
+                    backgroundColor?: string;
+                };
+                hover?: {
+                    color?: string;
+                    backgroundColor?: string;
+                };
+            };
+        };
+        headerActionLinks?: IHeaderActionLinksProps;
+        headerLinks?: IHeaderLinksProps;
+        departments?: {
+            backgroundColor?: {
+                active?: string;
+                static?: string;
+            };
+            color?: {
+                static?: string;
+                hover?: string;
+            };
+            iconColor?: {
+                static?: string;
+                hover?: string;
+            };
+        };
+        badge?: {
+            cart?: {
+                color?: string;
+                bgColor?: string;
+            };
+        };
+        notifications?: {
+            counter: {
+                backgroundColor?: string;
+            };
+            text?: {
+                color?: string;
+                hoverColor?: string;
+            };
+        };
+    };
+    body?: {
+        fontSize?: string;
+        color?: string;
+        backgroundColor?: string;
+    };
+    footer?: {
+        mainFooter?: INavStyles;
+        bottomFooter?: INavStyles;
+        bottomFooterNavHeaderLink?: INavStyles;
+        mediaIcons?: {
+            color?: string;
+        };
+    };
+    minimalHeader?: {
+        desktop?: IMinimalHeaderProps;
+        mobile?: IMinimalHeaderProps;
+    };
+    subHeaderBoxes?: {
+        backgroundColor?: string;
+        color?: string;
+        contentBorder?: string;
+    };
+    breadcrumb?: {
+        textTransform?: ITextTransform;
+        backgroundColor?: string;
+        color?: string;
+        activeColor?: string;
+        backIconColor?: string;
+    };
+    payment?: {
+        selectedCardBackground?: string;
+        selectedCardColor?: string;
+        summary?: {
+            listItemBackground?: string;
+        };
+        checkoutCards?: ICheckoutCards;
+    };
+    productPage?: {
+        detailsBackgroundColor?: string;
+        badges?: IProductBadges;
+        priceReductionColor?: string;
+        previouslyPurchased?: {
+            color?: string;
+            bgColor?: string;
+        };
+    };
+    accountPage?: {
+        passwordRequirements?: {
+            backgroundColor?: string;
+        };
+    };
+    orderConfirmation?: {
+        iconColor?: string;
+        backgroundColor?: string;
+    };
+    favorites?: {
+        headerIconStyle?: IconNames;
+        productColors?: {
+            static?: ICommonColors;
+            active?: ICommonColors;
+        };
+    };
+    loyaltyCard?: {
+        backgroundColor?: string;
+        borderColor?: string;
+        borderRadius?: string;
+        cardTextColor?: string;
+        dimensions?: ILoyaltyCardDimensions;
+        input?: ILoyaltyCardInput;
+        infoList?: ILoyaltyCardInfoList;
+    };
+    promoBadges?: {
+        backgroundColor?: {
+            promotion?: string;
+            pointsBasedPromo?: string;
+        };
+        fontWeight?: IFontWeights;
+        color?: {
+            promotion?: string;
+            pointsBasedPromo?: string;
+        };
+    };
+    typography?: {
+        webFonts?: string[];
+        embeddedFonts?: IEmbeddedFont[];
+        weights?: {
+            normal?: IFontWeights;
+            bold?: IFontWeights;
+        };
+        text?: {
+            body?: ITextType;
+            fontXS?: ITextType;
+            fontSM?: ITextType;
+            fontMD?: ITextType;
+            fontLG?: ITextType;
+            fontXL?: ITextType;
+        };
+        links?: {
+            static?: ILinkType;
+            hover?: ILinkType;
+            clicked?: ILinkType;
+            visited?: ILinkType;
+        };
+    };
+    buttons?: {
+        globalThemeBorderRadius?: string;
+        globalThemeFontWeight?: IFontWeights;
+        globalThemeFontFamily?: string;
+        primary?: IButtonType;
+        primaryLight?: IButtonType;
+        secondary?: IButtonType;
+        secondaryLight?: IButtonType;
+        tertiary?: IButtonType;
+        iconPosition?: IIconPosition;
+        checkout?: {
+            borderRadius?: string;
+            fontWeight?: IFontWeights;
+            iconColor?: string;
+            textTransform?: ITextTransform;
+            static?: ICheckoutButtonColorType;
+            hover?: ICheckoutButtonColorType;
+            clicked?: ICheckoutButtonColorType;
+            disabled?: ICheckoutButtonColorType;
+        };
+        filterSort?: IFilterSort;
+        quantityStepper?: {
+            borderColor?: string;
+            borderRadius?: string;
+            textTransform?: ITextTransform;
+            numericInput?: {
+                fontWeight?: IFontWeights;
+                fontSize?: string;
+                lineHeight?: string;
+                letterSpacing?: string;
+                static?: {
+                    bgColor?: string;
+                    color?: string;
+                };
+                focused?: {
+                    bgColor?: string;
+                    color?: string;
+                };
+            };
+            plusMinusButtons?: {
+                plusMinusIconBgColor?: string;
+                plusMinusIconColor?: string;
+            };
+        };
+        coupon?: {
+            borderRadius?: string;
+            borderStyle?: "dashed" | "solid";
+            fontWeight?: IFontWeights;
+            static?: IQSButtonColorType;
+            hover?: IQSButtonColorType;
+            clicked?: IQSButtonColorType;
+            clipped?: ICouponClippedBtnColorType;
+        };
+        miniCart?: {
+            textTransform?: ITextTransform;
+            backgroundColor?: string;
+            borderRadius?: string;
+            activeBackgroundColor?: string;
+            hoverBackgroundColor?: string;
+            color?: string;
+            activeColor?: string;
+            mobileColor?: string;
+            iconColor?: string;
+            activeIconColor?: string;
+            mobileIconColor?: string;
+            tabletIconColor?: string;
+            desktopIconSize?: string;
+            mobileIconSize?: string;
+        };
+        addToCart?: {
+            borderRadius?: string;
+            fontWeight?: IFontWeights;
+            textTransform?: ITextTransform;
+            static?: IAddToCartButton;
+            hover?: IAddToCartButton;
+            clicked?: IAddToCartButton;
+            disabled?: IAddToCartButton;
+        };
+        pills?: {
+            borderRadius?: string;
+            textTransform?: ITextTransform;
+            active?: IPillButtons;
+            small?: IPillButtons;
+            regular?: IPillButtons;
+        };
+        facets?: {
+            borderRadius?: string;
+            textTransform?: ITextTransform;
+            fontWeight?: IFontWeights;
+            active?: IFacets;
+            small?: IFacets;
+            regular?: IFacets;
+        };
+        sliderArrows?: {
+            backgroundColor?: string;
+            sideBorderColor?: string;
+            iconColor?: string;
+        };
+        activeAddress?: {
+            backgroundColor?: string;
+            borderColor?: string;
+        };
+        timeSlotPaginationDay?: {
+            selected?: {
+                backgroundColor?: string;
+            };
+        };
+    };
+    carousel?: {
+        bannerBackgroundColor?: string;
+        carouselPagination?: {
+            dotBackground?: string;
+            activeDotBackground?: string;
+            wrapperBackground?: string;
+            wrapperHeight?: string;
+        };
+        carouselArrows?: {
+            borderRadius?: string;
+            backgroundColor?: string;
+            activeBackgroundColor?: string;
+            iconColor?: string;
+            buttonDimension?: number;
+        };
+    };
+    modal?: {
+        header?: {
+            mobileBackgroundColor?: string;
+        };
+        storeIcon?: {
+            bgColor?: string;
+            borderColor?: string;
+            color?: string;
+            hoverBGColor?: string;
+            hoverBorderColor?: string;
+            iconColor?: string;
+        };
+    };
+    selectedOption?: {
+        bgColor?: string;
+    };
+    input?: {
+        borderRadius?: string;
+        static?: IInputFields;
+        hover?: IInputFields;
+        focus?: IInputFields;
+        disabled?: IInputFields;
+    };
+    productGrid?: {
+        borderColor?: string;
+    };
+    checkoutStepColors?: {
+        active?: string;
+        default?: string;
+        disabled?: string;
+    };
+    logoHeight?: IThemeLogoHeights;
+    stsThemeStyles?: ISTSThemeInterface;
+    stsLogoWidth?: string;
+    globalAnimations?: IThemeGlobalAnimations;
+    metadata?: IThemeMetadata;
+    scripts?: IThemeScripts;
+}
+export interface IThemeScripts {
+    [key: string]: string;
+}
+interface IInputFields {
+    bgColor?: string;
+    borderColor?: string;
+    color?: string;
+    placeholderColor?: string;
+}
+interface ICouponClippedBtnColorType extends IQSButtonColorType {
+    clippedIconColor?: string;
+}
+interface IButtonType {
+    borderRadius?: string;
+    clicked?: IButtonColorType;
+    disabled?: IButtonColorType;
+    fontWeight?: IFontWeights;
+    hover?: IButtonColorType;
+    static?: IButtonColorType;
+    textTransform?: ITextTransform;
+}
+declare type ITextTransform = "none" | "capitalize" | "uppercase" | "lowercase" | "initial" | "inherit";
+declare type ITextPosition = "left" | "center" | "right";
+interface IFilterSort extends ICommonColors {
+    borderRadius?: string;
+}
+interface ICommonColors {
+    color?: string;
+    hoverColor?: string;
+}
+interface IQSButtonColorType {
+    bgColor?: string;
+    borderColor?: string;
+    color?: string;
+    couponIconColor?: string;
+}
+interface ICheckoutButtonColorType {
+    bgColor?: string;
+    borderColor?: string;
+    color?: string;
+}
+interface IButtonColorType {
+    bgColor?: string;
+    borderColor?: string;
+    color?: string;
+    iconColor?: string;
+}
+interface ITextType {
+    color?: string;
+    fontFamily?: string;
+    fontSize?: string;
+    fontWeight?: IFontWeights;
+    capitalization?: ITextTransform;
+    lineHeight?: string;
+    letterSpacing?: string;
+}
+interface ILinkType {
+    color?: string;
+    textDecoration?: "none" | "underline";
+}
+export interface IGlobalTheme {
+    BorderRadius?: string;
+    FontFamily?: string;
+    FontWeight?: IFontWeights;
+    FontWeightBold?: IFontWeights;
+    HeadlineFontFamily?: string;
+    HeadlineFontWeight?: IFontWeights;
+    baseFontSize?: string;
+    bodyFontColor?: string;
+    bodyBackgroundColor?: string;
+}
+export declare type IColors = IBrandColors & IUiColors;
+interface IBrandColors {
+    primary1?: string;
+    primary2?: string;
+    primary3?: string;
+    primary4?: string;
+    primary5?: string;
+    secondary1?: string;
+    secondary2?: string;
+    secondary3?: string;
+    secondary4?: string;
+    secondary5?: string;
+    tertiary1?: string;
+    tertiary2?: string;
+    tertiary3?: string;
+    tertiary4?: string;
+    tertiary5?: string;
+}
+interface IUiColors {
+    success?: string;
+    successDark?: string;
+    successLight?: string;
+    warn?: string;
+    warnDark?: string;
+    warnLight?: string;
+    alert?: string;
+    alertDark?: string;
+    alertLight?: string;
+    promotion1?: string;
+    promotion2?: string;
+    greyscale1?: string;
+    greyscale2?: string;
+    greyscale3?: string;
+    greyscale4?: string;
+    greyscale5?: string;
+    greyscale6?: string;
+    greyscale7?: string;
+}
+export interface IInitializedEmptyTheme {
+    exports?: any;
+}
+declare type IFontWeights = "normal" | "bold" | "bolder" | "lighter" | number | "initial" | "inherit";
+interface INavBottom extends INavStyles {
+    hoverColor?: string;
+    textTransform?: ITextTransform;
+    fontWeight?: IFontWeights;
+}
+interface INavStyles {
+    color?: string;
+    backgroundColor?: string;
+    links?: {
+        static?: ILinkType;
+        hover?: ILinkType;
+        clicked?: ILinkType;
+        visited?: ILinkType;
+    };
+}
+interface INavActiveColors {
+    activeColor?: string;
+    activeBackgroundColor?: string;
+}
+interface IHeaderLinksProps extends INavStyles, INavActiveColors {
+    fontWeight?: IFontWeights;
+    borderRadius?: string;
+}
+interface IHeaderActionLinksProps extends IHeaderLinksProps {
+    fontFamily?: string;
+}
+interface IMinimalHeaderProps extends INavStyles {
+    iconColor?: string;
+}
+interface IAddToCartButton {
+    bgColor?: string;
+    borderColor?: string;
+    color?: string;
+    iconColor?: string;
+}
+interface IFacets extends IPillButtons {
+    iconColor?: string;
+}
+interface IPillButtons {
+    fontWeight?: IFontWeights;
+    fontWeightHover?: IFontWeights;
+    color?: string;
+    colorHover?: string;
+    colorVisited?: string;
+    backgroundColor?: string;
+    borderColor?: string;
+    borderColorSelected?: string;
+    textDecoration?: "none" | "underline";
+    textDecorationHover?: "none" | "underline";
+    padding?: string;
+}
+interface IProductBadges {
+    borderRadius?: string;
+}
+interface ICheckoutCards {
+    borderRadius?: string;
+}
+interface ILoyaltyCardDimensions {
+    width?: number;
+    height?: number;
+}
+interface ILoyaltyCardIdFields {
+    staticBorder?: string;
+    hoverBorder?: string;
+    activeBorder?: string;
+    errorBorder?: string;
+}
+interface ILoyaltyCardInput {
+    borderRadius?: string;
+    backgroundColor?: string;
+    borderColor?: string;
+    idFields?: ILoyaltyCardIdFields;
+}
+interface ILoyaltyCardInfoList {
+    color?: string;
+    borderColor?: string;
+}
+export declare type IThemeAnimationsConfettiPlacesTypes = "successModals";
+export interface IThemeGlobalAnimations {
+    confettiAnimation?: IThemeAnimationConfettiPlaces;
+}
+export declare type IThemeAnimationConfettiPlaces = {
+    [key in IThemeAnimationsConfettiPlacesTypes]?: IThemeAnimationsConfettiProps;
+};
+export interface IThemeAnimationsConfettiProps {
+    colors?: string[];
+}
+export interface IEmbeddedFont {
+    fontFamily?: string;
+    sourceSet?: IEmbeddedFontSource[];
+    fontWeight?: number;
+    fontStyle?: string;
+}
+export interface IEmbeddedFontSource {
+    url?: string;
+    format?: string;
+}
+export {};

package/.eslintignore

@@ -1,46 +0,0 @@
-# dependencies
-/node_modules
-
-# testing
-/coverage
-
-# production
-/build
-/build_server
-/build_ts
-/oidc-storage
-/dist
-/lib
-
-# output files
-/default-theme.interface.d.ts
-/theme.interfaces.d.ts
-/index.d.ts
-/icons.interfaces.d.ts
-/retailer-settings.interfaces.d.ts
-
-# misc
-.DS_Store
-.env.local
-.env.development.local
-.env.test.local
-.env.production.local
-
-npm-debug.log*
-yarn-debug.log*
-yarn-error.log*
-yarn-lock
-
-# editor configs
-.vscode
-.idea
-
-
-package-lock.json
-/yarn.lock
-.gitignore
-/src
-
-*.tgz
-*.lock
-*.orig

package/.eslintrc.js

@@ -1,35 +0,0 @@
-module.exports = {
-  env: {
-    browser: true,
-    es2021: true
-  },
-  extends: ['prettier'],
-  parser: '@typescript-eslint/parser',
-  parserOptions: {
-    ecmaFeatures: {
-      jsx: true
-    },
-    ecmaVersion: 13,
-    sourceType: 'module'
-  },
-  plugins: ['eslint-plugin-prettier', 'prettier'],
-  rules: {
-    'prettier/prettier': ['error'],
-    'sort-imports': [
-      'error',
-      {
-        allowSeparatedGroups: false,
-        ignoreCase: false,
-        ignoreDeclarationSort: false,
-        ignoreMemberSort: false,
-        memberSyntaxSortOrder: ['none', 'all', 'multiple', 'single']
-      }
-    ],
-    'sort-keys': [
-      'error',
-      'asc',
-      { caseSensitive: true, minKeys: 2, natural: false }
-    ],
-    'sort-vars': ['error', { ignoreCase: true }]
-  }
-};