@soundworks/core/src/server/index.js

Open-source creative coding framework for distributed applications based on Web technologies

/**
 * @license
 * Copyright (c) 2014-present IRCAM – Centre Pompidou (France, Paris)
 * SPDX-License-Identifier: BSD-3-Clause
 */

// these types must be defined here, so that they can be imported into the application

/**
 * The role of the client in the application.
 *
 * For browser client, this information is used to create the URL endpoint.
 *
 * @typedef ClientRole
 * @type {string}
 */
/**
 * @typedef ClientDescription
 * @type {object}
 * @property {'browser'|'node'} runtime - Runtime on which the client is aimed at running
 * @property {boolean} [default=false] - For browser client, define is the client should be
 *   accessible at the default / root HTTP endpoint
 */
/**
 * Application configuration object.
 *
 * @typedef ServerAppConfig
 * @type {object}
 * @property {object<ClientRole, ClientDescription>} clients - Definition of the application clients.
 * @property {string} [name=''] - Name of the application.
 * @property {string} [author=''] - Name of the author.
 */
/**
 * Environment configuration object.
 *
 * @typedef ServerEnvConfig
 * @type {objecy}
 * @property {'development'|'production'} type - If set to 'production', will enforce
 *  some security feature (e.g. blocking access to sensitive APIs, etc.) based on
 *  the `auth`.
 * @property {number} port - Port on which the server is listening.
 * @property {string} serverAddress - Domain name or IP of the server.
 *  Mandatory when node clients are declared
 * @property {boolean} useHttps - Define is the server run in http or in https.
 * @property {object} [httpsInfos=null] - Path to cert files ( cert, key } for https.
 *  If not given and `useHttps` is `true` self certified certificates will be created.
 * @property {string} [httpsInfos.cert=null] - Path to cert file.
 * @property {string} [httpsInfos.key=null] - Path to key file.
 * @property {object} [auth=null] - Configuration object for authenticating clients
 *  using simple HTTP authentication.
 * @property {array.<ClientRole>} [auth.client=[]] - List of client role that must authenticate.
 * @property {login} [auth.login=''] - Login
 * @property {login} [auth.password=''] - Password
 * @property {string} [env.baseUrl=''] - If running behind a proxy, base URL of the application.
 */
/**
 * Configuration object for the server.
 *
 * @typedef ServerConfig
 * @type {object}
 * @property {AppConfig} app - Application configuration object.
 * @property {ServerEnvConfig} env - Environment configuration object.
 */

export { default as Server } from './Server.js';
export { default as ServerPlugin } from './ServerPlugin.js';
export { default as ServerContext } from './ServerContext.js';
export { default as version } from '../common/version.js';