supertokens-auth-react
Version:
ReactJS SDK that provides login functionality with SuperTokens.
88 lines (87 loc) • 3.32 kB
TypeScript
/// <reference types="react" />
import { RecipeInterface } from "supertokens-web-js/recipe/multifactorauth";
import { GetRedirectionURLContext, PreAPIHookContext, OnHandleEventContext } from "./types";
import { UserInput, FactorIds } from "./types";
import type { Navigate, UserContext } from "../../types";
import type { RecipeFunctionOptions } from "supertokens-web-js/recipe/multifactorauth";
import type { MFAFactorInfo } from "supertokens-web-js/recipe/multifactorauth/types";
export default class Wrapper {
static MultiFactorAuthClaim: import("./multiFactorAuthClaim").MultiFactorAuthClaimClass;
static FactorIds: {
readonly EMAILPASSWORD: "emailpassword";
readonly OTP_EMAIL: "otp-email";
readonly OTP_PHONE: "otp-phone";
readonly LINK_EMAIL: "link-email";
readonly LINK_PHONE: "link-phone";
readonly THIRDPARTY: "thirdparty";
readonly TOTP: "totp";
readonly WEBAUTHN: "webauthn";
};
static init(
config?: UserInput
): import("../../types").RecipeInitResult<
GetRedirectionURLContext,
"GET_MFA_INFO",
OnHandleEventContext,
import("./types").NormalisedConfig
>;
static resyncSessionAndFetchMFAInfo(input?: {
userContext?: UserContext;
options?: RecipeFunctionOptions;
}): Promise<{
status: "OK";
factors: MFAFactorInfo;
emails: Record<string, string[] | undefined>;
phoneNumbers: Record<string, string[] | undefined>;
fetchResponse: Response;
}>;
static redirectToFactor(input: {
factorId: string;
forceSetup?: boolean;
stepUp?: boolean;
redirectBack?: boolean;
navigate?: Navigate;
userContext?: UserContext;
}): Promise<void>;
static redirectToFactorChooser(input: {
redirectBack?: boolean;
nextFactorOptions?: string[];
stepUp?: boolean;
navigate?: Navigate;
userContext?: UserContext;
}): Promise<void>;
static getSecondaryFactors(input: {
userContext?: UserContext;
}): import("./types").SecondaryFactorRedirectionInfo[];
static ComponentsOverrideProvider: import("react").FC<
import("react").PropsWithChildren<{
components: import("./types").ComponentOverrideMap;
}>
>;
}
declare const init: typeof Wrapper.init;
declare const resyncSessionAndFetchMFAInfo: typeof Wrapper.resyncSessionAndFetchMFAInfo;
declare const redirectToFactor: typeof Wrapper.redirectToFactor;
declare const redirectToFactorChooser: typeof Wrapper.redirectToFactorChooser;
declare const getSecondaryFactors: typeof Wrapper.getSecondaryFactors;
declare const MultiFactorAuthComponentsOverrideProvider: import("react").FC<
import("react").PropsWithChildren<{
components: import("./types").ComponentOverrideMap;
}>
>;
declare const MultiFactorAuthClaim: import("./multiFactorAuthClaim").MultiFactorAuthClaimClass;
export {
init,
resyncSessionAndFetchMFAInfo,
redirectToFactor,
redirectToFactorChooser,
getSecondaryFactors,
MultiFactorAuthComponentsOverrideProvider,
GetRedirectionURLContext,
PreAPIHookContext as PreAPIHookContext,
OnHandleEventContext,
UserInput,
RecipeInterface,
MultiFactorAuthClaim,
FactorIds,
};