chore: generated code for commit 7bb3928. [skip ci]

Co-authored-by: Clément Vannicatte <[email protected]>

Author: algolia-bot

Diff for: clients/algoliasearch-client-javascript/packages/algoliasearch/builds/browser.ts

@@ -63,13 +63,15 @@ export function algoliasearch(
     throw new Error('`apiKey` is missing.');
   }
 
-  const commonOptions: Omit<CreateClientOptions, 'apiKey' | 'appId'> = {
+  const commonOptions: CreateClientOptions = {
+    apiKey,
+    appId,
     timeouts: {
       connect: DEFAULT_CONNECT_TIMEOUT_BROWSER,
       read: DEFAULT_READ_TIMEOUT_BROWSER,
       write: DEFAULT_WRITE_TIMEOUT_BROWSER,
     },
-    requester: options?.requester ?? createXhrRequester(),
+    requester: createXhrRequester(),
     algoliaAgents: [{ segment: 'Browser' }],
     authMode: 'WithinQueryParameters',
     responsesCache: createMemoryCache(),
@@ -99,11 +101,9 @@ export function algoliasearch(
     }
 
     return createAnalyticsClient({
-      ...initOptions.options,
       ...commonOptions,
-      appId: initOptions.appId ?? appId,
-      apiKey: initOptions.apiKey ?? apiKey,
-      region: initOptions.region,
+      ...initOptions.options,
+      ...initOptions,
     });
   }
 
@@ -123,11 +123,9 @@ export function algoliasearch(
     }
 
     return createAbtestingClient({
-      ...initOptions.options,
       ...commonOptions,
-      appId: initOptions.appId ?? appId,
-      apiKey: initOptions.apiKey ?? apiKey,
-      region: initOptions.region,
+      ...initOptions.options,
+      ...initOptions,
     });
   }
 
@@ -151,16 +149,20 @@ export function algoliasearch(
     }
 
     return createPersonalizationClient({
-      ...initOptions.options,
       ...commonOptions,
-      appId: initOptions.appId ?? appId,
-      apiKey: initOptions.apiKey ?? apiKey,
-      region: initOptions.region,
+      ...initOptions.options,
+      ...initOptions,
     });
   }
 
   return {
-    ...createSearchClient({ appId, apiKey, ...commonOptions }),
+    ...createSearchClient(commonOptions),
+    /**
+     * Get the value of the `algoliaAgent`, used by our libraries internally and telemetry system.
+     */
+    get _ua(): string {
+      return this.transporter.algoliaAgent.value;
+    },
     initAnalytics,
     initPersonalization,
     initAbtesting,

Diff for: clients/algoliasearch-client-javascript/packages/algoliasearch/builds/node.ts

@@ -62,13 +62,15 @@ export function algoliasearch(
     throw new Error('`apiKey` is missing.');
   }
 
-  const commonOptions: Omit<CreateClientOptions, 'apiKey' | 'appId'> = {
+  const commonOptions: CreateClientOptions = {
+    apiKey,
+    appId,
     timeouts: {
       connect: DEFAULT_CONNECT_TIMEOUT_NODE,
       read: DEFAULT_READ_TIMEOUT_NODE,
       write: DEFAULT_WRITE_TIMEOUT_NODE,
     },
-    requester: options?.requester ?? createHttpRequester(),
+    requester: createHttpRequester(),
     algoliaAgents: [{ segment: 'Node.js', version: process.versions.node }],
     responsesCache: createNullCache(),
     requestsCache: createNullCache(),
@@ -92,11 +94,9 @@ export function algoliasearch(
     }
 
     return createAnalyticsClient({
-      ...initOptions.options,
       ...commonOptions,
-      appId: initOptions.appId ?? appId,
-      apiKey: initOptions.apiKey ?? apiKey,
-      region: initOptions.region,
+      ...initOptions.options,
+      ...initOptions,
     });
   }
 
@@ -116,11 +116,9 @@ export function algoliasearch(
     }
 
     return createAbtestingClient({
-      ...initOptions.options,
       ...commonOptions,
-      appId: initOptions.appId ?? appId,
-      apiKey: initOptions.apiKey ?? apiKey,
-      region: initOptions.region,
+      ...initOptions.options,
+      ...initOptions,
     });
   }
 
@@ -144,16 +142,20 @@ export function algoliasearch(
     }
 
     return createPersonalizationClient({
-      ...initOptions.options,
       ...commonOptions,
-      appId: initOptions.appId ?? appId,
-      apiKey: initOptions.apiKey ?? apiKey,
-      region: initOptions.region,
+      ...initOptions.options,
+      ...initOptions,
     });
   }
 
   return {
-    ...createSearchClient({ appId, apiKey, ...commonOptions }),
+    ...createSearchClient(commonOptions),
+    /**
+     * Get the value of the `algoliaAgent`, used by our libraries internally and telemetry system.
+     */
+    get _ua(): string {
+      return this.transporter.algoliaAgent.value;
+    },
     initAnalytics,
     initPersonalization,
     initAbtesting,

Diff for: clients/algoliasearch-client-javascript/packages/algoliasearch/lite/src/liteClient.ts

@@ -85,12 +85,23 @@ export function createLiteClient({
     },
   });
 
-  function addAlgoliaAgent(segment: string, version?: string): void {
-    transporter.algoliaAgent.add({ segment, version });
-  }
-
   return {
-    addAlgoliaAgent,
+    transporter,
+    /**
+     * Get the value of the `algoliaAgent`, used by our libraries internally and telemetry system.
+     */
+    get _ua(): string {
+      return transporter.algoliaAgent.value;
+    },
+    /**
+     * Adds a `segment` to the `x-algolia-agent` sent with every requests.
+     *
+     * @param segment - The algolia agent (user-agent) segment to add.
+     * @param version - The version of the agent.
+     */
+    addAlgoliaAgent(segment: string, version?: string): void {
+      transporter.algoliaAgent.add({ segment, version });
+    },
     /**
      * This method allow you to send requests to the Algolia REST API.
      *

Diff for: clients/algoliasearch-client-javascript/packages/client-abtesting/src/abtestingClient.ts

@@ -69,12 +69,23 @@ export function createAbtestingClient({
     },
   });
 
-  function addAlgoliaAgent(segment: string, version?: string): void {
-    transporter.algoliaAgent.add({ segment, version });
-  }
-
   return {
-    addAlgoliaAgent,
+    transporter,
+    /**
+     * Get the value of the `algoliaAgent`, used by our libraries internally and telemetry system.
+     */
+    get _ua(): string {
+      return transporter.algoliaAgent.value;
+    },
+    /**
+     * Adds a `segment` to the `x-algolia-agent` sent with every requests.
+     *
+     * @param segment - The algolia agent (user-agent) segment to add.
+     * @param version - The version of the agent.
+     */
+    addAlgoliaAgent(segment: string, version?: string): void {
+      transporter.algoliaAgent.add({ segment, version });
+    },
     /**
      * Creates a new A/B test with provided configuration. You can set an A/B test on two different indices with different settings, or on the same index with different search parameters by providing a customSearchParameters setting on one of the variants.
      *

Diff for: clients/algoliasearch-client-javascript/packages/client-analytics/src/analyticsClient.ts

@@ -95,12 +95,23 @@ export function createAnalyticsClient({
     },
   });
 
-  function addAlgoliaAgent(segment: string, version?: string): void {
-    transporter.algoliaAgent.add({ segment, version });
-  }
-
   return {
-    addAlgoliaAgent,
+    transporter,
+    /**
+     * Get the value of the `algoliaAgent`, used by our libraries internally and telemetry system.
+     */
+    get _ua(): string {
+      return transporter.algoliaAgent.value;
+    },
+    /**
+     * Adds a `segment` to the `x-algolia-agent` sent with every requests.
+     *
+     * @param segment - The algolia agent (user-agent) segment to add.
+     * @param version - The version of the agent.
+     */
+    addAlgoliaAgent(segment: string, version?: string): void {
+      transporter.algoliaAgent.add({ segment, version });
+    },
     /**
      * This method allow you to send requests to the Algolia REST API.
      *

Diff for: clients/algoliasearch-client-javascript/packages/client-insights/src/insightsClient.ts

@@ -63,12 +63,23 @@ export function createInsightsClient({
     },
   });
 
-  function addAlgoliaAgent(segment: string, version?: string): void {
-    transporter.algoliaAgent.add({ segment, version });
-  }
-
   return {
-    addAlgoliaAgent,
+    transporter,
+    /**
+     * Get the value of the `algoliaAgent`, used by our libraries internally and telemetry system.
+     */
+    get _ua(): string {
+      return transporter.algoliaAgent.value;
+    },
+    /**
+     * Adds a `segment` to the `x-algolia-agent` sent with every requests.
+     *
+     * @param segment - The algolia agent (user-agent) segment to add.
+     * @param version - The version of the agent.
+     */
+    addAlgoliaAgent(segment: string, version?: string): void {
+      transporter.algoliaAgent.add({ segment, version });
+    },
     /**
      * This method allow you to send requests to the Algolia REST API.
      *

Diff for: clients/algoliasearch-client-javascript/packages/client-personalization/src/personalizationClient.ts

@@ -68,12 +68,23 @@ export function createPersonalizationClient({
     },
   });
 
-  function addAlgoliaAgent(segment: string, version?: string): void {
-    transporter.algoliaAgent.add({ segment, version });
-  }
-
   return {
-    addAlgoliaAgent,
+    transporter,
+    /**
+     * Get the value of the `algoliaAgent`, used by our libraries internally and telemetry system.
+     */
+    get _ua(): string {
+      return transporter.algoliaAgent.value;
+    },
+    /**
+     * Adds a `segment` to the `x-algolia-agent` sent with every requests.
+     *
+     * @param segment - The algolia agent (user-agent) segment to add.
+     * @param version - The version of the agent.
+     */
+    addAlgoliaAgent(segment: string, version?: string): void {
+      transporter.algoliaAgent.add({ segment, version });
+    },
     /**
      * This method allow you to send requests to the Algolia REST API.
      *

Diff for: clients/algoliasearch-client-javascript/packages/client-query-suggestions/src/querySuggestionsClient.ts

@@ -72,12 +72,23 @@ export function createQuerySuggestionsClient({
     },
   });
 
-  function addAlgoliaAgent(segment: string, version?: string): void {
-    transporter.algoliaAgent.add({ segment, version });
-  }
-
   return {
-    addAlgoliaAgent,
+    transporter,
+    /**
+     * Get the value of the `algoliaAgent`, used by our libraries internally and telemetry system.
+     */
+    get _ua(): string {
+      return transporter.algoliaAgent.value;
+    },
+    /**
+     * Adds a `segment` to the `x-algolia-agent` sent with every requests.
+     *
+     * @param segment - The algolia agent (user-agent) segment to add.
+     * @param version - The version of the agent.
+     */
+    addAlgoliaAgent(segment: string, version?: string): void {
+      transporter.algoliaAgent.add({ segment, version });
+    },
     /**
      * Create a configuration of a Query Suggestions index. There\'s a limit of 100 configurations per application.
      *

Diff for: clients/algoliasearch-client-javascript/packages/client-search/src/searchClient.ts

@@ -179,12 +179,23 @@ export function createSearchClient({
     },
   });
 
-  function addAlgoliaAgent(segment: string, version?: string): void {
-    transporter.algoliaAgent.add({ segment, version });
-  }
-
   return {
-    addAlgoliaAgent,
+    transporter,
+    /**
+     * Get the value of the `algoliaAgent`, used by our libraries internally and telemetry system.
+     */
+    get _ua(): string {
+      return transporter.algoliaAgent.value;
+    },
+    /**
+     * Adds a `segment` to the `x-algolia-agent` sent with every requests.
+     *
+     * @param segment - The algolia agent (user-agent) segment to add.
+     * @param version - The version of the agent.
+     */
+    addAlgoliaAgent(segment: string, version?: string): void {
+      transporter.algoliaAgent.add({ segment, version });
+    },
     /**
      * Helper: Wait for a task to complete with `indexName` and `taskID`.
      *

Diff for: clients/algoliasearch-client-javascript/packages/client-sources/src/sourcesClient.ts

@@ -61,12 +61,23 @@ export function createSourcesClient({
     },
   });
 
-  function addAlgoliaAgent(segment: string, version?: string): void {
-    transporter.algoliaAgent.add({ segment, version });
-  }
-
   return {
-    addAlgoliaAgent,
+    transporter,
+    /**
+     * Get the value of the `algoliaAgent`, used by our libraries internally and telemetry system.
+     */
+    get _ua(): string {
+      return transporter.algoliaAgent.value;
+    },
+    /**
+     * Adds a `segment` to the `x-algolia-agent` sent with every requests.
+     *
+     * @param segment - The algolia agent (user-agent) segment to add.
+     * @param version - The version of the agent.
+     */
+    addAlgoliaAgent(segment: string, version?: string): void {
+      transporter.algoliaAgent.add({ segment, version });
+    },
     /**
      * This method allow you to send requests to the Algolia REST API.
      *