@niledatabase/react 5.1.0 → 5.2.0-alpha.0

package/dist/index.d.mts

@@ -283,6 +283,71 @@ declare function SignedOut({ children, session: startSession, ...props }: Sessio
     className?: string;
 }): React__default.JSX.Element | null;
 
+type MfaMethod = 'authenticator' | 'email';
+type ChallengeScope = 'setup' | 'challenge';
+type AuthenticatorSetup = {
+    method: 'authenticator';
+    token: string;
+    scope: ChallengeScope;
+    otpauthUrl?: string;
+    secret?: string;
+    recoveryKeys?: string[];
+};
+type EmailSetup = {
+    method: 'email';
+    token: string;
+    scope: ChallengeScope;
+    maskedEmail?: string;
+};
+type EnrollMfaProps = {
+    enrolled?: boolean;
+    enrolledMethod?: MfaMethod | null;
+    onRedirect?: (url: string) => void;
+    onChallengeRedirect?: (params: ChallengeRedirect) => void;
+};
+type ChallengeRedirect = {
+    token: string;
+    method: MfaMethod;
+    scope: ChallengeScope;
+    destination?: string;
+};
+type MfaSetup = AuthenticatorSetup | EmailSetup;
+type AuthenticatorSetupProps = {
+    setup: AuthenticatorSetup;
+    onError: (message: string | null) => void;
+    onSuccess: (scope: 'setup' | 'challenge') => void;
+};
+type EnrollmentError = 'setup' | 'disable' | 'parseSetup' | 'parseDisable' | null;
+type UseMfaEnrollmentOptions = {
+    method: MfaMethod;
+    currentMethod: MfaMethod | null;
+    onRedirect?: (url: string) => void;
+    onChallengeRedirect?: (params: ChallengeRedirect) => void;
+};
+type UseMfaEnrollmentResult<TSetup extends MfaSetup> = {
+    setup: TSetup | null;
+    loading: boolean;
+    errorType: EnrollmentError;
+    startSetup: () => Promise<void>;
+    startDisable: () => Promise<void>;
+};
+
+declare const useMultiFactor: ({ method, currentMethod, onRedirect, onChallengeRedirect, }: UseMfaEnrollmentOptions) => UseMfaEnrollmentResult<MfaSetup>;
+
+declare function SetupAuthenticator({ setup, onError, onSuccess, }: AuthenticatorSetupProps): React__default.JSX.Element;
+
+declare function SetupEmail({ setup, onSuccess, }: {
+    setup: EmailSetup;
+    onSuccess: (scope: 'setup' | 'challenge') => void;
+}): React__default.JSX.Element;
+
+declare function ChallengeContent({ payload, message, isEnrolled, onSuccess, }: {
+    payload: MfaSetup;
+    message?: string;
+    isEnrolled?: boolean;
+    onSuccess?: (scope: 'setup' | 'challenge') => void;
+}): React__default.JSX.Element;
+
 type Tenant = {
     id: string;
     name: string;
@@ -322,6 +387,7 @@ interface User {
     created: string;
     updated?: string;
     emailVerified?: string | null;
+    multiFactor?: string | null;
     tenants: string[];
 }
 
@@ -370,4 +436,4 @@ declare const Email: ({ hide }: {
 }) => React$1.JSX.Element;
 declare const Password: () => React$1.JSX.Element;
 
-export { AzureSignInButton as Azure, DiscordSignInButton as Discord, Email, EmailSigningIn as EmailSignIn, EmailSignInButton, GitHubSignInButton as GitHub, GoogleSSOButton as Google, HubSpotSignInButton as HubSpot, LinkedInSignInButton as LinkedIn, OktaSignInButton as Okta, Password, ResetPasswordForm as PasswordResetForm, ResetPasswordForm$1 as PasswordResetRequestForm, SessionContext, SessionProvider, SigningIn as SignInForm, SignOutButton, SigningUp as SignUpForm, SignedIn, SignedOut, SlackSignInButton as Slack, TenantSelector, UserInfo, XSignInButton as X, useEmailSignIn, useMe, useResetPassword, useSession, useSignIn, useSignUp, useTenantId, useTenants };
+export { type AuthenticatorSetup, AzureSignInButton as Azure, type ChallengeRedirect, DiscordSignInButton as Discord, Email, type EmailSetup, EmailSigningIn as EmailSignIn, EmailSignInButton, type EnrollMfaProps, type EnrollmentError, GitHubSignInButton as GitHub, GoogleSSOButton as Google, HubSpotSignInButton as HubSpot, LinkedInSignInButton as LinkedIn, type MfaMethod, type MfaSetup, SetupAuthenticator as MultiFactorAuthenticator, ChallengeContent as MultiFactorChallenge, SetupEmail as MultiFactorEmail, OktaSignInButton as Okta, Password, ResetPasswordForm as PasswordResetForm, ResetPasswordForm$1 as PasswordResetRequestForm, SessionContext, SessionProvider, SigningIn as SignInForm, SignOutButton, SigningUp as SignUpForm, SignedIn, SignedOut, SlackSignInButton as Slack, TenantSelector, UserInfo, XSignInButton as X, useEmailSignIn, useMe, useMultiFactor, useResetPassword, useSession, useSignIn, useSignUp, useTenantId, useTenants };

package/dist/index.d.ts

@@ -283,6 +283,71 @@ declare function SignedOut({ children, session: startSession, ...props }: Sessio
     className?: string;
 }): React__default.JSX.Element | null;
 
+type MfaMethod = 'authenticator' | 'email';
+type ChallengeScope = 'setup' | 'challenge';
+type AuthenticatorSetup = {
+    method: 'authenticator';
+    token: string;
+    scope: ChallengeScope;
+    otpauthUrl?: string;
+    secret?: string;
+    recoveryKeys?: string[];
+};
+type EmailSetup = {
+    method: 'email';
+    token: string;
+    scope: ChallengeScope;
+    maskedEmail?: string;
+};
+type EnrollMfaProps = {
+    enrolled?: boolean;
+    enrolledMethod?: MfaMethod | null;
+    onRedirect?: (url: string) => void;
+    onChallengeRedirect?: (params: ChallengeRedirect) => void;
+};
+type ChallengeRedirect = {
+    token: string;
+    method: MfaMethod;
+    scope: ChallengeScope;
+    destination?: string;
+};
+type MfaSetup = AuthenticatorSetup | EmailSetup;
+type AuthenticatorSetupProps = {
+    setup: AuthenticatorSetup;
+    onError: (message: string | null) => void;
+    onSuccess: (scope: 'setup' | 'challenge') => void;
+};
+type EnrollmentError = 'setup' | 'disable' | 'parseSetup' | 'parseDisable' | null;
+type UseMfaEnrollmentOptions = {
+    method: MfaMethod;
+    currentMethod: MfaMethod | null;
+    onRedirect?: (url: string) => void;
+    onChallengeRedirect?: (params: ChallengeRedirect) => void;
+};
+type UseMfaEnrollmentResult<TSetup extends MfaSetup> = {
+    setup: TSetup | null;
+    loading: boolean;
+    errorType: EnrollmentError;
+    startSetup: () => Promise<void>;
+    startDisable: () => Promise<void>;
+};
+
+declare const useMultiFactor: ({ method, currentMethod, onRedirect, onChallengeRedirect, }: UseMfaEnrollmentOptions) => UseMfaEnrollmentResult<MfaSetup>;
+
+declare function SetupAuthenticator({ setup, onError, onSuccess, }: AuthenticatorSetupProps): React__default.JSX.Element;
+
+declare function SetupEmail({ setup, onSuccess, }: {
+    setup: EmailSetup;
+    onSuccess: (scope: 'setup' | 'challenge') => void;
+}): React__default.JSX.Element;
+
+declare function ChallengeContent({ payload, message, isEnrolled, onSuccess, }: {
+    payload: MfaSetup;
+    message?: string;
+    isEnrolled?: boolean;
+    onSuccess?: (scope: 'setup' | 'challenge') => void;
+}): React__default.JSX.Element;
+
 type Tenant = {
     id: string;
     name: string;
@@ -322,6 +387,7 @@ interface User {
     created: string;
     updated?: string;
     emailVerified?: string | null;
+    multiFactor?: string | null;
     tenants: string[];
 }
 
@@ -370,4 +436,4 @@ declare const Email: ({ hide }: {
 }) => React$1.JSX.Element;
 declare const Password: () => React$1.JSX.Element;
 
-export { AzureSignInButton as Azure, DiscordSignInButton as Discord, Email, EmailSigningIn as EmailSignIn, EmailSignInButton, GitHubSignInButton as GitHub, GoogleSSOButton as Google, HubSpotSignInButton as HubSpot, LinkedInSignInButton as LinkedIn, OktaSignInButton as Okta, Password, ResetPasswordForm as PasswordResetForm, ResetPasswordForm$1 as PasswordResetRequestForm, SessionContext, SessionProvider, SigningIn as SignInForm, SignOutButton, SigningUp as SignUpForm, SignedIn, SignedOut, SlackSignInButton as Slack, TenantSelector, UserInfo, XSignInButton as X, useEmailSignIn, useMe, useResetPassword, useSession, useSignIn, useSignUp, useTenantId, useTenants };
+export { type AuthenticatorSetup, AzureSignInButton as Azure, type ChallengeRedirect, DiscordSignInButton as Discord, Email, type EmailSetup, EmailSigningIn as EmailSignIn, EmailSignInButton, type EnrollMfaProps, type EnrollmentError, GitHubSignInButton as GitHub, GoogleSSOButton as Google, HubSpotSignInButton as HubSpot, LinkedInSignInButton as LinkedIn, type MfaMethod, type MfaSetup, SetupAuthenticator as MultiFactorAuthenticator, ChallengeContent as MultiFactorChallenge, SetupEmail as MultiFactorEmail, OktaSignInButton as Okta, Password, ResetPasswordForm as PasswordResetForm, ResetPasswordForm$1 as PasswordResetRequestForm, SessionContext, SessionProvider, SigningIn as SignInForm, SignOutButton, SigningUp as SignUpForm, SignedIn, SignedOut, SlackSignInButton as Slack, TenantSelector, UserInfo, XSignInButton as X, useEmailSignIn, useMe, useMultiFactor, useResetPassword, useSession, useSignIn, useSignUp, useTenantId, useTenants };