@depup/firebase__auth 1.12.1-depup.0

package/dist/web-extension-esm/src/platform_browser/persistence/local_storage.d.ts

@@ -0,0 +1,25 @@
+/**
+ * @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 { Persistence } from '../../model/public_types';
+export declare const _POLLING_INTERVAL_MS = 1000;
+/**
+ * An implementation of {@link Persistence} of type `LOCAL` using `localStorage`
+ * for the underlying storage.
+ *
+ * @public
+ */
+export declare const browserLocalPersistence: Persistence;

package/dist/web-extension-esm/src/platform_browser/persistence/session_storage.d.ts

@@ -0,0 +1,24 @@
+/**
+ * @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 { Persistence } from '../../model/public_types';
+/**
+ * An implementation of {@link Persistence} of `SESSION` using `sessionStorage`
+ * for the underlying storage.
+ *
+ * @public
+ */
+export declare const browserSessionPersistence: Persistence;

package/dist/web-extension-esm/src/platform_browser/popup_redirect.d.ts

@@ -0,0 +1,27 @@
+/**
+ * @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 { PopupRedirectResolver } from '../model/public_types';
+/**
+ * An implementation of {@link PopupRedirectResolver} suitable for browser
+ * based applications.
+ *
+ * @remarks
+ * This method does not work in a Node.js environment.
+ *
+ * @public
+ */
+export declare const browserPopupRedirectResolver: PopupRedirectResolver;

package/dist/web-extension-esm/src/platform_browser/providers/phone.d.ts

@@ -0,0 +1,154 @@
+/**
+ * @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, PhoneInfoOptions, ApplicationVerifier, UserCredential } from '../../model/public_types';
+import { PhoneAuthCredential } from '../../core/credentials/phone';
+import { AuthCredential } from '../../core';
+import { FirebaseError } from '@firebase/util';
+/**
+ * Provider for generating an {@link PhoneAuthCredential}.
+ *
+ * @remarks
+ * `PhoneAuthProvider` does not work in a Node.js environment.
+ *
+ * @example
+ * ```javascript
+ * // '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);
+ * const userCredential = await signInWithCredential(auth, phoneCredential);
+ * ```
+ *
+ * @public
+ */
+export declare class PhoneAuthProvider {
+    /** Always set to {@link ProviderId}.PHONE. */
+    static readonly PROVIDER_ID: 'phone';
+    /** Always set to {@link SignInMethod}.PHONE. */
+    static readonly PHONE_SIGN_IN_METHOD: 'phone';
+    /** Always set to {@link ProviderId}.PHONE. */
+    readonly providerId: "phone";
+    private readonly auth;
+    /**
+     * @param auth - The Firebase {@link Auth} instance in which sign-ins should occur.
+     *
+     */
+    constructor(auth: Auth);
+    /**
+     *
+     * Starts a phone number authentication flow by sending a verification code to the given phone
+     * number.
+     *
+     * @example
+     * ```javascript
+     * const provider = new PhoneAuthProvider(auth);
+     * const verificationId = await provider.verifyPhoneNumber(phoneNumber, applicationVerifier);
+     * // Obtain verificationCode from the user.
+     * const authCredential = PhoneAuthProvider.credential(verificationId, verificationCode);
+     * const userCredential = await signInWithCredential(auth, authCredential);
+     * ```
+     *
+     * @example
+     * An alternative flow is provided using the `signInWithPhoneNumber` method.
+     * ```javascript
+     * const confirmationResult = signInWithPhoneNumber(auth, phoneNumber, applicationVerifier);
+     * // Obtain verificationCode from the user.
+     * const userCredential = confirmationResult.confirm(verificationCode);
+     * ```
+     *
+     * @param phoneInfoOptions - The user's {@link PhoneInfoOptions}. The phone number should be in
+     * E.164 format (e.g. +16505550101).
+     * @param applicationVerifier - An {@link ApplicationVerifier}, which prevents
+     * requests from unauthorized clients. This SDK includes an implementation
+     * based on reCAPTCHA v2, {@link RecaptchaVerifier}. If you've enabled
+     * reCAPTCHA Enterprise bot protection in Enforce mode, this parameter is
+     * optional; in all other configurations, the parameter is required.
+     *
+     * @returns A Promise for a verification ID that can be passed to
+     * {@link PhoneAuthProvider.credential} to identify this flow.
+     */
+    verifyPhoneNumber(phoneOptions: PhoneInfoOptions | string, applicationVerifier?: ApplicationVerifier): Promise<string>;
+    /**
+     * Creates a phone auth credential, given the verification ID from
+     * {@link PhoneAuthProvider.verifyPhoneNumber} and the code that was sent to the user's
+     * mobile device.
+     *
+     * @example
+     * ```javascript
+     * const provider = new PhoneAuthProvider(auth);
+     * const verificationId = provider.verifyPhoneNumber(phoneNumber, applicationVerifier);
+     * // Obtain verificationCode from the user.
+     * const authCredential = PhoneAuthProvider.credential(verificationId, verificationCode);
+     * const userCredential = signInWithCredential(auth, authCredential);
+     * ```
+     *
+     * @example
+     * An alternative flow is provided using the `signInWithPhoneNumber` method.
+     * ```javascript
+     * const confirmationResult = await signInWithPhoneNumber(auth, phoneNumber, applicationVerifier);
+     * // Obtain verificationCode from the user.
+     * const userCredential = await confirmationResult.confirm(verificationCode);
+     * ```
+     *
+     * @param verificationId - The verification ID returned from {@link PhoneAuthProvider.verifyPhoneNumber}.
+     * @param verificationCode - The verification code sent to the user's mobile device.
+     *
+     * @returns The auth provider credential.
+     */
+    static credential(verificationId: string, verificationCode: string): PhoneAuthCredential;
+    /**
+     * Generates an {@link AuthCredential} from a {@link UserCredential}.
+     * @param userCredential - The user credential.
+     */
+    static credentialFromResult(userCredential: UserCredential): AuthCredential | null;
+    /**
+     * Returns an {@link AuthCredential} when passed an error.
+     *
+     * @remarks
+     *
+     * This method works for errors like
+     * `auth/account-exists-with-different-credentials`. This is useful for
+     * recovering when attempting to set a user's phone number but the number
+     * in question is already tied to another account. For example, the following
+     * code tries to update the current user's phone number, and if that
+     * fails, links the user with the account associated with that number:
+     *
+     * ```js
+     * const provider = new PhoneAuthProvider(auth);
+     * const verificationId = await provider.verifyPhoneNumber(number, verifier);
+     * try {
+     *   const code = ''; // Prompt the user for the verification code
+     *   await updatePhoneNumber(
+     *       auth.currentUser,
+     *       PhoneAuthProvider.credential(verificationId, code));
+     * } catch (e) {
+     *   if ((e as FirebaseError)?.code === 'auth/account-exists-with-different-credential') {
+     *     const cred = PhoneAuthProvider.credentialFromError(e);
+     *     await linkWithCredential(auth.currentUser, cred);
+     *   }
+     * }
+     *
+     * // At this point, auth.currentUser.phoneNumber === number.
+     * ```
+     *
+     * @param error - The error to generate a credential from.
+     */
+    static credentialFromError(error: FirebaseError): AuthCredential | null;
+    private static credentialFromTaggedObject;
+}

package/dist/web-extension-esm/src/platform_browser/recaptcha/recaptcha.d.ts

@@ -0,0 +1,78 @@
+/**
+ * @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 { RecaptchaParameters } from '../../model/public_types';
+import { GetRecaptchaConfigResponse, RecaptchaEnforcementProviderState } from '../../api/authentication/recaptcha';
+import { EnforcementState } from '../../api/index';
+export interface Recaptcha {
+    render: (container: HTMLElement, parameters: RecaptchaParameters) => number;
+    getResponse: (id: number) => string;
+    execute: (id: number) => unknown;
+    reset: (id: number) => unknown;
+}
+export declare function isV2(grecaptcha: Recaptcha | GreCAPTCHA | undefined): grecaptcha is Recaptcha;
+export interface GreCAPTCHATopLevel extends GreCAPTCHA {
+    enterprise: GreCAPTCHA;
+}
+export interface GreCAPTCHA {
+    ready: (callback: () => void) => void;
+    execute: (siteKey: string, options: {
+        action: string;
+    }) => Promise<string>;
+    render: (container: string | HTMLElement, parameters: GreCAPTCHARenderOption) => string;
+}
+export interface GreCAPTCHARenderOption {
+    sitekey: string;
+    size: 'invisible';
+}
+export declare function isEnterprise(grecaptcha: Recaptcha | GreCAPTCHA | undefined): grecaptcha is GreCAPTCHATopLevel;
+declare global {
+    interface Window {
+        grecaptcha?: Recaptcha | GreCAPTCHATopLevel;
+    }
+}
+export declare class RecaptchaConfig {
+    /**
+     * The reCAPTCHA site key.
+     */
+    siteKey: string;
+    /**
+     * The list of providers and their enablement status for reCAPTCHA Enterprise.
+     */
+    recaptchaEnforcementState: RecaptchaEnforcementProviderState[];
+    constructor(response: GetRecaptchaConfigResponse);
+    /**
+     * Returns the reCAPTCHA Enterprise enforcement state for the given provider.
+     *
+     * @param providerStr - The provider whose enforcement state is to be returned.
+     * @returns The reCAPTCHA Enterprise enforcement state for the given provider.
+     */
+    getProviderEnforcementState(providerStr: string): EnforcementState | null;
+    /**
+     * Returns true if the reCAPTCHA Enterprise enforcement state for the provider is set to ENFORCE or AUDIT.
+     *
+     * @param providerStr - The provider whose enablement state is to be returned.
+     * @returns Whether or not reCAPTCHA Enterprise protection is enabled for the given provider.
+     */
+    isProviderEnabled(providerStr: string): boolean;
+    /**
+     * Returns true if reCAPTCHA Enterprise protection is enabled in at least one provider, otherwise
+     * returns false.
+     *
+     * @returns Whether or not reCAPTCHA Enterprise protection is enabled for at least one provider.
+     */
+    isAnyProviderEnabled(): boolean;
+}

package/dist/web-extension-esm/src/platform_browser/recaptcha/recaptcha_enterprise_verifier.d.ts

@@ -0,0 +1,45 @@
+/**
+ * @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 class RecaptchaEnterpriseVerifier {
+    /**
+     * Identifies the type of application verifier (e.g. "recaptcha-enterprise").
+     */
+    readonly type = "recaptcha-enterprise";
+    private readonly auth;
+    /**
+     *
+     * @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 {};

package/dist/web-extension-esm/src/platform_browser/recaptcha/recaptcha_loader.d.ts

@@ -0,0 +1,49 @@
+/**
+ * @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/web-extension-esm/src/platform_browser/recaptcha/recaptcha_mock.d.ts

@@ -0,0 +1,66 @@
+/**
+ * @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/web-extension-esm/src/platform_browser/recaptcha/recaptcha_verifier.d.ts

@@ -0,0 +1,92 @@
+/**
+ * @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;
+}