u8-mqtt 0.3.2-0 → 0.4.1

package/cjs/v4.cjs

@@ -520,6 +520,198 @@ const mqtt_opts_v4 =
     encode_fns: mqtt_encode_v4,
     mqtt_writer: mqtt_writer_v4, };
 
+function parse(str, loose) {
+	if (str instanceof RegExp) return { keys:false, pattern:str };
+	var c, o, tmp, ext, keys=[], pattern='', arr = str.split('/');
+	arr[0] || arr.shift();
+
+	while (tmp = arr.shift()) {
+		c = tmp[0];
+		if (c === '*') {
+			keys.push('wild');
+			pattern += '/(.*)';
+		} else if (c === ':') {
+			o = tmp.indexOf('?', 1);
+			ext = tmp.indexOf('.', 1);
+			keys.push( tmp.substring(1, !!~o ? o : !!~ext ? ext : tmp.length) );
+			pattern += !!~o && !~ext ? '(?:/([^/]+?))?' : '/([^/]+?)';
+			if (!!~ext) pattern += (!!~o ? '?' : '') + '\\' + tmp.substring(ext);
+		} else {
+			pattern += '/' + tmp;
+		}
+	}
+
+	return {
+		keys: keys,
+		pattern: new RegExp('^' + pattern + (loose ? '(?=$|\/)' : '\/?$'), 'i')
+	};
+}
+
+/*
+class AbstractTopicRouter ::
+  async invoke(pkt, ctx) ::
+  add(topic_route, ...args) ::
+  remove(topic_route, priority) ::
+  clear(priority) ::
+  find(topic) :: // optional
+  mqtt_topic(topic_route)
+*/
+
+const with_topic_router = mqtt_topic_router =>
+  MQTTKlass => class extends MQTTKlass {
+    static _aliases() {
+      return super._aliases() +
+        ' sub_topic:subscribe_topic unsub_topic:unsubscribe_topic'}
+
+    _init_router(opt, client, target) {
+      let router = this.router = target.router =
+        mqtt_topic_router(opt, this);
+      return router?.invoke}
+    get on_topic() {return this.router.add}
+
+    _sub_chain(topic, ex, topic_prefix) {
+      let res = this.subscribe([[ topic ]], ex, topic_prefix);
+      let subs = this.subs ||(this.subs = new Map());
+      subs.set((res.topic = topic), (subs.last = res));
+      return this }// fluent api -- return this and track side effects
+
+    // alias: sub_topic
+    subscribe_topic(topic_route, ...args) {
+      let router = this.router;
+      router.add(topic_route, true, args.pop() );// handler
+      let topic = router.mqtt_topic(topic_route);
+      return this._sub_chain(topic, ...args ) }// ex, topic_prefix
+
+    // alias: unsub_topic
+    unsubscribe_topic(topic_route, ...args) {
+      let router = this.router;
+      router.remove(topic_route, true);
+      let topic = router.mqtt_topic(topic_route);
+      return this.unsubscribe([[ topic ]], ...args ) } };// topic_prefix
+
+// Use [regexparam][] for url-like topic parsing
+//  [regexparam]: https://github.com/lukeed/regexparam
+
+
+const with_topic_path_router = /* #__PURE__ */
+  with_topic_router(mqtt_topic_path_router);
+
+
+const mqtt_topic = topic_route =>
+  topic_route
+    .replace(/[*].*$/, '#')
+    .replace(/:\w+\??/g, '+');
+
+/* From the [MQTT v5 Spec](https://docs.oasis-open.org/mqtt/mqtt/v5.0/os/mqtt-v5.0-os.html#_Topic_Names_and)
+4.7.1.2 Multi-level wildcard -- (‘#’ U+0023)
+... MUST be specified either on its own or following a topic level separator.
+In either case it MUST be the last character specified in the Topic Filter
+
+4.7.1.3 Single-level wildcard -- (‘+’ U+002B)
+...it MUST occupy an entire level of the filter.
+*/
+
+const as_topic_path = (topic_route, id) =>(
+  id=1,
+  topic_route
+    .replace(/#$/, '*' )// replace MQTT '#' multi-level wildcard at end
+    .replace(/\+/g, () => `:$${id++}` ) );// replace MQTT '+' single-level wildcards
+
+function _ignore(pkt, params, ctx) {ctx.done = true;}
+
+function mqtt_topic_path_router() {
+  let pri_lsts = [[],[]], rm = Symbol();
+  let find = topic => _routes_iter(pri_lsts, topic);
+
+  // return duck-type compatible with AbstractTopicRouter in ./with_topic_router
+  return {find, mqtt_topic,
+    add(topic_route, ...args) {
+      let fn = args.pop();
+      let priority = args.pop();
+
+      if ('function' !== typeof fn) {
+        if (false === fn) {
+          fn = _ignore;}
+        else throw new TypeError()}
+
+      let rte = parse(as_topic_path(topic_route));
+
+      rte.key = topic_route;
+      rte.tgt = fn;
+      pri_lsts[priority ? 0 : 1].push(rte);
+      return this}
+
+  , remove(topic_route, priority) {
+      let lst = pri_lsts[priority ? 0 : 1];
+      return _route_remove([lst], topic_route)}
+
+  , clear(priority) {
+      pri_lsts[priority ? 0 : 1] = [];
+      if (null == priority) {
+        pri_lsts[1] = [];} }
+
+  , async invoke(pkt, ctx) {
+      ctx.idx = 0;
+      ctx.rm = rm;
+
+      for (let [fn, params] of find(pkt.topic)) {
+        let res = await fn(pkt, params, ctx);
+
+        if (rm === res) {
+          _route_remove(pri_lsts, fn);}
+
+        if (ctx.done) {
+          break}
+        else ctx.idx++;}
+
+      let {pkt_id, qos} = pkt;
+      if (1 === qos) {
+        await ctx.mqtt._send('puback', {pkt_id});} } } }
+
+
+function * _routes_iter(all_route_lists, topic) {
+  for (let route_list of all_route_lists) {
+    for (let route of route_list) {
+      let res = _route_match_one(topic, route);
+      if (undefined !== res) {
+        yield res;} } } }
+
+
+function _route_match_one(topic, {keys, pattern, tgt}) {
+  let match = '/' !== topic[0]
+    ? pattern.exec('/'+topic)
+    : pattern.exec(topic);
+
+  if (null === match) {
+    return}
+
+  if (false === keys) {
+    let {groups} = match;
+    if (! groups) {
+      return [tgt]}
+
+    let params = {};
+    for (let k in groups) {
+      params[k] = groups[k];}
+
+    return [tgt, params]}
+
+  if (0 === keys.length) {
+    return [tgt]}
+
+  let params = {};
+  for (let i=0; i<keys.length; i++) {
+    params[ keys[i] ] = match[1+i];}
+  return [tgt, params]}
+
+
+function _route_remove(all_route_lists, query) {
+  let match = route => route===query || route.tgt===query || route.key===query;
+  for (let lst of all_route_lists) {
+    let i = lst.findIndex(match);
+    if (0 <= i) {return !! lst.splice(i,1)} }
+  return false}
+
 /*
 export function decode_varint_loop(u8, i=0) {
   let i0 = i
@@ -701,138 +893,13 @@ function _ping_interval(send_ping) {
     if (td) {
       tid = setInterval(send_ping, 1000 * td);
       
-
-
+        
+        
       
-      // ensure the interval allows the NodeJS event loop to exit
-      tid.unref?.();
+        // ensure the interval allows the NodeJS event loop to exit
+        tid.unref?.();
       return true} }) }
 
-function parse(str, loose) {
-	if (str instanceof RegExp) return { keys:false, pattern:str };
-	var c, o, tmp, ext, keys=[], pattern='', arr = str.split('/');
-	arr[0] || arr.shift();
-
-	while (tmp = arr.shift()) {
-		c = tmp[0];
-		if (c === '*') {
-			keys.push('wild');
-			pattern += '/(.*)';
-		} else if (c === ':') {
-			o = tmp.indexOf('?', 1);
-			ext = tmp.indexOf('.', 1);
-			keys.push( tmp.substring(1, !!~o ? o : !!~ext ? ext : tmp.length) );
-			pattern += !!~o && !~ext ? '(?:/([^/]+?))?' : '/([^/]+?)';
-			if (!!~ext) pattern += (!!~o ? '?' : '') + '\\' + tmp.substring(ext);
-		} else {
-			pattern += '/' + tmp;
-		}
-	}
-
-	return {
-		keys: keys,
-		pattern: new RegExp('^' + pattern + (loose ? '(?=$|\/)' : '\/?$'), 'i')
-	};
-}
-
-// Use [regexparam][] for url-like topic parsing
-
-function _ignore(pkt, params, ctx) {ctx.done = true;}
-
-function _mqtt_topic_router() {
-  let pri_lsts = [[],[]], rm = Symbol();
-  let find = topic => _mqtt_routes_iter(pri_lsts, topic);
-
-  return {find,
-
-    add(topic_route, ...args) {
-      let fn = args.pop();
-      let priority = args.pop();
-
-      if ('function' !== typeof fn) {
-        if (false === fn) {
-          fn = _ignore;}
-        else throw new TypeError()}
-
-      let rte = parse(
-        topic_route.replace(/[+#]$/, '*'));
-
-      rte.key = topic_route;
-      rte.tgt = fn;
-      pri_lsts[priority ? 0 : 1].push(rte);
-      return this}
-
-  , remove(topic_route, priority) {
-      let lst = pri_lsts[priority ? 0 : 1];
-      return _mqtt_route_remove([lst], topic_route)}
-
-  , clear(priority) {
-      pri_lsts[priority ? 0 : 1] = [];
-      if (null == priority) {
-        pri_lsts[1] = [];} }
-
-  , async invoke(pkt, ctx) {
-      ctx.idx = 0;
-      ctx.rm = rm;
-
-      for (let [fn, params] of find(pkt.topic)) {
-        let res = await fn(pkt, params, ctx);
-
-        if (rm === res) {
-          _mqtt_route_remove(pri_lsts, fn);}
-
-        if (ctx.done) {
-          break}
-        else ctx.idx++;}
-
-      let {pkt_id, qos} = pkt;
-      if (1 === qos) {
-        await ctx.mqtt._send('puback', {pkt_id});} } } }
-
-
-function * _mqtt_routes_iter(all_route_lists, topic) {
-  for (let route_list of all_route_lists) {
-    for (let route of route_list) {
-      let res = _mqtt_route_match_one(topic, route);
-      if (undefined !== res) {
-        yield res;} } } }
-
-
-function _mqtt_route_match_one(topic, {keys, pattern, tgt}) {
-  let match = '/' !== topic[0]
-    ? pattern.exec('/'+topic)
-    : pattern.exec(topic);
-
-  if (null === match) {
-    return}
-
-  if (false === keys) {
-    let {groups} = match;
-    if (! groups) {
-      return [tgt]}
-
-    let params = {};
-    for (let k in groups) {
-      params[k] = groups[k];}
-
-    return [tgt, params]}
-
-  if (0 === keys.length) {
-    return [tgt]}
-
-  let params = {};
-  for (let i=0; i<keys.length; i++) {
-    params[ keys[i] ] = match[1+i];}
-  return [tgt, params]}
-
-
-function _mqtt_route_remove(all_route_lists, query) {
-  let match = route => route===query || route.tgt===query || route.key===query;
-  for (let lst of all_route_lists) {
-    let i = lst.findIndex(match);
-    if (0 <= i) {return !! lst.splice(i,1)} }
-  return false}
-
 const _mqtt_cmdid_dispatch ={
   create(target) {
     return {__proto__: this, target, hashbelt: [new Map()]} }
@@ -901,8 +968,7 @@ const _mqtt_cmdid_dispatch ={
       let fn = target[`mqtt_${pkt.type}`]
         || target.mqtt_pkt;
 
-      if (undefined !== fn) {
-        await fn.call(target, pkt, ctx);} } })()) };
+      await fn?.call(target, pkt, ctx);} })()) };
 
 function _mqtt_dispatch(opt, target) {
   let _disp_ = _mqtt_cmdid_dispatch.create(target);
@@ -983,53 +1049,15 @@ class MQTTBase {
 
 
   // alias: sub
-  subscribe(pkt, ex) {
-    pkt = _as_topics(pkt, ex);
+  subscribe(pkt, ex, topic_prefix) {
+    pkt = _as_topics(pkt, ex, topic_prefix);
     return this._send('subscribe', pkt, pkt)}
-  _sub_chain(topic, ex) {
-    let res = this.subscribe([[ topic ]], ex);
-    let subs = this.subs ||(this.subs = new Map());
-    subs.set((res.topic = topic), (subs.last = res));
-    return this }// fluent api -- return this and track side effects
 
   // alias: unsub
-  unsubscribe(pkt, ex) {
-    pkt = _as_topics(pkt, ex);
+  unsubscribe(pkt, ex, topic_prefix) {
+    pkt = _as_topics(pkt, ex, topic_prefix);
     return this._send('unsubscribe', pkt, pkt)}
 
-  get on_topic() {return this.router.add}
-
-  // alias: sub_topic
-  subscribe_topic(topic_route, ...args) {
-    this.router.add(topic_route, true, args.pop() );// handler
-    let topic = this.topic_for(topic_route);
-    return this._sub_chain(topic, args.pop() ) }// ex
-
-  // alias: unsub_topic
-  unsubscribe_topic(topic_route) {
-    this.router.remove(topic_route, true);
-    let topic = this.topic_for(topic_route);
-    return this.unsubscribe([[ topic ]]) }
-
-  // alias: shared_sub
-  shared_subscribe(group, topic_route, ...args) {
-    this.router.add(topic_route, true, args.pop() );// handler
-    let topic = this.topic_for(topic_route);
-    if (null != group) {
-      topic = `$share/${group}/${topic}`;}
-    return this._sub_chain(topic, args.pop() ) }// ex
-
-  // alias: shared_unsub
-  shared_unsubscribe(group, topic_route) {
-    this.router.remove(topic_route, true);
-    let topic = this.topic_for(topic_route);
-    if (null != group) {
-      topic = `$share/${group}/${topic}`;}
-    return this.unsubscribe([[ topic ]]) }
-
-  topic_for(topic_route) {
-    return topic_route.replace(/[:*].*$/, '#')}
-
 
   // alias: pub
   publish(pkt, pub_opt) {return _pub(this, pkt, pub_opt)}
@@ -1055,9 +1083,9 @@ class MQTTBase {
     if (undefined === cid) {
       this.client_id = cid = (
         
-
+          
         
-        this.new_client_id(parts)
+          this.new_client_id(parts)
         );}
 
     return cid}
@@ -1066,66 +1094,80 @@ class MQTTBase {
     return [parts[0], Math.random().toString(36).slice(2), parts[1]].join('')}
 
   
+    
+      
+      
+      
+        
+        
+      
 
 
+  // Internal API
 
+  /* async _send(type, pkt) -- provided by _conn_ and transport */
 
+  _init_dispatch(opt) {
+    this.constructor?._once_();
+    let target ={__proto__: opt.on_mqtt_type};
+    target.mqtt_publish ||=
+      this._init_router?.(opt, this, target);
+    return _mqtt_dispatch(this, target)}
 
+  static _aliases() {
+    return ' pub:publish sub:subscribe unsub:unsubscribe '}
 
+  static _once_(self=this) {
+    self._once_ = _=>0;
+    self.MQTTError = MQTTError;
+    let p = self.prototype;
+    for (let alias of self._aliases().split(/\s+/)) {
+      alias = alias.split(':');
+      let fn = alias[1] && p[alias[1]];
+      if (fn) {p[alias[0]] = fn;} } } }
 
 
+/*
+on_mqtt_type = {
+  mqtt_auth(pkt, ctx) ::
+  mqtt_connect(pkt, ctx) ::
+  mqtt_connack(pkt, ctx) ::
+  mqtt_disconnect(pkt, ctx) ::
+
+  mqtt_publish(pkt, ctx)
+  mqtt_subscribe(pkt, ctx) ::
+  mqtt_unsubscribe(pkt, ctx) ::
+
+  mqtt_pingreq(pkt, ctx) ::
+  mqtt_pingresp(pkt, ctx) ::
+}
+*/
 
-  // Internal API
-
-  /* async _send(type, pkt) -- provided by _conn_ and transport */
-
-  _init_router(opt) {
-    return this.router = _mqtt_topic_router()}
-
-  _init_dispatch(opt) {
-    let tgt ={
-      __proto__: opt.on_mqtt_type || {}
-    , router: this._init_router(opt, this)};
-
-    tgt.mqtt_publish ||= tgt.router.invoke;
-    return _mqtt_dispatch(this, tgt)} }
 
+const _prefix_topics = (topic_prefix, iterable) =>
+  Array.from(iterable, value =>(
+    value.trim // string
+      ? _prefix_topics(topic_prefix, value)
+      : topic_prefix + value) );
 
- {
-  let p = MQTTBase.prototype;
-  Object.assign(p,{
-    MQTTError
-  , pub: p.publish
-  , sub: p.subscribe
-  , unsub: p.unsubscribe
-  , sub_topic: p.subscribe_topic
-  , unsub_topic: p.unsubscribe_topic
-  , shared_sub: p.shared_subscribe
-  , shared_unsub: p.shared_unsubscribe} );
-
-  /*
-    p.on_mqtt_type = {
-      mqtt_auth(pkt, ctx) ::
-      mqtt_connect(pkt, ctx) ::
-      mqtt_connack(pkt, ctx) ::
-      mqtt_disconnect(pkt, ctx) ::
-
-      mqtt_publish(pkt, ctx)
-      mqtt_subscribe(pkt, ctx) ::
-      mqtt_unsubscribe(pkt, ctx) ::
-
-      mqtt_pingreq(pkt, ctx) ::
-      mqtt_pingresp(pkt, ctx) ::
-    }
-  */}
+function _as_topics(pkt, ex, topic_prefix) {
+  if (ex?.trim) {// string
+    topic_prefix = ex;
+    ex = null;}
 
+  pkt =(
+    pkt.trim // string
+      ? {topics:[pkt], ... ex}
+    : pkt[Symbol.iterator]
+      ? {topics:[... pkt], ... ex}
+    : ex ? {...pkt, ...ex}
+    : pkt);
 
-function _as_topics(pkt, ex) {
-  if ('string' === typeof pkt) {
-    return {topics:[pkt], ... ex}}
-  if (pkt[Symbol.iterator]) {
-    return {topics:[... pkt], ... ex}}
-  return ex ? {...pkt, ...ex} : pkt}
+  if (topic_prefix) {
+    // particularly useful with shared queues, e.g.
+    //   topic_prefix = '$share/some-queue-name/'
+    pkt.topics = _prefix_topics(topic_prefix, pkt.topics);}
+  return pkt}
 
 
 async function _pub(self, pkt, pub_opt) {
@@ -1241,53 +1283,53 @@ class MQTTCore extends MQTTBase {
 
 
   
+    
+      
+      
+      
+        
+          
 
+    
+      
+      
+        
+          
 
+    
+      
+        
+        
+          
 
+    
+      
+      
+        
 
+      
+      
 
+  
+    with_tcp(...opt) {
+      opt = this._conn_opt(opt);
+      console.log({opt});
+      return this._use_conn (() =>
+        this.with_stream(
+          node_net.connect(opt)) ) }
 
+    with_tls(...opt) {
+      opt = this._conn_opt(opt);
+      return this._use_conn (() =>
+        this.with_stream(
+          node_tls.connect(opt)) ) }
 
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-  
-  with_tcp(...opt) {
-    opt = this._conn_opt(opt);
-    console.log({opt});
-    return this._use_conn (() =>
-      this.with_stream(
-        node_net.connect(opt)) ) }
-
-  with_tls(...opt) {
-    opt = this._conn_opt(opt);
-    return this._use_conn (() =>
-      this.with_stream(
-        node_tls.connect(opt)) ) }
-
-  _conn_opt([a0, a1, a2]) {
-    // (port, hostname, options) or (url, options)
-    if (Number.isFinite(a0)) {
-      return {...a2, port: a0, host: a1}}
-    a0 = new URL(a0);
-    return {...a1, port: a0.port, host: a0.hostname}}
+    _conn_opt([a0, a1, a2]) {
+      // (port, hostname, options) or (url, options)
+      if (Number.isFinite(a0)) {
+        return {...a2, port: a0, host: a1}}
+      a0 = new URL(a0);
+      return {...a1, port: a0.port, host: a0.hostname}}
 
 
   with_stream(read_stream, write_stream) {
@@ -1333,10 +1375,11 @@ class MQTTCore extends MQTTBase {
 
     return this} }
 
-const version = '0.3.2-0';
+const version = '0.4.1';
 
 const MQTTClient_v4 = /* #__PURE__ */
-  MQTTCore.mqtt_ctx(4, mqtt_opts_v4);
+  with_topic_path_router(
+    MQTTCore.mqtt_ctx(4, mqtt_opts_v4) );
 
 const mqtt_v4 = opt =>
   new MQTTClient_v4(opt);