firebase-admin 9.100.0-alpha.0 → 10.0.2

package/lib/machine-learning/machine-learning.d.ts

@@ -1,4 +1,4 @@
-/*! firebase-admin v9.100.0-alpha.0 */
+/*! firebase-admin v10.0.2 */
 /*!
  * Copyright 2020 Google Inc.
  *
@@ -50,25 +50,25 @@ export declare class MachineLearning {
     private readonly client;
     private readonly appInternal;
     /**
-     *  The {@link app.App} associated with the current `MachineLearning`
+     *  The {@link firebase-admin.app#App} associated with the current `MachineLearning`
      *  service instance.
      */
     get app(): App;
     /**
      * Creates a model in the current Firebase project.
      *
-     * @param model The model to create.
+     * @param model - The model to create.
      *
-     * @return A Promise fulfilled with the created model.
+     * @returns A Promise fulfilled with the created model.
      */
     createModel(model: ModelOptions): Promise<Model>;
     /**
      * Updates a model's metadata or model file.
      *
-     * @param modelId The ID of the model to update.
-     * @param model The model fields to update.
+     * @param modelId - The ID of the model to update.
+     * @param model - The model fields to update.
      *
-     * @return A Promise fulfilled with the updated model.
+     * @returns A Promise fulfilled with the updated model.
      */
     updateModel(modelId: string, model: ModelOptions): Promise<Model>;
     /**
@@ -76,33 +76,33 @@ export declare class MachineLearning {
      *
      * A published model can be downloaded to client apps.
      *
-     * @param modelId The ID of the model to publish.
+     * @param modelId - The ID of the model to publish.
      *
-     * @return A Promise fulfilled with the published model.
+     * @returns A Promise fulfilled with the published model.
      */
     publishModel(modelId: string): Promise<Model>;
     /**
      * Unpublishes a Firebase ML model.
      *
-     * @param modelId The ID of the model to unpublish.
+     * @param modelId - The ID of the model to unpublish.
      *
-     * @return A Promise fulfilled with the unpublished model.
+     * @returns A Promise fulfilled with the unpublished model.
      */
     unpublishModel(modelId: string): Promise<Model>;
     /**
      * Gets the model specified by the given ID.
      *
-     * @param modelId The ID of the model to get.
+     * @param modelId - The ID of the model to get.
      *
-     * @return A Promise fulfilled with the model object.
+     * @returns A Promise fulfilled with the model object.
      */
     getModel(modelId: string): Promise<Model>;
     /**
      * Lists the current project's models.
      *
-     * @param options The listing options.
+     * @param options - The listing options.
      *
-     * @return A promise that
+     * @returns A promise that
      *     resolves with the current (filtered) list of models and the next page
      *     token. For the last page, an empty list of models and no page token
      *     are returned.
@@ -111,7 +111,7 @@ export declare class MachineLearning {
     /**
      * Deletes a model from the current project.
      *
-     * @param modelId The ID of the model to delete.
+     * @param modelId - The ID of the model to delete.
      */
     deleteModel(modelId: string): Promise<void>;
     private setPublishStatus;
@@ -158,7 +158,7 @@ export declare class Model {
     get tfliteModel(): TFLiteModel | undefined;
     /**
      * True if the model is locked by a server-side operation. You can't make
-     * changes to a locked model. See {@link waitForUnlocked `waitForUnlocked()`}.
+     * changes to a locked model. See {@link Model.waitForUnlocked}.
      */
     get locked(): boolean;
     /**
@@ -170,10 +170,10 @@ export declare class Model {
     /**
      * Wait for the model to be unlocked.
      *
-     * @param maxTimeMillis The maximum time in milliseconds to wait.
+     * @param maxTimeMillis - The maximum time in milliseconds to wait.
      *     If not specified, a default maximum of 2 minutes is used.
      *
-     * @return A promise that resolves when the model is unlocked
+     * @returns A promise that resolves when the model is unlocked
      *   or the maximum wait time has passed.
      */
     waitForUnlocked(maxTimeMillis?: number): Promise<void>;

package/lib/machine-learning/machine-learning.js

@@ -1,4 +1,4 @@
-/*! firebase-admin v9.100.0-alpha.0 */
+/*! firebase-admin v10.0.2 */
 "use strict";
 /*!
  * Copyright 2020 Google Inc.
@@ -29,7 +29,7 @@ var machine_learning_utils_1 = require("./machine-learning-utils");
  */
 var MachineLearning = /** @class */ (function () {
     /**
-     * @param app The app for this ML service.
+     * @param app - The app for this ML service.
      * @constructor
      * @internal
      */
@@ -46,7 +46,7 @@ var MachineLearning = /** @class */ (function () {
     }
     Object.defineProperty(MachineLearning.prototype, "app", {
         /**
-         *  The {@link app.App} associated with the current `MachineLearning`
+         *  The {@link firebase-admin.app#App} associated with the current `MachineLearning`
          *  service instance.
          */
         get: function () {
@@ -58,9 +58,9 @@ var MachineLearning = /** @class */ (function () {
     /**
      * Creates a model in the current Firebase project.
      *
-     * @param model The model to create.
+     * @param model - The model to create.
      *
-     * @return A Promise fulfilled with the created model.
+     * @returns A Promise fulfilled with the created model.
      */
     MachineLearning.prototype.createModel = function (model) {
         var _this = this;
@@ -72,10 +72,10 @@ var MachineLearning = /** @class */ (function () {
     /**
      * Updates a model's metadata or model file.
      *
-     * @param modelId The ID of the model to update.
-     * @param model The model fields to update.
+     * @param modelId - The ID of the model to update.
+     * @param model - The model fields to update.
      *
-     * @return A Promise fulfilled with the updated model.
+     * @returns A Promise fulfilled with the updated model.
      */
     MachineLearning.prototype.updateModel = function (modelId, model) {
         var _this = this;
@@ -90,9 +90,9 @@ var MachineLearning = /** @class */ (function () {
      *
      * A published model can be downloaded to client apps.
      *
-     * @param modelId The ID of the model to publish.
+     * @param modelId - The ID of the model to publish.
      *
-     * @return A Promise fulfilled with the published model.
+     * @returns A Promise fulfilled with the published model.
      */
     MachineLearning.prototype.publishModel = function (modelId) {
         return this.setPublishStatus(modelId, true);
@@ -100,9 +100,9 @@ var MachineLearning = /** @class */ (function () {
     /**
      * Unpublishes a Firebase ML model.
      *
-     * @param modelId The ID of the model to unpublish.
+     * @param modelId - The ID of the model to unpublish.
      *
-     * @return A Promise fulfilled with the unpublished model.
+     * @returns A Promise fulfilled with the unpublished model.
      */
     MachineLearning.prototype.unpublishModel = function (modelId) {
         return this.setPublishStatus(modelId, false);
@@ -110,9 +110,9 @@ var MachineLearning = /** @class */ (function () {
     /**
      * Gets the model specified by the given ID.
      *
-     * @param modelId The ID of the model to get.
+     * @param modelId - The ID of the model to get.
      *
-     * @return A Promise fulfilled with the model object.
+     * @returns A Promise fulfilled with the model object.
      */
     MachineLearning.prototype.getModel = function (modelId) {
         var _this = this;
@@ -122,9 +122,9 @@ var MachineLearning = /** @class */ (function () {
     /**
      * Lists the current project's models.
      *
-     * @param options The listing options.
+     * @param options - The listing options.
      *
-     * @return A promise that
+     * @returns A promise that
      *     resolves with the current (filtered) list of models and the next page
      *     token. For the last page, an empty list of models and no page token
      *     are returned.
@@ -151,7 +151,7 @@ var MachineLearning = /** @class */ (function () {
     /**
      * Deletes a model from the current project.
      *
-     * @param modelId The ID of the model to delete.
+     * @param modelId - The ID of the model to delete.
      */
     MachineLearning.prototype.deleteModel = function (modelId) {
         return this.client.deleteModel(modelId);
@@ -307,7 +307,7 @@ var Model = /** @class */ (function () {
     Object.defineProperty(Model.prototype, "locked", {
         /**
          * True if the model is locked by a server-side operation. You can't make
-         * changes to a locked model. See {@link waitForUnlocked `waitForUnlocked()`}.
+         * changes to a locked model. See {@link Model.waitForUnlocked}.
          */
         get: function () {
             var _a, _b;
@@ -347,10 +347,10 @@ var Model = /** @class */ (function () {
     /**
      * Wait for the model to be unlocked.
      *
-     * @param maxTimeMillis The maximum time in milliseconds to wait.
+     * @param maxTimeMillis - The maximum time in milliseconds to wait.
      *     If not specified, a default maximum of 2 minutes is used.
      *
-     * @return A promise that resolves when the model is unlocked
+     * @returns A promise that resolves when the model is unlocked
      *   or the maximum wait time has passed.
      */
     Model.prototype.waitForUnlocked = function (maxTimeMillis) {

package/lib/messaging/batch-request-internal.d.ts

@@ -1,4 +1,4 @@
-/*! firebase-admin v9.100.0-alpha.0 */
+/*! firebase-admin v10.0.2 */
 /*!
  * Copyright 2019 Google Inc.
  *
@@ -47,8 +47,8 @@ export declare class BatchRequestClient {
      * Sends the given array of sub requests as a single batch, and parses the results into an array
      * of HttpResponse objects.
      *
-     * @param {SubRequest[]} requests An array of sub requests to send.
-     * @return {Promise<HttpResponse[]>} A promise that resolves when the send operation is complete.
+     * @param requests - An array of sub requests to send.
+     * @returns A promise that resolves when the send operation is complete.
      */
     send(requests: SubRequest[]): Promise<HttpResponse[]>;
     private getMultipartPayload;

package/lib/messaging/batch-request-internal.js

@@ -1,4 +1,4 @@
-/*! firebase-admin v9.100.0-alpha.0 */
+/*! firebase-admin v10.0.2 */
 "use strict";
 /*!
  * Copyright 2019 Google Inc.
@@ -44,8 +44,8 @@ var BatchRequestClient = /** @class */ (function () {
      * Sends the given array of sub requests as a single batch, and parses the results into an array
      * of HttpResponse objects.
      *
-     * @param {SubRequest[]} requests An array of sub requests to send.
-     * @return {Promise<HttpResponse[]>} A promise that resolves when the send operation is complete.
+     * @param requests - An array of sub requests to send.
+     * @returns A promise that resolves when the send operation is complete.
      */
     BatchRequestClient.prototype.send = function (requests) {
         var _this = this;
@@ -89,10 +89,10 @@ exports.BatchRequestClient = BatchRequestClient;
  * API, sets the content-type header to application/http, and the content-transfer-encoding to
  * binary.
  *
- * @param {SubRequest} request A sub request that will be used to populate the part.
- * @param {string} boundary Multipart boundary string.
- * @param {number} idx An index number that is used to set the content-id header.
- * @return {string} The part as a string that can be included in the HTTP body.
+ * @param request - A sub request that will be used to populate the part.
+ * @param boundary - Multipart boundary string.
+ * @param idx - An index number that is used to set the content-id header.
+ * @returns The part as a string that can be included in the HTTP body.
  */
 function createPart(request, boundary, idx) {
     var serializedRequest = serializeSubRequest(request);
@@ -110,8 +110,8 @@ function createPart(request, boundary, idx) {
  * format of the string is the wire format of a typical HTTP request, consisting of a header and a
  * body.
  *
- * @param request {SubRequest} The sub request to be serialized.
- * @return {string} String representation of the SubRequest.
+ * @param request - The sub request to be serialized.
+ * @returns String representation of the SubRequest.
  */
 function serializeSubRequest(request) {
     var requestBody = JSON.stringify(request.body);

package/lib/messaging/index.d.ts

@@ -1,4 +1,4 @@
-/*! firebase-admin v9.100.0-alpha.0 */
+/*! firebase-admin v10.0.2 */
 /*!
  * Copyright 2020 Google Inc.
  *
@@ -14,19 +14,21 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
+/**
+ * Firebase Cloud Messaging (FCM).
+ *
+ * @packageDocumentation
+ */
 import { App } from '../app';
 import { Messaging } from './messaging';
 export { Messaging, } from './messaging';
 export { AndroidConfig, AndroidFcmOptions, AndroidNotification, ApnsConfig, ApnsFcmOptions, ApnsPayload, Aps, ApsAlert, BaseMessage, BatchResponse, CriticalSound, ConditionMessage, FcmOptions, LightSettings, Message, MessagingTopicManagementResponse, MulticastMessage, Notification, SendResponse, TokenMessage, TopicMessage, WebpushConfig, WebpushFcmOptions, WebpushNotification, DataMessagePayload, MessagingConditionResponse, MessagingDeviceGroupResponse, MessagingDeviceResult, MessagingDevicesResponse, MessagingOptions, MessagingPayload, MessagingTopicResponse, NotificationMessagePayload, } from './messaging-api';
 /**
- * Gets the {@link messaging.Messaging `Messaging`} service for the
- * default app or a given app.
+ * Gets the {@link Messaging} service for the default app or a given app.
  *
  * `admin.messaging()` can be called with no arguments to access the default
- * app's {@link messaging.Messaging `Messaging`} service or as
- * `admin.messaging(app)` to access the
- * {@link messaging.Messaging `Messaging`} service associated with a
- * specific app.
+ * app's `Messaging` service or as `admin.messaging(app)` to access the
+ * `Messaging` service associated with aspecific app.
  *
  * @example
  * ```javascript
@@ -40,10 +42,10 @@ export { AndroidConfig, AndroidFcmOptions, AndroidNotification, ApnsConfig, Apns
  * const otherMessaging = getMessaging(otherApp);
  * ```
  *
- * @param app Optional app whose `Messaging` service to
+ * @param app - Optional app whose `Messaging` service to
  *   return. If not provided, the default `Messaging` service will be returned.
  *
- * @return The default `Messaging` service if no
+ * @returns The default `Messaging` service if no
  *   app is provided or the `Messaging` service associated with the provided
  *   app.
  */

package/lib/messaging/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,19 +17,21 @@
  */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getMessaging = void 0;
+/**
+ * Firebase Cloud Messaging (FCM).
+ *
+ * @packageDocumentation
+ */
 var app_1 = require("../app");
 var messaging_1 = require("./messaging");
 var messaging_2 = require("./messaging");
 Object.defineProperty(exports, "Messaging", { enumerable: true, get: function () { return messaging_2.Messaging; } });
 /**
- * Gets the {@link messaging.Messaging `Messaging`} service for the
- * default app or a given app.
+ * Gets the {@link Messaging} service for the default app or a given app.
  *
  * `admin.messaging()` can be called with no arguments to access the default
- * app's {@link messaging.Messaging `Messaging`} service or as
- * `admin.messaging(app)` to access the
- * {@link messaging.Messaging `Messaging`} service associated with a
- * specific app.
+ * app's `Messaging` service or as `admin.messaging(app)` to access the
+ * `Messaging` service associated with aspecific app.
  *
  * @example
  * ```javascript
@@ -43,10 +45,10 @@ Object.defineProperty(exports, "Messaging", { enumerable: true, get: function ()
  * const otherMessaging = getMessaging(otherApp);
  * ```
  *
- * @param app Optional app whose `Messaging` service to
+ * @param app - Optional app whose `Messaging` service to
  *   return. If not provided, the default `Messaging` service will be returned.
  *
- * @return The default `Messaging` service if no
+ * @returns The default `Messaging` service if no
  *   app is provided or the `Messaging` service associated with the provided
  *   app.
  */

package/lib/messaging/messaging-api-request-internal.d.ts

@@ -1,4 +1,4 @@
-/*! firebase-admin v9.100.0-alpha.0 */
+/*! firebase-admin v10.0.2 */
 /*!
  * @license
  * Copyright 2017 Google Inc.
@@ -25,25 +25,25 @@ export declare class FirebaseMessagingRequestHandler {
     private readonly httpClient;
     private readonly batchClient;
     /**
-     * @param app The app used to fetch access tokens to sign API requests.
+     * @param app - The app used to fetch access tokens to sign API requests.
      * @constructor
      */
     constructor(app: App);
     /**
      * Invokes the request handler with the provided request data.
      *
-     * @param {string} host The host to which to send the request.
-     * @param {string} path The path to which to send the request.
-     * @param {object} requestData The request data.
-     * @return {Promise<object>} A promise that resolves with the response.
+     * @param host - The host to which to send the request.
+     * @param path - The path to which to send the request.
+     * @param requestData - The request data.
+     * @returns A promise that resolves with the response.
      */
     invokeRequestHandler(host: string, path: string, requestData: object): Promise<object>;
     /**
      * Sends the given array of sub requests as a single batch to FCM, and parses the result into
      * a BatchResponse object.
      *
-     * @param {SubRequest[]} requests An array of sub requests to send.
-     * @return {Promise<BatchResponse>} A promise that resolves when the send operation is complete.
+     * @param requests - An array of sub requests to send.
+     * @returns A promise that resolves when the send operation is complete.
      */
     sendBatchRequest(requests: SubRequest[]): Promise<BatchResponse>;
     private buildSendResponse;

package/lib/messaging/messaging-api-request-internal.js

@@ -1,4 +1,4 @@
-/*! firebase-admin v9.100.0-alpha.0 */
+/*! firebase-admin v10.0.2 */
 "use strict";
 /*!
  * @license
@@ -38,7 +38,7 @@ var LEGACY_FIREBASE_MESSAGING_HEADERS = {
  */
 var FirebaseMessagingRequestHandler = /** @class */ (function () {
     /**
-     * @param app The app used to fetch access tokens to sign API requests.
+     * @param app - The app used to fetch access tokens to sign API requests.
      * @constructor
      */
     function FirebaseMessagingRequestHandler(app) {
@@ -48,10 +48,10 @@ var FirebaseMessagingRequestHandler = /** @class */ (function () {
     /**
      * Invokes the request handler with the provided request data.
      *
-     * @param {string} host The host to which to send the request.
-     * @param {string} path The path to which to send the request.
-     * @param {object} requestData The request data.
-     * @return {Promise<object>} A promise that resolves with the response.
+     * @param host - The host to which to send the request.
+     * @param path - The path to which to send the request.
+     * @param requestData - The request data.
+     * @returns A promise that resolves with the response.
      */
     FirebaseMessagingRequestHandler.prototype.invokeRequestHandler = function (host, path, requestData) {
         var request = {
@@ -86,8 +86,8 @@ var FirebaseMessagingRequestHandler = /** @class */ (function () {
      * Sends the given array of sub requests as a single batch to FCM, and parses the result into
      * a BatchResponse object.
      *
-     * @param {SubRequest[]} requests An array of sub requests to send.
-     * @return {Promise<BatchResponse>} A promise that resolves when the send operation is complete.
+     * @param requests - An array of sub requests to send.
+     * @returns A promise that resolves when the send operation is complete.
      */
     FirebaseMessagingRequestHandler.prototype.sendBatchRequest = function (requests) {
         var _this = this;