feat: enable ESM support via dual-publishing

taeold · taeold · commit 7fb0fa363fd0 · 2025-10-28T09:28:03.000-07:00
- Configure tsdown to build both CJS and ESM outputs.
- Update package.json exports to support both 'require' and 'import'.
- Fix type hygiene issues by using explicit 'export type'.
- Update protos/update.sh to generate ESM version of compiledFirestore.
- Configure build aliases to handle relative paths to protos correctly.
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
diff --git a/protos/compiledFirestore.mjs b/protos/compiledFirestore.mjs
diff --git a/protos/update.sh b/protos/update.sh
@@ -24,7 +24,7 @@
 
 # vars
 PROTOS_DIR="$(pwd)"
-WORK_DIR=`mktemp -d`
+WORK_DIR=$(mktemp -d)
 
 # deletes the temp directory on exit
 function cleanup {
@@ -37,10 +37,6 @@ function cleanup {
 # register the cleanup function to be called on the EXIT signal
 trap cleanup EXIT
 
-# Capture location of pbjs / pbts before we pushd.
-PBJS="$(npm bin)/pbjs"
-PBTS="$(npm bin)/pbts"
-
 # enter working directory
 pushd "$WORK_DIR"
 
@@ -69,7 +65,32 @@ cp googleapis/google/type/latlng.proto \
 
 popd
 
-"${PBJS}" -t static-module -w commonjs -o compiledFirestore.js \
+PBJS="npx pbjs"
+PBTS="npx pbts"
+
+# Generate CommonJS
+${PBJS} -t static-module -w commonjs -o compiledFirestore.js \
+  data.proto any.proto
+
+# Generate ESM
+${PBJS} -t static-module -w es6 -o compiledFirestore.mjs \
   data.proto any.proto
 
-"${PBTS}" -o compiledFirestore.d.ts compiledFirestore.js
+# Generate Types
+${PBTS} -o compiledFirestore.d.ts compiledFirestore.js
+#
+# Fix imports for Node ESM in the generated .mjs file.
+# See: https://github.com/protobufjs/protobuf.js/issues/1929
+if [[ "$OSTYPE" == "darwin"* ]]; then
+  # 1. Append .js extension: Node ESM requires full paths for subpath imports not in 'exports'.
+  sed -i '' 's|protobufjs/minimal|protobufjs/minimal.js|g' compiledFirestore.mjs
+  # 2. Use default import: protobufjs is CJS. 'import * as' creates a namespace where
+  #    module.exports is under .default. Generated code expects $protobuf to be module.exports directly.
+  sed -i '' 's|import \* as \$protobuf|import \$protobuf|g' compiledFirestore.mjs
+else
+  # 1. Append .js extension.
+  sed -i 's|protobufjs/minimal|protobufjs/minimal.js|g' compiledFirestore.mjs
+  # 2. Use default import.
+  sed -i 's|import \* as \$protobuf|import \$protobuf|g' compiledFirestore.mjs
+fi
+
diff --git a/src/params/index.ts b/src/params/index.ts
@@ -39,17 +39,11 @@ import {
   InternalExpression,
 } from "./types";
 
-export {
-  BUCKET_PICKER,
-  TextInput,
-  SelectInput,
-  SelectOptions,
-  MultiSelectInput,
-  select,
-  multiSelect,
-} from "./types";
+export { BUCKET_PICKER, select, multiSelect } from "./types";
+export type { TextInput, SelectInput, SelectOptions, MultiSelectInput } from "./types";
 
-export { ParamOptions, Expression };
+export { Expression };
+export type { ParamOptions };
 
 type SecretOrExpr = Param<any> | SecretParam | JsonSecretParam<any>;
 export const declaredParams: SecretOrExpr[] = [];
diff --git a/src/v1/cloud-functions.ts b/src/v1/cloud-functions.ts
@@ -20,7 +20,7 @@
 // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 // SOFTWARE.
 
-import { Request, Response } from "express";
+import type { Request, Response } from "express";
 import { warn } from "../logger";
 import {
   DEFAULT_FAILURE_POLICY,
@@ -29,7 +29,7 @@ import {
   FailurePolicy,
   Schedule,
 } from "./function-configuration";
-export { Request, Response };
+export type { Request, Response };
 import {
   convertIfPresent,
   copyIfPresent,
diff --git a/src/v1/providers/auth.ts b/src/v1/providers/auth.ts
@@ -50,7 +50,8 @@ import { DeploymentOptions } from "../function-configuration";
 import { initV1Endpoint } from "../../runtime/manifest";
 
 // TODO: yank in next breaking change release
-export { UserRecord, UserInfo, UserRecordMetadata, userRecordConstructor };
+export { UserRecordMetadata, userRecordConstructor };
+export type { UserRecord, UserInfo };
 
 export { HttpsError };
 
diff --git a/src/v1/providers/https.ts b/src/v1/providers/https.ts
@@ -36,7 +36,8 @@ import { initV1Endpoint } from "../../runtime/manifest";
 import { withInit } from "../../common/onInit";
 import { wrapTraceContext } from "../../v2/trace";
 
-export { Request, CallableContext, FunctionsErrorCode, HttpsError };
+export { HttpsError };
+export type { Request, CallableContext, FunctionsErrorCode };
 
 /**
  * Handle HTTP requests.
diff --git a/src/v1/providers/tasks.ts b/src/v1/providers/tasks.ts
@@ -39,7 +39,7 @@ import {
 import { optionsToEndpoint, optionsToTrigger } from "../cloud-functions";
 import { DeploymentOptions } from "../function-configuration";
 
-export { RetryConfig, RateLimits, TaskContext };
+export type { RetryConfig, RateLimits, TaskContext };
 
 /**
  * Options for configuring the task queue to listen to.
diff --git a/src/v2/core.ts b/src/v2/core.ts
@@ -30,7 +30,7 @@ import { ManifestEndpoint } from "../runtime/manifest";
 
 export { Change };
 
-export { ParamsOf } from "../common/params";
+export type { ParamsOf } from "../common/params";
 export { onInit } from "../common/onInit";
 
 /** @internal */
diff --git a/src/v2/index.ts b/src/v2/index.ts
@@ -58,8 +58,8 @@ export {
   firestore,
 };
 
-export {
-  setGlobalOptions,
+export { setGlobalOptions } from "./options";
+export type {
   GlobalOptions,
   SupportedRegion,
   MemoryOption,
@@ -68,7 +68,8 @@ export {
   EventHandlerOptions,
 } from "./options";
 
-export { CloudFunction, CloudEvent, ParamsOf, onInit } from "./core";
+export { onInit } from "./core";
+export type { CloudFunction, CloudEvent, ParamsOf } from "./core";
 export { Change } from "../common/change";
 export { traceContext } from "../common/trace";
 // NOTE: Equivalent to `export * as params from "../params"` but api-extractor doesn't support that syntax.
diff --git a/src/v2/providers/identity.ts b/src/v2/providers/identity.ts
@@ -46,7 +46,8 @@ import * as options from "../options";
 import { SecretParam } from "../../params/types";
 import { withInit } from "../../common/onInit";
 
-export { AuthUserRecord, AuthBlockingEvent, HttpsError };
+export { HttpsError };
+export type { AuthUserRecord, AuthBlockingEvent };
 
 /** @hidden Internally used when parsing the options. */
 interface InternalOptions {
diff --git a/src/v2/providers/tasks.ts b/src/v2/providers/tasks.ts
@@ -42,7 +42,7 @@ import { SecretParam } from "../../params/types";
 import { initV2Endpoint, initTaskQueueTrigger } from "../../runtime/manifest";
 import { withInit } from "../../common/onInit";
 
-export { AuthData, Request, RateLimits, RetryConfig };
+export type { AuthData, Request, RateLimits, RetryConfig };
 
 export interface TaskQueueOptions extends options.EventHandlerOptions {
   /** How a task should be retried in the event of a non-2xx return. */
diff --git a/tsdown.config.ts b/tsdown.config.ts
@@ -0,0 +1,44 @@
+import { defineConfig } from "tsdown";
+
+const rewriteProtoPath = {
+  name: "rewrite-proto-path",
+  resolveId(source) {
+    if (source === "../../../protos/compiledFirestore") {
+      return { id: "../../../../protos/compiledFirestore", external: true };
+    }
+    return null;
+  },
+};
+
+const rewriteProtoPathMjs = {
+  name: "rewrite-proto-path-mjs",
+  resolveId(source) {
+    if (source === "../../../protos/compiledFirestore") {
+      return { id: "../../../../protos/compiledFirestore.mjs", external: true };
+    }
+    return null;
+  },
+};
+
+export default defineConfig([
+  {
+    entry: "src/**/*.ts",
+    unbundle: true,
+    format: "cjs",
+    outDir: "lib/cjs",
+    clean: true,
+    dts: true,
+    treeshake: false,
+    plugins: [rewriteProtoPath],
+  },
+  {
+    entry: "src/**/*.ts",
+    unbundle: true,
+    format: "esm",
+    outDir: "lib/esm",
+    clean: false, // Don't clean - need to keep cjs/ output
+    dts: false, // Already created from CJS build
+    treeshake: false,
+    plugins: [rewriteProtoPathMjs],
+  },
+]);
