firebase-admin 9.100.0-alpha.0 → 10.0.2

package/README.md

@@ -36,13 +36,17 @@ $ npm install --save firebase-admin
 To use the module in your application, `require` it from any JavaScript file:
 
 ```js
-var admin = require("firebase-admin");
+const { initializeApp } = require("firebase-admin/app");
+
+initializeApp();
 ```
 
 If you are using ES2015, you can `import` the module instead:
 
 ```js
-import * as admin from "firebase-admin";
+import { initializeApp } from "firebase-admin/app";
+
+initializeApp();
 ```
 
 
@@ -55,7 +59,7 @@ requests, code review feedback, and also pull requests.
 
 ## Supported Environments
 
-We support Node.js 10.10.0 and higher.
+We support Node.js 12 and higher.
 
 Please also note that the Admin SDK should only
 be used in server-side/back-end environments controlled by the app developer.

package/lib/app/core.d.ts

@@ -1,4 +1,4 @@
-/*! firebase-admin v9.100.0-alpha.0 */
+/*! firebase-admin v10.0.2 */
 /*!
  * @license
  * Copyright 2021 Google Inc.
@@ -19,19 +19,19 @@
 import { Agent } from 'http';
 import { Credential } from './credential';
 /**
- * Available options to pass to [`initializeApp()`](admin#.initializeApp).
+ * Available options to pass to {@link firebase-admin.app#initializeApp}.
  */
 export interface AppOptions {
     /**
-     * A {@link Credential `Credential`} object used to
+     * A {@link firebase-admin.app#Credential} object used to
      * authenticate the Admin SDK.
      *
-     * See [Initialize the SDK](/docs/admin/setup#initialize_the_sdk) for detailed
-     * documentation and code samples.
+     * See {@link https://firebase.google.com/docs/admin/setup#initialize_the_sdk | Initialize the SDK}
+     * for detailed documentation and code samples.
      */
     credential?: Credential;
     /**
-     * The object to use as the [`auth`](/docs/reference/security/database/#auth)
+     * The object to use as the {@link https://firebase.google.com/docs/reference/security/database/#auth | auth}
      * variable in your Realtime Database Rules when the Admin SDK reads from or
      * writes to the Realtime Database. This allows you to downscope the Admin SDK
      * from its default full read and write privileges.
@@ -39,7 +39,8 @@ export interface AppOptions {
      * You can pass `null` to act as an unauthenticated client.
      *
      * See
-     * [Authenticate with limited privileges](/docs/database/admin/start#authenticate-with-limited-privileges)
+     * {@link https://firebase.google.com/docs/database/admin/start#authenticate-with-limited-privileges |
+     * Authenticate with limited privileges}
      * for detailed documentation and code samples.
      */
     databaseAuthVariableOverride?: object | null;
@@ -63,7 +64,7 @@ export interface AppOptions {
      */
     projectId?: string;
     /**
-     * An [HTTP Agent](https://nodejs.org/api/http.html#http_class_http_agent)
+     * An {@link https://nodejs.org/api/http.html#http_class_http_agent | HTTP Agent}
      * to be used when making outgoing HTTP calls. This Agent instance is used
      * by all services that make REST calls (e.g. `auth`, `messaging`,
      * `projectManagement`).
@@ -78,12 +79,6 @@ export interface AppOptions {
 /**
  * A Firebase app holds the initialization information for a collection of
  * services.
- *
- * Do not call this constructor directly. Instead, use
- * {@link
- *   https://firebase.google.com/docs/reference/admin/node/admin#.initializeApp
- *   `admin.initializeApp()`}
- * to create an app.
  */
 export interface App {
     /**
@@ -108,10 +103,7 @@ export interface App {
     name: string;
     /**
      * The (read-only) configuration options for this app. These are the original
-     * parameters given in
-     * {@link
-     *   https://firebase.google.com/docs/reference/admin/node/admin#.initializeApp
-     *   `admin.initializeApp()`}.
+     * parameters given in {@link firebase-admin.app#initializeApp}.
      *
      * @example
      * ```javascript
@@ -148,13 +140,14 @@ export interface FirebaseError {
      * A string value containing the execution backtrace when the error originally
      * occurred.
      *
-     * This information can be useful to you and can be sent to
-     * {@link https://firebase.google.com/support/ Firebase Support} to help
-     * explain the cause of an error.
+     * This information can be useful for troubleshooting the cause of the error with
+     * {@link https://firebase.google.com/support | Firebase Support}.
      */
     stack?: string;
     /**
-     * @return A JSON-serializable representation of this object.
+     * Returns a JSON-serializable object representation of this error.
+     *
+     * @returns A JSON-serializable representation of this object.
      */
     toJSON(): object;
 }

package/lib/app/core.js

@@ -1,4 +1,4 @@
-/*! firebase-admin v9.100.0-alpha.0 */
+/*! firebase-admin v10.0.2 */
 "use strict";
 /*!
  * @license

package/lib/app/credential-factory.d.ts

@@ -1,4 +1,4 @@
-/*! firebase-admin v9.100.0-alpha.0 */
+/*! firebase-admin v10.0.2 */
 /*!
  * @license
  * Copyright 2021 Google Inc.
@@ -20,22 +20,16 @@ import { Agent } from 'http';
 import { Credential, ServiceAccount } from './credential';
 /**
  * Returns a credential created from the
- * {@link
- *    https://developers.google.com/identity/protocols/application-default-credentials
- *    Google Application Default Credentials}
+ * {@link https://developers.google.com/identity/protocols/application-default-credentials |
+ * Google Application Default Credentials}
  * that grants admin access to Firebase services. This credential can be used
- * in the call to
- * {@link
- *   https://firebase.google.com/docs/reference/admin/node/admin#.initializeApp
- *  `admin.initializeApp()`}.
+ * in the call to {@link firebase-admin.app#initializeApp}.
  *
  * Google Application Default Credentials are available on any Google
  * infrastructure, such as Google App Engine and Google Compute Engine.
  *
  * See
- * {@link
- *   https://firebase.google.com/docs/admin/setup#initialize_the_sdk
- *   Initialize the SDK}
+ * {@link https://firebase.google.com/docs/admin/setup#initialize_the_sdk | Initialize the SDK}
  * for more details.
  *
  * @example
@@ -46,25 +40,20 @@ import { Credential, ServiceAccount } from './credential';
  * });
  * ```
  *
- * @param httpAgent Optional [HTTP Agent](https://nodejs.org/api/http.html#http_class_http_agent)
+ * @param httpAgent - Optional {@link https://nodejs.org/api/http.html#http_class_http_agent | HTTP Agent}
  *   to be used when retrieving access tokens from Google token servers.
  *
- * @return A credential authenticated via Google
+ * @returns A credential authenticated via Google
  *   Application Default Credentials that can be used to initialize an app.
  */
 export declare function applicationDefault(httpAgent?: Agent): Credential;
 /**
  * Returns a credential created from the provided service account that grants
  * admin access to Firebase services. This credential can be used in the call
- * to
- * {@link
- *   https://firebase.google.com/docs/reference/admin/node/admin#.initializeApp
- *   `admin.initializeApp()`}.
+ * to {@link firebase-admin.app#initializeApp}.
  *
  * See
- * {@link
- *   https://firebase.google.com/docs/admin/setup#initialize_the_sdk
- *   Initialize the SDK}
+ * {@link https://firebase.google.com/docs/admin/setup#initialize_the_sdk | Initialize the SDK}
  * for more details.
  *
  * @example
@@ -90,27 +79,22 @@ export declare function applicationDefault(httpAgent?: Agent): Credential;
  * });
  * ```
  *
- * @param serviceAccountPathOrObject The path to a service
+ * @param serviceAccountPathOrObject - The path to a service
  *   account key JSON file or an object representing a service account key.
- * @param httpAgent Optional [HTTP Agent](https://nodejs.org/api/http.html#http_class_http_agent)
+ * @param httpAgent - Optional {@link https://nodejs.org/api/http.html#http_class_http_agent | HTTP Agent}
  *   to be used when retrieving access tokens from Google token servers.
  *
- * @return A credential authenticated via the
+ * @returns A credential authenticated via the
  *   provided service account that can be used to initialize an app.
  */
 export declare function cert(serviceAccountPathOrObject: string | ServiceAccount, httpAgent?: Agent): Credential;
 /**
  * Returns a credential created from the provided refresh token that grants
  * admin access to Firebase services. This credential can be used in the call
- * to
- * {@link
- *   https://firebase.google.com/docs/reference/admin/node/admin#.initializeApp
- *   `admin.initializeApp()`}.
+ * to {@link firebase-admin.app#initializeApp}.
  *
  * See
- * {@link
- *   https://firebase.google.com/docs/admin/setup#initialize_the_sdk
- *   Initialize the SDK}
+ * {@link https://firebase.google.com/docs/admin/setup#initialize_the_sdk | Initialize the SDK}
  * for more details.
  *
  * @example
@@ -123,13 +107,13 @@ export declare function cert(serviceAccountPathOrObject: string | ServiceAccount
  * });
  * ```
  *
- * @param refreshTokenPathOrObject The path to a Google
+ * @param refreshTokenPathOrObject - The path to a Google
  *   OAuth2 refresh token JSON file or an object representing a Google OAuth2
  *   refresh token.
- * @param httpAgent Optional [HTTP Agent](https://nodejs.org/api/http.html#http_class_http_agent)
+ * @param httpAgent - Optional {@link https://nodejs.org/api/http.html#http_class_http_agent | HTTP Agent}
  *   to be used when retrieving access tokens from Google token servers.
  *
- * @return A credential authenticated via the
+ * @returns A credential authenticated via the
  *   provided service account that can be used to initialize an app.
  */
 export declare function refreshToken(refreshTokenPathOrObject: string | object, httpAgent?: Agent): Credential;

package/lib/app/credential-factory.js

@@ -1,4 +1,4 @@
-/*! firebase-admin v9.100.0-alpha.0 */
+/*! firebase-admin v10.0.2 */
 "use strict";
 /*!
  * @license
@@ -24,22 +24,16 @@ var globalCertCreds = {};
 var globalRefreshTokenCreds = {};
 /**
  * Returns a credential created from the
- * {@link
- *    https://developers.google.com/identity/protocols/application-default-credentials
- *    Google Application Default Credentials}
+ * {@link https://developers.google.com/identity/protocols/application-default-credentials |
+ * Google Application Default Credentials}
  * that grants admin access to Firebase services. This credential can be used
- * in the call to
- * {@link
- *   https://firebase.google.com/docs/reference/admin/node/admin#.initializeApp
- *  `admin.initializeApp()`}.
+ * in the call to {@link firebase-admin.app#initializeApp}.
  *
  * Google Application Default Credentials are available on any Google
  * infrastructure, such as Google App Engine and Google Compute Engine.
  *
  * See
- * {@link
- *   https://firebase.google.com/docs/admin/setup#initialize_the_sdk
- *   Initialize the SDK}
+ * {@link https://firebase.google.com/docs/admin/setup#initialize_the_sdk | Initialize the SDK}
  * for more details.
  *
  * @example
@@ -50,10 +44,10 @@ var globalRefreshTokenCreds = {};
  * });
  * ```
  *
- * @param httpAgent Optional [HTTP Agent](https://nodejs.org/api/http.html#http_class_http_agent)
+ * @param httpAgent - Optional {@link https://nodejs.org/api/http.html#http_class_http_agent | HTTP Agent}
  *   to be used when retrieving access tokens from Google token servers.
  *
- * @return A credential authenticated via Google
+ * @returns A credential authenticated via Google
  *   Application Default Credentials that can be used to initialize an app.
  */
 function applicationDefault(httpAgent) {
@@ -66,15 +60,10 @@ exports.applicationDefault = applicationDefault;
 /**
  * Returns a credential created from the provided service account that grants
  * admin access to Firebase services. This credential can be used in the call
- * to
- * {@link
- *   https://firebase.google.com/docs/reference/admin/node/admin#.initializeApp
- *   `admin.initializeApp()`}.
+ * to {@link firebase-admin.app#initializeApp}.
  *
  * See
- * {@link
- *   https://firebase.google.com/docs/admin/setup#initialize_the_sdk
- *   Initialize the SDK}
+ * {@link https://firebase.google.com/docs/admin/setup#initialize_the_sdk | Initialize the SDK}
  * for more details.
  *
  * @example
@@ -100,12 +89,12 @@ exports.applicationDefault = applicationDefault;
  * });
  * ```
  *
- * @param serviceAccountPathOrObject The path to a service
+ * @param serviceAccountPathOrObject - The path to a service
  *   account key JSON file or an object representing a service account key.
- * @param httpAgent Optional [HTTP Agent](https://nodejs.org/api/http.html#http_class_http_agent)
+ * @param httpAgent - Optional {@link https://nodejs.org/api/http.html#http_class_http_agent | HTTP Agent}
  *   to be used when retrieving access tokens from Google token servers.
  *
- * @return A credential authenticated via the
+ * @returns A credential authenticated via the
  *   provided service account that can be used to initialize an app.
  */
 function cert(serviceAccountPathOrObject, httpAgent) {
@@ -119,15 +108,10 @@ exports.cert = cert;
 /**
  * Returns a credential created from the provided refresh token that grants
  * admin access to Firebase services. This credential can be used in the call
- * to
- * {@link
- *   https://firebase.google.com/docs/reference/admin/node/admin#.initializeApp
- *   `admin.initializeApp()`}.
+ * to {@link firebase-admin.app#initializeApp}.
  *
  * See
- * {@link
- *   https://firebase.google.com/docs/admin/setup#initialize_the_sdk
- *   Initialize the SDK}
+ * {@link https://firebase.google.com/docs/admin/setup#initialize_the_sdk | Initialize the SDK}
  * for more details.
  *
  * @example
@@ -140,13 +124,13 @@ exports.cert = cert;
  * });
  * ```
  *
- * @param refreshTokenPathOrObject The path to a Google
+ * @param refreshTokenPathOrObject - The path to a Google
  *   OAuth2 refresh token JSON file or an object representing a Google OAuth2
  *   refresh token.
- * @param httpAgent Optional [HTTP Agent](https://nodejs.org/api/http.html#http_class_http_agent)
+ * @param httpAgent - Optional {@link https://nodejs.org/api/http.html#http_class_http_agent | HTTP Agent}
  *   to be used when retrieving access tokens from Google token servers.
  *
- * @return A credential authenticated via the
+ * @returns A credential authenticated via the
  *   provided service account that can be used to initialize an app.
  */
 function refreshToken(refreshTokenPathOrObject, httpAgent) {

package/lib/app/credential-internal.d.ts

@@ -1,4 +1,4 @@
-/*! firebase-admin v9.100.0-alpha.0 */
+/*! firebase-admin v10.0.2 */
 /*!
  * @license
  * Copyright 2020 Google Inc.
@@ -31,9 +31,9 @@ export declare class ServiceAccountCredential implements Credential {
     /**
      * Creates a new ServiceAccountCredential from the given parameters.
      *
-     * @param serviceAccountPathOrObject Service account json object or path to a service account json file.
-     * @param httpAgent Optional http.Agent to use when calling the remote token server.
-     * @param implicit An optinal boolean indicating whether this credential was implicitly discovered from the
+     * @param serviceAccountPathOrObject - Service account json object or path to a service account json file.
+     * @param httpAgent - Optional http.Agent to use when calling the remote token server.
+     * @param implicit - An optinal boolean indicating whether this credential was implicitly discovered from the
      *   environment, as opposed to being explicitly specified by the developer.
      *
      * @constructor
@@ -67,10 +67,11 @@ export declare class RefreshTokenCredential implements Credential {
     /**
      * Creates a new RefreshTokenCredential from the given parameters.
      *
-     * @param refreshTokenPathOrObject Refresh token json object or path to a refresh token (user credentials) json file.
-     * @param httpAgent Optional http.Agent to use when calling the remote token server.
-     * @param implicit An optinal boolean indicating whether this credential was implicitly discovered from the
-     *   environment, as opposed to being explicitly specified by the developer.
+     * @param refreshTokenPathOrObject - Refresh token json object or path to a refresh token
+     *   (user credentials) json file.
+     * @param httpAgent - Optional http.Agent to use when calling the remote token server.
+     * @param implicit - An optinal boolean indicating whether this credential was implicitly
+     *   discovered from the environment, as opposed to being explicitly specified by the developer.
      *
      * @constructor
      */
@@ -83,7 +84,7 @@ export declare class RefreshTokenCredential implements Credential {
  * instances that were loaded from well-known files or environment variables, rather than being explicitly
  * instantiated.
  *
- * @param credential The credential instance to check.
+ * @param credential - The credential instance to check.
  */
 export declare function isApplicationDefault(credential?: Credential): boolean;
 export declare function getApplicationDefault(httpAgent?: Agent): Credential;

package/lib/app/credential-internal.js

@@ -1,4 +1,4 @@
-/*! firebase-admin v9.100.0-alpha.0 */
+/*! firebase-admin v10.0.2 */
 "use strict";
 /*!
  * @license
@@ -53,9 +53,9 @@ var ServiceAccountCredential = /** @class */ (function () {
     /**
      * Creates a new ServiceAccountCredential from the given parameters.
      *
-     * @param serviceAccountPathOrObject Service account json object or path to a service account json file.
-     * @param httpAgent Optional http.Agent to use when calling the remote token server.
-     * @param implicit An optinal boolean indicating whether this credential was implicitly discovered from the
+     * @param serviceAccountPathOrObject - Service account json object or path to a service account json file.
+     * @param httpAgent - Optional http.Agent to use when calling the remote token server.
+     * @param implicit - An optinal boolean indicating whether this credential was implicitly discovered from the
      *   environment, as opposed to being explicitly specified by the developer.
      *
      * @constructor
@@ -87,6 +87,7 @@ var ServiceAccountCredential = /** @class */ (function () {
         };
         return requestAccessToken(this.httpClient, request);
     };
+    // eslint-disable-next-line @typescript-eslint/naming-convention
     ServiceAccountCredential.prototype.createAuthJwt_ = function () {
         var claims = {
             scope: [
@@ -204,10 +205,11 @@ var RefreshTokenCredential = /** @class */ (function () {
     /**
      * Creates a new RefreshTokenCredential from the given parameters.
      *
-     * @param refreshTokenPathOrObject Refresh token json object or path to a refresh token (user credentials) json file.
-     * @param httpAgent Optional http.Agent to use when calling the remote token server.
-     * @param implicit An optinal boolean indicating whether this credential was implicitly discovered from the
-     *   environment, as opposed to being explicitly specified by the developer.
+     * @param refreshTokenPathOrObject - Refresh token json object or path to a refresh token
+     *   (user credentials) json file.
+     * @param httpAgent - Optional http.Agent to use when calling the remote token server.
+     * @param implicit - An optinal boolean indicating whether this credential was implicitly
+     *   discovered from the environment, as opposed to being explicitly specified by the developer.
      *
      * @constructor
      */
@@ -283,7 +285,7 @@ var RefreshToken = /** @class */ (function () {
  * instances that were loaded from well-known files or environment variables, rather than being explicitly
  * instantiated.
  *
- * @param credential The credential instance to check.
+ * @param credential - The credential instance to check.
  */
 function isApplicationDefault(credential) {
     return credential instanceof ComputeEngineCredential ||
@@ -311,10 +313,10 @@ exports.getApplicationDefault = getApplicationDefault;
  * If no property exists by the given "key", looks for a property identified by "alt", and copies it instead.
  * This can be used to implement behaviors such as "copy property myKey or my_key".
  *
- * @param to Target object to copy the property into.
- * @param from Source object to copy the property from.
- * @param key Name of the property to copy.
- * @param alt Alternative name of the property to copy.
+ * @param to - Target object to copy the property into.
+ * @param from - Source object to copy the property from.
+ * @param key - Name of the property to copy.
+ * @param alt - Alternative name of the property to copy.
  */
 function copyAttr(to, from, key, alt) {
     var tmp = from[key] || from[alt];

package/lib/app/credential.d.ts

@@ -1,4 +1,4 @@
-/*! firebase-admin v9.100.0-alpha.0 */
+/*! firebase-admin v10.0.2 */
 /*!
  * @license
  * Copyright 2021 Google Inc.
@@ -32,20 +32,14 @@ export interface GoogleOAuthAccessToken {
  * with Firebase services.
  *
  * In most cases, you will not need to implement this yourself and can instead
- * use the default implementations provided by
- * {@link credential `admin.credential`}.
+ * use the default implementations provided by the `firebase-admin/app` module.
  */
 export interface Credential {
     /**
      * Returns a Google OAuth2 access token object used to authenticate with
      * Firebase services.
      *
-     * This object contains the following properties:
-     * * `access_token` (`string`): The actual Google OAuth2 access token.
-     * * `expires_in` (`number`): The number of seconds from when the token was
-     *   issued that it expires.
-     *
-     * @return A Google OAuth2 access token object.
+     * @returns A Google OAuth2 access token object.
      */
     getAccessToken(): Promise<GoogleOAuthAccessToken>;
 }

package/lib/app/credential.js

@@ -1,4 +1,4 @@
-/*! firebase-admin v9.100.0-alpha.0 */
+/*! firebase-admin v10.0.2 */
 "use strict";
 /*!
  * @license

package/lib/app/firebase-app.d.ts

@@ -1,4 +1,4 @@
-/*! firebase-admin v9.100.0-alpha.0 */
+/*! firebase-admin v10.0.2 */
 /*!
  * @license
  * Copyright 2017 Google Inc.
@@ -15,12 +15,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-import { app } from '../firebase-namespace-api';
 import { Credential } from './credential';
-/**
- * Type representing a callback which is called every time an app lifecycle event occurs.
- */
-export declare type AppHook = (event: string, app: app.App) => void;
 /**
  * Type representing a Firebase OAuth access token (derived from a Google OAuth2 access token) which
  * can be used to authenticate to Firebase services such as the Realtime Database and Auth.
@@ -34,42 +29,23 @@ export interface FirebaseAccessToken {
  */
 export declare class FirebaseAppInternals {
     private credential_;
-    private isDeleted_;
     private cachedToken_;
-    private cachedTokenPromise_;
     private tokenListeners_;
-    private tokenRefreshTimeout_;
     constructor(credential_: Credential);
-    /**
-     * Gets an auth token for the associated app.
-     *
-     * @param {boolean} forceRefresh Whether or not to force a token refresh.
-     * @return {Promise<FirebaseAccessToken>} A Promise that will be fulfilled with the current or
-     *   new token.
-     */
     getToken(forceRefresh?: boolean): Promise<FirebaseAccessToken>;
+    getCachedToken(): FirebaseAccessToken | null;
+    private refreshToken;
+    private shouldRefresh;
     /**
      * Adds a listener that is called each time a token changes.
      *
-     * @param {function(string)} listener The listener that will be called with each new token.
+     * @param listener - The listener that will be called with each new token.
      */
     addAuthTokenListener(listener: (token: string) => void): void;
     /**
      * Removes a token listener.
      *
-     * @param {function(string)} listener The listener to remove.
+     * @param listener - The listener to remove.
      */
     removeAuthTokenListener(listener: (token: string) => void): void;
-    /**
-     * Deletes the FirebaseAppInternals instance.
-     */
-    delete(): void;
-    /**
-     * Establishes timeout to refresh the Google OAuth2 access token used by the SDK.
-     *
-     * @param {number} delayInMilliseconds The delay to use for the timeout.
-     * @param {number} numRetries The number of times to retry fetching a new token if the prior fetch
-     *   failed.
-     */
-    private setTokenRefreshTimeout;
 }