fix(javascript): type definition and template cleanup (#3656)

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

@@ -82,8 +82,8 @@ public void processOpts() {
       supportingFiles.add(new SupportingFile("README.mustache", "", "../../README.md"));
 
       // `algoliasearch` builds
-      supportingFiles.add(new SupportingFile("algoliasearch/builds/browser.mustache", "builds", "browser.ts"));
-      supportingFiles.add(new SupportingFile("algoliasearch/builds/node.mustache", "builds", "node.ts"));
+      supportingFiles.add(new SupportingFile("algoliasearch/builds/definition.mustache", "builds", "browser.ts"));
+      supportingFiles.add(new SupportingFile("algoliasearch/builds/definition.mustache", "builds", "node.ts"));
       supportingFiles.add(new SupportingFile("algoliasearch/builds/models.mustache", "builds", "models.ts"));
 
       // `lite` builds

templates/javascript/clients/algoliasearch/builds/definition.mustache

@@ -1,29 +1,12 @@
-{{#nodeSearchHelpers}}
-import { createHmac } from 'node:crypto';
-{{/nodeSearchHelpers}}
-
-import {
-  DEFAULT_CONNECT_TIMEOUT_BROWSER,
-  DEFAULT_CONNECT_TIMEOUT_NODE,
-  DEFAULT_READ_TIMEOUT_BROWSER,
-  DEFAULT_READ_TIMEOUT_NODE,
-  DEFAULT_WRITE_TIMEOUT_BROWSER,
-  DEFAULT_WRITE_TIMEOUT_NODE,
-  createBrowserLocalStorageCache,
-  createFallbackableCache,
-  createMemoryCache,
-  createNullCache,
-  serializeQueryParameters,
-} from '@algolia/client-common';
+// {{{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 { createXhrRequester } from '@algolia/requester-browser-xhr';
-import { createHttpRequester } from '@algolia/requester-node-http';
 import { abtestingClient } from '@algolia/client-abtesting';
 import { analyticsClient } from '@algolia/client-analytics';
 import { personalizationClient } from '@algolia/client-personalization';
@@ -33,29 +16,65 @@ import { recommendClient } from '@algolia/recommend';
 import type {
   InitClientOptions,
   InitClientRegion,
-  GenerateSecuredApiKeyOptions,
-  GetSecuredApiKeyRemainingValidityOptions,
 } from './models';
 
-import { apiClientVersion } from './models';
-
 export * from './models';
 
-/**
- * The client type.
- */
-export type Algoliasearch = ReturnType<typeof algoliasearch>;
-
-// eslint-disable-next-line @typescript-eslint/explicit-function-return-type
-export function algoliasearch(
-  appId: string,
-  apiKey: string,
-  options?: ClientOptions
-) {
+export type Algoliasearch = SearchClient & {
+    initRecommend: (initOptions: InitClientOptions)=> RecommendClient;
+    initAnalytics: (initOptions: InitClientOptions & InitClientRegion<AnalyticsRegion>)=> AnalyticsClient;
+    initAbtesting: (initOptions: InitClientOptions & InitClientRegion<AbtestingRegion>)=> AbtestingClient;
+    initPersonalization: (initOptions: InitClientOptions & Required<InitClientRegion<PersonalizationRegion>>)=> PersonalizationClient;
+};
+
+export function algoliasearch(appId: string, apiKey: string, options?: ClientOptions): Algoliasearch {
   if (!appId || typeof appId !== 'string') {
     throw new Error('`appId` is missing.');
   }
 
   if (!apiKey || typeof apiKey !== 'string') {
     throw new Error('`apiKey` is missing.');
-  }
+  }
+
+  return {
+    ...searchClient(appId, apiKey, options),
+    /**
+     * Get the value of the `algoliaAgent`, used by our libraries internally and telemetry system.
+     */
+    get _ua(): string {
+      return this.transporter.algoliaAgent.value;
+    },
+    initRecommend: (initOptions: InitClientOptions = {}): RecommendClient => {
+      return recommendClient(initOptions.appId || appId, initOptions.apiKey || apiKey, initOptions.options);
+    },
+
+    initAnalytics: (initOptions: InitClientOptions & InitClientRegion<AnalyticsRegion> = {}): AnalyticsClient => {
+      return analyticsClient(
+        initOptions.appId || appId,
+        initOptions.apiKey || apiKey,
+        initOptions.region,
+        initOptions.options,
+      );
+    },
+
+    initAbtesting: (initOptions: InitClientOptions & InitClientRegion<AbtestingRegion> = {}): AbtestingClient => {
+      return abtestingClient(
+        initOptions.appId || appId,
+        initOptions.apiKey || apiKey,
+        initOptions.region,
+        initOptions.options,
+      );
+    },
+
+    initPersonalization: (
+      initOptions: InitClientOptions & Required<InitClientRegion<PersonalizationRegion>>,
+    ): PersonalizationClient => {
+      return personalizationClient(
+        initOptions.appId || appId,
+        initOptions.apiKey || apiKey,
+        initOptions.region,
+        initOptions.options,
+      );
+    },
+  }
+}

templates/javascript/clients/algoliasearch/builds/models.mustache

@@ -1,8 +1,9 @@
 // {{{generationBanner}}}
 
-import type { Region as ABTestingRegion } from '@algolia/client-abtesting';
-import type { Region as AnalyticsRegion } from '@algolia/client-analytics';
+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 {
   AdvancedSyntaxFeatures,
   AlternativesAsExact,
@@ -78,8 +79,9 @@ import type {
   Value,
 } from '@algolia/client-search';
 import { apiClientVersion } from '@algolia/client-search';
+import type { RecommendClient } from '@algolia/recommend';
 
-type Region = ABTestingRegion | AnalyticsRegion;
+type Region = AbTestingRegion | AnalyticsRegion;
 
 export * from '@algolia/client-search';
 export * from '@algolia/recommend';
@@ -161,7 +163,7 @@ export {
   TypoToleranceEnum,
   Value,
   AnalyticsRegion,
-  ABTestingRegion,
+  AbTestingRegion,
   Region,
   apiClientVersion,
 };

templates/javascript/clients/api-single.mustache

@@ -21,27 +21,26 @@ export function create{{#lambda.titlecase}}{{apiName}}{{/lambda.titlecase}}({
     ...options
   }: CreateClientOptions{{#hasRegionalHost}} & {region{{#fallbackToAliasHost}}?{{/fallbackToAliasHost}}: Region }{{/hasRegionalHost}}) {
   const auth = createAuth(appIdOption, apiKeyOption, authMode);
-  const transporter = createTransporter({
-    hosts: getDefaultHosts({{#hostWithAppID}}appIdOption{{/hostWithAppID}}{{#hasRegionalHost}}regionOption{{/hasRegionalHost}}),
-    ...options,
-    algoliaAgent: getAlgoliaAgent({
-      algoliaAgents,
-      client: '{{{algoliaAgent}}}',
-      version: apiClientVersion,
-    }),
-    baseHeaders: {
-      'content-type': 'text/plain',
-      ...auth.headers(),
-      ...options.baseHeaders,
-    },
-    baseQueryParameters: {
-      ...auth.queryParameters(),
-      ...options.baseQueryParameters,
-    },
-  });
 
   return {
-    transporter,
+    transporter: createTransporter({
+      hosts: getDefaultHosts({{#hostWithAppID}}appIdOption{{/hostWithAppID}}{{#hasRegionalHost}}regionOption{{/hasRegionalHost}}),
+      ...options,
+      algoliaAgent: getAlgoliaAgent({
+        algoliaAgents,
+        client: '{{{algoliaAgent}}}',
+        version: apiClientVersion,
+      }),
+      baseHeaders: {
+        'content-type': 'text/plain',
+        ...auth.headers(),
+        ...options.baseHeaders,
+      },
+      baseQueryParameters: {
+        ...auth.queryParameters(),
+        ...options.baseQueryParameters,
+      },
+    }),
 
     /**
      * The `appId` currently in use.
@@ -53,16 +52,16 @@ export function create{{#lambda.titlecase}}{{apiName}}{{/lambda.titlecase}}({
      */
     clearCache(): Promise<void> {
       return Promise.all([
-        transporter.requestsCache.clear(),
-        transporter.responsesCache.clear(),
+        this.transporter.requestsCache.clear(),
+        this.transporter.responsesCache.clear(),
       ]).then(() => undefined);
     },
 
     /**
      * Get the value of the `algoliaAgent`, used by our libraries internally and telemetry system.
      */
     get _ua(): string {
-      return transporter.algoliaAgent.value;
+      return this.transporter.algoliaAgent.value;
     },
 
     /**
@@ -72,7 +71,7 @@ export function create{{#lambda.titlecase}}{{apiName}}{{/lambda.titlecase}}({
      * @param version - The version of the agent.
      */
     addAlgoliaAgent(segment: string, version?: string): void {
-      transporter.algoliaAgent.add({ segment, version });
+      this.transporter.algoliaAgent.add({ segment, version });
     },
 
     /**
@@ -82,7 +81,7 @@ export function create{{#lambda.titlecase}}{{apiName}}{{/lambda.titlecase}}({
     * @param params.apiKey - The new API Key to use.
     */
     setClientApiKey({ apiKey }: { apiKey: string }): void {
-      transporter.baseHeaders['x-algolia-api-key'] = apiKey;
+      this.transporter.baseHeaders['x-algolia-api-key'] = apiKey;
     },
 
     {{#isSearchClient}}
@@ -153,7 +152,7 @@ export function create{{#lambda.titlecase}}{{apiName}}{{/lambda.titlecase}}({
         {{/vendorExtensions}}
       };
 
-      return transporter.request(request, requestOptions);
+      return this.transporter.request(request, requestOptions);
     },
 
     {{/operation}}

templates/javascript/clients/client/api/nodeHelpers.mustache

@@ -6,10 +6,10 @@
  * @param generateSecuredApiKey.parentApiKey - The base API key from which to generate the new secured one.
  * @param generateSecuredApiKey.restrictions - A set of properties defining the restrictions of the secured API key.
  */
-generateSecuredApiKey({
+generateSecuredApiKey: ({
   parentApiKey,
   restrictions = {},
-}: GenerateSecuredApiKeyOptions): string {
+}: GenerateSecuredApiKeyOptions): string => {
   let mergedRestrictions = restrictions;
   if (restrictions.searchParams) {
     // merge searchParams with the root restrictions
@@ -47,9 +47,9 @@ generateSecuredApiKey({
  * @param getSecuredApiKeyRemainingValidity - The `getSecuredApiKeyRemainingValidity` object.
  * @param getSecuredApiKeyRemainingValidity.securedApiKey - The secured API key generated with the `generateSecuredApiKey` method.
  */
-getSecuredApiKeyRemainingValidity({
+getSecuredApiKeyRemainingValidity: ({
   securedApiKey,
-}: GetSecuredApiKeyRemainingValidityOptions): number {
+}: GetSecuredApiKeyRemainingValidityOptions): number => {
   const decodedString = Buffer.from(securedApiKey, 'base64').toString(
     'ascii'
   );

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

@@ -1,5 +1,7 @@
 // {{{generationBanner}}}
 
+export type {{#lambda.titlecase}}{{apiName}}{{/lambda.titlecase}} = ReturnType<typeof create{{#lambda.titlecase}}{{apiName}}{{/lambda.titlecase}}>;
+
 {{> client/builds/definition}}
   return create{{#lambda.titlecase}}{{apiName}}{{/lambda.titlecase}}({
     appId,