@supertokens-plugins/captcha-react

Public root exports for @supertokens-plugins/captcha-react 0.3.1.

Package version: 0.3.1

Generated from the packed release’s root declaration, ./dist/index.d.ts. Only exports reachable from that root are listed. See the immutable release source.

Public root exports

default

Published from the emitted _default declaration.

Root export:

export { PLUGIN_ID, type SuperTokensPluginCaptchaConfig, _default as default, init, useCaptcha, useCaptchaInputContainer };

Resolved declaration:

import * as supertokens_auth_react_lib_build_types from 'supertokens-auth-react/lib/build/types';
declare const _default: {
    init: (config: SuperTokensPluginCaptchaConfig) => supertokens_auth_react_lib_build_types.SuperTokensPlugin;
};

init

Root export:

export { PLUGIN_ID, type SuperTokensPluginCaptchaConfig, _default as default, init, useCaptcha, useCaptchaInputContainer };

Resolved declaration:

import { SuperTokensPlugin } from 'supertokens-auth-react/lib/build/types';
declare const init: (config: SuperTokensPluginCaptchaConfig) => SuperTokensPlugin;

PLUGIN_ID

Root export:

export { PLUGIN_ID, type SuperTokensPluginCaptchaConfig, _default as default, init, useCaptcha, useCaptchaInputContainer };

Resolved declaration:

declare const PLUGIN_ID = "supertokens-plugin-captcha";

SuperTokensPluginCaptchaConfig

Root export:

export { PLUGIN_ID, type SuperTokensPluginCaptchaConfig, _default as default, init, useCaptcha, useCaptchaInputContainer };

Resolved declaration:

type SuperTokensPluginCaptchaConfig = CaptchaConfig & {
    InputContainer?: React.ForwardRefExoticComponent<CaptchInputContainerProps & React.RefAttributes<HTMLDivElement>>;
    inputContainerId?: string | (() => Promise<string>);
};

useCaptcha

Root export:

export { PLUGIN_ID, type SuperTokensPluginCaptchaConfig, _default as default, init, useCaptcha, useCaptchaInputContainer };

Resolved declaration:

declare function useCaptcha(onError?: (error: string) => void): {
    state: CaptchaState;
    load: (configOverride?: Partial<SuperTokensPluginCaptchaConfig>) => Promise<true | undefined>;
    render: () => Promise<void>;
    containerId: string | (() => Promise<string>);
};

useCaptchaInputContainer

Root export:

export { PLUGIN_ID, type SuperTokensPluginCaptchaConfig, _default as default, init, useCaptcha, useCaptchaInputContainer };

Resolved declaration:

import * as react from 'react';
declare function useCaptchaInputContainer(): react.ForwardRefExoticComponent<{
    form: "EmailPasswordSignInForm" | "EmailPasswordSignUpForm" | "EmailPasswordResetPasswordEmail" | "EmailPasswordSubmitNewPassword" | "PasswordlessEmailForm" | "PasswordlessPhoneForm" | "PasswordlessEmailOrPhoneForm" | "PasswordlessEPComboEmailForm" | "PasswordlessEPComboEmailOrPhoneForm" | "PasswordlessUserInputForm";
} & react.HTMLAttributes<HTMLDivElement> & react.RefAttributes<HTMLDivElement>>;

Required signature types

These declarations are not additional package-root exports. They are included because the public signatures above depend on them.

CaptchaConfig

type CaptchaConfig = {
    type: "reCAPTCHAv3";
    captcha: ReCAPTCHAv3Config;
} | {
    type: "reCAPTCHAv2";
    captcha: ReCAPTCHAv2Config;
} | {
    type: "turnstile";
    captcha: TurnstileConfig;
};

CaptchaState

type CaptchaState = {
    error: string | undefined;
    token: string | undefined;
    isLoading: boolean;
    isRendering: boolean;
};

CaptchInputContainerProps

type CaptchInputContainerProps = {
    form: "EmailPasswordSignInForm" | "EmailPasswordSignUpForm" | "EmailPasswordResetPasswordEmail" | "EmailPasswordSubmitNewPassword" | "PasswordlessEmailForm" | "PasswordlessPhoneForm" | "PasswordlessEmailOrPhoneForm" | "PasswordlessEPComboEmailForm" | "PasswordlessEPComboEmailOrPhoneForm" | "PasswordlessUserInputForm";
} & React.HTMLAttributes<HTMLDivElement>;

ReCAPTCHAv2Config

type ReCAPTCHAv2Config = ReCaptchaV2.Parameters;

ReCAPTCHAv3Config

type ReCAPTCHAv3Config = {
    /**
     * Your sitekey.
     */
    sitekey: string;
    /**
     * The name of the action. Actions may only contain alphanumeric characters and slashes, and must not be user-specific.
     */
    action?: string;
};

TurnstileConfig

type TurnstileConfig = Turnstile.RenderParameters;