@clerk/types 4.91.0 → 4.92.0-canary.v20251006144543
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/index.d.mts +53 -1
- package/dist/index.d.ts +53 -1
- package/package.json +1 -1
package/dist/index.d.mts
CHANGED
|
@@ -3110,10 +3110,18 @@ interface SignInFutureFinalizeParams {
|
|
|
3110
3110
|
* The current active `SignIn` instance, for use in custom flows.
|
|
3111
3111
|
*/
|
|
3112
3112
|
interface SignInFutureResource {
|
|
3113
|
+
/**
|
|
3114
|
+
* The unique identifier for the current sign-in attempt.
|
|
3115
|
+
*/
|
|
3116
|
+
readonly id?: string;
|
|
3113
3117
|
/**
|
|
3114
3118
|
* The list of first-factor strategies that are available for the current sign-in attempt.
|
|
3115
3119
|
*/
|
|
3116
|
-
readonly
|
|
3120
|
+
readonly supportedFirstFactors: SignInFirstFactor[];
|
|
3121
|
+
/**
|
|
3122
|
+
* The list of second-factor strategies that are available for the current sign-in attempt.
|
|
3123
|
+
*/
|
|
3124
|
+
readonly supportedSecondFactors: SignInSecondFactor[];
|
|
3117
3125
|
/**
|
|
3118
3126
|
* The status of the current sign-in attempt as a string (for example, `'needs_identifier'`, `'needs_first_factor'`,
|
|
3119
3127
|
* `'complete'`, etc.)
|
|
@@ -3128,6 +3136,22 @@ interface SignInFutureResource {
|
|
|
3128
3136
|
sessionId: string;
|
|
3129
3137
|
};
|
|
3130
3138
|
readonly firstFactorVerification: VerificationResource;
|
|
3139
|
+
/**
|
|
3140
|
+
* The second-factor verification for the current sign-in attempt.
|
|
3141
|
+
*/
|
|
3142
|
+
readonly secondFactorVerification: VerificationResource;
|
|
3143
|
+
/**
|
|
3144
|
+
* The identifier for the current sign-in attempt.
|
|
3145
|
+
*/
|
|
3146
|
+
readonly identifier: string | null;
|
|
3147
|
+
/**
|
|
3148
|
+
* The created session ID for the current sign-in attempt.
|
|
3149
|
+
*/
|
|
3150
|
+
readonly createdSessionId: string | null;
|
|
3151
|
+
/**
|
|
3152
|
+
* The user data for the current sign-in attempt.
|
|
3153
|
+
*/
|
|
3154
|
+
readonly userData: UserData;
|
|
3131
3155
|
/**
|
|
3132
3156
|
* Used to supply an identifier for the sign-in attempt. Calling this method will populate data on the sign-in
|
|
3133
3157
|
* attempt, such as `signIn.resource.supportedFirstFactors`.
|
|
@@ -5295,10 +5319,26 @@ interface SignUpFutureFinalizeParams {
|
|
|
5295
5319
|
* The current active `SignUp` instance, for use in custom flows.
|
|
5296
5320
|
*/
|
|
5297
5321
|
interface SignUpFutureResource {
|
|
5322
|
+
/**
|
|
5323
|
+
* The unique identifier for the current sign-up attempt.
|
|
5324
|
+
*/
|
|
5325
|
+
readonly id?: string;
|
|
5298
5326
|
/**
|
|
5299
5327
|
* The status of the current sign-up attempt as a string (for example, `'missing_requirements'`, `'complete'`, `'abandoned'`, etc.)
|
|
5300
5328
|
*/
|
|
5301
5329
|
readonly status: SignUpStatus;
|
|
5330
|
+
/**
|
|
5331
|
+
* The list of required fields for the current sign-up attempt.
|
|
5332
|
+
*/
|
|
5333
|
+
readonly requiredFields: SignUpField[];
|
|
5334
|
+
/**
|
|
5335
|
+
* The list of optional fields for the current sign-up attempt.
|
|
5336
|
+
*/
|
|
5337
|
+
readonly optionalFields: SignUpField[];
|
|
5338
|
+
/**
|
|
5339
|
+
* The list of missing fields for the current sign-up attempt.
|
|
5340
|
+
*/
|
|
5341
|
+
readonly missingFields: SignUpField[];
|
|
5302
5342
|
/**
|
|
5303
5343
|
* An array of strings representing unverified fields such as `’email_address’`. Can be used to detect when verification is necessary.
|
|
5304
5344
|
*/
|
|
@@ -5311,6 +5351,18 @@ interface SignUpFutureResource {
|
|
|
5311
5351
|
readonly existingSession?: {
|
|
5312
5352
|
sessionId: string;
|
|
5313
5353
|
};
|
|
5354
|
+
readonly username: string | null;
|
|
5355
|
+
readonly firstName: string | null;
|
|
5356
|
+
readonly lastName: string | null;
|
|
5357
|
+
readonly emailAddress: string | null;
|
|
5358
|
+
readonly phoneNumber: string | null;
|
|
5359
|
+
readonly web3Wallet: string | null;
|
|
5360
|
+
readonly hasPassword: boolean;
|
|
5361
|
+
readonly unsafeMetadata: SignUpUnsafeMetadata;
|
|
5362
|
+
readonly createdSessionId: string | null;
|
|
5363
|
+
readonly createdUserId: string | null;
|
|
5364
|
+
readonly abandonAt: number | null;
|
|
5365
|
+
readonly legalAcceptedAt: number | null;
|
|
5314
5366
|
create: (params: SignUpFutureCreateParams) => Promise<{
|
|
5315
5367
|
error: unknown;
|
|
5316
5368
|
}>;
|
package/dist/index.d.ts
CHANGED
|
@@ -3110,10 +3110,18 @@ interface SignInFutureFinalizeParams {
|
|
|
3110
3110
|
* The current active `SignIn` instance, for use in custom flows.
|
|
3111
3111
|
*/
|
|
3112
3112
|
interface SignInFutureResource {
|
|
3113
|
+
/**
|
|
3114
|
+
* The unique identifier for the current sign-in attempt.
|
|
3115
|
+
*/
|
|
3116
|
+
readonly id?: string;
|
|
3113
3117
|
/**
|
|
3114
3118
|
* The list of first-factor strategies that are available for the current sign-in attempt.
|
|
3115
3119
|
*/
|
|
3116
|
-
readonly
|
|
3120
|
+
readonly supportedFirstFactors: SignInFirstFactor[];
|
|
3121
|
+
/**
|
|
3122
|
+
* The list of second-factor strategies that are available for the current sign-in attempt.
|
|
3123
|
+
*/
|
|
3124
|
+
readonly supportedSecondFactors: SignInSecondFactor[];
|
|
3117
3125
|
/**
|
|
3118
3126
|
* The status of the current sign-in attempt as a string (for example, `'needs_identifier'`, `'needs_first_factor'`,
|
|
3119
3127
|
* `'complete'`, etc.)
|
|
@@ -3128,6 +3136,22 @@ interface SignInFutureResource {
|
|
|
3128
3136
|
sessionId: string;
|
|
3129
3137
|
};
|
|
3130
3138
|
readonly firstFactorVerification: VerificationResource;
|
|
3139
|
+
/**
|
|
3140
|
+
* The second-factor verification for the current sign-in attempt.
|
|
3141
|
+
*/
|
|
3142
|
+
readonly secondFactorVerification: VerificationResource;
|
|
3143
|
+
/**
|
|
3144
|
+
* The identifier for the current sign-in attempt.
|
|
3145
|
+
*/
|
|
3146
|
+
readonly identifier: string | null;
|
|
3147
|
+
/**
|
|
3148
|
+
* The created session ID for the current sign-in attempt.
|
|
3149
|
+
*/
|
|
3150
|
+
readonly createdSessionId: string | null;
|
|
3151
|
+
/**
|
|
3152
|
+
* The user data for the current sign-in attempt.
|
|
3153
|
+
*/
|
|
3154
|
+
readonly userData: UserData;
|
|
3131
3155
|
/**
|
|
3132
3156
|
* Used to supply an identifier for the sign-in attempt. Calling this method will populate data on the sign-in
|
|
3133
3157
|
* attempt, such as `signIn.resource.supportedFirstFactors`.
|
|
@@ -5295,10 +5319,26 @@ interface SignUpFutureFinalizeParams {
|
|
|
5295
5319
|
* The current active `SignUp` instance, for use in custom flows.
|
|
5296
5320
|
*/
|
|
5297
5321
|
interface SignUpFutureResource {
|
|
5322
|
+
/**
|
|
5323
|
+
* The unique identifier for the current sign-up attempt.
|
|
5324
|
+
*/
|
|
5325
|
+
readonly id?: string;
|
|
5298
5326
|
/**
|
|
5299
5327
|
* The status of the current sign-up attempt as a string (for example, `'missing_requirements'`, `'complete'`, `'abandoned'`, etc.)
|
|
5300
5328
|
*/
|
|
5301
5329
|
readonly status: SignUpStatus;
|
|
5330
|
+
/**
|
|
5331
|
+
* The list of required fields for the current sign-up attempt.
|
|
5332
|
+
*/
|
|
5333
|
+
readonly requiredFields: SignUpField[];
|
|
5334
|
+
/**
|
|
5335
|
+
* The list of optional fields for the current sign-up attempt.
|
|
5336
|
+
*/
|
|
5337
|
+
readonly optionalFields: SignUpField[];
|
|
5338
|
+
/**
|
|
5339
|
+
* The list of missing fields for the current sign-up attempt.
|
|
5340
|
+
*/
|
|
5341
|
+
readonly missingFields: SignUpField[];
|
|
5302
5342
|
/**
|
|
5303
5343
|
* An array of strings representing unverified fields such as `’email_address’`. Can be used to detect when verification is necessary.
|
|
5304
5344
|
*/
|
|
@@ -5311,6 +5351,18 @@ interface SignUpFutureResource {
|
|
|
5311
5351
|
readonly existingSession?: {
|
|
5312
5352
|
sessionId: string;
|
|
5313
5353
|
};
|
|
5354
|
+
readonly username: string | null;
|
|
5355
|
+
readonly firstName: string | null;
|
|
5356
|
+
readonly lastName: string | null;
|
|
5357
|
+
readonly emailAddress: string | null;
|
|
5358
|
+
readonly phoneNumber: string | null;
|
|
5359
|
+
readonly web3Wallet: string | null;
|
|
5360
|
+
readonly hasPassword: boolean;
|
|
5361
|
+
readonly unsafeMetadata: SignUpUnsafeMetadata;
|
|
5362
|
+
readonly createdSessionId: string | null;
|
|
5363
|
+
readonly createdUserId: string | null;
|
|
5364
|
+
readonly abandonAt: number | null;
|
|
5365
|
+
readonly legalAcceptedAt: number | null;
|
|
5314
5366
|
create: (params: SignUpFutureCreateParams) => Promise<{
|
|
5315
5367
|
error: unknown;
|
|
5316
5368
|
}>;
|