@usethrottle/catalog 1.3.0 → 1.4.0

package/dist/{chunk-3DLH56OX.js → chunk-VJHA7J7B.js}

@@ -3,7 +3,7 @@ import {
 } from "./chunk-PKBMQBKP.js";
 
 // src/version.ts
-var SDK_VERSION = true ? "1.3.0" : "0.0.0-dev";
+var SDK_VERSION = true ? "1.4.0" : "0.0.0-dev";
 
 // src/index.ts
 import * as money from "@usethrottle/money";
@@ -140,7 +140,6 @@ var SUGGEST_MIN_CHARS = 2;
 var INDEXING_REVALIDATE_MS = 3e4;
 var CACHE_TAG = "throttle-catalog";
 var TAG_MAX_CHARS = 256;
-var DEFAULT_REVALIDATE_S = 60;
 var LIST_PAGE_SIZE = 100;
 var LIST_MAX_HANDLES = 5e4;
 var CATEGORY_TREE_MAX_DEPTH = 10;
@@ -182,6 +181,8 @@ var ERROR_KINDS = Object.freeze({
   ALREADY_REVIEWED: "base",
   REVIEW_QUEUE_FULL: "rateLimited",
   REVIEW_VERIFICATION_UNAVAILABLE: "base",
+  PAGE_NOT_FOUND: "base",
+  PREVIEW_EXPIRED: "base",
   // Throttle cart-session codes.
   price_locked: "base",
   quantity_unavailable: "cartLine",
@@ -388,7 +389,8 @@ var RESERVED_HEADERS = /* @__PURE__ */ new Set([
   "x-customer-token",
   "if-none-match",
   "idempotency-key",
-  "content-type"
+  "content-type",
+  "x-storefront-preview"
 ]);
 var MAX_TIMEOUT_MS = 2147483647;
 function optionError(code, message) {
@@ -439,6 +441,16 @@ function checkTimeout(timeoutMs) {
   }
   return Math.min(timeoutMs, MAX_TIMEOUT_MS);
 }
+function checkPreviewToken(token) {
+  if (token === void 0 || token === "") return void 0;
+  if (typeof token !== "string" || !/^[\x21-\x7e]+$/u.test(token)) {
+    throw optionError(
+      "INVALID_REQUEST",
+      "previewToken must be a string of visible ASCII characters."
+    );
+  }
+  return token;
+}
 function checkBaseUrl(baseUrl) {
   if (!isHttpUrl(baseUrl)) {
     throw optionError(
@@ -473,7 +485,8 @@ function resolveOptions(options) {
     cacheScope: options.cacheScope,
     indexingMaxWaitSeconds: retry === false ? null : retry?.maxWaitSeconds ?? INDEXING_MAX_WAIT_S,
     headers: checkHeaders(options.headers),
-    keyInQuery: keyInQuery === true
+    keyInQuery: keyInQuery === true,
+    previewToken: checkPreviewToken(options.previewToken)
   };
 }
 
@@ -635,7 +648,8 @@ function createTransport(o) {
     }
     let cacheKey;
     let cached;
-    const bypassCache = spec.tokenFree === true && keyInUrl;
+    const previewToken = spec.preview === true ? o.previewToken : void 0;
+    const bypassCache = spec.tokenFree === true && keyInUrl || previewToken !== void 0;
     if (isGet && !bypassCache && o.cache !== void 0 && spec.ifNoneMatch === void 0) {
       try {
         const scope = o.cacheScope === void 0 || spec.tokenFree === true ? "" : o.cacheScope();
@@ -653,6 +667,8 @@ function createTransport(o) {
     if (!keyInUrl) headers["x-catalog-key"] = o.publishableKey;
     if (!isGet) headers["content-type"] = "application/json";
     if (ifNoneMatch !== void 0) headers["if-none-match"] = ifNoneMatch;
+    if (previewToken !== void 0)
+      headers["x-storefront-preview"] = previewToken;
     if (spec.idempotencyKey !== void 0)
       headers["idempotency-key"] = spec.idempotencyKey;
     const body = isGet ? void 0 : JSON.stringify(spec.body ?? {});
@@ -677,7 +693,7 @@ function createTransport(o) {
         method: spec.method,
         headers: token === null ? headers : { ...headers, "x-customer-token": token }
       };
-      if (token !== null) {
+      if (token !== null || previewToken !== void 0) {
         delete init.next;
         init.cache = "no-store";
       } else if (call.next !== void 0) init.next = call.next;
@@ -915,8 +931,47 @@ function createCarts(transport, options) {
   };
 }
 
-// src/core/products.ts
+// src/core/pages.ts
 var SF = "/v1/storefront";
+function createPages(transport) {
+  return {
+    list: (call) => read(
+      transport,
+      {
+        method: "GET",
+        path: `${SF}/pages`,
+        query: buildQuery({ minGeneration: call?.minGeneration }, [
+          "minGeneration"
+        ]),
+        customerToken: "none",
+        tokenFallback: "anonymous",
+        featureRoute: true,
+        context: "locale",
+        preview: true
+      },
+      call
+    ),
+    get: (handle, call) => read(
+      transport,
+      {
+        method: "GET",
+        path: `${SF}/pages/${pathSegment(handle)}`,
+        query: buildQuery({ minGeneration: call?.minGeneration }, [
+          "minGeneration"
+        ]),
+        customerToken: "none",
+        tokenFallback: "anonymous",
+        featureRoute: false,
+        context: "locale",
+        preview: true
+      },
+      call
+    )
+  };
+}
+
+// src/core/products.ts
+var SF2 = "/v1/storefront";
 var LIST_ORDER = [
   "q",
   "category",
@@ -978,7 +1033,7 @@ function createProducts(transport) {
       transport,
       {
         method: "GET",
-        path: `${SF}/products`,
+        path: `${SF2}/products`,
         query: productsQuery(query),
         customerToken: "optional",
         tokenFallback: "anonymous",
@@ -991,7 +1046,7 @@ function createProducts(transport) {
       transport,
       {
         method: "GET",
-        path: `${SF}/products/${pathSegment(handle)}`,
+        path: `${SF2}/products/${pathSegment(handle)}`,
         // Always the full product (P6-R18).
         query: buildQuery(
           { fields: "full", include: commaList(opts?.include) },
@@ -1008,7 +1063,7 @@ function createProducts(transport) {
       transport,
       {
         method: "GET",
-        path: `${SF}/products/${pathSegment(handle)}/related`,
+        path: `${SF2}/products/${pathSegment(handle)}/related`,
         query: buildQuery(
           { limit: opts?.limit, fields: commaList(opts?.fields) },
           ["limit", "fields"]
@@ -1028,7 +1083,7 @@ function createFilters(transport) {
       transport,
       {
         method: "GET",
-        path: `${SF}/filters/${pathSegment(key)}/values`,
+        path: `${SF2}/filters/${pathSegment(key)}/values`,
         query: productsQuery(query),
         customerToken: "none",
         tokenFallback: "anonymous",
@@ -1045,7 +1100,7 @@ function createSuggest(transport) {
     transport,
     {
       method: "GET",
-      path: `${SF}/suggest`,
+      path: `${SF2}/suggest`,
       query: buildQuery({ q, limit: opts?.limit }, ["q", "limit"]),
       // Never a customer token (P8-R22): list prices for everyone.
       customerToken: "none",
@@ -1113,15 +1168,184 @@ function createReviews(transport) {
   };
 }
 
+// src/core/settings.ts
+var DEFAULT_STRINGS = {
+  "shop.title": "Shop",
+  "shop.description": "Browse the full catalog.",
+  "search.title": "Search",
+  "search.placeholder": "Search products",
+  "search.results": 'Results for "{q}"',
+  "empty.search": "No results found. Try a different search.",
+  "empty.listing": "No products match your filters.",
+  "empty.category": "No products in this category yet.",
+  "empty.collection": "No products in this collection yet.",
+  "empty.cart": "Your cart is empty.",
+  "cart.title": "Cart",
+  "cart.checkout": "Checkout",
+  "cart.continueShopping": "Continue shopping",
+  "filters.title": "Filters",
+  "filters.clearAll": "Clear all",
+  "filters.apply": "Apply",
+  "filters.showMore": "Show more",
+  "filters.showLess": "Show less",
+  "filters.priceMin": "Min",
+  "filters.priceMax": "Max",
+  "boolean.yes": "Yes",
+  "boolean.no": "No",
+  "sort.label": "Sort by",
+  "listing.count": "{count} products",
+  "listing.loadMore": "Load more",
+  "listing.loading": "Loading\u2026",
+  "listing.previous": "Previous",
+  "listing.next": "Next",
+  "product.addToCart": "Add to cart",
+  "product.quantity": "Quantity",
+  "product.selectOption": "Select {option}",
+  "product.sku": "SKU",
+  "product.description": "Description",
+  "product.specs": "Specifications",
+  "product.shipping": "Shipping",
+  "product.tags": "Tags",
+  "product.categories": "Categories",
+  "product.related": "You may also like",
+  "product.reviews": "Reviews",
+  "product.noReviews": "No reviews yet.",
+  "product.writeReview": "Write a review",
+  "home.shopAll": "Shop all",
+  "home.featured": "Featured",
+  "home.newest": "New arrivals",
+  "home.bestRated": "Best rated",
+  "home.categories": "Shop by category",
+  "footer.copyright": "\xA9 {year} {store}. All rights reserved.",
+  "nav.menu": "Menu",
+  "nav.account": "Account",
+  "nav.cart": "Cart",
+  "error.notFound": "Page not found",
+  "error.generic": "Something went wrong. Please try again."
+};
+function t(settings, key, vars) {
+  const text = settings?.strings?.[key] || DEFAULT_STRINGS[key];
+  return vars === void 0 ? text : text.replace(
+    /\{(\w+)\}/gu,
+    (whole, name) => Object.hasOwn(vars, name) ? String(vars[name]) : whole
+  );
+}
+function fill(pattern, name, value) {
+  return pattern.split(`{${name}}`).join(encodeURIComponent(value));
+}
+var SAFE_HREF = /^(?:https?:\/\/[^\s]|\/(?![/\\]))/iu;
+var UNSAFE_CHARACTER2 = /[\u0000-\u0020\u007f\s]/u;
+function resolveMenuTarget(settings, target) {
+  const { routes } = settings;
+  const { kind, handle, q, href } = target;
+  switch (kind) {
+    case "product":
+    case "category":
+    case "collection":
+    case "page":
+      return handle === void 0 ? null : fill(routes[kind], "handle", handle);
+    case "search":
+      return q === void 0 ? null : fill(routes.search, "q", q);
+    case "url":
+      return href !== void 0 && !UNSAFE_CHARACTER2.test(href) && SAFE_HREF.test(href) ? href : null;
+    default:
+      return null;
+  }
+}
+var SERIF = /* @__PURE__ */ new Set([
+  "Instrument Serif",
+  "Playfair Display",
+  "Lora",
+  "Merriweather",
+  "Cormorant Garamond",
+  "EB Garamond",
+  "Libre Baskerville",
+  "Source Serif 4",
+  "Fraunces",
+  "DM Serif Display"
+]);
+var MONO = /* @__PURE__ */ new Set([
+  "DM Mono",
+  "JetBrains Mono",
+  "IBM Plex Mono",
+  "Space Mono"
+]);
+var WEIGHTS_OF = {
+  "Instrument Serif": [400],
+  "DM Serif Display": [400],
+  "Bebas Neue": [400],
+  "Archivo Black": [400],
+  Merriweather: [400, 700],
+  "Libre Baskerville": [400, 700],
+  Lato: [400, 700],
+  "Space Mono": [400, 700],
+  "DM Mono": [400, 500]
+};
+var STACKS = {
+  sans: "system-ui, -apple-system, 'Segoe UI', Roboto, sans-serif",
+  serif: "Georgia, 'Times New Roman', serif",
+  mono: "ui-monospace, SFMono-Regular, Menlo, Consolas, monospace"
+};
+function fontStylesheetHref(theme) {
+  const families = /* @__PURE__ */ new Set();
+  for (const family of [
+    theme.fonts.heading,
+    theme.fonts.body,
+    theme.fonts.mono
+  ])
+    if (!family.startsWith("system-")) families.add(family);
+  if (families.size === 0) return null;
+  let href = "https://fonts.googleapis.com/css2?";
+  for (const family of families) {
+    const weights = WEIGHTS_OF[family] ?? [400, 500, 600, 700];
+    href += `family=${family.replace(/ /gu, "+")}:wght@${weights.join(";")}&`;
+  }
+  return `${href}display=swap`;
+}
+function fontStack(family) {
+  if (family.startsWith("system-"))
+    return STACKS[family.slice(7)] ?? STACKS.sans;
+  const kind = SERIF.has(family) ? "serif" : MONO.has(family) ? "mono" : "sans";
+  return `'${family}', ${STACKS[kind]}`;
+}
+function toAuthAppearance(theme, scheme) {
+  const p = theme[scheme];
+  return {
+    theme: scheme,
+    variables: {
+      colorPrimary: p.colorPrimary,
+      colorPrimaryForeground: p.colorPrimaryForeground,
+      colorBackground: p.colorBackground,
+      colorSurface: p.colorSurface,
+      colorForeground: p.colorForeground,
+      colorMuted: p.colorMuted,
+      colorMutedForeground: p.colorMutedForeground,
+      colorBorder: p.colorBorder,
+      colorBorderControl: p.colorBorderControl,
+      colorDanger: p.colorDanger,
+      colorSuccess: p.colorSuccess,
+      colorWarning: p.colorWarning,
+      fontFamily: fontStack(theme.fonts.body),
+      borderRadius: `${theme.radius}px`
+    }
+  };
+}
+function createSettings(config) {
+  return async (call) => {
+    const { settings, settingsVersion, generation } = await config(call);
+    return { settings, settingsVersion, generation };
+  };
+}
+
 // src/core/taxonomy.ts
-var SF2 = "/v1/storefront";
+var SF3 = "/v1/storefront";
 function createCategories(transport) {
   return {
     tree: (opts) => read(
       transport,
       {
         method: "GET",
-        path: `${SF2}/categories`,
+        path: `${SF3}/categories`,
         query: buildQuery({ depth: opts?.depth }, ["depth"]),
         customerToken: "none",
         tokenFallback: "anonymous",
@@ -1134,7 +1358,7 @@ function createCategories(transport) {
       transport,
       {
         method: "GET",
-        path: `${SF2}/categories/${pathSegment(handle)}`,
+        path: `${SF3}/categories/${pathSegment(handle)}`,
         customerToken: "none",
         tokenFallback: "anonymous",
         featureRoute: false,
@@ -1150,7 +1374,7 @@ function createTags(transport) {
       transport,
       {
         method: "GET",
-        path: `${SF2}/tags`,
+        path: `${SF3}/tags`,
         query: buildQuery({ q: opts?.q, limit: opts?.limit }, ["q", "limit"]),
         customerToken: "none",
         tokenFallback: "anonymous",
@@ -1166,7 +1390,7 @@ function createCollections(transport) {
       transport,
       {
         method: "GET",
-        path: `${SF2}/collections`,
+        path: `${SF3}/collections`,
         query: buildQuery({ limit: opts?.limit, cursor: opts?.cursor }, [
           "limit",
           "cursor"
@@ -1182,7 +1406,7 @@ function createCollections(transport) {
       transport,
       {
         method: "GET",
-        path: `${SF2}/collections/${pathSegment(handle)}`,
+        path: `${SF3}/collections/${pathSegment(handle)}`,
         customerToken: "none",
         tokenFallback: "anonymous",
         featureRoute: false,
@@ -1197,10 +1421,15 @@ function createConfig(transport) {
     transport,
     {
       method: "GET",
-      path: `${SF2}/config`,
+      path: `${SF3}/config`,
+      query: buildQuery({ minGeneration: call?.minGeneration }, [
+        "minGeneration"
+      ]),
       customerToken: "none",
       tokenFallback: "anonymous",
-      featureRoute: true
+      featureRoute: true,
+      context: "locale",
+      preview: true
     },
     call
   );
@@ -1213,6 +1442,7 @@ var TRANSPORT = Symbol.for(
 function createCatalogClient(options) {
   const resolved = resolveOptions(options);
   const transport = createTransport(resolved);
+  const config = createConfig(transport);
   return {
     [TRANSPORT]: transport,
     products: createProducts(transport),
@@ -1221,7 +1451,9 @@ function createCatalogClient(options) {
     tags: createTags(transport),
     collections: createCollections(transport),
     suggest: createSuggest(transport),
-    config: createConfig(transport),
+    config,
+    settings: createSettings(config),
+    pages: createPages(transport),
     reviews: createReviews(transport),
     carts: createCarts(transport, resolved)
   };
@@ -1248,10 +1480,14 @@ export {
   INDEXING_REVALIDATE_MS,
   CACHE_TAG,
   TAG_MAX_CHARS,
-  DEFAULT_REVALIDATE_S,
   LIST_PAGE_SIZE,
   LIST_MAX_HANDLES,
   CATEGORY_TREE_MAX_DEPTH,
+  DEFAULT_STRINGS,
+  t,
+  resolveMenuTarget,
+  fontStylesheetHref,
+  toAuthAppearance,
   createCatalogClient,
   money,
   CURRENCIES,

package/dist/{client-B3mL2-xJ.d.ts → client-B6CsU_v9.d.ts}

@@ -1,4 +1,4 @@
-import { y as RequestSpec, c as CallOptions, o as CatalogNamespaces, l as CatalogClientOptions } from './types-BfveENg1.js';
+import { D as RequestSpec, c as CallOptions, o as CatalogNamespaces, l as CatalogClientOptions } from './types-z57bkjjB.js';
 
 /** A `304` is possible only when `ifNoneMatch` (not the client cache) sent `If-None-Match`. */
 type TransportResult<T> = {

package/dist/{client-6j1Iz-iJ.d.cts → client-terkEl6u.d.cts}

@@ -1,4 +1,4 @@
-import { y as RequestSpec, c as CallOptions, o as CatalogNamespaces, l as CatalogClientOptions } from './types-D0PywKnN.cjs';
+import { D as RequestSpec, c as CallOptions, o as CatalogNamespaces, l as CatalogClientOptions } from './types-jNpOwEUw.cjs';
 
 /** A `304` is possible only when `ifNoneMatch` (not the client cache) sent `If-None-Match`. */
 type TransportResult<T> = {