chore(types): Deprecate old jwt types#5354

New issue

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

Sign up for GitHub

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

Already on GitHub? Sign in to your account

Merged
panteliselef merged 3 commits into from
Mar 15, 2025
Merged

chore(types): Deprecate old jwt types #5354

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
8ca008b
chore(types): Deprecate old jwt types
panteliselef Mar 14, 2025
8edaa89
update usage
panteliselef Mar 14, 2025
ac6f78c
changeset
panteliselef Mar 14, 2025
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
9 changes: 9 additions & 0 deletions .changeset/thick-bags-promise.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
---
'@clerk/clerk-js': minor
'@clerk/astro': minor
'@clerk/clerk-react': minor
'@clerk/types': minor
'@clerk/vue': minor
---

Deprecate out of date jwt types in favour of existing that are up-to-date.
6 changes: 3 additions & 3 deletions packages/astro/src/react/hooks.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
import type {
ActJWTClaim,
ActClaim,
CheckAuthorizationWithCustomPermissions,
Clerk,
GetToken,
Expand DownExpand Up@@ -85,7 +85,7 @@ type UseAuthReturn =
isSignedIn: true;
userId: string;
sessionId: string;
actor: ActJWTClaim | null;
actor: ActClaim | null;
orgId: null;
orgRole: null;
orgSlug: null;
Expand All@@ -98,7 +98,7 @@ type UseAuthReturn =
isSignedIn: true;
userId: string;
sessionId: string;
actor: ActJWTClaim | null;
actor: ActClaim | null;
orgId: string;
orgRole: OrganizationCustomRoleKey;
orgSlug: string | null;
Expand Down
4 changes: 2 additions & 2 deletions packages/clerk-js/src/core/resources/Session.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -3,7 +3,7 @@ import { ClerkWebAuthnError, is4xxError } from '@clerk/shared/error';
import { retry } from '@clerk/shared/retry';
import { isWebAuthnSupported as isWebAuthnSupportedOnWindow } from '@clerk/shared/webauthn';
import type {
ActJWTClaim,
ActClaim,
CheckAuthorization,
EmailCodeConfig,
GetToken,
Expand DownExpand Up@@ -45,7 +45,7 @@ export class Session extends BaseResource implements SessionResource {
lastActiveAt!: Date;
lastActiveToken!: TokenResource | null;
lastActiveOrganizationId!: string | null;
actor!: ActJWTClaim | null;
actor!: ActClaim | null;
user!: UserResource | null;
publicUserData!: PublicUserData;
factorVerificationAge: [number, number] | null = null;
Expand Down
4 changes: 2 additions & 2 deletions packages/clerk-js/src/core/resources/SessionWithActivities.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
import type {
ActJWTClaim,
ActClaim,
SessionActivity,
SessionActivityJSON,
SessionWithActivitiesJSON,
Expand DownExpand Up@@ -28,7 +28,7 @@ export class SessionWithActivities extends BaseResource implements SessionWithAc
expireAt!: Date;
lastActiveAt!: Date;
latestActivity!: SessionActivity;
actor!: ActJWTClaim | null;
actor!: ActClaim | null;

constructor(data: SessionWithActivitiesJSON, pathRoot: string) {
super();
Expand Down
4 changes: 2 additions & 2 deletions packages/clerk-js/src/utils/jwt.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
import type { JWT, JWTClaims } from '@clerk/types';
import type { JWT, JwtPayload } from '@clerk/types';

import { urlDecodeB64 } from './encoders';

Expand All@@ -11,7 +11,7 @@ export function decode(token: string): JWT {
}

const payloadJSON = JSON.parse(urlDecodeB64(payload));
const claims = { __raw: token } as JWTClaims;
const claims = { __raw: token } as JwtPayload;

Object.keys(payloadJSON).forEach(k => {
claims[k] = payloadJSON[k];
Expand Down
4 changes: 2 additions & 2 deletions packages/react/src/contexts/AuthContext.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
import { createContextAndHook } from '@clerk/shared/react';
import type { ActJWTClaim, OrganizationCustomPermissionKey, OrganizationCustomRoleKey } from '@clerk/types';
import type { ActClaim, OrganizationCustomPermissionKey, OrganizationCustomRoleKey } from '@clerk/types';

export type AuthContextValue = {
userId: string | null | undefined;
sessionId: string | null | undefined;
actor: ActJWTClaim | null | undefined;
actor: ActClaim | null | undefined;
orgId: string | null | undefined;
orgRole: OrganizationCustomRoleKey | null | undefined;
orgSlug: string | null | undefined;
Expand Down
6 changes: 3 additions & 3 deletions packages/types/src/hooks.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,7 +2,7 @@ import type { OrganizationCustomRoleKey } from 'organizationMembership';
import type { SignInResource } from 'signIn';

import type { SetActive, SignOut } from './clerk';
import type { ActJWTClaim } from './jwt';
import type { ActClaim } from './jwtv2';
import type {
CheckAuthorizationWithCustomPermissions,
GetToken,
Expand DownExpand Up@@ -83,7 +83,7 @@ export type UseAuthReturn =
isSignedIn: true;
userId: string;
sessionId: string;
actor: ActJWTClaim | null;
actor: ActClaim | null;
orgId: null;
orgRole: null;
orgSlug: null;
Expand All@@ -96,7 +96,7 @@ export type UseAuthReturn =
isSignedIn: true;
userId: string;
sessionId: string;
actor: ActJWTClaim | null;
actor: ActClaim | null;
orgId: string;
orgRole: OrganizationCustomRoleKey;
orgSlug: string | null;
Expand Down
4 changes: 2 additions & 2 deletions packages/types/src/json.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -5,7 +5,7 @@
import type { __experimental_CommerceSettingsJSON } from './commerceSettings';
import type { DisplayConfigJSON } from './displayConfig';
import type { EnterpriseProtocol, EnterpriseProvider } from './enterpriseAccount';
import type { ActJWTClaim } from './jwt';
import type { ActClaim } from './jwtv2';
import type { OAuthProvider } from './oauth';
import type { OrganizationDomainVerificationStatus, OrganizationEnrollmentMode } from './organizationDomain';
import type { OrganizationInvitationStatus } from './organizationInvitation';
Expand DownExpand Up@@ -118,7 +118,7 @@ export interface SessionJSON extends ClerkResourceJSON {
last_active_at: number;
last_active_token: TokenJSON;
last_active_organization_id: string | null;
actor: ActJWTClaim | null;
actor: ActClaim | null;
tasks: Array<SessionTask> | null;
user: UserJSON;
public_user_data: PublicUserDataJSON;
Expand Down
23 changes: 19 additions & 4 deletions packages/types/src/jwt.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,18 @@
import type { ActClaim, JwtHeader, JwtPayload } from './jwtv2';
import type { OrganizationCustomRoleKey } from './organizationMembership';

export interface JWT {
encoded: { header: string; payload: string; signature: string };
header: JWTHeader;
claims: JWTClaims;
header: JwtHeader;
claims: JwtPayload;
}

type NonEmptyArray<T> = [T, ...T[]];

// standard names https://www.rfc-editor.org/rfc/rfc7515.html#section-4.1
/**
* @deprecated use `JwtHeader` instead
*/
export interface JWTHeader {
alg: string | Algorithm;
typ?: string;
Expand All@@ -22,14 +26,20 @@ export interface JWTHeader {
x5c?: string | string[];
}

/**
* @deprecated use `JwtPayload` instead
*/
export interface JWTClaims extends ClerkJWTClaims {
/**
* Encoded token supporting the `getRawString` method.
*/
__raw: string;
}

/* Clerk-issued JWT payload */
/**
* Clerk-issued JWT payload
* @deprecated use `JwtPayload` instead
*/
export interface ClerkJWTClaims {
/**
* JWT Issuer - [RFC7519#section-4.1.1](https://tools.ietf.org/html/rfc7519#section-4.1.1).
Expand DownExpand Up@@ -69,7 +79,7 @@ export interface ClerkJWTClaims {
/**
* JWT Actor - [RFC8693](https://www.rfc-editor.org/rfc/rfc8693.html#name-act-actor-claim).
*/
act?: ActJWTClaim;
act?: ActClaim;

/**
* Active organization id.
Expand All@@ -95,10 +105,15 @@ export interface ClerkJWTClaims {
/**
* JWT Actor - [RFC8693](https://www.rfc-editor.org/rfc/rfc8693.html#name-act-actor-claim).
* @inline
* @deprecated use `ActClaim` instead
*/
export interface ActJWTClaim {
sub: string;

[x: string]: unknown;
}

/**
* @deprecated This type will be removed in the next major version.
*/
export type OrganizationsJWTClaim = Record<string, OrganizationCustomRoleKey>;
1 change: 0 additions & 1 deletion packages/types/src/jwtv2.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -119,6 +119,5 @@ export interface JwtPayload extends CustomJwtSessionClaims {
*/
export interface ActClaim {
sub: string;

[x: string]: unknown;
}
6 changes: 3 additions & 3 deletions packages/types/src/session.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -10,7 +10,7 @@ import type {
PhoneCodeSecondFactorConfig,
TOTPAttempt,
} from './factors';
import type { ActJWTClaim } from './jwt';
import type { ActClaim } from './jwtv2';
import type {
OrganizationCustomPermissionKey,
OrganizationCustomRoleKey,
Expand DownExpand Up@@ -122,7 +122,7 @@ export interface SessionResource extends ClerkResource {
lastActiveToken: TokenResource | null;
lastActiveOrganizationId: string | null;
lastActiveAt: Date;
actor: ActJWTClaim | null;
actor: ActClaim | null;
tasks: Array<SessionTask> | null;
currentTask?: SessionTask;
/**
Expand DownExpand Up@@ -190,7 +190,7 @@ export interface SessionWithActivitiesResource extends ClerkResource {
abandonAt: Date;
lastActiveAt: Date;
latestActivity: SessionActivity;
actor: ActJWTClaim | null;
actor: ActClaim | null;

revoke: () => Promise<SessionWithActivitiesResource>;
}
Expand Down
4 changes: 2 additions & 2 deletions packages/vue/src/types.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
import type {
ActJWTClaim,
ActClaim,
Clerk,
ClerkOptions,
ClientResource,
Expand All@@ -19,7 +19,7 @@ export interface VueClerkInjectionKeyType {
authCtx: ComputedRef<{
userId: string | null | undefined;
sessionId: string | null | undefined;
actor: ActJWTClaim | null | undefined;
actor: ActClaim | null | undefined;
orgId: string | null | undefined;
orgRole: OrganizationCustomRoleKey | null | undefined;
orgSlug: string | null | undefined;
Expand Down
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all 
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '

Skip to content
chore(types): Deprecate old jwt types#5354

New issue

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

 Sign up for GitHub

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

Already on GitHub?
Sign in
to your account

 Merged

panteliselef
merged 3 commits into

from

Mar 15, 2025
 Merged


chore(types): Deprecate old jwt types
#5354
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
8ca008b

chore(types): Deprecate old jwt types


panteliselef Mar 14, 2025
8edaa89

update usage


panteliselef Mar 14, 2025
ac6f78c

changeset


panteliselef Mar 14, 2025

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


9 changes: 9 additions & 0 deletions
.changeset/thick-bags-promise.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
---
'@clerk/clerk-js': minor
'@clerk/astro': minor
'@clerk/clerk-react': minor
'@clerk/types': minor
'@clerk/vue': minor
---

Deprecate out of date jwt types in favour of existing that are up-to-date.

6 changes: 3 additions & 3 deletions
packages/astro/src/react/hooks.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
import type {
ActJWTClaim,
ActClaim,
 CheckAuthorizationWithCustomPermissions,
 Clerk,
 GetToken,
Expand DownExpand Up@@ -85,7 +85,7 @@ type UseAuthReturn =
 isSignedIn: true;
 userId: string;
 sessionId: string;
 actor: ActJWTClaim | null;
 actor: ActClaim | null;
 orgId: null;
 orgRole: null;
 orgSlug: null;
Expand All@@ -98,7 +98,7 @@ type UseAuthReturn =
 isSignedIn: true;
 userId: string;
 sessionId: string;
 actor: ActJWTClaim | null;
 actor: ActClaim | null;
 orgId: string;
 orgRole: OrganizationCustomRoleKey;
 orgSlug: string | null;
Expand Down

4 changes: 2 additions & 2 deletions
packages/clerk-js/src/core/resources/Session.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,7 +3,7 @@ import { ClerkWebAuthnError, is4xxError } from '@clerk/shared/error';
import { retry } from '@clerk/shared/retry';
import { isWebAuthnSupported as isWebAuthnSupportedOnWindow } from '@clerk/shared/webauthn';
import type {
ActJWTClaim,
ActClaim,
 CheckAuthorization,
 EmailCodeConfig,
 GetToken,
Expand DownExpand Up@@ -45,7 +45,7 @@ export class Session extends BaseResource implements SessionResource {
 lastActiveAt!: Date;
 lastActiveToken!: TokenResource | null;
 lastActiveOrganizationId!: string | null;
 actor!: ActJWTClaim | null;
 actor!: ActClaim | null;
 user!: UserResource | null;
 publicUserData!: PublicUserData;
 factorVerificationAge: [number, number] | null = null;
Expand Down

4 changes: 2 additions & 2 deletions
packages/clerk-js/src/core/resources/SessionWithActivities.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
import type {
ActJWTClaim,
ActClaim,
 SessionActivity,
 SessionActivityJSON,
 SessionWithActivitiesJSON,
Expand DownExpand Up@@ -28,7 +28,7 @@ export class SessionWithActivities extends BaseResource implements SessionWithAc
 expireAt!: Date;
 lastActiveAt!: Date;
 latestActivity!: SessionActivity;
 actor!: ActJWTClaim | null;
 actor!: ActClaim | null;

 constructor(data: SessionWithActivitiesJSON, pathRoot: string) {
 super();
Expand Down

4 changes: 2 additions & 2 deletions
packages/clerk-js/src/utils/jwt.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
import type { JWT, JWTClaims } from '@clerk/types';
import type { JWT, JwtPayload } from '@clerk/types';

import { urlDecodeB64 } from './encoders';

Expand All@@ -11,7 +11,7 @@ export function decode(token: string): JWT {
 }

 const payloadJSON = JSON.parse(urlDecodeB64(payload));
 const claims = { __raw: token } as JWTClaims;
 const claims = { __raw: token } as JwtPayload;

 Object.keys(payloadJSON).forEach(k => {
 claims[k] = payloadJSON[k];
Expand Down

4 changes: 2 additions & 2 deletions
packages/react/src/contexts/AuthContext.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
import { createContextAndHook } from '@clerk/shared/react';
import type { ActJWTClaim, OrganizationCustomPermissionKey, OrganizationCustomRoleKey } from '@clerk/types';
import type { ActClaim, OrganizationCustomPermissionKey, OrganizationCustomRoleKey } from '@clerk/types';

export type AuthContextValue = {
 userId: string | null | undefined;
 sessionId: string | null | undefined;
 actor: ActJWTClaim | null | undefined;
 actor: ActClaim | null | undefined;
 orgId: string | null | undefined;
 orgRole: OrganizationCustomRoleKey | null | undefined;
 orgSlug: string | null | undefined;
Expand Down

6 changes: 3 additions & 3 deletions
packages/types/src/hooks.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,7 +2,7 @@ import type { OrganizationCustomRoleKey } from 'organizationMembership';
import type { SignInResource } from 'signIn';

import type { SetActive, SignOut } from './clerk';
import type { ActJWTClaim } from './jwt';
import type { ActClaim } from './jwtv2';
import type {
 CheckAuthorizationWithCustomPermissions,
 GetToken,
Expand DownExpand Up@@ -83,7 +83,7 @@ export type UseAuthReturn =
 isSignedIn: true;
 userId: string;
 sessionId: string;
 actor: ActJWTClaim | null;
 actor: ActClaim | null;
 orgId: null;
 orgRole: null;
 orgSlug: null;
Expand All@@ -96,7 +96,7 @@ export type UseAuthReturn =
 isSignedIn: true;
 userId: string;
 sessionId: string;
 actor: ActJWTClaim | null;
 actor: ActClaim | null;
 orgId: string;
 orgRole: OrganizationCustomRoleKey;
 orgSlug: string | null;
Expand Down

4 changes: 2 additions & 2 deletions
packages/types/src/json.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,7 +5,7 @@
import type { __experimental_CommerceSettingsJSON } from './commerceSettings';
import type { DisplayConfigJSON } from './displayConfig';
import type { EnterpriseProtocol, EnterpriseProvider } from './enterpriseAccount';
import type { ActJWTClaim } from './jwt';
import type { ActClaim } from './jwtv2';
import type { OAuthProvider } from './oauth';
import type { OrganizationDomainVerificationStatus, OrganizationEnrollmentMode } from './organizationDomain';
import type { OrganizationInvitationStatus } from './organizationInvitation';
Expand DownExpand Up@@ -118,7 +118,7 @@ export interface SessionJSON extends ClerkResourceJSON {
 last_active_at: number;
 last_active_token: TokenJSON;
 last_active_organization_id: string | null;
 actor: ActJWTClaim | null;
 actor: ActClaim | null;
 tasks: Array<SessionTask> | null;
 user: UserJSON;
 public_user_data: PublicUserDataJSON;
Expand Down

23 changes: 19 additions & 4 deletions
packages/types/src/jwt.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,14 +1,18 @@
import type { ActClaim, JwtHeader, JwtPayload } from './jwtv2';
import type { OrganizationCustomRoleKey } from './organizationMembership';

export interface JWT {
 encoded: { header: string; payload: string; signature: string };
 header: JWTHeader;
 claims: JWTClaims;
 header: JwtHeader;
 claims: JwtPayload;
}

type NonEmptyArray<T> = [T, ...T[]];

// standard names https://www.rfc-editor.org/rfc/rfc7515.html#section-4.1
/**
 * @deprecated use `JwtHeader` instead
 */
export interface JWTHeader {
 alg: string | Algorithm;
 typ?: string;
Expand All@@ -22,14 +26,20 @@ export interface JWTHeader {
 x5c?: string | string[];
}

/**
 * @deprecated use `JwtPayload` instead
 */
export interface JWTClaims extends ClerkJWTClaims {
 /**
 * Encoded token supporting the `getRawString` method.
 */
 __raw: string;
}

/* Clerk-issued JWT payload */
/**
 * Clerk-issued JWT payload
 * @deprecated use `JwtPayload` instead
 */
export interface ClerkJWTClaims {
 /**
 * JWT Issuer - [RFC7519#section-4.1.1](https://tools.ietf.org/html/rfc7519#section-4.1.1).
Expand DownExpand Up@@ -69,7 +79,7 @@ export interface ClerkJWTClaims {
 /**
 * JWT Actor - [RFC8693](https://www.rfc-editor.org/rfc/rfc8693.html#name-act-actor-claim).
 */
 act?: ActJWTClaim;
 act?: ActClaim;

 /**
 * Active organization id.
Expand All@@ -95,10 +105,15 @@ export interface ClerkJWTClaims {
/**
 * JWT Actor - [RFC8693](https://www.rfc-editor.org/rfc/rfc8693.html#name-act-actor-claim).
 * @inline
 * @deprecated use `ActClaim` instead
 */
export interface ActJWTClaim {
 sub: string;

 [x: string]: unknown;
}

/**
 * @deprecated This type will be removed in the next major version.
 */
export type OrganizationsJWTClaim = Record<string, OrganizationCustomRoleKey>;

1 change: 0 additions & 1 deletion
packages/types/src/jwtv2.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -119,6 +119,5 @@ export interface JwtPayload extends CustomJwtSessionClaims {
 */
export interface ActClaim {
 sub: string;

 [x: string]: unknown;
}

6 changes: 3 additions & 3 deletions
packages/types/src/session.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,7 +10,7 @@ import type {
 PhoneCodeSecondFactorConfig,
 TOTPAttempt,
} from './factors';
import type { ActJWTClaim } from './jwt';
import type { ActClaim } from './jwtv2';
import type {
 OrganizationCustomPermissionKey,
 OrganizationCustomRoleKey,
Expand DownExpand Up@@ -122,7 +122,7 @@ export interface SessionResource extends ClerkResource {
 lastActiveToken: TokenResource | null;
 lastActiveOrganizationId: string | null;
 lastActiveAt: Date;
 actor: ActJWTClaim | null;
 actor: ActClaim | null;
 tasks: Array<SessionTask> | null;
 currentTask?: SessionTask;
 /**
Expand DownExpand Up@@ -190,7 +190,7 @@ export interface SessionWithActivitiesResource extends ClerkResource {
 abandonAt: Date;
 lastActiveAt: Date;
 latestActivity: SessionActivity;
 actor: ActJWTClaim | null;
 actor: ActClaim | null;

 revoke: () => Promise<SessionWithActivitiesResource>;
}
Expand Down

4 changes: 2 additions & 2 deletions
packages/vue/src/types.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
import type {
ActJWTClaim,
ActClaim,
 Clerk,
 ClerkOptions,
 ClientResource,
Expand All@@ -19,7 +19,7 @@ export interface VueClerkInjectionKeyType {
 authCtx: ComputedRef<{
 userId: string | null | undefined;
 sessionId: string | null | undefined;
 actor: ActJWTClaim | null | undefined;
 actor: ActClaim | null | undefined;
 orgId: string | null | undefined;
 orgRole: OrganizationCustomRoleKey | null | undefined;
 orgSlug: string | null | undefined;
Expand Down

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

Skip to content
chore(types): Deprecate old jwt types#5354

New issue

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

 Sign up for GitHub

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

Already on GitHub?
Sign in
to your account

 Merged

panteliselef
merged 3 commits into

from

Mar 15, 2025
 Merged


chore(types): Deprecate old jwt types
#5354
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
8ca008b

chore(types): Deprecate old jwt types


panteliselef Mar 14, 2025
8edaa89

update usage


panteliselef Mar 14, 2025
ac6f78c

changeset


panteliselef Mar 14, 2025

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


9 changes: 9 additions & 0 deletions
.changeset/thick-bags-promise.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
---
'@clerk/clerk-js': minor
'@clerk/astro': minor
'@clerk/clerk-react': minor
'@clerk/types': minor
'@clerk/vue': minor
---

Deprecate out of date jwt types in favour of existing that are up-to-date.

6 changes: 3 additions & 3 deletions
packages/astro/src/react/hooks.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
import type {
ActJWTClaim,
ActClaim,
 CheckAuthorizationWithCustomPermissions,
 Clerk,
 GetToken,
Expand DownExpand Up@@ -85,7 +85,7 @@ type UseAuthReturn =
 isSignedIn: true;
 userId: string;
 sessionId: string;
 actor: ActJWTClaim | null;
 actor: ActClaim | null;
 orgId: null;
 orgRole: null;
 orgSlug: null;
Expand All@@ -98,7 +98,7 @@ type UseAuthReturn =
 isSignedIn: true;
 userId: string;
 sessionId: string;
 actor: ActJWTClaim | null;
 actor: ActClaim | null;
 orgId: string;
 orgRole: OrganizationCustomRoleKey;
 orgSlug: string | null;
Expand Down

4 changes: 2 additions & 2 deletions
packages/clerk-js/src/core/resources/Session.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,7 +3,7 @@ import { ClerkWebAuthnError, is4xxError } from '@clerk/shared/error';
import { retry } from '@clerk/shared/retry';
import { isWebAuthnSupported as isWebAuthnSupportedOnWindow } from '@clerk/shared/webauthn';
import type {
ActJWTClaim,
ActClaim,
 CheckAuthorization,
 EmailCodeConfig,
 GetToken,
Expand DownExpand Up@@ -45,7 +45,7 @@ export class Session extends BaseResource implements SessionResource {
 lastActiveAt!: Date;
 lastActiveToken!: TokenResource | null;
 lastActiveOrganizationId!: string | null;
 actor!: ActJWTClaim | null;
 actor!: ActClaim | null;
 user!: UserResource | null;
 publicUserData!: PublicUserData;
 factorVerificationAge: [number, number] | null = null;
Expand Down

4 changes: 2 additions & 2 deletions
packages/clerk-js/src/core/resources/SessionWithActivities.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
import type {
ActJWTClaim,
ActClaim,
 SessionActivity,
 SessionActivityJSON,
 SessionWithActivitiesJSON,
Expand DownExpand Up@@ -28,7 +28,7 @@ export class SessionWithActivities extends BaseResource implements SessionWithAc
 expireAt!: Date;
 lastActiveAt!: Date;
 latestActivity!: SessionActivity;
 actor!: ActJWTClaim | null;
 actor!: ActClaim | null;

 constructor(data: SessionWithActivitiesJSON, pathRoot: string) {
 super();
Expand Down

4 changes: 2 additions & 2 deletions
packages/clerk-js/src/utils/jwt.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
import type { JWT, JWTClaims } from '@clerk/types';
import type { JWT, JwtPayload } from '@clerk/types';

import { urlDecodeB64 } from './encoders';

Expand All@@ -11,7 +11,7 @@ export function decode(token: string): JWT {
 }

 const payloadJSON = JSON.parse(urlDecodeB64(payload));
 const claims = { __raw: token } as JWTClaims;
 const claims = { __raw: token } as JwtPayload;

 Object.keys(payloadJSON).forEach(k => {
 claims[k] = payloadJSON[k];
Expand Down

4 changes: 2 additions & 2 deletions
packages/react/src/contexts/AuthContext.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
import { createContextAndHook } from '@clerk/shared/react';
import type { ActJWTClaim, OrganizationCustomPermissionKey, OrganizationCustomRoleKey } from '@clerk/types';
import type { ActClaim, OrganizationCustomPermissionKey, OrganizationCustomRoleKey } from '@clerk/types';

export type AuthContextValue = {
 userId: string | null | undefined;
 sessionId: string | null | undefined;
 actor: ActJWTClaim | null | undefined;
 actor: ActClaim | null | undefined;
 orgId: string | null | undefined;
 orgRole: OrganizationCustomRoleKey | null | undefined;
 orgSlug: string | null | undefined;
Expand Down

6 changes: 3 additions & 3 deletions
packages/types/src/hooks.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,7 +2,7 @@ import type { OrganizationCustomRoleKey } from 'organizationMembership';
import type { SignInResource } from 'signIn';

import type { SetActive, SignOut } from './clerk';
import type { ActJWTClaim } from './jwt';
import type { ActClaim } from './jwtv2';
import type {
 CheckAuthorizationWithCustomPermissions,
 GetToken,
Expand DownExpand Up@@ -83,7 +83,7 @@ export type UseAuthReturn =
 isSignedIn: true;
 userId: string;
 sessionId: string;
 actor: ActJWTClaim | null;
 actor: ActClaim | null;
 orgId: null;
 orgRole: null;
 orgSlug: null;
Expand All@@ -96,7 +96,7 @@ export type UseAuthReturn =
 isSignedIn: true;
 userId: string;
 sessionId: string;
 actor: ActJWTClaim | null;
 actor: ActClaim | null;
 orgId: string;
 orgRole: OrganizationCustomRoleKey;
 orgSlug: string | null;
Expand Down

4 changes: 2 additions & 2 deletions
packages/types/src/json.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,7 +5,7 @@
import type { __experimental_CommerceSettingsJSON } from './commerceSettings';
import type { DisplayConfigJSON } from './displayConfig';
import type { EnterpriseProtocol, EnterpriseProvider } from './enterpriseAccount';
import type { ActJWTClaim } from './jwt';
import type { ActClaim } from './jwtv2';
import type { OAuthProvider } from './oauth';
import type { OrganizationDomainVerificationStatus, OrganizationEnrollmentMode } from './organizationDomain';
import type { OrganizationInvitationStatus } from './organizationInvitation';
Expand DownExpand Up@@ -118,7 +118,7 @@ export interface SessionJSON extends ClerkResourceJSON {
 last_active_at: number;
 last_active_token: TokenJSON;
 last_active_organization_id: string | null;
 actor: ActJWTClaim | null;
 actor: ActClaim | null;
 tasks: Array<SessionTask> | null;
 user: UserJSON;
 public_user_data: PublicUserDataJSON;
Expand Down

23 changes: 19 additions & 4 deletions
packages/types/src/jwt.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,14 +1,18 @@
import type { ActClaim, JwtHeader, JwtPayload } from './jwtv2';
import type { OrganizationCustomRoleKey } from './organizationMembership';

export interface JWT {
 encoded: { header: string; payload: string; signature: string };
 header: JWTHeader;
 claims: JWTClaims;
 header: JwtHeader;
 claims: JwtPayload;
}

type NonEmptyArray<T> = [T, ...T[]];

// standard names https://www.rfc-editor.org/rfc/rfc7515.html#section-4.1
/**
 * @deprecated use `JwtHeader` instead
 */
export interface JWTHeader {
 alg: string | Algorithm;
 typ?: string;
Expand All@@ -22,14 +26,20 @@ export interface JWTHeader {
 x5c?: string | string[];
}

/**
 * @deprecated use `JwtPayload` instead
 */
export interface JWTClaims extends ClerkJWTClaims {
 /**
 * Encoded token supporting the `getRawString` method.
 */
 __raw: string;
}

/* Clerk-issued JWT payload */
/**
 * Clerk-issued JWT payload
 * @deprecated use `JwtPayload` instead
 */
export interface ClerkJWTClaims {
 /**
 * JWT Issuer - [RFC7519#section-4.1.1](https://tools.ietf.org/html/rfc7519#section-4.1.1).
Expand DownExpand Up@@ -69,7 +79,7 @@ export interface ClerkJWTClaims {
 /**
 * JWT Actor - [RFC8693](https://www.rfc-editor.org/rfc/rfc8693.html#name-act-actor-claim).
 */
 act?: ActJWTClaim;
 act?: ActClaim;

 /**
 * Active organization id.
Expand All@@ -95,10 +105,15 @@ export interface ClerkJWTClaims {
/**
 * JWT Actor - [RFC8693](https://www.rfc-editor.org/rfc/rfc8693.html#name-act-actor-claim).
 * @inline
 * @deprecated use `ActClaim` instead
 */
export interface ActJWTClaim {
 sub: string;

 [x: string]: unknown;
}

/**
 * @deprecated This type will be removed in the next major version.
 */
export type OrganizationsJWTClaim = Record<string, OrganizationCustomRoleKey>;

1 change: 0 additions & 1 deletion
packages/types/src/jwtv2.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -119,6 +119,5 @@ export interface JwtPayload extends CustomJwtSessionClaims {
 */
export interface ActClaim {
 sub: string;

 [x: string]: unknown;
}

6 changes: 3 additions & 3 deletions
packages/types/src/session.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,7 +10,7 @@ import type {
 PhoneCodeSecondFactorConfig,
 TOTPAttempt,
} from './factors';
import type { ActJWTClaim } from './jwt';
import type { ActClaim } from './jwtv2';
import type {
 OrganizationCustomPermissionKey,
 OrganizationCustomRoleKey,
Expand DownExpand Up@@ -122,7 +122,7 @@ export interface SessionResource extends ClerkResource {
 lastActiveToken: TokenResource | null;
 lastActiveOrganizationId: string | null;
 lastActiveAt: Date;
 actor: ActJWTClaim | null;
 actor: ActClaim | null;
 tasks: Array<SessionTask> | null;
 currentTask?: SessionTask;
 /**
Expand DownExpand Up@@ -190,7 +190,7 @@ export interface SessionWithActivitiesResource extends ClerkResource {
 abandonAt: Date;
 lastActiveAt: Date;
 latestActivity: SessionActivity;
 actor: ActJWTClaim | null;
 actor: ActClaim | null;

 revoke: () => Promise<SessionWithActivitiesResource>;
}
Expand Down

4 changes: 2 additions & 2 deletions
packages/vue/src/types.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
import type {
ActJWTClaim,
ActClaim,
 Clerk,
 ClerkOptions,
 ClientResource,
Expand All@@ -19,7 +19,7 @@ export interface VueClerkInjectionKeyType {
 authCtx: ComputedRef<{
 userId: string | null | undefined;
 sessionId: string | null | undefined;
 actor: ActJWTClaim | null | undefined;
 actor: ActClaim | null | undefined;
 orgId: string | null | undefined;
 orgRole: OrganizationCustomRoleKey | null | undefined;
 orgSlug: string | null | undefined;
Expand Down

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

Skip to content
chore(types): Deprecate old jwt types#5354

New issue

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

 Sign up for GitHub

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

Already on GitHub?
Sign in
to your account

 Merged

panteliselef
merged 3 commits into

from

Mar 15, 2025
 Merged


chore(types): Deprecate old jwt types
#5354
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
8ca008b

chore(types): Deprecate old jwt types


panteliselef Mar 14, 2025
8edaa89

update usage


panteliselef Mar 14, 2025
ac6f78c

changeset


panteliselef Mar 14, 2025

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


9 changes: 9 additions & 0 deletions
.changeset/thick-bags-promise.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
---
'@clerk/clerk-js': minor
'@clerk/astro': minor
'@clerk/clerk-react': minor
'@clerk/types': minor
'@clerk/vue': minor
---

Deprecate out of date jwt types in favour of existing that are up-to-date.

6 changes: 3 additions & 3 deletions
packages/astro/src/react/hooks.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
import type {
ActJWTClaim,
ActClaim,
 CheckAuthorizationWithCustomPermissions,
 Clerk,
 GetToken,
Expand DownExpand Up@@ -85,7 +85,7 @@ type UseAuthReturn =
 isSignedIn: true;
 userId: string;
 sessionId: string;
 actor: ActJWTClaim | null;
 actor: ActClaim | null;
 orgId: null;
 orgRole: null;
 orgSlug: null;
Expand All@@ -98,7 +98,7 @@ type UseAuthReturn =
 isSignedIn: true;
 userId: string;
 sessionId: string;
 actor: ActJWTClaim | null;
 actor: ActClaim | null;
 orgId: string;
 orgRole: OrganizationCustomRoleKey;
 orgSlug: string | null;
Expand Down

4 changes: 2 additions & 2 deletions
packages/clerk-js/src/core/resources/Session.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,7 +3,7 @@ import { ClerkWebAuthnError, is4xxError } from '@clerk/shared/error';
import { retry } from '@clerk/shared/retry';
import { isWebAuthnSupported as isWebAuthnSupportedOnWindow } from '@clerk/shared/webauthn';
import type {
ActJWTClaim,
ActClaim,
 CheckAuthorization,
 EmailCodeConfig,
 GetToken,
Expand DownExpand Up@@ -45,7 +45,7 @@ export class Session extends BaseResource implements SessionResource {
 lastActiveAt!: Date;
 lastActiveToken!: TokenResource | null;
 lastActiveOrganizationId!: string | null;
 actor!: ActJWTClaim | null;
 actor!: ActClaim | null;
 user!: UserResource | null;
 publicUserData!: PublicUserData;
 factorVerificationAge: [number, number] | null = null;
Expand Down

4 changes: 2 additions & 2 deletions
packages/clerk-js/src/core/resources/SessionWithActivities.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
import type {
ActJWTClaim,
ActClaim,
 SessionActivity,
 SessionActivityJSON,
 SessionWithActivitiesJSON,
Expand DownExpand Up@@ -28,7 +28,7 @@ export class SessionWithActivities extends BaseResource implements SessionWithAc
 expireAt!: Date;
 lastActiveAt!: Date;
 latestActivity!: SessionActivity;
 actor!: ActJWTClaim | null;
 actor!: ActClaim | null;

 constructor(data: SessionWithActivitiesJSON, pathRoot: string) {
 super();
Expand Down

4 changes: 2 additions & 2 deletions
packages/clerk-js/src/utils/jwt.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
import type { JWT, JWTClaims } from '@clerk/types';
import type { JWT, JwtPayload } from '@clerk/types';

import { urlDecodeB64 } from './encoders';

Expand All@@ -11,7 +11,7 @@ export function decode(token: string): JWT {
 }

 const payloadJSON = JSON.parse(urlDecodeB64(payload));
 const claims = { __raw: token } as JWTClaims;
 const claims = { __raw: token } as JwtPayload;

 Object.keys(payloadJSON).forEach(k => {
 claims[k] = payloadJSON[k];
Expand Down

4 changes: 2 additions & 2 deletions
packages/react/src/contexts/AuthContext.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
import { createContextAndHook } from '@clerk/shared/react';
import type { ActJWTClaim, OrganizationCustomPermissionKey, OrganizationCustomRoleKey } from '@clerk/types';
import type { ActClaim, OrganizationCustomPermissionKey, OrganizationCustomRoleKey } from '@clerk/types';

export type AuthContextValue = {
 userId: string | null | undefined;
 sessionId: string | null | undefined;
 actor: ActJWTClaim | null | undefined;
 actor: ActClaim | null | undefined;
 orgId: string | null | undefined;
 orgRole: OrganizationCustomRoleKey | null | undefined;
 orgSlug: string | null | undefined;
Expand Down

6 changes: 3 additions & 3 deletions
packages/types/src/hooks.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,7 +2,7 @@ import type { OrganizationCustomRoleKey } from 'organizationMembership';
import type { SignInResource } from 'signIn';

import type { SetActive, SignOut } from './clerk';
import type { ActJWTClaim } from './jwt';
import type { ActClaim } from './jwtv2';
import type {
 CheckAuthorizationWithCustomPermissions,
 GetToken,
Expand DownExpand Up@@ -83,7 +83,7 @@ export type UseAuthReturn =
 isSignedIn: true;
 userId: string;
 sessionId: string;
 actor: ActJWTClaim | null;
 actor: ActClaim | null;
 orgId: null;
 orgRole: null;
 orgSlug: null;
Expand All@@ -96,7 +96,7 @@ export type UseAuthReturn =
 isSignedIn: true;
 userId: string;
 sessionId: string;
 actor: ActJWTClaim | null;
 actor: ActClaim | null;
 orgId: string;
 orgRole: OrganizationCustomRoleKey;
 orgSlug: string | null;
Expand Down

4 changes: 2 additions & 2 deletions
packages/types/src/json.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,7 +5,7 @@
import type { __experimental_CommerceSettingsJSON } from './commerceSettings';
import type { DisplayConfigJSON } from './displayConfig';
import type { EnterpriseProtocol, EnterpriseProvider } from './enterpriseAccount';
import type { ActJWTClaim } from './jwt';
import type { ActClaim } from './jwtv2';
import type { OAuthProvider } from './oauth';
import type { OrganizationDomainVerificationStatus, OrganizationEnrollmentMode } from './organizationDomain';
import type { OrganizationInvitationStatus } from './organizationInvitation';
Expand DownExpand Up@@ -118,7 +118,7 @@ export interface SessionJSON extends ClerkResourceJSON {
 last_active_at: number;
 last_active_token: TokenJSON;
 last_active_organization_id: string | null;
 actor: ActJWTClaim | null;
 actor: ActClaim | null;
 tasks: Array<SessionTask> | null;
 user: UserJSON;
 public_user_data: PublicUserDataJSON;
Expand Down

23 changes: 19 additions & 4 deletions
packages/types/src/jwt.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,14 +1,18 @@
import type { ActClaim, JwtHeader, JwtPayload } from './jwtv2';
import type { OrganizationCustomRoleKey } from './organizationMembership';

export interface JWT {
 encoded: { header: string; payload: string; signature: string };
 header: JWTHeader;
 claims: JWTClaims;
 header: JwtHeader;
 claims: JwtPayload;
}

type NonEmptyArray<T> = [T, ...T[]];

// standard names https://www.rfc-editor.org/rfc/rfc7515.html#section-4.1
/**
 * @deprecated use `JwtHeader` instead
 */
export interface JWTHeader {
 alg: string | Algorithm;
 typ?: string;
Expand All@@ -22,14 +26,20 @@ export interface JWTHeader {
 x5c?: string | string[];
}

/**
 * @deprecated use `JwtPayload` instead
 */
export interface JWTClaims extends ClerkJWTClaims {
 /**
 * Encoded token supporting the `getRawString` method.
 */
 __raw: string;
}

/* Clerk-issued JWT payload */
/**
 * Clerk-issued JWT payload
 * @deprecated use `JwtPayload` instead
 */
export interface ClerkJWTClaims {
 /**
 * JWT Issuer - [RFC7519#section-4.1.1](https://tools.ietf.org/html/rfc7519#section-4.1.1).
Expand DownExpand Up@@ -69,7 +79,7 @@ export interface ClerkJWTClaims {
 /**
 * JWT Actor - [RFC8693](https://www.rfc-editor.org/rfc/rfc8693.html#name-act-actor-claim).
 */
 act?: ActJWTClaim;
 act?: ActClaim;

 /**
 * Active organization id.
Expand All@@ -95,10 +105,15 @@ export interface ClerkJWTClaims {
/**
 * JWT Actor - [RFC8693](https://www.rfc-editor.org/rfc/rfc8693.html#name-act-actor-claim).
 * @inline
 * @deprecated use `ActClaim` instead
 */
export interface ActJWTClaim {
 sub: string;

 [x: string]: unknown;
}

/**
 * @deprecated This type will be removed in the next major version.
 */
export type OrganizationsJWTClaim = Record<string, OrganizationCustomRoleKey>;

1 change: 0 additions & 1 deletion
packages/types/src/jwtv2.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -119,6 +119,5 @@ export interface JwtPayload extends CustomJwtSessionClaims {
 */
export interface ActClaim {
 sub: string;

 [x: string]: unknown;
}

6 changes: 3 additions & 3 deletions
packages/types/src/session.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,7 +10,7 @@ import type {
 PhoneCodeSecondFactorConfig,
 TOTPAttempt,
} from './factors';
import type { ActJWTClaim } from './jwt';
import type { ActClaim } from './jwtv2';
import type {
 OrganizationCustomPermissionKey,
 OrganizationCustomRoleKey,
Expand DownExpand Up@@ -122,7 +122,7 @@ export interface SessionResource extends ClerkResource {
 lastActiveToken: TokenResource | null;
 lastActiveOrganizationId: string | null;
 lastActiveAt: Date;
 actor: ActJWTClaim | null;
 actor: ActClaim | null;
 tasks: Array<SessionTask> | null;
 currentTask?: SessionTask;
 /**
Expand DownExpand Up@@ -190,7 +190,7 @@ export interface SessionWithActivitiesResource extends ClerkResource {
 abandonAt: Date;
 lastActiveAt: Date;
 latestActivity: SessionActivity;
 actor: ActJWTClaim | null;
 actor: ActClaim | null;

 revoke: () => Promise<SessionWithActivitiesResource>;
}
Expand Down

4 changes: 2 additions & 2 deletions
packages/vue/src/types.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
import type {
ActJWTClaim,
ActClaim,
 Clerk,
 ClerkOptions,
 ClientResource,
Expand All@@ -19,7 +19,7 @@ export interface VueClerkInjectionKeyType {
 authCtx: ComputedRef<{
 userId: string | null | undefined;
 sessionId: string | null | undefined;
 actor: ActJWTClaim | null | undefined;
 actor: ActClaim | null | undefined;
 orgId: string | null | undefined;
 orgRole: OrganizationCustomRoleKey | null | undefined;
 orgSlug: string | null | undefined;
Expand Down

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

Skip to content
chore(types): Deprecate old jwt types#5354

New issue

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

 Sign up for GitHub

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

Already on GitHub?
Sign in
to your account

 Merged

panteliselef
merged 3 commits into

from

Mar 15, 2025
 Merged


chore(types): Deprecate old jwt types
#5354
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
8ca008b

chore(types): Deprecate old jwt types


panteliselef Mar 14, 2025
8edaa89

update usage


panteliselef Mar 14, 2025
ac6f78c

changeset


panteliselef Mar 14, 2025

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


9 changes: 9 additions & 0 deletions
.changeset/thick-bags-promise.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
---
'@clerk/clerk-js': minor
'@clerk/astro': minor
'@clerk/clerk-react': minor
'@clerk/types': minor
'@clerk/vue': minor
---

Deprecate out of date jwt types in favour of existing that are up-to-date.

6 changes: 3 additions & 3 deletions
packages/astro/src/react/hooks.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
import type {
ActJWTClaim,
ActClaim,
 CheckAuthorizationWithCustomPermissions,
 Clerk,
 GetToken,
Expand DownExpand Up@@ -85,7 +85,7 @@ type UseAuthReturn =
 isSignedIn: true;
 userId: string;
 sessionId: string;
 actor: ActJWTClaim | null;
 actor: ActClaim | null;
 orgId: null;
 orgRole: null;
 orgSlug: null;
Expand All@@ -98,7 +98,7 @@ type UseAuthReturn =
 isSignedIn: true;
 userId: string;
 sessionId: string;
 actor: ActJWTClaim | null;
 actor: ActClaim | null;
 orgId: string;
 orgRole: OrganizationCustomRoleKey;
 orgSlug: string | null;
Expand Down

4 changes: 2 additions & 2 deletions
packages/clerk-js/src/core/resources/Session.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,7 +3,7 @@ import { ClerkWebAuthnError, is4xxError } from '@clerk/shared/error';
import { retry } from '@clerk/shared/retry';
import { isWebAuthnSupported as isWebAuthnSupportedOnWindow } from '@clerk/shared/webauthn';
import type {
ActJWTClaim,
ActClaim,
 CheckAuthorization,
 EmailCodeConfig,
 GetToken,
Expand DownExpand Up@@ -45,7 +45,7 @@ export class Session extends BaseResource implements SessionResource {
 lastActiveAt!: Date;
 lastActiveToken!: TokenResource | null;
 lastActiveOrganizationId!: string | null;
 actor!: ActJWTClaim | null;
 actor!: ActClaim | null;
 user!: UserResource | null;
 publicUserData!: PublicUserData;
 factorVerificationAge: [number, number] | null = null;
Expand Down

4 changes: 2 additions & 2 deletions
packages/clerk-js/src/core/resources/SessionWithActivities.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
import type {
ActJWTClaim,
ActClaim,
 SessionActivity,
 SessionActivityJSON,
 SessionWithActivitiesJSON,
Expand DownExpand Up@@ -28,7 +28,7 @@ export class SessionWithActivities extends BaseResource implements SessionWithAc
 expireAt!: Date;
 lastActiveAt!: Date;
 latestActivity!: SessionActivity;
 actor!: ActJWTClaim | null;
 actor!: ActClaim | null;

 constructor(data: SessionWithActivitiesJSON, pathRoot: string) {
 super();
Expand Down

4 changes: 2 additions & 2 deletions
packages/clerk-js/src/utils/jwt.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
import type { JWT, JWTClaims } from '@clerk/types';
import type { JWT, JwtPayload } from '@clerk/types';

import { urlDecodeB64 } from './encoders';

Expand All@@ -11,7 +11,7 @@ export function decode(token: string): JWT {
 }

 const payloadJSON = JSON.parse(urlDecodeB64(payload));
 const claims = { __raw: token } as JWTClaims;
 const claims = { __raw: token } as JwtPayload;

 Object.keys(payloadJSON).forEach(k => {
 claims[k] = payloadJSON[k];
Expand Down

4 changes: 2 additions & 2 deletions
packages/react/src/contexts/AuthContext.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
import { createContextAndHook } from '@clerk/shared/react';
import type { ActJWTClaim, OrganizationCustomPermissionKey, OrganizationCustomRoleKey } from '@clerk/types';
import type { ActClaim, OrganizationCustomPermissionKey, OrganizationCustomRoleKey } from '@clerk/types';

export type AuthContextValue = {
 userId: string | null | undefined;
 sessionId: string | null | undefined;
 actor: ActJWTClaim | null | undefined;
 actor: ActClaim | null | undefined;
 orgId: string | null | undefined;
 orgRole: OrganizationCustomRoleKey | null | undefined;
 orgSlug: string | null | undefined;
Expand Down

6 changes: 3 additions & 3 deletions
packages/types/src/hooks.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,7 +2,7 @@ import type { OrganizationCustomRoleKey } from 'organizationMembership';
import type { SignInResource } from 'signIn';

import type { SetActive, SignOut } from './clerk';
import type { ActJWTClaim } from './jwt';
import type { ActClaim } from './jwtv2';
import type {
 CheckAuthorizationWithCustomPermissions,
 GetToken,
Expand DownExpand Up@@ -83,7 +83,7 @@ export type UseAuthReturn =
 isSignedIn: true;
 userId: string;
 sessionId: string;
 actor: ActJWTClaim | null;
 actor: ActClaim | null;
 orgId: null;
 orgRole: null;
 orgSlug: null;
Expand All@@ -96,7 +96,7 @@ export type UseAuthReturn =
 isSignedIn: true;
 userId: string;
 sessionId: string;
 actor: ActJWTClaim | null;
 actor: ActClaim | null;
 orgId: string;
 orgRole: OrganizationCustomRoleKey;
 orgSlug: string | null;
Expand Down

4 changes: 2 additions & 2 deletions
packages/types/src/json.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,7 +5,7 @@
import type { __experimental_CommerceSettingsJSON } from './commerceSettings';
import type { DisplayConfigJSON } from './displayConfig';
import type { EnterpriseProtocol, EnterpriseProvider } from './enterpriseAccount';
import type { ActJWTClaim } from './jwt';
import type { ActClaim } from './jwtv2';
import type { OAuthProvider } from './oauth';
import type { OrganizationDomainVerificationStatus, OrganizationEnrollmentMode } from './organizationDomain';
import type { OrganizationInvitationStatus } from './organizationInvitation';
Expand DownExpand Up@@ -118,7 +118,7 @@ export interface SessionJSON extends ClerkResourceJSON {
 last_active_at: number;
 last_active_token: TokenJSON;
 last_active_organization_id: string | null;
 actor: ActJWTClaim | null;
 actor: ActClaim | null;
 tasks: Array<SessionTask> | null;
 user: UserJSON;
 public_user_data: PublicUserDataJSON;
Expand Down

23 changes: 19 additions & 4 deletions
packages/types/src/jwt.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,14 +1,18 @@
import type { ActClaim, JwtHeader, JwtPayload } from './jwtv2';
import type { OrganizationCustomRoleKey } from './organizationMembership';

export interface JWT {
 encoded: { header: string; payload: string; signature: string };
 header: JWTHeader;
 claims: JWTClaims;
 header: JwtHeader;
 claims: JwtPayload;
}

type NonEmptyArray<T> = [T, ...T[]];

// standard names https://www.rfc-editor.org/rfc/rfc7515.html#section-4.1
/**
 * @deprecated use `JwtHeader` instead
 */
export interface JWTHeader {
 alg: string | Algorithm;
 typ?: string;
Expand All@@ -22,14 +26,20 @@ export interface JWTHeader {
 x5c?: string | string[];
}

/**
 * @deprecated use `JwtPayload` instead
 */
export interface JWTClaims extends ClerkJWTClaims {
 /**
 * Encoded token supporting the `getRawString` method.
 */
 __raw: string;
}

/* Clerk-issued JWT payload */
/**
 * Clerk-issued JWT payload
 * @deprecated use `JwtPayload` instead
 */
export interface ClerkJWTClaims {
 /**
 * JWT Issuer - [RFC7519#section-4.1.1](https://tools.ietf.org/html/rfc7519#section-4.1.1).
Expand DownExpand Up@@ -69,7 +79,7 @@ export interface ClerkJWTClaims {
 /**
 * JWT Actor - [RFC8693](https://www.rfc-editor.org/rfc/rfc8693.html#name-act-actor-claim).
 */
 act?: ActJWTClaim;
 act?: ActClaim;

 /**
 * Active organization id.
Expand All@@ -95,10 +105,15 @@ export interface ClerkJWTClaims {
/**
 * JWT Actor - [RFC8693](https://www.rfc-editor.org/rfc/rfc8693.html#name-act-actor-claim).
 * @inline
 * @deprecated use `ActClaim` instead
 */
export interface ActJWTClaim {
 sub: string;

 [x: string]: unknown;
}

/**
 * @deprecated This type will be removed in the next major version.
 */
export type OrganizationsJWTClaim = Record<string, OrganizationCustomRoleKey>;

1 change: 0 additions & 1 deletion
packages/types/src/jwtv2.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -119,6 +119,5 @@ export interface JwtPayload extends CustomJwtSessionClaims {
 */
export interface ActClaim {
 sub: string;

 [x: string]: unknown;
}

6 changes: 3 additions & 3 deletions
packages/types/src/session.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,7 +10,7 @@ import type {
 PhoneCodeSecondFactorConfig,
 TOTPAttempt,
} from './factors';
import type { ActJWTClaim } from './jwt';
import type { ActClaim } from './jwtv2';
import type {
 OrganizationCustomPermissionKey,
 OrganizationCustomRoleKey,
Expand DownExpand Up@@ -122,7 +122,7 @@ export interface SessionResource extends ClerkResource {
 lastActiveToken: TokenResource | null;
 lastActiveOrganizationId: string | null;
 lastActiveAt: Date;
 actor: ActJWTClaim | null;
 actor: ActClaim | null;
 tasks: Array<SessionTask> | null;
 currentTask?: SessionTask;
 /**
Expand DownExpand Up@@ -190,7 +190,7 @@ export interface SessionWithActivitiesResource extends ClerkResource {
 abandonAt: Date;
 lastActiveAt: Date;
 latestActivity: SessionActivity;
 actor: ActJWTClaim | null;
 actor: ActClaim | null;

 revoke: () => Promise<SessionWithActivitiesResource>;
}
Expand Down

4 changes: 2 additions & 2 deletions
packages/vue/src/types.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
import type {
ActJWTClaim,
ActClaim,
 Clerk,
 ClerkOptions,
 ClientResource,
Expand All@@ -19,7 +19,7 @@ export interface VueClerkInjectionKeyType {
 authCtx: ComputedRef<{
 userId: string | null | undefined;
 sessionId: string | null | undefined;
 actor: ActJWTClaim | null | undefined;
 actor: ActClaim | null | undefined;
 orgId: string | null | undefined;
 orgRole: OrganizationCustomRoleKey | null | undefined;
 orgSlug: string | null | undefined;
Expand Down

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

Skip to content
chore(types): Deprecate old jwt types#5354

New issue

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

 Sign up for GitHub

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

Already on GitHub?
Sign in
to your account

 Merged

panteliselef
merged 3 commits into

from

Mar 15, 2025
 Merged


chore(types): Deprecate old jwt types
#5354
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
8ca008b

chore(types): Deprecate old jwt types


panteliselef Mar 14, 2025
8edaa89

update usage


panteliselef Mar 14, 2025
ac6f78c

changeset


panteliselef Mar 14, 2025

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


9 changes: 9 additions & 0 deletions
.changeset/thick-bags-promise.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
---
'@clerk/clerk-js': minor
'@clerk/astro': minor
'@clerk/clerk-react': minor
'@clerk/types': minor
'@clerk/vue': minor
---

Deprecate out of date jwt types in favour of existing that are up-to-date.

6 changes: 3 additions & 3 deletions
packages/astro/src/react/hooks.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
import type {
ActJWTClaim,
ActClaim,
 CheckAuthorizationWithCustomPermissions,
 Clerk,
 GetToken,
Expand DownExpand Up@@ -85,7 +85,7 @@ type UseAuthReturn =
 isSignedIn: true;
 userId: string;
 sessionId: string;
 actor: ActJWTClaim | null;
 actor: ActClaim | null;
 orgId: null;
 orgRole: null;
 orgSlug: null;
Expand All@@ -98,7 +98,7 @@ type UseAuthReturn =
 isSignedIn: true;
 userId: string;
 sessionId: string;
 actor: ActJWTClaim | null;
 actor: ActClaim | null;
 orgId: string;
 orgRole: OrganizationCustomRoleKey;
 orgSlug: string | null;
Expand Down

4 changes: 2 additions & 2 deletions
packages/clerk-js/src/core/resources/Session.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,7 +3,7 @@ import { ClerkWebAuthnError, is4xxError } from '@clerk/shared/error';
import { retry } from '@clerk/shared/retry';
import { isWebAuthnSupported as isWebAuthnSupportedOnWindow } from '@clerk/shared/webauthn';
import type {
ActJWTClaim,
ActClaim,
 CheckAuthorization,
 EmailCodeConfig,
 GetToken,
Expand DownExpand Up@@ -45,7 +45,7 @@ export class Session extends BaseResource implements SessionResource {
 lastActiveAt!: Date;
 lastActiveToken!: TokenResource | null;
 lastActiveOrganizationId!: string | null;
 actor!: ActJWTClaim | null;
 actor!: ActClaim | null;
 user!: UserResource | null;
 publicUserData!: PublicUserData;
 factorVerificationAge: [number, number] | null = null;
Expand Down

4 changes: 2 additions & 2 deletions
packages/clerk-js/src/core/resources/SessionWithActivities.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
import type {
ActJWTClaim,
ActClaim,
 SessionActivity,
 SessionActivityJSON,
 SessionWithActivitiesJSON,
Expand DownExpand Up@@ -28,7 +28,7 @@ export class SessionWithActivities extends BaseResource implements SessionWithAc
 expireAt!: Date;
 lastActiveAt!: Date;
 latestActivity!: SessionActivity;
 actor!: ActJWTClaim | null;
 actor!: ActClaim | null;

 constructor(data: SessionWithActivitiesJSON, pathRoot: string) {
 super();
Expand Down

4 changes: 2 additions & 2 deletions
packages/clerk-js/src/utils/jwt.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
import type { JWT, JWTClaims } from '@clerk/types';
import type { JWT, JwtPayload } from '@clerk/types';

import { urlDecodeB64 } from './encoders';

Expand All@@ -11,7 +11,7 @@ export function decode(token: string): JWT {
 }

 const payloadJSON = JSON.parse(urlDecodeB64(payload));
 const claims = { __raw: token } as JWTClaims;
 const claims = { __raw: token } as JwtPayload;

 Object.keys(payloadJSON).forEach(k => {
 claims[k] = payloadJSON[k];
Expand Down

4 changes: 2 additions & 2 deletions
packages/react/src/contexts/AuthContext.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
import { createContextAndHook } from '@clerk/shared/react';
import type { ActJWTClaim, OrganizationCustomPermissionKey, OrganizationCustomRoleKey } from '@clerk/types';
import type { ActClaim, OrganizationCustomPermissionKey, OrganizationCustomRoleKey } from '@clerk/types';

export type AuthContextValue = {
 userId: string | null | undefined;
 sessionId: string | null | undefined;
 actor: ActJWTClaim | null | undefined;
 actor: ActClaim | null | undefined;
 orgId: string | null | undefined;
 orgRole: OrganizationCustomRoleKey | null | undefined;
 orgSlug: string | null | undefined;
Expand Down

6 changes: 3 additions & 3 deletions
packages/types/src/hooks.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,7 +2,7 @@ import type { OrganizationCustomRoleKey } from 'organizationMembership';
import type { SignInResource } from 'signIn';

import type { SetActive, SignOut } from './clerk';
import type { ActJWTClaim } from './jwt';
import type { ActClaim } from './jwtv2';
import type {
 CheckAuthorizationWithCustomPermissions,
 GetToken,
Expand DownExpand Up@@ -83,7 +83,7 @@ export type UseAuthReturn =
 isSignedIn: true;
 userId: string;
 sessionId: string;
 actor: ActJWTClaim | null;
 actor: ActClaim | null;
 orgId: null;
 orgRole: null;
 orgSlug: null;
Expand All@@ -96,7 +96,7 @@ export type UseAuthReturn =
 isSignedIn: true;
 userId: string;
 sessionId: string;
 actor: ActJWTClaim | null;
 actor: ActClaim | null;
 orgId: string;
 orgRole: OrganizationCustomRoleKey;
 orgSlug: string | null;
Expand Down

4 changes: 2 additions & 2 deletions
packages/types/src/json.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,7 +5,7 @@
import type { __experimental_CommerceSettingsJSON } from './commerceSettings';
import type { DisplayConfigJSON } from './displayConfig';
import type { EnterpriseProtocol, EnterpriseProvider } from './enterpriseAccount';
import type { ActJWTClaim } from './jwt';
import type { ActClaim } from './jwtv2';
import type { OAuthProvider } from './oauth';
import type { OrganizationDomainVerificationStatus, OrganizationEnrollmentMode } from './organizationDomain';
import type { OrganizationInvitationStatus } from './organizationInvitation';
Expand DownExpand Up@@ -118,7 +118,7 @@ export interface SessionJSON extends ClerkResourceJSON {
 last_active_at: number;
 last_active_token: TokenJSON;
 last_active_organization_id: string | null;
 actor: ActJWTClaim | null;
 actor: ActClaim | null;
 tasks: Array<SessionTask> | null;
 user: UserJSON;
 public_user_data: PublicUserDataJSON;
Expand Down

23 changes: 19 additions & 4 deletions
packages/types/src/jwt.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,14 +1,18 @@
import type { ActClaim, JwtHeader, JwtPayload } from './jwtv2';
import type { OrganizationCustomRoleKey } from './organizationMembership';

export interface JWT {
 encoded: { header: string; payload: string; signature: string };
 header: JWTHeader;
 claims: JWTClaims;
 header: JwtHeader;
 claims: JwtPayload;
}

type NonEmptyArray<T> = [T, ...T[]];

// standard names https://www.rfc-editor.org/rfc/rfc7515.html#section-4.1
/**
 * @deprecated use `JwtHeader` instead
 */
export interface JWTHeader {
 alg: string | Algorithm;
 typ?: string;
Expand All@@ -22,14 +26,20 @@ export interface JWTHeader {
 x5c?: string | string[];
}

/**
 * @deprecated use `JwtPayload` instead
 */
export interface JWTClaims extends ClerkJWTClaims {
 /**
 * Encoded token supporting the `getRawString` method.
 */
 __raw: string;
}

/* Clerk-issued JWT payload */
/**
 * Clerk-issued JWT payload
 * @deprecated use `JwtPayload` instead
 */
export interface ClerkJWTClaims {
 /**
 * JWT Issuer - [RFC7519#section-4.1.1](https://tools.ietf.org/html/rfc7519#section-4.1.1).
Expand DownExpand Up@@ -69,7 +79,7 @@ export interface ClerkJWTClaims {
 /**
 * JWT Actor - [RFC8693](https://www.rfc-editor.org/rfc/rfc8693.html#name-act-actor-claim).
 */
 act?: ActJWTClaim;
 act?: ActClaim;

 /**
 * Active organization id.
Expand All@@ -95,10 +105,15 @@ export interface ClerkJWTClaims {
/**
 * JWT Actor - [RFC8693](https://www.rfc-editor.org/rfc/rfc8693.html#name-act-actor-claim).
 * @inline
 * @deprecated use `ActClaim` instead
 */
export interface ActJWTClaim {
 sub: string;

 [x: string]: unknown;
}

/**
 * @deprecated This type will be removed in the next major version.
 */
export type OrganizationsJWTClaim = Record<string, OrganizationCustomRoleKey>;

1 change: 0 additions & 1 deletion
packages/types/src/jwtv2.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -119,6 +119,5 @@ export interface JwtPayload extends CustomJwtSessionClaims {
 */
export interface ActClaim {
 sub: string;

 [x: string]: unknown;
}

6 changes: 3 additions & 3 deletions
packages/types/src/session.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,7 +10,7 @@ import type {
 PhoneCodeSecondFactorConfig,
 TOTPAttempt,
} from './factors';
import type { ActJWTClaim } from './jwt';
import type { ActClaim } from './jwtv2';
import type {
 OrganizationCustomPermissionKey,
 OrganizationCustomRoleKey,
Expand DownExpand Up@@ -122,7 +122,7 @@ export interface SessionResource extends ClerkResource {
 lastActiveToken: TokenResource | null;
 lastActiveOrganizationId: string | null;
 lastActiveAt: Date;
 actor: ActJWTClaim | null;
 actor: ActClaim | null;
 tasks: Array<SessionTask> | null;
 currentTask?: SessionTask;
 /**
Expand DownExpand Up@@ -190,7 +190,7 @@ export interface SessionWithActivitiesResource extends ClerkResource {
 abandonAt: Date;
 lastActiveAt: Date;
 latestActivity: SessionActivity;
 actor: ActJWTClaim | null;
 actor: ActClaim | null;

 revoke: () => Promise<SessionWithActivitiesResource>;
}
Expand Down

4 changes: 2 additions & 2 deletions
packages/vue/src/types.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
import type {
ActJWTClaim,
ActClaim,
 Clerk,
 ClerkOptions,
 ClientResource,
Expand All@@ -19,7 +19,7 @@ export interface VueClerkInjectionKeyType {
 authCtx: ComputedRef<{
 userId: string | null | undefined;
 sessionId: string | null | undefined;
 actor: ActJWTClaim | null | undefined;
 actor: ActClaim | null | undefined;
 orgId: string | null | undefined;
 orgRole: OrganizationCustomRoleKey | null | undefined;
 orgSlug: string | null | undefined;
Expand Down

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

Skip to content
chore(types): Deprecate old jwt types#5354

New issue

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

 Sign up for GitHub

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

Already on GitHub?
Sign in
to your account

 Merged

panteliselef
merged 3 commits into

from

Mar 15, 2025
 Merged


chore(types): Deprecate old jwt types
#5354
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
8ca008b

chore(types): Deprecate old jwt types


panteliselef Mar 14, 2025
8edaa89

update usage


panteliselef Mar 14, 2025
ac6f78c

changeset


panteliselef Mar 14, 2025

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


9 changes: 9 additions & 0 deletions
.changeset/thick-bags-promise.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
---
'@clerk/clerk-js': minor
'@clerk/astro': minor
'@clerk/clerk-react': minor
'@clerk/types': minor
'@clerk/vue': minor
---

Deprecate out of date jwt types in favour of existing that are up-to-date.

6 changes: 3 additions & 3 deletions
packages/astro/src/react/hooks.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
import type {
ActJWTClaim,
ActClaim,
 CheckAuthorizationWithCustomPermissions,
 Clerk,
 GetToken,
Expand DownExpand Up@@ -85,7 +85,7 @@ type UseAuthReturn =
 isSignedIn: true;
 userId: string;
 sessionId: string;
 actor: ActJWTClaim | null;
 actor: ActClaim | null;
 orgId: null;
 orgRole: null;
 orgSlug: null;
Expand All@@ -98,7 +98,7 @@ type UseAuthReturn =
 isSignedIn: true;
 userId: string;
 sessionId: string;
 actor: ActJWTClaim | null;
 actor: ActClaim | null;
 orgId: string;
 orgRole: OrganizationCustomRoleKey;
 orgSlug: string | null;
Expand Down

4 changes: 2 additions & 2 deletions
packages/clerk-js/src/core/resources/Session.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,7 +3,7 @@ import { ClerkWebAuthnError, is4xxError } from '@clerk/shared/error';
import { retry } from '@clerk/shared/retry';
import { isWebAuthnSupported as isWebAuthnSupportedOnWindow } from '@clerk/shared/webauthn';
import type {
ActJWTClaim,
ActClaim,
 CheckAuthorization,
 EmailCodeConfig,
 GetToken,
Expand DownExpand Up@@ -45,7 +45,7 @@ export class Session extends BaseResource implements SessionResource {
 lastActiveAt!: Date;
 lastActiveToken!: TokenResource | null;
 lastActiveOrganizationId!: string | null;
 actor!: ActJWTClaim | null;
 actor!: ActClaim | null;
 user!: UserResource | null;
 publicUserData!: PublicUserData;
 factorVerificationAge: [number, number] | null = null;
Expand Down

4 changes: 2 additions & 2 deletions
packages/clerk-js/src/core/resources/SessionWithActivities.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
import type {
ActJWTClaim,
ActClaim,
 SessionActivity,
 SessionActivityJSON,
 SessionWithActivitiesJSON,
Expand DownExpand Up@@ -28,7 +28,7 @@ export class SessionWithActivities extends BaseResource implements SessionWithAc
 expireAt!: Date;
 lastActiveAt!: Date;
 latestActivity!: SessionActivity;
 actor!: ActJWTClaim | null;
 actor!: ActClaim | null;

 constructor(data: SessionWithActivitiesJSON, pathRoot: string) {
 super();
Expand Down

4 changes: 2 additions & 2 deletions
packages/clerk-js/src/utils/jwt.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
import type { JWT, JWTClaims } from '@clerk/types';
import type { JWT, JwtPayload } from '@clerk/types';

import { urlDecodeB64 } from './encoders';

Expand All@@ -11,7 +11,7 @@ export function decode(token: string): JWT {
 }

 const payloadJSON = JSON.parse(urlDecodeB64(payload));
 const claims = { __raw: token } as JWTClaims;
 const claims = { __raw: token } as JwtPayload;

 Object.keys(payloadJSON).forEach(k => {
 claims[k] = payloadJSON[k];
Expand Down

4 changes: 2 additions & 2 deletions
packages/react/src/contexts/AuthContext.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
import { createContextAndHook } from '@clerk/shared/react';
import type { ActJWTClaim, OrganizationCustomPermissionKey, OrganizationCustomRoleKey } from '@clerk/types';
import type { ActClaim, OrganizationCustomPermissionKey, OrganizationCustomRoleKey } from '@clerk/types';

export type AuthContextValue = {
 userId: string | null | undefined;
 sessionId: string | null | undefined;
 actor: ActJWTClaim | null | undefined;
 actor: ActClaim | null | undefined;
 orgId: string | null | undefined;
 orgRole: OrganizationCustomRoleKey | null | undefined;
 orgSlug: string | null | undefined;
Expand Down

6 changes: 3 additions & 3 deletions
packages/types/src/hooks.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,7 +2,7 @@ import type { OrganizationCustomRoleKey } from 'organizationMembership';
import type { SignInResource } from 'signIn';

import type { SetActive, SignOut } from './clerk';
import type { ActJWTClaim } from './jwt';
import type { ActClaim } from './jwtv2';
import type {
 CheckAuthorizationWithCustomPermissions,
 GetToken,
Expand DownExpand Up@@ -83,7 +83,7 @@ export type UseAuthReturn =
 isSignedIn: true;
 userId: string;
 sessionId: string;
 actor: ActJWTClaim | null;
 actor: ActClaim | null;
 orgId: null;
 orgRole: null;
 orgSlug: null;
Expand All@@ -96,7 +96,7 @@ export type UseAuthReturn =
 isSignedIn: true;
 userId: string;
 sessionId: string;
 actor: ActJWTClaim | null;
 actor: ActClaim | null;
 orgId: string;
 orgRole: OrganizationCustomRoleKey;
 orgSlug: string | null;
Expand Down

4 changes: 2 additions & 2 deletions
packages/types/src/json.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,7 +5,7 @@
import type { __experimental_CommerceSettingsJSON } from './commerceSettings';
import type { DisplayConfigJSON } from './displayConfig';
import type { EnterpriseProtocol, EnterpriseProvider } from './enterpriseAccount';
import type { ActJWTClaim } from './jwt';
import type { ActClaim } from './jwtv2';
import type { OAuthProvider } from './oauth';
import type { OrganizationDomainVerificationStatus, OrganizationEnrollmentMode } from './organizationDomain';
import type { OrganizationInvitationStatus } from './organizationInvitation';
Expand DownExpand Up@@ -118,7 +118,7 @@ export interface SessionJSON extends ClerkResourceJSON {
 last_active_at: number;
 last_active_token: TokenJSON;
 last_active_organization_id: string | null;
 actor: ActJWTClaim | null;
 actor: ActClaim | null;
 tasks: Array<SessionTask> | null;
 user: UserJSON;
 public_user_data: PublicUserDataJSON;
Expand Down

23 changes: 19 additions & 4 deletions
packages/types/src/jwt.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,14 +1,18 @@
import type { ActClaim, JwtHeader, JwtPayload } from './jwtv2';
import type { OrganizationCustomRoleKey } from './organizationMembership';

export interface JWT {
 encoded: { header: string; payload: string; signature: string };
 header: JWTHeader;
 claims: JWTClaims;
 header: JwtHeader;
 claims: JwtPayload;
}

type NonEmptyArray<T> = [T, ...T[]];

// standard names https://www.rfc-editor.org/rfc/rfc7515.html#section-4.1
/**
 * @deprecated use `JwtHeader` instead
 */
export interface JWTHeader {
 alg: string | Algorithm;
 typ?: string;
Expand All@@ -22,14 +26,20 @@ export interface JWTHeader {
 x5c?: string | string[];
}

/**
 * @deprecated use `JwtPayload` instead
 */
export interface JWTClaims extends ClerkJWTClaims {
 /**
 * Encoded token supporting the `getRawString` method.
 */
 __raw: string;
}

/* Clerk-issued JWT payload */
/**
 * Clerk-issued JWT payload
 * @deprecated use `JwtPayload` instead
 */
export interface ClerkJWTClaims {
 /**
 * JWT Issuer - [RFC7519#section-4.1.1](https://tools.ietf.org/html/rfc7519#section-4.1.1).
Expand DownExpand Up@@ -69,7 +79,7 @@ export interface ClerkJWTClaims {
 /**
 * JWT Actor - [RFC8693](https://www.rfc-editor.org/rfc/rfc8693.html#name-act-actor-claim).
 */
 act?: ActJWTClaim;
 act?: ActClaim;

 /**
 * Active organization id.
Expand All@@ -95,10 +105,15 @@ export interface ClerkJWTClaims {
/**
 * JWT Actor - [RFC8693](https://www.rfc-editor.org/rfc/rfc8693.html#name-act-actor-claim).
 * @inline
 * @deprecated use `ActClaim` instead
 */
export interface ActJWTClaim {
 sub: string;

 [x: string]: unknown;
}

/**
 * @deprecated This type will be removed in the next major version.
 */
export type OrganizationsJWTClaim = Record<string, OrganizationCustomRoleKey>;

1 change: 0 additions & 1 deletion
packages/types/src/jwtv2.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -119,6 +119,5 @@ export interface JwtPayload extends CustomJwtSessionClaims {
 */
export interface ActClaim {
 sub: string;

 [x: string]: unknown;
}

6 changes: 3 additions & 3 deletions
packages/types/src/session.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,7 +10,7 @@ import type {
 PhoneCodeSecondFactorConfig,
 TOTPAttempt,
} from './factors';
import type { ActJWTClaim } from './jwt';
import type { ActClaim } from './jwtv2';
import type {
 OrganizationCustomPermissionKey,
 OrganizationCustomRoleKey,
Expand DownExpand Up@@ -122,7 +122,7 @@ export interface SessionResource extends ClerkResource {
 lastActiveToken: TokenResource | null;
 lastActiveOrganizationId: string | null;
 lastActiveAt: Date;
 actor: ActJWTClaim | null;
 actor: ActClaim | null;
 tasks: Array<SessionTask> | null;
 currentTask?: SessionTask;
 /**
Expand DownExpand Up@@ -190,7 +190,7 @@ export interface SessionWithActivitiesResource extends ClerkResource {
 abandonAt: Date;
 lastActiveAt: Date;
 latestActivity: SessionActivity;
 actor: ActJWTClaim | null;
 actor: ActClaim | null;

 revoke: () => Promise<SessionWithActivitiesResource>;
}
Expand Down

4 changes: 2 additions & 2 deletions
packages/vue/src/types.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
import type {
ActJWTClaim,
ActClaim,
 Clerk,
 ClerkOptions,
 ClientResource,
Expand All@@ -19,7 +19,7 @@ export interface VueClerkInjectionKeyType {
 authCtx: ComputedRef<{
 userId: string | null | undefined;
 sessionId: string | null | undefined;
 actor: ActJWTClaim | null | undefined;
 actor: ActClaim | null | undefined;
 orgId: string | null | undefined;
 orgRole: OrganizationCustomRoleKey | null | undefined;
 orgSlug: string | null | undefined;
Expand Down

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

Skip to content
chore(types): Deprecate old jwt types#5354

New issue

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

 Sign up for GitHub

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

Already on GitHub?
Sign in
to your account

 Merged

panteliselef
merged 3 commits into

from

Mar 15, 2025
 Merged


chore(types): Deprecate old jwt types
#5354
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
8ca008b

chore(types): Deprecate old jwt types


panteliselef Mar 14, 2025
8edaa89

update usage


panteliselef Mar 14, 2025
ac6f78c

changeset


panteliselef Mar 14, 2025

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


9 changes: 9 additions & 0 deletions
.changeset/thick-bags-promise.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
---
'@clerk/clerk-js': minor
'@clerk/astro': minor
'@clerk/clerk-react': minor
'@clerk/types': minor
'@clerk/vue': minor
---

Deprecate out of date jwt types in favour of existing that are up-to-date.

6 changes: 3 additions & 3 deletions
packages/astro/src/react/hooks.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
import type {
ActJWTClaim,
ActClaim,
 CheckAuthorizationWithCustomPermissions,
 Clerk,
 GetToken,
Expand DownExpand Up@@ -85,7 +85,7 @@ type UseAuthReturn =
 isSignedIn: true;
 userId: string;
 sessionId: string;
 actor: ActJWTClaim | null;
 actor: ActClaim | null;
 orgId: null;
 orgRole: null;
 orgSlug: null;
Expand All@@ -98,7 +98,7 @@ type UseAuthReturn =
 isSignedIn: true;
 userId: string;
 sessionId: string;
 actor: ActJWTClaim | null;
 actor: ActClaim | null;
 orgId: string;
 orgRole: OrganizationCustomRoleKey;
 orgSlug: string | null;
Expand Down

4 changes: 2 additions & 2 deletions
packages/clerk-js/src/core/resources/Session.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,7 +3,7 @@ import { ClerkWebAuthnError, is4xxError } from '@clerk/shared/error';
import { retry } from '@clerk/shared/retry';
import { isWebAuthnSupported as isWebAuthnSupportedOnWindow } from '@clerk/shared/webauthn';
import type {
ActJWTClaim,
ActClaim,
 CheckAuthorization,
 EmailCodeConfig,
 GetToken,
Expand DownExpand Up@@ -45,7 +45,7 @@ export class Session extends BaseResource implements SessionResource {
 lastActiveAt!: Date;
 lastActiveToken!: TokenResource | null;
 lastActiveOrganizationId!: string | null;
 actor!: ActJWTClaim | null;
 actor!: ActClaim | null;
 user!: UserResource | null;
 publicUserData!: PublicUserData;
 factorVerificationAge: [number, number] | null = null;
Expand Down

4 changes: 2 additions & 2 deletions
packages/clerk-js/src/core/resources/SessionWithActivities.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
import type {
ActJWTClaim,
ActClaim,
 SessionActivity,
 SessionActivityJSON,
 SessionWithActivitiesJSON,
Expand DownExpand Up@@ -28,7 +28,7 @@ export class SessionWithActivities extends BaseResource implements SessionWithAc
 expireAt!: Date;
 lastActiveAt!: Date;
 latestActivity!: SessionActivity;
 actor!: ActJWTClaim | null;
 actor!: ActClaim | null;

 constructor(data: SessionWithActivitiesJSON, pathRoot: string) {
 super();
Expand Down

4 changes: 2 additions & 2 deletions
packages/clerk-js/src/utils/jwt.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
import type { JWT, JWTClaims } from '@clerk/types';
import type { JWT, JwtPayload } from '@clerk/types';

import { urlDecodeB64 } from './encoders';

Expand All@@ -11,7 +11,7 @@ export function decode(token: string): JWT {
 }

 const payloadJSON = JSON.parse(urlDecodeB64(payload));
 const claims = { __raw: token } as JWTClaims;
 const claims = { __raw: token } as JwtPayload;

 Object.keys(payloadJSON).forEach(k => {
 claims[k] = payloadJSON[k];
Expand Down

4 changes: 2 additions & 2 deletions
packages/react/src/contexts/AuthContext.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
import { createContextAndHook } from '@clerk/shared/react';
import type { ActJWTClaim, OrganizationCustomPermissionKey, OrganizationCustomRoleKey } from '@clerk/types';
import type { ActClaim, OrganizationCustomPermissionKey, OrganizationCustomRoleKey } from '@clerk/types';

export type AuthContextValue = {
 userId: string | null | undefined;
 sessionId: string | null | undefined;
 actor: ActJWTClaim | null | undefined;
 actor: ActClaim | null | undefined;
 orgId: string | null | undefined;
 orgRole: OrganizationCustomRoleKey | null | undefined;
 orgSlug: string | null | undefined;
Expand Down

6 changes: 3 additions & 3 deletions
packages/types/src/hooks.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,7 +2,7 @@ import type { OrganizationCustomRoleKey } from 'organizationMembership';
import type { SignInResource } from 'signIn';

import type { SetActive, SignOut } from './clerk';
import type { ActJWTClaim } from './jwt';
import type { ActClaim } from './jwtv2';
import type {
 CheckAuthorizationWithCustomPermissions,
 GetToken,
Expand DownExpand Up@@ -83,7 +83,7 @@ export type UseAuthReturn =
 isSignedIn: true;
 userId: string;
 sessionId: string;
 actor: ActJWTClaim | null;
 actor: ActClaim | null;
 orgId: null;
 orgRole: null;
 orgSlug: null;
Expand All@@ -96,7 +96,7 @@ export type UseAuthReturn =
 isSignedIn: true;
 userId: string;
 sessionId: string;
 actor: ActJWTClaim | null;
 actor: ActClaim | null;
 orgId: string;
 orgRole: OrganizationCustomRoleKey;
 orgSlug: string | null;
Expand Down

4 changes: 2 additions & 2 deletions
packages/types/src/json.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,7 +5,7 @@
import type { __experimental_CommerceSettingsJSON } from './commerceSettings';
import type { DisplayConfigJSON } from './displayConfig';
import type { EnterpriseProtocol, EnterpriseProvider } from './enterpriseAccount';
import type { ActJWTClaim } from './jwt';
import type { ActClaim } from './jwtv2';
import type { OAuthProvider } from './oauth';
import type { OrganizationDomainVerificationStatus, OrganizationEnrollmentMode } from './organizationDomain';
import type { OrganizationInvitationStatus } from './organizationInvitation';
Expand DownExpand Up@@ -118,7 +118,7 @@ export interface SessionJSON extends ClerkResourceJSON {
 last_active_at: number;
 last_active_token: TokenJSON;
 last_active_organization_id: string | null;
 actor: ActJWTClaim | null;
 actor: ActClaim | null;
 tasks: Array<SessionTask> | null;
 user: UserJSON;
 public_user_data: PublicUserDataJSON;
Expand Down

23 changes: 19 additions & 4 deletions
packages/types/src/jwt.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,14 +1,18 @@
import type { ActClaim, JwtHeader, JwtPayload } from './jwtv2';
import type { OrganizationCustomRoleKey } from './organizationMembership';

export interface JWT {
 encoded: { header: string; payload: string; signature: string };
 header: JWTHeader;
 claims: JWTClaims;
 header: JwtHeader;
 claims: JwtPayload;
}

type NonEmptyArray<T> = [T, ...T[]];

// standard names https://www.rfc-editor.org/rfc/rfc7515.html#section-4.1
/**
 * @deprecated use `JwtHeader` instead
 */
export interface JWTHeader {
 alg: string | Algorithm;
 typ?: string;
Expand All@@ -22,14 +26,20 @@ export interface JWTHeader {
 x5c?: string | string[];
}

/**
 * @deprecated use `JwtPayload` instead
 */
export interface JWTClaims extends ClerkJWTClaims {
 /**
 * Encoded token supporting the `getRawString` method.
 */
 __raw: string;
}

/* Clerk-issued JWT payload */
/**
 * Clerk-issued JWT payload
 * @deprecated use `JwtPayload` instead
 */
export interface ClerkJWTClaims {
 /**
 * JWT Issuer - [RFC7519#section-4.1.1](https://tools.ietf.org/html/rfc7519#section-4.1.1).
Expand DownExpand Up@@ -69,7 +79,7 @@ export interface ClerkJWTClaims {
 /**
 * JWT Actor - [RFC8693](https://www.rfc-editor.org/rfc/rfc8693.html#name-act-actor-claim).
 */
 act?: ActJWTClaim;
 act?: ActClaim;

 /**
 * Active organization id.
Expand All@@ -95,10 +105,15 @@ export interface ClerkJWTClaims {
/**
 * JWT Actor - [RFC8693](https://www.rfc-editor.org/rfc/rfc8693.html#name-act-actor-claim).
 * @inline
 * @deprecated use `ActClaim` instead
 */
export interface ActJWTClaim {
 sub: string;

 [x: string]: unknown;
}

/**
 * @deprecated This type will be removed in the next major version.
 */
export type OrganizationsJWTClaim = Record<string, OrganizationCustomRoleKey>;

1 change: 0 additions & 1 deletion
packages/types/src/jwtv2.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -119,6 +119,5 @@ export interface JwtPayload extends CustomJwtSessionClaims {
 */
export interface ActClaim {
 sub: string;

 [x: string]: unknown;
}

6 changes: 3 additions & 3 deletions
packages/types/src/session.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,7 +10,7 @@ import type {
 PhoneCodeSecondFactorConfig,
 TOTPAttempt,
} from './factors';
import type { ActJWTClaim } from './jwt';
import type { ActClaim } from './jwtv2';
import type {
 OrganizationCustomPermissionKey,
 OrganizationCustomRoleKey,
Expand DownExpand Up@@ -122,7 +122,7 @@ export interface SessionResource extends ClerkResource {
 lastActiveToken: TokenResource | null;
 lastActiveOrganizationId: string | null;
 lastActiveAt: Date;
 actor: ActJWTClaim | null;
 actor: ActClaim | null;
 tasks: Array<SessionTask> | null;
 currentTask?: SessionTask;
 /**
Expand DownExpand Up@@ -190,7 +190,7 @@ export interface SessionWithActivitiesResource extends ClerkResource {
 abandonAt: Date;
 lastActiveAt: Date;
 latestActivity: SessionActivity;
 actor: ActJWTClaim | null;
 actor: ActClaim | null;

 revoke: () => Promise<SessionWithActivitiesResource>;
}
Expand Down

4 changes: 2 additions & 2 deletions
packages/vue/src/types.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
import type {
ActJWTClaim,
ActClaim,
 Clerk,
 ClerkOptions,
 ClientResource,
Expand All@@ -19,7 +19,7 @@ export interface VueClerkInjectionKeyType {
 authCtx: ComputedRef<{
 userId: string | null | undefined;
 sessionId: string | null | undefined;
 actor: ActJWTClaim | null | undefined;
 actor: ActClaim | null | undefined;
 orgId: string | null | undefined;
 orgRole: OrganizationCustomRoleKey | null | undefined;
 orgSlug: string | null | undefined;
Expand Down