firebase-admin 11.2.0 → 11.3.0

package/lib/extensions/extensions-api-client-internal.js

@@ -0,0 +1,105 @@
+/*! firebase-admin v11.3.0 */
+"use strict";
+/*!
+ * @license
+ * Copyright 2022 Google Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FirebaseExtensionsError = exports.ExtensionsApiClient = void 0;
+const api_request_1 = require("../utils/api-request");
+const error_1 = require("../utils/error");
+const validator = require("../utils/validator");
+const utils = require("../utils");
+const FIREBASE_FUNCTIONS_CONFIG_HEADERS = {
+    'X-Firebase-Client': `fire-admin-node/${utils.getSdkVersion()}`
+};
+const EXTENSIONS_API_VERSION = 'v1beta';
+// Note - use getExtensionsApiUri() instead so that changing environments is consistent.
+const EXTENSIONS_URL = 'https://firebaseextensions.googleapis.com';
+/**
+ * Class that facilitates sending requests to the Firebase Extensions backend API.
+ *
+ * @internal
+ */
+class ExtensionsApiClient {
+    constructor(app) {
+        this.app = app;
+        if (!validator.isNonNullObject(app) || !('options' in app)) {
+            throw new error_1.FirebaseAppError('invalid-argument', 'First argument passed to getExtensions() must be a valid Firebase app instance.');
+        }
+        this.httpClient = new api_request_1.AuthorizedHttpClient(this.app);
+    }
+    async updateRuntimeData(projectId, instanceId, runtimeData) {
+        const url = this.getRuntimeDataUri(projectId, instanceId);
+        const request = {
+            method: 'PATCH',
+            url,
+            headers: FIREBASE_FUNCTIONS_CONFIG_HEADERS,
+            data: runtimeData,
+        };
+        try {
+            const res = await this.httpClient.send(request);
+            return res.data;
+        }
+        catch (err) {
+            throw this.toFirebaseError(err);
+        }
+    }
+    getExtensionsApiUri() {
+        return process.env['FIREBASE_EXT_URL'] ?? EXTENSIONS_URL;
+    }
+    getRuntimeDataUri(projectId, instanceId) {
+        return `${this.getExtensionsApiUri()}/${EXTENSIONS_API_VERSION}/projects/${projectId}/instances/${instanceId}/runtimeData`;
+    }
+    toFirebaseError(err) {
+        if (err instanceof error_1.PrefixedFirebaseError) {
+            return err;
+        }
+        const response = err.response;
+        if (!response?.isJson()) {
+            return new FirebaseExtensionsError('unknown-error', `Unexpected response with status: ${response.status} and body: ${response.text}`);
+        }
+        const error = response.data?.error;
+        const message = error?.message || `Unknown server error: ${response.text}`;
+        switch (error.code) {
+            case 403:
+                return new FirebaseExtensionsError('forbidden', message);
+            case 404:
+                return new FirebaseExtensionsError('not-found', message);
+            case 500:
+                return new FirebaseExtensionsError('internal-error', message);
+        }
+        return new FirebaseExtensionsError('unknown-error', message);
+    }
+}
+exports.ExtensionsApiClient = ExtensionsApiClient;
+/**
+ * Firebase Extensions error code structure. This extends PrefixedFirebaseError.
+ *
+ * @param code - The error code.
+ * @param message - The error message.
+ * @constructor
+ */
+class FirebaseExtensionsError extends error_1.PrefixedFirebaseError {
+    constructor(code, message) {
+        super('Extensions', code, message);
+        /* tslint:disable:max-line-length */
+        // Set the prototype explicitly. See the following link for more details:
+        // https://github.com/Microsoft/TypeScript/wiki/Breaking-Changes#extending-built-ins-like-error-array-and-map-may-no-longer-work
+        /* tslint:enable:max-line-length */
+        this.__proto__ = FirebaseExtensionsError.prototype;
+    }
+}
+exports.FirebaseExtensionsError = FirebaseExtensionsError;

package/lib/extensions/extensions-api.d.ts

@@ -0,0 +1,44 @@
+/*! firebase-admin v11.3.0 */
+/*!
+ * @license
+ * Copyright 2022 Google Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+/**
+ * `SettableProcessingState` represents all the processing states that can be set
+ * on an Extension instance's runtime data.
+ *
+ * @remarks
+ * You can set the following states:
+ *
+ * - `NONE`: No relevant lifecycle event work has been done.
+ *   Set this to clear out old statuses.
+ *
+ * - `PROCESSING_COMPLETE`: Lifecycle event work completed with no errors.
+ *
+ * - `PROCESSING_WARNING`: Lifecycle event work succeeded partially, or
+ *   something happened that the user should be warned about.
+ *
+ * - `PROCESSING_FAILED`: Lifecycle event work failed completely, but the
+ *   instance will still work correctly going forward.
+ *
+ * If the extension instance is in a broken state due to errors, instead call
+ * {@link Runtime.setFatalError}.
+ *
+ * The "processing" state gets set automatically when a lifecycle event handler
+ * starts; you can't set it explicitly.
+ * To report the ongoing status of an extension's function, use `console.log`
+ * or the Cloud Functions logger SDK.
+ */
+export declare type SettableProcessingState = 'NONE' | 'PROCESSING_COMPLETE' | 'PROCESSING_WARNING' | 'PROCESSING_FAILED';

package/lib/extensions/extensions-api.js

@@ -0,0 +1,19 @@
+/*! firebase-admin v11.3.0 */
+"use strict";
+/*!
+ * @license
+ * Copyright 2022 Google Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/extensions/extensions.d.ts

@@ -0,0 +1,73 @@
+/*! firebase-admin v11.3.0 */
+/*!
+ * @license
+ * Copyright 2022 Google Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import { App } from '../app';
+import { SettableProcessingState } from './extensions-api';
+/**
+ * The Firebase `Extensions` service interface.
+ */
+export declare class Extensions {
+    readonly app: App;
+    private readonly client;
+    /**
+     * The runtime() method returns a new Runtime, which provides methods to modify an extension instance's runtime data.
+     *
+     * @remarks
+     * This method will throw an error if called outside an Extensions environment.
+     *
+     * @returns A new {@link Runtime} object.
+     */
+    runtime(): Runtime;
+}
+/**
+ * Runtime provides methods to modify an extension instance's runtime data.
+ */
+export declare class Runtime {
+    private projectId;
+    private extensionInstanceId;
+    private readonly client;
+    /**
+     * Sets the processing state of an extension instance.
+     *
+     * @remarks
+     * Use this method to report the results of a lifecycle event handler.
+     *
+     * If the lifecycle event failed & the extension instance will no longer work
+     * correctly, use {@link Runtime.setFatalError} instead.
+     *
+     * To report the status of function calls other than lifecycle event handlers,
+     * use `console.log` or the Cloud Functions logger SDK.
+     *
+     * @param state - The state to set the instance to.
+     * @param detailMessage - A message explaining the results of the lifecycle function.
+     */
+    setProcessingState(state: SettableProcessingState, detailMessage: string): Promise<void>;
+    /**
+     * Reports a fatal error while running a lifecycle event handler.
+     *
+     * @remarks
+     * Call this method when a lifecycle event handler fails in a way that makes
+     * the Instance inoperable.
+     * If the lifecycle event failed but the instance will still work as expected,
+     * call `setProcessingState` with the "PROCESSING_WARNING" or
+     * "PROCESSING_FAILED" state instead.
+     *
+     * @param errorMessage - A message explaining what went wrong and how to fix it.
+     */
+    setFatalError(errorMessage: string): Promise<void>;
+    private getProjectId;
+}

package/lib/extensions/extensions.js

@@ -0,0 +1,122 @@
+/*! firebase-admin v11.3.0 */
+"use strict";
+/*!
+ * @license
+ * Copyright 2022 Google Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Runtime = exports.Extensions = void 0;
+const extensions_api_client_internal_1 = require("./extensions-api-client-internal");
+const validator = require("../utils/validator");
+/**
+ * The Firebase `Extensions` service interface.
+ */
+class Extensions {
+    /**
+     * @param app - The app for this `Extensions` service.
+     * @constructor
+     * @internal
+     */
+    constructor(app) {
+        this.app = app;
+        this.client = new extensions_api_client_internal_1.ExtensionsApiClient(app);
+    }
+    /**
+     * The runtime() method returns a new Runtime, which provides methods to modify an extension instance's runtime data.
+     *
+     * @remarks
+     * This method will throw an error if called outside an Extensions environment.
+     *
+     * @returns A new {@link Runtime} object.
+     */
+    runtime() {
+        return new Runtime(this.client);
+    }
+}
+exports.Extensions = Extensions;
+/**
+ * Runtime provides methods to modify an extension instance's runtime data.
+ */
+class Runtime {
+    /**
+     * @param client - The API client for this `Runtime` service.
+     * @constructor
+     * @internal
+     */
+    constructor(client) {
+        this.projectId = this.getProjectId();
+        if (!validator.isNonEmptyString(process.env['EXT_INSTANCE_ID'])) {
+            throw new extensions_api_client_internal_1.FirebaseExtensionsError('invalid-argument', 'Runtime is only available from within a running Extension instance.');
+        }
+        this.extensionInstanceId = process.env['EXT_INSTANCE_ID'];
+        if (!validator.isNonNullObject(client) || !('updateRuntimeData' in client)) {
+            throw new extensions_api_client_internal_1.FirebaseExtensionsError('invalid-argument', 'Must provide a valid ExtensionsApiClient instance to create a new Runtime.');
+        }
+        this.client = client;
+    }
+    /**
+     * Sets the processing state of an extension instance.
+     *
+     * @remarks
+     * Use this method to report the results of a lifecycle event handler.
+     *
+     * If the lifecycle event failed & the extension instance will no longer work
+     * correctly, use {@link Runtime.setFatalError} instead.
+     *
+     * To report the status of function calls other than lifecycle event handlers,
+     * use `console.log` or the Cloud Functions logger SDK.
+     *
+     * @param state - The state to set the instance to.
+     * @param detailMessage - A message explaining the results of the lifecycle function.
+     */
+    async setProcessingState(state, detailMessage) {
+        await this.client.updateRuntimeData(this.projectId, this.extensionInstanceId, {
+            processingState: {
+                state,
+                detailMessage,
+            },
+        });
+    }
+    /**
+     * Reports a fatal error while running a lifecycle event handler.
+     *
+     * @remarks
+     * Call this method when a lifecycle event handler fails in a way that makes
+     * the Instance inoperable.
+     * If the lifecycle event failed but the instance will still work as expected,
+     * call `setProcessingState` with the "PROCESSING_WARNING" or
+     * "PROCESSING_FAILED" state instead.
+     *
+     * @param errorMessage - A message explaining what went wrong and how to fix it.
+     */
+    async setFatalError(errorMessage) {
+        if (!validator.isNonEmptyString(errorMessage)) {
+            throw new extensions_api_client_internal_1.FirebaseExtensionsError('invalid-argument', 'errorMessage must not be empty');
+        }
+        await this.client.updateRuntimeData(this.projectId, this.extensionInstanceId, {
+            fatalError: {
+                errorMessage,
+            },
+        });
+    }
+    getProjectId() {
+        const projectId = process.env['PROJECT_ID'];
+        if (!validator.isNonEmptyString(projectId)) {
+            throw new extensions_api_client_internal_1.FirebaseExtensionsError('invalid-argument', 'PROJECT_ID must not be undefined in Extensions runtime environment');
+        }
+        return projectId;
+    }
+}
+exports.Runtime = Runtime;

package/lib/extensions/index.d.ts

@@ -0,0 +1,53 @@
+/*! firebase-admin v11.3.0 */
+/*!
+ * @license
+ * Copyright 2021 Google Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+/**
+ * Firebase Extensions service.
+ *
+ * @packageDocumentation
+ */
+import { App } from '../app';
+import { Extensions } from './extensions';
+export { Extensions, Runtime } from './extensions';
+export { SettableProcessingState } from './extensions-api';
+/**
+  * Gets the {@link Extensions} service for the default app
+  * or a given app.
+  *
+  * `getExtensions()` can be called with no arguments to access the default
+  * app's `Extensions` service or as `getExtensions(app)` to access the
+  * `Extensions` service associated with a specific app.
+  *
+  * @example
+  * ```javascript
+  * // Get the `Extensions` service for the default app
+  * const defaultExtensions = getExtensions();
+  * ```
+  *
+  * @example
+  * ```javascript
+  * // Get the `Extensions` service for a given app
+  * const otherExtensions = getExtensions(otherApp);
+  * ```
+  *
+  * @param app - Optional app for which to return the `Extensions` service.
+  *   If not provided, the default `Extensions` service is returned.
+  *
+  * @returns The default `Extensions` service if no app is provided, or the `Extensions`
+  *   service associated with the provided app.
+  */
+export declare function getExtensions(app?: App): Extensions;

package/lib/extensions/index.js

@@ -0,0 +1,64 @@
+/*! firebase-admin v11.3.0 */
+"use strict";
+/*!
+ * @license
+ * Copyright 2021 Google Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getExtensions = exports.Runtime = exports.Extensions = void 0;
+/**
+ * Firebase Extensions service.
+ *
+ * @packageDocumentation
+ */
+const app_1 = require("../app");
+const extensions_1 = require("./extensions");
+var extensions_2 = require("./extensions");
+Object.defineProperty(exports, "Extensions", { enumerable: true, get: function () { return extensions_2.Extensions; } });
+Object.defineProperty(exports, "Runtime", { enumerable: true, get: function () { return extensions_2.Runtime; } });
+/**
+  * Gets the {@link Extensions} service for the default app
+  * or a given app.
+  *
+  * `getExtensions()` can be called with no arguments to access the default
+  * app's `Extensions` service or as `getExtensions(app)` to access the
+  * `Extensions` service associated with a specific app.
+  *
+  * @example
+  * ```javascript
+  * // Get the `Extensions` service for the default app
+  * const defaultExtensions = getExtensions();
+  * ```
+  *
+  * @example
+  * ```javascript
+  * // Get the `Extensions` service for a given app
+  * const otherExtensions = getExtensions(otherApp);
+  * ```
+  *
+  * @param app - Optional app for which to return the `Extensions` service.
+  *   If not provided, the default `Extensions` service is returned.
+  *
+  * @returns The default `Extensions` service if no app is provided, or the `Extensions`
+  *   service associated with the provided app.
+  */
+function getExtensions(app) {
+    if (typeof app === 'undefined') {
+        app = (0, app_1.getApp)();
+    }
+    const firebaseApp = app;
+    return firebaseApp.getOrInitService('extensions', (app) => new extensions_1.Extensions(app));
+}
+exports.getExtensions = getExtensions;

package/lib/firebase-namespace-api.d.ts

@@ -1,4 +1,4 @@
-/*! firebase-admin v11.2.0 */
+/*! firebase-admin v11.3.0 */
 /*!
  * Copyright 2021 Google Inc.
  *

package/lib/firebase-namespace-api.js

@@ -1,4 +1,4 @@
-/*! firebase-admin v11.2.0 */
+/*! firebase-admin v11.3.0 */
 "use strict";
 /*!
  * Copyright 2021 Google Inc.

package/lib/firestore/firestore-internal.d.ts

@@ -1,4 +1,4 @@
-/*! firebase-admin v11.2.0 */
+/*! firebase-admin v11.3.0 */
 /*!
  * @license
  * Copyright 2017 Google Inc.
@@ -18,15 +18,15 @@
 import { Firestore, Settings } from '@google-cloud/firestore';
 import { App } from '../app';
 export declare class FirestoreService {
-    private appInternal;
-    private firestoreClient;
+    private readonly appInternal;
+    private readonly databases;
     constructor(app: App);
+    getDatabase(databaseId: string): Firestore;
     /**
      * Returns the app associated with this Storage instance.
      *
      * @returns The app associated with this Storage instance.
      */
     get app(): App;
-    get client(): Firestore;
 }
 export declare function getFirestoreOptions(app: App): Settings;

package/lib/firestore/firestore-internal.js

@@ -1,4 +1,4 @@
-/*! firebase-admin v11.2.0 */
+/*! firebase-admin v11.3.0 */
 "use strict";
 /*!
  * @license
@@ -24,9 +24,17 @@ const validator = require("../utils/validator");
 const utils = require("../utils/index");
 class FirestoreService {
     constructor(app) {
-        this.firestoreClient = initFirestore(app);
+        this.databases = new Map();
         this.appInternal = app;
     }
+    getDatabase(databaseId) {
+        let database = this.databases.get(databaseId);
+        if (database === undefined) {
+            database = initFirestore(this.app, databaseId);
+            this.databases.set(databaseId, database);
+        }
+        return database;
+    }
     /**
      * Returns the app associated with this Storage instance.
      *
@@ -35,9 +43,6 @@ class FirestoreService {
     get app() {
         return this.appInternal;
     }
-    get client() {
-        return this.firestoreClient;
-    }
 }
 exports.FirestoreService = FirestoreService;
 function getFirestoreOptions(app) {
@@ -77,8 +82,9 @@ function getFirestoreOptions(app) {
     });
 }
 exports.getFirestoreOptions = getFirestoreOptions;
-function initFirestore(app) {
+function initFirestore(app, databaseId) {
     const options = getFirestoreOptions(app);
+    options.databaseId = databaseId;
     let firestoreDatabase;
     try {
         // Lazy-load the Firestore implementation here, which in turns loads gRPC.

package/lib/firestore/firestore-namespace.d.ts

@@ -1,4 +1,4 @@
-/*! firebase-admin v11.2.0 */
+/*! firebase-admin v11.3.0 */
 /*!
  * Copyright 2021 Google Inc.
  *

package/lib/firestore/firestore-namespace.js

@@ -1,4 +1,4 @@
-/*! firebase-admin v11.2.0 */
+/*! firebase-admin v11.3.0 */
 "use strict";
 /*!
  * Copyright 2021 Google Inc.

package/lib/firestore/index.d.ts

@@ -1,4 +1,4 @@
-/*! firebase-admin v11.2.0 */
+/*! firebase-admin v11.3.0 */
 /*!
  * Copyright 2020 Google Inc.
  *
@@ -21,10 +21,10 @@
  */
 import { Firestore } from '@google-cloud/firestore';
 import { App } from '../app';
-export { AddPrefixToKeys, BulkWriter, BulkWriterOptions, BundleBuilder, ChildUpdateFields, CollectionGroup, CollectionReference, DocumentChange, DocumentChangeType, DocumentData, DocumentReference, DocumentSnapshot, FieldPath, FieldValue, Firestore, FirestoreDataConverter, GeoPoint, GrpcStatus, NestedUpdateFields, OrderByDirection, PartialWithFieldValue, Precondition, Primitive, Query, QueryDocumentSnapshot, QueryPartition, QuerySnapshot, ReadOptions, ReadOnlyTransactionOptions, Settings, SetOptions, Timestamp, Transaction, UpdateData, UnionToIntersection, WhereFilterOp, WithFieldValue, WriteBatch, WriteResult, v1, setLogFunction, } from '@google-cloud/firestore';
+export { AddPrefixToKeys, BulkWriter, BulkWriterOptions, BundleBuilder, ChildUpdateFields, CollectionGroup, CollectionReference, DocumentChange, DocumentChangeType, DocumentData, DocumentReference, DocumentSnapshot, FieldPath, FieldValue, Firestore, FirestoreDataConverter, GeoPoint, GrpcStatus, NestedUpdateFields, OrderByDirection, PartialWithFieldValue, Precondition, Primitive, Query, QueryDocumentSnapshot, QueryPartition, QuerySnapshot, ReadOptions, ReadOnlyTransactionOptions, ReadWriteTransactionOptions, Settings, SetOptions, Timestamp, Transaction, UpdateData, UnionToIntersection, WhereFilterOp, WithFieldValue, WriteBatch, WriteResult, v1, setLogFunction, } from '@google-cloud/firestore';
 /**
  * Gets the {@link https://googleapis.dev/nodejs/firestore/latest/Firestore.html | Firestore}
- * service for the default app or a given app.
+ * service for the default app.
  *
  * `getFirestore()` can be called with no arguments to access the default
  * app's `Firestore` service or as `getFirestore(app)` to access the
@@ -35,6 +35,19 @@ export { AddPrefixToKeys, BulkWriter, BulkWriterOptions, BundleBuilder, ChildUpd
  * // Get the Firestore service for the default app
  * const defaultFirestore = getFirestore();
  * ```
+
+ * @returns The default {@link https://googleapis.dev/nodejs/firestore/latest/Firestore.html | Firestore}
+ *   service if no app is provided or the `Firestore` service associated with the
+ *   provided app.
+ */
+export declare function getFirestore(): Firestore;
+/**
+ * Gets the {@link https://googleapis.dev/nodejs/firestore/latest/Firestore.html | Firestore}
+ * service for the given app.
+ *
+ * `getFirestore()` can be called with no arguments to access the default
+ * app's `Firestore` service or as `getFirestore(app)` to access the
+ * `Firestore` service associated with a specific app.
  *
  * @example
  * ```javascript
@@ -49,4 +62,4 @@ export { AddPrefixToKeys, BulkWriter, BulkWriterOptions, BundleBuilder, ChildUpd
  *   service if no app is provided or the `Firestore` service associated with the
  *   provided app.
  */
-export declare function getFirestore(app?: App): Firestore;
+export declare function getFirestore(app: App): Firestore;