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

Merged
alexcarpenter merged 2 commits into
mainfrom
brk.chore/isomorphic-clerk-types
Feb 24, 2025
Merged

chore(clerk-react): Align types between Clerk and IsomorphicClerk#5197
alexcarpenter merged 2 commits into
mainfrom
brk.chore/isomorphic-clerk-types

Conversation

@brkalow

Copy link
Copy Markdown
Member

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

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

@changeset-bot

Copy link
Copy Markdown

🦋 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
NameType
@clerk/clerk-reactPatch
@clerk/chrome-extensionPatch
@clerk/elementsPatch
@clerk/clerk-expoPatch
@clerk/nextjsPatch
@clerk/react-routerPatch
@clerk/remixPatch
@clerk/tanstack-startPatch
@clerk/uiPatch

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

vercelBot commented Feb 18, 2025

Copy link
Copy Markdown

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

NameStatusPreviewCommentsUpdated (UTC)
clerk-js-sandbox✅ Ready (Inspect)Visit Preview💬 Add feedbackFeb 18, 2025 11:15pm

Comment on lines +80 to +85
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];
};

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

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.

Comment on lines +88 to +89
WithVoidReturnFunctions<LoadedClerk>,
'client' | '__internal_addNavigationListener' | '__internal_getCachedResources' | '__internal_reloadInitialResources'

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

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

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.

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 🤔.

}

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

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

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

@brkalow
brkalow requested a review from a teamFebruary 18, 2025 23:28

@anagstefanagstef 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.

👏

};

handleGoogleOneTapCallback = (
handleGoogleOneTapCallback = async (

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.

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

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

This aligns with the underlying Clerk type I believe 👀

@brkalowbrkalowFeb 19, 2025

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

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

Copy link
Copy Markdown
Contributor

!snapshot

@clerk-cookie

Copy link
Copy Markdown
Collaborator

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

PackageVersion
@clerk/agent-toolkit0.0.4-snapshot.v20250219155214
@clerk/astro2.3.0-snapshot.v20250219155214
@clerk/backend1.24.3-snapshot.v20250219155214
@clerk/chrome-extension2.2.11-snapshot.v20250219155214
@clerk/clerk-js5.54.0-snapshot.v20250219155214
@clerk/elements0.23.0-snapshot.v20250219155214
@clerk/clerk-expo2.8.0-snapshot.v20250219155214
@clerk/expo-passkeys0.1.22-snapshot.v20250219155214
@clerk/express1.3.50-snapshot.v20250219155214
@clerk/fastify2.1.23-snapshot.v20250219155214
@clerk/localizations3.10.8-snapshot.v20250219155214
@clerk/nextjs6.12.1-snapshot.v20250219155214
@clerk/nuxt1.2.1-snapshot.v20250219155214
@clerk/clerk-react5.24.0-snapshot.v20250219155214
@clerk/react-router1.1.1-snapshot.v20250219155214
@clerk/remix4.5.1-snapshot.v20250219155214
@clerk/shared2.23.0-snapshot.v20250219155214
@clerk/tanstack-start0.10.1-snapshot.v20250219155214
@clerk/testing1.4.24-snapshot.v20250219155214
@clerk/themes2.2.20-snapshot.v20250219155214
@clerk/types4.47.0-snapshot.v20250219155214
@clerk/ui0.3.25-snapshot.v20250219155214
@clerk/vue1.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

@alexcarpenter
alexcarpenter merged commit b707e94 into mainFeb 24, 2025
@alexcarpenter
alexcarpenter deleted the brk.chore/isomorphic-clerk-types branch February 24, 2025 15:06
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

7 participants

@brkalow@panteliselef@clerk-cookie@tmilewski@wobsoriano@anagstef@alexcarpenter
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
Skip to content

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

Merged
alexcarpenter merged 2 commits into
mainfrom
brk.chore/isomorphic-clerk-types
Feb 24, 2025
Merged

chore(clerk-react): Align types between Clerk and IsomorphicClerk#5197
alexcarpenter merged 2 commits into
mainfrom
brk.chore/isomorphic-clerk-types

Conversation

@brkalow

Copy link
Copy Markdown
Member

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

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

@changeset-bot

Copy link
Copy Markdown

🦋 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
NameType
@clerk/clerk-reactPatch
@clerk/chrome-extensionPatch
@clerk/elementsPatch
@clerk/clerk-expoPatch
@clerk/nextjsPatch
@clerk/react-routerPatch
@clerk/remixPatch
@clerk/tanstack-startPatch
@clerk/uiPatch

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

vercelBot commented Feb 18, 2025

Copy link
Copy Markdown

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

NameStatusPreviewCommentsUpdated (UTC)
clerk-js-sandbox✅ Ready (Inspect)Visit Preview💬 Add feedbackFeb 18, 2025 11:15pm

Comment on lines +80 to +85
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];
};

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

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.

Comment on lines +88 to +89
WithVoidReturnFunctions<LoadedClerk>,
'client' | '__internal_addNavigationListener' | '__internal_getCachedResources' | '__internal_reloadInitialResources'

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

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

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.

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 🤔.

}

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

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

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

@brkalow
brkalow requested a review from a teamFebruary 18, 2025 23:28

@anagstefanagstef 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.

👏

};

handleGoogleOneTapCallback = (
handleGoogleOneTapCallback = async (

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.

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

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

This aligns with the underlying Clerk type I believe 👀

@brkalowbrkalowFeb 19, 2025

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

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

Copy link
Copy Markdown
Contributor

!snapshot

@clerk-cookie

Copy link
Copy Markdown
Collaborator

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

PackageVersion
@clerk/agent-toolkit0.0.4-snapshot.v20250219155214
@clerk/astro2.3.0-snapshot.v20250219155214
@clerk/backend1.24.3-snapshot.v20250219155214
@clerk/chrome-extension2.2.11-snapshot.v20250219155214
@clerk/clerk-js5.54.0-snapshot.v20250219155214
@clerk/elements0.23.0-snapshot.v20250219155214
@clerk/clerk-expo2.8.0-snapshot.v20250219155214
@clerk/expo-passkeys0.1.22-snapshot.v20250219155214
@clerk/express1.3.50-snapshot.v20250219155214
@clerk/fastify2.1.23-snapshot.v20250219155214
@clerk/localizations3.10.8-snapshot.v20250219155214
@clerk/nextjs6.12.1-snapshot.v20250219155214
@clerk/nuxt1.2.1-snapshot.v20250219155214
@clerk/clerk-react5.24.0-snapshot.v20250219155214
@clerk/react-router1.1.1-snapshot.v20250219155214
@clerk/remix4.5.1-snapshot.v20250219155214
@clerk/shared2.23.0-snapshot.v20250219155214
@clerk/tanstack-start0.10.1-snapshot.v20250219155214
@clerk/testing1.4.24-snapshot.v20250219155214
@clerk/themes2.2.20-snapshot.v20250219155214
@clerk/types4.47.0-snapshot.v20250219155214
@clerk/ui0.3.25-snapshot.v20250219155214
@clerk/vue1.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

@alexcarpenter
alexcarpenter merged commit b707e94 into mainFeb 24, 2025
@alexcarpenter
alexcarpenter deleted the brk.chore/isomorphic-clerk-types branch February 24, 2025 15:06
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

7 participants

@brkalow@panteliselef@clerk-cookie@tmilewski@wobsoriano@anagstef@alexcarpenter
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix"); } } catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

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

Merged
alexcarpenter merged 2 commits into
mainfrom
brk.chore/isomorphic-clerk-types
Feb 24, 2025
Merged

chore(clerk-react): Align types between Clerk and IsomorphicClerk#5197
alexcarpenter merged 2 commits into
mainfrom
brk.chore/isomorphic-clerk-types

Conversation

@brkalow

Copy link
Copy Markdown
Member

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

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

@changeset-bot

Copy link
Copy Markdown

🦋 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
NameType
@clerk/clerk-reactPatch
@clerk/chrome-extensionPatch
@clerk/elementsPatch
@clerk/clerk-expoPatch
@clerk/nextjsPatch
@clerk/react-routerPatch
@clerk/remixPatch
@clerk/tanstack-startPatch
@clerk/uiPatch

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

vercelBot commented Feb 18, 2025

Copy link
Copy Markdown

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

NameStatusPreviewCommentsUpdated (UTC)
clerk-js-sandbox✅ Ready (Inspect)Visit Preview💬 Add feedbackFeb 18, 2025 11:15pm

Comment on lines +80 to +85
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];
};

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

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.

Comment on lines +88 to +89
WithVoidReturnFunctions<LoadedClerk>,
'client' | '__internal_addNavigationListener' | '__internal_getCachedResources' | '__internal_reloadInitialResources'

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

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

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.

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 🤔.

}

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

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

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

@brkalow
brkalow requested a review from a teamFebruary 18, 2025 23:28

@anagstefanagstef 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.

👏

};

handleGoogleOneTapCallback = (
handleGoogleOneTapCallback = async (

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.

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

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

This aligns with the underlying Clerk type I believe 👀

@brkalowbrkalowFeb 19, 2025

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

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

Copy link
Copy Markdown
Contributor

!snapshot

@clerk-cookie

Copy link
Copy Markdown
Collaborator

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

PackageVersion
@clerk/agent-toolkit0.0.4-snapshot.v20250219155214
@clerk/astro2.3.0-snapshot.v20250219155214
@clerk/backend1.24.3-snapshot.v20250219155214
@clerk/chrome-extension2.2.11-snapshot.v20250219155214
@clerk/clerk-js5.54.0-snapshot.v20250219155214
@clerk/elements0.23.0-snapshot.v20250219155214
@clerk/clerk-expo2.8.0-snapshot.v20250219155214
@clerk/expo-passkeys0.1.22-snapshot.v20250219155214
@clerk/express1.3.50-snapshot.v20250219155214
@clerk/fastify2.1.23-snapshot.v20250219155214
@clerk/localizations3.10.8-snapshot.v20250219155214
@clerk/nextjs6.12.1-snapshot.v20250219155214
@clerk/nuxt1.2.1-snapshot.v20250219155214
@clerk/clerk-react5.24.0-snapshot.v20250219155214
@clerk/react-router1.1.1-snapshot.v20250219155214
@clerk/remix4.5.1-snapshot.v20250219155214
@clerk/shared2.23.0-snapshot.v20250219155214
@clerk/tanstack-start0.10.1-snapshot.v20250219155214
@clerk/testing1.4.24-snapshot.v20250219155214
@clerk/themes2.2.20-snapshot.v20250219155214
@clerk/types4.47.0-snapshot.v20250219155214
@clerk/ui0.3.25-snapshot.v20250219155214
@clerk/vue1.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

@alexcarpenter
alexcarpenter merged commit b707e94 into mainFeb 24, 2025
@alexcarpenter
alexcarpenter deleted the brk.chore/isomorphic-clerk-types branch February 24, 2025 15:06
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

7 participants

@brkalow@panteliselef@clerk-cookie@tmilewski@wobsoriano@anagstef@alexcarpenter
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms"); } } catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

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

Merged
alexcarpenter merged 2 commits into
mainfrom
brk.chore/isomorphic-clerk-types
Feb 24, 2025
Merged

chore(clerk-react): Align types between Clerk and IsomorphicClerk#5197
alexcarpenter merged 2 commits into
mainfrom
brk.chore/isomorphic-clerk-types

Conversation

@brkalow

Copy link
Copy Markdown
Member

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

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

@changeset-bot

Copy link
Copy Markdown

🦋 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
NameType
@clerk/clerk-reactPatch
@clerk/chrome-extensionPatch
@clerk/elementsPatch
@clerk/clerk-expoPatch
@clerk/nextjsPatch
@clerk/react-routerPatch
@clerk/remixPatch
@clerk/tanstack-startPatch
@clerk/uiPatch

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

vercelBot commented Feb 18, 2025

Copy link
Copy Markdown

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

NameStatusPreviewCommentsUpdated (UTC)
clerk-js-sandbox✅ Ready (Inspect)Visit Preview💬 Add feedbackFeb 18, 2025 11:15pm

Comment on lines +80 to +85
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];
};

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

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.

Comment on lines +88 to +89
WithVoidReturnFunctions<LoadedClerk>,
'client' | '__internal_addNavigationListener' | '__internal_getCachedResources' | '__internal_reloadInitialResources'

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

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

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.

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 🤔.

}

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

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

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

@brkalow
brkalow requested a review from a teamFebruary 18, 2025 23:28

@anagstefanagstef 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.

👏

};

handleGoogleOneTapCallback = (
handleGoogleOneTapCallback = async (

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.

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

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

This aligns with the underlying Clerk type I believe 👀

@brkalowbrkalowFeb 19, 2025

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

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

Copy link
Copy Markdown
Contributor

!snapshot

@clerk-cookie

Copy link
Copy Markdown
Collaborator

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

PackageVersion
@clerk/agent-toolkit0.0.4-snapshot.v20250219155214
@clerk/astro2.3.0-snapshot.v20250219155214
@clerk/backend1.24.3-snapshot.v20250219155214
@clerk/chrome-extension2.2.11-snapshot.v20250219155214
@clerk/clerk-js5.54.0-snapshot.v20250219155214
@clerk/elements0.23.0-snapshot.v20250219155214
@clerk/clerk-expo2.8.0-snapshot.v20250219155214
@clerk/expo-passkeys0.1.22-snapshot.v20250219155214
@clerk/express1.3.50-snapshot.v20250219155214
@clerk/fastify2.1.23-snapshot.v20250219155214
@clerk/localizations3.10.8-snapshot.v20250219155214
@clerk/nextjs6.12.1-snapshot.v20250219155214
@clerk/nuxt1.2.1-snapshot.v20250219155214
@clerk/clerk-react5.24.0-snapshot.v20250219155214
@clerk/react-router1.1.1-snapshot.v20250219155214
@clerk/remix4.5.1-snapshot.v20250219155214
@clerk/shared2.23.0-snapshot.v20250219155214
@clerk/tanstack-start0.10.1-snapshot.v20250219155214
@clerk/testing1.4.24-snapshot.v20250219155214
@clerk/themes2.2.20-snapshot.v20250219155214
@clerk/types4.47.0-snapshot.v20250219155214
@clerk/ui0.3.25-snapshot.v20250219155214
@clerk/vue1.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

@alexcarpenter
alexcarpenter merged commit b707e94 into mainFeb 24, 2025
@alexcarpenter
alexcarpenter deleted the brk.chore/isomorphic-clerk-types branch February 24, 2025 15:06
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

7 participants

@brkalow@panteliselef@clerk-cookie@tmilewski@wobsoriano@anagstef@alexcarpenter
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links"); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + '
Skip to content

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

Merged
alexcarpenter merged 2 commits into
mainfrom
brk.chore/isomorphic-clerk-types
Feb 24, 2025
Merged

chore(clerk-react): Align types between Clerk and IsomorphicClerk#5197
alexcarpenter merged 2 commits into
mainfrom
brk.chore/isomorphic-clerk-types

Conversation

@brkalow

Copy link
Copy Markdown
Member

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

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

@changeset-bot

Copy link
Copy Markdown

🦋 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
NameType
@clerk/clerk-reactPatch
@clerk/chrome-extensionPatch
@clerk/elementsPatch
@clerk/clerk-expoPatch
@clerk/nextjsPatch
@clerk/react-routerPatch
@clerk/remixPatch
@clerk/tanstack-startPatch
@clerk/uiPatch

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

vercelBot commented Feb 18, 2025

Copy link
Copy Markdown

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

NameStatusPreviewCommentsUpdated (UTC)
clerk-js-sandbox✅ Ready (Inspect)Visit Preview💬 Add feedbackFeb 18, 2025 11:15pm

Comment on lines +80 to +85
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];
};

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

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.

Comment on lines +88 to +89
WithVoidReturnFunctions<LoadedClerk>,
'client' | '__internal_addNavigationListener' | '__internal_getCachedResources' | '__internal_reloadInitialResources'

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

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

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.

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 🤔.

}

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

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

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

@brkalow
brkalow requested a review from a teamFebruary 18, 2025 23:28

@anagstefanagstef 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.

👏

};

handleGoogleOneTapCallback = (
handleGoogleOneTapCallback = async (

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.

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

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

This aligns with the underlying Clerk type I believe 👀

@brkalowbrkalowFeb 19, 2025

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

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

Copy link
Copy Markdown
Contributor

!snapshot

@clerk-cookie

Copy link
Copy Markdown
Collaborator

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

PackageVersion
@clerk/agent-toolkit0.0.4-snapshot.v20250219155214
@clerk/astro2.3.0-snapshot.v20250219155214
@clerk/backend1.24.3-snapshot.v20250219155214
@clerk/chrome-extension2.2.11-snapshot.v20250219155214
@clerk/clerk-js5.54.0-snapshot.v20250219155214
@clerk/elements0.23.0-snapshot.v20250219155214
@clerk/clerk-expo2.8.0-snapshot.v20250219155214
@clerk/expo-passkeys0.1.22-snapshot.v20250219155214
@clerk/express1.3.50-snapshot.v20250219155214
@clerk/fastify2.1.23-snapshot.v20250219155214
@clerk/localizations3.10.8-snapshot.v20250219155214
@clerk/nextjs6.12.1-snapshot.v20250219155214
@clerk/nuxt1.2.1-snapshot.v20250219155214
@clerk/clerk-react5.24.0-snapshot.v20250219155214
@clerk/react-router1.1.1-snapshot.v20250219155214
@clerk/remix4.5.1-snapshot.v20250219155214
@clerk/shared2.23.0-snapshot.v20250219155214
@clerk/tanstack-start0.10.1-snapshot.v20250219155214
@clerk/testing1.4.24-snapshot.v20250219155214
@clerk/themes2.2.20-snapshot.v20250219155214
@clerk/types4.47.0-snapshot.v20250219155214
@clerk/ui0.3.25-snapshot.v20250219155214
@clerk/vue1.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

@alexcarpenter
alexcarpenter merged commit b707e94 into mainFeb 24, 2025
@alexcarpenter
alexcarpenter deleted the brk.chore/isomorphic-clerk-types branch February 24, 2025 15:06
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

7 participants

@brkalow@panteliselef@clerk-cookie@tmilewski@wobsoriano@anagstef@alexcarpenter
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default"); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

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

Merged
alexcarpenter merged 2 commits into
mainfrom
brk.chore/isomorphic-clerk-types
Feb 24, 2025
Merged

chore(clerk-react): Align types between Clerk and IsomorphicClerk#5197
alexcarpenter merged 2 commits into
mainfrom
brk.chore/isomorphic-clerk-types

Conversation

@brkalow

Copy link
Copy Markdown
Member

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

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

@changeset-bot

Copy link
Copy Markdown

🦋 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
NameType
@clerk/clerk-reactPatch
@clerk/chrome-extensionPatch
@clerk/elementsPatch
@clerk/clerk-expoPatch
@clerk/nextjsPatch
@clerk/react-routerPatch
@clerk/remixPatch
@clerk/tanstack-startPatch
@clerk/uiPatch

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

vercelBot commented Feb 18, 2025

Copy link
Copy Markdown

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

NameStatusPreviewCommentsUpdated (UTC)
clerk-js-sandbox✅ Ready (Inspect)Visit Preview💬 Add feedbackFeb 18, 2025 11:15pm

Comment on lines +80 to +85
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];
};

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

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.

Comment on lines +88 to +89
WithVoidReturnFunctions<LoadedClerk>,
'client' | '__internal_addNavigationListener' | '__internal_getCachedResources' | '__internal_reloadInitialResources'

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

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

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.

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 🤔.

}

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

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

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

@brkalow
brkalow requested a review from a teamFebruary 18, 2025 23:28

@anagstefanagstef 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.

👏

};

handleGoogleOneTapCallback = (
handleGoogleOneTapCallback = async (

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.

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

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

This aligns with the underlying Clerk type I believe 👀

@brkalowbrkalowFeb 19, 2025

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

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

Copy link
Copy Markdown
Contributor

!snapshot

@clerk-cookie

Copy link
Copy Markdown
Collaborator

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

PackageVersion
@clerk/agent-toolkit0.0.4-snapshot.v20250219155214
@clerk/astro2.3.0-snapshot.v20250219155214
@clerk/backend1.24.3-snapshot.v20250219155214
@clerk/chrome-extension2.2.11-snapshot.v20250219155214
@clerk/clerk-js5.54.0-snapshot.v20250219155214
@clerk/elements0.23.0-snapshot.v20250219155214
@clerk/clerk-expo2.8.0-snapshot.v20250219155214
@clerk/expo-passkeys0.1.22-snapshot.v20250219155214
@clerk/express1.3.50-snapshot.v20250219155214
@clerk/fastify2.1.23-snapshot.v20250219155214
@clerk/localizations3.10.8-snapshot.v20250219155214
@clerk/nextjs6.12.1-snapshot.v20250219155214
@clerk/nuxt1.2.1-snapshot.v20250219155214
@clerk/clerk-react5.24.0-snapshot.v20250219155214
@clerk/react-router1.1.1-snapshot.v20250219155214
@clerk/remix4.5.1-snapshot.v20250219155214
@clerk/shared2.23.0-snapshot.v20250219155214
@clerk/tanstack-start0.10.1-snapshot.v20250219155214
@clerk/testing1.4.24-snapshot.v20250219155214
@clerk/themes2.2.20-snapshot.v20250219155214
@clerk/types4.47.0-snapshot.v20250219155214
@clerk/ui0.3.25-snapshot.v20250219155214
@clerk/vue1.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

@alexcarpenter
alexcarpenter merged commit b707e94 into mainFeb 24, 2025
@alexcarpenter
alexcarpenter deleted the brk.chore/isomorphic-clerk-types branch February 24, 2025 15:06
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

7 participants

@brkalow@panteliselef@clerk-cookie@tmilewski@wobsoriano@anagstef@alexcarpenter
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers"); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

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

Merged
alexcarpenter merged 2 commits into
mainfrom
brk.chore/isomorphic-clerk-types
Feb 24, 2025
Merged

chore(clerk-react): Align types between Clerk and IsomorphicClerk#5197
alexcarpenter merged 2 commits into
mainfrom
brk.chore/isomorphic-clerk-types

Conversation

@brkalow

Copy link
Copy Markdown
Member

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

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

@changeset-bot

Copy link
Copy Markdown

🦋 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
NameType
@clerk/clerk-reactPatch
@clerk/chrome-extensionPatch
@clerk/elementsPatch
@clerk/clerk-expoPatch
@clerk/nextjsPatch
@clerk/react-routerPatch
@clerk/remixPatch
@clerk/tanstack-startPatch
@clerk/uiPatch

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

vercelBot commented Feb 18, 2025

Copy link
Copy Markdown

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

NameStatusPreviewCommentsUpdated (UTC)
clerk-js-sandbox✅ Ready (Inspect)Visit Preview💬 Add feedbackFeb 18, 2025 11:15pm

Comment on lines +80 to +85
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];
};

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

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.

Comment on lines +88 to +89
WithVoidReturnFunctions<LoadedClerk>,
'client' | '__internal_addNavigationListener' | '__internal_getCachedResources' | '__internal_reloadInitialResources'

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

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

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.

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 🤔.

}

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

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

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

@brkalow
brkalow requested a review from a teamFebruary 18, 2025 23:28

@anagstefanagstef 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.

👏

};

handleGoogleOneTapCallback = (
handleGoogleOneTapCallback = async (

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.

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

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

This aligns with the underlying Clerk type I believe 👀

@brkalowbrkalowFeb 19, 2025

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

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

Copy link
Copy Markdown
Contributor

!snapshot

@clerk-cookie

Copy link
Copy Markdown
Collaborator

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

PackageVersion
@clerk/agent-toolkit0.0.4-snapshot.v20250219155214
@clerk/astro2.3.0-snapshot.v20250219155214
@clerk/backend1.24.3-snapshot.v20250219155214
@clerk/chrome-extension2.2.11-snapshot.v20250219155214
@clerk/clerk-js5.54.0-snapshot.v20250219155214
@clerk/elements0.23.0-snapshot.v20250219155214
@clerk/clerk-expo2.8.0-snapshot.v20250219155214
@clerk/expo-passkeys0.1.22-snapshot.v20250219155214
@clerk/express1.3.50-snapshot.v20250219155214
@clerk/fastify2.1.23-snapshot.v20250219155214
@clerk/localizations3.10.8-snapshot.v20250219155214
@clerk/nextjs6.12.1-snapshot.v20250219155214
@clerk/nuxt1.2.1-snapshot.v20250219155214
@clerk/clerk-react5.24.0-snapshot.v20250219155214
@clerk/react-router1.1.1-snapshot.v20250219155214
@clerk/remix4.5.1-snapshot.v20250219155214
@clerk/shared2.23.0-snapshot.v20250219155214
@clerk/tanstack-start0.10.1-snapshot.v20250219155214
@clerk/testing1.4.24-snapshot.v20250219155214
@clerk/themes2.2.20-snapshot.v20250219155214
@clerk/types4.47.0-snapshot.v20250219155214
@clerk/ui0.3.25-snapshot.v20250219155214
@clerk/vue1.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

@alexcarpenter
alexcarpenter merged commit b707e94 into mainFeb 24, 2025
@alexcarpenter
alexcarpenter deleted the brk.chore/isomorphic-clerk-types branch February 24, 2025 15:06
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

7 participants

@brkalow@panteliselef@clerk-cookie@tmilewski@wobsoriano@anagstef@alexcarpenter
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode"); } } catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); } })(); })();
Skip to content

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

Merged
alexcarpenter merged 2 commits into
mainfrom
brk.chore/isomorphic-clerk-types
Feb 24, 2025
Merged

chore(clerk-react): Align types between Clerk and IsomorphicClerk#5197
alexcarpenter merged 2 commits into
mainfrom
brk.chore/isomorphic-clerk-types

Conversation

@brkalow

Copy link
Copy Markdown
Member

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

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

@changeset-bot

Copy link
Copy Markdown

🦋 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
NameType
@clerk/clerk-reactPatch
@clerk/chrome-extensionPatch
@clerk/elementsPatch
@clerk/clerk-expoPatch
@clerk/nextjsPatch
@clerk/react-routerPatch
@clerk/remixPatch
@clerk/tanstack-startPatch
@clerk/uiPatch

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

vercelBot commented Feb 18, 2025

Copy link
Copy Markdown

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

NameStatusPreviewCommentsUpdated (UTC)
clerk-js-sandbox✅ Ready (Inspect)Visit Preview💬 Add feedbackFeb 18, 2025 11:15pm

Comment on lines +80 to +85
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];
};

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

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.

Comment on lines +88 to +89
WithVoidReturnFunctions<LoadedClerk>,
'client' | '__internal_addNavigationListener' | '__internal_getCachedResources' | '__internal_reloadInitialResources'

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

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

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.

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 🤔.

}

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

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

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

@brkalow
brkalow requested a review from a teamFebruary 18, 2025 23:28

@anagstefanagstef 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.

👏

};

handleGoogleOneTapCallback = (
handleGoogleOneTapCallback = async (

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.

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

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

This aligns with the underlying Clerk type I believe 👀

@brkalowbrkalowFeb 19, 2025

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

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

Copy link
Copy Markdown
Contributor

!snapshot

@clerk-cookie

Copy link
Copy Markdown
Collaborator

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

PackageVersion
@clerk/agent-toolkit0.0.4-snapshot.v20250219155214
@clerk/astro2.3.0-snapshot.v20250219155214
@clerk/backend1.24.3-snapshot.v20250219155214
@clerk/chrome-extension2.2.11-snapshot.v20250219155214
@clerk/clerk-js5.54.0-snapshot.v20250219155214
@clerk/elements0.23.0-snapshot.v20250219155214
@clerk/clerk-expo2.8.0-snapshot.v20250219155214
@clerk/expo-passkeys0.1.22-snapshot.v20250219155214
@clerk/express1.3.50-snapshot.v20250219155214
@clerk/fastify2.1.23-snapshot.v20250219155214
@clerk/localizations3.10.8-snapshot.v20250219155214
@clerk/nextjs6.12.1-snapshot.v20250219155214
@clerk/nuxt1.2.1-snapshot.v20250219155214
@clerk/clerk-react5.24.0-snapshot.v20250219155214
@clerk/react-router1.1.1-snapshot.v20250219155214
@clerk/remix4.5.1-snapshot.v20250219155214
@clerk/shared2.23.0-snapshot.v20250219155214
@clerk/tanstack-start0.10.1-snapshot.v20250219155214
@clerk/testing1.4.24-snapshot.v20250219155214
@clerk/themes2.2.20-snapshot.v20250219155214
@clerk/types4.47.0-snapshot.v20250219155214
@clerk/ui0.3.25-snapshot.v20250219155214
@clerk/vue1.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

@alexcarpenter
alexcarpenter merged commit b707e94 into mainFeb 24, 2025
@alexcarpenter
alexcarpenter deleted the brk.chore/isomorphic-clerk-types branch February 24, 2025 15:06
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

7 participants

@brkalow@panteliselef@clerk-cookie@tmilewski@wobsoriano@anagstef@alexcarpenter