@firebase/auth 1.7.9 → 1.8.0

package/dist/esm5/src/core/persistence/persistence_user_manager.d.ts

@@ -1,45 +0,0 @@
-/**
- * @license
- * Copyright 2019 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 { ApiKey, AppName, AuthInternal } from '../../model/auth';
-import { UserInternal } from '../../model/user';
-import { PersistenceInternal } from '../persistence';
-export declare const enum KeyName {
-    AUTH_USER = "authUser",
-    AUTH_EVENT = "authEvent",
-    REDIRECT_USER = "redirectUser",
-    PERSISTENCE_USER = "persistence"
-}
-export declare const enum Namespace {
-    PERSISTENCE = "firebase"
-}
-export declare function _persistenceKeyName(key: string, apiKey: ApiKey, appName: AppName): string;
-export declare class PersistenceUserManager {
-    persistence: PersistenceInternal;
-    private readonly auth;
-    private readonly userKey;
-    private readonly fullUserKey;
-    private readonly fullPersistenceKey;
-    private readonly boundEventHandler;
-    private constructor();
-    setCurrentUser(user: UserInternal): Promise<void>;
-    getCurrentUser(): Promise<UserInternal | null>;
-    removeCurrentUser(): Promise<void>;
-    savePersistenceForRedirect(): Promise<void>;
-    setPersistence(newPersistence: PersistenceInternal): Promise<void>;
-    delete(): void;
-    static create(auth: AuthInternal, persistenceHierarchy: PersistenceInternal[], userKey?: KeyName): Promise<PersistenceUserManager>;
-}

package/dist/esm5/src/core/persistence/persistence_user_manager.test.d.ts

@@ -1,17 +0,0 @@
-/**
- * @license
- * Copyright 2019 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/core/providers/email.d.ts

@@ -1,83 +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 { AuthProvider } from '../../model/public_types';
-import { EmailAuthCredential } from '../credentials/email';
-/**
- * Provider for generating {@link EmailAuthCredential}.
- *
- * @public
- */
-export declare class EmailAuthProvider implements AuthProvider {
-    /**
-     * Always set to {@link ProviderId}.PASSWORD, even for email link.
-     */
-    static readonly PROVIDER_ID: 'password';
-    /**
-     * Always set to {@link SignInMethod}.EMAIL_PASSWORD.
-     */
-    static readonly EMAIL_PASSWORD_SIGN_IN_METHOD: 'password';
-    /**
-     * Always set to {@link SignInMethod}.EMAIL_LINK.
-     */
-    static readonly EMAIL_LINK_SIGN_IN_METHOD: 'emailLink';
-    /**
-     * Always set to {@link ProviderId}.PASSWORD, even for email link.
-     */
-    readonly providerId: "password";
-    /**
-     * Initialize an {@link AuthCredential} using an email and password.
-     *
-     * @example
-     * ```javascript
-     * const authCredential = EmailAuthProvider.credential(email, password);
-     * const userCredential = await signInWithCredential(auth, authCredential);
-     * ```
-     *
-     * @example
-     * ```javascript
-     * const userCredential = await signInWithEmailAndPassword(auth, email, password);
-     * ```
-     *
-     * @param email - Email address.
-     * @param password - User account password.
-     * @returns The auth provider credential.
-     */
-    static credential(email: string, password: string): EmailAuthCredential;
-    /**
-     * Initialize an {@link AuthCredential} using an email and an email link after a sign in with
-     * email link operation.
-     *
-     * @example
-     * ```javascript
-     * const authCredential = EmailAuthProvider.credentialWithLink(auth, email, emailLink);
-     * const userCredential = await signInWithCredential(auth, authCredential);
-     * ```
-     *
-     * @example
-     * ```javascript
-     * await sendSignInLinkToEmail(auth, email);
-     * // Obtain emailLink from user.
-     * const userCredential = await signInWithEmailLink(auth, email, emailLink);
-     * ```
-     *
-     * @param auth - The {@link Auth} instance used to verify the link.
-     * @param email - Email address.
-     * @param emailLink - Sign-in email link.
-     * @returns - The auth provider credential.
-     */
-    static credentialWithLink(email: string, emailLink: string): EmailAuthCredential;
-}

package/dist/esm5/src/core/providers/email.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/core/providers/facebook.d.ts

@@ -1,93 +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 { UserCredential } from '../../model/public_types';
-import { FirebaseError } from '@firebase/util';
-import { OAuthCredential } from '../credentials/oauth';
-import { BaseOAuthProvider } from './oauth';
-/**
- * Provider for generating an {@link OAuthCredential} for {@link ProviderId}.FACEBOOK.
- *
- * @example
- * ```javascript
- * // Sign in using a redirect.
- * const provider = new FacebookAuthProvider();
- * // Start a sign in process for an unauthenticated user.
- * provider.addScope('user_birthday');
- * await signInWithRedirect(auth, provider);
- * // This will trigger a full page redirect away from your app
- *
- * // After returning from the redirect when your app initializes you can obtain the result
- * const result = await getRedirectResult(auth);
- * if (result) {
- *   // This is the signed-in user
- *   const user = result.user;
- *   // This gives you a Facebook Access Token.
- *   const credential = FacebookAuthProvider.credentialFromResult(result);
- *   const token = credential.accessToken;
- * }
- * ```
- *
- * @example
- * ```javascript
- * // Sign in using a popup.
- * const provider = new FacebookAuthProvider();
- * provider.addScope('user_birthday');
- * const result = await signInWithPopup(auth, provider);
- *
- * // The signed-in user info.
- * const user = result.user;
- * // This gives you a Facebook Access Token.
- * const credential = FacebookAuthProvider.credentialFromResult(result);
- * const token = credential.accessToken;
- * ```
- *
- * @public
- */
-export declare class FacebookAuthProvider extends BaseOAuthProvider {
-    /** Always set to {@link SignInMethod}.FACEBOOK. */
-    static readonly FACEBOOK_SIGN_IN_METHOD: 'facebook.com';
-    /** Always set to {@link ProviderId}.FACEBOOK. */
-    static readonly PROVIDER_ID: 'facebook.com';
-    constructor();
-    /**
-     * Creates a credential for Facebook.
-     *
-     * @example
-     * ```javascript
-     * // `event` from the Facebook auth.authResponseChange callback.
-     * const credential = FacebookAuthProvider.credential(event.authResponse.accessToken);
-     * const result = await signInWithCredential(credential);
-     * ```
-     *
-     * @param accessToken - Facebook access token.
-     */
-    static credential(accessToken: string): OAuthCredential;
-    /**
-     * Used to extract the underlying {@link OAuthCredential} from a {@link UserCredential}.
-     *
-     * @param userCredential - The user credential.
-     */
-    static credentialFromResult(userCredential: UserCredential): OAuthCredential | null;
-    /**
-     * Used to extract the underlying {@link OAuthCredential} from a {@link AuthError} which was
-     * thrown during a sign-in, link, or reauthenticate operation.
-     *
-     * @param userCredential - The user credential.
-     */
-    static credentialFromError(error: FirebaseError): OAuthCredential | null;
-    private static credentialFromTaggedObject;
-}

package/dist/esm5/src/core/providers/facebook.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/core/providers/federated.d.ts

@@ -1,64 +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 { AuthProvider } from '../../model/public_types';
-/**
- * Map of OAuth Custom Parameters.
- *
- * @public
- */
-export declare type CustomParameters = Record<string, string>;
-/**
- * The base class for all Federated providers (OAuth (including OIDC), SAML).
- *
- * This class is not meant to be instantiated directly.
- *
- * @public
- */
-export declare abstract class FederatedAuthProvider implements AuthProvider {
-    readonly providerId: string;
-    /** @internal */
-    defaultLanguageCode: string | null;
-    /** @internal */
-    private customParameters;
-    /**
-     * Constructor for generic OAuth providers.
-     *
-     * @param providerId - Provider for which credentials should be generated.
-     */
-    constructor(providerId: string);
-    /**
-     * Set the language gode.
-     *
-     * @param languageCode - language code
-     */
-    setDefaultLanguage(languageCode: string | null): void;
-    /**
-     * Sets the OAuth custom parameters to pass in an OAuth request for popup and redirect sign-in
-     * operations.
-     *
-     * @remarks
-     * For a detailed list, check the reserved required OAuth 2.0 parameters such as `client_id`,
-     * `redirect_uri`, `scope`, `response_type`, and `state` are not allowed and will be ignored.
-     *
-     * @param customOAuthParameters - The custom OAuth parameters to pass in the OAuth request.
-     */
-    setCustomParameters(customOAuthParameters: CustomParameters): AuthProvider;
-    /**
-     * Retrieve the current list of {@link CustomParameters}.
-     */
-    getCustomParameters(): CustomParameters;
-}

package/dist/esm5/src/core/providers/federated.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/core/providers/github.d.ts

@@ -1,89 +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 { UserCredential } from '../../model/public_types';
-import { FirebaseError } from '@firebase/util';
-import { OAuthCredential } from '../credentials/oauth';
-import { BaseOAuthProvider } from './oauth';
-/**
- * Provider for generating an {@link OAuthCredential} for {@link ProviderId}.GITHUB.
- *
- * @remarks
- * GitHub requires an OAuth 2.0 redirect, so you can either handle the redirect directly, or use
- * the {@link signInWithPopup} handler:
- *
- * @example
- * ```javascript
- * // Sign in using a redirect.
- * const provider = new GithubAuthProvider();
- * // Start a sign in process for an unauthenticated user.
- * provider.addScope('repo');
- * await signInWithRedirect(auth, provider);
- * // This will trigger a full page redirect away from your app
- *
- * // After returning from the redirect when your app initializes you can obtain the result
- * const result = await getRedirectResult(auth);
- * if (result) {
- *   // This is the signed-in user
- *   const user = result.user;
- *   // This gives you a GitHub Access Token.
- *   const credential = GithubAuthProvider.credentialFromResult(result);
- *   const token = credential.accessToken;
- * }
- * ```
- *
- * @example
- * ```javascript
- * // Sign in using a popup.
- * const provider = new GithubAuthProvider();
- * provider.addScope('repo');
- * const result = await signInWithPopup(auth, provider);
- *
- * // The signed-in user info.
- * const user = result.user;
- * // This gives you a GitHub Access Token.
- * const credential = GithubAuthProvider.credentialFromResult(result);
- * const token = credential.accessToken;
- * ```
- * @public
- */
-export declare class GithubAuthProvider extends BaseOAuthProvider {
-    /** Always set to {@link SignInMethod}.GITHUB. */
-    static readonly GITHUB_SIGN_IN_METHOD: 'github.com';
-    /** Always set to {@link ProviderId}.GITHUB. */
-    static readonly PROVIDER_ID: 'github.com';
-    constructor();
-    /**
-     * Creates a credential for GitHub.
-     *
-     * @param accessToken - GitHub access token.
-     */
-    static credential(accessToken: string): OAuthCredential;
-    /**
-     * Used to extract the underlying {@link OAuthCredential} from a {@link UserCredential}.
-     *
-     * @param userCredential - The user credential.
-     */
-    static credentialFromResult(userCredential: UserCredential): OAuthCredential | null;
-    /**
-     * Used to extract the underlying {@link OAuthCredential} from a {@link AuthError} which was
-     * thrown during a sign-in, link, or reauthenticate operation.
-     *
-     * @param userCredential - The user credential.
-     */
-    static credentialFromError(error: FirebaseError): OAuthCredential | null;
-    private static credentialFromTaggedObject;
-}

package/dist/esm5/src/core/providers/github.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/core/providers/google.d.ts

@@ -1,96 +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 { UserCredential } from '../../model/public_types';
-import { FirebaseError } from '@firebase/util';
-import { OAuthCredential } from '../credentials/oauth';
-import { BaseOAuthProvider } from './oauth';
-/**
- * Provider for generating an {@link OAuthCredential} for {@link ProviderId}.GOOGLE.
- *
- * @example
- * ```javascript
- * // Sign in using a redirect.
- * const provider = new GoogleAuthProvider();
- * // Start a sign in process for an unauthenticated user.
- * provider.addScope('profile');
- * provider.addScope('email');
- * await signInWithRedirect(auth, provider);
- * // This will trigger a full page redirect away from your app
- *
- * // After returning from the redirect when your app initializes you can obtain the result
- * const result = await getRedirectResult(auth);
- * if (result) {
- *   // This is the signed-in user
- *   const user = result.user;
- *   // This gives you a Google Access Token.
- *   const credential = GoogleAuthProvider.credentialFromResult(result);
- *   const token = credential.accessToken;
- * }
- * ```
- *
- * @example
- * ```javascript
- * // Sign in using a popup.
- * const provider = new GoogleAuthProvider();
- * provider.addScope('profile');
- * provider.addScope('email');
- * const result = await signInWithPopup(auth, provider);
- *
- * // The signed-in user info.
- * const user = result.user;
- * // This gives you a Google Access Token.
- * const credential = GoogleAuthProvider.credentialFromResult(result);
- * const token = credential.accessToken;
- * ```
- *
- * @public
- */
-export declare class GoogleAuthProvider extends BaseOAuthProvider {
-    /** Always set to {@link SignInMethod}.GOOGLE. */
-    static readonly GOOGLE_SIGN_IN_METHOD: 'google.com';
-    /** Always set to {@link ProviderId}.GOOGLE. */
-    static readonly PROVIDER_ID: 'google.com';
-    constructor();
-    /**
-     * Creates a credential for Google. At least one of ID token and access token is required.
-     *
-     * @example
-     * ```javascript
-     * // \`googleUser\` from the onsuccess Google Sign In callback.
-     * const credential = GoogleAuthProvider.credential(googleUser.getAuthResponse().id_token);
-     * const result = await signInWithCredential(credential);
-     * ```
-     *
-     * @param idToken - Google ID token.
-     * @param accessToken - Google access token.
-     */
-    static credential(idToken?: string | null, accessToken?: string | null): OAuthCredential;
-    /**
-     * Used to extract the underlying {@link OAuthCredential} from a {@link UserCredential}.
-     *
-     * @param userCredential - The user credential.
-     */
-    static credentialFromResult(userCredential: UserCredential): OAuthCredential | null;
-    /**
-     * Used to extract the underlying {@link OAuthCredential} from a {@link AuthError} which was
-     * thrown during a sign-in, link, or reauthenticate operation.
-     *
-     * @param userCredential - The user credential.
-     */
-    static credentialFromError(error: FirebaseError): OAuthCredential | null;
-    private static credentialFromTaggedObject;
-}

package/dist/esm5/src/core/providers/google.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 {};