@firebase/auth 0.23.2-canary.23581c540 → 0.23.2-canary.3133e7619

package/dist/auth-public.d.ts

@@ -303,6 +303,8 @@ export declare interface Auth {
      * remembered or not. It also makes it easier to never persist the Auth state for applications
      * that are shared by other users or have sensitive data.
      *
+     * This method does not work in a Node.js environment.
+     *
      * @example
      * ```javascript
      * auth.setPersistence(browserSessionPersistence);
@@ -730,6 +732,9 @@ export declare const browserLocalPersistence: Persistence;
  * 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;
@@ -1299,6 +1304,8 @@ declare interface GetRecaptchaConfigResponse {
  * If sign-in succeeded, returns the signed in user. If sign-in was unsuccessful, fails with an
  * error. If no redirect operation was called, returns `null`.
  *
+ * This method does not work in a Node.js environment.
+ *
  * @example
  * ```javascript
  * // Sign in using a redirect.
@@ -1588,6 +1595,8 @@ export declare function initializeAuth(app: FirebaseApp, deps?: Dependencies): A
  * Thus, by calling this optional method, you will reduce the latency of future auth flows.
  * Loading the reCAPTCHA config early will also enhance the signal collected by reCAPTCHA.
  *
+ * This method does not work in a Node.js environment.
+ *
  * @example
  * ```javascript
  * initializeRecaptchaConfig(auth);
@@ -1632,6 +1641,9 @@ export declare function linkWithCredential(user: User, credential: AuthCredentia
 /**
  * Links the user account with the given phone number.
  *
+ * @remarks
+ * This method does not work in a Node.js environment.
+ *
  * @param user - The user.
  * @param phoneNumber - The user's phone number in E.164 format (e.g. +16505550101).
  * @param appVerifier - The {@link ApplicationVerifier}.
@@ -1646,6 +1658,7 @@ export declare function linkWithPhoneNumber(user: User, phoneNumber: string, app
  * @remarks
  * If the linking is successful, the returned result will contain the user and the provider's credential.
  *
+ * This method does not work in a Node.js environment.
  *
  * @example
  * ```javascript
@@ -1673,6 +1686,8 @@ export declare function linkWithPopup(user: User, provider: AuthProvider, resolv
  * Follow the {@link https://firebase.google.com/docs/auth/web/redirect-best-practices
  * | best practices} when using {@link linkWithRedirect}.
  *
+ * This method does not work in a Node.js environment.
+ *
  * @example
  * ```javascript
  * // Sign in using some other provider.
@@ -1692,7 +1707,6 @@ export declare function linkWithPopup(user: User, provider: AuthProvider, resolv
  * @param resolver - An instance of {@link PopupRedirectResolver}, optional
  * if already supplied to {@link initializeAuth} or provided by {@link getAuth}.
  *
- *
  * @public
  */
 export declare function linkWithRedirect(user: User, provider: AuthProvider, resolver?: PopupRedirectResolver): Promise<never>;
@@ -2274,6 +2288,9 @@ export declare class PhoneAuthCredential extends AuthCredential {
 /**
  * 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.
@@ -2450,6 +2467,9 @@ export declare class PhoneMultiFactorGenerator {
     /**
      * Provides a {@link PhoneMultiFactorAssertion} to confirm ownership of the phone second factor.
      *
+     * @remarks
+     * This method does not work in a Node.js environment.
+     *
      * @param phoneAuthCredential - A credential provided by {@link PhoneAuthProvider.credential}.
      * @returns A {@link PhoneMultiFactorAssertion} which can be used with
      * {@link MultiFactorResolver.resolveSignIn}
@@ -2601,7 +2621,10 @@ export declare function reauthenticateWithCredential(user: User, credential: Aut
 /**
  * Re-authenticates a user using a fresh phone credential.
  *
- * @remarks Use before operations such as {@link updatePassword} that require tokens from recent sign-in attempts.
+ * @remarks
+ * Use before operations such as {@link updatePassword} that require tokens from recent sign-in attempts.
+ *
+ * This method does not work in a Node.js environment.
  *
  * @param user - The user.
  * @param phoneNumber - The user's phone number in E.164 format (e.g. +16505550101).
@@ -2619,6 +2642,8 @@ export declare function reauthenticateWithPhoneNumber(user: User, phoneNumber: s
  * If the reauthentication is successful, the returned result will contain the user and the
  * provider's credential.
  *
+ * This method does not work in a Node.js environment.
+ *
  * @example
  * ```javascript
  * // Sign in using a popup.
@@ -2645,6 +2670,8 @@ export declare function reauthenticateWithPopup(user: User, provider: AuthProvid
  * Follow the {@link https://firebase.google.com/docs/auth/web/redirect-best-practices
  * | best practices} when using {@link reauthenticateWithRedirect}.
  *
+ * This method does not work in a Node.js environment.
+ *
  * @example
  * ```javascript
  * // Sign in using a redirect.
@@ -2716,6 +2743,9 @@ export declare interface RecaptchaParameters {
 /**
  * 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 {
@@ -2950,6 +2980,8 @@ export declare function sendSignInLinkToEmail(auth: Auth, email: string, actionC
  * remembered or not. It also makes it easier to never persist the `Auth` state for applications
  * that are shared by other users or have sensitive data.
  *
+ * This method does not work in a Node.js environment.
+ *
  * @example
  * ```javascript
  * setPersistence(auth, browserSessionPersistence);
@@ -3103,6 +3135,8 @@ export declare function signInWithEmailLink(auth: Auth, email: string, emailLink
  * {@link RecaptchaVerifier} (like React Native), but you need to use a
  * third-party {@link ApplicationVerifier} implementation.
  *
+ * This method does not work in a Node.js environment.
+ *
  * @example
  * ```javascript
  * // 'recaptcha-container' is the ID of an element in the DOM.
@@ -3131,6 +3165,8 @@ export declare function signInWithPhoneNumber(auth: Auth, phoneNumber: string, a
  * If succeeds, returns the signed in user along with the provider's credential. If sign in was
  * unsuccessful, returns an error object containing additional information about the error.
  *
+ * This method does not work in a Node.js environment.
+ *
  * @example
  * ```javascript
  * // Sign in using a popup.
@@ -3150,7 +3186,6 @@ export declare function signInWithPhoneNumber(auth: Auth, phoneNumber: string, a
  * @param resolver - An instance of {@link PopupRedirectResolver}, optional
  * if already supplied to {@link initializeAuth} or provided by {@link getAuth}.
  *
- *
  * @public
  */
 export declare function signInWithPopup(auth: Auth, provider: AuthProvider, resolver?: PopupRedirectResolver): Promise<UserCredential>;
@@ -3163,6 +3198,8 @@ export declare function signInWithPopup(auth: Auth, provider: AuthProvider, reso
  * Follow the {@link https://firebase.google.com/docs/auth/web/redirect-best-practices
  * | best practices} when using {@link signInWithRedirect}.
  *
+ * This method does not work in a Node.js environment.
+ *
  * @example
  * ```javascript
  * // Sign in using a redirect.
@@ -3475,6 +3512,9 @@ export declare function updatePassword(user: User, newPassword: string): Promise
 /**
  * Updates the user's phone number.
  *
+ * @remarks
+ * This method does not work in a Node.js environment.
+ *
  * @example
  * ```
  * // 'recaptcha-container' is the ID of an element in the DOM.

package/dist/auth.d.ts

@@ -312,6 +312,8 @@ export declare interface Auth {
      * remembered or not. It also makes it easier to never persist the Auth state for applications
      * that are shared by other users or have sensitive data.
      *
+     * This method does not work in a Node.js environment.
+     *
      * @example
      * ```javascript
      * auth.setPersistence(browserSessionPersistence);
@@ -972,6 +974,9 @@ export declare const browserLocalPersistence: Persistence;
  * 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;
@@ -1591,6 +1596,8 @@ declare interface GetRecaptchaConfigResponse {
  * If sign-in succeeded, returns the signed in user. If sign-in was unsuccessful, fails with an
  * error. If no redirect operation was called, returns `null`.
  *
+ * This method does not work in a Node.js environment.
+ *
  * @example
  * ```javascript
  * // Sign in using a redirect.
@@ -1923,6 +1930,8 @@ export declare function initializeAuth(app: FirebaseApp, deps?: Dependencies): A
  * Thus, by calling this optional method, you will reduce the latency of future auth flows.
  * Loading the reCAPTCHA config early will also enhance the signal collected by reCAPTCHA.
  *
+ * This method does not work in a Node.js environment.
+ *
  * @example
  * ```javascript
  * initializeRecaptchaConfig(auth);
@@ -1967,6 +1976,9 @@ export declare function linkWithCredential(user: User, credential: AuthCredentia
 /**
  * Links the user account with the given phone number.
  *
+ * @remarks
+ * This method does not work in a Node.js environment.
+ *
  * @param user - The user.
  * @param phoneNumber - The user's phone number in E.164 format (e.g. +16505550101).
  * @param appVerifier - The {@link ApplicationVerifier}.
@@ -1981,6 +1993,7 @@ export declare function linkWithPhoneNumber(user: User, phoneNumber: string, app
  * @remarks
  * If the linking is successful, the returned result will contain the user and the provider's credential.
  *
+ * This method does not work in a Node.js environment.
  *
  * @example
  * ```javascript
@@ -2008,6 +2021,8 @@ export declare function linkWithPopup(user: User, provider: AuthProvider, resolv
  * Follow the {@link https://firebase.google.com/docs/auth/web/redirect-best-practices
  * | best practices} when using {@link linkWithRedirect}.
  *
+ * This method does not work in a Node.js environment.
+ *
  * @example
  * ```javascript
  * // Sign in using some other provider.
@@ -2027,7 +2042,6 @@ export declare function linkWithPopup(user: User, provider: AuthProvider, resolv
  * @param resolver - An instance of {@link PopupRedirectResolver}, optional
  * if already supplied to {@link initializeAuth} or provided by {@link getAuth}.
  *
- *
  * @public
  */
 export declare function linkWithRedirect(user: User, provider: AuthProvider, resolver?: PopupRedirectResolver): Promise<never>;
@@ -2619,6 +2633,9 @@ export declare class PhoneAuthCredential extends AuthCredential {
 /**
  * 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.
@@ -2795,6 +2812,9 @@ export declare class PhoneMultiFactorGenerator {
     /**
      * Provides a {@link PhoneMultiFactorAssertion} to confirm ownership of the phone second factor.
      *
+     * @remarks
+     * This method does not work in a Node.js environment.
+     *
      * @param phoneAuthCredential - A credential provided by {@link PhoneAuthProvider.credential}.
      * @returns A {@link PhoneMultiFactorAssertion} which can be used with
      * {@link MultiFactorResolver.resolveSignIn}
@@ -3004,7 +3024,10 @@ export declare function reauthenticateWithCredential(user: User, credential: Aut
 /**
  * Re-authenticates a user using a fresh phone credential.
  *
- * @remarks Use before operations such as {@link updatePassword} that require tokens from recent sign-in attempts.
+ * @remarks
+ * Use before operations such as {@link updatePassword} that require tokens from recent sign-in attempts.
+ *
+ * This method does not work in a Node.js environment.
  *
  * @param user - The user.
  * @param phoneNumber - The user's phone number in E.164 format (e.g. +16505550101).
@@ -3022,6 +3045,8 @@ export declare function reauthenticateWithPhoneNumber(user: User, phoneNumber: s
  * If the reauthentication is successful, the returned result will contain the user and the
  * provider's credential.
  *
+ * This method does not work in a Node.js environment.
+ *
  * @example
  * ```javascript
  * // Sign in using a popup.
@@ -3048,6 +3073,8 @@ export declare function reauthenticateWithPopup(user: User, provider: AuthProvid
  * Follow the {@link https://firebase.google.com/docs/auth/web/redirect-best-practices
  * | best practices} when using {@link reauthenticateWithRedirect}.
  *
+ * This method does not work in a Node.js environment.
+ *
  * @example
  * ```javascript
  * // Sign in using a redirect.
@@ -3128,6 +3155,9 @@ export declare interface RecaptchaParameters {
 /**
  * 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 {
@@ -3364,6 +3394,8 @@ export declare function sendSignInLinkToEmail(auth: Auth, email: string, actionC
  * remembered or not. It also makes it easier to never persist the `Auth` state for applications
  * that are shared by other users or have sensitive data.
  *
+ * This method does not work in a Node.js environment.
+ *
  * @example
  * ```javascript
  * setPersistence(auth, browserSessionPersistence);
@@ -3526,6 +3558,8 @@ declare interface SignInWithIdpResponse extends IdTokenResponse {
  * {@link RecaptchaVerifier} (like React Native), but you need to use a
  * third-party {@link ApplicationVerifier} implementation.
  *
+ * This method does not work in a Node.js environment.
+ *
  * @example
  * ```javascript
  * // 'recaptcha-container' is the ID of an element in the DOM.
@@ -3569,6 +3603,8 @@ declare interface SignInWithPhoneNumberResponse extends IdTokenResponse {
  * If succeeds, returns the signed in user along with the provider's credential. If sign in was
  * unsuccessful, returns an error object containing additional information about the error.
  *
+ * This method does not work in a Node.js environment.
+ *
  * @example
  * ```javascript
  * // Sign in using a popup.
@@ -3588,7 +3624,6 @@ declare interface SignInWithPhoneNumberResponse extends IdTokenResponse {
  * @param resolver - An instance of {@link PopupRedirectResolver}, optional
  * if already supplied to {@link initializeAuth} or provided by {@link getAuth}.
  *
- *
  * @public
  */
 export declare function signInWithPopup(auth: Auth, provider: AuthProvider, resolver?: PopupRedirectResolver): Promise<UserCredential>;
@@ -3601,6 +3636,8 @@ export declare function signInWithPopup(auth: Auth, provider: AuthProvider, reso
  * Follow the {@link https://firebase.google.com/docs/auth/web/redirect-best-practices
  * | best practices} when using {@link signInWithRedirect}.
  *
+ * This method does not work in a Node.js environment.
+ *
  * @example
  * ```javascript
  * // Sign in using a redirect.
@@ -3941,6 +3978,9 @@ export declare function updatePassword(user: User, newPassword: string): Promise
 /**
  * Updates the user's phone number.
  *
+ * @remarks
+ * This method does not work in a Node.js environment.
+ *
  * @example
  * ```
  * // 'recaptcha-container' is the ID of an element in the DOM.

package/dist/browser-cjs/{index-a99ac085.js → index-48389c29.js}

@@ -6067,6 +6067,8 @@ function getAdditionalUserInfo(userCredential) {
  * remembered or not. It also makes it easier to never persist the `Auth` state for applications
  * that are shared by other users or have sensitive data.
  *
+ * This method does not work in a Node.js environment.
+ *
  * @example
  * ```javascript
  * setPersistence(auth, browserSessionPersistence);
@@ -6097,6 +6099,8 @@ function setPersistence(auth, persistence) {
  * Thus, by calling this optional method, you will reduce the latency of future auth flows.
  * Loading the reCAPTCHA config early will also enhance the signal collected by reCAPTCHA.
  *
+ * This method does not work in a Node.js environment.
+ *
  * @example
  * ```javascript
  * initializeRecaptchaConfig(auth);
@@ -7710,6 +7714,9 @@ const DEFAULT_PARAMS = {
 /**
  * An {@link https://www.google.com/recaptcha/ | reCAPTCHA}-based application verifier.
  *
+ * @remarks
+ * `RecaptchaVerifier` does not work in a Node.js environment.
+ *
  * @public
  */
 class RecaptchaVerifier {
@@ -7942,6 +7949,8 @@ class ConfirmationResultImpl {
  * {@link RecaptchaVerifier} (like React Native), but you need to use a
  * third-party {@link ApplicationVerifier} implementation.
  *
+ * This method does not work in a Node.js environment.
+ *
  * @example
  * ```javascript
  * // 'recaptcha-container' is the ID of an element in the DOM.
@@ -7965,6 +7974,9 @@ async function signInWithPhoneNumber(auth, phoneNumber, appVerifier) {
 /**
  * Links the user account with the given phone number.
  *
+ * @remarks
+ * This method does not work in a Node.js environment.
+ *
  * @param user - The user.
  * @param phoneNumber - The user's phone number in E.164 format (e.g. +16505550101).
  * @param appVerifier - The {@link ApplicationVerifier}.
@@ -7980,7 +7992,10 @@ async function linkWithPhoneNumber(user, phoneNumber, appVerifier) {
 /**
  * Re-authenticates a user using a fresh phone credential.
  *
- * @remarks Use before operations such as {@link updatePassword} that require tokens from recent sign-in attempts.
+ * @remarks
+ * Use before operations such as {@link updatePassword} that require tokens from recent sign-in attempts.
+ *
+ * This method does not work in a Node.js environment.
  *
  * @param user - The user.
  * @param phoneNumber - The user's phone number in E.164 format (e.g. +16505550101).
@@ -8055,6 +8070,9 @@ async function _verifyPhoneNumber(auth, options, verifier) {
 /**
  * Updates the user's phone number.
  *
+ * @remarks
+ * This method does not work in a Node.js environment.
+ *
  * @example
  * ```
  * // 'recaptcha-container' is the ID of an element in the DOM.
@@ -8094,6 +8112,9 @@ async function updatePhoneNumber(user, credential) {
 /**
  * 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.
@@ -8455,6 +8476,8 @@ const _POLL_WINDOW_CLOSE_TIMEOUT = new Delay(2000, 10000);
  * If succeeds, returns the signed in user along with the provider's credential. If sign in was
  * unsuccessful, returns an error object containing additional information about the error.
  *
+ * This method does not work in a Node.js environment.
+ *
  * @example
  * ```javascript
  * // Sign in using a popup.
@@ -8474,7 +8497,6 @@ const _POLL_WINDOW_CLOSE_TIMEOUT = new Delay(2000, 10000);
  * @param resolver - An instance of {@link PopupRedirectResolver}, optional
  * if already supplied to {@link initializeAuth} or provided by {@link getAuth}.
  *
- *
  * @public
  */
 async function signInWithPopup(auth, provider, resolver) {
@@ -8492,6 +8514,8 @@ async function signInWithPopup(auth, provider, resolver) {
  * If the reauthentication is successful, the returned result will contain the user and the
  * provider's credential.
  *
+ * This method does not work in a Node.js environment.
+ *
  * @example
  * ```javascript
  * // Sign in using a popup.
@@ -8522,6 +8546,7 @@ async function reauthenticateWithPopup(user, provider, resolver) {
  * @remarks
  * If the linking is successful, the returned result will contain the user and the provider's credential.
  *
+ * This method does not work in a Node.js environment.
  *
  * @example
  * ```javascript
@@ -8761,6 +8786,8 @@ function pendingRedirectKey(auth) {
  * Follow the {@link https://firebase.google.com/docs/auth/web/redirect-best-practices
  * | best practices} when using {@link signInWithRedirect}.
  *
+ * This method does not work in a Node.js environment.
+ *
  * @example
  * ```javascript
  * // Sign in using a redirect.
@@ -8815,6 +8842,8 @@ async function _signInWithRedirect(auth, provider, resolver) {
  * Follow the {@link https://firebase.google.com/docs/auth/web/redirect-best-practices
  * | best practices} when using {@link reauthenticateWithRedirect}.
  *
+ * This method does not work in a Node.js environment.
+ *
  * @example
  * ```javascript
  * // Sign in using a redirect.
@@ -8863,6 +8892,8 @@ async function _reauthenticateWithRedirect(user, provider, resolver) {
  * Follow the {@link https://firebase.google.com/docs/auth/web/redirect-best-practices
  * | best practices} when using {@link linkWithRedirect}.
  *
+ * This method does not work in a Node.js environment.
+ *
  * @example
  * ```javascript
  * // Sign in using some other provider.
@@ -8882,7 +8913,6 @@ async function _reauthenticateWithRedirect(user, provider, resolver) {
  * @param resolver - An instance of {@link PopupRedirectResolver}, optional
  * if already supplied to {@link initializeAuth} or provided by {@link getAuth}.
  *
- *
  * @public
  */
 function linkWithRedirect(user, provider, resolver) {
@@ -8909,6 +8939,8 @@ async function _linkWithRedirect(user, provider, resolver) {
  * If sign-in succeeded, returns the signed in user. If sign-in was unsuccessful, fails with an
  * error. If no redirect operation was called, returns `null`.
  *
+ * This method does not work in a Node.js environment.
+ *
  * @example
  * ```javascript
  * // Sign in using a redirect.
@@ -9645,6 +9677,9 @@ class BrowserPopupRedirectResolver {
  * An implementation of {@link PopupRedirectResolver} suitable for browser
  * based applications.
  *
+ * @remarks
+ * This method does not work in a Node.js environment.
+ *
  * @public
  */
 const browserPopupRedirectResolver = BrowserPopupRedirectResolver;
@@ -9705,6 +9740,9 @@ class PhoneMultiFactorGenerator {
     /**
      * Provides a {@link PhoneMultiFactorAssertion} to confirm ownership of the phone second factor.
      *
+     * @remarks
+     * This method does not work in a Node.js environment.
+     *
      * @param phoneAuthCredential - A credential provided by {@link PhoneAuthProvider.credential}.
      * @returns A {@link PhoneMultiFactorAssertion} which can be used with
      * {@link MultiFactorResolver.resolveSignIn}
@@ -9866,7 +9904,7 @@ function _isEmptyString(input) {
 }
 
 var name = "@firebase/auth";
-var version = "0.23.2-canary.23581c540";
+var version = "0.23.2-canary.3133e7619";
 
 /**
  * @license
@@ -10191,4 +10229,4 @@ exports.updateProfile = updateProfile;
 exports.useDeviceLanguage = useDeviceLanguage;
 exports.verifyBeforeUpdateEmail = verifyBeforeUpdateEmail;
 exports.verifyPasswordResetCode = verifyPasswordResetCode;
-//# sourceMappingURL=index-a99ac085.js.map
+//# sourceMappingURL=index-48389c29.js.map