@algolia/client-search 5.56.0 → 5.59.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/worker.d.ts CHANGED
@@ -748,6 +748,10 @@ type LogQuery = {
748
748
  };
749
749
 
750
750
  type Log = {
751
+ /**
752
+ * Correlation ID of the logged API request, also returned in that request\'s `Correlation-ID` response header.
753
+ */
754
+ cid?: string | undefined;
751
755
  /**
752
756
  * Date and time of the API request, in RFC 3339 format.
753
757
  */
@@ -3242,7 +3246,7 @@ type AccountCopyIndexOptions = ChunkedHelperOptions & {
3242
3246
  batchSize?: number | undefined;
3243
3247
  };
3244
3248
 
3245
- declare const apiClientVersion = "5.56.0";
3249
+ declare const apiClientVersion = "5.59.0";
3246
3250
  declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode, algoliaAgents, ...options }: CreateClientOptions): {
3247
3251
  transporter: _algolia_client_common.TransporterWithHttpInfo;
3248
3252
  /**
@@ -3407,6 +3411,8 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
3407
3411
  * Helper: Replaces all objects (records) in the given `index_name` with the given `objects`. A temporary index is created during this process in order to backup your data.
3408
3412
  * See https://api-clients-automation.netlify.app/docs/custom-helpers/#replaceallobjects for implementation details.
3409
3413
  *
3414
+ * Warning: calling this method with an empty `objects` list replaces the index with an empty one, deleting all existing records.
3415
+ *
3410
3416
  * @summary Helper: Replaces all objects (records) in the given `index_name` with the given `objects`. A temporary index is created during this process in order to backup your data.
3411
3417
  * @param replaceAllObjects - The `replaceAllObjects` object.
3412
3418
  * @param replaceAllObjects.indexName - The `indexName` to replace `objects` in.
@@ -3417,7 +3423,7 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
3417
3423
  * @param requestOptions - The requestOptions to send along with the query, they will be forwarded to the `batch`, `operationIndex` and `getTask` method and merged with the transporter requestOptions.
3418
3424
  */
3419
3425
  replaceAllObjects({ indexName, objects, batchSize, scopes, maxRetries, }: ReplaceAllObjectsOptions, requestOptions?: RequestOptions | undefined): Promise<ReplaceAllObjectsResponse>;
3420
- indexExists({ indexName }: GetSettingsProps): Promise<boolean>;
3426
+ indexExists({ indexName }: GetSettingsProps, requestOptions?: RequestOptions | undefined): Promise<boolean>;
3421
3427
  /**
3422
3428
  * Helper: calls the `search` method but with certainty that we will only request Algolia records (hits) and not facets.
3423
3429
  * Disclaimer: We don't assert that the parameters you pass to this method only contains `hits` requests to prevent impacting search performances, this helper is purely for typing purposes.
package/package.json CHANGED
@@ -1,5 +1,5 @@
1
1
  {
2
- "version": "5.56.0",
2
+ "version": "5.59.0",
3
3
  "repository": {
4
4
  "type": "git",
5
5
  "url": "git+https://github.com/algolia/algoliasearch-client-javascript.git"
@@ -54,21 +54,21 @@
54
54
  "index.d.ts"
55
55
  ],
56
56
  "dependencies": {
57
- "@algolia/client-common": "5.56.0",
58
- "@algolia/requester-browser-xhr": "5.56.0",
59
- "@algolia/requester-fetch": "5.56.0",
60
- "@algolia/requester-node-http": "5.56.0"
57
+ "@algolia/client-common": "5.59.0",
58
+ "@algolia/requester-browser-xhr": "5.59.0",
59
+ "@algolia/requester-fetch": "5.59.0",
60
+ "@algolia/requester-node-http": "5.59.0"
61
61
  },
62
62
  "devDependencies": {
63
63
  "@arethetypeswrong/cli": "0.18.5",
64
- "@types/node": "26.1.1",
65
- "publint": "0.3.21",
66
- "rollup": "4.62.2",
64
+ "@types/node": "26.4.1",
65
+ "publint": "0.3.24",
66
+ "rollup": "4.63.1",
67
67
  "tsup": "8.5.1",
68
68
  "typescript": "5.9.3"
69
69
  },
70
70
  "engines": {
71
71
  "node": ">= 14.0.0"
72
72
  },
73
- "gitHead": "d6430d45e71470a1099ccb7aaeacc4a858420f56"
73
+ "gitHead": "6f5c9b04c6a2e27bba935d37ff7f1bc737c48984"
74
74
  }