npm - @algolia/client-search - Versions diffs - 5.56.0 → 5.57.0 - Mend

@algolia/client-search 5.56.0 → 5.57.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.

Files changed (24) hide show

package/README.md +4 -4
package/dist/browser.d.ts +4 -2
package/dist/builds/browser.js +49 -21
package/dist/builds/browser.js.map +1 -1
package/dist/builds/browser.min.js +5 -5
package/dist/builds/browser.min.js.map +1 -1
package/dist/builds/browser.umd.js +7 -7
package/dist/builds/fetch.js +102 -60
package/dist/builds/fetch.js.map +1 -1
package/dist/builds/node.cjs +97 -58
package/dist/builds/node.cjs.map +1 -1
package/dist/builds/node.js +102 -60
package/dist/builds/node.js.map +1 -1
package/dist/builds/worker.js +49 -21
package/dist/builds/worker.js.map +1 -1
package/dist/fetch.d.ts +4 -2
package/dist/node.d.cts +4 -2
package/dist/node.d.ts +4 -2
package/dist/src/searchClient.cjs +45 -20
package/dist/src/searchClient.cjs.map +1 -1
package/dist/src/searchClient.js +53 -23
package/dist/src/searchClient.js.map +1 -1
package/dist/worker.d.ts +4 -2
package/package.json +9 -9

package/README.md CHANGED Viewed

@@ -40,11 +40,11 @@ All of our clients comes with type definition, and are available for both browse
 ### With a package manager
 ```bash
-yarn add @algolia/client-search@5.56.0
+yarn add @algolia/client-search@5.57.0
 # or
-npm install @algolia/client-search@5.56.0
+npm install @algolia/client-search@5.57.0
 # or
-pnpm add @algolia/client-search@5.56.0
+pnpm add @algolia/client-search@5.57.0
 ```
 ### Without a package manager
@@ -52,7 +52,7 @@ pnpm add @algolia/client-search@5.56.0
 Add the following JavaScript snippet to the <head> of your website:
 ```html
-<script src="https://cdn.jsdelivr.net/npm/@algolia/client-search@5.56.0/dist/builds/browser.umd.js"></script>
+<script src="https://cdn.jsdelivr.net/npm/@algolia/client-search@5.57.0/dist/builds/browser.umd.js"></script>
 ```
 ### Usage

package/dist/browser.d.ts CHANGED Viewed

@@ -3242,7 +3242,7 @@ type AccountCopyIndexOptions = ChunkedHelperOptions & {
     batchSize?: number | undefined;
 };
-declare const apiClientVersion = "5.56.0";
+declare const apiClientVersion = "5.57.0";
 declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode, algoliaAgents, ...options }: CreateClientOptions): {
     transporter: _algolia_client_common.TransporterWithHttpInfo;
     /**
@@ -3407,6 +3407,8 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
      * 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.
      * See https://api-clients-automation.netlify.app/docs/custom-helpers/#replaceallobjects for implementation details.
      *
+     * Warning: calling this method with an empty `objects` list replaces the index with an empty one, deleting all existing records.
+     *
      * @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.
      * @param replaceAllObjects - The `replaceAllObjects` object.
      * @param replaceAllObjects.indexName - The `indexName` to replace `objects` in.
@@ -3417,7 +3419,7 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
      * @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.
      */
     replaceAllObjects({ indexName, objects, batchSize, scopes, maxRetries, }: ReplaceAllObjectsOptions, requestOptions?: RequestOptions | undefined): Promise<ReplaceAllObjectsResponse>;
-    indexExists({ indexName }: GetSettingsProps): Promise<boolean>;
+    indexExists({ indexName }: GetSettingsProps, requestOptions?: RequestOptions | undefined): Promise<boolean>;
     /**
      * Helper: calls the `search` method but with certainty that we will only request Algolia records (hits) and not facets.
      * 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/dist/builds/browser.js CHANGED Viewed

@@ -15,10 +15,12 @@ import {
   createIterablePromise,
   createTransporter,
   getAlgoliaAgent,
+  logWarning,
   shuffle,
-  validateRequired
+  validateRequired,
+  withRequestId
 } from "@algolia/client-common";
-var apiClientVersion = "5.56.0";
+var apiClientVersion = "5.57.0";
 function getDefaultHosts(appId) {
   return [
     {
@@ -138,6 +140,7 @@ function createSearchClient({
       maxRetries = 100,
       timeout = (retryCount) => Math.min(retryCount * 200, 5e3)
     }, requestOptions) {
+      requestOptions = withRequestId(transporter, requestOptions);
       let retryCount = 0;
       return createIterablePromise({
         func: () => this.getTask({ indexName, taskID }, requestOptions),
@@ -165,6 +168,7 @@ function createSearchClient({
       maxRetries = 100,
       timeout = (retryCount) => Math.min(retryCount * 200, 5e3)
     }, requestOptions) {
+      requestOptions = withRequestId(transporter, requestOptions);
       let retryCount = 0;
       return createIterablePromise({
         func: () => this.getAppTask({ taskID }, requestOptions),
@@ -196,6 +200,7 @@ function createSearchClient({
       maxRetries = 100,
       timeout = (retryCount) => Math.min(retryCount * 200, 5e3)
     }, requestOptions) {
+      requestOptions = withRequestId(transporter, requestOptions);
       let retryCount = 0;
       const baseIteratorOptions = {
         aggregator: () => retryCount += 1,
@@ -251,6 +256,7 @@ function createSearchClient({
      * @param requestOptions - The requestOptions to send along with the query, they will be forwarded to the `browse` method and merged with the transporter requestOptions.
      */
     browseObjects({ indexName, browseParams, ...browseObjectsOptions }, requestOptions) {
+      requestOptions = withRequestId(transporter, requestOptions);
       return createIterablePromise({
         func: (previousResponse) => {
           return this.browse(
@@ -281,6 +287,7 @@ function createSearchClient({
      * @param requestOptions - The requestOptions to send along with the query, they will be forwarded to the `searchRules` method and merged with the transporter requestOptions.
      */
     browseRules({ indexName, searchRulesParams, ...browseRulesOptions }, requestOptions) {
+      requestOptions = withRequestId(transporter, requestOptions);
       const params = {
         ...searchRulesParams,
         hitsPerPage: searchRulesParams?.hitsPerPage || 1e3
@@ -318,6 +325,7 @@ function createSearchClient({
       searchSynonymsParams,
       ...browseSynonymsOptions
     }, requestOptions) {
+      requestOptions = withRequestId(transporter, requestOptions);
       const params = {
         ...searchSynonymsParams,
         page: searchSynonymsParams?.page || 0,
@@ -363,6 +371,7 @@ function createSearchClient({
       batchSize = 1e3,
       maxRetries = 100
     }, requestOptions) {
+      requestOptions = withRequestId(transporter, requestOptions);
       let requests = [];
       const responses = [];
       const objectEntries = objects.entries();
@@ -375,7 +384,7 @@ function createSearchClient({
       }
       if (waitForTasks) {
         for (const resp of responses) {
-          await this.waitForTask({ indexName, taskID: resp.taskID, maxRetries });
+          await this.waitForTask({ indexName, taskID: resp.taskID, maxRetries }, requestOptions);
         }
       }
       return responses;
@@ -453,6 +462,8 @@ function createSearchClient({
      * 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.
      * See https://api-clients-automation.netlify.app/docs/custom-helpers/#replaceallobjects for implementation details.
      *
+     * Warning: calling this method with an empty `objects` list replaces the index with an empty one, deleting all existing records.
+     *
      * @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.
      * @param replaceAllObjects - The `replaceAllObjects` object.
      * @param replaceAllObjects.indexName - The `indexName` to replace `objects` in.
@@ -469,6 +480,13 @@ function createSearchClient({
       scopes,
       maxRetries = DEFAULT_REPLACE_ALL_OBJECTS_MAX_RETRIES
     }, requestOptions) {
+      requestOptions = withRequestId(transporter, requestOptions);
+      if (objects.length === 0) {
+        logWarning(
+          transporter.logger,
+          `replaceAllObjects was called with an empty list of objects, which will delete all records currently in the "${indexName}" index.`
+        );
+      }
       const randomSuffix = Math.floor(Math.random() * 1e6) + 1e5;
       const tmpIndexName = `${indexName}_tmp_${randomSuffix}`;
       if (scopes === void 0) {
@@ -490,11 +508,14 @@ function createSearchClient({
           { indexName: tmpIndexName, objects, waitForTasks: true, batchSize, maxRetries },
           requestOptions
         );
-        await this.waitForTask({
-          indexName: tmpIndexName,
-          taskID: copyOperationResponse.taskID,
-          maxRetries
-        });
+        await this.waitForTask(
+          {
+            indexName: tmpIndexName,
+            taskID: copyOperationResponse.taskID,
+            maxRetries
+          },
+          requestOptions
+        );
         copyOperationResponse = await this.operationIndex(
           {
             indexName,
@@ -506,11 +527,14 @@ function createSearchClient({
           },
           requestOptions
         );
-        await this.waitForTask({
-          indexName: tmpIndexName,
-          taskID: copyOperationResponse.taskID,
-          maxRetries
-        });
+        await this.waitForTask(
+          {
+            indexName: tmpIndexName,
+            taskID: copyOperationResponse.taskID,
+            maxRetries
+          },
+          requestOptions
+        );
         const moveOperationResponse = await this.operationIndex(
           {
             indexName: tmpIndexName,
@@ -518,20 +542,23 @@ function createSearchClient({
           },
           requestOptions
         );
-        await this.waitForTask({
-          indexName: tmpIndexName,
-          taskID: moveOperationResponse.taskID,
-          maxRetries
-        });
+        await this.waitForTask(
+          {
+            indexName: tmpIndexName,
+            taskID: moveOperationResponse.taskID,
+            maxRetries
+          },
+          requestOptions
+        );
         return { copyOperationResponse, batchResponses, moveOperationResponse };
       } catch (error) {
-        await this.deleteIndex({ indexName: tmpIndexName });
+        await this.deleteIndex({ indexName: tmpIndexName }, requestOptions);
         throw error;
       }
     },
-    async indexExists({ indexName }) {
+    async indexExists({ indexName }, requestOptions) {
       try {
-        await this.getSettings({ indexName });
+        await this.getSettings({ indexName }, requestOptions);
       } catch (error) {
         if (error instanceof ApiError && error.status === 404) {
           return false;
@@ -4016,6 +4043,7 @@ function searchClient(appId, apiKey, options) {
     requester: createXhrRequester(),
     algoliaAgents: [{ segment: "Browser" }],
     authMode: "WithinQueryParameters",
+    requestIdChannel: "queryParameters",
     responsesCache: createMemoryCache(),
     requestsCache: createMemoryCache({ serializable: false }),
     hostsCache: createFallbackableCache({