@findlane/server 0.26.0 → 0.28.0

package/dist/index.cjs

@@ -381,6 +381,8 @@ class SearchServerClient {
           const stage = await beginReplacement(stageId, options.signal);
           if (stage.status === "committed")
             return { acceptedRevision: stage.acceptedRevision, recordCount: stage.recordCount, replaced: true };
+          if (stage.status === "committing")
+            return await commitReplacement(stageId, stage.batchCount, stage.recordCount, options.signal);
           if (stage.status !== "open")
             throw new Error(`Stage is ${stage.status}`);
           let batch = [];

package/dist/index.d.cts

@@ -21,7 +21,12 @@ export type IndexSettings = {
     }[];
     facetFields: string[];
     filterFields?: string[];
-    typoTolerance: boolean;
+    /** Prefixes and typos match (true, the default), or not (false). `"min"` keeps only the results with the
+     * fewest typos, and `"strict"` those and the ones with one more, ranked after them, as Algolia's modes do. */
+    typoTolerance: boolean | "min" | "strict";
+    /** The last query word matches as the start of longer words from its first letter, numbers too, for search
+     * boxes that search as you type. Off by default, when words match as prefixes from 3 letters. */
+    shortPrefixes?: boolean;
     /** Words of at least `oneTypo` letters match with one typo, and of at least `twoTypos` with two.
      * `{ oneTypo: 4, twoTypos: 7 }` by default; oneTypo is 3 to 20, twoTypos from oneTypo to 50. */
     typoWordLengths?: {
@@ -304,13 +309,18 @@ export type CompareOptions = {
     searched?: boolean;
     signal?: AbortSignal;
 };
+/** What browser search may do with an index. A list left out follows the index's settings: a policy of
+ * `returnFields` alone limits only the fields browsers get. Fields a page asks for that the policy hides
+ * are left out of its results. */
 export type PublicSearchPolicy = {
+    /** The fields browsers get; a parent such as `variations` returns the fields inside it. */
     returnFields: string[];
-    searchFields: string[];
-    filterFields: string[];
-    facetFields: string[];
-    sortIds: string[];
-    defaultSort: string;
+    searchFields?: string[];
+    filterFields?: string[];
+    facetFields?: string[];
+    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. */
     location?: boolean;
 };
@@ -691,7 +701,8 @@ export type IndexingStatus = {
 };
 export type ReplacementStage = {
     stageId: string;
-    status: "open" | "committed" | "aborted";
+    /** "committing" (0.27.0): a big stage's commit going on in steps; committing it again waits for it. */
+    status: "open" | "committing" | "committed" | "aborted";
     baseRevision: number;
     recordCount: number;
     batchCount: number;
@@ -1167,6 +1178,11 @@ export type RevenueReport = AnalyticsReport & {
             revenue: number;
         }>;
     };
+    /** Orders in the main currency cancelled or refunded since (0.27.0), which every number above leaves out, and their value. */
+    cancelled: {
+        orders: number;
+        revenue: number;
+    };
     otherCurrencies: {
         currency: string;
         orders: number;

package/dist/index.d.ts

@@ -21,7 +21,12 @@ export type IndexSettings = {
     }[];
     facetFields: string[];
     filterFields?: string[];
-    typoTolerance: boolean;
+    /** Prefixes and typos match (true, the default), or not (false). `"min"` keeps only the results with the
+     * fewest typos, and `"strict"` those and the ones with one more, ranked after them, as Algolia's modes do. */
+    typoTolerance: boolean | "min" | "strict";
+    /** The last query word matches as the start of longer words from its first letter, numbers too, for search
+     * boxes that search as you type. Off by default, when words match as prefixes from 3 letters. */
+    shortPrefixes?: boolean;
     /** Words of at least `oneTypo` letters match with one typo, and of at least `twoTypos` with two.
      * `{ oneTypo: 4, twoTypos: 7 }` by default; oneTypo is 3 to 20, twoTypos from oneTypo to 50. */
     typoWordLengths?: {
@@ -304,13 +309,18 @@ export type CompareOptions = {
     searched?: boolean;
     signal?: AbortSignal;
 };
+/** What browser search may do with an index. A list left out follows the index's settings: a policy of
+ * `returnFields` alone limits only the fields browsers get. Fields a page asks for that the policy hides
+ * are left out of its results. */
 export type PublicSearchPolicy = {
+    /** The fields browsers get; a parent such as `variations` returns the fields inside it. */
     returnFields: string[];
-    searchFields: string[];
-    filterFields: string[];
-    facetFields: string[];
-    sortIds: string[];
-    defaultSort: string;
+    searchFields?: string[];
+    filterFields?: string[];
+    facetFields?: string[];
+    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. */
     location?: boolean;
 };
@@ -691,7 +701,8 @@ export type IndexingStatus = {
 };
 export type ReplacementStage = {
     stageId: string;
-    status: "open" | "committed" | "aborted";
+    /** "committing" (0.27.0): a big stage's commit going on in steps; committing it again waits for it. */
+    status: "open" | "committing" | "committed" | "aborted";
     baseRevision: number;
     recordCount: number;
     batchCount: number;
@@ -1167,6 +1178,11 @@ export type RevenueReport = AnalyticsReport & {
             revenue: number;
         }>;
     };
+    /** Orders in the main currency cancelled or refunded since (0.27.0), which every number above leaves out, and their value. */
+    cancelled: {
+        orders: number;
+        revenue: number;
+    };
     otherCurrencies: {
         currency: string;
         orders: number;

package/dist/index.js

@@ -335,6 +335,8 @@ class SearchServerClient {
           const stage = await beginReplacement(stageId, options.signal);
           if (stage.status === "committed")
             return { acceptedRevision: stage.acceptedRevision, recordCount: stage.recordCount, replaced: true };
+          if (stage.status === "committing")
+            return await commitReplacement(stageId, stage.batchCount, stage.recordCount, options.signal);
           if (stage.status !== "open")
             throw new Error(`Stage is ${stage.status}`);
           let batch = [];

package/package.json

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