@devioarts/capacitor-mdns 0.0.3 → 0.2.0

package/dist/plugin.js.map

@@ -1 +1 @@
-{"version":3,"file":"plugin.js","sources":["esm/index.js","esm/web.js"],"sourcesContent":["import { registerPlugin } from '@capacitor/core';\nconst mDNS = registerPlugin('mDNS', {\n    web: () => import('./web').then((m) => new m.mDNSWeb()),\n});\nexport * from './definitions';\nexport { mDNS };\n//# sourceMappingURL=index.js.map","// src/web.ts\nimport { WebPlugin } from '@capacitor/core';\n/**\n * Web implementation of the mDNS plugin.\n *\n * This class behaves as a thin proxy:\n * - In Electron (when a preload exposes window.mDNS/window.mdns), calls are forwarded over IPC.\n * - In a regular browser, mDNS is not available; methods resolve with well-shaped stub values\n *   and log a console message with the [WEB_NOT_SUPPORTED] tag.\n */\nexport class mDNSWeb extends WebPlugin {\n    /** Electron preload bridge (if present). */\n    get electronApi() {\n        if (typeof window === 'undefined')\n            return undefined;\n        return window.mDNS || window.mdns;\n    }\n    async startBroadcast(options) {\n        const api = this.electronApi;\n        if (api === null || api === void 0 ? void 0 : api.startBroadcast)\n            return api.startBroadcast(options);\n        console.log('[WEB_NOT_SUPPORTED] startBroadcast', options);\n        // Keep the shape consistent even when not supported\n        return { publishing: true, name: '', error: false, errorMessage: null };\n    }\n    async stopBroadcast() {\n        const api = this.electronApi;\n        if (api === null || api === void 0 ? void 0 : api.stopBroadcast)\n            return api.stopBroadcast();\n        console.log('[WEB_NOT_SUPPORTED] stopBroadcast');\n        return { publishing: false, error: false, errorMessage: null };\n    }\n    async discover(options = {}) {\n        const api = this.electronApi;\n        if (api === null || api === void 0 ? void 0 : api.discover)\n            return api.discover(options);\n        console.log('[WEB_NOT_SUPPORTED] discover', options);\n        return { services: [], error: false, errorMessage: null, servicesFound: 0 };\n    }\n}\n//# sourceMappingURL=web.js.map"],"names":["registerPlugin","WebPlugin"],"mappings":";;;AACK,UAAC,IAAI,GAAGA,mBAAc,CAAC,MAAM,EAAE;IACpC,IAAI,GAAG,EAAE,MAAM,mDAAe,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,IAAI,CAAC,CAAC,OAAO,EAAE,CAAC;IAC3D,CAAC;;ICHD;IAEA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACO,MAAM,OAAO,SAASC,cAAS,CAAC;IACvC;IACA,IAAI,IAAI,WAAW,GAAG;IACtB,QAAQ,IAAI,OAAO,MAAM,KAAK,WAAW;IACzC,YAAY,OAAO,SAAS;IAC5B,QAAQ,OAAO,MAAM,CAAC,IAAI,IAAI,MAAM,CAAC,IAAI;IACzC,IAAI;IACJ,IAAI,MAAM,cAAc,CAAC,OAAO,EAAE;IAClC,QAAQ,MAAM,GAAG,GAAG,IAAI,CAAC,WAAW;IACpC,QAAQ,IAAI,GAAG,KAAK,IAAI,IAAI,GAAG,KAAK,MAAM,GAAG,MAAM,GAAG,GAAG,CAAC,cAAc;IACxE,YAAY,OAAO,GAAG,CAAC,cAAc,CAAC,OAAO,CAAC;IAC9C,QAAQ,OAAO,CAAC,GAAG,CAAC,oCAAoC,EAAE,OAAO,CAAC;IAClE;IACA,QAAQ,OAAO,EAAE,UAAU,EAAE,IAAI,EAAE,IAAI,EAAE,EAAE,EAAE,KAAK,EAAE,KAAK,EAAE,YAAY,EAAE,IAAI,EAAE;IAC/E,IAAI;IACJ,IAAI,MAAM,aAAa,GAAG;IAC1B,QAAQ,MAAM,GAAG,GAAG,IAAI,CAAC,WAAW;IACpC,QAAQ,IAAI,GAAG,KAAK,IAAI,IAAI,GAAG,KAAK,MAAM,GAAG,MAAM,GAAG,GAAG,CAAC,aAAa;IACvE,YAAY,OAAO,GAAG,CAAC,aAAa,EAAE;IACtC,QAAQ,OAAO,CAAC,GAAG,CAAC,mCAAmC,CAAC;IACxD,QAAQ,OAAO,EAAE,UAAU,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,YAAY,EAAE,IAAI,EAAE;IACtE,IAAI;IACJ,IAAI,MAAM,QAAQ,CAAC,OAAO,GAAG,EAAE,EAAE;IACjC,QAAQ,MAAM,GAAG,GAAG,IAAI,CAAC,WAAW;IACpC,QAAQ,IAAI,GAAG,KAAK,IAAI,IAAI,GAAG,KAAK,MAAM,GAAG,MAAM,GAAG,GAAG,CAAC,QAAQ;IAClE,YAAY,OAAO,GAAG,CAAC,QAAQ,CAAC,OAAO,CAAC;IACxC,QAAQ,OAAO,CAAC,GAAG,CAAC,8BAA8B,EAAE,OAAO,CAAC;IAC5D,QAAQ,OAAO,EAAE,QAAQ,EAAE,EAAE,EAAE,KAAK,EAAE,KAAK,EAAE,YAAY,EAAE,IAAI,EAAE,aAAa,EAAE,CAAC,EAAE;IACnF,IAAI;IACJ;;;;;;;;;;;;;;;"}
+{"version":3,"file":"plugin.js","sources":["esm/index.js","esm/web.js"],"sourcesContent":["import { registerPlugin } from '@capacitor/core';\nconst platformPlugin = registerPlugin('mDNS', {\n    web: () => import('./web').then((m) => new m.mDNSWeb()),\n    electron: () => {\n        var _a, _b;\n        const plugin = (_b = (_a = window.CapacitorCustomPlatform) === null || _a === void 0 ? void 0 : _a.plugins) === null || _b === void 0 ? void 0 : _b.mDNS;\n        if (!plugin)\n            throw new Error('mDNS Electron plugin is not registered; run npx cap-electron sync in the app');\n        return Promise.resolve(plugin);\n    },\n});\nconst mDNS = new Proxy(platformPlugin, {\n    get(target, property, receiver) {\n        if (property !== 'discover')\n            return Reflect.get(target, property, receiver);\n        return (options) => {\n            const timeout = options === null || options === void 0 ? void 0 : options.timeout;\n            // Native JSON bridges turn NaN/Infinity into null, losing the invalid input.\n            if (timeout != null && (typeof timeout !== 'number' || !Number.isFinite(timeout))) {\n                return Promise.resolve({ error: true, errorMessage: 'Invalid timeout', servicesFound: 0, services: [] });\n            }\n            return target.discover(options);\n        };\n    },\n});\nexport * from './definitions';\nexport { mDNS };\n//# sourceMappingURL=index.js.map","// src/web.ts\nimport { WebPlugin } from '@capacitor/core';\n/**\n * Web implementation of the mDNS plugin.\n *\n * This class behaves as a thin proxy:\n * - In Electron (when a preload exposes window.mDNS/window.mdns), calls are forwarded over IPC.\n * - In a regular browser, mDNS is not available; methods resolve with well-shaped stub values\n *   and log a console message with the [WEB_NOT_SUPPORTED] tag.\n */\nexport class mDNSWeb extends WebPlugin {\n    constructor() {\n        super(...arguments);\n        this.unsupportedMessage = 'mDNS is not supported in this browser runtime';\n    }\n    /** Electron preload bridge (if present). */\n    get electronApi() {\n        if (typeof window === 'undefined')\n            return undefined;\n        return window.mDNS || window.mdns;\n    }\n    async getPluginPlatform() {\n        const api = this.electronApi;\n        if (api === null || api === void 0 ? void 0 : api.getPluginPlatform)\n            return api.getPluginPlatform();\n        return { platform: 'web' };\n    }\n    async startBroadcast(options) {\n        const api = this.electronApi;\n        if (api === null || api === void 0 ? void 0 : api.startBroadcast)\n            return api.startBroadcast(options);\n        console.log('[WEB_NOT_SUPPORTED] startBroadcast', options);\n        return { publishing: false, name: '', error: true, errorMessage: this.unsupportedMessage };\n    }\n    async stopBroadcast() {\n        const api = this.electronApi;\n        if (api === null || api === void 0 ? void 0 : api.stopBroadcast)\n            return api.stopBroadcast();\n        console.log('[WEB_NOT_SUPPORTED] stopBroadcast');\n        return { publishing: false, error: false, errorMessage: null };\n    }\n    async discover(options = {}) {\n        const api = this.electronApi;\n        if (api === null || api === void 0 ? void 0 : api.discover)\n            return api.discover(options);\n        console.log('[WEB_NOT_SUPPORTED] discover', options);\n        return { services: [], error: true, errorMessage: this.unsupportedMessage, servicesFound: 0 };\n    }\n    async watchServices(options) {\n        var _a;\n        if ((_a = this.electronApi) === null || _a === void 0 ? void 0 : _a.watchServices)\n            return this.electronApi.watchServices(options);\n        return { error: true, errorMessage: this.unsupportedMessage, watchersStarted: 0 };\n    }\n    async stopWatching() {\n        var _a;\n        if ((_a = this.electronApi) === null || _a === void 0 ? void 0 : _a.stopWatching)\n            return this.electronApi.stopWatching();\n        return { watching: false, error: false, errorMessage: null };\n    }\n    async addListener(eventName, handler) {\n        var _a;\n        if ((_a = this.electronApi) === null || _a === void 0 ? void 0 : _a.addListener)\n            return this.electronApi.addListener(eventName, handler);\n        return super.addListener(eventName, handler);\n    }\n    async removeAllListeners() {\n        var _a, _b;\n        await ((_b = (_a = this.electronApi) === null || _a === void 0 ? void 0 : _a.removeAllListeners) === null || _b === void 0 ? void 0 : _b.call(_a));\n        await super.removeAllListeners();\n    }\n}\n//# sourceMappingURL=web.js.map"],"names":["registerPlugin","WebPlugin"],"mappings":";;;IACA,MAAM,cAAc,GAAGA,mBAAc,CAAC,MAAM,EAAE;IAC9C,IAAI,GAAG,EAAE,MAAM,mDAAe,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,IAAI,CAAC,CAAC,OAAO,EAAE,CAAC;IAC3D,IAAI,QAAQ,EAAE,MAAM;IACpB,QAAQ,IAAI,EAAE,EAAE,EAAE;IAClB,QAAQ,MAAM,MAAM,GAAG,CAAC,EAAE,GAAG,CAAC,EAAE,GAAG,MAAM,CAAC,uBAAuB,MAAM,IAAI,IAAI,EAAE,KAAK,MAAM,GAAG,MAAM,GAAG,EAAE,CAAC,OAAO,MAAM,IAAI,IAAI,EAAE,KAAK,MAAM,GAAG,MAAM,GAAG,EAAE,CAAC,IAAI;IAChK,QAAQ,IAAI,CAAC,MAAM;IACnB,YAAY,MAAM,IAAI,KAAK,CAAC,8EAA8E,CAAC;IAC3G,QAAQ,OAAO,OAAO,CAAC,OAAO,CAAC,MAAM,CAAC;IACtC,IAAI,CAAC;IACL,CAAC,CAAC;AACG,UAAC,IAAI,GAAG,IAAI,KAAK,CAAC,cAAc,EAAE;IACvC,IAAI,GAAG,CAAC,MAAM,EAAE,QAAQ,EAAE,QAAQ,EAAE;IACpC,QAAQ,IAAI,QAAQ,KAAK,UAAU;IACnC,YAAY,OAAO,OAAO,CAAC,GAAG,CAAC,MAAM,EAAE,QAAQ,EAAE,QAAQ,CAAC;IAC1D,QAAQ,OAAO,CAAC,OAAO,KAAK;IAC5B,YAAY,MAAM,OAAO,GAAG,OAAO,KAAK,IAAI,IAAI,OAAO,KAAK,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC,OAAO;IAC7F;IACA,YAAY,IAAI,OAAO,IAAI,IAAI,KAAK,OAAO,OAAO,KAAK,QAAQ,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,EAAE;IAC/F,gBAAgB,OAAO,OAAO,CAAC,OAAO,CAAC,EAAE,KAAK,EAAE,IAAI,EAAE,YAAY,EAAE,iBAAiB,EAAE,aAAa,EAAE,CAAC,EAAE,QAAQ,EAAE,EAAE,EAAE,CAAC;IACxH,YAAY;IACZ,YAAY,OAAO,MAAM,CAAC,QAAQ,CAAC,OAAO,CAAC;IAC3C,QAAQ,CAAC;IACT,IAAI,CAAC;IACL,CAAC;;ICxBD;IAEA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACO,MAAM,OAAO,SAASC,cAAS,CAAC;IACvC,IAAI,WAAW,GAAG;IAClB,QAAQ,KAAK,CAAC,GAAG,SAAS,CAAC;IAC3B,QAAQ,IAAI,CAAC,kBAAkB,GAAG,+CAA+C;IACjF,IAAI;IACJ;IACA,IAAI,IAAI,WAAW,GAAG;IACtB,QAAQ,IAAI,OAAO,MAAM,KAAK,WAAW;IACzC,YAAY,OAAO,SAAS;IAC5B,QAAQ,OAAO,MAAM,CAAC,IAAI,IAAI,MAAM,CAAC,IAAI;IACzC,IAAI;IACJ,IAAI,MAAM,iBAAiB,GAAG;IAC9B,QAAQ,MAAM,GAAG,GAAG,IAAI,CAAC,WAAW;IACpC,QAAQ,IAAI,GAAG,KAAK,IAAI,IAAI,GAAG,KAAK,MAAM,GAAG,MAAM,GAAG,GAAG,CAAC,iBAAiB;IAC3E,YAAY,OAAO,GAAG,CAAC,iBAAiB,EAAE;IAC1C,QAAQ,OAAO,EAAE,QAAQ,EAAE,KAAK,EAAE;IAClC,IAAI;IACJ,IAAI,MAAM,cAAc,CAAC,OAAO,EAAE;IAClC,QAAQ,MAAM,GAAG,GAAG,IAAI,CAAC,WAAW;IACpC,QAAQ,IAAI,GAAG,KAAK,IAAI,IAAI,GAAG,KAAK,MAAM,GAAG,MAAM,GAAG,GAAG,CAAC,cAAc;IACxE,YAAY,OAAO,GAAG,CAAC,cAAc,CAAC,OAAO,CAAC;IAC9C,QAAQ,OAAO,CAAC,GAAG,CAAC,oCAAoC,EAAE,OAAO,CAAC;IAClE,QAAQ,OAAO,EAAE,UAAU,EAAE,KAAK,EAAE,IAAI,EAAE,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,YAAY,EAAE,IAAI,CAAC,kBAAkB,EAAE;IAClG,IAAI;IACJ,IAAI,MAAM,aAAa,GAAG;IAC1B,QAAQ,MAAM,GAAG,GAAG,IAAI,CAAC,WAAW;IACpC,QAAQ,IAAI,GAAG,KAAK,IAAI,IAAI,GAAG,KAAK,MAAM,GAAG,MAAM,GAAG,GAAG,CAAC,aAAa;IACvE,YAAY,OAAO,GAAG,CAAC,aAAa,EAAE;IACtC,QAAQ,OAAO,CAAC,GAAG,CAAC,mCAAmC,CAAC;IACxD,QAAQ,OAAO,EAAE,UAAU,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,YAAY,EAAE,IAAI,EAAE;IACtE,IAAI;IACJ,IAAI,MAAM,QAAQ,CAAC,OAAO,GAAG,EAAE,EAAE;IACjC,QAAQ,MAAM,GAAG,GAAG,IAAI,CAAC,WAAW;IACpC,QAAQ,IAAI,GAAG,KAAK,IAAI,IAAI,GAAG,KAAK,MAAM,GAAG,MAAM,GAAG,GAAG,CAAC,QAAQ;IAClE,YAAY,OAAO,GAAG,CAAC,QAAQ,CAAC,OAAO,CAAC;IACxC,QAAQ,OAAO,CAAC,GAAG,CAAC,8BAA8B,EAAE,OAAO,CAAC;IAC5D,QAAQ,OAAO,EAAE,QAAQ,EAAE,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,YAAY,EAAE,IAAI,CAAC,kBAAkB,EAAE,aAAa,EAAE,CAAC,EAAE;IACrG,IAAI;IACJ,IAAI,MAAM,aAAa,CAAC,OAAO,EAAE;IACjC,QAAQ,IAAI,EAAE;IACd,QAAQ,IAAI,CAAC,EAAE,GAAG,IAAI,CAAC,WAAW,MAAM,IAAI,IAAI,EAAE,KAAK,MAAM,GAAG,MAAM,GAAG,EAAE,CAAC,aAAa;IACzF,YAAY,OAAO,IAAI,CAAC,WAAW,CAAC,aAAa,CAAC,OAAO,CAAC;IAC1D,QAAQ,OAAO,EAAE,KAAK,EAAE,IAAI,EAAE,YAAY,EAAE,IAAI,CAAC,kBAAkB,EAAE,eAAe,EAAE,CAAC,EAAE;IACzF,IAAI;IACJ,IAAI,MAAM,YAAY,GAAG;IACzB,QAAQ,IAAI,EAAE;IACd,QAAQ,IAAI,CAAC,EAAE,GAAG,IAAI,CAAC,WAAW,MAAM,IAAI,IAAI,EAAE,KAAK,MAAM,GAAG,MAAM,GAAG,EAAE,CAAC,YAAY;IACxF,YAAY,OAAO,IAAI,CAAC,WAAW,CAAC,YAAY,EAAE;IAClD,QAAQ,OAAO,EAAE,QAAQ,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,YAAY,EAAE,IAAI,EAAE;IACpE,IAAI;IACJ,IAAI,MAAM,WAAW,CAAC,SAAS,EAAE,OAAO,EAAE;IAC1C,QAAQ,IAAI,EAAE;IACd,QAAQ,IAAI,CAAC,EAAE,GAAG,IAAI,CAAC,WAAW,MAAM,IAAI,IAAI,EAAE,KAAK,MAAM,GAAG,MAAM,GAAG,EAAE,CAAC,WAAW;IACvF,YAAY,OAAO,IAAI,CAAC,WAAW,CAAC,WAAW,CAAC,SAAS,EAAE,OAAO,CAAC;IACnE,QAAQ,OAAO,KAAK,CAAC,WAAW,CAAC,SAAS,EAAE,OAAO,CAAC;IACpD,IAAI;IACJ,IAAI,MAAM,kBAAkB,GAAG;IAC/B,QAAQ,IAAI,EAAE,EAAE,EAAE;IAClB,QAAQ,OAAO,CAAC,EAAE,GAAG,CAAC,EAAE,GAAG,IAAI,CAAC,WAAW,MAAM,IAAI,IAAI,EAAE,KAAK,MAAM,GAAG,MAAM,GAAG,EAAE,CAAC,kBAAkB,MAAM,IAAI,IAAI,EAAE,KAAK,MAAM,GAAG,MAAM,GAAG,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IAC1J,QAAQ,MAAM,KAAK,CAAC,kBAAkB,EAAE;IACxC,IAAI;IACJ;;;;;;;;;;;;;;;"}

package/docs/electron.md

@@ -0,0 +1,91 @@
+# Electron setup
+
+Electron support is maintained for
+[`devioarts/capacitor-electron`](https://github.com/devioarts/capacitor-electron).
+
+## Capacitor Electron
+
+Use the root package API in application code, the same as iOS and Android:
+
+```ts
+import { mDNS } from '@devioarts/capacitor-mdns';
+
+await mDNS.startBroadcast({ type: '_http._tcp.', name: 'MyService', port: 9100 });
+const platform = await mDNS.getPluginPlatform();
+```
+
+The Electron runtime generator reads plugin metadata from:
+
+```ts
+import { pluginSettings } from '@devioarts/capacitor-mdns/electron/settings';
+```
+
+After installing or updating the plugin, run `npx cap-electron sync` in the application. If the
+generated runtime has no `mDNS` plugin, the root API rejects with an error identifying this step.
+This is a runtime setup error, before a platform implementation can return an operation result.
+
+The Electron main-process plugin class is exported from:
+
+```ts
+import { mDNS } from '@devioarts/capacitor-mdns/electron';
+```
+
+## Manual bridge
+
+Continuous discovery uses the same `watchServices`, `stopWatching` and `addListener` API as native
+platforms. After updating the plugin, run `npx cap-electron sync` so the generated metadata includes
+the new methods and the `serviceFound`, `serviceLost`, `watchError` events.
+
+The older manual bridge remains available for apps that do not use
+`devioarts/capacitor-electron`.
+
+The Electron runtime needs `bonjour-service`. It is declared as an optional peer dependency
+(only Electron apps need it), so install it in the Electron app:
+
+```shell
+npm i bonjour-service@~1.4.0
+```
+
+The supported range is `~1.4.0` because probe cleanup uses Bonjour 1.4 service behavior. Before widening
+it, run the real-registry regressions for conflicts, pending announcements and goodbye packets.
+
+### Main process
+
+```ts
+import { app } from 'electron';
+import { mDNS } from '@devioarts/capacitor-mdns/electron';
+
+const mdns = new mDNS(undefined, {
+  // Only needed for an exact development server or a custom application origin:
+  // trustedOrigins: ['http://localhost:5173'],
+});
+
+app.whenReady().then(() => {
+  mdns.init();
+});
+
+app.on('before-quit', async () => {
+  await mdns.destroy();
+});
+```
+
+### Preload
+
+```js
+const { contextBridge, ipcRenderer } = require('electron');
+const { createMDNSAPI } = require('@devioarts/capacitor-mdns/electron/mdns-bridge.cjs');
+
+contextBridge.exposeInMainWorld('mDNS', createMDNSAPI({ ipcRenderer }));
+contextBridge.exposeInMainWorld('mdns', createMDNSAPI({ ipcRenderer }));
+```
+
+### IPC trust
+
+Manual handlers accept calls only from a trusted top-level frame. By default these are
+`capacitor-electron://localhost` and `file:` documents inside `app.getAppPath()`.
+Unpackaged apps also accept the Capacitor Electron default dev origin `http://localhost:5173`;
+that default dev origin is disabled in packaged apps.
+For a custom protocol or development server, configure its exact origin with `trustedOrigins`.
+Third-party pages, child frames and other origins are rejected. Event delivery uses the same
+URL allowlist, so windows displaying remote pages do not receive service data. The generated
+Capacitor Electron route additionally applies its runtime's sender validation.

package/docs/platform-setup.md

@@ -0,0 +1,58 @@
+# Platform setup
+
+## Android
+
+Add the mDNS/network permissions to your Android manifest.
+
+`android/app/src/main/AndroidManifest.xml`
+
+```xml
+<manifest xmlns:android="http://schemas.android.com/apk/res/android">
+  <uses-permission android:name="android.permission.INTERNET" />
+  <uses-permission android:name="android.permission.CHANGE_WIFI_MULTICAST_STATE" />
+
+  <application>
+    <!-- Your app configuration -->
+  </application>
+</manifest>
+```
+
+The plugin also declares these permissions in its own Android manifest, so they
+are merged into your app during `npx cap sync`. Keeping them in your app
+manifest is still useful when you want the native project to show the network
+requirements explicitly.
+
+On some devices, mDNS discovery can still return no results if multicast traffic is blocked by the
+network, router, VPN, or device policy.
+
+The plugin does not request location or `NEARBY_WIFI_DEVICES` by default. Add
+those only if your app has separate Wi-Fi scanning or nearby-device features
+that require them.
+
+## iOS
+
+Add the local network permissions and every Bonjour service type your app uses to
+`ios/App/App/Info.plist`.
+
+```xml
+<key>NSLocalNetworkUsageDescription</key>
+<string>It is needed for the correct functioning of the application</string>
+<key>NSAppTransportSecurity</key>
+<dict>
+    <key>NSAllowsLocalNetworking</key>
+    <true/>
+</dict>
+<key>NSBonjourServices</key>
+<array>
+    <string>_http._tcp</string>
+    <string>_airplay._tcp</string>
+    <string>_googlecast._tcp</string>
+</array>
+```
+
+For a custom service such as `_capmdnse2e._tcp.`, add `_capmdnse2e._tcp` to
+`NSBonjourServices`.
+
+For continuous watching, include every type passed to `watchServices`. For example, watching
+`['_http._tcp.', '_airplay._tcp.', '_googlecast._tcp.']` requires all three entries shown above. A denied
+Local Network permission is reported through `watchError` and stops the watch group.

package/docs/playground.md

@@ -0,0 +1,50 @@
+# Playground
+
+The `playground` directory is the maintained example app for this package.
+Its application identifier is `com.devioarts.pg.cap` on iOS, Android and Electron.
+
+It demonstrates:
+
+- starting, updating and stopping an mDNS advertisement with JSON TXT records;
+- discovering services by type and optional name, with visible addresses and TXT;
+- watching several service types, with live service lists, found/lost logs and runtime errors;
+- using the Electron preload bridge;
+- checking `getPluginPlatform()` so you can confirm which runtime implementation handled a call.
+
+Run it from the playground directory:
+
+```shell
+npm install
+npm run dev
+```
+
+For Electron, use the playground together with `devioarts/capacitor-electron`.
+
+If native folders are missing after cloning, create the required platform first with `npx cap add ios`, `npx cap add android`, or `npx cap-electron add` inside `playground`.
+
+For native builds, build the plugin first from the repository root (`npm run build`), then:
+
+```shell
+cd playground
+npm run build:vite
+npx cap sync
+npm run open-ios       # or npm run open-android
+```
+
+On macOS, the sync hook adds the Local Network usage description and the default `_http._tcp`, `_airplay._tcp` and `_googlecast._tcp` Bonjour types to the generated iOS project, preserving any existing description and custom types. Add other types to `NSBonjourServices` before testing them on iOS.
+
+For Electron use `npm run build` followed by `npm run open-electron` inside `playground`. The build synchronizes the plugin registry before compiling, including all six methods and the three watch events. The default development origin is `http://localhost:5173`.
+A regular browser displays the UI but cannot perform mDNS; unsupported calls show an error.
+
+To test continuous discovery:
+
+1. Publish `_http._tcp.` with TXT on one device. Keep both devices on the same Wi-Fi network.
+2. On the other device, open Discovery and start watching `_http._tcp., _airplay._tcp., _googlecast._tcp.`.
+3. Check the live name, type, port, IP addresses and TXT. Publish a second type and check both appear.
+4. Stop a publisher and check its lost event and removal. Abrupt disappearance can take until its advertised TTL expires.
+5. Run a one-time search while watching, then stop watching and verify the publisher stays active.
+6. Stop the watch, change the types and start again. Switching tabs keeps both operations active; use their Stop buttons for independent cleanup.
+
+Use dots in the advertised name and hyphens in a name filter to verify equivalent matching.
+Run a long search and click Replace search to test replacement; the older request is logged as an error.
+The Logger panel shows full event snapshots, including the last snapshot on loss.

package/docs/runtime-behavior.md

@@ -0,0 +1,80 @@
+# Runtime behavior
+
+## Continuous discovery
+
+- `watchServices({ types })` is available on iOS, Android and Electron. A nonempty array of valid
+  `_name._tcp.` / `_name._udp.` types is required. Types are trimmed, trailing dots appended and
+  duplicates merged. Invalid input leaves the current watch running.
+- One watch group is active. A valid replacement first stops the old group. `watchersStarted`
+  counts requested native browsers; asynchronous startup failures arrive through `watchError`.
+- Register `serviceFound`, `serviceLost` and `watchError` listeners before starting. Found/lost
+  contain `{ service }` with `name`, full `type`, `domain`, `port`, `hosts` and optional `txt` /
+  `hostname`. Found is emitted only after a numeric address resolves. `hosts` is always an array. Lost uses the last resolved snapshot, and is emitted
+  only if the service was reported as found. A disappearance during resolve cancels that candidate.
+- Each service emits found once per period of presence. Lost carries the last resolved snapshot;
+  this API does not promise continuous updates or separate events for address or TXT changes.
+- A browser / transport failure stops the watch group and emits `{ type, errorMessage,
+  watching: false }`. Native resolve errors retry up to three times, then emit the same event with
+  `watching: true`; a later discovery can retry that service again.
+- `stopWatching()` returns `{ watching: false, error, errorMessage }`, suppresses old callbacks and
+  cancels browsers, pending resolves and retries. Stop failures are reported and cleanup can be
+  retried. It does not stop an advertisement or one-shot discovery. Native manager destruction
+  also closes the watch group.
+- Android watch groups and one-shot discovery share the pre-API-34 resolver queue and hold separate
+  references to the Wi-Fi multicast lock. Resolved NSD TXT attributes are returned as UTF-8 strings.
+- Electron observes Bonjour goodbye packets and PTR TTL expiry. It refreshes browse queries every
+  30 seconds and checks expiry every second. Detection after abrupt network loss depends on the
+  peer's advertised TTL. Late address packets update the cached snapshot.
+- A regular web browser returns `error: true` for watch startup; stop is an idempotent no-op.
+  The manual Electron preload bridge forwards all three event types and supports listener removal.
+
+## One-shot discovery and advertising
+
+- All methods resolve with the documented result shape. Runtime failures are reported through
+  `error` and `errorMessage` instead of rejecting when the platform bridge can recover safely.
+- `getPluginPlatform()` resolves to `ios`, `android`, `electron`, or `web` from the implementation
+  that handled the call.
+- `startBroadcast()` is guarded by a native timeout on Android, iOS, and Electron. If the OS does
+  not report publish success or failure, the operation is stopped and returned as an error.
+- Only one advertisement is active at a time. Starting a new advertisement stops the previous one.
+- Discovery is timeboxed and cleans up native listeners, browsers, service-info callbacks, and
+  resolvers after completion. A valid new discovery replaces the previous request with `error: true` and an empty list on every platform. Invalid requests leave the active search running.
+- Without a name filter, discovery waits for the entire timeout. A matching resolved service with an IP address can finish a filtered search early. A candidate without an address is not returned. Any discovery error discards partial results on every platform.
+- `stopBroadcast()` is idempotent and safe to call repeatedly, including after failed or timed-out
+  publish attempts.
+- Android and Electron wait for stop confirmation. A failed or timed-out stop returns `error: true`
+  and `publishing: true` because the service may still be active. The registration is retained for
+  cleanup, and a replacement advertisement is not started until stopping succeeds.
+- On Android versions before T extension 7, mDNS operations hold a reference-counted Wi-Fi
+  multicast lock. Overlapping publishing and discovery keep separate references, so completing
+  discovery does not disable multicast for the active advertisement. Failed publish/stop attempts
+  release their lock reference while retaining any registration needed for late cleanup.
+- iOS IPv6 addresses with an interface scope retain it as a `%<scope-id>` suffix.
+- All platforms return IPv4 addresses before IPv6, retaining discovery order within each family.
+  Electron removes exact duplicate address strings from both discovery and watch snapshots.
+  Android retains the scope suffix provided by the OS. Electron's Bonjour library may return
+  link-local IPv6 without an interface scope; sorting does not make those addresses usable on an
+  IPv6-only network. Try suitable addresses rather than treating `hosts[0]` as a reachability guarantee.
+- On iOS a denied Local Network permission makes `discover()` report an error instead of returning an
+  empty list after the timeout.
+- Android resolves discovered services one at a time before API 34 (a platform limit of
+  `NsdManager.resolveService`); on API 34+ resolves run concurrently.
+- Service types use `_name._tcp.` or `_name._udp.` (optional trailing dot). The service label has 1–15 ASCII letters/digits/hyphens, includes a letter, starts and ends with a letter or digit, and has no consecutive hyphens. Types are trimmed and lowercased; absent or blank types default to `_http._tcp.` for broadcast/discover. Watch entries must be nonblank.
+- Broadcast names default to `DevIOArtsMDNS` on all platforms, are trimmed, contain no control characters and fit in 63 UTF-8 bytes. Name filters use normalized prefix matching: dots and hyphens compare equally and a final ` (n)` suffix is ignored. Returned names preserve actual advertised spelling. Bonjour on Electron changes dots to hyphens when publishing; native platforms can retain dots.
+- Ports must be integer numbers from 1 to 65535. Timeout defaults to 3000 ms; nonnumeric or non-finite values are errors, fractions are truncated and delays clamped to 0–2147483647 ms.
+- TXT publication works on all three platforms. Values must be strings. Keys must be nonempty printable ASCII without `=`, unique ignoring ASCII case. Each UTF-8 `key=value` entry fits in 255 bytes; the complete TXT record fits in 1300 bytes including the length byte for each entry (the common Android limit). Validation runs before replacing a broadcast.
+- Android cancels an unconfirmed registration immediately through its original listener; it does not wait indefinitely for a publish confirmation. Failed cancellation is retained for a stop retry.
+- Electron reports name conflicts immediately when Bonjour stops its probe; it does not rename the
+  service. A service stopped during its probe sends no goodbye records, so a rejected duplicate does
+  not evict the original service from other browsers. Once announcement records have been prepared,
+  stopping sends goodbye even if the send callback and `up` event have not arrived yet. Stopped
+  services ignore late announcement attempts. This behavior is tested with Bonjour 1.4.0;
+  the supported dependency range is `~1.4.0`.
+- Electron creates the Bonjour socket only when the first network operation starts. A failed response
+  to an incoming query is logged and leaves publication, discovery and watches running. Transport
+  `error` events remain fatal: they fail pending operations and stop watches. After a fatal transport
+  error, destroy the instance and create a new one.
+- On a fresh iOS installation, the Local Network prompt may outlast a discovery or publish timeout;
+  the system may also report denial before the user answers. The plugin does not distinguish a
+  pending permission prompt from explicit denial. Explain why access is needed, then allow the user
+  to retry the operation after granting it. This first-run sequence still needs physical-device testing.

package/electron/dist/plugin-settings.js

@@ -0,0 +1,22 @@
+'use strict';
+
+/**
+ * Metadata consumed by the capacitor-electron runtime generator (`npx cap-electron sync`).
+ *
+ * Import path for the JS layer: `@devioarts/capacitor-mdns/electron/settings`.
+ */
+const pluginSettings = {
+    pluginClass: 'mDNS',
+    pluginMethods: [
+        'getPluginPlatform',
+        'startBroadcast',
+        'stopBroadcast',
+        'discover',
+        'watchServices',
+        'stopWatching',
+    ],
+    pluginEvents: ['serviceFound', 'serviceLost', 'watchError'],
+};
+
+exports.pluginSettings = pluginSettings;
+//# sourceMappingURL=plugin-settings.js.map

package/electron/dist/plugin-settings.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"plugin-settings.js","sources":["../build/electron/src/plugin-settings.js"],"sourcesContent":["/**\n * Metadata consumed by the capacitor-electron runtime generator (`npx cap-electron sync`).\n *\n * Import path for the JS layer: `@devioarts/capacitor-mdns/electron/settings`.\n */\nexport const pluginSettings = {\n    pluginClass: 'mDNS',\n    pluginMethods: [\n        'getPluginPlatform',\n        'startBroadcast',\n        'stopBroadcast',\n        'discover',\n        'watchServices',\n        'stopWatching',\n    ],\n    pluginEvents: ['serviceFound', 'serviceLost', 'watchError'],\n};\n//# sourceMappingURL=plugin-settings.js.map"],"names":[],"mappings":";;AAAA;AACA;AACA;AACA;AACA;AACY,MAAC,cAAc,GAAG;AAC9B,IAAI,WAAW,EAAE,MAAM;AACvB,IAAI,aAAa,EAAE;AACnB,QAAQ,mBAAmB;AAC3B,QAAQ,gBAAgB;AACxB,QAAQ,eAAe;AACvB,QAAQ,UAAU;AAClB,QAAQ,eAAe;AACvB,QAAQ,cAAc;AACtB,KAAK;AACL,IAAI,YAAY,EAAE,CAAC,cAAc,EAAE,aAAa,EAAE,YAAY,CAAC;AAC/D;;;;"}