u8-mqtt 0.4.0 → 0.5.0

package/README.md

@@ -71,9 +71,9 @@ Built for small footprint with ES Modules (ESM) using embedded [u8-mqtt-packet][
 
 | module                  |   brotli | minified |
 |:------------------------|---------:|---------:|
-| `u8-mqtt`               |   6608 B |  19988 B |
-| `u8-mqtt/esm/v5.min.js` |   6518 B |  19815 B |
-| `u8-mqtt/esm/v4.min.js` |   5434 B |  15405 B |
+| `u8-mqtt`               |   6587 B |  19962 B |
+| `u8-mqtt/esm/v5.min.js` |   6504 B |  19789 B |
+| `u8-mqtt/esm/v4.min.js` |   5420 B |  15379 B |
 
 [automated sizing report](./docs/compressed.md)
 

package/cjs/basic-v4.cjs

@@ -51,7 +51,7 @@ class U8_Reason extends Number {
   }
 }
 
-class mqtt_reader_v4$1 {
+let mqtt_reader_v4$1 = class mqtt_reader_v4 {
   static of(buf) { return this.prototype.of(buf) }
   of(buf) {
     let step = (width, k) => (k=0|step.k, step.k=k+width, k);
@@ -107,7 +107,7 @@ class mqtt_reader_v4$1 {
     return buf.subarray(step.k|0)
   }
 
-}
+};
 
 function mqtt_reader_info(mqtt_reader, ... info_fn_list) {
   mqtt_reader = class extends mqtt_reader {
@@ -482,7 +482,7 @@ function mqtt_encode_disconnect(ns, mqtt_writer) {
   }
 }
 
-// not a v4 packet: import { mqtt_encode_auth } from './encode/auth.mjs'
+// not a v4 packet: import { mqtt_encode_auth } from './encode/auth.js'
 
 
 const mqtt_decode_v4 =  [
@@ -778,6 +778,22 @@ const _mqtt_cmdid_dispatch ={
 
       await fn?.call(target, pkt, ctx);} })()) };
 
+/*
+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 _mqtt_dispatch(opt, target) {
   let _disp_ = _mqtt_cmdid_dispatch.create(target);
   let { cmdids } = _disp_;
@@ -807,28 +823,34 @@ class MQTTError extends Error {
 
 class MQTTBase {
   constructor(opt={}) {
+    this.with(opt);
     this._conn_ = _mqtt_conn(this,
       this._init_dispatch(opt, this)); }
 
+  with(fns_ns) {
+    for (let [k,v] of Object.entries(fns_ns)) {
+      if ('function' === typeof v) {this[k] = v;} }
+    return this}
+
   async conn_emit(evt, arg, err_arg) {
     this.log_conn?.(evt, arg, err_arg);
     try {
-      let fn_evt = this[await evt]; // microtask break
+      let fn_evt = this[await evt]; // microtask break using `await evt`
       if (fn_evt) {
         await fn_evt.call(this, this, arg, err_arg);}
-      else if (err_arg) {
-        await this.on_error(err_arg, evt);} }
+      else if (err_arg) {throw err_arg} }
     catch (err) {
       this.on_error(err, evt);} }
 
-  on_error(err, err_path) {
-    console.warn('[[u8-mqtt error: %s]]', err_path, err); }
+  on_error(err, evt) {
+    console.warn('[[u8-mqtt error: %s]]', evt, err); }
 
   // Handshaking Packets
 
   async connect(pkt={}) {
-    let cid = pkt.client_id || ['u8-mqtt--', ''];
-    if (Array.isArray(cid)) {
+    let cid = pkt.client_id || this.client_id;
+    if ('string' !== typeof cid) {
+      // see init_client_id implementation in core.jsy
       pkt.client_id = cid = this.init_client_id(cid);}
     this.client_id = cid;
 
@@ -854,12 +876,13 @@ class MQTTBase {
     return this._send('auth', pkt, 'auth')}
 
   ping() {return this._send('pingreq', null, 'pingresp')}
-
+  puback({pkt_id}) {return this._send('puback', {pkt_id})}
 
   // alias: sub
   subscribe(pkt, ex, topic_prefix) {
     pkt = _as_topics(pkt, ex, topic_prefix);
-    return this._send('subscribe', pkt, pkt)}
+    let suback = this._send('subscribe', pkt, pkt);
+    return this.on_sub?.(suback, pkt) ?? suback}
 
   // alias: unsub
   unsubscribe(pkt, ex, topic_prefix) {
@@ -867,48 +890,52 @@ class MQTTBase {
     return this._send('unsubscribe', pkt, pkt)}
 
 
-  // alias: pub
-  publish(pkt, pub_opt) {return _pub(this, pkt, pub_opt)}
-  post(topic, payload, pub_opt) {return _pub.m(this, topic, payload, pub_opt)}
-  send(topic, payload, pub_opt) {return _pub.mq(this, topic, payload, pub_opt)}
-  store(topic, payload, pub_opt) {return _pub.mqr(this, topic, payload, pub_opt)}
-
-  json_post(topic, msg, pub_opt) {return _pub.o(this, topic, msg, pub_opt)}
-  json_send(topic, msg, pub_opt) {return _pub.oq(this, topic, msg, pub_opt)}
-  json_store(topic, msg, pub_opt) {return _pub.oqr(this, topic, msg, pub_opt)}
-
-  obj_post(topic, msg, pub_opt) {return _pub.o(this, topic, msg, pub_opt)}
-  obj_send(topic, msg, pub_opt) {return _pub.oq(this, topic, msg, pub_opt)}
-  obj_store(topic, msg, pub_opt) {return _pub.oqr(this, topic, msg, pub_opt)}
-
-
-
-  // Utility Methods
-
-  init_client_id(parts) {
-    let cid = this.client_id;
-
-    if (undefined === cid) {
-      this.client_id = cid = (
-        
-          
-        
-          this.new_client_id(parts)
-        );}
-
-    return cid}
-
-  new_client_id(parts) {
-    return [parts[0], Math.random().toString(36).slice(2), parts[1]].join('')}
-
-  
-    
-      
-      
-      
-        
-        
-      
+  post(topic, payload, pub_opt) {// qos:0
+    return this.pub({topic, payload, qos:0}, pub_opt)}
+  send(topic, payload, pub_opt) {// qos:1
+    return this.pub({topic, payload, qos:1}, pub_opt)}
+  store(topic, payload, pub_opt) {// qos:1, retain: 1
+    return this.pub({topic, payload, qos:1, retain: 1}, pub_opt)}
+
+  // alias: json_post
+  obj_post(topic, msg, pub_opt) {// qos:0
+    return this.pub({topic, msg, arg: 'msg', qos:0}, pub_opt)}
+  // alias: json_send
+  obj_send(topic, msg, pub_opt) {// qos:1
+    return this.pub({topic, msg, arg: 'msg', qos:1}, pub_opt)}
+  // alias: json_store
+  obj_store(topic, msg, pub_opt) {// qos:1, retain: 1
+    return this.pub({topic, msg, arg: 'msg', qos:1, retain: 1}, pub_opt)}
+
+  // alias: publish -- because 'pub' is shorter for semantic aliases above
+  async pub(pkt, pub_opt) {
+    if (undefined === pkt.payload) {
+      if ('function' === typeof pub_opt) {
+        pub_opt = {fn_encode: pub_opt};}
+
+      let {msg} = pkt;
+      switch (typeof msg) {
+        case 'function':
+          pub_opt = {...pub_opt, fn_encode: msg};
+          // flow into 'undefined' case
+        case 'undefined':
+          // return a single-value closure to publish packets
+          return v => this.pub({...pkt, [pkt.arg || 'payload']: v}, pub_opt)}
+
+      // Encode payload from msg; fn_encode allows alternative to JSON.stringify
+      let {fn_encode} = pub_opt || {};
+      pkt.payload = fn_encode
+        ? await fn_encode(msg)
+        : JSON.stringify(msg);}
+
+    if (pub_opt) {
+      if (pub_opt.props) {
+        pkt.props = pub_opt.props;}
+      if (pub_opt.xform) {
+        pkt = pub_opt.xform(pkt) || pkt;} }
+
+    return this._send('publish', pkt,
+      pkt.qos ? pkt : void 0 ) }// key
 
 
   // Internal API
@@ -917,52 +944,24 @@ class MQTTBase {
 
   _init_dispatch(opt) {
     this.constructor?._once_();
-    let router = this.router =
-      this._init_router?.(opt, this);
-
-    let tgt ={
-      __proto__: opt.on_mqtt_type || {}
-    , router};
-
-    tgt.mqtt_publish ||= router?.invoke;
-    return _mqtt_dispatch(this, tgt)}
+    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 '}
+    return ' publish:pub sub:subscribe unsub:unsubscribe json_post:obj_post json_send:obj_send json_store:obj_store'}
 
   static _once_(self=this) {
     self._once_ = _=>0;
-    self.MQTTError = MQTTError;
     let p = self.prototype;
+    p.MQTTError = MQTTError;
     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;
@@ -979,55 +978,11 @@ function _as_topics(pkt, ex, topic_prefix) {
   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}
-
+    let _prefix_topics = v =>
+      v.trim ? topic_prefix+v : v.map(_prefix_topics);
 
-async function _pub(self, pkt, pub_opt) {
-  if (undefined === pkt.payload) {
-    if ('function' === typeof pub_opt) {
-      pub_opt = {fn_encode: pub_opt};}
-
-    let {msg} = pkt;
-    switch (typeof msg) {
-      case 'function':
-        pub_opt = {...pub_opt, fn_encode: msg};
-        // flow into 'undefined' case
-      case 'undefined':
-        // return a single-value closure to publish packets
-        return v => _pub(self, {...pkt, [pkt.arg || 'payload']: v}, pub_opt)
-
-      default:
-        // Encode payload from msg; fn_encode allows alternative to JSON.stringify
-        let {fn_encode} = pub_opt || {};
-        pkt.payload = fn_encode
-          ? await fn_encode(msg)
-          : JSON.stringify(msg);} }
-
-  if (pub_opt) {
-    if (pub_opt.props) {
-      pkt.props = pub_opt.props;}
-    if (pub_opt.xform) {
-      pkt = pub_opt.xform(pkt) || pkt;} }
-
-  return self._send('publish', pkt,
-    pkt.qos ? pkt : void 0 ) }// key
-
- {
-  Object.assign(_pub,{
-    m: (self, topic, payload, pub_opt) =>
-      _pub(self, {topic, payload, qos:0}, pub_opt)
-  , mq: (self, topic, payload, pub_opt) =>
-      _pub(self, {topic, payload, qos:1}, pub_opt)
-  , mqr: (self, topic, payload, pub_opt) =>
-      _pub(self, {topic, payload, qos:1, retain: 1}, pub_opt)
-
-  , o: (self, topic, msg, pub_opt) =>
-      _pub(self, {topic, msg, arg: 'msg', qos:0}, pub_opt)
-  , oq: (self, topic, msg, pub_opt) =>
-      _pub(self, {topic, msg, arg: 'msg', qos:1}, pub_opt)
-  , oqr: (self, topic, msg, pub_opt) =>
-      _pub(self, {topic, msg, arg: 'msg', qos:1, retain: 1}, pub_opt)} ); }
+    pkt.topics = pkt.topics.map(_prefix_topics);}
+  return pkt}
 
 const pkt_api = {
   utf8(u8) { return new TextDecoder('utf-8').decode(u8 || this.payload ) },
@@ -1036,20 +991,27 @@ const pkt_api = {
 };
 
 class MQTTCore extends MQTTBase {
-  constructor(opt={}) {
-    super(opt);
-    this.with(opt);}
-
   static mqtt_ctx(mqtt_level, mqtt_opts, pkt_ctx=pkt_api) {
     let self = class extends this {};
     self.prototype.mqtt_ctx =
       mqtt_pkt_ctx(mqtt_level, mqtt_opts, pkt_ctx);
     return self}
 
-  with(fns_ns) {
-    for (let [k,v] of Object.entries(fns_ns)) {
-      if ('function' === typeof v) {this[k] = v;} }
-    return this}
+
+  // automatic Client Id for connect()
+  init_client_id(parts=['u8-mqtt--','']) {
+    let sess_stg=this.sess_stg;
+    let key, cid = sess_stg?.getItem(key=parts.join(' '));
+    if (! cid) {
+      cid = parts.join(Math.random().toString(36).slice(2));
+      sess_stg?.setItem(key, cid);}
+    return cid}
+
+  get sess_stg() {return globalThis.sessionStorage}
+
+
+  //on_error(err, evt) ::
+  //  console.warn @ '[[u8-mqtt error: %s]]', evt, err
 
   //log_conn(evt, arg, err_arg) ::
   //  console.info @ '[[u8-mqtt log: %s]]', evt, arg, err_arg
@@ -1126,7 +1088,6 @@ 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)) ) }
@@ -1188,7 +1149,7 @@ class MQTTCore extends MQTTBase {
 
     return this} }
 
-const version = '0.4.0';
+const version = '0.5.0';
 
 const MQTTClient_v4 = /* #__PURE__ */
   MQTTCore.mqtt_ctx(4, mqtt_opts_v4);