@findlane/server 0.9.0 → 0.10.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/index.d.cts CHANGED
@@ -189,14 +189,23 @@ export type RecommendationHit<T> = {
189
189
  score: number | null;
190
190
  record: T;
191
191
  };
192
+ /** A Bought together pick: `count` is the orders in the last year that had both products. */
193
+ export type TogetherHit<T> = RecommendationHit<T> & {
194
+ count: number;
195
+ };
192
196
  export type RecommendationsResponse<T> = {
193
197
  objectID: string;
194
- /** false until the product's lists are built; both lists are empty meanwhile. */
198
+ /** false until the product's lists are built; the lists are empty meanwhile. */
195
199
  ready: boolean;
196
200
  /** Products a shopper would want with this one, the likeliest first; `score` is the decision model's probability. */
197
201
  goesWith: RecommendationHit<T>[];
198
202
  /** Products a shopper could choose instead, then (unless the index hides them) variants of this one. */
199
203
  similar: RecommendationHit<T>[];
204
+ /** Products bought in the same orders as this one, the most orders first, from the orders sent with
205
+ * `index.events`. Empty without orders. */
206
+ together?: TogetherHit<T>[];
207
+ /** What `together`'s counts are of. */
208
+ togetherBasis?: "orders";
200
209
  };
201
210
  /** A corrected query. `applied`: the results are already for `q` (a search's "Showing results for");
202
211
  * otherwise searching `q` finds results that the query didn't ("Did you mean"). `changes` lists each
package/dist/index.d.ts CHANGED
@@ -189,14 +189,23 @@ export type RecommendationHit<T> = {
189
189
  score: number | null;
190
190
  record: T;
191
191
  };
192
+ /** A Bought together pick: `count` is the orders in the last year that had both products. */
193
+ export type TogetherHit<T> = RecommendationHit<T> & {
194
+ count: number;
195
+ };
192
196
  export type RecommendationsResponse<T> = {
193
197
  objectID: string;
194
- /** false until the product's lists are built; both lists are empty meanwhile. */
198
+ /** false until the product's lists are built; the lists are empty meanwhile. */
195
199
  ready: boolean;
196
200
  /** Products a shopper would want with this one, the likeliest first; `score` is the decision model's probability. */
197
201
  goesWith: RecommendationHit<T>[];
198
202
  /** Products a shopper could choose instead, then (unless the index hides them) variants of this one. */
199
203
  similar: RecommendationHit<T>[];
204
+ /** Products bought in the same orders as this one, the most orders first, from the orders sent with
205
+ * `index.events`. Empty without orders. */
206
+ together?: TogetherHit<T>[];
207
+ /** What `together`'s counts are of. */
208
+ togetherBasis?: "orders";
200
209
  };
201
210
  /** A corrected query. `applied`: the results are already for `q` (a search's "Showing results for");
202
211
  * otherwise searching `q` finds results that the query didn't ("Did you mean"). `changes` lists each
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@findlane/server",
3
- "version": "0.9.0",
3
+ "version": "0.10.0",
4
4
  "description": "Findlane server SDK: upload catalogs, manage index settings, and search with a secret workspace API key.",
5
5
  "keywords": ["findlane", "search", "full-text search", "typo tolerance", "ecommerce search", "search api", "sdk"],
6
6
  "license": "MIT",