u8-mqtt 0.3.2-0 → 0.4.1

package/code/base.jsy

@@ -1,5 +1,4 @@
 import {_mqtt_conn} from './_conn.jsy'
-import {_mqtt_topic_router} from './_router.jsy'
 import {_mqtt_dispatch} from './_dispatch.jsy'
 
 export class MQTTError extends Error ::
@@ -60,53 +59,15 @@ export 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)
@@ -156,53 +117,67 @@ export class MQTTBase ::
 
   /* async _send(type, pkt) -- provided by _conn_ and transport */
 
-  _init_router(opt) ::
-    return this.router = _mqtt_topic_router(this)
-
   _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)
-
-
-::
-  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) ::
-  if 'string' === typeof pkt ::
-    return {topics:[pkt], ... ex}
-  if pkt[Symbol.iterator] ::
-    return {topics:[... pkt], ... ex}
-  return ex ? {...pkt, ...ex} : pkt
+    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) ::
+}
+*/
+
+
+const _prefix_topics = (topic_prefix, iterable) =>
+  Array.from @ iterable, value => @
+    value.trim // string
+      ? _prefix_topics(topic_prefix, value)
+      : topic_prefix + value
+
+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
+
+  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) ::

package/code/basic-v4.js

@@ -0,0 +1,18 @@
+import mqtt_opts_v4 from 'u8-mqtt-packet/esm/codec_v4_client.js'
+import MQTTCore from './core.jsy'
+export * from './version.js'
+
+const MQTTClient_v4 = /* #__PURE__ */
+  MQTTCore.mqtt_ctx(4, mqtt_opts_v4)
+
+const mqtt_v4 = opt =>
+  new MQTTClient_v4(opt)
+
+export {
+  MQTTClient_v4,
+  MQTTClient_v4 as MQTTClient,
+
+  mqtt_v4,
+  mqtt_v4 as mqtt,
+  mqtt_v4 as default,
+}

package/code/basic-v5.js

@@ -0,0 +1,26 @@
+import mqtt_opts_v5 from 'u8-mqtt-packet/esm/codec_v5_client.js'
+import MQTTCore from './core.jsy'
+export * from './version.js'
+
+const MQTTClient_v4 = /* #__PURE__ */
+  MQTTCore.mqtt_ctx(4, mqtt_opts_v5)
+
+const MQTTClient_v5 = /* #__PURE__ */
+  MQTTCore.mqtt_ctx(5, mqtt_opts_v5)
+
+const mqtt_v4 = opt =>
+  new MQTTClient_v4(opt)
+
+const mqtt_v5 = opt =>
+  new MQTTClient_v5(opt)
+
+export {
+  MQTTClient_v4,
+  MQTTClient_v5,
+  MQTTClient_v5 as MQTTClient,
+
+  mqtt_v4,
+  mqtt_v5,
+  mqtt_v5 as mqtt,
+  mqtt_v5 as default,
+}

package/code/index.js

@@ -7,7 +7,8 @@ export {
 export * from './core.jsy'
 export * from './base.jsy'
 export * from './_conn.jsy'
-export * from './_router.jsy'
 export * from './_dispatch.jsy'
 export * from './_cmdid_dispatch.jsy'
+export * from './with_topic_router.jsy'
+export * from './router_path.jsy'
 

package/code/{_router.jsy → router_path.jsy}

@@ -2,15 +2,40 @@
 //  [regexparam]: https://github.com/lukeed/regexparam
 
 import {parse as _rxp_parse} from 'regexparam'
+import {with_topic_router} from './with_topic_router.jsy'
+
+export 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.
+*/
+
+export 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
 
-export function _mqtt_topic_router() ::
+function mqtt_topic_path_router() ::
   let pri_lsts = [[],[]], rm = Symbol()
-  let find = topic => _mqtt_routes_iter(pri_lsts, topic)
-
-  return @{} find,
+  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()
@@ -20,8 +45,7 @@ export function _mqtt_topic_router() ::
           fn = _ignore
         else throw new TypeError()
 
-      let rte = _rxp_parse @
-        topic_route.replace(/[+#]$/, '*')
+      let rte = _rxp_parse @ as_topic_path @ topic_route
 
       rte.key = topic_route
       rte.tgt = fn
@@ -30,7 +54,7 @@ export function _mqtt_topic_router() ::
 
     remove(topic_route, priority) ::
       let lst = pri_lsts[priority ? 0 : 1]
-      return _mqtt_route_remove([lst], topic_route)
+      return _route_remove([lst], topic_route)
 
     clear(priority) ::
       pri_lsts[priority ? 0 : 1] = []
@@ -45,7 +69,7 @@ export function _mqtt_topic_router() ::
         let res = await fn(pkt, params, ctx)
 
         if rm === res ::
-          _mqtt_route_remove(pri_lsts, fn)
+          _route_remove(pri_lsts, fn)
 
         if ctx.done ::
           break
@@ -56,15 +80,15 @@ export function _mqtt_topic_router() ::
         await ctx.mqtt._send('puback', {pkt_id})
 
 
-export function * _mqtt_routes_iter(all_route_lists, topic) ::
+function * _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)
+      let res = _route_match_one(topic, route)
       if undefined !== res ::
         yield res
 
 
-export function _mqtt_route_match_one(topic, {keys, pattern, tgt}) ::
+function _route_match_one(topic, {keys, pattern, tgt}) ::
   let match = '/' !== topic[0]
     ? pattern.exec('/'+topic)
     : pattern.exec(topic)
@@ -92,7 +116,7 @@ export function _mqtt_route_match_one(topic, {keys, pattern, tgt}) ::
   return [tgt, params]
 
 
-export function _mqtt_route_remove(all_route_lists, query) ::
+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)

package/code/v4.js

@@ -1,9 +1,11 @@
 import mqtt_opts_v4 from 'u8-mqtt-packet/esm/codec_v4_client.js'
+import {with_topic_path_router} from './router_path.jsy'
 import MQTTCore from './core.jsy'
 export * from './version.js'
 
 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)

package/code/v5.js

@@ -1,12 +1,15 @@
 import mqtt_opts_v5 from 'u8-mqtt-packet/esm/codec_v5_client.js'
+import {with_topic_path_router} from './router_path.jsy'
 import MQTTCore from './core.jsy'
 export * from './version.js'
 
 const MQTTClient_v4 = /* #__PURE__ */
-  MQTTCore.mqtt_ctx(4, mqtt_opts_v5)
+  with_topic_path_router(
+    MQTTCore.mqtt_ctx(4, mqtt_opts_v5) )
 
 const MQTTClient_v5 = /* #__PURE__ */
-  MQTTCore.mqtt_ctx(5, mqtt_opts_v5)
+  with_topic_path_router(
+    MQTTCore.mqtt_ctx(5, mqtt_opts_v5) )
 
 const mqtt_v4 = opt =>
   new MQTTClient_v4(opt)

package/code/with_topic_router.jsy

@@ -0,0 +1,42 @@
+/*
+class AbstractTopicRouter ::
+  async invoke(pkt, ctx) ::
+  add(topic_route, ...args) ::
+  remove(topic_route, priority) ::
+  clear(priority) ::
+  find(topic) :: // optional
+  mqtt_topic(topic_route)
+*/
+
+export 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
+