Skip to content

feat(hono): Add Frontend API proxy support#7988

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
brkalow wants to merge 3 commits into from
Closed

feat(hono): Add Frontend API proxy support #7988

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
4c631cd
feat(hono): Add Frontend API proxy support to clerkMiddleware
brkalow Mar 5, 2026
5500d54
chore: Add changeset for hono Frontend API proxy
brkalow Mar 5, 2026
f2af2b8
Apply suggestion from @brkalow
brkalow Mar 5, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/bright-planes-proxy.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
"@clerk/hono": minor
---

Add Frontend API proxy support to `clerkMiddleware` via the new `frontendApiProxy` option, enabling request forwarding to Clerk's Frontend API.
110 changes: 110 additions & 0 deletions packages/hono/src/__tests__/clerkMiddleware.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
import { clerkFrontendApiProxy } from '@clerk/backend/proxy';
import { Hono } from 'hono';

import { clerkMiddleware, getAuth } from '../index';
Expand DownExpand Up@@ -31,6 +32,16 @@ vi.mock(import('@clerk/backend'), async importOriginal => {
};
});

vi.mock(import('@clerk/backend/proxy'), async importOriginal => {
const original = await importOriginal();
return {
...original,
clerkFrontendApiProxy: vi.fn().mockResolvedValue(new Response('proxy-response', { status: 200 })),
};
});

const mockClerkFrontendApiProxy = vi.mocked(clerkFrontendApiProxy);

describe('clerkMiddleware()', () => {
beforeEach(() => {
vi.stubEnv('CLERK_SECRET_KEY', EnvVariables.CLERK_SECRET_KEY);
Expand DownExpand Up@@ -161,6 +172,105 @@ describe('clerkMiddleware()', () => {

expect(response.status).toEqual(500);
});

describe('frontendApiProxy', () => {
beforeEach(() => {
mockClerkFrontendApiProxy.mockReset();
mockClerkFrontendApiProxy.mockResolvedValue(new Response('proxy-response', { status: 200 }));
});

test('proxies requests to the default proxy path when enabled', async () => {
const app = new Hono();
app.use('*', clerkMiddleware({ frontendApiProxy: { enabled: true } }));
app.get('/', c => c.json({ ok: true }));

const response = await app.request(new Request('http://localhost/__clerk/v1/client'));

expect(response.status).toEqual(200);
expect(await response.text()).toEqual('proxy-response');
expect(mockClerkFrontendApiProxy).toHaveBeenCalled();
expect(authenticateRequestMock).not.toHaveBeenCalled();
});

test('proxies requests to custom proxy path', async () => {
const app = new Hono();
app.use('*', clerkMiddleware({ frontendApiProxy: { enabled: true, path: '/custom-proxy' } }));
app.get('/', c => c.json({ ok: true }));

const response = await app.request(new Request('http://localhost/custom-proxy/v1/client'));

expect(response.status).toEqual(200);
expect(mockClerkFrontendApiProxy).toHaveBeenCalled();
});

test('does not proxy when enabled is false', async () => {
authenticateRequestMock.mockResolvedValueOnce({
headers: new Headers(),
toAuth: createMockSessionAuth,
});
const app = new Hono();
app.use('*', clerkMiddleware({ frontendApiProxy: { enabled: false } }));
app.get('/__clerk/v1/client', c => c.json({ ok: true }));

const response = await app.request(new Request('http://localhost/__clerk/v1/client'));

expect(response.status).toEqual(200);
expect(mockClerkFrontendApiProxy).not.toHaveBeenCalled();
expect(authenticateRequestMock).toHaveBeenCalled();
});

test('does not proxy non-matching paths', async () => {
authenticateRequestMock.mockResolvedValueOnce({
headers: new Headers(),
toAuth: createMockSessionAuth,
});
const app = new Hono();
app.use('*', clerkMiddleware({ frontendApiProxy: { enabled: true } }));
app.get('/api/users', c => c.json({ ok: true }));

const response = await app.request(new Request('http://localhost/api/users'));

expect(response.status).toEqual(200);
expect(mockClerkFrontendApiProxy).not.toHaveBeenCalled();
expect(authenticateRequestMock).toHaveBeenCalled();
});

test('supports enabled as a function', async () => {
authenticateRequestMock.mockResolvedValueOnce({
headers: new Headers(),
toAuth: createMockSessionAuth,
});
const enabledFn = vi.fn().mockReturnValue(false);
const app = new Hono();
app.use('*', clerkMiddleware({ frontendApiProxy: { enabled: enabledFn } }));
app.get('/__clerk/v1/client', c => c.json({ ok: true }));

const response = await app.request(new Request('http://localhost/__clerk/v1/client'));

expect(response.status).toEqual(200);
expect(enabledFn).toHaveBeenCalledWith(expect.any(URL));
expect(mockClerkFrontendApiProxy).not.toHaveBeenCalled();
});

test('auto-derives proxyUrl for authenticateRequest when frontendApiProxy is enabled', async () => {
authenticateRequestMock.mockResolvedValueOnce({
headers: new Headers(),
toAuth: createMockSessionAuth,
});
const app = new Hono();
app.use('*', clerkMiddleware({ frontendApiProxy: { enabled: true } }));
app.get('/api/users', c => c.json({ ok: true }));

await app.request(new Request('http://localhost/api/users'));

expect(authenticateRequestMock).toHaveBeenCalledWith(
expect.any(Request),
expect.objectContaining({
proxyUrl: 'http://localhost/__clerk',
}),
);
});
});
});

describe('getAuth()', () => {
Expand Down
56 changes: 48 additions & 8 deletions packages/hono/src/clerkMiddleware.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,17 +2,26 @@ import type { AuthObject } from '@clerk/backend';
import { createClerkClient } from '@clerk/backend';
import type { AuthenticateRequestOptions, AuthOptions, GetAuthFnNoRequest } from '@clerk/backend/internal';
import { getAuthObjectForAcceptedToken } from '@clerk/backend/internal';
import { clerkFrontendApiProxy, DEFAULT_PROXY_PATH, matchProxyPath } from '@clerk/backend/proxy';
import type { MiddlewareHandler } from 'hono';
import { env } from 'hono/adapter';

import type { FrontendApiProxyOptions } from './types';

type ClerkEnv = {
CLERK_SECRET_KEY: string;
CLERK_PUBLISHABLE_KEY: string;
CLERK_API_URL?: string;
CLERK_API_VERSION?: string;
};

export type ClerkMiddlewareOptions = Omit<AuthenticateRequestOptions, 'acceptsToken'>;
export type ClerkMiddlewareOptions = Omit<AuthenticateRequestOptions, 'acceptsToken'> & {
/**
* When set, enables the middleware to proxy Frontend API requests to Clerk.
* This is useful when direct communication with Clerk's API is blocked.
*/
frontendApiProxy?: FrontendApiProxyOptions;
};

/**
* Clerk middleware for Hono that authenticates requests and attaches
Expand All@@ -35,12 +44,14 @@ export type ClerkMiddlewareOptions = Omit<AuthenticateRequestOptions, 'acceptsTo
export const clerkMiddleware = (options?: ClerkMiddlewareOptions): MiddlewareHandler => {
return async (c, next) => {
const clerkEnv = env<ClerkEnv>(c);
const { secretKey, publishableKey, apiUrl, apiVersion, ...rest } = options || {
secretKey: clerkEnv.CLERK_SECRET_KEY || '',
publishableKey: clerkEnv.CLERK_PUBLISHABLE_KEY || '',
apiUrl: clerkEnv.CLERK_API_URL,
apiVersion: clerkEnv.CLERK_API_VERSION,
};
const {
secretKey = clerkEnv.CLERK_SECRET_KEY || '',
publishableKey = clerkEnv.CLERK_PUBLISHABLE_KEY || '',
apiUrl = clerkEnv.CLERK_API_URL,
apiVersion = clerkEnv.CLERK_API_VERSION,
frontendApiProxy,
...rest
} = options || {};

if (!secretKey) {
throw new Error(
Expand All@@ -54,6 +65,22 @@ export const clerkMiddleware = (options?: ClerkMiddlewareOptions): MiddlewareHan
);
}

// Handle Frontend API proxy requests early, before authentication
if (frontendApiProxy) {
const { enabled, path: proxyPath = DEFAULT_PROXY_PATH } = frontendApiProxy;

const requestUrl = new URL(c.req.url);
const isEnabled = typeof enabled === 'function' ? enabled(requestUrl) : enabled;

if (isEnabled && matchProxyPath(c.req.raw, { proxyPath })) {
return clerkFrontendApiProxy(c.req.raw, {
proxyPath,
publishableKey,
secretKey,
});
}
}

const clerkClient = createClerkClient({
...rest,
apiUrl,
Expand All@@ -63,8 +90,21 @@ export const clerkMiddleware = (options?: ClerkMiddlewareOptions): MiddlewareHan
userAgent: `${PACKAGE_NAME}@${PACKAGE_VERSION}`,
});

// Auto-derive proxyUrl from frontendApiProxy config if not explicitly set
let authenticateOptions: typeof rest & { proxyUrl?: string } = rest;
if (frontendApiProxy && !rest.proxyUrl) {
const { enabled, path: proxyPath = DEFAULT_PROXY_PATH } = frontendApiProxy;
const requestUrl = new URL(c.req.url);
const isEnabled = typeof enabled === 'function' ? enabled(requestUrl) : enabled;

if (isEnabled) {
const derivedProxyUrl = `${requestUrl.origin}${proxyPath}`;
authenticateOptions = { ...rest, proxyUrl: derivedProxyUrl };
}
}

const requestState = await clerkClient.authenticateRequest(c.req.raw, {
...rest,
...authenticateOptions,
secretKey,
publishableKey,
acceptsToken: 'any',
Expand Down
4 changes: 2 additions & 2 deletions packages/hono/src/index.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -3,8 +3,8 @@ export type { ClerkMiddlewareOptions } from './clerkMiddleware';

export { getAuth } from './getAuth';

import type { ClerkHonoVariables } from './types';
export type { ClerkHonoVariables };
import type { ClerkHonoVariables, FrontendApiProxyOptions } from './types';
export type { ClerkHonoVariables, FrontendApiProxyOptions };

// Augment Hono's ContextVariableMap so users get type inference
// for c.get('clerk') and c.get('clerkAuth')
Expand Down
18 changes: 18 additions & 0 deletions packages/hono/src/types.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
import type { ClerkClient } from '@clerk/backend';
import type { GetAuthFnNoRequest } from '@clerk/backend/internal';
import type { ShouldProxyFn } from '@clerk/shared/proxy';

/**
* Variables that clerkMiddleware sets on the Hono context.
Expand All@@ -9,3 +10,20 @@ export type ClerkHonoVariables = {
clerk: ClerkClient;
clerkAuth: GetAuthFnNoRequest;
};

/**
* Options for configuring Frontend API proxy in clerkMiddleware
*/
export interface FrontendApiProxyOptions {
/**
* Enable proxy handling. Can be:
* - `true` - enable for all domains
* - `false` - disable for all domains
* - A function: (url: URL) => boolean - enable based on the request URL
*/
enabled: boolean | ShouldProxyFn;
/**
* The path prefix for proxy requests. Defaults to `/__clerk`.
*/
path?: string;
}
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Add copy buttons to all 
 blocks
(function() {
function addCopyButtons() {
document.querySelectorAll('pre code').forEach(function(codeBlock) {
if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;
codeBlock.parentElement.setAttribute('data-copy-added', 'true');
var btn = document.createElement('button');
btn.textContent = 'Copy';
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;';
btn.onmouseover = function() { this.style.opacity = '1'; };
btn.onmouseout = function() { this.style.opacity = '0.7'; };
btn.onclick = function() {
navigator.clipboard.writeText(codeBlock.textContent).then(function() {
btn.textContent = 'Copied!';
setTimeout(function() { btn.textContent = 'Copy'; }, 1500);
});
};
codeBlock.parentElement.style.position = 'relative';
codeBlock.parentElement.appendChild(btn);
});
}
addCopyButtons();
// Re-run on dynamic content
var observer = new MutationObserver(addCopyButtons);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
feat(hono): Add Frontend API proxy support by brkalow · Pull Request #7988 · clerk/javascript · GitHub
Skip to content
feat(hono): Add Frontend API proxy support#7988

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Closed

brkalow
wants to merge
3
commits into

from

 Closed


feat(hono): Add Frontend API proxy support
#7988
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
4c631cd

feat(hono): Add Frontend API proxy support to clerkMiddleware


brkalow Mar 5, 2026
5500d54

chore: Add changeset for hono Frontend API proxy


brkalow Mar 5, 2026
f2af2b8

Apply suggestion from @brkalow


brkalow Mar 5, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


5 changes: 5 additions & 0 deletions
.changeset/bright-planes-proxy.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
"@clerk/hono": minor
---

Add Frontend API proxy support to `clerkMiddleware` via the new `frontendApiProxy` option, enabling request forwarding to Clerk's Frontend API.

110 changes: 110 additions & 0 deletions
packages/hono/src/__tests__/clerkMiddleware.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
import { clerkFrontendApiProxy } from '@clerk/backend/proxy';
import { Hono } from 'hono';

import { clerkMiddleware, getAuth } from '../index';
Expand DownExpand Up@@ -31,6 +32,16 @@ vi.mock(import('@clerk/backend'), async importOriginal => {
 };
});

vi.mock(import('@clerk/backend/proxy'), async importOriginal => {
 const original = await importOriginal();
 return {
 ...original,
 clerkFrontendApiProxy: vi.fn().mockResolvedValue(new Response('proxy-response', { status: 200 })),
 };
});

const mockClerkFrontendApiProxy = vi.mocked(clerkFrontendApiProxy);

describe('clerkMiddleware()', () => {
 beforeEach(() => {
 vi.stubEnv('CLERK_SECRET_KEY', EnvVariables.CLERK_SECRET_KEY);
Expand DownExpand Up@@ -161,6 +172,105 @@ describe('clerkMiddleware()', () => {

 expect(response.status).toEqual(500);
 });

 describe('frontendApiProxy', () => {
 beforeEach(() => {
 mockClerkFrontendApiProxy.mockReset();
 mockClerkFrontendApiProxy.mockResolvedValue(new Response('proxy-response', { status: 200 }));
 });

 test('proxies requests to the default proxy path when enabled', async () => {
 const app = new Hono();
 app.use('*', clerkMiddleware({ frontendApiProxy: { enabled: true } }));
 app.get('/', c => c.json({ ok: true }));

 const response = await app.request(new Request('http://localhost/__clerk/v1/client'));

 expect(response.status).toEqual(200);
 expect(await response.text()).toEqual('proxy-response');
 expect(mockClerkFrontendApiProxy).toHaveBeenCalled();
 expect(authenticateRequestMock).not.toHaveBeenCalled();
 });

 test('proxies requests to custom proxy path', async () => {
 const app = new Hono();
 app.use('*', clerkMiddleware({ frontendApiProxy: { enabled: true, path: '/custom-proxy' } }));
 app.get('/', c => c.json({ ok: true }));

 const response = await app.request(new Request('http://localhost/custom-proxy/v1/client'));

 expect(response.status).toEqual(200);
 expect(mockClerkFrontendApiProxy).toHaveBeenCalled();
 });

 test('does not proxy when enabled is false', async () => {
 authenticateRequestMock.mockResolvedValueOnce({
 headers: new Headers(),
 toAuth: createMockSessionAuth,
 });
 const app = new Hono();
 app.use('*', clerkMiddleware({ frontendApiProxy: { enabled: false } }));
 app.get('/__clerk/v1/client', c => c.json({ ok: true }));

 const response = await app.request(new Request('http://localhost/__clerk/v1/client'));

 expect(response.status).toEqual(200);
 expect(mockClerkFrontendApiProxy).not.toHaveBeenCalled();
 expect(authenticateRequestMock).toHaveBeenCalled();
 });

 test('does not proxy non-matching paths', async () => {
 authenticateRequestMock.mockResolvedValueOnce({
 headers: new Headers(),
 toAuth: createMockSessionAuth,
 });
 const app = new Hono();
 app.use('*', clerkMiddleware({ frontendApiProxy: { enabled: true } }));
 app.get('/api/users', c => c.json({ ok: true }));

 const response = await app.request(new Request('http://localhost/api/users'));

 expect(response.status).toEqual(200);
 expect(mockClerkFrontendApiProxy).not.toHaveBeenCalled();
 expect(authenticateRequestMock).toHaveBeenCalled();
 });

 test('supports enabled as a function', async () => {
 authenticateRequestMock.mockResolvedValueOnce({
 headers: new Headers(),
 toAuth: createMockSessionAuth,
 });
 const enabledFn = vi.fn().mockReturnValue(false);
 const app = new Hono();
 app.use('*', clerkMiddleware({ frontendApiProxy: { enabled: enabledFn } }));
 app.get('/__clerk/v1/client', c => c.json({ ok: true }));

 const response = await app.request(new Request('http://localhost/__clerk/v1/client'));

 expect(response.status).toEqual(200);
 expect(enabledFn).toHaveBeenCalledWith(expect.any(URL));
 expect(mockClerkFrontendApiProxy).not.toHaveBeenCalled();
 });

 test('auto-derives proxyUrl for authenticateRequest when frontendApiProxy is enabled', async () => {
 authenticateRequestMock.mockResolvedValueOnce({
 headers: new Headers(),
 toAuth: createMockSessionAuth,
 });
 const app = new Hono();
 app.use('*', clerkMiddleware({ frontendApiProxy: { enabled: true } }));
 app.get('/api/users', c => c.json({ ok: true }));

 await app.request(new Request('http://localhost/api/users'));

 expect(authenticateRequestMock).toHaveBeenCalledWith(
 expect.any(Request),
 expect.objectContaining({
 proxyUrl: 'http://localhost/__clerk',
 }),
 );
 });
 });
});

describe('getAuth()', () => {
Expand Down

56 changes: 48 additions & 8 deletions
packages/hono/src/clerkMiddleware.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,17 +2,26 @@ import type { AuthObject } from '@clerk/backend';
import { createClerkClient } from '@clerk/backend';
import type { AuthenticateRequestOptions, AuthOptions, GetAuthFnNoRequest } from '@clerk/backend/internal';
import { getAuthObjectForAcceptedToken } from '@clerk/backend/internal';
import { clerkFrontendApiProxy, DEFAULT_PROXY_PATH, matchProxyPath } from '@clerk/backend/proxy';
import type { MiddlewareHandler } from 'hono';
import { env } from 'hono/adapter';

import type { FrontendApiProxyOptions } from './types';

type ClerkEnv = {
 CLERK_SECRET_KEY: string;
 CLERK_PUBLISHABLE_KEY: string;
 CLERK_API_URL?: string;
 CLERK_API_VERSION?: string;
};

export type ClerkMiddlewareOptions = Omit<AuthenticateRequestOptions, 'acceptsToken'>;
export type ClerkMiddlewareOptions = Omit<AuthenticateRequestOptions, 'acceptsToken'> & {
 /**
 * When set, enables the middleware to proxy Frontend API requests to Clerk.
 * This is useful when direct communication with Clerk's API is blocked.
 */
 frontendApiProxy?: FrontendApiProxyOptions;
};

/**
 * Clerk middleware for Hono that authenticates requests and attaches
Expand All@@ -35,12 +44,14 @@ export type ClerkMiddlewareOptions = Omit<AuthenticateRequestOptions, 'acceptsTo
export const clerkMiddleware = (options?: ClerkMiddlewareOptions): MiddlewareHandler => {
 return async (c, next) => {
 const clerkEnv = env<ClerkEnv>(c);
 const { secretKey, publishableKey, apiUrl, apiVersion, ...rest } = options || {
 secretKey: clerkEnv.CLERK_SECRET_KEY || '',
 publishableKey: clerkEnv.CLERK_PUBLISHABLE_KEY || '',
 apiUrl: clerkEnv.CLERK_API_URL,
 apiVersion: clerkEnv.CLERK_API_VERSION,
 };
 const {
 secretKey = clerkEnv.CLERK_SECRET_KEY || '',
 publishableKey = clerkEnv.CLERK_PUBLISHABLE_KEY || '',
 apiUrl = clerkEnv.CLERK_API_URL,
 apiVersion = clerkEnv.CLERK_API_VERSION,
 frontendApiProxy,
 ...rest
 } = options || {};

 if (!secretKey) {
 throw new Error(
Expand All@@ -54,6 +65,22 @@ export const clerkMiddleware = (options?: ClerkMiddlewareOptions): MiddlewareHan
 );
 }

 // Handle Frontend API proxy requests early, before authentication
 if (frontendApiProxy) {
 const { enabled, path: proxyPath = DEFAULT_PROXY_PATH } = frontendApiProxy;

 const requestUrl = new URL(c.req.url);
 const isEnabled = typeof enabled === 'function' ? enabled(requestUrl) : enabled;

 if (isEnabled && matchProxyPath(c.req.raw, { proxyPath })) {
 return clerkFrontendApiProxy(c.req.raw, {
 proxyPath,
 publishableKey,
 secretKey,
 });
 }
 }

 const clerkClient = createClerkClient({
 ...rest,
 apiUrl,
Expand All@@ -63,8 +90,21 @@ export const clerkMiddleware = (options?: ClerkMiddlewareOptions): MiddlewareHan
 userAgent: `${PACKAGE_NAME}@${PACKAGE_VERSION}`,
 });

 // Auto-derive proxyUrl from frontendApiProxy config if not explicitly set
 let authenticateOptions: typeof rest & { proxyUrl?: string } = rest;
 if (frontendApiProxy && !rest.proxyUrl) {
 const { enabled, path: proxyPath = DEFAULT_PROXY_PATH } = frontendApiProxy;
 const requestUrl = new URL(c.req.url);
 const isEnabled = typeof enabled === 'function' ? enabled(requestUrl) : enabled;

 if (isEnabled) {
 const derivedProxyUrl = `${requestUrl.origin}${proxyPath}`;
 authenticateOptions = { ...rest, proxyUrl: derivedProxyUrl };
 }
 }

 const requestState = await clerkClient.authenticateRequest(c.req.raw, {
 ...rest,
 ...authenticateOptions,
 secretKey,
 publishableKey,
 acceptsToken: 'any',
Expand Down

4 changes: 2 additions & 2 deletions
packages/hono/src/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,8 +3,8 @@ export type { ClerkMiddlewareOptions } from './clerkMiddleware';

export { getAuth } from './getAuth';

import type { ClerkHonoVariables } from './types';
export type { ClerkHonoVariables };
import type { ClerkHonoVariables, FrontendApiProxyOptions } from './types';
export type { ClerkHonoVariables, FrontendApiProxyOptions };

// Augment Hono's ContextVariableMap so users get type inference
// for c.get('clerk') and c.get('clerkAuth')
Expand Down

18 changes: 18 additions & 0 deletions
packages/hono/src/types.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
import type { ClerkClient } from '@clerk/backend';
import type { GetAuthFnNoRequest } from '@clerk/backend/internal';
import type { ShouldProxyFn } from '@clerk/shared/proxy';

/**
 * Variables that clerkMiddleware sets on the Hono context.
Expand All@@ -9,3 +10,20 @@ export type ClerkHonoVariables = {
 clerk: ClerkClient;
 clerkAuth: GetAuthFnNoRequest;
};

/**
 * Options for configuring Frontend API proxy in clerkMiddleware
 */
export interface FrontendApiProxyOptions {
 /**
 * Enable proxy handling. Can be:
 * - `true` - enable for all domains
 * - `false` - disable for all domains
 * - A function: (url: URL) => boolean - enable based on the request URL
 */
 enabled: boolean | ShouldProxyFn;
 /**
 * The path prefix for proxy requests. Defaults to `/__clerk`.
 */
 path?: string;
}
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Force GitHub README to respect dark mode
(function() {
var style = document.createElement('style');
style.textContent = '
.markdown-body {
color-scheme: dark light;
}
.markdown-body pre { background: #161b22 !important; }
.markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }
.markdown-body table th, .markdown-body table td { border-color: #30363d !important; }
.markdown-body img { background: #0d1117; }
.markdown-body blockquote { border-left-color: #8b949e; }
.markdown-body hr { border-color: #30363d; }
';
document.head.appendChild(style);
})();
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
feat(hono): Add Frontend API proxy support by brkalow · Pull Request #7988 · clerk/javascript · GitHub
Skip to content
feat(hono): Add Frontend API proxy support#7988

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Closed

brkalow
wants to merge
3
commits into

from

 Closed


feat(hono): Add Frontend API proxy support
#7988
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
4c631cd

feat(hono): Add Frontend API proxy support to clerkMiddleware


brkalow Mar 5, 2026
5500d54

chore: Add changeset for hono Frontend API proxy


brkalow Mar 5, 2026
f2af2b8

Apply suggestion from @brkalow


brkalow Mar 5, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


5 changes: 5 additions & 0 deletions
.changeset/bright-planes-proxy.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
"@clerk/hono": minor
---

Add Frontend API proxy support to `clerkMiddleware` via the new `frontendApiProxy` option, enabling request forwarding to Clerk's Frontend API.

110 changes: 110 additions & 0 deletions
packages/hono/src/__tests__/clerkMiddleware.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
import { clerkFrontendApiProxy } from '@clerk/backend/proxy';
import { Hono } from 'hono';

import { clerkMiddleware, getAuth } from '../index';
Expand DownExpand Up@@ -31,6 +32,16 @@ vi.mock(import('@clerk/backend'), async importOriginal => {
 };
});

vi.mock(import('@clerk/backend/proxy'), async importOriginal => {
 const original = await importOriginal();
 return {
 ...original,
 clerkFrontendApiProxy: vi.fn().mockResolvedValue(new Response('proxy-response', { status: 200 })),
 };
});

const mockClerkFrontendApiProxy = vi.mocked(clerkFrontendApiProxy);

describe('clerkMiddleware()', () => {
 beforeEach(() => {
 vi.stubEnv('CLERK_SECRET_KEY', EnvVariables.CLERK_SECRET_KEY);
Expand DownExpand Up@@ -161,6 +172,105 @@ describe('clerkMiddleware()', () => {

 expect(response.status).toEqual(500);
 });

 describe('frontendApiProxy', () => {
 beforeEach(() => {
 mockClerkFrontendApiProxy.mockReset();
 mockClerkFrontendApiProxy.mockResolvedValue(new Response('proxy-response', { status: 200 }));
 });

 test('proxies requests to the default proxy path when enabled', async () => {
 const app = new Hono();
 app.use('*', clerkMiddleware({ frontendApiProxy: { enabled: true } }));
 app.get('/', c => c.json({ ok: true }));

 const response = await app.request(new Request('http://localhost/__clerk/v1/client'));

 expect(response.status).toEqual(200);
 expect(await response.text()).toEqual('proxy-response');
 expect(mockClerkFrontendApiProxy).toHaveBeenCalled();
 expect(authenticateRequestMock).not.toHaveBeenCalled();
 });

 test('proxies requests to custom proxy path', async () => {
 const app = new Hono();
 app.use('*', clerkMiddleware({ frontendApiProxy: { enabled: true, path: '/custom-proxy' } }));
 app.get('/', c => c.json({ ok: true }));

 const response = await app.request(new Request('http://localhost/custom-proxy/v1/client'));

 expect(response.status).toEqual(200);
 expect(mockClerkFrontendApiProxy).toHaveBeenCalled();
 });

 test('does not proxy when enabled is false', async () => {
 authenticateRequestMock.mockResolvedValueOnce({
 headers: new Headers(),
 toAuth: createMockSessionAuth,
 });
 const app = new Hono();
 app.use('*', clerkMiddleware({ frontendApiProxy: { enabled: false } }));
 app.get('/__clerk/v1/client', c => c.json({ ok: true }));

 const response = await app.request(new Request('http://localhost/__clerk/v1/client'));

 expect(response.status).toEqual(200);
 expect(mockClerkFrontendApiProxy).not.toHaveBeenCalled();
 expect(authenticateRequestMock).toHaveBeenCalled();
 });

 test('does not proxy non-matching paths', async () => {
 authenticateRequestMock.mockResolvedValueOnce({
 headers: new Headers(),
 toAuth: createMockSessionAuth,
 });
 const app = new Hono();
 app.use('*', clerkMiddleware({ frontendApiProxy: { enabled: true } }));
 app.get('/api/users', c => c.json({ ok: true }));

 const response = await app.request(new Request('http://localhost/api/users'));

 expect(response.status).toEqual(200);
 expect(mockClerkFrontendApiProxy).not.toHaveBeenCalled();
 expect(authenticateRequestMock).toHaveBeenCalled();
 });

 test('supports enabled as a function', async () => {
 authenticateRequestMock.mockResolvedValueOnce({
 headers: new Headers(),
 toAuth: createMockSessionAuth,
 });
 const enabledFn = vi.fn().mockReturnValue(false);
 const app = new Hono();
 app.use('*', clerkMiddleware({ frontendApiProxy: { enabled: enabledFn } }));
 app.get('/__clerk/v1/client', c => c.json({ ok: true }));

 const response = await app.request(new Request('http://localhost/__clerk/v1/client'));

 expect(response.status).toEqual(200);
 expect(enabledFn).toHaveBeenCalledWith(expect.any(URL));
 expect(mockClerkFrontendApiProxy).not.toHaveBeenCalled();
 });

 test('auto-derives proxyUrl for authenticateRequest when frontendApiProxy is enabled', async () => {
 authenticateRequestMock.mockResolvedValueOnce({
 headers: new Headers(),
 toAuth: createMockSessionAuth,
 });
 const app = new Hono();
 app.use('*', clerkMiddleware({ frontendApiProxy: { enabled: true } }));
 app.get('/api/users', c => c.json({ ok: true }));

 await app.request(new Request('http://localhost/api/users'));

 expect(authenticateRequestMock).toHaveBeenCalledWith(
 expect.any(Request),
 expect.objectContaining({
 proxyUrl: 'http://localhost/__clerk',
 }),
 );
 });
 });
});

describe('getAuth()', () => {
Expand Down

56 changes: 48 additions & 8 deletions
packages/hono/src/clerkMiddleware.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,17 +2,26 @@ import type { AuthObject } from '@clerk/backend';
import { createClerkClient } from '@clerk/backend';
import type { AuthenticateRequestOptions, AuthOptions, GetAuthFnNoRequest } from '@clerk/backend/internal';
import { getAuthObjectForAcceptedToken } from '@clerk/backend/internal';
import { clerkFrontendApiProxy, DEFAULT_PROXY_PATH, matchProxyPath } from '@clerk/backend/proxy';
import type { MiddlewareHandler } from 'hono';
import { env } from 'hono/adapter';

import type { FrontendApiProxyOptions } from './types';

type ClerkEnv = {
 CLERK_SECRET_KEY: string;
 CLERK_PUBLISHABLE_KEY: string;
 CLERK_API_URL?: string;
 CLERK_API_VERSION?: string;
};

export type ClerkMiddlewareOptions = Omit<AuthenticateRequestOptions, 'acceptsToken'>;
export type ClerkMiddlewareOptions = Omit<AuthenticateRequestOptions, 'acceptsToken'> & {
 /**
 * When set, enables the middleware to proxy Frontend API requests to Clerk.
 * This is useful when direct communication with Clerk's API is blocked.
 */
 frontendApiProxy?: FrontendApiProxyOptions;
};

/**
 * Clerk middleware for Hono that authenticates requests and attaches
Expand All@@ -35,12 +44,14 @@ export type ClerkMiddlewareOptions = Omit<AuthenticateRequestOptions, 'acceptsTo
export const clerkMiddleware = (options?: ClerkMiddlewareOptions): MiddlewareHandler => {
 return async (c, next) => {
 const clerkEnv = env<ClerkEnv>(c);
 const { secretKey, publishableKey, apiUrl, apiVersion, ...rest } = options || {
 secretKey: clerkEnv.CLERK_SECRET_KEY || '',
 publishableKey: clerkEnv.CLERK_PUBLISHABLE_KEY || '',
 apiUrl: clerkEnv.CLERK_API_URL,
 apiVersion: clerkEnv.CLERK_API_VERSION,
 };
 const {
 secretKey = clerkEnv.CLERK_SECRET_KEY || '',
 publishableKey = clerkEnv.CLERK_PUBLISHABLE_KEY || '',
 apiUrl = clerkEnv.CLERK_API_URL,
 apiVersion = clerkEnv.CLERK_API_VERSION,
 frontendApiProxy,
 ...rest
 } = options || {};

 if (!secretKey) {
 throw new Error(
Expand All@@ -54,6 +65,22 @@ export const clerkMiddleware = (options?: ClerkMiddlewareOptions): MiddlewareHan
 );
 }

 // Handle Frontend API proxy requests early, before authentication
 if (frontendApiProxy) {
 const { enabled, path: proxyPath = DEFAULT_PROXY_PATH } = frontendApiProxy;

 const requestUrl = new URL(c.req.url);
 const isEnabled = typeof enabled === 'function' ? enabled(requestUrl) : enabled;

 if (isEnabled && matchProxyPath(c.req.raw, { proxyPath })) {
 return clerkFrontendApiProxy(c.req.raw, {
 proxyPath,
 publishableKey,
 secretKey,
 });
 }
 }

 const clerkClient = createClerkClient({
 ...rest,
 apiUrl,
Expand All@@ -63,8 +90,21 @@ export const clerkMiddleware = (options?: ClerkMiddlewareOptions): MiddlewareHan
 userAgent: `${PACKAGE_NAME}@${PACKAGE_VERSION}`,
 });

 // Auto-derive proxyUrl from frontendApiProxy config if not explicitly set
 let authenticateOptions: typeof rest & { proxyUrl?: string } = rest;
 if (frontendApiProxy && !rest.proxyUrl) {
 const { enabled, path: proxyPath = DEFAULT_PROXY_PATH } = frontendApiProxy;
 const requestUrl = new URL(c.req.url);
 const isEnabled = typeof enabled === 'function' ? enabled(requestUrl) : enabled;

 if (isEnabled) {
 const derivedProxyUrl = `${requestUrl.origin}${proxyPath}`;
 authenticateOptions = { ...rest, proxyUrl: derivedProxyUrl };
 }
 }

 const requestState = await clerkClient.authenticateRequest(c.req.raw, {
 ...rest,
 ...authenticateOptions,
 secretKey,
 publishableKey,
 acceptsToken: 'any',
Expand Down

4 changes: 2 additions & 2 deletions
packages/hono/src/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,8 +3,8 @@ export type { ClerkMiddlewareOptions } from './clerkMiddleware';

export { getAuth } from './getAuth';

import type { ClerkHonoVariables } from './types';
export type { ClerkHonoVariables };
import type { ClerkHonoVariables, FrontendApiProxyOptions } from './types';
export type { ClerkHonoVariables, FrontendApiProxyOptions };

// Augment Hono's ContextVariableMap so users get type inference
// for c.get('clerk') and c.get('clerkAuth')
Expand Down

18 changes: 18 additions & 0 deletions
packages/hono/src/types.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
import type { ClerkClient } from '@clerk/backend';
import type { GetAuthFnNoRequest } from '@clerk/backend/internal';
import type { ShouldProxyFn } from '@clerk/shared/proxy';

/**
 * Variables that clerkMiddleware sets on the Hono context.
Expand All@@ -9,3 +10,20 @@ export type ClerkHonoVariables = {
 clerk: ClerkClient;
 clerkAuth: GetAuthFnNoRequest;
};

/**
 * Options for configuring Frontend API proxy in clerkMiddleware
 */
export interface FrontendApiProxyOptions {
 /**
 * Enable proxy handling. Can be:
 * - `true` - enable for all domains
 * - `false` - disable for all domains
 * - A function: (url: URL) => boolean - enable based on the request URL
 */
 enabled: boolean | ShouldProxyFn;
 /**
 * The path prefix for proxy requests. Defaults to `/__clerk`.
 */
 path?: string;
}
Loading

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Closed

brkalow
wants to merge
3
commits into

from

 Closed


feat(hono): Add Frontend API proxy support
#7988
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
4c631cd

feat(hono): Add Frontend API proxy support to clerkMiddleware


brkalow Mar 5, 2026
5500d54

chore: Add changeset for hono Frontend API proxy


brkalow Mar 5, 2026
f2af2b8

Apply suggestion from @brkalow


brkalow Mar 5, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


5 changes: 5 additions & 0 deletions
.changeset/bright-planes-proxy.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
"@clerk/hono": minor
---

Add Frontend API proxy support to `clerkMiddleware` via the new `frontendApiProxy` option, enabling request forwarding to Clerk's Frontend API.

110 changes: 110 additions & 0 deletions
packages/hono/src/__tests__/clerkMiddleware.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
import { clerkFrontendApiProxy } from '@clerk/backend/proxy';
import { Hono } from 'hono';

import { clerkMiddleware, getAuth } from '../index';
Expand DownExpand Up@@ -31,6 +32,16 @@ vi.mock(import('@clerk/backend'), async importOriginal => {
 };
});

vi.mock(import('@clerk/backend/proxy'), async importOriginal => {
 const original = await importOriginal();
 return {
 ...original,
 clerkFrontendApiProxy: vi.fn().mockResolvedValue(new Response('proxy-response', { status: 200 })),
 };
});

const mockClerkFrontendApiProxy = vi.mocked(clerkFrontendApiProxy);

describe('clerkMiddleware()', () => {
 beforeEach(() => {
 vi.stubEnv('CLERK_SECRET_KEY', EnvVariables.CLERK_SECRET_KEY);
Expand DownExpand Up@@ -161,6 +172,105 @@ describe('clerkMiddleware()', () => {

 expect(response.status).toEqual(500);
 });

 describe('frontendApiProxy', () => {
 beforeEach(() => {
 mockClerkFrontendApiProxy.mockReset();
 mockClerkFrontendApiProxy.mockResolvedValue(new Response('proxy-response', { status: 200 }));
 });

 test('proxies requests to the default proxy path when enabled', async () => {
 const app = new Hono();
 app.use('*', clerkMiddleware({ frontendApiProxy: { enabled: true } }));
 app.get('/', c => c.json({ ok: true }));

 const response = await app.request(new Request('http://localhost/__clerk/v1/client'));

 expect(response.status).toEqual(200);
 expect(await response.text()).toEqual('proxy-response');
 expect(mockClerkFrontendApiProxy).toHaveBeenCalled();
 expect(authenticateRequestMock).not.toHaveBeenCalled();
 });

 test('proxies requests to custom proxy path', async () => {
 const app = new Hono();
 app.use('*', clerkMiddleware({ frontendApiProxy: { enabled: true, path: '/custom-proxy' } }));
 app.get('/', c => c.json({ ok: true }));

 const response = await app.request(new Request('http://localhost/custom-proxy/v1/client'));

 expect(response.status).toEqual(200);
 expect(mockClerkFrontendApiProxy).toHaveBeenCalled();
 });

 test('does not proxy when enabled is false', async () => {
 authenticateRequestMock.mockResolvedValueOnce({
 headers: new Headers(),
 toAuth: createMockSessionAuth,
 });
 const app = new Hono();
 app.use('*', clerkMiddleware({ frontendApiProxy: { enabled: false } }));
 app.get('/__clerk/v1/client', c => c.json({ ok: true }));

 const response = await app.request(new Request('http://localhost/__clerk/v1/client'));

 expect(response.status).toEqual(200);
 expect(mockClerkFrontendApiProxy).not.toHaveBeenCalled();
 expect(authenticateRequestMock).toHaveBeenCalled();
 });

 test('does not proxy non-matching paths', async () => {
 authenticateRequestMock.mockResolvedValueOnce({
 headers: new Headers(),
 toAuth: createMockSessionAuth,
 });
 const app = new Hono();
 app.use('*', clerkMiddleware({ frontendApiProxy: { enabled: true } }));
 app.get('/api/users', c => c.json({ ok: true }));

 const response = await app.request(new Request('http://localhost/api/users'));

 expect(response.status).toEqual(200);
 expect(mockClerkFrontendApiProxy).not.toHaveBeenCalled();
 expect(authenticateRequestMock).toHaveBeenCalled();
 });

 test('supports enabled as a function', async () => {
 authenticateRequestMock.mockResolvedValueOnce({
 headers: new Headers(),
 toAuth: createMockSessionAuth,
 });
 const enabledFn = vi.fn().mockReturnValue(false);
 const app = new Hono();
 app.use('*', clerkMiddleware({ frontendApiProxy: { enabled: enabledFn } }));
 app.get('/__clerk/v1/client', c => c.json({ ok: true }));

 const response = await app.request(new Request('http://localhost/__clerk/v1/client'));

 expect(response.status).toEqual(200);
 expect(enabledFn).toHaveBeenCalledWith(expect.any(URL));
 expect(mockClerkFrontendApiProxy).not.toHaveBeenCalled();
 });

 test('auto-derives proxyUrl for authenticateRequest when frontendApiProxy is enabled', async () => {
 authenticateRequestMock.mockResolvedValueOnce({
 headers: new Headers(),
 toAuth: createMockSessionAuth,
 });
 const app = new Hono();
 app.use('*', clerkMiddleware({ frontendApiProxy: { enabled: true } }));
 app.get('/api/users', c => c.json({ ok: true }));

 await app.request(new Request('http://localhost/api/users'));

 expect(authenticateRequestMock).toHaveBeenCalledWith(
 expect.any(Request),
 expect.objectContaining({
 proxyUrl: 'http://localhost/__clerk',
 }),
 );
 });
 });
});

describe('getAuth()', () => {
Expand Down

56 changes: 48 additions & 8 deletions
packages/hono/src/clerkMiddleware.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,17 +2,26 @@ import type { AuthObject } from '@clerk/backend';
import { createClerkClient } from '@clerk/backend';
import type { AuthenticateRequestOptions, AuthOptions, GetAuthFnNoRequest } from '@clerk/backend/internal';
import { getAuthObjectForAcceptedToken } from '@clerk/backend/internal';
import { clerkFrontendApiProxy, DEFAULT_PROXY_PATH, matchProxyPath } from '@clerk/backend/proxy';
import type { MiddlewareHandler } from 'hono';
import { env } from 'hono/adapter';

import type { FrontendApiProxyOptions } from './types';

type ClerkEnv = {
 CLERK_SECRET_KEY: string;
 CLERK_PUBLISHABLE_KEY: string;
 CLERK_API_URL?: string;
 CLERK_API_VERSION?: string;
};

export type ClerkMiddlewareOptions = Omit<AuthenticateRequestOptions, 'acceptsToken'>;
export type ClerkMiddlewareOptions = Omit<AuthenticateRequestOptions, 'acceptsToken'> & {
 /**
 * When set, enables the middleware to proxy Frontend API requests to Clerk.
 * This is useful when direct communication with Clerk's API is blocked.
 */
 frontendApiProxy?: FrontendApiProxyOptions;
};

/**
 * Clerk middleware for Hono that authenticates requests and attaches
Expand All@@ -35,12 +44,14 @@ export type ClerkMiddlewareOptions = Omit<AuthenticateRequestOptions, 'acceptsTo
export const clerkMiddleware = (options?: ClerkMiddlewareOptions): MiddlewareHandler => {
 return async (c, next) => {
 const clerkEnv = env<ClerkEnv>(c);
 const { secretKey, publishableKey, apiUrl, apiVersion, ...rest } = options || {
 secretKey: clerkEnv.CLERK_SECRET_KEY || '',
 publishableKey: clerkEnv.CLERK_PUBLISHABLE_KEY || '',
 apiUrl: clerkEnv.CLERK_API_URL,
 apiVersion: clerkEnv.CLERK_API_VERSION,
 };
 const {
 secretKey = clerkEnv.CLERK_SECRET_KEY || '',
 publishableKey = clerkEnv.CLERK_PUBLISHABLE_KEY || '',
 apiUrl = clerkEnv.CLERK_API_URL,
 apiVersion = clerkEnv.CLERK_API_VERSION,
 frontendApiProxy,
 ...rest
 } = options || {};

 if (!secretKey) {
 throw new Error(
Expand All@@ -54,6 +65,22 @@ export const clerkMiddleware = (options?: ClerkMiddlewareOptions): MiddlewareHan
 );
 }

 // Handle Frontend API proxy requests early, before authentication
 if (frontendApiProxy) {
 const { enabled, path: proxyPath = DEFAULT_PROXY_PATH } = frontendApiProxy;

 const requestUrl = new URL(c.req.url);
 const isEnabled = typeof enabled === 'function' ? enabled(requestUrl) : enabled;

 if (isEnabled && matchProxyPath(c.req.raw, { proxyPath })) {
 return clerkFrontendApiProxy(c.req.raw, {
 proxyPath,
 publishableKey,
 secretKey,
 });
 }
 }

 const clerkClient = createClerkClient({
 ...rest,
 apiUrl,
Expand All@@ -63,8 +90,21 @@ export const clerkMiddleware = (options?: ClerkMiddlewareOptions): MiddlewareHan
 userAgent: `${PACKAGE_NAME}@${PACKAGE_VERSION}`,
 });

 // Auto-derive proxyUrl from frontendApiProxy config if not explicitly set
 let authenticateOptions: typeof rest & { proxyUrl?: string } = rest;
 if (frontendApiProxy && !rest.proxyUrl) {
 const { enabled, path: proxyPath = DEFAULT_PROXY_PATH } = frontendApiProxy;
 const requestUrl = new URL(c.req.url);
 const isEnabled = typeof enabled === 'function' ? enabled(requestUrl) : enabled;

 if (isEnabled) {
 const derivedProxyUrl = `${requestUrl.origin}${proxyPath}`;
 authenticateOptions = { ...rest, proxyUrl: derivedProxyUrl };
 }
 }

 const requestState = await clerkClient.authenticateRequest(c.req.raw, {
 ...rest,
 ...authenticateOptions,
 secretKey,
 publishableKey,
 acceptsToken: 'any',
Expand Down

4 changes: 2 additions & 2 deletions
packages/hono/src/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,8 +3,8 @@ export type { ClerkMiddlewareOptions } from './clerkMiddleware';

export { getAuth } from './getAuth';

import type { ClerkHonoVariables } from './types';
export type { ClerkHonoVariables };
import type { ClerkHonoVariables, FrontendApiProxyOptions } from './types';
export type { ClerkHonoVariables, FrontendApiProxyOptions };

// Augment Hono's ContextVariableMap so users get type inference
// for c.get('clerk') and c.get('clerkAuth')
Expand Down

18 changes: 18 additions & 0 deletions
packages/hono/src/types.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
import type { ClerkClient } from '@clerk/backend';
import type { GetAuthFnNoRequest } from '@clerk/backend/internal';
import type { ShouldProxyFn } from '@clerk/shared/proxy';

/**
 * Variables that clerkMiddleware sets on the Hono context.
Expand All@@ -9,3 +10,20 @@ export type ClerkHonoVariables = {
 clerk: ClerkClient;
 clerkAuth: GetAuthFnNoRequest;
};

/**
 * Options for configuring Frontend API proxy in clerkMiddleware
 */
export interface FrontendApiProxyOptions {
 /**
 * Enable proxy handling. Can be:
 * - `true` - enable for all domains
 * - `false` - disable for all domains
 * - A function: (url: URL) => boolean - enable based on the request URL
 */
 enabled: boolean | ShouldProxyFn;
 /**
 * The path prefix for proxy requests. Defaults to `/__clerk`.
 */
 path?: string;
}
Loading

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Closed

brkalow
wants to merge
3
commits into

from

 Closed


feat(hono): Add Frontend API proxy support
#7988
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
4c631cd

feat(hono): Add Frontend API proxy support to clerkMiddleware


brkalow Mar 5, 2026
5500d54

chore: Add changeset for hono Frontend API proxy


brkalow Mar 5, 2026
f2af2b8

Apply suggestion from @brkalow


brkalow Mar 5, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


5 changes: 5 additions & 0 deletions
.changeset/bright-planes-proxy.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
"@clerk/hono": minor
---

Add Frontend API proxy support to `clerkMiddleware` via the new `frontendApiProxy` option, enabling request forwarding to Clerk's Frontend API.

110 changes: 110 additions & 0 deletions
packages/hono/src/__tests__/clerkMiddleware.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
import { clerkFrontendApiProxy } from '@clerk/backend/proxy';
import { Hono } from 'hono';

import { clerkMiddleware, getAuth } from '../index';
Expand DownExpand Up@@ -31,6 +32,16 @@ vi.mock(import('@clerk/backend'), async importOriginal => {
 };
});

vi.mock(import('@clerk/backend/proxy'), async importOriginal => {
 const original = await importOriginal();
 return {
 ...original,
 clerkFrontendApiProxy: vi.fn().mockResolvedValue(new Response('proxy-response', { status: 200 })),
 };
});

const mockClerkFrontendApiProxy = vi.mocked(clerkFrontendApiProxy);

describe('clerkMiddleware()', () => {
 beforeEach(() => {
 vi.stubEnv('CLERK_SECRET_KEY', EnvVariables.CLERK_SECRET_KEY);
Expand DownExpand Up@@ -161,6 +172,105 @@ describe('clerkMiddleware()', () => {

 expect(response.status).toEqual(500);
 });

 describe('frontendApiProxy', () => {
 beforeEach(() => {
 mockClerkFrontendApiProxy.mockReset();
 mockClerkFrontendApiProxy.mockResolvedValue(new Response('proxy-response', { status: 200 }));
 });

 test('proxies requests to the default proxy path when enabled', async () => {
 const app = new Hono();
 app.use('*', clerkMiddleware({ frontendApiProxy: { enabled: true } }));
 app.get('/', c => c.json({ ok: true }));

 const response = await app.request(new Request('http://localhost/__clerk/v1/client'));

 expect(response.status).toEqual(200);
 expect(await response.text()).toEqual('proxy-response');
 expect(mockClerkFrontendApiProxy).toHaveBeenCalled();
 expect(authenticateRequestMock).not.toHaveBeenCalled();
 });

 test('proxies requests to custom proxy path', async () => {
 const app = new Hono();
 app.use('*', clerkMiddleware({ frontendApiProxy: { enabled: true, path: '/custom-proxy' } }));
 app.get('/', c => c.json({ ok: true }));

 const response = await app.request(new Request('http://localhost/custom-proxy/v1/client'));

 expect(response.status).toEqual(200);
 expect(mockClerkFrontendApiProxy).toHaveBeenCalled();
 });

 test('does not proxy when enabled is false', async () => {
 authenticateRequestMock.mockResolvedValueOnce({
 headers: new Headers(),
 toAuth: createMockSessionAuth,
 });
 const app = new Hono();
 app.use('*', clerkMiddleware({ frontendApiProxy: { enabled: false } }));
 app.get('/__clerk/v1/client', c => c.json({ ok: true }));

 const response = await app.request(new Request('http://localhost/__clerk/v1/client'));

 expect(response.status).toEqual(200);
 expect(mockClerkFrontendApiProxy).not.toHaveBeenCalled();
 expect(authenticateRequestMock).toHaveBeenCalled();
 });

 test('does not proxy non-matching paths', async () => {
 authenticateRequestMock.mockResolvedValueOnce({
 headers: new Headers(),
 toAuth: createMockSessionAuth,
 });
 const app = new Hono();
 app.use('*', clerkMiddleware({ frontendApiProxy: { enabled: true } }));
 app.get('/api/users', c => c.json({ ok: true }));

 const response = await app.request(new Request('http://localhost/api/users'));

 expect(response.status).toEqual(200);
 expect(mockClerkFrontendApiProxy).not.toHaveBeenCalled();
 expect(authenticateRequestMock).toHaveBeenCalled();
 });

 test('supports enabled as a function', async () => {
 authenticateRequestMock.mockResolvedValueOnce({
 headers: new Headers(),
 toAuth: createMockSessionAuth,
 });
 const enabledFn = vi.fn().mockReturnValue(false);
 const app = new Hono();
 app.use('*', clerkMiddleware({ frontendApiProxy: { enabled: enabledFn } }));
 app.get('/__clerk/v1/client', c => c.json({ ok: true }));

 const response = await app.request(new Request('http://localhost/__clerk/v1/client'));

 expect(response.status).toEqual(200);
 expect(enabledFn).toHaveBeenCalledWith(expect.any(URL));
 expect(mockClerkFrontendApiProxy).not.toHaveBeenCalled();
 });

 test('auto-derives proxyUrl for authenticateRequest when frontendApiProxy is enabled', async () => {
 authenticateRequestMock.mockResolvedValueOnce({
 headers: new Headers(),
 toAuth: createMockSessionAuth,
 });
 const app = new Hono();
 app.use('*', clerkMiddleware({ frontendApiProxy: { enabled: true } }));
 app.get('/api/users', c => c.json({ ok: true }));

 await app.request(new Request('http://localhost/api/users'));

 expect(authenticateRequestMock).toHaveBeenCalledWith(
 expect.any(Request),
 expect.objectContaining({
 proxyUrl: 'http://localhost/__clerk',
 }),
 );
 });
 });
});

describe('getAuth()', () => {
Expand Down

56 changes: 48 additions & 8 deletions
packages/hono/src/clerkMiddleware.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,17 +2,26 @@ import type { AuthObject } from '@clerk/backend';
import { createClerkClient } from '@clerk/backend';
import type { AuthenticateRequestOptions, AuthOptions, GetAuthFnNoRequest } from '@clerk/backend/internal';
import { getAuthObjectForAcceptedToken } from '@clerk/backend/internal';
import { clerkFrontendApiProxy, DEFAULT_PROXY_PATH, matchProxyPath } from '@clerk/backend/proxy';
import type { MiddlewareHandler } from 'hono';
import { env } from 'hono/adapter';

import type { FrontendApiProxyOptions } from './types';

type ClerkEnv = {
 CLERK_SECRET_KEY: string;
 CLERK_PUBLISHABLE_KEY: string;
 CLERK_API_URL?: string;
 CLERK_API_VERSION?: string;
};

export type ClerkMiddlewareOptions = Omit<AuthenticateRequestOptions, 'acceptsToken'>;
export type ClerkMiddlewareOptions = Omit<AuthenticateRequestOptions, 'acceptsToken'> & {
 /**
 * When set, enables the middleware to proxy Frontend API requests to Clerk.
 * This is useful when direct communication with Clerk's API is blocked.
 */
 frontendApiProxy?: FrontendApiProxyOptions;
};

/**
 * Clerk middleware for Hono that authenticates requests and attaches
Expand All@@ -35,12 +44,14 @@ export type ClerkMiddlewareOptions = Omit<AuthenticateRequestOptions, 'acceptsTo
export const clerkMiddleware = (options?: ClerkMiddlewareOptions): MiddlewareHandler => {
 return async (c, next) => {
 const clerkEnv = env<ClerkEnv>(c);
 const { secretKey, publishableKey, apiUrl, apiVersion, ...rest } = options || {
 secretKey: clerkEnv.CLERK_SECRET_KEY || '',
 publishableKey: clerkEnv.CLERK_PUBLISHABLE_KEY || '',
 apiUrl: clerkEnv.CLERK_API_URL,
 apiVersion: clerkEnv.CLERK_API_VERSION,
 };
 const {
 secretKey = clerkEnv.CLERK_SECRET_KEY || '',
 publishableKey = clerkEnv.CLERK_PUBLISHABLE_KEY || '',
 apiUrl = clerkEnv.CLERK_API_URL,
 apiVersion = clerkEnv.CLERK_API_VERSION,
 frontendApiProxy,
 ...rest
 } = options || {};

 if (!secretKey) {
 throw new Error(
Expand All@@ -54,6 +65,22 @@ export const clerkMiddleware = (options?: ClerkMiddlewareOptions): MiddlewareHan
 );
 }

 // Handle Frontend API proxy requests early, before authentication
 if (frontendApiProxy) {
 const { enabled, path: proxyPath = DEFAULT_PROXY_PATH } = frontendApiProxy;

 const requestUrl = new URL(c.req.url);
 const isEnabled = typeof enabled === 'function' ? enabled(requestUrl) : enabled;

 if (isEnabled && matchProxyPath(c.req.raw, { proxyPath })) {
 return clerkFrontendApiProxy(c.req.raw, {
 proxyPath,
 publishableKey,
 secretKey,
 });
 }
 }

 const clerkClient = createClerkClient({
 ...rest,
 apiUrl,
Expand All@@ -63,8 +90,21 @@ export const clerkMiddleware = (options?: ClerkMiddlewareOptions): MiddlewareHan
 userAgent: `${PACKAGE_NAME}@${PACKAGE_VERSION}`,
 });

 // Auto-derive proxyUrl from frontendApiProxy config if not explicitly set
 let authenticateOptions: typeof rest & { proxyUrl?: string } = rest;
 if (frontendApiProxy && !rest.proxyUrl) {
 const { enabled, path: proxyPath = DEFAULT_PROXY_PATH } = frontendApiProxy;
 const requestUrl = new URL(c.req.url);
 const isEnabled = typeof enabled === 'function' ? enabled(requestUrl) : enabled;

 if (isEnabled) {
 const derivedProxyUrl = `${requestUrl.origin}${proxyPath}`;
 authenticateOptions = { ...rest, proxyUrl: derivedProxyUrl };
 }
 }

 const requestState = await clerkClient.authenticateRequest(c.req.raw, {
 ...rest,
 ...authenticateOptions,
 secretKey,
 publishableKey,
 acceptsToken: 'any',
Expand Down

4 changes: 2 additions & 2 deletions
packages/hono/src/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,8 +3,8 @@ export type { ClerkMiddlewareOptions } from './clerkMiddleware';

export { getAuth } from './getAuth';

import type { ClerkHonoVariables } from './types';
export type { ClerkHonoVariables };
import type { ClerkHonoVariables, FrontendApiProxyOptions } from './types';
export type { ClerkHonoVariables, FrontendApiProxyOptions };

// Augment Hono's ContextVariableMap so users get type inference
// for c.get('clerk') and c.get('clerkAuth')
Expand Down

18 changes: 18 additions & 0 deletions
packages/hono/src/types.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
import type { ClerkClient } from '@clerk/backend';
import type { GetAuthFnNoRequest } from '@clerk/backend/internal';
import type { ShouldProxyFn } from '@clerk/shared/proxy';

/**
 * Variables that clerkMiddleware sets on the Hono context.
Expand All@@ -9,3 +10,20 @@ export type ClerkHonoVariables = {
 clerk: ClerkClient;
 clerkAuth: GetAuthFnNoRequest;
};

/**
 * Options for configuring Frontend API proxy in clerkMiddleware
 */
export interface FrontendApiProxyOptions {
 /**
 * Enable proxy handling. Can be:
 * - `true` - enable for all domains
 * - `false` - disable for all domains
 * - A function: (url: URL) => boolean - enable based on the request URL
 */
 enabled: boolean | ShouldProxyFn;
 /**
 * The path prefix for proxy requests. Defaults to `/__clerk`.
 */
 path?: string;
}
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Auto-enable theater mode on YouTube
(function() {
function tryTheater() {
var btn = document.querySelector('button[aria-label="Theater mode"], ytd-player #player button[title="Theater mode"]');
if (btn && !btn.classList.contains('activated')) {
btn.click();
}
}
// Try immediately
tryTheater();
// Try after navigation (SPA)
var lastUrl = location.href;
setInterval(function() {
if (location.href !== lastUrl) {
lastUrl = location.href;
setTimeout(tryTheater, 500);
}
}, 1000);
// Also try on player load
var observer = new MutationObserver(tryTheater);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
feat(hono): Add Frontend API proxy support by brkalow · Pull Request #7988 · clerk/javascript · GitHub
Skip to content
feat(hono): Add Frontend API proxy support#7988

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Closed

brkalow
wants to merge
3
commits into

from

 Closed


feat(hono): Add Frontend API proxy support
#7988
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
4c631cd

feat(hono): Add Frontend API proxy support to clerkMiddleware


brkalow Mar 5, 2026
5500d54

chore: Add changeset for hono Frontend API proxy


brkalow Mar 5, 2026
f2af2b8

Apply suggestion from @brkalow


brkalow Mar 5, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


5 changes: 5 additions & 0 deletions
.changeset/bright-planes-proxy.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
"@clerk/hono": minor
---

Add Frontend API proxy support to `clerkMiddleware` via the new `frontendApiProxy` option, enabling request forwarding to Clerk's Frontend API.

110 changes: 110 additions & 0 deletions
packages/hono/src/__tests__/clerkMiddleware.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
import { clerkFrontendApiProxy } from '@clerk/backend/proxy';
import { Hono } from 'hono';

import { clerkMiddleware, getAuth } from '../index';
Expand DownExpand Up@@ -31,6 +32,16 @@ vi.mock(import('@clerk/backend'), async importOriginal => {
 };
});

vi.mock(import('@clerk/backend/proxy'), async importOriginal => {
 const original = await importOriginal();
 return {
 ...original,
 clerkFrontendApiProxy: vi.fn().mockResolvedValue(new Response('proxy-response', { status: 200 })),
 };
});

const mockClerkFrontendApiProxy = vi.mocked(clerkFrontendApiProxy);

describe('clerkMiddleware()', () => {
 beforeEach(() => {
 vi.stubEnv('CLERK_SECRET_KEY', EnvVariables.CLERK_SECRET_KEY);
Expand DownExpand Up@@ -161,6 +172,105 @@ describe('clerkMiddleware()', () => {

 expect(response.status).toEqual(500);
 });

 describe('frontendApiProxy', () => {
 beforeEach(() => {
 mockClerkFrontendApiProxy.mockReset();
 mockClerkFrontendApiProxy.mockResolvedValue(new Response('proxy-response', { status: 200 }));
 });

 test('proxies requests to the default proxy path when enabled', async () => {
 const app = new Hono();
 app.use('*', clerkMiddleware({ frontendApiProxy: { enabled: true } }));
 app.get('/', c => c.json({ ok: true }));

 const response = await app.request(new Request('http://localhost/__clerk/v1/client'));

 expect(response.status).toEqual(200);
 expect(await response.text()).toEqual('proxy-response');
 expect(mockClerkFrontendApiProxy).toHaveBeenCalled();
 expect(authenticateRequestMock).not.toHaveBeenCalled();
 });

 test('proxies requests to custom proxy path', async () => {
 const app = new Hono();
 app.use('*', clerkMiddleware({ frontendApiProxy: { enabled: true, path: '/custom-proxy' } }));
 app.get('/', c => c.json({ ok: true }));

 const response = await app.request(new Request('http://localhost/custom-proxy/v1/client'));

 expect(response.status).toEqual(200);
 expect(mockClerkFrontendApiProxy).toHaveBeenCalled();
 });

 test('does not proxy when enabled is false', async () => {
 authenticateRequestMock.mockResolvedValueOnce({
 headers: new Headers(),
 toAuth: createMockSessionAuth,
 });
 const app = new Hono();
 app.use('*', clerkMiddleware({ frontendApiProxy: { enabled: false } }));
 app.get('/__clerk/v1/client', c => c.json({ ok: true }));

 const response = await app.request(new Request('http://localhost/__clerk/v1/client'));

 expect(response.status).toEqual(200);
 expect(mockClerkFrontendApiProxy).not.toHaveBeenCalled();
 expect(authenticateRequestMock).toHaveBeenCalled();
 });

 test('does not proxy non-matching paths', async () => {
 authenticateRequestMock.mockResolvedValueOnce({
 headers: new Headers(),
 toAuth: createMockSessionAuth,
 });
 const app = new Hono();
 app.use('*', clerkMiddleware({ frontendApiProxy: { enabled: true } }));
 app.get('/api/users', c => c.json({ ok: true }));

 const response = await app.request(new Request('http://localhost/api/users'));

 expect(response.status).toEqual(200);
 expect(mockClerkFrontendApiProxy).not.toHaveBeenCalled();
 expect(authenticateRequestMock).toHaveBeenCalled();
 });

 test('supports enabled as a function', async () => {
 authenticateRequestMock.mockResolvedValueOnce({
 headers: new Headers(),
 toAuth: createMockSessionAuth,
 });
 const enabledFn = vi.fn().mockReturnValue(false);
 const app = new Hono();
 app.use('*', clerkMiddleware({ frontendApiProxy: { enabled: enabledFn } }));
 app.get('/__clerk/v1/client', c => c.json({ ok: true }));

 const response = await app.request(new Request('http://localhost/__clerk/v1/client'));

 expect(response.status).toEqual(200);
 expect(enabledFn).toHaveBeenCalledWith(expect.any(URL));
 expect(mockClerkFrontendApiProxy).not.toHaveBeenCalled();
 });

 test('auto-derives proxyUrl for authenticateRequest when frontendApiProxy is enabled', async () => {
 authenticateRequestMock.mockResolvedValueOnce({
 headers: new Headers(),
 toAuth: createMockSessionAuth,
 });
 const app = new Hono();
 app.use('*', clerkMiddleware({ frontendApiProxy: { enabled: true } }));
 app.get('/api/users', c => c.json({ ok: true }));

 await app.request(new Request('http://localhost/api/users'));

 expect(authenticateRequestMock).toHaveBeenCalledWith(
 expect.any(Request),
 expect.objectContaining({
 proxyUrl: 'http://localhost/__clerk',
 }),
 );
 });
 });
});

describe('getAuth()', () => {
Expand Down

56 changes: 48 additions & 8 deletions
packages/hono/src/clerkMiddleware.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,17 +2,26 @@ import type { AuthObject } from '@clerk/backend';
import { createClerkClient } from '@clerk/backend';
import type { AuthenticateRequestOptions, AuthOptions, GetAuthFnNoRequest } from '@clerk/backend/internal';
import { getAuthObjectForAcceptedToken } from '@clerk/backend/internal';
import { clerkFrontendApiProxy, DEFAULT_PROXY_PATH, matchProxyPath } from '@clerk/backend/proxy';
import type { MiddlewareHandler } from 'hono';
import { env } from 'hono/adapter';

import type { FrontendApiProxyOptions } from './types';

type ClerkEnv = {
 CLERK_SECRET_KEY: string;
 CLERK_PUBLISHABLE_KEY: string;
 CLERK_API_URL?: string;
 CLERK_API_VERSION?: string;
};

export type ClerkMiddlewareOptions = Omit<AuthenticateRequestOptions, 'acceptsToken'>;
export type ClerkMiddlewareOptions = Omit<AuthenticateRequestOptions, 'acceptsToken'> & {
 /**
 * When set, enables the middleware to proxy Frontend API requests to Clerk.
 * This is useful when direct communication with Clerk's API is blocked.
 */
 frontendApiProxy?: FrontendApiProxyOptions;
};

/**
 * Clerk middleware for Hono that authenticates requests and attaches
Expand All@@ -35,12 +44,14 @@ export type ClerkMiddlewareOptions = Omit<AuthenticateRequestOptions, 'acceptsTo
export const clerkMiddleware = (options?: ClerkMiddlewareOptions): MiddlewareHandler => {
 return async (c, next) => {
 const clerkEnv = env<ClerkEnv>(c);
 const { secretKey, publishableKey, apiUrl, apiVersion, ...rest } = options || {
 secretKey: clerkEnv.CLERK_SECRET_KEY || '',
 publishableKey: clerkEnv.CLERK_PUBLISHABLE_KEY || '',
 apiUrl: clerkEnv.CLERK_API_URL,
 apiVersion: clerkEnv.CLERK_API_VERSION,
 };
 const {
 secretKey = clerkEnv.CLERK_SECRET_KEY || '',
 publishableKey = clerkEnv.CLERK_PUBLISHABLE_KEY || '',
 apiUrl = clerkEnv.CLERK_API_URL,
 apiVersion = clerkEnv.CLERK_API_VERSION,
 frontendApiProxy,
 ...rest
 } = options || {};

 if (!secretKey) {
 throw new Error(
Expand All@@ -54,6 +65,22 @@ export const clerkMiddleware = (options?: ClerkMiddlewareOptions): MiddlewareHan
 );
 }

 // Handle Frontend API proxy requests early, before authentication
 if (frontendApiProxy) {
 const { enabled, path: proxyPath = DEFAULT_PROXY_PATH } = frontendApiProxy;

 const requestUrl = new URL(c.req.url);
 const isEnabled = typeof enabled === 'function' ? enabled(requestUrl) : enabled;

 if (isEnabled && matchProxyPath(c.req.raw, { proxyPath })) {
 return clerkFrontendApiProxy(c.req.raw, {
 proxyPath,
 publishableKey,
 secretKey,
 });
 }
 }

 const clerkClient = createClerkClient({
 ...rest,
 apiUrl,
Expand All@@ -63,8 +90,21 @@ export const clerkMiddleware = (options?: ClerkMiddlewareOptions): MiddlewareHan
 userAgent: `${PACKAGE_NAME}@${PACKAGE_VERSION}`,
 });

 // Auto-derive proxyUrl from frontendApiProxy config if not explicitly set
 let authenticateOptions: typeof rest & { proxyUrl?: string } = rest;
 if (frontendApiProxy && !rest.proxyUrl) {
 const { enabled, path: proxyPath = DEFAULT_PROXY_PATH } = frontendApiProxy;
 const requestUrl = new URL(c.req.url);
 const isEnabled = typeof enabled === 'function' ? enabled(requestUrl) : enabled;

 if (isEnabled) {
 const derivedProxyUrl = `${requestUrl.origin}${proxyPath}`;
 authenticateOptions = { ...rest, proxyUrl: derivedProxyUrl };
 }
 }

 const requestState = await clerkClient.authenticateRequest(c.req.raw, {
 ...rest,
 ...authenticateOptions,
 secretKey,
 publishableKey,
 acceptsToken: 'any',
Expand Down

4 changes: 2 additions & 2 deletions
packages/hono/src/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,8 +3,8 @@ export type { ClerkMiddlewareOptions } from './clerkMiddleware';

export { getAuth } from './getAuth';

import type { ClerkHonoVariables } from './types';
export type { ClerkHonoVariables };
import type { ClerkHonoVariables, FrontendApiProxyOptions } from './types';
export type { ClerkHonoVariables, FrontendApiProxyOptions };

// Augment Hono's ContextVariableMap so users get type inference
// for c.get('clerk') and c.get('clerkAuth')
Expand Down

18 changes: 18 additions & 0 deletions
packages/hono/src/types.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
import type { ClerkClient } from '@clerk/backend';
import type { GetAuthFnNoRequest } from '@clerk/backend/internal';
import type { ShouldProxyFn } from '@clerk/shared/proxy';

/**
 * Variables that clerkMiddleware sets on the Hono context.
Expand All@@ -9,3 +10,20 @@ export type ClerkHonoVariables = {
 clerk: ClerkClient;
 clerkAuth: GetAuthFnNoRequest;
};

/**
 * Options for configuring Frontend API proxy in clerkMiddleware
 */
export interface FrontendApiProxyOptions {
 /**
 * Enable proxy handling. Can be:
 * - `true` - enable for all domains
 * - `false` - disable for all domains
 * - A function: (url: URL) => boolean - enable based on the request URL
 */
 enabled: boolean | ShouldProxyFn;
 /**
 * The path prefix for proxy requests. Defaults to `/__clerk`.
 */
 path?: string;
}
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Remove or un-stick sticky/fixed headers that block content
(function() {
function unstick() {
document.querySelectorAll('header, nav, [role="banner"], .header, .navbar, .sticky, .fixed-top, [style*="position: fixed"], [style*="position:sticky"]').forEach(function(el) {
if (el.style.position === 'fixed' || el.style.position === 'sticky' || getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {
el.style.position = 'static';
el.style.top = 'auto';
el.style.zIndex = 'auto';
}
});
}
unstick();
var observer = new MutationObserver(unstick);
observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });
})();
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
feat(hono): Add Frontend API proxy support by brkalow · Pull Request #7988 · clerk/javascript · GitHub
Skip to content
feat(hono): Add Frontend API proxy support#7988

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Closed

brkalow
wants to merge
3
commits into

from

 Closed


feat(hono): Add Frontend API proxy support
#7988
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
4c631cd

feat(hono): Add Frontend API proxy support to clerkMiddleware


brkalow Mar 5, 2026
5500d54

chore: Add changeset for hono Frontend API proxy


brkalow Mar 5, 2026
f2af2b8

Apply suggestion from @brkalow


brkalow Mar 5, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


5 changes: 5 additions & 0 deletions
.changeset/bright-planes-proxy.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
"@clerk/hono": minor
---

Add Frontend API proxy support to `clerkMiddleware` via the new `frontendApiProxy` option, enabling request forwarding to Clerk's Frontend API.

110 changes: 110 additions & 0 deletions
packages/hono/src/__tests__/clerkMiddleware.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
import { clerkFrontendApiProxy } from '@clerk/backend/proxy';
import { Hono } from 'hono';

import { clerkMiddleware, getAuth } from '../index';
Expand DownExpand Up@@ -31,6 +32,16 @@ vi.mock(import('@clerk/backend'), async importOriginal => {
 };
});

vi.mock(import('@clerk/backend/proxy'), async importOriginal => {
 const original = await importOriginal();
 return {
 ...original,
 clerkFrontendApiProxy: vi.fn().mockResolvedValue(new Response('proxy-response', { status: 200 })),
 };
});

const mockClerkFrontendApiProxy = vi.mocked(clerkFrontendApiProxy);

describe('clerkMiddleware()', () => {
 beforeEach(() => {
 vi.stubEnv('CLERK_SECRET_KEY', EnvVariables.CLERK_SECRET_KEY);
Expand DownExpand Up@@ -161,6 +172,105 @@ describe('clerkMiddleware()', () => {

 expect(response.status).toEqual(500);
 });

 describe('frontendApiProxy', () => {
 beforeEach(() => {
 mockClerkFrontendApiProxy.mockReset();
 mockClerkFrontendApiProxy.mockResolvedValue(new Response('proxy-response', { status: 200 }));
 });

 test('proxies requests to the default proxy path when enabled', async () => {
 const app = new Hono();
 app.use('*', clerkMiddleware({ frontendApiProxy: { enabled: true } }));
 app.get('/', c => c.json({ ok: true }));

 const response = await app.request(new Request('http://localhost/__clerk/v1/client'));

 expect(response.status).toEqual(200);
 expect(await response.text()).toEqual('proxy-response');
 expect(mockClerkFrontendApiProxy).toHaveBeenCalled();
 expect(authenticateRequestMock).not.toHaveBeenCalled();
 });

 test('proxies requests to custom proxy path', async () => {
 const app = new Hono();
 app.use('*', clerkMiddleware({ frontendApiProxy: { enabled: true, path: '/custom-proxy' } }));
 app.get('/', c => c.json({ ok: true }));

 const response = await app.request(new Request('http://localhost/custom-proxy/v1/client'));

 expect(response.status).toEqual(200);
 expect(mockClerkFrontendApiProxy).toHaveBeenCalled();
 });

 test('does not proxy when enabled is false', async () => {
 authenticateRequestMock.mockResolvedValueOnce({
 headers: new Headers(),
 toAuth: createMockSessionAuth,
 });
 const app = new Hono();
 app.use('*', clerkMiddleware({ frontendApiProxy: { enabled: false } }));
 app.get('/__clerk/v1/client', c => c.json({ ok: true }));

 const response = await app.request(new Request('http://localhost/__clerk/v1/client'));

 expect(response.status).toEqual(200);
 expect(mockClerkFrontendApiProxy).not.toHaveBeenCalled();
 expect(authenticateRequestMock).toHaveBeenCalled();
 });

 test('does not proxy non-matching paths', async () => {
 authenticateRequestMock.mockResolvedValueOnce({
 headers: new Headers(),
 toAuth: createMockSessionAuth,
 });
 const app = new Hono();
 app.use('*', clerkMiddleware({ frontendApiProxy: { enabled: true } }));
 app.get('/api/users', c => c.json({ ok: true }));

 const response = await app.request(new Request('http://localhost/api/users'));

 expect(response.status).toEqual(200);
 expect(mockClerkFrontendApiProxy).not.toHaveBeenCalled();
 expect(authenticateRequestMock).toHaveBeenCalled();
 });

 test('supports enabled as a function', async () => {
 authenticateRequestMock.mockResolvedValueOnce({
 headers: new Headers(),
 toAuth: createMockSessionAuth,
 });
 const enabledFn = vi.fn().mockReturnValue(false);
 const app = new Hono();
 app.use('*', clerkMiddleware({ frontendApiProxy: { enabled: enabledFn } }));
 app.get('/__clerk/v1/client', c => c.json({ ok: true }));

 const response = await app.request(new Request('http://localhost/__clerk/v1/client'));

 expect(response.status).toEqual(200);
 expect(enabledFn).toHaveBeenCalledWith(expect.any(URL));
 expect(mockClerkFrontendApiProxy).not.toHaveBeenCalled();
 });

 test('auto-derives proxyUrl for authenticateRequest when frontendApiProxy is enabled', async () => {
 authenticateRequestMock.mockResolvedValueOnce({
 headers: new Headers(),
 toAuth: createMockSessionAuth,
 });
 const app = new Hono();
 app.use('*', clerkMiddleware({ frontendApiProxy: { enabled: true } }));
 app.get('/api/users', c => c.json({ ok: true }));

 await app.request(new Request('http://localhost/api/users'));

 expect(authenticateRequestMock).toHaveBeenCalledWith(
 expect.any(Request),
 expect.objectContaining({
 proxyUrl: 'http://localhost/__clerk',
 }),
 );
 });
 });
});

describe('getAuth()', () => {
Expand Down

56 changes: 48 additions & 8 deletions
packages/hono/src/clerkMiddleware.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,17 +2,26 @@ import type { AuthObject } from '@clerk/backend';
import { createClerkClient } from '@clerk/backend';
import type { AuthenticateRequestOptions, AuthOptions, GetAuthFnNoRequest } from '@clerk/backend/internal';
import { getAuthObjectForAcceptedToken } from '@clerk/backend/internal';
import { clerkFrontendApiProxy, DEFAULT_PROXY_PATH, matchProxyPath } from '@clerk/backend/proxy';
import type { MiddlewareHandler } from 'hono';
import { env } from 'hono/adapter';

import type { FrontendApiProxyOptions } from './types';

type ClerkEnv = {
 CLERK_SECRET_KEY: string;
 CLERK_PUBLISHABLE_KEY: string;
 CLERK_API_URL?: string;
 CLERK_API_VERSION?: string;
};

export type ClerkMiddlewareOptions = Omit<AuthenticateRequestOptions, 'acceptsToken'>;
export type ClerkMiddlewareOptions = Omit<AuthenticateRequestOptions, 'acceptsToken'> & {
 /**
 * When set, enables the middleware to proxy Frontend API requests to Clerk.
 * This is useful when direct communication with Clerk's API is blocked.
 */
 frontendApiProxy?: FrontendApiProxyOptions;
};

/**
 * Clerk middleware for Hono that authenticates requests and attaches
Expand All@@ -35,12 +44,14 @@ export type ClerkMiddlewareOptions = Omit<AuthenticateRequestOptions, 'acceptsTo
export const clerkMiddleware = (options?: ClerkMiddlewareOptions): MiddlewareHandler => {
 return async (c, next) => {
 const clerkEnv = env<ClerkEnv>(c);
 const { secretKey, publishableKey, apiUrl, apiVersion, ...rest } = options || {
 secretKey: clerkEnv.CLERK_SECRET_KEY || '',
 publishableKey: clerkEnv.CLERK_PUBLISHABLE_KEY || '',
 apiUrl: clerkEnv.CLERK_API_URL,
 apiVersion: clerkEnv.CLERK_API_VERSION,
 };
 const {
 secretKey = clerkEnv.CLERK_SECRET_KEY || '',
 publishableKey = clerkEnv.CLERK_PUBLISHABLE_KEY || '',
 apiUrl = clerkEnv.CLERK_API_URL,
 apiVersion = clerkEnv.CLERK_API_VERSION,
 frontendApiProxy,
 ...rest
 } = options || {};

 if (!secretKey) {
 throw new Error(
Expand All@@ -54,6 +65,22 @@ export const clerkMiddleware = (options?: ClerkMiddlewareOptions): MiddlewareHan
 );
 }

 // Handle Frontend API proxy requests early, before authentication
 if (frontendApiProxy) {
 const { enabled, path: proxyPath = DEFAULT_PROXY_PATH } = frontendApiProxy;

 const requestUrl = new URL(c.req.url);
 const isEnabled = typeof enabled === 'function' ? enabled(requestUrl) : enabled;

 if (isEnabled && matchProxyPath(c.req.raw, { proxyPath })) {
 return clerkFrontendApiProxy(c.req.raw, {
 proxyPath,
 publishableKey,
 secretKey,
 });
 }
 }

 const clerkClient = createClerkClient({
 ...rest,
 apiUrl,
Expand All@@ -63,8 +90,21 @@ export const clerkMiddleware = (options?: ClerkMiddlewareOptions): MiddlewareHan
 userAgent: `${PACKAGE_NAME}@${PACKAGE_VERSION}`,
 });

 // Auto-derive proxyUrl from frontendApiProxy config if not explicitly set
 let authenticateOptions: typeof rest & { proxyUrl?: string } = rest;
 if (frontendApiProxy && !rest.proxyUrl) {
 const { enabled, path: proxyPath = DEFAULT_PROXY_PATH } = frontendApiProxy;
 const requestUrl = new URL(c.req.url);
 const isEnabled = typeof enabled === 'function' ? enabled(requestUrl) : enabled;

 if (isEnabled) {
 const derivedProxyUrl = `${requestUrl.origin}${proxyPath}`;
 authenticateOptions = { ...rest, proxyUrl: derivedProxyUrl };
 }
 }

 const requestState = await clerkClient.authenticateRequest(c.req.raw, {
 ...rest,
 ...authenticateOptions,
 secretKey,
 publishableKey,
 acceptsToken: 'any',
Expand Down

4 changes: 2 additions & 2 deletions
packages/hono/src/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,8 +3,8 @@ export type { ClerkMiddlewareOptions } from './clerkMiddleware';

export { getAuth } from './getAuth';

import type { ClerkHonoVariables } from './types';
export type { ClerkHonoVariables };
import type { ClerkHonoVariables, FrontendApiProxyOptions } from './types';
export type { ClerkHonoVariables, FrontendApiProxyOptions };

// Augment Hono's ContextVariableMap so users get type inference
// for c.get('clerk') and c.get('clerkAuth')
Expand Down

18 changes: 18 additions & 0 deletions
packages/hono/src/types.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
import type { ClerkClient } from '@clerk/backend';
import type { GetAuthFnNoRequest } from '@clerk/backend/internal';
import type { ShouldProxyFn } from '@clerk/shared/proxy';

/**
 * Variables that clerkMiddleware sets on the Hono context.
Expand All@@ -9,3 +10,20 @@ export type ClerkHonoVariables = {
 clerk: ClerkClient;
 clerkAuth: GetAuthFnNoRequest;
};

/**
 * Options for configuring Frontend API proxy in clerkMiddleware
 */
export interface FrontendApiProxyOptions {
 /**
 * Enable proxy handling. Can be:
 * - `true` - enable for all domains
 * - `false` - disable for all domains
 * - A function: (url: URL) => boolean - enable based on the request URL
 */
 enabled: boolean | ShouldProxyFn;
 /**
 * The path prefix for proxy requests. Defaults to `/__clerk`.
 */
 path?: string;
}
Loading

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Closed

brkalow
wants to merge
3
commits into

from

 Closed


feat(hono): Add Frontend API proxy support
#7988
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
4c631cd

feat(hono): Add Frontend API proxy support to clerkMiddleware


brkalow Mar 5, 2026
5500d54

chore: Add changeset for hono Frontend API proxy


brkalow Mar 5, 2026
f2af2b8

Apply suggestion from @brkalow


brkalow Mar 5, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


5 changes: 5 additions & 0 deletions
.changeset/bright-planes-proxy.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
"@clerk/hono": minor
---

Add Frontend API proxy support to `clerkMiddleware` via the new `frontendApiProxy` option, enabling request forwarding to Clerk's Frontend API.

110 changes: 110 additions & 0 deletions
packages/hono/src/__tests__/clerkMiddleware.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
import { clerkFrontendApiProxy } from '@clerk/backend/proxy';
import { Hono } from 'hono';

import { clerkMiddleware, getAuth } from '../index';
Expand DownExpand Up@@ -31,6 +32,16 @@ vi.mock(import('@clerk/backend'), async importOriginal => {
 };
});

vi.mock(import('@clerk/backend/proxy'), async importOriginal => {
 const original = await importOriginal();
 return {
 ...original,
 clerkFrontendApiProxy: vi.fn().mockResolvedValue(new Response('proxy-response', { status: 200 })),
 };
});

const mockClerkFrontendApiProxy = vi.mocked(clerkFrontendApiProxy);

describe('clerkMiddleware()', () => {
 beforeEach(() => {
 vi.stubEnv('CLERK_SECRET_KEY', EnvVariables.CLERK_SECRET_KEY);
Expand DownExpand Up@@ -161,6 +172,105 @@ describe('clerkMiddleware()', () => {

 expect(response.status).toEqual(500);
 });

 describe('frontendApiProxy', () => {
 beforeEach(() => {
 mockClerkFrontendApiProxy.mockReset();
 mockClerkFrontendApiProxy.mockResolvedValue(new Response('proxy-response', { status: 200 }));
 });

 test('proxies requests to the default proxy path when enabled', async () => {
 const app = new Hono();
 app.use('*', clerkMiddleware({ frontendApiProxy: { enabled: true } }));
 app.get('/', c => c.json({ ok: true }));

 const response = await app.request(new Request('http://localhost/__clerk/v1/client'));

 expect(response.status).toEqual(200);
 expect(await response.text()).toEqual('proxy-response');
 expect(mockClerkFrontendApiProxy).toHaveBeenCalled();
 expect(authenticateRequestMock).not.toHaveBeenCalled();
 });

 test('proxies requests to custom proxy path', async () => {
 const app = new Hono();
 app.use('*', clerkMiddleware({ frontendApiProxy: { enabled: true, path: '/custom-proxy' } }));
 app.get('/', c => c.json({ ok: true }));

 const response = await app.request(new Request('http://localhost/custom-proxy/v1/client'));

 expect(response.status).toEqual(200);
 expect(mockClerkFrontendApiProxy).toHaveBeenCalled();
 });

 test('does not proxy when enabled is false', async () => {
 authenticateRequestMock.mockResolvedValueOnce({
 headers: new Headers(),
 toAuth: createMockSessionAuth,
 });
 const app = new Hono();
 app.use('*', clerkMiddleware({ frontendApiProxy: { enabled: false } }));
 app.get('/__clerk/v1/client', c => c.json({ ok: true }));

 const response = await app.request(new Request('http://localhost/__clerk/v1/client'));

 expect(response.status).toEqual(200);
 expect(mockClerkFrontendApiProxy).not.toHaveBeenCalled();
 expect(authenticateRequestMock).toHaveBeenCalled();
 });

 test('does not proxy non-matching paths', async () => {
 authenticateRequestMock.mockResolvedValueOnce({
 headers: new Headers(),
 toAuth: createMockSessionAuth,
 });
 const app = new Hono();
 app.use('*', clerkMiddleware({ frontendApiProxy: { enabled: true } }));
 app.get('/api/users', c => c.json({ ok: true }));

 const response = await app.request(new Request('http://localhost/api/users'));

 expect(response.status).toEqual(200);
 expect(mockClerkFrontendApiProxy).not.toHaveBeenCalled();
 expect(authenticateRequestMock).toHaveBeenCalled();
 });

 test('supports enabled as a function', async () => {
 authenticateRequestMock.mockResolvedValueOnce({
 headers: new Headers(),
 toAuth: createMockSessionAuth,
 });
 const enabledFn = vi.fn().mockReturnValue(false);
 const app = new Hono();
 app.use('*', clerkMiddleware({ frontendApiProxy: { enabled: enabledFn } }));
 app.get('/__clerk/v1/client', c => c.json({ ok: true }));

 const response = await app.request(new Request('http://localhost/__clerk/v1/client'));

 expect(response.status).toEqual(200);
 expect(enabledFn).toHaveBeenCalledWith(expect.any(URL));
 expect(mockClerkFrontendApiProxy).not.toHaveBeenCalled();
 });

 test('auto-derives proxyUrl for authenticateRequest when frontendApiProxy is enabled', async () => {
 authenticateRequestMock.mockResolvedValueOnce({
 headers: new Headers(),
 toAuth: createMockSessionAuth,
 });
 const app = new Hono();
 app.use('*', clerkMiddleware({ frontendApiProxy: { enabled: true } }));
 app.get('/api/users', c => c.json({ ok: true }));

 await app.request(new Request('http://localhost/api/users'));

 expect(authenticateRequestMock).toHaveBeenCalledWith(
 expect.any(Request),
 expect.objectContaining({
 proxyUrl: 'http://localhost/__clerk',
 }),
 );
 });
 });
});

describe('getAuth()', () => {
Expand Down

56 changes: 48 additions & 8 deletions
packages/hono/src/clerkMiddleware.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,17 +2,26 @@ import type { AuthObject } from '@clerk/backend';
import { createClerkClient } from '@clerk/backend';
import type { AuthenticateRequestOptions, AuthOptions, GetAuthFnNoRequest } from '@clerk/backend/internal';
import { getAuthObjectForAcceptedToken } from '@clerk/backend/internal';
import { clerkFrontendApiProxy, DEFAULT_PROXY_PATH, matchProxyPath } from '@clerk/backend/proxy';
import type { MiddlewareHandler } from 'hono';
import { env } from 'hono/adapter';

import type { FrontendApiProxyOptions } from './types';

type ClerkEnv = {
 CLERK_SECRET_KEY: string;
 CLERK_PUBLISHABLE_KEY: string;
 CLERK_API_URL?: string;
 CLERK_API_VERSION?: string;
};

export type ClerkMiddlewareOptions = Omit<AuthenticateRequestOptions, 'acceptsToken'>;
export type ClerkMiddlewareOptions = Omit<AuthenticateRequestOptions, 'acceptsToken'> & {
 /**
 * When set, enables the middleware to proxy Frontend API requests to Clerk.
 * This is useful when direct communication with Clerk's API is blocked.
 */
 frontendApiProxy?: FrontendApiProxyOptions;
};

/**
 * Clerk middleware for Hono that authenticates requests and attaches
Expand All@@ -35,12 +44,14 @@ export type ClerkMiddlewareOptions = Omit<AuthenticateRequestOptions, 'acceptsTo
export const clerkMiddleware = (options?: ClerkMiddlewareOptions): MiddlewareHandler => {
 return async (c, next) => {
 const clerkEnv = env<ClerkEnv>(c);
 const { secretKey, publishableKey, apiUrl, apiVersion, ...rest } = options || {
 secretKey: clerkEnv.CLERK_SECRET_KEY || '',
 publishableKey: clerkEnv.CLERK_PUBLISHABLE_KEY || '',
 apiUrl: clerkEnv.CLERK_API_URL,
 apiVersion: clerkEnv.CLERK_API_VERSION,
 };
 const {
 secretKey = clerkEnv.CLERK_SECRET_KEY || '',
 publishableKey = clerkEnv.CLERK_PUBLISHABLE_KEY || '',
 apiUrl = clerkEnv.CLERK_API_URL,
 apiVersion = clerkEnv.CLERK_API_VERSION,
 frontendApiProxy,
 ...rest
 } = options || {};

 if (!secretKey) {
 throw new Error(
Expand All@@ -54,6 +65,22 @@ export const clerkMiddleware = (options?: ClerkMiddlewareOptions): MiddlewareHan
 );
 }

 // Handle Frontend API proxy requests early, before authentication
 if (frontendApiProxy) {
 const { enabled, path: proxyPath = DEFAULT_PROXY_PATH } = frontendApiProxy;

 const requestUrl = new URL(c.req.url);
 const isEnabled = typeof enabled === 'function' ? enabled(requestUrl) : enabled;

 if (isEnabled && matchProxyPath(c.req.raw, { proxyPath })) {
 return clerkFrontendApiProxy(c.req.raw, {
 proxyPath,
 publishableKey,
 secretKey,
 });
 }
 }

 const clerkClient = createClerkClient({
 ...rest,
 apiUrl,
Expand All@@ -63,8 +90,21 @@ export const clerkMiddleware = (options?: ClerkMiddlewareOptions): MiddlewareHan
 userAgent: `${PACKAGE_NAME}@${PACKAGE_VERSION}`,
 });

 // Auto-derive proxyUrl from frontendApiProxy config if not explicitly set
 let authenticateOptions: typeof rest & { proxyUrl?: string } = rest;
 if (frontendApiProxy && !rest.proxyUrl) {
 const { enabled, path: proxyPath = DEFAULT_PROXY_PATH } = frontendApiProxy;
 const requestUrl = new URL(c.req.url);
 const isEnabled = typeof enabled === 'function' ? enabled(requestUrl) : enabled;

 if (isEnabled) {
 const derivedProxyUrl = `${requestUrl.origin}${proxyPath}`;
 authenticateOptions = { ...rest, proxyUrl: derivedProxyUrl };
 }
 }

 const requestState = await clerkClient.authenticateRequest(c.req.raw, {
 ...rest,
 ...authenticateOptions,
 secretKey,
 publishableKey,
 acceptsToken: 'any',
Expand Down

4 changes: 2 additions & 2 deletions
packages/hono/src/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,8 +3,8 @@ export type { ClerkMiddlewareOptions } from './clerkMiddleware';

export { getAuth } from './getAuth';

import type { ClerkHonoVariables } from './types';
export type { ClerkHonoVariables };
import type { ClerkHonoVariables, FrontendApiProxyOptions } from './types';
export type { ClerkHonoVariables, FrontendApiProxyOptions };

// Augment Hono's ContextVariableMap so users get type inference
// for c.get('clerk') and c.get('clerkAuth')
Expand Down

18 changes: 18 additions & 0 deletions
packages/hono/src/types.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
import type { ClerkClient } from '@clerk/backend';
import type { GetAuthFnNoRequest } from '@clerk/backend/internal';
import type { ShouldProxyFn } from '@clerk/shared/proxy';

/**
 * Variables that clerkMiddleware sets on the Hono context.
Expand All@@ -9,3 +10,20 @@ export type ClerkHonoVariables = {
 clerk: ClerkClient;
 clerkAuth: GetAuthFnNoRequest;
};

/**
 * Options for configuring Frontend API proxy in clerkMiddleware
 */
export interface FrontendApiProxyOptions {
 /**
 * Enable proxy handling. Can be:
 * - `true` - enable for all domains
 * - `false` - disable for all domains
 * - A function: (url: URL) => boolean - enable based on the request URL
 */
 enabled: boolean | ShouldProxyFn;
 /**
 * The path prefix for proxy requests. Defaults to `/__clerk`.
 */
 path?: string;
}
Loading