react-native-zeroconf 0.13.8 → 0.15.0

package/dist/index.js

@@ -1 +1,160 @@
-Object.defineProperty(exports,"__esModule",{value:true});exports.ImplType=undefined;var _slicedToArray=function(){function sliceIterator(arr,i){var _arr=[];var _n=true;var _d=false;var _e=undefined;try{for(var _i=arr[typeof Symbol==='function'?Symbol.iterator:'@@iterator'](),_s;!(_n=(_s=_i.next()).done);_n=true){_arr.push(_s.value);if(i&&_arr.length===i)break;}}catch(err){_d=true;_e=err;}finally{try{if(!_n&&_i["return"])_i["return"]();}finally{if(_d)throw _e;}}return _arr;}return function(arr,i){if(Array.isArray(arr)){return arr;}else if((typeof Symbol==='function'?Symbol.iterator:'@@iterator')in Object(arr)){return sliceIterator(arr,i);}else{throw new TypeError("Invalid attempt to destructure non-iterable instance");}};}();var _createClass=function(){function defineProperties(target,props){for(var i=0;i<props.length;i++){var descriptor=props[i];descriptor.enumerable=descriptor.enumerable||false;descriptor.configurable=true;if("value"in descriptor)descriptor.writable=true;Object.defineProperty(target,descriptor.key,descriptor);}}return function(Constructor,protoProps,staticProps){if(protoProps)defineProperties(Constructor.prototype,protoProps);if(staticProps)defineProperties(Constructor,staticProps);return Constructor;};}();var _reactNative=require('react-native');var _events=require('events');function _classCallCheck(instance,Constructor){if(!(instance instanceof Constructor)){throw new TypeError("Cannot call a class as a function");}}function _possibleConstructorReturn(self,call){if(!self){throw new ReferenceError("this hasn't been initialised - super() hasn't been called");}return call&&(typeof call==="object"||typeof call==="function")?call:self;}function _inherits(subClass,superClass){if(typeof superClass!=="function"&&superClass!==null){throw new TypeError("Super expression must either be null or a function, not "+typeof superClass);}subClass.prototype=Object.create(superClass&&superClass.prototype,{constructor:{value:subClass,enumerable:false,writable:true,configurable:true}});if(superClass)Object.setPrototypeOf?Object.setPrototypeOf(subClass,superClass):subClass.__proto__=superClass;}var RNZeroconf=_reactNative.NativeModules.RNZeroconf;var ImplType=exports.ImplType={NSD:'NSD',DNSSD:'DNSSD'};var Zeroconf=function(_EventEmitter){_inherits(Zeroconf,_EventEmitter);function Zeroconf(props){_classCallCheck(this,Zeroconf);var _this=_possibleConstructorReturn(this,(Zeroconf.__proto__||Object.getPrototypeOf(Zeroconf)).call(this,props));_this._services={};_this._publishedServices={};_this._dListeners={};_this.addDeviceListeners();return _this;}_createClass(Zeroconf,[{key:'addDeviceListeners',value:function addDeviceListeners(){var _this2=this;if(Object.keys(this._dListeners).length){return this.emit('error',new Error('RNZeroconf listeners already in place.'));}this._dListeners.start=_reactNative.DeviceEventEmitter.addListener('RNZeroconfStart',function(){return _this2.emit('start');});this._dListeners.stop=_reactNative.DeviceEventEmitter.addListener('RNZeroconfStop',function(){return _this2.emit('stop');});this._dListeners.error=_reactNative.DeviceEventEmitter.addListener('RNZeroconfError',function(err){if(_this2.listenerCount('error')>0){_this2.emit('error',new Error(err));}});this._dListeners.found=_reactNative.DeviceEventEmitter.addListener('RNZeroconfFound',function(service){if(!service||!service.name){return;}var name=service.name;_this2._services[name]=service;_this2.emit('found',name);_this2.emit('update');});this._dListeners.remove=_reactNative.DeviceEventEmitter.addListener('RNZeroconfRemove',function(service){if(!service||!service.name){return;}var name=service.name;delete _this2._services[name];_this2.emit('remove',name);_this2.emit('update');});this._dListeners.resolved=_reactNative.DeviceEventEmitter.addListener('RNZeroconfResolved',function(service){if(!service||!service.name){return;}_this2._services[service.name]=service;_this2.emit('resolved',service);_this2.emit('update');});this._dListeners.published=_reactNative.DeviceEventEmitter.addListener('RNZeroconfServiceRegistered',function(service){if(!service||!service.name){return;}_this2._publishedServices[service.name]=service;_this2.emit('published',service);});this._dListeners.unpublished=_reactNative.DeviceEventEmitter.addListener('RNZeroconfServiceUnregistered',function(service){if(!service||!service.name){return;}delete _this2._publishedServices[service.name];_this2.emit('unpublished',service);});}},{key:'removeDeviceListeners',value:function removeDeviceListeners(){var _this3=this;Object.keys(this._dListeners).forEach(function(name){return _this3._dListeners[name].remove();});this._dListeners={};}},{key:'getServices',value:function getServices(){return this._services;}},{key:'scan',value:function scan(){var type=arguments.length>0&&arguments[0]!==undefined?arguments[0]:'http';var protocol=arguments.length>1&&arguments[1]!==undefined?arguments[1]:'tcp';var domain=arguments.length>2&&arguments[2]!==undefined?arguments[2]:'local.';var implType=arguments.length>3&&arguments[3]!==undefined?arguments[3]:ImplType.NSD;this._services={};this.emit('update');if(_reactNative.Platform.OS==='android'){RNZeroconf.scan(type,protocol,domain,implType);}else{RNZeroconf.scan(type,protocol,domain);}}},{key:'stop',value:function stop(){var implType=arguments.length>0&&arguments[0]!==undefined?arguments[0]:ImplType.NSD;if(_reactNative.Platform.OS==='android'){RNZeroconf.stop(implType);}else{RNZeroconf.stop();}}},{key:'publishService',value:function publishService(type,protocol){var domain=arguments.length>2&&arguments[2]!==undefined?arguments[2]:'local.';var name=arguments[3];var port=arguments[4];var txt=arguments.length>5&&arguments[5]!==undefined?arguments[5]:{};var implType=arguments.length>6&&arguments[6]!==undefined?arguments[6]:ImplType.NSD;if(Object.keys(txt).length!==0){Object.entries(txt).map(function(_ref){var _ref2=_slicedToArray(_ref,2),key=_ref2[0],value=_ref2[1];return txt[key]=value.toString();});}if(_reactNative.Platform.OS==='android'){RNZeroconf.registerService(type,protocol,domain,name,port,txt,implType);}else{RNZeroconf.registerService(type,protocol,domain,name,port,txt);}}},{key:'unpublishService',value:function unpublishService(name){var implType=arguments.length>1&&arguments[1]!==undefined?arguments[1]:ImplType.NSD;if(_reactNative.Platform.OS==='android'){RNZeroconf.unregisterService(name,implType);}else{RNZeroconf.unregisterService(name);}}}]);return Zeroconf;}(_events.EventEmitter);exports.default=Zeroconf;
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = exports.ImplType = void 0;
+var _reactNative = require("react-native");
+var _events = require("events");
+const RNZeroconf = _reactNative.NativeModules.RNZeroconf;
+const ImplType = exports.ImplType = {
+  NSD: 'NSD',
+  DNSSD: 'DNSSD'
+};
+class Zeroconf extends _events.EventEmitter {
+  constructor(props) {
+    super(props);
+    if (!RNZeroconf) {
+      throw new Error('react-native-zeroconf: native module not found. Make sure the library is linked and the app rebuilt. Expo Go is not supported, use a development build instead.');
+    }
+    this._services = {};
+    this._publishedServices = {};
+    this._publishedImplTypes = {};
+    this._scanImplType = null;
+    this._dListeners = {};
+    this.addDeviceListeners();
+  }
+
+  /**
+   * Add all event listeners
+   */
+  addDeviceListeners() {
+    if (Object.keys(this._dListeners).length) {
+      return this.emit('error', new Error('RNZeroconf listeners already in place.'));
+    }
+    this._dListeners.start = _reactNative.DeviceEventEmitter.addListener('RNZeroconfStart', () => this.emit('start'));
+    this._dListeners.stop = _reactNative.DeviceEventEmitter.addListener('RNZeroconfStop', () => this.emit('stop'));
+    this._dListeners.error = _reactNative.DeviceEventEmitter.addListener('RNZeroconfError', err => {
+      if (this.listenerCount('error') > 0) {
+        this.emit('error', new Error(err));
+      }
+    });
+    this._dListeners.found = _reactNative.DeviceEventEmitter.addListener('RNZeroconfFound', service => {
+      if (!service || !service.name) {
+        return;
+      }
+      const {
+        name
+      } = service;
+      this._services[name] = service;
+      this.emit('found', name);
+      this.emit('update');
+    });
+    this._dListeners.remove = _reactNative.DeviceEventEmitter.addListener('RNZeroconfRemove', service => {
+      if (!service || !service.name) {
+        return;
+      }
+      const {
+        name
+      } = service;
+      delete this._services[name];
+      this.emit('remove', name);
+      this.emit('update');
+    });
+    this._dListeners.resolved = _reactNative.DeviceEventEmitter.addListener('RNZeroconfResolved', service => {
+      if (!service || !service.name) {
+        return;
+      }
+      this._services[service.name] = service;
+      this.emit('resolved', service);
+      this.emit('update');
+    });
+    this._dListeners.published = _reactNative.DeviceEventEmitter.addListener('RNZeroconfServiceRegistered', service => {
+      if (!service || !service.name) {
+        return;
+      }
+      this._publishedServices[service.name] = service;
+      this.emit('published', service);
+    });
+    this._dListeners.unpublished = _reactNative.DeviceEventEmitter.addListener('RNZeroconfServiceUnregistered', service => {
+      if (!service || !service.name) {
+        return;
+      }
+      delete this._publishedServices[service.name];
+      this.emit('unpublished', service);
+    });
+  }
+
+  /**
+   * Remove all event listeners and clean map
+   */
+  removeDeviceListeners() {
+    Object.keys(this._dListeners).forEach(name => this._dListeners[name].remove());
+    this._dListeners = {};
+  }
+
+  /**
+   * Get all the services already resolved
+   */
+  getServices() {
+    return this._services;
+  }
+
+  /**
+   * Scan for Zeroconf services,
+   * Defaults to _http._tcp. on local domain
+   */
+  scan(type = 'http', protocol = 'tcp', domain = 'local.', implType = ImplType.NSD) {
+    this._services = {};
+    this.emit('update');
+    if (_reactNative.Platform.OS === 'android') {
+      if (this._scanImplType && implType !== this._scanImplType) {
+        // Only one scan runs at a time, stop the one running on the other implementation
+        RNZeroconf.stop(this._scanImplType);
+      }
+      this._scanImplType = implType;
+      RNZeroconf.scan(type, protocol, domain, implType);
+    } else {
+      RNZeroconf.scan(type, protocol, domain);
+    }
+  }
+
+  /**
+   * Stop current scan if any,
+   * Defaults to the implementation used by the last scan
+   */
+  stop(implType = this._scanImplType || ImplType.NSD) {
+    if (_reactNative.Platform.OS === 'android') {
+      RNZeroconf.stop(implType);
+    } else {
+      RNZeroconf.stop();
+    }
+  }
+
+  /**
+   * Publish a service
+   */
+  publishService(type, protocol, domain = 'local.', name, port, txt = {}, implType = ImplType.NSD) {
+    const txtRecord = Object.fromEntries(Object.entries(txt || {}).map(([key, value]) => [key, String(value)]));
+    if (_reactNative.Platform.OS === 'android') {
+      this._publishedImplTypes[name] = implType;
+      RNZeroconf.registerService(type, protocol, domain, name, port, txtRecord, implType);
+    } else {
+      RNZeroconf.registerService(type, protocol, domain, name, port, txtRecord);
+    }
+  }
+
+  /**
+   * Unpublish a service,
+   * Defaults to the implementation the service was published with
+   */
+  unpublishService(name, implType = this._publishedImplTypes[name] || ImplType.NSD) {
+    if (_reactNative.Platform.OS === 'android') {
+      delete this._publishedImplTypes[name];
+      RNZeroconf.unregisterService(name, implType);
+    } else {
+      RNZeroconf.unregisterService(name);
+    }
+  }
+}
+exports.default = Zeroconf;

package/index.d.ts

@@ -0,0 +1,91 @@
+export declare const ImplType: {
+  readonly NSD: 'NSD'
+  readonly DNSSD: 'DNSSD'
+}
+
+/** Android only: which discovery implementation to use */
+export type ImplType = (typeof ImplType)[keyof typeof ImplType]
+
+export interface Service {
+  /** Human-readable service name */
+  name: string
+  /** Full service name, e.g. `XeroxPrinter.local._http._tcp.` */
+  fullName: string
+  /** Hostname, e.g. `XeroxPrinter.local.` */
+  host: string
+  port: number
+  /** IPv4 and/or IPv6 addresses */
+  addresses: string[]
+  /** TXT record attributes */
+  txt: Record<string, string>
+}
+
+export interface ZeroconfEvents {
+  start: () => void
+  stop: () => void
+  /** Service found, before resolution */
+  found: (name: string) => void
+  /** Service fully resolved with network info */
+  resolved: (service: Service) => void
+  /** Service removed from the network */
+  remove: (name: string) => void
+  /** Services list changed */
+  update: () => void
+  error: (error: Error) => void
+  published: (service: Service) => void
+  unpublished: (service: Service) => void
+}
+
+/** Extends the `events` package EventEmitter */
+export default class Zeroconf {
+  constructor()
+
+  on<E extends keyof ZeroconfEvents>(event: E, listener: ZeroconfEvents[E]): this
+  once<E extends keyof ZeroconfEvents>(event: E, listener: ZeroconfEvents[E]): this
+  addListener<E extends keyof ZeroconfEvents>(event: E, listener: ZeroconfEvents[E]): this
+  removeListener<E extends keyof ZeroconfEvents>(event: E, listener: ZeroconfEvents[E]): this
+  off<E extends keyof ZeroconfEvents>(event: E, listener: ZeroconfEvents[E]): this
+  removeAllListeners(event?: keyof ZeroconfEvents): this
+  listenerCount(event: keyof ZeroconfEvents): number
+
+  /** Add the native event listeners (called automatically in the constructor) */
+  addDeviceListeners(): void
+
+  /** Remove the native event listeners, call it when you are done with the instance */
+  removeDeviceListeners(): void
+
+  /** All the services found so far, keyed by name */
+  getServices(): Record<string, Service>
+
+  /**
+   * Scan for services, defaults to `_http._tcp.` on the `local.` domain
+   * @param implType Android only, defaults to `NSD`
+   */
+  scan(type?: string, protocol?: string, domain?: string, implType?: ImplType): void
+
+  /**
+   * Stop the current scan
+   * @param implType Android only, defaults to the implementation used by the last scan
+   */
+  stop(implType?: ImplType): void
+
+  /**
+   * Publish a service. Type and protocol are passed without underscores, e.g. `('http', 'tcp', ...)`
+   * @param implType Android only, defaults to `NSD`
+   */
+  publishService(
+    type: string,
+    protocol: string,
+    domain: string | undefined,
+    name: string,
+    port: number,
+    txt?: Record<string, string | number | boolean>,
+    implType?: ImplType,
+  ): void
+
+  /**
+   * Unpublish a service
+   * @param implType Android only, defaults to the implementation the service was published with
+   */
+  unpublishService(name: string, implType?: ImplType): void
+}

package/ios/RNZeroconf/RNNetServiceSerializer.m

@@ -35,9 +35,13 @@ const NSString *kRNServiceTxtRecords = @"txt";
         NSMutableDictionary *dict = [[NSMutableDictionary alloc] init];
         for (NSString *key in txtRecordDict) {
             @try{
-                dict[key] = [[NSString alloc]
-                            initWithData:txtRecordDict[key]
-                            encoding:NSASCIIStringEncoding];
+                NSData *value = txtRecordDict[key];
+                NSString *string = [[NSString alloc] initWithData:value encoding:NSUTF8StringEncoding];
+                if (string == nil) {
+                    // Not valid UTF-8, fall back to a lossless 8-bit decoding
+                    string = [[NSString alloc] initWithData:value encoding:NSISOLatin1StringEncoding];
+                }
+                dict[key] = string;
             }
             @catch(NSException *exception){
                 NSLog(@"%@", exception);

package/ios/RNZeroconf/RNZeroconf.m

@@ -106,6 +106,14 @@ RCT_EXPORT_METHOD(unregisterService:(NSString *) serviceName)
       return;
     }
 
+    // Stop any pending resolve for the removed service
+    NSNetService *resolving = self.resolvingServices[service.name];
+    if (resolving) {
+        resolving.delegate = nil;
+        [resolving stop];
+        [self.resolvingServices removeObjectForKey:service.name];
+    }
+
     NSDictionary *serviceInfo = [RNNetServiceSerializer serializeServiceToDictionary:service resolved:NO];
     [self.bridge.eventDispatcher sendDeviceEventWithName:@"RNZeroconfRemove" body:serviceInfo];
 }

package/package.json

@@ -1,10 +1,12 @@
 {
   "name": "react-native-zeroconf",
-  "version": "0.13.8",
+  "version": "0.15.0",
   "description": "A Zeroconf discovery utility for react-native",
   "main": "dist",
+  "types": "index.d.ts",
   "scripts": {
     "lint": "eslint src/*.js",
+    "format": "prettier --write src/*.js",
     "build": "rm -rf dist && mkdir dist && babel src -o dist/index.js"
   },
   "repository": {
@@ -12,10 +14,13 @@
     "url": "git://github.com/Apercu/react-native-zeroconf.git"
   },
   "files": [
+    "src",
     "dist",
+    "index.d.ts",
     "android",
     "ios",
-    "react-native-zeroconf.podspec"
+    "react-native-zeroconf.podspec",
+    "NOTICE"
   ],
   "keywords": [
     "react-component",
@@ -40,23 +45,26 @@
     "react-native": ">=0.60"
   },
   "devDependencies": {
-    "babel-cli": "^6.26.0",
-    "babel-eslint": "^10.0.3",
-    "babel-preset-react-native": "^4.0.1",
-    "eslint": "^6.7.2",
-    "eslint-config-prettier": "^6.7.0",
-    "eslint-config-zavatta": "^6.0.3",
-    "prettier": "^1.19.1"
-  },
-  "eslintConfig": {
-    "extends": [
-      "zavatta",
-      "prettier"
-    ]
+    "@babel/cli": "^7.23.0",
+    "@babel/core": "^7.23.0",
+    "@babel/preset-env": "^7.23.0",
+    "@babel/preset-flow": "^7.23.0",
+    "eslint": "^8.57.0",
+    "eslint-config-prettier": "^9.1.0",
+    "prettier": "^3.2.0"
   },
   "babel": {
     "presets": [
-      "react-native"
+      [
+        "@babel/preset-env",
+        {
+          "targets": {
+            "node": "14"
+          }
+        }
+      ],
+      "@babel/preset-flow"
     ]
-  }
+  },
+  "packageManager": "yarn@1.22.22+sha512.a6b2f7906b721bba3d67d4aff083df04dad64c399707841b7acf00f6b133b7ac24255f2652fa22ae3534329dc6180534e98d17432037ff6fd140556e2bb3137e"
 }

package/src/index.js

@@ -0,0 +1,183 @@
+import { Platform, NativeModules, DeviceEventEmitter } from 'react-native'
+import { EventEmitter } from 'events'
+
+const RNZeroconf = NativeModules.RNZeroconf
+
+export const ImplType = {
+  NSD: 'NSD',
+  DNSSD: 'DNSSD',
+}
+
+export default class Zeroconf extends EventEmitter {
+  constructor(props) {
+    super(props)
+
+    if (!RNZeroconf) {
+      throw new Error(
+        'react-native-zeroconf: native module not found. Make sure the library is linked and the app rebuilt. Expo Go is not supported, use a development build instead.',
+      )
+    }
+
+    this._services = {}
+    this._publishedServices = {}
+    this._publishedImplTypes = {}
+    this._scanImplType = null
+    this._dListeners = {}
+
+    this.addDeviceListeners()
+  }
+
+  /**
+   * Add all event listeners
+   */
+  addDeviceListeners() {
+    if (Object.keys(this._dListeners).length) {
+      return this.emit('error', new Error('RNZeroconf listeners already in place.'))
+    }
+
+    this._dListeners.start = DeviceEventEmitter.addListener('RNZeroconfStart', () =>
+      this.emit('start'),
+    )
+
+    this._dListeners.stop = DeviceEventEmitter.addListener('RNZeroconfStop', () =>
+      this.emit('stop'),
+    )
+
+    this._dListeners.error = DeviceEventEmitter.addListener('RNZeroconfError', err => {
+      if (this.listenerCount('error') > 0) {
+        this.emit('error', new Error(err))
+      }
+    })
+
+    this._dListeners.found = DeviceEventEmitter.addListener('RNZeroconfFound', service => {
+      if (!service || !service.name) {
+        return
+      }
+      const { name } = service
+
+      this._services[name] = service
+      this.emit('found', name)
+      this.emit('update')
+    })
+
+    this._dListeners.remove = DeviceEventEmitter.addListener('RNZeroconfRemove', service => {
+      if (!service || !service.name) {
+        return
+      }
+      const { name } = service
+
+      delete this._services[name]
+
+      this.emit('remove', name)
+      this.emit('update')
+    })
+
+    this._dListeners.resolved = DeviceEventEmitter.addListener('RNZeroconfResolved', service => {
+      if (!service || !service.name) {
+        return
+      }
+
+      this._services[service.name] = service
+      this.emit('resolved', service)
+      this.emit('update')
+    })
+
+    this._dListeners.published = DeviceEventEmitter.addListener(
+      'RNZeroconfServiceRegistered',
+      service => {
+        if (!service || !service.name) {
+          return
+        }
+
+        this._publishedServices[service.name] = service
+        this.emit('published', service)
+      },
+    )
+
+    this._dListeners.unpublished = DeviceEventEmitter.addListener(
+      'RNZeroconfServiceUnregistered',
+      service => {
+        if (!service || !service.name) {
+          return
+        }
+
+        delete this._publishedServices[service.name]
+        this.emit('unpublished', service)
+      },
+    )
+  }
+
+  /**
+   * Remove all event listeners and clean map
+   */
+  removeDeviceListeners() {
+    Object.keys(this._dListeners).forEach(name => this._dListeners[name].remove())
+    this._dListeners = {}
+  }
+
+  /**
+   * Get all the services already resolved
+   */
+  getServices() {
+    return this._services
+  }
+
+  /**
+   * Scan for Zeroconf services,
+   * Defaults to _http._tcp. on local domain
+   */
+  scan(type = 'http', protocol = 'tcp', domain = 'local.', implType = ImplType.NSD) {
+    this._services = {}
+    this.emit('update')
+    if (Platform.OS === 'android') {
+      if (this._scanImplType && implType !== this._scanImplType) {
+        // Only one scan runs at a time, stop the one running on the other implementation
+        RNZeroconf.stop(this._scanImplType)
+      }
+      this._scanImplType = implType
+      RNZeroconf.scan(type, protocol, domain, implType)
+    } else {
+      RNZeroconf.scan(type, protocol, domain)
+    }
+  }
+
+  /**
+   * Stop current scan if any,
+   * Defaults to the implementation used by the last scan
+   */
+  stop(implType = this._scanImplType || ImplType.NSD) {
+    if (Platform.OS === 'android') {
+      RNZeroconf.stop(implType)
+    } else {
+      RNZeroconf.stop()
+    }
+  }
+
+  /**
+   * Publish a service
+   */
+  publishService(type, protocol, domain = 'local.', name, port, txt = {}, implType = ImplType.NSD) {
+    const txtRecord = Object.fromEntries(
+      Object.entries(txt || {}).map(([key, value]) => [key, String(value)]),
+    )
+    if (Platform.OS === 'android') {
+      this._publishedImplTypes[name] = implType
+      RNZeroconf.registerService(type, protocol, domain, name, port, txtRecord, implType)
+    } else {
+      RNZeroconf.registerService(type, protocol, domain, name, port, txtRecord)
+    }
+  }
+
+  /**
+   * Unpublish a service,
+   * Defaults to the implementation the service was published with
+   */
+  unpublishService(name, implType = this._publishedImplTypes[name] || ImplType.NSD) {
+    if (Platform.OS === 'android') {
+      delete this._publishedImplTypes[name]
+      RNZeroconf.unregisterService(name, implType)
+    } else {
+      RNZeroconf.unregisterService(name)
+    }
+  }
+}