@findlane/server 0.27.0 → 0.28.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
@@ -309,13 +309,18 @@ export type CompareOptions = {
309
309
  searched?: boolean;
310
310
  signal?: AbortSignal;
311
311
  };
312
+ /** What browser search may do with an index. A list left out follows the index's settings: a policy of
313
+ * `returnFields` alone limits only the fields browsers get. Fields a page asks for that the policy hides
314
+ * are left out of its results. */
312
315
  export type PublicSearchPolicy = {
316
+ /** The fields browsers get; a parent such as `variations` returns the fields inside it. */
313
317
  returnFields: string[];
314
- searchFields: string[];
315
- filterFields: string[];
316
- facetFields: string[];
317
- sortIds: string[];
318
- defaultSort: string;
318
+ searchFields?: string[];
319
+ filterFields?: string[];
320
+ facetFields?: string[];
321
+ sortIds?: string[];
322
+ /** With `sortIds`: the sort browsers get when they ask for none. */
323
+ defaultSort?: string;
319
324
  /** Whether browser search may use `near` and `within`, which show roughly where each record is. */
320
325
  location?: boolean;
321
326
  };
package/dist/index.d.ts CHANGED
@@ -309,13 +309,18 @@ export type CompareOptions = {
309
309
  searched?: boolean;
310
310
  signal?: AbortSignal;
311
311
  };
312
+ /** What browser search may do with an index. A list left out follows the index's settings: a policy of
313
+ * `returnFields` alone limits only the fields browsers get. Fields a page asks for that the policy hides
314
+ * are left out of its results. */
312
315
  export type PublicSearchPolicy = {
316
+ /** The fields browsers get; a parent such as `variations` returns the fields inside it. */
313
317
  returnFields: string[];
314
- searchFields: string[];
315
- filterFields: string[];
316
- facetFields: string[];
317
- sortIds: string[];
318
- defaultSort: string;
318
+ searchFields?: string[];
319
+ filterFields?: string[];
320
+ facetFields?: string[];
321
+ sortIds?: string[];
322
+ /** With `sortIds`: the sort browsers get when they ask for none. */
323
+ defaultSort?: string;
319
324
  /** Whether browser search may use `near` and `within`, which show roughly where each record is. */
320
325
  location?: boolean;
321
326
  };
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@findlane/server",
3
- "version": "0.27.0",
3
+ "version": "0.28.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",