u8-mqtt 0.6.2 → 0.6.4

package/cjs/basic-v4.cjs

@@ -6,56 +6,34 @@ var node_net = require('node:net');
 var node_tls = require('node:tls');
 
 function encode_varint(n, a=[]) {
-  do {
-    const ni = n & 0x7f;
-    n >>>= 7;
-    a.push( ni | (0===n ? 0 : 0x80) );
-  } while (n > 0)
+  a.push((n<0x80 ? 0 : 0x80) | (n & 0x7f));
+  for(; ( n>>>=7 ) > 0 ;)
+    a.push((n<0x80 ? 0 : 0x80) | (n & 0x7f));
   return a
 }
 
+function decode_varint$1(u8, i0=0, invalid) {
+  let shift=0, i=i0, b=u8[i++], n=(b & 0x7f);
+  for(; b & 0x80;)
+    n |= ((b=u8[i++]) & 0x7f) << (shift += 7);
 
-/*
-export function decode_varint_loop(u8, i=0) {
-  let i0 = i
-  let shift = 0, n = (u8[i] & 0x7f)
-  while ( 0x80 & u8[i++] )
-    n |= (u8[i] & 0x7f) << (shift += 7)
-
-  return [n, i, i0]
-}
-*/
-
-
-function decode_varint$1(u8, i=0) {
-  let i0 = i;
-  // unrolled for a max of 4 chains
-  let n = (u8[i] & 0x7f) <<  0;
-  if ( 0x80 & u8[i++] ) {
-    n |= (u8[i] & 0x7f) <<  7;
-    if ( 0x80 & u8[i++] ) {
-      n |= (u8[i] & 0x7f) << 14;
-      if ( 0x80 & u8[i++] ) {
-        n |= (u8[i] & 0x7f) << 21;
-      }
-    }
-  }
-  return [n, i, i0]
+  return (u8.length < i)
+    ? [invalid, i0, i0] // fail: insuffecient u8 bytes to decode
+    : [n, i, i0] // successful value
 }
 
-class U8_Reason extends Number {
-  static of(v, pkt_kind, by_kind) {
-    let self = new this(v);
-    self.reason = by_kind?.[pkt_kind]?.get(v) || pkt_kind;
-    return self
+class mqtt_reason extends Number {
+  constructor(v, reason) {
+    super(v);
+    this.reason = `:${(this.ok = v<0x80) ? 'ok' : 'fail'}:${reason}`;
   }
 }
 
 let mqtt_reader_v4$1 = class mqtt_reader_v4 {
-  static of(buf) { return this.prototype.of(buf) }
-  of(buf) {
+  static for(pkt, u8_body) { return new this().of(u8_body, {pkt}) }
+  of(buf, opt) {
     let step = (width, k) => (k=0|step.k, step.k=k+width, k);
-    return {__proto__: this, buf, step}
+    return {__proto__: this, buf, step, ...opt}
   }
 
   has_more() {
@@ -98,7 +76,7 @@ let mqtt_reader_v4$1 = class mqtt_reader_v4 {
   reason(pkt_kind) {
     let v = this.buf[this.step(1)];
     if (null != v)
-      return U8_Reason.of(v, pkt_kind, this._reasons_by)
+      return new mqtt_reason(v, this._reason_for?.(v, pkt_kind))
   }
 
   flush() {
@@ -109,28 +87,57 @@ let mqtt_reader_v4$1 = class mqtt_reader_v4 {
 
 };
 
-function mqtt_reader_info(mqtt_reader, ... info_fn_list) {
-  mqtt_reader = class extends mqtt_reader {
-    static reasons(pkt_type, ...reason_entries) {
-      let proto = this.prototype;
-      proto._reasons_by = {... proto._reasons_by};
-
-      let lut = (proto._reasons_by[pkt_type] ||= new Map());
-      for (let [u8, reason] of reason_entries)
-        lut.set( u8, reason );
+function with_reasons(mqtt_reader, by_kind) {
+  for (let [k,lut] of Object.entries(by_kind))
+    by_kind[k] = new Map(lut);
 
-      return this
+  return class extends mqtt_reader {
+    _reason_for(v, pkt_kind) {
+      return by_kind[pkt_kind]?.get(v) || by_kind.all.get(v)
     }
-  };
+    warn(msg) {
+      let pkt = this.pkt;
+      pkt.warn ? pkt.warn(msg, pkt)
+        : console.warn('[u8-mqtt-packet] '+msg);
+    }
+  }
+}
 
-  for (let fn_info of info_fn_list)
-    fn_info(mqtt_reader);
 
-  return mqtt_reader
-}
+const reasons_v4 =  {
+  connack: [
+    [ 0x01, 'conn refused: unacceptable protocol version'],
+    [ 0x02, 'conn refused: identifier rejected'],
+    [ 0x03, 'conn refused: server unavailable'],
+    [ 0x04, 'conn refused: bad user name or password'],
+    [ 0x05, 'conn refused: not authorized'],
+  ],
+  suback: [
+    [ 0x00, 'qos=0'],
+    [ 0x01, 'qos=1'],
+    [ 0x02, 'qos=2'],
+  ],
+  unsuback: [
+    [ 0x11, 'no subscription existed'],
+  ],
+  puback: [
+    [ 0x10, 'no matching subscribers'],
+  ],
+  all: [
+    [ 0, ''], // Success
+    [ 0x80, 'unspecified error'], // disconnect puback suback unsuback
+    [ 0x83, 'implementation specific error'], // connack disconnect puback suback unsuback
+    [ 0x87, 'not authorized'], // connack disconnect puback suback unsuback
+    [ 0x8F, 'topic filter invalid'], // disconnect suback unsuback
+    [ 0x91, 'packet identifier in use'], // puback suback unsuback
+    [ 0x92, 'packet identifier not found' ], // pubxxx
+  ]};
+
+const mqtt_reader_v4 = /* #__PURE__ */
+  with_reasons(mqtt_reader_v4$1, reasons_v4);
 
 class mqtt_writer_v4 {
-  static of() { return this.prototype.of() }
+  static for(pkt) { return new this().of() }
   of() { return {__proto__: this, $:[]} }
 
   static init() { return this }
@@ -201,128 +208,6 @@ class mqtt_writer_v4 {
   }
 }
 
-function mqtt_decode_connack(ns, mqtt_reader) {
-  class _connack_flags_ extends Number {
-    get session_present() { return this & 0x01 !== 0 }
-  }
-
-  return ns[0x2] = (pkt, u8_body) => {
-    let rdr = mqtt_reader.of(u8_body);
-
-    pkt.flags =
-      rdr.flags(_connack_flags_);
-
-    pkt.reason = rdr.reason(pkt.type);
-    if (5 <= pkt.mqtt_level)
-      pkt.props = rdr.props();
-    return pkt }
-}
-
-
-function _connack_v4(mqtt_reader) {
-  mqtt_reader.reasons('connack',
-    // MQTT 3.1.1
-    [ 0x00, 'Success'],
-    [ 0x01, 'Connection refused, unacceptable protocol version'],
-    [ 0x02, 'Connection refused, identifier rejected'],
-    [ 0x03, 'Connection refused, server unavailable'],
-    [ 0x04, 'Connection refused, bad user name or password'],
-    [ 0x05, 'Connection refused, not authorized'],
-  );
-}
-
-function mqtt_decode_publish(ns, mqtt_reader) {
-  return ns[0x3] = (pkt, u8_body) => {
-    let {hdr} = pkt;
-    pkt.dup = Boolean(hdr & 0x8);
-    pkt.retain = Boolean(hdr & 0x1);
-    let qos = pkt.qos = (hdr>>1) & 0x3;
-
-    let rdr = mqtt_reader.of(u8_body);
-    pkt.topic = rdr.utf8();
-    if (0 !== qos)
-      pkt.pkt_id = rdr.u16();
-
-    if (5 <= pkt.mqtt_level)
-      pkt.props = rdr.props();
-
-    pkt.payload = rdr.flush();
-    return pkt }
-}
-
-function mqtt_decode_puback(ns, mqtt_reader) {
-  return ns[0x4] = (pkt, u8_body) => {
-    let rdr = mqtt_reader.of(u8_body);
-
-    pkt.pkt_id = rdr.u16();
-    if (5 <= pkt.mqtt_level) {
-      pkt.reason = rdr.reason(pkt.type);
-      pkt.props = rdr.props();
-    }
-
-    return pkt }
-}
-
-function _mqtt_decode_suback(mqtt_reader) {
-  return (pkt, u8_body) => {
-    let rdr = mqtt_reader.of(u8_body);
-
-    pkt.pkt_id = rdr.u16();
-    if (5 <= pkt.mqtt_level)
-      pkt.props = rdr.props();
-
-    let answers = pkt.answers = [];
-    while (rdr.has_more())
-      answers.push(
-        rdr.reason(pkt.type) );
-
-    return pkt }
-}
-
-function mqtt_decode_suback(ns, mqtt_reader) {
-  return ns[0x9] = _mqtt_decode_suback(mqtt_reader)
-}
-
-function _suback_v4(mqtt_reader) {
-  mqtt_reader.reasons('suback',
-    // MQTT 3.1.1
-    [ 0x00, 'Granted QoS 0'],
-    [ 0x01, 'Granted QoS 1'],
-    [ 0x02, 'Granted QoS 2'],
-  );
-}
-
-function mqtt_decode_unsuback(ns, mqtt_reader) {
-  return ns[0xb] = _mqtt_decode_suback(mqtt_reader)
-}
-
-function _unsuback_v4(mqtt_reader) {
-  mqtt_reader.reasons('unsuback',
-    // MQTT 3.1.1
-    [ 0x00, 'Success'],
-    [ 0x11, 'No subscription existed'],
-    [ 0x80, 'Unspecified error'],
-    [ 0x83, 'Implementation specific error'],
-    [ 0x87, 'Not authorized'],
-    [ 0x8F, 'Topic Filter invalid'],
-    [ 0x91, 'Packet Identifier in use'],
-  );
-}
-
-function mqtt_decode_pingxxx(ns) {
-  return ns[0xc] = ns[0xd] = pkt => pkt
-}
-
-function mqtt_decode_disconnect(ns, mqtt_reader) {
-  return ns[0xe] = (pkt, u8_body) => {
-    if (u8_body && 5 <= pkt.mqtt_level) {
-      let rdr = mqtt_reader.of(u8_body);
-      pkt.reason = rdr.reason(pkt.type);
-      pkt.props = rdr.props();
-    }
-    return pkt }
-}
-
 function mqtt_encode_connect(ns, mqtt_writer) {
   const _c_mqtt_proto = new Uint8Array([
     0, 4, 0x4d, 0x51, 0x54, 0x54 ]);
@@ -341,7 +226,7 @@ function mqtt_encode_connect(ns, mqtt_writer) {
       | ( will.retain ? 0x20 : 0 );
 
   return ns.connect = ( mqtt_level, pkt ) => {
-    let wrt = mqtt_writer.of(pkt);
+    let wrt = mqtt_writer.for(pkt);
 
     wrt.push(_c_mqtt_proto);
     wrt.u8( mqtt_level );
@@ -379,10 +264,27 @@ function mqtt_encode_connect(ns, mqtt_writer) {
   }
 }
 
+function mqtt_decode_connack(ns, mqtt_reader) {
+  class _connack_flags_ extends Number {
+    get session_present() { return this & 0x01 !== 0 }
+  }
+
+  return ns[0x2] = (pkt, u8_body) => {
+    let rdr = mqtt_reader.for(pkt, u8_body);
+
+    pkt.flags =
+      rdr.flags(_connack_flags_);
+
+    pkt.reason = rdr.reason(pkt.type);
+    if (5 <= pkt.mqtt_level)
+      pkt.props = rdr.props();
+    return pkt }
+}
+
 function mqtt_encode_publish(ns, mqtt_writer) {
   return ns.publish = ( mqtt_level, pkt ) => {
     let qos = (pkt.qos & 0x3) << 1;
-    let wrt = mqtt_writer.of(pkt);
+    let wrt = mqtt_writer.for(pkt);
 
     wrt.utf8(pkt.topic);
     if (0 !== qos)
@@ -400,9 +302,28 @@ function mqtt_encode_publish(ns, mqtt_writer) {
   }
 }
 
+function mqtt_decode_publish(ns, mqtt_reader) {
+  return ns[0x3] = (pkt, u8_body) => {
+    let {hdr} = pkt;
+    pkt.dup = Boolean(hdr & 0x8);
+    pkt.retain = Boolean(hdr & 0x1);
+    let qos = pkt.qos = (hdr>>1) & 0x3;
+
+    let rdr = mqtt_reader.for(pkt, u8_body);
+    pkt.topic = rdr.utf8();
+    if (0 !== qos)
+      pkt.pkt_id = rdr.u16();
+
+    if (5 <= pkt.mqtt_level)
+      pkt.props = rdr.props();
+
+    pkt.payload = rdr.flush();
+    return pkt }
+}
+
 function mqtt_encode_puback(ns, mqtt_writer) {
   return ns.puback = ( mqtt_level, pkt ) => {
-    let wrt = mqtt_writer.of(pkt);
+    let wrt = mqtt_writer.for(pkt);
 
     wrt.u16(pkt.pkt_id);
     if (5 <= mqtt_level) {
@@ -414,6 +335,20 @@ function mqtt_encode_puback(ns, mqtt_writer) {
   }
 }
 
+
+function mqtt_decode_puback(ns, mqtt_reader) {
+  return ns[0x4] = (pkt, u8_body) => {
+    let rdr = mqtt_reader.for(pkt, u8_body);
+
+    pkt.pkt_id = rdr.u16();
+    if (5 <= pkt.mqtt_level) {
+      pkt.reason = rdr.reason(pkt.type);
+      pkt.props = rdr.props();
+    }
+
+    return pkt }
+}
+
 function mqtt_encode_subscribe(ns, mqtt_writer) {
   const _enc_subscribe_flags = opts => 0
       | ( opts.qos & 0x3 )
@@ -421,7 +356,7 @@ function mqtt_encode_subscribe(ns, mqtt_writer) {
       | ( (opts.retain_handling & 0x3) << 2 );
 
   return ns.subscribe = ( mqtt_level, pkt ) => {
-    let wrt = mqtt_writer.of(pkt);
+    let wrt = mqtt_writer.for(pkt);
 
     wrt.u16(pkt.pkt_id);
     if (5 <= mqtt_level)
@@ -447,9 +382,25 @@ function mqtt_encode_subscribe(ns, mqtt_writer) {
   }
 }
 
+function mqtt_decode_xxsuback(ns, mqtt_reader) {
+  return ns[0x9] = ns[0xb] = (pkt, u8_body) => {
+    let rdr = mqtt_reader.for(pkt, u8_body);
+
+    pkt.pkt_id = rdr.u16();
+    if (5 <= pkt.mqtt_level)
+      pkt.props = rdr.props();
+
+    let answers = pkt.answers = [];
+    while (rdr.has_more())
+      answers.push(
+        rdr.reason(pkt.type) );
+
+    return pkt }
+}
+
 function mqtt_encode_unsubscribe(ns, mqtt_writer) {
   return ns.unsubscribe = ( mqtt_level, pkt ) => {
-    let wrt = mqtt_writer.of(pkt);
+    let wrt = mqtt_writer.for(pkt);
 
     wrt.u16(pkt.pkt_id);
     if (5 <= mqtt_level)
@@ -467,9 +418,14 @@ function mqtt_encode_pingxxx(ns) {
   ns.pingresp = () => new Uint8Array([ 0xd0, 0 ]);
 }
 
+
+function mqtt_decode_pingxxx(ns) {
+  return ns[0xc] = ns[0xd] = pkt => pkt
+}
+
 function mqtt_encode_disconnect(ns, mqtt_writer) {
   return ns.disconnect = ( mqtt_level, pkt ) => {
-    let wrt = mqtt_writer.of(pkt);
+    let wrt = mqtt_writer.for(pkt);
 
     if (pkt && 5 <= mqtt_level) {
       if (pkt.reason || pkt.props) {
@@ -482,15 +438,25 @@ function mqtt_encode_disconnect(ns, mqtt_writer) {
   }
 }
 
-// not a v4 packet: import { mqtt_encode_auth } from './encode/auth.js'
+
+function mqtt_decode_disconnect(ns, mqtt_reader) {
+  return ns[0xe] = (pkt, u8_body) => {
+    if (u8_body && 5 <= pkt.mqtt_level) {
+      let rdr = mqtt_reader.for(pkt, u8_body);
+      pkt.reason = rdr.reason(pkt.type);
+      pkt.props = rdr.props();
+    }
+    return pkt }
+}
+
+// not a v4 packet: import { mqtt_encode_auth, mqtt_decode_auth } from './pkt/auth.js'
 
 
 const mqtt_decode_v4 =  [
   mqtt_decode_connack,
   mqtt_decode_publish,
   mqtt_decode_puback,
-  mqtt_decode_suback,
-  mqtt_decode_unsuback,
+  mqtt_decode_xxsuback,
   mqtt_decode_pingxxx,
   mqtt_decode_disconnect,
 ];
@@ -506,13 +472,6 @@ const mqtt_encode_v4 =  [
   mqtt_encode_disconnect,
 ];
 
-const mqtt_reader_v4 = /* #__PURE__ */
-  mqtt_reader_info(
-    mqtt_reader_v4$1,
-    _connack_v4,
-    _suback_v4,
-    _unsuback_v4,
-  );
 
 const mqtt_opts_v4 = 
   { decode_fns: mqtt_decode_v4,
@@ -520,47 +479,38 @@ const mqtt_opts_v4 =
     encode_fns: mqtt_encode_v4,
     mqtt_writer: mqtt_writer_v4, };
 
-/*
-export function decode_varint_loop(u8, i=0) {
-  let i0 = i
-  let shift = 0, n = (u8[i] & 0x7f)
-  while ( 0x80 & u8[i++] )
-    n |= (u8[i] & 0x7f) << (shift += 7)
+function decode_varint(u8, i0=0, invalid) {
+  let shift=0, i=i0, b=u8[i++], n=(b & 0x7f);
+  for(; b & 0x80;)
+    n |= ((b=u8[i++]) & 0x7f) << (shift += 7);
 
-  return [n, i, i0]
-}
-*/
-
-
-function decode_varint(u8, i=0) {
-  let i0 = i;
-  // unrolled for a max of 4 chains
-  let n = (u8[i] & 0x7f) <<  0;
-  if ( 0x80 & u8[i++] ) {
-    n |= (u8[i] & 0x7f) <<  7;
-    if ( 0x80 & u8[i++] ) {
-      n |= (u8[i] & 0x7f) << 14;
-      if ( 0x80 & u8[i++] ) {
-        n |= (u8[i] & 0x7f) << 21;
-      }
-    }
-  }
-  return [n, i, i0]
+  return (u8.length < i)
+    ? [invalid, i0, i0] // fail: insuffecient u8 bytes to decode
+    : [n, i, i0] // successful value
 }
 
 function mqtt_raw_dispatch(opt) {
-  let u8 = new Uint8Array(0);
+  let u8 = new Uint8Array(0), len_tip=0;
   return u8_buf => {
     u8 = 0 === u8.byteLength
       ? u8_buf : _u8_join(u8, u8_buf);
 
     let res = [];
-    while (1) {
-      let [len_body, len_vh] = decode_varint(u8, 1);
-      let len_pkt = len_body + len_vh;
 
-      if ( u8.byteLength < len_pkt )
-        return res
+    // wait for at least len_tip bytes for next (tip) message
+    while ( u8.byteLength >= len_tip ) {
+
+      // if varint is incomplete, return len_body=NaN
+      let [len_body, len_vh] = decode_varint(u8, 1, NaN);
+      let len_pkt = len_body + len_vh; // may be NaN
+
+      if (!( len_pkt <= u8.byteLength )) {
+        // incomplete packet cases:
+        // - len_pkt is less than available bytes
+        // - len_pkt is NaN from decode_varint() due to lack of data
+        len_tip = len_pkt || 0; // 0 when NaN
+        break
+      }
 
       let b0 = u8[0];
       let u8_body = 0 === len_body ? null
@@ -572,6 +522,8 @@ function mqtt_raw_dispatch(opt) {
       if (null != pkt)
         res.push( pkt );
     }
+
+    return res
   }
 }
 
@@ -582,16 +534,17 @@ function _u8_join(a, b) {
   return r
 }
 
-const _pkt_types = ['~', 'connect', 'connack', 'publish', 'puback', 'pubrec', 'pubrel', 'pubcomp', 'subscribe', 'suback', 'unsubscribe', 'unsuback', 'pingreq', 'pingresp', 'disconnect', 'auth'];
+const _pkt_types =  ['~', 'connect', 'connack', 'publish', 'puback', 'pubrec', 'pubrel', 'pubcomp', 'subscribe', 'suback', 'unsubscribe', 'unsuback', 'pingreq', 'pingresp', 'disconnect', 'auth'];
+
+
+function mqtt_pkt_ctx(mqtt_level, opts, pkt_api=opts.pkt_ctx) {
+  let _as_pkt_ctx = pkt_api => ({
+        __proto__: pkt_api,
+        get hdr() { return this.b0 & 0xf },
+        get id() { return this.b0 >>> 4 },
+        get type() { return _pkt_types[this.b0 >>> 4] },
+        mqtt_level });
 
-function mqtt_pkt_ctx(mqtt_level, opts, pkt_ctx) {
-  pkt_ctx = {
-    __proto__: pkt_ctx || opts.pkt_ctx,
-    mqtt_level,
-    get hdr() { return this.b0 & 0xf },
-    get id() { return this.b0 >>> 4 },
-    get type() { return _pkt_types[this.b0 >>> 4] },
-  };
 
   let op, _decode_by_id=[], _encode_by_type={};
   for (op of opts.encode_fns)
@@ -600,10 +553,10 @@ function mqtt_pkt_ctx(mqtt_level, opts, pkt_ctx) {
     op(_decode_by_id, opts.mqtt_reader);
 
   return {
-    pkt_ctx,
+    pkt_api, pkt_ctx: _as_pkt_ctx(pkt_api),
 
-    encode_pkt(type, pkt) {
-      return _encode_by_type[type]( mqtt_level, pkt ) },
+    encode_pkt: (type, pkt) =>
+      _encode_by_type[type]( mqtt_level, pkt ),
 
     decode_pkt(b0, u8_body) {
       if (b0.map) // Uint8Array in first arg
@@ -612,12 +565,10 @@ function mqtt_pkt_ctx(mqtt_level, opts, pkt_ctx) {
       let fn_decode = _decode_by_id[b0>>>4] || _decode_by_id[0];
       return fn_decode?.({__proto__: this.pkt_ctx, b0}, u8_body) },
 
-    mqtt_stream() {
-      let self = { __proto__: this, pkt_ctx: { __proto__: pkt_ctx } };
-      self.pkt_ctx._base_ = self.pkt_ctx;
+    mqtt_stream(pkt_api=this.pkt_api) {
+      let self = { __proto__: this, pkt_ctx: _as_pkt_ctx(pkt_api) };
       self.decode = mqtt_raw_dispatch(self);
-      return self
-    },
+      return self },
   }
 }
 
@@ -1158,7 +1109,7 @@ class MQTTCore extends MQTTBase {
 
     return this} }
 
-const version = '0.6.2-node';
+const version = '0.6.4-node';
 
 const MQTTClient_v4 = /* #__PURE__ */
   MQTTCore.mqtt_ctx(4, mqtt_opts_v4);