@findlane/server 0.35.0 → 0.36.0

package/dist/index.d.cts

@@ -430,12 +430,17 @@ export type SearchRequest = {
      * subindexes count as one search (0.25.0). */
     subindexes?: Record<string, Omit<SearchRequest, "subindexes"> | true>;
     /** The facet values the query names (0.34.0): `true` for every field of the index's facetMatches setting, or
-     * `{ fields }` for some of them. They come back in `facetMatches`. */
+     * `{ fields }` for some of them. They come back in `facetMatches`. With the setting's `apply`, a match that names a
+     * value exactly filters this search (`applied`, with `rewrittenQuery`); `apply` chooses for this search instead (0.36.0). */
     facetMatches?: boolean | {
         fields?: string[];
+        apply?: FacetMatchApply;
     };
 };
-/** The facetMatches setting (0.34.0); see IndexSettings. */
+/** When a search that asks applies a facet match's filter (0.36.0): never (the default), when the match is the whole
+ * query, or whenever it names a value exactly, searching the query's other words. */
+export type FacetMatchApply = "never" | "whole" | "exact";
+/** The facetMatches setting (0.34.0); see IndexSettings. A field's `apply` goes over the setting's. */
 export type FacetMatchesSetting = {
     fields: Array<{
         field: string;
@@ -445,13 +450,15 @@ export type FacetMatchesSetting = {
         only?: "labelled";
         hide?: string[];
         link?: string;
+        apply?: FacetMatchApply;
     }>;
+    apply?: FacetMatchApply;
     perField?: number;
 };
 /** A facet value a query names (0.34.0): the field's `values` it stands for (several when values share a label),
  * its `label`, its `count` of records the search's filters allow, how it matched (`match`: exact, prefix, typo,
  * or contains, a later word of the value), whether it took every word (`whole`), where those words are in `q`
- * (`typed`, UTF-16 offsets), its `link`, a `filter` for it, and whether the search applied it (false for now). */
+ * (`typed`, UTF-16 offsets), its `link`, a `filter` for it, and whether the search applied it (`applied`, 0.36.0). */
 export type FacetMatch = {
     field: string;
     values: string[];

package/dist/index.d.ts

@@ -430,12 +430,17 @@ export type SearchRequest = {
      * subindexes count as one search (0.25.0). */
     subindexes?: Record<string, Omit<SearchRequest, "subindexes"> | true>;
     /** The facet values the query names (0.34.0): `true` for every field of the index's facetMatches setting, or
-     * `{ fields }` for some of them. They come back in `facetMatches`. */
+     * `{ fields }` for some of them. They come back in `facetMatches`. With the setting's `apply`, a match that names a
+     * value exactly filters this search (`applied`, with `rewrittenQuery`); `apply` chooses for this search instead (0.36.0). */
     facetMatches?: boolean | {
         fields?: string[];
+        apply?: FacetMatchApply;
     };
 };
-/** The facetMatches setting (0.34.0); see IndexSettings. */
+/** When a search that asks applies a facet match's filter (0.36.0): never (the default), when the match is the whole
+ * query, or whenever it names a value exactly, searching the query's other words. */
+export type FacetMatchApply = "never" | "whole" | "exact";
+/** The facetMatches setting (0.34.0); see IndexSettings. A field's `apply` goes over the setting's. */
 export type FacetMatchesSetting = {
     fields: Array<{
         field: string;
@@ -445,13 +450,15 @@ export type FacetMatchesSetting = {
         only?: "labelled";
         hide?: string[];
         link?: string;
+        apply?: FacetMatchApply;
     }>;
+    apply?: FacetMatchApply;
     perField?: number;
 };
 /** A facet value a query names (0.34.0): the field's `values` it stands for (several when values share a label),
  * its `label`, its `count` of records the search's filters allow, how it matched (`match`: exact, prefix, typo,
  * or contains, a later word of the value), whether it took every word (`whole`), where those words are in `q`
- * (`typed`, UTF-16 offsets), its `link`, a `filter` for it, and whether the search applied it (false for now). */
+ * (`typed`, UTF-16 offsets), its `link`, a `filter` for it, and whether the search applied it (`applied`, 0.36.0). */
 export type FacetMatch = {
     field: string;
     values: string[];

package/package.json

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