timing-provider-server 2.0.13

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 Christoph Guttandin
+
+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.

package/README.md

@@ -0,0 +1,44 @@
+# timing-provider-server
+
+**A command line tool to spin up a server which can be used with the timing-provider.**
+
+[![dependencies](https://img.shields.io/david/chrisguttandin/timing-provider-server.svg?style=flat-square)](https://github.com/chrisguttandin/timing-provider-server/network/dependencies)
+[![version](https://img.shields.io/npm/v/timing-provider-server.svg?style=flat-square)](https://www.npmjs.com/package/timing-provider-server)
+
+This command line tool spins up a server which can be used as the signaling server for the [timing-provider](https://github.com/chrisguttandin/timing-provider).
+
+## Usage
+
+The timing-provider-server package is published on [npm](https://www.npmjs.com/package/timing-provider-server). It can be installed like this:
+
+```shell
+npm install timing-provider-server
+```
+
+Afterwards the server can be started by executing the following command:
+
+```shell
+timing-provider-server
+```
+
+It is also possible to execute the command above without installing a local version of this package like this:
+
+```shell
+npx timing-provider-server
+```
+
+Once the server is up and running it can be used when creating a new `TimingProvider`.
+
+```js
+const timingProvider = new TimingProvider('ws://localhost:2276');
+```
+
+## Arguments
+
+### --port
+
+This option can be used to specify the port to which the server is listening. If this argument is not used 2276 will be used as the default port.
+
+```shell
+timing-provider-server --port 4567
+```

package/build/es2019/app.d.ts

@@ -0,0 +1,3 @@
+#!/usr/bin/env node
+export {};
+//# sourceMappingURL=app.d.ts.map

package/build/es2019/app.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"app.d.ts","sourceRoot":"","sources":["../../src/app.ts"],"names":[],"mappings":""}

package/build/es2019/app.js

@@ -0,0 +1,45 @@
+#!/usr/bin/env node
+import { generateUniqueNumber } from 'fast-unique-numbers';
+import { Server } from 'ws';
+import yargs from 'yargs';
+if (require.main !== module) {
+    throw new Error('This script is meant to be executed from the command line.');
+}
+(async () => {
+    const commandLineArguments = yargs
+        .help()
+        .option('port', {
+        default: 2276,
+        describe: 'specify the port at which the server will be listening',
+        type: 'number'
+    })
+        .strict().argv;
+    if (commandLineArguments instanceof Promise) {
+        throw new Error('The command line arguments are expected to get parsed synchronously.');
+    }
+    const { port } = commandLineArguments;
+    const activeConnections = new Map();
+    const server = new Server({ port });
+    server.on('connection', (connection) => {
+        const id = generateUniqueNumber(activeConnections);
+        const sendMessage = (message) => connection.send(JSON.stringify(message));
+        activeConnections.set(id, sendMessage);
+        connection.on('message', (message) => {
+            const parsedMessage = JSON.parse(message.toString());
+            const sendMessageToActiveConnection = activeConnections.get(parsedMessage.client.id);
+            if (sendMessageToActiveConnection !== undefined) {
+                sendMessageToActiveConnection({ client: { id }, message: parsedMessage.message });
+            }
+        });
+        connection.on('close', () => activeConnections.delete(id));
+        for (const activeConnection of activeConnections) {
+            if (activeConnection[0] !== id) {
+                const label = [id, activeConnection[0]].sort().join('-');
+                const type = 'request';
+                sendMessage({ message: { isActive: true, label, mask: { client: { id: activeConnection[0] } } }, type });
+                activeConnection[1]({ message: { isActive: false, mask: { client: { id } } }, type });
+            }
+        }
+    });
+})();
+//# sourceMappingURL=app.js.map

package/build/es2019/app.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"app.js","sourceRoot":"","sources":["../../src/app.ts"],"names":[],"mappings":";AAEA,OAAO,EAAE,oBAAoB,EAAE,MAAM,qBAAqB,CAAC;AAC3D,OAAO,EAAE,MAAM,EAAE,MAAM,IAAI,CAAC;AAC5B,OAAO,KAAK,MAAM,OAAO,CAAC;AAG1B,IAAI,OAAO,CAAC,IAAI,KAAK,MAAM,EAAE;IACzB,MAAM,IAAI,KAAK,CAAC,4DAA4D,CAAC,CAAC;CACjF;AAED,CAAC,KAAK,IAAI,EAAE;IACR,MAAM,oBAAoB,GAAuC,KAAM;SAClE,IAAI,EAAE;SACN,MAAM,CAAC,MAAM,EAAE;QACZ,OAAO,EAAE,IAAI;QACb,QAAQ,EAAE,wDAAwD;QAClE,IAAI,EAAE,QAAQ;KACjB,CAAC;SACD,MAAM,EAAE,CAAC,IAAI,CAAC;IAEnB,IAAI,oBAAoB,YAAY,OAAO,EAAE;QACzC,MAAM,IAAI,KAAK,CAAC,sEAAsE,CAAC,CAAC;KAC3F;IAED,MAAM,EAAE,IAAI,EAAE,GAAG,oBAAoB,CAAC;IACtC,MAAM,iBAAiB,GAAG,IAAI,GAAG,EAAqC,CAAC;IACvE,MAAM,MAAM,GAAG,IAAI,MAAM,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC;IAEpC,MAAM,CAAC,EAAE,CAAC,YAAY,EAAE,CAAC,UAAU,EAAE,EAAE;QACnC,MAAM,EAAE,GAAG,oBAAoB,CAAC,iBAAiB,CAAC,CAAC;QACnD,MAAM,WAAW,GAAG,CAAC,OAAe,EAAE,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,CAAC;QAElF,iBAAiB,CAAC,GAAG,CAAC,EAAE,EAAE,WAAW,CAAC,CAAC;QAEvC,UAAU,CAAC,EAAE,CAAC,SAAS,EAAE,CAAC,OAAO,EAAE,EAAE;YACjC,MAAM,aAAa,GAAG,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,QAAQ,EAAE,CAAC,CAAC;YAErD,MAAM,6BAA6B,GAAG,iBAAiB,CAAC,GAAG,CAAC,aAAa,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;YAErF,IAAI,6BAA6B,KAAK,SAAS,EAAE;gBAC7C,6BAA6B,CAAC,EAAE,MAAM,EAAE,EAAE,EAAE,EAAE,EAAE,OAAO,EAAE,aAAa,CAAC,OAAO,EAAE,CAAC,CAAC;aACrF;QACL,CAAC,CAAC,CAAC;QAEH,UAAU,CAAC,EAAE,CAAC,OAAO,EAAE,GAAG,EAAE,CAAC,iBAAiB,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,CAAC;QAE3D,KAAK,MAAM,gBAAgB,IAAI,iBAAiB,EAAE;YAC9C,IAAI,gBAAgB,CAAC,CAAC,CAAC,KAAK,EAAE,EAAE;gBAC5B,MAAM,KAAK,GAAG,CAAC,EAAE,EAAE,gBAAgB,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;gBACzD,MAAM,IAAI,GAAG,SAAS,CAAC;gBAEvB,WAAW,CAAC,EAAE,OAAO,EAAE,EAAE,QAAQ,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,EAAE,MAAM,EAAE,EAAE,EAAE,EAAE,gBAAgB,CAAC,CAAC,CAAC,EAAE,EAAE,EAAE,EAAE,IAAI,EAAE,CAAC,CAAC;gBACzG,gBAAgB,CAAC,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,EAAE,QAAQ,EAAE,KAAK,EAAE,IAAI,EAAE,EAAE,MAAM,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,IAAI,EAAE,CAAC,CAAC;aACzF;SACJ;IACL,CAAC,CAAC,CAAC;AACP,CAAC,CAAC,EAAE,CAAC"}

package/build/es2019/interfaces/command-line-arguments.d.ts

@@ -0,0 +1,4 @@
+export interface ICommandLineArguments {
+    port: number;
+}
+//# sourceMappingURL=command-line-arguments.d.ts.map

package/build/es2019/interfaces/command-line-arguments.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"command-line-arguments.d.ts","sourceRoot":"","sources":["../../../src/interfaces/command-line-arguments.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,qBAAqB;IAClC,IAAI,EAAE,MAAM,CAAC;CAChB"}

package/build/es2019/interfaces/command-line-arguments.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=command-line-arguments.js.map

package/build/es2019/interfaces/command-line-arguments.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"command-line-arguments.js","sourceRoot":"","sources":["../../../src/interfaces/command-line-arguments.ts"],"names":[],"mappings":""}

package/build/es2019/interfaces/index.d.ts

@@ -0,0 +1,2 @@
+export * from './command-line-arguments';
+//# sourceMappingURL=index.d.ts.map

package/build/es2019/interfaces/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/interfaces/index.ts"],"names":[],"mappings":"AAAA,cAAc,0BAA0B,CAAC"}

package/build/es2019/interfaces/index.js

@@ -0,0 +1,2 @@
+export * from './command-line-arguments';
+//# sourceMappingURL=index.js.map

package/build/es2019/interfaces/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/interfaces/index.ts"],"names":[],"mappings":"AAAA,cAAc,0BAA0B,CAAC"}

package/build/node/app.js

@@ -0,0 +1,85 @@
+#!/usr/bin/env node
+"use strict";
+
+var _fastUniqueNumbers = require("fast-unique-numbers");
+
+var _ws = require("ws");
+
+var _yargs = _interopRequireDefault(require("yargs"));
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+if (require.main !== module) {
+  throw new Error('This script is meant to be executed from the command line.');
+}
+
+(async () => {
+  const commandLineArguments = _yargs.default.help().option('port', {
+    default: 2276,
+    describe: 'specify the port at which the server will be listening',
+    type: 'number'
+  }).strict().argv;
+
+  if (commandLineArguments instanceof Promise) {
+    throw new Error('The command line arguments are expected to get parsed synchronously.');
+  }
+
+  const {
+    port
+  } = commandLineArguments;
+  const activeConnections = new Map();
+  const server = new _ws.Server({
+    port
+  });
+  server.on('connection', connection => {
+    const id = (0, _fastUniqueNumbers.generateUniqueNumber)(activeConnections);
+
+    const sendMessage = message => connection.send(JSON.stringify(message));
+
+    activeConnections.set(id, sendMessage);
+    connection.on('message', message => {
+      const parsedMessage = JSON.parse(message.toString());
+      const sendMessageToActiveConnection = activeConnections.get(parsedMessage.client.id);
+
+      if (sendMessageToActiveConnection !== undefined) {
+        sendMessageToActiveConnection({
+          client: {
+            id
+          },
+          message: parsedMessage.message
+        });
+      }
+    });
+    connection.on('close', () => activeConnections.delete(id));
+
+    for (const activeConnection of activeConnections) {
+      if (activeConnection[0] !== id) {
+        const label = [id, activeConnection[0]].sort().join('-');
+        const type = 'request';
+        sendMessage({
+          message: {
+            isActive: true,
+            label,
+            mask: {
+              client: {
+                id: activeConnection[0]
+              }
+            }
+          },
+          type
+        });
+        activeConnection[1]({
+          message: {
+            isActive: false,
+            mask: {
+              client: {
+                id
+              }
+            }
+          },
+          type
+        });
+      }
+    }
+  });
+})();

package/build/node/interfaces/command-line-arguments.js

@@ -0,0 +1,5 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});

package/build/node/interfaces/index.js

@@ -0,0 +1,18 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+
+var _commandLineArguments = require("./command-line-arguments");
+
+Object.keys(_commandLineArguments).forEach(function (key) {
+  if (key === "default" || key === "__esModule") return;
+  if (key in exports && exports[key] === _commandLineArguments[key]) return;
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function () {
+      return _commandLineArguments[key];
+    }
+  });
+});

package/package.json

@@ -0,0 +1,81 @@
+{
+    "author": "Christoph Guttandin",
+    "bin": {
+        "timing-provider-server": "./build/node/app.js"
+    },
+    "bugs": {
+        "url": "https://github.com/chrisguttandin/timing-provider-server/issues"
+    },
+    "config": {
+        "commitizen": {
+            "path": "cz-conventional-changelog"
+        }
+    },
+    "dependencies": {
+        "fast-unique-numbers": "^6.0.6",
+        "tslib": "^2.3.1",
+        "typescript": "^4.4.3",
+        "ws": "^8.2.2",
+        "yargs": "^17.1.1"
+    },
+    "description": "A command line tool to spin up a server which can be used with the timing-provider.",
+    "devDependencies": {
+        "@babel/core": "^7.15.5",
+        "@babel/preset-env": "^7.15.6",
+        "@babel/register": "^7.15.3",
+        "@commitlint/cli": "^13.1.0",
+        "@commitlint/config-angular": "^13.1.0",
+        "@types/ws": "^7.4.7",
+        "@types/yargs": "^17.0.2",
+        "chai": "^4.3.4",
+        "commitizen": "^4.2.4",
+        "cz-conventional-changelog": "^3.3.0",
+        "eslint": "^7.32.0",
+        "eslint-config-holy-grail": "^50.1.8",
+        "grunt": "^1.4.1",
+        "grunt-babel": "^8.0.0",
+        "grunt-cli": "^1.4.3",
+        "grunt-contrib-clean": "^2.0.0",
+        "grunt-sh": "^0.2.0",
+        "husky": "^7.0.2",
+        "load-grunt-config": "^4.0.1",
+        "mocha": "^9.1.1",
+        "prettier": "^2.4.1",
+        "pretty-quick": "^3.1.1",
+        "sinon": "^11.1.2",
+        "sinon-chai": "^3.7.0",
+        "tsconfig-holy-grail": "^11.1.12",
+        "tslint": "^6.1.3",
+        "tslint-config-holy-grail": "^53.2.25"
+    },
+    "engines": {
+        "node": ">=12.20.1"
+    },
+    "files": [
+        "build/es2019/",
+        "build/node/",
+        "src/"
+    ],
+    "homepage": "https://github.com/chrisguttandin/timing-provider-server",
+    "keywords": [
+        "Timing Object",
+        "Timing Provider",
+        "synchronisation",
+        "timing",
+        "timingsrc",
+        "webtiming"
+    ],
+    "license": "MIT",
+    "name": "timing-provider-server",
+    "repository": {
+        "type": "git",
+        "url": "https://github.com/chrisguttandin/timing-provider-server.git"
+    },
+    "scripts": {
+        "prepare": "husky install",
+        "prepublishOnly": "grunt build",
+        "start": "node build/node/app.js",
+        "test": "grunt test"
+    },
+    "version": "2.0.13"
+}

package/src/app.ts

@@ -0,0 +1,58 @@
+#!/usr/bin/env node
+
+import { generateUniqueNumber } from 'fast-unique-numbers';
+import { Server } from 'ws';
+import yargs from 'yargs';
+import { ICommandLineArguments } from './interfaces';
+
+if (require.main !== module) {
+    throw new Error('This script is meant to be executed from the command line.');
+}
+
+(async () => {
+    const commandLineArguments = (<yargs.Argv<ICommandLineArguments>>yargs)
+        .help()
+        .option('port', {
+            default: 2276,
+            describe: 'specify the port at which the server will be listening',
+            type: 'number'
+        })
+        .strict().argv;
+
+    if (commandLineArguments instanceof Promise) {
+        throw new Error('The command line arguments are expected to get parsed synchronously.');
+    }
+
+    const { port } = commandLineArguments;
+    const activeConnections = new Map<number, (message: object) => void>();
+    const server = new Server({ port });
+
+    server.on('connection', (connection) => {
+        const id = generateUniqueNumber(activeConnections);
+        const sendMessage = (message: object) => connection.send(JSON.stringify(message));
+
+        activeConnections.set(id, sendMessage);
+
+        connection.on('message', (message) => {
+            const parsedMessage = JSON.parse(message.toString());
+
+            const sendMessageToActiveConnection = activeConnections.get(parsedMessage.client.id);
+
+            if (sendMessageToActiveConnection !== undefined) {
+                sendMessageToActiveConnection({ client: { id }, message: parsedMessage.message });
+            }
+        });
+
+        connection.on('close', () => activeConnections.delete(id));
+
+        for (const activeConnection of activeConnections) {
+            if (activeConnection[0] !== id) {
+                const label = [id, activeConnection[0]].sort().join('-');
+                const type = 'request';
+
+                sendMessage({ message: { isActive: true, label, mask: { client: { id: activeConnection[0] } } }, type });
+                activeConnection[1]({ message: { isActive: false, mask: { client: { id } } }, type });
+            }
+        }
+    });
+})();

package/src/interfaces/command-line-arguments.ts

@@ -0,0 +1,3 @@
+export interface ICommandLineArguments {
+    port: number;
+}

package/src/interfaces/index.ts

@@ -0,0 +1 @@
+export * from './command-line-arguments';

package/src/tsconfig.json

@@ -0,0 +1,3 @@
+{
+    "extends": "tsconfig-holy-grail/src/tsconfig-node"
+}