@firebase/auth 0.18.3 → 0.19.0-canary.0b3ca78eb

package/dist/node-esm/src/mfa/mfa_user.d.ts

@@ -0,0 +1,38 @@
+/**
+ * @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 { MultiFactorAssertion, MultiFactorInfo, MultiFactorSession, MultiFactorUser, User } from '../model/public_types';
+import { UserInternal } from '../model/user';
+export declare class MultiFactorUserImpl implements MultiFactorUser {
+    readonly user: UserInternal;
+    enrolledFactors: MultiFactorInfo[];
+    private constructor();
+    static _fromUser(user: UserInternal): MultiFactorUserImpl;
+    getSession(): Promise<MultiFactorSession>;
+    enroll(assertionExtern: MultiFactorAssertion, displayName?: string | null): Promise<void>;
+    unenroll(infoOrUid: MultiFactorInfo | string): Promise<void>;
+}
+/**
+ * The {@link MultiFactorUser} corresponding to the user.
+ *
+ * @remarks
+ * This is used to access all multi-factor properties and operations related to the user.
+ *
+ * @param user - The user.
+ *
+ * @public
+ */
+export declare function multiFactor(user: User): MultiFactorUser;

package/dist/node-esm/src/mfa/mfa_user.test.d.ts

@@ -0,0 +1,17 @@
+/**
+ * @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/node-esm/src/model/application_verifier.d.ts

@@ -0,0 +1,23 @@
+/**
+ * @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 } from './public_types';
+export interface ApplicationVerifierInternal extends ApplicationVerifier {
+    /**
+     * @internal
+     */
+    _reset(): void;
+}

package/dist/node-esm/src/model/auth.d.ts

@@ -0,0 +1,75 @@
+/**
+ * @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, AuthSettings, Config, EmulatorConfig, PopupRedirectResolver, User } from './public_types';
+import { ErrorFactory } from '@firebase/util';
+import { AuthErrorCode, AuthErrorParams } from '../core/errors';
+import { PopupRedirectResolverInternal } from './popup_redirect';
+import { UserInternal } from './user';
+import { ClientPlatform } from '../core/util/version';
+export declare type AppName = string;
+export declare type ApiKey = string;
+export declare type AuthDomain = string;
+/**
+ * @internal
+ */
+export interface ConfigInternal extends Config {
+    /**
+     * @readonly
+     */
+    emulator?: {
+        url: string;
+    };
+    /**
+     * @readonly
+     */
+    clientPlatform: ClientPlatform;
+}
+/**
+ * UserInternal and AuthInternal reference each other, so both of them are included in the public typings.
+ * In order to exclude them, we mark them as internal explicitly.
+ *
+ * @internal
+ */
+export interface AuthInternal extends Auth {
+    currentUser: User | null;
+    emulatorConfig: EmulatorConfig | null;
+    _canInitEmulator: boolean;
+    _isInitialized: boolean;
+    _initializationPromise: Promise<void> | null;
+    _updateCurrentUser(user: UserInternal | null): Promise<void>;
+    _onStorageEvent(): void;
+    _notifyListenersIfCurrent(user: UserInternal): void;
+    _persistUserIfCurrent(user: UserInternal): Promise<void>;
+    _setRedirectUser(user: UserInternal | null, popupRedirectResolver?: PopupRedirectResolver): Promise<void>;
+    _redirectUserForId(id: string): Promise<UserInternal | null>;
+    _popupRedirectResolver: PopupRedirectResolverInternal | null;
+    _key(): string;
+    _startProactiveRefresh(): void;
+    _stopProactiveRefresh(): void;
+    _getPersistence(): string;
+    _logFramework(framework: string): void;
+    _getFrameworks(): readonly string[];
+    _getSdkClientVersion(): string;
+    readonly name: AppName;
+    readonly config: ConfigInternal;
+    languageCode: string | null;
+    tenantId: string | null;
+    readonly settings: AuthSettings;
+    _errorFactory: ErrorFactory<AuthErrorCode, AuthErrorParams>;
+    useDeviceLanguage(): void;
+    signOut(): Promise<void>;
+}

package/dist/node-esm/src/model/enum_maps.d.ts

@@ -0,0 +1,97 @@
+/**
+ * @license
+ * Copyright 2021 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.
+ */
+/**
+ * An enum of factors that may be used for multifactor authentication.
+ *
+ * @public
+ */
+export declare const FactorId: {
+    /** Phone as second factor */
+    readonly PHONE: "phone";
+};
+/**
+ * Enumeration of supported providers.
+ *
+ * @public
+ */
+export declare const ProviderId: {
+    /** Facebook provider ID */
+    readonly FACEBOOK: "facebook.com";
+    /** GitHub provider ID */
+    readonly GITHUB: "github.com";
+    /** Google provider ID */
+    readonly GOOGLE: "google.com";
+    /** Password provider */
+    readonly PASSWORD: "password";
+    /** Phone provider */
+    readonly PHONE: "phone";
+    /** Twitter provider ID */
+    readonly TWITTER: "twitter.com";
+};
+/**
+ * Enumeration of supported sign-in methods.
+ *
+ * @public
+ */
+export declare const SignInMethod: {
+    /** Email link sign in method */
+    readonly EMAIL_LINK: "emailLink";
+    /** Email/password sign in method */
+    readonly EMAIL_PASSWORD: "password";
+    /** Facebook sign in method */
+    readonly FACEBOOK: "facebook.com";
+    /** GitHub sign in method */
+    readonly GITHUB: "github.com";
+    /** Google sign in method */
+    readonly GOOGLE: "google.com";
+    /** Phone sign in method */
+    readonly PHONE: "phone";
+    /** Twitter sign in method */
+    readonly TWITTER: "twitter.com";
+};
+/**
+ * Enumeration of supported operation types.
+ *
+ * @public
+ */
+export declare const OperationType: {
+    /** Operation involving linking an additional provider to an already signed-in user. */
+    readonly LINK: "link";
+    /** Operation involving using a provider to reauthenticate an already signed-in user. */
+    readonly REAUTHENTICATE: "reauthenticate";
+    /** Operation involving signing in a user. */
+    readonly SIGN_IN: "signIn";
+};
+/**
+ * An enumeration of the possible email action types.
+ *
+ * @public
+ */
+export declare const ActionCodeOperation: {
+    /** The email link sign-in action. */
+    readonly EMAIL_SIGNIN: "EMAIL_SIGNIN";
+    /** The password reset action. */
+    readonly PASSWORD_RESET: "PASSWORD_RESET";
+    /** The email revocation action. */
+    readonly RECOVER_EMAIL: "RECOVER_EMAIL";
+    /** The revert second factor addition email action. */
+    readonly REVERT_SECOND_FACTOR_ADDITION: "REVERT_SECOND_FACTOR_ADDITION";
+    /** The revert second factor addition email action. */
+    readonly VERIFY_AND_CHANGE_EMAIL: "VERIFY_AND_CHANGE_EMAIL";
+    /** The email verification action. */
+    readonly VERIFY_EMAIL: "VERIFY_EMAIL";
+};

package/dist/node-esm/src/model/enums.d.ts

@@ -0,0 +1,74 @@
+/**
+ * @license
+ * Copyright 2021 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.
+ */
+/**
+ * Enumeration of supported providers.
+ * @internal
+ */
+export declare const enum ProviderId {
+    /** @internal */
+    ANONYMOUS = "anonymous",
+    /** @internal */
+    CUSTOM = "custom",
+    /** Facebook provider ID */
+    FACEBOOK = "facebook.com",
+    /** @internal */
+    FIREBASE = "firebase",
+    /** GitHub provider ID */
+    GITHUB = "github.com",
+    /** Google provider ID */
+    GOOGLE = "google.com",
+    /** Password provider */
+    PASSWORD = "password",
+    /** Phone provider */
+    PHONE = "phone",
+    /** Twitter provider ID */
+    TWITTER = "twitter.com"
+}
+/**
+ * Enumeration of supported sign-in methods.
+ * @internal
+ */
+export declare const enum SignInMethod {
+    /** @internal */
+    ANONYMOUS = "anonymous",
+    /** Email link sign in method */
+    EMAIL_LINK = "emailLink",
+    /** Email/password sign in method */
+    EMAIL_PASSWORD = "password",
+    /** Facebook sign in method */
+    FACEBOOK = "facebook.com",
+    /** GitHub sign in method */
+    GITHUB = "github.com",
+    /** Google sign in method */
+    GOOGLE = "google.com",
+    /** Phone sign in method */
+    PHONE = "phone",
+    /** Twitter sign in method */
+    TWITTER = "twitter.com"
+}
+/**
+ * Enumeration of supported operation types.
+ * @internal
+ */
+export declare const enum OperationType {
+    /** Operation involving linking an additional provider to an already signed-in user. */
+    LINK = "link",
+    /** Operation involving using a provider to reauthenticate an already signed-in user. */
+    REAUTHENTICATE = "reauthenticate",
+    /** Operation involving signing in a user. */
+    SIGN_IN = "signIn"
+}

package/dist/node-esm/src/model/id_token.d.ts

@@ -0,0 +1,84 @@
+/**
+ * @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 { PhoneOrOauthTokenResponse } from '../api/authentication/mfa';
+/**
+ * Raw encoded JWT
+ *
+ */
+export declare type IdToken = string;
+/**
+ * Raw parsed JWT
+ *
+ */
+export interface ParsedIdToken {
+    iss: string;
+    aud: string;
+    exp: number;
+    sub: string;
+    iat: number;
+    email?: string;
+    verified: boolean;
+    providerId?: string;
+    tenantId?: string;
+    anonymous: boolean;
+    federatedId?: string;
+    displayName?: string;
+    photoURL?: string;
+    toString(): string;
+}
+/**
+ * IdToken as returned by the API
+ *
+ * @internal
+ */
+export interface IdTokenResponse {
+    localId: string;
+    idToken?: IdToken;
+    refreshToken?: string;
+    expiresIn?: string;
+    providerId?: string;
+    displayName?: string | null;
+    isNewUser?: boolean;
+    kind?: IdTokenResponseKind;
+    photoUrl?: string | null;
+    rawUserInfo?: string;
+    screenName?: string | null;
+}
+/**
+ * The possible types of the `IdTokenResponse`
+ *
+ * @internal
+ */
+export declare const enum IdTokenResponseKind {
+    CreateAuthUri = "identitytoolkit#CreateAuthUriResponse",
+    DeleteAccount = "identitytoolkit#DeleteAccountResponse",
+    DownloadAccount = "identitytoolkit#DownloadAccountResponse",
+    EmailLinkSignin = "identitytoolkit#EmailLinkSigninResponse",
+    GetAccountInfo = "identitytoolkit#GetAccountInfoResponse",
+    GetOobConfirmationCode = "identitytoolkit#GetOobConfirmationCodeResponse",
+    GetRecaptchaParam = "identitytoolkit#GetRecaptchaParamResponse",
+    ResetPassword = "identitytoolkit#ResetPasswordResponse",
+    SetAccountInfo = "identitytoolkit#SetAccountInfoResponse",
+    SignupNewUser = "identitytoolkit#SignupNewUserResponse",
+    UploadAccount = "identitytoolkit#UploadAccountResponse",
+    VerifyAssertion = "identitytoolkit#VerifyAssertionResponse",
+    VerifyCustomToken = "identitytoolkit#VerifyCustomTokenResponse",
+    VerifyPassword = "identitytoolkit#VerifyPasswordResponse"
+}
+export interface TaggedWithTokenResponse {
+    _tokenResponse?: PhoneOrOauthTokenResponse;
+}

package/dist/node-esm/src/model/popup_redirect.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, AuthProvider, Persistence, PopupRedirectResolver, UserCredential } from './public_types';
+import { FirebaseError } from '@firebase/util';
+import { AuthPopup } from '../platform_browser/util/popup';
+import { AuthInternal } from './auth';
+export declare const enum EventFilter {
+    POPUP = 0,
+    REDIRECT = 1
+}
+export declare const enum GapiOutcome {
+    ACK = "ACK",
+    ERROR = "ERROR"
+}
+export interface GapiAuthEvent extends gapi.iframes.Message {
+    authEvent: AuthEvent;
+}
+/**
+ * @internal
+ */
+export declare const enum AuthEventType {
+    LINK_VIA_POPUP = "linkViaPopup",
+    LINK_VIA_REDIRECT = "linkViaRedirect",
+    REAUTH_VIA_POPUP = "reauthViaPopup",
+    REAUTH_VIA_REDIRECT = "reauthViaRedirect",
+    SIGN_IN_VIA_POPUP = "signInViaPopup",
+    SIGN_IN_VIA_REDIRECT = "signInViaRedirect",
+    UNKNOWN = "unknown",
+    VERIFY_APP = "verifyApp"
+}
+export interface AuthEventError extends Error {
+    code: string;
+    message: string;
+}
+/**
+ * @internal
+ */
+export interface AuthEvent {
+    type: AuthEventType;
+    eventId: string | null;
+    urlResponse: string | null;
+    sessionId: string | null;
+    postBody: string | null;
+    tenantId: string | null;
+    error?: AuthEventError;
+}
+/**
+ * @internal
+ */
+export interface AuthEventConsumer {
+    readonly filter: AuthEventType[];
+    eventId: string | null;
+    onAuthEvent(event: AuthEvent): unknown;
+    onError(error: FirebaseError): unknown;
+}
+/**
+ * @internal
+ */
+export interface EventManager {
+    registerConsumer(authEventConsumer: AuthEventConsumer): void;
+    unregisterConsumer(authEventConsumer: AuthEventConsumer): void;
+}
+/**
+ * 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 PopupRedirectResolverInternal extends PopupRedirectResolver {
+    _shouldInitProactively: boolean;
+    _initialize(auth: AuthInternal): Promise<EventManager>;
+    _openPopup(auth: AuthInternal, provider: AuthProvider, authType: AuthEventType, eventId?: string): Promise<AuthPopup>;
+    _openRedirect(auth: AuthInternal, provider: AuthProvider, authType: AuthEventType, eventId?: string): Promise<void | never>;
+    _isIframeWebStorageSupported(auth: AuthInternal, cb: (support: boolean) => unknown): void;
+    _redirectPersistence: Persistence;
+    _originValidation(auth: Auth): Promise<void>;
+    _completeRedirectFn: (auth: Auth, resolver: PopupRedirectResolver, bypassAuthState: boolean) => Promise<UserCredential | null>;
+}