tauri-plugin-fcm 0.1.0

package/LICENSE-APACHE

@@ -0,0 +1,190 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of Your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   Copyright 2026 tauri-plugin-fcm contributors
+
+   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.

package/LICENSE-MIT

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 tauri-plugin-fcm contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,218 @@
+# tauri-plugin-fcm
+
+[![Crates.io](https://img.shields.io/crates/v/tauri-plugin-fcm.svg)](https://crates.io/crates/tauri-plugin-fcm)
+[![npm](https://img.shields.io/npm/v/tauri-plugin-fcm.svg)](https://www.npmjs.com/package/tauri-plugin-fcm)
+[![License](https://img.shields.io/badge/license-MIT%2FApache--2.0-blue.svg)](#license)
+
+Firebase Cloud Messaging for Tauri 2 mobile apps.
+
+The plugin returns FCM registration tokens on both iOS and Android. On iOS it handles the APNs to FCM exchange so your app uses one token type across both platforms.
+
+| Platform | Supported |
+| --- | --- |
+| Android | Yes |
+| iOS | Yes |
+| macOS | No |
+| Windows | No |
+| Linux | No |
+
+## Install
+
+Add the Rust crate to `src-tauri/Cargo.toml`:
+
+```toml
+[dependencies]
+tauri-plugin-fcm = "0.1.0"
+```
+
+Install the JavaScript guest bindings:
+
+```sh
+pnpm add tauri-plugin-fcm
+# or
+bun add tauri-plugin-fcm
+# or
+npm add tauri-plugin-fcm
+# or
+yarn add tauri-plugin-fcm
+```
+
+Register the plugin in your Tauri app:
+
+```rust
+fn main() {
+    let builder = tauri::Builder::default();
+    #[cfg(mobile)]
+    let builder = builder.plugin(tauri_plugin_fcm::init());
+
+    builder
+        .run(tauri::generate_context!())
+        .expect("error while running tauri application");
+}
+```
+
+Add the capability permission:
+
+```json
+{
+  "permissions": [
+    "fcm:default"
+  ]
+}
+```
+
+## API
+
+```ts
+import {
+  checkPermissions,
+  createChannel,
+  deleteToken,
+  getToken,
+  onPushError,
+  onTokenRefresh,
+  register,
+  requestPermissions,
+  sendNotification,
+} from "tauri-plugin-fcm";
+```
+
+### Functions
+
+- `checkPermissions(): Promise<PermissionState>`
+- `requestPermissions(): Promise<PermissionState>`
+- `register(): Promise<void>`
+- `getToken(): Promise<{ token: string }>`
+- `deleteToken(): Promise<void>`
+- `createChannel(options: CreateChannelOptions): Promise<void>`
+- `sendNotification(options: SendNotificationOptions): Promise<void>`
+- `onTokenRefresh(handler): Promise<PluginListener>`
+- `onPushError(handler): Promise<PluginListener>`
+
+`PermissionState` comes from `@tauri-apps/api/core` and can be:
+
+- `granted`
+- `denied`
+- `prompt`
+- `prompt-with-rationale` (Android only)
+
+### Types
+
+#### `CreateChannelOptions`
+
+```ts
+interface CreateChannelOptions {
+  /** Unique identifier for the channel */
+  id: string;
+  /** Display name for the channel */
+  name: string;
+  /** Importance level for the channel (0-5) */
+  importance: number;
+}
+```
+
+#### `SendNotificationOptions`
+
+```ts
+interface SendNotificationOptions {
+  /** Notification title */
+  title: string;
+  /** Notification body text */
+  body?: string;
+  /** Icon identifier or URL */
+  icon?: string;
+  /** Notification ID */
+  id?: number;
+  /** Channel ID (Android) */
+  channelId?: string;
+}
+```
+
+## Usage
+
+### Basic Setup
+
+```ts
+import {
+  checkPermissions,
+  getToken,
+  onPushError,
+  onTokenRefresh,
+  register,
+  requestPermissions,
+} from "tauri-plugin-fcm";
+
+let permission = await checkPermissions();
+
+if (permission === "prompt" || permission === "prompt-with-rationale") {
+  permission = await requestPermissions();
+}
+
+if (permission === "granted") {
+  await register();
+  const { token } = await getToken();
+  console.log("FCM token:", token);
+}
+
+const tokenListener = await onTokenRefresh((event) => {
+  console.log("New FCM token:", event.token);
+});
+
+const errorListener = await onPushError((event) => {
+  console.error("Push error:", event.error);
+});
+
+// Later:
+await tokenListener.unregister();
+await errorListener.unregister();
+```
+
+### Sending Notifications
+
+```ts
+import { createChannel, sendNotification } from "tauri-plugin-fcm";
+
+// Create a notification channel (Android only, no-op on iOS)
+await createChannel({
+  id: "default",
+  name: "Default Notifications",
+  importance: 4,
+});
+
+// Send a notification
+await sendNotification({
+  title: "Hello",
+  body: "This is a test notification",
+  channelId: "default",
+});
+```
+
+## Platform setup
+
+### iOS
+
+1. Add `GoogleService-Info.plist` to your generated iOS project under `src-tauri/gen/apple/<app-name>_iOS/` and make sure it is included in the iOS app target.
+2. Enable the `aps-environment` entitlement.
+3. Enable Push Notifications and Background Modes with Remote notifications.
+4. If you disable `FirebaseAppDelegateProxyEnabled`, make sure APNs callbacks still reach Firebase.
+
+### Android
+
+1. Add `google-services.json` to `src-tauri/gen/android/app`.
+2. Apply the Google Services Gradle plugin in the Android app.
+3. Keep `POST_NOTIFICATIONS` available for Android 13 and later.
+
+## Notes
+
+- This is a mobile-only plugin. If you share Tauri setup code across desktop and mobile targets, gate registration with `#[cfg(mobile)]`.
+- On Android, `register()` is effectively a no-op because FCM registration is automatic.
+- On iOS simulators, remote notification transport is unavailable. The plugin emits `push-error` instead of crashing.
+- `createChannel()` is Android-only and is a no-op on iOS.
+- On Android API 26+, calling `sendNotification()` before `createChannel()` will silently drop the notification.
+
+## License
+
+Licensed under either of:
+
+- Apache License, Version 2.0 ([LICENSE-APACHE](LICENSE-APACHE))
+- MIT License ([LICENSE-MIT](LICENSE-MIT))

package/dist-js/index.cjs

@@ -0,0 +1,91 @@
+'use strict';
+
+var core = require('@tauri-apps/api/core');
+
+/**
+ * Retrieves the current FCM registration token.
+ * @returns Promise resolving to an object containing the FCM token
+ * @throws Error if token retrieval fails
+ */
+async function getToken() {
+    return await core.invoke("plugin:fcm|get_token");
+}
+/**
+ * Requests notification permissions from the user.
+ * @returns Promise resolving to the notification permission state
+ * @throws Error if permission request fails
+ */
+async function requestPermissions() {
+    return await core.requestPermissions("fcm").then((result) => result.notification);
+}
+/**
+ * Checks the current notification permission status.
+ * @returns Promise resolving to the current notification permission state
+ * @throws Error if permission check fails
+ */
+async function checkPermissions() {
+    return await core.checkPermissions("fcm").then((result) => result.notification);
+}
+/**
+ * Registers the device for push notifications.
+ * On iOS, this triggers the native registration flow.
+ * On Android, this is a no-op as FCM auto-registers.
+ * @returns Promise that resolves when registration is complete
+ * @throws Error if registration fails
+ */
+async function register() {
+    await core.invoke("plugin:fcm|register");
+}
+/**
+ * Deletes the current FCM registration token.
+ * @returns Promise that resolves when token deletion is complete
+ * @throws Error if token deletion fails
+ */
+async function deleteToken() {
+    await core.invoke("plugin:fcm|delete_token");
+}
+/**
+ * Registers a listener for FCM token refresh events.
+ * @param handler - Callback function invoked when token is refreshed
+ * @returns Promise resolving to a PluginListener that can be used to unlisten
+ */
+async function onTokenRefresh(handler) {
+    return await core.addPluginListener("fcm", "token-refresh", handler);
+}
+/**
+ * Registers a listener for push notification error events.
+ * @param handler - Callback function invoked when a push error occurs
+ * @returns Promise resolving to a PluginListener that can be used to unlisten
+ */
+async function onPushError(handler) {
+    return await core.addPluginListener("fcm", "push-error", handler);
+}
+/**
+ * Creates a notification channel (Android only, no-op on iOS).
+ * @param options - Channel configuration options
+ * @returns Promise that resolves when channel creation is complete
+ * @throws Error if channel creation fails
+ */
+async function createChannel(options) {
+    await core.invoke("plugin:fcm|create_channel", options);
+}
+/**
+ * Sends a notification to the user.
+ * @param options - Notification configuration options
+ * @returns Promise that resolves when notification is sent
+ * @throws Error if notification sending fails
+ */
+async function sendNotification(options) {
+    await core.invoke("plugin:fcm|send_notification", options);
+}
+
+exports.checkPermissions = checkPermissions;
+exports.createChannel = createChannel;
+exports.deleteToken = deleteToken;
+exports.getToken = getToken;
+exports.onPushError = onPushError;
+exports.onTokenRefresh = onTokenRefresh;
+exports.register = register;
+exports.requestPermissions = requestPermissions;
+exports.sendNotification = sendNotification;
+//# sourceMappingURL=index.cjs.map

package/dist-js/index.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.cjs","sources":["../guest-js/index.ts"],"sourcesContent":["import {\n  addPluginListener,\n  checkPermissions as checkPermissions_,\n  invoke,\n  type PermissionState,\n  type PluginListener,\n  requestPermissions as requestPermissions_,\n} from \"@tauri-apps/api/core\";\n\n/**\n * Represents an FCM token response.\n */\nexport interface FcmToken {\n  /** The FCM registration token */\n  token: string;\n}\n\nexport type { PermissionState } from \"@tauri-apps/api/core\";\n\n/**\n * Event emitted when FCM token is refreshed.\n */\nexport interface TokenRefreshEvent {\n  /** The new FCM registration token */\n  token: string;\n}\n\n/**\n * Event emitted when a push notification error occurs.\n */\nexport interface PushErrorEvent {\n  /** Error message describing the push notification error */\n  error: string;\n}\n\n/**\n * Options for creating a notification channel (Android only).\n */\nexport interface CreateChannelOptions extends Record<string, unknown> {\n  /** Unique identifier for the channel */\n  id: string;\n  /** Display name for the channel */\n  name: string;\n  /** Importance level for the channel (0-5) */\n  importance: number;\n}\n\n/**\n * Options for sending a notification.\n */\nexport interface SendNotificationOptions extends Record<string, unknown> {\n  /** Notification title */\n  title: string;\n  /** Notification body text */\n  body?: string;\n  /** Icon identifier or URL */\n  icon?: string;\n  /** Notification ID */\n  id?: number;\n  /** Channel ID (Android) */\n  channelId?: string;\n}\n\n/**\n * Retrieves the current FCM registration token.\n * @returns Promise resolving to an object containing the FCM token\n * @throws Error if token retrieval fails\n */\nexport async function getToken(): Promise<FcmToken> {\n  return await invoke<FcmToken>(\"plugin:fcm|get_token\");\n}\n\n/**\n * Requests notification permissions from the user.\n * @returns Promise resolving to the notification permission state\n * @throws Error if permission request fails\n */\nexport async function requestPermissions(): Promise<PermissionState> {\n  return await requestPermissions_<{ notification: PermissionState }>(\n    \"fcm\",\n  ).then((result) => result.notification);\n}\n\n/**\n * Checks the current notification permission status.\n * @returns Promise resolving to the current notification permission state\n * @throws Error if permission check fails\n */\nexport async function checkPermissions(): Promise<PermissionState> {\n  return await checkPermissions_<{ notification: PermissionState }>(\"fcm\").then(\n    (result) => result.notification,\n  );\n}\n\n/**\n * Registers the device for push notifications.\n * On iOS, this triggers the native registration flow.\n * On Android, this is a no-op as FCM auto-registers.\n * @returns Promise that resolves when registration is complete\n * @throws Error if registration fails\n */\nexport async function register(): Promise<void> {\n  await invoke(\"plugin:fcm|register\");\n}\n\n/**\n * Deletes the current FCM registration token.\n * @returns Promise that resolves when token deletion is complete\n * @throws Error if token deletion fails\n */\nexport async function deleteToken(): Promise<void> {\n  await invoke(\"plugin:fcm|delete_token\");\n}\n\n/**\n * Registers a listener for FCM token refresh events.\n * @param handler - Callback function invoked when token is refreshed\n * @returns Promise resolving to a PluginListener that can be used to unlisten\n */\nexport async function onTokenRefresh(\n  handler: (event: TokenRefreshEvent) => void,\n): Promise<PluginListener> {\n  return await addPluginListener(\"fcm\", \"token-refresh\", handler);\n}\n\n/**\n * Registers a listener for push notification error events.\n * @param handler - Callback function invoked when a push error occurs\n * @returns Promise resolving to a PluginListener that can be used to unlisten\n */\nexport async function onPushError(\n  handler: (event: PushErrorEvent) => void,\n): Promise<PluginListener> {\n  return await addPluginListener(\"fcm\", \"push-error\", handler);\n}\n\n/**\n * Creates a notification channel (Android only, no-op on iOS).\n * @param options - Channel configuration options\n * @returns Promise that resolves when channel creation is complete\n * @throws Error if channel creation fails\n */\nexport async function createChannel(\n  options: CreateChannelOptions,\n): Promise<void> {\n  await invoke(\"plugin:fcm|create_channel\", options);\n}\n\n/**\n * Sends a notification to the user.\n * @param options - Notification configuration options\n * @returns Promise that resolves when notification is sent\n * @throws Error if notification sending fails\n */\nexport async function sendNotification(\n  options: SendNotificationOptions,\n): Promise<void> {\n  await invoke(\"plugin:fcm|send_notification\", options);\n}\n"],"names":["invoke","requestPermissions_","checkPermissions_","addPluginListener"],"mappings":";;;;AA+DA;;;;AAIG;AACI,eAAe,QAAQ,GAAA;AAC5B,IAAA,OAAO,MAAMA,WAAM,CAAW,sBAAsB,CAAC;AACvD;AAEA;;;;AAIG;AACI,eAAe,kBAAkB,GAAA;AACtC,IAAA,OAAO,MAAMC,uBAAmB,CAC9B,KAAK,CACN,CAAC,IAAI,CAAC,CAAC,MAAM,KAAK,MAAM,CAAC,YAAY,CAAC;AACzC;AAEA;;;;AAIG;AACI,eAAe,gBAAgB,GAAA;AACpC,IAAA,OAAO,MAAMC,qBAAiB,CAAoC,KAAK,CAAC,CAAC,IAAI,CAC3E,CAAC,MAAM,KAAK,MAAM,CAAC,YAAY,CAChC;AACH;AAEA;;;;;;AAMG;AACI,eAAe,QAAQ,GAAA;AAC5B,IAAA,MAAMF,WAAM,CAAC,qBAAqB,CAAC;AACrC;AAEA;;;;AAIG;AACI,eAAe,WAAW,GAAA;AAC/B,IAAA,MAAMA,WAAM,CAAC,yBAAyB,CAAC;AACzC;AAEA;;;;AAIG;AACI,eAAe,cAAc,CAClC,OAA2C,EAAA;IAE3C,OAAO,MAAMG,sBAAiB,CAAC,KAAK,EAAE,eAAe,EAAE,OAAO,CAAC;AACjE;AAEA;;;;AAIG;AACI,eAAe,WAAW,CAC/B,OAAwC,EAAA;IAExC,OAAO,MAAMA,sBAAiB,CAAC,KAAK,EAAE,YAAY,EAAE,OAAO,CAAC;AAC9D;AAEA;;;;;AAKG;AACI,eAAe,aAAa,CACjC,OAA6B,EAAA;AAE7B,IAAA,MAAMH,WAAM,CAAC,2BAA2B,EAAE,OAAO,CAAC;AACpD;AAEA;;;;;AAKG;AACI,eAAe,gBAAgB,CACpC,OAAgC,EAAA;AAEhC,IAAA,MAAMA,WAAM,CAAC,8BAA8B,EAAE,OAAO,CAAC;AACvD;;;;;;;;;;;;"}

package/dist-js/index.d.ts

@@ -0,0 +1,107 @@
+import { type PermissionState, type PluginListener } from "@tauri-apps/api/core";
+/**
+ * Represents an FCM token response.
+ */
+export interface FcmToken {
+    /** The FCM registration token */
+    token: string;
+}
+export type { PermissionState } from "@tauri-apps/api/core";
+/**
+ * Event emitted when FCM token is refreshed.
+ */
+export interface TokenRefreshEvent {
+    /** The new FCM registration token */
+    token: string;
+}
+/**
+ * Event emitted when a push notification error occurs.
+ */
+export interface PushErrorEvent {
+    /** Error message describing the push notification error */
+    error: string;
+}
+/**
+ * Options for creating a notification channel (Android only).
+ */
+export interface CreateChannelOptions extends Record<string, unknown> {
+    /** Unique identifier for the channel */
+    id: string;
+    /** Display name for the channel */
+    name: string;
+    /** Importance level for the channel (0-5) */
+    importance: number;
+}
+/**
+ * Options for sending a notification.
+ */
+export interface SendNotificationOptions extends Record<string, unknown> {
+    /** Notification title */
+    title: string;
+    /** Notification body text */
+    body?: string;
+    /** Icon identifier or URL */
+    icon?: string;
+    /** Notification ID */
+    id?: number;
+    /** Channel ID (Android) */
+    channelId?: string;
+}
+/**
+ * Retrieves the current FCM registration token.
+ * @returns Promise resolving to an object containing the FCM token
+ * @throws Error if token retrieval fails
+ */
+export declare function getToken(): Promise<FcmToken>;
+/**
+ * Requests notification permissions from the user.
+ * @returns Promise resolving to the notification permission state
+ * @throws Error if permission request fails
+ */
+export declare function requestPermissions(): Promise<PermissionState>;
+/**
+ * Checks the current notification permission status.
+ * @returns Promise resolving to the current notification permission state
+ * @throws Error if permission check fails
+ */
+export declare function checkPermissions(): Promise<PermissionState>;
+/**
+ * Registers the device for push notifications.
+ * On iOS, this triggers the native registration flow.
+ * On Android, this is a no-op as FCM auto-registers.
+ * @returns Promise that resolves when registration is complete
+ * @throws Error if registration fails
+ */
+export declare function register(): Promise<void>;
+/**
+ * Deletes the current FCM registration token.
+ * @returns Promise that resolves when token deletion is complete
+ * @throws Error if token deletion fails
+ */
+export declare function deleteToken(): Promise<void>;
+/**
+ * Registers a listener for FCM token refresh events.
+ * @param handler - Callback function invoked when token is refreshed
+ * @returns Promise resolving to a PluginListener that can be used to unlisten
+ */
+export declare function onTokenRefresh(handler: (event: TokenRefreshEvent) => void): Promise<PluginListener>;
+/**
+ * Registers a listener for push notification error events.
+ * @param handler - Callback function invoked when a push error occurs
+ * @returns Promise resolving to a PluginListener that can be used to unlisten
+ */
+export declare function onPushError(handler: (event: PushErrorEvent) => void): Promise<PluginListener>;
+/**
+ * Creates a notification channel (Android only, no-op on iOS).
+ * @param options - Channel configuration options
+ * @returns Promise that resolves when channel creation is complete
+ * @throws Error if channel creation fails
+ */
+export declare function createChannel(options: CreateChannelOptions): Promise<void>;
+/**
+ * Sends a notification to the user.
+ * @param options - Notification configuration options
+ * @returns Promise that resolves when notification is sent
+ * @throws Error if notification sending fails
+ */
+export declare function sendNotification(options: SendNotificationOptions): Promise<void>;

package/dist-js/index.js

@@ -0,0 +1,81 @@
+import { invoke, requestPermissions as requestPermissions$1, checkPermissions as checkPermissions$1, addPluginListener } from '@tauri-apps/api/core';
+
+/**
+ * Retrieves the current FCM registration token.
+ * @returns Promise resolving to an object containing the FCM token
+ * @throws Error if token retrieval fails
+ */
+async function getToken() {
+    return await invoke("plugin:fcm|get_token");
+}
+/**
+ * Requests notification permissions from the user.
+ * @returns Promise resolving to the notification permission state
+ * @throws Error if permission request fails
+ */
+async function requestPermissions() {
+    return await requestPermissions$1("fcm").then((result) => result.notification);
+}
+/**
+ * Checks the current notification permission status.
+ * @returns Promise resolving to the current notification permission state
+ * @throws Error if permission check fails
+ */
+async function checkPermissions() {
+    return await checkPermissions$1("fcm").then((result) => result.notification);
+}
+/**
+ * Registers the device for push notifications.
+ * On iOS, this triggers the native registration flow.
+ * On Android, this is a no-op as FCM auto-registers.
+ * @returns Promise that resolves when registration is complete
+ * @throws Error if registration fails
+ */
+async function register() {
+    await invoke("plugin:fcm|register");
+}
+/**
+ * Deletes the current FCM registration token.
+ * @returns Promise that resolves when token deletion is complete
+ * @throws Error if token deletion fails
+ */
+async function deleteToken() {
+    await invoke("plugin:fcm|delete_token");
+}
+/**
+ * Registers a listener for FCM token refresh events.
+ * @param handler - Callback function invoked when token is refreshed
+ * @returns Promise resolving to a PluginListener that can be used to unlisten
+ */
+async function onTokenRefresh(handler) {
+    return await addPluginListener("fcm", "token-refresh", handler);
+}
+/**
+ * Registers a listener for push notification error events.
+ * @param handler - Callback function invoked when a push error occurs
+ * @returns Promise resolving to a PluginListener that can be used to unlisten
+ */
+async function onPushError(handler) {
+    return await addPluginListener("fcm", "push-error", handler);
+}
+/**
+ * Creates a notification channel (Android only, no-op on iOS).
+ * @param options - Channel configuration options
+ * @returns Promise that resolves when channel creation is complete
+ * @throws Error if channel creation fails
+ */
+async function createChannel(options) {
+    await invoke("plugin:fcm|create_channel", options);
+}
+/**
+ * Sends a notification to the user.
+ * @param options - Notification configuration options
+ * @returns Promise that resolves when notification is sent
+ * @throws Error if notification sending fails
+ */
+async function sendNotification(options) {
+    await invoke("plugin:fcm|send_notification", options);
+}
+
+export { checkPermissions, createChannel, deleteToken, getToken, onPushError, onTokenRefresh, register, requestPermissions, sendNotification };
+//# sourceMappingURL=index.js.map

package/dist-js/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sources":["../guest-js/index.ts"],"sourcesContent":["import {\n  addPluginListener,\n  checkPermissions as checkPermissions_,\n  invoke,\n  type PermissionState,\n  type PluginListener,\n  requestPermissions as requestPermissions_,\n} from \"@tauri-apps/api/core\";\n\n/**\n * Represents an FCM token response.\n */\nexport interface FcmToken {\n  /** The FCM registration token */\n  token: string;\n}\n\nexport type { PermissionState } from \"@tauri-apps/api/core\";\n\n/**\n * Event emitted when FCM token is refreshed.\n */\nexport interface TokenRefreshEvent {\n  /** The new FCM registration token */\n  token: string;\n}\n\n/**\n * Event emitted when a push notification error occurs.\n */\nexport interface PushErrorEvent {\n  /** Error message describing the push notification error */\n  error: string;\n}\n\n/**\n * Options for creating a notification channel (Android only).\n */\nexport interface CreateChannelOptions extends Record<string, unknown> {\n  /** Unique identifier for the channel */\n  id: string;\n  /** Display name for the channel */\n  name: string;\n  /** Importance level for the channel (0-5) */\n  importance: number;\n}\n\n/**\n * Options for sending a notification.\n */\nexport interface SendNotificationOptions extends Record<string, unknown> {\n  /** Notification title */\n  title: string;\n  /** Notification body text */\n  body?: string;\n  /** Icon identifier or URL */\n  icon?: string;\n  /** Notification ID */\n  id?: number;\n  /** Channel ID (Android) */\n  channelId?: string;\n}\n\n/**\n * Retrieves the current FCM registration token.\n * @returns Promise resolving to an object containing the FCM token\n * @throws Error if token retrieval fails\n */\nexport async function getToken(): Promise<FcmToken> {\n  return await invoke<FcmToken>(\"plugin:fcm|get_token\");\n}\n\n/**\n * Requests notification permissions from the user.\n * @returns Promise resolving to the notification permission state\n * @throws Error if permission request fails\n */\nexport async function requestPermissions(): Promise<PermissionState> {\n  return await requestPermissions_<{ notification: PermissionState }>(\n    \"fcm\",\n  ).then((result) => result.notification);\n}\n\n/**\n * Checks the current notification permission status.\n * @returns Promise resolving to the current notification permission state\n * @throws Error if permission check fails\n */\nexport async function checkPermissions(): Promise<PermissionState> {\n  return await checkPermissions_<{ notification: PermissionState }>(\"fcm\").then(\n    (result) => result.notification,\n  );\n}\n\n/**\n * Registers the device for push notifications.\n * On iOS, this triggers the native registration flow.\n * On Android, this is a no-op as FCM auto-registers.\n * @returns Promise that resolves when registration is complete\n * @throws Error if registration fails\n */\nexport async function register(): Promise<void> {\n  await invoke(\"plugin:fcm|register\");\n}\n\n/**\n * Deletes the current FCM registration token.\n * @returns Promise that resolves when token deletion is complete\n * @throws Error if token deletion fails\n */\nexport async function deleteToken(): Promise<void> {\n  await invoke(\"plugin:fcm|delete_token\");\n}\n\n/**\n * Registers a listener for FCM token refresh events.\n * @param handler - Callback function invoked when token is refreshed\n * @returns Promise resolving to a PluginListener that can be used to unlisten\n */\nexport async function onTokenRefresh(\n  handler: (event: TokenRefreshEvent) => void,\n): Promise<PluginListener> {\n  return await addPluginListener(\"fcm\", \"token-refresh\", handler);\n}\n\n/**\n * Registers a listener for push notification error events.\n * @param handler - Callback function invoked when a push error occurs\n * @returns Promise resolving to a PluginListener that can be used to unlisten\n */\nexport async function onPushError(\n  handler: (event: PushErrorEvent) => void,\n): Promise<PluginListener> {\n  return await addPluginListener(\"fcm\", \"push-error\", handler);\n}\n\n/**\n * Creates a notification channel (Android only, no-op on iOS).\n * @param options - Channel configuration options\n * @returns Promise that resolves when channel creation is complete\n * @throws Error if channel creation fails\n */\nexport async function createChannel(\n  options: CreateChannelOptions,\n): Promise<void> {\n  await invoke(\"plugin:fcm|create_channel\", options);\n}\n\n/**\n * Sends a notification to the user.\n * @param options - Notification configuration options\n * @returns Promise that resolves when notification is sent\n * @throws Error if notification sending fails\n */\nexport async function sendNotification(\n  options: SendNotificationOptions,\n): Promise<void> {\n  await invoke(\"plugin:fcm|send_notification\", options);\n}\n"],"names":["requestPermissions_","checkPermissions_"],"mappings":";;AA+DA;;;;AAIG;AACI,eAAe,QAAQ,GAAA;AAC5B,IAAA,OAAO,MAAM,MAAM,CAAW,sBAAsB,CAAC;AACvD;AAEA;;;;AAIG;AACI,eAAe,kBAAkB,GAAA;AACtC,IAAA,OAAO,MAAMA,oBAAmB,CAC9B,KAAK,CACN,CAAC,IAAI,CAAC,CAAC,MAAM,KAAK,MAAM,CAAC,YAAY,CAAC;AACzC;AAEA;;;;AAIG;AACI,eAAe,gBAAgB,GAAA;AACpC,IAAA,OAAO,MAAMC,kBAAiB,CAAoC,KAAK,CAAC,CAAC,IAAI,CAC3E,CAAC,MAAM,KAAK,MAAM,CAAC,YAAY,CAChC;AACH;AAEA;;;;;;AAMG;AACI,eAAe,QAAQ,GAAA;AAC5B,IAAA,MAAM,MAAM,CAAC,qBAAqB,CAAC;AACrC;AAEA;;;;AAIG;AACI,eAAe,WAAW,GAAA;AAC/B,IAAA,MAAM,MAAM,CAAC,yBAAyB,CAAC;AACzC;AAEA;;;;AAIG;AACI,eAAe,cAAc,CAClC,OAA2C,EAAA;IAE3C,OAAO,MAAM,iBAAiB,CAAC,KAAK,EAAE,eAAe,EAAE,OAAO,CAAC;AACjE;AAEA;;;;AAIG;AACI,eAAe,WAAW,CAC/B,OAAwC,EAAA;IAExC,OAAO,MAAM,iBAAiB,CAAC,KAAK,EAAE,YAAY,EAAE,OAAO,CAAC;AAC9D;AAEA;;;;;AAKG;AACI,eAAe,aAAa,CACjC,OAA6B,EAAA;AAE7B,IAAA,MAAM,MAAM,CAAC,2BAA2B,EAAE,OAAO,CAAC;AACpD;AAEA;;;;;AAKG;AACI,eAAe,gBAAgB,CACpC,OAAgC,EAAA;AAEhC,IAAA,MAAM,MAAM,CAAC,8BAA8B,EAAE,OAAO,CAAC;AACvD;;;;"}

package/package.json

@@ -0,0 +1,63 @@
+{
+  "name": "tauri-plugin-fcm",
+  "version": "0.1.0",
+  "description": "Tauri 2 plugin for Firebase Cloud Messaging (FCM) — iOS APNs→FCM token exchange + Android FCM",
+  "license": "MIT OR Apache-2.0",
+  "type": "module",
+  "packageManager": "bun@1.3.10",
+  "types": "./dist-js/index.d.ts",
+  "main": "./dist-js/index.cjs",
+  "module": "./dist-js/index.js",
+  "exports": {
+    ".": {
+      "types": "./dist-js/index.d.ts",
+      "import": "./dist-js/index.js",
+      "require": "./dist-js/index.cjs"
+    }
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/srod/tauri-plugin-fcm"
+  },
+  "files": [
+    "dist-js",
+    "README.md",
+    "LICENSE-MIT",
+    "LICENSE-APACHE"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "engines": {
+    "node": ">=18"
+  },
+  "scripts": {
+    "build": "rollup -c",
+    "lint": "bunx biome check .",
+    "lint:fix": "bunx biome check --write .",
+    "format": "bunx biome format --write .",
+    "format:check": "bunx biome format .",
+    "typecheck": "bunx tsc --noEmit --project guest-js/tsconfig.json",
+    "prepublishOnly": "bun run build",
+    "test": "bun run build && node --test"
+  },
+  "dependencies": {
+    "@tauri-apps/api": "^2.0.0"
+  },
+  "devDependencies": {
+    "@biomejs/biome": "2.4.6",
+    "typescript": "^5.0.0",
+    "@rollup/plugin-typescript": "^12.0.0",
+    "rollup": "^4.0.0",
+    "tslib": "^2.6.0"
+  },
+  "keywords": [
+    "tauri",
+    "tauri-plugin",
+    "fcm",
+    "firebase",
+    "push-notifications",
+    "ios",
+    "android"
+  ]
+}