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
7 changes: 7 additions & 0 deletions .changeset/clerk-ui-version.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
---
'@clerk/clerk-js': minor
'@clerk/shared': minor
'@clerk/react': minor
Comment on lines +2 to +4

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Should it just be a patch bump maybe?

---

Expose the loaded `@clerk/ui` version on the `Clerk` object via a new `uiVersion` property. It returns the version of the prebuilt UI bundle once it has loaded (for example `Clerk.uiVersion` in the browser console), or `undefined` if the UI has not been loaded yet. `@clerk/clerk-js` and `@clerk/ui` are versioned and loaded independently, so `uiVersion` can differ from `Clerk.version`.
1 change: 1 addition & 0 deletions .typedoc/__tests__/__snapshots__/clerk-properties.mdx
Original file line numberDiff line numberDiff line change
Expand Up@@ -17,5 +17,6 @@
| <a id="session"></a> `session` | <code>undefined \| null \| [SignedInSessionResource](/docs/reference/objects/session)</code> | The currently active `Session`, which is guaranteed to be one of the sessions in `Client.sessions`. If there is no active session, this field will be `null`. If the session is loading, this field will be `undefined`. |
| <a id="status"></a> `status` | <code>"error" \| "degraded" \| "loading" \| "ready"</code> | The status of the `Clerk` instance. Possible values are: <ul> <li>`"error"`: Set when hotloading `clerk-js` or `Clerk.load()` failed.</li> <li>`"loading"`: Set during initialization.</li> <li>`"ready"`: Set when Clerk is fully operational.</li> <li>`"degraded"`: Set when Clerk is partially operational.</li> </ul> |
| <a id="telemetry"></a> `telemetry` | <code>undefined \| \{ isDebug: boolean; isEnabled: boolean; record: void; recordLog: void; \}</code> | [Telemetry](/docs/guides/how-clerk-works/security/clerk-telemetry) configuration. |
| <a id="uiversion"></a> `uiVersion` | <code>undefined \| string</code> | The version of `@clerk/ui` that is currently loaded, or `undefined` if the prebuilt UI has not been loaded yet. |
| <a id="user"></a> `user` | <code>undefined \| null \| [UserResource](/docs/reference/objects/user)</code> | A shortcut to `Session.user` which holds the currently active `User` object. If the session is `null` or `undefined`, the user field will match. |
| <a id="version"></a> `version` | <code>undefined \| string</code> | The Clerk SDK version number. |
55 changes: 55 additions & 0 deletions packages/clerk-js/src/core/__tests__/clerk.ui-version.test.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
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.uiVersion', () => {
let clerk: Clerk;

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

afterEach(() => {
delete (window as any).__internal_ClerkUICtor;
vi.restoreAllMocks();
});

it('exposes the property on the instance', () => {
expect('uiVersion' in clerk).toBe(true);
});

it('returns undefined when the @clerk/ui bundle has not loaded', () => {
expect((window as any).__internal_ClerkUICtor).toBeUndefined();
expect(clerk.uiVersion).toBeUndefined();
});

it('returns the version published by the loaded @clerk/ui constructor', () => {
(window as any).__internal_ClerkUICtor = { version: '1.18.1' };
expect(clerk.uiVersion).toBe('1.18.1');
});

it('reports a UI version independent of the clerk-js version', () => {
(window as any).__internal_ClerkUICtor = { version: '1.18.1' };
expect(clerk.uiVersion).not.toBe(clerk.version);
});
});
8 changes: 8 additions & 0 deletions packages/clerk-js/src/core/clerk.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -337,6 +337,14 @@ export class Clerk implements ClerkInterface {
return Clerk.version;
}

get uiVersion(): string | undefined {
// `@clerk/ui` publishes its constructor (which carries its package version) on this global when hot-loaded
// from the CDN; bundled (no-RHC) builds pass the constructor directly via `options.ui.ClerkUI` instead.
const globalCtor = typeof window !== 'undefined' ? window.__internal_ClerkUICtor : undefined;
const bundledCtor = this.#options.ui?.ClerkUI;
return globalCtor?.version ?? (bundledCtor instanceof Promise ? undefined : bundledCtor?.version);
}

set sdkMetadata(metadata: SDKMetadata) {
Clerk.sdkMetadata = metadata;
}
Expand Down
4 changes: 4 additions & 0 deletions packages/react/src/isomorphicClerk.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -776,6 +776,10 @@ export class IsomorphicClerk implements IsomorphicLoadedClerk {
return this.clerkjs?.version;
}

get uiVersion(): string | undefined {
return this.clerkjs?.uiVersion;
}

get client(): ClientResource | undefined {
if (this.clerkjs) {
return this.clerkjs.client;
Expand Down
5 changes: 5 additions & 0 deletions packages/shared/src/types/clerk.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -256,6 +256,11 @@ export interface Clerk {
*/
version: string | undefined;

/**
* The version of `@clerk/ui` that is currently loaded, or `undefined` if the prebuilt UI has not been loaded yet.
*/
uiVersion: string | undefined;

/**
* If present, contains information about the SDK that the host application is using.
* For example, if Clerk is loaded through `@clerk/nextjs`, this would be `{ name: '@clerk/nextjs', version: '1.0.0' }`. You don't need to set this value yourself unless you're [developing an SDK](https://clerk.com/docs/guides/development/sdk-development/overview).
Expand Down
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(js): expose loaded @clerk/ui version via Clerk.uiVersion by jacekradko · Pull Request #8931 · 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
7 changes: 7 additions & 0 deletions .changeset/clerk-ui-version.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
---
'@clerk/clerk-js': minor
'@clerk/shared': minor
'@clerk/react': minor
Comment on lines +2 to +4

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Should it just be a patch bump maybe?

---

Expose the loaded `@clerk/ui` version on the `Clerk` object via a new `uiVersion` property. It returns the version of the prebuilt UI bundle once it has loaded (for example `Clerk.uiVersion` in the browser console), or `undefined` if the UI has not been loaded yet. `@clerk/clerk-js` and `@clerk/ui` are versioned and loaded independently, so `uiVersion` can differ from `Clerk.version`.
1 change: 1 addition & 0 deletions .typedoc/__tests__/__snapshots__/clerk-properties.mdx
Original file line numberDiff line numberDiff line change
Expand Up@@ -17,5 +17,6 @@
| <a id="session"></a> `session` | <code>undefined \| null \| [SignedInSessionResource](/docs/reference/objects/session)</code> | The currently active `Session`, which is guaranteed to be one of the sessions in `Client.sessions`. If there is no active session, this field will be `null`. If the session is loading, this field will be `undefined`. |
| <a id="status"></a> `status` | <code>"error" \| "degraded" \| "loading" \| "ready"</code> | The status of the `Clerk` instance. Possible values are: <ul> <li>`"error"`: Set when hotloading `clerk-js` or `Clerk.load()` failed.</li> <li>`"loading"`: Set during initialization.</li> <li>`"ready"`: Set when Clerk is fully operational.</li> <li>`"degraded"`: Set when Clerk is partially operational.</li> </ul> |
| <a id="telemetry"></a> `telemetry` | <code>undefined \| \{ isDebug: boolean; isEnabled: boolean; record: void; recordLog: void; \}</code> | [Telemetry](/docs/guides/how-clerk-works/security/clerk-telemetry) configuration. |
| <a id="uiversion"></a> `uiVersion` | <code>undefined \| string</code> | The version of `@clerk/ui` that is currently loaded, or `undefined` if the prebuilt UI has not been loaded yet. |
| <a id="user"></a> `user` | <code>undefined \| null \| [UserResource](/docs/reference/objects/user)</code> | A shortcut to `Session.user` which holds the currently active `User` object. If the session is `null` or `undefined`, the user field will match. |
| <a id="version"></a> `version` | <code>undefined \| string</code> | The Clerk SDK version number. |
55 changes: 55 additions & 0 deletions packages/clerk-js/src/core/__tests__/clerk.ui-version.test.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
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.uiVersion', () => {
let clerk: Clerk;

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

afterEach(() => {
delete (window as any).__internal_ClerkUICtor;
vi.restoreAllMocks();
});

it('exposes the property on the instance', () => {
expect('uiVersion' in clerk).toBe(true);
});

it('returns undefined when the @clerk/ui bundle has not loaded', () => {
expect((window as any).__internal_ClerkUICtor).toBeUndefined();
expect(clerk.uiVersion).toBeUndefined();
});

it('returns the version published by the loaded @clerk/ui constructor', () => {
(window as any).__internal_ClerkUICtor = { version: '1.18.1' };
expect(clerk.uiVersion).toBe('1.18.1');
});

it('reports a UI version independent of the clerk-js version', () => {
(window as any).__internal_ClerkUICtor = { version: '1.18.1' };
expect(clerk.uiVersion).not.toBe(clerk.version);
});
});
8 changes: 8 additions & 0 deletions packages/clerk-js/src/core/clerk.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -337,6 +337,14 @@ export class Clerk implements ClerkInterface {
return Clerk.version;
}

get uiVersion(): string | undefined {
// `@clerk/ui` publishes its constructor (which carries its package version) on this global when hot-loaded
// from the CDN; bundled (no-RHC) builds pass the constructor directly via `options.ui.ClerkUI` instead.
const globalCtor = typeof window !== 'undefined' ? window.__internal_ClerkUICtor : undefined;
const bundledCtor = this.#options.ui?.ClerkUI;
return globalCtor?.version ?? (bundledCtor instanceof Promise ? undefined : bundledCtor?.version);
}

set sdkMetadata(metadata: SDKMetadata) {
Clerk.sdkMetadata = metadata;
}
Expand Down
4 changes: 4 additions & 0 deletions packages/react/src/isomorphicClerk.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -776,6 +776,10 @@ export class IsomorphicClerk implements IsomorphicLoadedClerk {
return this.clerkjs?.version;
}

get uiVersion(): string | undefined {
return this.clerkjs?.uiVersion;
}

get client(): ClientResource | undefined {
if (this.clerkjs) {
return this.clerkjs.client;
Expand Down
5 changes: 5 additions & 0 deletions packages/shared/src/types/clerk.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -256,6 +256,11 @@ export interface Clerk {
*/
version: string | undefined;

/**
* The version of `@clerk/ui` that is currently loaded, or `undefined` if the prebuilt UI has not been loaded yet.
*/
uiVersion: string | undefined;

/**
* If present, contains information about the SDK that the host application is using.
* For example, if Clerk is loaded through `@clerk/nextjs`, this would be `{ name: '@clerk/nextjs', version: '1.0.0' }`. You don't need to set this value yourself unless you're [developing an SDK](https://clerk.com/docs/guides/development/sdk-development/overview).
Expand Down
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(js): expose loaded @clerk/ui version via Clerk.uiVersion by jacekradko · Pull Request #8931 · 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
7 changes: 7 additions & 0 deletions .changeset/clerk-ui-version.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
---
'@clerk/clerk-js': minor
'@clerk/shared': minor
'@clerk/react': minor
Comment on lines +2 to +4

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Should it just be a patch bump maybe?

---

Expose the loaded `@clerk/ui` version on the `Clerk` object via a new `uiVersion` property. It returns the version of the prebuilt UI bundle once it has loaded (for example `Clerk.uiVersion` in the browser console), or `undefined` if the UI has not been loaded yet. `@clerk/clerk-js` and `@clerk/ui` are versioned and loaded independently, so `uiVersion` can differ from `Clerk.version`.
1 change: 1 addition & 0 deletions .typedoc/__tests__/__snapshots__/clerk-properties.mdx
Original file line numberDiff line numberDiff line change
Expand Up@@ -17,5 +17,6 @@
| <a id="session"></a> `session` | <code>undefined \| null \| [SignedInSessionResource](/docs/reference/objects/session)</code> | The currently active `Session`, which is guaranteed to be one of the sessions in `Client.sessions`. If there is no active session, this field will be `null`. If the session is loading, this field will be `undefined`. |
| <a id="status"></a> `status` | <code>"error" \| "degraded" \| "loading" \| "ready"</code> | The status of the `Clerk` instance. Possible values are: <ul> <li>`"error"`: Set when hotloading `clerk-js` or `Clerk.load()` failed.</li> <li>`"loading"`: Set during initialization.</li> <li>`"ready"`: Set when Clerk is fully operational.</li> <li>`"degraded"`: Set when Clerk is partially operational.</li> </ul> |
| <a id="telemetry"></a> `telemetry` | <code>undefined \| \{ isDebug: boolean; isEnabled: boolean; record: void; recordLog: void; \}</code> | [Telemetry](/docs/guides/how-clerk-works/security/clerk-telemetry) configuration. |
| <a id="uiversion"></a> `uiVersion` | <code>undefined \| string</code> | The version of `@clerk/ui` that is currently loaded, or `undefined` if the prebuilt UI has not been loaded yet. |
| <a id="user"></a> `user` | <code>undefined \| null \| [UserResource](/docs/reference/objects/user)</code> | A shortcut to `Session.user` which holds the currently active `User` object. If the session is `null` or `undefined`, the user field will match. |
| <a id="version"></a> `version` | <code>undefined \| string</code> | The Clerk SDK version number. |
55 changes: 55 additions & 0 deletions packages/clerk-js/src/core/__tests__/clerk.ui-version.test.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
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.uiVersion', () => {
let clerk: Clerk;

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

afterEach(() => {
delete (window as any).__internal_ClerkUICtor;
vi.restoreAllMocks();
});

it('exposes the property on the instance', () => {
expect('uiVersion' in clerk).toBe(true);
});

it('returns undefined when the @clerk/ui bundle has not loaded', () => {
expect((window as any).__internal_ClerkUICtor).toBeUndefined();
expect(clerk.uiVersion).toBeUndefined();
});

it('returns the version published by the loaded @clerk/ui constructor', () => {
(window as any).__internal_ClerkUICtor = { version: '1.18.1' };
expect(clerk.uiVersion).toBe('1.18.1');
});

it('reports a UI version independent of the clerk-js version', () => {
(window as any).__internal_ClerkUICtor = { version: '1.18.1' };
expect(clerk.uiVersion).not.toBe(clerk.version);
});
});
8 changes: 8 additions & 0 deletions packages/clerk-js/src/core/clerk.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -337,6 +337,14 @@ export class Clerk implements ClerkInterface {
return Clerk.version;
}

get uiVersion(): string | undefined {
// `@clerk/ui` publishes its constructor (which carries its package version) on this global when hot-loaded
// from the CDN; bundled (no-RHC) builds pass the constructor directly via `options.ui.ClerkUI` instead.
const globalCtor = typeof window !== 'undefined' ? window.__internal_ClerkUICtor : undefined;
const bundledCtor = this.#options.ui?.ClerkUI;
return globalCtor?.version ?? (bundledCtor instanceof Promise ? undefined : bundledCtor?.version);
}

set sdkMetadata(metadata: SDKMetadata) {
Clerk.sdkMetadata = metadata;
}
Expand Down
4 changes: 4 additions & 0 deletions packages/react/src/isomorphicClerk.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -776,6 +776,10 @@ export class IsomorphicClerk implements IsomorphicLoadedClerk {
return this.clerkjs?.version;
}

get uiVersion(): string | undefined {
return this.clerkjs?.uiVersion;
}

get client(): ClientResource | undefined {
if (this.clerkjs) {
return this.clerkjs.client;
Expand Down
5 changes: 5 additions & 0 deletions packages/shared/src/types/clerk.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -256,6 +256,11 @@ export interface Clerk {
*/
version: string | undefined;

/**
* The version of `@clerk/ui` that is currently loaded, or `undefined` if the prebuilt UI has not been loaded yet.
*/
uiVersion: string | undefined;

/**
* If present, contains information about the SDK that the host application is using.
* For example, if Clerk is loaded through `@clerk/nextjs`, this would be `{ name: '@clerk/nextjs', version: '1.0.0' }`. You don't need to set this value yourself unless you're [developing an SDK](https://clerk.com/docs/guides/development/sdk-development/overview).
Expand Down
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(js): expose loaded @clerk/ui version via Clerk.uiVersion by jacekradko · Pull Request #8931 · 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
7 changes: 7 additions & 0 deletions .changeset/clerk-ui-version.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
---
'@clerk/clerk-js': minor
'@clerk/shared': minor
'@clerk/react': minor
Comment on lines +2 to +4

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Should it just be a patch bump maybe?

---

Expose the loaded `@clerk/ui` version on the `Clerk` object via a new `uiVersion` property. It returns the version of the prebuilt UI bundle once it has loaded (for example `Clerk.uiVersion` in the browser console), or `undefined` if the UI has not been loaded yet. `@clerk/clerk-js` and `@clerk/ui` are versioned and loaded independently, so `uiVersion` can differ from `Clerk.version`.
1 change: 1 addition & 0 deletions .typedoc/__tests__/__snapshots__/clerk-properties.mdx
Original file line numberDiff line numberDiff line change
Expand Up@@ -17,5 +17,6 @@
| <a id="session"></a> `session` | <code>undefined \| null \| [SignedInSessionResource](/docs/reference/objects/session)</code> | The currently active `Session`, which is guaranteed to be one of the sessions in `Client.sessions`. If there is no active session, this field will be `null`. If the session is loading, this field will be `undefined`. |
| <a id="status"></a> `status` | <code>"error" \| "degraded" \| "loading" \| "ready"</code> | The status of the `Clerk` instance. Possible values are: <ul> <li>`"error"`: Set when hotloading `clerk-js` or `Clerk.load()` failed.</li> <li>`"loading"`: Set during initialization.</li> <li>`"ready"`: Set when Clerk is fully operational.</li> <li>`"degraded"`: Set when Clerk is partially operational.</li> </ul> |
| <a id="telemetry"></a> `telemetry` | <code>undefined \| \{ isDebug: boolean; isEnabled: boolean; record: void; recordLog: void; \}</code> | [Telemetry](/docs/guides/how-clerk-works/security/clerk-telemetry) configuration. |
| <a id="uiversion"></a> `uiVersion` | <code>undefined \| string</code> | The version of `@clerk/ui` that is currently loaded, or `undefined` if the prebuilt UI has not been loaded yet. |
| <a id="user"></a> `user` | <code>undefined \| null \| [UserResource](/docs/reference/objects/user)</code> | A shortcut to `Session.user` which holds the currently active `User` object. If the session is `null` or `undefined`, the user field will match. |
| <a id="version"></a> `version` | <code>undefined \| string</code> | The Clerk SDK version number. |
55 changes: 55 additions & 0 deletions packages/clerk-js/src/core/__tests__/clerk.ui-version.test.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
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.uiVersion', () => {
let clerk: Clerk;

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

afterEach(() => {
delete (window as any).__internal_ClerkUICtor;
vi.restoreAllMocks();
});

it('exposes the property on the instance', () => {
expect('uiVersion' in clerk).toBe(true);
});

it('returns undefined when the @clerk/ui bundle has not loaded', () => {
expect((window as any).__internal_ClerkUICtor).toBeUndefined();
expect(clerk.uiVersion).toBeUndefined();
});

it('returns the version published by the loaded @clerk/ui constructor', () => {
(window as any).__internal_ClerkUICtor = { version: '1.18.1' };
expect(clerk.uiVersion).toBe('1.18.1');
});

it('reports a UI version independent of the clerk-js version', () => {
(window as any).__internal_ClerkUICtor = { version: '1.18.1' };
expect(clerk.uiVersion).not.toBe(clerk.version);
});
});
8 changes: 8 additions & 0 deletions packages/clerk-js/src/core/clerk.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -337,6 +337,14 @@ export class Clerk implements ClerkInterface {
return Clerk.version;
}

get uiVersion(): string | undefined {
// `@clerk/ui` publishes its constructor (which carries its package version) on this global when hot-loaded
// from the CDN; bundled (no-RHC) builds pass the constructor directly via `options.ui.ClerkUI` instead.
const globalCtor = typeof window !== 'undefined' ? window.__internal_ClerkUICtor : undefined;
const bundledCtor = this.#options.ui?.ClerkUI;
return globalCtor?.version ?? (bundledCtor instanceof Promise ? undefined : bundledCtor?.version);
}

set sdkMetadata(metadata: SDKMetadata) {
Clerk.sdkMetadata = metadata;
}
Expand Down
4 changes: 4 additions & 0 deletions packages/react/src/isomorphicClerk.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -776,6 +776,10 @@ export class IsomorphicClerk implements IsomorphicLoadedClerk {
return this.clerkjs?.version;
}

get uiVersion(): string | undefined {
return this.clerkjs?.uiVersion;
}

get client(): ClientResource | undefined {
if (this.clerkjs) {
return this.clerkjs.client;
Expand Down
5 changes: 5 additions & 0 deletions packages/shared/src/types/clerk.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -256,6 +256,11 @@ export interface Clerk {
*/
version: string | undefined;

/**
* The version of `@clerk/ui` that is currently loaded, or `undefined` if the prebuilt UI has not been loaded yet.
*/
uiVersion: string | undefined;

/**
* If present, contains information about the SDK that the host application is using.
* For example, if Clerk is loaded through `@clerk/nextjs`, this would be `{ name: '@clerk/nextjs', version: '1.0.0' }`. You don't need to set this value yourself unless you're [developing an SDK](https://clerk.com/docs/guides/development/sdk-development/overview).
Expand Down
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(js): expose loaded @clerk/ui version via Clerk.uiVersion by jacekradko · Pull Request #8931 · 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
7 changes: 7 additions & 0 deletions .changeset/clerk-ui-version.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
---
'@clerk/clerk-js': minor
'@clerk/shared': minor
'@clerk/react': minor
Comment on lines +2 to +4

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Should it just be a patch bump maybe?

---

Expose the loaded `@clerk/ui` version on the `Clerk` object via a new `uiVersion` property. It returns the version of the prebuilt UI bundle once it has loaded (for example `Clerk.uiVersion` in the browser console), or `undefined` if the UI has not been loaded yet. `@clerk/clerk-js` and `@clerk/ui` are versioned and loaded independently, so `uiVersion` can differ from `Clerk.version`.
1 change: 1 addition & 0 deletions .typedoc/__tests__/__snapshots__/clerk-properties.mdx
Original file line numberDiff line numberDiff line change
Expand Up@@ -17,5 +17,6 @@
| <a id="session"></a> `session` | <code>undefined \| null \| [SignedInSessionResource](/docs/reference/objects/session)</code> | The currently active `Session`, which is guaranteed to be one of the sessions in `Client.sessions`. If there is no active session, this field will be `null`. If the session is loading, this field will be `undefined`. |
| <a id="status"></a> `status` | <code>"error" \| "degraded" \| "loading" \| "ready"</code> | The status of the `Clerk` instance. Possible values are: <ul> <li>`"error"`: Set when hotloading `clerk-js` or `Clerk.load()` failed.</li> <li>`"loading"`: Set during initialization.</li> <li>`"ready"`: Set when Clerk is fully operational.</li> <li>`"degraded"`: Set when Clerk is partially operational.</li> </ul> |
| <a id="telemetry"></a> `telemetry` | <code>undefined \| \{ isDebug: boolean; isEnabled: boolean; record: void; recordLog: void; \}</code> | [Telemetry](/docs/guides/how-clerk-works/security/clerk-telemetry) configuration. |
| <a id="uiversion"></a> `uiVersion` | <code>undefined \| string</code> | The version of `@clerk/ui` that is currently loaded, or `undefined` if the prebuilt UI has not been loaded yet. |
| <a id="user"></a> `user` | <code>undefined \| null \| [UserResource](/docs/reference/objects/user)</code> | A shortcut to `Session.user` which holds the currently active `User` object. If the session is `null` or `undefined`, the user field will match. |
| <a id="version"></a> `version` | <code>undefined \| string</code> | The Clerk SDK version number. |
55 changes: 55 additions & 0 deletions packages/clerk-js/src/core/__tests__/clerk.ui-version.test.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
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.uiVersion', () => {
let clerk: Clerk;

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

afterEach(() => {
delete (window as any).__internal_ClerkUICtor;
vi.restoreAllMocks();
});

it('exposes the property on the instance', () => {
expect('uiVersion' in clerk).toBe(true);
});

it('returns undefined when the @clerk/ui bundle has not loaded', () => {
expect((window as any).__internal_ClerkUICtor).toBeUndefined();
expect(clerk.uiVersion).toBeUndefined();
});

it('returns the version published by the loaded @clerk/ui constructor', () => {
(window as any).__internal_ClerkUICtor = { version: '1.18.1' };
expect(clerk.uiVersion).toBe('1.18.1');
});

it('reports a UI version independent of the clerk-js version', () => {
(window as any).__internal_ClerkUICtor = { version: '1.18.1' };
expect(clerk.uiVersion).not.toBe(clerk.version);
});
});
8 changes: 8 additions & 0 deletions packages/clerk-js/src/core/clerk.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -337,6 +337,14 @@ export class Clerk implements ClerkInterface {
return Clerk.version;
}

get uiVersion(): string | undefined {
// `@clerk/ui` publishes its constructor (which carries its package version) on this global when hot-loaded
// from the CDN; bundled (no-RHC) builds pass the constructor directly via `options.ui.ClerkUI` instead.
const globalCtor = typeof window !== 'undefined' ? window.__internal_ClerkUICtor : undefined;
const bundledCtor = this.#options.ui?.ClerkUI;
return globalCtor?.version ?? (bundledCtor instanceof Promise ? undefined : bundledCtor?.version);
}

set sdkMetadata(metadata: SDKMetadata) {
Clerk.sdkMetadata = metadata;
}
Expand Down
4 changes: 4 additions & 0 deletions packages/react/src/isomorphicClerk.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -776,6 +776,10 @@ export class IsomorphicClerk implements IsomorphicLoadedClerk {
return this.clerkjs?.version;
}

get uiVersion(): string | undefined {
return this.clerkjs?.uiVersion;
}

get client(): ClientResource | undefined {
if (this.clerkjs) {
return this.clerkjs.client;
Expand Down
5 changes: 5 additions & 0 deletions packages/shared/src/types/clerk.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -256,6 +256,11 @@ export interface Clerk {
*/
version: string | undefined;

/**
* The version of `@clerk/ui` that is currently loaded, or `undefined` if the prebuilt UI has not been loaded yet.
*/
uiVersion: string | undefined;

/**
* If present, contains information about the SDK that the host application is using.
* For example, if Clerk is loaded through `@clerk/nextjs`, this would be `{ name: '@clerk/nextjs', version: '1.0.0' }`. You don't need to set this value yourself unless you're [developing an SDK](https://clerk.com/docs/guides/development/sdk-development/overview).
Expand Down
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(js): expose loaded @clerk/ui version via Clerk.uiVersion by jacekradko · Pull Request #8931 · 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
7 changes: 7 additions & 0 deletions .changeset/clerk-ui-version.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
---
'@clerk/clerk-js': minor
'@clerk/shared': minor
'@clerk/react': minor
Comment on lines +2 to +4

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Should it just be a patch bump maybe?

---

Expose the loaded `@clerk/ui` version on the `Clerk` object via a new `uiVersion` property. It returns the version of the prebuilt UI bundle once it has loaded (for example `Clerk.uiVersion` in the browser console), or `undefined` if the UI has not been loaded yet. `@clerk/clerk-js` and `@clerk/ui` are versioned and loaded independently, so `uiVersion` can differ from `Clerk.version`.
1 change: 1 addition & 0 deletions .typedoc/__tests__/__snapshots__/clerk-properties.mdx
Original file line numberDiff line numberDiff line change
Expand Up@@ -17,5 +17,6 @@
| <a id="session"></a> `session` | <code>undefined \| null \| [SignedInSessionResource](/docs/reference/objects/session)</code> | The currently active `Session`, which is guaranteed to be one of the sessions in `Client.sessions`. If there is no active session, this field will be `null`. If the session is loading, this field will be `undefined`. |
| <a id="status"></a> `status` | <code>"error" \| "degraded" \| "loading" \| "ready"</code> | The status of the `Clerk` instance. Possible values are: <ul> <li>`"error"`: Set when hotloading `clerk-js` or `Clerk.load()` failed.</li> <li>`"loading"`: Set during initialization.</li> <li>`"ready"`: Set when Clerk is fully operational.</li> <li>`"degraded"`: Set when Clerk is partially operational.</li> </ul> |
| <a id="telemetry"></a> `telemetry` | <code>undefined \| \{ isDebug: boolean; isEnabled: boolean; record: void; recordLog: void; \}</code> | [Telemetry](/docs/guides/how-clerk-works/security/clerk-telemetry) configuration. |
| <a id="uiversion"></a> `uiVersion` | <code>undefined \| string</code> | The version of `@clerk/ui` that is currently loaded, or `undefined` if the prebuilt UI has not been loaded yet. |
| <a id="user"></a> `user` | <code>undefined \| null \| [UserResource](/docs/reference/objects/user)</code> | A shortcut to `Session.user` which holds the currently active `User` object. If the session is `null` or `undefined`, the user field will match. |
| <a id="version"></a> `version` | <code>undefined \| string</code> | The Clerk SDK version number. |
55 changes: 55 additions & 0 deletions packages/clerk-js/src/core/__tests__/clerk.ui-version.test.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
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.uiVersion', () => {
let clerk: Clerk;

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

afterEach(() => {
delete (window as any).__internal_ClerkUICtor;
vi.restoreAllMocks();
});

it('exposes the property on the instance', () => {
expect('uiVersion' in clerk).toBe(true);
});

it('returns undefined when the @clerk/ui bundle has not loaded', () => {
expect((window as any).__internal_ClerkUICtor).toBeUndefined();
expect(clerk.uiVersion).toBeUndefined();
});

it('returns the version published by the loaded @clerk/ui constructor', () => {
(window as any).__internal_ClerkUICtor = { version: '1.18.1' };
expect(clerk.uiVersion).toBe('1.18.1');
});

it('reports a UI version independent of the clerk-js version', () => {
(window as any).__internal_ClerkUICtor = { version: '1.18.1' };
expect(clerk.uiVersion).not.toBe(clerk.version);
});
});
8 changes: 8 additions & 0 deletions packages/clerk-js/src/core/clerk.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -337,6 +337,14 @@ export class Clerk implements ClerkInterface {
return Clerk.version;
}

get uiVersion(): string | undefined {
// `@clerk/ui` publishes its constructor (which carries its package version) on this global when hot-loaded
// from the CDN; bundled (no-RHC) builds pass the constructor directly via `options.ui.ClerkUI` instead.
const globalCtor = typeof window !== 'undefined' ? window.__internal_ClerkUICtor : undefined;
const bundledCtor = this.#options.ui?.ClerkUI;
return globalCtor?.version ?? (bundledCtor instanceof Promise ? undefined : bundledCtor?.version);
}

set sdkMetadata(metadata: SDKMetadata) {
Clerk.sdkMetadata = metadata;
}
Expand Down
4 changes: 4 additions & 0 deletions packages/react/src/isomorphicClerk.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -776,6 +776,10 @@ export class IsomorphicClerk implements IsomorphicLoadedClerk {
return this.clerkjs?.version;
}

get uiVersion(): string | undefined {
return this.clerkjs?.uiVersion;
}

get client(): ClientResource | undefined {
if (this.clerkjs) {
return this.clerkjs.client;
Expand Down
5 changes: 5 additions & 0 deletions packages/shared/src/types/clerk.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -256,6 +256,11 @@ export interface Clerk {
*/
version: string | undefined;

/**
* The version of `@clerk/ui` that is currently loaded, or `undefined` if the prebuilt UI has not been loaded yet.
*/
uiVersion: string | undefined;

/**
* If present, contains information about the SDK that the host application is using.
* For example, if Clerk is loaded through `@clerk/nextjs`, this would be `{ name: '@clerk/nextjs', version: '1.0.0' }`. You don't need to set this value yourself unless you're [developing an SDK](https://clerk.com/docs/guides/development/sdk-development/overview).
Expand Down
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(js): expose loaded @clerk/ui version via Clerk.uiVersion by jacekradko · Pull Request #8931 · 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
7 changes: 7 additions & 0 deletions .changeset/clerk-ui-version.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
---
'@clerk/clerk-js': minor
'@clerk/shared': minor
'@clerk/react': minor
Comment on lines +2 to +4

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Should it just be a patch bump maybe?

---

Expose the loaded `@clerk/ui` version on the `Clerk` object via a new `uiVersion` property. It returns the version of the prebuilt UI bundle once it has loaded (for example `Clerk.uiVersion` in the browser console), or `undefined` if the UI has not been loaded yet. `@clerk/clerk-js` and `@clerk/ui` are versioned and loaded independently, so `uiVersion` can differ from `Clerk.version`.
1 change: 1 addition & 0 deletions .typedoc/__tests__/__snapshots__/clerk-properties.mdx
Original file line numberDiff line numberDiff line change
Expand Up@@ -17,5 +17,6 @@
| <a id="session"></a> `session` | <code>undefined \| null \| [SignedInSessionResource](/docs/reference/objects/session)</code> | The currently active `Session`, which is guaranteed to be one of the sessions in `Client.sessions`. If there is no active session, this field will be `null`. If the session is loading, this field will be `undefined`. |
| <a id="status"></a> `status` | <code>"error" \| "degraded" \| "loading" \| "ready"</code> | The status of the `Clerk` instance. Possible values are: <ul> <li>`"error"`: Set when hotloading `clerk-js` or `Clerk.load()` failed.</li> <li>`"loading"`: Set during initialization.</li> <li>`"ready"`: Set when Clerk is fully operational.</li> <li>`"degraded"`: Set when Clerk is partially operational.</li> </ul> |
| <a id="telemetry"></a> `telemetry` | <code>undefined \| \{ isDebug: boolean; isEnabled: boolean; record: void; recordLog: void; \}</code> | [Telemetry](/docs/guides/how-clerk-works/security/clerk-telemetry) configuration. |
| <a id="uiversion"></a> `uiVersion` | <code>undefined \| string</code> | The version of `@clerk/ui` that is currently loaded, or `undefined` if the prebuilt UI has not been loaded yet. |
| <a id="user"></a> `user` | <code>undefined \| null \| [UserResource](/docs/reference/objects/user)</code> | A shortcut to `Session.user` which holds the currently active `User` object. If the session is `null` or `undefined`, the user field will match. |
| <a id="version"></a> `version` | <code>undefined \| string</code> | The Clerk SDK version number. |
55 changes: 55 additions & 0 deletions packages/clerk-js/src/core/__tests__/clerk.ui-version.test.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
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.uiVersion', () => {
let clerk: Clerk;

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

afterEach(() => {
delete (window as any).__internal_ClerkUICtor;
vi.restoreAllMocks();
});

it('exposes the property on the instance', () => {
expect('uiVersion' in clerk).toBe(true);
});

it('returns undefined when the @clerk/ui bundle has not loaded', () => {
expect((window as any).__internal_ClerkUICtor).toBeUndefined();
expect(clerk.uiVersion).toBeUndefined();
});

it('returns the version published by the loaded @clerk/ui constructor', () => {
(window as any).__internal_ClerkUICtor = { version: '1.18.1' };
expect(clerk.uiVersion).toBe('1.18.1');
});

it('reports a UI version independent of the clerk-js version', () => {
(window as any).__internal_ClerkUICtor = { version: '1.18.1' };
expect(clerk.uiVersion).not.toBe(clerk.version);
});
});
8 changes: 8 additions & 0 deletions packages/clerk-js/src/core/clerk.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -337,6 +337,14 @@ export class Clerk implements ClerkInterface {
return Clerk.version;
}

get uiVersion(): string | undefined {
// `@clerk/ui` publishes its constructor (which carries its package version) on this global when hot-loaded
// from the CDN; bundled (no-RHC) builds pass the constructor directly via `options.ui.ClerkUI` instead.
const globalCtor = typeof window !== 'undefined' ? window.__internal_ClerkUICtor : undefined;
const bundledCtor = this.#options.ui?.ClerkUI;
return globalCtor?.version ?? (bundledCtor instanceof Promise ? undefined : bundledCtor?.version);
}

set sdkMetadata(metadata: SDKMetadata) {
Clerk.sdkMetadata = metadata;
}
Expand Down
4 changes: 4 additions & 0 deletions packages/react/src/isomorphicClerk.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -776,6 +776,10 @@ export class IsomorphicClerk implements IsomorphicLoadedClerk {
return this.clerkjs?.version;
}

get uiVersion(): string | undefined {
return this.clerkjs?.uiVersion;
}

get client(): ClientResource | undefined {
if (this.clerkjs) {
return this.clerkjs.client;
Expand Down
5 changes: 5 additions & 0 deletions packages/shared/src/types/clerk.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -256,6 +256,11 @@ export interface Clerk {
*/
version: string | undefined;

/**
* The version of `@clerk/ui` that is currently loaded, or `undefined` if the prebuilt UI has not been loaded yet.
*/
uiVersion: string | undefined;

/**
* If present, contains information about the SDK that the host application is using.
* For example, if Clerk is loaded through `@clerk/nextjs`, this would be `{ name: '@clerk/nextjs', version: '1.0.0' }`. You don't need to set this value yourself unless you're [developing an SDK](https://clerk.com/docs/guides/development/sdk-development/overview).
Expand Down
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(js): expose loaded @clerk/ui version via Clerk.uiVersion by jacekradko · Pull Request #8931 · 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
7 changes: 7 additions & 0 deletions .changeset/clerk-ui-version.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
---
'@clerk/clerk-js': minor
'@clerk/shared': minor
'@clerk/react': minor
Comment on lines +2 to +4

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Should it just be a patch bump maybe?

---

Expose the loaded `@clerk/ui` version on the `Clerk` object via a new `uiVersion` property. It returns the version of the prebuilt UI bundle once it has loaded (for example `Clerk.uiVersion` in the browser console), or `undefined` if the UI has not been loaded yet. `@clerk/clerk-js` and `@clerk/ui` are versioned and loaded independently, so `uiVersion` can differ from `Clerk.version`.
1 change: 1 addition & 0 deletions .typedoc/__tests__/__snapshots__/clerk-properties.mdx
Original file line numberDiff line numberDiff line change
Expand Up@@ -17,5 +17,6 @@
| <a id="session"></a> `session` | <code>undefined \| null \| [SignedInSessionResource](/docs/reference/objects/session)</code> | The currently active `Session`, which is guaranteed to be one of the sessions in `Client.sessions`. If there is no active session, this field will be `null`. If the session is loading, this field will be `undefined`. |
| <a id="status"></a> `status` | <code>"error" \| "degraded" \| "loading" \| "ready"</code> | The status of the `Clerk` instance. Possible values are: <ul> <li>`"error"`: Set when hotloading `clerk-js` or `Clerk.load()` failed.</li> <li>`"loading"`: Set during initialization.</li> <li>`"ready"`: Set when Clerk is fully operational.</li> <li>`"degraded"`: Set when Clerk is partially operational.</li> </ul> |
| <a id="telemetry"></a> `telemetry` | <code>undefined \| \{ isDebug: boolean; isEnabled: boolean; record: void; recordLog: void; \}</code> | [Telemetry](/docs/guides/how-clerk-works/security/clerk-telemetry) configuration. |
| <a id="uiversion"></a> `uiVersion` | <code>undefined \| string</code> | The version of `@clerk/ui` that is currently loaded, or `undefined` if the prebuilt UI has not been loaded yet. |
| <a id="user"></a> `user` | <code>undefined \| null \| [UserResource](/docs/reference/objects/user)</code> | A shortcut to `Session.user` which holds the currently active `User` object. If the session is `null` or `undefined`, the user field will match. |
| <a id="version"></a> `version` | <code>undefined \| string</code> | The Clerk SDK version number. |
55 changes: 55 additions & 0 deletions packages/clerk-js/src/core/__tests__/clerk.ui-version.test.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
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.uiVersion', () => {
let clerk: Clerk;

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

afterEach(() => {
delete (window as any).__internal_ClerkUICtor;
vi.restoreAllMocks();
});

it('exposes the property on the instance', () => {
expect('uiVersion' in clerk).toBe(true);
});

it('returns undefined when the @clerk/ui bundle has not loaded', () => {
expect((window as any).__internal_ClerkUICtor).toBeUndefined();
expect(clerk.uiVersion).toBeUndefined();
});

it('returns the version published by the loaded @clerk/ui constructor', () => {
(window as any).__internal_ClerkUICtor = { version: '1.18.1' };
expect(clerk.uiVersion).toBe('1.18.1');
});

it('reports a UI version independent of the clerk-js version', () => {
(window as any).__internal_ClerkUICtor = { version: '1.18.1' };
expect(clerk.uiVersion).not.toBe(clerk.version);
});
});
8 changes: 8 additions & 0 deletions packages/clerk-js/src/core/clerk.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -337,6 +337,14 @@ export class Clerk implements ClerkInterface {
return Clerk.version;
}

get uiVersion(): string | undefined {
// `@clerk/ui` publishes its constructor (which carries its package version) on this global when hot-loaded
// from the CDN; bundled (no-RHC) builds pass the constructor directly via `options.ui.ClerkUI` instead.
const globalCtor = typeof window !== 'undefined' ? window.__internal_ClerkUICtor : undefined;
const bundledCtor = this.#options.ui?.ClerkUI;
return globalCtor?.version ?? (bundledCtor instanceof Promise ? undefined : bundledCtor?.version);
}

set sdkMetadata(metadata: SDKMetadata) {
Clerk.sdkMetadata = metadata;
}
Expand Down
4 changes: 4 additions & 0 deletions packages/react/src/isomorphicClerk.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -776,6 +776,10 @@ export class IsomorphicClerk implements IsomorphicLoadedClerk {
return this.clerkjs?.version;
}

get uiVersion(): string | undefined {
return this.clerkjs?.uiVersion;
}

get client(): ClientResource | undefined {
if (this.clerkjs) {
return this.clerkjs.client;
Expand Down
5 changes: 5 additions & 0 deletions packages/shared/src/types/clerk.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -256,6 +256,11 @@ export interface Clerk {
*/
version: string | undefined;

/**
* The version of `@clerk/ui` that is currently loaded, or `undefined` if the prebuilt UI has not been loaded yet.
*/
uiVersion: string | undefined;

/**
* If present, contains information about the SDK that the host application is using.
* For example, if Clerk is loaded through `@clerk/nextjs`, this would be `{ name: '@clerk/nextjs', version: '1.0.0' }`. You don't need to set this value yourself unless you're [developing an SDK](https://clerk.com/docs/guides/development/sdk-development/overview).
Expand Down
Loading