fix(javascript): common package types (#4015)

shortcuts · millotp · web-flow · commit 25de7005caa5 · 2024-10-22T16:17:02.000+02:00
Co-authored-by: Pierre Millot &lt;pierre.millot@algolia.com&gt;
diff --git a/clients/algoliasearch-client-javascript/packages/client-common/index.ts b/clients/algoliasearch-client-javascript/packages/client-common/index.ts
diff --git a/clients/algoliasearch-client-javascript/packages/client-common/src/index.ts b/clients/algoliasearch-client-javascript/packages/client-common/src/index.ts
@@ -0,0 +1,9 @@
+export * from './cache';
+export * from './constants';
+export * from './createAlgoliaAgent';
+export * from './createAuth';
+export * from './createIterablePromise';
+export * from './getAlgoliaAgent';
+export * from './logger';
+export * from './transporter';
+export * from './types';
diff --git a/clients/algoliasearch-client-javascript/packages/client-common/tsconfig.json b/clients/algoliasearch-client-javascript/packages/client-common/tsconfig.json
@@ -4,6 +4,6 @@
     "types": ["node", "vitest/globals"],
     "outDir": "dist"
   },
-  "include": ["src", "index.ts"],
+  "include": ["src"],
   "exclude": ["dist", "node_modules", "src/__tests__"]
 }
diff --git a/clients/algoliasearch-client-javascript/packages/client-common/tsup.config.ts b/clients/algoliasearch-client-javascript/packages/client-common/tsup.config.ts
@@ -8,13 +8,13 @@ export default defineConfig([
   {
     ...getBaseNodeOptions(pkg, __dirname),
     format: 'cjs',
-    dts: { entry: { common: 'index.ts' } },
-    entry: { common: 'index.ts' },
+    dts: { entry: { common: 'src/index.ts' } },
+    entry: { common: 'src/index.ts' },
   },
   {
     ...getBaseNodeOptions(pkg, __dirname),
     format: 'esm',
-    dts: { entry: { common: 'index.ts' } },
-    entry: { common: 'index.ts' },
+    dts: { entry: { common: 'src/index.ts' } },
+    entry: { common: 'src/index.ts' },
   },
 ]);
diff --git a/clients/algoliasearch-client-javascript/packages/logger-console/index.ts b/clients/algoliasearch-client-javascript/packages/logger-console/index.ts
diff --git a/clients/algoliasearch-client-javascript/packages/logger-console/tsup.config.ts b/clients/algoliasearch-client-javascript/packages/logger-console/tsup.config.ts
@@ -8,13 +8,13 @@ export default defineConfig([
   {
     ...getBaseNodeOptions(pkg, __dirname),
     format: 'cjs',
-    dts: { entry: { logger: 'index.ts' } },
-    entry: { logger: 'index.ts' },
+    dts: { entry: { logger: 'src/logger.ts' } },
+    entry: { logger: 'src/logger.ts' },
   },
   {
     ...getBaseNodeOptions(pkg, __dirname),
     format: 'esm',
-    dts: { entry: { logger: 'index.ts' } },
-    entry: { logger: 'index.ts' },
+    dts: { entry: { logger: 'src/logger.ts' } },
+    entry: { logger: 'src/logger.ts' },
   },
 ]);
diff --git a/clients/algoliasearch-client-javascript/packages/requester-browser-xhr/index.ts b/clients/algoliasearch-client-javascript/packages/requester-browser-xhr/index.ts
diff --git a/clients/algoliasearch-client-javascript/packages/requester-browser-xhr/src/index.ts b/clients/algoliasearch-client-javascript/packages/requester-browser-xhr/src/index.ts
@@ -0,0 +1 @@
+export * from './createXhrRequester';
diff --git a/clients/algoliasearch-client-javascript/packages/requester-browser-xhr/tsconfig.json b/clients/algoliasearch-client-javascript/packages/requester-browser-xhr/tsconfig.json
@@ -4,6 +4,6 @@
     "types": ["node", "vitest/globals"],
     "outDir": "dist"
   },
-  "include": ["src", "index.ts"],
+  "include": ["src"],
   "exclude": ["dist", "node_modules", "src/__tests__"]
 }
diff --git a/clients/algoliasearch-client-javascript/packages/requester-browser-xhr/tsup.config.ts b/clients/algoliasearch-client-javascript/packages/requester-browser-xhr/tsup.config.ts
@@ -8,6 +8,6 @@ export default defineConfig({
   ...getBaseBrowserOptions(pkg, __dirname),
   minify: true,
   globalName: 'requesterxhr',
-  entry: { 'requester.xhr': 'index.ts' },
-  dts: { entry: { 'requester.xhr': 'index.ts' } },
+  entry: { 'requester.xhr': 'src/index.ts' },
+  dts: { entry: { 'requester.xhr': 'src/index.ts' } },
 });
diff --git a/clients/algoliasearch-client-javascript/packages/requester-fetch/index.ts b/clients/algoliasearch-client-javascript/packages/requester-fetch/index.ts
diff --git a/clients/algoliasearch-client-javascript/packages/requester-fetch/src/index.ts b/clients/algoliasearch-client-javascript/packages/requester-fetch/src/index.ts
@@ -0,0 +1 @@
+export * from './createFetchRequester';
diff --git a/clients/algoliasearch-client-javascript/packages/requester-fetch/tsconfig.json b/clients/algoliasearch-client-javascript/packages/requester-fetch/tsconfig.json
@@ -4,6 +4,6 @@
     "types": ["node", "vitest/globals"],
     "outDir": "dist"
   },
-  "include": ["src", "index.ts"],
+  "include": ["src"],
   "exclude": ["dist", "node_modules", "src/__tests__"]
 }
diff --git a/clients/algoliasearch-client-javascript/packages/requester-fetch/tsup.config.ts b/clients/algoliasearch-client-javascript/packages/requester-fetch/tsup.config.ts
@@ -9,22 +9,22 @@ export default defineConfig([
     ...getBaseNodeOptions(pkg, __dirname),
     format: 'cjs',
     name: 'node cjs',
-    entry: { 'requester.fetch.node': 'index.ts' },
-    dts: { entry: { 'requester.fetch.node': 'index.ts' } },
+    entry: { 'requester.fetch.node': 'src/index.ts' },
+    dts: { entry: { 'requester.fetch.node': 'src/index.ts' } },
   },
   {
     ...getBaseNodeOptions(pkg, __dirname),
     format: 'esm',
     name: 'node esm',
-    entry: { 'requester.fetch.node': 'index.ts' },
-    dts: { entry: { 'requester.fetch.node': 'index.ts' } },
+    entry: { 'requester.fetch.node': 'src/index.ts' },
+    dts: { entry: { 'requester.fetch.node': 'src/index.ts' } },
   },
   {
     ...getBaseBrowserOptions(pkg, __dirname),
     minify: true,
     name: 'browser esm',
-    entry: { 'requester.fetch.browser': 'index.ts' },
-    dts: { entry: { 'requester.fetch.browser': 'index.ts' } },
+    entry: { 'requester.fetch.browser': 'src/index.ts' },
+    dts: { entry: { 'requester.fetch.browser': 'src/index.ts' } },
     globalName: 'requesterfetch',
   },
 ]);
diff --git a/clients/algoliasearch-client-javascript/packages/requester-node-http/index.ts b/clients/algoliasearch-client-javascript/packages/requester-node-http/index.ts
diff --git a/clients/algoliasearch-client-javascript/packages/requester-node-http/src/index.ts b/clients/algoliasearch-client-javascript/packages/requester-node-http/src/index.ts
@@ -0,0 +1 @@
+export * from './createHttpRequester';
diff --git a/clients/algoliasearch-client-javascript/packages/requester-node-http/tsconfig.json b/clients/algoliasearch-client-javascript/packages/requester-node-http/tsconfig.json
@@ -4,6 +4,6 @@
     "types": ["node", "vitest/globals"],
     "outDir": "dist"
   },
-  "include": ["src", "index.ts"],
+  "include": ["src"],
   "exclude": ["dist", "node_modules", "src/__tests__"]
 }
diff --git a/clients/algoliasearch-client-javascript/packages/requester-node-http/tsup.config.ts b/clients/algoliasearch-client-javascript/packages/requester-node-http/tsup.config.ts
@@ -8,13 +8,13 @@ export default defineConfig([
   {
     ...getBaseNodeOptions(pkg, __dirname),
     format: 'cjs',
-    entry: { 'requester.http': 'index.ts' },
-    dts: { entry: { 'requester.http': 'index.ts' } },
+    entry: { 'requester.http': 'src/index.ts' },
+    dts: { entry: { 'requester.http': 'src/index.ts' } },
   },
   {
     ...getBaseNodeOptions(pkg, __dirname),
     format: 'esm',
-    entry: { 'requester.http': 'index.ts' },
-    dts: { entry: { 'requester.http': 'index.ts' } },
+    entry: { 'requester.http': 'src/index.ts' },
+    dts: { entry: { 'requester.http': 'src/index.ts' } },
   },
 ]);
diff --git a/clients/algoliasearch-client-javascript/packages/requester-testing/index.ts b/clients/algoliasearch-client-javascript/packages/requester-testing/index.ts
diff --git a/clients/algoliasearch-client-javascript/packages/requester-testing/src/browserEchoRequester.ts b/clients/algoliasearch-client-javascript/packages/requester-testing/src/browserEchoRequester.ts
@@ -5,3 +5,5 @@ import { createEchoRequester } from './createEchoRequester';
 export function browserEchoRequester(status: number = 200): Requester {
   return createEchoRequester({ getURL: (url: string) => new URL(url), status });
 }
+
+export type { EchoResponse } from './createEchoRequester.ts';
diff --git a/clients/algoliasearch-client-javascript/packages/requester-testing/src/index.ts b/clients/algoliasearch-client-javascript/packages/requester-testing/src/index.ts
@@ -0,0 +1,3 @@
+export * from './browserEchoRequester';
+export * from './createEchoRequester';
+export * from './nodeEchoRequester';
diff --git a/clients/algoliasearch-client-javascript/packages/requester-testing/src/nodeEchoRequester.ts b/clients/algoliasearch-client-javascript/packages/requester-testing/src/nodeEchoRequester.ts
@@ -7,3 +7,5 @@ import { createEchoRequester } from './createEchoRequester';
 export function nodeEchoRequester(status: number = 200): Requester {
   return createEchoRequester({ getURL: (url: string) => new URL(url), status });
 }
+
+export type { EchoResponse } from './createEchoRequester.ts';
diff --git a/clients/algoliasearch-client-javascript/packages/requester-testing/tsconfig.json b/clients/algoliasearch-client-javascript/packages/requester-testing/tsconfig.json
@@ -4,6 +4,6 @@
     "types": ["node"],
     "outDir": "dist"
   },
-  "include": ["src", "index.ts"],
+  "include": ["src"],
   "exclude": ["dist", "node_modules"]
 }
diff --git a/config/base.tsconfig.json b/config/base.tsconfig.json
@@ -1,13 +1,13 @@
 {
   "compilerOptions": {
-    "module": "commonjs",
+    "module": "nodenext",
     "noImplicitAny": false,
     "target": "esnext",
     "allowSyntheticDefaultImports": true,
     "esModuleInterop": true,
     "strict": true,
     "skipLibCheck": true,
-    "moduleResolution": "node",
+    "moduleResolution": "nodenext",
     "removeComments": true,
     "sourceMap": true,
     "noLib": false,
diff --git a/templates/javascript/tests/client/client.mustache b/templates/javascript/tests/client/client.mustache
@@ -1,6 +1,5 @@
 // {{generationBanner}}
 /* eslint-disable eslint/no-unused-vars */
-// @ts-nocheck Failing tests will have type errors, but we cannot suppress them even with @ts-expect-error because it doesn't work for a block of lines.
 import { describe, test, expect } from 'vitest';
 
 import { {{{clientName}}} } from '{{{importPackage}}}';
diff --git a/templates/javascript/tests/client/createClient.mustache b/templates/javascript/tests/client/createClient.mustache
@@ -1 +1,47 @@
-{{^autoCreateClient}}const client = {{/autoCreateClient}}{{{clientName}}}('{{parametersWithDataTypeMap.appId.value}}', '{{parametersWithDataTypeMap.apiKey.value}}'{{#isSearchClient}}, { {{#useEchoRequester}}requester: nodeEchoRequester(),{{/useEchoRequester}}{{#hasCustomHosts}}hosts:[{{#customHosts}}{ url: 'localhost', port: {{port}}, accept: 'readWrite', protocol: 'http' },{{/customHosts}}]{{/hasCustomHosts}} }{{/isSearchClient}}){{^isSearchClient}}.{{{initMethod}}}({ options: { {{#useEchoRequester}}requester: nodeEchoRequester(),{{/useEchoRequester}} {{#hasCustomHosts}}hosts:[{{#customHosts}}{ url: 'localhost', port: {{port}}, accept: 'readWrite', protocol: 'http' },{{/customHosts}}]{{/hasCustomHosts}} }, {{#hasRegionalHost}} region:'{{{parametersWithDataTypeMap.region.value}}}' {{/hasRegionalHost}} }){{/isSearchClient}};
+{{^autoCreateClient}}const client = {{/autoCreateClient}}{{{clientName}}}(
+  '{{parametersWithDataTypeMap.appId.value}}',
+  '{{parametersWithDataTypeMap.apiKey.value}}'
+  {{#isSearchClient}},
+  {
+    {{#useEchoRequester}}
+    requester: nodeEchoRequester(),
+    {{/useEchoRequester}}
+    {{#hasCustomHosts}}
+    hosts:[
+    {{#customHosts}}
+    {
+      url: 'localhost',
+      port: {{port}},
+      accept: 'readWrite',
+      protocol: 'http'
+    },
+    {{/customHosts}}
+    ]
+    {{/hasCustomHosts}} 
+  }
+  {{/isSearchClient}}
+){{^isSearchClient}}.{{{initMethod}}}(
+  {
+    options: {
+    {{#useEchoRequester}}
+      requester: nodeEchoRequester(),
+    {{/useEchoRequester}}
+    {{#hasCustomHosts}}
+      hosts:[
+      {{#customHosts}}
+      {
+        url: 'localhost',
+        port: {{port}},
+        accept: 'readWrite',
+        protocol: 'http'
+      },
+      {{/customHosts}}
+      ]
+      {{/hasCustomHosts}}
+  },
+ {{#hasRegionalHost}}
+ // @ts-ignore
+ region: '{{{parametersWithDataTypeMap.region.value}}}'
+ {{/hasRegionalHost}}
+})
+{{/isSearchClient}};
diff --git a/templates/javascript/tests/client/tests.mustache b/templates/javascript/tests/client/tests.mustache
@@ -12,6 +12,7 @@ describe('{{testType}}', () => {
       {{/times}}
       {{#isError}}
         try {
+          // @ts-ignore
           {{#dynamicTemplate}}{{/dynamicTemplate}}
           throw new Error('test is expected to throw error');
         } catch(e) {
@@ -39,7 +40,7 @@ describe('{{testType}}', () => {
               expect(result).toEqual("{{{match.value}}}");
             {{/match.isString}}
             {{^match.isString}}
-              expect(result).toEqual({{{match.value}}});
+              expect(result).toEqual({{^match.isNull}}{{{match.value}}}{{/match.isNull}}{{#match.isNull}}undefined{{/match.isNull}});
             {{/match.isString}}
           {{/match.isPrimitive}}
           {{^match.isPrimitive}}
diff --git a/templates/javascript/tests/e2e/e2e.mustache b/templates/javascript/tests/e2e/e2e.mustache
@@ -1,7 +1,7 @@
 // {{generationBanner}}
 import { describe, test, expect } from 'vitest';
 
-import { union } from '../helpers';
+import { union } from '../helpers.js';
 
 import * as dotenv from 'dotenv';
 
diff --git a/templates/javascript/tests/package.mustache b/templates/javascript/tests/package.mustache
@@ -1,12 +1,12 @@
 {
   "name": "javascript-tests",
+  "type": "module",
   "version": "1.0.0",
   "scripts": {
     "test": "tsc --noEmit && vitest run"
   },
   "dependencies": {
     "algoliasearch": "link:../../../clients/algoliasearch-client-javascript/packages/algoliasearch",
-    "@algolia/client-common": "link:../../../clients/algoliasearch-client-javascript/packages/client-common",
     "@algolia/requester-testing": "link:../../../clients/algoliasearch-client-javascript/packages/requester-testing"
   },
   "devDependencies": {
diff --git a/templates/javascript/tests/requests/requests.mustache b/templates/javascript/tests/requests/requests.mustache
@@ -4,12 +4,13 @@ import { describe, test, expect } from 'vitest';
 import { {{{clientName}}} } from '{{{importPackage}}}';
 import { nodeEchoRequester } from '@algolia/requester-testing';
 import type { EchoResponse } from '@algolia/requester-testing';
-import type { RequestOptions } from '@algolia/client-common';
+import type { ClientOptions } from '@algolia/client-common';
 
 const appId = process.env.ALGOLIA_APPLICATION_ID || 'test_app_id';
 const apiKey = process.env.ALGOLIA_SEARCH_KEY || 'test_api_key';
 
-const client = {{{clientName}}}(appId, apiKey{{#isSearchClient}}, { requester: nodeEchoRequester() }{{/isSearchClient}}){{^isSearchClient}}.{{{initMethod}}}({ options: { requester: nodeEchoRequester() }, {{#hasRegionalHost}} region:'{{{defaultRegion}}}' {{/hasRegionalHost}} });{{/isSearchClient}};
+const clientOptions: ClientOptions = { requester: nodeEchoRequester() }; // this makes sure the types are correctly exported
+const client = {{{clientName}}}(appId, apiKey{{#isSearchClient}}, { requester: nodeEchoRequester() }{{/isSearchClient}}){{^isSearchClient}}.{{{initMethod}}}({ options: clientOptions, {{#hasRegionalHost}} region:'{{{defaultRegion}}}' {{/hasRegionalHost}} });{{/isSearchClient}};
 
 {{#blocksRequests}}
 describe('{{operationId}}', () => {
diff --git a/tests/output/javascript/tsconfig.json b/tests/output/javascript/tsconfig.json
@@ -1,7 +1,7 @@
 {
   "extends": "../../../config/base.tsconfig.json",
   "compilerOptions": {
-    "typeRoots": ["../../../node_modules/@types"],
+    "skipLibCheck": false,
     "types": ["node"],
     "lib": ["dom", "esnext"]
   },
diff --git a/tests/output/javascript/yarn.lock b/tests/output/javascript/yarn.lock

Original file line number	Diff line number	Diff line change
`@@ -4,6 +4,6 @@`
`4`	`4`	`"types": ["node", "vitest/globals"],`
`5`	`5`	`"outDir": "dist"`
`6`	`6`	`},`
`7`		`- "include": ["src", "index.ts"],`
	`7`	`+ "include": ["src"],`
`8`	`8`	`"exclude": ["dist", "node_modules", "src/__tests__"]`
`9`	`9`	`}`