Merged
6 changes: 6 additions & 0 deletions .changeset/tame-poems-impress.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
---
"@clerk/nuxt": patch
"@clerk/vue": patch
---

Make `initialState` prop public and bump `@nuxt/kit` to 3.17.5
24 changes: 16 additions & 8 deletions packages/nextjs/src/__tests__/webhooks.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -10,16 +10,22 @@ const mockSuccessResponse = {
object: 'event',
} as any;

const mockError = new Error('Missing required Svix headers: svix-id, svix-timestamp, svix-signature');

vi.mock('@clerk/backend/webhooks', () => ({
verifyWebhook: vi.fn().mockImplementation((request: Request) => {
const svixId = request.headers.get('svix-id');
const svixTimestamp = request.headers.get('svix-timestamp');
const svixSignature = request.headers.get('svix-signature');
verifyWebhook: vi.fn().mockImplementation(async (request: any) => {
// Support both Fetch API Request and plain object
const getHeader = (key: string) => {
if (request instanceof Request) {
return request.headers.get(key);
}
return request.headers?.[key];
};

const svixId = getHeader('svix-id');
const svixTimestamp = getHeader('svix-timestamp');
const svixSignature = getHeader('svix-signature');

if (!svixId || !svixTimestamp || !svixSignature) {
throw mockError;
throw new Error('Missing required Svix headers: svix-id, svix-timestamp, svix-signature');
}

return mockSuccessResponse;
Expand DownExpand Up@@ -88,7 +94,9 @@ describe('verifyWebhook', () => {
aborted: false,
} as unknown as NextApiRequest;

await expect(verifyWebhook(mockNextApiRequest)).rejects.toThrow(mockError);
await expect(verifyWebhook(mockNextApiRequest)).rejects.toThrow(
'Missing required Svix headers: svix-id, svix-timestamp, svix-signature',
);
});
});
});
8 changes: 4 additions & 4 deletions packages/nuxt/package.json
Original file line numberDiff line numberDiff line change
Expand Up@@ -71,12 +71,12 @@
"@clerk/shared": "workspace:^",
"@clerk/types": "workspace:^",
"@clerk/vue": "workspace:^",
"@nuxt/kit": "^3.16.2",
"@nuxt/schema": "^3.16.2",
"h3": "^1.15.1"
"@nuxt/kit": "^3.17.5",
"@nuxt/schema": "^3.17.5",
"h3": "^1.15.3"
},
"devDependencies": {
"nuxt": "^3.16.2",
"nuxt": "^3.17.5",
"typescript": "catalog:repo"
},
"engines": {
Expand Down
1 change: 1 addition & 0 deletions packages/nuxt/src/global.d.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -11,6 +11,7 @@ declare module 'nuxt/schema' {
clerk: {
secretKey?: string;
jwtKey?: string;
webhookSigningSecret?: string;
};
}
interface PublicRuntimeConfig {
Expand Down
11 changes: 7 additions & 4 deletions packages/nuxt/src/module.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -12,7 +12,10 @@ import {
updateRuntimeConfig,
} from '@nuxt/kit';

export type ModuleOptions = Without<PluginOptions, 'routerPush' | 'routerReplace' | 'publishableKey'> & {
export type ModuleOptions = Without<
PluginOptions,
'routerPush' | 'routerReplace' | 'publishableKey' | 'initialState'
> & {
publishableKey?: string;
/**
* Skip the automatic server middleware registration. When enabled, you'll need to
Expand DownExpand Up@@ -106,10 +109,10 @@ export default defineNuxtModule<ModuleOptions>({
addTypeTemplate(
{
filename: 'types/clerk.d.ts',
getContents: () => `import type { SignedInAuthObject, SignedOutAuthObject } from '@clerk/backend/internal';
getContents: () => `import type { SessionAuthObject } from '@clerk/backend';
declare module 'h3' {
type AuthObjectHandler = (SignedInAuthObject | SignedOutAuthObject) & {
(): SignedInAuthObject | SignedOutAuthObject;
type AuthObjectHandler = SessionAuthObject & {
(): SessionAuthObject;
Comment on lines +112 to +115

@wobsorianowobsorianoJun 16, 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.

SessionAuthObject is a new type introduced in machine auth

see token types

}

interface H3EventContext {
Expand Down
4 changes: 3 additions & 1 deletion packages/nuxt/src/runtime/plugin.ts
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
import { setClerkJsLoadingErrorPackageName } from '@clerk/shared/loadClerkJsScript';
import type { InitialState } from '@clerk/types';
import { clerkPlugin } from '@clerk/vue';
import { setErrorThrowerOptions } from '@clerk/vue/internal';
import { defineNuxtPlugin, navigateTo, useRuntimeConfig, useState } from 'nuxt/app';
Expand All@@ -8,14 +9,15 @@ setClerkJsLoadingErrorPackageName(PACKAGE_NAME);

export default defineNuxtPlugin(nuxtApp => {
// SSR-friendly shared state
const initialState = useState('clerk-initial-state', () => undefined);
const initialState = useState<InitialState | undefined>('clerk-initial-state', () => undefined);

if (import.meta.server) {
// Save the initial state from server and pass it to the plugin
initialState.value = nuxtApp.ssrContext?.event.context.__clerk_initial_state;
}

const runtimeConfig = useRuntimeConfig();

nuxtApp.vueApp.use(clerkPlugin, {
...(runtimeConfig.public.clerk ?? {}),
sdkMetadata: {
Expand Down
6 changes: 3 additions & 3 deletions packages/vue/package.json
Original file line numberDiff line numberDiff line change
Expand Up@@ -62,10 +62,10 @@
},
"devDependencies": {
"@testing-library/vue": "^8.1.0",
"@vitejs/plugin-vue": "^5.2.3",
"@vitejs/plugin-vue": "^5.2.4",
"@vue.ts/tsx-auto-props": "^0.6.0",
"unplugin-vue": "^5.2.1",
"vue": "3.5.13",
"unplugin-vue": "^6.2.0",
"vue": "3.5.16",
"vue-tsc": "^2.2.10"
},
"peerDependencies": {
Expand Down
8 changes: 5 additions & 3 deletions packages/vue/src/plugin.ts
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,16 @@
import { inBrowser } from '@clerk/shared/browser';
import { deriveState } from '@clerk/shared/deriveState';
import { loadClerkJsScript, type LoadClerkJsScriptOptions } from '@clerk/shared/loadClerkJsScript';
import type { Clerk, ClientResource, MultiDomainAndOrProxy, Resources, Without } from '@clerk/types';
import type { Clerk, ClientResource, InitialState, MultiDomainAndOrProxy, Resources, Without } from '@clerk/types';
import type { Plugin } from 'vue';
import { computed, ref, shallowRef, triggerRef } from 'vue';

import { ClerkInjectionKey } from './keys';

export type PluginOptions = Without<LoadClerkJsScriptOptions, 'domain' | 'proxyUrl'> & MultiDomainAndOrProxy;
export type PluginOptions = Without<LoadClerkJsScriptOptions, 'domain' | 'proxyUrl'> &
MultiDomainAndOrProxy & {
initialState?: InitialState;
};
Comment on lines +10 to +13

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.

🛠️ Refactor suggestion

initialState leaks into loadClerkJsScript options

pluginOptions now carries initialState, but a few lines below we cast the full object to LoadClerkJsScriptOptions and forward it to loadClerkJsScript:

constoptions={
...pluginOptions,sdkMetadata: pluginOptions.sdkMetadata||SDK_METADATA,}asLoadClerkJsScriptOptions;

loadClerkJsScript has no concept of initialState; the extra key is silently ignored today but future strict‐mode checks (or external libs doing Object.keys) might fail.

A minimal, type-safe guard:

-const options = {- ...pluginOptions,- sdkMetadata: pluginOptions.sdkMetadata || SDK_METADATA,-} as LoadClerkJsScriptOptions;+const { initialState, ...loadOptions } = pluginOptions;+const options: LoadClerkJsScriptOptions = {+ ...loadOptions,+ sdkMetadata: loadOptions.sdkMetadata || SDK_METADATA,+};

Keeps runtime payload clean and removes the need for the as cast.

🤖 Prompt for AI Agents
In packages/vue/src/plugin.ts around lines 10 to 13, the PluginOptions type
includes an initialState property that is not part of LoadClerkJsScriptOptions
but is being cast and passed to loadClerkJsScript, causing a type leak. To fix
this, explicitly separate initialState from pluginOptions before passing options
to loadClerkJsScript, ensuring only valid LoadClerkJsScriptOptions keys are
forwarded. Remove the type assertion cast and construct the options object
without initialState to keep the runtime payload clean and maintain type safety.


const SDK_METADATA = {
name: PACKAGE_NAME,
Expand DownExpand Up@@ -35,7 +38,6 @@ const SDK_METADATA = {
*/
export const clerkPlugin: Plugin<[PluginOptions]> = {
install(app, pluginOptions) {
// @ts-expect-error: Internal property for SSR frameworks like Nuxt
const { initialState } = pluginOptions;

const loaded = shallowRef(false);
Expand Down
Loading
, '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
Merged
6 changes: 6 additions & 0 deletions .changeset/tame-poems-impress.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
---
"@clerk/nuxt": patch
"@clerk/vue": patch
---

Make `initialState` prop public and bump `@nuxt/kit` to 3.17.5
24 changes: 16 additions & 8 deletions packages/nextjs/src/__tests__/webhooks.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -10,16 +10,22 @@ const mockSuccessResponse = {
object: 'event',
} as any;

const mockError = new Error('Missing required Svix headers: svix-id, svix-timestamp, svix-signature');

vi.mock('@clerk/backend/webhooks', () => ({
verifyWebhook: vi.fn().mockImplementation((request: Request) => {
const svixId = request.headers.get('svix-id');
const svixTimestamp = request.headers.get('svix-timestamp');
const svixSignature = request.headers.get('svix-signature');
verifyWebhook: vi.fn().mockImplementation(async (request: any) => {
// Support both Fetch API Request and plain object
const getHeader = (key: string) => {
if (request instanceof Request) {
return request.headers.get(key);
}
return request.headers?.[key];
};

const svixId = getHeader('svix-id');
const svixTimestamp = getHeader('svix-timestamp');
const svixSignature = getHeader('svix-signature');

if (!svixId || !svixTimestamp || !svixSignature) {
throw mockError;
throw new Error('Missing required Svix headers: svix-id, svix-timestamp, svix-signature');
}

return mockSuccessResponse;
Expand DownExpand Up@@ -88,7 +94,9 @@ describe('verifyWebhook', () => {
aborted: false,
} as unknown as NextApiRequest;

await expect(verifyWebhook(mockNextApiRequest)).rejects.toThrow(mockError);
await expect(verifyWebhook(mockNextApiRequest)).rejects.toThrow(
'Missing required Svix headers: svix-id, svix-timestamp, svix-signature',
);
});
});
});
8 changes: 4 additions & 4 deletions packages/nuxt/package.json
Original file line numberDiff line numberDiff line change
Expand Up@@ -71,12 +71,12 @@
"@clerk/shared": "workspace:^",
"@clerk/types": "workspace:^",
"@clerk/vue": "workspace:^",
"@nuxt/kit": "^3.16.2",
"@nuxt/schema": "^3.16.2",
"h3": "^1.15.1"
"@nuxt/kit": "^3.17.5",
"@nuxt/schema": "^3.17.5",
"h3": "^1.15.3"
},
"devDependencies": {
"nuxt": "^3.16.2",
"nuxt": "^3.17.5",
"typescript": "catalog:repo"
},
"engines": {
Expand Down
1 change: 1 addition & 0 deletions packages/nuxt/src/global.d.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -11,6 +11,7 @@ declare module 'nuxt/schema' {
clerk: {
secretKey?: string;
jwtKey?: string;
webhookSigningSecret?: string;
};
}
interface PublicRuntimeConfig {
Expand Down
11 changes: 7 additions & 4 deletions packages/nuxt/src/module.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -12,7 +12,10 @@ import {
updateRuntimeConfig,
} from '@nuxt/kit';

export type ModuleOptions = Without<PluginOptions, 'routerPush' | 'routerReplace' | 'publishableKey'> & {
export type ModuleOptions = Without<
PluginOptions,
'routerPush' | 'routerReplace' | 'publishableKey' | 'initialState'
> & {
publishableKey?: string;
/**
* Skip the automatic server middleware registration. When enabled, you'll need to
Expand DownExpand Up@@ -106,10 +109,10 @@ export default defineNuxtModule<ModuleOptions>({
addTypeTemplate(
{
filename: 'types/clerk.d.ts',
getContents: () => `import type { SignedInAuthObject, SignedOutAuthObject } from '@clerk/backend/internal';
getContents: () => `import type { SessionAuthObject } from '@clerk/backend';
declare module 'h3' {
type AuthObjectHandler = (SignedInAuthObject | SignedOutAuthObject) & {
(): SignedInAuthObject | SignedOutAuthObject;
type AuthObjectHandler = SessionAuthObject & {
(): SessionAuthObject;
Comment on lines +112 to +115

@wobsorianowobsorianoJun 16, 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.

SessionAuthObject is a new type introduced in machine auth

see token types

}

interface H3EventContext {
Expand Down
4 changes: 3 additions & 1 deletion packages/nuxt/src/runtime/plugin.ts
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
import { setClerkJsLoadingErrorPackageName } from '@clerk/shared/loadClerkJsScript';
import type { InitialState } from '@clerk/types';
import { clerkPlugin } from '@clerk/vue';
import { setErrorThrowerOptions } from '@clerk/vue/internal';
import { defineNuxtPlugin, navigateTo, useRuntimeConfig, useState } from 'nuxt/app';
Expand All@@ -8,14 +9,15 @@ setClerkJsLoadingErrorPackageName(PACKAGE_NAME);

export default defineNuxtPlugin(nuxtApp => {
// SSR-friendly shared state
const initialState = useState('clerk-initial-state', () => undefined);
const initialState = useState<InitialState | undefined>('clerk-initial-state', () => undefined);

if (import.meta.server) {
// Save the initial state from server and pass it to the plugin
initialState.value = nuxtApp.ssrContext?.event.context.__clerk_initial_state;
}

const runtimeConfig = useRuntimeConfig();

nuxtApp.vueApp.use(clerkPlugin, {
...(runtimeConfig.public.clerk ?? {}),
sdkMetadata: {
Expand Down
6 changes: 3 additions & 3 deletions packages/vue/package.json
Original file line numberDiff line numberDiff line change
Expand Up@@ -62,10 +62,10 @@
},
"devDependencies": {
"@testing-library/vue": "^8.1.0",
"@vitejs/plugin-vue": "^5.2.3",
"@vitejs/plugin-vue": "^5.2.4",
"@vue.ts/tsx-auto-props": "^0.6.0",
"unplugin-vue": "^5.2.1",
"vue": "3.5.13",
"unplugin-vue": "^6.2.0",
"vue": "3.5.16",
"vue-tsc": "^2.2.10"
},
"peerDependencies": {
Expand Down
8 changes: 5 additions & 3 deletions packages/vue/src/plugin.ts
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,16 @@
import { inBrowser } from '@clerk/shared/browser';
import { deriveState } from '@clerk/shared/deriveState';
import { loadClerkJsScript, type LoadClerkJsScriptOptions } from '@clerk/shared/loadClerkJsScript';
import type { Clerk, ClientResource, MultiDomainAndOrProxy, Resources, Without } from '@clerk/types';
import type { Clerk, ClientResource, InitialState, MultiDomainAndOrProxy, Resources, Without } from '@clerk/types';
import type { Plugin } from 'vue';
import { computed, ref, shallowRef, triggerRef } from 'vue';

import { ClerkInjectionKey } from './keys';

export type PluginOptions = Without<LoadClerkJsScriptOptions, 'domain' | 'proxyUrl'> & MultiDomainAndOrProxy;
export type PluginOptions = Without<LoadClerkJsScriptOptions, 'domain' | 'proxyUrl'> &
MultiDomainAndOrProxy & {
initialState?: InitialState;
};
Comment on lines +10 to +13

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.

🛠️ Refactor suggestion

initialState leaks into loadClerkJsScript options

pluginOptions now carries initialState, but a few lines below we cast the full object to LoadClerkJsScriptOptions and forward it to loadClerkJsScript:

constoptions={
...pluginOptions,sdkMetadata: pluginOptions.sdkMetadata||SDK_METADATA,}asLoadClerkJsScriptOptions;

loadClerkJsScript has no concept of initialState; the extra key is silently ignored today but future strict‐mode checks (or external libs doing Object.keys) might fail.

A minimal, type-safe guard:

-const options = {- ...pluginOptions,- sdkMetadata: pluginOptions.sdkMetadata || SDK_METADATA,-} as LoadClerkJsScriptOptions;+const { initialState, ...loadOptions } = pluginOptions;+const options: LoadClerkJsScriptOptions = {+ ...loadOptions,+ sdkMetadata: loadOptions.sdkMetadata || SDK_METADATA,+};

Keeps runtime payload clean and removes the need for the as cast.

🤖 Prompt for AI Agents
In packages/vue/src/plugin.ts around lines 10 to 13, the PluginOptions type
includes an initialState property that is not part of LoadClerkJsScriptOptions
but is being cast and passed to loadClerkJsScript, causing a type leak. To fix
this, explicitly separate initialState from pluginOptions before passing options
to loadClerkJsScript, ensuring only valid LoadClerkJsScriptOptions keys are
forwarded. Remove the type assertion cast and construct the options object
without initialState to keep the runtime payload clean and maintain type safety.


const SDK_METADATA = {
name: PACKAGE_NAME,
Expand DownExpand Up@@ -35,7 +38,6 @@ const SDK_METADATA = {
*/
export const clerkPlugin: Plugin<[PluginOptions]> = {
install(app, pluginOptions) {
// @ts-expect-error: Internal property for SSR frameworks like Nuxt
const { initialState } = pluginOptions;

const loaded = shallowRef(false);
Expand Down
Loading
, '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
Merged
6 changes: 6 additions & 0 deletions .changeset/tame-poems-impress.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
---
"@clerk/nuxt": patch
"@clerk/vue": patch
---

Make `initialState` prop public and bump `@nuxt/kit` to 3.17.5
24 changes: 16 additions & 8 deletions packages/nextjs/src/__tests__/webhooks.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -10,16 +10,22 @@ const mockSuccessResponse = {
object: 'event',
} as any;

const mockError = new Error('Missing required Svix headers: svix-id, svix-timestamp, svix-signature');

vi.mock('@clerk/backend/webhooks', () => ({
verifyWebhook: vi.fn().mockImplementation((request: Request) => {
const svixId = request.headers.get('svix-id');
const svixTimestamp = request.headers.get('svix-timestamp');
const svixSignature = request.headers.get('svix-signature');
verifyWebhook: vi.fn().mockImplementation(async (request: any) => {
// Support both Fetch API Request and plain object
const getHeader = (key: string) => {
if (request instanceof Request) {
return request.headers.get(key);
}
return request.headers?.[key];
};

const svixId = getHeader('svix-id');
const svixTimestamp = getHeader('svix-timestamp');
const svixSignature = getHeader('svix-signature');

if (!svixId || !svixTimestamp || !svixSignature) {
throw mockError;
throw new Error('Missing required Svix headers: svix-id, svix-timestamp, svix-signature');
}

return mockSuccessResponse;
Expand DownExpand Up@@ -88,7 +94,9 @@ describe('verifyWebhook', () => {
aborted: false,
} as unknown as NextApiRequest;

await expect(verifyWebhook(mockNextApiRequest)).rejects.toThrow(mockError);
await expect(verifyWebhook(mockNextApiRequest)).rejects.toThrow(
'Missing required Svix headers: svix-id, svix-timestamp, svix-signature',
);
});
});
});
8 changes: 4 additions & 4 deletions packages/nuxt/package.json
Original file line numberDiff line numberDiff line change
Expand Up@@ -71,12 +71,12 @@
"@clerk/shared": "workspace:^",
"@clerk/types": "workspace:^",
"@clerk/vue": "workspace:^",
"@nuxt/kit": "^3.16.2",
"@nuxt/schema": "^3.16.2",
"h3": "^1.15.1"
"@nuxt/kit": "^3.17.5",
"@nuxt/schema": "^3.17.5",
"h3": "^1.15.3"
},
"devDependencies": {
"nuxt": "^3.16.2",
"nuxt": "^3.17.5",
"typescript": "catalog:repo"
},
"engines": {
Expand Down
1 change: 1 addition & 0 deletions packages/nuxt/src/global.d.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -11,6 +11,7 @@ declare module 'nuxt/schema' {
clerk: {
secretKey?: string;
jwtKey?: string;
webhookSigningSecret?: string;
};
}
interface PublicRuntimeConfig {
Expand Down
11 changes: 7 additions & 4 deletions packages/nuxt/src/module.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -12,7 +12,10 @@ import {
updateRuntimeConfig,
} from '@nuxt/kit';

export type ModuleOptions = Without<PluginOptions, 'routerPush' | 'routerReplace' | 'publishableKey'> & {
export type ModuleOptions = Without<
PluginOptions,
'routerPush' | 'routerReplace' | 'publishableKey' | 'initialState'
> & {
publishableKey?: string;
/**
* Skip the automatic server middleware registration. When enabled, you'll need to
Expand DownExpand Up@@ -106,10 +109,10 @@ export default defineNuxtModule<ModuleOptions>({
addTypeTemplate(
{
filename: 'types/clerk.d.ts',
getContents: () => `import type { SignedInAuthObject, SignedOutAuthObject } from '@clerk/backend/internal';
getContents: () => `import type { SessionAuthObject } from '@clerk/backend';
declare module 'h3' {
type AuthObjectHandler = (SignedInAuthObject | SignedOutAuthObject) & {
(): SignedInAuthObject | SignedOutAuthObject;
type AuthObjectHandler = SessionAuthObject & {
(): SessionAuthObject;
Comment on lines +112 to +115

@wobsorianowobsorianoJun 16, 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.

SessionAuthObject is a new type introduced in machine auth

see token types

}

interface H3EventContext {
Expand Down
4 changes: 3 additions & 1 deletion packages/nuxt/src/runtime/plugin.ts
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
import { setClerkJsLoadingErrorPackageName } from '@clerk/shared/loadClerkJsScript';
import type { InitialState } from '@clerk/types';
import { clerkPlugin } from '@clerk/vue';
import { setErrorThrowerOptions } from '@clerk/vue/internal';
import { defineNuxtPlugin, navigateTo, useRuntimeConfig, useState } from 'nuxt/app';
Expand All@@ -8,14 +9,15 @@ setClerkJsLoadingErrorPackageName(PACKAGE_NAME);

export default defineNuxtPlugin(nuxtApp => {
// SSR-friendly shared state
const initialState = useState('clerk-initial-state', () => undefined);
const initialState = useState<InitialState | undefined>('clerk-initial-state', () => undefined);

if (import.meta.server) {
// Save the initial state from server and pass it to the plugin
initialState.value = nuxtApp.ssrContext?.event.context.__clerk_initial_state;
}

const runtimeConfig = useRuntimeConfig();

nuxtApp.vueApp.use(clerkPlugin, {
...(runtimeConfig.public.clerk ?? {}),
sdkMetadata: {
Expand Down
6 changes: 3 additions & 3 deletions packages/vue/package.json
Original file line numberDiff line numberDiff line change
Expand Up@@ -62,10 +62,10 @@
},
"devDependencies": {
"@testing-library/vue": "^8.1.0",
"@vitejs/plugin-vue": "^5.2.3",
"@vitejs/plugin-vue": "^5.2.4",
"@vue.ts/tsx-auto-props": "^0.6.0",
"unplugin-vue": "^5.2.1",
"vue": "3.5.13",
"unplugin-vue": "^6.2.0",
"vue": "3.5.16",
"vue-tsc": "^2.2.10"
},
"peerDependencies": {
Expand Down
8 changes: 5 additions & 3 deletions packages/vue/src/plugin.ts
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,16 @@
import { inBrowser } from '@clerk/shared/browser';
import { deriveState } from '@clerk/shared/deriveState';
import { loadClerkJsScript, type LoadClerkJsScriptOptions } from '@clerk/shared/loadClerkJsScript';
import type { Clerk, ClientResource, MultiDomainAndOrProxy, Resources, Without } from '@clerk/types';
import type { Clerk, ClientResource, InitialState, MultiDomainAndOrProxy, Resources, Without } from '@clerk/types';
import type { Plugin } from 'vue';
import { computed, ref, shallowRef, triggerRef } from 'vue';

import { ClerkInjectionKey } from './keys';

export type PluginOptions = Without<LoadClerkJsScriptOptions, 'domain' | 'proxyUrl'> & MultiDomainAndOrProxy;
export type PluginOptions = Without<LoadClerkJsScriptOptions, 'domain' | 'proxyUrl'> &
MultiDomainAndOrProxy & {
initialState?: InitialState;
};
Comment on lines +10 to +13

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.

🛠️ Refactor suggestion

initialState leaks into loadClerkJsScript options

pluginOptions now carries initialState, but a few lines below we cast the full object to LoadClerkJsScriptOptions and forward it to loadClerkJsScript:

constoptions={
...pluginOptions,sdkMetadata: pluginOptions.sdkMetadata||SDK_METADATA,}asLoadClerkJsScriptOptions;

loadClerkJsScript has no concept of initialState; the extra key is silently ignored today but future strict‐mode checks (or external libs doing Object.keys) might fail.

A minimal, type-safe guard:

-const options = {- ...pluginOptions,- sdkMetadata: pluginOptions.sdkMetadata || SDK_METADATA,-} as LoadClerkJsScriptOptions;+const { initialState, ...loadOptions } = pluginOptions;+const options: LoadClerkJsScriptOptions = {+ ...loadOptions,+ sdkMetadata: loadOptions.sdkMetadata || SDK_METADATA,+};

Keeps runtime payload clean and removes the need for the as cast.

🤖 Prompt for AI Agents
In packages/vue/src/plugin.ts around lines 10 to 13, the PluginOptions type
includes an initialState property that is not part of LoadClerkJsScriptOptions
but is being cast and passed to loadClerkJsScript, causing a type leak. To fix
this, explicitly separate initialState from pluginOptions before passing options
to loadClerkJsScript, ensuring only valid LoadClerkJsScriptOptions keys are
forwarded. Remove the type assertion cast and construct the options object
without initialState to keep the runtime payload clean and maintain type safety.


const SDK_METADATA = {
name: PACKAGE_NAME,
Expand DownExpand Up@@ -35,7 +38,6 @@ const SDK_METADATA = {
*/
export const clerkPlugin: Plugin<[PluginOptions]> = {
install(app, pluginOptions) {
// @ts-expect-error: Internal property for SSR frameworks like Nuxt
const { initialState } = pluginOptions;

const loaded = shallowRef(false);
Expand Down
Loading
, '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
Merged
6 changes: 6 additions & 0 deletions .changeset/tame-poems-impress.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
---
"@clerk/nuxt": patch
"@clerk/vue": patch
---

Make `initialState` prop public and bump `@nuxt/kit` to 3.17.5
24 changes: 16 additions & 8 deletions packages/nextjs/src/__tests__/webhooks.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -10,16 +10,22 @@ const mockSuccessResponse = {
object: 'event',
} as any;

const mockError = new Error('Missing required Svix headers: svix-id, svix-timestamp, svix-signature');

vi.mock('@clerk/backend/webhooks', () => ({
verifyWebhook: vi.fn().mockImplementation((request: Request) => {
const svixId = request.headers.get('svix-id');
const svixTimestamp = request.headers.get('svix-timestamp');
const svixSignature = request.headers.get('svix-signature');
verifyWebhook: vi.fn().mockImplementation(async (request: any) => {
// Support both Fetch API Request and plain object
const getHeader = (key: string) => {
if (request instanceof Request) {
return request.headers.get(key);
}
return request.headers?.[key];
};

const svixId = getHeader('svix-id');
const svixTimestamp = getHeader('svix-timestamp');
const svixSignature = getHeader('svix-signature');

if (!svixId || !svixTimestamp || !svixSignature) {
throw mockError;
throw new Error('Missing required Svix headers: svix-id, svix-timestamp, svix-signature');
}

return mockSuccessResponse;
Expand DownExpand Up@@ -88,7 +94,9 @@ describe('verifyWebhook', () => {
aborted: false,
} as unknown as NextApiRequest;

await expect(verifyWebhook(mockNextApiRequest)).rejects.toThrow(mockError);
await expect(verifyWebhook(mockNextApiRequest)).rejects.toThrow(
'Missing required Svix headers: svix-id, svix-timestamp, svix-signature',
);
});
});
});
8 changes: 4 additions & 4 deletions packages/nuxt/package.json
Original file line numberDiff line numberDiff line change
Expand Up@@ -71,12 +71,12 @@
"@clerk/shared": "workspace:^",
"@clerk/types": "workspace:^",
"@clerk/vue": "workspace:^",
"@nuxt/kit": "^3.16.2",
"@nuxt/schema": "^3.16.2",
"h3": "^1.15.1"
"@nuxt/kit": "^3.17.5",
"@nuxt/schema": "^3.17.5",
"h3": "^1.15.3"
},
"devDependencies": {
"nuxt": "^3.16.2",
"nuxt": "^3.17.5",
"typescript": "catalog:repo"
},
"engines": {
Expand Down
1 change: 1 addition & 0 deletions packages/nuxt/src/global.d.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -11,6 +11,7 @@ declare module 'nuxt/schema' {
clerk: {
secretKey?: string;
jwtKey?: string;
webhookSigningSecret?: string;
};
}
interface PublicRuntimeConfig {
Expand Down
11 changes: 7 additions & 4 deletions packages/nuxt/src/module.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -12,7 +12,10 @@ import {
updateRuntimeConfig,
} from '@nuxt/kit';

export type ModuleOptions = Without<PluginOptions, 'routerPush' | 'routerReplace' | 'publishableKey'> & {
export type ModuleOptions = Without<
PluginOptions,
'routerPush' | 'routerReplace' | 'publishableKey' | 'initialState'
> & {
publishableKey?: string;
/**
* Skip the automatic server middleware registration. When enabled, you'll need to
Expand DownExpand Up@@ -106,10 +109,10 @@ export default defineNuxtModule<ModuleOptions>({
addTypeTemplate(
{
filename: 'types/clerk.d.ts',
getContents: () => `import type { SignedInAuthObject, SignedOutAuthObject } from '@clerk/backend/internal';
getContents: () => `import type { SessionAuthObject } from '@clerk/backend';
declare module 'h3' {
type AuthObjectHandler = (SignedInAuthObject | SignedOutAuthObject) & {
(): SignedInAuthObject | SignedOutAuthObject;
type AuthObjectHandler = SessionAuthObject & {
(): SessionAuthObject;
Comment on lines +112 to +115

@wobsorianowobsorianoJun 16, 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.

SessionAuthObject is a new type introduced in machine auth

see token types

}

interface H3EventContext {
Expand Down
4 changes: 3 additions & 1 deletion packages/nuxt/src/runtime/plugin.ts
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
import { setClerkJsLoadingErrorPackageName } from '@clerk/shared/loadClerkJsScript';
import type { InitialState } from '@clerk/types';
import { clerkPlugin } from '@clerk/vue';
import { setErrorThrowerOptions } from '@clerk/vue/internal';
import { defineNuxtPlugin, navigateTo, useRuntimeConfig, useState } from 'nuxt/app';
Expand All@@ -8,14 +9,15 @@ setClerkJsLoadingErrorPackageName(PACKAGE_NAME);

export default defineNuxtPlugin(nuxtApp => {
// SSR-friendly shared state
const initialState = useState('clerk-initial-state', () => undefined);
const initialState = useState<InitialState | undefined>('clerk-initial-state', () => undefined);

if (import.meta.server) {
// Save the initial state from server and pass it to the plugin
initialState.value = nuxtApp.ssrContext?.event.context.__clerk_initial_state;
}

const runtimeConfig = useRuntimeConfig();

nuxtApp.vueApp.use(clerkPlugin, {
...(runtimeConfig.public.clerk ?? {}),
sdkMetadata: {
Expand Down
6 changes: 3 additions & 3 deletions packages/vue/package.json
Original file line numberDiff line numberDiff line change
Expand Up@@ -62,10 +62,10 @@
},
"devDependencies": {
"@testing-library/vue": "^8.1.0",
"@vitejs/plugin-vue": "^5.2.3",
"@vitejs/plugin-vue": "^5.2.4",
"@vue.ts/tsx-auto-props": "^0.6.0",
"unplugin-vue": "^5.2.1",
"vue": "3.5.13",
"unplugin-vue": "^6.2.0",
"vue": "3.5.16",
"vue-tsc": "^2.2.10"
},
"peerDependencies": {
Expand Down
8 changes: 5 additions & 3 deletions packages/vue/src/plugin.ts
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,16 @@
import { inBrowser } from '@clerk/shared/browser';
import { deriveState } from '@clerk/shared/deriveState';
import { loadClerkJsScript, type LoadClerkJsScriptOptions } from '@clerk/shared/loadClerkJsScript';
import type { Clerk, ClientResource, MultiDomainAndOrProxy, Resources, Without } from '@clerk/types';
import type { Clerk, ClientResource, InitialState, MultiDomainAndOrProxy, Resources, Without } from '@clerk/types';
import type { Plugin } from 'vue';
import { computed, ref, shallowRef, triggerRef } from 'vue';

import { ClerkInjectionKey } from './keys';

export type PluginOptions = Without<LoadClerkJsScriptOptions, 'domain' | 'proxyUrl'> & MultiDomainAndOrProxy;
export type PluginOptions = Without<LoadClerkJsScriptOptions, 'domain' | 'proxyUrl'> &
MultiDomainAndOrProxy & {
initialState?: InitialState;
};
Comment on lines +10 to +13

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.

🛠️ Refactor suggestion

initialState leaks into loadClerkJsScript options

pluginOptions now carries initialState, but a few lines below we cast the full object to LoadClerkJsScriptOptions and forward it to loadClerkJsScript:

constoptions={
...pluginOptions,sdkMetadata: pluginOptions.sdkMetadata||SDK_METADATA,}asLoadClerkJsScriptOptions;

loadClerkJsScript has no concept of initialState; the extra key is silently ignored today but future strict‐mode checks (or external libs doing Object.keys) might fail.

A minimal, type-safe guard:

-const options = {- ...pluginOptions,- sdkMetadata: pluginOptions.sdkMetadata || SDK_METADATA,-} as LoadClerkJsScriptOptions;+const { initialState, ...loadOptions } = pluginOptions;+const options: LoadClerkJsScriptOptions = {+ ...loadOptions,+ sdkMetadata: loadOptions.sdkMetadata || SDK_METADATA,+};

Keeps runtime payload clean and removes the need for the as cast.

🤖 Prompt for AI Agents
In packages/vue/src/plugin.ts around lines 10 to 13, the PluginOptions type
includes an initialState property that is not part of LoadClerkJsScriptOptions
but is being cast and passed to loadClerkJsScript, causing a type leak. To fix
this, explicitly separate initialState from pluginOptions before passing options
to loadClerkJsScript, ensuring only valid LoadClerkJsScriptOptions keys are
forwarded. Remove the type assertion cast and construct the options object
without initialState to keep the runtime payload clean and maintain type safety.


const SDK_METADATA = {
name: PACKAGE_NAME,
Expand DownExpand Up@@ -35,7 +38,6 @@ const SDK_METADATA = {
*/
export const clerkPlugin: Plugin<[PluginOptions]> = {
install(app, pluginOptions) {
// @ts-expect-error: Internal property for SSR frameworks like Nuxt
const { initialState } = pluginOptions;

const loaded = shallowRef(false);
Expand Down
Loading
, '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
Merged
6 changes: 6 additions & 0 deletions .changeset/tame-poems-impress.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
---
"@clerk/nuxt": patch
"@clerk/vue": patch
---

Make `initialState` prop public and bump `@nuxt/kit` to 3.17.5
24 changes: 16 additions & 8 deletions packages/nextjs/src/__tests__/webhooks.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -10,16 +10,22 @@ const mockSuccessResponse = {
object: 'event',
} as any;

const mockError = new Error('Missing required Svix headers: svix-id, svix-timestamp, svix-signature');

vi.mock('@clerk/backend/webhooks', () => ({
verifyWebhook: vi.fn().mockImplementation((request: Request) => {
const svixId = request.headers.get('svix-id');
const svixTimestamp = request.headers.get('svix-timestamp');
const svixSignature = request.headers.get('svix-signature');
verifyWebhook: vi.fn().mockImplementation(async (request: any) => {
// Support both Fetch API Request and plain object
const getHeader = (key: string) => {
if (request instanceof Request) {
return request.headers.get(key);
}
return request.headers?.[key];
};

const svixId = getHeader('svix-id');
const svixTimestamp = getHeader('svix-timestamp');
const svixSignature = getHeader('svix-signature');

if (!svixId || !svixTimestamp || !svixSignature) {
throw mockError;
throw new Error('Missing required Svix headers: svix-id, svix-timestamp, svix-signature');
}

return mockSuccessResponse;
Expand DownExpand Up@@ -88,7 +94,9 @@ describe('verifyWebhook', () => {
aborted: false,
} as unknown as NextApiRequest;

await expect(verifyWebhook(mockNextApiRequest)).rejects.toThrow(mockError);
await expect(verifyWebhook(mockNextApiRequest)).rejects.toThrow(
'Missing required Svix headers: svix-id, svix-timestamp, svix-signature',
);
});
});
});
8 changes: 4 additions & 4 deletions packages/nuxt/package.json
Original file line numberDiff line numberDiff line change
Expand Up@@ -71,12 +71,12 @@
"@clerk/shared": "workspace:^",
"@clerk/types": "workspace:^",
"@clerk/vue": "workspace:^",
"@nuxt/kit": "^3.16.2",
"@nuxt/schema": "^3.16.2",
"h3": "^1.15.1"
"@nuxt/kit": "^3.17.5",
"@nuxt/schema": "^3.17.5",
"h3": "^1.15.3"
},
"devDependencies": {
"nuxt": "^3.16.2",
"nuxt": "^3.17.5",
"typescript": "catalog:repo"
},
"engines": {
Expand Down
1 change: 1 addition & 0 deletions packages/nuxt/src/global.d.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -11,6 +11,7 @@ declare module 'nuxt/schema' {
clerk: {
secretKey?: string;
jwtKey?: string;
webhookSigningSecret?: string;
};
}
interface PublicRuntimeConfig {
Expand Down
11 changes: 7 additions & 4 deletions packages/nuxt/src/module.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -12,7 +12,10 @@ import {
updateRuntimeConfig,
} from '@nuxt/kit';

export type ModuleOptions = Without<PluginOptions, 'routerPush' | 'routerReplace' | 'publishableKey'> & {
export type ModuleOptions = Without<
PluginOptions,
'routerPush' | 'routerReplace' | 'publishableKey' | 'initialState'
> & {
publishableKey?: string;
/**
* Skip the automatic server middleware registration. When enabled, you'll need to
Expand DownExpand Up@@ -106,10 +109,10 @@ export default defineNuxtModule<ModuleOptions>({
addTypeTemplate(
{
filename: 'types/clerk.d.ts',
getContents: () => `import type { SignedInAuthObject, SignedOutAuthObject } from '@clerk/backend/internal';
getContents: () => `import type { SessionAuthObject } from '@clerk/backend';
declare module 'h3' {
type AuthObjectHandler = (SignedInAuthObject | SignedOutAuthObject) & {
(): SignedInAuthObject | SignedOutAuthObject;
type AuthObjectHandler = SessionAuthObject & {
(): SessionAuthObject;
Comment on lines +112 to +115

@wobsorianowobsorianoJun 16, 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.

SessionAuthObject is a new type introduced in machine auth

see token types

}

interface H3EventContext {
Expand Down
4 changes: 3 additions & 1 deletion packages/nuxt/src/runtime/plugin.ts
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
import { setClerkJsLoadingErrorPackageName } from '@clerk/shared/loadClerkJsScript';
import type { InitialState } from '@clerk/types';
import { clerkPlugin } from '@clerk/vue';
import { setErrorThrowerOptions } from '@clerk/vue/internal';
import { defineNuxtPlugin, navigateTo, useRuntimeConfig, useState } from 'nuxt/app';
Expand All@@ -8,14 +9,15 @@ setClerkJsLoadingErrorPackageName(PACKAGE_NAME);

export default defineNuxtPlugin(nuxtApp => {
// SSR-friendly shared state
const initialState = useState('clerk-initial-state', () => undefined);
const initialState = useState<InitialState | undefined>('clerk-initial-state', () => undefined);

if (import.meta.server) {
// Save the initial state from server and pass it to the plugin
initialState.value = nuxtApp.ssrContext?.event.context.__clerk_initial_state;
}

const runtimeConfig = useRuntimeConfig();

nuxtApp.vueApp.use(clerkPlugin, {
...(runtimeConfig.public.clerk ?? {}),
sdkMetadata: {
Expand Down
6 changes: 3 additions & 3 deletions packages/vue/package.json
Original file line numberDiff line numberDiff line change
Expand Up@@ -62,10 +62,10 @@
},
"devDependencies": {
"@testing-library/vue": "^8.1.0",
"@vitejs/plugin-vue": "^5.2.3",
"@vitejs/plugin-vue": "^5.2.4",
"@vue.ts/tsx-auto-props": "^0.6.0",
"unplugin-vue": "^5.2.1",
"vue": "3.5.13",
"unplugin-vue": "^6.2.0",
"vue": "3.5.16",
"vue-tsc": "^2.2.10"
},
"peerDependencies": {
Expand Down
8 changes: 5 additions & 3 deletions packages/vue/src/plugin.ts
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,16 @@
import { inBrowser } from '@clerk/shared/browser';
import { deriveState } from '@clerk/shared/deriveState';
import { loadClerkJsScript, type LoadClerkJsScriptOptions } from '@clerk/shared/loadClerkJsScript';
import type { Clerk, ClientResource, MultiDomainAndOrProxy, Resources, Without } from '@clerk/types';
import type { Clerk, ClientResource, InitialState, MultiDomainAndOrProxy, Resources, Without } from '@clerk/types';
import type { Plugin } from 'vue';
import { computed, ref, shallowRef, triggerRef } from 'vue';

import { ClerkInjectionKey } from './keys';

export type PluginOptions = Without<LoadClerkJsScriptOptions, 'domain' | 'proxyUrl'> & MultiDomainAndOrProxy;
export type PluginOptions = Without<LoadClerkJsScriptOptions, 'domain' | 'proxyUrl'> &
MultiDomainAndOrProxy & {
initialState?: InitialState;
};
Comment on lines +10 to +13

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.

🛠️ Refactor suggestion

initialState leaks into loadClerkJsScript options

pluginOptions now carries initialState, but a few lines below we cast the full object to LoadClerkJsScriptOptions and forward it to loadClerkJsScript:

constoptions={
...pluginOptions,sdkMetadata: pluginOptions.sdkMetadata||SDK_METADATA,}asLoadClerkJsScriptOptions;

loadClerkJsScript has no concept of initialState; the extra key is silently ignored today but future strict‐mode checks (or external libs doing Object.keys) might fail.

A minimal, type-safe guard:

-const options = {- ...pluginOptions,- sdkMetadata: pluginOptions.sdkMetadata || SDK_METADATA,-} as LoadClerkJsScriptOptions;+const { initialState, ...loadOptions } = pluginOptions;+const options: LoadClerkJsScriptOptions = {+ ...loadOptions,+ sdkMetadata: loadOptions.sdkMetadata || SDK_METADATA,+};

Keeps runtime payload clean and removes the need for the as cast.

🤖 Prompt for AI Agents
In packages/vue/src/plugin.ts around lines 10 to 13, the PluginOptions type
includes an initialState property that is not part of LoadClerkJsScriptOptions
but is being cast and passed to loadClerkJsScript, causing a type leak. To fix
this, explicitly separate initialState from pluginOptions before passing options
to loadClerkJsScript, ensuring only valid LoadClerkJsScriptOptions keys are
forwarded. Remove the type assertion cast and construct the options object
without initialState to keep the runtime payload clean and maintain type safety.


const SDK_METADATA = {
name: PACKAGE_NAME,
Expand DownExpand Up@@ -35,7 +38,6 @@ const SDK_METADATA = {
*/
export const clerkPlugin: Plugin<[PluginOptions]> = {
install(app, pluginOptions) {
// @ts-expect-error: Internal property for SSR frameworks like Nuxt
const { initialState } = pluginOptions;

const loaded = shallowRef(false);
Expand Down
Loading
, '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
Merged
6 changes: 6 additions & 0 deletions .changeset/tame-poems-impress.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
---
"@clerk/nuxt": patch
"@clerk/vue": patch
---

Make `initialState` prop public and bump `@nuxt/kit` to 3.17.5
24 changes: 16 additions & 8 deletions packages/nextjs/src/__tests__/webhooks.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -10,16 +10,22 @@ const mockSuccessResponse = {
object: 'event',
} as any;

const mockError = new Error('Missing required Svix headers: svix-id, svix-timestamp, svix-signature');

vi.mock('@clerk/backend/webhooks', () => ({
verifyWebhook: vi.fn().mockImplementation((request: Request) => {
const svixId = request.headers.get('svix-id');
const svixTimestamp = request.headers.get('svix-timestamp');
const svixSignature = request.headers.get('svix-signature');
verifyWebhook: vi.fn().mockImplementation(async (request: any) => {
// Support both Fetch API Request and plain object
const getHeader = (key: string) => {
if (request instanceof Request) {
return request.headers.get(key);
}
return request.headers?.[key];
};

const svixId = getHeader('svix-id');
const svixTimestamp = getHeader('svix-timestamp');
const svixSignature = getHeader('svix-signature');

if (!svixId || !svixTimestamp || !svixSignature) {
throw mockError;
throw new Error('Missing required Svix headers: svix-id, svix-timestamp, svix-signature');
}

return mockSuccessResponse;
Expand DownExpand Up@@ -88,7 +94,9 @@ describe('verifyWebhook', () => {
aborted: false,
} as unknown as NextApiRequest;

await expect(verifyWebhook(mockNextApiRequest)).rejects.toThrow(mockError);
await expect(verifyWebhook(mockNextApiRequest)).rejects.toThrow(
'Missing required Svix headers: svix-id, svix-timestamp, svix-signature',
);
});
});
});
8 changes: 4 additions & 4 deletions packages/nuxt/package.json
Original file line numberDiff line numberDiff line change
Expand Up@@ -71,12 +71,12 @@
"@clerk/shared": "workspace:^",
"@clerk/types": "workspace:^",
"@clerk/vue": "workspace:^",
"@nuxt/kit": "^3.16.2",
"@nuxt/schema": "^3.16.2",
"h3": "^1.15.1"
"@nuxt/kit": "^3.17.5",
"@nuxt/schema": "^3.17.5",
"h3": "^1.15.3"
},
"devDependencies": {
"nuxt": "^3.16.2",
"nuxt": "^3.17.5",
"typescript": "catalog:repo"
},
"engines": {
Expand Down
1 change: 1 addition & 0 deletions packages/nuxt/src/global.d.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -11,6 +11,7 @@ declare module 'nuxt/schema' {
clerk: {
secretKey?: string;
jwtKey?: string;
webhookSigningSecret?: string;
};
}
interface PublicRuntimeConfig {
Expand Down
11 changes: 7 additions & 4 deletions packages/nuxt/src/module.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -12,7 +12,10 @@ import {
updateRuntimeConfig,
} from '@nuxt/kit';

export type ModuleOptions = Without<PluginOptions, 'routerPush' | 'routerReplace' | 'publishableKey'> & {
export type ModuleOptions = Without<
PluginOptions,
'routerPush' | 'routerReplace' | 'publishableKey' | 'initialState'
> & {
publishableKey?: string;
/**
* Skip the automatic server middleware registration. When enabled, you'll need to
Expand DownExpand Up@@ -106,10 +109,10 @@ export default defineNuxtModule<ModuleOptions>({
addTypeTemplate(
{
filename: 'types/clerk.d.ts',
getContents: () => `import type { SignedInAuthObject, SignedOutAuthObject } from '@clerk/backend/internal';
getContents: () => `import type { SessionAuthObject } from '@clerk/backend';
declare module 'h3' {
type AuthObjectHandler = (SignedInAuthObject | SignedOutAuthObject) & {
(): SignedInAuthObject | SignedOutAuthObject;
type AuthObjectHandler = SessionAuthObject & {
(): SessionAuthObject;
Comment on lines +112 to +115

@wobsorianowobsorianoJun 16, 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.

SessionAuthObject is a new type introduced in machine auth

see token types

}

interface H3EventContext {
Expand Down
4 changes: 3 additions & 1 deletion packages/nuxt/src/runtime/plugin.ts
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
import { setClerkJsLoadingErrorPackageName } from '@clerk/shared/loadClerkJsScript';
import type { InitialState } from '@clerk/types';
import { clerkPlugin } from '@clerk/vue';
import { setErrorThrowerOptions } from '@clerk/vue/internal';
import { defineNuxtPlugin, navigateTo, useRuntimeConfig, useState } from 'nuxt/app';
Expand All@@ -8,14 +9,15 @@ setClerkJsLoadingErrorPackageName(PACKAGE_NAME);

export default defineNuxtPlugin(nuxtApp => {
// SSR-friendly shared state
const initialState = useState('clerk-initial-state', () => undefined);
const initialState = useState<InitialState | undefined>('clerk-initial-state', () => undefined);

if (import.meta.server) {
// Save the initial state from server and pass it to the plugin
initialState.value = nuxtApp.ssrContext?.event.context.__clerk_initial_state;
}

const runtimeConfig = useRuntimeConfig();

nuxtApp.vueApp.use(clerkPlugin, {
...(runtimeConfig.public.clerk ?? {}),
sdkMetadata: {
Expand Down
6 changes: 3 additions & 3 deletions packages/vue/package.json
Original file line numberDiff line numberDiff line change
Expand Up@@ -62,10 +62,10 @@
},
"devDependencies": {
"@testing-library/vue": "^8.1.0",
"@vitejs/plugin-vue": "^5.2.3",
"@vitejs/plugin-vue": "^5.2.4",
"@vue.ts/tsx-auto-props": "^0.6.0",
"unplugin-vue": "^5.2.1",
"vue": "3.5.13",
"unplugin-vue": "^6.2.0",
"vue": "3.5.16",
"vue-tsc": "^2.2.10"
},
"peerDependencies": {
Expand Down
8 changes: 5 additions & 3 deletions packages/vue/src/plugin.ts
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,16 @@
import { inBrowser } from '@clerk/shared/browser';
import { deriveState } from '@clerk/shared/deriveState';
import { loadClerkJsScript, type LoadClerkJsScriptOptions } from '@clerk/shared/loadClerkJsScript';
import type { Clerk, ClientResource, MultiDomainAndOrProxy, Resources, Without } from '@clerk/types';
import type { Clerk, ClientResource, InitialState, MultiDomainAndOrProxy, Resources, Without } from '@clerk/types';
import type { Plugin } from 'vue';
import { computed, ref, shallowRef, triggerRef } from 'vue';

import { ClerkInjectionKey } from './keys';

export type PluginOptions = Without<LoadClerkJsScriptOptions, 'domain' | 'proxyUrl'> & MultiDomainAndOrProxy;
export type PluginOptions = Without<LoadClerkJsScriptOptions, 'domain' | 'proxyUrl'> &
MultiDomainAndOrProxy & {
initialState?: InitialState;
};
Comment on lines +10 to +13

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.

🛠️ Refactor suggestion

initialState leaks into loadClerkJsScript options

pluginOptions now carries initialState, but a few lines below we cast the full object to LoadClerkJsScriptOptions and forward it to loadClerkJsScript:

constoptions={
...pluginOptions,sdkMetadata: pluginOptions.sdkMetadata||SDK_METADATA,}asLoadClerkJsScriptOptions;

loadClerkJsScript has no concept of initialState; the extra key is silently ignored today but future strict‐mode checks (or external libs doing Object.keys) might fail.

A minimal, type-safe guard:

-const options = {- ...pluginOptions,- sdkMetadata: pluginOptions.sdkMetadata || SDK_METADATA,-} as LoadClerkJsScriptOptions;+const { initialState, ...loadOptions } = pluginOptions;+const options: LoadClerkJsScriptOptions = {+ ...loadOptions,+ sdkMetadata: loadOptions.sdkMetadata || SDK_METADATA,+};

Keeps runtime payload clean and removes the need for the as cast.

🤖 Prompt for AI Agents
In packages/vue/src/plugin.ts around lines 10 to 13, the PluginOptions type
includes an initialState property that is not part of LoadClerkJsScriptOptions
but is being cast and passed to loadClerkJsScript, causing a type leak. To fix
this, explicitly separate initialState from pluginOptions before passing options
to loadClerkJsScript, ensuring only valid LoadClerkJsScriptOptions keys are
forwarded. Remove the type assertion cast and construct the options object
without initialState to keep the runtime payload clean and maintain type safety.


const SDK_METADATA = {
name: PACKAGE_NAME,
Expand DownExpand Up@@ -35,7 +38,6 @@ const SDK_METADATA = {
*/
export const clerkPlugin: Plugin<[PluginOptions]> = {
install(app, pluginOptions) {
// @ts-expect-error: Internal property for SSR frameworks like Nuxt
const { initialState } = pluginOptions;

const loaded = shallowRef(false);
Expand Down
Loading
, '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
Merged
6 changes: 6 additions & 0 deletions .changeset/tame-poems-impress.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
---
"@clerk/nuxt": patch
"@clerk/vue": patch
---

Make `initialState` prop public and bump `@nuxt/kit` to 3.17.5
24 changes: 16 additions & 8 deletions packages/nextjs/src/__tests__/webhooks.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -10,16 +10,22 @@ const mockSuccessResponse = {
object: 'event',
} as any;

const mockError = new Error('Missing required Svix headers: svix-id, svix-timestamp, svix-signature');

vi.mock('@clerk/backend/webhooks', () => ({
verifyWebhook: vi.fn().mockImplementation((request: Request) => {
const svixId = request.headers.get('svix-id');
const svixTimestamp = request.headers.get('svix-timestamp');
const svixSignature = request.headers.get('svix-signature');
verifyWebhook: vi.fn().mockImplementation(async (request: any) => {
// Support both Fetch API Request and plain object
const getHeader = (key: string) => {
if (request instanceof Request) {
return request.headers.get(key);
}
return request.headers?.[key];
};

const svixId = getHeader('svix-id');
const svixTimestamp = getHeader('svix-timestamp');
const svixSignature = getHeader('svix-signature');

if (!svixId || !svixTimestamp || !svixSignature) {
throw mockError;
throw new Error('Missing required Svix headers: svix-id, svix-timestamp, svix-signature');
}

return mockSuccessResponse;
Expand DownExpand Up@@ -88,7 +94,9 @@ describe('verifyWebhook', () => {
aborted: false,
} as unknown as NextApiRequest;

await expect(verifyWebhook(mockNextApiRequest)).rejects.toThrow(mockError);
await expect(verifyWebhook(mockNextApiRequest)).rejects.toThrow(
'Missing required Svix headers: svix-id, svix-timestamp, svix-signature',
);
});
});
});
8 changes: 4 additions & 4 deletions packages/nuxt/package.json
Original file line numberDiff line numberDiff line change
Expand Up@@ -71,12 +71,12 @@
"@clerk/shared": "workspace:^",
"@clerk/types": "workspace:^",
"@clerk/vue": "workspace:^",
"@nuxt/kit": "^3.16.2",
"@nuxt/schema": "^3.16.2",
"h3": "^1.15.1"
"@nuxt/kit": "^3.17.5",
"@nuxt/schema": "^3.17.5",
"h3": "^1.15.3"
},
"devDependencies": {
"nuxt": "^3.16.2",
"nuxt": "^3.17.5",
"typescript": "catalog:repo"
},
"engines": {
Expand Down
1 change: 1 addition & 0 deletions packages/nuxt/src/global.d.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -11,6 +11,7 @@ declare module 'nuxt/schema' {
clerk: {
secretKey?: string;
jwtKey?: string;
webhookSigningSecret?: string;
};
}
interface PublicRuntimeConfig {
Expand Down
11 changes: 7 additions & 4 deletions packages/nuxt/src/module.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -12,7 +12,10 @@ import {
updateRuntimeConfig,
} from '@nuxt/kit';

export type ModuleOptions = Without<PluginOptions, 'routerPush' | 'routerReplace' | 'publishableKey'> & {
export type ModuleOptions = Without<
PluginOptions,
'routerPush' | 'routerReplace' | 'publishableKey' | 'initialState'
> & {
publishableKey?: string;
/**
* Skip the automatic server middleware registration. When enabled, you'll need to
Expand DownExpand Up@@ -106,10 +109,10 @@ export default defineNuxtModule<ModuleOptions>({
addTypeTemplate(
{
filename: 'types/clerk.d.ts',
getContents: () => `import type { SignedInAuthObject, SignedOutAuthObject } from '@clerk/backend/internal';
getContents: () => `import type { SessionAuthObject } from '@clerk/backend';
declare module 'h3' {
type AuthObjectHandler = (SignedInAuthObject | SignedOutAuthObject) & {
(): SignedInAuthObject | SignedOutAuthObject;
type AuthObjectHandler = SessionAuthObject & {
(): SessionAuthObject;
Comment on lines +112 to +115

@wobsorianowobsorianoJun 16, 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.

SessionAuthObject is a new type introduced in machine auth

see token types

}

interface H3EventContext {
Expand Down
4 changes: 3 additions & 1 deletion packages/nuxt/src/runtime/plugin.ts
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
import { setClerkJsLoadingErrorPackageName } from '@clerk/shared/loadClerkJsScript';
import type { InitialState } from '@clerk/types';
import { clerkPlugin } from '@clerk/vue';
import { setErrorThrowerOptions } from '@clerk/vue/internal';
import { defineNuxtPlugin, navigateTo, useRuntimeConfig, useState } from 'nuxt/app';
Expand All@@ -8,14 +9,15 @@ setClerkJsLoadingErrorPackageName(PACKAGE_NAME);

export default defineNuxtPlugin(nuxtApp => {
// SSR-friendly shared state
const initialState = useState('clerk-initial-state', () => undefined);
const initialState = useState<InitialState | undefined>('clerk-initial-state', () => undefined);

if (import.meta.server) {
// Save the initial state from server and pass it to the plugin
initialState.value = nuxtApp.ssrContext?.event.context.__clerk_initial_state;
}

const runtimeConfig = useRuntimeConfig();

nuxtApp.vueApp.use(clerkPlugin, {
...(runtimeConfig.public.clerk ?? {}),
sdkMetadata: {
Expand Down
6 changes: 3 additions & 3 deletions packages/vue/package.json
Original file line numberDiff line numberDiff line change
Expand Up@@ -62,10 +62,10 @@
},
"devDependencies": {
"@testing-library/vue": "^8.1.0",
"@vitejs/plugin-vue": "^5.2.3",
"@vitejs/plugin-vue": "^5.2.4",
"@vue.ts/tsx-auto-props": "^0.6.0",
"unplugin-vue": "^5.2.1",
"vue": "3.5.13",
"unplugin-vue": "^6.2.0",
"vue": "3.5.16",
"vue-tsc": "^2.2.10"
},
"peerDependencies": {
Expand Down
8 changes: 5 additions & 3 deletions packages/vue/src/plugin.ts
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,16 @@
import { inBrowser } from '@clerk/shared/browser';
import { deriveState } from '@clerk/shared/deriveState';
import { loadClerkJsScript, type LoadClerkJsScriptOptions } from '@clerk/shared/loadClerkJsScript';
import type { Clerk, ClientResource, MultiDomainAndOrProxy, Resources, Without } from '@clerk/types';
import type { Clerk, ClientResource, InitialState, MultiDomainAndOrProxy, Resources, Without } from '@clerk/types';
import type { Plugin } from 'vue';
import { computed, ref, shallowRef, triggerRef } from 'vue';

import { ClerkInjectionKey } from './keys';

export type PluginOptions = Without<LoadClerkJsScriptOptions, 'domain' | 'proxyUrl'> & MultiDomainAndOrProxy;
export type PluginOptions = Without<LoadClerkJsScriptOptions, 'domain' | 'proxyUrl'> &
MultiDomainAndOrProxy & {
initialState?: InitialState;
};
Comment on lines +10 to +13

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.

🛠️ Refactor suggestion

initialState leaks into loadClerkJsScript options

pluginOptions now carries initialState, but a few lines below we cast the full object to LoadClerkJsScriptOptions and forward it to loadClerkJsScript:

constoptions={
...pluginOptions,sdkMetadata: pluginOptions.sdkMetadata||SDK_METADATA,}asLoadClerkJsScriptOptions;

loadClerkJsScript has no concept of initialState; the extra key is silently ignored today but future strict‐mode checks (or external libs doing Object.keys) might fail.

A minimal, type-safe guard:

-const options = {- ...pluginOptions,- sdkMetadata: pluginOptions.sdkMetadata || SDK_METADATA,-} as LoadClerkJsScriptOptions;+const { initialState, ...loadOptions } = pluginOptions;+const options: LoadClerkJsScriptOptions = {+ ...loadOptions,+ sdkMetadata: loadOptions.sdkMetadata || SDK_METADATA,+};

Keeps runtime payload clean and removes the need for the as cast.

🤖 Prompt for AI Agents
In packages/vue/src/plugin.ts around lines 10 to 13, the PluginOptions type
includes an initialState property that is not part of LoadClerkJsScriptOptions
but is being cast and passed to loadClerkJsScript, causing a type leak. To fix
this, explicitly separate initialState from pluginOptions before passing options
to loadClerkJsScript, ensuring only valid LoadClerkJsScriptOptions keys are
forwarded. Remove the type assertion cast and construct the options object
without initialState to keep the runtime payload clean and maintain type safety.


const SDK_METADATA = {
name: PACKAGE_NAME,
Expand DownExpand Up@@ -35,7 +38,6 @@ const SDK_METADATA = {
*/
export const clerkPlugin: Plugin<[PluginOptions]> = {
install(app, pluginOptions) {
// @ts-expect-error: Internal property for SSR frameworks like Nuxt
const { initialState } = pluginOptions;

const loaded = shallowRef(false);
Expand Down
Loading
, '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
Merged
6 changes: 6 additions & 0 deletions .changeset/tame-poems-impress.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
---
"@clerk/nuxt": patch
"@clerk/vue": patch
---

Make `initialState` prop public and bump `@nuxt/kit` to 3.17.5
24 changes: 16 additions & 8 deletions packages/nextjs/src/__tests__/webhooks.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -10,16 +10,22 @@ const mockSuccessResponse = {
object: 'event',
} as any;

const mockError = new Error('Missing required Svix headers: svix-id, svix-timestamp, svix-signature');

vi.mock('@clerk/backend/webhooks', () => ({
verifyWebhook: vi.fn().mockImplementation((request: Request) => {
const svixId = request.headers.get('svix-id');
const svixTimestamp = request.headers.get('svix-timestamp');
const svixSignature = request.headers.get('svix-signature');
verifyWebhook: vi.fn().mockImplementation(async (request: any) => {
// Support both Fetch API Request and plain object
const getHeader = (key: string) => {
if (request instanceof Request) {
return request.headers.get(key);
}
return request.headers?.[key];
};

const svixId = getHeader('svix-id');
const svixTimestamp = getHeader('svix-timestamp');
const svixSignature = getHeader('svix-signature');

if (!svixId || !svixTimestamp || !svixSignature) {
throw mockError;
throw new Error('Missing required Svix headers: svix-id, svix-timestamp, svix-signature');
}

return mockSuccessResponse;
Expand DownExpand Up@@ -88,7 +94,9 @@ describe('verifyWebhook', () => {
aborted: false,
} as unknown as NextApiRequest;

await expect(verifyWebhook(mockNextApiRequest)).rejects.toThrow(mockError);
await expect(verifyWebhook(mockNextApiRequest)).rejects.toThrow(
'Missing required Svix headers: svix-id, svix-timestamp, svix-signature',
);
});
});
});
8 changes: 4 additions & 4 deletions packages/nuxt/package.json
Original file line numberDiff line numberDiff line change
Expand Up@@ -71,12 +71,12 @@
"@clerk/shared": "workspace:^",
"@clerk/types": "workspace:^",
"@clerk/vue": "workspace:^",
"@nuxt/kit": "^3.16.2",
"@nuxt/schema": "^3.16.2",
"h3": "^1.15.1"
"@nuxt/kit": "^3.17.5",
"@nuxt/schema": "^3.17.5",
"h3": "^1.15.3"
},
"devDependencies": {
"nuxt": "^3.16.2",
"nuxt": "^3.17.5",
"typescript": "catalog:repo"
},
"engines": {
Expand Down
1 change: 1 addition & 0 deletions packages/nuxt/src/global.d.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -11,6 +11,7 @@ declare module 'nuxt/schema' {
clerk: {
secretKey?: string;
jwtKey?: string;
webhookSigningSecret?: string;
};
}
interface PublicRuntimeConfig {
Expand Down
11 changes: 7 additions & 4 deletions packages/nuxt/src/module.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -12,7 +12,10 @@ import {
updateRuntimeConfig,
} from '@nuxt/kit';

export type ModuleOptions = Without<PluginOptions, 'routerPush' | 'routerReplace' | 'publishableKey'> & {
export type ModuleOptions = Without<
PluginOptions,
'routerPush' | 'routerReplace' | 'publishableKey' | 'initialState'
> & {
publishableKey?: string;
/**
* Skip the automatic server middleware registration. When enabled, you'll need to
Expand DownExpand Up@@ -106,10 +109,10 @@ export default defineNuxtModule<ModuleOptions>({
addTypeTemplate(
{
filename: 'types/clerk.d.ts',
getContents: () => `import type { SignedInAuthObject, SignedOutAuthObject } from '@clerk/backend/internal';
getContents: () => `import type { SessionAuthObject } from '@clerk/backend';
declare module 'h3' {
type AuthObjectHandler = (SignedInAuthObject | SignedOutAuthObject) & {
(): SignedInAuthObject | SignedOutAuthObject;
type AuthObjectHandler = SessionAuthObject & {
(): SessionAuthObject;
Comment on lines +112 to +115

@wobsorianowobsorianoJun 16, 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.

SessionAuthObject is a new type introduced in machine auth

see token types

}

interface H3EventContext {
Expand Down
4 changes: 3 additions & 1 deletion packages/nuxt/src/runtime/plugin.ts
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
import { setClerkJsLoadingErrorPackageName } from '@clerk/shared/loadClerkJsScript';
import type { InitialState } from '@clerk/types';
import { clerkPlugin } from '@clerk/vue';
import { setErrorThrowerOptions } from '@clerk/vue/internal';
import { defineNuxtPlugin, navigateTo, useRuntimeConfig, useState } from 'nuxt/app';
Expand All@@ -8,14 +9,15 @@ setClerkJsLoadingErrorPackageName(PACKAGE_NAME);

export default defineNuxtPlugin(nuxtApp => {
// SSR-friendly shared state
const initialState = useState('clerk-initial-state', () => undefined);
const initialState = useState<InitialState | undefined>('clerk-initial-state', () => undefined);

if (import.meta.server) {
// Save the initial state from server and pass it to the plugin
initialState.value = nuxtApp.ssrContext?.event.context.__clerk_initial_state;
}

const runtimeConfig = useRuntimeConfig();

nuxtApp.vueApp.use(clerkPlugin, {
...(runtimeConfig.public.clerk ?? {}),
sdkMetadata: {
Expand Down
6 changes: 3 additions & 3 deletions packages/vue/package.json
Original file line numberDiff line numberDiff line change
Expand Up@@ -62,10 +62,10 @@
},
"devDependencies": {
"@testing-library/vue": "^8.1.0",
"@vitejs/plugin-vue": "^5.2.3",
"@vitejs/plugin-vue": "^5.2.4",
"@vue.ts/tsx-auto-props": "^0.6.0",
"unplugin-vue": "^5.2.1",
"vue": "3.5.13",
"unplugin-vue": "^6.2.0",
"vue": "3.5.16",
"vue-tsc": "^2.2.10"
},
"peerDependencies": {
Expand Down
8 changes: 5 additions & 3 deletions packages/vue/src/plugin.ts
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,16 @@
import { inBrowser } from '@clerk/shared/browser';
import { deriveState } from '@clerk/shared/deriveState';
import { loadClerkJsScript, type LoadClerkJsScriptOptions } from '@clerk/shared/loadClerkJsScript';
import type { Clerk, ClientResource, MultiDomainAndOrProxy, Resources, Without } from '@clerk/types';
import type { Clerk, ClientResource, InitialState, MultiDomainAndOrProxy, Resources, Without } from '@clerk/types';
import type { Plugin } from 'vue';
import { computed, ref, shallowRef, triggerRef } from 'vue';

import { ClerkInjectionKey } from './keys';

export type PluginOptions = Without<LoadClerkJsScriptOptions, 'domain' | 'proxyUrl'> & MultiDomainAndOrProxy;
export type PluginOptions = Without<LoadClerkJsScriptOptions, 'domain' | 'proxyUrl'> &
MultiDomainAndOrProxy & {
initialState?: InitialState;
};
Comment on lines +10 to +13

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.

🛠️ Refactor suggestion

initialState leaks into loadClerkJsScript options

pluginOptions now carries initialState, but a few lines below we cast the full object to LoadClerkJsScriptOptions and forward it to loadClerkJsScript:

constoptions={
...pluginOptions,sdkMetadata: pluginOptions.sdkMetadata||SDK_METADATA,}asLoadClerkJsScriptOptions;

loadClerkJsScript has no concept of initialState; the extra key is silently ignored today but future strict‐mode checks (or external libs doing Object.keys) might fail.

A minimal, type-safe guard:

-const options = {- ...pluginOptions,- sdkMetadata: pluginOptions.sdkMetadata || SDK_METADATA,-} as LoadClerkJsScriptOptions;+const { initialState, ...loadOptions } = pluginOptions;+const options: LoadClerkJsScriptOptions = {+ ...loadOptions,+ sdkMetadata: loadOptions.sdkMetadata || SDK_METADATA,+};

Keeps runtime payload clean and removes the need for the as cast.

🤖 Prompt for AI Agents
In packages/vue/src/plugin.ts around lines 10 to 13, the PluginOptions type
includes an initialState property that is not part of LoadClerkJsScriptOptions
but is being cast and passed to loadClerkJsScript, causing a type leak. To fix
this, explicitly separate initialState from pluginOptions before passing options
to loadClerkJsScript, ensuring only valid LoadClerkJsScriptOptions keys are
forwarded. Remove the type assertion cast and construct the options object
without initialState to keep the runtime payload clean and maintain type safety.


const SDK_METADATA = {
name: PACKAGE_NAME,
Expand DownExpand Up@@ -35,7 +38,6 @@ const SDK_METADATA = {
*/
export const clerkPlugin: Plugin<[PluginOptions]> = {
install(app, pluginOptions) {
// @ts-expect-error: Internal property for SSR frameworks like Nuxt
const { initialState } = pluginOptions;

const loaded = shallowRef(false);
Expand Down
Loading