@findlane/browser 0.3.0 → 0.4.1

package/dist/index.d.ts

@@ -8,9 +8,12 @@ export type SearchRequest = {
     /** Facets (also in `facets`) counted without the filter on their own field, so a list of choices
      * keeps its other values, with counts, after one is chosen. */
     disjunctiveFacets?: string[];
+    /** Number fields (up to eight) whose smallest and largest values across the matches to return in
+     * `facetStats`, such as a price slider's bounds. Each field's own filter is left out. */
+    facetStats?: string[];
     /** Hits per request: 1–50 (default 20). */
     limit?: number;
-    /** Up to 1,000. */
+    /** Up to 5,000. */
     offset?: number;
     attributesToRetrieve?: string[];
     /** "page" (default) counts only the returned page when a query matches more; "exact" counts every match. */
@@ -37,6 +40,12 @@ export type SearchResponse<T> = {
     totalRelation?: "eq" | "gte";
     hasMore?: boolean;
     facets: Record<string, Record<string, number>>;
+    /** With `facetStats`: each field's smallest and largest value across the matches, without the field's
+     * own filter. A field no match has is left out. */
+    facetStats?: Record<string, {
+        min: number;
+        max: number;
+    }>;
     tookMs: number;
     sort?: string;
     /** With the index's `didYouMean` setting: the query with the words typo tolerance corrected, when the

package/dist/react/cache.js

@@ -12,7 +12,7 @@ export function searchKey(request) {
     for (const [key, value] of Object.entries(defaults))
         if (normal[key] === value)
             delete normal[key];
-    for (const key of ["facets", "disjunctiveFacets"]) {
+    for (const key of ["facets", "disjunctiveFacets", "facetStats"]) {
         const list = normal[key];
         if (Array.isArray(list))
             normal[key] = list.length ? [...list].sort() : undefined;

package/dist/react/search-provider.d.ts

@@ -72,9 +72,13 @@ export type Range = {
     gte?: number | string;
     lte?: number | string;
 };
-/** A number or date range filter. List the field in `filterFields` to keep it in the URL. */
+/** A number or date range filter. List the field in `filterFields` to keep it in the URL, and in
+ * `facetStats` for `min` and `max`: the smallest and largest values across the matches, without
+ * this range, such as a slider's bounds. */
 export declare function useRange(field: string): {
     range: Range | undefined;
+    min: number | undefined;
+    max: number | undefined;
     /** Leave a bound out (or empty) for no limit on that side. */
     setRange: (range: Range | undefined) => void;
     clear: () => void;
@@ -110,7 +114,7 @@ export declare function useLoadMore(): {
     shown: number;
     total: number;
 };
-/** Numbered pages, from 0. The API returns hits up to the 1,000th offset, so pages stop there. */
+/** Numbered pages, from 0. The API returns hits up to the 5,000th offset, so pages stop there. */
 export declare function usePagination(): {
     page: number;
     pages: number;

package/dist/react/search-provider.js

@@ -142,12 +142,17 @@ export function useRefinementList(field) {
         clear: () => store.update(withRefinement(field, [])),
     };
 }
-/** A number or date range filter. List the field in `filterFields` to keep it in the URL. */
+/** A number or date range filter. List the field in `filterFields` to keep it in the URL, and in
+ * `facetStats` for `min` and `max`: the smallest and largest values across the matches, without
+ * this range, such as a slider's bounds. */
 export function useRange(field) {
-    const [{ state }, store] = useSnapshot();
+    const [{ state, results }, store] = useSnapshot();
     const value = state.filters[field];
+    const stats = results?.response.facetStats?.[field];
     return {
         range: isRange(value) ? value : undefined,
+        min: stats?.min,
+        max: stats?.max,
         /** Leave a bound out (or empty) for no limit on that side. */
         setRange: (range) => {
             const bounds = Object.entries(range ?? {}).filter(([, bound]) => bound !== undefined && bound !== "");
@@ -203,7 +208,7 @@ export function useLoadMore() {
         total: results?.response.total ?? 0,
     };
 }
-/** Numbered pages, from 0. The API returns hits up to the 1,000th offset, so pages stop there. */
+/** Numbered pages, from 0. The API returns hits up to the 5,000th offset, so pages stop there. */
 export function usePagination() {
     const [{ state, results }, store] = useSnapshot();
     const pageSize = store.settings.pageSize ?? 20;

package/dist/react/state.d.ts

@@ -18,6 +18,9 @@ export type SearchConfig = {
     facets?: string[];
     /** Fields that useRange and useToggle filter, so the URL can carry them. */
     filterFields?: string[];
+    /** Number fields whose smallest and largest values across the matches useRange returns as `min`
+     * and `max`, such as a price slider's bounds. */
+    facetStats?: string[];
     /** Filters always applied, such as `{ published: true }`. They aren't shown as refinements. */
     filters?: Record<string, unknown>;
     /** Hits per page: 1–50 (default 20). */
@@ -30,7 +33,7 @@ export type SearchConfig = {
 };
 export declare const emptyState: SearchState;
 /** The API's largest offset. */
-export declare const maxOffset = 1000;
+export declare const maxOffset = 5000;
 /** The request behind a state. A facet with selections is counted without them
  * (`disjunctiveFacets`), so its other values stay listed and can be added. */
 export declare function planSearch(config: SearchConfig, state: SearchState): SearchRequest;

package/dist/react/state.js

@@ -1,6 +1,6 @@
 export const emptyState = { q: "", refinements: {}, filters: {}, page: 0 };
 /** The API's largest offset. */
-export const maxOffset = 1000;
+export const maxOffset = 5000;
 /** The request behind a state. A facet with selections is counted without them
  * (`disjunctiveFacets`), so its other values stay listed and can be added. */
 export function planSearch(config, state) {
@@ -19,6 +19,7 @@ export function planSearch(config, state) {
         ...(Object.keys(filters).length ? { filters } : {}),
         ...(facets.length ? { facets } : {}),
         ...(disjunctive.length ? { disjunctiveFacets: disjunctive } : {}),
+        ...(config.facetStats?.length ? { facetStats: config.facetStats } : {}),
         limit: pageSize,
         ...(state.page > 0 ? { offset: Math.min(state.page * pageSize, maxOffset) } : {}),
         ...(config.fields ? { attributesToRetrieve: config.fields } : {}),

package/dist/react/store.js

@@ -116,7 +116,7 @@ export class SearchStore {
         const { results, loadingMore, pending } = this.snapshot;
         if (!results?.hasMore || loadingMore || pending)
             return;
-        const { facets: _, disjunctiveFacets: __, facetMode: ___, ...request } = results.request;
+        const { facets: _, disjunctiveFacets: __, facetMode: ___, facetStats: ____, ...request } = results.request;
         const offset = (request.offset ?? 0) + results.hits.length;
         const run = this.run;
         this.set({ loadingMore: true });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@findlane/browser",
-  "version": "0.3.0",
+  "version": "0.4.1",
   "description": "Findlane browser SDK: fast, typo-tolerant public search from the browser with an index's public ID, plus React hooks and components.",
   "keywords": ["findlane", "search", "full-text search", "typo tolerance", "instant search", "ecommerce search", "browser", "react", "autocomplete"],
   "license": "MIT",