@findlane/browser 0.17.0 → 0.18.0

package/dist/index.d.ts

@@ -48,6 +48,9 @@ export type SearchRequest = {
     within?: GeoBox;
     /** With the index's related results on: false asks for none (0.17.0). */
     related?: boolean;
+    /** 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;
 };
 /** A point in degrees: lat from -90 to 90, lng from -180 to 180. */
 export type GeoPoint = {
@@ -70,10 +73,25 @@ export type SearchHit<T> = {
     distance?: number;
     /** With `highlight`: matched searchable fields by path; list fields give one string per value. */
     highlights?: Record<string, string | string[]>;
+    /** With the index's `distinct` setting: the hit's group (its value of the group field, null for a record
+     * without one) and how many of the group's records matched. */
+    group?: {
+        value: string | number | null;
+        matched: number;
+    };
+    /** With the index's `variants` setting: which item of the record's variants list the search matched, by
+     * its words or by filters on the variants' fields, such as the flavour a shopper typed. Absent when none
+     * stands out. */
+    variant?: {
+        index: number;
+    };
 };
 export type SearchResponse<T> = {
     hits: SearchHit<T>[];
+    /** The matches; with the index's `distinct` setting, the groups. */
     total: number;
+    /** With `distinct`: the matching records, which `total` counts as groups. */
+    totalRecords?: number;
     /** "gte" when `total` is a lower bound (page count mode). */
     totalRelation?: "eq" | "gte";
     hasMore?: boolean;

package/package.json

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