@seriousme/opifex 1.6.3 → 1.7.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@seriousme/opifex",
-  "version": "1.6.3",
+  "version": "1.7.0",
   "description": "MQTT client & server for Deno & NodeJS",
   "type": "module",
   "scripts": {
@@ -21,6 +21,16 @@
     "mqtt": "dist/bin/mqtt.js",
     "demoServer": "dist/bin/demoServer.js"
   },
+  "files": [
+    "package.json",
+    "README.md",
+    "LICENSE.txt",
+    "**/*.ts",
+    "dist/**/*.js",
+    "dist/**/*.js.map",
+    "dist/**/*.d.ts",
+    "dist/**/*.d.ts.map"
+  ],
   "exports": {
     "./server": "./dist/server/mod.js",
     "./client": "./dist/client/mod.js",
@@ -53,6 +63,6 @@
   },
   "homepage": "https://github.com/seriousme/opifex#readme",
   "devDependencies": {
-    "@types/node": "^22.10.0"
+    "@types/node": "^22.13.1"
   }
 }

package/.github/dependabot.yml

@@ -1,7 +0,0 @@
-version: 2
-updates:
-  - package-ecosystem: "github-actions"
-    directory: "/"
-    schedule:
-      # Check for updates to GitHub Actions every week
-      interval: "weekly"

package/.github/workflows/closeStale.yml

@@ -1,15 +0,0 @@
-name: "Close stale issues"
-on:
-  schedule:
-    - cron: "5 0 * * *"
-
-jobs:
-  stale:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/stale@v9
-        with:
-          repo-token: ${{ secrets.GITHUB_TOKEN }}
-          days-before-stale: 30
-          days-before-close: 5
-          stale-issue-message: This issue is stale because it has been open 30 days with no activity. Remove stale label or comment or this will be closed in 5 days'

package/.github/workflows/codeql-analysis.yml

@@ -1,71 +0,0 @@
-# For most projects, this workflow file will not need changing; you simply need
-# to commit it to your repository.
-#
-# You may wish to alter this file to override the set of languages analyzed,
-# or to provide custom queries or build logic.
-#
-# ******** NOTE ********
-# We have attempted to detect the languages in your repository. Please check
-# the `language` matrix defined below to confirm you have the correct set of
-# supported CodeQL languages.
-#
-name: "CodeQL"
-
-on:
-  push:
-    branches: [master]
-  pull_request:
-    # The branches below must be a subset of the branches above
-    branches: [master]
-  schedule:
-    - cron: "27 16 * * 3"
-
-jobs:
-  analyze:
-    name: Analyze
-    runs-on: ubuntu-latest
-    permissions:
-      actions: read
-      contents: read
-      security-events: write
-
-    strategy:
-      fail-fast: false
-      matrix:
-        language: ["javascript"]
-        # CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python' ]
-        # Learn more:
-        # https://docs.github.com/en/free-pro-team@latest/github/finding-security-vulnerabilities-and-errors-in-your-code/configuring-code-scanning#changing-the-languages-that-are-analyzed
-
-    steps:
-      - name: Checkout repository
-        uses: actions/checkout@v4
-
-      # Initializes the CodeQL tools for scanning.
-      - name: Initialize CodeQL
-        uses: github/codeql-action/init@v3
-        with:
-          languages: ${{ matrix.language }}
-          # If you wish to specify custom queries, you can do so here or in a config file.
-          # By default, queries listed here will override any specified in a config file.
-          # Prefix the list here with "+" to use these queries and those in the config file.
-          # queries: ./path/to/local/query, your-org/your-repo/queries@main
-
-      # Autobuild attempts to build any compiled languages  (C/C++, C#, or Java).
-      # If this step fails, then you should remove it and run the build manually (see below)
-      - name: Autobuild
-        uses: github/codeql-action/autobuild@v3
-
-      # ℹ️ Command-line programs to run using the OS shell.
-      # 📚 https://git.io/JvXDl
-
-      # ✏️ If the Autobuild fails above, remove it and uncomment the following three lines
-      #    and modify them (or add more) to build your code if your project
-      #    uses a compiled language
-
-      #- run: |
-      #   make bootstrap
-      #   make release
-
-      - name: Perform CodeQL Analysis
-        uses: github/codeql-action/analyze@v3

package/.github/workflows/deno-ci.yml

@@ -1,16 +0,0 @@
-# This workflow will test on Deno lastest stable major and canary
-# see https://github.com/marketplace/actions/setup-deno for details
-name: Deno CI
-on: [push, pull_request]
-jobs:
-  build:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v4
-      - uses: denoland/setup-deno@v2
-        with:
-          deno-version: vx.x.x # Run with latest stable Deno.
-      - run: deno install
-      - run: deno fmt --check
-      - run: deno lint
-      - run: deno test -A

package/.github/workflows/nodejs-ci.yml

@@ -1,23 +0,0 @@
-# This workflow will do a clean install of node dependencies, build the source code and run tests across different versions of node
-# For more information see: https://help.github.com/actions/language-and-framework-guides/using-nodejs-with-github-actions
-
-name: Node.js CI
-
-on: [push, pull_request]
-
-permissions: {}
-
-jobs:
-  build:
-    runs-on: ubuntu-latest
-
-    strategy:
-      matrix:
-        node-version: ["22", "23"]
-    steps:
-      - uses: actions/checkout@v4
-      - name: Use Node.js ${{ matrix.node-version }}
-        uses: actions/setup-node@v4
-        with:
-          node-version: ${{ matrix.node-version }}
-      - run: npm run test

package/.github/workflows/publish.yml

@@ -1,16 +0,0 @@
-name: Publish
-
-on:
-  push:
-    branches:
-      - main
-
-jobs:
-  publish:
-    runs-on: ubuntu-latest
-    permissions:
-      contents: read
-      id-token: write # The OIDC ID token is used for authentication with JSR.
-    steps:
-      - uses: actions/checkout@v4
-      - run: npx jsr publish

package/.github/workflows/update-license-year.sh

@@ -1,14 +0,0 @@
-#!/bin/bash
-
-license='LICENSE.txt'
-prefix='2016-'
-current_year=$(date +%Y)
-sed -i -e "s/$prefix\([0-9\]\+\)/$prefix$current_year/" $license
-
-if [ "$(git diff $license)" ]; then
-  git add $license
-  git commit -m "Update license year to $current_year"
-  git push
-else
-  echo "No changes detected in $license"
-fi

package/.github/workflows/update-license-year.yml

@@ -1,13 +0,0 @@
-name: Update License Year
-
-on:
-  schedule:
-    - cron: "5 12 1 1 *"
-
-jobs:
-  update_license:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v4
-      - name: Update license year
-        run: ./update_license.sh

package/CHANGELOG.md

@@ -1,80 +0,0 @@
-# Changelog
-
-## [Unreleased]
-
-### Changed
-
-## [v1.6.3] 31-01-2025
-
-### Changed
-
-- fix: improve memory persistence backend on reconnects
-
-## [v1.6.2] 19-01-2025
-
-### Changed
-
-- fix: added more JSdoc comments
-
-## [v1.6.1] 18-01-2025
-
-### Changed
-
-- fix: fixed Deno lint type errors
-
-## [v1.6.0] 18-01-2025
-
-### Changed
-
-- added: export TcpClient and TcpServer for both NodeJS and Deno
-- added: export mqttPacket and utils
-
-## [v1.5.1] 16-01-2025
-
-### Changed
-
-- fixed issue with QoS=1
-
-## [v1.5.0] 02-01-2025
-
-### Changed
-
-- added client certificate support to mqtts.ts
-
-## [v1.4.0] 02-01-2025
-
-### Changed
-
-- added client certificate support (w0otness)
-
-## [v1.3.0] 19-11-2024
-
-### Changed
-
-- update: added architectural description of Opifex to documentation
-- update: added comments to platform specific code to explain boundary between
-  platform agnostic and platform specific.
-- update: set default clientId in client
-- fix: improve handling of errors if client connect fails
-
-## [v1.2.1] 01-11-2024
-
-### Changed
-
-- fix: unlock last BYOB request using respond(0)
-
-## [v1.2.0] 01-11-2024
-
-### Changed
-
-- added support for NodeJS < 22.0.6 by adding transpiled Javascript in `/dist`
-
-## [v1.1.0] 01-11-2024
-
-### Changed
-
-- added support for NodeJS >= 22.0.6 using --experimental-strip-types
-
-## [v1.0.0] 09-10-2022
-
-Initial version

package/deno.json

@@ -1,16 +0,0 @@
-{
-  "name": "@seriousme/opifex",
-  "version": "1.6.3",
-  "license": "MIT",
-  "exports": {
-    "./server": "./server/mod.ts",
-    "./client": "./client/mod.ts",
-    "./mqttPacket": "./mqttPacket/mod.ts",
-    "./utils": "./utils/mod.ts",
-    "./tcpClient": "./deno/tcpClient.ts",
-    "./tcpServer": "./deno/tcpServer.ts"
-  },
-  "exclude": [
-    "dist"
-  ]
-}

package/deno.lock

@@ -1,34 +0,0 @@
-{
-  "version": "4",
-  "specifiers": {
-    "npm:@types/node@*": "22.5.4",
-    "npm:@types/node@^22.10.0": "22.10.0"
-  },
-  "npm": {
-    "@types/node@22.10.0": {
-      "integrity": "sha512-XC70cRZVElFHfIUB40FgZOBbgJYFKKMa5nb9lxcwYstFG/Mi+/Y0bGS+rs6Dmhmkpq4pnNiLiuZAbc02YCOnmA==",
-      "dependencies": [
-        "undici-types@6.20.0"
-      ]
-    },
-    "@types/node@22.5.4": {
-      "integrity": "sha512-FDuKUJQm/ju9fT/SeX/6+gBzoPzlVCzfzmGkwKvRHQVxi4BntVbyIwf6a4Xn62mrvndLiml6z/UBXIdEVjQLXg==",
-      "dependencies": [
-        "undici-types@6.19.8"
-      ]
-    },
-    "undici-types@6.19.8": {
-      "integrity": "sha512-ve2KP6f/JnbPBFyobGHuerC9g1FYGn/F8n1LWTwNxCEzd6IfqTwUQcNXgEtmmQ6DlRrC1hrSrBnCZPokRrDHjw=="
-    },
-    "undici-types@6.20.0": {
-      "integrity": "sha512-Ny6QZ2Nju20vw1SRHe3d9jVu6gJ+4e3+MMpqu7pqE5HT6WsTSlce++GQmK5UXS8mzV8DSYHrQH+Xrf2jVcuKNg=="
-    }
-  },
-  "workspace": {
-    "packageJson": {
-      "dependencies": [
-        "npm:@types/node@^22.10.0"
-      ]
-    }
-  }
-}

package/dist/bin/conformanceServer.js

@@ -1,97 +0,0 @@
-#!/usr/bin/env -S node --experimental-strip-types
-// this server is intended to be used with https://github.com/eclipse/iottestware
-/**
- * MQTT Server implementation with authentication and authorization
- * @module mqttServer
- */
-import { TcpServer } from "../node/tcpServer.js";
-import { AuthenticationResult } from "../server/mod.js";
-import { getArgs, logger, LogLevel, parseArgs } from "../utils/mod.js";
-/**
- * UTF-8 decoder for parsing passwords
- */
-const utf8Decoder = new TextDecoder();
-/**
- * Map storing valid username/password combinations
- */
-const userTable = new Map();
-userTable.set("IoTester_1", "strong_password");
-userTable.set("IoTester_2", "strong_password");
-/**
- * Regular expression for validating usernames
- * Allows alphanumeric characters up to 23 chars long
- */
-const strictUsername = new RegExp(/^[a-zA-Z0-9]{0,23}$/);
-/**
- * Flag to enable/disable username checking
- * If false, all users are allowed access
- * If true, only users in userTable are allowed access
- */
-const checkUsername = true;
-/**
- * Authenticates MQTT clients
- * @param {Context} _ctx - Connection context
- * @param {string} clientId - Client identifier
- * @param {string} username - Username to authenticate
- * @param {Uint8Array} password - Password as byte array
- * @returns {TAuthenticationResult} Authentication result
- */
-function isAuthenticated(_ctx, clientId, username, password) {
-    const pwd = utf8Decoder.decode(password);
-    logger.info(`Verifying authentication of client '${clientId}' with username '${username}' and password '${pwd}'`);
-    if (!checkUsername) {
-        // allow all users access
-        return AuthenticationResult.ok;
-    }
-    // is the username valid according to MQTT specification
-    if (!strictUsername.test(username)) {
-        return AuthenticationResult.badUsernameOrPassword;
-    }
-    // Does user and password match an entry in userTable
-    if (userTable.has(username)) {
-        const pass = userTable.get(username);
-        if (pwd === pass) {
-            return AuthenticationResult.ok;
-        }
-    }
-    return AuthenticationResult.notAuthorized;
-}
-/**
- * Checks if client is authorized to publish to a topic
- * @param {Context} ctx - Connection context
- * @param {Topic} topic - Topic to publish to
- * @returns {boolean} True if authorized
- */
-function isAuthorizedToPublish(ctx, topic) {
-    logger.debug(`Checking authorization of client '${ctx.store?.clientId}' to publish on topic '${topic}'`);
-    return true;
-}
-/**
- * Checks if client is authorized to subscribe to a topic
- * @param {Context} ctx - Connection context
- * @param {Topic} topic - Topic to subscribe to
- * @returns {boolean} True if authorized
- */
-function isAuthorizedToSubscribe(ctx, topic) {
-    logger.debug(`Checking authorization of client '${ctx.store?.clientId}' to subscribe to topic '${topic}'`);
-    return true;
-}
-/**
- * Parse command line arguments and start server
- */
-const { _: [portNum] } = parseArgs(getArgs());
-const port = Number(portNum ?? 1883);
-const hostname = "::";
-logger.level(LogLevel.info);
-/**
- * TCP Server instance with authentication and authorization handlers
- */
-const tcpServer = new TcpServer({ port, hostname }, {
-    handlers: {
-        isAuthenticated,
-        isAuthorizedToPublish,
-        isAuthorizedToSubscribe,
-    },
-});
-tcpServer.start();
-logger.info(`Server started on port ${tcpServer.port}`);

package/dist/bin/demoServer.js

@@ -1,96 +0,0 @@
-#!/usr/bin/env -S node --experimental-strip-types
-/**
- * MQTT Server implementation with authentication and authorization
- * @module mqttServer
- */
-import { TcpServer } from "../node/tcpServer.js";
-import { AuthenticationResult } from "../server/mod.js";
-import { getArgs, logger, LogLevel, parseArgs } from "../utils/mod.js";
-/**
- * UTF-8 decoder for parsing passwords
- */
-const utf8Decoder = new TextDecoder();
-/**
- * Map storing valid username/password combinations
- */
-const userTable = new Map();
-userTable.set("IoTester_1", "strong_password");
-userTable.set("IoTester_2", "strong_password");
-/**
- * Regular expression for validating usernames
- * Allows alphanumeric characters up to 23 chars long
- */
-const strictUsername = new RegExp(/^[a-zA-Z0-9]{0,23}$/);
-/**
- * Flag to enable/disable username checking
- * If false, all users are allowed access
- * If true, only users in userTable are allowed access
- */
-const checkUsername = false;
-/**
- * Authenticates MQTT clients
- * @param {Context} _ctx - Connection context
- * @param {string} clientId - Client identifier
- * @param {string} username - Username to authenticate
- * @param {Uint8Array} password - Password as byte array
- * @returns {TAuthenticationResult} Authentication result
- */
-function isAuthenticated(_ctx, clientId, username, password) {
-    const pwd = utf8Decoder.decode(password);
-    logger.info(`Verifying authentication of client '${clientId}' with username '${username}' and password '${pwd}'`);
-    if (!checkUsername) {
-        // allow all users access
-        return AuthenticationResult.ok;
-    }
-    // is the username valid according to MQTT specification
-    if (!strictUsername.test(username)) {
-        return AuthenticationResult.badUsernameOrPassword;
-    }
-    // Does user and password match an entry in userTable
-    if (userTable.has(username)) {
-        const pass = userTable.get(username);
-        if (pwd === pass) {
-            return AuthenticationResult.ok;
-        }
-    }
-    return AuthenticationResult.notAuthorized;
-}
-/**
- * Checks if client is authorized to publish to a topic
- * @param {Context} ctx - Connection context
- * @param {Topic} topic - Topic to publish to
- * @returns {boolean} True if authorized
- */
-function isAuthorizedToPublish(ctx, topic) {
-    logger.debug(`Checking authorization of client '${ctx.store?.clientId}' to publish on topic '${topic}'`);
-    return true;
-}
-/**
- * Checks if client is authorized to subscribe to a topic
- * @param {Context} ctx - Connection context
- * @param {Topic} topic - Topic to subscribe to
- * @returns {boolean} True if authorized
- */
-function isAuthorizedToSubscribe(ctx, topic) {
-    logger.debug(`Checking authorization of client '${ctx.store?.clientId}' to subscribe to topic '${topic}'`);
-    return true;
-}
-/**
- * Parse command line arguments and start server
- */
-const { _: [portNum] } = parseArgs(getArgs());
-const port = Number(portNum ?? 1883);
-const hostname = "::";
-logger.level(LogLevel.info);
-/**
- * TCP Server instance with authentication and authorization handlers
- */
-const tcpServer = new TcpServer({ port, hostname }, {
-    handlers: {
-        isAuthenticated,
-        isAuthorizedToPublish,
-        isAuthorizedToSubscribe,
-    },
-});
-tcpServer.start();
-logger.info(`Server started on port ${tcpServer.port}`);