feat(javascript): expose current apiKey on the client instance [skip-…

…bc] (generated) algolia/api-clients-automation#4285 Co-authored-by: algolia-bot <accounts+algolia-api-client-bot@algolia.com> Co-authored-by: Haroen Viaene <hello@haroen.me>
algolia · Dec 24, 2024 · 3df88c8 · 3df88c8
1 parent c8a275c
commit 3df88c8
Show file tree

Hide file tree

Showing 12 changed files with 59 additions and 0 deletions.
diff --git a/packages/algoliasearch/__tests__/algoliasearch.common.test.ts b/packages/algoliasearch/__tests__/algoliasearch.common.test.ts
@@ -20,6 +20,10 @@ describe('api', () => {
     expect(client.appId).toEqual('APP_ID');
   });
 
+  test('exposes the `apiKey` currently in use at the root of the API', () => {
+    expect(client.apiKey).toEqual('API_KEY');
+  });
+
   test('provides a `clearCache` method', () => {
     expect(client.clearCache).not.toBeUndefined();
     expect(() => client.clearCache()).not.toThrow();

diff --git a/packages/algoliasearch/lite/src/liteClient.ts b/packages/algoliasearch/lite/src/liteClient.ts
@@ -96,6 +96,11 @@ export function createLiteClient({
      */
     appId: appIdOption,
 
+    /**
+     * The `apiKey` currently in use.
+     */
+    apiKey: apiKeyOption,
+
     /**
      * Clears the cache of the transporter for the `requestsCache` and `responsesCache` properties.
      */

diff --git a/packages/client-abtesting/src/abtestingClient.ts b/packages/client-abtesting/src/abtestingClient.ts
@@ -79,6 +79,11 @@ export function createAbtestingClient({
      */
     appId: appIdOption,
 
+    /**
+     * The `apiKey` currently in use.
+     */
+    apiKey: apiKeyOption,
+
     /**
      * Clears the cache of the transporter for the `requestsCache` and `responsesCache` properties.
      */

diff --git a/packages/client-analytics/src/analyticsClient.ts b/packages/client-analytics/src/analyticsClient.ts
@@ -106,6 +106,11 @@ export function createAnalyticsClient({
      */
     appId: appIdOption,
 
+    /**
+     * The `apiKey` currently in use.
+     */
+    apiKey: apiKeyOption,
+
     /**
      * Clears the cache of the transporter for the `requestsCache` and `responsesCache` properties.
      */

diff --git a/packages/client-composition/src/compositionClient.ts b/packages/client-composition/src/compositionClient.ts
@@ -113,6 +113,11 @@ export function createCompositionClient({
      */
     appId: appIdOption,
 
+    /**
+     * The `apiKey` currently in use.
+     */
+    apiKey: apiKeyOption,
+
     /**
      * Clears the cache of the transporter for the `requestsCache` and `responsesCache` properties.
      */

diff --git a/packages/client-insights/src/insightsClient.ts b/packages/client-insights/src/insightsClient.ts
@@ -69,6 +69,11 @@ export function createInsightsClient({
      */
     appId: appIdOption,
 
+    /**
+     * The `apiKey` currently in use.
+     */
+    apiKey: apiKeyOption,
+
     /**
      * Clears the cache of the transporter for the `requestsCache` and `responsesCache` properties.
      */

diff --git a/packages/client-personalization/src/personalizationClient.ts b/packages/client-personalization/src/personalizationClient.ts
@@ -73,6 +73,11 @@ export function createPersonalizationClient({
      */
     appId: appIdOption,
 
+    /**
+     * The `apiKey` currently in use.
+     */
+    apiKey: apiKeyOption,
+
     /**
      * Clears the cache of the transporter for the `requestsCache` and `responsesCache` properties.
      */

diff --git a/packages/client-query-suggestions/src/querySuggestionsClient.ts b/packages/client-query-suggestions/src/querySuggestionsClient.ts
@@ -78,6 +78,11 @@ export function createQuerySuggestionsClient({
      */
     appId: appIdOption,
 
+    /**
+     * The `apiKey` currently in use.
+     */
+    apiKey: apiKeyOption,
+
     /**
      * Clears the cache of the transporter for the `requestsCache` and `responsesCache` properties.
      */

diff --git a/packages/client-search/src/searchClient.ts b/packages/client-search/src/searchClient.ts
@@ -214,6 +214,11 @@ export function createSearchClient({
      */
     appId: appIdOption,
 
+    /**
+     * The `apiKey` currently in use.
+     */
+    apiKey: apiKeyOption,
+
     /**
      * Clears the cache of the transporter for the `requestsCache` and `responsesCache` properties.
      */

diff --git a/packages/ingestion/src/ingestionClient.ts b/packages/ingestion/src/ingestionClient.ts
@@ -196,6 +196,11 @@ export function createIngestionClient({
      */
     appId: appIdOption,
 
+    /**
+     * The `apiKey` currently in use.
+     */
+    apiKey: apiKeyOption,
+
     /**
      * Clears the cache of the transporter for the `requestsCache` and `responsesCache` properties.
      */

diff --git a/packages/monitoring/src/monitoringClient.ts b/packages/monitoring/src/monitoringClient.ts
@@ -72,6 +72,11 @@ export function createMonitoringClient({
      */
     appId: appIdOption,
 
+    /**
+     * The `apiKey` currently in use.
+     */
+    apiKey: apiKeyOption,
+
     /**
      * Clears the cache of the transporter for the `requestsCache` and `responsesCache` properties.
      */

diff --git a/packages/recommend/src/recommendClient.ts b/packages/recommend/src/recommendClient.ts
@@ -106,6 +106,11 @@ export function createRecommendClient({
      */
     appId: appIdOption,
 
+    /**
+     * The `apiKey` currently in use.
+     */
+    apiKey: apiKeyOption,
+
     /**
      * Clears the cache of the transporter for the `requestsCache` and `responsesCache` properties.
      */