Skip to content

Commit 7ab269c

Browse files
shortcutsshortcuts
committed
fix: generator naming
1 parent a6b5238 commit 7ab269c

File tree

12 files changed

+29
-27
lines changed

12 files changed

+29
-27
lines changed

‎clients/algoliasearch-client-javascript/README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ import { liteClient } from 'algoliasearch/lite';
6767
const client = liteClient('YOUR_APP_ID', 'YOUR_API_KEY');
6868
```
6969

70-
For full documentation, visit the **[Algolia JavaScript API Client](https://www.algolia.com/doc/libraries/javascript/)**.
70+
For full documentation, visit the **[Algolia JavaScript API Client](https://www.algolia.com/doc/libraries/javascript/v5/methods/search/)**.
7171

7272
## ❓ Troubleshooting
7373

‎generators/src/main/java/com/algolia/codegen/AlgoliaJavascriptGenerator.java‎

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -148,10 +148,11 @@ public static String getPackageName(String client) throws ConfigException {
148148

149149
/** Set default generator options */
150150
private void setDefaultGeneratorOptions() {
151-
String apiName = CLIENT + Helpers.API_SUFFIX;
151+
String clientName = CLIENT + Helpers.API_SUFFIX;
152152
String packageName = getPackageName((String) additionalProperties.get("client"));
153153

154-
additionalProperties.put("apiName", apiName);
154+
additionalProperties.put("apiName", CLIENT);
155+
additionalProperties.put("clientName", clientName);
155156
additionalProperties.put("algoliaAgent", Helpers.capitalize(CLIENT));
156157
additionalProperties.put("isSearchClient", CLIENT.equals("search") || isAlgoliasearchClient);
157158
additionalProperties.put("isIngestionClient", CLIENT.equals("ingestion"));
@@ -170,8 +171,9 @@ private void setDefaultGeneratorOptions() {
170171
additionalProperties.put("recommendVersion", Helpers.getPackageJsonVersion("recommend"));
171172

172173
// Files used to generate the `lite` client
173-
apiName = "lite" + Helpers.API_SUFFIX;
174-
additionalProperties.put("apiName", apiName);
174+
clientName = "lite" + Helpers.API_SUFFIX;
175+
additionalProperties.put("apiName", "search");
176+
additionalProperties.put("clientName", clientName);
175177
additionalProperties.put("algoliaAgent", "Lite");
176178
}
177179
}

‎templates/javascript/clients/README.mustache‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -63,23 +63,23 @@ You can now import the Algolia API client in your project and play with it.
6363

6464
```js
6565
{{^isAlgoliasearchClient}}
66-
import { {{apiName}} } from '{{npmPackageName}}';
66+
import { {{clientName}} } from '{{npmPackageName}}';
6767

68-
const client = {{apiName}}('YOUR_APP_ID', 'YOUR_API_KEY');
68+
const client = {{clientName}}('YOUR_APP_ID', 'YOUR_API_KEY');
6969
{{/isAlgoliasearchClient}}
7070
{{#isAlgoliasearchClient}}
7171
import { algoliasearch } from '{{npmPackageName}}';
7272

7373
const client = algoliasearch('YOUR_APP_ID', 'YOUR_API_KEY');
7474

7575
// or with the lite client
76-
import { {{apiName}} } from '{{npmPackageName}}/lite';
76+
import { {{clientName}} } from '{{npmPackageName}}/lite';
7777

78-
const client = {{apiName}}('YOUR_APP_ID', 'YOUR_API_KEY');
78+
const client = {{clientName}}('YOUR_APP_ID', 'YOUR_API_KEY');
7979
{{/isAlgoliasearchClient}}
8080
```
8181

82-
For full documentation, visit the **[Algolia JavaScript API Client](https://www.algolia.com/doc/libraries/javascript/)**.
82+
For full documentation, visit the **[Algolia JavaScript API Client](https://www.algolia.com/doc/libraries/javascript/v5/methods/{{apiName}}/)**.
8383

8484
## ❓ Troubleshooting
8585

‎templates/javascript/clients/api-single.mustache‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ export const apiClientVersion = '{{packageVersion}}';
1313
{{/isIngestionClient}}
1414

1515
// eslint-disable-next-line @typescript-eslint/explicit-function-return-type
16-
export function create{{#lambda.titlecase}}{{apiName}}{{/lambda.titlecase}}({
16+
export function create{{#lambda.titlecase}}{{clientName}}{{/lambda.titlecase}}({
1717
appId: appIdOption,
1818
apiKey: apiKeyOption,
1919
authMode,

‎templates/javascript/clients/client/builds/browser.mustache‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
// {{{generationBanner}}}
22

3-
export type {{#lambda.titlecase}}{{apiName}}{{/lambda.titlecase}} = ReturnType<typeof create{{#lambda.titlecase}}{{apiName}}{{/lambda.titlecase}}>;
3+
export type {{#lambda.titlecase}}{{clientName}}{{/lambda.titlecase}} = ReturnType<typeof create{{#lambda.titlecase}}{{clientName}}{{/lambda.titlecase}}>;
44

55
{{> client/builds/definition}}
6-
return create{{#lambda.titlecase}}{{apiName}}{{/lambda.titlecase}}({
6+
return create{{#lambda.titlecase}}{{clientName}}{{/lambda.titlecase}}({
77
appId,
88
apiKey,{{#hasRegionalHost}}region,{{/hasRegionalHost}}
99
timeouts: {

‎templates/javascript/clients/client/builds/definition.mustache‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,10 @@ import { createHttpRequester } from '@algolia/requester-node-http';
33
import { createFetchRequester } from '@algolia/requester-fetch';
44
import { createNullLogger, createMemoryCache, createFallbackableCache, createBrowserLocalStorageCache, createNullCache, ClientOptions, serializeQueryParameters, DEFAULT_CONNECT_TIMEOUT_NODE, DEFAULT_READ_TIMEOUT_NODE, DEFAULT_WRITE_TIMEOUT_NODE, DEFAULT_CONNECT_TIMEOUT_BROWSER, DEFAULT_READ_TIMEOUT_BROWSER, DEFAULT_WRITE_TIMEOUT_BROWSER } from '@algolia/client-common';
55

6-
import { create{{#lambda.titlecase}}{{apiName}}{{/lambda.titlecase}}, apiClientVersion } from '../src/{{apiName}}';
6+
import { create{{#lambda.titlecase}}{{clientName}}{{/lambda.titlecase}}, apiClientVersion } from '../src/{{clientName}}';
77

88
{{#hasRegionalHost}}
9-
import { Region, REGIONS } from '../src/{{apiName}}';
9+
import { Region, REGIONS } from '../src/{{clientName}}';
1010
{{/hasRegionalHost}}
1111

1212
{{! We don't use `export *` to prevent exposing the factory, to avoid confusion for the user }}
@@ -20,7 +20,7 @@ export {
2020
isScheduleTrigger,
2121
isSubscriptionTrigger,
2222
{{/isIngestionClient}}
23-
} from '../src/{{apiName}}';
23+
} from '../src/{{clientName}}';
2424
export * from '../model';
2525

2626
{{#isSearchClient}}
@@ -32,11 +32,11 @@ import {createHmac} from 'node:crypto';
3232
{{/nodeSearchHelpers}}
3333

3434
// eslint-disable-next-line @typescript-eslint/explicit-function-return-type
35-
export function {{apiName}}(
35+
export function {{clientName}}(
3636
appId: string,
3737
apiKey: string,{{#hasRegionalHost}}region{{#fallbackToAliasHost}}?{{/fallbackToAliasHost}}: Region,{{/hasRegionalHost}}
3838
options?: ClientOptions
39-
): {{#lambda.titlecase}}{{apiName}}{{/lambda.titlecase}} {
39+
): {{#lambda.titlecase}}{{clientName}}{{/lambda.titlecase}} {
4040
if (!appId || typeof appId !== 'string') {
4141
throw new Error("`appId` is missing.");
4242
}

‎templates/javascript/clients/client/builds/fetch.mustache‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
// {{{generationBanner}}}
22

3-
export type {{#lambda.titlecase}}{{apiName}}{{/lambda.titlecase}} = ReturnType<typeof create{{#lambda.titlecase}}{{apiName}}{{/lambda.titlecase}}>{{#nodeSearchHelpers}} & SearchClientNodeHelpers{{/nodeSearchHelpers}};
3+
export type {{#lambda.titlecase}}{{clientName}}{{/lambda.titlecase}} = ReturnType<typeof create{{#lambda.titlecase}}{{clientName}}{{/lambda.titlecase}}>{{#nodeSearchHelpers}} & SearchClientNodeHelpers{{/nodeSearchHelpers}};
44

55
{{> client/builds/definition}}
66
return {
7-
...create{{#lambda.titlecase}}{{apiName}}{{/lambda.titlecase}}({
7+
...create{{#lambda.titlecase}}{{clientName}}{{/lambda.titlecase}}({
88
appId,
99
apiKey,{{#hasRegionalHost}}region,{{/hasRegionalHost}}
1010
timeouts: {

‎templates/javascript/clients/client/builds/liteNode.mustache‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
// {{{generationBanner}}}
22

3-
export type {{#lambda.titlecase}}{{apiName}}{{/lambda.titlecase}} = ReturnType<typeof create{{#lambda.titlecase}}{{apiName}}{{/lambda.titlecase}}>;
3+
export type {{#lambda.titlecase}}{{clientName}}{{/lambda.titlecase}} = ReturnType<typeof create{{#lambda.titlecase}}{{clientName}}{{/lambda.titlecase}}>;
44

55
{{> client/builds/definition}}
6-
return create{{#lambda.titlecase}}{{apiName}}{{/lambda.titlecase}}({
6+
return create{{#lambda.titlecase}}{{clientName}}{{/lambda.titlecase}}({
77
appId,
88
apiKey,{{#hasRegionalHost}}region,{{/hasRegionalHost}}
99
timeouts: {

‎templates/javascript/clients/client/builds/node.mustache‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
// {{{generationBanner}}}
22

3-
export type {{#lambda.titlecase}}{{apiName}}{{/lambda.titlecase}} = ReturnType<typeof create{{#lambda.titlecase}}{{apiName}}{{/lambda.titlecase}}>{{#nodeSearchHelpers}} & SearchClientNodeHelpers{{/nodeSearchHelpers}};
3+
export type {{#lambda.titlecase}}{{clientName}}{{/lambda.titlecase}} = ReturnType<typeof create{{#lambda.titlecase}}{{clientName}}{{/lambda.titlecase}}>{{#nodeSearchHelpers}} & SearchClientNodeHelpers{{/nodeSearchHelpers}};
44

55
{{> client/builds/definition}}
66
return {
7-
...create{{#lambda.titlecase}}{{apiName}}{{/lambda.titlecase}}({
7+
...create{{#lambda.titlecase}}{{clientName}}{{/lambda.titlecase}}({
88
appId,
99
apiKey,{{#hasRegionalHost}}region,{{/hasRegionalHost}}
1010
timeouts: {

‎templates/javascript/clients/rollup.config.mustache‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ export default [
1818
['lite']: 'lite',
1919
{{/isAlgoliasearchClient}}
2020
{{^isAlgoliasearchClient}}
21-
['{{apiName}}']: '{{apiName}}',
21+
['{{clientName}}']: '{{clientName}}',
2222
{{/isAlgoliasearchClient}}
2323
},
2424
},

0 commit comments

Comments
 (0)