algoliasearch 5.2.5 → 5.3.1

package/lite/src/liteClient.ts

@@ -22,7 +22,7 @@ import type { SearchMethodParams } from '../model/searchMethodParams';
 import type { SearchResponse } from '../model/searchResponse';
 import type { SearchResponses } from '../model/searchResponses';
 
-export const apiClientVersion = '5.2.5';
+export const apiClientVersion = '5.3.1';
 
 function getDefaultHosts(appId: string): Host[] {
   return (
@@ -68,27 +68,26 @@ export function createLiteClient({
   ...options
 }: CreateClientOptions) {
   const auth = createAuth(appIdOption, apiKeyOption, authMode);
-  const transporter = createTransporter({
-    hosts: getDefaultHosts(appIdOption),
-    ...options,
-    algoliaAgent: getAlgoliaAgent({
-      algoliaAgents,
-      client: 'Lite',
-      version: apiClientVersion,
-    }),
-    baseHeaders: {
-      'content-type': 'text/plain',
-      ...auth.headers(),
-      ...options.baseHeaders,
-    },
-    baseQueryParameters: {
-      ...auth.queryParameters(),
-      ...options.baseQueryParameters,
-    },
-  });
 
   return {
-    transporter,
+    transporter: createTransporter({
+      hosts: getDefaultHosts(appIdOption),
+      ...options,
+      algoliaAgent: getAlgoliaAgent({
+        algoliaAgents,
+        client: 'Lite',
+        version: apiClientVersion,
+      }),
+      baseHeaders: {
+        'content-type': 'text/plain',
+        ...auth.headers(),
+        ...options.baseHeaders,
+      },
+      baseQueryParameters: {
+        ...auth.queryParameters(),
+        ...options.baseQueryParameters,
+      },
+    }),
 
     /**
      * The `appId` currently in use.
@@ -99,14 +98,16 @@ export function createLiteClient({
      * Clears the cache of the transporter for the `requestsCache` and `responsesCache` properties.
      */
     clearCache(): Promise<void> {
-      return Promise.all([transporter.requestsCache.clear(), transporter.responsesCache.clear()]).then(() => undefined);
+      return Promise.all([this.transporter.requestsCache.clear(), this.transporter.responsesCache.clear()]).then(
+        () => undefined,
+      );
     },
 
     /**
      * Get the value of the `algoliaAgent`, used by our libraries internally and telemetry system.
      */
     get _ua(): string {
-      return transporter.algoliaAgent.value;
+      return this.transporter.algoliaAgent.value;
     },
 
     /**
@@ -116,7 +117,21 @@ export function createLiteClient({
      * @param version - The version of the agent.
      */
     addAlgoliaAgent(segment: string, version?: string): void {
-      transporter.algoliaAgent.add({ segment, version });
+      this.transporter.algoliaAgent.add({ segment, version });
+    },
+
+    /**
+     * Helper method to switch the API key used to authenticate the requests.
+     *
+     * @param params - Method params.
+     * @param params.apiKey - The new API Key to use.
+     */
+    setClientApiKey({ apiKey }: { apiKey: string }): void {
+      if (!authMode || authMode === 'WithinHeaders') {
+        this.transporter.baseHeaders['x-algolia-api-key'] = apiKey;
+      } else {
+        this.transporter.baseQueryParameters['x-algolia-api-key'] = apiKey;
+      }
     },
     /**
      * Helper: calls the `search` method but with certainty that we will only request Algolia records (hits) and not facets.
@@ -178,7 +193,7 @@ export function createLiteClient({
         data: body ? body : {},
       };
 
-      return transporter.request(request, requestOptions);
+      return this.transporter.request(request, requestOptions);
     },
 
     /**
@@ -225,7 +240,7 @@ export function createLiteClient({
         cacheable: true,
       };
 
-      return transporter.request(request, requestOptions);
+      return this.transporter.request(request, requestOptions);
     },
 
     /**
@@ -288,7 +303,7 @@ export function createLiteClient({
         cacheable: true,
       };
 
-      return transporter.request(request, requestOptions);
+      return this.transporter.request(request, requestOptions);
     },
   };
 }

package/package.json

@@ -1,5 +1,5 @@
 {
-  "version": "5.2.5",
+  "version": "5.3.1",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/algolia/algoliasearch-client-javascript.git"
@@ -65,14 +65,14 @@
     "lite.d.ts"
   ],
   "dependencies": {
-    "@algolia/client-abtesting": "5.2.5",
-    "@algolia/client-analytics": "5.2.5",
-    "@algolia/client-common": "5.2.5",
-    "@algolia/client-personalization": "5.2.5",
-    "@algolia/client-search": "5.2.5",
-    "@algolia/recommend": "5.2.5",
-    "@algolia/requester-browser-xhr": "5.2.5",
-    "@algolia/requester-node-http": "5.2.5"
+    "@algolia/client-abtesting": "5.3.1",
+    "@algolia/client-analytics": "5.3.1",
+    "@algolia/client-common": "5.3.1",
+    "@algolia/client-personalization": "5.3.1",
+    "@algolia/client-search": "5.3.1",
+    "@algolia/recommend": "5.3.1",
+    "@algolia/requester-browser-xhr": "5.3.1",
+    "@algolia/requester-node-http": "5.3.1"
   },
   "devDependencies": {
     "@arethetypeswrong/cli": "0.15.4",