Skip to content

Commit

Permalink
chore(clerk-js, clerk-react,types): Rename assurance to reverification (
Browse files Browse the repository at this point in the history 
#4268)
  • Loading branch information
@panteliselef
panteliselef authored Oct 2, 2024
1 parent 2e369ee commit fb932e5
Show file tree
Hide file tree
Showing 10 changed files with 256 additions and 147 deletions.
13 changes: 13 additions & 0 deletions .changeset/purple-goats-applaud.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
---
"@clerk/clerk-js": minor
"@clerk/shared": minor
"@clerk/clerk-react": minor
"@clerk/types": minor
---

Rename `__experimental_assurance` to `__experimental_reverification`.

- Supported levels are now are `firstFactor`, `secondFactor`, `multiFactor`.
- Support maxAge is now replaced by maxAgeMinutes and afterMinutes depending on usage.
- Introduced `____experimental_SessionVerificationTypes` that abstracts away the level and maxAge
- Allowed values 'veryStrict' | 'strict' | 'moderate' | 'lax'
2 changes: 1 addition & 1 deletion packages/clerk-js/bundlewatch.config.json
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"files": [
{ "path": "./dist/clerk.browser.js", "maxSize": "65kB" },
{ "path": "./dist/clerk.browser.js", "maxSize": "64.5kB" },
{ "path": "./dist/clerk.headless.js", "maxSize": "43kB" },
{ "path": "./dist/ui-common*.js", "maxSize": "86KB" },
{ "path": "./dist/vendors*.js", "maxSize": "70KB" },
Expand Down
4 changes: 2 additions & 2 deletions packages/clerk-js/src/core/resources/Session.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -122,15 +122,15 @@ export class Session extends BaseResource implements SessionResource {

__experimental_startVerification = async ({
level,
maxAge,
maxAgeMinutes,
}: __experimental_SessionVerifyCreateParams): Promise<__experimental_SessionVerificationResource> => {
const json = (
await BaseResource._fetch({
method: 'POST',
path: `/client/sessions/${this.id}/verify`,
body: {
level,
maxAge,
maxAgeMinutes,
} as any,
})
)?.response as unknown as __experimental_SessionVerificationJSON;
Expand Down
172 changes: 101 additions & 71 deletions packages/clerk-js/src/core/resources/__tests__/Session.test.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -311,9 +311,9 @@ describe('Session', () => {

const isAuthorized = session.checkAuthorization({
permission: 'org:sys_profile:delete',
__experimental_assurance: {
level: 'L2.secondFactor',
maxAge: 'A1.10min',
__experimental_reverification: {
level: 'multiFactor',
afterMinutes: 10,
},
});

Expand All @@ -338,9 +338,9 @@ describe('Session', () => {

const isAuthorized = session.checkAuthorization({
permission: 'org:sys_profile:delete',
__experimental_assurance: {
level: 'L2.secondFactor',
maxAge: 'A1.10min',
__experimental_reverification: {
level: 'multiFactor',
afterMinutes: 10,
},
});

Expand All @@ -362,9 +362,9 @@ describe('Session', () => {
} as SessionJSON);

const isAuthorized = session.checkAuthorization({
__experimental_assurance: {
level: 'L2.secondFactor',
maxAge: 'A1.10min',
__experimental_reverification: {
level: 'multiFactor',
afterMinutes: 10,
},
});

Expand All @@ -386,9 +386,9 @@ describe('Session', () => {
} as SessionJSON);

const isAuthorized = session.checkAuthorization({
__experimental_assurance: {
level: 'L2.secondFactor',
maxAge: 'A1.10min',
__experimental_reverification: {
level: 'multiFactor',
afterMinutes: 10,
},
});

Expand All @@ -410,9 +410,9 @@ describe('Session', () => {
} as SessionJSON);

const isAuthorized = session.checkAuthorization({
__experimental_assurance: {
level: 'L1.firstFactor',
maxAge: 'A1.10min',
__experimental_reverification: {
level: 'multiFactor',
afterMinutes: 10,
},
});

Expand All @@ -434,9 +434,9 @@ describe('Session', () => {
} as SessionJSON);

const isAuthorized = session.checkAuthorization({
__experimental_assurance: {
level: 'L1.firstFactor',
maxAge: 'A1.10min',
__experimental_reverification: {
level: 'multiFactor',
afterMinutes: 10,
},
});

Expand All @@ -458,9 +458,9 @@ describe('Session', () => {
} as SessionJSON);

const isAuthorized = session.checkAuthorization({
__experimental_assurance: {
level: 'L2.secondFactor',
maxAge: 'A1.10min',
__experimental_reverification: {
level: 'multiFactor',
afterMinutes: 10,
},
});

Expand All @@ -482,10 +482,7 @@ describe('Session', () => {
} as SessionJSON);

const isAuthorized = session.checkAuthorization({
__experimental_assurance: {
level: 'L2.secondFactor',
maxAge: 'A1.10min',
},
__experimental_reverification: 'strict',
});

expect(isAuthorized).toBe(false);
Expand All @@ -506,10 +503,7 @@ describe('Session', () => {
} as SessionJSON);

const isAuthorized = session.checkAuthorization({
__experimental_assurance: {
level: 'L3.multiFactor',
maxAge: 'A1.10min',
},
__experimental_reverification: 'veryStrict',
});

expect(isAuthorized).toBe(true);
Expand All @@ -530,9 +524,9 @@ describe('Session', () => {
} as SessionJSON);

const isAuthorized = session.checkAuthorization({
__experimental_assurance: {
level: 'L3.multiFactor',
maxAge: 'A1.10min',
__experimental_reverification: {
level: 'multiFactor',
afterMinutes: 10,
},
});

Expand All @@ -554,9 +548,9 @@ describe('Session', () => {
} as SessionJSON);

const isAuthorized = session.checkAuthorization({
__experimental_assurance: {
level: 'L3.multiFactor',
maxAge: 'A1.10min',
__experimental_reverification: {
level: 'multiFactor',
afterMinutes: 10,
},
});

Expand All @@ -578,9 +572,9 @@ describe('Session', () => {
} as SessionJSON);

const isAuthorized = session.checkAuthorization({
__experimental_assurance: {
level: 'L3.multiFactor',
maxAge: 'A1.10min',
__experimental_reverification: {
level: 'multiFactor',
afterMinutes: 10,
},
});

Expand All @@ -602,9 +596,9 @@ describe('Session', () => {
} as SessionJSON);

const isAuthorized = session.checkAuthorization({
__experimental_assurance: {
level: 'L3.multiFactor',
maxAge: 'A1.10min',
__experimental_reverification: {
level: 'multiFactor',
afterMinutes: 10,
},
});

Expand All @@ -626,9 +620,9 @@ describe('Session', () => {
} as SessionJSON);

const isAuthorized = session.checkAuthorization({
__experimental_assurance: {
level: 'L3.multiFactor',
maxAge: 'A1.10min',
__experimental_reverification: {
level: 'multiFactor',
afterMinutes: 10,
},
});

Expand All @@ -650,9 +644,9 @@ describe('Session', () => {
} as SessionJSON);

const isAuthorized = session.checkAuthorization({
__experimental_assurance: {
level: 'L1.firstFactor',
maxAge: 'A1.10min',
__experimental_reverification: {
level: 'firstFactor',
afterMinutes: 10,
},
});

Expand All @@ -674,10 +668,7 @@ describe('Session', () => {
} as SessionJSON);

const isAuthorized = session.checkAuthorization({
__experimental_assurance: {
level: 'L2.secondFactor',
maxAge: 'A1.10min',
},
__experimental_reverification: 'strict',
});

expect(isAuthorized).toBe(false);
Expand All @@ -686,7 +677,7 @@ describe('Session', () => {
/**
* Test for invalid input
*/
it('incorrect params for __experimental_assurance', async () => {
it('incorrect params for __experimental_reverification', async () => {
const session = new Session({
status: 'active',
id: 'session_1',
Expand All @@ -701,17 +692,17 @@ describe('Session', () => {
} as SessionJSON);

const isAuthorized = session.checkAuthorization({
__experimental_assurance: {
__experimental_reverification: {
//@ts-expect-error
level: 'any level',
maxAge: 'A1.10min',
afterMinutes: 10,
},
});

expect(isAuthorized).toBe(false);
});

it('incorrect params for __experimental_assurance', async () => {
it('incorrect params for __experimental_reverification', async () => {
const session = new Session({
status: 'active',
id: 'session_1',
Expand All @@ -726,18 +717,39 @@ describe('Session', () => {
} as SessionJSON);

const isAuthorized = session.checkAuthorization({
__experimental_assurance: {
__experimental_reverification: {
//@ts-expect-error
level: 'any level',
//@ts-expect-error
maxAge: 'som-value',
afterMinutes: 'some-value',
},
});

expect(isAuthorized).toBe(false);
});

it('incorrect params for __experimental_assurance', async () => {
it('incorrect params for __experimental_reverification', async () => {
const session = new Session({
status: 'active',
id: 'session_1',
object: 'session',
user: createUser(),
last_active_organization_id: null,
last_active_token: { object: 'token', jwt: mockJwt },
actor: null,
created_at: new Date().getTime(),
updated_at: new Date().getTime(),
factor_verification_age: [0, 0],
} as SessionJSON);

const isAuthorized = session.checkAuthorization({
__experimental_reverification: 'invalid-value',
});

expect(isAuthorized).toBe(false);
});

it('incorrect params for __experimental_reverification', async () => {
const session = new Session({
status: 'active',
id: 'session_1',
Expand All @@ -752,10 +764,31 @@ describe('Session', () => {
} as SessionJSON);

const isAuthorized = session.checkAuthorization({
__experimental_assurance: {
level: 'L1.firstFactor',
__experimental_reverification: 123,
});

expect(isAuthorized).toBe(false);
});

it('incorrect params for __experimental_reverification', async () => {
const session = new Session({
status: 'active',
id: 'session_1',
object: 'session',
user: createUser(),
last_active_organization_id: null,
last_active_token: { object: 'token', jwt: mockJwt },
actor: null,
created_at: new Date().getTime(),
updated_at: new Date().getTime(),
factor_verification_age: [0, 0],
} as SessionJSON);

const isAuthorized = session.checkAuthorization({
__experimental_reverification: {
level: 'firstFactor',
//@ts-expect-error
maxAge: 100,
afterMinutes: '10',
},
});

Expand All @@ -780,9 +813,9 @@ describe('Session', () => {
} as SessionJSON);

const isAuthorized = session.checkAuthorization({
__experimental_assurance: {
level: 'L3.multiFactor',
maxAge: 'A1.10min',
__experimental_reverification: {
level: 'multiFactor',
afterMinutes: 10,
},
});

Expand All @@ -804,9 +837,9 @@ describe('Session', () => {
} as SessionJSON);

const isAuthorized = session.checkAuthorization({
__experimental_assurance: {
level: 'L1.firstFactor',
maxAge: 'A1.10min',
__experimental_reverification: {
level: 'firstFactor',
afterMinutes: 10,
},
});

Expand All @@ -828,10 +861,7 @@ describe('Session', () => {
} as SessionJSON);

const isAuthorized = session.checkAuthorization({
__experimental_assurance: {
level: 'L2.secondFactor',
maxAge: 'A1.10min',
},
__experimental_reverification: 'strict',
});

expect(isAuthorized).toBe(true);
Expand Down
Loading

0 comments on commit fb932e5

Please sign in to comment.