@choochmeque/tauri-plugin-notifications-api 0.3.0 → 0.3.4

package/dist-js/index.cjs

@@ -145,6 +145,24 @@ async function requestPermission() {
 async function registerForPushNotifications() {
     return await core.invoke("plugin:notifications|register_for_push_notifications");
 }
+/**
+ * Unregisters the app from push notifications (mobile).
+ *
+ * This removes the device's push notification token and stops receiving
+ * remote push notifications.
+ *
+ * @example
+ * ```typescript
+ * import { unregisterForPushNotifications } from '@choochmeque/tauri-plugin-notifications-api';
+ * await unregisterForPushNotifications();
+ * console.log('Unregistered from push notifications');
+ * ```
+ *
+ * @returns A promise resolving when unregistration is complete.
+ */
+async function unregisterForPushNotifications() {
+    return await core.invoke("plugin:notifications|unregister_for_push_notifications");
+}
 /**
  * Sends a notification to the user.
  * @example
@@ -361,6 +379,42 @@ async function onNotificationReceived(cb) {
 async function onAction(cb) {
     return await core.addPluginListener("notifications", "actionPerformed", cb);
 }
+/**
+ * Registers a listener for notification click/tap events.
+ * This fires when the user taps on a notification (both push and local).
+ *
+ * This function handles cold-start scenarios where the app is launched by
+ * tapping a notification. Any pending notification click data is automatically
+ * delivered when the listener is registered.
+ *
+ * @example
+ * ```typescript
+ * import { onNotificationClicked } from '@choochmeque/tauri-plugin-notifications-api';
+ * const unlisten = await onNotificationClicked((data) => {
+ *   console.log('Notification clicked, id:', data.id);
+ *   console.log('Custom data:', data.data);
+ * });
+ * ```
+ *
+ * @param cb - Callback function to handle notification clicks.
+ * @returns A promise resolving to a function that removes the listener.
+ */
+async function onNotificationClicked(cb) {
+    const listener = await core.addPluginListener("notifications", "notificationClicked", cb);
+    // Tell native side listener is active (triggers pending if any)
+    await core.invoke("plugin:notifications|set_click_listener_active", {
+        active: true,
+    });
+    // Return wrapped listener that notifies native side on unregister
+    return {
+        unregister: async () => {
+            await core.invoke("plugin:notifications|set_click_listener_active", {
+                active: false,
+            });
+            return listener.unregister();
+        },
+    };
+}
 
 exports.Schedule = Schedule;
 exports.active = active;
@@ -370,6 +424,7 @@ exports.channels = channels;
 exports.createChannel = createChannel;
 exports.isPermissionGranted = isPermissionGranted;
 exports.onAction = onAction;
+exports.onNotificationClicked = onNotificationClicked;
 exports.onNotificationReceived = onNotificationReceived;
 exports.pending = pending;
 exports.registerActionTypes = registerActionTypes;
@@ -379,3 +434,4 @@ exports.removeAllActive = removeAllActive;
 exports.removeChannel = removeChannel;
 exports.requestPermission = requestPermission;
 exports.sendNotification = sendNotification;
+exports.unregisterForPushNotifications = unregisterForPushNotifications;

package/dist-js/index.d.ts

@@ -387,6 +387,22 @@ declare function requestPermission(): Promise<NotificationPermission>;
  * @returns A promise resolving to the device push token.
  */
 declare function registerForPushNotifications(): Promise<string>;
+/**
+ * Unregisters the app from push notifications (mobile).
+ *
+ * This removes the device's push notification token and stops receiving
+ * remote push notifications.
+ *
+ * @example
+ * ```typescript
+ * import { unregisterForPushNotifications } from '@choochmeque/tauri-plugin-notifications-api';
+ * await unregisterForPushNotifications();
+ * console.log('Unregistered from push notifications');
+ * ```
+ *
+ * @returns A promise resolving when unregistration is complete.
+ */
+declare function unregisterForPushNotifications(): Promise<string>;
 /**
  * Sends a notification to the user.
  * @example
@@ -574,5 +590,35 @@ declare function onNotificationReceived(cb: (notification: Options) => void): Pr
  * @returns A promise resolving to a function that removes the listener.
  */
 declare function onAction(cb: (notification: Options) => void): Promise<PluginListener>;
-export type { Attachment, Options, Action, ActionType, PendingNotification, ActiveNotification, Channel, ScheduleInterval, };
-export { Importance, Visibility, sendNotification, requestPermission, isPermissionGranted, registerForPushNotifications, registerActionTypes, pending, cancel, cancelAll, active, removeActive, removeAllActive, createChannel, removeChannel, channels, onNotificationReceived, onAction, Schedule, ScheduleEvery, };
+/**
+ * Data received when a notification is clicked/tapped.
+ */
+interface NotificationClickedData {
+    /** Notification ID */
+    id: number;
+    /** Custom data payload attached to the notification */
+    data?: Record<string, string>;
+}
+/**
+ * Registers a listener for notification click/tap events.
+ * This fires when the user taps on a notification (both push and local).
+ *
+ * This function handles cold-start scenarios where the app is launched by
+ * tapping a notification. Any pending notification click data is automatically
+ * delivered when the listener is registered.
+ *
+ * @example
+ * ```typescript
+ * import { onNotificationClicked } from '@choochmeque/tauri-plugin-notifications-api';
+ * const unlisten = await onNotificationClicked((data) => {
+ *   console.log('Notification clicked, id:', data.id);
+ *   console.log('Custom data:', data.data);
+ * });
+ * ```
+ *
+ * @param cb - Callback function to handle notification clicks.
+ * @returns A promise resolving to a function that removes the listener.
+ */
+declare function onNotificationClicked(cb: (data: NotificationClickedData) => void): Promise<PluginListener>;
+export type { Attachment, Options, Action, ActionType, PendingNotification, ActiveNotification, Channel, ScheduleInterval, NotificationClickedData, };
+export { Importance, Visibility, sendNotification, requestPermission, isPermissionGranted, registerForPushNotifications, unregisterForPushNotifications, registerActionTypes, pending, cancel, cancelAll, active, removeActive, removeAllActive, createChannel, removeChannel, channels, onNotificationReceived, onAction, onNotificationClicked, Schedule, ScheduleEvery, };

package/dist-js/index.js

@@ -143,6 +143,24 @@ async function requestPermission() {
 async function registerForPushNotifications() {
     return await invoke("plugin:notifications|register_for_push_notifications");
 }
+/**
+ * Unregisters the app from push notifications (mobile).
+ *
+ * This removes the device's push notification token and stops receiving
+ * remote push notifications.
+ *
+ * @example
+ * ```typescript
+ * import { unregisterForPushNotifications } from '@choochmeque/tauri-plugin-notifications-api';
+ * await unregisterForPushNotifications();
+ * console.log('Unregistered from push notifications');
+ * ```
+ *
+ * @returns A promise resolving when unregistration is complete.
+ */
+async function unregisterForPushNotifications() {
+    return await invoke("plugin:notifications|unregister_for_push_notifications");
+}
 /**
  * Sends a notification to the user.
  * @example
@@ -359,5 +377,41 @@ async function onNotificationReceived(cb) {
 async function onAction(cb) {
     return await addPluginListener("notifications", "actionPerformed", cb);
 }
+/**
+ * Registers a listener for notification click/tap events.
+ * This fires when the user taps on a notification (both push and local).
+ *
+ * This function handles cold-start scenarios where the app is launched by
+ * tapping a notification. Any pending notification click data is automatically
+ * delivered when the listener is registered.
+ *
+ * @example
+ * ```typescript
+ * import { onNotificationClicked } from '@choochmeque/tauri-plugin-notifications-api';
+ * const unlisten = await onNotificationClicked((data) => {
+ *   console.log('Notification clicked, id:', data.id);
+ *   console.log('Custom data:', data.data);
+ * });
+ * ```
+ *
+ * @param cb - Callback function to handle notification clicks.
+ * @returns A promise resolving to a function that removes the listener.
+ */
+async function onNotificationClicked(cb) {
+    const listener = await addPluginListener("notifications", "notificationClicked", cb);
+    // Tell native side listener is active (triggers pending if any)
+    await invoke("plugin:notifications|set_click_listener_active", {
+        active: true,
+    });
+    // Return wrapped listener that notifies native side on unregister
+    return {
+        unregister: async () => {
+            await invoke("plugin:notifications|set_click_listener_active", {
+                active: false,
+            });
+            return listener.unregister();
+        },
+    };
+}
 
-export { Importance, Schedule, ScheduleEvery, Visibility, active, cancel, cancelAll, channels, createChannel, isPermissionGranted, onAction, onNotificationReceived, pending, registerActionTypes, registerForPushNotifications, removeActive, removeAllActive, removeChannel, requestPermission, sendNotification };
+export { Importance, Schedule, ScheduleEvery, Visibility, active, cancel, cancelAll, channels, createChannel, isPermissionGranted, onAction, onNotificationClicked, onNotificationReceived, pending, registerActionTypes, registerForPushNotifications, removeActive, removeAllActive, removeChannel, requestPermission, sendNotification, unregisterForPushNotifications };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@choochmeque/tauri-plugin-notifications-api",
-  "version": "0.3.0",
+  "version": "0.3.4",
   "license": "MIT",
   "author": "You",
   "description": "A Tauri v2 plugin for sending notifications on desktop and mobile platforms with support for system notifications and push delivery via FCM and APNs.",
@@ -41,7 +41,7 @@
     "rollup": "^4.52.4",
     "tslib": "^2.6.2",
     "typescript": "^5.3.3",
-    "prettier": "3.7.3",
+    "prettier": "3.7.4",
     "vitest": "^2.1.8"
   },
   "scripts": {