@usethrottle/catalog 1.3.0 → 1.4.1

package/dist/chunk-5AJS3CX5.cjs

@@ -0,0 +1,192 @@
+"use strict";Object.defineProperty(exports, "__esModule", {value: true}); function _nullishCoalesce(lhs, rhsFn) { if (lhs != null) { return lhs; } else { return rhsFn(); } }
+
+
+
+var _chunk2ODFFMZ4cjs = require('./chunk-2ODFFMZ4.cjs');
+
+// src/server/cache-policy.ts
+var UNTIL_CHANGED_REVALIDATE_S = 3600;
+var DEFAULT_CACHE_POLICY = {
+  settings: "until-changed",
+  navigation: "until-changed",
+  pages: "until-changed",
+  product: "until-changed",
+  listings: "60s",
+  facets: "60s",
+  related: "60s",
+  reviews: "60s",
+  search: "60s"
+};
+function decode(segment) {
+  try {
+    return decodeURIComponent(segment);
+  } catch (e) {
+    return segment;
+  }
+}
+function storefrontRoute(path) {
+  const bare = _nullishCoalesce(path.split(/[?#]/u, 1)[0], () => ( ""));
+  const at = bare.indexOf("/v1/storefront/");
+  const parts = (at < 0 ? bare : bare.slice(at + 15)).replace(/^\//u, "");
+  const [first, segment, sub, extra] = parts.split("/");
+  if (extra !== void 0) return null;
+  if (segment === void 0) {
+    switch (first) {
+      case "config":
+      case "products":
+      case "pages":
+      case "categories":
+      case "tags":
+      case "collections":
+      case "suggest":
+        return { route: first };
+      default:
+        return null;
+    }
+  }
+  const handle = decode(segment);
+  if (handle === "") return null;
+  switch (first) {
+    case "filters":
+      return sub === "values" ? { route: "filters" } : null;
+    case "products":
+      if (sub === "related" || sub === "reviews") return { route: sub, handle };
+      return sub === void 0 ? { route: "product", handle } : null;
+    case "pages":
+      return sub === void 0 ? { route: "page", handle } : null;
+    case "categories":
+      return sub === void 0 ? { route: "category", handle } : null;
+    case "collections":
+      return sub === void 0 ? { route: "collection", handle } : null;
+    default:
+      return null;
+  }
+}
+var KIND_OF_ROUTE = {
+  config: "settings",
+  pages: "pages",
+  page: "pages",
+  products: "listings",
+  product: "product",
+  related: "related",
+  reviews: "reviews",
+  filters: "facets",
+  suggest: "search",
+  categories: "listings",
+  category: "listings",
+  collections: "listings",
+  collection: "listings",
+  tags: "listings"
+};
+function cacheKindForPath(path) {
+  const found = storefrontRoute(path);
+  return found === null ? null : _nullishCoalesce(KIND_OF_ROUTE[found.route], () => ( null));
+}
+var DURATION = /^(\d+)([sm])$/u;
+function policyToNext(policy) {
+  if (policy === "no-store") return "no-store";
+  if (policy === "until-changed")
+    return { revalidate: UNTIL_CHANGED_REVALIDATE_S };
+  const match = typeof policy === "string" ? DURATION.exec(policy) : null;
+  if (match === null) {
+    throw new (0, _chunk2ODFFMZ4cjs.CatalogError)({
+      code: "INVALID_REQUEST",
+      message: "A cache policy is 'until-changed', 'no-store' or a duration such as '90s' or '5m'.",
+      statusCode: 0,
+      source: "client",
+      retryable: false
+    });
+  }
+  const seconds = Number(match[1]) * (match[2] === "m" ? 60 : 1);
+  return seconds === 0 ? "no-store" : { revalidate: seconds };
+}
+
+// src/server/min-generation.ts
+var EVERY_STORE = Symbol("every-store");
+var floors = /* @__PURE__ */ new Map();
+function noteMinGeneration(generation, floorKey) {
+  if (!Number.isSafeInteger(generation) || generation < 0) return;
+  const key = _nullishCoalesce(floorKey, () => ( EVERY_STORE));
+  const known = floors.get(key);
+  if (known === void 0 || generation > known) floors.set(key, generation);
+}
+function pendingMinGeneration(floorKey) {
+  const own = floors.get(floorKey);
+  const every = floors.get(EVERY_STORE);
+  return own === void 0 || every !== void 0 && every > own ? every : own;
+}
+function observeGeneration(generation, floorKey) {
+  if (typeof generation !== "number") return;
+  for (const key of [floorKey, EVERY_STORE]) {
+    const floor = floors.get(key);
+    if (floor !== void 0 && generation >= floor) floors.delete(key);
+  }
+}
+
+// src/server/tags.ts
+function familyOf(route) {
+  if (route === "config") return "config";
+  return route === "pages" || route === "page" ? "pages" : "data";
+}
+function catalogTags(route, handle) {
+  const tags = [_chunk2ODFFMZ4cjs.CACHE_TAG, `${_chunk2ODFFMZ4cjs.CACHE_TAG}:${familyOf(route)}`];
+  if (route !== familyOf(route)) tags.push(`${_chunk2ODFFMZ4cjs.CACHE_TAG}:${route}`);
+  if (handle !== void 0) tags.push(`${_chunk2ODFFMZ4cjs.CACHE_TAG}:${route}:${handle}`);
+  return tags.filter((tag) => tag.length <= _chunk2ODFFMZ4cjs.TAG_MAX_CHARS);
+}
+function tagsForUrl(url, storefront) {
+  const path = _nullishCoalesce(url.split(/[?#]/u, 1)[0], () => ( ""));
+  if (!path.startsWith(storefront)) return null;
+  const found = storefrontRoute(path.slice(storefront.length));
+  return found === null ? null : catalogTags(found.route, found.handle);
+}
+var family = (name) => `${_chunk2ODFFMZ4cjs.CACHE_TAG}:${name}`;
+function tagsForScope(scope) {
+  const colon = scope.indexOf(":");
+  const name = colon < 0 ? scope : scope.slice(0, colon);
+  const handle = colon < 0 ? "" : scope.slice(colon + 1);
+  switch (scope) {
+    case "settings":
+    case "navigation":
+      return [family("config")];
+    case "filters":
+      return [family("config"), family("data")];
+    case "pages":
+      return [family("pages")];
+    case "taxonomy":
+    case "catalog":
+      return [family("data")];
+  }
+  if (handle !== "") {
+    if (name === "product" || name === "collection" || name === "category")
+      return [`${family(name)}:${handle}`, family("data")];
+    if (name === "reviews")
+      return [
+        `${family("reviews")}:${handle}`,
+        `${family("product")}:${handle}`
+      ];
+  }
+  return [family("data")];
+}
+function scopesToTags(scopes) {
+  const out = /* @__PURE__ */ new Set();
+  for (const scope of scopes) {
+    for (const tag of tagsForScope(scope)) {
+      if (tag.length <= _chunk2ODFFMZ4cjs.TAG_MAX_CHARS) out.add(tag);
+    }
+  }
+  return [...out];
+}
+
+
+
+
+
+
+
+
+
+
+
+
+exports.DEFAULT_CACHE_POLICY = DEFAULT_CACHE_POLICY; exports.storefrontRoute = storefrontRoute; exports.cacheKindForPath = cacheKindForPath; exports.policyToNext = policyToNext; exports.noteMinGeneration = noteMinGeneration; exports.pendingMinGeneration = pendingMinGeneration; exports.observeGeneration = observeGeneration; exports.catalogTags = catalogTags; exports.tagsForUrl = tagsForUrl; exports.scopesToTags = scopesToTags;

package/dist/{chunk-CADIHOIR.js → chunk-6K7H7HBD.js}

@@ -6,7 +6,7 @@ import {
   STALE_MS,
   SUGGEST_DEBOUNCE_MS,
   SUGGEST_MIN_CHARS
-} from "./chunk-3DLH56OX.js";
+} from "./chunk-STNQNHNZ.js";
 
 // src/react/provider.tsx
 import {
@@ -183,6 +183,21 @@ function createStore(client, options = {}) {
       }
     }
   }
+  function invalidate() {
+    for (const [key, entry] of [...entries]) {
+      clearTimeout(entry.timer);
+      clearTimeout(entry.retry);
+      entry.flight?.abort();
+      if (entry.subs.size === 0) {
+        entries.delete(key);
+      } else {
+        entry.etag = entry.flight = entry.promise = void 0;
+        entry.indexing = false;
+        entry.retries = 0;
+        if (entry.run) void fetchKey(key, entry.run, { force: true });
+      }
+    }
+  }
   return {
     subscribe(key, listener) {
       const entry = touch(key);
@@ -202,6 +217,7 @@ function createStore(client, options = {}) {
     },
     fetch: fetchKey,
     clear,
+    invalidate,
     pause,
     pausedUntil: () => until > now() ? until : 0,
     dispose() {
@@ -360,7 +376,7 @@ function useQuery(route, params, run, options = {}) {
 }
 
 // src/react/hooks.ts
-import { useEffect as useEffect3, useMemo as useMemo2, useSyncExternalStore as useSyncExternalStore2 } from "react";
+import { useEffect as useEffect3, useMemo as useMemo2, useRef as useRef3, useSyncExternalStore as useSyncExternalStore2 } from "react";
 function defined(options) {
   const out = {};
   for (const name in options) {
@@ -466,6 +482,75 @@ function useConfig(options) {
     options
   );
 }
+function useStorefrontSettings(options) {
+  return useQuery(
+    "settings",
+    null,
+    (client, call) => client.settings(call),
+    options
+  );
+}
+var watches = /* @__PURE__ */ new WeakMap();
+var watchRun = (client, call) => client.config(call);
+var pageDocument = () => Reflect.get(globalThis, "document");
+function watch(store, intervalMs, listener) {
+  let w = watches.get(store);
+  if (w === void 0) {
+    const key = `\0${catalogQueryKey("generation", null)}`;
+    const visible = () => pageDocument().visibilityState === "visible";
+    const listeners = /* @__PURE__ */ new Set();
+    let known;
+    let hiddenAt = visible() ? 0 : Date.now();
+    const check = async () => {
+      if (!visible()) return;
+      await store.fetch(key, watchRun, { force: true });
+      const data = store.get(key).data;
+      if (watches.get(store) !== w || data?.generation === void 0) return;
+      const changed = known !== void 0 && data.generation !== known;
+      known = data.generation;
+      if (changed) {
+        store.invalidate();
+        for (const { current } of [...listeners]) current?.(known);
+      }
+    };
+    const onVisibility = () => {
+      if (!visible()) hiddenAt = Date.now();
+      else {
+        if (known === void 0 || Date.now() - hiddenAt >= intervalMs)
+          void check();
+        hiddenAt = 0;
+      }
+    };
+    void check();
+    const timer = setInterval(() => void check(), intervalMs);
+    const doc = pageDocument();
+    doc.addEventListener("visibilitychange", onVisibility);
+    w = {
+      listeners,
+      stop() {
+        clearInterval(timer);
+        doc.removeEventListener("visibilitychange", onVisibility);
+        watches.delete(store);
+      }
+    };
+    watches.set(store, w);
+  }
+  const mine = w;
+  mine.listeners.add(listener);
+  return () => {
+    mine.listeners.delete(listener);
+    if (mine.listeners.size === 0) mine.stop();
+  };
+}
+function useGenerationWatch({
+  intervalMs = 6e4,
+  onChange
+} = {}) {
+  const { store } = useCatalogContext();
+  const latest = useRef3(onChange);
+  latest.current = onChange;
+  useEffect3(() => watch(store, intervalMs, latest), [store, intervalMs]);
+}
 function useFilterValues(key, query = {}, options) {
   return useQuery(
     "filterValues",
@@ -492,5 +577,7 @@ export {
   useCollection,
   useReviews,
   useConfig,
+  useStorefrontSettings,
+  useGenerationWatch,
   useFilterValues
 };

package/dist/chunk-P3ABGAF5.js

@@ -0,0 +1,192 @@
+import {
+  CACHE_TAG,
+  CatalogError,
+  TAG_MAX_CHARS
+} from "./chunk-STNQNHNZ.js";
+
+// src/server/cache-policy.ts
+var UNTIL_CHANGED_REVALIDATE_S = 3600;
+var DEFAULT_CACHE_POLICY = {
+  settings: "until-changed",
+  navigation: "until-changed",
+  pages: "until-changed",
+  product: "until-changed",
+  listings: "60s",
+  facets: "60s",
+  related: "60s",
+  reviews: "60s",
+  search: "60s"
+};
+function decode(segment) {
+  try {
+    return decodeURIComponent(segment);
+  } catch {
+    return segment;
+  }
+}
+function storefrontRoute(path) {
+  const bare = path.split(/[?#]/u, 1)[0] ?? "";
+  const at = bare.indexOf("/v1/storefront/");
+  const parts = (at < 0 ? bare : bare.slice(at + 15)).replace(/^\//u, "");
+  const [first, segment, sub, extra] = parts.split("/");
+  if (extra !== void 0) return null;
+  if (segment === void 0) {
+    switch (first) {
+      case "config":
+      case "products":
+      case "pages":
+      case "categories":
+      case "tags":
+      case "collections":
+      case "suggest":
+        return { route: first };
+      default:
+        return null;
+    }
+  }
+  const handle = decode(segment);
+  if (handle === "") return null;
+  switch (first) {
+    case "filters":
+      return sub === "values" ? { route: "filters" } : null;
+    case "products":
+      if (sub === "related" || sub === "reviews") return { route: sub, handle };
+      return sub === void 0 ? { route: "product", handle } : null;
+    case "pages":
+      return sub === void 0 ? { route: "page", handle } : null;
+    case "categories":
+      return sub === void 0 ? { route: "category", handle } : null;
+    case "collections":
+      return sub === void 0 ? { route: "collection", handle } : null;
+    default:
+      return null;
+  }
+}
+var KIND_OF_ROUTE = {
+  config: "settings",
+  pages: "pages",
+  page: "pages",
+  products: "listings",
+  product: "product",
+  related: "related",
+  reviews: "reviews",
+  filters: "facets",
+  suggest: "search",
+  categories: "listings",
+  category: "listings",
+  collections: "listings",
+  collection: "listings",
+  tags: "listings"
+};
+function cacheKindForPath(path) {
+  const found = storefrontRoute(path);
+  return found === null ? null : KIND_OF_ROUTE[found.route] ?? null;
+}
+var DURATION = /^(\d+)([sm])$/u;
+function policyToNext(policy) {
+  if (policy === "no-store") return "no-store";
+  if (policy === "until-changed")
+    return { revalidate: UNTIL_CHANGED_REVALIDATE_S };
+  const match = typeof policy === "string" ? DURATION.exec(policy) : null;
+  if (match === null) {
+    throw new CatalogError({
+      code: "INVALID_REQUEST",
+      message: "A cache policy is 'until-changed', 'no-store' or a duration such as '90s' or '5m'.",
+      statusCode: 0,
+      source: "client",
+      retryable: false
+    });
+  }
+  const seconds = Number(match[1]) * (match[2] === "m" ? 60 : 1);
+  return seconds === 0 ? "no-store" : { revalidate: seconds };
+}
+
+// src/server/min-generation.ts
+var EVERY_STORE = Symbol("every-store");
+var floors = /* @__PURE__ */ new Map();
+function noteMinGeneration(generation, floorKey) {
+  if (!Number.isSafeInteger(generation) || generation < 0) return;
+  const key = floorKey ?? EVERY_STORE;
+  const known = floors.get(key);
+  if (known === void 0 || generation > known) floors.set(key, generation);
+}
+function pendingMinGeneration(floorKey) {
+  const own = floors.get(floorKey);
+  const every = floors.get(EVERY_STORE);
+  return own === void 0 || every !== void 0 && every > own ? every : own;
+}
+function observeGeneration(generation, floorKey) {
+  if (typeof generation !== "number") return;
+  for (const key of [floorKey, EVERY_STORE]) {
+    const floor = floors.get(key);
+    if (floor !== void 0 && generation >= floor) floors.delete(key);
+  }
+}
+
+// src/server/tags.ts
+function familyOf(route) {
+  if (route === "config") return "config";
+  return route === "pages" || route === "page" ? "pages" : "data";
+}
+function catalogTags(route, handle) {
+  const tags = [CACHE_TAG, `${CACHE_TAG}:${familyOf(route)}`];
+  if (route !== familyOf(route)) tags.push(`${CACHE_TAG}:${route}`);
+  if (handle !== void 0) tags.push(`${CACHE_TAG}:${route}:${handle}`);
+  return tags.filter((tag) => tag.length <= TAG_MAX_CHARS);
+}
+function tagsForUrl(url, storefront) {
+  const path = url.split(/[?#]/u, 1)[0] ?? "";
+  if (!path.startsWith(storefront)) return null;
+  const found = storefrontRoute(path.slice(storefront.length));
+  return found === null ? null : catalogTags(found.route, found.handle);
+}
+var family = (name) => `${CACHE_TAG}:${name}`;
+function tagsForScope(scope) {
+  const colon = scope.indexOf(":");
+  const name = colon < 0 ? scope : scope.slice(0, colon);
+  const handle = colon < 0 ? "" : scope.slice(colon + 1);
+  switch (scope) {
+    case "settings":
+    case "navigation":
+      return [family("config")];
+    case "filters":
+      return [family("config"), family("data")];
+    case "pages":
+      return [family("pages")];
+    case "taxonomy":
+    case "catalog":
+      return [family("data")];
+  }
+  if (handle !== "") {
+    if (name === "product" || name === "collection" || name === "category")
+      return [`${family(name)}:${handle}`, family("data")];
+    if (name === "reviews")
+      return [
+        `${family("reviews")}:${handle}`,
+        `${family("product")}:${handle}`
+      ];
+  }
+  return [family("data")];
+}
+function scopesToTags(scopes) {
+  const out = /* @__PURE__ */ new Set();
+  for (const scope of scopes) {
+    for (const tag of tagsForScope(scope)) {
+      if (tag.length <= TAG_MAX_CHARS) out.add(tag);
+    }
+  }
+  return [...out];
+}
+
+export {
+  DEFAULT_CACHE_POLICY,
+  storefrontRoute,
+  cacheKindForPath,
+  policyToNext,
+  noteMinGeneration,
+  pendingMinGeneration,
+  observeGeneration,
+  catalogTags,
+  tagsForUrl,
+  scopesToTags
+};