@simplysm/capacitor-plugin-intent 14.0.4 → 14.0.5

package/README.md

@@ -1,6 +1,9 @@
 # @simplysm/capacitor-plugin-intent
 
-Capacitor Intent plugin for Android broadcast communication and activity results.
+Capacitor plugin for Android intent handling. Supports broadcast send/receive, launch intent retrieval, event listeners for new intents, and `startActivityForResult`. Designed for industrial device integration (barcode scanners, PDA devices, etc.).
+
+- **Android**: Full intent support
+- **Browser**: Web fallback for development
 
 ## Installation
 
@@ -10,7 +13,7 @@ npm install @simplysm/capacitor-plugin-intent
 
 ## API Overview
 
-### Intent
+### Interfaces
 
 | API | Type | Description |
 |-----|------|-------------|
@@ -18,23 +21,45 @@ npm install @simplysm/capacitor-plugin-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
+### Classes
+
+| API | Type | Description |
+|-----|------|-------------|
+| `Intent` | Class | Static API for broadcast send/receive, launch intents, and activity results |
 
-### IntentResult
+## `IntentResult`
 
 Data received from a broadcast or launch intent.
 
+```typescript
+interface IntentResult {
+  action?: string;
+  extras?: Record<string, unknown>;
+}
+```
+
 | 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
+## `StartActivityForResultOptions`
 
 Options for launching an Android activity and awaiting its result.
 
+```typescript
+interface StartActivityForResultOptions {
+  action?: string;
+  uri?: string;
+  extras?: Record<string, unknown>;
+  type?: string;
+  packageName?: string;
+  className?: string;
+  flags?: number;
+}
+```
+
 | Field | Type | Description |
 |-------|------|-------------|
 | `action` | `string \| undefined` | Intent action (e.g. `"android.intent.action.VIEW"`) |
@@ -42,21 +67,53 @@ Options for launching an Android activity and awaiting its result.
 | `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 |
+| `className` | `string \| undefined` | Target Activity class name for an explicit intent |
 | `flags` | `number \| undefined` | Intent flags bitmask |
 
-### StartActivityForResultResult
+## `StartActivityForResultResult`
 
 Result returned when a launched activity finishes.
 
+```typescript
+interface StartActivityForResultResult {
+  resultCode: number;
+  data?: {
+    action?: string;
+    uri?: string;
+    extras?: Record<string, unknown>;
+  };
+}
+```
+
 | 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.
+## `IntentPlugin`
+
+Native plugin interface for intent operations. Use the `Intent` class for a simplified API.
+
+```typescript
+interface IntentPlugin {
+  subscribe(
+    options: { filters: string[] },
+    callback: (result: IntentResult) => void,
+  ): Promise<{ id: string }>;
+  unsubscribe(options: { id: string }): Promise<void>;
+  unsubscribeAll(): Promise<void>;
+  send(options: { action: string; extras?: Record<string, unknown> }): Promise<void>;
+  getLaunchIntent(): Promise<IntentResult>;
+  addListener(
+    eventName: "newIntent",
+    listenerFunc: (data: IntentResult) => void,
+  ): Promise<PluginListenerHandle>;
+  removeAllListeners(): Promise<void>;
+  startActivityForResult(
+    options: StartActivityForResultOptions,
+  ): Promise<StartActivityForResultResult>;
+}
+```
 
 | Method | Signature | Description |
 |--------|-----------|-------------|
@@ -69,13 +126,29 @@ Native plugin interface for intent operations.
 | `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.
+## `Intent`
+
+Abstract class with static methods for Android intent operations. Designed for industrial devices such as barcode scanners and PDAs.
+
+```typescript
+abstract class Intent {
+  static async subscribe(
+    filters: string[],
+    callback: (result: IntentResult) => void,
+  ): Promise<() => Promise<void>>;
+  static async unsubscribeAll(): Promise<void>;
+  static async send(options: { action: string; extras?: Record<string, unknown> }): Promise<void>;
+  static async getLaunchIntent(): Promise<IntentResult>;
+  static async addListener(
+    eventName: "newIntent",
+    callback: (result: IntentResult) => void,
+  ): Promise<PluginListenerHandle>;
+  static async removeAllListeners(): Promise<void>;
+  static async startActivityForResult(
+    options: StartActivityForResultOptions,
+  ): Promise<StartActivityForResultResult>;
+}
+```
 
 | Method | Signature | Description |
 |--------|-----------|-------------|
@@ -83,7 +156,7 @@ All methods are static.
 | `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` |
+| `addListener` | `static async addListener(eventName: "newIntent", callback: (result: IntentResult) => void): Promise<PluginListenerHandle>` | Add a listener for new intents delivered to the activity via `onNewIntent`. Call `handle.remove()` to unregister. |
 | `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 |
 
@@ -91,14 +164,14 @@ All methods are static.
 
 ### Subscribe to barcode scanner broadcasts
 
-```ts
+```typescript
 import { Intent } from "@simplysm/capacitor-plugin-intent";
 
 const unsubscribe = await Intent.subscribe(
-  ["com.example.scanner.BARCODE_RESULT"],
+  ["com.symbol.datawedge.api.RESULT_ACTION"],
   (result) => {
-    const barcode = result.extras?.["barcode"] as string;
-    handleBarcode(barcode);
+    const barcode = result.extras?.["com.symbol.datawedge.data_string"];
+    // handle barcode
   },
 );
 
@@ -106,28 +179,25 @@ const unsubscribe = await Intent.subscribe(
 await unsubscribe();
 ```
 
-### Send a broadcast
+### Send a broadcast and start an activity for result
 
-```ts
+```typescript
 import { Intent } from "@simplysm/capacitor-plugin-intent";
 
+// Send a broadcast
 await Intent.send({
-  action: "com.example.ACTION_TRIGGER_SCAN",
-  extras: { mode: "continuous" },
+  action: "com.symbol.datawedge.api.ACTION",
+  extras: {
+    "com.symbol.datawedge.api.SOFT_SCAN_TRIGGER": "TOGGLE_SCANNING",
+  },
 });
-```
-
-### Start an activity for result
-
-```ts
-import { Intent } from "@simplysm/capacitor-plugin-intent";
 
+// Start an activity for result
 const result = await Intent.startActivityForResult({
-  action: "android.intent.action.PICK",
-  type: "image/*",
+  action: "com.example.PAY",
+  extras: { amount: 1000 },
 });
-
-if (result.resultCode === -1 && result.data?.uri) {
-  loadImage(result.data.uri);
+if (result.resultCode === -1) {
+  // RESULT_OK - payment succeeded
 }
 ```

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@simplysm/capacitor-plugin-intent",
-  "version": "14.0.4",
+  "version": "14.0.5",
   "description": "심플리즘 패키지 - Capacitor Intent 플러그인",
   "author": "심플리즘",
   "license": "Apache-2.0",