Merge branch 'master' of https://github.com/OpenHPS/openhps-video

OpenHPS · Nov 29, 2023 · 242fa56 · 242fa56
2 parents 2869a23 + 89d571e
commit 242fa56
Show file tree

Hide file tree

Showing 28 changed files with 9,056 additions and 4,576 deletions.
diff --git a/.eslintrc.js b/.eslintrc.js
@@ -6,7 +6,7 @@ module.exports = {
     },
     "parser": "@typescript-eslint/parser",
     "parserOptions": {
-        "project": "tsconfig.json",
+        "project": "tsconfig/tsconfig.lint.json",
         "sourceType": "module"
     },
     "plugins": [

diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -0,0 +1,20 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: ''
+assignees: 'Maximvdw'
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior. Provide a code example.
+```typescript
+
+```
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml
@@ -8,35 +8,151 @@ on:
   workflow_dispatch:
 
 jobs:
-  build_and_test:
+  build:
+    name: Build
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
-      - name: Build
+      - uses: actions/checkout@v3
+      - name: Load dependency cache
+        uses: actions/cache@v2
+        with:
+          path: |
+            **/node_modules
+          key: ${{ runner.os }}-dependencies-v1-${{ hashFiles('**/package-lock.json') }}
+      - name: Load build cache
+        uses: actions/cache@v2
+        with:
+          path: |
+            **/dist
+          key: ${{ runner.os }}-build-v1-${{ hashFiles('**/package-lock.json') }}-${{ github.run_number }}
+      - name: Installing dependencies
         run: |
           npm install
+      - name: Build
+        run: |
           npm run build
+      - name: Upload web artifacts
+        uses: actions/upload-artifact@v2
+        with:
+          name: web
+          path: |
+            dist/web/*
+            !dist/web/*.txt
+
+  quality:
+    name: Code quality
+    needs: build
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - name: Load dependency cache
+        uses: actions/cache@v2
+        with:
+          path: |
+            **/node_modules
+          key: ${{ runner.os }}-dependencies-v1-${{ hashFiles('**/package-lock.json') }}
       - name: Quality
         run: |
           npm run lint
+
+  test_coverage:
+    name: Unit tests
+    needs: build
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - name: Load dependency cache
+        uses: actions/cache@v2
+        with:
+          path: |
+            **/node_modules
+          key: ${{ runner.os }}-dependencies-v1-${{ hashFiles('**/package-lock.json') }}
+      - name: Load build cache
+        uses: actions/cache@v2
+        with:
+          path: |
+            **/dist
+          key: ${{ runner.os }}-build-v1-${{ hashFiles('**/package-lock.json') }}-${{ github.run_number }}
+      - name: Load test and coverage cache
+        uses: actions/cache@v2
+        with:
+          path: |
+            **/test-results.xml
+            **/coverage
+          key: ${{ runner.os }}-test-v1-${{ hashFiles('**/package-lock.json') }}-${{ github.run_number }}
       - name: Test
         run: |
-          npm run test -- --reporter mocha-junit-reporter
-          npm run cover
-      - name: Publish Web Artifacts
-        uses: actions/upload-artifact@v2
+          npm run cover:ci
+
+  documentation:
+    name: Build documentation
+    needs: build
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - name: Load dependency cache
+        uses: actions/cache@v2
         with:
-          name: web
           path: |
-            dist/web/*
-            !dist/web/*.txt
+            **/node_modules
+          key: ${{ runner.os }}-dependencies-v1-${{ hashFiles('**/package-lock.json') }}
+      - name: Load build cache
+        uses: actions/cache@v2
+        with:
+          path: |
+            **/dist
+          key: ${{ runner.os }}-build-v1-${{ hashFiles('**/package-lock.json') }}-${{ github.run_number }}
+      - name: Load document cache
+        uses: actions/cache@v2
+        with:
+          path: |
+            **/docs/out
+          key: ${{ runner.os }}-docs-v1-${{ hashFiles('**/package-lock.json') }}-${{ github.run_number }}
+      - name: Build documentation
+        run: |
+          npm run build:typedoc
+
+  publish_documentation:
+    name: Publish documentation
+    needs:
+      - documentation
+      - quality
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - name: Load document cache
+        uses: actions/cache@v2
+        with:
+          path: |
+            **/docs/out
+          key: ${{ runner.os }}-docs-v1-${{ hashFiles('**/package-lock.json') }}-${{ github.run_number }}
       - name: Publish Documentation
         uses: actions/upload-artifact@v2
         with:
           name: docs
           path: |
             docs/out/*
-      - name: Publish Unit Test Results
+      - name: Deploy site to GitHub
+        if: github.ref == 'refs/heads/master' && success()
+        uses: peaceiris/actions-gh-pages@v3
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: ./docs/out
+
+  publish_test_coverage:
+    name: Publish unit tests and coverage
+    needs: test_coverage
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - name: Load test and coverage cache
+        uses: actions/cache@v2
+        with:
+          path: |
+            **/test-results.xml
+            **/coverage
+          key: ${{ runner.os }}-test-v1-${{ hashFiles('**/package-lock.json') }}-${{ github.run_number }}
+      - name: Publish unit test results
         uses: EnricoMi/publish-unit-test-result-action@v1
         if: always()
         with:
@@ -46,23 +162,80 @@ jobs:
         with:
           files: coverage/cobertura-coverage.xml
           verbose: true
+
+  release_dev:
+    name: Release DEV
+    needs:
+      - build
+      - quality
+      - test_coverage
+    runs-on: ubuntu-latest
+    if: github.ref == 'refs/heads/dev'
+    steps:
+      - uses: actions/checkout@v3
+      - name: Load dependency cache
+        uses: actions/cache@v2
+        with:
+          path: |
+            **/node_modules
+          key: ${{ runner.os }}-dependencies-v1-${{ hashFiles('**/package-lock.json') }}
+      - name: Load build cache
+        uses: actions/cache@v2
+        with:
+          path: |
+            **/dist
+          key: ${{ runner.os }}-build-v1-${{ hashFiles('**/package-lock.json') }}-${{ github.run_number }}
       - name: Configure Publish
         run: |
           git config --global user.name 'CI'
           git config --global user.email 'ci@openhps.org'
       - name: Bump version development
-        if: github.ref == 'refs/heads/dev'
         run: |
           npm run bump:development
+      - name: Publish to NPM (dev)
+        uses: JS-DevTools/npm-publish@v1
+        with:
+          token: ${{ secrets.NPM_TOKEN }}
+          tag: dev
+      - name: Publish to GitHub
+        if: success()
+        run: |
+          git push
+  
+  release_master:
+    name: Release MASTER
+    needs:
+      - build
+      - quality
+      - test_coverage
+    runs-on: ubuntu-latest
+    if: github.ref == 'refs/heads/master'
+    steps:
+      - uses: actions/checkout@v3
+      - name: Load dependency cache
+        uses: actions/cache@v2
+        with:
+          path: |
+            **/node_modules
+          key: ${{ runner.os }}-dependencies-v1-${{ hashFiles('**/package-lock.json') }}
+      - name: Load build cache
+        uses: actions/cache@v2
+        with:
+          path: |
+            **/dist
+          key: ${{ runner.os }}-build-v1-${{ hashFiles('**/package-lock.json') }}-${{ github.run_number }}
+      - name: Configure Publish
+        run: |
+          git config --global user.name 'CI'
+          git config --global user.email 'ci@openhps.org'
       - name: Bump version release
-        if: github.ref == 'refs/heads/master'
         run: |
           npm run bump:release
-      - name: Publish to NPM
+      - name: Publish to NPM (master)
         uses: JS-DevTools/npm-publish@v1
-        if: github.ref == 'refs/heads/master' || github.ref == 'refs/heads/dev'
         with:
           token: ${{ secrets.NPM_TOKEN }}
+          tag: latest
       - name: Publish to GitHub
         if: success()
         run: |

diff --git a/LICENSE b/LICENSE
@@ -175,7 +175,7 @@
 
    END OF TERMS AND CONDITIONS
 
-   Copyright 2019-2021 Maxim Van de Wynckel & Vrije Universiteit Brussel
+   Copyright 2019-2022 Maxim Van de Wynckel & Vrije Universiteit Brussel
 
    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.

diff --git a/examples/.gitignore b/examples/.gitignore
@@ -0,0 +1,2 @@
+common/*
+!common/.gitkeep
diff --git a/examples/common/.gitkeep b/examples/common/.gitkeep
diff --git a/examples/web/index.html b/examples/web/index.html
@@ -0,0 +1,23 @@
+<!DOCTYPE html>
+<html>
+    <head>
+        <title>@openhps/video - Basic Example</title>
+    </head>
+    <body>
+        <script type="module">
+        import { ModelBuilder, DataSerializer, DataObject } from '../common/openhps-core.es.js';
+        import { CameraObject } from '../common/openhps-video.es.js';
+
+        ModelBuilder.create()
+            .from()
+            .to()
+            .build().then(model => {
+                console.log(model);
+                const abc = new DataObject("test");
+                console.log(abc);
+                const object = new CameraObject("test");
+                console.log(DataSerializer.serialize(object));
+            }).catch(console.error);
+        </script>
+    </body>
+</html>