@simplysm/capacitor-plugin-broadcast 13.0.0-beta.7 → 13.0.2

package/README.md

@@ -50,6 +50,23 @@ An interface representing Broadcast reception results or Intent information.
 | `action` | `string \| undefined` | Broadcast action string |
 | `extras` | `Record<string, unknown> \| undefined` | Additional data included in the Intent |
 
+### `IBroadcastPlugin` Interface
+
+The low-level Capacitor plugin interface. In most cases, use the `Broadcast` wrapper class instead of this interface directly. It is exported for advanced use cases such as custom plugin registration.
+
+| Method | Return Type | Description |
+|--------|----------|------|
+| `subscribe(options, callback)` | `Promise<{ id: string }>` | Register a BroadcastReceiver with intent filters |
+| `unsubscribe(options)` | `Promise<void>` | Unregister a specific BroadcastReceiver by ID |
+| `unsubscribeAll()` | `Promise<void>` | Unregister all BroadcastReceivers |
+| `send(options)` | `Promise<void>` | Send a Broadcast Intent |
+| `getLaunchIntent()` | `Promise<IBroadcastResult>` | Retrieve the launch Intent |
+| `addListener("onNewIntent", callback)` | `Promise<PluginListenerHandle>` | Listen for new Intents while the app is running |
+
+```typescript
+import type { IBroadcastPlugin, IBroadcastResult } from "@simplysm/capacitor-plugin-broadcast";
+```
+
 ## Usage Examples
 
 ### Receiving Broadcasts

package/dist/Broadcast.js.map

@@ -1,7 +1,6 @@
 {
   "version": 3,
   "sources": ["../src/Broadcast.ts"],
-  "sourcesContent": ["import { registerPlugin } from \"@capacitor/core\";\nimport type { PluginListenerHandle } from \"@capacitor/core\";\nimport type { IBroadcastPlugin, IBroadcastResult } from \"./IBroadcastPlugin\";\n\nconst BroadcastPlugin = registerPlugin<IBroadcastPlugin>(\"Broadcast\", {\n  web: async () => {\n    const { BroadcastWeb } = await import(\"./web/BroadcastWeb\");\n    return new BroadcastWeb();\n  },\n});\n\n/**\n * Android Broadcast \uC1A1\uC218\uC2E0 \uD50C\uB7EC\uADF8\uC778\n * - \uC0B0\uC5C5\uC6A9 \uC7A5\uCE58(\uBC14\uCF54\uB4DC \uC2A4\uCE90\uB108, PDA \uB4F1) \uC5F0\uB3D9\uC6A9\n */\nexport abstract class Broadcast {\n  /**\n   * Broadcast \uC218\uC2E0 \uB4F1\uB85D\n   * @returns \uD574\uC81C \uD568\uC218\n   *\n   * @example\n   * ```ts\n   * const unsub = await Broadcast.subscribe(\n   *   [\"com.symbol.datawedge.api.RESULT_ACTION\"],\n   *   (result) => console.log(result.extras)\n   * );\n   *\n   * // \uD574\uC81C\n   * unsub();\n   * ```\n   */\n  static async subscribe(\n    filters: string[],\n    callback: (result: IBroadcastResult) => void,\n  ): Promise<() => Promise<void>> {\n    const { id } = await BroadcastPlugin.subscribe({ filters }, (result) => {\n      // Filter out the initial resolve that only contains { id }\n      if (result.action != null) {\n        callback(result);\n      }\n    });\n    return async () => {\n      await BroadcastPlugin.unsubscribe({ id });\n    };\n  }\n\n  /**\n   * \uBAA8\uB4E0 Broadcast \uC218\uC2E0\uAE30 \uD574\uC81C\n   */\n  static async unsubscribeAll(): Promise<void> {\n    await BroadcastPlugin.unsubscribeAll();\n  }\n\n  /**\n   * Broadcast \uC804\uC1A1\n   *\n   * @example\n   * ```ts\n   * await Broadcast.send({\n   *   action: \"com.symbol.datawedge.api.ACTION\",\n   *   extras: {\n   *     \"com.symbol.datawedge.api.SOFT_SCAN_TRIGGER\": \"TOGGLE_SCANNING\"\n   *   }\n   * });\n   * ```\n   */\n  static async send(options: { action: string; extras?: Record<string, unknown> }): Promise<void> {\n    await BroadcastPlugin.send(options);\n  }\n\n  /**\n   * \uC571 \uC2DC\uC791 Intent \uAC00\uC838\uC624\uAE30\n   */\n  static async getLaunchIntent(): Promise<IBroadcastResult> {\n    return BroadcastPlugin.getLaunchIntent();\n  }\n\n  /**\n   * \uC571 \uC2E4\uD589 \uC911 \uC0C8 Intent \uC218\uC2E0 \uB9AC\uC2A4\uB108 \uB4F1\uB85D\n   * @returns \uB9AC\uC2A4\uB108 \uD578\uB4E4 (remove()\uB85C \uD574\uC81C)\n   */\n  static async addNewIntentListener(callback: (result: IBroadcastResult) => void): Promise<PluginListenerHandle> {\n    return BroadcastPlugin.addListener(\"onNewIntent\", callback);\n  }\n}\n"],
   "mappings": "AAAA,SAAS,sBAAsB;AAI/B,MAAM,kBAAkB,eAAiC,aAAa;AAAA,EACpE,KAAK,YAAY;AACf,UAAM,EAAE,aAAa,IAAI,MAAM,OAAO,oBAAoB;AAC1D,WAAO,IAAI,aAAa;AAAA,EAC1B;AACF,CAAC;AAMM,MAAe,UAAU;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAgB9B,aAAa,UACX,SACA,UAC8B;AAC9B,UAAM,EAAE,GAAG,IAAI,MAAM,gBAAgB,UAAU,EAAE,QAAQ,GAAG,CAAC,WAAW;AAEtE,UAAI,OAAO,UAAU,MAAM;AACzB,iBAAS,MAAM;AAAA,MACjB;AAAA,IACF,CAAC;AACD,WAAO,YAAY;AACjB,YAAM,gBAAgB,YAAY,EAAE,GAAG,CAAC;AAAA,IAC1C;AAAA,EACF;AAAA;AAAA;AAAA;AAAA,EAKA,aAAa,iBAAgC;AAC3C,UAAM,gBAAgB,eAAe;AAAA,EACvC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAeA,aAAa,KAAK,SAA8E;AAC9F,UAAM,gBAAgB,KAAK,OAAO;AAAA,EACpC;AAAA;AAAA;AAAA;AAAA,EAKA,aAAa,kBAA6C;AACxD,WAAO,gBAAgB,gBAAgB;AAAA,EACzC;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,aAAa,qBAAqB,UAA6E;AAC7G,WAAO,gBAAgB,YAAY,eAAe,QAAQ;AAAA,EAC5D;AACF;",
   "names": []
 }

package/dist/IBroadcastPlugin.js.map

@@ -1,7 +1,6 @@
 {
   "version": 3,
   "sources": [],
-  "sourcesContent": [],
   "mappings": "",
   "names": []
 }

package/dist/index.js

@@ -1,3 +1,3 @@
-export * from "./Broadcast";
-export * from "./IBroadcastPlugin";
+export * from "./Broadcast.js";
+export * from "./IBroadcastPlugin.js";
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1,7 +1,6 @@
 {
   "version": 3,
   "sources": ["../src/index.ts"],
-  "sourcesContent": ["export * from \"./Broadcast\";\nexport * from \"./IBroadcastPlugin\";\n"],
   "mappings": "AAAA,cAAc;AACd,cAAc;",
   "names": []
 }

package/dist/web/BroadcastWeb.js.map

@@ -1,7 +1,6 @@
 {
   "version": 3,
   "sources": ["../../src/web/BroadcastWeb.ts"],
-  "sourcesContent": ["import { WebPlugin } from \"@capacitor/core\";\nimport type { IBroadcastPlugin, IBroadcastResult } from \"../IBroadcastPlugin\";\n\nexport class BroadcastWeb extends WebPlugin implements IBroadcastPlugin {\n  private static readonly _warn = () =>\n    // eslint-disable-next-line no-console\n    console.warn(\"[Broadcast] \uC6F9 \uD658\uACBD\uC5D0\uC11C\uB294 Broadcast\uB97C \uC9C0\uC6D0\uD558\uC9C0 \uC54A\uC2B5\uB2C8\uB2E4.\");\n\n  subscribe(_options: { filters: string[] }, _callback: (result: IBroadcastResult) => void): Promise<{ id: string }> {\n    BroadcastWeb._warn();\n    return Promise.resolve({ id: \"web-stub\" });\n  }\n\n  async unsubscribe(_options: { id: string }): Promise<void> {\n    // \uC6F9 \uD658\uACBD\uC5D0\uC11C\uB294 no-op\n  }\n\n  async unsubscribeAll(): Promise<void> {\n    // \uC6F9 \uD658\uACBD\uC5D0\uC11C\uB294 no-op\n  }\n\n  send(_options: { action: string; extras?: Record<string, unknown> }): Promise<void> {\n    BroadcastWeb._warn();\n    return Promise.resolve();\n  }\n\n  getLaunchIntent(): Promise<IBroadcastResult> {\n    return Promise.resolve({});\n  }\n}\n"],
   "mappings": "AAAA,SAAS,iBAAiB;AAGnB,MAAM,qBAAqB,UAAsC;AAAA,EACtE,OAAwB,QAAQ;AAAA;AAAA,IAE9B,QAAQ,KAAK,sHAA2C;AAAA;AAAA,EAE1D,UAAU,UAAiC,WAAwE;AACjH,iBAAa,MAAM;AACnB,WAAO,QAAQ,QAAQ,EAAE,IAAI,WAAW,CAAC;AAAA,EAC3C;AAAA,EAEA,MAAM,YAAY,UAAyC;AAAA,EAE3D;AAAA,EAEA,MAAM,iBAAgC;AAAA,EAEtC;AAAA,EAEA,KAAK,UAA+E;AAClF,iBAAa,MAAM;AACnB,WAAO,QAAQ,QAAQ;AAAA,EACzB;AAAA,EAEA,kBAA6C;AAC3C,WAAO,QAAQ,QAAQ,CAAC,CAAC;AAAA,EAC3B;AACF;",
   "names": []
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@simplysm/capacitor-plugin-broadcast",
-  "version": "13.0.0-beta.7",
+  "version": "13.0.2",
   "description": "심플리즘 패키지 - Capacitor Broadcast Plugin",
   "author": "김석래",
   "repository": {
@@ -27,4 +27,4 @@
   "devDependencies": {
     "@capacitor/core": "^7.4.5"
   }
-}
+}