@ircam/comote-helpers 1.0.1 → 1.0.4

package/examples/soundworks/src/clients/player/index.js

@@ -1,118 +0,0 @@
-import '@soundworks/helpers/polyfills.js';
-import { Client } from '@soundworks/core/client.js';
-import { loadConfig, launcher } from '@soundworks/helpers/browser.js';
-import { html, render } from 'lit';
-
-import '../components/sw-credits.js';
-import * as CoMoteQRCode from '@ircam/comote-helpers/qrcode.js';
-
-import '@ircam/sc-components/sc-text.js';
-import '@ircam/sc-components/sc-toggle.js';
-import '@ircam/sc-components/sc-editor.js';
-import '@ircam/sc-components/sc-tab.js';
-
-// - General documentation: https://soundworks.dev/
-// - API documentation:     https://soundworks.dev/api
-// - Issue Tracker:         https://github.com/collective-soundworks/soundworks/issues
-// - Wizard & Tools:        `npx soundworks`
-
-async function main($container) {
-  /**
-   * Load configuration from config files and create the soundworks client
-   */
-  const config = loadConfig();
-  const client = new Client(config);
-  launcher.register(client, { initScreensContainer: $container });
-
-  await client.start();
-
-  const global = await client.stateManager.attach('global');
-
-  let qrCode;
-  let data = {};
-  let buttonA = false;
-  let buttonB = false;
-  let control = {};
-
-  global.onUpdate(async updates => {
-    if ('comoteConfig' in updates) {
-      qrCode = await CoMoteQRCode.dataURL(updates.comoteConfig);
-    }
-
-    if ('data' in updates) {
-      ({data} = updates);
-
-      if ('control' in updates.data) {
-        control = updates.data.control;
-
-        if ('buttonA' in updates.data.control) {
-          buttonA = !!updates.data.control.buttonA;
-        } else if ('buttonB' in updates.data.control) {
-          buttonB = !!updates.data.control.buttonB;
-        }
-      }
-    }
-
-    renderApp();
-  }, true);
-
-  function renderApp() {
-    render(html`
-      <div style="padding: 20px">
-        <h1 style="margin: 20px 0">CoMote dashboard</h1>
-
-        <div style="margin-bottom: 10px;">
-          <sc-text>WiFi infos</sc-text>
-          <sc-text style="height: 80px;">${JSON.stringify(global.get('wifiInfos'), null, 2)}</sc-text>
-        </div>
-        <div style="margin-bottom: 10px;">
-          <sc-text>Settings</sc-text>
-          <sc-editor
-            value=${JSON.stringify(global.get('comoteConfig'), null, 2)}
-            @change=${e => global.set({ comoteConfig: JSON.parse(e.detail.value) })}
-          ></sc-editor>
-        </div>
-
-        <div style="display: inline-block; vertical-align: top; margin-right: 12px">
-          <sc-text style="display: block; margin-bottom: 4px;">Flash QR to retrieve settings in CoMote</sc-text>
-          <img src=${qrCode} width="300" height="300" style="image-rendering: pixelated;"/>
-        </div>
-
-        <div style="display: inline-block; vertical-align: top; margin-right: 12px">
-          <sc-text style="width: 300px; height: 350px">${JSON.stringify(data, null, 2)}</sc-text>
-        </div>
-
-        <div style="display: inline-block; vertical-align: top; margin-right: 12px">
-          <div style="margin-bottom: 6px">
-            <sc-text>buttonA</sc-text>
-            <sc-toggle .active=${buttonA}></sc-toggle>
-          </div>
-          <div style="margin-bottom: 6px">
-            <sc-text>buttonB</sc-text>
-            <sc-toggle .active=${buttonB}></sc-toggle>
-          </div>
-          <div style="margin-bottom: 6px">
-            <sc-text>Arbitrary control (webview)</sc-text>
-            <sc-text>${JSON.stringify(control)}</sc-text>
-          </div>
-        </div>
-
-        <div style="margin-top: 12px">
-          <sc-text>webview page</sc-text>
-          <sc-tab
-            .options=${['1', '2']}
-            value=${global.get('webviewPage')}
-            @change=${e => global.set({ webviewPage: e.detail.value })}
-          ></sc-tab>
-        </div>
-      </div>
-    `, $container);
-  }
-}
-
-// The launcher enables instanciation of multiple clients in the same page to
-// facilitate development and testing.
-// e.g. `http://127.0.0.1:8000?emulate=10` to run 10 clients side-by-side
-launcher.execute(main, {
-  numClients: parseInt(new URLSearchParams(window.location.search).get('emulate')) || 1,
-});

package/examples/soundworks/src/clients/styles/app.scss

@@ -1,79 +0,0 @@
-:root {
-  --sw-background-color: #000000;
-  --sw-medium-background-color: #121212;
-  --sw-light-background-color: #242424;
-  --sw-lighter-background-color: #363636;
-  --sw-font-color: #ffffff;
-  --sw-light-font-color: #cccccc;
-  --sw-font-color-error: #a94442;
-  --sw-font-family: Consolas, monaco, monospace;
-  --sw-font-size: 62.5%; // such that 1rem == 10px
-}
-
-html, body {
-  width: 100%;
-  min-height: 100vh;
-  background-color: var(--sw-background-color);
-  color: var(--sw-font-color);
-}
-
-html {
-  font-size: var(--sw-font-size);
-}
-
-body {
-  display: flex;
-  flex-wrap: wrap;
-}
-
-* {
-  box-sizing: border-box;
-  font-family: var(--sw-font-family);
-}
-
-body.loading {
-  background-image: url(../../images/loader.gif);
-  background-position: 50% 50%;
-  background-repeat: no-repeat;
-}
-
-.simple-layout {
-  display: block;
-  flex-grow: 1;
-  padding: 20px;
-  position: relative;
-}
-
-// default styles for controller layout
-.controller-layout {
-  display: block;
-  flex-grow: 1;
-  position: relative;
-
-  & > header {
-    display: block;
-    height: 38px;
-    line-height: 38px;
-    background-color: var(--sw-medium-background-color);
-    display: flex;
-    flex-direction: row;
-    justify-content: space-between;
-    border-bottom: 1px solid var(--sw-lighter-background-color);
-
-    h1 {
-      font-size: 12px;
-      margin: 0;
-      padding-left: 20px;
-      max-width: 50%;
-      overflow: hidden;
-    }
-
-    sc-audit {
-      max-width: 50%;
-    }
-  }
-
-  & > section {
-    padding: 20px;
-  }
-}

package/examples/soundworks/src/clients/styles/normalize.scss

@@ -1,359 +0,0 @@
-/*! normalize.css v8.0.1 | MIT License | github.com/necolas/normalize.css */
-/*
-  The MIT License (MIT)
-  Copyright © Nicolas Gallagher and Jonathan Neal
-
-  Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
-
-  The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
-
-  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
-*/
-
-/* Document
-   ========================================================================== */
-
-/**
- * 1. Correct the line height in all browsers.
- * 2. Prevent adjustments of font size after orientation changes in iOS.
- */
-
-html {
-  line-height: 1.15; /* 1 */
-  -webkit-text-size-adjust: 100%; /* 2 */
-}
-
-/* Sections
-   ========================================================================== */
-
-/**
- * Remove the margin in all browsers.
- */
-
-body {
-  margin: 0;
-}
-
-/**
- * Render the `main` element consistently in IE.
- */
-
-main {
-  display: block;
-}
-
-/**
- * Correct the font size and margin on `h1` elements within `section` and
- * `article` contexts in Chrome, Firefox, and Safari.
- */
-
-h1 {
-  font-size: 2em;
-  margin: 0.67em 0;
-}
-
-/* Grouping content
-   ========================================================================== */
-
-/**
- * 1. Add the correct box sizing in Firefox.
- * 2. Show the overflow in Edge and IE.
- */
-
-hr {
-  box-sizing: content-box; /* 1 */
-  height: 0; /* 1 */
-  overflow: visible; /* 2 */
-}
-
-/**
- * 1. Correct the inheritance and scaling of font size in all browsers.
- * 2. Correct the odd `em` font sizing in all browsers.
- */
-
-pre {
-  font-family: monospace, monospace; /* 1 */
-  font-size: 1em; /* 2 */
-}
-
-/* Text-level semantics
-   ========================================================================== */
-
-/**
- * Remove the gray background on active links in IE 10.
- */
-
-a {
-  background-color: transparent;
-}
-
-/**
- * 1. Remove the bottom border in Chrome 57-
- * 2. Add the correct text decoration in Chrome, Edge, IE, Opera, and Safari.
- */
-
-abbr[title] {
-  border-bottom: none; /* 1 */
-  text-decoration: underline; /* 2 */
-  text-decoration: underline dotted; /* 2 */
-}
-
-/**
- * Add the correct font weight in Chrome, Edge, and Safari.
- */
-
-b,
-strong {
-  font-weight: bolder;
-}
-
-/**
- * 1. Correct the inheritance and scaling of font size in all browsers.
- * 2. Correct the odd `em` font sizing in all browsers.
- */
-
-code,
-kbd,
-samp {
-  font-family: monospace, monospace; /* 1 */
-  font-size: 1em; /* 2 */
-}
-
-/**
- * Add the correct font size in all browsers.
- */
-
-small {
-  font-size: 80%;
-}
-
-/**
- * Prevent `sub` and `sup` elements from affecting the line height in
- * all browsers.
- */
-
-sub,
-sup {
-  font-size: 75%;
-  line-height: 0;
-  position: relative;
-  vertical-align: baseline;
-}
-
-sub {
-  bottom: -0.25em;
-}
-
-sup {
-  top: -0.5em;
-}
-
-/* Embedded content
-   ========================================================================== */
-
-/**
- * Remove the border on images inside links in IE 10.
- */
-
-img {
-  border-style: none;
-}
-
-/* Forms
-   ========================================================================== */
-
-/**
- * 1. Change the font styles in all browsers.
- * 2. Remove the margin in Firefox and Safari.
- */
-
-button,
-input,
-optgroup,
-select,
-textarea {
-  font-family: inherit; /* 1 */
-  font-size: 100%; /* 1 */
-  line-height: 1.15; /* 1 */
-  margin: 0; /* 2 */
-}
-
-/**
- * Show the overflow in IE.
- * 1. Show the overflow in Edge.
- */
-
-button,
-input { /* 1 */
-  overflow: visible;
-}
-
-/**
- * Remove the inheritance of text transform in Edge, Firefox, and IE.
- * 1. Remove the inheritance of text transform in Firefox.
- */
-
-button,
-select { /* 1 */
-  text-transform: none;
-}
-
-/**
- * Correct the inability to style clickable types in iOS and Safari.
- */
-
-button,
-[type="button"],
-[type="reset"],
-[type="submit"] {
-  -webkit-appearance: button;
-}
-
-/**
- * Remove the inner border and padding in Firefox.
- */
-
-button::-moz-focus-inner,
-[type="button"]::-moz-focus-inner,
-[type="reset"]::-moz-focus-inner,
-[type="submit"]::-moz-focus-inner {
-  border-style: none;
-  padding: 0;
-}
-
-/**
- * Restore the focus styles unset by the previous rule.
- */
-
-button:-moz-focusring,
-[type="button"]:-moz-focusring,
-[type="reset"]:-moz-focusring,
-[type="submit"]:-moz-focusring {
-  outline: 1px dotted ButtonText;
-}
-
-/**
- * Correct the padding in Firefox.
- */
-
-fieldset {
-  padding: 0.35em 0.75em 0.625em;
-}
-
-/**
- * 1. Correct the text wrapping in Edge and IE.
- * 2. Correct the color inheritance from `fieldset` elements in IE.
- * 3. Remove the padding so developers are not caught out when they zero out
- *    `fieldset` elements in all browsers.
- */
-
-legend {
-  box-sizing: border-box; /* 1 */
-  color: inherit; /* 2 */
-  display: table; /* 1 */
-  max-width: 100%; /* 1 */
-  padding: 0; /* 3 */
-  white-space: normal; /* 1 */
-}
-
-/**
- * Add the correct vertical alignment in Chrome, Firefox, and Opera.
- */
-
-progress {
-  vertical-align: baseline;
-}
-
-/**
- * Remove the default vertical scrollbar in IE 10+.
- */
-
-textarea {
-  overflow: auto;
-}
-
-/**
- * 1. Add the correct box sizing in IE 10.
- * 2. Remove the padding in IE 10.
- */
-
-[type="checkbox"],
-[type="radio"] {
-  box-sizing: border-box; /* 1 */
-  padding: 0; /* 2 */
-}
-
-/**
- * Correct the cursor style of increment and decrement buttons in Chrome.
- */
-
-[type="number"]::-webkit-inner-spin-button,
-[type="number"]::-webkit-outer-spin-button {
-  height: auto;
-}
-
-/**
- * 1. Correct the odd appearance in Chrome and Safari.
- * 2. Correct the outline style in Safari.
- */
-
-[type="search"] {
-  -webkit-appearance: textfield; /* 1 */
-  outline-offset: -2px; /* 2 */
-}
-
-/**
- * Remove the inner padding in Chrome and Safari on macOS.
- */
-
-[type="search"]::-webkit-search-decoration {
-  -webkit-appearance: none;
-}
-
-/**
- * 1. Correct the inability to style clickable types in iOS and Safari.
- * 2. Change font properties to `inherit` in Safari.
- */
-
-::-webkit-file-upload-button {
-  -webkit-appearance: button; /* 1 */
-  font: inherit; /* 2 */
-}
-
-/* Interactive
-   ========================================================================== */
-
-/*
- * Add the correct display in Edge, IE 10+, and Firefox.
- */
-
-details {
-  display: block;
-}
-
-/*
- * Add the correct display in all browsers.
- */
-
-summary {
-  display: list-item;
-}
-
-/* Misc
-   ========================================================================== */
-
-/**
- * Add the correct display in IE 10+.
- */
-
-template {
-  display: none;
-}
-
-/**
- * Add the correct display in IE 10.
- */
-
-[hidden] {
-  display: none;
-}

package/examples/soundworks/src/clients/webview/index.js

@@ -1,78 +0,0 @@
-import '@soundworks/helpers/polyfills.js';
-import { Client } from '@soundworks/core/client.js';
-import { loadConfig, launcher } from '@soundworks/helpers/browser.js';
-import { html, render } from 'lit';
-
-import '../components/sw-credits.js';
-
-import '@ircam/sc-components/sc-button.js';
-import '@ircam/sc-components/sc-slider.js';
-import '@ircam/sc-components/sc-text.js';
-import '@ircam/sc-components/sc-toggle.js';
-
-// - General documentation: https://soundworks.dev/
-// - API documentation:     https://soundworks.dev/api
-// - Issue Tracker:         https://github.com/collective-soundworks/soundworks/issues
-// - Wizard & Tools:        `npx soundworks`
-
-async function main($container) {
-  const config = loadConfig();
-  const client = new Client(config);
-
-  launcher.register(client, { initScreensContainer: $container });
-
-  await client.start();
-
-  const global = await client.stateManager.attach('global', ['webviewPage']);
-  global.onUpdate(updates => renderApp(), true);
-
-  function renderApp() {
-    render(html`
-      <div class="simple-layout">
-        <h1>CoMote Test WebView</h1>
-
-        ${global.get('webviewPage') === '1'
-          ? html`
-              <div style="margin: 4px 0;">
-                <h2>Page 1</h2>
-                <sc-text>w/ attributes</sc-text>
-                <sc-button
-                  comote-key="my-button"
-                  comote-touchstart="1"
-                  comote-touchend="0"
-                >Simple Test</sc-button>
-              </div>
-              <div style="margin: 4px 0;">
-                <sc-text>w/ sendEvent</sc-text>
-                <sc-slider
-                  @input=${e => sendEvent('my-slider', e.detail.value)}
-                ></sc-slider>
-                <sc-toggle
-                  @change=${e => sendEvent('my-toggle', e.detail.value)}
-                ></sc-toggle>
-              </div>
-            `
-          : html`
-              <div style="margin: 4px 0;">
-                <h2>Page 2</h2>
-                <sc-text>my-second-slider</sc-text>
-                <sc-slider
-                  @input=${e => sendEvent('my-second-slider', e.detail.value)}
-                ></sc-slider>
-              </div>
-            `
-        }
-
-
-        <sw-credits .infos="${client.config.app}"></sw-credits>
-      </div>
-    `, $container);
-  }
-}
-
-// The launcher enables instanciation of multiple clients in the same page to
-// facilitate development and testing.
-// e.g. `http://127.0.0.1:8000?emulate=10` to run 10 clients side-by-side
-launcher.execute(main, {
-  numClients: parseInt(new URLSearchParams(window.location.search).get('emulate')) || 1,
-});

package/examples/soundworks/src/server/index.js

@@ -1,62 +0,0 @@
-import '@soundworks/helpers/polyfills.js';
-import { Server } from '@soundworks/core/server.js';
-import { loadConfig } from '@soundworks/helpers/node.js';
-
-import '../utils/catch-unhandled-errors.js';
-
-import { Server as CoMoteServer } from '@ircam/comote-helpers/server.js';
-import * as CoMoteQRCode from '@ircam/comote-helpers/qrcode.js';
-import { getWifiInfos } from '@ircam/comote-helpers/wifi-infos.js';
-
-import globalSchema from './schemas/global.js';
-
-// - General documentation: https://soundworks.dev/
-// - API documentation:     https://soundworks.dev/api
-// - Issue Tracker:         https://github.com/collective-soundworks/soundworks/issues
-// - Wizard & Tools:        `npx soundworks`
-
-const config = loadConfig(process.env.ENV, import.meta.url);
-
-console.log(`
---------------------------------------------------------
-- launching "${config.app.name}" in "${process.env.ENV || 'default'}" environment
-- [pid: ${process.pid}]
---------------------------------------------------------
-`);
-
-const server = new Server(config);
-server.useDefaultApplicationTemplate();
-
-server.stateManager.registerSchema('global', globalSchema);
-
-await server.start();
-
-const wifiInfos = await getWifiInfos();
-const comoteConfig = {
-  id: 0,
-  interval: 20, // period in ms
-  ws: {
-    port: 8901,
-    hostname: wifiInfos.ip,
-    autostart: true,
-  },
-  osc: null,
-  webview: `http://${wifiInfos.ip}:${config.env.port}/webview`,
-  // test raw HTML
-  // webview: `<button style="width: 500px; height: 300px;" comote-key="coucou-1" comote-touchstart="1" comote-touchend="0">Coucou</button>`
-};
-
-const comoteServer = new CoMoteServer(comoteConfig, { verbose: false });
-await comoteServer.start();
-
-// -----------------------------------------------------------
-console.log('+ CoMote link:', CoMoteQRCode.rawLink(comoteConfig));
-console.log('');
-console.log(await CoMoteQRCode.terminal(comoteConfig));
-
-const global = await server.stateManager.create('global', {
-  wifiInfos,
-  comoteConfig,
-});
-
-comoteServer.addWsListener(data => global.set({ data }));

package/examples/soundworks/src/server/schemas/.gitkeep

@@ -1 +0,0 @@
-.gitkeep