@goldenhippo/builder-cart-schemas 0.1.0

package/dist/data/index.d.ts

@@ -0,0 +1,604 @@
+import { BuilderResponseBaseData, ModelShape } from '@goldenhippo/builder-types';
+import { BuilderContent } from '@builder.io/sdk';
+
+declare enum HeaderType {
+    BASIC = "BASIC",
+    MEDIUM = "MEDIUM",
+    MEGA = "MEGA",
+    NONE = "NONE",
+    DMP = "DMP"
+}
+interface BasicHeaderLink {
+    title: string;
+    href: string;
+    newTab: boolean;
+    cssClasses: string[];
+}
+declare enum BasicHeaderCTAType {
+    PRIMARY = "primary",
+    SECONDARY = "secondary",
+    OUTLINE = "outline",
+    LINK = "link"
+}
+declare enum MediumHeaderDropdownType {
+    SEARCH = "search",
+    LINKS = "links",
+    ACCOUNT_LINKS = "accountLinks",
+    HTML = "html",
+    TIMED_HTML = "timedHtml"
+}
+declare enum MediumHeaderDesktopContentType {
+    LINKS = "links",
+    LOGO = "logo",
+    ACCOUNT_LINKS = "accountLinks",
+    CART_COUNT = "cartCount",
+    HTML = "html"
+}
+
+declare enum FooterType {
+    BASIC = "BASIC",
+    MEGA = "MEGA",
+    NONE = "NONE"
+}
+
+declare enum ProductGridFilterType {
+    DROPDOWN = "Dropdown",
+    STACKED_LIST = "Stacked List"
+}
+declare enum ProductLinkPrefix {
+    P = "/p",
+    PRODUCT = "/product"
+}
+
+declare enum SubscriptionCancelReasons {
+    DoNotLike = "DoNotLike",
+    NotWorking = "NotWorking",
+    NoBenefits = "NoBenefits",
+    NoFitNoNeed = "NoFitNoNeed",
+    Budget = "Budget",
+    Mistake = "Mistake",
+    Try = "Try",
+    TooMuch = "TooMuch",
+    TravelMove = "TravelMove",
+    DoNotNeed = "DoNotNeed",
+    AnotherReason = "AnotherReason",
+    NotHelpingSkin = "NotHelpingSkin",
+    SkinImproved = "SkinImproved",
+    PetDoesNotLike = "PetDoesNotLike",
+    NotHelpingPet = "NotHelpingPet",
+    NoneGiven = "NoneGiven"
+}
+declare enum SubscriptionCancelButtonType {
+    Link = "link",
+    Update = "update",
+    Keep = "keep",
+    Continue = "continue",
+    Cancel = "cancel"
+}
+
+declare const createBrandConfigModel: (gridFilterModelId: string, bannerModelId: string) => ModelShape;
+type BuilderBrandConfigContent = BuilderContent & Partial<{
+    data: BuilderResponseBaseData & {
+        brandDisplayName: string;
+        images: {
+            brandLogoSmall: string;
+            brandLogoLarge: string;
+            brandLogoFooter: string;
+            bbbImage: string;
+        };
+        links: {
+            termsLink: string;
+            subscriptionTermsLink: string;
+            privacyLink: string;
+            supportLink: string;
+            ccpaLink: string;
+            bbbLink: string;
+            accessibilityLink: string;
+            socialMedia: {
+                twitter: string;
+                facebook: string;
+                youtube: string;
+                instagram: string;
+                pinterest: string;
+                tiktok: string;
+            };
+        };
+        banners: {
+            banner: {
+                id: string;
+                name: string;
+            };
+            alwaysShow: boolean;
+        }[];
+        header: {
+            headerType: HeaderType;
+            basicHeaderConfig?: {
+                logoImage: string;
+                mobileLinks: BasicHeaderLink[];
+                desktopLinks: BasicHeaderLink[];
+                ctas: {
+                    title: string;
+                    href: string;
+                    type: BasicHeaderCTAType;
+                    newTab: boolean;
+                    cssClasses: string[];
+                    hideOnMobile: boolean;
+                }[];
+                myAccountGuest: BasicHeaderLink & {
+                    icon: string;
+                }[];
+                myAccountAuthorized: BasicHeaderLink & {
+                    icon: string;
+                };
+                stickyHeader: {
+                    enabled: boolean;
+                    backgroundColor: string;
+                    scrollBackgroundColor: string;
+                    scrollLogo: string;
+                };
+                showLocaleSelection: boolean;
+            };
+            mediumHeaderConfig?: {
+                wrapperID: string;
+                wrapperClasses: string;
+                showShippingMessage: boolean;
+                mobileMenu: {
+                    logo: string;
+                    logoClasses: string;
+                    navClasses: string;
+                    dropDownWrapperClasses: string;
+                    dropDownContent: {
+                        type: MediumHeaderDropdownType;
+                        links: {
+                            itemClasses: string;
+                            loggedInOnly: boolean;
+                            loggedOutOnly: boolean;
+                            text: string;
+                            URL: string;
+                            subLinksWrapperClasses: string;
+                            subLinks: {
+                                text: string;
+                                URL: string;
+                            }[];
+                        }[];
+                        htmlContent: string;
+                        inputs: {
+                            defaultHtml: string;
+                            temporaryHtml: string;
+                            startTime: number;
+                            endTime: number;
+                        };
+                    }[];
+                };
+                desktopMenu: {
+                    logo: string;
+                    navClasses: string;
+                    content: {
+                        type: MediumHeaderDesktopContentType;
+                        wrapperClasses: string;
+                        links: {
+                            text: string;
+                            URL: string;
+                            loggedInOnly: boolean;
+                            loggedOutOnly: boolean;
+                            dropdownWrapperClasses: string;
+                            dropdownItemClasses: string;
+                            subLinks: {
+                                columnHeaderTitle: string;
+                                columnContentType: string;
+                                links: {
+                                    text: string;
+                                    URL: string;
+                                }[];
+                                content: string;
+                                inputs: {
+                                    defaultHtml: string;
+                                    temporaryHtml: string;
+                                    startTime: number;
+                                    endTime: number;
+                                };
+                            };
+                        }[];
+                        htmlContent: string;
+                    }[];
+                };
+                bannersAboveHeader: {
+                    wrapperClasses: string;
+                    content: string;
+                }[];
+                contactUrl: string;
+            };
+            megaMenuConfig?: {
+                showShippingMessage: boolean;
+                mobileLinks: {
+                    title: string;
+                    href: string;
+                    expanded: boolean;
+                    links: {
+                        title: string;
+                        href: string;
+                    }[];
+                }[];
+                desktopShopNavLinks: {
+                    title: string;
+                    links: {
+                        title: string;
+                        href: string;
+                    }[];
+                    shopAllLink: {
+                        title: string;
+                        href: string;
+                    };
+                }[];
+            };
+            dmpHeaderConfig?: {
+                logoImage: string;
+                mobileLinks: {
+                    title: string;
+                    href: string;
+                }[];
+                desktopLinks: {
+                    title: string;
+                    href: string;
+                }[];
+            };
+        };
+        footer: {
+            footerType: FooterType;
+        };
+        features: {
+            productGridFilterType: ProductGridFilterType;
+            productGridFilterGroups: {
+                filterConfig: {
+                    id: string;
+                };
+            }[];
+            productGridHideRestricted: boolean;
+            productLinkPrefix: ProductLinkPrefix;
+            subscriptionAddOnsEnabled: boolean;
+            shippingThresholdNotificationEnabled: boolean;
+            bundlingEnabled: boolean;
+        };
+        support: {
+            email: string;
+            phone: string;
+            phoneDisplay: string;
+            address: {
+                street: string;
+                city: string;
+                state: string;
+                zipcode: string;
+            };
+            addressString: string;
+        };
+        pageConfig: {
+            accountDetails: {
+                birthdayBannerConfig: {
+                    content: string;
+                    linkText: string;
+                    linkUrl: string;
+                    styles: {
+                        display: string;
+                        alignItems: string;
+                        margin: string;
+                        padding: string;
+                        backgroundColor: string;
+                        color: string;
+                    };
+                };
+            };
+            cart: {
+                continueShoppingUrl: string;
+                imageContainerBGColor: string;
+                freeShippingBanner: {
+                    isVisible: boolean;
+                    loggedOutBannerContent: string;
+                    loggedInBannerContent: string;
+                    styles: {
+                        backgroundColor: string;
+                        color: string;
+                    };
+                };
+                notices: {
+                    securePaymentNotice: {
+                        isVisible: boolean;
+                        text: string;
+                        styles: {
+                            backgroundColor: string;
+                            color: string;
+                        };
+                    };
+                };
+            };
+            checkout: {
+                freeShippingBanner: {
+                    isVisible: boolean;
+                    loggedOutBannerContent: string;
+                    loggedInBannerContent: string;
+                };
+                securePaymentNotice: {
+                    isVisible: boolean;
+                    content: string;
+                };
+                autoSignUp: {
+                    isVisible: boolean;
+                    isChecked: boolean;
+                    labelText: string;
+                    helpModal: {
+                        header: string;
+                        content: string;
+                    };
+                };
+                smsOptIn: {
+                    isVisible: boolean;
+                    title: string;
+                    content: string;
+                };
+            };
+            orderDetails: {
+                title: string;
+                tableHeaderStyle: {
+                    backgroundColor: string;
+                    color: string;
+                };
+                tableContentStyle: {
+                    backgroundColor: string;
+                };
+                buyItAgainButton: {
+                    text: string;
+                    classes: string;
+                };
+                reOrderAllButton: {
+                    text: string;
+                    classes: string;
+                };
+            };
+            resetPassword: {
+                title: string;
+            };
+            subscriptionCancel: {
+                cancelText: string;
+                cancelReasons: {
+                    title: string;
+                    text: string;
+                    identifier: SubscriptionCancelReasons;
+                    buttons: {
+                        text: string;
+                        link: string;
+                        type: SubscriptionCancelButtonType;
+                    }[];
+                }[];
+            };
+            subscriptionEdit: {
+                subscriptionItemDefaultImage: string;
+                shipNow: {
+                    modalHeadlineContent: string;
+                    modalContent: string;
+                };
+            };
+            upsell: {
+                mbgImage: string;
+                mbgText: string;
+            };
+        };
+        cookieConfig: {
+            popupBanner: {
+                content: string;
+                bannerStyles: {
+                    backgroundColor: string;
+                    borderRadius: string;
+                };
+                buttonStyles: {
+                    backgroundColor: string;
+                    color: string;
+                };
+            };
+        };
+    };
+}>;
+
+declare const createBlogCategoryModel: () => ModelShape;
+type BuilderBlogCategoryContent = BuilderContent & Partial<{
+    data: BuilderResponseBaseData & {
+        name: string;
+        description?: string;
+        slug: string;
+        parentId?: string;
+    };
+}>;
+
+declare const createBlogCommentModel: (pageModelId: string) => ModelShape;
+type BuilderBlogCommentContent = BuilderContent & Partial<{
+    data: BuilderResponseBaseData & {
+        name: string;
+        date: string;
+        status: 'Pending Approval' | 'Approved' | 'Rejected';
+        email?: string;
+        comment: string;
+        language: string;
+        locale: string;
+        parentId?: string;
+        internal?: boolean;
+        blog: {
+            id: string;
+            name: string;
+        };
+    };
+}>;
+
+interface ProductModelProps {
+    ingredientsModelId: string;
+    categoryModelId: string;
+    tagModelId: string;
+    useCaseModelId: string;
+}
+declare const createProductModel: (request: ProductModelProps) => ModelShape;
+type BuilderProductContent = BuilderContent & Partial<{
+    data: {
+        name: string;
+        displayName: string;
+        featuredImage?: string;
+        secondaryImage?: string;
+        subHeading?: string;
+        gridTagline?: string;
+        gridDescription?: string;
+        shortDescription?: string;
+        quote?: string;
+        packagingLabels?: {
+            singular: string;
+            plural: string;
+        };
+        hidden?: boolean;
+        outOfStock?: boolean;
+        cartOutOfStock?: boolean;
+        upc?: string;
+        reviews?: {
+            id: string;
+            count: number;
+            averageRating: number;
+        };
+        tags?: {
+            tag: {
+                name: string;
+                displayName: string;
+            };
+        }[];
+        categories?: {
+            category: {
+                name: string;
+                displayName: string;
+            };
+        }[];
+        ingredients?: {
+            ingredient: {
+                name: string;
+                displayName: string;
+            };
+        }[];
+        useCases?: {
+            useCase: {
+                name: string;
+                displayName: string;
+            };
+        }[];
+        gh: {
+            slug: string;
+            productionId: string;
+            type: 'Product' | 'Bundle' | 'Trial Size';
+        };
+    } & BuilderResponseBaseData;
+}>;
+
+declare enum ProductGroupType {
+    FlavorOptionGroup = "Flavor/Option Group",
+    TrialGroup = "Trial Group"
+}
+declare const createProductGroupModel: (productModelId: string) => ModelShape;
+type BuilderProductGroupContent = BuilderContent & Partial<{
+    data: BuilderResponseBaseData & {
+        displayName: string;
+        featuredImage?: string;
+        subHeading?: string;
+        gridTagline?: string;
+        shortDescription?: string;
+        products: {
+            product: string;
+            displayName?: string;
+            isTrialSize?: boolean;
+        }[];
+        selectionLabel?: string;
+        hidden?: boolean;
+        gh?: {
+            productionId?: string;
+            slug?: string;
+        };
+        groupType?: ProductGroupType;
+        name: string;
+    };
+}>;
+
+declare const createCategoryModel: () => ModelShape;
+type BuilderProductCategoryContent = BuilderContent & Partial<{
+    data: BuilderResponseBaseData & {
+        name: string;
+        description?: string;
+        desktopImage?: string;
+        mobileImage?: string;
+        hidden?: boolean;
+        slug?: string;
+        searchKeys?: string[];
+    };
+}>;
+
+interface ProductFilterModels {
+    categoryId: string;
+    useCaseId: string;
+    ingredientId: string;
+    tagId: string;
+}
+declare enum FilterApplicationType {
+    Inclusive = "Inclusive",
+    Exclusive = "Exclusive"
+}
+declare const createProductGridConfigModel: (models: ProductFilterModels) => ModelShape;
+type BuilderProductGridFilterGroupContent = BuilderContent & Partial<{
+    data: BuilderResponseBaseData & {
+        displayName: string;
+        categories: {
+            category: {
+                id: string;
+            } & Record<string, any>;
+        }[];
+        ingredients: {
+            ingredient: {
+                id: string;
+            } & Record<string, any>;
+        }[];
+        useCases: {
+            useCase: {
+                id: string;
+            } & Record<string, any>;
+        }[];
+        tags: {
+            tag: {
+                id: string;
+            } & Record<string, any>;
+        }[];
+        filterApplicationType: FilterApplicationType;
+    };
+}>;
+
+declare const createIngredientsModel: () => ModelShape;
+type BuilderIngredientContent = BuilderContent & Partial<{
+    data: BuilderResponseBaseData & {
+        name: string;
+        description?: string;
+        image?: string;
+        shortDescription?: string;
+        searchKeys?: string[];
+    };
+}>;
+
+declare const createProductTagModel: () => ModelShape;
+type BuilderProductTagContent = BuilderContent & Partial<{
+    data: BuilderResponseBaseData & {
+        name: string;
+        tagColor: string;
+        hidden?: boolean;
+        image?: string;
+        pluralDisplayName?: string;
+    };
+}>;
+
+declare const createProductUseCaseModel: () => ModelShape;
+type BuilderProductUseCaseContent = BuilderContent & Partial<{
+    data: BuilderResponseBaseData & {
+        name: string;
+        description?: string;
+        searchKeys?: string[];
+        image?: string;
+        hidden?: boolean;
+    };
+}>;
+
+export { type BuilderBlogCategoryContent, type BuilderBlogCommentContent, type BuilderBrandConfigContent, type BuilderIngredientContent, type BuilderProductCategoryContent, type BuilderProductContent, type BuilderProductGridFilterGroupContent, type BuilderProductGroupContent, type BuilderProductTagContent, type BuilderProductUseCaseContent, createBlogCategoryModel, createBlogCommentModel, createBrandConfigModel, createCategoryModel, createIngredientsModel, createProductGridConfigModel, createProductGroupModel, createProductModel, createProductTagModel, createProductUseCaseModel };