fix(javascript): remove factory from build (#639)

shortcuts · web-flow · commit 2a1f30c98abb · 2022-06-06T14:15:21.000+02:00
diff --git a/clients/algoliasearch-client-javascript/bundlesize.config.json b/clients/algoliasearch-client-javascript/bundlesize.config.json
@@ -2,43 +2,43 @@
   "files": [
     {
       "path": "packages/algoliasearch/dist/algoliasearch.umd.browser.js",
-      "maxSize": "7.40KB"
+      "maxSize": "7.50KB"
     },
     {
       "path": "packages/algoliasearch-lite/dist/algoliasearch-lite.umd.browser.js",
-      "maxSize": "3.70KB"
+      "maxSize": "3.75KB"
     },
     {
       "path": "packages/client-abtesting/dist/client-abtesting.umd.browser.js",
-      "maxSize": "3.85KB"
+      "maxSize": "3.90KB"
     },
     {
       "path": "packages/client-analytics/dist/client-analytics.umd.browser.js",
-      "maxSize": "4.45KB"
+      "maxSize": "4.50KB"
     },
     {
       "path": "packages/client-insights/dist/client-insights.umd.browser.js",
-      "maxSize": "3.70KB"
+      "maxSize": "3.75KB"
     },
     {
       "path": "packages/client-personalization/dist/client-personalization.umd.browser.js",
-      "maxSize": "3.85KB"
+      "maxSize": "3.95KB"
     },
     {
       "path": "packages/client-query-suggestions/dist/client-query-suggestions.umd.browser.js",
-      "maxSize": "3.90KB"
+      "maxSize": "4.00KB"
     },
     {
       "path": "packages/client-search/dist/client-search.umd.browser.js",
-      "maxSize": "6.30KB"
+      "maxSize": "6.25KB"
     },
     {
       "path": "packages/client-sources/dist/client-sources.umd.browser.js",
-      "maxSize": "3.70KB"
+      "maxSize": "3.85KB"
     },
     {
       "path": "packages/recommend/dist/recommend.umd.browser.js",
-      "maxSize": "3.80KB"
+      "maxSize": "3.85KB"
     }
   ]
 }
diff --git a/clients/algoliasearch-client-javascript/packages/algoliasearch/builds/browser.ts b/clients/algoliasearch-client-javascript/packages/algoliasearch/builds/browser.ts
@@ -20,10 +20,12 @@ import type {
 import { createPersonalizationClient } from '@experimental-api-clients-automation/client-personalization/src/personalizationClient';
 import {
   createSearchClient,
-  apiClientVersion,
+  apiClientVersion as searchClientVersion,
 } from '@experimental-api-clients-automation/client-search/src/searchClient';
 import { createXhrRequester } from '@experimental-api-clients-automation/requester-browser-xhr';
 
+export const apiClientVersion = searchClientVersion;
+
 // eslint-disable-next-line @typescript-eslint/explicit-function-return-type
 export function algoliasearch(
   appId: string,
@@ -98,3 +100,5 @@ export function algoliasearch(
     initPersonalization,
   };
 }
+
+export type Algoliasearch = ReturnType<typeof algoliasearch>;
diff --git a/clients/algoliasearch-client-javascript/packages/algoliasearch/builds/node.ts b/clients/algoliasearch-client-javascript/packages/algoliasearch/builds/node.ts
@@ -17,9 +17,14 @@ import type {
   Region as PersonalizationRegion,
 } from '@experimental-api-clients-automation/client-personalization/src/personalizationClient';
 import { createPersonalizationClient } from '@experimental-api-clients-automation/client-personalization/src/personalizationClient';
-import { createSearchClient } from '@experimental-api-clients-automation/client-search/src/searchClient';
+import {
+  createSearchClient,
+  apiClientVersion as searchClientVersion,
+} from '@experimental-api-clients-automation/client-search/src/searchClient';
 import { createHttpRequester } from '@experimental-api-clients-automation/requester-node-http';
 
+export const apiClientVersion = searchClientVersion;
+
 // eslint-disable-next-line @typescript-eslint/explicit-function-return-type
 export function algoliasearch(
   appId: string,
@@ -88,3 +93,5 @@ export function algoliasearch(
     initPersonalization,
   };
 }
+
+export type Algoliasearch = ReturnType<typeof algoliasearch>;
diff --git a/generators/src/main/java/com/algolia/codegen/AlgoliaJavaScriptGenerator.java b/generators/src/main/java/com/algolia/codegen/AlgoliaJavaScriptGenerator.java
@@ -33,6 +33,7 @@ public void processOpts() {
     // clear all supported files to avoid unwanted ones
     supportingFiles.clear();
 
+    supportingFiles.add(new SupportingFile("clientMethodProps.mustache", "model", "clientMethodProps.ts"));
     supportingFiles.add(new SupportingFile("modelBarrel.mustache", "model", "index.ts"));
     supportingFiles.add(new SupportingFile("browser.mustache", "builds", "browser.ts"));
     supportingFiles.add(new SupportingFile("node.mustache", "builds", "node.ts"));
diff --git a/playground/javascript/node/algoliasearch.ts b/playground/javascript/node/algoliasearch.ts
@@ -2,7 +2,7 @@ import { algoliasearch } from '@experimental-api-clients-automation/algoliasearc
 import { ApiError } from '@experimental-api-clients-automation/client-common';
 import dotenv from 'dotenv';
 
-import type { SearchResponse } from '@experimental-api-clients-automation/client-search';
+import type { SearchResponses } from '@experimental-api-clients-automation/client-search';
 
 dotenv.config({ path: '../../.env' });
 
@@ -31,9 +31,14 @@ client.addAlgoliaAgent('algoliasearch node playground', '0.0.1');
 
 async function testAlgoliasearch() {
   try {
-    const res: SearchResponse = await client.search({
-      indexName: searchIndex,
-      searchParams: { query: searchQuery },
+    const res: SearchResponses = await client.search({
+      requests: [
+        {
+          indexName: searchIndex,
+          query: searchQuery,
+          hitsPerPage: 50,
+        },
+      ],
     });
 
     console.log(`[OK search]`, res);
diff --git a/templates/javascript/api-single.mustache b/templates/javascript/api-single.mustache
@@ -23,16 +23,19 @@ import type {
 import { {{classname}} } from '{{filename}}';
 {{/imports}}
 
-export * from '../model';
+{{#operations}}
+import type {
+{{#operation}}
+{{#vendorExtensions.x-create-wrapping-object}}
+{{#lambda.titlecase}}{{nickname}}{{/lambda.titlecase}}Props,
+{{/vendorExtensions.x-create-wrapping-object}}
+{{/operation}}
+} from '../model/clientMethodProps';
+{{/operations}}
+
 export const apiClientVersion = '{{packageVersion}}';
 
 {{#operations}}
-{{#description}}
-/**
-* {{&description}}
-*/
-{{/description}}
-
 {{#hasRegionalHost}}
 export const REGIONS = [{{#allowedRegions}}'{{.}}'{{^-last}},{{/-last}}{{/allowedRegions}}] as const;
 export type Region = typeof REGIONS[number];
@@ -244,20 +247,4 @@ export function create{{capitalizedApiName}}({
 
 export type {{capitalizedApiName}} = ReturnType<typeof create{{capitalizedApiName}}>;
 
-{{#operation}}
-{{#vendorExtensions.x-create-wrapping-object}}
-export type {{#lambda.titlecase}}{{nickname}}{{/lambda.titlecase}}Props = {
-  {{#allParams}}
-    {{#description}}
-    /**
-    * {{{description}}}
-    */
-    {{/description}}
-    {{paramName}}{{^required}}?{{/required}}: {{{dataType}}};
-  {{/allParams}}
-}
-{{/vendorExtensions.x-create-wrapping-object}}
-
-{{/operation}}
-
 {{/operations}}
diff --git a/templates/javascript/browser.mustache b/templates/javascript/browser.mustache
@@ -9,7 +9,12 @@ import type { {{capitalizedApiName}} } from '../src/{{apiName}}';
 import { Region, REGIONS } from '../src/{{apiName}}';
 {{/hasRegionalHost}}
 
-export * from '../src/{{apiName}}';
+{{! We don't use `export *` to prevent exposing the factory, to avoid confusion for the user }}
+export { 
+  apiClientVersion,
+  {{capitalizedApiName}},
+} from '../src/{{apiName}}';
+export * from '../model';
 
 export function {{apiName}}(
   appId: string,
@@ -24,16 +29,15 @@ export function {{apiName}}(
     throw new Error("`apiKey` is missing.");
   }
 
-  {{#hasRegionalHost}}
-  {{^fallbackToAliasHost}}
+  {{#hasRegionalHost}}{{^fallbackToAliasHost}}
   if (!region) {
     throw new Error("`region` is missing.");
   }
+
   if (typeof region !== 'string' || !REGIONS.includes(region)) {
     throw new Error(`\`region\` must be one of the following: ${REGIONS.join(', ')}`);
   }
-  {{/fallbackToAliasHost}}
-  {{/hasRegionalHost}}
+  {{/fallbackToAliasHost}}{{/hasRegionalHost}}
 
   return create{{capitalizedApiName}}({
     appId,
diff --git a/templates/javascript/clientMethodProps.mustache b/templates/javascript/clientMethodProps.mustache
@@ -0,0 +1,27 @@
+{{#apiInfo.apis.0}}
+
+{{#imports}}
+import { {{classname}} } from '{{filename}}';
+{{/imports}}
+
+{{#operations}}
+{{#operation}}
+{{#vendorExtensions.x-create-wrapping-object}}
+/**
+ * Properties for the `{{nickname}}` method.
+ */
+export type {{#lambda.titlecase}}{{nickname}}{{/lambda.titlecase}}Props = {
+  {{#allParams}}
+    {{#description}}
+    /**
+    * {{{description}}}
+    */
+    {{/description}}
+    {{paramName}}{{^required}}?{{/required}}: {{{dataType}}};
+  {{/allParams}}
+}
+{{/vendorExtensions.x-create-wrapping-object}}
+
+{{/operation}}
+{{/operations}}
+{{/apiInfo.apis.0}}
diff --git a/templates/javascript/modelBarrel.mustache b/templates/javascript/modelBarrel.mustache
@@ -3,3 +3,4 @@
 export * from '{{{ classFilename }}}';
 {{/model}}
 {{/models}}
+export * from './clientMethodProps'
diff --git a/templates/javascript/node.mustache b/templates/javascript/node.mustache
@@ -9,7 +9,12 @@ import type { {{capitalizedApiName}} } from '../src/{{apiName}}';
 import { Region, REGIONS } from '../src/{{apiName}}';
 {{/hasRegionalHost}}
 
-export * from '../src/{{apiName}}';
+{{! We don't use `export *` to prevent exposing the factory, to avoid confusion for the user }}
+export { 
+  apiClientVersion,
+  {{capitalizedApiName}},
+} from '../src/{{apiName}}';
+export * from '../model';
 
 export function {{apiName}}(
   appId: string,
@@ -24,16 +29,15 @@ export function {{apiName}}(
     throw new Error("`apiKey` is missing.");
   }
 
-  {{#hasRegionalHost}}
-  {{^fallbackToAliasHost}}
+  {{#hasRegionalHost}}{{^fallbackToAliasHost}}
   if (!region) {
     throw new Error("`region` is missing.");
   }
+
   if (typeof region !== 'string' || !REGIONS.includes(region)) {
     throw new Error(`\`region\` must be one of the following: ${REGIONS.join(', ')}`);
   }
-  {{/fallbackToAliasHost}}
-  {{/hasRegionalHost}}
+  {{/fallbackToAliasHost}}{{/hasRegionalHost}}
 
   return create{{capitalizedApiName}}({
     appId,

Original file line number	Diff line number	Diff line change
`@@ -2,43 +2,43 @@`
`2`	`2`	`"files": [`
`3`	`3`	`{`
`4`	`4`	`"path": "packages/algoliasearch/dist/algoliasearch.umd.browser.js",`
`5`		`- "maxSize": "7.40KB"`
	`5`	`+ "maxSize": "7.50KB"`
`6`	`6`	`},`
`7`	`7`	`{`
`8`	`8`	`"path": "packages/algoliasearch-lite/dist/algoliasearch-lite.umd.browser.js",`
`9`		`- "maxSize": "3.70KB"`
	`9`	`+ "maxSize": "3.75KB"`
`10`	`10`	`},`
`11`	`11`	`{`
`12`	`12`	`"path": "packages/client-abtesting/dist/client-abtesting.umd.browser.js",`
`13`		`- "maxSize": "3.85KB"`
	`13`	`+ "maxSize": "3.90KB"`
`14`	`14`	`},`
`15`	`15`	`{`
`16`	`16`	`"path": "packages/client-analytics/dist/client-analytics.umd.browser.js",`
`17`		`- "maxSize": "4.45KB"`
	`17`	`+ "maxSize": "4.50KB"`
`18`	`18`	`},`
`19`	`19`	`{`
`20`	`20`	`"path": "packages/client-insights/dist/client-insights.umd.browser.js",`
`21`		`- "maxSize": "3.70KB"`
	`21`	`+ "maxSize": "3.75KB"`
`22`	`22`	`},`
`23`	`23`	`{`
`24`	`24`	`"path": "packages/client-personalization/dist/client-personalization.umd.browser.js",`
`25`		`- "maxSize": "3.85KB"`
	`25`	`+ "maxSize": "3.95KB"`
`26`	`26`	`},`
`27`	`27`	`{`
`28`	`28`	`"path": "packages/client-query-suggestions/dist/client-query-suggestions.umd.browser.js",`
`29`		`- "maxSize": "3.90KB"`
	`29`	`+ "maxSize": "4.00KB"`
`30`	`30`	`},`
`31`	`31`	`{`
`32`	`32`	`"path": "packages/client-search/dist/client-search.umd.browser.js",`
`33`		`- "maxSize": "6.30KB"`
	`33`	`+ "maxSize": "6.25KB"`
`34`	`34`	`},`
`35`	`35`	`{`
`36`	`36`	`"path": "packages/client-sources/dist/client-sources.umd.browser.js",`
`37`		`- "maxSize": "3.70KB"`
	`37`	`+ "maxSize": "3.85KB"`
`38`	`38`	`},`
`39`	`39`	`{`
`40`	`40`	`"path": "packages/recommend/dist/recommend.umd.browser.js",`
`41`		`- "maxSize": "3.80KB"`
	`41`	`+ "maxSize": "3.85KB"`
`42`	`42`	`}`
`43`	`43`	`]`
`44`	`44`	`}`