npm - @choochmeque/tauri-plugin-notifications-api - Versions diffs - 0.1.0 → 0.2.2 - Mend

@choochmeque/tauri-plugin-notifications-api 0.1.0 → 0.2.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (5) hide show

package/README.md CHANGED Viewed

@@ -4,7 +4,7 @@
 # Tauri Plugin Notifications
-A Tauri v2 plugin for sending system notifications on desktop and mobile platforms. Send toast notifications (brief auto-expiring OS window elements) to your user with support for rich content, scheduling, actions, and channels.
+A Tauri v2 plugin for sending notifications on desktop and mobile platforms. Send toast notifications (brief auto-expiring OS window elements) with support for rich content, scheduling, actions, channels, and push delivery via FCM and APNs.
 ## Features
@@ -46,6 +46,26 @@ Add the plugin to your Tauri project's `Cargo.toml`:
 tauri-plugin-notifications = "0.1"
 ```
+### Push Notifications Feature
+The `push-notifications` feature is **disabled by default**. To enable push notifications support:
+```toml
+[dependencies]
+tauri-plugin-notifications = { version = "0.1", features = ["push-notifications"] }
+```
+This enables:
+- Firebase Cloud Messaging support on Android
+- APNs (Apple Push Notification service) support on iOS
+**Note:** Push notifications are currently supported on mobile platforms (iOS and Android) only. macOS and Windows support is not yet available.
+Without this feature enabled:
+- Firebase dependencies are not included in Android builds
+- Push notification registration code is disabled
+- The `registerForPushNotifications()` function will return an error if called
 Configure the plugin permissions in your `capabilities/default.json`:
 ```json
@@ -308,20 +328,35 @@ const unlisten = await onNotificationReceived((notification) => {
 unlisten();
 ```
+#### Push Notifications (Mobile)
+```typescript
+import { registerForPushNotifications } from '@choochmeque/tauri-plugin-notifications-api';
+// Register for push notifications and get device token
+try {
+  const token = await registerForPushNotifications();
+  console.log('Push token:', token);
+  // Send this token to your server to send push notifications
+} catch (error) {
+  console.error('Failed to register for push notifications:', error);
+}
+```
 ### Rust
 ```rust
-use tauri_plugin_notifications::{NotificationExt, Schedule, ScheduleEvery};
+use tauri_plugin_notifications::{NotificationsExt, Schedule, ScheduleEvery};
 // Send simple notification
-app.notification()
+app.notifications()
     .builder()
     .title("Hello")
     .body("This is a notification from Rust!")
     .show()?;
 // Send rich notification
-app.notification()
+app.notifications()
     .builder()
     .id(1)
     .title("New Message")
@@ -332,7 +367,7 @@ app.notification()
     .show()?;
 // Scheduled notification
-app.notification()
+app.notifications()
     .builder()
     .title("Reminder")
     .body("Time for your meeting!")
@@ -342,7 +377,7 @@ app.notification()
 // Notification with attachments
 use tauri_plugin_notifications::Attachment;
-app.notification()
+app.notifications()
     .builder()
     .title("Photo Shared")
     .body("Check out this image!")
@@ -365,6 +400,11 @@ Requests the permission to send notifications.
 **Returns:** `Promise<'granted' | 'denied' | 'default'>`
+### `registerForPushNotifications()`
+Registers the app for push notifications (mobile only). On Android, this retrieves the FCM device token. On iOS, this requests permissions and registers for remote notifications.
+**Returns:** `Promise<string>` - The device push token
 ### `sendNotification(options: Options | string)`
 Sends a notification to the user. Can be called with a simple string for the title or with a detailed options object.
@@ -506,6 +546,27 @@ Listens for notification action performed events.
 3. For custom icons:
    - Place icons in `res/drawable/` folder
    - Reference by filename (without extension)
+4. **For push notifications (FCM)** - These steps must be done in your Tauri app project:
+   - Create a Firebase project at [Firebase Console](https://console.firebase.google.com/)
+   - Download the `google-services.json` file from Firebase Console
+   - Place `google-services.json` in your Tauri app's `gen/android/app/` directory
+   - Add the Google Services classpath to your app's `gen/android/build.gradle.kts`:
+     ```kotlin
+     buildscript {
+         repositories {
+             google()
+             mavenCentral()
+         }
+         dependencies {
+             classpath("com.google.gms:google-services:4.4.2")
+         }
+     }
+     ```
+   - Apply the plugin at the bottom of `gen/android/app/build.gradle.kts`:
+     ```kotlin
+     apply(plugin = "com.google.gms.google-services")
+     ```
+   - The notification plugin already includes the Firebase Cloud Messaging dependency when the `push-notifications` feature is enabled
 ## Testing

package/dist-js/index.cjs CHANGED Viewed

@@ -2,15 +2,15 @@
 var core = require('@tauri-apps/api/core');
-// Copyright 2019-2023 Tauri Programme within The Commons Conservancy
-// SPDX-License-Identifier: Apache-2.0
-// SPDX-License-Identifier: MIT
 /**
  * Send toast notifications (brief auto-expiring OS window element) to your user.
  * Can also be used with the Notification Web API.
  *
  * @module
  */
+/**
+ * Predefined intervals for repeating notifications.
+ */
 exports.ScheduleEvery = void 0;
 (function (ScheduleEvery) {
     ScheduleEvery["Year"] = "year";
@@ -25,7 +25,18 @@ exports.ScheduleEvery = void 0;
      */
     ScheduleEvery["Second"] = "second";
 })(exports.ScheduleEvery || (exports.ScheduleEvery = {}));
+/**
+ * Schedule configuration for notifications.
+ */
 class Schedule {
+    /**
+     * Creates a schedule to fire at a specific date and time.
+     *
+     * @param date - The date and time to fire the notification.
+     * @param repeating - Whether to repeat the notification at the same time daily.
+     * @param allowWhileIdle - On Android, allows notification to fire even when the device is in idle mode.
+     * @returns A new Schedule instance.
+     */
     static at(date, repeating = false, allowWhileIdle = false) {
         return {
             at: { date, repeating, allowWhileIdle },
@@ -33,6 +44,13 @@ class Schedule {
             every: undefined,
         };
     }
+    /**
+     * Creates a schedule using an interval configuration.
+     *
+     * @param interval - The interval configuration specifying when to fire.
+     * @param allowWhileIdle - On Android, allows notification to fire even when the device is in idle mode.
+     * @returns A new Schedule instance.
+     */
     static interval(interval, allowWhileIdle = false) {
         return {
             at: undefined,
@@ -40,6 +58,14 @@ class Schedule {
             every: undefined,
         };
     }
+    /**
+     * Creates a schedule to repeat at regular intervals.
+     *
+     * @param kind - The type of interval (year, month, week, day, hour, minute, second).
+     * @param count - The number of intervals between notifications.
+     * @param allowWhileIdle - On Android, allows notification to fire even when the device is in idle mode.
+     * @returns A new Schedule instance.
+     */
     static every(kind, count, allowWhileIdle = false) {
         return {
             at: undefined,
@@ -48,29 +74,41 @@ class Schedule {
         };
     }
 }
+/**
+ * The importance level of a notification channel (Android).
+ */
 exports.Importance = void 0;
 (function (Importance) {
+    /** Does not show notifications. */
     Importance[Importance["None"] = 0] = "None";
+    /** Shows notifications only in the notification shade, no sound, no visual interruption. */
     Importance[Importance["Min"] = 1] = "Min";
+    /** Shows notifications everywhere, but is not intrusive. */
     Importance[Importance["Low"] = 2] = "Low";
+    /** Shows notifications everywhere with sound. */
     Importance[Importance["Default"] = 3] = "Default";
+    /** Shows notifications everywhere with sound and heads-up display. */
     Importance[Importance["High"] = 4] = "High";
 })(exports.Importance || (exports.Importance = {}));
+/**
+ * The visibility of a notification on the lock screen (Android).
+ */
 exports.Visibility = void 0;
 (function (Visibility) {
+    /** Do not show any part of this notification on the lock screen. */
     Visibility[Visibility["Secret"] = -1] = "Secret";
+    /** Show the notification, but hide sensitive content on the lock screen. */
     Visibility[Visibility["Private"] = 0] = "Private";
+    /** Show the entire notification on the lock screen. */
     Visibility[Visibility["Public"] = 1] = "Public";
 })(exports.Visibility || (exports.Visibility = {}));
 /**
  * Checks if the permission to send notifications is granted.
  * @example
  * ```typescript
- * import { isPermissionGranted } from '@tauri-apps/plugin-notification';
+ * import { isPermissionGranted } from '@choochmeque/tauri-plugin-notifications-api';
  * const permissionGranted = await isPermissionGranted();
  * ```
- *
- * @since 2.0.0
  */
 async function isPermissionGranted() {
     return await core.invoke("plugin:notifications|is_permission_granted");
@@ -79,7 +117,7 @@ async function isPermissionGranted() {
  * Requests the permission to send notifications.
  * @example
  * ```typescript
- * import { isPermissionGranted, requestPermission } from '@tauri-apps/plugin-notification';
+ * import { isPermissionGranted, requestPermission } from '@choochmeque/tauri-plugin-notifications-api';
  * let permissionGranted = await isPermissionGranted();
  * if (!permissionGranted) {
  *   const permission = await requestPermission();
@@ -88,17 +126,30 @@ async function isPermissionGranted() {
  * ```
  *
  * @returns A promise resolving to whether the user granted the permission or not.
- *
- * @since 2.0.0
  */
 async function requestPermission() {
     return await core.invoke("plugin:notifications|request_permission");
 }
+/**
+ * Registers the app for push notifications (mobile).
+ *
+ * @example
+ * ```typescript
+ * import { registerForPushNotifications } from '@choochmeque/tauri-plugin-notifications-api';
+ * const token = await registerForPushNotifications();
+ * console.log('Push token:', token);
+ * ```
+ *
+ * @returns A promise resolving to the device push token.
+ */
+async function registerForPushNotifications() {
+    return await core.invoke("plugin:notifications|register_for_push_notifications");
+}
 /**
  * Sends a notification to the user.
  * @example
  * ```typescript
- * import { isPermissionGranted, requestPermission, sendNotification } from '@tauri-apps/plugin-notification';
+ * import { isPermissionGranted, requestPermission, sendNotification } from '@choochmeque/tauri-plugin-notifications-api';
  * let permissionGranted = await isPermissionGranted();
  * if (!permissionGranted) {
  *   const permission = await requestPermission();
@@ -109,8 +160,6 @@ async function requestPermission() {
  *   sendNotification({ title: 'TAURI', body: 'Tauri is awesome!' });
  * }
  * ```
- *
- * @since 2.0.0
  */
 async function sendNotification(options) {
     await core.invoke("plugin:notifications|notify", {
@@ -126,7 +175,7 @@ async function sendNotification(options) {
  *
  * @example
  * ```typescript
- * import { registerActionTypes } from '@tauri-apps/plugin-notification';
+ * import { registerActionTypes } from '@choochmeque/tauri-plugin-notifications-api';
  * await registerActionTypes([{
  *   id: 'tauri',
  *   actions: [{
@@ -137,8 +186,6 @@ async function sendNotification(options) {
  * ```
  *
  * @returns A promise indicating the success or failure of the operation.
- *
- * @since 2.0.0
  */
 async function registerActionTypes(types) {
     await core.invoke("plugin:notifications|register_action_types", { types });
@@ -148,13 +195,11 @@ async function registerActionTypes(types) {
  *
  * @example
  * ```typescript
- * import { pending } from '@tauri-apps/plugin-notification';
+ * import { pending } from '@choochmeque/tauri-plugin-notifications-api';
  * const pendingNotifications = await pending();
  * ```
  *
  * @returns A promise resolving to the list of pending notifications.
- *
- * @since 2.0.0
  */
 async function pending() {
     return await core.invoke("plugin:notifications|get_pending");
@@ -164,13 +209,11 @@ async function pending() {
  *
  * @example
  * ```typescript
- * import { cancel } from '@tauri-apps/plugin-notification';
+ * import { cancel } from '@choochmeque/tauri-plugin-notifications-api';
  * await cancel([-34234, 23432, 4311]);
  * ```
  *
  * @returns A promise indicating the success or failure of the operation.
- *
- * @since 2.0.0
  */
 async function cancel(notifications) {
     await core.invoke("plugin:notifications|cancel", { notifications });
@@ -180,13 +223,11 @@ async function cancel(notifications) {
  *
  * @example
  * ```typescript
- * import { cancelAll } from '@tauri-apps/plugin-notification';
+ * import { cancelAll } from '@choochmeque/tauri-plugin-notifications-api';
  * await cancelAll();
  * ```
  *
  * @returns A promise indicating the success or failure of the operation.
- *
- * @since 2.0.0
  */
 async function cancelAll() {
     await core.invoke("plugin:notifications|cancel");
@@ -196,13 +237,11 @@ async function cancelAll() {
  *
  * @example
  * ```typescript
- * import { active } from '@tauri-apps/plugin-notification';
+ * import { active } from '@choochmeque/tauri-plugin-notifications-api';
  * const activeNotifications = await active();
  * ```
  *
  * @returns A promise resolving to the list of active notifications.
- *
- * @since 2.0.0
  */
 async function active() {
     return await core.invoke("plugin:notifications|get_active");
@@ -212,13 +251,11 @@ async function active() {
  *
  * @example
  * ```typescript
- * import { cancel } from '@tauri-apps/plugin-notification';
- * await cancel([-34234, 23432, 4311])
+ * import { removeActive } from '@choochmeque/tauri-plugin-notifications-api';
+ * await removeActive([{ id: 1 }, { id: 2, tag: 'news' }]);
  * ```
  *
  * @returns A promise indicating the success or failure of the operation.
- *
- * @since 2.0.0
  */
 async function removeActive(notifications) {
     await core.invoke("plugin:notifications|remove_active", { notifications });
@@ -228,13 +265,11 @@ async function removeActive(notifications) {
  *
  * @example
  * ```typescript
- * import { removeAllActive } from '@tauri-apps/plugin-notification';
+ * import { removeAllActive } from '@choochmeque/tauri-plugin-notifications-api';
  * await removeAllActive()
  * ```
  *
  * @returns A promise indicating the success or failure of the operation.
- *
- * @since 2.0.0
  */
 async function removeAllActive() {
     await core.invoke("plugin:notifications|remove_active");
@@ -244,7 +279,7 @@ async function removeAllActive() {
  *
  * @example
  * ```typescript
- * import { createChannel, Importance, Visibility } from '@tauri-apps/plugin-notification';
+ * import { createChannel, Importance, Visibility } from '@choochmeque/tauri-plugin-notifications-api';
  * await createChannel({
  *   id: 'new-messages',
  *   name: 'New Messages',
@@ -256,8 +291,6 @@ async function removeAllActive() {
  * ```
  *
  * @returns A promise indicating the success or failure of the operation.
- *
- * @since 2.0.0
  */
 async function createChannel(channel) {
     await core.invoke("plugin:notifications|create_channel", { ...channel });
@@ -267,13 +300,11 @@ async function createChannel(channel) {
  *
  * @example
  * ```typescript
- * import { removeChannel } from '@tauri-apps/plugin-notification';
- * await removeChannel();
+ * import { removeChannel } from '@choochmeque/tauri-plugin-notifications-api';
+ * await removeChannel('new-messages');
  * ```
  *
  * @returns A promise indicating the success or failure of the operation.
- *
- * @since 2.0.0
  */
 async function removeChannel(id) {
     await core.invoke("plugin:notifications|delete_channel", { id });
@@ -283,20 +314,50 @@ async function removeChannel(id) {
  *
  * @example
  * ```typescript
- * import { channels } from '@tauri-apps/plugin-notification';
+ * import { channels } from '@choochmeque/tauri-plugin-notifications-api';
  * const notificationChannels = await channels();
  * ```
  *
  * @returns A promise resolving to the list of notification channels.
- *
- * @since 2.0.0
  */
 async function channels() {
     return await core.invoke("plugin:notifications|listChannels");
 }
+/**
+ * Registers a listener for incoming notifications.
+ *
+ * @example
+ * ```typescript
+ * import { onNotificationReceived } from '@choochmeque/tauri-plugin-notifications-api';
+ * const unlisten = await onNotificationReceived((notification) => {
+ *   console.log('Notification received:', notification);
+ * });
+ * // Later, to stop listening:
+ * // unlisten();
+ * ```
+ *
+ * @param cb - Callback function to handle received notifications.
+ * @returns A promise resolving to a function that removes the listener.
+ */
 async function onNotificationReceived(cb) {
     return await core.addPluginListener("notifications", "notification", cb);
 }
+/**
+ * Registers a listener for notification action events.
+ *
+ * @example
+ * ```typescript
+ * import { onAction } from '@choochmeque/tauri-plugin-notifications-api';
+ * const unlisten = await onAction((notification) => {
+ *   console.log('Action performed on notification:', notification);
+ * });
+ * // Later, to stop listening:
+ * // unlisten();
+ * ```
+ *
+ * @param cb - Callback function to handle notification actions.
+ * @returns A promise resolving to a function that removes the listener.
+ */
 async function onAction(cb) {
     return await core.addPluginListener("notifications", "actionPerformed", cb);
 }
@@ -312,6 +373,7 @@ exports.onAction = onAction;
 exports.onNotificationReceived = onNotificationReceived;
 exports.pending = pending;
 exports.registerActionTypes = registerActionTypes;
+exports.registerForPushNotifications = registerForPushNotifications;
 exports.removeActive = removeActive;
 exports.removeAllActive = removeAllActive;
 exports.removeChannel = removeChannel;

package/dist-js/index.d.ts CHANGED Viewed

@@ -8,8 +8,6 @@ import { type PluginListener } from "@tauri-apps/api/core";
 export type { PermissionState } from "@tauri-apps/api/core";
 /**
  * Options to send a notification.
- *
- * @since 2.0.0
  */
 interface Options {
     /**
@@ -17,10 +15,10 @@ interface Options {
      */
     id?: number;
     /**
-     * Identifier of the {@link Channel} that deliveres this notification.
+     * Identifier of the {@link Channel} that delivers this notification.
      *
      * If the channel does not exist, the notification won't fire.
-     * Make sure the channel exists with {@link listChannels} and {@link createChannel}.
+     * Make sure the channel exists with {@link channels} and {@link createChannel}.
      */
     channelId?: string;
     /**
@@ -120,24 +118,37 @@ interface Options {
      */
     number?: number;
 }
+/**
+ * Interval configuration for scheduling notifications.
+ */
 interface ScheduleInterval {
+    /** Year component of the schedule interval. */
     year?: number;
+    /** Month component of the schedule interval. */
     month?: number;
+    /** Day component of the schedule interval. */
     day?: number;
     /**
-     * 1 - Sunday
-     * 2 - Monday
-     * 3 - Tuesday
-     * 4 - Wednesday
-     * 5 - Thursday
-     * 6 - Friday
-     * 7 - Saturday
+     * Weekday component of the schedule interval.
+     * - 1 - Sunday
+     * - 2 - Monday
+     * - 3 - Tuesday
+     * - 4 - Wednesday
+     * - 5 - Thursday
+     * - 6 - Friday
+     * - 7 - Saturday
      */
     weekday?: number;
+    /** Hour component of the schedule interval. */
     hour?: number;
+    /** Minute component of the schedule interval. */
     minute?: number;
+    /** Second component of the schedule interval. */
     second?: number;
 }
+/**
+ * Predefined intervals for repeating notifications.
+ */
 declare enum ScheduleEvery {
     Year = "year",
     Month = "month",
@@ -151,23 +162,52 @@ declare enum ScheduleEvery {
      */
     Second = "second"
 }
+/**
+ * Schedule configuration for notifications.
+ */
 declare class Schedule {
+    /** Schedule a notification at a specific date and time. */
     at: {
         date: Date;
         repeating: boolean;
         allowWhileIdle: boolean;
     } | undefined;
+    /** Schedule a notification using an interval configuration. */
     interval: {
         interval: ScheduleInterval;
         allowWhileIdle: boolean;
     } | undefined;
+    /** Schedule a notification to repeat at regular intervals. */
     every: {
         interval: ScheduleEvery;
         count: number;
         allowWhileIdle: boolean;
     } | undefined;
+    /**
+     * Creates a schedule to fire at a specific date and time.
+     *
+     * @param date - The date and time to fire the notification.
+     * @param repeating - Whether to repeat the notification at the same time daily.
+     * @param allowWhileIdle - On Android, allows notification to fire even when the device is in idle mode.
+     * @returns A new Schedule instance.
+     */
     static at(date: Date, repeating?: boolean, allowWhileIdle?: boolean): Schedule;
+    /**
+     * Creates a schedule using an interval configuration.
+     *
+     * @param interval - The interval configuration specifying when to fire.
+     * @param allowWhileIdle - On Android, allows notification to fire even when the device is in idle mode.
+     * @returns A new Schedule instance.
+     */
     static interval(interval: ScheduleInterval, allowWhileIdle?: boolean): Schedule;
+    /**
+     * Creates a schedule to repeat at regular intervals.
+     *
+     * @param kind - The type of interval (year, month, week, day, hour, minute, second).
+     * @param count - The number of intervals between notifications.
+     * @param allowWhileIdle - On Android, allows notification to fire even when the device is in idle mode.
+     * @returns A new Schedule instance.
+     */
     static every(kind: ScheduleEvery, count: number, allowWhileIdle?: boolean): Schedule;
 }
 /**
@@ -179,90 +219,151 @@ interface Attachment {
     /** Attachment URL. Accepts the `asset` and `file` protocols. */
     url: string;
 }
+/**
+ * An action that can be performed from a notification.
+ */
 interface Action {
+    /** Unique identifier for the action. */
     id: string;
+    /** The title text displayed for the action. */
     title: string;
+    /** Whether the action requires device authentication (iOS). */
     requiresAuthentication?: boolean;
+    /** Whether the action should launch the app in the foreground. */
     foreground?: boolean;
+    /** Whether the action is destructive (displayed in red on iOS). */
     destructive?: boolean;
+    /** Whether the action allows text input. */
     input?: boolean;
+    /** The title for the input button when `input` is true. */
     inputButtonTitle?: string;
+    /** Placeholder text for the input field when `input` is true. */
     inputPlaceholder?: string;
 }
+/**
+ * A group of related actions that can be performed from a notification.
+ */
 interface ActionType {
-    /**
-     * The identifier of this action type
-     */
+    /** The identifier of this action type. */
     id: string;
-    /**
-     * The list of associated actions
-     */
+    /** The list of associated actions. */
     actions: Action[];
+    /** Placeholder text shown in place of the notification body when previews are hidden (iOS). */
     hiddenPreviewsBodyPlaceholder?: string;
+    /** Whether to include a custom dismiss action (iOS). */
     customDismissAction?: boolean;
+    /** Whether the notification can be displayed in CarPlay (iOS). */
     allowInCarPlay?: boolean;
+    /** Whether to show the title when previews are hidden (iOS). */
     hiddenPreviewsShowTitle?: boolean;
+    /** Whether to show the subtitle when previews are hidden (iOS). */
     hiddenPreviewsShowSubtitle?: boolean;
 }
+/**
+ * Represents a scheduled notification that has not yet been delivered.
+ */
 interface PendingNotification {
+    /** Notification identifier. */
     id: number;
+    /** Notification title. */
     title?: string;
+    /** Notification body. */
     body?: string;
+    /** The schedule configuration for this notification. */
     schedule: Schedule;
 }
+/**
+ * Represents a notification that is currently displayed.
+ */
 interface ActiveNotification {
+    /** Notification identifier. */
     id: number;
+    /** Optional tag for the notification. */
     tag?: string;
+    /** Notification title. */
     title?: string;
+    /** Notification body. */
     body?: string;
+    /** Group identifier for this notification. */
     group?: string;
+    /** Whether this notification is a group summary. */
     groupSummary: boolean;
+    /** Additional string data attached to the notification. */
     data: Record<string, string>;
+    /** Extra payload stored in the notification. */
     extra: Record<string, unknown>;
+    /** List of attachments for this notification. */
     attachments: Attachment[];
+    /** The action type identifier for this notification. */
     actionTypeId?: string;
+    /** The schedule configuration if this was a scheduled notification. */
     schedule?: Schedule;
+    /** The sound resource name. */
     sound?: string;
 }
+/**
+ * The importance level of a notification channel (Android).
+ */
 declare enum Importance {
+    /** Does not show notifications. */
     None = 0,
+    /** Shows notifications only in the notification shade, no sound, no visual interruption. */
     Min = 1,
+    /** Shows notifications everywhere, but is not intrusive. */
     Low = 2,
+    /** Shows notifications everywhere with sound. */
     Default = 3,
+    /** Shows notifications everywhere with sound and heads-up display. */
     High = 4
 }
+/**
+ * The visibility of a notification on the lock screen (Android).
+ */
 declare enum Visibility {
+    /** Do not show any part of this notification on the lock screen. */
     Secret = -1,
+    /** Show the notification, but hide sensitive content on the lock screen. */
     Private = 0,
+    /** Show the entire notification on the lock screen. */
     Public = 1
 }
+/**
+ * A notification channel (Android).
+ */
 interface Channel {
+    /** Channel identifier. */
     id: string;
+    /** Channel name shown to the user. */
     name: string;
+    /** Channel description shown to the user. */
     description?: string;
+    /** Sound resource name for notifications in this channel. */
     sound?: string;
+    /** Whether to show LED lights for notifications in this channel. */
     lights?: boolean;
+    /** The LED light color in hex format (e.g., "#FF0000"). */
     lightColor?: string;
+    /** Whether to vibrate for notifications in this channel. */
     vibration?: boolean;
+    /** The importance level for notifications in this channel. */
     importance?: Importance;
+    /** The visibility level on the lock screen for notifications in this channel. */
     visibility?: Visibility;
 }
 /**
  * Checks if the permission to send notifications is granted.
  * @example
  * ```typescript
- * import { isPermissionGranted } from '@tauri-apps/plugin-notification';
+ * import { isPermissionGranted } from '@choochmeque/tauri-plugin-notifications-api';
  * const permissionGranted = await isPermissionGranted();
  * ```
- *
- * @since 2.0.0
  */
 declare function isPermissionGranted(): Promise<boolean>;
 /**
  * Requests the permission to send notifications.
  * @example
  * ```typescript
- * import { isPermissionGranted, requestPermission } from '@tauri-apps/plugin-notification';
+ * import { isPermissionGranted, requestPermission } from '@choochmeque/tauri-plugin-notifications-api';
  * let permissionGranted = await isPermissionGranted();
  * if (!permissionGranted) {
  *   const permission = await requestPermission();
@@ -271,15 +372,26 @@ declare function isPermissionGranted(): Promise<boolean>;
  * ```
  *
  * @returns A promise resolving to whether the user granted the permission or not.
- *
- * @since 2.0.0
  */
 declare function requestPermission(): Promise<NotificationPermission>;
+/**
+ * Registers the app for push notifications (mobile).
+ *
+ * @example
+ * ```typescript
+ * import { registerForPushNotifications } from '@choochmeque/tauri-plugin-notifications-api';
+ * const token = await registerForPushNotifications();
+ * console.log('Push token:', token);
+ * ```
+ *
+ * @returns A promise resolving to the device push token.
+ */
+declare function registerForPushNotifications(): Promise<string>;
 /**
  * Sends a notification to the user.
  * @example
  * ```typescript
- * import { isPermissionGranted, requestPermission, sendNotification } from '@tauri-apps/plugin-notification';
+ * import { isPermissionGranted, requestPermission, sendNotification } from '@choochmeque/tauri-plugin-notifications-api';
  * let permissionGranted = await isPermissionGranted();
  * if (!permissionGranted) {
  *   const permission = await requestPermission();
@@ -290,8 +402,6 @@ declare function requestPermission(): Promise<NotificationPermission>;
  *   sendNotification({ title: 'TAURI', body: 'Tauri is awesome!' });
  * }
  * ```
- *
- * @since 2.0.0
  */
 declare function sendNotification(options: Options | string): Promise<void>;
 /**
@@ -299,7 +409,7 @@ declare function sendNotification(options: Options | string): Promise<void>;
  *
  * @example
  * ```typescript
- * import { registerActionTypes } from '@tauri-apps/plugin-notification';
+ * import { registerActionTypes } from '@choochmeque/tauri-plugin-notifications-api';
  * await registerActionTypes([{
  *   id: 'tauri',
  *   actions: [{
@@ -310,8 +420,6 @@ declare function sendNotification(options: Options | string): Promise<void>;
  * ```
  *
  * @returns A promise indicating the success or failure of the operation.
- *
- * @since 2.0.0
  */
 declare function registerActionTypes(types: ActionType[]): Promise<void>;
 /**
@@ -319,13 +427,11 @@ declare function registerActionTypes(types: ActionType[]): Promise<void>;
  *
  * @example
  * ```typescript
- * import { pending } from '@tauri-apps/plugin-notification';
+ * import { pending } from '@choochmeque/tauri-plugin-notifications-api';
  * const pendingNotifications = await pending();
  * ```
  *
  * @returns A promise resolving to the list of pending notifications.
- *
- * @since 2.0.0
  */
 declare function pending(): Promise<PendingNotification[]>;
 /**
@@ -333,13 +439,11 @@ declare function pending(): Promise<PendingNotification[]>;
  *
  * @example
  * ```typescript
- * import { cancel } from '@tauri-apps/plugin-notification';
+ * import { cancel } from '@choochmeque/tauri-plugin-notifications-api';
  * await cancel([-34234, 23432, 4311]);
  * ```
  *
  * @returns A promise indicating the success or failure of the operation.
- *
- * @since 2.0.0
  */
 declare function cancel(notifications: number[]): Promise<void>;
 /**
@@ -347,13 +451,11 @@ declare function cancel(notifications: number[]): Promise<void>;
  *
  * @example
  * ```typescript
- * import { cancelAll } from '@tauri-apps/plugin-notification';
+ * import { cancelAll } from '@choochmeque/tauri-plugin-notifications-api';
  * await cancelAll();
  * ```
  *
  * @returns A promise indicating the success or failure of the operation.
- *
- * @since 2.0.0
  */
 declare function cancelAll(): Promise<void>;
 /**
@@ -361,13 +463,11 @@ declare function cancelAll(): Promise<void>;
  *
  * @example
  * ```typescript
- * import { active } from '@tauri-apps/plugin-notification';
+ * import { active } from '@choochmeque/tauri-plugin-notifications-api';
  * const activeNotifications = await active();
  * ```
  *
  * @returns A promise resolving to the list of active notifications.
- *
- * @since 2.0.0
  */
 declare function active(): Promise<ActiveNotification[]>;
 /**
@@ -375,13 +475,11 @@ declare function active(): Promise<ActiveNotification[]>;
  *
  * @example
  * ```typescript
- * import { cancel } from '@tauri-apps/plugin-notification';
- * await cancel([-34234, 23432, 4311])
+ * import { removeActive } from '@choochmeque/tauri-plugin-notifications-api';
+ * await removeActive([{ id: 1 }, { id: 2, tag: 'news' }]);
  * ```
  *
  * @returns A promise indicating the success or failure of the operation.
- *
- * @since 2.0.0
  */
 declare function removeActive(notifications: Array<{
     id: number;
@@ -392,13 +490,11 @@ declare function removeActive(notifications: Array<{
  *
  * @example
  * ```typescript
- * import { removeAllActive } from '@tauri-apps/plugin-notification';
+ * import { removeAllActive } from '@choochmeque/tauri-plugin-notifications-api';
  * await removeAllActive()
  * ```
  *
  * @returns A promise indicating the success or failure of the operation.
- *
- * @since 2.0.0
  */
 declare function removeAllActive(): Promise<void>;
 /**
@@ -406,7 +502,7 @@ declare function removeAllActive(): Promise<void>;
  *
  * @example
  * ```typescript
- * import { createChannel, Importance, Visibility } from '@tauri-apps/plugin-notification';
+ * import { createChannel, Importance, Visibility } from '@choochmeque/tauri-plugin-notifications-api';
  * await createChannel({
  *   id: 'new-messages',
  *   name: 'New Messages',
@@ -418,8 +514,6 @@ declare function removeAllActive(): Promise<void>;
  * ```
  *
  * @returns A promise indicating the success or failure of the operation.
- *
- * @since 2.0.0
  */
 declare function createChannel(channel: Channel): Promise<void>;
 /**
@@ -427,13 +521,11 @@ declare function createChannel(channel: Channel): Promise<void>;
  *
  * @example
  * ```typescript
- * import { removeChannel } from '@tauri-apps/plugin-notification';
- * await removeChannel();
+ * import { removeChannel } from '@choochmeque/tauri-plugin-notifications-api';
+ * await removeChannel('new-messages');
  * ```
  *
  * @returns A promise indicating the success or failure of the operation.
- *
- * @since 2.0.0
  */
 declare function removeChannel(id: string): Promise<void>;
 /**
@@ -441,16 +533,46 @@ declare function removeChannel(id: string): Promise<void>;
  *
  * @example
  * ```typescript
- * import { channels } from '@tauri-apps/plugin-notification';
+ * import { channels } from '@choochmeque/tauri-plugin-notifications-api';
  * const notificationChannels = await channels();
  * ```
  *
  * @returns A promise resolving to the list of notification channels.
- *
- * @since 2.0.0
  */
 declare function channels(): Promise<Channel[]>;
+/**
+ * Registers a listener for incoming notifications.
+ *
+ * @example
+ * ```typescript
+ * import { onNotificationReceived } from '@choochmeque/tauri-plugin-notifications-api';
+ * const unlisten = await onNotificationReceived((notification) => {
+ *   console.log('Notification received:', notification);
+ * });
+ * // Later, to stop listening:
+ * // unlisten();
+ * ```
+ *
+ * @param cb - Callback function to handle received notifications.
+ * @returns A promise resolving to a function that removes the listener.
+ */
 declare function onNotificationReceived(cb: (notification: Options) => void): Promise<PluginListener>;
+/**
+ * Registers a listener for notification action events.
+ *
+ * @example
+ * ```typescript
+ * import { onAction } from '@choochmeque/tauri-plugin-notifications-api';
+ * const unlisten = await onAction((notification) => {
+ *   console.log('Action performed on notification:', notification);
+ * });
+ * // Later, to stop listening:
+ * // unlisten();
+ * ```
+ *
+ * @param cb - Callback function to handle notification actions.
+ * @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, registerActionTypes, pending, cancel, cancelAll, active, removeActive, removeAllActive, createChannel, removeChannel, channels, onNotificationReceived, onAction, Schedule, ScheduleEvery, };
+export { Importance, Visibility, sendNotification, requestPermission, isPermissionGranted, registerForPushNotifications, registerActionTypes, pending, cancel, cancelAll, active, removeActive, removeAllActive, createChannel, removeChannel, channels, onNotificationReceived, onAction, Schedule, ScheduleEvery, };

package/dist-js/index.js CHANGED Viewed

@@ -1,14 +1,14 @@
 import { invoke, addPluginListener } from '@tauri-apps/api/core';
-// Copyright 2019-2023 Tauri Programme within The Commons Conservancy
-// SPDX-License-Identifier: Apache-2.0
-// SPDX-License-Identifier: MIT
 /**
  * Send toast notifications (brief auto-expiring OS window element) to your user.
  * Can also be used with the Notification Web API.
  *
  * @module
  */
+/**
+ * Predefined intervals for repeating notifications.
+ */
 var ScheduleEvery;
 (function (ScheduleEvery) {
     ScheduleEvery["Year"] = "year";
@@ -23,7 +23,18 @@ var ScheduleEvery;
      */
     ScheduleEvery["Second"] = "second";
 })(ScheduleEvery || (ScheduleEvery = {}));
+/**
+ * Schedule configuration for notifications.
+ */
 class Schedule {
+    /**
+     * Creates a schedule to fire at a specific date and time.
+     *
+     * @param date - The date and time to fire the notification.
+     * @param repeating - Whether to repeat the notification at the same time daily.
+     * @param allowWhileIdle - On Android, allows notification to fire even when the device is in idle mode.
+     * @returns A new Schedule instance.
+     */
     static at(date, repeating = false, allowWhileIdle = false) {
         return {
             at: { date, repeating, allowWhileIdle },
@@ -31,6 +42,13 @@ class Schedule {
             every: undefined,
         };
     }
+    /**
+     * Creates a schedule using an interval configuration.
+     *
+     * @param interval - The interval configuration specifying when to fire.
+     * @param allowWhileIdle - On Android, allows notification to fire even when the device is in idle mode.
+     * @returns A new Schedule instance.
+     */
     static interval(interval, allowWhileIdle = false) {
         return {
             at: undefined,
@@ -38,6 +56,14 @@ class Schedule {
             every: undefined,
         };
     }
+    /**
+     * Creates a schedule to repeat at regular intervals.
+     *
+     * @param kind - The type of interval (year, month, week, day, hour, minute, second).
+     * @param count - The number of intervals between notifications.
+     * @param allowWhileIdle - On Android, allows notification to fire even when the device is in idle mode.
+     * @returns A new Schedule instance.
+     */
     static every(kind, count, allowWhileIdle = false) {
         return {
             at: undefined,
@@ -46,29 +72,41 @@ class Schedule {
         };
     }
 }
+/**
+ * The importance level of a notification channel (Android).
+ */
 var Importance;
 (function (Importance) {
+    /** Does not show notifications. */
     Importance[Importance["None"] = 0] = "None";
+    /** Shows notifications only in the notification shade, no sound, no visual interruption. */
     Importance[Importance["Min"] = 1] = "Min";
+    /** Shows notifications everywhere, but is not intrusive. */
     Importance[Importance["Low"] = 2] = "Low";
+    /** Shows notifications everywhere with sound. */
     Importance[Importance["Default"] = 3] = "Default";
+    /** Shows notifications everywhere with sound and heads-up display. */
     Importance[Importance["High"] = 4] = "High";
 })(Importance || (Importance = {}));
+/**
+ * The visibility of a notification on the lock screen (Android).
+ */
 var Visibility;
 (function (Visibility) {
+    /** Do not show any part of this notification on the lock screen. */
     Visibility[Visibility["Secret"] = -1] = "Secret";
+    /** Show the notification, but hide sensitive content on the lock screen. */
     Visibility[Visibility["Private"] = 0] = "Private";
+    /** Show the entire notification on the lock screen. */
     Visibility[Visibility["Public"] = 1] = "Public";
 })(Visibility || (Visibility = {}));
 /**
  * Checks if the permission to send notifications is granted.
  * @example
  * ```typescript
- * import { isPermissionGranted } from '@tauri-apps/plugin-notification';
+ * import { isPermissionGranted } from '@choochmeque/tauri-plugin-notifications-api';
  * const permissionGranted = await isPermissionGranted();
  * ```
- *
- * @since 2.0.0
  */
 async function isPermissionGranted() {
     return await invoke("plugin:notifications|is_permission_granted");
@@ -77,7 +115,7 @@ async function isPermissionGranted() {
  * Requests the permission to send notifications.
  * @example
  * ```typescript
- * import { isPermissionGranted, requestPermission } from '@tauri-apps/plugin-notification';
+ * import { isPermissionGranted, requestPermission } from '@choochmeque/tauri-plugin-notifications-api';
  * let permissionGranted = await isPermissionGranted();
  * if (!permissionGranted) {
  *   const permission = await requestPermission();
@@ -86,17 +124,30 @@ async function isPermissionGranted() {
  * ```
  *
  * @returns A promise resolving to whether the user granted the permission or not.
- *
- * @since 2.0.0
  */
 async function requestPermission() {
     return await invoke("plugin:notifications|request_permission");
 }
+/**
+ * Registers the app for push notifications (mobile).
+ *
+ * @example
+ * ```typescript
+ * import { registerForPushNotifications } from '@choochmeque/tauri-plugin-notifications-api';
+ * const token = await registerForPushNotifications();
+ * console.log('Push token:', token);
+ * ```
+ *
+ * @returns A promise resolving to the device push token.
+ */
+async function registerForPushNotifications() {
+    return await invoke("plugin:notifications|register_for_push_notifications");
+}
 /**
  * Sends a notification to the user.
  * @example
  * ```typescript
- * import { isPermissionGranted, requestPermission, sendNotification } from '@tauri-apps/plugin-notification';
+ * import { isPermissionGranted, requestPermission, sendNotification } from '@choochmeque/tauri-plugin-notifications-api';
  * let permissionGranted = await isPermissionGranted();
  * if (!permissionGranted) {
  *   const permission = await requestPermission();
@@ -107,8 +158,6 @@ async function requestPermission() {
  *   sendNotification({ title: 'TAURI', body: 'Tauri is awesome!' });
  * }
  * ```
- *
- * @since 2.0.0
  */
 async function sendNotification(options) {
     await invoke("plugin:notifications|notify", {
@@ -124,7 +173,7 @@ async function sendNotification(options) {
  *
  * @example
  * ```typescript
- * import { registerActionTypes } from '@tauri-apps/plugin-notification';
+ * import { registerActionTypes } from '@choochmeque/tauri-plugin-notifications-api';
  * await registerActionTypes([{
  *   id: 'tauri',
  *   actions: [{
@@ -135,8 +184,6 @@ async function sendNotification(options) {
  * ```
  *
  * @returns A promise indicating the success or failure of the operation.
- *
- * @since 2.0.0
  */
 async function registerActionTypes(types) {
     await invoke("plugin:notifications|register_action_types", { types });
@@ -146,13 +193,11 @@ async function registerActionTypes(types) {
  *
  * @example
  * ```typescript
- * import { pending } from '@tauri-apps/plugin-notification';
+ * import { pending } from '@choochmeque/tauri-plugin-notifications-api';
  * const pendingNotifications = await pending();
  * ```
  *
  * @returns A promise resolving to the list of pending notifications.
- *
- * @since 2.0.0
  */
 async function pending() {
     return await invoke("plugin:notifications|get_pending");
@@ -162,13 +207,11 @@ async function pending() {
  *
  * @example
  * ```typescript
- * import { cancel } from '@tauri-apps/plugin-notification';
+ * import { cancel } from '@choochmeque/tauri-plugin-notifications-api';
  * await cancel([-34234, 23432, 4311]);
  * ```
  *
  * @returns A promise indicating the success or failure of the operation.
- *
- * @since 2.0.0
  */
 async function cancel(notifications) {
     await invoke("plugin:notifications|cancel", { notifications });
@@ -178,13 +221,11 @@ async function cancel(notifications) {
  *
  * @example
  * ```typescript
- * import { cancelAll } from '@tauri-apps/plugin-notification';
+ * import { cancelAll } from '@choochmeque/tauri-plugin-notifications-api';
  * await cancelAll();
  * ```
  *
  * @returns A promise indicating the success or failure of the operation.
- *
- * @since 2.0.0
  */
 async function cancelAll() {
     await invoke("plugin:notifications|cancel");
@@ -194,13 +235,11 @@ async function cancelAll() {
  *
  * @example
  * ```typescript
- * import { active } from '@tauri-apps/plugin-notification';
+ * import { active } from '@choochmeque/tauri-plugin-notifications-api';
  * const activeNotifications = await active();
  * ```
  *
  * @returns A promise resolving to the list of active notifications.
- *
- * @since 2.0.0
  */
 async function active() {
     return await invoke("plugin:notifications|get_active");
@@ -210,13 +249,11 @@ async function active() {
  *
  * @example
  * ```typescript
- * import { cancel } from '@tauri-apps/plugin-notification';
- * await cancel([-34234, 23432, 4311])
+ * import { removeActive } from '@choochmeque/tauri-plugin-notifications-api';
+ * await removeActive([{ id: 1 }, { id: 2, tag: 'news' }]);
  * ```
  *
  * @returns A promise indicating the success or failure of the operation.
- *
- * @since 2.0.0
  */
 async function removeActive(notifications) {
     await invoke("plugin:notifications|remove_active", { notifications });
@@ -226,13 +263,11 @@ async function removeActive(notifications) {
  *
  * @example
  * ```typescript
- * import { removeAllActive } from '@tauri-apps/plugin-notification';
+ * import { removeAllActive } from '@choochmeque/tauri-plugin-notifications-api';
  * await removeAllActive()
  * ```
  *
  * @returns A promise indicating the success or failure of the operation.
- *
- * @since 2.0.0
  */
 async function removeAllActive() {
     await invoke("plugin:notifications|remove_active");
@@ -242,7 +277,7 @@ async function removeAllActive() {
  *
  * @example
  * ```typescript
- * import { createChannel, Importance, Visibility } from '@tauri-apps/plugin-notification';
+ * import { createChannel, Importance, Visibility } from '@choochmeque/tauri-plugin-notifications-api';
  * await createChannel({
  *   id: 'new-messages',
  *   name: 'New Messages',
@@ -254,8 +289,6 @@ async function removeAllActive() {
  * ```
  *
  * @returns A promise indicating the success or failure of the operation.
- *
- * @since 2.0.0
  */
 async function createChannel(channel) {
     await invoke("plugin:notifications|create_channel", { ...channel });
@@ -265,13 +298,11 @@ async function createChannel(channel) {
  *
  * @example
  * ```typescript
- * import { removeChannel } from '@tauri-apps/plugin-notification';
- * await removeChannel();
+ * import { removeChannel } from '@choochmeque/tauri-plugin-notifications-api';
+ * await removeChannel('new-messages');
  * ```
  *
  * @returns A promise indicating the success or failure of the operation.
- *
- * @since 2.0.0
  */
 async function removeChannel(id) {
     await invoke("plugin:notifications|delete_channel", { id });
@@ -281,22 +312,52 @@ async function removeChannel(id) {
  *
  * @example
  * ```typescript
- * import { channels } from '@tauri-apps/plugin-notification';
+ * import { channels } from '@choochmeque/tauri-plugin-notifications-api';
  * const notificationChannels = await channels();
  * ```
  *
  * @returns A promise resolving to the list of notification channels.
- *
- * @since 2.0.0
  */
 async function channels() {
     return await invoke("plugin:notifications|listChannels");
 }
+/**
+ * Registers a listener for incoming notifications.
+ *
+ * @example
+ * ```typescript
+ * import { onNotificationReceived } from '@choochmeque/tauri-plugin-notifications-api';
+ * const unlisten = await onNotificationReceived((notification) => {
+ *   console.log('Notification received:', notification);
+ * });
+ * // Later, to stop listening:
+ * // unlisten();
+ * ```
+ *
+ * @param cb - Callback function to handle received notifications.
+ * @returns A promise resolving to a function that removes the listener.
+ */
 async function onNotificationReceived(cb) {
     return await addPluginListener("notifications", "notification", cb);
 }
+/**
+ * Registers a listener for notification action events.
+ *
+ * @example
+ * ```typescript
+ * import { onAction } from '@choochmeque/tauri-plugin-notifications-api';
+ * const unlisten = await onAction((notification) => {
+ *   console.log('Action performed on notification:', notification);
+ * });
+ * // Later, to stop listening:
+ * // unlisten();
+ * ```
+ *
+ * @param cb - Callback function to handle notification actions.
+ * @returns A promise resolving to a function that removes the listener.
+ */
 async function onAction(cb) {
     return await addPluginListener("notifications", "actionPerformed", cb);
 }
-export { Importance, Schedule, ScheduleEvery, Visibility, active, cancel, cancelAll, channels, createChannel, isPermissionGranted, onAction, onNotificationReceived, pending, registerActionTypes, removeActive, removeAllActive, removeChannel, requestPermission, sendNotification };
+export { Importance, Schedule, ScheduleEvery, Visibility, active, cancel, cancelAll, channels, createChannel, isPermissionGranted, onAction, onNotificationReceived, pending, registerActionTypes, registerForPushNotifications, removeActive, removeAllActive, removeChannel, requestPermission, sendNotification };

package/package.json CHANGED Viewed

@@ -1,9 +1,9 @@
 {
   "name": "@choochmeque/tauri-plugin-notifications-api",
-  "version": "0.1.0",
+  "version": "0.2.2",
   "license": "MIT",
   "author": "You",
-  "description": "A Tauri v2 plugin for sending system notifications on desktop and mobile platforms.",
+  "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.",
   "type": "module",
   "types": "./dist-js/index.d.ts",
   "main": "./dist-js/index.cjs",