@findlane/server 0.13.0 → 0.14.0

package/dist/index.d.cts

@@ -57,6 +57,12 @@ export type IndexSettings = {
     /** Searches say which words typo tolerance corrected, and `suggest()` offers a corrected query for a
      * search that finds nothing. Off by default. */
     didYouMean?: boolean;
+    /** Compound words find each other written as one word or apart, in any language: a query word that the
+     * index's words show is a compound also matches its parts written apart ("sjóræningjabúningur" finds
+     * "Sjóræningja búningur"), and neighbouring query words the word they make ("face paint" finds "facepaint").
+     * Exact matches rank first. Searches use it once the index's word list is built, a minute or so after it's
+     * turned on. Off by default. */
+    compoundWords?: 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;
@@ -217,14 +223,16 @@ export type GeoBox = {
     east: number;
     west: number;
 };
-/** How a query word matched: as itself, as the start of a longer word, within its typos, through a synonym, or
- * as another form of the word in the index's languages (a plural or another spelling). */
-export type MatchKind = "exact" | "prefix" | "typo" | "synonym" | "form";
-/** A query word's best match in one searchable field. `word` is the matched word (or a synonym's phrase) as
- * the record writes it. `weight` is what that kind of match weighs in the search: the field's weight times 1
- * for exact, 0.8 for a synonym or word form, 0.2 for a prefix, and 0.1 for a typo. A typo has `edits`, or
- * `firstLetter` when the first letter differs (tried only when nothing matched without); a synonym has the
- * `synonym` that matched. */
+/** How a query word matched: as itself, as the start of a longer word, within its typos, through a synonym,
+ * as another form of the word in the index's languages (a plural or another spelling), or, with the
+ * `compoundWords` setting, as a compound: its parts written apart, or the word it makes with a neighbouring
+ * query word. */
+export type MatchKind = "exact" | "prefix" | "typo" | "synonym" | "form" | "compound";
+/** A query word's best match in one searchable field. `word` is the matched word (or a synonym's phrase, or a
+ * compound's parts) as the record writes it. `weight` is what that kind of match weighs in the search: the
+ * field's weight times 1 for exact, 0.8 for a synonym or word form, 0.4 for a compound, 0.2 for a prefix, and
+ * 0.1 for a typo. A typo has `edits`, or `firstLetter` when the first letter differs (tried only when nothing
+ * matched without); a synonym has the `synonym` that matched. */
 export type FieldMatch = {
     field: string;
     word: string;

package/dist/index.d.ts

@@ -57,6 +57,12 @@ export type IndexSettings = {
     /** Searches say which words typo tolerance corrected, and `suggest()` offers a corrected query for a
      * search that finds nothing. Off by default. */
     didYouMean?: boolean;
+    /** Compound words find each other written as one word or apart, in any language: a query word that the
+     * index's words show is a compound also matches its parts written apart ("sjóræningjabúningur" finds
+     * "Sjóræningja búningur"), and neighbouring query words the word they make ("face paint" finds "facepaint").
+     * Exact matches rank first. Searches use it once the index's word list is built, a minute or so after it's
+     * turned on. Off by default. */
+    compoundWords?: 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;
@@ -217,14 +223,16 @@ export type GeoBox = {
     east: number;
     west: number;
 };
-/** How a query word matched: as itself, as the start of a longer word, within its typos, through a synonym, or
- * as another form of the word in the index's languages (a plural or another spelling). */
-export type MatchKind = "exact" | "prefix" | "typo" | "synonym" | "form";
-/** A query word's best match in one searchable field. `word` is the matched word (or a synonym's phrase) as
- * the record writes it. `weight` is what that kind of match weighs in the search: the field's weight times 1
- * for exact, 0.8 for a synonym or word form, 0.2 for a prefix, and 0.1 for a typo. A typo has `edits`, or
- * `firstLetter` when the first letter differs (tried only when nothing matched without); a synonym has the
- * `synonym` that matched. */
+/** How a query word matched: as itself, as the start of a longer word, within its typos, through a synonym,
+ * as another form of the word in the index's languages (a plural or another spelling), or, with the
+ * `compoundWords` setting, as a compound: its parts written apart, or the word it makes with a neighbouring
+ * query word. */
+export type MatchKind = "exact" | "prefix" | "typo" | "synonym" | "form" | "compound";
+/** A query word's best match in one searchable field. `word` is the matched word (or a synonym's phrase, or a
+ * compound's parts) as the record writes it. `weight` is what that kind of match weighs in the search: the
+ * field's weight times 1 for exact, 0.8 for a synonym or word form, 0.4 for a compound, 0.2 for a prefix, and
+ * 0.1 for a typo. A typo has `edits`, or `firstLetter` when the first letter differs (tried only when nothing
+ * matched without); a synonym has the `synonym` that matched. */
 export type FieldMatch = {
     field: string;
     word: string;

package/package.json

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