fix(javascript): assert helpers and fix setClientApiKey helper (#3663)

Author: shortcuts

clients/algoliasearch-client-javascript/packages/algoliasearch/__tests__/algoliasearch.browser.test.ts

@@ -20,6 +20,18 @@ describe('api', () => {
 
   it('provides a `clearCache` method', () => {
     expect(client.clearCache).not.toBeUndefined();
+    expect(() => client.clearCache()).not.toThrow();
+  });
+
+  it('provides a `setClientApiKey` method', () => {
+      const _client = algoliasearch('foo', 'bar', {
+        requester: echoRequester(),
+      });
+
+    expect(_client.transporter.baseQueryParameters['x-algolia-api-key']).toEqual('bar')
+    expect(_client.setClientApiKey).not.toBeUndefined();
+    _client.setClientApiKey({apiKey:'tabac'})
+    expect(_client.transporter.baseQueryParameters['x-algolia-api-key']).toEqual('tabac')
   });
 
   it('sets the user agent', async () => {

clients/algoliasearch-client-javascript/packages/algoliasearch/__tests__/algoliasearch.node.test.ts

@@ -20,6 +20,18 @@ describe('api', () => {
 
   it('provides a `clearCache` method', () => {
     expect(client.clearCache).not.toBeUndefined();
+    expect(() => client.clearCache()).not.toThrow();
+  });
+
+  it('provides a `setClientApiKey` method', () => {
+      const _client = algoliasearch('foo', 'bar', {
+        requester: echoRequester(),
+      });
+
+    expect(_client.transporter.baseHeaders['x-algolia-api-key']).toEqual('bar')
+    expect(_client.setClientApiKey).not.toBeUndefined();
+    _client.setClientApiKey({apiKey:'tabac'})
+    expect(_client.transporter.baseHeaders['x-algolia-api-key']).toEqual('tabac')
   });
 
   it('sets the user agent', async () => {

templates/javascript/clients/api-single.mustache

@@ -75,13 +75,17 @@ export function create{{#lambda.titlecase}}{{apiName}}{{/lambda.titlecase}}({
     },
 
     /**
-    * 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.
-    */
+     * 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 {
-      this.transporter.baseHeaders['x-algolia-api-key'] = apiKey;
+      if (!authMode || authMode === 'WithinHeaders') {
+        this.transporter.baseHeaders['x-algolia-api-key'] = apiKey;
+      } else {
+        this.transporter.baseQueryParameters['x-algolia-api-key'] = apiKey;
+      }
     },
 
     {{#isSearchClient}}