@choochmeque/tauri-plugin-notifications-api 0.1.0

package/dist-js/index.js

@@ -0,0 +1,302 @@
+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
+ */
+var ScheduleEvery;
+(function (ScheduleEvery) {
+    ScheduleEvery["Year"] = "year";
+    ScheduleEvery["Month"] = "month";
+    ScheduleEvery["TwoWeeks"] = "twoWeeks";
+    ScheduleEvery["Week"] = "week";
+    ScheduleEvery["Day"] = "day";
+    ScheduleEvery["Hour"] = "hour";
+    ScheduleEvery["Minute"] = "minute";
+    /**
+     * Not supported on iOS.
+     */
+    ScheduleEvery["Second"] = "second";
+})(ScheduleEvery || (ScheduleEvery = {}));
+class Schedule {
+    static at(date, repeating = false, allowWhileIdle = false) {
+        return {
+            at: { date, repeating, allowWhileIdle },
+            interval: undefined,
+            every: undefined,
+        };
+    }
+    static interval(interval, allowWhileIdle = false) {
+        return {
+            at: undefined,
+            interval: { interval, allowWhileIdle },
+            every: undefined,
+        };
+    }
+    static every(kind, count, allowWhileIdle = false) {
+        return {
+            at: undefined,
+            interval: undefined,
+            every: { interval: kind, count, allowWhileIdle },
+        };
+    }
+}
+var Importance;
+(function (Importance) {
+    Importance[Importance["None"] = 0] = "None";
+    Importance[Importance["Min"] = 1] = "Min";
+    Importance[Importance["Low"] = 2] = "Low";
+    Importance[Importance["Default"] = 3] = "Default";
+    Importance[Importance["High"] = 4] = "High";
+})(Importance || (Importance = {}));
+var Visibility;
+(function (Visibility) {
+    Visibility[Visibility["Secret"] = -1] = "Secret";
+    Visibility[Visibility["Private"] = 0] = "Private";
+    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';
+ * const permissionGranted = await isPermissionGranted();
+ * ```
+ *
+ * @since 2.0.0
+ */
+async function isPermissionGranted() {
+    return await invoke("plugin:notifications|is_permission_granted");
+}
+/**
+ * Requests the permission to send notifications.
+ * @example
+ * ```typescript
+ * import { isPermissionGranted, requestPermission } from '@tauri-apps/plugin-notification';
+ * let permissionGranted = await isPermissionGranted();
+ * if (!permissionGranted) {
+ *   const permission = await requestPermission();
+ *   permissionGranted = permission === 'granted';
+ * }
+ * ```
+ *
+ * @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");
+}
+/**
+ * Sends a notification to the user.
+ * @example
+ * ```typescript
+ * import { isPermissionGranted, requestPermission, sendNotification } from '@tauri-apps/plugin-notification';
+ * let permissionGranted = await isPermissionGranted();
+ * if (!permissionGranted) {
+ *   const permission = await requestPermission();
+ *   permissionGranted = permission === 'granted';
+ * }
+ * if (permissionGranted) {
+ *   sendNotification('Tauri is awesome!');
+ *   sendNotification({ title: 'TAURI', body: 'Tauri is awesome!' });
+ * }
+ * ```
+ *
+ * @since 2.0.0
+ */
+async function sendNotification(options) {
+    await invoke("plugin:notifications|notify", {
+        options: typeof options === "string"
+            ? {
+                title: options,
+            }
+            : options,
+    });
+}
+/**
+ * Register actions that are performed when the user clicks on the notification.
+ *
+ * @example
+ * ```typescript
+ * import { registerActionTypes } from '@tauri-apps/plugin-notification';
+ * await registerActionTypes([{
+ *   id: 'tauri',
+ *   actions: [{
+ *     id: 'my-action',
+ *     title: 'Settings'
+ *   }]
+ * }])
+ * ```
+ *
+ * @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 });
+}
+/**
+ * Retrieves the list of pending notifications.
+ *
+ * @example
+ * ```typescript
+ * import { pending } from '@tauri-apps/plugin-notification';
+ * 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");
+}
+/**
+ * Cancels the pending notifications with the given list of identifiers.
+ *
+ * @example
+ * ```typescript
+ * import { cancel } from '@tauri-apps/plugin-notification';
+ * 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 });
+}
+/**
+ * Cancels all pending notifications.
+ *
+ * @example
+ * ```typescript
+ * import { cancelAll } from '@tauri-apps/plugin-notification';
+ * 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");
+}
+/**
+ * Retrieves the list of active notifications.
+ *
+ * @example
+ * ```typescript
+ * import { active } from '@tauri-apps/plugin-notification';
+ * 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");
+}
+/**
+ * Removes the active notifications with the given list of identifiers.
+ *
+ * @example
+ * ```typescript
+ * import { cancel } from '@tauri-apps/plugin-notification';
+ * await cancel([-34234, 23432, 4311])
+ * ```
+ *
+ * @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 });
+}
+/**
+ * Removes all active notifications.
+ *
+ * @example
+ * ```typescript
+ * import { removeAllActive } from '@tauri-apps/plugin-notification';
+ * 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");
+}
+/**
+ * Creates a notification channel.
+ *
+ * @example
+ * ```typescript
+ * import { createChannel, Importance, Visibility } from '@tauri-apps/plugin-notification';
+ * await createChannel({
+ *   id: 'new-messages',
+ *   name: 'New Messages',
+ *   lights: true,
+ *   vibration: true,
+ *   importance: Importance.Default,
+ *   visibility: Visibility.Private
+ * });
+ * ```
+ *
+ * @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 });
+}
+/**
+ * Removes the channel with the given identifier.
+ *
+ * @example
+ * ```typescript
+ * import { removeChannel } from '@tauri-apps/plugin-notification';
+ * await removeChannel();
+ * ```
+ *
+ * @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 });
+}
+/**
+ * Retrieves the list of notification channels.
+ *
+ * @example
+ * ```typescript
+ * import { channels } from '@tauri-apps/plugin-notification';
+ * 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");
+}
+async function onNotificationReceived(cb) {
+    return await addPluginListener("notifications", "notification", cb);
+}
+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 };

package/package.json

@@ -0,0 +1,51 @@
+{
+  "name": "@choochmeque/tauri-plugin-notifications-api",
+  "version": "0.1.0",
+  "license": "MIT",
+  "author": "You",
+  "description": "A Tauri v2 plugin for sending system notifications on desktop and mobile platforms.",
+  "type": "module",
+  "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"
+  },
+  "files": [
+    "dist-js",
+    "README.md"
+  ],
+  "directories": {
+    "example": "examples"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/Choochmeque/tauri-plugin-notifications.git"
+  },
+  "keywords": [
+    "tauri",
+    "notifications"
+  ],
+  "bugs": {
+    "url": "https://github.com/Choochmeque/tauri-plugin-notifications/issues"
+  },
+  "homepage": "https://github.com/Choochmeque/tauri-plugin-notifications#readme",
+  "dependencies": {
+    "@tauri-apps/api": "^2.8.0"
+  },
+  "devDependencies": {
+    "@rollup/plugin-typescript": "^12.1.4",
+    "rollup": "^4.52.4",
+    "tslib": "^2.6.2",
+    "typescript": "^5.3.3",
+    "prettier": "3.6.2"
+  },
+  "scripts": {
+    "build": "rollup -c",
+    "pretest": "pnpm build",
+    "format": "prettier --write \"./**/*.{cjs,mjs,js,jsx,mts,ts,tsx,html,css,json}\"",
+    "format-check": "prettier --check \"./**/*.{cjs,mjs,js,jsx,mts,ts,tsx,html,css,json}\""
+  }
+}