feat(clients): add helper to check if an index exists (generated)

algolia/api-clients-automation#3646

Co-authored-by: algolia-bot <[email protected]>
Co-authored-by: Pierre Millot <[email protected]>
Co-authored-by: Thomas Raffray <[email protected]>

Author: 3 people

packages/client-search/src/searchClient.ts

@@ -1,14 +1,20 @@
 // Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
 
-import { createAuth, createTransporter, getAlgoliaAgent, shuffle, createIterablePromise } from '@algolia/client-common';
+import {
+  createAuth,
+  createTransporter,
+  getAlgoliaAgent,
+  shuffle,
+  ApiError,
+  createIterablePromise,
+} from '@algolia/client-common';
 import type {
   CreateClientOptions,
   Headers,
   Host,
   QueryParameters,
   Request,
   RequestOptions,
-  ApiError,
   IterableOptions,
 } from '@algolia/client-common';
 
@@ -643,6 +649,19 @@ export function createSearchClient({
       return { copyOperationResponse, batchResponses, moveOperationResponse };
     },
 
+    async indexExists({ indexName }: GetSettingsProps): Promise<boolean> {
+      try {
+        await this.getSettings({ indexName });
+      } catch (error) {
+        if (error instanceof ApiError && error.status === 404) {
+          return false;
+        }
+        throw error;
+      }
+
+      return true;
+    },
+
     /**
      * 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.
@@ -1045,7 +1064,6 @@ export function createSearchClient({
       const requestPath = '/1/indexes/{indexName}/rules/clear'.replace('{indexName}', encodeURIComponent(indexName));
       const headers: Headers = {};
       const queryParameters: QueryParameters = {};
-
       if (forwardToReplicas !== undefined) {
         queryParameters.forwardToReplicas = forwardToReplicas.toString();
       }
@@ -1082,7 +1100,6 @@ export function createSearchClient({
       const requestPath = '/1/indexes/{indexName}/synonyms/clear'.replace('{indexName}', encodeURIComponent(indexName));
       const headers: Headers = {};
       const queryParameters: QueryParameters = {};
-
       if (forwardToReplicas !== undefined) {
         queryParameters.forwardToReplicas = forwardToReplicas.toString();
       }
@@ -1454,6 +1471,7 @@ export function createSearchClient({
         .replace('{objectID}', encodeURIComponent(objectID));
       const headers: Headers = {};
       const queryParameters: QueryParameters = {};
+
       if (forwardToReplicas !== undefined) {
         queryParameters.forwardToReplicas = forwardToReplicas.toString();
       }
@@ -1595,7 +1613,6 @@ export function createSearchClient({
       if (length !== undefined) {
         queryParameters.length = length.toString();
       }
-
       if (indexName !== undefined) {
         queryParameters.indexName = indexName.toString();
       }
@@ -1642,6 +1659,7 @@ export function createSearchClient({
         .replace('{objectID}', encodeURIComponent(objectID));
       const headers: Headers = {};
       const queryParameters: QueryParameters = {};
+
       if (attributesToRetrieve !== undefined) {
         queryParameters.attributesToRetrieve = attributesToRetrieve.toString();
       }
@@ -2381,10 +2399,10 @@ export function createSearchClient({
       const requestPath = '/1/indexes/{indexName}/rules/batch'.replace('{indexName}', encodeURIComponent(indexName));
       const headers: Headers = {};
       const queryParameters: QueryParameters = {};
+
       if (forwardToReplicas !== undefined) {
         queryParameters.forwardToReplicas = forwardToReplicas.toString();
       }
-
       if (clearExistingRules !== undefined) {
         queryParameters.clearExistingRules = clearExistingRules.toString();
       }
@@ -2487,7 +2505,6 @@ export function createSearchClient({
       if (forwardToReplicas !== undefined) {
         queryParameters.forwardToReplicas = forwardToReplicas.toString();
       }
-
       if (replaceExistingSynonyms !== undefined) {
         queryParameters.replaceExistingSynonyms = replaceExistingSynonyms.toString();
       }