feat(javascript): add accountCopyIndex helper

specs/common/responses/IndexAlreadyExists.yml

@@ -0,0 +1,5 @@
+description: Destination index already exists.
+content:
+  application/json:
+    schema:
+      $ref: '../schemas/ErrorBase.yml'

specs/common/responses/IndexInSameApp.yml

@@ -0,0 +1,5 @@
+description: Indices are in the same application. Use operationIndex instead.
+content:
+  application/json:
+    schema:
+      $ref: '../schemas/ErrorBase.yml'

specs/search/helpers/accountCopyIndex.yml

@@ -0,0 +1,33 @@
+method:
+  post:
+    x-helper: true
+    tags:
+      - Account
+    operationId: accountCopyIndex
+    summary: Copies the index of an Algolia application, to an other Algolia application
+    description: |
+      Copies the index of an Algolia application, to an other Algolia application.
+    parameters:
+      - in: query
+        name: sourceIndexName
+        description: The name of the index to copy in the `sourceClient`.
+        required: true
+        schema:
+          type: string
+      - in: query
+        name: destinationClient
+        description: The already initialized search client with write ACL credentials, this is the application to copy the index to.
+        required: true
+        schema:
+          type: object
+      - in: query
+        name: destinationIndexName
+        description: The name of the index to write the copied index to in the `destinationClient`.
+        required: true
+        schema:
+          type: string
+    responses:
+      '400':
+        $ref: '../../common/responses/IndexInSameApp.yml'
+      '403':
+        $ref: '../../common/responses/IndexAlreadyExists.yml'

templates/javascript/clients/client/api/nodeHelpers.mustache

@@ -33,4 +33,78 @@ generateSecuredApiKey: ({
 
   const queryParameters = serializeQueryParameters(mergedRestrictions);
   return Buffer.from(createHmac('sha256', parentApiKey).update(queryParameters).digest('hex') + queryParameters,).toString('base64');
+},
+
+/**
+ * Helper: Copies the given `sourceIndexName` to the `destinationIndexName` of the `destinationClient`.
+ * See https://api-clients-automation.netlify.app/docs/add-new-api-client#5-helpers for implementation details.
+ *
+ * @summary Helper: Copies the given `sourceIndexName` to the `destinationIndexName` of the `destinationClient`.
+ * @param accountCopyIndex - The `accountCopyIndex` object.
+ * @param accountCopyIndex.sourceIndexName - The name of the index to copy
+ * @param accountCopyIndex.destinationClient - The already initialized search client with write ACL credentials, this is the application to copy the index to.
+ * @param accountCopyIndex.destinationIndexName - The name of the index to write the copied index to in the `destinationClient`.
+ * @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, destinationClient, destinationIndexName }: AccountCopyIndexOptions,
+  requestOptions?: RequestOptions,
+): Promise<void> {
+  const responses: Array<{ taskID: UpdatedAtResponse['taskID'] }> = [];
+
+  if (await destinationClient.indexExists({ indexName: sourceIndexName })) {
+    if (this.appId === destinationClient.appId) {
+      throw new AlgoliaError(
+        'Indices are in the same application. Use operationIndex instead.',
+        'IndexInSameApp',
+      );
+    }
+
+    throw new AlgoliaError('Destination index already exists.', 'IndexAlreadyExists');
+  }
+
+  responses.push(
+    await destinationClient.setSettings(
+      {
+        indexName: destinationIndexName,
+        indexSettings: await this.getSettings({ indexName: sourceIndexName }),
+      },
+      requestOptions,
+    ),
+  );
+
+  await this.browseRules({
+    indexName: sourceIndexName,
+    async aggregator(response: SearchRulesResponse) {
+      responses.push(
+        await destinationClient.saveRules({ indexName: destinationIndexName, rules: response.hits }, requestOptions),
+      );
+    },
+  });
+
+  await this.browseSynonyms({
+    indexName: sourceIndexName,
+    async aggregator(response: SearchSynonymsResponse) {
+      responses.push(
+        await destinationClient.saveSynonyms(
+          { indexName: destinationIndexName, synonymHit: response.hits },
+          requestOptions,
+        ),
+      );
+    },
+  });
+
+  await this.browseObjects({
+    indexName: sourceIndexName,
+    async aggregator(response: BrowseResponse) {
+      await destinationClient.saveObjects(
+        { indexName: destinationIndexName, objects: response.hits, waitForTasks: true },
+        requestOptions,
+      );
+    },
+  });
+
+  for (const response of responses) {
+    await destinationClient.waitForTask({ indexName: destinationIndexName, taskID: response.taskID });
+  }
 },

templates/javascript/clients/client/builds/definition.mustache

@@ -1,9 +1,9 @@
 import { createXhrRequester } from '@algolia/requester-browser-xhr';
 import { createHttpRequester } from '@algolia/requester-node-http';
 import { createFetchRequester } from '@algolia/requester-fetch';
-import { createNullLogger, createMemoryCache, createFallbackableCache, createBrowserLocalStorageCache, createNullCache, serializeQueryParameters } from '@algolia/client-common';
+import { AlgoliaError, createNullLogger, createMemoryCache, createFallbackableCache, createBrowserLocalStorageCache, createNullCache, serializeQueryParameters } from '@algolia/client-common';
 
-import type { ClientOptions } from '@algolia/client-common';
+import type { RequestOptions, ClientOptions } from '@algolia/client-common';
 
 import { create{{#lambda.titlecase}}{{clientName}}{{/lambda.titlecase}}, apiClientVersion } from '../src/{{#isCompositionFullClient}}compositionFullClient{{/isCompositionFullClient}}{{^isCompositionFullClient}}{{clientName}}{{/isCompositionFullClient}}';
 
@@ -28,7 +28,16 @@ export * from '../model';
 
 {{#isSearchClient}}
 {{^isAlgoliasearchClient}}
-import type { GenerateSecuredApiKeyOptions, GetSecuredApiKeyRemainingValidityOptions, SearchClientNodeHelpers } from '../model';
+import type { 
+  AccountCopyIndexOptions,
+  BrowseResponse,
+  GenerateSecuredApiKeyOptions,
+  GetSecuredApiKeyRemainingValidityOptions,
+  SearchClientNodeHelpers,
+  SearchRulesResponse,
+  SearchSynonymsResponse,
+  UpdatedAtResponse,
+} from '../model';
 {{/isAlgoliasearchClient}}
 {{/isSearchClient}}
 

templates/javascript/clients/client/model/clientMethodProps.mustache

@@ -14,6 +14,7 @@ import type { {{classname}} } from '{{filename}}';
 
 {{! Imports for the helpers method of the search client }}
 {{#isSearchClient}}
+import type { createSearchClient } from '../src/searchClient';
 import type { CreateIterablePromise } from '@algolia/client-common';
 {{/isSearchClient}}
 
@@ -127,9 +128,10 @@ export type GetSecuredApiKeyRemainingValidityOptions = {
 }
 
 export type SearchClientNodeHelpers = {
+  accountCopyIndex: (opts: AccountCopyIndexOptions) => Promise<void>;
   generateSecuredApiKey: (opts: GenerateSecuredApiKeyOptions) => string;
   getSecuredApiKeyRemainingValidity: (opts: GetSecuredApiKeyRemainingValidityOptions) => number;
-}
+};
 {{/isSearchClient}}
 
 export type DeleteObjectsOptions = Pick<ChunkedBatchOptions, 'indexName' | 'waitForTasks' | 'batchSize'> & {
@@ -187,6 +189,23 @@ export type ReplaceAllObjectsOptions = {
    */
   scopes?: Array<ScopeType>;
 }
+
+export type AccountCopyIndexOptions = {
+  /**
+   * The name of the index to copy to the `destinationClient`.
+   */
+  sourceIndexName: string;
+
+  /**
+   * The already initialized search client with write ACLs, this must target the application to copy the index to.
+   */
+  destinationClient: ReturnType<typeof createSearchClient>;
+
+  /**
+   * The name of the index to write the copy in.
+   */
+  destinationIndexName: string;
+};
 {{/isAlgoliasearchClient}}
 {{/isSearchClient}}
 {{#isCompositionFullClient}}