@dawidzawada/bonjour-zeroconf 1.0.0

package/nitrogen/generated/shared/c++/ScanOptions.hpp

@@ -0,0 +1,75 @@
+///
+/// ScanOptions.hpp
+/// This file was generated by nitrogen. DO NOT MODIFY THIS FILE.
+/// https://github.com/mrousavy/nitro
+/// Copyright © 2025 Marc Rousavy @ Margelo
+///
+
+#pragma once
+
+#if __has_include(<NitroModules/JSIConverter.hpp>)
+#include <NitroModules/JSIConverter.hpp>
+#else
+#error NitroModules cannot be found! Are you sure you installed NitroModules properly?
+#endif
+#if __has_include(<NitroModules/NitroDefines.hpp>)
+#include <NitroModules/NitroDefines.hpp>
+#else
+#error NitroModules cannot be found! Are you sure you installed NitroModules properly?
+#endif
+#if __has_include(<NitroModules/JSIHelpers.hpp>)
+#include <NitroModules/JSIHelpers.hpp>
+#else
+#error NitroModules cannot be found! Are you sure you installed NitroModules properly?
+#endif
+
+
+
+#include <optional>
+
+namespace margelo::nitro::dawidzawada_bonjourzeroconf {
+
+  /**
+   * A struct which can be represented as a JavaScript object (ScanOptions).
+   */
+  struct ScanOptions {
+  public:
+    std::optional<double> addressResolveTimeout     SWIFT_PRIVATE;
+
+  public:
+    ScanOptions() = default;
+    explicit ScanOptions(std::optional<double> addressResolveTimeout): addressResolveTimeout(addressResolveTimeout) {}
+  };
+
+} // namespace margelo::nitro::dawidzawada_bonjourzeroconf
+
+namespace margelo::nitro {
+
+  // C++ ScanOptions <> JS ScanOptions (object)
+  template <>
+  struct JSIConverter<margelo::nitro::dawidzawada_bonjourzeroconf::ScanOptions> final {
+    static inline margelo::nitro::dawidzawada_bonjourzeroconf::ScanOptions fromJSI(jsi::Runtime& runtime, const jsi::Value& arg) {
+      jsi::Object obj = arg.asObject(runtime);
+      return margelo::nitro::dawidzawada_bonjourzeroconf::ScanOptions(
+        JSIConverter<std::optional<double>>::fromJSI(runtime, obj.getProperty(runtime, "addressResolveTimeout"))
+      );
+    }
+    static inline jsi::Value toJSI(jsi::Runtime& runtime, const margelo::nitro::dawidzawada_bonjourzeroconf::ScanOptions& arg) {
+      jsi::Object obj(runtime);
+      obj.setProperty(runtime, "addressResolveTimeout", JSIConverter<std::optional<double>>::toJSI(runtime, arg.addressResolveTimeout));
+      return obj;
+    }
+    static inline bool canConvert(jsi::Runtime& runtime, const jsi::Value& value) {
+      if (!value.isObject()) {
+        return false;
+      }
+      jsi::Object obj = value.getObject(runtime);
+      if (!nitro::isPlainObject(runtime, obj)) {
+        return false;
+      }
+      if (!JSIConverter<std::optional<double>>::canConvert(runtime, obj.getProperty(runtime, "addressResolveTimeout"))) return false;
+      return true;
+    }
+  };
+
+} // namespace margelo::nitro

package/nitrogen/generated/shared/c++/ScanResult.hpp

@@ -0,0 +1,92 @@
+///
+/// ScanResult.hpp
+/// This file was generated by nitrogen. DO NOT MODIFY THIS FILE.
+/// https://github.com/mrousavy/nitro
+/// Copyright © 2025 Marc Rousavy @ Margelo
+///
+
+#pragma once
+
+#if __has_include(<NitroModules/JSIConverter.hpp>)
+#include <NitroModules/JSIConverter.hpp>
+#else
+#error NitroModules cannot be found! Are you sure you installed NitroModules properly?
+#endif
+#if __has_include(<NitroModules/NitroDefines.hpp>)
+#include <NitroModules/NitroDefines.hpp>
+#else
+#error NitroModules cannot be found! Are you sure you installed NitroModules properly?
+#endif
+#if __has_include(<NitroModules/JSIHelpers.hpp>)
+#include <NitroModules/JSIHelpers.hpp>
+#else
+#error NitroModules cannot be found! Are you sure you installed NitroModules properly?
+#endif
+
+
+
+#include <string>
+#include <optional>
+
+namespace margelo::nitro::dawidzawada_bonjourzeroconf {
+
+  /**
+   * A struct which can be represented as a JavaScript object (ScanResult).
+   */
+  struct ScanResult {
+  public:
+    std::string name     SWIFT_PRIVATE;
+    std::optional<std::string> ipv4     SWIFT_PRIVATE;
+    std::optional<std::string> ipv6     SWIFT_PRIVATE;
+    std::optional<std::string> hostname     SWIFT_PRIVATE;
+    std::optional<double> port     SWIFT_PRIVATE;
+
+  public:
+    ScanResult() = default;
+    explicit ScanResult(std::string name, std::optional<std::string> ipv4, std::optional<std::string> ipv6, std::optional<std::string> hostname, std::optional<double> port): name(name), ipv4(ipv4), ipv6(ipv6), hostname(hostname), port(port) {}
+  };
+
+} // namespace margelo::nitro::dawidzawada_bonjourzeroconf
+
+namespace margelo::nitro {
+
+  // C++ ScanResult <> JS ScanResult (object)
+  template <>
+  struct JSIConverter<margelo::nitro::dawidzawada_bonjourzeroconf::ScanResult> final {
+    static inline margelo::nitro::dawidzawada_bonjourzeroconf::ScanResult fromJSI(jsi::Runtime& runtime, const jsi::Value& arg) {
+      jsi::Object obj = arg.asObject(runtime);
+      return margelo::nitro::dawidzawada_bonjourzeroconf::ScanResult(
+        JSIConverter<std::string>::fromJSI(runtime, obj.getProperty(runtime, "name")),
+        JSIConverter<std::optional<std::string>>::fromJSI(runtime, obj.getProperty(runtime, "ipv4")),
+        JSIConverter<std::optional<std::string>>::fromJSI(runtime, obj.getProperty(runtime, "ipv6")),
+        JSIConverter<std::optional<std::string>>::fromJSI(runtime, obj.getProperty(runtime, "hostname")),
+        JSIConverter<std::optional<double>>::fromJSI(runtime, obj.getProperty(runtime, "port"))
+      );
+    }
+    static inline jsi::Value toJSI(jsi::Runtime& runtime, const margelo::nitro::dawidzawada_bonjourzeroconf::ScanResult& arg) {
+      jsi::Object obj(runtime);
+      obj.setProperty(runtime, "name", JSIConverter<std::string>::toJSI(runtime, arg.name));
+      obj.setProperty(runtime, "ipv4", JSIConverter<std::optional<std::string>>::toJSI(runtime, arg.ipv4));
+      obj.setProperty(runtime, "ipv6", JSIConverter<std::optional<std::string>>::toJSI(runtime, arg.ipv6));
+      obj.setProperty(runtime, "hostname", JSIConverter<std::optional<std::string>>::toJSI(runtime, arg.hostname));
+      obj.setProperty(runtime, "port", JSIConverter<std::optional<double>>::toJSI(runtime, arg.port));
+      return obj;
+    }
+    static inline bool canConvert(jsi::Runtime& runtime, const jsi::Value& value) {
+      if (!value.isObject()) {
+        return false;
+      }
+      jsi::Object obj = value.getObject(runtime);
+      if (!nitro::isPlainObject(runtime, obj)) {
+        return false;
+      }
+      if (!JSIConverter<std::string>::canConvert(runtime, obj.getProperty(runtime, "name"))) return false;
+      if (!JSIConverter<std::optional<std::string>>::canConvert(runtime, obj.getProperty(runtime, "ipv4"))) return false;
+      if (!JSIConverter<std::optional<std::string>>::canConvert(runtime, obj.getProperty(runtime, "ipv6"))) return false;
+      if (!JSIConverter<std::optional<std::string>>::canConvert(runtime, obj.getProperty(runtime, "hostname"))) return false;
+      if (!JSIConverter<std::optional<double>>::canConvert(runtime, obj.getProperty(runtime, "port"))) return false;
+      return true;
+    }
+  };
+
+} // namespace margelo::nitro

package/package.json

@@ -0,0 +1,169 @@
+{
+  "name": "@dawidzawada/bonjour-zeroconf",
+  "version": "1.0.0",
+  "description": "React Native Zeroconf scanner using Bonjour (iOS) and NSD (Android). Powered by Nitro Modules.",
+  "main": "./lib/module/index.js",
+  "types": "./lib/typescript/src/index.d.ts",
+  "exports": {
+    ".": {
+      "source": "./src/index.ts",
+      "types": "./lib/typescript/src/index.d.ts",
+      "default": "./lib/module/index.js"
+    },
+    "./package.json": "./package.json"
+  },
+  "files": [
+    "src",
+    "lib",
+    "android",
+    "ios",
+    "cpp",
+    "nitrogen",
+    "nitro.json",
+    "*.podspec",
+    "react-native.config.js",
+    "!ios/build",
+    "!android/build",
+    "!android/gradle",
+    "!android/gradlew",
+    "!android/gradlew.bat",
+    "!android/local.properties",
+    "!**/__tests__",
+    "!**/__fixtures__",
+    "!**/__mocks__",
+    "!**/.*"
+  ],
+  "scripts": {
+    "example": "yarn workspace @dawidzawada/bonjour-zeroconf-example",
+    "test": "jest",
+    "typecheck": "tsc",
+    "lint": "eslint \"**/*.{js,ts,tsx}\"",
+    "clean": "del-cli android/build example/android/build example/android/app/build example/ios/build lib",
+    "prepare": "bob build",
+    "nitrogen": "nitrogen",
+    "release": "release-it --only-version"
+  },
+  "keywords": [
+    "react-native",
+    "ios",
+    "android"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/dawidzawada/bonjour-zeroconf.git"
+  },
+  "author": "Dawid Zawada <dawidzaw7@gmail.com> (https://github.com/dawidzawada)",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/dawidzawada/bonjour-zeroconf/issues"
+  },
+  "homepage": "https://github.com/dawidzawada/bonjour-zeroconf#readme",
+  "publishConfig": {
+    "registry": "https://registry.npmjs.org/",
+    "access": "public"
+  },
+  "devDependencies": {
+    "@commitlint/config-conventional": "^19.8.1",
+    "@eslint/compat": "^1.3.2",
+    "@eslint/eslintrc": "^3.3.1",
+    "@eslint/js": "^9.35.0",
+    "@evilmartians/lefthook": "^1.12.3",
+    "@react-native/babel-preset": "0.81.1",
+    "@react-native/eslint-config": "^0.81.1",
+    "@release-it/conventional-changelog": "^10.0.1",
+    "@types/jest": "^29.5.14",
+    "@types/react": "^19.1.0",
+    "commitlint": "^19.8.1",
+    "del-cli": "^6.0.0",
+    "eslint": "^9.35.0",
+    "eslint-config-prettier": "^10.1.8",
+    "eslint-plugin-prettier": "^5.5.4",
+    "jest": "^29.7.0",
+    "nitrogen": "0.31.8",
+    "prettier": "^3.6.2",
+    "react": "19.1.0",
+    "react-native": "0.81.1",
+    "react-native-builder-bob": "^0.40.13",
+    "react-native-nitro-modules": "0.31.8",
+    "release-it": "^19.0.4",
+    "turbo": "^2.5.6",
+    "typescript": "^5.9.2"
+  },
+  "peerDependencies": {
+    "react": "*",
+    "react-native": "*",
+    "react-native-nitro-modules": "0.31.8"
+  },
+  "workspaces": [
+    "example"
+  ],
+  "packageManager": "yarn@3.6.1",
+  "jest": {
+    "preset": "react-native",
+    "modulePathIgnorePatterns": [
+      "<rootDir>/example/node_modules",
+      "<rootDir>/lib/"
+    ]
+  },
+  "commitlint": {
+    "extends": [
+      "@commitlint/config-conventional"
+    ]
+  },
+  "release-it": {
+    "git": {
+      "commitMessage": "chore: release ${version}",
+      "tagName": "v${version}"
+    },
+    "npm": {
+      "publish": true
+    },
+    "github": {
+      "release": true
+    },
+    "plugins": {
+      "@release-it/conventional-changelog": {
+        "preset": {
+          "name": "angular"
+        }
+      }
+    }
+  },
+  "prettier": {
+    "quoteProps": "consistent",
+    "singleQuote": true,
+    "tabWidth": 2,
+    "trailingComma": "es5",
+    "useTabs": false
+  },
+  "react-native-builder-bob": {
+    "source": "src",
+    "output": "lib",
+    "targets": [
+      [
+        "custom",
+        {
+          "script": "nitrogen",
+          "clean": "nitrogen/"
+        }
+      ],
+      [
+        "module",
+        {
+          "esm": true
+        }
+      ],
+      [
+        "typescript",
+        {
+          "project": "tsconfig.build.json"
+        }
+      ]
+    ]
+  },
+  "create-react-native-library": {
+    "languages": "kotlin-swift",
+    "type": "nitro-module",
+    "version": "0.54.6"
+  }
+}

package/src/index.ts

@@ -0,0 +1,22 @@
+import { NitroModules } from 'react-native-nitro-modules';
+import type { BonjourZeroconf } from './specs/BonjourZeroconf.nitro';
+import { useIsScanning } from './useIsScanning';
+import { type ScanResult } from './specs/ScanResult';
+import { type ScanOptions } from './specs/BonjourZeroconf.nitro';
+import { BonjourFail } from './specs/BonjourFail';
+import {
+  requestLocalNetworkPermission,
+  useLocalNetworkPermission,
+} from './permissions';
+
+export const Scanner =
+  NitroModules.createHybridObject<BonjourZeroconf>('BonjourZeroconf');
+
+export {
+  useIsScanning,
+  requestLocalNetworkPermission,
+  useLocalNetworkPermission,
+  BonjourFail,
+  type ScanResult,
+  type ScanOptions,
+};

package/src/permissions.ios.ts

@@ -0,0 +1,27 @@
+import { NitroModules } from 'react-native-nitro-modules';
+import type { LocalNetworkPermission } from './specs/LocalNetworkPermission.nitro';
+import { useEffect, useState } from 'react';
+
+const LocalNetworkPermission =
+  NitroModules.createHybridObject<LocalNetworkPermission>(
+    'LocalNetworkPermission'
+  );
+
+export const requestLocalNetworkPermission = async () => {
+  return await LocalNetworkPermission.requestPermission();
+};
+
+export const useLocalNetworkPermission = () => {
+  const [permissionGranted, setPermissionGranted] = useState(false);
+
+  useEffect(() => {
+    const { remove } = LocalNetworkPermission.listenForPermission((granted) => {
+      setPermissionGranted(granted);
+    });
+    return () => {
+      remove();
+    };
+  }, []);
+
+  return [permissionGranted, requestLocalNetworkPermission];
+};

package/src/permissions.ts

@@ -0,0 +1,7 @@
+export const requestLocalNetworkPermission = async () => {
+  return true;
+};
+
+export const useLocalNetworkPermission = () => {
+  return [true, requestLocalNetworkPermission];
+};

package/src/specs/BonjourFail.ts

@@ -0,0 +1,5 @@
+export enum BonjourFail {
+  RESOLVE_FAILED,
+  EXTRACTION_FAILED,
+  DISCOVERY_FAILED,
+}

package/src/specs/BonjourListener.ts

@@ -0,0 +1,3 @@
+export interface BonjourListener {
+  remove: () => void;
+}

package/src/specs/BonjourZeroconf.nitro.ts

@@ -0,0 +1,20 @@
+import type { HybridObject } from 'react-native-nitro-modules';
+import type { BonjourFail } from './BonjourFail';
+import type { BonjourListener } from './BonjourListener';
+import type { ScanResult } from './ScanResult';
+
+export interface ScanOptions {
+  addressResolveTimeout?: number;
+}
+
+export interface BonjourZeroconf
+  extends HybridObject<{ ios: 'swift'; android: 'kotlin' }> {
+  readonly isScanning: boolean;
+  scan(type: string, domain: string, options?: ScanOptions): void;
+  stop(): void;
+  listenForScanResults(
+    onResult: (results: ScanResult[]) => void
+  ): BonjourListener;
+  listenForScanState(onChange: (isScanning: boolean) => void): BonjourListener;
+  listenForScanFail(onFail: (fail: BonjourFail) => void): BonjourListener;
+}

package/src/specs/LocalNetworkPermission.nitro.ts

@@ -0,0 +1,7 @@
+import type { HybridObject } from 'react-native-nitro-modules';
+import type { BonjourListener } from './BonjourListener';
+
+export interface LocalNetworkPermission extends HybridObject<{ ios: 'swift' }> {
+  requestPermission(): Promise<boolean>;
+  listenForPermission(onChange: (granted: boolean) => void): BonjourListener;
+}

package/src/specs/ScanResult.ts

@@ -0,0 +1,7 @@
+export interface ScanResult {
+  name: string;
+  ipv4?: string;
+  ipv6?: string;
+  hostname?: string;
+  port?: number;
+}

package/src/useIsScanning.ts

@@ -0,0 +1,17 @@
+import { useEffect, useState } from 'react';
+import { Scanner } from './index';
+
+export const useIsScanning = () => {
+  const [scanRunning, setScanRunning] = useState(false);
+
+  useEffect(() => {
+    const { remove } = Scanner.listenForScanState((scanning) => {
+      setScanRunning(scanning);
+    });
+    return () => {
+      remove();
+    };
+  }, []);
+
+  return scanRunning;
+};