feat(backend): Replace enums with as const objects#2516

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
nikosdouvlis merged 2 commits into from
Jan 9, 2024
Merged

feat(backend): Replace enums with as const objects #2516

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6bb96e8
feat(backend): Replace enums with `as const` objects
nikosdouvlis Jan 9, 2024
7837827
Create many-moons-matter.md
nikosdouvlis Jan 9, 2024
File filter

Filter by extension

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

Replace enums with `as const` objects so `@clerk/backend` is consistent with the other packages
88 changes: 45 additions & 43 deletions packages/backend/src/api/resources/JSON.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -7,52 +7,54 @@ import type {
SignUpStatus,
} from './Enums';

export enum ObjectType {
AllowlistIdentifier = 'allowlist_identifier',
Client = 'client',
Email = 'email',
EmailAddress = 'email_address',
ExternalAccount = 'external_account',
FacebookAccount = 'facebook_account',
GoogleAccount = 'google_account',
Invitation = 'invitation',
OauthAccessToken = 'oauth_access_token',
Organization = 'organization',
OrganizationInvitation = 'organization_invitation',
OrganizationMembership = 'organization_membership',
PhoneNumber = 'phone_number',
RedirectUrl = 'redirect_url',
Session = 'session',
SignInAttempt = 'sign_in_attempt',
SignInToken = 'sign_in_token',
SignUpAttempt = 'sign_up_attempt',
SmsMessage = 'sms_message',
User = 'user',
Web3Wallet = 'web3_wallet',
Token = 'token',
TotalCount = 'total_count',
}
export const ObjectType = {
AllowlistIdentifier: 'allowlist_identifier',
Client: 'client',
Email: 'email',
EmailAddress: 'email_address',
ExternalAccount: 'external_account',
FacebookAccount: 'facebook_account',
GoogleAccount: 'google_account',
Invitation: 'invitation',
OauthAccessToken: 'oauth_access_token',
Organization: 'organization',
OrganizationInvitation: 'organization_invitation',
OrganizationMembership: 'organization_membership',
PhoneNumber: 'phone_number',
RedirectUrl: 'redirect_url',
Session: 'session',
SignInAttempt: 'sign_in_attempt',
SignInToken: 'sign_in_token',
SignUpAttempt: 'sign_up_attempt',
SmsMessage: 'sms_message',
User: 'user',
Web3Wallet: 'web3_wallet',
Token: 'token',
TotalCount: 'total_count',
} as const;

export type ObjectType = (typeof ObjectType)[keyof typeof ObjectType];

export interface ClerkResourceJSON {
object: ObjectType;
id: string;
}

export interface TokenJSON {
object: ObjectType.Token;
object: typeof ObjectType.Token;
jwt: string;
}

export interface AllowlistIdentifierJSON extends ClerkResourceJSON {
object: ObjectType.AllowlistIdentifier;
object: typeof ObjectType.AllowlistIdentifier;
identifier: string;
created_at: number;
updated_at: number;
invitation_id?: string;
}

export interface ClientJSON extends ClerkResourceJSON {
object: ObjectType.Client;
object: typeof ObjectType.Client;
session_ids: string[];
sessions: SessionJSON[];
sign_in_id: string | null;
Expand All@@ -63,7 +65,7 @@ export interface ClientJSON extends ClerkResourceJSON {
}

export interface EmailJSON extends ClerkResourceJSON {
object: ObjectType.Email;
object: typeof ObjectType.Email;
from_email_name: string;
to_email_address?: string;
email_address_id: string | null;
Expand All@@ -77,14 +79,14 @@ export interface EmailJSON extends ClerkResourceJSON {
}

export interface EmailAddressJSON extends ClerkResourceJSON {
object: ObjectType.EmailAddress;
object: typeof ObjectType.EmailAddress;
email_address: string;
verification: VerificationJSON | null;
linked_to: IdentificationLinkJSON[];
}

export interface ExternalAccountJSON extends ClerkResourceJSON {
object: ObjectType.ExternalAccount;
object: typeof ObjectType.ExternalAccount;
provider: string;
identification_id: string;
provider_user_id: string;
Expand All@@ -104,7 +106,7 @@ export interface IdentificationLinkJSON extends ClerkResourceJSON {
}

export interface InvitationJSON extends ClerkResourceJSON {
object: ObjectType.Invitation;
object: typeof ObjectType.Invitation;
email_address: string;
public_metadata: Record<string, unknown> | null;
created_at: number;
Expand All@@ -114,7 +116,7 @@ export interface InvitationJSON extends ClerkResourceJSON {
}

export interface OauthAccessTokenJSON {
object: ObjectType.OauthAccessToken;
object: typeof ObjectType.OauthAccessToken;
provider: string;
token: string;
public_metadata: Record<string, unknown>;
Expand All@@ -126,7 +128,7 @@ export interface OauthAccessTokenJSON {
}

export interface OrganizationJSON extends ClerkResourceJSON {
object: ObjectType.Organization;
object: typeof ObjectType.Organization;
name: string;
slug: string | null;
image_url: string;
Expand All@@ -153,7 +155,7 @@ export interface OrganizationInvitationJSON extends ClerkResourceJSON {
}

export interface OrganizationMembershipJSON extends ClerkResourceJSON {
object: ObjectType.OrganizationMembership;
object: typeof ObjectType.OrganizationMembership;
organization: OrganizationJSON;
public_metadata: OrganizationMembershipPublicMetadata;
private_metadata?: OrganizationMembershipPrivateMetadata;
Expand All@@ -173,7 +175,7 @@ export interface OrganizationMembershipPublicUserDataJSON {
}

export interface PhoneNumberJSON extends ClerkResourceJSON {
object: ObjectType.PhoneNumber;
object: typeof ObjectType.PhoneNumber;
phone_number: string;
reserved_for_second_factor: boolean;
default_second_factor: boolean;
Expand All@@ -182,14 +184,14 @@ export interface PhoneNumberJSON extends ClerkResourceJSON {
}

export interface RedirectUrlJSON extends ClerkResourceJSON {
object: ObjectType.RedirectUrl;
object: typeof ObjectType.RedirectUrl;
url: string;
created_at: number;
updated_at: number;
}

export interface SessionJSON extends ClerkResourceJSON {
object: ObjectType.Session;
object: typeof ObjectType.Session;
client_id: string;
user_id: string;
status: string;
Expand All@@ -201,7 +203,7 @@ export interface SessionJSON extends ClerkResourceJSON {
}

export interface SignInJSON extends ClerkResourceJSON {
object: ObjectType.SignInToken;
object: typeof ObjectType.SignInToken;
status: SignInStatus;
identifier: string;
created_session_id: string | null;
Expand All@@ -217,7 +219,7 @@ export interface SignInTokenJSON extends ClerkResourceJSON {
}

export interface SignUpJSON extends ClerkResourceJSON {
object: ObjectType.SignUpAttempt;
object: typeof ObjectType.SignUpAttempt;
status: SignUpStatus;
attribute_requirements: SignUpAttributeRequirements;
username: string | null;
Expand All@@ -234,7 +236,7 @@ export interface SignUpJSON extends ClerkResourceJSON {
}

export interface SMSMessageJSON extends ClerkResourceJSON {
object: ObjectType.SmsMessage;
object: typeof ObjectType.SmsMessage;
from_phone_number: string;
to_phone_number: string;
phone_number_id: string | null;
Expand All@@ -244,7 +246,7 @@ export interface SMSMessageJSON extends ClerkResourceJSON {
}

export interface UserJSON extends ClerkResourceJSON {
object: ObjectType.User;
object: typeof ObjectType.User;
username: string | null;
first_name: string;
last_name: string;
Expand DownExpand Up@@ -287,7 +289,7 @@ export interface VerificationJSON extends ClerkResourceJSON {
}

export interface Web3WalletJSON extends ClerkResourceJSON {
object: ObjectType.Web3Wallet;
object: typeof ObjectType.Web3Wallet;
web3_wallet: string;
verification: VerificationJSON | null;
}
Expand Down
55 changes: 30 additions & 25 deletions packages/backend/src/errors.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,35 +1,40 @@
export type TokenCarrier = 'header' | 'cookie';

export enum TokenVerificationErrorCode {
InvalidSecretKey = 'clerk_key_invalid',
}
export const TokenVerificationErrorCode = {
InvalidSecretKey: 'clerk_key_invalid',
};

export enum TokenVerificationErrorReason {
TokenExpired = 'token-expired',
TokenInvalid = 'token-invalid',
TokenInvalidAlgorithm = 'token-invalid-algorithm',
TokenInvalidAuthorizedParties = 'token-invalid-authorized-parties',
TokenInvalidSignature = 'token-invalid-signature',
TokenNotActiveYet = 'token-not-active-yet',
TokenVerificationFailed = 'token-verification-failed',
InvalidSecretKey = 'secret-key-invalid',
export type TokenVerificationErrorCode = (typeof TokenVerificationErrorCode)[keyof typeof TokenVerificationErrorCode];

LocalJWKMissing = 'jwk-local-missing',
export const TokenVerificationErrorReason = {
TokenExpired: 'token-expired',
TokenInvalid: 'token-invalid',
TokenInvalidAlgorithm: 'token-invalid-algorithm',
TokenInvalidAuthorizedParties: 'token-invalid-authorized-parties',
TokenInvalidSignature: 'token-invalid-signature',
TokenNotActiveYet: 'token-not-active-yet',
TokenVerificationFailed: 'token-verification-failed',
InvalidSecretKey: 'secret-key-invalid',
LocalJWKMissing: 'jwk-local-missing',
RemoteJWKFailedToLoad: 'jwk-remote-failed-to-load',
RemoteJWKInvalid: 'jwk-remote-invalid',
RemoteJWKMissing: 'jwk-remote-missing',
JWKFailedToResolve: 'jwk-failed-to-resolve',
};

RemoteJWKFailedToLoad = 'jwk-remote-failed-to-load',
RemoteJWKInvalid = 'jwk-remote-invalid',
RemoteJWKMissing = 'jwk-remote-missing',
export type TokenVerificationErrorReason =
(typeof TokenVerificationErrorReason)[keyof typeof TokenVerificationErrorReason];

JWKFailedToResolve = 'jwk-failed-to-resolve',
}
export const TokenVerificationErrorAction = {
ContactSupport: 'Contact support@clerk.com',
EnsureClerkJWT: 'Make sure that this is a valid Clerk generate JWT.',
SetClerkJWTKey: 'Set the CLERK_JWT_KEY environment variable.',
SetClerkSecretKey: 'Set the CLERK_SECRET_KEY environment variable.',
EnsureClockSync: 'Make sure your system clock is in sync (e.g. turn off and on automatic time synchronization).',
};

export enum TokenVerificationErrorAction {
ContactSupport = 'Contact support@clerk.com',
EnsureClerkJWT = 'Make sure that this is a valid Clerk generate JWT.',
SetClerkJWTKey = 'Set the CLERK_JWT_KEY environment variable.',
SetClerkSecretKey = 'Set the CLERK_SECRET_KEY environment variable.',
EnsureClockSync = 'Make sure your system clock is in sync (e.g. turn off and on automatic time synchronization).',
}
export type TokenVerificationErrorAction =
(typeof TokenVerificationErrorAction)[keyof typeof TokenVerificationErrorAction];

export class TokenVerificationError extends Error {
action?: TokenVerificationErrorAction;
Expand Down
42 changes: 23 additions & 19 deletions packages/backend/src/tokens/authStatus.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -5,14 +5,16 @@ import type { AuthenticateContext } from './authenticateContext';
import type { SignedInAuthObject, SignedOutAuthObject } from './authObjects';
import { signedInAuthObject, signedOutAuthObject } from './authObjects';

export enum AuthStatus {
SignedIn = 'signed-in',
SignedOut = 'signed-out',
Handshake = 'handshake',
}
export const AuthStatus = {
SignedIn: 'signed-in',
SignedOut: 'signed-out',
Handshake: 'handshake',
} as const;

export type AuthStatus = (typeof AuthStatus)[keyof typeof AuthStatus];

export type SignedInState = {
status: AuthStatus.SignedIn;
status: typeof AuthStatus.SignedIn;
reason: null;
message: null;
proxyUrl?: string;
Expand All@@ -29,7 +31,7 @@ export type SignedInState = {
};

export type SignedOutState = {
status: AuthStatus.SignedOut;
status: typeof AuthStatus.SignedOut;
message: string;
reason: AuthReason;
proxyUrl?: string;
Expand All@@ -46,22 +48,24 @@ export type SignedOutState = {
};

export type HandshakeState = Omit<SignedOutState, 'status' | 'toAuth'> & {
status: AuthStatus.Handshake;
status: typeof AuthStatus.Handshake;
headers: Headers;
toAuth: () => null;
};

export enum AuthErrorReason {
ClientUATWithoutSessionToken = 'client-uat-but-no-session-token',
DevBrowserSync = 'dev-browser-sync',
PrimaryRespondsToSyncing = 'primary-responds-to-syncing',
SatelliteCookieNeedsSyncing = 'satellite-needs-syncing',
SessionTokenAndUATMissing = 'session-token-and-uat-missing',
SessionTokenMissing = 'session-token-missing',
SessionTokenOutdated = 'session-token-outdated',
SessionTokenWithoutClientUAT = 'session-token-but-no-client-uat',
UnexpectedError = 'unexpected-error',
}
export const AuthErrorReason = {
ClientUATWithoutSessionToken: 'client-uat-but-no-session-token',
DevBrowserSync: 'dev-browser-sync',
PrimaryRespondsToSyncing: 'primary-responds-to-syncing',
SatelliteCookieNeedsSyncing: 'satellite-needs-syncing',
SessionTokenAndUATMissing: 'session-token-and-uat-missing',
SessionTokenMissing: 'session-token-missing',
SessionTokenOutdated: 'session-token-outdated',
SessionTokenWithoutClientUAT: 'session-token-but-no-client-uat',
UnexpectedError: 'unexpected-error',
} as const;

export type AuthErrorReason = (typeof AuthErrorReason)[keyof typeof AuthErrorReason];

export type AuthReason = AuthErrorReason | TokenVerificationErrorReason;

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
feat(backend): Replace enums with as const objects#2516

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

nikosdouvlis
merged 2 commits into

from

Jan 9, 2024
 Merged


feat(backend): Replace enums with as const objects
#2516
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
6bb96e8

feat(backend): Replace enums with `as const` objects


nikosdouvlis Jan 9, 2024
7837827

Create many-moons-matter.md


nikosdouvlis Jan 9, 2024

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


5 changes: 5 additions & 0 deletions
.changeset/many-moons-matter.md

View file


Open in desktop

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

Replace enums with `as const` objects so `@clerk/backend` is consistent with the other packages

88 changes: 45 additions & 43 deletions
packages/backend/src/api/resources/JSON.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -7,52 +7,54 @@ import type {
 SignUpStatus,
} from './Enums';

export enum ObjectType {
 AllowlistIdentifier = 'allowlist_identifier',
 Client = 'client',
 Email = 'email',
 EmailAddress = 'email_address',
 ExternalAccount = 'external_account',
 FacebookAccount = 'facebook_account',
 GoogleAccount = 'google_account',
 Invitation = 'invitation',
 OauthAccessToken = 'oauth_access_token',
 Organization = 'organization',
 OrganizationInvitation = 'organization_invitation',
 OrganizationMembership = 'organization_membership',
 PhoneNumber = 'phone_number',
 RedirectUrl = 'redirect_url',
 Session = 'session',
 SignInAttempt = 'sign_in_attempt',
 SignInToken = 'sign_in_token',
 SignUpAttempt = 'sign_up_attempt',
 SmsMessage = 'sms_message',
 User = 'user',
 Web3Wallet = 'web3_wallet',
 Token = 'token',
 TotalCount = 'total_count',
}
export const ObjectType = {
 AllowlistIdentifier: 'allowlist_identifier',
 Client: 'client',
 Email: 'email',
 EmailAddress: 'email_address',
 ExternalAccount: 'external_account',
 FacebookAccount: 'facebook_account',
 GoogleAccount: 'google_account',
 Invitation: 'invitation',
 OauthAccessToken: 'oauth_access_token',
 Organization: 'organization',
 OrganizationInvitation: 'organization_invitation',
 OrganizationMembership: 'organization_membership',
 PhoneNumber: 'phone_number',
 RedirectUrl: 'redirect_url',
 Session: 'session',
 SignInAttempt: 'sign_in_attempt',
 SignInToken: 'sign_in_token',
 SignUpAttempt: 'sign_up_attempt',
 SmsMessage: 'sms_message',
 User: 'user',
 Web3Wallet: 'web3_wallet',
 Token: 'token',
 TotalCount: 'total_count',
} as const;

export type ObjectType = (typeof ObjectType)[keyof typeof ObjectType];

export interface ClerkResourceJSON {
 object: ObjectType;
 id: string;
}

export interface TokenJSON {
 object: ObjectType.Token;
 object: typeof ObjectType.Token;
 jwt: string;
}

export interface AllowlistIdentifierJSON extends ClerkResourceJSON {
 object: ObjectType.AllowlistIdentifier;
 object: typeof ObjectType.AllowlistIdentifier;
 identifier: string;
 created_at: number;
 updated_at: number;
 invitation_id?: string;
}

export interface ClientJSON extends ClerkResourceJSON {
 object: ObjectType.Client;
 object: typeof ObjectType.Client;
 session_ids: string[];
 sessions: SessionJSON[];
 sign_in_id: string | null;
Expand All@@ -63,7 +65,7 @@ export interface ClientJSON extends ClerkResourceJSON {
}

export interface EmailJSON extends ClerkResourceJSON {
 object: ObjectType.Email;
 object: typeof ObjectType.Email;
 from_email_name: string;
 to_email_address?: string;
 email_address_id: string | null;
Expand All@@ -77,14 +79,14 @@ export interface EmailJSON extends ClerkResourceJSON {
}

export interface EmailAddressJSON extends ClerkResourceJSON {
 object: ObjectType.EmailAddress;
 object: typeof ObjectType.EmailAddress;
 email_address: string;
 verification: VerificationJSON | null;
 linked_to: IdentificationLinkJSON[];
}

export interface ExternalAccountJSON extends ClerkResourceJSON {
 object: ObjectType.ExternalAccount;
 object: typeof ObjectType.ExternalAccount;
 provider: string;
 identification_id: string;
 provider_user_id: string;
Expand All@@ -104,7 +106,7 @@ export interface IdentificationLinkJSON extends ClerkResourceJSON {
}

export interface InvitationJSON extends ClerkResourceJSON {
 object: ObjectType.Invitation;
 object: typeof ObjectType.Invitation;
 email_address: string;
 public_metadata: Record<string, unknown> | null;
 created_at: number;
Expand All@@ -114,7 +116,7 @@ export interface InvitationJSON extends ClerkResourceJSON {
}

export interface OauthAccessTokenJSON {
 object: ObjectType.OauthAccessToken;
 object: typeof ObjectType.OauthAccessToken;
 provider: string;
 token: string;
 public_metadata: Record<string, unknown>;
Expand All@@ -126,7 +128,7 @@ export interface OauthAccessTokenJSON {
}

export interface OrganizationJSON extends ClerkResourceJSON {
 object: ObjectType.Organization;
 object: typeof ObjectType.Organization;
 name: string;
 slug: string | null;
 image_url: string;
Expand All@@ -153,7 +155,7 @@ export interface OrganizationInvitationJSON extends ClerkResourceJSON {
}

export interface OrganizationMembershipJSON extends ClerkResourceJSON {
 object: ObjectType.OrganizationMembership;
 object: typeof ObjectType.OrganizationMembership;
 organization: OrganizationJSON;
 public_metadata: OrganizationMembershipPublicMetadata;
 private_metadata?: OrganizationMembershipPrivateMetadata;
Expand All@@ -173,7 +175,7 @@ export interface OrganizationMembershipPublicUserDataJSON {
}

export interface PhoneNumberJSON extends ClerkResourceJSON {
 object: ObjectType.PhoneNumber;
 object: typeof ObjectType.PhoneNumber;
 phone_number: string;
 reserved_for_second_factor: boolean;
 default_second_factor: boolean;
Expand All@@ -182,14 +184,14 @@ export interface PhoneNumberJSON extends ClerkResourceJSON {
}

export interface RedirectUrlJSON extends ClerkResourceJSON {
 object: ObjectType.RedirectUrl;
 object: typeof ObjectType.RedirectUrl;
 url: string;
 created_at: number;
 updated_at: number;
}

export interface SessionJSON extends ClerkResourceJSON {
 object: ObjectType.Session;
 object: typeof ObjectType.Session;
 client_id: string;
 user_id: string;
 status: string;
Expand All@@ -201,7 +203,7 @@ export interface SessionJSON extends ClerkResourceJSON {
}

export interface SignInJSON extends ClerkResourceJSON {
 object: ObjectType.SignInToken;
 object: typeof ObjectType.SignInToken;
 status: SignInStatus;
 identifier: string;
 created_session_id: string | null;
Expand All@@ -217,7 +219,7 @@ export interface SignInTokenJSON extends ClerkResourceJSON {
}

export interface SignUpJSON extends ClerkResourceJSON {
 object: ObjectType.SignUpAttempt;
 object: typeof ObjectType.SignUpAttempt;
 status: SignUpStatus;
 attribute_requirements: SignUpAttributeRequirements;
 username: string | null;
Expand All@@ -234,7 +236,7 @@ export interface SignUpJSON extends ClerkResourceJSON {
}

export interface SMSMessageJSON extends ClerkResourceJSON {
 object: ObjectType.SmsMessage;
 object: typeof ObjectType.SmsMessage;
 from_phone_number: string;
 to_phone_number: string;
 phone_number_id: string | null;
Expand All@@ -244,7 +246,7 @@ export interface SMSMessageJSON extends ClerkResourceJSON {
}

export interface UserJSON extends ClerkResourceJSON {
 object: ObjectType.User;
 object: typeof ObjectType.User;
 username: string | null;
 first_name: string;
 last_name: string;
Expand DownExpand Up@@ -287,7 +289,7 @@ export interface VerificationJSON extends ClerkResourceJSON {
}

export interface Web3WalletJSON extends ClerkResourceJSON {
 object: ObjectType.Web3Wallet;
 object: typeof ObjectType.Web3Wallet;
 web3_wallet: string;
 verification: VerificationJSON | null;
}
Expand Down

55 changes: 30 additions & 25 deletions
packages/backend/src/errors.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,35 +1,40 @@
export type TokenCarrier = 'header' | 'cookie';

export enum TokenVerificationErrorCode {
 InvalidSecretKey = 'clerk_key_invalid',
}
export const TokenVerificationErrorCode = {
 InvalidSecretKey: 'clerk_key_invalid',
};

export enum TokenVerificationErrorReason {
 TokenExpired = 'token-expired',
 TokenInvalid = 'token-invalid',
 TokenInvalidAlgorithm = 'token-invalid-algorithm',
 TokenInvalidAuthorizedParties = 'token-invalid-authorized-parties',
 TokenInvalidSignature = 'token-invalid-signature',
 TokenNotActiveYet = 'token-not-active-yet',
 TokenVerificationFailed = 'token-verification-failed',
 InvalidSecretKey = 'secret-key-invalid',
export type TokenVerificationErrorCode = (typeof TokenVerificationErrorCode)[keyof typeof TokenVerificationErrorCode];

 LocalJWKMissing = 'jwk-local-missing',
export const TokenVerificationErrorReason = {
 TokenExpired: 'token-expired',
 TokenInvalid: 'token-invalid',
 TokenInvalidAlgorithm: 'token-invalid-algorithm',
 TokenInvalidAuthorizedParties: 'token-invalid-authorized-parties',
 TokenInvalidSignature: 'token-invalid-signature',
 TokenNotActiveYet: 'token-not-active-yet',
 TokenVerificationFailed: 'token-verification-failed',
 InvalidSecretKey: 'secret-key-invalid',
 LocalJWKMissing: 'jwk-local-missing',
 RemoteJWKFailedToLoad: 'jwk-remote-failed-to-load',
 RemoteJWKInvalid: 'jwk-remote-invalid',
 RemoteJWKMissing: 'jwk-remote-missing',
 JWKFailedToResolve: 'jwk-failed-to-resolve',
};

 RemoteJWKFailedToLoad = 'jwk-remote-failed-to-load',
 RemoteJWKInvalid = 'jwk-remote-invalid',
 RemoteJWKMissing = 'jwk-remote-missing',
export type TokenVerificationErrorReason =
 (typeof TokenVerificationErrorReason)[keyof typeof TokenVerificationErrorReason];

 JWKFailedToResolve = 'jwk-failed-to-resolve',
}
export const TokenVerificationErrorAction = {
 ContactSupport: 'Contact support@clerk.com',
 EnsureClerkJWT: 'Make sure that this is a valid Clerk generate JWT.',
 SetClerkJWTKey: 'Set the CLERK_JWT_KEY environment variable.',
 SetClerkSecretKey: 'Set the CLERK_SECRET_KEY environment variable.',
 EnsureClockSync: 'Make sure your system clock is in sync (e.g. turn off and on automatic time synchronization).',
};

export enum TokenVerificationErrorAction {
 ContactSupport = 'Contact support@clerk.com',
 EnsureClerkJWT = 'Make sure that this is a valid Clerk generate JWT.',
 SetClerkJWTKey = 'Set the CLERK_JWT_KEY environment variable.',
 SetClerkSecretKey = 'Set the CLERK_SECRET_KEY environment variable.',
 EnsureClockSync = 'Make sure your system clock is in sync (e.g. turn off and on automatic time synchronization).',
}
export type TokenVerificationErrorAction =
 (typeof TokenVerificationErrorAction)[keyof typeof TokenVerificationErrorAction];

export class TokenVerificationError extends Error {
 action?: TokenVerificationErrorAction;
Expand Down

42 changes: 23 additions & 19 deletions
packages/backend/src/tokens/authStatus.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,14 +5,16 @@ import type { AuthenticateContext } from './authenticateContext';
import type { SignedInAuthObject, SignedOutAuthObject } from './authObjects';
import { signedInAuthObject, signedOutAuthObject } from './authObjects';

export enum AuthStatus {
 SignedIn = 'signed-in',
 SignedOut = 'signed-out',
 Handshake = 'handshake',
}
export const AuthStatus = {
 SignedIn: 'signed-in',
 SignedOut: 'signed-out',
 Handshake: 'handshake',
} as const;

export type AuthStatus = (typeof AuthStatus)[keyof typeof AuthStatus];

export type SignedInState = {
 status: AuthStatus.SignedIn;
 status: typeof AuthStatus.SignedIn;
 reason: null;
 message: null;
 proxyUrl?: string;
Expand All@@ -29,7 +31,7 @@ export type SignedInState = {
};

export type SignedOutState = {
 status: AuthStatus.SignedOut;
 status: typeof AuthStatus.SignedOut;
 message: string;
 reason: AuthReason;
 proxyUrl?: string;
Expand All@@ -46,22 +48,24 @@ export type SignedOutState = {
};

export type HandshakeState = Omit<SignedOutState, 'status' | 'toAuth'> & {
 status: AuthStatus.Handshake;
 status: typeof AuthStatus.Handshake;
 headers: Headers;
 toAuth: () => null;
};

export enum AuthErrorReason {
 ClientUATWithoutSessionToken = 'client-uat-but-no-session-token',
 DevBrowserSync = 'dev-browser-sync',
 PrimaryRespondsToSyncing = 'primary-responds-to-syncing',
 SatelliteCookieNeedsSyncing = 'satellite-needs-syncing',
 SessionTokenAndUATMissing = 'session-token-and-uat-missing',
 SessionTokenMissing = 'session-token-missing',
 SessionTokenOutdated = 'session-token-outdated',
 SessionTokenWithoutClientUAT = 'session-token-but-no-client-uat',
 UnexpectedError = 'unexpected-error',
}
export const AuthErrorReason = {
 ClientUATWithoutSessionToken: 'client-uat-but-no-session-token',
 DevBrowserSync: 'dev-browser-sync',
 PrimaryRespondsToSyncing: 'primary-responds-to-syncing',
 SatelliteCookieNeedsSyncing: 'satellite-needs-syncing',
 SessionTokenAndUATMissing: 'session-token-and-uat-missing',
 SessionTokenMissing: 'session-token-missing',
 SessionTokenOutdated: 'session-token-outdated',
 SessionTokenWithoutClientUAT: 'session-token-but-no-client-uat',
 UnexpectedError: 'unexpected-error',
} as const;

export type AuthErrorReason = (typeof AuthErrorReason)[keyof typeof AuthErrorReason];

export type AuthReason = AuthErrorReason | TokenVerificationErrorReason;

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
feat(backend): Replace enums with as const objects#2516

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

nikosdouvlis
merged 2 commits into

from

Jan 9, 2024
 Merged


feat(backend): Replace enums with as const objects
#2516
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
6bb96e8

feat(backend): Replace enums with `as const` objects


nikosdouvlis Jan 9, 2024
7837827

Create many-moons-matter.md


nikosdouvlis Jan 9, 2024

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


5 changes: 5 additions & 0 deletions
.changeset/many-moons-matter.md

View file


Open in desktop

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

Replace enums with `as const` objects so `@clerk/backend` is consistent with the other packages

88 changes: 45 additions & 43 deletions
packages/backend/src/api/resources/JSON.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -7,52 +7,54 @@ import type {
 SignUpStatus,
} from './Enums';

export enum ObjectType {
 AllowlistIdentifier = 'allowlist_identifier',
 Client = 'client',
 Email = 'email',
 EmailAddress = 'email_address',
 ExternalAccount = 'external_account',
 FacebookAccount = 'facebook_account',
 GoogleAccount = 'google_account',
 Invitation = 'invitation',
 OauthAccessToken = 'oauth_access_token',
 Organization = 'organization',
 OrganizationInvitation = 'organization_invitation',
 OrganizationMembership = 'organization_membership',
 PhoneNumber = 'phone_number',
 RedirectUrl = 'redirect_url',
 Session = 'session',
 SignInAttempt = 'sign_in_attempt',
 SignInToken = 'sign_in_token',
 SignUpAttempt = 'sign_up_attempt',
 SmsMessage = 'sms_message',
 User = 'user',
 Web3Wallet = 'web3_wallet',
 Token = 'token',
 TotalCount = 'total_count',
}
export const ObjectType = {
 AllowlistIdentifier: 'allowlist_identifier',
 Client: 'client',
 Email: 'email',
 EmailAddress: 'email_address',
 ExternalAccount: 'external_account',
 FacebookAccount: 'facebook_account',
 GoogleAccount: 'google_account',
 Invitation: 'invitation',
 OauthAccessToken: 'oauth_access_token',
 Organization: 'organization',
 OrganizationInvitation: 'organization_invitation',
 OrganizationMembership: 'organization_membership',
 PhoneNumber: 'phone_number',
 RedirectUrl: 'redirect_url',
 Session: 'session',
 SignInAttempt: 'sign_in_attempt',
 SignInToken: 'sign_in_token',
 SignUpAttempt: 'sign_up_attempt',
 SmsMessage: 'sms_message',
 User: 'user',
 Web3Wallet: 'web3_wallet',
 Token: 'token',
 TotalCount: 'total_count',
} as const;

export type ObjectType = (typeof ObjectType)[keyof typeof ObjectType];

export interface ClerkResourceJSON {
 object: ObjectType;
 id: string;
}

export interface TokenJSON {
 object: ObjectType.Token;
 object: typeof ObjectType.Token;
 jwt: string;
}

export interface AllowlistIdentifierJSON extends ClerkResourceJSON {
 object: ObjectType.AllowlistIdentifier;
 object: typeof ObjectType.AllowlistIdentifier;
 identifier: string;
 created_at: number;
 updated_at: number;
 invitation_id?: string;
}

export interface ClientJSON extends ClerkResourceJSON {
 object: ObjectType.Client;
 object: typeof ObjectType.Client;
 session_ids: string[];
 sessions: SessionJSON[];
 sign_in_id: string | null;
Expand All@@ -63,7 +65,7 @@ export interface ClientJSON extends ClerkResourceJSON {
}

export interface EmailJSON extends ClerkResourceJSON {
 object: ObjectType.Email;
 object: typeof ObjectType.Email;
 from_email_name: string;
 to_email_address?: string;
 email_address_id: string | null;
Expand All@@ -77,14 +79,14 @@ export interface EmailJSON extends ClerkResourceJSON {
}

export interface EmailAddressJSON extends ClerkResourceJSON {
 object: ObjectType.EmailAddress;
 object: typeof ObjectType.EmailAddress;
 email_address: string;
 verification: VerificationJSON | null;
 linked_to: IdentificationLinkJSON[];
}

export interface ExternalAccountJSON extends ClerkResourceJSON {
 object: ObjectType.ExternalAccount;
 object: typeof ObjectType.ExternalAccount;
 provider: string;
 identification_id: string;
 provider_user_id: string;
Expand All@@ -104,7 +106,7 @@ export interface IdentificationLinkJSON extends ClerkResourceJSON {
}

export interface InvitationJSON extends ClerkResourceJSON {
 object: ObjectType.Invitation;
 object: typeof ObjectType.Invitation;
 email_address: string;
 public_metadata: Record<string, unknown> | null;
 created_at: number;
Expand All@@ -114,7 +116,7 @@ export interface InvitationJSON extends ClerkResourceJSON {
}

export interface OauthAccessTokenJSON {
 object: ObjectType.OauthAccessToken;
 object: typeof ObjectType.OauthAccessToken;
 provider: string;
 token: string;
 public_metadata: Record<string, unknown>;
Expand All@@ -126,7 +128,7 @@ export interface OauthAccessTokenJSON {
}

export interface OrganizationJSON extends ClerkResourceJSON {
 object: ObjectType.Organization;
 object: typeof ObjectType.Organization;
 name: string;
 slug: string | null;
 image_url: string;
Expand All@@ -153,7 +155,7 @@ export interface OrganizationInvitationJSON extends ClerkResourceJSON {
}

export interface OrganizationMembershipJSON extends ClerkResourceJSON {
 object: ObjectType.OrganizationMembership;
 object: typeof ObjectType.OrganizationMembership;
 organization: OrganizationJSON;
 public_metadata: OrganizationMembershipPublicMetadata;
 private_metadata?: OrganizationMembershipPrivateMetadata;
Expand All@@ -173,7 +175,7 @@ export interface OrganizationMembershipPublicUserDataJSON {
}

export interface PhoneNumberJSON extends ClerkResourceJSON {
 object: ObjectType.PhoneNumber;
 object: typeof ObjectType.PhoneNumber;
 phone_number: string;
 reserved_for_second_factor: boolean;
 default_second_factor: boolean;
Expand All@@ -182,14 +184,14 @@ export interface PhoneNumberJSON extends ClerkResourceJSON {
}

export interface RedirectUrlJSON extends ClerkResourceJSON {
 object: ObjectType.RedirectUrl;
 object: typeof ObjectType.RedirectUrl;
 url: string;
 created_at: number;
 updated_at: number;
}

export interface SessionJSON extends ClerkResourceJSON {
 object: ObjectType.Session;
 object: typeof ObjectType.Session;
 client_id: string;
 user_id: string;
 status: string;
Expand All@@ -201,7 +203,7 @@ export interface SessionJSON extends ClerkResourceJSON {
}

export interface SignInJSON extends ClerkResourceJSON {
 object: ObjectType.SignInToken;
 object: typeof ObjectType.SignInToken;
 status: SignInStatus;
 identifier: string;
 created_session_id: string | null;
Expand All@@ -217,7 +219,7 @@ export interface SignInTokenJSON extends ClerkResourceJSON {
}

export interface SignUpJSON extends ClerkResourceJSON {
 object: ObjectType.SignUpAttempt;
 object: typeof ObjectType.SignUpAttempt;
 status: SignUpStatus;
 attribute_requirements: SignUpAttributeRequirements;
 username: string | null;
Expand All@@ -234,7 +236,7 @@ export interface SignUpJSON extends ClerkResourceJSON {
}

export interface SMSMessageJSON extends ClerkResourceJSON {
 object: ObjectType.SmsMessage;
 object: typeof ObjectType.SmsMessage;
 from_phone_number: string;
 to_phone_number: string;
 phone_number_id: string | null;
Expand All@@ -244,7 +246,7 @@ export interface SMSMessageJSON extends ClerkResourceJSON {
}

export interface UserJSON extends ClerkResourceJSON {
 object: ObjectType.User;
 object: typeof ObjectType.User;
 username: string | null;
 first_name: string;
 last_name: string;
Expand DownExpand Up@@ -287,7 +289,7 @@ export interface VerificationJSON extends ClerkResourceJSON {
}

export interface Web3WalletJSON extends ClerkResourceJSON {
 object: ObjectType.Web3Wallet;
 object: typeof ObjectType.Web3Wallet;
 web3_wallet: string;
 verification: VerificationJSON | null;
}
Expand Down

55 changes: 30 additions & 25 deletions
packages/backend/src/errors.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,35 +1,40 @@
export type TokenCarrier = 'header' | 'cookie';

export enum TokenVerificationErrorCode {
 InvalidSecretKey = 'clerk_key_invalid',
}
export const TokenVerificationErrorCode = {
 InvalidSecretKey: 'clerk_key_invalid',
};

export enum TokenVerificationErrorReason {
 TokenExpired = 'token-expired',
 TokenInvalid = 'token-invalid',
 TokenInvalidAlgorithm = 'token-invalid-algorithm',
 TokenInvalidAuthorizedParties = 'token-invalid-authorized-parties',
 TokenInvalidSignature = 'token-invalid-signature',
 TokenNotActiveYet = 'token-not-active-yet',
 TokenVerificationFailed = 'token-verification-failed',
 InvalidSecretKey = 'secret-key-invalid',
export type TokenVerificationErrorCode = (typeof TokenVerificationErrorCode)[keyof typeof TokenVerificationErrorCode];

 LocalJWKMissing = 'jwk-local-missing',
export const TokenVerificationErrorReason = {
 TokenExpired: 'token-expired',
 TokenInvalid: 'token-invalid',
 TokenInvalidAlgorithm: 'token-invalid-algorithm',
 TokenInvalidAuthorizedParties: 'token-invalid-authorized-parties',
 TokenInvalidSignature: 'token-invalid-signature',
 TokenNotActiveYet: 'token-not-active-yet',
 TokenVerificationFailed: 'token-verification-failed',
 InvalidSecretKey: 'secret-key-invalid',
 LocalJWKMissing: 'jwk-local-missing',
 RemoteJWKFailedToLoad: 'jwk-remote-failed-to-load',
 RemoteJWKInvalid: 'jwk-remote-invalid',
 RemoteJWKMissing: 'jwk-remote-missing',
 JWKFailedToResolve: 'jwk-failed-to-resolve',
};

 RemoteJWKFailedToLoad = 'jwk-remote-failed-to-load',
 RemoteJWKInvalid = 'jwk-remote-invalid',
 RemoteJWKMissing = 'jwk-remote-missing',
export type TokenVerificationErrorReason =
 (typeof TokenVerificationErrorReason)[keyof typeof TokenVerificationErrorReason];

 JWKFailedToResolve = 'jwk-failed-to-resolve',
}
export const TokenVerificationErrorAction = {
 ContactSupport: 'Contact support@clerk.com',
 EnsureClerkJWT: 'Make sure that this is a valid Clerk generate JWT.',
 SetClerkJWTKey: 'Set the CLERK_JWT_KEY environment variable.',
 SetClerkSecretKey: 'Set the CLERK_SECRET_KEY environment variable.',
 EnsureClockSync: 'Make sure your system clock is in sync (e.g. turn off and on automatic time synchronization).',
};

export enum TokenVerificationErrorAction {
 ContactSupport = 'Contact support@clerk.com',
 EnsureClerkJWT = 'Make sure that this is a valid Clerk generate JWT.',
 SetClerkJWTKey = 'Set the CLERK_JWT_KEY environment variable.',
 SetClerkSecretKey = 'Set the CLERK_SECRET_KEY environment variable.',
 EnsureClockSync = 'Make sure your system clock is in sync (e.g. turn off and on automatic time synchronization).',
}
export type TokenVerificationErrorAction =
 (typeof TokenVerificationErrorAction)[keyof typeof TokenVerificationErrorAction];

export class TokenVerificationError extends Error {
 action?: TokenVerificationErrorAction;
Expand Down

42 changes: 23 additions & 19 deletions
packages/backend/src/tokens/authStatus.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,14 +5,16 @@ import type { AuthenticateContext } from './authenticateContext';
import type { SignedInAuthObject, SignedOutAuthObject } from './authObjects';
import { signedInAuthObject, signedOutAuthObject } from './authObjects';

export enum AuthStatus {
 SignedIn = 'signed-in',
 SignedOut = 'signed-out',
 Handshake = 'handshake',
}
export const AuthStatus = {
 SignedIn: 'signed-in',
 SignedOut: 'signed-out',
 Handshake: 'handshake',
} as const;

export type AuthStatus = (typeof AuthStatus)[keyof typeof AuthStatus];

export type SignedInState = {
 status: AuthStatus.SignedIn;
 status: typeof AuthStatus.SignedIn;
 reason: null;
 message: null;
 proxyUrl?: string;
Expand All@@ -29,7 +31,7 @@ export type SignedInState = {
};

export type SignedOutState = {
 status: AuthStatus.SignedOut;
 status: typeof AuthStatus.SignedOut;
 message: string;
 reason: AuthReason;
 proxyUrl?: string;
Expand All@@ -46,22 +48,24 @@ export type SignedOutState = {
};

export type HandshakeState = Omit<SignedOutState, 'status' | 'toAuth'> & {
 status: AuthStatus.Handshake;
 status: typeof AuthStatus.Handshake;
 headers: Headers;
 toAuth: () => null;
};

export enum AuthErrorReason {
 ClientUATWithoutSessionToken = 'client-uat-but-no-session-token',
 DevBrowserSync = 'dev-browser-sync',
 PrimaryRespondsToSyncing = 'primary-responds-to-syncing',
 SatelliteCookieNeedsSyncing = 'satellite-needs-syncing',
 SessionTokenAndUATMissing = 'session-token-and-uat-missing',
 SessionTokenMissing = 'session-token-missing',
 SessionTokenOutdated = 'session-token-outdated',
 SessionTokenWithoutClientUAT = 'session-token-but-no-client-uat',
 UnexpectedError = 'unexpected-error',
}
export const AuthErrorReason = {
 ClientUATWithoutSessionToken: 'client-uat-but-no-session-token',
 DevBrowserSync: 'dev-browser-sync',
 PrimaryRespondsToSyncing: 'primary-responds-to-syncing',
 SatelliteCookieNeedsSyncing: 'satellite-needs-syncing',
 SessionTokenAndUATMissing: 'session-token-and-uat-missing',
 SessionTokenMissing: 'session-token-missing',
 SessionTokenOutdated: 'session-token-outdated',
 SessionTokenWithoutClientUAT: 'session-token-but-no-client-uat',
 UnexpectedError: 'unexpected-error',
} as const;

export type AuthErrorReason = (typeof AuthErrorReason)[keyof typeof AuthErrorReason];

export type AuthReason = AuthErrorReason | TokenVerificationErrorReason;

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
feat(backend): Replace enums with as const objects#2516

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

nikosdouvlis
merged 2 commits into

from

Jan 9, 2024
 Merged


feat(backend): Replace enums with as const objects
#2516
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
6bb96e8

feat(backend): Replace enums with `as const` objects


nikosdouvlis Jan 9, 2024
7837827

Create many-moons-matter.md


nikosdouvlis Jan 9, 2024

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


5 changes: 5 additions & 0 deletions
.changeset/many-moons-matter.md

View file


Open in desktop

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

Replace enums with `as const` objects so `@clerk/backend` is consistent with the other packages

88 changes: 45 additions & 43 deletions
packages/backend/src/api/resources/JSON.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -7,52 +7,54 @@ import type {
 SignUpStatus,
} from './Enums';

export enum ObjectType {
 AllowlistIdentifier = 'allowlist_identifier',
 Client = 'client',
 Email = 'email',
 EmailAddress = 'email_address',
 ExternalAccount = 'external_account',
 FacebookAccount = 'facebook_account',
 GoogleAccount = 'google_account',
 Invitation = 'invitation',
 OauthAccessToken = 'oauth_access_token',
 Organization = 'organization',
 OrganizationInvitation = 'organization_invitation',
 OrganizationMembership = 'organization_membership',
 PhoneNumber = 'phone_number',
 RedirectUrl = 'redirect_url',
 Session = 'session',
 SignInAttempt = 'sign_in_attempt',
 SignInToken = 'sign_in_token',
 SignUpAttempt = 'sign_up_attempt',
 SmsMessage = 'sms_message',
 User = 'user',
 Web3Wallet = 'web3_wallet',
 Token = 'token',
 TotalCount = 'total_count',
}
export const ObjectType = {
 AllowlistIdentifier: 'allowlist_identifier',
 Client: 'client',
 Email: 'email',
 EmailAddress: 'email_address',
 ExternalAccount: 'external_account',
 FacebookAccount: 'facebook_account',
 GoogleAccount: 'google_account',
 Invitation: 'invitation',
 OauthAccessToken: 'oauth_access_token',
 Organization: 'organization',
 OrganizationInvitation: 'organization_invitation',
 OrganizationMembership: 'organization_membership',
 PhoneNumber: 'phone_number',
 RedirectUrl: 'redirect_url',
 Session: 'session',
 SignInAttempt: 'sign_in_attempt',
 SignInToken: 'sign_in_token',
 SignUpAttempt: 'sign_up_attempt',
 SmsMessage: 'sms_message',
 User: 'user',
 Web3Wallet: 'web3_wallet',
 Token: 'token',
 TotalCount: 'total_count',
} as const;

export type ObjectType = (typeof ObjectType)[keyof typeof ObjectType];

export interface ClerkResourceJSON {
 object: ObjectType;
 id: string;
}

export interface TokenJSON {
 object: ObjectType.Token;
 object: typeof ObjectType.Token;
 jwt: string;
}

export interface AllowlistIdentifierJSON extends ClerkResourceJSON {
 object: ObjectType.AllowlistIdentifier;
 object: typeof ObjectType.AllowlistIdentifier;
 identifier: string;
 created_at: number;
 updated_at: number;
 invitation_id?: string;
}

export interface ClientJSON extends ClerkResourceJSON {
 object: ObjectType.Client;
 object: typeof ObjectType.Client;
 session_ids: string[];
 sessions: SessionJSON[];
 sign_in_id: string | null;
Expand All@@ -63,7 +65,7 @@ export interface ClientJSON extends ClerkResourceJSON {
}

export interface EmailJSON extends ClerkResourceJSON {
 object: ObjectType.Email;
 object: typeof ObjectType.Email;
 from_email_name: string;
 to_email_address?: string;
 email_address_id: string | null;
Expand All@@ -77,14 +79,14 @@ export interface EmailJSON extends ClerkResourceJSON {
}

export interface EmailAddressJSON extends ClerkResourceJSON {
 object: ObjectType.EmailAddress;
 object: typeof ObjectType.EmailAddress;
 email_address: string;
 verification: VerificationJSON | null;
 linked_to: IdentificationLinkJSON[];
}

export interface ExternalAccountJSON extends ClerkResourceJSON {
 object: ObjectType.ExternalAccount;
 object: typeof ObjectType.ExternalAccount;
 provider: string;
 identification_id: string;
 provider_user_id: string;
Expand All@@ -104,7 +106,7 @@ export interface IdentificationLinkJSON extends ClerkResourceJSON {
}

export interface InvitationJSON extends ClerkResourceJSON {
 object: ObjectType.Invitation;
 object: typeof ObjectType.Invitation;
 email_address: string;
 public_metadata: Record<string, unknown> | null;
 created_at: number;
Expand All@@ -114,7 +116,7 @@ export interface InvitationJSON extends ClerkResourceJSON {
}

export interface OauthAccessTokenJSON {
 object: ObjectType.OauthAccessToken;
 object: typeof ObjectType.OauthAccessToken;
 provider: string;
 token: string;
 public_metadata: Record<string, unknown>;
Expand All@@ -126,7 +128,7 @@ export interface OauthAccessTokenJSON {
}

export interface OrganizationJSON extends ClerkResourceJSON {
 object: ObjectType.Organization;
 object: typeof ObjectType.Organization;
 name: string;
 slug: string | null;
 image_url: string;
Expand All@@ -153,7 +155,7 @@ export interface OrganizationInvitationJSON extends ClerkResourceJSON {
}

export interface OrganizationMembershipJSON extends ClerkResourceJSON {
 object: ObjectType.OrganizationMembership;
 object: typeof ObjectType.OrganizationMembership;
 organization: OrganizationJSON;
 public_metadata: OrganizationMembershipPublicMetadata;
 private_metadata?: OrganizationMembershipPrivateMetadata;
Expand All@@ -173,7 +175,7 @@ export interface OrganizationMembershipPublicUserDataJSON {
}

export interface PhoneNumberJSON extends ClerkResourceJSON {
 object: ObjectType.PhoneNumber;
 object: typeof ObjectType.PhoneNumber;
 phone_number: string;
 reserved_for_second_factor: boolean;
 default_second_factor: boolean;
Expand All@@ -182,14 +184,14 @@ export interface PhoneNumberJSON extends ClerkResourceJSON {
}

export interface RedirectUrlJSON extends ClerkResourceJSON {
 object: ObjectType.RedirectUrl;
 object: typeof ObjectType.RedirectUrl;
 url: string;
 created_at: number;
 updated_at: number;
}

export interface SessionJSON extends ClerkResourceJSON {
 object: ObjectType.Session;
 object: typeof ObjectType.Session;
 client_id: string;
 user_id: string;
 status: string;
Expand All@@ -201,7 +203,7 @@ export interface SessionJSON extends ClerkResourceJSON {
}

export interface SignInJSON extends ClerkResourceJSON {
 object: ObjectType.SignInToken;
 object: typeof ObjectType.SignInToken;
 status: SignInStatus;
 identifier: string;
 created_session_id: string | null;
Expand All@@ -217,7 +219,7 @@ export interface SignInTokenJSON extends ClerkResourceJSON {
}

export interface SignUpJSON extends ClerkResourceJSON {
 object: ObjectType.SignUpAttempt;
 object: typeof ObjectType.SignUpAttempt;
 status: SignUpStatus;
 attribute_requirements: SignUpAttributeRequirements;
 username: string | null;
Expand All@@ -234,7 +236,7 @@ export interface SignUpJSON extends ClerkResourceJSON {
}

export interface SMSMessageJSON extends ClerkResourceJSON {
 object: ObjectType.SmsMessage;
 object: typeof ObjectType.SmsMessage;
 from_phone_number: string;
 to_phone_number: string;
 phone_number_id: string | null;
Expand All@@ -244,7 +246,7 @@ export interface SMSMessageJSON extends ClerkResourceJSON {
}

export interface UserJSON extends ClerkResourceJSON {
 object: ObjectType.User;
 object: typeof ObjectType.User;
 username: string | null;
 first_name: string;
 last_name: string;
Expand DownExpand Up@@ -287,7 +289,7 @@ export interface VerificationJSON extends ClerkResourceJSON {
}

export interface Web3WalletJSON extends ClerkResourceJSON {
 object: ObjectType.Web3Wallet;
 object: typeof ObjectType.Web3Wallet;
 web3_wallet: string;
 verification: VerificationJSON | null;
}
Expand Down

55 changes: 30 additions & 25 deletions
packages/backend/src/errors.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,35 +1,40 @@
export type TokenCarrier = 'header' | 'cookie';

export enum TokenVerificationErrorCode {
 InvalidSecretKey = 'clerk_key_invalid',
}
export const TokenVerificationErrorCode = {
 InvalidSecretKey: 'clerk_key_invalid',
};

export enum TokenVerificationErrorReason {
 TokenExpired = 'token-expired',
 TokenInvalid = 'token-invalid',
 TokenInvalidAlgorithm = 'token-invalid-algorithm',
 TokenInvalidAuthorizedParties = 'token-invalid-authorized-parties',
 TokenInvalidSignature = 'token-invalid-signature',
 TokenNotActiveYet = 'token-not-active-yet',
 TokenVerificationFailed = 'token-verification-failed',
 InvalidSecretKey = 'secret-key-invalid',
export type TokenVerificationErrorCode = (typeof TokenVerificationErrorCode)[keyof typeof TokenVerificationErrorCode];

 LocalJWKMissing = 'jwk-local-missing',
export const TokenVerificationErrorReason = {
 TokenExpired: 'token-expired',
 TokenInvalid: 'token-invalid',
 TokenInvalidAlgorithm: 'token-invalid-algorithm',
 TokenInvalidAuthorizedParties: 'token-invalid-authorized-parties',
 TokenInvalidSignature: 'token-invalid-signature',
 TokenNotActiveYet: 'token-not-active-yet',
 TokenVerificationFailed: 'token-verification-failed',
 InvalidSecretKey: 'secret-key-invalid',
 LocalJWKMissing: 'jwk-local-missing',
 RemoteJWKFailedToLoad: 'jwk-remote-failed-to-load',
 RemoteJWKInvalid: 'jwk-remote-invalid',
 RemoteJWKMissing: 'jwk-remote-missing',
 JWKFailedToResolve: 'jwk-failed-to-resolve',
};

 RemoteJWKFailedToLoad = 'jwk-remote-failed-to-load',
 RemoteJWKInvalid = 'jwk-remote-invalid',
 RemoteJWKMissing = 'jwk-remote-missing',
export type TokenVerificationErrorReason =
 (typeof TokenVerificationErrorReason)[keyof typeof TokenVerificationErrorReason];

 JWKFailedToResolve = 'jwk-failed-to-resolve',
}
export const TokenVerificationErrorAction = {
 ContactSupport: 'Contact support@clerk.com',
 EnsureClerkJWT: 'Make sure that this is a valid Clerk generate JWT.',
 SetClerkJWTKey: 'Set the CLERK_JWT_KEY environment variable.',
 SetClerkSecretKey: 'Set the CLERK_SECRET_KEY environment variable.',
 EnsureClockSync: 'Make sure your system clock is in sync (e.g. turn off and on automatic time synchronization).',
};

export enum TokenVerificationErrorAction {
 ContactSupport = 'Contact support@clerk.com',
 EnsureClerkJWT = 'Make sure that this is a valid Clerk generate JWT.',
 SetClerkJWTKey = 'Set the CLERK_JWT_KEY environment variable.',
 SetClerkSecretKey = 'Set the CLERK_SECRET_KEY environment variable.',
 EnsureClockSync = 'Make sure your system clock is in sync (e.g. turn off and on automatic time synchronization).',
}
export type TokenVerificationErrorAction =
 (typeof TokenVerificationErrorAction)[keyof typeof TokenVerificationErrorAction];

export class TokenVerificationError extends Error {
 action?: TokenVerificationErrorAction;
Expand Down

42 changes: 23 additions & 19 deletions
packages/backend/src/tokens/authStatus.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,14 +5,16 @@ import type { AuthenticateContext } from './authenticateContext';
import type { SignedInAuthObject, SignedOutAuthObject } from './authObjects';
import { signedInAuthObject, signedOutAuthObject } from './authObjects';

export enum AuthStatus {
 SignedIn = 'signed-in',
 SignedOut = 'signed-out',
 Handshake = 'handshake',
}
export const AuthStatus = {
 SignedIn: 'signed-in',
 SignedOut: 'signed-out',
 Handshake: 'handshake',
} as const;

export type AuthStatus = (typeof AuthStatus)[keyof typeof AuthStatus];

export type SignedInState = {
 status: AuthStatus.SignedIn;
 status: typeof AuthStatus.SignedIn;
 reason: null;
 message: null;
 proxyUrl?: string;
Expand All@@ -29,7 +31,7 @@ export type SignedInState = {
};

export type SignedOutState = {
 status: AuthStatus.SignedOut;
 status: typeof AuthStatus.SignedOut;
 message: string;
 reason: AuthReason;
 proxyUrl?: string;
Expand All@@ -46,22 +48,24 @@ export type SignedOutState = {
};

export type HandshakeState = Omit<SignedOutState, 'status' | 'toAuth'> & {
 status: AuthStatus.Handshake;
 status: typeof AuthStatus.Handshake;
 headers: Headers;
 toAuth: () => null;
};

export enum AuthErrorReason {
 ClientUATWithoutSessionToken = 'client-uat-but-no-session-token',
 DevBrowserSync = 'dev-browser-sync',
 PrimaryRespondsToSyncing = 'primary-responds-to-syncing',
 SatelliteCookieNeedsSyncing = 'satellite-needs-syncing',
 SessionTokenAndUATMissing = 'session-token-and-uat-missing',
 SessionTokenMissing = 'session-token-missing',
 SessionTokenOutdated = 'session-token-outdated',
 SessionTokenWithoutClientUAT = 'session-token-but-no-client-uat',
 UnexpectedError = 'unexpected-error',
}
export const AuthErrorReason = {
 ClientUATWithoutSessionToken: 'client-uat-but-no-session-token',
 DevBrowserSync: 'dev-browser-sync',
 PrimaryRespondsToSyncing: 'primary-responds-to-syncing',
 SatelliteCookieNeedsSyncing: 'satellite-needs-syncing',
 SessionTokenAndUATMissing: 'session-token-and-uat-missing',
 SessionTokenMissing: 'session-token-missing',
 SessionTokenOutdated: 'session-token-outdated',
 SessionTokenWithoutClientUAT: 'session-token-but-no-client-uat',
 UnexpectedError: 'unexpected-error',
} as const;

export type AuthErrorReason = (typeof AuthErrorReason)[keyof typeof AuthErrorReason];

export type AuthReason = AuthErrorReason | TokenVerificationErrorReason;

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
feat(backend): Replace enums with as const objects#2516

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

nikosdouvlis
merged 2 commits into

from

Jan 9, 2024
 Merged


feat(backend): Replace enums with as const objects
#2516
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
6bb96e8

feat(backend): Replace enums with `as const` objects


nikosdouvlis Jan 9, 2024
7837827

Create many-moons-matter.md


nikosdouvlis Jan 9, 2024

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


5 changes: 5 additions & 0 deletions
.changeset/many-moons-matter.md

View file


Open in desktop

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

Replace enums with `as const` objects so `@clerk/backend` is consistent with the other packages

88 changes: 45 additions & 43 deletions
packages/backend/src/api/resources/JSON.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -7,52 +7,54 @@ import type {
 SignUpStatus,
} from './Enums';

export enum ObjectType {
 AllowlistIdentifier = 'allowlist_identifier',
 Client = 'client',
 Email = 'email',
 EmailAddress = 'email_address',
 ExternalAccount = 'external_account',
 FacebookAccount = 'facebook_account',
 GoogleAccount = 'google_account',
 Invitation = 'invitation',
 OauthAccessToken = 'oauth_access_token',
 Organization = 'organization',
 OrganizationInvitation = 'organization_invitation',
 OrganizationMembership = 'organization_membership',
 PhoneNumber = 'phone_number',
 RedirectUrl = 'redirect_url',
 Session = 'session',
 SignInAttempt = 'sign_in_attempt',
 SignInToken = 'sign_in_token',
 SignUpAttempt = 'sign_up_attempt',
 SmsMessage = 'sms_message',
 User = 'user',
 Web3Wallet = 'web3_wallet',
 Token = 'token',
 TotalCount = 'total_count',
}
export const ObjectType = {
 AllowlistIdentifier: 'allowlist_identifier',
 Client: 'client',
 Email: 'email',
 EmailAddress: 'email_address',
 ExternalAccount: 'external_account',
 FacebookAccount: 'facebook_account',
 GoogleAccount: 'google_account',
 Invitation: 'invitation',
 OauthAccessToken: 'oauth_access_token',
 Organization: 'organization',
 OrganizationInvitation: 'organization_invitation',
 OrganizationMembership: 'organization_membership',
 PhoneNumber: 'phone_number',
 RedirectUrl: 'redirect_url',
 Session: 'session',
 SignInAttempt: 'sign_in_attempt',
 SignInToken: 'sign_in_token',
 SignUpAttempt: 'sign_up_attempt',
 SmsMessage: 'sms_message',
 User: 'user',
 Web3Wallet: 'web3_wallet',
 Token: 'token',
 TotalCount: 'total_count',
} as const;

export type ObjectType = (typeof ObjectType)[keyof typeof ObjectType];

export interface ClerkResourceJSON {
 object: ObjectType;
 id: string;
}

export interface TokenJSON {
 object: ObjectType.Token;
 object: typeof ObjectType.Token;
 jwt: string;
}

export interface AllowlistIdentifierJSON extends ClerkResourceJSON {
 object: ObjectType.AllowlistIdentifier;
 object: typeof ObjectType.AllowlistIdentifier;
 identifier: string;
 created_at: number;
 updated_at: number;
 invitation_id?: string;
}

export interface ClientJSON extends ClerkResourceJSON {
 object: ObjectType.Client;
 object: typeof ObjectType.Client;
 session_ids: string[];
 sessions: SessionJSON[];
 sign_in_id: string | null;
Expand All@@ -63,7 +65,7 @@ export interface ClientJSON extends ClerkResourceJSON {
}

export interface EmailJSON extends ClerkResourceJSON {
 object: ObjectType.Email;
 object: typeof ObjectType.Email;
 from_email_name: string;
 to_email_address?: string;
 email_address_id: string | null;
Expand All@@ -77,14 +79,14 @@ export interface EmailJSON extends ClerkResourceJSON {
}

export interface EmailAddressJSON extends ClerkResourceJSON {
 object: ObjectType.EmailAddress;
 object: typeof ObjectType.EmailAddress;
 email_address: string;
 verification: VerificationJSON | null;
 linked_to: IdentificationLinkJSON[];
}

export interface ExternalAccountJSON extends ClerkResourceJSON {
 object: ObjectType.ExternalAccount;
 object: typeof ObjectType.ExternalAccount;
 provider: string;
 identification_id: string;
 provider_user_id: string;
Expand All@@ -104,7 +106,7 @@ export interface IdentificationLinkJSON extends ClerkResourceJSON {
}

export interface InvitationJSON extends ClerkResourceJSON {
 object: ObjectType.Invitation;
 object: typeof ObjectType.Invitation;
 email_address: string;
 public_metadata: Record<string, unknown> | null;
 created_at: number;
Expand All@@ -114,7 +116,7 @@ export interface InvitationJSON extends ClerkResourceJSON {
}

export interface OauthAccessTokenJSON {
 object: ObjectType.OauthAccessToken;
 object: typeof ObjectType.OauthAccessToken;
 provider: string;
 token: string;
 public_metadata: Record<string, unknown>;
Expand All@@ -126,7 +128,7 @@ export interface OauthAccessTokenJSON {
}

export interface OrganizationJSON extends ClerkResourceJSON {
 object: ObjectType.Organization;
 object: typeof ObjectType.Organization;
 name: string;
 slug: string | null;
 image_url: string;
Expand All@@ -153,7 +155,7 @@ export interface OrganizationInvitationJSON extends ClerkResourceJSON {
}

export interface OrganizationMembershipJSON extends ClerkResourceJSON {
 object: ObjectType.OrganizationMembership;
 object: typeof ObjectType.OrganizationMembership;
 organization: OrganizationJSON;
 public_metadata: OrganizationMembershipPublicMetadata;
 private_metadata?: OrganizationMembershipPrivateMetadata;
Expand All@@ -173,7 +175,7 @@ export interface OrganizationMembershipPublicUserDataJSON {
}

export interface PhoneNumberJSON extends ClerkResourceJSON {
 object: ObjectType.PhoneNumber;
 object: typeof ObjectType.PhoneNumber;
 phone_number: string;
 reserved_for_second_factor: boolean;
 default_second_factor: boolean;
Expand All@@ -182,14 +184,14 @@ export interface PhoneNumberJSON extends ClerkResourceJSON {
}

export interface RedirectUrlJSON extends ClerkResourceJSON {
 object: ObjectType.RedirectUrl;
 object: typeof ObjectType.RedirectUrl;
 url: string;
 created_at: number;
 updated_at: number;
}

export interface SessionJSON extends ClerkResourceJSON {
 object: ObjectType.Session;
 object: typeof ObjectType.Session;
 client_id: string;
 user_id: string;
 status: string;
Expand All@@ -201,7 +203,7 @@ export interface SessionJSON extends ClerkResourceJSON {
}

export interface SignInJSON extends ClerkResourceJSON {
 object: ObjectType.SignInToken;
 object: typeof ObjectType.SignInToken;
 status: SignInStatus;
 identifier: string;
 created_session_id: string | null;
Expand All@@ -217,7 +219,7 @@ export interface SignInTokenJSON extends ClerkResourceJSON {
}

export interface SignUpJSON extends ClerkResourceJSON {
 object: ObjectType.SignUpAttempt;
 object: typeof ObjectType.SignUpAttempt;
 status: SignUpStatus;
 attribute_requirements: SignUpAttributeRequirements;
 username: string | null;
Expand All@@ -234,7 +236,7 @@ export interface SignUpJSON extends ClerkResourceJSON {
}

export interface SMSMessageJSON extends ClerkResourceJSON {
 object: ObjectType.SmsMessage;
 object: typeof ObjectType.SmsMessage;
 from_phone_number: string;
 to_phone_number: string;
 phone_number_id: string | null;
Expand All@@ -244,7 +246,7 @@ export interface SMSMessageJSON extends ClerkResourceJSON {
}

export interface UserJSON extends ClerkResourceJSON {
 object: ObjectType.User;
 object: typeof ObjectType.User;
 username: string | null;
 first_name: string;
 last_name: string;
Expand DownExpand Up@@ -287,7 +289,7 @@ export interface VerificationJSON extends ClerkResourceJSON {
}

export interface Web3WalletJSON extends ClerkResourceJSON {
 object: ObjectType.Web3Wallet;
 object: typeof ObjectType.Web3Wallet;
 web3_wallet: string;
 verification: VerificationJSON | null;
}
Expand Down

55 changes: 30 additions & 25 deletions
packages/backend/src/errors.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,35 +1,40 @@
export type TokenCarrier = 'header' | 'cookie';

export enum TokenVerificationErrorCode {
 InvalidSecretKey = 'clerk_key_invalid',
}
export const TokenVerificationErrorCode = {
 InvalidSecretKey: 'clerk_key_invalid',
};

export enum TokenVerificationErrorReason {
 TokenExpired = 'token-expired',
 TokenInvalid = 'token-invalid',
 TokenInvalidAlgorithm = 'token-invalid-algorithm',
 TokenInvalidAuthorizedParties = 'token-invalid-authorized-parties',
 TokenInvalidSignature = 'token-invalid-signature',
 TokenNotActiveYet = 'token-not-active-yet',
 TokenVerificationFailed = 'token-verification-failed',
 InvalidSecretKey = 'secret-key-invalid',
export type TokenVerificationErrorCode = (typeof TokenVerificationErrorCode)[keyof typeof TokenVerificationErrorCode];

 LocalJWKMissing = 'jwk-local-missing',
export const TokenVerificationErrorReason = {
 TokenExpired: 'token-expired',
 TokenInvalid: 'token-invalid',
 TokenInvalidAlgorithm: 'token-invalid-algorithm',
 TokenInvalidAuthorizedParties: 'token-invalid-authorized-parties',
 TokenInvalidSignature: 'token-invalid-signature',
 TokenNotActiveYet: 'token-not-active-yet',
 TokenVerificationFailed: 'token-verification-failed',
 InvalidSecretKey: 'secret-key-invalid',
 LocalJWKMissing: 'jwk-local-missing',
 RemoteJWKFailedToLoad: 'jwk-remote-failed-to-load',
 RemoteJWKInvalid: 'jwk-remote-invalid',
 RemoteJWKMissing: 'jwk-remote-missing',
 JWKFailedToResolve: 'jwk-failed-to-resolve',
};

 RemoteJWKFailedToLoad = 'jwk-remote-failed-to-load',
 RemoteJWKInvalid = 'jwk-remote-invalid',
 RemoteJWKMissing = 'jwk-remote-missing',
export type TokenVerificationErrorReason =
 (typeof TokenVerificationErrorReason)[keyof typeof TokenVerificationErrorReason];

 JWKFailedToResolve = 'jwk-failed-to-resolve',
}
export const TokenVerificationErrorAction = {
 ContactSupport: 'Contact support@clerk.com',
 EnsureClerkJWT: 'Make sure that this is a valid Clerk generate JWT.',
 SetClerkJWTKey: 'Set the CLERK_JWT_KEY environment variable.',
 SetClerkSecretKey: 'Set the CLERK_SECRET_KEY environment variable.',
 EnsureClockSync: 'Make sure your system clock is in sync (e.g. turn off and on automatic time synchronization).',
};

export enum TokenVerificationErrorAction {
 ContactSupport = 'Contact support@clerk.com',
 EnsureClerkJWT = 'Make sure that this is a valid Clerk generate JWT.',
 SetClerkJWTKey = 'Set the CLERK_JWT_KEY environment variable.',
 SetClerkSecretKey = 'Set the CLERK_SECRET_KEY environment variable.',
 EnsureClockSync = 'Make sure your system clock is in sync (e.g. turn off and on automatic time synchronization).',
}
export type TokenVerificationErrorAction =
 (typeof TokenVerificationErrorAction)[keyof typeof TokenVerificationErrorAction];

export class TokenVerificationError extends Error {
 action?: TokenVerificationErrorAction;
Expand Down

42 changes: 23 additions & 19 deletions
packages/backend/src/tokens/authStatus.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,14 +5,16 @@ import type { AuthenticateContext } from './authenticateContext';
import type { SignedInAuthObject, SignedOutAuthObject } from './authObjects';
import { signedInAuthObject, signedOutAuthObject } from './authObjects';

export enum AuthStatus {
 SignedIn = 'signed-in',
 SignedOut = 'signed-out',
 Handshake = 'handshake',
}
export const AuthStatus = {
 SignedIn: 'signed-in',
 SignedOut: 'signed-out',
 Handshake: 'handshake',
} as const;

export type AuthStatus = (typeof AuthStatus)[keyof typeof AuthStatus];

export type SignedInState = {
 status: AuthStatus.SignedIn;
 status: typeof AuthStatus.SignedIn;
 reason: null;
 message: null;
 proxyUrl?: string;
Expand All@@ -29,7 +31,7 @@ export type SignedInState = {
};

export type SignedOutState = {
 status: AuthStatus.SignedOut;
 status: typeof AuthStatus.SignedOut;
 message: string;
 reason: AuthReason;
 proxyUrl?: string;
Expand All@@ -46,22 +48,24 @@ export type SignedOutState = {
};

export type HandshakeState = Omit<SignedOutState, 'status' | 'toAuth'> & {
 status: AuthStatus.Handshake;
 status: typeof AuthStatus.Handshake;
 headers: Headers;
 toAuth: () => null;
};

export enum AuthErrorReason {
 ClientUATWithoutSessionToken = 'client-uat-but-no-session-token',
 DevBrowserSync = 'dev-browser-sync',
 PrimaryRespondsToSyncing = 'primary-responds-to-syncing',
 SatelliteCookieNeedsSyncing = 'satellite-needs-syncing',
 SessionTokenAndUATMissing = 'session-token-and-uat-missing',
 SessionTokenMissing = 'session-token-missing',
 SessionTokenOutdated = 'session-token-outdated',
 SessionTokenWithoutClientUAT = 'session-token-but-no-client-uat',
 UnexpectedError = 'unexpected-error',
}
export const AuthErrorReason = {
 ClientUATWithoutSessionToken: 'client-uat-but-no-session-token',
 DevBrowserSync: 'dev-browser-sync',
 PrimaryRespondsToSyncing: 'primary-responds-to-syncing',
 SatelliteCookieNeedsSyncing: 'satellite-needs-syncing',
 SessionTokenAndUATMissing: 'session-token-and-uat-missing',
 SessionTokenMissing: 'session-token-missing',
 SessionTokenOutdated: 'session-token-outdated',
 SessionTokenWithoutClientUAT: 'session-token-but-no-client-uat',
 UnexpectedError: 'unexpected-error',
} as const;

export type AuthErrorReason = (typeof AuthErrorReason)[keyof typeof AuthErrorReason];

export type AuthReason = AuthErrorReason | TokenVerificationErrorReason;

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
feat(backend): Replace enums with as const objects#2516

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

nikosdouvlis
merged 2 commits into

from

Jan 9, 2024
 Merged


feat(backend): Replace enums with as const objects
#2516
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
6bb96e8

feat(backend): Replace enums with `as const` objects


nikosdouvlis Jan 9, 2024
7837827

Create many-moons-matter.md


nikosdouvlis Jan 9, 2024

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


5 changes: 5 additions & 0 deletions
.changeset/many-moons-matter.md

View file


Open in desktop

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

Replace enums with `as const` objects so `@clerk/backend` is consistent with the other packages

88 changes: 45 additions & 43 deletions
packages/backend/src/api/resources/JSON.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -7,52 +7,54 @@ import type {
 SignUpStatus,
} from './Enums';

export enum ObjectType {
 AllowlistIdentifier = 'allowlist_identifier',
 Client = 'client',
 Email = 'email',
 EmailAddress = 'email_address',
 ExternalAccount = 'external_account',
 FacebookAccount = 'facebook_account',
 GoogleAccount = 'google_account',
 Invitation = 'invitation',
 OauthAccessToken = 'oauth_access_token',
 Organization = 'organization',
 OrganizationInvitation = 'organization_invitation',
 OrganizationMembership = 'organization_membership',
 PhoneNumber = 'phone_number',
 RedirectUrl = 'redirect_url',
 Session = 'session',
 SignInAttempt = 'sign_in_attempt',
 SignInToken = 'sign_in_token',
 SignUpAttempt = 'sign_up_attempt',
 SmsMessage = 'sms_message',
 User = 'user',
 Web3Wallet = 'web3_wallet',
 Token = 'token',
 TotalCount = 'total_count',
}
export const ObjectType = {
 AllowlistIdentifier: 'allowlist_identifier',
 Client: 'client',
 Email: 'email',
 EmailAddress: 'email_address',
 ExternalAccount: 'external_account',
 FacebookAccount: 'facebook_account',
 GoogleAccount: 'google_account',
 Invitation: 'invitation',
 OauthAccessToken: 'oauth_access_token',
 Organization: 'organization',
 OrganizationInvitation: 'organization_invitation',
 OrganizationMembership: 'organization_membership',
 PhoneNumber: 'phone_number',
 RedirectUrl: 'redirect_url',
 Session: 'session',
 SignInAttempt: 'sign_in_attempt',
 SignInToken: 'sign_in_token',
 SignUpAttempt: 'sign_up_attempt',
 SmsMessage: 'sms_message',
 User: 'user',
 Web3Wallet: 'web3_wallet',
 Token: 'token',
 TotalCount: 'total_count',
} as const;

export type ObjectType = (typeof ObjectType)[keyof typeof ObjectType];

export interface ClerkResourceJSON {
 object: ObjectType;
 id: string;
}

export interface TokenJSON {
 object: ObjectType.Token;
 object: typeof ObjectType.Token;
 jwt: string;
}

export interface AllowlistIdentifierJSON extends ClerkResourceJSON {
 object: ObjectType.AllowlistIdentifier;
 object: typeof ObjectType.AllowlistIdentifier;
 identifier: string;
 created_at: number;
 updated_at: number;
 invitation_id?: string;
}

export interface ClientJSON extends ClerkResourceJSON {
 object: ObjectType.Client;
 object: typeof ObjectType.Client;
 session_ids: string[];
 sessions: SessionJSON[];
 sign_in_id: string | null;
Expand All@@ -63,7 +65,7 @@ export interface ClientJSON extends ClerkResourceJSON {
}

export interface EmailJSON extends ClerkResourceJSON {
 object: ObjectType.Email;
 object: typeof ObjectType.Email;
 from_email_name: string;
 to_email_address?: string;
 email_address_id: string | null;
Expand All@@ -77,14 +79,14 @@ export interface EmailJSON extends ClerkResourceJSON {
}

export interface EmailAddressJSON extends ClerkResourceJSON {
 object: ObjectType.EmailAddress;
 object: typeof ObjectType.EmailAddress;
 email_address: string;
 verification: VerificationJSON | null;
 linked_to: IdentificationLinkJSON[];
}

export interface ExternalAccountJSON extends ClerkResourceJSON {
 object: ObjectType.ExternalAccount;
 object: typeof ObjectType.ExternalAccount;
 provider: string;
 identification_id: string;
 provider_user_id: string;
Expand All@@ -104,7 +106,7 @@ export interface IdentificationLinkJSON extends ClerkResourceJSON {
}

export interface InvitationJSON extends ClerkResourceJSON {
 object: ObjectType.Invitation;
 object: typeof ObjectType.Invitation;
 email_address: string;
 public_metadata: Record<string, unknown> | null;
 created_at: number;
Expand All@@ -114,7 +116,7 @@ export interface InvitationJSON extends ClerkResourceJSON {
}

export interface OauthAccessTokenJSON {
 object: ObjectType.OauthAccessToken;
 object: typeof ObjectType.OauthAccessToken;
 provider: string;
 token: string;
 public_metadata: Record<string, unknown>;
Expand All@@ -126,7 +128,7 @@ export interface OauthAccessTokenJSON {
}

export interface OrganizationJSON extends ClerkResourceJSON {
 object: ObjectType.Organization;
 object: typeof ObjectType.Organization;
 name: string;
 slug: string | null;
 image_url: string;
Expand All@@ -153,7 +155,7 @@ export interface OrganizationInvitationJSON extends ClerkResourceJSON {
}

export interface OrganizationMembershipJSON extends ClerkResourceJSON {
 object: ObjectType.OrganizationMembership;
 object: typeof ObjectType.OrganizationMembership;
 organization: OrganizationJSON;
 public_metadata: OrganizationMembershipPublicMetadata;
 private_metadata?: OrganizationMembershipPrivateMetadata;
Expand All@@ -173,7 +175,7 @@ export interface OrganizationMembershipPublicUserDataJSON {
}

export interface PhoneNumberJSON extends ClerkResourceJSON {
 object: ObjectType.PhoneNumber;
 object: typeof ObjectType.PhoneNumber;
 phone_number: string;
 reserved_for_second_factor: boolean;
 default_second_factor: boolean;
Expand All@@ -182,14 +184,14 @@ export interface PhoneNumberJSON extends ClerkResourceJSON {
}

export interface RedirectUrlJSON extends ClerkResourceJSON {
 object: ObjectType.RedirectUrl;
 object: typeof ObjectType.RedirectUrl;
 url: string;
 created_at: number;
 updated_at: number;
}

export interface SessionJSON extends ClerkResourceJSON {
 object: ObjectType.Session;
 object: typeof ObjectType.Session;
 client_id: string;
 user_id: string;
 status: string;
Expand All@@ -201,7 +203,7 @@ export interface SessionJSON extends ClerkResourceJSON {
}

export interface SignInJSON extends ClerkResourceJSON {
 object: ObjectType.SignInToken;
 object: typeof ObjectType.SignInToken;
 status: SignInStatus;
 identifier: string;
 created_session_id: string | null;
Expand All@@ -217,7 +219,7 @@ export interface SignInTokenJSON extends ClerkResourceJSON {
}

export interface SignUpJSON extends ClerkResourceJSON {
 object: ObjectType.SignUpAttempt;
 object: typeof ObjectType.SignUpAttempt;
 status: SignUpStatus;
 attribute_requirements: SignUpAttributeRequirements;
 username: string | null;
Expand All@@ -234,7 +236,7 @@ export interface SignUpJSON extends ClerkResourceJSON {
}

export interface SMSMessageJSON extends ClerkResourceJSON {
 object: ObjectType.SmsMessage;
 object: typeof ObjectType.SmsMessage;
 from_phone_number: string;
 to_phone_number: string;
 phone_number_id: string | null;
Expand All@@ -244,7 +246,7 @@ export interface SMSMessageJSON extends ClerkResourceJSON {
}

export interface UserJSON extends ClerkResourceJSON {
 object: ObjectType.User;
 object: typeof ObjectType.User;
 username: string | null;
 first_name: string;
 last_name: string;
Expand DownExpand Up@@ -287,7 +289,7 @@ export interface VerificationJSON extends ClerkResourceJSON {
}

export interface Web3WalletJSON extends ClerkResourceJSON {
 object: ObjectType.Web3Wallet;
 object: typeof ObjectType.Web3Wallet;
 web3_wallet: string;
 verification: VerificationJSON | null;
}
Expand Down

55 changes: 30 additions & 25 deletions
packages/backend/src/errors.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,35 +1,40 @@
export type TokenCarrier = 'header' | 'cookie';

export enum TokenVerificationErrorCode {
 InvalidSecretKey = 'clerk_key_invalid',
}
export const TokenVerificationErrorCode = {
 InvalidSecretKey: 'clerk_key_invalid',
};

export enum TokenVerificationErrorReason {
 TokenExpired = 'token-expired',
 TokenInvalid = 'token-invalid',
 TokenInvalidAlgorithm = 'token-invalid-algorithm',
 TokenInvalidAuthorizedParties = 'token-invalid-authorized-parties',
 TokenInvalidSignature = 'token-invalid-signature',
 TokenNotActiveYet = 'token-not-active-yet',
 TokenVerificationFailed = 'token-verification-failed',
 InvalidSecretKey = 'secret-key-invalid',
export type TokenVerificationErrorCode = (typeof TokenVerificationErrorCode)[keyof typeof TokenVerificationErrorCode];

 LocalJWKMissing = 'jwk-local-missing',
export const TokenVerificationErrorReason = {
 TokenExpired: 'token-expired',
 TokenInvalid: 'token-invalid',
 TokenInvalidAlgorithm: 'token-invalid-algorithm',
 TokenInvalidAuthorizedParties: 'token-invalid-authorized-parties',
 TokenInvalidSignature: 'token-invalid-signature',
 TokenNotActiveYet: 'token-not-active-yet',
 TokenVerificationFailed: 'token-verification-failed',
 InvalidSecretKey: 'secret-key-invalid',
 LocalJWKMissing: 'jwk-local-missing',
 RemoteJWKFailedToLoad: 'jwk-remote-failed-to-load',
 RemoteJWKInvalid: 'jwk-remote-invalid',
 RemoteJWKMissing: 'jwk-remote-missing',
 JWKFailedToResolve: 'jwk-failed-to-resolve',
};

 RemoteJWKFailedToLoad = 'jwk-remote-failed-to-load',
 RemoteJWKInvalid = 'jwk-remote-invalid',
 RemoteJWKMissing = 'jwk-remote-missing',
export type TokenVerificationErrorReason =
 (typeof TokenVerificationErrorReason)[keyof typeof TokenVerificationErrorReason];

 JWKFailedToResolve = 'jwk-failed-to-resolve',
}
export const TokenVerificationErrorAction = {
 ContactSupport: 'Contact support@clerk.com',
 EnsureClerkJWT: 'Make sure that this is a valid Clerk generate JWT.',
 SetClerkJWTKey: 'Set the CLERK_JWT_KEY environment variable.',
 SetClerkSecretKey: 'Set the CLERK_SECRET_KEY environment variable.',
 EnsureClockSync: 'Make sure your system clock is in sync (e.g. turn off and on automatic time synchronization).',
};

export enum TokenVerificationErrorAction {
 ContactSupport = 'Contact support@clerk.com',
 EnsureClerkJWT = 'Make sure that this is a valid Clerk generate JWT.',
 SetClerkJWTKey = 'Set the CLERK_JWT_KEY environment variable.',
 SetClerkSecretKey = 'Set the CLERK_SECRET_KEY environment variable.',
 EnsureClockSync = 'Make sure your system clock is in sync (e.g. turn off and on automatic time synchronization).',
}
export type TokenVerificationErrorAction =
 (typeof TokenVerificationErrorAction)[keyof typeof TokenVerificationErrorAction];

export class TokenVerificationError extends Error {
 action?: TokenVerificationErrorAction;
Expand Down

42 changes: 23 additions & 19 deletions
packages/backend/src/tokens/authStatus.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,14 +5,16 @@ import type { AuthenticateContext } from './authenticateContext';
import type { SignedInAuthObject, SignedOutAuthObject } from './authObjects';
import { signedInAuthObject, signedOutAuthObject } from './authObjects';

export enum AuthStatus {
 SignedIn = 'signed-in',
 SignedOut = 'signed-out',
 Handshake = 'handshake',
}
export const AuthStatus = {
 SignedIn: 'signed-in',
 SignedOut: 'signed-out',
 Handshake: 'handshake',
} as const;

export type AuthStatus = (typeof AuthStatus)[keyof typeof AuthStatus];

export type SignedInState = {
 status: AuthStatus.SignedIn;
 status: typeof AuthStatus.SignedIn;
 reason: null;
 message: null;
 proxyUrl?: string;
Expand All@@ -29,7 +31,7 @@ export type SignedInState = {
};

export type SignedOutState = {
 status: AuthStatus.SignedOut;
 status: typeof AuthStatus.SignedOut;
 message: string;
 reason: AuthReason;
 proxyUrl?: string;
Expand All@@ -46,22 +48,24 @@ export type SignedOutState = {
};

export type HandshakeState = Omit<SignedOutState, 'status' | 'toAuth'> & {
 status: AuthStatus.Handshake;
 status: typeof AuthStatus.Handshake;
 headers: Headers;
 toAuth: () => null;
};

export enum AuthErrorReason {
 ClientUATWithoutSessionToken = 'client-uat-but-no-session-token',
 DevBrowserSync = 'dev-browser-sync',
 PrimaryRespondsToSyncing = 'primary-responds-to-syncing',
 SatelliteCookieNeedsSyncing = 'satellite-needs-syncing',
 SessionTokenAndUATMissing = 'session-token-and-uat-missing',
 SessionTokenMissing = 'session-token-missing',
 SessionTokenOutdated = 'session-token-outdated',
 SessionTokenWithoutClientUAT = 'session-token-but-no-client-uat',
 UnexpectedError = 'unexpected-error',
}
export const AuthErrorReason = {
 ClientUATWithoutSessionToken: 'client-uat-but-no-session-token',
 DevBrowserSync: 'dev-browser-sync',
 PrimaryRespondsToSyncing: 'primary-responds-to-syncing',
 SatelliteCookieNeedsSyncing: 'satellite-needs-syncing',
 SessionTokenAndUATMissing: 'session-token-and-uat-missing',
 SessionTokenMissing: 'session-token-missing',
 SessionTokenOutdated: 'session-token-outdated',
 SessionTokenWithoutClientUAT: 'session-token-but-no-client-uat',
 UnexpectedError: 'unexpected-error',
} as const;

export type AuthErrorReason = (typeof AuthErrorReason)[keyof typeof AuthErrorReason];

export type AuthReason = AuthErrorReason | TokenVerificationErrorReason;

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
feat(backend): Replace enums with as const objects#2516

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

nikosdouvlis
merged 2 commits into

from

Jan 9, 2024
 Merged


feat(backend): Replace enums with as const objects
#2516
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
6bb96e8

feat(backend): Replace enums with `as const` objects


nikosdouvlis Jan 9, 2024
7837827

Create many-moons-matter.md


nikosdouvlis Jan 9, 2024

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


5 changes: 5 additions & 0 deletions
.changeset/many-moons-matter.md

View file


Open in desktop

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

Replace enums with `as const` objects so `@clerk/backend` is consistent with the other packages

88 changes: 45 additions & 43 deletions
packages/backend/src/api/resources/JSON.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -7,52 +7,54 @@ import type {
 SignUpStatus,
} from './Enums';

export enum ObjectType {
 AllowlistIdentifier = 'allowlist_identifier',
 Client = 'client',
 Email = 'email',
 EmailAddress = 'email_address',
 ExternalAccount = 'external_account',
 FacebookAccount = 'facebook_account',
 GoogleAccount = 'google_account',
 Invitation = 'invitation',
 OauthAccessToken = 'oauth_access_token',
 Organization = 'organization',
 OrganizationInvitation = 'organization_invitation',
 OrganizationMembership = 'organization_membership',
 PhoneNumber = 'phone_number',
 RedirectUrl = 'redirect_url',
 Session = 'session',
 SignInAttempt = 'sign_in_attempt',
 SignInToken = 'sign_in_token',
 SignUpAttempt = 'sign_up_attempt',
 SmsMessage = 'sms_message',
 User = 'user',
 Web3Wallet = 'web3_wallet',
 Token = 'token',
 TotalCount = 'total_count',
}
export const ObjectType = {
 AllowlistIdentifier: 'allowlist_identifier',
 Client: 'client',
 Email: 'email',
 EmailAddress: 'email_address',
 ExternalAccount: 'external_account',
 FacebookAccount: 'facebook_account',
 GoogleAccount: 'google_account',
 Invitation: 'invitation',
 OauthAccessToken: 'oauth_access_token',
 Organization: 'organization',
 OrganizationInvitation: 'organization_invitation',
 OrganizationMembership: 'organization_membership',
 PhoneNumber: 'phone_number',
 RedirectUrl: 'redirect_url',
 Session: 'session',
 SignInAttempt: 'sign_in_attempt',
 SignInToken: 'sign_in_token',
 SignUpAttempt: 'sign_up_attempt',
 SmsMessage: 'sms_message',
 User: 'user',
 Web3Wallet: 'web3_wallet',
 Token: 'token',
 TotalCount: 'total_count',
} as const;

export type ObjectType = (typeof ObjectType)[keyof typeof ObjectType];

export interface ClerkResourceJSON {
 object: ObjectType;
 id: string;
}

export interface TokenJSON {
 object: ObjectType.Token;
 object: typeof ObjectType.Token;
 jwt: string;
}

export interface AllowlistIdentifierJSON extends ClerkResourceJSON {
 object: ObjectType.AllowlistIdentifier;
 object: typeof ObjectType.AllowlistIdentifier;
 identifier: string;
 created_at: number;
 updated_at: number;
 invitation_id?: string;
}

export interface ClientJSON extends ClerkResourceJSON {
 object: ObjectType.Client;
 object: typeof ObjectType.Client;
 session_ids: string[];
 sessions: SessionJSON[];
 sign_in_id: string | null;
Expand All@@ -63,7 +65,7 @@ export interface ClientJSON extends ClerkResourceJSON {
}

export interface EmailJSON extends ClerkResourceJSON {
 object: ObjectType.Email;
 object: typeof ObjectType.Email;
 from_email_name: string;
 to_email_address?: string;
 email_address_id: string | null;
Expand All@@ -77,14 +79,14 @@ export interface EmailJSON extends ClerkResourceJSON {
}

export interface EmailAddressJSON extends ClerkResourceJSON {
 object: ObjectType.EmailAddress;
 object: typeof ObjectType.EmailAddress;
 email_address: string;
 verification: VerificationJSON | null;
 linked_to: IdentificationLinkJSON[];
}

export interface ExternalAccountJSON extends ClerkResourceJSON {
 object: ObjectType.ExternalAccount;
 object: typeof ObjectType.ExternalAccount;
 provider: string;
 identification_id: string;
 provider_user_id: string;
Expand All@@ -104,7 +106,7 @@ export interface IdentificationLinkJSON extends ClerkResourceJSON {
}

export interface InvitationJSON extends ClerkResourceJSON {
 object: ObjectType.Invitation;
 object: typeof ObjectType.Invitation;
 email_address: string;
 public_metadata: Record<string, unknown> | null;
 created_at: number;
Expand All@@ -114,7 +116,7 @@ export interface InvitationJSON extends ClerkResourceJSON {
}

export interface OauthAccessTokenJSON {
 object: ObjectType.OauthAccessToken;
 object: typeof ObjectType.OauthAccessToken;
 provider: string;
 token: string;
 public_metadata: Record<string, unknown>;
Expand All@@ -126,7 +128,7 @@ export interface OauthAccessTokenJSON {
}

export interface OrganizationJSON extends ClerkResourceJSON {
 object: ObjectType.Organization;
 object: typeof ObjectType.Organization;
 name: string;
 slug: string | null;
 image_url: string;
Expand All@@ -153,7 +155,7 @@ export interface OrganizationInvitationJSON extends ClerkResourceJSON {
}

export interface OrganizationMembershipJSON extends ClerkResourceJSON {
 object: ObjectType.OrganizationMembership;
 object: typeof ObjectType.OrganizationMembership;
 organization: OrganizationJSON;
 public_metadata: OrganizationMembershipPublicMetadata;
 private_metadata?: OrganizationMembershipPrivateMetadata;
Expand All@@ -173,7 +175,7 @@ export interface OrganizationMembershipPublicUserDataJSON {
}

export interface PhoneNumberJSON extends ClerkResourceJSON {
 object: ObjectType.PhoneNumber;
 object: typeof ObjectType.PhoneNumber;
 phone_number: string;
 reserved_for_second_factor: boolean;
 default_second_factor: boolean;
Expand All@@ -182,14 +184,14 @@ export interface PhoneNumberJSON extends ClerkResourceJSON {
}

export interface RedirectUrlJSON extends ClerkResourceJSON {
 object: ObjectType.RedirectUrl;
 object: typeof ObjectType.RedirectUrl;
 url: string;
 created_at: number;
 updated_at: number;
}

export interface SessionJSON extends ClerkResourceJSON {
 object: ObjectType.Session;
 object: typeof ObjectType.Session;
 client_id: string;
 user_id: string;
 status: string;
Expand All@@ -201,7 +203,7 @@ export interface SessionJSON extends ClerkResourceJSON {
}

export interface SignInJSON extends ClerkResourceJSON {
 object: ObjectType.SignInToken;
 object: typeof ObjectType.SignInToken;
 status: SignInStatus;
 identifier: string;
 created_session_id: string | null;
Expand All@@ -217,7 +219,7 @@ export interface SignInTokenJSON extends ClerkResourceJSON {
}

export interface SignUpJSON extends ClerkResourceJSON {
 object: ObjectType.SignUpAttempt;
 object: typeof ObjectType.SignUpAttempt;
 status: SignUpStatus;
 attribute_requirements: SignUpAttributeRequirements;
 username: string | null;
Expand All@@ -234,7 +236,7 @@ export interface SignUpJSON extends ClerkResourceJSON {
}

export interface SMSMessageJSON extends ClerkResourceJSON {
 object: ObjectType.SmsMessage;
 object: typeof ObjectType.SmsMessage;
 from_phone_number: string;
 to_phone_number: string;
 phone_number_id: string | null;
Expand All@@ -244,7 +246,7 @@ export interface SMSMessageJSON extends ClerkResourceJSON {
}

export interface UserJSON extends ClerkResourceJSON {
 object: ObjectType.User;
 object: typeof ObjectType.User;
 username: string | null;
 first_name: string;
 last_name: string;
Expand DownExpand Up@@ -287,7 +289,7 @@ export interface VerificationJSON extends ClerkResourceJSON {
}

export interface Web3WalletJSON extends ClerkResourceJSON {
 object: ObjectType.Web3Wallet;
 object: typeof ObjectType.Web3Wallet;
 web3_wallet: string;
 verification: VerificationJSON | null;
}
Expand Down

55 changes: 30 additions & 25 deletions
packages/backend/src/errors.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,35 +1,40 @@
export type TokenCarrier = 'header' | 'cookie';

export enum TokenVerificationErrorCode {
 InvalidSecretKey = 'clerk_key_invalid',
}
export const TokenVerificationErrorCode = {
 InvalidSecretKey: 'clerk_key_invalid',
};

export enum TokenVerificationErrorReason {
 TokenExpired = 'token-expired',
 TokenInvalid = 'token-invalid',
 TokenInvalidAlgorithm = 'token-invalid-algorithm',
 TokenInvalidAuthorizedParties = 'token-invalid-authorized-parties',
 TokenInvalidSignature = 'token-invalid-signature',
 TokenNotActiveYet = 'token-not-active-yet',
 TokenVerificationFailed = 'token-verification-failed',
 InvalidSecretKey = 'secret-key-invalid',
export type TokenVerificationErrorCode = (typeof TokenVerificationErrorCode)[keyof typeof TokenVerificationErrorCode];

 LocalJWKMissing = 'jwk-local-missing',
export const TokenVerificationErrorReason = {
 TokenExpired: 'token-expired',
 TokenInvalid: 'token-invalid',
 TokenInvalidAlgorithm: 'token-invalid-algorithm',
 TokenInvalidAuthorizedParties: 'token-invalid-authorized-parties',
 TokenInvalidSignature: 'token-invalid-signature',
 TokenNotActiveYet: 'token-not-active-yet',
 TokenVerificationFailed: 'token-verification-failed',
 InvalidSecretKey: 'secret-key-invalid',
 LocalJWKMissing: 'jwk-local-missing',
 RemoteJWKFailedToLoad: 'jwk-remote-failed-to-load',
 RemoteJWKInvalid: 'jwk-remote-invalid',
 RemoteJWKMissing: 'jwk-remote-missing',
 JWKFailedToResolve: 'jwk-failed-to-resolve',
};

 RemoteJWKFailedToLoad = 'jwk-remote-failed-to-load',
 RemoteJWKInvalid = 'jwk-remote-invalid',
 RemoteJWKMissing = 'jwk-remote-missing',
export type TokenVerificationErrorReason =
 (typeof TokenVerificationErrorReason)[keyof typeof TokenVerificationErrorReason];

 JWKFailedToResolve = 'jwk-failed-to-resolve',
}
export const TokenVerificationErrorAction = {
 ContactSupport: 'Contact support@clerk.com',
 EnsureClerkJWT: 'Make sure that this is a valid Clerk generate JWT.',
 SetClerkJWTKey: 'Set the CLERK_JWT_KEY environment variable.',
 SetClerkSecretKey: 'Set the CLERK_SECRET_KEY environment variable.',
 EnsureClockSync: 'Make sure your system clock is in sync (e.g. turn off and on automatic time synchronization).',
};

export enum TokenVerificationErrorAction {
 ContactSupport = 'Contact support@clerk.com',
 EnsureClerkJWT = 'Make sure that this is a valid Clerk generate JWT.',
 SetClerkJWTKey = 'Set the CLERK_JWT_KEY environment variable.',
 SetClerkSecretKey = 'Set the CLERK_SECRET_KEY environment variable.',
 EnsureClockSync = 'Make sure your system clock is in sync (e.g. turn off and on automatic time synchronization).',
}
export type TokenVerificationErrorAction =
 (typeof TokenVerificationErrorAction)[keyof typeof TokenVerificationErrorAction];

export class TokenVerificationError extends Error {
 action?: TokenVerificationErrorAction;
Expand Down

42 changes: 23 additions & 19 deletions
packages/backend/src/tokens/authStatus.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,14 +5,16 @@ import type { AuthenticateContext } from './authenticateContext';
import type { SignedInAuthObject, SignedOutAuthObject } from './authObjects';
import { signedInAuthObject, signedOutAuthObject } from './authObjects';

export enum AuthStatus {
 SignedIn = 'signed-in',
 SignedOut = 'signed-out',
 Handshake = 'handshake',
}
export const AuthStatus = {
 SignedIn: 'signed-in',
 SignedOut: 'signed-out',
 Handshake: 'handshake',
} as const;

export type AuthStatus = (typeof AuthStatus)[keyof typeof AuthStatus];

export type SignedInState = {
 status: AuthStatus.SignedIn;
 status: typeof AuthStatus.SignedIn;
 reason: null;
 message: null;
 proxyUrl?: string;
Expand All@@ -29,7 +31,7 @@ export type SignedInState = {
};

export type SignedOutState = {
 status: AuthStatus.SignedOut;
 status: typeof AuthStatus.SignedOut;
 message: string;
 reason: AuthReason;
 proxyUrl?: string;
Expand All@@ -46,22 +48,24 @@ export type SignedOutState = {
};

export type HandshakeState = Omit<SignedOutState, 'status' | 'toAuth'> & {
 status: AuthStatus.Handshake;
 status: typeof AuthStatus.Handshake;
 headers: Headers;
 toAuth: () => null;
};

export enum AuthErrorReason {
 ClientUATWithoutSessionToken = 'client-uat-but-no-session-token',
 DevBrowserSync = 'dev-browser-sync',
 PrimaryRespondsToSyncing = 'primary-responds-to-syncing',
 SatelliteCookieNeedsSyncing = 'satellite-needs-syncing',
 SessionTokenAndUATMissing = 'session-token-and-uat-missing',
 SessionTokenMissing = 'session-token-missing',
 SessionTokenOutdated = 'session-token-outdated',
 SessionTokenWithoutClientUAT = 'session-token-but-no-client-uat',
 UnexpectedError = 'unexpected-error',
}
export const AuthErrorReason = {
 ClientUATWithoutSessionToken: 'client-uat-but-no-session-token',
 DevBrowserSync: 'dev-browser-sync',
 PrimaryRespondsToSyncing: 'primary-responds-to-syncing',
 SatelliteCookieNeedsSyncing: 'satellite-needs-syncing',
 SessionTokenAndUATMissing: 'session-token-and-uat-missing',
 SessionTokenMissing: 'session-token-missing',
 SessionTokenOutdated: 'session-token-outdated',
 SessionTokenWithoutClientUAT: 'session-token-but-no-client-uat',
 UnexpectedError: 'unexpected-error',
} as const;

export type AuthErrorReason = (typeof AuthErrorReason)[keyof typeof AuthErrorReason];

export type AuthReason = AuthErrorReason | TokenVerificationErrorReason;

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
feat(backend): Replace enums with as const objects#2516

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

nikosdouvlis
merged 2 commits into

from

Jan 9, 2024
 Merged


feat(backend): Replace enums with as const objects
#2516
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
6bb96e8

feat(backend): Replace enums with `as const` objects


nikosdouvlis Jan 9, 2024
7837827

Create many-moons-matter.md


nikosdouvlis Jan 9, 2024

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


5 changes: 5 additions & 0 deletions
.changeset/many-moons-matter.md

View file


Open in desktop

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

Replace enums with `as const` objects so `@clerk/backend` is consistent with the other packages

88 changes: 45 additions & 43 deletions
packages/backend/src/api/resources/JSON.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -7,52 +7,54 @@ import type {
 SignUpStatus,
} from './Enums';

export enum ObjectType {
 AllowlistIdentifier = 'allowlist_identifier',
 Client = 'client',
 Email = 'email',
 EmailAddress = 'email_address',
 ExternalAccount = 'external_account',
 FacebookAccount = 'facebook_account',
 GoogleAccount = 'google_account',
 Invitation = 'invitation',
 OauthAccessToken = 'oauth_access_token',
 Organization = 'organization',
 OrganizationInvitation = 'organization_invitation',
 OrganizationMembership = 'organization_membership',
 PhoneNumber = 'phone_number',
 RedirectUrl = 'redirect_url',
 Session = 'session',
 SignInAttempt = 'sign_in_attempt',
 SignInToken = 'sign_in_token',
 SignUpAttempt = 'sign_up_attempt',
 SmsMessage = 'sms_message',
 User = 'user',
 Web3Wallet = 'web3_wallet',
 Token = 'token',
 TotalCount = 'total_count',
}
export const ObjectType = {
 AllowlistIdentifier: 'allowlist_identifier',
 Client: 'client',
 Email: 'email',
 EmailAddress: 'email_address',
 ExternalAccount: 'external_account',
 FacebookAccount: 'facebook_account',
 GoogleAccount: 'google_account',
 Invitation: 'invitation',
 OauthAccessToken: 'oauth_access_token',
 Organization: 'organization',
 OrganizationInvitation: 'organization_invitation',
 OrganizationMembership: 'organization_membership',
 PhoneNumber: 'phone_number',
 RedirectUrl: 'redirect_url',
 Session: 'session',
 SignInAttempt: 'sign_in_attempt',
 SignInToken: 'sign_in_token',
 SignUpAttempt: 'sign_up_attempt',
 SmsMessage: 'sms_message',
 User: 'user',
 Web3Wallet: 'web3_wallet',
 Token: 'token',
 TotalCount: 'total_count',
} as const;

export type ObjectType = (typeof ObjectType)[keyof typeof ObjectType];

export interface ClerkResourceJSON {
 object: ObjectType;
 id: string;
}

export interface TokenJSON {
 object: ObjectType.Token;
 object: typeof ObjectType.Token;
 jwt: string;
}

export interface AllowlistIdentifierJSON extends ClerkResourceJSON {
 object: ObjectType.AllowlistIdentifier;
 object: typeof ObjectType.AllowlistIdentifier;
 identifier: string;
 created_at: number;
 updated_at: number;
 invitation_id?: string;
}

export interface ClientJSON extends ClerkResourceJSON {
 object: ObjectType.Client;
 object: typeof ObjectType.Client;
 session_ids: string[];
 sessions: SessionJSON[];
 sign_in_id: string | null;
Expand All@@ -63,7 +65,7 @@ export interface ClientJSON extends ClerkResourceJSON {
}

export interface EmailJSON extends ClerkResourceJSON {
 object: ObjectType.Email;
 object: typeof ObjectType.Email;
 from_email_name: string;
 to_email_address?: string;
 email_address_id: string | null;
Expand All@@ -77,14 +79,14 @@ export interface EmailJSON extends ClerkResourceJSON {
}

export interface EmailAddressJSON extends ClerkResourceJSON {
 object: ObjectType.EmailAddress;
 object: typeof ObjectType.EmailAddress;
 email_address: string;
 verification: VerificationJSON | null;
 linked_to: IdentificationLinkJSON[];
}

export interface ExternalAccountJSON extends ClerkResourceJSON {
 object: ObjectType.ExternalAccount;
 object: typeof ObjectType.ExternalAccount;
 provider: string;
 identification_id: string;
 provider_user_id: string;
Expand All@@ -104,7 +106,7 @@ export interface IdentificationLinkJSON extends ClerkResourceJSON {
}

export interface InvitationJSON extends ClerkResourceJSON {
 object: ObjectType.Invitation;
 object: typeof ObjectType.Invitation;
 email_address: string;
 public_metadata: Record<string, unknown> | null;
 created_at: number;
Expand All@@ -114,7 +116,7 @@ export interface InvitationJSON extends ClerkResourceJSON {
}

export interface OauthAccessTokenJSON {
 object: ObjectType.OauthAccessToken;
 object: typeof ObjectType.OauthAccessToken;
 provider: string;
 token: string;
 public_metadata: Record<string, unknown>;
Expand All@@ -126,7 +128,7 @@ export interface OauthAccessTokenJSON {
}

export interface OrganizationJSON extends ClerkResourceJSON {
 object: ObjectType.Organization;
 object: typeof ObjectType.Organization;
 name: string;
 slug: string | null;
 image_url: string;
Expand All@@ -153,7 +155,7 @@ export interface OrganizationInvitationJSON extends ClerkResourceJSON {
}

export interface OrganizationMembershipJSON extends ClerkResourceJSON {
 object: ObjectType.OrganizationMembership;
 object: typeof ObjectType.OrganizationMembership;
 organization: OrganizationJSON;
 public_metadata: OrganizationMembershipPublicMetadata;
 private_metadata?: OrganizationMembershipPrivateMetadata;
Expand All@@ -173,7 +175,7 @@ export interface OrganizationMembershipPublicUserDataJSON {
}

export interface PhoneNumberJSON extends ClerkResourceJSON {
 object: ObjectType.PhoneNumber;
 object: typeof ObjectType.PhoneNumber;
 phone_number: string;
 reserved_for_second_factor: boolean;
 default_second_factor: boolean;
Expand All@@ -182,14 +184,14 @@ export interface PhoneNumberJSON extends ClerkResourceJSON {
}

export interface RedirectUrlJSON extends ClerkResourceJSON {
 object: ObjectType.RedirectUrl;
 object: typeof ObjectType.RedirectUrl;
 url: string;
 created_at: number;
 updated_at: number;
}

export interface SessionJSON extends ClerkResourceJSON {
 object: ObjectType.Session;
 object: typeof ObjectType.Session;
 client_id: string;
 user_id: string;
 status: string;
Expand All@@ -201,7 +203,7 @@ export interface SessionJSON extends ClerkResourceJSON {
}

export interface SignInJSON extends ClerkResourceJSON {
 object: ObjectType.SignInToken;
 object: typeof ObjectType.SignInToken;
 status: SignInStatus;
 identifier: string;
 created_session_id: string | null;
Expand All@@ -217,7 +219,7 @@ export interface SignInTokenJSON extends ClerkResourceJSON {
}

export interface SignUpJSON extends ClerkResourceJSON {
 object: ObjectType.SignUpAttempt;
 object: typeof ObjectType.SignUpAttempt;
 status: SignUpStatus;
 attribute_requirements: SignUpAttributeRequirements;
 username: string | null;
Expand All@@ -234,7 +236,7 @@ export interface SignUpJSON extends ClerkResourceJSON {
}

export interface SMSMessageJSON extends ClerkResourceJSON {
 object: ObjectType.SmsMessage;
 object: typeof ObjectType.SmsMessage;
 from_phone_number: string;
 to_phone_number: string;
 phone_number_id: string | null;
Expand All@@ -244,7 +246,7 @@ export interface SMSMessageJSON extends ClerkResourceJSON {
}

export interface UserJSON extends ClerkResourceJSON {
 object: ObjectType.User;
 object: typeof ObjectType.User;
 username: string | null;
 first_name: string;
 last_name: string;
Expand DownExpand Up@@ -287,7 +289,7 @@ export interface VerificationJSON extends ClerkResourceJSON {
}

export interface Web3WalletJSON extends ClerkResourceJSON {
 object: ObjectType.Web3Wallet;
 object: typeof ObjectType.Web3Wallet;
 web3_wallet: string;
 verification: VerificationJSON | null;
}
Expand Down

55 changes: 30 additions & 25 deletions
packages/backend/src/errors.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,35 +1,40 @@
export type TokenCarrier = 'header' | 'cookie';

export enum TokenVerificationErrorCode {
 InvalidSecretKey = 'clerk_key_invalid',
}
export const TokenVerificationErrorCode = {
 InvalidSecretKey: 'clerk_key_invalid',
};

export enum TokenVerificationErrorReason {
 TokenExpired = 'token-expired',
 TokenInvalid = 'token-invalid',
 TokenInvalidAlgorithm = 'token-invalid-algorithm',
 TokenInvalidAuthorizedParties = 'token-invalid-authorized-parties',
 TokenInvalidSignature = 'token-invalid-signature',
 TokenNotActiveYet = 'token-not-active-yet',
 TokenVerificationFailed = 'token-verification-failed',
 InvalidSecretKey = 'secret-key-invalid',
export type TokenVerificationErrorCode = (typeof TokenVerificationErrorCode)[keyof typeof TokenVerificationErrorCode];

 LocalJWKMissing = 'jwk-local-missing',
export const TokenVerificationErrorReason = {
 TokenExpired: 'token-expired',
 TokenInvalid: 'token-invalid',
 TokenInvalidAlgorithm: 'token-invalid-algorithm',
 TokenInvalidAuthorizedParties: 'token-invalid-authorized-parties',
 TokenInvalidSignature: 'token-invalid-signature',
 TokenNotActiveYet: 'token-not-active-yet',
 TokenVerificationFailed: 'token-verification-failed',
 InvalidSecretKey: 'secret-key-invalid',
 LocalJWKMissing: 'jwk-local-missing',
 RemoteJWKFailedToLoad: 'jwk-remote-failed-to-load',
 RemoteJWKInvalid: 'jwk-remote-invalid',
 RemoteJWKMissing: 'jwk-remote-missing',
 JWKFailedToResolve: 'jwk-failed-to-resolve',
};

 RemoteJWKFailedToLoad = 'jwk-remote-failed-to-load',
 RemoteJWKInvalid = 'jwk-remote-invalid',
 RemoteJWKMissing = 'jwk-remote-missing',
export type TokenVerificationErrorReason =
 (typeof TokenVerificationErrorReason)[keyof typeof TokenVerificationErrorReason];

 JWKFailedToResolve = 'jwk-failed-to-resolve',
}
export const TokenVerificationErrorAction = {
 ContactSupport: 'Contact support@clerk.com',
 EnsureClerkJWT: 'Make sure that this is a valid Clerk generate JWT.',
 SetClerkJWTKey: 'Set the CLERK_JWT_KEY environment variable.',
 SetClerkSecretKey: 'Set the CLERK_SECRET_KEY environment variable.',
 EnsureClockSync: 'Make sure your system clock is in sync (e.g. turn off and on automatic time synchronization).',
};

export enum TokenVerificationErrorAction {
 ContactSupport = 'Contact support@clerk.com',
 EnsureClerkJWT = 'Make sure that this is a valid Clerk generate JWT.',
 SetClerkJWTKey = 'Set the CLERK_JWT_KEY environment variable.',
 SetClerkSecretKey = 'Set the CLERK_SECRET_KEY environment variable.',
 EnsureClockSync = 'Make sure your system clock is in sync (e.g. turn off and on automatic time synchronization).',
}
export type TokenVerificationErrorAction =
 (typeof TokenVerificationErrorAction)[keyof typeof TokenVerificationErrorAction];

export class TokenVerificationError extends Error {
 action?: TokenVerificationErrorAction;
Expand Down

42 changes: 23 additions & 19 deletions
packages/backend/src/tokens/authStatus.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,14 +5,16 @@ import type { AuthenticateContext } from './authenticateContext';
import type { SignedInAuthObject, SignedOutAuthObject } from './authObjects';
import { signedInAuthObject, signedOutAuthObject } from './authObjects';

export enum AuthStatus {
 SignedIn = 'signed-in',
 SignedOut = 'signed-out',
 Handshake = 'handshake',
}
export const AuthStatus = {
 SignedIn: 'signed-in',
 SignedOut: 'signed-out',
 Handshake: 'handshake',
} as const;

export type AuthStatus = (typeof AuthStatus)[keyof typeof AuthStatus];

export type SignedInState = {
 status: AuthStatus.SignedIn;
 status: typeof AuthStatus.SignedIn;
 reason: null;
 message: null;
 proxyUrl?: string;
Expand All@@ -29,7 +31,7 @@ export type SignedInState = {
};

export type SignedOutState = {
 status: AuthStatus.SignedOut;
 status: typeof AuthStatus.SignedOut;
 message: string;
 reason: AuthReason;
 proxyUrl?: string;
Expand All@@ -46,22 +48,24 @@ export type SignedOutState = {
};

export type HandshakeState = Omit<SignedOutState, 'status' | 'toAuth'> & {
 status: AuthStatus.Handshake;
 status: typeof AuthStatus.Handshake;
 headers: Headers;
 toAuth: () => null;
};

export enum AuthErrorReason {
 ClientUATWithoutSessionToken = 'client-uat-but-no-session-token',
 DevBrowserSync = 'dev-browser-sync',
 PrimaryRespondsToSyncing = 'primary-responds-to-syncing',
 SatelliteCookieNeedsSyncing = 'satellite-needs-syncing',
 SessionTokenAndUATMissing = 'session-token-and-uat-missing',
 SessionTokenMissing = 'session-token-missing',
 SessionTokenOutdated = 'session-token-outdated',
 SessionTokenWithoutClientUAT = 'session-token-but-no-client-uat',
 UnexpectedError = 'unexpected-error',
}
export const AuthErrorReason = {
 ClientUATWithoutSessionToken: 'client-uat-but-no-session-token',
 DevBrowserSync: 'dev-browser-sync',
 PrimaryRespondsToSyncing: 'primary-responds-to-syncing',
 SatelliteCookieNeedsSyncing: 'satellite-needs-syncing',
 SessionTokenAndUATMissing: 'session-token-and-uat-missing',
 SessionTokenMissing: 'session-token-missing',
 SessionTokenOutdated: 'session-token-outdated',
 SessionTokenWithoutClientUAT: 'session-token-but-no-client-uat',
 UnexpectedError: 'unexpected-error',
} as const;

export type AuthErrorReason = (typeof AuthErrorReason)[keyof typeof AuthErrorReason];

export type AuthReason = AuthErrorReason | TokenVerificationErrorReason;

Expand Down