From d0f06d12c1f86515bd66a0aee693f3b8b0629fa5 Mon Sep 17 00:00:00 2001 From: shortcuts Date: Thu, 10 Oct 2024 13:57:47 +0200 Subject: [PATCH 01/11] feat(javascript): add every APIs --- .../codegen/AlgoliaJavascriptGenerator.java | 38 ++++++++++--------- .../com/algolia/codegen/utils/Helpers.java | 16 ++++++++ templates/javascript/clients/README.mustache | 4 +- templates/javascript/clients/package.mustache | 8 ++-- 4 files changed, 41 insertions(+), 25 deletions(-) diff --git a/generators/src/main/java/com/algolia/codegen/AlgoliaJavascriptGenerator.java b/generators/src/main/java/com/algolia/codegen/AlgoliaJavascriptGenerator.java index 7de7583a005..375b9cbc598 100644 --- a/generators/src/main/java/com/algolia/codegen/AlgoliaJavascriptGenerator.java +++ b/generators/src/main/java/com/algolia/codegen/AlgoliaJavascriptGenerator.java @@ -5,10 +5,7 @@ import io.swagger.v3.oas.models.OpenAPI; import io.swagger.v3.oas.models.Operation; import io.swagger.v3.oas.models.servers.Server; -import java.util.List; -import java.util.Map; -import java.util.Spliterator; -import java.util.Spliterators; +import java.util.*; import java.util.stream.StreamSupport; import org.openapitools.codegen.CodegenOperation; import org.openapitools.codegen.SupportingFile; @@ -151,6 +148,8 @@ public static String getPackageName(String client) throws ConfigException { private void setDefaultGeneratorOptions() { String clientName = CLIENT + Helpers.API_SUFFIX; String packageName = getPackageName((String) additionalProperties.get("client")); + List clientList = Helpers.getClientListForLanguage("javascript"); + clientList.removeIf(c -> c.equals("algoliasearch")); additionalProperties.put("apiName", CLIENT); additionalProperties.put("clientName", clientName); @@ -158,26 +157,29 @@ private void setDefaultGeneratorOptions() { additionalProperties.put("isSearchClient", CLIENT.equals("search") || isAlgoliasearchClient); additionalProperties.put("isIngestionClient", CLIENT.equals("ingestion")); additionalProperties.put("isAlgoliasearchClient", isAlgoliasearchClient); - additionalProperties.put( - "isAvailableInAlgoliasearch", - CLIENT.equals("search") || - CLIENT.equals("recommend") || - CLIENT.equals("personalization") || - CLIENT.equals("analytics") || - CLIENT.equals("abtesting") - ); + additionalProperties.put("isAvailableInAlgoliasearch", clientList.contains(CLIENT)); additionalProperties.put("packageVersion", Helpers.getPackageJsonVersion(packageName)); additionalProperties.put("packageName", packageName); additionalProperties.put("npmPackageName", isAlgoliasearchClient ? packageName : "@algolia/" + packageName); additionalProperties.put("nodeSearchHelpers", CLIENT.equals("search") || isAlgoliasearchClient); if (isAlgoliasearchClient) { - // Files used to create the package.json of the algoliasearch package - additionalProperties.put("analyticsVersion", Helpers.getPackageJsonVersion("client-analytics")); - additionalProperties.put("abtestingVersion", Helpers.getPackageJsonVersion("client-abtesting")); - additionalProperties.put("personalizationVersion", Helpers.getPackageJsonVersion("client-personalization")); - additionalProperties.put("searchVersion", Helpers.getPackageJsonVersion("client-search")); - additionalProperties.put("recommendVersion", Helpers.getPackageJsonVersion("recommend")); + var dependencies = new ArrayList>(); + List> packages = Helpers.getClientConfigList("javascript", "clients"); + for (Map pkg : packages) { + String name = ((String) pkg.get("output")).replace("clients/algoliasearch-client-javascript/packages/", ""); + if (name.equals("algoliasearch")) { + continue; + } + + var dependency = new HashMap(); + dependency.put("name", name); + dependency.put("package", "@algolia/" + name); + dependency.put("version", Helpers.getPackageJsonVersion(name)); + + dependencies.add(dependency); + } + additionalProperties.put("dependencies", dependencies); // Files used to generate the `lite` client clientName = "lite" + Helpers.API_SUFFIX; diff --git a/generators/src/main/java/com/algolia/codegen/utils/Helpers.java b/generators/src/main/java/com/algolia/codegen/utils/Helpers.java index 2b60eac6444..4296d2dad54 100644 --- a/generators/src/main/java/com/algolia/codegen/utils/Helpers.java +++ b/generators/src/main/java/com/algolia/codegen/utils/Helpers.java @@ -198,6 +198,22 @@ public static String getClientConfigField(String language, String... fields) thr return value.asText(); } + /** Get the `field` value in the `config/clients.config.json` file for the given language */ + public static List> getClientConfigList(String language, String... fields) throws ConfigException { + if (fields.length == 0) { + throw new ConfigException("getClientConfigList requires at least one field"); + } + JsonNode value = getClientConfig(language); + for (String field : fields) { + value = value.get(field); + } + try { + return new ObjectMapper().readerForListOf(Map.class).readValue(value); + } catch (IOException e) { + throw new ConfigException("Cannot convert value", e); + } + } + public static List getClientListForLanguage(String language) throws ConfigException { JsonNode value = getClientConfig(language); value = value.get("clients"); diff --git a/templates/javascript/clients/README.mustache b/templates/javascript/clients/README.mustache index 5c1a25f2a09..133b867e3b4 100644 --- a/templates/javascript/clients/README.mustache +++ b/templates/javascript/clients/README.mustache @@ -32,10 +32,10 @@ ## 💡 Getting Started -{{#isAvailableInAlgoliasearch}} +{{^isAlgoliasearchClient}} > [!TIP] > This API client is 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. -{{/isAvailableInAlgoliasearch}} +{{/isAlgoliasearchClient}} To get started, you first need to install {{npmPackageName}} (or any other available API client package). All of our clients comes with type definition, and are available for both browser and node environments. diff --git a/templates/javascript/clients/package.mustache b/templates/javascript/clients/package.mustache index 737bdc05c7f..45bb04ce278 100644 --- a/templates/javascript/clients/package.mustache +++ b/templates/javascript/clients/package.mustache @@ -120,12 +120,10 @@ "lite.d.ts" ], "dependencies": { - "@algolia/client-analytics": "{{analyticsVersion}}", - "@algolia/client-abtesting": "{{abtestingVersion}}", - "@algolia/client-personalization": "{{personalizationVersion}}", - "@algolia/client-search": "{{searchVersion}}", + {{#dependencies}} + "{{{package}}}": "{{{version}}}", + {{/dependencies}} "@algolia/client-common": "{{utilsPackageVersion}}", - "@algolia/recommend": "{{recommendVersion}}", "@algolia/requester-browser-xhr": "{{utilsPackageVersion}}", "@algolia/requester-node-http": "{{utilsPackageVersion}}", "@algolia/requester-fetch": "{{utilsPackageVersion}}" From 407c82e0c7790edb855198234cd0c9db974ed602 Mon Sep 17 00:00:00 2001 From: shortcuts Date: Thu, 10 Oct 2024 15:28:25 +0200 Subject: [PATCH 02/11] chore: dynamic template dependencies --- .../algoliasearch-client-javascript/yarn.lock | 12 ++-- .../codegen/AlgoliaJavascriptGenerator.java | 16 +++-- .../algoliasearch/builds/definition.mustache | 62 +++++----------- .../algoliasearch/builds/models.mustache | 72 ++++++++++++------- .../javascript/clients/api-single.mustache | 2 +- .../clients/client/api/hosts.mustache | 1 + .../clients/client/builds/definition.mustache | 3 +- templates/javascript/clients/package.mustache | 2 +- 8 files changed, 87 insertions(+), 83 deletions(-) diff --git a/clients/algoliasearch-client-javascript/yarn.lock b/clients/algoliasearch-client-javascript/yarn.lock index f1aa60e0edf..1c3475db8c2 100644 --- a/clients/algoliasearch-client-javascript/yarn.lock +++ b/clients/algoliasearch-client-javascript/yarn.lock @@ -54,7 +54,7 @@ __metadata: languageName: unknown linkType: soft -"@algolia/client-insights@workspace:packages/client-insights": +"@algolia/client-insights@npm:5.8.0, @algolia/client-insights@workspace:packages/client-insights": version: 0.0.0-use.local resolution: "@algolia/client-insights@workspace:packages/client-insights" dependencies: @@ -88,7 +88,7 @@ __metadata: languageName: unknown linkType: soft -"@algolia/client-query-suggestions@workspace:packages/client-query-suggestions": +"@algolia/client-query-suggestions@npm:5.8.0, @algolia/client-query-suggestions@workspace:packages/client-query-suggestions": version: 0.0.0-use.local resolution: "@algolia/client-query-suggestions@workspace:packages/client-query-suggestions" dependencies: @@ -122,7 +122,7 @@ __metadata: languageName: unknown linkType: soft -"@algolia/ingestion@workspace:packages/ingestion": +"@algolia/ingestion@npm:1.8.0, @algolia/ingestion@workspace:packages/ingestion": version: 0.0.0-use.local resolution: "@algolia/ingestion@workspace:packages/ingestion" dependencies: @@ -155,7 +155,7 @@ __metadata: languageName: unknown linkType: soft -"@algolia/monitoring@workspace:packages/monitoring": +"@algolia/monitoring@npm:1.8.0, @algolia/monitoring@workspace:packages/monitoring": version: 0.0.0-use.local resolution: "@algolia/monitoring@workspace:packages/monitoring" dependencies: @@ -2088,8 +2088,12 @@ __metadata: "@algolia/client-abtesting": "npm:5.8.0" "@algolia/client-analytics": "npm:5.8.0" "@algolia/client-common": "npm:5.8.0" + "@algolia/client-insights": "npm:5.8.0" "@algolia/client-personalization": "npm:5.8.0" + "@algolia/client-query-suggestions": "npm:5.8.0" "@algolia/client-search": "npm:5.8.0" + "@algolia/ingestion": "npm:1.8.0" + "@algolia/monitoring": "npm:1.8.0" "@algolia/recommend": "npm:5.8.0" "@algolia/requester-browser-xhr": "npm:5.8.0" "@algolia/requester-fetch": "npm:5.8.0" diff --git a/generators/src/main/java/com/algolia/codegen/AlgoliaJavascriptGenerator.java b/generators/src/main/java/com/algolia/codegen/AlgoliaJavascriptGenerator.java index 375b9cbc598..55c8862ec8b 100644 --- a/generators/src/main/java/com/algolia/codegen/AlgoliaJavascriptGenerator.java +++ b/generators/src/main/java/com/algolia/codegen/AlgoliaJavascriptGenerator.java @@ -148,8 +148,6 @@ public static String getPackageName(String client) throws ConfigException { private void setDefaultGeneratorOptions() { String clientName = CLIENT + Helpers.API_SUFFIX; String packageName = getPackageName((String) additionalProperties.get("client")); - List clientList = Helpers.getClientListForLanguage("javascript"); - clientList.removeIf(c -> c.equals("algoliasearch")); additionalProperties.put("apiName", CLIENT); additionalProperties.put("clientName", clientName); @@ -157,7 +155,7 @@ private void setDefaultGeneratorOptions() { additionalProperties.put("isSearchClient", CLIENT.equals("search") || isAlgoliasearchClient); additionalProperties.put("isIngestionClient", CLIENT.equals("ingestion")); additionalProperties.put("isAlgoliasearchClient", isAlgoliasearchClient); - additionalProperties.put("isAvailableInAlgoliasearch", clientList.contains(CLIENT)); + additionalProperties.put("isAvailableInAlgoliasearch", !CLIENT.equals("algoliasearch")); additionalProperties.put("packageVersion", Helpers.getPackageJsonVersion(packageName)); additionalProperties.put("packageName", packageName); additionalProperties.put("npmPackageName", isAlgoliasearchClient ? packageName : "@algolia/" + packageName); @@ -168,14 +166,18 @@ private void setDefaultGeneratorOptions() { List> packages = Helpers.getClientConfigList("javascript", "clients"); for (Map pkg : packages) { String name = ((String) pkg.get("output")).replace("clients/algoliasearch-client-javascript/packages/", ""); - if (name.equals("algoliasearch")) { + if (name.contains("search")) { continue; } var dependency = new HashMap(); - dependency.put("name", name); - dependency.put("package", "@algolia/" + name); - dependency.put("version", Helpers.getPackageJsonVersion(name)); + dependency.put("dependencyName", Helpers.createClientName((String) pkg.get("name"), "javascript")); + dependency.put("dependencyPackage", "@algolia/" + name); + dependency.put("dependencyVersion", Helpers.getPackageJsonVersion(name)); + dependency.put( + "dependencyHasRegionalHosts", + !name.contains("search") && !name.contains("recommend") && !name.contains("monitoring") + ); dependencies.add(dependency); } diff --git a/templates/javascript/clients/algoliasearch/builds/definition.mustache b/templates/javascript/clients/algoliasearch/builds/definition.mustache index b455f154338..986107bbc76 100644 --- a/templates/javascript/clients/algoliasearch/builds/definition.mustache +++ b/templates/javascript/clients/algoliasearch/builds/definition.mustache @@ -1,30 +1,28 @@ // {{{generationBanner}}} import type { ClientOptions } from '@algolia/client-common'; -import type { AbtestingClient, Region as AbtestingRegion } from "@algolia/client-abtesting" -import type { AnalyticsClient, Region as AnalyticsRegion } from "@algolia/client-analytics" -import type { PersonalizationClient, Region as PersonalizationRegion } from "@algolia/client-personalization" -import type { RecommendClient } from "@algolia/recommend" -import type { SearchClient } from "@algolia/client-search" -import { abtestingClient } from '@algolia/client-abtesting'; -import { analyticsClient } from '@algolia/client-analytics'; -import { personalizationClient } from '@algolia/client-personalization'; -import { searchClient } from '@algolia/client-search'; -import { recommendClient } from '@algolia/recommend'; +{{#dependencies}} +import { {{{dependencyName}}}Client } from '{{{dependencyPackage}}}'; +import type { {{#lambda.titlecase}}{{{dependencyName}}}{{/lambda.titlecase}}Client } from '{{{dependencyPackage}}}'; +{{/dependencies}} import type { InitClientOptions, - InitClientRegion, + {{#dependencies}} + {{#dependencyHasRegionalHosts}} + {{#lambda.titlecase}}{{{dependencyName}}}Region{{/lambda.titlecase}}, + {{#lambda.titlecase}}{{{dependencyName}}}RegionOptions{{/lambda.titlecase}}, + {{/dependencyHasRegionalHosts}} + {{/dependencies}} } from './models'; export * from './models'; export type Algoliasearch = SearchClient & { - initRecommend: (initOptions?: InitClientOptions)=> RecommendClient; - initAnalytics: (initOptions?: InitClientOptions & InitClientRegion)=> AnalyticsClient; - initAbtesting: (initOptions?: InitClientOptions & InitClientRegion)=> AbtestingClient; - initPersonalization: (initOptions: InitClientOptions & Required>)=> PersonalizationClient; + {{#dependencies}} + init{{#lambda.titlecase}}{{{dependencyName}}}{{/lambda.titlecase}}: (initOptions: InitClientOptions {{#dependencyHasRegionalHosts}}& {{#lambda.titlecase}}{{{dependencyName}}}RegionOptions{{/lambda.titlecase}}{{/dependencyHasRegionalHosts}}) => {{#lambda.titlecase}}{{{dependencyName}}}{{/lambda.titlecase}}Client; + {{/dependencies}} }; export function algoliasearch(appId: string, apiKey: string, options?: ClientOptions): Algoliasearch { @@ -40,43 +38,19 @@ export function algoliasearch(appId: string, apiKey: string, options?: ClientOpt return { ...client, + /** * Get the value of the `algoliaAgent`, used by our libraries internally and telemetry system. */ get _ua(): string { return client.transporter.algoliaAgent.value; }, - initRecommend: (initOptions: InitClientOptions = {}): RecommendClient => { - return recommendClient(initOptions.appId || appId, initOptions.apiKey || apiKey, initOptions.options); - }, - initAnalytics: (initOptions: InitClientOptions & InitClientRegion = {}): AnalyticsClient => { - return analyticsClient( - initOptions.appId || appId, - initOptions.apiKey || apiKey, - initOptions.region, - initOptions.options, - ); + {{#dependencies}} + init{{#lambda.titlecase}}{{{dependencyName}}}{{/lambda.titlecase}}: (initOptions: InitClientOptions {{#dependencyHasRegionalHosts}}& {{#lambda.titlecase}}{{{dependencyName}}}RegionOptions{{/lambda.titlecase}}{{/dependencyHasRegionalHosts}}): {{#lambda.titlecase}}{{{dependencyName}}}{{/lambda.titlecase}}Client => { + return {{{dependencyName}}}Client(initOptions.appId || appId, initOptions.apiKey || apiKey, {{#dependencyHasRegionalHosts}}initOptions.region,{{/dependencyHasRegionalHosts}}initOptions.options); }, - initAbtesting: (initOptions: InitClientOptions & InitClientRegion = {}): AbtestingClient => { - return abtestingClient( - initOptions.appId || appId, - initOptions.apiKey || apiKey, - initOptions.region, - initOptions.options, - ); - }, - - initPersonalization: ( - initOptions: InitClientOptions & Required>, - ): PersonalizationClient => { - return personalizationClient( - initOptions.appId || appId, - initOptions.apiKey || apiKey, - initOptions.region, - initOptions.options, - ); - }, + {{/dependencies}} } } \ No newline at end of file diff --git a/templates/javascript/clients/algoliasearch/builds/models.mustache b/templates/javascript/clients/algoliasearch/builds/models.mustache index ac93e8ae154..a42db308890 100644 --- a/templates/javascript/clients/algoliasearch/builds/models.mustache +++ b/templates/javascript/clients/algoliasearch/builds/models.mustache @@ -1,9 +1,18 @@ // {{{generationBanner}}} -import type { AbtestingClient, Region as AbTestingRegion } from '@algolia/client-abtesting'; -import type { AnalyticsClient, Region as AnalyticsRegion } from '@algolia/client-analytics'; +{{#dependencies}} +import type { + {{#lambda.titlecase}}{{{dependencyName}}}Client{{/lambda.titlecase}}, + {{#dependencyHasRegionalHosts}} + Region as {{#lambda.titlecase}}{{{dependencyName}}}Region{{/lambda.titlecase}}, + RegionOptions as {{#lambda.titlecase}}{{{dependencyName}}}RegionOptions{{/lambda.titlecase}}, + {{/dependencyHasRegionalHosts}} +} from '{{{dependencyPackage}}}'; +{{/dependencies}} + import type { ClientOptions } from '@algolia/client-common'; import type { + Action, AdvancedSyntaxFeatures, AlternativesAsExact, Anchoring, @@ -32,6 +41,7 @@ import type { CustomGetProps, CustomPostProps, CustomPutProps, + DeleteSourceProps, DeletedAtResponse, Distinct, Edit, @@ -41,14 +51,16 @@ import type { Exhaustive, FacetFilters, FacetOrdering, - Facets, FacetStats, + Facets, + GetTaskProps, HighlightResult, HighlightResultOption, IgnorePlurals, IndexSettingsAsSearchParams, - MatchedGeoLocation, + Languages, MatchLevel, + MatchedGeoLocation, Mode, NumericFilters, OptionalFilters, @@ -60,6 +72,7 @@ import type { QueryType, Range, RankingInfo, + ReRankingApplyFilter, Redirect, RedirectRuleIndexData, RedirectRuleIndexMetadata, @@ -67,7 +80,6 @@ import type { RemoveStopWords, RemoveWordsIfNoResults, RenderingContent, - ReRankingApplyFilter, SearchPagination, SearchParams, SearchParamsObject, @@ -76,6 +88,7 @@ import type { SnippetResult, SnippetResultOption, SortRemainingBy, + Source, SupportedLanguage, TagFilters, TaskStatus, @@ -86,23 +99,25 @@ import type { Widgets, } from '@algolia/client-search'; import { apiClientVersion } from '@algolia/client-search'; -import type { RecommendClient } from '@algolia/recommend'; +import { + Status, +} from '@algolia/client-abtesting'; +import { + EventType, +} from '@algolia/client-personalization'; -type Region = AbTestingRegion | AnalyticsRegion; +type Region = {{#dependencies}} {{#dependencyHasRegionalHosts}}{{^-first}}|{{/-first}}{{#lambda.titlecase}}{{{dependencyName}}}Region{{/lambda.titlecase}} {{/dependencyHasRegionalHosts}}{{/dependencies}}; +type RegionOptions = {{#dependencies}} {{#dependencyHasRegionalHosts}}{{^-first}}|{{/-first}}{{#lambda.titlecase}}{{{dependencyName}}}RegionOptions{{/lambda.titlecase}} {{/dependencyHasRegionalHosts}}{{/dependencies}}; -export * from '@algolia/client-search'; -export * from '@algolia/recommend'; -export * from '@algolia/client-personalization'; -export * from '@algolia/client-analytics'; -export * from '@algolia/client-abtesting'; +{{#dependencies}} +export * from '{{{dependencyPackage}}}'; +{{/dependencies}} export { - AbTestingRegion, + Action, AdvancedSyntaxFeatures, AlternativesAsExact, - AnalyticsRegion, Anchoring, - apiClientVersion, AroundPrecision, AroundRadius, AroundRadiusAll, @@ -128,23 +143,27 @@ export { CustomGetProps, CustomPostProps, CustomPutProps, + DeleteSourceProps, DeletedAtResponse, Distinct, Edit, EditType, ErrorBase, + EventType, ExactOnSingleWordQuery, Exhaustive, FacetFilters, FacetOrdering, - Facets, FacetStats, + Facets, + GetTaskProps, HighlightResult, HighlightResultOption, IgnorePlurals, IndexSettingsAsSearchParams, - MatchedGeoLocation, + Languages, MatchLevel, + MatchedGeoLocation, Mode, NumericFilters, OptionalFilters, @@ -156,15 +175,16 @@ export { QueryType, Range, RankingInfo, + ReRankingApplyFilter, Redirect, RedirectRuleIndexData, RedirectRuleIndexMetadata, RedirectURL, Region, + RegionOptions, RemoveStopWords, RemoveWordsIfNoResults, RenderingContent, - ReRankingApplyFilter, SearchPagination, SearchParams, SearchParamsObject, @@ -173,6 +193,8 @@ export { SnippetResult, SnippetResultOption, SortRemainingBy, + Source, + Status, SupportedLanguage, TagFilters, TaskStatus, @@ -181,6 +203,13 @@ export { TypoToleranceEnum, Value, Widgets, + apiClientVersion, +{{#dependencies}} + {{#dependencyHasRegionalHosts}} + {{#lambda.titlecase}}{{{dependencyName}}}Region{{/lambda.titlecase}}, + {{#lambda.titlecase}}{{{dependencyName}}}RegionOptions{{/lambda.titlecase}}, + {{/dependencyHasRegionalHosts}} +{{/dependencies}} }; /** @@ -196,11 +225,4 @@ export type InitClientOptions = Partial<{ */ apiKey: string; options: ClientOptions; -}>; - -export type InitClientRegion = Partial<{ - /** - * Available regions of the initialized client. - */ - region: TRegion; }>; \ No newline at end of file diff --git a/templates/javascript/clients/api-single.mustache b/templates/javascript/clients/api-single.mustache index 1f03c32c704..2018f8dd745 100644 --- a/templates/javascript/clients/api-single.mustache +++ b/templates/javascript/clients/api-single.mustache @@ -18,7 +18,7 @@ export function create{{#lambda.titlecase}}{{clientName}}{{/lambda.titlecase}}({ authMode, algoliaAgents,{{#hasRegionalHost}} region: regionOption,{{/hasRegionalHost}} ...options - }: CreateClientOptions{{#hasRegionalHost}} & {region{{#fallbackToAliasHost}}?{{/fallbackToAliasHost}}: Region }{{/hasRegionalHost}}) { + }: CreateClientOptions{{#hasRegionalHost}} & RegionOptions{{/hasRegionalHost}}) { const auth = createAuth(appIdOption, apiKeyOption, authMode); const transporter = createTransporter({ hosts: getDefaultHosts({{#hostWithAppID}}appIdOption{{/hostWithAppID}}{{#hasRegionalHost}}regionOption{{/hasRegionalHost}}), diff --git a/templates/javascript/clients/client/api/hosts.mustache b/templates/javascript/clients/client/api/hosts.mustache index 76b473a399a..8f201a1b3c0 100644 --- a/templates/javascript/clients/client/api/hosts.mustache +++ b/templates/javascript/clients/client/api/hosts.mustache @@ -1,6 +1,7 @@ {{#hasRegionalHost}} export const REGIONS = [{{#allowedRegions}}'{{.}}'{{^-last}},{{/-last}}{{/allowedRegions}}] as const; export type Region = (typeof REGIONS)[number]; +export type RegionOptions = {region{{#fallbackToAliasHost}}?{{/fallbackToAliasHost}}: Region }; {{/hasRegionalHost}} {{^hasRegionalHost}} diff --git a/templates/javascript/clients/client/builds/definition.mustache b/templates/javascript/clients/client/builds/definition.mustache index e7de6b43ddb..31312f3ab1c 100644 --- a/templates/javascript/clients/client/builds/definition.mustache +++ b/templates/javascript/clients/client/builds/definition.mustache @@ -6,7 +6,7 @@ import { createNullLogger, createMemoryCache, createFallbackableCache, createBro import { create{{#lambda.titlecase}}{{clientName}}{{/lambda.titlecase}}, apiClientVersion } from '../src/{{clientName}}'; {{#hasRegionalHost}} -import { Region, REGIONS } from '../src/{{clientName}}'; +import { Region, REGIONS, RegionOptions } from '../src/{{clientName}}'; {{/hasRegionalHost}} {{! We don't use `export *` to prevent exposing the factory, to avoid confusion for the user }} @@ -14,6 +14,7 @@ export { apiClientVersion, {{#hasRegionalHost}} Region, + RegionOptions, {{/hasRegionalHost}} {{#isIngestionClient}} isOnDemandTrigger, diff --git a/templates/javascript/clients/package.mustache b/templates/javascript/clients/package.mustache index 45bb04ce278..92416d269a7 100644 --- a/templates/javascript/clients/package.mustache +++ b/templates/javascript/clients/package.mustache @@ -121,7 +121,7 @@ ], "dependencies": { {{#dependencies}} - "{{{package}}}": "{{{version}}}", + "{{{dependencyPackage}}}": "{{{dependencyVersion}}}", {{/dependencies}} "@algolia/client-common": "{{utilsPackageVersion}}", "@algolia/requester-browser-xhr": "{{utilsPackageVersion}}", From 0c5602ac986691eba646944a224c6f8e1e56a213 Mon Sep 17 00:00:00 2001 From: shortcuts Date: Thu, 10 Oct 2024 15:30:06 +0200 Subject: [PATCH 03/11] chore: unused prop --- .../java/com/algolia/codegen/AlgoliaJavascriptGenerator.java | 1 - 1 file changed, 1 deletion(-) diff --git a/generators/src/main/java/com/algolia/codegen/AlgoliaJavascriptGenerator.java b/generators/src/main/java/com/algolia/codegen/AlgoliaJavascriptGenerator.java index 55c8862ec8b..faa94bdf662 100644 --- a/generators/src/main/java/com/algolia/codegen/AlgoliaJavascriptGenerator.java +++ b/generators/src/main/java/com/algolia/codegen/AlgoliaJavascriptGenerator.java @@ -155,7 +155,6 @@ private void setDefaultGeneratorOptions() { additionalProperties.put("isSearchClient", CLIENT.equals("search") || isAlgoliasearchClient); additionalProperties.put("isIngestionClient", CLIENT.equals("ingestion")); additionalProperties.put("isAlgoliasearchClient", isAlgoliasearchClient); - additionalProperties.put("isAvailableInAlgoliasearch", !CLIENT.equals("algoliasearch")); additionalProperties.put("packageVersion", Helpers.getPackageJsonVersion(packageName)); additionalProperties.put("packageName", packageName); additionalProperties.put("npmPackageName", isAlgoliasearchClient ? packageName : "@algolia/" + packageName); From c801378d3554acc6061559159ffe6e376b4984b7 Mon Sep 17 00:00:00 2001 From: shortcuts Date: Thu, 10 Oct 2024 15:35:40 +0200 Subject: [PATCH 04/11] trigger From 499dabccfc838d3e79f35fc581437d0aab6f7571 Mon Sep 17 00:00:00 2001 From: shortcuts Date: Thu, 10 Oct 2024 15:43:19 +0200 Subject: [PATCH 05/11] chore: lock --- .../algoliasearch-client-javascript/yarn.lock | 55 +++++-------------- 1 file changed, 15 insertions(+), 40 deletions(-) diff --git a/clients/algoliasearch-client-javascript/yarn.lock b/clients/algoliasearch-client-javascript/yarn.lock index e46be61be03..90eca7a7ffe 100644 --- a/clients/algoliasearch-client-javascript/yarn.lock +++ b/clients/algoliasearch-client-javascript/yarn.lock @@ -54,7 +54,7 @@ __metadata: languageName: unknown linkType: soft -"@algolia/client-insights@npm:5.8.0, @algolia/client-insights@workspace:packages/client-insights": +"@algolia/client-insights@npm:5.8.1, @algolia/client-insights@workspace:packages/client-insights": version: 0.0.0-use.local resolution: "@algolia/client-insights@workspace:packages/client-insights" dependencies: @@ -88,7 +88,7 @@ __metadata: languageName: unknown linkType: soft -"@algolia/client-query-suggestions@npm:5.8.0, @algolia/client-query-suggestions@workspace:packages/client-query-suggestions": +"@algolia/client-query-suggestions@npm:5.8.1, @algolia/client-query-suggestions@workspace:packages/client-query-suggestions": version: 0.0.0-use.local resolution: "@algolia/client-query-suggestions@workspace:packages/client-query-suggestions" dependencies: @@ -105,7 +105,7 @@ __metadata: languageName: unknown linkType: soft -"@algolia/client-search@npm:5.8.1, @algolia/client-search@workspace:packages/client-search": +"@algolia/client-search@workspace:packages/client-search": version: 0.0.0-use.local resolution: "@algolia/client-search@workspace:packages/client-search" dependencies: @@ -122,7 +122,7 @@ __metadata: languageName: unknown linkType: soft -"@algolia/ingestion@npm:1.8.0, @algolia/ingestion@workspace:packages/ingestion": +"@algolia/ingestion@npm:1.8.1, @algolia/ingestion@workspace:packages/ingestion": version: 0.0.0-use.local resolution: "@algolia/ingestion@workspace:packages/ingestion" dependencies: @@ -155,7 +155,7 @@ __metadata: languageName: unknown linkType: soft -"@algolia/monitoring@npm:1.8.0, @algolia/monitoring@workspace:packages/monitoring": +"@algolia/monitoring@npm:1.8.1, @algolia/monitoring@workspace:packages/monitoring": version: 0.0.0-use.local resolution: "@algolia/monitoring@workspace:packages/monitoring" dependencies: @@ -2085,44 +2085,19 @@ __metadata: version: 0.0.0-use.local resolution: "algoliasearch@workspace:packages/algoliasearch" dependencies: -<<<<<<< HEAD - "@algolia/client-abtesting": "npm:5.8.0" - "@algolia/client-analytics": "npm:5.8.0" - "@algolia/client-common": "npm:5.8.0" - "@algolia/client-insights": "npm:5.8.0" - "@algolia/client-personalization": "npm:5.8.0" - "@algolia/client-query-suggestions": "npm:5.8.0" - "@algolia/client-search": "npm:5.8.0" - "@algolia/ingestion": "npm:1.8.0" - "@algolia/monitoring": "npm:1.8.0" - "@algolia/recommend": "npm:5.8.0" - "@algolia/requester-browser-xhr": "npm:5.8.0" - "@algolia/requester-fetch": "npm:5.8.0" - "@algolia/requester-node-http": "npm:5.8.0" - "@algolia/requester-testing": "npm:5.8.0" -||||||| 0b2d1f54f - "@algolia/client-abtesting": "npm:5.8.0" - "@algolia/client-analytics": "npm:5.8.0" - "@algolia/client-common": "npm:5.8.0" - "@algolia/client-personalization": "npm:5.8.0" - "@algolia/client-search": "npm:5.8.0" - "@algolia/recommend": "npm:5.8.0" - "@algolia/requester-browser-xhr": "npm:5.8.0" - "@algolia/requester-fetch": "npm:5.8.0" - "@algolia/requester-node-http": "npm:5.8.0" - "@algolia/requester-testing": "npm:5.8.0" -======= "@algolia/client-abtesting": "npm:5.8.1" "@algolia/client-analytics": "npm:5.8.1" "@algolia/client-common": "npm:5.8.1" + "@algolia/client-insights": "npm:5.8.1" "@algolia/client-personalization": "npm:5.8.1" - "@algolia/client-search": "npm:5.8.1" + "@algolia/client-query-suggestions": "npm:5.8.1" + "@algolia/ingestion": "npm:1.8.1" + "@algolia/monitoring": "npm:1.8.1" "@algolia/recommend": "npm:5.8.1" "@algolia/requester-browser-xhr": "npm:5.8.1" "@algolia/requester-fetch": "npm:5.8.1" "@algolia/requester-node-http": "npm:5.8.1" "@algolia/requester-testing": "npm:5.8.1" ->>>>>>> main "@arethetypeswrong/cli": "npm:0.16.4" "@types/node": "npm:22.7.4" jsdom: "npm:25.0.1" @@ -3966,13 +3941,13 @@ __metadata: linkType: hard "form-data@npm:^4.0.0": - version: 4.0.0 - resolution: "form-data@npm:4.0.0" + version: 4.0.1 + resolution: "form-data@npm:4.0.1" dependencies: asynckit: "npm:^0.4.0" combined-stream: "npm:^1.0.8" mime-types: "npm:^2.1.12" - checksum: 10/7264aa760a8cf09482816d8300f1b6e2423de1b02bba612a136857413fdc96d7178298ced106817655facc6b89036c6e12ae31c9eb5bdc16aabf502ae8a5d805 + checksum: 10/6adb1cff557328bc6eb8a68da205f9ae44ab0e88d4d9237aaf91eed591ffc64f77411efb9016af7d87f23d0a038c45a788aa1c6634e51175c4efa36c2bc53774 languageName: node linkType: hard @@ -5847,11 +5822,11 @@ __metadata: linkType: hard "nan@npm:^2.14.0": - version: 2.20.0 - resolution: "nan@npm:2.20.0" + version: 2.21.0 + resolution: "nan@npm:2.21.0" dependencies: node-gyp: "npm:latest" - checksum: 10/5f16e4c9953075d9920229c703c1d781c0b74118ce3d9e926b448a4eef92b7d8be5ac6adc748a13a5fafb594436cbfe63250e3471aefdd78e3a0cd14603b9ba7 + checksum: 10/4517d316776b509a961c65241b72863e70f63aa5b0c354ca19fbbbf7c78254e54aa1f0de142fac1df986a04c27e74a1fb7e4aa85e9e3834daa172b8d9d1bbb07 languageName: node linkType: hard From 357bc5751db73967cfe095a51d96cfc7230c5a30 Mon Sep 17 00:00:00 2001 From: shortcuts Date: Thu, 10 Oct 2024 16:01:04 +0200 Subject: [PATCH 06/11] fix: search types --- .../clients/algoliasearch/builds/definition.mustache | 3 +++ 1 file changed, 3 insertions(+) diff --git a/templates/javascript/clients/algoliasearch/builds/definition.mustache b/templates/javascript/clients/algoliasearch/builds/definition.mustache index 986107bbc76..e7f5f658d6d 100644 --- a/templates/javascript/clients/algoliasearch/builds/definition.mustache +++ b/templates/javascript/clients/algoliasearch/builds/definition.mustache @@ -2,6 +2,9 @@ import type { ClientOptions } from '@algolia/client-common'; +import type { SearchClient } from '@algolia/client-search'; +import { searchClient } from '@algolia/client-search'; + {{#dependencies}} import { {{{dependencyName}}}Client } from '{{{dependencyPackage}}}'; import type { {{#lambda.titlecase}}{{{dependencyName}}}{{/lambda.titlecase}}Client } from '{{{dependencyPackage}}}'; From 5b1eb3975aa1bee22d92bf66052a8c402738368e Mon Sep 17 00:00:00 2001 From: shortcuts Date: Mon, 14 Oct 2024 09:42:17 +0200 Subject: [PATCH 07/11] fix: ci assertions --- .github/workflows/check.yml | 10 +++++----- .../bundlesize.config.json | 10 +++++----- clients/algoliasearch-client-javascript/package.json | 2 +- .../clients/algoliasearch/builds/definition.mustache | 1 - 4 files changed, 11 insertions(+), 12 deletions(-) diff --git a/.github/workflows/check.yml b/.github/workflows/check.yml index 238f06cdc03..b20199ce8d1 100644 --- a/.github/workflows/check.yml +++ b/.github/workflows/check.yml @@ -199,10 +199,10 @@ jobs: type: specs - name: Remove generated clients - if: ${{ startsWith(env.head_ref, 'chore/prepare-release-') }} + if: ${{ startsWith(github.head_ref, 'chore/prepare-release-') }} run: | cd clients/algoliasearch-client-javascript/packages - ls | grep -v -E "(client-common|requester-*|algoliasearch)" | xargs rm -rf + ls | grep -v -E "(logger-console|client-common|requester-*|algoliasearch)" | xargs rm -rf cd algoliasearch ls | grep -v -E "__tests__" | xargs rm -rf @@ -228,11 +228,11 @@ jobs: run: cd clients/algoliasearch-client-javascript && yarn test ${{ !contains(fromJSON(needs.setup.outputs.JAVASCRIPT_DATA).toRun, 'algoliasearch') && '--ignore algoliasearch' || '' }} - name: Test JavaScript bundle size - if: ${{ startsWith(env.head_ref, 'chore/prepare-release-') }} + if: ${{ startsWith(github.head_ref, 'chore/prepare-release-') }} run: cd clients/algoliasearch-client-javascript && yarn test:size - name: Test JavaScript bundle and types - if: ${{ startsWith(env.head_ref, 'chore/prepare-release-') }} + if: ${{ startsWith(github.head_ref, 'chore/prepare-release-') }} run: cd clients/algoliasearch-client-javascript && yarn test:bundle - name: Remove previous CTS output @@ -335,7 +335,7 @@ jobs: run: yarn cli generate ${{ matrix.client.language }} ${{ matrix.client.toRun }} - name: Update composer.lock - if: ${{ matrix.client.language == 'php' && startsWith(env.head_ref, 'chore/renovateBaseBranch') && matrix.client.isMainVersion }} + if: ${{ matrix.client.language == 'php' && startsWith(github.head_ref, 'chore/renovateBaseBranch') && matrix.client.isMainVersion }} run: cd ${{ matrix.client.path }} && composer update - name: Check for file duplicates in Swift diff --git a/clients/algoliasearch-client-javascript/bundlesize.config.json b/clients/algoliasearch-client-javascript/bundlesize.config.json index f72ce0e5338..14fb1b29506 100644 --- a/clients/algoliasearch-client-javascript/bundlesize.config.json +++ b/clients/algoliasearch-client-javascript/bundlesize.config.json @@ -2,7 +2,7 @@ "files": [ { "path": "packages/algoliasearch/dist/algoliasearch.umd.js", - "maxSize": "9.50KB" + "maxSize": "12.60KB" }, { "path": "packages/algoliasearch/dist/lite/builds/browser.umd.js", @@ -10,11 +10,11 @@ }, { "path": "packages/client-abtesting/dist/builds/browser.umd.js", - "maxSize": "4.10KB" + "maxSize": "4.15KB" }, { "path": "packages/client-analytics/dist/builds/browser.umd.js", - "maxSize": "4.75KB" + "maxSize": "4.85KB" }, { "path": "packages/client-insights/dist/builds/browser.umd.js", @@ -30,7 +30,7 @@ }, { "path": "packages/client-search/dist/builds/browser.umd.js", - "maxSize": "7.15KB" + "maxSize": "7.25KB" }, { "path": "packages/ingestion/dist/builds/browser.umd.js", @@ -42,7 +42,7 @@ }, { "path": "packages/recommend/dist/builds/browser.umd.js", - "maxSize": "4.10KB" + "maxSize": "4.15KB" } ] } diff --git a/clients/algoliasearch-client-javascript/package.json b/clients/algoliasearch-client-javascript/package.json index 7beab792d4f..da0789dada1 100644 --- a/clients/algoliasearch-client-javascript/package.json +++ b/clients/algoliasearch-client-javascript/package.json @@ -7,7 +7,7 @@ ], "scripts": { "build:all": "lerna run build --include-dependencies", - "build:many": "lerna run build --scope '@algolia/requester-testing' --scope ${0:-'{@algolia/*,algoliasearch}'} --include-dependencies", + "build:many": "lerna run build --scope '@algolia/requester-testing' --scope '@algolia/logger-console' --scope ${0:-'{@algolia/*,algoliasearch}'} --include-dependencies", "clean": "lerna run clean", "release:bump": "lerna version ${0:-patch} --no-changelog --no-git-tag-version --no-push --exact --force-publish --yes", "release:publish": "tsc --project scripts/tsconfig.json && node scripts/dist/scripts/publish.js", diff --git a/templates/javascript/clients/algoliasearch/builds/definition.mustache b/templates/javascript/clients/algoliasearch/builds/definition.mustache index e7f5f658d6d..4236e3cfc67 100644 --- a/templates/javascript/clients/algoliasearch/builds/definition.mustache +++ b/templates/javascript/clients/algoliasearch/builds/definition.mustache @@ -1,7 +1,6 @@ // {{{generationBanner}}} import type { ClientOptions } from '@algolia/client-common'; - import type { SearchClient } from '@algolia/client-search'; import { searchClient } from '@algolia/client-search'; From 5b8f5ceabd2fca11fd50193912335f11c0ca1f29 Mon Sep 17 00:00:00 2001 From: shortcuts Date: Mon, 14 Oct 2024 09:42:34 +0200 Subject: [PATCH 08/11] chore: ignore foo --- .eslintignore | 1 + 1 file changed, 1 insertion(+) diff --git a/.eslintignore b/.eslintignore index 583e0662e35..85f17a31be3 100644 --- a/.eslintignore +++ b/.eslintignore @@ -6,3 +6,4 @@ composer.json tsconfig.json vendor builddir +foo From a0f0ea127142abad3205ebe772a0063486bf86be Mon Sep 17 00:00:00 2001 From: shortcuts Date: Mon, 14 Oct 2024 09:45:22 +0200 Subject: [PATCH 09/11] chore: restore from main --- .../packages/algoliasearch/builds/browser.ts | 89 +++++-------------- .../packages/algoliasearch/builds/fetch.ts | 89 +++++-------------- .../packages/algoliasearch/builds/models.ts | 84 ++++------------- .../packages/algoliasearch/builds/node.ts | 89 +++++-------------- .../packages/algoliasearch/package.json | 19 ++-- .../client-abtesting/builds/browser.ts | 2 +- .../packages/client-abtesting/builds/fetch.ts | 2 +- .../packages/client-abtesting/builds/node.ts | 2 +- .../packages/client-abtesting/package.json | 4 +- .../client-abtesting/src/abtestingClient.ts | 3 +- .../client-analytics/builds/browser.ts | 2 +- .../packages/client-analytics/builds/fetch.ts | 2 +- .../packages/client-analytics/builds/node.ts | 2 +- .../packages/client-analytics/package.json | 4 +- .../client-analytics/src/analyticsClient.ts | 3 +- .../packages/client-insights/README.md | 3 - .../client-insights/builds/browser.ts | 2 +- .../packages/client-insights/builds/fetch.ts | 2 +- .../packages/client-insights/builds/node.ts | 2 +- .../packages/client-insights/package.json | 4 +- .../client-insights/src/insightsClient.ts | 3 +- .../client-personalization/builds/browser.ts | 2 +- .../client-personalization/builds/fetch.ts | 2 +- .../client-personalization/builds/node.ts | 2 +- .../client-personalization/package.json | 4 +- .../src/personalizationClient.ts | 3 +- .../client-query-suggestions/README.md | 3 - .../builds/browser.ts | 2 +- .../client-query-suggestions/builds/fetch.ts | 2 +- .../client-query-suggestions/builds/node.ts | 2 +- .../client-query-suggestions/package.json | 4 +- .../src/querySuggestionsClient.ts | 3 +- .../packages/client-search/package.json | 4 +- .../packages/ingestion/README.md | 3 - .../packages/ingestion/builds/browser.ts | 1 - .../packages/ingestion/builds/fetch.ts | 1 - .../packages/ingestion/builds/node.ts | 1 - .../packages/ingestion/package.json | 4 +- .../packages/ingestion/src/ingestionClient.ts | 3 +- .../packages/monitoring/README.md | 3 - .../packages/monitoring/package.json | 4 +- .../packages/recommend/package.json | 4 +- 42 files changed, 129 insertions(+), 340 deletions(-) diff --git a/clients/algoliasearch-client-javascript/packages/algoliasearch/builds/browser.ts b/clients/algoliasearch-client-javascript/packages/algoliasearch/builds/browser.ts index 134c7258ce6..e1c5a385ef8 100644 --- a/clients/algoliasearch-client-javascript/packages/algoliasearch/builds/browser.ts +++ b/clients/algoliasearch-client-javascript/packages/algoliasearch/builds/browser.ts @@ -1,45 +1,29 @@ // Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT. +import type { AbtestingClient, Region as AbtestingRegion } from '@algolia/client-abtesting'; +import type { AnalyticsClient, Region as AnalyticsRegion } from '@algolia/client-analytics'; import type { ClientOptions } from '@algolia/client-common'; +import type { PersonalizationClient, Region as PersonalizationRegion } from '@algolia/client-personalization'; +import type { SearchClient } from '@algolia/client-search'; +import type { RecommendClient } from '@algolia/recommend'; -import type { AbtestingClient } from '@algolia/client-abtesting'; import { abtestingClient } from '@algolia/client-abtesting'; -import type { AnalyticsClient } from '@algolia/client-analytics'; import { analyticsClient } from '@algolia/client-analytics'; -import type { InsightsClient } from '@algolia/client-insights'; -import { insightsClient } from '@algolia/client-insights'; -import type { PersonalizationClient } from '@algolia/client-personalization'; import { personalizationClient } from '@algolia/client-personalization'; -import type { QuerySuggestionsClient } from '@algolia/client-query-suggestions'; -import { querySuggestionsClient } from '@algolia/client-query-suggestions'; -import type { IngestionClient } from '@algolia/ingestion'; -import { ingestionClient } from '@algolia/ingestion'; -import type { MonitoringClient } from '@algolia/monitoring'; -import { monitoringClient } from '@algolia/monitoring'; -import type { RecommendClient } from '@algolia/recommend'; +import { searchClient } from '@algolia/client-search'; import { recommendClient } from '@algolia/recommend'; -import type { - AbtestingRegionOptions, - AnalyticsRegionOptions, - IngestionRegionOptions, - InitClientOptions, - InsightsRegionOptions, - PersonalizationRegionOptions, - QuerySuggestionsRegionOptions, -} from './models'; +import type { InitClientOptions, InitClientRegion } from './models'; export * from './models'; export type Algoliasearch = SearchClient & { - initAbtesting: (initOptions: InitClientOptions & AbtestingRegionOptions) => AbtestingClient; - initAnalytics: (initOptions: InitClientOptions & AnalyticsRegionOptions) => AnalyticsClient; - initIngestion: (initOptions: InitClientOptions & IngestionRegionOptions) => IngestionClient; - initInsights: (initOptions: InitClientOptions & InsightsRegionOptions) => InsightsClient; - initMonitoring: (initOptions: InitClientOptions) => MonitoringClient; - initPersonalization: (initOptions: InitClientOptions & PersonalizationRegionOptions) => PersonalizationClient; - initQuerySuggestions: (initOptions: InitClientOptions & QuerySuggestionsRegionOptions) => QuerySuggestionsClient; - initRecommend: (initOptions: InitClientOptions) => RecommendClient; + initRecommend: (initOptions?: InitClientOptions) => RecommendClient; + initAnalytics: (initOptions?: InitClientOptions & InitClientRegion) => AnalyticsClient; + initAbtesting: (initOptions?: InitClientOptions & InitClientRegion) => AbtestingClient; + initPersonalization: ( + initOptions: InitClientOptions & Required>, + ) => PersonalizationClient; }; export function algoliasearch(appId: string, apiKey: string, options?: ClientOptions): Algoliasearch { @@ -55,24 +39,17 @@ export function algoliasearch(appId: string, apiKey: string, options?: ClientOpt return { ...client, - /** * Get the value of the `algoliaAgent`, used by our libraries internally and telemetry system. */ get _ua(): string { return client.transporter.algoliaAgent.value; }, - - initAbtesting: (initOptions: InitClientOptions & AbtestingRegionOptions): AbtestingClient => { - return abtestingClient( - initOptions.appId || appId, - initOptions.apiKey || apiKey, - initOptions.region, - initOptions.options, - ); + initRecommend: (initOptions: InitClientOptions = {}): RecommendClient => { + return recommendClient(initOptions.appId || appId, initOptions.apiKey || apiKey, initOptions.options); }, - initAnalytics: (initOptions: InitClientOptions & AnalyticsRegionOptions): AnalyticsClient => { + initAnalytics: (initOptions: InitClientOptions & InitClientRegion = {}): AnalyticsClient => { return analyticsClient( initOptions.appId || appId, initOptions.apiKey || apiKey, @@ -81,17 +58,8 @@ export function algoliasearch(appId: string, apiKey: string, options?: ClientOpt ); }, - initIngestion: (initOptions: InitClientOptions & IngestionRegionOptions): IngestionClient => { - return ingestionClient( - initOptions.appId || appId, - initOptions.apiKey || apiKey, - initOptions.region, - initOptions.options, - ); - }, - - initInsights: (initOptions: InitClientOptions & InsightsRegionOptions): InsightsClient => { - return insightsClient( + initAbtesting: (initOptions: InitClientOptions & InitClientRegion = {}): AbtestingClient => { + return abtestingClient( initOptions.appId || appId, initOptions.apiKey || apiKey, initOptions.region, @@ -99,11 +67,9 @@ export function algoliasearch(appId: string, apiKey: string, options?: ClientOpt ); }, - initMonitoring: (initOptions: InitClientOptions): MonitoringClient => { - return monitoringClient(initOptions.appId || appId, initOptions.apiKey || apiKey, initOptions.options); - }, - - initPersonalization: (initOptions: InitClientOptions & PersonalizationRegionOptions): PersonalizationClient => { + initPersonalization: ( + initOptions: InitClientOptions & Required>, + ): PersonalizationClient => { return personalizationClient( initOptions.appId || appId, initOptions.apiKey || apiKey, @@ -111,18 +77,5 @@ export function algoliasearch(appId: string, apiKey: string, options?: ClientOpt initOptions.options, ); }, - - initQuerySuggestions: (initOptions: InitClientOptions & QuerySuggestionsRegionOptions): QuerySuggestionsClient => { - return querySuggestionsClient( - initOptions.appId || appId, - initOptions.apiKey || apiKey, - initOptions.region, - initOptions.options, - ); - }, - - initRecommend: (initOptions: InitClientOptions): RecommendClient => { - return recommendClient(initOptions.appId || appId, initOptions.apiKey || apiKey, initOptions.options); - }, }; } diff --git a/clients/algoliasearch-client-javascript/packages/algoliasearch/builds/fetch.ts b/clients/algoliasearch-client-javascript/packages/algoliasearch/builds/fetch.ts index 134c7258ce6..e1c5a385ef8 100644 --- a/clients/algoliasearch-client-javascript/packages/algoliasearch/builds/fetch.ts +++ b/clients/algoliasearch-client-javascript/packages/algoliasearch/builds/fetch.ts @@ -1,45 +1,29 @@ // Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT. +import type { AbtestingClient, Region as AbtestingRegion } from '@algolia/client-abtesting'; +import type { AnalyticsClient, Region as AnalyticsRegion } from '@algolia/client-analytics'; import type { ClientOptions } from '@algolia/client-common'; +import type { PersonalizationClient, Region as PersonalizationRegion } from '@algolia/client-personalization'; +import type { SearchClient } from '@algolia/client-search'; +import type { RecommendClient } from '@algolia/recommend'; -import type { AbtestingClient } from '@algolia/client-abtesting'; import { abtestingClient } from '@algolia/client-abtesting'; -import type { AnalyticsClient } from '@algolia/client-analytics'; import { analyticsClient } from '@algolia/client-analytics'; -import type { InsightsClient } from '@algolia/client-insights'; -import { insightsClient } from '@algolia/client-insights'; -import type { PersonalizationClient } from '@algolia/client-personalization'; import { personalizationClient } from '@algolia/client-personalization'; -import type { QuerySuggestionsClient } from '@algolia/client-query-suggestions'; -import { querySuggestionsClient } from '@algolia/client-query-suggestions'; -import type { IngestionClient } from '@algolia/ingestion'; -import { ingestionClient } from '@algolia/ingestion'; -import type { MonitoringClient } from '@algolia/monitoring'; -import { monitoringClient } from '@algolia/monitoring'; -import type { RecommendClient } from '@algolia/recommend'; +import { searchClient } from '@algolia/client-search'; import { recommendClient } from '@algolia/recommend'; -import type { - AbtestingRegionOptions, - AnalyticsRegionOptions, - IngestionRegionOptions, - InitClientOptions, - InsightsRegionOptions, - PersonalizationRegionOptions, - QuerySuggestionsRegionOptions, -} from './models'; +import type { InitClientOptions, InitClientRegion } from './models'; export * from './models'; export type Algoliasearch = SearchClient & { - initAbtesting: (initOptions: InitClientOptions & AbtestingRegionOptions) => AbtestingClient; - initAnalytics: (initOptions: InitClientOptions & AnalyticsRegionOptions) => AnalyticsClient; - initIngestion: (initOptions: InitClientOptions & IngestionRegionOptions) => IngestionClient; - initInsights: (initOptions: InitClientOptions & InsightsRegionOptions) => InsightsClient; - initMonitoring: (initOptions: InitClientOptions) => MonitoringClient; - initPersonalization: (initOptions: InitClientOptions & PersonalizationRegionOptions) => PersonalizationClient; - initQuerySuggestions: (initOptions: InitClientOptions & QuerySuggestionsRegionOptions) => QuerySuggestionsClient; - initRecommend: (initOptions: InitClientOptions) => RecommendClient; + initRecommend: (initOptions?: InitClientOptions) => RecommendClient; + initAnalytics: (initOptions?: InitClientOptions & InitClientRegion) => AnalyticsClient; + initAbtesting: (initOptions?: InitClientOptions & InitClientRegion) => AbtestingClient; + initPersonalization: ( + initOptions: InitClientOptions & Required>, + ) => PersonalizationClient; }; export function algoliasearch(appId: string, apiKey: string, options?: ClientOptions): Algoliasearch { @@ -55,24 +39,17 @@ export function algoliasearch(appId: string, apiKey: string, options?: ClientOpt return { ...client, - /** * Get the value of the `algoliaAgent`, used by our libraries internally and telemetry system. */ get _ua(): string { return client.transporter.algoliaAgent.value; }, - - initAbtesting: (initOptions: InitClientOptions & AbtestingRegionOptions): AbtestingClient => { - return abtestingClient( - initOptions.appId || appId, - initOptions.apiKey || apiKey, - initOptions.region, - initOptions.options, - ); + initRecommend: (initOptions: InitClientOptions = {}): RecommendClient => { + return recommendClient(initOptions.appId || appId, initOptions.apiKey || apiKey, initOptions.options); }, - initAnalytics: (initOptions: InitClientOptions & AnalyticsRegionOptions): AnalyticsClient => { + initAnalytics: (initOptions: InitClientOptions & InitClientRegion = {}): AnalyticsClient => { return analyticsClient( initOptions.appId || appId, initOptions.apiKey || apiKey, @@ -81,17 +58,8 @@ export function algoliasearch(appId: string, apiKey: string, options?: ClientOpt ); }, - initIngestion: (initOptions: InitClientOptions & IngestionRegionOptions): IngestionClient => { - return ingestionClient( - initOptions.appId || appId, - initOptions.apiKey || apiKey, - initOptions.region, - initOptions.options, - ); - }, - - initInsights: (initOptions: InitClientOptions & InsightsRegionOptions): InsightsClient => { - return insightsClient( + initAbtesting: (initOptions: InitClientOptions & InitClientRegion = {}): AbtestingClient => { + return abtestingClient( initOptions.appId || appId, initOptions.apiKey || apiKey, initOptions.region, @@ -99,11 +67,9 @@ export function algoliasearch(appId: string, apiKey: string, options?: ClientOpt ); }, - initMonitoring: (initOptions: InitClientOptions): MonitoringClient => { - return monitoringClient(initOptions.appId || appId, initOptions.apiKey || apiKey, initOptions.options); - }, - - initPersonalization: (initOptions: InitClientOptions & PersonalizationRegionOptions): PersonalizationClient => { + initPersonalization: ( + initOptions: InitClientOptions & Required>, + ): PersonalizationClient => { return personalizationClient( initOptions.appId || appId, initOptions.apiKey || apiKey, @@ -111,18 +77,5 @@ export function algoliasearch(appId: string, apiKey: string, options?: ClientOpt initOptions.options, ); }, - - initQuerySuggestions: (initOptions: InitClientOptions & QuerySuggestionsRegionOptions): QuerySuggestionsClient => { - return querySuggestionsClient( - initOptions.appId || appId, - initOptions.apiKey || apiKey, - initOptions.region, - initOptions.options, - ); - }, - - initRecommend: (initOptions: InitClientOptions): RecommendClient => { - return recommendClient(initOptions.appId || appId, initOptions.apiKey || apiKey, initOptions.options); - }, }; } diff --git a/clients/algoliasearch-client-javascript/packages/algoliasearch/builds/models.ts b/clients/algoliasearch-client-javascript/packages/algoliasearch/builds/models.ts index 86c330dfa3b..201e705bab7 100644 --- a/clients/algoliasearch-client-javascript/packages/algoliasearch/builds/models.ts +++ b/clients/algoliasearch-client-javascript/packages/algoliasearch/builds/models.ts @@ -1,24 +1,9 @@ // Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT. -import type { Region as AbtestingRegion, RegionOptions as AbtestingRegionOptions } from '@algolia/client-abtesting'; -import type { Region as AnalyticsRegion, RegionOptions as AnalyticsRegionOptions } from '@algolia/client-analytics'; -import type { Region as InsightsRegion, RegionOptions as InsightsRegionOptions } from '@algolia/client-insights'; -import type { Region as IngestionRegion, RegionOptions as IngestionRegionOptions } from '@algolia/ingestion'; - -import type { - Region as PersonalizationRegion, - RegionOptions as PersonalizationRegionOptions, -} from '@algolia/client-personalization'; -import type { - Region as QuerySuggestionsRegion, - RegionOptions as QuerySuggestionsRegionOptions, -} from '@algolia/client-query-suggestions'; - -import { Status } from '@algolia/client-abtesting'; +import type { Region as AbTestingRegion } from '@algolia/client-abtesting'; +import type { Region as AnalyticsRegion } from '@algolia/client-analytics'; import type { ClientOptions } from '@algolia/client-common'; -import { EventType } from '@algolia/client-personalization'; import type { - Action, AdvancedSyntaxFeatures, AlternativesAsExact, Anchoring, @@ -46,7 +31,6 @@ import type { CustomGetProps, CustomPostProps, CustomPutProps, - DeleteSourceProps, DeletedAtResponse, Distinct, Edit, @@ -56,16 +40,14 @@ import type { Exhaustive, FacetFilters, FacetOrdering, - FacetStats, Facets, - GetTaskProps, + FacetStats, HighlightResult, HighlightResultOption, IgnorePlurals, IndexSettingsAsSearchParams, - Languages, - MatchLevel, MatchedGeoLocation, + MatchLevel, Mode, NumericFilters, OptionalFilters, @@ -77,7 +59,6 @@ import type { QueryType, Range, RankingInfo, - ReRankingApplyFilter, Redirect, RedirectRuleIndexData, RedirectRuleIndexMetadata, @@ -85,6 +66,7 @@ import type { RemoveStopWords, RemoveWordsIfNoResults, RenderingContent, + ReRankingApplyFilter, SearchPagination, SearchParams, SearchParamsObject, @@ -93,7 +75,6 @@ import type { SnippetResult, SnippetResultOption, SortRemainingBy, - Source, SupportedLanguage, TagFilters, TaskStatus, @@ -105,39 +86,21 @@ import type { } from '@algolia/client-search'; import { apiClientVersion } from '@algolia/client-search'; -type Region = - | AbtestingRegion - | AnalyticsRegion - | IngestionRegion - | InsightsRegion - | PersonalizationRegion - | QuerySuggestionsRegion; -type RegionOptions = - | AbtestingRegionOptions - | AnalyticsRegionOptions - | IngestionRegionOptions - | InsightsRegionOptions - | PersonalizationRegionOptions - | QuerySuggestionsRegionOptions; +type Region = AbTestingRegion | AnalyticsRegion; export * from '@algolia/client-abtesting'; export * from '@algolia/client-analytics'; -export * from '@algolia/client-insights'; export * from '@algolia/client-personalization'; -export * from '@algolia/client-query-suggestions'; -export * from '@algolia/ingestion'; -export * from '@algolia/monitoring'; +export * from '@algolia/client-search'; export * from '@algolia/recommend'; export { - AbtestingRegion, - AbtestingRegionOptions, - Action, + AbTestingRegion, AdvancedSyntaxFeatures, AlternativesAsExact, AnalyticsRegion, - AnalyticsRegionOptions, Anchoring, + apiClientVersion, AroundPrecision, AroundRadius, AroundRadiusAll, @@ -162,56 +125,43 @@ export { CustomGetProps, CustomPostProps, CustomPutProps, - DeleteSourceProps, DeletedAtResponse, Distinct, Edit, EditType, ErrorBase, - EventType, ExactOnSingleWordQuery, Exhaustive, FacetFilters, FacetOrdering, - FacetStats, Facets, - GetTaskProps, + FacetStats, HighlightResult, HighlightResultOption, IgnorePlurals, IndexSettingsAsSearchParams, - IngestionRegion, - IngestionRegionOptions, - InsightsRegion, - InsightsRegionOptions, - Languages, - MatchLevel, MatchedGeoLocation, + MatchLevel, Mode, NumericFilters, OptionalFilters, Params, Personalization, - PersonalizationRegion, - PersonalizationRegionOptions, Promote, PromoteObjectID, PromoteObjectIDs, - QuerySuggestionsRegion, - QuerySuggestionsRegionOptions, QueryType, Range, RankingInfo, - ReRankingApplyFilter, Redirect, RedirectRuleIndexData, RedirectRuleIndexMetadata, RedirectURL, Region, - RegionOptions, RemoveStopWords, RemoveWordsIfNoResults, RenderingContent, + ReRankingApplyFilter, SearchPagination, SearchParams, SearchParamsObject, @@ -220,8 +170,6 @@ export { SnippetResult, SnippetResultOption, SortRemainingBy, - Source, - Status, SupportedLanguage, TagFilters, TaskStatus, @@ -230,7 +178,6 @@ export { TypoToleranceEnum, Value, Widgets, - apiClientVersion, }; /** @@ -247,3 +194,10 @@ export type InitClientOptions = Partial<{ apiKey: string; options: ClientOptions; }>; + +export type InitClientRegion = Partial<{ + /** + * Available regions of the initialized client. + */ + region: TRegion; +}>; diff --git a/clients/algoliasearch-client-javascript/packages/algoliasearch/builds/node.ts b/clients/algoliasearch-client-javascript/packages/algoliasearch/builds/node.ts index 134c7258ce6..e1c5a385ef8 100644 --- a/clients/algoliasearch-client-javascript/packages/algoliasearch/builds/node.ts +++ b/clients/algoliasearch-client-javascript/packages/algoliasearch/builds/node.ts @@ -1,45 +1,29 @@ // Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT. +import type { AbtestingClient, Region as AbtestingRegion } from '@algolia/client-abtesting'; +import type { AnalyticsClient, Region as AnalyticsRegion } from '@algolia/client-analytics'; import type { ClientOptions } from '@algolia/client-common'; +import type { PersonalizationClient, Region as PersonalizationRegion } from '@algolia/client-personalization'; +import type { SearchClient } from '@algolia/client-search'; +import type { RecommendClient } from '@algolia/recommend'; -import type { AbtestingClient } from '@algolia/client-abtesting'; import { abtestingClient } from '@algolia/client-abtesting'; -import type { AnalyticsClient } from '@algolia/client-analytics'; import { analyticsClient } from '@algolia/client-analytics'; -import type { InsightsClient } from '@algolia/client-insights'; -import { insightsClient } from '@algolia/client-insights'; -import type { PersonalizationClient } from '@algolia/client-personalization'; import { personalizationClient } from '@algolia/client-personalization'; -import type { QuerySuggestionsClient } from '@algolia/client-query-suggestions'; -import { querySuggestionsClient } from '@algolia/client-query-suggestions'; -import type { IngestionClient } from '@algolia/ingestion'; -import { ingestionClient } from '@algolia/ingestion'; -import type { MonitoringClient } from '@algolia/monitoring'; -import { monitoringClient } from '@algolia/monitoring'; -import type { RecommendClient } from '@algolia/recommend'; +import { searchClient } from '@algolia/client-search'; import { recommendClient } from '@algolia/recommend'; -import type { - AbtestingRegionOptions, - AnalyticsRegionOptions, - IngestionRegionOptions, - InitClientOptions, - InsightsRegionOptions, - PersonalizationRegionOptions, - QuerySuggestionsRegionOptions, -} from './models'; +import type { InitClientOptions, InitClientRegion } from './models'; export * from './models'; export type Algoliasearch = SearchClient & { - initAbtesting: (initOptions: InitClientOptions & AbtestingRegionOptions) => AbtestingClient; - initAnalytics: (initOptions: InitClientOptions & AnalyticsRegionOptions) => AnalyticsClient; - initIngestion: (initOptions: InitClientOptions & IngestionRegionOptions) => IngestionClient; - initInsights: (initOptions: InitClientOptions & InsightsRegionOptions) => InsightsClient; - initMonitoring: (initOptions: InitClientOptions) => MonitoringClient; - initPersonalization: (initOptions: InitClientOptions & PersonalizationRegionOptions) => PersonalizationClient; - initQuerySuggestions: (initOptions: InitClientOptions & QuerySuggestionsRegionOptions) => QuerySuggestionsClient; - initRecommend: (initOptions: InitClientOptions) => RecommendClient; + initRecommend: (initOptions?: InitClientOptions) => RecommendClient; + initAnalytics: (initOptions?: InitClientOptions & InitClientRegion) => AnalyticsClient; + initAbtesting: (initOptions?: InitClientOptions & InitClientRegion) => AbtestingClient; + initPersonalization: ( + initOptions: InitClientOptions & Required>, + ) => PersonalizationClient; }; export function algoliasearch(appId: string, apiKey: string, options?: ClientOptions): Algoliasearch { @@ -55,24 +39,17 @@ export function algoliasearch(appId: string, apiKey: string, options?: ClientOpt return { ...client, - /** * Get the value of the `algoliaAgent`, used by our libraries internally and telemetry system. */ get _ua(): string { return client.transporter.algoliaAgent.value; }, - - initAbtesting: (initOptions: InitClientOptions & AbtestingRegionOptions): AbtestingClient => { - return abtestingClient( - initOptions.appId || appId, - initOptions.apiKey || apiKey, - initOptions.region, - initOptions.options, - ); + initRecommend: (initOptions: InitClientOptions = {}): RecommendClient => { + return recommendClient(initOptions.appId || appId, initOptions.apiKey || apiKey, initOptions.options); }, - initAnalytics: (initOptions: InitClientOptions & AnalyticsRegionOptions): AnalyticsClient => { + initAnalytics: (initOptions: InitClientOptions & InitClientRegion = {}): AnalyticsClient => { return analyticsClient( initOptions.appId || appId, initOptions.apiKey || apiKey, @@ -81,17 +58,8 @@ export function algoliasearch(appId: string, apiKey: string, options?: ClientOpt ); }, - initIngestion: (initOptions: InitClientOptions & IngestionRegionOptions): IngestionClient => { - return ingestionClient( - initOptions.appId || appId, - initOptions.apiKey || apiKey, - initOptions.region, - initOptions.options, - ); - }, - - initInsights: (initOptions: InitClientOptions & InsightsRegionOptions): InsightsClient => { - return insightsClient( + initAbtesting: (initOptions: InitClientOptions & InitClientRegion = {}): AbtestingClient => { + return abtestingClient( initOptions.appId || appId, initOptions.apiKey || apiKey, initOptions.region, @@ -99,11 +67,9 @@ export function algoliasearch(appId: string, apiKey: string, options?: ClientOpt ); }, - initMonitoring: (initOptions: InitClientOptions): MonitoringClient => { - return monitoringClient(initOptions.appId || appId, initOptions.apiKey || apiKey, initOptions.options); - }, - - initPersonalization: (initOptions: InitClientOptions & PersonalizationRegionOptions): PersonalizationClient => { + initPersonalization: ( + initOptions: InitClientOptions & Required>, + ): PersonalizationClient => { return personalizationClient( initOptions.appId || appId, initOptions.apiKey || apiKey, @@ -111,18 +77,5 @@ export function algoliasearch(appId: string, apiKey: string, options?: ClientOpt initOptions.options, ); }, - - initQuerySuggestions: (initOptions: InitClientOptions & QuerySuggestionsRegionOptions): QuerySuggestionsClient => { - return querySuggestionsClient( - initOptions.appId || appId, - initOptions.apiKey || apiKey, - initOptions.region, - initOptions.options, - ); - }, - - initRecommend: (initOptions: InitClientOptions): RecommendClient => { - return recommendClient(initOptions.appId || appId, initOptions.apiKey || apiKey, initOptions.options); - }, }; } diff --git a/clients/algoliasearch-client-javascript/packages/algoliasearch/package.json b/clients/algoliasearch-client-javascript/packages/algoliasearch/package.json index ce589ccce21..2495cb9578e 100644 --- a/clients/algoliasearch-client-javascript/packages/algoliasearch/package.json +++ b/clients/algoliasearch-client-javascript/packages/algoliasearch/package.json @@ -75,28 +75,25 @@ "dependencies": { "@algolia/client-abtesting": "5.8.1", "@algolia/client-analytics": "5.8.1", - "@algolia/ingestion": "1.8.1", - "@algolia/client-insights": "5.8.1", - "@algolia/monitoring": "1.8.1", + "@algolia/client-common": "5.8.1", "@algolia/client-personalization": "5.8.1", - "@algolia/client-query-suggestions": "5.8.1", + "@algolia/client-search": "5.8.1", "@algolia/recommend": "5.8.1", - "@algolia/client-common": "5.8.1", "@algolia/requester-browser-xhr": "5.8.1", - "@algolia/requester-node-http": "5.8.1", - "@algolia/requester-fetch": "5.8.1" + "@algolia/requester-fetch": "5.8.1", + "@algolia/requester-node-http": "5.8.1" }, "devDependencies": { "@algolia/requester-testing": "5.8.1", - "vitest-environment-miniflare": "2.14.3", - "jsdom": "25.0.1", - "vitest": "2.1.2", "@arethetypeswrong/cli": "0.16.4", "@types/node": "22.7.4", + "jsdom": "25.0.1", "publint": "0.2.11", "rollup": "4.24.0", "tsup": "8.3.0", - "typescript": "5.6.2" + "typescript": "5.6.2", + "vitest": "2.1.2", + "vitest-environment-miniflare": "2.14.3" }, "engines": { "node": ">= 14.0.0" diff --git a/clients/algoliasearch-client-javascript/packages/client-abtesting/builds/browser.ts b/clients/algoliasearch-client-javascript/packages/client-abtesting/builds/browser.ts index f2f61631889..aee47c7d87d 100644 --- a/clients/algoliasearch-client-javascript/packages/client-abtesting/builds/browser.ts +++ b/clients/algoliasearch-client-javascript/packages/client-abtesting/builds/browser.ts @@ -18,7 +18,7 @@ import { apiClientVersion, createAbtestingClient } from '../src/abtestingClient' import { Region, REGIONS } from '../src/abtestingClient'; export * from '../model'; -export { apiClientVersion, Region, RegionOptions } from '../src/abtestingClient'; +export { apiClientVersion, Region } from '../src/abtestingClient'; export function abtestingClient( appId: string, diff --git a/clients/algoliasearch-client-javascript/packages/client-abtesting/builds/fetch.ts b/clients/algoliasearch-client-javascript/packages/client-abtesting/builds/fetch.ts index d22f10a74f3..16d3e1fcb3d 100644 --- a/clients/algoliasearch-client-javascript/packages/client-abtesting/builds/fetch.ts +++ b/clients/algoliasearch-client-javascript/packages/client-abtesting/builds/fetch.ts @@ -18,7 +18,7 @@ import { createAbtestingClient } from '../src/abtestingClient'; import { Region, REGIONS } from '../src/abtestingClient'; export * from '../model'; -export { apiClientVersion, Region, RegionOptions } from '../src/abtestingClient'; +export { apiClientVersion, Region } from '../src/abtestingClient'; export function abtestingClient( appId: string, diff --git a/clients/algoliasearch-client-javascript/packages/client-abtesting/builds/node.ts b/clients/algoliasearch-client-javascript/packages/client-abtesting/builds/node.ts index 6f22aa10751..d25e259991b 100644 --- a/clients/algoliasearch-client-javascript/packages/client-abtesting/builds/node.ts +++ b/clients/algoliasearch-client-javascript/packages/client-abtesting/builds/node.ts @@ -19,7 +19,7 @@ import { createAbtestingClient } from '../src/abtestingClient'; import { Region, REGIONS } from '../src/abtestingClient'; export * from '../model'; -export { apiClientVersion, Region, RegionOptions } from '../src/abtestingClient'; +export { apiClientVersion, Region } from '../src/abtestingClient'; export function abtestingClient( appId: string, diff --git a/clients/algoliasearch-client-javascript/packages/client-abtesting/package.json b/clients/algoliasearch-client-javascript/packages/client-abtesting/package.json index 0c1b989f9ee..ea574a67e90 100644 --- a/clients/algoliasearch-client-javascript/packages/client-abtesting/package.json +++ b/clients/algoliasearch-client-javascript/packages/client-abtesting/package.json @@ -51,8 +51,8 @@ "dependencies": { "@algolia/client-common": "5.8.1", "@algolia/requester-browser-xhr": "5.8.1", - "@algolia/requester-node-http": "5.8.1", - "@algolia/requester-fetch": "5.8.1" + "@algolia/requester-fetch": "5.8.1", + "@algolia/requester-node-http": "5.8.1" }, "devDependencies": { "@arethetypeswrong/cli": "0.16.4", diff --git a/clients/algoliasearch-client-javascript/packages/client-abtesting/src/abtestingClient.ts b/clients/algoliasearch-client-javascript/packages/client-abtesting/src/abtestingClient.ts index a95f60c2862..56cb483f009 100644 --- a/clients/algoliasearch-client-javascript/packages/client-abtesting/src/abtestingClient.ts +++ b/clients/algoliasearch-client-javascript/packages/client-abtesting/src/abtestingClient.ts @@ -33,7 +33,6 @@ export const apiClientVersion = '5.8.1'; export const REGIONS = ['de', 'us'] as const; export type Region = (typeof REGIONS)[number]; -export type RegionOptions = { region?: Region }; function getDefaultHosts(region?: Region): Host[] { const url = !region ? 'analytics.algolia.com' : 'analytics.{region}.algolia.com'.replace('{region}', region); @@ -48,7 +47,7 @@ export function createAbtestingClient({ algoliaAgents, region: regionOption, ...options -}: CreateClientOptions & RegionOptions) { +}: CreateClientOptions & { region?: Region }) { const auth = createAuth(appIdOption, apiKeyOption, authMode); const transporter = createTransporter({ hosts: getDefaultHosts(regionOption), diff --git a/clients/algoliasearch-client-javascript/packages/client-analytics/builds/browser.ts b/clients/algoliasearch-client-javascript/packages/client-analytics/builds/browser.ts index c5be547d34a..9323837065e 100644 --- a/clients/algoliasearch-client-javascript/packages/client-analytics/builds/browser.ts +++ b/clients/algoliasearch-client-javascript/packages/client-analytics/builds/browser.ts @@ -18,7 +18,7 @@ import { apiClientVersion, createAnalyticsClient } from '../src/analyticsClient' import { Region, REGIONS } from '../src/analyticsClient'; export * from '../model'; -export { apiClientVersion, Region, RegionOptions } from '../src/analyticsClient'; +export { apiClientVersion, Region } from '../src/analyticsClient'; export function analyticsClient( appId: string, diff --git a/clients/algoliasearch-client-javascript/packages/client-analytics/builds/fetch.ts b/clients/algoliasearch-client-javascript/packages/client-analytics/builds/fetch.ts index 0346bb524e7..c6baa6e2b53 100644 --- a/clients/algoliasearch-client-javascript/packages/client-analytics/builds/fetch.ts +++ b/clients/algoliasearch-client-javascript/packages/client-analytics/builds/fetch.ts @@ -18,7 +18,7 @@ import { createAnalyticsClient } from '../src/analyticsClient'; import { Region, REGIONS } from '../src/analyticsClient'; export * from '../model'; -export { apiClientVersion, Region, RegionOptions } from '../src/analyticsClient'; +export { apiClientVersion, Region } from '../src/analyticsClient'; export function analyticsClient( appId: string, diff --git a/clients/algoliasearch-client-javascript/packages/client-analytics/builds/node.ts b/clients/algoliasearch-client-javascript/packages/client-analytics/builds/node.ts index 5cdabba3822..1adcd4ce33d 100644 --- a/clients/algoliasearch-client-javascript/packages/client-analytics/builds/node.ts +++ b/clients/algoliasearch-client-javascript/packages/client-analytics/builds/node.ts @@ -19,7 +19,7 @@ import { createAnalyticsClient } from '../src/analyticsClient'; import { Region, REGIONS } from '../src/analyticsClient'; export * from '../model'; -export { apiClientVersion, Region, RegionOptions } from '../src/analyticsClient'; +export { apiClientVersion, Region } from '../src/analyticsClient'; export function analyticsClient( appId: string, diff --git a/clients/algoliasearch-client-javascript/packages/client-analytics/package.json b/clients/algoliasearch-client-javascript/packages/client-analytics/package.json index 2a5ff5dd5a0..ff597f11834 100644 --- a/clients/algoliasearch-client-javascript/packages/client-analytics/package.json +++ b/clients/algoliasearch-client-javascript/packages/client-analytics/package.json @@ -51,8 +51,8 @@ "dependencies": { "@algolia/client-common": "5.8.1", "@algolia/requester-browser-xhr": "5.8.1", - "@algolia/requester-node-http": "5.8.1", - "@algolia/requester-fetch": "5.8.1" + "@algolia/requester-fetch": "5.8.1", + "@algolia/requester-node-http": "5.8.1" }, "devDependencies": { "@arethetypeswrong/cli": "0.16.4", diff --git a/clients/algoliasearch-client-javascript/packages/client-analytics/src/analyticsClient.ts b/clients/algoliasearch-client-javascript/packages/client-analytics/src/analyticsClient.ts index ad503f32e0f..894d17bc07e 100644 --- a/clients/algoliasearch-client-javascript/packages/client-analytics/src/analyticsClient.ts +++ b/clients/algoliasearch-client-javascript/packages/client-analytics/src/analyticsClient.ts @@ -62,7 +62,6 @@ export const apiClientVersion = '5.8.1'; export const REGIONS = ['de', 'us'] as const; export type Region = (typeof REGIONS)[number]; -export type RegionOptions = { region?: Region }; function getDefaultHosts(region?: Region): Host[] { const url = !region ? 'analytics.algolia.com' : 'analytics.{region}.algolia.com'.replace('{region}', region); @@ -77,7 +76,7 @@ export function createAnalyticsClient({ algoliaAgents, region: regionOption, ...options -}: CreateClientOptions & RegionOptions) { +}: CreateClientOptions & { region?: Region }) { const auth = createAuth(appIdOption, apiKeyOption, authMode); const transporter = createTransporter({ hosts: getDefaultHosts(regionOption), diff --git a/clients/algoliasearch-client-javascript/packages/client-insights/README.md b/clients/algoliasearch-client-javascript/packages/client-insights/README.md index 4d0d0729d3c..134d4be49e2 100644 --- a/clients/algoliasearch-client-javascript/packages/client-insights/README.md +++ b/clients/algoliasearch-client-javascript/packages/client-insights/README.md @@ -32,9 +32,6 @@ ## 💡 Getting Started -> [!TIP] -> This API client is already a dependency of [the algoliasearch client](https://www.npmjs.com/package/algoliasearch), you don't need to manually install `@algolia/client-insights` if you already have `algoliasearch` installed. - To get started, you first need to install @algolia/client-insights (or any other available API client package). All of our clients comes with type definition, and are available for both browser and node environments. diff --git a/clients/algoliasearch-client-javascript/packages/client-insights/builds/browser.ts b/clients/algoliasearch-client-javascript/packages/client-insights/builds/browser.ts index df14d9bc860..3fece73cc7a 100644 --- a/clients/algoliasearch-client-javascript/packages/client-insights/builds/browser.ts +++ b/clients/algoliasearch-client-javascript/packages/client-insights/builds/browser.ts @@ -18,7 +18,7 @@ import { apiClientVersion, createInsightsClient } from '../src/insightsClient'; import { Region, REGIONS } from '../src/insightsClient'; export * from '../model'; -export { apiClientVersion, Region, RegionOptions } from '../src/insightsClient'; +export { apiClientVersion, Region } from '../src/insightsClient'; export function insightsClient( appId: string, diff --git a/clients/algoliasearch-client-javascript/packages/client-insights/builds/fetch.ts b/clients/algoliasearch-client-javascript/packages/client-insights/builds/fetch.ts index 90545757ea5..363f8626be0 100644 --- a/clients/algoliasearch-client-javascript/packages/client-insights/builds/fetch.ts +++ b/clients/algoliasearch-client-javascript/packages/client-insights/builds/fetch.ts @@ -18,7 +18,7 @@ import { createInsightsClient } from '../src/insightsClient'; import { Region, REGIONS } from '../src/insightsClient'; export * from '../model'; -export { apiClientVersion, Region, RegionOptions } from '../src/insightsClient'; +export { apiClientVersion, Region } from '../src/insightsClient'; export function insightsClient( appId: string, diff --git a/clients/algoliasearch-client-javascript/packages/client-insights/builds/node.ts b/clients/algoliasearch-client-javascript/packages/client-insights/builds/node.ts index 10ef870918d..b3bb7ceb170 100644 --- a/clients/algoliasearch-client-javascript/packages/client-insights/builds/node.ts +++ b/clients/algoliasearch-client-javascript/packages/client-insights/builds/node.ts @@ -19,7 +19,7 @@ import { createInsightsClient } from '../src/insightsClient'; import { Region, REGIONS } from '../src/insightsClient'; export * from '../model'; -export { apiClientVersion, Region, RegionOptions } from '../src/insightsClient'; +export { apiClientVersion, Region } from '../src/insightsClient'; export function insightsClient( appId: string, diff --git a/clients/algoliasearch-client-javascript/packages/client-insights/package.json b/clients/algoliasearch-client-javascript/packages/client-insights/package.json index 07c67b504ce..956bd77e690 100644 --- a/clients/algoliasearch-client-javascript/packages/client-insights/package.json +++ b/clients/algoliasearch-client-javascript/packages/client-insights/package.json @@ -51,8 +51,8 @@ "dependencies": { "@algolia/client-common": "5.8.1", "@algolia/requester-browser-xhr": "5.8.1", - "@algolia/requester-node-http": "5.8.1", - "@algolia/requester-fetch": "5.8.1" + "@algolia/requester-fetch": "5.8.1", + "@algolia/requester-node-http": "5.8.1" }, "devDependencies": { "@arethetypeswrong/cli": "0.16.4", diff --git a/clients/algoliasearch-client-javascript/packages/client-insights/src/insightsClient.ts b/clients/algoliasearch-client-javascript/packages/client-insights/src/insightsClient.ts index 663e2eb0aa9..97daf1b8da1 100644 --- a/clients/algoliasearch-client-javascript/packages/client-insights/src/insightsClient.ts +++ b/clients/algoliasearch-client-javascript/packages/client-insights/src/insightsClient.ts @@ -25,7 +25,6 @@ export const apiClientVersion = '5.8.1'; export const REGIONS = ['de', 'us'] as const; export type Region = (typeof REGIONS)[number]; -export type RegionOptions = { region?: Region }; function getDefaultHosts(region?: Region): Host[] { const url = !region ? 'insights.algolia.io' : 'insights.{region}.algolia.io'.replace('{region}', region); @@ -40,7 +39,7 @@ export function createInsightsClient({ algoliaAgents, region: regionOption, ...options -}: CreateClientOptions & RegionOptions) { +}: CreateClientOptions & { region?: Region }) { const auth = createAuth(appIdOption, apiKeyOption, authMode); const transporter = createTransporter({ hosts: getDefaultHosts(regionOption), diff --git a/clients/algoliasearch-client-javascript/packages/client-personalization/builds/browser.ts b/clients/algoliasearch-client-javascript/packages/client-personalization/builds/browser.ts index b7f7657cc52..a373c9543e2 100644 --- a/clients/algoliasearch-client-javascript/packages/client-personalization/builds/browser.ts +++ b/clients/algoliasearch-client-javascript/packages/client-personalization/builds/browser.ts @@ -18,7 +18,7 @@ import { apiClientVersion, createPersonalizationClient } from '../src/personaliz import { Region, REGIONS } from '../src/personalizationClient'; export * from '../model'; -export { apiClientVersion, Region, RegionOptions } from '../src/personalizationClient'; +export { apiClientVersion, Region } from '../src/personalizationClient'; export function personalizationClient( appId: string, diff --git a/clients/algoliasearch-client-javascript/packages/client-personalization/builds/fetch.ts b/clients/algoliasearch-client-javascript/packages/client-personalization/builds/fetch.ts index 037a0f58e42..7d5c879d331 100644 --- a/clients/algoliasearch-client-javascript/packages/client-personalization/builds/fetch.ts +++ b/clients/algoliasearch-client-javascript/packages/client-personalization/builds/fetch.ts @@ -18,7 +18,7 @@ import { createPersonalizationClient } from '../src/personalizationClient'; import { Region, REGIONS } from '../src/personalizationClient'; export * from '../model'; -export { apiClientVersion, Region, RegionOptions } from '../src/personalizationClient'; +export { apiClientVersion, Region } from '../src/personalizationClient'; export function personalizationClient( appId: string, diff --git a/clients/algoliasearch-client-javascript/packages/client-personalization/builds/node.ts b/clients/algoliasearch-client-javascript/packages/client-personalization/builds/node.ts index ac32f8cf206..d08aeadc13b 100644 --- a/clients/algoliasearch-client-javascript/packages/client-personalization/builds/node.ts +++ b/clients/algoliasearch-client-javascript/packages/client-personalization/builds/node.ts @@ -19,7 +19,7 @@ import { createPersonalizationClient } from '../src/personalizationClient'; import { Region, REGIONS } from '../src/personalizationClient'; export * from '../model'; -export { apiClientVersion, Region, RegionOptions } from '../src/personalizationClient'; +export { apiClientVersion, Region } from '../src/personalizationClient'; export function personalizationClient( appId: string, diff --git a/clients/algoliasearch-client-javascript/packages/client-personalization/package.json b/clients/algoliasearch-client-javascript/packages/client-personalization/package.json index f13750d9a5d..99d668b37a8 100644 --- a/clients/algoliasearch-client-javascript/packages/client-personalization/package.json +++ b/clients/algoliasearch-client-javascript/packages/client-personalization/package.json @@ -51,8 +51,8 @@ "dependencies": { "@algolia/client-common": "5.8.1", "@algolia/requester-browser-xhr": "5.8.1", - "@algolia/requester-node-http": "5.8.1", - "@algolia/requester-fetch": "5.8.1" + "@algolia/requester-fetch": "5.8.1", + "@algolia/requester-node-http": "5.8.1" }, "devDependencies": { "@arethetypeswrong/cli": "0.16.4", diff --git a/clients/algoliasearch-client-javascript/packages/client-personalization/src/personalizationClient.ts b/clients/algoliasearch-client-javascript/packages/client-personalization/src/personalizationClient.ts index 05f29235d11..8e4f0d7dae7 100644 --- a/clients/algoliasearch-client-javascript/packages/client-personalization/src/personalizationClient.ts +++ b/clients/algoliasearch-client-javascript/packages/client-personalization/src/personalizationClient.ts @@ -29,7 +29,6 @@ export const apiClientVersion = '5.8.1'; export const REGIONS = ['eu', 'us'] as const; export type Region = (typeof REGIONS)[number]; -export type RegionOptions = { region: Region }; function getDefaultHosts(region: Region): Host[] { const url = 'personalization.{region}.algolia.com'.replace('{region}', region); @@ -44,7 +43,7 @@ export function createPersonalizationClient({ algoliaAgents, region: regionOption, ...options -}: CreateClientOptions & RegionOptions) { +}: CreateClientOptions & { region: Region }) { const auth = createAuth(appIdOption, apiKeyOption, authMode); const transporter = createTransporter({ hosts: getDefaultHosts(regionOption), diff --git a/clients/algoliasearch-client-javascript/packages/client-query-suggestions/README.md b/clients/algoliasearch-client-javascript/packages/client-query-suggestions/README.md index 717d2f59a66..158d31cd95c 100644 --- a/clients/algoliasearch-client-javascript/packages/client-query-suggestions/README.md +++ b/clients/algoliasearch-client-javascript/packages/client-query-suggestions/README.md @@ -32,9 +32,6 @@ ## 💡 Getting Started -> [!TIP] -> This API client is already a dependency of [the algoliasearch client](https://www.npmjs.com/package/algoliasearch), you don't need to manually install `@algolia/client-query-suggestions` if you already have `algoliasearch` installed. - To get started, you first need to install @algolia/client-query-suggestions (or any other available API client package). All of our clients comes with type definition, and are available for both browser and node environments. diff --git a/clients/algoliasearch-client-javascript/packages/client-query-suggestions/builds/browser.ts b/clients/algoliasearch-client-javascript/packages/client-query-suggestions/builds/browser.ts index 9b4a08a8ae3..8f10336dfad 100644 --- a/clients/algoliasearch-client-javascript/packages/client-query-suggestions/builds/browser.ts +++ b/clients/algoliasearch-client-javascript/packages/client-query-suggestions/builds/browser.ts @@ -18,7 +18,7 @@ import { apiClientVersion, createQuerySuggestionsClient } from '../src/querySugg import { Region, REGIONS } from '../src/querySuggestionsClient'; export * from '../model'; -export { apiClientVersion, Region, RegionOptions } from '../src/querySuggestionsClient'; +export { apiClientVersion, Region } from '../src/querySuggestionsClient'; export function querySuggestionsClient( appId: string, diff --git a/clients/algoliasearch-client-javascript/packages/client-query-suggestions/builds/fetch.ts b/clients/algoliasearch-client-javascript/packages/client-query-suggestions/builds/fetch.ts index 4114d54fda3..439861d428f 100644 --- a/clients/algoliasearch-client-javascript/packages/client-query-suggestions/builds/fetch.ts +++ b/clients/algoliasearch-client-javascript/packages/client-query-suggestions/builds/fetch.ts @@ -18,7 +18,7 @@ import { createQuerySuggestionsClient } from '../src/querySuggestionsClient'; import { Region, REGIONS } from '../src/querySuggestionsClient'; export * from '../model'; -export { apiClientVersion, Region, RegionOptions } from '../src/querySuggestionsClient'; +export { apiClientVersion, Region } from '../src/querySuggestionsClient'; export function querySuggestionsClient( appId: string, diff --git a/clients/algoliasearch-client-javascript/packages/client-query-suggestions/builds/node.ts b/clients/algoliasearch-client-javascript/packages/client-query-suggestions/builds/node.ts index eabb8ab6936..5c3031adf54 100644 --- a/clients/algoliasearch-client-javascript/packages/client-query-suggestions/builds/node.ts +++ b/clients/algoliasearch-client-javascript/packages/client-query-suggestions/builds/node.ts @@ -19,7 +19,7 @@ import { createQuerySuggestionsClient } from '../src/querySuggestionsClient'; import { Region, REGIONS } from '../src/querySuggestionsClient'; export * from '../model'; -export { apiClientVersion, Region, RegionOptions } from '../src/querySuggestionsClient'; +export { apiClientVersion, Region } from '../src/querySuggestionsClient'; export function querySuggestionsClient( appId: string, diff --git a/clients/algoliasearch-client-javascript/packages/client-query-suggestions/package.json b/clients/algoliasearch-client-javascript/packages/client-query-suggestions/package.json index 91430d78a3b..45bdaeffc12 100644 --- a/clients/algoliasearch-client-javascript/packages/client-query-suggestions/package.json +++ b/clients/algoliasearch-client-javascript/packages/client-query-suggestions/package.json @@ -51,8 +51,8 @@ "dependencies": { "@algolia/client-common": "5.8.1", "@algolia/requester-browser-xhr": "5.8.1", - "@algolia/requester-node-http": "5.8.1", - "@algolia/requester-fetch": "5.8.1" + "@algolia/requester-fetch": "5.8.1", + "@algolia/requester-node-http": "5.8.1" }, "devDependencies": { "@arethetypeswrong/cli": "0.16.4", diff --git a/clients/algoliasearch-client-javascript/packages/client-query-suggestions/src/querySuggestionsClient.ts b/clients/algoliasearch-client-javascript/packages/client-query-suggestions/src/querySuggestionsClient.ts index d71ab329c99..5abd7559c26 100644 --- a/clients/algoliasearch-client-javascript/packages/client-query-suggestions/src/querySuggestionsClient.ts +++ b/clients/algoliasearch-client-javascript/packages/client-query-suggestions/src/querySuggestionsClient.ts @@ -34,7 +34,6 @@ export const apiClientVersion = '5.8.1'; export const REGIONS = ['eu', 'us'] as const; export type Region = (typeof REGIONS)[number]; -export type RegionOptions = { region: Region }; function getDefaultHosts(region: Region): Host[] { const url = 'query-suggestions.{region}.algolia.com'.replace('{region}', region); @@ -49,7 +48,7 @@ export function createQuerySuggestionsClient({ algoliaAgents, region: regionOption, ...options -}: CreateClientOptions & RegionOptions) { +}: CreateClientOptions & { region: Region }) { const auth = createAuth(appIdOption, apiKeyOption, authMode); const transporter = createTransporter({ hosts: getDefaultHosts(regionOption), diff --git a/clients/algoliasearch-client-javascript/packages/client-search/package.json b/clients/algoliasearch-client-javascript/packages/client-search/package.json index 7480185e240..1318d64e858 100644 --- a/clients/algoliasearch-client-javascript/packages/client-search/package.json +++ b/clients/algoliasearch-client-javascript/packages/client-search/package.json @@ -51,8 +51,8 @@ "dependencies": { "@algolia/client-common": "5.8.1", "@algolia/requester-browser-xhr": "5.8.1", - "@algolia/requester-node-http": "5.8.1", - "@algolia/requester-fetch": "5.8.1" + "@algolia/requester-fetch": "5.8.1", + "@algolia/requester-node-http": "5.8.1" }, "devDependencies": { "@arethetypeswrong/cli": "0.16.4", diff --git a/clients/algoliasearch-client-javascript/packages/ingestion/README.md b/clients/algoliasearch-client-javascript/packages/ingestion/README.md index bd6de4de1f5..30278eb4d5d 100644 --- a/clients/algoliasearch-client-javascript/packages/ingestion/README.md +++ b/clients/algoliasearch-client-javascript/packages/ingestion/README.md @@ -32,9 +32,6 @@ ## 💡 Getting Started -> [!TIP] -> This API client is already a dependency of [the algoliasearch client](https://www.npmjs.com/package/algoliasearch), you don't need to manually install `@algolia/ingestion` if you already have `algoliasearch` installed. - To get started, you first need to install @algolia/ingestion (or any other available API client package). All of our clients comes with type definition, and are available for both browser and node environments. diff --git a/clients/algoliasearch-client-javascript/packages/ingestion/builds/browser.ts b/clients/algoliasearch-client-javascript/packages/ingestion/builds/browser.ts index 25ae23cdc49..f53cad1fed4 100644 --- a/clients/algoliasearch-client-javascript/packages/ingestion/builds/browser.ts +++ b/clients/algoliasearch-client-javascript/packages/ingestion/builds/browser.ts @@ -24,7 +24,6 @@ export { isScheduleTrigger, isSubscriptionTrigger, Region, - RegionOptions, } from '../src/ingestionClient'; export function ingestionClient( diff --git a/clients/algoliasearch-client-javascript/packages/ingestion/builds/fetch.ts b/clients/algoliasearch-client-javascript/packages/ingestion/builds/fetch.ts index 20a8a48e866..aa0491d69e4 100644 --- a/clients/algoliasearch-client-javascript/packages/ingestion/builds/fetch.ts +++ b/clients/algoliasearch-client-javascript/packages/ingestion/builds/fetch.ts @@ -24,7 +24,6 @@ export { isScheduleTrigger, isSubscriptionTrigger, Region, - RegionOptions, } from '../src/ingestionClient'; export function ingestionClient( diff --git a/clients/algoliasearch-client-javascript/packages/ingestion/builds/node.ts b/clients/algoliasearch-client-javascript/packages/ingestion/builds/node.ts index 3f92fc326f8..0fc36d70fe9 100644 --- a/clients/algoliasearch-client-javascript/packages/ingestion/builds/node.ts +++ b/clients/algoliasearch-client-javascript/packages/ingestion/builds/node.ts @@ -25,7 +25,6 @@ export { isScheduleTrigger, isSubscriptionTrigger, Region, - RegionOptions, } from '../src/ingestionClient'; export function ingestionClient( diff --git a/clients/algoliasearch-client-javascript/packages/ingestion/package.json b/clients/algoliasearch-client-javascript/packages/ingestion/package.json index 22a05386f27..a0cc6d1d12a 100644 --- a/clients/algoliasearch-client-javascript/packages/ingestion/package.json +++ b/clients/algoliasearch-client-javascript/packages/ingestion/package.json @@ -51,8 +51,8 @@ "dependencies": { "@algolia/client-common": "5.8.1", "@algolia/requester-browser-xhr": "5.8.1", - "@algolia/requester-node-http": "5.8.1", - "@algolia/requester-fetch": "5.8.1" + "@algolia/requester-fetch": "5.8.1", + "@algolia/requester-node-http": "5.8.1" }, "devDependencies": { "@arethetypeswrong/cli": "0.16.4", diff --git a/clients/algoliasearch-client-javascript/packages/ingestion/src/ingestionClient.ts b/clients/algoliasearch-client-javascript/packages/ingestion/src/ingestionClient.ts index 6f331b99c29..69669d98204 100644 --- a/clients/algoliasearch-client-javascript/packages/ingestion/src/ingestionClient.ts +++ b/clients/algoliasearch-client-javascript/packages/ingestion/src/ingestionClient.ts @@ -121,7 +121,6 @@ export const apiClientVersion = '1.8.1'; export const REGIONS = ['eu', 'us'] as const; export type Region = (typeof REGIONS)[number]; -export type RegionOptions = { region: Region }; function getDefaultHosts(region: Region): Host[] { const url = 'data.{region}.algolia.com'.replace('{region}', region); @@ -166,7 +165,7 @@ export function createIngestionClient({ algoliaAgents, region: regionOption, ...options -}: CreateClientOptions & RegionOptions) { +}: CreateClientOptions & { region: Region }) { const auth = createAuth(appIdOption, apiKeyOption, authMode); const transporter = createTransporter({ hosts: getDefaultHosts(regionOption), diff --git a/clients/algoliasearch-client-javascript/packages/monitoring/README.md b/clients/algoliasearch-client-javascript/packages/monitoring/README.md index 2bc735c5cec..f134090ab9e 100644 --- a/clients/algoliasearch-client-javascript/packages/monitoring/README.md +++ b/clients/algoliasearch-client-javascript/packages/monitoring/README.md @@ -32,9 +32,6 @@ ## 💡 Getting Started -> [!TIP] -> This API client is already a dependency of [the algoliasearch client](https://www.npmjs.com/package/algoliasearch), you don't need to manually install `@algolia/monitoring` if you already have `algoliasearch` installed. - To get started, you first need to install @algolia/monitoring (or any other available API client package). All of our clients comes with type definition, and are available for both browser and node environments. diff --git a/clients/algoliasearch-client-javascript/packages/monitoring/package.json b/clients/algoliasearch-client-javascript/packages/monitoring/package.json index c33f12acf9e..089ab89bda0 100644 --- a/clients/algoliasearch-client-javascript/packages/monitoring/package.json +++ b/clients/algoliasearch-client-javascript/packages/monitoring/package.json @@ -51,8 +51,8 @@ "dependencies": { "@algolia/client-common": "5.8.1", "@algolia/requester-browser-xhr": "5.8.1", - "@algolia/requester-node-http": "5.8.1", - "@algolia/requester-fetch": "5.8.1" + "@algolia/requester-fetch": "5.8.1", + "@algolia/requester-node-http": "5.8.1" }, "devDependencies": { "@arethetypeswrong/cli": "0.16.4", diff --git a/clients/algoliasearch-client-javascript/packages/recommend/package.json b/clients/algoliasearch-client-javascript/packages/recommend/package.json index b28ddc7097b..455b4b6292b 100644 --- a/clients/algoliasearch-client-javascript/packages/recommend/package.json +++ b/clients/algoliasearch-client-javascript/packages/recommend/package.json @@ -51,8 +51,8 @@ "dependencies": { "@algolia/client-common": "5.8.1", "@algolia/requester-browser-xhr": "5.8.1", - "@algolia/requester-node-http": "5.8.1", - "@algolia/requester-fetch": "5.8.1" + "@algolia/requester-fetch": "5.8.1", + "@algolia/requester-node-http": "5.8.1" }, "devDependencies": { "@arethetypeswrong/cli": "0.16.4", From fc68881c2660d873637c06d2732c592d7eae4dfe Mon Sep 17 00:00:00 2001 From: shortcuts Date: Mon, 14 Oct 2024 10:18:19 +0200 Subject: [PATCH 10/11] chore: export search --- .../javascript/clients/algoliasearch/builds/models.mustache | 1 + 1 file changed, 1 insertion(+) diff --git a/templates/javascript/clients/algoliasearch/builds/models.mustache b/templates/javascript/clients/algoliasearch/builds/models.mustache index a0ad090e02a..0532b2f2150 100644 --- a/templates/javascript/clients/algoliasearch/builds/models.mustache +++ b/templates/javascript/clients/algoliasearch/builds/models.mustache @@ -111,6 +111,7 @@ type RegionOptions = {{#dependencies}} {{#dependencyHasRegionalHosts}}{{^-first} {{#dependencies}} export * from '{{{dependencyPackage}}}'; {{/dependencies}} +export * from '@algolia/client-search'; export { Action, From ad19041c110c6236bada576e939612af049083ee Mon Sep 17 00:00:00 2001 From: shortcuts Date: Mon, 14 Oct 2024 10:36:12 +0200 Subject: [PATCH 11/11] fix: playground --- playground/javascript/node/algoliasearch.ts | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/playground/javascript/node/algoliasearch.ts b/playground/javascript/node/algoliasearch.ts index 6de434cc534..a9e21f5e520 100644 --- a/playground/javascript/node/algoliasearch.ts +++ b/playground/javascript/node/algoliasearch.ts @@ -80,7 +80,7 @@ async function testAlgoliasearch() { } try { - const analyticsClient = client.initAnalytics(); + const analyticsClient = client.initAnalytics({region: 'de'}); const res = await analyticsClient.getTopFilterForAttribute({ attribute: 'myAttribute1,myAttribute2', @@ -97,7 +97,7 @@ async function testAlgoliasearch() { } try { - const abtestingClient = client.initAbtesting(); + const abtestingClient = client.initAbtesting({region: 'us'}); const res = await abtestingClient.getABTest({ id: 42,