tauri-plugin-background-service 0.1.0

package/dist-js/index.cjs

@@ -0,0 +1,35 @@
+'use strict';
+
+var core = require('@tauri-apps/api/core');
+var event = require('@tauri-apps/api/event');
+
+// guest-js/index.ts
+/**
+ * Start the background service.
+ * The service struct is already registered in main.rs — this just starts it.
+ */
+async function startService(config = {}) {
+    await core.invoke('plugin:background-service|start', { config });
+}
+/** Stop the service and cancel the shutdown token. */
+async function stopService() {
+    await core.invoke('plugin:background-service|stop');
+}
+/** Returns true if the Rust service is currently running. */
+async function isServiceRunning() {
+    return core.invoke('plugin:background-service|is_running');
+}
+/**
+ * Listen to built-in plugin lifecycle events.
+ * Your service can emit its own custom events via ctx.app.emit() —
+ * subscribe to those separately with tauri's `listen()`.
+ */
+async function onPluginEvent(handler) {
+    return event.listen('background-service://event', e => handler(e.payload));
+}
+
+exports.isServiceRunning = isServiceRunning;
+exports.onPluginEvent = onPluginEvent;
+exports.startService = startService;
+exports.stopService = stopService;
+//# sourceMappingURL=index.cjs.map

package/dist-js/index.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.cjs","sources":["../../index.ts"],"sourcesContent":[null],"names":["invoke","listen"],"mappings":";;;;;AAAA;AAoBA;;;AAGG;AACI,eAAe,YAAY,CAAC,SAAsB,EAAE,EAAA;IACzD,MAAMA,WAAM,CAAC,iCAAiC,EAAE,EAAE,MAAM,EAAE,CAAC;AAC7D;AAEA;AACO,eAAe,WAAW,GAAA;AAC/B,IAAA,MAAMA,WAAM,CAAC,gCAAgC,CAAC;AAChD;AAEA;AACO,eAAe,gBAAgB,GAAA;AACpC,IAAA,OAAOA,WAAM,CAAU,sCAAsC,CAAC;AAChE;AAEA;;;;AAIG;AACI,eAAe,aAAa,CACjC,OAAqC,EAAA;AAErC,IAAA,OAAOC,YAAM,CAAc,4BAA4B,EAAE,CAAC,IAAI,OAAO,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC;AACnF;;;;;;;"}

package/dist-js/index.d.ts

@@ -0,0 +1,36 @@
+import { type UnlistenFn } from '@tauri-apps/api/event';
+export interface StartConfig {
+    /** Text shown in the Android persistent foreground notification */
+    serviceLabel?: string;
+    /**
+     * Android foreground service type. Valid values: `"dataSync"` (default), `"specialUse"`.
+     * Ignored on non-Android platforms.
+     */
+    foregroundServiceType?: string;
+}
+/** Built-in plugin lifecycle events */
+export type PluginEvent = {
+    type: 'started';
+} | {
+    type: 'stopped';
+    reason: string;
+} | {
+    type: 'error';
+    message: string;
+};
+/**
+ * Start the background service.
+ * The service struct is already registered in main.rs — this just starts it.
+ */
+export declare function startService(config?: StartConfig): Promise<void>;
+/** Stop the service and cancel the shutdown token. */
+export declare function stopService(): Promise<void>;
+/** Returns true if the Rust service is currently running. */
+export declare function isServiceRunning(): Promise<boolean>;
+/**
+ * Listen to built-in plugin lifecycle events.
+ * Your service can emit its own custom events via ctx.app.emit() —
+ * subscribe to those separately with tauri's `listen()`.
+ */
+export declare function onPluginEvent(handler: (event: PluginEvent) => void): Promise<UnlistenFn>;
+//# sourceMappingURL=index.d.ts.map

package/dist-js/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":"AAEA,OAAO,EAAU,KAAK,UAAU,EAAE,MAAM,uBAAuB,CAAC;AAEhE,MAAM,WAAW,WAAW;IAC1B,mEAAmE;IACnE,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB;;;OAGG;IACH,qBAAqB,CAAC,EAAE,MAAM,CAAC;CAChC;AAED,uCAAuC;AACvC,MAAM,MAAM,WAAW,GACnB;IAAE,IAAI,EAAE,SAAS,CAAA;CAAE,GACnB;IAAE,IAAI,EAAE,SAAS,CAAC;IAAE,MAAM,EAAE,MAAM,CAAA;CAAE,GACpC;IAAE,IAAI,EAAE,OAAO,CAAC;IAAI,OAAO,EAAE,MAAM,CAAA;CAAE,CAAC;AAE1C;;;GAGG;AACH,wBAAsB,YAAY,CAAC,MAAM,GAAE,WAAgB,GAAG,OAAO,CAAC,IAAI,CAAC,CAE1E;AAED,sDAAsD;AACtD,wBAAsB,WAAW,IAAI,OAAO,CAAC,IAAI,CAAC,CAEjD;AAED,6DAA6D;AAC7D,wBAAsB,gBAAgB,IAAI,OAAO,CAAC,OAAO,CAAC,CAEzD;AAED;;;;GAIG;AACH,wBAAsB,aAAa,CACjC,OAAO,EAAE,CAAC,KAAK,EAAE,WAAW,KAAK,IAAI,GACpC,OAAO,CAAC,UAAU,CAAC,CAErB"}

package/dist-js/index.js

@@ -0,0 +1,30 @@
+import { invoke } from '@tauri-apps/api/core';
+import { listen } from '@tauri-apps/api/event';
+
+// guest-js/index.ts
+/**
+ * Start the background service.
+ * The service struct is already registered in main.rs — this just starts it.
+ */
+async function startService(config = {}) {
+    await invoke('plugin:background-service|start', { config });
+}
+/** Stop the service and cancel the shutdown token. */
+async function stopService() {
+    await invoke('plugin:background-service|stop');
+}
+/** Returns true if the Rust service is currently running. */
+async function isServiceRunning() {
+    return invoke('plugin:background-service|is_running');
+}
+/**
+ * Listen to built-in plugin lifecycle events.
+ * Your service can emit its own custom events via ctx.app.emit() —
+ * subscribe to those separately with tauri's `listen()`.
+ */
+async function onPluginEvent(handler) {
+    return listen('background-service://event', e => handler(e.payload));
+}
+
+export { isServiceRunning, onPluginEvent, startService, stopService };
+//# sourceMappingURL=index.js.map

package/dist-js/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sources":["../../index.ts"],"sourcesContent":[null],"names":[],"mappings":";;;AAAA;AAoBA;;;AAGG;AACI,eAAe,YAAY,CAAC,SAAsB,EAAE,EAAA;IACzD,MAAM,MAAM,CAAC,iCAAiC,EAAE,EAAE,MAAM,EAAE,CAAC;AAC7D;AAEA;AACO,eAAe,WAAW,GAAA;AAC/B,IAAA,MAAM,MAAM,CAAC,gCAAgC,CAAC;AAChD;AAEA;AACO,eAAe,gBAAgB,GAAA;AACpC,IAAA,OAAO,MAAM,CAAU,sCAAsC,CAAC;AAChE;AAEA;;;;AAIG;AACI,eAAe,aAAa,CACjC,OAAqC,EAAA;AAErC,IAAA,OAAO,MAAM,CAAc,4BAA4B,EAAE,CAAC,IAAI,OAAO,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC;AACnF;;;;"}

package/package.json

@@ -0,0 +1,55 @@
+{
+  "name": "tauri-plugin-background-service",
+  "version": "0.1.0",
+  "description": "Manage long-lived background service lifecycle in Tauri v2 apps across Android, iOS, and desktop.",
+  "license": "MIT OR Apache-2.0",
+  "authors": [
+    "Mohamed Dardouri <med@dardouri.com>"
+  ],
+  "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"
+  },
+  "scripts": {
+    "build": "rollup -c",
+    "prepublishOnly": "npm run build"
+  },
+  "files": [
+    "dist-js",
+    "README.md",
+    "LICENSE"
+  ],
+  "keywords": [
+    "tauri",
+    "tauri-plugin",
+    "background",
+    "service",
+    "foreground-service",
+    "android",
+    "ios",
+    "mobile",
+    "lifecycle"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/dardourimohamed/tauri-background-service.git"
+  },
+  "homepage": "https://github.com/dardourimohamed/tauri-background-service#readme",
+  "bugs": {
+    "url": "https://github.com/dardourimohamed/tauri-background-service/issues"
+  },
+  "dependencies": {
+    "@tauri-apps/api": "^2.0.0"
+  },
+  "devDependencies": {
+    "typescript": "^5.0.0",
+    "rollup": "^4.0.0",
+    "@rollup/plugin-typescript": "^11.0.0",
+    "tslib": "^2.6.0"
+  }
+}