@firebase/messaging 0.12.26 → 0.13.0-20260526192810

package/dist/src/messaging-service.d.ts

@@ -20,7 +20,7 @@ import { FirebaseAnalyticsInternalName } from '@firebase/analytics-interop-types
 import { FirebaseInternalDependencies } from './interfaces/internal-dependencies';
 import { LogEvent } from './interfaces/logging-types';
 import { Provider } from '@firebase/component';
-import { _FirebaseInstallationsInternal } from '@firebase/installations';
+import { _FirebaseInstallationsInternal, IdChangeUnsubscribeFn } from '@firebase/installations';
 export declare class MessagingService implements _FirebaseService {
     readonly app: FirebaseApp;
     readonly firebaseDependencies: FirebaseInternalDependencies;
@@ -29,8 +29,33 @@ export declare class MessagingService implements _FirebaseService {
     deliveryMetricsExportedToBigQueryEnabled: boolean;
     onBackgroundMessageHandler: NextFn<MessagePayload> | Observer<MessagePayload> | null;
     onMessageHandler: NextFn<MessagePayload> | Observer<MessagePayload> | null;
+    /** Observer for the event that the app instance is registered with FCM via Firebase Installation ID (FID). */
+    onRegisteredHandler: NextFn<string> | Observer<string> | null;
+    /** Observer for the event that the app instance is unregistered from FCM (FID no longer active). */
+    onUnregisteredHandler: NextFn<string> | Observer<string> | null;
+    /**
+     * Serializes the FID get + compare + notify step so concurrent register() calls
+     * do not race each other.
+     */
+    _registerNotifyChain: Promise<void>;
+    /** Unsubscribe from Installations `onIdChange` when messaging is deleted. */
+    _fidChangeUnsubscribe: IdChangeUnsubscribeFn | null;
     logEvents: LogEvent[];
-    isLogServiceStarted: boolean;
+    /**
+     * Single source of truth for the logging loop lifecycle.
+     *
+     * `scheduled` holds the active timer id; `flushing` indicates an async dispatch
+     * is in progress (prevents duplicate starts); `stopped` means idle.
+     */
+    logQueue: LogQueueState;
     constructor(app: FirebaseApp, installations: _FirebaseInstallationsInternal, analyticsProvider: Provider<FirebaseAnalyticsInternalName>);
     _delete(): Promise<void>;
 }
+export type LogQueueState = {
+    state: 'stopped';
+} | {
+    state: 'scheduled';
+    timerId: ReturnType<typeof setTimeout>;
+} | {
+    state: 'flushing';
+};

package/dist/src/testing/fakes/token-details.d.ts

@@ -14,5 +14,5 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-import { TokenDetails } from '../../interfaces/token-details';
+import { TokenDetails } from '../../interfaces/registration-details';
 export declare function getFakeTokenDetails(): TokenDetails;

package/dist/src/util/errors.d.ts

@@ -26,6 +26,9 @@ export declare const enum ErrorCode {
     FAILED_DEFAULT_REGISTRATION = "failed-service-worker-registration",
     TOKEN_SUBSCRIBE_FAILED = "token-subscribe-failed",
     TOKEN_SUBSCRIBE_NO_TOKEN = "token-subscribe-no-token",
+    FID_REGISTRATION_FAILED = "fid-registration-failed",
+    FID_UNREGISTER_FAILED = "fid-unregister-failed",
+    FID_REGISTRATION_IDB_SCHEMA_UNAVAILABLE = "fid-registration-idb-schema-unavailable",
     TOKEN_UNSUBSCRIBE_FAILED = "token-unsubscribe-failed",
     TOKEN_UPDATE_FAILED = "token-update-failed",
     TOKEN_UPDATE_NO_TOKEN = "token-update-no-token",
@@ -33,7 +36,8 @@ export declare const enum ErrorCode {
     USE_SW_AFTER_GET_TOKEN = "use-sw-after-get-token",
     INVALID_SW_REGISTRATION = "invalid-sw-registration",
     USE_VAPID_KEY_AFTER_GET_TOKEN = "use-vapid-key-after-get-token",
-    INVALID_VAPID_KEY = "invalid-vapid-key"
+    INVALID_VAPID_KEY = "invalid-vapid-key",
+    INVALID_ON_REGISTERED_HANDLER = "invalid-on-registered-handler"
 }
 export declare const ERROR_MAP: ErrorMap<ErrorCode>;
 interface ErrorParams {
@@ -46,6 +50,12 @@ interface ErrorParams {
     [ErrorCode.TOKEN_SUBSCRIBE_FAILED]: {
         errorInfo: string;
     };
+    [ErrorCode.FID_REGISTRATION_FAILED]: {
+        errorInfo: string;
+    };
+    [ErrorCode.FID_UNREGISTER_FAILED]: {
+        errorInfo: string;
+    };
     [ErrorCode.TOKEN_UNSUBSCRIBE_FAILED]: {
         errorInfo: string;
     };

package/dist/sw/index-public.d.ts

@@ -157,10 +157,44 @@ export { Observer };
  * @param nextOrObserver - This function, or observer object with `next` defined, is called when a
  * message is received and the app is currently in the background.
  *
- * @returns To stop listening for messages execute this returned function
+ * @returns To stop listening for messages execute this returned function.
  *
  * @public
  */
 export declare function onBackgroundMessage(messaging: Messaging, nextOrObserver: NextFn<MessagePayload> | Observer<MessagePayload>): Unsubscribe;
+/**
+ * Subscribes to an event that the app instance is registered with FCM via Firebase Installation ID (FID).
+ * Use the FID passed to the callback to upload it to your application server. When you receive an FID
+ * after calling {@link register}, instruct your backend to remove any legacy token for this instance.
+ *
+ * @param messaging - The {@link Messaging} instance.
+ * @param nextOrObserver - A function or observer object called when an FID is registered.
+ * @returns Unsubscribe function to stop listening.
+ *
+ * @public
+ */
+export declare function onRegistered(messaging: Messaging, nextOrObserver: NextFn<string> | Observer<string>): Unsubscribe;
+/**
+ * Subscribes to an event that the app instance is unregistered from FCM (FID no longer active).
+ * Use this to notify your backend to remove this FID to prevent 404 errors on send.
+ *
+ * @param messaging - The {@link Messaging} instance.
+ * @param nextOrObserver - A function or observer object called with the unregistered FID.
+ * @returns Unsubscribe function to stop listening.
+ *
+ * @public
+ */
+export declare function onUnregistered(messaging: Messaging, nextOrObserver: NextFn<string> | Observer<string>): Unsubscribe;
+/**
+ * Options for {@link register}. Same shape as GetTokenOptions for SW and VAPID configuration.
+ *
+ * @public
+ */
+export declare interface RegisterOptions {
+    /** Optional VAPID key. See {@link GetTokenOptions.vapidKey}. */
+    vapidKey?: string;
+    /** Optional service worker registration. See {@link GetTokenOptions.serviceWorkerRegistration}. */
+    serviceWorkerRegistration?: ServiceWorkerRegistration;
+}
 export { Unsubscribe };
 export {};

package/dist/sw/internal.d.ts

@@ -170,11 +170,48 @@ export { Observer }
  * @param nextOrObserver - This function, or observer object with `next` defined, is called when a
  * message is received and the app is currently in the background.
  *
- * @returns To stop listening for messages execute this returned function
+ * @returns To stop listening for messages execute this returned function.
  *
  * @public
  */
 export declare function onBackgroundMessage(messaging: Messaging, nextOrObserver: NextFn<MessagePayload> | Observer<MessagePayload>): Unsubscribe;
+
+/**
+ * Subscribes to an event that the app instance is registered with FCM via Firebase Installation ID (FID).
+ * Use the FID passed to the callback to upload it to your application server. When you receive an FID
+ * after calling {@link register}, instruct your backend to remove any legacy token for this instance.
+ *
+ * @param messaging - The {@link Messaging} instance.
+ * @param nextOrObserver - A function or observer object called when an FID is registered.
+ * @returns Unsubscribe function to stop listening.
+ *
+ * @public
+ */
+export declare function onRegistered(messaging: Messaging, nextOrObserver: NextFn<string> | Observer<string>): Unsubscribe;
+
+/**
+ * Subscribes to an event that the app instance is unregistered from FCM (FID no longer active).
+ * Use this to notify your backend to remove this FID to prevent 404 errors on send.
+ *
+ * @param messaging - The {@link Messaging} instance.
+ * @param nextOrObserver - A function or observer object called with the unregistered FID.
+ * @returns Unsubscribe function to stop listening.
+ *
+ * @public
+ */
+export declare function onUnregistered(messaging: Messaging, nextOrObserver: NextFn<string> | Observer<string>): Unsubscribe;
+
+/**
+ * Options for {@link register}. Same shape as GetTokenOptions for SW and VAPID configuration.
+ *
+ * @public
+ */
+export declare interface RegisterOptions {
+    /** Optional VAPID key. See {@link GetTokenOptions.vapidKey}. */
+    vapidKey?: string;
+    /** Optional service worker registration. See {@link GetTokenOptions.serviceWorkerRegistration}. */
+    serviceWorkerRegistration?: ServiceWorkerRegistration;
+}
 export { Unsubscribe }
 
 export { }

package/dist/sw/private.d.ts

@@ -167,11 +167,48 @@ export { Observer }
  * @param nextOrObserver - This function, or observer object with `next` defined, is called when a
  * message is received and the app is currently in the background.
  *
- * @returns To stop listening for messages execute this returned function
+ * @returns To stop listening for messages execute this returned function.
  *
  * @public
  */
 export declare function onBackgroundMessage(messaging: Messaging, nextOrObserver: NextFn<MessagePayload> | Observer<MessagePayload>): Unsubscribe;
+
+/**
+ * Subscribes to an event that the app instance is registered with FCM via Firebase Installation ID (FID).
+ * Use the FID passed to the callback to upload it to your application server. When you receive an FID
+ * after calling {@link register}, instruct your backend to remove any legacy token for this instance.
+ *
+ * @param messaging - The {@link Messaging} instance.
+ * @param nextOrObserver - A function or observer object called when an FID is registered.
+ * @returns Unsubscribe function to stop listening.
+ *
+ * @public
+ */
+export declare function onRegistered(messaging: Messaging, nextOrObserver: NextFn<string> | Observer<string>): Unsubscribe;
+
+/**
+ * Subscribes to an event that the app instance is unregistered from FCM (FID no longer active).
+ * Use this to notify your backend to remove this FID to prevent 404 errors on send.
+ *
+ * @param messaging - The {@link Messaging} instance.
+ * @param nextOrObserver - A function or observer object called with the unregistered FID.
+ * @returns Unsubscribe function to stop listening.
+ *
+ * @public
+ */
+export declare function onUnregistered(messaging: Messaging, nextOrObserver: NextFn<string> | Observer<string>): Unsubscribe;
+
+/**
+ * Options for {@link register}. Same shape as GetTokenOptions for SW and VAPID configuration.
+ *
+ * @public
+ */
+export declare interface RegisterOptions {
+    /** Optional VAPID key. See {@link GetTokenOptions.vapidKey}. */
+    vapidKey?: string;
+    /** Optional service worker registration. See {@link GetTokenOptions.serviceWorkerRegistration}. */
+    serviceWorkerRegistration?: ServiceWorkerRegistration;
+}
 export { Unsubscribe }
 
 export { }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@firebase/messaging",
-  "version": "0.12.26",
+  "version": "0.13.0-20260526192810",
   "description": "",
   "author": "Firebase <firebase-support@google.com> (https://firebase.google.com/)",
   "main": "dist/index.cjs.js",
@@ -53,7 +53,7 @@
   },
   "dependencies": {
     "@firebase/installations": "0.6.22",
-    "@firebase/messaging-interop-types": "0.2.4",
+    "@firebase/messaging-interop-types": "0.2.5-20260526192810",
     "@firebase/util": "1.15.1",
     "@firebase/component": "0.7.3",
     "idb": "7.1.1",