@seriousme/opifex 2.0.3 → 2.2.0

package/server/handlers/handlePublish.ts

@@ -13,10 +13,9 @@ import type {
   PublishPacket,
   QoS,
   Topic,
-  TReasonCode,
 } from "../deps.ts";
 
-const reasonsToDisconnect: TReasonCode[] = [
+const reasonsToDisconnect: ReasonCode[] = [
   ReasonCode.topicAliasInvalid,
 ];
 
@@ -24,7 +23,7 @@ async function handlePublishError(
   ctx: Context,
   id: PacketId | undefined,
   qos: QoS,
-  reasonCode: TReasonCode,
+  reasonCode: ReasonCode,
   reasonString: string,
 ) {
   // in v4 we can only close the connection
@@ -103,7 +102,7 @@ async function authorizedToPublish(ctx: Context, topic: Topic) {
 function validatePublishPacket(
   ctx: Context,
   packet: PublishPacket,
-): { reasonCode: TReasonCode; message: string } | null {
+): { reasonCode: ReasonCode; message: string } | null {
   const cfg = ctx.config.context;
   const isProtocolV5 = packet.protocolLevel === 5;
   const hasTopicAlias = isProtocolV5 &&

package/server/handlers/handleSubscribe.ts

@@ -15,7 +15,6 @@ import type {
   ShareName,
   SubscribePacket,
   Topic,
-  TReasonCode,
 } from "../deps.ts";
 
 // V4 Subscription Failure
@@ -58,7 +57,7 @@ function validateSubscription(
   isProtocolV5: boolean,
   sub: ClientSubscription,
   cfg: Context["config"]["context"],
-): TReasonCode | null {
+): ReasonCode | null {
   if (
     cfg.wildcardSubscriptionAvailable === false && hasWildcards(sub.topicFilter)
   ) {
@@ -108,7 +107,7 @@ export async function handleSubscribe(
   }
 
   const retainedSubscriptions: ClientSubscription[] = [];
-  const results: TReasonCode[] = [];
+  const results: ReasonCode[] = [];
 
   for (const sub of packet.subscriptions) {
     const clientSub = sub as ClientSubscription;
@@ -166,7 +165,7 @@ export async function handleSubscribe(
     }
 
     // Success code (Granted QoS)
-    results.push(sub.qos as TReasonCode);
+    results.push(sub.qos as ReasonCode);
   }
 
   // Send SUBACK response

package/server/handlers/handleUnsubscribe.ts

@@ -4,7 +4,7 @@ import {
   parseTopicFilter,
   ReasonCode,
 } from "../deps.ts";
-import type { TReasonCode, UnsubscribePacket } from "../deps.ts";
+import type { UnsubscribePacket } from "../deps.ts";
 import { SessionState } from "../context.ts";
 import type { Context } from "../context.ts";
 
@@ -26,7 +26,7 @@ export async function handleUnsubscribe(
     subscriptions.add(joinTopicFilter(sub.topicFilter, sub.shareName));
   }
 
-  const reasonCodes: TReasonCode[] = [];
+  const reasonCodes: ReasonCode[] = [];
 
   for (const packetTopicFilter of packet.topicFilters) {
     // split topicFilter into topicFilter and shareName

package/server/mod.ts

@@ -5,7 +5,7 @@
 export { ReasonCode } from "./deps.ts";
 export type {
   ConnectPacket,
-  IPersistence,
+  Persistence,
   ShareName,
   SockConn,
   Topic,

package/server/server.ts

@@ -1,7 +1,7 @@
 import { logger, MemoryPersistence, ReasonCode } from "./deps.ts";
 import { Context } from "./context.ts";
 import type { Handlers } from "./context.ts";
-import type { IPersistence, ShareName, SockConn, Topic } from "./deps.ts";
+import type { Persistence, ShareName, SockConn, Topic } from "./deps.ts";
 import { handlePacket } from "./handlers/handlePacket.ts";
 import { createConfiguration } from "./config.ts";
 import type { Configuration, ConfigurationInput } from "./config.ts";
@@ -69,7 +69,7 @@ const defaultIsAuthorizedToSubscribe = (
  */
 export type MqttServerOptions = {
   /** Optional persistence layer implementation. Defaults to MemoryPersistence. */
-  persistence?: IPersistence;
+  persistence?: Persistence;
   /** Optional custom handlers for authentication and authorization. */
   handlers?: Handlers;
   /** Optional configuration data */
@@ -91,7 +91,7 @@ export class MqttServer {
   /** The registered authentication and authorization handlers. */
   handlers: Handlers;
   /** The persistence layer used for storing sessions and messages. */
-  persistence: IPersistence;
+  persistence: Persistence;
   /** The persistence layer used for storing sessions and messages. */
   configuration: Configuration;
 

package/socket/socket.ts

@@ -1,20 +1,45 @@
+/** Net addresses */
 export type NetAddr = {
+  /** The IP-based transport protocol */
   transport: "tcp" | "udp";
+  /** The hostname */
   hostname: string;
+  /** The port number */
   port: number;
 };
-export type UnixAddr = { transport: "unix" | "unixpacket"; path: string };
-export type VsockAddr = { transport: "vsock"; cid: number; port: number };
+/** Unix addresses */
+export type UnixAddr = {
+  /** The Unix domain socket transport protocol */
+  transport: "unix" | "unixpacket";
+  /** The file system path to the socket to connect to */
+  path: string;
+};
+/** vSock addresses */
+export type VsockAddr = {
+  /** The VSOCK transport protocol */
+  transport: "vsock";
+  /** The context identifier (CID) of the peer */
+  cid: number;
+  /** The port number */
+  port: number;
+};
+/** Socket addresses */
 export type SockAddr = NetAddr | UnixAddr | VsockAddr;
 /** Socket connection descriptor. */
 export type SockConn = {
+  /** The stream to read from */
   readable: ReadableStream<Uint8Array>;
+  /** The stream to write to */
   writable: WritableStream<Uint8Array>;
+  /** The callback to call on close */
   close: () => void;
+  /** The local address of the connection */
   localAddr?: SockAddr;
+  /** The remote address of the connection */
   remoteAddr?: SockAddr;
 };
 
+/** Connection class */
 export class Conn {
   reader: ReadableStreamDefaultReader<Uint8Array>;
   writer: WritableStreamDefaultWriter<Uint8Array>;
@@ -24,6 +49,7 @@ export class Conn {
 
   private leftover: Uint8Array = new Uint8Array(0);
 
+  /** Create a new Conn object from a SockConn */
   constructor(sockConn: SockConn) {
     this.closed = false;
     this.reader = sockConn.readable.getReader();
@@ -34,6 +60,7 @@ export class Conn {
     this.remoteAddr = sockConn.remoteAddr;
   }
 
+  /** Read bytes from the connection */
   async read(length: number): Promise<Uint8Array | null> {
     if (this.closed || length < 0) {
       return null;
@@ -81,6 +108,7 @@ export class Conn {
     return result;
   }
 
+  /** Write bytes to the connection */
   async write(data: Uint8Array): Promise<number> {
     if (this.closed) {
       return Promise.reject(new Error("Connection closed"));
@@ -94,6 +122,7 @@ export class Conn {
     }
   }
 
+  /** close the connection */
   close() {
     if (!this.closed) {
       this.closed = true;

package/tools/benchmarks/receiver.ts

@@ -1,11 +1,11 @@
 import { exit } from "node:process";
 import { getArgs, importClientClass } from "./utils.ts";
 import { logger } from "../../utils/mod.ts";
-import type { TLogLevel } from "../../utils/logger.ts";
+import type { LogLevel } from "../../utils/logger.ts";
 import type { QoS } from "../../client/deps.ts";
 
 export async function runReceiver(
-  level: TLogLevel,
+  level: LogLevel,
   url: string,
   topic: string,
   qos: QoS,

package/tools/benchmarks/sender.ts

@@ -2,7 +2,7 @@ import { exit } from "node:process";
 import { runAsap } from "../../dev_utils/timers.ts";
 import { getArgs, importClientClass } from "./utils.ts";
 import { logger } from "../../utils/mod.ts";
-import type { TLogLevel } from "../../utils/logger.ts";
+import type { LogLevel } from "../../utils/logger.ts";
 import type { QoS } from "../../client/deps.ts";
 
 const { TcpClient } = await importClientClass();
@@ -13,7 +13,7 @@ client.onError = (err: Error) => {
 };
 
 export async function runSender(
-  level: TLogLevel,
+  level: LogLevel,
   url: string,
   topic: string,
   qos: QoS,

package/utils/logger.ts

@@ -19,7 +19,7 @@ export const LogLevel = {
 /**
  * Union type representing the permitted numeric log level indices.
  */
-export type TLogLevel = typeof LogLevel[keyof typeof LogLevel];
+export type LogLevel = typeof LogLevel[keyof typeof LogLevel];
 
 type LogArgument = unknown | (() => unknown);
 
@@ -88,9 +88,9 @@ export class Logger {
 
   /**
    * Adjusts the current verbosity threshold, enabling or masking specific log outputs.
-   * @param {TLogLevel} logLevel - The minimum numeric severity level threshold to output.
+   * @param {LogLevel} logLevel - The minimum numeric severity level threshold to output.
    */
-  level(logLevel: TLogLevel) {
+  level(logLevel: LogLevel) {
     this.isWarn = logLevel >= LogLevel.warn;
     this.isInfo = logLevel >= LogLevel.info;
     this.isVerbose = logLevel >= LogLevel.verbose;

package/web/wsClient.ts

@@ -1,16 +1,28 @@
+/**
+ * this is a WebSockets specific client
+ * it extends the platform agnostic Client class
+ *  @module
+ */
+
 import { Client } from "../client/client.ts";
 import { logger } from "../client/deps.ts";
 import type { SockConn } from "../client/deps.ts";
 import { wrapWebSocket } from "./wrapWebSocket.ts";
 
+/**
+ * WsClient extends the Client class to provide WebSocket based clients
+ * it is used by the MQTTclient to connect to the broker
+ * see the /examples folder for an example
+ */
 export class WsClient extends Client {
+  /** create a websocket and wrap it in a SockConn */
   private async establishSocket(url: string): Promise<SockConn> {
     const ws = new WebSocket(url);
     const conn = await wrapWebSocket(ws);
     return conn;
   }
 
-  // overload createConn from the base client class
+  /** createConn provides support for both "ws:" and "wss:" URLs */
   protected override createConn(): Promise<SockConn> {
     const { protocol, hostname, port: portStr, pathname } = this.connectUrl;
     const port = portStr ? Number(portStr) : (protocol === "wss:" ? 443 : 80);