@kronos-integration/service-mqtt 2.0.3 → 3.1.0

package/.github/workflows/ci.yml

@@ -18,6 +18,7 @@ jobs:
         os:
           - ubuntu-latest
         node-version:
+          - 22.17.1
           - 24.4.1
     steps:
       - name: checkout
@@ -25,10 +26,10 @@ jobs:
       - name: Start Mosquitto
         uses: namoshek/mosquitto-github-action@v1
         with:
-          version: '2.0.22'
-          ports: '1883:1883 8883:8883'
+          version: 2.0.22
+          ports: 1883:1883 8883:8883
           config: ${{ github.workspace }}/.github/mosquitto/mosquitto.conf
-          container-name: 'mqtt'
+          container-name: mqtt
       - name: prepare node
         uses: actions/setup-node@v4.4.0
         with:

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kronos-integration/service-mqtt",
-  "version": "2.0.3",
+  "version": "3.1.0",
   "publishConfig": {
     "access": "public",
     "provenance": true
@@ -36,12 +36,11 @@
     "lint:typescript": "tsc --allowJs --checkJs --noEmit --resolveJsonModule --target es2024 --lib es2024 -m esnext --module nodenext --moduleResolution nodenext ./src**/*.mjs"
   },
   "dependencies": {
-    "@kronos-integration/service": "^12.0.5",
+    "@kronos-integration/service": "^13.0.1",
     "mqtt": "^5.13.3",
-    "pacc": "^3.7.0"
+    "pacc": "^3.9.0"
   },
   "devDependencies": {
-    "@types/node": "^24.0.15",
     "ava": "^6.4.1",
     "c8": "^10.1.3",
     "documentation": "^14.0.3",

package/src/service-mqtt.mjs

@@ -1,4 +1,10 @@
-import { mergeAttributeDefinitions, prepareAttributesDefinitions } from "pacc";
+import {
+  prepareAttributesDefinitions,
+  default_attribute,
+  url_attribute,
+  boolean_attribute,
+  secret_attribute
+} from "pacc";
 import { Service } from "@kronos-integration/service";
 import { connect } from "mqtt";
 import { TopicEndpoint } from "./topic-endpoint.mjs";
@@ -20,38 +26,26 @@ export class ServiceMQTT extends Service {
     return "mqtt client";
   }
 
-  static get configurationAttributes() {
-    return mergeAttributeDefinitions(
-      prepareAttributesDefinitions({
-        url: {
-          description: "url of the mqtt server",
-          needsRestart: true,
-          type: "url"
-        },
-        clean: {
-          type: "boolean"
-        },
-        clientId: {
-          type: "string"
-        },
-        connectTimeout: {
-          type: "integer"
-        },
-        reconnectPeriod: {
-          type: "integer"
-        },
-        username: {
-          type: "string",
-          private: true
-        },
-        password: {
-          type: "string",
-          private: true
-        }
-      }),
-      Service.configurationAttributes
-    );
-  }
+  static attributes = prepareAttributesDefinitions(
+    {
+      url: {
+        ...url_attribute,
+        description: "url of the mqtt server",
+        needsRestart: true
+      },
+      clean: boolean_attribute,
+      clientId: default_attribute,
+      connectTimeout: {
+        type: "integer"
+      },
+      reconnectPeriod: {
+        type: "integer"
+      },
+      username: secret_attribute,
+      password: secret_attribute
+    },
+    Service.attributes
+  );
 
   /**
    * @return {string} name with url
@@ -60,21 +54,6 @@ export class ServiceMQTT extends Service {
     return `${this.name}(${this.url})`;
   }
 
-  get options() {
-    return Object.fromEntries(
-      [
-        "username",
-        "password",
-        "clean",
-        "clientId",
-        "connectTimeout",
-        "reconnectPeriod"
-      ]
-        .filter(key => this[key] !== undefined)
-        .map(key => [key, this[key]])
-    );
-  }
-
   get topics() {
     return Object.values(this.endpoints)
       .filter(e => e.topic)
@@ -98,7 +77,16 @@ export class ServiceMQTT extends Service {
   async _start() {
     await super._start();
 
-    const client = connect(this.url, this.options);
+    const options = Object.fromEntries(
+      ["clean", "clientId", "connectTimeout", "reconnectPeriod"]
+        .filter(key => this[key] !== undefined)
+        .map(key => [key, this[key]])
+    );
+
+    options.password = await this.password;
+    options.username = await this.username;
+
+    const client = connect(this.url, options);
 
     this.client = client;
 

package/tests/mqtt-ava.mjs

@@ -4,19 +4,24 @@ import { ReceiveEndpoint } from "@kronos-integration/endpoint";
 import { StandaloneServiceProvider } from "@kronos-integration/service";
 import { ServiceMQTT, TopicEndpoint } from "@kronos-integration/service-mqtt";
 
-test("endpoint factory", async t => {
+test("factory", async t => {
   const sp = new StandaloneServiceProvider();
   const r1 = new ReceiveEndpoint("r1", sp);
   r1.receive = async () => "OK R1";
 
   const mqtt = await sp.declareService({
     type: ServiceMQTT,
+    clean: true,
+    clientId: "test",
+    url: "mqtt://localhost",
     endpoints: {
       s1: { topic: true, connected: r1 },
       s2: { topic: "s2b", connected: r1 }
     }
   });
 
+  t.is(mqtt.clean, true);
+  t.is(mqtt.clientId, "test");
   t.is(mqtt.endpoints["s1"].name, "s1");
   t.is(mqtt.endpoints["s2"].name, "s2");
   t.true(mqtt.endpoints["s1"] instanceof TopicEndpoint);
@@ -30,7 +35,7 @@ test("start / stop", async t => {
 
   const received = [];
 
-  r1.receive = async (message) => received.push(message);
+  r1.receive = async message => received.push(message);
 
   const mqtt = await sp.declareService({
     type: ServiceMQTT,

package/types/service-mqtt.d.mts

@@ -3,9 +3,6 @@ export { TopicEndpoint };
  * MQTT client.
  */
 export class ServiceMQTT extends Service {
-    get options(): {
-        [k: string]: any;
-    };
     get topics(): any[];
     /**
      * On demand create TopicEndpoint.