tauri-plugin-shizuku-api 0.1.0

package/README.md

@@ -0,0 +1,104 @@
+# Tauri Plugin Shizuku
+
+Android Tauri v2 plugin for communicating with Shizuku.
+
+Current capabilities:
+
+- Shizuku service status detection
+- Shizuku permission request trigger
+- Open Shizuku app (or download page when not installed)
+- Execute shell/adb style commands through Shizuku
+- Query Android system properties
+- List installed packages
+
+## Install
+
+Rust side:
+
+```toml
+[dependencies]
+tauri-plugin-shizuku = { path = "../tauri-plugin-shizuku" }
+```
+
+JS side:
+
+```bash
+bun tauri add tauri-plugin-shizuku-api
+```
+
+Register plugin:
+
+```rust
+#[cfg_attr(mobile, tauri::mobile_entry_point)]
+pub fn run() {
+	tauri::Builder::default()
+		.plugin(tauri_plugin_shizuku::init())
+		.run(tauri::generate_context!())
+		.expect("error while running tauri application");
+}
+```
+
+## Rust API (Out-of-the-box)
+
+After plugin registration, call directly from Rust:
+
+```rust
+use tauri_plugin_shizuku::ShizukuExt;
+
+let status = app.shizuku().get_status()?;
+let _ = app.shizuku().request_permission(Default::default())?;
+let cmd = app.shizuku().run_adb_command(tauri_plugin_shizuku::RunAdbCommandRequest {
+	command: "id".to_string(),
+	timeout_ms: Some(15_000),
+})?;
+```
+
+No extra manifest edits are required by plugin users. The Android provider and native code are shipped inside this plugin.
+
+## JavaScript API
+
+```ts
+import {
+	getStatus,
+	requestPermission,
+	openShizuku,
+	runAdbCommand,
+	getSystemProperty,
+	listPackages,
+} from 'tauri-plugin-shizuku-api'
+
+const status = await getStatus()
+if (!status.permissionGranted) {
+	await openShizuku()
+	await requestPermission()
+}
+
+const commandResult = await runAdbCommand({ command: 'id', timeoutMs: 15000 })
+const release = await getSystemProperty('ro.build.version.release')
+const packages = await listPackages({ includeSystem: false, limit: 30 })
+```
+
+## Android Behavior Notes
+
+- This plugin depends on `dev.rikka.shizuku:api` and `dev.rikka.shizuku:provider`.
+- End users still need to install and start Shizuku (or Sui) because this is required by Shizuku's runtime model.
+- `runAdbCommand` currently uses `Shizuku.newProcess` for command execution.
+
+## Example App
+
+An interactive test console is provided at `examples/tauri-app`.
+
+Run steps:
+
+```bash
+cd examples/tauri-app
+bun tauri android dev
+```
+
+In app:
+
+1. Tap `Open Shizuku`
+2. Start Shizuku service in Shizuku app
+3. Tap `Request Permission`
+4. Tap `Refresh Status`
+5. Run command/property/package tests

package/dist-js/index.cjs

@@ -0,0 +1,45 @@
+'use strict';
+
+var core = require('@tauri-apps/api/core');
+
+async function ping(value) {
+    return await core.invoke('plugin:shizuku|ping', {
+        payload: {
+            value,
+        },
+    }).then((r) => (r.value ? r.value : null));
+}
+async function getStatus() {
+    return await core.invoke('plugin:shizuku|get_status');
+}
+async function requestPermission(payload) {
+    return await core.invoke('plugin:shizuku|request_permission', {
+        payload,
+    });
+}
+async function openShizuku() {
+    return await core.invoke('plugin:shizuku|open_shizuku');
+}
+async function runAdbCommand(payload) {
+    return await core.invoke('plugin:shizuku|run_adb_command', {
+        payload,
+    });
+}
+async function getSystemProperty(key) {
+    return await core.invoke('plugin:shizuku|get_system_property', {
+        payload: { key },
+    });
+}
+async function listPackages(payload) {
+    return await core.invoke('plugin:shizuku|list_packages', {
+        payload,
+    });
+}
+
+exports.getStatus = getStatus;
+exports.getSystemProperty = getSystemProperty;
+exports.listPackages = listPackages;
+exports.openShizuku = openShizuku;
+exports.ping = ping;
+exports.requestPermission = requestPermission;
+exports.runAdbCommand = runAdbCommand;

package/dist-js/index.d.ts

@@ -0,0 +1,50 @@
+export declare function ping(value: string): Promise<string | null>;
+export interface ShizukuStatus {
+    serviceAvailable: boolean;
+    preV11: boolean;
+    permissionGranted: boolean;
+    shouldShowRequestRationale: boolean;
+    canRequestPermission: boolean;
+    serverUid?: number;
+    serverVersion?: number;
+    message?: string;
+}
+export interface RequestPermissionRequest {
+    requestCode?: number;
+}
+export interface RequestPermissionResponse {
+    requested: boolean;
+    granted: boolean;
+    message?: string;
+}
+export interface OpenShizukuResponse {
+    opened: boolean;
+    message?: string;
+}
+export interface RunAdbCommandRequest {
+    command: string;
+    timeoutMs?: number;
+}
+export interface RunAdbCommandResponse {
+    exitCode: number;
+    stdout: string;
+    stderr: string;
+    durationMs: number;
+}
+export interface GetSystemPropertyResponse {
+    key: string;
+    value?: string;
+}
+export interface ListPackagesRequest {
+    includeSystem?: boolean;
+    limit?: number;
+}
+export interface ListPackagesResponse {
+    packages: string[];
+}
+export declare function getStatus(): Promise<ShizukuStatus>;
+export declare function requestPermission(payload?: RequestPermissionRequest): Promise<RequestPermissionResponse>;
+export declare function openShizuku(): Promise<OpenShizukuResponse>;
+export declare function runAdbCommand(payload: RunAdbCommandRequest): Promise<RunAdbCommandResponse>;
+export declare function getSystemProperty(key: string): Promise<GetSystemPropertyResponse>;
+export declare function listPackages(payload?: ListPackagesRequest): Promise<ListPackagesResponse>;

package/dist-js/index.js

@@ -0,0 +1,37 @@
+import { invoke } from '@tauri-apps/api/core';
+
+async function ping(value) {
+    return await invoke('plugin:shizuku|ping', {
+        payload: {
+            value,
+        },
+    }).then((r) => (r.value ? r.value : null));
+}
+async function getStatus() {
+    return await invoke('plugin:shizuku|get_status');
+}
+async function requestPermission(payload) {
+    return await invoke('plugin:shizuku|request_permission', {
+        payload,
+    });
+}
+async function openShizuku() {
+    return await invoke('plugin:shizuku|open_shizuku');
+}
+async function runAdbCommand(payload) {
+    return await invoke('plugin:shizuku|run_adb_command', {
+        payload,
+    });
+}
+async function getSystemProperty(key) {
+    return await invoke('plugin:shizuku|get_system_property', {
+        payload: { key },
+    });
+}
+async function listPackages(payload) {
+    return await invoke('plugin:shizuku|list_packages', {
+        payload,
+    });
+}
+
+export { getStatus, getSystemProperty, listPackages, openShizuku, ping, requestPermission, runAdbCommand };

package/package.json

@@ -0,0 +1,33 @@
+{
+  "name": "tauri-plugin-shizuku-api",
+  "version": "0.1.0",
+  "author": "You",
+  "description": "",
+  "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"
+  ],
+  "scripts": {
+    "build": "rollup -c",
+    "prepublishOnly": "pnpm build",
+    "pretest": "pnpm build"
+  },
+  "dependencies": {
+    "@tauri-apps/api": "^2.0.0"
+  },
+  "devDependencies": {
+    "@rollup/plugin-typescript": "^12.0.0",
+    "rollup": "^4.9.6",
+    "typescript": "^5.3.3",
+    "tslib": "^2.6.2"
+  }
+}