@usethrottle/catalog 1.3.0 → 1.4.0

package/dist/{contract-types-BRyonOYH.d.cts → contract-types-D2-SSPM9.d.cts}

@@ -151,6 +151,15 @@ type StorefrontConfigAnswer = {
         extensionId: string;
     };
     generation: number;
+    settings: StorefrontSettings;
+    filters: StorefrontFilterDefinition[];
+    settingsVersion: number;
+};
+type StorefrontFilterDefinition = {
+    key: string;
+    label: string;
+    display: 'checkbox' | 'swatch' | 'range' | 'boolean' | 'dropdown';
+    source: string;
 };
 type StorefrontFilterValuesAnswer = {
     key: string;
@@ -392,6 +401,32 @@ type StorefrontListProduct = {
     supersededBy?: string[] | undefined;
     supersedes?: string[] | undefined;
 };
+type StorefrontMenuItem = {
+    label: string;
+    target: {
+        kind: 'category' | 'collection' | 'page' | 'product' | 'search' | 'url';
+        handle?: string | undefined;
+        q?: string | undefined;
+        href?: string | undefined;
+    };
+    children?: StorefrontMenuItem[] | undefined;
+};
+type StorefrontPageAnswer = {
+    handle: string;
+    title: string;
+    bodyHtml: string;
+    seo: {
+        title: string;
+        description: string;
+    };
+};
+type StorefrontPagesAnswer = {
+    pages: {
+        handle: string;
+        title: string;
+        position: number;
+    }[];
+};
 type StorefrontProductAnswer = {
     product: {
         handle: string;
@@ -549,6 +584,199 @@ type StorefrontReviewsAnswer = ({
 }) | ({
     redirectTo: string;
 });
+type StorefrontSettings = {
+    storefrontId: 'default';
+    brand: {
+        storeName: string;
+        logo: {
+            light: {
+                id: string;
+                url: string;
+            } | null;
+            dark: {
+                id: string;
+                url: string;
+            } | null;
+        };
+        favicon: {
+            id: string;
+            url: string;
+        } | null;
+    };
+    theme: {
+        light: {
+            colorPrimary: string;
+            colorPrimaryForeground: string;
+            colorBackground: string;
+            colorSurface: string;
+            colorForeground: string;
+            colorMuted: string;
+            colorMutedForeground: string;
+            colorBorder: string;
+            colorBorderControl: string;
+            colorAccent: string;
+            colorSale: string;
+            colorSuccess: string;
+            colorWarning: string;
+            colorDanger: string;
+        };
+        dark: {
+            colorPrimary: string;
+            colorPrimaryForeground: string;
+            colorBackground: string;
+            colorSurface: string;
+            colorForeground: string;
+            colorMuted: string;
+            colorMutedForeground: string;
+            colorBorder: string;
+            colorBorderControl: string;
+            colorAccent: string;
+            colorSale: string;
+            colorSuccess: string;
+            colorWarning: string;
+            colorDanger: string;
+        };
+        fonts: {
+            heading: 'Instrument Serif' | 'Playfair Display' | 'Lora' | 'Merriweather' | 'Cormorant Garamond' | 'EB Garamond' | 'Libre Baskerville' | 'Source Serif 4' | 'Fraunces' | 'DM Serif Display' | 'Inter' | 'Schibsted Grotesk' | 'DM Sans' | 'Manrope' | 'Poppins' | 'Montserrat' | 'Work Sans' | 'Rubik' | 'Nunito Sans' | 'Open Sans' | 'Lato' | 'Raleway' | 'Outfit' | 'Plus Jakarta Sans' | 'Figtree' | 'Karla' | 'DM Mono' | 'JetBrains Mono' | 'IBM Plex Mono' | 'Space Mono' | 'Bebas Neue' | 'Oswald' | 'Archivo Black' | 'Space Grotesk' | 'Syne' | 'system-sans' | 'system-serif' | 'system-mono';
+            body: 'Instrument Serif' | 'Playfair Display' | 'Lora' | 'Merriweather' | 'Cormorant Garamond' | 'EB Garamond' | 'Libre Baskerville' | 'Source Serif 4' | 'Fraunces' | 'DM Serif Display' | 'Inter' | 'Schibsted Grotesk' | 'DM Sans' | 'Manrope' | 'Poppins' | 'Montserrat' | 'Work Sans' | 'Rubik' | 'Nunito Sans' | 'Open Sans' | 'Lato' | 'Raleway' | 'Outfit' | 'Plus Jakarta Sans' | 'Figtree' | 'Karla' | 'DM Mono' | 'JetBrains Mono' | 'IBM Plex Mono' | 'Space Mono' | 'Bebas Neue' | 'Oswald' | 'Archivo Black' | 'Space Grotesk' | 'Syne' | 'system-sans' | 'system-serif' | 'system-mono';
+            mono: 'Instrument Serif' | 'Playfair Display' | 'Lora' | 'Merriweather' | 'Cormorant Garamond' | 'EB Garamond' | 'Libre Baskerville' | 'Source Serif 4' | 'Fraunces' | 'DM Serif Display' | 'Inter' | 'Schibsted Grotesk' | 'DM Sans' | 'Manrope' | 'Poppins' | 'Montserrat' | 'Work Sans' | 'Rubik' | 'Nunito Sans' | 'Open Sans' | 'Lato' | 'Raleway' | 'Outfit' | 'Plus Jakarta Sans' | 'Figtree' | 'Karla' | 'DM Mono' | 'JetBrains Mono' | 'IBM Plex Mono' | 'Space Mono' | 'Bebas Neue' | 'Oswald' | 'Archivo Black' | 'Space Grotesk' | 'Syne' | 'system-sans' | 'system-serif' | 'system-mono';
+        };
+        radius: number;
+        spacingScale: 'compact' | 'comfortable' | 'roomy';
+        colorScheme: 'light' | 'dark' | 'auto';
+    };
+    navigation: {
+        header: StorefrontMenuItem[];
+        footer: StorefrontMenuItem[];
+    };
+    home: {
+        hero: {
+            image: {
+                id: string;
+                url: string;
+            } | null;
+            heading: string;
+            subheading: string;
+            ctaLabel: string;
+            ctaTarget: {
+                kind: 'category' | 'collection' | 'page' | 'product' | 'search' | 'url';
+                handle?: string | undefined;
+                q?: string | undefined;
+                href?: string | undefined;
+            } | null;
+        };
+        shelves: {
+            kind: 'collection' | 'featured' | 'newest' | 'best_rated' | 'categories';
+            handle?: string | undefined;
+            title?: string | undefined;
+            limit: number;
+        }[];
+    };
+    announcement: {
+        enabled: boolean;
+        message: string;
+        target: {
+            kind: 'category' | 'collection' | 'page' | 'product' | 'search' | 'url';
+            handle?: string | undefined;
+            q?: string | undefined;
+            href?: string | undefined;
+        } | null;
+        startsAt: string | null;
+        endsAt: string | null;
+    };
+    listing: {
+        pageSize: number;
+        pagination: 'numbered' | 'load_more' | 'infinite';
+        columns: {
+            desktop: number;
+            mobile: number;
+        };
+        defaultSort: 'relevance' | 'featured' | 'manual' | 'title_asc' | 'title_desc' | 'price_asc' | 'price_desc' | 'newest' | 'updated' | 'best_rated';
+        filterLayout: 'sidebar' | 'topbar' | 'drawer';
+        sorts: {
+            key: 'relevance' | 'featured' | 'manual' | 'title_asc' | 'title_desc' | 'price_asc' | 'price_desc' | 'newest' | 'updated' | 'best_rated';
+            enabled: boolean;
+            label: string;
+        }[];
+    };
+    card: {
+        style: 'standard' | 'minimal' | 'overlay' | 'row';
+        showRating: boolean;
+        showSwatches: boolean;
+        showBrand: boolean;
+        showCompareAt: boolean;
+        showBadges: boolean;
+        secondImageOnHover: boolean;
+        quickAdd: boolean;
+    };
+    badges: {
+        sale: {
+            enabled: boolean;
+            label: string;
+            colour: string;
+        };
+        new: {
+            enabled: boolean;
+            label: string;
+            colour: string;
+            days: number;
+        };
+        lowStock: {
+            enabled: boolean;
+            label: string;
+        };
+        custom: {
+            tag: string;
+            label: string;
+            colour: string;
+        }[];
+    };
+    stock: {
+        hideOutOfStock: boolean;
+        showExactCount: boolean;
+        words: {
+            inStock: string;
+            lowStock: string;
+            outOfStock: string;
+            backorder: string;
+            preorder: string;
+        };
+        lowStockThreshold: number | null;
+    };
+    product: {
+        layout: 'classic' | 'stacked' | 'editorial';
+        sectionsStyle: 'auto' | 'tabs' | 'accordion' | 'stacked';
+        sections: {
+            key: 'description' | 'specs' | 'shipping' | 'tags' | 'categories' | 'related' | 'reviews';
+            enabled: boolean;
+            title: string;
+            pageHandle: string | null;
+        }[];
+        relatedLimit: number;
+        relatedTitle: string;
+    };
+    seo: {
+        titleTemplate: string;
+        defaultDescription: string;
+        shareImage: {
+            id: string;
+            url: string;
+        } | null;
+    };
+    strings: Record<'shop.title' | 'shop.description' | 'search.title' | 'search.placeholder' | 'search.results' | 'empty.search' | 'empty.listing' | 'empty.category' | 'empty.collection' | 'empty.cart' | 'cart.title' | 'cart.checkout' | 'cart.continueShopping' | 'filters.title' | 'filters.clearAll' | 'filters.apply' | 'filters.showMore' | 'filters.showLess' | 'filters.priceMin' | 'filters.priceMax' | 'boolean.yes' | 'boolean.no' | 'sort.label' | 'listing.count' | 'listing.loadMore' | 'listing.loading' | 'listing.previous' | 'listing.next' | 'product.addToCart' | 'product.quantity' | 'product.selectOption' | 'product.sku' | 'product.description' | 'product.specs' | 'product.shipping' | 'product.tags' | 'product.categories' | 'product.related' | 'product.reviews' | 'product.noReviews' | 'product.writeReview' | 'home.shopAll' | 'home.featured' | 'home.newest' | 'home.bestRated' | 'home.categories' | 'footer.copyright' | 'nav.menu' | 'nav.account' | 'nav.cart' | 'error.notFound' | 'error.generic', string>;
+    routes: {
+        product: string;
+        category: string;
+        collection: string;
+        tag: string;
+        page: string;
+        search: string;
+        shop: string;
+    };
+    preview: {
+        storeUrl: string | null;
+    };
+};
 type StorefrontSuggestAnswer = {
     products: {
         handle: string;
@@ -596,6 +824,6 @@ type StorefrontTagsAnswer = {
         productCount: number;
     }[];
 };
-type CatalogContractErrorCode = 'INVALID_REQUEST' | 'AUTHENTICATION_FAILED' | 'INFRASTRUCTURE_UNAVAILABLE' | 'PROVIDER_UNAVAILABLE' | 'INTERNAL_ERROR' | 'CUSTOMER_TOKEN_INVALID' | 'ORIGIN_NOT_ALLOWED' | 'SERVER_KEY_IN_BROWSER' | 'KEY_NOT_ALLOWED_IN_URL' | 'NOT_FOUND' | 'RATE_LIMITED' | 'STOREFRONT_UNAVAILABLE' | 'REQUEST_BODY_TOO_LARGE' | 'CART_CURRENCY_REQUIRED' | 'CART_CURRENCY_NOT_ENABLED' | 'CHECKOUT_NOT_CONFIGURED' | 'EXTENSION_UPGRADE_REQUIRED' | 'CART_ITEMS_INVALID' | 'CART_REJECTED' | 'CART_UNAVAILABLE' | 'CHECKOUT_UNAVAILABLE' | 'RETURN_URL_NOT_ALLOWED' | 'CHECKOUT_TOTAL_TOO_LARGE' | 'CHECKOUT_CART_MISMATCH' | 'CHECKOUT_ITEMS_INVALID' | 'CHECKOUT_REJECTED' | 'CURRENCY_NOT_ENABLED' | 'STOREFRONT_INDEXING' | 'EMAIL_NOT_VERIFIED' | 'NOT_VERIFIED_BUYER' | 'PURCHASE_REFUNDED' | 'ALREADY_REVIEWED' | 'REVIEW_QUEUE_FULL' | 'REVIEW_VERIFICATION_UNAVAILABLE';
+type CatalogContractErrorCode = 'INVALID_REQUEST' | 'AUTHENTICATION_FAILED' | 'INFRASTRUCTURE_UNAVAILABLE' | 'PROVIDER_UNAVAILABLE' | 'INTERNAL_ERROR' | 'CUSTOMER_TOKEN_INVALID' | 'ORIGIN_NOT_ALLOWED' | 'SERVER_KEY_IN_BROWSER' | 'KEY_NOT_ALLOWED_IN_URL' | 'NOT_FOUND' | 'RATE_LIMITED' | 'STOREFRONT_UNAVAILABLE' | 'REQUEST_BODY_TOO_LARGE' | 'CART_CURRENCY_REQUIRED' | 'CART_CURRENCY_NOT_ENABLED' | 'CHECKOUT_NOT_CONFIGURED' | 'EXTENSION_UPGRADE_REQUIRED' | 'CART_ITEMS_INVALID' | 'CART_REJECTED' | 'CART_UNAVAILABLE' | 'CHECKOUT_UNAVAILABLE' | 'RETURN_URL_NOT_ALLOWED' | 'CHECKOUT_TOTAL_TOO_LARGE' | 'CHECKOUT_CART_MISMATCH' | 'CHECKOUT_ITEMS_INVALID' | 'CHECKOUT_REJECTED' | 'CURRENCY_NOT_ENABLED' | 'STOREFRONT_INDEXING' | 'EMAIL_NOT_VERIFIED' | 'NOT_VERIFIED_BUYER' | 'PURCHASE_REFUNDED' | 'ALREADY_REVIEWED' | 'REVIEW_QUEUE_FULL' | 'REVIEW_VERIFICATION_UNAVAILABLE' | 'PAGE_NOT_FOUND' | 'PREVIEW_EXPIRED';
 
-export type { CartCheckAnswer as C, ReviewSubmitAnswer as R, StorefrontCategoryNode as S, ReviewSubmitInput as a, StorefrontListAnswer as b, StorefrontListProduct as c, ReviewEligibilityAnswer as d, StorefrontProductAnswer as e, CartCheckRequest as f, CartCreateAnswer as g, CartCreateRequest as h, CatalogContractErrorCode as i, StorefrontCategoriesAnswer as j, StorefrontCategoryAnswer as k, StorefrontCollectionAnswer as l, StorefrontCollectionsAnswer as m, StorefrontConfigAnswer as n, StorefrontFilterValuesAnswer as o, StorefrontRelatedAnswer as p, StorefrontReviewsAnswer as q, StorefrontSuggestAnswer as r, StorefrontTagsAnswer as s };
+export type { CartCheckAnswer as C, ReviewSubmitAnswer as R, StorefrontSettings as S, ReviewSubmitInput as a, StorefrontMenuItem as b, StorefrontCategoryNode as c, StorefrontListAnswer as d, StorefrontListProduct as e, ReviewEligibilityAnswer as f, StorefrontProductAnswer as g, CartCheckRequest as h, CartCreateAnswer as i, CartCreateRequest as j, CatalogContractErrorCode as k, StorefrontCategoriesAnswer as l, StorefrontCategoryAnswer as m, StorefrontCollectionAnswer as n, StorefrontCollectionsAnswer as o, StorefrontConfigAnswer as p, StorefrontFilterDefinition as q, StorefrontFilterValuesAnswer as r, StorefrontPageAnswer as s, StorefrontPagesAnswer as t, StorefrontRelatedAnswer as u, StorefrontReviewsAnswer as v, StorefrontSuggestAnswer as w, StorefrontTagsAnswer as x };

package/dist/{contract-types-BRyonOYH.d.ts → contract-types-D2-SSPM9.d.ts}

@@ -151,6 +151,15 @@ type StorefrontConfigAnswer = {
         extensionId: string;
     };
     generation: number;
+    settings: StorefrontSettings;
+    filters: StorefrontFilterDefinition[];
+    settingsVersion: number;
+};
+type StorefrontFilterDefinition = {
+    key: string;
+    label: string;
+    display: 'checkbox' | 'swatch' | 'range' | 'boolean' | 'dropdown';
+    source: string;
 };
 type StorefrontFilterValuesAnswer = {
     key: string;
@@ -392,6 +401,32 @@ type StorefrontListProduct = {
     supersededBy?: string[] | undefined;
     supersedes?: string[] | undefined;
 };
+type StorefrontMenuItem = {
+    label: string;
+    target: {
+        kind: 'category' | 'collection' | 'page' | 'product' | 'search' | 'url';
+        handle?: string | undefined;
+        q?: string | undefined;
+        href?: string | undefined;
+    };
+    children?: StorefrontMenuItem[] | undefined;
+};
+type StorefrontPageAnswer = {
+    handle: string;
+    title: string;
+    bodyHtml: string;
+    seo: {
+        title: string;
+        description: string;
+    };
+};
+type StorefrontPagesAnswer = {
+    pages: {
+        handle: string;
+        title: string;
+        position: number;
+    }[];
+};
 type StorefrontProductAnswer = {
     product: {
         handle: string;
@@ -549,6 +584,199 @@ type StorefrontReviewsAnswer = ({
 }) | ({
     redirectTo: string;
 });
+type StorefrontSettings = {
+    storefrontId: 'default';
+    brand: {
+        storeName: string;
+        logo: {
+            light: {
+                id: string;
+                url: string;
+            } | null;
+            dark: {
+                id: string;
+                url: string;
+            } | null;
+        };
+        favicon: {
+            id: string;
+            url: string;
+        } | null;
+    };
+    theme: {
+        light: {
+            colorPrimary: string;
+            colorPrimaryForeground: string;
+            colorBackground: string;
+            colorSurface: string;
+            colorForeground: string;
+            colorMuted: string;
+            colorMutedForeground: string;
+            colorBorder: string;
+            colorBorderControl: string;
+            colorAccent: string;
+            colorSale: string;
+            colorSuccess: string;
+            colorWarning: string;
+            colorDanger: string;
+        };
+        dark: {
+            colorPrimary: string;
+            colorPrimaryForeground: string;
+            colorBackground: string;
+            colorSurface: string;
+            colorForeground: string;
+            colorMuted: string;
+            colorMutedForeground: string;
+            colorBorder: string;
+            colorBorderControl: string;
+            colorAccent: string;
+            colorSale: string;
+            colorSuccess: string;
+            colorWarning: string;
+            colorDanger: string;
+        };
+        fonts: {
+            heading: 'Instrument Serif' | 'Playfair Display' | 'Lora' | 'Merriweather' | 'Cormorant Garamond' | 'EB Garamond' | 'Libre Baskerville' | 'Source Serif 4' | 'Fraunces' | 'DM Serif Display' | 'Inter' | 'Schibsted Grotesk' | 'DM Sans' | 'Manrope' | 'Poppins' | 'Montserrat' | 'Work Sans' | 'Rubik' | 'Nunito Sans' | 'Open Sans' | 'Lato' | 'Raleway' | 'Outfit' | 'Plus Jakarta Sans' | 'Figtree' | 'Karla' | 'DM Mono' | 'JetBrains Mono' | 'IBM Plex Mono' | 'Space Mono' | 'Bebas Neue' | 'Oswald' | 'Archivo Black' | 'Space Grotesk' | 'Syne' | 'system-sans' | 'system-serif' | 'system-mono';
+            body: 'Instrument Serif' | 'Playfair Display' | 'Lora' | 'Merriweather' | 'Cormorant Garamond' | 'EB Garamond' | 'Libre Baskerville' | 'Source Serif 4' | 'Fraunces' | 'DM Serif Display' | 'Inter' | 'Schibsted Grotesk' | 'DM Sans' | 'Manrope' | 'Poppins' | 'Montserrat' | 'Work Sans' | 'Rubik' | 'Nunito Sans' | 'Open Sans' | 'Lato' | 'Raleway' | 'Outfit' | 'Plus Jakarta Sans' | 'Figtree' | 'Karla' | 'DM Mono' | 'JetBrains Mono' | 'IBM Plex Mono' | 'Space Mono' | 'Bebas Neue' | 'Oswald' | 'Archivo Black' | 'Space Grotesk' | 'Syne' | 'system-sans' | 'system-serif' | 'system-mono';
+            mono: 'Instrument Serif' | 'Playfair Display' | 'Lora' | 'Merriweather' | 'Cormorant Garamond' | 'EB Garamond' | 'Libre Baskerville' | 'Source Serif 4' | 'Fraunces' | 'DM Serif Display' | 'Inter' | 'Schibsted Grotesk' | 'DM Sans' | 'Manrope' | 'Poppins' | 'Montserrat' | 'Work Sans' | 'Rubik' | 'Nunito Sans' | 'Open Sans' | 'Lato' | 'Raleway' | 'Outfit' | 'Plus Jakarta Sans' | 'Figtree' | 'Karla' | 'DM Mono' | 'JetBrains Mono' | 'IBM Plex Mono' | 'Space Mono' | 'Bebas Neue' | 'Oswald' | 'Archivo Black' | 'Space Grotesk' | 'Syne' | 'system-sans' | 'system-serif' | 'system-mono';
+        };
+        radius: number;
+        spacingScale: 'compact' | 'comfortable' | 'roomy';
+        colorScheme: 'light' | 'dark' | 'auto';
+    };
+    navigation: {
+        header: StorefrontMenuItem[];
+        footer: StorefrontMenuItem[];
+    };
+    home: {
+        hero: {
+            image: {
+                id: string;
+                url: string;
+            } | null;
+            heading: string;
+            subheading: string;
+            ctaLabel: string;
+            ctaTarget: {
+                kind: 'category' | 'collection' | 'page' | 'product' | 'search' | 'url';
+                handle?: string | undefined;
+                q?: string | undefined;
+                href?: string | undefined;
+            } | null;
+        };
+        shelves: {
+            kind: 'collection' | 'featured' | 'newest' | 'best_rated' | 'categories';
+            handle?: string | undefined;
+            title?: string | undefined;
+            limit: number;
+        }[];
+    };
+    announcement: {
+        enabled: boolean;
+        message: string;
+        target: {
+            kind: 'category' | 'collection' | 'page' | 'product' | 'search' | 'url';
+            handle?: string | undefined;
+            q?: string | undefined;
+            href?: string | undefined;
+        } | null;
+        startsAt: string | null;
+        endsAt: string | null;
+    };
+    listing: {
+        pageSize: number;
+        pagination: 'numbered' | 'load_more' | 'infinite';
+        columns: {
+            desktop: number;
+            mobile: number;
+        };
+        defaultSort: 'relevance' | 'featured' | 'manual' | 'title_asc' | 'title_desc' | 'price_asc' | 'price_desc' | 'newest' | 'updated' | 'best_rated';
+        filterLayout: 'sidebar' | 'topbar' | 'drawer';
+        sorts: {
+            key: 'relevance' | 'featured' | 'manual' | 'title_asc' | 'title_desc' | 'price_asc' | 'price_desc' | 'newest' | 'updated' | 'best_rated';
+            enabled: boolean;
+            label: string;
+        }[];
+    };
+    card: {
+        style: 'standard' | 'minimal' | 'overlay' | 'row';
+        showRating: boolean;
+        showSwatches: boolean;
+        showBrand: boolean;
+        showCompareAt: boolean;
+        showBadges: boolean;
+        secondImageOnHover: boolean;
+        quickAdd: boolean;
+    };
+    badges: {
+        sale: {
+            enabled: boolean;
+            label: string;
+            colour: string;
+        };
+        new: {
+            enabled: boolean;
+            label: string;
+            colour: string;
+            days: number;
+        };
+        lowStock: {
+            enabled: boolean;
+            label: string;
+        };
+        custom: {
+            tag: string;
+            label: string;
+            colour: string;
+        }[];
+    };
+    stock: {
+        hideOutOfStock: boolean;
+        showExactCount: boolean;
+        words: {
+            inStock: string;
+            lowStock: string;
+            outOfStock: string;
+            backorder: string;
+            preorder: string;
+        };
+        lowStockThreshold: number | null;
+    };
+    product: {
+        layout: 'classic' | 'stacked' | 'editorial';
+        sectionsStyle: 'auto' | 'tabs' | 'accordion' | 'stacked';
+        sections: {
+            key: 'description' | 'specs' | 'shipping' | 'tags' | 'categories' | 'related' | 'reviews';
+            enabled: boolean;
+            title: string;
+            pageHandle: string | null;
+        }[];
+        relatedLimit: number;
+        relatedTitle: string;
+    };
+    seo: {
+        titleTemplate: string;
+        defaultDescription: string;
+        shareImage: {
+            id: string;
+            url: string;
+        } | null;
+    };
+    strings: Record<'shop.title' | 'shop.description' | 'search.title' | 'search.placeholder' | 'search.results' | 'empty.search' | 'empty.listing' | 'empty.category' | 'empty.collection' | 'empty.cart' | 'cart.title' | 'cart.checkout' | 'cart.continueShopping' | 'filters.title' | 'filters.clearAll' | 'filters.apply' | 'filters.showMore' | 'filters.showLess' | 'filters.priceMin' | 'filters.priceMax' | 'boolean.yes' | 'boolean.no' | 'sort.label' | 'listing.count' | 'listing.loadMore' | 'listing.loading' | 'listing.previous' | 'listing.next' | 'product.addToCart' | 'product.quantity' | 'product.selectOption' | 'product.sku' | 'product.description' | 'product.specs' | 'product.shipping' | 'product.tags' | 'product.categories' | 'product.related' | 'product.reviews' | 'product.noReviews' | 'product.writeReview' | 'home.shopAll' | 'home.featured' | 'home.newest' | 'home.bestRated' | 'home.categories' | 'footer.copyright' | 'nav.menu' | 'nav.account' | 'nav.cart' | 'error.notFound' | 'error.generic', string>;
+    routes: {
+        product: string;
+        category: string;
+        collection: string;
+        tag: string;
+        page: string;
+        search: string;
+        shop: string;
+    };
+    preview: {
+        storeUrl: string | null;
+    };
+};
 type StorefrontSuggestAnswer = {
     products: {
         handle: string;
@@ -596,6 +824,6 @@ type StorefrontTagsAnswer = {
         productCount: number;
     }[];
 };
-type CatalogContractErrorCode = 'INVALID_REQUEST' | 'AUTHENTICATION_FAILED' | 'INFRASTRUCTURE_UNAVAILABLE' | 'PROVIDER_UNAVAILABLE' | 'INTERNAL_ERROR' | 'CUSTOMER_TOKEN_INVALID' | 'ORIGIN_NOT_ALLOWED' | 'SERVER_KEY_IN_BROWSER' | 'KEY_NOT_ALLOWED_IN_URL' | 'NOT_FOUND' | 'RATE_LIMITED' | 'STOREFRONT_UNAVAILABLE' | 'REQUEST_BODY_TOO_LARGE' | 'CART_CURRENCY_REQUIRED' | 'CART_CURRENCY_NOT_ENABLED' | 'CHECKOUT_NOT_CONFIGURED' | 'EXTENSION_UPGRADE_REQUIRED' | 'CART_ITEMS_INVALID' | 'CART_REJECTED' | 'CART_UNAVAILABLE' | 'CHECKOUT_UNAVAILABLE' | 'RETURN_URL_NOT_ALLOWED' | 'CHECKOUT_TOTAL_TOO_LARGE' | 'CHECKOUT_CART_MISMATCH' | 'CHECKOUT_ITEMS_INVALID' | 'CHECKOUT_REJECTED' | 'CURRENCY_NOT_ENABLED' | 'STOREFRONT_INDEXING' | 'EMAIL_NOT_VERIFIED' | 'NOT_VERIFIED_BUYER' | 'PURCHASE_REFUNDED' | 'ALREADY_REVIEWED' | 'REVIEW_QUEUE_FULL' | 'REVIEW_VERIFICATION_UNAVAILABLE';
+type CatalogContractErrorCode = 'INVALID_REQUEST' | 'AUTHENTICATION_FAILED' | 'INFRASTRUCTURE_UNAVAILABLE' | 'PROVIDER_UNAVAILABLE' | 'INTERNAL_ERROR' | 'CUSTOMER_TOKEN_INVALID' | 'ORIGIN_NOT_ALLOWED' | 'SERVER_KEY_IN_BROWSER' | 'KEY_NOT_ALLOWED_IN_URL' | 'NOT_FOUND' | 'RATE_LIMITED' | 'STOREFRONT_UNAVAILABLE' | 'REQUEST_BODY_TOO_LARGE' | 'CART_CURRENCY_REQUIRED' | 'CART_CURRENCY_NOT_ENABLED' | 'CHECKOUT_NOT_CONFIGURED' | 'EXTENSION_UPGRADE_REQUIRED' | 'CART_ITEMS_INVALID' | 'CART_REJECTED' | 'CART_UNAVAILABLE' | 'CHECKOUT_UNAVAILABLE' | 'RETURN_URL_NOT_ALLOWED' | 'CHECKOUT_TOTAL_TOO_LARGE' | 'CHECKOUT_CART_MISMATCH' | 'CHECKOUT_ITEMS_INVALID' | 'CHECKOUT_REJECTED' | 'CURRENCY_NOT_ENABLED' | 'STOREFRONT_INDEXING' | 'EMAIL_NOT_VERIFIED' | 'NOT_VERIFIED_BUYER' | 'PURCHASE_REFUNDED' | 'ALREADY_REVIEWED' | 'REVIEW_QUEUE_FULL' | 'REVIEW_VERIFICATION_UNAVAILABLE' | 'PAGE_NOT_FOUND' | 'PREVIEW_EXPIRED';
 
-export type { CartCheckAnswer as C, ReviewSubmitAnswer as R, StorefrontCategoryNode as S, ReviewSubmitInput as a, StorefrontListAnswer as b, StorefrontListProduct as c, ReviewEligibilityAnswer as d, StorefrontProductAnswer as e, CartCheckRequest as f, CartCreateAnswer as g, CartCreateRequest as h, CatalogContractErrorCode as i, StorefrontCategoriesAnswer as j, StorefrontCategoryAnswer as k, StorefrontCollectionAnswer as l, StorefrontCollectionsAnswer as m, StorefrontConfigAnswer as n, StorefrontFilterValuesAnswer as o, StorefrontRelatedAnswer as p, StorefrontReviewsAnswer as q, StorefrontSuggestAnswer as r, StorefrontTagsAnswer as s };
+export type { CartCheckAnswer as C, ReviewSubmitAnswer as R, StorefrontSettings as S, ReviewSubmitInput as a, StorefrontMenuItem as b, StorefrontCategoryNode as c, StorefrontListAnswer as d, StorefrontListProduct as e, ReviewEligibilityAnswer as f, StorefrontProductAnswer as g, CartCheckRequest as h, CartCreateAnswer as i, CartCreateRequest as j, CatalogContractErrorCode as k, StorefrontCategoriesAnswer as l, StorefrontCategoryAnswer as m, StorefrontCollectionAnswer as n, StorefrontCollectionsAnswer as o, StorefrontConfigAnswer as p, StorefrontFilterDefinition as q, StorefrontFilterValuesAnswer as r, StorefrontPageAnswer as s, StorefrontPagesAnswer as t, StorefrontRelatedAnswer as u, StorefrontReviewsAnswer as v, StorefrontSuggestAnswer as w, StorefrontTagsAnswer as x };

package/dist/index.cjs

@@ -21,7 +21,12 @@
 
 
 
-var _chunk2YQNMBDIcjs = require('./chunk-2YQNMBDI.cjs');
+
+
+
+
+
+var _chunkJ2GHGQY6cjs = require('./chunk-J2GHGQY6.cjs');
 require('./chunk-ETV4XYOV.cjs');
 
 
@@ -46,4 +51,9 @@ require('./chunk-ETV4XYOV.cjs');
 
 
 
-exports.CURRENCIES = _chunk2YQNMBDIcjs.CURRENCIES; exports.CartLineError = _chunk2YQNMBDIcjs.CartLineError; exports.CatalogError = _chunk2YQNMBDIcjs.CatalogError; exports.CustomerTokenInvalidError = _chunk2YQNMBDIcjs.CustomerTokenInvalidError; exports.FeatureUnavailableError = _chunk2YQNMBDIcjs.FeatureUnavailableError; exports.NetworkError = _chunk2YQNMBDIcjs.NetworkError; exports.OriginNotAllowedError = _chunk2YQNMBDIcjs.OriginNotAllowedError; exports.RateLimitedError = _chunk2YQNMBDIcjs.RateLimitedError; exports.SDK_VERSION = _chunk2YQNMBDIcjs.SDK_VERSION; exports.TimeoutError = _chunk2YQNMBDIcjs.TimeoutError; exports.UnknownCurrencyError = _chunk2YQNMBDIcjs.UnknownCurrencyError; exports.createCatalogClient = _chunk2YQNMBDIcjs.createCatalogClient; exports.currencySymbol = _chunk2YQNMBDIcjs.currencySymbol; exports.formatMoney = _chunk2YQNMBDIcjs.formatMoney; exports.isCatalogError = _chunk2YQNMBDIcjs.isCatalogError; exports.isKnownCurrency = _chunk2YQNMBDIcjs.isKnownCurrency; exports.minorUnitsOf = _chunk2YQNMBDIcjs.minorUnitsOf; exports.money = _chunk2YQNMBDIcjs.money; exports.moneyValue = _chunk2YQNMBDIcjs.moneyValue; exports.parseMoney = _chunk2YQNMBDIcjs.parseMoney; exports.toDecimalString = _chunk2YQNMBDIcjs.toDecimalString; exports.toMinor = _chunk2YQNMBDIcjs.toMinor;
+
+
+
+
+
+exports.CURRENCIES = _chunkJ2GHGQY6cjs.CURRENCIES; exports.CartLineError = _chunkJ2GHGQY6cjs.CartLineError; exports.CatalogError = _chunkJ2GHGQY6cjs.CatalogError; exports.CustomerTokenInvalidError = _chunkJ2GHGQY6cjs.CustomerTokenInvalidError; exports.DEFAULT_STRINGS = _chunkJ2GHGQY6cjs.DEFAULT_STRINGS; exports.FeatureUnavailableError = _chunkJ2GHGQY6cjs.FeatureUnavailableError; exports.NetworkError = _chunkJ2GHGQY6cjs.NetworkError; exports.OriginNotAllowedError = _chunkJ2GHGQY6cjs.OriginNotAllowedError; exports.RateLimitedError = _chunkJ2GHGQY6cjs.RateLimitedError; exports.SDK_VERSION = _chunkJ2GHGQY6cjs.SDK_VERSION; exports.TimeoutError = _chunkJ2GHGQY6cjs.TimeoutError; exports.UnknownCurrencyError = _chunkJ2GHGQY6cjs.UnknownCurrencyError; exports.createCatalogClient = _chunkJ2GHGQY6cjs.createCatalogClient; exports.currencySymbol = _chunkJ2GHGQY6cjs.currencySymbol; exports.fontStylesheetHref = _chunkJ2GHGQY6cjs.fontStylesheetHref; exports.formatMoney = _chunkJ2GHGQY6cjs.formatMoney; exports.isCatalogError = _chunkJ2GHGQY6cjs.isCatalogError; exports.isKnownCurrency = _chunkJ2GHGQY6cjs.isKnownCurrency; exports.minorUnitsOf = _chunkJ2GHGQY6cjs.minorUnitsOf; exports.money = _chunkJ2GHGQY6cjs.money; exports.moneyValue = _chunkJ2GHGQY6cjs.moneyValue; exports.parseMoney = _chunkJ2GHGQY6cjs.parseMoney; exports.resolveMenuTarget = _chunkJ2GHGQY6cjs.resolveMenuTarget; exports.t = _chunkJ2GHGQY6cjs.t; exports.toAuthAppearance = _chunkJ2GHGQY6cjs.toAuthAppearance; exports.toDecimalString = _chunkJ2GHGQY6cjs.toDecimalString; exports.toMinor = _chunkJ2GHGQY6cjs.toMinor;

package/dist/index.d.cts

@@ -1,12 +1,58 @@
-import { S as StorefrontCategoryNode, b as StorefrontListAnswer, c as StorefrontListProduct, d as ReviewEligibilityAnswer, e as StorefrontProductAnswer } from './contract-types-BRyonOYH.cjs';
-export { C as CartCheckAnswer, f as CartCheckRequest, g as CartCreateAnswer, h as CartCreateRequest, i as CatalogContractErrorCode, R as ReviewSubmitAnswer, a as ReviewSubmitInput, j as StorefrontCategoriesAnswer, k as StorefrontCategoryAnswer, l as StorefrontCollectionAnswer, m as StorefrontCollectionsAnswer, n as StorefrontConfigAnswer, o as StorefrontFilterValuesAnswer, p as StorefrontRelatedAnswer, q as StorefrontReviewsAnswer, r as StorefrontSuggestAnswer, s as StorefrontTagsAnswer } from './contract-types-BRyonOYH.cjs';
+import { S as StorefrontSettings, b as StorefrontMenuItem, c as StorefrontCategoryNode, d as StorefrontListAnswer, e as StorefrontListProduct, f as ReviewEligibilityAnswer, g as StorefrontProductAnswer } from './contract-types-D2-SSPM9.cjs';
+export { C as CartCheckAnswer, h as CartCheckRequest, i as CartCreateAnswer, j as CartCreateRequest, k as CatalogContractErrorCode, R as ReviewSubmitAnswer, a as ReviewSubmitInput, l as StorefrontCategoriesAnswer, m as StorefrontCategoryAnswer, n as StorefrontCollectionAnswer, o as StorefrontCollectionsAnswer, p as StorefrontConfigAnswer, q as StorefrontFilterDefinition, r as StorefrontFilterValuesAnswer, s as StorefrontPageAnswer, t as StorefrontPagesAnswer, u as StorefrontRelatedAnswer, v as StorefrontReviewsAnswer, w as StorefrontSuggestAnswer, x as StorefrontTagsAnswer } from './contract-types-D2-SSPM9.cjs';
 export { S as SDK_VERSION } from './version-ev3p03v2.cjs';
 import * as money from '@usethrottle/money';
 export { money };
 export { CURRENCIES, CurrencyCode, MoneyValue, UnknownCurrencyError, currencySymbol, formatMoney, isKnownCurrency, minorUnitsOf, moneyValue, parseMoney, toDecimalString, toMinor } from '@usethrottle/money';
-export { C as CatalogClient, c as createCatalogClient } from './client-6j1Iz-iJ.cjs';
-export { c as CallOptions, d as CartAbsorb, e as CartCheckout, f as CartCheckoutInput, g as CartSession, h as CartSessionBranding, i as CartSessionDetail, j as CartSessionSnapshot, b as CartWarning, k as CartsNamespace, l as CatalogClientOptions, m as CatalogHttpCache, n as CatalogHttpCacheEntry, o as CatalogNamespaces, p as CategoriesNamespace, a as CategoryTreeDepth, q as CollectionsNamespace, C as CustomerCartSource, r as CustomerTokenSource, F as FieldsOption, s as FiltersNamespace, N as NextFetchOptions, O as OpenCartRef, t as ProductsNamespace, P as ProductsQuery, R as Redirect, u as ReviewsNamespace, S as SessionCallOptions, v as StorefrontSort, w as TagsNamespace, T as ThrottleCart, x as ThrottleLine } from './types-D0PywKnN.cjs';
-export { C as CartLineError, a as CartLineProblem, b as CatalogError, c as CatalogErrorCode, d as CatalogErrorInit, e as CatalogErrorIssue, f as CatalogErrorSource, g as ClientErrorCode, h as CustomerTokenInvalidError, F as FeatureUnavailableError, N as NetworkError, O as OriginNotAllowedError, R as RateLimitedError, j as ThrottleCartCode, T as TimeoutError, i as isCatalogError } from './catalog-error-BOaSKgY3.cjs';
+export { C as CatalogClient, c as createCatalogClient } from './client-terkEl6u.cjs';
+export { c as CallOptions, d as CartAbsorb, e as CartCheckout, f as CartCheckoutInput, g as CartSession, h as CartSessionBranding, i as CartSessionDetail, j as CartSessionSnapshot, b as CartWarning, k as CartsNamespace, l as CatalogClientOptions, m as CatalogHttpCache, n as CatalogHttpCacheEntry, o as CatalogNamespaces, p as CategoriesNamespace, a as CategoryTreeDepth, q as CollectionsNamespace, C as CustomerCartSource, r as CustomerTokenSource, F as FieldsOption, s as FiltersNamespace, N as NextFetchOptions, O as OpenCartRef, t as PagesNamespace, u as ProductsNamespace, P as ProductsQuery, R as Redirect, v as ReviewsNamespace, S as SessionCallOptions, w as SettingsCallOptions, x as SettingsNamespace, y as StorefrontSettingsResult, z as StorefrontSort, A as TagsNamespace, T as ThrottleCart, B as ThrottleLine } from './types-jNpOwEUw.cjs';
+export { C as CartLineError, a as CartLineProblem, b as CatalogError, c as CatalogErrorCode, d as CatalogErrorInit, e as CatalogErrorIssue, f as CatalogErrorSource, g as ClientErrorCode, h as CustomerTokenInvalidError, F as FeatureUnavailableError, N as NetworkError, O as OriginNotAllowedError, R as RateLimitedError, j as ThrottleCartCode, T as TimeoutError, i as isCatalogError } from './catalog-error-BKN5hNWP.cjs';
+
+/** The settings document as `/config` answers it: text resolved, targets as handles. */
+type ResolvedStorefrontSettings = StorefrontSettings;
+/** Where a menu item, announcement or hero button points. */
+type ResolvedMenuTarget = StorefrontMenuItem['target'];
+/** A key of `settings.strings`. */
+type StringKey = keyof StorefrontSettings['strings'];
+/**
+ * The English text of every storefront string: what `t` falls back to. Kept
+ * in step with the contract's defaults, which the Worker resolves first.
+ */
+declare const DEFAULT_STRINGS: Readonly<Record<StringKey, string>>;
+/**
+ * One string of the store, in the locale the settings were read for, with
+ * `{name}` placeholders filled from `vars` (a name without a value stays as
+ * written). A missing or empty string falls back to the English default.
+ */
+declare function t(settings: {
+    strings?: Partial<Record<StringKey, string>>;
+} | null | undefined, key: StringKey, vars?: Record<string, string | number>): string;
+/**
+ * The URL a menu target points to, from the store's route patterns
+ * (`settings.routes`); `null` when the target has nothing to point at (no
+ * handle, or a link that is not http(s) or a site path).
+ */
+declare function resolveMenuTarget(settings: Pick<ResolvedStorefrontSettings, 'routes'>, target: ResolvedMenuTarget): string | null;
+/** The style options `@usethrottle/auth` components take (the part this maps to). */
+type ThrottleAppearance = {
+    theme?: 'light' | 'dark' | 'auto';
+    variables?: Partial<Record<'colorPrimary' | 'colorPrimaryForeground' | 'colorBackground' | 'colorSurface' | 'colorForeground' | 'colorMuted' | 'colorMutedForeground' | 'colorBorder' | 'colorBorderControl' | 'colorDanger' | 'colorSuccess' | 'colorWarning' | 'fontFamily' | 'borderRadius', string>>;
+};
+type Fonts = StorefrontSettings['theme']['fonts'];
+/**
+ * One Google Fonts `css2` URL for the theme's fonts: each Google family once,
+ * with the weights the storefront uses (400 to 700, as far as the family has
+ * them) and `display=swap`. `null` when every font is a system stack.
+ */
+declare function fontStylesheetHref(theme: {
+    fonts: Fonts;
+}): string | null;
+/**
+ * The appearance for `@usethrottle/auth` components under the store's theme:
+ * the `scheme` palette (its accent and sale colours have no auth variable),
+ * `fonts.body` as `fontFamily` and `radius` as `borderRadius`.
+ */
+declare function toAuthAppearance(theme: Pick<StorefrontSettings['theme'], 'light' | 'dark' | 'fonts' | 'radius'>, scheme: 'light' | 'dark'): ThrottleAppearance;
 
 /** The answer of `reviews.eligibility`. */
 type ReviewEligibility = ReviewEligibilityAnswer;
@@ -19,5 +65,5 @@ type Filter = NonNullable<StorefrontListAnswer['filters']>[number];
 /** One node of the category tree. */
 type CategoryNode = StorefrontCategoryNode;
 
-export { ReviewEligibilityAnswer, StorefrontCategoryNode, StorefrontListAnswer, StorefrontListProduct, StorefrontProductAnswer };
-export type { CategoryNode, Filter, ListProduct, ReviewEligibility, StorefrontProduct };
+export { DEFAULT_STRINGS, ReviewEligibilityAnswer, StorefrontCategoryNode, StorefrontListAnswer, StorefrontListProduct, StorefrontMenuItem, StorefrontProductAnswer, StorefrontSettings, fontStylesheetHref, resolveMenuTarget, t, toAuthAppearance };
+export type { CategoryNode, Filter, ListProduct, ResolvedMenuTarget, ResolvedStorefrontSettings, ReviewEligibility, StorefrontProduct, StringKey, ThrottleAppearance };