@findlane/browser 0.22.0 → 0.23.0

package/dist/react/index.d.ts

@@ -4,7 +4,7 @@ export { useAutocomplete, type AutocompleteItem, type AutocompleteOptions, type
 export { useRecommendations, type UseRecommendationsOptions, type UseRecommendationsResult } from "./use-recommendations.js";
 export { Recommendations, type RecommendationsProps } from "./recommendations.js";
 export { ProductView, useProductView } from "./product-view.js";
-export { SearchProvider, useCurrentRefinements, useDidYouMean, useGeoSearch, useHits, useLoadMore, usePagination, useRange, useRefinementList, useSearchBox, useSearchState, useSortBy, useToggle, type Range, type Refinement, type SearchProviderProps, } from "./search-provider.js";
+export { SearchProvider, useCurrentRefinements, useDidYouMean, useGeoSearch, useHits, useLoadMore, usePagination, useRange, useRefinementList, useSearchBox, useSearchState, useSortBy, useSubindex, useToggle, type Range, type Refinement, type SearchProviderProps, } from "./search-provider.js";
 export { CurrentRefinements, DefaultBanner, DefaultHit, DidYouMean, Hits, LoadMore, RefinementList, SearchBox, SearchInput, SortSelect, Stats, type HitsProps, type RefinementListProps, type SearchBoxProps, type SuggestionLabels, } from "./components.js";
 export { SearchDialog, type SearchDialogProps } from "./dialog.js";
 export { Highlight, Snippet, excerpt, highlightParts, type HighlightProps } from "./highlight.js";

package/dist/react/index.js

@@ -6,7 +6,7 @@ export { useAutocomplete } from "./use-autocomplete.js";
 export { useRecommendations } from "./use-recommendations.js";
 export { Recommendations } from "./recommendations.js";
 export { ProductView, useProductView } from "./product-view.js";
-export { SearchProvider, useCurrentRefinements, useDidYouMean, useGeoSearch, useHits, useLoadMore, usePagination, useRange, useRefinementList, useSearchBox, useSearchState, useSortBy, useToggle, } from "./search-provider.js";
+export { SearchProvider, useCurrentRefinements, useDidYouMean, useGeoSearch, useHits, useLoadMore, usePagination, useRange, useRefinementList, useSearchBox, useSearchState, useSortBy, useSubindex, useToggle, } from "./search-provider.js";
 export { CurrentRefinements, DefaultBanner, DefaultHit, DidYouMean, Hits, LoadMore, RefinementList, SearchBox, SearchInput, SortSelect, Stats, } from "./components.js";
 export { SearchDialog } from "./dialog.js";
 export { Highlight, Snippet, excerpt, highlightParts } from "./highlight.js";

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

@@ -2,7 +2,7 @@ import { type ReactNode } from "react";
 import type { DidYouMean, GeoBox } from "../index.js";
 import { type ClientOptions } from "./client.js";
 import { type ServerResults, type StateChange } from "./store.js";
-import { type Near, type SearchConfig, type SearchState } from "./state.js";
+import { type Hit, type Near, type SearchConfig, type SearchState } from "./state.js";
 export type SearchProviderProps<T> = SearchConfig & ClientOptions & {
     children: ReactNode;
     /** Keeps the state in the page's URL (`?q=shoe&brand=Acme`), so results can be shared and Back
@@ -32,8 +32,11 @@ export declare function useSearchBox(): {
     /** Opens the connection to the API ahead of the first search: call it when the box gets focus. */
     warm: () => void;
 };
+/** A subindex's results for the current query (SearchProvider's `subindexes`), such as categories to suggest
+ * above the results; none without a query, or when its search failed (0.23.0). */
+export declare function useSubindex<T = Record<string, unknown>>(name: string): Hit<T>[];
 export declare function useHits<T = Record<string, unknown>>(): {
-    hits: import("./state.js").Hit<T>[];
+    hits: Hit<T>[];
     total: number;
     /** With the index's related results on, when nothing matched: the products closest in meaning. */
     related: import("../index.js").SearchHit<T>[];

package/dist/react/search-provider.js

@@ -77,6 +77,13 @@ export function useSearchBox() {
         /** Opens the connection to the API ahead of the first search: call it when the box gets focus. */
         warm: () => store.warm() };
 }
+/** A subindex's results for the current query (SearchProvider's `subindexes`), such as categories to suggest
+ * above the results; none without a query, or when its search failed (0.23.0). */
+export function useSubindex(name) {
+    const [{ results }] = useSnapshot();
+    const answer = results?.response.subindexes?.[name];
+    return answer && "hits" in answer ? answer.hits : [];
+}
 export function useHits() {
     const [{ results, pending, error }, store] = useSnapshot();
     return {

package/dist/react/state.d.ts

@@ -41,6 +41,9 @@ export type SearchConfig = {
     facetMode?: "page" | "exact";
     /** Contexts the page sends, which the index's rules may fire on, such as "category-page" (0.19.0). */
     context?: string | string[];
+    /** The index's subindexes to search with each query, such as categories to suggest above the results, by
+     * name (0.23.0): in the same request, counted as one search. Read them with useSubindex. */
+    subindexes?: SearchRequest["subindexes"];
 };
 export declare const emptyState: SearchState;
 /** The API's largest offset. */

package/dist/react/state.js

@@ -28,6 +28,8 @@ export function planSearch(config, state) {
         countMode: config.countMode ?? "exact",
         ...(facets.length ? { facetMode: config.facetMode ?? "exact" } : {}),
         ...(config.context?.length ? { context: config.context } : {}),
+        // Subindexes only for a query: a page without words has nothing to suggest.
+        ...(config.subindexes && state.q.trim() ? { subindexes: config.subindexes } : {}),
         highlight: true,
     };
 }

package/dist/react/store.js

@@ -164,7 +164,7 @@ export class SearchStore {
         const { results, loadingMore, pending } = this.snapshot;
         if (!results?.hasMore || loadingMore || pending)
             return;
-        const { facets: _, disjunctiveFacets: __, facetMode: ___, facetStats: ____, ...request } = results.request;
+        const { facets: _, disjunctiveFacets: __, facetMode: ___, facetStats: ____, subindexes: _____, ...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.22.0",
+  "version": "0.23.0",
   "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",