codecharta-visualization 1.125.0 → 1.127.0

package/LICENSE.md

@@ -1,17 +1,17 @@
-Copyright (c) 2017, MaibornWolff GmbH
+Copyright (c) 2024, MaibornWolff GmbH
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without
 modification, are permitted provided that the following conditions are met:
 
--   Redistributions of source code must retain the above copyright notice,
-    this list of conditions and the following disclaimer.
--   Redistributions in binary form must reproduce the above copyright
-    notice, this list of conditions and the following disclaimer in the
-    documentation and/or other materials provided with the distribution.
--   Neither the name of nor the names of its contributors may be used to
-    endorse or promote products derived from this software without specific
-    prior written permission.
+- Redistributions of source code must retain the above copyright notice,
+  this list of conditions and the following disclaimer.
+- Redistributions in binary form must reproduce the above copyright
+  notice, this list of conditions and the following disclaimer in the
+  documentation and/or other materials provided with the distribution.
+- Neither the name of nor the names of its contributors may be used to
+  endorse or promote products derived from this software without specific
+  prior written permission.
 
 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE

package/README.md

@@ -6,22 +6,22 @@
 
 ## Jump to Section
 
--   [Installation](#installation)
--   [Development Tasks](#tasks)
--   [Testing](#testing)
--   [JSON structure](#json-structure)
--   [License](LICENSE.md)
+- [Installation](#installation)
+- [Development Tasks](#tasks)
+- [Testing](#testing)
+- [JSON structure](#json-structure)
+- [License](LICENSE.md)
 
 # Installation
 
 You can start with **Codecharta Visualization** on multiple ways:
 
--   Installation as a [npm package](#npm-package) (Recommended for users)
--   Run an operating system specific [standalone](#run-a-standalone)
--   Build it yourself from the github [repository](#build-it-yourself) (Development)
--   Use [docker-compose](https://maibornwolff.github.io/codecharta/docs/docker-containers/) to run this with other needed tools like a Sonar instance or analyzing tools of codecharta-analysis.
--   Use our [Dockerfile](#run-in-docker-container) to run the visualization in a container
--   Try out the [online version](https://maibornwolff.github.io/codecharta/visualization/app/index.html?file=codecharta.cc.json&file=codecharta_analysis.cc.json)
+- Installation as a [npm package](#npm-package) (Recommended for users)
+- Run an operating system specific [standalone](#run-a-standalone)
+- Build it yourself from the github [repository](#build-it-yourself) (Development)
+- Use [docker-compose](https://maibornwolff.github.io/codecharta/docs/docker-containers/) to run this with other needed tools like a Sonar instance or analyzing tools of codecharta-analysis.
+- Use our [Dockerfile](#run-in-docker-container) to run the visualization in a container
+- Try out the [online version](https://maibornwolff.github.io/codecharta/visualization/app/index.html?file=codecharta.cc.json&file=codecharta_analysis.cc.json)
 
 > Be aware, that if you are on Apple Silicon, you may run into problems with the standalone and build versions
 
@@ -40,8 +40,8 @@ $ codecharta-visualization
 
 ## Run a standalone
 
--   Download the correct standalone version for your OS from the [latest release page](https://github.com/MaibornWolff/codecharta/releases) under 'Assets'
--   Extract & run the application
+- Download the correct standalone version for your OS from the [latest release page](https://github.com/MaibornWolff/codecharta/releases) under 'Assets'
+- Extract & run the application
 
 ### MacOS
 
@@ -50,8 +50,8 @@ $ codecharta-visualization
 
 > If you are using an M1 or similar (arm64) architectures you might need to do additional steps, because the OS might flag the executable as damaged, if it is downloaded and from an unverified developer:
 
--   Remove the 'downloaded' attributes from the OS:
-    `$ xattr -cr codecharta-visualization.app/`
+- Remove the 'downloaded' attributes from the OS:
+  `$ xattr -cr codecharta-visualization.app/`
 
 ## Build it yourself
 
@@ -161,11 +161,15 @@ We assume that you already installed docker, if not, you have to do that before!
 
 To containerize the visualization, please follow the below listed steps.
 
--   Start the docker container: `docker run -d -p 9000:80 codecharta/codecharta-visualization`. This detaches the container and exposes port 80 on the container and port 9000 on the host.
--   Open `localhost:9000` in your browser and you can already use the visualization, upload `cc.json` files and play around!
+- Start the docker container: `docker run -d -p 9000:80 codecharta/codecharta-visualization`. This detaches the container and exposes port 80 on the container and port 9000 on the host.
+- Open `localhost:9000` in your browser and you can already use the visualization, upload `cc.json` files and play around!
 
 # JSON structure
 
 [Example Data](/visualization/app/codeCharta/assets/sample1.cc.json)
 
 [JSON Schema](/visualization/app/codeCharta/util/generatedSchema.json)
+
+## Code Style
+
+Please check out the [DEV_START_GUIDE](../DEV_START_GUIDE.md).

package/conf/jestE2E.config.json

@@ -1,23 +1,23 @@
 {
-	"collectCoverage": true,
-	"rootDir": "./../",
-	"coverageDirectory": "<rootDir>/dist/coverage",
-	"collectCoverageFrom": ["<rootDir>/app/**/*.ts", "!**/node_modules/**"],
-	"coveragePathIgnorePatterns": ["\\.(spec|e2e|po)\\.ts$", "<rootDir>/app/puppeteer.helper.ts"],
-	"transform": {
-		"\\.(ts|tsx)$": [
-			"ts-jest",
-			{
-				"tsconfig": "tsconfig.spec.json"
-			}
-		],
-		"^.+\\.md$": "<rootDir>/app/codeCharta/util/testUtils/markdown-transformer.js"
-	},
-	"transformIgnorePatterns": ["/node_modules/(?!(three|ngx-color/fesm2020))"],
-	"roots": ["<rootDir>/app"],
-	"testMatch": ["**/*.e2e.ts"],
-	"moduleFileExtensions": ["js", "json", "ts", "mjs"],
-	"moduleDirectories": ["node_modules", "<rootDir>/app"],
-	"preset": "./conf/jestE2E-preset.js",
-	"testTimeout": 60000
+  "collectCoverage": true,
+  "rootDir": "./../",
+  "coverageDirectory": "<rootDir>/dist/coverage",
+  "collectCoverageFrom": ["<rootDir>/app/**/*.ts", "!**/node_modules/**"],
+  "coveragePathIgnorePatterns": ["\\.(spec|e2e|po)\\.ts$", "<rootDir>/app/puppeteer.helper.ts"],
+  "transform": {
+    "\\.(ts|tsx)$": [
+      "ts-jest",
+      {
+        "tsconfig": "tsconfig.spec.json"
+      }
+    ],
+    "^.+\\.md$": "<rootDir>/app/codeCharta/util/testUtils/markdown-transformer.js"
+  },
+  "transformIgnorePatterns": ["/node_modules/(?!(three|ngx-color/fesm2020))"],
+  "roots": ["<rootDir>/app"],
+  "testMatch": ["**/*.e2e.ts"],
+  "moduleFileExtensions": ["js", "json", "ts", "mjs"],
+  "moduleDirectories": ["node_modules", "<rootDir>/app"],
+  "preset": "./conf/jestE2E-preset.js",
+  "testTimeout": 60000
 }

package/conf/jestUnit.config.json

@@ -1,22 +1,22 @@
 {
-	"collectCoverage": true,
-	"rootDir": "./../",
-	"coverageDirectory": "<rootDir>/dist/coverage",
-	"collectCoverageFrom": ["<rootDir>/app/**/*.ts", "!**/node_modules/**"],
-	"coveragePathIgnorePatterns": ["\\.(spec|e2e|po)\\.ts$", "<rootDir>/app/puppeteer.helper.ts"],
-	"preset": "jest-preset-angular",
-	"transform": {
-		"\\.glsl$": "<rootDir>/mocks/fileTransformer.js"
-	},
-	"transformIgnorePatterns": ["/node_modules/(?!(three|ngx-color/fesm2020|.*\\.mjs$))"],
-	"moduleNameMapper": {
-		"\\CHANGELOG.(md)$": "<rootDir>/mocks/changelogMock.js",
-		"^d3$": "<rootDir>/node_modules/d3/dist/d3.min.js"
-	},
-	"roots": ["<rootDir>/app"],
-	"moduleFileExtensions": ["js", "json", "ts", "mjs"],
-	"moduleDirectories": ["node_modules", "<rootDir>/app"],
-	"setupFiles": ["<rootDir>/mocks/localStorageMock.js"],
-	"setupFilesAfterEnv": ["<rootDir>/conf/setupJestUnit.ts", "jest-canvas-mock"],
-	"testEnvironment": "jsdom"
+  "collectCoverage": true,
+  "rootDir": "./../",
+  "coverageDirectory": "<rootDir>/dist/coverage",
+  "collectCoverageFrom": ["<rootDir>/app/**/*.ts", "!**/node_modules/**"],
+  "coveragePathIgnorePatterns": ["\\.(spec|e2e|po)\\.ts$", "<rootDir>/app/puppeteer.helper.ts"],
+  "preset": "jest-preset-angular",
+  "transform": {
+    "\\.glsl$": "<rootDir>/mocks/fileTransformer.js"
+  },
+  "transformIgnorePatterns": ["/node_modules/(?!(three|ngx-color/fesm2020|.*\\.mjs$))"],
+  "moduleNameMapper": {
+    "\\CHANGELOG.(md)$": "<rootDir>/mocks/changelogMock.js",
+    "^d3$": "<rootDir>/node_modules/d3/dist/d3.min.js"
+  },
+  "roots": ["<rootDir>/app"],
+  "moduleFileExtensions": ["js", "json", "ts", "mjs"],
+  "moduleDirectories": ["node_modules", "<rootDir>/app"],
+  "setupFiles": ["<rootDir>/mocks/localStorageMock.js"],
+  "setupFilesAfterEnv": ["<rootDir>/conf/setupJestUnit.ts", "jest-canvas-mock"],
+  "testEnvironment": "jsdom"
 }

package/conf/setupJestUnit.ts

@@ -2,7 +2,7 @@ import "jest-preset-angular/setup-jest"
 
 const numberToLocaleString = Number.prototype.toLocaleString
 Number.prototype.toLocaleString = function (locale = "en-US") {
-	return numberToLocaleString.call(this, locale)
+    return numberToLocaleString.call(this, locale)
 }
 
 window["__TEST_ENVIRONMENT__"] = true

package/conf/webpack.config.js

@@ -1,14 +1,14 @@
 module.exports = config => {
-	config.module.rules.push(
-		{
-			test: /\.glsl$/,
-			use: ["webpack-glsl-loader"]
-		},
-		{
-			test: /\.md$/,
-			type: "asset/source"
-		}
-	)
+    config.module.rules.push(
+        {
+            test: /\.glsl$/,
+            use: ["webpack-glsl-loader"]
+        },
+        {
+            test: /\.md$/,
+            type: "asset/source"
+        }
+    )
 
-	return config
+    return config
 }

package/dist/webpack/3rdpartylicenses.txt

@@ -599,6 +599,32 @@ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 THE SOFTWARE.
 
 
+dijkstrajs
+MIT
+```
+Dijkstra path-finding functions. Adapted from the Dijkstar Python project.
+
+Copyright (C) 2008
+  Wyatt Baldwin <self@wyattbaldwin.com>
+  All rights reserved
+
+Licensed under the MIT license.
+
+  http://www.opensource.org/licenses/mit-license.php
+
+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.
+```
+
+
+encode-utf8
+MIT
+
 fast-deep-equal
 MIT
 MIT License
@@ -649,6 +675,30 @@ 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.
 
 
+fflate
+MIT
+MIT License
+
+Copyright (c) 2023 Arjun Barrett
+
+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.
+
 font-awesome
 (OFL-1.1 AND MIT)
 
@@ -1147,6 +1197,20 @@ The above copyright notice and this permission notice shall be included in all c
 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.
 
 
+qrcode
+MIT
+The MIT License (MIT)
+
+Copyright (c) 2012 Ryan Day
+
+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.
+
+
+
 rxjs
 Apache-2.0
                                Apache License

package/dist/webpack/codeCharta/assets/area_icon_for_3D_print.svg

@@ -0,0 +1 @@
+<svg xmlns="http://www.w3.org/2000/svg" height="16" width="16" viewBox="0 0 512 512"><!--!Font Awesome Free 6.5.1 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free Copyright 2023 Fonticons, Inc.--><path opacity="1" fill="#1E3050" d="M200 32H56C42.7 32 32 42.7 32 56V200c0 9.7 5.8 18.5 14.8 22.2s19.3 1.7 26.2-5.2l40-40 79 79-79 79L73 295c-6.9-6.9-17.2-8.9-26.2-5.2S32 302.3 32 312V456c0 13.3 10.7 24 24 24H200c9.7 0 18.5-5.8 22.2-14.8s1.7-19.3-5.2-26.2l-40-40 79-79 79 79-40 40c-6.9 6.9-8.9 17.2-5.2 26.2s12.5 14.8 22.2 14.8H456c13.3 0 24-10.7 24-24V312c0-9.7-5.8-18.5-14.8-22.2s-19.3-1.7-26.2 5.2l-40 40-79-79 79-79 40 40c6.9 6.9 17.2 8.9 26.2 5.2s14.8-12.5 14.8-22.2V56c0-13.3-10.7-24-24-24H312c-9.7 0-18.5 5.8-22.2 14.8s-1.7 19.3 5.2 26.2l40 40-79 79-79-79 40-40c6.9-6.9 8.9-17.2 5.2-26.2S209.7 32 200 32z"/></svg>

package/dist/webpack/codeCharta/assets/color_icon_for_3D_print.svg

@@ -0,0 +1 @@
+<svg xmlns="http://www.w3.org/2000/svg" height="16" width="18" viewBox="0 0 576 512"><!--!Font Awesome Free 6.5.1 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free Copyright 2023 Fonticons, Inc.--><path opacity="1" fill="#1E3050" d="M339.3 367.1c27.3-3.9 51.9-19.4 67.2-42.9L568.2 74.1c12.6-19.5 9.4-45.3-7.6-61.2S517.7-4.4 499.1 9.6L262.4 187.2c-24 18-38.2 46.1-38.4 76.1L339.3 367.1zm-19.6 25.4l-116-104.4C143.9 290.3 96 339.6 96 400c0 3.9 .2 7.8 .6 11.6C98.4 429.1 86.4 448 68.8 448H64c-17.7 0-32 14.3-32 32s14.3 32 32 32H208c61.9 0 112-50.1 112-112c0-2.5-.1-5-.2-7.5z"/></svg>

package/dist/webpack/codeCharta/assets/height_icon_for_3D_print.svg

@@ -0,0 +1 @@
+<svg xmlns="http://www.w3.org/2000/svg" height="16" width="10" viewBox="0 0 320 512"><!--!Font Awesome Free 6.5.1 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free Copyright 2023 Fonticons, Inc.--><path opacity="1" fill="#1E3050" d="M182.6 9.4c-12.5-12.5-32.8-12.5-45.3 0l-96 96c-12.5 12.5-12.5 32.8 0 45.3s32.8 12.5 45.3 0L128 109.3V402.7L86.6 361.4c-12.5-12.5-32.8-12.5-45.3 0s-12.5 32.8 0 45.3l96 96c12.5 12.5 32.8 12.5 45.3 0l96-96c12.5-12.5 12.5-32.8 0-45.3s-32.8-12.5-45.3 0L192 402.7V109.3l41.4 41.4c12.5 12.5 32.8 12.5 45.3 0s12.5-32.8 0-45.3l-96-96z"/></svg>