feat(clerk-js, types): Add clientTrustState and untrustedFirstFactors to Client and SignIn resources

  - Trusted users automatically see password
  - Untrusted users automatically don't see password
  - Added Expo dummy data.

Author: chriscanin

packages/clerk-js/src/core/resources/Client.ts

@@ -3,6 +3,7 @@ import type {
   ClientJSON,
   ClientJSONSnapshot,
   ClientResource,
+  ClientTrustState,
   LastAuthenticationStrategy,
   SignedInSessionResource,
   SignInResource,
@@ -26,6 +27,7 @@ export class Client extends BaseResource implements ClientResource {
   cookieExpiresAt: Date | null = null;
   /** Last authentication strategy used by this client; `null` when unknown/disabled. */
   lastAuthenticationStrategy: LastAuthenticationStrategy | null = null;
+  clientTrustState: ClientTrustState | null = null;
   createdAt: Date | null = null;
   updatedAt: Date | null = null;
 
@@ -86,6 +88,7 @@ export class Client extends BaseResource implements ClientResource {
       this.signIn = new SignIn(null);
       this.lastActiveSessionId = null;
       this.lastAuthenticationStrategy = null;
+      this.clientTrustState = null;
       this.cookieExpiresAt = null;
       this.createdAt = null;
       this.updatedAt = null;
@@ -135,6 +138,7 @@ export class Client extends BaseResource implements ClientResource {
       this.captchaBypass = data.captcha_bypass || false;
       this.cookieExpiresAt = data.cookie_expires_at ? unixEpochToDate(data.cookie_expires_at) : null;
       this.lastAuthenticationStrategy = data.last_authentication_strategy || null;
+      this.clientTrustState = data.client_trust_state || null;
       this.createdAt = unixEpochToDate(data.created_at || undefined);
       this.updatedAt = unixEpochToDate(data.updated_at || undefined);
     }
@@ -153,6 +157,7 @@ export class Client extends BaseResource implements ClientResource {
       captcha_bypass: this.captchaBypass,
       cookie_expires_at: this.cookieExpiresAt ? this.cookieExpiresAt.getTime() : null,
       last_authentication_strategy: this.lastAuthenticationStrategy ?? null,
+      client_trust_state: this.clientTrustState ?? null,
       created_at: this.createdAt?.getTime() ?? null,
       updated_at: this.updatedAt?.getTime() ?? null,
     };

packages/clerk-js/src/core/resources/SignIn.ts

@@ -103,6 +103,7 @@ export class SignIn extends BaseResource implements SignInResource {
   private _status: SignInStatus | null = null;
   supportedIdentifiers: SignInIdentifier[] = [];
   supportedFirstFactors: SignInFirstFactor[] | null = [];
+  untrustedFirstFactors: SignInFirstFactor[] | null = [];
   supportedSecondFactors: SignInSecondFactor[] | null = null;
   firstFactorVerification: VerificationResource = new Verification(null);
   secondFactorVerification: VerificationResource = new Verification(null);
@@ -527,6 +528,7 @@ export class SignIn extends BaseResource implements SignInResource {
       this.supportedIdentifiers = data.supported_identifiers;
       this.identifier = data.identifier;
       this.supportedFirstFactors = deepSnakeToCamel(data.supported_first_factors) as SignInFirstFactor[] | null;
+      this.untrustedFirstFactors = deepSnakeToCamel(data.untrusted_first_factors) as SignInFirstFactor[] | null;
       this.supportedSecondFactors = deepSnakeToCamel(data.supported_second_factors) as SignInSecondFactor[] | null;
       this.firstFactorVerification = new Verification(data.first_factor_verification);
       this.secondFactorVerification = new Verification(data.second_factor_verification);
@@ -545,6 +547,7 @@ export class SignIn extends BaseResource implements SignInResource {
       status: this.status || null,
       supported_identifiers: this.supportedIdentifiers,
       supported_first_factors: deepCamelToSnake(this.supportedFirstFactors),
+      untrusted_first_factors: deepCamelToSnake(this.untrustedFirstFactors),
       supported_second_factors: deepCamelToSnake(this.supportedSecondFactors),
       first_factor_verification: this.firstFactorVerification.__internal_toSnapshot(),
       second_factor_verification: this.secondFactorVerification.__internal_toSnapshot(),

packages/clerk-js/src/test/core-fixtures.ts

@@ -208,6 +208,7 @@ export const createSignIn = (signInParams: Partial<SignInJSON> = {}, user: Parti
     object: 'sign_in',
     second_factor_verification: signInParams.second_factor_verification,
     supported_first_factors: signInParams.supported_first_factors,
+    untrusted_first_factors: signInParams.untrusted_first_factors || [],
     supported_second_factors: signInParams.supported_second_factors,
     user_data: {
       first_name: user.first_name,

packages/expo/src/cache/dummy-data/client-resource.ts

@@ -92,6 +92,7 @@ export const DUMMY_CLERK_CLIENT_RESOURCE = {
     status: null,
     supported_identifiers: [],
     supported_first_factors: [],
+    untrusted_first_factors: [],
     supported_second_factors: null,
     first_factor_verification: {
       object: 'verification',
@@ -126,6 +127,7 @@ export const DUMMY_CLERK_CLIENT_RESOURCE = {
   last_active_session_id: null,
   cookie_expires_at: null,
   last_authentication_strategy: null,
+  client_trust_state: null,
   created_at: new Date().getTime(),
   updated_at: new Date().getTime(),
 } as unknown as ClientJSONSnapshot;

packages/shared/src/types/client.ts

@@ -1,4 +1,4 @@
-import type { LastAuthenticationStrategy } from './json';
+import type { ClientTrustState, LastAuthenticationStrategy } from './json';
 import type { ClerkResource } from './resource';
 import type { ActiveSessionResource, SessionResource, SignedInSessionResource } from './session';
 import type { SignInResource } from './signIn';
@@ -20,6 +20,7 @@ export interface ClientResource extends ClerkResource {
   lastActiveSessionId: string | null;
   /** Last authentication strategy used by this client; `null` when unknown or feature disabled. */
   lastAuthenticationStrategy: LastAuthenticationStrategy | null;
+  clientTrustState: ClientTrustState | null;
   captchaBypass: boolean;
   cookieExpiresAt: Date | null;
   createdAt: Date | null;

packages/shared/src/types/json.ts

@@ -102,6 +102,8 @@ export type LastAuthenticationStrategy =
   | OAuthStrategy
   | Web3Strategy;
 
+export type ClientTrustState = 'new' | 'known' | 'pending';
+
 export interface ClientJSON extends ClerkResourceJSON {
   object: 'client';
   id: string;
@@ -111,6 +113,7 @@ export interface ClientJSON extends ClerkResourceJSON {
   captcha_bypass?: boolean; // this is used by the @clerk/testing package
   last_active_session_id: string | null;
   last_authentication_strategy: LastAuthenticationStrategy | null;
+  client_trust_state: ClientTrustState | null;
   cookie_expires_at: number | null;
   created_at: number;
   updated_at: number;

packages/shared/src/types/signIn.ts

@@ -41,6 +41,7 @@ export interface SignInResource extends ClerkResource {
    */
   supportedIdentifiers: SignInIdentifier[];
   supportedFirstFactors: SignInFirstFactor[] | null;
+  untrustedFirstFactors: SignInFirstFactor[] | null;
   supportedSecondFactors: SignInSecondFactor[] | null;
   firstFactorVerification: VerificationResource;
   secondFactorVerification: VerificationResource;
@@ -101,6 +102,7 @@ export interface SignInJSON extends ClerkResourceJSON {
   identifier: string;
   user_data: UserDataJSON;
   supported_first_factors: SignInFirstFactorJSON[];
+  untrusted_first_factors: SignInFirstFactorJSON[];
   supported_second_factors: SignInSecondFactorJSON[];
   first_factor_verification: VerificationJSON | null;
   second_factor_verification: VerificationJSON | null;

packages/shared/src/types/snapshots.ts

@@ -35,7 +35,10 @@ import type { UserSettingsJSON } from './userSettings';
 import type { Nullable, Override } from './utils';
 
 export type SignInJSONSnapshot = Override<
-  Nullable<SignInJSON, 'status' | 'identifier' | 'supported_first_factors' | 'supported_second_factors'>,
+  Nullable<
+    SignInJSON,
+    'status' | 'identifier' | 'supported_first_factors' | 'untrusted_first_factors' | 'supported_second_factors'
+  >,
   {
     first_factor_verification: VerificationJSONSnapshot;
     second_factor_verification: VerificationJSONSnapshot;