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

package/src/client/ContextManager.js

@@ -1,111 +0,0 @@
-/** @private */
-class ContextCollection {
-  constructor() {
-    this.inner = [];
-  }
-
-  add(context) {
-    this.inner.push(context);
-  }
-
-  has(name) {
-    return this.inner.find(c => c.name === name) !== undefined;
-  }
-
-  get(name) {
-    return this.inner.find(c => c.name === name);
-  }
-
-  map(func) {
-    return this.inner.map(func);
-  }
-}
-
-/**
- * Manage the different contexts and their lifecycle.
- *
- * See {@link client.Client#contextManager}
- *
- * _WARNING: In most cases, you should not have to manipulate the context manager directly._
- *
- * @memberof client
- * @hideconstructor
- */
-class ContextManager {
-  constructor() {
-    /** @private */
-    this._contexts = new ContextCollection();
-    /** @private */
-    this._contextStartPromises = new Map();
-  }
-
-  /**
-   * Register the context into the manager. Is called in context constructor.
-   *
-   * @param {client.Context} context - The context to be registered.
-   * @private
-   */
-  register(context) {
-    if (this._contexts.has(context.name)) {
-      throw new Error(`[soundworks:context-manager] Context "${context.name}" already registered`);
-    }
-
-    this._contexts.add(context);
-  }
-
-  /**
-   * Retrieve a started context from its name.
-   *
-   * _WARNING: Most of the time, you should not have to call this method manually._
-   *
-   * @param {client.Context#name} contextName - Name of the context.
-   */
-  async get(contextName) {
-    if (!this._contexts.has(contextName)) {
-      throw new Error(`[soundworks:ContextManager] Can't get context "${contextName}", not registered`);
-    }
-
-    const context = this._contexts.get(contextName);
-
-    if (this._contextStartPromises.has(contextName)) {
-      const startPromise = this._contextStartPromises.get(contextName);
-      await startPromise;
-    } else {
-      context.status = 'inited';
-
-      try {
-        const startPromise = context.start();
-        this._contextStartPromises.set(contextName, startPromise);
-        await startPromise;
-        context.status = 'started';
-      } catch (err) {
-        context.status = 'errored';
-        throw new Error(err);
-      }
-    }
-
-    return context;
-  }
-
-  /**
-   * Start all registered contexts. Called during `client.start()`
-   *
-   * @private
-   */
-  async start() {
-    const promises = this._contexts.map(context => this.get(context.name));
-    await Promise.all(promises);
-  }
-
-  /**
-   * Stop all registered contexts. Called during `client.stop()`
-   *
-   * @private
-   */
-  async stop() {
-    const promises = this._contexts.map(context => context.stop());
-    await Promise.all(promises);
-  }
-}
-
-export default ContextManager;

package/src/client/SharedState.js

@@ -1,84 +0,0 @@
-import BaseSharedState from '../common/BaseSharedState.js';
-
-// this file exists only for documentation purposes
-
-/**
- * @callback client.SharedState~onUpdateCallback
- * @param {Object} newValues - Key / value pairs of the updates that have been
- *  applied to the state.
- * @param {Object} oldValues - Key / value pairs of the updated params before
- *  the updates has been applied to the state.
- * @param {Mixed} [context=null] - Optionnal context object that has been passed
- *  with the values updates in the `set` call.
- */
-
-/**
- * Delete the registered {@link client.SharedState~onUpdateCallback}.
- *
- * @callback client.SharedState~deleteOnUpdateCallback
- */
-
-
-/**
- * The `SharedState` is one of the most important and versatile abstraction provided
- * by `soundworks`. It represents a set of parameters that are synchronized accross
- * every nodes of the application (clients and server) that declared some interest
- * to the shared state.
- *
- * A `SharedState` is created according to a "schema" (in the sense of a database
- * schema) that must be declared and registered server-side. Any number of `SharedState`s
- * can be created from a single schema.
- *
- * A shared state can be created both by the clients or by the server (in which case
- * it is generally considered as a global state of the application). Similarly any
- * node of the application (clients or server) can declare interest and "attach" to
- * a state created by another node. All node attached to a state can modify its values
- * and/or react to the modifications applied by other nodes.
- *
- * Tutorial: {@link https://soundworks.dev/guide/state-manager.html}
- *
- * ```
- * // server-side
- * import { Server } from '@soundworks/server/index.js';
- *
- * const server = new Server(config);
- * // declare and register the schema of a shared state.
- * server.stateManager.registerSchema('some-global-state', {
- *   myRandom: {
- *     type: 'float',
- *     default: 0,
- *   }
- * });
- *
- * await server.start();
- *
- * // create a global state server-side
- * const globalState = await server.stateManager.create('some-global-state');
- * // listen and react to the changes made by the clients
- * globalState.onUpdate(updates => console.log(updates));
- * ```
- *
- * ```
- * // client-side
- * import { Client } from '@soundworks/client.index.js';
- *
- * const client = new Client(config);
- * await client.start();
- *
- * // attach to the global state created by the server
- * const globalState = await client.stateManager.attach('some-global-state');
- *
- * // update the value of a `myRandom` parameter every seconds
- * setInterval(() => {
- *   globalState.set({ myRandom: Math.random() });
- * }, 1000);
- * ```
- *
- * @memberof client
- * @extends BaseSharedState
- * @inheritdoc
- * @hideconstructor
- */
-class SharedState extends BaseSharedState {}
-
-export default SharedState;

package/src/client/SharedStateCollection.js

@@ -1,38 +0,0 @@
-import BaseSharedStateCollection from '../common/BaseSharedStateCollection.js';
-
-// this file exists only for documentation purposesSharedStateCollection.js
-
-/**
- * @callback client.SharedStateCollection~onUpdateCallback
- * @param {client.SharedState} state - State that triggered the update.
- * @param {Object} newValues - Key / value pairs of the updates that have been
- *  applied to the state.
- * @param {Object} oldValues - Key / value pairs of the updated params before
- *  the updates has been applied to the state.
- * @param {Mixed} [context=null] - Optionnal context object that has been passed
- *  with the values updates in the `set` call.
- */
-
-/**
- * The `SharedStateCollection` interface represent a collection of all states
- * created from a given schema name on the network.
- *
- * It can optionnaly exclude the states created by the current node.
- *
- * See {@link client.StateManager#getCollection} for factory method API
- *
- * ```
- * const collection = await client.stateManager.getCollection('my-schema');
- * const allValues = collection.getValues();
- * collection.onUpdate((state, newValues, oldValues, context) => {
- *   // do something
- * });
- * ```
- * @memberof client
- * @extends BaseSharedStateCollection
- * @inheritdoc
- * @hideconstructor
- */
-class SharedStateCollection extends BaseSharedStateCollection {}
-
-export default SharedStateCollection;

package/src/server/Client.js

@@ -1,55 +0,0 @@
-import { idGenerator } from '@ircam/sc-utils';
-import { v4 as uuid } from 'uuid';
-
-const generateId = idGenerator();
-
-/**
- * Server-side representation of a `soundworks` client.
- *
- * @memberof server
- * @hideconstructor
- * @see {@link client.Client}
- */
-class Client {
-  /**
-   * @param {String} role - Role of the client
-   * @param {server.Socket} socket - Socket connection with the client
-   */
-  constructor(role, socket) {
-    /**
-     * Client role, as specified in client side config {@link client.Client}.
-     *
-     * @type {String}
-     */
-    this.role = role;
-
-    /**
-     * Session Id (incremented positive number).
-     *
-     * @type {Number}
-     */
-    this.id = generateId.next().value;
-
-    /**
-     * Unique session Id (uuidv4).
-     *
-     * @type {String}
-     */
-    this.uuid = uuid();
-
-    /**
-     * Socket connection with the remote client {@link client.Client}.
-     *
-     * @type {server.Socket}
-     */
-    this.socket = socket;
-
-    /**
-     * Is set in server._onSocketConnection
-     * @private
-     */
-    this.token = null;
-  }
-}
-
-export default Client;

package/src/server/SharedState.js

@@ -1,85 +0,0 @@
-import BaseSharedState from '../common/BaseSharedState.js';
-
-// this file exists only for documentation purposes
-
-/**
- * @callback server.SharedState~onUpdateCallback
- * @param {Object} newValues - Key / value pairs of the updates that have been
- *  applied to the state.
- * @param {Object} oldValues - Key / value pairs of the updated params before
- *  the updates has been applied to the state.
- * @param {Mixed} [context=null] - Optionnal context object that has been passed
- *  with the values updates in the `set` call.
- */
-
-/**
- * Delete the registered {@link server.SharedState~onUpdateCallback}.
- *
- * @callback server.SharedState~deleteOnUpdateCallback
- */
-
-/**
- * The `SharedState` is one of the most important and versatile abstraction provided
- * by `soundworks`. It represents a set of parameters that are synchronized accross
- * every nodes of the application (clients and server) that declared some interest
- * to the shared state.
- *
- * A `SharedState` is created according to a "schema" (in the sense of a database
- * schema) that must be declared and registered server-side. Any number of `SharedState`s
- * can be created from a single schema.
- *
- * A shared state can be created both by the clients or by the server (in which case
- * it is generally considered as a global state of the application). Similarly any
- * node of the application (clients or server) can declare interest and "attach" to
- * a state created by another node. All node attached to a state can modify its values
- * and/or react to the modifications applied by other nodes.
- *
- * Tutorial: {@link https://soundworks.dev/guide/state-manager.html}
- *
- * ```
- * // server-side
- * import { Server } from '@soundworks/server/index.js';
- *
- * const server = new Server(config);
- * // declare and register the schema of a shared state.
- * server.stateManager.registerSchema('some-global-state', {
- *   myRandom: {
- *     type: 'float',
- *     default: 0,
- *   }
- * });
- *
- * await server.start();
- *
- * // create a global state server-side
- * const globalState = await server.stateManager.create('some-global-state');
- * // listen and react to the changes made by the clients
- * globalState.onUpdate(updates => console.log(updates));
- * ```
- *
- * ```
- * // client-side
- * import { Client } from '@soundworks/client.index.js';
- *
- * const client = new Client(config);
- * await client.start();
- *
- * // attach to the global state created by the server
- * const globalState = await client.stateManager.attach('some-global-state');
- *
- * // update the value of a `myRandom` parameter every seconds
- * setInterval(() => {
- *   globalState.set({ myRandom: Math.random() });
- * }, 1000);
- * ``
- *
- * @memberof server
- * @extends BaseSharedState
- * @inheritdoc
- * @hideconstructor
- * @see {server.StateManager}
- */
-class SharedState extends BaseSharedState {}
-
-export default SharedState;
-

package/src/server/SharedStateCollection.js

@@ -1,39 +0,0 @@
-import BaseSharedStateCollection from '../common/BaseSharedStateCollection.js';
-
-// this file exists only for documentation purposesSharedStateCollection.js
-
-/**
- * @callback server.SharedStateCollection~onUpdateCallback
- * @param {server.SharedState} state - State that triggered the update.
- * @param {Object} newValues - Key / value pairs of the updates that have been
- *  applied to the state.
- * @param {Object} oldValues - Key / value pairs of the updated params before
- *  the updates has been applied to the state.
- * @param {Mixed} [context=null] - Optionnal context object that has been passed
- *  with the values updates in the `set` call.
- */
-
-/**
- * The `SharedStateCollection` interface represent a collection of all states
- * created from a given schema name on the network.
- *
- * It can optionnaly exclude the states created by the current node.
- *
- * See {@link server.StateManager#getCollection} for factory method API
- *
- * ```
- * const collection = await server.stateManager.getCollection('my-schema');
- * const allValues = collection.getValues();
- * collection.onUpdate((state, newValues, oldValues, context) => {
- *   // do something
- * });
- * ```
- * @memberof server
- * @extends BaseSharedStateCollection
- * @inheritdoc
- * @hideconstructor
- */
-class SharedStateCollection extends BaseSharedStateCollection {}
-
-export default SharedStateCollection;
-