@findlane/browser 0.12.0 → 0.13.0

package/dist/index.d.ts

@@ -2,7 +2,13 @@ export type SearchRequest = {
     q?: string;
     /** A sort ID from the index settings, "relevance", or "distance" (with `near`). */
     sort?: string;
-    /** Field values to keep: a value, `{ in: [...] }`, or a range `{ gte, lte }` for numbers and dates. */
+    /** Field values to keep. Each field takes a value (a list field contains it), or an object of
+     * conditions that all apply: `in` (any of up to 100 values), `all` (a list field has every one),
+     * `not` and `notIn` (records without the field stay in), and `gte`/`lte` for numbers and dates, such
+     * as `{ tags: { in: ["kids", "adult"], notIn: ["party"] }, price: { lte: 50 } }`. `"$or"` takes one to
+     * four groups of field filters and keeps records that match any group:
+     * `{ inStock: true, $or: [{ brand: "Acme" }, { price: { lte: 20 } }] }`. Up to 20 field filters,
+     * counting those in groups. */
     filters?: Record<string, unknown>;
     facets?: string[];
     /** Facets (also in `facets`) counted without the filter on their own field, so a list of choices
@@ -81,6 +87,16 @@ export type SearchResponse<T> = {
     /** With the index's `didYouMean` setting: the query with the words typo tolerance corrected, when the
      * results matched some words only by typo ("Showing results for …"), else null. */
     didYouMean?: DidYouMean | null;
+    /** The index's query rules the query fired, in the index's order, with their `userData`, such as a banner
+     * to show or a page to go to. Left out when none fired. */
+    appliedRules?: AppliedRule[];
+    /** When a rule replaced words: the query that was searched. */
+    rewrittenQuery?: string;
+};
+/** A query rule a search fired, with its `userData`, if it has any. */
+export type AppliedRule = {
+    id: string;
+    userData?: unknown;
 };
 /** A corrected query. `applied`: the results are already for `q` (a search's "Showing results for");
  * otherwise searching `q` finds results that the query didn't ("Did you mean"). `changes` lists each
@@ -97,8 +113,9 @@ export type DidYouMean = {
 export type RecommendationsRequest = {
     /** Up to this many products in each list, 1 to 20; 8 by default. */
     limit?: number;
-    /** Only picks matching these filters, as in a search, such as `{ inStock: true }`. The index's browser
-     * access decides which fields may be filtered by. */
+    /** Only picks matching these filters, as in a search, such as `{ inStock: true }`. Each field's filter
+     * takes the same shapes; `$or` is for searches only. The index's browser access decides which fields
+     * may be filtered by. */
     filters?: SearchRequest["filters"];
     /** The record fields to return; by default, those the index's browser access returns. */
     attributesToRetrieve?: string[];

package/package.json

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