@findlane/server 0.4.1 → 0.5.0

package/dist/index.d.cts

@@ -32,6 +32,8 @@ export type IndexSettings = {
      * search that finds nothing. Off by default. */
     didYouMean?: boolean;
     normalizationProfile?: "default-v2" | "default-v1" | "icelandic-ascii-v1";
+    /** An object field of lat and lng numbers, such as `_geoloc`, that `near` and `within` search; null for none. */
+    locationField?: string | null;
     [key: string]: unknown;
 };
 /** A settings change running in the background (with the settings it applies), or the last one's
@@ -72,6 +74,8 @@ export type PublicSearchPolicy = {
     facetFields: string[];
     sortIds: string[];
     defaultSort: string;
+    /** Whether browser search may use `near` and `within`, which show roughly where each record is. */
+    location?: boolean;
 };
 export type PublicSearchAccess = {
     publicId: string;
@@ -91,7 +95,7 @@ export type RecordSnapshot<T> = {
 };
 export type SearchRequest = {
     q?: string;
-    /** A sort ID from the index settings, or "relevance". */
+    /** 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. */
     filters?: Record<string, unknown>;
@@ -115,12 +119,35 @@ export type SearchRequest = {
         preTag?: string;
         postTag?: string;
     };
+    /** Nearest first from a point, with each hit's `distance` in meters; `radius` (meters) keeps only what's
+     * within it. With a query, the best matches come first and distance orders them. Needs the index's
+     * location field. Records without a location are left out. */
+    near?: GeoPoint & {
+        radius?: number;
+    };
+    /** Only records inside a box, in degrees, such as a map's visible area. West greater than east crosses the
+     * antimeridian. */
+    within?: GeoBox;
+};
+/** A point in degrees: lat from -90 to 90, lng from -180 to 180. */
+export type GeoPoint = {
+    lat: number;
+    lng: number;
+};
+/** A box in degrees, such as a map's bounds. */
+export type GeoBox = {
+    north: number;
+    south: number;
+    east: number;
+    west: number;
 };
 export type SearchResponse<T> = {
     hits: {
         id: string;
         score: number | null;
         record: T;
+        /** With `near`: meters from the point. */
+        distance?: number;
         /** With `highlight`: matched searchable fields by path; list fields give one string per value. */
         highlights?: Record<string, string | string[]>;
     }[];
@@ -137,6 +164,8 @@ export type SearchResponse<T> = {
     }>;
     tookMs: number;
     sort?: string;
+    /** With `near`: the point distances are from, or null when the visitor's location isn't known. */
+    near?: GeoPoint | null;
     /** 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;

package/dist/index.d.ts

@@ -32,6 +32,8 @@ export type IndexSettings = {
      * search that finds nothing. Off by default. */
     didYouMean?: boolean;
     normalizationProfile?: "default-v2" | "default-v1" | "icelandic-ascii-v1";
+    /** An object field of lat and lng numbers, such as `_geoloc`, that `near` and `within` search; null for none. */
+    locationField?: string | null;
     [key: string]: unknown;
 };
 /** A settings change running in the background (with the settings it applies), or the last one's
@@ -72,6 +74,8 @@ export type PublicSearchPolicy = {
     facetFields: string[];
     sortIds: string[];
     defaultSort: string;
+    /** Whether browser search may use `near` and `within`, which show roughly where each record is. */
+    location?: boolean;
 };
 export type PublicSearchAccess = {
     publicId: string;
@@ -91,7 +95,7 @@ export type RecordSnapshot<T> = {
 };
 export type SearchRequest = {
     q?: string;
-    /** A sort ID from the index settings, or "relevance". */
+    /** 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. */
     filters?: Record<string, unknown>;
@@ -115,12 +119,35 @@ export type SearchRequest = {
         preTag?: string;
         postTag?: string;
     };
+    /** Nearest first from a point, with each hit's `distance` in meters; `radius` (meters) keeps only what's
+     * within it. With a query, the best matches come first and distance orders them. Needs the index's
+     * location field. Records without a location are left out. */
+    near?: GeoPoint & {
+        radius?: number;
+    };
+    /** Only records inside a box, in degrees, such as a map's visible area. West greater than east crosses the
+     * antimeridian. */
+    within?: GeoBox;
+};
+/** A point in degrees: lat from -90 to 90, lng from -180 to 180. */
+export type GeoPoint = {
+    lat: number;
+    lng: number;
+};
+/** A box in degrees, such as a map's bounds. */
+export type GeoBox = {
+    north: number;
+    south: number;
+    east: number;
+    west: number;
 };
 export type SearchResponse<T> = {
     hits: {
         id: string;
         score: number | null;
         record: T;
+        /** With `near`: meters from the point. */
+        distance?: number;
         /** With `highlight`: matched searchable fields by path; list fields give one string per value. */
         highlights?: Record<string, string | string[]>;
     }[];
@@ -137,6 +164,8 @@ export type SearchResponse<T> = {
     }>;
     tookMs: number;
     sort?: string;
+    /** With `near`: the point distances are from, or null when the visitor's location isn't known. */
+    near?: GeoPoint | null;
     /** 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;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@findlane/server",
-  "version": "0.4.1",
+  "version": "0.5.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",