@firebase/auth
Version:
The Firebase Authenticaton component of the Firebase JS SDK.
64 lines (63 loc) • 3.04 kB
TypeScript
/**
* @license
* Copyright 2022 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import { RecaptchaActionName, RecaptchaAuthProvider } from '../../api';
import { Auth } from '../../model/public_types';
import { AuthInternal } from '../../model/auth';
export declare const RECAPTCHA_ENTERPRISE_VERIFIER_TYPE = "recaptcha-enterprise";
export declare const FAKE_TOKEN = "NO_RECAPTCHA";
export declare const RECAPTCHA_ENTERPRISE_ONLOAD_CALLBACK_NAME = "onFirebaseAuthREInstanceReady";
declare global {
interface Window {
[RECAPTCHA_ENTERPRISE_ONLOAD_CALLBACK_NAME]: () => void;
}
}
export declare class RecaptchaEnterpriseVerifier {
/**
* Identifies the type of application verifier (e.g. "recaptcha-enterprise").
*/
readonly type = "recaptcha-enterprise";
private readonly auth;
/**
* Deferred that resolves when script tag has been injected onto the page
* and the script is ready (grecaptcha.ready() and script.onload are not
* reliable indicators, so this resolves when the global
* `window[RECAPTCHA_ENTERPRISE_ONLOAD_CALLBACK_NAME]()` callback provided to the recaptcha url param "onload"
* is triggered).
* As a static variable this is applied to all instances of the class.
* This will cause an error if users try to create multiple RecaptchaVerifiers
* with different Recaptcha Enterprise sitekeys, which should be an
* unuspported use case.
*/
private static scriptInjectionDeferred;
/**
*
* @param authExtern - The corresponding Firebase {@link Auth} instance.
*
*/
constructor(authExtern: Auth);
/**
* Executes the verification process.
*
* @returns A Promise for a token that can be used to assert the validity of a request.
*/
verify(action?: string, forceRefresh?: boolean): Promise<string>;
}
export declare function injectRecaptchaFields<T extends object>(auth: AuthInternal, request: T, action: RecaptchaActionName, isCaptchaResp?: boolean, isFakeToken?: boolean): Promise<T>;
type ActionMethod<TRequest, TResponse> = (auth: AuthInternal, request: TRequest) => Promise<TResponse>;
export declare function handleRecaptchaFlow<TRequest extends object, TResponse>(authInstance: AuthInternal, request: TRequest, actionName: RecaptchaActionName, actionMethod: ActionMethod<TRequest, TResponse>, recaptchaAuthProvider: RecaptchaAuthProvider): Promise<TResponse>;
export declare function _initializeRecaptchaConfig(auth: Auth): Promise<void>;
export {};