@algolia/client-search 4.23.2 → 4.24.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.
@@ -811,6 +811,10 @@ export declare type Index = {
811
811
  * Contains the names of all linked replicas.
812
812
  */
813
813
  readonly replicas?: readonly string[];
814
+ /**
815
+ * Only present if the index is a virtual replica.
816
+ */
817
+ readonly virtual?: boolean;
814
818
  };
815
819
 
816
820
  export declare type IndexOperationResponse = {
@@ -1764,6 +1768,10 @@ export declare type SearchResponse<TObject = {}> = {
1764
1768
  * Time the server took to process the request, in milliseconds. This does not include network time.
1765
1769
  */
1766
1770
  processingTimeMS: number;
1771
+ /**
1772
+ * Time the server took to process the request, in milliseconds.
1773
+ */
1774
+ serverTimeMS?: number;
1767
1775
  /**
1768
1776
  * Whether the nbHits is exhaustive (true) or approximate (false).
1769
1777
  *
@@ -2342,6 +2350,10 @@ export declare type Settings = {
2342
2350
  */
2343
2351
  readonly values?: {
2344
2352
  readonly [facet: string]: {
2353
+ /**
2354
+ * Hide facet values
2355
+ */
2356
+ readonly hide?: readonly string[];
2345
2357
  /**
2346
2358
  * pinned order of facet values
2347
2359
  */
@@ -2356,6 +2368,49 @@ export declare type Settings = {
2356
2368
  };
2357
2369
  };
2358
2370
  };
2371
+ /**
2372
+ * Defining UI widget configuration
2373
+ */
2374
+ readonly widgets?: {
2375
+ /**
2376
+ * Configuration for banners
2377
+ */
2378
+ readonly banners?: ReadonlyArray<{
2379
+ /**
2380
+ * Configuration for the banner image
2381
+ */
2382
+ readonly image: {
2383
+ /**
2384
+ * Set of possible URLs of the banner image
2385
+ */
2386
+ readonly urls: ReadonlyArray<{
2387
+ /**
2388
+ * URL of the banner image
2389
+ */
2390
+ readonly url: string;
2391
+ }>;
2392
+ /**
2393
+ * Alt text of the banner image
2394
+ */
2395
+ readonly title?: string;
2396
+ };
2397
+ /**
2398
+ * Configuration for the banner click navigation
2399
+ */
2400
+ readonly link?: {
2401
+ /**
2402
+ * URL to navigate to when the banner is clicked
2403
+ */
2404
+ readonly url?: string;
2405
+ /**
2406
+ * Target of the navigation
2407
+ * - `_blank` opens the URL in a new tab
2408
+ * - `_self` opens the URL in the same tab
2409
+ */
2410
+ readonly target?: '_blank' | '_self';
2411
+ };
2412
+ }>;
2413
+ };
2359
2414
  };
2360
2415
  /**
2361
2416
  * Whether this index should use Dynamic Re-Ranking.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@algolia/client-search",
3
- "version": "4.23.2",
3
+ "version": "4.24.0",
4
4
  "private": false,
5
5
  "repository": {
6
6
  "type": "git",
@@ -16,8 +16,8 @@
16
16
  "dist"
17
17
  ],
18
18
  "dependencies": {
19
- "@algolia/client-common": "4.23.2",
20
- "@algolia/requester-common": "4.23.2",
21
- "@algolia/transporter": "4.23.2"
19
+ "@algolia/client-common": "4.24.0",
20
+ "@algolia/requester-common": "4.24.0",
21
+ "@algolia/transporter": "4.24.0"
22
22
  }
23
23
  }