Skip to content

Commit 8dd911f

Browse files
Merge master into release
2 parents 3f12eca + 2ccc9dd commit 8dd911f

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

47 files changed

+359
-450
lines changed

.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 0 additions & 50 deletions
This file was deleted.

.github/ISSUE_TEMPLATE/bug_report_v2.yaml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
name: 🐞 Bug Report V2
1+
name: 🐞 Bug Report
22
description: File a bug report
3-
title: '[Bug]: '
3+
title: 'Title for the bug'
44
labels: 'new, type: question'
55
body:
66
- type: markdown

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Firebase Javascript SDK
22

33
<!-- BADGES -->
4-
![Build Status](https://img.shields.io/github/workflow/status/firebase/firebase-js-sdk/Run%20All%20Tests.svg)
4+
![Build Status](https://img.shields.io/github/actions/workflow/status/firebase/firebase-js-sdk/test-all.yml)
55
[![Version](https://img.shields.io/npm/v/firebase.svg?label=version)](https://www.npmjs.com/package/firebase)
66
[![Coverage Status](https://coveralls.io/repos/github/firebase/firebase-js-sdk/badge.svg?branch=master)](https://coveralls.io/github/firebase/firebase-js-sdk?branch=master)
77
<!-- END BADGES -->

docs-devsite/analytics.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ https://github.com/firebase/firebase-js-sdk
1010
{% endcomment %}
1111

1212
# analytics package
13-
Firebase Analytics
13+
The Firebase Analytics Web SDK. This SDK does not work in a Node.js environment.
1414

1515
## Functions
1616

docs-devsite/app-check.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,9 @@ https://github.com/firebase/firebase-js-sdk
1010
{% endcomment %}
1111

1212
# app-check package
13-
Firebase App Check
13+
The Firebase App Check Web SDK.
14+
15+
Firebase App Check does not work in a Node.js environment using `ReCaptchaV3Provider` or `ReCaptchaEnterpriseProvider`<!-- -->, but can be used in Node.js if you use `CustomProvider` and write your own attestation method.
1416

1517
## Functions
1618

docs-devsite/auth.auth.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -221,6 +221,8 @@ This will affect the currently saved Auth session and applies this type of persi
221221

222222
This makes it easy for a user signing in to specify whether their session should be 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.
223223

224+
This method does not work in a Node.js environment.
225+
224226
<b>Signature:</b>
225227

226228
```typescript

docs-devsite/auth.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -442,6 +442,8 @@ Returns a [UserCredential](./auth.usercredential.md#usercredential_interface) fr
442442

443443
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`<!-- -->.
444444

445+
This method does not work in a Node.js environment.
446+
445447
<b>Signature:</b>
446448

447449
```typescript
@@ -497,6 +499,8 @@ If initializeRecaptchaConfig() is not invoked, the auth flow will always start w
497499

498500
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.
499501

502+
This method does not work in a Node.js environment.
503+
500504
<b>Signature:</b>
501505

502506
```typescript
@@ -694,6 +698,8 @@ Changes the type of persistence on the [Auth](./auth.auth.md#auth_interface) ins
694698

695699
This makes it easy for a user signing in to specify whether their session should be 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.
696700

701+
This method does not work in a Node.js environment.
702+
697703
<b>Signature:</b>
698704

699705
```typescript
@@ -877,6 +883,8 @@ This method sends a code via SMS to the given phone number, and returns a [Confi
877883

878884
For abuse prevention, this method also requires a [ApplicationVerifier](./auth.applicationverifier.md#applicationverifier_interface)<!-- -->. This SDK includes a reCAPTCHA-based implementation, [RecaptchaVerifier](./auth.recaptchaverifier.md#recaptchaverifier_class)<!-- -->. This function can work on other platforms that do not support the [RecaptchaVerifier](./auth.recaptchaverifier.md#recaptchaverifier_class) (like React Native), but you need to use a third-party [ApplicationVerifier](./auth.applicationverifier.md#applicationverifier_interface) implementation.
879885

886+
This method does not work in a Node.js environment.
887+
880888
<b>Signature:</b>
881889

882890
```typescript
@@ -913,6 +921,8 @@ Authenticates a Firebase client using a popup-based OAuth authentication flow.
913921

914922
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.
915923

924+
This method does not work in a Node.js environment.
925+
916926
<b>Signature:</b>
917927

918928
```typescript
@@ -953,6 +963,8 @@ Authenticates a Firebase client using a full-page redirect flow.
953963

954964
To handle the results and errors for this operation, refer to [getRedirectResult()](./auth.md#getredirectresult)<!-- -->. Follow the [best practices](https://firebase.google.com/docs/auth/web/redirect-best-practices) when using [signInWithRedirect()](./auth.md#signinwithredirect)<!-- -->.
955965

966+
This method does not work in a Node.js environment.
967+
956968
<b>Signature:</b>
957969

958970
```typescript
@@ -1204,6 +1216,8 @@ Promise&lt;[UserCredential](./auth.usercredential.md#usercredential_interface)<!
12041216

12051217
Links the user account with the given phone number.
12061218

1219+
This method does not work in a Node.js environment.
1220+
12071221
<b>Signature:</b>
12081222

12091223
```typescript
@@ -1228,6 +1242,8 @@ Links the authenticated provider to the user account using a pop-up based OAuth
12281242

12291243
If the linking is successful, the returned result will contain the user and the provider's credential.
12301244

1245+
This method does not work in a Node.js environment.
1246+
12311247
<b>Signature:</b>
12321248

12331249
```typescript
@@ -1264,6 +1280,8 @@ Links the [OAuthProvider](./auth.oauthprovider.md#oauthprovider_class) to the us
12641280

12651281
To handle the results and errors for this operation, refer to [getRedirectResult()](./auth.md#getredirectresult)<!-- -->. Follow the [best practices](https://firebase.google.com/docs/auth/web/redirect-best-practices) when using [linkWithRedirect()](./auth.md#linkwithredirect)<!-- -->.
12661282

1283+
This method does not work in a Node.js environment.
1284+
12671285
<b>Signature:</b>
12681286

12691287
```typescript
@@ -1349,6 +1367,8 @@ Re-authenticates a user using a fresh phone credential.
13491367

13501368
Use before operations such as [updatePassword()](./auth.md#updatepassword) that require tokens from recent sign-in attempts.
13511369

1370+
This method does not work in a Node.js environment.
1371+
13521372
<b>Signature:</b>
13531373

13541374
```typescript
@@ -1373,6 +1393,8 @@ Reauthenticates the current user with the specified [OAuthProvider](./auth.oauth
13731393

13741394
If the reauthentication is successful, the returned result will contain the user and the provider's credential.
13751395

1396+
This method does not work in a Node.js environment.
1397+
13761398
<b>Signature:</b>
13771399

13781400
```typescript
@@ -1409,6 +1431,8 @@ Reauthenticates the current user with the specified [OAuthProvider](./auth.oauth
14091431

14101432
To handle the results and errors for this operation, refer to [getRedirectResult()](./auth.md#getredirectresult)<!-- -->. Follow the [best practices](https://firebase.google.com/docs/auth/web/redirect-best-practices) when using [reauthenticateWithRedirect()](./auth.md#reauthenticatewithredirect)<!-- -->.
14111433

1434+
This method does not work in a Node.js environment.
1435+
14121436
<b>Signature:</b>
14131437

14141438
```typescript
@@ -1585,6 +1609,8 @@ Promise&lt;void&gt;
15851609

15861610
Updates the user's phone number.
15871611

1612+
This method does not work in a Node.js environment.
1613+
15881614
<b>Signature:</b>
15891615

15901616
```typescript
@@ -1855,6 +1881,8 @@ browserLocalPersistence: Persistence
18551881

18561882
An implementation of [PopupRedirectResolver](./auth.popupredirectresolver.md#popupredirectresolver_interface) suitable for browser based applications.
18571883

1884+
This method does not work in a Node.js environment.
1885+
18581886
<b>Signature:</b>
18591887

18601888
```typescript

docs-devsite/auth.phoneauthprovider.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,8 @@ https://github.com/firebase/firebase-js-sdk
1212
# PhoneAuthProvider class
1313
Provider for generating an [PhoneAuthCredential](./auth.phoneauthcredential.md#phoneauthcredential_class)<!-- -->.
1414

15+
`PhoneAuthProvider` does not work in a Node.js environment.
16+
1517
<b>Signature:</b>
1618

1719
```typescript

docs-devsite/auth.phonemultifactorgenerator.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,8 @@ static FACTOR_ID: string;
4444

4545
Provides a [PhoneMultiFactorAssertion](./auth.phonemultifactorassertion.md#phonemultifactorassertion_interface) to confirm ownership of the phone second factor.
4646

47+
This method does not work in a Node.js environment.
48+
4749
<b>Signature:</b>
4850

4951
```typescript

docs-devsite/auth.recaptchaverifier.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,8 @@ https://github.com/firebase/firebase-js-sdk
1212
# RecaptchaVerifier class
1313
An [reCAPTCHA](https://www.google.com/recaptcha/)<!-- -->-based application verifier.
1414

15+
`RecaptchaVerifier` does not work in a Node.js environment.
16+
1517
<b>Signature:</b>
1618

1719
```typescript

0 commit comments

Comments
 (0)