@clerk/types
Advanced tools
Comparing version 1.15.6 to 1.16.0
@@ -9,11 +9,3 @@ import { ClerkResource } from './resource'; | ||
signUp: SignUpResource; | ||
/** | ||
* @deprecated `signUpAttempt` has been deprecated and will be removed soon. Use the new {@link Client.signUp} instead. | ||
*/ | ||
signUpAttempt: SignUpResource; | ||
signIn: SignInResource; | ||
/** | ||
* @deprecated `signInAttempt` has been deprecated and will be removed soon. Use the new {@link Client.signIn} instead. | ||
*/ | ||
signInAttempt: SignInResource; | ||
isNew: () => boolean; | ||
@@ -20,0 +12,0 @@ create: () => Promise<ClientResource>; |
@@ -7,4 +7,4 @@ /** | ||
import { SessionStatus } from './session'; | ||
import { IdentificationStrategy, PreferredSignInStrategy, SignInFactor, SignInIdentifier, SignInStatus, SignInStrategy, SignInStrategyName, UserData } from './signIn'; | ||
import { SignUpAttributeRequirements, SignUpField, SignUpIdentificationField, SignUpIdentificationRequirements, SignUpMissingRequirements, SignUpStatus } from './signUp'; | ||
import { IdentificationStrategy, PreferredSignInStrategy, SignInFactor, SignInIdentifier, SignInStatus, SignInStrategyName, UserData } from './signIn'; | ||
import { SignUpField, SignUpIdentificationField, SignUpStatus } from './signUp'; | ||
import { BoxShadow, Color, EmUnit, FontFamily, FontWeight, HexColor } from './theme'; | ||
@@ -87,5 +87,2 @@ import { VerificationStatus } from './verification'; | ||
supported_external_accounts: OAuthStrategy[]; | ||
identification_requirements: SignUpIdentificationRequirements; | ||
attribute_requirements: SignUpAttributeRequirements; | ||
missing_requirements: SignUpMissingRequirements; | ||
username: string | null; | ||
@@ -95,7 +92,4 @@ first_name: string | null; | ||
email_address: string | null; | ||
email_address_verification: SignUpVerificationJSON | null; | ||
phone_number: string | null; | ||
phone_number_verification: SignUpVerificationJSON | null; | ||
external_account_strategy: string | null; | ||
external_account_verification: VerificationJSON | null; | ||
external_account: any; | ||
@@ -124,3 +118,2 @@ has_password: boolean; | ||
status: SignInStatus; | ||
allowed_identifier_types: IdentificationStrategy[]; | ||
supported_identifiers: SignInIdentifier[]; | ||
@@ -131,8 +124,4 @@ supported_external_accounts: OAuthStrategy[]; | ||
supported_first_factors: SignInFactor[]; | ||
allowed_factor_one_strategies: SignInStrategy[]; | ||
supported_second_factors: SignInFactor[]; | ||
allowed_factor_two_strategies: SignInStrategy[]; | ||
factor_one_verification: VerificationJSON | null; | ||
first_factor_verification: VerificationJSON | null; | ||
factor_two_verification: VerificationJSON | null; | ||
second_factor_verification: VerificationJSON | null; | ||
@@ -139,0 +128,0 @@ created_session_id: string | null; |
import { ClerkResource } from './resource'; | ||
import { SnakeToCamel } from './utils'; | ||
import { VerificationResource, StartMagicLinkFlowParams, CreateMagicLinkFlowReturn } from './verification'; | ||
import { AuthenticateWithRedirectParams, OAuthCallbacks, OAuthStrategy } from './oauth'; | ||
import { AuthenticateWithRedirectParams, OAuthStrategy } from './oauth'; | ||
import { EmailAddressVerificationStrategy } from './emailAddress'; | ||
@@ -17,61 +17,7 @@ export interface SignInResource extends ClerkResource { | ||
userData: UserData; | ||
/** | ||
* @deprecated `allowedIdentifierTypes` has been deprecated and will be removed soon. | ||
* Use {@link SignInResource.supportedIdentifiers} and {@link SignInResource.supportedExternalAccounts} instead. | ||
*/ | ||
allowedIdentifierTypes: IdentificationStrategy[]; | ||
/** | ||
* @deprecated `allowedFactorOneStrategies` has been deprecated and will be removed soon. | ||
* Use {@link SignInResource.supportedFirstFactors} instead. | ||
*/ | ||
allowedFactorOneStrategies: SignInStrategy[]; | ||
/** | ||
* @deprecated `allowedFactorTwoStrategies` has been deprecated and will be removed soon. | ||
* Use {@link SignInResource.supportedSecondFactors} instead. | ||
*/ | ||
allowedFactorTwoStrategies: SignInStrategy[]; | ||
/** | ||
* @deprecated `factorOneVerification` has been deprecated and will be removed soon. | ||
* Use {@link SignInResource.firstFactorVerification} instead. | ||
*/ | ||
factorOneVerification: VerificationResource; | ||
/** | ||
* @deprecated `factorTwoVerification` has been deprecated and will be removed soon. | ||
* Use {@link SignInResource.secondFactorVerification} instead. | ||
*/ | ||
factorTwoVerification: VerificationResource; | ||
create: (params: SignInParams) => Promise<SignInResource>; | ||
/** | ||
* @deprecated `update` has been deprecated and will be removed soon. Use {@link SignInResource.create} instead. | ||
*/ | ||
update: (params: SignInParams) => Promise<SignInResource>; | ||
/** | ||
* @deprecated `prepareFactorOne` has been deprecated and will be removed soon. | ||
* Use {@link SignInResource.prepareFirstFactor} instead. | ||
*/ | ||
prepareFactorOne: (strategy: any) => Promise<SignInResource>; | ||
prepareFirstFactor: (strategy: PrepareFirstFactorParams) => Promise<SignInResource>; | ||
/** | ||
* @deprecated `attemptFactorOne` has been deprecated and will be removed soon. | ||
* Use {@link SignInResource.attemptFirstFactor} instead. | ||
*/ | ||
attemptFactorOne: (params: any) => Promise<SignInResource>; | ||
attemptFirstFactor: (params: AttemptFactorParams) => Promise<SignInResource>; | ||
/** | ||
* @deprecated `prepareFactorTwo` has been deprecated and will be removed soon. | ||
* Use {@link SignInResource.prepareSecondFactor} instead. | ||
*/ | ||
prepareFactorTwo: (params: any) => Promise<SignInResource>; | ||
prepareSecondFactor: (params: PrepareSecondFactorParams) => Promise<SignInResource>; | ||
/** | ||
* @deprecated `attemptFactorTwo` has been deprecated and will be removed soon. | ||
* Use {@link SignInResource.attemptSecondFactor} instead. | ||
*/ | ||
attemptFactorTwo: (params: any) => Promise<SignInResource>; | ||
attemptSecondFactor: (params: AttemptFactorParams) => Promise<SignInResource>; | ||
/** | ||
* @deprecated `signInWithOAuth` has been deprecated and will be removed soon. | ||
* Use {@link SignInResource.authenticateWithRedirect} instead. | ||
*/ | ||
signInWithOAuth: (strategy: OAuthStrategy, callbacks: OAuthCallbacks) => Promise<void>; | ||
authenticateWithRedirect: (params: AuthenticateWithRedirectParams) => Promise<void>; | ||
@@ -90,3 +36,3 @@ createMagicLinkFlow: () => CreateMagicLinkFlowReturn<SignInStartMagicLinkFlowParams, SignInResource>; | ||
export declare type PreferredSignInStrategy = 'password' | 'otp'; | ||
declare type EmailCodeFactor = { | ||
export declare type EmailCodeFactor = { | ||
strategy: Extract<SignInStrategyName, 'email_code'>; | ||
@@ -96,3 +42,3 @@ email_address_id: string; | ||
}; | ||
declare type EmailLinkFactor = { | ||
export declare type EmailLinkFactor = { | ||
strategy: Extract<SignInStrategyName, 'email_link'>; | ||
@@ -102,3 +48,3 @@ email_address_id: string; | ||
}; | ||
declare type PhoneCodeFactor = { | ||
export declare type PhoneCodeFactor = { | ||
strategy: Extract<SignInStrategyName, 'phone_code'>; | ||
@@ -109,19 +55,8 @@ phone_number_id: string; | ||
}; | ||
declare type PasswordFactor = { | ||
export declare type PasswordFactor = { | ||
strategy: Extract<SignInStrategyName, 'password'>; | ||
}; | ||
declare type OauthFactor = { | ||
export declare type OauthFactor = { | ||
strategy: OAuthStrategy; | ||
}; | ||
/** | ||
* @deprecated `SignInStrategyName` has been deprecated and will be removed soon. | ||
* Use {@link SignInFactor} instead. | ||
*/ | ||
export declare type SignInStrategy = { | ||
email_address_id?: string; | ||
phone_number_id?: string; | ||
safe_identifier?: string; | ||
default?: boolean; | ||
name: SignInStrategyName; | ||
}; | ||
export declare type SignInFactor = EmailCodeFactor | EmailLinkFactor | PhoneCodeFactor | PasswordFactor | OauthFactor; | ||
@@ -128,0 +63,0 @@ export declare type PrepareFirstFactorParams = Omit<EmailCodeFactor, 'safe_identifier'> | (Omit<EmailLinkFactor, 'safe_identifier'> & { |
@@ -1,2 +0,2 @@ | ||
import { AuthenticateWithRedirectParams, OAuthCallbacks, OAuthStrategy } from './oauth'; | ||
import { AuthenticateWithRedirectParams, OAuthStrategy } from './oauth'; | ||
import { ClerkResource } from './resource'; | ||
@@ -25,37 +25,2 @@ import { SnakeToCamel } from './utils'; | ||
abandonAt: number | null; | ||
/** | ||
* @deprecated `identificationRequirements` has been deprecated and will be removed soon. | ||
* Use {@link SignUpResource.requiredFields} instead. | ||
*/ | ||
identificationRequirements: SignUpIdentificationRequirements; | ||
/** | ||
* @deprecated `attributeRequirements` has been deprecated and will be removed soon. | ||
* Use {@link SignUpResource.requiredFields} and {@link SignUpResource.optionalFields} instead. | ||
*/ | ||
attributeRequirements: SignUpAttributeRequirements; | ||
/** | ||
* @deprecated `missingRequirements` has been deprecated and will be removed soon. | ||
* Use {@link SignUpResource.missingFields} and {@link SignUpResource.unverifiedFields} instead. | ||
*/ | ||
missingRequirements: SignUpMissingRequirements; | ||
/** | ||
* @deprecated `emailAddressVerification` has been deprecated and will be removed soon. | ||
* Use {@link SignUpResource.verifications.emailAddress} instead. | ||
*/ | ||
emailAddressVerification: VerificationResource; | ||
/** | ||
* @deprecated `phoneNumberVerification` has been deprecated and will be removed soon. | ||
* Use {@link SignUpResource.verifications.phoneNumber} instead. | ||
*/ | ||
phoneNumberVerification: VerificationResource; | ||
/** | ||
* @deprecated `externalAccountStrategy` has been deprecated and will be removed soon. | ||
* Use {@link SignUpResource.verifications.externalAccount.strategy} instead. | ||
*/ | ||
externalAccountStrategy: string | null; | ||
/** | ||
* @deprecated `missingRequirements` has been deprecated and will be removed soon. | ||
* Use {@link SignUpResource.verifications.externalAccount} instead. | ||
*/ | ||
externalAccountVerification: VerificationResource; | ||
create: (params: SignUpParams) => Promise<SignUpResource>; | ||
@@ -70,7 +35,2 @@ update: (params: SignUpParams) => Promise<SignUpResource>; | ||
attemptPhoneNumberVerification: (params: VerificationAttemptParams) => Promise<SignUpResource>; | ||
/** | ||
* @deprecated `signUpWithOAuth` has been deprecated and will be removed soon. | ||
* Use {@link SignUpResource.authenticateWithRedirect} instead. | ||
*/ | ||
signUpWithOAuth: (strategy: OAuthStrategy, callbacks: OAuthCallbacks) => Promise<void>; | ||
authenticateWithRedirect: (params: AuthenticateWithRedirectParams) => Promise<void>; | ||
@@ -82,11 +42,3 @@ } | ||
export declare type SignUpIdentification = SignUpIdentificationField | OAuthStrategy; | ||
/** | ||
* @deprecated `SignUpIdentificationRequirements` has been deprecated and will be removed soon. | ||
*/ | ||
export declare type SignUpIdentificationRequirements = SignUpIdentification[][]; | ||
export declare type SignUpAttribute = 'first_name' | 'last_name' | 'password' | 'birthday' | 'gender'; | ||
/** | ||
* @deprecated `SignUpAttributeRequirements` has been deprecated and will be removed soon. | ||
*/ | ||
export declare type SignUpAttributeRequirements = SignUpAttribute[][]; | ||
export declare type SignUpAttributes = { | ||
@@ -103,7 +55,2 @@ external_account_strategy: string; | ||
export declare type SignUpParams = Partial<SnakeToCamel<SignUpAttributes> & SignUpAttributes>; | ||
/** | ||
* @deprecated `SignUpMissingRequirements` has been deprecated and will be removed soon. | ||
*/ | ||
export declare type SignUpMissingRequirements = SignUpRequirement[]; | ||
declare type SignUpRequirement = SignUpIdentification | SignUpAttribute; | ||
export interface SignUpVerificationsResource { | ||
@@ -122,3 +69,2 @@ emailAddress: SignUpVerificationResource; | ||
} & VerificationAttemptParams; | ||
export {}; | ||
//# sourceMappingURL=signUp.d.ts.map |
{ | ||
"name": "@clerk/types", | ||
"version": "1.15.6", | ||
"version": "1.16.0", | ||
"license": "MIT", | ||
@@ -5,0 +5,0 @@ "description": "Clerk.dev Types", |
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
84446
1257