feat(clerk-js,types): Expose SessionVerification as an experimental resource#4011

New issue

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

Sign up for GitHub

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

Already on GitHub? Sign in to your account

Merged
panteliselef merged 3 commits into from
Aug 26, 2024
Merged

feat(clerk-js,types): Expose SessionVerification as an experimental resource #4011

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
7fa85c9
feat(clerk-js,types): Expose `SessionVerification` as an experimental…
panteliselef Aug 23, 2024
20735d8
fix linting
panteliselef Aug 23, 2024
8585d40
Merge branch 'refs/heads/main' into elef/user-609-support-the-session…
panteliselef Aug 24, 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
12 changes: 12 additions & 0 deletions .changeset/late-taxis-end.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
---
"@clerk/clerk-js": minor
"@clerk/types": minor
---

Expose `SessionVerification` as an experimental resource.
Update `UserResource` with 5 new experimental methods:
- `experimental_verifySession` for creating a new SessionVerification record and initiating a new flow.
- `experimental_verifySessionPrepareFirstFactor` for preparing a supported first factor like `phone_code`
- `experimental_verifySessionAttemptFirstFactor` for attempting a supported first factor like `password`
- `experimental_verifySessionPrepareSecondFactor` for preparing a supported second factor like `phone_code`
- `experimental_verifySessionAttemptSecondFactor` for attempting a supported second factor like `totp`
46 changes: 46 additions & 0 deletions packages/clerk-js/src/core/resources/SessionVerification.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
import { deepSnakeToCamel } from '@clerk/shared';
import type {
__experimental_SessionVerificationFirstFactor,
__experimental_SessionVerificationJSON,
__experimental_SessionVerificationLevel,
__experimental_SessionVerificationResource,
__experimental_SessionVerificationSecondFactor,
__experimental_SessionVerificationStatus,
SessionResource,
VerificationResource,
} from '@clerk/types';

import { BaseResource, Session, Verification } from './internal';

export class SessionVerification extends BaseResource implements __experimental_SessionVerificationResource {
status!: __experimental_SessionVerificationStatus;
level!: __experimental_SessionVerificationLevel;
session!: SessionResource;
supportedFirstFactors: __experimental_SessionVerificationFirstFactor[] = [];
supportedSecondFactors: __experimental_SessionVerificationSecondFactor[] = [];
firstFactorVerification: VerificationResource = new Verification(null);
secondFactorVerification: VerificationResource = new Verification(null);

constructor(data: __experimental_SessionVerificationJSON | null = null) {
super();
this.fromJSON(data);
}

protected fromJSON(data: __experimental_SessionVerificationJSON | null): this {
if (data) {
this.id = data.id;
this.status = data.status;
this.session = new Session(data.session);
this.level = data.level;
this.supportedFirstFactors = deepSnakeToCamel(
data.supported_first_factors,
) as __experimental_SessionVerificationFirstFactor[];
this.supportedSecondFactors = deepSnakeToCamel(
data.supported_second_factors,
) as __experimental_SessionVerificationSecondFactor[];
this.firstFactorVerification = new Verification(data.first_factor_verification);
this.secondFactorVerification = new Verification(data.second_factor_verification);
}
return this;
}
}
103 changes: 103 additions & 0 deletions packages/clerk-js/src/core/resources/User.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,11 @@
import type {
__experimental_SessionVerificationJSON,
__experimental_SessionVerificationResource,
__experimental_SessionVerifyAttemptFirstFactorParams,
__experimental_SessionVerifyAttemptSecondFactorParams,
__experimental_SessionVerifyCreateParams,
__experimental_SessionVerifyPrepareFirstFactorParams,
__experimental_SessionVerifyPrepareSecondFactorParams,
BackupCodeJSON,
BackupCodeResource,
CreateEmailAddressParams,
Expand All@@ -8,6 +15,7 @@ import type {
DeletedObjectJSON,
DeletedObjectResource,
EmailAddressResource,
EmailCodeConfig,
ExternalAccountJSON,
ExternalAccountResource,
GetOrganizationMemberships,
Expand All@@ -16,6 +24,7 @@ import type {
ImageResource,
OrganizationMembershipResource,
PasskeyResource,
PhoneCodeConfig,
PhoneNumberResource,
RemoveUserPasswordParams,
SamlAccountResource,
Expand All@@ -33,6 +42,7 @@ import type {
import { unixEpochToDate } from '../../utils/date';
import { normalizeUnsafeMetadata } from '../../utils/resourceParams';
import { getFullName } from '../../utils/user';
import { clerkInvalidStrategy } from '../errors';
import { BackupCode } from './BackupCode';
import {
BaseResource,
Expand All@@ -50,6 +60,7 @@ import {
UserOrganizationInvitation,
Web3Wallet,
} from './internal';
import { SessionVerification } from './SessionVerification';

export class User extends BaseResource implements UserResource {
pathRoot = '/me';
Expand DownExpand Up@@ -239,6 +250,98 @@ export class User extends BaseResource implements UserResource {
return this._baseDelete({ path: '/me' });
};

__experimental_verifySession = async ({
level,
maxAge,
}: __experimental_SessionVerifyCreateParams): Promise<__experimental_SessionVerificationResource> => {
const json = (
await BaseResource._fetch({
method: 'POST',
path: `/me/sessions/${User.clerk.session?.id}/verify`,
body: {
level,
maxAge,
} as any,
})
)?.response as unknown as __experimental_SessionVerificationJSON;

return new SessionVerification(json);
};

__experimental_verifySessionPrepareFirstFactor = async (
factor: __experimental_SessionVerifyPrepareFirstFactorParams,
): Promise<__experimental_SessionVerificationResource> => {
let config;
switch (factor.strategy) {
case 'email_code':
config = { emailAddressId: factor.emailAddressId } as EmailCodeConfig;
break;
case 'phone_code':
config = {
phoneNumberId: factor.phoneNumberId,
default: factor.default,
} as PhoneCodeConfig;
break;
default:
clerkInvalidStrategy('User.verifySessionPrepareFirstFactor', (factor as any).strategy);
}

const json = (
await BaseResource._fetch({
method: 'POST',
path: `/me/sessions/${User.clerk.session?.id}/verify/prepare_first_factor`,
body: {
...config,
strategy: factor.strategy,
} as any,
})
)?.response as unknown as __experimental_SessionVerificationJSON;

return new SessionVerification(json);
};

__experimental_verifySessionAttemptFirstFactor = async (
attemptFactor: __experimental_SessionVerifyAttemptFirstFactorParams,
): Promise<__experimental_SessionVerificationResource> => {
const json = (
await BaseResource._fetch({
method: 'POST',
path: `/me/sessions/${User.clerk.session?.id}/verify/attempt_first_factor`,
body: { ...attemptFactor, strategy: attemptFactor.strategy } as any,
})
)?.response as unknown as __experimental_SessionVerificationJSON;

return new SessionVerification(json);
};

__experimental_verifySessionPrepareSecondFactor = async (
params: __experimental_SessionVerifyPrepareSecondFactorParams,
): Promise<__experimental_SessionVerificationResource> => {
const json = (
await BaseResource._fetch({
method: 'POST',
path: `/me/sessions/${User.clerk.session?.id}/verify/prepare_second_factor`,
body: params as any,
})
)?.response as unknown as __experimental_SessionVerificationJSON;

return new SessionVerification(json);
};

__experimental_verifySessionAttemptSecondFactor = async (
params: __experimental_SessionVerifyAttemptSecondFactorParams,
): Promise<__experimental_SessionVerificationResource> => {
const json = (
await BaseResource._fetch({
method: 'POST',
path: `/me/sessions/${User.clerk.session?.id}/verify/attempt_second_factor`,
body: params as any,
})
)?.response as unknown as __experimental_SessionVerificationJSON;

return new SessionVerification(json);
};

getSessions = async (): Promise<SessionWithActivities[]> => {
if (this.cachedSessionsWithActivities) {
return this.cachedSessionsWithActivities;
Expand Down
1 change: 1 addition & 0 deletions packages/types/src/index.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -39,6 +39,7 @@ export * from './role';
export * from './saml';
export * from './samlAccount';
export * from './session';
export * from './sessionVerification';
export * from './signIn';
export * from './signUp';
export * from './ssr';
Expand Down
15 changes: 15 additions & 0 deletions packages/types/src/json.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -12,6 +12,10 @@ import type { OrganizationSettingsJSON } from './organizationSettings';
import type { OrganizationSuggestionStatus } from './organizationSuggestion';
import type { SamlIdpSlug } from './saml';
import type { SessionStatus } from './session';
import type {
__experimental_SessionVerificationLevel,
__experimental_SessionVerificationStatus,
} from './sessionVerification';
import type { SignInFirstFactor, SignInJSON, SignInSecondFactor } from './signIn';
import type { SignUpField, SignUpIdentificationField, SignUpStatus } from './signUp';
import type { BoxShadow, Color, EmUnit, FontWeight, HexColor } from './theme';
Expand DownExpand Up@@ -112,6 +116,17 @@ export interface SessionJSON extends ClerkResourceJSON {
updated_at: number;
}

export interface __experimental_SessionVerificationJSON extends ClerkResourceJSON {
object: 'session_verification';
status: __experimental_SessionVerificationStatus;
first_factor_verification: VerificationJSON;
session: SessionJSON;
second_factor_verification: VerificationJSON;
level: __experimental_SessionVerificationLevel;
supported_first_factors: SignInFirstFactorJSON[];
supported_second_factors: SignInSecondFactorJSON[];
}

export interface EmailAddressJSON extends ClerkResourceJSON {
object: 'email_address';
email_address: string;
Expand Down
21 changes: 21 additions & 0 deletions packages/types/src/sessionVerification.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
import type { BackupCodeFactor, EmailCodeFactor, PasswordFactor, PhoneCodeFactor, TOTPFactor } from './factors';
import type { ClerkResource } from './resource';
import type { SessionResource } from './session';
import type { VerificationResource } from './verification';

export interface __experimental_SessionVerificationResource extends ClerkResource {
status: __experimental_SessionVerificationStatus | null;
level: __experimental_SessionVerificationLevel;
session: SessionResource;
firstFactorVerification: VerificationResource;
secondFactorVerification: VerificationResource;
supportedFirstFactors: __experimental_SessionVerificationFirstFactor[];
supportedSecondFactors: __experimental_SessionVerificationSecondFactor[];
}

export type __experimental_SessionVerificationStatus = 'needs_first_factor' | 'needs_second_factor' | 'complete';
export type __experimental_SessionVerificationLevel = 'L1.firstFactor' | 'L2.secondFactor' | 'L3.multiFactor';
export type __experimental_SessionVerificationMaxAge = 'A1.10min' | 'A2.1hr' | 'A3.4hr' | 'A4.1day' | 'A5.1wk';

export type __experimental_SessionVerificationFirstFactor = EmailCodeFactor | PhoneCodeFactor | PasswordFactor;
export type __experimental_SessionVerificationSecondFactor = PhoneCodeFactor | TOTPFactor | BackupCodeFactor;
44 changes: 44 additions & 0 deletions packages/types/src/user.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,6 +2,16 @@ import type { BackupCodeResource } from './backupCode';
import type { DeletedObjectResource } from './deletedObject';
import type { EmailAddressResource } from './emailAddress';
import type { ExternalAccountResource } from './externalAccount';
import type {
BackupCodeAttempt,
EmailCodeAttempt,
EmailCodeConfig,
PasswordAttempt,
PhoneCodeAttempt,
PhoneCodeConfig,
PhoneCodeSecondFactorConfig,
TOTPAttempt,
} from './factors';
import type { ImageResource } from './image';
import type { UserJSON } from './json';
import type { OAuthScope } from './oauth';
Expand All@@ -14,6 +24,11 @@ import type { PhoneNumberResource } from './phoneNumber';
import type { ClerkResource } from './resource';
import type { SamlAccountResource } from './samlAccount';
import type { SessionWithActivitiesResource } from './session';
import type {
__experimental_SessionVerificationLevel,
__experimental_SessionVerificationMaxAge,
__experimental_SessionVerificationResource,
} from './sessionVerification';
import type { OAuthStrategy } from './strategies';
import type { TOTPResource } from './totp';
import type { UserOrganizationInvitationResource } from './userOrganizationInvitation';
Expand DownExpand Up@@ -109,6 +124,21 @@ export interface UserResource extends ClerkResource {
verifyTOTP: (params: VerifyTOTPParams) => Promise<TOTPResource>;
disableTOTP: () => Promise<DeletedObjectResource>;
createBackupCode: () => Promise<BackupCodeResource>;
__experimental_verifySession: (
params: __experimental_SessionVerifyCreateParams,
) => Promise<__experimental_SessionVerificationResource>;
__experimental_verifySessionPrepareFirstFactor: (
factor: __experimental_SessionVerifyPrepareFirstFactorParams,
) => Promise<__experimental_SessionVerificationResource>;
__experimental_verifySessionAttemptFirstFactor: (
attemptFactor: __experimental_SessionVerifyAttemptFirstFactorParams,
) => Promise<__experimental_SessionVerificationResource>;
__experimental_verifySessionPrepareSecondFactor: (
params: __experimental_SessionVerifyPrepareSecondFactorParams,
) => Promise<__experimental_SessionVerificationResource>;
__experimental_verifySessionAttemptSecondFactor: (
params: __experimental_SessionVerifyAttemptSecondFactorParams,
) => Promise<__experimental_SessionVerificationResource>;

get verifiedExternalAccounts(): ExternalAccountResource[];

Expand All@@ -119,6 +149,20 @@ export interface UserResource extends ClerkResource {
get hasVerifiedPhoneNumber(): boolean;
}

export type __experimental_SessionVerifyCreateParams = {
level: __experimental_SessionVerificationLevel;
maxAge: __experimental_SessionVerificationMaxAge;
};

export type __experimental_SessionVerifyPrepareFirstFactorParams = EmailCodeConfig | PhoneCodeConfig;
export type __experimental_SessionVerifyAttemptFirstFactorParams =
| EmailCodeAttempt
| PhoneCodeAttempt
| PasswordAttempt;

export type __experimental_SessionVerifyPrepareSecondFactorParams = PhoneCodeSecondFactorConfig;
export type __experimental_SessionVerifyAttemptSecondFactorParams = PhoneCodeAttempt | TOTPAttempt | BackupCodeAttempt;

export type CreateEmailAddressParams = { email: string };
export type CreatePhoneNumberParams = { phoneNumber: string };
export type CreateWeb3WalletParams = { web3Wallet: string };
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(clerk-js,types): Expose SessionVerification as an experimental resource#4011

New issue

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

 Sign up for GitHub

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

Already on GitHub?
Sign in
to your account

 Merged

panteliselef
merged 3 commits into

from

Aug 26, 2024
 Merged


feat(clerk-js,types): Expose SessionVerification as an experimental resource
#4011
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
7fa85c9

feat(clerk-js,types): Expose `SessionVerification` as an experimental…


panteliselef Aug 23, 2024
20735d8

fix linting


panteliselef Aug 23, 2024
8585d40

Merge branch 'refs/heads/main' into elef/user-609-support-the-session…


panteliselef Aug 24, 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


12 changes: 12 additions & 0 deletions
.changeset/late-taxis-end.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
---
"@clerk/clerk-js": minor
"@clerk/types": minor
---

Expose `SessionVerification` as an experimental resource. 
Update `UserResource` with 5 new experimental methods:
- `experimental_verifySession` for creating a new SessionVerification record and initiating a new flow.
- `experimental_verifySessionPrepareFirstFactor` for preparing a supported first factor like `phone_code`
- `experimental_verifySessionAttemptFirstFactor` for attempting a supported first factor like `password`
- `experimental_verifySessionPrepareSecondFactor` for preparing a supported second factor like `phone_code`
- `experimental_verifySessionAttemptSecondFactor` for attempting a supported second factor like `totp`

46 changes: 46 additions & 0 deletions
packages/clerk-js/src/core/resources/SessionVerification.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
import { deepSnakeToCamel } from '@clerk/shared';
import type {
 __experimental_SessionVerificationFirstFactor,
 __experimental_SessionVerificationJSON,
 __experimental_SessionVerificationLevel,
 __experimental_SessionVerificationResource,
 __experimental_SessionVerificationSecondFactor,
 __experimental_SessionVerificationStatus,
 SessionResource,
 VerificationResource,
} from '@clerk/types';

import { BaseResource, Session, Verification } from './internal';

export class SessionVerification extends BaseResource implements __experimental_SessionVerificationResource {
 status!: __experimental_SessionVerificationStatus;
 level!: __experimental_SessionVerificationLevel;
 session!: SessionResource;
 supportedFirstFactors: __experimental_SessionVerificationFirstFactor[] = [];
 supportedSecondFactors: __experimental_SessionVerificationSecondFactor[] = [];
 firstFactorVerification: VerificationResource = new Verification(null);
 secondFactorVerification: VerificationResource = new Verification(null);

 constructor(data: __experimental_SessionVerificationJSON | null = null) {
 super();
 this.fromJSON(data);
 }

 protected fromJSON(data: __experimental_SessionVerificationJSON | null): this {
 if (data) {
 this.id = data.id;
 this.status = data.status;
 this.session = new Session(data.session);
 this.level = data.level;
 this.supportedFirstFactors = deepSnakeToCamel(
 data.supported_first_factors,
 ) as __experimental_SessionVerificationFirstFactor[];
 this.supportedSecondFactors = deepSnakeToCamel(
 data.supported_second_factors,
 ) as __experimental_SessionVerificationSecondFactor[];
 this.firstFactorVerification = new Verification(data.first_factor_verification);
 this.secondFactorVerification = new Verification(data.second_factor_verification);
 }
 return this;
 }
}

103 changes: 103 additions & 0 deletions
packages/clerk-js/src/core/resources/User.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,11 @@
import type {
 __experimental_SessionVerificationJSON,
 __experimental_SessionVerificationResource,
 __experimental_SessionVerifyAttemptFirstFactorParams,
 __experimental_SessionVerifyAttemptSecondFactorParams,
 __experimental_SessionVerifyCreateParams,
 __experimental_SessionVerifyPrepareFirstFactorParams,
 __experimental_SessionVerifyPrepareSecondFactorParams,
 BackupCodeJSON,
 BackupCodeResource,
 CreateEmailAddressParams,
Expand All@@ -8,6 +15,7 @@ import type {
 DeletedObjectJSON,
 DeletedObjectResource,
 EmailAddressResource,
 EmailCodeConfig,
 ExternalAccountJSON,
 ExternalAccountResource,
 GetOrganizationMemberships,
Expand All@@ -16,6 +24,7 @@ import type {
 ImageResource,
 OrganizationMembershipResource,
 PasskeyResource,
 PhoneCodeConfig,
 PhoneNumberResource,
 RemoveUserPasswordParams,
 SamlAccountResource,
Expand All@@ -33,6 +42,7 @@ import type {
import { unixEpochToDate } from '../../utils/date';
import { normalizeUnsafeMetadata } from '../../utils/resourceParams';
import { getFullName } from '../../utils/user';
import { clerkInvalidStrategy } from '../errors';
import { BackupCode } from './BackupCode';
import {
 BaseResource,
Expand All@@ -50,6 +60,7 @@ import {
 UserOrganizationInvitation,
 Web3Wallet,
} from './internal';
import { SessionVerification } from './SessionVerification';

export class User extends BaseResource implements UserResource {
 pathRoot = '/me';
Expand DownExpand Up@@ -239,6 +250,98 @@ export class User extends BaseResource implements UserResource {
 return this._baseDelete({ path: '/me' });
 };

 __experimental_verifySession = async ({
 level,
 maxAge,
 }: __experimental_SessionVerifyCreateParams): Promise<__experimental_SessionVerificationResource> => {
 const json = (
 await BaseResource._fetch({
 method: 'POST',
 path: `/me/sessions/${User.clerk.session?.id}/verify`,
 body: {
 level,
 maxAge,
 } as any,
 })
 )?.response as unknown as __experimental_SessionVerificationJSON;

 return new SessionVerification(json);
 };

 __experimental_verifySessionPrepareFirstFactor = async (
 factor: __experimental_SessionVerifyPrepareFirstFactorParams,
 ): Promise<__experimental_SessionVerificationResource> => {
 let config;
 switch (factor.strategy) {
 case 'email_code':
 config = { emailAddressId: factor.emailAddressId } as EmailCodeConfig;
 break;
 case 'phone_code':
 config = {
 phoneNumberId: factor.phoneNumberId,
 default: factor.default,
 } as PhoneCodeConfig;
 break;
 default:
 clerkInvalidStrategy('User.verifySessionPrepareFirstFactor', (factor as any).strategy);
 }

 const json = (
 await BaseResource._fetch({
 method: 'POST',
 path: `/me/sessions/${User.clerk.session?.id}/verify/prepare_first_factor`,
 body: {
 ...config,
 strategy: factor.strategy,
 } as any,
 })
 )?.response as unknown as __experimental_SessionVerificationJSON;

 return new SessionVerification(json);
 };

 __experimental_verifySessionAttemptFirstFactor = async (
 attemptFactor: __experimental_SessionVerifyAttemptFirstFactorParams,
 ): Promise<__experimental_SessionVerificationResource> => {
 const json = (
 await BaseResource._fetch({
 method: 'POST',
 path: `/me/sessions/${User.clerk.session?.id}/verify/attempt_first_factor`,
 body: { ...attemptFactor, strategy: attemptFactor.strategy } as any,
 })
 )?.response as unknown as __experimental_SessionVerificationJSON;

 return new SessionVerification(json);
 };

 __experimental_verifySessionPrepareSecondFactor = async (
 params: __experimental_SessionVerifyPrepareSecondFactorParams,
 ): Promise<__experimental_SessionVerificationResource> => {
 const json = (
 await BaseResource._fetch({
 method: 'POST',
 path: `/me/sessions/${User.clerk.session?.id}/verify/prepare_second_factor`,
 body: params as any,
 })
 )?.response as unknown as __experimental_SessionVerificationJSON;

 return new SessionVerification(json);
 };

 __experimental_verifySessionAttemptSecondFactor = async (
 params: __experimental_SessionVerifyAttemptSecondFactorParams,
 ): Promise<__experimental_SessionVerificationResource> => {
 const json = (
 await BaseResource._fetch({
 method: 'POST',
 path: `/me/sessions/${User.clerk.session?.id}/verify/attempt_second_factor`,
 body: params as any,
 })
 )?.response as unknown as __experimental_SessionVerificationJSON;

 return new SessionVerification(json);
 };

 getSessions = async (): Promise<SessionWithActivities[]> => {
 if (this.cachedSessionsWithActivities) {
 return this.cachedSessionsWithActivities;
Expand Down

1 change: 1 addition & 0 deletions
packages/types/src/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -39,6 +39,7 @@ export * from './role';
export * from './saml';
export * from './samlAccount';
export * from './session';
export * from './sessionVerification';
export * from './signIn';
export * from './signUp';
export * from './ssr';
Expand Down

15 changes: 15 additions & 0 deletions
packages/types/src/json.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -12,6 +12,10 @@ import type { OrganizationSettingsJSON } from './organizationSettings';
import type { OrganizationSuggestionStatus } from './organizationSuggestion';
import type { SamlIdpSlug } from './saml';
import type { SessionStatus } from './session';
import type {
 __experimental_SessionVerificationLevel,
 __experimental_SessionVerificationStatus,
} from './sessionVerification';
import type { SignInFirstFactor, SignInJSON, SignInSecondFactor } from './signIn';
import type { SignUpField, SignUpIdentificationField, SignUpStatus } from './signUp';
import type { BoxShadow, Color, EmUnit, FontWeight, HexColor } from './theme';
Expand DownExpand Up@@ -112,6 +116,17 @@ export interface SessionJSON extends ClerkResourceJSON {
 updated_at: number;
}

export interface __experimental_SessionVerificationJSON extends ClerkResourceJSON {
 object: 'session_verification';
 status: __experimental_SessionVerificationStatus;
 first_factor_verification: VerificationJSON;
 session: SessionJSON;
 second_factor_verification: VerificationJSON;
 level: __experimental_SessionVerificationLevel;
 supported_first_factors: SignInFirstFactorJSON[];
 supported_second_factors: SignInSecondFactorJSON[];
}

export interface EmailAddressJSON extends ClerkResourceJSON {
 object: 'email_address';
 email_address: string;
Expand Down

21 changes: 21 additions & 0 deletions
packages/types/src/sessionVerification.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
import type { BackupCodeFactor, EmailCodeFactor, PasswordFactor, PhoneCodeFactor, TOTPFactor } from './factors';
import type { ClerkResource } from './resource';
import type { SessionResource } from './session';
import type { VerificationResource } from './verification';

export interface __experimental_SessionVerificationResource extends ClerkResource {
 status: __experimental_SessionVerificationStatus | null;
 level: __experimental_SessionVerificationLevel;
 session: SessionResource;
 firstFactorVerification: VerificationResource;
 secondFactorVerification: VerificationResource;
 supportedFirstFactors: __experimental_SessionVerificationFirstFactor[];
 supportedSecondFactors: __experimental_SessionVerificationSecondFactor[];
}

export type __experimental_SessionVerificationStatus = 'needs_first_factor' | 'needs_second_factor' | 'complete';
export type __experimental_SessionVerificationLevel = 'L1.firstFactor' | 'L2.secondFactor' | 'L3.multiFactor';
export type __experimental_SessionVerificationMaxAge = 'A1.10min' | 'A2.1hr' | 'A3.4hr' | 'A4.1day' | 'A5.1wk';

export type __experimental_SessionVerificationFirstFactor = EmailCodeFactor | PhoneCodeFactor | PasswordFactor;
export type __experimental_SessionVerificationSecondFactor = PhoneCodeFactor | TOTPFactor | BackupCodeFactor;

44 changes: 44 additions & 0 deletions
packages/types/src/user.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,6 +2,16 @@ import type { BackupCodeResource } from './backupCode';
import type { DeletedObjectResource } from './deletedObject';
import type { EmailAddressResource } from './emailAddress';
import type { ExternalAccountResource } from './externalAccount';
import type {
 BackupCodeAttempt,
 EmailCodeAttempt,
 EmailCodeConfig,
 PasswordAttempt,
 PhoneCodeAttempt,
 PhoneCodeConfig,
 PhoneCodeSecondFactorConfig,
 TOTPAttempt,
} from './factors';
import type { ImageResource } from './image';
import type { UserJSON } from './json';
import type { OAuthScope } from './oauth';
Expand All@@ -14,6 +24,11 @@ import type { PhoneNumberResource } from './phoneNumber';
import type { ClerkResource } from './resource';
import type { SamlAccountResource } from './samlAccount';
import type { SessionWithActivitiesResource } from './session';
import type {
 __experimental_SessionVerificationLevel,
 __experimental_SessionVerificationMaxAge,
 __experimental_SessionVerificationResource,
} from './sessionVerification';
import type { OAuthStrategy } from './strategies';
import type { TOTPResource } from './totp';
import type { UserOrganizationInvitationResource } from './userOrganizationInvitation';
Expand DownExpand Up@@ -109,6 +124,21 @@ export interface UserResource extends ClerkResource {
 verifyTOTP: (params: VerifyTOTPParams) => Promise<TOTPResource>;
 disableTOTP: () => Promise<DeletedObjectResource>;
 createBackupCode: () => Promise<BackupCodeResource>;
 __experimental_verifySession: (
 params: __experimental_SessionVerifyCreateParams,
 ) => Promise<__experimental_SessionVerificationResource>;
 __experimental_verifySessionPrepareFirstFactor: (
 factor: __experimental_SessionVerifyPrepareFirstFactorParams,
 ) => Promise<__experimental_SessionVerificationResource>;
 __experimental_verifySessionAttemptFirstFactor: (
 attemptFactor: __experimental_SessionVerifyAttemptFirstFactorParams,
 ) => Promise<__experimental_SessionVerificationResource>;
 __experimental_verifySessionPrepareSecondFactor: (
 params: __experimental_SessionVerifyPrepareSecondFactorParams,
 ) => Promise<__experimental_SessionVerificationResource>;
 __experimental_verifySessionAttemptSecondFactor: (
 params: __experimental_SessionVerifyAttemptSecondFactorParams,
 ) => Promise<__experimental_SessionVerificationResource>;

 get verifiedExternalAccounts(): ExternalAccountResource[];

Expand All@@ -119,6 +149,20 @@ export interface UserResource extends ClerkResource {
 get hasVerifiedPhoneNumber(): boolean;
}

export type __experimental_SessionVerifyCreateParams = {
 level: __experimental_SessionVerificationLevel;
 maxAge: __experimental_SessionVerificationMaxAge;
};

export type __experimental_SessionVerifyPrepareFirstFactorParams = EmailCodeConfig | PhoneCodeConfig;
export type __experimental_SessionVerifyAttemptFirstFactorParams =
 | EmailCodeAttempt
 | PhoneCodeAttempt
 | PasswordAttempt;

export type __experimental_SessionVerifyPrepareSecondFactorParams = PhoneCodeSecondFactorConfig;
export type __experimental_SessionVerifyAttemptSecondFactorParams = PhoneCodeAttempt | TOTPAttempt | BackupCodeAttempt;

export type CreateEmailAddressParams = { email: string };
export type CreatePhoneNumberParams = { phoneNumber: string };
export type CreateWeb3WalletParams = { web3Wallet: string };
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(clerk-js,types): Expose SessionVerification as an experimental resource#4011

New issue

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

 Sign up for GitHub

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

Already on GitHub?
Sign in
to your account

 Merged

panteliselef
merged 3 commits into

from

Aug 26, 2024
 Merged


feat(clerk-js,types): Expose SessionVerification as an experimental resource
#4011
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
7fa85c9

feat(clerk-js,types): Expose `SessionVerification` as an experimental…


panteliselef Aug 23, 2024
20735d8

fix linting


panteliselef Aug 23, 2024
8585d40

Merge branch 'refs/heads/main' into elef/user-609-support-the-session…


panteliselef Aug 24, 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


12 changes: 12 additions & 0 deletions
.changeset/late-taxis-end.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
---
"@clerk/clerk-js": minor
"@clerk/types": minor
---

Expose `SessionVerification` as an experimental resource. 
Update `UserResource` with 5 new experimental methods:
- `experimental_verifySession` for creating a new SessionVerification record and initiating a new flow.
- `experimental_verifySessionPrepareFirstFactor` for preparing a supported first factor like `phone_code`
- `experimental_verifySessionAttemptFirstFactor` for attempting a supported first factor like `password`
- `experimental_verifySessionPrepareSecondFactor` for preparing a supported second factor like `phone_code`
- `experimental_verifySessionAttemptSecondFactor` for attempting a supported second factor like `totp`

46 changes: 46 additions & 0 deletions
packages/clerk-js/src/core/resources/SessionVerification.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
import { deepSnakeToCamel } from '@clerk/shared';
import type {
 __experimental_SessionVerificationFirstFactor,
 __experimental_SessionVerificationJSON,
 __experimental_SessionVerificationLevel,
 __experimental_SessionVerificationResource,
 __experimental_SessionVerificationSecondFactor,
 __experimental_SessionVerificationStatus,
 SessionResource,
 VerificationResource,
} from '@clerk/types';

import { BaseResource, Session, Verification } from './internal';

export class SessionVerification extends BaseResource implements __experimental_SessionVerificationResource {
 status!: __experimental_SessionVerificationStatus;
 level!: __experimental_SessionVerificationLevel;
 session!: SessionResource;
 supportedFirstFactors: __experimental_SessionVerificationFirstFactor[] = [];
 supportedSecondFactors: __experimental_SessionVerificationSecondFactor[] = [];
 firstFactorVerification: VerificationResource = new Verification(null);
 secondFactorVerification: VerificationResource = new Verification(null);

 constructor(data: __experimental_SessionVerificationJSON | null = null) {
 super();
 this.fromJSON(data);
 }

 protected fromJSON(data: __experimental_SessionVerificationJSON | null): this {
 if (data) {
 this.id = data.id;
 this.status = data.status;
 this.session = new Session(data.session);
 this.level = data.level;
 this.supportedFirstFactors = deepSnakeToCamel(
 data.supported_first_factors,
 ) as __experimental_SessionVerificationFirstFactor[];
 this.supportedSecondFactors = deepSnakeToCamel(
 data.supported_second_factors,
 ) as __experimental_SessionVerificationSecondFactor[];
 this.firstFactorVerification = new Verification(data.first_factor_verification);
 this.secondFactorVerification = new Verification(data.second_factor_verification);
 }
 return this;
 }
}

103 changes: 103 additions & 0 deletions
packages/clerk-js/src/core/resources/User.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,11 @@
import type {
 __experimental_SessionVerificationJSON,
 __experimental_SessionVerificationResource,
 __experimental_SessionVerifyAttemptFirstFactorParams,
 __experimental_SessionVerifyAttemptSecondFactorParams,
 __experimental_SessionVerifyCreateParams,
 __experimental_SessionVerifyPrepareFirstFactorParams,
 __experimental_SessionVerifyPrepareSecondFactorParams,
 BackupCodeJSON,
 BackupCodeResource,
 CreateEmailAddressParams,
Expand All@@ -8,6 +15,7 @@ import type {
 DeletedObjectJSON,
 DeletedObjectResource,
 EmailAddressResource,
 EmailCodeConfig,
 ExternalAccountJSON,
 ExternalAccountResource,
 GetOrganizationMemberships,
Expand All@@ -16,6 +24,7 @@ import type {
 ImageResource,
 OrganizationMembershipResource,
 PasskeyResource,
 PhoneCodeConfig,
 PhoneNumberResource,
 RemoveUserPasswordParams,
 SamlAccountResource,
Expand All@@ -33,6 +42,7 @@ import type {
import { unixEpochToDate } from '../../utils/date';
import { normalizeUnsafeMetadata } from '../../utils/resourceParams';
import { getFullName } from '../../utils/user';
import { clerkInvalidStrategy } from '../errors';
import { BackupCode } from './BackupCode';
import {
 BaseResource,
Expand All@@ -50,6 +60,7 @@ import {
 UserOrganizationInvitation,
 Web3Wallet,
} from './internal';
import { SessionVerification } from './SessionVerification';

export class User extends BaseResource implements UserResource {
 pathRoot = '/me';
Expand DownExpand Up@@ -239,6 +250,98 @@ export class User extends BaseResource implements UserResource {
 return this._baseDelete({ path: '/me' });
 };

 __experimental_verifySession = async ({
 level,
 maxAge,
 }: __experimental_SessionVerifyCreateParams): Promise<__experimental_SessionVerificationResource> => {
 const json = (
 await BaseResource._fetch({
 method: 'POST',
 path: `/me/sessions/${User.clerk.session?.id}/verify`,
 body: {
 level,
 maxAge,
 } as any,
 })
 )?.response as unknown as __experimental_SessionVerificationJSON;

 return new SessionVerification(json);
 };

 __experimental_verifySessionPrepareFirstFactor = async (
 factor: __experimental_SessionVerifyPrepareFirstFactorParams,
 ): Promise<__experimental_SessionVerificationResource> => {
 let config;
 switch (factor.strategy) {
 case 'email_code':
 config = { emailAddressId: factor.emailAddressId } as EmailCodeConfig;
 break;
 case 'phone_code':
 config = {
 phoneNumberId: factor.phoneNumberId,
 default: factor.default,
 } as PhoneCodeConfig;
 break;
 default:
 clerkInvalidStrategy('User.verifySessionPrepareFirstFactor', (factor as any).strategy);
 }

 const json = (
 await BaseResource._fetch({
 method: 'POST',
 path: `/me/sessions/${User.clerk.session?.id}/verify/prepare_first_factor`,
 body: {
 ...config,
 strategy: factor.strategy,
 } as any,
 })
 )?.response as unknown as __experimental_SessionVerificationJSON;

 return new SessionVerification(json);
 };

 __experimental_verifySessionAttemptFirstFactor = async (
 attemptFactor: __experimental_SessionVerifyAttemptFirstFactorParams,
 ): Promise<__experimental_SessionVerificationResource> => {
 const json = (
 await BaseResource._fetch({
 method: 'POST',
 path: `/me/sessions/${User.clerk.session?.id}/verify/attempt_first_factor`,
 body: { ...attemptFactor, strategy: attemptFactor.strategy } as any,
 })
 )?.response as unknown as __experimental_SessionVerificationJSON;

 return new SessionVerification(json);
 };

 __experimental_verifySessionPrepareSecondFactor = async (
 params: __experimental_SessionVerifyPrepareSecondFactorParams,
 ): Promise<__experimental_SessionVerificationResource> => {
 const json = (
 await BaseResource._fetch({
 method: 'POST',
 path: `/me/sessions/${User.clerk.session?.id}/verify/prepare_second_factor`,
 body: params as any,
 })
 )?.response as unknown as __experimental_SessionVerificationJSON;

 return new SessionVerification(json);
 };

 __experimental_verifySessionAttemptSecondFactor = async (
 params: __experimental_SessionVerifyAttemptSecondFactorParams,
 ): Promise<__experimental_SessionVerificationResource> => {
 const json = (
 await BaseResource._fetch({
 method: 'POST',
 path: `/me/sessions/${User.clerk.session?.id}/verify/attempt_second_factor`,
 body: params as any,
 })
 )?.response as unknown as __experimental_SessionVerificationJSON;

 return new SessionVerification(json);
 };

 getSessions = async (): Promise<SessionWithActivities[]> => {
 if (this.cachedSessionsWithActivities) {
 return this.cachedSessionsWithActivities;
Expand Down

1 change: 1 addition & 0 deletions
packages/types/src/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -39,6 +39,7 @@ export * from './role';
export * from './saml';
export * from './samlAccount';
export * from './session';
export * from './sessionVerification';
export * from './signIn';
export * from './signUp';
export * from './ssr';
Expand Down

15 changes: 15 additions & 0 deletions
packages/types/src/json.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -12,6 +12,10 @@ import type { OrganizationSettingsJSON } from './organizationSettings';
import type { OrganizationSuggestionStatus } from './organizationSuggestion';
import type { SamlIdpSlug } from './saml';
import type { SessionStatus } from './session';
import type {
 __experimental_SessionVerificationLevel,
 __experimental_SessionVerificationStatus,
} from './sessionVerification';
import type { SignInFirstFactor, SignInJSON, SignInSecondFactor } from './signIn';
import type { SignUpField, SignUpIdentificationField, SignUpStatus } from './signUp';
import type { BoxShadow, Color, EmUnit, FontWeight, HexColor } from './theme';
Expand DownExpand Up@@ -112,6 +116,17 @@ export interface SessionJSON extends ClerkResourceJSON {
 updated_at: number;
}

export interface __experimental_SessionVerificationJSON extends ClerkResourceJSON {
 object: 'session_verification';
 status: __experimental_SessionVerificationStatus;
 first_factor_verification: VerificationJSON;
 session: SessionJSON;
 second_factor_verification: VerificationJSON;
 level: __experimental_SessionVerificationLevel;
 supported_first_factors: SignInFirstFactorJSON[];
 supported_second_factors: SignInSecondFactorJSON[];
}

export interface EmailAddressJSON extends ClerkResourceJSON {
 object: 'email_address';
 email_address: string;
Expand Down

21 changes: 21 additions & 0 deletions
packages/types/src/sessionVerification.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
import type { BackupCodeFactor, EmailCodeFactor, PasswordFactor, PhoneCodeFactor, TOTPFactor } from './factors';
import type { ClerkResource } from './resource';
import type { SessionResource } from './session';
import type { VerificationResource } from './verification';

export interface __experimental_SessionVerificationResource extends ClerkResource {
 status: __experimental_SessionVerificationStatus | null;
 level: __experimental_SessionVerificationLevel;
 session: SessionResource;
 firstFactorVerification: VerificationResource;
 secondFactorVerification: VerificationResource;
 supportedFirstFactors: __experimental_SessionVerificationFirstFactor[];
 supportedSecondFactors: __experimental_SessionVerificationSecondFactor[];
}

export type __experimental_SessionVerificationStatus = 'needs_first_factor' | 'needs_second_factor' | 'complete';
export type __experimental_SessionVerificationLevel = 'L1.firstFactor' | 'L2.secondFactor' | 'L3.multiFactor';
export type __experimental_SessionVerificationMaxAge = 'A1.10min' | 'A2.1hr' | 'A3.4hr' | 'A4.1day' | 'A5.1wk';

export type __experimental_SessionVerificationFirstFactor = EmailCodeFactor | PhoneCodeFactor | PasswordFactor;
export type __experimental_SessionVerificationSecondFactor = PhoneCodeFactor | TOTPFactor | BackupCodeFactor;

44 changes: 44 additions & 0 deletions
packages/types/src/user.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,6 +2,16 @@ import type { BackupCodeResource } from './backupCode';
import type { DeletedObjectResource } from './deletedObject';
import type { EmailAddressResource } from './emailAddress';
import type { ExternalAccountResource } from './externalAccount';
import type {
 BackupCodeAttempt,
 EmailCodeAttempt,
 EmailCodeConfig,
 PasswordAttempt,
 PhoneCodeAttempt,
 PhoneCodeConfig,
 PhoneCodeSecondFactorConfig,
 TOTPAttempt,
} from './factors';
import type { ImageResource } from './image';
import type { UserJSON } from './json';
import type { OAuthScope } from './oauth';
Expand All@@ -14,6 +24,11 @@ import type { PhoneNumberResource } from './phoneNumber';
import type { ClerkResource } from './resource';
import type { SamlAccountResource } from './samlAccount';
import type { SessionWithActivitiesResource } from './session';
import type {
 __experimental_SessionVerificationLevel,
 __experimental_SessionVerificationMaxAge,
 __experimental_SessionVerificationResource,
} from './sessionVerification';
import type { OAuthStrategy } from './strategies';
import type { TOTPResource } from './totp';
import type { UserOrganizationInvitationResource } from './userOrganizationInvitation';
Expand DownExpand Up@@ -109,6 +124,21 @@ export interface UserResource extends ClerkResource {
 verifyTOTP: (params: VerifyTOTPParams) => Promise<TOTPResource>;
 disableTOTP: () => Promise<DeletedObjectResource>;
 createBackupCode: () => Promise<BackupCodeResource>;
 __experimental_verifySession: (
 params: __experimental_SessionVerifyCreateParams,
 ) => Promise<__experimental_SessionVerificationResource>;
 __experimental_verifySessionPrepareFirstFactor: (
 factor: __experimental_SessionVerifyPrepareFirstFactorParams,
 ) => Promise<__experimental_SessionVerificationResource>;
 __experimental_verifySessionAttemptFirstFactor: (
 attemptFactor: __experimental_SessionVerifyAttemptFirstFactorParams,
 ) => Promise<__experimental_SessionVerificationResource>;
 __experimental_verifySessionPrepareSecondFactor: (
 params: __experimental_SessionVerifyPrepareSecondFactorParams,
 ) => Promise<__experimental_SessionVerificationResource>;
 __experimental_verifySessionAttemptSecondFactor: (
 params: __experimental_SessionVerifyAttemptSecondFactorParams,
 ) => Promise<__experimental_SessionVerificationResource>;

 get verifiedExternalAccounts(): ExternalAccountResource[];

Expand All@@ -119,6 +149,20 @@ export interface UserResource extends ClerkResource {
 get hasVerifiedPhoneNumber(): boolean;
}

export type __experimental_SessionVerifyCreateParams = {
 level: __experimental_SessionVerificationLevel;
 maxAge: __experimental_SessionVerificationMaxAge;
};

export type __experimental_SessionVerifyPrepareFirstFactorParams = EmailCodeConfig | PhoneCodeConfig;
export type __experimental_SessionVerifyAttemptFirstFactorParams =
 | EmailCodeAttempt
 | PhoneCodeAttempt
 | PasswordAttempt;

export type __experimental_SessionVerifyPrepareSecondFactorParams = PhoneCodeSecondFactorConfig;
export type __experimental_SessionVerifyAttemptSecondFactorParams = PhoneCodeAttempt | TOTPAttempt | BackupCodeAttempt;

export type CreateEmailAddressParams = { email: string };
export type CreatePhoneNumberParams = { phoneNumber: string };
export type CreateWeb3WalletParams = { web3Wallet: string };
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(clerk-js,types): Expose SessionVerification as an experimental resource#4011

New issue

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

 Sign up for GitHub

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

Already on GitHub?
Sign in
to your account

 Merged

panteliselef
merged 3 commits into

from

Aug 26, 2024
 Merged


feat(clerk-js,types): Expose SessionVerification as an experimental resource
#4011
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
7fa85c9

feat(clerk-js,types): Expose `SessionVerification` as an experimental…


panteliselef Aug 23, 2024
20735d8

fix linting


panteliselef Aug 23, 2024
8585d40

Merge branch 'refs/heads/main' into elef/user-609-support-the-session…


panteliselef Aug 24, 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


12 changes: 12 additions & 0 deletions
.changeset/late-taxis-end.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
---
"@clerk/clerk-js": minor
"@clerk/types": minor
---

Expose `SessionVerification` as an experimental resource. 
Update `UserResource` with 5 new experimental methods:
- `experimental_verifySession` for creating a new SessionVerification record and initiating a new flow.
- `experimental_verifySessionPrepareFirstFactor` for preparing a supported first factor like `phone_code`
- `experimental_verifySessionAttemptFirstFactor` for attempting a supported first factor like `password`
- `experimental_verifySessionPrepareSecondFactor` for preparing a supported second factor like `phone_code`
- `experimental_verifySessionAttemptSecondFactor` for attempting a supported second factor like `totp`

46 changes: 46 additions & 0 deletions
packages/clerk-js/src/core/resources/SessionVerification.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
import { deepSnakeToCamel } from '@clerk/shared';
import type {
 __experimental_SessionVerificationFirstFactor,
 __experimental_SessionVerificationJSON,
 __experimental_SessionVerificationLevel,
 __experimental_SessionVerificationResource,
 __experimental_SessionVerificationSecondFactor,
 __experimental_SessionVerificationStatus,
 SessionResource,
 VerificationResource,
} from '@clerk/types';

import { BaseResource, Session, Verification } from './internal';

export class SessionVerification extends BaseResource implements __experimental_SessionVerificationResource {
 status!: __experimental_SessionVerificationStatus;
 level!: __experimental_SessionVerificationLevel;
 session!: SessionResource;
 supportedFirstFactors: __experimental_SessionVerificationFirstFactor[] = [];
 supportedSecondFactors: __experimental_SessionVerificationSecondFactor[] = [];
 firstFactorVerification: VerificationResource = new Verification(null);
 secondFactorVerification: VerificationResource = new Verification(null);

 constructor(data: __experimental_SessionVerificationJSON | null = null) {
 super();
 this.fromJSON(data);
 }

 protected fromJSON(data: __experimental_SessionVerificationJSON | null): this {
 if (data) {
 this.id = data.id;
 this.status = data.status;
 this.session = new Session(data.session);
 this.level = data.level;
 this.supportedFirstFactors = deepSnakeToCamel(
 data.supported_first_factors,
 ) as __experimental_SessionVerificationFirstFactor[];
 this.supportedSecondFactors = deepSnakeToCamel(
 data.supported_second_factors,
 ) as __experimental_SessionVerificationSecondFactor[];
 this.firstFactorVerification = new Verification(data.first_factor_verification);
 this.secondFactorVerification = new Verification(data.second_factor_verification);
 }
 return this;
 }
}

103 changes: 103 additions & 0 deletions
packages/clerk-js/src/core/resources/User.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,11 @@
import type {
 __experimental_SessionVerificationJSON,
 __experimental_SessionVerificationResource,
 __experimental_SessionVerifyAttemptFirstFactorParams,
 __experimental_SessionVerifyAttemptSecondFactorParams,
 __experimental_SessionVerifyCreateParams,
 __experimental_SessionVerifyPrepareFirstFactorParams,
 __experimental_SessionVerifyPrepareSecondFactorParams,
 BackupCodeJSON,
 BackupCodeResource,
 CreateEmailAddressParams,
Expand All@@ -8,6 +15,7 @@ import type {
 DeletedObjectJSON,
 DeletedObjectResource,
 EmailAddressResource,
 EmailCodeConfig,
 ExternalAccountJSON,
 ExternalAccountResource,
 GetOrganizationMemberships,
Expand All@@ -16,6 +24,7 @@ import type {
 ImageResource,
 OrganizationMembershipResource,
 PasskeyResource,
 PhoneCodeConfig,
 PhoneNumberResource,
 RemoveUserPasswordParams,
 SamlAccountResource,
Expand All@@ -33,6 +42,7 @@ import type {
import { unixEpochToDate } from '../../utils/date';
import { normalizeUnsafeMetadata } from '../../utils/resourceParams';
import { getFullName } from '../../utils/user';
import { clerkInvalidStrategy } from '../errors';
import { BackupCode } from './BackupCode';
import {
 BaseResource,
Expand All@@ -50,6 +60,7 @@ import {
 UserOrganizationInvitation,
 Web3Wallet,
} from './internal';
import { SessionVerification } from './SessionVerification';

export class User extends BaseResource implements UserResource {
 pathRoot = '/me';
Expand DownExpand Up@@ -239,6 +250,98 @@ export class User extends BaseResource implements UserResource {
 return this._baseDelete({ path: '/me' });
 };

 __experimental_verifySession = async ({
 level,
 maxAge,
 }: __experimental_SessionVerifyCreateParams): Promise<__experimental_SessionVerificationResource> => {
 const json = (
 await BaseResource._fetch({
 method: 'POST',
 path: `/me/sessions/${User.clerk.session?.id}/verify`,
 body: {
 level,
 maxAge,
 } as any,
 })
 )?.response as unknown as __experimental_SessionVerificationJSON;

 return new SessionVerification(json);
 };

 __experimental_verifySessionPrepareFirstFactor = async (
 factor: __experimental_SessionVerifyPrepareFirstFactorParams,
 ): Promise<__experimental_SessionVerificationResource> => {
 let config;
 switch (factor.strategy) {
 case 'email_code':
 config = { emailAddressId: factor.emailAddressId } as EmailCodeConfig;
 break;
 case 'phone_code':
 config = {
 phoneNumberId: factor.phoneNumberId,
 default: factor.default,
 } as PhoneCodeConfig;
 break;
 default:
 clerkInvalidStrategy('User.verifySessionPrepareFirstFactor', (factor as any).strategy);
 }

 const json = (
 await BaseResource._fetch({
 method: 'POST',
 path: `/me/sessions/${User.clerk.session?.id}/verify/prepare_first_factor`,
 body: {
 ...config,
 strategy: factor.strategy,
 } as any,
 })
 )?.response as unknown as __experimental_SessionVerificationJSON;

 return new SessionVerification(json);
 };

 __experimental_verifySessionAttemptFirstFactor = async (
 attemptFactor: __experimental_SessionVerifyAttemptFirstFactorParams,
 ): Promise<__experimental_SessionVerificationResource> => {
 const json = (
 await BaseResource._fetch({
 method: 'POST',
 path: `/me/sessions/${User.clerk.session?.id}/verify/attempt_first_factor`,
 body: { ...attemptFactor, strategy: attemptFactor.strategy } as any,
 })
 )?.response as unknown as __experimental_SessionVerificationJSON;

 return new SessionVerification(json);
 };

 __experimental_verifySessionPrepareSecondFactor = async (
 params: __experimental_SessionVerifyPrepareSecondFactorParams,
 ): Promise<__experimental_SessionVerificationResource> => {
 const json = (
 await BaseResource._fetch({
 method: 'POST',
 path: `/me/sessions/${User.clerk.session?.id}/verify/prepare_second_factor`,
 body: params as any,
 })
 )?.response as unknown as __experimental_SessionVerificationJSON;

 return new SessionVerification(json);
 };

 __experimental_verifySessionAttemptSecondFactor = async (
 params: __experimental_SessionVerifyAttemptSecondFactorParams,
 ): Promise<__experimental_SessionVerificationResource> => {
 const json = (
 await BaseResource._fetch({
 method: 'POST',
 path: `/me/sessions/${User.clerk.session?.id}/verify/attempt_second_factor`,
 body: params as any,
 })
 )?.response as unknown as __experimental_SessionVerificationJSON;

 return new SessionVerification(json);
 };

 getSessions = async (): Promise<SessionWithActivities[]> => {
 if (this.cachedSessionsWithActivities) {
 return this.cachedSessionsWithActivities;
Expand Down

1 change: 1 addition & 0 deletions
packages/types/src/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -39,6 +39,7 @@ export * from './role';
export * from './saml';
export * from './samlAccount';
export * from './session';
export * from './sessionVerification';
export * from './signIn';
export * from './signUp';
export * from './ssr';
Expand Down

15 changes: 15 additions & 0 deletions
packages/types/src/json.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -12,6 +12,10 @@ import type { OrganizationSettingsJSON } from './organizationSettings';
import type { OrganizationSuggestionStatus } from './organizationSuggestion';
import type { SamlIdpSlug } from './saml';
import type { SessionStatus } from './session';
import type {
 __experimental_SessionVerificationLevel,
 __experimental_SessionVerificationStatus,
} from './sessionVerification';
import type { SignInFirstFactor, SignInJSON, SignInSecondFactor } from './signIn';
import type { SignUpField, SignUpIdentificationField, SignUpStatus } from './signUp';
import type { BoxShadow, Color, EmUnit, FontWeight, HexColor } from './theme';
Expand DownExpand Up@@ -112,6 +116,17 @@ export interface SessionJSON extends ClerkResourceJSON {
 updated_at: number;
}

export interface __experimental_SessionVerificationJSON extends ClerkResourceJSON {
 object: 'session_verification';
 status: __experimental_SessionVerificationStatus;
 first_factor_verification: VerificationJSON;
 session: SessionJSON;
 second_factor_verification: VerificationJSON;
 level: __experimental_SessionVerificationLevel;
 supported_first_factors: SignInFirstFactorJSON[];
 supported_second_factors: SignInSecondFactorJSON[];
}

export interface EmailAddressJSON extends ClerkResourceJSON {
 object: 'email_address';
 email_address: string;
Expand Down

21 changes: 21 additions & 0 deletions
packages/types/src/sessionVerification.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
import type { BackupCodeFactor, EmailCodeFactor, PasswordFactor, PhoneCodeFactor, TOTPFactor } from './factors';
import type { ClerkResource } from './resource';
import type { SessionResource } from './session';
import type { VerificationResource } from './verification';

export interface __experimental_SessionVerificationResource extends ClerkResource {
 status: __experimental_SessionVerificationStatus | null;
 level: __experimental_SessionVerificationLevel;
 session: SessionResource;
 firstFactorVerification: VerificationResource;
 secondFactorVerification: VerificationResource;
 supportedFirstFactors: __experimental_SessionVerificationFirstFactor[];
 supportedSecondFactors: __experimental_SessionVerificationSecondFactor[];
}

export type __experimental_SessionVerificationStatus = 'needs_first_factor' | 'needs_second_factor' | 'complete';
export type __experimental_SessionVerificationLevel = 'L1.firstFactor' | 'L2.secondFactor' | 'L3.multiFactor';
export type __experimental_SessionVerificationMaxAge = 'A1.10min' | 'A2.1hr' | 'A3.4hr' | 'A4.1day' | 'A5.1wk';

export type __experimental_SessionVerificationFirstFactor = EmailCodeFactor | PhoneCodeFactor | PasswordFactor;
export type __experimental_SessionVerificationSecondFactor = PhoneCodeFactor | TOTPFactor | BackupCodeFactor;

44 changes: 44 additions & 0 deletions
packages/types/src/user.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,6 +2,16 @@ import type { BackupCodeResource } from './backupCode';
import type { DeletedObjectResource } from './deletedObject';
import type { EmailAddressResource } from './emailAddress';
import type { ExternalAccountResource } from './externalAccount';
import type {
 BackupCodeAttempt,
 EmailCodeAttempt,
 EmailCodeConfig,
 PasswordAttempt,
 PhoneCodeAttempt,
 PhoneCodeConfig,
 PhoneCodeSecondFactorConfig,
 TOTPAttempt,
} from './factors';
import type { ImageResource } from './image';
import type { UserJSON } from './json';
import type { OAuthScope } from './oauth';
Expand All@@ -14,6 +24,11 @@ import type { PhoneNumberResource } from './phoneNumber';
import type { ClerkResource } from './resource';
import type { SamlAccountResource } from './samlAccount';
import type { SessionWithActivitiesResource } from './session';
import type {
 __experimental_SessionVerificationLevel,
 __experimental_SessionVerificationMaxAge,
 __experimental_SessionVerificationResource,
} from './sessionVerification';
import type { OAuthStrategy } from './strategies';
import type { TOTPResource } from './totp';
import type { UserOrganizationInvitationResource } from './userOrganizationInvitation';
Expand DownExpand Up@@ -109,6 +124,21 @@ export interface UserResource extends ClerkResource {
 verifyTOTP: (params: VerifyTOTPParams) => Promise<TOTPResource>;
 disableTOTP: () => Promise<DeletedObjectResource>;
 createBackupCode: () => Promise<BackupCodeResource>;
 __experimental_verifySession: (
 params: __experimental_SessionVerifyCreateParams,
 ) => Promise<__experimental_SessionVerificationResource>;
 __experimental_verifySessionPrepareFirstFactor: (
 factor: __experimental_SessionVerifyPrepareFirstFactorParams,
 ) => Promise<__experimental_SessionVerificationResource>;
 __experimental_verifySessionAttemptFirstFactor: (
 attemptFactor: __experimental_SessionVerifyAttemptFirstFactorParams,
 ) => Promise<__experimental_SessionVerificationResource>;
 __experimental_verifySessionPrepareSecondFactor: (
 params: __experimental_SessionVerifyPrepareSecondFactorParams,
 ) => Promise<__experimental_SessionVerificationResource>;
 __experimental_verifySessionAttemptSecondFactor: (
 params: __experimental_SessionVerifyAttemptSecondFactorParams,
 ) => Promise<__experimental_SessionVerificationResource>;

 get verifiedExternalAccounts(): ExternalAccountResource[];

Expand All@@ -119,6 +149,20 @@ export interface UserResource extends ClerkResource {
 get hasVerifiedPhoneNumber(): boolean;
}

export type __experimental_SessionVerifyCreateParams = {
 level: __experimental_SessionVerificationLevel;
 maxAge: __experimental_SessionVerificationMaxAge;
};

export type __experimental_SessionVerifyPrepareFirstFactorParams = EmailCodeConfig | PhoneCodeConfig;
export type __experimental_SessionVerifyAttemptFirstFactorParams =
 | EmailCodeAttempt
 | PhoneCodeAttempt
 | PasswordAttempt;

export type __experimental_SessionVerifyPrepareSecondFactorParams = PhoneCodeSecondFactorConfig;
export type __experimental_SessionVerifyAttemptSecondFactorParams = PhoneCodeAttempt | TOTPAttempt | BackupCodeAttempt;

export type CreateEmailAddressParams = { email: string };
export type CreatePhoneNumberParams = { phoneNumber: string };
export type CreateWeb3WalletParams = { web3Wallet: string };
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(clerk-js,types): Expose SessionVerification as an experimental resource#4011

New issue

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

 Sign up for GitHub

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

Already on GitHub?
Sign in
to your account

 Merged

panteliselef
merged 3 commits into

from

Aug 26, 2024
 Merged


feat(clerk-js,types): Expose SessionVerification as an experimental resource
#4011
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
7fa85c9

feat(clerk-js,types): Expose `SessionVerification` as an experimental…


panteliselef Aug 23, 2024
20735d8

fix linting


panteliselef Aug 23, 2024
8585d40

Merge branch 'refs/heads/main' into elef/user-609-support-the-session…


panteliselef Aug 24, 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


12 changes: 12 additions & 0 deletions
.changeset/late-taxis-end.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
---
"@clerk/clerk-js": minor
"@clerk/types": minor
---

Expose `SessionVerification` as an experimental resource. 
Update `UserResource` with 5 new experimental methods:
- `experimental_verifySession` for creating a new SessionVerification record and initiating a new flow.
- `experimental_verifySessionPrepareFirstFactor` for preparing a supported first factor like `phone_code`
- `experimental_verifySessionAttemptFirstFactor` for attempting a supported first factor like `password`
- `experimental_verifySessionPrepareSecondFactor` for preparing a supported second factor like `phone_code`
- `experimental_verifySessionAttemptSecondFactor` for attempting a supported second factor like `totp`

46 changes: 46 additions & 0 deletions
packages/clerk-js/src/core/resources/SessionVerification.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
import { deepSnakeToCamel } from '@clerk/shared';
import type {
 __experimental_SessionVerificationFirstFactor,
 __experimental_SessionVerificationJSON,
 __experimental_SessionVerificationLevel,
 __experimental_SessionVerificationResource,
 __experimental_SessionVerificationSecondFactor,
 __experimental_SessionVerificationStatus,
 SessionResource,
 VerificationResource,
} from '@clerk/types';

import { BaseResource, Session, Verification } from './internal';

export class SessionVerification extends BaseResource implements __experimental_SessionVerificationResource {
 status!: __experimental_SessionVerificationStatus;
 level!: __experimental_SessionVerificationLevel;
 session!: SessionResource;
 supportedFirstFactors: __experimental_SessionVerificationFirstFactor[] = [];
 supportedSecondFactors: __experimental_SessionVerificationSecondFactor[] = [];
 firstFactorVerification: VerificationResource = new Verification(null);
 secondFactorVerification: VerificationResource = new Verification(null);

 constructor(data: __experimental_SessionVerificationJSON | null = null) {
 super();
 this.fromJSON(data);
 }

 protected fromJSON(data: __experimental_SessionVerificationJSON | null): this {
 if (data) {
 this.id = data.id;
 this.status = data.status;
 this.session = new Session(data.session);
 this.level = data.level;
 this.supportedFirstFactors = deepSnakeToCamel(
 data.supported_first_factors,
 ) as __experimental_SessionVerificationFirstFactor[];
 this.supportedSecondFactors = deepSnakeToCamel(
 data.supported_second_factors,
 ) as __experimental_SessionVerificationSecondFactor[];
 this.firstFactorVerification = new Verification(data.first_factor_verification);
 this.secondFactorVerification = new Verification(data.second_factor_verification);
 }
 return this;
 }
}

103 changes: 103 additions & 0 deletions
packages/clerk-js/src/core/resources/User.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,11 @@
import type {
 __experimental_SessionVerificationJSON,
 __experimental_SessionVerificationResource,
 __experimental_SessionVerifyAttemptFirstFactorParams,
 __experimental_SessionVerifyAttemptSecondFactorParams,
 __experimental_SessionVerifyCreateParams,
 __experimental_SessionVerifyPrepareFirstFactorParams,
 __experimental_SessionVerifyPrepareSecondFactorParams,
 BackupCodeJSON,
 BackupCodeResource,
 CreateEmailAddressParams,
Expand All@@ -8,6 +15,7 @@ import type {
 DeletedObjectJSON,
 DeletedObjectResource,
 EmailAddressResource,
 EmailCodeConfig,
 ExternalAccountJSON,
 ExternalAccountResource,
 GetOrganizationMemberships,
Expand All@@ -16,6 +24,7 @@ import type {
 ImageResource,
 OrganizationMembershipResource,
 PasskeyResource,
 PhoneCodeConfig,
 PhoneNumberResource,
 RemoveUserPasswordParams,
 SamlAccountResource,
Expand All@@ -33,6 +42,7 @@ import type {
import { unixEpochToDate } from '../../utils/date';
import { normalizeUnsafeMetadata } from '../../utils/resourceParams';
import { getFullName } from '../../utils/user';
import { clerkInvalidStrategy } from '../errors';
import { BackupCode } from './BackupCode';
import {
 BaseResource,
Expand All@@ -50,6 +60,7 @@ import {
 UserOrganizationInvitation,
 Web3Wallet,
} from './internal';
import { SessionVerification } from './SessionVerification';

export class User extends BaseResource implements UserResource {
 pathRoot = '/me';
Expand DownExpand Up@@ -239,6 +250,98 @@ export class User extends BaseResource implements UserResource {
 return this._baseDelete({ path: '/me' });
 };

 __experimental_verifySession = async ({
 level,
 maxAge,
 }: __experimental_SessionVerifyCreateParams): Promise<__experimental_SessionVerificationResource> => {
 const json = (
 await BaseResource._fetch({
 method: 'POST',
 path: `/me/sessions/${User.clerk.session?.id}/verify`,
 body: {
 level,
 maxAge,
 } as any,
 })
 )?.response as unknown as __experimental_SessionVerificationJSON;

 return new SessionVerification(json);
 };

 __experimental_verifySessionPrepareFirstFactor = async (
 factor: __experimental_SessionVerifyPrepareFirstFactorParams,
 ): Promise<__experimental_SessionVerificationResource> => {
 let config;
 switch (factor.strategy) {
 case 'email_code':
 config = { emailAddressId: factor.emailAddressId } as EmailCodeConfig;
 break;
 case 'phone_code':
 config = {
 phoneNumberId: factor.phoneNumberId,
 default: factor.default,
 } as PhoneCodeConfig;
 break;
 default:
 clerkInvalidStrategy('User.verifySessionPrepareFirstFactor', (factor as any).strategy);
 }

 const json = (
 await BaseResource._fetch({
 method: 'POST',
 path: `/me/sessions/${User.clerk.session?.id}/verify/prepare_first_factor`,
 body: {
 ...config,
 strategy: factor.strategy,
 } as any,
 })
 )?.response as unknown as __experimental_SessionVerificationJSON;

 return new SessionVerification(json);
 };

 __experimental_verifySessionAttemptFirstFactor = async (
 attemptFactor: __experimental_SessionVerifyAttemptFirstFactorParams,
 ): Promise<__experimental_SessionVerificationResource> => {
 const json = (
 await BaseResource._fetch({
 method: 'POST',
 path: `/me/sessions/${User.clerk.session?.id}/verify/attempt_first_factor`,
 body: { ...attemptFactor, strategy: attemptFactor.strategy } as any,
 })
 )?.response as unknown as __experimental_SessionVerificationJSON;

 return new SessionVerification(json);
 };

 __experimental_verifySessionPrepareSecondFactor = async (
 params: __experimental_SessionVerifyPrepareSecondFactorParams,
 ): Promise<__experimental_SessionVerificationResource> => {
 const json = (
 await BaseResource._fetch({
 method: 'POST',
 path: `/me/sessions/${User.clerk.session?.id}/verify/prepare_second_factor`,
 body: params as any,
 })
 )?.response as unknown as __experimental_SessionVerificationJSON;

 return new SessionVerification(json);
 };

 __experimental_verifySessionAttemptSecondFactor = async (
 params: __experimental_SessionVerifyAttemptSecondFactorParams,
 ): Promise<__experimental_SessionVerificationResource> => {
 const json = (
 await BaseResource._fetch({
 method: 'POST',
 path: `/me/sessions/${User.clerk.session?.id}/verify/attempt_second_factor`,
 body: params as any,
 })
 )?.response as unknown as __experimental_SessionVerificationJSON;

 return new SessionVerification(json);
 };

 getSessions = async (): Promise<SessionWithActivities[]> => {
 if (this.cachedSessionsWithActivities) {
 return this.cachedSessionsWithActivities;
Expand Down

1 change: 1 addition & 0 deletions
packages/types/src/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -39,6 +39,7 @@ export * from './role';
export * from './saml';
export * from './samlAccount';
export * from './session';
export * from './sessionVerification';
export * from './signIn';
export * from './signUp';
export * from './ssr';
Expand Down

15 changes: 15 additions & 0 deletions
packages/types/src/json.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -12,6 +12,10 @@ import type { OrganizationSettingsJSON } from './organizationSettings';
import type { OrganizationSuggestionStatus } from './organizationSuggestion';
import type { SamlIdpSlug } from './saml';
import type { SessionStatus } from './session';
import type {
 __experimental_SessionVerificationLevel,
 __experimental_SessionVerificationStatus,
} from './sessionVerification';
import type { SignInFirstFactor, SignInJSON, SignInSecondFactor } from './signIn';
import type { SignUpField, SignUpIdentificationField, SignUpStatus } from './signUp';
import type { BoxShadow, Color, EmUnit, FontWeight, HexColor } from './theme';
Expand DownExpand Up@@ -112,6 +116,17 @@ export interface SessionJSON extends ClerkResourceJSON {
 updated_at: number;
}

export interface __experimental_SessionVerificationJSON extends ClerkResourceJSON {
 object: 'session_verification';
 status: __experimental_SessionVerificationStatus;
 first_factor_verification: VerificationJSON;
 session: SessionJSON;
 second_factor_verification: VerificationJSON;
 level: __experimental_SessionVerificationLevel;
 supported_first_factors: SignInFirstFactorJSON[];
 supported_second_factors: SignInSecondFactorJSON[];
}

export interface EmailAddressJSON extends ClerkResourceJSON {
 object: 'email_address';
 email_address: string;
Expand Down

21 changes: 21 additions & 0 deletions
packages/types/src/sessionVerification.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
import type { BackupCodeFactor, EmailCodeFactor, PasswordFactor, PhoneCodeFactor, TOTPFactor } from './factors';
import type { ClerkResource } from './resource';
import type { SessionResource } from './session';
import type { VerificationResource } from './verification';

export interface __experimental_SessionVerificationResource extends ClerkResource {
 status: __experimental_SessionVerificationStatus | null;
 level: __experimental_SessionVerificationLevel;
 session: SessionResource;
 firstFactorVerification: VerificationResource;
 secondFactorVerification: VerificationResource;
 supportedFirstFactors: __experimental_SessionVerificationFirstFactor[];
 supportedSecondFactors: __experimental_SessionVerificationSecondFactor[];
}

export type __experimental_SessionVerificationStatus = 'needs_first_factor' | 'needs_second_factor' | 'complete';
export type __experimental_SessionVerificationLevel = 'L1.firstFactor' | 'L2.secondFactor' | 'L3.multiFactor';
export type __experimental_SessionVerificationMaxAge = 'A1.10min' | 'A2.1hr' | 'A3.4hr' | 'A4.1day' | 'A5.1wk';

export type __experimental_SessionVerificationFirstFactor = EmailCodeFactor | PhoneCodeFactor | PasswordFactor;
export type __experimental_SessionVerificationSecondFactor = PhoneCodeFactor | TOTPFactor | BackupCodeFactor;

44 changes: 44 additions & 0 deletions
packages/types/src/user.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,6 +2,16 @@ import type { BackupCodeResource } from './backupCode';
import type { DeletedObjectResource } from './deletedObject';
import type { EmailAddressResource } from './emailAddress';
import type { ExternalAccountResource } from './externalAccount';
import type {
 BackupCodeAttempt,
 EmailCodeAttempt,
 EmailCodeConfig,
 PasswordAttempt,
 PhoneCodeAttempt,
 PhoneCodeConfig,
 PhoneCodeSecondFactorConfig,
 TOTPAttempt,
} from './factors';
import type { ImageResource } from './image';
import type { UserJSON } from './json';
import type { OAuthScope } from './oauth';
Expand All@@ -14,6 +24,11 @@ import type { PhoneNumberResource } from './phoneNumber';
import type { ClerkResource } from './resource';
import type { SamlAccountResource } from './samlAccount';
import type { SessionWithActivitiesResource } from './session';
import type {
 __experimental_SessionVerificationLevel,
 __experimental_SessionVerificationMaxAge,
 __experimental_SessionVerificationResource,
} from './sessionVerification';
import type { OAuthStrategy } from './strategies';
import type { TOTPResource } from './totp';
import type { UserOrganizationInvitationResource } from './userOrganizationInvitation';
Expand DownExpand Up@@ -109,6 +124,21 @@ export interface UserResource extends ClerkResource {
 verifyTOTP: (params: VerifyTOTPParams) => Promise<TOTPResource>;
 disableTOTP: () => Promise<DeletedObjectResource>;
 createBackupCode: () => Promise<BackupCodeResource>;
 __experimental_verifySession: (
 params: __experimental_SessionVerifyCreateParams,
 ) => Promise<__experimental_SessionVerificationResource>;
 __experimental_verifySessionPrepareFirstFactor: (
 factor: __experimental_SessionVerifyPrepareFirstFactorParams,
 ) => Promise<__experimental_SessionVerificationResource>;
 __experimental_verifySessionAttemptFirstFactor: (
 attemptFactor: __experimental_SessionVerifyAttemptFirstFactorParams,
 ) => Promise<__experimental_SessionVerificationResource>;
 __experimental_verifySessionPrepareSecondFactor: (
 params: __experimental_SessionVerifyPrepareSecondFactorParams,
 ) => Promise<__experimental_SessionVerificationResource>;
 __experimental_verifySessionAttemptSecondFactor: (
 params: __experimental_SessionVerifyAttemptSecondFactorParams,
 ) => Promise<__experimental_SessionVerificationResource>;

 get verifiedExternalAccounts(): ExternalAccountResource[];

Expand All@@ -119,6 +149,20 @@ export interface UserResource extends ClerkResource {
 get hasVerifiedPhoneNumber(): boolean;
}

export type __experimental_SessionVerifyCreateParams = {
 level: __experimental_SessionVerificationLevel;
 maxAge: __experimental_SessionVerificationMaxAge;
};

export type __experimental_SessionVerifyPrepareFirstFactorParams = EmailCodeConfig | PhoneCodeConfig;
export type __experimental_SessionVerifyAttemptFirstFactorParams =
 | EmailCodeAttempt
 | PhoneCodeAttempt
 | PasswordAttempt;

export type __experimental_SessionVerifyPrepareSecondFactorParams = PhoneCodeSecondFactorConfig;
export type __experimental_SessionVerifyAttemptSecondFactorParams = PhoneCodeAttempt | TOTPAttempt | BackupCodeAttempt;

export type CreateEmailAddressParams = { email: string };
export type CreatePhoneNumberParams = { phoneNumber: string };
export type CreateWeb3WalletParams = { web3Wallet: string };
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(clerk-js,types): Expose SessionVerification as an experimental resource#4011

New issue

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

 Sign up for GitHub

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

Already on GitHub?
Sign in
to your account

 Merged

panteliselef
merged 3 commits into

from

Aug 26, 2024
 Merged


feat(clerk-js,types): Expose SessionVerification as an experimental resource
#4011
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
7fa85c9

feat(clerk-js,types): Expose `SessionVerification` as an experimental…


panteliselef Aug 23, 2024
20735d8

fix linting


panteliselef Aug 23, 2024
8585d40

Merge branch 'refs/heads/main' into elef/user-609-support-the-session…


panteliselef Aug 24, 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


12 changes: 12 additions & 0 deletions
.changeset/late-taxis-end.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
---
"@clerk/clerk-js": minor
"@clerk/types": minor
---

Expose `SessionVerification` as an experimental resource. 
Update `UserResource` with 5 new experimental methods:
- `experimental_verifySession` for creating a new SessionVerification record and initiating a new flow.
- `experimental_verifySessionPrepareFirstFactor` for preparing a supported first factor like `phone_code`
- `experimental_verifySessionAttemptFirstFactor` for attempting a supported first factor like `password`
- `experimental_verifySessionPrepareSecondFactor` for preparing a supported second factor like `phone_code`
- `experimental_verifySessionAttemptSecondFactor` for attempting a supported second factor like `totp`

46 changes: 46 additions & 0 deletions
packages/clerk-js/src/core/resources/SessionVerification.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
import { deepSnakeToCamel } from '@clerk/shared';
import type {
 __experimental_SessionVerificationFirstFactor,
 __experimental_SessionVerificationJSON,
 __experimental_SessionVerificationLevel,
 __experimental_SessionVerificationResource,
 __experimental_SessionVerificationSecondFactor,
 __experimental_SessionVerificationStatus,
 SessionResource,
 VerificationResource,
} from '@clerk/types';

import { BaseResource, Session, Verification } from './internal';

export class SessionVerification extends BaseResource implements __experimental_SessionVerificationResource {
 status!: __experimental_SessionVerificationStatus;
 level!: __experimental_SessionVerificationLevel;
 session!: SessionResource;
 supportedFirstFactors: __experimental_SessionVerificationFirstFactor[] = [];
 supportedSecondFactors: __experimental_SessionVerificationSecondFactor[] = [];
 firstFactorVerification: VerificationResource = new Verification(null);
 secondFactorVerification: VerificationResource = new Verification(null);

 constructor(data: __experimental_SessionVerificationJSON | null = null) {
 super();
 this.fromJSON(data);
 }

 protected fromJSON(data: __experimental_SessionVerificationJSON | null): this {
 if (data) {
 this.id = data.id;
 this.status = data.status;
 this.session = new Session(data.session);
 this.level = data.level;
 this.supportedFirstFactors = deepSnakeToCamel(
 data.supported_first_factors,
 ) as __experimental_SessionVerificationFirstFactor[];
 this.supportedSecondFactors = deepSnakeToCamel(
 data.supported_second_factors,
 ) as __experimental_SessionVerificationSecondFactor[];
 this.firstFactorVerification = new Verification(data.first_factor_verification);
 this.secondFactorVerification = new Verification(data.second_factor_verification);
 }
 return this;
 }
}

103 changes: 103 additions & 0 deletions
packages/clerk-js/src/core/resources/User.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,11 @@
import type {
 __experimental_SessionVerificationJSON,
 __experimental_SessionVerificationResource,
 __experimental_SessionVerifyAttemptFirstFactorParams,
 __experimental_SessionVerifyAttemptSecondFactorParams,
 __experimental_SessionVerifyCreateParams,
 __experimental_SessionVerifyPrepareFirstFactorParams,
 __experimental_SessionVerifyPrepareSecondFactorParams,
 BackupCodeJSON,
 BackupCodeResource,
 CreateEmailAddressParams,
Expand All@@ -8,6 +15,7 @@ import type {
 DeletedObjectJSON,
 DeletedObjectResource,
 EmailAddressResource,
 EmailCodeConfig,
 ExternalAccountJSON,
 ExternalAccountResource,
 GetOrganizationMemberships,
Expand All@@ -16,6 +24,7 @@ import type {
 ImageResource,
 OrganizationMembershipResource,
 PasskeyResource,
 PhoneCodeConfig,
 PhoneNumberResource,
 RemoveUserPasswordParams,
 SamlAccountResource,
Expand All@@ -33,6 +42,7 @@ import type {
import { unixEpochToDate } from '../../utils/date';
import { normalizeUnsafeMetadata } from '../../utils/resourceParams';
import { getFullName } from '../../utils/user';
import { clerkInvalidStrategy } from '../errors';
import { BackupCode } from './BackupCode';
import {
 BaseResource,
Expand All@@ -50,6 +60,7 @@ import {
 UserOrganizationInvitation,
 Web3Wallet,
} from './internal';
import { SessionVerification } from './SessionVerification';

export class User extends BaseResource implements UserResource {
 pathRoot = '/me';
Expand DownExpand Up@@ -239,6 +250,98 @@ export class User extends BaseResource implements UserResource {
 return this._baseDelete({ path: '/me' });
 };

 __experimental_verifySession = async ({
 level,
 maxAge,
 }: __experimental_SessionVerifyCreateParams): Promise<__experimental_SessionVerificationResource> => {
 const json = (
 await BaseResource._fetch({
 method: 'POST',
 path: `/me/sessions/${User.clerk.session?.id}/verify`,
 body: {
 level,
 maxAge,
 } as any,
 })
 )?.response as unknown as __experimental_SessionVerificationJSON;

 return new SessionVerification(json);
 };

 __experimental_verifySessionPrepareFirstFactor = async (
 factor: __experimental_SessionVerifyPrepareFirstFactorParams,
 ): Promise<__experimental_SessionVerificationResource> => {
 let config;
 switch (factor.strategy) {
 case 'email_code':
 config = { emailAddressId: factor.emailAddressId } as EmailCodeConfig;
 break;
 case 'phone_code':
 config = {
 phoneNumberId: factor.phoneNumberId,
 default: factor.default,
 } as PhoneCodeConfig;
 break;
 default:
 clerkInvalidStrategy('User.verifySessionPrepareFirstFactor', (factor as any).strategy);
 }

 const json = (
 await BaseResource._fetch({
 method: 'POST',
 path: `/me/sessions/${User.clerk.session?.id}/verify/prepare_first_factor`,
 body: {
 ...config,
 strategy: factor.strategy,
 } as any,
 })
 )?.response as unknown as __experimental_SessionVerificationJSON;

 return new SessionVerification(json);
 };

 __experimental_verifySessionAttemptFirstFactor = async (
 attemptFactor: __experimental_SessionVerifyAttemptFirstFactorParams,
 ): Promise<__experimental_SessionVerificationResource> => {
 const json = (
 await BaseResource._fetch({
 method: 'POST',
 path: `/me/sessions/${User.clerk.session?.id}/verify/attempt_first_factor`,
 body: { ...attemptFactor, strategy: attemptFactor.strategy } as any,
 })
 )?.response as unknown as __experimental_SessionVerificationJSON;

 return new SessionVerification(json);
 };

 __experimental_verifySessionPrepareSecondFactor = async (
 params: __experimental_SessionVerifyPrepareSecondFactorParams,
 ): Promise<__experimental_SessionVerificationResource> => {
 const json = (
 await BaseResource._fetch({
 method: 'POST',
 path: `/me/sessions/${User.clerk.session?.id}/verify/prepare_second_factor`,
 body: params as any,
 })
 )?.response as unknown as __experimental_SessionVerificationJSON;

 return new SessionVerification(json);
 };

 __experimental_verifySessionAttemptSecondFactor = async (
 params: __experimental_SessionVerifyAttemptSecondFactorParams,
 ): Promise<__experimental_SessionVerificationResource> => {
 const json = (
 await BaseResource._fetch({
 method: 'POST',
 path: `/me/sessions/${User.clerk.session?.id}/verify/attempt_second_factor`,
 body: params as any,
 })
 )?.response as unknown as __experimental_SessionVerificationJSON;

 return new SessionVerification(json);
 };

 getSessions = async (): Promise<SessionWithActivities[]> => {
 if (this.cachedSessionsWithActivities) {
 return this.cachedSessionsWithActivities;
Expand Down

1 change: 1 addition & 0 deletions
packages/types/src/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -39,6 +39,7 @@ export * from './role';
export * from './saml';
export * from './samlAccount';
export * from './session';
export * from './sessionVerification';
export * from './signIn';
export * from './signUp';
export * from './ssr';
Expand Down

15 changes: 15 additions & 0 deletions
packages/types/src/json.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -12,6 +12,10 @@ import type { OrganizationSettingsJSON } from './organizationSettings';
import type { OrganizationSuggestionStatus } from './organizationSuggestion';
import type { SamlIdpSlug } from './saml';
import type { SessionStatus } from './session';
import type {
 __experimental_SessionVerificationLevel,
 __experimental_SessionVerificationStatus,
} from './sessionVerification';
import type { SignInFirstFactor, SignInJSON, SignInSecondFactor } from './signIn';
import type { SignUpField, SignUpIdentificationField, SignUpStatus } from './signUp';
import type { BoxShadow, Color, EmUnit, FontWeight, HexColor } from './theme';
Expand DownExpand Up@@ -112,6 +116,17 @@ export interface SessionJSON extends ClerkResourceJSON {
 updated_at: number;
}

export interface __experimental_SessionVerificationJSON extends ClerkResourceJSON {
 object: 'session_verification';
 status: __experimental_SessionVerificationStatus;
 first_factor_verification: VerificationJSON;
 session: SessionJSON;
 second_factor_verification: VerificationJSON;
 level: __experimental_SessionVerificationLevel;
 supported_first_factors: SignInFirstFactorJSON[];
 supported_second_factors: SignInSecondFactorJSON[];
}

export interface EmailAddressJSON extends ClerkResourceJSON {
 object: 'email_address';
 email_address: string;
Expand Down

21 changes: 21 additions & 0 deletions
packages/types/src/sessionVerification.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
import type { BackupCodeFactor, EmailCodeFactor, PasswordFactor, PhoneCodeFactor, TOTPFactor } from './factors';
import type { ClerkResource } from './resource';
import type { SessionResource } from './session';
import type { VerificationResource } from './verification';

export interface __experimental_SessionVerificationResource extends ClerkResource {
 status: __experimental_SessionVerificationStatus | null;
 level: __experimental_SessionVerificationLevel;
 session: SessionResource;
 firstFactorVerification: VerificationResource;
 secondFactorVerification: VerificationResource;
 supportedFirstFactors: __experimental_SessionVerificationFirstFactor[];
 supportedSecondFactors: __experimental_SessionVerificationSecondFactor[];
}

export type __experimental_SessionVerificationStatus = 'needs_first_factor' | 'needs_second_factor' | 'complete';
export type __experimental_SessionVerificationLevel = 'L1.firstFactor' | 'L2.secondFactor' | 'L3.multiFactor';
export type __experimental_SessionVerificationMaxAge = 'A1.10min' | 'A2.1hr' | 'A3.4hr' | 'A4.1day' | 'A5.1wk';

export type __experimental_SessionVerificationFirstFactor = EmailCodeFactor | PhoneCodeFactor | PasswordFactor;
export type __experimental_SessionVerificationSecondFactor = PhoneCodeFactor | TOTPFactor | BackupCodeFactor;

44 changes: 44 additions & 0 deletions
packages/types/src/user.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,6 +2,16 @@ import type { BackupCodeResource } from './backupCode';
import type { DeletedObjectResource } from './deletedObject';
import type { EmailAddressResource } from './emailAddress';
import type { ExternalAccountResource } from './externalAccount';
import type {
 BackupCodeAttempt,
 EmailCodeAttempt,
 EmailCodeConfig,
 PasswordAttempt,
 PhoneCodeAttempt,
 PhoneCodeConfig,
 PhoneCodeSecondFactorConfig,
 TOTPAttempt,
} from './factors';
import type { ImageResource } from './image';
import type { UserJSON } from './json';
import type { OAuthScope } from './oauth';
Expand All@@ -14,6 +24,11 @@ import type { PhoneNumberResource } from './phoneNumber';
import type { ClerkResource } from './resource';
import type { SamlAccountResource } from './samlAccount';
import type { SessionWithActivitiesResource } from './session';
import type {
 __experimental_SessionVerificationLevel,
 __experimental_SessionVerificationMaxAge,
 __experimental_SessionVerificationResource,
} from './sessionVerification';
import type { OAuthStrategy } from './strategies';
import type { TOTPResource } from './totp';
import type { UserOrganizationInvitationResource } from './userOrganizationInvitation';
Expand DownExpand Up@@ -109,6 +124,21 @@ export interface UserResource extends ClerkResource {
 verifyTOTP: (params: VerifyTOTPParams) => Promise<TOTPResource>;
 disableTOTP: () => Promise<DeletedObjectResource>;
 createBackupCode: () => Promise<BackupCodeResource>;
 __experimental_verifySession: (
 params: __experimental_SessionVerifyCreateParams,
 ) => Promise<__experimental_SessionVerificationResource>;
 __experimental_verifySessionPrepareFirstFactor: (
 factor: __experimental_SessionVerifyPrepareFirstFactorParams,
 ) => Promise<__experimental_SessionVerificationResource>;
 __experimental_verifySessionAttemptFirstFactor: (
 attemptFactor: __experimental_SessionVerifyAttemptFirstFactorParams,
 ) => Promise<__experimental_SessionVerificationResource>;
 __experimental_verifySessionPrepareSecondFactor: (
 params: __experimental_SessionVerifyPrepareSecondFactorParams,
 ) => Promise<__experimental_SessionVerificationResource>;
 __experimental_verifySessionAttemptSecondFactor: (
 params: __experimental_SessionVerifyAttemptSecondFactorParams,
 ) => Promise<__experimental_SessionVerificationResource>;

 get verifiedExternalAccounts(): ExternalAccountResource[];

Expand All@@ -119,6 +149,20 @@ export interface UserResource extends ClerkResource {
 get hasVerifiedPhoneNumber(): boolean;
}

export type __experimental_SessionVerifyCreateParams = {
 level: __experimental_SessionVerificationLevel;
 maxAge: __experimental_SessionVerificationMaxAge;
};

export type __experimental_SessionVerifyPrepareFirstFactorParams = EmailCodeConfig | PhoneCodeConfig;
export type __experimental_SessionVerifyAttemptFirstFactorParams =
 | EmailCodeAttempt
 | PhoneCodeAttempt
 | PasswordAttempt;

export type __experimental_SessionVerifyPrepareSecondFactorParams = PhoneCodeSecondFactorConfig;
export type __experimental_SessionVerifyAttemptSecondFactorParams = PhoneCodeAttempt | TOTPAttempt | BackupCodeAttempt;

export type CreateEmailAddressParams = { email: string };
export type CreatePhoneNumberParams = { phoneNumber: string };
export type CreateWeb3WalletParams = { web3Wallet: string };
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(clerk-js,types): Expose SessionVerification as an experimental resource#4011

New issue

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

 Sign up for GitHub

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

Already on GitHub?
Sign in
to your account

 Merged

panteliselef
merged 3 commits into

from

Aug 26, 2024
 Merged


feat(clerk-js,types): Expose SessionVerification as an experimental resource
#4011
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
7fa85c9

feat(clerk-js,types): Expose `SessionVerification` as an experimental…


panteliselef Aug 23, 2024
20735d8

fix linting


panteliselef Aug 23, 2024
8585d40

Merge branch 'refs/heads/main' into elef/user-609-support-the-session…


panteliselef Aug 24, 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


12 changes: 12 additions & 0 deletions
.changeset/late-taxis-end.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
---
"@clerk/clerk-js": minor
"@clerk/types": minor
---

Expose `SessionVerification` as an experimental resource. 
Update `UserResource` with 5 new experimental methods:
- `experimental_verifySession` for creating a new SessionVerification record and initiating a new flow.
- `experimental_verifySessionPrepareFirstFactor` for preparing a supported first factor like `phone_code`
- `experimental_verifySessionAttemptFirstFactor` for attempting a supported first factor like `password`
- `experimental_verifySessionPrepareSecondFactor` for preparing a supported second factor like `phone_code`
- `experimental_verifySessionAttemptSecondFactor` for attempting a supported second factor like `totp`

46 changes: 46 additions & 0 deletions
packages/clerk-js/src/core/resources/SessionVerification.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
import { deepSnakeToCamel } from '@clerk/shared';
import type {
 __experimental_SessionVerificationFirstFactor,
 __experimental_SessionVerificationJSON,
 __experimental_SessionVerificationLevel,
 __experimental_SessionVerificationResource,
 __experimental_SessionVerificationSecondFactor,
 __experimental_SessionVerificationStatus,
 SessionResource,
 VerificationResource,
} from '@clerk/types';

import { BaseResource, Session, Verification } from './internal';

export class SessionVerification extends BaseResource implements __experimental_SessionVerificationResource {
 status!: __experimental_SessionVerificationStatus;
 level!: __experimental_SessionVerificationLevel;
 session!: SessionResource;
 supportedFirstFactors: __experimental_SessionVerificationFirstFactor[] = [];
 supportedSecondFactors: __experimental_SessionVerificationSecondFactor[] = [];
 firstFactorVerification: VerificationResource = new Verification(null);
 secondFactorVerification: VerificationResource = new Verification(null);

 constructor(data: __experimental_SessionVerificationJSON | null = null) {
 super();
 this.fromJSON(data);
 }

 protected fromJSON(data: __experimental_SessionVerificationJSON | null): this {
 if (data) {
 this.id = data.id;
 this.status = data.status;
 this.session = new Session(data.session);
 this.level = data.level;
 this.supportedFirstFactors = deepSnakeToCamel(
 data.supported_first_factors,
 ) as __experimental_SessionVerificationFirstFactor[];
 this.supportedSecondFactors = deepSnakeToCamel(
 data.supported_second_factors,
 ) as __experimental_SessionVerificationSecondFactor[];
 this.firstFactorVerification = new Verification(data.first_factor_verification);
 this.secondFactorVerification = new Verification(data.second_factor_verification);
 }
 return this;
 }
}

103 changes: 103 additions & 0 deletions
packages/clerk-js/src/core/resources/User.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,11 @@
import type {
 __experimental_SessionVerificationJSON,
 __experimental_SessionVerificationResource,
 __experimental_SessionVerifyAttemptFirstFactorParams,
 __experimental_SessionVerifyAttemptSecondFactorParams,
 __experimental_SessionVerifyCreateParams,
 __experimental_SessionVerifyPrepareFirstFactorParams,
 __experimental_SessionVerifyPrepareSecondFactorParams,
 BackupCodeJSON,
 BackupCodeResource,
 CreateEmailAddressParams,
Expand All@@ -8,6 +15,7 @@ import type {
 DeletedObjectJSON,
 DeletedObjectResource,
 EmailAddressResource,
 EmailCodeConfig,
 ExternalAccountJSON,
 ExternalAccountResource,
 GetOrganizationMemberships,
Expand All@@ -16,6 +24,7 @@ import type {
 ImageResource,
 OrganizationMembershipResource,
 PasskeyResource,
 PhoneCodeConfig,
 PhoneNumberResource,
 RemoveUserPasswordParams,
 SamlAccountResource,
Expand All@@ -33,6 +42,7 @@ import type {
import { unixEpochToDate } from '../../utils/date';
import { normalizeUnsafeMetadata } from '../../utils/resourceParams';
import { getFullName } from '../../utils/user';
import { clerkInvalidStrategy } from '../errors';
import { BackupCode } from './BackupCode';
import {
 BaseResource,
Expand All@@ -50,6 +60,7 @@ import {
 UserOrganizationInvitation,
 Web3Wallet,
} from './internal';
import { SessionVerification } from './SessionVerification';

export class User extends BaseResource implements UserResource {
 pathRoot = '/me';
Expand DownExpand Up@@ -239,6 +250,98 @@ export class User extends BaseResource implements UserResource {
 return this._baseDelete({ path: '/me' });
 };

 __experimental_verifySession = async ({
 level,
 maxAge,
 }: __experimental_SessionVerifyCreateParams): Promise<__experimental_SessionVerificationResource> => {
 const json = (
 await BaseResource._fetch({
 method: 'POST',
 path: `/me/sessions/${User.clerk.session?.id}/verify`,
 body: {
 level,
 maxAge,
 } as any,
 })
 )?.response as unknown as __experimental_SessionVerificationJSON;

 return new SessionVerification(json);
 };

 __experimental_verifySessionPrepareFirstFactor = async (
 factor: __experimental_SessionVerifyPrepareFirstFactorParams,
 ): Promise<__experimental_SessionVerificationResource> => {
 let config;
 switch (factor.strategy) {
 case 'email_code':
 config = { emailAddressId: factor.emailAddressId } as EmailCodeConfig;
 break;
 case 'phone_code':
 config = {
 phoneNumberId: factor.phoneNumberId,
 default: factor.default,
 } as PhoneCodeConfig;
 break;
 default:
 clerkInvalidStrategy('User.verifySessionPrepareFirstFactor', (factor as any).strategy);
 }

 const json = (
 await BaseResource._fetch({
 method: 'POST',
 path: `/me/sessions/${User.clerk.session?.id}/verify/prepare_first_factor`,
 body: {
 ...config,
 strategy: factor.strategy,
 } as any,
 })
 )?.response as unknown as __experimental_SessionVerificationJSON;

 return new SessionVerification(json);
 };

 __experimental_verifySessionAttemptFirstFactor = async (
 attemptFactor: __experimental_SessionVerifyAttemptFirstFactorParams,
 ): Promise<__experimental_SessionVerificationResource> => {
 const json = (
 await BaseResource._fetch({
 method: 'POST',
 path: `/me/sessions/${User.clerk.session?.id}/verify/attempt_first_factor`,
 body: { ...attemptFactor, strategy: attemptFactor.strategy } as any,
 })
 )?.response as unknown as __experimental_SessionVerificationJSON;

 return new SessionVerification(json);
 };

 __experimental_verifySessionPrepareSecondFactor = async (
 params: __experimental_SessionVerifyPrepareSecondFactorParams,
 ): Promise<__experimental_SessionVerificationResource> => {
 const json = (
 await BaseResource._fetch({
 method: 'POST',
 path: `/me/sessions/${User.clerk.session?.id}/verify/prepare_second_factor`,
 body: params as any,
 })
 )?.response as unknown as __experimental_SessionVerificationJSON;

 return new SessionVerification(json);
 };

 __experimental_verifySessionAttemptSecondFactor = async (
 params: __experimental_SessionVerifyAttemptSecondFactorParams,
 ): Promise<__experimental_SessionVerificationResource> => {
 const json = (
 await BaseResource._fetch({
 method: 'POST',
 path: `/me/sessions/${User.clerk.session?.id}/verify/attempt_second_factor`,
 body: params as any,
 })
 )?.response as unknown as __experimental_SessionVerificationJSON;

 return new SessionVerification(json);
 };

 getSessions = async (): Promise<SessionWithActivities[]> => {
 if (this.cachedSessionsWithActivities) {
 return this.cachedSessionsWithActivities;
Expand Down

1 change: 1 addition & 0 deletions
packages/types/src/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -39,6 +39,7 @@ export * from './role';
export * from './saml';
export * from './samlAccount';
export * from './session';
export * from './sessionVerification';
export * from './signIn';
export * from './signUp';
export * from './ssr';
Expand Down

15 changes: 15 additions & 0 deletions
packages/types/src/json.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -12,6 +12,10 @@ import type { OrganizationSettingsJSON } from './organizationSettings';
import type { OrganizationSuggestionStatus } from './organizationSuggestion';
import type { SamlIdpSlug } from './saml';
import type { SessionStatus } from './session';
import type {
 __experimental_SessionVerificationLevel,
 __experimental_SessionVerificationStatus,
} from './sessionVerification';
import type { SignInFirstFactor, SignInJSON, SignInSecondFactor } from './signIn';
import type { SignUpField, SignUpIdentificationField, SignUpStatus } from './signUp';
import type { BoxShadow, Color, EmUnit, FontWeight, HexColor } from './theme';
Expand DownExpand Up@@ -112,6 +116,17 @@ export interface SessionJSON extends ClerkResourceJSON {
 updated_at: number;
}

export interface __experimental_SessionVerificationJSON extends ClerkResourceJSON {
 object: 'session_verification';
 status: __experimental_SessionVerificationStatus;
 first_factor_verification: VerificationJSON;
 session: SessionJSON;
 second_factor_verification: VerificationJSON;
 level: __experimental_SessionVerificationLevel;
 supported_first_factors: SignInFirstFactorJSON[];
 supported_second_factors: SignInSecondFactorJSON[];
}

export interface EmailAddressJSON extends ClerkResourceJSON {
 object: 'email_address';
 email_address: string;
Expand Down

21 changes: 21 additions & 0 deletions
packages/types/src/sessionVerification.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
import type { BackupCodeFactor, EmailCodeFactor, PasswordFactor, PhoneCodeFactor, TOTPFactor } from './factors';
import type { ClerkResource } from './resource';
import type { SessionResource } from './session';
import type { VerificationResource } from './verification';

export interface __experimental_SessionVerificationResource extends ClerkResource {
 status: __experimental_SessionVerificationStatus | null;
 level: __experimental_SessionVerificationLevel;
 session: SessionResource;
 firstFactorVerification: VerificationResource;
 secondFactorVerification: VerificationResource;
 supportedFirstFactors: __experimental_SessionVerificationFirstFactor[];
 supportedSecondFactors: __experimental_SessionVerificationSecondFactor[];
}

export type __experimental_SessionVerificationStatus = 'needs_first_factor' | 'needs_second_factor' | 'complete';
export type __experimental_SessionVerificationLevel = 'L1.firstFactor' | 'L2.secondFactor' | 'L3.multiFactor';
export type __experimental_SessionVerificationMaxAge = 'A1.10min' | 'A2.1hr' | 'A3.4hr' | 'A4.1day' | 'A5.1wk';

export type __experimental_SessionVerificationFirstFactor = EmailCodeFactor | PhoneCodeFactor | PasswordFactor;
export type __experimental_SessionVerificationSecondFactor = PhoneCodeFactor | TOTPFactor | BackupCodeFactor;

44 changes: 44 additions & 0 deletions
packages/types/src/user.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,6 +2,16 @@ import type { BackupCodeResource } from './backupCode';
import type { DeletedObjectResource } from './deletedObject';
import type { EmailAddressResource } from './emailAddress';
import type { ExternalAccountResource } from './externalAccount';
import type {
 BackupCodeAttempt,
 EmailCodeAttempt,
 EmailCodeConfig,
 PasswordAttempt,
 PhoneCodeAttempt,
 PhoneCodeConfig,
 PhoneCodeSecondFactorConfig,
 TOTPAttempt,
} from './factors';
import type { ImageResource } from './image';
import type { UserJSON } from './json';
import type { OAuthScope } from './oauth';
Expand All@@ -14,6 +24,11 @@ import type { PhoneNumberResource } from './phoneNumber';
import type { ClerkResource } from './resource';
import type { SamlAccountResource } from './samlAccount';
import type { SessionWithActivitiesResource } from './session';
import type {
 __experimental_SessionVerificationLevel,
 __experimental_SessionVerificationMaxAge,
 __experimental_SessionVerificationResource,
} from './sessionVerification';
import type { OAuthStrategy } from './strategies';
import type { TOTPResource } from './totp';
import type { UserOrganizationInvitationResource } from './userOrganizationInvitation';
Expand DownExpand Up@@ -109,6 +124,21 @@ export interface UserResource extends ClerkResource {
 verifyTOTP: (params: VerifyTOTPParams) => Promise<TOTPResource>;
 disableTOTP: () => Promise<DeletedObjectResource>;
 createBackupCode: () => Promise<BackupCodeResource>;
 __experimental_verifySession: (
 params: __experimental_SessionVerifyCreateParams,
 ) => Promise<__experimental_SessionVerificationResource>;
 __experimental_verifySessionPrepareFirstFactor: (
 factor: __experimental_SessionVerifyPrepareFirstFactorParams,
 ) => Promise<__experimental_SessionVerificationResource>;
 __experimental_verifySessionAttemptFirstFactor: (
 attemptFactor: __experimental_SessionVerifyAttemptFirstFactorParams,
 ) => Promise<__experimental_SessionVerificationResource>;
 __experimental_verifySessionPrepareSecondFactor: (
 params: __experimental_SessionVerifyPrepareSecondFactorParams,
 ) => Promise<__experimental_SessionVerificationResource>;
 __experimental_verifySessionAttemptSecondFactor: (
 params: __experimental_SessionVerifyAttemptSecondFactorParams,
 ) => Promise<__experimental_SessionVerificationResource>;

 get verifiedExternalAccounts(): ExternalAccountResource[];

Expand All@@ -119,6 +149,20 @@ export interface UserResource extends ClerkResource {
 get hasVerifiedPhoneNumber(): boolean;
}

export type __experimental_SessionVerifyCreateParams = {
 level: __experimental_SessionVerificationLevel;
 maxAge: __experimental_SessionVerificationMaxAge;
};

export type __experimental_SessionVerifyPrepareFirstFactorParams = EmailCodeConfig | PhoneCodeConfig;
export type __experimental_SessionVerifyAttemptFirstFactorParams =
 | EmailCodeAttempt
 | PhoneCodeAttempt
 | PasswordAttempt;

export type __experimental_SessionVerifyPrepareSecondFactorParams = PhoneCodeSecondFactorConfig;
export type __experimental_SessionVerifyAttemptSecondFactorParams = PhoneCodeAttempt | TOTPAttempt | BackupCodeAttempt;

export type CreateEmailAddressParams = { email: string };
export type CreatePhoneNumberParams = { phoneNumber: string };
export type CreateWeb3WalletParams = { web3Wallet: string };
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(clerk-js,types): Expose SessionVerification as an experimental resource#4011

New issue

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

 Sign up for GitHub

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

Already on GitHub?
Sign in
to your account

 Merged

panteliselef
merged 3 commits into

from

Aug 26, 2024
 Merged


feat(clerk-js,types): Expose SessionVerification as an experimental resource
#4011
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
7fa85c9

feat(clerk-js,types): Expose `SessionVerification` as an experimental…


panteliselef Aug 23, 2024
20735d8

fix linting


panteliselef Aug 23, 2024
8585d40

Merge branch 'refs/heads/main' into elef/user-609-support-the-session…


panteliselef Aug 24, 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


12 changes: 12 additions & 0 deletions
.changeset/late-taxis-end.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
---
"@clerk/clerk-js": minor
"@clerk/types": minor
---

Expose `SessionVerification` as an experimental resource. 
Update `UserResource` with 5 new experimental methods:
- `experimental_verifySession` for creating a new SessionVerification record and initiating a new flow.
- `experimental_verifySessionPrepareFirstFactor` for preparing a supported first factor like `phone_code`
- `experimental_verifySessionAttemptFirstFactor` for attempting a supported first factor like `password`
- `experimental_verifySessionPrepareSecondFactor` for preparing a supported second factor like `phone_code`
- `experimental_verifySessionAttemptSecondFactor` for attempting a supported second factor like `totp`

46 changes: 46 additions & 0 deletions
packages/clerk-js/src/core/resources/SessionVerification.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
import { deepSnakeToCamel } from '@clerk/shared';
import type {
 __experimental_SessionVerificationFirstFactor,
 __experimental_SessionVerificationJSON,
 __experimental_SessionVerificationLevel,
 __experimental_SessionVerificationResource,
 __experimental_SessionVerificationSecondFactor,
 __experimental_SessionVerificationStatus,
 SessionResource,
 VerificationResource,
} from '@clerk/types';

import { BaseResource, Session, Verification } from './internal';

export class SessionVerification extends BaseResource implements __experimental_SessionVerificationResource {
 status!: __experimental_SessionVerificationStatus;
 level!: __experimental_SessionVerificationLevel;
 session!: SessionResource;
 supportedFirstFactors: __experimental_SessionVerificationFirstFactor[] = [];
 supportedSecondFactors: __experimental_SessionVerificationSecondFactor[] = [];
 firstFactorVerification: VerificationResource = new Verification(null);
 secondFactorVerification: VerificationResource = new Verification(null);

 constructor(data: __experimental_SessionVerificationJSON | null = null) {
 super();
 this.fromJSON(data);
 }

 protected fromJSON(data: __experimental_SessionVerificationJSON | null): this {
 if (data) {
 this.id = data.id;
 this.status = data.status;
 this.session = new Session(data.session);
 this.level = data.level;
 this.supportedFirstFactors = deepSnakeToCamel(
 data.supported_first_factors,
 ) as __experimental_SessionVerificationFirstFactor[];
 this.supportedSecondFactors = deepSnakeToCamel(
 data.supported_second_factors,
 ) as __experimental_SessionVerificationSecondFactor[];
 this.firstFactorVerification = new Verification(data.first_factor_verification);
 this.secondFactorVerification = new Verification(data.second_factor_verification);
 }
 return this;
 }
}

103 changes: 103 additions & 0 deletions
packages/clerk-js/src/core/resources/User.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,11 @@
import type {
 __experimental_SessionVerificationJSON,
 __experimental_SessionVerificationResource,
 __experimental_SessionVerifyAttemptFirstFactorParams,
 __experimental_SessionVerifyAttemptSecondFactorParams,
 __experimental_SessionVerifyCreateParams,
 __experimental_SessionVerifyPrepareFirstFactorParams,
 __experimental_SessionVerifyPrepareSecondFactorParams,
 BackupCodeJSON,
 BackupCodeResource,
 CreateEmailAddressParams,
Expand All@@ -8,6 +15,7 @@ import type {
 DeletedObjectJSON,
 DeletedObjectResource,
 EmailAddressResource,
 EmailCodeConfig,
 ExternalAccountJSON,
 ExternalAccountResource,
 GetOrganizationMemberships,
Expand All@@ -16,6 +24,7 @@ import type {
 ImageResource,
 OrganizationMembershipResource,
 PasskeyResource,
 PhoneCodeConfig,
 PhoneNumberResource,
 RemoveUserPasswordParams,
 SamlAccountResource,
Expand All@@ -33,6 +42,7 @@ import type {
import { unixEpochToDate } from '../../utils/date';
import { normalizeUnsafeMetadata } from '../../utils/resourceParams';
import { getFullName } from '../../utils/user';
import { clerkInvalidStrategy } from '../errors';
import { BackupCode } from './BackupCode';
import {
 BaseResource,
Expand All@@ -50,6 +60,7 @@ import {
 UserOrganizationInvitation,
 Web3Wallet,
} from './internal';
import { SessionVerification } from './SessionVerification';

export class User extends BaseResource implements UserResource {
 pathRoot = '/me';
Expand DownExpand Up@@ -239,6 +250,98 @@ export class User extends BaseResource implements UserResource {
 return this._baseDelete({ path: '/me' });
 };

 __experimental_verifySession = async ({
 level,
 maxAge,
 }: __experimental_SessionVerifyCreateParams): Promise<__experimental_SessionVerificationResource> => {
 const json = (
 await BaseResource._fetch({
 method: 'POST',
 path: `/me/sessions/${User.clerk.session?.id}/verify`,
 body: {
 level,
 maxAge,
 } as any,
 })
 )?.response as unknown as __experimental_SessionVerificationJSON;

 return new SessionVerification(json);
 };

 __experimental_verifySessionPrepareFirstFactor = async (
 factor: __experimental_SessionVerifyPrepareFirstFactorParams,
 ): Promise<__experimental_SessionVerificationResource> => {
 let config;
 switch (factor.strategy) {
 case 'email_code':
 config = { emailAddressId: factor.emailAddressId } as EmailCodeConfig;
 break;
 case 'phone_code':
 config = {
 phoneNumberId: factor.phoneNumberId,
 default: factor.default,
 } as PhoneCodeConfig;
 break;
 default:
 clerkInvalidStrategy('User.verifySessionPrepareFirstFactor', (factor as any).strategy);
 }

 const json = (
 await BaseResource._fetch({
 method: 'POST',
 path: `/me/sessions/${User.clerk.session?.id}/verify/prepare_first_factor`,
 body: {
 ...config,
 strategy: factor.strategy,
 } as any,
 })
 )?.response as unknown as __experimental_SessionVerificationJSON;

 return new SessionVerification(json);
 };

 __experimental_verifySessionAttemptFirstFactor = async (
 attemptFactor: __experimental_SessionVerifyAttemptFirstFactorParams,
 ): Promise<__experimental_SessionVerificationResource> => {
 const json = (
 await BaseResource._fetch({
 method: 'POST',
 path: `/me/sessions/${User.clerk.session?.id}/verify/attempt_first_factor`,
 body: { ...attemptFactor, strategy: attemptFactor.strategy } as any,
 })
 )?.response as unknown as __experimental_SessionVerificationJSON;

 return new SessionVerification(json);
 };

 __experimental_verifySessionPrepareSecondFactor = async (
 params: __experimental_SessionVerifyPrepareSecondFactorParams,
 ): Promise<__experimental_SessionVerificationResource> => {
 const json = (
 await BaseResource._fetch({
 method: 'POST',
 path: `/me/sessions/${User.clerk.session?.id}/verify/prepare_second_factor`,
 body: params as any,
 })
 )?.response as unknown as __experimental_SessionVerificationJSON;

 return new SessionVerification(json);
 };

 __experimental_verifySessionAttemptSecondFactor = async (
 params: __experimental_SessionVerifyAttemptSecondFactorParams,
 ): Promise<__experimental_SessionVerificationResource> => {
 const json = (
 await BaseResource._fetch({
 method: 'POST',
 path: `/me/sessions/${User.clerk.session?.id}/verify/attempt_second_factor`,
 body: params as any,
 })
 )?.response as unknown as __experimental_SessionVerificationJSON;

 return new SessionVerification(json);
 };

 getSessions = async (): Promise<SessionWithActivities[]> => {
 if (this.cachedSessionsWithActivities) {
 return this.cachedSessionsWithActivities;
Expand Down

1 change: 1 addition & 0 deletions
packages/types/src/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -39,6 +39,7 @@ export * from './role';
export * from './saml';
export * from './samlAccount';
export * from './session';
export * from './sessionVerification';
export * from './signIn';
export * from './signUp';
export * from './ssr';
Expand Down

15 changes: 15 additions & 0 deletions
packages/types/src/json.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -12,6 +12,10 @@ import type { OrganizationSettingsJSON } from './organizationSettings';
import type { OrganizationSuggestionStatus } from './organizationSuggestion';
import type { SamlIdpSlug } from './saml';
import type { SessionStatus } from './session';
import type {
 __experimental_SessionVerificationLevel,
 __experimental_SessionVerificationStatus,
} from './sessionVerification';
import type { SignInFirstFactor, SignInJSON, SignInSecondFactor } from './signIn';
import type { SignUpField, SignUpIdentificationField, SignUpStatus } from './signUp';
import type { BoxShadow, Color, EmUnit, FontWeight, HexColor } from './theme';
Expand DownExpand Up@@ -112,6 +116,17 @@ export interface SessionJSON extends ClerkResourceJSON {
 updated_at: number;
}

export interface __experimental_SessionVerificationJSON extends ClerkResourceJSON {
 object: 'session_verification';
 status: __experimental_SessionVerificationStatus;
 first_factor_verification: VerificationJSON;
 session: SessionJSON;
 second_factor_verification: VerificationJSON;
 level: __experimental_SessionVerificationLevel;
 supported_first_factors: SignInFirstFactorJSON[];
 supported_second_factors: SignInSecondFactorJSON[];
}

export interface EmailAddressJSON extends ClerkResourceJSON {
 object: 'email_address';
 email_address: string;
Expand Down

21 changes: 21 additions & 0 deletions
packages/types/src/sessionVerification.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
import type { BackupCodeFactor, EmailCodeFactor, PasswordFactor, PhoneCodeFactor, TOTPFactor } from './factors';
import type { ClerkResource } from './resource';
import type { SessionResource } from './session';
import type { VerificationResource } from './verification';

export interface __experimental_SessionVerificationResource extends ClerkResource {
 status: __experimental_SessionVerificationStatus | null;
 level: __experimental_SessionVerificationLevel;
 session: SessionResource;
 firstFactorVerification: VerificationResource;
 secondFactorVerification: VerificationResource;
 supportedFirstFactors: __experimental_SessionVerificationFirstFactor[];
 supportedSecondFactors: __experimental_SessionVerificationSecondFactor[];
}

export type __experimental_SessionVerificationStatus = 'needs_first_factor' | 'needs_second_factor' | 'complete';
export type __experimental_SessionVerificationLevel = 'L1.firstFactor' | 'L2.secondFactor' | 'L3.multiFactor';
export type __experimental_SessionVerificationMaxAge = 'A1.10min' | 'A2.1hr' | 'A3.4hr' | 'A4.1day' | 'A5.1wk';

export type __experimental_SessionVerificationFirstFactor = EmailCodeFactor | PhoneCodeFactor | PasswordFactor;
export type __experimental_SessionVerificationSecondFactor = PhoneCodeFactor | TOTPFactor | BackupCodeFactor;

44 changes: 44 additions & 0 deletions
packages/types/src/user.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,6 +2,16 @@ import type { BackupCodeResource } from './backupCode';
import type { DeletedObjectResource } from './deletedObject';
import type { EmailAddressResource } from './emailAddress';
import type { ExternalAccountResource } from './externalAccount';
import type {
 BackupCodeAttempt,
 EmailCodeAttempt,
 EmailCodeConfig,
 PasswordAttempt,
 PhoneCodeAttempt,
 PhoneCodeConfig,
 PhoneCodeSecondFactorConfig,
 TOTPAttempt,
} from './factors';
import type { ImageResource } from './image';
import type { UserJSON } from './json';
import type { OAuthScope } from './oauth';
Expand All@@ -14,6 +24,11 @@ import type { PhoneNumberResource } from './phoneNumber';
import type { ClerkResource } from './resource';
import type { SamlAccountResource } from './samlAccount';
import type { SessionWithActivitiesResource } from './session';
import type {
 __experimental_SessionVerificationLevel,
 __experimental_SessionVerificationMaxAge,
 __experimental_SessionVerificationResource,
} from './sessionVerification';
import type { OAuthStrategy } from './strategies';
import type { TOTPResource } from './totp';
import type { UserOrganizationInvitationResource } from './userOrganizationInvitation';
Expand DownExpand Up@@ -109,6 +124,21 @@ export interface UserResource extends ClerkResource {
 verifyTOTP: (params: VerifyTOTPParams) => Promise<TOTPResource>;
 disableTOTP: () => Promise<DeletedObjectResource>;
 createBackupCode: () => Promise<BackupCodeResource>;
 __experimental_verifySession: (
 params: __experimental_SessionVerifyCreateParams,
 ) => Promise<__experimental_SessionVerificationResource>;
 __experimental_verifySessionPrepareFirstFactor: (
 factor: __experimental_SessionVerifyPrepareFirstFactorParams,
 ) => Promise<__experimental_SessionVerificationResource>;
 __experimental_verifySessionAttemptFirstFactor: (
 attemptFactor: __experimental_SessionVerifyAttemptFirstFactorParams,
 ) => Promise<__experimental_SessionVerificationResource>;
 __experimental_verifySessionPrepareSecondFactor: (
 params: __experimental_SessionVerifyPrepareSecondFactorParams,
 ) => Promise<__experimental_SessionVerificationResource>;
 __experimental_verifySessionAttemptSecondFactor: (
 params: __experimental_SessionVerifyAttemptSecondFactorParams,
 ) => Promise<__experimental_SessionVerificationResource>;

 get verifiedExternalAccounts(): ExternalAccountResource[];

Expand All@@ -119,6 +149,20 @@ export interface UserResource extends ClerkResource {
 get hasVerifiedPhoneNumber(): boolean;
}

export type __experimental_SessionVerifyCreateParams = {
 level: __experimental_SessionVerificationLevel;
 maxAge: __experimental_SessionVerificationMaxAge;
};

export type __experimental_SessionVerifyPrepareFirstFactorParams = EmailCodeConfig | PhoneCodeConfig;
export type __experimental_SessionVerifyAttemptFirstFactorParams =
 | EmailCodeAttempt
 | PhoneCodeAttempt
 | PasswordAttempt;

export type __experimental_SessionVerifyPrepareSecondFactorParams = PhoneCodeSecondFactorConfig;
export type __experimental_SessionVerifyAttemptSecondFactorParams = PhoneCodeAttempt | TOTPAttempt | BackupCodeAttempt;

export type CreateEmailAddressParams = { email: string };
export type CreatePhoneNumberParams = { phoneNumber: string };
export type CreateWeb3WalletParams = { web3Wallet: string };
Expand Down