@firebase/auth 1.5.1 → 1.6.0-20240131233318

package/dist/web-extension-cjs/src/model/password_policy.d.ts

@@ -0,0 +1,111 @@
+/**
+ * @license
+ * Copyright 2023 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 { PasswordPolicy, PasswordValidationStatus } from './public_types';
+/**
+ * Internal typing of password policy that includes the schema version and methods for
+ * validating that a password meets the policy. The developer does not need access to
+ * these properties and methods, so they are excluded from the public typing.
+ *
+ * @internal
+ */
+export interface PasswordPolicyInternal extends PasswordPolicy {
+    /**
+     * Requirements enforced by the password policy.
+     */
+    readonly customStrengthOptions: PasswordPolicyCustomStrengthOptions;
+    /**
+     * Schema version of the password policy.
+     */
+    readonly schemaVersion: number;
+    /**
+     * Validates the password against the policy.
+     * @param password Password to validate.
+     */
+    validatePassword(password: string): PasswordValidationStatus;
+}
+/**
+ * Internal typing of the password policy custom strength options that is modifiable. This
+ * allows us to construct the strength options before storing them in the policy.
+ *
+ * @internal
+ */
+export interface PasswordPolicyCustomStrengthOptions {
+    /**
+     * Minimum password length.
+     */
+    minPasswordLength?: number;
+    /**
+     * Maximum password length.
+     */
+    maxPasswordLength?: number;
+    /**
+     * Whether the password should contain a lowercase letter.
+     */
+    containsLowercaseLetter?: boolean;
+    /**
+     * Whether the password should contain an uppercase letter.
+     */
+    containsUppercaseLetter?: boolean;
+    /**
+     * Whether the password should contain a numeric character.
+     */
+    containsNumericCharacter?: boolean;
+    /**
+     * Whether the password should contain a non-alphanumeric character.
+     */
+    containsNonAlphanumericCharacter?: boolean;
+}
+/**
+ * Internal typing of password validation status that is modifiable. This allows us to
+ * construct the validation status before returning it.
+ *
+ * @internal
+ */
+export interface PasswordValidationStatusInternal extends PasswordValidationStatus {
+    /**
+     * Whether the password meets all requirements.
+     */
+    isValid: boolean;
+    /**
+     * Whether the password meets the minimum password length.
+     */
+    meetsMinPasswordLength?: boolean;
+    /**
+     * Whether the password meets the maximum password length.
+     */
+    meetsMaxPasswordLength?: boolean;
+    /**
+     * Whether the password contains a lowercase letter, if required.
+     */
+    containsLowercaseLetter?: boolean;
+    /**
+     * Whether the password contains an uppercase letter, if required.
+     */
+    containsUppercaseLetter?: boolean;
+    /**
+     * Whether the password contains a numeric character, if required.
+     */
+    containsNumericCharacter?: boolean;
+    /**
+     * Whether the password contains a non-alphanumeric character, if required.
+     */
+    containsNonAlphanumericCharacter?: boolean;
+    /**
+     * The policy used to validate the password.
+     */
+    passwordPolicy: PasswordPolicy;
+}

package/dist/web-extension-cjs/src/model/popup_redirect.d.ts

@@ -0,0 +1,94 @@
+/**
+ * @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';
+import { UserCredentialInternal } from './user';
+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>;
+    _overrideRedirectResult: (auth: AuthInternal, resultGetter: () => Promise<UserCredentialInternal | null>) => void;
+}