@usethrottle/catalog 1.2.0 → 1.4.0

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

@@ -1,3 +1,5 @@
+import { CurrencyCode } from '@usethrottle/money';
+
 type CartCheckAnswer = {
     priceContext?: 'anonymous' | 'customer' | 'email_unverified' | 'anonymous_fallback' | undefined;
     items: {
@@ -5,7 +7,7 @@ type CartCheckAnswer = {
         ok: boolean;
         code?: 'NOT_FOUND' | 'NOT_PURCHASABLE' | 'OUT_OF_STOCK' | 'QUANTITY_UNAVAILABLE' | 'BELOW_MIN' | 'ABOVE_MAX' | 'NO_PRICE_IN_CURRENCY' | 'PRICE_SOURCE_MISMATCH' | undefined;
         unitPriceMinor: number | null;
-        currency: string | null;
+        currency: CurrencyCode | null;
         maxQuantity?: number | undefined;
     }[];
 };
@@ -29,7 +31,7 @@ type CartCreateAnswer = {
             unitPriceMinor: number;
             imageUrl: string | null;
         }[];
-        currency: string;
+        currency: CurrencyCode;
         subtotalMinor: number;
     };
     returnUrlApplied?: boolean | undefined;
@@ -149,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;
@@ -218,7 +229,7 @@ type StorefrontListAnswer = {
         ignored?: string[] | undefined;
     };
     sort: 'relevance' | 'featured' | 'manual' | 'title_asc' | 'title_desc' | 'price_asc' | 'price_desc' | 'newest' | 'updated' | 'best_rated';
-    currency: string | null;
+    currency: CurrencyCode | null;
     locale: string | null;
     priceContext?: 'anonymous' | 'customer' | 'email_unverified' | 'anonymous_fallback' | undefined;
     indexing?: true | undefined;
@@ -246,12 +257,12 @@ type StorefrontListProduct = {
     priceRange?: ({
         minMinor: number;
         maxMinor: number;
-        currency: string;
+        currency: CurrencyCode;
         compareAtMinMinor: number | null;
     } | null) | ({
         minMinor: number;
         maxMinor: number;
-        currency: string;
+        currency: CurrencyCode;
     } | null) | undefined;
     availability?: ('in_stock' | 'out_of_stock' | 'preorder' | 'backorder' | null) | ('in_stock' | 'out_of_stock' | 'preorder' | 'backorder' | null) | undefined;
     lowStock?: (boolean) | (boolean) | undefined;
@@ -296,7 +307,7 @@ type StorefrontListProduct = {
         options: Record<string, string> | null;
         priceMinor: number | null;
         salePriceMinor: number | null;
-        currency: string | null;
+        currency: CurrencyCode | null;
         availability: 'in_stock' | 'out_of_stock' | 'preorder' | 'backorder' | null;
         gtin: string | null;
         mpn: string | null;
@@ -390,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;
@@ -410,7 +447,7 @@ type StorefrontProductAnswer = {
         priceRange: {
             minMinor: number;
             maxMinor: number;
-            currency: string;
+            currency: CurrencyCode;
         } | null;
         availability: 'in_stock' | 'out_of_stock' | 'preorder' | 'backorder' | null;
         variants: {
@@ -419,7 +456,7 @@ type StorefrontProductAnswer = {
             options: Record<string, string> | null;
             priceMinor: number | null;
             salePriceMinor: number | null;
-            currency: string | null;
+            currency: CurrencyCode | null;
             availability: 'in_stock' | 'out_of_stock' | 'preorder' | 'backorder' | null;
             gtin: string | null;
             mpn: string | null;
@@ -547,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;
@@ -562,7 +792,7 @@ type StorefrontSuggestAnswer = {
         priceRange: {
             minMinor: number;
             maxMinor: number;
-            currency: string;
+            currency: CurrencyCode;
             compareAtMinMinor: number | null;
         } | null;
         availability: 'in_stock' | 'out_of_stock' | 'preorder' | 'backorder' | null;
@@ -594,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 };