Skip to content

Commit dac3ea5

Browse files
algolia-botshortcuts
algolia-bot
and
shortcuts
committed
fix(javascript): assert helpers and fix setClientApiKey helper (generated)
algolia/api-clients-automation#3663 Co-authored-by: algolia-bot <[email protected]> Co-authored-by: Clément Vannicatte <[email protected]>
1 parent 8b24e5d commit dac3ea5

File tree

13 files changed

+102
-36
lines changed

13 files changed

+102
-36
lines changed

‎packages/algoliasearch/__tests__/algoliasearch.browser.test.ts‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,18 @@ describe('api', () => {
2020

2121
it('provides a `clearCache` method', () => {
2222
expect(client.clearCache).not.toBeUndefined();
23+
expect(() => client.clearCache()).not.toThrow();
24+
});
25+
26+
it('provides a `setClientApiKey` method', () => {
27+
const _client = algoliasearch('foo', 'bar', {
28+
requester: echoRequester(),
29+
});
30+
31+
expect(_client.transporter.baseQueryParameters['x-algolia-api-key']).toEqual('bar');
32+
expect(_client.setClientApiKey).not.toBeUndefined();
33+
_client.setClientApiKey({ apiKey: 'tabac' });
34+
expect(_client.transporter.baseQueryParameters['x-algolia-api-key']).toEqual('tabac');
2335
});
2436

2537
it('sets the user agent', async () => {

‎packages/algoliasearch/__tests__/algoliasearch.node.test.ts‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,18 @@ describe('api', () => {
2020

2121
it('provides a `clearCache` method', () => {
2222
expect(client.clearCache).not.toBeUndefined();
23+
expect(() => client.clearCache()).not.toThrow();
24+
});
25+
26+
it('provides a `setClientApiKey` method', () => {
27+
const _client = algoliasearch('foo', 'bar', {
28+
requester: echoRequester(),
29+
});
30+
31+
expect(_client.transporter.baseHeaders['x-algolia-api-key']).toEqual('bar');
32+
expect(_client.setClientApiKey).not.toBeUndefined();
33+
_client.setClientApiKey({ apiKey: 'tabac' });
34+
expect(_client.transporter.baseHeaders['x-algolia-api-key']).toEqual('tabac');
2335
});
2436

2537
it('sets the user agent', async () => {

‎packages/algoliasearch/lite/src/liteClient.ts‎

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -127,7 +127,11 @@ export function createLiteClient({
127127
* @param params.apiKey - The new API Key to use.
128128
*/
129129
setClientApiKey({ apiKey }: { apiKey: string }): void {
130-
this.transporter.baseHeaders['x-algolia-api-key'] = apiKey;
130+
if (!authMode || authMode === 'WithinHeaders') {
131+
this.transporter.baseHeaders['x-algolia-api-key'] = apiKey;
132+
} else {
133+
this.transporter.baseQueryParameters['x-algolia-api-key'] = apiKey;
134+
}
131135
},
132136
/**
133137
* Helper: calls the `search` method but with certainty that we will only request Algolia records (hits) and not facets.

‎packages/client-abtesting/src/abtestingClient.ts‎

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -107,7 +107,11 @@ export function createAbtestingClient({
107107
* @param params.apiKey - The new API Key to use.
108108
*/
109109
setClientApiKey({ apiKey }: { apiKey: string }): void {
110-
this.transporter.baseHeaders['x-algolia-api-key'] = apiKey;
110+
if (!authMode || authMode === 'WithinHeaders') {
111+
this.transporter.baseHeaders['x-algolia-api-key'] = apiKey;
112+
} else {
113+
this.transporter.baseQueryParameters['x-algolia-api-key'] = apiKey;
114+
}
111115
},
112116

113117
/**
@@ -351,10 +355,10 @@ export function createAbtestingClient({
351355
if (offset !== undefined) {
352356
queryParameters.offset = offset.toString();
353357
}
358+
354359
if (limit !== undefined) {
355360
queryParameters.limit = limit.toString();
356361
}
357-
358362
if (indexPrefix !== undefined) {
359363
queryParameters.indexPrefix = indexPrefix.toString();
360364
}

‎packages/client-analytics/src/analyticsClient.ts‎

Lines changed: 15 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -137,7 +137,11 @@ export function createAnalyticsClient({
137137
* @param params.apiKey - The new API Key to use.
138138
*/
139139
setClientApiKey({ apiKey }: { apiKey: string }): void {
140-
this.transporter.baseHeaders['x-algolia-api-key'] = apiKey;
140+
if (!authMode || authMode === 'WithinHeaders') {
141+
this.transporter.baseHeaders['x-algolia-api-key'] = apiKey;
142+
} else {
143+
this.transporter.baseQueryParameters['x-algolia-api-key'] = apiKey;
144+
}
141145
},
142146

143147
/**
@@ -288,9 +292,11 @@ export function createAnalyticsClient({
288292
if (index !== undefined) {
289293
queryParameters.index = index.toString();
290294
}
295+
291296
if (startDate !== undefined) {
292297
queryParameters.startDate = startDate.toString();
293298
}
299+
294300
if (endDate !== undefined) {
295301
queryParameters.endDate = endDate.toString();
296302
}
@@ -335,13 +341,13 @@ export function createAnalyticsClient({
335341
if (index !== undefined) {
336342
queryParameters.index = index.toString();
337343
}
338-
339344
if (startDate !== undefined) {
340345
queryParameters.startDate = startDate.toString();
341346
}
342347
if (endDate !== undefined) {
343348
queryParameters.endDate = endDate.toString();
344349
}
350+
345351
if (tags !== undefined) {
346352
queryParameters.tags = tags.toString();
347353
}
@@ -434,7 +440,6 @@ export function createAnalyticsClient({
434440
if (startDate !== undefined) {
435441
queryParameters.startDate = startDate.toString();
436442
}
437-
438443
if (endDate !== undefined) {
439444
queryParameters.endDate = endDate.toString();
440445
}
@@ -485,7 +490,6 @@ export function createAnalyticsClient({
485490
if (endDate !== undefined) {
486491
queryParameters.endDate = endDate.toString();
487492
}
488-
489493
if (tags !== undefined) {
490494
queryParameters.tags = tags.toString();
491495
}
@@ -527,6 +531,7 @@ export function createAnalyticsClient({
527531
if (index !== undefined) {
528532
queryParameters.index = index.toString();
529533
}
534+
530535
if (startDate !== undefined) {
531536
queryParameters.startDate = startDate.toString();
532537
}
@@ -574,13 +579,13 @@ export function createAnalyticsClient({
574579
if (index !== undefined) {
575580
queryParameters.index = index.toString();
576581
}
577-
578582
if (startDate !== undefined) {
579583
queryParameters.startDate = startDate.toString();
580584
}
581585
if (endDate !== undefined) {
582586
queryParameters.endDate = endDate.toString();
583587
}
588+
584589
if (tags !== undefined) {
585590
queryParameters.tags = tags.toString();
586591
}
@@ -622,7 +627,6 @@ export function createAnalyticsClient({
622627
if (index !== undefined) {
623628
queryParameters.index = index.toString();
624629
}
625-
626630
if (startDate !== undefined) {
627631
queryParameters.startDate = startDate.toString();
628632
}
@@ -674,7 +678,6 @@ export function createAnalyticsClient({
674678
if (startDate !== undefined) {
675679
queryParameters.startDate = startDate.toString();
676680
}
677-
678681
if (endDate !== undefined) {
679682
queryParameters.endDate = endDate.toString();
680683
}
@@ -768,16 +771,17 @@ export function createAnalyticsClient({
768771
if (index !== undefined) {
769772
queryParameters.index = index.toString();
770773
}
774+
771775
if (startDate !== undefined) {
772776
queryParameters.startDate = startDate.toString();
773777
}
774778
if (endDate !== undefined) {
775779
queryParameters.endDate = endDate.toString();
776780
}
781+
777782
if (limit !== undefined) {
778783
queryParameters.limit = limit.toString();
779784
}
780-
781785
if (offset !== undefined) {
782786
queryParameters.offset = offset.toString();
783787
}
@@ -827,10 +831,10 @@ export function createAnalyticsClient({
827831
if (startDate !== undefined) {
828832
queryParameters.startDate = startDate.toString();
829833
}
834+
830835
if (endDate !== undefined) {
831836
queryParameters.endDate = endDate.toString();
832837
}
833-
834838
if (limit !== undefined) {
835839
queryParameters.limit = limit.toString();
836840
}
@@ -916,6 +920,7 @@ export function createAnalyticsClient({
916920
if (startDate !== undefined) {
917921
queryParameters.startDate = startDate.toString();
918922
}
923+
919924
if (endDate !== undefined) {
920925
queryParameters.endDate = endDate.toString();
921926
}
@@ -975,7 +980,6 @@ export function createAnalyticsClient({
975980
if (startDate !== undefined) {
976981
queryParameters.startDate = startDate.toString();
977982
}
978-
979983
if (endDate !== undefined) {
980984
queryParameters.endDate = endDate.toString();
981985
}
@@ -1040,6 +1044,7 @@ export function createAnalyticsClient({
10401044
if (startDate !== undefined) {
10411045
queryParameters.startDate = startDate.toString();
10421046
}
1047+
10431048
if (endDate !== undefined) {
10441049
queryParameters.endDate = endDate.toString();
10451050
}

‎packages/client-insights/src/insightsClient.ts‎

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -100,7 +100,11 @@ export function createInsightsClient({
100100
* @param params.apiKey - The new API Key to use.
101101
*/
102102
setClientApiKey({ apiKey }: { apiKey: string }): void {
103-
this.transporter.baseHeaders['x-algolia-api-key'] = apiKey;
103+
if (!authMode || authMode === 'WithinHeaders') {
104+
this.transporter.baseHeaders['x-algolia-api-key'] = apiKey;
105+
} else {
106+
this.transporter.baseQueryParameters['x-algolia-api-key'] = apiKey;
107+
}
104108
},
105109

106110
/**

‎packages/client-personalization/src/personalizationClient.ts‎

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -103,7 +103,11 @@ export function createPersonalizationClient({
103103
* @param params.apiKey - The new API Key to use.
104104
*/
105105
setClientApiKey({ apiKey }: { apiKey: string }): void {
106-
this.transporter.baseHeaders['x-algolia-api-key'] = apiKey;
106+
if (!authMode || authMode === 'WithinHeaders') {
107+
this.transporter.baseHeaders['x-algolia-api-key'] = apiKey;
108+
} else {
109+
this.transporter.baseQueryParameters['x-algolia-api-key'] = apiKey;
110+
}
107111
},
108112

109113
/**

‎packages/client-query-suggestions/src/querySuggestionsClient.ts‎

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -107,7 +107,11 @@ export function createQuerySuggestionsClient({
107107
* @param params.apiKey - The new API Key to use.
108108
*/
109109
setClientApiKey({ apiKey }: { apiKey: string }): void {
110-
this.transporter.baseHeaders['x-algolia-api-key'] = apiKey;
110+
if (!authMode || authMode === 'WithinHeaders') {
111+
this.transporter.baseHeaders['x-algolia-api-key'] = apiKey;
112+
} else {
113+
this.transporter.baseQueryParameters['x-algolia-api-key'] = apiKey;
114+
}
111115
},
112116

113117
/**

‎packages/client-search/src/searchClient.ts‎

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -233,7 +233,11 @@ export function createSearchClient({
233233
* @param params.apiKey - The new API Key to use.
234234
*/
235235
setClientApiKey({ apiKey }: { apiKey: string }): void {
236-
this.transporter.baseHeaders['x-algolia-api-key'] = apiKey;
236+
if (!authMode || authMode === 'WithinHeaders') {
237+
this.transporter.baseHeaders['x-algolia-api-key'] = apiKey;
238+
} else {
239+
this.transporter.baseQueryParameters['x-algolia-api-key'] = apiKey;
240+
}
237241
},
238242

239243
/**
@@ -1410,7 +1414,6 @@ export function createSearchClient({
14101414
.replace('{objectID}', encodeURIComponent(objectID));
14111415
const headers: Headers = {};
14121416
const queryParameters: QueryParameters = {};
1413-
14141417
if (forwardToReplicas !== undefined) {
14151418
queryParameters.forwardToReplicas = forwardToReplicas.toString();
14161419
}
@@ -2065,6 +2068,7 @@ export function createSearchClient({
20652068
if (page !== undefined) {
20662069
queryParameters.page = page.toString();
20672070
}
2071+
20682072
if (hitsPerPage !== undefined) {
20692073
queryParameters.hitsPerPage = hitsPerPage.toString();
20702074
}
@@ -2188,6 +2192,7 @@ export function createSearchClient({
21882192
.replace('{objectID}', encodeURIComponent(objectID));
21892193
const headers: Headers = {};
21902194
const queryParameters: QueryParameters = {};
2195+
21912196
if (createIfNotExists !== undefined) {
21922197
queryParameters.createIfNotExists = createIfNotExists.toString();
21932198
}
@@ -2364,7 +2369,6 @@ export function createSearchClient({
23642369
.replace('{objectID}', encodeURIComponent(objectID));
23652370
const headers: Headers = {};
23662371
const queryParameters: QueryParameters = {};
2367-
23682372
if (forwardToReplicas !== undefined) {
23692373
queryParameters.forwardToReplicas = forwardToReplicas.toString();
23702374
}
@@ -2468,7 +2472,6 @@ export function createSearchClient({
24682472
.replace('{objectID}', encodeURIComponent(objectID));
24692473
const headers: Headers = {};
24702474
const queryParameters: QueryParameters = {};
2471-
24722475
if (forwardToReplicas !== undefined) {
24732476
queryParameters.forwardToReplicas = forwardToReplicas.toString();
24742477
}
@@ -2512,7 +2515,6 @@ export function createSearchClient({
25122515
const requestPath = '/1/indexes/{indexName}/synonyms/batch'.replace('{indexName}', encodeURIComponent(indexName));
25132516
const headers: Headers = {};
25142517
const queryParameters: QueryParameters = {};
2515-
25162518
if (forwardToReplicas !== undefined) {
25172519
queryParameters.forwardToReplicas = forwardToReplicas.toString();
25182520
}

‎packages/client-usage/src/usageClient.ts‎

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -94,7 +94,11 @@ export function createUsageClient({
9494
* @param params.apiKey - The new API Key to use.
9595
*/
9696
setClientApiKey({ apiKey }: { apiKey: string }): void {
97-
this.transporter.baseHeaders['x-algolia-api-key'] = apiKey;
97+
if (!authMode || authMode === 'WithinHeaders') {
98+
this.transporter.baseHeaders['x-algolia-api-key'] = apiKey;
99+
} else {
100+
this.transporter.baseQueryParameters['x-algolia-api-key'] = apiKey;
101+
}
98102
},
99103

100104
/**

0 commit comments

Comments
 (0)