@soundworks/core 5.5.0 → 5.7.0

package/CHANGELOG.md

@@ -1,3 +1,16 @@
+# CHANGELOG
+
+## v5.7.0 - 2026-10-01
+
+- Refactor: SharedState callback and instantiation
+- Feat: introduce blackList and whiteList filters on SharedState and SharedStateCollection (backward compatible)
+- Feat: introduce SharedState#onUpdate(paramName, listener) and SharedStateCollection#onUpdate(paramName, listener) signature (backward compatible)
+- Feat: introduce experimental SharedState#waitFor(condition, timeout) method
+
+## v5.6.0 - 2026-09-23
+
+- Feat: do not propagate values when acknowledge is false and state has no siblings
+
 ## v5.5.0 - 2026-06-10
 
 - CI: move to node 24

package/README.md

@@ -42,6 +42,12 @@ Note that the `@soundworks/core` package is automatically installed when creatin
 npm install @soundworks/core
 ```
 
+## Developement Notes
+
+### Windows
+
+On windows machine, tests may fail when run in node.js command line, due to `openssl` not being found. This is fixed when run with git command line.
+
 ## Share with Us
 
 If you made an application using **soundworks** please let us know here: https://github.com/collective-soundworks/soundworks/discussions/61

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@soundworks/core",
-  "version": "5.5.0",
+  "version": "5.7.0",
   "description": "Open-source creative coding framework for distributed applications based on Web technologies",
   "collaborators": [
     "Benjamin Matuszewski",
@@ -24,6 +24,16 @@
       "types": "./types/server/index.d.ts"
     }
   },
+  "imports": {
+    "#isomorphic/colored-logger.js": {
+      "module": "./src/common/isomorphic/colored-logger.browser.js",
+      "node": "./src/common/isomorphic/colored-logger.node.js"
+    },
+    "#isomorphic/web-socket.js": {
+      "module": "./src/common/isomorphic/web-socket.browser.js",
+      "node": "./src/common/isomorphic/web-socket.node.js"
+    }
+  },
   "repository": {
     "type": "git",
     "url": "git+https://github.com/collective-soundworks/soundworks.git"
@@ -41,7 +51,7 @@
     "distributed-system"
   ],
   "engines": {
-    "node": ">=16.0.0"
+    "node": ">=22.0.0"
   },
   "scripts": {
     "doc": "npm run types && rm -rf docs && jsdoc -c .jsdoc --verbose && cp -R misc/assets docs/",
@@ -56,14 +66,11 @@
   "dependencies": {
     "@ircam/sc-utils": "^1.13.0",
     "cancelable-promise": "^4.3.1",
-    "chalk": "^5.6.2",
-    "fast-deep-equal": "^3.1.3",
-    "isomorphic-ws": "^5.0.0",
+    "defu": "^6.1.7",
+    "dequal": "^2.0.3",
     "keyv": "^5.6.0",
     "keyv-file": "^5.3.3",
-    "lodash": "^4.17.23",
-    "pem": "^1.14.8",
-    "uuid": "^13.0.0",
+    "selfsigned": "^5.5.0",
     "ws": "^8.19.0"
   },
   "devDependencies": {
@@ -73,13 +80,12 @@
     "dotenv": "^17.3.1",
     "eslint": "^10.0.3",
     "jsdoc": "^4.0.5",
-    "mocha": "^11.7.5",
+    "mocha": "^11.7.6",
     "puppeteer": "^24.39.0",
     "tcp-ping": "^0.1.1",
     "typescript": "^6.0.2"
   },
   "optionalDependencies": {
-    "bufferutil": "^4.1.0",
-    "utf-8-validate": "^6.0.6"
+    "bufferutil": "^4.1.0"
   }
 }

package/src/client/Client.js

@@ -23,7 +23,10 @@ import {
   CLIENT_HANDSHAKE_ERROR,
   AUDIT_STATE_NAME,
 } from '../common/constants.js';
-import logger from '../common/logger.js';
+
+import gatedLogger from '../common/logs/gated-logger.js';
+import warnings from '../common/logs/warnings.js';
+
 import VERSION from '../common/version.js';
 
 // for testing purposes
@@ -132,7 +135,7 @@ class Client {
 
     this[kClientOnStatusChangeCallbacks] = new Set();
 
-    logger.configure(!!config.env.verbose);
+    gatedLogger.verbose = !!this.#config.env.verbose;
   }
 
   /**
@@ -209,7 +212,7 @@ class Client {
    * @deprecated Use {@link Client#runtime} instead.
    */
   get target() {
-    logger.deprecated('Client#target', 'Client#runtime', '4.0.0-alpha.29');
+    warnings.deprecated('Client#target', 'Client#runtime', '4.0.0-alpha.29');
     return this.runtime;
   }
 
@@ -335,7 +338,7 @@ class Client {
           this.#token = token;
 
           if (version !== this.#version) {
-            logger.warnVersionDiscrepancies(this.#role, this.#version, version);
+            warnings.versionDiscrepancies(this.#role, this.#version, version);
           }
 
           resolve();

package/src/client/ClientSocket.js

@@ -1,11 +1,10 @@
 import { isBrowser } from '@ircam/sc-utils';
-import WebSocket from 'isomorphic-ws';
 
+import WebSocket from '#isomorphic/web-socket.js';
 import {
   PING_MESSAGE,
   PONG_MESSAGE,
 } from '../common/constants.js';
-import logger from '../common/logger.js';
 import {
   packStringMessage,
   unpackStringMessage,
@@ -167,7 +166,7 @@ class ClientSocket {
 
           if (e.error) {
             const msg = `ClientSocket error - code: ${e.error.code}, message: ${e.error.message}`;
-            logger.log(msg);
+            console.log(msg);
           }
 
           // Try to reconnect in all cases. Note that if the socket has been connected,

package/src/common/BasePlugin.js

@@ -1,4 +1,4 @@
-import merge from 'lodash/merge.js';
+import { defu } from 'defu';
 
 // Notes: we use Symbol.for because we need to override this in helpers test
 export const kBasePluginStatus = Symbol.for('soundworks:base-plugin-status');
@@ -171,7 +171,7 @@ class BasePlugin {
    * @see {@link BasePluginManager#onStateChange}
    */
   propagateStateChange(updates) {
-    this.state = merge(this.state, updates);
+    this.state = defu(updates, this.state);
     this.#onStateChangeCallbacks.forEach(callback => callback(this.state));
   }
 }

package/src/common/BasePluginManager.js

@@ -4,7 +4,7 @@ import {
   kBasePluginStatus,
 } from './BasePlugin.js';
 
-import logger from './logger.js';
+import gatedLogger from './logs/gated-logger.js';
 
 export const kPluginManagerStart = Symbol('soundworks:plugin-manager-start');
 export const kPluginManagerStop = Symbol('soundworks:plugin-manager-stop');
@@ -64,7 +64,7 @@ class BasePluginManager {
    * @private
    */
   async [kPluginManagerStart]() {
-    logger.title('starting registered plugins');
+    gatedLogger.title('starting registered plugins');
 
     if (this.#status !== 'idle') {
       throw new DOMException(`Cannot execute 'kPluginManagerStart' on BasePluginManager: Lifecycle methods must be called in following order: kPluginManagerStart, kPluginManagerStop`, 'InvalidAccessError');