@findlane/browser 0.18.0 → 0.19.0

package/dist/index.d.ts

@@ -51,6 +51,9 @@ export type SearchRequest = {
     /** With the index's `distinct` setting, which shows each product once, such as one of its colours: false
      * shows every record, a number 1 to 4 how many of each group's records. */
     distinct?: boolean | number;
+    /** Contexts the page sends, which the index's rules may fire on, such as "category-page" or
+     * "black-friday": a name or up to 10, each 1 to 64 letters, digits, `_`, `:` or `-` (0.19.0). */
+    context?: string | string[];
 };
 /** A point in degrees: lat from -90 to 90, lng from -180 to 180. */
 export type GeoPoint = {
@@ -85,6 +88,8 @@ export type SearchHit<T> = {
     variant?: {
         index: number;
     };
+    /** A rule pinned it at its place (0.19.0). */
+    pinned?: true;
 };
 export type SearchResponse<T> = {
     hits: SearchHit<T>[];

package/dist/react/state.d.ts

@@ -39,6 +39,8 @@ export type SearchConfig = {
     /** "exact" (default) counts every match; "page" is faster on large indexes. */
     countMode?: "page" | "exact";
     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[];
 };
 export declare const emptyState: SearchState;
 /** The API's largest offset. */

package/dist/react/state.js

@@ -27,6 +27,7 @@ export function planSearch(config, state) {
         ...(config.fields ? { attributesToRetrieve: config.fields } : {}),
         countMode: config.countMode ?? "exact",
         ...(facets.length ? { facetMode: config.facetMode ?? "exact" } : {}),
+        ...(config.context?.length ? { context: config.context } : {}),
         highlight: true,
     };
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@findlane/browser",
-  "version": "0.18.0",
+  "version": "0.19.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",