@depup/firebase__messaging 0.12.24-depup.0

package/dist/sw/internal.d.ts

@@ -0,0 +1,180 @@
+import { FirebaseApp } from '@firebase/app';
+import { NextFn } from '@firebase/util';
+import { Observer } from '@firebase/util';
+import { Unsubscribe } from '@firebase/util';
+
+/**
+ * Enables or disables Firebase Cloud Messaging message delivery metrics export to BigQuery. By
+ * default, message delivery metrics are not exported to BigQuery. Use this method to enable or
+ * disable the export at runtime.
+ *
+ * @param messaging - The `FirebaseMessaging` instance.
+ * @param enable - Whether Firebase Cloud Messaging should export message delivery metrics to
+ * BigQuery.
+ *
+ * @public
+ */
+export declare function experimentalSetDeliveryMetricsExportedToBigQueryEnabled(messaging: Messaging, enable: boolean): void;
+
+/**
+ * Options for features provided by the FCM SDK for Web. See {@link
+ * https://firebase.google.com/docs/reference/fcm/rest/v1/projects.messages#webpushfcmoptions |
+ * WebpushFcmOptions}.
+ *
+ * @public
+ */
+export declare interface FcmOptions {
+    /**
+     * The link to open when the user clicks on the notification.
+     */
+    link?: string;
+    /**
+     * The label associated with the message's analytics data.
+     */
+    analyticsLabel?: string;
+}
+
+/**
+ * @internal
+ */
+export declare type _FirebaseMessagingName = 'messaging';
+
+/**
+ * Retrieves a Firebase Cloud Messaging instance.
+ *
+ * @returns The Firebase Cloud Messaging instance associated with the provided firebase app.
+ *
+ * @public
+ */
+export declare function getMessaging(app?: FirebaseApp): Messaging;
+
+/**
+ * Options for {@link getToken}.
+ *
+ * @public
+ */
+export declare interface GetTokenOptions {
+    /**
+     * The public server key provided to push services. The key is used to
+     * authenticate push subscribers to receive push messages only from sending servers that hold
+     * the corresponding private key. If it is not provided, a default VAPID key is used. Note that some
+     * push services (Chrome Push Service) require a non-default VAPID key. Therefore, it is recommended
+     * to generate and import a VAPID key for your project with
+     * {@link https://firebase.google.com/docs/cloud-messaging/js/client#configure_web_credentials_in_your_app | Configure Web Credentials with FCM}.
+     * See
+     * {@link https://developers.google.com/web/fundamentals/push-notifications/web-push-protocol | The Web Push Protocol}
+     * for details on web push services.
+     */
+    vapidKey?: string;
+    /**
+     * The service worker registration for receiving push
+     * messaging. If the registration is not provided explicitly, you need to have a
+     * `firebase-messaging-sw.js` at your root location. See
+     * {@link https://firebase.google.com/docs/cloud-messaging/js/client#access_the_registration_token | Access the registration token}
+     * for more details.
+     */
+    serviceWorkerRegistration?: ServiceWorkerRegistration;
+}
+
+/**
+ * Checks whether all required APIs exist within SW Context
+ * @returns a Promise that resolves to a boolean.
+ *
+ * @public
+ */
+export declare function isSupported(): Promise<boolean>;
+
+/**
+ * Message payload that contains the notification payload that is represented with
+ * {@link NotificationPayload} and the data payload that contains an arbitrary
+ * number of key-value pairs sent by developers through the
+ * {@link https://firebase.google.com/docs/reference/fcm/rest/v1/projects.messages#notification | Send API}.
+ *
+ * @public
+ */
+export declare interface MessagePayload {
+    /**
+     * {@inheritdoc NotificationPayload}
+     */
+    notification?: NotificationPayload;
+    /**
+     * Arbitrary key/value payload.
+     */
+    data?: {
+        [key: string]: string;
+    };
+    /**
+     * {@inheritdoc FcmOptions}
+     */
+    fcmOptions?: FcmOptions;
+    /**
+     * The sender of this message.
+     */
+    from: string;
+    /**
+     * The collapse key of the message. See
+     * {@link https://firebase.google.com/docs/cloud-messaging/concept-options#collapsible_and_non-collapsible_messages | Non-collapsible and collapsible messages}
+     */
+    collapseKey: string;
+    /**
+     * The message ID of a message.
+     */
+    messageId: string;
+}
+
+/**
+ * Public interface of the Firebase Cloud Messaging SDK.
+ *
+ * @public
+ */
+export declare interface Messaging {
+    /**
+     * The {@link @firebase/app#FirebaseApp} this `Messaging` instance is associated with.
+     */
+    app: FirebaseApp;
+}
+export { NextFn }
+
+/**
+ * Display notification details. Details are sent through the
+ * {@link https://firebase.google.com/docs/reference/fcm/rest/v1/projects.messages#notification | Send API}.
+ *
+ * @public
+ */
+export declare interface NotificationPayload {
+    /**
+     * The notification's title.
+     */
+    title?: string;
+    /**
+     * The notification's body text.
+     */
+    body?: string;
+    /**
+     * The URL of an image that is downloaded on the device and displayed in the notification.
+     */
+    image?: string;
+    /**
+     * The URL to use for the notification's icon. If you don't send this key in the request,
+     * FCM displays the launcher icon specified in your app manifest.
+     */
+    icon?: string;
+}
+export { Observer }
+
+/**
+ * Called when a message is received while the app is in the background. An app is considered to be
+ * in the background if no active window is displayed.
+ *
+ * @param messaging - The {@link Messaging} instance.
+ * @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
+ *
+ * @public
+ */
+export declare function onBackgroundMessage(messaging: Messaging, nextOrObserver: NextFn<MessagePayload> | Observer<MessagePayload>): Unsubscribe;
+export { Unsubscribe }
+
+export { }

package/dist/sw/private.d.ts

@@ -0,0 +1,177 @@
+import { FirebaseApp } from '@firebase/app';
+import { NextFn } from '@firebase/util';
+import { Observer } from '@firebase/util';
+import { Unsubscribe } from '@firebase/util';
+
+/**
+ * Enables or disables Firebase Cloud Messaging message delivery metrics export to BigQuery. By
+ * default, message delivery metrics are not exported to BigQuery. Use this method to enable or
+ * disable the export at runtime.
+ *
+ * @param messaging - The `FirebaseMessaging` instance.
+ * @param enable - Whether Firebase Cloud Messaging should export message delivery metrics to
+ * BigQuery.
+ *
+ * @public
+ */
+export declare function experimentalSetDeliveryMetricsExportedToBigQueryEnabled(messaging: Messaging, enable: boolean): void;
+
+/**
+ * Options for features provided by the FCM SDK for Web. See {@link
+ * https://firebase.google.com/docs/reference/fcm/rest/v1/projects.messages#webpushfcmoptions |
+ * WebpushFcmOptions}.
+ *
+ * @public
+ */
+export declare interface FcmOptions {
+    /**
+     * The link to open when the user clicks on the notification.
+     */
+    link?: string;
+    /**
+     * The label associated with the message's analytics data.
+     */
+    analyticsLabel?: string;
+}
+
+/* Excluded from this release type: _FirebaseMessagingName */
+
+/**
+ * Retrieves a Firebase Cloud Messaging instance.
+ *
+ * @returns The Firebase Cloud Messaging instance associated with the provided firebase app.
+ *
+ * @public
+ */
+export declare function getMessaging(app?: FirebaseApp): Messaging;
+
+/**
+ * Options for {@link getToken}.
+ *
+ * @public
+ */
+export declare interface GetTokenOptions {
+    /**
+     * The public server key provided to push services. The key is used to
+     * authenticate push subscribers to receive push messages only from sending servers that hold
+     * the corresponding private key. If it is not provided, a default VAPID key is used. Note that some
+     * push services (Chrome Push Service) require a non-default VAPID key. Therefore, it is recommended
+     * to generate and import a VAPID key for your project with
+     * {@link https://firebase.google.com/docs/cloud-messaging/js/client#configure_web_credentials_in_your_app | Configure Web Credentials with FCM}.
+     * See
+     * {@link https://developers.google.com/web/fundamentals/push-notifications/web-push-protocol | The Web Push Protocol}
+     * for details on web push services.
+     */
+    vapidKey?: string;
+    /**
+     * The service worker registration for receiving push
+     * messaging. If the registration is not provided explicitly, you need to have a
+     * `firebase-messaging-sw.js` at your root location. See
+     * {@link https://firebase.google.com/docs/cloud-messaging/js/client#access_the_registration_token | Access the registration token}
+     * for more details.
+     */
+    serviceWorkerRegistration?: ServiceWorkerRegistration;
+}
+
+/**
+ * Checks whether all required APIs exist within SW Context
+ * @returns a Promise that resolves to a boolean.
+ *
+ * @public
+ */
+export declare function isSupported(): Promise<boolean>;
+
+/**
+ * Message payload that contains the notification payload that is represented with
+ * {@link NotificationPayload} and the data payload that contains an arbitrary
+ * number of key-value pairs sent by developers through the
+ * {@link https://firebase.google.com/docs/reference/fcm/rest/v1/projects.messages#notification | Send API}.
+ *
+ * @public
+ */
+export declare interface MessagePayload {
+    /**
+     * {@inheritdoc NotificationPayload}
+     */
+    notification?: NotificationPayload;
+    /**
+     * Arbitrary key/value payload.
+     */
+    data?: {
+        [key: string]: string;
+    };
+    /**
+     * {@inheritdoc FcmOptions}
+     */
+    fcmOptions?: FcmOptions;
+    /**
+     * The sender of this message.
+     */
+    from: string;
+    /**
+     * The collapse key of the message. See
+     * {@link https://firebase.google.com/docs/cloud-messaging/concept-options#collapsible_and_non-collapsible_messages | Non-collapsible and collapsible messages}
+     */
+    collapseKey: string;
+    /**
+     * The message ID of a message.
+     */
+    messageId: string;
+}
+
+/**
+ * Public interface of the Firebase Cloud Messaging SDK.
+ *
+ * @public
+ */
+export declare interface Messaging {
+    /**
+     * The {@link @firebase/app#FirebaseApp} this `Messaging` instance is associated with.
+     */
+    app: FirebaseApp;
+}
+export { NextFn }
+
+/**
+ * Display notification details. Details are sent through the
+ * {@link https://firebase.google.com/docs/reference/fcm/rest/v1/projects.messages#notification | Send API}.
+ *
+ * @public
+ */
+export declare interface NotificationPayload {
+    /**
+     * The notification's title.
+     */
+    title?: string;
+    /**
+     * The notification's body text.
+     */
+    body?: string;
+    /**
+     * The URL of an image that is downloaded on the device and displayed in the notification.
+     */
+    image?: string;
+    /**
+     * The URL to use for the notification's icon. If you don't send this key in the request,
+     * FCM displays the launcher icon specified in your app manifest.
+     */
+    icon?: string;
+}
+export { Observer }
+
+/**
+ * Called when a message is received while the app is in the background. An app is considered to be
+ * in the background if no active window is displayed.
+ *
+ * @param messaging - The {@link Messaging} instance.
+ * @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
+ *
+ * @public
+ */
+export declare function onBackgroundMessage(messaging: Messaging, nextOrObserver: NextFn<MessagePayload> | Observer<MessagePayload>): Unsubscribe;
+export { Unsubscribe }
+
+export { }

package/package.json

@@ -0,0 +1,103 @@
+{
+  "name": "@depup/firebase__messaging",
+  "version": "0.12.24-depup.0",
+  "description": "[DepUp] Dependency-bumped version of @firebase/messaging",
+  "author": "Firebase <firebase-support@google.com> (https://firebase.google.com/)",
+  "main": "dist/index.cjs.js",
+  "browser": "dist/esm/index.esm.js",
+  "module": "dist/esm/index.esm.js",
+  "sw": "dist/esm/index.sw.esm.js",
+  "sw-main": "dist/index.sw.cjs",
+  "exports": {
+    ".": {
+      "types": "./dist/index-public.d.ts",
+      "require": "./dist/index.cjs.js",
+      "module": "./dist/esm/index.esm.js",
+      "default": "./dist/esm/index.esm.js"
+    },
+    "./sw": {
+      "types": "./dist/sw/index-public.d.ts",
+      "require": "./dist/index.sw.cjs",
+      "default": "./dist/esm/index.sw.esm.js"
+    },
+    "./package.json": "./package.json"
+  },
+  "typings": "./dist/index-public.d.ts",
+  "files": [
+    "dist",
+    "sw/package.json",
+    "changes.json",
+    "README.md"
+  ],
+  "scripts": {
+    "lint": "eslint -c .eslintrc.js '**/*.ts' --ignore-path '../../.gitignore'",
+    "lint:fix": "eslint --fix -c .eslintrc.js '**/*.ts' --ignore-path '../../.gitignore'",
+    "build": "rollup -c && yarn api-report",
+    "build:deps": "lerna run --scope @firebase/'{app,messaging}' --include-dependencies build",
+    "build:release": "yarn build && yarn typings:public",
+    "dev": "rollup -c -w",
+    "test": "run-p --npm-path npm test:karma type-check lint ",
+    "test:integration": "run-p --npm-path npm test:karma type-check lint && cd ../../integration/messaging && npm run-script test",
+    "test:ci": "node ../../scripts/run_tests_in_ci.js",
+    "test:karma": "karma start",
+    "test:debug": "karma start --browsers=Chrome --auto-watch",
+    "api-report": "yarn api-report:main && yarn api-report:sw && yarn api-report:api-json",
+    "api-report:main": "ts-node-script ../../repo-scripts/prune-dts/extract-public-api.ts --package messaging --packageRoot . --typescriptDts ./dist/src/index.d.ts --rollupDts ./dist/private.d.ts --untrimmedRollupDts ./dist/internal.d.ts --publicDts ./dist/index-public.d.ts",
+    "api-report:sw": "ts-node-script ../../repo-scripts/prune-dts/extract-public-api.ts --package messaging-sw --packageRoot . --typescriptDts ./dist/src/index.sw.d.ts --rollupDts ./dist/sw/private.d.ts --untrimmedRollupDts ./dist/sw/internal.d.ts --publicDts ./dist/sw/index-public.d.ts",
+    "api-report:api-json": "api-extractor run --local --verbose",
+    "type-check": "tsc --noEmit",
+    "trusted-type-check": "tsec -p tsconfig.json --noEmit",
+    "typings:public": "node ../../scripts/build/use_typings.js ./dist/index-public.d.ts"
+  },
+  "license": "Apache-2.0",
+  "peerDependencies": {
+    "@firebase/app": "0.x"
+  },
+  "dependencies": {
+    "@firebase/installations": "0.6.20",
+    "@firebase/messaging-interop-types": "0.2.3",
+    "@firebase/util": "1.14.0",
+    "@firebase/component": "0.7.1",
+    "idb": "^8.0.3",
+    "tslib": "^2.8.1"
+  },
+  "devDependencies": {
+    "@firebase/app": "0.14.9",
+    "rollup": "2.79.2",
+    "rollup-plugin-typescript2": "0.36.0",
+    "@rollup/plugin-json": "6.1.0",
+    "ts-essentials": "10.0.4",
+    "typescript": "5.5.4"
+  },
+  "repository": {
+    "directory": "packages/messaging",
+    "type": "git",
+    "url": "git+https://github.com/firebase/firebase-js-sdk.git"
+  },
+  "bugs": {
+    "url": "https://github.com/firebase/firebase-js-sdk/issues"
+  },
+  "keywords": [
+    "depup",
+    "dependency-bumped",
+    "updated-deps",
+    "@firebase/messaging"
+  ],
+  "depup": {
+    "changes": {
+      "idb": {
+        "from": "7.1.1",
+        "to": "^8.0.3"
+      },
+      "tslib": {
+        "from": "^2.1.0",
+        "to": "^2.8.1"
+      }
+    },
+    "depsUpdated": 2,
+    "originalPackage": "@firebase/messaging",
+    "originalVersion": "0.12.24",
+    "processedAt": "2026-03-17T16:31:15.579Z",
+    "smokeTest": "passed"
+  }
+}

package/sw/package.json

@@ -0,0 +1,8 @@
+{
+  "name": "@firebase/messaging-sw",
+  "description": "",
+  "author": "Firebase <firebase-support@google.com> (https://firebase.google.com/)",
+  "main": "../dist/index.sw.cjs",
+  "module": "../dist/esm/index.sw.esm.js",
+  "typings": "../dist/src/index.sw.d.ts"
+}