@firebase-oss/ui-core 0.0.1 → 0.0.2-exp.ed61394

package/dist/index.d.cts

@@ -8,11 +8,43 @@ import { CountryCode } from 'libphonenumber-js';
 export { CountryCode } from 'libphonenumber-js';
 import * as z from 'zod';
 
+/**
+ * Copyright 2025 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.
+ */
+
 type OnUpgradeCallback = (ui: FirebaseUI, oldUserId: string, credential: UserCredential) => Promise<void> | void;
 declare const autoUpgradeAnonymousCredentialHandler: (ui: FirebaseUI, credential: AuthCredential, onUpgrade?: OnUpgradeCallback) => Promise<UserCredential | undefined>;
 declare const autoUpgradeAnonymousProviderHandler: (ui: FirebaseUI, provider: AuthProvider, onUpgrade?: OnUpgradeCallback) => Promise<UserCredential | undefined>;
 declare const autoUpgradeAnonymousUserRedirectHandler: (ui: FirebaseUI, credential: UserCredential | null, onUpgrade?: OnUpgradeCallback) => Promise<void>;
 
+/**
+ * Copyright 2025 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.
+ */
+
 type CallableHandler<T extends (...args: any[]) => any = (...args: any[]) => any> = T;
 type InitHandler = (ui: FirebaseUI) => Promise<void> | void;
 type RedirectHandler = (ui: FirebaseUI, result: UserCredential | null) => Promise<void> | void;
@@ -29,17 +61,81 @@ type InitBehavior<T extends InitHandler = InitHandler> = {
     handler: T;
 };
 
+/**
+ * Copyright 2025 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.
+ */
+
 declare const autoAnonymousLoginHandler: InitHandler;
 
+/**
+ * Copyright 2025 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.
+ */
+
 type RecaptchaVerificationOptions$1 = {
     size?: "normal" | "invisible" | "compact";
     theme?: "light" | "dark";
     tabindex?: number;
 };
 
+/**
+ * Copyright 2025 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.
+ */
+
 type ProviderSignInStrategyHandler = (ui: FirebaseUI, provider: AuthProvider) => Promise<never | UserCredential>;
 type ProviderLinkStrategyHandler = (ui: FirebaseUI, user: User, provider: AuthProvider) => Promise<never | UserCredential>;
 
+/**
+ * Copyright 2025 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.
+ */
+
 type OneTapSignInOptions$1 = {
     clientId: IdConfiguration["client_id"];
     autoSelect?: IdConfiguration["auto_select"];
@@ -50,6 +146,22 @@ type OneTapSignInOptions$1 = {
 };
 declare const oneTapSignInHandler: (ui: FirebaseUI, options: OneTapSignInOptions$1) => Promise<void>;
 
+/**
+ * Copyright 2025 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.
+ */
+
 declare const requireDisplayNameHandler: (_: FirebaseUI, user: User, displayName: string) => Promise<void>;
 
 /**
@@ -68,6 +180,9 @@ declare const requireDisplayNameHandler: (_: FirebaseUI, user: User, displayName
  * limitations under the License.
  */
 
+/**
+ * An array of country data objects containing name, dial code, country code, and emoji for all supported countries.
+ */
 declare const countryData: [{
     readonly name: "Afghanistan";
     readonly dialCode: "+93";
@@ -1299,15 +1414,45 @@ declare const countryData: [{
     readonly code: "AX";
     readonly emoji: "🇦🇽";
 }];
+/**
+ * A country data object containing name, dial code, country code, and emoji for a supported country.
+ */
 type CountryData = {
+    /** The name of the country. */
     name: string;
+    /** The dial code of the country. */
     dialCode: string;
+    /** The country code of the country. */
     code: CountryCode;
+    /** The emoji of the country. */
     emoji: string;
 };
 
+/**
+ * Formats a phone number according to the specified country data.
+ *
+ * @param phoneNumber - The phone number to format.
+ * @param countryData - The country data to use for formatting.
+ * @returns {string} The formatted phone number in E164 format.
+ */
 declare function formatPhoneNumber(phoneNumber: string, countryData: CountryData): string;
 
+/**
+ * Copyright 2025 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.
+ */
+
 type CountryCodesOptions = {
     allowedCountries?: CountryCode[];
     defaultCountry?: CountryCode;
@@ -3777,6 +3922,22 @@ declare const countryCodesHandler: (options?: CountryCodesOptions) => {
     };
 };
 
+/**
+ * Copyright 2025 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.
+ */
+
 type Registry = {
     autoAnonymousLogin: InitBehavior<typeof autoAnonymousLoginHandler>;
     autoUpgradeAnonymousCredential: CallableBehavior<typeof autoUpgradeAnonymousCredentialHandler>;
@@ -3789,23 +3950,94 @@ type Registry = {
     requireDisplayName: CallableBehavior<typeof requireDisplayNameHandler>;
     countryCodes: CallableBehavior<typeof countryCodesHandler>;
 };
+/** A behavior or set of behaviors from the registry. */
 type Behavior<T extends keyof Registry = keyof Registry> = Pick<Registry, T>;
+/** All available behaviors, with each behavior being optional. */
 type Behaviors = Partial<Registry>;
+/**
+ * Enables automatic anonymous login when the app initializes.
+ *
+ * @returns A behavior that automatically signs in users anonymously on app initialization.
+ */
 declare function autoAnonymousLogin(): Behavior<"autoAnonymousLogin">;
+/** Options for the auto-upgrade anonymous users behavior. */
 type AutoUpgradeAnonymousUsersOptions = {
+    /** Optional callback function that is called when an anonymous user is upgraded. */
     onUpgrade?: OnUpgradeCallback;
 };
+/**
+ * Automatically upgrades anonymous users to regular users when they sign in with a credential or provider.
+ *
+ * This behavior handles upgrading anonymous users for credential-based sign-ins, provider-based sign-ins,
+ * and redirect-based authentication flows.
+ *
+ * @param options - Optional configuration including an upgrade callback.
+ * @returns Behaviors for automatically upgrading anonymous users.
+ */
 declare function autoUpgradeAnonymousUsers(options?: AutoUpgradeAnonymousUsersOptions): Behavior<"autoUpgradeAnonymousCredential" | "autoUpgradeAnonymousProvider" | "autoUpgradeAnonymousUserRedirectHandler">;
+/** Options for reCAPTCHA verification behavior. */
 type RecaptchaVerificationOptions = RecaptchaVerificationOptions$1;
+/**
+ * Configures reCAPTCHA verification for phone authentication.
+ *
+ * @param options - Optional reCAPTCHA verification options.
+ * @returns A behavior that handles reCAPTCHA verification for phone authentication.
+ */
 declare function recaptchaVerification(options?: RecaptchaVerificationOptions): Behavior<"recaptchaVerification">;
+/**
+ * Configures provider authentication to use redirect strategy instead of popup.
+ *
+ * @returns Behaviors for provider sign-in and linking using redirect strategy.
+ */
 declare function providerRedirectStrategy(): Behavior<"providerSignInStrategy" | "providerLinkStrategy">;
+/**
+ * Configures provider authentication to use popup strategy instead of redirect.
+ *
+ * This is the default strategy for provider authentication.
+ *
+ * @returns Behaviors for provider sign-in and linking using popup strategy.
+ */
 declare function providerPopupStrategy(): Behavior<"providerSignInStrategy" | "providerLinkStrategy">;
+/** Options for Google One Tap sign-in behavior. */
 type OneTapSignInOptions = OneTapSignInOptions$1;
+/**
+ * Enables Google One Tap sign-in functionality.
+ *
+ * @param options - Configuration options for Google One Tap sign-in.
+ * @returns A behavior that handles Google One Tap sign-in initialization.
+ */
 declare function oneTapSignIn(options: OneTapSignInOptions): Behavior<"oneTapSignIn">;
+/**
+ * Requires users to provide a display name when creating an account.
+ *
+ * @returns A behavior that enforces display name requirement during user registration.
+ */
 declare function requireDisplayName(): Behavior<"requireDisplayName">;
+/**
+ * Configures country code selection for phone number input.
+ *
+ * @param options - Optional configuration for country code behavior.
+ * @returns A behavior that provides country code functionality for phone authentication.
+ */
 declare function countryCodes(options?: CountryCodesOptions): Behavior<"countryCodes">;
+/**
+ * Checks if a specific behavior is enabled for the given FirebaseUI instance.
+ *
+ * @param ui - The FirebaseUI instance.
+ * @param key - The behavior key to check.
+ * @returns True if the behavior is enabled, false otherwise.
+ */
 declare function hasBehavior<T extends keyof Registry>(ui: FirebaseUI, key: T): boolean;
+/**
+ * Gets the handler function for a specific behavior.
+ *
+ * @param ui - The FirebaseUI instance.
+ * @param key - The behavior key to retrieve.
+ * @returns The handler function for the specified behavior.
+ * @throws {Error} Throws an error if the behavior is not found.
+ */
 declare function getBehavior<T extends keyof Registry>(ui: FirebaseUI, key: T): Registry[T]["handler"];
+/** Default behaviors that are enabled by default for all FirebaseUI instances. */
 declare const defaultBehaviors: Behavior<"recaptchaVerification">;
 
 /**
@@ -3825,27 +4057,77 @@ declare const defaultBehaviors: Behavior<"recaptchaVerification">;
  */
 type FirebaseUIState = "idle" | "pending" | "loading";
 
+/**
+ * Configuration options for initializing FirebaseUI.
+ */
 type FirebaseUIOptions = {
+    /** A required Firebase App instance, e.g. from `initializeApp`. */
     app: FirebaseApp;
+    /** An optional Firebase Auth instance, e.g. from `getAuth`. If not provided, it will be created using the app instance. */
     auth?: Auth;
+    /** A default locale to use. Defaults to `enUs`. */
     locale?: RegisteredLocale;
+    /** An optional array of behaviors, e.g. from `requireDisplayName`. */
     behaviors?: Behavior<any>[];
 };
+/**
+ * The main FirebaseUI instance that provides access to Firebase Auth and UI state management.
+ *
+ * This type encapsulates all the necessary components for managing authentication UI state,
+ * including Firebase app and auth instances, locale settings, behaviors, and multi-factor
+ * authentication state.
+ */
 type FirebaseUI = {
+    /** The Firebase App instance. */
     app: FirebaseApp;
+    /** The Firebase Auth instance. */
     auth: Auth;
+    /** Sets the locale for translations. */
     setLocale: (locale: RegisteredLocale) => void;
+    /** The current UI state (e.g., "idle", "pending", "loading"). */
     state: FirebaseUIState;
+    /** Sets the UI state. */
     setState: (state: FirebaseUIState) => void;
+    /** The current locale for translations. */
     locale: RegisteredLocale;
+    /** The configured behaviors that customize authentication flows. */
     behaviors: Behaviors;
+    /** The multi-factor resolver, if a multi-factor challenge is in progress. */
     multiFactorResolver?: MultiFactorResolver;
+    /** Sets the multi-factor resolver. */
     setMultiFactorResolver: (multiFactorResolver?: MultiFactorResolver) => void;
+    /** Any error that occurred during a redirect-based authentication flow. */
     redirectError?: Error;
+    /** Sets the redirect error. */
     setRedirectError: (error?: Error) => void;
 };
 declare const $config: nanostores.PreinitializedMapStore<Record<string, DeepMapStore<FirebaseUI>>> & object;
+/**
+ * A reactive store containing a FirebaseUI instance.
+ *
+ * This store allows for reactive updates to the FirebaseUI state, enabling UI components
+ * to automatically update when the authentication state or configuration changes.
+ */
 type FirebaseUIStore = DeepMapStore<FirebaseUI>;
+/**
+ * Initializes a FirebaseUI instance with the provided configuration.
+ *
+ * Creates a reactive store containing the FirebaseUI instance, sets up behaviors,
+ * and handles initialization and redirect flows if running client-side.
+ *
+ * Example:
+ * ```typescript
+ * const ui = initializeUI({
+ *   app: firebaseApp,
+ *   locale: enUs,
+ *   behaviors: [requireDisplayName()],
+ * });
+ * ```
+ *
+ * @param config - The configuration options for FirebaseUI.
+ * @param name - Optional name for the FirebaseUI instance. Defaults to "[DEFAULT]".
+ * @returns {FirebaseUIStore} A reactive store containing the initialized FirebaseUI instance.
+ */
 declare function initializeUI(config: FirebaseUIOptions, name?: string): FirebaseUIStore;
 
 /**
@@ -3864,21 +4146,166 @@ declare function initializeUI(config: FirebaseUIOptions, name?: string): Firebas
  * limitations under the License.
  */
 
+/**
+ * Signs in with an email and password.
+ *
+ * If the `autoUpgradeAnonymousUsers` behavior is enabled, it will attempt to upgrade an anonymous user to a regular user.
+ *
+ * @param ui - The FirebaseUI instance.
+ * @param email - The email to sign in with.
+ * @param password - The password to sign in with.
+ * @returns {Promise<UserCredential>} A promise containing the user credential.
+ */
 declare function signInWithEmailAndPassword(ui: FirebaseUI, email: string, password: string): Promise<UserCredential>;
+/**
+ * Creates a new user account with an email and password.
+ *
+ * If the `requireDisplayName` behavior is enabled, a display name must be provided.
+ * If the `autoUpgradeAnonymousUsers` behavior is enabled, it will attempt to upgrade an anonymous user to a regular user.
+ *
+ * @param ui - The FirebaseUI instance.
+ * @param email - The email address for the new account.
+ * @param password - The password for the new account.
+ * @param displayName - Optional display name for the user.
+ * @returns {Promise<UserCredential>} A promise containing the user credential.
+ */
 declare function createUserWithEmailAndPassword(ui: FirebaseUI, email: string, password: string, displayName?: string): Promise<UserCredential>;
+/**
+ * Verifies a phone number for authentication.
+ *
+ * Supports regular phone authentication, MFA enrollment, and MFA assertion flows.
+ *
+ * @param ui - The FirebaseUI instance.
+ * @param phoneNumber - The phone number to verify.
+ * @param appVerifier - The application verifier (reCAPTCHA).
+ * @param mfaUser - Optional multi-factor user for MFA enrollment flow.
+ * @param mfaHint - Optional multi-factor info hint for MFA assertion flow.
+ * @returns {Promise<string>} A promise containing the verification ID.
+ */
 declare function verifyPhoneNumber(ui: FirebaseUI, phoneNumber: string, appVerifier: ApplicationVerifier, mfaUser?: MultiFactorUser, mfaHint?: MultiFactorInfo): Promise<string>;
+/**
+ * Confirms a phone number verification code and signs in the user.
+ *
+ * If the `autoUpgradeAnonymousUsers` behavior is enabled and the current user is anonymous, it will attempt to upgrade the anonymous user to a regular user.
+ *
+ * @param ui - The FirebaseUI instance.
+ * @param verificationId - The verification ID from the phone verification process.
+ * @param verificationCode - The verification code sent to the phone.
+ * @returns {Promise<UserCredential>} A promise containing the user credential.
+ */
 declare function confirmPhoneNumber(ui: FirebaseUI, verificationId: string, verificationCode: string): Promise<UserCredential>;
+/**
+ * Sends a password reset email to the specified email address.
+ *
+ * @param ui - The FirebaseUI instance.
+ * @param email - The email address to send the password reset email to.
+ * @returns {Promise<void>} A promise that resolves when the email is sent.
+ */
 declare function sendPasswordResetEmail(ui: FirebaseUI, email: string): Promise<void>;
+/**
+ * Sends a sign-in link to the specified email address.
+ *
+ * The email address is stored in localStorage for later use during the sign-in process.
+ *
+ * @param ui - The FirebaseUI instance.
+ * @param email - The email address to send the sign-in link to.
+ * @returns {Promise<void>} A promise that resolves when the email is sent.
+ */
 declare function sendSignInLinkToEmail(ui: FirebaseUI, email: string): Promise<void>;
+/**
+ * Signs in a user using an email link.
+ *
+ * @param ui - The FirebaseUI instance.
+ * @param email - The email address associated with the sign-in link.
+ * @param link - The sign-in link from the email.
+ * @returns {Promise<UserCredential>} A promise containing the user credential.
+ */
 declare function signInWithEmailLink(ui: FirebaseUI, email: string, link: string): Promise<UserCredential>;
+/**
+ * Signs in a user with an authentication credential.
+ *
+ * If the `autoUpgradeAnonymousUsers` behavior is enabled, it will attempt to upgrade an anonymous user to a regular user.
+ *
+ * @param ui - The FirebaseUI instance.
+ * @param credential - The authentication credential to sign in with.
+ * @returns {Promise<UserCredential>} A promise containing the user credential.
+ */
 declare function signInWithCredential(ui: FirebaseUI, credential: AuthCredential): Promise<UserCredential>;
+/**
+ * Signs in a user with a custom token.
+ *
+ * @param ui - The FirebaseUI instance.
+ * @param customToken - The custom token to sign in with.
+ * @returns {Promise<UserCredential>} A promise containing the user credential.
+ */
 declare function signInWithCustomToken(ui: FirebaseUI, customToken: string): Promise<UserCredential>;
+/**
+ * Signs in a user anonymously.
+ *
+ * @param ui - The FirebaseUI instance.
+ * @returns {Promise<UserCredential>} A promise containing the user credential.
+ */
 declare function signInAnonymously(ui: FirebaseUI): Promise<UserCredential>;
+/**
+ * Signs in a user with an authentication provider (e.g., Google, Facebook, etc.).
+ *
+ * If the `autoUpgradeAnonymousProvider` behavior is enabled, it will attempt to upgrade an anonymous user to a regular user.
+ * The sign-in strategy (popup or redirect) is determined by the `providerSignInStrategy` behavior.
+ *
+ * @param ui - The FirebaseUI instance.
+ * @param provider - The authentication provider to sign in with.
+ * @returns {Promise<UserCredential | never>} A promise containing the user credential, or never if using redirect strategy.
+ */
 declare function signInWithProvider(ui: FirebaseUI, provider: AuthProvider): Promise<UserCredential | never>;
+/**
+ * Completes the email link sign-in process using the current URL.
+ *
+ * Checks if the current URL is a valid email link sign-in URL and retrieves the email from localStorage.
+ * Returns null if the URL is not a valid email link or if no email is found in localStorage.
+ *
+ * @param ui - The FirebaseUI instance.
+ * @param currentUrl - The current URL to check for email link sign-in.
+ * @returns {Promise<UserCredential | null>} A promise containing the user credential, or null if the sign-in cannot be completed.
+ */
 declare function completeEmailLinkSignIn(ui: FirebaseUI, currentUrl: string): Promise<UserCredential | null>;
+/**
+ * Generates a QR code data URL for TOTP (Time-based One-Time Password) multi-factor authentication.
+ *
+ * The QR code can be scanned by an authenticator app to set up TOTP MFA for the user.
+ *
+ * @param ui - The FirebaseUI instance.
+ * @param secret - The TOTP secret to generate the QR code for.
+ * @param accountName - Optional account name for the QR code. Defaults to the user's email if not provided.
+ * @param issuer - Optional issuer name for the QR code.
+ * @returns {string} A data URL containing the QR code image.
+ * @throws {Error} Throws an error if the user is not authenticated.
+ */
 declare function generateTotpQrCode(ui: FirebaseUI, secret: TotpSecret, accountName?: string, issuer?: string): string;
-declare function signInWithMultiFactorAssertion(ui: FirebaseUI, assertion: MultiFactorAssertion): Promise<UserCredential | undefined>;
+/**
+ * Signs in a user using a multi-factor assertion.
+ *
+ * Resolves the multi-factor challenge using the provided assertion and clears the multi-factor resolver from the UI state.
+ *
+ * @param ui - The FirebaseUI instance.
+ * @param assertion - The multi-factor assertion to use for sign-in.
+ * @returns {Promise<UserCredential>} A promise containing the user credential.
+ */
+declare function signInWithMultiFactorAssertion(ui: FirebaseUI, assertion: MultiFactorAssertion): Promise<UserCredential>;
+/**
+ * Enrolls a multi-factor authentication method for the current user.
+ *
+ * @param ui - The FirebaseUI instance.
+ * @param assertion - The multi-factor assertion to enroll.
+ * @param displayName - Optional display name for the enrolled MFA method.
+ * @returns {Promise<void>} A promise that resolves when the enrollment is complete.
+ */
 declare function enrollWithMultiFactorAssertion(ui: FirebaseUI, assertion: MultiFactorAssertion, displayName?: string): Promise<void>;
+/**
+ * Generates a TOTP (Time-based One-Time Password) secret for multi-factor authentication enrollment.
+ *
+ * @param ui - The FirebaseUI instance.
+ * @returns {Promise<TotpSecret>} A promise containing the TOTP secret.
+ */
 declare function generateTotpSecret(ui: FirebaseUI): Promise<TotpSecret>;
 
 /**
@@ -3897,11 +4324,48 @@ declare function generateTotpSecret(ui: FirebaseUI): Promise<TotpSecret>;
  * limitations under the License.
  */
 
+/**
+ * A custom error class that extends FirebaseError and provides a translated error message based on the configured locale.
+ */
 declare class FirebaseUIError extends FirebaseError {
     constructor(ui: FirebaseUI, error: FirebaseError);
 }
+/**
+ * Handles a Firebase error and throws a FirebaseUIError if it is a Firebase error.
+ *
+ * Addtionally, handles the following error codes:
+ * - auth/account-exists-with-different-credential - stores the credential in sessionStorage.
+ * - auth/multi-factor-auth-required - updates the UI instance with the multi-factor resolver.
+ *
+ * @param ui - The FirebaseUI instance.
+ * @param error - The error to handle.
+ * @returns {never} A never type.
+ */
 declare function handleFirebaseError(ui: FirebaseUI, error: unknown): never;
 
+/**
+ * Copyright 2025 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.
+ */
+/**
+ * Register a framework with the FirebaseUI configuration.
+ * @internal
+ * @param framework The type of framework being registered.
+ * @param version The version of the framework being registered.
+ */
+declare function registerFramework(framework: string, version: string): void;
+
 /**
  * Copyright 2025 Google LLC
  *
@@ -3918,53 +4382,151 @@ declare function handleFirebaseError(ui: FirebaseUI, error: unknown): never;
  * limitations under the License.
  */
 
-declare const LoginTypes: readonly ["email", "phone", "anonymous", "emailLink", "google"];
-type LoginType = (typeof LoginTypes)[number];
-type AuthMode = "signIn" | "signUp";
+/**
+ * Creates a Zod schema for sign-in form validation.
+ *
+ * Validates email format and password minimum length (6 characters).
+ *
+ * @param ui - The FirebaseUI instance.
+ * @returns A Zod schema for sign-in form validation.
+ */
 declare function createSignInAuthFormSchema(ui: FirebaseUI): z.ZodObject<{
     email: z.ZodEmail;
     password: z.ZodString;
 }, z.core.$strip>;
+/**
+ * Creates a Zod schema for sign-up form validation.
+ *
+ * Validates email format, password minimum length (6 characters), and optionally requires a display name
+ * if the `requireDisplayName` behavior is enabled.
+ *
+ * @param ui - The FirebaseUI instance.
+ * @returns A Zod schema for sign-up form validation.
+ */
 declare function createSignUpAuthFormSchema(ui: FirebaseUI): z.ZodObject<{
     email: z.ZodEmail;
     password: z.ZodString;
     displayName: z.ZodString | z.ZodOptional<z.ZodString>;
 }, z.core.$strip>;
+/**
+ * Creates a Zod schema for forgot password form validation.
+ *
+ * Validates email format.
+ *
+ * @param ui - The FirebaseUI instance.
+ * @returns A Zod schema for forgot password form validation.
+ */
 declare function createForgotPasswordAuthFormSchema(ui: FirebaseUI): z.ZodObject<{
     email: z.ZodEmail;
 }, z.core.$strip>;
+/**
+ * Creates a Zod schema for email link authentication form validation.
+ *
+ * Validates email format.
+ *
+ * @param ui - The FirebaseUI instance.
+ * @returns A Zod schema for email link authentication form validation.
+ */
 declare function createEmailLinkAuthFormSchema(ui: FirebaseUI): z.ZodObject<{
     email: z.ZodEmail;
 }, z.core.$strip>;
+/**
+ * Creates a Zod schema for phone number form validation.
+ *
+ * Validates that the phone number is provided and has a maximum length of 10 characters.
+ *
+ * @param ui - The FirebaseUI instance.
+ * @returns A Zod schema for phone number form validation.
+ */
 declare function createPhoneAuthNumberFormSchema(ui: FirebaseUI): z.ZodObject<{
     phoneNumber: z.ZodString;
 }, z.core.$strip>;
+/**
+ * Creates a Zod schema for phone verification code form validation.
+ *
+ * Validates that the verification ID is provided and the verification code is at least 6 characters long.
+ *
+ * @param ui - The FirebaseUI instance.
+ * @returns A Zod schema for phone verification form validation.
+ */
 declare function createPhoneAuthVerifyFormSchema(ui: FirebaseUI): z.ZodObject<{
     verificationId: z.ZodString;
     verificationCode: z.ZodString;
 }, z.core.$strip>;
+/**
+ * Creates a Zod schema for multi-factor phone authentication number form validation.
+ *
+ * Extends the phone number schema with a required display name field.
+ *
+ * @param ui - The FirebaseUI instance.
+ * @returns A Zod schema for multi-factor phone authentication number form validation.
+ */
 declare function createMultiFactorPhoneAuthNumberFormSchema(ui: FirebaseUI): z.ZodObject<{
     phoneNumber: z.ZodString;
     displayName: z.ZodString;
 }, z.core.$strip>;
+/**
+ * Creates a Zod schema for multi-factor phone authentication assertion form validation.
+ *
+ * Uses the same validation as the phone number form schema.
+ *
+ * @param ui - The FirebaseUI instance.
+ * @returns A Zod schema for multi-factor phone authentication assertion form validation.
+ */
+declare function createMultiFactorPhoneAuthAssertionFormSchema(ui: FirebaseUI): z.ZodObject<{
+    phoneNumber: z.ZodString;
+}, z.core.$strip>;
+/**
+ * Creates a Zod schema for multi-factor phone authentication verification form validation.
+ *
+ * Uses the same validation as the phone verification form schema.
+ *
+ * @param ui - The FirebaseUI instance.
+ * @returns A Zod schema for multi-factor phone authentication verification form validation.
+ */
 declare function createMultiFactorPhoneAuthVerifyFormSchema(ui: FirebaseUI): z.ZodObject<{
     verificationId: z.ZodString;
     verificationCode: z.ZodString;
 }, z.core.$strip>;
+/**
+ * Creates a Zod schema for multi-factor TOTP authentication number form validation.
+ *
+ * Validates that a display name is provided.
+ *
+ * @param ui - The FirebaseUI instance.
+ * @returns A Zod schema for multi-factor TOTP authentication number form validation.
+ */
 declare function createMultiFactorTotpAuthNumberFormSchema(ui: FirebaseUI): z.ZodObject<{
     displayName: z.ZodString;
 }, z.core.$strip>;
+/**
+ * Creates a Zod schema for multi-factor TOTP authentication verification form validation.
+ *
+ * Validates that the verification code is exactly 6 characters long.
+ *
+ * @param ui - The FirebaseUI instance.
+ * @returns A Zod schema for multi-factor TOTP authentication verification form validation.
+ */
 declare function createMultiFactorTotpAuthVerifyFormSchema(ui: FirebaseUI): z.ZodObject<{
     verificationCode: z.ZodString;
 }, z.core.$strip>;
+/** The inferred type for the sign-in authentication form schema. */
 type SignInAuthFormSchema = z.infer<ReturnType<typeof createSignInAuthFormSchema>>;
+/** The inferred type for the sign-up authentication form schema. */
 type SignUpAuthFormSchema = z.infer<ReturnType<typeof createSignUpAuthFormSchema>>;
+/** The inferred type for the forgot password authentication form schema. */
 type ForgotPasswordAuthFormSchema = z.infer<ReturnType<typeof createForgotPasswordAuthFormSchema>>;
+/** The inferred type for the email link authentication form schema. */
 type EmailLinkAuthFormSchema = z.infer<ReturnType<typeof createEmailLinkAuthFormSchema>>;
+/** The inferred type for the phone authentication number form schema. */
 type PhoneAuthNumberFormSchema = z.infer<ReturnType<typeof createPhoneAuthNumberFormSchema>>;
+/** The inferred type for the phone authentication verification form schema. */
 type PhoneAuthVerifyFormSchema = z.infer<ReturnType<typeof createPhoneAuthVerifyFormSchema>>;
+/** The inferred type for the multi-factor phone authentication number form schema. */
 type MultiFactorPhoneAuthNumberFormSchema = z.infer<ReturnType<typeof createMultiFactorPhoneAuthNumberFormSchema>>;
+/** The inferred type for the multi-factor TOTP authentication number form schema. */
 type MultiFactorTotpAuthNumberFormSchema = z.infer<ReturnType<typeof createMultiFactorTotpAuthNumberFormSchema>>;
+/** The inferred type for the multi-factor TOTP authentication verification form schema. */
 type MultiFactorTotpAuthVerifyFormSchema = z.infer<ReturnType<typeof createMultiFactorTotpAuthVerifyFormSchema>>;
 
 /**
@@ -3983,14 +4545,20 @@ type MultiFactorTotpAuthVerifyFormSchema = z.infer<ReturnType<typeof createMulti
  * limitations under the License.
  */
 
-declare function getTranslation<T extends TranslationCategory>(ui: FirebaseUI, category: T, key: TranslationKey<T>): string;
-
 /**
- * Register a framework with the FirebaseUI configuration.
- * @internal
- * @param framework The type of framework being registered.
- * @param version The version of the framework being registered.
+ * Gets a translated string for a given category and key.
+ *
+ * Example:
+ * ```typescript
+ * const translation = getTranslation(ui, "errors", "userNotFound");
+ * ```
+ *
+ * @param ui - The FirebaseUI instance.
+ * @param category - The translation category.
+ * @param key - The translation key.
+ * @param replacements - Optional replacements for placeholders.
+ * @returns The translated string.
  */
-declare function registerFramework(framework: string, version: string): void;
+declare function getTranslation<T extends TranslationCategory>(ui: FirebaseUI, category: T, key: TranslationKey<T>, replacements?: Record<string, string>): string;
 
-export { $config, type AuthMode, type AutoUpgradeAnonymousUsersOptions, type Behavior, type Behaviors, type CountryData, type EmailLinkAuthFormSchema, type FirebaseUI, FirebaseUIError, type FirebaseUIOptions, type FirebaseUIStore, type ForgotPasswordAuthFormSchema, type LoginType, LoginTypes, type MultiFactorPhoneAuthNumberFormSchema, type MultiFactorTotpAuthNumberFormSchema, type MultiFactorTotpAuthVerifyFormSchema, type OneTapSignInOptions, type PhoneAuthNumberFormSchema, type PhoneAuthVerifyFormSchema, type RecaptchaVerificationOptions, type SignInAuthFormSchema, type SignUpAuthFormSchema, autoAnonymousLogin, autoUpgradeAnonymousUsers, completeEmailLinkSignIn, confirmPhoneNumber, countryCodes, countryData, createEmailLinkAuthFormSchema, createForgotPasswordAuthFormSchema, createMultiFactorPhoneAuthNumberFormSchema, createMultiFactorPhoneAuthVerifyFormSchema, createMultiFactorTotpAuthNumberFormSchema, createMultiFactorTotpAuthVerifyFormSchema, createPhoneAuthNumberFormSchema, createPhoneAuthVerifyFormSchema, createSignInAuthFormSchema, createSignUpAuthFormSchema, createUserWithEmailAndPassword, defaultBehaviors, enrollWithMultiFactorAssertion, formatPhoneNumber, generateTotpQrCode, generateTotpSecret, getBehavior, getTranslation, handleFirebaseError, hasBehavior, initializeUI, oneTapSignIn, providerPopupStrategy, providerRedirectStrategy, recaptchaVerification, registerFramework, requireDisplayName, sendPasswordResetEmail, sendSignInLinkToEmail, signInAnonymously, signInWithCredential, signInWithCustomToken, signInWithEmailAndPassword, signInWithEmailLink, signInWithMultiFactorAssertion, signInWithProvider, verifyPhoneNumber };
+export { $config, type AutoUpgradeAnonymousUsersOptions, type Behavior, type Behaviors, type CountryData, type EmailLinkAuthFormSchema, type FirebaseUI, FirebaseUIError, type FirebaseUIOptions, type FirebaseUIStore, type ForgotPasswordAuthFormSchema, type MultiFactorPhoneAuthNumberFormSchema, type MultiFactorTotpAuthNumberFormSchema, type MultiFactorTotpAuthVerifyFormSchema, type OneTapSignInOptions, type PhoneAuthNumberFormSchema, type PhoneAuthVerifyFormSchema, type RecaptchaVerificationOptions, type SignInAuthFormSchema, type SignUpAuthFormSchema, autoAnonymousLogin, autoUpgradeAnonymousUsers, completeEmailLinkSignIn, confirmPhoneNumber, countryCodes, countryData, createEmailLinkAuthFormSchema, createForgotPasswordAuthFormSchema, createMultiFactorPhoneAuthAssertionFormSchema, createMultiFactorPhoneAuthNumberFormSchema, createMultiFactorPhoneAuthVerifyFormSchema, createMultiFactorTotpAuthNumberFormSchema, createMultiFactorTotpAuthVerifyFormSchema, createPhoneAuthNumberFormSchema, createPhoneAuthVerifyFormSchema, createSignInAuthFormSchema, createSignUpAuthFormSchema, createUserWithEmailAndPassword, defaultBehaviors, enrollWithMultiFactorAssertion, formatPhoneNumber, generateTotpQrCode, generateTotpSecret, getBehavior, getTranslation, handleFirebaseError, hasBehavior, initializeUI, oneTapSignIn, providerPopupStrategy, providerRedirectStrategy, recaptchaVerification, registerFramework, requireDisplayName, sendPasswordResetEmail, sendSignInLinkToEmail, signInAnonymously, signInWithCredential, signInWithCustomToken, signInWithEmailAndPassword, signInWithEmailLink, signInWithMultiFactorAssertion, signInWithProvider, verifyPhoneNumber };