@seriousme/opifex 1.10.1 → 1.11.0

package/dist/utils/utils.d.ts

@@ -0,0 +1,2 @@
+export declare const noop: () => void;
+//# sourceMappingURL=utils.d.ts.map

package/dist/utils/utils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../utils/utils.ts"],"names":[],"mappings":"AAKA,eAAO,MAAM,IAAI,YAAW,CAAC"}

package/dist/utils/utils.js

@@ -0,0 +1,6 @@
+/*
+ * This file contains utilities used throughout the project too small to
+ * deserve their own dedicated files.
+ */
+export const noop = () => { };
+//# sourceMappingURL=utils.js.map

package/dist/utils/utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.js","sourceRoot":"","sources":["../../utils/utils.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,MAAM,CAAC,MAAM,IAAI,GAAG,GAAG,EAAE,GAAE,CAAC,CAAC"}

package/mqttPacket/auth.ts

@@ -5,13 +5,6 @@ import { Decoder, DecoderError, hasEmptyFlags } from "./decoder.ts";
 import type { TReasonCode } from "./ReasonCode.ts";
 import type { AuthProperties } from "./Properties.ts";
 
-/**
- * An AUTH packet is sent from Client to Server or Server to Client as part of an extended
- * authentication exchange, such as challenge / response authentication.
- * It is a Protocol Error for the Client or Server to send an AUTH packet
- * if the CONNECT packet did not contain the same Authentication Method.
- */
-
 // AuthPacket does not exist on protocol levels < 5
 export type AuthPacketV5 = {
   type: TPacketType;
@@ -20,6 +13,12 @@ export type AuthPacketV5 = {
   properties?: AuthProperties;
 };
 
+/**
+ * An AUTH packet is sent from Client to Server or Server to Client as part of an extended
+ * authentication exchange, such as challenge / response authentication.
+ * It is a Protocol Error for the Client or Server to send an AUTH packet
+ * if the CONNECT packet did not contain the same Authentication Method.
+ */
 export type AuthPacket = AuthPacketV5;
 
 export const auth: {

package/mqttPacket/connack.ts

@@ -17,10 +17,6 @@ import { AuthenticationResultByNumber } from "./AuthenticationResult.ts";
 import type { TReasonCode } from "./ReasonCode.ts";
 import type { ConnackProperties } from "./Properties.ts";
 
-/**
- * ConnackPacket is sent from the server to the client in response to a connect packet.
- * It indicates that the connect is accepted.
- */
 export type ConnackPacketV4 = {
   type: TPacketType;
   protocolLevel: ProtocolLevelNoV5;
@@ -36,6 +32,10 @@ export type ConnackPacketV5 = {
   properties?: ConnackProperties;
 };
 
+/**
+ * ConnackPacket is sent from the server to the client in response to a connect packet.
+ * It indicates that the connect is accepted.
+ */
 export type ConnackPacket = ConnackPacketV4 | ConnackPacketV5;
 
 export const connack: {

package/mqttPacket/connect.ts

@@ -20,9 +20,6 @@ import {
   hasEmptyFlags,
 } from "./decoder.ts";
 
-/**
- * ConnectPacket is sent from the client to the server to initiate a connection.
- */
 export type ConnectPacketV4 = {
   type: TPacketType;
   protocolName?: string;
@@ -61,6 +58,9 @@ export type ConnectPacketV5 = {
   properties?: ConnectProperties;
 };
 
+/**
+ * ConnectPacket is sent from the client to the server to initiate a connection.
+ */
 export type ConnectPacket = ConnectPacketV4 | ConnectPacketV5;
 
 function invalidProtocolName(version: number, name: string): boolean {

package/mqttPacket/disconnect.ts

@@ -10,10 +10,6 @@ import type { DisconnectProperties } from "./Properties.ts";
 import { Encoder } from "./encoder.ts";
 import { ReasonCode } from "./ReasonCode.ts";
 
-/**
- * DisconnectPacket is the final control packet sent from the client to the server.
- * It indicates that the client is disconnecting cleanly.
- */
 export type DisconnectPacketv4 = {
   type: TPacketType;
   protocolLevel: ProtocolLevelNoV5;
@@ -26,6 +22,10 @@ export type DisconnectPacketv5 = {
   properties?: DisconnectProperties;
 };
 
+/**
+ * DisconnectPacket is the final control packet sent from the client to the server.
+ * It indicates that the client is disconnecting cleanly.
+ */
 export type DisconnectPacket = DisconnectPacketv4 | DisconnectPacketv5;
 
 const DISCONNECT_PACKET = new Uint8Array([PacketType.disconnect << 4, 0]);

package/mqttPacket/mod.ts

@@ -209,6 +209,7 @@ export function decodePayload(
 /**
  * @function decode
  * @description Decodes a complete MQTT packet from binary format into a packet object
+ *
  * @param {Uint8Array} buffer - The binary buffer containing the complete MQTT packet
  * @param {CodecOpts} codecOpts - the options for the decoder
  * @returns {AnyPacket} The decoded MQTT packet object

package/mqttPacket/protocolLevels.ts

@@ -4,10 +4,10 @@
 
 import type { ProtocolLevel } from "./types.ts";
 
-// MQTT Protocol levels
+/** available MQTT Protocol levels */
 export const MQTTLevel = {
   unknown: undefined as ProtocolLevel,
   v3: 3 as ProtocolLevel,
   v4: 4 as ProtocolLevel,
   v5: 5 as ProtocolLevel,
-};
+} as const;

package/mqttPacket/pubblishAcks.ts

@@ -10,14 +10,6 @@ import { PacketType } from "./PacketType.ts";
 import { Decoder, DecoderError } from "./decoder.ts";
 import { Encoder } from "./encoder.ts";
 
-/**
- * PubackPacket is sent to indicate publish complete (QoS 1)
- * Pubrec is sent to indicate publish received (QoS 2)
- * Pubrel is sent to indicate publish release (QoS 2)
- * Pubcomp is sent to indicate publish complete (QoS 2)
- *
- * all 4 packets are identical except for packet type
- */
 export type AckPacketV4<T> = {
   type: TPacketType;
   protocolLevel: ProtocolLevelNoV5;
@@ -31,11 +23,25 @@ export type AckPacketV5<T> = {
   reasonCode?: TReasonCode;
   properties?: PubackProperties;
 };
-
+/**
+ * all 4 ack packets are identical except for packet type and flags of Pubrel
+ */
 export type AckPacket<T> = AckPacketV4<T> | AckPacketV5<T>;
+/**
+ * PubackPacket is sent to indicate publish complete (QoS 1)
+ */
 export type PubackPacket = AckPacket<typeof PacketType.puback>;
+/**
+ * Pubrec is sent to indicate publish received (QoS 2)
+ */
 export type PubrecPacket = AckPacket<typeof PacketType.pubrec>;
+/**
+ * Pubrel is sent to indicate publish release (QoS 2)
+ */
 export type PubrelPacket = AckPacket<typeof PacketType.pubrel>;
+/**
+ * Pubcomp is sent to indicate publish complete (QoS 2)
+ */
 export type PubcompPacket = AckPacket<typeof PacketType.pubcomp>;
 
 export type AnyAckPacket =

package/mqttPacket/suback.ts

@@ -12,10 +12,6 @@ import { Encoder } from "./encoder.ts";
 import { Decoder, DecoderError } from "./decoder.ts";
 const validReturnCodes = [0x00, 0x01, 0x02, 0x80];
 
-/**
- * SubackPacket is sent by the server to the client to confirm receipt and
- * processing of a SubscribePacket.
- */
 export type SubackPacketV4 = {
   type: TPacketType;
   protocolLevel: ProtocolLevelNoV5;
@@ -31,6 +27,10 @@ export type SubackPacketV5 = {
   reasonCodes: Array<TReasonCode>;
 };
 
+/**
+ * SubackPacket is sent by the server to the client to confirm receipt and
+ * processing of a SubscribePacket.
+ */
 export type SubackPacket = SubackPacketV4 | SubackPacketV5;
 
 export const suback: {

package/mqttPacket/subscribe.ts

@@ -13,9 +13,6 @@ import { BitMask } from "./BitMask.ts";
 import { Encoder } from "./encoder.ts";
 import { booleanFlag, Decoder, DecoderError } from "./decoder.ts";
 
-/**
- * SubscribePacket is sent from client to server to subscribe to topics
- */
 export type SubscribePacketV4 = {
   type: TPacketType;
   protocolLevel: ProtocolLevelNoV5;
@@ -31,6 +28,9 @@ export type SubscribePacketV5 = {
   subscriptions: Array<SubscriptionV5>;
 };
 
+/**
+ * SubscribePacket is sent from client to server to subscribe to topics
+ */
 export type SubscribePacket = SubscribePacketV4 | SubscribePacketV5;
 /**
  * The topic to subscribe to and the associated QoS

package/mqttPacket/types.ts

@@ -73,6 +73,9 @@ export type ReturnCodes = number[];
  */
 export type ClientId = string;
 
+/**
+ * helper type to limit retain handling values
+ */
 export type TRetainHandling =
   typeof RetainHandling[keyof typeof RetainHandling];
 

package/mqttPacket/unsuback.ts

@@ -10,10 +10,6 @@ import { PacketType } from "./PacketType.ts";
 import { Decoder, hasEmptyFlags } from "./decoder.ts";
 import { Encoder } from "./encoder.ts";
 
-/**
- * UnsubackPacket is sent by the server to the client to confirm receipt
- * of an UnsubscribePacket.
- */
 export type UnsubackPacketV4 = {
   type: TPacketType;
   protocolLevel: ProtocolLevelNoV5;
@@ -28,6 +24,10 @@ export type UnsubackPacketV5 = {
   reasonCodes: Array<TReasonCode>;
 };
 
+/**
+ * UnsubackPacket is sent by the server to the client to confirm receipt
+ * of an UnsubscribePacket.
+ */
 export type UnsubackPacket = UnsubackPacketV4 | UnsubackPacketV5;
 
 export const unsuback: {

package/mqttPacket/unsubscribe.ts

@@ -11,9 +11,6 @@ import { PacketType } from "./PacketType.ts";
 import { Encoder } from "./encoder.ts";
 import { Decoder, DecoderError } from "./decoder.ts";
 
-/**
- * UnsubscribePacket is sent from client to server to unsubscribe from topics
- */
 export type UnsubscribePacketV4 = {
   type: TPacketType;
   protocolLevel: ProtocolLevelNoV5;
@@ -29,6 +26,9 @@ export type UnsubscribePacketV5 = {
   topicFilters: TopicFilter[];
 };
 
+/**
+ * UnsubscribePacket is sent from client to server to unsubscribe from topics
+ */
 export type UnsubscribePacket = UnsubscribePacketV4 | UnsubscribePacketV5;
 
 export const unsubscribe: {

package/mqttPacket/validators.ts

@@ -7,14 +7,29 @@ const invalidTopicRegEx = new RegExp(/^$|\+|#|\x00|\uFFFD/);
 // deno-lint-ignore no-control-regex
 const invalidTopicFilterRegEx = new RegExp(/^$|#.|[^\/]\+|\+[^\/]|\x00|\uFFFD/);
 
+/**
+ * check for invalid UTF-8 characters
+ * @param value string to test
+ * @returns true if the string contains invalid UTF-8 characters
+ */
 export function invalidUTF8(value: string): boolean {
   return invalidUTF8regEx.test(value);
 }
 
+/**
+ * check for invalid topic characters
+ * @param value
+ * @returns true if the topic is invalid
+ */
 export function invalidTopic(value: Topic): boolean {
   return invalidTopicRegEx.test(value);
 }
 
+/**
+ * check for invalid topic filter characters
+ * @param value topic filter to test
+ * @returns true if the topic filter is invalid
+ */
 export function invalidTopicFilter(value: TopicFilter): boolean {
   return invalidTopicFilterRegEx.test(value);
 }

package/node/tcpClient.ts

@@ -96,6 +96,6 @@ export class TcpClient extends Client {
     if (protocol === "mqtt:") {
       return this.connectMQTT(hostname, port);
     }
-    throw `Unsupported protocol: ${protocol}`;
+    throw new Error(`Unsupported protocol: ${protocol}`);
   }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@seriousme/opifex",
-  "version": "1.10.1",
+  "version": "1.11.0",
   "description": "MQTT client & server for Deno & NodeJS",
   "type": "module",
   "scripts": {

package/persistence/memory/memoryPersistence.ts

@@ -134,7 +134,7 @@ export class MemoryPersistence implements IPersistence {
       newPacket.qos = qos;
       //  logger.debug(`publish ${topic} to client ${clientId}`);
       const client = this.clientList.get(clientId);
-      client?.handler(packet);
+      client?.handler(newPacket);
     }
   }
 

package/utils/asyncQueue.ts

@@ -1,3 +1,4 @@
+import { Deferred } from "./deferred.ts";
 import { nextTick } from "./nextTick.ts";
 /**
  * An Async Queue is a queue that can be used to push items to it and then wait
@@ -12,13 +13,14 @@ import { nextTick } from "./nextTick.ts";
  * }
  * ```
  */
+
 export class AsyncQueue<T> {
   private queue: T[] = [];
   private maxQueueLength = Infinity;
-  private nextResolve = (_value: T) => {};
-  private nextReject = (_reason?: string) => {};
+
   private done = false;
-  private hasNext = false;
+
+  #next?: Deferred<T>;
 
   constructor(maxQueueLength?: number) {
     if (maxQueueLength) {
@@ -28,39 +30,33 @@ export class AsyncQueue<T> {
 
   async next(): Promise<T> {
     await nextTick();
-    if (this.done && this.queue.length === 0) {
+    if (this.queue.length) {
+      return Promise.resolve(this.queue.shift()!);
+    } else if (this.done) {
       return Promise.reject("Closed");
+    } else if (!this.#next) {
+      this.#next = new Deferred<T>();
     }
-    return new Promise((resolve, reject) => {
-      if (this.queue.length > 0) {
-        const item = this.queue.shift();
-        if (item) {
-          return resolve(item);
-        }
-      }
-      this.nextResolve = resolve;
-      this.nextReject = reject;
-      this.hasNext = true;
-    });
+    return this.#next.promise;
   }
 
   close(reason = "closed"): void {
     this.done = true;
-    if (this.hasNext) {
-      this.nextReject(reason);
+    if (this.#next) {
+      this.#next.reject(new Error(reason));
     }
   }
 
   async *[Symbol.asyncIterator](): AsyncGenerator<Awaited<T>, void, unknown> {
     while (true) {
-      yield this.next();
+      yield await this.next();
     }
   }
 
   push(item: T) {
-    if (this.hasNext) {
-      this.nextResolve(item);
-      this.hasNext = false;
+    if (this.#next) {
+      this.#next.resolve(item);
+      this.#next = undefined;
       return;
     }
     if (this.queue.length > this.maxQueueLength) {

package/utils/logger.ts

@@ -1,3 +1,5 @@
+import { noop } from "./utils.ts";
+
 /**
  * The available log levels
  */
@@ -30,21 +32,20 @@ export class Logger {
   private defaultInfo = console.info;
   private defaultVerbose = console.log;
   private defaultDebug = console.log;
-  // deno-lint-ignore no-explicit-any
-  private noop = (..._data: any[]) => {};
-  error = this.defaultError;
-  warn = this.defaultWarn;
-  info = this.defaultInfo;
-  verbose = this.noop;
-  debug = this.noop;
+
+  error: typeof console.log = this.defaultError;
+  warn: typeof console.log = this.defaultWarn;
+  info: typeof console.log = this.defaultInfo;
+  verbose: typeof console.log = noop;
+  debug: typeof console.log = noop;
 
   constructor() {}
 
   level(logLevel: TLogLevel) {
-    this.warn = logLevel > 0 ? this.defaultWarn : this.noop;
-    this.info = logLevel > 1 ? this.defaultInfo : this.noop;
-    this.verbose = logLevel > 2 ? this.defaultVerbose : this.noop;
-    this.debug = logLevel > 3 ? this.defaultDebug : this.noop;
+    this.warn = logLevel > 0 ? this.defaultWarn : noop;
+    this.info = logLevel > 1 ? this.defaultInfo : noop;
+    this.verbose = logLevel > 2 ? this.defaultVerbose : noop;
+    this.debug = logLevel > 3 ? this.defaultDebug : noop;
   }
 }
 

package/utils/utils.ts

@@ -0,0 +1,6 @@
+/*
+ * This file contains utilities used throughout the project too small to
+ * deserve their own dedicated files.
+ */
+
+export const noop = () => {};