@findlane/server 0.37.0 → 0.38.0

package/dist/index.d.cts

@@ -341,7 +341,7 @@ export type PublicSearchPolicy = {
     sortIds?: string[];
     /** With `sortIds`: the sort browsers get when they ask for none. */
     defaultSort?: string;
-    /** Whether browser search may use `near` and `within`, which show roughly where each record is. */
+    /** Whether browser search may use `near`, `within`, `tile`, `bounds`, `clusters` and `spread`, which show roughly where each record is. */
     location?: boolean;
 };
 export type PublicSearchAccess = {
@@ -417,7 +417,7 @@ export type SearchRequest = {
      * `limit: 0` then gives no hits. */
     clusters?: {
         cells: MapCells;
-        stats?: string[];
+        stats?: ClusterStat[];
     };
     /** With `tile`: the page is each cell's best records (`perCell`, 1 by default, up to 10) rather than the top of one list. It takes
      * no `offset`, and `distinct` stays off. */
@@ -524,7 +524,14 @@ export type MapTile = {
 };
 /** Cells a side of a map tile. */
 export type MapCells = 1 | 2 | 4 | 8 | 16;
-/** A group of matches: how many, their average place, and the box around them. A box with no size means every record is at one place. */
+/** A number field in clusters' stats, by its name. With `gt`, values at or below it are left out of the stat, such as a price of 0
+ * that means no price. Those records stay in the cluster's `count`. */
+export type ClusterStat = string | {
+    field: string;
+    gt?: number;
+};
+/** A group of matches: how many, their average place, and the box around them. A box with no size means every record is at one
+ * place. `stats` leaves out a field no record has a value of. */
 export type Cluster = {
     count: number;
     lat: number;

package/dist/index.d.ts

@@ -341,7 +341,7 @@ export type PublicSearchPolicy = {
     sortIds?: string[];
     /** With `sortIds`: the sort browsers get when they ask for none. */
     defaultSort?: string;
-    /** Whether browser search may use `near` and `within`, which show roughly where each record is. */
+    /** Whether browser search may use `near`, `within`, `tile`, `bounds`, `clusters` and `spread`, which show roughly where each record is. */
     location?: boolean;
 };
 export type PublicSearchAccess = {
@@ -417,7 +417,7 @@ export type SearchRequest = {
      * `limit: 0` then gives no hits. */
     clusters?: {
         cells: MapCells;
-        stats?: string[];
+        stats?: ClusterStat[];
     };
     /** With `tile`: the page is each cell's best records (`perCell`, 1 by default, up to 10) rather than the top of one list. It takes
      * no `offset`, and `distinct` stays off. */
@@ -524,7 +524,14 @@ export type MapTile = {
 };
 /** Cells a side of a map tile. */
 export type MapCells = 1 | 2 | 4 | 8 | 16;
-/** A group of matches: how many, their average place, and the box around them. A box with no size means every record is at one place. */
+/** A number field in clusters' stats, by its name. With `gt`, values at or below it are left out of the stat, such as a price of 0
+ * that means no price. Those records stay in the cluster's `count`. */
+export type ClusterStat = string | {
+    field: string;
+    gt?: number;
+};
+/** A group of matches: how many, their average place, and the box around them. A box with no size means every record is at one
+ * place. `stats` leaves out a field no record has a value of. */
 export type Cluster = {
     count: number;
     lat: number;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@findlane/server",
-  "version": "0.37.0",
+  "version": "0.38.0",
   "description": "Findlane server SDK: upload catalogs, manage index settings, and search with a secret workspace API key.",
   "keywords": ["findlane", "search", "full-text search", "typo tolerance", "ecommerce search", "search api", "sdk"],
   "license": "MIT",