@firebase/app 0.13.1 → 0.13.2-canary.25b60fdaa

package/dist/app/src/api.d.ts

@@ -65,6 +65,10 @@ export declare const SDK_VERSION: string;
  *
  * @returns The initialized app.
  *
+ * @throws If the optional `name` parameter is malformed or empty.
+ *
+ * @throws If a `FirebaseApp` already exists with the same name but with a different configuration.
+ *
  * @public
  */
 export declare function initializeApp(options: FirebaseOptions, name?: string): FirebaseApp;
@@ -74,6 +78,9 @@ export declare function initializeApp(options: FirebaseOptions, name?: string):
  * @param options - Options to configure the app's services.
  * @param config - FirebaseApp Configuration
  *
+ * @throws If {@link FirebaseAppSettings.name} is defined but the value is malformed or empty.
+ *
+ * @throws If a `FirebaseApp` already exists with the same name but with a different configuration.
  * @public
  */
 export declare function initializeApp(options: FirebaseOptions, config?: FirebaseAppSettings): FirebaseApp;
@@ -118,13 +125,34 @@ export declare function initializeApp(): FirebaseApp;
  *
  * @param options - `Firebase.AppOptions` to configure the app's services, or a
  *   a `FirebaseApp` instance which contains the `AppOptions` within.
- * @param config - `FirebaseServerApp` configuration.
+ * @param config - Optional `FirebaseServerApp` settings.
+ *
+ * @returns The initialized `FirebaseServerApp`.
+ *
+ * @throws If invoked in an unsupported non-server environment such as a browser.
+ *
+ * @throws If {@link FirebaseServerAppSettings.releaseOnDeref} is defined but the runtime doesn't
+ *   provide Finalization Registry support.
+ *
+ * @public
+ */
+export declare function initializeServerApp(options: FirebaseOptions | FirebaseApp, config?: FirebaseServerAppSettings): FirebaseServerApp;
+/**
+ * Creates and initializes a {@link @firebase/app#FirebaseServerApp} instance.
+ *
+ * @param config - Optional `FirebaseServerApp` settings.
  *
  * @returns The initialized `FirebaseServerApp`.
  *
+ * @throws If invoked in an unsupported non-server environment such as a browser.
+ * @throws If {@link FirebaseServerAppSettings.releaseOnDeref} is defined but the runtime doesn't
+ *   provide Finalization Registry support.
+ * @throws If the `FIREBASE_OPTIONS` enviornment variable does not contain a valid project
+ *   configuration required for auto-initialization.
+ *
  * @public
  */
-export declare function initializeServerApp(options: FirebaseOptions | FirebaseApp, config: FirebaseServerAppSettings): FirebaseServerApp;
+export declare function initializeServerApp(config?: FirebaseServerAppSettings): FirebaseServerApp;
 /**
  * Retrieves a {@link @firebase/app#FirebaseApp} instance.
  *

package/dist/app/src/global_index.d.ts

@@ -641,6 +641,10 @@ declare const SDK_VERSION: string;
  *
  * @returns The initialized app.
  *
+ * @throws If the optional `name` parameter is malformed or empty.
+ *
+ * @throws If a `FirebaseApp` already exists with the same name but with a different configuration.
+ *
  * @public
  */
 declare function initializeApp(options: FirebaseOptions, name?: string): FirebaseApp;
@@ -650,6 +654,9 @@ declare function initializeApp(options: FirebaseOptions, name?: string): Firebas
  * @param options - Options to configure the app's services.
  * @param config - FirebaseApp Configuration
  *
+ * @throws If {@link FirebaseAppSettings.name} is defined but the value is malformed or empty.
+ *
+ * @throws If a `FirebaseApp` already exists with the same name but with a different configuration.
  * @public
  */
 declare function initializeApp(options: FirebaseOptions, config?: FirebaseAppSettings): FirebaseApp;
@@ -694,13 +701,34 @@ declare function initializeApp(): FirebaseApp;
  *
  * @param options - `Firebase.AppOptions` to configure the app's services, or a
  *   a `FirebaseApp` instance which contains the `AppOptions` within.
- * @param config - `FirebaseServerApp` configuration.
+ * @param config - Optional `FirebaseServerApp` settings.
  *
  * @returns The initialized `FirebaseServerApp`.
  *
+ * @throws If invoked in an unsupported non-server environment such as a browser.
+ *
+ * @throws If {@link FirebaseServerAppSettings.releaseOnDeref} is defined but the runtime doesn't
+ *   provide Finalization Registry support.
+ *
  * @public
  */
-declare function initializeServerApp(options: FirebaseOptions | FirebaseApp, config: FirebaseServerAppSettings): FirebaseServerApp;
+declare function initializeServerApp(options: FirebaseOptions | FirebaseApp, config?: FirebaseServerAppSettings): FirebaseServerApp;
+/**
+ * Creates and initializes a {@link @firebase/app#FirebaseServerApp} instance.
+ *
+ * @param config - Optional `FirebaseServerApp` settings.
+ *
+ * @returns The initialized `FirebaseServerApp`.
+ *
+ * @throws If invoked in an unsupported non-server environment such as a browser.
+ * @throws If {@link FirebaseServerAppSettings.releaseOnDeref} is defined but the runtime doesn't
+ *   provide Finalization Registry support.
+ * @throws If the `FIREBASE_OPTIONS` enviornment variable does not contain a valid project
+ *   configuration required for auto-initialization.
+ *
+ * @public
+ */
+declare function initializeServerApp(config?: FirebaseServerAppSettings): FirebaseServerApp;
 /**
  * Retrieves a {@link @firebase/app#FirebaseApp} instance.
  *
@@ -876,13 +904,22 @@ declare function _getProvider<T extends Name>(app: FirebaseApp, name: T): Provid
 declare function _removeServiceInstance<T extends Name>(app: FirebaseApp, name: T, instanceIdentifier?: string): void;
 /**
  *
- * @param obj - an object of type FirebaseApp or FirebaseOptions.
+ * @param obj - an object of type FirebaseApp, FirebaseOptions or FirebaseAppSettings.
  *
  * @returns true if the provide object is of type FirebaseApp.
  *
  * @internal
  */
-declare function _isFirebaseApp(obj: FirebaseApp | FirebaseOptions): obj is FirebaseApp;
+declare function _isFirebaseApp(obj: FirebaseApp | FirebaseOptions | FirebaseAppSettings): obj is FirebaseApp;
+/**
+ *
+ * @param obj - an object of type FirebaseApp, FirebaseOptions or FirebaseAppSettings.
+ *
+ * @returns true if the provided object is of type FirebaseServerAppImpl.
+ *
+ * @internal
+ */
+declare function _isFirebaseServerAppSettings(obj: FirebaseApp | FirebaseOptions | FirebaseAppSettings): obj is FirebaseServerAppSettings;
 /**
  *
  * @param obj - an object of type FirebaseApp.
@@ -899,4 +936,4 @@ declare function _isFirebaseServerApp(obj: FirebaseApp | FirebaseServerApp | nul
  */
 declare function _clearComponents(): void;
 
-export { FirebaseApp, FirebaseAppSettings, FirebaseError, FirebaseOptions, FirebaseServerApp, FirebaseServerAppSettings, SDK_VERSION, DEFAULT_ENTRY_NAME as _DEFAULT_ENTRY_NAME, _FirebaseAppInternal, _FirebaseService, _addComponent, _addOrOverwriteComponent, _apps, _clearComponents, _components, _getProvider, _isFirebaseApp, _isFirebaseServerApp, _registerComponent, _removeServiceInstance, _serverApps, deleteApp, getApp, getApps, initializeApp, initializeServerApp, onLog, registerVersion, setLogLevel };
+export { FirebaseApp, FirebaseAppSettings, FirebaseError, FirebaseOptions, FirebaseServerApp, FirebaseServerAppSettings, SDK_VERSION, DEFAULT_ENTRY_NAME as _DEFAULT_ENTRY_NAME, _FirebaseAppInternal, _FirebaseService, _addComponent, _addOrOverwriteComponent, _apps, _clearComponents, _components, _getProvider, _isFirebaseApp, _isFirebaseServerApp, _isFirebaseServerAppSettings, _registerComponent, _removeServiceInstance, _serverApps, deleteApp, getApp, getApps, initializeApp, initializeServerApp, onLog, registerVersion, setLogLevel };

package/dist/app/src/internal.d.ts

@@ -14,7 +14,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-import { FirebaseApp, FirebaseOptions, FirebaseServerApp } from './public-types';
+import { FirebaseApp, FirebaseAppSettings, FirebaseServerAppSettings, FirebaseOptions, FirebaseServerApp } from './public-types';
 import { Component, Provider, Name } from '@firebase/component';
 import { DEFAULT_ENTRY_NAME } from './constants';
 /**
@@ -71,13 +71,22 @@ export declare function _getProvider<T extends Name>(app: FirebaseApp, name: T):
 export declare function _removeServiceInstance<T extends Name>(app: FirebaseApp, name: T, instanceIdentifier?: string): void;
 /**
  *
- * @param obj - an object of type FirebaseApp or FirebaseOptions.
+ * @param obj - an object of type FirebaseApp, FirebaseOptions or FirebaseAppSettings.
  *
  * @returns true if the provide object is of type FirebaseApp.
  *
  * @internal
  */
-export declare function _isFirebaseApp(obj: FirebaseApp | FirebaseOptions): obj is FirebaseApp;
+export declare function _isFirebaseApp(obj: FirebaseApp | FirebaseOptions | FirebaseAppSettings): obj is FirebaseApp;
+/**
+ *
+ * @param obj - an object of type FirebaseApp, FirebaseOptions or FirebaseAppSettings.
+ *
+ * @returns true if the provided object is of type FirebaseServerAppImpl.
+ *
+ * @internal
+ */
+export declare function _isFirebaseServerAppSettings(obj: FirebaseApp | FirebaseOptions | FirebaseAppSettings): obj is FirebaseServerAppSettings;
 /**
  *
  * @param obj - an object of type FirebaseApp.

package/dist/app-public.d.ts

@@ -332,6 +332,10 @@ export declare function getApps(): FirebaseApp[];
  *
  * @returns The initialized app.
  *
+ * @throws If the optional `name` parameter is malformed or empty.
+ *
+ * @throws If a `FirebaseApp` already exists with the same name but with a different configuration.
+ *
  * @public
  */
 export declare function initializeApp(options: FirebaseOptions, name?: string): FirebaseApp;
@@ -342,6 +346,9 @@ export declare function initializeApp(options: FirebaseOptions, name?: string):
  * @param options - Options to configure the app's services.
  * @param config - FirebaseApp Configuration
  *
+ * @throws If {@link FirebaseAppSettings.name} is defined but the value is malformed or empty.
+ *
+ * @throws If a `FirebaseApp` already exists with the same name but with a different configuration.
  * @public
  */
 export declare function initializeApp(options: FirebaseOptions, config?: FirebaseAppSettings): FirebaseApp;
@@ -388,18 +395,42 @@ export declare function initializeApp(): FirebaseApp;
  *
  * @param options - `Firebase.AppOptions` to configure the app's services, or a
  *   a `FirebaseApp` instance which contains the `AppOptions` within.
- * @param config - `FirebaseServerApp` configuration.
+ * @param config - Optional `FirebaseServerApp` settings.
+ *
+ * @returns The initialized `FirebaseServerApp`.
+ *
+ * @throws If invoked in an unsupported non-server environment such as a browser.
+ *
+ * @throws If {@link FirebaseServerAppSettings.releaseOnDeref} is defined but the runtime doesn't
+ *   provide Finalization Registry support.
+ *
+ * @public
+ */
+export declare function initializeServerApp(options: FirebaseOptions | FirebaseApp, config?: FirebaseServerAppSettings): FirebaseServerApp;
+
+/**
+ * Creates and initializes a {@link @firebase/app#FirebaseServerApp} instance.
+ *
+ * @param config - Optional `FirebaseServerApp` settings.
  *
  * @returns The initialized `FirebaseServerApp`.
  *
+ * @throws If invoked in an unsupported non-server environment such as a browser.
+ * @throws If {@link FirebaseServerAppSettings.releaseOnDeref} is defined but the runtime doesn't
+ *   provide Finalization Registry support.
+ * @throws If the `FIREBASE_OPTIONS` enviornment variable does not contain a valid project
+ *   configuration required for auto-initialization.
+ *
  * @public
  */
-export declare function initializeServerApp(options: FirebaseOptions | FirebaseApp, config: FirebaseServerAppSettings): FirebaseServerApp;
+export declare function initializeServerApp(config?: FirebaseServerAppSettings): FirebaseServerApp;
 
 /* Excluded from this release type: _isFirebaseApp */
 
 /* Excluded from this release type: _isFirebaseServerApp */
 
+/* Excluded from this release type: _isFirebaseServerAppSettings */
+
 /**
  * Sets log handler for all Firebase SDKs.
  * @param logCallback - An optional custom log handler that executes user code whenever

package/dist/app.d.ts

@@ -385,6 +385,10 @@ export declare function _getProvider<T extends Name>(app: FirebaseApp, name: T):
  *
  * @returns The initialized app.
  *
+ * @throws If the optional `name` parameter is malformed or empty.
+ *
+ * @throws If a `FirebaseApp` already exists with the same name but with a different configuration.
+ *
  * @public
  */
 export declare function initializeApp(options: FirebaseOptions, name?: string): FirebaseApp;
@@ -395,6 +399,9 @@ export declare function initializeApp(options: FirebaseOptions, name?: string):
  * @param options - Options to configure the app's services.
  * @param config - FirebaseApp Configuration
  *
+ * @throws If {@link FirebaseAppSettings.name} is defined but the value is malformed or empty.
+ *
+ * @throws If a `FirebaseApp` already exists with the same name but with a different configuration.
  * @public
  */
 export declare function initializeApp(options: FirebaseOptions, config?: FirebaseAppSettings): FirebaseApp;
@@ -441,23 +448,45 @@ export declare function initializeApp(): FirebaseApp;
  *
  * @param options - `Firebase.AppOptions` to configure the app's services, or a
  *   a `FirebaseApp` instance which contains the `AppOptions` within.
- * @param config - `FirebaseServerApp` configuration.
+ * @param config - Optional `FirebaseServerApp` settings.
  *
  * @returns The initialized `FirebaseServerApp`.
  *
+ * @throws If invoked in an unsupported non-server environment such as a browser.
+ *
+ * @throws If {@link FirebaseServerAppSettings.releaseOnDeref} is defined but the runtime doesn't
+ *   provide Finalization Registry support.
+ *
  * @public
  */
-export declare function initializeServerApp(options: FirebaseOptions | FirebaseApp, config: FirebaseServerAppSettings): FirebaseServerApp;
+export declare function initializeServerApp(options: FirebaseOptions | FirebaseApp, config?: FirebaseServerAppSettings): FirebaseServerApp;
 
 /**
+ * Creates and initializes a {@link @firebase/app#FirebaseServerApp} instance.
  *
- * @param obj - an object of type FirebaseApp or FirebaseOptions.
+ * @param config - Optional `FirebaseServerApp` settings.
+ *
+ * @returns The initialized `FirebaseServerApp`.
+ *
+ * @throws If invoked in an unsupported non-server environment such as a browser.
+ * @throws If {@link FirebaseServerAppSettings.releaseOnDeref} is defined but the runtime doesn't
+ *   provide Finalization Registry support.
+ * @throws If the `FIREBASE_OPTIONS` enviornment variable does not contain a valid project
+ *   configuration required for auto-initialization.
+ *
+ * @public
+ */
+export declare function initializeServerApp(config?: FirebaseServerAppSettings): FirebaseServerApp;
+
+/**
+ *
+ * @param obj - an object of type FirebaseApp, FirebaseOptions or FirebaseAppSettings.
  *
  * @returns true if the provide object is of type FirebaseApp.
  *
  * @internal
  */
-export declare function _isFirebaseApp(obj: FirebaseApp | FirebaseOptions): obj is FirebaseApp;
+export declare function _isFirebaseApp(obj: FirebaseApp | FirebaseOptions | FirebaseAppSettings): obj is FirebaseApp;
 
 /**
  *
@@ -469,6 +498,16 @@ export declare function _isFirebaseApp(obj: FirebaseApp | FirebaseOptions): obj
  */
 export declare function _isFirebaseServerApp(obj: FirebaseApp | FirebaseServerApp | null | undefined): obj is FirebaseServerApp;
 
+/**
+ *
+ * @param obj - an object of type FirebaseApp, FirebaseOptions or FirebaseAppSettings.
+ *
+ * @returns true if the provided object is of type FirebaseServerAppImpl.
+ *
+ * @internal
+ */
+export declare function _isFirebaseServerAppSettings(obj: FirebaseApp | FirebaseOptions | FirebaseAppSettings): obj is FirebaseServerAppSettings;
+
 /**
  * Sets log handler for all Firebase SDKs.
  * @param logCallback - An optional custom log handler that executes user code whenever

package/dist/esm/app/src/api.d.ts

@@ -65,6 +65,10 @@ export declare const SDK_VERSION: string;
  *
  * @returns The initialized app.
  *
+ * @throws If the optional `name` parameter is malformed or empty.
+ *
+ * @throws If a `FirebaseApp` already exists with the same name but with a different configuration.
+ *
  * @public
  */
 export declare function initializeApp(options: FirebaseOptions, name?: string): FirebaseApp;
@@ -74,6 +78,9 @@ export declare function initializeApp(options: FirebaseOptions, name?: string):
  * @param options - Options to configure the app's services.
  * @param config - FirebaseApp Configuration
  *
+ * @throws If {@link FirebaseAppSettings.name} is defined but the value is malformed or empty.
+ *
+ * @throws If a `FirebaseApp` already exists with the same name but with a different configuration.
  * @public
  */
 export declare function initializeApp(options: FirebaseOptions, config?: FirebaseAppSettings): FirebaseApp;
@@ -118,13 +125,34 @@ export declare function initializeApp(): FirebaseApp;
  *
  * @param options - `Firebase.AppOptions` to configure the app's services, or a
  *   a `FirebaseApp` instance which contains the `AppOptions` within.
- * @param config - `FirebaseServerApp` configuration.
+ * @param config - Optional `FirebaseServerApp` settings.
+ *
+ * @returns The initialized `FirebaseServerApp`.
+ *
+ * @throws If invoked in an unsupported non-server environment such as a browser.
+ *
+ * @throws If {@link FirebaseServerAppSettings.releaseOnDeref} is defined but the runtime doesn't
+ *   provide Finalization Registry support.
+ *
+ * @public
+ */
+export declare function initializeServerApp(options: FirebaseOptions | FirebaseApp, config?: FirebaseServerAppSettings): FirebaseServerApp;
+/**
+ * Creates and initializes a {@link @firebase/app#FirebaseServerApp} instance.
+ *
+ * @param config - Optional `FirebaseServerApp` settings.
  *
  * @returns The initialized `FirebaseServerApp`.
  *
+ * @throws If invoked in an unsupported non-server environment such as a browser.
+ * @throws If {@link FirebaseServerAppSettings.releaseOnDeref} is defined but the runtime doesn't
+ *   provide Finalization Registry support.
+ * @throws If the `FIREBASE_OPTIONS` enviornment variable does not contain a valid project
+ *   configuration required for auto-initialization.
+ *
  * @public
  */
-export declare function initializeServerApp(options: FirebaseOptions | FirebaseApp, config: FirebaseServerAppSettings): FirebaseServerApp;
+export declare function initializeServerApp(config?: FirebaseServerAppSettings): FirebaseServerApp;
 /**
  * Retrieves a {@link @firebase/app#FirebaseApp} instance.
  *

package/dist/esm/app/src/internal.d.ts

@@ -14,7 +14,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-import { FirebaseApp, FirebaseOptions, FirebaseServerApp } from './public-types';
+import { FirebaseApp, FirebaseAppSettings, FirebaseServerAppSettings, FirebaseOptions, FirebaseServerApp } from './public-types';
 import { Component, Provider, Name } from '@firebase/component';
 import { DEFAULT_ENTRY_NAME } from './constants';
 /**
@@ -71,13 +71,22 @@ export declare function _getProvider<T extends Name>(app: FirebaseApp, name: T):
 export declare function _removeServiceInstance<T extends Name>(app: FirebaseApp, name: T, instanceIdentifier?: string): void;
 /**
  *
- * @param obj - an object of type FirebaseApp or FirebaseOptions.
+ * @param obj - an object of type FirebaseApp, FirebaseOptions or FirebaseAppSettings.
  *
  * @returns true if the provide object is of type FirebaseApp.
  *
  * @internal
  */
-export declare function _isFirebaseApp(obj: FirebaseApp | FirebaseOptions): obj is FirebaseApp;
+export declare function _isFirebaseApp(obj: FirebaseApp | FirebaseOptions | FirebaseAppSettings): obj is FirebaseApp;
+/**
+ *
+ * @param obj - an object of type FirebaseApp, FirebaseOptions or FirebaseAppSettings.
+ *
+ * @returns true if the provided object is of type FirebaseServerAppImpl.
+ *
+ * @internal
+ */
+export declare function _isFirebaseServerAppSettings(obj: FirebaseApp | FirebaseOptions | FirebaseAppSettings): obj is FirebaseServerAppSettings;
 /**
  *
  * @param obj - an object of type FirebaseApp.