@algolia/client-search 5.23.3 → 5.24.0

package/dist/builds/node.js

@@ -1,7 +1,15 @@
 // builds/node.ts
 import { createHmac } from "node:crypto";
 import { createHttpRequester } from "@algolia/requester-node-http";
-import { createMemoryCache, createNullCache, createNullLogger, serializeQueryParameters } from "@algolia/client-common";
+import {
+  IndexAlreadyExistsError,
+  IndexNotFoundError,
+  IndicesInSameAppError,
+  createMemoryCache,
+  createNullCache,
+  createNullLogger,
+  serializeQueryParameters
+} from "@algolia/client-common";
 
 // src/searchClient.ts
 import {
@@ -12,7 +20,7 @@ import {
   getAlgoliaAgent,
   shuffle
 } from "@algolia/client-common";
-var apiClientVersion = "5.23.3";
+var apiClientVersion = "5.24.0";
 function getDefaultHosts(appId) {
   return [
     {
@@ -1994,7 +2002,7 @@ function createSearchClient({
       return transporter.request(request, requestOptions);
     },
     /**
-     * Sends multiple search requests to one or more indices.  This can be useful in these cases:  - Different indices for different purposes, such as, one index for products, another one for marketing content. - Multiple searches to the same index—for example, with different filters.
+     * Sends multiple search requests to one or more indices.  This can be useful in these cases:  - Different indices for different purposes, such as, one index for products, another one for marketing content. - Multiple searches to the same index—for example, with different filters.  Use the helper `searchForHits` or `searchForFacets` to get the results in a more convenient format, if you already know the return type you want.
      *
      * Required API Key ACLs:
      *  - search
@@ -2385,6 +2393,91 @@ function searchClient(appId, apiKey, options) {
         createHmac("sha256", parentApiKey).update(queryParameters).digest("hex") + queryParameters
       ).toString("base64");
     },
+    /**
+     * Helper: Copies the given `sourceIndexName` records, rules and synonyms to an other Algolia application for the given `destinationIndexName`.
+     * See https://api-clients-automation.netlify.app/docs/add-new-api-client#5-helpers for implementation details.
+     *
+     * @summary Helper: Copies the given `sourceIndexName` records, rules and synonyms to an other Algolia application for the given `destinationIndexName`.
+     * @param accountCopyIndex - The `accountCopyIndex` object.
+     * @param accountCopyIndex.sourceIndexName - The name of the index to copy.
+     * @param accountCopyIndex.destinationAppID - The application ID to write the index to.
+     * @param accountCopyIndex.destinationApiKey - The API Key of the `destinationAppID` to write the index to, must have write ACLs.
+     * @param accountCopyIndex.destinationIndexName - The name of the index to write the copied index to.
+     * @param requestOptions - The requestOptions to send along with the query, they will be forwarded to the `setSettings`, `saveRules`, `saveSynonyms` and `saveObjects` method and merged with the transporter requestOptions.
+     */
+    async accountCopyIndex({ sourceIndexName, destinationAppID, destinationApiKey, destinationIndexName }, requestOptions) {
+      const responses = [];
+      if (this.appId === destinationAppID) {
+        throw new IndicesInSameAppError();
+      }
+      if (!await this.indexExists({ indexName: sourceIndexName })) {
+        throw new IndexNotFoundError(sourceIndexName);
+      }
+      const destinationClient = createSearchClient({
+        appId: destinationAppID,
+        apiKey: destinationApiKey,
+        timeouts: {
+          connect: 2e3,
+          read: 5e3,
+          write: 3e4
+        },
+        logger: createNullLogger(),
+        requester: createHttpRequester(),
+        algoliaAgents: [{ segment: "accountCopyIndex", version: process.versions.node }],
+        responsesCache: createNullCache(),
+        requestsCache: createNullCache(),
+        hostsCache: createMemoryCache(),
+        ...options
+      });
+      if (await destinationClient.indexExists({ indexName: destinationIndexName })) {
+        throw new IndexAlreadyExistsError(destinationIndexName);
+      }
+      responses.push(
+        await destinationClient.setSettings(
+          {
+            indexName: destinationIndexName,
+            indexSettings: await this.getSettings({ indexName: sourceIndexName })
+          },
+          requestOptions
+        )
+      );
+      await this.browseRules({
+        indexName: sourceIndexName,
+        async aggregator(response) {
+          responses.push(
+            await destinationClient.saveRules(
+              { indexName: destinationIndexName, rules: response.hits },
+              requestOptions
+            )
+          );
+        }
+      });
+      await this.browseSynonyms({
+        indexName: sourceIndexName,
+        async aggregator(response) {
+          responses.push(
+            await destinationClient.saveSynonyms(
+              { indexName: destinationIndexName, synonymHit: response.hits },
+              requestOptions
+            )
+          );
+        }
+      });
+      await this.browseObjects({
+        indexName: sourceIndexName,
+        async aggregator(response) {
+          responses.push(
+            ...await destinationClient.saveObjects(
+              { indexName: destinationIndexName, objects: response.hits },
+              requestOptions
+            )
+          );
+        }
+      });
+      for (const response of responses) {
+        await destinationClient.waitForTask({ indexName: destinationIndexName, taskID: response.taskID });
+      }
+    },
     /**
      * Helper: Retrieves the remaining validity of the previous generated `securedApiKey`, the `ValidUntil` parameter must have been provided.
      *