Skip to content

Commit 86723a4

Browse files
committed
chore: algoliasearch sub clients notice
1 parent 7ab269c commit 86723a4

File tree

2 files changed

+13
-0
lines changed

2 files changed

+13
-0
lines changed

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

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -157,6 +157,14 @@ private void setDefaultGeneratorOptions() {
157157
additionalProperties.put("isSearchClient", CLIENT.equals("search") || isAlgoliasearchClient);
158158
additionalProperties.put("isIngestionClient", CLIENT.equals("ingestion"));
159159
additionalProperties.put("isAlgoliasearchClient", isAlgoliasearchClient);
160+
additionalProperties.put(
161+
"isAvailableInAlgoliasearch",
162+
CLIENT.equals("search") ||
163+
CLIENT.equals("recommend") ||
164+
CLIENT.equals("personalization") ||
165+
CLIENT.equals("analytics") ||
166+
CLIENT.equals("abtesting")
167+
);
160168
additionalProperties.put("packageVersion", Helpers.getPackageJsonVersion(packageName));
161169
additionalProperties.put("packageName", packageName);
162170
additionalProperties.put("npmPackageName", isAlgoliasearchClient ? packageName : "@algolia/" + packageName);

templates/javascript/clients/README.mustache

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,11 @@
3232

3333
## 💡 Getting Started
3434

35+
{{#isAvailableInAlgoliasearch}}
36+
> [!TIP]
37+
> This API client already a dependency of [the algoliasearch client](https://www.npmjs.com/package/algoliasearch), you don't need to manually install `{{{npmPackageName}}}` if you already have `algoliasearch` installed.
38+
{{/isAvailableInAlgoliasearch}}
39+
3540
To get started, you first need to install {{npmPackageName}} (or any other available API client package).
3641

3742
All of our clients comes with type definition, and are available for both browser and node environments.

0 commit comments

Comments
 (0)