@simplysm/capacitor-plugin-intent 14.0.1 → 14.0.4

package/README.md

@@ -0,0 +1,133 @@
+# @simplysm/capacitor-plugin-intent
+
+Capacitor Intent plugin for Android broadcast communication and activity results.
+
+## Installation
+
+```bash
+npm install @simplysm/capacitor-plugin-intent
+```
+
+## API Overview
+
+### Intent
+
+| API | Type | Description |
+|-----|------|-------------|
+| `IntentResult` | Interface | Data received from a broadcast or launch intent |
+| `StartActivityForResultOptions` | Interface | Options for starting an Android activity and awaiting its result |
+| `StartActivityForResultResult` | Interface | Result returned from a started activity |
+| `IntentPlugin` | Interface | Native plugin interface for intent operations |
+| `Intent` | Class | Static API for broadcast send/receive, launch intents, and activity results |
+
+## Interfaces
+
+### IntentResult
+
+Data received from a broadcast or launch intent.
+
+| Field | Type | Description |
+|-------|------|-------------|
+| `action` | `string \| undefined` | The intent action string (e.g. `"com.example.SCAN_RESULT"`) |
+| `extras` | `Record<string, unknown> \| undefined` | Key-value map of intent extras |
+
+### StartActivityForResultOptions
+
+Options for launching an Android activity and awaiting its result.
+
+| Field | Type | Description |
+|-------|------|-------------|
+| `action` | `string \| undefined` | Intent action (e.g. `"android.intent.action.VIEW"`) |
+| `uri` | `string \| undefined` | Data URI to pass to the intent |
+| `extras` | `Record<string, unknown> \| undefined` | Extra key-value pairs to include |
+| `type` | `string \| undefined` | MIME type (e.g. `"image/*"`) |
+| `packageName` | `string \| undefined` | Target package name for an explicit intent |
+| `className` | `string \| undefined` | Target class name for an explicit intent |
+| `flags` | `number \| undefined` | Intent flags bitmask |
+
+### StartActivityForResultResult
+
+Result returned when a launched activity finishes.
+
+| Field | Type | Description |
+|-------|------|-------------|
+| `resultCode` | `number` | Android result code (`RESULT_OK = -1`, `RESULT_CANCELED = 0`) |
+| `data` | `{ action?: string; uri?: string; extras?: Record<string, unknown> } \| undefined` | Optional data returned by the activity, including its action, URI, and extras |
+
+### IntentPlugin
+
+Native plugin interface for intent operations.
+
+| Method | Signature | Description |
+|--------|-----------|-------------|
+| `subscribe` | `(options: { filters: string[] }, callback: (result: IntentResult) => void) => Promise<{ id: string }>` | Register a broadcast receiver for the given action filters |
+| `unsubscribe` | `(options: { id: string }) => Promise<void>` | Unregister a broadcast receiver by subscription ID |
+| `unsubscribeAll` | `() => Promise<void>` | Unregister all broadcast receivers |
+| `send` | `(options: { action: string; extras?: Record<string, unknown> }) => Promise<void>` | Send a broadcast intent |
+| `getLaunchIntent` | `() => Promise<IntentResult>` | Get the intent that launched the current activity |
+| `addListener` | `(eventName: "newIntent", listenerFunc: (data: IntentResult) => void) => Promise<PluginListenerHandle>` | Listen for new intents delivered to the activity |
+| `removeAllListeners` | `() => Promise<void>` | Remove all event listeners |
+| `startActivityForResult` | `(options: StartActivityForResultOptions) => Promise<StartActivityForResultResult>` | Start an activity and await its result |
+
+## Classes
+
+### Intent
+
+Android Intent plugin for broadcast send/receive and launch intent handling. Designed for industrial devices such as barcode scanners and PDAs.
+
+All methods are static.
+
+| Method | Signature | Description |
+|--------|-----------|-------------|
+| `subscribe` | `static async subscribe(filters: string[], callback: (result: IntentResult) => void): Promise<() => Promise<void>>` | Register a broadcast receiver for the given action filters. Returns an async unsubscribe function. |
+| `unsubscribeAll` | `static async unsubscribeAll(): Promise<void>` | Unregister all active broadcast receivers |
+| `send` | `static async send(options: { action: string; extras?: Record<string, unknown> }): Promise<void>` | Send a broadcast intent with the specified action and optional extras |
+| `getLaunchIntent` | `static async getLaunchIntent(): Promise<IntentResult>` | Retrieve the intent that launched the current activity |
+| `addListener` | `static async addListener(eventName: "newIntent", callback: (result: IntentResult) => void): Promise<PluginListenerHandle>` | Add a listener for new intents delivered to the activity via `onNewIntent` |
+| `removeAllListeners` | `static async removeAllListeners(): Promise<void>` | Remove all registered event listeners |
+| `startActivityForResult` | `static async startActivityForResult(options: StartActivityForResultOptions): Promise<StartActivityForResultResult>` | Start an Android activity and return its result when it finishes |
+
+## Usage Examples
+
+### Subscribe to barcode scanner broadcasts
+
+```ts
+import { Intent } from "@simplysm/capacitor-plugin-intent";
+
+const unsubscribe = await Intent.subscribe(
+  ["com.example.scanner.BARCODE_RESULT"],
+  (result) => {
+    const barcode = result.extras?.["barcode"] as string;
+    handleBarcode(barcode);
+  },
+);
+
+// Later, stop listening
+await unsubscribe();
+```
+
+### Send a broadcast
+
+```ts
+import { Intent } from "@simplysm/capacitor-plugin-intent";
+
+await Intent.send({
+  action: "com.example.ACTION_TRIGGER_SCAN",
+  extras: { mode: "continuous" },
+});
+```
+
+### Start an activity for result
+
+```ts
+import { Intent } from "@simplysm/capacitor-plugin-intent";
+
+const result = await Intent.startActivityForResult({
+  action: "android.intent.action.PICK",
+  type: "image/*",
+});
+
+if (result.resultCode === -1 && result.data?.uri) {
+  loadImage(result.data.uri);
+}
+```

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@simplysm/capacitor-plugin-intent",
-  "version": "14.0.1",
+  "version": "14.0.4",
   "description": "심플리즘 패키지 - Capacitor Intent 플러그인",
   "author": "심플리즘",
   "license": "Apache-2.0",
@@ -18,7 +18,7 @@
     "android"
   ],
   "devDependencies": {
-    "@capacitor/core": "^7.6.0"
+    "@capacitor/core": "^7.6.1"
   },
   "peerDependencies": {
     "@capacitor/core": "^7"