firebase-admin 13.9.0 → 14.0.0

package/lib/messaging/error.js

@@ -0,0 +1,286 @@
+/*! firebase-admin v14.0.0 */
+"use strict";
+/*!
+ * Copyright 2026 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FirebaseMessagingError = exports.messagingClientErrorCode = exports.MessagingErrorCode = void 0;
+const error_1 = require("../utils/error");
+const deep_copy_1 = require("../utils/deep-copy");
+/**
+ * The constant mapping for valid Messaging client error codes.
+ */
+exports.MessagingErrorCode = {
+    INVALID_ARGUMENT: 'invalid-argument',
+    INVALID_RECIPIENT: 'invalid-recipient',
+    INVALID_PAYLOAD: 'invalid-payload',
+    INVALID_DATA_PAYLOAD_KEY: 'invalid-data-payload-key',
+    PAYLOAD_SIZE_LIMIT_EXCEEDED: 'payload-size-limit-exceeded',
+    INVALID_OPTIONS: 'invalid-options',
+    INVALID_REGISTRATION_TOKEN: 'invalid-registration-token',
+    REGISTRATION_TOKEN_NOT_REGISTERED: 'registration-token-not-registered',
+    MISMATCHED_CREDENTIAL: 'mismatched-credential',
+    INVALID_PACKAGE_NAME: 'invalid-package-name',
+    DEVICE_MESSAGE_RATE_EXCEEDED: 'device-message-rate-exceeded',
+    TOPICS_MESSAGE_RATE_EXCEEDED: 'topics-message-rate-exceeded',
+    TOPICS_SUBSCRIPTION_RATE_EXCEEDED: 'topics-subscription-rate-exceeded',
+    MESSAGE_RATE_EXCEEDED: 'message-rate-exceeded',
+    THIRD_PARTY_AUTH_ERROR: 'third-party-auth-error',
+    TOO_MANY_TOPICS: 'too-many-topics',
+    AUTHENTICATION_ERROR: 'authentication-error',
+    SERVER_UNAVAILABLE: 'server-unavailable',
+    INTERNAL_ERROR: 'internal-error',
+    UNKNOWN_ERROR: 'unknown-error',
+};
+/**
+ * Internal Messaging client error code mapping used to construct ErrorInfo.
+ */
+exports.messagingClientErrorCode = {
+    INVALID_ARGUMENT: {
+        code: exports.MessagingErrorCode.INVALID_ARGUMENT,
+        message: 'Invalid argument provided.',
+    },
+    INVALID_RECIPIENT: {
+        code: exports.MessagingErrorCode.INVALID_RECIPIENT,
+        message: 'Invalid message recipient provided.',
+    },
+    INVALID_PAYLOAD: {
+        code: exports.MessagingErrorCode.INVALID_PAYLOAD,
+        message: 'Invalid message payload provided.',
+    },
+    INVALID_DATA_PAYLOAD_KEY: {
+        code: exports.MessagingErrorCode.INVALID_DATA_PAYLOAD_KEY,
+        message: 'The data message payload contains an invalid key. See the reference ' +
+            'documentation for the DataMessagePayload type for restricted keys.',
+    },
+    PAYLOAD_SIZE_LIMIT_EXCEEDED: {
+        code: exports.MessagingErrorCode.PAYLOAD_SIZE_LIMIT_EXCEEDED,
+        message: 'The provided message payload exceeds the FCM size limits. See the ' +
+            'error documentation for more details.',
+    },
+    INVALID_OPTIONS: {
+        code: exports.MessagingErrorCode.INVALID_OPTIONS,
+        message: 'Invalid message options provided.',
+    },
+    INVALID_REGISTRATION_TOKEN: {
+        code: exports.MessagingErrorCode.INVALID_REGISTRATION_TOKEN,
+        message: 'Invalid registration token provided. Make sure it matches the ' +
+            'registration token the client app receives from registering with FCM.',
+    },
+    REGISTRATION_TOKEN_NOT_REGISTERED: {
+        code: exports.MessagingErrorCode.REGISTRATION_TOKEN_NOT_REGISTERED,
+        message: 'The provided registration token is not registered. A ' +
+            'previously valid registration token can be unregistered for a variety of reasons. See the ' +
+            'error documentation for more details. Remove this registration token and stop using it to ' +
+            'send messages.',
+    },
+    MISMATCHED_CREDENTIAL: {
+        code: exports.MessagingErrorCode.MISMATCHED_CREDENTIAL,
+        message: 'The credential used to authenticate this SDK does not have permission ' +
+            'to send messages to the device corresponding to the provided registration token. Make sure the ' +
+            'credential and registration token both belong to the same Firebase project.',
+    },
+    INVALID_PACKAGE_NAME: {
+        code: exports.MessagingErrorCode.INVALID_PACKAGE_NAME,
+        message: 'The message was addressed to a registration token whose package name does ' +
+            'not match the provided "restrictedPackageName" option.',
+    },
+    DEVICE_MESSAGE_RATE_EXCEEDED: {
+        code: exports.MessagingErrorCode.DEVICE_MESSAGE_RATE_EXCEEDED,
+        message: 'The rate of messages to a particular device is too high. Reduce ' +
+            'the number of messages sent to this device and do not immediately retry sending to this device.',
+    },
+    TOPICS_MESSAGE_RATE_EXCEEDED: {
+        code: exports.MessagingErrorCode.TOPICS_MESSAGE_RATE_EXCEEDED,
+        message: 'The rate of messages to subscribers to a particular topic is too ' +
+            'high. Reduce the number of messages sent for this topic, and do not immediately retry sending ' +
+            'to this topic.',
+    },
+    TOPICS_SUBSCRIPTION_RATE_EXCEEDED: {
+        code: exports.MessagingErrorCode.TOPICS_SUBSCRIPTION_RATE_EXCEEDED,
+        message: 'The rate of subscription management requests to a particular topic is too ' +
+            'high. Reduce the number of requests sent for this topic, and do not immediately retry the ' +
+            'request.',
+    },
+    MESSAGE_RATE_EXCEEDED: {
+        code: exports.MessagingErrorCode.MESSAGE_RATE_EXCEEDED,
+        message: 'Sending limit exceeded for the message target.',
+    },
+    THIRD_PARTY_AUTH_ERROR: {
+        code: exports.MessagingErrorCode.THIRD_PARTY_AUTH_ERROR,
+        message: 'A message targeted to an iOS device could not be sent because the ' +
+            'required APNs SSL certificate was not uploaded or has expired. Check the validity of your ' +
+            'development and production certificates.',
+    },
+    TOO_MANY_TOPICS: {
+        code: exports.MessagingErrorCode.TOO_MANY_TOPICS,
+        message: 'The maximum number of topics the provided registration token can be ' +
+            'subscribed to has been exceeded.',
+    },
+    AUTHENTICATION_ERROR: {
+        code: exports.MessagingErrorCode.AUTHENTICATION_ERROR,
+        message: 'An error occurred when trying to authenticate to the FCM servers. Make ' +
+            'sure the credential used to authenticate this SDK has the proper permissions. See ' +
+            'https://firebase.google.com/docs/admin/setup for setup instructions.',
+    },
+    SERVER_UNAVAILABLE: {
+        code: exports.MessagingErrorCode.SERVER_UNAVAILABLE,
+        message: 'The FCM server could not process the request in time. See the error ' +
+            'documentation for more details.',
+    },
+    INTERNAL_ERROR: {
+        code: exports.MessagingErrorCode.INTERNAL_ERROR,
+        message: 'An internal error has occurred. Please retry the request.',
+    },
+    UNKNOWN_ERROR: {
+        code: exports.MessagingErrorCode.UNKNOWN_ERROR,
+        message: 'An unknown server error was returned.',
+    },
+};
+/** @const {Record<string, keyof typeof MessagingErrorCode>} Messaging server to client enum error codes. */
+const MESSAGING_SERVER_TO_CLIENT_CODE = {
+    /* GENERIC ERRORS */
+    // Generic invalid message parameter provided.
+    InvalidParameters: 'INVALID_ARGUMENT',
+    // Mismatched sender ID.
+    MismatchSenderId: 'MISMATCHED_CREDENTIAL',
+    // FCM server unavailable.
+    Unavailable: 'SERVER_UNAVAILABLE',
+    // FCM server internal error.
+    InternalServerError: 'INTERNAL_ERROR',
+    /* SEND ERRORS */
+    // Invalid registration token format.
+    InvalidRegistration: 'INVALID_REGISTRATION_TOKEN',
+    // Registration token is not registered.
+    NotRegistered: 'REGISTRATION_TOKEN_NOT_REGISTERED',
+    // Registration token does not match restricted package name.
+    InvalidPackageName: 'INVALID_PACKAGE_NAME',
+    // Message payload size limit exceeded.
+    MessageTooBig: 'PAYLOAD_SIZE_LIMIT_EXCEEDED',
+    // Invalid key in the data message payload.
+    InvalidDataKey: 'INVALID_DATA_PAYLOAD_KEY',
+    // Invalid time to live option.
+    InvalidTtl: 'INVALID_OPTIONS',
+    // Device message rate exceeded.
+    DeviceMessageRateExceeded: 'DEVICE_MESSAGE_RATE_EXCEEDED',
+    // Topics message rate exceeded.
+    TopicsMessageRateExceeded: 'TOPICS_MESSAGE_RATE_EXCEEDED',
+    // Invalid APNs credentials.
+    InvalidApnsCredential: 'THIRD_PARTY_AUTH_ERROR',
+    /* FCM v1 canonical error codes */
+    NOT_FOUND: 'REGISTRATION_TOKEN_NOT_REGISTERED',
+    PERMISSION_DENIED: 'MISMATCHED_CREDENTIAL',
+    RESOURCE_EXHAUSTED: 'MESSAGE_RATE_EXCEEDED',
+    UNAUTHENTICATED: 'THIRD_PARTY_AUTH_ERROR',
+    /* FCM v1 new error codes */
+    APNS_AUTH_ERROR: 'THIRD_PARTY_AUTH_ERROR',
+    INTERNAL: 'INTERNAL_ERROR',
+    INVALID_ARGUMENT: 'INVALID_ARGUMENT',
+    QUOTA_EXCEEDED: 'MESSAGE_RATE_EXCEEDED',
+    SENDER_ID_MISMATCH: 'MISMATCHED_CREDENTIAL',
+    THIRD_PARTY_AUTH_ERROR: 'THIRD_PARTY_AUTH_ERROR',
+    UNAVAILABLE: 'SERVER_UNAVAILABLE',
+    UNREGISTERED: 'REGISTRATION_TOKEN_NOT_REGISTERED',
+    UNSPECIFIED_ERROR: 'UNKNOWN_ERROR',
+};
+/**
+ * @const {Record<string, keyof typeof MessagingErrorCode>} Topic management (IID)
+ * server to client enum error codes.
+ */
+const TOPIC_MGT_SERVER_TO_CLIENT_CODE = {
+    /* TOPIC SUBSCRIPTION MANAGEMENT ERRORS */
+    NOT_FOUND: 'REGISTRATION_TOKEN_NOT_REGISTERED',
+    INVALID_ARGUMENT: 'INVALID_REGISTRATION_TOKEN',
+    TOO_MANY_TOPICS: 'TOO_MANY_TOPICS',
+    RESOURCE_EXHAUSTED: 'TOPICS_SUBSCRIPTION_RATE_EXCEEDED',
+    PERMISSION_DENIED: 'AUTHENTICATION_ERROR',
+    DEADLINE_EXCEEDED: 'SERVER_UNAVAILABLE',
+    INTERNAL: 'INTERNAL_ERROR',
+    UNKNOWN: 'UNKNOWN_ERROR',
+};
+/**
+ * Firebase Messaging error code structure. This extends `FirebaseError`.
+ */
+class FirebaseMessagingError extends error_1.FirebaseError {
+    /**
+     * Creates the developer-facing error corresponding to the backend error code.
+     *
+     * @param serverErrorCode - The server error code.
+     * @param [message] The error message. The default message is used
+     *     if not provided.
+     * @param [serverError] The error's raw server response.
+     * @returns The corresponding developer-facing error.
+     * @internal
+     */
+    static fromServerError(serverErrorCode, message, serverError) {
+        // If not found, default to unknown error.
+        let clientCodeKey = 'UNKNOWN_ERROR';
+        if (serverErrorCode && serverErrorCode in MESSAGING_SERVER_TO_CLIENT_CODE) {
+            clientCodeKey = MESSAGING_SERVER_TO_CLIENT_CODE[serverErrorCode];
+        }
+        const error = (0, deep_copy_1.deepCopy)(exports.messagingClientErrorCode[clientCodeKey]);
+        error.message = message || error.message;
+        const rawData = serverError?.response?.data;
+        if (clientCodeKey === 'UNKNOWN_ERROR' && typeof rawData !== 'undefined') {
+            try {
+                error.message += ` Raw server response: "${typeof rawData === 'string' ? rawData : JSON.stringify(rawData)}"`;
+            }
+            catch (e) {
+                // Ignore JSON parsing error.
+            }
+        }
+        error.cause = serverError;
+        error.httpResponse = serverError?.response ? (0, error_1.toHttpResponse)(serverError.response) : undefined;
+        return new FirebaseMessagingError(error);
+    }
+    /**
+     * @internal
+     */
+    static fromTopicManagementServerError(serverErrorCode, message, serverError) {
+        // If not found, default to unknown error.
+        const clientCodeKey = TOPIC_MGT_SERVER_TO_CLIENT_CODE[serverErrorCode] || 'UNKNOWN_ERROR';
+        const error = (0, deep_copy_1.deepCopy)(exports.messagingClientErrorCode[clientCodeKey]);
+        error.message = message || error.message;
+        const rawData = serverError?.response?.data;
+        if (clientCodeKey === 'UNKNOWN_ERROR' && typeof rawData !== 'undefined') {
+            try {
+                error.message += ` Raw server response: "${typeof rawData === 'string' ? rawData : JSON.stringify(rawData)}"`;
+            }
+            catch (e) {
+                // Ignore JSON parsing error.
+            }
+        }
+        error.cause = serverError;
+        error.httpResponse = serverError?.response ? (0, error_1.toHttpResponse)(serverError.response) : undefined;
+        return new FirebaseMessagingError(error);
+    }
+    /**
+     *
+     * @param info - The error code info.
+     * @param message - The error message. This will override the default message if provided.
+     */
+    constructor(info, message) {
+        // Override default message if custom message provided.
+        super({
+            code: `messaging/${info.code}`,
+            message: message || info.message,
+            httpResponse: info.httpResponse,
+            cause: info.cause,
+        });
+        /** @internal */
+        this.codePrefix = 'messaging';
+    }
+}
+exports.FirebaseMessagingError = FirebaseMessagingError;

package/lib/messaging/index.d.ts

@@ -1,4 +1,4 @@
-/*! firebase-admin v13.9.0 */
+/*! firebase-admin v14.0.0 */
 /*!
  * Copyright 2020 Google LLC
  *
@@ -22,7 +22,7 @@
 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, MessagingOptions, MessagingPayload, NotificationMessagePayload, } from './messaging-api';
+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, } from './messaging-api';
 /**
  * Gets the {@link Messaging} service for the default app or a given app.
  *
@@ -50,4 +50,4 @@ export { AndroidConfig, AndroidFcmOptions, AndroidNotification, ApnsConfig, Apns
  *   app.
  */
 export declare function getMessaging(app?: App): Messaging;
-export { FirebaseMessagingError, MessagingClientErrorCode } from '../utils/error';
+export { FirebaseMessagingError, MessagingErrorCode, } from './error';

package/lib/messaging/index.js

@@ -1,4 +1,4 @@
-/*! firebase-admin v13.9.0 */
+/*! firebase-admin v14.0.0 */
 "use strict";
 /*!
  * Copyright 2020 Google LLC
@@ -16,7 +16,7 @@
  * limitations under the License.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.MessagingClientErrorCode = exports.FirebaseMessagingError = exports.Messaging = void 0;
+exports.MessagingErrorCode = exports.FirebaseMessagingError = exports.Messaging = void 0;
 exports.getMessaging = getMessaging;
 /**
  * Firebase Cloud Messaging (FCM).
@@ -60,6 +60,6 @@ function getMessaging(app) {
     const firebaseApp = app;
     return firebaseApp.getOrInitService('messaging', (app) => new messaging_1.Messaging(app));
 }
-var error_1 = require("../utils/error");
+var error_1 = require("./error");
 Object.defineProperty(exports, "FirebaseMessagingError", { enumerable: true, get: function () { return error_1.FirebaseMessagingError; } });
-Object.defineProperty(exports, "MessagingClientErrorCode", { enumerable: true, get: function () { return error_1.MessagingClientErrorCode; } });
+Object.defineProperty(exports, "MessagingErrorCode", { enumerable: true, get: function () { return error_1.MessagingErrorCode; } });

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

@@ -1,4 +1,4 @@
-/*! firebase-admin v13.9.0 */
+/*! firebase-admin v14.0.0 */
 /*!
  * @license
  * Copyright 2017 Google LLC

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

@@ -1,4 +1,4 @@
-/*! firebase-admin v13.9.0 */
+/*! firebase-admin v14.0.0 */
 "use strict";
 /*!
  * @license

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

@@ -1,4 +1,4 @@
-/*! firebase-admin v13.9.0 */
+/*! firebase-admin v14.0.0 */
 /*!
  * @license
  * Copyright 2021 Google LLC
@@ -577,285 +577,6 @@ export interface AndroidFcmOptions {
      */
     analyticsLabel?: string;
 }
-/**
- * Interface representing an FCM legacy API data message payload. Data
- * messages let developers send up to 4KB of custom key-value pairs. The
- * keys and values must both be strings. Keys can be any custom string,
- * except for the following reserved strings:
- *
- * <ul>
- *   <li><code>from</code></li>
- *   <li>Anything starting with <code>google.</code></li>
- * </ul>
- *
- * See {@link https://firebase.google.com/docs/cloud-messaging/send-message | Build send requests}
- * for code samples and detailed documentation.
- */
-export interface DataMessagePayload {
-    [key: string]: string;
-}
-/**
- * Interface representing an FCM legacy API notification message payload.
- * Notification messages let developers send up to 4KB of predefined
- * key-value pairs. Accepted keys are outlined below.
- *
- * See {@link https://firebase.google.com/docs/cloud-messaging/send-message | Build send requests}
- * for code samples and detailed documentation.
- */
-export interface NotificationMessagePayload {
-    /**
-     * Identifier used to replace existing notifications in the notification drawer.
-     *
-     * If not specified, each request creates a new notification.
-     *
-     * If specified and a notification with the same tag is already being shown,
-     * the new notification replaces the existing one in the notification drawer.
-     *
-     * **Platforms:** Android
-     */
-    tag?: string;
-    /**
-     * The notification's body text.
-     *
-     * **Platforms:** iOS, Android, Web
-     */
-    body?: string;
-    /**
-     * The notification's icon.
-     *
-     * **Android:** Sets the notification icon to `myicon` for drawable resource
-     * `myicon`. If you don't send this key in the request, FCM displays the
-     * launcher icon specified in your app manifest.
-     *
-     * **Web:** The URL to use for the notification's icon.
-     *
-     * **Platforms:** Android, Web
-     */
-    icon?: string;
-    /**
-     * The value of the badge on the home screen app icon.
-     *
-     * If not specified, the badge is not changed.
-     *
-     * If set to `0`, the badge is removed.
-     *
-     * **Platforms:** iOS
-     */
-    badge?: string;
-    /**
-     * The notification icon's color, expressed in `#rrggbb` format.
-     *
-     * **Platforms:** Android
-     */
-    color?: string;
-    /**
-     * The sound to be played when the device receives a notification. Supports
-     * "default" for the default notification sound of the device or the filename of a
-     * sound resource bundled in the app.
-     * Sound files must reside in `/res/raw/`.
-     *
-     * **Platforms:** Android
-     */
-    sound?: string;
-    /**
-     * The notification's title.
-     *
-     * **Platforms:** iOS, Android, Web
-     */
-    title?: string;
-    /**
-     * The key to the body string in the app's string resources to use to localize
-     * the body text to the user's current localization.
-     *
-     * **iOS:** Corresponds to `loc-key` in the APNs payload. See
-     * {@link https://developer.apple.com/library/content/documentation/NetworkingInternet/Conceptual/RemoteNotificationsPG/PayloadKeyReference.html |
-     * Payload Key Reference} and
-     * {@link https://developer.apple.com/library/content/documentation/NetworkingInternet/Conceptual/RemoteNotificationsPG/CreatingtheNotificationPayload.html#//apple_ref/doc/uid/TP40008194-CH10-SW9 |
-     * Localizing the Content of Your Remote Notifications} for more information.
-     *
-     * **Android:** See
-     * {@link http://developer.android.com/guide/topics/resources/string-resource.html | String Resources}
-     * for more information.
-     *
-     * **Platforms:** iOS, Android
-     */
-    bodyLocKey?: string;
-    /**
-     * Variable string values to be used in place of the format specifiers in
-     * `body_loc_key` to use to localize the body text to the user's current
-     * localization.
-     *
-     * The value should be a stringified JSON array.
-     *
-     * **iOS:** Corresponds to `loc-args` in the APNs payload. See
-     * {@link https://developer.apple.com/library/content/documentation/NetworkingInternet/Conceptual/RemoteNotificationsPG/PayloadKeyReference.html |
-     * Payload Key Reference} and
-     * {@link https://developer.apple.com/library/content/documentation/NetworkingInternet/Conceptual/RemoteNotificationsPG/CreatingtheNotificationPayload.html#//apple_ref/doc/uid/TP40008194-CH10-SW9 |
-     * Localizing the Content of Your Remote Notifications} for more information.
-     *
-     * **Android:** See
-     * {@link http://developer.android.com/guide/topics/resources/string-resource.html#FormattingAndStyling |
-     * Formatting and Styling} for more information.
-     *
-     * **Platforms:** iOS, Android
-     */
-    bodyLocArgs?: string;
-    /**
-     * Action associated with a user click on the notification. If specified, an
-     * activity with a matching Intent Filter is launched when a user clicks on the
-     * notification.
-     *
-     *   * **Platforms:** Android
-     */
-    clickAction?: string;
-    /**
-     * The key to the title string in the app's string resources to use to localize
-     * the title text to the user's current localization.
-     *
-     * **iOS:** Corresponds to `title-loc-key` in the APNs payload. See
-     * {@link https://developer.apple.com/library/content/documentation/NetworkingInternet/Conceptual/RemoteNotificationsPG/PayloadKeyReference.html |
-     * Payload Key Reference} and
-     * {@link https://developer.apple.com/library/content/documentation/NetworkingInternet/Conceptual/RemoteNotificationsPG/CreatingtheNotificationPayload.html#//apple_ref/doc/uid/TP40008194-CH10-SW9 |
-     * Localizing the Content of Your Remote Notifications} for more information.
-     *
-     * **Android:** See
-     * {@link http://developer.android.com/guide/topics/resources/string-resource.html | String Resources}
-     * for more information.
-     *
-     * **Platforms:** iOS, Android
-     */
-    titleLocKey?: string;
-    /**
-     * Variable string values to be used in place of the format specifiers in
-     * `title_loc_key` to use to localize the title text to the user's current
-     * localization.
-     *
-     * The value should be a stringified JSON array.
-     *
-     * **iOS:** Corresponds to `title-loc-args` in the APNs payload. See
-     * {@link https://developer.apple.com/library/content/documentation/NetworkingInternet/Conceptual/RemoteNotificationsPG/PayloadKeyReference.html |
-     * Payload Key Reference} and
-     * {@link https://developer.apple.com/library/content/documentation/NetworkingInternet/Conceptual/RemoteNotificationsPG/CreatingtheNotificationPayload.html#//apple_ref/doc/uid/TP40008194-CH10-SW9 |
-     * Localizing the Content of Your Remote Notifications} for more information.
-     *
-     * **Android:** See
-     * {@link http://developer.android.com/guide/topics/resources/string-resource.html#FormattingAndStyling |
-     * Formatting and Styling} for more information.
-     *
-     * **Platforms:** iOS, Android
-     */
-    titleLocArgs?: string;
-    [key: string]: string | undefined;
-}
-/**
- * Interface representing a Firebase Cloud Messaging message payload. One or
- * both of the `data` and `notification` keys are required.
- *
- * See {@link https://firebase.google.com/docs/cloud-messaging/send-message | Build send requests}
- * for code samples and detailed documentation.
- */
-export interface MessagingPayload {
-    /**
-     * The data message payload.
-     */
-    data?: DataMessagePayload;
-    /**
-     * The notification message payload.
-     */
-    notification?: NotificationMessagePayload;
-}
-/**
- * Interface representing the options that can be provided when sending a
- * message via the FCM legacy APIs.
- *
- * See {@link https://firebase.google.com/docs/cloud-messaging/send-message | Build send requests}
- * for code samples and detailed documentation.
- */
-export interface MessagingOptions {
-    /**
-     * Whether or not the message should actually be sent. When set to `true`,
-     * allows developers to test a request without actually sending a message. When
-     * set to `false`, the message will be sent.
-     *
-     * **Default value:** `false`
-     */
-    dryRun?: boolean;
-    /**
-     * The priority of the message. Valid values are `"normal"` and `"high".` On
-     * iOS, these correspond to APNs priorities `5` and `10`.
-     *
-     * By default, notification messages are sent with high priority, and data
-     * messages are sent with normal priority. Normal priority optimizes the client
-     * app's battery consumption and should be used unless immediate delivery is
-     * required. For messages with normal priority, the app may receive the message
-     * with unspecified delay.
-     *
-     * When a message is sent with high priority, it is sent immediately, and the
-     * app can wake a sleeping device and open a network connection to your server.
-     *
-     * For more information, see
-     * {@link https://firebase.google.com/docs/cloud-messaging/concept-options#setting-the-priority-of-a-message |
-     * Setting the priority of a message}.
-     *
-     * **Default value:** `"high"` for notification messages, `"normal"` for data
-     * messages
-     */
-    priority?: string;
-    /**
-     * How long (in seconds) the message should be kept in FCM storage if the device
-     * is offline. The maximum time to live supported is four weeks, and the default
-     * value is also four weeks. For more information, see
-     * {@link https://firebase.google.com/docs/cloud-messaging/concept-options#ttl | Setting the lifespan of a message}.
-     *
-     * **Default value:** `2419200` (representing four weeks, in seconds)
-     */
-    timeToLive?: number;
-    /**
-     * String identifying a group of messages (for example, "Updates Available")
-     * that can be collapsed, so that only the last message gets sent when delivery
-     * can be resumed. This is used to avoid sending too many of the same messages
-     * when the device comes back online or becomes active.
-     *
-     * There is no guarantee of the order in which messages get sent.
-     *
-     * A maximum of four different collapse keys is allowed at any given time. This
-     * means FCM server can simultaneously store four different
-     * send-to-sync messages per client app. If you exceed this number, there is no
-     * guarantee which four collapse keys the FCM server will keep.
-     *
-     * **Default value:** None
-     */
-    collapseKey?: string;
-    /**
-     * On iOS, use this field to represent `mutable-content` in the APNs payload.
-     * When a notification is sent and this is set to `true`, the content of the
-     * notification can be modified before it is displayed, using a
-     * {@link https://developer.apple.com/reference/usernotifications/unnotificationserviceextension |
-     * Notification Service app extension}.
-     *
-     * On Android and Web, this parameter will be ignored.
-     *
-     * **Default value:** `false`
-     */
-    mutableContent?: boolean;
-    /**
-     * On iOS, use this field to represent `content-available` in the APNs payload.
-     * When a notification or data message is sent and this is set to `true`, an
-     * inactive client app is awoken. On Android, data messages wake the app by
-     * default. On Chrome, this flag is currently not supported.
-     *
-     * **Default value:** `false`
-     */
-    contentAvailable?: boolean;
-    /**
-     * The package name of the application which the registration tokens must match
-     * in order to receive the message.
-     *
-     * **Default value:** None
-     */
-    restrictedPackageName?: string;
-    [key: string]: any | undefined;
-}
 /**
  * Interface representing the server response from the
  * {@link Messaging.subscribeToTopic} and {@link Messaging.unsubscribeFromTopic}

package/lib/messaging/messaging-api.js

@@ -1,4 +1,4 @@
-/*! firebase-admin v13.9.0 */
+/*! firebase-admin v14.0.0 */
 "use strict";
 /*!
  * @license

package/lib/messaging/messaging-errors-internal.d.ts

@@ -1,4 +1,4 @@
-/*! firebase-admin v13.9.0 */
+/*! firebase-admin v14.0.0 */
 /*!
  * Copyright 2019 Google LLC
  *
@@ -15,7 +15,7 @@
  * limitations under the License.
  */
 import { RequestResponseError } from '../utils/api-request';
-import { FirebaseMessagingError } from '../utils/error';
+import { FirebaseMessagingError } from './error';
 /**
  * Creates a new `FirebaseMessagingError` by extracting the error code, message and other relevant
  * details from a `RequestResponseError` response.