Skip to content

Commit 5ae04bc

Browse files
Merge main into release
2 parents 67ea4f7 + aef5468 commit 5ae04bc

File tree

273 files changed

+1403
-874
lines changed

Some content is hidden

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

273 files changed

+1403
-874
lines changed

.changeset/config.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
"commit": false,
88
"linked": [],
99
"access": "public",
10-
"baseBranch": "master",
10+
"baseBranch": "main",
1111
"updateInternalDependencies": "patch",
1212
"ignore": [
1313
"firebase-namespace-integration-test",

.changeset/late-humans-tan.md

+12
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
---
2+
'@firebase/firestore-compat': patch
3+
'@firebase/database-compat': patch
4+
'@firebase/auth-compat': patch
5+
'@firebase/app-compat': patch
6+
'@firebase/firestore': patch
7+
'@firebase/database': patch
8+
'firebase': patch
9+
'@firebase/auth': patch
10+
---
11+
12+
Fixed typos in documentation and some internal variables and parameters.

.changeset/spicy-dragons-pay.md

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
'@firebase/app-compat': patch
3+
---
4+
5+
Properly handle the case in app-compat checks where `window` exists but `self` does not. (This occurs in Ionic Stencil's Jest preset.)

.changeset/tender-apes-clap.md

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
---
2+
'@firebase/analytics': patch
3+
'@firebase/app-check': patch
4+
---
5+
6+
Revert introduction of safevalues to prevent issues from arising in Browser CommonJS environments due to ES5 incompatibility. For more information, see [GitHub PR #8395](https://github.com/firebase/firebase-js-sdk/pull/8395)

.editorconfig

+1-1
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ root = true
1111
end_of_line = lf
1212
insert_final_newline = true
1313

14-
# Javascript and Typescript look like Google-style
14+
# JavaScript and TypeScript look like Google-style
1515
[*.{js,json,ts}]
1616
charset = utf-8
1717
indent_style = space

.github/ISSUE_TEMPLATE/bug_report_v2.yaml

+1-1
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ body:
2222
attributes:
2323
value: |
2424
*[READ THIS]:* to evaluate if you are in the right place?
25-
- For issues or feature requests related to __the code in this repository__, file a Github issue.
25+
- For issues or feature requests related to __the code in this repository__, file a GitHub issue.
2626
- If this is a __feature request__, make sure the issue title starts with "FR:".
2727
- For general technical questions, post a question on [StackOverflow](http://stackoverflow.com/) with the firebase tag.
2828
- For general Firebase discussion, use the [firebase-talk](https://groups.google.com/forum/#!forum/firebase-talk) google group.

.github/workflows/canary-deploy.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ name: Canary Deploy
1717
on:
1818
push:
1919
branches:
20-
- master
20+
- main
2121
workflow_dispatch:
2222

2323
jobs:

.github/workflows/check-changeset.yml

+7-7
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ name: Check Changeset
1717
on:
1818
pull_request:
1919
branches:
20-
- master
20+
- main
2121

2222
env:
2323
GITHUB_PULL_REQUEST_HEAD_SHA: ${{ github.event.pull_request.head.sha }}
@@ -41,9 +41,9 @@ jobs:
4141
- name: Yarn install
4242
run: yarn
4343
- name: Run changeset script
44-
# pull master so changeset can diff against it
44+
# pull main so changeset can diff against it
4545
run: |
46-
git pull -f --no-rebase origin master:master
46+
git pull -f --no-rebase origin main:main
4747
yarn ts-node-script scripts/ci/check_changeset.ts
4848
id: check-changeset
4949
- name: Print changeset checker output
@@ -54,22 +54,22 @@ jobs:
5454
- name: Print blocking failure status
5555
run: echo "${{steps.check-changeset.outputs.BLOCKING_FAILURE}}"
5656
- name: Find Comment
57-
uses: peter-evans/find-comment@v1
57+
uses: peter-evans/find-comment@v3
5858
id: fc
5959
with:
6060
issue-number: ${{github.event.number}}
6161
body-includes: Changeset File Check
6262
- name: Create comment (missing packages)
6363
if: ${{!steps.fc.outputs.comment-id && steps.check-changeset.outputs.CHANGESET_ERROR_MESSAGE}}
64-
uses: peter-evans/create-or-update-comment@v1
64+
uses: peter-evans/create-or-update-comment@v4
6565
with:
6666
issue-number: ${{github.event.number}}
6767
body: |
6868
### Changeset File Check :warning:
6969
${{steps.check-changeset.outputs.CHANGESET_ERROR_MESSAGE}}
7070
- name: Update comment (missing packages)
7171
if: ${{steps.fc.outputs.comment-id}}
72-
uses: peter-evans/create-or-update-comment@v1
72+
uses: peter-evans/create-or-update-comment@v4
7373
with:
7474
comment-id: ${{steps.fc.outputs.comment-id}} && steps.check-changeset.outputs.CHANGESET_ERROR_MESSAGE}}
7575
edit-mode: replace
@@ -78,7 +78,7 @@ jobs:
7878
${{steps.check-changeset.outputs.CHANGESET_ERROR_MESSAGE}}
7979
- name: Update comment (no missing packages)
8080
if: ${{steps.fc.outputs.comment-id && !steps.check-changeset.outputs.CHANGESET_ERROR_MESSAGE}}
81-
uses: peter-evans/create-or-update-comment@v1
81+
uses: peter-evans/create-or-update-comment@v4
8282
with:
8383
comment-id: ${{steps.fc.outputs.comment-id}}
8484
edit-mode: replace

.github/workflows/merge-release-branch.yml

+4-4
Original file line numberDiff line numberDiff line change
@@ -12,12 +12,12 @@
1212
# See the License for the specific language governing permissions and
1313
# limitations under the License.
1414

15-
name: Merge Release Into Master
15+
name: Merge Release Into Main
1616

1717
on: workflow_dispatch
1818

1919
jobs:
20-
merge_to_master:
20+
merge_to_main:
2121
runs-on: ubuntu-latest
2222
# Allow GITHUB_TOKEN to have write permissions
2323
permissions:
@@ -36,15 +36,15 @@ jobs:
3636
- name: Echo version in shell
3737
run: |
3838
echo "Merging release ${{ steps.get-version.outputs.RELEASE_VERSION }}"
39-
- name: Merge to master
39+
- name: Merge to main
4040
uses: actions/github-script@v6
4141
with:
4242
github-token: ${{ secrets.GITHUB_TOKEN }}
4343
script: |
4444
github.rest.repos.merge({
4545
owner: context.repo.owner,
4646
repo: context.repo.repo,
47-
base: 'master',
47+
base: 'main',
4848
head: 'release',
4949
commit_message: 'Release ${{ steps.get-version.outputs.RELEASE_VERSION }}'
5050
})

.github/workflows/release-pr.yml

+2-2
Original file line numberDiff line numberDiff line change
@@ -43,9 +43,9 @@ jobs:
4343
# Ensures a new @firebase/app is published with every release.
4444
# This keeps the SDK_VERSION variable up to date.
4545
- name: Add a changeset for @firebase/app
46-
# pull master so changeset can diff against it
46+
# pull main so changeset can diff against it
4747
run: |
48-
git pull -f --no-rebase origin master:master
48+
git pull -f --no-rebase origin main:main
4949
yarn ts-node-script scripts/ci/add_changeset.ts
5050
5151
- name: Create Release Pull Request

.github/workflows/release-prod.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -120,7 +120,7 @@ jobs:
120120
curl -X POST -H "Content-Type:application/json" \
121121
-d "{\"version\":\"$BASE_VERSION\",\"date\":\"$DATE\"}" \
122122
$RELEASE_TRACKER_URL/logProduction
123-
- name: Create Github release
123+
- name: Create GitHub release
124124
env:
125125
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
126126
run: |

.github/workflows/release-staging.yml

+3-3
Original file line numberDiff line numberDiff line change
@@ -25,10 +25,10 @@ on:
2525
source-branch:
2626
description: 'Branch to release from'
2727
type: choice
28-
default: 'master'
28+
default: 'main'
2929
required: true
3030
options:
31-
- master
31+
- main
3232
- v8
3333
verbose:
3434
description: 'Enable verbose logging'
@@ -50,7 +50,7 @@ jobs:
5050
uses: actions/setup-node@v3
5151
with:
5252
node-version: 20.x
53-
- name: Merge master into release
53+
- name: Merge main into release
5454
uses: actions/github-script@v6
5555
with:
5656
github-token: ${{ secrets.OSS_BOT_GITHUB_TOKEN }}

.github/workflows/test-all.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ env:
2020
# make chromedriver detect installed Chrome version and download the corresponding driver
2121
DETECT_CHROMEDRIVER_VERSION: true
2222
# The default behavior of chromedriver uses the older Chrome download URLs. We need to override
23-
# the beahvior to use the new URLs.
23+
# the behavior to use the new URLs.
2424
CHROMEDRIVER_CDNURL: https://googlechromelabs.github.io/
2525
CHROMEDRIVER_CDNBINARIESURL: https://storage.googleapis.com/chrome-for-testing-public
2626
CHROME_VALIDATED_VERSION: linux-120.0.6099.71

.github/workflows/test-changed-auth.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ env:
2020
# make chromedriver detect installed Chrome version and download the corresponding driver
2121
DETECT_CHROMEDRIVER_VERSION: true
2222
# The default behavior of chromedriver uses the older Chrome download URLs. We need to override
23-
# the beahvior to use the new URLs.
23+
# the behavior to use the new URLs.
2424
CHROMEDRIVER_CDNURL: https://googlechromelabs.github.io/
2525
CHROMEDRIVER_CDNBINARIESURL: https://storage.googleapis.com/chrome-for-testing-public
2626
CHROME_VALIDATED_VERSION: linux-120.0.6099.71

CONTRIBUTING.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -115,7 +115,7 @@ review.
115115
* Make your changes in a new git branch:
116116

117117
```shell
118-
git checkout -b my-fix-branch master
118+
git checkout -b my-fix-branch main
119119
```
120120

121121
* Create your change, **including appropriate test cases**. Changes with tests are more likely to be
@@ -144,7 +144,7 @@ entries to the `.gitignore`).
144144
git push origin my-fix-branch
145145
```
146146

147-
* In GitHub, create a pull request against the `firebase-js-sdk:master` branch.
147+
* In GitHub, create a pull request against the `firebase-js-sdk:main` branch.
148148
* Add changeset. See [Adding changeset to PR](#adding-changeset-to-pr).
149149
* All pull requests must be reviewed by a member of the Firebase JS SDK team, who will merge it
150150
when/if they feel it is good to go.

README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
1-
# Firebase Javascript SDK
1+
# Firebase JavaScript SDK
22

33
<!-- BADGES -->
44
![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)
6-
[![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)
6+
[![Coverage Status](https://coveralls.io/repos/github/firebase/firebase-js-sdk/badge.svg?branch=main)](https://coveralls.io/github/firebase/firebase-js-sdk?branch=main)
77
<!-- END BADGES -->
88

99
The Firebase JavaScript SDK implements the client-side libraries used by

config/api-extractor.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -289,7 +289,7 @@
289289
*/
290290
"default": {
291291
/**
292-
* Specifies whether the message should be written to the the tool's output log. Note that
292+
* Specifies whether the message should be written to the tool's output log. Note that
293293
* the "addToApiReportFile" property may supersede this option.
294294
*
295295
* Possible values: "error", "warning", "none"

config/karma.saucelabs.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -105,7 +105,7 @@ function getPackageLabels() {
105105

106106
/**
107107
* Gets a list of file patterns for test, defined individually
108-
* in karma.conf.js in each package under worksapce packages or
108+
* in karma.conf.js in each package under workspace packages or
109109
* integration.
110110
*/
111111
function getTestFiles() {

docs-devsite/auth.githubauthprovider.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ export declare class GithubAuthProvider extends BaseOAuthProvider
3838
3939
| Method | Modifiers | Description |
4040
| --- | --- | --- |
41-
| [credential(accessToken)](./auth.githubauthprovider.md#githubauthprovidercredential) | <code>static</code> | Creates a credential for Github. |
41+
| [credential(accessToken)](./auth.githubauthprovider.md#githubauthprovidercredential) | <code>static</code> | Creates a credential for GitHub. |
4242
| [credentialFromError(error)](./auth.githubauthprovider.md#githubauthprovidercredentialfromerror) | <code>static</code> | Used to extract the underlying [OAuthCredential](./auth.oauthcredential.md#oauthcredential_class) from a [AuthError](./auth.autherror.md#autherror_interface) which was thrown during a sign-in, link, or reauthenticate operation. |
4343
| [credentialFromResult(userCredential)](./auth.githubauthprovider.md#githubauthprovidercredentialfromresult) | <code>static</code> | Used to extract the underlying [OAuthCredential](./auth.oauthcredential.md#oauthcredential_class) from a [UserCredential](./auth.usercredential.md#usercredential_interface)<!-- -->. |
4444
@@ -74,7 +74,7 @@ static readonly PROVIDER_ID: 'github.com';
7474
7575
## GithubAuthProvider.credential()
7676
77-
Creates a credential for Github.
77+
Creates a credential for GitHub.
7878
7979
<b>Signature:</b>
8080
@@ -86,7 +86,7 @@ static credential(accessToken: string): OAuthCredential;
8686
8787
| Parameter | Type | Description |
8888
| --- | --- | --- |
89-
| accessToken | string | Github access token. |
89+
| accessToken | string | GitHub access token. |
9090
9191
<b>Returns:</b>
9292
@@ -148,7 +148,7 @@ const result = await getRedirectResult(auth);
148148
if (result) {
149149
// This is the signed-in user
150150
const user = result.user;
151-
// This gives you a Github Access Token.
151+
// This gives you a GitHub Access Token.
152152
const credential = GithubAuthProvider.credentialFromResult(result);
153153
const token = credential.accessToken;
154154
}
@@ -166,7 +166,7 @@ const result = await signInWithPopup(auth, provider);
166166

167167
// The signed-in user info.
168168
const user = result.user;
169-
// This gives you a Github Access Token.
169+
// This gives you a GitHub Access Token.
170170
const credential = GithubAuthProvider.credentialFromResult(result);
171171
const token = credential.accessToken;
172172

docs-devsite/database.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ Firebase Realtime Database
1717
| Function | Description |
1818
| --- | --- |
1919
| <b>function(app, ...)</b> |
20-
| [getDatabase(app, url)](./database.md#getdatabase_d9cea01) | Returns the instance of the Realtime Database SDK that is associated with the provided [FirebaseApp](./app.firebaseapp.md#firebaseapp_interface)<!-- -->. Initializes a new instance with with default settings if no instance exists or if the existing instance uses a custom database URL. |
20+
| [getDatabase(app, url)](./database.md#getdatabase_d9cea01) | Returns the instance of the Realtime Database SDK that is associated with the provided [FirebaseApp](./app.firebaseapp.md#firebaseapp_interface)<!-- -->. Initializes a new instance with default settings if no instance exists or if the existing instance uses a custom database URL. |
2121
| <b>function(db, ...)</b> |
2222
| [connectDatabaseEmulator(db, host, port, options)](./database.md#connectdatabaseemulator_27b9e93) | Modify the provided instance to communicate with the Realtime Database emulator.<p>Note: This method must be called before performing any other operation. |
2323
| [goOffline(db)](./database.md#gooffline_732b338) | Disconnects from the server (all Database operations will be completed offline).<!-- -->The client automatically maintains a persistent connection to the Database server, which will remain active indefinitely and reconnect when disconnected. However, the <code>goOffline()</code> and <code>goOnline()</code> methods may be used to control the client connection in cases where a persistent connection is undesirable.<!-- -->While offline, the client will no longer receive data updates from the Database. However, all Database operations performed locally will continue to immediately fire events, allowing your application to continue behaving normally. Additionally, each operation performed locally will automatically be queued and retried upon reconnection to the Database server.<!-- -->To reconnect to the Database and begin receiving remote events, see <code>goOnline()</code>. |
@@ -112,7 +112,7 @@ Firebase Realtime Database
112112

113113
### getDatabase(app, url) {:#getdatabase_d9cea01}
114114

115-
Returns the instance of the Realtime Database SDK that is associated with the provided [FirebaseApp](./app.firebaseapp.md#firebaseapp_interface)<!-- -->. Initializes a new instance with with default settings if no instance exists or if the existing instance uses a custom database URL.
115+
Returns the instance of the Realtime Database SDK that is associated with the provided [FirebaseApp](./app.firebaseapp.md#firebaseapp_interface)<!-- -->. Initializes a new instance with default settings if no instance exists or if the existing instance uses a custom database URL.
116116

117117
<b>Signature:</b>
118118

0 commit comments

Comments
 (0)