tauri-plugin-mobile-push-api 0.1.0

package/dist/index.cjs

@@ -0,0 +1,68 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// index.ts
+var index_exports = {};
+__export(index_exports, {
+  getToken: () => getToken,
+  onNotificationReceived: () => onNotificationReceived,
+  onNotificationTapped: () => onNotificationTapped,
+  onTokenRefresh: () => onTokenRefresh,
+  requestPermission: () => requestPermission
+});
+module.exports = __toCommonJS(index_exports);
+var import_core = require("@tauri-apps/api/core");
+async function requestPermission() {
+  return (0, import_core.invoke)("plugin:mobile-push|request_permission");
+}
+async function getToken() {
+  const result = await (0, import_core.invoke)(
+    "plugin:mobile-push|get_token"
+  );
+  return result.token;
+}
+async function onNotificationReceived(handler) {
+  return (0, import_core.addPluginListener)(
+    "plugin:mobile-push",
+    "notification-received",
+    handler
+  );
+}
+async function onNotificationTapped(handler) {
+  return (0, import_core.addPluginListener)(
+    "plugin:mobile-push",
+    "notification-tapped",
+    handler
+  );
+}
+async function onTokenRefresh(handler) {
+  return (0, import_core.addPluginListener)(
+    "plugin:mobile-push",
+    "token-received",
+    handler
+  );
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  getToken,
+  onNotificationReceived,
+  onNotificationTapped,
+  onTokenRefresh,
+  requestPermission
+});

package/dist/index.d.cts

@@ -0,0 +1,49 @@
+import { PluginListener } from '@tauri-apps/api/core';
+
+/** Payload delivered with push notification events. */
+interface PushNotification {
+    title?: string;
+    body?: string;
+    data: Record<string, unknown>;
+    badge?: number;
+    sound?: string;
+}
+/**
+ * Request permission to display push notifications.
+ *
+ * On iOS this triggers the system permission dialog. On Android 13+
+ * (API 33) it requests the `POST_NOTIFICATIONS` runtime permission.
+ * Earlier Android versions return `{ granted: true }` immediately.
+ */
+declare function requestPermission(): Promise<{
+    granted: boolean;
+}>;
+/**
+ * Return the current device push token.
+ *
+ * - iOS: APNs device token (hex string)
+ * - Android: FCM registration token
+ *
+ * The token may change over the lifetime of the app. Use
+ * {@link onTokenRefresh} to stay up-to-date.
+ */
+declare function getToken(): Promise<string>;
+/**
+ * Called when a push notification is received while the app is in the
+ * foreground.
+ */
+declare function onNotificationReceived(handler: (notification: PushNotification) => void): Promise<PluginListener>;
+/**
+ * Called when the user taps a push notification to open the app.
+ */
+declare function onNotificationTapped(handler: (notification: PushNotification) => void): Promise<PluginListener>;
+/**
+ * Called when the platform issues a new push token (e.g., after an
+ * APNs token refresh or FCM token rotation). Send the new token to
+ * your backend whenever this fires.
+ */
+declare function onTokenRefresh(handler: (payload: {
+    token: string;
+}) => void): Promise<PluginListener>;
+
+export { type PushNotification, getToken, onNotificationReceived, onNotificationTapped, onTokenRefresh, requestPermission };

package/dist/index.d.ts

@@ -0,0 +1,49 @@
+import { PluginListener } from '@tauri-apps/api/core';
+
+/** Payload delivered with push notification events. */
+interface PushNotification {
+    title?: string;
+    body?: string;
+    data: Record<string, unknown>;
+    badge?: number;
+    sound?: string;
+}
+/**
+ * Request permission to display push notifications.
+ *
+ * On iOS this triggers the system permission dialog. On Android 13+
+ * (API 33) it requests the `POST_NOTIFICATIONS` runtime permission.
+ * Earlier Android versions return `{ granted: true }` immediately.
+ */
+declare function requestPermission(): Promise<{
+    granted: boolean;
+}>;
+/**
+ * Return the current device push token.
+ *
+ * - iOS: APNs device token (hex string)
+ * - Android: FCM registration token
+ *
+ * The token may change over the lifetime of the app. Use
+ * {@link onTokenRefresh} to stay up-to-date.
+ */
+declare function getToken(): Promise<string>;
+/**
+ * Called when a push notification is received while the app is in the
+ * foreground.
+ */
+declare function onNotificationReceived(handler: (notification: PushNotification) => void): Promise<PluginListener>;
+/**
+ * Called when the user taps a push notification to open the app.
+ */
+declare function onNotificationTapped(handler: (notification: PushNotification) => void): Promise<PluginListener>;
+/**
+ * Called when the platform issues a new push token (e.g., after an
+ * APNs token refresh or FCM token rotation). Send the new token to
+ * your backend whenever this fires.
+ */
+declare function onTokenRefresh(handler: (payload: {
+    token: string;
+}) => void): Promise<PluginListener>;
+
+export { type PushNotification, getToken, onNotificationReceived, onNotificationTapped, onTokenRefresh, requestPermission };

package/dist/index.js

@@ -0,0 +1,42 @@
+// index.ts
+import {
+  invoke,
+  addPluginListener
+} from "@tauri-apps/api/core";
+async function requestPermission() {
+  return invoke("plugin:mobile-push|request_permission");
+}
+async function getToken() {
+  const result = await invoke(
+    "plugin:mobile-push|get_token"
+  );
+  return result.token;
+}
+async function onNotificationReceived(handler) {
+  return addPluginListener(
+    "plugin:mobile-push",
+    "notification-received",
+    handler
+  );
+}
+async function onNotificationTapped(handler) {
+  return addPluginListener(
+    "plugin:mobile-push",
+    "notification-tapped",
+    handler
+  );
+}
+async function onTokenRefresh(handler) {
+  return addPluginListener(
+    "plugin:mobile-push",
+    "token-received",
+    handler
+  );
+}
+export {
+  getToken,
+  onNotificationReceived,
+  onNotificationTapped,
+  onTokenRefresh,
+  requestPermission
+};

package/package.json

@@ -0,0 +1,50 @@
+{
+  "name": "tauri-plugin-mobile-push-api",
+  "version": "0.1.0",
+  "description": "TypeScript API for tauri-plugin-mobile-push — push notifications for iOS (APNs) and Android (FCM)",
+  "license": "(MIT OR Apache-2.0)",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/yanqianglu/tauri-plugin-mobile-push.git"
+  },
+  "type": "module",
+  "main": "dist/index.cjs",
+  "module": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "require": "./dist/index.cjs"
+    }
+  },
+  "files": [
+    "dist",
+    "README.md"
+  ],
+  "scripts": {
+    "build": "tsup index.ts --format esm,cjs --dts --clean",
+    "prepublishOnly": "npm run build"
+  },
+  "peerDependencies": {
+    "@tauri-apps/api": ">=2.0.0"
+  },
+  "devDependencies": {
+    "@tauri-apps/api": "^2.10.1",
+    "tsup": "^8.5.1",
+    "typescript": "^5.9.3"
+  },
+  "keywords": [
+    "tauri",
+    "tauri-plugin",
+    "push-notifications",
+    "apns",
+    "fcm",
+    "ios",
+    "android",
+    "mobile",
+    "remote-push",
+    "firebase",
+    "apple-push"
+  ]
+}