firebase-admin 9.100.0-alpha.0 → 10.0.2

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

@@ -1,4 +1,4 @@
-/*! firebase-admin v9.100.0-alpha.0 */
+/*! firebase-admin v10.0.2 */
 /*!
  * Copyright 2021 Google Inc.
  *
@@ -18,14 +18,12 @@ import { App } from '../app';
 import { Messaging as TMessaging } from './messaging';
 import { AndroidConfig as TAndroidConfig, AndroidFcmOptions as TAndroidFcmOptions, AndroidNotification as TAndroidNotification, ApnsConfig as TApnsConfig, ApnsFcmOptions as TApnsFcmOptions, ApnsPayload as TApnsPayload, Aps as TAps, ApsAlert as TApsAlert, BatchResponse as TBatchResponse, CriticalSound as TCriticalSound, ConditionMessage as TConditionMessage, FcmOptions as TFcmOptions, LightSettings as TLightSettings, Message as TMessage, MessagingTopicManagementResponse as TMessagingTopicManagementResponse, MulticastMessage as TMulticastMessage, Notification as TNotification, SendResponse as TSendResponse, TokenMessage as TTokenMessage, TopicMessage as TTopicMessage, WebpushConfig as TWebpushConfig, WebpushFcmOptions as TWebpushFcmOptions, WebpushNotification as TWebpushNotification, DataMessagePayload as TDataMessagePayload, MessagingConditionResponse as TMessagingConditionResponse, MessagingDeviceGroupResponse as TMessagingDeviceGroupResponse, MessagingDeviceResult as TMessagingDeviceResult, MessagingDevicesResponse as TMessagingDevicesResponse, MessagingOptions as TMessagingOptions, MessagingPayload as TMessagingPayload, MessagingTopicResponse as TMessagingTopicResponse, NotificationMessagePayload as TNotificationMessagePayload } from './messaging-api';
 /**
- * Gets the {@link messaging.Messaging `Messaging`} service for the
+ * Gets the {@link firebase-admin.messaging#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 a specific app.
  *
  * @example
  * ```javascript
@@ -39,46 +37,145 @@ import { AndroidConfig as TAndroidConfig, AndroidFcmOptions as TAndroidFcmOption
  * var otherMessaging = admin.messaging(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.
  */
 export declare function messaging(app?: App): messaging.Messaging;
 export declare namespace messaging {
+    /**
+     * Type alias to {@link firebase-admin.messaging#Messaging}.
+     */
     type Messaging = TMessaging;
+    /**
+     * Type alias to {@link firebase-admin.messaging#AndroidConfig}.
+     */
     type AndroidConfig = TAndroidConfig;
+    /**
+     * Type alias to {@link firebase-admin.messaging#AndroidFcmOptions}.
+     */
     type AndroidFcmOptions = TAndroidFcmOptions;
+    /**
+     * Type alias to {@link firebase-admin.messaging#AndroidNotification}.
+     */
     type AndroidNotification = TAndroidNotification;
+    /**
+     * Type alias to {@link firebase-admin.messaging#ApnsConfig}.
+     */
     type ApnsConfig = TApnsConfig;
+    /**
+     * Type alias to {@link firebase-admin.messaging#ApnsFcmOptions}.
+     */
     type ApnsFcmOptions = TApnsFcmOptions;
+    /**
+     * Type alias to {@link firebase-admin.messaging#ApnsPayload}.
+     */
     type ApnsPayload = TApnsPayload;
+    /**
+     * Type alias to {@link firebase-admin.messaging#Aps}.
+     */
     type Aps = TAps;
+    /**
+     * Type alias to {@link firebase-admin.messaging#ApsAlert}.
+     */
     type ApsAlert = TApsAlert;
+    /**
+     * Type alias to {@link firebase-admin.messaging#BatchResponse}.
+     */
     type BatchResponse = TBatchResponse;
+    /**
+     * Type alias to {@link firebase-admin.messaging#CriticalSound}.
+     */
     type CriticalSound = TCriticalSound;
+    /**
+     * Type alias to {@link firebase-admin.messaging#ConditionMessage}.
+     */
     type ConditionMessage = TConditionMessage;
+    /**
+     * Type alias to {@link firebase-admin.messaging#FcmOptions}.
+     */
     type FcmOptions = TFcmOptions;
+    /**
+     * Type alias to {@link firebase-admin.messaging#LightSettings}.
+     */
     type LightSettings = TLightSettings;
+    /**
+     * Type alias to {@link firebase-admin.messaging#Message}.
+     */
     type Message = TMessage;
+    /**
+     * Type alias to {@link firebase-admin.messaging#MessagingTopicManagementResponse}.
+     */
     type MessagingTopicManagementResponse = TMessagingTopicManagementResponse;
+    /**
+     * Type alias to {@link firebase-admin.messaging#MulticastMessage}.
+     */
     type MulticastMessage = TMulticastMessage;
+    /**
+     * Type alias to {@link firebase-admin.messaging#Notification}.
+     */
     type Notification = TNotification;
+    /**
+     * Type alias to {@link firebase-admin.messaging#SendResponse}.
+     */
     type SendResponse = TSendResponse;
+    /**
+     * Type alias to {@link firebase-admin.messaging#TokenMessage}.
+     */
     type TokenMessage = TTokenMessage;
+    /**
+     * Type alias to {@link firebase-admin.messaging#TopicMessage}.
+     */
     type TopicMessage = TTopicMessage;
+    /**
+     * Type alias to {@link firebase-admin.messaging#WebpushConfig}.
+     */
     type WebpushConfig = TWebpushConfig;
+    /**
+     * Type alias to {@link firebase-admin.messaging#WebpushFcmOptions}.
+     */
     type WebpushFcmOptions = TWebpushFcmOptions;
+    /**
+     * Type alias to {@link firebase-admin.messaging#WebpushNotification}.
+     */
     type WebpushNotification = TWebpushNotification;
+    /**
+     * Type alias to {@link firebase-admin.messaging#DataMessagePayload}.
+     */
     type DataMessagePayload = TDataMessagePayload;
+    /**
+     * Type alias to {@link firebase-admin.messaging#MessagingConditionResponse}.
+     */
     type MessagingConditionResponse = TMessagingConditionResponse;
+    /**
+     * Type alias to {@link firebase-admin.messaging#MessagingDeviceGroupResponse}.
+     */
     type MessagingDeviceGroupResponse = TMessagingDeviceGroupResponse;
+    /**
+     * Type alias to {@link firebase-admin.messaging#MessagingDeviceResult}.
+     */
     type MessagingDeviceResult = TMessagingDeviceResult;
+    /**
+     * Type alias to {@link firebase-admin.messaging#MessagingDevicesResponse}.
+     */
     type MessagingDevicesResponse = TMessagingDevicesResponse;
+    /**
+     * Type alias to {@link firebase-admin.messaging#MessagingOptions}.
+     */
     type MessagingOptions = TMessagingOptions;
+    /**
+     * Type alias to {@link firebase-admin.messaging#MessagingPayload}.
+     */
     type MessagingPayload = TMessagingPayload;
+    /**
+     * Type alias to {@link firebase-admin.messaging#MessagingTopicResponse}.
+     */
     type MessagingTopicResponse = TMessagingTopicResponse;
+    /**
+     * Type alias to {@link firebase-admin.messaging#NotificationMessagePayload}.
+     */
     type NotificationMessagePayload = TNotificationMessagePayload;
 }

package/lib/messaging/messaging-namespace.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/messaging/messaging.d.ts

@@ -1,4 +1,4 @@
-/*! firebase-admin v9.100.0-alpha.0 */
+/*! firebase-admin v10.0.2 */
 /*!
  * @license
  * Copyright 2017 Google Inc.
@@ -25,21 +25,7 @@ export declare class Messaging {
     private readonly appInternal;
     private readonly messagingRequestHandler;
     /**
-     * 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.
-     */
-    constructor(app: 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
@@ -51,10 +37,10 @@ export declare class Messaging {
     /**
      * 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.
      */
@@ -71,11 +57,11 @@ export declare class Messaging {
      * 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.
      */
     sendAll(messages: Message[], dryRun?: boolean): Promise<BatchResponse>;
@@ -90,11 +76,11 @@ export declare class Messaging {
      * 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.
      */
     sendMulticast(message: MulticastMessage, dryRun?: boolean): Promise<BatchResponse>;
@@ -102,20 +88,20 @@ export declare class Messaging {
      * 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.
      */
     sendToDevice(registrationTokenOrTokens: string | string[], payload: MessagingPayload, options?: MessagingOptions): Promise<MessagingDevicesResponse>;
@@ -123,82 +109,80 @@ export declare class Messaging {
      * 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.
      */
     sendToDeviceGroup(notificationKey: string, payload: MessagingPayload, options?: MessagingOptions): Promise<MessagingDeviceGroupResponse>;
     /**
      * 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.
      */
     sendToTopic(topic: string, payload: MessagingPayload, options?: MessagingOptions): Promise<MessagingTopicResponse>;
     /**
      * 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.
      */
     sendToCondition(condition: string, payload: MessagingPayload, options?: MessagingOptions): Promise<MessagingConditionResponse>;
     /**
      * 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.
      */
     subscribeToTopic(registrationTokenOrTokens: string | string[], topic: string): Promise<MessagingTopicManagementResponse>;
     /**
      * 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.
      */
     unsubscribeFromTopic(registrationTokenOrTokens: string | string[], topic: string): Promise<MessagingTopicManagementResponse>;
@@ -206,80 +190,80 @@ export declare class Messaging {
     /**
      * 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.
      */
     private sendTopicManagementRequest;
     /**
      * 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.
      */
     private validateMessagingPayloadAndOptionsTypes;
     /**
      * 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.
      */
     private validateMessagingPayload;
     /**
      * 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.
      */
     private validateMessagingOptions;
     /**
      * 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.
      */
     private validateRegistrationTokensType;
     /**
      * 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.
      */
     private validateRegistrationTokens;
     /**
      * 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.
      */
     private validateTopicType;
     /**
      * 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.
      */
     private validateTopic;
     /**
      * 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.
      */
     private normalizeTopic;
 }