@soundworks/core 5.7.0 → 5.8.0

package/CHANGELOG.md

@@ -1,5 +1,9 @@
 # CHANGELOG
 
+## v5.8.0 - 2026-10-01
+
+- Feat: SharedState#WaitFor accept arbitrary function as condition
+
 ## v5.7.0 - 2026-10-01
 
 - Refactor: SharedState callback and instantiation

package/package.json

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

package/src/common/SharedState.js

@@ -1,6 +1,7 @@
 import {
   isPlainObject,
   isString,
+  isFunction,
 } from '@ircam/sc-utils';
 
 import ParameterBag from './ParameterBag.js';
@@ -383,19 +384,25 @@ class SharedState {
   }
 
   #checkPendingWaitForConditions() {
-    const values = this.getValuesUnsafe();
+    const values = this.getValues();
 
     this.#waitForConditions.forEach(payload => {
       const { resolve, condition, timeoutId } = payload;
-      let match = true;
+      let match;
 
-      for (let [key, value] of Object.entries(condition)) {
-        if (values[key] !== value) {
-          match = false;
+      if (isFunction(condition)) {
+        match = condition(values);
+      } else {
+        match = true;
+
+        for (let [key, value] of Object.entries(condition)) {
+          if (values[key] !== value) {
+            match = false;
+          }
         }
       }
 
-      if (match) {
+      if (match === true) {
         clearTimeout(timeoutId);
         this.#waitForConditions.delete(payload);
         resolve();
@@ -954,14 +961,16 @@ class SharedState {
    *
    * @private
    * @param {object} condition - Condition to be meet in the state for the
-   *  returned promise to resolve.
-   * @param {object} condition - Timeout (in milliseconds) that trigger the rejection
+   *  returned promise to resolve. The condition is either a function which returns
+   *  `true` when the condition is met or an object that describe a desired state
+   *  of a subset the `SharedState` values.
+   * @param {object} timeout - Timeout (in milliseconds) that trigger the rejection
    *  of the returned promise.
    * @return {Promise}
    */
   waitFor(condition, timeout = null) {
-    if (!isPlainObject(condition)) {
-      throw new TypeError(`Cannot execute 'waitFor' on SharedState: argument 0 must be an object`);
+    if (!isPlainObject(condition) && !isFunction(condition)) {
+      throw new TypeError(`Cannot execute 'waitFor' on SharedState: argument 0 must be either a function or an object`);
     }
 
     if (timeout !== null && (!Number.isFinite(timeout) || timeout <= 0)) {

package/src/common/version.js

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

package/types/common/SharedState.d.ts

@@ -301,8 +301,10 @@ declare class SharedState {
      *
      * @private
      * @param {object} condition - Condition to be meet in the state for the
-     *  returned promise to resolve.
-     * @param {object} condition - Timeout (in milliseconds) that trigger the rejection
+     *  returned promise to resolve. The condition is either a function which returns
+     *  `true` when the condition is met or an object that describe a desired state
+     *  of a subset the `SharedState` values.
+     * @param {object} timeout - Timeout (in milliseconds) that trigger the rejection
      *  of the returned promise.
      * @return {Promise}
      */

package/types/common/SharedState.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"SharedState.d.ts","sourceRoot":"","sources":["../../src/common/SharedState.js"],"names":[],"mappings":"AAmCA,qDAAwF;;;;;sDAM7E,MAAM,GAAC,GAAG,aAGV,MAAM,GAAC,GAAG,eAGV,iCAAiC;;;;;AAV5C;;;;;;;;;;;;GAYG;AAEH;;;;GAIG;AAEH;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAuDG;AACH;IAoSE;;;OAGG;IACH,iBAEC;IAED;;;OAGG;IACH,wBAEC;IAED;;OAEG;IACH,yBAGC;IAED;;;OAGG;IACH,uBAEC;IAED;;;;;OAKG;IACH,2BAUC;IAED;;;;;;;;;;;OAWG;IACH,2BARW,MAAM,GAEL,2BAA2B,GAAC,+BAA+B,CAYtE;;;;;;;;;;;IAQE,aACQ,MAAM,GACJ,OAAO,CAAC,MAAM,CAAC,CAC3B;;;;;;;;;;;;IAOE,UACQ,wBAAwB,SACxB,GAAC,GACC,OAAO,CAAC,MAAM,CAAC,CAC3B;IA6KD;;;;;;;;;;;;;;OAcG;IACH,UANW,wBAAwB,GACvB,GAAG,CAkBd;IAED;;;;;;;;;;;;;;OAcG;IACH,gBANW,wBAAwB,GACvB,GAAG,CAkBd;IAED;;;;;;;;OAQG;IACH,aAJY,MAAM,CAOjB;IAED;;;;;;;;;;;;OAYG;IACH,mBAJY,MAAM,CAOjB;IAED;;;;;;;OAOG;IACH,iBAJY,MAAM,CAMjB;IAED;;;;;;OAMG;IACH,eAJY,MAAM,CAMjB;IAED;;;;;;;;OAQG;IACH,uBAiBC;IAED;;;;;;;;;;;;;;OAcG;IACH,uBAUC;;;;;;;;;;;;;;;IAKE,mBACQ,2BAA2B,0CAIzB,iCAAiC,CAC3C;;;;;;;;;;;;;;;;IAQA,oBACQ,wBAAwB,YACxB,2BAA2B,0CAIzB,iCAAiC,CAC3C;IAwDH;;;;;;;OAOG;IACH,4CAGC;IAED;;;;;;OAMG;IACH,4CAOC;IAED;;;;;;;;;;;;;OAaG;IACH,gBAgCC;IAMD;;OAEG;IACH,iCAGC;IAx1BC,eAAe;IACf,mCAAwE;;CAy1B3E"}
+{"version":3,"file":"SharedState.d.ts","sourceRoot":"","sources":["../../src/common/SharedState.js"],"names":[],"mappings":"AAoCA,qDAAwF;;;;;sDAM7E,MAAM,GAAC,GAAG,aAGV,MAAM,GAAC,GAAG,eAGV,iCAAiC;;;;;AAV5C;;;;;;;;;;;;GAYG;AAEH;;;;GAIG;AAEH;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAuDG;AACH;IA0SE;;;OAGG;IACH,iBAEC;IAED;;;OAGG;IACH,wBAEC;IAED;;OAEG;IACH,yBAGC;IAED;;;OAGG;IACH,uBAEC;IAED;;;;;OAKG;IACH,2BAUC;IAED;;;;;;;;;;;OAWG;IACH,2BARW,MAAM,GAEL,2BAA2B,GAAC,+BAA+B,CAYtE;;;;;;;;;;;IAQE,aACQ,MAAM,GACJ,OAAO,CAAC,MAAM,CAAC,CAC3B;;;;;;;;;;;;IAOE,UACQ,wBAAwB,SACxB,GAAC,GACC,OAAO,CAAC,MAAM,CAAC,CAC3B;IA6KD;;;;;;;;;;;;;;OAcG;IACH,UANW,wBAAwB,GACvB,GAAG,CAkBd;IAED;;;;;;;;;;;;;;OAcG;IACH,gBANW,wBAAwB,GACvB,GAAG,CAkBd;IAED;;;;;;;;OAQG;IACH,aAJY,MAAM,CAOjB;IAED;;;;;;;;;;;;OAYG;IACH,mBAJY,MAAM,CAOjB;IAED;;;;;;;OAOG;IACH,iBAJY,MAAM,CAMjB;IAED;;;;;;OAMG;IACH,eAJY,MAAM,CAMjB;IAED;;;;;;;;OAQG;IACH,uBAiBC;IAED;;;;;;;;;;;;;;OAcG;IACH,uBAUC;;;;;;;;;;;;;;;IAKE,mBACQ,2BAA2B,0CAIzB,iCAAiC,CAC3C;;;;;;;;;;;;;;;;IAQA,oBACQ,wBAAwB,YACxB,2BAA2B,0CAIzB,iCAAiC,CAC3C;IAwDH;;;;;;;OAOG;IACH,4CAGC;IAED;;;;;;OAMG;IACH,4CAOC;IAED;;;;;;;;;;;;;;;OAeG;IACH,gBAgCC;IAMD;;OAEG;IACH,iCAGC;IAh2BC,eAAe;IACf,mCAAwE;;CAi2B3E"}

package/types/common/version.d.ts

@@ -1,3 +1,3 @@
-declare const _default: "5.7.0";
+declare const _default: "5.8.0";
 export default _default;
 //# sourceMappingURL=version.d.ts.map