@findlane/server 0.1.1 → 0.3.0

package/README.md

@@ -44,7 +44,7 @@ The workspace ID is under Settings in the dashboard, and keys are under API keys
 | `delete(objectID)` | Delete a record. |
 | `getRecord(objectID)` | A record and its version. |
 | `upsertOne(record, { expectedVersion })`, `deleteOne(objectID, { expectedVersion })` | Write only if the record is still at `expectedVersion` (0 for one that never existed); retried with one idempotency key. |
-| `getSettings()`, `replaceSettings(settings)`, `waitForSettings()` | Read and change searchable fields, facets, filters, sorts, custom ranking, synonyms, typo tolerance, and text normalization. |
+| `getSettings()`, `replaceSettings(settings)`, `waitForSettings()` | Read and change searchable fields, facets, filters, sorts, custom ranking, synonyms, languages, typo tolerance, and text normalization. |
 | `getIndexingStatus()`, `waitUntilIndexed(revision)` | Writes return an accepted revision and are searchable when accepted, so `waitUntilIndexed` returns at once. |
 | `getPublicSearchAccess()`, `setPublicSearchPolicy(policy)`, `usePublicIndexDefaults()` | Restrict what browser search may read and query. |
 

package/dist/index.d.ts

@@ -26,6 +26,11 @@ export type IndexSettings = {
     customRanking?: SortRule[];
     /** Groups of interchangeable words or phrases (up to four words each). */
     synonyms?: string[][];
+    /** Languages whose common words queries drop, and whose plurals and alternative spellings match. */
+    languages?: Array<"da" | "de" | "en" | "is" | "no" | "sv">;
+    /** Searches say which words typo tolerance corrected, and `suggest()` offers a corrected query for a
+     * search that finds nothing. Off by default. */
+    didYouMean?: boolean;
     normalizationProfile?: "default-v2" | "default-v1" | "icelandic-ascii-v1";
     [key: string]: unknown;
 };
@@ -91,6 +96,9 @@ export type SearchRequest = {
     /** Field values to keep: a value, `{ in: [...] }`, or a range `{ gte, lte }` for numbers and dates. */
     filters?: Record<string, unknown>;
     facets?: string[];
+    /** Facets (also in `facets`) counted without the filter on their own field, so a list of choices
+     * keeps its other values, with counts, after one is chosen. */
+    disjunctiveFacets?: string[];
     limit?: number;
     offset?: number;
     attributesToRetrieve?: string[];
@@ -120,6 +128,20 @@ export type SearchResponse<T> = {
     facets: Record<string, Record<string, number>>;
     tookMs: number;
     sort?: string;
+    /** 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;
+};
+/** 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
+ * changed part of the query as typed. */
+export type DidYouMean = {
+    q: string;
+    applied: boolean;
+    changes: {
+        from: string;
+        to: string;
+    }[];
 };
 export type ConditionalWriteOptions = {
     expectedVersion: number;
@@ -176,6 +198,10 @@ export declare class SearchServerClient {
     } = JsonRecord>(name: string): {
         /** Searches the index; the API key needs the `search` scope. */
         search: <R = T>(query?: SearchRequest, signal?: AbortSignal) => Promise<SearchResponse<R>>;
+        /** Did you mean: for a search that found nothing, a query that finds something, or null. Takes the
+         * same request (its q, filters, and fields matter). Needs the `didYouMean` setting; not counted as
+         * a search. */
+        suggest: (query: SearchRequest, signal?: AbortSignal) => Promise<DidYouMean | null>;
         upsert: (records: T[], signal?: AbortSignal) => Promise<WriteReceipt>;
         getRecord: (objectID: string, signal?: AbortSignal) => Promise<RecordSnapshot<T>>;
         upsertOne: (record: T, options: ConditionalWriteOptions) => Promise<WriteReceipt>;

package/dist/index.js

@@ -97,6 +97,7 @@ class SearchServerClient {
     };
     return {
       search: (query = {}, signal) => request("/search", "POST", query, signal),
+      suggest: async (query, signal) => (await request("/suggest", "POST", query, signal)).didYouMean,
       upsert: (records, signal) => request("/records", "POST", { records }, signal),
       getRecord: (objectID, signal) => request(`/records/${encodeURIComponent(objectID)}`, "GET", undefined, signal),
       upsertOne: (record, options) => writeOne("upsert", record.objectID, record, options),

package/package.json

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