Copy fixes for documentation.

Author: DellaBitta

.changeset/afraid-fishes-repair.md

@@ -4,5 +4,5 @@
 'firebase': minor
 ---
 
-Added a new interface `FirebaseServerApp` which extends FirebaseApp and is intended to bridge state
-data between client and server runtime environments.
+Added the new `FirebaseServerApp` interface to bridge state
+data between client and server runtime environments. This interface extends `FirebaseApp`.

docs-devsite/app.firebaseserverapp.md

@@ -10,7 +10,7 @@ https://github.com/firebase/firebase-js-sdk
 {% endcomment %}
 
 # FirebaseServerApp interface
-A [FirebaseServerApp](./app.firebaseserverapp.md#firebaseserverapp_interface) holds the initialization information for a collection of services running in server enviornments.
+A [FirebaseServerApp](./app.firebaseserverapp.md#firebaseserverapp_interface) holds the initialization information for a collection of services running in server environments.
 
 Do not call this constructor directly. Instead, use [initializeServerApp()](./app.md#initializeserverapp_30ab697) to create an app.
 
@@ -25,7 +25,7 @@ export interface FirebaseServerApp extends FirebaseApp
 
 |  Property | Type | Description |
 |  --- | --- | --- |
-|  [authIdTokenVerified](./app.firebaseserverapp.md#firebaseserverappauthidtokenverified) | () =&gt; Promise&lt;void&gt; | Checks to see if the local verification of the <code>authIdToken</code> provided to [initializeServerApp()](./app.md#initializeserverapp_30ab697) has completed.<!-- -->It is recommend that your application awaits this <code>Promise</code> before invoking <code>getAuth</code> if an <code>authIdToken</code> was provided in the <code>FirebaseServerAppSettings</code>.<!-- -->The returned <code>Promise</code> is completed immediately if the optional authIdToken parameter was omitted from <code>FirebaseServerApp</code> initialization. |
+|  [authIdTokenVerified](./app.firebaseserverapp.md#firebaseserverappauthidtokenverified) | () =&gt; Promise&lt;void&gt; | Checks to see if the local verification of the <code>authIdToken</code> provided to [initializeServerApp()](./app.md#initializeserverapp_30ab697) has completed.<!-- -->It is recommend that your application awaits this <code>Promise</code> before invoking <code>getAuth</code> if an <code>authIdToken</code> was provided in the <code>FirebaseServerAppSettings</code>.<!-- -->The returned <code>Promise</code> is completed immediately if the optional <code>authIdToken</code> parameter was omitted from <code>FirebaseServerApp</code> initialization. |
 |  [name](./app.firebaseserverapp.md#firebaseserverappname) | string | There is no <code>getApp()</code> operation for <code>FirebaseServerApp</code>, so the name is not relevant for applications. However, it may be used internally, and is declared here so that <code>FirebaseServerApp</code> conforms to the <code>FirebaseApp</code> interface. |
 |  [settings](./app.firebaseserverapp.md#firebaseserverappsettings) | [FirebaseServerAppSettings](./app.firebaseserverappsettings.md#firebaseserverappsettings_interface) | The (read-only) configuration settings for this server app. These are the original parameters given in [initializeServerApp()](./app.md#initializeserverapp_30ab697)<!-- -->. |
 
@@ -35,7 +35,7 @@ Checks to see if the local verification of the `authIdToken` provided to [initia
 
 It is recommend that your application awaits this `Promise` before invoking `getAuth` if an `authIdToken` was provided in the `FirebaseServerAppSettings`<!-- -->.
 
-The returned `Promise` is completed immediately if the optional authIdToken parameter was omitted from `FirebaseServerApp` initialization.
+The returned `Promise` is completed immediately if the optional `authIdToken` parameter was omitted from `FirebaseServerApp` initialization.
 
 <b>Signature:</b>
 

docs-devsite/app.firebaseserverappsettings.md

@@ -24,8 +24,8 @@ export interface FirebaseServerAppSettings extends FirebaseAppSettings
 |  Property | Type | Description |
 |  --- | --- | --- |
 |  [authIdToken](./app.firebaseserverappsettings.md#firebaseserverappsettingsauthidtoken) | string | An optional Auth ID token used to resume a signed in user session from a client runtime environment.<!-- -->If provided, the <code>FirebaseServerApp</code> works to validate the token even before <code>Auth</code> is initialized. The result of the validation can be queried via . Awaiting the <code>Promise</code> returned by  is highly recommended if an <code>authIdToken</code> token is provided.<!-- -->Invoking <code>getAuth</code> with a <code>FirebaseServerApp</code> configured with a validated <code>authIdToken</code> causes an automatic attempt to sign in the user that the <code>authIdToken</code> represents. The token needs to have been recently minted for this operation to succeed.<!-- -->If the token fails local verification, or if the Auth service has failed to validate it when the Auth SDK is initialized, then a warning is logged to the console and the Auth SDK will not sign in a user on initalization.<!-- -->If a user is successfully signed in, then the Auth instance's <code>onAuthStateChanged</code> callback is invoked with the <code>User</code> object as per standard Auth flows. However, <code>User</code> objects created via an <code>authIdToken</code> do not have a refresh token. Attempted <code>refreshToken</code> operations fail. |
-|  [name](./app.firebaseserverappsettings.md#firebaseserverappsettingsname) | undefined | There is no get for <code>FirebaseServerApp</code>, so the name is not relevant. However it's always a blank string so that <code>FirebaseServerAp</code>p<code> conforms to the </code>FirebaseApp<!-- -->\` interface declaration. |
-|  [releaseOnDeref](./app.firebaseserverappsettings.md#firebaseserverappsettingsreleaseonderef) | object | An optional object. If provided, the Firebase SDK uses a <code>FinalizationRegistry</code> object to monitor the garbage collection status of the provided object. The Firebase SDK releases its refrence on the <code>FirebaseServerApp</code> instance when the provided <code>releaseOnDeref</code> object is garbage collected.<!-- -->The intent of this field is to help reduce memory overhead for cloud functions. If provided, the customer's app running in a SSR pass need not worry about <code>FirebaseServerApp</code> cleanup, so long as the reference object is deleted (by falling out of SSR scope, for instance.)<!-- -->If an object is not provided then the application must clean up the <code>FirebaseServerApp</code> instance by invoking <code>deleteApp</code>.<!-- -->If the application provides an object in this parameter, but the application is executed in a JavaScript engine that predates the support of <code>FinalizationRegistry</code> (introduced in node v14.6.0, for instance), then an error is thrown at <code>FirebaseServerApp</code> initialization. |
+|  [name](./app.firebaseserverappsettings.md#firebaseserverappsettingsname) | undefined | There is no <code>getApp()</code> operation for <code>FirebaseServerApp</code>, so the name is not relevant for applications. However, it may be used internally, and is declared here so that <code>FirebaseServerApp</code> conforms to the <code>FirebaseApp</code> interface. |
+|  [releaseOnDeref](./app.firebaseserverappsettings.md#firebaseserverappsettingsreleaseonderef) | object | An optional object. If provided, the Firebase SDK uses a <code>FinalizationRegistry</code> object to monitor the garbage collection status of the provided object. The Firebase SDK releases its refrence on the <code>FirebaseServerApp</code> instance when the provided <code>releaseOnDeref</code> object is garbage collected.<!-- -->You can use this field to reduce memory management overhead for your application. If provided, an app running in a SSR pass does not need to perform <code>FirebaseServerApp</code> cleanup, so long as the reference object is deleted (by falling out of SSR scope, for instance.)<!-- -->If an object is not provided then the application must clean up the <code>FirebaseServerApp</code> instance by invoking <code>deleteApp</code>.<!-- -->If the application provides an object in this parameter, but the application is executed in a JavaScript engine that predates the support of <code>FinalizationRegistry</code> (introduced in node v14.6.0, for instance), then an error is thrown at <code>FirebaseServerApp</code> initialization. |
 
 ## FirebaseServerAppSettings.authIdToken
 
@@ -47,7 +47,7 @@ authIdToken?: string;
 
 ## FirebaseServerAppSettings.name
 
-There is no get for `FirebaseServerApp`<!-- -->, so the name is not relevant. However it's always a blank string so that `FirebaseServerAp`<!-- -->p` conforms to the `<!-- -->FirebaseApp<!-- -->\` interface declaration.
+There is no `getApp()` operation for `FirebaseServerApp`<!-- -->, so the name is not relevant for applications. However, it may be used internally, and is declared here so that `FirebaseServerApp` conforms to the `FirebaseApp` interface.
 
 <b>Signature:</b>
 
@@ -59,7 +59,7 @@ name?: undefined;
 
 An optional object. If provided, the Firebase SDK uses a `FinalizationRegistry` object to monitor the garbage collection status of the provided object. The Firebase SDK releases its refrence on the `FirebaseServerApp` instance when the provided `releaseOnDeref` object is garbage collected.
 
-The intent of this field is to help reduce memory overhead for cloud functions. If provided, the customer's app running in a SSR pass need not worry about `FirebaseServerApp` cleanup, so long as the reference object is deleted (by falling out of SSR scope, for instance.)
+You can use this field to reduce memory management overhead for your application. If provided, an app running in a SSR pass does not need to perform `FirebaseServerApp` cleanup, so long as the reference object is deleted (by falling out of SSR scope, for instance.)
 
 If an object is not provided then the application must clean up the `FirebaseServerApp` instance by invoking `deleteApp`<!-- -->.
 

docs-devsite/app.md

@@ -43,7 +43,7 @@ This package coordinates the communication between the different Firebase compon
 |  [FirebaseApp](./app.firebaseapp.md#firebaseapp_interface) | A [FirebaseApp](./app.firebaseapp.md#firebaseapp_interface) holds the initialization information for a collection of services.<!-- -->Do not call this constructor directly. Instead, use [initializeApp()](./app.md#initializeapp_cb2f5e1) to create an app. |
 |  [FirebaseAppSettings](./app.firebaseappsettings.md#firebaseappsettings_interface) | Configuration options given to [initializeApp()](./app.md#initializeapp_cb2f5e1) |
 |  [FirebaseOptions](./app.firebaseoptions.md#firebaseoptions_interface) | Firebase configuration object. Contains a set of parameters required by services in order to successfully communicate with Firebase server APIs and to associate client data with your Firebase project and Firebase application. Typically this object is populated by the Firebase console at project setup. See also: [Learn about the Firebase config object](https://firebase.google.com/docs/web/setup#config-object)<!-- -->. |
-|  [FirebaseServerApp](./app.firebaseserverapp.md#firebaseserverapp_interface) | A [FirebaseServerApp](./app.firebaseserverapp.md#firebaseserverapp_interface) holds the initialization information for a collection of services running in server enviornments.<!-- -->Do not call this constructor directly. Instead, use [initializeServerApp()](./app.md#initializeserverapp_30ab697) to create an app. |
+|  [FirebaseServerApp](./app.firebaseserverapp.md#firebaseserverapp_interface) | A [FirebaseServerApp](./app.firebaseserverapp.md#firebaseserverapp_interface) holds the initialization information for a collection of services running in server environments.<!-- -->Do not call this constructor directly. Instead, use [initializeServerApp()](./app.md#initializeserverapp_30ab697) to create an app. |
 |  [FirebaseServerAppSettings](./app.firebaseserverappsettings.md#firebaseserverappsettings_interface) | Configuration options given to [initializeServerApp()](./app.md#initializeserverapp_30ab697) |
 
 ## Variables

packages/app/src/api.test.ts

@@ -199,7 +199,7 @@ describe('API tests', () => {
 
     it('creates FirebaseServerApp with options', async () => {
       if (isBrowser()) {
-        // FirebaseServerApp isn't supported for execution in browser enviornments.
+        // FirebaseServerApp isn't supported for execution in browser environments.
         return;
       }
 
@@ -218,7 +218,7 @@ describe('API tests', () => {
 
     it('creates FirebaseServerApp with automaticDataCollectionEnabled', async () => {
       if (isBrowser()) {
-        // FirebaseServerApp isn't supported for execution in browser enviornments.
+        // FirebaseServerApp isn't supported for execution in browser environments.
         return;
       }
 
@@ -239,7 +239,7 @@ describe('API tests', () => {
 
     it('creates FirebaseServerApp with releaseOnDeref', async () => {
       if (isBrowser()) {
-        // FirebaseServerApp isn't supported for execution in browser enviornments.
+        // FirebaseServerApp isn't supported for execution in browser environments.
         return;
       }
 
@@ -258,7 +258,7 @@ describe('API tests', () => {
 
     it('creates FirebaseServerApp with FirebaseApp', async () => {
       if (isBrowser()) {
-        // FirebaseServerApp isn't supported for execution in browser enviornments.
+        // FirebaseServerApp isn't supported for execution in browser environments.
         return;
       }
 
@@ -283,7 +283,7 @@ describe('API tests', () => {
 
   it('create similar FirebaseServerApps does not return the same object', async () => {
     if (isBrowser()) {
-      // FirebaseServerApp isn't supported for execution in browser enviornments.
+      // FirebaseServerApp isn't supported for execution in browser environments.
       return;
     }
 
@@ -311,7 +311,7 @@ describe('API tests', () => {
 
   it('create FirebaseServerApps with varying deleteOnDeref, and they still return same object ', async () => {
     if (isBrowser()) {
-      // FirebaseServerApp isn't supported for execution in browser enviornments.
+      // FirebaseServerApp isn't supported for execution in browser environments.
       return;
     }
 
@@ -338,7 +338,7 @@ describe('API tests', () => {
 
   it('create duplicate FirebaseServerApps returns the same object', async () => {
     if (isBrowser()) {
-      // FirebaseServerApp isn't supported for execution in browser enviornments.
+      // FirebaseServerApp isn't supported for execution in browser environments.
       return;
     }
 
@@ -360,7 +360,7 @@ describe('API tests', () => {
 
   it('deleting FirebaseServerApps is ref counted', async () => {
     if (isBrowser()) {
-      // FirebaseServerApp isn't supported for execution in browser enviornments.
+      // FirebaseServerApp isn't supported for execution in browser environments.
       return;
     }
 

packages/app/src/public-types.ts

@@ -73,7 +73,7 @@ export interface FirebaseApp {
 
 /**
  * A {@link @firebase/app#FirebaseServerApp} holds the initialization information
- * for a collection of services running in server enviornments.
+ * for a collection of services running in server environments.
  *
  * Do not call this constructor directly. Instead, use
  * {@link (initializeServerApp:1) | initializeServerApp()} to create
@@ -89,7 +89,7 @@ export interface FirebaseServerApp extends FirebaseApp {
    * It is recommend that your application awaits this `Promise` before invoking `getAuth` if an
    * `authIdToken` was provided in the `FirebaseServerAppSettings`.
    *
-   * The returned `Promise` is completed immediately if the optional authIdToken parameter
+   * The returned `Promise` is completed immediately if the optional `authIdToken` parameter
    * was omitted from `FirebaseServerApp` initialization.
    */
   authIdTokenVerified: () => Promise<void>;
@@ -219,8 +219,8 @@ export interface FirebaseServerAppSettings extends FirebaseAppSettings {
    * Firebase SDK releases its refrence on the `FirebaseServerApp` instance when the
    * provided `releaseOnDeref` object is garbage collected.
    *
-   * The intent of this field is to help reduce memory overhead for cloud functions.
-   * If provided, the customer's app running in a SSR pass need not worry about
+   * You can use this field to reduce memory management overhead for your application.
+   * If provided, an app running in a SSR pass does not need to perform
    * `FirebaseServerApp` cleanup, so long as the reference object is deleted (by falling out of
    * SSR scope, for instance.)
    *
@@ -235,8 +235,9 @@ export interface FirebaseServerAppSettings extends FirebaseAppSettings {
   releaseOnDeref?: object;
 
   /**
-   * There is no get for `FirebaseServerApp`, so the name is not relevant. However it's always
-   * a blank string so that `FirebaseServerAp`p` conforms to the `FirebaseApp` interface declaration.
+   * There is no `getApp()` operation for `FirebaseServerApp`, so the name is not relevant for
+   * applications. However, it may be used internally, and is declared here so that
+   * `FirebaseServerApp` conforms to the `FirebaseApp` interface.
    */
   name?: undefined;
 }