@firebase/auth 1.7.9 → 1.8.0

package/dist/esm5/src/platform_browser/recaptcha/recaptcha_loader.d.ts

@@ -1,49 +0,0 @@
-/**
- * @license
- * Copyright 2020 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 { AuthInternal } from '../../model/auth';
-import { Recaptcha } from './recaptcha';
-export declare const _JSLOAD_CALLBACK: string;
-/**
- * We need to mark this interface as internal explicitly to exclude it in the public typings, because
- * it references AuthInternal which has a circular dependency with UserInternal.
- *
- * @internal
- */
-export interface ReCaptchaLoader {
-    load(auth: AuthInternal, hl?: string): Promise<Recaptcha>;
-    clearedOneInstance(): void;
-}
-/**
- * Loader for the GReCaptcha library. There should only ever be one of this.
- */
-export declare class ReCaptchaLoaderImpl implements ReCaptchaLoader {
-    private hostLanguage;
-    private counter;
-    /**
-     * Check for `render()` method. `window.grecaptcha` will exist if the Enterprise
-     * version of the ReCAPTCHA script was loaded by someone else (e.g. App Check) but
-     * `window.grecaptcha.render()` will not. Another load will add it.
-     */
-    private readonly librarySeparatelyLoaded;
-    load(auth: AuthInternal, hl?: string): Promise<Recaptcha>;
-    clearedOneInstance(): void;
-    private shouldResolveImmediately;
-}
-export declare class MockReCaptchaLoaderImpl implements ReCaptchaLoader {
-    load(auth: AuthInternal): Promise<Recaptcha>;
-    clearedOneInstance(): void;
-}

package/dist/esm5/src/platform_browser/recaptcha/recaptcha_loader.test.d.ts

@@ -1,17 +0,0 @@
-/**
- * @license
- * Copyright 2020 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.
- */
-export {};

package/dist/esm5/src/platform_browser/recaptcha/recaptcha_mock.d.ts

@@ -1,66 +0,0 @@
-/**
- * @license
- * Copyright 2020 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 { AuthInternal } from '../../model/auth';
-import { RecaptchaParameters } from '../../model/public_types';
-import { Recaptcha, GreCAPTCHATopLevel, GreCAPTCHARenderOption, GreCAPTCHA } from './recaptcha';
-export declare const _SOLVE_TIME_MS = 500;
-export declare const _EXPIRATION_TIME_MS = 60000;
-export declare const _WIDGET_ID_START = 1000000000000;
-export interface Widget {
-    getResponse: () => string | null;
-    delete: () => void;
-    execute: () => void;
-}
-export declare class MockReCaptcha implements Recaptcha {
-    private readonly auth;
-    private counter;
-    _widgets: Map<number, Widget>;
-    constructor(auth: AuthInternal);
-    render(container: string | HTMLElement, parameters?: RecaptchaParameters): number;
-    reset(optWidgetId?: number): void;
-    getResponse(optWidgetId?: number): string;
-    execute(optWidgetId?: number | string): Promise<string>;
-}
-export declare class MockGreCAPTCHATopLevel implements GreCAPTCHATopLevel {
-    enterprise: GreCAPTCHA;
-    ready(callback: () => void): void;
-    execute(_siteKey: string, _options: {
-        action: string;
-    }): Promise<string>;
-    render(_container: string | HTMLElement, _parameters: GreCAPTCHARenderOption): string;
-}
-export declare class MockGreCAPTCHA implements GreCAPTCHA {
-    ready(callback: () => void): void;
-    execute(_siteKey: string, _options: {
-        action: string;
-    }): Promise<string>;
-    render(_container: string | HTMLElement, _parameters: GreCAPTCHARenderOption): string;
-}
-export declare class MockWidget {
-    private readonly params;
-    private readonly container;
-    private readonly isVisible;
-    private timerId;
-    private deleted;
-    private responseToken;
-    private readonly clickHandler;
-    constructor(containerOrId: string | HTMLElement, appName: string, params: RecaptchaParameters);
-    getResponse(): string | null;
-    delete(): void;
-    execute(): void;
-    private checkIfDeleted;
-}

package/dist/esm5/src/platform_browser/recaptcha/recaptcha_mock.test.d.ts

@@ -1,17 +0,0 @@
-/**
- * @license
- * Copyright 2020 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.
- */
-export {};

package/dist/esm5/src/platform_browser/recaptcha/recaptcha_verifier.d.ts

@@ -1,92 +0,0 @@
-/**
- * @license
- * Copyright 2020 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 { Auth, RecaptchaParameters } from '../../model/public_types';
-import { ApplicationVerifierInternal } from '../../model/application_verifier';
-import { ReCaptchaLoader } from './recaptcha_loader';
-export declare const RECAPTCHA_VERIFIER_TYPE = "recaptcha";
-/**
- * An {@link https://www.google.com/recaptcha/ | reCAPTCHA}-based application verifier.
- *
- * @remarks
- * `RecaptchaVerifier` does not work in a Node.js environment.
- *
- * @public
- */
-export declare class RecaptchaVerifier implements ApplicationVerifierInternal {
-    private readonly parameters;
-    /**
-     * The application verifier type.
-     *
-     * @remarks
-     * For a reCAPTCHA verifier, this is 'recaptcha'.
-     */
-    readonly type = "recaptcha";
-    private destroyed;
-    private widgetId;
-    private readonly container;
-    private readonly isInvisible;
-    private readonly tokenChangeListeners;
-    private renderPromise;
-    private readonly auth;
-    /** @internal */
-    readonly _recaptchaLoader: ReCaptchaLoader;
-    private recaptcha;
-    /**
-     * @param authExtern - The corresponding Firebase {@link Auth} instance.
-     *
-     * @param containerOrId - The reCAPTCHA container parameter.
-     *
-     * @remarks
-     * This has different meaning depending on whether the reCAPTCHA is hidden or visible. For a
-     * visible reCAPTCHA the container must be empty. If a string is used, it has to correspond to
-     * an element ID. The corresponding element must also must be in the DOM at the time of
-     * initialization.
-     *
-     * @param parameters - The optional reCAPTCHA parameters.
-     *
-     * @remarks
-     * Check the reCAPTCHA docs for a comprehensive list. All parameters are accepted except for
-     * the sitekey. Firebase Auth backend provisions a reCAPTCHA for each project and will
-     * configure this upon rendering. For an invisible reCAPTCHA, a size key must have the value
-     * 'invisible'.
-     */
-    constructor(authExtern: Auth, containerOrId: HTMLElement | string, parameters?: RecaptchaParameters);
-    /**
-     * Waits for the user to solve the reCAPTCHA and resolves with the reCAPTCHA token.
-     *
-     * @returns A Promise for the reCAPTCHA token.
-     */
-    verify(): Promise<string>;
-    /**
-     * Renders the reCAPTCHA widget on the page.
-     *
-     * @returns A Promise that resolves with the reCAPTCHA widget ID.
-     */
-    render(): Promise<number>;
-    /** @internal */
-    _reset(): void;
-    /**
-     * Clears the reCAPTCHA widget from the page and destroys the instance.
-     */
-    clear(): void;
-    private validateStartingState;
-    private makeTokenCallback;
-    private assertNotDestroyed;
-    private makeRenderPromise;
-    private init;
-    private getAssertedRecaptcha;
-}

package/dist/esm5/src/platform_browser/recaptcha/recaptcha_verifier.test.d.ts

@@ -1,17 +0,0 @@
-/**
- * @license
- * Copyright 2020 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.
- */
-export {};

package/dist/esm5/src/platform_browser/strategies/phone.d.ts

@@ -1,112 +0,0 @@
-/**
- * @license
- * Copyright 2020 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 { ApplicationVerifier, Auth, ConfirmationResult, PhoneInfoOptions, User } from '../../model/public_types';
-import { ApplicationVerifierInternal } from '../../model/application_verifier';
-import { PhoneAuthCredential } from '../../core/credentials/phone';
-import { AuthInternal } from '../../model/auth';
-/**
- * Asynchronously signs in using a phone number.
- *
- * @remarks
- * This method sends a code via SMS to the given
- * phone number, and returns a {@link ConfirmationResult}. After the user
- * provides the code sent to their phone, call {@link ConfirmationResult.confirm}
- * with the code to sign the user in.
- *
- * For abuse prevention, this method also requires a {@link ApplicationVerifier}.
- * This SDK includes a reCAPTCHA-based implementation, {@link RecaptchaVerifier}.
- * This function can work on other platforms that do not support the
- * {@link RecaptchaVerifier} (like React Native), but you need to use a
- * third-party {@link ApplicationVerifier} implementation.
- *
- * This method does not work in a Node.js environment or with {@link Auth} instances created with a
- * {@link @firebase/app#FirebaseServerApp}.
- *
- * @example
- * ```javascript
- * // 'recaptcha-container' is the ID of an element in the DOM.
- * const applicationVerifier = new firebase.auth.RecaptchaVerifier('recaptcha-container');
- * const confirmationResult = await signInWithPhoneNumber(auth, phoneNumber, applicationVerifier);
- * // Obtain a verificationCode from the user.
- * const credential = await confirmationResult.confirm(verificationCode);
- * ```
- *
- * @param auth - The {@link Auth} instance.
- * @param phoneNumber - The user's phone number in E.164 format (e.g. +16505550101).
- * @param appVerifier - The {@link ApplicationVerifier}.
- *
- * @public
- */
-export declare function signInWithPhoneNumber(auth: Auth, phoneNumber: string, appVerifier: ApplicationVerifier): Promise<ConfirmationResult>;
-/**
- * Links the user account with the given phone number.
- *
- * @remarks
- * This method does not work in a Node.js environment.
- *
- * @param user - The user.
- * @param phoneNumber - The user's phone number in E.164 format (e.g. +16505550101).
- * @param appVerifier - The {@link ApplicationVerifier}.
- *
- * @public
- */
-export declare function linkWithPhoneNumber(user: User, phoneNumber: string, appVerifier: ApplicationVerifier): Promise<ConfirmationResult>;
-/**
- * Re-authenticates a user using a fresh phone credential.
- *
- * @remarks
- * Use before operations such as {@link updatePassword} that require tokens from recent sign-in attempts.
- *
- * This method does not work in a Node.js environment or on any {@link User} signed in by
- * {@link Auth} instances created with a {@link @firebase/app#FirebaseServerApp}.
- *
- * @param user - The user.
- * @param phoneNumber - The user's phone number in E.164 format (e.g. +16505550101).
- * @param appVerifier - The {@link ApplicationVerifier}.
- *
- * @public
- */
-export declare function reauthenticateWithPhoneNumber(user: User, phoneNumber: string, appVerifier: ApplicationVerifier): Promise<ConfirmationResult>;
-/**
- * Returns a verification ID to be used in conjunction with the SMS code that is sent.
- *
- */
-export declare function _verifyPhoneNumber(auth: AuthInternal, options: PhoneInfoOptions | string, verifier: ApplicationVerifierInternal): Promise<string>;
-/**
- * Updates the user's phone number.
- *
- * @remarks
- * This method does not work in a Node.js environment or on any {@link User} signed in by
- * {@link Auth} instances created with a {@link @firebase/app#FirebaseServerApp}.
- *
- * @example
- * ```
- * // 'recaptcha-container' is the ID of an element in the DOM.
- * const applicationVerifier = new RecaptchaVerifier('recaptcha-container');
- * const provider = new PhoneAuthProvider(auth);
- * const verificationId = await provider.verifyPhoneNumber('+16505550101', applicationVerifier);
- * // Obtain the verificationCode from the user.
- * const phoneCredential = PhoneAuthProvider.credential(verificationId, verificationCode);
- * await updatePhoneNumber(user, phoneCredential);
- * ```
- *
- * @param user - The user.
- * @param credential - A credential authenticating the new phone number.
- *
- * @public
- */
-export declare function updatePhoneNumber(user: User, credential: PhoneAuthCredential): Promise<void>;

package/dist/esm5/src/platform_browser/strategies/phone.test.d.ts

@@ -1,17 +0,0 @@
-/**
- * @license
- * Copyright 2020 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.
- */
-export {};

package/dist/esm5/src/platform_browser/strategies/popup.d.ts

@@ -1,109 +0,0 @@
-/**
- * @license
- * Copyright 2020 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 { Auth, AuthProvider, PopupRedirectResolver, User, UserCredential } from '../../model/public_types';
-import { Delay } from '../../core/util/delay';
-export declare const enum _Timeout {
-    AUTH_EVENT = 8000
-}
-export declare const _POLL_WINDOW_CLOSE_TIMEOUT: Delay;
-/**
- * Authenticates a Firebase client using a popup-based OAuth authentication flow.
- *
- * @remarks
- * If succeeds, returns the signed in user along with the provider's credential. If sign in was
- * unsuccessful, returns an error object containing additional information about the error.
- *
- * This method does not work in a Node.js environment or with {@link Auth} instances created with a
- * {@link @firebase/app#FirebaseServerApp}.
- *
- * @example
- * ```javascript
- * // Sign in using a popup.
- * const provider = new FacebookAuthProvider();
- * const result = await signInWithPopup(auth, provider);
- *
- * // The signed-in user info.
- * const user = result.user;
- * // This gives you a Facebook Access Token.
- * const credential = provider.credentialFromResult(auth, result);
- * const token = credential.accessToken;
- * ```
- *
- * @param auth - The {@link Auth} instance.
- * @param provider - The provider to authenticate. The provider has to be an {@link OAuthProvider}.
- * Non-OAuth providers like {@link EmailAuthProvider} will throw an error.
- * @param resolver - An instance of {@link PopupRedirectResolver}, optional
- * if already supplied to {@link initializeAuth} or provided by {@link getAuth}.
- *
- * @public
- */
-export declare function signInWithPopup(auth: Auth, provider: AuthProvider, resolver?: PopupRedirectResolver): Promise<UserCredential>;
-/**
- * Reauthenticates the current user with the specified {@link OAuthProvider} using a pop-up based
- * OAuth flow.
- *
- * @remarks
- * If the reauthentication is successful, the returned result will contain the user and the
- * provider's credential.
- *
- * This method does not work in a Node.js environment or on any {@link User} signed in by
- * {@link Auth} instances created with a {@link @firebase/app#FirebaseServerApp}.
- *
- * @example
- * ```javascript
- * // Sign in using a popup.
- * const provider = new FacebookAuthProvider();
- * const result = await signInWithPopup(auth, provider);
- * // Reauthenticate using a popup.
- * await reauthenticateWithPopup(result.user, provider);
- * ```
- *
- * @param user - The user.
- * @param provider - The provider to authenticate. The provider has to be an {@link OAuthProvider}.
- * Non-OAuth providers like {@link EmailAuthProvider} will throw an error.
- * @param resolver - An instance of {@link PopupRedirectResolver}, optional
- * if already supplied to {@link initializeAuth} or provided by {@link getAuth}.
- *
- * @public
- */
-export declare function reauthenticateWithPopup(user: User, provider: AuthProvider, resolver?: PopupRedirectResolver): Promise<UserCredential>;
-/**
- * Links the authenticated provider to the user account using a pop-up based OAuth flow.
- *
- * @remarks
- * If the linking is successful, the returned result will contain the user and the provider's credential.
- *
- * This method does not work in a Node.js environment.
- *
- * @example
- * ```javascript
- * // Sign in using some other provider.
- * const result = await signInWithEmailAndPassword(auth, email, password);
- * // Link using a popup.
- * const provider = new FacebookAuthProvider();
- * await linkWithPopup(result.user, provider);
- * ```
- *
- * @param user - The user.
- * @param provider - The provider to authenticate. The provider has to be an {@link OAuthProvider}.
- * Non-OAuth providers like {@link EmailAuthProvider} will throw an error.
- * @param resolver - An instance of {@link PopupRedirectResolver}, optional
- * if already supplied to {@link initializeAuth} or provided by {@link getAuth}.
- *
- * @public
- */
-export declare function linkWithPopup(user: User, provider: AuthProvider, resolver?: PopupRedirectResolver): Promise<UserCredential>;

package/dist/esm5/src/platform_browser/strategies/popup.test.d.ts

@@ -1,17 +0,0 @@
-/**
- * @license
- * Copyright 2020 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.
- */
-export {};