@tiledev/sdk-shopify 0.5.0 → 0.7.0

package/dist/react/useCollectionProducts.d.ts

@@ -1,4 +1,5 @@
-import type { Filter, Product, ProductFilter } from '../types';
+import { type ProductFeedResult, type ProductFeedState } from './useProductFeed';
+import type { ImageTransform, ProductFilter } from '../types';
 /** How a collection is ordered. `key` is a Storefront `ProductCollectionSortKeys` value. */
 export interface CollectionSort {
     key: string;
@@ -10,9 +11,15 @@ export interface UseCollectionProductsOptions {
     handle: string | null | undefined;
     /** Storefront sort. Omit for the merchant's own collection order. */
     sort?: CollectionSort;
-    /** Shopify's own product filters — a `FilterValue.input` parsed and handed back, never hand-built. */
+    /**
+     * Filters the app always applies, e.g. in stock only. Shopify's own product filters: a
+     * `FilterValue.input` parsed and handed back, never hand-built. The shopper's selection
+     * (`setFilters`) is applied on top.
+     */
     filters?: ProductFilter[];
     pageSize?: number;
+    /** Resize/convert the products' images on Shopify's CDN, e.g. `{ maxWidth: 330, scale: 2 }`. */
+    imageTransform?: ImageTransform;
     /**
      * Called with any transport error (first page or paging) so the host app can log it — the hook has
      * no logger of its own. Optional; when omitted the error only surfaces as `error` / a stopped feed.
@@ -22,22 +29,7 @@ export interface UseCollectionProductsOptions {
         handle: string;
     }) => void;
 }
-export interface CollectionProductsState {
-    products: Product[];
-    /** Null until the first read resolves, so a screen can render its own heading first. */
-    title: string | null;
-    /** The facets Shopify offers for this collection under the current filters. */
-    availableFilters: Filter[];
-    /** A first page is in flight: the grid has nothing to show yet. */
-    loading: boolean;
-    /** A later page is in flight: the grid keeps what it has and shows a footer spinner. */
-    loadingMore: boolean;
-    hasMore: boolean;
-    error: boolean;
-}
-export interface UseCollectionProductsResult extends CollectionProductsState {
-    loadMore: () => void;
-    retry: () => void;
-}
-export declare function useCollectionProducts({ handle, sort, filters, pageSize, onError, }: UseCollectionProductsOptions): UseCollectionProductsResult;
+export type CollectionProductsState = ProductFeedState;
+export type UseCollectionProductsResult = ProductFeedResult;
+export declare function useCollectionProducts({ handle, sort, filters, pageSize, imageTransform, onError, }: UseCollectionProductsOptions): UseCollectionProductsResult;
 //# sourceMappingURL=useCollectionProducts.d.ts.map

package/dist/react/useCollectionProducts.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"useCollectionProducts.d.ts","sourceRoot":"","sources":["../../src/react/useCollectionProducts.ts"],"names":[],"mappings":"AAgBA,OAAO,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AAE/D,4FAA4F;AAC5F,MAAM,WAAW,cAAc;IAC7B,GAAG,EAAE,MAAM,CAAC;IACZ,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB;AAED,oFAAoF;AACpF,eAAO,MAAM,oBAAoB,KAAK,CAAC;AAEvC,MAAM,WAAW,4BAA4B;IAC3C,MAAM,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC;IAClC,qEAAqE;IACrE,IAAI,CAAC,EAAE,cAAc,CAAC;IACtB,sGAAsG;IACtG,OAAO,CAAC,EAAE,aAAa,EAAE,CAAC;IAC1B,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;;OAGG;IACH,OAAO,CAAC,EAAE,CAAC,KAAK,EAAE,OAAO,EAAE,OAAO,EAAE;QAAE,EAAE,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,MAAM,CAAA;KAAE,KAAK,IAAI,CAAC;CAC7E;AAED,MAAM,WAAW,uBAAuB;IACtC,QAAQ,EAAE,OAAO,EAAE,CAAC;IACpB,wFAAwF;IACxF,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IACrB,+EAA+E;IAC/E,gBAAgB,EAAE,MAAM,EAAE,CAAC;IAC3B,mEAAmE;IACnE,OAAO,EAAE,OAAO,CAAC;IACjB,wFAAwF;IACxF,WAAW,EAAE,OAAO,CAAC;IACrB,OAAO,EAAE,OAAO,CAAC;IACjB,KAAK,EAAE,OAAO,CAAC;CAChB;AAED,MAAM,WAAW,2BAA4B,SAAQ,uBAAuB;IAC1E,QAAQ,EAAE,MAAM,IAAI,CAAC;IACrB,KAAK,EAAE,MAAM,IAAI,CAAC;CACnB;AAYD,wBAAgB,qBAAqB,CAAC,EACpC,MAAM,EACN,IAAI,EACJ,OAAO,EACP,QAA+B,EAC/B,OAAO,GACR,EAAE,4BAA4B,GAAG,2BAA2B,CAwH5D"}
+{"version":3,"file":"useCollectionProducts.d.ts","sourceRoot":"","sources":["../../src/react/useCollectionProducts.ts"],"names":[],"mappings":"AASA,OAAO,EAAkB,KAAK,iBAAiB,EAAE,KAAK,gBAAgB,EAAE,MAAM,kBAAkB,CAAC;AACjG,OAAO,KAAK,EAAE,cAAc,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AAE9D,4FAA4F;AAC5F,MAAM,WAAW,cAAc;IAC7B,GAAG,EAAE,MAAM,CAAC;IACZ,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB;AAED,oFAAoF;AACpF,eAAO,MAAM,oBAAoB,KAAK,CAAC;AAEvC,MAAM,WAAW,4BAA4B;IAC3C,MAAM,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC;IAClC,qEAAqE;IACrE,IAAI,CAAC,EAAE,cAAc,CAAC;IACtB;;;;OAIG;IACH,OAAO,CAAC,EAAE,aAAa,EAAE,CAAC;IAC1B,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,gGAAgG;IAChG,cAAc,CAAC,EAAE,cAAc,CAAC;IAChC;;;OAGG;IACH,OAAO,CAAC,EAAE,CAAC,KAAK,EAAE,OAAO,EAAE,OAAO,EAAE;QAAE,EAAE,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,MAAM,CAAA;KAAE,KAAK,IAAI,CAAC;CAC7E;AAED,MAAM,MAAM,uBAAuB,GAAG,gBAAgB,CAAC;AACvD,MAAM,MAAM,2BAA2B,GAAG,iBAAiB,CAAC;AAE5D,wBAAgB,qBAAqB,CAAC,EACpC,MAAM,EACN,IAAI,EACJ,OAAO,EACP,QAA+B,EAC/B,cAAc,EACd,OAAO,GACR,EAAE,4BAA4B,GAAG,2BAA2B,CAgC5D"}

package/dist/react/useCollectionProducts.js

@@ -3,149 +3,48 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.COLLECTION_PAGE_SIZE = void 0;
 exports.useCollectionProducts = useCollectionProducts;
 /**
- * useCollectionProducts — one collection's products, cursor-paginated.
+ * useCollectionProducts — one collection's products (a product listing page), cache first.
  *
- * Pages on a cursor (`after: endCursor`) and APPENDS, rather than growing `first` and refetching the
- * whole list each step. Growing `first` breaks on large collections: the Storefront API rejects
- * `first > 250`, so a shopper scrolling deep eventually sends an over-cap request that errors — and a
- * screen that replaces its grid on that error destroys everything already loaded, with a retry that
- * re-sends the same failing request. Cursor paging has no such cap, never re-downloads earlier pages,
- * and — because `loadMore` failing only stops growth — leaves the loaded products in place.
- *
- * Every response is checked against the request that is current (`requestId`), so a page resolving
- * after the sort or filters changed cannot merge into the new list.
+ * The collection's last first page renders immediately (memory, else the device store, so after a
+ * cold start too), then the network answer replaces it in place. Cursor-paged, appending. The
+ * shopper's filter selection is held here as `FilterValue.input` strings. The engine, and why each
+ * part is shaped the way it is, is `useProductFeed`.
  */
-const react_1 = require("react");
 const shopify_1 = require("../shopify");
-const ShopifyProvider_1 = require("./ShopifyProvider");
+const useProductFeed_1 = require("./useProductFeed");
 /** Default page size — 12 is six rows of two, a full first screenful on a phone. */
 exports.COLLECTION_PAGE_SIZE = 12;
-const IDLE = {
-    products: [],
-    title: null,
-    availableFilters: [],
-    loading: false,
-    loadingMore: false,
-    hasMore: false,
-    error: false,
-};
-function useCollectionProducts({ handle, sort, filters, pageSize = exports.COLLECTION_PAGE_SIZE, onError, }) {
-    const { ready } = (0, ShopifyProvider_1.useShopify)();
-    const [state, setState] = (0, react_1.useState)(IDLE);
-    const [attempt, setAttempt] = (0, react_1.useState)(0);
-    /**
-     * Identifies the request the state belongs to. Bumped on every fresh read; an append carries the
-     * value it started with, so a response whose counter has moved on is dropped rather than merged.
-     */
-    const requestId = (0, react_1.useRef)(0);
-    /** The cursor for the next page, held in a ref so `loadMore` does not need a fresh callback. */
-    const cursor = (0, react_1.useRef)(null);
-    /**
-     * The filter array and sort object are rebuilt on every render of the screen that owns them, so the
-     * effect depends on their serialisation rather than their identity — otherwise every keystroke
-     * elsewhere on the screen would refetch.
-     */
-    const filterKey = (filters === null || filters === void 0 ? void 0 : filters.length) ? JSON.stringify(filters) : '';
+function useCollectionProducts({ handle, sort, filters, pageSize = exports.COLLECTION_PAGE_SIZE, imageTransform, onError, }) {
     const sortKey = sort ? `${sort.key}:${sort.reverse ? 'desc' : 'asc'}` : '';
-    (0, react_1.useEffect)(() => {
-        var _a;
-        // A client that is not up yet, or no handle to read, is not a failed load — it is no load.
-        if (!ready || !handle) {
-            requestId.current += 1;
-            cursor.current = null;
-            setState(IDLE);
-            return;
-        }
-        const id = (requestId.current += 1);
-        cursor.current = null;
-        setState({ ...IDLE, loading: true });
-        shopify_1.shopify.collections
-            .products(handle, {
-            first: pageSize,
-            sortKey: sort === null || sort === void 0 ? void 0 : sort.key,
-            reverse: (_a = sort === null || sort === void 0 ? void 0 : sort.reverse) !== null && _a !== void 0 ? _a : false,
-            filters: (filters === null || filters === void 0 ? void 0 : filters.length) ? filters : undefined,
-        })
-            .then((page) => {
-            var _a, _b, _c;
-            if (requestId.current !== id)
-                return;
-            cursor.current = page.pageInfo.endCursor;
-            setState({
-                products: page.nodes,
-                title: (_b = (_a = page.collection) === null || _a === void 0 ? void 0 : _a.title) !== null && _b !== void 0 ? _b : null,
-                availableFilters: (_c = page.filters) !== null && _c !== void 0 ? _c : [],
-                loading: false,
-                loadingMore: false,
-                hasMore: page.pageInfo.hasNextPage,
-                error: false,
-            });
-        })
-            .catch((caught) => {
-            onError === null || onError === void 0 ? void 0 : onError(caught, { at: 'useCollectionProducts', handle });
-            if (requestId.current !== id)
-                return;
-            // A first-page failure genuinely has nothing to show, so the consumer renders its error state.
-            setState({ ...IDLE, error: true });
-        });
-        // Keyed on the serialised filters and sort; both change identity every render.
-        // eslint-disable-next-line react-hooks/exhaustive-deps
-    }, [ready, handle, sortKey, filterKey, pageSize, attempt]);
-    /**
-     * Guarded on both in-flight flags as well as on `hasMore`: a list's `onEndReached` fires every
-     * time the end stays in view, so an ungated version would run through the collection a page a frame.
-     */
-    const loadMore = (0, react_1.useCallback)(() => {
-        var _a;
-        if (state.loading || state.loadingMore || !state.hasMore || !cursor.current)
-            return;
-        const id = requestId.current;
-        const after = cursor.current;
-        // Claim the cursor synchronously. `onEndReached` fires repeatedly and the `loadingMore` guard
-        // reads a `state` snapshot that is stale until the next render, so a second call in the same frame
-        // would otherwise fetch this SAME page again and append it twice — duplicate keys. Nulling the ref
-        // now makes the re-entrant call bail on `!cursor.current`; the fetch restores it, a failure leaves
-        // it null (paging has stopped anyway).
-        cursor.current = null;
-        setState((current) => ({ ...current, loadingMore: true }));
-        shopify_1.shopify.collections
-            .products(handle, {
-            first: pageSize,
-            after,
-            sortKey: sort === null || sort === void 0 ? void 0 : sort.key,
-            reverse: (_a = sort === null || sort === void 0 ? void 0 : sort.reverse) !== null && _a !== void 0 ? _a : false,
-            filters: (filters === null || filters === void 0 ? void 0 : filters.length) ? filters : undefined,
-        })
-            .then((page) => {
-            if (requestId.current !== id)
-                return;
-            cursor.current = page.pageInfo.endCursor;
-            setState((current) => {
-                // Defensive against any overlap between pages: never append a product already held.
-                const seen = new Set(current.products.map((p) => p.id));
-                const fresh = page.nodes.filter((p) => !seen.has(p.id));
-                return {
-                    ...current,
-                    products: fresh.length ? [...current.products, ...fresh] : current.products,
-                    loadingMore: false,
-                    hasMore: page.pageInfo.hasNextPage,
-                };
+    return (0, useProductFeed_1.useProductFeed)({
+        id: handle ? `collection:${handle}` : null,
+        // The transform is part of the key: a page cached at one image size is not another's.
+        paramsKey: `${sortKey}|${pageSize}|${imageTransform ? JSON.stringify(imageTransform) : ''}`,
+        fixedFilters: filters,
+        fetch: async ({ after, filters: applied, fresh }) => {
+            var _a, _b, _c, _d;
+            const page = await shopify_1.shopify.collections.products(handle, {
+                first: pageSize,
+                after,
+                sortKey: sort === null || sort === void 0 ? void 0 : sort.key,
+                reverse: (_a = sort === null || sort === void 0 ? void 0 : sort.reverse) !== null && _a !== void 0 ? _a : false,
+                filters: applied,
+                fresh,
+                imageTransform,
             });
-        })
-            .catch((caught) => {
-            onError === null || onError === void 0 ? void 0 : onError(caught, { at: 'useCollectionProducts.loadMore', handle: handle });
-            if (requestId.current !== id)
-                return;
-            // A failed page is not a failed collection: what is on screen stays, and the end simply stops
-            // growing rather than the grid being replaced by an error.
-            setState((current) => ({ ...current, loadingMore: false, hasMore: false }));
-        });
-        // eslint-disable-next-line react-hooks/exhaustive-deps
-    }, [state.loading, state.loadingMore, state.hasMore, handle, sortKey, filterKey, pageSize]);
-    return {
-        ...state,
-        loadMore,
-        retry: () => setAttempt((n) => n + 1),
-    };
+            return {
+                nodes: page.nodes,
+                pageInfo: page.pageInfo,
+                filters: (_b = page.filters) !== null && _b !== void 0 ? _b : [],
+                title: (_d = (_c = page.collection) === null || _c === void 0 ? void 0 : _c.title) !== null && _d !== void 0 ? _d : null,
+            };
+        },
+        onError: onError
+            ? (error, phase) => onError(error, {
+                at: phase === 'first' ? 'useCollectionProducts' : 'useCollectionProducts.loadMore',
+                handle: handle,
+            })
+            : undefined,
+    });
 }
 //# sourceMappingURL=useCollectionProducts.js.map

package/dist/react/useCollectionProducts.js.map

@@ -1 +1 @@
-{"version":3,"file":"useCollectionProducts.js","sourceRoot":"","sources":["../../src/react/useCollectionProducts.ts"],"names":[],"mappings":";;;AAsEA,sDA8HC;AApMD;;;;;;;;;;;;GAYG;AACH,iCAAiE;AACjE,wCAAqC;AACrC,uDAA+C;AAS/C,oFAAoF;AACvE,QAAA,oBAAoB,GAAG,EAAE,CAAC;AAmCvC,MAAM,IAAI,GAA4B;IACpC,QAAQ,EAAE,EAAE;IACZ,KAAK,EAAE,IAAI;IACX,gBAAgB,EAAE,EAAE;IACpB,OAAO,EAAE,KAAK;IACd,WAAW,EAAE,KAAK;IAClB,OAAO,EAAE,KAAK;IACd,KAAK,EAAE,KAAK;CACb,CAAC;AAEF,SAAgB,qBAAqB,CAAC,EACpC,MAAM,EACN,IAAI,EACJ,OAAO,EACP,QAAQ,GAAG,4BAAoB,EAC/B,OAAO,GACsB;IAC7B,MAAM,EAAE,KAAK,EAAE,GAAG,IAAA,4BAAU,GAAE,CAAC;IAE/B,MAAM,CAAC,KAAK,EAAE,QAAQ,CAAC,GAAG,IAAA,gBAAQ,EAA0B,IAAI,CAAC,CAAC;IAClE,MAAM,CAAC,OAAO,EAAE,UAAU,CAAC,GAAG,IAAA,gBAAQ,EAAC,CAAC,CAAC,CAAC;IAE1C;;;OAGG;IACH,MAAM,SAAS,GAAG,IAAA,cAAM,EAAC,CAAC,CAAC,CAAC;IAC5B,gGAAgG;IAChG,MAAM,MAAM,GAAG,IAAA,cAAM,EAAgB,IAAI,CAAC,CAAC;IAE3C;;;;OAIG;IACH,MAAM,SAAS,GAAG,CAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,MAAM,EAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;IACjE,MAAM,OAAO,GAAG,IAAI,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,GAAG,IAAI,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;IAE3E,IAAA,iBAAS,EAAC,GAAG,EAAE;;QACb,2FAA2F;QAC3F,IAAI,CAAC,KAAK,IAAI,CAAC,MAAM,EAAE,CAAC;YACtB,SAAS,CAAC,OAAO,IAAI,CAAC,CAAC;YACvB,MAAM,CAAC,OAAO,GAAG,IAAI,CAAC;YACtB,QAAQ,CAAC,IAAI,CAAC,CAAC;YACf,OAAO;QACT,CAAC;QAED,MAAM,EAAE,GAAG,CAAC,SAAS,CAAC,OAAO,IAAI,CAAC,CAAC,CAAC;QACpC,MAAM,CAAC,OAAO,GAAG,IAAI,CAAC;QACtB,QAAQ,CAAC,EAAE,GAAG,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC,CAAC;QAErC,iBAAO,CAAC,WAAW;aAChB,QAAQ,CAAC,MAAM,EAAE;YAChB,KAAK,EAAE,QAAQ;YACf,OAAO,EAAE,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,GAAG;YAClB,OAAO,EAAE,MAAA,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,OAAO,mCAAI,KAAK;YAC/B,OAAO,EAAE,CAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,MAAM,EAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,SAAS;SAC/C,CAAC;aACD,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE;;YACb,IAAI,SAAS,CAAC,OAAO,KAAK,EAAE;gBAAE,OAAO;YACrC,MAAM,CAAC,OAAO,GAAG,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC;YACzC,QAAQ,CAAC;gBACP,QAAQ,EAAE,IAAI,CAAC,KAAK;gBACpB,KAAK,EAAE,MAAA,MAAA,IAAI,CAAC,UAAU,0CAAE,KAAK,mCAAI,IAAI;gBACrC,gBAAgB,EAAE,MAAA,IAAI,CAAC,OAAO,mCAAI,EAAE;gBACpC,OAAO,EAAE,KAAK;gBACd,WAAW,EAAE,KAAK;gBAClB,OAAO,EAAE,IAAI,CAAC,QAAQ,CAAC,WAAW;gBAClC,KAAK,EAAE,KAAK;aACb,CAAC,CAAC;QACL,CAAC,CAAC;aACD,KAAK,CAAC,CAAC,MAAM,EAAE,EAAE;YAChB,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAG,MAAM,EAAE,EAAE,EAAE,EAAE,uBAAuB,EAAE,MAAM,EAAE,CAAC,CAAC;YAC3D,IAAI,SAAS,CAAC,OAAO,KAAK,EAAE;gBAAE,OAAO;YACrC,+FAA+F;YAC/F,QAAQ,CAAC,EAAE,GAAG,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC;QACrC,CAAC,CAAC,CAAC;QACL,+EAA+E;QAC/E,uDAAuD;IACzD,CAAC,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,SAAS,EAAE,QAAQ,EAAE,OAAO,CAAC,CAAC,CAAC;IAE3D;;;OAGG;IACH,MAAM,QAAQ,GAAG,IAAA,mBAAW,EAAC,GAAG,EAAE;;QAChC,IAAI,KAAK,CAAC,OAAO,IAAI,KAAK,CAAC,WAAW,IAAI,CAAC,KAAK,CAAC,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO;YAAE,OAAO;QAEpF,MAAM,EAAE,GAAG,SAAS,CAAC,OAAO,CAAC;QAC7B,MAAM,KAAK,GAAG,MAAM,CAAC,OAAO,CAAC;QAC7B,8FAA8F;QAC9F,mGAAmG;QACnG,mGAAmG;QACnG,mGAAmG;QACnG,uCAAuC;QACvC,MAAM,CAAC,OAAO,GAAG,IAAI,CAAC;QACtB,QAAQ,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC,EAAE,GAAG,OAAO,EAAE,WAAW,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC;QAE3D,iBAAO,CAAC,WAAW;aAChB,QAAQ,CAAC,MAAgB,EAAE;YAC1B,KAAK,EAAE,QAAQ;YACf,KAAK;YACL,OAAO,EAAE,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,GAAG;YAClB,OAAO,EAAE,MAAA,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,OAAO,mCAAI,KAAK;YAC/B,OAAO,EAAE,CAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,MAAM,EAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,SAAS;SAC/C,CAAC;aACD,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE;YACb,IAAI,SAAS,CAAC,OAAO,KAAK,EAAE;gBAAE,OAAO;YACrC,MAAM,CAAC,OAAO,GAAG,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC;YACzC,QAAQ,CAAC,CAAC,OAAO,EAAE,EAAE;gBACnB,oFAAoF;gBACpF,MAAM,IAAI,GAAG,IAAI,GAAG,CAAC,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;gBACxD,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;gBACxD,OAAO;oBACL,GAAG,OAAO;oBACV,QAAQ,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,QAAQ,EAAE,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,QAAQ;oBAC3E,WAAW,EAAE,KAAK;oBAClB,OAAO,EAAE,IAAI,CAAC,QAAQ,CAAC,WAAW;iBACnC,CAAC;YACJ,CAAC,CAAC,CAAC;QACL,CAAC,CAAC;aACD,KAAK,CAAC,CAAC,MAAM,EAAE,EAAE;YAChB,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAG,MAAM,EAAE,EAAE,EAAE,EAAE,gCAAgC,EAAE,MAAM,EAAE,MAAgB,EAAE,CAAC,CAAC;YACtF,IAAI,SAAS,CAAC,OAAO,KAAK,EAAE;gBAAE,OAAO;YACrC,8FAA8F;YAC9F,2DAA2D;YAC3D,QAAQ,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC,EAAE,GAAG,OAAO,EAAE,WAAW,EAAE,KAAK,EAAE,OAAO,EAAE,KAAK,EAAE,CAAC,CAAC,CAAC;QAC9E,CAAC,CAAC,CAAC;QACL,uDAAuD;IACzD,CAAC,EAAE,CAAC,KAAK,CAAC,OAAO,EAAE,KAAK,CAAC,WAAW,EAAE,KAAK,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,SAAS,EAAE,QAAQ,CAAC,CAAC,CAAC;IAE5F,OAAO;QACL,GAAG,KAAK;QACR,QAAQ;QACR,KAAK,EAAE,GAAG,EAAE,CAAC,UAAU,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC;KACtC,CAAC;AACJ,CAAC"}
+{"version":3,"file":"useCollectionProducts.js","sourceRoot":"","sources":["../../src/react/useCollectionProducts.ts"],"names":[],"mappings":";;;AA4CA,sDAuCC;AAnFD;;;;;;;GAOG;AACH,wCAAqC;AACrC,qDAAiG;AASjG,oFAAoF;AACvE,QAAA,oBAAoB,GAAG,EAAE,CAAC;AAyBvC,SAAgB,qBAAqB,CAAC,EACpC,MAAM,EACN,IAAI,EACJ,OAAO,EACP,QAAQ,GAAG,4BAAoB,EAC/B,cAAc,EACd,OAAO,GACsB;IAC7B,MAAM,OAAO,GAAG,IAAI,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,GAAG,IAAI,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;IAC3E,OAAO,IAAA,+BAAc,EAAC;QACpB,EAAE,EAAE,MAAM,CAAC,CAAC,CAAC,cAAc,MAAM,EAAE,CAAC,CAAC,CAAC,IAAI;QAC1C,sFAAsF;QACtF,SAAS,EAAE,GAAG,OAAO,IAAI,QAAQ,IAAI,cAAc,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC,EAAE,EAAE;QAC3F,YAAY,EAAE,OAAO;QACrB,KAAK,EAAE,KAAK,EAAE,EAAE,KAAK,EAAE,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE,EAAE,EAAE;;YAClD,MAAM,IAAI,GAAG,MAAM,iBAAO,CAAC,WAAW,CAAC,QAAQ,CAAC,MAAgB,EAAE;gBAChE,KAAK,EAAE,QAAQ;gBACf,KAAK;gBACL,OAAO,EAAE,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,GAAG;gBAClB,OAAO,EAAE,MAAA,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,OAAO,mCAAI,KAAK;gBAC/B,OAAO,EAAE,OAAO;gBAChB,KAAK;gBACL,cAAc;aACf,CAAC,CAAC;YACH,OAAO;gBACL,KAAK,EAAE,IAAI,CAAC,KAAK;gBACjB,QAAQ,EAAE,IAAI,CAAC,QAAQ;gBACvB,OAAO,EAAE,MAAA,IAAI,CAAC,OAAO,mCAAI,EAAE;gBAC3B,KAAK,EAAE,MAAA,MAAA,IAAI,CAAC,UAAU,0CAAE,KAAK,mCAAI,IAAI;aACtC,CAAC;QACJ,CAAC;QACD,OAAO,EAAE,OAAO;YACd,CAAC,CAAC,CAAC,KAAK,EAAE,KAAK,EAAE,EAAE,CACf,OAAO,CAAC,KAAK,EAAE;gBACb,EAAE,EAAE,KAAK,KAAK,OAAO,CAAC,CAAC,CAAC,uBAAuB,CAAC,CAAC,CAAC,gCAAgC;gBAClF,MAAM,EAAE,MAAgB;aACzB,CAAC;YACN,CAAC,CAAC,SAAS;KACd,CAAC,CAAC;AACL,CAAC"}

package/dist/react/useProduct.d.ts

@@ -0,0 +1,36 @@
+import { type ProductBase } from '../productStore';
+import type { ImageTransform, Product } from '../types';
+export interface UseProductOptions {
+    /**
+     * Resize/convert the full product's images on Shopify's CDN (the gallery). The first-render
+     * `preview.featuredImage` is whatever the grid that showed the product fetched, which is the image
+     * already on screen and in the image cache.
+     */
+    imageTransform?: ImageTransform;
+    onError?: (error: unknown, context: {
+        at: string;
+        handle: string;
+    }) => void;
+}
+export interface UseProductState {
+    /** The full product: variants, media, description. Null until known. */
+    product: Product | null;
+    /** What can render right away: title, image and price. Set whenever anything is known. */
+    preview: ProductBase | null;
+    /** How much is known: `'full'`, `'base'` (preview only), or null (nothing yet). */
+    level: 'full' | 'base' | null;
+    /** Nothing to show yet: no cached copy, and the read is in flight. */
+    loading: boolean;
+    /** A cached copy is on screen while the fresh one is read. */
+    refreshing: boolean;
+    /** The read failed. A cached copy, if any, is still shown. */
+    error: boolean;
+    /** Shopify has no product with this handle. */
+    notFound: boolean;
+}
+export interface UseProductResult extends UseProductState {
+    /** Read the product from the network again (pull-to-refresh). */
+    refresh: () => void;
+}
+export declare function useProduct(handle: string | null | undefined, options?: UseProductOptions): UseProductResult;
+//# sourceMappingURL=useProduct.d.ts.map

package/dist/react/useProduct.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"useProduct.d.ts","sourceRoot":"","sources":["../../src/react/useProduct.ts"],"names":[],"mappings":"AAgBA,OAAO,EAAmC,KAAK,WAAW,EAAE,MAAM,iBAAiB,CAAC;AAIpF,OAAO,KAAK,EAAE,cAAc,EAAE,OAAO,EAAE,MAAM,UAAU,CAAC;AAExD,MAAM,WAAW,iBAAiB;IAChC;;;;OAIG;IACH,cAAc,CAAC,EAAE,cAAc,CAAC;IAChC,OAAO,CAAC,EAAE,CAAC,KAAK,EAAE,OAAO,EAAE,OAAO,EAAE;QAAE,EAAE,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,MAAM,CAAA;KAAE,KAAK,IAAI,CAAC;CAC7E;AAED,MAAM,WAAW,eAAe;IAC9B,wEAAwE;IACxE,OAAO,EAAE,OAAO,GAAG,IAAI,CAAC;IACxB,0FAA0F;IAC1F,OAAO,EAAE,WAAW,GAAG,IAAI,CAAC;IAC5B,mFAAmF;IACnF,KAAK,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,CAAC;IAC9B,sEAAsE;IACtE,OAAO,EAAE,OAAO,CAAC;IACjB,8DAA8D;IAC9D,UAAU,EAAE,OAAO,CAAC;IACpB,8DAA8D;IAC9D,KAAK,EAAE,OAAO,CAAC;IACf,+CAA+C;IAC/C,QAAQ,EAAE,OAAO,CAAC;CACnB;AAED,MAAM,WAAW,gBAAiB,SAAQ,eAAe;IACvD,iEAAiE;IACjE,OAAO,EAAE,MAAM,IAAI,CAAC;CACrB;AA0BD,wBAAgB,UAAU,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,EAAE,OAAO,GAAE,iBAAsB,GAAG,gBAAgB,CAgF/G"}

package/dist/react/useProduct.js

@@ -0,0 +1,126 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.useProduct = useProduct;
+/**
+ * useProduct — one product (a product page), cache first, built to open instantly.
+ *
+ * First render, synchronously from the product store (memory, else the device store: MMKV on
+ * native, read by key in microseconds):
+ * - the **full** product, if this device has read it before; or
+ * - the **base** keys (`PRODUCT_BASE_KEYS`: title, image, price), which every collection, search,
+ *   recommendation and wishlist read records. A product tapped in a grid always has these.
+ *
+ * Then the full product is read in the background and replaces what is shown, with `refreshing` true
+ * meanwhile rather than a spinner. A full product read under `REVALIDATE_AFTER_MS` ago is not read
+ * again. Render `preview` straight away; render what needs variants (the picker, add to cart) once
+ * `product` is set.
+ */
+const react_1 = require("react");
+const client_1 = require("../client");
+const productStore_1 = require("../productStore");
+const shopify_1 = require("../shopify");
+const ShopifyProvider_1 = require("./ShopifyProvider");
+const useProductFeed_1 = require("./useProductFeed");
+const EMPTY = {
+    product: null,
+    preview: null,
+    level: null,
+    loading: false,
+    refreshing: false,
+    error: false,
+    notFound: false,
+};
+function fromCache(entry, reading) {
+    if (!entry)
+        return { ...EMPTY, loading: reading };
+    const full = entry.full;
+    return {
+        product: full,
+        preview: entry.base,
+        level: full ? 'full' : 'base',
+        loading: false,
+        refreshing: reading,
+        error: false,
+        notFound: false,
+    };
+}
+function useProduct(handle, options = {}) {
+    const { ready } = (0, ShopifyProvider_1.useShopify)();
+    const configured = ready || (0, client_1.isConfigured)();
+    const onErrorRef = (0, react_1.useRef)(options.onError);
+    onErrorRef.current = options.onError;
+    const transformKey = options.imageTransform ? JSON.stringify(options.imageTransform) : '';
+    const transformRef = (0, react_1.useRef)(options.imageTransform);
+    transformRef.current = options.imageTransform;
+    // First render: whatever the store knows, so the page paints on frame one.
+    const [state, setState] = (0, react_1.useState)(() => fromCache(configured && handle ? (0, productStore_1.peekProduct)(handle) : null, !!handle));
+    const [attempt, setAttempt] = (0, react_1.useState)(0);
+    const requestId = (0, react_1.useRef)(0);
+    const freshNext = (0, react_1.useRef)(false);
+    (0, react_1.useEffect)(() => {
+        if (!handle || !configured) {
+            requestId.current += 1;
+            setState(EMPTY);
+            return;
+        }
+        const id = (requestId.current += 1);
+        const fresh = freshNext.current;
+        freshNext.current = false;
+        const cached = (0, productStore_1.peekProduct)(handle);
+        if ((cached === null || cached === void 0 ? void 0 : cached.full) && !fresh && Date.now() - cached.fullAt < useProductFeed_1.REVALIDATE_AFTER_MS) {
+            setState(fromCache(cached, false));
+            return;
+        }
+        setState((current) => {
+            if (cached)
+                return fromCache(cached, true);
+            // A refresh keeps what is on screen until the fresh product lands.
+            if (fresh && current.preview)
+                return { ...current, refreshing: true, error: false };
+            return { ...EMPTY, loading: true };
+        });
+        shopify_1.shopify.products
+            .byHandle(handle, { fresh, imageTransform: transformRef.current })
+            .then((product) => {
+            var _a, _b;
+            if (requestId.current !== id)
+                return;
+            if (!product) {
+                setState({ ...EMPTY, notFound: true });
+                return;
+            }
+            setState({
+                product,
+                preview: {
+                    id: product.id,
+                    handle: product.handle,
+                    title: product.title,
+                    featuredImage: (_a = product.featuredImage) !== null && _a !== void 0 ? _a : null,
+                    priceRange: product.priceRange,
+                    compareAtPriceRange: (_b = product.compareAtPriceRange) !== null && _b !== void 0 ? _b : null,
+                },
+                level: 'full',
+                loading: false,
+                refreshing: false,
+                error: false,
+                notFound: false,
+            });
+        })
+            .catch((caught) => {
+            var _a;
+            (_a = onErrorRef.current) === null || _a === void 0 ? void 0 : _a.call(onErrorRef, caught, { at: 'useProduct', handle });
+            if (requestId.current !== id)
+                return;
+            // Whatever was shown stays; the page can say the fresh read failed.
+            setState((current) => ({ ...current, loading: false, refreshing: false, error: true }));
+        });
+        // Keyed on the transform's serialisation; the object changes identity every render.
+        // eslint-disable-next-line react-hooks/exhaustive-deps
+    }, [configured, handle, attempt, transformKey]);
+    const refresh = (0, react_1.useCallback)(() => {
+        freshNext.current = true;
+        setAttempt((n) => n + 1);
+    }, []);
+    return { ...state, refresh };
+}
+//# sourceMappingURL=useProduct.js.map

package/dist/react/useProduct.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"useProduct.js","sourceRoot":"","sources":["../../src/react/useProduct.ts"],"names":[],"mappings":";;AA8EA,gCAgFC;AA9JD;;;;;;;;;;;;;GAaG;AACH,iCAAiE;AACjE,sCAAyC;AACzC,kDAAoF;AACpF,wCAAqC;AACrC,uDAA+C;AAC/C,qDAAuD;AAmCvD,MAAM,KAAK,GAAoB;IAC7B,OAAO,EAAE,IAAI;IACb,OAAO,EAAE,IAAI;IACb,KAAK,EAAE,IAAI;IACX,OAAO,EAAE,KAAK;IACd,UAAU,EAAE,KAAK;IACjB,KAAK,EAAE,KAAK;IACZ,QAAQ,EAAE,KAAK;CAChB,CAAC;AAEF,SAAS,SAAS,CAAC,KAA2B,EAAE,OAAgB;IAC9D,IAAI,CAAC,KAAK;QAAE,OAAO,EAAE,GAAG,KAAK,EAAE,OAAO,EAAE,OAAO,EAAE,CAAC;IAClD,MAAM,IAAI,GAAG,KAAK,CAAC,IAAI,CAAC;IACxB,OAAO;QACL,OAAO,EAAE,IAAI;QACb,OAAO,EAAE,KAAK,CAAC,IAAI;QACnB,KAAK,EAAE,IAAI,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM;QAC7B,OAAO,EAAE,KAAK;QACd,UAAU,EAAE,OAAO;QACnB,KAAK,EAAE,KAAK;QACZ,QAAQ,EAAE,KAAK;KAChB,CAAC;AACJ,CAAC;AAED,SAAgB,UAAU,CAAC,MAAiC,EAAE,UAA6B,EAAE;IAC3F,MAAM,EAAE,KAAK,EAAE,GAAG,IAAA,4BAAU,GAAE,CAAC;IAC/B,MAAM,UAAU,GAAG,KAAK,IAAI,IAAA,qBAAY,GAAE,CAAC;IAC3C,MAAM,UAAU,GAAG,IAAA,cAAM,EAAC,OAAO,CAAC,OAAO,CAAC,CAAC;IAC3C,UAAU,CAAC,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC;IACrC,MAAM,YAAY,GAAG,OAAO,CAAC,cAAc,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;IAC1F,MAAM,YAAY,GAAG,IAAA,cAAM,EAAC,OAAO,CAAC,cAAc,CAAC,CAAC;IACpD,YAAY,CAAC,OAAO,GAAG,OAAO,CAAC,cAAc,CAAC;IAE9C,2EAA2E;IAC3E,MAAM,CAAC,KAAK,EAAE,QAAQ,CAAC,GAAG,IAAA,gBAAQ,EAAkB,GAAG,EAAE,CACvD,SAAS,CAAC,UAAU,IAAI,MAAM,CAAC,CAAC,CAAC,IAAA,0BAAW,EAAC,MAAM,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,MAAM,CAAC,CACvE,CAAC;IACF,MAAM,CAAC,OAAO,EAAE,UAAU,CAAC,GAAG,IAAA,gBAAQ,EAAC,CAAC,CAAC,CAAC;IAC1C,MAAM,SAAS,GAAG,IAAA,cAAM,EAAC,CAAC,CAAC,CAAC;IAC5B,MAAM,SAAS,GAAG,IAAA,cAAM,EAAC,KAAK,CAAC,CAAC;IAEhC,IAAA,iBAAS,EAAC,GAAG,EAAE;QACb,IAAI,CAAC,MAAM,IAAI,CAAC,UAAU,EAAE,CAAC;YAC3B,SAAS,CAAC,OAAO,IAAI,CAAC,CAAC;YACvB,QAAQ,CAAC,KAAK,CAAC,CAAC;YAChB,OAAO;QACT,CAAC;QACD,MAAM,EAAE,GAAG,CAAC,SAAS,CAAC,OAAO,IAAI,CAAC,CAAC,CAAC;QACpC,MAAM,KAAK,GAAG,SAAS,CAAC,OAAO,CAAC;QAChC,SAAS,CAAC,OAAO,GAAG,KAAK,CAAC;QAC1B,MAAM,MAAM,GAAG,IAAA,0BAAW,EAAC,MAAM,CAAC,CAAC;QAEnC,IAAI,CAAA,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,IAAI,KAAI,CAAC,KAAK,IAAI,IAAI,CAAC,GAAG,EAAE,GAAG,MAAM,CAAC,MAAM,GAAG,oCAAmB,EAAE,CAAC;YAC/E,QAAQ,CAAC,SAAS,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC,CAAC;YACnC,OAAO;QACT,CAAC;QACD,QAAQ,CAAC,CAAC,OAAO,EAAE,EAAE;YACnB,IAAI,MAAM;gBAAE,OAAO,SAAS,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;YAC3C,mEAAmE;YACnE,IAAI,KAAK,IAAI,OAAO,CAAC,OAAO;gBAAE,OAAO,EAAE,GAAG,OAAO,EAAE,UAAU,EAAE,IAAI,EAAE,KAAK,EAAE,KAAK,EAAE,CAAC;YACpF,OAAO,EAAE,GAAG,KAAK,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC;QACrC,CAAC,CAAC,CAAC;QAEH,iBAAO,CAAC,QAAQ;aACb,QAAQ,CAAC,MAAM,EAAE,EAAE,KAAK,EAAE,cAAc,EAAE,YAAY,CAAC,OAAO,EAAE,CAAC;aACjE,IAAI,CAAC,CAAC,OAAO,EAAE,EAAE;;YAChB,IAAI,SAAS,CAAC,OAAO,KAAK,EAAE;gBAAE,OAAO;YACrC,IAAI,CAAC,OAAO,EAAE,CAAC;gBACb,QAAQ,CAAC,EAAE,GAAG,KAAK,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC,CAAC;gBACvC,OAAO;YACT,CAAC;YACD,QAAQ,CAAC;gBACP,OAAO;gBACP,OAAO,EAAE;oBACP,EAAE,EAAE,OAAO,CAAC,EAAE;oBACd,MAAM,EAAE,OAAO,CAAC,MAAM;oBACtB,KAAK,EAAE,OAAO,CAAC,KAAK;oBACpB,aAAa,EAAE,MAAA,OAAO,CAAC,aAAa,mCAAI,IAAI;oBAC5C,UAAU,EAAE,OAAO,CAAC,UAAU;oBAC9B,mBAAmB,EAAE,MAAA,OAAO,CAAC,mBAAmB,mCAAI,IAAI;iBACzD;gBACD,KAAK,EAAE,MAAM;gBACb,OAAO,EAAE,KAAK;gBACd,UAAU,EAAE,KAAK;gBACjB,KAAK,EAAE,KAAK;gBACZ,QAAQ,EAAE,KAAK;aAChB,CAAC,CAAC;QACL,CAAC,CAAC;aACD,KAAK,CAAC,CAAC,MAAM,EAAE,EAAE;;YAChB,MAAA,UAAU,CAAC,OAAO,2DAAG,MAAM,EAAE,EAAE,EAAE,EAAE,YAAY,EAAE,MAAM,EAAE,CAAC,CAAC;YAC3D,IAAI,SAAS,CAAC,OAAO,KAAK,EAAE;gBAAE,OAAO;YACrC,oEAAoE;YACpE,QAAQ,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC,EAAE,GAAG,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE,UAAU,EAAE,KAAK,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC;QAC1F,CAAC,CAAC,CAAC;QACL,oFAAoF;QACpF,uDAAuD;IACzD,CAAC,EAAE,CAAC,UAAU,EAAE,MAAM,EAAE,OAAO,EAAE,YAAY,CAAC,CAAC,CAAC;IAEhD,MAAM,OAAO,GAAG,IAAA,mBAAW,EAAC,GAAG,EAAE;QAC/B,SAAS,CAAC,OAAO,GAAG,IAAI,CAAC;QACzB,UAAU,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;IAC3B,CAAC,EAAE,EAAE,CAAC,CAAC;IAEP,OAAO,EAAE,GAAG,KAAK,EAAE,OAAO,EAAE,CAAC;AAC/B,CAAC"}

package/dist/react/useProductFeed.d.ts

@@ -0,0 +1,57 @@
+import type { Filter, PageInfo, Product, ProductFilter } from '../types';
+/** A cached first page younger than this is shown without asking the network again. */
+export declare const REVALIDATE_AFTER_MS: number;
+export interface FeedPage {
+    nodes: Product[];
+    pageInfo: PageInfo;
+    filters?: Filter[];
+    title?: string | null;
+    totalCount?: number;
+}
+export interface FeedSource {
+    /** Which feed this is (`collection:<handle>`, `search:<term>`); null when there is nothing to read. */
+    id: string | null;
+    /** What else shapes the first page: sort, page size. Fixed filters are passed separately. */
+    paramsKey: string;
+    /** Filters the app always applies; the shopper's selection goes on top. */
+    fixedFilters?: ProductFilter[];
+    fetch(args: {
+        after?: string;
+        filters: ProductFilter[] | undefined;
+        fresh: boolean;
+    }): Promise<FeedPage>;
+    onError?: (error: unknown, phase: 'first' | 'more') => void;
+}
+export interface ProductFeedState {
+    products: Product[];
+    /** Null until a first page is known, so a screen can render its own heading first. */
+    title: string | null;
+    /** The facets Shopify offers for these products under the current filters. */
+    availableFilters: Filter[];
+    /** Search only: how many products match. */
+    totalCount?: number;
+    /** Nothing to show yet: no cached page, and the first read is in flight. */
+    loading: boolean;
+    /** A later page is in flight: the grid keeps what it has and shows a footer spinner. */
+    loadingMore: boolean;
+    /** A cached page is on screen while the fresh one is read. No spinner needed. */
+    refreshing: boolean;
+    hasMore: boolean;
+    error: boolean;
+}
+export interface ProductFeedResult extends ProductFeedState {
+    loadMore: () => void;
+    /** Re-reads the first page from the network. The name for an error state's button. */
+    retry: () => void;
+    /** Re-reads the first page from the network, keeping what is on screen until it lands. */
+    refresh: () => void;
+    /** The shopper's filter selection, as the `input` strings of the values they picked. */
+    selectedFilters: string[];
+    /** Replace the selection. An input that isn't a Shopify filter (unparseable JSON) is dropped. */
+    setFilters: (inputs: string[]) => void;
+    clearFilters: () => void;
+    /** True while the shopper has at least one filter selected. */
+    filterActive: boolean;
+}
+export declare function useProductFeed(source: FeedSource): ProductFeedResult;
+//# sourceMappingURL=useProductFeed.d.ts.map

package/dist/react/useProductFeed.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"useProductFeed.d.ts","sourceRoot":"","sources":["../../src/react/useProductFeed.ts"],"names":[],"mappings":"AAmBA,OAAO,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AAEzE,uFAAuF;AACvF,eAAO,MAAM,mBAAmB,QAAY,CAAC;AAE7C,MAAM,WAAW,QAAQ;IACvB,KAAK,EAAE,OAAO,EAAE,CAAC;IACjB,QAAQ,EAAE,QAAQ,CAAC;IACnB,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;IACnB,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACtB,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,UAAU;IACzB,uGAAuG;IACvG,EAAE,EAAE,MAAM,GAAG,IAAI,CAAC;IAClB,6FAA6F;IAC7F,SAAS,EAAE,MAAM,CAAC;IAClB,2EAA2E;IAC3E,YAAY,CAAC,EAAE,aAAa,EAAE,CAAC;IAC/B,KAAK,CAAC,IAAI,EAAE;QAAE,KAAK,CAAC,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,aAAa,EAAE,GAAG,SAAS,CAAC;QAAC,KAAK,EAAE,OAAO,CAAA;KAAE,GAAG,OAAO,CAAC,QAAQ,CAAC,CAAC;IACzG,OAAO,CAAC,EAAE,CAAC,KAAK,EAAE,OAAO,EAAE,KAAK,EAAE,OAAO,GAAG,MAAM,KAAK,IAAI,CAAC;CAC7D;AAED,MAAM,WAAW,gBAAgB;IAC/B,QAAQ,EAAE,OAAO,EAAE,CAAC;IACpB,sFAAsF;IACtF,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IACrB,8EAA8E;IAC9E,gBAAgB,EAAE,MAAM,EAAE,CAAC;IAC3B,4CAA4C;IAC5C,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,4EAA4E;IAC5E,OAAO,EAAE,OAAO,CAAC;IACjB,wFAAwF;IACxF,WAAW,EAAE,OAAO,CAAC;IACrB,iFAAiF;IACjF,UAAU,EAAE,OAAO,CAAC;IACpB,OAAO,EAAE,OAAO,CAAC;IACjB,KAAK,EAAE,OAAO,CAAC;CAChB;AAED,MAAM,WAAW,iBAAkB,SAAQ,gBAAgB;IACzD,QAAQ,EAAE,MAAM,IAAI,CAAC;IACrB,sFAAsF;IACtF,KAAK,EAAE,MAAM,IAAI,CAAC;IAClB,0FAA0F;IAC1F,OAAO,EAAE,MAAM,IAAI,CAAC;IACpB,wFAAwF;IACxF,eAAe,EAAE,MAAM,EAAE,CAAC;IAC1B,iGAAiG;IACjG,UAAU,EAAE,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,IAAI,CAAC;IACvC,YAAY,EAAE,MAAM,IAAI,CAAC;IACzB,+DAA+D;IAC/D,YAAY,EAAE,OAAO,CAAC;CACvB;AAwCD,wBAAgB,cAAc,CAAC,MAAM,EAAE,UAAU,GAAG,iBAAiB,CA4KpE"}