fix(build): ensure correct typing for node esm (#3209)

Co-authored-by: Anthony Fu <anthonyfu117@hotmail.com>
vueuse · Jul 30, 2023 · e755653 · e755653
1 parent a32ae73
commit e755653
Show file tree

Hide file tree

Showing 17 changed files with 35 additions and 55 deletions.
diff --git a/packages/components/package.json b/packages/components/package.json
@@ -21,7 +21,6 @@
   "sideEffects": false,
   "exports": {
     ".": {
-      "types": "./index.d.ts",
       "require": "./index.cjs",
       "import": "./index.mjs"
     },
@@ -31,7 +30,7 @@
   "module": "./index.mjs",
   "unpkg": "./index.iife.min.js",
   "jsdelivr": "./index.iife.min.js",
-  "types": "./index.d.ts",
+  "types": "./index.d.cts",
   "dependencies": {
     "@vueuse/core": "workspace:*",
     "@vueuse/shared": "workspace:*",

diff --git a/packages/core/metadata.d.cts b/packages/core/metadata.d.cts
@@ -0,0 +1 @@
+export * from '@vueuse/metadata'
diff --git a/packages/core/metadata.d.mts b/packages/core/metadata.d.mts
@@ -0,0 +1 @@
+export * from '@vueuse/metadata'
diff --git a/packages/core/package.json b/packages/core/package.json
@@ -22,13 +22,11 @@
   "sideEffects": false,
   "exports": {
     ".": {
-      "types": "./index.d.ts",
       "require": "./index.cjs",
       "import": "./index.mjs"
     },
     "./*": "./*",
     "./metadata": {
-      "types": "./metadata.d.ts",
       "require": "./metadata.cjs",
       "import": "./metadata.mjs"
     }
@@ -37,7 +35,7 @@
   "module": "./index.mjs",
   "unpkg": "./index.iife.min.js",
   "jsdelivr": "./index.iife.min.js",
-  "types": "./index.d.ts",
+  "types": "./index.d.cts",
   "dependencies": {
     "@types/web-bluetooth": "^0.0.17",
     "@vueuse/metadata": "workspace:*",

diff --git a/packages/electron/package.json b/packages/electron/package.json
@@ -24,15 +24,14 @@
   "sideEffects": false,
   "exports": {
     ".": {
-      "types": "./index.d.ts",
       "require": "./index.cjs",
       "import": "./index.mjs"
     },
     "./*": "./*"
   },
   "main": "./index.cjs",
   "module": "./index.mjs",
-  "types": "./index.d.ts",
+  "types": "./index.d.cts",
   "peerDependencies": {
     "electron": ">=9.0.0"
   },

diff --git a/packages/firebase/package.json b/packages/firebase/package.json
@@ -24,23 +24,19 @@
   "sideEffects": false,
   "exports": {
     ".": {
-      "types": "./index.d.ts",
       "require": "./index.cjs",
       "import": "./index.mjs"
     },
     "./*": "./*",
     "./useAuth": {
-      "types": "./useAuth.d.ts",
       "require": "./useAuth.cjs",
       "import": "./useAuth.mjs"
     },
     "./useFirestore": {
-      "types": "./useFirestore.d.ts",
       "require": "./useFirestore.cjs",
       "import": "./useFirestore.mjs"
     },
     "./useRTDB": {
-      "types": "./useRTDB.d.ts",
       "require": "./useRTDB.cjs",
       "import": "./useRTDB.mjs"
     }
@@ -49,7 +45,7 @@
   "module": "./index.mjs",
   "unpkg": "./index.iife.min.js",
   "jsdelivr": "./index.iife.min.js",
-  "types": "./index.d.ts",
+  "types": "./index.d.cts",
   "peerDependencies": {
     "firebase": ">=9.0.0"
   },

diff --git a/packages/integrations/package.json b/packages/integrations/package.json
@@ -22,83 +22,67 @@
   "sideEffects": false,
   "exports": {
     ".": {
-      "types": "./index.d.ts",
       "require": "./index.cjs",
       "import": "./index.mjs"
     },
     "./*": "./*",
     "./useAsyncValidator": {
-      "types": "./useAsyncValidator.d.ts",
       "require": "./useAsyncValidator.cjs",
       "import": "./useAsyncValidator.mjs"
     },
     "./useAxios": {
-      "types": "./useAxios.d.ts",
       "require": "./useAxios.cjs",
       "import": "./useAxios.mjs"
     },
     "./useCookies": {
-      "types": "./useCookies.d.ts",
       "require": "./useCookies.cjs",
       "import": "./useCookies.mjs"
     },
     "./useDrauu": {
-      "types": "./useDrauu.d.ts",
       "require": "./useDrauu.cjs",
       "import": "./useDrauu.mjs"
     },
     "./useFocusTrap": {
-      "types": "./useFocusTrap.d.ts",
       "require": "./useFocusTrap.cjs",
       "import": "./useFocusTrap.mjs"
     },
     "./useFocusTrap/component": {
-      "types": "./useFocusTrap/component.d.ts",
       "require": "./useFocusTrap/component.cjs",
       "import": "./useFocusTrap/component.mjs"
     },
     "./useFuse": {
-      "types": "./useFuse.d.ts",
       "require": "./useFuse.cjs",
       "import": "./useFuse.mjs"
     },
     "./useJwt": {
-      "types": "./useJwt.d.ts",
       "require": "./useJwt.cjs",
       "import": "./useJwt.mjs"
     },
     "./useNProgress": {
-      "types": "./useNProgress.d.ts",
       "require": "./useNProgress.cjs",
       "import": "./useNProgress.mjs"
     },
     "./useQRCode": {
-      "types": "./useQRCode.d.ts",
       "require": "./useQRCode.cjs",
       "import": "./useQRCode.mjs"
     },
     "./useChangeCase": {
-      "types": "./useChangeCase.d.ts",
       "require": "./useChangeCase.cjs",
       "import": "./useChangeCase.mjs"
     },
     "./useAsyncValidator/component": {
-      "types": "./useAsyncValidator/component.d.ts",
       "require": "./useAsyncValidator/component.cjs",
       "import": "./useAsyncValidator/component.mjs"
     },
     "./useIDBKeyval": {
-      "types": "./useIDBKeyval.d.ts",
       "require": "./useIDBKeyval.cjs",
       "import": "./useIDBKeyval.mjs"
     },
     "./useSortable": {
-      "types": "./useSortable.d.ts",
       "require": "./useSortable.cjs",
       "import": "./useSortable.mjs"
     },
     "./useSortable/component": {
-      "types": "./useSortable/component.d.ts",
       "require": "./useSortable/component.cjs",
       "import": "./useSortable/component.mjs"
     }
@@ -107,7 +91,7 @@
   "module": "./index.mjs",
   "unpkg": "./index.iife.min.js",
   "jsdelivr": "./index.iife.min.js",
-  "types": "./index.d.ts",
+  "types": "./index.d.cts",
   "peerDependencies": {
     "async-validator": "*",
     "axios": "*",

diff --git a/packages/math/package.json b/packages/math/package.json
@@ -23,7 +23,6 @@
   "sideEffects": false,
   "exports": {
     ".": {
-      "types": "./index.d.ts",
       "require": "./index.cjs",
       "import": "./index.mjs"
     },
@@ -33,7 +32,7 @@
   "module": "./index.mjs",
   "unpkg": "./index.iife.min.js",
   "jsdelivr": "./index.iife.min.js",
-  "types": "./index.d.ts",
+  "types": "./index.d.cts",
   "dependencies": {
     "@vueuse/shared": "workspace:*",
     "vue-demi": ">=0.14.5"

diff --git a/packages/metadata/package.json b/packages/metadata/package.json
@@ -21,15 +21,14 @@
   "sideEffects": false,
   "exports": {
     ".": {
-      "types": "./index.d.ts",
       "require": "./index.cjs",
       "import": "./index.mjs"
     },
     "./*": "./*"
   },
   "main": "./index.cjs",
   "module": "./index.mjs",
-  "types": "./index.d.ts",
+  "types": "./index.d.cts",
   "files": [
     "index.*"
   ],

diff --git a/packages/nuxt/package.json b/packages/nuxt/package.json
@@ -24,15 +24,14 @@
   "sideEffects": false,
   "exports": {
     ".": {
-      "types": "./index.d.ts",
       "require": "./index.cjs",
       "import": "./index.mjs"
     },
     "./*": "./*"
   },
   "main": "./index.cjs",
   "module": "./index.mjs",
-  "types": "./index.d.ts",
+  "types": "./index.d.cts",
   "peerDependencies": {
     "nuxt": "^3.0.0"
   },

diff --git a/packages/router/package.json b/packages/router/package.json
@@ -23,7 +23,6 @@
   "sideEffects": false,
   "exports": {
     ".": {
-      "types": "./index.d.ts",
       "require": "./index.cjs",
       "import": "./index.mjs"
     },
@@ -33,7 +32,7 @@
   "module": "./index.mjs",
   "unpkg": "./index.iife.min.js",
   "jsdelivr": "./index.iife.min.js",
-  "types": "./index.d.ts",
+  "types": "./index.d.cts",
   "peerDependencies": {
     "vue-router": ">=4.0.0-rc.1"
   },

diff --git a/packages/rxjs/package.json b/packages/rxjs/package.json
@@ -24,7 +24,6 @@
   "sideEffects": false,
   "exports": {
     ".": {
-      "types": "./index.d.ts",
       "require": "./index.cjs",
       "import": "./index.mjs"
     },
@@ -34,7 +33,7 @@
   "module": "./index.mjs",
   "unpkg": "./index.iife.min.js",
   "jsdelivr": "./index.iife.min.js",
-  "types": "./index.d.ts",
+  "types": "./index.d.cts",
   "peerDependencies": {
     "rxjs": ">=6.0.0"
   },

diff --git a/packages/shared/package.json b/packages/shared/package.json
@@ -21,7 +21,6 @@
   "sideEffects": false,
   "exports": {
     ".": {
-      "types": "./index.d.ts",
       "require": "./index.cjs",
       "import": "./index.mjs"
     },
@@ -31,7 +30,7 @@
   "module": "./index.mjs",
   "unpkg": "./index.iife.min.js",
   "jsdelivr": "./index.iife.min.js",
-  "types": "./index.d.ts",
+  "types": "./index.d.cts",
   "dependencies": {
     "vue-demi": ">=0.14.5"
   }

diff --git a/scripts/build.ts b/scripts/build.ts
@@ -23,6 +23,8 @@ const FILES_COPY_LOCAL = [
   '*.cjs',
   '*.mjs',
   '*.d.ts',
+  '*.d.cts',
+  '*.d.mts',
 ]
 
 assert(process.cwd() !== __dirname)

diff --git a/scripts/fix-types.ts b/scripts/fix-types.ts
@@ -2,7 +2,14 @@ import fg from 'fast-glob'
 import fs from 'fs-extra'
 
 export async function fixTypes() {
-  const files = await fg(['types/**/*.d.ts', 'packages/*/dist/*.d.ts'], {
+  const files = await fg([
+    'types/**/*.d.ts',
+    'types/**/*.d.cts',
+    'types/**/*.d.mts',
+    'packages/*/dist/*.d.ts',
+    'packages/*/dist/*.d.cts',
+    'packages/*/dist/*.d.mts',
+  ], {
     onlyFiles: true,
   })
 

diff --git a/scripts/rollup.config.ts b/scripts/rollup.config.ts
@@ -129,10 +129,11 @@ for (const { globals, name, external, submodules, iife, build, cjs, mjs, dts, ta
     if (dts !== false) {
       configs.push({
         input,
-        output: {
-          file: `packages/${name}/dist/${fn}.d.ts`,
-          format: 'es',
-        },
+        output: [
+          { file: `packages/${name}/dist/${fn}.d.cts` },
+          { file: `packages/${name}/dist/${fn}.d.mts` },
+          { file: `packages/${name}/dist/${fn}.d.ts` }, // for node10 compatibility
+        ],
         plugins: [
           pluginDts,
         ],
@@ -168,10 +169,11 @@ for (const { globals, name, external, submodules, iife, build, cjs, mjs, dts, ta
 
       configs.push({
         input: `packages/${name}/${fn}/component.ts`,
-        output: {
-          file: `packages/${name}/dist/${fn}/component.d.ts`,
-          format: 'es',
-        },
+        output: [
+          { file: `packages/${name}/dist/${fn}/component.d.cts` },
+          { file: `packages/${name}/dist/${fn}/component.d.mts` },
+          { file: `packages/${name}/dist/${fn}/component.d.ts` }, // for node10 compatibility
+        ],
         plugins: [
           pluginDts,
         ],

diff --git a/scripts/utils.ts b/scripts/utils.ts
@@ -17,7 +17,7 @@ export const DIR_SRC = resolve(__dirname, '../packages')
 const DIR_TYPES = resolve(__dirname, '../types/packages')
 
 export async function getTypeDefinition(pkg: string, name: string): Promise<string | undefined> {
-  const typingFilepath = join(DIR_TYPES, `${pkg}/${name}/index.d.ts`)
+  const typingFilepath = join(DIR_TYPES, `${pkg}/${name}/index.d.mts`)
 
   if (!fs.existsSync(typingFilepath))
     return
@@ -242,7 +242,7 @@ export async function updatePackageJSON(indexes: PackageIndexes) {
       directory: `packages/${name}`,
     }
     packageJSON.main = './index.cjs'
-    packageJSON.types = './index.d.ts'
+    packageJSON.types = './index.d.cts'
     packageJSON.module = './index.mjs'
     if (iife !== false) {
       packageJSON.unpkg = './index.iife.min.js'
@@ -252,7 +252,6 @@ export async function updatePackageJSON(indexes: PackageIndexes) {
       '.': {
         import: './index.mjs',
         require: './index.cjs',
-        types: './index.d.ts',
       },
       './*': './*',
       ...packageJSON.exports,
@@ -263,13 +262,11 @@ export async function updatePackageJSON(indexes: PackageIndexes) {
         .filter(i => i.package === name)
         .forEach((i) => {
           packageJSON.exports[`./${i.name}`] = {
-            types: `./${i.name}.d.ts`,
             require: `./${i.name}.cjs`,
             import: `./${i.name}.mjs`,
           }
           if (i.component) {
             packageJSON.exports[`./${i.name}/component`] = {
-              types: `./${i.name}/component.d.ts`,
               require: `./${i.name}/component.cjs`,
               import: `./${i.name}/component.mjs`,
             }