@kronos-integration/service-swarm 4.0.12 → 4.0.14

package/README.md

@@ -1,10 +1,12 @@
+[![npm](https://img.shields.io/npm/v/@kronos-integration/service-swarm.svg)](https://www.npmjs.com/package/@kronos-integration/service-swarm)
 [![License](https://img.shields.io/badge/License-0BSD-blue.svg)](https://spdx.org/licenses/0BSD.html)
+[![bundlejs](https://deno.bundlejs.com/?q=@kronos-integration/service-swarm\&badge=detailed)](https://bundlejs.com/?q=@kronos-integration/service-swarm)
+[![downloads](http://img.shields.io/npm/dm/@kronos-integration/service-swarm.svg?style=flat-square)](https://npmjs.org/package/@kronos-integration/service-swarm)
 [![GitHub Issues](https://img.shields.io/github/issues/Kronos-Integration/service-swarm.svg?style=flat-square)](https://github.com/Kronos-Integration/service-swarm/issues)
 [![Build Status](https://img.shields.io/endpoint.svg?url=https%3A%2F%2Factions-badge.atrox.dev%2FKronos-Integration%2Fservice-swarm%2Fbadge\&style=flat)](https://actions-badge.atrox.dev/Kronos-Integration/service-swarm/goto)
 [![Styled with prettier](https://img.shields.io/badge/styled_with-prettier-ff69b4.svg)](https://github.com/prettier/prettier)
 [![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/)
 [![Known Vulnerabilities](https://snyk.io/test/github/Kronos-Integration/service-swarm/badge.svg)](https://snyk.io/test/github/Kronos-Integration/service-swarm)
-[![Coverage Status](https://coveralls.io/repos/Kronos-Integration/service-swarm/badge.svg)](https://coveralls.io/github/Kronos-Integration/service-swarm)
 
 # @kronos-integration/service-swarm
 

package/package.json

@@ -1,10 +1,11 @@
 {
   "name": "@kronos-integration/service-swarm",
-  "version": "4.0.12",
+  "version": "4.0.14",
   "publishConfig": {
     "access": "public",
     "provenance": true
   },
+  "packageManager": "npm@11.6.4+sha512.1118cab46a05a50aee6bff5b1b4fa1df18afff89d57465620a3518035026955db87c5bdf9d207b07b7487d99f2490d450cb774655ad63ec2cba7bf1d0ad25d45",
   "exports": {
     ".": "./src/service-swarm.mjs"
   },
@@ -20,21 +21,21 @@
       "email": "markus.felten@gmx.de"
     }
   ],
-  "license": "BSD-2-Clause",
+  "license": "0BSD",
   "scripts": {
     "test": "node --run test:ava",
     "test:ava": "ava --timeout 4m tests/*-ava.mjs tests/*-ava-node.mjs",
     "cover": "c8 -x 'tests/**/*' --temp-directory build/tmp ava --timeout 4m tests/*-ava.mjs tests/*-ava-node.mjs && c8 report -r lcov -o build/coverage --temp-directory build/tmp",
-    "docs": "documentation readme --section=API ./src/**/*.mjs",
+    "docs": "documentation readme --section=API ./src**/*.mjs",
     "lint": "node --run lint:docs",
-    "lint:docs": "documentation lint ./src/**/*.mjs"
+    "lint:docs": "documentation lint ./src**/*.mjs"
   },
   "dependencies": {
     "@kronos-integration/endpoint": "^11.0.5",
     "@kronos-integration/service": "^15.1.1",
-    "hyperswarm": "^4.15.1",
+    "hyperswarm": "^4.16.0",
     "length-prefix-framed-stream": "^2.0.12",
-    "pacc": "^5.1.0"
+    "pacc": "^5.2.0"
   },
   "devDependencies": {
     "@hyperswarm/dht": "^6.5.1",
@@ -45,7 +46,7 @@
     "semantic-release": "^25.0.2"
   },
   "engines": {
-    "node": ">=24.11.1"
+    "node": ">=24.12.0"
   },
   "repository": {
     "type": "git",
@@ -60,6 +61,5 @@
       "arlac77/template-arlac77-github",
       "arlac77/template-kronos-component"
     ]
-  },
-  "packageManager": "npm@11.6.4+sha512.1118cab46a05a50aee6bff5b1b4fa1df18afff89d57465620a3518035026955db87c5bdf9d207b07b7487d99f2490d450cb774655ad63ec2cba7bf1d0ad25d45"
+  }
 }

package/src/peers-endpoint.mjs

@@ -7,11 +7,6 @@ const PEERS_NAME_PREFIX = "peers.";
 
 /**
  * Endpoint to link against a swarm topic.
- * @param {string} name endpoint name
- * @param {Object} owner owner of the endpoint
- * @param {Object} options
- * @param {string} options.topic defaults to endpoint name (without @see PEERS_NAME_PREFIX)
- *
  * @property {Topic} topic
  */
 export class PeersEndpoint extends MultiSendEndpoint {
@@ -19,6 +14,16 @@ export class PeersEndpoint extends MultiSendEndpoint {
     return name.startsWith(PEERS_NAME_PREFIX);
   }
 
+  topic;
+  socket;
+  
+  /**
+   * @param {string} name endpoint name
+   * @param {Object} owner owner of the endpoint
+   * @param {Object} options
+   * @param {string} options.topic defaults to endpoint name (without @see PEERS_NAME_PREFIX)
+   *
+   */
   constructor(name, owner, options) {
     super(name, owner, options);
 

package/src/service-swarm.mjs

@@ -2,6 +2,7 @@ import { pipeline } from "node:stream";
 import Hyperswarm from "hyperswarm";
 import { Decode, Encode } from "length-prefix-framed-stream";
 import {
+  getAttributesJSON,
   prepareAttributesDefinitions,
   private_key_attribute,
   boolean_attribute_false,
@@ -17,9 +18,6 @@ import { PeersEndpoint } from "./peers-endpoint.mjs";
  * Swarm detecting sync service.
  */
 export class ServiceSwarm extends Service {
-  _topics; // = new Map();
-  _topicsByName; // = new Map();
-
   /**
    * @return {string} 'swarm'
    */
@@ -31,7 +29,7 @@ export class ServiceSwarm extends Service {
     {
       server: {
         ...boolean_attribute_false,
-        needsRestart: true,
+        needsRestart: true
       },
       client: {
         ...boolean_attribute_false,
@@ -41,16 +39,18 @@ export class ServiceSwarm extends Service {
         ...object_attribute,
         description: "well known dht addresses",
         needsRestart: true,
+        connectionOption: true
       },
       maxPeers: {
         ...integer_attribute,
         description: "total amount of peers that this peer will connect to",
         default: 10,
-        needsRestart: true
+        needsRestart: true,
+        connectionOption: true
       },
-      key: {
+      seed: {
         ...private_key_attribute,
-        description: "topic initial key",
+        description: "key pair seed",
         needsRestart: true
       }
     },
@@ -86,7 +86,8 @@ export class ServiceSwarm extends Service {
    * On demand create topic endpoints.
    * @param {string} name
    * @param {Object|string} definition
-   * @return {Class} TopicEndpoint if name starts with 'topic.'
+   * @param {InitializationContext} ic
+   * @return {Object} TopicEndpoint if name starts with 'topic.'
    */
   endpointFactoryFromConfig(name, definition, ic) {
     if (TopicEndpoint.isTopicName(name)) {
@@ -102,20 +103,14 @@ export class ServiceSwarm extends Service {
 
   async _start() {
     const swarm = (this.swarm = new Hyperswarm({
-      dht: this.dht,
-      maxPeers: this.maxPeers
+      ...getAttributesJSON(
+        this,
+        this.attributes,
+        (name, attribute) => attribute.connectionOption
+      ),
+      ...(await this.getCredentials())
     }));
 
-    /*
-    this.discovery = swarm.join(
-      topic,
-        ? {
-            server: this.server,
-            client: this.client
-          }
-    );
-    */
-
     swarm.on("update", () => {
       console.log("Hyperswarm update", swarm);
     });
@@ -175,28 +170,27 @@ export class ServiceSwarm extends Service {
     await Promise.all(
       [...this.topics.values()].map(topic => {
         this.trace(`join topic ${topic.name} ${JSON.stringify(topic.options)}`);
-        return new Promise(resolve => {
-          this.swarm.join(topic.key, topic.options, () => {
-            this.trace(`joined topic ${topic.name}`);
-            resolve();
-          });
-        });
+        const discovery = this.swarm.join(topic.key, topic.options);
+        return discovery.flushed();
       })
     );
   }
 
   async _stop() {
+    const swarm = this.swarm;
+    delete this.swarm;
+    this.swam = undefined;
+
     return Promise.all(
       [...this.topics.values()].map(topic => {
         this.trace(`leave topic ${topic.name}`);
-        return new Promise(resolve => {
-          this.swarm.join(topic.key, () => {
-            this.trace(`leaved topic ${topic.name}`);
-            resolve();
-          });
-        });
+        return swarm.leave(topic.key);
       })
     );
+
+    await swarm.suspend({
+      log: (...args) => this.info(...args)
+    });
   }
 }
 

package/src/topic-endpoint.mjs

@@ -9,10 +9,6 @@ const TOPIC_NAME_PREFIX = "topic.";
 
 /**
  * Endpoint to link against a swarm topic.
- * @param {string} name endpoint name
- * @param {Object} owner owner of the endpoint
- * @param {Object} options
- * @param {string} options.topic defaults to endpoint name (without @see TOPIC_NAME_PREFIX)
  * @property {Topic} topic
  */
 export class TopicEndpoint extends MultiSendEndpoint {
@@ -23,6 +19,12 @@ export class TopicEndpoint extends MultiSendEndpoint {
   sockets = new Set();
   encode = new Encode();
 
+  /**
+   * @param {string} name endpoint name
+   * @param {Object} owner owner of the endpoint
+   * @param {Object} options
+   * @param {string} options.topic defaults to endpoint name (without @see TOPIC_NAME_PREFIX)
+   */
   constructor(name, owner, options) {
     super(name, owner, options);
 
@@ -34,7 +36,7 @@ export class TopicEndpoint extends MultiSendEndpoint {
   }
 
   async addSocket(socket) {
-    if(this.sockets.has(socket)) {
+    if (this.sockets.has(socket)) {
       this.owner.error(`socket already present`);
       return;
     }