Put firebase/* entry point ESM files in their own subdirs with "type: module" package.json (#6826)

hsubox76 · web-flow · commit 7e237cd47d7a · 2022-12-01T09:11:42.000-08:00
diff --git a/.changeset/eighty-ants-do.md b/.changeset/eighty-ants-do.md
@@ -0,0 +1,5 @@
+---
+'firebase': patch
+---
+
+Modify entry point ESM bundles to conform to Node ESM specs.
diff --git a/packages/firebase/analytics/package.json b/packages/firebase/analytics/package.json
@@ -1,7 +1,7 @@
 {
   "name": "firebase/analytics",
   "main": "dist/index.cjs.js",
-  "browser": "dist/index.esm.js",
-  "module": "dist/index.esm.js",
+  "browser": "dist/esm/index.esm.js",
+  "module": "dist/esm/index.esm.js",
   "typings": "dist/analytics/index.d.ts"
-}
+}
diff --git a/packages/firebase/app-check/package.json b/packages/firebase/app-check/package.json
@@ -1,7 +1,7 @@
 {
   "name": "firebase/app-check",
   "main": "dist/index.cjs.js",
-  "browser": "dist/index.esm.js",
-  "module": "dist/index.esm.js",
+  "browser": "dist/esm/index.esm.js",
+  "module": "dist/esm/index.esm.js",
   "typings": "dist/app-check/index.d.ts"
-}
+}
diff --git a/packages/firebase/app/package.json b/packages/firebase/app/package.json
@@ -1,7 +1,7 @@
 {
   "name": "firebase/app",
   "main": "dist/index.cjs.js",
-  "browser": "dist/index.esm.js",
-  "module": "dist/index.esm.js",
+  "browser": "dist/esm/index.esm.js",
+  "module": "dist/esm/index.esm.js",
   "typings": "dist/app/index.d.ts"
-}
+}
diff --git a/packages/firebase/auth/cordova/package.json b/packages/firebase/auth/cordova/package.json
@@ -1,7 +1,7 @@
 {
   "name": "firebase/auth/cordova",
   "main": "dist/index.cjs.js",
-  "browser": "dist/index.esm.js",
-  "module": "dist/index.esm.js",
+  "browser": "dist/esm/index.esm.js",
+  "module": "dist/esm/index.esm.js",
   "typings": "dist/auth/cordova/index.d.ts"
-}
+}
diff --git a/packages/firebase/auth/package.json b/packages/firebase/auth/package.json
@@ -1,7 +1,7 @@
 {
   "name": "firebase/auth",
   "main": "dist/index.cjs.js",
-  "browser": "dist/index.esm.js",
-  "module": "dist/index.esm.js",
+  "browser": "dist/esm/index.esm.js",
+  "module": "dist/esm/index.esm.js",
   "typings": "dist/auth/index.d.ts"
-}
+}
diff --git a/packages/firebase/auth/react-native/package.json b/packages/firebase/auth/react-native/package.json
@@ -1,7 +1,7 @@
 {
   "name": "firebase/auth/react-native",
   "main": "dist/index.cjs.js",
-  "browser": "dist/index.esm.js",
-  "module": "dist/index.esm.js",
+  "browser": "dist/esm/index.esm.js",
+  "module": "dist/esm/index.esm.js",
   "typings": "dist/auth/react-native/index.d.ts"
-}
+}
diff --git a/packages/firebase/compat/analytics/package.json b/packages/firebase/compat/analytics/package.json
@@ -1,7 +1,7 @@
 {
   "name": "firebase/compat/analytics",
   "main": "dist/index.cjs.js",
-  "browser": "dist/index.esm.js",
-  "module": "dist/index.esm.js",
+  "browser": "dist/esm/index.esm.js",
+  "module": "dist/esm/index.esm.js",
   "typings": "dist/compat/analytics/index.d.ts"
-}
+}
diff --git a/packages/firebase/compat/app-check/package.json b/packages/firebase/compat/app-check/package.json
@@ -1,7 +1,7 @@
 {
   "name": "firebase/compat/app-check",
   "main": "dist/index.cjs.js",
-  "browser": "dist/index.esm.js",
-  "module": "dist/index.esm.js",
+  "browser": "dist/esm/index.esm.js",
+  "module": "dist/esm/index.esm.js",
   "typings": "dist/compat/app-check/index.d.ts"
-}
+}
diff --git a/packages/firebase/compat/app/package.json b/packages/firebase/compat/app/package.json
@@ -1,7 +1,7 @@
 {
   "name": "firebase/compat/app",
   "main": "dist/index.cjs.js",
-  "browser": "dist/index.esm.js",
-  "module": "dist/index.esm.js",
+  "browser": "dist/esm/index.esm.js",
+  "module": "dist/esm/index.esm.js",
   "typings": "../index.d.ts"
-}
+}
diff --git a/packages/firebase/compat/auth/package.json b/packages/firebase/compat/auth/package.json
@@ -1,7 +1,7 @@
 {
   "name": "firebase/compat/auth",
   "main": "dist/index.cjs.js",
-  "browser": "dist/index.esm.js",
-  "module": "dist/index.esm.js",
+  "browser": "dist/esm/index.esm.js",
+  "module": "dist/esm/index.esm.js",
   "typings": "dist/compat/auth/index.d.ts"
-}
+}
diff --git a/packages/firebase/compat/database/package.json b/packages/firebase/compat/database/package.json
@@ -1,7 +1,7 @@
 {
   "name": "firebase/compat/database",
   "main": "dist/index.cjs.js",
-  "browser": "dist/index.esm.js",
-  "module": "dist/index.esm.js",
+  "browser": "dist/esm/index.esm.js",
+  "module": "dist/esm/index.esm.js",
   "typings": "dist/compat/database/index.d.ts"
-}
+}
diff --git a/packages/firebase/compat/firestore/package.json b/packages/firebase/compat/firestore/package.json
@@ -1,7 +1,7 @@
 {
   "name": "firebase/compat/firestore",
   "main": "dist/index.cjs.js",
-  "browser": "dist/index.esm.js",
-  "module": "dist/index.esm.js",
+  "browser": "dist/esm/index.esm.js",
+  "module": "dist/esm/index.esm.js",
   "typings": "dist/compat/firestore/index.d.ts"
-}
+}
diff --git a/packages/firebase/compat/functions/package.json b/packages/firebase/compat/functions/package.json
@@ -1,7 +1,7 @@
 {
   "name": "firebase/compat/functions",
   "main": "dist/index.cjs.js",
-  "browser": "dist/index.esm.js",
-  "module": "dist/index.esm.js",
+  "browser": "dist/esm/index.esm.js",
+  "module": "dist/esm/index.esm.js",
   "typings": "dist/compat/functions/index.d.ts"
-}
+}
diff --git a/packages/firebase/compat/installations/package.json b/packages/firebase/compat/installations/package.json
@@ -1,7 +1,7 @@
 {
   "name": "firebase/compat/installations",
   "main": "dist/index.cjs.js",
-  "browser": "dist/index.esm.js",
-  "module": "dist/index.esm.js",
+  "browser": "dist/esm/index.esm.js",
+  "module": "dist/esm/index.esm.js",
   "typings": "dist/compat/installations/index.d.ts"
-}
+}
diff --git a/packages/firebase/compat/messaging/package.json b/packages/firebase/compat/messaging/package.json
@@ -1,7 +1,7 @@
 {
   "name": "firebase/compat/messaging",
   "main": "dist/index.cjs.js",
-  "browser": "dist/index.esm.js",
-  "module": "dist/index.esm.js",
+  "browser": "dist/esm/index.esm.js",
+  "module": "dist/esm/index.esm.js",
   "typings": "dist/compat/messaging/index.d.ts"
-}
+}
diff --git a/packages/firebase/compat/package.json b/packages/firebase/compat/package.json
@@ -1,8 +1,8 @@
 {
   "name": "firebase/compat",
   "main": "dist/index.node.cjs",
-  "browser": "dist/index.esm.js",
-  "module": "dist/index.esm.js",
+  "browser": "dist/esm/index.esm.js",
+  "module": "dist/esm/index.esm.js",
   "react-native": "dist/index.rn.cjs.js",
   "typings": "index.d.ts",
   "components": [
@@ -19,4 +19,4 @@
     "storage",
     "database"
   ]
-}
+}
diff --git a/packages/firebase/compat/performance/package.json b/packages/firebase/compat/performance/package.json
@@ -1,7 +1,7 @@
 {
   "name": "firebase/compat/performance",
   "main": "dist/index.cjs.js",
-  "browser": "dist/index.esm.js",
-  "module": "dist/index.esm.js",
+  "browser": "dist/esm/index.esm.js",
+  "module": "dist/esm/index.esm.js",
   "typings": "dist/compat/performance/index.d.ts"
-}
+}
diff --git a/packages/firebase/compat/remote-config/package.json b/packages/firebase/compat/remote-config/package.json
@@ -1,7 +1,7 @@
 {
   "name": "firebase/compat/remote-config",
   "main": "dist/index.cjs.js",
-  "browser": "dist/index.esm.js",
-  "module": "dist/index.esm.js",
+  "browser": "dist/esm/index.esm.js",
+  "module": "dist/esm/index.esm.js",
   "typings": "dist/compat/remote-config/index.d.ts"
-}
+}
diff --git a/packages/firebase/compat/rollup.config.js b/packages/firebase/compat/rollup.config.js
@@ -27,6 +27,7 @@ import json from '@rollup/plugin-json';
 import pkg from '../package.json';
 import compatPkg from './package.json';
 import appPkg from './app/package.json';
+import { emitModulePackageFile } from '../../../scripts/build/rollup_emit_module_package_file';
 
 const external = Object.keys(pkg.dependencies || {});
 const uglifyOptions = {
@@ -92,7 +93,25 @@ const typescriptPluginCDN = rollupTypescriptPlugin({
  */
 const appBuilds = [
   /**
-   * App Browser Builds
+   * App ESM Build
+   * Uses "type:module" in package.json to signal this is ESM.
+   * Allows the extension to remain '.js' as some tools do not recognize
+   * '.mjs'.
+   */
+  {
+    input: `${__dirname}/app/index.ts`,
+    output: [
+      {
+        file: resolve(__dirname, 'app', appPkg.browser),
+        format: 'es',
+        sourcemap: true
+      }
+    ],
+    plugins: [...plugins, typescriptPlugin, emitModulePackageFile()],
+    external: id => external.some(dep => id === dep || id.startsWith(`${dep}/`))
+  },
+  /**
+   * App CJS/MJS Builds
    */
   {
     input: `${__dirname}/app/index.ts`,
@@ -106,11 +125,6 @@ const appBuilds = [
         file: resolve(__dirname, 'app', appPkg.main.replace('.cjs.js', '.mjs')),
         format: 'es',
         sourcemap: true
-      },
-      {
-        file: resolve(__dirname, 'app', appPkg.browser),
-        format: 'es',
-        sourcemap: true
       }
     ],
     plugins: [...plugins, typescriptPlugin],
@@ -137,6 +151,28 @@ const componentBuilds = compatPkg.components
   .map(component => {
     const pkg = require(`${__dirname}/${component}/package.json`);
     return [
+      /**
+       * Component ESM build
+       * Uses "type:module" in package.json to signal this is ESM.
+       * Allows the extension to remain '.js' as some tools do not recognize
+       * '.mjs'.
+       */
+      {
+        input: `${__dirname}/${component}/index.ts`,
+        output: [
+          {
+            file: resolve(__dirname, component, pkg.browser),
+            format: 'es',
+            sourcemap: true
+          }
+        ],
+        plugins: [...plugins, typescriptPlugin, emitModulePackageFile()],
+        external: id =>
+          external.some(dep => id === dep || id.startsWith(`${dep}/`))
+      },
+      /**
+       * Component CJS/MJS builds
+       */
       {
         input: `${__dirname}/${component}/index.ts`,
         output: [
@@ -164,6 +200,9 @@ const componentBuilds = compatPkg.components
         external: id =>
           external.some(dep => id === dep || id.startsWith(`${dep}/`))
       },
+      /**
+       * Component UMD build
+       */
       {
         input: `${__dirname}/${component}/index.ts`,
         output: createUmdOutputConfig(`firebase-${component}-compat.js`),
diff --git a/packages/firebase/compat/storage/package.json b/packages/firebase/compat/storage/package.json
@@ -1,7 +1,7 @@
 {
   "name": "firebase/compat/storage",
   "main": "dist/index.cjs.js",
-  "browser": "dist/index.esm.js",
-  "module": "dist/index.esm.js",
+  "browser": "dist/esm/index.esm.js",
+  "module": "dist/esm/index.esm.js",
   "typings": "dist/compat/storage/index.d.ts"
-}
+}
diff --git a/packages/firebase/database/package.json b/packages/firebase/database/package.json
@@ -1,7 +1,7 @@
 {
   "name": "firebase/database",
   "main": "dist/index.cjs.js",
-  "browser": "dist/index.esm.js",
-  "module": "dist/index.esm.js",
+  "browser": "dist/esm/index.esm.js",
+  "module": "dist/esm/index.esm.js",
   "typings": "dist/database/index.d.ts"
-}
+}
diff --git a/packages/firebase/firestore/lite/package.json b/packages/firebase/firestore/lite/package.json
@@ -1,7 +1,7 @@
 {
   "name": "firebase/firestore/lite",
   "main": "dist/index.cjs.js",
-  "browser": "dist/index.esm.js",
-  "module": "dist/index.esm.js",
+  "browser": "dist/esm/index.esm.js",
+  "module": "dist/esm/index.esm.js",
   "typings": "dist/firestore/lite/index.d.ts"
-}
+}
diff --git a/packages/firebase/firestore/package.json b/packages/firebase/firestore/package.json
@@ -1,7 +1,7 @@
 {
   "name": "firebase/firestore",
   "main": "dist/index.cjs.js",
-  "browser": "dist/index.esm.js",
-  "module": "dist/index.esm.js",
+  "browser": "dist/esm/index.esm.js",
+  "module": "dist/esm/index.esm.js",
   "typings": "dist/firestore/index.d.ts"
-}
+}
diff --git a/packages/firebase/functions/package.json b/packages/firebase/functions/package.json
@@ -1,7 +1,7 @@
 {
   "name": "firebase/functions",
   "main": "dist/index.cjs.js",
-  "browser": "dist/index.esm.js",
-  "module": "dist/index.esm.js",
+  "browser": "dist/esm/index.esm.js",
+  "module": "dist/esm/index.esm.js",
   "typings": "dist/functions/index.d.ts"
-}
+}
diff --git a/packages/firebase/installations/package.json b/packages/firebase/installations/package.json
@@ -1,7 +1,7 @@
 {
   "name": "firebase/installations",
   "main": "dist/index.cjs.js",
-  "browser": "dist/index.esm.js",
-  "module": "dist/index.esm.js",
+  "browser": "dist/esm/index.esm.js",
+  "module": "dist/esm/index.esm.js",
   "typings": "dist/installations/index.d.ts"
-}
+}
diff --git a/packages/firebase/messaging/package.json b/packages/firebase/messaging/package.json
@@ -1,7 +1,7 @@
 {
   "name": "firebase/messaging",
   "main": "dist/index.cjs.js",
-  "browser": "dist/index.esm.js",
-  "module": "dist/index.esm.js",
+  "browser": "dist/esm/index.esm.js",
+  "module": "dist/esm/index.esm.js",
   "typings": "dist/messaging/index.d.ts"
-}
+}
diff --git a/packages/firebase/messaging/sw/package.json b/packages/firebase/messaging/sw/package.json
diff --git a/packages/firebase/package.json b/packages/firebase/package.json
diff --git a/packages/firebase/performance/package.json b/packages/firebase/performance/package.json
diff --git a/packages/firebase/remote-config/package.json b/packages/firebase/remote-config/package.json
diff --git a/packages/firebase/rollup.config.js b/packages/firebase/rollup.config.js
diff --git a/packages/firebase/storage/package.json b/packages/firebase/storage/package.json
diff --git a/scripts/ci-test/check-paths.ts b/scripts/ci-test/check-paths.ts

-Original file line number
+Diff line change
@@ @@ -0,0 +1,5 @@ @@
 +---
 +'firebase': patch
 +---
++
 +Modify entry point ESM bundles to conform to Node ESM specs.