@seriousme/opifex 2.0.3 → 2.1.0

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,10 +1,14 @@
+/** Net adresses */
 export type NetAddr = {
   transport: "tcp" | "udp";
   hostname: string;
   port: number;
 };
+/** Unix adresses */
 export type UnixAddr = { transport: "unix" | "unixpacket"; path: string };
+/** vSock adresses */
 export type VsockAddr = { transport: "vsock"; cid: number; port: number };
+/** Socket adresses */
 export type SockAddr = NetAddr | UnixAddr | VsockAddr;
 /** Socket connection descriptor. */
 export type SockConn = {

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);