Major 2.0 (#63)

* refactor: make applyMixins return the correctly typed class constructor.

* Change to esnext build.

* Refined mixins.

* Made ci pipeline run for every pr.

* Fixed AR capabilities.

* Renamed enums.

* Reduced AR Quick Look logic.

* Added converter, loader and exporter.

* Reorganized exporter types.

* Reworked AR Quick Look.

* Reworked ARQuickLook futher and adjusted AR accordingly.

* Reworked Scene Viewer.

* Refined Info types.

* Renamed all AR related systems.

* Fixed tests to use new Loader.

* Reworked AR Quick Look launch.

* Reworked Scene Viewer launch.

* Added more inline documentation.

* Export ARSystem correctly.

* Added USDZLoader mock.

* Fixed Converter types.

* Reworked types.

* Added tests for Exporter.

* Added tests for Loader.

* Reworked loaders.

* Refined error handling in ARSystem.

* Renamed files.

* Reworked error handling.

* Removed logs.

* Renamed methods.

* Prefixed classes with Asset to give more structure.

* Reworked AssetConverter methods.

* Improved on natural Promise rejection.

* Improved Scene Viewer test.

* Fixed getIsARCapable method.

* Added first version of State.

* Added dynamic dependencies to Actions.

* Changed property order.

* Added first version of ModuleRegistry.

* Renamed files.

* Fixed tests.

* Exclude ARSystem from global export.

* Removed unnecessary test.

* Renamed file, added test.

* Renamed export.

* Moved modules to own folder.

* Reworked ModuleRegistry.

* Improved error handling.

* Rearranged code.

* Renamed test describes.

* Refined build script to catch all module registrations.

* Moved files.

* Reworked module exports in package.json.

* Modified readme template to contain build process and yalc as local development environment.

* Updated readme template.

* Fixed Math naming.

* Created centralized module registrations (in modules/indes.ts).

* New build process approach.

* Improved ModuleRegistry workflow.

* Added relative paths to module registry.

* Fixed pipeline.

* Exposed dive instance modules.

* Updated readme template.

* Updated module documentation.

* Added module documentation to README.

* Automated module documentation.

* Fixed pipeline.

* Revert "Changed property order."

This reverts commit 40c7d13.

* Revert "Added dynamic dependencies to Actions."

This reverts commit 5a6bbd4.

* Revert "Added first version of State."

This reverts commit b2006ff.

* Fixed pipeline.

* Reworked module build process.

* Fixed paths.

* Fixed export.

* Reworked module types.

* Reworked documentation generation.

* Fixed pipeline.

* Moved ci script file.

* Renamed Modules to ModuleRegistry.

* Removed docs from npm package due to file size.

* Fixed build.

* Reworked ModuleRegistry to only deliver classes.

* Change package.json to export ModuleRegistry only.

* Added modules build path.

* Added more documentation.

* Removed ModuleRegistry to just use Importer on it's own.

* Reworked build process to dynamically rewrite imports.

* Added automatic instantiation as a method to ModuleImporter.

* Updated docs.

* Defined engine.

* Correctly autostart the renderer.

* Reworked QuickView to be async (wait for loading model).

* Fixed tests.

* Reactivated test.

* Moved all scene components to seperate folder.

* Moved src code to a more sturctured way.

* Added index.ts files for logical groups.

* Raised test coverage.

* Fixed irrelevant webxr files.

* Fixed tests.

* Merge pull request #65 from shopware/refactor/module-registry

Refactor: Modules

* Added build path helper.

* Fixed Resize manager.

* Fixed view calculation.

* Fixed tests.

* Reworked Renderer.

* Fixed build path.

* Changed renderer name.

* Refactor: Engine (#81)

* Added first version of State.

* Added dynamic dependencies to Actions.

* Changed property order.

* Added first version of ModuleRegistry.

* Renamed files.

* Fixed tests.

* Exclude ARSystem from global export.

* Removed unnecessary test.

* Renamed file, added test.

* Renamed export.

* Moved modules to own folder.

* Reworked ModuleRegistry.

* Improved error handling.

* Rearranged code.

* Renamed test describes.

* Refined build script to catch all module registrations.

* Moved files.

* Reworked module exports in package.json.

* Modified readme template to contain build process and yalc as local development environment.

* Updated readme template.

* Fixed Math naming.

* Created centralized module registrations (in modules/indes.ts).

* New build process approach.

* Improved ModuleRegistry workflow.

* Added relative paths to module registry.

* Fixed pipeline.

* Exposed dive instance modules.

* Updated readme template.

* Updated module documentation.

* Added module documentation to README.

* Automated module documentation.

* Fixed pipeline.

* Revert "Changed property order."

This reverts commit 40c7d13.

* Revert "Added dynamic dependencies to Actions."

This reverts commit 5a6bbd4.

* Revert "Added first version of State."

This reverts commit b2006ff.

* Fixed pipeline.

* Reworked module build process.

* Fixed paths.

* Fixed export.

* Reworked module types.

* Reworked documentation generation.

* Fixed pipeline.

* Moved ci script file.

* Renamed Modules to ModuleRegistry.

* Removed docs from npm package due to file size.

* Fixed build.

* Reworked ModuleRegistry to only deliver classes.

* Change package.json to export ModuleRegistry only.

* Added modules build path.

* Added more documentation.

* Removed ModuleRegistry to just use Importer on it's own.

* Reworked build process to dynamically rewrite imports.

* Added automatic instantiation as a method to ModuleImporter.

* Updated docs.

* Defined engine.

* Correctly autostart the renderer.

* Reworked QuickView to be async (wait for loading model).

* Fixed tests.

* Reactivated test.

* Moved all scene components to seperate folder.

* Moved src code to a more sturctured way.

* Added index.ts files for logical groups.

* Raised test coverage.

* Fixed irrelevant webxr files.

* Fixed tests.

* Added build path helper.

* Fixed Resize manager.

* Fixed view calculation.

* Fixed tests.

* Reworked Renderer.

* Fixed build path.

* Changed renderer name.

* Reworked Renderer.

* Changed renderer name to renderPipeline.

* Added new Action factory.

* Clean implementation of types.

* Implemented ComputeEncompassingViewAction.

* Rewrote actions to use new Action.define factory.

* Added tests to rewrote actions.

* Renamed Communication to State.

* Added build path helper.

* Added Action registry.

* Removed lint:actions script because linting resolves in TS now.

* Fixed tests.

* Fixed merge issues.

* Implemented ComputeEncompassingViewAction.

* Rewrote actions to use new Action.define factory.

* Renamed Communication to State.

* Added Animator for convinient animating.

* Added OrbitController refactoring (wip).

* Fixed tests.

* Renamed methods.

* Renamed methods, made Toolbox Module.

* Added canvas as a setting to QuickView.

* Refactor: State (#82)

* Added first version of State.

* Added dynamic dependencies to Actions.

* Changed property order.

* Added first version of ModuleRegistry.

* Renamed files.

* Fixed tests.

* Exclude ARSystem from global export.

* Removed unnecessary test.

* Renamed file, added test.

* Renamed export.

* Moved modules to own folder.

* Reworked ModuleRegistry.

* Improved error handling.

* Rearranged code.

* Renamed test describes.

* Refined build script to catch all module registrations.

* Moved files.

* Reworked module exports in package.json.

* Modified readme template to contain build process and yalc as local development environment.

* Updated readme template.

* Fixed Math naming.

* Created centralized module registrations (in modules/indes.ts).

* New build process approach.

* Improved ModuleRegistry workflow.

* Added relative paths to module registry.

* Fixed pipeline.

* Exposed dive instance modules.

* Updated readme template.

* Updated module documentation.

* Added module documentation to README.

* Automated module documentation.

* Fixed pipeline.

* Revert "Changed property order."

This reverts commit 40c7d13.

* Revert "Added dynamic dependencies to Actions."

This reverts commit 5a6bbd4.

* Revert "Added first version of State."

This reverts commit b2006ff.

* Fixed pipeline.

* Reworked module build process.

* Fixed paths.

* Fixed export.

* Reworked module types.

* Reworked documentation generation.

* Fixed pipeline.

* Moved ci script file.

* Renamed Modules to ModuleRegistry.

* Removed docs from npm package due to file size.

* Fixed build.

* Reworked ModuleRegistry to only deliver classes.

* Change package.json to export ModuleRegistry only.

* Added modules build path.

* Added more documentation.

* Removed ModuleRegistry to just use Importer on it's own.

* Reworked build process to dynamically rewrite imports.

* Added automatic instantiation as a method to ModuleImporter.

* Updated docs.

* Defined engine.

* Correctly autostart the renderer.

* Reworked QuickView to be async (wait for loading model).

* Fixed tests.

* Reactivated test.

* Moved all scene components to seperate folder.

* Moved src code to a more sturctured way.

* Added index.ts files for logical groups.

* Raised test coverage.

* Fixed irrelevant webxr files.

* Fixed tests.

* Added build path helper.

* Fixed Resize manager.

* Fixed view calculation.

* Fixed tests.

* Reworked Renderer.

* Fixed build path.

* Changed renderer name.

* Reworked Renderer.

* Changed renderer name to renderPipeline.

* Added new Action factory.

* Clean implementation of types.

* Implemented ComputeEncompassingViewAction.

* Rewrote actions to use new Action.define factory.

* Added tests to rewrote actions.

* Renamed Communication to State.

* Added build path helper.

* Added Action registry.

* Removed lint:actions script because linting resolves in TS now.

* Fixed tests.

* Fixed merge issues.

* Implemented ComputeEncompassingViewAction.

* Rewrote actions to use new Action.define factory.

* Renamed Communication to State.

* Added Animator for convinient animating.

* Added OrbitController refactoring (wip).

* Fixed tests.

* Renamed methods.

* Renamed methods, made Toolbox Module.

* Added canvas as a setting to QuickView.

* Modules rework (wip).

* Switched from jest to vitest.

* Fixed testing setup.

* Renamed entry file.

* Fixed tests.

* Added tsx for .ts execution.

* Added DRACO support locally.

* Reworked objects data flow.

* Fixed tests.

* Fixed TS issue.

* Update project config to correctly handle draco files.

* Reworked Draco Loader implementation.

* Fixed import of draco lib.

* Added class exports instead of types.

* Fixed applyMixin helper.

* Fixed instance referencing.

* Fixed floor visibility.

* Added instance unregistering.

* Removed mixin to fix interface issue.

* Expose engine and interface types.

* Fixed AnimationSystem test mock error.

* Fixed import in action.

* Improved error handling for AR.

* Moved event system out of modules.

* Added new module definition method via index.ts files.

* Fixed shadow map.

* Fixed tests.

* Added plugin structure to existing animation system.

* Added postinstall to install node_modules for plugins.

* Made imports more slim.

* Made SystemInfo a decoupled plugin.

* Made asset handlers decoupled plugins.

* Fixed vitest setup

* Added names to plugins.

* Made AxisCamera a plugin.

* Fixed media creator plugin.

* Moved remaining modules to plugin architecture.

* Fixed tests

* Add docu to vite config.

* Removed ModuleRegistry overhead.

* Moved required types from state plugin to core.

* Rebundled types.

* Fixed README for animation system.

* Added README for ar.

* Improved README for animation.

* Added README to assetconverter.

* Added README to axiscamera.

* Added README to mediacreator.

* Added README to orbitcontroller.

* Added README to state.

* Added README to systeminfo.

* Added README to toolbox.

* Renamed modules folder to plugins.

* Fixed ar plugin structure.

* Added README to assetexporter.

* Added README to assetloader.

* Fixed build step.

* Removed old docu.

* Cleaned up last imports.

* Deleted old types.

* Added robust install script.

* Prettier fix.

* Removed temporarily broken docs generation from ci script.

* Fixed remaining mocks.

* Renamed build script.

* Changed github workflows to cache plugins node_modules as well.

* Moved deps to root.

* Revert "Changed github workflows to cache plugins node_modules as well."

This reverts commit cf8d225.

* Refined error class types.

* Added user-story template for github.

* Introduced new error type. Correctly export error files.

* Removed duplicate test file.

* Added lockcamera action test.

* Exlude barrel exports from coverage report.

* Added test for type guards.

* Added testing for EventExecutor class.

* Renamed and extended the EventExecutor class to EventDispatcher.

* Added AssetCache plugin.

* Improved async test behaviour.

* Improved test coverage on TransformTool.

* Added more tests.

* Reworked encompassing view calculation.

* Renamed pipelines.

* Refactored Orientation Display.

* Added BoundingBox tests.

* Added export.

Author: feliopterix

.github/ISSUE_TEMPLATE/bug_report.yaml

@@ -1,7 +1,8 @@
-name: 🐞 Bug
+name: Bug Report
 description: File a bug/issue
 title: '[BUG] '
-labels: [bug]
+type: Bug
+labels: [bug, service/shopping-experience]
 body:
     - type: checkboxes
       attributes:

.github/ISSUE_TEMPLATE/feature_request.yml

@@ -0,0 +1,28 @@
+name: User Story
+description: Use this template to draft user stories.
+type: Story
+labels: [enhancement, service/shopping-experience]
+body:
+    - type: textarea
+      id: description
+      attributes:
+          label: Description
+          description: One-line description of what the story involves.
+      validations:
+          required: true
+    - type: textarea
+      id: acceptance-criteria
+      attributes:
+          label: Acceptance criteria
+          description: Please add acceptance criteria to the story. If some of the topics are not applicable, please remove them. (e.g. if not directly related to shopware, remove the Shopware Functionality topic)
+          value: |
+              DIVE Functionality:
+              - [ ]
+              Shopware Functionality:
+              - [ ]
+              Integration:
+              - [ ] All of the above changes are available on (shopware/)showpare->trunk.
+              Testing:
+              - [ ] All of the above changes are unit-tested completely.
+      validations:
+          required: true

.github/ISSUE_TEMPLATE/user_story.yaml

@@ -1,8 +1,7 @@
-name: 'CI'
+name: 'CI Pull Request'
 
 on:
     pull_request:
-        branches: ['trunk']
 
 jobs:
     install:
@@ -93,26 +92,9 @@ jobs:
               run: yarn
             - name: Build DIVE
               run: yarn build
-    lint-actions:
-        runs-on: ubuntu-latest
-        needs: install
-        steps:
-            - name: Checkout
-              uses: actions/checkout@main
-            - name: Search for cached dependencies
-              uses: actions/cache@main
-              id: yarn-cache
-              with:
-                  path: node_modules
-                  key: node-modules-${{ runner.os }}-${{ hashFiles('yarn.lock') }}
-            - name: Install dependencies (if cache not found)
-              if: steps.yarn-cache.outputs.cache-hit != 'true'
-              run: yarn
-            - name: Run lint-actions
-              run: bash ci/lint/lint-actions.sh
     publish-dry-run:
         runs-on: ubuntu-latest
-        needs: [unit, eslint, build, prettier-check, lint-actions]
+        needs: [unit, eslint, build, prettier-check]
         steps:
             - name: Checkout
               uses: actions/checkout@main

.github/workflows/ci.yml .github/workflows/ci-pull-request.yml.github/workflows/ci.yml renamed to .github/workflows/ci-pull-request.yml

@@ -1,4 +1,4 @@
-name: Beta Release
+name: 'Publish Beta Manually'
 
 on:
     workflow_dispatch: # This allows manual triggering only from the Actions tab
@@ -114,7 +114,7 @@ jobs:
                   next_version="$major.$minor.$next_patch"
 
                   # Find all beta branches matching the pattern
-                  prefix="beta/v$next_version-beta"
+                  prefix="beta/$next_version-beta"
                   last_beta=$(git branch -r | grep "origin/$prefix" | awk -F '-' '{print $NF}' | sort -n | tail -n 1)
 
                   if [ -z "$last_beta" ]; then
@@ -135,25 +135,25 @@ jobs:
 
             - name: Create beta branch
               run: |
-                  git checkout -b beta/v${{ env.next_beta }}
+                  git checkout -b beta/${{ env.next_beta }}
 
             - name: Build DIVE
               run: yarn build
 
             - name: Add build files
-              run: git add ./build -f
+              run: git add ./build -f && git add package.json
 
             - name: Commit changes
               run: |
-                  git commit -m "Beta v$(node -p "require('./package.json').version")"
+                  git commit -m "Beta $(node -p "require('./package.json').version")"
 
             - name: Create tag
               run: |
-                  git tag -a v$(node -p "require('./package.json').version") -m "Beta v$(node -p "require('./package.json').version")"
+                  git tag -a $(node -p "require('./package.json').version") -m "Beta v$(node -p "require('./package.json').version")"
 
             - name: Push changes
               run: |
-                  git push origin beta/v$(node -p "require('./package.json').version") --follow-tags
+                  git push origin beta/$(node -p "require('./package.json').version") --follow-tags
 
             - name: Authenticate with NPM
               env:

.github/workflows/publish-beta.yml …thub/workflows/publish-beta-manually.yml.github/workflows/publish-beta.yml renamed to .github/workflows/publish-beta-manually.yml .github/workflows/publish-beta.yml renamed to .github/workflows/publish-beta-manually.yml

@@ -1,4 +1,4 @@
-name: 'Publish to npm'
+name: 'Publish on Merge'
 
 on:
     push:
@@ -97,11 +97,17 @@ jobs:
               if: steps.yarn-cache.outputs.cache-hit != 'true'
               run: yarn
 
-            - name: Generate README.md
-              run: yarn generate-readme
+            - name: Build DIVE
+              run: yarn build
+
+            - name: 'Add package.json to git'
+              run: git add package.json
+
+            - name: Generate docs
+              run: yarn docs
 
-            - name: 'Add README file to git'
-              run: git add README.md -f
+            - name: 'Add docs folder to git'
+              run: git add git add docs -f
 
             - name: 'Automated Version Bump'
               uses: 'phips28/gh-action-bump-version@master'
@@ -126,8 +132,7 @@ jobs:
 
             - name: 'Create release branch'
               run: git checkout -b release/v$(node -p "require('./package.json').version")
-            - name: Build DIVE
-              run: yarn build
+
             - name: 'Add Build files to git'
               run: git add ./build -f && echo "Staged build files! Status:" && git status
             - name: 'Commit changes'

.github/workflows/publish-to-npm.yml .github/workflows/publish-on-merge.yml.github/workflows/publish-to-npm.yml renamed to .github/workflows/publish-on-merge.yml

@@ -89,7 +89,7 @@ out
 
 # Nuxt.js build / generate output
 .nuxt
-build
+/build
 
 # Gatsby files
 .cache/

.gitignore

@@ -0,0 +1,7 @@
+docs/
+README.md
+assets/
+ci/
+tests/
+*.test.ts
+*.spec.ts

.npmignore

@@ -1,5 +1,6 @@
-tsconfig.json
-
 PULL_REQUEST_TEMPLATE.md
 
-.vscode
+*.md
+.vscode
+
+*.js

.prettierignore

@@ -11,5 +11,16 @@
     "endOfLine": "lf",
     "plugins": [
         "prettier-plugin-multiline-arrays"
+    ],
+    "overrides": [
+        {
+            "files": "*.md",
+            "options": {
+                "proseWrap": "always",
+                "printWidth": 100,
+                "tabWidth": 2,
+                "embeddedLanguageFormatting": "off"
+            }
+        }
     ]
 }