sportident.js 1.0.0

package/.dependency-cruiser.js

@@ -0,0 +1,233 @@
+/* global module */
+/* exported module */
+
+const recommendedForbidden = [
+    {
+        name: 'no-circular',
+        severity: 'warn',
+        comment: 'Warn in case there\'s circular dependencies',
+        from: {},
+        to: {
+            circular: true,
+        },
+    },
+    {
+        name: 'no-orphans',
+        severity: 'info',
+        comment: 'Inform in case there\'s orphans hiding in the code base',
+        from: {
+            orphan: true,
+            pathNot: '\\.d\\.ts$',
+        },
+        to: {},
+    },
+    {
+        name: 'no-deprecated-core',
+        comment: 'Warn about dependencies on deprecated core modules.',
+        severity: 'warn',
+        from: {},
+        to: {
+            dependencyTypes: [
+                'core',
+            ],
+            path: '^(punycode|domain|constants|sys|_linklist|_stream_wrap)$',
+        },
+    },
+    {
+        name: 'no-deprecated-npm',
+        comment: 'These npm modules are deprecated - find an alternative.',
+        severity: 'warn',
+        from: {},
+        to: {
+            dependencyTypes: [
+                'deprecated',
+            ],
+        },
+    },
+    {
+        name: 'no-non-package-json',
+        severity: 'error',
+        comment: 'Don\'t allow dependencies to packages not in package.json',
+        from: {},
+        to: {
+            dependencyTypes: [
+                'npm-no-pkg',
+                'npm-unknown',
+            ],
+        },
+    },
+    {
+        name: 'not-to-unresolvable',
+        comment: 'Don\'t allow dependencies on modules dependency-cruiser can\'t resolve to files on disk (which probably means they don\'t exist)',
+        severity: 'error',
+        from: {},
+        to: {
+            couldNotResolve: true,
+        },
+    },
+    // We want this for react stuff
+    // {
+    //     name: 'no-duplicate-dep-types',
+    //     comment: 'Warn if a dependency you\'re actually using occurs in your package.json more than once (technically: has more than one dependency type)',
+    //     severity: 'warn',
+    //     from: {},
+    //     to: {
+    //         moreThanOneDependencyType: true,
+    //     },
+    // },
+];
+
+const customForbidden = [
+    {
+        name: 'not-to-test',
+        comment: 'Don\'t allow dependencies from outside to test files',
+        severity: 'error',
+        from: {
+            pathNot: '\\.test\\.(j|t)sx?$|testUtils\\.(j|t)sx?$|/testUtils/',
+        },
+        to: {
+            path: '\\.test\\.(j|t)sx?$|testUtils\\.(j|t)sx?$|/testUtils/',
+        },
+    },
+    {
+        name: 'not-to-testbench',
+        comment: 'Don\'t allow dependencies from outside to testbench',
+        severity: 'error',
+        from: {
+            pathNot: '^testbench',
+        },
+        to: {
+            path: '^testbench',
+        },
+    },
+    {
+        name: 'not-to-src-si-device-drivers',
+        comment: 'Don\'t allow dependencies from outside to src/SiDevice/drivers',
+        severity: 'error',
+        from: {
+            pathNot: '^(src/SiDevice/)',
+        },
+        to: {
+            path: '^src/SiDevice/drivers',
+        },
+    },
+    {
+        name: 'not-from-testbench-inside-src',
+        comment: 'Don\'t allow dependencies from testbench to src except index.(j|t)s[x]',
+        severity: 'error',
+        from: {
+            path: '^testbench',
+        },
+        to: {
+            path: '^src',
+            pathNot: '^src/index\\.(j|t)sx?',
+        },
+    },
+    {
+        name: 'not-from-utils-outside',
+        comment: 'Don\'t allow dependencies from utils outside utils',
+        severity: 'error',
+        from: {
+            path: '^utils/',
+        },
+        to: {
+            pathNot: '^utils/',
+        },
+    },
+    {
+        name: 'not-to-simulation',
+        comment: 'Don\'t allow dependencies from non-tests to simulation',
+        severity: 'error',
+        from: {
+            pathNot: '\\.test\\.(j|t)sx?$|testUtils\\.(j|t)sx?$|/testUtils/|/simulation/',
+        },
+        to: {
+            path: '^simulation/',
+        },
+    },
+];
+
+module.exports = {
+    forbidden: [
+        ...recommendedForbidden,
+        ...customForbidden,
+    ],
+    options: {
+
+        /* conditions specifying which files not to follow further when encountered:
+           - path: a regular expression to match
+           - dependencyTypes: see https://github.com/sverweij/dependency-cruiser/blob/develop/doc/rules-reference.md#dependencytypes
+             for a complete list
+        */
+        doNotFollow: {
+            // path: 'node_modules',
+            dependencyTypes: [
+                'npm',
+                'npm-dev',
+                'npm-optional',
+                'npm-peer',
+                'npm-bundled',
+                'npm-no-pkg',
+            ],
+        },
+
+        /* pattern specifying which files to exclude (regular expression) */
+        exclude: '\\.min\\.(j|t)sx?$|webpack\\.config\\.(j|t)sx?$',
+
+        /* pattern specifying which files to include (regular expression)
+           dependency-cruiser will skip everything not matching this pattern
+        */
+        // , includeOnly : ''
+
+        /* list of module systems to cruise */
+        // , moduleSystems: ['amd', 'cjs', 'es6', 'tsd']
+
+        /* prefix for links in html and svg output (e.g. https://github.com/you/yourrepo/blob/develop/) */
+        // , prefix: ''
+
+        /* if true detect dependencies that only exist before typescript-to-javascript compilation */
+        // , tsPreCompilationDeps: false
+
+        /* if true combines the package.jsons found from the module up to the base
+           folder the cruise is initiated from. Useful for how (some) mono-repos
+           manage dependencies & dependency definitions.
+         */
+        // , combinedDependencies: false
+
+        /* if true leave symlinks untouched, otherwise use the realpath */
+        // , preserveSymlinks: false
+
+        /* Typescript project file ('tsconfig.json') to use for
+           (1) compilation and
+           (2) resolution (e.g. with the paths property)
+
+           The (optional) fileName attribute specifies which file to take (relative to
+           dependency-cruiser's current working directory). When not provided
+           defaults to './tsconfig.json'.
+         */
+        // , tsConfig: {
+        //    fileName: './tsconfig.json'
+        // }
+
+        /* Webpack configuration to use to get resolve options from.
+
+          The (optional) fileName attribute specifies which file to take (relative to dependency-cruiser's
+          current working directory. When not provided defaults to './webpack.conf.js'.
+
+          The (optional) `env` and `args` attributes contain the parameters to be passed if
+          your webpack config is a function and takes them (see webpack documentation
+          for details)
+         */
+        // , webpackConfig: {
+        //    fileName: './webpack.conf.js'
+        //    , env: {}
+        //    , args: {}
+        // }
+
+        /* How to resolve external modules - use "yarn-pnp" if you're using yarn's Plug'n'Play.
+           otherwise leave it out (or set to the default, which is 'node_modules')
+        */
+        // , externalModuleResolutionStrategy: 'node_modules'
+    },
+};
+// generated: dependency-cruiser@4.21.0 on 2019-06-09T07:26:46.829Z

package/.editorconfig

@@ -0,0 +1,12 @@
+root = true
+
+[*]
+indent_style = space
+indent_size = 4
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+
+[*.{json,yml}]
+indent_size = 2

package/.eslintignore

@@ -0,0 +1,6 @@
+docs/
+coverage/
+node_modules/
+build/
+
+eslint.base.js

package/.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,35 @@
+---
+name: Bug report
+about: Create a report to help us improve
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**Desktop (please complete the following information):**
+ - OS: [e.g. iOS]
+ - Browser [e.g. chrome, safari]
+ - Version [e.g. 22]
+
+**Smartphone (please complete the following information):**
+ - Device: [e.g. iPhone6]
+ - OS: [e.g. iOS8.1]
+ - Browser [e.g. stock browser, safari]
+ - Version [e.g. 22]
+
+**Additional context**
+Add any other context about the problem here.

package/.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,17 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

package/.github/workflows/npm.yml

@@ -0,0 +1,17 @@
+on:
+  push:
+    branches: main
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v3
+        with:
+          node-version: "20"
+      - run: npm ci
+      - run: npm test
+      - uses: JS-DevTools/npm-publish@v3
+        with:
+          token: ${{ secrets.NPM_TOKEN }}

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018 Simon Hatt / 2024 Marcel Würsten
+
+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,31 @@
+# sportident.js
+JavaScript/TypeScript interface to SportIdent devices
+
+There are [generated docs](https://allestuetsmerweh.github.io/sportident.js/).
+
+## How to install
+
+- [Install node.js](https://nodejs.org/en/download/)
+- `git clone` this repository and `cd` to the root directory of it
+- `npm install`
+- `npm run lerna bootstrap`
+
+## How to run testbench
+- `npm run testbench-client`
+- `npm run testbench-server`
+
+## How to run...
+- Tests: `npm run test`
+- Linter: `npm run lint`
+- Build: `npm run build` (this compiles TypeScript for the libraries and builds the webpack file for `sportident-testbench-client`)
+
+## Development
+We use `lerna` to manage multiple packages in the same repository:
+- [sportident](./tree/main/packages/sportident/#readme)
+- [sportident-node-usb](./tree/main/packages/sportident-node-usb/#readme)
+- [sportident-react](./tree/main/packages/sportident-react/#readme)
+- [sportident-testbench-client](./tree/main/packages/sportident-testbench-client/#readme)
+- [sportident-testbench-node](./tree/main/packages/sportident-testbench-node/#readme)
+- [sportident-testbench-server](./tree/main/packages/sportident-testbench-server/#readme)
+- [sportident-testbench-shell](./tree/main/packages/sportident-testbench-shell/#readme)
+- [sportident-webusb](./tree/main/packages/sportident-webusb/#readme)

package/babel.config.js

@@ -0,0 +1,21 @@
+/* global module */
+/* exported module */
+
+module.exports = (api) => {
+    api.cache(true);
+
+    const presets = [
+        ['@babel/typescript'],
+        ['@babel/preset-env', {useBuiltIns: 'usage', corejs: '2'}],
+        ['@babel/preset-react'],
+    ];
+    const plugins = [
+        '@babel/proposal-class-properties',
+        '@babel/proposal-object-rest-spread'
+    ];
+
+    return {
+        presets: presets,
+        plugins: plugins,
+    };
+};

package/build-docs.sh

@@ -0,0 +1,25 @@
+# Assumes the following commands have been run:
+# - npm run webpack-testbench
+# - npm run jest
+
+set -e
+
+mkdir -p docs/.circleci
+cp .circleci/config.yml docs/.circleci/
+
+mkdir -p docs/testbench
+cp packages/sportident-testbench-client/build/sportident-testbench-client.min.js docs/testbench/
+cp packages/sportident-testbench-client/build/index.html docs/testbench/
+
+mkdir -p docs/coverage
+cp -R coverage/* docs/coverage/
+
+mkdir -p docs/generated
+npx depcruise --config=./.dependency-cruiser.js --max-depth=1 --output-type=dot packages/sportident/src | dot -T svg > docs/generated/dependencygraph-src.svg
+npx depcruise --config=./.dependency-cruiser.js --max-depth=1 --output-type=dot packages/sportident/src/SiCard | dot -T svg > docs/generated/dependencygraph-src-sicard.svg
+npx depcruise --config=./.dependency-cruiser.js --max-depth=1 --output-type=dot packages/sportident/src/SiDevice | dot -T svg > docs/generated/dependencygraph-src-sidevice.svg
+npx depcruise --config=./.dependency-cruiser.js --max-depth=1 --output-type=dot packages/sportident/src/SiStation | dot -T svg > docs/generated/dependencygraph-src-sistation.svg
+npx depcruise --config=./.dependency-cruiser.js --max-depth=1 --output-type=dot packages/sportident/src/utils | dot -T svg > docs/generated/dependencygraph-src-utils.svg
+npx depcruise --config=./.dependency-cruiser.js --max-depth=1 --output-type=dot packages/sportident-testbench-client/src | dot -T svg > docs/generated/dependencygraph-testbench.svg
+
+lerna run typedoc

package/docs/index.md

@@ -0,0 +1,9 @@
+There is an [online testbench](./testbench/).
+
+There is a [test coverage report](./coverage/lcov-report/index.html).
+
+These are the current `src` dependencies:
+![src dependency graph](./generated/dependencygraph-src.svg "src dependency graph")
+
+These are the current `testbench` dependencies:
+![testbench dependency graph](./generated/dependencygraph-testbench.svg "testbench dependency graph")

package/docs/typedoc/index.md

@@ -0,0 +1,11 @@
+# Typedoc API docs
+
+[`sportident`](./sportident/)
+
+[`sportident-node-usb`](./sportident-node-usb/)
+
+[`sportident-react`](./sportident-react/)
+
+[`sportident-testbench-shell`](./sportident-testbench-shell/)
+
+[`sportident-webusb`](./sportident-webusb/)

package/eslint.base.js

@@ -0,0 +1,232 @@
+const javaScriptRules = {
+    'indent': ['warn', 4, { 'SwitchCase': 1 }],
+    'semi': ['error', 'always'],
+    'no-console': [0],
+    'array-bracket-spacing': ['error', 'never'],
+    'array-bracket-newline': ['error', 'consistent'],
+    'arrow-body-style': ['error', 'as-needed'],
+    'arrow-parens': ['error', 'always'],
+    'arrow-spacing': 'error',
+    'block-scoped-var': 'error',
+    'block-spacing': 'error',
+    'brace-style': ['error', '1tbs', { 'allowSingleLine': true }],
+    'comma-dangle': ['error', { 'arrays': 'always-multiline', 'objects': 'always-multiline', 'imports': 'always-multiline', 'exports': 'always-multiline', 'functions': 'always-multiline' }],
+    'comma-spacing': ['error', { 'before': false, 'after': true }],
+    'comma-style': ['error', 'last'],
+    'computed-property-spacing': ['error', 'never'],
+    'consistent-return': 'error',
+    'curly': ['error', 'all'],
+    'default-case': 'error',
+    'dot-location': ['error', 'property'],
+    'dot-notation': 'error',
+    'eol-last': ['error', 'always'],
+    'eqeqeq': ['error', 'always'],
+    'for-direction': 'warn',
+    'func-call-spacing': ['error', 'never'],
+    'func-name-matching': 'warn',
+    'func-names': ['error', 'always'],
+    'func-style': ['error', 'declaration', { 'allowArrowFunctions': true }],
+    'function-paren-newline': ['error', 'consistent'],
+    'generator-star-spacing': ['error', { 'before': false, 'after': true }],
+    'getter-return': 'error',
+    'guard-for-in': 'warn',
+    'key-spacing': ['error', { 'beforeColon': false, 'afterColon': true }],
+    'keyword-spacing': 'error',
+    'linebreak-style': ['error', 'unix'],
+    'lines-around-directive': 'error',
+    'lines-between-class-members': ['error', 'always', { exceptAfterSingleLine: true }],
+    'no-alert': 'error',
+    'no-array-constructor': 'error',
+    'no-await-in-loop': 'error',
+    'no-buffer-constructor': 'error',
+    'no-caller': 'error',
+    'no-confusing-arrow': ['error', { 'allowParens': true }],
+    'no-continue': 'error',
+    'no-duplicate-imports': 'error',
+    'no-else-return': 'error',
+    'no-empty-function': 'off',
+    'no-eval': 'error',
+    'no-extend-native': 'error',
+    'no-floating-decimal': 'error',
+    'no-implied-eval': 'error',
+    'no-invalid-this': 'error',
+    'no-labels': 'error',
+    'no-lone-blocks': 'error',
+    'no-lonely-if': 'error',
+    'no-multi-assign': 'error',
+    'no-multi-spaces': 'error',
+    'no-multiple-empty-lines': 'error',
+    'no-native-reassign': 'error',
+    'no-negated-in-lhs': 'error',
+    'no-new-func': 'error',
+    'no-new-require': 'error',
+    'no-octal-escape': 'error',
+    'no-param-reassign': 'error',
+    'no-proto': 'error',
+    'no-return-assign': 'error',
+    'no-return-await': 'error',
+    'no-script-url': 'error',
+    'no-self-compare': 'error',
+    'no-sequences': 'error',
+    'no-shadow-restricted-names': 'error',
+    'no-spaced-func': 'error',
+    'no-tabs': 'error',
+    'no-template-curly-in-string': 'error',
+    'no-throw-literal': 'error',
+    'no-trailing-spaces': 'error',
+    'no-unneeded-ternary': 'error',
+    'no-unused-expressions': 'error',
+    'no-unused-vars': ['error', {'args': 'none'}],
+    'no-use-before-define': 'off',
+    'no-useless-concat': 'error',
+    'no-useless-constructor': 'error',
+    'no-useless-rename': 'error',
+    'no-useless-return': 'error',
+    'no-var': 'error',
+    'no-warning-comments': 'warn',
+    'no-whitespace-before-property': 'error',
+    'no-with': 'error',
+    'object-curly-newline': ['error', { 'consistent': true }],
+    'prefer-const': 'error',
+    'prefer-numeric-literals': 'error',
+    'prefer-promise-reject-errors': 'error',
+    'prefer-rest-params': 'error',
+    'prefer-template': 'error',
+    'quotes': ['error', 'single'],
+    'radix': 'error',
+    'rest-spread-spacing': 'error',
+    'semi-spacing': 'error',
+    'space-before-blocks': 'error',
+    'space-infix-ops': 'error',
+    'space-unary-ops': ['error', { 'words': true, 'nonwords': false }],
+    'spaced-comment': ['error', 'always', { 'block': { 'balanced': true } }],
+    'symbol-description': 'error',
+    'template-curly-spacing': 'error',
+    'wrap-iife': 'error',
+};
+
+const typeScriptRules = {
+    ...javaScriptRules,
+    '@typescript-eslint/ban-ts-comment': 'off',
+    '@typescript-eslint/ban-ts-ignore': 'off',
+    '@typescript-eslint/explicit-function-return-type': 'off',
+    '@typescript-eslint/explicit-module-boundary-types': 'error',
+    '@typescript-eslint/interface-name-prefix': 'off',
+    '@typescript-eslint/member-delimiter-style': 'off',
+    '@typescript-eslint/no-empty-function': 'off',
+    '@typescript-eslint/no-explicit-any': 'off',
+    '@typescript-eslint/no-non-null-assertion': 'off',
+    '@typescript-eslint/no-unused-vars': ['error', {
+        'vars': 'all',
+        'args': 'all',
+        'ignoreRestSiblings': true,
+        'argsIgnorePattern': '^_',
+        'varsIgnorePattern': '^_',
+    }],
+    '@typescript-eslint/no-shadow': ['error'],
+    '@typescript-eslint/no-use-before-define': ['error', {'classes': false, 'functions': false}],
+    '@typescript-eslint/no-useless-constructor': ['error'],
+    'no-shadow': 'off',
+    'no-unused-vars': 'off',
+    'no-useless-constructor': 'off',
+};
+
+module.exports = {
+    frontendConfig: {
+        env: {
+            browser: true,
+            es6: true,
+        },
+        extends: [
+            'eslint:recommended',
+            'plugin:react/recommended',
+        ],
+        parserOptions: {
+            ecmaVersion: 2018,
+            ecmaFeatures: {
+                jsx: true,
+            },
+            sourceType: 'module',
+        },
+        plugins: [
+            'react',
+        ],
+        settings: {
+            react: {
+                createClass: 'createReactClass',
+                pragma: 'React',
+                version: 'detect',
+                flowVersion: '0.53',
+            },
+            propWrapperFunctions: [
+                'forbidExtraProps',
+                { property: 'freeze', object: 'Object' },
+                { property: 'myFavoriteWrapper' },
+            ],
+            linkComponents: [
+                'Hyperlink',
+                { name: 'Link', linkAttribute: 'to' },
+            ],
+        },
+        rules: javaScriptRules,
+        overrides: [
+            {
+                files: ['**/*.ts', '**/*.tsx'],
+                env: {
+                    browser: true,
+                    es6: true,
+                },
+                extends: [
+                    'eslint:recommended',
+                    'plugin:react/recommended',
+                    'plugin:@typescript-eslint/eslint-recommended',
+                    'plugin:@typescript-eslint/recommended',
+                ],
+                globals: { 'Atomics': 'readonly', 'SharedArrayBuffer': 'readonly' },
+                parser: '@typescript-eslint/parser',
+                parserOptions: {
+                    'ecmaVersion': 2018,
+                    'sourceType': 'module',
+                },
+                plugins: ['@typescript-eslint'],
+                rules: typeScriptRules,
+            },
+        ],
+    },
+    nodeConfig: {
+        env: {
+            node: true,
+            es6: true,
+        },
+        extends: [
+            'eslint:recommended',
+        ],
+        parserOptions: {
+            ecmaVersion: 2018,
+            sourceType: 'module',
+        },
+        rules: javaScriptRules,
+        overrides: [
+            {
+                files: ['**/*.ts', '**/*.tsx'],
+                env: {
+                    browser: true,
+                    es6: true,
+                },
+                extends: [
+                    'eslint:recommended',
+                    'plugin:@typescript-eslint/eslint-recommended',
+                    'plugin:@typescript-eslint/recommended',
+                ],
+                globals: { 'Atomics': 'readonly', 'SharedArrayBuffer': 'readonly' },
+                parser: '@typescript-eslint/parser',
+                parserOptions: {
+                    'ecmaVersion': 2018,
+                    'sourceType': 'module',
+                },
+                plugins: ['@typescript-eslint'],
+                rules: typeScriptRules,
+            },
+        ],
+    },
+};