firebase-admin 9.100.0-alpha.0 → 10.0.2

package/lib/messaging/messaging.js

@@ -1,4 +1,4 @@
-/*! firebase-admin v9.100.0-alpha.0 */
+/*! firebase-admin v10.0.2 */
 "use strict";
 /*!
  * @license
@@ -35,7 +35,6 @@ var utils = require("../utils");
 var validator = require("../utils/validator");
 var messaging_internal_1 = require("./messaging-internal");
 var messaging_api_request_internal_1 = require("./messaging-api-request-internal");
-/* eslint-disable @typescript-eslint/camelcase */
 // FCM endpoints
 var FCM_SEND_HOST = 'fcm.googleapis.com';
 var FCM_SEND_PATH = '/fcm/send';
@@ -90,9 +89,9 @@ var MESSAGING_CONDITION_RESPONSE_KEYS_MAP = {
 /**
  * Maps a raw FCM server response to a MessagingDevicesResponse object.
  *
- * @param {object} response The raw FCM server response to map.
+ * @param response - The raw FCM server response to map.
  *
- * @return {MessagingDeviceGroupResponse} The mapped MessagingDevicesResponse object.
+ * @returns The mapped MessagingDevicesResponse object.
  */
 function mapRawResponseToDevicesResponse(response) {
     // Rename properties on the server response
@@ -112,9 +111,9 @@ function mapRawResponseToDevicesResponse(response) {
 /**
  * Maps a raw FCM server response to a MessagingDeviceGroupResponse object.
  *
- * @param {object} response The raw FCM server response to map.
+ * @param response - The raw FCM server response to map.
  *
- * @return {MessagingDeviceGroupResponse} The mapped MessagingDeviceGroupResponse object.
+ * @returns The mapped MessagingDeviceGroupResponse object.
  */
 function mapRawResponseToDeviceGroupResponse(response) {
     // Rename properties on the server response
@@ -129,7 +128,7 @@ function mapRawResponseToDeviceGroupResponse(response) {
  *
  * @param {object} response The raw FCM server response to map.
  *
- * @return {MessagingTopicManagementResponse} The mapped MessagingTopicManagementResponse object.
+ * @returns {MessagingTopicManagementResponse} The mapped MessagingTopicManagementResponse object.
  */
 function mapRawResponseToTopicManagementResponse(response) {
     // Add the success and failure counts.
@@ -161,17 +160,7 @@ function mapRawResponseToTopicManagementResponse(response) {
  */
 var Messaging = /** @class */ (function () {
     /**
-     * Gets the {@link messaging.Messaging `Messaging`} service for the
-     * current app.
-     *
-     * @example
-     * ```javascript
-     * var messaging = app.messaging();
-     * // The above is shorthand for:
-     * // var messaging = admin.messaging(app);
-     * ```
-     *
-     * @return The `Messaging` service for the current app.
+     * @internal
      */
     function Messaging(app) {
         if (!validator.isNonNullObject(app) || !('options' in app)) {
@@ -182,7 +171,7 @@ var Messaging = /** @class */ (function () {
     }
     Object.defineProperty(Messaging.prototype, "app", {
         /**
-         * The {@link app.App app} associated with the current `Messaging` service
+         * The {@link firebase-admin.app#App} associated with the current `Messaging` service
          * instance.
          *
          * @example
@@ -199,10 +188,10 @@ var Messaging = /** @class */ (function () {
     /**
      * Sends the given message via FCM.
      *
-     * @param message The message payload.
-     * @param dryRun Whether to send the message in the dry-run
+     * @param message - The message payload.
+     * @param dryRun - Whether to send the message in the dry-run
      *   (validation only) mode.
-     * @return A promise fulfilled with a unique message ID
+     * @returns A promise fulfilled with a unique message ID
      *   string after the message has been successfully handed off to the FCM
      *   service for delivery.
      */
@@ -237,11 +226,11 @@ var Messaging = /** @class */ (function () {
      * the list could be sent. Partial failures are indicated by a `BatchResponse`
      * return value.
      *
-     * @param messages A non-empty array
+     * @param messages - A non-empty array
      *   containing up to 500 messages.
-     * @param dryRun Whether to send the messages in the dry-run
+     * @param dryRun - Whether to send the messages in the dry-run
      *   (validation only) mode.
-     * @return A Promise fulfilled with an object representing the result of the
+     * @returns A Promise fulfilled with an object representing the result of the
      *   send operation.
      */
     Messaging.prototype.sendAll = function (messages, dryRun) {
@@ -289,11 +278,11 @@ var Messaging = /** @class */ (function () {
      * not sent to any of the tokens in the list. Partial failures are indicated by
      * a `BatchResponse` return value.
      *
-     * @param message A multicast message
+     * @param message - A multicast message
      *   containing up to 500 tokens.
-     * @param dryRun Whether to send the message in the dry-run
+     * @param dryRun - Whether to send the message in the dry-run
      *   (validation only) mode.
-     * @return A Promise fulfilled with an object representing the result of the
+     * @returns A Promise fulfilled with an object representing the result of the
      *   send operation.
      */
     Messaging.prototype.sendMulticast = function (message, dryRun) {
@@ -324,20 +313,20 @@ var Messaging = /** @class */ (function () {
      * Sends an FCM message to a single device corresponding to the provided
      * registration token.
      *
-     * See
-     * [Send to individual devices](/docs/cloud-messaging/admin/legacy-fcm#send_to_individual_devices)
+     * See {@link https://firebase.google.com/docs/cloud-messaging/admin/legacy-fcm#send_to_individual_devices |
+     * Send to individual devices}
      * for code samples and detailed documentation. Takes either a
      * `registrationToken` to send to a single device or a
      * `registrationTokens` parameter containing an array of tokens to send
      * to multiple devices.
      *
-     * @param registrationToken A device registration token or an array of
+     * @param registrationToken - A device registration token or an array of
      *   device registration tokens to which the message should be sent.
-     * @param payload The message payload.
-     * @param options Optional options to
+     * @param payload - The message payload.
+     * @param options - Optional options to
      *   alter the message.
      *
-     * @return A promise fulfilled with the server's response after the message
+     * @returns A promise fulfilled with the server's response after the message
      *   has been sent.
      */
     Messaging.prototype.sendToDevice = function (registrationTokenOrTokens, payload, options) {
@@ -383,17 +372,16 @@ var Messaging = /** @class */ (function () {
      * Sends an FCM message to a device group corresponding to the provided
      * notification key.
      *
-     * See
-     * [Send to a device group](/docs/cloud-messaging/admin/legacy-fcm#send_to_a_device_group)
-     * for code samples and detailed documentation.
+     * See {@link https://firebase.google.com/docs/cloud-messaging/admin/legacy-fcm#send_to_a_device_group |
+     * Send to a device group} for code samples and detailed documentation.
      *
-     * @param notificationKey The notification key for the device group to
+     * @param notificationKey - The notification key for the device group to
      *   which to send the message.
-     * @param payload The message payload.
-     * @param options Optional options to
+     * @param payload - The message payload.
+     * @param options - Optional options to
      *   alter the message.
      *
-     * @return A promise fulfilled with the server's response after the message
+     * @returns A promise fulfilled with the server's response after the message
      *   has been sent.
      */
     Messaging.prototype.sendToDeviceGroup = function (notificationKey, payload, options) {
@@ -449,16 +437,15 @@ var Messaging = /** @class */ (function () {
     /**
      * Sends an FCM message to a topic.
      *
-     * See
-     * [Send to a topic](/docs/cloud-messaging/admin/legacy-fcm#send_to_a_topic)
-     * for code samples and detailed documentation.
+     * See {@link https://firebase.google.com/docs/cloud-messaging/admin/legacy-fcm#send_to_a_topic |
+     * Send to a topic} for code samples and detailed documentation.
      *
-     * @param topic The topic to which to send the message.
-     * @param payload The message payload.
-     * @param options Optional options to
+     * @param topic - The topic to which to send the message.
+     * @param payload - The message payload.
+     * @param options - Optional options to
      *   alter the message.
      *
-     * @return A promise fulfilled with the server's response after the message
+     * @returns A promise fulfilled with the server's response after the message
      *   has been sent.
      */
     Messaging.prototype.sendToTopic = function (topic, payload, options) {
@@ -491,17 +478,17 @@ var Messaging = /** @class */ (function () {
     /**
      * Sends an FCM message to a condition.
      *
-     * See
-     * [Send to a condition](/docs/cloud-messaging/admin/legacy-fcm#send_to_a_condition)
+     * See {@link https://firebase.google.com/docs/cloud-messaging/admin/legacy-fcm#send_to_a_condition |
+     * Send to a condition}
      * for code samples and detailed documentation.
      *
-     * @param condition The condition determining to which topics to send
+     * @param condition - The condition determining to which topics to send
      *   the message.
-     * @param payload The message payload.
-     * @param options Optional options to
+     * @param payload - The message payload.
+     * @param options - Optional options to
      *   alter the message.
      *
-     * @return A promise fulfilled with the server's response after the message
+     * @returns A promise fulfilled with the server's response after the message
      *   has been sent.
      */
     Messaging.prototype.sendToCondition = function (condition, payload, options) {
@@ -538,16 +525,16 @@ var Messaging = /** @class */ (function () {
     /**
      * Subscribes a device to an FCM topic.
      *
-     * See [Subscribe to a
-     * topic](/docs/cloud-messaging/manage-topics#suscribe_and_unsubscribe_using_the)
+     * See {@link https://firebase.google.com/docs/cloud-messaging/manage-topics#suscribe_and_unsubscribe_using_the |
+     * Subscribe to a topic}
      * for code samples and detailed documentation. Optionally, you can provide an
      * array of tokens to subscribe multiple devices.
      *
-     * @param registrationTokens A token or array of registration tokens
+     * @param registrationTokens - A token or array of registration tokens
      *   for the devices to subscribe to the topic.
-     * @param topic The topic to which to subscribe.
+     * @param topic - The topic to which to subscribe.
      *
-     * @return A promise fulfilled with the server's response after the device has been
+     * @returns A promise fulfilled with the server's response after the device has been
      *   subscribed to the topic.
      */
     Messaging.prototype.subscribeToTopic = function (registrationTokenOrTokens, topic) {
@@ -556,16 +543,16 @@ var Messaging = /** @class */ (function () {
     /**
      * Unsubscribes a device from an FCM topic.
      *
-     * See [Unsubscribe from a
-     * topic](/docs/cloud-messaging/admin/manage-topic-subscriptions#unsubscribe_from_a_topic)
+     * See {@link https://firebase.google.com/docs/cloud-messaging/admin/manage-topic-subscriptions#unsubscribe_from_a_topic |
+     * Unsubscribe from a topic}
      * for code samples and detailed documentation.  Optionally, you can provide an
      * array of tokens to unsubscribe multiple devices.
      *
-     * @param registrationTokens A device registration token or an array of
+     * @param registrationTokens - A device registration token or an array of
      *   device registration tokens to unsubscribe from the topic.
-     * @param topic The topic from which to unsubscribe.
+     * @param topic - The topic from which to unsubscribe.
      *
-     * @return A promise fulfilled with the server's response after the device has been
+     * @returns A promise fulfilled with the server's response after the device has been
      *   unsubscribed from the topic.
      */
     Messaging.prototype.unsubscribeFromTopic = function (registrationTokenOrTokens, topic) {
@@ -591,13 +578,13 @@ var Messaging = /** @class */ (function () {
     /**
      * Helper method which sends and handles topic subscription management requests.
      *
-     * @param {string|string[]} registrationTokenOrTokens The registration token or an array of
+     * @param registrationTokenOrTokens - The registration token or an array of
      *     registration tokens to unsubscribe from the topic.
-     * @param {string} topic The topic to which to subscribe.
-     * @param {string} methodName The name of the original method called.
-     * @param {string} path The endpoint path to use for the request.
+     * @param topic - The topic to which to subscribe.
+     * @param methodName - The name of the original method called.
+     * @param path - The endpoint path to use for the request.
      *
-     * @return {Promise<MessagingTopicManagementResponse>} A Promise fulfilled with the parsed server
+     * @returns A Promise fulfilled with the parsed server
      *   response.
      */
     Messaging.prototype.sendTopicManagementRequest = function (registrationTokenOrTokens, topic, methodName, path) {
@@ -630,8 +617,8 @@ var Messaging = /** @class */ (function () {
     /**
      * Validates the types of the messaging payload and options. If invalid, an error will be thrown.
      *
-     * @param {MessagingPayload} payload The messaging payload to validate.
-     * @param {MessagingOptions} options The messaging options to validate.
+     * @param payload - The messaging payload to validate.
+     * @param options - The messaging options to validate.
      */
     Messaging.prototype.validateMessagingPayloadAndOptionsTypes = function (payload, options) {
         // Validate the payload is an object
@@ -646,9 +633,9 @@ var Messaging = /** @class */ (function () {
     /**
      * Validates the messaging payload. If invalid, an error will be thrown.
      *
-     * @param {MessagingPayload} payload The messaging payload to validate.
+     * @param payload - The messaging payload to validate.
      *
-     * @return {MessagingPayload} A copy of the provided payload with whitelisted properties switched
+     * @returns A copy of the provided payload with whitelisted properties switched
      *     from camelCase to underscore_case.
      */
     Messaging.prototype.validateMessagingPayload = function (payload) {
@@ -711,9 +698,9 @@ var Messaging = /** @class */ (function () {
     /**
      * Validates the messaging options. If invalid, an error will be thrown.
      *
-     * @param {MessagingOptions} options The messaging options to validate.
+     * @param options - The messaging options to validate.
      *
-     * @return {MessagingOptions} A copy of the provided options with whitelisted properties switched
+     * @returns A copy of the provided options with whitelisted properties switched
      *   from camelCase to underscore_case.
      */
     Messaging.prototype.validateMessagingOptions = function (options) {
@@ -767,9 +754,9 @@ var Messaging = /** @class */ (function () {
     /**
      * Validates the type of the provided registration token(s). If invalid, an error will be thrown.
      *
-     * @param {string|string[]} registrationTokenOrTokens The registration token(s) to validate.
-     * @param {string} method The method name to use in error messages.
-     * @param {ErrorInfo?} [errorInfo] The error info to use if the registration tokens are invalid.
+     * @param registrationTokenOrTokens - The registration token(s) to validate.
+     * @param method - The method name to use in error messages.
+     * @param errorInfo - The error info to use if the registration tokens are invalid.
      */
     Messaging.prototype.validateRegistrationTokensType = function (registrationTokenOrTokens, methodName, errorInfo) {
         if (errorInfo === void 0) { errorInfo = error_1.MessagingClientErrorCode.INVALID_ARGUMENT; }
@@ -782,10 +769,10 @@ var Messaging = /** @class */ (function () {
     /**
      * Validates the provided registration tokens. If invalid, an error will be thrown.
      *
-     * @param {string|string[]} registrationTokenOrTokens The registration token or an array of
+     * @param registrationTokenOrTokens - The registration token or an array of
      *     registration tokens to validate.
-     * @param {string} method The method name to use in error messages.
-     * @param {errorInfo?} [ErrorInfo] The error info to use if the registration tokens are invalid.
+     * @param method - The method name to use in error messages.
+     * @param errorInfo - The error info to use if the registration tokens are invalid.
      */
     Messaging.prototype.validateRegistrationTokens = function (registrationTokenOrTokens, methodName, errorInfo) {
         if (errorInfo === void 0) { errorInfo = error_1.MessagingClientErrorCode.INVALID_ARGUMENT; }
@@ -807,9 +794,9 @@ var Messaging = /** @class */ (function () {
     /**
      * Validates the type of the provided topic. If invalid, an error will be thrown.
      *
-     * @param {string} topic The topic to validate.
-     * @param {string} method The method name to use in error messages.
-     * @param {ErrorInfo?} [errorInfo] The error info to use if the topic is invalid.
+     * @param topic - The topic to validate.
+     * @param method - The method name to use in error messages.
+     * @param errorInfo - The error info to use if the topic is invalid.
      */
     Messaging.prototype.validateTopicType = function (topic, methodName, errorInfo) {
         if (errorInfo === void 0) { errorInfo = error_1.MessagingClientErrorCode.INVALID_ARGUMENT; }
@@ -821,9 +808,9 @@ var Messaging = /** @class */ (function () {
     /**
      * Validates the provided topic. If invalid, an error will be thrown.
      *
-     * @param {string} topic The topic to validate.
-     * @param {string} method The method name to use in error messages.
-     * @param {ErrorInfo?} [errorInfo] The error info to use if the topic is invalid.
+     * @param topic - The topic to validate.
+     * @param method - The method name to use in error messages.
+     * @param errorInfo - The error info to use if the topic is invalid.
      */
     Messaging.prototype.validateTopic = function (topic, methodName, errorInfo) {
         if (errorInfo === void 0) { errorInfo = error_1.MessagingClientErrorCode.INVALID_ARGUMENT; }
@@ -835,9 +822,9 @@ var Messaging = /** @class */ (function () {
     /**
      * Normalizes the provided topic name by prepending it with '/topics/', if necessary.
      *
-     * @param {string} topic The topic name to normalize.
+     * @param topic - The topic name to normalize.
      *
-     * @return {string} The normalized topic name.
+     * @returns The normalized topic name.
      */
     Messaging.prototype.normalizeTopic = function (topic) {
         if (!/^\/topics\//.test(topic)) {

package/lib/project-management/android-app.d.ts

@@ -1,4 +1,4 @@
-/*! firebase-admin v9.100.0-alpha.0 */
+/*! firebase-admin v10.0.2 */
 /*!
  * Copyright 2018 Google Inc.
  *
@@ -34,8 +34,7 @@ export interface AndroidAppMetadata extends AppMetadata {
 /**
  * A reference to a Firebase Android app.
  *
- * Do not call this constructor directly. Instead, use
- * [`projectManagement.androidApp()`](projectManagement.ProjectManagement#androidApp).
+ * Do not call this constructor directly. Instead, use {@link ProjectManagement.androidApp}.
  */
 export declare class AndroidApp {
     readonly appId: string;
@@ -44,46 +43,46 @@ export declare class AndroidApp {
     /**
      * Retrieves metadata about this Android app.
      *
-     * @return A promise that resolves to the retrieved metadata about this Android app.
+     * @returns A promise that resolves to the retrieved metadata about this Android app.
      */
     getMetadata(): Promise<AndroidAppMetadata>;
     /**
      * Sets the optional user-assigned display name of the app.
      *
-     * @param newDisplayName The new display name to set.
+     * @param newDisplayName - The new display name to set.
      *
-     * @return A promise that resolves when the display name has been set.
+     * @returns A promise that resolves when the display name has been set.
      */
     setDisplayName(newDisplayName: string): Promise<void>;
     /**
      * Gets the list of SHA certificates associated with this Android app in Firebase.
      *
-     * @return The list of SHA-1 and SHA-256 certificates associated with this Android app in
+     * @returns The list of SHA-1 and SHA-256 certificates associated with this Android app in
      *     Firebase.
      */
     getShaCertificates(): Promise<ShaCertificate[]>;
     /**
      * Adds the given SHA certificate to this Android app.
      *
-     * @param certificateToAdd The SHA certificate to add.
+     * @param certificateToAdd - The SHA certificate to add.
      *
-     * @return A promise that resolves when the given certificate
+     * @returns A promise that resolves when the given certificate
      *     has been added to the Android app.
      */
     addShaCertificate(certificateToAdd: ShaCertificate): Promise<void>;
     /**
      * Deletes the specified SHA certificate from this Android app.
      *
-     * @param  certificateToDelete The SHA certificate to delete.
+     * @param certificateToDelete - The SHA certificate to delete.
      *
-     * @return A promise that resolves when the specified
+     * @returns A promise that resolves when the specified
      *     certificate has been removed from the Android app.
      */
     deleteShaCertificate(certificateToDelete: ShaCertificate): Promise<void>;
     /**
      * Gets the configuration artifact associated with this app.
      *
-     * @return A promise that resolves to the Android app's
+     * @returns A promise that resolves to the Android app's
      *     Firebase config file, in UTF-8 string format. This string is typically
      *     intended to be written to a JSON file that gets shipped with your Android
      *     app.

package/lib/project-management/android-app.js

@@ -1,4 +1,4 @@
-/*! firebase-admin v9.100.0-alpha.0 */
+/*! firebase-admin v10.0.2 */
 "use strict";
 /*!
  * Copyright 2018 Google Inc.
@@ -24,8 +24,7 @@ var app_metadata_1 = require("./app-metadata");
 /**
  * A reference to a Firebase Android app.
  *
- * Do not call this constructor directly. Instead, use
- * [`projectManagement.androidApp()`](projectManagement.ProjectManagement#androidApp).
+ * Do not call this constructor directly. Instead, use {@link ProjectManagement.androidApp}.
  */
 var AndroidApp = /** @class */ (function () {
     /**
@@ -42,7 +41,7 @@ var AndroidApp = /** @class */ (function () {
     /**
      * Retrieves metadata about this Android app.
      *
-     * @return A promise that resolves to the retrieved metadata about this Android app.
+     * @returns A promise that resolves to the retrieved metadata about this Android app.
      */
     AndroidApp.prototype.getMetadata = function () {
         return this.requestHandler.getResource(this.resourceName)
@@ -66,9 +65,9 @@ var AndroidApp = /** @class */ (function () {
     /**
      * Sets the optional user-assigned display name of the app.
      *
-     * @param newDisplayName The new display name to set.
+     * @param newDisplayName - The new display name to set.
      *
-     * @return A promise that resolves when the display name has been set.
+     * @returns A promise that resolves when the display name has been set.
      */
     AndroidApp.prototype.setDisplayName = function (newDisplayName) {
         return this.requestHandler.setDisplayName(this.resourceName, newDisplayName);
@@ -76,7 +75,7 @@ var AndroidApp = /** @class */ (function () {
     /**
      * Gets the list of SHA certificates associated with this Android app in Firebase.
      *
-     * @return The list of SHA-1 and SHA-256 certificates associated with this Android app in
+     * @returns The list of SHA-1 and SHA-256 certificates associated with this Android app in
      *     Firebase.
      */
     AndroidApp.prototype.getShaCertificates = function () {
@@ -100,9 +99,9 @@ var AndroidApp = /** @class */ (function () {
     /**
      * Adds the given SHA certificate to this Android app.
      *
-     * @param certificateToAdd The SHA certificate to add.
+     * @param certificateToAdd - The SHA certificate to add.
      *
-     * @return A promise that resolves when the given certificate
+     * @returns A promise that resolves when the given certificate
      *     has been added to the Android app.
      */
     AndroidApp.prototype.addShaCertificate = function (certificateToAdd) {
@@ -111,9 +110,9 @@ var AndroidApp = /** @class */ (function () {
     /**
      * Deletes the specified SHA certificate from this Android app.
      *
-     * @param  certificateToDelete The SHA certificate to delete.
+     * @param certificateToDelete - The SHA certificate to delete.
      *
-     * @return A promise that resolves when the specified
+     * @returns A promise that resolves when the specified
      *     certificate has been removed from the Android app.
      */
     AndroidApp.prototype.deleteShaCertificate = function (certificateToDelete) {
@@ -126,7 +125,7 @@ var AndroidApp = /** @class */ (function () {
     /**
      * Gets the configuration artifact associated with this app.
      *
-     * @return A promise that resolves to the Android app's
+     * @returns A promise that resolves to the Android app's
      *     Firebase config file, in UTF-8 string format. This string is typically
      *     intended to be written to a JSON file that gets shipped with your Android
      *     app.
@@ -154,12 +153,12 @@ var ShaCertificate = /** @class */ (function () {
      * Creates a ShaCertificate using the given hash. The ShaCertificate's type (eg. 'sha256') is
      * automatically determined from the hash itself.
      *
-     * @param shaHash The sha256 or sha1 hash for this certificate.
+     * @param shaHash - The sha256 or sha1 hash for this certificate.
      * @example
      * ```javascript
      * var shaHash = shaCertificate.shaHash;
      * ```
-     * @param resourceName The Firebase resource name for this certificate. This does not need to be
+     * @param resourceName - The Firebase resource name for this certificate. This does not need to be
      *     set when creating a new certificate.
      * @example
      * ```javascript

package/lib/project-management/app-metadata.d.ts

@@ -1,4 +1,4 @@
-/*! firebase-admin v9.100.0-alpha.0 */
+/*! firebase-admin v10.0.2 */
 /*!
  * Copyright 2021 Google Inc.
  *

package/lib/project-management/app-metadata.js

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

package/lib/project-management/index.d.ts

@@ -1,4 +1,4 @@
-/*! firebase-admin v9.100.0-alpha.0 */
+/*! firebase-admin v10.0.2 */
 /*!
  * Copyright 2020 Google Inc.
  *
@@ -14,6 +14,11 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
+/**
+ * Firebase project management.
+ *
+ * @packageDocumentation
+ */
 import { App } from '../app';
 import { ProjectManagement } from './project-management';
 export { AppMetadata, AppPlatform } from './app-metadata';
@@ -21,14 +26,11 @@ export { ProjectManagement } from './project-management';
 export { AndroidApp, AndroidAppMetadata, ShaCertificate } from './android-app';
 export { IosApp, IosAppMetadata } from './ios-app';
 /**
- * Gets the {@link projectManagement.ProjectManagement
- * `ProjectManagement`} service for the default app or a given app.
+ * Gets the {@link ProjectManagement} service for the default app or a given app.
  *
  * `getProjectManagement()` can be called with no arguments to access the
- * default app's {@link projectManagement.ProjectManagement
- * `ProjectManagement`} service, or as `getProjectManagement(app)` to access
- * the {@link projectManagement.ProjectManagement `ProjectManagement`}
- * service associated with a specific app.
+ * default app's `ProjectManagement` service, or as `getProjectManagement(app)` to access
+ * the `ProjectManagement` service associated with a specific app.
  *
  * @example
  * ```javascript
@@ -42,10 +44,10 @@ export { IosApp, IosAppMetadata } from './ios-app';
  * const otherProjectManagement = getProjectManagement(otherApp);
  * ```
  *
- * @param app Optional app whose `ProjectManagement` service
+ * @param app - Optional app whose `ProjectManagement` service
  *     to return. If not provided, the default `ProjectManagement` service will
  *     be returned. *
- * @return The default `ProjectManagement` service if no app is provided or the
+ * @returns The default `ProjectManagement` service if no app is provided or the
  *   `ProjectManagement` service associated with the provided app.
  */
 export declare function getProjectManagement(app?: App): ProjectManagement;

package/lib/project-management/index.js

@@ -1,4 +1,4 @@
-/*! firebase-admin v9.100.0-alpha.0 */
+/*! firebase-admin v10.0.2 */
 "use strict";
 /*!
  * Copyright 2020 Google Inc.
@@ -17,6 +17,11 @@
  */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getProjectManagement = void 0;
+/**
+ * Firebase project management.
+ *
+ * @packageDocumentation
+ */
 var app_1 = require("../app");
 var project_management_1 = require("./project-management");
 var app_metadata_1 = require("./app-metadata");
@@ -29,14 +34,11 @@ Object.defineProperty(exports, "ShaCertificate", { enumerable: true, get: functi
 var ios_app_1 = require("./ios-app");
 Object.defineProperty(exports, "IosApp", { enumerable: true, get: function () { return ios_app_1.IosApp; } });
 /**
- * Gets the {@link projectManagement.ProjectManagement
- * `ProjectManagement`} service for the default app or a given app.
+ * Gets the {@link ProjectManagement} service for the default app or a given app.
  *
  * `getProjectManagement()` can be called with no arguments to access the
- * default app's {@link projectManagement.ProjectManagement
- * `ProjectManagement`} service, or as `getProjectManagement(app)` to access
- * the {@link projectManagement.ProjectManagement `ProjectManagement`}
- * service associated with a specific app.
+ * default app's `ProjectManagement` service, or as `getProjectManagement(app)` to access
+ * the `ProjectManagement` service associated with a specific app.
  *
  * @example
  * ```javascript
@@ -50,10 +52,10 @@ Object.defineProperty(exports, "IosApp", { enumerable: true, get: function () {
  * const otherProjectManagement = getProjectManagement(otherApp);
  * ```
  *
- * @param app Optional app whose `ProjectManagement` service
+ * @param app - Optional app whose `ProjectManagement` service
  *     to return. If not provided, the default `ProjectManagement` service will
  *     be returned. *
- * @return The default `ProjectManagement` service if no app is provided or the
+ * @returns The default `ProjectManagement` service if no app is provided or the
  *   `ProjectManagement` service associated with the provided app.
  */
 function getProjectManagement(app) {