chore(clerk-react): Align types between Clerk and IsomorphicClerk #5197

brkalow · 2025-02-18T23:14:57Z

Description

Aligns types between IsomorphicClerk and Clerk to ensure the implementation remains in sync.

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

changeset-bot · 2025-02-18T23:15:01Z

🦋 Changeset detected

Latest commit: a7247a8

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

This PR includes changesets to release 9 packages

Name	Type
@clerk/clerk-react	Patch
@clerk/chrome-extension	Patch
@clerk/elements	Patch
@clerk/clerk-expo	Patch
@clerk/nextjs	Patch
@clerk/react-router	Patch
@clerk/remix	Patch
@clerk/tanstack-start	Patch
@clerk/ui	Patch

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 · 2025-02-18T23:15:01Z

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
clerk-js-sandbox	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Feb 18, 2025 11:15pm

brkalow · 2025-02-18T23:19:29Z

packages/react/src/isomorphicClerk.ts

+type WithVoidReturn<F extends (...args: any) => any> = (
+  ...args: Parameters<F>
+) => ReturnType<F> extends Promise<infer T> ? Promise<T | void> : ReturnType<F> | void;
+type WithVoidReturnFunctions<T> = {
+  [K in keyof T]: T[K] extends (...args: any) => any ? WithVoidReturn<T[K]> : T[K];
+};


Most methods were adjust to add | void to the return type, so I've gone ahead and created a helper type to do that automatically.

brkalow · 2025-02-18T23:20:06Z

packages/react/src/isomorphicClerk.ts

+  WithVoidReturnFunctions<LoadedClerk>,
+  'client' | '__internal_addNavigationListener' | '__internal_getCachedResources' | '__internal_reloadInitialResources'


I'm not sure if we need the __internal_ methods here, they don't exist today.

yeah, some of the internals we need some we don't. I know that __internal_addNavigationListener is only needed within clerk-js, which makes me think we can refactor it 🤔.

brkalow · 2025-02-18T23:20:45Z

packages/react/src/isomorphicClerk.ts

    }

-    this.premountSignInNodes.forEach((props: SignInProps, node: HTMLDivElement) => {
+    this.premountSignInNodes.forEach((props, node) => {


I've also removed unnecessary type annotations and instead am relying on the underlying IsomorphicClerk type definition.

anagstef

👏

panteliselef · 2025-02-19T09:31:56Z

packages/react/src/isomorphicClerk.ts

  };

-  handleGoogleOneTapCallback = (
+  handleGoogleOneTapCallback = async (


🚨 Technically this is a breaking change at the type level.

This aligns with the underlying Clerk type I believe 👀

Here: https://github.com/clerk/javascript/blob/main/packages/types/src/clerk.ts#L540-L544

Another reason to ensure these types are sourced from the same place 😅

panteliselef · 2025-02-19T15:51:23Z

!snapshot

clerk-cookie · 2025-02-19T15:53:47Z

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

Package	Version
@clerk/agent-toolkit	0.0.4-snapshot.v20250219155214
@clerk/astro	2.3.0-snapshot.v20250219155214
@clerk/backend	1.24.3-snapshot.v20250219155214
@clerk/chrome-extension	2.2.11-snapshot.v20250219155214
@clerk/clerk-js	5.54.0-snapshot.v20250219155214
@clerk/elements	0.23.0-snapshot.v20250219155214
@clerk/clerk-expo	2.8.0-snapshot.v20250219155214
@clerk/expo-passkeys	0.1.22-snapshot.v20250219155214
@clerk/express	1.3.50-snapshot.v20250219155214
@clerk/fastify	2.1.23-snapshot.v20250219155214
@clerk/localizations	3.10.8-snapshot.v20250219155214
@clerk/nextjs	6.12.1-snapshot.v20250219155214
@clerk/nuxt	1.2.1-snapshot.v20250219155214
@clerk/clerk-react	5.24.0-snapshot.v20250219155214
@clerk/react-router	1.1.1-snapshot.v20250219155214
@clerk/remix	4.5.1-snapshot.v20250219155214
@clerk/shared	2.23.0-snapshot.v20250219155214
@clerk/tanstack-start	0.10.1-snapshot.v20250219155214
@clerk/testing	1.4.24-snapshot.v20250219155214
@clerk/themes	2.2.20-snapshot.v20250219155214
@clerk/types	4.47.0-snapshot.v20250219155214
@clerk/ui	0.3.25-snapshot.v20250219155214
@clerk/vue	1.3.0-snapshot.v20250219155214

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

npm i @clerk/agent-toolkit@0.0.4-snapshot.v20250219155214 --save-exact

@clerk/astro

npm i @clerk/astro@2.3.0-snapshot.v20250219155214 --save-exact

@clerk/backend

npm i @clerk/backend@1.24.3-snapshot.v20250219155214 --save-exact

@clerk/chrome-extension

npm i @clerk/chrome-extension@2.2.11-snapshot.v20250219155214 --save-exact

@clerk/clerk-js

npm i @clerk/clerk-js@5.54.0-snapshot.v20250219155214 --save-exact

@clerk/elements

npm i @clerk/elements@0.23.0-snapshot.v20250219155214 --save-exact

@clerk/clerk-expo

npm i @clerk/clerk-expo@2.8.0-snapshot.v20250219155214 --save-exact

@clerk/expo-passkeys

npm i @clerk/expo-passkeys@0.1.22-snapshot.v20250219155214 --save-exact

@clerk/express

npm i @clerk/express@1.3.50-snapshot.v20250219155214 --save-exact

@clerk/fastify

npm i @clerk/fastify@2.1.23-snapshot.v20250219155214 --save-exact

@clerk/localizations

npm i @clerk/localizations@3.10.8-snapshot.v20250219155214 --save-exact

@clerk/nextjs

npm i @clerk/nextjs@6.12.1-snapshot.v20250219155214 --save-exact

@clerk/nuxt

npm i @clerk/nuxt@1.2.1-snapshot.v20250219155214 --save-exact

@clerk/clerk-react

npm i @clerk/clerk-react@5.24.0-snapshot.v20250219155214 --save-exact

@clerk/react-router

npm i @clerk/react-router@1.1.1-snapshot.v20250219155214 --save-exact

@clerk/remix

npm i @clerk/remix@4.5.1-snapshot.v20250219155214 --save-exact

@clerk/shared

npm i @clerk/shared@2.23.0-snapshot.v20250219155214 --save-exact

@clerk/tanstack-start

npm i @clerk/tanstack-start@0.10.1-snapshot.v20250219155214 --save-exact

@clerk/testing

npm i @clerk/testing@1.4.24-snapshot.v20250219155214 --save-exact

@clerk/themes

npm i @clerk/themes@2.2.20-snapshot.v20250219155214 --save-exact

@clerk/types

npm i @clerk/types@4.47.0-snapshot.v20250219155214 --save-exact

@clerk/ui

npm i @clerk/ui@0.3.25-snapshot.v20250219155214 --save-exact

@clerk/vue

npm i @clerk/vue@1.3.0-snapshot.v20250219155214 --save-exact

brkalow added 2 commits February 18, 2025 17:11

Align types between Clerk and IsomorphicClerk

5fede0b

Adds changeset

a7247a8

clerk-cookie added the react label Feb 18, 2025

brkalow commented Feb 18, 2025

View reviewed changes

brkalow requested a review from a team February 18, 2025 23:28

tmilewski approved these changes Feb 18, 2025

View reviewed changes

wobsoriano approved these changes Feb 19, 2025

View reviewed changes

anagstef approved these changes Feb 19, 2025

View reviewed changes

panteliselef reviewed Feb 19, 2025

View reviewed changes

alexcarpenter merged commit b707e94 into main Feb 24, 2025
30 checks passed

alexcarpenter deleted the brk.chore/isomorphic-clerk-types branch February 24, 2025 15:06

clerk-cookie mentioned this pull request Feb 24, 2025

ci(repo): Version packages #5193

Merged

		WithVoidReturnFunctions<LoadedClerk>,
		'client' \| '__internal_addNavigationListener' \| '__internal_getCachedResources' \| '__internal_reloadInitialResources'

chore(clerk-react): Align types between Clerk and IsomorphicClerk #5197

chore(clerk-react): Align types between Clerk and IsomorphicClerk #5197

Uh oh!

Conversation

brkalow commented Feb 18, 2025

Description

Checklist

Type of change

Uh oh!

changeset-bot bot commented Feb 18, 2025

🦋 Changeset detected

Uh oh!

vercel bot commented Feb 18, 2025

Uh oh!

brkalow Feb 18, 2025

Choose a reason for hiding this comment

Uh oh!

brkalow Feb 18, 2025

Choose a reason for hiding this comment

Uh oh!

panteliselef Feb 19, 2025

Choose a reason for hiding this comment

Uh oh!

brkalow Feb 18, 2025

Choose a reason for hiding this comment

Uh oh!

anagstef left a comment

Choose a reason for hiding this comment

Uh oh!

panteliselef Feb 19, 2025

Choose a reason for hiding this comment

Uh oh!

brkalow Feb 19, 2025

Choose a reason for hiding this comment

Uh oh!

brkalow Feb 19, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

panteliselef commented Feb 19, 2025

Uh oh!

clerk-cookie commented Feb 19, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

8 participants

brkalow Feb 19, 2025 •

edited

Loading