Remove the new FirebaseServerApp from the app-types.

DellaBitta · web-flow · commit 04af9312b446 · 2024-01-03T10:13:01.000-05:00
Remove the new FirebaseServerApp from the app-types. App-types are meant only for compat, and FirebaseServerApp will not be part of compat.
diff --git a/docs-devsite/app.firebaseserverappsettings.md b/docs-devsite/app.firebaseserverappsettings.md
@@ -10,7 +10,7 @@ https://github.com/firebase/firebase-js-sdk
 {% endcomment %}
 
 # FirebaseServerAppSettings interface
-Configuration options given to [initializeServerApp()](./app.md#initializeserverapp)
+Configuration options given to [initializeServerApp()](./app.md#initializeserverapp_30ab697)
 
 <b>Signature:</b>
 
@@ -26,7 +26,7 @@ export interface FirebaseServerAppSettings extends FirebaseAppSettings
 |  [appCheckToken](./app.firebaseserverappsettings.md#firebaseserverappsettingsappchecktoken) | string | An optional AppCheck token.<!-- -->If provided, the FirebaseServerApp instance will work to validate the token. The result of the validation can be monitored by invoking the FirebaseServerApp.appCheckTokenVerified(). Awaiting the Promise returned by appCheckTokenVerified is highly recommended if an AppCheck token is provided.<!-- -->If the token has been properly verified then the AppCheck token will be automatically used by Firebase SDKs that support App Check.<!-- -->If the token fails verification then a warning is logged and the token will not be used. |
 |  [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 FirebaseServerApp instance will work to validate the token. The result of the validation can be queried via by the application by invoking the FirebaseServerApp.authIdTokenVerified(). Awaiting the Promise returned by authIdTokenVerified is highly recommended if an Auth ID token is provided.<!-- -->Once the token has been properly verified then invoking getAuth() will attempt to automatically sign in a user with the provided Auth ID Token.<!-- -->If the token fails verification then a warning is logged and Auth SDK will not attempt to sign in a user upon its initalization. |
 |  [installationsAuthToken](./app.firebaseserverappsettings.md#firebaseserverappsettingsinstallationsauthtoken) | string | An optional Installation Auth token.<!-- -->If provided, the FirebaseServerApp instance will work to validate the token. The result of the validation can be monitored by invoking the FirebaseServerApp.installationTokenVerified(). Awaiting the Promise returned by appCheckTokenVerified is highly recommended before initalization any other Firebase SDKs.<!-- -->If the token has been properly verified then the Installation Auth token will be automatically used by Firebase SDKs that support Firebase Installations.<!-- -->If the token fails verification then a warning is logged and the token will not be used. |
-|  [name](./app.firebaseserverappsettings.md#firebaseserverappsettingsname) | "" | There is no get for FirebaseServerApps, so the name is not relevant. however it's always a blank string so that FirebaseServerApp conforms to the FirebaseApp interface declaration. |
+|  [name](./app.firebaseserverappsettings.md#firebaseserverappsettingsname) | undefined | There is no get for FirebaseServerApps, so the name is not relevant. however it's always a blank string so that FirebaseServerApp conforms to the FirebaseApp interface declaration. |
 |  [releaseOnDeref](./app.firebaseserverappsettings.md#firebaseserverappsettingsreleaseonderef) | object | An optional object. If provided, the Firebase SDK will use a FinalizationRegistry object to monitor the Garbage Collection status of the provided object, and the Firebase SDK will release its refrence on the FirebaseServerApp instance when the provided object is collected. or.<!-- -->The intent of this field is to help reduce memory overhead for long-running cloud functions executing SSR fulfillment without the customer's app needing to orchestrate FirebaseServerApp cleanup. Additionally, prexisting FirebaseServerApp instances may reused if they're identical to a previously generated one that has yet to be deleted.<!-- -->If the object is not provided then the application must clean up the FirebaseServerApp instance through the applicationss own standard mechanisms by invoking deleteApp.<!-- -->If the app provides an object in this parameter, but the application is executed in a JavaScript engine that predates the support of FinalizationRegistry (introduced in node v14.6.0, for instance), then the Firebase SDK will not be able to automatically clean up the FirebaseServerApp instance and an error will be thrown. |
 
 ## FirebaseServerAppSettings.appCheckToken
@@ -84,7 +84,7 @@ There is no get for FirebaseServerApps, so the name is not relevant. however it'
 <b>Signature:</b>
 
 ```typescript
-name?: "";
+name?: undefined;
 ```
 
 ## FirebaseServerAppSettings.releaseOnDeref
diff --git a/docs-devsite/app.md b/docs-devsite/app.md
@@ -34,6 +34,7 @@ This package coordinates the communication between the different Firebase compon
 |  <b>function(options, ...)</b> |
 |  [initializeApp(options, name)](./app.md#initializeapp_cb2f5e1) | Creates and initializes a [FirebaseApp](./app.firebaseapp.md#firebaseapp_interface) instance.<!-- -->See [Add Firebase to your app](https://firebase.google.com/docs/web/setup#add_firebase_to_your_app) and [Initialize multiple projects](https://firebase.google.com/docs/web/setup#multiple-projects) for detailed documentation. |
 |  [initializeApp(options, config)](./app.md#initializeapp_079e917) | Creates and initializes a FirebaseApp instance. |
+|  [initializeServerApp(options, config)](./app.md#initializeserverapp_30ab697) | Creates and initializes a [FirebaseServerApp](./app.firebaseserverapp.md#firebaseserverapp_interface) instance.<!-- -->The FirebaseServerApp is similar to FirebaseApp, but is intended for execution in server side rendering environments only.<!-- -->See [Add Firebase to your app](https://firebase.google.com/docs/web/setup#add_firebase_to_your_app) and [Initialize multiple projects](https://firebase.google.com/docs/web/setup#multiple-projects) for detailed documentation. |
 
 ## Interfaces
 
@@ -43,7 +44,7 @@ This package coordinates the communication between the different Firebase compon
 |  [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  to create an app. |
-|  [FirebaseServerAppSettings](./app.firebaseserverappsettings.md#firebaseserverappsettings_interface) | Configuration options given to [initializeServerApp()](./app.md#initializeserverapp) |
+|  [FirebaseServerAppSettings](./app.firebaseserverappsettings.md#firebaseserverappsettings_interface) | Configuration options given to [initializeServerApp()](./app.md#initializeserverapp_30ab697) |
 
 ## Variables
 
@@ -312,7 +313,7 @@ export declare function initializeApp(options: FirebaseOptions, config?: Firebas
 
 [FirebaseApp](./app.firebaseapp.md#firebaseapp_interface)
 
-## initializeServerApp()
+### initializeServerApp(options, config) {:#initializeserverapp_30ab697}
 
 Creates and initializes a [FirebaseServerApp](./app.firebaseserverapp.md#firebaseserverapp_interface) instance.
 
@@ -326,7 +327,7 @@ See [Add Firebase to your app](https://firebase.google.com/docs/web/setup#add_fi
 export declare function initializeServerApp(options: FirebaseOptions | FirebaseApp, config: FirebaseServerAppSettings): FirebaseServerApp;
 ```
 
-### Parameters
+#### Parameters
 
 |  Parameter | Type | Description |
 |  --- | --- | --- |
diff --git a/packages/app-types/index.d.ts b/packages/app-types/index.d.ts
@@ -32,84 +32,6 @@ export interface FirebaseAppConfig {
   automaticDataCollectionEnabled?: boolean;
 }
 
-export interface FirebaseServerAppConfig extends FirebaseAppConfig {
-  /**
-   * An optional Auth ID token used to resume a signed in user session from a client
-   * runtime environment.
-   *
-   * If provided, the FirebaseServerApp instance will work to validate the token. The
-   * result of the validation can be queried via by the application by invoking the
-   * FirebaseServerApp.authIdTokenVerified(). Awaiting the Promise returned by
-   * authIdTokenVerified is highly recommended if an Auth ID token is provided.
-   *
-   * Once the token has been properly verified then invoking getAuth() will attempt to
-   * automatically sign in a user with the provided Auth ID Token.
-   *
-   * If the token fails verification then a warning is logged and Auth SDK will not
-   * attempt to sign in a user upon its initalization.
-   */
-  authIdToken?: string;
-
-  /**
-   * An optional AppCheck token.
-   *
-   * If provided, the FirebaseServerApp instance will work to validate the token. The
-   * result of the validation can be monitored by invoking the
-   * FirebaseServerApp.appCheckTokenVerified(). Awaiting the Promise returned by
-   * appCheckTokenVerified is highly recommended if an AppCheck token is provided.
-   *
-   * If the token has been properly verified then the AppCheck token will be
-   * automatically used by Firebase SDKs that support App Check.
-   *
-   * If the token fails verification then a warning is logged and the token will not
-   * be used.
-   */
-  appCheckToken?: string;
-
-  /**
-   * An optional Installation Auth token.
-   *
-   * If provided, the FirebaseServerApp instance will work to validate the token. The
-   * result of the validation can be monitored by invoking the
-   * FirebaseServerApp.installationAuthTokenVerified(). Awaiting the Promise returned by
-   * appCheckTokenVerified is highly recommended before initalization any other Firebase
-   * SDKs.
-   *
-   * If the token has been properly verified then the Installation Auth token will be
-   * automatically used by Firebase SDKs that support Firebase Installations.
-   *
-   * If the token fails verification then a warning is logged and the token will not
-   * be used.
-   */
-  installationAuthToken?: string;
-
-  /**
-   * An optional object. If provided, the Firebase SDK will use a FinalizationRegistry
-   * object to monitor its GC status. The Firebase SDK will cleanup and
-   * delete the corresponding FirebaseServerApp instance when the provided object is
-   * deleted by the garbage collector.
-   *
-   * The intent of this field is to help reduce memory overhead for long-running cloud
-   * functions executing SSR fulfillment without the customer's app needing to
-   * orchestrate FirebaseServerApp cleanup.
-   *
-   * For instance, in the case that asynchronous operations makes it difficult to
-   * determine the finality of the server side rendering pass.
-   *
-   * If the object is not provided then the application must clean up the
-   * FirebaseServerApp instance through it's own standard mechanisms by invoking
-   * deleteApp.
-   *
-   * If the app uses provides an object but uses a JavaScript engine that predates the
-   * support of FinalizationRegistry (introduced in node v14.6.0, for instance), then the
-   * Firebase SDK will not be able to automatically clean up the FirebaseServerApp
-   * instance and an error will be thrown.
-   */
-  deleteOnDeref?: object;
-
-  name: undefined;
-}
-
 export class FirebaseApp {
   /**
    * The (read-only) name (identifier) for this App. '[DEFAULT]' is the default
@@ -133,67 +55,6 @@ export class FirebaseApp {
   delete(): Promise<void>;
 }
 
-/**
- * A {@link @firebase/app#FirebaseServerApp} holds the initialization information
- * for a collection of services running in server enviornments.
- *
- * Do not call this constructor directly. Instead, use
- * {@link (initializeServerAppInstance:1) | initializeServerAppInstance()} to create
- * an app.
- *
- * @public
- */
-export class FirebaseServerApp extends FirebaseApp {
-  /**
-   * Checks to see if the verification of the authIdToken provided to
-   * @initializeServerApp has completed.
-   *
-   * It is recommend that your application awaits this promise if an authIdToken was
-   * provided during FirebaseServerApp initialization before invoking getAuth(). If an
-   * instance of Auth is created before the Auth ID Token is validated, then the token
-   * will not be used by that instance of the Auth SDK.
-   *
-   * The returned Promise is completed immediately if the optional authIdToken parameter
-   * was omitted from FirebaseServerApp initialization.
-   */
-  authIdTokenVerified: () => Promise<void>;
-
-  /**
-   * Checks to see if the verification of the appCheckToken provided to
-   * @initializeServerApp has completed. If the optional appCheckToken parameter was
-   * omitted then the returned Promise is completed immediately.
-   *
-   * It is recommend that your application awaits this promise before initializing
-   * any Firebase products that use AppCheck. The Firebase SDKs will not
-   * use App Check tokens that are determined to be invalid or those that have not yet
-   * completed validation.
-   *
-   * The returned Promise is completed immediately if the optional appCheckToken
-   * parameter was omitted from FirebaseServerApp initialization.
-   */
-  appCheckTokenVerified: () => Promise<void>;
-
-  /**
-   * Checks to see if the verification of the installationAuthToken provided to
-   * @initializeServerApp has completed.
-   *
-   * It is recommend that your application awaits this promise before initializing
-   * any Firebase products that use Firebase Installations. The Firebase SDKs will not
-   * use Installation Auth tokens that are determined to be invalid or those that have
-   * not yet completed validation.
-   *
-   * The returned Promise is completed immediately if the optional appCheckToken
-   * parameter was omitted from FirebaseServerApp initialization.
-   */
-  installationAuthTokenVerified: () => Promise<void>;
-
-  /**
-   * There is no get for FirebaseServerApp, name is not relevant—however it's always
-   * a blank string to conform to the FirebaseApp interface
-   */
-  name: '';
-}
-
 export interface FirebaseNamespace {
   /**
    * Create (and initialize) a FirebaseApp.
@@ -205,7 +66,6 @@ export interface FirebaseNamespace {
     options: FirebaseOptions,
     config?: FirebaseAppConfig
   ): FirebaseApp;
-
   /**
    * Create (and initialize) a FirebaseApp.
    *
@@ -215,18 +75,6 @@ export interface FirebaseNamespace {
    */
   initializeApp(options: FirebaseOptions, name?: string): FirebaseApp;
 
-  /**
-   * Create (and initialize) a FirebaseServerApp.
-   *
-   * @param options - Firebase.AppOptions to configure the app's services, or a
-   *   a FirebaseApp instance which contains the AppOptions within.
-   * @param config The config for your firebase server app.
-   */
-  initializeServerApp(
-    options: FirebaseOptions | FirebaseApp,
-    config: FirebaseServerAppConfig
-  ): FirebaseServerApp;
-
   app: {
     /**
      * Retrieve an instance of a FirebaseApp.
@@ -246,35 +94,11 @@ export interface FirebaseNamespace {
     App: typeof FirebaseApp;
   };
 
-  serverApp: {
-    /**
-     * Retrieve an instance of a FirebaseServerApp.
-     *
-     * Usage: firebase.serverApp(name)
-     *
-     * @param name The optional name of the server app to return ('[DEFAULT]' if omitted)
-     */
-    (name?: string): FirebaseServerApp;
-
-    /**
-     * For testing FirebaseServerApp instances:
-     *  serverApp() instanceof firebase.app.FirebaseServerApp
-     *
-     * DO NOT call this constuctor directly (use firebase.initializeServerApp() instead).
-     */
-    serverApp: typeof FirebaseServerApp;
-  };
-
   /**
    * A (read-only) array of all the initialized Apps.
    */
   apps: FirebaseApp[];
 
-  /**
-   * A (read-only) array of all the initialized Server Apps.
-   */
-  serverApps: FirebaseServerApp[];
-
   /**
    * Registers a library's name and version for platform logging purposes.
    * @param library Name of 1p or 3p library (e.g. firestore, angularfire)
