@soundworks/core 4.0.0-alpha.28 → 4.0.0-alpha.29

package/src/common/BatchedTransport.js

@@ -1,5 +1,3 @@
-import { delay } from '@ircam/sc-utils';
-
 import { BATCHED_TRANSPORT_CHANNEL } from './constants.js';
 
 /**
@@ -11,20 +9,22 @@ import { BATCHED_TRANSPORT_CHANNEL } from './constants.js';
  * @private
  */
 class BatchedTransport {
+  #transport = null;
+  #listeners = new Map();
+  #stack = [];
+  #sending = false;
+
   constructor(transport) {
-    this._transport = transport;
-    this._listeners = new Map();
-    this._stack = [];
-    this._sending = false;
+    this.#transport = transport;
 
-    this._transport.addListener(BATCHED_TRANSPORT_CHANNEL, stack => {
+    this.#transport.addListener(BATCHED_TRANSPORT_CHANNEL, stack => {
       stack.forEach(entry => {
         const [channel, args] = entry;
         // server side the transport is the same EventEmitter instance
         // for both state manager server and client, so channel might not exist
         // one side or the other.
-        if (this._listeners.has(channel)) {
-          const callbacks = this._listeners.get(channel);
+        if (this.#listeners.has(channel)) {
+          const callbacks = this.#listeners.get(channel);
           callbacks.forEach(callback => callback(...args));
         }
       });
@@ -32,39 +32,39 @@ class BatchedTransport {
   }
 
   addListener(channel, callback) {
-    if (!this._listeners.has(channel)) {
-      this._listeners.set(channel, new Set());
+    if (!this.#listeners.has(channel)) {
+      this.#listeners.set(channel, new Set());
     }
 
-    const callbacks = this._listeners.get(channel);
+    const callbacks = this.#listeners.get(channel);
     callbacks.add(callback);
   }
 
   async emit(channel, ...args) {
-    this._stack.push([channel, args]);
+    this.#stack.push([channel, args]);
 
-    if (!this._sending) {
-      this._sending = true;
+    if (!this.#sending) {
+      this.#sending = true;
       await false;
-      this._sending = false;
-      const stack = this._stack;
-      this._stack = [];
-      this._transport.emit(BATCHED_TRANSPORT_CHANNEL, stack);
+      this.#sending = false;
+      const stack = this.#stack;
+      this.#stack = [];
+      this.#transport.emit(BATCHED_TRANSPORT_CHANNEL, stack);
     }
   }
 
   removeListener(channel, callback) {
-    if (!this._listeners.has(channel)) {
-      const callbacks = this._listeners.get(channel);
+    if (!this.#listeners.has(channel)) {
+      const callbacks = this.#listeners.get(channel);
       callbacks.delete(callback);
     }
   }
 
   removeAllListeners(channel = null) {
     if (channel === null) {
-      this._listeners.clear();
-    } else if (this._listeners.has(channel)) {
-      const callbacks = this._listeners.get(channel);
+      this.#listeners.clear();
+    } else if (this.#listeners.has(channel)) {
+      const callbacks = this.#listeners.get(channel);
       callbacks.clear();
     }
   }

package/src/common/ParameterBag.js

@@ -4,6 +4,7 @@ import equal from 'fast-deep-equal';
 export const sharedOptions = {
   nullable: false,
   event: false, // if event=true, nullable=true
+  required: false, // if required=true, default is set to init value
   metas: {},
   filterChange: true,
   immediate: false,
@@ -129,10 +130,7 @@ export const types = {
 };
 
 
-/**
- * Bag of parameters.
- * @private
- */
+/** @private */
 class ParameterBag {
   static validateSchema(schema) {
     for (let name in schema) {
@@ -149,8 +147,13 @@ class ParameterBag {
       const required = types[def.type].required;
 
       required.forEach(key => {
-        if (def.event === true && key === 'default') {
-          // do nothing, default is always null for `event` params
+        if ((def.event === true || def.required === true) && key === 'default') {
+          // do nothing:
+          // - default is always null for `event` params
+          // - default is always null for `required` params
+          if ('default' in def && def.default !== null) {
+            throw new TypeError(`[StateManager.registerSchema] Invalid schema definition for param ${name} - "default" propaerty is set and not null while the parameter definition is declared as "event" or "required"`);
+          }
         } else if (!Object.prototype.hasOwnProperty.call(def, key)) {
           throw new TypeError(`[StateManager.registerSchema] Invalid schema definition - param "${name}" (type "${def.type}"): "${key}" key is required`);
         }
@@ -211,6 +214,15 @@ class ParameterBag {
         def.default = null;
       }
 
+      if (def.required === true) {
+        // throw if value is not given in init values
+        if (initValues[name] === undefined || initValues[name] === null) {
+          throw new Error(`[SharedState.create] Invalid init value for required param "${name}", cannot be null or undefined`);
+        }
+
+        def.default = initValues[name];
+      }
+
       let initValue;
 
       if (Object.prototype.hasOwnProperty.call(initValues, name)) {

package/src/common/PromiseStore.js

@@ -1,5 +1,6 @@
 import { idGenerator } from '@ircam/sc-utils';
 
+/** @private */
 export default class PromiseStore {
   constructor(name) {
     this.name = name;