@findlane/server 0.20.0 → 0.22.0

package/dist/index.d.cts

@@ -386,6 +386,11 @@ export type SearchRequest = {
     /** Contexts the page sends, which rules with a `context` condition fire on, such as "category-page": a
      * name or up to 10, each 1 to 64 letters, digits, `_`, `:` or `-` (0.20.0). */
     context?: string | string[];
+    /** Records matching these filters come first, after the index's rank first, in searches by relevance: filters as
+     * `filters` takes them, or a list of up to 10, each counting once, so records matching more come first (0.21.0). */
+    boost?: SearchRequest["filters"] | SearchRequest["filters"][];
+    /** Records matching these come last, the same way (0.21.0). */
+    bury?: SearchRequest["filters"] | SearchRequest["filters"][];
     /** Checks rules as at this time, in milliseconds since 1970, such as a campaign's start, instead of now
      * (0.20.0). Browser search doesn't take it. */
     rulesAt?: number;
@@ -458,6 +463,14 @@ export type AppliedRule = {
     id: string;
     userData?: unknown;
 };
+/** A rule's banner: an image, where it links, its text, its place among the hits from 1, and the rule's ID. */
+export type Banner = {
+    image: string;
+    link?: string;
+    title?: string;
+    position?: number;
+    rule: string;
+};
 export type SearchResponse<T> = {
     hits: {
         id: string;
@@ -512,6 +525,11 @@ export type SearchResponse<T> = {
     appliedRules?: AppliedRule[];
     /** When a rule replaced words: the query that was searched. */
     rewrittenQuery?: string;
+    /** Banners of the rules that fired, in their order (0.21.0): show each at its `position` among the hits (from
+     * 1; the top when left out), linking to `link`. */
+    banners?: Banner[];
+    /** A page a rule sends this search to, such as "/pages/returns" (0.21.0): go there instead of showing results. */
+    redirect?: string;
     /** With the index's `relatedResults` on (0.18.0): when the query's words found nothing (`hits` empty,
      * `total` 0), the products closest to it in meaning, best first, with their similarity as `score`. Show
      * them under a heading of their own, such as "No exact matches. Related products". */
@@ -727,6 +745,15 @@ export type ServerEvent = {
  | {
     type: "cancel";
     orderID: string;
+}
+/** A rule's banner was clicked: its rule, as search responses give it with the banner, the search's
+ * query, and its place. */
+ | {
+    type: "bannerClick";
+    rule: string;
+    query?: string;
+    position?: number;
+    timestamp?: number;
 };
 /** A past order for importOrders; `timestamp` is when it was placed (ms, a Date, or an ISO string). */
 export type Order = {

package/dist/index.d.ts

@@ -386,6 +386,11 @@ export type SearchRequest = {
     /** Contexts the page sends, which rules with a `context` condition fire on, such as "category-page": a
      * name or up to 10, each 1 to 64 letters, digits, `_`, `:` or `-` (0.20.0). */
     context?: string | string[];
+    /** Records matching these filters come first, after the index's rank first, in searches by relevance: filters as
+     * `filters` takes them, or a list of up to 10, each counting once, so records matching more come first (0.21.0). */
+    boost?: SearchRequest["filters"] | SearchRequest["filters"][];
+    /** Records matching these come last, the same way (0.21.0). */
+    bury?: SearchRequest["filters"] | SearchRequest["filters"][];
     /** Checks rules as at this time, in milliseconds since 1970, such as a campaign's start, instead of now
      * (0.20.0). Browser search doesn't take it. */
     rulesAt?: number;
@@ -458,6 +463,14 @@ export type AppliedRule = {
     id: string;
     userData?: unknown;
 };
+/** A rule's banner: an image, where it links, its text, its place among the hits from 1, and the rule's ID. */
+export type Banner = {
+    image: string;
+    link?: string;
+    title?: string;
+    position?: number;
+    rule: string;
+};
 export type SearchResponse<T> = {
     hits: {
         id: string;
@@ -512,6 +525,11 @@ export type SearchResponse<T> = {
     appliedRules?: AppliedRule[];
     /** When a rule replaced words: the query that was searched. */
     rewrittenQuery?: string;
+    /** Banners of the rules that fired, in their order (0.21.0): show each at its `position` among the hits (from
+     * 1; the top when left out), linking to `link`. */
+    banners?: Banner[];
+    /** A page a rule sends this search to, such as "/pages/returns" (0.21.0): go there instead of showing results. */
+    redirect?: string;
     /** With the index's `relatedResults` on (0.18.0): when the query's words found nothing (`hits` empty,
      * `total` 0), the products closest to it in meaning, best first, with their similarity as `score`. Show
      * them under a heading of their own, such as "No exact matches. Related products". */
@@ -727,6 +745,15 @@ export type ServerEvent = {
  | {
     type: "cancel";
     orderID: string;
+}
+/** A rule's banner was clicked: its rule, as search responses give it with the banner, the search's
+ * query, and its place. */
+ | {
+    type: "bannerClick";
+    rule: string;
+    query?: string;
+    position?: number;
+    timestamp?: number;
 };
 /** A past order for importOrders; `timestamp` is when it was placed (ms, a Date, or an ISO string). */
 export type Order = {

package/package.json

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