Fix FirebaseServerApp Typescript exactOptionalPropertyTypes error (#8341

)

This change fixes a TypeScript compilation error. 

The `FirebaseServerAppSettings.name` field inherited from `FirebaseAppSettings` but the type was redefined from `string` to `undefined`. This redefinition would cause a TypeScript compliation error if `exactOptionalPropertyTypes` was set `true` in `packages/app/tsconfig.json`.

This change now uses `omit< , >` to strip the `name` field from the `FirebaseServerAppSettings` declaration, where `FirebaseAppSettings` is extended.

Fixes #8336

.changeset/silver-crews-build.md

@@ -0,0 +1,8 @@
+---
+'firebase': patch
+'@firebase/app': patch
+---
+
+The `FirebaseServerAppSettings.name` field inherited from `FirebaseAppSettings` is now omitted
+instead of overloading the value as `undefined`. This fixes a TypeScript compilation error. For more
+information, see [GitHub Issue #8336](https://github.com/firebase/firebase-js-sdk/issues/8336).

common/api-review/app.api.md

@@ -78,9 +78,8 @@ export interface FirebaseServerApp extends FirebaseApp {
 }
 
 // @public
-export interface FirebaseServerAppSettings extends FirebaseAppSettings {
+export interface FirebaseServerAppSettings extends Omit<FirebaseAppSettings, 'name'> {
     authIdToken?: string;
-    name?: undefined;
     releaseOnDeref?: object;
 }
 

common/api-review/util.api.md

@@ -329,6 +329,11 @@ export const isValidFormat: (token: string) => boolean;
 // @public
 export const isValidTimestamp: (token: string) => boolean;
 
+// Warning: (ae-missing-release-tag) "isWebWorker" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public
+export function isWebWorker(): boolean;
+
 // Warning: (ae-missing-release-tag) "jsonEval" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
 //
 // @public

docs-devsite/app.firebaseserverappsettings.md

@@ -15,16 +15,15 @@ Configuration options given to [initializeServerApp()](./app.md#initializeserver
 <b>Signature:</b>
 
 ```typescript
-export interface FirebaseServerAppSettings extends FirebaseAppSettings 
+export interface FirebaseServerAppSettings extends Omit<FirebaseAppSettings, 'name'> 
 ```
-<b>Extends:</b> [FirebaseAppSettings](./app.firebaseappsettings.md#firebaseappsettings_interface)
+<b>Extends:</b> Omit&lt;[FirebaseAppSettings](./app.firebaseappsettings.md#firebaseappsettings_interface)<!-- -->, 'name'&gt;
 
 ## Properties
 
 |  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.<!-- -->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 initialization.<!-- -->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 <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 reference 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
@@ -43,16 +42,6 @@ If a user is successfully signed in, then the Auth instance's `onAuthStateChange
 authIdToken?: string;
 ```
 
-## FirebaseServerAppSettings.name
-
-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>
-
-```typescript
-name?: undefined;
-```
-
 ## FirebaseServerAppSettings.releaseOnDeref
 
 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 reference on the `FirebaseServerApp` instance when the provided `releaseOnDeref` object is garbage collected.

packages/app/src/public-types.ts

@@ -175,7 +175,8 @@ export interface FirebaseAppSettings {
  *
  * Configuration options given to {@link (initializeServerApp:1) | initializeServerApp()}
  */
-export interface FirebaseServerAppSettings extends FirebaseAppSettings {
+export interface FirebaseServerAppSettings
+  extends Omit<FirebaseAppSettings, 'name'> {
   /**
    * An optional Auth ID token used to resume a signed in user session from a client
    * runtime environment.
@@ -215,13 +216,6 @@ export interface FirebaseServerAppSettings extends FirebaseAppSettings {
    * initialization.
    */
   releaseOnDeref?: object;
-
-  /**
-   * 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;
 }
 
 /**