Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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/restore-internal-query-client.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/clerk-js': patch
---

Restore the `clerk.__internal_queryClient` getter as a backward-compatibility shim so apps still on `@clerk/shared < 4.10.0` can hydrate their query client and continue to render paginated hooks (e.g. `useOrganizationList`, `useOrganization`). The getter lazily imports `@tanstack/query-core` only when accessed, so apps on `@clerk/shared >= 4.10.0` (which use the singleton in `@clerk/shared`) pay zero runtime cost.
5 changes: 3 additions & 2 deletions packages/clerk-js/bundlewatch.config.json
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,15 @@
{
"files": [
{ "path": "./dist/clerk.js", "maxSize": "543KB" },
{ "path": "./dist/clerk.js", "maxSize": "549KB" },
{ "path": "./dist/clerk.browser.js", "maxSize": "70KB" },
{ "path": "./dist/clerk.legacy.browser.js", "maxSize": "112KB" },
{ "path": "./dist/clerk.no-rhc.js", "maxSize": "311KB" },
{ "path": "./dist/clerk.no-rhc.js", "maxSize": "316KB" },
{ "path": "./dist/clerk.native.js", "maxSize": "70KB" },
{ "path": "./dist/vendors*.js", "maxSize": "7KB" },
{ "path": "./dist/coinbase*.js", "maxSize": "36KB" },
{ "path": "./dist/base-account-sdk*.js", "maxSize": "203KB" },
{ "path": "./dist/stripe-vendors*.js", "maxSize": "1KB" },
{ "path": "./dist/query-core-vendors*.js", "maxSize": "11KB" },
{ "path": "./dist/zxcvbn-ts-core*.js", "maxSize": "12KB" },
{ "path": "./dist/zxcvbn-common*.js", "maxSize": "226KB" }
]
Expand Down
1 change: 1 addition & 0 deletions packages/clerk-js/package.json
Original file line numberDiff line numberDiff line change
Expand Up@@ -91,6 +91,7 @@
"@solana/wallet-standard": "catalog:module-manager",
"@stripe/stripe-js": "5.6.0",
"@swc/helpers": "catalog:repo",
"@tanstack/query-core": "catalog:repo",
"@wallet-standard/core": "catalog:module-manager",
"@zxcvbn-ts/core": "catalog:module-manager",
"@zxcvbn-ts/language-common": "catalog:module-manager",
Expand Down
6 changes: 6 additions & 0 deletions packages/clerk-js/rspack.config.js
Original file line numberDiff line numberDiff line change
Expand Up@@ -110,6 +110,12 @@ const common = ({ mode, variant, disableRHC = false }) => {
chunks: 'all',
enforce: true,
},
queryCoreVendor: {
test: /[\\/]node_modules[\\/](@tanstack\/query-core)[\\/]/,
name: 'query-core-vendors',
chunks: 'all',
enforce: true,
},
defaultVendors: {
minChunks: 1,
test: module => {
Expand Down
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,75 @@
import { QueryClient } from '@tanstack/query-core';
import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest';

import { Clerk } from '../clerk';
import { Client, Environment } from '../resources/internal';

vi.mock('../resources/Client');
vi.mock('../resources/Environment');

vi.mock('../auth/devBrowser', () => ({
createDevBrowser: () => ({
clear: vi.fn(),
setup: vi.fn(),
getDevBrowser: vi.fn(() => 'deadbeef'),
setDevBrowser: vi.fn(),
removeDevBrowser: vi.fn(),
refreshCookies: vi.fn(),
}),
}));

Client.getOrCreateInstance = vi.fn().mockImplementation(() => ({ fetch: vi.fn() }));
Environment.getInstance = vi.fn().mockImplementation(() => ({ fetch: vi.fn(() => Promise.resolve({})) }));

const publishableKey = 'pk_test_Y2xlcmsuYWJjZWYuMTIzNDUuZGV2LmxjbGNsZXJrLmNvbSQ';

describe('Clerk __internal_queryClient (backward compat shim)', () => {
let clerk: Clerk;

beforeEach(() => {
clerk = new Clerk(publishableKey);
});

afterEach(() => {
vi.restoreAllMocks();
});

it('returns undefined before the lazy import resolves', () => {
expect(clerk.__internal_queryClient).toBeUndefined();
});

it('returns a tagged QueryClient after the lazy import resolves', async () => {
// Trigger the getter (fires the lazy import)
void clerk.__internal_queryClient;

// Wait for the dynamic import and QueryClient construction to settle
await vi.dynamicImportSettled();

const result = clerk.__internal_queryClient;
expect(result).toBeDefined();
expect(result!.__tag).toBe('clerk-rq-client');
expect(result!.client).toBeInstanceOf(QueryClient);
});

it('returns the same QueryClient instance on repeated access', async () => {
void clerk.__internal_queryClient;
await vi.dynamicImportSettled();

const first = clerk.__internal_queryClient;
const second = clerk.__internal_queryClient;
expect(first!.client).toBe(second!.client);
});

it('emits queryClientStatus event when the client is ready', async () => {
const listener = vi.fn();
// @ts-expect-error - queryClientStatus is not typed on clerk.on
clerk.on('queryClientStatus', listener);

void clerk.__internal_queryClient;
await vi.dynamicImportSettled();

expect(listener).toHaveBeenCalledWith('ready');
// @ts-expect-error
clerk.off('queryClientStatus', listener);
});
});
24 changes: 24 additions & 0 deletions packages/clerk-js/src/core/clerk.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -140,6 +140,7 @@ import type {
import type { ClerkUI } from '@clerk/shared/ui';
import { addClerkPrefix, isAbsoluteUrl, stripScheme } from '@clerk/shared/url';
import { allSettled, handleValueOrFn, noop } from '@clerk/shared/utils';
import type { QueryClient } from '@tanstack/query-core';

import { debugLogger, initDebugLogger } from '@/utils/debug';
import { ModuleManager } from '@/utils/moduleManager';
Expand DownExpand Up@@ -252,6 +253,7 @@ export class Clerk implements ClerkInterface {
// converted to protected environment to support `updateEnvironment` type assertion
protected environment?: EnvironmentResource | null;

#queryClient: QueryClient | undefined;
#publishableKey = '';
#domain: DomainOrProxyUrl['domain'];
#proxyUrl: DomainOrProxyUrl['proxyUrl'];
Expand All@@ -271,6 +273,28 @@ export class Clerk implements ClerkInterface {
#touchThrottledUntil = 0;
#publicEventBus = createClerkEventBus();

get __internal_queryClient(): { __tag: 'clerk-rq-client'; client: QueryClient } | undefined {
if (!this.#queryClient) {
void import('./query-core')
.then(module => module.QueryClient)
.then(QueryClient => {
if (this.#queryClient) {
return;
}
this.#queryClient = new QueryClient();
// @ts-expect-error - queryClientStatus is not typed
this.#publicEventBus.emit('queryClientStatus', 'ready');
});
}

return this.#queryClient
? {
__tag: 'clerk-rq-client',
client: this.#queryClient,
}
: undefined;
}

public __internal_getCachedResources:
| (() => Promise<{ client: ClientJSONSnapshot | null; environment: EnvironmentJSONSnapshot | null }>)
| undefined;
Expand Down
1 change: 1 addition & 0 deletions packages/clerk-js/src/core/query-core.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
export { QueryClient } from '@tanstack/query-core';
3 changes: 3 additions & 0 deletions pnpm-lock.yaml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

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" + '
fix(clerk-js): Restore internal queryClient for backward compat with older SDKs by wobsoriano · Pull Request #8562 · clerk/javascript · GitHub
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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/restore-internal-query-client.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/clerk-js': patch
---

Restore the `clerk.__internal_queryClient` getter as a backward-compatibility shim so apps still on `@clerk/shared < 4.10.0` can hydrate their query client and continue to render paginated hooks (e.g. `useOrganizationList`, `useOrganization`). The getter lazily imports `@tanstack/query-core` only when accessed, so apps on `@clerk/shared >= 4.10.0` (which use the singleton in `@clerk/shared`) pay zero runtime cost.
5 changes: 3 additions & 2 deletions packages/clerk-js/bundlewatch.config.json
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,15 @@
{
"files": [
{ "path": "./dist/clerk.js", "maxSize": "543KB" },
{ "path": "./dist/clerk.js", "maxSize": "549KB" },
{ "path": "./dist/clerk.browser.js", "maxSize": "70KB" },
{ "path": "./dist/clerk.legacy.browser.js", "maxSize": "112KB" },
{ "path": "./dist/clerk.no-rhc.js", "maxSize": "311KB" },
{ "path": "./dist/clerk.no-rhc.js", "maxSize": "316KB" },
{ "path": "./dist/clerk.native.js", "maxSize": "70KB" },
{ "path": "./dist/vendors*.js", "maxSize": "7KB" },
{ "path": "./dist/coinbase*.js", "maxSize": "36KB" },
{ "path": "./dist/base-account-sdk*.js", "maxSize": "203KB" },
{ "path": "./dist/stripe-vendors*.js", "maxSize": "1KB" },
{ "path": "./dist/query-core-vendors*.js", "maxSize": "11KB" },
{ "path": "./dist/zxcvbn-ts-core*.js", "maxSize": "12KB" },
{ "path": "./dist/zxcvbn-common*.js", "maxSize": "226KB" }
]
Expand Down
1 change: 1 addition & 0 deletions packages/clerk-js/package.json
Original file line numberDiff line numberDiff line change
Expand Up@@ -91,6 +91,7 @@
"@solana/wallet-standard": "catalog:module-manager",
"@stripe/stripe-js": "5.6.0",
"@swc/helpers": "catalog:repo",
"@tanstack/query-core": "catalog:repo",
"@wallet-standard/core": "catalog:module-manager",
"@zxcvbn-ts/core": "catalog:module-manager",
"@zxcvbn-ts/language-common": "catalog:module-manager",
Expand Down
6 changes: 6 additions & 0 deletions packages/clerk-js/rspack.config.js
Original file line numberDiff line numberDiff line change
Expand Up@@ -110,6 +110,12 @@ const common = ({ mode, variant, disableRHC = false }) => {
chunks: 'all',
enforce: true,
},
queryCoreVendor: {
test: /[\\/]node_modules[\\/](@tanstack\/query-core)[\\/]/,
name: 'query-core-vendors',
chunks: 'all',
enforce: true,
},
defaultVendors: {
minChunks: 1,
test: module => {
Expand Down
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,75 @@
import { QueryClient } from '@tanstack/query-core';
import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest';

import { Clerk } from '../clerk';
import { Client, Environment } from '../resources/internal';

vi.mock('../resources/Client');
vi.mock('../resources/Environment');

vi.mock('../auth/devBrowser', () => ({
createDevBrowser: () => ({
clear: vi.fn(),
setup: vi.fn(),
getDevBrowser: vi.fn(() => 'deadbeef'),
setDevBrowser: vi.fn(),
removeDevBrowser: vi.fn(),
refreshCookies: vi.fn(),
}),
}));

Client.getOrCreateInstance = vi.fn().mockImplementation(() => ({ fetch: vi.fn() }));
Environment.getInstance = vi.fn().mockImplementation(() => ({ fetch: vi.fn(() => Promise.resolve({})) }));

const publishableKey = 'pk_test_Y2xlcmsuYWJjZWYuMTIzNDUuZGV2LmxjbGNsZXJrLmNvbSQ';

describe('Clerk __internal_queryClient (backward compat shim)', () => {
let clerk: Clerk;

beforeEach(() => {
clerk = new Clerk(publishableKey);
});

afterEach(() => {
vi.restoreAllMocks();
});

it('returns undefined before the lazy import resolves', () => {
expect(clerk.__internal_queryClient).toBeUndefined();
});

it('returns a tagged QueryClient after the lazy import resolves', async () => {
// Trigger the getter (fires the lazy import)
void clerk.__internal_queryClient;

// Wait for the dynamic import and QueryClient construction to settle
await vi.dynamicImportSettled();

const result = clerk.__internal_queryClient;
expect(result).toBeDefined();
expect(result!.__tag).toBe('clerk-rq-client');
expect(result!.client).toBeInstanceOf(QueryClient);
});

it('returns the same QueryClient instance on repeated access', async () => {
void clerk.__internal_queryClient;
await vi.dynamicImportSettled();

const first = clerk.__internal_queryClient;
const second = clerk.__internal_queryClient;
expect(first!.client).toBe(second!.client);
});

it('emits queryClientStatus event when the client is ready', async () => {
const listener = vi.fn();
// @ts-expect-error - queryClientStatus is not typed on clerk.on
clerk.on('queryClientStatus', listener);

void clerk.__internal_queryClient;
await vi.dynamicImportSettled();

expect(listener).toHaveBeenCalledWith('ready');
// @ts-expect-error
clerk.off('queryClientStatus', listener);
});
});
24 changes: 24 additions & 0 deletions packages/clerk-js/src/core/clerk.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -140,6 +140,7 @@ import type {
import type { ClerkUI } from '@clerk/shared/ui';
import { addClerkPrefix, isAbsoluteUrl, stripScheme } from '@clerk/shared/url';
import { allSettled, handleValueOrFn, noop } from '@clerk/shared/utils';
import type { QueryClient } from '@tanstack/query-core';

import { debugLogger, initDebugLogger } from '@/utils/debug';
import { ModuleManager } from '@/utils/moduleManager';
Expand DownExpand Up@@ -252,6 +253,7 @@ export class Clerk implements ClerkInterface {
// converted to protected environment to support `updateEnvironment` type assertion
protected environment?: EnvironmentResource | null;

#queryClient: QueryClient | undefined;
#publishableKey = '';
#domain: DomainOrProxyUrl['domain'];
#proxyUrl: DomainOrProxyUrl['proxyUrl'];
Expand All@@ -271,6 +273,28 @@ export class Clerk implements ClerkInterface {
#touchThrottledUntil = 0;
#publicEventBus = createClerkEventBus();

get __internal_queryClient(): { __tag: 'clerk-rq-client'; client: QueryClient } | undefined {
if (!this.#queryClient) {
void import('./query-core')
.then(module => module.QueryClient)
.then(QueryClient => {
if (this.#queryClient) {
return;
}
this.#queryClient = new QueryClient();
// @ts-expect-error - queryClientStatus is not typed
this.#publicEventBus.emit('queryClientStatus', 'ready');
});
}

return this.#queryClient
? {
__tag: 'clerk-rq-client',
client: this.#queryClient,
}
: undefined;
}

public __internal_getCachedResources:
| (() => Promise<{ client: ClientJSONSnapshot | null; environment: EnvironmentJSONSnapshot | null }>)
| undefined;
Expand Down
1 change: 1 addition & 0 deletions packages/clerk-js/src/core/query-core.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
export { QueryClient } from '@tanstack/query-core';
3 changes: 3 additions & 0 deletions pnpm-lock.yaml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

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('^' + ".*" + ' fix(clerk-js): Restore internal queryClient for backward compat with older SDKs by wobsoriano · Pull Request #8562 · clerk/javascript · GitHub
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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/restore-internal-query-client.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/clerk-js': patch
---

Restore the `clerk.__internal_queryClient` getter as a backward-compatibility shim so apps still on `@clerk/shared < 4.10.0` can hydrate their query client and continue to render paginated hooks (e.g. `useOrganizationList`, `useOrganization`). The getter lazily imports `@tanstack/query-core` only when accessed, so apps on `@clerk/shared >= 4.10.0` (which use the singleton in `@clerk/shared`) pay zero runtime cost.
5 changes: 3 additions & 2 deletions packages/clerk-js/bundlewatch.config.json
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,15 @@
{
"files": [
{ "path": "./dist/clerk.js", "maxSize": "543KB" },
{ "path": "./dist/clerk.js", "maxSize": "549KB" },
{ "path": "./dist/clerk.browser.js", "maxSize": "70KB" },
{ "path": "./dist/clerk.legacy.browser.js", "maxSize": "112KB" },
{ "path": "./dist/clerk.no-rhc.js", "maxSize": "311KB" },
{ "path": "./dist/clerk.no-rhc.js", "maxSize": "316KB" },
{ "path": "./dist/clerk.native.js", "maxSize": "70KB" },
{ "path": "./dist/vendors*.js", "maxSize": "7KB" },
{ "path": "./dist/coinbase*.js", "maxSize": "36KB" },
{ "path": "./dist/base-account-sdk*.js", "maxSize": "203KB" },
{ "path": "./dist/stripe-vendors*.js", "maxSize": "1KB" },
{ "path": "./dist/query-core-vendors*.js", "maxSize": "11KB" },
{ "path": "./dist/zxcvbn-ts-core*.js", "maxSize": "12KB" },
{ "path": "./dist/zxcvbn-common*.js", "maxSize": "226KB" }
]
Expand Down
1 change: 1 addition & 0 deletions packages/clerk-js/package.json
Original file line numberDiff line numberDiff line change
Expand Up@@ -91,6 +91,7 @@
"@solana/wallet-standard": "catalog:module-manager",
"@stripe/stripe-js": "5.6.0",
"@swc/helpers": "catalog:repo",
"@tanstack/query-core": "catalog:repo",
"@wallet-standard/core": "catalog:module-manager",
"@zxcvbn-ts/core": "catalog:module-manager",
"@zxcvbn-ts/language-common": "catalog:module-manager",
Expand Down
6 changes: 6 additions & 0 deletions packages/clerk-js/rspack.config.js
Original file line numberDiff line numberDiff line change
Expand Up@@ -110,6 +110,12 @@ const common = ({ mode, variant, disableRHC = false }) => {
chunks: 'all',
enforce: true,
},
queryCoreVendor: {
test: /[\\/]node_modules[\\/](@tanstack\/query-core)[\\/]/,
name: 'query-core-vendors',
chunks: 'all',
enforce: true,
},
defaultVendors: {
minChunks: 1,
test: module => {
Expand Down
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,75 @@
import { QueryClient } from '@tanstack/query-core';
import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest';

import { Clerk } from '../clerk';
import { Client, Environment } from '../resources/internal';

vi.mock('../resources/Client');
vi.mock('../resources/Environment');

vi.mock('../auth/devBrowser', () => ({
createDevBrowser: () => ({
clear: vi.fn(),
setup: vi.fn(),
getDevBrowser: vi.fn(() => 'deadbeef'),
setDevBrowser: vi.fn(),
removeDevBrowser: vi.fn(),
refreshCookies: vi.fn(),
}),
}));

Client.getOrCreateInstance = vi.fn().mockImplementation(() => ({ fetch: vi.fn() }));
Environment.getInstance = vi.fn().mockImplementation(() => ({ fetch: vi.fn(() => Promise.resolve({})) }));

const publishableKey = 'pk_test_Y2xlcmsuYWJjZWYuMTIzNDUuZGV2LmxjbGNsZXJrLmNvbSQ';

describe('Clerk __internal_queryClient (backward compat shim)', () => {
let clerk: Clerk;

beforeEach(() => {
clerk = new Clerk(publishableKey);
});

afterEach(() => {
vi.restoreAllMocks();
});

it('returns undefined before the lazy import resolves', () => {
expect(clerk.__internal_queryClient).toBeUndefined();
});

it('returns a tagged QueryClient after the lazy import resolves', async () => {
// Trigger the getter (fires the lazy import)
void clerk.__internal_queryClient;

// Wait for the dynamic import and QueryClient construction to settle
await vi.dynamicImportSettled();

const result = clerk.__internal_queryClient;
expect(result).toBeDefined();
expect(result!.__tag).toBe('clerk-rq-client');
expect(result!.client).toBeInstanceOf(QueryClient);
});

it('returns the same QueryClient instance on repeated access', async () => {
void clerk.__internal_queryClient;
await vi.dynamicImportSettled();

const first = clerk.__internal_queryClient;
const second = clerk.__internal_queryClient;
expect(first!.client).toBe(second!.client);
});

it('emits queryClientStatus event when the client is ready', async () => {
const listener = vi.fn();
// @ts-expect-error - queryClientStatus is not typed on clerk.on
clerk.on('queryClientStatus', listener);

void clerk.__internal_queryClient;
await vi.dynamicImportSettled();

expect(listener).toHaveBeenCalledWith('ready');
// @ts-expect-error
clerk.off('queryClientStatus', listener);
});
});
24 changes: 24 additions & 0 deletions packages/clerk-js/src/core/clerk.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -140,6 +140,7 @@ import type {
import type { ClerkUI } from '@clerk/shared/ui';
import { addClerkPrefix, isAbsoluteUrl, stripScheme } from '@clerk/shared/url';
import { allSettled, handleValueOrFn, noop } from '@clerk/shared/utils';
import type { QueryClient } from '@tanstack/query-core';

import { debugLogger, initDebugLogger } from '@/utils/debug';
import { ModuleManager } from '@/utils/moduleManager';
Expand DownExpand Up@@ -252,6 +253,7 @@ export class Clerk implements ClerkInterface {
// converted to protected environment to support `updateEnvironment` type assertion
protected environment?: EnvironmentResource | null;

#queryClient: QueryClient | undefined;
#publishableKey = '';
#domain: DomainOrProxyUrl['domain'];
#proxyUrl: DomainOrProxyUrl['proxyUrl'];
Expand All@@ -271,6 +273,28 @@ export class Clerk implements ClerkInterface {
#touchThrottledUntil = 0;
#publicEventBus = createClerkEventBus();

get __internal_queryClient(): { __tag: 'clerk-rq-client'; client: QueryClient } | undefined {
if (!this.#queryClient) {
void import('./query-core')
.then(module => module.QueryClient)
.then(QueryClient => {
if (this.#queryClient) {
return;
}
this.#queryClient = new QueryClient();
// @ts-expect-error - queryClientStatus is not typed
this.#publicEventBus.emit('queryClientStatus', 'ready');
});
}

return this.#queryClient
? {
__tag: 'clerk-rq-client',
client: this.#queryClient,
}
: undefined;
}

public __internal_getCachedResources:
| (() => Promise<{ client: ClientJSONSnapshot | null; environment: EnvironmentJSONSnapshot | null }>)
| undefined;
Expand Down
1 change: 1 addition & 0 deletions packages/clerk-js/src/core/query-core.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
export { QueryClient } from '@tanstack/query-core';
3 changes: 3 additions & 0 deletions pnpm-lock.yaml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

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('^' + ".*" + ' fix(clerk-js): Restore internal queryClient for backward compat with older SDKs by wobsoriano · Pull Request #8562 · clerk/javascript · GitHub
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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/restore-internal-query-client.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/clerk-js': patch
---

Restore the `clerk.__internal_queryClient` getter as a backward-compatibility shim so apps still on `@clerk/shared < 4.10.0` can hydrate their query client and continue to render paginated hooks (e.g. `useOrganizationList`, `useOrganization`). The getter lazily imports `@tanstack/query-core` only when accessed, so apps on `@clerk/shared >= 4.10.0` (which use the singleton in `@clerk/shared`) pay zero runtime cost.
5 changes: 3 additions & 2 deletions packages/clerk-js/bundlewatch.config.json
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,15 @@
{
"files": [
{ "path": "./dist/clerk.js", "maxSize": "543KB" },
{ "path": "./dist/clerk.js", "maxSize": "549KB" },
{ "path": "./dist/clerk.browser.js", "maxSize": "70KB" },
{ "path": "./dist/clerk.legacy.browser.js", "maxSize": "112KB" },
{ "path": "./dist/clerk.no-rhc.js", "maxSize": "311KB" },
{ "path": "./dist/clerk.no-rhc.js", "maxSize": "316KB" },
{ "path": "./dist/clerk.native.js", "maxSize": "70KB" },
{ "path": "./dist/vendors*.js", "maxSize": "7KB" },
{ "path": "./dist/coinbase*.js", "maxSize": "36KB" },
{ "path": "./dist/base-account-sdk*.js", "maxSize": "203KB" },
{ "path": "./dist/stripe-vendors*.js", "maxSize": "1KB" },
{ "path": "./dist/query-core-vendors*.js", "maxSize": "11KB" },
{ "path": "./dist/zxcvbn-ts-core*.js", "maxSize": "12KB" },
{ "path": "./dist/zxcvbn-common*.js", "maxSize": "226KB" }
]
Expand Down
1 change: 1 addition & 0 deletions packages/clerk-js/package.json
Original file line numberDiff line numberDiff line change
Expand Up@@ -91,6 +91,7 @@
"@solana/wallet-standard": "catalog:module-manager",
"@stripe/stripe-js": "5.6.0",
"@swc/helpers": "catalog:repo",
"@tanstack/query-core": "catalog:repo",
"@wallet-standard/core": "catalog:module-manager",
"@zxcvbn-ts/core": "catalog:module-manager",
"@zxcvbn-ts/language-common": "catalog:module-manager",
Expand Down
6 changes: 6 additions & 0 deletions packages/clerk-js/rspack.config.js
Original file line numberDiff line numberDiff line change
Expand Up@@ -110,6 +110,12 @@ const common = ({ mode, variant, disableRHC = false }) => {
chunks: 'all',
enforce: true,
},
queryCoreVendor: {
test: /[\\/]node_modules[\\/](@tanstack\/query-core)[\\/]/,
name: 'query-core-vendors',
chunks: 'all',
enforce: true,
},
defaultVendors: {
minChunks: 1,
test: module => {
Expand Down
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,75 @@
import { QueryClient } from '@tanstack/query-core';
import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest';

import { Clerk } from '../clerk';
import { Client, Environment } from '../resources/internal';

vi.mock('../resources/Client');
vi.mock('../resources/Environment');

vi.mock('../auth/devBrowser', () => ({
createDevBrowser: () => ({
clear: vi.fn(),
setup: vi.fn(),
getDevBrowser: vi.fn(() => 'deadbeef'),
setDevBrowser: vi.fn(),
removeDevBrowser: vi.fn(),
refreshCookies: vi.fn(),
}),
}));

Client.getOrCreateInstance = vi.fn().mockImplementation(() => ({ fetch: vi.fn() }));
Environment.getInstance = vi.fn().mockImplementation(() => ({ fetch: vi.fn(() => Promise.resolve({})) }));

const publishableKey = 'pk_test_Y2xlcmsuYWJjZWYuMTIzNDUuZGV2LmxjbGNsZXJrLmNvbSQ';

describe('Clerk __internal_queryClient (backward compat shim)', () => {
let clerk: Clerk;

beforeEach(() => {
clerk = new Clerk(publishableKey);
});

afterEach(() => {
vi.restoreAllMocks();
});

it('returns undefined before the lazy import resolves', () => {
expect(clerk.__internal_queryClient).toBeUndefined();
});

it('returns a tagged QueryClient after the lazy import resolves', async () => {
// Trigger the getter (fires the lazy import)
void clerk.__internal_queryClient;

// Wait for the dynamic import and QueryClient construction to settle
await vi.dynamicImportSettled();

const result = clerk.__internal_queryClient;
expect(result).toBeDefined();
expect(result!.__tag).toBe('clerk-rq-client');
expect(result!.client).toBeInstanceOf(QueryClient);
});

it('returns the same QueryClient instance on repeated access', async () => {
void clerk.__internal_queryClient;
await vi.dynamicImportSettled();

const first = clerk.__internal_queryClient;
const second = clerk.__internal_queryClient;
expect(first!.client).toBe(second!.client);
});

it('emits queryClientStatus event when the client is ready', async () => {
const listener = vi.fn();
// @ts-expect-error - queryClientStatus is not typed on clerk.on
clerk.on('queryClientStatus', listener);

void clerk.__internal_queryClient;
await vi.dynamicImportSettled();

expect(listener).toHaveBeenCalledWith('ready');
// @ts-expect-error
clerk.off('queryClientStatus', listener);
});
});
24 changes: 24 additions & 0 deletions packages/clerk-js/src/core/clerk.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -140,6 +140,7 @@ import type {
import type { ClerkUI } from '@clerk/shared/ui';
import { addClerkPrefix, isAbsoluteUrl, stripScheme } from '@clerk/shared/url';
import { allSettled, handleValueOrFn, noop } from '@clerk/shared/utils';
import type { QueryClient } from '@tanstack/query-core';

import { debugLogger, initDebugLogger } from '@/utils/debug';
import { ModuleManager } from '@/utils/moduleManager';
Expand DownExpand Up@@ -252,6 +253,7 @@ export class Clerk implements ClerkInterface {
// converted to protected environment to support `updateEnvironment` type assertion
protected environment?: EnvironmentResource | null;

#queryClient: QueryClient | undefined;
#publishableKey = '';
#domain: DomainOrProxyUrl['domain'];
#proxyUrl: DomainOrProxyUrl['proxyUrl'];
Expand All@@ -271,6 +273,28 @@ export class Clerk implements ClerkInterface {
#touchThrottledUntil = 0;
#publicEventBus = createClerkEventBus();

get __internal_queryClient(): { __tag: 'clerk-rq-client'; client: QueryClient } | undefined {
if (!this.#queryClient) {
void import('./query-core')
.then(module => module.QueryClient)
.then(QueryClient => {
if (this.#queryClient) {
return;
}
this.#queryClient = new QueryClient();
// @ts-expect-error - queryClientStatus is not typed
this.#publicEventBus.emit('queryClientStatus', 'ready');
});
}

return this.#queryClient
? {
__tag: 'clerk-rq-client',
client: this.#queryClient,
}
: undefined;
}

public __internal_getCachedResources:
| (() => Promise<{ client: ClientJSONSnapshot | null; environment: EnvironmentJSONSnapshot | null }>)
| undefined;
Expand Down
1 change: 1 addition & 0 deletions packages/clerk-js/src/core/query-core.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
export { QueryClient } from '@tanstack/query-core';
3 changes: 3 additions & 0 deletions pnpm-lock.yaml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

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" + ' fix(clerk-js): Restore internal queryClient for backward compat with older SDKs by wobsoriano · Pull Request #8562 · clerk/javascript · GitHub
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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/restore-internal-query-client.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/clerk-js': patch
---

Restore the `clerk.__internal_queryClient` getter as a backward-compatibility shim so apps still on `@clerk/shared < 4.10.0` can hydrate their query client and continue to render paginated hooks (e.g. `useOrganizationList`, `useOrganization`). The getter lazily imports `@tanstack/query-core` only when accessed, so apps on `@clerk/shared >= 4.10.0` (which use the singleton in `@clerk/shared`) pay zero runtime cost.
5 changes: 3 additions & 2 deletions packages/clerk-js/bundlewatch.config.json
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,15 @@
{
"files": [
{ "path": "./dist/clerk.js", "maxSize": "543KB" },
{ "path": "./dist/clerk.js", "maxSize": "549KB" },
{ "path": "./dist/clerk.browser.js", "maxSize": "70KB" },
{ "path": "./dist/clerk.legacy.browser.js", "maxSize": "112KB" },
{ "path": "./dist/clerk.no-rhc.js", "maxSize": "311KB" },
{ "path": "./dist/clerk.no-rhc.js", "maxSize": "316KB" },
{ "path": "./dist/clerk.native.js", "maxSize": "70KB" },
{ "path": "./dist/vendors*.js", "maxSize": "7KB" },
{ "path": "./dist/coinbase*.js", "maxSize": "36KB" },
{ "path": "./dist/base-account-sdk*.js", "maxSize": "203KB" },
{ "path": "./dist/stripe-vendors*.js", "maxSize": "1KB" },
{ "path": "./dist/query-core-vendors*.js", "maxSize": "11KB" },
{ "path": "./dist/zxcvbn-ts-core*.js", "maxSize": "12KB" },
{ "path": "./dist/zxcvbn-common*.js", "maxSize": "226KB" }
]
Expand Down
1 change: 1 addition & 0 deletions packages/clerk-js/package.json
Original file line numberDiff line numberDiff line change
Expand Up@@ -91,6 +91,7 @@
"@solana/wallet-standard": "catalog:module-manager",
"@stripe/stripe-js": "5.6.0",
"@swc/helpers": "catalog:repo",
"@tanstack/query-core": "catalog:repo",
"@wallet-standard/core": "catalog:module-manager",
"@zxcvbn-ts/core": "catalog:module-manager",
"@zxcvbn-ts/language-common": "catalog:module-manager",
Expand Down
6 changes: 6 additions & 0 deletions packages/clerk-js/rspack.config.js
Original file line numberDiff line numberDiff line change
Expand Up@@ -110,6 +110,12 @@ const common = ({ mode, variant, disableRHC = false }) => {
chunks: 'all',
enforce: true,
},
queryCoreVendor: {
test: /[\\/]node_modules[\\/](@tanstack\/query-core)[\\/]/,
name: 'query-core-vendors',
chunks: 'all',
enforce: true,
},
defaultVendors: {
minChunks: 1,
test: module => {
Expand Down
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,75 @@
import { QueryClient } from '@tanstack/query-core';
import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest';

import { Clerk } from '../clerk';
import { Client, Environment } from '../resources/internal';

vi.mock('../resources/Client');
vi.mock('../resources/Environment');

vi.mock('../auth/devBrowser', () => ({
createDevBrowser: () => ({
clear: vi.fn(),
setup: vi.fn(),
getDevBrowser: vi.fn(() => 'deadbeef'),
setDevBrowser: vi.fn(),
removeDevBrowser: vi.fn(),
refreshCookies: vi.fn(),
}),
}));

Client.getOrCreateInstance = vi.fn().mockImplementation(() => ({ fetch: vi.fn() }));
Environment.getInstance = vi.fn().mockImplementation(() => ({ fetch: vi.fn(() => Promise.resolve({})) }));

const publishableKey = 'pk_test_Y2xlcmsuYWJjZWYuMTIzNDUuZGV2LmxjbGNsZXJrLmNvbSQ';

describe('Clerk __internal_queryClient (backward compat shim)', () => {
let clerk: Clerk;

beforeEach(() => {
clerk = new Clerk(publishableKey);
});

afterEach(() => {
vi.restoreAllMocks();
});

it('returns undefined before the lazy import resolves', () => {
expect(clerk.__internal_queryClient).toBeUndefined();
});

it('returns a tagged QueryClient after the lazy import resolves', async () => {
// Trigger the getter (fires the lazy import)
void clerk.__internal_queryClient;

// Wait for the dynamic import and QueryClient construction to settle
await vi.dynamicImportSettled();

const result = clerk.__internal_queryClient;
expect(result).toBeDefined();
expect(result!.__tag).toBe('clerk-rq-client');
expect(result!.client).toBeInstanceOf(QueryClient);
});

it('returns the same QueryClient instance on repeated access', async () => {
void clerk.__internal_queryClient;
await vi.dynamicImportSettled();

const first = clerk.__internal_queryClient;
const second = clerk.__internal_queryClient;
expect(first!.client).toBe(second!.client);
});

it('emits queryClientStatus event when the client is ready', async () => {
const listener = vi.fn();
// @ts-expect-error - queryClientStatus is not typed on clerk.on
clerk.on('queryClientStatus', listener);

void clerk.__internal_queryClient;
await vi.dynamicImportSettled();

expect(listener).toHaveBeenCalledWith('ready');
// @ts-expect-error
clerk.off('queryClientStatus', listener);
});
});
24 changes: 24 additions & 0 deletions packages/clerk-js/src/core/clerk.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -140,6 +140,7 @@ import type {
import type { ClerkUI } from '@clerk/shared/ui';
import { addClerkPrefix, isAbsoluteUrl, stripScheme } from '@clerk/shared/url';
import { allSettled, handleValueOrFn, noop } from '@clerk/shared/utils';
import type { QueryClient } from '@tanstack/query-core';

import { debugLogger, initDebugLogger } from '@/utils/debug';
import { ModuleManager } from '@/utils/moduleManager';
Expand DownExpand Up@@ -252,6 +253,7 @@ export class Clerk implements ClerkInterface {
// converted to protected environment to support `updateEnvironment` type assertion
protected environment?: EnvironmentResource | null;

#queryClient: QueryClient | undefined;
#publishableKey = '';
#domain: DomainOrProxyUrl['domain'];
#proxyUrl: DomainOrProxyUrl['proxyUrl'];
Expand All@@ -271,6 +273,28 @@ export class Clerk implements ClerkInterface {
#touchThrottledUntil = 0;
#publicEventBus = createClerkEventBus();

get __internal_queryClient(): { __tag: 'clerk-rq-client'; client: QueryClient } | undefined {
if (!this.#queryClient) {
void import('./query-core')
.then(module => module.QueryClient)
.then(QueryClient => {
if (this.#queryClient) {
return;
}
this.#queryClient = new QueryClient();
// @ts-expect-error - queryClientStatus is not typed
this.#publicEventBus.emit('queryClientStatus', 'ready');
});
}

return this.#queryClient
? {
__tag: 'clerk-rq-client',
client: this.#queryClient,
}
: undefined;
}

public __internal_getCachedResources:
| (() => Promise<{ client: ClientJSONSnapshot | null; environment: EnvironmentJSONSnapshot | null }>)
| undefined;
Expand Down
1 change: 1 addition & 0 deletions packages/clerk-js/src/core/query-core.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
export { QueryClient } from '@tanstack/query-core';
3 changes: 3 additions & 0 deletions pnpm-lock.yaml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

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('^' + ".*" + ' fix(clerk-js): Restore internal queryClient for backward compat with older SDKs by wobsoriano · Pull Request #8562 · clerk/javascript · GitHub
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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/restore-internal-query-client.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/clerk-js': patch
---

Restore the `clerk.__internal_queryClient` getter as a backward-compatibility shim so apps still on `@clerk/shared < 4.10.0` can hydrate their query client and continue to render paginated hooks (e.g. `useOrganizationList`, `useOrganization`). The getter lazily imports `@tanstack/query-core` only when accessed, so apps on `@clerk/shared >= 4.10.0` (which use the singleton in `@clerk/shared`) pay zero runtime cost.
5 changes: 3 additions & 2 deletions packages/clerk-js/bundlewatch.config.json
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,15 @@
{
"files": [
{ "path": "./dist/clerk.js", "maxSize": "543KB" },
{ "path": "./dist/clerk.js", "maxSize": "549KB" },
{ "path": "./dist/clerk.browser.js", "maxSize": "70KB" },
{ "path": "./dist/clerk.legacy.browser.js", "maxSize": "112KB" },
{ "path": "./dist/clerk.no-rhc.js", "maxSize": "311KB" },
{ "path": "./dist/clerk.no-rhc.js", "maxSize": "316KB" },
{ "path": "./dist/clerk.native.js", "maxSize": "70KB" },
{ "path": "./dist/vendors*.js", "maxSize": "7KB" },
{ "path": "./dist/coinbase*.js", "maxSize": "36KB" },
{ "path": "./dist/base-account-sdk*.js", "maxSize": "203KB" },
{ "path": "./dist/stripe-vendors*.js", "maxSize": "1KB" },
{ "path": "./dist/query-core-vendors*.js", "maxSize": "11KB" },
{ "path": "./dist/zxcvbn-ts-core*.js", "maxSize": "12KB" },
{ "path": "./dist/zxcvbn-common*.js", "maxSize": "226KB" }
]
Expand Down
1 change: 1 addition & 0 deletions packages/clerk-js/package.json
Original file line numberDiff line numberDiff line change
Expand Up@@ -91,6 +91,7 @@
"@solana/wallet-standard": "catalog:module-manager",
"@stripe/stripe-js": "5.6.0",
"@swc/helpers": "catalog:repo",
"@tanstack/query-core": "catalog:repo",
"@wallet-standard/core": "catalog:module-manager",
"@zxcvbn-ts/core": "catalog:module-manager",
"@zxcvbn-ts/language-common": "catalog:module-manager",
Expand Down
6 changes: 6 additions & 0 deletions packages/clerk-js/rspack.config.js
Original file line numberDiff line numberDiff line change
Expand Up@@ -110,6 +110,12 @@ const common = ({ mode, variant, disableRHC = false }) => {
chunks: 'all',
enforce: true,
},
queryCoreVendor: {
test: /[\\/]node_modules[\\/](@tanstack\/query-core)[\\/]/,
name: 'query-core-vendors',
chunks: 'all',
enforce: true,
},
defaultVendors: {
minChunks: 1,
test: module => {
Expand Down
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,75 @@
import { QueryClient } from '@tanstack/query-core';
import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest';

import { Clerk } from '../clerk';
import { Client, Environment } from '../resources/internal';

vi.mock('../resources/Client');
vi.mock('../resources/Environment');

vi.mock('../auth/devBrowser', () => ({
createDevBrowser: () => ({
clear: vi.fn(),
setup: vi.fn(),
getDevBrowser: vi.fn(() => 'deadbeef'),
setDevBrowser: vi.fn(),
removeDevBrowser: vi.fn(),
refreshCookies: vi.fn(),
}),
}));

Client.getOrCreateInstance = vi.fn().mockImplementation(() => ({ fetch: vi.fn() }));
Environment.getInstance = vi.fn().mockImplementation(() => ({ fetch: vi.fn(() => Promise.resolve({})) }));

const publishableKey = 'pk_test_Y2xlcmsuYWJjZWYuMTIzNDUuZGV2LmxjbGNsZXJrLmNvbSQ';

describe('Clerk __internal_queryClient (backward compat shim)', () => {
let clerk: Clerk;

beforeEach(() => {
clerk = new Clerk(publishableKey);
});

afterEach(() => {
vi.restoreAllMocks();
});

it('returns undefined before the lazy import resolves', () => {
expect(clerk.__internal_queryClient).toBeUndefined();
});

it('returns a tagged QueryClient after the lazy import resolves', async () => {
// Trigger the getter (fires the lazy import)
void clerk.__internal_queryClient;

// Wait for the dynamic import and QueryClient construction to settle
await vi.dynamicImportSettled();

const result = clerk.__internal_queryClient;
expect(result).toBeDefined();
expect(result!.__tag).toBe('clerk-rq-client');
expect(result!.client).toBeInstanceOf(QueryClient);
});

it('returns the same QueryClient instance on repeated access', async () => {
void clerk.__internal_queryClient;
await vi.dynamicImportSettled();

const first = clerk.__internal_queryClient;
const second = clerk.__internal_queryClient;
expect(first!.client).toBe(second!.client);
});

it('emits queryClientStatus event when the client is ready', async () => {
const listener = vi.fn();
// @ts-expect-error - queryClientStatus is not typed on clerk.on
clerk.on('queryClientStatus', listener);

void clerk.__internal_queryClient;
await vi.dynamicImportSettled();

expect(listener).toHaveBeenCalledWith('ready');
// @ts-expect-error
clerk.off('queryClientStatus', listener);
});
});
24 changes: 24 additions & 0 deletions packages/clerk-js/src/core/clerk.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -140,6 +140,7 @@ import type {
import type { ClerkUI } from '@clerk/shared/ui';
import { addClerkPrefix, isAbsoluteUrl, stripScheme } from '@clerk/shared/url';
import { allSettled, handleValueOrFn, noop } from '@clerk/shared/utils';
import type { QueryClient } from '@tanstack/query-core';

import { debugLogger, initDebugLogger } from '@/utils/debug';
import { ModuleManager } from '@/utils/moduleManager';
Expand DownExpand Up@@ -252,6 +253,7 @@ export class Clerk implements ClerkInterface {
// converted to protected environment to support `updateEnvironment` type assertion
protected environment?: EnvironmentResource | null;

#queryClient: QueryClient | undefined;
#publishableKey = '';
#domain: DomainOrProxyUrl['domain'];
#proxyUrl: DomainOrProxyUrl['proxyUrl'];
Expand All@@ -271,6 +273,28 @@ export class Clerk implements ClerkInterface {
#touchThrottledUntil = 0;
#publicEventBus = createClerkEventBus();

get __internal_queryClient(): { __tag: 'clerk-rq-client'; client: QueryClient } | undefined {
if (!this.#queryClient) {
void import('./query-core')
.then(module => module.QueryClient)
.then(QueryClient => {
if (this.#queryClient) {
return;
}
this.#queryClient = new QueryClient();
// @ts-expect-error - queryClientStatus is not typed
this.#publicEventBus.emit('queryClientStatus', 'ready');
});
}

return this.#queryClient
? {
__tag: 'clerk-rq-client',
client: this.#queryClient,
}
: undefined;
}

public __internal_getCachedResources:
| (() => Promise<{ client: ClientJSONSnapshot | null; environment: EnvironmentJSONSnapshot | null }>)
| undefined;
Expand Down
1 change: 1 addition & 0 deletions packages/clerk-js/src/core/query-core.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
export { QueryClient } from '@tanstack/query-core';
3 changes: 3 additions & 0 deletions pnpm-lock.yaml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

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); } })(); })(); fix(clerk-js): Restore internal queryClient for backward compat with older SDKs by wobsoriano · Pull Request #8562 · clerk/javascript · GitHub
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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/restore-internal-query-client.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/clerk-js': patch
---

Restore the `clerk.__internal_queryClient` getter as a backward-compatibility shim so apps still on `@clerk/shared < 4.10.0` can hydrate their query client and continue to render paginated hooks (e.g. `useOrganizationList`, `useOrganization`). The getter lazily imports `@tanstack/query-core` only when accessed, so apps on `@clerk/shared >= 4.10.0` (which use the singleton in `@clerk/shared`) pay zero runtime cost.
5 changes: 3 additions & 2 deletions packages/clerk-js/bundlewatch.config.json
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,15 @@
{
"files": [
{ "path": "./dist/clerk.js", "maxSize": "543KB" },
{ "path": "./dist/clerk.js", "maxSize": "549KB" },
{ "path": "./dist/clerk.browser.js", "maxSize": "70KB" },
{ "path": "./dist/clerk.legacy.browser.js", "maxSize": "112KB" },
{ "path": "./dist/clerk.no-rhc.js", "maxSize": "311KB" },
{ "path": "./dist/clerk.no-rhc.js", "maxSize": "316KB" },
{ "path": "./dist/clerk.native.js", "maxSize": "70KB" },
{ "path": "./dist/vendors*.js", "maxSize": "7KB" },
{ "path": "./dist/coinbase*.js", "maxSize": "36KB" },
{ "path": "./dist/base-account-sdk*.js", "maxSize": "203KB" },
{ "path": "./dist/stripe-vendors*.js", "maxSize": "1KB" },
{ "path": "./dist/query-core-vendors*.js", "maxSize": "11KB" },
{ "path": "./dist/zxcvbn-ts-core*.js", "maxSize": "12KB" },
{ "path": "./dist/zxcvbn-common*.js", "maxSize": "226KB" }
]
Expand Down
1 change: 1 addition & 0 deletions packages/clerk-js/package.json
Original file line numberDiff line numberDiff line change
Expand Up@@ -91,6 +91,7 @@
"@solana/wallet-standard": "catalog:module-manager",
"@stripe/stripe-js": "5.6.0",
"@swc/helpers": "catalog:repo",
"@tanstack/query-core": "catalog:repo",
"@wallet-standard/core": "catalog:module-manager",
"@zxcvbn-ts/core": "catalog:module-manager",
"@zxcvbn-ts/language-common": "catalog:module-manager",
Expand Down
6 changes: 6 additions & 0 deletions packages/clerk-js/rspack.config.js
Original file line numberDiff line numberDiff line change
Expand Up@@ -110,6 +110,12 @@ const common = ({ mode, variant, disableRHC = false }) => {
chunks: 'all',
enforce: true,
},
queryCoreVendor: {
test: /[\\/]node_modules[\\/](@tanstack\/query-core)[\\/]/,
name: 'query-core-vendors',
chunks: 'all',
enforce: true,
},
defaultVendors: {
minChunks: 1,
test: module => {
Expand Down
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,75 @@
import { QueryClient } from '@tanstack/query-core';
import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest';

import { Clerk } from '../clerk';
import { Client, Environment } from '../resources/internal';

vi.mock('../resources/Client');
vi.mock('../resources/Environment');

vi.mock('../auth/devBrowser', () => ({
createDevBrowser: () => ({
clear: vi.fn(),
setup: vi.fn(),
getDevBrowser: vi.fn(() => 'deadbeef'),
setDevBrowser: vi.fn(),
removeDevBrowser: vi.fn(),
refreshCookies: vi.fn(),
}),
}));

Client.getOrCreateInstance = vi.fn().mockImplementation(() => ({ fetch: vi.fn() }));
Environment.getInstance = vi.fn().mockImplementation(() => ({ fetch: vi.fn(() => Promise.resolve({})) }));

const publishableKey = 'pk_test_Y2xlcmsuYWJjZWYuMTIzNDUuZGV2LmxjbGNsZXJrLmNvbSQ';

describe('Clerk __internal_queryClient (backward compat shim)', () => {
let clerk: Clerk;

beforeEach(() => {
clerk = new Clerk(publishableKey);
});

afterEach(() => {
vi.restoreAllMocks();
});

it('returns undefined before the lazy import resolves', () => {
expect(clerk.__internal_queryClient).toBeUndefined();
});

it('returns a tagged QueryClient after the lazy import resolves', async () => {
// Trigger the getter (fires the lazy import)
void clerk.__internal_queryClient;

// Wait for the dynamic import and QueryClient construction to settle
await vi.dynamicImportSettled();

const result = clerk.__internal_queryClient;
expect(result).toBeDefined();
expect(result!.__tag).toBe('clerk-rq-client');
expect(result!.client).toBeInstanceOf(QueryClient);
});

it('returns the same QueryClient instance on repeated access', async () => {
void clerk.__internal_queryClient;
await vi.dynamicImportSettled();

const first = clerk.__internal_queryClient;
const second = clerk.__internal_queryClient;
expect(first!.client).toBe(second!.client);
});

it('emits queryClientStatus event when the client is ready', async () => {
const listener = vi.fn();
// @ts-expect-error - queryClientStatus is not typed on clerk.on
clerk.on('queryClientStatus', listener);

void clerk.__internal_queryClient;
await vi.dynamicImportSettled();

expect(listener).toHaveBeenCalledWith('ready');
// @ts-expect-error
clerk.off('queryClientStatus', listener);
});
});
24 changes: 24 additions & 0 deletions packages/clerk-js/src/core/clerk.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -140,6 +140,7 @@ import type {
import type { ClerkUI } from '@clerk/shared/ui';
import { addClerkPrefix, isAbsoluteUrl, stripScheme } from '@clerk/shared/url';
import { allSettled, handleValueOrFn, noop } from '@clerk/shared/utils';
import type { QueryClient } from '@tanstack/query-core';

import { debugLogger, initDebugLogger } from '@/utils/debug';
import { ModuleManager } from '@/utils/moduleManager';
Expand DownExpand Up@@ -252,6 +253,7 @@ export class Clerk implements ClerkInterface {
// converted to protected environment to support `updateEnvironment` type assertion
protected environment?: EnvironmentResource | null;

#queryClient: QueryClient | undefined;
#publishableKey = '';
#domain: DomainOrProxyUrl['domain'];
#proxyUrl: DomainOrProxyUrl['proxyUrl'];
Expand All@@ -271,6 +273,28 @@ export class Clerk implements ClerkInterface {
#touchThrottledUntil = 0;
#publicEventBus = createClerkEventBus();

get __internal_queryClient(): { __tag: 'clerk-rq-client'; client: QueryClient } | undefined {
if (!this.#queryClient) {
void import('./query-core')
.then(module => module.QueryClient)
.then(QueryClient => {
if (this.#queryClient) {
return;
}
this.#queryClient = new QueryClient();
// @ts-expect-error - queryClientStatus is not typed
this.#publicEventBus.emit('queryClientStatus', 'ready');
});
}

return this.#queryClient
? {
__tag: 'clerk-rq-client',
client: this.#queryClient,
}
: undefined;
}

public __internal_getCachedResources:
| (() => Promise<{ client: ClientJSONSnapshot | null; environment: EnvironmentJSONSnapshot | null }>)
| undefined;
Expand Down
1 change: 1 addition & 0 deletions packages/clerk-js/src/core/query-core.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
export { QueryClient } from '@tanstack/query-core';
3 changes: 3 additions & 0 deletions pnpm-lock.yaml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading