Skip to content

feat(specs): default authMode to WithinHeaders for Composition Client #4129

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Nov 18, 2024
Merged

feat(specs): default authMode to WithinHeaders for Composition Client #4129

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
385d320
feat(specs): default authMode to WithinHeaders for Composition Client
e-krebs Nov 18, 2024
98eb49e
fix: variable name consistency
shortcuts Nov 18, 2024
0e97d38
Merge branch 'main' into feat/composition-default-authmode
shortcuts Nov 18, 2024
File filter

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 1 addition & 2 deletions generators/src/main/java/com/algolia/codegen/AlgoliaJavascriptGenerator.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -154,10 +154,9 @@ private void setDefaultGeneratorOptions() {
additionalProperties.put("apiName", CLIENT);
additionalProperties.put("clientName", clientName);
additionalProperties.put("algoliaAgent", Helpers.capitalize(CLIENT));
additionalProperties.put("is" + Helpers.capitalize(CLIENT) + "Client", true);
additionalProperties.put("isSearchClient", CLIENT.equals("search") || isAlgoliasearchClient);
additionalProperties.put("isIngestionClient", CLIENT.equals("ingestion"));
additionalProperties.put("isAlgoliasearchClient", isAlgoliasearchClient);
additionalProperties.put("isAlgoliaCompositionClient", isAlgoliaCompositionClient);
additionalProperties.put("packageVersion", Helpers.getPackageJsonVersion(packageName));
additionalProperties.put("packageName", packageName);
additionalProperties.put("npmPackageName", isAlgoliasearchClient ? packageName : "@algolia/" + packageName);
Expand Down
4 changes: 2 additions & 2 deletions templates/javascript/clients/api-single.mustache
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -91,9 +91,9 @@ export function create{{#lambda.titlecase}}{{clientName}}{{/lambda.titlecase}}({
{{#isSearchClient}}
{{> client/api/helpers}}
{{/isSearchClient}}
{{#isAlgoliaCompositionClient}}
{{#isCompositionClient}}
{{> client/api/compositionHelpers}}
{{/isAlgoliaCompositionClient}}
{{/isCompositionClient}}
{{#operation}}
{{> client/api/operation/jsdoc}}
{{nickname}}{{#vendorExtensions.x-is-generic}}<T>{{/vendorExtensions.x-is-generic}}( {{> client/api/operation/parameters}} ) : Promise<{{#returnType}}{{{returnType}}}{{/returnType}}{{^returnType}}void{{/returnType}}{{#vendorExtensions.x-is-generic}}<T>{{/vendorExtensions.x-is-generic}}> {
Expand Down
8 changes: 4 additions & 4 deletions templates/javascript/clients/client/api/imports.mustache
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,9 @@ import {
serializeQueryParameters,
createIterablePromise,
{{/isSearchClient}}
{{#isAlgoliaCompositionClient}}
{{#isCompositionClient}}
createIterablePromise,
{{/isAlgoliaCompositionClient}}
{{/isCompositionClient}}
} from '@algolia/client-common';
import type {
CreateClientOptions,
Expand Down Expand Up @@ -42,9 +42,9 @@ import type {
WaitForAppTaskOptions,
WaitForTaskOptions,
{{/isSearchClient}}
{{#isAlgoliaCompositionClient}}
{{#isCompositionClient}}
WaitForCompositionTaskOptions,
{{/isAlgoliaCompositionClient}}
{{/isCompositionClient}}
{{#operation}}
{{#vendorExtensions}}
{{#x-create-wrapping-object}}
Expand Down
2 changes: 1 addition & 1 deletion templates/javascript/clients/client/builds/browser.mustache
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
logger: createNullLogger(),
requester: createXhrRequester(),
algoliaAgents: [{ segment: 'Browser' }],
authMode: 'WithinQueryParameters',
authMode: 'Within{{#isCompositionClient}}Headers{{/isCompositionClient}}{{^isCompositionClient}}QueryParameters{{/isCompositionClient}}',
responsesCache: createMemoryCache(),
requestsCache: createMemoryCache({ serializable: false }),
hostsCache: createFallbackableCache({
Expand Down
4 changes: 2 additions & 2 deletions templates/javascript/clients/client/model/clientMethodProps.mustache
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -184,7 +184,7 @@ export type ReplaceAllObjectsOptions = {
}
{{/isAlgoliasearchClient}}
{{/isSearchClient}}
{{#isAlgoliaCompositionClient}}
{{#isCompositionClient}}
export type WaitForCompositionTaskOptions = {
/**
* The maximum number of retries. 50 by default.
Expand All @@ -206,6 +206,6 @@ export type WaitForCompositionTaskOptions = {
*/
compositionID: string;
};
{{/isAlgoliaCompositionClient}}
{{/isCompositionClient}}

{{/apiInfo.apis.0}}
Loading