@soundworks/core 5.0.2 → 5.1.0

package/CHANGELOG.md

@@ -1,3 +1,7 @@
+## v5.0.3 - 2025-02-13
+
+- Fix: unexpected error when getting description of shared state class with required parameter
+
 ## v5.0.0 - 2025-01-30
 
 ### Breaking

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@soundworks/core",
-  "version": "5.0.2",
+  "version": "5.1.0",
   "description": "Open-source creative coding framework for distributed applications based on Web technologies",
   "collaborators": [
     "Benjamin Matuszewski",

package/src/common/BaseStateManager.js

@@ -236,12 +236,13 @@ class BaseStateManager {
     this[kStateManagerClient].transport.addListener(
       GET_CLASS_DESCRIPTION_RESPONSE,
       (reqId, className, classDescription) => {
+        const fullDescription = ParameterBag.getFullDescription(classDescription);
+
         if (!this.#cachedClasses.has(className)) {
-          this.#cachedClasses.set(className, classDescription);
+          this.#cachedClasses.set(className, fullDescription);
         }
-        // This cannot throw as the SharedState class has already been registered
-        const parameterBag = new ParameterBag(classDescription);
-        this.#promiseStore.resolve(reqId, parameterBag.getDescription());
+
+        this.#promiseStore.resolve(reqId, fullDescription);
       },
     );
 
@@ -268,10 +269,7 @@ class BaseStateManager {
     }
 
     if (this.#cachedClasses.has(className)) {
-      const classDescription = this.#cachedClasses.get(className);
-      // This cannot throw as the SharedState class has already been registered
-      const parameterBag = new ParameterBag(classDescription);
-      return parameterBag.getDescription();
+      return this.#cachedClasses.get(className);
     }
 
     return new Promise((resolve, reject) => {

package/src/common/ParameterBag.js

@@ -165,6 +165,33 @@ class ParameterBag {
     }
   }
 
+  static getFullDescription(description) {
+    const fullDescription = cloneDeep(description);
+
+    for (let [name, def] of Object.entries(fullDescription)) {
+      if (types[def.type].sanitizeDescription) {
+        def = types[def.type].sanitizeDescription(def);
+      }
+
+      const { defaultOptions } = types[def.type];
+      def = Object.assign({}, defaultOptions, def);
+      // if event property is set to true, the param must
+      // be nullable and its default value is `undefined`
+      if (def.event === true) {
+        def.nullable = true;
+        def.default = null;
+      }
+
+      if (def.required === true) {
+        def.default = null;
+      }
+
+      fullDescription[name] = def;
+    }
+
+    return fullDescription;
+  }
+
   #description = {};
   #values = {};
 
@@ -173,11 +200,11 @@ class ParameterBag {
       throw new TypeError(`Cannot construct ParameterBag: argument 1 must be an object`);
     }
 
-    description = cloneDeep(description);
-    initValues = cloneDeep(initValues);
-
     ParameterBag.validateDescription(description);
 
+    description = ParameterBag.getFullDescription(description);
+    initValues = cloneDeep(initValues);
+
     // make sure initValues make sens according to the given description
     for (let name in initValues) {
       if (!Object.prototype.hasOwnProperty.call(description, name)) {
@@ -186,19 +213,6 @@ class ParameterBag {
     }
 
     for (let [name, def] of Object.entries(description)) {
-      if (types[def.type].sanitizeDescription) {
-        def = types[def.type].sanitizeDescription(def);
-      }
-
-      const { defaultOptions } = types[def.type];
-      def = Object.assign({}, defaultOptions, def);
-      // if event property is set to true, the param must
-      // be nullable and its default value is `undefined`
-      if (def.event === true) {
-        def.nullable = true;
-        def.default = null;
-      }
-
       if (def.required === true) {
         // throw if value is not given in init values
         if (initValues[name] === undefined || initValues[name] === null) {
@@ -216,13 +230,11 @@ class ParameterBag {
         initValue = def.default;
       }
 
-
       this.#description[name] = def;
       // coerce init value and store in definition
-      initValue = this.set(name, initValue)[0];
-
-      this.#description[name].initValue = initValue;
-      this.#values[name] = initValue;
+      const coercedInitValue = this.set(name, initValue)[0];
+      this.#description[name].initValue = coercedInitValue;
+      this.#values[name] = coercedInitValue;
     }
   }
 

package/src/common/SharedStateCollection.js

@@ -471,6 +471,30 @@ class SharedStateCollection {
     return this.#states.find(func);
   }
 
+  /**
+   * Execute a user-supplied "reducer" callback function on each element of the collection,
+   * in order, passing in the return value from the calculation on the preceding element.
+   * The final result of running the reducer across all elements of the array is a single value.
+   *
+   * @template T
+   * @param {Function} func - A function to execute for each element in the array.
+   *  Its return value becomes the value of the accumulator parameter on the next
+   *  invocation of callbackFn. For the last invocation, the return value becomes
+   *  the return value of reduce(). The function is called with the following arguments:
+   * @param {T} initialValue - A value to which accumulator is initialized the first
+   *  time the callback is called. If initialValue is specified, callbackFn starts
+   *  executing with the first value in the array as currentValue.
+   * @return {T}
+   */
+  reduce(func, initialValue) {
+    // compared to the native Array.reduce method, initial Value is mandatory
+    if (arguments.length < 0) {
+      throw new Error(`Cannot execute 'reduce' on 'SharedStateCollection: argument 2 is not defined`);
+    }
+
+    return this.#states.reduce(func, initialValue);
+  }
+
   /**
    * Iterable API, e.g. for use in `for .. of` loops
    */

package/src/common/version.js

@@ -1,2 +1,2 @@
 // [WARNING] This file is generated, do not edit
-export default '5.0.2';
+export default '5.1.0';

package/src/server/ServerClient.js

@@ -1,7 +1,7 @@
-import { idGenerator } from '@ircam/sc-utils';
+import { counter } from '@ircam/sc-utils';
 import { v4 as uuid } from 'uuid';
 
-const generateId = idGenerator();
+const generateId = counter();
 
 export const kServerClientToken = Symbol('soundworks:server-client-token');
 
@@ -23,7 +23,7 @@ class ServerClient {
    */
   constructor(role, socket) {
     this.#role = role;
-    this.#id = generateId.next().value;
+    this.#id = generateId();
     this.#uuid = uuid();
     this.#socket = socket;
 

package/src/server/ServerSockets.js

@@ -120,7 +120,7 @@ class ServerSockets {
   }
 
   /**
-   * Remove given socket from all rooms.
+   * Delete given socket.
    * @private
    */
   [kSocketsDeleteSocket](socket) {

package/src/server/ServerStateManager.js

@@ -471,21 +471,21 @@ class ServerStateManager extends BaseStateManager {
    */
   defineClass(className, classDescription) {
     if (!isString(className)) {
-      throw new TypeError(`Cannot execute 'defineClass' on ServerStateManager: argument 1 must be of type SharedStateClassName`);
+      throw new TypeError(`Cannot execute 'defineClass' (${className}) on ServerStateManager: argument 1 must be of type SharedStateClassName`);
     }
 
     if (!isPlainObject(classDescription)) {
-      throw new TypeError(`Cannot execute 'defineClass' on ServerStateManager: argument 2 must be of type SharedStateClassDescription`);
+      throw new TypeError(`Cannot execute 'defineClass' (${className}) on ServerStateManager: argument 2 must be of type SharedStateClassDescription`);
     }
 
     if (this.#classes.has(className)) {
-      throw new DOMException(`Cannot execute 'defineClass' on ServerStateManager: SharedState class '${className}' is already defined`, 'NotSupportedError');
+      throw new DOMException(`Cannot execute 'defineClass'(${className})  on ServerStateManager: SharedState class '${className}' is already defined`, 'NotSupportedError');
     }
 
     try {
       ParameterBag.validateDescription(classDescription);
     } catch (err) {
-      throw new TypeError(`Cannot execute 'defineClass' on ServerStateManager: ${err.message}`);
+      throw new TypeError(`Cannot execute 'defineClass' (${className}) on ServerStateManager: ${err.message}`);
     }
 
     this.#classes.set(className, clonedeep(classDescription));
@@ -586,11 +586,11 @@ class ServerStateManager extends BaseStateManager {
    */
   registerCreateHook(className, createHook) {
     if (!this.#classes.has(className)) {
-      throw new TypeError(`Cannot execute 'registerCreateHook' on BaseStateManager: SharedState class '${className}' is not defined`);
+      throw new TypeError(`Cannot execute 'registerCreateHook' (${className}) on BaseStateManager: SharedState class '${className}' is not defined`);
     }
 
     if (!isFunction(createHook)) {
-      throw new TypeError(`Cannot execute 'registerCreateHook' on BaseStateManager: argument 2 must be a function`);
+      throw new TypeError(`Cannot execute 'registerCreateHook' (${className}) on BaseStateManager: argument 2 must be a function`);
     }
 
     const hooks = this.#createHooksByClassName.get(className);
@@ -634,11 +634,11 @@ class ServerStateManager extends BaseStateManager {
    */
   registerDeleteHook(className, deleteHook) {
     if (!this.#classes.has(className)) {
-      throw new TypeError(`Cannot execute 'registerDeleteHook' on BaseStateManager: SharedState class '${className}' is not defined`);
+      throw new TypeError(`Cannot execute 'registerDeleteHook' (${className}) on BaseStateManager: SharedState class '${className}' is not defined`);
     }
 
     if (!isFunction(deleteHook)) {
-      throw new TypeError(`Cannot execute 'registerDeleteHook' on BaseStateManager: argument 2 must be a function`);
+      throw new TypeError(`Cannot execute 'registerDeleteHook' (${className}) on BaseStateManager: argument 2 must be a function`);
     }
 
     const hooks = this.#deleteHooksByClassName.get(className);
@@ -689,11 +689,11 @@ class ServerStateManager extends BaseStateManager {
    */
   registerUpdateHook(className, updateHook) {
     if (!this.#classes.has(className)) {
-      throw new TypeError(`Cannot execute 'registerUpdateHook' on BaseStateManager: SharedState class '${className}' is not defined`);
+      throw new TypeError(`Cannot execute 'registerUpdateHook' (${className}) on BaseStateManager: SharedState class '${className}' is not defined`);
     }
 
     if (!isFunction(updateHook)) {
-      throw new TypeError(`Cannot execute 'registerUpdateHook' on BaseStateManager: argument 2 must be a function`);
+      throw new TypeError(`Cannot execute 'registerUpdateHook' (${className}) on BaseStateManager: argument 2 must be a function`);
     }
 
     const hooks = this.#updateHooksByClassName.get(className);

package/types/common/ParameterBag.d.ts

@@ -62,6 +62,7 @@ export default ParameterBag;
 /** @private */
 declare class ParameterBag {
     static validateDescription(description: any): void;
+    static getFullDescription(description: any): any;
     constructor(description: any, initValues?: {});
     /**
      * Define if the parameter exists.

package/types/common/SharedStateCollection.d.ts

@@ -296,6 +296,22 @@ declare class SharedStateCollection {
      * @return {}
      */
     find(func: Function): any;
+    /**
+     * Execute a user-supplied "reducer" callback function on each element of the collection,
+     * in order, passing in the return value from the calculation on the preceding element.
+     * The final result of running the reducer across all elements of the array is a single value.
+     *
+     * @template T
+     * @param {Function} func - A function to execute for each element in the array.
+     *  Its return value becomes the value of the accumulator parameter on the next
+     *  invocation of callbackFn. For the last invocation, the return value becomes
+     *  the return value of reduce(). The function is called with the following arguments:
+     * @param {T} initialValue - A value to which accumulator is initialized the first
+     *  time the callback is called. If initialValue is specified, callbackFn starts
+     *  executing with the first value in the array as currentValue.
+     * @return {T}
+     */
+    reduce<T>(func: Function, initialValue: T, ...args: any[]): T;
     /** @private */
     private [kSharedStateCollectionInit];
     /**

package/types/common/version.d.ts

@@ -1,2 +1,2 @@
-declare const _default: "5.0.2";
+declare const _default: "5.1.0";
 export default _default;

package/types/server/ServerSockets.d.ts

@@ -32,7 +32,7 @@ declare class ServerSockets {
      */
     private [kSocketsStop];
     /**
-     * Remove given socket from all rooms.
+     * Delete given socket.
      * @private
      */
     private [kSocketsDeleteSocket];