@usethrottle/catalog 1.3.0 → 1.4.1

package/dist/{types-BfveENg1.d.ts → types-dKvIfrVH.d.ts}

@@ -1,5 +1,5 @@
 import { CurrencyCode } from '@usethrottle/money';
-import { C as CartCheckAnswer, h as CartCreateRequest, g as CartCreateAnswer, b as StorefrontListAnswer, e as StorefrontProductAnswer, p as StorefrontRelatedAnswer, o as StorefrontFilterValuesAnswer, j as StorefrontCategoriesAnswer, k as StorefrontCategoryAnswer, s as StorefrontTagsAnswer, m as StorefrontCollectionsAnswer, l as StorefrontCollectionAnswer, r as StorefrontSuggestAnswer, n as StorefrontConfigAnswer, q as StorefrontReviewsAnswer, d as ReviewEligibilityAnswer, a as ReviewSubmitInput, R as ReviewSubmitAnswer } from './contract-types-BRyonOYH.js';
+import { C as CartCheckAnswer, j as CartCreateRequest, i as CartCreateAnswer, d as StorefrontListAnswer, g as StorefrontProductAnswer, w as StorefrontRelatedAnswer, r as StorefrontFilterValuesAnswer, l as StorefrontCategoriesAnswer, m as StorefrontCategoryAnswer, z as StorefrontTagsAnswer, o as StorefrontCollectionsAnswer, n as StorefrontCollectionAnswer, y as StorefrontSuggestAnswer, p as StorefrontConfigAnswer, S as StorefrontSettings, v as StorefrontPagesAnswer, u as StorefrontPageAnswer, x as StorefrontReviewsAnswer, f as ReviewEligibilityAnswer, a as ReviewSubmitInput, R as ReviewSubmitAnswer } from './contract-types-BJMeJSTz.js';
 
 type QueryPairs = [string, string][];
 
@@ -36,6 +36,13 @@ type CatalogClientOptions = {
      * the header.
      */
     keyInQuery?: boolean;
+    /**
+     * A preview token (from the dashboard's preview link). Settings and pages
+     * reads then send it as `X-Storefront-Preview` and answer the draft: they
+     * are never cached, here or in the `cache` store. A token that does not
+     * verify is a `401` `PREVIEW_EXPIRED`. Other routes never carry it.
+     */
+    previewToken?: string;
 };
 /** Next.js's `fetch` cache options; the SDK never imports Next. */
 type NextFetchOptions = {
@@ -57,6 +64,14 @@ type CallOptions = {
      */
     next?: NextFetchOptions;
 };
+/** Options of the reads that answer settings (`config`, `settings`, `pages`). */
+type SettingsCallOptions = CallOptions & {
+    /**
+     * The storefront generation the caller knows exists (a change notice names
+     * it). Above the one the edge holds, the answer is read fresh.
+     */
+    minGeneration?: number;
+};
 type RequestSpec = {
     method: 'GET' | 'POST';
     /** Already encoded, starting with `/`. */
@@ -85,6 +100,8 @@ type RequestSpec = {
      * options). A POST takes them in its body, from `context()`.
      */
     context?: 'priced' | 'locale';
+    /** The route answers a draft to a preview token, so the client sends one. */
+    preview?: boolean;
 };
 
 /** A list sort the catalog knows. */
@@ -309,6 +326,24 @@ type CartsNamespace = {
         throttleBaseUrl?: string;
     }): CartSession;
 };
+/** `settings()`: the storefront settings and what versions them. */
+type StorefrontSettingsResult = {
+    settings: StorefrontSettings;
+    settingsVersion: number;
+    generation: number;
+};
+/**
+ * `client.settings()`. The document may later be assembled from more than one
+ * extension (site design and catalog display); callers always read it through
+ * here, so its source can move without a change in the store.
+ */
+type SettingsNamespace = (call?: SettingsCallOptions) => Promise<StorefrontSettingsResult>;
+type PagesNamespace = {
+    /** The published pages, in the store's order. */
+    list(call?: SettingsCallOptions): Promise<StorefrontPagesAnswer>;
+    /** One page; an unknown handle is a `404` `PAGE_NOT_FOUND`. */
+    get(handle: string, call?: SettingsCallOptions): Promise<StorefrontPageAnswer>;
+};
 type CatalogNamespaces = {
     readonly products: ProductsNamespace;
     readonly filters: FiltersNamespace;
@@ -318,7 +353,9 @@ type CatalogNamespaces = {
     readonly suggest: (q: string, opts?: {
         limit?: number;
     } & CallOptions) => Promise<StorefrontSuggestAnswer>;
-    readonly config: (call?: CallOptions) => Promise<StorefrontConfigAnswer>;
+    readonly config: (call?: SettingsCallOptions) => Promise<StorefrontConfigAnswer>;
+    readonly settings: SettingsNamespace;
+    readonly pages: PagesNamespace;
     readonly reviews: ReviewsNamespace;
     readonly carts: CartsNamespace;
 };
@@ -346,4 +383,4 @@ type CustomerCartSource = {
     whenClaimSettled(): Promise<void>;
 };
 
-export type { CustomerCartSource as C, FieldsOption as F, NextFetchOptions as N, OpenCartRef as O, ProductsQuery as P, Redirect as R, SessionCallOptions as S, ThrottleCart as T, CategoryTreeDepth as a, CartWarning as b, CallOptions as c, CartAbsorb as d, CartCheckout as e, CartCheckoutInput as f, CartSession as g, CartSessionBranding as h, CartSessionDetail as i, CartSessionSnapshot as j, CartsNamespace as k, CatalogClientOptions as l, CatalogHttpCache as m, CatalogHttpCacheEntry as n, CatalogNamespaces as o, CategoriesNamespace as p, CollectionsNamespace as q, CustomerTokenSource as r, FiltersNamespace as s, ProductsNamespace as t, ReviewsNamespace as u, StorefrontSort as v, TagsNamespace as w, ThrottleLine as x, RequestSpec as y };
+export type { TagsNamespace as A, ThrottleLine as B, CustomerCartSource as C, RequestSpec as D, FieldsOption as F, NextFetchOptions as N, OpenCartRef as O, ProductsQuery as P, Redirect as R, SessionCallOptions as S, ThrottleCart as T, CategoryTreeDepth as a, CartWarning as b, CallOptions as c, CartAbsorb as d, CartCheckout as e, CartCheckoutInput as f, CartSession as g, CartSessionBranding as h, CartSessionDetail as i, CartSessionSnapshot as j, CartsNamespace as k, CatalogClientOptions as l, CatalogHttpCache as m, CatalogHttpCacheEntry as n, CatalogNamespaces as o, CategoriesNamespace as p, CollectionsNamespace as q, CustomerTokenSource as r, FiltersNamespace as s, PagesNamespace as t, ProductsNamespace as u, ReviewsNamespace as v, SettingsCallOptions as w, SettingsNamespace as x, StorefrontSettingsResult as y, StorefrontSort as z };

package/dist/url.d.cts

@@ -1,6 +1,6 @@
 import { ProductsQuery } from './index.cjs';
 import '@usethrottle/money';
-import './contract-types-BRyonOYH.cjs';
+import './contract-types-BJMeJSTz.cjs';
 
 /** The shop page's selection as URL state (P6-R16). */
 type ShopQuery = {

package/dist/url.d.ts

@@ -1,6 +1,6 @@
 import { ProductsQuery } from './index.js';
 import '@usethrottle/money';
-import './contract-types-BRyonOYH.js';
+import './contract-types-BJMeJSTz.js';
 
 /** The shop page's selection as URL state (P6-R16). */
 type ShopQuery = {

package/dist/{use-query-UWf6Pi5g.d.cts → use-query-C2rfTJd4.d.cts}

@@ -1,4 +1,4 @@
-import { b as CatalogError } from './catalog-error-BOaSKgY3.cjs';
+import { b as CatalogError } from './catalog-error-bG1XHquN.cjs';
 
 type QueryResult<T> = {
     data: T | undefined;

package/dist/{use-query-CR7r5tam.d.ts → use-query-DeCj1hXt.d.ts}

@@ -1,4 +1,4 @@
-import { b as CatalogError } from './catalog-error-CSoPS0-d.js';
+import { b as CatalogError } from './catalog-error-c3BVgU6k.js';
 
 type QueryResult<T> = {
     data: T | undefined;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@usethrottle/catalog",
-  "version": "1.3.0",
+  "version": "1.4.1",
   "description": "Storefront SDK for the Throttle Product Catalog: a typed client, React hooks, server helpers and URL helpers.",
   "license": "MIT",
   "repository": {
@@ -56,6 +56,16 @@
         "default": "./dist/server.cjs"
       }
     },
+    "./next": {
+      "import": {
+        "types": "./dist/next.d.ts",
+        "default": "./dist/next.js"
+      },
+      "require": {
+        "types": "./dist/next.d.cts",
+        "default": "./dist/next.cjs"
+      }
+    },
     "./url": {
       "import": {
         "types": "./dist/url.d.ts",
@@ -89,12 +99,16 @@
   },
   "dependencies": {
     "@usethrottle/errors": "^1.1.0",
-    "@usethrottle/money": "^1.0.0"
+    "@usethrottle/money": "^1.1.0"
   },
   "peerDependencies": {
+    "next": ">=14",
     "react": "^18.2.0 || ^19.0.0"
   },
   "peerDependenciesMeta": {
+    "next": {
+      "optional": true
+    },
     "react": {
       "optional": true
     }