Skip to content

chore(electron): Fix cjs/esm exports#8959

Merged
wobsoriano merged 11 commits into
mainfrom
rob/fix-cjs-esm-issue-electron
Jun 23, 2026
Merged

chore(electron): Fix cjs/esm exports#8959
wobsoriano merged 11 commits into
mainfrom
rob/fix-cjs-esm-issue-electron

Conversation

@wobsoriano

@wobsoriano wobsoriano commented Jun 22, 2026

Copy link
Copy Markdown
Member

Description

Checklist

  • pnpm test runs as expected.
  • pnpm build runs as expected.
  • (If applicable) JSDoc comments have been added or updated for any package exports
  • (If applicable) Documentation has been updated

Type of change

  • 🐛 Bug fix
  • 🌟 New feature
  • 🔨 Breaking change
  • 📖 Refactoring / dependency upgrade / documentation
  • other:

Summary by CodeRabbit

  • Bug Fixes
    • Fixed Electron SDK exports to properly support both ESM and CommonJS module systems with correct type declarations.

@changeset-bot

changeset-bot Bot commented Jun 22, 2026

Copy link
Copy Markdown

🦋 Changeset detected

Latest commit: 4807231

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 0 packages

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

@vercel

vercel Bot commented Jun 22, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
clerk-js-sandbox Ready Ready Preview, Comment Jun 23, 2026 8:04pm
swingset Ready Ready Preview, Comment Jun 23, 2026 8:04pm

Request Review

@coderabbitai

coderabbitai Bot commented Jun 22, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Repository YAML (base), Repository UI (inherited)

Review profile: CHILL

Plan: Pro

Run ID: b8aa1ea6-f27b-4152-a4cb-115413297ff1

📥 Commits

Reviewing files that changed from the base of the PR and between 7661e55 and 4807231.

📒 Files selected for processing (1)
  • .changeset/quiet-ducks-wonder.md
💤 Files with no reviewable changes (1)
  • .changeset/quiet-ducks-wonder.md

📝 Walkthrough

Walkthrough

The @clerk/electron package build is restructured to produce separate ESM (dist/esm) and CJS (dist/cjs) outputs via two distinct tsdown targets. A new tsconfig.declarations.json emits type declarations to dist/types. The package.json exports, main, module, and types fields are updated to reference these new output locations. A patch changeset is included.

Changes

Electron SDK ESM/CJS build restructure

Layer / File(s) Summary
ESM/CJS split and declaration-only tsconfig
packages/electron/tsconfig.declarations.json, packages/electron/tsdown.config.mts
Adds tsconfig.declarations.json to emit .d.ts files to dist/types. Refactors tsdown.config.mts to produce separate esm and cjs option objects with dts: false, wired via runAfterLast to run pnpm build:declarations then optionally pkglab pub --ping.
Package entrypoints and changeset
packages/electron/package.json, .changeset/quiet-ducks-wonder.md
Updates all exports subpaths to route import.defaultdist/esm, require.defaultdist/cjs, and typesdist/types/.../index.d.ts. Updates top-level main, module, types, and adds the build:declarations script. Adds a patch changeset for the export fix.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

  • clerk/javascript#8786: Initial @clerk/electron SDK scaffold that established the original package.json entrypoints and build config this PR is directly updating.

Suggested reviewers

  • dstaley

Poem

🐇 Hop hop, the bundles split in two,
ESM and CJS, each path is true!
dist/types holds the declarations neat,
runAfterLast makes the pipeline complete.
No more mixed-up exports to untangle —
The Electron SDK shines from every angle! ✨

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately describes the main change: restructuring Electron package exports to properly separate CommonJS and ESM entrypoints with corresponding type definitions.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.


Comment @coderabbitai help to get the list of available commands.

@pkg-pr-new

pkg-pr-new Bot commented Jun 22, 2026

Copy link
Copy Markdown

Open in StackBlitz

@clerk/astro

npm i https://pkg.pr.new/@clerk/astro@8959

@clerk/backend

npm i https://pkg.pr.new/@clerk/backend@8959

@clerk/chrome-extension

npm i https://pkg.pr.new/@clerk/chrome-extension@8959

@clerk/clerk-js

npm i https://pkg.pr.new/@clerk/clerk-js@8959

@clerk/electron

npm i https://pkg.pr.new/@clerk/electron@8959

@clerk/electron-passkeys

npm i https://pkg.pr.new/@clerk/electron-passkeys@8959

@clerk/eslint-plugin

npm i https://pkg.pr.new/@clerk/eslint-plugin@8959

@clerk/expo

npm i https://pkg.pr.new/@clerk/expo@8959

@clerk/expo-passkeys

npm i https://pkg.pr.new/@clerk/expo-passkeys@8959

@clerk/express

npm i https://pkg.pr.new/@clerk/express@8959

@clerk/fastify

npm i https://pkg.pr.new/@clerk/fastify@8959

@clerk/hono

npm i https://pkg.pr.new/@clerk/hono@8959

@clerk/localizations

npm i https://pkg.pr.new/@clerk/localizations@8959

@clerk/nextjs

npm i https://pkg.pr.new/@clerk/nextjs@8959

@clerk/nuxt

npm i https://pkg.pr.new/@clerk/nuxt@8959

@clerk/react

npm i https://pkg.pr.new/@clerk/react@8959

@clerk/react-router

npm i https://pkg.pr.new/@clerk/react-router@8959

@clerk/shared

npm i https://pkg.pr.new/@clerk/shared@8959

@clerk/tanstack-react-start

npm i https://pkg.pr.new/@clerk/tanstack-react-start@8959

@clerk/testing

npm i https://pkg.pr.new/@clerk/testing@8959

@clerk/ui

npm i https://pkg.pr.new/@clerk/ui@8959

@clerk/upgrade

npm i https://pkg.pr.new/@clerk/upgrade@8959

@clerk/vue

npm i https://pkg.pr.new/@clerk/vue@8959

commit: 4807231

@wobsoriano

Copy link
Copy Markdown
Member Author

!snapshot

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🧹 Nitpick comments (1)
packages/electron/tsdown.config.mts (1)

9-10: 🩺 Stability & Availability | 🔵 Trivial

Consider explicit type checking for the publish flag to prevent accidental publish runs if the env value is ever passed as a string.

!!overrideOptions.env?.publish relies on JavaScript truthiness, which can coerce non-empty strings (like "false") to true. While the current pattern uses --env.publish as a boolean, explicit type checking would be more robust if the configuration ever receives string values.

Suggested improvement
-  const shouldPublish = !!overrideOptions.env?.publish;
+  const publishEnv = overrideOptions.env?.publish;
+  const shouldPublish =
+    publishEnv === true ||
+    (typeof publishEnv === 'string' && ['1', 'true', 'yes'].includes(publishEnv.toLowerCase()));
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@packages/electron/tsdown.config.mts` around lines 9 - 10, The shouldPublish
constant uses JavaScript truthiness coercion on overrideOptions.env?.publish,
which will incorrectly evaluate string values like "false" as true. Replace the
double negation operator truthiness check with explicit type checking that
compares overrideOptions.env?.publish to the string "true" or validates it as a
boolean true value, ensuring that string-based configuration values are handled
correctly and accidental publish runs are prevented.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@scripts/common.mjs`:
- Around line 20-23: The second find command for native packages in the
packages/electron-passkeys/npm directory is using .nothrow() to suppress all
errors without checking the exitCode or stderr, which can mask real discovery
failures and exclude packages from workflows. Remove the .nothrow() call from
the nativeResult assignment to match the error handling behavior of the first
find command, or if .nothrow() must be kept, add explicit checks for
nativeResult.exitCode and nativeResult.stderr to differentiate between missing
directories (acceptable) and actual errors (which should be thrown or logged).

---

Nitpick comments:
In `@packages/electron/tsdown.config.mts`:
- Around line 9-10: The shouldPublish constant uses JavaScript truthiness
coercion on overrideOptions.env?.publish, which will incorrectly evaluate string
values like "false" as true. Replace the double negation operator truthiness
check with explicit type checking that compares overrideOptions.env?.publish to
the string "true" or validates it as a boolean true value, ensuring that
string-based configuration values are handled correctly and accidental publish
runs are prevented.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Repository YAML (base), Repository UI (inherited)

Review profile: CHILL

Plan: Pro

Run ID: 02e2d0a8-1ca2-4c70-bf47-4db67ea0e0a3

📥 Commits

Reviewing files that changed from the base of the PR and between 52d310c and 5b61a0a.

📒 Files selected for processing (9)
  • packages/electron-passkeys/.gitignore
  • packages/electron-passkeys/npm/darwin-arm64/electron-passkeys.darwin-arm64.node
  • packages/electron-passkeys/npm/darwin-x64/electron-passkeys.darwin-x64.node
  • packages/electron-passkeys/npm/win32-arm64-msvc/electron-passkeys.win32-arm64-msvc.node
  • packages/electron-passkeys/npm/win32-x64-msvc/electron-passkeys.win32-x64-msvc.node
  • packages/electron/package.json
  • packages/electron/tsconfig.declarations.json
  • packages/electron/tsdown.config.mts
  • scripts/common.mjs

Comment thread scripts/common.mjs Outdated
@wobsoriano

Copy link
Copy Markdown
Member Author

!snapshot

@wobsoriano

Copy link
Copy Markdown
Member Author

!snapshot

@github-actions

Copy link
Copy Markdown
Contributor

Hey @wobsoriano - the snapshot version command generated the following package versions:

Package Version
@clerk/astro 3.4.7-snapshot.v20260622234151
@clerk/backend 3.8.3-snapshot.v20260622234151
@clerk/chrome-extension 3.1.42-snapshot.v20260622234151
@clerk/clerk-js 6.21.0-snapshot.v20260622234151
@clerk/electron 0.0.2-snapshot.v20260622234151
@clerk/electron-passkeys 0.0.2-snapshot.v20260622234151
@clerk/eslint-plugin 0.1.1-snapshot.v20260622234151
@clerk/expo 3.5.3-snapshot.v20260622234151
@clerk/expo-passkeys 1.1.9-snapshot.v20260622234151
@clerk/express 2.1.31-snapshot.v20260622234151
@clerk/fastify 3.1.41-snapshot.v20260622234151
@clerk/headless 0.0.3-snapshot.v20260622234151
@clerk/hono 0.1.41-snapshot.v20260622234151
@clerk/localizations 4.9.3-snapshot.v20260622234151
@clerk/msw 0.0.39-snapshot.v20260622234151
@clerk/nextjs 7.5.8-snapshot.v20260622234151
@clerk/nuxt 2.6.7-snapshot.v20260622234151
@clerk/react 6.11.0-snapshot.v20260622234151
@clerk/react-router 3.4.8-snapshot.v20260622234151
@clerk/shared 4.21.0-snapshot.v20260622234151
@clerk/swingset 0.0.8-snapshot.v20260622234151
@clerk/tanstack-react-start 1.4.8-snapshot.v20260622234151
@clerk/testing 2.1.6-snapshot.v20260622234151
@clerk/ui 1.20.1-snapshot.v20260622234151
@clerk/upgrade 2.0.5-snapshot.v20260622234151
@clerk/vue 2.4.7-snapshot.v20260622234151

Tip: Use the snippet copy button below to quickly install the required packages.
@clerk/astro

npm i @clerk/astro@3.4.7-snapshot.v20260622234151 --save-exact

@clerk/backend

npm i @clerk/backend@3.8.3-snapshot.v20260622234151 --save-exact

@clerk/chrome-extension

npm i @clerk/chrome-extension@3.1.42-snapshot.v20260622234151 --save-exact

@clerk/clerk-js

npm i @clerk/clerk-js@6.21.0-snapshot.v20260622234151 --save-exact

@clerk/electron

npm i @clerk/electron@0.0.2-snapshot.v20260622234151 --save-exact

@clerk/electron-passkeys

npm i @clerk/electron-passkeys@0.0.2-snapshot.v20260622234151 --save-exact

@clerk/eslint-plugin

npm i @clerk/eslint-plugin@0.1.1-snapshot.v20260622234151 --save-exact

@clerk/expo

npm i @clerk/expo@3.5.3-snapshot.v20260622234151 --save-exact

@clerk/expo-passkeys

npm i @clerk/expo-passkeys@1.1.9-snapshot.v20260622234151 --save-exact

@clerk/express

npm i @clerk/express@2.1.31-snapshot.v20260622234151 --save-exact

@clerk/fastify

npm i @clerk/fastify@3.1.41-snapshot.v20260622234151 --save-exact

@clerk/headless

npm i @clerk/headless@0.0.3-snapshot.v20260622234151 --save-exact

@clerk/hono

npm i @clerk/hono@0.1.41-snapshot.v20260622234151 --save-exact

@clerk/localizations

npm i @clerk/localizations@4.9.3-snapshot.v20260622234151 --save-exact

@clerk/msw

npm i @clerk/msw@0.0.39-snapshot.v20260622234151 --save-exact

@clerk/nextjs

npm i @clerk/nextjs@7.5.8-snapshot.v20260622234151 --save-exact

@clerk/nuxt

npm i @clerk/nuxt@2.6.7-snapshot.v20260622234151 --save-exact

@clerk/react

npm i @clerk/react@6.11.0-snapshot.v20260622234151 --save-exact

@clerk/react-router

npm i @clerk/react-router@3.4.8-snapshot.v20260622234151 --save-exact

@clerk/shared

npm i @clerk/shared@4.21.0-snapshot.v20260622234151 --save-exact

@clerk/swingset

npm i @clerk/swingset@0.0.8-snapshot.v20260622234151 --save-exact

@clerk/tanstack-react-start

npm i @clerk/tanstack-react-start@1.4.8-snapshot.v20260622234151 --save-exact

@clerk/testing

npm i @clerk/testing@2.1.6-snapshot.v20260622234151 --save-exact

@clerk/ui

npm i @clerk/ui@1.20.1-snapshot.v20260622234151 --save-exact

@clerk/upgrade

npm i @clerk/upgrade@2.0.5-snapshot.v20260622234151 --save-exact

@clerk/vue

npm i @clerk/vue@2.4.7-snapshot.v20260622234151 --save-exact

@wobsoriano wobsoriano marked this pull request as draft June 22, 2026 23:55
@wobsoriano wobsoriano changed the title chore(electron): Fix exports chore(electron): Fix cjs/esm exports Jun 23, 2026
@wobsoriano wobsoriano requested a review from jeremy-clerk June 23, 2026 20:02
@wobsoriano wobsoriano marked this pull request as ready for review June 23, 2026 20:02

@jeremy-clerk jeremy-clerk left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍

@wobsoriano wobsoriano merged commit 11cb740 into main Jun 23, 2026
48 checks passed
@wobsoriano wobsoriano deleted the rob/fix-cjs-esm-issue-electron branch June 23, 2026 20:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants