From 6008e96c62e6f249e6b360e0597ba4edf49c9eb8 Mon Sep 17 00:00:00 2001 From: Ralf Aron Date: Tue, 16 Jan 2024 13:52:57 +0100 Subject: [PATCH] prettier enabled --- .eslintrc.json | 64 +--- .prettierignore | 9 + .prettierrc.json | 17 + .vscode/settings.json | 5 +- package-lock.json | 354 ++++++++++-------- package.json | 8 +- projects/aas-lib/.eslintrc.json | 88 +++-- projects/aas-lib/src/lib/aas-lib.module.ts | 10 +- .../src/lib/aas-table/aas-table.actions.ts | 30 +- .../src/lib/aas-table/aas-table.component.ts | 46 ++- .../src/lib/aas-table/aas-table.effects.ts | 52 ++- .../src/lib/aas-table/aas-table.reducer.ts | 69 +--- .../src/lib/aas-table/aas-table.selectors.ts | 26 +- .../src/lib/aas-table/aas-table.state.ts | 6 +- .../src/lib/aas-tree/aas-tree-api.service.ts | 36 +- .../src/lib/aas-tree/aas-tree-search.ts | 78 ++-- .../src/lib/aas-tree/aas-tree.actions.ts | 31 +- .../src/lib/aas-tree/aas-tree.component.ts | 172 +++++---- .../src/lib/aas-tree/aas-tree.reducer.ts | 128 +++---- .../src/lib/aas-tree/aas-tree.selectors.ts | 24 +- .../src/lib/aas-tree/aas-tree.state.ts | 12 +- .../operation-call-form.component.html | 2 +- .../operation-call-form.component.ts | 34 +- .../show-image-form.component.html | 2 +- .../show-image-form.component.ts | 10 +- .../show-video-form.component.html | 2 +- .../show-video-form.component.ts | 10 +- .../aas-lib/src/lib/auth/auth-api.service.ts | 10 +- .../aas-lib/src/lib/auth/auth.component.html | 44 +-- .../aas-lib/src/lib/auth/auth.component.ts | 19 +- .../aas-lib/src/lib/auth/auth.interceptor.ts | 4 +- projects/aas-lib/src/lib/auth/auth.service.ts | 66 ++-- .../auth/login-form/login-form.component.ts | 53 +-- .../profile-form/profile-form.component.ts | 20 +- .../register-form/register-form.component.ts | 15 +- projects/aas-lib/src/lib/clipboard.service.ts | 13 +- projects/aas-lib/src/lib/convert.ts | 3 +- .../customer-feedback.actions.ts | 11 +- .../customer-feedback.component.ts | 77 ++-- .../customer-feedback.reducer.ts | 26 +- .../customer-feedback.selectors.ts | 2 +- .../customer-feedback.state.ts | 2 +- .../digital-nameplate.component.ts | 38 +- projects/aas-lib/src/lib/document.service.ts | 6 +- projects/aas-lib/src/lib/download.service.ts | 75 ++-- .../library-table/library-table.component.ts | 11 +- .../aas-lib/src/lib/localize/culture-info.ts | 2 +- .../src/lib/localize/localize.component.html | 21 +- .../src/lib/localize/localize.component.ts | 25 +- projects/aas-lib/src/lib/max-length.pipe.ts | 4 +- .../message-table/massage-table.reducer.ts | 22 +- .../message-table/message-table.actions.ts | 12 +- .../message-table/message-table.component.ts | 64 ++-- .../message-table/message-table.selectors.ts | 2 +- .../lib/message-table/message-table.state.ts | 2 +- .../src/lib/notify/notify.component.ts | 7 +- .../aas-lib/src/lib/notify/notify.service.ts | 38 +- .../aas-lib/src/lib/score/score.component.ts | 6 +- .../secured-image/secured-image.component.ts | 9 +- .../src/lib/sortable-header.directive.ts | 12 +- .../submodel-template/submodel-template.ts | 6 +- .../aas-lib/src/lib/types/aas-query-params.ts | 6 +- projects/aas-lib/src/lib/types/environment.ts | 2 +- projects/aas-lib/src/lib/types/errors.ts | 2 +- projects/aas-lib/src/lib/types/info.ts | 4 +- .../aas-lib/src/lib/types/message-entry.ts | 2 +- .../aas-lib/src/lib/types/online-state.ts | 2 +- projects/aas-lib/src/lib/types/view-mode.ts | 4 +- .../src/lib/types/view-query-params.ts | 6 +- .../src/lib/web-socket-factory.service.ts | 4 +- projects/aas-lib/src/lib/window.service.ts | 12 +- .../assets/test-web-socket-factory.service.ts | 2 +- projects/aas-portal/.eslintrc.json | 88 +++-- projects/aas-portal/package.json | 4 +- .../aas-portal/src/app/aas/aas-api.service.ts | 16 +- .../aas-portal/src/app/aas/aas.actions.ts | 27 +- .../aas-portal/src/app/aas/aas.component.ts | 247 +++++++----- .../aas-portal/src/app/aas/aas.effects.ts | 14 +- .../aas-portal/src/app/aas/aas.reducer.ts | 38 +- .../aas-portal/src/app/aas/aas.selectors.ts | 6 +- projects/aas-portal/src/app/aas/aas.state.ts | 8 +- .../src/app/aas/can-activate-aas.guard.ts | 22 +- .../src/app/aas/command-handler.service.ts | 21 +- .../src/app/aas/commands/delete-command.ts | 36 +- .../app/aas/commands/new-element-command.ts | 28 +- .../aas/commands/update-element-command.ts | 10 +- .../edit-element-form.component.html | 2 +- .../edit-element-form.component.ts | 35 +- .../new-element-form.component.html | 2 +- .../new-element-form.component.ts | 29 +- .../src/app/about/about.component.ts | 14 +- .../src/app/about/server-api.service.ts | 17 +- .../aas-portal/src/app/app-routing.module.ts | 8 +- projects/aas-portal/src/app/app.component.ts | 4 +- projects/aas-portal/src/app/app.module.ts | 29 +- projects/aas-portal/src/app/configuration.ts | 2 +- .../commands/add-new-page-command.ts | 13 +- .../dashboard/commands/dashboard-command.ts | 33 +- .../dashboard/commands/delete-item-command.ts | 17 +- .../dashboard/commands/delete-page-command.ts | 15 +- .../dashboard/commands/move-down-command.ts | 19 +- .../dashboard/commands/move-left-command.ts | 19 +- .../dashboard/commands/move-right-command.ts | 19 +- .../app/dashboard/commands/move-up-command.ts | 20 +- .../dashboard/commands/rename-page-command.ts | 15 +- .../commands/set-chart-type-command.ts | 57 +-- .../dashboard/commands/set-color-command.ts | 17 +- .../dashboard/commands/set-min-max-command.ts | 17 +- .../app/dashboard/dashboard-api.service.ts | 8 +- .../src/app/dashboard/dashboard.actions.ts | 41 +- .../app/dashboard/dashboard.component.html | 2 +- .../src/app/dashboard/dashboard.component.ts | 259 +++++++------ .../src/app/dashboard/dashboard.reducer.ts | 59 +-- .../src/app/dashboard/dashboard.selectors.ts | 21 +- .../src/app/dashboard/dashboard.service.ts | 93 +++-- .../src/app/dashboard/dashboard.state.ts | 8 +- .../aas-portal/src/app/http-loader-factory.ts | 2 +- projects/aas-portal/src/app/index.ts | 4 +- .../src/app/main/main-api.service.ts | 10 +- .../aas-portal/src/app/main/main.component.ts | 55 +-- .../add-endpoint-form.component.html | 2 +- .../add-endpoint-form.component.ts | 16 +- .../favorites-form.component.html | 2 +- .../favorites-form.component.ts | 4 +- .../favorites-form/favorites-form.store.ts | 2 +- .../src/app/start/favorites.service.ts | 7 +- .../remove-endpoint-form.component.html | 2 +- .../remove-endpoint-form.component.ts | 20 +- .../src/app/start/start-api.service.ts | 35 +- .../aas-portal/src/app/start/start.actions.ts | 43 +-- .../src/app/start/start.component.ts | 198 ++++++---- .../aas-portal/src/app/start/start.effects.ts | 232 +++++++----- .../aas-portal/src/app/start/start.reducer.ts | 40 +- .../src/app/start/start.selectors.ts | 12 +- .../aas-portal/src/app/start/start.state.ts | 2 +- .../upload-form/upload-form.component.html | 2 +- .../upload-form/upload-form.component.ts | 50 +-- .../aas-portal/src/app/toolbar.service.ts | 6 +- .../aas-portal/src/app/types/action-base.ts | 21 -- projects/aas-portal/src/app/types/command.ts | 30 +- .../src/app/types/dashboard-query-params.ts | 4 +- projects/aas-portal/src/app/types/doc-ref.ts | 2 +- projects/aas-portal/src/app/types/errors.ts | 2 +- projects/aas-portal/src/app/types/info.ts | 4 +- projects/aas-portal/src/app/types/intl.d.ts | 2 +- .../src/app/types/selection-mode.ts | 4 +- .../src/app/view/view-api.service.ts | 13 +- .../aas-portal/src/app/view/view.actions.ts | 15 +- .../aas-portal/src/app/view/view.component.ts | 60 +-- .../aas-portal/src/app/view/view.effects.ts | 34 +- .../aas-portal/src/app/view/view.reducer.ts | 13 +- .../aas-portal/src/app/view/view.selectors.ts | 2 +- .../test/aas/command-handler.service.spec.ts | 4 +- .../assets/test-web-socket-factory.service.ts | 2 +- projects/aas-server/.eslintrc | 8 +- .../src/app/aas-index/aas-index-factory.ts | 8 +- .../src/app/aas-index/aas-index-query.ts | 7 +- .../aas-server/src/app/aas-index/aas-index.ts | 19 +- .../src/app/aas-index/lowdb/lowdb-index.ts | 63 +++- .../src/app/aas-index/lowdb/lowdb-query.ts | 15 +- .../src/app/aas-index/lowdb/lowdb-types.ts | 2 +- .../src/app/aas-index/mysql/mysql-index.ts | 142 +++---- .../src/app/aas-index/mysql/mysql-query.ts | 33 +- .../src/app/aas-index/mysql/mysql-types.ts | 5 +- .../src/app/aas-provider/aas-provider.ts | 64 ++-- .../aas-provider/aas-resource-scan-factory.ts | 16 +- .../src/app/aas-provider/aas-resource-scan.ts | 3 +- .../src/app/aas-provider/aasx-server-scan.ts | 14 +- .../src/app/aas-provider/directory-scan.ts | 8 +- .../src/app/aas-provider/opcua-server-scan.ts | 20 +- .../src/app/aas-provider/parallel.ts | 19 +- .../src/app/aas-provider/scan-result.ts | 16 +- .../aas-server/src/app/aas-scan-worker.ts | 5 +- projects/aas-server/src/app/aas-server.ts | 10 +- projects/aas-server/src/app/app.ts | 32 +- .../aas-server/src/app/application-info.ts | 8 +- .../aas-server/src/app/auth/auth-service.ts | 29 +- .../src/app/auth/cookie-storage-factory.ts | 5 +- .../aas-server/src/app/auth/cookie-storage.ts | 8 +- .../src/app/auth/locale-cookie-storage.ts | 9 +- .../src/app/auth/locale-user-storage.ts | 10 +- .../src/app/auth/mongo-db-cookie-storage.ts | 12 +- .../src/app/auth/mongo-db-user-storage.ts | 10 +- projects/aas-server/src/app/auth/user-data.ts | 4 +- .../src/app/auth/user-storage-factory.ts | 5 +- .../aas-server/src/app/auth/user-storage.ts | 4 +- projects/aas-server/src/app/configuration.ts | 13 +- .../src/app/controller/aas-controller.ts | 4 +- .../src/app/controller/app-controller.ts | 6 +- .../src/app/controller/auth-controller.ts | 13 +- .../src/app/controller/authentication.ts | 6 +- .../app/controller/containers-controller.ts | 44 ++- .../app/controller/documents-controller.ts | 13 +- .../app/controller/endpoints-controller.ts | 8 +- .../src/app/controller/ioc-container.ts | 2 +- .../app/controller/templates-controller.ts | 6 +- projects/aas-server/src/app/convert.ts | 5 +- projects/aas-server/src/app/errors.ts | 4 +- .../app/file-storage/file-storage-factory.ts | 13 +- .../app/file-storage/local-file-storage.ts | 4 +- .../src/app/file-storage/own-cloud-storage.ts | 37 +- .../aas-server/src/app/image-processing.ts | 9 +- projects/aas-server/src/app/lazy.ts | 8 +- .../src/app/live/empty-subscription.ts | 4 +- .../src/app/live/http/http-socket-item.ts | 10 +- .../src/app/live/http/http-subscription.ts | 34 +- .../src/app/live/opcua/opcua-socket-item.ts | 20 +- .../src/app/live/opcua/opcua-subscription.ts | 33 +- .../aas-server/src/app/live/socket-client.ts | 10 +- .../aas-server/src/app/live/socket-item.ts | 6 +- .../src/app/live/socket-subscription.ts | 2 +- .../aas-server/src/app/logging/file-logger.ts | 14 +- .../src/app/logging/logger-factory.ts | 9 +- projects/aas-server/src/app/logging/logger.ts | 8 +- .../src/app/logging/memory-logger.ts | 21 +- projects/aas-server/src/app/mailer.ts | 22 +- .../src/app/packages/aas-package.ts | 22 +- .../aas-server/src/app/packages/aas-reader.ts | 8 +- .../src/app/packages/aas-resource-factory.ts | 39 +- .../src/app/packages/aas-resource.ts | 22 +- .../aas-server/src/app/packages/aas-writer.ts | 6 +- .../packages/aasx-directory/aasx-directory.ts | 12 +- .../packages/aasx-directory/aasx-package.ts | 17 +- .../aasx-server/aasx-server-package.ts | 4 +- .../packages/aasx-server/aasx-server-v0.ts | 19 +- .../packages/aasx-server/aasx-server-v3.ts | 85 +++-- .../app/packages/aasx-server/aasx-server.ts | 24 +- .../src/app/packages/json-reader-v2.ts | 117 +++--- .../src/app/packages/json-reader.ts | 126 ++++--- .../src/app/packages/json-writer-v2.ts | 119 +++--- .../src/app/packages/json-writer.ts | 92 ++--- .../src/app/packages/opcua/client-file.ts | 35 +- .../opcua/opaque-structure-decoder.ts | 10 +- .../opcua/opcua-data-type-dictionary.ts | 9 +- .../src/app/packages/opcua/opcua-package.ts | 21 +- .../src/app/packages/opcua/opcua-reader.ts | 145 ++++--- .../src/app/packages/opcua/opcua-server.ts | 52 ++- .../src/app/packages/opcua/opcua.ts | 83 ++-- .../src/app/packages/server-message.ts | 145 +++---- .../aas-server/src/app/packages/xml-reader.ts | 80 ++-- projects/aas-server/src/app/scan-container.ts | 30 +- projects/aas-server/src/app/send-error.ts | 28 +- .../app/template/template-storage-factory.ts | 6 +- .../src/app/template/template-storage.ts | 12 +- projects/aas-server/src/app/types/aas-v2.ts | 246 ++++++------ .../src/app/types/container-index.ts | 2 +- .../src/app/types/owncloud-sdk.d.ts | 15 +- projects/aas-server/src/app/types/registry.ts | 4 +- projects/aas-server/src/app/types/uuid.d.ts | 2 +- .../aas-server/src/app/update-statistic.ts | 2 +- projects/aas-server/src/app/variable.ts | 4 +- projects/aas-server/src/app/worker-app.ts | 13 +- projects/aas-server/src/app/ws-server.ts | 20 +- .../test/aas-index/mysql/mysql-index.spec.ts | 2 +- .../test/aas-index/mysql/mysql-query.spec.ts | 4 +- .../test/aas-provider/aas-provider.spec.ts | 2 +- .../src/test/auth/auth-service.spec.ts | 66 ++-- .../test/auth/locale-cookie-storage.spec.ts | 241 +++++++----- .../src/test/auth/locale-user-storage.spec.ts | 44 +-- .../test/auth/mongo-db-cookie-storage.spec.ts | 69 ++-- .../test/auth/mongo-db-user-storage.spec.ts | 22 +- .../aasx-server/aasx-server-v0.spec.ts | 59 +-- .../aasx-server/aasx-server-v3.spec.ts | 119 +++--- .../src/test/packages/json-writer-v2.spec.ts | 18 +- .../src/test/packages/json-writer.spec.ts | 14 +- .../test/packages/opcua/opcua-reader.spec.ts | 8 +- .../test/packages/opcua/opcua-server.spec.ts | 61 +-- .../src/test/packages/server-message.spec.ts | 32 +- projects/common/.eslintrc | 8 +- projects/common/src/lib/aas.ts | 229 ++++++----- projects/common/src/lib/application-error.ts | 10 +- projects/common/src/lib/authentication.ts | 19 +- projects/common/src/lib/convert.ts | 243 ++++++------ projects/common/src/lib/crc32.ts | 16 +- projects/common/src/lib/document.ts | 231 +++++++----- projects/common/src/lib/index.ts | 14 +- projects/common/src/lib/keyed-list.ts | 7 +- projects/common/src/lib/multi-key-map.ts | 2 +- projects/common/src/lib/query-parser.ts | 36 +- projects/common/src/lib/server-message.ts | 22 +- projects/common/src/lib/types.ts | 62 +-- 281 files changed, 4753 insertions(+), 4099 deletions(-) create mode 100644 .prettierignore create mode 100644 .prettierrc.json delete mode 100644 projects/aas-portal/src/app/types/action-base.ts diff --git a/.eslintrc.json b/.eslintrc.json index 65b51509..25e30d4a 100644 --- a/.eslintrc.json +++ b/.eslintrc.json @@ -1,55 +1,21 @@ { - "root": true, - "ignorePatterns": [ - "projects/**/*" - ], - "overrides": [ - { - "files": [ - "*.ts" - ], - "extends": [ + "root": true, + "parser": "@typescript-eslint/parser", + "extends": [ "eslint:recommended", "plugin:@typescript-eslint/recommended", - "plugin:@angular-eslint/recommended", - "plugin:@angular-eslint/template/process-inline-templates" - ], - "rules": { - "@angular-eslint/directive-selector": [ - "error", - { - "type": "attribute", - "prefix": "lib", - "style": "camelCase" - } - ], - "@angular-eslint/component-selector": [ - "error", - { - "type": "element", - "prefix": "lib", - "style": "kebab-case" - } - ] - } + "plugin:prettier/recommended" + ], + "parserOptions": { + "ecmaVersion": 2022, + "sourceType": "module" }, - { - "files": [ - "*.html" - ], - "extends": [ - "plugin:@angular-eslint/template/recommended", - "plugin:@angular-eslint/template/accessibility" - ], - "rules": {} - }, - { - "files": [ - "*.ts" - ], - "extends": [ - "plugin:@ngrx/recommended" - ] + "rules": { + "@typescript-eslint/no-empty-function": "error", + "@typescript-eslint/no-empty-interface": "error", + "@typescript-eslint/no-unused-vars": "error", + "@typescript-eslint/prefer-for-of": "error", + "@typescript-eslint/explicit-member-accessibility": "error", + "prettier/prettier": "error" } - ] } \ No newline at end of file diff --git a/.prettierignore b/.prettierignore new file mode 100644 index 00000000..7e53ed2d --- /dev/null +++ b/.prettierignore @@ -0,0 +1,9 @@ +# Ignore everything +**/* + +# But not TS and JS files +!**/*.ts +!**/*.js + +# Check subdirectories too +!*/ diff --git a/.prettierrc.json b/.prettierrc.json new file mode 100644 index 00000000..3cc0fb26 --- /dev/null +++ b/.prettierrc.json @@ -0,0 +1,17 @@ +{ + "singleQuote": true, + "trailingComma": "all", + "useTabs": false, + "tabWidth": 4, + "semi": true, + "endOfLine": "auto", + "printWidth": 120, + "quoteProps": "as-needed", + "bracketSpacing": true, + "bracketSameLine": false, + "arrowParens": "avoid", + "proseWrap": "preserve", + "embeddedLanguageFormatting": "auto", + "singleAttributePerLine": false + } + diff --git a/.vscode/settings.json b/.vscode/settings.json index 1c2c5268..cc1b6b3b 100644 --- a/.vscode/settings.json +++ b/.vscode/settings.json @@ -1,6 +1,7 @@ { "cSpell.words": [ "aaslist", + "aasv", "aasv3", "angewandten", "autohide", @@ -22,6 +23,7 @@ "nicht", "NMTOKEN", "NMTOKENS", + "opnxml", "owncloud", "preprocessors", "Qualifiable", @@ -34,5 +36,6 @@ "uuid", "xmldoc", "ZVEI" - ] + ], + "files.eol": "\n", } \ No newline at end of file diff --git a/package-lock.json b/package-lock.json index 4137d493..6d36b15f 100644 --- a/package-lock.json +++ b/package-lock.json @@ -58,6 +58,7 @@ "rxjs": "~7.8.1", "swagger-ui-express": "^5.0.0", "tslib": "^2.6.2", + "tsoa": "^6.0.0", "tsyringe": "^4.8.0", "uuid": "^8.3.2", "winston": "^3.11.0", @@ -101,6 +102,8 @@ "babel-plugin-transform-import-meta": "^2.2.1", "esbuild": "^0.19.11", "eslint": "^8.56.0", + "eslint-config-prettier": "^9.1.0", + "eslint-plugin-prettier": "^5.1.3", "jasmine-core": "^5.1.1", "jest": "^29.7.0", "karma": "^6.4.2", @@ -110,12 +113,12 @@ "karma-jasmine-html-reporter": "^2.1.0", "karma-junit-reporter": "^2.0.1", "ng-packagr": "^17.0.3", + "prettier": "^3.1.1", "rimraf": "^5.0.5", "semantic-release": "^22.0.12", "supertest": "^6.3.3", "ts-jest": "^29.1.1", "ts-node": "^10.9.2", - "tsoa": "^6.0.0", "typescript": "^5.2.2" } }, @@ -3605,7 +3608,6 @@ "version": "8.0.2", "resolved": "https://registry.npmjs.org/@isaacs/cliui/-/cliui-8.0.2.tgz", "integrity": "sha512-O8jcjabXaleOG9DQ0+ARXWZBTfnP4WNAqzuiJK7ll44AmxGKv/J2M4TPjxjY3znBCfvBXFzucm1twdyFybFqEA==", - "dev": true, "dependencies": { "string-width": "^5.1.2", "string-width-cjs": "npm:string-width@^4.2.0", @@ -3622,7 +3624,6 @@ "version": "6.0.1", "resolved": "https://registry.npmjs.org/ansi-regex/-/ansi-regex-6.0.1.tgz", "integrity": "sha512-n5M855fKb2SsfMIiFFoVrABHJC8QtHwVx+mHWP3QcEqBHYienj5dHSgjbxtC0WEZXYt4wcD6zrQElDPhFuZgfA==", - "dev": true, "engines": { "node": ">=12" }, @@ -3634,7 +3635,6 @@ "version": "6.2.1", "resolved": "https://registry.npmjs.org/ansi-styles/-/ansi-styles-6.2.1.tgz", "integrity": "sha512-bN798gFfQX+viw3R7yrGWRqnrN2oRkEkUjjl4JNn4E8GxxbjtG3FbrEIIY3l8/hrwUwIeCZvi4QuOTP4MErVug==", - "dev": true, "engines": { "node": ">=12" }, @@ -3645,14 +3645,12 @@ "node_modules/@isaacs/cliui/node_modules/emoji-regex": { "version": "9.2.2", "resolved": "https://registry.npmjs.org/emoji-regex/-/emoji-regex-9.2.2.tgz", - "integrity": "sha512-L18DaJsXSUk2+42pv8mLs5jJT2hqFkFE4j21wOmgbUqsZ2hL72NsUU785g9RXgo3s0ZNgVl42TiHp3ZtOv/Vyg==", - "dev": true + "integrity": "sha512-L18DaJsXSUk2+42pv8mLs5jJT2hqFkFE4j21wOmgbUqsZ2hL72NsUU785g9RXgo3s0ZNgVl42TiHp3ZtOv/Vyg==" }, "node_modules/@isaacs/cliui/node_modules/string-width": { "version": "5.1.2", "resolved": "https://registry.npmjs.org/string-width/-/string-width-5.1.2.tgz", "integrity": "sha512-HnLOCR3vjcY8beoNLtcjZ5/nxn2afmME6lhrDrebokqMap+XbeW8n9TXpPDOqdGK5qcI3oT0GKTW6wC7EMiVqA==", - "dev": true, "dependencies": { "eastasianwidth": "^0.2.0", "emoji-regex": "^9.2.2", @@ -3669,7 +3667,6 @@ "version": "7.1.0", "resolved": "https://registry.npmjs.org/strip-ansi/-/strip-ansi-7.1.0.tgz", "integrity": "sha512-iq6eVVI64nQQTRYq2KtEg2d2uU7LElhTJwsH4YzIHZshxlgZms/wIc4VoDQTlG/IvVIrBKG06CrZnp0qv7hkcQ==", - "dev": true, "dependencies": { "ansi-regex": "^6.0.1" }, @@ -3684,7 +3681,6 @@ "version": "8.1.0", "resolved": "https://registry.npmjs.org/wrap-ansi/-/wrap-ansi-8.1.0.tgz", "integrity": "sha512-si7QWI6zUMq56bESFvagtmzMdGOtoxfR+Sez11Mobfc7tm+VkUckk9bW2UeffTGVUbOksxmSw0AA2gs8g71NCQ==", - "dev": true, "dependencies": { "ansi-styles": "^6.1.0", "string-width": "^5.0.1", @@ -5779,12 +5775,23 @@ "version": "0.11.0", "resolved": "https://registry.npmjs.org/@pkgjs/parseargs/-/parseargs-0.11.0.tgz", "integrity": "sha512-+1VkjdD0QBLPodGrJUeqarH8VAIvQODIbwh9XpP5Syisf7YoQgsJKPNFoqqLQlu+VQ/tVSshMR6loPMn8U+dPg==", - "dev": true, "optional": true, "engines": { "node": ">=14" } }, + "node_modules/@pkgr/core": { + "version": "0.1.0", + "resolved": "https://registry.npmjs.org/@pkgr/core/-/core-0.1.0.tgz", + "integrity": "sha512-Zwq5OCzuwJC2jwqmpEQt7Ds1DTi6BWSwoGkbb1n9pO3hzb35BoJELx7c0T23iDkBGkh2e7tvOtjF3tr3OaQHDQ==", + "dev": true, + "engines": { + "node": "^12.20.0 || ^14.18.0 || >=16.0.0" + }, + "funding": { + "url": "https://opencollective.com/unts" + } + }, "node_modules/@pnpm/config.env-replace": { "version": "1.1.0", "resolved": "https://registry.npmjs.org/@pnpm/config.env-replace/-/config.env-replace-1.1.0.tgz", @@ -6704,7 +6711,6 @@ "version": "6.0.0", "resolved": "https://registry.npmjs.org/@tsoa/cli/-/cli-6.0.0.tgz", "integrity": "sha512-Pzzg3sWkcalYEKzzNnvX8iAu7X19FxeN79yBjvCvR8h6Q5qvfO2UqlifSIZdZd6rPOoxaIuYEU8C5sBupI6+sg==", - "dev": true, "dependencies": { "@tsoa/runtime": "^6.0.0", "@types/multer": "^1.4.11", @@ -6731,7 +6737,6 @@ "version": "11.2.0", "resolved": "https://registry.npmjs.org/fs-extra/-/fs-extra-11.2.0.tgz", "integrity": "sha512-PmDi3uwK5nFuXh7XDTlVnS17xJS7vW36is2+w3xcv8SVxiB4NyATf4ctkVY5bkSjX0Y4nbvZCq1/EjtEyr9ktw==", - "dev": true, "dependencies": { "graceful-fs": "^4.2.0", "jsonfile": "^6.0.1", @@ -6745,7 +6750,6 @@ "version": "10.3.10", "resolved": "https://registry.npmjs.org/glob/-/glob-10.3.10.tgz", "integrity": "sha512-fa46+tv1Ak0UPK1TOy/pZrIybNNt4HCv7SDzwyfiOZkvZLEbjsZkJBPtDHVshZjbecAoAGSC20MjLDG/qr679g==", - "dev": true, "dependencies": { "foreground-child": "^3.1.0", "jackspeak": "^2.3.5", @@ -6767,7 +6771,6 @@ "version": "6.1.0", "resolved": "https://registry.npmjs.org/jsonfile/-/jsonfile-6.1.0.tgz", "integrity": "sha512-5dgndWOriYSm5cnYaJNhalLNDKOqFwyDB/rr1E9ZsGciGvKPs8R2xYGCacuf3z6K1YKDz182fd+fY3cn3pMqXQ==", - "dev": true, "dependencies": { "universalify": "^2.0.0" }, @@ -6779,7 +6782,6 @@ "version": "5.3.3", "resolved": "https://registry.npmjs.org/typescript/-/typescript-5.3.3.tgz", "integrity": "sha512-pXWcraxM0uxAS+tN0AG/BF2TyqmHO014Z070UsJ+pFvYuRSq8KH8DmWpnbXe0pEPDHXZV3FcAbJkijJ5oNEnWw==", - "dev": true, "bin": { "tsc": "bin/tsc", "tsserver": "bin/tsserver" @@ -6792,7 +6794,6 @@ "version": "2.0.1", "resolved": "https://registry.npmjs.org/universalify/-/universalify-2.0.1.tgz", "integrity": "sha512-gptHNQghINnc/vTGIk0SOFGFNXw7JVrlRUtConJRlvaw6DuX0wO5Jeko9sWrMBhh+PsYAZ7oXAiOnf/UKogyiw==", - "dev": true, "engines": { "node": ">= 10.0.0" } @@ -6801,7 +6802,6 @@ "version": "6.0.0", "resolved": "https://registry.npmjs.org/@tsoa/runtime/-/runtime-6.0.0.tgz", "integrity": "sha512-n0LYcjII313kDn3M4bZdAjU+sX7595sIEA3bw4pvxWRrkandyDdDFNrfQL8nZ3Pw6dkTmK7brZi0YBBDhe0Rzw==", - "dev": true, "dependencies": { "@types/multer": "^1.4.11", "reflect-metadata": "^0.2.1", @@ -6898,7 +6898,6 @@ "version": "1.19.5", "resolved": "https://registry.npmjs.org/@types/body-parser/-/body-parser-1.19.5.tgz", "integrity": "sha512-fB3Zu92ucau0iQ0JMCFQE7b/dv8Ot07NI3KaZIkIUNXq82k4eBAqUaneXfleGY9JWskeS9y+u0nXMyspcuQrCg==", - "dev": true, "dependencies": { "@types/connect": "*", "@types/node": "*" @@ -6926,7 +6925,6 @@ "version": "3.4.38", "resolved": "https://registry.npmjs.org/@types/connect/-/connect-3.4.38.tgz", "integrity": "sha512-K6uROf1LD88uDQqJCktA4yzL1YYAK6NgfsI0v/mTgyPKWsX1CnJ0XPSDhViejru1GcRkLWb8RlzFYJRqGUbaug==", - "dev": true, "dependencies": { "@types/node": "*" } @@ -7000,7 +6998,6 @@ "version": "4.17.21", "resolved": "https://registry.npmjs.org/@types/express/-/express-4.17.21.tgz", "integrity": "sha512-ejlPM315qwLpaQlQDTjPdsUFSc6ZsP4AN6AlWnogPjQ7CVi7PYF3YVz+CY3jE2pwYf7E/7HlDAN0rV2GxTG0HQ==", - "dev": true, "dependencies": { "@types/body-parser": "*", "@types/express-serve-static-core": "^4.17.33", @@ -7012,7 +7009,6 @@ "version": "4.17.41", "resolved": "https://registry.npmjs.org/@types/express-serve-static-core/-/express-serve-static-core-4.17.41.tgz", "integrity": "sha512-OaJ7XLaelTgrvlZD8/aa0vvvxZdUmlCn6MtWeB7TkiKW70BQLc9XEPpDLPdbo52ZhXUCrznlWdCHWxJWtdyajA==", - "dev": true, "dependencies": { "@types/node": "*", "@types/qs": "*", @@ -7032,8 +7028,7 @@ "node_modules/@types/http-errors": { "version": "2.0.4", "resolved": "https://registry.npmjs.org/@types/http-errors/-/http-errors-2.0.4.tgz", - "integrity": "sha512-D0CFMMtydbJAegzOyHjtiKPLlvnm3iTZyZRSZoLq2mRhDdmLfIWOCYPfQJ4cu2erKghU++QvjcUjp/5h7hESpA==", - "dev": true + "integrity": "sha512-D0CFMMtydbJAegzOyHjtiKPLlvnm3iTZyZRSZoLq2mRhDdmLfIWOCYPfQJ4cu2erKghU++QvjcUjp/5h7hESpA==" }, "node_modules/@types/http-proxy": { "version": "1.17.14", @@ -7126,8 +7121,7 @@ "node_modules/@types/mime": { "version": "1.3.5", "resolved": "https://registry.npmjs.org/@types/mime/-/mime-1.3.5.tgz", - "integrity": "sha512-/pyBZWSLD2n0dcHE3hq8s8ZvcETHtEuF+3E7XVt0Ig2nvsVQXdghHVcEkIWjy9A0wKfTn97a/PSDYohKIlnP/w==", - "dev": true + "integrity": "sha512-/pyBZWSLD2n0dcHE3hq8s8ZvcETHtEuF+3E7XVt0Ig2nvsVQXdghHVcEkIWjy9A0wKfTn97a/PSDYohKIlnP/w==" }, "node_modules/@types/mkdirp": { "version": "1.0.2", @@ -7150,7 +7144,6 @@ "version": "1.4.11", "resolved": "https://registry.npmjs.org/@types/multer/-/multer-1.4.11.tgz", "integrity": "sha512-svK240gr6LVWvv3YGyhLlA+6LRRWA4mnGIU7RcNmgjBYFl6665wcXrRfxGp5tEPVHUNm5FMcmq7too9bxCwX/w==", - "dev": true, "dependencies": { "@types/express": "*" } @@ -7207,14 +7200,12 @@ "node_modules/@types/qs": { "version": "6.9.11", "resolved": "https://registry.npmjs.org/@types/qs/-/qs-6.9.11.tgz", - "integrity": "sha512-oGk0gmhnEJK4Yyk+oI7EfXsLayXatCWPHary1MtcmbAifkobT9cM9yutG/hZKIseOU0MqbIwQ/u2nn/Gb+ltuQ==", - "dev": true + "integrity": "sha512-oGk0gmhnEJK4Yyk+oI7EfXsLayXatCWPHary1MtcmbAifkobT9cM9yutG/hZKIseOU0MqbIwQ/u2nn/Gb+ltuQ==" }, "node_modules/@types/range-parser": { "version": "1.2.7", "resolved": "https://registry.npmjs.org/@types/range-parser/-/range-parser-1.2.7.tgz", - "integrity": "sha512-hKormJbkJqzQGhziax5PItDUTMAM9uE2XXQmM37dyd4hVM+5aVl7oVxMVUiVQn2oCQFN/LKCZdvSM0pFRqbSmQ==", - "dev": true + "integrity": "sha512-hKormJbkJqzQGhziax5PItDUTMAM9uE2XXQmM37dyd4hVM+5aVl7oVxMVUiVQn2oCQFN/LKCZdvSM0pFRqbSmQ==" }, "node_modules/@types/resolve": { "version": "1.20.2", @@ -7236,7 +7227,6 @@ "version": "0.17.4", "resolved": "https://registry.npmjs.org/@types/send/-/send-0.17.4.tgz", "integrity": "sha512-x2EM6TJOybec7c52BX0ZspPodMsQUd5L6PRwOunVyVUhXiBSKf3AezDL8Dgvgt5o0UfKNfuA0eMLr2wLT4AiBA==", - "dev": true, "dependencies": { "@types/mime": "^1", "@types/node": "*" @@ -7255,7 +7245,6 @@ "version": "1.15.5", "resolved": "https://registry.npmjs.org/@types/serve-static/-/serve-static-1.15.5.tgz", "integrity": "sha512-PDRk21MnK70hja/YF8AHfC7yIsiQHn1rcXx7ijCFBX/k+XQJhQT/gw3xekXKJvx+5SXaMMS8oqQy09Mzvz2TuQ==", - "dev": true, "dependencies": { "@types/http-errors": "*", "@types/mime": "*", @@ -8510,7 +8499,6 @@ "version": "1.0.10", "resolved": "https://registry.npmjs.org/argparse/-/argparse-1.0.10.tgz", "integrity": "sha512-o5Roy6tNG4SL/FOkCAN6RzjiakZS25RLYFrcMttJqbdd8BWrnA+fGz57iN5Pb06pvBGvl5gQ0B48dJlslXvoTg==", - "dev": true, "dependencies": { "sprintf-js": "~1.0.2" } @@ -10683,7 +10671,6 @@ "version": "7.0.3", "resolved": "https://registry.npmjs.org/cross-spawn/-/cross-spawn-7.0.3.tgz", "integrity": "sha512-iRDPJKUPVEND7dHPO8rkbOnPpyDygcDFtWjpeWNCgy8WP2rXcxXL8TskReQl6OrB2G7+UJrags1q15Fudc7G6w==", - "dev": true, "dependencies": { "path-key": "^3.1.0", "shebang-command": "^2.0.0", @@ -10876,7 +10863,6 @@ "version": "4.3.1", "resolved": "https://registry.npmjs.org/deepmerge/-/deepmerge-4.3.1.tgz", "integrity": "sha512-3sUqbMEc77XqpdNO7FRyRog+eW3ph+GYCbj+rK+uYyRMuwsVy0rMiVtPn+QJlKFvWP/1PYpapqYn0Me2knFn+A==", - "dev": true, "engines": { "node": ">=0.10.0" } @@ -11232,8 +11218,7 @@ "node_modules/eastasianwidth": { "version": "0.2.0", "resolved": "https://registry.npmjs.org/eastasianwidth/-/eastasianwidth-0.2.0.tgz", - "integrity": "sha512-I88TYZWc9XiYHRQ4/3c5rjjfgkjhLyW2luGIheGERbNQ6OY7yTybanSpDXZa8y7VUP9YmDcYa+eyq4ca7iLqWA==", - "dev": true + "integrity": "sha512-I88TYZWc9XiYHRQ4/3c5rjjfgkjhLyW2luGIheGERbNQ6OY7yTybanSpDXZa8y7VUP9YmDcYa+eyq4ca7iLqWA==" }, "node_modules/easy-extender": { "version": "2.3.4", @@ -11898,6 +11883,18 @@ "url": "https://opencollective.com/eslint" } }, + "node_modules/eslint-config-prettier": { + "version": "9.1.0", + "resolved": "https://registry.npmjs.org/eslint-config-prettier/-/eslint-config-prettier-9.1.0.tgz", + "integrity": "sha512-NSWl5BFQWEPi1j4TjVNItzYV7dZXZ+wP6I6ZhrBGpChQhZRUaElihE9uRRkcbRnNb76UMKDF3r+WTmNcGPKsqw==", + "dev": true, + "bin": { + "eslint-config-prettier": "bin/cli.js" + }, + "peerDependencies": { + "eslint": ">=7.0.0" + } + }, "node_modules/eslint-etc": { "version": "5.2.1", "resolved": "https://registry.npmjs.org/eslint-etc/-/eslint-etc-5.2.1.tgz", @@ -11913,6 +11910,36 @@ "typescript": ">=4.0.0" } }, + "node_modules/eslint-plugin-prettier": { + "version": "5.1.3", + "resolved": "https://registry.npmjs.org/eslint-plugin-prettier/-/eslint-plugin-prettier-5.1.3.tgz", + "integrity": "sha512-C9GCVAs4Eq7ZC/XFQHITLiHJxQngdtraXaM+LoUFoFp/lHNl2Zn8f3WQbe9HvTBBQ9YnKFB0/2Ajdqwo5D1EAw==", + "dev": true, + "dependencies": { + "prettier-linter-helpers": "^1.0.0", + "synckit": "^0.8.6" + }, + "engines": { + "node": "^14.18.0 || >=16.0.0" + }, + "funding": { + "url": "https://opencollective.com/eslint-plugin-prettier" + }, + "peerDependencies": { + "@types/eslint": ">=8.0.0", + "eslint": ">=8.0.0", + "eslint-config-prettier": "*", + "prettier": ">=3.0.0" + }, + "peerDependenciesMeta": { + "@types/eslint": { + "optional": true + }, + "eslint-config-prettier": { + "optional": true + } + } + }, "node_modules/eslint-scope": { "version": "8.0.0", "resolved": "https://registry.npmjs.org/eslint-scope/-/eslint-scope-8.0.0.tgz", @@ -12527,6 +12554,12 @@ "resolved": "https://registry.npmjs.org/fast-deep-equal/-/fast-deep-equal-3.1.3.tgz", "integrity": "sha512-f3qQ9oQy9j2AhBe/H9VC91wLmKBCCU/gDOnKNAYG5hswO7BLKj09Hc5HYNz9cGI++xlpDCIgDaitVs03ATR84Q==" }, + "node_modules/fast-diff": { + "version": "1.3.0", + "resolved": "https://registry.npmjs.org/fast-diff/-/fast-diff-1.3.0.tgz", + "integrity": "sha512-VxPP4NqbUjj6MaAOafWeUn2cXWLcCtljklUtZf0Ind4XQ+QPtmA0b18zZy0jIQx+ExRVCR/ZQpBmik5lXshNsw==", + "dev": true + }, "node_modules/fast-glob": { "version": "3.3.1", "resolved": "https://registry.npmjs.org/fast-glob/-/fast-glob-3.3.1.tgz", @@ -12904,7 +12937,6 @@ "version": "3.1.1", "resolved": "https://registry.npmjs.org/foreground-child/-/foreground-child-3.1.1.tgz", "integrity": "sha512-TMKDUnIte6bfb5nWv7V/caI169OHgvwjb7V4WkeUvbQQdjr5rWKqHFiKWb/fcOwB+CzBT+qbWjvj+DVwRskpIg==", - "dev": true, "dependencies": { "cross-spawn": "^7.0.0", "signal-exit": "^4.0.1" @@ -12920,7 +12952,6 @@ "version": "4.1.0", "resolved": "https://registry.npmjs.org/signal-exit/-/signal-exit-4.1.0.tgz", "integrity": "sha512-bzyZ1e88w9O1iNJbKnOlvYTrWPDl46O1bG0D3XInv+9tkPrxrN8jUUTiFlDkkmKWgn1M6CfIA13SuGqOa9Korw==", - "dev": true, "engines": { "node": ">=14" }, @@ -13308,7 +13339,6 @@ "version": "4.7.8", "resolved": "https://registry.npmjs.org/handlebars/-/handlebars-4.7.8.tgz", "integrity": "sha512-vafaFqs8MZkRrSX7sFVUdo3ap/eNiLnb4IakshzvP56X5Nr1iGKAIqdX6tMlm6HcNRIkr6AxO5jFEoJzzpT8aQ==", - "dev": true, "dependencies": { "minimist": "^1.2.5", "neo-async": "^2.6.2", @@ -13329,7 +13359,6 @@ "version": "0.6.1", "resolved": "https://registry.npmjs.org/source-map/-/source-map-0.6.1.tgz", "integrity": "sha512-UjgapumWlbMhkBgzT7Ykc5YXUT46F0iKu8SGXq0bcwP5dz/h0Plj6enJqjz1Zbq2l5WaqYnrVbwWOWMyF3F47g==", - "dev": true, "engines": { "node": ">=0.10.0" } @@ -14297,8 +14326,7 @@ "node_modules/isexe": { "version": "2.0.0", "resolved": "https://registry.npmjs.org/isexe/-/isexe-2.0.0.tgz", - "integrity": "sha512-RHxMLp9lnKHGHRng9QFhRCMbYAcVpn69smSGcq3f36xjgVVWThj4qqLbTLlq7Ssj8B+fIQ1EuCEGI2lKsyQeIw==", - "dev": true + "integrity": "sha512-RHxMLp9lnKHGHRng9QFhRCMbYAcVpn69smSGcq3f36xjgVVWThj4qqLbTLlq7Ssj8B+fIQ1EuCEGI2lKsyQeIw==" }, "node_modules/isobject": { "version": "3.0.1", @@ -14443,7 +14471,6 @@ "version": "2.3.6", "resolved": "https://registry.npmjs.org/jackspeak/-/jackspeak-2.3.6.tgz", "integrity": "sha512-N3yCS/NegsOBokc8GAdM8UcmfsKiSS8cipheD/nivzr700H+nsMOxJjQnvwOcRYVuFkdH0wGUvW2WbXGmrZGbQ==", - "dev": true, "dependencies": { "@isaacs/cliui": "^8.0.2" }, @@ -17710,7 +17737,6 @@ "version": "5.1.7", "resolved": "https://registry.npmjs.org/merge-anything/-/merge-anything-5.1.7.tgz", "integrity": "sha512-eRtbOb1N5iyH0tkQDAoQ4Ipsp/5qSR79Dzrz8hEPxRX10RWWR/iQXdoKmBSRCThY1Fh5EhISDtpSc93fpxUniQ==", - "dev": true, "dependencies": { "is-what": "^4.1.8" }, @@ -17725,7 +17751,6 @@ "version": "4.1.16", "resolved": "https://registry.npmjs.org/is-what/-/is-what-4.1.16.tgz", "integrity": "sha512-ZhMwEosbFJkA0YhFnNDgTM4ZxDRsS6HqTo7qsZM08fehyRYIYa0yHu5R6mgo1n/8MgaPBXiPimPD77baVFYg+A==", - "dev": true, "engines": { "node": ">=12.13" }, @@ -17863,7 +17888,6 @@ "version": "9.0.3", "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-9.0.3.tgz", "integrity": "sha512-RHiac9mvaRw0x3AYRgDC1CxAP7HTcNrrECeA8YYJeWnpo+2Q5CegtZjaotWTWxDG3UeGA1coE05iH1mPjT/2mg==", - "dev": true, "dependencies": { "brace-expansion": "^2.0.1" }, @@ -17886,7 +17910,6 @@ "version": "7.0.4", "resolved": "https://registry.npmjs.org/minipass/-/minipass-7.0.4.tgz", "integrity": "sha512-jYofLM5Dam9279rdkWzqHozUo4ybjdZmCsDHePy5V/PbBcVMiSZR97gmAy45aqi8CK1lG2ECd356FU86avfwUQ==", - "dev": true, "engines": { "node": ">=16 || 14 >=14.17" } @@ -18405,8 +18428,7 @@ "node_modules/neo-async": { "version": "2.6.2", "resolved": "https://registry.npmjs.org/neo-async/-/neo-async-2.6.2.tgz", - "integrity": "sha512-Yd3UES5mWCSqR+qNT93S3UoYUkqAZ9lLg8a7g9rimsWmYGK8cVToA4/sF3RrshdyV3sAGMXVUmpMYOw+dLpOuw==", - "dev": true + "integrity": "sha512-Yd3UES5mWCSqR+qNT93S3UoYUkqAZ9lLg8a7g9rimsWmYGK8cVToA4/sF3RrshdyV3sAGMXVUmpMYOw+dLpOuw==" }, "node_modules/nerf-dart": { "version": "1.0.0", @@ -25151,7 +25173,6 @@ "version": "3.1.1", "resolved": "https://registry.npmjs.org/path-key/-/path-key-3.1.1.tgz", "integrity": "sha512-ojmeN0qd+y0jszEtoY48r0Peq5dwMEkIlCOu6Q5f41lfkswXuKtYrhgoTpLnyIcHm24Uhqx+5Tqm2InSwLhE6Q==", - "dev": true, "engines": { "node": ">=8" } @@ -25172,7 +25193,6 @@ "version": "1.10.1", "resolved": "https://registry.npmjs.org/path-scurry/-/path-scurry-1.10.1.tgz", "integrity": "sha512-MkhCqzzBEpPvxxQ71Md0b1Kk51W01lrYvlMzSUaIzNsODdd7mqhiimSZlr+VegAz5Z6Vzt9Xg2ttE//XBhH3EQ==", - "dev": true, "dependencies": { "lru-cache": "^9.1.1 || ^10.0.0", "minipass": "^5.0.0 || ^6.0.2 || ^7.0.0" @@ -25188,7 +25208,6 @@ "version": "10.1.0", "resolved": "https://registry.npmjs.org/lru-cache/-/lru-cache-10.1.0.tgz", "integrity": "sha512-/1clY/ui8CzjKFyjdvwPWJUYKiFVXG2I2cY0ssG7h4+hwk+XOIX7ZSG9Q7TW8TW3Kp3BUSqgFWBLgL4PJ+Blag==", - "dev": true, "engines": { "node": "14 || >=16.14" } @@ -25726,6 +25745,33 @@ "node": ">= 0.8.0" } }, + "node_modules/prettier": { + "version": "3.1.1", + "resolved": "https://registry.npmjs.org/prettier/-/prettier-3.1.1.tgz", + "integrity": "sha512-22UbSzg8luF4UuZtzgiUOfcGM8s4tjBv6dJRT7j275NXsy2jb4aJa4NNveul5x4eqlF1wuhuR2RElK71RvmVaw==", + "dev": true, + "bin": { + "prettier": "bin/prettier.cjs" + }, + "engines": { + "node": ">=14" + }, + "funding": { + "url": "https://github.com/prettier/prettier?sponsor=1" + } + }, + "node_modules/prettier-linter-helpers": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/prettier-linter-helpers/-/prettier-linter-helpers-1.0.0.tgz", + "integrity": "sha512-GbK2cP9nraSSUF9N2XwUwqfzlAFlMNYYl+ShE/V+H8a9uNl/oUqB1w2EL54Jh0OlyRSd8RfWYJ3coVS4TROP2w==", + "dev": true, + "dependencies": { + "fast-diff": "^1.1.2" + }, + "engines": { + "node": ">=6.0.0" + } + }, "node_modules/pretty-bytes": { "version": "5.6.0", "resolved": "https://registry.npmjs.org/pretty-bytes/-/pretty-bytes-5.6.0.tgz", @@ -27410,7 +27456,6 @@ "version": "2.0.0", "resolved": "https://registry.npmjs.org/shebang-command/-/shebang-command-2.0.0.tgz", "integrity": "sha512-kHxr2zZpYtdmrN1qDjrrX/Z1rR1kG8Dx+gkpK1G4eXmvXswmcE1hTWBWYUzlraYw1/yZp6YuDY77YtvbN0dmDA==", - "dev": true, "dependencies": { "shebang-regex": "^3.0.0" }, @@ -27422,7 +27467,6 @@ "version": "3.0.0", "resolved": "https://registry.npmjs.org/shebang-regex/-/shebang-regex-3.0.0.tgz", "integrity": "sha512-7++dFhtcx3353uBaq8DDR4NuxBetBzC7ZQOhmTQInHEd6bSrXdiEyzCvG07Z44UYdLShWUyXt5M/yhz8ekcb1A==", - "dev": true, "engines": { "node": ">=8" } @@ -27840,8 +27884,7 @@ "node_modules/sprintf-js": { "version": "1.0.3", "resolved": "https://registry.npmjs.org/sprintf-js/-/sprintf-js-1.0.3.tgz", - "integrity": "sha512-D9cPgkvLlV3t3IzL0D0YLvGA9Ahk4PcvVwUbN0dSGr1aP0Nrt4AEnTUbuGvquEC0mA64Gqt1fzirlRs5ibXx8g==", - "dev": true + "integrity": "sha512-D9cPgkvLlV3t3IzL0D0YLvGA9Ahk4PcvVwUbN0dSGr1aP0Nrt4AEnTUbuGvquEC0mA64Gqt1fzirlRs5ibXx8g==" }, "node_modules/sqlstring": { "version": "2.3.3", @@ -28073,7 +28116,6 @@ "version": "4.2.3", "resolved": "https://registry.npmjs.org/string-width/-/string-width-4.2.3.tgz", "integrity": "sha512-wKyQRQpjJ0sIp62ErSZdGsjMJWsap5oRNihHhu6G7JVO/9jIB6UyevL+tXuOqrng8j/cxKTWyWUwvSTriiZz/g==", - "dev": true, "dependencies": { "emoji-regex": "^8.0.0", "is-fullwidth-code-point": "^3.0.0", @@ -28099,7 +28141,6 @@ "version": "6.0.1", "resolved": "https://registry.npmjs.org/strip-ansi/-/strip-ansi-6.0.1.tgz", "integrity": "sha512-Y38VPSHcqkFrCpFnQ9vuSXmquuv5oXOKpGeT6aGrr3o3Gc9AlVa6JBfUSOCnbxGGZF+/0ooI7KrPuUSztUdU5A==", - "dev": true, "dependencies": { "ansi-regex": "^5.0.1" }, @@ -28307,6 +28348,22 @@ "node": ">=0.10" } }, + "node_modules/synckit": { + "version": "0.8.8", + "resolved": "https://registry.npmjs.org/synckit/-/synckit-0.8.8.tgz", + "integrity": "sha512-HwOKAP7Wc5aRGYdKH+dw0PRRpbO841v2DENBtjnR5HFWoiNByAl7vrx3p0G/rCyYXQsrxqtX48TImFtPcIHSpQ==", + "dev": true, + "dependencies": { + "@pkgr/core": "^0.1.0", + "tslib": "^2.6.2" + }, + "engines": { + "node": "^14.18.0 || >=16.0.0" + }, + "funding": { + "url": "https://opencollective.com/unts" + } + }, "node_modules/tapable": { "version": "2.2.1", "resolved": "https://registry.npmjs.org/tapable/-/tapable-2.2.1.tgz", @@ -28978,7 +29035,6 @@ "version": "6.0.0", "resolved": "https://registry.npmjs.org/tsoa/-/tsoa-6.0.0.tgz", "integrity": "sha512-D8Kvp3wUhZwpX13hXptqKdk/2VMqg+t8SLeZDiRwv5XiOv39YJbt0F+6DEeyIBW6cC6vBYKD1Cs+cUXoY1VKiQ==", - "dev": true, "dependencies": { "@tsoa/cli": "^6.0.0", "@tsoa/runtime": "^6.0.0" @@ -29168,7 +29224,6 @@ "version": "3.17.4", "resolved": "https://registry.npmjs.org/uglify-js/-/uglify-js-3.17.4.tgz", "integrity": "sha512-T9q82TJI9e/C1TAxYvfb16xO120tMVFZrGA3f9/P4424DNu6ypK103y0GPFVa17yotwSyZW5iYXgjYHkGrJW/g==", - "dev": true, "optional": true, "bin": { "uglifyjs": "bin/uglifyjs" @@ -29473,7 +29528,6 @@ "version": "13.11.0", "resolved": "https://registry.npmjs.org/validator/-/validator-13.11.0.tgz", "integrity": "sha512-Ii+sehpSfZy+At5nPdnyMhx78fEoPDkR2XW/zimHEL3MyGJQOCQ7WeP20jPYRz7ZCpcKLB21NxuXHF3bxjStBQ==", - "dev": true, "engines": { "node": ">= 0.10" } @@ -30417,7 +30471,6 @@ "version": "2.0.2", "resolved": "https://registry.npmjs.org/which/-/which-2.0.2.tgz", "integrity": "sha512-BLI3Tl1TW3Pvl70l3yq3Y64i+awpwXqsGBYWkkqMtnbXgrMD+yj7rhW0kuEDxzJaYXGjEW5ogapKNMEKNMjibA==", - "dev": true, "dependencies": { "isexe": "^2.0.0" }, @@ -30540,8 +30593,7 @@ "node_modules/wordwrap": { "version": "1.0.0", "resolved": "https://registry.npmjs.org/wordwrap/-/wordwrap-1.0.0.tgz", - "integrity": "sha512-gvVzJFlPycKc5dZN4yPkP8w7Dc37BtP1yczEneOb4uq34pXZcvrtRTmWV8W+Ume+XCxKgbjM+nevkyFPMybd4Q==", - "dev": true + "integrity": "sha512-gvVzJFlPycKc5dZN4yPkP8w7Dc37BtP1yczEneOb4uq34pXZcvrtRTmWV8W+Ume+XCxKgbjM+nevkyFPMybd4Q==" }, "node_modules/wrap-ansi": { "version": "6.2.0", @@ -30562,7 +30614,6 @@ "version": "7.0.0", "resolved": "https://registry.npmjs.org/wrap-ansi/-/wrap-ansi-7.0.0.tgz", "integrity": "sha512-YVGIj2kamLSTxw6NsZjoBxfSwsn0ycdesmc4p+Q21c5zPuZ1pl+NfxVdxPtdHvmNVOQ6XSYG4AUtyt/Fi7D16Q==", - "dev": true, "dependencies": { "ansi-styles": "^4.0.0", "string-width": "^4.1.0", @@ -30579,7 +30630,6 @@ "version": "4.3.0", "resolved": "https://registry.npmjs.org/ansi-styles/-/ansi-styles-4.3.0.tgz", "integrity": "sha512-zbB9rCJAT1rbjiVDb2hqKFHNYLxgtk8NURxZ3IZwD3F6NtxbXZQCnnSi1Lkx+IDohdPlFp222wVALIheZJQSEg==", - "dev": true, "dependencies": { "color-convert": "^2.0.1" }, @@ -30594,7 +30644,6 @@ "version": "2.0.1", "resolved": "https://registry.npmjs.org/color-convert/-/color-convert-2.0.1.tgz", "integrity": "sha512-RRECPsj7iu/xb5oKYcsFHSppFNnsj/52OVTRKb4zP5onXwVF3zVmmToNcOfGC+CRDpfK/U584fMg38ZHCaElKQ==", - "dev": true, "dependencies": { "color-name": "~1.1.4" }, @@ -30605,8 +30654,7 @@ "node_modules/wrap-ansi-cjs/node_modules/color-name": { "version": "1.1.4", "resolved": "https://registry.npmjs.org/color-name/-/color-name-1.1.4.tgz", - "integrity": "sha512-dOy+3AuW3a2wNbZHIuMZpTcgjGuLU/uBL/ubcZF9OXbDo8ff4O8yVp5Bf0efS8uEoYo5q4Fx7dY9OgQGXgAsQA==", - "dev": true + "integrity": "sha512-dOy+3AuW3a2wNbZHIuMZpTcgjGuLU/uBL/ubcZF9OXbDo8ff4O8yVp5Bf0efS8uEoYo5q4Fx7dY9OgQGXgAsQA==" }, "node_modules/wrap-ansi/node_modules/ansi-styles": { "version": "4.3.0", @@ -30795,7 +30843,6 @@ "version": "0.3.0", "resolved": "https://registry.npmjs.org/yamljs/-/yamljs-0.3.0.tgz", "integrity": "sha512-C/FsVVhht4iPQYXOInoxUM/1ELSf9EsgKH34FofQOp6hwCPrW4vG4w5++TED3xRUo8gD7l0P1J1dLlDYzODsTQ==", - "dev": true, "dependencies": { "argparse": "^1.0.7", "glob": "^7.0.5" @@ -30910,6 +30957,7 @@ "@babel/polyfill": "^7.4.4", "@xmldom/xmldom": "^0.8.10", "bcryptjs": "^2.4.3", + "chalk": "^2.4.1", "cors": "^2.8.5", "express": "^4.18.2", "form-data": "^4.0.0", @@ -30929,6 +30977,7 @@ "reflect-metadata": "^0.2.1", "swagger-ui-express": "^5.0.0", "tslib": "^2.6.2", + "tsoa": "^6.0.0", "tsyringe": "^4.8.0", "uuid": "^8.3.2", "winston": "^3.11.0", @@ -33188,7 +33237,6 @@ "version": "8.0.2", "resolved": "https://registry.npmjs.org/@isaacs/cliui/-/cliui-8.0.2.tgz", "integrity": "sha512-O8jcjabXaleOG9DQ0+ARXWZBTfnP4WNAqzuiJK7ll44AmxGKv/J2M4TPjxjY3znBCfvBXFzucm1twdyFybFqEA==", - "dev": true, "requires": { "string-width": "^5.1.2", "string-width-cjs": "npm:string-width@^4.2.0", @@ -33201,26 +33249,22 @@ "ansi-regex": { "version": "6.0.1", "resolved": "https://registry.npmjs.org/ansi-regex/-/ansi-regex-6.0.1.tgz", - "integrity": "sha512-n5M855fKb2SsfMIiFFoVrABHJC8QtHwVx+mHWP3QcEqBHYienj5dHSgjbxtC0WEZXYt4wcD6zrQElDPhFuZgfA==", - "dev": true + "integrity": "sha512-n5M855fKb2SsfMIiFFoVrABHJC8QtHwVx+mHWP3QcEqBHYienj5dHSgjbxtC0WEZXYt4wcD6zrQElDPhFuZgfA==" }, "ansi-styles": { "version": "6.2.1", "resolved": "https://registry.npmjs.org/ansi-styles/-/ansi-styles-6.2.1.tgz", - "integrity": "sha512-bN798gFfQX+viw3R7yrGWRqnrN2oRkEkUjjl4JNn4E8GxxbjtG3FbrEIIY3l8/hrwUwIeCZvi4QuOTP4MErVug==", - "dev": true + "integrity": "sha512-bN798gFfQX+viw3R7yrGWRqnrN2oRkEkUjjl4JNn4E8GxxbjtG3FbrEIIY3l8/hrwUwIeCZvi4QuOTP4MErVug==" }, "emoji-regex": { "version": "9.2.2", "resolved": "https://registry.npmjs.org/emoji-regex/-/emoji-regex-9.2.2.tgz", - "integrity": "sha512-L18DaJsXSUk2+42pv8mLs5jJT2hqFkFE4j21wOmgbUqsZ2hL72NsUU785g9RXgo3s0ZNgVl42TiHp3ZtOv/Vyg==", - "dev": true + "integrity": "sha512-L18DaJsXSUk2+42pv8mLs5jJT2hqFkFE4j21wOmgbUqsZ2hL72NsUU785g9RXgo3s0ZNgVl42TiHp3ZtOv/Vyg==" }, "string-width": { "version": "5.1.2", "resolved": "https://registry.npmjs.org/string-width/-/string-width-5.1.2.tgz", "integrity": "sha512-HnLOCR3vjcY8beoNLtcjZ5/nxn2afmME6lhrDrebokqMap+XbeW8n9TXpPDOqdGK5qcI3oT0GKTW6wC7EMiVqA==", - "dev": true, "requires": { "eastasianwidth": "^0.2.0", "emoji-regex": "^9.2.2", @@ -33231,7 +33275,6 @@ "version": "7.1.0", "resolved": "https://registry.npmjs.org/strip-ansi/-/strip-ansi-7.1.0.tgz", "integrity": "sha512-iq6eVVI64nQQTRYq2KtEg2d2uU7LElhTJwsH4YzIHZshxlgZms/wIc4VoDQTlG/IvVIrBKG06CrZnp0qv7hkcQ==", - "dev": true, "requires": { "ansi-regex": "^6.0.1" } @@ -33240,7 +33283,6 @@ "version": "8.1.0", "resolved": "https://registry.npmjs.org/wrap-ansi/-/wrap-ansi-8.1.0.tgz", "integrity": "sha512-si7QWI6zUMq56bESFvagtmzMdGOtoxfR+Sez11Mobfc7tm+VkUckk9bW2UeffTGVUbOksxmSw0AA2gs8g71NCQ==", - "dev": true, "requires": { "ansi-styles": "^6.1.0", "string-width": "^5.0.1", @@ -34789,9 +34831,14 @@ "version": "0.11.0", "resolved": "https://registry.npmjs.org/@pkgjs/parseargs/-/parseargs-0.11.0.tgz", "integrity": "sha512-+1VkjdD0QBLPodGrJUeqarH8VAIvQODIbwh9XpP5Syisf7YoQgsJKPNFoqqLQlu+VQ/tVSshMR6loPMn8U+dPg==", - "dev": true, "optional": true }, + "@pkgr/core": { + "version": "0.1.0", + "resolved": "https://registry.npmjs.org/@pkgr/core/-/core-0.1.0.tgz", + "integrity": "sha512-Zwq5OCzuwJC2jwqmpEQt7Ds1DTi6BWSwoGkbb1n9pO3hzb35BoJELx7c0T23iDkBGkh2e7tvOtjF3tr3OaQHDQ==", + "dev": true + }, "@pnpm/config.env-replace": { "version": "1.1.0", "resolved": "https://registry.npmjs.org/@pnpm/config.env-replace/-/config.env-replace-1.1.0.tgz", @@ -35395,7 +35442,6 @@ "version": "6.0.0", "resolved": "https://registry.npmjs.org/@tsoa/cli/-/cli-6.0.0.tgz", "integrity": "sha512-Pzzg3sWkcalYEKzzNnvX8iAu7X19FxeN79yBjvCvR8h6Q5qvfO2UqlifSIZdZd6rPOoxaIuYEU8C5sBupI6+sg==", - "dev": true, "requires": { "@tsoa/runtime": "^6.0.0", "@types/multer": "^1.4.11", @@ -35415,7 +35461,6 @@ "version": "11.2.0", "resolved": "https://registry.npmjs.org/fs-extra/-/fs-extra-11.2.0.tgz", "integrity": "sha512-PmDi3uwK5nFuXh7XDTlVnS17xJS7vW36is2+w3xcv8SVxiB4NyATf4ctkVY5bkSjX0Y4nbvZCq1/EjtEyr9ktw==", - "dev": true, "requires": { "graceful-fs": "^4.2.0", "jsonfile": "^6.0.1", @@ -35426,7 +35471,6 @@ "version": "10.3.10", "resolved": "https://registry.npmjs.org/glob/-/glob-10.3.10.tgz", "integrity": "sha512-fa46+tv1Ak0UPK1TOy/pZrIybNNt4HCv7SDzwyfiOZkvZLEbjsZkJBPtDHVshZjbecAoAGSC20MjLDG/qr679g==", - "dev": true, "requires": { "foreground-child": "^3.1.0", "jackspeak": "^2.3.5", @@ -35439,7 +35483,6 @@ "version": "6.1.0", "resolved": "https://registry.npmjs.org/jsonfile/-/jsonfile-6.1.0.tgz", "integrity": "sha512-5dgndWOriYSm5cnYaJNhalLNDKOqFwyDB/rr1E9ZsGciGvKPs8R2xYGCacuf3z6K1YKDz182fd+fY3cn3pMqXQ==", - "dev": true, "requires": { "graceful-fs": "^4.1.6", "universalify": "^2.0.0" @@ -35448,14 +35491,12 @@ "typescript": { "version": "5.3.3", "resolved": "https://registry.npmjs.org/typescript/-/typescript-5.3.3.tgz", - "integrity": "sha512-pXWcraxM0uxAS+tN0AG/BF2TyqmHO014Z070UsJ+pFvYuRSq8KH8DmWpnbXe0pEPDHXZV3FcAbJkijJ5oNEnWw==", - "dev": true + "integrity": "sha512-pXWcraxM0uxAS+tN0AG/BF2TyqmHO014Z070UsJ+pFvYuRSq8KH8DmWpnbXe0pEPDHXZV3FcAbJkijJ5oNEnWw==" }, "universalify": { "version": "2.0.1", "resolved": "https://registry.npmjs.org/universalify/-/universalify-2.0.1.tgz", - "integrity": "sha512-gptHNQghINnc/vTGIk0SOFGFNXw7JVrlRUtConJRlvaw6DuX0wO5Jeko9sWrMBhh+PsYAZ7oXAiOnf/UKogyiw==", - "dev": true + "integrity": "sha512-gptHNQghINnc/vTGIk0SOFGFNXw7JVrlRUtConJRlvaw6DuX0wO5Jeko9sWrMBhh+PsYAZ7oXAiOnf/UKogyiw==" } } }, @@ -35463,7 +35504,6 @@ "version": "6.0.0", "resolved": "https://registry.npmjs.org/@tsoa/runtime/-/runtime-6.0.0.tgz", "integrity": "sha512-n0LYcjII313kDn3M4bZdAjU+sX7595sIEA3bw4pvxWRrkandyDdDFNrfQL8nZ3Pw6dkTmK7brZi0YBBDhe0Rzw==", - "dev": true, "requires": { "@types/multer": "^1.4.11", "reflect-metadata": "^0.2.1", @@ -35550,7 +35590,6 @@ "version": "1.19.5", "resolved": "https://registry.npmjs.org/@types/body-parser/-/body-parser-1.19.5.tgz", "integrity": "sha512-fB3Zu92ucau0iQ0JMCFQE7b/dv8Ot07NI3KaZIkIUNXq82k4eBAqUaneXfleGY9JWskeS9y+u0nXMyspcuQrCg==", - "dev": true, "requires": { "@types/connect": "*", "@types/node": "*" @@ -35578,7 +35617,6 @@ "version": "3.4.38", "resolved": "https://registry.npmjs.org/@types/connect/-/connect-3.4.38.tgz", "integrity": "sha512-K6uROf1LD88uDQqJCktA4yzL1YYAK6NgfsI0v/mTgyPKWsX1CnJ0XPSDhViejru1GcRkLWb8RlzFYJRqGUbaug==", - "dev": true, "requires": { "@types/node": "*" } @@ -35652,7 +35690,6 @@ "version": "4.17.21", "resolved": "https://registry.npmjs.org/@types/express/-/express-4.17.21.tgz", "integrity": "sha512-ejlPM315qwLpaQlQDTjPdsUFSc6ZsP4AN6AlWnogPjQ7CVi7PYF3YVz+CY3jE2pwYf7E/7HlDAN0rV2GxTG0HQ==", - "dev": true, "requires": { "@types/body-parser": "*", "@types/express-serve-static-core": "^4.17.33", @@ -35664,7 +35701,6 @@ "version": "4.17.41", "resolved": "https://registry.npmjs.org/@types/express-serve-static-core/-/express-serve-static-core-4.17.41.tgz", "integrity": "sha512-OaJ7XLaelTgrvlZD8/aa0vvvxZdUmlCn6MtWeB7TkiKW70BQLc9XEPpDLPdbo52ZhXUCrznlWdCHWxJWtdyajA==", - "dev": true, "requires": { "@types/node": "*", "@types/qs": "*", @@ -35684,8 +35720,7 @@ "@types/http-errors": { "version": "2.0.4", "resolved": "https://registry.npmjs.org/@types/http-errors/-/http-errors-2.0.4.tgz", - "integrity": "sha512-D0CFMMtydbJAegzOyHjtiKPLlvnm3iTZyZRSZoLq2mRhDdmLfIWOCYPfQJ4cu2erKghU++QvjcUjp/5h7hESpA==", - "dev": true + "integrity": "sha512-D0CFMMtydbJAegzOyHjtiKPLlvnm3iTZyZRSZoLq2mRhDdmLfIWOCYPfQJ4cu2erKghU++QvjcUjp/5h7hESpA==" }, "@types/http-proxy": { "version": "1.17.14", @@ -35778,8 +35813,7 @@ "@types/mime": { "version": "1.3.5", "resolved": "https://registry.npmjs.org/@types/mime/-/mime-1.3.5.tgz", - "integrity": "sha512-/pyBZWSLD2n0dcHE3hq8s8ZvcETHtEuF+3E7XVt0Ig2nvsVQXdghHVcEkIWjy9A0wKfTn97a/PSDYohKIlnP/w==", - "dev": true + "integrity": "sha512-/pyBZWSLD2n0dcHE3hq8s8ZvcETHtEuF+3E7XVt0Ig2nvsVQXdghHVcEkIWjy9A0wKfTn97a/PSDYohKIlnP/w==" }, "@types/mkdirp": { "version": "1.0.2", @@ -35802,7 +35836,6 @@ "version": "1.4.11", "resolved": "https://registry.npmjs.org/@types/multer/-/multer-1.4.11.tgz", "integrity": "sha512-svK240gr6LVWvv3YGyhLlA+6LRRWA4mnGIU7RcNmgjBYFl6665wcXrRfxGp5tEPVHUNm5FMcmq7too9bxCwX/w==", - "dev": true, "requires": { "@types/express": "*" } @@ -35859,14 +35892,12 @@ "@types/qs": { "version": "6.9.11", "resolved": "https://registry.npmjs.org/@types/qs/-/qs-6.9.11.tgz", - "integrity": "sha512-oGk0gmhnEJK4Yyk+oI7EfXsLayXatCWPHary1MtcmbAifkobT9cM9yutG/hZKIseOU0MqbIwQ/u2nn/Gb+ltuQ==", - "dev": true + "integrity": "sha512-oGk0gmhnEJK4Yyk+oI7EfXsLayXatCWPHary1MtcmbAifkobT9cM9yutG/hZKIseOU0MqbIwQ/u2nn/Gb+ltuQ==" }, "@types/range-parser": { "version": "1.2.7", "resolved": "https://registry.npmjs.org/@types/range-parser/-/range-parser-1.2.7.tgz", - "integrity": "sha512-hKormJbkJqzQGhziax5PItDUTMAM9uE2XXQmM37dyd4hVM+5aVl7oVxMVUiVQn2oCQFN/LKCZdvSM0pFRqbSmQ==", - "dev": true + "integrity": "sha512-hKormJbkJqzQGhziax5PItDUTMAM9uE2XXQmM37dyd4hVM+5aVl7oVxMVUiVQn2oCQFN/LKCZdvSM0pFRqbSmQ==" }, "@types/resolve": { "version": "1.20.2", @@ -35888,7 +35919,6 @@ "version": "0.17.4", "resolved": "https://registry.npmjs.org/@types/send/-/send-0.17.4.tgz", "integrity": "sha512-x2EM6TJOybec7c52BX0ZspPodMsQUd5L6PRwOunVyVUhXiBSKf3AezDL8Dgvgt5o0UfKNfuA0eMLr2wLT4AiBA==", - "dev": true, "requires": { "@types/mime": "^1", "@types/node": "*" @@ -35907,7 +35937,6 @@ "version": "1.15.5", "resolved": "https://registry.npmjs.org/@types/serve-static/-/serve-static-1.15.5.tgz", "integrity": "sha512-PDRk21MnK70hja/YF8AHfC7yIsiQHn1rcXx7ijCFBX/k+XQJhQT/gw3xekXKJvx+5SXaMMS8oqQy09Mzvz2TuQ==", - "dev": true, "requires": { "@types/http-errors": "*", "@types/mime": "*", @@ -36647,6 +36676,7 @@ "@babel/polyfill": "^7.4.4", "@xmldom/xmldom": "^0.8.10", "bcryptjs": "^2.4.3", + "chalk": "^2.4.1", "cors": "^2.8.5", "express": "^4.18.2", "form-data": "^4.0.0", @@ -36666,6 +36696,7 @@ "reflect-metadata": "^0.2.1", "swagger-ui-express": "^5.0.0", "tslib": "^2.6.2", + "tsoa": "^6.0.0", "tsyringe": "^4.8.0", "uuid": "^8.3.2", "winston": "^3.11.0", @@ -36874,7 +36905,6 @@ "version": "1.0.10", "resolved": "https://registry.npmjs.org/argparse/-/argparse-1.0.10.tgz", "integrity": "sha512-o5Roy6tNG4SL/FOkCAN6RzjiakZS25RLYFrcMttJqbdd8BWrnA+fGz57iN5Pb06pvBGvl5gQ0B48dJlslXvoTg==", - "dev": true, "requires": { "sprintf-js": "~1.0.2" } @@ -38500,7 +38530,6 @@ "version": "7.0.3", "resolved": "https://registry.npmjs.org/cross-spawn/-/cross-spawn-7.0.3.tgz", "integrity": "sha512-iRDPJKUPVEND7dHPO8rkbOnPpyDygcDFtWjpeWNCgy8WP2rXcxXL8TskReQl6OrB2G7+UJrags1q15Fudc7G6w==", - "dev": true, "requires": { "path-key": "^3.1.0", "shebang-command": "^2.0.0", @@ -38627,8 +38656,7 @@ "deepmerge": { "version": "4.3.1", "resolved": "https://registry.npmjs.org/deepmerge/-/deepmerge-4.3.1.tgz", - "integrity": "sha512-3sUqbMEc77XqpdNO7FRyRog+eW3ph+GYCbj+rK+uYyRMuwsVy0rMiVtPn+QJlKFvWP/1PYpapqYn0Me2knFn+A==", - "dev": true + "integrity": "sha512-3sUqbMEc77XqpdNO7FRyRog+eW3ph+GYCbj+rK+uYyRMuwsVy0rMiVtPn+QJlKFvWP/1PYpapqYn0Me2knFn+A==" }, "default-gateway": { "version": "6.0.3", @@ -38887,8 +38915,7 @@ "eastasianwidth": { "version": "0.2.0", "resolved": "https://registry.npmjs.org/eastasianwidth/-/eastasianwidth-0.2.0.tgz", - "integrity": "sha512-I88TYZWc9XiYHRQ4/3c5rjjfgkjhLyW2luGIheGERbNQ6OY7yTybanSpDXZa8y7VUP9YmDcYa+eyq4ca7iLqWA==", - "dev": true + "integrity": "sha512-I88TYZWc9XiYHRQ4/3c5rjjfgkjhLyW2luGIheGERbNQ6OY7yTybanSpDXZa8y7VUP9YmDcYa+eyq4ca7iLqWA==" }, "easy-extender": { "version": "2.3.4", @@ -39543,6 +39570,13 @@ } } }, + "eslint-config-prettier": { + "version": "9.1.0", + "resolved": "https://registry.npmjs.org/eslint-config-prettier/-/eslint-config-prettier-9.1.0.tgz", + "integrity": "sha512-NSWl5BFQWEPi1j4TjVNItzYV7dZXZ+wP6I6ZhrBGpChQhZRUaElihE9uRRkcbRnNb76UMKDF3r+WTmNcGPKsqw==", + "dev": true, + "requires": {} + }, "eslint-etc": { "version": "5.2.1", "resolved": "https://registry.npmjs.org/eslint-etc/-/eslint-etc-5.2.1.tgz", @@ -39554,6 +39588,16 @@ "tsutils-etc": "^1.4.1" } }, + "eslint-plugin-prettier": { + "version": "5.1.3", + "resolved": "https://registry.npmjs.org/eslint-plugin-prettier/-/eslint-plugin-prettier-5.1.3.tgz", + "integrity": "sha512-C9GCVAs4Eq7ZC/XFQHITLiHJxQngdtraXaM+LoUFoFp/lHNl2Zn8f3WQbe9HvTBBQ9YnKFB0/2Ajdqwo5D1EAw==", + "dev": true, + "requires": { + "prettier-linter-helpers": "^1.0.0", + "synckit": "^0.8.6" + } + }, "eslint-scope": { "version": "8.0.0", "resolved": "https://registry.npmjs.org/eslint-scope/-/eslint-scope-8.0.0.tgz", @@ -39844,6 +39888,12 @@ "resolved": "https://registry.npmjs.org/fast-deep-equal/-/fast-deep-equal-3.1.3.tgz", "integrity": "sha512-f3qQ9oQy9j2AhBe/H9VC91wLmKBCCU/gDOnKNAYG5hswO7BLKj09Hc5HYNz9cGI++xlpDCIgDaitVs03ATR84Q==" }, + "fast-diff": { + "version": "1.3.0", + "resolved": "https://registry.npmjs.org/fast-diff/-/fast-diff-1.3.0.tgz", + "integrity": "sha512-VxPP4NqbUjj6MaAOafWeUn2cXWLcCtljklUtZf0Ind4XQ+QPtmA0b18zZy0jIQx+ExRVCR/ZQpBmik5lXshNsw==", + "dev": true + }, "fast-glob": { "version": "3.3.1", "resolved": "https://registry.npmjs.org/fast-glob/-/fast-glob-3.3.1.tgz", @@ -40133,7 +40183,6 @@ "version": "3.1.1", "resolved": "https://registry.npmjs.org/foreground-child/-/foreground-child-3.1.1.tgz", "integrity": "sha512-TMKDUnIte6bfb5nWv7V/caI169OHgvwjb7V4WkeUvbQQdjr5rWKqHFiKWb/fcOwB+CzBT+qbWjvj+DVwRskpIg==", - "dev": true, "requires": { "cross-spawn": "^7.0.0", "signal-exit": "^4.0.1" @@ -40142,8 +40191,7 @@ "signal-exit": { "version": "4.1.0", "resolved": "https://registry.npmjs.org/signal-exit/-/signal-exit-4.1.0.tgz", - "integrity": "sha512-bzyZ1e88w9O1iNJbKnOlvYTrWPDl46O1bG0D3XInv+9tkPrxrN8jUUTiFlDkkmKWgn1M6CfIA13SuGqOa9Korw==", - "dev": true + "integrity": "sha512-bzyZ1e88w9O1iNJbKnOlvYTrWPDl46O1bG0D3XInv+9tkPrxrN8jUUTiFlDkkmKWgn1M6CfIA13SuGqOa9Korw==" } } }, @@ -40450,7 +40498,6 @@ "version": "4.7.8", "resolved": "https://registry.npmjs.org/handlebars/-/handlebars-4.7.8.tgz", "integrity": "sha512-vafaFqs8MZkRrSX7sFVUdo3ap/eNiLnb4IakshzvP56X5Nr1iGKAIqdX6tMlm6HcNRIkr6AxO5jFEoJzzpT8aQ==", - "dev": true, "requires": { "minimist": "^1.2.5", "neo-async": "^2.6.2", @@ -40462,8 +40509,7 @@ "source-map": { "version": "0.6.1", "resolved": "https://registry.npmjs.org/source-map/-/source-map-0.6.1.tgz", - "integrity": "sha512-UjgapumWlbMhkBgzT7Ykc5YXUT46F0iKu8SGXq0bcwP5dz/h0Plj6enJqjz1Zbq2l5WaqYnrVbwWOWMyF3F47g==", - "dev": true + "integrity": "sha512-UjgapumWlbMhkBgzT7Ykc5YXUT46F0iKu8SGXq0bcwP5dz/h0Plj6enJqjz1Zbq2l5WaqYnrVbwWOWMyF3F47g==" } } }, @@ -41137,8 +41183,7 @@ "isexe": { "version": "2.0.0", "resolved": "https://registry.npmjs.org/isexe/-/isexe-2.0.0.tgz", - "integrity": "sha512-RHxMLp9lnKHGHRng9QFhRCMbYAcVpn69smSGcq3f36xjgVVWThj4qqLbTLlq7Ssj8B+fIQ1EuCEGI2lKsyQeIw==", - "dev": true + "integrity": "sha512-RHxMLp9lnKHGHRng9QFhRCMbYAcVpn69smSGcq3f36xjgVVWThj4qqLbTLlq7Ssj8B+fIQ1EuCEGI2lKsyQeIw==" }, "isobject": { "version": "3.0.1", @@ -41256,7 +41301,6 @@ "version": "2.3.6", "resolved": "https://registry.npmjs.org/jackspeak/-/jackspeak-2.3.6.tgz", "integrity": "sha512-N3yCS/NegsOBokc8GAdM8UcmfsKiSS8cipheD/nivzr700H+nsMOxJjQnvwOcRYVuFkdH0wGUvW2WbXGmrZGbQ==", - "dev": true, "requires": { "@isaacs/cliui": "^8.0.2", "@pkgjs/parseargs": "^0.11.0" @@ -43716,7 +43760,6 @@ "version": "5.1.7", "resolved": "https://registry.npmjs.org/merge-anything/-/merge-anything-5.1.7.tgz", "integrity": "sha512-eRtbOb1N5iyH0tkQDAoQ4Ipsp/5qSR79Dzrz8hEPxRX10RWWR/iQXdoKmBSRCThY1Fh5EhISDtpSc93fpxUniQ==", - "dev": true, "requires": { "is-what": "^4.1.8" }, @@ -43724,8 +43767,7 @@ "is-what": { "version": "4.1.16", "resolved": "https://registry.npmjs.org/is-what/-/is-what-4.1.16.tgz", - "integrity": "sha512-ZhMwEosbFJkA0YhFnNDgTM4ZxDRsS6HqTo7qsZM08fehyRYIYa0yHu5R6mgo1n/8MgaPBXiPimPD77baVFYg+A==", - "dev": true + "integrity": "sha512-ZhMwEosbFJkA0YhFnNDgTM4ZxDRsS6HqTo7qsZM08fehyRYIYa0yHu5R6mgo1n/8MgaPBXiPimPD77baVFYg+A==" } } }, @@ -43818,7 +43860,6 @@ "version": "9.0.3", "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-9.0.3.tgz", "integrity": "sha512-RHiac9mvaRw0x3AYRgDC1CxAP7HTcNrrECeA8YYJeWnpo+2Q5CegtZjaotWTWxDG3UeGA1coE05iH1mPjT/2mg==", - "dev": true, "requires": { "brace-expansion": "^2.0.1" } @@ -43831,8 +43872,7 @@ "minipass": { "version": "7.0.4", "resolved": "https://registry.npmjs.org/minipass/-/minipass-7.0.4.tgz", - "integrity": "sha512-jYofLM5Dam9279rdkWzqHozUo4ybjdZmCsDHePy5V/PbBcVMiSZR97gmAy45aqi8CK1lG2ECd356FU86avfwUQ==", - "dev": true + "integrity": "sha512-jYofLM5Dam9279rdkWzqHozUo4ybjdZmCsDHePy5V/PbBcVMiSZR97gmAy45aqi8CK1lG2ECd356FU86avfwUQ==" }, "minipass-collect": { "version": "2.0.1", @@ -44222,8 +44262,7 @@ "neo-async": { "version": "2.6.2", "resolved": "https://registry.npmjs.org/neo-async/-/neo-async-2.6.2.tgz", - "integrity": "sha512-Yd3UES5mWCSqR+qNT93S3UoYUkqAZ9lLg8a7g9rimsWmYGK8cVToA4/sF3RrshdyV3sAGMXVUmpMYOw+dLpOuw==", - "dev": true + "integrity": "sha512-Yd3UES5mWCSqR+qNT93S3UoYUkqAZ9lLg8a7g9rimsWmYGK8cVToA4/sF3RrshdyV3sAGMXVUmpMYOw+dLpOuw==" }, "nerf-dart": { "version": "1.0.0", @@ -49189,8 +49228,7 @@ "path-key": { "version": "3.1.1", "resolved": "https://registry.npmjs.org/path-key/-/path-key-3.1.1.tgz", - "integrity": "sha512-ojmeN0qd+y0jszEtoY48r0Peq5dwMEkIlCOu6Q5f41lfkswXuKtYrhgoTpLnyIcHm24Uhqx+5Tqm2InSwLhE6Q==", - "dev": true + "integrity": "sha512-ojmeN0qd+y0jszEtoY48r0Peq5dwMEkIlCOu6Q5f41lfkswXuKtYrhgoTpLnyIcHm24Uhqx+5Tqm2InSwLhE6Q==" }, "path-parse": { "version": "1.0.7", @@ -49208,7 +49246,6 @@ "version": "1.10.1", "resolved": "https://registry.npmjs.org/path-scurry/-/path-scurry-1.10.1.tgz", "integrity": "sha512-MkhCqzzBEpPvxxQ71Md0b1Kk51W01lrYvlMzSUaIzNsODdd7mqhiimSZlr+VegAz5Z6Vzt9Xg2ttE//XBhH3EQ==", - "dev": true, "requires": { "lru-cache": "^9.1.1 || ^10.0.0", "minipass": "^5.0.0 || ^6.0.2 || ^7.0.0" @@ -49217,8 +49254,7 @@ "lru-cache": { "version": "10.1.0", "resolved": "https://registry.npmjs.org/lru-cache/-/lru-cache-10.1.0.tgz", - "integrity": "sha512-/1clY/ui8CzjKFyjdvwPWJUYKiFVXG2I2cY0ssG7h4+hwk+XOIX7ZSG9Q7TW8TW3Kp3BUSqgFWBLgL4PJ+Blag==", - "dev": true + "integrity": "sha512-/1clY/ui8CzjKFyjdvwPWJUYKiFVXG2I2cY0ssG7h4+hwk+XOIX7ZSG9Q7TW8TW3Kp3BUSqgFWBLgL4PJ+Blag==" } } }, @@ -49584,6 +49620,21 @@ "integrity": "sha512-vkcDPrRZo1QZLbn5RLGPpg/WmIQ65qoWWhcGKf/b5eplkkarX0m9z8ppCat4mlOqUsWpyNuYgO3VRyrYHSzX5g==", "dev": true }, + "prettier": { + "version": "3.1.1", + "resolved": "https://registry.npmjs.org/prettier/-/prettier-3.1.1.tgz", + "integrity": "sha512-22UbSzg8luF4UuZtzgiUOfcGM8s4tjBv6dJRT7j275NXsy2jb4aJa4NNveul5x4eqlF1wuhuR2RElK71RvmVaw==", + "dev": true + }, + "prettier-linter-helpers": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/prettier-linter-helpers/-/prettier-linter-helpers-1.0.0.tgz", + "integrity": "sha512-GbK2cP9nraSSUF9N2XwUwqfzlAFlMNYYl+ShE/V+H8a9uNl/oUqB1w2EL54Jh0OlyRSd8RfWYJ3coVS4TROP2w==", + "dev": true, + "requires": { + "fast-diff": "^1.1.2" + } + }, "pretty-bytes": { "version": "5.6.0", "resolved": "https://registry.npmjs.org/pretty-bytes/-/pretty-bytes-5.6.0.tgz", @@ -50816,7 +50867,6 @@ "version": "2.0.0", "resolved": "https://registry.npmjs.org/shebang-command/-/shebang-command-2.0.0.tgz", "integrity": "sha512-kHxr2zZpYtdmrN1qDjrrX/Z1rR1kG8Dx+gkpK1G4eXmvXswmcE1hTWBWYUzlraYw1/yZp6YuDY77YtvbN0dmDA==", - "dev": true, "requires": { "shebang-regex": "^3.0.0" } @@ -50824,8 +50874,7 @@ "shebang-regex": { "version": "3.0.0", "resolved": "https://registry.npmjs.org/shebang-regex/-/shebang-regex-3.0.0.tgz", - "integrity": "sha512-7++dFhtcx3353uBaq8DDR4NuxBetBzC7ZQOhmTQInHEd6bSrXdiEyzCvG07Z44UYdLShWUyXt5M/yhz8ekcb1A==", - "dev": true + "integrity": "sha512-7++dFhtcx3353uBaq8DDR4NuxBetBzC7ZQOhmTQInHEd6bSrXdiEyzCvG07Z44UYdLShWUyXt5M/yhz8ekcb1A==" }, "shell-quote": { "version": "1.8.1", @@ -51163,8 +51212,7 @@ "sprintf-js": { "version": "1.0.3", "resolved": "https://registry.npmjs.org/sprintf-js/-/sprintf-js-1.0.3.tgz", - "integrity": "sha512-D9cPgkvLlV3t3IzL0D0YLvGA9Ahk4PcvVwUbN0dSGr1aP0Nrt4AEnTUbuGvquEC0mA64Gqt1fzirlRs5ibXx8g==", - "dev": true + "integrity": "sha512-D9cPgkvLlV3t3IzL0D0YLvGA9Ahk4PcvVwUbN0dSGr1aP0Nrt4AEnTUbuGvquEC0mA64Gqt1fzirlRs5ibXx8g==" }, "sqlstring": { "version": "2.3.3", @@ -51352,7 +51400,6 @@ "version": "npm:string-width@4.2.3", "resolved": "https://registry.npmjs.org/string-width/-/string-width-4.2.3.tgz", "integrity": "sha512-wKyQRQpjJ0sIp62ErSZdGsjMJWsap5oRNihHhu6G7JVO/9jIB6UyevL+tXuOqrng8j/cxKTWyWUwvSTriiZz/g==", - "dev": true, "requires": { "emoji-regex": "^8.0.0", "is-fullwidth-code-point": "^3.0.0", @@ -51371,7 +51418,6 @@ "version": "npm:strip-ansi@6.0.1", "resolved": "https://registry.npmjs.org/strip-ansi/-/strip-ansi-6.0.1.tgz", "integrity": "sha512-Y38VPSHcqkFrCpFnQ9vuSXmquuv5oXOKpGeT6aGrr3o3Gc9AlVa6JBfUSOCnbxGGZF+/0ooI7KrPuUSztUdU5A==", - "dev": true, "requires": { "ansi-regex": "^5.0.1" } @@ -51516,6 +51562,16 @@ "integrity": "sha512-b19dMThMV4HVFynSAM1++gBHAbk2Tc/osgLIBZMKsyqh34jb2e8Os7T6ZW/Bt3pJFdBTd2JwAnAAEQV7rSNvcQ==", "dev": true }, + "synckit": { + "version": "0.8.8", + "resolved": "https://registry.npmjs.org/synckit/-/synckit-0.8.8.tgz", + "integrity": "sha512-HwOKAP7Wc5aRGYdKH+dw0PRRpbO841v2DENBtjnR5HFWoiNByAl7vrx3p0G/rCyYXQsrxqtX48TImFtPcIHSpQ==", + "dev": true, + "requires": { + "@pkgr/core": "^0.1.0", + "tslib": "^2.6.2" + } + }, "tapable": { "version": "2.2.1", "resolved": "https://registry.npmjs.org/tapable/-/tapable-2.2.1.tgz", @@ -51987,7 +52043,6 @@ "version": "6.0.0", "resolved": "https://registry.npmjs.org/tsoa/-/tsoa-6.0.0.tgz", "integrity": "sha512-D8Kvp3wUhZwpX13hXptqKdk/2VMqg+t8SLeZDiRwv5XiOv39YJbt0F+6DEeyIBW6cC6vBYKD1Cs+cUXoY1VKiQ==", - "dev": true, "requires": { "@tsoa/cli": "^6.0.0", "@tsoa/runtime": "^6.0.0" @@ -52112,7 +52167,6 @@ "version": "3.17.4", "resolved": "https://registry.npmjs.org/uglify-js/-/uglify-js-3.17.4.tgz", "integrity": "sha512-T9q82TJI9e/C1TAxYvfb16xO120tMVFZrGA3f9/P4424DNu6ypK103y0GPFVa17yotwSyZW5iYXgjYHkGrJW/g==", - "dev": true, "optional": true }, "undici": { @@ -52335,8 +52389,7 @@ "validator": { "version": "13.11.0", "resolved": "https://registry.npmjs.org/validator/-/validator-13.11.0.tgz", - "integrity": "sha512-Ii+sehpSfZy+At5nPdnyMhx78fEoPDkR2XW/zimHEL3MyGJQOCQ7WeP20jPYRz7ZCpcKLB21NxuXHF3bxjStBQ==", - "dev": true + "integrity": "sha512-Ii+sehpSfZy+At5nPdnyMhx78fEoPDkR2XW/zimHEL3MyGJQOCQ7WeP20jPYRz7ZCpcKLB21NxuXHF3bxjStBQ==" }, "vary": { "version": "1.1.2", @@ -52892,7 +52945,6 @@ "version": "2.0.2", "resolved": "https://registry.npmjs.org/which/-/which-2.0.2.tgz", "integrity": "sha512-BLI3Tl1TW3Pvl70l3yq3Y64i+awpwXqsGBYWkkqMtnbXgrMD+yj7rhW0kuEDxzJaYXGjEW5ogapKNMEKNMjibA==", - "dev": true, "requires": { "isexe": "^2.0.0" } @@ -52986,8 +53038,7 @@ "wordwrap": { "version": "1.0.0", "resolved": "https://registry.npmjs.org/wordwrap/-/wordwrap-1.0.0.tgz", - "integrity": "sha512-gvVzJFlPycKc5dZN4yPkP8w7Dc37BtP1yczEneOb4uq34pXZcvrtRTmWV8W+Ume+XCxKgbjM+nevkyFPMybd4Q==", - "dev": true + "integrity": "sha512-gvVzJFlPycKc5dZN4yPkP8w7Dc37BtP1yczEneOb4uq34pXZcvrtRTmWV8W+Ume+XCxKgbjM+nevkyFPMybd4Q==" }, "wrap-ansi": { "version": "6.2.0", @@ -53030,7 +53081,6 @@ "version": "npm:wrap-ansi@7.0.0", "resolved": "https://registry.npmjs.org/wrap-ansi/-/wrap-ansi-7.0.0.tgz", "integrity": "sha512-YVGIj2kamLSTxw6NsZjoBxfSwsn0ycdesmc4p+Q21c5zPuZ1pl+NfxVdxPtdHvmNVOQ6XSYG4AUtyt/Fi7D16Q==", - "dev": true, "requires": { "ansi-styles": "^4.0.0", "string-width": "^4.1.0", @@ -53041,7 +53091,6 @@ "version": "4.3.0", "resolved": "https://registry.npmjs.org/ansi-styles/-/ansi-styles-4.3.0.tgz", "integrity": "sha512-zbB9rCJAT1rbjiVDb2hqKFHNYLxgtk8NURxZ3IZwD3F6NtxbXZQCnnSi1Lkx+IDohdPlFp222wVALIheZJQSEg==", - "dev": true, "requires": { "color-convert": "^2.0.1" } @@ -53050,7 +53099,6 @@ "version": "2.0.1", "resolved": "https://registry.npmjs.org/color-convert/-/color-convert-2.0.1.tgz", "integrity": "sha512-RRECPsj7iu/xb5oKYcsFHSppFNnsj/52OVTRKb4zP5onXwVF3zVmmToNcOfGC+CRDpfK/U584fMg38ZHCaElKQ==", - "dev": true, "requires": { "color-name": "~1.1.4" } @@ -53058,8 +53106,7 @@ "color-name": { "version": "1.1.4", "resolved": "https://registry.npmjs.org/color-name/-/color-name-1.1.4.tgz", - "integrity": "sha512-dOy+3AuW3a2wNbZHIuMZpTcgjGuLU/uBL/ubcZF9OXbDo8ff4O8yVp5Bf0efS8uEoYo5q4Fx7dY9OgQGXgAsQA==", - "dev": true + "integrity": "sha512-dOy+3AuW3a2wNbZHIuMZpTcgjGuLU/uBL/ubcZF9OXbDo8ff4O8yVp5Bf0efS8uEoYo5q4Fx7dY9OgQGXgAsQA==" } } }, @@ -53175,7 +53222,6 @@ "version": "0.3.0", "resolved": "https://registry.npmjs.org/yamljs/-/yamljs-0.3.0.tgz", "integrity": "sha512-C/FsVVhht4iPQYXOInoxUM/1ELSf9EsgKH34FofQOp6hwCPrW4vG4w5++TED3xRUo8gD7l0P1J1dLlDYzODsTQ==", - "dev": true, "requires": { "argparse": "^1.0.7", "glob": "^7.0.5" diff --git a/package.json b/package.json index ac9d0f7f..652fded1 100644 --- a/package.json +++ b/package.json @@ -9,7 +9,8 @@ "header": "node copyright-header.js", "coverage": "node coverage-summary.js", "user-db": "docker run -p 27017:27017 -d --name aasportal-users -e MONGO_INITDB_DATABASE=aasportal-users mongo", - "lint": "ng lint", + "lint": "npm run lint -ws", + "format": "npm run format -ws", "test": "npm run test -ws", "tsc": "npm run tsc -ws", "build": "npm run build -ws", @@ -122,6 +123,8 @@ "babel-plugin-transform-import-meta": "^2.2.1", "esbuild": "^0.19.11", "eslint": "^8.56.0", + "eslint-config-prettier": "^9.1.0", + "eslint-plugin-prettier": "^5.1.3", "jasmine-core": "^5.1.1", "jest": "^29.7.0", "karma": "^6.4.2", @@ -131,6 +134,7 @@ "karma-jasmine-html-reporter": "^2.1.0", "karma-junit-reporter": "^2.0.1", "ng-packagr": "^17.0.3", + "prettier": "^3.1.1", "rimraf": "^5.0.5", "semantic-release": "^22.0.12", "supertest": "^6.3.3", @@ -138,4 +142,4 @@ "ts-node": "^10.9.2", "typescript": "^5.2.2" } -} \ No newline at end of file +} diff --git a/projects/aas-lib/.eslintrc.json b/projects/aas-lib/.eslintrc.json index f9f1c647..f73abb67 100644 --- a/projects/aas-lib/.eslintrc.json +++ b/projects/aas-lib/.eslintrc.json @@ -1,37 +1,53 @@ { - "extends": "../../.eslintrc.json", - "ignorePatterns": [ - "!**/*" - ], - "overrides": [ - { - "files": [ - "*.ts" - ], - "rules": { - "@angular-eslint/directive-selector": [ - "error", - { - "type": "attribute", - "prefix": "fhg", - "style": "camelCase" - } - ], - "@angular-eslint/component-selector": [ - "error", - { - "type": "element", - "prefix": "fhg", - "style": "kebab-case" - } - ] - } - }, - { - "files": [ - "*.html" - ], - "rules": {} - } - ] -} + "extends": "../../.eslintrc.json", + "ignorePatterns": [ + "!**/*" + ], + "overrides": [ + { + "files": [ + "*.ts" + ], + "extends": [ + "plugin:@angular-eslint/recommended", + "plugin:@angular-eslint/template/process-inline-templates" + ], + "rules": { + "@angular-eslint/directive-selector": [ + "error", + { + "type": "attribute", + "prefix": "fhg", + "style": "camelCase" + } + ], + "@angular-eslint/component-selector": [ + "error", + { + "type": "element", + "prefix": "fhg", + "style": "kebab-case" + } + ] + } + }, + { + "files": [ + "*.html" + ], + "extends": [ + "plugin:@angular-eslint/template/recommended", + "plugin:@angular-eslint/template/accessibility" + ], + "rules": {} + }, + { + "files": [ + "*.ts" + ], + "extends": [ + "plugin:@ngrx/recommended" + ] + } + ] +} \ No newline at end of file diff --git a/projects/aas-lib/src/lib/aas-lib.module.ts b/projects/aas-lib/src/lib/aas-lib.module.ts index 6edf58bd..b67fc9f7 100644 --- a/projects/aas-lib/src/lib/aas-lib.module.ts +++ b/projects/aas-lib/src/lib/aas-lib.module.ts @@ -60,7 +60,7 @@ import { AASTableEffects } from './aas-table/aas-table.effects'; ScoreComponent, DigitalNameplateComponent, MessageTableComponent, - SecuredImageComponent + SecuredImageComponent, ], imports: [ CommonModule, @@ -72,7 +72,7 @@ import { AASTableEffects } from './aas-table/aas-table.effects'; StoreModule.forFeature('aasTable', aasTableReducer), StoreModule.forFeature('tree', aasTreeReducer), EffectsModule.forFeature(AASTableEffects), - HttpClientModule + HttpClientModule, ], exports: [ NotifyComponent, @@ -90,8 +90,8 @@ import { AASTableEffects } from './aas-table/aas-table.effects'; ScoreComponent, DigitalNameplateComponent, MessageTableComponent, - SecuredImageComponent + SecuredImageComponent, ], - providers: [] + providers: [], }) -export class AASLibModule { } \ No newline at end of file +export class AASLibModule {} diff --git a/projects/aas-lib/src/lib/aas-table/aas-table.actions.ts b/projects/aas-lib/src/lib/aas-table/aas-table.actions.ts index e79de017..18a868f5 100644 --- a/projects/aas-lib/src/lib/aas-table/aas-table.actions.ts +++ b/projects/aas-lib/src/lib/aas-table/aas-table.actions.ts @@ -27,33 +27,21 @@ export interface UpdateViewAction extends TypedAction()); +export const setViewMode = createAction(AASTableActionType.SET_VIEW_MODE, props<{ viewMode: ViewMode }>()); -export const updateView = createAction( - AASTableActionType.UPDATE_VIEW, - props<{ documents: AASDocument[] }>()); +export const updateView = createAction(AASTableActionType.UPDATE_VIEW, props<{ documents: AASDocument[] }>()); -export const setRows = createAction( - AASTableActionType.SET_PAGE, - props<{ rows: AASTableRow[] }>()); +export const setRows = createAction(AASTableActionType.SET_PAGE, props<{ rows: AASTableRow[] }>()); export const toggleSelected = createAction( AASTableActionType.TOGGLE_SELECTED, - props<{ row: AASTableRow, altKey: boolean, shiftKey: boolean }>()); + props<{ row: AASTableRow; altKey: boolean; shiftKey: boolean }>(), +); -export const toggleSelections = createAction( - AASTableActionType.TOGGLE_SELECTIONS); +export const toggleSelections = createAction(AASTableActionType.TOGGLE_SELECTIONS); -export const setSelections = createAction( - AASTableActionType.SET_SELECTIONS, - props<{ documents: AASDocument[] }>()); +export const setSelections = createAction(AASTableActionType.SET_SELECTIONS, props<{ documents: AASDocument[] }>()); -export const expandRow = createAction( - AASTableActionType.EXPAND, - props<{ row: AASTableRow }>()); +export const expandRow = createAction(AASTableActionType.EXPAND, props<{ row: AASTableRow }>()); -export const collapseRow = createAction( - AASTableActionType.COLLAPSE, - props<{ row: AASTableRow }>()); +export const collapseRow = createAction(AASTableActionType.COLLAPSE, props<{ row: AASTableRow }>()); diff --git a/projects/aas-lib/src/lib/aas-table/aas-table.component.ts b/projects/aas-lib/src/lib/aas-table/aas-table.component.ts index ae4033e9..8e5ff38d 100644 --- a/projects/aas-lib/src/lib/aas-table/aas-table.component.ts +++ b/projects/aas-lib/src/lib/aas-table/aas-table.component.ts @@ -23,7 +23,7 @@ import { ViewMode } from '../types/view-mode'; @Component({ selector: 'fhg-aas-table', templateUrl: './aas-table.component.html', - styleUrls: ['./aas-table.component.scss'] + styleUrls: ['./aas-table.component.scss'], }) export class AASTableComponent implements OnInit, OnChanges, OnDestroy { private readonly store: Store; @@ -32,19 +32,23 @@ export class AASTableComponent implements OnInit, OnChanges, OnDestroy { private shiftKey = false; private altKey = false; - constructor( + public constructor( private readonly router: Router, store: Store, private readonly clipboard: ClipboardService, - private readonly window: WindowService + private readonly window: WindowService, ) { this.store = store as Store; this.rows = this.store.select(AASTableSelectors.selectRows); this.everySelected = this.store.select(AASTableSelectors.selectEverySelected); this.someSelected = this.store.select(AASTableSelectors.selectSomeSelected); - this.subscription.add(this.store.select(AASTableSelectors.selectSelectedDocuments).pipe() - .subscribe(values => this._selected = values)); + this.subscription.add( + this.store + .select(AASTableSelectors.selectSelectedDocuments) + .pipe() + .subscribe(values => (this._selected = values)), + ); this.window.addEventListener('keyup', this.keyup); this.window.addEventListener('keydown', this.keydown); @@ -77,24 +81,32 @@ export class AASTableComponent implements OnInit, OnChanges, OnDestroy { public readonly rows: Observable; public ngOnInit(): void { - this.subscription.add(this.store.select(AASTableSelectors.selectSelectedDocuments).pipe() - .subscribe(documents => { - this._selected = documents; - this.selectedChange.emit(documents); - })); + this.subscription.add( + this.store + .select(AASTableSelectors.selectSelectedDocuments) + .pipe() + .subscribe(documents => { + this._selected = documents; + this.selectedChange.emit(documents); + }), + ); } public ngOnChanges(changes: SimpleChanges): void { if (changes['viewMode'] && this.viewMode != null) { - this.subscription.add(this.viewMode.subscribe(value => { - this.store.dispatch(AASTableActions.setViewMode({ viewMode: value })); - })); + this.subscription.add( + this.viewMode.subscribe(value => { + this.store.dispatch(AASTableActions.setViewMode({ viewMode: value })); + }), + ); } if (changes['documents'] && this.documents != null) { - this.subscription.add(this.documents.subscribe(values => { - this.store.dispatch(AASTableActions.updateView({ documents: values })); - })); + this.subscription.add( + this.documents.subscribe(values => { + this.store.dispatch(AASTableActions.updateView({ documents: values })); + }), + ); } } @@ -143,4 +155,4 @@ export class AASTableComponent implements OnInit, OnChanges, OnDestroy { this.shiftKey = event.shiftKey; this.altKey = event.altKey; }; -} \ No newline at end of file +} diff --git a/projects/aas-lib/src/lib/aas-table/aas-table.effects.ts b/projects/aas-lib/src/lib/aas-table/aas-table.effects.ts index 7ae9080f..bc3d7339 100644 --- a/projects/aas-lib/src/lib/aas-table/aas-table.effects.ts +++ b/projects/aas-lib/src/lib/aas-table/aas-table.effects.ts @@ -22,7 +22,7 @@ import { ViewMode } from '../types/view-mode'; export class AASTableEffects { private readonly store: Store; - constructor( + public constructor( private readonly actions: Actions, store: Store, ) { @@ -32,24 +32,28 @@ export class AASTableEffects { public updateView = createEffect(() => { return this.actions.pipe( ofType(AASTableActions.AASTableActionType.UPDATE_VIEW), - exhaustMap(action => this.store.select(AASTableSelectors.selectState).pipe( - first(), - map(state => { - const rows = state.viewMode === ViewMode.List - ? this.createListViewRows(state.rows, action.documents) - : this.createTreeViewRows(state.rows, action.documents); - - return AASTableActions.setRows({ rows }); - }) - ))); + exhaustMap(action => + this.store.select(AASTableSelectors.selectState).pipe( + first(), + map(state => { + const rows = + state.viewMode === ViewMode.List + ? this.createListViewRows(state.rows, action.documents) + : this.createTreeViewRows(state.rows, action.documents); + + return AASTableActions.setRows({ rows }); + }), + ), + ), + ); }); private createListViewRows(state: AASTableRow[], documents: AASDocument[]): AASTableRow[] { const map = new Map(state.map(row => [`${row.endpoint}:${row.id}`, row])); const rows = documents.map(document => { - const row = map.get(`${document.endpoint}:${document.id}`); + const row = map.get(`${document.endpoint}:${document.id}`); if (row) { - return row.document === document ? row : this.cloneD(row, document) + return row.document === document ? row : this.cloneD(row, document); } return new AASTableRow(document, false, false, false, -1, -1, -1); @@ -90,10 +94,10 @@ export class AASTableEffects { children.length === 0, 0, children.length > 0 ? rows.length + 1 : -1, - -1 + -1, ); - rows.push(rootRow) + rows.push(rootRow); if (index >= 0) { const previous = this.clone(rows[index]); @@ -111,15 +115,7 @@ export class AASTableEffects { let previous: AASTableRow | null = null; const children = nodes.filter(node => this.isChild(parent, node)); for (const child of children) { - const row = new AASTableRow( - child, - false, - false, - children.length === 0, - level, - -1, - -1 - ); + const row = new AASTableRow(child, false, false, children.length === 0, level, -1, -1); rows.push(row); if (previous) { @@ -151,10 +147,10 @@ export class AASTableEffects { row.isLeaf, row.level, row.firstChild, - row.nextSibling); + row.nextSibling, + ); } - private cloneD(row: AASTableRow, document: AASDocument): AASTableRow { return new AASTableRow( document, @@ -163,7 +159,7 @@ export class AASTableEffects { row.isLeaf, row.level, row.firstChild, - row.nextSibling); + row.nextSibling, + ); } - } diff --git a/projects/aas-lib/src/lib/aas-table/aas-table.reducer.ts b/projects/aas-lib/src/lib/aas-table/aas-table.reducer.ts index 48b792ba..6badf721 100644 --- a/projects/aas-lib/src/lib/aas-table/aas-table.reducer.ts +++ b/projects/aas-lib/src/lib/aas-table/aas-table.reducer.ts @@ -19,34 +19,15 @@ const initialState: AASTableState = { export const aasTableReducer = createReducer( initialState, - on( - AASTableActions.setViewMode, - (state, { viewMode }) => setViewMode(state, viewMode), - ), - on( - AASTableActions.collapseRow, - (state, { row }) => collapseRow(state, row) - ), - on( - AASTableActions.expandRow, - (state, { row }) => expandRow(state, row) - ), - on( - AASTableActions.setRows, - (state, { rows }) => setRows(state, rows) - ), - on( - AASTableActions.toggleSelected, - (state, { row, altKey, shiftKey }) => toggleSelected(state, row, altKey, shiftKey) - ), - on( - AASTableActions.toggleSelections, - (state) => toggleSelections(state) - ), - on( - AASTableActions.setSelections, - (state, { documents }) => setSelections(state, documents) + on(AASTableActions.setViewMode, (state, { viewMode }) => setViewMode(state, viewMode)), + on(AASTableActions.collapseRow, (state, { row }) => collapseRow(state, row)), + on(AASTableActions.expandRow, (state, { row }) => expandRow(state, row)), + on(AASTableActions.setRows, (state, { rows }) => setRows(state, rows)), + on(AASTableActions.toggleSelected, (state, { row, altKey, shiftKey }) => + toggleSelected(state, row, altKey, shiftKey), ), + on(AASTableActions.toggleSelections, state => toggleSelections(state)), + on(AASTableActions.setSelections, (state, { documents }) => setSelections(state, documents)), ); function setViewMode(state: AASTableState, viewMode: ViewMode): AASTableState { @@ -57,7 +38,7 @@ function setRows(state: AASTableState, rows: AASTableRow[]): AASTableState { } function setSelections(state: AASTableState, documents: AASDocument[]): AASTableState { - const rows = [ ...state.rows ]; + const rows = [...state.rows]; const set = new Set(documents); for (let i = 0, n = rows.length; i < n; i++) { const row = rows[i]; @@ -71,16 +52,11 @@ function setSelections(state: AASTableState, documents: AASDocument[]): AASTable return { ...state, rows }; } -function toggleSelected( - state: AASTableState, - row: AASTableRow, - altKey: boolean, - shiftKey: boolean, -): AASTableState { +function toggleSelected(state: AASTableState, row: AASTableRow, altKey: boolean, shiftKey: boolean): AASTableState { let rows: AASTableRow[]; if (altKey) { rows = state.rows.map(item => - item === row ? clone(row, !row.selected) : (item.selected ? clone(item, false) : item) + item === row ? clone(row, !row.selected) : item.selected ? clone(item, false) : item, ); } else if (shiftKey) { const index = state.rows.indexOf(row); @@ -128,7 +104,7 @@ function toggleSelections(state: AASTableState): AASTableState { } } - return { ...state, rows } + return { ...state, rows }; } function clone(row: AASTableRow, selected?: boolean): AASTableRow { @@ -143,20 +119,14 @@ function clone(row: AASTableRow, selected?: boolean): AASTableRow { row.isLeaf, row.level, row.firstChild, - row.nextSibling) + row.nextSibling, + ); } function expandRow(state: AASTableState, row: AASTableRow): AASTableState { const rows = [...state.rows]; const index = rows.indexOf(row); - rows[index] = new AASTableRow( - row.document, - false, - true, - row.isLeaf, - row.level, - row.firstChild, - row.nextSibling); + rows[index] = new AASTableRow(row.document, false, true, row.isLeaf, row.level, row.firstChild, row.nextSibling); return { ...state, rows }; } @@ -164,14 +134,7 @@ function expandRow(state: AASTableState, row: AASTableRow): AASTableState { function collapseRow(state: AASTableState, row: AASTableRow): AASTableState { const rows = [...state.rows]; const index = rows.indexOf(row); - rows[index] = new AASTableRow( - row.document, - false, - false, - row.isLeaf, - row.level, - row.firstChild, - row.nextSibling); + rows[index] = new AASTableRow(row.document, false, false, row.isLeaf, row.level, row.firstChild, row.nextSibling); return { ...state, rows }; } diff --git a/projects/aas-lib/src/lib/aas-table/aas-table.selectors.ts b/projects/aas-lib/src/lib/aas-table/aas-table.selectors.ts index 518d6996..9ed02e91 100644 --- a/projects/aas-lib/src/lib/aas-table/aas-table.selectors.ts +++ b/projects/aas-lib/src/lib/aas-table/aas-table.selectors.ts @@ -15,26 +15,18 @@ const getState = (state: AASTableFeatureState) => state.aasTable; export const selectState = createSelector(getState, state => state); -export const selectSelectedDocuments = createSelector( - getRows, - (rows: AASTableRow[]): AASDocument[] => { - return rows.filter(row => row.selected).map(row => row.document); - }); - -export const selectSomeSelected = createSelector( - getRows, - (rows: AASTableRow[]): boolean => { - return rows.length > 0 && rows.some(row => row.selected) && !rows.every(row => row.selected); - }); +export const selectSelectedDocuments = createSelector(getRows, (rows: AASTableRow[]): AASDocument[] => { + return rows.filter(row => row.selected).map(row => row.document); +}); +export const selectSomeSelected = createSelector(getRows, (rows: AASTableRow[]): boolean => { + return rows.length > 0 && rows.some(row => row.selected) && !rows.every(row => row.selected); +}); -export const selectEverySelected = createSelector( - getRows, - (rows: AASTableRow[]): boolean => { - return rows.length > 0 && rows.every(row => row.selected); - }); +export const selectEverySelected = createSelector(getRows, (rows: AASTableRow[]): boolean => { + return rows.length > 0 && rows.every(row => row.selected); +}); export const selectRows = createSelector(getState, state => { return state.rows; }); - diff --git a/projects/aas-lib/src/lib/aas-table/aas-table.state.ts b/projects/aas-lib/src/lib/aas-table/aas-table.state.ts index 85b7a2f5..e7569423 100644 --- a/projects/aas-lib/src/lib/aas-table/aas-table.state.ts +++ b/projects/aas-lib/src/lib/aas-table/aas-table.state.ts @@ -10,15 +10,15 @@ import { AASDocument } from 'common'; import { ViewMode } from '../types/view-mode'; export class AASTableRow { - constructor( + public constructor( public readonly document: AASDocument, public readonly selected: boolean, public readonly expanded: boolean, public readonly isLeaf: boolean, public readonly level: number, public firstChild: number, - public nextSibling: number) { - } + public nextSibling: number, + ) {} public get id(): string { return this.document.id; diff --git a/projects/aas-lib/src/lib/aas-tree/aas-tree-api.service.ts b/projects/aas-lib/src/lib/aas-tree/aas-tree-api.service.ts index 8f10ca30..fee7755f 100644 --- a/projects/aas-lib/src/lib/aas-tree/aas-tree-api.service.ts +++ b/projects/aas-lib/src/lib/aas-tree/aas-tree-api.service.ts @@ -13,24 +13,19 @@ import { encodeBase64Url } from '../convert'; /** The client side AAS provider service. */ @Injectable({ - providedIn: 'root' + providedIn: 'root', }) export class AASTreeApiService { - constructor( - private readonly http: HttpClient - ) { } + public constructor(private readonly http: HttpClient) {} public getTokenAsync(url: string): Promise { return new Promise((result, reject) => { let data: AuthResult; - this.http.post( - '/api/v1/login', - { id: url }).subscribe( - { - next: value => data = value, - complete: () => result(data.token), - error: (error) => reject(error) - }); + this.http.post('/api/v1/login', { id: url }).subscribe({ + next: value => (data = value), + complete: () => result(data.token), + error: error => reject(error), + }); }); } @@ -43,13 +38,18 @@ export class AASTreeApiService { public invoke(document: AASDocument, operation: aas.Operation): Promise { return new Promise((result, reject) => { let data: aas.Operation; - this.http.post( - `/api/v1/containers/${encodeBase64Url(document.endpoint)}/documents/${encodeBase64Url(document.id)}`, - operation).subscribe({ - next: (value) => data = value, + this.http + .post( + `/api/v1/containers/${encodeBase64Url(document.endpoint)}/documents/${encodeBase64Url( + document.id, + )}`, + operation, + ) + .subscribe({ + next: value => (data = value), complete: () => result(data), - error: (error) => reject(error) + error: error => reject(error), }); }); } -} \ No newline at end of file +} diff --git a/projects/aas-lib/src/lib/aas-tree/aas-tree-search.ts b/projects/aas-lib/src/lib/aas-tree/aas-tree-search.ts index 00c34cf8..58784a4f 100644 --- a/projects/aas-lib/src/lib/aas-tree/aas-tree-search.ts +++ b/projects/aas-lib/src/lib/aas-tree/aas-tree-search.ts @@ -21,35 +21,50 @@ import { convertToString, getModelTypeFromAbbreviation, parseDate, - parseNumber + parseNumber, } from 'common'; import { Injectable } from '@angular/core'; @Injectable() export class AASTreeSearch { - private store: Store + private store: Store; private readonly loop = true; private subscription = new Subscription(); private terms: SearchTerm[] = []; private rows: AASTreeRow[] = []; private index = -1; - constructor(store: Store, private translate: TranslateService) { - this.store = store as Store - - this.subscription.add(this.store.select(AASTreeSelectors.selectRows).pipe() - .subscribe(rows => { - this.rows = rows; - })); - - this.subscription.add(this.store.select(AASTreeSelectors.selectTerms).pipe() - .subscribe(terms => { - this.terms = terms; - this.findFirst(); - })); - - this.subscription.add(this.store.select(AASTreeSelectors.selectMatchIndex).pipe() - .subscribe((value) => this.index = value)); + public constructor( + store: Store, + private translate: TranslateService, + ) { + this.store = store as Store; + + this.subscription.add( + this.store + .select(AASTreeSelectors.selectRows) + .pipe() + .subscribe(rows => { + this.rows = rows; + }), + ); + + this.subscription.add( + this.store + .select(AASTreeSelectors.selectTerms) + .pipe() + .subscribe(terms => { + this.terms = terms; + this.findFirst(); + }), + ); + + this.subscription.add( + this.store + .select(AASTreeSelectors.selectMatchIndex) + .pipe() + .subscribe(value => (this.index = value)), + ); } public destroy(): void { @@ -87,7 +102,7 @@ export class AASTreeSearch { public findNext(): boolean { let completed = false; - if (this.rows.length > 0 && (this.terms.length > 0)) { + if (this.rows.length > 0 && this.terms.length > 0) { let match = false; let i = this.index < 0 ? 0 : this.index + 1; const start = i; @@ -115,7 +130,7 @@ export class AASTreeSearch { public findPrevious(): boolean { let completed = false; - if (this.rows.length > 0 && (this.terms.length > 0)) { + if (this.rows.length > 0 && this.terms.length > 0) { let match = false; let i = this.index <= 0 ? this.rows.length - 1 : this.index - 1; const start = i; @@ -146,7 +161,7 @@ export class AASTreeSearch { } private findFirst(): void { - if (this.rows.length > 0 && (this.terms.length > 0)) { + if (this.rows.length > 0 && this.terms.length > 0) { let match = false; let i = this.index < 0 ? 0 : this.index; const start = i; @@ -202,7 +217,7 @@ export class AASTreeSearch { return query; } - private parseOperator(expression: string): { index: number, operator: Operator } | undefined { + private parseOperator(expression: string): { index: number; operator: Operator } | undefined { let index = expression.indexOf('<='); if (index > 0) { return { index: index, operator: '<=' }; @@ -233,7 +248,7 @@ export class AASTreeSearch { return { index, operator: '<' }; } - return undefined + return undefined; } private fromString(s: string): string | boolean { @@ -268,7 +283,8 @@ export class AASTreeSearch { } } } else if (term.text) { - match = row.name.toLocaleLowerCase(this.translate.currentLang).indexOf(term.text) >= 0 || + match = + row.name.toLocaleLowerCase(this.translate.currentLang).indexOf(term.text) >= 0 || row.typeInfo.toLocaleLowerCase(this.translate.currentLang).indexOf(term.text) >= 0 || (typeof row.value === 'string' && row.value.toLocaleLowerCase(this.translate.currentLang).indexOf(term.text) >= 0); @@ -304,7 +320,9 @@ export class AASTreeSearch { } case 'MultiLanguageProperty': { const langString = (referable as aas.MultiLanguageProperty).value; - return langString ? langString.some(item => item ? this.containsString(item.text, value as string) : false) : false; + return langString + ? langString.some(item => (item ? this.containsString(item.text, value as string) : false)) + : false; } default: return false; @@ -314,7 +332,7 @@ export class AASTreeSearch { private matchProperty(property: aas.Property, b: string | boolean, operator: Operator = '='): boolean { const a = convertFromString(property.value, property.valueType); if (typeof a === 'boolean') { - return (typeof b === 'boolean') && a === b; + return typeof b === 'boolean' && a === b; } else if (typeof b === 'boolean') { return false; } @@ -364,8 +382,10 @@ export class AASTreeSearch { return false; } - return this.containsString(convertToString(a), b) || - this.containsString(convertToString(a, this.translate.currentLang), b); + return ( + this.containsString(convertToString(a), b) || + this.containsString(convertToString(a, this.translate.currentLang), b) + ); } private isDate(valueType: aas.DataTypeDefXsd): boolean { @@ -377,4 +397,4 @@ export class AASTreeSearch { return false; } } -} \ No newline at end of file +} diff --git a/projects/aas-lib/src/lib/aas-tree/aas-tree.actions.ts b/projects/aas-lib/src/lib/aas-tree/aas-tree.actions.ts index 4d935def..59fe7696 100644 --- a/projects/aas-lib/src/lib/aas-tree/aas-tree.actions.ts +++ b/projects/aas-lib/src/lib/aas-tree/aas-tree.actions.ts @@ -25,34 +25,27 @@ export enum AASTreeActionType { export const updateRows = createAction( AASTreeActionType.UPDATE_ROWS, - props<{ document: AASDocument | null; localeId: string }>()); + props<{ document: AASDocument | null; localeId: string }>(), +); -export const expandRow = createAction( - AASTreeActionType.EXPAND_ROW, - props<{ arg: number | AASTreeRow }>()); +export const expandRow = createAction(AASTreeActionType.EXPAND_ROW, props<{ arg: number | AASTreeRow }>()); -export const collapseRow = createAction( - AASTreeActionType.COLLAPSE_ROW, - props<{ row: AASTreeRow }>()); +export const collapseRow = createAction(AASTreeActionType.COLLAPSE_ROW, props<{ row: AASTreeRow }>()); -export const collapse = createAction( - AASTreeActionType.COLLAPSE); +export const collapse = createAction(AASTreeActionType.COLLAPSE); export const toggleSelected = createAction( AASTreeActionType.TOGGLE_SELECTED, - props<{ row: AASTreeRow, altKey: boolean, shiftKey: boolean }>()); + props<{ row: AASTreeRow; altKey: boolean; shiftKey: boolean }>(), +); -export const toggleSelections = createAction( - AASTreeActionType.TOGGLE_SELECTIONS); +export const toggleSelections = createAction(AASTreeActionType.TOGGLE_SELECTIONS); -export const setSearchText = createAction( - AASTreeActionType.SET_SEARCH_TEXT, - props<{ terms: SearchTerm[] }>()); +export const setSearchText = createAction(AASTreeActionType.SET_SEARCH_TEXT, props<{ terms: SearchTerm[] }>()); -export const setMatchIndex = createAction( - AASTreeActionType.SET_MATCH_INDEX, - props<{ index: number }>()); +export const setMatchIndex = createAction(AASTreeActionType.SET_MATCH_INDEX, props<{ index: number }>()); export const setSelectedElements = createAction( AASTreeActionType.SET_SELECTED_ELEMENTS, - props<{ elements: aas.Referable[] }>()); + props<{ elements: aas.Referable[] }>(), +); diff --git a/projects/aas-lib/src/lib/aas-tree/aas-tree.component.ts b/projects/aas-lib/src/lib/aas-tree/aas-tree.component.ts index 23fbcc9e..912c8b83 100644 --- a/projects/aas-lib/src/lib/aas-tree/aas-tree.component.ts +++ b/projects/aas-lib/src/lib/aas-tree/aas-tree.component.ts @@ -6,7 +6,7 @@ * *****************************************************************************/ -import { Component, EventEmitter, Input, OnChanges, OnDestroy, OnInit, Output, SimpleChanges, } from '@angular/core'; +import { Component, EventEmitter, Input, OnChanges, OnDestroy, OnInit, Output, SimpleChanges } from '@angular/core'; import { BehaviorSubject, Subscription, Observable, first } from 'rxjs'; import { WebSocketSubject } from 'rxjs/webSocket'; import { Store } from '@ngrx/store'; @@ -43,21 +43,25 @@ import { DownloadService } from '../download.service'; import { WebSocketFactoryService } from '../web-socket-factory.service'; import { ClipboardService } from '../clipboard.service'; import { LogType, NotifyService } from '../notify/notify.service'; -import { SubmodelViewDescriptor, resolveSemanticId, supportedSubmodelTemplates } from '../submodel-template/submodel-template'; +import { + SubmodelViewDescriptor, + resolveSemanticId, + supportedSubmodelTemplates, +} from '../submodel-template/submodel-template'; import * as AASTreeActions from './aas-tree.actions'; import * as AASTreeSelectors from './aas-tree.selectors'; import { AASTreeApiService } from './aas-tree-api.service'; interface PropertyValue { - property: aas.Property, - value: BehaviorSubject + property: aas.Property; + value: BehaviorSubject; } @Component({ selector: 'fhg-aas-tree', templateUrl: './aas-tree.component.html', styleUrls: ['./aas-tree.component.scss'], - providers: [AASTreeSearch] + providers: [AASTreeSearch], }) export class AASTreeComponent implements OnInit, OnChanges, OnDestroy { private readonly store: Store; @@ -70,7 +74,7 @@ export class AASTreeComponent implements OnInit, OnChanges, OnDestroy { private webSocketSubject?: WebSocketSubject; - constructor( + public constructor( private readonly router: Router, store: Store, private readonly api: AASTreeApiService, @@ -89,11 +93,15 @@ export class AASTreeComponent implements OnInit, OnChanges, OnDestroy { this.someSelected = this.store.select(AASTreeSelectors.selectSomeSelected); this.everySelected = this.store.select(AASTreeSelectors.selectEverySelected); - this.subscription.add(this.store.select(AASTreeSelectors.selectSelectedElements).pipe() - .subscribe(elements => { - this._selected = elements; - this.selectedChange.emit(elements); - })); + this.subscription.add( + this.store + .select(AASTreeSelectors.selectSelectedElements) + .pipe() + .subscribe(elements => { + this._selected = elements; + this.selectedChange.emit(elements); + }), + ); this.window.addEventListener('keyup', this.keyup); this.window.addEventListener('keydown', this.keydown); @@ -139,45 +147,66 @@ export class AASTreeComponent implements OnInit, OnChanges, OnDestroy { public nodes: Observable; public ngOnInit(): void { - this.subscription.add(this.store.select(AASTreeSelectors.selectError).pipe().subscribe(error => { - if (error) { - this.notify.error(error); - } - })); - - this.subscription.add(this.store.select(AASTreeSelectors.selectMatchIndex).pipe().subscribe(index => { - if (index >= 0) { - this.store.dispatch(AASTreeActions.expandRow({ arg: index })); - } - })); - - this.subscription.add(this.store.select(AASTreeSelectors.selectMatchRow).pipe().subscribe(row => { - if (row) { - setTimeout(() => { - const element = this.dom.getElementById(row.id); - element?.scrollIntoView({ block: 'center', behavior: 'smooth' }); - }) - } - })); + this.subscription.add( + this.store + .select(AASTreeSelectors.selectError) + .pipe() + .subscribe(error => { + if (error) { + this.notify.error(error); + } + }), + ); + + this.subscription.add( + this.store + .select(AASTreeSelectors.selectMatchIndex) + .pipe() + .subscribe(index => { + if (index >= 0) { + this.store.dispatch(AASTreeActions.expandRow({ arg: index })); + } + }), + ); + + this.subscription.add( + this.store + .select(AASTreeSelectors.selectMatchRow) + .pipe() + .subscribe(row => { + if (row) { + setTimeout(() => { + const element = this.dom.getElementById(row.id); + element?.scrollIntoView({ block: 'center', behavior: 'smooth' }); + }); + } + }), + ); - this.subscription.add(this.translate.onLangChange.subscribe(() => { - this.store.dispatch(AASTreeActions.updateRows({ - document: this.document, - localeId: this.translate.currentLang - })); - })); + this.subscription.add( + this.translate.onLangChange.subscribe(() => { + this.store.dispatch( + AASTreeActions.updateRows({ + document: this.document, + localeId: this.translate.currentLang, + }), + ); + }), + ); } public ngOnChanges(changes: SimpleChanges): void { if (changes['document']) { - this.store.dispatch(AASTreeActions.updateRows({ - document: this.document, - localeId: this.translate.currentLang - })); + this.store.dispatch( + AASTreeActions.updateRows({ + document: this.document, + localeId: this.translate.currentLang, + }), + ); } if (changes['search'] && this.search) { - this.subscription.add(this.search.subscribe((value) => this.searching.start(value))); + this.subscription.add(this.search.subscribe(value => this.searching.start(value))); } const stateChange = changes['state']; @@ -310,11 +339,13 @@ export class AASTreeComponent implements OnInit, OnChanges, OnDestroy { if (template && this.document) { const descriptor: SubmodelViewDescriptor = { template, - submodels: [{ - id: this.document.id, - endpoint: this.document.endpoint, - idShort: submodel.idShort - }] + submodels: [ + { + id: this.document.id, + endpoint: this.document.endpoint, + idShort: submodel.idShort, + }, + ], }; this.clipboard.set('ViewQuery', { descriptor } as ViewQuery); @@ -363,7 +394,6 @@ export class AASTreeComponent implements OnInit, OnChanges, OnDestroy { } else if (blob.contentType.startsWith('video/')) { await this.showVideoAsync(name, url); } else if (blob.contentType.endsWith('/pdf')) { - this.window.open(url); } else if (blob) { await this.downloadFileAsync(name, url); @@ -431,8 +461,7 @@ export class AASTreeComponent implements OnInit, OnChanges, OnDestroy { modalRef.componentInstance.operation = operation; await modalRef.result; } - } - catch (error) { + } catch (error) { if (error) { this.notify.error(error); } @@ -449,17 +478,17 @@ export class AASTreeComponent implements OnInit, OnChanges, OnDestroy { private goOnline(): void { try { - this.store.select(AASTreeSelectors.selectSelectedRows).pipe(first()).subscribe( - { - next: (rows) => { + this.store + .select(AASTreeSelectors.selectSelectedRows) + .pipe(first()) + .subscribe({ + next: rows => { this.prepareOnline(rows); this.play(); }, - error: () => this.stop() - } - ) - } - catch (error) { + error: () => this.stop(), + }); + } catch (error) { this.stop(); } } @@ -471,12 +500,10 @@ export class AASTreeComponent implements OnInit, OnChanges, OnDestroy { private play(): void { if (this.document) { this.webSocketSubject = this.webSocketFactory.create(); - this.webSocketSubject.subscribe( - { - next: this.onMessage, - error: this.onError - } - ); + this.webSocketSubject.subscribe({ + next: this.onMessage, + error: this.onError, + }); this.webSocketSubject.next(this.createMessage(this.document)); } @@ -510,7 +537,7 @@ export class AASTreeComponent implements OnInit, OnChanges, OnDestroy { if (property.nodeId) { this.liveNodes.push({ nodeId: property.nodeId, - valueType: property.valueType ?? 'undefined' + valueType: property.valueType ?? 'undefined', }); const subject = new BehaviorSubject(this.getPropertyValue(property)); @@ -524,7 +551,7 @@ export class AASTreeComponent implements OnInit, OnChanges, OnDestroy { private createMessage(document: AASDocument): WebSocketData { return { type: 'LiveRequest', - data: { endpoint: document.endpoint, id: document.id, nodes: this.liveNodes } as LiveRequest + data: { endpoint: document.endpoint, id: document.id, nodes: this.liveNodes } as LiveRequest, }; } @@ -536,15 +563,16 @@ export class AASTreeComponent implements OnInit, OnChanges, OnDestroy { item.value.next( typeof node.value === 'boolean' ? node.value - : convertToString(node.value, this.translate.currentLang)); + : convertToString(node.value, this.translate.currentLang), + ); } } } - } + }; private onError = (error: unknown): void => { this.notify.log(LogType.Error, error); - } + }; private keyup = () => { this.shiftKey = false; @@ -556,8 +584,8 @@ export class AASTreeComponent implements OnInit, OnChanges, OnDestroy { this.altKey = event.altKey; }; - private resolveFile(file: aas.File): { url?: string, name?: string } { - const value: { url?: string, name?: string } = {}; + private resolveFile(file: aas.File): { url?: string; name?: string } { + const value: { url?: string; name?: string } = {}; if (this.document?.content && file.value) { const submodel = selectSubmodel(this.document.content, file); if (submodel) { @@ -572,4 +600,4 @@ export class AASTreeComponent implements OnInit, OnChanges, OnDestroy { return value; } -} \ No newline at end of file +} diff --git a/projects/aas-lib/src/lib/aas-tree/aas-tree.reducer.ts b/projects/aas-lib/src/lib/aas-tree/aas-tree.reducer.ts index c763c22a..996bdf9e 100644 --- a/projects/aas-lib/src/lib/aas-tree/aas-tree.reducer.ts +++ b/projects/aas-lib/src/lib/aas-tree/aas-tree.reducer.ts @@ -21,7 +21,7 @@ import { isBooleanType, toLocale, toBoolean, - mimeTypeToExtension + mimeTypeToExtension, } from 'common'; import { AASTreeRow, AASTreeState, DisplayType, SearchTerm } from './aas-tree.state'; @@ -32,53 +32,28 @@ const initialState: AASTreeState = { rows: [], index: -1, terms: [], - error: null + error: null, }; export const aasTreeReducer = createReducer( initialState, - on( - AASTreeActions.collapse, - (state) => collapse(state) + on(AASTreeActions.collapse, state => collapse(state)), + on(AASTreeActions.collapseRow, (state, { row }) => collapseRow(state, row)), + on(AASTreeActions.expandRow, (state, { arg }) => expandRow(state, arg)), + on(AASTreeActions.setMatchIndex, (state, { index }) => setMatchIndex(state, index)), + on(AASTreeActions.setSearchText, (state, { terms }) => setSearchText(state, terms)), + on(AASTreeActions.toggleSelected, (state, { row, altKey, shiftKey }) => + toggleSelected(state, row, altKey, shiftKey), ), - on( - AASTreeActions.collapseRow, - (state, { row }) => collapseRow(state, row) - ), - on( - AASTreeActions.expandRow, - (state, { arg }) => expandRow(state, arg) - ), - on( - AASTreeActions.setMatchIndex, - (state, { index }) => setMatchIndex(state, index) - ), - on( - AASTreeActions.setSearchText, - (state, { terms }) => setSearchText(state, terms) - ), - on( - AASTreeActions.toggleSelected, - (state, { row, altKey, shiftKey }) => toggleSelected(state, row, altKey, shiftKey) - ), - on( - AASTreeActions.toggleSelections, - (state) => toggleSelections(state) - ), - on( - AASTreeActions.updateRows, - (state, { document, localeId }) => { - try { - return updateRows(state, document, localeId); - } catch (error) { - return { ...state, error }; - } + on(AASTreeActions.toggleSelections, state => toggleSelections(state)), + on(AASTreeActions.updateRows, (state, { document, localeId }) => { + try { + return updateRows(state, document, localeId); + } catch (error) { + return { ...state, error }; } - ), - on( - AASTreeActions.setSelectedElements, - (state, {elements}) => setSelectedElements(state, elements), - ), + }), + on(AASTreeActions.setSelectedElements, (state, { elements }) => setSelectedElements(state, elements)), ); function updateRows(state: AASTreeState, document: AASDocument | null, localeId: string): AASTreeState { @@ -104,10 +79,7 @@ function updateRows(state: AASTreeState, document: AASDocument | null, localeId: return { ...state, rows, error: null }; - function traverse( - element: aas.Referable, - parent: number, - level: number): void { + function traverse(element: aas.Referable, parent: number, level: number): void { let previous: AASTreeRow | null = null; for (const child of getChildren(element)) { const row = createRow(child, parent, level, false); @@ -225,7 +197,8 @@ function updateRows(state: AASTreeState, document: AASDocument | null, localeId: isLeaf, parent, -1, - -1); + -1, + ); function getPropertyDisplayType(property: aas.Property): DisplayType { switch (property.valueType) { @@ -240,22 +213,26 @@ function updateRows(state: AASTreeState, document: AASDocument | null, localeId: } function findRow(rows: AASTreeRow[], referable: aas.Referable): AASTreeRow | undefined { - return rows.find((row) => isEqual(createReference(row.element), createReference(referable))); + return rows.find(row => isEqual(createReference(row.element), createReference(referable))); } function createReference(referable: aas.Referable): aas.Reference { let keys: aas.Key[]; if (referable.parent) { - keys = [...referable.parent.keys.map(key => ({ ...key })), - { - type: referable.modelType as aas.KeyTypes, - value: referable.idShort, - }]; + keys = [ + ...referable.parent.keys.map(key => ({ ...key })), + { + type: referable.modelType as aas.KeyTypes, + value: referable.idShort, + }, + ]; } else if (isIdentifiable(referable)) { - keys = [{ - type: referable.modelType as aas.KeyTypes, - value: referable.id, - }]; + keys = [ + { + type: referable.modelType as aas.KeyTypes, + value: referable.id, + }, + ]; } else { throw new Error('Unexpected referable.'); } @@ -311,7 +288,8 @@ function expandRow(state: AASTreeState, arg: number | AASTreeRow): AASTreeState row.isLeaf, row.parent, row.firstChild, - row.nextSibling); + row.nextSibling, + ); } } @@ -333,7 +311,8 @@ function collapseRow(state: AASTreeState, row: AASTreeRow): AASTreeState { row.isLeaf, row.parent, row.firstChild, - row.nextSibling); + row.nextSibling, + ); return { ...state, rows, error: null }; } @@ -357,7 +336,8 @@ function collapse(state: AASTreeState): AASTreeState { row.isLeaf, row.parent, row.firstChild, - row.nextSibling); + row.nextSibling, + ); } } else if (!row.isLeaf && row.expanded) { return new AASTreeRow( @@ -375,7 +355,8 @@ function collapse(state: AASTreeState): AASTreeState { row.isLeaf, row.parent, row.firstChild, - row.nextSibling); + row.nextSibling, + ); } return row; @@ -388,7 +369,7 @@ function toggleSelected(state: AASTreeState, row: AASTreeRow, altKey: boolean, s let rows: AASTreeRow[]; if (altKey) { rows = state.rows.map(item => - item === row ? clone(row, !row.selected) : (item.selected ? clone(item, false) : item), + item === row ? clone(row, !row.selected) : item.selected ? clone(item, false) : item, ); } else if (shiftKey) { const index = state.rows.indexOf(row); @@ -440,7 +421,7 @@ function toggleSelections(state: AASTreeState): AASTreeState { } function setSelectedElements(state: AASTreeState, elements: aas.Referable[]): AASTreeState { - const rows = [ ...state.rows ]; + const rows = [...state.rows]; const set = new Set(elements); for (let i = 0, n = rows.length; i < n; i++) { const row = rows[i]; @@ -470,7 +451,8 @@ function clone(row: AASTreeRow, selected: boolean): AASTreeRow { row.isLeaf, row.parent, row.firstChild, - row.nextSibling); + row.nextSibling, + ); } function getTypeInfo(referable: aas.Referable | null): string { @@ -526,8 +508,7 @@ function getTypeInfo(referable: aas.Referable | null): string { if (operation.outputVariables && operation.outputVariables.length === 1) { value += `: ${variableToString(operation.outputVariables[0].value)}`; - } - else if (operation.outputVariables && operation.outputVariables.length > 1) { + } else if (operation.outputVariables && operation.outputVariables.length > 1) { value += ': {' + operation.outputVariables.map(v => variableToString(v.value)).join(', ') + '}'; } break; @@ -551,7 +532,7 @@ function getTypeInfo(referable: aas.Referable | null): string { return `${value.idShort}: ${value?.value?.keys.map(key => key.value).join('/')}`; } - return `${value.idShort}: ${value.modelType}` + return `${value.idShort}: ${value.modelType}`; } function referenceToString(reference?: aas.Reference): string { @@ -617,14 +598,14 @@ function setMatchIndex(state: AASTreeState, index: number): AASTreeState { ...state, rows: updateHighlighted(index), index: index, - error: null + error: null, }; } else { return { rows: updateHighlighted(-1), index: -1, terms: [], - error: null + error: null, }; } @@ -648,9 +629,9 @@ function setMatchIndex(state: AASTreeState, index: number): AASTreeState { row.isLeaf, row.parent, row.firstChild, - row.nextSibling); - } - else if (rows[i].highlighted) { + row.nextSibling, + ); + } else if (rows[i].highlighted) { rows[i] = new AASTreeRow( row.id, row.element, @@ -666,7 +647,8 @@ function setMatchIndex(state: AASTreeState, index: number): AASTreeState { row.isLeaf, row.parent, row.firstChild, - row.nextSibling); + row.nextSibling, + ); } } diff --git a/projects/aas-lib/src/lib/aas-tree/aas-tree.selectors.ts b/projects/aas-lib/src/lib/aas-tree/aas-tree.selectors.ts index 33127955..26471295 100644 --- a/projects/aas-lib/src/lib/aas-tree/aas-tree.selectors.ts +++ b/projects/aas-lib/src/lib/aas-tree/aas-tree.selectors.ts @@ -29,29 +29,19 @@ export const selectError = createSelector(getError, error => error); export const selectRow = (index: number) => { return createSelector(getRows, rows => rows[index]); -} +}; -export const selectNodes = createSelector( - getRows, - rows => rows.find(row => row.level === 0)?.getExpanded(rows) ?? [] -); +export const selectNodes = createSelector(getRows, rows => rows.find(row => row.level === 0)?.getExpanded(rows) ?? []); -export const selectSelectedElements = createSelector( - getRows, - rows => rows.filter(row => row.selected).map(item => item.element) +export const selectSelectedElements = createSelector(getRows, rows => + rows.filter(row => row.selected).map(item => item.element), ); export const selectSomeSelected = createSelector( getRows, - rows => rows.length > 0 && rows.some(row => row.selected) && !rows.every(row => row.selected) + rows => rows.length > 0 && rows.some(row => row.selected) && !rows.every(row => row.selected), ); -export const selectEverySelected = createSelector( - getRows, - rows => rows.length > 0 && rows.every(row => row.selected) -); +export const selectEverySelected = createSelector(getRows, rows => rows.length > 0 && rows.every(row => row.selected)); -export const selectSelectedRows = createSelector( - getRows, - rows => rows.filter(row => row.selected) -); +export const selectSelectedRows = createSelector(getRows, rows => rows.filter(row => row.selected)); diff --git a/projects/aas-lib/src/lib/aas-tree/aas-tree.state.ts b/projects/aas-lib/src/lib/aas-tree/aas-tree.state.ts index e597f228..095be6e9 100644 --- a/projects/aas-lib/src/lib/aas-tree/aas-tree.state.ts +++ b/projects/aas-lib/src/lib/aas-tree/aas-tree.state.ts @@ -10,7 +10,7 @@ import { aas, isSubmodel } from 'common'; import { resolveSemanticId, supportedSubmodelTemplates } from '../submodel-template/submodel-template'; export class AASTreeRow { - constructor( + public constructor( public readonly id: string, public readonly element: aas.Referable, public expanded: boolean, @@ -25,8 +25,8 @@ export class AASTreeRow { public readonly isLeaf: boolean, public readonly parent: number, public firstChild: number, - public nextSibling: number) { - } + public nextSibling: number, + ) {} public get hasChildren(): boolean { return this.firstChild >= 0; @@ -80,12 +80,12 @@ export enum DisplayType { undefined = '', Text = 'text', Boolean = 'boolean', - Url = 'url' + Url = 'url', } export interface SearchTerm { - text?: string, - query?: SearchQuery + text?: string; + query?: SearchQuery; } export type Operator = '=' | '<' | '>' | '<=' | '>=' | '!='; diff --git a/projects/aas-lib/src/lib/aas-tree/operation-call-form/operation-call-form.component.html b/projects/aas-lib/src/lib/aas-tree/operation-call-form/operation-call-form.component.html index b1bd0c94..98bee296 100644 --- a/projects/aas-lib/src/lib/aas-tree/operation-call-form/operation-call-form.component.html +++ b/projects/aas-lib/src/lib/aas-tree/operation-call-form/operation-call-form.component.html @@ -12,7 +12,7 @@

{{name}}

- +
@for (message of messages; track message) { diff --git a/projects/aas-lib/src/lib/aas-tree/operation-call-form/operation-call-form.component.ts b/projects/aas-lib/src/lib/aas-tree/operation-call-form/operation-call-form.component.ts index bbc31e94..793c374c 100644 --- a/projects/aas-lib/src/lib/aas-tree/operation-call-form/operation-call-form.component.ts +++ b/projects/aas-lib/src/lib/aas-tree/operation-call-form/operation-call-form.component.ts @@ -24,7 +24,7 @@ import { isProperty, toInvariant, convertToString, - toBoolean + toBoolean, } from 'common'; export interface Bla { @@ -39,16 +39,16 @@ export interface Bla { @Component({ selector: 'fhg-operation-call', templateUrl: './operation-call-form.component.html', - styleUrls: ['./operation-call-form.component.scss'] + styleUrls: ['./operation-call-form.component.scss'], }) export class OperationCallFormComponent { private _operation!: aas.Operation; - constructor( + public constructor( private modal: NgbActiveModal, private translate: TranslateService, - private api: AASTreeApiService) { - } + private api: AASTreeApiService, + ) {} public name = ''; @@ -103,9 +103,10 @@ export class OperationCallFormComponent { for (const item of this.inputVariables) { const element = item.submodelElement; if (isProperty(element)) { - const value = typeof item.value === 'boolean' - ? item.value.toString() - : toInvariant(item.value, item.type, this.translate.currentLang); + const value = + typeof item.value === 'boolean' + ? item.value.toString() + : toInvariant(item.value, item.type, this.translate.currentLang); if (value == null) { throw new ApplicationError( @@ -113,12 +114,13 @@ export class OperationCallFormComponent { ERRORS.INVALID_OPERATION_VARIABLE_EXPRESSION, element.value, element.idShort, - element.valueType); + element.valueType, + ); } element.value = value; } else { - // ToDo: + // ToDo: } } @@ -141,9 +143,11 @@ export class OperationCallFormComponent { } if (!valueType) { - throw new ApplicationError(`The data type of the variable "${source.idShort}" is undefined.`, + throw new ApplicationError( + `The data type of the variable "${source.idShort}" is undefined.`, ERRORS.UNKNOWN_VARIABLE_VALUE_TYPE, - source.idShort); + source.idShort, + ); } let value = source.value; @@ -157,7 +161,7 @@ export class OperationCallFormComponent { description: getLocaleValue(source.descriptions), type: valueType, inputType: inputType, - value: inputType === 'checkbox' ? toBoolean(value) : value + value: inputType === 'checkbox' ? toBoolean(value) : value, }); } else { const source = sourceVariable.value; @@ -167,10 +171,10 @@ export class OperationCallFormComponent { description: getLocaleValue(source.descriptions), type: 'xs:string', inputType: 'text', - value: 'not implemented' + value: 'not implemented', }); } } } } -} \ No newline at end of file +} diff --git a/projects/aas-lib/src/lib/aas-tree/show-image-form/show-image-form.component.html b/projects/aas-lib/src/lib/aas-tree/show-image-form/show-image-form.component.html index e13cf835..37cdb6df 100644 --- a/projects/aas-lib/src/lib/aas-tree/show-image-form/show-image-form.component.html +++ b/projects/aas-lib/src/lib/aas-tree/show-image-form/show-image-form.component.html @@ -11,7 +11,7 @@

{{name}}

- +
diff --git a/projects/aas-lib/src/lib/aas-tree/show-image-form/show-image-form.component.ts b/projects/aas-lib/src/lib/aas-tree/show-image-form/show-image-form.component.ts index 81ecd1c7..26ba3b14 100644 --- a/projects/aas-lib/src/lib/aas-tree/show-image-form/show-image-form.component.ts +++ b/projects/aas-lib/src/lib/aas-tree/show-image-form/show-image-form.component.ts @@ -6,18 +6,18 @@ * *****************************************************************************/ -import { Component } from "@angular/core"; -import { NgbActiveModal } from "@ng-bootstrap/ng-bootstrap"; +import { Component } from '@angular/core'; +import { NgbActiveModal } from '@ng-bootstrap/ng-bootstrap'; @Component({ selector: 'fhg-show-image', templateUrl: './show-image-form.component.html', - styleUrls: ['./show-image-form.component.scss'] + styleUrls: ['./show-image-form.component.scss'], }) export class ShowImageFormComponent { private readonly _modal: NgbActiveModal; - constructor(modal: NgbActiveModal) { + public constructor(modal: NgbActiveModal) { this._modal = modal; } @@ -28,4 +28,4 @@ export class ShowImageFormComponent { public close(): void { this._modal.close(); } -} \ No newline at end of file +} diff --git a/projects/aas-lib/src/lib/aas-tree/show-video-form/show-video-form.component.html b/projects/aas-lib/src/lib/aas-tree/show-video-form/show-video-form.component.html index ef7c9422..deaa76a2 100644 --- a/projects/aas-lib/src/lib/aas-tree/show-video-form/show-video-form.component.html +++ b/projects/aas-lib/src/lib/aas-tree/show-video-form/show-video-form.component.html @@ -11,7 +11,7 @@

{{name}}

- +
diff --git a/projects/aas-lib/src/lib/aas-tree/show-video-form/show-video-form.component.ts b/projects/aas-lib/src/lib/aas-tree/show-video-form/show-video-form.component.ts index a78c61d3..e7c048a3 100644 --- a/projects/aas-lib/src/lib/aas-tree/show-video-form/show-video-form.component.ts +++ b/projects/aas-lib/src/lib/aas-tree/show-video-form/show-video-form.component.ts @@ -6,18 +6,18 @@ * *****************************************************************************/ -import { Component } from "@angular/core"; -import { NgbActiveModal } from "@ng-bootstrap/ng-bootstrap"; +import { Component } from '@angular/core'; +import { NgbActiveModal } from '@ng-bootstrap/ng-bootstrap'; @Component({ selector: 'fhg-show-video', templateUrl: './show-video-form.component.html', - styleUrls: ['./show-video-form.component.scss'] + styleUrls: ['./show-video-form.component.scss'], }) export class ShowVideoFormComponent { private readonly _modal: NgbActiveModal; - constructor(modal: NgbActiveModal) { + public constructor(modal: NgbActiveModal) { this._modal = modal; } @@ -28,4 +28,4 @@ export class ShowVideoFormComponent { public close(): void { this._modal.close(); } -} \ No newline at end of file +} diff --git a/projects/aas-lib/src/lib/auth/auth-api.service.ts b/projects/aas-lib/src/lib/auth/auth-api.service.ts index 3b2596b4..254d9ec3 100644 --- a/projects/aas-lib/src/lib/auth/auth-api.service.ts +++ b/projects/aas-lib/src/lib/auth/auth-api.service.ts @@ -16,9 +16,7 @@ import { encodeBase64Url } from '../convert'; providedIn: 'root', }) export class AuthApiService { - constructor( - private readonly http: HttpClient - ) { } + public constructor(private readonly http: HttpClient) {} public register(profile: UserProfile): Observable { return this.http.post('/api/v1/register', profile); @@ -49,12 +47,10 @@ export class AuthApiService { } public setCookie(id: string, cookie: Cookie): Observable { - return this.http.post( - `/api/v1/users/${encodeBase64Url(id)}/cookies/${cookie.name}`, - cookie); + return this.http.post(`/api/v1/users/${encodeBase64Url(id)}/cookies/${cookie.name}`, cookie); } public deleteCookie(id: string, name: string): Observable { return this.http.delete(`/api/v1/users/${encodeBase64Url(id)}/cookies/${name}`); } -} \ No newline at end of file +} diff --git a/projects/aas-lib/src/lib/auth/auth.component.html b/projects/aas-lib/src/lib/auth/auth.component.html index 7bb13ae7..2eea6cff 100644 --- a/projects/aas-lib/src/lib/auth/auth.component.html +++ b/projects/aas-lib/src/lib/auth/auth.component.html @@ -7,26 +7,28 @@ !---------------------------------------------------------------------------->
- -
-
-
{{userName}}
+ +
+
+
{{userName}}
+
+ +
+ @if (!userAuthenticated) { + CMD_LOGIN + } + @if (!userAuthenticated) { + CMD_REGISTER_USER + } + @if (userAuthenticated) { + CMD_UPDATE_PROFILE + } + @if (userAuthenticated) { + CMD_LOGOUT + }
- -
- @if (!userAuthenticated) { - CMD_LOGIN - } - @if (!userAuthenticated) { - CMD_REGISTER_USER - } - @if (userAuthenticated) { - CMD_UPDATE_PROFILE - } - @if (userAuthenticated) { - CMD_LOGOUT - } -
\ No newline at end of file diff --git a/projects/aas-lib/src/lib/auth/auth.component.ts b/projects/aas-lib/src/lib/auth/auth.component.ts index b1bad501..6f2de3c2 100644 --- a/projects/aas-lib/src/lib/auth/auth.component.ts +++ b/projects/aas-lib/src/lib/auth/auth.component.ts @@ -6,19 +6,20 @@ * *****************************************************************************/ -import { Component } from "@angular/core"; -import { NotifyService } from "../notify/notify.service"; -import { AuthService } from "./auth.service"; +import { Component } from '@angular/core'; +import { NotifyService } from '../notify/notify.service'; +import { AuthService } from './auth.service'; @Component({ - selector: "fhg-auth", - templateUrl: "./auth.component.html", - styleUrls: ["./auth.component.scss"], + selector: 'fhg-auth', + templateUrl: './auth.component.html', + styleUrls: ['./auth.component.scss'], }) export class AuthComponent { - constructor( + public constructor( private auth: AuthService, - private notify: NotifyService) { } + private notify: NotifyService, + ) {} public get userAuthenticated(): boolean { return this.auth.authenticated; @@ -43,4 +44,4 @@ export class AuthComponent { public updateUserProfile(): void { this.auth.updateUserProfile().subscribe({ error: error => this.notify.error(error) }); } -} \ No newline at end of file +} diff --git a/projects/aas-lib/src/lib/auth/auth.interceptor.ts b/projects/aas-lib/src/lib/auth/auth.interceptor.ts index b9599ded..21f63fdb 100644 --- a/projects/aas-lib/src/lib/auth/auth.interceptor.ts +++ b/projects/aas-lib/src/lib/auth/auth.interceptor.ts @@ -17,7 +17,7 @@ export class AuthInterceptor implements HttpInterceptor { const token = localStorage.getItem('.Token'); if (token) { const cloned = req.clone({ - headers: req.headers.set('Authorization', 'Bearer ' + token) + headers: req.headers.set('Authorization', 'Bearer ' + token), }); return next.handle(cloned); @@ -25,4 +25,4 @@ export class AuthInterceptor implements HttpInterceptor { return next.handle(req); } } -} \ No newline at end of file +} diff --git a/projects/aas-lib/src/lib/auth/auth.service.ts b/projects/aas-lib/src/lib/auth/auth.service.ts index 7ed77ca1..cdf5a034 100644 --- a/projects/aas-lib/src/lib/auth/auth.service.ts +++ b/projects/aas-lib/src/lib/auth/auth.service.ts @@ -19,7 +19,7 @@ import { UserProfile, UserRole, JWTPayload, - toBoolean + toBoolean, } from 'common'; import { NotifyService } from '../notify/notify.service'; @@ -31,19 +31,19 @@ import { AuthApiService } from './auth-api.service'; import { WindowService } from '../window.service'; @Injectable({ - providedIn: 'root' + providedIn: 'root', }) export class AuthService { private readonly payload$ = new BehaviorSubject({ role: 'guest' }); private readonly ready$ = new BehaviorSubject(false); private readonly cookies = new Map(); - constructor( + public constructor( private modal: NgbModal, private translate: TranslateService, private api: AuthApiService, private notify: NotifyService, - private window: WindowService + private window: WindowService, ) { this.payload = this.payload$.asObservable(); this.ready = this.ready$.asObservable(); @@ -57,8 +57,8 @@ export class AuthService { } this.loginAsGuest().subscribe({ - error: (error) => notify.error(error), - complete: () => this.ready$.next(true) + error: error => notify.error(error), + complete: () => this.ready$.next(true), }); } @@ -121,7 +121,8 @@ export class AuthService { } return of(void 0); - })); + }), + ); } /** @@ -133,11 +134,13 @@ export class AuthService { return of(void 0); } - return this.login().pipe(map(() => { - if (!this.isAuthorized(role)) { - throw new ApplicationError('Unauthorized access.', ERRORS.UNAUTHORIZED_ACCESS); - } - })); + return this.login().pipe( + map(() => { + if (!this.isAuthorized(role)) { + throw new ApplicationError('Unauthorized access.', ERRORS.UNAUTHORIZED_ACCESS); + } + }), + ); } /** Logs out the current user. */ @@ -169,7 +172,8 @@ export class AuthService { this.window.removeLocalStorageItem('.StayLoggedIn'); } } - })); + }), + ); } /** @@ -183,14 +187,13 @@ export class AuthService { } if (profile) { - return this.api.updateProfile(payload.sub, profile).pipe( - map(result => this.nextPayload(result.token))); + return this.api.updateProfile(payload.sub, profile).pipe(map(result => this.nextPayload(result.token))); } return of(this.modal.open(ProfileFormComponent, { backdrop: 'static', animation: true, keyboard: true })).pipe( mergeMap(form => { form.componentInstance.initialize({ id: payload.sub, name: payload.name }); - return from>(form.result) + return from>(form.result); }), mergeMap(result => { if (result?.token) { @@ -203,7 +206,8 @@ export class AuthService { } return of(void 0); - })); + }), + ); } /** @@ -265,13 +269,16 @@ export class AuthService { const payload = this.payload$.getValue(); if (payload && payload.sub) { const id = payload.sub; - this.api.setCookie(id, { name, data }).pipe( - last(), - mergeMap(() => this.api.getCookies(id))).subscribe( - { - next: (cookies) => cookies.forEach(cookie => this.cookies.set(cookie.name, cookie.data)), - error: (error) => this.notify.error(error) - }); + this.api + .setCookie(id, { name, data }) + .pipe( + last(), + mergeMap(() => this.api.getCookies(id)), + ) + .subscribe({ + next: cookies => cookies.forEach(cookie => this.cookies.set(cookie.name, cookie.data)), + error: error => this.notify.error(error), + }); } else { this.window.setLocalStorageItem(name, data); } @@ -290,7 +297,8 @@ export class AuthService { map(cookies => { this.cookies.clear(); cookies.forEach(cookie => this.cookies.set(cookie.name, cookie.data)); - })); + }), + ); } else { this.window.removeLocalStorageItem(name); return of(void 0); @@ -306,7 +314,7 @@ export class AuthService { private isValid(token: string): boolean { try { const value = jwtDecode(token) as JWTPayload; - return value.exp == null || (Date.now() / 1000 < value.exp); + return value.exp == null || Date.now() / 1000 < value.exp; } catch (error) { return false; } @@ -319,9 +327,9 @@ export class AuthService { this.cookies.clear(); if (payload.sub) { this.api.getCookies(payload.sub).subscribe({ - next: (cookies) => cookies.forEach(cookie => this.cookies.set(cookie.name, cookie.data)), - error: (error) => this.notify.error(error) + next: cookies => cookies.forEach(cookie => this.cookies.set(cookie.name, cookie.data)), + error: error => this.notify.error(error), }); } } -} \ No newline at end of file +} diff --git a/projects/aas-lib/src/lib/auth/login-form/login-form.component.ts b/projects/aas-lib/src/lib/auth/login-form/login-form.component.ts index 92104b8d..08a14d30 100644 --- a/projects/aas-lib/src/lib/auth/login-form/login-form.component.ts +++ b/projects/aas-lib/src/lib/auth/login-form/login-form.component.ts @@ -27,15 +27,16 @@ export interface LoginFormResult { @Component({ selector: 'fhg-login', templateUrl: './login-form.component.html', - styleUrls: ['./login-form.component.scss'] + styleUrls: ['./login-form.component.scss'], }) export class LoginFormComponent { private newPasswordSent = false; - constructor( + public constructor( private modal: NgbActiveModal, private translate: TranslateService, - private api: AuthApiService) { } + private api: AuthApiService, + ) {} public passwordPerEMail = false; @@ -56,7 +57,10 @@ export class LoginFormComponent { this.pushMessage(stringFormat(this.translate.instant(ERRORS.INVALID_EMAIL))); } else { try { - this.pushMessage(stringFormat(this.translate.instant(INFO.NEW_PASSWORD_SENT), this.userId), 'bg-info w-100'); + this.pushMessage( + stringFormat(this.translate.instant(INFO.NEW_PASSWORD_SENT), this.userId), + 'bg-info w-100', + ); } catch (error) { this.pushMessage(messageToString(error, this.translate)); } finally { @@ -67,7 +71,7 @@ export class LoginFormComponent { } public registerUser(): void { - this.modal.close({ action: "register" } as LoginFormResult); + this.modal.close({ action: 'register' } as LoginFormResult); } public submit(): void { @@ -82,18 +86,17 @@ export class LoginFormComponent { this.pushMessage(this.translate.instant(ERRORS.INVALID_PASSWORD)); } else { const credentials: Credentials = { id: this.userId, password: this.password }; - this.api.login(credentials).subscribe( - { - next: value => { - const result: LoginFormResult = { - stayLoggedIn: this.stayLoggedIn, - token: value.token - }; - - this.modal.close(result); - }, - error: error => this.pushMessage(messageToString(error, this.translate)) - }); + this.api.login(credentials).subscribe({ + next: value => { + const result: LoginFormResult = { + stayLoggedIn: this.stayLoggedIn, + token: value.token, + }; + + this.modal.close(result); + }, + error: error => this.pushMessage(messageToString(error, this.translate)), + }); } } @@ -102,15 +105,17 @@ export class LoginFormComponent { } private pushMessage(text: string, type = 'bg-danger w-100'): void { - this.messages = [{ - text: text, - classname: type, - autohide: false, - delay: 0 - }]; + this.messages = [ + { + text: text, + classname: type, + autohide: false, + delay: 0, + }, + ]; } private clearMessages(): void { this.messages = []; } -} \ No newline at end of file +} diff --git a/projects/aas-lib/src/lib/auth/profile-form/profile-form.component.ts b/projects/aas-lib/src/lib/auth/profile-form/profile-form.component.ts index 5284be39..234a8dbc 100644 --- a/projects/aas-lib/src/lib/auth/profile-form/profile-form.component.ts +++ b/projects/aas-lib/src/lib/auth/profile-form/profile-form.component.ts @@ -23,16 +23,16 @@ export interface ProfileFormResult { @Component({ selector: 'fhg-profile', templateUrl: './profile-form.component.html', - styleUrls: ['./profile-form.component.scss'] + styleUrls: ['./profile-form.component.scss'], }) export class ProfileFormComponent { private profile?: UserProfile; - constructor( + public constructor( private modal: NgbActiveModal, private translate: TranslateService, - private api: AuthApiService - ) { } + private api: AuthApiService, + ) {} public id = ''; @@ -82,17 +82,17 @@ export class ProfileFormComponent { const newProfile: UserProfile = { id: this.id, name: this.name ?? getUserNameFromEMail(this.id), - password: this.password1 + password: this.password1, }; this.api.updateProfile(this.profile.id, newProfile).subscribe({ - next: (value) => { + next: value => { const result: ProfileFormResult = { token: value.token }; this.modal.close(result); }, - error: (error) => { + error: error => { this.pushMessage(messageToString(error, this.translate)); - } + }, }); } } @@ -102,10 +102,10 @@ export class ProfileFormComponent { } private pushMessage(message: string): void { - this.messages = [message] + this.messages = [message]; } private clearMessages(): void { this.messages = []; } -} \ No newline at end of file +} diff --git a/projects/aas-lib/src/lib/auth/register-form/register-form.component.ts b/projects/aas-lib/src/lib/auth/register-form/register-form.component.ts index b5fc0118..094dc36e 100644 --- a/projects/aas-lib/src/lib/auth/register-form/register-form.component.ts +++ b/projects/aas-lib/src/lib/auth/register-form/register-form.component.ts @@ -27,10 +27,11 @@ export interface RegisterFormResult { styleUrls: ['./register-form.component.scss'], }) export class RegisterFormComponent { - constructor( + public constructor( private modal: NgbActiveModal, private translate: TranslateService, - private api: AuthApiService) { } + private api: AuthApiService, + ) {} public userId = ''; @@ -72,7 +73,7 @@ export class RegisterFormComponent { const profile: UserProfile = { id: this.userId, name: this.name ?? getUserNameFromEMail(this.userId), - password: this.password1 + password: this.password1, }; let result: RegisterFormResult | undefined; @@ -81,13 +82,13 @@ export class RegisterFormComponent { if (!this.passwordAsEMail) { result = { stayLoggedIn: this.stayLoggedIn, - token: value.token + token: value.token, }; this.modal.close(result); } }, - error: error => this.pushMessage(messageToString(error, this.translate)) + error: error => this.pushMessage(messageToString(error, this.translate)), }); } } @@ -97,10 +98,10 @@ export class RegisterFormComponent { } private pushMessage(message: string): void { - this.messages = [message] + this.messages = [message]; } private clearMessages(): void { this.messages = []; } -} \ No newline at end of file +} diff --git a/projects/aas-lib/src/lib/clipboard.service.ts b/projects/aas-lib/src/lib/clipboard.service.ts index 8747f6ad..caee25b5 100644 --- a/projects/aas-lib/src/lib/clipboard.service.ts +++ b/projects/aas-lib/src/lib/clipboard.service.ts @@ -9,29 +9,28 @@ import { Injectable } from '@angular/core'; @Injectable({ - providedIn: 'root' + providedIn: 'root', }) export class ClipboardService { - private readonly data = new Map(); + private readonly data = new Map(); public contains(format?: string): boolean { return format ? this.data.has(format) : this.data.size > 0; } public get(format: string): T { - return this.data.get(format); + return this.data.get(format) as T; } - public set(format: string, data: any): void { + public set(format: string, data: unknown): void { this.data.set(format, data); } public clear(format?: string): void { if (format) { this.data.delete(format); - } - else { + } else { this.data.clear(); } } -} \ No newline at end of file +} diff --git a/projects/aas-lib/src/lib/convert.ts b/projects/aas-lib/src/lib/convert.ts index 980ffcc0..74f57860 100644 --- a/projects/aas-lib/src/lib/convert.ts +++ b/projects/aas-lib/src/lib/convert.ts @@ -26,7 +26,6 @@ export function messageToString(message: unknown, translate: TranslateService): } else if (typeof message === 'string') { text = message; } else if (message instanceof HttpErrorResponse) { - if (isErrorData(message.error)) { text = format(message.error.message, message.error.name, message.error.args); } else { @@ -58,7 +57,7 @@ export function messageToString(message: unknown, translate: TranslateService): * Resolves the specified error to an displayable object. * @param error The error. * @param translate The translation service. - * @returns + * @returns */ export async function resolveError(error: unknown, translate: TranslateService): Promise { let message = error; diff --git a/projects/aas-lib/src/lib/customer-feedback/customer-feedback.actions.ts b/projects/aas-lib/src/lib/customer-feedback/customer-feedback.actions.ts index 22057a53..a14beb3f 100644 --- a/projects/aas-lib/src/lib/customer-feedback/customer-feedback.actions.ts +++ b/projects/aas-lib/src/lib/customer-feedback/customer-feedback.actions.ts @@ -6,11 +6,11 @@ * *****************************************************************************/ -import { createAction, props } from "@ngrx/store"; -import { FeedbackItem, GeneralItem } from "./customer-feedback.state"; +import { createAction, props } from '@ngrx/store'; +import { FeedbackItem, GeneralItem } from './customer-feedback.state'; export enum CustomerFeedbackActionType { - INITIALIZE = '[CustomerFeedback] initialize' + INITIALIZE = '[CustomerFeedback] initialize', } export const initialize = createAction( @@ -20,5 +20,6 @@ export const initialize = createAction( count: number; starClassNames: string[]; items: GeneralItem[]; - feedbacks: FeedbackItem[] - }>()); + feedbacks: FeedbackItem[]; + }>(), +); diff --git a/projects/aas-lib/src/lib/customer-feedback/customer-feedback.component.ts b/projects/aas-lib/src/lib/customer-feedback/customer-feedback.component.ts index 0952cdb2..d4a6a09f 100644 --- a/projects/aas-lib/src/lib/customer-feedback/customer-feedback.component.ts +++ b/projects/aas-lib/src/lib/customer-feedback/customer-feedback.component.ts @@ -19,17 +19,17 @@ import { selectCustomerFeedback } from './customer-feedback.selectors'; @Component({ selector: 'fhg-customer-feedback', templateUrl: './customer-feedback.component.html', - styleUrls: ['./customer-feedback.component.scss'] + styleUrls: ['./customer-feedback.component.scss'], }) export class CustomerFeedbackComponent implements SubmodelTemplate, OnInit, OnChanges, OnDestroy { private static readonly maxStars = 5; - private readonly store: Store + private readonly store: Store; private readonly map = new Map(); private readonly subscription = new Subscription(); - constructor( + public constructor( store: Store, - private readonly translate: TranslateService + private readonly translate: TranslateService, ) { this.store = store as Store; } @@ -41,9 +41,12 @@ export class CustomerFeedbackComponent implements SubmodelTemplate, OnInit, OnCh let value: string | undefined; if (this.submodels) { const names = this.submodels.map( - item => getLocaleValue( - getPreferredName(item.document.content!, item.submodel), - this.translate.currentLang) ?? item.submodel.idShort); + item => + getLocaleValue( + getPreferredName(item.document.content!, item.submodel), + this.translate.currentLang, + ) ?? item.submodel.idShort, + ); if (names.length <= 2) { value = names.join(', '); @@ -66,17 +69,24 @@ export class CustomerFeedbackComponent implements SubmodelTemplate, OnInit, OnCh public starClassNames: string[] = []; public ngOnInit(): void { - this.subscription.add(this.store.select(selectCustomerFeedback).pipe().subscribe(state => { - this.stars = state.stars; - this.count = state.count; - this.starClassNames = state.starClassNames; - this.items = state.items.filter(item => item.count > 0); - this.feedbacks = state.feedbacks; - })); - - this.subscription.add(this.translate.onLangChange.subscribe(() => { - this.init(); - })); + this.subscription.add( + this.store + .select(selectCustomerFeedback) + .pipe() + .subscribe(state => { + this.stars = state.stars; + this.count = state.count; + this.starClassNames = state.starClassNames; + this.items = state.items.filter(item => item.count > 0); + this.feedbacks = state.feedbacks; + }), + ); + + this.subscription.add( + this.translate.onLangChange.subscribe(() => { + this.init(); + }), + ); } public ngOnChanges(changes: SimpleChanges): void { @@ -101,9 +111,11 @@ export class CustomerFeedbackComponent implements SubmodelTemplate, OnInit, OnCh for (const pair of this.submodels) { if (pair.submodel.submodelElements) { for (const feedback of pair.submodel.submodelElements.filter( - item => item.modelType === 'SubmodelElementCollection')) { + item => item.modelType === 'SubmodelElementCollection', + )) { const general = (feedback as aas.SubmodelElementCollection).value?.find( - item => item.modelType === 'SubmodelElementCollection' && item.idShort === 'General'); + item => item.modelType === 'SubmodelElementCollection' && item.idShort === 'General', + ); if (general) { sumStars += this.getStars(feedback); @@ -115,7 +127,7 @@ export class CustomerFeedbackComponent implements SubmodelTemplate, OnInit, OnCh stars: this.initStarClassNames(this.getStars(feedback)), createdAt: this.getCreatedAt(feedback), subject: pair.submodel.idShort, - message: this.getMessage(feedback) + message: this.getMessage(feedback), }); } } @@ -134,13 +146,15 @@ export class CustomerFeedbackComponent implements SubmodelTemplate, OnInit, OnCh starClassNames = this.initStarClassNames(0); } - this.store.dispatch(CustomerFeedbackActions.initialize({ - stars, - count, - starClassNames, - items, - feedbacks - })); + this.store.dispatch( + CustomerFeedbackActions.initialize({ + stars, + count, + starClassNames, + items, + feedbacks, + }), + ); } private buildItems(general: aas.SubmodelElementCollection, items: GeneralItem[]): void { @@ -153,7 +167,7 @@ export class CustomerFeedbackComponent implements SubmodelTemplate, OnInit, OnCh score: 0, sum: 0.0, count: 0, - like: false + like: false, }; this.map.set(element.idShort, item); @@ -220,7 +234,6 @@ export class CustomerFeedbackComponent implements SubmodelTemplate, OnInit, OnCh } private findProperty(element: aas.SubmodelElementCollection, name: string): aas.Property | undefined { - return element.value?.find( - child => child.modelType === 'Property' && child.idShort === name) as aas.Property; + return element.value?.find(child => child.modelType === 'Property' && child.idShort === name) as aas.Property; } -} \ No newline at end of file +} diff --git a/projects/aas-lib/src/lib/customer-feedback/customer-feedback.reducer.ts b/projects/aas-lib/src/lib/customer-feedback/customer-feedback.reducer.ts index 2be940fb..9828cf7f 100644 --- a/projects/aas-lib/src/lib/customer-feedback/customer-feedback.reducer.ts +++ b/projects/aas-lib/src/lib/customer-feedback/customer-feedback.reducer.ts @@ -6,9 +6,9 @@ * *****************************************************************************/ -import { createReducer, on } from "@ngrx/store"; -import * as CustomerFeedbackActions from "./customer-feedback.actions"; -import { CustomerFeedbackState, FeedbackItem, GeneralItem } from "./customer-feedback.state"; +import { createReducer, on } from '@ngrx/store'; +import * as CustomerFeedbackActions from './customer-feedback.actions'; +import { CustomerFeedbackState, FeedbackItem, GeneralItem } from './customer-feedback.state'; const initialState: CustomerFeedbackState = { stars: 0.0, @@ -16,16 +16,15 @@ const initialState: CustomerFeedbackState = { starClassNames: [], items: [], feedbacks: [], - error: null -} + error: null, +}; export const customerFeedbackReducer = createReducer( initialState, - on( - CustomerFeedbackActions.initialize, - (state, { stars, count, starClassNames, items, feedbacks }) => initialize(state, stars, count, starClassNames, items, feedbacks) - ) -) + on(CustomerFeedbackActions.initialize, (state, { stars, count, starClassNames, items, feedbacks }) => + initialize(state, stars, count, starClassNames, items, feedbacks), + ), +); function initialize( state: CustomerFeedbackState, @@ -33,7 +32,8 @@ function initialize( count: number, starClassNames: string[], items: GeneralItem[], - feedbacks: FeedbackItem[]): CustomerFeedbackState { + feedbacks: FeedbackItem[], +): CustomerFeedbackState { return { ...state, stars: stars, @@ -41,6 +41,6 @@ function initialize( starClassNames: starClassNames, items: items, feedbacks: feedbacks, - error: null + error: null, }; -} \ No newline at end of file +} diff --git a/projects/aas-lib/src/lib/customer-feedback/customer-feedback.selectors.ts b/projects/aas-lib/src/lib/customer-feedback/customer-feedback.selectors.ts index 96def872..ca57654f 100644 --- a/projects/aas-lib/src/lib/customer-feedback/customer-feedback.selectors.ts +++ b/projects/aas-lib/src/lib/customer-feedback/customer-feedback.selectors.ts @@ -11,4 +11,4 @@ import { CustomerFeedbackFeatureState } from './customer-feedback.state'; const getCustomerFeedback = (state: CustomerFeedbackFeatureState) => state.customerFeedback; -export const selectCustomerFeedback = createSelector(getCustomerFeedback, (customerFeedback) => customerFeedback); \ No newline at end of file +export const selectCustomerFeedback = createSelector(getCustomerFeedback, customerFeedback => customerFeedback); diff --git a/projects/aas-lib/src/lib/customer-feedback/customer-feedback.state.ts b/projects/aas-lib/src/lib/customer-feedback/customer-feedback.state.ts index afa480f8..946615ab 100644 --- a/projects/aas-lib/src/lib/customer-feedback/customer-feedback.state.ts +++ b/projects/aas-lib/src/lib/customer-feedback/customer-feedback.state.ts @@ -27,7 +27,7 @@ export interface CustomerFeedbackState { starClassNames: string[]; items: GeneralItem[]; feedbacks: FeedbackItem[]; - error: unknown + error: unknown; } export interface CustomerFeedbackFeatureState { diff --git a/projects/aas-lib/src/lib/digital-nameplate/digital-nameplate.component.ts b/projects/aas-lib/src/lib/digital-nameplate/digital-nameplate.component.ts index 085bf1ba..1a3361c3 100644 --- a/projects/aas-lib/src/lib/digital-nameplate/digital-nameplate.component.ts +++ b/projects/aas-lib/src/lib/digital-nameplate/digital-nameplate.component.ts @@ -6,7 +6,7 @@ * *****************************************************************************/ -import { Component, Input, OnChanges, OnInit, SimpleChanges } from '@angular/core'; +import { Component, Input, OnChanges, SimpleChanges } from '@angular/core'; import { TranslateService } from '@ngx-translate/core'; import { aas, @@ -14,7 +14,7 @@ import { getLocaleValue, isMultiLanguageProperty, isProperty, - isSubmodelElementCollection + isSubmodelElementCollection, } from 'common'; import { DocumentSubmodelPair, SubmodelTemplate } from '../submodel-template/submodel-template'; @@ -32,11 +32,10 @@ export interface DigitalNameplate { @Component({ selector: 'fhg-digital-nameplate', templateUrl: './digital-nameplate.component.html', - styleUrls: ['./digital-nameplate.component.scss'] + styleUrls: ['./digital-nameplate.component.scss'], }) export class DigitalNameplateComponent implements SubmodelTemplate, OnChanges { - - constructor(private readonly translate: TranslateService) { } + public constructor(private readonly translate: TranslateService) {} @Input() public submodels: DocumentSubmodelPair[] | null = null; @@ -50,19 +49,20 @@ export class DigitalNameplateComponent implements SubmodelTemplate, OnChanges { } private init() { - this.nameplates = this.submodels?.map(pair => { - const submodel = pair.submodel; - return { - serialNumber: this.getPropertyValue(submodel, ['SerialNumber']), - productCountryOfOrigin: this.getPropertyValue(submodel, ['ProductCountryOfOrigin']), - yearOfConstruction: this.getPropertyValue(submodel, ['YearOfConstruction']), - manufacturerName: this.getPropertyValue(submodel, ['ManufacturerName']), - countryCode: this.getPropertyValue(submodel, ['PhysicalAddress', 'CountryCode']), - zip: this.getPropertyValue(submodel, ['PhysicalAddress', 'Zip']), - cityTown: this.getPropertyValue(submodel, ['PhysicalAddress', 'CityTown']), - street: this.getPropertyValue(submodel, ['PhysicalAddress', 'Street']) - }; - }) ?? []; + this.nameplates = + this.submodels?.map(pair => { + const submodel = pair.submodel; + return { + serialNumber: this.getPropertyValue(submodel, ['SerialNumber']), + productCountryOfOrigin: this.getPropertyValue(submodel, ['ProductCountryOfOrigin']), + yearOfConstruction: this.getPropertyValue(submodel, ['YearOfConstruction']), + manufacturerName: this.getPropertyValue(submodel, ['ManufacturerName']), + countryCode: this.getPropertyValue(submodel, ['PhysicalAddress', 'CountryCode']), + zip: this.getPropertyValue(submodel, ['PhysicalAddress', 'Zip']), + cityTown: this.getPropertyValue(submodel, ['PhysicalAddress', 'CityTown']), + street: this.getPropertyValue(submodel, ['PhysicalAddress', 'Street']), + }; + }) ?? []; } private getPropertyValue(submodel: aas.Submodel, path: string[]): string { @@ -84,4 +84,4 @@ export class DigitalNameplateComponent implements SubmodelTemplate, OnChanges { return ''; } -} \ No newline at end of file +} diff --git a/projects/aas-lib/src/lib/document.service.ts b/projects/aas-lib/src/lib/document.service.ts index 1081dbbf..9bfa26ce 100644 --- a/projects/aas-lib/src/lib/document.service.ts +++ b/projects/aas-lib/src/lib/document.service.ts @@ -9,14 +9,14 @@ import { Injectable } from '@angular/core'; @Injectable({ - providedIn: 'root' + providedIn: 'root', }) export class DocumentService { public getElementById(elementId: string): HTMLElement | null { return document.getElementById(elementId); } - + public createElement(tagName: string, options?: ElementCreationOptions): HTMLElement { return document.createElement(tagName, options); } -} \ No newline at end of file +} diff --git a/projects/aas-lib/src/lib/download.service.ts b/projects/aas-lib/src/lib/download.service.ts index 4503ca99..0dcba470 100644 --- a/projects/aas-lib/src/lib/download.service.ts +++ b/projects/aas-lib/src/lib/download.service.ts @@ -12,13 +12,10 @@ import { map, Observable } from 'rxjs'; import { encodeBase64Url } from './convert'; @Injectable({ - providedIn: 'root' + providedIn: 'root', }) export class DownloadService { - constructor( - private readonly http: HttpClient - ) { - } + public constructor(private readonly http: HttpClient) {} /** * Download a file from the specified URL. @@ -27,19 +24,22 @@ export class DownloadService { */ public async downloadFileAsync(url: string, filename: string): Promise { return new Promise((resolve, reject) => { - this.http.get( - url, - { - responseType: 'blob' - }).pipe(map(blob => { - const a = document.createElement('a'); - a.href = URL.createObjectURL(blob); - a.setAttribute('download', filename); - a.click(); - URL.revokeObjectURL(a.href); - })).subscribe({ - error: (error) => reject(error), - complete: () => resolve() + this.http + .get(url, { + responseType: 'blob', + }) + .pipe( + map(blob => { + const a = document.createElement('a'); + a.href = URL.createObjectURL(blob); + a.setAttribute('download', filename); + a.click(); + URL.revokeObjectURL(a.href); + }), + ) + .subscribe({ + error: error => reject(error), + complete: () => resolve(), }); }); } @@ -51,19 +51,21 @@ export class DownloadService { * @param name The file name. */ public downloadDocument(endpoint: string, id: string, name: string): Observable { - return this.http.get( - `/api/v1/containers/${encodeBase64Url(endpoint)}/packages/${encodeBase64Url(id)}`, - { - responseType: 'blob' - }).pipe(map(blob => { - const a = document.createElement('a'); - a.href = URL.createObjectURL(blob); - a.setAttribute('download', name); - a.click(); - URL.revokeObjectURL(a.href); - })); + return this.http + .get(`/api/v1/containers/${encodeBase64Url(endpoint)}/packages/${encodeBase64Url(id)}`, { + responseType: 'blob', + }) + .pipe( + map(blob => { + const a = document.createElement('a'); + a.href = URL.createObjectURL(blob); + a.setAttribute('download', name); + a.click(); + URL.revokeObjectURL(a.href); + }), + ); } - + /** * Uploads the specified aasx file. * @param file A file. @@ -77,12 +79,9 @@ export class DownloadService { data.append('file', file); } - return this.http.post( - `/api/v1/containers/${encodeBase64Url(name)}/packages`, - data, - { - reportProgress: true, - observe: 'events' - }); + return this.http.post(`/api/v1/containers/${encodeBase64Url(name)}/packages`, data, { + reportProgress: true, + observe: 'events', + }); } -} \ No newline at end of file +} diff --git a/projects/aas-lib/src/lib/library-table/library-table.component.ts b/projects/aas-lib/src/lib/library-table/library-table.component.ts index 3b49479f..ec6d212e 100644 --- a/projects/aas-lib/src/lib/library-table/library-table.component.ts +++ b/projects/aas-lib/src/lib/library-table/library-table.component.ts @@ -16,7 +16,7 @@ export interface LibraryRow extends Library { @Component({ selector: 'fhg-library-table', templateUrl: './library-table.component.html', - styleUrls: ['./library-table.component.scss'] + styleUrls: ['./library-table.component.scss'], }) export class LibraryTableComponent implements OnChanges { @Input() @@ -41,12 +41,11 @@ export class LibraryTableComponent implements OnChanges { public refreshLibraries(): void { if (this.pageSize > 0 && this.size > this.pageSize) { - this.libraries = this.collection.map((library, i) => ({ id: i + 1, ...library })).slice( - (this.page - 1) * this.pageSize, - (this.page - 1) * this.pageSize + this.pageSize, - ); + this.libraries = this.collection + .map((library, i) => ({ id: i + 1, ...library })) + .slice((this.page - 1) * this.pageSize, (this.page - 1) * this.pageSize + this.pageSize); } else { this.libraries = this.collection.map((library, i) => ({ id: i + 1, ...library })); } } -} \ No newline at end of file +} diff --git a/projects/aas-lib/src/lib/localize/culture-info.ts b/projects/aas-lib/src/lib/localize/culture-info.ts index 16c0310c..f42c3667 100644 --- a/projects/aas-lib/src/lib/localize/culture-info.ts +++ b/projects/aas-lib/src/lib/localize/culture-info.ts @@ -9,4 +9,4 @@ export interface CultureInfo { localeId: string; name: string; -} \ No newline at end of file +} diff --git a/projects/aas-lib/src/lib/localize/localize.component.html b/projects/aas-lib/src/lib/localize/localize.component.html index 4efc0026..11c2d4e5 100644 --- a/projects/aas-lib/src/lib/localize/localize.component.html +++ b/projects/aas-lib/src/lib/localize/localize.component.html @@ -7,15 +7,16 @@ !---------------------------------------------------------------------------->
- -
-
-
{{(culture | async)?.localeId}}
+ +
+
+
{{(culture | async)?.localeId}}
+
+ +
+ @for (culture of cultures | async; track culture) { + {{culture.name}} + }
- -
- @for (culture of cultures | async; track culture) { - {{culture.name}} - } -
\ No newline at end of file diff --git a/projects/aas-lib/src/lib/localize/localize.component.ts b/projects/aas-lib/src/lib/localize/localize.component.ts index 2ce4da76..51359e94 100644 --- a/projects/aas-lib/src/lib/localize/localize.component.ts +++ b/projects/aas-lib/src/lib/localize/localize.component.ts @@ -15,16 +15,16 @@ import { WindowService } from '../window.service'; @Component({ selector: 'fhg-localize', templateUrl: './localize.component.html', - styleUrls: ['./localize.component.scss'] + styleUrls: ['./localize.component.scss'], }) export class LocalizeComponent implements OnInit, OnChanges, OnDestroy { private readonly subscription = new Subscription(); private readonly _cultures = new BehaviorSubject([]); private readonly _culture = new BehaviorSubject(undefined); - constructor( + public constructor( private readonly translate: TranslateService, - private readonly window: WindowService + private readonly window: WindowService, ) { this.cultures = this._cultures.asObservable(); this.culture = this._culture.asObservable(); @@ -56,13 +56,16 @@ export class LocalizeComponent implements OnInit, OnChanges, OnDestroy { public ngOnChanges(changes: SimpleChanges): void { if (changes['languages']) { - const items = this.languages.map(lang => ( - { - localeId: lang, - name: new Intl.DisplayNames([lang], { type: 'language' }).of(lang) - } as CultureInfo)); + const items = this.languages.map( + lang => + ({ + localeId: lang, + name: new Intl.DisplayNames([lang], { type: 'language' }).of(lang), + }) as CultureInfo, + ); - const current = this.findCulture(items, this.translate.currentLang) ?? + const current = + this.findCulture(items, this.translate.currentLang) ?? this.findCulture(items, this.translate.defaultLang) ?? items[0]; @@ -80,10 +83,10 @@ export class LocalizeComponent implements OnInit, OnChanges, OnDestroy { if (item) { this._culture.next(item); } - } + }; private findCulture(cultures: CultureInfo[], localeId: string): CultureInfo | undefined { localeId = localeId?.toLocaleLowerCase(); return cultures.find(item => item.localeId.toLocaleLowerCase() === localeId); } -} \ No newline at end of file +} diff --git a/projects/aas-lib/src/lib/max-length.pipe.ts b/projects/aas-lib/src/lib/max-length.pipe.ts index a90a7c4c..afd17122 100644 --- a/projects/aas-lib/src/lib/max-length.pipe.ts +++ b/projects/aas-lib/src/lib/max-length.pipe.ts @@ -9,7 +9,7 @@ import { Pipe, PipeTransform } from '@angular/core'; @Pipe({ - name: 'max' + name: 'max', }) export class MaxLengthPipe implements PipeTransform { private max = 80; @@ -26,4 +26,4 @@ export class MaxLengthPipe implements PipeTransform { const end = value.slice(value.length - m2 + 2); return start + '...' + end; } -} \ No newline at end of file +} diff --git a/projects/aas-lib/src/lib/message-table/massage-table.reducer.ts b/projects/aas-lib/src/lib/message-table/massage-table.reducer.ts index d46645b5..0453a9de 100644 --- a/projects/aas-lib/src/lib/message-table/massage-table.reducer.ts +++ b/projects/aas-lib/src/lib/message-table/massage-table.reducer.ts @@ -15,27 +15,17 @@ const initialState: MessageTableState = { showWarning: false, showError: true, column: '', - direction: '' + direction: '', }; export const messageTableReducer = createReducer( initialState, - on( - MessageTableActions.setSortParameter, - (state, { column, direction }) => setSortParameter(state, column, direction) + on(MessageTableActions.setSortParameter, (state, { column, direction }) => + setSortParameter(state, column, direction), ), - on( - MessageTableActions.toggleShowError, - (state) => toggleShowError(state) - ), - on( - MessageTableActions.toggleShowInfo, - (state) => toggleShowInfo(state) - ), - on( - MessageTableActions.toggleShowWarning, - (state) => toggleShowWarning(state) - ) + on(MessageTableActions.toggleShowError, state => toggleShowError(state)), + on(MessageTableActions.toggleShowInfo, state => toggleShowInfo(state)), + on(MessageTableActions.toggleShowWarning, state => toggleShowWarning(state)), ); function setSortParameter(state: MessageTableState, column: string, direction: string): MessageTableState { diff --git a/projects/aas-lib/src/lib/message-table/message-table.actions.ts b/projects/aas-lib/src/lib/message-table/message-table.actions.ts index dc227617..d2a92ee0 100644 --- a/projects/aas-lib/src/lib/message-table/message-table.actions.ts +++ b/projects/aas-lib/src/lib/message-table/message-table.actions.ts @@ -17,13 +17,11 @@ export enum MessageTableActionType { export const setSortParameter = createAction( MessageTableActionType.SET_SORT_PARAMETER, - props<{ column: string; direction: string}>()); + props<{ column: string; direction: string }>(), +); -export const toggleShowInfo = createAction( - MessageTableActionType.TOGGLE_SHOW_INFO); +export const toggleShowInfo = createAction(MessageTableActionType.TOGGLE_SHOW_INFO); -export const toggleShowWarning = createAction( - MessageTableActionType.TOGGLE_SHOW_WARNING); +export const toggleShowWarning = createAction(MessageTableActionType.TOGGLE_SHOW_WARNING); -export const toggleShowError = createAction( - MessageTableActionType.TOGGLE_SHOW_ERROR); \ No newline at end of file +export const toggleShowError = createAction(MessageTableActionType.TOGGLE_SHOW_ERROR); diff --git a/projects/aas-lib/src/lib/message-table/message-table.component.ts b/projects/aas-lib/src/lib/message-table/message-table.component.ts index e0b06a8a..8ffe32f7 100644 --- a/projects/aas-lib/src/lib/message-table/message-table.component.ts +++ b/projects/aas-lib/src/lib/message-table/message-table.component.ts @@ -19,12 +19,16 @@ import * as MessageTableSelectors from './message-table.selectors'; @Component({ selector: 'fhg-message-table', templateUrl: './message-table.component.html', - styleUrls: ['./message-table.component.scss'] + styleUrls: ['./message-table.component.scss'], }) export class MessageTableComponent implements OnInit, OnChanges, OnDestroy { private readonly dateTimeOptions: Intl.DateTimeFormatOptions = { - year: 'numeric', month: 'numeric', day: 'numeric', - hour: 'numeric', minute: 'numeric', second: 'numeric' + year: 'numeric', + month: 'numeric', + day: 'numeric', + hour: 'numeric', + minute: 'numeric', + second: 'numeric', }; private readonly store: Store; @@ -35,12 +39,13 @@ export class MessageTableComponent implements OnInit, OnChanges, OnDestroy { showWarning: false, showError: true, column: '', - direction: '' + direction: '', }; - constructor( + public constructor( store: Store, - private translate: TranslateService) { + private translate: TranslateService, + ) { this.store = store as Store; } @@ -74,12 +79,16 @@ export class MessageTableComponent implements OnInit, OnChanges, OnDestroy { } public ngOnInit(): void { - this.subscription.add(this.store.select(MessageTableSelectors.selectState).pipe() - .subscribe(state => { - this.snapshot = state; - this.filterSort(); - this.refreshMessages(); - })); + this.subscription.add( + this.store + .select(MessageTableSelectors.selectState) + .pipe() + .subscribe(state => { + this.snapshot = state; + this.filterSort(); + this.refreshMessages(); + }), + ); } public ngOnDestroy(): void { @@ -132,18 +141,22 @@ export class MessageTableComponent implements OnInit, OnChanges, OnDestroy { } public timestampToString(value: number): string { - return new Intl.DateTimeFormat(this.translate.currentLang, this.dateTimeOptions).format(value) + return new Intl.DateTimeFormat(this.translate.currentLang, this.dateTimeOptions).format(value); } private filterSort(): void { - if (this.snapshot.showError && this.snapshot.showWarning && this.snapshot.showInfo || - !this.snapshot.showError && !this.snapshot.showWarning && !this.snapshot.showInfo) { + if ( + (this.snapshot.showError && this.snapshot.showWarning && this.snapshot.showInfo) || + (!this.snapshot.showError && !this.snapshot.showWarning && !this.snapshot.showInfo) + ) { this._collection = this.collection; - } - else { - this._collection = this.collection.filter(item => item.type === 'Error' && this.snapshot.showError || - item.type === 'Warning' && this.snapshot.showWarning || - item.type === 'Info' && this.snapshot.showInfo); + } else { + this._collection = this.collection.filter( + item => + (item.type === 'Error' && this.snapshot.showError) || + (item.type === 'Warning' && this.snapshot.showWarning) || + (item.type === 'Info' && this.snapshot.showInfo), + ); } if (this.snapshot.column && this.snapshot.direction) { @@ -159,15 +172,14 @@ export class MessageTableComponent implements OnInit, OnChanges, OnDestroy { switch (column) { case 'text': return a.text.localeCompare(b.text, this.translate.currentLang, { sensitivity: 'accent' }); - case 'type': - { - const value = a.type.localeCompare(b.type, this.translate.currentLang, { sensitivity: 'accent' }); - return value !== 0 ? value : (a.timestamp - b.timestamp); - } + case 'type': { + const value = a.type.localeCompare(b.type, this.translate.currentLang, { sensitivity: 'accent' }); + return value !== 0 ? value : a.timestamp - b.timestamp; + } case 'timestamp': return a.timestamp - b.timestamp; default: return 0; } } -} \ No newline at end of file +} diff --git a/projects/aas-lib/src/lib/message-table/message-table.selectors.ts b/projects/aas-lib/src/lib/message-table/message-table.selectors.ts index 60f6aa46..d9d4e604 100644 --- a/projects/aas-lib/src/lib/message-table/message-table.selectors.ts +++ b/projects/aas-lib/src/lib/message-table/message-table.selectors.ts @@ -11,4 +11,4 @@ import { MessageTableFeatureState } from './message-table.state'; const getState = (state: MessageTableFeatureState) => state.messageTable; -export const selectState = createSelector(getState, (state) => state); \ No newline at end of file +export const selectState = createSelector(getState, state => state); diff --git a/projects/aas-lib/src/lib/message-table/message-table.state.ts b/projects/aas-lib/src/lib/message-table/message-table.state.ts index 44a03a1f..fc99bb22 100644 --- a/projects/aas-lib/src/lib/message-table/message-table.state.ts +++ b/projects/aas-lib/src/lib/message-table/message-table.state.ts @@ -16,4 +16,4 @@ export interface MessageTableState { export interface MessageTableFeatureState { messageTable: MessageTableState; -} \ No newline at end of file +} diff --git a/projects/aas-lib/src/lib/notify/notify.component.ts b/projects/aas-lib/src/lib/notify/notify.component.ts index c21e307f..67d5dc4b 100644 --- a/projects/aas-lib/src/lib/notify/notify.component.ts +++ b/projects/aas-lib/src/lib/notify/notify.component.ts @@ -13,11 +13,10 @@ import { NotifyService } from './notify.service'; @Component({ selector: 'fhg-notify', templateUrl: './notify.component.html', - styleUrls: ['./notify.component.scss'] + styleUrls: ['./notify.component.scss'], }) export class NotifyComponent implements OnInit { - - constructor(notify: NotifyService) { + public constructor(notify: NotifyService) { this.notify = notify; } @@ -30,4 +29,4 @@ export class NotifyComponent implements OnInit { public ngOnInit(): void { this.notify.clear(); } -} \ No newline at end of file +} diff --git a/projects/aas-lib/src/lib/notify/notify.service.ts b/projects/aas-lib/src/lib/notify/notify.service.ts index 2cfc609a..f5a7532a 100644 --- a/projects/aas-lib/src/lib/notify/notify.service.ts +++ b/projects/aas-lib/src/lib/notify/notify.service.ts @@ -17,14 +17,14 @@ export enum LogType { Error, Warning, Info, - Debug + Debug, } @Injectable({ - providedIn: 'root' + providedIn: 'root', }) export class NotifyService { - constructor(private translate: TranslateService) { } + public constructor(private translate: TranslateService) {} public messages: MessageEntry[] = []; @@ -35,14 +35,13 @@ export class NotifyService { public async error(error: unknown): Promise { if (error) { const text = await resolveError(error, this.translate); - this.messages.push( - { - header: this.translate.instant('CAPTION_ERROR'), - text: text, - classname: 'bg-danger', - autohide: false, - delay: 5000 - }); + this.messages.push({ + header: this.translate.instant('CAPTION_ERROR'), + text: text, + classname: 'bg-danger', + autohide: false, + delay: 5000, + }); } } @@ -53,14 +52,13 @@ export class NotifyService { public info(message: string, ...args: unknown[]): void { if (message && !isElement(message)) { message = stringFormat(this.translate.instant(message), args); - this.messages.push( - { - header: this.translate.instant('CAPTION_INFO'), - text: message, - classname: 'bg-info', - autohide: true, - delay: 5000 - }); + this.messages.push({ + header: this.translate.instant('CAPTION_INFO'), + text: message, + classname: 'bg-info', + autohide: true, + delay: 5000, + }); } } @@ -102,4 +100,4 @@ export class NotifyService { } } } -} \ No newline at end of file +} diff --git a/projects/aas-lib/src/lib/score/score.component.ts b/projects/aas-lib/src/lib/score/score.component.ts index b3186e25..964d476a 100644 --- a/projects/aas-lib/src/lib/score/score.component.ts +++ b/projects/aas-lib/src/lib/score/score.component.ts @@ -11,7 +11,7 @@ import { Component, Input, OnChanges, SimpleChanges } from '@angular/core'; @Component({ selector: 'fhg-score', templateUrl: './score.component.html', - styleUrls: ['./score.component.scss'] + styleUrls: ['./score.component.scss'], }) export class ScoreComponent implements OnChanges { @Input() @@ -22,7 +22,7 @@ export class ScoreComponent implements OnChanges { public negative = 0; public ngOnChanges(changes: SimpleChanges): void { - if(changes['score']) { + if (changes['score']) { if (this.score >= 0.0) { this.positive = Math.min(Math.round(this.score * 100), 100); this.negative = 0; @@ -32,4 +32,4 @@ export class ScoreComponent implements OnChanges { } } } -} \ No newline at end of file +} diff --git a/projects/aas-lib/src/lib/secured-image/secured-image.component.ts b/projects/aas-lib/src/lib/secured-image/secured-image.component.ts index eff32d44..b133704d 100644 --- a/projects/aas-lib/src/lib/secured-image/secured-image.component.ts +++ b/projects/aas-lib/src/lib/secured-image/secured-image.component.ts @@ -14,10 +14,13 @@ import { DomSanitizer } from '@angular/platform-browser'; @Component({ selector: 'fhg-img', templateUrl: './secured-image.component.html', - styleUrls: ['./secured-image.component.scss'] + styleUrls: ['./secured-image.component.scss'], }) export class SecuredImageComponent implements OnChanges { - constructor(private httpClient: HttpClient, private domSanitizer: DomSanitizer) { + public constructor( + private httpClient: HttpClient, + private domSanitizer: DomSanitizer, + ) { this.dataUrl$ = this.src$.pipe(switchMap(url => this.loadImage(url))); } @@ -54,4 +57,4 @@ export class SecuredImageComponent implements OnChanges { .get(url, { responseType: 'blob' }) .pipe(map(e => this.domSanitizer.bypassSecurityTrustResourceUrl(URL.createObjectURL(e)))); } -} \ No newline at end of file +} diff --git a/projects/aas-lib/src/lib/sortable-header.directive.ts b/projects/aas-lib/src/lib/sortable-header.directive.ts index a163042a..b706bc15 100644 --- a/projects/aas-lib/src/lib/sortable-header.directive.ts +++ b/projects/aas-lib/src/lib/sortable-header.directive.ts @@ -6,9 +6,9 @@ * *****************************************************************************/ -import { Directive, EventEmitter, Input, Output } from "@angular/core"; +import { Directive, EventEmitter, Input, Output } from '@angular/core'; -const rotate: { [key: string]: SortDirection } = { 'asc': 'desc', 'desc': '', '': 'asc' }; +const rotate: { [key: string]: SortDirection } = { asc: 'desc', desc: '', '': 'asc' }; export type SortDirection = 'asc' | 'desc' | ''; @@ -18,12 +18,14 @@ export interface SortEvent { } @Directive({ + // eslint-disable-next-line @angular-eslint/directive-selector selector: 'th[sortable]', + // eslint-disable-next-line @angular-eslint/no-host-metadata-property host: { '[class.asc]': 'direction === "asc"', '[class.desc]': 'direction === "desc"', - '(click)': 'rotate()' - } + '(click)': 'rotate()', + }, }) export class SortableHeaderDirective { @Input() @@ -39,4 +41,4 @@ export class SortableHeaderDirective { this.direction = rotate[this.direction]; this.sort.emit({ column: this.sortable, direction: this.direction }); } -} \ No newline at end of file +} diff --git a/projects/aas-lib/src/lib/submodel-template/submodel-template.ts b/projects/aas-lib/src/lib/submodel-template/submodel-template.ts index 4c88615b..8ef44157 100644 --- a/projects/aas-lib/src/lib/submodel-template/submodel-template.ts +++ b/projects/aas-lib/src/lib/submodel-template/submodel-template.ts @@ -36,7 +36,7 @@ export const FHGNameplate = 'urn:IOSB:Fraunhofer:de:KIReallabor:CUNACup:SemId:Su export const supportedSubmodelTemplates = new Map([ [ZVEINameplate, 'Nameplate'], - [CustomerFeedback, 'CustomerFeedback'] + [CustomerFeedback, 'CustomerFeedback'], ]); const semanticIdMap = new Map([ @@ -44,7 +44,7 @@ const semanticIdMap = new Map([ [ZVEINameplate, ZVEINameplate], ['urn:IOSB:Fraunhofer:de:KIReallabor:CUNACup:SemId:Submodel:Nameplate', ZVEINameplate], ['https://admin-shell.io/zvei/nameplate/2/0/Nameplate', ZVEINameplate], - [CustomerFeedback, CustomerFeedback] + [CustomerFeedback, CustomerFeedback], ]); export function resolveSemanticId(value: aas.HasSemantic | aas.Reference | string): string | undefined { @@ -68,4 +68,4 @@ export function resolveSemanticId(value: aas.HasSemantic | aas.Reference | strin function isReference(value: unknown): value is aas.Reference { return Array.isArray((value as aas.Reference).keys); } -} \ No newline at end of file +} diff --git a/projects/aas-lib/src/lib/types/aas-query-params.ts b/projects/aas-lib/src/lib/types/aas-query-params.ts index e962eefb..7dd2c218 100644 --- a/projects/aas-lib/src/lib/types/aas-query-params.ts +++ b/projects/aas-lib/src/lib/types/aas-query-params.ts @@ -7,12 +7,12 @@ *****************************************************************************/ export interface AASQueryParams { - format?: string, - id?: string + format?: string; + id?: string; } export interface AASQuery { id: string; name?: string; search?: string; -} \ No newline at end of file +} diff --git a/projects/aas-lib/src/lib/types/environment.ts b/projects/aas-lib/src/lib/types/environment.ts index 88a402a7..866c5c67 100644 --- a/projects/aas-lib/src/lib/types/environment.ts +++ b/projects/aas-lib/src/lib/types/environment.ts @@ -12,4 +12,4 @@ export interface Environment { version: string; homepage: string; author: string; -} \ No newline at end of file +} diff --git a/projects/aas-lib/src/lib/types/errors.ts b/projects/aas-lib/src/lib/types/errors.ts index 21d2b06c..367127ef 100644 --- a/projects/aas-lib/src/lib/types/errors.ts +++ b/projects/aas-lib/src/lib/types/errors.ts @@ -17,4 +17,4 @@ export const ERRORS = { PASSWORDS_NOT_EQUAL: 'ERROR_PASSWORDS_NOT_EQUAL', DASHBOARD_PAGE_ALREADY_EXISTS: 'ERROR_DASHBOARD_PAGE_ALREADY_EXISTS', UNAUTHORIZED_ACCESS: 'ERROR_UNAUTHORIZED_ACCESS', -} \ No newline at end of file +}; diff --git a/projects/aas-lib/src/lib/types/info.ts b/projects/aas-lib/src/lib/types/info.ts index e0a980b0..ce0ebd38 100644 --- a/projects/aas-lib/src/lib/types/info.ts +++ b/projects/aas-lib/src/lib/types/info.ts @@ -7,5 +7,5 @@ *****************************************************************************/ export const INFO = { - NEW_PASSWORD_SENT: 'INFO_NEW_PASSWORD_SENT' -}; \ No newline at end of file + NEW_PASSWORD_SENT: 'INFO_NEW_PASSWORD_SENT', +}; diff --git a/projects/aas-lib/src/lib/types/message-entry.ts b/projects/aas-lib/src/lib/types/message-entry.ts index d4e364b5..bcd1a68c 100644 --- a/projects/aas-lib/src/lib/types/message-entry.ts +++ b/projects/aas-lib/src/lib/types/message-entry.ts @@ -12,4 +12,4 @@ export interface MessageEntry { delay: number; autohide: boolean; classname?: string; -} \ No newline at end of file +} diff --git a/projects/aas-lib/src/lib/types/online-state.ts b/projects/aas-lib/src/lib/types/online-state.ts index cba75e32..ae431cc9 100644 --- a/projects/aas-lib/src/lib/types/online-state.ts +++ b/projects/aas-lib/src/lib/types/online-state.ts @@ -6,4 +6,4 @@ * *****************************************************************************/ -export type OnlineState = 'offline' | 'online'; \ No newline at end of file +export type OnlineState = 'offline' | 'online'; diff --git a/projects/aas-lib/src/lib/types/view-mode.ts b/projects/aas-lib/src/lib/types/view-mode.ts index 1d676513..1da6b968 100644 --- a/projects/aas-lib/src/lib/types/view-mode.ts +++ b/projects/aas-lib/src/lib/types/view-mode.ts @@ -9,5 +9,5 @@ export enum ViewMode { Undefined = '', List = 'list', - Tree = 'tree' -} \ No newline at end of file + Tree = 'tree', +} diff --git a/projects/aas-lib/src/lib/types/view-query-params.ts b/projects/aas-lib/src/lib/types/view-query-params.ts index 2732827f..9cd480ac 100644 --- a/projects/aas-lib/src/lib/types/view-query-params.ts +++ b/projects/aas-lib/src/lib/types/view-query-params.ts @@ -6,12 +6,12 @@ * *****************************************************************************/ -import { SubmodelViewDescriptor } from "../submodel-template/submodel-template"; +import { SubmodelViewDescriptor } from '../submodel-template/submodel-template'; export interface ViewQueryParams { - format: string, + format: string; } export interface ViewQuery { descriptor: SubmodelViewDescriptor; -} \ No newline at end of file +} diff --git a/projects/aas-lib/src/lib/web-socket-factory.service.ts b/projects/aas-lib/src/lib/web-socket-factory.service.ts index 4d518338..57dd6f68 100644 --- a/projects/aas-lib/src/lib/web-socket-factory.service.ts +++ b/projects/aas-lib/src/lib/web-socket-factory.service.ts @@ -11,7 +11,7 @@ import { WebSocketData } from 'common'; import { webSocket, WebSocketSubject } from 'rxjs/webSocket'; @Injectable({ - providedIn: 'root' + providedIn: 'root', }) export class WebSocketFactoryService { /** @@ -27,4 +27,4 @@ export class WebSocketFactoryService { return webSocket(url); } -} \ No newline at end of file +} diff --git a/projects/aas-lib/src/lib/window.service.ts b/projects/aas-lib/src/lib/window.service.ts index b51edfcc..8053702c 100644 --- a/projects/aas-lib/src/lib/window.service.ts +++ b/projects/aas-lib/src/lib/window.service.ts @@ -9,7 +9,7 @@ import { Injectable } from '@angular/core'; @Injectable({ - providedIn: 'root' + providedIn: 'root', }) export class WindowService { /** @@ -55,16 +55,16 @@ export class WindowService { public addEventListener( type: K, listener: (this: Window, ev: WindowEventMap[K]) => unknown, - options?: boolean | AddEventListenerOptions + options?: boolean | AddEventListenerOptions, ): void { - window.addEventListener(type, listener, options) + window.addEventListener(type, listener, options); } public removeEventListener( type: K, listener: (this: Window, ev: WindowEventMap[K]) => unknown, - options?: boolean | EventListenerOptions + options?: boolean | EventListenerOptions, ): void { - window.removeEventListener(type, listener, options) + window.removeEventListener(type, listener, options); } -} \ No newline at end of file +} diff --git a/projects/aas-lib/src/test/assets/test-web-socket-factory.service.ts b/projects/aas-lib/src/test/assets/test-web-socket-factory.service.ts index 4bee7ce2..e07a1568 100644 --- a/projects/aas-lib/src/test/assets/test-web-socket-factory.service.ts +++ b/projects/aas-lib/src/test/assets/test-web-socket-factory.service.ts @@ -12,7 +12,7 @@ import { WebSocketSubject } from 'rxjs/webSocket'; import { WebSocketFactoryService } from '../../lib/web-socket-factory.service'; export class TestWebSocketFactoryService implements Partial { - constructor(private readonly subject: Subject) {} + public constructor(private readonly subject: Subject) {} public create(): WebSocketSubject { return this.subject as WebSocketSubject; diff --git a/projects/aas-portal/.eslintrc.json b/projects/aas-portal/.eslintrc.json index f9f1c647..f73abb67 100644 --- a/projects/aas-portal/.eslintrc.json +++ b/projects/aas-portal/.eslintrc.json @@ -1,37 +1,53 @@ { - "extends": "../../.eslintrc.json", - "ignorePatterns": [ - "!**/*" - ], - "overrides": [ - { - "files": [ - "*.ts" - ], - "rules": { - "@angular-eslint/directive-selector": [ - "error", - { - "type": "attribute", - "prefix": "fhg", - "style": "camelCase" - } - ], - "@angular-eslint/component-selector": [ - "error", - { - "type": "element", - "prefix": "fhg", - "style": "kebab-case" - } - ] - } - }, - { - "files": [ - "*.html" - ], - "rules": {} - } - ] -} + "extends": "../../.eslintrc.json", + "ignorePatterns": [ + "!**/*" + ], + "overrides": [ + { + "files": [ + "*.ts" + ], + "extends": [ + "plugin:@angular-eslint/recommended", + "plugin:@angular-eslint/template/process-inline-templates" + ], + "rules": { + "@angular-eslint/directive-selector": [ + "error", + { + "type": "attribute", + "prefix": "fhg", + "style": "camelCase" + } + ], + "@angular-eslint/component-selector": [ + "error", + { + "type": "element", + "prefix": "fhg", + "style": "kebab-case" + } + ] + } + }, + { + "files": [ + "*.html" + ], + "extends": [ + "plugin:@angular-eslint/template/recommended", + "plugin:@angular-eslint/template/accessibility" + ], + "rules": {} + }, + { + "files": [ + "*.ts" + ], + "extends": [ + "plugin:@ngrx/recommended" + ] + } + ] +} \ No newline at end of file diff --git a/projects/aas-portal/package.json b/projects/aas-portal/package.json index 77c555cf..3a810447 100644 --- a/projects/aas-portal/package.json +++ b/projects/aas-portal/package.json @@ -12,7 +12,9 @@ "build": "ng build", "build:debug": "ng build --configuration development", "test": "ng test aas-portal", - "tsc": "rimraf build && tsc -p tsconfig.json" + "tsc": "rimraf build && tsc -p tsconfig.json", + "lint": "ng lint aas-portal", + "format": "ng lint aas-portal --fix" }, "private": true, "dependencies": { diff --git a/projects/aas-portal/src/app/aas/aas-api.service.ts b/projects/aas-portal/src/app/aas/aas-api.service.ts index 145a3a2c..55bea7a7 100644 --- a/projects/aas-portal/src/app/aas/aas-api.service.ts +++ b/projects/aas-portal/src/app/aas/aas-api.service.ts @@ -14,13 +14,10 @@ import { encodeBase64Url } from 'projects/aas-lib/src/public-api'; /** The client side AAS provider service. */ @Injectable({ - providedIn: 'root' + providedIn: 'root', }) export class AASApiService { - constructor( - private readonly http: HttpClient - ) { - } + public constructor(private readonly http: HttpClient) {} /** * Gets the AAS document with the specified identifier. @@ -30,7 +27,9 @@ export class AASApiService { */ public getDocument(id: string, name?: string): Observable { if (name) { - return this.http.get(`/api/v1/containers/${encodeBase64Url(name)}/documents/${encodeBase64Url(id)}`); + return this.http.get( + `/api/v1/containers/${encodeBase64Url(name)}/documents/${encodeBase64Url(id)}`, + ); } return this.http.get(`/api/v1/documents/${encodeBase64Url(id)}`); @@ -53,6 +52,7 @@ export class AASApiService { formData.append('content', new Blob([JSON.stringify(document.content)])); return this.http.put( `/api/v1/containers/${encodeBase64Url(document.endpoint)}/documents/${encodeBase64Url(document.id)}`, - formData); + formData, + ); } -} \ No newline at end of file +} diff --git a/projects/aas-portal/src/app/aas/aas.actions.ts b/projects/aas-portal/src/app/aas/aas.actions.ts index 5e25ec42..76d99421 100644 --- a/projects/aas-portal/src/app/aas/aas.actions.ts +++ b/projects/aas-portal/src/app/aas/aas.actions.ts @@ -17,33 +17,24 @@ export enum AASActionType { APPLY_DOCUMENT = '[AAS] apply document', RESET_MODIFIED = '[AAS] reset modified', SET_DASHBOARD = '[AAS] set dashboard', - SET_SEARCH = '[AAS] set search' + SET_SEARCH = '[AAS] set search', } export interface GetDocumentAction extends TypedAction { id: string; name?: string; } -export const getDocument = createAction( - AASActionType.GET_DOCUMENT, - props<{ id: string, name?: string }>()); +export const getDocument = createAction(AASActionType.GET_DOCUMENT, props<{ id: string; name?: string }>()); -export const setDocument = createAction( - AASActionType.SET_DOCUMENT, - props<{ document: AASDocument | null }>()); +export const setDocument = createAction(AASActionType.SET_DOCUMENT, props<{ document: AASDocument | null }>()); -export const applyDocument = createAction( - AASActionType.APPLY_DOCUMENT, - props<{ document: AASDocument }>()); +export const applyDocument = createAction(AASActionType.APPLY_DOCUMENT, props<{ document: AASDocument }>()); export const setTemplateStorage = createAction( - AASActionType.SET_TEMPLATE_STORAGE, - props<{ templates: TemplateDescriptor[] }>()); + AASActionType.SET_TEMPLATE_STORAGE, + props<{ templates: TemplateDescriptor[] }>(), +); -export const resetModified = createAction( - AASActionType.RESET_MODIFIED, - props<{ document: AASDocument }>()); +export const resetModified = createAction(AASActionType.RESET_MODIFIED, props<{ document: AASDocument }>()); -export const setSearch = createAction( - AASActionType.SET_SEARCH, - props<{ search: string }>()); \ No newline at end of file +export const setSearch = createAction(AASActionType.SET_SEARCH, props<{ search: string }>()); diff --git a/projects/aas-portal/src/app/aas/aas.component.ts b/projects/aas-portal/src/app/aas/aas.component.ts index 9134f57b..dbf8d19e 100644 --- a/projects/aas-portal/src/app/aas/aas.component.ts +++ b/projects/aas-portal/src/app/aas/aas.component.ts @@ -12,7 +12,16 @@ import { ActivatedRoute, Router } from '@angular/router'; import { EMPTY, map, mergeMap, Observable, Subscription, from } from 'rxjs'; import { NgbModal } from '@ng-bootstrap/ng-bootstrap'; import { Store } from '@ngrx/store'; -import { AASQuery, AASQueryParams, AuthService, ClipboardService, DownloadService, NotifyService, OnlineState, encodeBase64Url } from 'projects/aas-lib/src/public-api'; +import { + AASQuery, + AASQueryParams, + AuthService, + ClipboardService, + DownloadService, + NotifyService, + OnlineState, + encodeBase64Url, +} from 'projects/aas-lib/src/public-api'; import { CommandHandlerService } from '../aas/command-handler.service'; import { EditElementFormComponent } from './edit-element-form/edit-element-form.component'; @@ -28,19 +37,12 @@ import { State } from './aas.state'; import { DashboardChartType } from '../dashboard/dashboard.state'; import { DashboardQuery } from '../types/dashboard-query-params'; import { ToolbarService } from '../toolbar.service'; -import { - AASDocument, - equalDocument, - TemplateDescriptor, - aas, isProperty, - isNumberType, - isBlob, -} from 'common'; +import { AASDocument, equalDocument, TemplateDescriptor, aas, isProperty, isNumberType, isBlob } from 'common'; @Component({ selector: 'fhg-aas', templateUrl: './aas.component.html', - styleUrls: ['./aas.component.scss'] + styleUrls: ['./aas.component.scss'], }) export class AASComponent implements OnInit, OnDestroy, AfterViewInit { private readonly store: Store; @@ -49,7 +51,7 @@ export class AASComponent implements OnInit, OnDestroy, AfterViewInit { private _dashboardPage = ''; private templates: TemplateDescriptor[] = []; - constructor( + public constructor( store: Store, private readonly router: Router, private readonly route: ActivatedRoute, @@ -61,13 +63,13 @@ export class AASComponent implements OnInit, OnDestroy, AfterViewInit { private readonly commandHandler: CommandHandlerService, private readonly toolbar: ToolbarService, private readonly auth: AuthService, - private readonly clipboard: ClipboardService + private readonly clipboard: ClipboardService, ) { this.store = store as Store; this.search = this.store.select(AASSelectors.selectSearch); this.editable = this.store.select(AASSelectors.selectEditable); - this.dashboardPages = this.dashboard.pages.pipe((map(pages => pages.map(page => page.name)))); + this.dashboardPages = this.dashboard.pages.pipe(map(pages => pages.map(page => page.name))); } @ViewChild('aasToolbar', { read: TemplateRef }) @@ -90,7 +92,7 @@ export class AASComponent implements OnInit, OnDestroy, AfterViewInit { } public get id(): string { - return this.document?.id ?? '-' + return this.document?.id ?? '-'; } public get assetId(): string { @@ -104,7 +106,7 @@ export class AASComponent implements OnInit, OnDestroy, AfterViewInit { return `/api/v1/containers/${name}/documents/${id}/thumbnail`; } - return 'assets/resources/aas.svg' + return 'assets/resources/aas.svg'; } public get version(): string { @@ -140,7 +142,7 @@ export class AASComponent implements OnInit, OnDestroy, AfterViewInit { query = this.clipboard.get(params.format); } else if (params.id) { query = { - id: params.id + id: params.id, }; } @@ -152,37 +154,54 @@ export class AASComponent implements OnInit, OnDestroy, AfterViewInit { this.store.dispatch(AASActions.getDocument({ id: query.id, name: query.name })); } - this.subscription.add(this.store.select(AASSelectors.selectDocument).pipe() - .subscribe((value) => { - if (!equalDocument(this.document, value)) { - this.commandHandler.clear(); - } - - this.document = value; - })); - - this.subscription.add(this.store.select(AASSelectors.selectTemplateStorage).pipe( - mergeMap(templateStorage => { - if (templateStorage.timestamp === 0) { - return this.api.getTemplates().pipe( - map(templates => this.store.dispatch(AASActions.setTemplateStorage({ templates }))) - ); - } else { - return EMPTY; - } - })) - .subscribe({ - error: error => this.notify.error(error) - })); - - this.subscription.add(this.store.select(AASSelectors.selectTemplates).pipe() - .subscribe(templates => { - this.templates = templates; - })); - - this.subscription.add(this.dashboard.name.subscribe(name => { - this._dashboardPage = name; - })); + this.subscription.add( + this.store + .select(AASSelectors.selectDocument) + .pipe() + .subscribe(value => { + if (!equalDocument(this.document, value)) { + this.commandHandler.clear(); + } + + this.document = value; + }), + ); + + this.subscription.add( + this.store + .select(AASSelectors.selectTemplateStorage) + .pipe( + mergeMap(templateStorage => { + if (templateStorage.timestamp === 0) { + return this.api + .getTemplates() + .pipe( + map(templates => this.store.dispatch(AASActions.setTemplateStorage({ templates }))), + ); + } else { + return EMPTY; + } + }), + ) + .subscribe({ + error: error => this.notify.error(error), + }), + ); + + this.subscription.add( + this.store + .select(AASSelectors.selectTemplates) + .pipe() + .subscribe(templates => { + this.templates = templates; + }), + ); + + this.subscription.add( + this.dashboard.name.subscribe(name => { + this._dashboardPage = name; + }), + ); } public ngAfterViewInit(): void { @@ -208,9 +227,12 @@ export class AASComponent implements OnInit, OnDestroy, AfterViewInit { public canAddToDashboard(): boolean { const selectedElements = this.selectedElements; - return this.dashboardPage != null && this.document != null && + return ( + this.dashboardPage != null && + this.document != null && selectedElements.length > 0 && - selectedElements.every(element => this.isNumberProperty(element) || this.isTimeSeries(element)); + selectedElements.every(element => this.isNumberProperty(element) || this.isTimeSeries(element)) + ); } public async addToDashboard(chartType: string): Promise { @@ -223,7 +245,8 @@ export class AASComponent implements OnInit, OnDestroy, AfterViewInit { this.dashboardPage, this.document, this.selectedElements, - chartType as DashboardChartType); + chartType as DashboardChartType, + ); this.clipboard.set('DashboardQuery', { page: this.dashboardPage } as DashboardQuery); return await this.router.navigateByUrl('/dashboard?format=DashboardQuery'); @@ -234,23 +257,28 @@ export class AASComponent implements OnInit, OnDestroy, AfterViewInit { } public canSynchronize(): boolean { - return this.document != null && !this.document.readonly && this.document.modified ? this.document.modified : false; + return this.document != null && !this.document.readonly && this.document.modified + ? this.document.modified + : false; } public synchronize(): void { if (!this.canSynchronize() || !this.document) return; const document = this.document; - this.auth.ensureAuthorized('editor').pipe( - mergeMap(() => this.api.putDocument(document)), - map((messages) => { - if (messages && messages.length > 0) { - this.notify.info(messages.join('\r\n')); - } - - this.store.dispatch(AASActions.resetModified({ document })); - })).subscribe({ error: (error) => this.notify.error(error) }); + this.auth + .ensureAuthorized('editor') + .pipe( + mergeMap(() => this.api.putDocument(document)), + map(messages => { + if (messages && messages.length > 0) { + this.notify.info(messages.join('\r\n')); + } + this.store.dispatch(AASActions.resetModified({ document })); + }), + ) + .subscribe({ error: error => this.notify.error(error) }); } public canUndo(): boolean { @@ -281,21 +309,23 @@ export class AASComponent implements OnInit, OnDestroy, AfterViewInit { if (!this.document?.content || this.selectedElements.length !== 1) return; const document = this.document; - this.auth.ensureAuthorized('editor').pipe( - map(() => this.modal.open(NewElementFormComponent, { backdrop: 'static' })), - mergeMap((modalRef) => { - modalRef.componentInstance.initialize(document.content, this.selectedElements[0], this.templates); - return from>(modalRef.result) - }), - map((result) => { - if (!result) return; - - this.commandHandler.execute(new NewElementCommand( - this.store, - document, - this.selectedElements[0], - result.element)); - })).subscribe({ error: (error) => this.notify.error(error) }); + this.auth + .ensureAuthorized('editor') + .pipe( + map(() => this.modal.open(NewElementFormComponent, { backdrop: 'static' })), + mergeMap(modalRef => { + modalRef.componentInstance.initialize(document.content, this.selectedElements[0], this.templates); + return from>(modalRef.result); + }), + map(result => { + if (!result) return; + + this.commandHandler.execute( + new NewElementCommand(this.store, document, this.selectedElements[0], result.element), + ); + }), + ) + .subscribe({ error: error => this.notify.error(error) }); } public canEditElement(): boolean { @@ -306,36 +336,44 @@ export class AASComponent implements OnInit, OnDestroy, AfterViewInit { if (!this.document?.content || this.selectedElements.length !== 1) return; const document = this.document; - this.auth.ensureAuthorized('editor').pipe( - map(() => this.modal.open(EditElementFormComponent, { backdrop: 'static' })), - mergeMap((modalRef) => { - modalRef.componentInstance.initialize(this.selectedElements[0]); - return from>(modalRef.result); - }), - map((result) => { - if (!result) return; - - this.commandHandler.execute(new UpdateElementCommand( - this.store, - document, - this.selectedElements[0], - result)); - })).subscribe({ error: (error) => this.notify.error(error) }); + this.auth + .ensureAuthorized('editor') + .pipe( + map(() => this.modal.open(EditElementFormComponent, { backdrop: 'static' })), + mergeMap(modalRef => { + modalRef.componentInstance.initialize(this.selectedElements[0]); + return from>(modalRef.result); + }), + map(result => { + if (!result) return; + + this.commandHandler.execute( + new UpdateElementCommand(this.store, document, this.selectedElements[0], result), + ); + }), + ) + .subscribe({ error: error => this.notify.error(error) }); } public canDeleteElement(): boolean { - return this.selectedElements.length > 0 && - this.selectedElements.every(item => item.modelType !== 'AssetAdministrationShell'); + return ( + this.selectedElements.length > 0 && + this.selectedElements.every(item => item.modelType !== 'AssetAdministrationShell') + ); } public deleteElement(): void { if (!this.document || this.selectedElements.length <= 0) return; const document = this.document; - this.auth.ensureAuthorized('editor').pipe( - map(() => { - this.commandHandler.execute(new DeleteCommand(this.store, document, this.selectedElements)); - })).subscribe({ error: (error) => this.notify.error(error) }); + this.auth + .ensureAuthorized('editor') + .pipe( + map(() => { + this.commandHandler.execute(new DeleteCommand(this.store, document, this.selectedElements)); + }), + ) + .subscribe({ error: error => this.notify.error(error) }); } public canDownloadDocument(): boolean { @@ -343,10 +381,9 @@ export class AASComponent implements OnInit, OnDestroy, AfterViewInit { } public downloadDocument(): void { - this.download.downloadDocument( - this.document!.endpoint, - this.document!.id, - this.document!.idShort + '.aasx').subscribe({ error: (error) => this.notify.error(error) }); + this.download + .downloadDocument(this.document!.endpoint, this.document!.id, this.document!.idShort + '.aasx') + .subscribe({ error: error => this.notify.error(error) }); } public applySearch(text: string): void { @@ -379,11 +416,13 @@ export class AASComponent implements OnInit, OnDestroy, AfterViewInit { return false; } - // Hack, Hack + // Hack, Hack private isTimeSeries(element: aas.Referable): boolean { - return isBlob(element) && + return ( + isBlob(element) && element.value != null && element.idShort === 'TimeSeriesHistory' && - element.contentType === 'application/json'; + element.contentType === 'application/json' + ); } -} \ No newline at end of file +} diff --git a/projects/aas-portal/src/app/aas/aas.effects.ts b/projects/aas-portal/src/app/aas/aas.effects.ts index 43e86e9e..acd60fd2 100644 --- a/projects/aas-portal/src/app/aas/aas.effects.ts +++ b/projects/aas-portal/src/app/aas/aas.effects.ts @@ -17,13 +17,17 @@ import { AASApiService } from './aas-api.service'; export class AASEffects { public constructor( private readonly actions: Actions, - private readonly api: AASApiService - ) { } + private readonly api: AASApiService, + ) {} public getDocument = createEffect(() => { return this.actions.pipe( ofType(AASActions.AASActionType.GET_DOCUMENT), - exhaustMap(action => this.api.getDocument(action.id, action.name).pipe( - map(document => AASActions.setDocument({ document }))))); + exhaustMap(action => + this.api + .getDocument(action.id, action.name) + .pipe(map(document => AASActions.setDocument({ document }))), + ), + ); }); -} \ No newline at end of file +} diff --git a/projects/aas-portal/src/app/aas/aas.reducer.ts b/projects/aas-portal/src/app/aas/aas.reducer.ts index 482a6ece..cd5fcfee 100644 --- a/projects/aas-portal/src/app/aas/aas.reducer.ts +++ b/projects/aas-portal/src/app/aas/aas.reducer.ts @@ -6,32 +6,18 @@ * *****************************************************************************/ -import { createReducer, on } from "@ngrx/store"; -import { AASDocument, TemplateDescriptor } from "common"; -import * as AASActions from "./aas.actions"; -import { AASState, initialState } from "./aas.state"; +import { createReducer, on } from '@ngrx/store'; +import { AASDocument, TemplateDescriptor } from 'common'; +import * as AASActions from './aas.actions'; +import { AASState, initialState } from './aas.state'; -export const aasReducer = createReducer(initialState, - on( - AASActions.applyDocument, - (state, { document }) => applyDocument(state, document) - ), - on( - AASActions.resetModified, - (state, { document }) => resetModified(state, document) - ), - on( - AASActions.setDocument, - (state, { document }) => setDocument(state, document) - ), - on( - AASActions.setSearch, - (state, { search }) => setSearch(state, search) - ), - on( - AASActions.setTemplateStorage, - (state, { templates }) => setTemplateStorage(state, templates) - ) +export const aasReducer = createReducer( + initialState, + on(AASActions.applyDocument, (state, { document }) => applyDocument(state, document)), + on(AASActions.resetModified, (state, { document }) => resetModified(state, document)), + on(AASActions.setDocument, (state, { document }) => setDocument(state, document)), + on(AASActions.setSearch, (state, { search }) => setSearch(state, search)), + on(AASActions.setTemplateStorage, (state, { templates }) => setTemplateStorage(state, templates)), ); function setTemplateStorage(state: AASState, templates: TemplateDescriptor[]): AASState { @@ -52,4 +38,4 @@ function resetModified(state: AASState, document: AASDocument): AASState { function setSearch(state: AASState, search: string): AASState { return { ...state, search }; -} \ No newline at end of file +} diff --git a/projects/aas-portal/src/app/aas/aas.selectors.ts b/projects/aas-portal/src/app/aas/aas.selectors.ts index a027d918..401a13f2 100644 --- a/projects/aas-portal/src/app/aas/aas.selectors.ts +++ b/projects/aas-portal/src/app/aas/aas.selectors.ts @@ -6,8 +6,8 @@ * *****************************************************************************/ -import { createSelector } from "@ngrx/store"; -import { State } from "./aas.state"; +import { createSelector } from '@ngrx/store'; +import { State } from './aas.state'; const getReadOnly = (state: State) => state.aas.document?.readonly ?? true; const getOnlineReady = (state: State) => state.aas.document?.onlineReady ?? false; @@ -30,4 +30,4 @@ export const selectHasDocument = createSelector(getDocument, document => documen export const selectTemplateStorage = createSelector(getTemplateStorage, templateStorage => templateStorage); -export const selectTemplates = createSelector(getTemplates, templates => templates); \ No newline at end of file +export const selectTemplates = createSelector(getTemplates, templates => templates); diff --git a/projects/aas-portal/src/app/aas/aas.state.ts b/projects/aas-portal/src/app/aas/aas.state.ts index 550f5e0f..28a8edd1 100644 --- a/projects/aas-portal/src/app/aas/aas.state.ts +++ b/projects/aas-portal/src/app/aas/aas.state.ts @@ -6,7 +6,7 @@ * *****************************************************************************/ -import { AASDocument, TemplateDescriptor } from "common"; +import { AASDocument, TemplateDescriptor } from 'common'; export interface TemplateStorage { timestamp: number; @@ -25,11 +25,11 @@ export const initialState: AASState = { search: '', templateStorage: { timestamp: 0, - templates: [] + templates: [], }, - error: null + error: null, }; export interface State { aas: AASState; -} \ No newline at end of file +} diff --git a/projects/aas-portal/src/app/aas/can-activate-aas.guard.ts b/projects/aas-portal/src/app/aas/can-activate-aas.guard.ts index ad2e40ea..6531efae 100644 --- a/projects/aas-portal/src/app/aas/can-activate-aas.guard.ts +++ b/projects/aas-portal/src/app/aas/can-activate-aas.guard.ts @@ -6,27 +6,29 @@ * *****************************************************************************/ -import { Injectable } from "@angular/core"; -import { ActivatedRouteSnapshot, UrlTree } from "@angular/router"; -import { Store } from "@ngrx/store"; -import { Observable } from "rxjs"; +import { Injectable } from '@angular/core'; +import { ActivatedRouteSnapshot, UrlTree } from '@angular/router'; +import { Store } from '@ngrx/store'; +import { Observable } from 'rxjs'; import { AASQueryParams } from 'projects/aas-lib/src/public-api'; import * as AASSelectors from './aas.selectors'; import { State } from './aas.state'; @Injectable() -export class CanActivateAAS { +export class CanActivateAAS { private readonly store: Store; - constructor(store: Store) { + public constructor(store: Store) { this.store = store as Store; - } + } - public canActivate(route: ActivatedRouteSnapshot): boolean | UrlTree | Observable | Promise { + public canActivate( + route: ActivatedRouteSnapshot, + ): boolean | UrlTree | Observable | Promise { const params: AASQueryParams = route.queryParams; if (params.id || params.format) { return true; } - + return this.store.select(AASSelectors.selectHasDocument); } -} \ No newline at end of file +} diff --git a/projects/aas-portal/src/app/aas/command-handler.service.ts b/projects/aas-portal/src/app/aas/command-handler.service.ts index d71c17d8..986123b8 100644 --- a/projects/aas-portal/src/app/aas/command-handler.service.ts +++ b/projects/aas-portal/src/app/aas/command-handler.service.ts @@ -6,23 +6,22 @@ * *****************************************************************************/ -import { Injectable } from "@angular/core"; +import { Injectable } from '@angular/core'; import { NotifyService } from 'projects/aas-lib/src/public-api'; -import { Command } from "../types/command"; +import { Command } from '../types/command'; @Injectable({ - providedIn: 'root' + providedIn: 'root', }) export class CommandHandlerService { private commands: Array = []; private position = -1; - constructor(private notify: NotifyService) { - } + public constructor(private notify: NotifyService) {} public execute(command: Command): void { if (!command) { - throw new Error("Argument command is undefined."); + throw new Error('Argument command is undefined.'); } try { @@ -45,15 +44,14 @@ export class CommandHandlerService { } public get canRedo(): boolean { - return this.position + 1 < this.commands.length + return this.position + 1 < this.commands.length; } public undo(): void { try { this.commands[this.position].undo(); --this.position; - } - catch (error) { + } catch (error) { this.notify.error(error); } } @@ -62,8 +60,7 @@ export class CommandHandlerService { try { ++this.position; this.commands[this.position].redo(); - } - catch (error) { + } catch (error) { this.notify.error(error); } } @@ -72,4 +69,4 @@ export class CommandHandlerService { this.commands = []; this.position = -1; } -} \ No newline at end of file +} diff --git a/projects/aas-portal/src/app/aas/commands/delete-command.ts b/projects/aas-portal/src/app/aas/commands/delete-command.ts index da5a29a1..b36c5c47 100644 --- a/projects/aas-portal/src/app/aas/commands/delete-command.ts +++ b/projects/aas-portal/src/app/aas/commands/delete-command.ts @@ -6,12 +6,22 @@ * *****************************************************************************/ -import { aas, AASDocument, getChildren, getParent, isAssetAdministrationShell, isSubmodel, normalize, selectSubmodel } from "common"; -import { cloneDeep, noop } from "lodash-es"; -import { Store } from "@ngrx/store"; +import { + aas, + AASDocument, + getChildren, + getParent, + isAssetAdministrationShell, + isSubmodel, + normalize, + selectSubmodel, +} from 'common'; + +import { cloneDeep, noop } from 'lodash-es'; +import { Store } from '@ngrx/store'; import { State } from '../aas.state'; import * as AASActions from '../aas.actions'; -import { Command } from "../../types/command"; +import { Command } from '../../types/command'; export class DeleteCommand extends Command { private readonly store: Store; @@ -19,27 +29,25 @@ export class DeleteCommand extends Command { private readonly memento: AASDocument; private document: AASDocument; - constructor(store: Store, document: AASDocument, elements: aas.Referable | aas.Referable[]) { - super("Delete"); + public constructor(store: Store, document: AASDocument, elements: aas.Referable | aas.Referable[]) { + super('Delete'); if (!document.content) { - throw new Error("Document content is undefined.") + throw new Error('Document content is undefined.'); } - this.store = store; + this.store = store as Store; this.memento = document; this.document = { ...document, content: { ...document.content!, assetAdministrationShells: [...document.content!.assetAdministrationShells], - submodels: [...document.content!.submodels] - } + submodels: [...document.content!.submodels], + }, }; - this.elements = Array.isArray(elements) - ? normalize(document.content, elements, item => item) - : [elements]; + this.elements = Array.isArray(elements) ? normalize(document.content, elements, item => item) : [elements]; } protected onExecute(): void { @@ -104,4 +112,4 @@ export class DeleteCommand extends Command { protected onAbort(): void { noop(); } -} \ No newline at end of file +} diff --git a/projects/aas-portal/src/app/aas/commands/new-element-command.ts b/projects/aas-portal/src/app/aas/commands/new-element-command.ts index 3fc341ec..bfc51932 100644 --- a/projects/aas-portal/src/app/aas/commands/new-element-command.ts +++ b/projects/aas-portal/src/app/aas/commands/new-element-command.ts @@ -16,7 +16,7 @@ import { isAssetAdministrationShell, isSubmodel, isSubmodelElement, - isSubmodelElementCollection + isSubmodelElementCollection, } from 'common'; import { AASState } from '../aas.state'; @@ -29,11 +29,7 @@ export class NewElementCommand extends Command { private readonly memento: AASDocument; private document: AASDocument; - constructor( - store: Store<{ aas: AASState }>, - document: AASDocument, - parent: aas.Referable, - element: aas.Referable) { + public constructor(store: Store, document: AASDocument, parent: aas.Referable, element: aas.Referable) { super('New Element'); if (!document || !document.content) { @@ -42,18 +38,18 @@ export class NewElementCommand extends Command { const children = getChildren(parent, document.content); if (!children) { - throw new Error('Argument parent is invalid.') + throw new Error('Argument parent is invalid.'); } - this.store = store; + this.store = store as Store<{ aas: AASState }>; this.memento = document; this.document = { ...document, content: { ...document.content!, assetAdministrationShells: [...document.content!.assetAdministrationShells], - submodels: [...document.content!.submodels] - } + submodels: [...document.content!.submodels], + }, }; this.parent = parent; @@ -92,10 +88,12 @@ export class NewElementCommand extends Command { const submodels = shell.submodels ? [...shell.submodels] : []; submodels.push({ type: 'ModelReference', - keys: [{ - type: 'Submodel', - value: submodel.id, - }] + keys: [ + { + type: 'Submodel', + value: submodel.id, + }, + ], }); shell = { ...shell, submodels }; @@ -156,4 +154,4 @@ export class NewElementCommand extends Command { return children; } -} \ No newline at end of file +} diff --git a/projects/aas-portal/src/app/aas/commands/update-element-command.ts b/projects/aas-portal/src/app/aas/commands/update-element-command.ts index 75cfd70c..62420bac 100644 --- a/projects/aas-portal/src/app/aas/commands/update-element-command.ts +++ b/projects/aas-portal/src/app/aas/commands/update-element-command.ts @@ -20,14 +20,10 @@ export class UpdateElementCommand extends Command { private readonly memento: AASDocument; private document: AASDocument; - constructor( - store: Store, - document: AASDocument, - origin: aas.SubmodelElement, - element: aas.SubmodelElement) { + public constructor(store: Store, document: AASDocument, origin: aas.SubmodelElement, element: aas.SubmodelElement) { super('SetValue'); - this.store = store; + this.store = store as Store; this.document = this.memento = document; this.origin = origin; this.element = element; @@ -77,4 +73,4 @@ export class UpdateElementCommand extends Command { return children; } -} \ No newline at end of file +} diff --git a/projects/aas-portal/src/app/aas/edit-element-form/edit-element-form.component.html b/projects/aas-portal/src/app/aas/edit-element-form/edit-element-form.component.html index 13178e3d..db295343 100644 --- a/projects/aas-portal/src/app/aas/edit-element-form/edit-element-form.component.html +++ b/projects/aas-portal/src/app/aas/edit-element-form/edit-element-form.component.html @@ -12,7 +12,7 @@

{{modelType}}

- +
@for (message of messages; track message) { diff --git a/projects/aas-portal/src/app/aas/edit-element-form/edit-element-form.component.ts b/projects/aas-portal/src/app/aas/edit-element-form/edit-element-form.component.ts index 8c4e6109..77c737ce 100644 --- a/projects/aas-portal/src/app/aas/edit-element-form/edit-element-form.component.ts +++ b/projects/aas-portal/src/app/aas/edit-element-form/edit-element-form.component.ts @@ -20,12 +20,15 @@ export interface LangStringRow extends aas.LangString { @Component({ selector: 'fhg-edit-element', templateUrl: './edit-element-form.component.html', - styleUrls: ['./edit-element-form.component.scss'] + styleUrls: ['./edit-element-form.component.scss'], }) export class EditElementFormComponent { private element?: aas.Referable; - constructor(private modal: NgbActiveModal, private translate: TranslateService) { } + public constructor( + private modal: NgbActiveModal, + private translate: TranslateService, + ) {} public modelType!: aas.ModelType; @@ -69,7 +72,7 @@ export class EditElementFormComponent { 'xs:unsignedByte', 'xs:unsignedInt', 'xs:unsignedLong', - 'xs:unsignedShort' + 'xs:unsignedShort', ]; public value?: string; @@ -120,7 +123,7 @@ export class EditElementFormComponent { } public select(item: LangStringRow): void { - this.langStrings.forEach((langString) => { + this.langStrings.forEach(langString => { if (item === langString && langString.index >= 0) { langString.selected = !langString.selected; } else { @@ -133,7 +136,7 @@ export class EditElementFormComponent { this.clearMessages(); const last = this.langStrings[this.langStrings.length - 1]; last.index = this.langStrings.length - 1; - this.langStrings.forEach(item => item.selected = false); + this.langStrings.forEach(item => (item.selected = false)); last.selected = true; this.langStrings.push({ language: '', text: '', selected: false, index: -1 }); } @@ -142,7 +145,7 @@ export class EditElementFormComponent { this.clearMessages(); if (item.index >= 0) { this.langStrings = this.langStrings.filter(langString => langString !== item); - this.langStrings.forEach((langString, index) => langString.index = index); + this.langStrings.forEach((langString, index) => (langString.index = index)); this.langStrings[this.langStrings.length - 1].index = -1; } } @@ -166,12 +169,12 @@ export class EditElementFormComponent { const temp = this.value; this.value = undefined; this.contentType = extensionToMimeType(ext); - convertBlobToBase64Async(files[0]).then( - value => this.value = value - ).catch(() => { - this.value = temp; - this.pushMessage('Unable to read file.'); - }) + convertBlobToBase64Async(files[0]) + .then(value => (this.value = value)) + .catch(() => { + this.value = temp; + this.pushMessage('Unable to read file.'); + }); } } } @@ -185,7 +188,8 @@ export class EditElementFormComponent { private initMultiLanguageProperty(): void { const multiLangProperty = this.element as aas.MultiLanguageProperty; this.langStrings = multiLangProperty.value.map( - (item, index) => ({ ...item, selected: false, index } as LangStringRow)); + (item, index) => ({ ...item, selected: false, index }) as LangStringRow, + ); this.langStrings.push({ language: '', text: '', selected: false, index: -1 }); } @@ -248,7 +252,8 @@ export class EditElementFormComponent { private submitMultiLanguageProperty(): boolean { if (this.element) { const multiLangProperty = this.element as aas.MultiLanguageProperty; - multiLangProperty.value = this.langStrings.filter(item => item.language && item.text && item.index >= 0) + multiLangProperty.value = this.langStrings + .filter(item => item.language && item.text && item.index >= 0) .map(item => ({ language: item.language, text: item.text })); return true; @@ -302,4 +307,4 @@ export class EditElementFormComponent { private clearMessages() { this.messages = []; } -} \ No newline at end of file +} diff --git a/projects/aas-portal/src/app/aas/new-element-form/new-element-form.component.html b/projects/aas-portal/src/app/aas/new-element-form/new-element-form.component.html index 9b7f6b96..9f8c1311 100644 --- a/projects/aas-portal/src/app/aas/new-element-form/new-element-form.component.html +++ b/projects/aas-portal/src/app/aas/new-element-form/new-element-form.component.html @@ -12,7 +12,7 @@

CAPTION_NEW_ELEMENT

- +
@for (message of messages; track message) { diff --git a/projects/aas-portal/src/app/aas/new-element-form/new-element-form.component.ts b/projects/aas-portal/src/app/aas/new-element-form/new-element-form.component.ts index c27515cd..9598789c 100644 --- a/projects/aas-portal/src/app/aas/new-element-form/new-element-form.component.ts +++ b/projects/aas-portal/src/app/aas/new-element-form/new-element-form.component.ts @@ -19,7 +19,7 @@ export interface NewElementResult { @Component({ selector: 'fhg-new-element', templateUrl: './new-element-form.component.html', - styleUrls: ['./new-element-form.component.scss'] + styleUrls: ['./new-element-form.component.scss'], }) export class NewElementFormComponent { private env?: aas.Environment; @@ -28,7 +28,7 @@ export class NewElementFormComponent { private _modelType?: aas.ModelType; private _template?: TemplateDescriptor; - constructor(private readonly modal: NgbActiveModal) { } + public constructor(private readonly modal: NgbActiveModal) {} public modelTypes: aas.ModelType[] = []; @@ -75,15 +75,30 @@ export class NewElementFormComponent { this.modelType = 'Submodel'; break; case 'Submodel': - this.modelTypes.push('MultiLanguageProperty', 'Property', 'SubmodelElementCollection', 'SubmodelElementList'); + this.modelTypes.push( + 'MultiLanguageProperty', + 'Property', + 'SubmodelElementCollection', + 'SubmodelElementList', + ); this.modelType = 'Property'; break; case 'SubmodelElementCollection': - this.modelTypes.push('MultiLanguageProperty', 'Property', 'SubmodelElementCollection', 'SubmodelElementList'); + this.modelTypes.push( + 'MultiLanguageProperty', + 'Property', + 'SubmodelElementCollection', + 'SubmodelElementList', + ); this.modelType = 'SubmodelElementCollection'; break; case 'SubmodelElementList': - this.modelTypes.push('MultiLanguageProperty', 'Property', 'SubmodelElementCollection', 'SubmodelElementList'); + this.modelTypes.push( + 'MultiLanguageProperty', + 'Property', + 'SubmodelElementCollection', + 'SubmodelElementList', + ); this.modelType = 'SubmodelElementList'; } } @@ -92,7 +107,7 @@ export class NewElementFormComponent { this.clearMessages(); if (this.validate()) { this.modal.close({ - element: this.createElement() + element: this.createElement(), } as NewElementResult); } } @@ -133,4 +148,4 @@ export class NewElementFormComponent { private clearMessages(): void { this.messages = []; } -} \ No newline at end of file +} diff --git a/projects/aas-portal/src/app/about/about.component.ts b/projects/aas-portal/src/app/about/about.component.ts index 4578ca95..973dd465 100644 --- a/projects/aas-portal/src/app/about/about.component.ts +++ b/projects/aas-portal/src/app/about/about.component.ts @@ -16,13 +16,14 @@ import { environment } from '../../environments/environment'; @Component({ selector: 'fhg-about', templateUrl: './about.component.html', - styleUrls: ['./about.component.scss'] + styleUrls: ['./about.component.scss'], }) export class AboutComponent implements OnInit, OnDestroy, AfterViewInit { - constructor( + public constructor( private serverApi: ServerApiService, private translate: TranslateService, - private toolbar: ToolbarService) { + private toolbar: ToolbarService, + ) { this.author = environment.author; this.version = environment.version; this.homepage = environment.homepage; @@ -33,7 +34,7 @@ export class AboutComponent implements OnInit, OnDestroy, AfterViewInit { public version = ''; - public serverVersion = '' + public serverVersion = ''; public author = ''; @@ -44,13 +45,12 @@ export class AboutComponent implements OnInit, OnDestroy, AfterViewInit { public messages: Message[] = []; public ngOnInit(): void { - this.serverApi.getInfo().subscribe(info => { this.serverVersion = info.version; this.libraries = info.libraries ?? []; }); - this.serverApi.getMessages().subscribe(messages => this.messages = messages); + this.serverApi.getMessages().subscribe(messages => (this.messages = messages)); } public ngAfterViewInit(): void { @@ -62,4 +62,4 @@ export class AboutComponent implements OnInit, OnDestroy, AfterViewInit { public ngOnDestroy(): void { this.toolbar.clear(); } -} \ No newline at end of file +} diff --git a/projects/aas-portal/src/app/about/server-api.service.ts b/projects/aas-portal/src/app/about/server-api.service.ts index c3e18d55..7fa59215 100644 --- a/projects/aas-portal/src/app/about/server-api.service.ts +++ b/projects/aas-portal/src/app/about/server-api.service.ts @@ -6,20 +6,17 @@ * *****************************************************************************/ -import { HttpClient } from "@angular/common/http"; -import { Injectable } from "@angular/core"; -import { PackageInfo, Message } from "common"; -import { Observable } from "rxjs"; +import { HttpClient } from '@angular/common/http'; +import { Injectable } from '@angular/core'; +import { PackageInfo, Message } from 'common'; +import { Observable } from 'rxjs'; /** Realizes the IServer service. */ @Injectable({ - providedIn: 'root' + providedIn: 'root', }) export class ServerApiService { - constructor( - private readonly http: HttpClient, - ) { - } + public constructor(private readonly http: HttpClient) {} public getInfo(): Observable { return this.http.get('/api/v1/app/info'); @@ -28,4 +25,4 @@ export class ServerApiService { public getMessages(): Observable { return this.http.get('/api/v1/app/messages'); } -} \ No newline at end of file +} diff --git a/projects/aas-portal/src/app/app-routing.module.ts b/projects/aas-portal/src/app/app-routing.module.ts index d8000f66..80922f71 100644 --- a/projects/aas-portal/src/app/app-routing.module.ts +++ b/projects/aas-portal/src/app/app-routing.module.ts @@ -17,16 +17,16 @@ import { ViewComponent } from './view/view.component'; const routes: Routes = [ { path: 'start', component: StartComponent }, - { path: 'aas', component: AASComponent, canActivate: [CanActivateAAS]}, + { path: 'aas', component: AASComponent, canActivate: [CanActivateAAS] }, { path: 'view', component: ViewComponent }, { path: 'dashboard', component: DashboardComponent }, { path: 'about', component: AboutComponent }, - { path: '', pathMatch: 'full', redirectTo: 'start' } + { path: '', pathMatch: 'full', redirectTo: 'start' }, ]; @NgModule({ imports: [RouterModule.forRoot(routes)], exports: [RouterModule], - providers: [CanActivateAAS] + providers: [CanActivateAAS], }) -export class AppRoutingModule { } \ No newline at end of file +export class AppRoutingModule {} diff --git a/projects/aas-portal/src/app/app.component.ts b/projects/aas-portal/src/app/app.component.ts index 490d969a..e70264ad 100644 --- a/projects/aas-portal/src/app/app.component.ts +++ b/projects/aas-portal/src/app/app.component.ts @@ -11,8 +11,8 @@ import { Component } from '@angular/core'; @Component({ selector: 'fhg-root', templateUrl: './app.component.html', - styleUrls: ['./app.component.scss'] + styleUrls: ['./app.component.scss'], }) export class AppComponent { public title = 'AASPortal'; -} \ No newline at end of file +} diff --git a/projects/aas-portal/src/app/app.module.ts b/projects/aas-portal/src/app/app.module.ts index 62881300..38177695 100644 --- a/projects/aas-portal/src/app/app.module.ts +++ b/projects/aas-portal/src/app/app.module.ts @@ -10,7 +10,7 @@ import { NgModule } from '@angular/core'; import { BrowserModule } from '@angular/platform-browser'; import { BrowserAnimationsModule } from '@angular/platform-browser/animations'; import { StoreModule } from '@ngrx/store'; -import { NgbModule } from '@ng-bootstrap/ng-bootstrap' +import { NgbModule } from '@ng-bootstrap/ng-bootstrap'; import { HttpClientModule, HttpClient } from '@angular/common/http'; import { TranslateModule, TranslateLoader } from '@ngx-translate/core'; import { AASLibModule } from 'projects/aas-lib/src/public-api'; @@ -55,7 +55,7 @@ import { FavoritesFormComponent } from './start/favorites-form/favorites-form.co EditElementFormComponent, UploadFormComponent, ViewComponent, - FavoritesFormComponent + FavoritesFormComponent, ], imports: [ BrowserModule, @@ -64,27 +64,24 @@ import { FavoritesFormComponent } from './start/favorites-form/favorites-form.co HttpClientModule, FormsModule, NgbModule, - StoreModule.forRoot( - { - start: startReducer, - aas: aasReducer, - view: viewReducer, - dashboard: dashboardReducer, - }), + StoreModule.forRoot({ + start: startReducer, + aas: aasReducer, + view: viewReducer, + dashboard: dashboardReducer, + }), EffectsModule.forRoot([StartEffects, AASEffects, ViewEffects]), TranslateModule.forRoot({ defaultLanguage: 'en-us', loader: { provide: TranslateLoader, useFactory: HttpLoaderFactory, - deps: [HttpClient] - } + deps: [HttpClient], + }, }), AASLibModule, ], - providers: [ - httpInterceptorProviders - ], - bootstrap: [AppComponent] + providers: [httpInterceptorProviders], + bootstrap: [AppComponent], }) -export class AppModule { } \ No newline at end of file +export class AppModule {} diff --git a/projects/aas-portal/src/app/configuration.ts b/projects/aas-portal/src/app/configuration.ts index 0f9f29bf..aea9e1ab 100644 --- a/projects/aas-portal/src/app/configuration.ts +++ b/projects/aas-portal/src/app/configuration.ts @@ -36,7 +36,7 @@ export function getEndpointType(url: string | URL): AASEndpointType { return 'AasxDirectory'; case 'http:': case 'https:': - return url.searchParams.get('type') as AASEndpointType ?? 'AasxServer'; + return (url.searchParams.get('type') as AASEndpointType) ?? 'AasxServer'; case 'opc.tcp:': return 'OpcuaServer'; default: diff --git a/projects/aas-portal/src/app/dashboard/commands/add-new-page-command.ts b/projects/aas-portal/src/app/dashboard/commands/add-new-page-command.ts index ffe6b459..feb8e8ee 100644 --- a/projects/aas-portal/src/app/dashboard/commands/add-new-page-command.ts +++ b/projects/aas-portal/src/app/dashboard/commands/add-new-page-command.ts @@ -6,19 +6,20 @@ * *****************************************************************************/ -import { Store } from "@ngrx/store"; -import { DashboardService } from "../dashboard.service"; -import { DashboardCommand } from "./dashboard-command"; +import { Store } from '@ngrx/store'; +import { DashboardService } from '../dashboard.service'; +import { DashboardCommand } from './dashboard-command'; export class AddNewPageCommand extends DashboardCommand { - constructor( + public constructor( store: Store, private dashboard: DashboardService, - private pageName?: string) { + private pageName?: string, + ) { super('Add new page', store); } protected executing(): void { this.dashboard.addNew(this.pageName); } -} \ No newline at end of file +} diff --git a/projects/aas-portal/src/app/dashboard/commands/dashboard-command.ts b/projects/aas-portal/src/app/dashboard/commands/dashboard-command.ts index 6c88190b..139b5694 100644 --- a/projects/aas-portal/src/app/dashboard/commands/dashboard-command.ts +++ b/projects/aas-portal/src/app/dashboard/commands/dashboard-command.ts @@ -11,24 +11,37 @@ import { first } from 'rxjs'; import { Command } from '../../types/command'; import * as DashboardSelectors from '../dashboard.selectors'; import * as DashboardActions from '../dashboard.actions'; -import { DashboardChart, DashboardItem, DashboardItemType, DashboardRow, DashboardState, State } from '../dashboard.state'; +import { + DashboardChart, + DashboardItem, + DashboardItemType, + DashboardRow, + DashboardState, + State, +} from '../dashboard.state'; export abstract class DashboardCommand extends Command { private preState!: DashboardState; private postState!: DashboardState; - constructor(name: string, store: Store) { + protected constructor(name: string, store: Store) { super(name); this.store = store as Store; } - protected store: Store + protected store: Store; protected onExecute(): void { - this.store.select(DashboardSelectors.selectState).pipe(first()).subscribe(state => this.preState = state); + this.store + .select(DashboardSelectors.selectState) + .pipe(first()) + .subscribe(state => (this.preState = state)); this.executing(); - this.store.select(DashboardSelectors.selectState).pipe(first()).subscribe(state => this.postState = state); + this.store + .select(DashboardSelectors.selectState) + .pipe(first()) + .subscribe(state => (this.postState = state)); } protected abstract executing(): void; @@ -54,17 +67,17 @@ export abstract class DashboardCommand extends Command { columns: row.map(item => ({ id: item.id, item: item, - itemType: item.type - })) + itemType: item.type, + })), })); } protected validateItems(grid: DashboardItem[][]): DashboardItem[][] { grid.forEach((row, y) => { - row.forEach((item, x) => item.positions[0].x = x); - row.forEach(item => item.positions[0].y = y); + row.forEach((item, x) => (item.positions[0].x = x)); + row.forEach(item => (item.positions[0].y = y)); }); return grid; } -} \ No newline at end of file +} diff --git a/projects/aas-portal/src/app/dashboard/commands/delete-item-command.ts b/projects/aas-portal/src/app/dashboard/commands/delete-item-command.ts index c9a98cef..7f6d6746 100644 --- a/projects/aas-portal/src/app/dashboard/commands/delete-item-command.ts +++ b/projects/aas-portal/src/app/dashboard/commands/delete-item-command.ts @@ -6,18 +6,19 @@ * *****************************************************************************/ -import { Store } from "@ngrx/store"; -import { cloneDeep } from "lodash-es"; -import { DashboardService } from "../dashboard.service"; -import { DashboardCommand } from "./dashboard-command"; -import { DashboardPage, DashboardItem } from "../dashboard.state"; +import { Store } from '@ngrx/store'; +import { cloneDeep } from 'lodash-es'; +import { DashboardService } from '../dashboard.service'; +import { DashboardCommand } from './dashboard-command'; +import { DashboardPage, DashboardItem } from '../dashboard.state'; export class DeleteItemCommand extends DashboardCommand { - constructor( + public constructor( store: Store, private dashboard: DashboardService, private page: DashboardPage, - private items: DashboardItem[]) { + private items: DashboardItem[], + ) { super('Delete item', store); } @@ -28,4 +29,4 @@ export class DeleteItemCommand extends DashboardCommand { this.validateItems(grid); this.dashboard.update(page, this.getRows(grid)); } -} \ No newline at end of file +} diff --git a/projects/aas-portal/src/app/dashboard/commands/delete-page-command.ts b/projects/aas-portal/src/app/dashboard/commands/delete-page-command.ts index 3be71bd2..621e02b1 100644 --- a/projects/aas-portal/src/app/dashboard/commands/delete-page-command.ts +++ b/projects/aas-portal/src/app/dashboard/commands/delete-page-command.ts @@ -6,20 +6,21 @@ * *****************************************************************************/ -import { Store } from "@ngrx/store"; -import { DashboardPage } from "../dashboard.state"; -import { DashboardService } from "../dashboard.service"; -import { DashboardCommand } from "./dashboard-command"; +import { Store } from '@ngrx/store'; +import { DashboardPage } from '../dashboard.state'; +import { DashboardService } from '../dashboard.service'; +import { DashboardCommand } from './dashboard-command'; export class DeletePageCommand extends DashboardCommand { - constructor( + public constructor( store: Store, private dashboard: DashboardService, - private page: DashboardPage) { + private page: DashboardPage, + ) { super('Delete page', store); } protected executing(): void { this.dashboard.delete(this.page); } -} \ No newline at end of file +} diff --git a/projects/aas-portal/src/app/dashboard/commands/move-down-command.ts b/projects/aas-portal/src/app/dashboard/commands/move-down-command.ts index 1ea3efbd..0ff6bf55 100644 --- a/projects/aas-portal/src/app/dashboard/commands/move-down-command.ts +++ b/projects/aas-portal/src/app/dashboard/commands/move-down-command.ts @@ -6,24 +6,25 @@ * *****************************************************************************/ -import { Store } from "@ngrx/store"; -import { cloneDeep } from "lodash-es"; -import { DashboardItem, DashboardPage, DashboardRow } from "../dashboard.state"; -import { DashboardService } from "../dashboard.service"; -import { DashboardCommand } from "./dashboard-command"; +import { Store } from '@ngrx/store'; +import { cloneDeep } from 'lodash-es'; +import { DashboardItem, DashboardPage, DashboardRow } from '../dashboard.state'; +import { DashboardService } from '../dashboard.service'; +import { DashboardCommand } from './dashboard-command'; export class MoveDownCommand extends DashboardCommand { - constructor( + public constructor( store: Store, private dashboard: DashboardService, private page: DashboardPage, - private item: DashboardItem) { + private item: DashboardItem, + ) { super('Move down', store); } protected executing(): void { if (!this.dashboard.canMoveDown(this.page, this.item)) { - throw new Error(`Item can not be moved down.`) + throw new Error(`Item can not be moved down.`); } let rows: DashboardRow[] | undefined; @@ -52,4 +53,4 @@ export class MoveDownCommand extends DashboardCommand { this.dashboard.update(page, rows); } -} \ No newline at end of file +} diff --git a/projects/aas-portal/src/app/dashboard/commands/move-left-command.ts b/projects/aas-portal/src/app/dashboard/commands/move-left-command.ts index 76ce70d0..46e91a28 100644 --- a/projects/aas-portal/src/app/dashboard/commands/move-left-command.ts +++ b/projects/aas-portal/src/app/dashboard/commands/move-left-command.ts @@ -6,24 +6,25 @@ * *****************************************************************************/ -import { Store } from "@ngrx/store"; -import { cloneDeep } from "lodash-es"; -import { DashboardItem, DashboardPage, DashboardRow } from "../dashboard.state"; -import { DashboardService } from "../dashboard.service"; -import { DashboardCommand } from "./dashboard-command"; +import { Store } from '@ngrx/store'; +import { cloneDeep } from 'lodash-es'; +import { DashboardItem, DashboardPage, DashboardRow } from '../dashboard.state'; +import { DashboardService } from '../dashboard.service'; +import { DashboardCommand } from './dashboard-command'; export class MoveLeftCommand extends DashboardCommand { - constructor( + public constructor( store: Store, private dashboard: DashboardService, private page: DashboardPage, - private item: DashboardItem) { + private item: DashboardItem, + ) { super('Move left', store); } protected executing(): void { if (!this.dashboard.canMoveLeft(this.page, this.item)) { - throw new Error(`Item can not be moved to the left.`) + throw new Error(`Item can not be moved to the left.`); } let rows: DashboardRow[] | undefined; @@ -40,4 +41,4 @@ export class MoveLeftCommand extends DashboardCommand { this.dashboard.update(page, rows); } -} \ No newline at end of file +} diff --git a/projects/aas-portal/src/app/dashboard/commands/move-right-command.ts b/projects/aas-portal/src/app/dashboard/commands/move-right-command.ts index b150157f..90653c04 100644 --- a/projects/aas-portal/src/app/dashboard/commands/move-right-command.ts +++ b/projects/aas-portal/src/app/dashboard/commands/move-right-command.ts @@ -6,24 +6,25 @@ * *****************************************************************************/ -import { Store } from "@ngrx/store"; -import { cloneDeep } from "lodash-es"; -import { DashboardItem, DashboardPage, DashboardRow } from "../dashboard.state"; -import { DashboardService } from "../dashboard.service"; -import { DashboardCommand } from "./dashboard-command"; +import { Store } from '@ngrx/store'; +import { cloneDeep } from 'lodash-es'; +import { DashboardItem, DashboardPage, DashboardRow } from '../dashboard.state'; +import { DashboardService } from '../dashboard.service'; +import { DashboardCommand } from './dashboard-command'; export class MoveRightCommand extends DashboardCommand { - constructor( + public constructor( store: Store, private dashboard: DashboardService, private page: DashboardPage, - private item: DashboardItem) { + private item: DashboardItem, + ) { super('Move right', store); } protected executing(): void { if (!this.dashboard.canMoveRight(this.page, this.item)) { - throw new Error(`Item can not be moved to the right.`) + throw new Error(`Item can not be moved to the right.`); } let rows: DashboardRow[] | undefined; @@ -40,4 +41,4 @@ export class MoveRightCommand extends DashboardCommand { this.dashboard.update(page, rows); } -} \ No newline at end of file +} diff --git a/projects/aas-portal/src/app/dashboard/commands/move-up-command.ts b/projects/aas-portal/src/app/dashboard/commands/move-up-command.ts index 4fe724be..5e8a07d2 100644 --- a/projects/aas-portal/src/app/dashboard/commands/move-up-command.ts +++ b/projects/aas-portal/src/app/dashboard/commands/move-up-command.ts @@ -6,25 +6,25 @@ * *****************************************************************************/ -import { Store } from "@ngrx/store"; -import { cloneDeep } from "lodash-es"; -import { DashboardItem, DashboardPage, DashboardRow } from "../dashboard.state"; -import { DashboardService } from "../dashboard.service"; -import { DashboardCommand } from "./dashboard-command"; +import { Store } from '@ngrx/store'; +import { cloneDeep } from 'lodash-es'; +import { DashboardItem, DashboardPage, DashboardRow } from '../dashboard.state'; +import { DashboardService } from '../dashboard.service'; +import { DashboardCommand } from './dashboard-command'; export class MoveUpCommand extends DashboardCommand { - - constructor( + public constructor( store: Store, private dashboard: DashboardService, private page: DashboardPage, - private item: DashboardItem) { + private item: DashboardItem, + ) { super('Move up', store); } protected executing(): void { if (!this.dashboard.canMoveUp(this.page, this.item)) { - throw new Error(`Item can not be moved up.`) + throw new Error(`Item can not be moved up.`); } let rows: DashboardRow[] | undefined; @@ -53,4 +53,4 @@ export class MoveUpCommand extends DashboardCommand { this.dashboard.update(page, rows); } -} \ No newline at end of file +} diff --git a/projects/aas-portal/src/app/dashboard/commands/rename-page-command.ts b/projects/aas-portal/src/app/dashboard/commands/rename-page-command.ts index d3776bbb..1f52c689 100644 --- a/projects/aas-portal/src/app/dashboard/commands/rename-page-command.ts +++ b/projects/aas-portal/src/app/dashboard/commands/rename-page-command.ts @@ -6,21 +6,22 @@ * *****************************************************************************/ -import { Store } from "@ngrx/store"; -import { DashboardPage } from "../dashboard.state"; -import { DashboardService } from "../dashboard.service"; -import { DashboardCommand } from "./dashboard-command"; +import { Store } from '@ngrx/store'; +import { DashboardPage } from '../dashboard.state'; +import { DashboardService } from '../dashboard.service'; +import { DashboardCommand } from './dashboard-command'; export class RenamePageCommand extends DashboardCommand { - constructor( + public constructor( store: Store, private dashboard: DashboardService, private page: DashboardPage, - private newName: string) { + private newName: string, + ) { super('Delete page', store); } protected executing(): void { this.dashboard.rename(this.page, this.newName); } -} \ No newline at end of file +} diff --git a/projects/aas-portal/src/app/dashboard/commands/set-chart-type-command.ts b/projects/aas-portal/src/app/dashboard/commands/set-chart-type-command.ts index 9d28e333..9794618e 100644 --- a/projects/aas-portal/src/app/dashboard/commands/set-chart-type-command.ts +++ b/projects/aas-portal/src/app/dashboard/commands/set-chart-type-command.ts @@ -6,31 +6,32 @@ * *****************************************************************************/ - import { Store } from "@ngrx/store"; - import { cloneDeep } from "lodash-es"; - import { DashboardChart, DashboardChartType, DashboardItem, DashboardPage } from "../dashboard.state"; - import { DashboardService } from "../dashboard.service"; - import { DashboardCommand } from "./dashboard-command"; - - export class SetChartTypeCommand extends DashboardCommand { - constructor( - store: Store, - private dashboard: DashboardService, - private page: DashboardPage, - private item: DashboardItem, - private chartType: DashboardChartType) { - super('Set chart type', store); - } - - protected executing(): void { - const page = cloneDeep(this.page); - const item = page.items[this.page.items.indexOf(this.item)] as DashboardChart; - - if (this.isChart(item)) { - item.chartType = this.chartType; - this.dashboard.update(page); - } else { - throw new Error('Not implemented.'); - } - } - } \ No newline at end of file +import { Store } from '@ngrx/store'; +import { cloneDeep } from 'lodash-es'; +import { DashboardChart, DashboardChartType, DashboardItem, DashboardPage } from '../dashboard.state'; +import { DashboardService } from '../dashboard.service'; +import { DashboardCommand } from './dashboard-command'; + +export class SetChartTypeCommand extends DashboardCommand { + public constructor( + store: Store, + private dashboard: DashboardService, + private page: DashboardPage, + private item: DashboardItem, + private chartType: DashboardChartType, + ) { + super('Set chart type', store); + } + + protected executing(): void { + const page = cloneDeep(this.page); + const item = page.items[this.page.items.indexOf(this.item)] as DashboardChart; + + if (this.isChart(item)) { + item.chartType = this.chartType; + this.dashboard.update(page); + } else { + throw new Error('Not implemented.'); + } + } +} diff --git a/projects/aas-portal/src/app/dashboard/commands/set-color-command.ts b/projects/aas-portal/src/app/dashboard/commands/set-color-command.ts index ba1550cd..1b171d7d 100644 --- a/projects/aas-portal/src/app/dashboard/commands/set-color-command.ts +++ b/projects/aas-portal/src/app/dashboard/commands/set-color-command.ts @@ -6,20 +6,21 @@ * *****************************************************************************/ -import { Store } from "@ngrx/store"; -import { cloneDeep } from "lodash-es"; -import { DashboardItem, DashboardPage } from "../dashboard.state"; -import { DashboardService } from "../dashboard.service"; -import { DashboardCommand } from "./dashboard-command"; +import { Store } from '@ngrx/store'; +import { cloneDeep } from 'lodash-es'; +import { DashboardItem, DashboardPage } from '../dashboard.state'; +import { DashboardService } from '../dashboard.service'; +import { DashboardCommand } from './dashboard-command'; export class SetColorCommand extends DashboardCommand { - constructor( + public constructor( store: Store, private dashboard: DashboardService, private page: DashboardPage, private item: DashboardItem, private index: number, - private color: string) { + private color: string, + ) { super('Set color', store); } @@ -34,4 +35,4 @@ export class SetColorCommand extends DashboardCommand { throw new Error('Not implemented.'); } } -} \ No newline at end of file +} diff --git a/projects/aas-portal/src/app/dashboard/commands/set-min-max-command.ts b/projects/aas-portal/src/app/dashboard/commands/set-min-max-command.ts index 92cfe369..84c38f3d 100644 --- a/projects/aas-portal/src/app/dashboard/commands/set-min-max-command.ts +++ b/projects/aas-portal/src/app/dashboard/commands/set-min-max-command.ts @@ -6,20 +6,21 @@ * *****************************************************************************/ -import { Store } from "@ngrx/store"; -import { cloneDeep } from "lodash-es"; -import { DashboardChart, DashboardPage } from "../dashboard.state"; -import { DashboardService } from "../dashboard.service"; -import { DashboardCommand } from "./dashboard-command"; +import { Store } from '@ngrx/store'; +import { cloneDeep } from 'lodash-es'; +import { DashboardChart, DashboardPage } from '../dashboard.state'; +import { DashboardService } from '../dashboard.service'; +import { DashboardCommand } from './dashboard-command'; export class SetMinMaxCommand extends DashboardCommand { - constructor( + public constructor( store: Store, private dashboard: DashboardService, private page: DashboardPage, private chart: DashboardChart, private min?: number, - private max?: number) { + private max?: number, + ) { super('Set min/max', store); } @@ -36,4 +37,4 @@ export class SetMinMaxCommand extends DashboardCommand { this.dashboard.update(page); } -} \ No newline at end of file +} diff --git a/projects/aas-portal/src/app/dashboard/dashboard-api.service.ts b/projects/aas-portal/src/app/dashboard/dashboard-api.service.ts index 322fce9c..018a02bd 100644 --- a/projects/aas-portal/src/app/dashboard/dashboard-api.service.ts +++ b/projects/aas-portal/src/app/dashboard/dashboard-api.service.ts @@ -11,14 +11,12 @@ import { HttpClient } from '@angular/common/http'; import { Observable } from 'rxjs'; @Injectable({ - providedIn: 'root' + providedIn: 'root', }) export class DashboardApiService { - constructor( - private readonly http: HttpClient - ) { } + public constructor(private readonly http: HttpClient) {} public getBlobValue(url: string): Observable { return this.http.get(url); } -} \ No newline at end of file +} diff --git a/projects/aas-portal/src/app/dashboard/dashboard.actions.ts b/projects/aas-portal/src/app/dashboard/dashboard.actions.ts index b6fe7d33..55f98142 100644 --- a/projects/aas-portal/src/app/dashboard/dashboard.actions.ts +++ b/projects/aas-portal/src/app/dashboard/dashboard.actions.ts @@ -6,8 +6,8 @@ * *****************************************************************************/ -import { createAction, props } from "@ngrx/store"; -import { DashboardPage, DashboardRow, DashboardState } from "./dashboard.state"; +import { createAction, props } from '@ngrx/store'; +import { DashboardPage, DashboardRow, DashboardState } from './dashboard.state'; export enum DashboardActionType { UPDATE_ROWS = '[Dashboard] update rows', @@ -18,41 +18,26 @@ export enum DashboardActionType { UPDATE_PAGE = '[Dashboard] update page', DELETE_PAGE = '[Dashboard] delete page', RENAME_PAGE = '[Dashboard] rename page', - SET_STATE = '[Dashboard] set state' + SET_STATE = '[Dashboard] set state', } -export const updateRows = createAction( - DashboardActionType.UPDATE_ROWS, - props<{ rows: DashboardRow[] }>()); +export const updateRows = createAction(DashboardActionType.UPDATE_ROWS, props<{ rows: DashboardRow[] }>()); -export const setEditMode = createAction( - DashboardActionType.SET_EDIT_MODE, - props<{ editMode: boolean }>()); +export const setEditMode = createAction(DashboardActionType.SET_EDIT_MODE, props<{ editMode: boolean }>()); -export const setPageName = createAction( - DashboardActionType.SET_PAGE_NAME, - props<{ name: string }>()); +export const setPageName = createAction(DashboardActionType.SET_PAGE_NAME, props<{ name: string }>()); -export const setPages = createAction( - DashboardActionType.SET_PAGES, - props<{ pages: DashboardPage[] }>()); +export const setPages = createAction(DashboardActionType.SET_PAGES, props<{ pages: DashboardPage[] }>()); export const updatePage = createAction( DashboardActionType.UPDATE_PAGE, - props<{ page: DashboardPage; rows?: DashboardRow[] }>()); + props<{ page: DashboardPage; rows?: DashboardRow[] }>(), +); -export const addNewPage = createAction( - DashboardActionType.ADD_NEW_PAGE, - props<{ name?: string }>()); +export const addNewPage = createAction(DashboardActionType.ADD_NEW_PAGE, props<{ name?: string }>()); -export const deletePage = createAction( - DashboardActionType.DELETE_PAGE, - props<{ page: DashboardPage }>()); +export const deletePage = createAction(DashboardActionType.DELETE_PAGE, props<{ page: DashboardPage }>()); -export const renamePage = createAction( - DashboardActionType.RENAME_PAGE, - props<{ page: DashboardPage; name: string }>()); +export const renamePage = createAction(DashboardActionType.RENAME_PAGE, props<{ page: DashboardPage; name: string }>()); -export const setState = createAction( - DashboardActionType.SET_STATE, - props<{ state: DashboardState }>()); \ No newline at end of file +export const setState = createAction(DashboardActionType.SET_STATE, props<{ state: DashboardState }>()); diff --git a/projects/aas-portal/src/app/dashboard/dashboard.component.html b/projects/aas-portal/src/app/dashboard/dashboard.component.html index 2ef0fdee..d869fb8f 100644 --- a/projects/aas-portal/src/app/dashboard/dashboard.component.html +++ b/projects/aas-portal/src/app/dashboard/dashboard.component.html @@ -12,7 +12,7 @@ @for (column of row.columns; track column) {
+ (click)="toggleSelection(column)" (keydown.enter)="toggleSelection(column)" tabindex="0"> @if (!editMode) { } diff --git a/projects/aas-portal/src/app/dashboard/dashboard.component.ts b/projects/aas-portal/src/app/dashboard/dashboard.component.ts index b76dec4e..ec87ad0b 100644 --- a/projects/aas-portal/src/app/dashboard/dashboard.component.ts +++ b/projects/aas-portal/src/app/dashboard/dashboard.component.ts @@ -6,36 +6,47 @@ * *****************************************************************************/ -import "chart.js/auto"; -import { AfterViewInit, AfterViewChecked, Component, ElementRef, OnDestroy, OnInit, QueryList, TemplateRef, ViewChild, ViewChildren } from '@angular/core'; +import 'chart.js/auto'; +import { + AfterViewInit, + AfterViewChecked, + Component, + ElementRef, + OnDestroy, + OnInit, + QueryList, + TemplateRef, + ViewChild, + ViewChildren, +} from '@angular/core'; import { isNumber } from 'lodash-es'; import { Chart, ChartConfiguration, ChartDataset, ChartType } from 'chart.js'; import { aas, convertToString, LiveNode, LiveRequest, parseNumber, WebSocketData } from 'common'; import * as lib from 'projects/aas-lib/src/public-api'; import { WebSocketSubject } from 'rxjs/webSocket'; -import { Observable, Subscription } from "rxjs"; -import { ActivatedRoute } from "@angular/router"; -import { Store } from "@ngrx/store"; +import { Observable, Subscription } from 'rxjs'; +import { ActivatedRoute } from '@angular/router'; +import { Store } from '@ngrx/store'; import { DashboardService } from './dashboard.service'; import { SelectionMode } from '../types/selection-mode'; -import { TranslateService } from "@ngx-translate/core"; -import { CommandHandlerService } from "../aas/command-handler.service"; -import { MoveLeftCommand } from "./commands/move-left-command"; -import { MoveRightCommand } from "./commands/move-right-command"; -import { MoveUpCommand } from "./commands/move-up-command"; -import { MoveDownCommand } from "./commands/move-down-command"; -import { SetColorCommand } from "./commands/set-color-command"; -import { DeletePageCommand } from "./commands/delete-page-command"; -import { RenamePageCommand } from "./commands/rename-page-command"; -import { AddNewPageCommand } from "./commands/add-new-page-command"; -import { DeleteItemCommand } from "./commands/delete-item-command"; -import { SetChartTypeCommand } from "./commands/set-chart-type-command"; -import { selectEditMode, selectPage, selectPages, selectRows, selectSelectionMode } from "./dashboard.selectors"; -import { SetMinMaxCommand } from "./commands/set-min-max-command"; -import { DashboardQuery, DashboardQueryParams } from "../types/dashboard-query-params"; +import { TranslateService } from '@ngx-translate/core'; +import { CommandHandlerService } from '../aas/command-handler.service'; +import { MoveLeftCommand } from './commands/move-left-command'; +import { MoveRightCommand } from './commands/move-right-command'; +import { MoveUpCommand } from './commands/move-up-command'; +import { MoveDownCommand } from './commands/move-down-command'; +import { SetColorCommand } from './commands/set-color-command'; +import { DeletePageCommand } from './commands/delete-page-command'; +import { RenamePageCommand } from './commands/rename-page-command'; +import { AddNewPageCommand } from './commands/add-new-page-command'; +import { DeleteItemCommand } from './commands/delete-item-command'; +import { SetChartTypeCommand } from './commands/set-chart-type-command'; +import { selectEditMode, selectPage, selectPages, selectRows, selectSelectionMode } from './dashboard.selectors'; +import { SetMinMaxCommand } from './commands/set-min-max-command'; +import { DashboardQuery, DashboardQueryParams } from '../types/dashboard-query-params'; import * as DashboardActions from './dashboard.actions'; -import { DashboardApiService } from "./dashboard-api.service"; +import { DashboardApiService } from './dashboard-api.service'; import { ToolbarService } from '../toolbar.service'; import { DashboardItem, @@ -45,7 +56,7 @@ import { DashboardChartType, DashboardRow, DashboardColumn, - State + State, } from './dashboard.state'; interface UpdateTuple { @@ -66,7 +77,7 @@ interface TimeSeries { @Component({ selector: 'fhg-dashboard', templateUrl: './dashboard.component.html', - styleUrls: ['./dashboard.component.scss'] + styleUrls: ['./dashboard.component.scss'], }) export class DashboardComponent implements OnInit, OnDestroy, AfterViewInit, AfterViewChecked { private readonly store: Store; @@ -80,7 +91,7 @@ export class DashboardComponent implements OnInit, OnDestroy, AfterViewInit, Aft private _page: DashboardPage; private _editMode = false; - constructor( + public constructor( store: Store, private readonly api: DashboardApiService, private readonly activeRoute: ActivatedRoute, @@ -92,23 +103,39 @@ export class DashboardComponent implements OnInit, OnDestroy, AfterViewInit, Aft private readonly toolbar: ToolbarService, private readonly commandHandler: CommandHandlerService, private readonly window: lib.WindowService, - private readonly clipboard: lib.ClipboardService + private readonly clipboard: lib.ClipboardService, ) { this.store = store as Store; this._page = this.dashboard.defaultPage ?? { name: '-', items: [], requests: [] }; this.pages = this.store.select(selectPages); - this.subscription.add(this.store.select(selectPage).pipe() - .subscribe(value => this.updatePage(value))); - - this.subscription.add(this.store.select(selectEditMode).pipe() - .subscribe(editMode => this.updateEditMode(editMode))); - - this.subscription.add(this.store.select(selectSelectionMode).pipe() - .subscribe(selectionMode => this.selectionMode = selectionMode)); - - this.subscription.add(this.store.select(selectRows).pipe() - .subscribe(rows => this.rows = rows)); + this.subscription.add( + this.store + .select(selectPage) + .pipe() + .subscribe(value => this.updatePage(value)), + ); + + this.subscription.add( + this.store + .select(selectEditMode) + .pipe() + .subscribe(editMode => this.updateEditMode(editMode)), + ); + + this.subscription.add( + this.store + .select(selectSelectionMode) + .pipe() + .subscribe(selectionMode => (this.selectionMode = selectionMode)), + ); + + this.subscription.add( + this.store + .select(selectRows) + .pipe() + .subscribe(rows => (this.rows = rows)), + ); } @ViewChildren('chart') @@ -135,7 +162,7 @@ export class DashboardComponent implements OnInit, OnDestroy, AfterViewInit, Aft this.store.dispatch(DashboardActions.setEditMode({ editMode: value })); } - public rows: DashboardRow[] = [] + public rows: DashboardRow[] = []; public get selectedItem(): DashboardItem | null { if (this.selections.size === 1) { @@ -242,7 +269,10 @@ export class DashboardComponent implements OnInit, OnDestroy, AfterViewInit, Aft public changeSource(column: DashboardColumn, label: string): void { const item = column.item; if (this.isChart(item)) { - this.selectedSources.set(item.id, item.sources.findIndex(source => source.label === label)); + this.selectedSources.set( + item.id, + item.sources.findIndex(source => source.label === label), + ); } } @@ -278,7 +308,8 @@ export class DashboardComponent implements OnInit, OnDestroy, AfterViewInit, Aft try { if (this.selectedItems.length > 0) { this.commandHandler.execute( - new DeleteItemCommand(this.store, this.dashboard, this._page, this.selectedItems)); + new DeleteItemCommand(this.store, this.dashboard, this._page, this.selectedItems), + ); this.selectedItems.forEach(item => { this.selections.delete(item.id); @@ -301,7 +332,9 @@ export class DashboardComponent implements OnInit, OnDestroy, AfterViewInit, Aft public moveLeft(): void { try { - this.commandHandler.execute(new MoveLeftCommand(this.store, this.dashboard, this._page, this.selectedItem!)); + this.commandHandler.execute( + new MoveLeftCommand(this.store, this.dashboard, this._page, this.selectedItem!), + ); } catch (error) { this.notify.error(error); } @@ -314,7 +347,9 @@ export class DashboardComponent implements OnInit, OnDestroy, AfterViewInit, Aft public moveRight(): void { try { - this.commandHandler.execute(new MoveRightCommand(this.store, this.dashboard, this._page, this.selectedItem!)); + this.commandHandler.execute( + new MoveRightCommand(this.store, this.dashboard, this._page, this.selectedItem!), + ); } catch (error) { this.notify.error(error); } @@ -340,7 +375,9 @@ export class DashboardComponent implements OnInit, OnDestroy, AfterViewInit, Aft public moveDown(): void { try { - this.commandHandler.execute(new MoveDownCommand(this.store, this.dashboard, this._page, this.selectedItem!)); + this.commandHandler.execute( + new MoveDownCommand(this.store, this.dashboard, this._page, this.selectedItem!), + ); } catch (error) { this.notify.error(error); } @@ -366,13 +403,16 @@ export class DashboardComponent implements OnInit, OnDestroy, AfterViewInit, Aft public changeColor(column: DashboardColumn, color: string): void { try { - this.commandHandler.execute(new SetColorCommand( - this.store, - this.dashboard, - this._page, - column.item, - this.selectedSources.get(column.id) ?? 0, - color)); + this.commandHandler.execute( + new SetColorCommand( + this.store, + this.dashboard, + this._page, + column.item, + this.selectedSources.get(column.id) ?? 0, + color, + ), + ); } catch (error) { this.notify.error(error); } @@ -380,12 +420,15 @@ export class DashboardComponent implements OnInit, OnDestroy, AfterViewInit, Aft public changeChartType(column: DashboardColumn, value: string): void { try { - this.commandHandler.execute(new SetChartTypeCommand( - this.store, - this.dashboard, - this._page, - column.item, - value as DashboardChartType)); + this.commandHandler.execute( + new SetChartTypeCommand( + this.store, + this.dashboard, + this._page, + column.item, + value as DashboardChartType, + ), + ); } catch (error) { this.notify.error(error); } @@ -399,18 +442,21 @@ export class DashboardComponent implements OnInit, OnDestroy, AfterViewInit, Aft : '-'; } - return '-' + return '-'; } public changeMin(column: DashboardColumn, value: string): void { try { - this.commandHandler.execute(new SetMinMaxCommand( - this.store, - this.dashboard, - this._page, - column.item as DashboardChart, - Number(value), - undefined)); + this.commandHandler.execute( + new SetMinMaxCommand( + this.store, + this.dashboard, + this._page, + column.item as DashboardChart, + Number(value), + undefined, + ), + ); } catch (error) { this.notify.error(error); } @@ -424,18 +470,21 @@ export class DashboardComponent implements OnInit, OnDestroy, AfterViewInit, Aft : '-'; } - return '-' + return '-'; } public changeMax(column: DashboardColumn, value: string): void { try { - this.commandHandler.execute(new SetMinMaxCommand( - this.store, - this.dashboard, - this._page, - column.item as DashboardChart, - undefined, - Number(value))); + this.commandHandler.execute( + new SetMinMaxCommand( + this.store, + this.dashboard, + this._page, + column.item as DashboardChart, + undefined, + Number(value), + ), + ); } catch (error) { this.notify.error(error); } @@ -500,7 +549,7 @@ export class DashboardComponent implements OnInit, OnDestroy, AfterViewInit, Aft this.webSocketSubject = this.webServiceFactory.create(); this.webSocketSubject.subscribe({ next: this.socketOnMessage, - error: this.socketOnError + error: this.socketOnError, }); } } @@ -559,16 +608,16 @@ export class DashboardComponent implements OnInit, OnDestroy, AfterViewInit, Aft type: 'line', data: { labels: [], - datasets: [] + datasets: [], }, options: { scales: { - 'y': { + y: { min: item.min, - max: item.max - } - } - } + max: item.max, + }, + }, + }, }; let length = 0; @@ -603,17 +652,17 @@ export class DashboardComponent implements OnInit, OnDestroy, AfterViewInit, Aft type: 'bar', data: { labels: [item.label], - datasets: [] + datasets: [], }, options: { indexAxis: 'x', scales: { y: { min: item.min, - max: item.max - } - } - } + max: item.max, + }, + }, + }, }; for (const source of item.sources) { @@ -631,7 +680,7 @@ export class DashboardComponent implements OnInit, OnDestroy, AfterViewInit, Aft this.map.set(source.node.nodeId, { item, dataset }); } - dataset.data[0] = this.getInitialBarChartData(source.element as aas.Property) + dataset.data[0] = this.getInitialBarChartData(source.element as aas.Property); } return { chart: new Chart(canvas, configuration), configuration }; @@ -642,17 +691,17 @@ export class DashboardComponent implements OnInit, OnDestroy, AfterViewInit, Aft type: 'bar', data: { labels: [item.label], - datasets: [] + datasets: [], }, options: { indexAxis: 'y', scales: { x: { min: item.min, - max: item.max - } - } - } + max: item.max, + }, + }, + }, }; for (const source of item.sources) { @@ -670,7 +719,7 @@ export class DashboardComponent implements OnInit, OnDestroy, AfterViewInit, Aft this.map.set(source.node.nodeId, { item, dataset }); } - dataset.data[0] = this.getInitialBarChartData(source.element as aas.Property) + dataset.data[0] = this.getInitialBarChartData(source.element as aas.Property); } return { chart: new Chart(canvas, configuration), configuration }; @@ -681,22 +730,22 @@ export class DashboardComponent implements OnInit, OnDestroy, AfterViewInit, Aft type: 'line', data: { labels: [], - datasets: [] + datasets: [], }, options: { scales: { y: { min: item.min, - max: item.max - } + max: item.max, + }, }, plugins: { decimation: { enabled: true, - algorithm: 'min-max' + algorithm: 'min-max', }, - } - } + }, + }, }; for (const source of item.sources) { @@ -709,7 +758,7 @@ export class DashboardComponent implements OnInit, OnDestroy, AfterViewInit, Aft borderWidth: 1, data: [], animation: false, - pointRadius: 0 + pointRadius: 0, }; configuration.data.datasets.push(dataset); @@ -734,7 +783,7 @@ export class DashboardComponent implements OnInit, OnDestroy, AfterViewInit, Aft private getTimeSeriesData(url: string, data: number[], labels: string[]): void { this.api.getBlobValue(url).subscribe({ - next: (value) => { + next: value => { const timeSeries: TimeSeries = JSON.parse(window.atob(value)); if (timeSeries.timestamp && timeSeries.value) { const n = Math.min(timeSeries.value.length, timeSeries.timestamp.length); @@ -744,26 +793,26 @@ export class DashboardComponent implements OnInit, OnDestroy, AfterViewInit, Aft } } }, - error: (error) => this.notify.error(error) + error: error => this.notify.error(error), }); } private createMessage(request: LiveRequest): WebSocketData { return { type: 'LiveRequest', - data: request - } + data: request, + }; } private socketOnMessage = (data: WebSocketData): void => { if (data.type === 'LiveNode[]') { - this.updateCharts(data.data as LiveNode[]) + this.updateCharts(data.data as LiveNode[]); } - } + }; private socketOnError = (error: unknown): void => { this.notify.error(error); - } + }; private updateCharts(nodes: LiveNode[]): void { for (const node of nodes) { @@ -828,7 +877,7 @@ export class DashboardComponent implements OnInit, OnDestroy, AfterViewInit, Aft } } - private isBigInt(y: unknown): boolean { + private isBigInt(y: unknown): y is number[] { return Array.isArray(y) && y.length === 2 && isNumber(y[0]) && isNumber(y[1]); } diff --git a/projects/aas-portal/src/app/dashboard/dashboard.reducer.ts b/projects/aas-portal/src/app/dashboard/dashboard.reducer.ts index 2f373d53..a7825e02 100644 --- a/projects/aas-portal/src/app/dashboard/dashboard.reducer.ts +++ b/projects/aas-portal/src/app/dashboard/dashboard.reducer.ts @@ -28,46 +28,21 @@ export const initialState: DashboardState = { pages: [], editMode: false, selectionMode: SelectionMode.Single, - rows: [] + rows: [], }; -export const dashboardReducer = createReducer(initialState, - on( - DashboardActions.addNewPage, - (state, { name }) => addNewPage(state, name) - ), - on( - DashboardActions.deletePage, - (state, { page }) => deletePage(state, page) - ), - on( - DashboardActions.renamePage, - (state, { page, name }) => renamePage(state, page, name) - ), - on( - DashboardActions.setPageName, - (state, { name }) => setPageName(state, name) - ), - on( - DashboardActions.setPages, - (state, { pages }) => setPages(state, pages) - ), - on( - DashboardActions.setState, - (_, { state }) => setState(state) - ), - on( - DashboardActions.setEditMode, - (state, { editMode }) => setEditMode(state, editMode) - ), - on( - DashboardActions.updatePage, - (state, { page, rows }) => updatePage(state, page, rows) - ), - on( - DashboardActions.updateRows, - (state, { rows }) => updateRows(state, rows) - )); +export const dashboardReducer = createReducer( + initialState, + on(DashboardActions.addNewPage, (state, { name }) => addNewPage(state, name)), + on(DashboardActions.deletePage, (state, { page }) => deletePage(state, page)), + on(DashboardActions.renamePage, (state, { page, name }) => renamePage(state, page, name)), + on(DashboardActions.setPageName, (state, { name }) => setPageName(state, name)), + on(DashboardActions.setPages, (state, { pages }) => setPages(state, pages)), + on(DashboardActions.setState, (_, { state }) => setState(state)), + on(DashboardActions.setEditMode, (state, { editMode }) => setEditMode(state, editMode)), + on(DashboardActions.updatePage, (state, { page, rows }) => updatePage(state, page, rows)), + on(DashboardActions.updateRows, (state, { rows }) => updateRows(state, rows)), +); function updateRows(state: DashboardState, rows: DashboardRow[]): DashboardState { return { ...state, rows }; @@ -114,12 +89,12 @@ function deletePage(state: DashboardState, page: DashboardPage): DashboardState } function renamePage(state: DashboardState, page: DashboardPage, name: string): DashboardState { - const index = state.pages.indexOf(page) + const index = state.pages.indexOf(page); if (index < 0) { return state; } - const pages = [...state.pages] + const pages = [...state.pages]; pages[index] = { ...page, name }; return state.name === page.name ? { ...state, pages, name } : { ...state, pages }; } @@ -129,7 +104,7 @@ function addNewPage(state: DashboardState, name?: string): DashboardState { const page: DashboardPage = { name: name, items: [], - requests: [] + requests: [], }; const pages = [...state.pages, page]; @@ -138,4 +113,4 @@ function addNewPage(state: DashboardState, name?: string): DashboardState { function setState(state: DashboardState): DashboardState { return state; -} \ No newline at end of file +} diff --git a/projects/aas-portal/src/app/dashboard/dashboard.selectors.ts b/projects/aas-portal/src/app/dashboard/dashboard.selectors.ts index a47603de..321e75fc 100644 --- a/projects/aas-portal/src/app/dashboard/dashboard.selectors.ts +++ b/projects/aas-portal/src/app/dashboard/dashboard.selectors.ts @@ -6,8 +6,8 @@ * *****************************************************************************/ -import { createSelector } from "@ngrx/store"; -import { State } from "./dashboard.state"; +import { createSelector } from '@ngrx/store'; +import { State } from './dashboard.state'; const getName = (state: State) => state.dashboard.name; const getPages = (state: State) => state.dashboard.pages; @@ -16,19 +16,16 @@ const getSelectionMode = (state: State) => state.dashboard.selectionMode; const getRows = (state: State) => state.dashboard.rows; const getState = (state: State) => state.dashboard; -export const selectName = createSelector(getName, (name) => name); +export const selectName = createSelector(getName, name => name); -export const selectPages = createSelector(getPages, (pages) => pages); +export const selectPages = createSelector(getPages, pages => pages); -export const selectEditMode = createSelector(getEditMode, (editMode) => editMode); +export const selectEditMode = createSelector(getEditMode, editMode => editMode); -export const selectSelectionMode = createSelector(getSelectionMode, (selectionMode) => selectionMode); +export const selectSelectionMode = createSelector(getSelectionMode, selectionMode => selectionMode); -export const selectRows = createSelector(getRows, (rows) => rows); +export const selectRows = createSelector(getRows, rows => rows); -export const selectPage = createSelector( - getName, - getPages, - (name, pages) => pages.find(page => page.name === name)); +export const selectPage = createSelector(getName, getPages, (name, pages) => pages.find(page => page.name === name)); -export const selectState = createSelector(getState, (state) => state); +export const selectState = createSelector(getState, state => state); diff --git a/projects/aas-portal/src/app/dashboard/dashboard.service.ts b/projects/aas-portal/src/app/dashboard/dashboard.service.ts index 4421271f..48d4cf56 100644 --- a/projects/aas-portal/src/app/dashboard/dashboard.service.ts +++ b/projects/aas-portal/src/app/dashboard/dashboard.service.ts @@ -8,7 +8,16 @@ import { Injectable } from '@angular/core'; import { v4 as uuid } from 'uuid'; -import { aas, AASDocument, AASEndpointType, ApplicationError, EndpointType, getIdShortPath, getUnit, LiveNode } from 'common'; +import { + aas, + AASDocument, + AASEndpointType, + ApplicationError, + EndpointType, + getIdShortPath, + getUnit, + LiveNode, +} from 'common'; import { cloneDeep } from 'lodash-es'; import { ERRORS } from '../types/errors'; import { Observable } from 'rxjs'; @@ -24,11 +33,11 @@ import { DashboardChartType, DashboardItem, DashboardRow, - State + State, } from './dashboard.state'; @Injectable({ - providedIn: 'root' + providedIn: 'root', }) export class DashboardService { private readonly store: Store; @@ -36,9 +45,9 @@ export class DashboardService { private _name = ''; private modified = false; - constructor( + public constructor( store: Store, - private auth: AuthService + private auth: AuthService, ) { this.store = store as Store; @@ -46,8 +55,8 @@ export class DashboardService { this.pages = this.store.select(DashboardSelectors.selectPages); this.name = this.store.select(DashboardSelectors.selectName); - this.pages.subscribe(pages => this._pages = pages); - this.name.subscribe(name => this._name = name); + this.pages.subscribe(pages => (this._pages = pages)); + this.name.subscribe(name => (this._name = name)); } public get defaultPage(): DashboardPage { @@ -72,7 +81,12 @@ export class DashboardService { } } - public add(name: string, document: AASDocument, elements: aas.SubmodelElement[], chartType: DashboardChartType): void { + public add( + name: string, + document: AASDocument, + elements: aas.SubmodelElement[], + chartType: DashboardChartType, + ): void { const pages = this._pages; const i = pages.findIndex(item => item.name === name); if (i < 0) { @@ -80,11 +94,9 @@ export class DashboardService { } const page = cloneDeep(pages[i]); - const properties = elements.filter(item => item.modelType === 'Property') - .map(item => item as aas.Property); + const properties = elements.filter(item => item.modelType === 'Property').map(item => item as aas.Property); - const blobs = elements.filter(item => item.modelType === 'Blob') - .map(item => item as aas.Blob); + const blobs = elements.filter(item => item.modelType === 'Blob').map(item => item as aas.Blob); const nodes = this.getNodes(page, document); if (properties.length > 0) { @@ -118,7 +130,8 @@ export class DashboardService { throw new ApplicationError( `A page withe name "${name}" already exists.`, ERRORS.DASHBOARD_PAGE_ALREADY_EXISTS, - name); + name, + ); } this.store.dispatch(DashboardActions.addNewPage({ name })); @@ -135,7 +148,8 @@ export class DashboardService { throw new ApplicationError( `A page withe name "${name}" already exists.`, ERRORS.DASHBOARD_PAGE_ALREADY_EXISTS, - name); + name, + ); } this.store.dispatch(DashboardActions.renamePage({ page, name })); @@ -145,7 +159,7 @@ export class DashboardService { public getGrid(page: DashboardPage): DashboardItem[][] { const map = new Map(); page.items.forEach(item => { - const y = item.positions[0].y + const y = item.positions[0].y; let row = map.get(y); if (!row) { row = []; @@ -157,7 +171,7 @@ export class DashboardService { const grid: DashboardItem[][] = []; let y = 0; - for (let i = 0; i < map.size;) { + for (let i = 0; i < map.size; ) { const row = map.get(y); if (row) { row.sort((a, b) => a.positions[0].x - b.positions[0].x); @@ -176,13 +190,13 @@ export class DashboardService { columns: row.map(item => ({ id: item.id, item: item, - itemType: item.type - })) + itemType: item.type, + })), })); } public canMoveLeft(page: DashboardPage, item: DashboardItem): boolean { - return item.positions[0].x > 0 + return item.positions[0].x > 0; } public canMoveRight(page: DashboardPage, item: DashboardItem): boolean { @@ -195,7 +209,7 @@ export class DashboardService { const y = item.positions[0].y; if (y > 0) { if (grid[y - 1].length < 12) { - return true + return true; } } else if (grid[y].length > 1) { return true; @@ -239,7 +253,8 @@ export class DashboardService { page: DashboardPage, env: aas.Environment, properties: aas.Property[], - nodes: LiveNode[] | null): void { + nodes: LiveNode[] | null, + ): void { let columnIndex = 0; let rowIndex = page.items.length > 0 ? Math.max(...page.items.map(item => item.positions[0].y)) + 1 : 0; for (const property of properties) { @@ -261,12 +276,14 @@ export class DashboardService { type: DashboardItemType.Chart, chartType: DashboardChartType.Line, positions: [{ x: columnIndex, y: rowIndex }], - sources: [{ - label: property.idShort, - color: this.createRandomColor(), - element: property, - node: node, - }] + sources: [ + { + label: property.idShort, + color: this.createRandomColor(), + element: property, + node: node, + }, + ], }; page.items.push(item); @@ -283,7 +300,7 @@ export class DashboardService { type: DashboardItemType.Chart, chartType: DashboardChartType.BarVertical, positions: [{ x: 0, y: rowIndex }], - sources: [] + sources: [], }; for (const property of properties) { @@ -320,13 +337,15 @@ export class DashboardService { type: DashboardItemType.Chart, chartType: DashboardChartType.TimeSeries, positions: [{ x: columnIndex, y: rowIndex }], - sources: [{ - label: blob.idShort, - color: this.createRandomColor(), - element: blob, - node: null, - url: `/api/v1/containers/${name}/documents/${id}/submodels/${smId}/blobs/${path}/value` - }] + sources: [ + { + label: blob.idShort, + color: this.createRandomColor(), + element: blob, + node: null, + url: `/api/v1/containers/${name}/documents/${id}/submodels/${smId}/blobs/${path}/value`, + }, + ], }; page.items.push(item); @@ -349,7 +368,7 @@ export class DashboardService { page.requests.push({ endpoint: document.endpoint, id: document.id, - nodes: nodes + nodes: nodes, }); } } @@ -410,4 +429,4 @@ export class DashboardService { const blue = Math.trunc(Math.random() * 255).toString(16); return '#' + red + green + blue; } -} \ No newline at end of file +} diff --git a/projects/aas-portal/src/app/dashboard/dashboard.state.ts b/projects/aas-portal/src/app/dashboard/dashboard.state.ts index 4748b77a..9a910415 100644 --- a/projects/aas-portal/src/app/dashboard/dashboard.state.ts +++ b/projects/aas-portal/src/app/dashboard/dashboard.state.ts @@ -13,14 +13,14 @@ export type DashboardColor = string; export enum DashboardItemType { Chart = 'Chart', - Grid = 'Grid' + Grid = 'Grid', } export enum DashboardChartType { Line = 'Line', BarVertical = 'BarVertical', BarHorizontal = 'BarHorizontal', - TimeSeries = 'TimeSeries' + TimeSeries = 'TimeSeries', } export interface DashboardSource { @@ -74,7 +74,7 @@ export interface DashboardColumn { } export interface DashboardRow { - columns: DashboardColumn[] + columns: DashboardColumn[]; } export interface DashboardState { @@ -82,7 +82,7 @@ export interface DashboardState { pages: DashboardPage[]; editMode: boolean; selectionMode: SelectionMode; - rows: DashboardRow[] + rows: DashboardRow[]; } export interface State { diff --git a/projects/aas-portal/src/app/http-loader-factory.ts b/projects/aas-portal/src/app/http-loader-factory.ts index 84533c09..53b7f7ab 100644 --- a/projects/aas-portal/src/app/http-loader-factory.ts +++ b/projects/aas-portal/src/app/http-loader-factory.ts @@ -11,4 +11,4 @@ import { TranslateHttpLoader } from '@ngx-translate/http-loader'; export function HttpLoaderFactory(http: HttpClient) { return new TranslateHttpLoader(http, './assets/i18n/', '.json'); -} \ No newline at end of file +} diff --git a/projects/aas-portal/src/app/index.ts b/projects/aas-portal/src/app/index.ts index 0b99a91c..01f19967 100644 --- a/projects/aas-portal/src/app/index.ts +++ b/projects/aas-portal/src/app/index.ts @@ -9,6 +9,4 @@ import { HTTP_INTERCEPTORS } from '@angular/common/http'; import { AuthInterceptor } from 'projects/aas-lib/src/public-api'; -export const httpInterceptorProviders = [ - { provide: HTTP_INTERCEPTORS, useClass: AuthInterceptor, multi: true }, -]; \ No newline at end of file +export const httpInterceptorProviders = [{ provide: HTTP_INTERCEPTORS, useClass: AuthInterceptor, multi: true }]; diff --git a/projects/aas-portal/src/app/main/main-api.service.ts b/projects/aas-portal/src/app/main/main-api.service.ts index 99c972f3..b9b07c4d 100644 --- a/projects/aas-portal/src/app/main/main-api.service.ts +++ b/projects/aas-portal/src/app/main/main-api.service.ts @@ -7,19 +7,17 @@ *****************************************************************************/ import { Injectable } from '@angular/core'; -import { HttpClient, } from '@angular/common/http'; +import { HttpClient } from '@angular/common/http'; import { AASDocument } from 'common'; import { Observable } from 'rxjs'; import { encodeBase64Url } from 'projects/aas-lib/src/public-api'; /** The client side AAS provider service. */ @Injectable({ - providedIn: 'root' + providedIn: 'root', }) export class MainApiService { - constructor( - private readonly http: HttpClient, - ) { } + public constructor(private readonly http: HttpClient) {} /** * Gets the first AAS with the specified identifier. @@ -29,4 +27,4 @@ export class MainApiService { public getDocument(id: string): Observable { return this.http.get(`/api/v1/documents/${encodeBase64Url(id)}`); } -} \ No newline at end of file +} diff --git a/projects/aas-portal/src/app/main/main.component.ts b/projects/aas-portal/src/app/main/main.component.ts index 1e33a59b..93c49ad7 100644 --- a/projects/aas-portal/src/app/main/main.component.ts +++ b/projects/aas-portal/src/app/main/main.component.ts @@ -18,7 +18,7 @@ export enum LinkId { AAS = 1, VIEW = 2, DASHBOARD = 3, - ABOUT = 4 + ABOUT = 4, } export interface LinkDescriptor { @@ -30,37 +30,47 @@ export interface LinkDescriptor { @Component({ selector: 'fhg-main', templateUrl: './main.component.html', - styleUrls: ['./main.component.scss'] + styleUrls: ['./main.component.scss'], }) export class MainComponent implements OnInit, OnDestroy { private readonly subscription = new Subscription(); private readonly _links: LinkDescriptor[] = [ { - id: LinkId.START, name: "CAPTION_START", url: "/start" + id: LinkId.START, + name: 'CAPTION_START', + url: '/start', }, { - id: LinkId.AAS, name: "CAPTION_AAS", url: '/aas' + id: LinkId.AAS, + name: 'CAPTION_AAS', + url: '/aas', }, { - id: LinkId.VIEW, name: "CAPTION_VIEW", url: '/view' + id: LinkId.VIEW, + name: 'CAPTION_VIEW', + url: '/view', }, { - id: LinkId.DASHBOARD, name: "CAPTION_DASHBOARD", url: '/dashboard' + id: LinkId.DASHBOARD, + name: 'CAPTION_DASHBOARD', + url: '/dashboard', }, { - id: LinkId.ABOUT, name: "CAPTION_ABOUT", url: "/about" - } + id: LinkId.ABOUT, + name: 'CAPTION_ABOUT', + url: '/about', + }, ]; - constructor( + public constructor( private readonly router: Router, private readonly window: WindowService, private readonly api: MainApiService, private readonly clipboard: ClipboardService, private readonly viewContainer: ViewContainerRef, - private readonly toolbar: ToolbarService) { - - this.toolbarTemplate = this.toolbar.toolbarTemplate.pipe(map(value => this.nextToolbar(value))) + private readonly toolbar: ToolbarService, + ) { + this.toolbarTemplate = this.toolbar.toolbarTemplate.pipe(map(value => this.nextToolbar(value))); } @ViewChild('emptyToolbar', { read: TemplateRef }) @@ -78,14 +88,17 @@ export class MainComponent implements OnInit, OnDestroy { const params = this.window.getQueryParams(); const id = params.get('id'); if (id) { - this.api.getDocument(id).pipe(first()).subscribe(document => { - if (document) { - this.clipboard.set('AASQuery', { id: document.id } as AASQuery); - this.router.navigateByUrl('/aas?format=AASQuery', { skipLocationChange: true }); - } else { - this.router.navigateByUrl('/start', { skipLocationChange: true }); - } - }); + this.api + .getDocument(id) + .pipe(first()) + .subscribe(document => { + if (document) { + this.clipboard.set('AASQuery', { id: document.id } as AASQuery); + this.router.navigateByUrl('/aas?format=AASQuery', { skipLocationChange: true }); + } else { + this.router.navigateByUrl('/start', { skipLocationChange: true }); + } + }); } else { this.router.navigateByUrl('/start', { skipLocationChange: true }); } @@ -98,4 +111,4 @@ export class MainComponent implements OnInit, OnDestroy { private nextToolbar(value: TemplateRef | null): TemplateRef { return value ?? this.emptyToolbar; } -} \ No newline at end of file +} diff --git a/projects/aas-portal/src/app/start/add-endpoint-form/add-endpoint-form.component.html b/projects/aas-portal/src/app/start/add-endpoint-form/add-endpoint-form.component.html index 9360f502..6d5f0835 100644 --- a/projects/aas-portal/src/app/start/add-endpoint-form/add-endpoint-form.component.html +++ b/projects/aas-portal/src/app/start/add-endpoint-form/add-endpoint-form.component.html @@ -12,7 +12,7 @@

CAPTION_ADD_ENDPOINT

- +
@for (message of messages; track message) { diff --git a/projects/aas-portal/src/app/start/add-endpoint-form/add-endpoint-form.component.ts b/projects/aas-portal/src/app/start/add-endpoint-form/add-endpoint-form.component.ts index 5791b9a1..39c5bcce 100644 --- a/projects/aas-portal/src/app/start/add-endpoint-form/add-endpoint-form.component.ts +++ b/projects/aas-portal/src/app/start/add-endpoint-form/add-endpoint-form.component.ts @@ -20,27 +20,28 @@ export interface EndpointItem { @Component({ selector: 'fhg-add-endpoint', templateUrl: './add-endpoint-form.component.html', - styleUrls: ['./add-endpoint-form.component.scss'] + styleUrls: ['./add-endpoint-form.component.scss'], }) export class AddEndpointFormComponent { - constructor( + public constructor( private modal: NgbActiveModal, - private translate: TranslateService) { + private translate: TranslateService, + ) { this.items = [ { name: this.translate.instant('AASEndpointType.AasxServer'), type: 'AasxServer', - value: 'http://' + value: 'http://', }, { name: this.translate.instant('AASEndpointType.OpcuaServer'), type: 'OpcuaServer', - value: 'opc.tcp://' + value: 'opc.tcp://', }, { name: this.translate.instant('AASEndpointType.AasxDirectory'), type: 'AasxDirectory', - value: 'file:///' + value: 'file:///', }, ]; @@ -94,7 +95,6 @@ export class AddEndpointFormComponent { this.messages.push(this.createMessage('ERROR_EMPTY_ENDPOINT_NAME')); name = undefined; } else { - for (const workspace of this.endpoints) { if (workspace.toLocaleLowerCase() === name.toLocaleLowerCase()) { this.messages.push(this.createMessage('ERROR_ENDPOINT_ALREADY_EXIST', name)); @@ -139,4 +139,4 @@ export class AddEndpointFormComponent { private createMessage(id: string, ...args: unknown[]): string { return stringFormat(this.translate.instant(id), args); } -} \ No newline at end of file +} diff --git a/projects/aas-portal/src/app/start/favorites-form/favorites-form.component.html b/projects/aas-portal/src/app/start/favorites-form/favorites-form.component.html index 41bfd9f8..424d5a30 100644 --- a/projects/aas-portal/src/app/start/favorites-form/favorites-form.component.html +++ b/projects/aas-portal/src/app/start/favorites-form/favorites-form.component.html @@ -12,7 +12,7 @@

CAPTION_FAVORITES

- +
@for (message of messages; track message) { diff --git a/projects/aas-portal/src/app/start/favorites-form/favorites-form.component.ts b/projects/aas-portal/src/app/start/favorites-form/favorites-form.component.ts index 4c7a32cb..f1c17dee 100644 --- a/projects/aas-portal/src/app/start/favorites-form/favorites-form.component.ts +++ b/projects/aas-portal/src/app/start/favorites-form/favorites-form.component.ts @@ -25,7 +25,7 @@ export class FavoritesFormComponent { public constructor( private readonly modal: NgbActiveModal, private readonly favorites: FavoritesService, - private readonly store: FavoritesFormStore + private readonly store: FavoritesFormStore, ) { this.items = this.store.select(state => state.items); @@ -92,4 +92,4 @@ export class FavoritesFormComponent { this.messages = []; } } -} \ No newline at end of file +} diff --git a/projects/aas-portal/src/app/start/favorites-form/favorites-form.store.ts b/projects/aas-portal/src/app/start/favorites-form/favorites-form.store.ts index d04b973e..3edc6231 100644 --- a/projects/aas-portal/src/app/start/favorites-form/favorites-form.store.ts +++ b/projects/aas-portal/src/app/start/favorites-form/favorites-form.store.ts @@ -55,4 +55,4 @@ export class FavoritesFormStore extends ComponentStore { return { ...state, items }; }); } -} \ No newline at end of file +} diff --git a/projects/aas-portal/src/app/start/favorites.service.ts b/projects/aas-portal/src/app/start/favorites.service.ts index ee2c5edd..c47f2b64 100644 --- a/projects/aas-portal/src/app/start/favorites.service.ts +++ b/projects/aas-portal/src/app/start/favorites.service.ts @@ -12,7 +12,7 @@ import { AASDocument } from 'common'; import { AuthService } from 'projects/aas-lib/src/public-api'; @Injectable({ - providedIn: 'root' + providedIn: 'root', }) export class FavoritesService { private _lists: FavoritesList[]; @@ -72,9 +72,10 @@ export class FavoritesService { const lists = [...this.lists]; const list = { ...lists[i] }; list.documents = list.documents.filter(favorite => - documents.every(document => favorite.endpoint !== document.endpoint || favorite.id !== document.id)); + documents.every(document => favorite.endpoint !== document.endpoint || favorite.id !== document.id), + ); this._lists = lists; this.auth.setCookie('.Favorites', JSON.stringify(this._lists)); } -} \ No newline at end of file +} diff --git a/projects/aas-portal/src/app/start/remove-endpoint-form/remove-endpoint-form.component.html b/projects/aas-portal/src/app/start/remove-endpoint-form/remove-endpoint-form.component.html index 566186b2..e8c28833 100644 --- a/projects/aas-portal/src/app/start/remove-endpoint-form/remove-endpoint-form.component.html +++ b/projects/aas-portal/src/app/start/remove-endpoint-form/remove-endpoint-form.component.html @@ -12,7 +12,7 @@

CAPTION_REMOVE_ENDPOINT

- +
@for (message of messages; track message) { diff --git a/projects/aas-portal/src/app/start/remove-endpoint-form/remove-endpoint-form.component.ts b/projects/aas-portal/src/app/start/remove-endpoint-form/remove-endpoint-form.component.ts index 953dc13f..5dfc9217 100644 --- a/projects/aas-portal/src/app/start/remove-endpoint-form/remove-endpoint-form.component.ts +++ b/projects/aas-portal/src/app/start/remove-endpoint-form/remove-endpoint-form.component.ts @@ -6,9 +6,9 @@ * *****************************************************************************/ -import { Component } from "@angular/core"; -import { NgbActiveModal } from "@ng-bootstrap/ng-bootstrap"; -import { TranslateService } from "@ngx-translate/core"; +import { Component } from '@angular/core'; +import { NgbActiveModal } from '@ng-bootstrap/ng-bootstrap'; +import { TranslateService } from '@ngx-translate/core'; export interface EndpointSelect { name: string; @@ -17,13 +17,15 @@ export interface EndpointSelect { } @Component({ - selector: "fhg-remove-endpoint", - templateUrl: "./remove-endpoint-form.component.html", - styleUrls: ["./remove-endpoint-form.component.scss"], + selector: 'fhg-remove-endpoint', + templateUrl: './remove-endpoint-form.component.html', + styleUrls: ['./remove-endpoint-form.component.scss'], }) export class RemoveEndpointFormComponent { - constructor(private modal: NgbActiveModal, private translate: TranslateService) { - } + public constructor( + private modal: NgbActiveModal, + private translate: TranslateService, + ) {} public endpoints: EndpointSelect[] = []; @@ -53,4 +55,4 @@ export class RemoveEndpointFormComponent { this.messages = []; } } -} \ No newline at end of file +} diff --git a/projects/aas-portal/src/app/start/start-api.service.ts b/projects/aas-portal/src/app/start/start-api.service.ts index b53e8d69..b35e17b8 100644 --- a/projects/aas-portal/src/app/start/start-api.service.ts +++ b/projects/aas-portal/src/app/start/start-api.service.ts @@ -7,24 +7,22 @@ *****************************************************************************/ import { Injectable } from '@angular/core'; -import { HttpClient, } from '@angular/common/http'; +import { HttpClient } from '@angular/common/http'; import { Observable } from 'rxjs'; import { AASCursor, AASDocument, AASEndpoint, AASPage, aas } from 'common'; import { encodeBase64Url } from 'projects/aas-lib/src/public-api'; /** The client side AAS provider service. */ @Injectable({ - providedIn: 'root' + providedIn: 'root', }) export class StartApiService { - constructor( - private readonly http: HttpClient, - ) {} + public constructor(private readonly http: HttpClient) {} /** - * Returns all configured AAS endpoints. - * @returns An array of `AASContainer`. - */ + * Returns all configured AAS endpoints. + * @returns An array of `AASContainer`. + */ public getEndpoints(): Observable { return this.http.get('/api/v1/endpoints'); } @@ -57,10 +55,9 @@ export class StartApiService { * @returns An observable. */ public delete(id: string, url: string): Observable { - return this.http.delete( - `/api/v1/containers/${encodeBase64Url(url)}/packages/${encodeBase64Url(id)}`); + return this.http.delete(`/api/v1/containers/${encodeBase64Url(url)}/packages/${encodeBase64Url(id)}`); } - + /** * Returns a page of documents from the specified cursor. * @param cursor The current cursor. @@ -88,17 +85,19 @@ export class StartApiService { */ public getContent(endpointName: string, id: string): Observable { return this.http.get( - `/api/v1/containers/${encodeBase64Url(endpointName)}/documents/${encodeBase64Url(id)}/content`); + `/api/v1/containers/${encodeBase64Url(endpointName)}/documents/${encodeBase64Url(id)}/content`, + ); } /** - * - * @param endpointName - * @param id - * @returns + * + * @param endpointName + * @param id + * @returns */ public getHierarchy(endpointName: string, id: string): Observable { return this.http.get( - `/api/v1/containers/${encodeBase64Url(endpointName)}/documents/${encodeBase64Url(id)}/hierarchy`); + `/api/v1/containers/${encodeBase64Url(endpointName)}/documents/${encodeBase64Url(id)}/hierarchy`, + ); } -} \ No newline at end of file +} diff --git a/projects/aas-portal/src/app/start/start.actions.ts b/projects/aas-portal/src/app/start/start.actions.ts index f4d55769..5a5c2e28 100644 --- a/projects/aas-portal/src/app/start/start.actions.ts +++ b/projects/aas-portal/src/app/start/start.actions.ts @@ -38,49 +38,40 @@ export interface GetFavoritesAction extends TypedAction()); +export const setViewMode = createAction(StartActionType.SET_VIEW_MODE, props<{ viewMode: ViewMode }>()); -export const addTree = createAction( - StartActionType.ADD_TREE, - props<{ documents: AASDocument[] }>()); +export const addTree = createAction(StartActionType.ADD_TREE, props<{ documents: AASDocument[] }>()); -export const getFirstPage = createAction( - StartActionType.GET_FIRST_PAGE, - props<{ limit?: number, filter?: string }>()); +export const getFirstPage = createAction(StartActionType.GET_FIRST_PAGE, props<{ limit?: number; filter?: string }>()); -export const getNextPage = createAction( - StartActionType.GET_NEXT_PAGE); +export const getNextPage = createAction(StartActionType.GET_NEXT_PAGE); -export const getPreviousPage = createAction( - StartActionType.GET_PREVIOUS_PAGE); +export const getPreviousPage = createAction(StartActionType.GET_PREVIOUS_PAGE); -export const getLastPage = createAction( - StartActionType.GET_LAST_PAGE); +export const getLastPage = createAction(StartActionType.GET_LAST_PAGE); export const setPage = createAction( StartActionType.SET_PAGE, - props<{ page: AASPage, limit: number | undefined, filter: string | undefined }>()); + props<{ page: AASPage; limit: number | undefined; filter: string | undefined }>(), +); export const setContent = createAction( StartActionType.SET_CONTENT, - props<{ document: AASDocument, content: aas.Environment }>()); + props<{ document: AASDocument; content: aas.Environment }>(), +); export const getFavorites = createAction( StartActionType.GET_FAVORITES, - props<{ name: string, documents: AASDocument[] }>()); + props<{ name: string; documents: AASDocument[] }>(), +); export const setFavorites = createAction( StartActionType.SET_FAVORITES, - props<{ name: string, documents: AASDocument[] }>()); + props<{ name: string; documents: AASDocument[] }>(), +); -export const removeFavorites = createAction( - StartActionType.REMOVE_FAVORITES, - props<{ favorites: AASDocument[] }>()); +export const removeFavorites = createAction(StartActionType.REMOVE_FAVORITES, props<{ favorites: AASDocument[] }>()); diff --git a/projects/aas-portal/src/app/start/start.component.ts b/projects/aas-portal/src/app/start/start.component.ts index 84307b1c..eb8bc340 100644 --- a/projects/aas-portal/src/app/start/start.component.ts +++ b/projects/aas-portal/src/app/start/start.component.ts @@ -25,7 +25,7 @@ import { WindowService, ZVEINameplate, resolveSemanticId, - supportedSubmodelTemplates + supportedSubmodelTemplates, } from 'projects/aas-lib/src/public-api'; import { AddEndpointFormComponent } from './add-endpoint-form/add-endpoint-form.component'; @@ -45,13 +45,13 @@ import { FavoritesFormComponent } from './favorites-form/favorites-form.componen styleUrls: ['./start.component.scss'], }) export class StartComponent implements OnDestroy, AfterViewInit { - private readonly store: Store + private readonly store: Store; private readonly subscription = new Subscription(); private readonly someSelectedDocuments = new BehaviorSubject(true); private _selected: AASDocument[] = []; private _favoritesList = '-'; - constructor( + public constructor( store: Store, private readonly router: Router, private readonly modal: NgbModal, @@ -74,18 +74,25 @@ export class StartComponent implements OnDestroy, AfterViewInit { this.viewMode = this.store.select(StartSelectors.selectViewMode); this.endpoints = this.api.getEndpoints(); - this.store.select(StartSelectors.selectViewMode).pipe( - first(viewMode => viewMode === ViewMode.Undefined), - mergeMap(() => this.auth.ready), - first(ready => ready), - first(), - ).subscribe({ - next: () => this.store.dispatch(StartActions.getFirstPage({})), - error: error => this.notify.error(error), - }); + this.store + .select(StartSelectors.selectViewMode) + .pipe( + first(viewMode => viewMode === ViewMode.Undefined), + mergeMap(() => this.auth.ready), + first(ready => ready), + first(), + ) + .subscribe({ + next: () => this.store.dispatch(StartActions.getFirstPage({})), + error: error => this.notify.error(error), + }); - this.subscription.add(this.store.select(StartSelectors.selectFavorites).pipe() - .subscribe(value => this._favoritesList = value)) + this.subscription.add( + this.store + .select(StartSelectors.selectFavorites) + .pipe() + .subscribe(value => (this._favoritesList = value)), + ); } @ViewChild('startToolbar', { read: TemplateRef }) @@ -99,10 +106,12 @@ export class StartComponent implements OnDestroy, AfterViewInit { if (value !== this._favoritesList) { const favoritesList = this.favorites.get(value); if (favoritesList) { - this.store.dispatch(StartActions.getFavorites({ - name: favoritesList.name, - documents: favoritesList.documents, - })); + this.store.dispatch( + StartActions.getFavorites({ + name: favoritesList.name, + documents: favoritesList.documents, + }), + ); } else { this.store.dispatch(StartActions.getFirstPage({})); } @@ -156,48 +165,62 @@ export class StartComponent implements OnDestroy, AfterViewInit { } public addEndpoint(): void { - this.auth.ensureAuthorized('editor').pipe( - mergeMap(() => this.api.getEndpoints()), - map(endpoints => { - const modalRef = this.modal.open(AddEndpointFormComponent, { backdrop: 'static' }); - modalRef.componentInstance.workspaces = endpoints; - return modalRef; - }), - mergeMap(modalRef => from>(modalRef.result)), - mergeMap((result) => { - if (!result) return EMPTY; - - return this.api.addEndpoint(result); - })).subscribe({ error: (error) => this.notify.error(error) }); + this.auth + .ensureAuthorized('editor') + .pipe( + mergeMap(() => this.api.getEndpoints()), + map(endpoints => { + const modalRef = this.modal.open(AddEndpointFormComponent, { backdrop: 'static' }); + modalRef.componentInstance.workspaces = endpoints; + return modalRef; + }), + mergeMap(modalRef => from>(modalRef.result)), + mergeMap(result => { + if (!result) return EMPTY; + + return this.api.addEndpoint(result); + }), + ) + .subscribe({ error: error => this.notify.error(error) }); } public removeEndpoint(): void { - this.auth.ensureAuthorized('editor').pipe( - mergeMap(() => this.api.getEndpoints()), - mergeMap(endpoints => { - const modalRef = this.modal.open(RemoveEndpointFormComponent, { backdrop: 'static' }); - modalRef.componentInstance.endpoints = endpoints - .sort((a, b) => a.name.localeCompare(b.name)) - .map(item => ({ - name: item.name, - url: item.url, - selected: false - } as EndpointSelect)); - return from>(modalRef.result); - }), - mergeMap((endpoints) => from((endpoints ?? []))), - mergeMap((endpoint) => this.api.removeEndpoint(endpoint))) - .subscribe({ error: (error) => this.notify.error(error) }); + this.auth + .ensureAuthorized('editor') + .pipe( + mergeMap(() => this.api.getEndpoints()), + mergeMap(endpoints => { + const modalRef = this.modal.open(RemoveEndpointFormComponent, { backdrop: 'static' }); + modalRef.componentInstance.endpoints = endpoints + .sort((a, b) => a.name.localeCompare(b.name)) + .map( + item => + ({ + name: item.name, + url: item.url, + selected: false, + }) as EndpointSelect, + ); + return from>(modalRef.result); + }), + mergeMap(endpoints => from(endpoints ?? [])), + mergeMap(endpoint => this.api.removeEndpoint(endpoint)), + ) + .subscribe({ error: error => this.notify.error(error) }); } public reset(): void { - this.auth.ensureAuthorized('editor').pipe( - map(() => this.window.confirm(this.translate.instant('CONFIRM_RESET_CONFIGURATION'))), - mergeMap((result) => { - if (!result) return of(void 0); - - return this.api.reset(); - })).subscribe({ error: (error) => this.notify.error(error) }); + this.auth + .ensureAuthorized('editor') + .pipe( + map(() => this.window.confirm(this.translate.instant('CONFIRM_RESET_CONFIGURATION'))), + mergeMap(result => { + if (!result) return of(void 0); + + return this.api.reset(); + }), + ) + .subscribe({ error: error => this.notify.error(error) }); } public canUploadDocument(): boolean { @@ -205,20 +228,24 @@ export class StartComponent implements OnDestroy, AfterViewInit { } public uploadDocument(): void { - this.auth.ensureAuthorized('editor').pipe( - mergeMap(() => this.api.getEndpoints()), - mergeMap(endpoints => { - const modalRef = this.modal.open(UploadFormComponent, { backdrop: 'static' }); - modalRef.componentInstance.endpoints = endpoints.sort((a, b) => a.name.localeCompare(b.name)); - modalRef.componentInstance.endpoint = endpoints[0]; - return from>(modalRef.result); - })).subscribe({ - next: (result) => { + this.auth + .ensureAuthorized('editor') + .pipe( + mergeMap(() => this.api.getEndpoints()), + mergeMap(endpoints => { + const modalRef = this.modal.open(UploadFormComponent, { backdrop: 'static' }); + modalRef.componentInstance.endpoints = endpoints.sort((a, b) => a.name.localeCompare(b.name)); + modalRef.componentInstance.endpoint = endpoints[0]; + return from>(modalRef.result); + }), + ) + .subscribe({ + next: result => { if (result) { this.notify.info('INFO_UPLOAD_AASX_FILE_SUCCESS', result); } }, - error: (error) => this.notify.error(error) + error: error => this.notify.error(error), }); } @@ -228,10 +255,9 @@ export class StartComponent implements OnDestroy, AfterViewInit { public downloadDocument(): void { for (const document of this._selected) { - this.download.downloadDocument( - document.endpoint, - document.id, - document.idShort + '.aasx').subscribe({ error: (error) => this.notify.error(error) }); + this.download + .downloadDocument(document.endpoint, document.id, document.idShort + '.aasx') + .subscribe({ error: error => this.notify.error(error) }); } } @@ -243,13 +269,21 @@ export class StartComponent implements OnDestroy, AfterViewInit { if (this._selected.length === 0) return; if (this._favoritesList === '-') { - this.auth.ensureAuthorized('editor').pipe( - map(() => this.window.confirm(stringFormat( - this.translate.instant('CONFIRM_DELETE_DOCUMENT'), - this._selected.map(item => item.idShort).join(', ')))), - mergeMap((result) => from(result ? this._selected : [])), - mergeMap((document) => this.api.delete(document.id, document.endpoint))) - .subscribe({ error: (error) => this.notify.error(error) }); + this.auth + .ensureAuthorized('editor') + .pipe( + map(() => + this.window.confirm( + stringFormat( + this.translate.instant('CONFIRM_DELETE_DOCUMENT'), + this._selected.map(item => item.idShort).join(', '), + ), + ), + ), + mergeMap(result => from(result ? this._selected : [])), + mergeMap(document => this.api.delete(document.id, document.endpoint)), + ) + .subscribe({ error: error => this.notify.error(error) }); } else { this.favorites.remove(this._selected, this._favoritesList); this.store.dispatch(StartActions.removeFavorites({ favorites: [...this._selected] })); @@ -263,7 +297,7 @@ export class StartComponent implements OnDestroy, AfterViewInit { public viewUserFeedback(): void { const descriptor: SubmodelViewDescriptor = { template: supportedSubmodelTemplates.get(CustomerFeedback), - submodels: [] + submodels: [], }; for (const document of this._selected) { @@ -272,13 +306,13 @@ export class StartComponent implements OnDestroy, AfterViewInit { descriptor.submodels.push({ id: document.id, endpoint: document.endpoint, - idShort: submodels[0].idShort + idShort: submodels[0].idShort, }); } } if (descriptor.submodels.length > 0) { - this.clipboard.set('ViewQuery', { descriptor } as ViewQuery) + this.clipboard.set('ViewQuery', { descriptor } as ViewQuery); this.router.navigateByUrl('/view?format=ViewQuery', { skipLocationChange: true }); } } @@ -290,7 +324,7 @@ export class StartComponent implements OnDestroy, AfterViewInit { public viewNameplate(): void { const descriptor: SubmodelViewDescriptor = { template: supportedSubmodelTemplates.get(ZVEINameplate), - submodels: [] + submodels: [], }; for (const document of this._selected) { @@ -299,13 +333,13 @@ export class StartComponent implements OnDestroy, AfterViewInit { descriptor.submodels.push({ id: document.id, endpoint: document.endpoint, - idShort: submodels[0].idShort + idShort: submodels[0].idShort, }); } } if (descriptor.submodels.length > 0) { - this.clipboard.set('ViewQuery', { descriptor } as ViewQuery) + this.clipboard.set('ViewQuery', { descriptor } as ViewQuery); this.router.navigateByUrl('/view?format=ViewQuery', { skipLocationChange: true }); } } @@ -356,4 +390,4 @@ export class StartComponent implements OnDestroy, AfterViewInit { private selectSubmodels(document: AASDocument, semanticId: string): aas.Submodel[] { return document.content?.submodels.filter(submodel => resolveSemanticId(submodel) === semanticId) ?? []; } -} \ No newline at end of file +} diff --git a/projects/aas-portal/src/app/start/start.effects.ts b/projects/aas-portal/src/app/start/start.effects.ts index 82cb7535..89c1b861 100644 --- a/projects/aas-portal/src/app/start/start.effects.ts +++ b/projects/aas-portal/src/app/start/start.effects.ts @@ -23,7 +23,7 @@ import { StartApiService } from './start-api.service'; export class StartEffects { private readonly store: Store; - constructor( + public constructor( private readonly actions: Actions, store: Store, private readonly translate: TranslateService, @@ -35,114 +35,168 @@ export class StartEffects { public setListView = createEffect(() => { return this.actions.pipe( ofType(StartActions.StartActionType.SET_LIST_VIEW), - exhaustMap(() => concat(of(StartActions.setViewMode({ viewMode: ViewMode.List })), - this.store.select(StartSelectors.selectState).pipe( - first(), - mergeMap(state => { - return this.api.getPage({ - previous: null, - limit: state.limit - }, - state.filter, - this.translate.currentLang); - }), - mergeMap(page => this.setPageAndLoadContents(page)))))); + exhaustMap(() => + concat( + of(StartActions.setViewMode({ viewMode: ViewMode.List })), + this.store.select(StartSelectors.selectState).pipe( + first(), + mergeMap(state => { + return this.api.getPage( + { + previous: null, + limit: state.limit, + }, + state.filter, + this.translate.currentLang, + ); + }), + mergeMap(page => this.setPageAndLoadContents(page)), + ), + ), + ), + ); }); public getFirstPage = createEffect(() => { return this.actions.pipe( ofType(StartActions.StartActionType.GET_FIRST_PAGE), - exhaustMap(action => concat(of(StartActions.setViewMode({ viewMode: ViewMode.List })), - this.store.select(StartSelectors.selectState).pipe( - first(), - mergeMap(state => { - return this.api.getPage({ - previous: null, - limit: action.limit ?? state.limit - }, - action.filter ?? state.filter, - this.translate.currentLang); - }), - mergeMap(page => this.setPageAndLoadContents(page, action.limit, action.filter)))))); + exhaustMap(action => + concat( + of(StartActions.setViewMode({ viewMode: ViewMode.List })), + this.store.select(StartSelectors.selectState).pipe( + first(), + mergeMap(state => { + return this.api.getPage( + { + previous: null, + limit: action.limit ?? state.limit, + }, + action.filter ?? state.filter, + this.translate.currentLang, + ); + }), + mergeMap(page => this.setPageAndLoadContents(page, action.limit, action.filter)), + ), + ), + ), + ); }); public getLastPage = createEffect(() => { return this.actions.pipe( ofType(StartActions.StartActionType.GET_LAST_PAGE), - exhaustMap(() => concat(of(StartActions.setViewMode({ viewMode: ViewMode.List })), - this.store.select(StartSelectors.selectState).pipe( - first(), - mergeMap(state => { - return this.api.getPage({ - next: null, - limit: state.limit - }, - state.filter, - this.translate.currentLang); - }), - mergeMap(page => this.setPageAndLoadContents(page)))))); + exhaustMap(() => + concat( + of(StartActions.setViewMode({ viewMode: ViewMode.List })), + this.store.select(StartSelectors.selectState).pipe( + first(), + mergeMap(state => { + return this.api.getPage( + { + next: null, + limit: state.limit, + }, + state.filter, + this.translate.currentLang, + ); + }), + mergeMap(page => this.setPageAndLoadContents(page)), + ), + ), + ), + ); }); public getNextPage = createEffect(() => { return this.actions.pipe( ofType(StartActions.StartActionType.GET_NEXT_PAGE), - exhaustMap(() => concat(of(StartActions.setViewMode({ viewMode: ViewMode.List })), - this.store.select(StartSelectors.selectState).pipe( - first(), - mergeMap(state => { - if (state.documents.length === 0) return EMPTY; - - return this.api.getPage( - { - next: this.getId(state.documents[state.documents.length - 1]), - limit: state.limit - }, - state.filter, - this.translate.currentLang); - }), - mergeMap(page => this.setPageAndLoadContents(page)))))); + exhaustMap(() => + concat( + of(StartActions.setViewMode({ viewMode: ViewMode.List })), + this.store.select(StartSelectors.selectState).pipe( + first(), + mergeMap(state => { + if (state.documents.length === 0) return EMPTY; + + return this.api.getPage( + { + next: this.getId(state.documents[state.documents.length - 1]), + limit: state.limit, + }, + state.filter, + this.translate.currentLang, + ); + }), + mergeMap(page => this.setPageAndLoadContents(page)), + ), + ), + ), + ); }); public getPreviousPage = createEffect(() => { return this.actions.pipe( ofType(StartActions.StartActionType.GET_PREVIOUS_PAGE), - exhaustMap(() => concat(of(StartActions.setViewMode({ viewMode: ViewMode.List })), - this.store.select(StartSelectors.selectState).pipe( - first(), - mergeMap(state => { - if (state.documents.length === 0) return EMPTY; - - return this.api.getPage( - { - previous: this.getId(state.documents[0]), - limit: state.limit - }, - state.filter, - this.translate.currentLang); - }), - mergeMap(page => this.setPageAndLoadContents(page)))))); + exhaustMap(() => + concat( + of(StartActions.setViewMode({ viewMode: ViewMode.List })), + this.store.select(StartSelectors.selectState).pipe( + first(), + mergeMap(state => { + if (state.documents.length === 0) return EMPTY; + + return this.api.getPage( + { + previous: this.getId(state.documents[0]), + limit: state.limit, + }, + state.filter, + this.translate.currentLang, + ); + }), + mergeMap(page => this.setPageAndLoadContents(page)), + ), + ), + ), + ); }); public setTreeView = createEffect(() => { return this.actions.pipe( ofType(StartActions.StartActionType.SET_TREE_VIEW), - exhaustMap(() => concat( - of(StartActions.setViewMode({ viewMode: ViewMode.Tree })), - this.store.select(StartSelectors.selectDocuments).pipe( - first(), - mergeMap(documents => from(documents).pipe( - mergeMap(document => this.api.getHierarchy(document.endpoint, document.id)), - mergeMap(nodes => this.addTreeAndLoadContents(nodes)))))))); + exhaustMap(() => + concat( + of(StartActions.setViewMode({ viewMode: ViewMode.Tree })), + this.store.select(StartSelectors.selectDocuments).pipe( + first(), + mergeMap(documents => + from(documents).pipe( + mergeMap(document => this.api.getHierarchy(document.endpoint, document.id)), + mergeMap(nodes => this.addTreeAndLoadContents(nodes)), + ), + ), + ), + ), + ), + ); }); public getFavorites = createEffect(() => { return this.actions.pipe( ofType(StartActions.StartActionType.GET_FAVORITES), - exhaustMap(action => concat( - of(StartActions.setFavorites({ name: action.name, documents: action.documents })), - from(action.documents).pipe( - mergeMap(document => this.api.getContent(document.endpoint, document.id).pipe( - map(content => StartActions.setContent({ document, content })))))))); + exhaustMap(action => + concat( + of(StartActions.setFavorites({ name: action.name, documents: action.documents })), + from(action.documents).pipe( + mergeMap(document => + this.api + .getContent(document.endpoint, document.id) + .pipe(map(content => StartActions.setContent({ document, content }))), + ), + ), + ), + ), + ); }); private getId(document: AASDocument): AASDocumentId { @@ -153,17 +207,25 @@ export class StartEffects { return concat( of(StartActions.setPage({ page, limit, filter })), from(page.documents).pipe( - mergeMap(document => this.api.getContent(document.endpoint, document.id).pipe( - map(content => StartActions.setContent({ document, content })) - )))); + mergeMap(document => + this.api + .getContent(document.endpoint, document.id) + .pipe(map(content => StartActions.setContent({ document, content }))), + ), + ), + ); } private addTreeAndLoadContents(documents: AASDocument[]): Observable { return concat( of(StartActions.addTree({ documents })), from(documents).pipe( - mergeMap(document => this.api.getContent(document.endpoint, document.id).pipe( - map(content => StartActions.setContent({ document, content })) - )))); + mergeMap(document => + this.api + .getContent(document.endpoint, document.id) + .pipe(map(content => StartActions.setContent({ document, content }))), + ), + ), + ); } } diff --git a/projects/aas-portal/src/app/start/start.reducer.ts b/projects/aas-portal/src/app/start/start.reducer.ts index 862666a3..c8a985c6 100644 --- a/projects/aas-portal/src/app/start/start.reducer.ts +++ b/projects/aas-portal/src/app/start/start.reducer.ts @@ -25,31 +25,13 @@ const initialState: StartState = { export const startReducer = createReducer( initialState, - on( - StartActions.setViewMode, - (state, { viewMode }) => setViewMode(state, viewMode) - ), - on( - StartActions.addTree, - (state, { documents }) => addTree(state, documents) - ), - on( - StartActions.setPage, - (state, { page, limit, filter }) => setPage(state, page, limit, filter) - ), - on( - StartActions.setContent, - (state, { document, content }) => setContent(state, document, content) - ), - on( - StartActions.setFavorites, - (state, { name, documents }) => setFavorites(state, name, documents) - ), - on( - StartActions.removeFavorites, - (state, { favorites }) => removeFavorites(state, favorites) - ), -) + on(StartActions.setViewMode, (state, { viewMode }) => setViewMode(state, viewMode)), + on(StartActions.addTree, (state, { documents }) => addTree(state, documents)), + on(StartActions.setPage, (state, { page, limit, filter }) => setPage(state, page, limit, filter)), + on(StartActions.setContent, (state, { document, content }) => setContent(state, document, content)), + on(StartActions.setFavorites, (state, { name, documents }) => setFavorites(state, name, documents)), + on(StartActions.removeFavorites, (state, { favorites }) => removeFavorites(state, favorites)), +); function setViewMode(state: StartState, viewMode: ViewMode): StartState { return { ...state, documents: [], viewMode }; @@ -80,7 +62,7 @@ function setContent(state: StartState, document: AASDocument, content: aas.Envir const documents = [...state.documents]; const index = documents.findIndex(item => item.endpoint === document.endpoint && item.id === document.id); if (index >= 0) { - documents[index] = { ...document, content } + documents[index] = { ...document, content }; } return { ...state, documents }; @@ -91,9 +73,9 @@ function removeFavorites(state: StartState, favorites: AASDocument[]): StartStat return state; } - const documents = state.documents.filter( - document => favorites.every(favorite => document.endpoint !== favorite.endpoint || - document.id !== favorite.id)); + const documents = state.documents.filter(document => + favorites.every(favorite => document.endpoint !== favorite.endpoint || document.id !== favorite.id), + ); return { ...state, documents }; } diff --git a/projects/aas-portal/src/app/start/start.selectors.ts b/projects/aas-portal/src/app/start/start.selectors.ts index 23fc608f..e87c044f 100644 --- a/projects/aas-portal/src/app/start/start.selectors.ts +++ b/projects/aas-portal/src/app/start/start.selectors.ts @@ -7,7 +7,7 @@ *****************************************************************************/ import { createSelector } from '@ngrx/store'; -import { StartFeatureState } from './start.state' +import { StartFeatureState } from './start.state'; import { ViewMode } from 'projects/aas-lib/src/public-api'; const getState = (state: StartFeatureState) => state.start; @@ -26,16 +26,12 @@ export const selectIsViewModeList = createSelector(getViewMode, viewMode => view export const selectIsViewModeTree = createSelector(getViewMode, viewMode => viewMode === ViewMode.Tree); -export const selectLimit = createSelector(getLimit, limit => limit); +export const selectLimit = createSelector(getLimit, limit => limit); export const selectDocuments = createSelector(getDocuments, documents => documents); -export const selectIsFirstPage = createSelector( - getState, - state => state.isFirstPage); +export const selectIsFirstPage = createSelector(getState, state => state.isFirstPage); -export const selectIsLastPage = createSelector( - getState, - state => state.isLastPage); +export const selectIsLastPage = createSelector(getState, state => state.isLastPage); export const selectFavorites = createSelector(getState, state => state.favorites); diff --git a/projects/aas-portal/src/app/start/start.state.ts b/projects/aas-portal/src/app/start/start.state.ts index f8f7353a..1f8aadf9 100644 --- a/projects/aas-portal/src/app/start/start.state.ts +++ b/projects/aas-portal/src/app/start/start.state.ts @@ -27,4 +27,4 @@ export interface FavoritesList { export interface StartFeatureState { start: StartState; -} \ No newline at end of file +} diff --git a/projects/aas-portal/src/app/start/upload-form/upload-form.component.html b/projects/aas-portal/src/app/start/upload-form/upload-form.component.html index b428b418..edeb3e21 100644 --- a/projects/aas-portal/src/app/start/upload-form/upload-form.component.html +++ b/projects/aas-portal/src/app/start/upload-form/upload-form.component.html @@ -12,7 +12,7 @@

CAPTION_UPLOAD_FILE

- +
diff --git a/projects/aas-portal/src/app/start/upload-form/upload-form.component.ts b/projects/aas-portal/src/app/start/upload-form/upload-form.component.ts index 374801f4..5755b1e4 100644 --- a/projects/aas-portal/src/app/start/upload-form/upload-form.component.ts +++ b/projects/aas-portal/src/app/start/upload-form/upload-form.component.ts @@ -15,14 +15,15 @@ import { AASEndpoint } from 'common'; @Component({ selector: 'fhg-upload-form', templateUrl: './upload-form.component.html', - styleUrls: ['./upload-form.component.scss'] + styleUrls: ['./upload-form.component.scss'], }) export class UploadFormComponent { private uploading = false; - constructor( + public constructor( private readonly modal: NgbActiveModal, - private readonly download: DownloadService) { } + private readonly download: DownloadService, + ) {} @ViewChild('fileInput') public fileInput: ElementRef | null = null; @@ -36,33 +37,34 @@ export class UploadFormComponent { public progress = 0; public canSubmit(): boolean { - return this.fileInput?.nativeElement?.files != null && + return ( + this.fileInput?.nativeElement?.files != null && this.fileInput.nativeElement.files.length > 0 && - this.endpoint != null; + this.endpoint != null + ); } public submit(): void { if (!this.uploading && this.endpoint?.url) { this.uploading = true; const file = this.fileInput!.nativeElement!.files![0]; - this.download.uploadDocuments(this.endpoint.name, [file]) - .subscribe({ - next: (event: HttpEvent) => { - switch (event.type) { - case HttpEventType.Sent: - break; - case HttpEventType.ResponseHeader: - break; - case HttpEventType.UploadProgress: - this.progress = Math.round(event.loaded / event.total! * 100); - break; - case HttpEventType.Response: - break; - } - }, - complete: () => this.modal.close(file.name), - error: (error) => this.modal.dismiss(error) - }); + this.download.uploadDocuments(this.endpoint.name, [file]).subscribe({ + next: (event: HttpEvent) => { + switch (event.type) { + case HttpEventType.Sent: + break; + case HttpEventType.ResponseHeader: + break; + case HttpEventType.UploadProgress: + this.progress = Math.round((event.loaded / event.total!) * 100); + break; + case HttpEventType.Response: + break; + } + }, + complete: () => this.modal.close(file.name), + error: error => this.modal.dismiss(error), + }); } } @@ -71,4 +73,4 @@ export class UploadFormComponent { this.modal.close(); } } -} \ No newline at end of file +} diff --git a/projects/aas-portal/src/app/toolbar.service.ts b/projects/aas-portal/src/app/toolbar.service.ts index 96b08ff9..77a59a84 100644 --- a/projects/aas-portal/src/app/toolbar.service.ts +++ b/projects/aas-portal/src/app/toolbar.service.ts @@ -10,12 +10,12 @@ import { Injectable, TemplateRef } from '@angular/core'; import { BehaviorSubject, Observable } from 'rxjs'; @Injectable({ - providedIn: 'root' + providedIn: 'root', }) export class ToolbarService { private readonly toolbarTemplate$ = new BehaviorSubject | null>(null); - constructor() { + public constructor() { this.toolbarTemplate = this.toolbarTemplate$.asObservable(); } @@ -28,4 +28,4 @@ export class ToolbarService { public clear(): void { Promise.resolve().then(() => this.toolbarTemplate$.next(null)); } -} \ No newline at end of file +} diff --git a/projects/aas-portal/src/app/types/action-base.ts b/projects/aas-portal/src/app/types/action-base.ts deleted file mode 100644 index 3166213b..00000000 --- a/projects/aas-portal/src/app/types/action-base.ts +++ /dev/null @@ -1,21 +0,0 @@ -/****************************************************************************** - * - * Copyright (c) 2019-2023 Fraunhofer IOSB-INA Lemgo, - * eine rechtlich nicht selbstaendige Einrichtung der Fraunhofer-Gesellschaft - * zur Foerderung der angewandten Forschung e.V. - * - *****************************************************************************/ - -import { Action } from "@ngrx/store"; - -export abstract class ActionBase implements Action { - constructor(type: string) { - this.type = type; - } - - /** The action type. */ - public readonly type: string; - - /** The error when the action fails. */ - public error: any = null; -} \ No newline at end of file diff --git a/projects/aas-portal/src/app/types/command.ts b/projects/aas-portal/src/app/types/command.ts index 11fa45d1..55b14d39 100644 --- a/projects/aas-portal/src/app/types/command.ts +++ b/projects/aas-portal/src/app/types/command.ts @@ -6,12 +6,12 @@ * *****************************************************************************/ -import { aas, isIdentifiable } from "common"; +import { aas, isIdentifiable } from 'common'; enum CommandState { Idle, Executed, - Aborted + Aborted, } /** Abstract base implementation of a command. */ @@ -21,12 +21,11 @@ export abstract class Command { /** * @param name The command name. */ - constructor(public readonly name: string) { - } + protected constructor(public readonly name: string) {} public execute(): void { if (this.state !== CommandState.Idle) { - throw new Error("Invalid command state."); + throw new Error('Invalid command state.'); } this.onExecute(); @@ -35,7 +34,7 @@ export abstract class Command { public undo(): void { if (this.state !== CommandState.Executed) { - throw new Error("Invalid command state."); + throw new Error('Invalid command state.'); } this.onUndo(); @@ -43,7 +42,7 @@ export abstract class Command { public redo(): void { if (this.state !== CommandState.Executed) { - throw new Error("Invalid command state."); + throw new Error('Invalid command state.'); } this.onRedo(); @@ -51,7 +50,7 @@ export abstract class Command { public abort() { if (this.state !== CommandState.Idle) { - throw new Error("Invalid command state."); + throw new Error('Invalid command state.'); } this.onAbort(); @@ -70,10 +69,12 @@ export abstract class Command { if (isIdentifiable(referable)) { reference = { type: 'ModelReference', - keys: [{ - value: referable.id, - type: referable.modelType as aas.KeyTypes, - }] + keys: [ + { + value: referable.id, + type: referable.modelType as aas.KeyTypes, + }, + ], }; } else if (referable.parent) { reference = { @@ -83,7 +84,8 @@ export abstract class Command { { type: referable.modelType as aas.KeyTypes, value: referable.idShort, - }] + }, + ], }; } @@ -93,4 +95,4 @@ export abstract class Command { return reference; } -} \ No newline at end of file +} diff --git a/projects/aas-portal/src/app/types/dashboard-query-params.ts b/projects/aas-portal/src/app/types/dashboard-query-params.ts index 435c22c0..c4a08c17 100644 --- a/projects/aas-portal/src/app/types/dashboard-query-params.ts +++ b/projects/aas-portal/src/app/types/dashboard-query-params.ts @@ -7,9 +7,9 @@ *****************************************************************************/ export interface DashboardQueryParams { - format: string, + format: string; } export interface DashboardQuery { page: string; -} \ No newline at end of file +} diff --git a/projects/aas-portal/src/app/types/doc-ref.ts b/projects/aas-portal/src/app/types/doc-ref.ts index 04229a03..215e67d2 100644 --- a/projects/aas-portal/src/app/types/doc-ref.ts +++ b/projects/aas-portal/src/app/types/doc-ref.ts @@ -11,4 +11,4 @@ export interface DocRef { id: string; /** The URL of the container that contains the AAS document. */ url: string; -} \ No newline at end of file +} diff --git a/projects/aas-portal/src/app/types/errors.ts b/projects/aas-portal/src/app/types/errors.ts index 21d2b06c..367127ef 100644 --- a/projects/aas-portal/src/app/types/errors.ts +++ b/projects/aas-portal/src/app/types/errors.ts @@ -17,4 +17,4 @@ export const ERRORS = { PASSWORDS_NOT_EQUAL: 'ERROR_PASSWORDS_NOT_EQUAL', DASHBOARD_PAGE_ALREADY_EXISTS: 'ERROR_DASHBOARD_PAGE_ALREADY_EXISTS', UNAUTHORIZED_ACCESS: 'ERROR_UNAUTHORIZED_ACCESS', -} \ No newline at end of file +}; diff --git a/projects/aas-portal/src/app/types/info.ts b/projects/aas-portal/src/app/types/info.ts index e0a980b0..ce0ebd38 100644 --- a/projects/aas-portal/src/app/types/info.ts +++ b/projects/aas-portal/src/app/types/info.ts @@ -7,5 +7,5 @@ *****************************************************************************/ export const INFO = { - NEW_PASSWORD_SENT: 'INFO_NEW_PASSWORD_SENT' -}; \ No newline at end of file + NEW_PASSWORD_SENT: 'INFO_NEW_PASSWORD_SENT', +}; diff --git a/projects/aas-portal/src/app/types/intl.d.ts b/projects/aas-portal/src/app/types/intl.d.ts index 00269ea4..3b855539 100644 --- a/projects/aas-portal/src/app/types/intl.d.ts +++ b/projects/aas-portal/src/app/types/intl.d.ts @@ -8,4 +8,4 @@ declare namespace Intl { function getCanonicalLocales(locales: string | string[]): string[]; -} \ No newline at end of file +} diff --git a/projects/aas-portal/src/app/types/selection-mode.ts b/projects/aas-portal/src/app/types/selection-mode.ts index 7f24c692..fd182223 100644 --- a/projects/aas-portal/src/app/types/selection-mode.ts +++ b/projects/aas-portal/src/app/types/selection-mode.ts @@ -8,5 +8,5 @@ export enum SelectionMode { Single = 'Single', - Multiple = 'Multiple' -} \ No newline at end of file + Multiple = 'Multiple', +} diff --git a/projects/aas-portal/src/app/view/view-api.service.ts b/projects/aas-portal/src/app/view/view-api.service.ts index 351e52ff..7f3d47f9 100644 --- a/projects/aas-portal/src/app/view/view-api.service.ts +++ b/projects/aas-portal/src/app/view/view-api.service.ts @@ -7,19 +7,17 @@ *****************************************************************************/ import { Injectable } from '@angular/core'; -import { HttpClient, } from '@angular/common/http'; +import { HttpClient } from '@angular/common/http'; import { AASDocument } from 'common'; import { Observable } from 'rxjs'; import { encodeBase64Url } from 'projects/aas-lib/src/public-api'; /** The client side AAS provider service. */ @Injectable({ - providedIn: 'root' + providedIn: 'root', }) export class ViewApiService { - constructor( - private readonly http: HttpClient, - ) {} + public constructor(private readonly http: HttpClient) {} /** * Gets the referenced AAS document. @@ -29,6 +27,7 @@ export class ViewApiService { */ public getDocument(endpoint: string, id: string): Observable { return this.http.get( - `/api/v1/containers/${encodeBase64Url(endpoint)}/documents/${encodeBase64Url(id)}`); + `/api/v1/containers/${encodeBase64Url(endpoint)}/documents/${encodeBase64Url(id)}`, + ); } -} \ No newline at end of file +} diff --git a/projects/aas-portal/src/app/view/view.actions.ts b/projects/aas-portal/src/app/view/view.actions.ts index 4bf4adcf..54521835 100644 --- a/projects/aas-portal/src/app/view/view.actions.ts +++ b/projects/aas-portal/src/app/view/view.actions.ts @@ -6,23 +6,22 @@ * *****************************************************************************/ -import { createAction, props } from "@ngrx/store"; +import { createAction, props } from '@ngrx/store'; import { TypedAction } from '@ngrx/store/src/models'; -import { DocumentSubmodelPair, SubmodelViewDescriptor } from 'projects/aas-lib/src/public-api' +import { DocumentSubmodelPair, SubmodelViewDescriptor } from 'projects/aas-lib/src/public-api'; export enum ViewActionType { SET_SUBMODELS = '[Submodel] set submodels', - INIT_VIEW = '[Submodel] init view' + INIT_VIEW = '[Submodel] init view', } -export const setSubmodels = createAction( - ViewActionType.SET_SUBMODELS, - props<{ descriptor: SubmodelViewDescriptor }>()); +export const setSubmodels = createAction(ViewActionType.SET_SUBMODELS, props<{ descriptor: SubmodelViewDescriptor }>()); export const initView = createAction( ViewActionType.INIT_VIEW, - props<{ submodels: DocumentSubmodelPair[]; template?: string }>()); + props<{ submodels: DocumentSubmodelPair[]; template?: string }>(), +); export interface SetSubmodelsAction extends TypedAction { descriptor: SubmodelViewDescriptor; -} \ No newline at end of file +} diff --git a/projects/aas-portal/src/app/view/view.component.ts b/projects/aas-portal/src/app/view/view.component.ts index 506a01f2..7e16e001 100644 --- a/projects/aas-portal/src/app/view/view.component.ts +++ b/projects/aas-portal/src/app/view/view.component.ts @@ -21,29 +21,37 @@ import { ViewApiService } from './view-api.service'; @Component({ selector: 'fhg-view', templateUrl: './view.component.html', - styleUrls: ['./view.component.scss'] + styleUrls: ['./view.component.scss'], }) export class ViewComponent implements OnInit, AfterViewInit, OnDestroy { private readonly store: Store; private readonly subscription = new Subscription(); - constructor( + public constructor( store: Store, private readonly route: ActivatedRoute, private readonly api: ViewApiService, private readonly clipboard: lib.ClipboardService, - private readonly toolbar: ToolbarService + private readonly toolbar: ToolbarService, ) { this.store = store as Store; - this.subscription.add(this.store.select(ViewSelectors.selectSubmodels) - .pipe().subscribe(submodels => { - this.submodels = submodels; - })); + this.subscription.add( + this.store + .select(ViewSelectors.selectSubmodels) + .pipe() + .subscribe(submodels => { + this.submodels = submodels; + }), + ); - this.subscription.add(this.store.select(ViewSelectors.selectTemplate) - .pipe().subscribe(template => { - this.template = template; - })); + this.subscription.add( + this.store + .select(ViewSelectors.selectTemplate) + .pipe() + .subscribe(template => { + this.template = template; + }), + ); } @ViewChild('viewToolbar', { read: TemplateRef }) @@ -62,19 +70,23 @@ export class ViewComponent implements OnInit, AfterViewInit, OnDestroy { if (query?.descriptor) { const descriptor: lib.SubmodelViewDescriptor = query.descriptor; - zip(of(descriptor.template), from(descriptor.submodels).pipe( - mergeMap(item => zip(this.api.getDocument(item.endpoint, item.id), of(item.idShort))), - mergeMap(tuple => { - const submodel = tuple[0].content?.submodels.find(item => item.idShort === tuple[1]); - if (submodel?.modelType === 'Submodel') { - return of({ document: tuple[0], submodel } as lib.DocumentSubmodelPair); - } + zip( + of(descriptor.template), + from(descriptor.submodels).pipe( + mergeMap(item => zip(this.api.getDocument(item.endpoint, item.id), of(item.idShort))), + mergeMap(tuple => { + const submodel = tuple[0].content?.submodels.find(item => item.idShort === tuple[1]); + if (submodel?.modelType === 'Submodel') { + return of({ document: tuple[0], submodel } as lib.DocumentSubmodelPair); + } - return EMPTY; - }), - toArray() - )).subscribe(tuple => this.store.dispatch( - ViewActions.initView({ submodels: tuple[1], template: tuple[0] }))); + return EMPTY; + }), + toArray(), + ), + ).subscribe(tuple => + this.store.dispatch(ViewActions.initView({ submodels: tuple[1], template: tuple[0] })), + ); } } @@ -88,4 +100,4 @@ export class ViewComponent implements OnInit, AfterViewInit, OnDestroy { this.subscription.unsubscribe(); this.toolbar.clear(); } -} \ No newline at end of file +} diff --git a/projects/aas-portal/src/app/view/view.effects.ts b/projects/aas-portal/src/app/view/view.effects.ts index be04fb70..9f6cd3ab 100644 --- a/projects/aas-portal/src/app/view/view.effects.ts +++ b/projects/aas-portal/src/app/view/view.effects.ts @@ -16,25 +16,29 @@ import { ViewApiService } from './view-api.service'; /** Currently not used. Does not work with ProjectService */ @Injectable() export class ViewEffects { - constructor( + public constructor( private readonly actions: Actions, - private readonly api: ViewApiService - ) { } + private readonly api: ViewApiService, + ) {} public setSubmodels = createEffect(() => { return this.actions.pipe( ofType(ViewActions.ViewActionType.SET_SUBMODELS), - exhaustMap(action => from(action.descriptor.submodels).pipe( - mergeMap(item => zip(this.api.getDocument(item.endpoint, item.id), of(item.idShort))), - mergeMap(tuple => { - const submodel = tuple[0].content?.submodels.find(item => item.idShort === tuple[1]); - if (submodel?.modelType === 'Submodel') { - return of({ document: tuple[0], submodel } as DocumentSubmodelPair); - } + exhaustMap(action => + from(action.descriptor.submodels).pipe( + mergeMap(item => zip(this.api.getDocument(item.endpoint, item.id), of(item.idShort))), + mergeMap(tuple => { + const submodel = tuple[0].content?.submodels.find(item => item.idShort === tuple[1]); + if (submodel?.modelType === 'Submodel') { + return of({ document: tuple[0], submodel } as DocumentSubmodelPair); + } - return EMPTY; - }), - toArray(), - map(submodels => ViewActions.initView({ submodels }))))); + return EMPTY; + }), + toArray(), + map(submodels => ViewActions.initView({ submodels })), + ), + ), + ); }); -} \ No newline at end of file +} diff --git a/projects/aas-portal/src/app/view/view.reducer.ts b/projects/aas-portal/src/app/view/view.reducer.ts index e0e657db..a15a9701 100644 --- a/projects/aas-portal/src/app/view/view.reducer.ts +++ b/projects/aas-portal/src/app/view/view.reducer.ts @@ -6,21 +6,18 @@ * *****************************************************************************/ -import { createReducer, on } from "@ngrx/store"; +import { createReducer, on } from '@ngrx/store'; import { DocumentSubmodelPair } from 'projects/aas-lib/src/public-api'; -import * as ViewActions from "./view.actions"; -import { ViewState } from "./view.state"; +import * as ViewActions from './view.actions'; +import { ViewState } from './view.state'; const initialState: ViewState = { - submodels: [] + submodels: [], }; export const viewReducer = createReducer( initialState, - on( - ViewActions.initView, - (state, { submodels, template }) => initView(state, submodels, template) - ) + on(ViewActions.initView, (state, { submodels, template }) => initView(state, submodels, template)), ); function initView(state: ViewState, submodels: DocumentSubmodelPair[], template: string | undefined): ViewState { diff --git a/projects/aas-portal/src/app/view/view.selectors.ts b/projects/aas-portal/src/app/view/view.selectors.ts index 30a1eac4..fe9b0f56 100644 --- a/projects/aas-portal/src/app/view/view.selectors.ts +++ b/projects/aas-portal/src/app/view/view.selectors.ts @@ -14,4 +14,4 @@ const getTemplate = (state: State) => state.view.template; export const selectSubmodels = createSelector(getSubmodels, submodels => submodels); -export const selectTemplate = createSelector(getTemplate, template => template); \ No newline at end of file +export const selectTemplate = createSelector(getTemplate, template => template); diff --git a/projects/aas-portal/src/test/aas/command-handler.service.spec.ts b/projects/aas-portal/src/test/aas/command-handler.service.spec.ts index 643a146a..5051b410 100644 --- a/projects/aas-portal/src/test/aas/command-handler.service.spec.ts +++ b/projects/aas-portal/src/test/aas/command-handler.service.spec.ts @@ -13,7 +13,7 @@ import { NotifyService } from 'projects/aas-lib/src/public-api'; import { CommandHandlerService } from '../../app/aas/command-handler.service'; class TestCommand extends Command { - constructor(private spy?: jasmine.Spy, private undoSpy?: jasmine.Spy, private redoSpy?: jasmine.Spy) { + public constructor(private spy?: jasmine.Spy, private undoSpy?: jasmine.Spy, private redoSpy?: jasmine.Spy) { super("TestCommand"); } @@ -41,7 +41,7 @@ class TestCommand extends Command { } class FailCommand extends Command { - constructor(private abortSpy: jasmine.Spy) { + public constructor(private abortSpy: jasmine.Spy) { super("TestCommand"); } diff --git a/projects/aas-portal/src/test/assets/test-web-socket-factory.service.ts b/projects/aas-portal/src/test/assets/test-web-socket-factory.service.ts index 6bb6b9fe..4af3017f 100644 --- a/projects/aas-portal/src/test/assets/test-web-socket-factory.service.ts +++ b/projects/aas-portal/src/test/assets/test-web-socket-factory.service.ts @@ -12,7 +12,7 @@ import { Subject } from 'rxjs'; import { WebSocketSubject } from 'rxjs/webSocket'; export class TestWebSocketFactoryService implements Partial { - constructor(private readonly subject: Subject) {} + public constructor(private readonly subject: Subject) {} public create(): WebSocketSubject { return this.subject as WebSocketSubject; diff --git a/projects/aas-server/.eslintrc b/projects/aas-server/.eslintrc index c939dc42..b6e2302c 100644 --- a/projects/aas-server/.eslintrc +++ b/projects/aas-server/.eslintrc @@ -1,7 +1,3 @@ { - "root": true, - "parser": "@typescript-eslint/parser", - "extends": ["plugin:@typescript-eslint/recommended"], - "parserOptions": { "ecmaVersion": 2018, "sourceType": "module" }, - "rules": {} - } \ No newline at end of file + "extends": "../../.eslintrc.json" +} \ No newline at end of file diff --git a/projects/aas-server/src/app/aas-index/aas-index-factory.ts b/projects/aas-server/src/app/aas-index/aas-index-factory.ts index 0986bc06..dde3524f 100644 --- a/projects/aas-server/src/app/aas-index/aas-index-factory.ts +++ b/projects/aas-server/src/app/aas-index/aas-index-factory.ts @@ -8,7 +8,7 @@ import { DependencyContainer } from 'tsyringe'; import path from 'path'; -import { JSONFile } from 'lowdb/node' +import { JSONFile } from 'lowdb/node'; import { Low } from 'lowdb'; import { AASIndex } from './aas-index.js'; import { LowDbIndex } from './lowdb/lowdb-index.js'; @@ -17,9 +17,7 @@ import { LowDbData } from './lowdb/lowdb-types.js'; import { MySqlIndex } from './mysql/mysql-index.js'; export class AASIndexFactory { - constructor( - private readonly container: DependencyContainer - ) { } + public constructor(private readonly container: DependencyContainer) {} public create(): AASIndex { const variable = this.container.resolve(Variable); @@ -36,4 +34,4 @@ export class AASIndexFactory { const db = new Low(new JSONFile(dbFile), { documents: [], endpoints: [], elements: [] }); return new LowDbIndex(db, variable); } -} \ No newline at end of file +} diff --git a/projects/aas-server/src/app/aas-index/aas-index-query.ts b/projects/aas-server/src/app/aas-index/aas-index-query.ts index 2f324345..47997958 100644 --- a/projects/aas-server/src/app/aas-index/aas-index-query.ts +++ b/projects/aas-server/src/app/aas-index/aas-index-query.ts @@ -9,7 +9,10 @@ import { AASQuery, OrExpression, QueryParser } from 'common'; export abstract class AASIndexQuery { - protected constructor(expression: string, protected readonly language: string) { + protected constructor( + expression: string, + protected readonly language: string, + ) { this.queryParser = new QueryParser(expression, language); } @@ -26,4 +29,4 @@ export abstract class AASIndexQuery { protected isExpression(value: unknown): value is OrExpression[] { return Array.isArray(value); } -} \ No newline at end of file +} diff --git a/projects/aas-server/src/app/aas-index/aas-index.ts b/projects/aas-server/src/app/aas-index/aas-index.ts index e69805ea..1b67c5ee 100644 --- a/projects/aas-server/src/app/aas-index/aas-index.ts +++ b/projects/aas-server/src/app/aas-index/aas-index.ts @@ -17,7 +17,7 @@ import { isProperty, parseDate, parseNumber, - toBoolean + toBoolean, } from 'common'; export abstract class AASIndex { @@ -58,15 +58,14 @@ export abstract class AASIndex { protected toStringValue(referable: aas.Referable): string | undefined { switch (referable.modelType) { - case 'Property': - { - const property = referable as aas.Property; - if (baseType(property.valueType) === 'string') { - return property.value; - } - - return undefined; + case 'Property': { + const property = referable as aas.Property; + if (baseType(property.valueType) === 'string') { + return property.value; } + + return undefined; + } case 'MultiLanguageProperty': return (referable as aas.MultiLanguageProperty).value?.map(item => item.text).join(' '); case 'File': @@ -111,4 +110,4 @@ export abstract class AASIndex { return undefined; } -} \ No newline at end of file +} diff --git a/projects/aas-server/src/app/aas-index/lowdb/lowdb-index.ts b/projects/aas-server/src/app/aas-index/lowdb/lowdb-index.ts index 757c86bb..0bad2b59 100644 --- a/projects/aas-server/src/app/aas-index/lowdb/lowdb-index.ts +++ b/projects/aas-server/src/app/aas-index/lowdb/lowdb-index.ts @@ -8,7 +8,17 @@ import { Low } from 'lowdb'; import { v4 } from 'uuid'; -import { AASCursor, AASDocument, AASDocumentId, AASEndpoint, AASPage, ApplicationError, BaseValueType, aas, flat } from 'common'; +import { + AASCursor, + AASDocument, + AASDocumentId, + AASEndpoint, + AASPage, + ApplicationError, + BaseValueType, + aas, + flat, +} from 'common'; import { AASIndex } from '../aas-index.js'; import { LowDbQuery } from './lowdb-query.js'; import { Variable } from '../../variable.js'; @@ -19,7 +29,10 @@ import { LowDbData, LowDbDocument, LowDbElement } from './lowdb-types.js'; export class LowDbIndex extends AASIndex { private readonly promise: Promise; - public constructor(private readonly db: Low, private readonly variable: Variable) { + public constructor( + private readonly db: Low, + private readonly variable: Variable, + ) { super(); this.promise = this.initialize(); @@ -46,7 +59,8 @@ export class LowDbIndex extends AASIndex { throw new ApplicationError( `An endpoint with the name "${name}" already exists.`, ERRORS.RegistryAlreadyExists, - endpoint.name); + endpoint.name, + ); } this.db.data.endpoints.push(endpoint); @@ -158,8 +172,7 @@ export class LowDbIndex extends AASIndex { public async reset(): Promise { this.db.data.documents = []; - this.db.data.endpoints = - this.variable.ENDPOINTS.map(endpoint => urlToEndpoint(endpoint)); + this.db.data.endpoints = this.variable.ENDPOINTS.map(endpoint => urlToEndpoint(endpoint)); await this.db.write(); } @@ -203,7 +216,13 @@ export class LowDbIndex extends AASIndex { const elements = this.db.data.elements; for (const document of this.db.data.documents) { const uuid = document.uuid; - if (!filter || filter.do(document, elements.filter(element => element.uuid === uuid))) { + if ( + !filter || + filter.do( + document, + elements.filter(element => element.uuid === uuid), + ) + ) { documents.push(this.toDocument(document)); if (documents.length >= n) { break; @@ -235,7 +254,13 @@ export class LowDbIndex extends AASIndex { for (let m = items.length; i < m; i++) { const document = items[i]; const uuid = document.uuid; - if (!filter || filter.do(document, elements.filter(element => element.uuid === uuid))) { + if ( + !filter || + filter.do( + document, + elements.filter(element => element.uuid === uuid), + ) + ) { documents.push(this.toDocument(document)); if (documents.length >= n) { break; @@ -256,7 +281,7 @@ export class LowDbIndex extends AASIndex { return { previous: null, documents, next: null }; } - const n = limit + 1 + const n = limit + 1; const items = this.db.data.documents; let i = this.findIndexReverse(current); if (i < 0) { @@ -267,7 +292,13 @@ export class LowDbIndex extends AASIndex { for (; i >= 0; --i) { const document = items[i]; const uuid = document.uuid; - if (!filter || filter.do(document, elements.filter(element => element.uuid === uuid))) { + if ( + !filter || + filter.do( + document, + elements.filter(element => element.uuid === uuid), + ) + ) { documents.push(this.toDocument(document)); if (documents.length >= n) { break; @@ -288,13 +319,19 @@ export class LowDbIndex extends AASIndex { return { previous: null, documents, next: null }; } - const n = limit + 1 + const n = limit + 1; const items = this.db.data.documents; const elements = this.db.data.elements; for (let i = items.length - 1; i >= 0; --i) { const document = items[i]; const uuid = document.uuid; - if (!filter || filter.do(document, elements.filter(element => element.uuid === uuid))) { + if ( + !filter || + filter.do( + document, + elements.filter(element => element.uuid === uuid), + ) + ) { documents.push(this.toDocument(document)); if (documents.length >= n) { break; @@ -345,7 +382,7 @@ export class LowDbIndex extends AASIndex { const element: LowDbElement = { uuid: uuid, modelType: this.toAbbreviation(referable), - idShort: referable.idShort + idShort: referable.idShort, }; let value: BaseValueType | undefined = this.toStringValue(referable); @@ -390,4 +427,4 @@ export class LowDbIndex extends AASIndex { this.db.data.elements.push(element); } -} \ No newline at end of file +} diff --git a/projects/aas-server/src/app/aas-index/lowdb/lowdb-query.ts b/projects/aas-server/src/app/aas-index/lowdb/lowdb-query.ts index 55cc8b7f..04a9385c 100644 --- a/projects/aas-server/src/app/aas-index/lowdb/lowdb-query.ts +++ b/projects/aas-server/src/app/aas-index/lowdb/lowdb-query.ts @@ -13,7 +13,6 @@ import { LowDbDocument, LowDbElement, LowDbElementValueType } from './lowdb-type import { AASIndexQuery } from '../aas-index-query.js'; export class LowDbQuery extends AASIndexQuery { - public constructor(expression: string, language: string) { super(expression, language); } @@ -53,9 +52,11 @@ export class LowDbQuery extends AASIndexQuery { private contains(document: AASDocument, value: string): boolean { value = value.toLocaleLowerCase(this.language); - return document.idShort.toLocaleLowerCase(this.language).indexOf(value) >= 0 || + return ( + document.idShort.toLocaleLowerCase(this.language).indexOf(value) >= 0 || document.id.toLocaleLowerCase(this.language).indexOf(value) >= 0 || - document.endpoint.toLocaleLowerCase(this.language).indexOf(value) >= 0; + document.endpoint.toLocaleLowerCase(this.language).indexOf(value) >= 0 + ); } private match(elements: LowDbElement[], query: AASQuery | undefined): boolean { @@ -147,7 +148,7 @@ export class LowDbQuery extends AASIndexQuery { return Math.abs(a - b) <= 0.000001; } } else if (Array.isArray(b)) { - return (b.length === 2 && typeof b[0] === 'number' && typeof b[1] === 'number') + return b.length === 2 && typeof b[0] === 'number' && typeof b[1] === 'number' ? a >= b[0] && a <= b[1] : false; } @@ -172,7 +173,7 @@ export class LowDbQuery extends AASIndexQuery { return a === b; } } else if (Array.isArray(b)) { - return (b.length === 2 && typeof b[0] === 'bigint' && typeof b[1] === 'bigint') + return b.length === 2 && typeof b[0] === 'bigint' && typeof b[1] === 'bigint' ? a >= b[0] && a <= b[1] : false; } @@ -197,7 +198,7 @@ export class LowDbQuery extends AASIndexQuery { return a.getTime() === b.getTime(); } } else if (Array.isArray(b)) { - return (b.length === 2 && b[0] instanceof Date && b[1] instanceof Date) + return b.length === 2 && b[0] instanceof Date && b[1] instanceof Date ? a.getTime() >= b[0].getTime() && a.getTime() <= b[1].getTime() : false; } @@ -219,4 +220,4 @@ export class LowDbQuery extends AASIndexQuery { return Date.parse(s); } } -} \ No newline at end of file +} diff --git a/projects/aas-server/src/app/aas-index/lowdb/lowdb-types.ts b/projects/aas-server/src/app/aas-index/lowdb/lowdb-types.ts index f1265ac7..307b9b35 100644 --- a/projects/aas-server/src/app/aas-index/lowdb/lowdb-types.ts +++ b/projects/aas-server/src/app/aas-index/lowdb/lowdb-types.ts @@ -26,4 +26,4 @@ export interface LowDbData { endpoints: AASEndpoint[]; documents: LowDbDocument[]; elements: LowDbElement[]; -} \ No newline at end of file +} diff --git a/projects/aas-server/src/app/aas-index/mysql/mysql-index.ts b/projects/aas-server/src/app/aas-index/mysql/mysql-index.ts index ce2b3ac2..88cb6ec6 100644 --- a/projects/aas-server/src/app/aas-index/mysql/mysql-index.ts +++ b/projects/aas-server/src/app/aas-index/mysql/mysql-index.ts @@ -25,18 +25,21 @@ export class MySqlIndex extends AASIndex { } public override async getEndpoints(): Promise { - return (await (await this.connection).query('SELECT * FROM `endpoints`'))[0] - .map(row => ({ - name: row.name, - url: row.url, - type: row.type, - version: row.version, - } as AASEndpoint)); + return (await (await this.connection).query('SELECT * FROM `endpoints`'))[0].map( + row => + ({ + name: row.name, + url: row.url, + type: row.type, + version: row.version, + }) as AASEndpoint, + ); } public override async getEndpoint(name: string): Promise { - const [results] = await (await this.connection).query( - 'SELECT * FROM `endpoints` WHERE name = ?', [name]); + const [results] = await ( + await this.connection + ).query('SELECT * FROM `endpoints` WHERE name = ?', [name]); if (results.length === 0) { throw new Error(`An endpoint with the name "${name}" does not exist.`); @@ -48,16 +51,20 @@ export class MySqlIndex extends AASIndex { } public override async addEndpoint(endpoint: AASEndpoint): Promise { - await (await this.connection).query( - 'INSERT INTO `endpoints` (name, url, type, version) VALUES (?, ?, ?, ?)', - [endpoint.name, endpoint.url, endpoint.type, endpoint.version]); + await ( + await this.connection + ).query('INSERT INTO `endpoints` (name, url, type, version) VALUES (?, ?, ?, ?)', [ + endpoint.name, + endpoint.url, + endpoint.type, + endpoint.version, + ]); } public override async removeEndpoint(name: string): Promise { - const result = await (await this.connection).query( - 'DELETE FROM `endpoints` WHERE name = ?', - [name] - ); + const result = await ( + await this.connection + ).query('DELETE FROM `endpoints` WHERE name = ?', [name]); return result[0].affectedRows > 0; } @@ -84,9 +91,11 @@ export class MySqlIndex extends AASIndex { } public override async getContainerDocuments(endpointName: string): Promise { - return (await (await this.connection).query( - 'SELECT * FROM `documents` WHERE endpoint = ?', - [endpointName]))[0].map(row => this.toDocument(row)); + return ( + await ( + await this.connection + ).query('SELECT * FROM `documents` WHERE endpoint = ?', [endpointName]) + )[0].map(row => this.toDocument(row)); } public override async update(document: AASDocument): Promise { @@ -95,7 +104,8 @@ export class MySqlIndex extends AASIndex { await connection.beginTransaction(); const result = await connection.query( 'SELECT uuid FROM `documents` WHERE endpoint = ? AND id = ?;', - [document.endpoint, document.id]); + [document.endpoint, document.id], + ); if (result[0].length === 0) { return; @@ -112,14 +122,12 @@ export class MySqlIndex extends AASIndex { document.readonly, document.timestamp, document.thumbnail, - uuid - ]); + uuid, + ], + ); if (document.content) { - await connection.query( - 'DELETE FROM `elements` WHERE uuid = ?;', - [uuid], - ); + await connection.query('DELETE FROM `elements` WHERE uuid = ?;', [uuid]); await this.traverseEnvironment(connection, uuid, document.content); } @@ -149,7 +157,8 @@ export class MySqlIndex extends AASIndex { document.readonly, document.thumbnail ?? '', document.timestamp, - ]); + ], + ); if (document.content) { await this.traverseEnvironment(connection, uuid, document.content); @@ -177,7 +186,8 @@ export class MySqlIndex extends AASIndex { await connection.beginTransaction(); const [results] = await connection.query( 'SELECT uuid FROM `documents` WHERE endpoint = ? AND id = ?;', - [endpointName, id]); + [endpointName, id], + ); if (results.length === 0) { return false; @@ -185,15 +195,9 @@ export class MySqlIndex extends AASIndex { const uuid = results[0].uuid; - await connection.query( - 'DELETE FROM `elements` WHERE uuid = ?;', - [uuid], - ); + await connection.query('DELETE FROM `elements` WHERE uuid = ?;', [uuid]); - await connection.query( - 'DELETE FROM `documents` WHERE uuid = ?;', - [uuid], - ); + await connection.query('DELETE FROM `documents` WHERE uuid = ?;', [uuid]); await connection.commit(); return true; @@ -224,11 +228,13 @@ export class MySqlIndex extends AASIndex { const values: unknown[] = []; if (query) { if (query.joinElements) { - sql = 'SELECT DISTINCT documents.* FROM `documents` INNER JOIN `elements` ON documents.uuid = elements.uuid WHERE ' + + sql = + 'SELECT DISTINCT documents.* FROM `documents` INNER JOIN `elements` ON documents.uuid = elements.uuid WHERE ' + query.createSql(values) + ' ORDER BY endpoint ASC, id ASC LIMIT ?;'; } else { - sql = 'SELECT * FROM `documents` WHERE ' + + sql = + 'SELECT * FROM `documents` WHERE ' + query.createSql(values) + ' ORDER BY endpoint ASC, id ASC LIMIT ?;'; } @@ -243,7 +249,7 @@ export class MySqlIndex extends AASIndex { return { previous: null, documents: documents.slice(0, limit), - next: documents.length >= (limit + 1) ? documents[limit] : null, + next: documents.length >= limit + 1 ? documents[limit] : null, }; } @@ -254,11 +260,13 @@ export class MySqlIndex extends AASIndex { if (query) { if (query.joinElements) { - sql = 'SELECT DISTINCT documents.* FROM `documents` INNER JOIN `elements` ON documents.uuid = elements.uuid WHERE CONCAT(endpoint, id) > ? AND (' + + sql = + 'SELECT DISTINCT documents.* FROM `documents` INNER JOIN `elements` ON documents.uuid = elements.uuid WHERE CONCAT(endpoint, id) > ? AND (' + query.createSql(values) + ') ORDER BY documents.endpoint ASC, documents.id ASC LIMIT ?;'; - } else { - sql = 'SELECT * FROM `documents` WHERE CONCAT(endpoint, id) > ? AND (' + + } else { + sql = + 'SELECT * FROM `documents` WHERE CONCAT(endpoint, id) > ? AND (' + query.createSql(values) + ') ORDER BY endpoint ASC, id ASC LIMIT ?;'; } @@ -273,7 +281,7 @@ export class MySqlIndex extends AASIndex { return { previous: current, documents: documents.slice(0, limit), - next: documents.length >= (limit + 1) ? documents[limit] : null, + next: documents.length >= limit + 1 ? documents[limit] : null, }; } @@ -284,13 +292,15 @@ export class MySqlIndex extends AASIndex { if (query) { if (query.joinElements) { - sql = 'SELECT DISTINCT documents.* FROM `documents` INNER JOIN `elements` ON documents.uuid = elements.uuid WHERE CONCAT(endpoint, id) < ? AND (' + + sql = + 'SELECT DISTINCT documents.* FROM `documents` INNER JOIN `elements` ON documents.uuid = elements.uuid WHERE CONCAT(endpoint, id) < ? AND (' + query.createSql(values) + ') ORDER BY documents.endpoint DESC, documents.id DESC LIMIT ?;'; - } else { - sql = 'SELECT * FROM `documents` WHERE CONCAT(endpoint, id) < ? AND (' + - query.createSql(values) + - ') ORDER BY endpoint DESC, id DESC LIMIT ?;'; + } else { + sql = + 'SELECT * FROM `documents` WHERE CONCAT(endpoint, id) < ? AND (' + + query.createSql(values) + + ') ORDER BY endpoint DESC, id DESC LIMIT ?;'; } } else { sql = 'SELECT * FROM `documents` WHERE CONCAT(endpoint, id) < ? ORDER BY endpoint DESC, id DESC LIMIT ?;'; @@ -301,7 +311,7 @@ export class MySqlIndex extends AASIndex { const documents = results.map(result => this.toDocument(result)); return { - previous: documents.length >= (limit + 1) ? documents[0] : null, + previous: documents.length >= limit + 1 ? documents[0] : null, documents: documents.slice(0, limit).reverse(), next: current, }; @@ -313,16 +323,18 @@ export class MySqlIndex extends AASIndex { const values: unknown[] = []; if (query) { if (query.joinElements) { - sql = 'SELECT DISTINCT documents.* FROM `documents` INNER JOIN `elements` ON documents.uuid = elements.uuid WHERE ' + + sql = + 'SELECT DISTINCT documents.* FROM `documents` INNER JOIN `elements` ON documents.uuid = elements.uuid WHERE ' + query.createSql(values) + ' ORDER BY documents.endpoint DESC, documents.id DESC LIMIT ?;'; - } else { - sql = 'SELECT * FROM `documents` WHERE ' + + } else { + sql = + 'SELECT * FROM `documents` WHERE ' + query.createSql(values) + ' ORDER BY endpoint DESC, id DESC LIMIT ?;'; } } else { - sql = 'SELECT * FROM `documents` ORDER BY endpoint DESC, id DESC LIMIT ?;' + sql = 'SELECT * FROM `documents` ORDER BY endpoint DESC, id DESC LIMIT ?;'; } values.push(limit + 1); @@ -330,16 +342,16 @@ export class MySqlIndex extends AASIndex { const documents = results.map(result => this.toDocument(result)); return { - previous: documents.length >= (limit + 1) ? documents[0] : null, + previous: documents.length >= limit + 1 ? documents[0] : null, documents: documents.slice(0, limit).reverse(), next: null, }; } private async getEndpointDocument(endpoint: string, id: string): Promise { - const [results] = await (await this.connection).query( - 'SELECT * FROM `documents` WHERE endpoint = ? AND id = ?', - [endpoint, id]); + const [results] = await ( + await this.connection + ).query('SELECT * FROM `documents` WHERE endpoint = ? AND id = ?', [endpoint, id]); if (results.length === 0) { throw new Error(`A document with the id "${id}" does not exist in "${endpoint}".`); @@ -349,9 +361,9 @@ export class MySqlIndex extends AASIndex { } private async getDocument(id: string): Promise { - const [results] = await (await this.connection).query( - 'SELECT * FROM `documents` WHERE id = ?', - [id]); + const [results] = await ( + await this.connection + ).query('SELECT * FROM `documents` WHERE id = ?', [id]); if (results.length === 0) { throw new Error(`A document with the id "${id}" does not exist.`); @@ -380,7 +392,8 @@ export class MySqlIndex extends AASIndex { this.toDateValue(referable), this.toBooleanValue(referable), this.toBigintValue(referable), - ]); + ], + ); } private toDocument(result: MySqlDocument): AASDocument { @@ -399,7 +412,7 @@ export class MySqlIndex extends AASIndex { } private async initialize(): Promise { - const url = new URL(this.variable.AAS_INDEX!) + const url = new URL(this.variable.AAS_INDEX!); const connection = await mysql.createConnection({ host: url.hostname, port: Number(url.port), @@ -420,7 +433,8 @@ export class MySqlIndex extends AASIndex { for (const endpoint of this.variable.ENDPOINTS.map(endpoint => urlToEndpoint(endpoint))) { await connection.query( 'INSERT INTO `endpoints` (name, url, type, version) VALUES (?, ?, ?, ?)', - [endpoint.name, endpoint.url, endpoint.type, endpoint.version]); + [endpoint.name, endpoint.url, endpoint.type, endpoint.version], + ); } } -} \ No newline at end of file +} diff --git a/projects/aas-server/src/app/aas-index/mysql/mysql-query.ts b/projects/aas-server/src/app/aas-index/mysql/mysql-query.ts index ce31f8a7..7b395408 100644 --- a/projects/aas-server/src/app/aas-index/mysql/mysql-query.ts +++ b/projects/aas-server/src/app/aas-index/mysql/mysql-query.ts @@ -10,7 +10,6 @@ import { AASQuery, AASQueryOperator, OrExpression } from 'common'; import { AASIndexQuery } from '../aas-index-query.js'; export class MySqlQuery extends AASIndexQuery { - public constructor(expression: string, language: string = 'en') { super(expression, language); } @@ -37,7 +36,9 @@ export class MySqlQuery extends AASIndexQuery { } else if (this.isExpression(and)) { andSqlTerms.push(`(${this.evaluate(and, values)})`); } else { - andSqlTerms.push(`(documents.endpoint LIKE '%${and}%' OR documents.id LIKE '%${and}%' OR documents.idShort LIKE '%${and}%')`); + andSqlTerms.push( + `(documents.endpoint LIKE '%${and}%' OR documents.id LIKE '%${and}%' OR documents.idShort LIKE '%${and}%')`, + ); } } @@ -50,7 +51,7 @@ export class MySqlQuery extends AASIndexQuery { private createSqlTerm(query: AASQuery, values: unknown[]): string { let s = `elements.modelType = "${query.modelType.toLowerCase()}"`; if (query.name) { - s += ` AND elements.idShort LIKE '%${query.name}%'` + s += ` AND elements.idShort LIKE '%${query.name}%'`; } if (query.value && query.operator) { @@ -71,21 +72,21 @@ export class MySqlQuery extends AASIndexQuery { } private isDate(value: unknown): value is Date | [Date, Date] { - return value instanceof Date || Array.isArray(value) && value[0] instanceof Date; + return value instanceof Date || (Array.isArray(value) && value[0] instanceof Date); } private isNumber(value: unknown): value is number | [number, number] { - return typeof value === 'number' || Array.isArray(value) && typeof value[0] === 'number'; + return typeof value === 'number' || (Array.isArray(value) && typeof value[0] === 'number'); } private isBigint(value: unknown): value is bigint | [bigint, bigint] { - return typeof value === 'bigint' || Array.isArray(value) && typeof value[0] === 'bigint'; + return typeof value === 'bigint' || (Array.isArray(value) && typeof value[0] === 'bigint'); } private createDateSqlTerm(operator: AASQueryOperator, value: Date | [Date, Date], values: unknown[]): string { if (Array.isArray(value)) { values.push(value[0]); - values.push(value[1]) + values.push(value[1]); return ` AND elements.dateValue >= ? AND elements.dateValue <= ?`; } @@ -93,10 +94,14 @@ export class MySqlQuery extends AASIndexQuery { return ` AND elements.dateValue ${this.toMySqlOperator(operator)} ?`; } - private createNumberSqlTerm(operator: AASQueryOperator, value: number | [number, number], values: unknown[]): string { + private createNumberSqlTerm( + operator: AASQueryOperator, + value: number | [number, number], + values: unknown[], + ): string { if (Array.isArray(value)) { values.push(value[0]); - values.push(value[1]) + values.push(value[1]); return ` AND elements.numberValue >= ? AND elements.numberValue <= ?`; } @@ -104,10 +109,14 @@ export class MySqlQuery extends AASIndexQuery { return ` AND elements.numberValue ${this.toMySqlOperator(operator)} ?`; } - private createBigintSqlTerm(operator: AASQueryOperator, value: bigint | [bigint, bigint], values: unknown[]): string { + private createBigintSqlTerm( + operator: AASQueryOperator, + value: bigint | [bigint, bigint], + values: unknown[], + ): string { if (Array.isArray(value)) { values.push(value[0]); - values.push(value[1]) + values.push(value[1]); return ` AND elements.bigintValue >= ? AND elements.bigintValue <= ?`; } @@ -144,4 +153,4 @@ export class MySqlQuery extends AASIndexQuery { private toMySqlOperator(operator: AASQueryOperator): string { return operator === '!=' ? '<>' : operator; } -} \ No newline at end of file +} diff --git a/projects/aas-server/src/app/aas-index/mysql/mysql-types.ts b/projects/aas-server/src/app/aas-index/mysql/mysql-types.ts index 56d2c048..8ca9d720 100644 --- a/projects/aas-server/src/app/aas-index/mysql/mysql-types.ts +++ b/projects/aas-server/src/app/aas-index/mysql/mysql-types.ts @@ -9,8 +9,7 @@ import { RowDataPacket } from 'mysql2/promise'; import { AASEndpoint, AASDocument } from 'common'; -export interface MySqlEndpoint extends AASEndpoint, RowDataPacket { -} +export interface MySqlEndpoint extends AASEndpoint, RowDataPacket {} export interface MySqlDocument extends AASDocument, RowDataPacket { uuid: string; @@ -24,4 +23,4 @@ export interface MySqlElement extends RowDataPacket { numberValue?: number; dateValue?: Date; booleanValue?: boolean; -} \ No newline at end of file +} diff --git a/projects/aas-server/src/app/aas-provider/aas-provider.ts b/projects/aas-server/src/app/aas-provider/aas-provider.ts index 38ae7417..f0357e00 100644 --- a/projects/aas-server/src/app/aas-provider/aas-provider.ts +++ b/projects/aas-server/src/app/aas-provider/aas-provider.ts @@ -21,7 +21,7 @@ import { AASPage, AASEndpoint, ApplicationError, - getChildren + getChildren, } from 'common'; import { ImageProcessing } from '../image-processing.js'; @@ -44,19 +44,22 @@ export class AASProvider { private readonly timeout: number; private readonly file: string | undefined; private wsServer!: WSServer; - private readonly tasks = new Map(); + private readonly tasks = new Map< + number, + { + id: string; + type: 'ScanEndpoint' | 'ScanContainer'; + } + >(); private nextTaskId = 1; - constructor( + public constructor( @inject(Variable) variable: Variable, @inject('Logger') private readonly logger: Logger, @inject(Parallel) private readonly parallel: Parallel, @inject(AASResourceFactory) private readonly resourceFactory: AASResourceFactory, - @inject('AASIndex') private readonly index: AASIndex + @inject('AASIndex') private readonly index: AASIndex, ) { this.timeout = variable.TIMEOUT; this.parallel.on('message', this.parallelOnMessage); @@ -132,7 +135,7 @@ export class AASProvider { id: string, smId: string, path: string, - options?: object + options?: object, ): Promise { const endpoint = await this.index.getEndpoint(name); const document = await this.index.get(name, id); @@ -154,7 +157,7 @@ export class AASProvider { const file = dataElement as aas.File; stream = await pkg.openReadStreamAsync(document.content, file); const extension = file.value ? extname(file.value).toLowerCase() : ''; - const imageOptions = options as { width?: number, height?: number }; + const imageOptions = options as { width?: number; height?: number }; if (file.contentType.startsWith('image/')) { if (imageOptions?.width || imageOptions?.height) { stream = await ImageProcessing.resizeAsync(stream, imageOptions.width, imageOptions.height); @@ -240,7 +243,7 @@ export class AASProvider { * @param name The endpoint name. * @param id The AAS document ID. * @param content The new document content. - * @returns + * @returns */ public async updateDocumentAsync(name: string, id: string, content: aas.Environment): Promise { const endpoint = await this.index.getEndpoint(name); @@ -258,8 +261,7 @@ export class AASProvider { } return await pkg.commitDocumentAsync(document, content); - } - finally { + } finally { await resource.closeAsync(); } } @@ -293,7 +295,8 @@ export class AASProvider { throw new ApplicationError( `An AAS container with the name "${name}" does not exist.`, ERRORS.ContainerDoesNotExist, - name); + name, + ); } const source = this.resourceFactory.create(endpoint); @@ -332,7 +335,7 @@ export class AASProvider { for (const endpoint of await this.index.getEndpoints()) { if (endpoint.type === 'AasxDirectory') { const documents = await factory.create(endpoint).scanAsync(); - documents.forEach(async (document) => await this.index.add(document)); + documents.forEach(async document => await this.index.add(document)); } } } @@ -352,15 +355,15 @@ export class AASProvider { await resource.openAsync(); return await resource.invoke(document.content!, operation); } finally { - await resource.closeAsync() + await resource.closeAsync(); } } /** - * + * * @param endpoint The endpoint name. - * @param id The AAS identifier. - * @returns + * @param id The AAS identifier. + * @returns */ public async getHierarchyAsync(endpoint: string, id: string): Promise { const document = await this.index.get(endpoint, id); @@ -413,12 +416,7 @@ export class AASProvider { if (task.type === 'ScanContainer') { const endpoint = await this.index.getEndpoint(task.id); if (endpoint) { - setTimeout( - this.startContainerScan, - this.timeout, - result.taskId, - endpoint, - result.statistic); + setTimeout(this.startContainerScan, this.timeout, result.taskId, endpoint, result.statistic); } } } @@ -436,7 +434,7 @@ export class AASProvider { type: 'ScanContainerData', taskId, statistic, - container: { ...endpoint, documents } + container: { ...endpoint, documents }, }; this.tasks.set(taskId, { id: endpoint.name, type: 'ScanContainer' }); @@ -444,11 +442,10 @@ export class AASProvider { }; private notify(data: AASServerMessage): void { - this.wsServer.notify('WorkspaceChanged', - { - type: 'AASServerMessage', - data: data - }); + this.wsServer.notify('WorkspaceChanged', { + type: 'AASServerMessage', + data: data, + }); } private parallelOnMessage = async (result: ScanResult) => { @@ -489,7 +486,7 @@ export class AASProvider { private sendMessage(data: AASServerMessage) { this.wsServer.notify('WorkspaceChanged', { type: 'AASServerMessage', - data: data + data: data, }); } @@ -515,7 +512,8 @@ export class AASProvider { const content = await this.getDocumentContentAsync(parent); for (const reference of this.whereReferenceElement(content.submodels)) { const childId = reference.value.keys[0].value; - const child = await this.index.find(parent.endpoint, childId) ?? await this.index.find(undefined, childId); + const child = + (await this.index.find(parent.endpoint, childId)) ?? (await this.index.find(undefined, childId)); if (child) { const node: AASDocument = { ...child, parent: { ...parent }, content: null }; nodes.push(node); @@ -555,4 +553,4 @@ export class AASProvider { await resource.closeAsync(); } } -} \ No newline at end of file +} diff --git a/projects/aas-server/src/app/aas-provider/aas-resource-scan-factory.ts b/projects/aas-server/src/app/aas-provider/aas-resource-scan-factory.ts index 0127240a..404ac169 100644 --- a/projects/aas-server/src/app/aas-provider/aas-resource-scan-factory.ts +++ b/projects/aas-server/src/app/aas-provider/aas-resource-scan-factory.ts @@ -23,16 +23,15 @@ import { FileStorage } from '../file-storage/file-storage.js'; @singleton() export class AASResourceScanFactory { - constructor( + public constructor( @inject('Logger') private readonly logger: Logger, - @inject(FileStorageFactory) private readonly fileStorageFactory: FileStorageFactory - ) { - } + @inject(FileStorageFactory) private readonly fileStorageFactory: FileStorageFactory, + ) {} public create(endpoint: AASEndpoint): AASResourceScan { switch (new URL(endpoint.url).protocol) { case 'http:': - case 'https': + case 'https': { const version = endpoint.version ?? '3.0'; let source: AasxServer; if (version === '3.0') { @@ -44,6 +43,7 @@ export class AASResourceScanFactory { } return new AASXServerScan(this.logger, source); + } case 'opc.tcp:': return new OpcuaServerScan(this.logger, new OpcuaServer(this.logger, endpoint.url, endpoint.name)); case 'file:': @@ -53,7 +53,9 @@ export class AASResourceScanFactory { this.logger, endpoint.url, endpoint.name, - this.createLocalFileStorage(new URL(endpoint.url)))); + this.createLocalFileStorage(new URL(endpoint.url)), + ), + ); default: throw new Error('Not implemented.'); } @@ -62,4 +64,4 @@ export class AASResourceScanFactory { private createLocalFileStorage(url: URL): FileStorage { return this.fileStorageFactory.create(`file:///endpoints` + url.pathname); } -} \ No newline at end of file +} diff --git a/projects/aas-server/src/app/aas-provider/aas-resource-scan.ts b/projects/aas-server/src/app/aas-provider/aas-resource-scan.ts index b30b0cc7..ff4e56a5 100644 --- a/projects/aas-server/src/app/aas-provider/aas-resource-scan.ts +++ b/projects/aas-server/src/app/aas-provider/aas-resource-scan.ts @@ -11,7 +11,6 @@ import { AASDocument } from 'common'; /** Defines an automate to scan an AAS resource for Asset Administration Shells. */ export abstract class AASResourceScan extends EventEmitter { - /** Gets all documents of the current container. */ public abstract scanAsync(): Promise; -} \ No newline at end of file +} diff --git a/projects/aas-server/src/app/aas-provider/aasx-server-scan.ts b/projects/aas-server/src/app/aas-provider/aasx-server-scan.ts index 21196afe..ba684e11 100644 --- a/projects/aas-server/src/app/aas-provider/aasx-server-scan.ts +++ b/projects/aas-server/src/app/aas-provider/aasx-server-scan.ts @@ -6,17 +6,17 @@ * *****************************************************************************/ -import { AASDocument } from "common"; -import { Logger } from "../logging/logger.js"; -import { AasxServer } from "../packages/aasx-server/aasx-server.js"; -import { AasxServerPackage } from "../packages/aasx-server/aasx-server-package.js"; -import { AASResourceScan } from "./aas-resource-scan.js"; +import { AASDocument } from 'common'; +import { Logger } from '../logging/logger.js'; +import { AasxServer } from '../packages/aasx-server/aasx-server.js'; +import { AasxServerPackage } from '../packages/aasx-server/aasx-server-package.js'; +import { AASResourceScan } from './aas-resource-scan.js'; export class AASXServerScan extends AASResourceScan { private readonly logger: Logger; private readonly server: AasxServer; - constructor(logger: Logger, server: AasxServer) { + public constructor(logger: Logger, server: AasxServer) { super(); this.logger = logger; @@ -44,4 +44,4 @@ export class AASXServerScan extends AASResourceScan { await this.server.closeAsync(); } } -} \ No newline at end of file +} diff --git a/projects/aas-server/src/app/aas-provider/directory-scan.ts b/projects/aas-server/src/app/aas-provider/directory-scan.ts index 53ac2095..1d9622ff 100644 --- a/projects/aas-server/src/app/aas-provider/directory-scan.ts +++ b/projects/aas-server/src/app/aas-provider/directory-scan.ts @@ -14,16 +14,16 @@ import { extname } from 'path'; import { AASResourceScan } from './aas-resource-scan.js'; export class DirectoryScan extends AASResourceScan { - constructor( + public constructor( private readonly logger: Logger, - private readonly source: AasxDirectory + private readonly source: AasxDirectory, ) { super(); } public async scanAsync(): Promise { try { - await this.source.openAsync() + await this.source.openAsync(); const files = await this.source.getStorage().readDir('.'); const documents: AASDocument[] = []; @@ -46,4 +46,4 @@ export class DirectoryScan extends AASResourceScan { await this.source.closeAsync(); } } -} \ No newline at end of file +} diff --git a/projects/aas-server/src/app/aas-provider/opcua-server-scan.ts b/projects/aas-server/src/app/aas-provider/opcua-server-scan.ts index 5097bb21..0f7a8c9d 100644 --- a/projects/aas-server/src/app/aas-provider/opcua-server-scan.ts +++ b/projects/aas-server/src/app/aas-provider/opcua-server-scan.ts @@ -18,7 +18,7 @@ export class OpcuaServerScan extends AASResourceScan { private readonly logger: Logger; private readonly server: OpcuaServer; - constructor(logger: Logger, server: OpcuaServer) { + public constructor(logger: Logger, server: OpcuaServer) { super(); this.logger = logger; @@ -49,7 +49,10 @@ export class OpcuaServerScan extends AASResourceScan { } } - private async browseAsync(nodeToBrowse: BrowseDescriptionLike, descriptions: ReferenceDescription[] = []): Promise { + private async browseAsync( + nodeToBrowse: BrowseDescriptionLike, + descriptions: ReferenceDescription[] = [], + ): Promise { const session = this.server.getSession(); const result = await session.browse(nodeToBrowse); if (result.references) { @@ -67,7 +70,7 @@ export class OpcuaServerScan extends AASResourceScan { private async isFolderAsync(obj: ReferenceDescription): Promise { const type = (await this.readQualifiedName(obj)).name; - return type === 'FolderType' || type === 'AASEnvironmentType' + return type === 'FolderType' || type === 'AASEnvironmentType'; } private async isAASTypeAsync(obj: ReferenceDescription): Promise { @@ -75,12 +78,11 @@ export class OpcuaServerScan extends AASResourceScan { } private async readQualifiedName(obj: ReferenceDescription): Promise { - const node = await (this.server.getSession()).read( - { - nodeId: obj.typeDefinition, - attributeId: AttributeIds.BrowseName - }); + const node = await this.server.getSession().read({ + nodeId: obj.typeDefinition, + attributeId: AttributeIds.BrowseName, + }); return node.value.value as QualifiedName; } -} \ No newline at end of file +} diff --git a/projects/aas-server/src/app/aas-provider/parallel.ts b/projects/aas-server/src/app/aas-provider/parallel.ts index 554a1ecf..9ab33437 100644 --- a/projects/aas-server/src/app/aas-provider/parallel.ts +++ b/projects/aas-server/src/app/aas-provider/parallel.ts @@ -22,7 +22,7 @@ import { Variable } from '../variable.js'; class WorkerTask extends EventEmitter { private _worker?: Worker; - constructor(data: WorkerData) { + public constructor(data: WorkerData) { super(); this.data = data; @@ -59,15 +59,15 @@ class WorkerTask extends EventEmitter { } else { this.emit('message', result); } - } + }; private workerOnError = (error: Error) => { this.emit('error', error, this); - } + }; private workerOnExit = (code: number) => { this.emit('exit', code, this); - } + }; } /** Provides a pool of worker threads. */ @@ -77,9 +77,9 @@ export class Parallel extends EventEmitter { private readonly waiting = new Array(); private readonly pool = new Map(); - constructor( + public constructor( @inject('Logger') private readonly logger: Logger, - @inject(Variable) private readonly variable: Variable + @inject(Variable) private readonly variable: Variable, ) { super(); this.script = path.resolve(this.variable.CONTENT_ROOT, 'aas-scan-worker.js'); @@ -151,7 +151,7 @@ export class Parallel extends EventEmitter { if (task) { task.destroy(); if (task.worker) { - this.pool.delete(task.worker) + this.pool.delete(task.worker); } const index = this.waiting.indexOf(task); @@ -163,9 +163,8 @@ export class Parallel extends EventEmitter { this.pool.set(new Worker(this.script, { env: SHARE_ENV }), true); } } - } - catch (error) { + } catch (error) { noop(); } } -} \ No newline at end of file +} diff --git a/projects/aas-server/src/app/aas-provider/scan-result.ts b/projects/aas-server/src/app/aas-provider/scan-result.ts index 79aa40a3..c630dcc6 100644 --- a/projects/aas-server/src/app/aas-provider/scan-result.ts +++ b/projects/aas-server/src/app/aas-provider/scan-result.ts @@ -6,7 +6,7 @@ * *****************************************************************************/ -import { AASDocument, AASContainer, Message, AASEndpoint } from 'common'; +import { AASDocument, AASContainer, Message } from 'common'; export enum ScanResultType { Added, @@ -20,23 +20,23 @@ export interface ScanStatistic { /** Start time. */ start: number; /** End time */ - end: number, + end: number; /** The number of scan cycles. */ - counter: number, + counter: number; /** The number of changed AAS documents.*/ - changed: number, + changed: number; /** The number of new AAS documents. */ - new: number, + new: number; /** The number of deleted AAS documents. */ - deleted: number, + deleted: number; /** The number of offline events. */ - offline: number + offline: number; } /** The result of a container scan. */ export interface ScanResult { /** The result. */ - type: ScanResultType, + type: ScanResultType; /** The task identifier. */ taskId: number; /** Statistic information. */ diff --git a/projects/aas-server/src/app/aas-scan-worker.ts b/projects/aas-server/src/app/aas-scan-worker.ts index 9df30ac2..9580f2c0 100644 --- a/projects/aas-server/src/app/aas-scan-worker.ts +++ b/projects/aas-server/src/app/aas-scan-worker.ts @@ -13,8 +13,9 @@ import { WorkerApp } from './worker-app.js'; container.register('Logger', MemoryLogger); container.registerInstance( - 'LOG_LEVEL', - process.env.NODE_ENV === 'production' ? MemoryLoggerLevel.Error : MemoryLoggerLevel.All); + 'LOG_LEVEL', + process.env.NODE_ENV === 'production' ? MemoryLoggerLevel.Error : MemoryLoggerLevel.All, +); const app = container.resolve(WorkerApp); app.run(); diff --git a/projects/aas-server/src/app/aas-server.ts b/projects/aas-server/src/app/aas-server.ts index 71ea4131..b991844c 100644 --- a/projects/aas-server/src/app/aas-server.ts +++ b/projects/aas-server/src/app/aas-server.ts @@ -25,9 +25,13 @@ container.register('UserStorage', { useFactory: c => new UserStorageFactory(c).c container.register('winston.Logger', { useFactory: () => new LoggerFactory().create() }); container.register('TemplateStorage', { useFactory: c => new TemplateStorageFactory(c).create() }); -container.afterResolution(AASProvider, (_, instance) => { - (instance as AASProvider).start(container.resolve(WSServer)); -}, { frequency: 'Once' }); +container.afterResolution( + AASProvider, + (_, instance) => { + (instance as AASProvider).start(container.resolve(WSServer)); + }, + { frequency: 'Once' }, +); container.resolve(WSServer).run(); container.resolve(AASProvider); diff --git a/projects/aas-server/src/app/app.ts b/projects/aas-server/src/app/app.ts index 23f2e46d..a7543b6b 100644 --- a/projects/aas-server/src/app/app.ts +++ b/projects/aas-server/src/app/app.ts @@ -15,7 +15,7 @@ import swaggerUi, { JsonObject } from 'swagger-ui-express'; import { ApplicationError } from 'common'; import { ValidateError } from 'tsoa'; -import swaggerDoc from './swagger.json' assert {type: 'json'}; +import swaggerDoc from './swagger.json' assert { type: 'json' }; import { RegisterRoutes } from './routes/routes.js'; import { ERRORS } from './errors.js'; import { Variable } from './variable.js'; @@ -24,9 +24,9 @@ import { parseUrl } from './convert.js'; @singleton() export class App { - constructor( + public constructor( @inject('Logger') private readonly logger: Logger, - @inject(Variable) private readonly variable: Variable + @inject(Variable) private readonly variable: Variable, ) { this.app = express(); this.setup(); @@ -44,10 +44,12 @@ export class App { this.logger.error(`Unhandled Rejection at: ${promise}, reason: ${reason}`); }); - this.app.use(cors({ - origin: this.variable.CORS_ORIGIN, - credentials: true - })); + this.app.use( + cors({ + origin: this.variable.CORS_ORIGIN, + credentials: true, + }), + ); this.app.use(json()); this.app.use(urlencoded({ extended: true })); @@ -82,7 +84,7 @@ export class App { private errorHandler = (err: unknown, req: Request, res: Response, next: NextFunction): Response | void => { if (err instanceof ValidateError) { return res.status(422).json({ - message: "Validation Failed", + message: 'Validation Failed', details: err?.fields, }); } @@ -90,18 +92,18 @@ export class App { if (err instanceof ApplicationError) { if (err.name === ERRORS.UnauthorizedAccess) { return res.status(401).json({ - message: 'Unauthorized' + message: 'Unauthorized', }); } return res.status(500).json({ - message: err.message + message: err.message, }); } if (err instanceof Error) { return res.status(500).json({ - message: err.message + message: err.message, }); } @@ -110,7 +112,7 @@ export class App { private notFoundHandler = (_req: Request, res: Response) => { res.status(404).send({ - message: "Not Found" + message: 'Not Found', }); }; @@ -118,9 +120,9 @@ export class App { (swaggerDoc as { host?: string }).host = req.get('host'); (req as Request & { swaggerDoc: JsonObject }).swaggerDoc = swaggerDoc; next(); - } + }; private getIndex = (req: Request, res: Response) => { res.sendFile(this.variable.WEB_ROOT + '/index.html'); - } -} \ No newline at end of file + }; +} diff --git a/projects/aas-server/src/app/application-info.ts b/projects/aas-server/src/app/application-info.ts index 36d341c0..0f8aa8a2 100644 --- a/projects/aas-server/src/app/application-info.ts +++ b/projects/aas-server/src/app/application-info.ts @@ -16,9 +16,7 @@ import { inject, singleton } from 'tsyringe'; export class ApplicationInfo { private data?: PackageInfo; - constructor( - @inject('Logger') private readonly logger: Logger, - ) { } + public constructor(@inject('Logger') private readonly logger: Logger) {} public async getAsync(file?: string): Promise { if (!this.data) { @@ -55,8 +53,8 @@ export class ApplicationInfo { description: '', license: '', homepage: '', - libraries: [] + libraries: [], }; } } -} \ No newline at end of file +} diff --git a/projects/aas-server/src/app/auth/auth-service.ts b/projects/aas-server/src/app/auth/auth-service.ts index fc848e59..a5429b34 100644 --- a/projects/aas-server/src/app/auth/auth-service.ts +++ b/projects/aas-server/src/app/auth/auth-service.ts @@ -27,7 +27,7 @@ import { getUserNameFromEMail, Cookie, JWTPayload, - AuthResult + AuthResult, } from 'common'; @singleton() @@ -35,11 +35,11 @@ export class AuthService { private readonly algorithm: jwt.Algorithm; private readonly privateKey: string; - constructor( + public constructor( @inject(Mailer) private readonly mailer: Mailer, @inject('UserStorage') private readonly userStorage: UserStorage, @inject('CookieStorage') private readonly cookieStorage: CookieStorage, - @inject(Variable) private readonly variable: Variable + @inject(Variable) private readonly variable: Variable, ) { if (variable.JWT_PUBLIC_KEY) { this.algorithm = 'RS256'; @@ -96,7 +96,7 @@ export class AuthService { throw new ApplicationError( `An account already exists for this e-mail '${profile.id}'.`, ERRORS.UserAlreadyExists, - profile.id + profile.id, ); } @@ -118,7 +118,7 @@ export class AuthService { throw new ApplicationError( `An account already exists for this e-mail '${profile.id}'.`, ERRORS.UserAlreadyExists, - profile.id + profile.id, ); } @@ -137,7 +137,7 @@ export class AuthService { role: 'editor', password: await bcrypt.hash(profile.password, 10), created: new Date(), - lastLoggedIn: new Date(0) + lastLoggedIn: new Date(0), }; const token = this.generateToken(data.id, data.name, data.role); @@ -185,19 +185,18 @@ export class AuthService { private generateToken(subject: string, name: string, role: UserRole): string { const payload: JWTPayload = { name, role }; - return jwt.sign(payload, this.privateKey, - { - subject, - expiresIn: this.variable.JWT_EXPIRES_IN, - algorithm: this.algorithm - }); + return jwt.sign(payload, this.privateKey, { + subject, + expiresIn: this.variable.JWT_EXPIRES_IN, + algorithm: this.algorithm, + }); } private generateGuestToken(): string { const payload: JWTPayload = { role: 'guest' }; return jwt.sign(payload, this.privateKey, { expiresIn: this.variable.JWT_EXPIRES_IN, - algorithm: this.algorithm + algorithm: this.algorithm, }); } @@ -206,7 +205,7 @@ export class AuthService { return jwt.sign(payload, this.privateKey, { subject, expiresIn: this.variable.JWT_SHORT_EXP, - algorithm: this.algorithm + algorithm: this.algorithm, }); } @@ -219,4 +218,4 @@ export class AuthService { private createPassword(): string { return Math.random().toString(36).slice(-8); } -} \ No newline at end of file +} diff --git a/projects/aas-server/src/app/auth/cookie-storage-factory.ts b/projects/aas-server/src/app/auth/cookie-storage-factory.ts index c5052095..085eedd2 100644 --- a/projects/aas-server/src/app/auth/cookie-storage-factory.ts +++ b/projects/aas-server/src/app/auth/cookie-storage-factory.ts @@ -15,8 +15,7 @@ import { Logger } from '../logging/logger.js'; /* istanbul ignore next */ export class CookieStorageFactory { - constructor(private readonly container: DependencyContainer) { - } + public constructor(private readonly container: DependencyContainer) {} public create(): CookieStorage { const url = this.container.resolve(Variable).USER_STORAGE; @@ -39,4 +38,4 @@ export class CookieStorageFactory { logger.info(`Using locale user database.`); return storage; } -} \ No newline at end of file +} diff --git a/projects/aas-server/src/app/auth/cookie-storage.ts b/projects/aas-server/src/app/auth/cookie-storage.ts index 4914e049..36ac9167 100644 --- a/projects/aas-server/src/app/auth/cookie-storage.ts +++ b/projects/aas-server/src/app/auth/cookie-storage.ts @@ -6,7 +6,7 @@ * *****************************************************************************/ -import { Cookie } from "common"; +import { Cookie } from 'common'; export abstract class CookieStorage { /** @@ -24,12 +24,12 @@ export abstract class CookieStorage { /** * @param id The user identification. */ - public abstract getAllAsync(id: string): Promise; + public abstract getAllAsync(id: string): Promise; /** * @param id The user identification. * @param name The cookie name. - * @param data + * @param data */ public abstract setAsync(id: string, name: string, data: string): Promise; @@ -38,4 +38,4 @@ export abstract class CookieStorage { * @param name The cookie name. */ public abstract deleteAsync(id: string, name: string): Promise; -} \ No newline at end of file +} diff --git a/projects/aas-server/src/app/auth/locale-cookie-storage.ts b/projects/aas-server/src/app/auth/locale-cookie-storage.ts index 7fed41e6..e67e6b0b 100644 --- a/projects/aas-server/src/app/auth/locale-cookie-storage.ts +++ b/projects/aas-server/src/app/auth/locale-cookie-storage.ts @@ -17,9 +17,10 @@ import { Logger } from '../logging/logger.js'; export class LocaleCookieStorage extends CookieStorage { private readonly usersDirectory: string; - constructor( + public constructor( @inject('Logger') private readonly logger: Logger, - @inject('USERS_DIR') dir: string) { + @inject('USERS_DIR') dir: string, + ) { super(); this.usersDirectory = path.resolve(dir); @@ -65,7 +66,7 @@ export class LocaleCookieStorage extends CookieStorage { cookies[index].data = data; } - await await fs.promises.writeFile(file, JSON.stringify(cookies)); + await fs.promises.writeFile(file, JSON.stringify(cookies)); } public async deleteAsync(id: string, name: string): Promise { @@ -94,4 +95,4 @@ export class LocaleCookieStorage extends CookieStorage { return []; } } -} \ No newline at end of file +} diff --git a/projects/aas-server/src/app/auth/locale-user-storage.ts b/projects/aas-server/src/app/auth/locale-user-storage.ts index 1b7118fe..41c625f4 100644 --- a/projects/aas-server/src/app/auth/locale-user-storage.ts +++ b/projects/aas-server/src/app/auth/locale-user-storage.ts @@ -9,16 +9,14 @@ import { inject, injectable } from 'tsyringe'; import path from 'path'; import fs from 'fs'; -import { UserStorage } from "./user-storage.js"; +import { UserStorage } from './user-storage.js'; import { UserData } from './user-data.js'; @injectable() export class LocaleUserStorage extends UserStorage { private readonly usersDirectory: string; - constructor( - @inject('USERS_DIR') usersDirectory: string - ) { + public constructor(@inject('USERS_DIR') usersDirectory: string) { super(); this.usersDirectory = path.resolve(usersDirectory); @@ -29,7 +27,7 @@ export class LocaleUserStorage extends UserStorage { } public existAsync(userId: string): Promise { - return new Promise((resolve) => resolve(fs.existsSync(this.getUserDir(userId)))); + return new Promise(resolve => resolve(fs.existsSync(this.getUserDir(userId)))); } public async readAsync(userId: string): Promise { @@ -70,4 +68,4 @@ export class LocaleUserStorage extends UserStorage { private getUserDir(userId: string): string { return path.join(this.usersDirectory, userId); } -} \ No newline at end of file +} diff --git a/projects/aas-server/src/app/auth/mongo-db-cookie-storage.ts b/projects/aas-server/src/app/auth/mongo-db-cookie-storage.ts index 0a6710aa..a555e603 100644 --- a/projects/aas-server/src/app/auth/mongo-db-cookie-storage.ts +++ b/projects/aas-server/src/app/auth/mongo-db-cookie-storage.ts @@ -7,9 +7,9 @@ *****************************************************************************/ import { injectable } from 'tsyringe'; -import { Cookie } from "common"; -import { model, Schema } from "mongoose"; -import { CookieStorage } from "./cookie-storage.js"; +import { Cookie } from 'common'; +import { model, Schema } from 'mongoose'; +import { CookieStorage } from './cookie-storage.js'; export interface UserCookies { id: string; @@ -23,8 +23,8 @@ export class MongoDBCookieStorage extends CookieStorage { cookies: [ { name: String, - data: String - } + data: String, + }, ], }); @@ -87,4 +87,4 @@ export class MongoDBCookieStorage extends CookieStorage { } } } -} \ No newline at end of file +} diff --git a/projects/aas-server/src/app/auth/mongo-db-user-storage.ts b/projects/aas-server/src/app/auth/mongo-db-user-storage.ts index 2add4a70..21d2e2d2 100644 --- a/projects/aas-server/src/app/auth/mongo-db-user-storage.ts +++ b/projects/aas-server/src/app/auth/mongo-db-user-storage.ts @@ -8,8 +8,8 @@ import { injectable } from 'tsyringe'; import { Schema, model } from 'mongoose'; -import { UserData } from "./user-data.js"; -import { UserStorage } from "./user-storage.js"; +import { UserData } from './user-data.js'; +import { UserStorage } from './user-storage.js'; @injectable() export class MongoDBUserStorage extends UserStorage { @@ -29,7 +29,7 @@ export class MongoDBUserStorage extends UserStorage { } public async readAsync(userId: string): Promise { - return await this.UserDataModel.findOne({ id: userId }).exec() ?? undefined; + return (await this.UserDataModel.findOne({ id: userId }).exec()) ?? undefined; } public async writeAsync(userId: string, data: UserData): Promise { @@ -46,6 +46,6 @@ export class MongoDBUserStorage extends UserStorage { } public async deleteAsync(userId: string): Promise { - return (await this.UserDataModel.findOneAndDelete({ id: userId }).exec()) != null + return (await this.UserDataModel.findOneAndDelete({ id: userId }).exec()) != null; } -} \ No newline at end of file +} diff --git a/projects/aas-server/src/app/auth/user-data.ts b/projects/aas-server/src/app/auth/user-data.ts index e6257449..52684d32 100644 --- a/projects/aas-server/src/app/auth/user-data.ts +++ b/projects/aas-server/src/app/auth/user-data.ts @@ -6,7 +6,7 @@ * *****************************************************************************/ -import { UserRole } from "common"; +import { UserRole } from 'common'; /** The user data. */ export type UserData = { @@ -22,4 +22,4 @@ export type UserData = { created: Date; /** The date and time of the last login. */ lastLoggedIn: Date; -}; \ No newline at end of file +}; diff --git a/projects/aas-server/src/app/auth/user-storage-factory.ts b/projects/aas-server/src/app/auth/user-storage-factory.ts index 8f3da6a1..87281394 100644 --- a/projects/aas-server/src/app/auth/user-storage-factory.ts +++ b/projects/aas-server/src/app/auth/user-storage-factory.ts @@ -15,8 +15,7 @@ import { Logger } from '../logging/logger.js'; /* istanbul ignore next */ export class UserStorageFactory { - constructor(private readonly container: DependencyContainer) { - } + public constructor(private readonly container: DependencyContainer) {} public create(): UserStorage { const url = this.container.resolve(Variable).USER_STORAGE; @@ -39,4 +38,4 @@ export class UserStorageFactory { logger.info(`Using local user storage.`); return storage; } -} \ No newline at end of file +} diff --git a/projects/aas-server/src/app/auth/user-storage.ts b/projects/aas-server/src/app/auth/user-storage.ts index 00df4ee5..f9a92547 100644 --- a/projects/aas-server/src/app/auth/user-storage.ts +++ b/projects/aas-server/src/app/auth/user-storage.ts @@ -6,7 +6,7 @@ * *****************************************************************************/ -import { UserData } from "./user-data.js"; +import { UserData } from './user-data.js'; /** Defines user storage. */ export abstract class UserStorage { @@ -36,4 +36,4 @@ export abstract class UserStorage { * @returns `true` if the specified user was successfully deleted; otherwise, `false`. */ public abstract deleteAsync(userId: string): Promise; -} \ No newline at end of file +} diff --git a/projects/aas-server/src/app/configuration.ts b/projects/aas-server/src/app/configuration.ts index 09be6eb3..2c47fb4e 100644 --- a/projects/aas-server/src/app/configuration.ts +++ b/projects/aas-server/src/app/configuration.ts @@ -10,7 +10,7 @@ import { AASEndpoint, AASEndpointType } from 'common'; /** The AAS Server configuration. */ export interface AASServerConfiguration { - endpoints: AASEndpoint[] + endpoints: AASEndpoint[]; } /** @@ -41,7 +41,7 @@ export function getEndpointType(url: string | URL): AASEndpointType { return 'AasxDirectory'; case 'http:': case 'https:': - return url.searchParams.get('type') as AASEndpointType ?? 'AasxServer'; + return (url.searchParams.get('type') as AASEndpointType) ?? 'AasxServer'; case 'opc.tcp:': return 'OpcuaServer'; default: @@ -55,7 +55,12 @@ export function getEndpointType(url: string | URL): AASEndpointType { * @param options The container endpoint options or name. * @returns The endpoint URL as string. */ -export function createEndpoint(url: string, name: string, type: AASEndpointType = 'AasxServer', version: string = '3.0'): AASEndpoint { +export function createEndpoint( + url: string, + name: string, + type: AASEndpointType = 'AasxServer', + version: string = '3.0', +): AASEndpoint { return { url, name, type, version }; } @@ -67,7 +72,7 @@ export function createEndpoint(url: string, name: string, type: AASEndpointType export function urlToEndpoint(url: string): AASEndpoint { const value = new URL(url); const name = value.searchParams.get('name'); - const type = value.searchParams.get('type') as AASEndpointType ?? getEndpointType(value); + const type = (value.searchParams.get('type') as AASEndpointType) ?? getEndpointType(value); const version = value.searchParams.get('version') ?? '3.0'; value.search = ''; diff --git a/projects/aas-server/src/app/controller/aas-controller.ts b/projects/aas-server/src/app/controller/aas-controller.ts index 8628b13e..4c86ed69 100644 --- a/projects/aas-server/src/app/controller/aas-controller.ts +++ b/projects/aas-server/src/app/controller/aas-controller.ts @@ -15,8 +15,8 @@ export abstract class AASController extends Controller { protected constructor( protected readonly logger: Logger, protected readonly auth: AuthService, - protected readonly variable: Variable + protected readonly variable: Variable, ) { super(); } -} \ No newline at end of file +} diff --git a/projects/aas-server/src/app/controller/app-controller.ts b/projects/aas-server/src/app/controller/app-controller.ts index 5499beba..2d9b399f 100644 --- a/projects/aas-server/src/app/controller/app-controller.ts +++ b/projects/aas-server/src/app/controller/app-controller.ts @@ -19,11 +19,11 @@ import { Message, PackageInfo } from 'common'; @Route('/api/v1/app') @Tags('App') export class AppController extends AASController { - constructor( + public constructor( @inject('Logger') logger: Logger, @inject(AuthService) auth: AuthService, @inject(Variable) variable: Variable, - @inject(ApplicationInfo) private readonly applicationInfo: ApplicationInfo + @inject(ApplicationInfo) private readonly applicationInfo: ApplicationInfo, ) { super(logger, auth, variable); } @@ -59,4 +59,4 @@ export class AppController extends AASController { this.logger.stop(); } } -} \ No newline at end of file +} diff --git a/projects/aas-server/src/app/controller/auth-controller.ts b/projects/aas-server/src/app/controller/auth-controller.ts index f251ab9d..5e8ab626 100644 --- a/projects/aas-server/src/app/controller/auth-controller.ts +++ b/projects/aas-server/src/app/controller/auth-controller.ts @@ -20,10 +20,10 @@ import { Variable } from '../variable.js'; @Route('/api/v1') @Tags('Authentication') export class AuthController extends AASController { - constructor( + public constructor( @inject('Logger') logger: Logger, @inject(AuthService) auth: AuthService, - @inject(Variable) variable: Variable + @inject(Variable) variable: Variable, ) { super(logger, auth, variable); } @@ -69,8 +69,7 @@ export class AuthController extends AASController { @Put('users/{id}') @Security('bearerAuth', ['editor']) @OperationId('updateProfile') - public updateProfile(@Path() id: string, @Body() profile: UserProfile - ): Promise { + public updateProfile(@Path() id: string, @Body() profile: UserProfile): Promise { return this.auth.updateProfileAsync(decodeBase64Url(id), profile); } @@ -94,7 +93,7 @@ export class AuthController extends AASController { @Security('bearerAuth', ['editor']) @OperationId('deleteUser') public deleteUser(@Path() id: string): Promise { - return this.auth.deleteUserAsync(decodeBase64Url(id)) + return this.auth.deleteUserAsync(decodeBase64Url(id)); } /** @@ -107,7 +106,7 @@ export class AuthController extends AASController { @Security('bearerAuth', ['editor']) @OperationId('getCookie') public getCookie(@Path() id: string, @Path() name: string): Promise { - return this.auth.getCookieAsync(decodeBase64Url(id), name) + return this.auth.getCookieAsync(decodeBase64Url(id), name); } /** @@ -146,4 +145,4 @@ export class AuthController extends AASController { public deleteCookie(@Path() id: string, @Path() name: string): Promise { return this.auth.deleteCookieAsync(decodeBase64Url(id), name); } -} \ No newline at end of file +} diff --git a/projects/aas-server/src/app/controller/authentication.ts b/projects/aas-server/src/app/controller/authentication.ts index 4fc3a3b6..ac541692 100644 --- a/projects/aas-server/src/app/controller/authentication.ts +++ b/projects/aas-server/src/app/controller/authentication.ts @@ -22,10 +22,10 @@ export class Authentication { private static instance?: Authentication; private readonly publicKey: string; - constructor( + public constructor( @inject('Logger') private readonly logger: Logger, @inject(AuthService) private readonly auth: AuthService, - @inject(Variable) private readonly variable: Variable + @inject(Variable) private readonly variable: Variable, ) { if (this.variable.JWT_PUBLIC_KEY) { this.publicKey = fs.readFileSync(this.variable.JWT_PUBLIC_KEY, 'utf8'); @@ -49,7 +49,7 @@ export class Authentication { } if (payload.role === 'admin' || payload.role === 'editor') { - if (!payload.sub || !await this.auth.hasUserAsync(payload.sub)) { + if (!payload.sub || !(await this.auth.hasUserAsync(payload.sub))) { throw new ApplicationError('Unauthorized access.', ERRORS.UnauthorizedAccess); } } else if (payload.role !== 'guest') { diff --git a/projects/aas-server/src/app/controller/containers-controller.ts b/projects/aas-server/src/app/controller/containers-controller.ts index 21fa596e..bb2e9fb0 100644 --- a/projects/aas-server/src/app/controller/containers-controller.ts +++ b/projects/aas-server/src/app/controller/containers-controller.ts @@ -8,7 +8,21 @@ import { inject, injectable } from 'tsyringe'; import fs from 'fs'; -import { Body, Delete, Get, OperationId, Path, Post, Put, Queries, Route, Security, Tags, UploadedFile, UploadedFiles } from 'tsoa'; +import { + Body, + Delete, + Get, + OperationId, + Path, + Post, + Put, + Queries, + Route, + Security, + Tags, + UploadedFile, + UploadedFiles, +} from 'tsoa'; import { AASDocument, aas } from 'common'; import { AASProvider } from '../aas-provider/aas-provider.js'; @@ -22,11 +36,11 @@ import { Variable } from '../variable.js'; @Route('/api/v1/containers') @Tags('Containers') export class ContainersController extends AASController { - constructor( + public constructor( @inject('Logger') logger: Logger, @inject(AuthService) auth: AuthService, @inject(Variable) variable: Variable, - @inject(AASProvider) private readonly aasProvider: AASProvider + @inject(AASProvider) private readonly aasProvider: AASProvider, ) { super(logger, auth, variable); } @@ -110,7 +124,10 @@ export class ContainersController extends AASController { @Get('{endpoint}/documents/{id}/content') @Security('bearerAuth', ['guest']) @OperationId('getDocumentContent') - public async getDocumentContent(@Path() endpoint: string, @Path() id: string): Promise { + public async getDocumentContent( + @Path() endpoint: string, + @Path() id: string, + ): Promise { try { this.logger.start('getDocumentContent'); return await this.aasProvider.getContentAsync(decodeBase64Url(endpoint), decodeBase64Url(id)); @@ -118,7 +135,7 @@ export class ContainersController extends AASController { this.logger.stop(); } } - + /** * @summary Gets the thumbnail of the specified AAS document. * @param endpoint The endpoint name (Base64Url encoded). @@ -128,7 +145,10 @@ export class ContainersController extends AASController { @Get('{endpoint}/documents/{id}/thumbnail') @Security('bearerAuth', ['guest']) @OperationId('getDocumentThumbnail') - public async getDocumentThumbnail(@Path() endpoint: string, @Path() id: string): Promise { + public async getDocumentThumbnail( + @Path() endpoint: string, + @Path() id: string, + ): Promise { try { this.logger.start('getDocumentThumbnail'); return await this.aasProvider.getThumbnailAsync(decodeBase64Url(endpoint), decodeBase64Url(id)); @@ -155,7 +175,7 @@ export class ContainersController extends AASController { @Path() id: string, @Path() smId: string, @Path() path: string, - @Queries() queryParams: { width?: number, height?: number }, + @Queries() queryParams: { width?: number; height?: number }, ): Promise { try { this.logger.start('getDataElementValue'); @@ -164,7 +184,8 @@ export class ContainersController extends AASController { decodeBase64Url(id), decodeBase64Url(smId), path, - queryParams); + queryParams, + ); } finally { this.logger.stop(); } @@ -183,7 +204,7 @@ export class ContainersController extends AASController { public async updateDocument( @Path() endpoint: string, @Path() id: string, - @UploadedFile() content: Express.Multer.File + @UploadedFile() content: Express.Multer.File, ): Promise { try { this.logger.start('updateDocument'); @@ -208,7 +229,7 @@ export class ContainersController extends AASController { public async invokeOperation( @Path() endpoint: string, @Path() id: string, - @Body() operation: aas.Operation + @Body() operation: aas.Operation, ): Promise { try { this.logger.start('invokeOperation'); @@ -235,5 +256,4 @@ export class ContainersController extends AASController { this.logger.stop(); } } - -} \ No newline at end of file +} diff --git a/projects/aas-server/src/app/controller/documents-controller.ts b/projects/aas-server/src/app/controller/documents-controller.ts index adbb7022..e9de8dbf 100644 --- a/projects/aas-server/src/app/controller/documents-controller.ts +++ b/projects/aas-server/src/app/controller/documents-controller.ts @@ -20,11 +20,11 @@ import { decodeBase64Url } from '../convert.js'; @Route('/api/v1/documents') @Tags('Documents') export class DocumentsController extends AASController { - constructor( + public constructor( @inject('Logger') logger: Logger, @inject(AuthService) auth: AuthService, @inject(Variable) variable: Variable, - @inject(AASProvider) private readonly aasProvider: AASProvider + @inject(AASProvider) private readonly aasProvider: AASProvider, ) { super(logger, auth, variable); } @@ -39,9 +39,10 @@ export class DocumentsController extends AASController { @Security('bearerAuth', ['guest']) @OperationId('getDocuments') public async getDocuments( - @Query() cursor: string, - @Query() filter?:string, - @Query() language?: string): Promise { + @Query() cursor: string, + @Query() filter?: string, + @Query() language?: string, + ): Promise { try { this.logger.start('getDocuments'); if (filter) { @@ -70,4 +71,4 @@ export class DocumentsController extends AASController { this.logger.stop(); } } -} \ No newline at end of file +} diff --git a/projects/aas-server/src/app/controller/endpoints-controller.ts b/projects/aas-server/src/app/controller/endpoints-controller.ts index a9c264ff..99603618 100644 --- a/projects/aas-server/src/app/controller/endpoints-controller.ts +++ b/projects/aas-server/src/app/controller/endpoints-controller.ts @@ -20,11 +20,11 @@ import { Variable } from '../variable.js'; @Route('/api/v1/endpoints') @Tags('Endpoints') export class EndpointsController extends AASController { - constructor( + public constructor( @inject('Logger') logger: Logger, @inject(AuthService) auth: AuthService, @inject(Variable) variable: Variable, - @inject(AASProvider) private readonly aasProvider: AASProvider + @inject(AASProvider) private readonly aasProvider: AASProvider, ) { super(logger, auth, variable); } @@ -67,7 +67,7 @@ export class EndpointsController extends AASController { public deleteEndpoint(@Path() name: string): Promise { return this.aasProvider.removeEndpointAsync(name); } - + /** * @summary Resets the AASServer container configuration. */ @@ -82,4 +82,4 @@ export class EndpointsController extends AASController { this.logger.stop(); } } -} \ No newline at end of file +} diff --git a/projects/aas-server/src/app/controller/ioc-container.ts b/projects/aas-server/src/app/controller/ioc-container.ts index e03cd928..4394c940 100644 --- a/projects/aas-server/src/app/controller/ioc-container.ts +++ b/projects/aas-server/src/app/controller/ioc-container.ts @@ -13,4 +13,4 @@ export const iocContainer: IocContainer = { get: (controller: { prototype: T }): T => { return container.resolve(controller as never); }, -}; \ No newline at end of file +}; diff --git a/projects/aas-server/src/app/controller/templates-controller.ts b/projects/aas-server/src/app/controller/templates-controller.ts index f4082072..27fd12b1 100644 --- a/projects/aas-server/src/app/controller/templates-controller.ts +++ b/projects/aas-server/src/app/controller/templates-controller.ts @@ -22,11 +22,11 @@ import { TemplateStorage } from '../template/template-storage.js'; @Route('/api/v1/templates') @Tags('Templates') export class TemplatesController extends AASController { - constructor( + public constructor( @inject('Logger') logger: Logger, @inject(AuthService) auth: AuthService, @inject(Variable) variable: Variable, - @inject('TemplateStorage') private readonly templateStorage: TemplateStorage + @inject('TemplateStorage') private readonly templateStorage: TemplateStorage, ) { super(logger, auth, variable); } @@ -46,4 +46,4 @@ export class TemplatesController extends AASController { this.logger.stop(); } } -} \ No newline at end of file +} diff --git a/projects/aas-server/src/app/convert.ts b/projects/aas-server/src/app/convert.ts index fe0e0b83..21573ddc 100644 --- a/projects/aas-server/src/app/convert.ts +++ b/projects/aas-server/src/app/convert.ts @@ -7,7 +7,7 @@ *****************************************************************************/ import { ApplicationError } from 'common'; -import { ERRORS } from "./errors.js"; +import { ERRORS } from './errors.js'; export function decodeBase64Url(data: string): string { return Buffer.from(data, 'base64url').toString('ascii'); @@ -25,7 +25,8 @@ export function parseUrl(url: string): URL { `"${url}" is an invalid URL: ${error?.message}`, ERRORS.InvalidURL, url, - error?.message); + error?.message, + ); } } diff --git a/projects/aas-server/src/app/errors.ts b/projects/aas-server/src/app/errors.ts index df1ab52d..3ac1c12a 100644 --- a/projects/aas-server/src/app/errors.ts +++ b/projects/aas-server/src/app/errors.ts @@ -26,5 +26,5 @@ export const ERRORS = { InvalidURL: 'ERROR_INVALID_URL', DeleteAASNotSupported: 'ERROR_DELETE_AAS_NOT_SUPPORTED', InvalidContainerUrl: 'ERROR_INVALID_CONTAINER_URL', - InvokeOperationFailed: 'ERROR_INVOKE_OPERATION_FAILED' -}; \ No newline at end of file + InvokeOperationFailed: 'ERROR_INVOKE_OPERATION_FAILED', +}; diff --git a/projects/aas-server/src/app/file-storage/file-storage-factory.ts b/projects/aas-server/src/app/file-storage/file-storage-factory.ts index cc4226ca..4a4766cb 100644 --- a/projects/aas-server/src/app/file-storage/file-storage-factory.ts +++ b/projects/aas-server/src/app/file-storage/file-storage-factory.ts @@ -8,17 +8,14 @@ import path from 'path'; import { inject, singleton } from 'tsyringe'; -import { FileStorage } from "./file-storage.js"; -import { LocalFileStorage } from "./local-file-storage.js"; +import { FileStorage } from './file-storage.js'; +import { LocalFileStorage } from './local-file-storage.js'; import { parseUrl } from '../convert.js'; import { Variable } from '../variable.js'; @singleton() export class FileStorageFactory { - constructor( - @inject(Variable) private readonly variable: Variable - ) { - } + public constructor(@inject(Variable) private readonly variable: Variable) {} /** * Creates a FileStorage for the specified URL. @@ -31,6 +28,6 @@ export class FileStorageFactory { return new LocalFileStorage(path.join(this.variable.ASSETS, temp.pathname)); } - throw new Error('Not implemented.') + throw new Error('Not implemented.'); } -} \ No newline at end of file +} diff --git a/projects/aas-server/src/app/file-storage/local-file-storage.ts b/projects/aas-server/src/app/file-storage/local-file-storage.ts index 728065cf..97be01d7 100644 --- a/projects/aas-server/src/app/file-storage/local-file-storage.ts +++ b/projects/aas-server/src/app/file-storage/local-file-storage.ts @@ -11,7 +11,7 @@ import { resolve } from 'path'; import { FileStorage } from './file-storage.js'; export class LocalFileStorage extends FileStorage { - constructor(root: string) { + public constructor(root: string) { super(); this.root = resolve(root); @@ -58,4 +58,4 @@ export class LocalFileStorage extends FileStorage { public createReadStream(path: string): NodeJS.ReadableStream { return fs.createReadStream(resolve(this.root, path)); } -} \ No newline at end of file +} diff --git a/projects/aas-server/src/app/file-storage/own-cloud-storage.ts b/projects/aas-server/src/app/file-storage/own-cloud-storage.ts index bb1e0fec..bfddd430 100644 --- a/projects/aas-server/src/app/file-storage/own-cloud-storage.ts +++ b/projects/aas-server/src/app/file-storage/own-cloud-storage.ts @@ -13,7 +13,7 @@ export class OwnCloudStorage extends FileStorage { private promise: Promise; private oc: ownCloud; - constructor(arg: string | URL) { + public constructor(arg: string | URL) { super(); const url = typeof arg === 'string' ? new URL(arg) : arg; @@ -23,8 +23,8 @@ export class OwnCloudStorage extends FileStorage { url.password = ''; const options: OwnCloudOptions = { - baseUrl: url.href - } + baseUrl: url.href, + }; if (username && password) { options.auth = { basic: { username, password } }; @@ -36,34 +36,29 @@ export class OwnCloudStorage extends FileStorage { public readonly root: string = '/'; + // eslint-disable-next-line @typescript-eslint/no-unused-vars public mtime(path: string): Promise { throw new Error('Method not implemented.'); } public async exists(path: string): Promise { - try { - await this.promise; - const fileInfo = await this.oc.files.fileInfo(path, {}); - return fileInfo != null; - } catch (error) { - throw error; - } + await this.promise; + const fileInfo = await this.oc.files.fileInfo(path, {}); + return fileInfo != null; } public async isDirectory(path: string): Promise { - try { - await this.promise; - const fileInfo = await this.oc.files.fileInfo(path, {}); - return fileInfo.isDir(); - } catch (error) { - throw error; - } + await this.promise; + const fileInfo = await this.oc.files.fileInfo(path, {}); + return fileInfo.isDir(); } + // eslint-disable-next-line @typescript-eslint/no-unused-vars public mkdir(path: string, recursive?: boolean | undefined): Promise { throw new Error('Method not implemented.'); } + // eslint-disable-next-line @typescript-eslint/no-unused-vars public writeFile(path: string, data: string | Buffer): Promise { throw new Error('Method not implemented.'); } @@ -75,19 +70,23 @@ export class OwnCloudStorage extends FileStorage { return []; } + // eslint-disable-next-line @typescript-eslint/no-unused-vars public readFile(path: string): Promise { throw new Error('Method not implemented.'); } + // eslint-disable-next-line @typescript-eslint/no-unused-vars public unlink(path: string): Promise { throw new Error('Method not implemented.'); } - public rename(oldPath: string, newPath: string): Promise { + // eslint-disable-next-line @typescript-eslint/no-unused-vars + public override rename(oldPath: string, newPath: string): Promise { throw new Error('Method not implemented.'); } + // eslint-disable-next-line @typescript-eslint/no-unused-vars public createReadStream(path: string): NodeJS.ReadableStream { throw new Error('Method not implemented.'); } -} \ No newline at end of file +} diff --git a/projects/aas-server/src/app/image-processing.ts b/projects/aas-server/src/app/image-processing.ts index d3db143c..378b40b1 100644 --- a/projects/aas-server/src/app/image-processing.ts +++ b/projects/aas-server/src/app/image-processing.ts @@ -19,9 +19,10 @@ export class ImageProcessing { * @returns The resized image. */ public static async resizeAsync( - source: NodeJS.ReadableStream, - width: number | undefined, - height: number | undefined): Promise { + source: NodeJS.ReadableStream, + width: number | undefined, + height: number | undefined, + ): Promise { const buffer: Buffer = await new Promise((resolve, reject) => { const buffers: Uint8Array[] = []; source.on('data', function (buffer: Uint8Array) { @@ -80,4 +81,4 @@ export class ImageProcessing { stream.push(null); return stream; } -} \ No newline at end of file +} diff --git a/projects/aas-server/src/app/lazy.ts b/projects/aas-server/src/app/lazy.ts index 421c9571..f8f3b803 100644 --- a/projects/aas-server/src/app/lazy.ts +++ b/projects/aas-server/src/app/lazy.ts @@ -16,10 +16,10 @@ export class Lazy { private _value?: T; /** - * - * @param initialize The + * + * @param initialize The */ - constructor(initialize: () => Promise) { + public constructor(initialize: () => Promise) { this.initialize = initialize; } @@ -42,4 +42,4 @@ export class Lazy { return this._value; } -} \ No newline at end of file +} diff --git a/projects/aas-server/src/app/live/empty-subscription.ts b/projects/aas-server/src/app/live/empty-subscription.ts index 4ae17f5f..1a2dd3db 100644 --- a/projects/aas-server/src/app/live/empty-subscription.ts +++ b/projects/aas-server/src/app/live/empty-subscription.ts @@ -7,7 +7,7 @@ *****************************************************************************/ import { noop } from 'lodash-es'; -import { SocketSubscription } from "./socket-subscription.js"; +import { SocketSubscription } from './socket-subscription.js'; /** Provides an empty WebSocket subscription. */ export class EmptySubscription extends SocketSubscription { @@ -18,4 +18,4 @@ export class EmptySubscription extends SocketSubscription { public close(): void { noop(); } -} \ No newline at end of file +} diff --git a/projects/aas-server/src/app/live/http/http-socket-item.ts b/projects/aas-server/src/app/live/http/http-socket-item.ts index 9f38a9f3..9710f5de 100644 --- a/projects/aas-server/src/app/live/http/http-socket-item.ts +++ b/projects/aas-server/src/app/live/http/http-socket-item.ts @@ -11,10 +11,10 @@ import { SocketItem } from '../socket-item.js'; import { noop } from 'lodash-es'; export class HttpSocketItem implements SocketItem { - constructor( - public readonly node: LiveNode, - public readonly url: string) { - } + public constructor( + public readonly node: LiveNode, + public readonly url: string, + ) {} public subscribe(): void { noop(); @@ -23,4 +23,4 @@ export class HttpSocketItem implements SocketItem { public unsubscribe(): void { noop(); } - } \ No newline at end of file +} diff --git a/projects/aas-server/src/app/live/http/http-subscription.ts b/projects/aas-server/src/app/live/http/http-subscription.ts index 3ff438e1..8f62eec9 100644 --- a/projects/aas-server/src/app/live/http/http-subscription.ts +++ b/projects/aas-server/src/app/live/http/http-subscription.ts @@ -6,30 +6,31 @@ * *****************************************************************************/ -import { noop } from "lodash-es"; -import { aas, changeType, LiveNode, LiveRequest } from "common"; -import { HttpSocketItem } from "./http-socket-item.js"; -import { Logger } from "../../logging/logger.js"; -import { SocketClient } from "../socket-client.js"; -import { AasxServer } from "../../packages/aasx-server/aasx-server.js"; -import { SocketSubscription } from "../socket-subscription.js"; +import { noop } from 'lodash-es'; +import { aas, changeType, LiveNode, LiveRequest } from 'common'; +import { HttpSocketItem } from './http-socket-item.js'; +import { Logger } from '../../logging/logger.js'; +import { SocketClient } from '../socket-client.js'; +import { AasxServer } from '../../packages/aasx-server/aasx-server.js'; +import { SocketSubscription } from '../socket-subscription.js'; export class HttpSubscription extends SocketSubscription { private readonly items: HttpSocketItem[]; private timeout = 300; private timeoutId?: NodeJS.Timeout; - constructor( + public constructor( private readonly logger: Logger, private readonly server: AasxServer, private readonly client: SocketClient, message: LiveRequest, - env: aas.Environment) { + env: aas.Environment, + ) { super(); - this.items = message.nodes.map(node => new HttpSocketItem( - node, - server.resolveNodeId(env.assetAdministrationShells[0], node.nodeId))); + this.items = message.nodes.map( + node => new HttpSocketItem(node, server.resolveNodeId(env.assetAdministrationShells[0], node.nodeId)), + ); } public open(): void { @@ -54,7 +55,8 @@ export class HttpSubscription extends SocketSubscription { try { item.node.value = changeType( await this.server.readValueAsync(item.url, item.node.valueType), - item.node.valueType); + item.node.valueType, + ); item.node.timeStamp = Date.now(); nodes.push(item.node); @@ -65,11 +67,11 @@ export class HttpSubscription extends SocketSubscription { if (nodes.length > 0) { this.client.notify({ - type: "LiveNode[]", - data: nodes + type: 'LiveNode[]', + data: nodes, }); } this.timeoutId = setTimeout(this.readValues.bind(this), this.timeout); } -} \ No newline at end of file +} diff --git a/projects/aas-server/src/app/live/opcua/opcua-socket-item.ts b/projects/aas-server/src/app/live/opcua/opcua-socket-item.ts index f1ce717d..78ea5654 100644 --- a/projects/aas-server/src/app/live/opcua/opcua-socket-item.ts +++ b/projects/aas-server/src/app/live/opcua/opcua-socket-item.ts @@ -10,16 +10,16 @@ import { ClientMonitoredItem, DataValue } from 'node-opcua'; import { Logger } from '../../logging/logger.js'; import { LiveNode } from 'common'; import { SocketItem } from '../socket-item.js'; -import { SocketClient }from '../socket-client.js'; +import { SocketClient } from '../socket-client.js'; export class OpcuaSocketItem implements SocketItem { private item?: ClientMonitoredItem; - constructor( - private readonly logger: Logger, - private readonly client: SocketClient, - public readonly node: LiveNode) { - } + public constructor( + private readonly logger: Logger, + private readonly client: SocketClient, + public readonly node: LiveNode, + ) {} public subscribe(item: ClientMonitoredItem): void { this.item = item; @@ -40,11 +40,11 @@ export class OpcuaSocketItem implements SocketItem { this.node.timeStamp = dataValue.serverTimestamp?.valueOf(); this.client.notify({ type: 'LiveNode[]', - data: [this.node] + data: [this.node], }); - } + }; private onError = (message: string): void => { this.logger.error(message); - } -} \ No newline at end of file + }; +} diff --git a/projects/aas-server/src/app/live/opcua/opcua-subscription.ts b/projects/aas-server/src/app/live/opcua/opcua-subscription.ts index 6da00aca..abb5c614 100644 --- a/projects/aas-server/src/app/live/opcua/opcua-subscription.ts +++ b/projects/aas-server/src/app/live/opcua/opcua-subscription.ts @@ -19,7 +19,7 @@ import { MonitoringParametersOptions, NodeId, ReadValueIdOptions, - TimestampsToReturn + TimestampsToReturn, } from 'node-opcua'; export class OpcuaSubscription extends SocketSubscription { @@ -27,7 +27,12 @@ export class OpcuaSubscription extends SocketSubscription { private readonly items: OpcuaSocketItem[]; private subscription?: ClientSubscription; - constructor(private readonly logger: Logger, client: SocketClient, server: OpcuaServer, nodes: LiveNode[]) { + public constructor( + private readonly logger: Logger, + client: SocketClient, + server: OpcuaServer, + nodes: LiveNode[], + ) { super(); this.server = server; @@ -41,10 +46,11 @@ export class OpcuaSubscription extends SocketSubscription { requestedMaxKeepAliveCount: 10, maxNotificationsPerPublish: 100, publishingEnabled: true, - priority: 10 + priority: 10, }); - this.subscription.on('started', this.onSubscriptionStarted) + this.subscription + .on('started', this.onSubscriptionStarted) .on('keepalive', this.onSubscriptionKeepAlive) .on('terminated', this.onSubscriptionTerminated) .on('error', this.onSubscriptionError) @@ -53,20 +59,20 @@ export class OpcuaSubscription extends SocketSubscription { for (const item of this.items as OpcuaSocketItem[]) { const itemToMonitor: ReadValueIdOptions = { nodeId: NodeId.resolveNodeId(item.node.nodeId), - attributeId: AttributeIds.Value + attributeId: AttributeIds.Value, }; const parameters: MonitoringParametersOptions = { samplingInterval: 100, discardOldest: true, - queueSize: 10 + queueSize: 10, }; const monitoredItem = ClientMonitoredItem.create( this.subscription, itemToMonitor, parameters, - TimestampsToReturn.Both + TimestampsToReturn.Both, ); item.subscribe(monitoredItem); @@ -77,7 +83,8 @@ export class OpcuaSubscription extends SocketSubscription { this.items?.forEach(item => item.unsubscribe()); if (this.subscription) { - this.subscription.off('started', this.onSubscriptionStarted) + this.subscription + .off('started', this.onSubscriptionStarted) .off('keepalive', this.onSubscriptionKeepAlive) .off('terminated', this.onSubscriptionTerminated) .off('error', this.onSubscriptionError) @@ -89,17 +96,17 @@ export class OpcuaSubscription extends SocketSubscription { private onSubscriptionStarted = (subscriptionId: number): void => { this.logger.debug(`Subscription ${subscriptionId} started.`); - } + }; private onSubscriptionKeepAlive = (): void => { this.logger.debug(`Subscription ${this.subscription?.subscriptionId} keep alive.`); - } + }; private onSubscriptionTerminated = (): void => { this.logger.debug(`Subscription ${this.subscription?.subscriptionId} terminated.`); - } + }; private onSubscriptionError = (error: Error): void => { this.logger.error(error); - } -} \ No newline at end of file + }; +} diff --git a/projects/aas-server/src/app/live/socket-client.ts b/projects/aas-server/src/app/live/socket-client.ts index 81ef2835..14aa89c8 100644 --- a/projects/aas-server/src/app/live/socket-client.ts +++ b/projects/aas-server/src/app/live/socket-client.ts @@ -15,7 +15,7 @@ export class SocketClient extends EventEmitter { private readonly ws: WebSocket; private readonly subscriptions = new Map(); - constructor(ws: WebSocket) { + public constructor(ws: WebSocket) { super(); this.ws = ws; @@ -50,7 +50,7 @@ export class SocketClient extends EventEmitter { data = JSON.parse(rawData.toString()); this.emit('message', data, this); } - } + }; private onClose = (code: number, reason: string): void => { this.ws.removeAllListeners(); @@ -62,9 +62,9 @@ export class SocketClient extends EventEmitter { this.subscriptions.clear(); this.emit('close', code, reason, this); - } + }; private onError = (error: Error): void => { this.emit('error', error, this); - } -} \ No newline at end of file + }; +} diff --git a/projects/aas-server/src/app/live/socket-item.ts b/projects/aas-server/src/app/live/socket-item.ts index a37e826e..6bdea60b 100644 --- a/projects/aas-server/src/app/live/socket-item.ts +++ b/projects/aas-server/src/app/live/socket-item.ts @@ -6,10 +6,10 @@ * *****************************************************************************/ -import { LiveNode } from "common"; +import { LiveNode } from 'common'; export interface SocketItem { node: LiveNode; - subscribe(item: any): void; + subscribe(item: unknown): void; unsubscribe(): void; -} \ No newline at end of file +} diff --git a/projects/aas-server/src/app/live/socket-subscription.ts b/projects/aas-server/src/app/live/socket-subscription.ts index 84787a3f..fa98b795 100644 --- a/projects/aas-server/src/app/live/socket-subscription.ts +++ b/projects/aas-server/src/app/live/socket-subscription.ts @@ -13,4 +13,4 @@ export abstract class SocketSubscription { /** Closes the subscription. */ public abstract close(): void; -} \ No newline at end of file +} diff --git a/projects/aas-server/src/app/logging/file-logger.ts b/projects/aas-server/src/app/logging/file-logger.ts index 00985c6d..d3a14721 100644 --- a/projects/aas-server/src/app/logging/file-logger.ts +++ b/projects/aas-server/src/app/logging/file-logger.ts @@ -26,16 +26,14 @@ export class FileLogger extends Logger { private readonly defaultRecord: Record = { errors: new Map(), warnings: new Map(), - messages: new Map() + messages: new Map(), }; private record = this.defaultRecord; private recording = 0; private context: string | null = null; - constructor( - @inject('winston.Logger') private readonly logger: winston.Logger - ) { + public constructor(@inject('winston.Logger') private readonly logger: winston.Logger) { super(); } @@ -106,7 +104,7 @@ export class FileLogger extends Logger { } if (text) { - this.logger.debug(text) + this.logger.debug(text); } } } @@ -127,7 +125,7 @@ export class FileLogger extends Logger { if (this.logger.isInfoEnabled()) { this.record.messages.set(message.text, message.timestamp); } - break + break; } } @@ -139,7 +137,7 @@ export class FileLogger extends Logger { record = { errors: new Map(), warnings: new Map(), - messages: new Map() + messages: new Map(), }; this.records.set(context, record); @@ -180,4 +178,4 @@ export class FileLogger extends Logger { return messages.sort((a, b) => a.timestamp - b.timestamp); } -} \ No newline at end of file +} diff --git a/projects/aas-server/src/app/logging/logger-factory.ts b/projects/aas-server/src/app/logging/logger-factory.ts index 1ef0b09c..93f97ddb 100644 --- a/projects/aas-server/src/app/logging/logger-factory.ts +++ b/projects/aas-server/src/app/logging/logger-factory.ts @@ -30,13 +30,12 @@ export class LoggerFactory { zippedArchive: false, maxSize: '20m', maxFiles: '2d', - format: winston.format.combine( - winston.format.timestamp(), - winston.format.json()) + format: winston.format.combine(winston.format.timestamp(), winston.format.json()), }), new winston.transports.Console({ format: winston.format.simple(), - })] + }), + ], }); } @@ -52,4 +51,4 @@ export class LoggerFactory { } } } -} \ No newline at end of file +} diff --git a/projects/aas-server/src/app/logging/logger.ts b/projects/aas-server/src/app/logging/logger.ts index 4affe40a..e8d1654e 100644 --- a/projects/aas-server/src/app/logging/logger.ts +++ b/projects/aas-server/src/app/logging/logger.ts @@ -6,7 +6,7 @@ * *****************************************************************************/ -import { Message, MessageType } from "common"; +import { Message, MessageType } from 'common'; import { singleton } from 'tsyringe'; /** @@ -15,7 +15,7 @@ import { singleton } from 'tsyringe'; export abstract class Logger { /** * Logs an error. - * @param error + * @param error * @param args Additional arguments. */ public abstract error(error: Error | string, ...args: unknown[]): void; @@ -46,7 +46,7 @@ export abstract class Logger { * @param message The message. */ public abstract log(message: Message): void; - + /** * Starts the message recording for the specified context. * @param context The context name. @@ -75,4 +75,4 @@ export class DebugConsole { public debug(message: string | Error): void { console.debug(message); } -} \ No newline at end of file +} diff --git a/projects/aas-server/src/app/logging/memory-logger.ts b/projects/aas-server/src/app/logging/memory-logger.ts index 082aedc5..9928662c 100644 --- a/projects/aas-server/src/app/logging/memory-logger.ts +++ b/projects/aas-server/src/app/logging/memory-logger.ts @@ -16,7 +16,7 @@ export enum MemoryLoggerLevel { Info = 2, Warning = 3, Error = 4, - Non = 5 + Non = 5, } @singleton() @@ -26,14 +26,14 @@ export class MemoryLogger extends Logger { private readonly messages = new Map(); private recording = 0; - constructor( + public constructor( @inject('LOG_LEVEL') private readonly logLevel: MemoryLoggerLevel, - @inject(DebugConsole) private readonly console: DebugConsole + @inject(DebugConsole) private readonly console: DebugConsole, ) { super(); } - public error(error: string | Error, ...args: any[]): void { + public error(error: string | Error, ...args: unknown[]): void { if (this.logLevel <= MemoryLoggerLevel.Error) { let text: string | undefined; if (error) { @@ -50,7 +50,7 @@ export class MemoryLogger extends Logger { } } - public warning(message: string, ...args: any[]): void { + public warning(message: string, ...args: unknown[]): void { if (this.logLevel <= MemoryLoggerLevel.Warning) { if (typeof message === 'string') { this.warnings.set(stringFormat(message, args), Date.now()); @@ -58,7 +58,7 @@ export class MemoryLogger extends Logger { } } - public info(message: string, ...args: any[]): void { + public info(message: string, ...args: unknown[]): void { if (this.logLevel <= MemoryLoggerLevel.Info) { if (typeof message === 'string') { this.messages.set(stringFormat(message, args), Date.now()); @@ -66,7 +66,7 @@ export class MemoryLogger extends Logger { } } - public debug(message: string | Error, ...args: any[]): void { + public debug(message: string | Error, ...args: unknown[]): void { if (this.logLevel <= MemoryLoggerLevel.Debug) { { let text: string | undefined; @@ -101,10 +101,11 @@ export class MemoryLogger extends Logger { if (this.logLevel <= MemoryLoggerLevel.Info) { this.messages.set(message.text, message.timestamp); } - break + break; } } + // eslint-disable-next-line @typescript-eslint/no-unused-vars public start(context: string): boolean { if (this.recording === 0) { this.errors.clear(); @@ -126,7 +127,7 @@ export class MemoryLogger extends Logger { } public getMessages(): Message[] { - const messages: Message[] = [] + const messages: Message[] = []; for (const tuple of this.errors) { messages.push(createMessage('Error', tuple[0], tuple[1])); } @@ -141,4 +142,4 @@ export class MemoryLogger extends Logger { return messages.sort((a, b) => a.timestamp - b.timestamp); } -} \ No newline at end of file +} diff --git a/projects/aas-server/src/app/mailer.ts b/projects/aas-server/src/app/mailer.ts index 272dd0ee..b1071142 100644 --- a/projects/aas-server/src/app/mailer.ts +++ b/projects/aas-server/src/app/mailer.ts @@ -7,24 +7,22 @@ *****************************************************************************/ import { inject, singleton } from 'tsyringe'; -import nodemailer from "nodemailer"; -import { Logger } from "./logging/logger.js"; +import nodemailer from 'nodemailer'; +import { Logger } from './logging/logger.js'; @singleton() export class Mailer { - private transporter: any; - - constructor( - @inject('Logger') private readonly logger: Logger) { + private transporter: unknown; + public constructor(@inject('Logger') private readonly logger: Logger) { this.transporter = nodemailer.createTransport({ - host: "smtp.example.com", + host: 'smtp.example.com', port: 587, secure: false, auth: { - user: "username", - pass: "password" - } + user: 'username', + pass: 'password', + }, }); } @@ -32,6 +30,7 @@ export class Mailer { * Sends a new password to the specified e-mail. * @param email The e-mail address. */ + // eslint-disable-next-line @typescript-eslint/no-unused-vars public sendNewPassword(email: string, password: string): void { throw new Error('Sending e-mails not implemented'); } @@ -40,7 +39,8 @@ export class Mailer { * Sends an initial password to a new user withe the specified e-mail. * @param email The e-mail of the new user. */ + // eslint-disable-next-line @typescript-eslint/no-unused-vars public sendPassword(email: string, password: string) { throw new Error('Sending e-mails not implemented'); } -} \ No newline at end of file +} diff --git a/projects/aas-server/src/app/packages/aas-package.ts b/projects/aas-server/src/app/packages/aas-package.ts index 21518abe..33ddcdf8 100644 --- a/projects/aas-server/src/app/packages/aas-package.ts +++ b/projects/aas-server/src/app/packages/aas-package.ts @@ -6,8 +6,8 @@ * *****************************************************************************/ -import { AASDocument, Crc32, aas, flat } from "common"; -import { Logger } from "../logging/logger.js"; +import { AASDocument, Crc32, aas, flat } from 'common'; +import { Logger } from '../logging/logger.js'; /** * Represents a package that contains an Asset Administration Shell. @@ -15,14 +15,14 @@ import { Logger } from "../logging/logger.js"; export abstract class AASPackage { protected readonly logger: Logger; - constructor(logger: Logger) { + protected constructor(logger: Logger) { this.logger = logger; } /** Gets the document that contains an Asset Administration Shell. */ public abstract createDocumentAsync(): Promise; - /** + /** * Gets the thumbnail of the current Asset Administration Shell. * @param id The identifier of AAS. */ @@ -83,7 +83,7 @@ export abstract class AASPackage { switch (referable.modelType) { case 'Property': { - const property: aas.Property = { ...referable as aas.Property }; + const property: aas.Property = { ...(referable as aas.Property) }; if (property.category !== 'CONSTANT' && property.category !== 'PARAMETER') { delete property.value; } @@ -93,32 +93,34 @@ export abstract class AASPackage { break; case 'Submodel': { - const sm: aas.Submodel = { ...referable as aas.Submodel }; + const sm: aas.Submodel = { ...(referable as aas.Submodel) }; delete sm.submodelElements; crc.add(JSON.stringify(sm)); } break; case 'SubmodelElementCollection': { - const collection: aas.SubmodelElementCollection = { ...referable as aas.SubmodelElementCollection }; + const collection: aas.SubmodelElementCollection = { + ...(referable as aas.SubmodelElementCollection), + }; delete collection.value; crc.add(JSON.stringify(collection)); } break; case 'SubmodelElementList': { - const list: aas.SubmodelElementList = { ...referable as aas.SubmodelElementList }; + const list: aas.SubmodelElementList = { ...(referable as aas.SubmodelElementList) }; delete list.value; crc.add(JSON.stringify(list)); } break; default: crc.add(JSON.stringify(referable)); - break + break; } } } return crc.end(); } -} \ No newline at end of file +} diff --git a/projects/aas-server/src/app/packages/aas-reader.ts b/projects/aas-server/src/app/packages/aas-reader.ts index 38155223..ca80cc2d 100644 --- a/projects/aas-server/src/app/packages/aas-reader.ts +++ b/projects/aas-server/src/app/packages/aas-reader.ts @@ -9,7 +9,6 @@ import { aas } from 'common'; export abstract class AASReader { - public abstract readEnvironment(): aas.Environment; public abstract read(data: string | object): aas.Referable; @@ -34,7 +33,7 @@ export abstract class AASReader { return path; } - + protected createReference(parent: aas.Reference, child: aas.Referable): aas.Reference { return { type: 'ModelReference', @@ -43,7 +42,8 @@ export abstract class AASReader { { type: child.modelType as aas.KeyTypes, value: child.idShort, - }] + }, + ], }; } -} \ No newline at end of file +} diff --git a/projects/aas-server/src/app/packages/aas-resource-factory.ts b/projects/aas-server/src/app/packages/aas-resource-factory.ts index 945d7143..47b9cc34 100644 --- a/projects/aas-server/src/app/packages/aas-resource-factory.ts +++ b/projects/aas-server/src/app/packages/aas-resource-factory.ts @@ -8,22 +8,22 @@ import { inject, singleton } from 'tsyringe'; import { AASEndpoint, ApplicationError } from 'common'; -import { Logger } from "../logging/logger.js"; -import { AASResource } from "./aas-resource.js"; -import { AasxDirectory } from "./aasx-directory/aasx-directory.js"; -import { AasxServerV0 } from "./aasx-server/aasx-server-v0.js"; -import { AasxServerV3 } from "./aasx-server/aasx-server-v3.js"; -import { OpcuaServer } from "./opcua/opcua-server.js"; +import { Logger } from '../logging/logger.js'; +import { AASResource } from './aas-resource.js'; +import { AasxDirectory } from './aasx-directory/aasx-directory.js'; +import { AasxServerV0 } from './aasx-server/aasx-server-v0.js'; +import { AasxServerV3 } from './aasx-server/aasx-server-v3.js'; +import { OpcuaServer } from './opcua/opcua-server.js'; import { ERRORS } from '../errors.js'; import { FileStorageFactory } from '../file-storage/file-storage-factory.js'; import { FileStorage } from '../file-storage/file-storage.js'; @singleton() export class AASResourceFactory { - constructor( + public constructor( @inject('Logger') private readonly logger: Logger, - @inject(FileStorageFactory) private readonly fileStorageFactory: FileStorageFactory - ) { } + @inject(FileStorageFactory) private readonly fileStorageFactory: FileStorageFactory, + ) {} /** * Creates a concrete realization of an `AASSource`. @@ -48,11 +48,7 @@ export class AASResourceFactory { source = new OpcuaServer(this.logger, endpoint.url, endpoint.name); break; case 'file:': - source = new AasxDirectory( - this.logger, - endpoint.url, - endpoint.name, - this.createLocalFileStorage(url)); + source = new AasxDirectory(this.logger, endpoint.url, endpoint.name, this.createLocalFileStorage(url)); break; default: throw new Error('Not implemented.'); @@ -71,7 +67,7 @@ export class AASResourceFactory { const url = new URL(endpoint.url); switch (url.protocol) { case 'http:': - case 'https:': + case 'https:': { const version = endpoint.version ?? '3.0'; if (version === '3.0') { await new AasxServerV3(this.logger, endpoint.url, endpoint.name).testAsync(); @@ -81,11 +77,17 @@ export class AASResourceFactory { throw new Error('Not implemented.'); } break; + } case 'opc.tcp:': await new OpcuaServer(this.logger, endpoint.url, endpoint.name).testAsync(); break; case 'file:': - await new AasxDirectory(this.logger, endpoint.url, endpoint.name, this.createLocalFileStorage(url)).testAsync(); + await new AasxDirectory( + this.logger, + endpoint.url, + endpoint.name, + this.createLocalFileStorage(url), + ).testAsync(); break; default: throw new Error('Not implemented.'); @@ -94,11 +96,12 @@ export class AASResourceFactory { throw new ApplicationError( `"${endpoint.url}" addresses an invalid or not supported AAS resource.`, ERRORS.InvalidContainerUrl, - endpoint.url); + endpoint.url, + ); } } private createLocalFileStorage(url: URL): FileStorage { return this.fileStorageFactory.create(`file:///endpoints` + url.pathname); } -} \ No newline at end of file +} diff --git a/projects/aas-server/src/app/packages/aas-resource.ts b/projects/aas-server/src/app/packages/aas-resource.ts index 1e91636f..c8aacdda 100644 --- a/projects/aas-server/src/app/packages/aas-resource.ts +++ b/projects/aas-server/src/app/packages/aas-resource.ts @@ -14,12 +14,11 @@ import { SocketSubscription } from '../live/socket-subscription.js'; /** Represents a resource of Asset Administration Shells. */ export abstract class AASResource { - constructor( - protected readonly logger: Logger, - public readonly url: string, - public readonly name: string - ) { - } + protected constructor( + protected readonly logger: Logger, + public readonly url: string, + public readonly name: string, + ) {} public abstract readonly version: string; @@ -53,7 +52,8 @@ export abstract class AASResource { public abstract createSubscription( client: SocketClient, message: LiveRequest, - env: aas.Environment): SocketSubscription; + env: aas.Environment, + ): SocketSubscription; /** * Downloads an aasx package form the current source. @@ -90,7 +90,11 @@ export abstract class AASResource { * @param idShortPath The path from the Submodel to the Blob element. * @returns The Blob value. */ - public abstract getBlobValueAsync(env: aas.Environment, submodelId: string, idShortPath: string): Promise; + public abstract getBlobValueAsync( + env: aas.Environment, + submodelId: string, + idShortPath: string, + ): Promise; /** * Resolves a new URL from the base URL and the specified URL. @@ -100,4 +104,4 @@ export abstract class AASResource { protected resolve(url: string): URL { return new URL(url, this.url); } -} \ No newline at end of file +} diff --git a/projects/aas-server/src/app/packages/aas-writer.ts b/projects/aas-server/src/app/packages/aas-writer.ts index c0ea0cf6..0e81d7e0 100644 --- a/projects/aas-server/src/app/packages/aas-writer.ts +++ b/projects/aas-server/src/app/packages/aas-writer.ts @@ -10,6 +10,6 @@ import { aas } from 'common'; /** */ export abstract class AASWriter { - public abstract writeEnvironment(env: aas.Environment): any; - public abstract write(referable: aas.Referable): any; -} \ No newline at end of file + public abstract writeEnvironment(env: aas.Environment): T; + public abstract write(referable: aas.Referable): T; +} diff --git a/projects/aas-server/src/app/packages/aasx-directory/aasx-directory.ts b/projects/aas-server/src/app/packages/aasx-directory/aasx-directory.ts index c2974b4c..26c4a538 100644 --- a/projects/aas-server/src/app/packages/aasx-directory/aasx-directory.ts +++ b/projects/aas-server/src/app/packages/aasx-directory/aasx-directory.ts @@ -19,7 +19,12 @@ import { SocketSubscription } from '../../live/socket-subscription.js'; export class AasxDirectory extends AASResource { private reentry = 0; - constructor(logger: Logger, url: string, name: string, private readonly fileStorage: FileStorage) { + public constructor( + logger: Logger, + url: string, + name: string, + private readonly fileStorage: FileStorage, + ) { super(logger, url, name); } @@ -93,7 +98,8 @@ export class AasxDirectory extends AASResource { throw new ApplicationError( `A file with the name '${file.filename}' already exists.`, ERRORS.FileAlreadyExists, - file.filename); + file.filename, + ); } try { @@ -121,4 +127,4 @@ export class AasxDirectory extends AASResource { public override getBlobValueAsync(): Promise { throw new Error('Not implemented.'); } -} \ No newline at end of file +} diff --git a/projects/aas-server/src/app/packages/aasx-directory/aasx-package.ts b/projects/aas-server/src/app/packages/aasx-directory/aasx-package.ts index 45a74f14..aa63d140 100644 --- a/projects/aas-server/src/app/packages/aasx-directory/aasx-package.ts +++ b/projects/aas-server/src/app/packages/aasx-directory/aasx-package.ts @@ -94,7 +94,10 @@ export class AasxPackage extends AASPackage { let stream: NodeJS.ReadableStream | undefined; const relationships = await this.getRelationshipsAsync('_rels/.rels'); for (const relationship of relationships) { - if (relationship.getAttribute('Type') === 'http://schemas.openxmlformats.org/package/2006/relationships/metadata/thumbnail') { + if ( + relationship.getAttribute('Type') === + 'http://schemas.openxmlformats.org/package/2006/relationships/metadata/thumbnail' + ) { const value = relationship.getAttribute('Target'); if (value) { stream = (await this.zip.getValueAsync()).file(this.normalize(value))?.nodeStream(); @@ -116,12 +119,14 @@ export class AasxPackage extends AASPackage { const name = await this.getOriginNameAsync(); const extension = extname(name); switch (extension) { - case '.xml': + case '.xml': { const xml = await this.getZipEntryAsync(name); return new XmlReader(this.logger, xml); - case '.json': + } + case '.json': { const env = JSON.parse(await this.getZipEntryAsync(name)); return this.createJsonReader(env); + } default: throw new Error(`The AAS origin ${extension} is not supported.`); } @@ -169,10 +174,10 @@ export class AasxPackage extends AASPackage { const zip = await this.zip.getValueAsync(); const file = zip.file(path); if (file === null) { - throw new Error(`${path} is not a valid ZIP file.`) + throw new Error(`${path} is not a valid ZIP file.`); } - return await file.async(contentType) as string; + return (await file.async(contentType)) as string; } private getContentType(fileName: string): jszip.OutputType { @@ -222,4 +227,4 @@ export class AasxPackage extends AASPackage { return undefined; } } -} \ No newline at end of file +} diff --git a/projects/aas-server/src/app/packages/aasx-server/aasx-server-package.ts b/projects/aas-server/src/app/packages/aasx-server/aasx-server-package.ts index 346a65f8..cc9e938c 100644 --- a/projects/aas-server/src/app/packages/aasx-server/aasx-server-package.ts +++ b/projects/aas-server/src/app/packages/aasx-server/aasx-server-package.ts @@ -23,7 +23,7 @@ export class AasxServerPackage extends AASPackage { * @param resource The handle. * @param idShort The name of the AAS. */ - constructor(logger: Logger, resource: AASResource, idShort: string) { + public constructor(logger: Logger, resource: AASResource, idShort: string) { super(logger); this.server = resource as AasxServer; @@ -89,4 +89,4 @@ export class AasxServerPackage extends AASPackage { return undefined; } } -} \ No newline at end of file +} diff --git a/projects/aas-server/src/app/packages/aasx-server/aasx-server-v0.ts b/projects/aas-server/src/app/packages/aasx-server/aasx-server-v0.ts index a31334d5..7746f829 100644 --- a/projects/aas-server/src/app/packages/aasx-server/aasx-server-v0.ts +++ b/projects/aas-server/src/app/packages/aasx-server/aasx-server-v0.ts @@ -18,7 +18,7 @@ interface AASList { } export class AasxServerV0 extends AasxServer { - constructor(logger: Logger, url: string, name: string) { + public constructor(logger: Logger, url: string, name: string) { super(logger, url, name); } @@ -30,7 +30,7 @@ export class AasxServerV0 extends AasxServer { public async getShellsAsync(): Promise { const value = await this.message.get(this.resolve('/server/listaas')); - return value.aaslist.map(item => item.split(' : ')[1].trim()) + return value.aaslist.map(item => item.split(' : ')[1].trim()); } public override async readEnvironmentAsync(id: string): Promise { @@ -46,7 +46,8 @@ export class AasxServerV0 extends AasxServer { public override async commitAsync( source: aas.Environment, destination: aas.Environment, - diffs: DifferenceItem[]): Promise { + diffs: DifferenceItem[], + ): Promise { const messages: string[] = []; const updateSubmodels = new Set(); const deleteSubmodels = new Set(); @@ -79,11 +80,11 @@ export class AasxServerV0 extends AasxServer { } if (updateSubmodels.size > 0) { - messages.push(...await this.putSubmodelsAsync(destination, updateSubmodels.values())); + messages.push(...(await this.putSubmodelsAsync(destination, updateSubmodels.values()))); } if (deleteSubmodels.size > 0) { - messages.push(...await this.deleteSubmodelsAsync(destination, deleteSubmodels.values())); + messages.push(...(await this.deleteSubmodelsAsync(destination, deleteSubmodels.values()))); } return messages; @@ -135,7 +136,8 @@ export class AasxServerV0 extends AasxServer { private async putSubmodelsAsync( destination: aas.Environment, - submodels: IterableIterator): Promise { + submodels: IterableIterator, + ): Promise { const messages: string[] = []; const aas = destination.assetAdministrationShells[0].idShort; for (const submodel of submodels) { @@ -147,7 +149,8 @@ export class AasxServerV0 extends AasxServer { private async deleteSubmodelsAsync( destination: aas.Environment, - elements: IterableIterator): Promise { + elements: IterableIterator, + ): Promise { const messages: string[] = []; const aas = destination.assetAdministrationShells[0].idShort; for (const element of elements) { @@ -164,4 +167,4 @@ export class AasxServerV0 extends AasxServer { private deleteSubmodelAsync(aas: string, submodelId: string): Promise { return this.message.delete(this.resolve('/aas/' + aas + '/submodels/' + submodelId)); } -} \ No newline at end of file +} diff --git a/projects/aas-server/src/app/packages/aasx-server/aasx-server-v3.ts b/projects/aas-server/src/app/packages/aasx-server/aasx-server-v3.ts index f344ff0c..22317209 100644 --- a/projects/aas-server/src/app/packages/aasx-server/aasx-server-v3.ts +++ b/projects/aas-server/src/app/packages/aasx-server/aasx-server-v3.ts @@ -23,7 +23,7 @@ import { isAssetAdministrationShell, isSubmodel, isSubmodelElement, - selectSubmodel + selectSubmodel, } from 'common'; interface PackageDescriptor { @@ -63,7 +63,7 @@ interface PagedResult { } export class AasxServerV3 extends AasxServer { - constructor(logger: Logger, url: string, name: string) { + public constructor(logger: Logger, url: string, name: string) { super(logger, url, name); } @@ -74,24 +74,21 @@ export class AasxServerV3 extends AasxServer { public readonly onlineReady = true; public async getShellsAsync(): Promise { - const pagedResult = await this.message.get>( - this.resolve('/shells')); + const pagedResult = await this.message.get>(this.resolve('/shells')); return pagedResult.result.map(shell => shell.id); } public async readEnvironmentAsync(id: string): Promise { const aasId = encodeBase64Url(id); - const shell = await this.message.get( - this.resolve(`/shells/${aasId}`)); + const shell = await this.message.get(this.resolve(`/shells/${aasId}`)); const submodels: aas.Submodel[] = []; if (shell.submodels) { for (const reference of shell.submodels) { const submodelId = encodeBase64Url(reference.keys[0].value); try { - submodels.push(await this.message.get( - this.resolve(`/submodels/${submodelId}`))); + submodels.push(await this.message.get(this.resolve(`/submodels/${submodelId}`))); } catch (error) { this.logger.error(`Unable to read Submodel "${reference.keys[0].value}": ${error?.message}`); } @@ -99,12 +96,13 @@ export class AasxServerV3 extends AasxServer { } const pagedResult = await this.message.get>( - this.resolve(`/concept-descriptions`)); + this.resolve(`/concept-descriptions`), + ); const sourceEnv: aas.Environment = { assetAdministrationShells: [shell], submodels, - conceptDescriptions: pagedResult.result + conceptDescriptions: pagedResult.result, }; return new JsonReader(this.logger, sourceEnv).readEnvironment(); @@ -117,7 +115,8 @@ export class AasxServerV3 extends AasxServer { public async commitAsync( source: aas.Environment, target: aas.Environment, - diffs: DifferenceItem[]): Promise { + diffs: DifferenceItem[], + ): Promise { const messages: string[] = []; const aasId = encodeBase64Url(target.assetAdministrationShells[0].id); for (const diff of diffs) { @@ -135,7 +134,9 @@ export class AasxServerV3 extends AasxServer { messages.push(await this.putSubmodelAsync(aasId, diff.sourceElement)); } else if (isSubmodelElement(diff.sourceElement)) { const submodel = this.getSubmodel(target, diff.destinationElement); - messages.push(await this.putSubmodelElementAsync(submodel, diff.sourceElement as aas.SubmodelElement)); + messages.push( + await this.putSubmodelElementAsync(submodel, diff.sourceElement as aas.SubmodelElement), + ); } else if (isAssetAdministrationShell(diff.sourceElement)) { messages.push(await this.putShellAsync(diff.sourceElement)); } else { @@ -204,26 +205,35 @@ export class AasxServerV3 extends AasxServer { inoutputVariables: cloneDeep(operation.inoutputVariables), }; - const result: OperationResult = JSON.parse(await this.message.post( - this.resolve(`/shells/${aasId}/submodels/${smId}/submodel-elements/${path}/invoke`), - request)); + const result: OperationResult = JSON.parse( + await this.message.post( + this.resolve(`/shells/${aasId}/submodels/${smId}/submodel-elements/${path}/invoke`), + request, + ), + ); if (!result.success) { throw new ApplicationError( `Invoking the operation ${operation.idShort} failed: {0}`, ERRORS.InvokeOperationFailed, - result.messages?.map(message => message.text).join(' ') ?? 'No messages.'); + result.messages?.map(message => message.text).join(' ') ?? 'No messages.', + ); } return { ...operation, outputVariables: result.outputVariables, inoutputVariables: result.inoutputVariables }; } - public async getBlobValueAsync(env: aas.Environment, submodelId: string, idShortPath: string): Promise { + public async getBlobValueAsync( + env: aas.Environment, + submodelId: string, + idShortPath: string, + ): Promise { const blob = await this.message.get( - this.resolve(`/submodels/${submodelId}/submodel-elements/${idShortPath}/?extent=WithBlobValue`)); + this.resolve(`/submodels/${submodelId}/submodel-elements/${idShortPath}/?extent=WithBlobValue`), + ); if (!blob) { - throw new Error(`Blob element "${submodelId}.${idShortPath}" does not exist.`) + throw new Error(`Blob element "${submodelId}.${idShortPath}" does not exist.`); } return blob.value; @@ -231,48 +241,59 @@ export class AasxServerV3 extends AasxServer { private async putShellAsync(shell: aas.AssetAdministrationShell): Promise { const aasId = encodeBase64Url(shell.id); - return await this.message.put( - this.resolve(`/shells/${aasId}`), - new JsonWriter().write(shell)); + return await this.message.put(this.resolve(`/shells/${aasId}`), new JsonWriter().write(shell)); } private async putSubmodelAsync(aasId: string, submodel: aas.Submodel): Promise { const smId = encodeBase64Url(submodel.id); return await this.message.put( this.resolve(`/shells/${aasId}/submodels/${smId}`), - new JsonWriter().write(submodel)); + new JsonWriter().write(submodel), + ); } private async postSubmodelAsync(aasId: string, submodel: aas.Submodel): Promise { return await this.message.post( - this.resolve(`/submodels?aasIdentifier=${aasId}`), new JsonWriter().write(submodel)); + this.resolve(`/submodels?aasIdentifier=${aasId}`), + new JsonWriter().write(submodel), + ); } private async deleteSubmodelAsync(smId: string): Promise { return await this.message.delete(this.resolve(`/submodels/${encodeBase64Url(smId)}`)); } - private async putSubmodelElementAsync(submodel: aas.Submodel, submodelElement: aas.SubmodelElement): Promise { + private async putSubmodelElementAsync( + submodel: aas.Submodel, + submodelElement: aas.SubmodelElement, + ): Promise { const smId = encodeBase64Url(submodel.id); const path = getIdShortPath(submodelElement); return await this.message.put( this.resolve(`/submodels/${smId}/submodel-elements/${path}`), - new JsonWriter().write(submodelElement)); + new JsonWriter().write(submodelElement), + ); } - private async postSubmodelElementAsync(submodel: aas.Submodel, submodelElement: aas.SubmodelElement): Promise { + private async postSubmodelElementAsync( + submodel: aas.Submodel, + submodelElement: aas.SubmodelElement, + ): Promise { const smId = encodeBase64Url(submodel.id); const path = getIdShortPath(submodelElement); return await this.message.post( this.resolve(`/submodels/${smId}/submodel-elements/${path}`), - new JsonWriter().write(submodelElement)); + new JsonWriter().write(submodelElement), + ); } - private async deleteSubmodelElementAsync(submodel: aas.Submodel, submodelElement: aas.SubmodelElement): Promise { + private async deleteSubmodelElementAsync( + submodel: aas.Submodel, + submodelElement: aas.SubmodelElement, + ): Promise { const smId = encodeBase64Url(submodel.id); const path = getIdShortPath(submodelElement); - return await this.message.delete( - this.resolve(`/submodels/${smId}/submodel-elements/${path}`)); + return await this.message.delete(this.resolve(`/submodels/${smId}/submodel-elements/${path}`)); } private getSubmodel(env: aas.Environment, referable?: aas.Referable): aas.Submodel { @@ -287,4 +308,4 @@ export class AasxServerV3 extends AasxServer { return submodel; } -} \ No newline at end of file +} diff --git a/projects/aas-server/src/app/packages/aasx-server/aasx-server.ts b/projects/aas-server/src/app/packages/aasx-server/aasx-server.ts index 201d290a..6d003fa5 100644 --- a/projects/aas-server/src/app/packages/aasx-server/aasx-server.ts +++ b/projects/aas-server/src/app/packages/aasx-server/aasx-server.ts @@ -27,7 +27,7 @@ export abstract class AasxServer extends AASResource { /** * @param url The URL of the AASX-Server. */ - constructor(logger: Logger, url: string, name: string) { + public constructor(logger: Logger, url: string, name: string) { super(logger, url, name); } @@ -44,7 +44,7 @@ export abstract class AasxServer extends AASResource { } finally { await this.closeAsync(); } - } + } } /** @@ -56,7 +56,7 @@ export abstract class AasxServer extends AASResource { /** Gets the thumbnail of the AAS with the specified identifier. * @param id The identifier of the current AAS. - */ + */ public abstract getThumbnailAsync(id: string): Promise; public async openAsync(): Promise { @@ -84,7 +84,8 @@ export abstract class AasxServer extends AASResource { public override createSubscription( client: SocketClient, message: LiveRequest, - env: aas.Environment): SocketSubscription { + env: aas.Environment, + ): SocketSubscription { return new HttpSubscription(this.logger, this, client, message, env); } @@ -98,12 +99,13 @@ export abstract class AasxServer extends AASResource { * ToDo * @param source The source AAS. * @param destination The destination - * @param diffs + * @param diffs */ public abstract commitAsync( - source: aas.Environment, - destination: aas.Environment, - diffs: DifferenceItem[]): Promise; + source: aas.Environment, + destination: aas.Environment, + diffs: DifferenceItem[], + ): Promise; /** * Opens the specified file from the AASX server. @@ -113,10 +115,10 @@ export abstract class AasxServer extends AASResource { */ public abstract openFileAsync(shell: aas.AssetAdministrationShell, file: aas.File): Promise; - /** + /** * Reads the current value from a submodel element. * @param url The path of the submodel element value. - * @param valueType The + * @param valueType The * @returns The current value. */ public async readValueAsync(url: string, valueType: aas.DataTypeDefXsd): Promise { @@ -130,4 +132,4 @@ export abstract class AasxServer extends AASResource { * @param nodeId The path from the Submodel to the Property. */ public abstract resolveNodeId(aas: aas.AssetAdministrationShell, nodeId: string): string; -} \ No newline at end of file +} diff --git a/projects/aas-server/src/app/packages/json-reader-v2.ts b/projects/aas-server/src/app/packages/json-reader-v2.ts index 8c93342d..4ddd49fd 100644 --- a/projects/aas-server/src/app/packages/json-reader-v2.ts +++ b/projects/aas-server/src/app/packages/json-reader-v2.ts @@ -15,9 +15,10 @@ import * as aasv2 from '../types/aas-v2.js'; export class JsonReaderV2 extends AASReader { private readonly origin: aasv2.AssetAdministrationShellEnvironment; - constructor( + public constructor( private readonly logger: Logger, - origin?: aasv2.AssetAdministrationShellEnvironment | string) { + origin?: aasv2.AssetAdministrationShellEnvironment | string, + ) { super(); if (origin) { @@ -50,7 +51,7 @@ export class JsonReaderV2 extends AASReader { private readConceptDescriptions(): aas.ConceptDescription[] { const conceptDescriptions: aas.ConceptDescription[] = []; if (this.origin?.conceptDescriptions) { - for (const source of this.origin?.conceptDescriptions) { + for (const source of this.origin.conceptDescriptions) { conceptDescriptions.push(this.readConceptDescription(source)); } } @@ -61,7 +62,7 @@ export class JsonReaderV2 extends AASReader { private readAssetAdministrationShells(): aas.AssetAdministrationShell[] { const shells: aas.AssetAdministrationShell[] = []; if (this.origin?.assetAdministrationShells) { - for (const source of this.origin?.assetAdministrationShells) { + for (const source of this.origin.assetAdministrationShells) { shells.push(this.readAssetAdministrationShell(source)); } } @@ -77,7 +78,7 @@ export class JsonReaderV2 extends AASReader { const shell: aas.AssetAdministrationShell = { ...this.readIdentifiable(source), ...this.readHasDataSpecification(source), - assetInformation: this.readAssetInformation(this.origin.assets[0]) + assetInformation: this.readAssetInformation(this.origin.assets[0]), }; if (source.derivedFrom) { @@ -111,7 +112,7 @@ export class JsonReaderV2 extends AASReader { private readConceptDescription(source: aasv2.ConceptDescription): aas.ConceptDescription { const conceptDescription: aas.ConceptDescription = { ...this.readIdentifiable(source), - ...this.readHasDataSpecification(source) + ...this.readHasDataSpecification(source), }; if (source.isCaseOf) { @@ -124,7 +125,7 @@ export class JsonReaderV2 extends AASReader { private readAssetInformation(source: aasv2.Asset): aas.AssetInformation { const asset: aas.AssetInformation = { assetKind: source.kind ?? 'Instance', - globalAssetId: source.identification.id + globalAssetId: source.identification.id, }; return asset; @@ -147,12 +148,11 @@ export class JsonReaderV2 extends AASReader { ...this.readHasSemantic(source), ...this.readQualifiable(source), ...this.readHasKind(source), - ...this.readHasDataSpecification(source) + ...this.readHasDataSpecification(source), }; if (source.submodelElements) { - submodel.submodelElements = this.readSubmodelElements( - source.submodelElements, [submodel]); + submodel.submodelElements = this.readSubmodelElements(source.submodelElements, [submodel]); } return submodel; @@ -170,7 +170,10 @@ export class JsonReaderV2 extends AASReader { return submodelElements; } - private readSubmodelElement(source: aasv2.SubmodelElement, ancestors?: aas.Referable[]): aas.SubmodelElement | undefined { + private readSubmodelElement( + source: aasv2.SubmodelElement, + ancestors?: aas.Referable[], + ): aas.SubmodelElement | undefined { switch (source.modelType.name) { case 'AnnotatedRelationshipElement': return this.readAnnotatedRelationshipElement(source as aasv2.AnnotatedRelationshipElement, ancestors); @@ -207,16 +210,17 @@ export class JsonReaderV2 extends AASReader { ...this.readHasSemantic(source), ...this.readHasKind(source), ...this.readHasDataSpecification(source), - ...this.readQualifiable(source) + ...this.readQualifiable(source), }; } private readAnnotatedRelationshipElement( source: aasv2.AnnotatedRelationshipElement, - ancestors?: aas.Referable[]): aas.AnnotatedRelationshipElement { + ancestors?: aas.Referable[], + ): aas.AnnotatedRelationshipElement { const relationship: aas.AnnotatedRelationshipElement = { ...this.readRelationshipElement(source, ancestors), - annotations: source.annotation?.map(item => this.readSubmodelElementType(item)) ?? [] + annotations: source.annotation?.map(item => this.readSubmodelElementType(item)) ?? [], }; return relationship; @@ -231,7 +235,7 @@ export class JsonReaderV2 extends AASReader { ...this.readSubmodelElementType(source, ancestors), observed: this.readReference(source.observed), direction: 'input', - state: 'off' + state: 'off', }; return basicEvent; @@ -249,7 +253,7 @@ export class JsonReaderV2 extends AASReader { const property: aas.Property = { ...this.readSubmodelElementType(source, ancestors), - valueType + valueType, }; if (source.value) { @@ -266,11 +270,12 @@ export class JsonReaderV2 extends AASReader { private readMultiLanguageProperty( source: aasv2.MultiLanguageProperty, - ancestors?: aas.Referable[]): aas.MultiLanguageProperty { + ancestors?: aas.Referable[], + ): aas.MultiLanguageProperty { const value = this.readLangStringSet(source.value.langString); const property: aas.MultiLanguageProperty = { ...this.readSubmodelElementType(source, ancestors), - value + value, }; return property; @@ -284,7 +289,7 @@ export class JsonReaderV2 extends AASReader { const file: aas.File = { ...this.readSubmodelElementType(source, ancestors), - contentType + contentType, }; if (source.value) { @@ -302,7 +307,7 @@ export class JsonReaderV2 extends AASReader { const blob: aas.Blob = { ...this.readSubmodelElementType(source, ancestors), - contentType + contentType, }; if (source.value) { @@ -314,15 +319,17 @@ export class JsonReaderV2 extends AASReader { private readSubmodelElementCollection( source: aasv2.SubmodelElementCollection, - ancestors?: aas.Referable[]): aas.SubmodelElementCollection { + ancestors?: aas.Referable[], + ): aas.SubmodelElementCollection { const collection: aas.SubmodelElementCollection = { - ...this.readSubmodelElementType(source, ancestors) + ...this.readSubmodelElementType(source, ancestors), }; if (source.value) { collection.value = this.readSubmodelElements( source.value, - ancestors ? [...ancestors, collection] : undefined); + ancestors ? [...ancestors, collection] : undefined, + ); } return collection; @@ -335,25 +342,28 @@ export class JsonReaderV2 extends AASReader { const reference: aas.ReferenceElement = { ...this.readSubmodelElementType(source, ancestors), - value: this.readReference(source.value) + value: this.readReference(source.value), }; return reference; } - private readRelationshipElement(source: aasv2.RelationshipElement, ancestors?: aas.Referable[]): aas.RelationshipElement { + private readRelationshipElement( + source: aasv2.RelationshipElement, + ancestors?: aas.Referable[], + ): aas.RelationshipElement { if (!source.first) { - throw new Error('RelationshipElement.first') + throw new Error('RelationshipElement.first'); } if (!source.second) { - throw new Error('RelationshipElement.second') + throw new Error('RelationshipElement.second'); } const relationship: aas.RelationshipElement = { ...this.readSubmodelElementType(source, ancestors), first: this.readReference(source.first), - second: this.readReference(source.second) + second: this.readReference(source.second), }; return relationship; @@ -361,7 +371,7 @@ export class JsonReaderV2 extends AASReader { private readOperation(source: aasv2.Operation, ancestors?: aas.Referable[]): aas.Operation { const operation: aas.Operation = { - ...this.readSubmodelElementType(source, ancestors) + ...this.readSubmodelElementType(source, ancestors), }; if (source.inputVariable) { @@ -384,7 +394,7 @@ export class JsonReaderV2 extends AASReader { if (isSubmodelElement(source.value)) { value = this.readSubmodelElementType(source.value); } else if ('submodelElement' in source.value) { - const submodelElement = (source.value as any).submodelElement as aasv2.SubmodelElement; + const submodelElement = (source.value as { submodelElement: aasv2.SubmodelElement }).submodelElement; if (isSubmodelElement(submodelElement)) { value = this.readSubmodelElementType(submodelElement); } @@ -404,7 +414,7 @@ export class JsonReaderV2 extends AASReader { const entity: aas.Entity = { ...this.readSubmodelElementType(source, ancestors), - entityType: source.entityType + entityType: source.entityType, }; if (source.asset) { @@ -425,7 +435,7 @@ export class JsonReaderV2 extends AASReader { const range: aas.Range = { ...this.readSubmodelElementType(source, ancestors), - valueType: this.readDataTypeDefXsd(source.valueType.dataObjectType.name) as aas.DataTypeDefXsd + valueType: this.readDataTypeDefXsd(source.valueType.dataObjectType.name) as aas.DataTypeDefXsd, }; if (source.min) { @@ -476,7 +486,7 @@ export class JsonReaderV2 extends AASReader { qualifier = { type: sourceQualifier.type, - valueType: this.readDataTypeDefXsd(sourceQualifier.valueType) + valueType: this.readDataTypeDefXsd(sourceQualifier.valueType), }; if (sourceQualifier.value) { @@ -509,25 +519,25 @@ export class JsonReaderV2 extends AASReader { const referable: aas.Referable = { idShort, - modelType: this.readModelType(source.modelType.name) as aas.ModelType + modelType: this.readModelType(source.modelType.name) as aas.ModelType, }; if (ancestors) { referable.parent = { type: 'ModelReference', - keys: ancestors.map((ancestor, index) => { + keys: ancestors.map(ancestor => { if (isIdentifiable(ancestor)) { return { type: ancestor.modelType, - value: ancestor.id + value: ancestor.id, } as aas.Key; } else { return { type: ancestor.modelType, - value: ancestor.idShort + value: ancestor.idShort, } as aas.Key; } - }) + }), }; } @@ -554,7 +564,7 @@ export class JsonReaderV2 extends AASReader { const id = this.readIdentifier(source.identification); const identifiable: aas.Identifiable = { ...this.readReferable(source, id), - id: id + id: id, }; if (source.administration) { @@ -585,7 +595,7 @@ export class JsonReaderV2 extends AASReader { } return { type: key.type, value: key.value } as aas.Key; - }) + }), }; } @@ -596,8 +606,9 @@ export class JsonReaderV2 extends AASReader { private readHasDataSpecification(source: aasv2.HasDataSpecification): aas.HasDataSpecification { const hasDataSpecification: aas.HasDataSpecification = {}; if (source.embeddedDataSpecifications) { - hasDataSpecification.embeddedDataSpecifications = source.embeddedDataSpecifications - .map(item => this.readEmbeddedDatSpecification(item)); + hasDataSpecification.embeddedDataSpecifications = source.embeddedDataSpecifications.map(item => + this.readEmbeddedDatSpecification(item), + ); } return hasDataSpecification; @@ -615,28 +626,31 @@ export class JsonReaderV2 extends AASReader { let dataSpecificationContent: aas.DataSpecificationContent; if ((source.dataSpecificationContent as aasv2.DataSpecificationIEC61360Content).preferredName) { dataSpecificationContent = this.readDataSpecificationIEC61360( - source.dataSpecificationContent as aasv2.DataSpecificationIEC61360Content); + source.dataSpecificationContent as aasv2.DataSpecificationIEC61360Content, + ); } else { throw new Error('Not implemented.'); } const specification: aas.EmbeddedDataSpecification = { dataSpecification: this.readReference(source.dataSpecification), - dataSpecificationContent + dataSpecificationContent, }; return specification; } - private readDataSpecificationIEC61360(source: aasv2.DataSpecificationIEC61360Content): aas.DataSpecificationIEC61360 { + private readDataSpecificationIEC61360( + source: aasv2.DataSpecificationIEC61360Content, + ): aas.DataSpecificationIEC61360 { if (!source.preferredName) { throw new Error(`DataSpecificationIEC61360.preferredName`); } const iec61360: aas.DataSpecificationIEC61360 = { modelType: 'DataSpecificationIEC61360', - preferredName: this.readLangStringSet(source.preferredName) - } + preferredName: this.readLangStringSet(source.preferredName), + }; if (source.dataType) { iec61360.dataType = this.readDataTypeIEC61360(source.dataType); @@ -691,8 +705,7 @@ export class JsonReaderV2 extends AASReader { } return { - valueReferencePairs: source.valueReferencePairTypes - .map(item => this.readValueReferencePairType(item)) + valueReferencePairs: source.valueReferencePairTypes.map(item => this.readValueReferencePairType(item)), }; } @@ -712,14 +725,14 @@ export class JsonReaderV2 extends AASReader { } if (!source.valueId) { - throw new Error('ValueObject.valueId') + throw new Error('ValueObject.valueId'); } return { value: source.value, valueId: this.readReference(source.valueId) } as aas.ValueReferencePair; } private readModelType(source: aasv2.ModelTypes): aas.ModelType { - return source === 'BasicEvent' ? 'BasicEventElement' : source as aas.ModelType; + return source === 'BasicEvent' ? 'BasicEventElement' : (source as aas.ModelType); } private readDataTypeDefXsd(source: aasv2.DataTypeDefXsd): aas.DataTypeDefXsd { @@ -831,4 +844,4 @@ export class JsonReaderV2 extends AASReader { return source as aas.DataTypeIEC61360; } } -} \ No newline at end of file +} diff --git a/projects/aas-server/src/app/packages/json-reader.ts b/projects/aas-server/src/app/packages/json-reader.ts index 7f00f86b..876522c9 100644 --- a/projects/aas-server/src/app/packages/json-reader.ts +++ b/projects/aas-server/src/app/packages/json-reader.ts @@ -15,9 +15,10 @@ import { encodeBase64Url } from '../convert.js'; export class JsonReader extends AASReader { private readonly origin: aas.Environment; - constructor( + public constructor( private readonly logger: Logger, - origin?: aas.Environment | string) { + origin?: aas.Environment | string, + ) { super(); if (origin) { @@ -50,13 +51,14 @@ export class JsonReader extends AASReader { throw new Error('Invalid operation.'); case 'Submodel': return this.readSubmodel(source as aas.Submodel); - default: + default: { const element = this.readSubmodelElement(source as aas.SubmodelElement, []); if (!element) { throw new Error('Invalid operation.'); } return element; + } } } @@ -90,7 +92,7 @@ export class JsonReader extends AASReader { const shell: aas.AssetAdministrationShell = { ...this.readIdentifiable(source), ...this.readHasDataSpecification(source), - assetInformation: this.readAssetInformation(source.assetInformation) + assetInformation: this.readAssetInformation(source.assetInformation), }; if (source.derivedFrom) { @@ -142,7 +144,7 @@ export class JsonReader extends AASReader { ...this.readHasSemantic, name: source.name, value: source.value, - externalSubjectId: this.readReference(source.externalSubjectId) + externalSubjectId: this.readReference(source.externalSubjectId), }; } @@ -162,7 +164,7 @@ export class JsonReader extends AASReader { private readConceptDescription(source: aas.ConceptDescription): aas.ConceptDescription { const conceptDescription: aas.ConceptDescription = { ...this.readIdentifiable(source, 'ConceptDescription'), - ...this.readHasDataSpecification(source) + ...this.readHasDataSpecification(source), }; if (source.isCaseOf) { @@ -189,12 +191,11 @@ export class JsonReader extends AASReader { ...this.readHasSemantic(source), ...this.readQualifiable(source), ...this.readHasKind(source), - ...this.readHasDataSpecification(source) + ...this.readHasDataSpecification(source), }; if (source.submodelElements) { - submodel.submodelElements = this.readSubmodelElements( - source.submodelElements, [submodel]); + submodel.submodelElements = this.readSubmodelElements(source.submodelElements, [submodel]); } return submodel; @@ -212,7 +213,10 @@ export class JsonReader extends AASReader { return submodelElements; } - private readSubmodelElement(source: aas.SubmodelElement, ancestors?: aas.Referable[]): aas.SubmodelElement | undefined { + private readSubmodelElement( + source: aas.SubmodelElement, + ancestors?: aas.Referable[], + ): aas.SubmodelElement | undefined { switch (source.modelType) { case 'AnnotatedRelationshipElement': return this.readAnnotatedRelationshipElement(source as aas.AnnotatedRelationshipElement, ancestors); @@ -251,15 +255,16 @@ export class JsonReader extends AASReader { ...this.readHasSemantic(source), ...this.readHasKind(source), ...this.readHasDataSpecification(source), - ...this.readQualifiable(source) + ...this.readQualifiable(source), }; } private readAnnotatedRelationshipElement( source: aas.AnnotatedRelationshipElement, - ancestors?: aas.Referable[]): aas.AnnotatedRelationshipElement { + ancestors?: aas.Referable[], + ): aas.AnnotatedRelationshipElement { if (!source.annotations) { - throw new Error('AnnotatedRelationshipElement.annotation') + throw new Error('AnnotatedRelationshipElement.annotation'); } const relationship: aas.AnnotatedRelationshipElement = { @@ -291,7 +296,7 @@ export class JsonReader extends AASReader { ...this.readEventElement(source, ancestors), observed: source.observed, direction: source.direction, - state: source.state + state: source.state, }; if (source.messageTopic) { @@ -329,7 +334,7 @@ export class JsonReader extends AASReader { const property: aas.Property = { ...this.readSubmodelElementType(source, ancestors), - valueType + valueType, }; if (source.value) { @@ -346,7 +351,8 @@ export class JsonReader extends AASReader { private readMultiLanguageProperty( source: aas.MultiLanguageProperty, - ancestors?: aas.Referable[]): aas.MultiLanguageProperty { + ancestors?: aas.Referable[], + ): aas.MultiLanguageProperty { let value: aas.LangString[] | undefined; if (Array.isArray(source.value)) { value = source.value.map(item => ({ language: item.language, text: item.text })); @@ -361,7 +367,7 @@ export class JsonReader extends AASReader { private readOperation(source: aas.Operation, ancestors: aas.Referable[] | undefined): aas.Operation { const operation: aas.Operation = { - ...this.readSubmodelElementType(source, ancestors) + ...this.readSubmodelElementType(source, ancestors), }; if (source.inputVariables) { @@ -394,7 +400,7 @@ export class JsonReader extends AASReader { if (i >= 0) { contentType = extensionToMimeType(source.value.substring(i)); } - + if (!contentType) { throw new Error('File.contentType'); } @@ -404,7 +410,7 @@ export class JsonReader extends AASReader { const file: aas.File = { ...this.readSubmodelElementType(source, ancestors), - contentType: source.contentType + contentType: source.contentType, }; if (source.value) { @@ -417,7 +423,7 @@ export class JsonReader extends AASReader { private readBlob(source: aas.Blob, ancestors?: aas.Referable[]): aas.Blob { const blob: aas.Blob = { ...this.readSubmodelElementType(source, ancestors), - contentType: source.contentType ?? '' + contentType: source.contentType ?? '', }; if (source.value) { @@ -434,7 +440,7 @@ export class JsonReader extends AASReader { const entity: aas.Entity = { ...this.readSubmodelElementType(source, ancestors), - entityType: source.entityType + entityType: source.entityType, }; if (source.statements) { @@ -454,15 +460,17 @@ export class JsonReader extends AASReader { private readSubmodelElementCollection( source: aas.SubmodelElementCollection, - ancestors?: aas.Referable[]): aas.SubmodelElementCollection { + ancestors?: aas.Referable[], + ): aas.SubmodelElementCollection { const collection: aas.SubmodelElementCollection = { - ...this.readSubmodelElementType(source, ancestors) + ...this.readSubmodelElementType(source, ancestors), }; if (source.value) { collection.value = this.readSubmodelElements( source.value, - ancestors ? [...ancestors, collection] : undefined); + ancestors ? [...ancestors, collection] : undefined, + ); } return collection; @@ -470,7 +478,8 @@ export class JsonReader extends AASReader { private readSubmodelElementList( source: aas.SubmodelElementList, - ancestors?: aas.Referable[]): aas.SubmodelElementCollection { + ancestors?: aas.Referable[], + ): aas.SubmodelElementCollection { if (!source.typeValueListElement) { throw new Error('SubmodelElement.typeValueListElement'); } @@ -478,7 +487,7 @@ export class JsonReader extends AASReader { const list: aas.SubmodelElementList = { ...this.readSubmodelElementType(source, ancestors), typeValueListElement: source.typeValueListElement, - valueTypeListElement: source.valueTypeListElement + valueTypeListElement: source.valueTypeListElement, }; if (source.orderRelevant) { @@ -490,9 +499,7 @@ export class JsonReader extends AASReader { } if (source.value) { - list.value = this.readSubmodelElements( - source.value, - ancestors ? [...ancestors, list] : undefined); + list.value = this.readSubmodelElements(source.value, ancestors ? [...ancestors, list] : undefined); } return list; @@ -505,25 +512,28 @@ export class JsonReader extends AASReader { const reference: aas.ReferenceElement = { ...this.readSubmodelElementType(source, ancestors), - value: this.readReference(source.value) + value: this.readReference(source.value), }; return reference; } - private readRelationshipElement(source: aas.RelationshipElement, ancestors?: aas.Referable[]): aas.RelationshipElement { + private readRelationshipElement( + source: aas.RelationshipElement, + ancestors?: aas.Referable[], + ): aas.RelationshipElement { if (!source.first) { - throw new Error('RelationshipElement.first') + throw new Error('RelationshipElement.first'); } if (!source.second) { - throw new Error('RelationshipElement.second') + throw new Error('RelationshipElement.second'); } const relationship: aas.RelationshipElement = { ...this.readSubmodelElementType(source, ancestors), first: this.readReference(source.first), - second: this.readReference(source.second) + second: this.readReference(source.second), }; return relationship; @@ -536,7 +546,7 @@ export class JsonReader extends AASReader { const range: aas.Range = { ...this.readSubmodelElementType(source, ancestors), - valueType: source.valueType + valueType: source.valueType, }; if (source.min) { @@ -584,7 +594,7 @@ export class JsonReader extends AASReader { const qualifier: aas.Qualifier = { ...this.readHasSemantic(source), type: source.type, - valueType: source.valueType + valueType: source.valueType, }; if (source.kind) { @@ -606,7 +616,8 @@ export class JsonReader extends AASReader { source: aas.Referable, ancestors?: aas.Referable[], id?: string, - modelType?: aas.ModelType): aas.Referable { + modelType?: aas.ModelType, + ): aas.Referable { let idShort = source.idShort; if (!idShort) { if (!id) { @@ -625,19 +636,19 @@ export class JsonReader extends AASReader { if (ancestors) { referable.parent = { type: 'ModelReference', - keys: ancestors.map((ancestor) => { + keys: ancestors.map(ancestor => { if (isIdentifiable(ancestor)) { return { type: ancestor.modelType, - value: ancestor.id + value: ancestor.id, } as aas.Key; } else { return { type: ancestor.modelType, - value: ancestor.idShort + value: ancestor.idShort, } as aas.Key; } - }) + }), }; } @@ -663,7 +674,7 @@ export class JsonReader extends AASReader { const identifiable: aas.Identifiable = { ...this.readReferable(source, undefined, source.id, modelType), - id: source.id + id: source.id, }; if (source.administration) { @@ -676,7 +687,7 @@ export class JsonReader extends AASReader { private readReference(source: aas.Reference): aas.Reference { return { type: source.type, - keys: source.keys.map((key) => { + keys: source.keys.map(key => { if (!key.type) { throw new Error(`Reference.type`); } @@ -689,15 +700,16 @@ export class JsonReader extends AASReader { type: key.type, value: key.value, } as aas.Key; - }) + }), }; } private readHasDataSpecification(source: aas.HasDataSpecification): aas.HasDataSpecification { const hasDataSpecification: aas.HasDataSpecification = {}; if (source.embeddedDataSpecifications) { - hasDataSpecification.embeddedDataSpecifications = source.embeddedDataSpecifications - .map(item => this.readEmbeddedDatSpecification(item)); + hasDataSpecification.embeddedDataSpecifications = source.embeddedDataSpecifications.map(item => + this.readEmbeddedDatSpecification(item), + ); } return hasDataSpecification; @@ -713,16 +725,22 @@ export class JsonReader extends AASReader { } let dataSpecificationContent: aas.DataSpecificationContent; - if (!source.dataSpecificationContent.modelType || source.dataSpecificationContent.modelType === 'DataSpecificationIEC61360') { + if ( + !source.dataSpecificationContent.modelType || + source.dataSpecificationContent.modelType === 'DataSpecificationIEC61360' + ) { dataSpecificationContent = this.readDataSpecificationIEC61360( - source.dataSpecificationContent as aas.DataSpecificationIEC61360); + source.dataSpecificationContent as aas.DataSpecificationIEC61360, + ); } else { - throw new Error(`${source.dataSpecificationContent.modelType} is a not supported DataSpecificationContent.`); + throw new Error( + `${source.dataSpecificationContent.modelType} is a not supported DataSpecificationContent.`, + ); } const specification: aas.EmbeddedDataSpecification = { dataSpecification: this.readReference(source.dataSpecification), - dataSpecificationContent + dataSpecificationContent, }; return specification; @@ -735,8 +753,8 @@ export class JsonReader extends AASReader { const iec61360: aas.DataSpecificationIEC61360 = { modelType: source.modelType, - preferredName: source.preferredName - } + preferredName: source.preferredName, + }; if (source.dataType) { iec61360.dataType = source.dataType; @@ -791,7 +809,7 @@ export class JsonReader extends AASReader { } const valueList: aas.ValueList = { - valueReferencePairs: source.valueReferencePairs.map(item => this.readValueReferencePair(item)) + valueReferencePairs: source.valueReferencePairs.map(item => this.readValueReferencePair(item)), }; return valueList; @@ -808,4 +826,4 @@ export class JsonReader extends AASReader { return { value: source.value, valueId: this.readReference(source.valueId) }; } -} \ No newline at end of file +} diff --git a/projects/aas-server/src/app/packages/json-writer-v2.ts b/projects/aas-server/src/app/packages/json-writer-v2.ts index fde2c350..12bd22f6 100644 --- a/projects/aas-server/src/app/packages/json-writer-v2.ts +++ b/projects/aas-server/src/app/packages/json-writer-v2.ts @@ -11,16 +11,17 @@ import { aas, isSubmodelElement } from 'common'; import * as aasv2 from '../types/aas-v2.js'; export class JsonWriterV2 extends AASWriter { - public writeEnvironment(env: aas.Environment): any { + // eslint-disable-next-line @typescript-eslint/no-unused-vars + public writeEnvironment(env: aas.Environment): T { throw new Error('Method not implemented.'); } - public write(source: aas.Referable): any { + public write(source: aas.Referable): T { if (source.modelType === 'Submodel') { - return this.writeSubmodel(source as aas.Submodel); + return this.writeSubmodel(source as aas.Submodel) as T; } - return this.writeSubmodelElement(source as aas.SubmodelElement); + return this.writeSubmodelElement(source as aas.SubmodelElement) as T; } private writeSubmodel(source: aas.Submodel): aasv2.Submodel { @@ -29,7 +30,7 @@ export class JsonWriterV2 extends AASWriter { ...this.writeHasDataSpecification(source), ...this.writeHasSemantic(source), ...this.writeQualifiable(source), - ...this.writeHasKind(source) + ...this.writeHasKind(source), }; if (source.submodelElements) { @@ -70,9 +71,11 @@ export class JsonWriterV2 extends AASWriter { } } - private writeAnnotatedRelationshipElement(source: aas.AnnotatedRelationshipElement): aasv2.AnnotatedRelationshipElement { + private writeAnnotatedRelationshipElement( + source: aas.AnnotatedRelationshipElement, + ): aasv2.AnnotatedRelationshipElement { if (!source.annotations) { - throw new Error('AnnotatedRelationshipElement.annotation') + throw new Error('AnnotatedRelationshipElement.annotation'); } const relationship: aasv2.AnnotatedRelationshipElement = { @@ -90,7 +93,7 @@ export class JsonWriterV2 extends AASWriter { const basicEvent: aasv2.BasicEvent = { ...this.writeSubmodelElementType(source), - observed: this.writeReference(source.observed) + observed: this.writeReference(source.observed), }; return basicEvent; @@ -104,7 +107,7 @@ export class JsonWriterV2 extends AASWriter { const blob: aasv2.Blob = { ...this.writeSubmodelElementType(source), - mimeType + mimeType, }; if (source.value) { @@ -121,7 +124,7 @@ export class JsonWriterV2 extends AASWriter { const entity: aasv2.Entity = { ...this.writeSubmodelElementType(source), - entityType: source.entityType + entityType: source.entityType, }; if (source.globalAssetId) { @@ -144,7 +147,7 @@ export class JsonWriterV2 extends AASWriter { const file: aasv2.File = { ...this.writeSubmodelElementType(source), - mimeType + mimeType, }; if (source.value) { @@ -166,15 +169,15 @@ export class JsonWriterV2 extends AASWriter { const property: aasv2.MultiLanguageProperty = { ...this.writeSubmodelElementType(source), - value: { langString } - } + value: { langString }, + }; return property; } private writeOperation(source: aas.Operation): aasv2.Operation { const operation: aasv2.Operation = { - ...this.writeSubmodelElementType(source) + ...this.writeSubmodelElementType(source), }; if (source.inputVariables) { @@ -192,13 +195,12 @@ export class JsonWriterV2 extends AASWriter { return operation; } - private writeOperationVariable(source: aas.OperationVariable): aasv2.OperationVariable { let value: aasv2.SubmodelElement | undefined; if (isSubmodelElement(source.value)) { value = this.writeSubmodelElementType(source.value); } else if ('submodelElement' in source.value) { - const submodelElement = (source.value as any).submodelElement; + const submodelElement = (source.value as { submodelElement: aasv2.SubmodelElement }).submodelElement; if (isSubmodelElement(submodelElement)) { value = this.writeSubmodelElement(submodelElement); } @@ -219,7 +221,7 @@ export class JsonWriterV2 extends AASWriter { const property: aasv2.Property = { ...this.writeSubmodelElementType(source), - valueType + valueType, }; if (source.value) { @@ -240,7 +242,7 @@ export class JsonWriterV2 extends AASWriter { const range: aasv2.Range = { ...this.writeSubmodelElementType(source), - valueType: this.writeValueTypeDef(source.valueType)! + valueType: this.writeValueTypeDef(source.valueType)!, }; if (source.min) { @@ -261,7 +263,7 @@ export class JsonWriterV2 extends AASWriter { const reference: aasv2.ReferenceElement = { ...this.writeSubmodelElementType(source), - value: this.writeReference(source.value) + value: this.writeReference(source.value), }; return reference; @@ -269,17 +271,17 @@ export class JsonWriterV2 extends AASWriter { private writeRelationshipElement(source: aas.RelationshipElement): aasv2.RelationshipElement { if (!source.first) { - throw new Error('RelationshipElement.first') + throw new Error('RelationshipElement.first'); } if (!source.second) { - throw new Error('RelationshipElement.second') + throw new Error('RelationshipElement.second'); } const relationship: aasv2.RelationshipElement = { ...this.writeSubmodelElementType(source), first: this.writeReference(source.first), - second: this.writeReference(source.second) + second: this.writeReference(source.second), }; return relationship; @@ -291,7 +293,7 @@ export class JsonWriterV2 extends AASWriter { }; if (source.value) { - collection.value = source.value.map(item => this.writeSubmodelElement(item)) + collection.value = source.value.map(item => this.writeSubmodelElement(item)); } return collection; @@ -313,9 +315,9 @@ export class JsonWriterV2 extends AASWriter { type: key.type as aasv2.KeyElements, value: key.value, index: index, - local: true + local: true, } as aasv2.Key; - }) + }), }; } @@ -325,7 +327,7 @@ export class JsonWriterV2 extends AASWriter { ...this.writeHasSemantic(source), ...this.writeHasDataSpecification(source), ...this.writeQualifiable(source), - ...this.writeHasKind(source) + ...this.writeHasKind(source), }; } @@ -337,7 +339,7 @@ export class JsonWriterV2 extends AASWriter { const identification = this.writeIdentifier(source.id); const identifiable: aasv2.Identifiable = { ...this.writeReferable(source), - identification + identification, }; if (source.administration) { @@ -350,19 +352,19 @@ export class JsonWriterV2 extends AASWriter { private writeIdentifier(id: string): aasv2.Identifier { let idType: aasv2.KeyType; try { - const _ = new URL(id); + new URL(id); idType = 'IRI'; - } catch (_) { + } catch { idType = 'IRDI'; } - return { id, idType } + return { id, idType }; } private writeReferable(source: aas.Referable): aasv2.Referable { const referable: aasv2.Referable = { idShort: source.idShort, - modelType: { name: this.writeModelTypes(source.modelType) } + modelType: { name: this.writeModelTypes(source.modelType) }, }; if (source.category) { @@ -379,8 +381,9 @@ export class JsonWriterV2 extends AASWriter { private writeHasDataSpecification(source: aas.HasDataSpecification): aasv2.HasDataSpecification { const hasDataSpecification: aasv2.HasDataSpecification = {}; if (source.embeddedDataSpecifications) { - hasDataSpecification.embeddedDataSpecifications = source.embeddedDataSpecifications - .map(item => this.writeEmbeddedDatSpecification(item)); + hasDataSpecification.embeddedDataSpecifications = source.embeddedDataSpecifications.map(item => + this.writeEmbeddedDatSpecification(item), + ); } return hasDataSpecification; @@ -396,24 +399,27 @@ export class JsonWriterV2 extends AASWriter { } const dataSpecificationContent = this.writeDataSpecificationIEC61360( - source.dataSpecificationContent as aas.DataSpecificationIEC61360); + source.dataSpecificationContent as aas.DataSpecificationIEC61360, + ); const specification: aasv2.EmbeddedDataSpecification = { dataSpecification: this.writeReference(source.dataSpecification), - dataSpecificationContent + dataSpecificationContent, }; return specification; } - private writeDataSpecificationIEC61360(source: aas.DataSpecificationIEC61360): aasv2.DataSpecificationIEC61360Content { + private writeDataSpecificationIEC61360( + source: aas.DataSpecificationIEC61360, + ): aasv2.DataSpecificationIEC61360Content { if (!source.preferredName) { throw new Error(`DataSpecificationIEC61360.preferredName`); } const iec61360: aasv2.DataSpecificationIEC61360Content = { - preferredName: source.preferredName - } + preferredName: source.preferredName, + }; if (source.dataType) { iec61360.dataType = this.writeDataTypeIEC61360(source.dataType); @@ -467,18 +473,20 @@ export class JsonWriterV2 extends AASWriter { throw new Error('ValueList.valueReferencePairs'); } - return { valueReferencePairTypes: source.valueReferencePairs.map(item => { - const pair: aasv2.ValueReferencePairType = {}; - if (item.value) { - pair.value = item.value; - } + return { + valueReferencePairTypes: source.valueReferencePairs.map(item => { + const pair: aasv2.ValueReferencePairType = {}; + if (item.value) { + pair.value = item.value; + } - if (item.valueId) { - pair.valueId = this.writeReference(item.valueId); - } + if (item.valueId) { + pair.valueId = this.writeReference(item.valueId); + } - return pair; - }) }; + return pair; + }), + }; } private writeDataTypeIEC61360(source: aas.DataTypeIEC61360): aasv2.DataTypeIEC61360 { @@ -518,7 +526,7 @@ export class JsonWriterV2 extends AASWriter { const qualifier: aasv2.Qualifier = { modelType: { name: 'Qualifier' }, type: source.type, - valueType: this.writeDataTypeDefXsd(source.valueType) + valueType: this.writeDataTypeDefXsd(source.valueType), }; if (source.value) { @@ -608,12 +616,15 @@ export class JsonWriterV2 extends AASWriter { } private writeKeyType(source: aas.Key): aasv2.KeyType { - if (source.type === 'Submodel' || source.type === 'AssetAdministrationShell' || - source.type === 'ConceptDescription') { + if ( + source.type === 'Submodel' || + source.type === 'AssetAdministrationShell' || + source.type === 'ConceptDescription' + ) { try { - const _ = new URL(source.value); + new URL(source.value); return 'IRI'; - } catch (_) { + } catch { return 'IRDI'; } } @@ -629,4 +640,4 @@ export class JsonWriterV2 extends AASWriter { return source as aasv2.ModelTypes; } } -} \ No newline at end of file +} diff --git a/projects/aas-server/src/app/packages/json-writer.ts b/projects/aas-server/src/app/packages/json-writer.ts index e3805f0e..76e815d7 100644 --- a/projects/aas-server/src/app/packages/json-writer.ts +++ b/projects/aas-server/src/app/packages/json-writer.ts @@ -12,11 +12,11 @@ import { AASWriter } from './aas-writer.js'; /** */ export class JsonWriter extends AASWriter { - public writeEnvironment(env: aas.Environment): any { + public override writeEnvironment(env: aas.Environment): T { const conceptDescriptions = this.writeConceptDescriptions(env); const assetAdministrationShells = this.writeAssetAdministrationShells(env); const submodels = this.writeSubmodels(env); - return { assetAdministrationShells, submodels, conceptDescriptions }; + return { assetAdministrationShells, submodels, conceptDescriptions } as T; } /** @@ -24,14 +24,14 @@ export class JsonWriter extends AASWriter { * @param data The serialized Submodel or SubmodelElement. * @returns The deserialized Submodel or SubmodelElement. */ - public write(source: aas.Referable): any { + public write(source: aas.Referable): T { switch (source.modelType) { case 'AssetAdministrationShell': throw new Error('Invalid operation.'); case 'Submodel': - return this.writeSubmodel(source as aas.Submodel); + return this.writeSubmodel(source as aas.Submodel) as T; default: - return this.writeSubmodelElement(source as aas.SubmodelElement)!; + return this.writeSubmodelElement(source as aas.SubmodelElement) as T; } } @@ -65,7 +65,7 @@ export class JsonWriter extends AASWriter { const shell: aas.AssetAdministrationShell = { ...this.writeIdentifiable(source), ...this.writeHasDataSpecification(source), - assetInformation: this.writeAssetInformation(source.assetInformation) + assetInformation: this.writeAssetInformation(source.assetInformation), }; if (source.derivedFrom) { @@ -117,7 +117,7 @@ export class JsonWriter extends AASWriter { ...this.writeHasSemantic, name: source.name, value: source.value, - externalSubjectId: this.writeReference(source.externalSubjectId) + externalSubjectId: this.writeReference(source.externalSubjectId), }; } @@ -137,7 +137,7 @@ export class JsonWriter extends AASWriter { private writeConceptDescription(source: aas.ConceptDescription): aas.ConceptDescription { const conceptDescription: aas.ConceptDescription = { ...this.writeIdentifiable(source), - ...this.writeHasDataSpecification(source) + ...this.writeHasDataSpecification(source), }; if (source.isCaseOf) { @@ -164,7 +164,7 @@ export class JsonWriter extends AASWriter { ...this.writeHasSemantic(source), ...this.writeQualifiable(source), ...this.writeHasKind(source), - ...this.writeHasDataSpecification(source) + ...this.writeHasDataSpecification(source), }; if (source.submodelElements) { @@ -221,19 +221,19 @@ export class JsonWriter extends AASWriter { private writeSubmodelElementType(source: aas.SubmodelElement): aas.SubmodelElement { return { - ...this.writeReferable(source, undefined), + ...this.writeReferable(source), ...this.writeHasSemantic(source), ...this.writeHasKind(source), ...this.writeHasDataSpecification(source), - ...this.writeQualifiable(source) + ...this.writeQualifiable(source), }; } private writeAnnotatedRelationshipElement( source: aas.AnnotatedRelationshipElement, - ancestors?: aas.Referable[]): aas.AnnotatedRelationshipElement { + ): aas.AnnotatedRelationshipElement { if (!source.annotations) { - throw new Error('AnnotatedRelationshipElement.annotation') + throw new Error('AnnotatedRelationshipElement.annotation'); } const relationship: aas.AnnotatedRelationshipElement = { @@ -244,7 +244,7 @@ export class JsonWriter extends AASWriter { return relationship; } - private writeEventElement(source: aas.EventElement, ancestor?: aas.Referable[]): aas.EventElement { + private writeEventElement(source: aas.EventElement): aas.EventElement { return { ...this.writeSubmodelElementType(source) }; } @@ -265,7 +265,7 @@ export class JsonWriter extends AASWriter { ...this.writeEventElement(source), observed: source.observed, direction: source.direction, - state: source.state + state: source.state, }; if (source.messageTopic) { @@ -298,7 +298,7 @@ export class JsonWriter extends AASWriter { const property: aas.Property = { ...this.writeSubmodelElementType(source), - valueType: source.valueType + valueType: source.valueType, }; if (source.value) { @@ -323,7 +323,7 @@ export class JsonWriter extends AASWriter { private writeOperation(source: aas.Operation): aas.Operation { const operation: aas.Operation = { - ...this.writeSubmodelElementType(source) + ...this.writeSubmodelElementType(source), }; if (source.inputVariables) { @@ -360,7 +360,7 @@ export class JsonWriter extends AASWriter { const file: aas.File = { ...this.writeSubmodelElementType(source), - contentType + contentType, }; if (source.value) { @@ -377,7 +377,7 @@ export class JsonWriter extends AASWriter { const blob: aas.Blob = { ...this.writeSubmodelElementType(source), - contentType: source.contentType + contentType: source.contentType, }; if (source.value) { @@ -394,7 +394,7 @@ export class JsonWriter extends AASWriter { const entity: aas.Entity = { ...this.writeSubmodelElementType(source), - entityType: source.entityType + entityType: source.entityType, }; if (source.statements) { @@ -412,11 +412,9 @@ export class JsonWriter extends AASWriter { return entity; } - private writeSubmodelElementCollection( - source: aas.SubmodelElementCollection, - ancestors?: aas.Referable[]): aas.SubmodelElementCollection { + private writeSubmodelElementCollection(source: aas.SubmodelElementCollection): aas.SubmodelElementCollection { const collection: aas.SubmodelElementCollection = { - ...this.writeSubmodelElementType(source) + ...this.writeSubmodelElementType(source), }; if (source.value) { @@ -434,7 +432,7 @@ export class JsonWriter extends AASWriter { const list: aas.SubmodelElementList = { ...this.writeSubmodelElementType(source), typeValueListElement: source.typeValueListElement, - valueTypeListElement: source.valueTypeListElement + valueTypeListElement: source.valueTypeListElement, }; if (source.orderRelevant) { @@ -459,7 +457,7 @@ export class JsonWriter extends AASWriter { const reference: aas.ReferenceElement = { ...this.writeSubmodelElementType(source), - value: this.writeReference(source.value) + value: this.writeReference(source.value), }; return reference; @@ -467,17 +465,17 @@ export class JsonWriter extends AASWriter { private writeRelationshipElement(source: aas.RelationshipElement): aas.RelationshipElement { if (!source.first) { - throw new Error('RelationshipElement.first') + throw new Error('RelationshipElement.first'); } if (!source.second) { - throw new Error('RelationshipElement.second') + throw new Error('RelationshipElement.second'); } const relationship: aas.RelationshipElement = { ...this.writeSubmodelElementType(source), first: this.writeReference(source.first), - second: this.writeReference(source.second) + second: this.writeReference(source.second), }; return relationship; @@ -490,7 +488,7 @@ export class JsonWriter extends AASWriter { const range: aas.Range = { ...this.writeSubmodelElementType(source), - valueType: source.valueType + valueType: source.valueType, }; if (source.min) { @@ -538,7 +536,7 @@ export class JsonWriter extends AASWriter { const qualifier: aas.Qualifier = { ...this.writeHasSemantic(source), type: source.type, - valueType: source.valueType + valueType: source.valueType, }; if (source.kind) { @@ -556,7 +554,7 @@ export class JsonWriter extends AASWriter { return qualifier; } - private writeReferable(source: aas.Referable, id?: string): aas.Referable { + private writeReferable(source: aas.Referable): aas.Referable { if (!source.modelType) { throw Error(`Referable.modelType.`); } @@ -580,8 +578,8 @@ export class JsonWriter extends AASWriter { } const identifiable: aas.Identifiable = { - ...this.writeReferable(source, source.id), - id: source.id + ...this.writeReferable(source), + id: source.id, }; if (source.administration) { @@ -594,7 +592,7 @@ export class JsonWriter extends AASWriter { private writeReference(source: aas.Reference): aas.Reference { return { type: source.type, - keys: source.keys.map((key, index) => { + keys: source.keys.map(key => { if (!key.type) { throw new Error(`Reference.type`); } @@ -607,15 +605,16 @@ export class JsonWriter extends AASWriter { type: key.type, value: key.value, } as aas.Key; - }) + }), }; } private writeHasDataSpecification(source: aas.HasDataSpecification): aas.HasDataSpecification { const hasDataSpecification: aas.HasDataSpecification = {}; if (source.embeddedDataSpecifications) { - hasDataSpecification.embeddedDataSpecifications = source.embeddedDataSpecifications - .map(item => this.writeEmbeddedDatSpecification(item)); + hasDataSpecification.embeddedDataSpecifications = source.embeddedDataSpecifications.map(item => + this.writeEmbeddedDatSpecification(item), + ); } return hasDataSpecification; @@ -633,14 +632,17 @@ export class JsonWriter extends AASWriter { let dataSpecificationContent: aas.DataSpecificationContent; if (source.dataSpecificationContent.modelType === 'DataSpecificationIEC61360') { dataSpecificationContent = this.writeDataSpecificationIEC61360( - source.dataSpecificationContent as aas.DataSpecificationIEC61360); + source.dataSpecificationContent as aas.DataSpecificationIEC61360, + ); } else { - throw new Error(`${source.dataSpecificationContent.modelType} is a not supported DataSpecificationContent.`); + throw new Error( + `${source.dataSpecificationContent.modelType} is a not supported DataSpecificationContent.`, + ); } const specification: aas.EmbeddedDataSpecification = { dataSpecification: this.writeReference(source.dataSpecification), - dataSpecificationContent + dataSpecificationContent, }; return specification; @@ -653,8 +655,8 @@ export class JsonWriter extends AASWriter { const iec61360: aas.DataSpecificationIEC61360 = { modelType: source.modelType, - preferredName: source.preferredName - } + preferredName: source.preferredName, + }; if (source.dataType) { iec61360.dataType = source.dataType; @@ -709,7 +711,7 @@ export class JsonWriter extends AASWriter { } const valueList: aas.ValueList = { - valueReferencePairs: source.valueReferencePairs.map(item => this.writeValueReferencePair(item)) + valueReferencePairs: source.valueReferencePairs.map(item => this.writeValueReferencePair(item)), }; return valueList; @@ -726,4 +728,4 @@ export class JsonWriter extends AASWriter { return { value: source.value, valueId: this.writeReference(source.valueId) }; } -} \ No newline at end of file +} diff --git a/projects/aas-server/src/app/packages/opcua/client-file.ts b/projects/aas-server/src/app/packages/opcua/client-file.ts index b1d83bf1..7a6e7ea8 100644 --- a/projects/aas-server/src/app/packages/opcua/client-file.ts +++ b/projects/aas-server/src/app/packages/opcua/client-file.ts @@ -15,11 +15,11 @@ import { NodeId, ResultMask, StatusCodes, - VariantArrayType + VariantArrayType, } from 'node-opcua'; export enum OpenFileMode { - Read = 1 + Read = 1, } export class ClientFile { @@ -29,7 +29,10 @@ export class ClientFile { private closeMethodNodeId?: NodeId; private readMethodNodeId?: NodeId; - constructor(private session: ClientSession, fileNodeId: NodeId | string) { + public constructor( + private session: ClientSession, + fileNodeId: NodeId | string, + ) { this.fileNodeId = NodeId.resolveNodeId(fileNodeId); } @@ -47,15 +50,15 @@ export class ClientFile { } const result = await this.session.call({ - inputArguments: [ - { dataType: DataType.Byte, value: mode as Byte } - ], + inputArguments: [{ dataType: DataType.Byte, value: mode as Byte }], methodId: this.openMethodNodeId, - objectId: this.fileNodeId + objectId: this.fileNodeId, }); if (result.statusCode !== StatusCodes.Good) { - throw new Error('cannot open file statusCode = ' + result.statusCode.toString() + ' mode = ' + OpenFileMode[mode]); + throw new Error( + 'cannot open file statusCode = ' + result.statusCode.toString() + ' mode = ' + OpenFileMode[mode], + ); } this.fileHandle = result.outputArguments![0].value; @@ -73,11 +76,9 @@ export class ClientFile { } const result = await this.session.call({ - inputArguments: [ - { dataType: DataType.UInt32, value: this.fileHandle } - ], + inputArguments: [{ dataType: DataType.UInt32, value: this.fileHandle }], methodId: this.closeMethodNodeId, - objectId: this.fileNodeId + objectId: this.fileNodeId, }); if (result.statusCode !== StatusCodes.Good) { @@ -102,11 +103,11 @@ export class ClientFile { { arrayType: VariantArrayType.Scalar, dataType: DataType.Int32, - value: bytesToRead - } + value: bytesToRead, + }, ], methodId: this.readMethodNodeId, - objectId: this.fileNodeId + objectId: this.fileNodeId, }); if (result.statusCode !== StatusCodes.Good) { @@ -124,7 +125,7 @@ export class ClientFile { const result = await this.session.browse({ browseDirection: BrowseDirection.Forward, nodeId: this.fileNodeId, - resultMask: ResultMask.BrowseName | ResultMask.TypeDefinition + resultMask: ResultMask.BrowseName | ResultMask.TypeDefinition, }); if (result.references) { @@ -143,4 +144,4 @@ export class ClientFile { } } } -} \ No newline at end of file +} diff --git a/projects/aas-server/src/app/packages/opcua/opaque-structure-decoder.ts b/projects/aas-server/src/app/packages/opcua/opaque-structure-decoder.ts index ddbaa188..10094dfe 100644 --- a/projects/aas-server/src/app/packages/opcua/opaque-structure-decoder.ts +++ b/projects/aas-server/src/app/packages/opcua/opaque-structure-decoder.ts @@ -9,7 +9,7 @@ import { BinaryStream, DataValueOptions } from 'node-opcua'; import { OpaqueStructure } from 'node-opcua-extension-object'; import { aas } from 'common'; -import { UAKeyElements, UAKeyType } from './opcua.js'; +import { UAKeyElements } from './opcua.js'; export function decodeOpaqueStructure(value: OpaqueStructure, dataType: string): DataValueOptions { if (dataType === 'AASKeyDataType') { @@ -17,8 +17,8 @@ export function decodeOpaqueStructure(value: OpaqueStructure, dataType: string): value: { arrayType: 'Array', dimensions: [1], - value: decodeToKeyArray(value.buffer) - } + value: decodeToKeyArray(value.buffer), + }, }; } @@ -32,7 +32,7 @@ export function decodeOpaqueStructure(value: OpaqueStructure, dataType: string): const id = stream.readString() as string; keys.push({ type: toKeyTypes(type), - value: id + value: id, }); } @@ -42,4 +42,4 @@ export function decodeOpaqueStructure(value: OpaqueStructure, dataType: string): return UAKeyElements[value] as aas.KeyTypes; } } -} \ No newline at end of file +} diff --git a/projects/aas-server/src/app/packages/opcua/opcua-data-type-dictionary.ts b/projects/aas-server/src/app/packages/opcua/opcua-data-type-dictionary.ts index bad322f6..7472acf3 100644 --- a/projects/aas-server/src/app/packages/opcua/opcua-data-type-dictionary.ts +++ b/projects/aas-server/src/app/packages/opcua/opcua-data-type-dictionary.ts @@ -25,7 +25,7 @@ export class OpcuaDataTypeDictionary { return this.toDataTypeDefXsd(entry?.name); } - + public async initializeAsync(session: ClientSession): Promise { this.dataTypes.clear(); await this.browseAsync(session, 'DataTypesFolder'); @@ -38,7 +38,7 @@ export class OpcuaDataTypeDictionary { if (obj.nodeClass === NodeClass.DataType && obj.browseName.name) { this.dataTypes.set(obj.nodeId.toString(), { name: obj.browseName.name, - baseType: null + baseType: null, }); } @@ -48,8 +48,9 @@ export class OpcuaDataTypeDictionary { } } } - + + // eslint-disable-next-line @typescript-eslint/no-unused-vars private toDataTypeDefXsd(name: string | undefined): aas.DataTypeDefXsd { throw new Error('Method not implemented.'); } -} \ No newline at end of file +} diff --git a/projects/aas-server/src/app/packages/opcua/opcua-package.ts b/projects/aas-server/src/app/packages/opcua/opcua-package.ts index d0ec4643..af85538d 100644 --- a/projects/aas-server/src/app/packages/opcua/opcua-package.ts +++ b/projects/aas-server/src/app/packages/opcua/opcua-package.ts @@ -25,11 +25,7 @@ export class OpcuaPackage extends AASPackage { private readonly nodeId: string; private readonly dataTypes: OpcuaDataTypeDictionary; - constructor( - logger: Logger, - server: OpcuaServer, - nodeId: string, - dataTypes?: OpcuaDataTypeDictionary) { + public constructor(logger: Logger, server: OpcuaServer, nodeId: string, dataTypes?: OpcuaDataTypeDictionary) { super(logger); this.server = server; @@ -80,7 +76,7 @@ export class OpcuaPackage extends AASPackage { } const clientFile = new ClientFile(session, file.nodeId); - await clientFile.open(OpenFileMode.Read) + await clientFile.open(OpenFileMode.Read); try { const buffer = await clientFile.read(0); return Readable.from(buffer); @@ -91,7 +87,7 @@ export class OpcuaPackage extends AASPackage { private async crawlAsync(): Promise { const crawler = new NodeCrawler(this.server.getSession()); - const component = await crawler.read(NodeId.resolveNodeId(this.nodeId)) as OPCUAComponent; + const component = (await crawler.read(NodeId.resolveNodeId(this.nodeId))) as OPCUAComponent; await this.resolveAsync(component); return component; } @@ -129,11 +125,10 @@ export class OpcuaPackage extends AASPackage { } private async readDataValueAsync(session: ClientSession, property: OPCUAProperty): Promise { - return await session.read( - { - nodeId: property.nodeId, - attributeId: AttributeIds.Value - }); + return await session.read({ + nodeId: property.nodeId, + attributeId: AttributeIds.Value, + }); } private readOpaqueStructure(dataValue: DataValue): OpaqueStructure[] | undefined { @@ -189,4 +184,4 @@ export class OpcuaPackage extends AASPackage { return value; } -} \ No newline at end of file +} diff --git a/projects/aas-server/src/app/packages/opcua/opcua-reader.ts b/projects/aas-server/src/app/packages/opcua/opcua-reader.ts index aea4206e..01e28ce0 100644 --- a/projects/aas-server/src/app/packages/opcua/opcua-reader.ts +++ b/projects/aas-server/src/app/packages/opcua/opcua-reader.ts @@ -6,11 +6,11 @@ * *****************************************************************************/ -import { aas, convertToString, determineType } from "common"; -import { ArgumentOptions, LocalizedText, VariantArrayType, VariantOptions } from "node-opcua"; -import { Logger } from "../../logging/logger.js"; -import { AASReader } from "../aas-reader.js"; -import { OpcuaDataTypeDictionary } from "./opcua-data-type-dictionary.js"; +import { aas, convertToString, determineType } from 'common'; +import { ArgumentOptions, LocalizedText, VariantArrayType, VariantOptions } from 'node-opcua'; +import { Logger } from '../../logging/logger.js'; +import { AASReader } from '../aas-reader.js'; +import { OpcuaDataTypeDictionary } from './opcua-data-type-dictionary.js'; import { OPCUAComponent, OPCUAProperty, @@ -18,15 +18,16 @@ import { UAEntityType, UAKey, UAKeyElements, - ValueType -} from "./opcua.js"; + ValueType, +} from './opcua.js'; import { noop } from 'lodash-es'; export class OpcuaReader extends AASReader { - constructor( + public constructor( private readonly logger: Logger, private readonly origin: OPCUAComponent, - private readonly dataTypes: OpcuaDataTypeDictionary) { + private readonly dataTypes: OpcuaDataTypeDictionary, + ) { super(); } @@ -34,10 +35,11 @@ export class OpcuaReader extends AASReader { const conceptDescriptions = this.readConceptDescriptions(); const assetAdministrationShells = this.readAssetAdministrationShells(); const submodels: aas.Submodel[] = this.readSubmodels(this.origin); - return { assetAdministrationShells, submodels, conceptDescriptions } + return { assetAdministrationShells, submodels, conceptDescriptions }; } - public read(data: any): aas.Referable { + // eslint-disable-next-line @typescript-eslint/no-unused-vars + public read(data: unknown): aas.Referable { throw new Error('Not implemented.'); } @@ -55,8 +57,8 @@ export class OpcuaReader extends AASReader { const shell: aas.AssetAdministrationShell = { ...this.readIdentifiable(component), ...this.readHasDataSpecification(component), - assetInformation: this.readAssetInformation(component) - } + assetInformation: this.readAssetInformation(component), + }; const submodels = this.readReferenceList(component, 'Submodel'); if (submodels) { @@ -71,12 +73,12 @@ export class OpcuaReader extends AASReader { let globalAssetId: string | undefined; const assetComponent = this.selectComponent(this.origin, 'Asset'); if (assetComponent) { - assetKind = this.readPropertyValue(assetComponent, 'AssetKind') ?? 'Instance'; - globalAssetId = this.readIdentifier(assetComponent); + assetKind = this.readEnumProperty(assetComponent, 'AssetKind') ?? 'Instance'; + globalAssetId = this.readIdentifier(assetComponent); } else { const infoComponent = this.selectComponent(component, undefined, 'AASAssetInformationType'); if (infoComponent) { - assetKind = this.readPropertyValue(infoComponent, 'AssetKind') ?? 'Instance'; + assetKind = this.readEnumProperty(infoComponent, 'AssetKind') ?? 'Instance'; globalAssetId = this.readReference(infoComponent, 'GlobalAssetId')?.keys[0].value; } } @@ -111,18 +113,18 @@ export class OpcuaReader extends AASReader { ...this.readHasSemantic(component), ...this.readQualifiable(component), ...this.readHasKind(component), - ...this.readHasDataSpecification(component) - } + ...this.readHasDataSpecification(component), + }; - const submodelElements = this.readSubmodelElements( - component, - { - type: 'ModelReference', - keys: [{ + const submodelElements = this.readSubmodelElements(component, { + type: 'ModelReference', + keys: [ + { type: 'Submodel', value: submodel.id, - }] - }); + }, + ], + }); if (submodelElements.length > 0) { submodel.submodelElements = submodelElements; } @@ -131,7 +133,8 @@ export class OpcuaReader extends AASReader { } private readSubmodelElements(component: OPCUAComponent, parent?: aas.Reference): aas.SubmodelElement[] { - const results = this.where(component.hasComponent, + const results = this.where( + component.hasComponent, 'AASBlobType', 'AASCapabilityType', 'AASEventType', @@ -144,7 +147,8 @@ export class OpcuaReader extends AASReader { 'AASEntityType', 'AASReferenceElementType', 'AASRelationshipElementType', - 'AASOperationType'); + 'AASOperationType', + ); const submodelElements: aas.SubmodelElement[] = []; for (const component of results) { @@ -217,11 +221,12 @@ export class OpcuaReader extends AASReader { private readSubmodelElementCollection( component: OPCUAComponent, - parent?: aas.Reference): aas.SubmodelElementCollection { + parent?: aas.Reference, + ): aas.SubmodelElementCollection { const base = this.readSubmodelElementType(component, parent); const collection: aas.SubmodelElementCollection = { - ...base - } + ...base, + }; const value = this.readSubmodelElements(component, parent ? this.createReference(parent, base) : undefined); if (value.length > 0) { @@ -245,7 +250,7 @@ export class OpcuaReader extends AASReader { const property: aas.Property = { ...this.readSubmodelElementType(component, parent), valueType: valueType, - nodeId: this.findProperty(component, 'Value')?.nodeId.toString() + nodeId: this.findProperty(component, 'Value')?.nodeId.toString(), }; if (value) { @@ -256,17 +261,17 @@ export class OpcuaReader extends AASReader { } private readFile(component: OPCUAComponent, parent?: aas.Reference): aas.File { - const contentType: string = this.readPropertyValue(component, 'MimeType'); + const contentType = this.readStringProperty(component, 'MimeType'); if (!contentType) { throw new Error('File.mimeType'); } const file: aas.File = { ...this.readSubmodelElementType(component, parent), - contentType + contentType, }; - const value: string = this.readPropertyValue(component, 'Value'); + const value = this.readStringProperty(component, 'Value'); if (value) { file.value = value; } @@ -288,21 +293,23 @@ export class OpcuaReader extends AASReader { let langStrings: aas.LangString[] | undefined; const value: LocalizedText[] = this.readPropertyValue(component, propertyName); if (value) { - langStrings = value.map(item => ({ language: item.locale, text: item.text } as aas.LangString)); + langStrings = value.map(item => ({ language: item.locale, text: item.text }) as aas.LangString); } return langStrings; } private readEntity(component: OPCUAComponent, parent?: aas.Reference): aas.Entity { - const entityType: aas.EntityType | undefined = this.toEntityType(this.readPropertyValue(component, 'EntityType')); + const entityType: aas.EntityType | undefined = this.toEntityType( + this.readPropertyValue(component, 'EntityType'), + ); if (!entityType) { throw new Error('Entity.entityType'); } const entity: aas.Entity = { ...this.readSubmodelElementType(component, parent), - entityType + entityType, }; const asset = this.readReference(component, 'Asset'); @@ -323,7 +330,7 @@ export class OpcuaReader extends AASReader { return { ...this.readSubmodelElementType(component, parent), - value + value, }; } @@ -333,7 +340,8 @@ export class OpcuaReader extends AASReader { const inoutputVariables: aas.OperationVariable[] = []; let methodId: string | undefined; let objectId: string | undefined; - const opComponent = this.selectComponent(component, undefined, 'Operation') ?? this.findOperationNode(component); + const opComponent = + this.selectComponent(component, undefined, 'Operation') ?? this.findOperationNode(component); if (opComponent) { methodId = opComponent.nodeId?.toString(); objectId = component.nodeId?.toString(); @@ -433,7 +441,7 @@ export class OpcuaReader extends AASReader { modelType: 'Property', idShort: argument.name!, kind: 'Instance', - valueType: this.dataTypes.get(argument.dataType) + valueType: this.dataTypes.get(argument.dataType), }; return { value }; @@ -445,7 +453,7 @@ export class OpcuaReader extends AASReader { ...this.readHasSemantic(component), ...this.readHasKind(component), ...this.readHasDataSpecification(component), - ...this.readQualifiable(component) + ...this.readQualifiable(component), }; } @@ -472,12 +480,12 @@ export class OpcuaReader extends AASReader { private readAdministrativeInformation(component: OPCUAComponent): aas.AdministrativeInformation | undefined { const info: aas.AdministrativeInformation = {}; - const version: string = this.readPropertyValue(component, 'Version'); + const version = this.readStringProperty(component, 'Version'); if (version) { info.version = version; } - const revision: string = this.readPropertyValue(component, 'Revision'); + const revision = this.readStringProperty(component, 'Revision'); if (revision) { info.revision = revision; } @@ -488,14 +496,14 @@ export class OpcuaReader extends AASReader { private readReferable(component: OPCUAComponent, parent?: aas.Reference): aas.Referable { const referable: aas.Referable = { idShort: component.browseName, - modelType: this.readModelType(component) + modelType: this.readModelType(component), }; if (parent) { referable.parent = parent; } - const category: aas.Category = this.readPropertyValue(component, 'Category'); + const category = this.readEnumProperty(component, 'Category'); if (category) { referable.category = category; } @@ -514,12 +522,12 @@ export class OpcuaReader extends AASReader { } private readHasKind(component: OPCUAComponent): aas.HasKind { - return { kind: this.readPropertyValue(component, 'ModellingKind') ?? 'Instance' }; + return { kind: this.readEnumProperty(component, 'ModellingKind') ?? 'Instance' }; } private readHasDataSpecification(component: OPCUAComponent): aas.HasDataSpecification { const dataSpecification: aas.HasDataSpecification = {}; - const child = this.selectComponent(component, 'DataSpecification', 'AASReferenceList') + const child = this.selectComponent(component, 'DataSpecification', 'AASReferenceList'); if (child?.hasComponent) { // ToDo: } @@ -538,7 +546,7 @@ export class OpcuaReader extends AASReader { } private readIdentifier(component: OPCUAComponent): string { - const id: string = this.readPropertyValue(component, 'Id'); + const id = this.readStringProperty(component, 'Id'); if (!id) { throw new Error('Identifier.id'); } @@ -547,8 +555,9 @@ export class OpcuaReader extends AASReader { } private selectComponent(parent: OPCUAComponent, name?: string, type?: TypeDefinition): OPCUAComponent | undefined { - return parent.hasComponent?.find(component => - (!name || component.browseName === name) && (!type || type === component.typeDefinition)); + return parent.hasComponent?.find( + component => (!name || component.browseName === name) && (!type || type === component.typeDefinition), + ); } private hasProperty(component: OPCUAComponent, browseName: string): boolean { @@ -575,7 +584,27 @@ export class OpcuaReader extends AASReader { return undefined; } - private readPropertyValue(component: OPCUAComponent, propertyName: string): any { + private readStringProperty(component: OPCUAComponent, propertyName: string): string | undefined { + const property = this.findProperty(component, propertyName); + const value = property?.dataValue.value?.value; + if (value && typeof value !== 'string') { + throw new Error(`Unexpected value type: expected string, actual ${typeof value}`); + } + + return value; + } + + private readEnumProperty(component: OPCUAComponent, propertyName: string): T | undefined { + const property = this.findProperty(component, propertyName); + const value = property?.dataValue.value?.value; + if (value && typeof value !== 'string') { + throw new Error(`Unexpected value type: expected string, actual ${typeof value}`); + } + + return value; + } + + private readPropertyValue(component: OPCUAComponent, propertyName: string): T { const property = this.findProperty(component, propertyName); return property?.dataValue.value?.value; } @@ -592,7 +621,7 @@ export class OpcuaReader extends AASReader { private toReference(value: UAKey[]): aas.Reference { return { type: 'ModelReference', - keys: value.map(item => this.readKey(item)) + keys: value.map(item => this.readKey(item)), }; } @@ -603,8 +632,7 @@ export class OpcuaReader extends AASReader { for (const component of components) { if (set.has(component.typeDefinition)) { items.push(component); - } - else if (component.typeDefinition === 'AASReferenceList') { + } else if (component.typeDefinition === 'AASReferenceList') { if (component.browseName === 'Submodel' && component.hasComponent) { for (const submodelReference of component.hasComponent) { if (submodelReference.hasAddIn) { @@ -616,8 +644,7 @@ export class OpcuaReader extends AASReader { } } } - } - else if (component.typeDefinition === 'FolderType') { + } else if (component.typeDefinition === 'FolderType') { if (component.hasComponent) { for (const folderComponent of component.hasComponent) { if (set.has(folderComponent.typeDefinition)) { @@ -641,7 +668,7 @@ export class OpcuaReader extends AASReader { return value as aas.EntityType; } - return value ? UAEntityType[value] as aas.EntityType : undefined; + return value ? (UAEntityType[value] as aas.EntityType) : undefined; } private isArray(value: VariantOptions | undefined): boolean { @@ -649,7 +676,7 @@ export class OpcuaReader extends AASReader { } private getArray(value: VariantOptions | undefined): T[] { - return value !== undefined ? value.value as T[] : []; + return value !== undefined ? (value.value as T[]) : []; } private readDataTypeDefXsd(value?: ValueType | string): aas.DataTypeDefXsd | undefined { @@ -690,4 +717,4 @@ export class OpcuaReader extends AASReader { return undefined; } -} \ No newline at end of file +} diff --git a/projects/aas-server/src/app/packages/opcua/opcua-server.ts b/projects/aas-server/src/app/packages/opcua/opcua-server.ts index 399f4ac3..ccad3d4a 100644 --- a/projects/aas-server/src/app/packages/opcua/opcua-server.ts +++ b/projects/aas-server/src/app/packages/opcua/opcua-server.ts @@ -26,7 +26,7 @@ import { StatusCodes, VariantArrayType, VariantOptions, - coerceNodeId + coerceNodeId, } from 'node-opcua'; export class OpcuaServer extends AASResource { @@ -35,7 +35,7 @@ export class OpcuaServer extends AASResource { private session: ClientSession | null = null; private reentry = 0; - constructor(logger: Logger, url: string, name: string, options?: OPCUAClientOptions) { + public constructor(logger: Logger, url: string, name: string, options?: OPCUAClientOptions) { super(logger, url, name); if (options) { @@ -45,7 +45,7 @@ export class OpcuaServer extends AASResource { applicationName: 'aas-server', connectionStrategy: { initialDelay: 1000, - maxRetry: 1 + maxRetry: 1, }, securityMode: MessageSecurityMode.None, securityPolicy: SecurityPolicy.None, @@ -64,8 +64,8 @@ export class OpcuaServer extends AASResource { return this.reentry > 0; } - /** - * Gets the current client session. + /** + * Gets the current client session. **/ public getSession(): ClientSession { if (this.reentry <= 0 || this.session == null) { @@ -135,15 +135,15 @@ export class OpcuaServer extends AASResource { public async invoke(env: aas.Environment, operation: aas.Operation): Promise { const inputArguments: Array = []; if (operation.inputVariables) { - for (let i = 0; i < operation.inputVariables.length; i++) { - inputArguments.push(await this.toVariantAsync(operation.inputVariables[i].value)); + for (const inputVariable of operation.inputVariables) { + inputArguments.push(await this.toVariantAsync(inputVariable.value)); } } const result = await this.session!.call({ inputArguments: inputArguments, methodId: coerceNodeId(operation.methodId), - objectId: coerceNodeId(operation.objectId) + objectId: coerceNodeId(operation.objectId), }); if (result.statusCode.value !== StatusCodes.Good.value) { @@ -179,10 +179,9 @@ export class OpcuaServer extends AASResource { private resolveConnectionStrategy(value?: ConnectionStrategyOptions): ConnectionStrategyOptions | undefined { if (value) { - value = - { + value = { initialDelay: value.initialDelay, - maxRetry: value.maxRetry + maxRetry: value.maxRetry, }; } @@ -191,9 +190,7 @@ export class OpcuaServer extends AASResource { private resolveMode(value?: string | MessageSecurityMode): MessageSecurityMode { if (value) { - return typeof value === 'string' - ? MessageSecurityMode[value as keyof typeof MessageSecurityMode] - : value; + return typeof value === 'string' ? MessageSecurityMode[value as keyof typeof MessageSecurityMode] : value; } return MessageSecurityMode.None; @@ -201,9 +198,7 @@ export class OpcuaServer extends AASResource { private resolvePolicy(value?: string | SecurityPolicy): SecurityPolicy { if (value) { - return typeof value === 'string' - ? SecurityPolicy[value as keyof typeof SecurityPolicy] - : value; + return typeof value === 'string' ? SecurityPolicy[value as keyof typeof SecurityPolicy] : value; } return SecurityPolicy.None; @@ -213,22 +208,22 @@ export class OpcuaServer extends AASResource { if (value.modelType === 'Property') { const property = value as aas.Property; switch (property.valueType) { - case 'xs:string': + case 'xs:string': { let buffer: Buffer; if (typeof property.value === 'string') { buffer = await fs.promises.readFile(property.value); + // eslint-disable-next-line @typescript-eslint/no-explicit-any } else if (property.value instanceof Buffer) { - buffer = property.value as Buffer; + // eslint-disable-next-line @typescript-eslint/no-explicit-any + buffer = (property.value) as Buffer; } else { throw new Error('Not supported File representation.'); } return this.createVariantOptions(VariantArrayType.Scalar, DataType.ByteString, buffer); + } default: - return this.createVariantOptions( - VariantArrayType.Scalar, - property.valueType, - property.value); + return this.createVariantOptions(VariantArrayType.Scalar, property.valueType, property.value); } } else { throw new Error('Not implemented.'); @@ -238,12 +233,15 @@ export class OpcuaServer extends AASResource { private createVariantOptions( arrayType: VariantArrayType, dataType: DataType | aas.DataTypeDefXsd | undefined, - value: any): VariantOptions { + value: unknown, + ): VariantOptions { if (typeof dataType === 'string') { + // eslint-disable-next-line @typescript-eslint/no-explicit-any dataType = (DataType)[dataType]; } if (typeof arrayType === 'string') { + // eslint-disable-next-line @typescript-eslint/no-explicit-any arrayType = (VariantArrayType)[arrayType]; } @@ -251,7 +249,7 @@ export class OpcuaServer extends AASResource { arrayType: arrayType, dataType: dataType, value: value, - dimensions: Array.isArray(value) ? [1] : null - } + dimensions: Array.isArray(value) ? [1] : null, + }; } -} \ No newline at end of file +} diff --git a/projects/aas-server/src/app/packages/opcua/opcua.ts b/projects/aas-server/src/app/packages/opcua/opcua.ts index 79a20171..403383d9 100644 --- a/projects/aas-server/src/app/packages/opcua/opcua.ts +++ b/projects/aas-server/src/app/packages/opcua/opcua.ts @@ -15,35 +15,35 @@ import { NodeId, ClientSession, AttributeIds, - QualifiedName + QualifiedName, } from 'node-opcua'; export type BaseTypeDefinition = 'Operation' | 'FolderType' | 'FileType'; export type AASTypeDefinition = - 'AASEnvironmentType' | - 'AASAssetInformationType' | - 'AASAssetAdministrationShellType' | - 'AASAssetType' | - 'AASEventType' | - 'AASBlobType' | - 'AASCapabilityType' | - 'AASEntityType' | - 'AASSubmodelType' | - 'AASSubmodelElementCollectionType' | - 'AASOrderedSubmodelElementCollectionType' | - 'AASPropertyType' | - 'AASFileType' | - 'AASViewType' | - 'AASContainedElementRefType' | - 'AASQualifierList' | - 'AASRangeType' | - 'AASReferenceElementType' | - 'AASReferenceType' | - 'AASReferenceList' | - 'AASRelationshipElementType' | - 'AASMultiLanguagePropertyType' | - 'AASOperationType'; + | 'AASEnvironmentType' + | 'AASAssetInformationType' + | 'AASAssetAdministrationShellType' + | 'AASAssetType' + | 'AASEventType' + | 'AASBlobType' + | 'AASCapabilityType' + | 'AASEntityType' + | 'AASSubmodelType' + | 'AASSubmodelElementCollectionType' + | 'AASOrderedSubmodelElementCollectionType' + | 'AASPropertyType' + | 'AASFileType' + | 'AASViewType' + | 'AASContainedElementRefType' + | 'AASQualifierList' + | 'AASRangeType' + | 'AASReferenceElementType' + | 'AASReferenceType' + | 'AASReferenceList' + | 'AASRelationshipElementType' + | 'AASMultiLanguagePropertyType' + | 'AASOperationType'; export interface AssetInformation { kind: aas.AssetKind; @@ -109,7 +109,7 @@ export enum ValueType { DateTime = 12, ByteString = 13, LocalizedText = 14, - UtcTime = 15 + UtcTime = 15, } export enum PropertyValueType { @@ -163,7 +163,7 @@ export enum PropertyValueType { Time, ENTITIES, IDREFS, - NMTOKENS + NMTOKENS, } export enum DataTypeIEC61360Type { @@ -181,12 +181,22 @@ export enum DataTypeIEC61360Type { RATIONAL, RATIONAL_MEASURE, TIME, - TIMESTAMP + TIMESTAMP, } -export enum UAIdentifierType { IRDI = 0, IRI = 1, Custom = 2 } +export enum UAIdentifierType { + IRDI = 0, + IRI = 1, + Custom = 2, +} -export enum UAKeyType { idShort = 0, FragmentId = 1, Custom = 2, IRDI = 3, IRI = 4 } +export enum UAKeyType { + idShort = 0, + FragmentId = 1, + Custom = 2, + IRDI = 3, + IRI = 4, +} export interface UAKey { idType: UAKeyType; @@ -197,7 +207,7 @@ export interface UAKey { export enum UAEntityType { CoManagedEntity, - SelfManagedEntity + SelfManagedEntity, } export interface OPCUAComponent extends OPCUANode { @@ -216,20 +226,21 @@ export interface OPCUAReadRequest { export interface AASKeyDataType { type: UAKeyElements; - value: any; + value: unknown; idType: UAKeyType; } export async function readDataTypeAsync(session: ClientSession, dataType: NodeIdLike): Promise { - const qualifiedName: QualifiedName = (await session.read( - { + const qualifiedName: QualifiedName = ( + await session.read({ nodeId: dataType, - attributeId: AttributeIds.BrowseName - })).value.value; + attributeId: AttributeIds.BrowseName, + }) + ).value.value; if (typeof qualifiedName.name === 'string') { return qualifiedName.name; } throw new Error('Invalid operation.'); -} \ No newline at end of file +} diff --git a/projects/aas-server/src/app/packages/server-message.ts b/projects/aas-server/src/app/packages/server-message.ts index af187d66..0469c52d 100644 --- a/projects/aas-server/src/app/packages/server-message.ts +++ b/projects/aas-server/src/app/packages/server-message.ts @@ -25,7 +25,7 @@ export class ServerMessage { port: url.port, path: url.pathname + url.search, method: 'GET', - timeout: 3000 + timeout: 3000, }; const request = http.request(options, response => { @@ -46,7 +46,8 @@ export class ServerMessage { response.on('error', error => reject(error)); }); - request.on('timeout', () => request.destroy()) + request + .on('timeout', () => request.destroy()) .on('error', error => reject(error)) .end(); }); @@ -64,11 +65,12 @@ export class ServerMessage { port: url.port, path: url.pathname + url.search, method: 'GET', - timeout: 3000 + timeout: 3000, }; const request = http.request(options, response => result(response)); - request.on('timeout', () => request.destroy()) + request + .on('timeout', () => request.destroy()) .on('error', error => reject(error)) .end(); }); @@ -89,27 +91,29 @@ export class ServerMessage { method: 'PUT', headers: { 'Content-Type': 'application/json', - 'Content-Length': Buffer.byteLength(data) - } + 'Content-Length': Buffer.byteLength(data), + }, }; - const request = http.request(options, (response) => { - let responseData = ''; - response.on('data', (chunk: string) => { - responseData += chunk; - }); - - response.on('end', () => { - try { - ServerMessage.checkStatusCode(response, responseData); - result(responseData); - } catch (error) { - reject(error); - } - }); - - response.on('error', error => reject(error)); - }).on('error', error => reject(error)); + const request = http + .request(options, response => { + let responseData = ''; + response.on('data', (chunk: string) => { + responseData += chunk; + }); + + response.on('end', () => { + try { + ServerMessage.checkStatusCode(response, responseData); + result(responseData); + } catch (error) { + reject(error); + } + }); + + response.on('error', error => reject(error)); + }) + .on('error', error => reject(error)); request.write(data); request.end(); @@ -137,8 +141,8 @@ export class ServerMessage { path: url.pathname + url.search, method: 'DELETE', headers: { - 'Content-Type': 'application/json' - } + 'Content-Type': 'application/json', + }, }; http.request(options, response => { @@ -157,7 +161,8 @@ export class ServerMessage { }); response.on('error', error => reject(error)); - }).on('error', error => reject(error)) + }) + .on('error', error => reject(error)) .end(); }); } @@ -202,27 +207,29 @@ export class ServerMessage { method: 'POST', headers: { 'Content-Type': 'application/json', - 'Content-Length': Buffer.byteLength(data) - } + 'Content-Length': Buffer.byteLength(data), + }, }; - const request = http.request(options, (response) => { - let responseData = ''; - response.on('data', (chunk: string) => { - responseData += chunk; - }); - - response.on('end', () => { - try { - ServerMessage.checkStatusCode(response, responseData); - result(responseData); - } catch (error) { - reject(error); - } - }); - - response.on('error', error => reject(error)); - }).on('error', error => reject(error)); + const request = http + .request(options, response => { + let responseData = ''; + response.on('data', (chunk: string) => { + responseData += chunk; + }); + + response.on('end', () => { + try { + ServerMessage.checkStatusCode(response, responseData); + result(responseData); + } catch (error) { + reject(error); + } + }); + + response.on('error', error => reject(error)); + }) + .on('error', error => reject(error)); request.write(data); request.end(); @@ -236,26 +243,28 @@ export class ServerMessage { port: url.port, path: url.pathname + url.search, method: 'POST', - headers: formData.getHeaders() + headers: formData.getHeaders(), }; - const request = http.request(options, (response) => { - let responseData = ''; - response.on('data', (chunk: string) => { - responseData += chunk; - }); - - response.on('end', function () { - try { - ServerMessage.checkStatusCode(response, responseData); - result(responseData); - } catch (error) { - reject(error); - } - }); - - response.on('error', error => reject(error)); - }).on('error', error => reject(error)); + const request = http + .request(options, response => { + let responseData = ''; + response.on('data', (chunk: string) => { + responseData += chunk; + }); + + response.on('end', function () { + try { + ServerMessage.checkStatusCode(response, responseData); + result(responseData); + } catch (error) { + reject(error); + } + }); + + response.on('error', error => reject(error)); + }) + .on('error', error => reject(error)); formData.pipe(request); }); @@ -267,9 +276,11 @@ export class ServerMessage { } if (response.statusCode < 200 || response.statusCode >= 300) { - throw new Error(data - ? `(${response.statusCode}) ${response.statusMessage}: ${data}` - : `(${response.statusCode}) ${response.statusMessage}.`); + throw new Error( + data + ? `(${response.statusCode}) ${response.statusMessage}: ${data}` + : `(${response.statusCode}) ${response.statusMessage}.`, + ); } } -} \ No newline at end of file +} diff --git a/projects/aas-server/src/app/packages/xml-reader.ts b/projects/aas-server/src/app/packages/xml-reader.ts index 4d3451f8..4476d344 100644 --- a/projects/aas-server/src/app/packages/xml-reader.ts +++ b/projects/aas-server/src/app/packages/xml-reader.ts @@ -21,9 +21,10 @@ export class XmlReader extends AASReader { private readonly document: Document; private iec61360 = 'IEC61360'; - constructor( + public constructor( private readonly logger: Logger, - xmlSource: string) { + xmlSource: string, + ) { super(); this.document = new DOMParser().parseFromString(xmlSource); @@ -34,17 +35,18 @@ export class XmlReader extends AASReader { const conceptDescriptions = this.readConceptDescriptions(); const assetAdministrationShells = this.readAssetAdministrationShells(); const submodels = this.readSubmodels(); - return { assetAdministrationShells, submodels, conceptDescriptions } + return { assetAdministrationShells, submodels, conceptDescriptions }; } - public read(data: any): aas.Referable { + // eslint-disable-next-line @typescript-eslint/no-unused-vars + public read(data: unknown): aas.Referable { throw new Error('Not implemented.'); } private getNamespaces(): { [key: string]: string } { let nsMap: { [key: string]: string }; if ('_nsMap' in this.document.documentElement) { - nsMap = ((this.document.documentElement as any) as NamespaceMap)._nsMap; + nsMap = (this.document.documentElement as unknown as NamespaceMap)._nsMap; } else { nsMap = {}; } @@ -69,7 +71,7 @@ export class XmlReader extends AASReader { const node = this.selectNode('/aas:aasenv/aas:assets/aas:asset', this.document); if (node) { assetKind = this.selectNode('./aas:kind', node)?.textContent as aas.AssetKind; - globalAssetId = this.readIdentifier(node); + globalAssetId = this.readIdentifier(node); } else { assetKind = 'Instance'; } @@ -79,7 +81,10 @@ export class XmlReader extends AASReader { private readAssetAdministrationShells(): aas.AssetAdministrationShell[] { const shells: aas.AssetAdministrationShell[] = []; - for (const node of this.selectNodes('/aas:aasenv/aas:assetAdministrationShells/aas:assetAdministrationShell', this.document)) { + for (const node of this.selectNodes( + '/aas:aasenv/aas:assetAdministrationShells/aas:assetAdministrationShell', + this.document, + )) { const shell = this.readAssetAdministrationShell(node); shells.push(shell); } @@ -96,7 +101,7 @@ export class XmlReader extends AASReader { const shell: aas.AssetAdministrationShell = { ...this.readIdentifiable(node), ...this.readHasDataSpecification(node), - assetInformation + assetInformation, }; const submodels = this.readReferences('./aas:submodelRefs/aas:submodelRef', node); @@ -112,6 +117,7 @@ export class XmlReader extends AASReader { return shell; } + // eslint-disable-next-line @typescript-eslint/no-unused-vars private readAdministrationInformation(path: string, node: Node): aas.AdministrativeInformation | undefined { return undefined; } @@ -132,18 +138,18 @@ export class XmlReader extends AASReader { ...this.readHaSemantic(node), ...this.readQualifiable(node), ...this.readHasKind(node), - ...this.readHasDataSpecification(node) + ...this.readHasDataSpecification(node), }; - const submodelElements = this.readSubmodelElements( - node, - { - type: 'ModelReference', - keys: [{ + const submodelElements = this.readSubmodelElements(node, { + type: 'ModelReference', + keys: [ + { type: 'Submodel', value: submodel.id, - }] - }); + }, + ], + }); if (submodelElements.length > 0) { submodel.submodelElements = submodelElements; } @@ -153,7 +159,7 @@ export class XmlReader extends AASReader { private readSubmodelElements(node: Node, parent?: aas.Reference): aas.SubmodelElement[] { const submodelElements: aas.SubmodelElement[] = []; - for (const child of this.selectNodes("./aas:submodelElements/aas:submodelElement/*[1]", node)) { + for (const child of this.selectNodes('./aas:submodelElements/aas:submodelElement/*[1]', node)) { const submodelElement = this.readSubmodelElement(child, parent); if (submodelElement) { submodelElements.push(submodelElement); @@ -165,7 +171,7 @@ export class XmlReader extends AASReader { private readCollectionValue(node: Node, parent?: aas.Reference): aas.SubmodelElement[] { const submodelElements: aas.SubmodelElement[] = []; - for (const child of this.selectNodes("./aas:value/aas:submodelElement/*[1]", node)) { + for (const child of this.selectNodes('./aas:value/aas:submodelElement/*[1]', node)) { const submodelElement = this.readSubmodelElement(child, parent); if (submodelElement) { submodelElements.push(submodelElement); @@ -181,6 +187,7 @@ export class XmlReader extends AASReader { switch (modelType) { case 'AnnotatedRelationshipElement': submodelElement = this.readAnnotatedRelationshipElement(node, parent); + break; case 'BasicEventElement': submodelElement = this.readBasicEventElement(node, parent); break; @@ -215,10 +222,12 @@ export class XmlReader extends AASReader { return submodelElement; } + // eslint-disable-next-line @typescript-eslint/no-unused-vars private readAnnotatedRelationshipElement(node: Node, parent?: aas.Reference): aas.AnnotatedRelationshipElement { throw new Error('Method not implemented.'); } + // eslint-disable-next-line @typescript-eslint/no-unused-vars private readBasicEventElement(node: Node, parent?: aas.Reference): aas.BasicEventElement { throw new Error('Method not implemented.'); } @@ -231,7 +240,7 @@ export class XmlReader extends AASReader { const blob: aas.Blob = { ...this.readSubmodelElementType(node, parent), - contentType + contentType, }; const value = this.selectNode('./aas:value', node)?.textContent; @@ -268,7 +277,7 @@ export class XmlReader extends AASReader { if (!valueType) { valueType = 'xs:string'; - value = '!!! Undefined value type !!!' + value = '!!! Undefined value type !!!'; } const property: aas.Property = { ...this.readSubmodelElementType(node, parent), valueType }; @@ -279,10 +288,12 @@ export class XmlReader extends AASReader { return property; } + // eslint-disable-next-line @typescript-eslint/no-unused-vars private readRange(node: Node, parent?: aas.Reference): aas.Range { throw new Error('Method not implemented.'); } + // eslint-disable-next-line @typescript-eslint/no-unused-vars private readRelationshipElement(node: Node, parent?: aas.Reference): aas.RelationshipElement { throw new Error('Method not implemented.'); } @@ -295,7 +306,7 @@ export class XmlReader extends AASReader { const file: aas.File = { ...this.readSubmodelElementType(node, parent), - contentType + contentType, }; const value = this.selectNode('./aas:value', node)?.textContent; @@ -322,7 +333,7 @@ export class XmlReader extends AASReader { ...this.readHaSemantic(node), ...this.readHasKind(node), ...this.readHasDataSpecification(node), - ...this.readQualifiable(node) + ...this.readQualifiable(node), }; } @@ -345,7 +356,7 @@ export class XmlReader extends AASReader { const referable: aas.Referable = { idShort, - modelType: this.getModelTypeFromLocalName(node) + modelType: this.getModelTypeFromLocalName(node), }; if (parent) { @@ -377,7 +388,8 @@ export class XmlReader extends AASReader { private readHasDataSpecification(node: Node): aas.HasDataSpecification { const embeddedDataSpecifications: aas.EmbeddedDataSpecification[] = []; for (const child of this.selectNodes('./aas:embeddedDataSpecification', node)) { - const dataSpecification = this.readReference('./aas:hasDataSpecification', child) ?? + const dataSpecification = + this.readReference('./aas:hasDataSpecification', child) ?? this.readReference('./aas:dataSpecification', child); if (!dataSpecification) { @@ -410,7 +422,7 @@ export class XmlReader extends AASReader { const dataSpecification: aas.DataSpecificationIEC61360 = { modelType: this.getModelTypeFromLocalName(node), - preferredName + preferredName, }; const shortName = this.readLangString(`./${this.iec61360}:shortName`, node); @@ -471,6 +483,7 @@ export class XmlReader extends AASReader { return dataSpecification; } + // eslint-disable-next-line @typescript-eslint/no-unused-vars private readValueList(path: string, node: Node): aas.ValueList | undefined { return undefined; } @@ -548,11 +561,11 @@ export class XmlReader extends AASReader { for (const node of this.selectNodes('./aas:langString', content)) { const language = (node as Element).getAttribute('lang')!.toLowerCase(); const text = node.textContent ?? ''; - langString.push({ language, text }) + langString.push({ language, text }); } if (langString.length === 0 && content.textContent) { - langString.push({ language: 'en', text: content.textContent }) + langString.push({ language: 'en', text: content.textContent }); } } @@ -563,7 +576,8 @@ export class XmlReader extends AASReader { const conceptDescriptions: aas.ConceptDescription[] = []; for (const node of this.selectNodes( '/aas:aasenv/aas:conceptDescriptions/aas:conceptDescription', - this.document)) { + this.document, + )) { conceptDescriptions.push(this.readConceptDescription(node)); } @@ -573,12 +587,12 @@ export class XmlReader extends AASReader { private readConceptDescription(node: Node): aas.ConceptDescription { const conceptDescription: aas.ConceptDescription = { ...this.readIdentifiable(node), - ...this.readHasDataSpecification(node) + ...this.readHasDataSpecification(node), }; const isCaseOf: aas.Reference[] = []; for (const refNode of this.selectNodes('./isCaseOf', node)) { - isCaseOf.push(this.readReference('.', node)!) + isCaseOf.push(this.readReference('.', refNode)!); } if (isCaseOf.length > 0) { @@ -590,7 +604,7 @@ export class XmlReader extends AASReader { private getModelTypeFromLocalName(node: Node): aas.ModelType { const localName: string = (node as Element).localName; - return localName.charAt(0).toUpperCase() + localName.substring(1) as aas.ModelType; + return (localName.charAt(0).toUpperCase() + localName.substring(1)) as aas.ModelType; } private selectNode(query: string, node: Node): Node | undefined { @@ -613,7 +627,7 @@ export class XmlReader extends AASReader { private getReference(node: Node): aas.Reference { return { type: 'ModelReference', - keys: this.selectNodes('./aas:value/aas:keys/aas:key', node).map(item => this.getKey(item)) + keys: this.selectNodes('./aas:value/aas:keys/aas:key', node).map(item => this.getKey(item)), }; } @@ -621,7 +635,7 @@ export class XmlReader extends AASReader { const element = node as Element; return { type: element.getAttribute('type') as aas.KeyTypes, - value: element.textContent ?? '' + value: element.textContent ?? '', }; } diff --git a/projects/aas-server/src/app/scan-container.ts b/projects/aas-server/src/app/scan-container.ts index 0ca2cfb3..af9ccb57 100644 --- a/projects/aas-server/src/app/scan-container.ts +++ b/projects/aas-server/src/app/scan-container.ts @@ -21,13 +21,12 @@ import { Variable } from './variable.js'; export class ScanContainer { private data!: ScanContainerData; - constructor( + public constructor( @inject('Logger') private readonly logger: Logger, @inject(UpdateStatistic) private readonly statistic: UpdateStatistic, @inject(AASResourceScanFactory) private readonly resourceScanFactory: AASResourceScanFactory, - @inject(Variable) private readonly variable: Variable - ) { - } + @inject(Variable) private readonly variable: Variable, + ) {} public async scanAsync(data: ScanContainerData): Promise { this.data = data; @@ -64,11 +63,11 @@ export class ScanContainer { } else { this.postAdded(document); } - } + }; private onError = (error: Error): void => { this.logger.error(error); - } + }; private postChanged(document: AASDocument): void { const value: ScanContainerResult = { @@ -76,7 +75,7 @@ export class ScanContainer { type: ScanResultType.Changed, container: this.data.container, document: document, - statistic: this.statistic.update(this.data.statistic, ScanResultType.Changed) + statistic: this.statistic.update(this.data.statistic, ScanResultType.Changed), }; const array = toUint8Array(value); @@ -89,7 +88,7 @@ export class ScanContainer { type: ScanResultType.Removed, container: this.data.container, document: document, - statistic: this.statistic.update(this.data.statistic, ScanResultType.Removed) + statistic: this.statistic.update(this.data.statistic, ScanResultType.Removed), }; const array = toUint8Array(value); @@ -102,7 +101,7 @@ export class ScanContainer { type: ScanResultType.Added, container: this.data.container, document: document, - statistic: this.statistic.update(this.data.statistic, ScanResultType.Added) + statistic: this.statistic.update(this.data.statistic, ScanResultType.Added), }; const array = toUint8Array(value); @@ -110,18 +109,17 @@ export class ScanContainer { } private documentChanged(document: AASDocument, reference: AASDocument): boolean { - if (document.crc32 === reference.crc32 && - (!reference.timestamp || (Date.now() - reference.timestamp <= this.variable.AAS_EXPIRES_IN))) { + if ( + document.crc32 === reference.crc32 && + (!reference.timestamp || Date.now() - reference.timestamp <= this.variable.AAS_EXPIRES_IN) + ) { return false; } - return true; } - private equalContent( - a: aas.Environment | null, - b: aas.Environment | null): boolean { + private equalContent(a: aas.Environment | null, b: aas.Environment | null): boolean { let equals: boolean; if (a === b) { equals = true; @@ -133,4 +131,4 @@ export class ScanContainer { return equals; } -} \ No newline at end of file +} diff --git a/projects/aas-server/src/app/send-error.ts b/projects/aas-server/src/app/send-error.ts index a38048d3..cbac433c 100644 --- a/projects/aas-server/src/app/send-error.ts +++ b/projects/aas-server/src/app/send-error.ts @@ -6,31 +6,31 @@ * *****************************************************************************/ -import { Response, Request } from "express"; -import { ErrorData, ApplicationError } from "common"; -import { ERRORS } from "./errors.js"; -import { Logger } from "./logging/logger.js"; +import { Response, Request } from 'express'; +import { ErrorData, ApplicationError } from 'common'; +import { ERRORS } from './errors.js'; +import { Logger } from './logging/logger.js'; export function sendError( logger: Logger, res: Response, req: Request, - error: any, + error: unknown, errorId?: string, - ...args: any[] + ...args: unknown[] ) { let errorData: ErrorData; const method = `${req.method}: ${req.path}`; if (error instanceof ApplicationError) { - errorData = createError(method, "ApplicationError", error.name, error.message, error.args); + errorData = createError(method, 'ApplicationError', error.name, error.message, error.args); } else if (error instanceof Error) { if (errorId) { - errorData = createError(method, "Error", errorId, error.message, args ?? []); + errorData = createError(method, 'Error', errorId, error.message, args ?? []); } else { - errorData = createError(method, "Error", ERRORS.Uncaught, error.message, [error.message]); + errorData = createError(method, 'Error', ERRORS.Uncaught, error.message, [error.message]); } } else { - const message = typeof error === "string" ? error : typeof error; + const message = typeof error === 'string' ? error : typeof error; if (errorId) { errorData = createError(method, typeof error, errorId, message, args ?? []); } else { @@ -41,13 +41,13 @@ export function sendError( res.status(500).json(errorData); logger.error(`${method} failed: ${errorData.message}`); - function createError(method: string, type: string, name: string, message: string, args: any[]): ErrorData { + function createError(method: string, type: string, name: string, message: string, args: unknown[]): ErrorData { return { method: method, type: type, name: name, message: message, - args: args ?? [] - } + args: args ?? [], + }; } -} \ No newline at end of file +} diff --git a/projects/aas-server/src/app/template/template-storage-factory.ts b/projects/aas-server/src/app/template/template-storage-factory.ts index 2bf66037..7fd82cc9 100644 --- a/projects/aas-server/src/app/template/template-storage-factory.ts +++ b/projects/aas-server/src/app/template/template-storage-factory.ts @@ -16,9 +16,7 @@ import { LocalFileStorage } from '../file-storage/local-file-storage.js'; import { Logger } from '../logging/logger.js'; export class TemplateStorageFactory { - constructor( - private readonly container: DependencyContainer - ) { } + public constructor(private readonly container: DependencyContainer) {} public create(): TemplateStorage { let fileStorage: FileStorage; @@ -32,4 +30,4 @@ export class TemplateStorageFactory { return new TemplateStorage(this.container.resolve('Logger'), fileStorage); } -} \ No newline at end of file +} diff --git a/projects/aas-server/src/app/template/template-storage.ts b/projects/aas-server/src/app/template/template-storage.ts index 45202c1e..ba172d53 100644 --- a/projects/aas-server/src/app/template/template-storage.ts +++ b/projects/aas-server/src/app/template/template-storage.ts @@ -16,15 +16,15 @@ import { JsonReaderV2 } from '../packages/json-reader-v2.js'; import * as aasV2 from '../types/aas-v2.js'; export class TemplateStorage { - constructor( + public constructor( private readonly logger: Logger, - private readonly fileStorage: FileStorage - ) { } + private readonly fileStorage: FileStorage, + ) {} public async readAsync(): Promise { const descriptors: TemplateDescriptor[] = []; if (await this.fileStorage.exists(this.fileStorage.root)) { - await this.readDirAsync(this.fileStorage.root, descriptors) + await this.readDirAsync(this.fileStorage.root, descriptors); } return descriptors; @@ -43,7 +43,7 @@ export class TemplateStorage { name: $path.basename(path, $path.extname(format)), endpoint: { type: 'file', address: path }, format: '.json', - template: await this.readTemplateAsync(path) + template: await this.readTemplateAsync(path), }); break; @@ -71,4 +71,4 @@ export class TemplateStorage { throw new Error('Not implemented.'); } -} \ No newline at end of file +} diff --git a/projects/aas-server/src/app/types/aas-v2.ts b/projects/aas-server/src/app/types/aas-v2.ts index 7afb18ee..4f81d1eb 100644 --- a/projects/aas-server/src/app/types/aas-v2.ts +++ b/projects/aas-server/src/app/types/aas-v2.ts @@ -8,58 +8,59 @@ /** Defines the supported AAS element types. */ export type ModelTypes = - 'Asset' | - 'AssetAdministrationShell' | - 'ConceptDescription' | - 'Submodel' | - 'AccessPermissionRule' | - 'AnnotatedRelationshipElement' | - 'BasicEvent' | - 'Blob' | - 'Capability' | - 'ConceptDictionary' | - 'DataElement' | - 'File' | - 'Entity' | - 'Event' | - 'MultiLanguageProperty' | - 'Operation' | - 'Property' | - 'Range' | - 'ReferenceElement' | - 'RelationshipElement' | - 'SubmodelElement' | - 'SubmodelElementCollection' | - 'View' | - 'GlobalReference' | - 'FragmentReference' | - 'Constraint' | - 'Formula' | - 'Qualifier'; + | 'Asset' + | 'AssetAdministrationShell' + | 'ConceptDescription' + | 'Submodel' + | 'AccessPermissionRule' + | 'AnnotatedRelationshipElement' + | 'BasicEvent' + | 'Blob' + | 'Capability' + | 'ConceptDictionary' + | 'DataElement' + | 'File' + | 'Entity' + | 'Event' + | 'MultiLanguageProperty' + | 'Operation' + | 'Property' + | 'Range' + | 'ReferenceElement' + | 'RelationshipElement' + | 'SubmodelElement' + | 'SubmodelElementCollection' + | 'View' + | 'GlobalReference' + | 'FragmentReference' + | 'Constraint' + | 'Formula' + | 'Qualifier'; /** Identifiable elements within an asset administration shell that are not identifiable (from AAS Metamodel). */ export type IdentifiableElements = 'Asset' | 'AssetAdministrationShell' | 'ConceptDescription' | 'Submodel'; /** Referable elements within an asset administration shell (from AAS Metamodel). */ -export type ReferableElements = IdentifiableElements | - 'AccessPermissionRule' | - 'AnnotatedRelationshipElement' | - 'BasicEvent' | - 'Blob' | - 'Capability' | - 'DataElement' | - 'File' | - 'Entity' | - 'Event' | - 'MultiLanguageProperty' | - 'Operation' | - 'Property' | - 'Range' | - 'View' | - 'ReferenceElement' | - 'RelationshipElement' | - 'SubmodelElement' | - 'SubmodelElementCollection'; +export type ReferableElements = + | IdentifiableElements + | 'AccessPermissionRule' + | 'AnnotatedRelationshipElement' + | 'BasicEvent' + | 'Blob' + | 'Capability' + | 'DataElement' + | 'File' + | 'Entity' + | 'Event' + | 'MultiLanguageProperty' + | 'Operation' + | 'Property' + | 'Range' + | 'View' + | 'ReferenceElement' + | 'RelationshipElement' + | 'SubmodelElement' + | 'SubmodelElementCollection'; /** Different key value types within a key (from AAS Metamodel). */ export type KeyElements = ReferableElements | 'GlobalReference' | 'FragmentReference'; @@ -69,58 +70,58 @@ export type KeyType = 'IRI' | 'IRDI' | 'Custom' | 'IdShort' | 'FragmentId'; /** */ export type DataTypeDefXsd = - 'anyURI' | - 'base64Binary' | - 'boolean' | - 'byte' | - 'date' | - 'dateTime' | - 'dateTimeStamp' | - 'dayTimeDuration' | - 'decimal' | - 'double' | - 'duration' | - 'float' | - 'gDay' | - 'gMonth' | - 'gMonthDay' | - 'gYear' | - 'gYearMonth' | - 'hexBinary' | - 'int' | - 'integer' | - 'long' | - 'negativeInteger' | - 'nonNegativeInteger' | - 'nonPositiveInteger' | - 'positiveInteger' | - 'short' | - 'string' | - 'time' | - 'unsignedByte' | - 'unsignedInt' | - 'unsignedLong' | - 'unsignedShort' | - 'yearMonthDuration'; - -/** Enumeration of simple data types for a IEC61360 concept description + | 'anyURI' + | 'base64Binary' + | 'boolean' + | 'byte' + | 'date' + | 'dateTime' + | 'dateTimeStamp' + | 'dayTimeDuration' + | 'decimal' + | 'double' + | 'duration' + | 'float' + | 'gDay' + | 'gMonth' + | 'gMonthDay' + | 'gYear' + | 'gYearMonth' + | 'hexBinary' + | 'int' + | 'integer' + | 'long' + | 'negativeInteger' + | 'nonNegativeInteger' + | 'nonPositiveInteger' + | 'positiveInteger' + | 'short' + | 'string' + | 'time' + | 'unsignedByte' + | 'unsignedInt' + | 'unsignedLong' + | 'unsignedShort' + | 'yearMonthDuration'; + +/** Enumeration of simple data types for a IEC61360 concept description * using the data specification template DataSpecificationIEC61360 */ export type DataTypeIEC61360 = - 'DATE' | - 'STRING' | - 'STRING_TRANSLATABLE' | - 'INTEGER_MEASURE' | - 'INTEGER_COUNT' | - 'INTEGER_CURRENCY' | - 'REAL_MEASURE' | - 'REAL_COUNT' | - 'REAL_CURRENCY' | - 'BOOLEAN' | - 'URL' | - 'RATIONAL' | - 'RATIONAL_MEASURE' | - 'TIME' | - 'TIMESTAMP'; + | 'DATE' + | 'STRING' + | 'STRING_TRANSLATABLE' + | 'INTEGER_MEASURE' + | 'INTEGER_COUNT' + | 'INTEGER_CURRENCY' + | 'REAL_MEASURE' + | 'REAL_COUNT' + | 'REAL_CURRENCY' + | 'BOOLEAN' + | 'URL' + | 'RATIONAL' + | 'RATIONAL_MEASURE' + | 'TIME' + | 'TIMESTAMP'; /** Reference to an element by its id (from AAS Metamodel). */ export interface Key { @@ -195,7 +196,7 @@ export interface Qualifiable { /** Metainformation of a property (from AAS Metamodel). */ export type Category = 'CONSTANT' | 'PARAMETER' | 'VARIABLE'; -/** An element that is referable by its idShort. This id is not globally unique. +/** An element that is referable by its idShort. This id is not globally unique. * This id is unique within the name space of the element. */ export interface Referable { modelType: ModelType; @@ -226,10 +227,9 @@ export interface Identifiable extends Referable { } // eslint-disable-next-line @typescript-eslint/no-empty-interface -export interface DataSpecificationContent { -} +export interface DataSpecificationContent {} -/** Content of data specification template for concept descriptions for properties, +/** Content of data specification template for concept descriptions for properties, * values and value lists conformant to IEC 61360. */ export interface DataSpecificationIEC61360Content extends DataSpecificationContent { preferredName: LangString[]; @@ -248,7 +248,7 @@ export interface DataSpecificationIEC61360Content extends DataSpecificationConte export type LevelType = 'Max' | 'Min' | 'Nom' | 'Typ'; -/** Content of data specification template for concept descriptions for physical units +/** Content of data specification template for concept descriptions for physical units * conformant to IEC 61360. */ export interface DataSpecificationPhysicalUnitContent extends DataSpecificationContent { unitName: string; @@ -263,16 +263,15 @@ export interface DataSpecificationPhysicalUnitContent extends DataSpecificationC sourceOfDefinition?: string; conversionFactor?: string; registrationAuthorityId?: string; - supplier?: string + supplier?: string; } export interface ValueList { - valueReferencePairTypes: ValueReferencePairType[] + valueReferencePairTypes: ValueReferencePairType[]; } // eslint-disable-next-line @typescript-eslint/no-empty-interface -export interface ValueReferencePairType extends ValueObject { -} +export interface ValueReferencePairType extends ValueObject {} export interface EmbeddedDataSpecification { dataSpecification: Reference; @@ -290,8 +289,7 @@ export interface Asset extends Identifiable, HasDataSpecification { export type AssetKind = 'Type' | 'Instance'; /** A submodel element is an element suitable for the description and differentiation of assets. */ -export interface SubmodelElement extends Referable, HasDataSpecification, HasSemantic, Qualifiable, HasKind { -} +export interface SubmodelElement extends Referable, HasDataSpecification, HasSemantic, Qualifiable, HasKind {} export interface SubmodelElementCollection extends SubmodelElement { ordered?: boolean; @@ -301,8 +299,7 @@ export interface SubmodelElementCollection extends SubmodelElement { /** An event element. */ // eslint-disable-next-line @typescript-eslint/no-empty-interface -export interface Event extends SubmodelElement { -} +export interface Event extends SubmodelElement {} /** A basic event element. */ export interface BasicEvent extends Event { @@ -346,23 +343,23 @@ export interface MultiLanguageProperty extends DataElement { export type LangStringSet = { langString: LangString[]; -} +}; -/** A File is a data element that represents an address to a file. +/** A File is a data element that represents an address to a file. * The value is an URI that can represent an absolute or relative path. */ export interface File extends DataElement { mimeType: string; value?: string; } -/** A BLOB is a data element that represents a file that is contained with its source code in the +/** A BLOB is a data element that represents a file that is contained with its source code in the * value attribute. */ export interface Blob extends DataElement { mimeType: string; value?: string; } -/** A reference element is a data element that defines a logical reference to another element +/** A reference element is a data element that defines a logical reference to another element * within the same or another AAS or a reference to an external object or entity. */ export interface ReferenceElement extends DataElement { value: Reference; @@ -374,8 +371,8 @@ export interface RelationshipElement extends SubmodelElement { second: Reference; } -/** An annotated relationship element is a relationship element that can be annotated - * with additional data elements.*/ +/** An annotated relationship element is a relationship element that can be annotated + * with additional data elements.*/ export interface AnnotatedRelationshipElement extends RelationshipElement { annotation: DataElement[]; } @@ -383,9 +380,9 @@ export interface AnnotatedRelationshipElement extends RelationshipElement { /** Enumeration for denoting whether an entity is a self-managed entity or a co-managed entity. */ export type EntityType = /** For co-managed entities there is no separate AAS. Co-managed entities need to be part of a self-managed entity. */ - 'CoManagedEntity' | + | 'CoManagedEntity' /** Self-Managed Entities have their own AAS but can be part of the bill of material of a composite self-managed entity. */ - 'SelfManagedEntity'; + | 'SelfManagedEntity'; /** An IdentifierKeyValuePair describes a generic identifier as key-value pair. */ export interface IdentifierKeyValuePair { @@ -401,11 +398,10 @@ export interface Entity extends SubmodelElement { statements?: SubmodelElement[]; } -/** A capability is the implementation-independent description of the potential of an +/** A capability is the implementation-independent description of the potential of an * asset to achieve a certain effect in the physical or virtual world. */ // eslint-disable-next-line @typescript-eslint/no-empty-interface -export interface Capability extends SubmodelElement { -} +export interface Capability extends SubmodelElement {} /** An operation variable is a submodel element that is used as input or output variable of an operation. */ export interface OperationVariable { @@ -432,8 +428,8 @@ export interface View extends Referable, HasDataSpecification, HasSemantic { containedElements?: Reference[]; } -/** The semantics of a property or other elements that may have a semantic description is defined by - * a concept description. */ +/** The semantics of a property or other elements that may have a semantic description is defined by + * a concept description. */ export interface ConceptDescription extends Identifiable, HasDataSpecification { isCaseOf?: Reference[]; } @@ -453,8 +449,8 @@ export interface AssetAdministrationShell extends Identifiable, HasDataSpecifica /** Asset Administration Shell environment */ export interface AssetAdministrationShellEnvironment { - assetAdministrationShells: AssetAdministrationShell[], + assetAdministrationShells: AssetAdministrationShell[]; assets: Asset[]; submodels: Submodel[]; conceptDescriptions: ConceptDescription[]; -} \ No newline at end of file +} diff --git a/projects/aas-server/src/app/types/container-index.ts b/projects/aas-server/src/app/types/container-index.ts index b0214dcf..4f4f58ac 100644 --- a/projects/aas-server/src/app/types/container-index.ts +++ b/projects/aas-server/src/app/types/container-index.ts @@ -9,4 +9,4 @@ export interface ContainerIndex { first: string; last: string; -} \ No newline at end of file +} diff --git a/projects/aas-server/src/app/types/owncloud-sdk.d.ts b/projects/aas-server/src/app/types/owncloud-sdk.d.ts index 6823598b..bf71a104 100644 --- a/projects/aas-server/src/app/types/owncloud-sdk.d.ts +++ b/projects/aas-server/src/app/types/owncloud-sdk.d.ts @@ -7,9 +7,8 @@ *****************************************************************************/ declare module 'owncloud-sdk' { - export interface OwnCloudAuthentication { - basic?: { username: string; password: string; }; + basic?: { username: string; password: string }; bearer?: string; } @@ -39,16 +38,20 @@ declare module 'owncloud-sdk' { public getFileContents(path: string, options?: { [key: string]: string }): Promise; public getFileUrl(path: string): string; public getPathForFileId(fileId: number): Promise; - public putFileContents(path: string, content: string, options: { [key: string]: string } = {}): Promise; + public putFileContents( + path: string, + content: string, + options: { [key: string]: string } = {}, + ): Promise; public createFolder(path: string): Promise; public delete(path: string): Promise; public fileInfo(path: string, properties: { [key: string]: string }): Promise; - public move (source: string, target: string, overwrite = false): Promise; - public copy (source: string, target: string, overwrite = false): Promise; + public move(source: string, target: string, overwrite = false): Promise; + public copy(source: string, target: string, overwrite = false): Promise; } export default class ownCloud { - constructor(options?: OwnCloudOptions); + public constructor(options?: OwnCloudOptions); public files: Files; diff --git a/projects/aas-server/src/app/types/registry.ts b/projects/aas-server/src/app/types/registry.ts index 730064e9..3a7a1de4 100644 --- a/projects/aas-server/src/app/types/registry.ts +++ b/projects/aas-server/src/app/types/registry.ts @@ -10,7 +10,7 @@ import { Endpoint } from 'common'; import * as aasv2 from './aas-v2.js'; export interface AASRegistryModelType { - name: 'AssetAdministrationShellDescriptor' | 'Asset' + name: 'AssetAdministrationShellDescriptor' | 'Asset'; } /** The self-describing information of a network resource. */ @@ -38,4 +38,4 @@ export interface AssetAdministrationShellDescriptor extends AASRegistryDescripto idShort: string; asset: AssetDescriptor; submodels: SubmodelDescriptor[]; -} \ No newline at end of file +} diff --git a/projects/aas-server/src/app/types/uuid.d.ts b/projects/aas-server/src/app/types/uuid.d.ts index 0a8f6df0..59be0fb6 100644 --- a/projects/aas-server/src/app/types/uuid.d.ts +++ b/projects/aas-server/src/app/types/uuid.d.ts @@ -8,4 +8,4 @@ declare module 'uuid' { export function v4(): string; -} \ No newline at end of file +} diff --git a/projects/aas-server/src/app/update-statistic.ts b/projects/aas-server/src/app/update-statistic.ts index f6bc4477..d1226223 100644 --- a/projects/aas-server/src/app/update-statistic.ts +++ b/projects/aas-server/src/app/update-statistic.ts @@ -33,4 +33,4 @@ export class UpdateStatistic { return statistic; } -} \ No newline at end of file +} diff --git a/projects/aas-server/src/app/variable.ts b/projects/aas-server/src/app/variable.ts index 8c261aaa..b30de738 100644 --- a/projects/aas-server/src/app/variable.ts +++ b/projects/aas-server/src/app/variable.ts @@ -11,7 +11,7 @@ import path from 'path'; @singleton() export class Variable { - constructor() { + public constructor() { this.JWT_SECRET = process.env.JWT_SECRET ?? 'The quick brown fox jumps over the lazy dog.'; this.JWT_PUBLIC_KEY = process.env.JWT_PUBLIC_KEY; this.JWT_EXPIRES_IN = process.env.JWT_EXPIRED_IN ? Number(process.env.JWT_EXPIRED_IN) : 604800; @@ -84,4 +84,4 @@ export class Variable { /** The AASIndex realization. */ public readonly AAS_INDEX?: string; -} \ No newline at end of file +} diff --git a/projects/aas-server/src/app/worker-app.ts b/projects/aas-server/src/app/worker-app.ts index 7dc572a0..822349dd 100644 --- a/projects/aas-server/src/app/worker-app.ts +++ b/projects/aas-server/src/app/worker-app.ts @@ -17,12 +17,11 @@ import { ScanContainer } from './scan-container.js'; @singleton() export class WorkerApp { - constructor( + public constructor( @inject('Logger') private readonly logger: Logger, @inject(ScanContainer) private readonly scanContainer: ScanContainer, - @inject(UpdateStatistic) private readonly statistic: UpdateStatistic - ) { - } + @inject(UpdateStatistic) private readonly statistic: UpdateStatistic, + ) {} public run(): void { parentPort?.on('message', this.parentPortOnMessage); @@ -42,10 +41,10 @@ export class WorkerApp { taskId: data.taskId, type: ScanResultType.End, statistic: this.statistic.update(data.statistic, ScanResultType.End), - messages: this.logger.getMessages() + messages: this.logger.getMessages(), }; parentPort?.postMessage(toUint8Array(result)); } - } -} \ No newline at end of file + }; +} diff --git a/projects/aas-server/src/app/ws-server.ts b/projects/aas-server/src/app/ws-server.ts index 632e17e7..929cbb6f 100644 --- a/projects/aas-server/src/app/ws-server.ts +++ b/projects/aas-server/src/app/ws-server.ts @@ -26,10 +26,10 @@ export class WSServer extends EventEmitter { private readonly clients: Set = new Set(); private readonly server: http.Server | https.Server; - constructor( + public constructor( @inject(App) app: App, @inject(Variable) private readonly variable: Variable, - @inject('Logger') private readonly logger: Logger + @inject('Logger') private readonly logger: Logger, ) { super(); @@ -67,7 +67,7 @@ export class WSServer extends EventEmitter { public close(): Promise { return new Promise((resolve, reject) => { this.clients.forEach(client => client.close()); - this.wss.close((error) => { + this.wss.close(error => { if (error) { reject(error); } else { @@ -83,18 +83,18 @@ export class WSServer extends EventEmitter { client.on('close', this.onClientClose); client.on('error', this.onClientError); this.clients.add(client); - } + }; private onClose = (): void => { this.wss.clients.forEach(ws => ws.close()); this.wss.off('connection', this.onConnection); this.wss.off('close', this.onClose); this.wss.off('error', this.onError); - } + }; private onError = (error: Error): void => { this.logger.error(`WebSocket server error: ${error?.message}`); - } + }; private onClientClose = (code: number, reason: string, client: SocketClient): void => { this.emit('close', client); @@ -106,13 +106,13 @@ export class WSServer extends EventEmitter { if (!this.clients.delete(client)) { this.logger.error(`Unknown WebSocket client detected.`); } - } + }; private onClientMessage = (data: WebSocketData, client: SocketClient): void => { this.emit('message', data, client); - } + }; private onClientError = (error: Error, client: SocketClient): void => { this.emit('error', error, client); - } -} \ No newline at end of file + }; +} diff --git a/projects/aas-server/src/test/aas-index/mysql/mysql-index.spec.ts b/projects/aas-server/src/test/aas-index/mysql/mysql-index.spec.ts index 3e5c8440..1f0a78e9 100644 --- a/projects/aas-server/src/test/aas-index/mysql/mysql-index.spec.ts +++ b/projects/aas-server/src/test/aas-index/mysql/mysql-index.spec.ts @@ -10,4 +10,4 @@ import { describe, beforeEach, it, expect, jest, beforeAll } from '@jest/globals describe('MySqlIndex', () => { it.todo('MySqlIndex'); -}); \ No newline at end of file +}); diff --git a/projects/aas-server/src/test/aas-index/mysql/mysql-query.spec.ts b/projects/aas-server/src/test/aas-index/mysql/mysql-query.spec.ts index c7497286..5e0dfb98 100644 --- a/projects/aas-server/src/test/aas-index/mysql/mysql-query.spec.ts +++ b/projects/aas-server/src/test/aas-index/mysql/mysql-query.spec.ts @@ -16,7 +16,7 @@ describe('MySqlQuery', () => { const values: unknown[] = []; expect(query.createSql(values)).toEqual( "(documents.endpoint LIKE '%Hello World%' OR documents.id LIKE '%Hello World%' OR documents.idShort LIKE '%Hello World%')" - ); + ); }); it('A && (B || C)', () => { @@ -27,4 +27,4 @@ describe('MySqlQuery', () => { expect(query.createSql([])).toEqual(`(${a}) AND ((${b}) OR (${c}))`); }); }); -}); \ No newline at end of file +}); diff --git a/projects/aas-server/src/test/aas-provider/aas-provider.spec.ts b/projects/aas-server/src/test/aas-provider/aas-provider.spec.ts index 992cc11e..59b5ff0e 100644 --- a/projects/aas-server/src/test/aas-provider/aas-provider.spec.ts +++ b/projects/aas-server/src/test/aas-provider/aas-provider.spec.ts @@ -46,4 +46,4 @@ describe('AASProvider', function () { await expect(aasProvider.getEndpoints()).resolves.toEqual(endpoints); }); }); -}); \ No newline at end of file +}); diff --git a/projects/aas-server/src/test/auth/auth-service.spec.ts b/projects/aas-server/src/test/auth/auth-service.spec.ts index 34f9c0cc..defc14d2 100644 --- a/projects/aas-server/src/test/auth/auth-service.spec.ts +++ b/projects/aas-server/src/test/auth/auth-service.spec.ts @@ -35,12 +35,12 @@ describe('AuthService', function () { auth = new AuthService(mailer, userStorage, cookieStorage, variable); johnDoeData = { - id: "john.doe@email.com", - name: "John", - role: "editor", - password: "$2a$10$6qZT2ZM5jUVU/pLLQUjCvuXplG.GwPnoz48C1Eg/dKqjIrGE8jm0a", - created: new Date("2020-11-02T10:22:56.328Z"), - lastLoggedIn: new Date(0) + id: 'john.doe@email.com', + name: 'John', + role: 'editor', + password: '$2a$10$6qZT2ZM5jUVU/pLLQUjCvuXplG.GwPnoz48C1Eg/dKqjIrGE8jm0a', + created: new Date('2020-11-02T10:22:56.328Z'), + lastLoggedIn: new Date(0), }; }); @@ -50,20 +50,20 @@ describe('AuthService', function () { describe('loginAsync', function () { it('returns a user token.', async function () { - userStorage.readAsync.mockReturnValue(new Promise((result) => result(johnDoeData))); + userStorage.readAsync.mockReturnValue(new Promise(result => result(johnDoeData))); const result = await auth.loginAsync({ id: 'john.doe@email.com', password: '6iu3hbcc' }); expect(result?.token).toBeDefined(); }); it('returns a guest token.', async function () { - userStorage.readAsync.mockReturnValue(new Promise((result) => result(johnDoeData))); + userStorage.readAsync.mockReturnValue(new Promise(result => result(johnDoeData))); const result = await auth.loginAsync(); expect(result?.token).toBeDefined(); }); it('throws an UnknownUser error.', async function () { try { - userStorage.readAsync.mockReturnValue(new Promise((result) => result(undefined))); + userStorage.readAsync.mockReturnValue(new Promise(result => result(undefined))); await auth.loginAsync({ id: 'unknown@iosb-ina.fraunhofer.de', password: '6iu3hbcc' }); } catch (error) { expect(error instanceof ApplicationError).toBeTruthy(); @@ -73,7 +73,7 @@ describe('AuthService', function () { it('throws an InvalidPassword error.', async function () { try { - userStorage.readAsync.mockReturnValue(new Promise((result) => result(johnDoeData))); + userStorage.readAsync.mockReturnValue(new Promise(result => result(johnDoeData))); await auth.loginAsync({ id: 'john.doe@email.com', password: 'invalid' }); } catch (error) { expect(error instanceof ApplicationError).toBeTruthy(); @@ -89,27 +89,27 @@ describe('AuthService', function () { profile = { id: 'monika.mustermann@email.com', name: 'Monika', - password: '12345678' + password: '12345678', }; }); it('updates the profile of a registered user', async function () { const monikaData: UserData = { - id: "monika.mustermann@email.com", - name: "Monika", - role: "editor", - password: "$2a$10$6qZT2ZM5jUVU/pLLQUjCvuXplG.GwPnoz48C1Eg/dKqjIrGE8jm0a", - created: new Date("2020-11-02T10:22:56.328Z"), - lastLoggedIn: new Date(0) + id: 'monika.mustermann@email.com', + name: 'Monika', + role: 'editor', + password: '$2a$10$6qZT2ZM5jUVU/pLLQUjCvuXplG.GwPnoz48C1Eg/dKqjIrGE8jm0a', + created: new Date('2020-11-02T10:22:56.328Z'), + lastLoggedIn: new Date(0), }; - userStorage.readAsync.mockReturnValue(new Promise((result) => result(monikaData))); + userStorage.readAsync.mockReturnValue(new Promise(result => result(monikaData))); const result = await auth.updateProfileAsync('monika.mustermann@email.com', profile); expect(result.token).toBeDefined(); }); it('throws an error if user is unknown or not authenticated', async function () { - userStorage.readAsync.mockReturnValue(new Promise((result) => result(undefined))); + userStorage.readAsync.mockReturnValue(new Promise(result => result(undefined))); await expect(auth.updateProfileAsync('unknown', profile)).rejects.toThrowError(); }); }); @@ -121,7 +121,7 @@ describe('AuthService', function () { johnDoeProfile = { id: 'john.doe@email.com', name: 'John Doe', - password: '12345678' + password: '12345678', }; }); @@ -150,20 +150,24 @@ describe('AuthService', function () { it('throws an error if e-mail is invalid', async function () { userStorage.existAsync.mockReturnValue(new Promise(result => result(false))); - await expect(auth.registerUserAsync({ - id: 'invalid', - name: 'John Doe', - password: '12345678' - })).rejects.toThrowError(); + await expect( + auth.registerUserAsync({ + id: 'invalid', + name: 'John Doe', + password: '12345678', + }), + ).rejects.toThrowError(); }); it('throws an error if password is invalid', async function () { userStorage.existAsync.mockReturnValue(new Promise(result => result(false))); - await expect(auth.registerUserAsync({ - id: 'john.doe@email.com', - name: 'John Doe', - password: '1' - })).rejects.toThrowError(); + await expect( + auth.registerUserAsync({ + id: 'john.doe@email.com', + name: 'John Doe', + password: '1', + }), + ).rejects.toThrowError(); }); }); @@ -199,4 +203,4 @@ describe('AuthService', function () { await expect(auth.hasUserAsync('unknown')).resolves.toBe(false); }); }); -}); \ No newline at end of file +}); diff --git a/projects/aas-server/src/test/auth/locale-cookie-storage.spec.ts b/projects/aas-server/src/test/auth/locale-cookie-storage.spec.ts index ee81c900..b3674c74 100644 --- a/projects/aas-server/src/test/auth/locale-cookie-storage.spec.ts +++ b/projects/aas-server/src/test/auth/locale-cookie-storage.spec.ts @@ -8,110 +8,183 @@ import 'reflect-metadata'; import fs from 'fs'; +import os from 'os'; +import path from 'path'; import { Cookie } from 'common'; import { CookieStorage } from '../../app/auth/cookie-storage.js'; import { LocaleCookieStorage } from '../../app/auth/locale-cookie-storage.js'; -import { describe, beforeEach, it, expect, jest } from '@jest/globals'; +import { describe, beforeEach, it, expect, jest, afterEach } from '@jest/globals'; import { createSpyObj } from '../utils.js'; import { Logger } from '../../app/logging/logger.js'; -describe('LocaleCookieStorage', function () { - let usersDir: string; +describe('LocaleCookieStorage', () => { let cookieStorage: CookieStorage; - let cookies: Cookie[]; + let cookies: Buffer; + let usersDir: string; - beforeEach(async function () { - usersDir = '/users'; - cookies = [ - { - name: 'Cookie1', - data: 'The quick brown fox jumps over the lazy dog.' - }, - { - name: 'Cookie2', - data: '42' - } - ]; - - jest.spyOn(fs.promises, 'readFile').mockImplementation(() => { - return new Promise(resolve => resolve(Buffer.from(JSON.stringify(cookies)))); - }); + afterEach(() => { + jest.restoreAllMocks(); + }); + + beforeEach(async () => { + usersDir = os.tmpdir(); + cookies = Buffer.from( + JSON.stringify([ + { + name: 'Cookie1', + data: 'The quick brown fox jumps over the lazy dog.', + }, + { + name: 'Cookie2', + data: 42, + }, + ]), + ); cookieStorage = new LocaleCookieStorage(createSpyObj(['error']), usersDir); }); - describe('checkAsync', function () { - it('indicates that "Cookie1" for john.doe@email.com exist', async function () { - jest.spyOn(fs, 'existsSync').mockImplementation(() => true); + describe('checkAsync', () => { + it('indicates that "Cookie1" for john.doe@email.com exist', async () => { + jest.spyOn(fs, 'existsSync').mockReturnValue(true); + jest.spyOn(fs.promises, 'readFile').mockResolvedValue(Buffer.from(cookies)); await expect(cookieStorage.checkAsync('john.doe@email.com', 'Cookie1')).resolves.toBe(true); }); - it('indicates that "unknown" for john.doe@email.com not exist', async function () { - jest.spyOn(fs, 'existsSync').mockImplementation(() => true); + it('indicates that "unknown" for john.doe@email.com not exist', async () => { + jest.spyOn(fs, 'existsSync').mockReturnValue(true); + jest.spyOn(fs.promises, 'readFile').mockResolvedValue(Buffer.from(cookies)); await expect(cookieStorage.checkAsync('john.doe@email.com', 'unknown')).resolves.toBe(false); }); - it('indicates that "Cookie1" for jane.doe@email.com not exist', async function () { + it('indicates that "Cookie1" for jane.doe@email.com not exist', async () => { jest.spyOn(fs, 'existsSync').mockImplementation(() => false); await expect(cookieStorage.checkAsync('jane.doe@email.com', 'Cookie1')).resolves.toBe(false); }); }); - // describe('getAsync', function () { - // it('returns the value of "Cookie1" for john.doe@email.com', async function () { - // await expect(cookieStorage.getAsync('john.doe@email.com', 'Cookie1')) - // .resolves.toEqual({ name: 'Cookie1', data: 'The quick brown fox jumps over the lazy dog.' }); - // }); - - // it('returns "undefined" for "unknown" for john.doe@email.com', async function () { - // await expect(cookieStorage.getAsync('john.doe@email.com', 'unknown')) - // .resolves.toBeUndefined(); - // }); - - // it('returns "undefined" for "Cookie1" for jane.doe@email.com', async function () { - // await expect(cookieStorage.getAsync('jane.doe@email.com', 'unknown')) - // .resolves.toBeUndefined(); - // }); - // }); - - // describe('getAllAsync', function () { - // it('returns all cookies for john.doe@email.com', async function () { - // await expect(cookieStorage.getAllAsync('john.doe@email.com')) - // .resolves.toEqual([ - // { - // name: 'Cookie1', - // data: 'The quick brown fox jumps over the lazy dog.' - // }, - // { - // name: 'Cookie2', - // data: '42' - // } - // ]); - // }); - // }); - - // describe('setAsync', function () { - // it('can set a new Cookie3 for john.doe@email.com', async function () { - // await cookieStorage.setAsync('john.doe@email.com', 'Cookie3', 'Hello World!'); - // let items = JSON.parse((await readFile(join(userDir, 'cookies.json'))).toString()) as Cookie[]; - // expect(items.find(item => item.name === 'Cookie3')).toEqual({ name: 'Cookie3', data: 'Hello World!' } as Cookie); - // }); - - // it('can update the existing Cookie2 for john.doe@email.com', async function () { - // await cookieStorage.setAsync('john.doe@email.com', 'Cookie2', 'Hello World!'); - // let items = JSON.parse((await readFile(join(userDir, 'cookies.json'))).toString()) as Cookie[]; - // expect(items.find(item => item.name === 'Cookie2')).toEqual({ name: 'Cookie2', data: 'Hello World!' } as Cookie); - // }); - // }); - - // describe('deleteAsync', function () { - // it('can delete a cookie', async function () { - // await cookieStorage.deleteAsync('john.doe@email.com', 'Cookie1'); - // let items = JSON.parse((await readFile(join(userDir, 'cookies.json'))).toString()) as Cookie[]; - // expect(items.find(item => item.name === 'Cookie1')).toBeUndefined(); - - // await cookieStorage.deleteAsync('john.doe@email.com', 'Cookie2'); - // expect(existsSync(join(userDir, 'cookies.json'))).toBeFalsy(); - // }); - // }); -}); \ No newline at end of file + describe('getAsync', () => { + beforeEach(() => { + jest.spyOn(fs, 'existsSync').mockReturnValue(true); + jest.spyOn(fs.promises, 'readFile').mockResolvedValue(Buffer.from(cookies)); + }); + + it('returns the value of "Cookie1" for john.doe@email.com', async () => { + await expect(cookieStorage.getAsync('john.doe@email.com', 'Cookie1')).resolves.toEqual({ + name: 'Cookie1', + data: 'The quick brown fox jumps over the lazy dog.', + }); + }); + + it('returns "undefined" for "unknown" for john.doe@email.com', async () => { + await expect(cookieStorage.getAsync('john.doe@email.com', 'unknown')).resolves.toBeUndefined(); + }); + + it('returns "undefined" for "Cookie1" for jane.doe@email.com', async () => { + await expect(cookieStorage.getAsync('jane.doe@email.com', 'unknown')).resolves.toBeUndefined(); + }); + }); + + describe('getAllAsync', () => { + beforeEach(() => { + jest.spyOn(fs, 'existsSync').mockReturnValue(true); + jest.spyOn(fs.promises, 'readFile').mockResolvedValue(Buffer.from(cookies)); + }); + + it('returns all cookies for john.doe@email.com', async () => { + await expect(cookieStorage.getAllAsync('john.doe@email.com')).resolves.toEqual([ + { + name: 'Cookie1', + data: 'The quick brown fox jumps over the lazy dog.', + }, + { + name: 'Cookie2', + data: 42, + }, + ] as Cookie[]); + }); + }); + + describe('setAsync', () => { + beforeEach(() => { + jest.spyOn(fs, 'existsSync').mockReturnValue(true); + jest.spyOn(fs.promises, 'readFile').mockResolvedValue(Buffer.from(cookies)); + }); + + it('can set a new Cookie3 for john.doe@email.com', async () => { + jest.spyOn(fs.promises, 'writeFile').mockResolvedValue(); + await cookieStorage.setAsync('john.doe@email.com', 'Cookie3', 'Hello World!'); + expect(fs.promises.writeFile).toHaveBeenCalledWith( + path.join(usersDir, 'john.doe@email.com', 'cookies.json'), + JSON.stringify([ + { + name: 'Cookie1', + data: 'The quick brown fox jumps over the lazy dog.', + }, + { + name: 'Cookie2', + data: 42, + }, + { + name: 'Cookie3', + data: 'Hello World!', + }, + ] as Cookie[]), + ); + }); + + it('can update the existing Cookie2 for john.doe@email.com', async () => { + jest.spyOn(fs.promises, 'writeFile').mockResolvedValue(); + await cookieStorage.setAsync('john.doe@email.com', 'Cookie2', 'Hello World!'); + expect(fs.promises.writeFile).toHaveBeenCalledWith( + path.join(usersDir, 'john.doe@email.com', 'cookies.json'), + JSON.stringify([ + { + name: 'Cookie1', + data: 'The quick brown fox jumps over the lazy dog.', + }, + { + name: 'Cookie2', + data: 'Hello World!', + }, + ] as Cookie[]), + ); + }); + }); + + describe('deleteAsync', () => { + it('can delete a cookie', async () => { + jest.spyOn(fs, 'existsSync').mockReturnValue(true); + jest.spyOn(fs.promises, 'readFile').mockResolvedValue(Buffer.from(cookies)); + jest.spyOn(fs.promises, 'writeFile').mockResolvedValue(); + await cookieStorage.deleteAsync('john.doe@email.com', 'Cookie1'); + expect(fs.promises.writeFile).toHaveBeenCalledWith( + path.join(usersDir, 'john.doe@email.com', 'cookies.json'), + JSON.stringify([ + { + name: 'Cookie2', + data: 42, + }, + ]), + ); + }); + + it('removes the cookies file on empty cookies', async () => { + jest.spyOn(fs, 'existsSync').mockReturnValue(true); + jest.spyOn(fs.promises, 'readFile').mockResolvedValue( + Buffer.from( + JSON.stringify([ + { + name: 'Cookie2', + data: 42, + }, + ]), + ), + ); + + jest.spyOn(fs.promises, 'unlink').mockResolvedValue(); + await cookieStorage.deleteAsync('john.doe@email.com', 'Cookie2'); + expect(fs.promises.unlink).toHaveBeenCalled(); + }); + }); +}); diff --git a/projects/aas-server/src/test/auth/locale-user-storage.spec.ts b/projects/aas-server/src/test/auth/locale-user-storage.spec.ts index 0708a622..3fa4c85d 100644 --- a/projects/aas-server/src/test/auth/locale-user-storage.spec.ts +++ b/projects/aas-server/src/test/auth/locale-user-storage.spec.ts @@ -7,11 +7,12 @@ *****************************************************************************/ import 'reflect-metadata'; +import { describe, afterEach, beforeEach, it, expect, jest } from '@jest/globals'; import fs from 'fs'; +import os from 'os'; import { UserStorage } from '../../app/auth/user-storage.js'; import { LocaleUserStorage } from '../../app/auth/locale-user-storage.js'; import { UserData } from '../../app/auth/user-data.js'; -import { describe, beforeEach, it, expect, jest } from '@jest/globals'; describe('LocaleUserStorage', function () { let userStorage: UserStorage; @@ -19,16 +20,19 @@ describe('LocaleUserStorage', function () { beforeEach(function () { johnDoe = { - id: "john.doe@email.com", - name: "John Doe", - role: "editor", - password: "$2a$10$6qZT2ZM5jUVU/pLLQUjCvuXplG.GwPnoz48C1Eg/dKqjIrGE8jm0a", + id: 'john.doe@email.com', + name: 'John Doe', + role: 'editor', + password: '$2a$10$6qZT2ZM5jUVU/pLLQUjCvuXplG.GwPnoz48C1Eg/dKqjIrGE8jm0a', created: new Date(), - lastLoggedIn: new Date(0) + lastLoggedIn: new Date(0), }; - jest.spyOn(fs, 'existsSync').mockImplementation(() => true); - userStorage = new LocaleUserStorage('/users'); + userStorage = new LocaleUserStorage(os.tmpdir()); + }); + + afterEach(() => { + jest.restoreAllMocks(); }); describe('existsSync', function () { @@ -45,18 +49,16 @@ describe('LocaleUserStorage', function () { describe('writeAsync', function () { it('writes a new user', async function () { - jest.spyOn(fs, 'existsSync').mockImplementation(() => false); - jest.spyOn(fs.promises, 'mkdir').mockImplementation( - () => new Promise(resolve => resolve(undefined))); - - jest.spyOn(fs.promises, 'writeFile').mockImplementation(() => new Promise(resolve => resolve())); + jest.spyOn(fs, 'existsSync').mockReturnValue(false); + jest.spyOn(fs.promises, 'mkdir').mockResolvedValue(undefined); + jest.spyOn(fs.promises, 'writeFile').mockResolvedValue(); await userStorage.writeAsync('jane.doe@email.com', { id: 'jane.doe@email.com', name: 'Jane Doe', password: '12345678', role: 'editor', created: new Date(), - lastLoggedIn: new Date() + lastLoggedIn: new Date(), }); expect(fs.promises.mkdir).toHaveBeenCalled(); @@ -66,30 +68,28 @@ describe('LocaleUserStorage', function () { describe('readAsync', function () { it('reads the data of john.doe@email.com', async function () { - jest.spyOn(fs, 'existsSync').mockImplementation(() => true); - jest.spyOn(fs.promises, 'readFile').mockImplementation(() => new Promise( - resolve => resolve(Buffer.from(JSON.stringify(johnDoe))))); - + jest.spyOn(fs, 'existsSync').mockReturnValue(true); + jest.spyOn(fs.promises, 'readFile').mockResolvedValue(Buffer.from(JSON.stringify(johnDoe))); await expect(userStorage.readAsync('john.doe@email.com')).resolves.toEqual(johnDoe); }); it('reads "undefined" for an unknown user', async function () { - jest.spyOn(fs, 'existsSync').mockImplementation(() => false); + jest.spyOn(fs, 'existsSync').mockReturnValue(false); await expect(userStorage.readAsync('unknown@email.com')).resolves.toBeUndefined(); }); }); describe('deleteAsync', function () { it('john.doe@email.com', async function () { - jest.spyOn(fs, 'existsSync').mockImplementation(() => true); + jest.spyOn(fs, 'existsSync').mockReturnValue(true); jest.spyOn(fs.promises, 'rm').mockImplementation(() => new Promise(resolve => resolve())); await expect(userStorage.deleteAsync('john.doe@email.com')).resolves.toBe(true); expect(fs.promises.rm).toHaveBeenCalled(); }); it('indicates that an unknown user was not deleted', async function () { - jest.spyOn(fs, 'existsSync').mockImplementation(() => false); + jest.spyOn(fs, 'existsSync').mockReturnValue(false); await expect(userStorage.deleteAsync('unknown@email.com')).resolves.toBe(false); }); }); -}); \ No newline at end of file +}); diff --git a/projects/aas-server/src/test/auth/mongo-db-cookie-storage.spec.ts b/projects/aas-server/src/test/auth/mongo-db-cookie-storage.spec.ts index e6fcfa46..f676dfb7 100644 --- a/projects/aas-server/src/test/auth/mongo-db-cookie-storage.spec.ts +++ b/projects/aas-server/src/test/auth/mongo-db-cookie-storage.spec.ts @@ -8,7 +8,7 @@ import 'reflect-metadata'; import { MongoDBCookieStorage, UserCookies } from '../../app/auth/mongo-db-cookie-storage.js'; -import { describe, beforeAll, beforeEach, it, expect, jest } from '@jest/globals'; +import { describe, beforeEach, it, expect, jest, afterEach, beforeAll } from '@jest/globals'; interface UserCookiesInstance extends UserCookies { save(): Promise; @@ -33,16 +33,20 @@ describe('MongoDBCookieStorage', () => { cookies: [ { name: 'Cookie1', - data: 'The quick brown fox jumps over the lazy dog.' + data: 'The quick brown fox jumps over the lazy dog.', }, { name: 'Cookie2', - data: '42' - } - ] + data: '42', + }, + ], }; }); + afterEach(() => { + jest.restoreAllMocks(); + }); + describe('checkAsync', () => { it('indicates that "Cookie1" for john.doe@email.com exist', async () => { jest.spyOn(cookieStorage.UserCookiesModel, 'findOne').mockReturnValue(getInstance(userCookies)); @@ -64,22 +68,22 @@ describe('MongoDBCookieStorage', () => { it('returns the value of "Cookie1" for john.doe@email.com', async () => { jest.spyOn(cookieStorage.UserCookiesModel, 'findOne').mockReturnValue(getInstance(userCookies)); - await expect(cookieStorage.getAsync('john.doe@email.com', 'Cookie1')) - .resolves.toEqual({ name: 'Cookie1', data: 'The quick brown fox jumps over the lazy dog.' }); + await expect(cookieStorage.getAsync('john.doe@email.com', 'Cookie1')).resolves.toEqual({ + name: 'Cookie1', + data: 'The quick brown fox jumps over the lazy dog.', + }); }); it('returns "undefined" for "unknown" for john.doe@email.com', async () => { jest.spyOn(cookieStorage.UserCookiesModel, 'findOne').mockReturnValue(getInstance(userCookies)); - await expect(cookieStorage.getAsync('john.doe@email.com', 'unknown')) - .resolves.toBeUndefined(); + await expect(cookieStorage.getAsync('john.doe@email.com', 'unknown')).resolves.toBeUndefined(); }); it('returns "undefined" for "Cookie1" for jane.doe@email.com', async () => { jest.spyOn(cookieStorage.UserCookiesModel, 'findOne').mockReturnValue(getInstance()); - await expect(cookieStorage.getAsync('jane.doe@email.com', 'unknown')) - .resolves.toBeUndefined(); + await expect(cookieStorage.getAsync('jane.doe@email.com', 'unknown')).resolves.toBeUndefined(); }); }); @@ -87,17 +91,16 @@ describe('MongoDBCookieStorage', () => { it('returns all cookies for john.doe@email.com', async () => { jest.spyOn(cookieStorage.UserCookiesModel, 'findOne').mockReturnValue(getInstance(userCookies)); - await expect(cookieStorage.getAllAsync('john.doe@email.com')) - .resolves.toEqual([ - { - name: 'Cookie1', - data: 'The quick brown fox jumps over the lazy dog.' - }, - { - name: 'Cookie2', - data: '42' - } - ]); + await expect(cookieStorage.getAllAsync('john.doe@email.com')).resolves.toEqual([ + { + name: 'Cookie1', + data: 'The quick brown fox jumps over the lazy dog.', + }, + { + name: 'Cookie2', + data: '42', + }, + ]); }); }); @@ -123,7 +126,9 @@ describe('MongoDBCookieStorage', () => { it('can delete a cookie', async () => { const save = jest.fn<() => Promise>(); const deleteOne = jest.fn<() => Promise>(); - jest.spyOn(cookieStorage.UserCookiesModel, 'findOne').mockReturnValue(getInstance(userCookies, save, deleteOne)); + jest.spyOn(cookieStorage.UserCookiesModel, 'findOne').mockReturnValue( + getInstance(userCookies, save, deleteOne), + ); await cookieStorage.deleteAsync('john.doe@email.com', 'Cookie1'); expect(save).toHaveBeenCalled(); @@ -136,17 +141,19 @@ describe('MongoDBCookieStorage', () => { function getInstance(user?: UserCookies, save?: () => Promise, deleteOne?: () => Promise): any { if (user) { return { - exec: () => new Promise(resolve => resolve( - { - ...user, - save: save ?? (() => new Promise(result => result())), - deleteOne: deleteOne ?? (() => new Promise(result => result())) - })) + exec: () => + new Promise(resolve => + resolve({ + ...user, + save: save ?? (() => new Promise(result => result())), + deleteOne: deleteOne ?? (() => new Promise(result => result())), + }), + ), } as Promisify; } return { - exec: () => new Promise(resolve => resolve(undefined)) + exec: () => new Promise(resolve => resolve(undefined)), } as Promisify; } -}); \ No newline at end of file +}); diff --git a/projects/aas-server/src/test/auth/mongo-db-user-storage.spec.ts b/projects/aas-server/src/test/auth/mongo-db-user-storage.spec.ts index baf4c52c..1a7c0edd 100644 --- a/projects/aas-server/src/test/auth/mongo-db-user-storage.spec.ts +++ b/projects/aas-server/src/test/auth/mongo-db-user-storage.spec.ts @@ -29,12 +29,12 @@ describe('MongoDBUserStorage', () => { beforeEach(() => { johnDoe = { - id: "john.doe@email.com", - name: "John Doe", - role: "editor", - password: "$2a$10$6qZT2ZM5jUVU/pLLQUjCvuXplG.GwPnoz48C1Eg/dKqjIrGE8jm0a", + id: 'john.doe@email.com', + name: 'John Doe', + role: 'editor', + password: '$2a$10$6qZT2ZM5jUVU/pLLQUjCvuXplG.GwPnoz48C1Eg/dKqjIrGE8jm0a', created: new Date(), - lastLoggedIn: new Date(0) + lastLoggedIn: new Date(0), }; }); @@ -67,7 +67,7 @@ describe('MongoDBUserStorage', () => { const save = jest.fn<() => Promise>(); jest.spyOn(userStorage.UserDataModel, 'findOne').mockReturnValue(getPromisify(johnDoe, save)); await userStorage.writeAsync('john.doe@email.com', { ...johnDoe }); - expect(save).toHaveBeenCalled + expect(save).toHaveBeenCalled; }); it('deletes john.doe@email.com', async () => { @@ -78,19 +78,19 @@ describe('MongoDBUserStorage', () => { function getPromisify(user?: UserData, save?: () => Promise): any { if (user) { return { - exec: () => new Promise(resolve => resolve(getInstance(user, save))) + exec: () => new Promise(resolve => resolve(getInstance(user, save))), } as Promisify; } return { - exec: () => new Promise(resolve => resolve(undefined)) + exec: () => new Promise(resolve => resolve(undefined)), } as Promisify; } function getInstance(user: UserData, save?: () => Promise): UserDataInstance { return { ...user, - save: save ?? (() => new Promise(resolve => resolve())) - } + save: save ?? (() => new Promise(resolve => resolve())), + }; } -}); \ No newline at end of file +}); diff --git a/projects/aas-server/src/test/packages/aasx-server/aasx-server-v0.spec.ts b/projects/aas-server/src/test/packages/aasx-server/aasx-server-v0.spec.ts index fb7dc8ad..200fb90d 100644 --- a/projects/aas-server/src/test/packages/aasx-server/aasx-server-v0.spec.ts +++ b/projects/aas-server/src/test/packages/aasx-server/aasx-server-v0.spec.ts @@ -6,8 +6,10 @@ * *****************************************************************************/ +import { describe, beforeEach, it, expect, jest, afterEach } from '@jest/globals'; import http, { IncomingMessage } from 'http'; import { Socket } from 'net'; +import { aas, selectElement } from 'common'; import { AasxServer } from '../../../app/packages/aasx-server/aasx-server.js'; import listaas from '../../assets/test-aas/listaas.js'; import becher1 from '../../assets/test-aas/cuna-cup-becher1.js'; @@ -16,11 +18,9 @@ import nameplate from '../../assets/test-aas/nameplate-becher1.js'; import digitalProductPassport from '../../assets/test-aas/digital-product-passport-becher1.js'; import customerFeedback from '../../assets/test-aas/customer-feedback-becher1.js'; import { AasxServerV0 } from '../../../app/packages/aasx-server/aasx-server-v0.js'; -import { aas, selectElement } from 'common'; import { Logger } from '../../../app/logging/logger.js'; import aasEnvironment from '../../assets/aas-environment.js'; import { createSpyObj } from '../../utils.js'; -import { describe, beforeEach, it, expect, jest } from '@jest/globals'; describe('AasxServerV0', function () { let logger: jest.Mocked; @@ -31,13 +31,17 @@ describe('AasxServerV0', function () { server = new AasxServerV0(logger, 'http://localhost:1234', 'AASX Server'); }); + afterEach(() => { + jest.restoreAllMocks(); + }); + it('returns the AAS list', async function () { jest.spyOn(http, 'request').mockImplementation((options, callback) => { const stream = new IncomingMessage(new Socket()); stream.push(JSON.stringify(listaas)); stream.push(null); - stream.statusCode = 200, - stream.statusMessage = 'OK', + stream.statusCode = 200; + stream.statusMessage = 'OK'; (callback as (res: IncomingMessage) => void)(stream); return new http.ClientRequest('http://localhost:1234'); }); @@ -46,7 +50,8 @@ describe('AasxServerV0', function () { 'AssistanceSystem_Dte', 'CunaCup_Becher1', 'CunaCup_Becher2', - 'DTOrchestrator']); + 'DTOrchestrator', + ]); }); it('gets the AAS with the specified idShort', async function () { @@ -73,9 +78,9 @@ describe('AasxServerV0', function () { const stream = new IncomingMessage(new Socket()); stream.push(JSON.stringify(value)); stream.push(null); - stream.statusCode = 200, - stream.statusMessage = 'OK', - (callback as (res: IncomingMessage) => void)(stream); + (stream.statusCode = 200), + (stream.statusMessage = 'OK'), + (callback as (res: IncomingMessage) => void)(stream); return new http.ClientRequest('http://localhost:1234'); }); @@ -86,22 +91,25 @@ describe('AasxServerV0', function () { it('can open a file', async function () { jest.spyOn(http, 'request').mockImplementation((options, callback) => { const stream = new IncomingMessage(new Socket()); - stream.push(JSON.stringify({ - "aaslist": [ - "0 : ExampleMotor : [IRI] http://customer.com/aas/9175_7013_7091_9168 : ", - ] - })); + stream.push( + JSON.stringify({ + aaslist: ['0 : ExampleMotor : [IRI] http://customer.com/aas/9175_7013_7091_9168 : '], + }), + ); stream.push(null); - stream.statusCode = 200, - stream.statusMessage = 'OK', - (callback as (res: IncomingMessage) => void)(stream); + (stream.statusCode = 200), + (stream.statusMessage = 'OK'), + (callback as (res: IncomingMessage) => void)(stream); return new http.ClientRequest('http://localhost:1234'); }); await expect( - server.openFileAsync(aasEnvironment.assetAdministrationShells[0], - selectElement(aasEnvironment, 'Documentation', 'OperatingManual', 'DigitalFile_PDF')!)).resolves.toBeTruthy(); + server.openFileAsync( + aasEnvironment.assetAdministrationShells[0], + selectElement(aasEnvironment, 'Documentation', 'OperatingManual', 'DigitalFile_PDF')!, + ), + ).resolves.toBeTruthy(); }); it('reads the current value of a data element', async function () { @@ -109,9 +117,9 @@ describe('AasxServerV0', function () { const stream = new IncomingMessage(new Socket()); stream.push(JSON.stringify({ value: 42 })); stream.push(null); - stream.statusCode = 200, - stream.statusMessage = 'OK', - (callback as (res: IncomingMessage) => void)(stream); + (stream.statusCode = 200), + (stream.statusMessage = 'OK'), + (callback as (res: IncomingMessage) => void)(stream); return new http.ClientRequest('http://localhost:1234'); }); @@ -123,16 +131,15 @@ describe('AasxServerV0', function () { let shell: jest.Mocked; beforeEach(function () { - shell = createSpyObj( - {}, - { idShort: 'aas1' }); + shell = createSpyObj({}, { idShort: 'aas1' }); }); it('returns the URL to "property1"', function () { const smId = Buffer.from('http://localhost/test/submodel1').toString('base64'); const nodeId = smId + '.submodel1/property1'; expect(server.resolveNodeId(shell, nodeId)).toEqual( - `http://localhost:1234/aas/aas1/submodels/submodel1/elements/property1/value`); + `http://localhost:1234/aas/aas1/submodels/submodel1/elements/property1/value`, + ); }); }); -}); \ No newline at end of file +}); diff --git a/projects/aas-server/src/test/packages/aasx-server/aasx-server-v3.spec.ts b/projects/aas-server/src/test/packages/aasx-server/aasx-server-v3.spec.ts index 2406694c..cab3d7f3 100644 --- a/projects/aas-server/src/test/packages/aasx-server/aasx-server-v3.spec.ts +++ b/projects/aas-server/src/test/packages/aasx-server/aasx-server-v3.spec.ts @@ -14,7 +14,7 @@ import { cloneDeep } from 'lodash-es'; import { Socket } from 'net'; import { Logger } from '../../../app/logging/logger.js'; import { createSpyObj } from '../../utils.js'; -import { describe, beforeEach, it, expect, jest } from '@jest/globals'; +import { describe, beforeEach, it, expect, jest, afterEach } from '@jest/globals'; describe('AasxServerV3', function () { let logger: Logger; @@ -29,9 +29,7 @@ describe('AasxServerV3', function () { let shell: jest.Mocked; beforeEach(function () { - shell = createSpyObj( - {}, - { id: 'http://localhost/test/aas' }); + shell = createSpyObj({}, { id: 'http://localhost/test/aas' }); }); it('returns the URL to "property1"', function () { @@ -39,7 +37,8 @@ describe('AasxServerV3', function () { const smId = Buffer.from('http://localhost/test/submodel1').toString('base64url'); const nodeId = smId + '.submodel1/property1'; expect(server.resolveNodeId(shell, nodeId)).toEqual( - `http://localhost:1234/shells/${aasId}/submodels/${smId}/submodel-elements/property1`); + `http://localhost:1234/shells/${aasId}/submodels/${smId}/submodel-elements/property1`, + ); }); }); @@ -52,6 +51,10 @@ describe('AasxServerV3', function () { destination = cloneDeep(source); }); + afterEach(() => { + jest.restoreAllMocks(); + }); + it('inserts a submodel', async function () { jest.spyOn(http, 'request').mockImplementation((options, callback) => { const stream = new IncomingMessage(new Socket()); @@ -63,10 +66,12 @@ describe('AasxServerV3', function () { return new http.ClientRequest('http://localhost:1234'); }); - const diffs: DifferenceItem[] = [{ - type: 'inserted', - sourceElement: source.submodels[0] - }]; + const diffs: DifferenceItem[] = [ + { + type: 'inserted', + sourceElement: source.submodels[0], + }, + ]; await expect(server.commitAsync(source, destination, diffs)).resolves.toEqual(['Submodel inserted.']); }); @@ -82,14 +87,18 @@ describe('AasxServerV3', function () { return new http.ClientRequest('http://localhost:1234'); }); - const diffs: DifferenceItem[] = [{ - type: 'inserted', - sourceParent: source.submodels[0], - sourceElement: source.submodels[0].submodelElements![0], - destinationParent: destination.submodels[0] - }]; - - await expect(server.commitAsync(source, destination, diffs)).resolves.toEqual(['SubmodelElement inserted.']); + const diffs: DifferenceItem[] = [ + { + type: 'inserted', + sourceParent: source.submodels[0], + sourceElement: source.submodels[0].submodelElements![0], + destinationParent: destination.submodels[0], + }, + ]; + + await expect(server.commitAsync(source, destination, diffs)).resolves.toEqual([ + 'SubmodelElement inserted.', + ]); }); it('updates a submodel', async function () { @@ -103,11 +112,13 @@ describe('AasxServerV3', function () { return new http.ClientRequest('http://localhost:1234'); }); - const diffs: DifferenceItem[] = [{ - type: 'changed', - sourceElement: source.submodels[0], - destinationElement: destination.submodels[0] - }]; + const diffs: DifferenceItem[] = [ + { + type: 'changed', + sourceElement: source.submodels[0], + destinationElement: destination.submodels[0], + }, + ]; await expect(server.commitAsync(source, destination, diffs)).resolves.toEqual(['Submodel updated.']); }); @@ -123,13 +134,15 @@ describe('AasxServerV3', function () { return new http.ClientRequest('http://localhost:1234'); }); - const diffs: DifferenceItem[] = [{ - type: 'changed', - sourceParent: source.submodels[0], - sourceElement: source.submodels[0].submodelElements![0], - destinationParent: destination.submodels[0], - destinationElement: destination.submodels[0].submodelElements![0] - }]; + const diffs: DifferenceItem[] = [ + { + type: 'changed', + sourceParent: source.submodels[0], + sourceElement: source.submodels[0].submodelElements![0], + destinationParent: destination.submodels[0], + destinationElement: destination.submodels[0].submodelElements![0], + }, + ]; await expect(server.commitAsync(source, destination, diffs)).resolves.toEqual(['SubmodelElement updated.']); }); @@ -145,10 +158,12 @@ describe('AasxServerV3', function () { return new http.ClientRequest('http://localhost:1234'); }); - const diffs: DifferenceItem[] = [{ - type: 'deleted', - destinationElement: destination.submodels[0] - }]; + const diffs: DifferenceItem[] = [ + { + type: 'deleted', + destinationElement: destination.submodels[0], + }, + ]; await expect(server.commitAsync(source, destination, diffs)).resolves.toEqual(['Submodel deleted.']); }); @@ -164,11 +179,13 @@ describe('AasxServerV3', function () { return new http.ClientRequest('http://localhost:1234'); }); - const diffs: DifferenceItem[] = [{ - type: 'deleted', - destinationParent: destination.submodels[0], - destinationElement: destination.submodels[0].submodelElements![0] - }]; + const diffs: DifferenceItem[] = [ + { + type: 'deleted', + destinationParent: destination.submodels[0], + destinationElement: destination.submodels[0].submodelElements![0], + }, + ]; await expect(server.commitAsync(source, destination, diffs)).resolves.toEqual(['SubmodelElement deleted.']); }); @@ -178,7 +195,7 @@ describe('AasxServerV3', function () { it('invokes an operation synchronously', async function () { const result: OperationResult = { executionState: 'Completed', - success: true + success: true, }; jest.spyOn(http, 'request').mockImplementation((options, callback) => { @@ -196,9 +213,9 @@ describe('AasxServerV3', function () { modelType: 'Operation', parent: { type: 'ModelReference', - keys: [{ type: 'Submodel', value: 'http://i40.customer.com/type/1/1/F13E8576F6488342' }] - } - } + keys: [{ type: 'Submodel', value: 'http://i40.customer.com/type/1/1/F13E8576F6488342' }], + }, + }; await expect(server.invoke(env, operation)).resolves.toEqual(operation); }); @@ -218,18 +235,18 @@ describe('AasxServerV3', function () { modelType: 'Operation', parent: { type: 'ModelReference', - keys: [{ type: 'Submodel', value: 'http://i40.customer.com/type/1/1/F13E8576F6488342' }] - } - } + keys: [{ type: 'Submodel', value: 'http://i40.customer.com/type/1/1/F13E8576F6488342' }], + }, + }; await expect(server.invoke(env, operation)).rejects.toThrowError(); }); it('throws an error if the operation fails', async function () { const result: OperationResult = { - messages: [{messageType: 'Error', text: 'Operation failed.'}], + messages: [{ messageType: 'Error', text: 'Operation failed.' }], executionState: 'Failed', - success: false + success: false, }; jest.spyOn(http, 'request').mockImplementation((options, callback) => { @@ -247,11 +264,11 @@ describe('AasxServerV3', function () { modelType: 'Operation', parent: { type: 'ModelReference', - keys: [{ type: 'Submodel', value: 'http://i40.customer.com/type/1/1/F13E8576F6488342' }] - } - } + keys: [{ type: 'Submodel', value: 'http://i40.customer.com/type/1/1/F13E8576F6488342' }], + }, + }; await expect(server.invoke(env, operation)).rejects.toThrowError(); }); }); -}); \ No newline at end of file +}); diff --git a/projects/aas-server/src/test/packages/json-writer-v2.spec.ts b/projects/aas-server/src/test/packages/json-writer-v2.spec.ts index 14369410..737ef567 100644 --- a/projects/aas-server/src/test/packages/json-writer-v2.spec.ts +++ b/projects/aas-server/src/test/packages/json-writer-v2.spec.ts @@ -14,28 +14,28 @@ describe('JsonWriterV2', function () { describe('writeEnvironment', function () { let writer: JsonWriterV2; - beforeEach(function(){ + beforeEach(() => { writer = new JsonWriterV2(); }); - it('is not implemented', function() { + it('is not implemented', () => { expect(() => writer.writeEnvironment(env)).toThrowError(); - }) + }); }); - describe('write', function() { + describe('write', () => { let writer: JsonWriterV2; - beforeEach(function(){ + beforeEach(() => { writer = new JsonWriterV2(); }); - it('does not support writing an AAS', function() { + it('does not support writing an AAS', () => { expect(() => writer.write(env.assetAdministrationShells[0])).toThrowError(); }); - it('writes a submodel', function() { + it('writes a submodel', () => { expect(writer.write(env.submodels[0])).toBeDefined(); - }) + }); }); -}); \ No newline at end of file +}); diff --git a/projects/aas-server/src/test/packages/json-writer.spec.ts b/projects/aas-server/src/test/packages/json-writer.spec.ts index 6d812464..d44074d9 100644 --- a/projects/aas-server/src/test/packages/json-writer.spec.ts +++ b/projects/aas-server/src/test/packages/json-writer.spec.ts @@ -14,24 +14,24 @@ describe('JsonWriter', function () { describe('writeEnvironment', function () { let writer: JsonWriter; - beforeEach(function(){ + beforeEach(() => { writer = new JsonWriter(); }); - it('writes an AAS environment', function() { + it('writes an AAS environment', () => { expect(writer.writeEnvironment(env)).toBeDefined(); - }) + }); }); - describe('write', function() { + describe('write', () => { let writer: JsonWriter; - beforeEach(function(){ + beforeEach(() => { writer = new JsonWriter(); }); - it('does not support writing an AAS', function() { + it('does not support writing an AAS', () => { expect(() => writer.write(env.assetAdministrationShells[0])).toThrowError(); }); }); -}); \ No newline at end of file +}); diff --git a/projects/aas-server/src/test/packages/opcua/opcua-reader.spec.ts b/projects/aas-server/src/test/packages/opcua/opcua-reader.spec.ts index 8563474b..82b15386 100644 --- a/projects/aas-server/src/test/packages/opcua/opcua-reader.spec.ts +++ b/projects/aas-server/src/test/packages/opcua/opcua-reader.spec.ts @@ -7,10 +7,10 @@ *****************************************************************************/ import { describe, beforeEach, it, expect, jest } from '@jest/globals'; -import { Logger } from "../../../app/logging/logger.js"; +import { Logger } from '../../../app/logging/logger.js'; import { OpcuaReader } from '../../../app/packages/opcua/opcua-reader.js'; -import { OPCUAComponent } from "../../../app/packages/opcua/opcua.js"; -import { OpcuaDataTypeDictionary } from "../../../app/packages/opcua/opcua-data-type-dictionary.js"; +import { OPCUAComponent } from '../../../app/packages/opcua/opcua.js'; +import { OpcuaDataTypeDictionary } from '../../../app/packages/opcua/opcua-data-type-dictionary.js'; import { createSpyObj } from '../../utils.js'; describe('OpcuaReader', function () { @@ -29,4 +29,4 @@ describe('OpcuaReader', function () { it('should be created', function () { expect(reader).toBeTruthy(); }); -}); \ No newline at end of file +}); diff --git a/projects/aas-server/src/test/packages/opcua/opcua-server.spec.ts b/projects/aas-server/src/test/packages/opcua/opcua-server.spec.ts index 539bbcb5..dc8f5abe 100644 --- a/projects/aas-server/src/test/packages/opcua/opcua-server.spec.ts +++ b/projects/aas-server/src/test/packages/opcua/opcua-server.spec.ts @@ -14,6 +14,7 @@ import { CallMethodRequestLike, CallMethodResult, ClientSession, OPCUAClient, St import { SocketClient } from '../../../app/live/socket-client.js'; import { LiveRequest, aas } from 'common'; import env from '../../assets/aas-environment.js'; +import { afterEach } from 'node:test'; type CallMethod = (methodToCall: CallMethodRequestLike) => Promise; @@ -26,6 +27,10 @@ describe('OpcuaServer', function () { server = new OpcuaServer(logger, 'opc.tcp://localhost:1234/I4AASServer', 'OPCUA Server'); }); + afterEach(() => { + jest.restoreAllMocks(); + }); + it('should be created', function () { expect(server).toBeTruthy(); }); @@ -47,7 +52,10 @@ describe('OpcuaServer', function () { }); it('throws an Error for an invalid URL', async function () { - client.connect.mockImplementation(() => new Promise((_, reject) => reject(new Error('Connection failed.')))); + client.connect.mockImplementation( + () => new Promise((_, reject) => reject(new Error('Connection failed.'))), + ); + client.createSession.mockImplementation(() => new Promise(resolve => resolve(session))); jest.spyOn(OPCUAClient, 'create').mockReturnValue(client); await expect(server.testAsync()).rejects.toThrowError(); @@ -108,10 +116,12 @@ describe('OpcuaServer', function () { const request: LiveRequest = { endpoint: 'Test', id: 'opc.tcp://localhost:1234/I4AASServer', - nodes: [{ - nodeId: 'ns=1;i=4711', - valueType: 'xs:integer' - }] + nodes: [ + { + nodeId: 'ns=1;i=4711', + valueType: 'xs:integer', + }, + ], }; expect(server.createSubscription(createSpyObj({}), request)).toBeTruthy(); @@ -151,9 +161,7 @@ describe('OpcuaServer', function () { it('invokes an operation', async function () { const result = createSpyObj([], { statusCode: StatusCodes.Good, - outputArguments: [ - { value: '3' } as Variant - ] + outputArguments: [{ value: '3' } as Variant], }); const call: CallMethod = () => { @@ -168,15 +176,22 @@ describe('OpcuaServer', function () { objectId: 'ns=1;i=0815', inputVariables: [ { value: { idShort: 'a', modelType: 'Property', valueType: 'xs:int', value: '1' } as aas.Property }, - { value: { idShort: 'b', modelType: 'Property', valueType: 'xs:int', value: '2' } as aas.Property } + { value: { idShort: 'b', modelType: 'Property', valueType: 'xs:int', value: '2' } as aas.Property }, ], outputVariables: [ - { value: { idShort: 'sum', modelType: 'Property', valueType: 'xs:int', value: '3' } as aas.Property }, + { + value: { + idShort: 'sum', + modelType: 'Property', + valueType: 'xs:int', + value: '3', + } as aas.Property, + }, ], parent: { type: 'ModelReference', - keys: [{ type: 'Submodel', value: 'http://i40.customer.com/type/1/1/F13E8576F6488342' }] - } + keys: [{ type: 'Submodel', value: 'http://i40.customer.com/type/1/1/F13E8576F6488342' }], + }, }; await server.openAsync(); @@ -184,13 +199,10 @@ describe('OpcuaServer', function () { await server.closeAsync(); }); - it('throw an Error if the call result is not "Good"', async function () { const result = createSpyObj([], { statusCode: StatusCodes.Bad, - outputArguments: [ - { value: '3' } as Variant - ] + outputArguments: [{ value: '3' } as Variant], }); const call: CallMethod = () => { @@ -205,15 +217,22 @@ describe('OpcuaServer', function () { objectId: 'ns=1;i=0815', inputVariables: [ { value: { idShort: 'a', modelType: 'Property', valueType: 'xs:int', value: '1' } as aas.Property }, - { value: { idShort: 'b', modelType: 'Property', valueType: 'xs:int', value: '2' } as aas.Property } + { value: { idShort: 'b', modelType: 'Property', valueType: 'xs:int', value: '2' } as aas.Property }, ], outputVariables: [ - { value: { idShort: 'sum', modelType: 'Property', valueType: 'xs:int', value: '3' } as aas.Property }, + { + value: { + idShort: 'sum', + modelType: 'Property', + valueType: 'xs:int', + value: '3', + } as aas.Property, + }, ], parent: { type: 'ModelReference', - keys: [{ type: 'Submodel', value: 'http://i40.customer.com/type/1/1/F13E8576F6488342' }] - } + keys: [{ type: 'Submodel', value: 'http://i40.customer.com/type/1/1/F13E8576F6488342' }], + }, }; await server.openAsync(); @@ -221,4 +240,4 @@ describe('OpcuaServer', function () { await server.closeAsync(); }); }); -}); \ No newline at end of file +}); diff --git a/projects/aas-server/src/test/packages/server-message.spec.ts b/projects/aas-server/src/test/packages/server-message.spec.ts index 68056808..4e3ed0ab 100644 --- a/projects/aas-server/src/test/packages/server-message.spec.ts +++ b/projects/aas-server/src/test/packages/server-message.spec.ts @@ -9,9 +9,9 @@ import net from 'net'; import http, { IncomingMessage } from 'http'; import { Socket } from 'net'; -import { ServerMessage } from "../../app/packages/server-message.js"; +import { ServerMessage } from '../../app/packages/server-message.js'; import { createSpyObj } from '../utils.js'; -import { describe, beforeEach, it, expect, jest } from '@jest/globals'; +import { describe, beforeEach, it, expect, jest, afterEach } from '@jest/globals'; describe('ServerMessage', function () { let server: ServerMessage; @@ -20,6 +20,10 @@ describe('ServerMessage', function () { server = new ServerMessage(); }); + afterEach(() => { + jest.restoreAllMocks(); + }); + it('should created', function () { expect(server).toBeTruthy(); }); @@ -38,8 +42,9 @@ describe('ServerMessage', function () { }); it('gets an object from a server', async function () { - await expect(server.get<{ text: string }>(new URL('http://localhost:1234/hello/world'))) - .resolves.toEqual({ text: 'Hello World!' }); + await expect(server.get<{ text: string }>(new URL('http://localhost:1234/hello/world'))).resolves.toEqual({ + text: 'Hello World!', + }); }); }); @@ -56,7 +61,7 @@ describe('ServerMessage', function () { it('gets the message response', async function () { await expect(server.getResponse(new URL('http://localhost:1234/hello/world'))).resolves.toBeTruthy(); - }) + }); }); describe('put', function () { @@ -73,8 +78,9 @@ describe('ServerMessage', function () { }); it('updates an object on a server', async function () { - await expect(server.put(new URL('http://localhost:1234/hello/world'), { text: 'Hello World!' })) - .resolves.toEqual(JSON.stringify('OK')); + await expect( + server.put(new URL('http://localhost:1234/hello/world'), { text: 'Hello World!' }), + ).resolves.toEqual(JSON.stringify('OK')); }); }); @@ -92,8 +98,9 @@ describe('ServerMessage', function () { }); it('updates an object on a server', async function () { - await expect(server.post(new URL('http://localhost:1234/hello/world'), { text: 'Hello World!' })) - .resolves.toEqual(JSON.stringify('Created')); + await expect( + server.post(new URL('http://localhost:1234/hello/world'), { text: 'Hello World!' }), + ).resolves.toEqual(JSON.stringify('Created')); }); }); @@ -111,8 +118,9 @@ describe('ServerMessage', function () { }); it('updates an object on a server', async function () { - await expect(server.delete(new URL('http://localhost:1234/hello/world'))) - .resolves.toEqual(JSON.stringify('Deleted')); + await expect(server.delete(new URL('http://localhost:1234/hello/world'))).resolves.toEqual( + JSON.stringify('Deleted'), + ); }); }); @@ -149,4 +157,4 @@ describe('ServerMessage', function () { await expect(server.checkUrlExist('http://localhost:9876')).rejects.toThrowError(); }); }); -}); \ No newline at end of file +}); diff --git a/projects/common/.eslintrc b/projects/common/.eslintrc index c939dc42..b6e2302c 100644 --- a/projects/common/.eslintrc +++ b/projects/common/.eslintrc @@ -1,7 +1,3 @@ { - "root": true, - "parser": "@typescript-eslint/parser", - "extends": ["plugin:@typescript-eslint/recommended"], - "parserOptions": { "ecmaVersion": 2018, "sourceType": "module" }, - "rules": {} - } \ No newline at end of file + "extends": "../../.eslintrc.json" +} \ No newline at end of file diff --git a/projects/common/src/lib/aas.ts b/projects/common/src/lib/aas.ts index 1df5c1e6..5e56d82d 100644 --- a/projects/common/src/lib/aas.ts +++ b/projects/common/src/lib/aas.ts @@ -7,23 +7,23 @@ *****************************************************************************/ export type AasSubmodelElements = - 'AnnotatedRelationshipElement' | - 'BasicEventElement' | - 'Blob' | - 'Capability' | - 'DataElement' | - 'Entity' | - 'EventElement' | - 'File' | - 'MultiLanguageProperty' | - 'Operation' | - 'Property' | - 'Range' | - 'ReferenceElement' | - 'RelationshipElement' | - 'SubmodelElement' | - 'SubmodelElementCollection' | - 'SubmodelElementList'; + | 'AnnotatedRelationshipElement' + | 'BasicEventElement' + | 'Blob' + | 'Capability' + | 'DataElement' + | 'Entity' + | 'EventElement' + | 'File' + | 'MultiLanguageProperty' + | 'Operation' + | 'Property' + | 'Range' + | 'ReferenceElement' + | 'RelationshipElement' + | 'SubmodelElement' + | 'SubmodelElementCollection' + | 'SubmodelElementList'; export interface AdministrativeInformation extends HasDataSpecification { version?: string; @@ -69,8 +69,7 @@ export interface Blob extends DataElement { } // eslint-disable-next-line @typescript-eslint/no-empty-interface -export interface Capability extends SubmodelElement { -} +export interface Capability extends SubmodelElement {} export interface ConceptDescription extends Identifiable, HasDataSpecification { isCaseOf?: Reference[]; @@ -101,57 +100,57 @@ export interface DataSpecificationIEC61360 extends DataSpecificationContent { } export type DataTypeDefXsd = - 'xs:anyURI' | - 'xs:base64Binary' | - 'xs:boolean' | - 'xs:byte' | - 'xs:date' | - 'xs:dateTime' | - 'xs:decimal' | - 'xs:double' | - 'xs:duration' | - 'xs:float' | - 'xs:gDay' | - 'xs:gMonth' | - 'xs:gMonthDay' | - 'xs:gYear' | - 'xs:gYearMonth' | - 'xs:hexBinary' | - 'xs:int' | - 'xs:integer' | - 'xs:long' | - 'xs:negativeInteger' | - 'xs:nonNegativeInteger' | - 'xs:nonPositiveInteger' | - 'xs:positiveInteger' | - 'xs:short' | - 'xs:string' | - 'xs:time' | - 'xs:unsignedByte' | - 'xs:unsignedInt' | - 'xs:unsignedLong' | - 'xs:unsignedShort'; + | 'xs:anyURI' + | 'xs:base64Binary' + | 'xs:boolean' + | 'xs:byte' + | 'xs:date' + | 'xs:dateTime' + | 'xs:decimal' + | 'xs:double' + | 'xs:duration' + | 'xs:float' + | 'xs:gDay' + | 'xs:gMonth' + | 'xs:gMonthDay' + | 'xs:gYear' + | 'xs:gYearMonth' + | 'xs:hexBinary' + | 'xs:int' + | 'xs:integer' + | 'xs:long' + | 'xs:negativeInteger' + | 'xs:nonNegativeInteger' + | 'xs:nonPositiveInteger' + | 'xs:positiveInteger' + | 'xs:short' + | 'xs:string' + | 'xs:time' + | 'xs:unsignedByte' + | 'xs:unsignedInt' + | 'xs:unsignedLong' + | 'xs:unsignedShort'; export type DataTypeIEC61360 = - 'BLOB' | - 'BOOLEAN' | - 'DATE' | - 'FILE' | - 'HTML' | - 'INTEGER_COUNT' | - 'INTEGER_CURRENCY' | - 'INTEGER_MEASURE' | - 'IRDI' | - 'IRI' | - 'RATIONAL' | - 'RATIONAL_MEASURE' | - 'REAL_COUNT' | - 'REAL_CURRENCY' | - 'REAL_MEASURE' | - 'STRING' | - 'STRING_TRANSLATABLE' | - 'TIME' | - 'TIMESTAMP'; + | 'BLOB' + | 'BOOLEAN' + | 'DATE' + | 'FILE' + | 'HTML' + | 'INTEGER_COUNT' + | 'INTEGER_CURRENCY' + | 'INTEGER_MEASURE' + | 'IRDI' + | 'IRI' + | 'RATIONAL' + | 'RATIONAL_MEASURE' + | 'REAL_COUNT' + | 'REAL_CURRENCY' + | 'REAL_MEASURE' + | 'STRING' + | 'STRING_TRANSLATABLE' + | 'TIME' + | 'TIMESTAMP'; export type Direction = 'input' | 'output'; @@ -176,8 +175,7 @@ export interface Environment { } // eslint-disable-next-line @typescript-eslint/no-empty-interface -export interface EventElement extends SubmodelElement { -} +export interface EventElement extends SubmodelElement {} export interface EventPayload extends SubmodelElement { source: Reference; @@ -230,30 +228,30 @@ export interface Key { } export type KeyTypes = - 'AnnotatedRelationshipElement' | - 'AssetAdministrationShell' | - 'BasicEventElement' | - 'Blob' | - 'Capability' | - 'ConceptDescription' | - 'DataElement' | - 'Entity' | - 'EventElement' | - 'File' | - 'FragmentReference' | - 'GlobalReference' | - 'Identifiable' | - 'MultiLanguageProperty' | - 'Operation' | - 'Property' | - 'Range' | - 'Referable' | - 'ReferenceElement' | - 'RelationshipElement' | - 'Submodel' | - 'SubmodelElement' | - 'SubmodelElementCollection' | - 'SubmodelElementList'; + | 'AnnotatedRelationshipElement' + | 'AssetAdministrationShell' + | 'BasicEventElement' + | 'Blob' + | 'Capability' + | 'ConceptDescription' + | 'DataElement' + | 'Entity' + | 'EventElement' + | 'File' + | 'FragmentReference' + | 'GlobalReference' + | 'Identifiable' + | 'MultiLanguageProperty' + | 'Operation' + | 'Property' + | 'Range' + | 'Referable' + | 'ReferenceElement' + | 'RelationshipElement' + | 'Submodel' + | 'SubmodelElement' + | 'SubmodelElementCollection' + | 'SubmodelElementList'; export interface LangString { language: string; @@ -263,24 +261,24 @@ export interface LangString { export type LevelType = 'Max' | 'Min' | 'Nom' | 'Typ'; export type ModelType = - 'AnnotatedRelationshipElement' | - 'AssetAdministrationShell' | - 'BasicEventElement' | - 'Blob' | - 'Capability' | - 'ConceptDescription' | - 'DataSpecificationIEC61360' | - 'Entity' | - 'File' | - 'MultiLanguageProperty' | - 'Operation' | - 'Property' | - 'Range' | - 'ReferenceElement' | - 'RelationshipElement' | - 'Submodel' | - 'SubmodelElementCollection' | - 'SubmodelElementList'; + | 'AnnotatedRelationshipElement' + | 'AssetAdministrationShell' + | 'BasicEventElement' + | 'Blob' + | 'Capability' + | 'ConceptDescription' + | 'DataSpecificationIEC61360' + | 'Entity' + | 'File' + | 'MultiLanguageProperty' + | 'Operation' + | 'Property' + | 'Range' + | 'ReferenceElement' + | 'RelationshipElement' + | 'Submodel' + | 'SubmodelElementCollection' + | 'SubmodelElementList'; export type ModellingKind = 'Template' | 'Instance'; @@ -376,8 +374,7 @@ export interface Submodel extends Identifiable, HasKind, HasSemantic, Qualifiabl submodelElements?: SubmodelElement[]; } -export interface SubmodelElement extends Referable, HasKind, HasSemantic, Qualifiable, HasDataSpecification { -} +export interface SubmodelElement extends Referable, HasKind, HasSemantic, Qualifiable, HasDataSpecification {} export interface SubmodelElementCollection extends SubmodelElement { value?: SubmodelElement[]; @@ -392,10 +389,10 @@ export interface SubmodelElementList extends SubmodelElement { } export interface ValueList { - valueReferencePairs: ValueReferencePair[] + valueReferencePairs: ValueReferencePair[]; } export interface ValueReferencePair { value: string; valueId: Reference; -} \ No newline at end of file +} diff --git a/projects/common/src/lib/application-error.ts b/projects/common/src/lib/application-error.ts index b3a9af09..9f8b5ff7 100644 --- a/projects/common/src/lib/application-error.ts +++ b/projects/common/src/lib/application-error.ts @@ -6,20 +6,20 @@ * *****************************************************************************/ - export class ApplicationError extends Error { +export class ApplicationError extends Error { /** * @constructor * @param message The error message. * @param name The name of the error. * @param args Additional arguments for the error message. */ - constructor(message: string, name: string, ...args: Parameters) { + public constructor(message: string, name: string, ...args: unknown[]) { super(message); - this.name = name ?? "Application error"; + this.name = name ?? 'Application error'; this.args = args ?? []; } /** Gets the additional arguments. */ - public readonly args: Parameters; -} \ No newline at end of file + public readonly args: unknown[]; +} diff --git a/projects/common/src/lib/authentication.ts b/projects/common/src/lib/authentication.ts index c4f64e1d..937d5eb7 100644 --- a/projects/common/src/lib/authentication.ts +++ b/projects/common/src/lib/authentication.ts @@ -6,17 +6,17 @@ * *****************************************************************************/ -import { capitalize } from "lodash-es"; +import { capitalize } from 'lodash-es'; -export type UserRole = "guest" | "editor" | "admin"; +export type UserRole = 'guest' | 'editor' | 'admin'; export const priority: UserRole[] = ['guest', 'editor', 'admin']; /** The user roles. */ export const USER_ROLES: { [key: string]: string } = { - admin: "admin", - editor: "editor", - guest: "guest" + admin: 'admin', + editor: 'editor', + guest: 'guest', }; /** The user profile. */ @@ -60,7 +60,12 @@ export function getUserNameFromEMail(email: string): string { let name: string; const index = email.indexOf('@'); if (index > 0) { - name = email.substring(0, index).replace(/[.-]/, ' ').split(' ').map(item => capitalize(item)).join(' '); + name = email + .substring(0, index) + .replace(/[.-]/, ' ') + .split(' ') + .map(item => capitalize(item)) + .join(' '); } else { name = email; } @@ -77,4 +82,4 @@ export function isUserAuthorized(actual: UserRole, expected: UserRole): boolean const i = priority.indexOf(expected); const j = priority.indexOf(actual); return i >= 0 && j >= 0 && i <= j; -} \ No newline at end of file +} diff --git a/projects/common/src/lib/convert.ts b/projects/common/src/lib/convert.ts index fe805a40..f1821ed3 100644 --- a/projects/common/src/lib/convert.ts +++ b/projects/common/src/lib/convert.ts @@ -12,97 +12,95 @@ const dateTimeFormat: Intl.DateTimeFormatOptions = { year: 'numeric', month: 'numeric', day: 'numeric', - hour: "numeric", - minute: "numeric", - second: "numeric" + hour: 'numeric', + minute: 'numeric', + second: 'numeric', }; const invariantDecimalSeparator = '.'; const invariantGroupSeparator = ','; -const mimeTypes = new Map( - [ - ['audio/aac', '.aac'], - ['application/x-abiword', '.abw'], - ['application/x-freearc', '.arc'], - ['image/avif', '.avif'], - ['video/x-msvideo', '.avi'], - ['application/vnd.amazon.ebook', '.azw'], - ['application/octet-stream', '.bin'], - ['.bmp', 'image/bmp'], - ['application/x-bzip', '.bz'], - ['application/x-bzip2', '.bz2'], - ['application/x-cdf', '.cda'], - ['application/x-csh', '.csh'], - ['text/css', '.css'], - ['text/csv', '.csv'], - ['application/msword', '.doc'], - ['application/vnd.openxmlformats-officedocument.wordprocessingml.document', '.docx'], - ['application/vnd.ms-fontobject', '.eot'], - ['application/epub+zip', '.epub'], - ['application/gzip', '.gz'], - ['image/gif', '.gif'], - ['text/html', '.html'], - ['image/vnd.microsoft.icon', '.ico'], - ['text/calendar', '.ics'], - ['application/java-archive', '.jar'], - ['image/jpeg', '.jar'], - ['text/javascript', '.js'], - ['application/json', '.json'], - ['application/ld+json', '.jsonld'], - ['audio/midi', '.midi'], - ['audio/x-midi', '.midi'], - ['audio/mpeg', '.mp3'], - ['video/mp4', '.mp4'], - ['video/mpeg', '.mpeg'], - ['application/vnd.apple.installer+xml', '.mpkg'], - ['application/vnd.oasis.opendocument.presentation', '.odp'], - ['application/vnd.oasis.opendocument.spreadsheet', '.ods'], - ['application/vnd.oasis.opendocument.text', '.odt'], - ['audio/ogg', '.oga'], - ['video/ogg', '.ogv'], - ['application/ogg', '.ogx'], - ['audio/opus', '.opus'], - ['font/otf', '.otf'], - ['image/png', '.png'], - ['application/pdf', '.pdf'], - ['application/x-httpd-php', '.php'], - ['application/vnd.ms-powerpoint', '.ppt'], - ['application/vnd.openxmlformats-officedocument.presentationml.presentation', '.pptx'], - ['application/vnd.rar', '.rar'], - ['application/rtf', '.rtf'], - ['application/x-sh', '.sh'], - ['image/svg+xml', '.svg'], - ['application/x-tar', '.tar'], - ['image/tiff', '.tiff'], - ['video/mp2t', '.ts'], - ['font/ttf', '.ttf'], - ['text/plain', '.txt'], - ['application/vnd.visio', '.vsd'], - ['audio/wav', '.wav'], - ['audio/webm', '.weba'], - ['video/webm', '.webp'], - ['font/woff', '.woff'], - ['font/woff2', '.woff2'], - ['application/xhtml+xml', '.xhtml'], - ['application/vnd.ms-excel', '.xls'], - ['application/vnd.openxmlformats-officedocument.spreadsheetml.sheet', '.xlsx'], - ['application/xml', '.xml'], - ['text/xml', '.xml'], - ['application/vnd.mozilla.xul+xml', '.xul'], - ['application/x-pem-file', '.pem'], - ['application/zip', '.zip'], - ['video/3gpp', '.3gp'], - ['audio/3gpp', '.3gp'], - ['video/3gpp2', '.3g2'], - ['audio/3gpp2', '.3g2'], - ['application/x-7z-compressed', '.7z'] - ] -); +const mimeTypes = new Map([ + ['audio/aac', '.aac'], + ['application/x-abiword', '.abw'], + ['application/x-freearc', '.arc'], + ['image/avif', '.avif'], + ['video/x-msvideo', '.avi'], + ['application/vnd.amazon.ebook', '.azw'], + ['application/octet-stream', '.bin'], + ['.bmp', 'image/bmp'], + ['application/x-bzip', '.bz'], + ['application/x-bzip2', '.bz2'], + ['application/x-cdf', '.cda'], + ['application/x-csh', '.csh'], + ['text/css', '.css'], + ['text/csv', '.csv'], + ['application/msword', '.doc'], + ['application/vnd.openxmlformats-officedocument.wordprocessingml.document', '.docx'], + ['application/vnd.ms-fontobject', '.eot'], + ['application/epub+zip', '.epub'], + ['application/gzip', '.gz'], + ['image/gif', '.gif'], + ['text/html', '.html'], + ['image/vnd.microsoft.icon', '.ico'], + ['text/calendar', '.ics'], + ['application/java-archive', '.jar'], + ['image/jpeg', '.jar'], + ['text/javascript', '.js'], + ['application/json', '.json'], + ['application/ld+json', '.jsonld'], + ['audio/midi', '.midi'], + ['audio/x-midi', '.midi'], + ['audio/mpeg', '.mp3'], + ['video/mp4', '.mp4'], + ['video/mpeg', '.mpeg'], + ['application/vnd.apple.installer+xml', '.mpkg'], + ['application/vnd.oasis.opendocument.presentation', '.odp'], + ['application/vnd.oasis.opendocument.spreadsheet', '.ods'], + ['application/vnd.oasis.opendocument.text', '.odt'], + ['audio/ogg', '.oga'], + ['video/ogg', '.ogv'], + ['application/ogg', '.ogx'], + ['audio/opus', '.opus'], + ['font/otf', '.otf'], + ['image/png', '.png'], + ['application/pdf', '.pdf'], + ['application/x-httpd-php', '.php'], + ['application/vnd.ms-powerpoint', '.ppt'], + ['application/vnd.openxmlformats-officedocument.presentationml.presentation', '.pptx'], + ['application/vnd.rar', '.rar'], + ['application/rtf', '.rtf'], + ['application/x-sh', '.sh'], + ['image/svg+xml', '.svg'], + ['application/x-tar', '.tar'], + ['image/tiff', '.tiff'], + ['video/mp2t', '.ts'], + ['font/ttf', '.ttf'], + ['text/plain', '.txt'], + ['application/vnd.visio', '.vsd'], + ['audio/wav', '.wav'], + ['audio/webm', '.weba'], + ['video/webm', '.webp'], + ['font/woff', '.woff'], + ['font/woff2', '.woff2'], + ['application/xhtml+xml', '.xhtml'], + ['application/vnd.ms-excel', '.xls'], + ['application/vnd.openxmlformats-officedocument.spreadsheetml.sheet', '.xlsx'], + ['application/xml', '.xml'], + ['text/xml', '.xml'], + ['application/vnd.mozilla.xul+xml', '.xul'], + ['application/x-pem-file', '.pem'], + ['application/zip', '.zip'], + ['video/3gpp', '.3gp'], + ['audio/3gpp', '.3gp'], + ['video/3gpp2', '.3g2'], + ['audio/3gpp2', '.3g2'], + ['application/x-7z-compressed', '.7z'], +]); export type DefaultType = string | number | boolean | bigint; -export type StandardType = string | number | boolean | object +export type StandardType = string | number | boolean | object; /** * Assigns a XSD data type to a corresponding JS data type. @@ -116,7 +114,7 @@ export function baseType(type: DataTypeDefXsd): 'string' | 'number' | 'boolean' case 'xs:base64Binary': return 'string'; case 'xs:boolean': - return 'boolean' + return 'boolean'; case 'xs:byte': return 'number'; case 'xs:date': @@ -162,7 +160,7 @@ export function baseType(type: DataTypeDefXsd): 'string' | 'number' | 'boolean' case 'xs:string': return 'string'; case 'xs:time': - return 'Date' + return 'Date'; case 'xs:unsignedByte': return 'number'; case 'xs:unsignedInt': @@ -248,7 +246,7 @@ export function convertToString(value: unknown, localeId?: string): string { function getProperties(obj: object): string[] { const items: string[] = []; for (const property in obj) { - items.push(`${property}: ${convertToString((obj)[property], localeId)}`) + items.push(`${property}: ${convertToString((obj as { [key: string]: unknown })[property], localeId)}`); } return items; @@ -269,7 +267,8 @@ export function convertToString(value: unknown, localeId?: string): string { export function convertFromString( s: string | null | undefined, valueType: DataTypeDefXsd, - localeId?: string): DefaultType | undefined { + localeId?: string, +): DefaultType | undefined { if (!s) { return undefined; } @@ -331,7 +330,10 @@ export function parseNumber(s: string, localeId?: string): number { } const groups = items[0].split(groupSeparator); - if (groups.length > 1 && groups.some((group, i) => i === 0 && group.length > 3 || i > 0 && group.length !== 3)) { + if ( + groups.length > 1 && + groups.some((group, i) => (i === 0 && group.length > 3) || (i > 0 && group.length !== 3)) + ) { return NaN; } @@ -359,7 +361,7 @@ export function parseDate(s: string, localeId?: string): Date | undefined { s = s.trim(); if (localeId) { let dateItems: string[] | undefined; - let timeTuple: { items: string[], timePeriod?: string } | undefined; + let timeTuple: { items: string[]; timePeriod?: string } | undefined; const dateTime = splitDateTime(s); if (dateTime.length === 1) { if (s.indexOf(tuple.dateDelimiter) >= 0) { @@ -376,7 +378,8 @@ export function parseDate(s: string, localeId?: string): Date | undefined { now.getDate(), getHours(timeTuple?.items, timeTuple?.timePeriod), getMinutes(timeTuple?.items), - getSeconds(timeTuple?.items)); + getSeconds(timeTuple?.items), + ); } } else if (dateTime.length === 2) { dateItems = dateTime[0].split(tuple.dateDelimiter); @@ -387,7 +390,8 @@ export function parseDate(s: string, localeId?: string): Date | undefined { getDay(dateItems), getHours(timeTuple?.items, timeTuple?.timePeriod), getMinutes(timeTuple?.items), - getSeconds(timeTuple?.items)); + getSeconds(timeTuple?.items), + ); } else { date = new Date(NaN); } @@ -415,15 +419,16 @@ export function parseDate(s: string, localeId?: string): Date | undefined { } function getFormatInfo(parts: Intl.DateTimeFormatPart[]): { - dateDelimiter: string, - timeDelimiter: string, - indexOfYear: number, - indexOfMonth: number, - indexOfDay: number, - hours24: boolean + dateDelimiter: string; + timeDelimiter: string; + indexOfYear: number; + indexOfMonth: number; + indexOfDay: number; + hours24: boolean; } { - const items = ['year', 'month', 'day'] - .sort((a, b) => parts.findIndex(item => item.type === a) - parts.findIndex(item => item.type === b)); + const items = ['year', 'month', 'day'].sort( + (a, b) => parts.findIndex(item => item.type === a) - parts.findIndex(item => item.type === b), + ); return { dateDelimiter: parts[3].value, @@ -431,11 +436,11 @@ export function parseDate(s: string, localeId?: string): Date | undefined { indexOfDay: items.indexOf('day'), indexOfMonth: items.indexOf('month'), indexOfYear: items.indexOf('year'), - hours24: parts.findIndex(part => part.type === 'dayPeriod') < 0 + hours24: parts.findIndex(part => part.type === 'dayPeriod') < 0, }; } - function splitTime(exp: string): { items: string[], timePeriod?: string } { + function splitTime(exp: string): { items: string[]; timePeriod?: string } { if (exp.toLowerCase().endsWith('am')) { return { items: exp.substring(0, exp.length - 2).split(tuple.timeDelimiter), timePeriod: 'am' }; } @@ -591,8 +596,7 @@ export function getLocaleValue(value?: LangString[], localeId?: string): string if (lcid === localeId || lcid === language) { localeValue = item.text; break; - } - else if (!localeValue && getLanguage(item.language) === language) { + } else if (!localeValue && getLanguage(item.language) === language) { localeValue = item.text; } } @@ -608,11 +612,6 @@ export function getLocaleValue(value?: LangString[], localeId?: string): string function getLanguage(value: string): string { return value.split('-')[0].toLowerCase(); } - - function getRegion(value: string): string | null { - const items = value.split('-'); - return items.length > 1 ? items[1].toLowerCase() : null; - } } /** @@ -636,15 +635,17 @@ export function toLocale(value: string | undefined, valueType: DataTypeDefXsd, l switch (valueType) { case 'xs:float': - case 'xs:double': + case 'xs:double': { const d = parseNumber(value); return Number.isNaN(d) ? undefined : d.toLocaleString(localeId); + } case 'xs:integer': case 'xs:int': case 'xs:unsignedInt': - case 'xs:unsignedShort': + case 'xs:unsignedShort': { const i = parseNumber(value); return Number.isNaN(i) ? undefined : i.toLocaleString(localeId); + } case 'xs:date': case 'xs:dateTime': return parseDate(value)?.toLocaleString(localeId, dateTimeFormat); @@ -661,22 +662,28 @@ export function toLocale(value: string | undefined, valueType: DataTypeDefXsd, l * @param valueType The value type. * @param localeId The source language. */ -export function toInvariant(value: string | undefined, valueType: DataTypeDefXsd, localeId: string): string | undefined { +export function toInvariant( + value: string | undefined, + valueType: DataTypeDefXsd, + localeId: string, +): string | undefined { if (!value) { return value; } switch (valueType) { case 'xs:float': - case 'xs:double': + case 'xs:double': { const d = parseNumber(value, localeId); return Number.isNaN(d) ? undefined : d.toString(); + } case 'xs:integer': case 'xs:int': case 'xs:unsignedInt': - case 'xs:unsignedShort': + case 'xs:unsignedShort': { const i = parseNumber(value, localeId); return Number.isNaN(i) ? undefined : i.toString(); + } case 'xs:date': case 'xs:dateTime': case 'xs:time': @@ -729,7 +736,7 @@ export function toBoolean(value: unknown): boolean { return true; } - return Number(value) !== 0 ? true : false + return Number(value) !== 0 ? true : false; } if (typeof value === 'number') { @@ -762,7 +769,7 @@ function stringToBoolean(value: string): boolean { function stringToSByte(value: string): number | undefined { const b = Number(value); if (Number.isNaN(b) || b < -256) { - return undefined + return undefined; } return b < 128 ? b : b - 256; @@ -784,7 +791,9 @@ function toDouble(value: unknown, localeId?: string): number | undefined { if (typeof value === 'string') { if (localeId) { - const decimalPart = Intl.NumberFormat(localeId).formatToParts(1.23).find(part => part.type === 'decimal'); + const decimalPart = Intl.NumberFormat(localeId) + .formatToParts(1.23) + .find(part => part.type === 'decimal'); if (decimalPart) { value = value.replace(decimalPart.value, '.'); } @@ -860,4 +869,4 @@ function toBigInt(value: unknown): bigint | undefined { } return undefined; -} \ No newline at end of file +} diff --git a/projects/common/src/lib/crc32.ts b/projects/common/src/lib/crc32.ts index 7744d0af..e804cf1c 100644 --- a/projects/common/src/lib/crc32.ts +++ b/projects/common/src/lib/crc32.ts @@ -10,7 +10,7 @@ export class Crc32 { private readonly table: number[]; private crc = 0; - public constructor(private readonly reversedPolynomial = 0xEDB88320) { + public constructor(private readonly reversedPolynomial = 0xedb88320) { this.table = this.generate(); } @@ -41,8 +41,8 @@ export class Crc32 { const dataView = new DataView(data); const table = this.generate(); let crc = this.initial(); - for (let i = 0; i < dataView.byteLength; i++) { - crc = this.addByte(table, crc, dataView.getUint8(i)); + for (let i = 0; i < dataView.byteLength; i++) { + crc = this.addByte(table, crc, dataView.getUint8(i)); } return this.final(crc); @@ -69,7 +69,7 @@ export class Crc32 { n = n >>> 1; } } - + table[i] = n; } @@ -77,17 +77,17 @@ export class Crc32 { } private initial(): number { - return 0xFFFFFFFF; + return 0xffffffff; } private addByte(table: number[], crc: number, byte: number): number { - crc = (crc >>> 8) ^ table[(byte) ^ (crc & 0x000000FF)]; + crc = (crc >>> 8) ^ table[byte ^ (crc & 0x000000ff)]; return crc; } private final(crc: number): number { crc = ~crc; - crc = (crc < 0) ? (0xFFFFFFFF + crc + 1) : crc; + crc = crc < 0 ? 0xffffffff + crc + 1 : crc; return crc; } -} \ No newline at end of file +} diff --git a/projects/common/src/lib/document.ts b/projects/common/src/lib/document.ts index faa8c22d..18110be9 100644 --- a/projects/common/src/lib/document.ts +++ b/projects/common/src/lib/document.ts @@ -28,7 +28,7 @@ export interface DifferenceItem { * @returns `true` if the specified documents are equal. */ export function equalDocument(a: AASDocument | null, b: AASDocument | null): boolean { - return a === b || a != null && b != null && a.id === b.id && a.endpoint === b.endpoint; + return a === b || (a != null && b != null && a.id === b.id && a.endpoint === b.endpoint); } /** @@ -37,9 +37,7 @@ export function equalDocument(a: AASDocument | null, b: AASDocument | null): boo * @param referable The element to check. * @returns The parent element or `undefined` if element is the root. */ -export function getParent( - env: aas.Environment, - referable: aas.Referable): aas.Referable | undefined { +export function getParent(env: aas.Environment, referable: aas.Referable): aas.Referable | undefined { return referable.parent ? selectReferable(env, referable.parent) : undefined; } @@ -69,10 +67,7 @@ export function selectSubmodel(env: aas.Environment, referable: aas.Referable): * @param element An element to check. * @returns `true` if the element is a descendant of the given ancestor; otherwise, `false`. */ -export function isDescendant( - env: aas.Environment, - ancestor: aas.Referable, - element: aas.Referable): boolean { +export function isDescendant(env: aas.Environment, ancestor: aas.Referable, element: aas.Referable): boolean { for (let referable = getParent(env, element); referable; referable = getParent(env, referable)) { if (referable === ancestor) { return true; @@ -91,18 +86,17 @@ export function isDescendant( export function normalize( env: aas.Environment, elements: T[], - access: (item: T) => aas.Referable = (item) => item as aas.Referable): T[] { + access: (item: T) => aas.Referable = item => item as aas.Referable, +): T[] { let items: T[] = elements; let temp: T[] = []; for (let i = 0; i < items.length; ++i) { for (let j = 0; j < items.length; j++) { if (i !== j) { - if (items[i] !== items[j] && - !isDescendant(env, access(items[i]), access(items[j]))) { + if (items[i] !== items[j] && !isDescendant(env, access(items[i]), access(items[j]))) { temp.push(items[j]); } - } - else { + } else { temp.push(items[i]); } } @@ -126,7 +120,10 @@ export function* traverse(root: aas.Referable): Generator<[string, [aas.Referabl yield item; } - function* traverseChildren(parent: aas.Referable, path: string): Generator<[string, [aas.Referable, aas.Referable]]> { + function* traverseChildren( + parent: aas.Referable, + path: string, + ): Generator<[string, [aas.Referable, aas.Referable]]> { for (const child of getChildren(parent)) { const childPath = path + child.idShort; yield [path + child.idShort, [parent, child]]; @@ -139,8 +136,8 @@ export function* traverse(root: aas.Referable): Generator<[string, [aas.Referabl } /** - * - * @param root + * + * @param root */ export function* flat(root: aas.Referable): Generator { yield root; @@ -166,9 +163,7 @@ export function* flat(root: aas.Referable): Generator { * @param targetEnv The destination element. * @returns The differences between the source and destination element. */ -export function diff( - sourceEnv: aas.Environment, - targetEnv: aas.Environment): DifferenceItem[] { +export function diff(sourceEnv: aas.Environment, targetEnv: aas.Environment): DifferenceItem[] { if (sourceEnv && targetEnv && sourceEnv === targetEnv) { return []; } @@ -176,14 +171,15 @@ export function diff( return [ ...diffCollection(sourceEnv.assetAdministrationShells, targetEnv.assetAdministrationShells), ...diffCollection(sourceEnv.submodels, targetEnv.submodels), - ...diffCollection(sourceEnv.conceptDescriptions, targetEnv.conceptDescriptions)]; + ...diffCollection(sourceEnv.conceptDescriptions, targetEnv.conceptDescriptions), + ]; function diffCollection(sources: aas.Referable[], targets: aas.Referable[]): DifferenceItem[] { const diffs: DifferenceItem[] = []; for (let i = 0; i < sources.length; i++) { const j = targets.findIndex(item => item.idShort === sources[i].idShort); if (j < 0) { - diffs.push({ type: 'inserted', sourceIndex: i, sourceElement: sources[i] }) + diffs.push({ type: 'inserted', sourceIndex: i, sourceElement: sources[i] }); } else { diffs.push(...diffReferable(sources[i], targets[j])); } @@ -222,7 +218,7 @@ export function diff( sourceIndex: indexOf(srcParent, src), destinationParent: dstParent, destinationElement: dst, - destinationIndex: indexOf(dstParent, dst) + destinationIndex: indexOf(dstParent, dst), }); } else { const i = indexOf(srcParent, src); @@ -235,7 +231,7 @@ export function diff( sourceIndex: i, destinationParent: dstParent, destinationElement: dst, - destinationIndex: j + destinationIndex: j, }); } } @@ -245,7 +241,7 @@ export function diff( sourceParent: getParent(targetEnv, destinationItem[1][1]), destinationParent: destinationItem[1][0], destinationElement: destinationItem[1][1], - destinationIndex: indexOf(destinationItem[1][0], destinationItem[1][1]) + destinationIndex: indexOf(destinationItem[1][0], destinationItem[1][1]), }); } } @@ -257,7 +253,7 @@ export function diff( sourceParent: item[1][0], sourceElement: item[1][1], sourceIndex: indexOf(item[1][0], item[1][1]), - destinationParent: getParent(targetEnv, item[1][1]) + destinationParent: getParent(targetEnv, item[1][1]), }); } } @@ -269,7 +265,7 @@ export function diff( } function twins(a?: aas.Referable, b?: aas.Referable): boolean { - return a && b ? a === b || equalReference(a.parent, b.parent) && a.idShort === b.idShort : false; + return a && b ? a === b || (equalReference(a.parent, b.parent) && a.idShort === b.idShort) : false; } function indexOf(parent: aas.Referable | undefined, child: aas.Referable): number { @@ -284,19 +280,23 @@ export function diff( if (a.modelType === 'SubmodelElementCollection') { equal = isEqual( { ...a, value: undefined } as aas.SubmodelElementCollection, - { ...b, value: undefined } as aas.SubmodelElementCollection); + { ...b, value: undefined } as aas.SubmodelElementCollection, + ); } else if (a.modelType === 'SubmodelElementList') { equal = isEqual( { ...a, value: undefined } as aas.SubmodelElementList, - { ...b, value: undefined } as aas.SubmodelElementList); + { ...b, value: undefined } as aas.SubmodelElementList, + ); } else if (a.modelType === 'Submodel') { equal = isEqual( { ...a, submodelElements: undefined } as aas.Submodel, - { ...b, submodelElements: undefined } as aas.Submodel); + { ...b, submodelElements: undefined } as aas.Submodel, + ); } else if (a.modelType === 'AssetAdministrationShell') { equal = isEqual( { ...a, submodels: undefined } as aas.AssetAdministrationShell, - { ...b, submodels: undefined } as aas.AssetAdministrationShell); + { ...b, submodels: undefined } as aas.AssetAdministrationShell, + ); } else { equal = isEqual(a, b); } @@ -331,15 +331,19 @@ export function diffAsync(source: aas.Environment, destination: aas.Environment) export function isDeepEqual(a?: aas.Environment, b?: aas.Environment): boolean { const queue: [aas.Referable, aas.Referable][] = []; if (a && b) { - if (!equalLength(a.assetAdministrationShells, b.assetAdministrationShells) || + if ( + !equalLength(a.assetAdministrationShells, b.assetAdministrationShells) || !equalLength(a.submodels, b.submodels) || - !equalLength(a.conceptDescriptions, b.conceptDescriptions)) { + !equalLength(a.conceptDescriptions, b.conceptDescriptions) + ) { return false; } - if (!queueReferables(a.assetAdministrationShells, b.assetAdministrationShells) || + if ( + !queueReferables(a.assetAdministrationShells, b.assetAdministrationShells) || !queueReferables(a.submodels, b.submodels) || - !queueReferables(a.conceptDescriptions, b.conceptDescriptions)) { + !queueReferables(a.conceptDescriptions, b.conceptDescriptions) + ) { return false; } @@ -382,7 +386,10 @@ export function isDeepEqual(a?: aas.Environment, b?: aas.Environment): boolean { case 'Submodel': return equalSubmodel(a as aas.Submodel, b as aas.Submodel); case 'SubmodelElementCollection': - return equalSubmodelElementCollection(a as aas.SubmodelElementCollection, b as aas.SubmodelElementCollection); + return equalSubmodelElementCollection( + a as aas.SubmodelElementCollection, + b as aas.SubmodelElementCollection, + ); case 'SubmodelElementList': return equalSubmodelElementList(a as aas.SubmodelElementList, b as aas.SubmodelElementList); case 'AssetAdministrationShell': @@ -403,12 +410,15 @@ export function isDeepEqual(a?: aas.Environment, b?: aas.Environment): boolean { } function equalIdentifiable(a: aas.Identifiable, b: aas.Identifiable): boolean { - return equalReferable(a, b) && - a.id === b.id && - equalAdministrativeInformation(a.administration, b.administration); + return ( + equalReferable(a, b) && a.id === b.id && equalAdministrativeInformation(a.administration, b.administration) + ); } - function equalAdministrativeInformation(a?: aas.AdministrativeInformation, b?: aas.AdministrativeInformation): boolean { + function equalAdministrativeInformation( + a?: aas.AdministrativeInformation, + b?: aas.AdministrativeInformation, + ): boolean { if (a === b) { return true; } @@ -424,7 +434,10 @@ export function isDeepEqual(a?: aas.Environment, b?: aas.Environment): boolean { return equalEmbeddedDataSpecifications(a.embeddedDataSpecifications, b.embeddedDataSpecifications); } - function equalEmbeddedDataSpecifications(a?: aas.EmbeddedDataSpecification[], b?: aas.EmbeddedDataSpecification[]): boolean { + function equalEmbeddedDataSpecifications( + a?: aas.EmbeddedDataSpecification[], + b?: aas.EmbeddedDataSpecification[], + ): boolean { if (a === b) { return true; } @@ -442,11 +455,17 @@ export function isDeepEqual(a?: aas.Environment, b?: aas.Environment): boolean { return false; } - function equalEmbeddedDataSpecification(a: aas.EmbeddedDataSpecification, b: aas.EmbeddedDataSpecification): boolean { - return equalReference(a.dataSpecification, b.dataSpecification) && - equalDataSpecificationContent(a.dataSpecificationContent, b.dataSpecificationContent); + function equalEmbeddedDataSpecification( + a: aas.EmbeddedDataSpecification, + b: aas.EmbeddedDataSpecification, + ): boolean { + return ( + equalReference(a.dataSpecification, b.dataSpecification) && + equalDataSpecificationContent(a.dataSpecificationContent, b.dataSpecificationContent) + ); } + // eslint-disable-next-line @typescript-eslint/no-unused-vars function equalDataSpecificationContent(a: aas.DataSpecificationContent, b: aas.DataSpecificationContent): boolean { // ToDo: return true; @@ -479,8 +498,13 @@ export function isDeepEqual(a?: aas.Environment, b?: aas.Environment): boolean { } function equalQualifier(a: aas.Qualifier, b: aas.Qualifier) { - return a.kind === b.kind && a.type === b.type && a.valueType === b.valueType && a.value === b.value && - equalReference(a.valueId, b.valueId); + return ( + a.kind === b.kind && + a.type === b.type && + a.valueType === b.valueType && + a.value === b.value && + equalReference(a.valueId, b.valueId) + ); } function equalHasKind(a: aas.HasKind, b: aas.HasKind): boolean { @@ -492,16 +516,20 @@ export function isDeepEqual(a?: aas.Environment, b?: aas.Environment): boolean { return false; } - return equalReferences(a.submodels, b.submodels) && + return ( + equalReferences(a.submodels, b.submodels) && equalAssetInformation(a.assetInformation, b.assetInformation) && - equalReference(a.derivedFrom, b.derivedFrom); + equalReference(a.derivedFrom, b.derivedFrom) + ); } function equalAssetInformation(a: aas.AssetInformation, b: aas.AssetInformation): boolean { - return a.assetKind === b.assetKind && + return ( + a.assetKind === b.assetKind && a.globalAssetId === b.globalAssetId && equalSpecificIds(a.specificAssetIds, b.specificAssetIds) && - equalResource(a.defaultThumbnail, b.defaultThumbnail); + equalResource(a.defaultThumbnail, b.defaultThumbnail) + ); } function equalSpecificIds(a?: aas.SpecificAssetId[], b?: aas.SpecificAssetId[]): boolean { @@ -527,28 +555,34 @@ export function isDeepEqual(a?: aas.Environment, b?: aas.Environment): boolean { } function equalSubmodel(a: aas.Submodel, b: aas.Submodel): boolean { - return equalIdentifiable(a, b) && + return ( + equalIdentifiable(a, b) && equalHasDataSpecification(a, b) && equalHasSemantic(a, b) && equalQualifiable(a, b) && equalHasKind(a, b) && - queueReferables(a.submodelElements, b.submodelElements); + queueReferables(a.submodelElements, b.submodelElements) + ); } function equalReferable(a: aas.Referable, b: aas.Referable): boolean { - return a.modelType === b.modelType && + return ( + a.modelType === b.modelType && a.idShort === b.idShort && a.category === b.category && equalLangStrings(a.descriptions, b.descriptions) && - equalReference(a.parent, b.parent); + equalReference(a.parent, b.parent) + ); } function equalSubmodelElement(a: aas.SubmodelElement, b: aas.SubmodelElement): boolean { - return equalReferable(a, b) && + return ( + equalReferable(a, b) && equalHasDataSpecification(a, b) && equalHasSemantic(a, b) && equalQualifiable(a, b) && - equalHasKind(a, b); + equalHasKind(a, b) + ); } function equalProperty(a: aas.Property, b: aas.Property): boolean { @@ -573,17 +607,21 @@ export function isDeepEqual(a?: aas.Environment, b?: aas.Environment): boolean { return equalSubmodelElement(a, b) && equalLangStrings(a.value, b.value); } - function equalSubmodelElementCollection(a: aas.SubmodelElementCollection, b: aas.SubmodelElementCollection): boolean { - return equalSubmodelElement(a, b) && - queueReferables(a.value, b.value); + function equalSubmodelElementCollection( + a: aas.SubmodelElementCollection, + b: aas.SubmodelElementCollection, + ): boolean { + return equalSubmodelElement(a, b) && queueReferables(a.value, b.value); } function equalSubmodelElementList(a: aas.SubmodelElementList, b: aas.SubmodelElementList): boolean { - return equalSubmodelElement(a, b) && + return ( + equalSubmodelElement(a, b) && a.orderRelevant === b.orderRelevant && a.typeValueListElement === b.typeValueListElement && equalReference(a.semanticIdListElement, b.semanticIdListElement) && - queueReferables(a.value, b.value); + queueReferables(a.value, b.value) + ); } function equalLangStrings(a?: aas.LangString[], b?: aas.LangString[]): boolean { @@ -609,17 +647,25 @@ export function isDeepEqual(a?: aas.Environment, b?: aas.Environment): boolean { } function equalEntity(a: aas.Entity, b: aas.Entity): boolean { - return equalSubmodelElement(a, b) && + return ( + equalSubmodelElement(a, b) && a.entityType == b.entityType && a.globalAssetId === b.globalAssetId && equalSpecificAssetId(a.specificAssetId, b.specificAssetId) && - queueReferables(a.statements, b.statements); + queueReferables(a.statements, b.statements) + ); } function equalSpecificAssetId(a?: aas.SpecificAssetId, b?: aas.SpecificAssetId): boolean { - return a === b || - a != null && b != null && equalHasSemantic(a, b) && a.name === b.name && a.value === b.value && - equalReference(a.externalSubjectId, b.externalSubjectId); + return ( + a === b || + (a != null && + b != null && + equalHasSemantic(a, b) && + a.name === b.name && + a.value === b.value && + equalReference(a.externalSubjectId, b.externalSubjectId)) + ); } function equalFile(a: aas.File, b: aas.File): boolean { @@ -661,7 +707,7 @@ export function isDeepEqual(a?: aas.Environment, b?: aas.Environment): boolean { return true; } - if (a && b && a.keys && b.keys && (a.keys.length === b.keys.length)) { + if (a && b && a.keys && b.keys && a.keys.length === b.keys.length) { for (let i = 0, n = a.keys.length; i < n; i++) { if (!equalKey(a.keys[i], b.keys[i])) { return false; @@ -726,7 +772,7 @@ export function getAbbreviation(modelType: aas.ModelType): AASAbbreviation | und case 'ReferenceElement': return 'Ref'; case 'RelationshipElement': - return 'Rel' + return 'Rel'; case 'Submodel': return 'SM'; case 'SubmodelElementCollection': @@ -783,7 +829,8 @@ export function getModelTypeFromAbbreviation(abbreviation: AASAbbreviation): aas */ export function selectReferable( env: aas.Environment, - reference: aas.Reference): T | undefined { + reference: aas.Reference, +): T | undefined { let referable: aas.Referable | undefined; for (const key of reference.keys) { switch (key.type) { @@ -824,9 +871,9 @@ export function selectElement(env: aas.Environment, ... if (current.modelType === 'Submodel') { current = (current as aas.Submodel).submodelElements?.find(item => item.idShort === idShort); } else if (current.modelType === 'SubmodelElementCollection') { - current = (current as aas.SubmodelElementCollection).value?.find(item => item.idShort === idShort) + current = (current as aas.SubmodelElementCollection).value?.find(item => item.idShort === idShort); } else if (current.modelType === 'SubmodelElementList') { - current = (current as aas.SubmodelElementList).value?.find(item => item.idShort === idShort) + current = (current as aas.SubmodelElementList).value?.find(item => item.idShort === idShort); } if (!current) { @@ -845,9 +892,7 @@ export function selectElement(env: aas.Environment, ... * @param reference The reference. * @returns The referables that belongs to the specified reference. */ -export function resolveReference( - env: aas.Environment, - reference: aas.Reference): aas.Referable[] | undefined { +export function resolveReference(env: aas.Environment, reference: aas.Reference): aas.Referable[] | undefined { let parent: aas.Referable | undefined; const referables: aas.Referable[] = []; for (const key of reference.keys) { @@ -891,18 +936,22 @@ export function resolveReference( } /** - * - * @param env - * @param referable - * @returns + * + * @param env + * @param referable + * @returns */ export function getIEC61360Content( env: aas.Environment, - referable: aas.Referable): aas.DataSpecificationIEC61360 | undefined { + referable: aas.Referable, +): aas.DataSpecificationIEC61360 | undefined { const hasDataSpecification = referable as aas.HasDataSpecification; if (hasDataSpecification.embeddedDataSpecifications) { for (const item of hasDataSpecification.embeddedDataSpecifications) { - if (item.dataSpecification.keys[0].value === 'http://admin-shell.io/DataSpecificationTemplates/DataSpecificationIEC61360') { + if ( + item.dataSpecification.keys[0].value === + 'http://admin-shell.io/DataSpecificationTemplates/DataSpecificationIEC61360' + ) { return item.dataSpecificationContent as aas.DataSpecificationIEC61360; } } @@ -920,19 +969,19 @@ export function getIEC61360Content( } /** - * - * @param env - * @param referable + * + * @param env + * @param referable */ export function getUnit(env: aas.Environment, referable: aas.Referable): string | undefined { return getIEC61360Content(env, referable)?.unit; } /** - * - * @param env - * @param referable - * @returns + * + * @param env + * @param referable + * @returns */ export function getPreferredName(env: aas.Environment, referable: aas.Referable): aas.LangString[] | undefined { return getIEC61360Content(env, referable)?.preferredName; @@ -978,7 +1027,7 @@ export function getAbsolutePath(referable: aas.Referable): string[] { } /** - * Gets the idShort path of the specified + * Gets the idShort path of the specified * @param referable The current referable. * @returns The idShort path of the specified referable. */ @@ -1003,8 +1052,11 @@ function equalReference(a?: aas.Reference, b?: aas.Reference): boolean { return true; } - if (a.keys.length === b.keys.length && a.type === b.type && - equalReference(a.referredSemanticId, b.referredSemanticId)) { + if ( + a.keys.length === b.keys.length && + a.type === b.type && + equalReference(a.referredSemanticId, b.referredSemanticId) + ) { for (let i = 0; i < a.keys.length; i++) { if (a.keys[i].type !== b.keys[i].type || a.keys[i].value === b.keys[i].value) { return false; @@ -1017,4 +1069,3 @@ function equalReference(a?: aas.Reference, b?: aas.Reference): boolean { return false; } - diff --git a/projects/common/src/lib/index.ts b/projects/common/src/lib/index.ts index 41eddf91..b47cd45d 100644 --- a/projects/common/src/lib/index.ts +++ b/projects/common/src/lib/index.ts @@ -16,7 +16,7 @@ import { ReferenceElement, Submodel, SubmodelElement, - SubmodelElementCollection + SubmodelElementCollection, } from './aas.js'; export * from './document.js'; @@ -37,9 +37,7 @@ export * from './query-parser.js'; * @returns `true` if the specified value represents a valid e-mail; otherwise, `false`. */ export function isValidEMail(value: string | undefined): boolean { - return typeof value === 'string' && - value.length >= 5 && - /^[^@\s]+@[^@\s]+\.[^@\s]+$/.test(value); + return typeof value === 'string' && value.length >= 5 && /^[^@\s]+@[^@\s]+\.[^@\s]+$/.test(value); } /** @@ -48,11 +46,13 @@ export function isValidEMail(value: string | undefined): boolean { * @returns `true` if the specified value represents a valid password; otherwise, `false`. */ export function isValidPassword(value: string | undefined): boolean { - return typeof value === 'string' && + return ( + typeof value === 'string' && /^[\S]+$/.test(value) && value.length >= 8 && value.length <= 20 && - /^[a-zA-Z0-9-+_$%!§?#*~.,;:/]+$/.test(value); + /^[a-zA-Z0-9-+_$%!§?#*~.,;:/]+$/.test(value) + ); } /** @@ -229,4 +229,4 @@ export function isSubmodelElementCollection(referable?: Referable | null): refer */ export function isUrlSafeBase64(s: string): boolean { return /^[A-Za-z0-9_-]*[.=]{0,2}$/.test(s); -} \ No newline at end of file +} diff --git a/projects/common/src/lib/keyed-list.ts b/projects/common/src/lib/keyed-list.ts index 7d30d3fb..6742c537 100644 --- a/projects/common/src/lib/keyed-list.ts +++ b/projects/common/src/lib/keyed-list.ts @@ -10,7 +10,10 @@ export class KeyedList { private readonly map = new Map(); private readonly list: TValue[] = []; - constructor(private readonly getKey: (value: TValue) => TKey, values?: TValue[]) { + public constructor( + private readonly getKey: (value: TValue) => TKey, + values?: TValue[], + ) { if (values) { values.forEach(value => this.set(value)); } @@ -68,4 +71,4 @@ export class KeyedList { this.list.splice(0, this.list.length); this.map.clear(); } -} \ No newline at end of file +} diff --git a/projects/common/src/lib/multi-key-map.ts b/projects/common/src/lib/multi-key-map.ts index fe1b55ca..ea1e0323 100644 --- a/projects/common/src/lib/multi-key-map.ts +++ b/projects/common/src/lib/multi-key-map.ts @@ -74,4 +74,4 @@ export class MultiKeyMap { this._keyMap.clear(); this._valueMap.clear(); } -} \ No newline at end of file +} diff --git a/projects/common/src/lib/query-parser.ts b/projects/common/src/lib/query-parser.ts index 8c1299fc..b8af4e61 100644 --- a/projects/common/src/lib/query-parser.ts +++ b/projects/common/src/lib/query-parser.ts @@ -29,7 +29,7 @@ export interface OrExpression { } export interface Expression { - orExpressions: OrExpression[] + orExpressions: OrExpression[]; } export class QueryParser { @@ -48,14 +48,17 @@ export class QueryParser { 'rela', 'sm', 'smc', - 'sml' + 'sml', ]); private readonly stack: { orExpressions: OrExpression[]; currentOr?: OrExpression }[] = [{ orExpressions: [] }]; private currentPosition = -1; private _hasAASQueries = false; - public constructor(expression: string, private readonly language: string = 'en') { + public constructor( + expression: string, + private readonly language: string = 'en', + ) { this.expression = expression.trim(); } @@ -88,10 +91,7 @@ export class QueryParser { this.nextTerm(); if (this.stack.length !== 1) { - throw new ApplicationError( - 'QueryParser.INVALID_NESTED_EXPRESSION', - `Invalid nested expression.`, - ); + throw new ApplicationError('QueryParser.INVALID_NESTED_EXPRESSION', `Invalid nested expression.`); } const current = this.stack[this.stack.length - 1]; @@ -160,19 +160,20 @@ export class QueryParser { current.currentOr.andExpressions.push(term); } - current.orExpressions.push(current.currentOr) + current.orExpressions.push(current.currentOr); this.endTerm(current.orExpressions); } private getText(leaveQuotationMarks: boolean = false): string { const c = this.expression[this.currentPosition]; - if (c === '"' || c === '\'') { + if (c === '"' || c === "'") { const i = this.expression.indexOf(c, this.currentPosition + 1); if (i < 0) { throw new ApplicationError( 'QueryParser.END_OF_TEXT_NOT_FOUND', `The end of the text, starting at position ${this.currentPosition}, was not found.`, - this.currentPosition); + this.currentPosition, + ); } const text = leaveQuotationMarks @@ -225,7 +226,8 @@ export class QueryParser { throw new ApplicationError( 'QueryParser.LINK_EXPECTED', `'||' or '&&' expected at position ${this.currentPosition}`, - this.currentPosition); + this.currentPosition, + ); } private skipBlanks(): boolean { @@ -257,7 +259,7 @@ export class QueryParser { current.currentOr.andExpressions.push(term); } - current.orExpressions.push(current.currentOr) + current.orExpressions.push(current.currentOr); current.currentOr = undefined; } @@ -348,7 +350,7 @@ export class QueryParser { } if (this.ifChar('<=')) { - return '<=' + return '<='; } if (this.ifChar('<')) { @@ -356,7 +358,7 @@ export class QueryParser { } if (this.ifChar('>=')) { - return '>=' + return '>='; } if (this.ifChar('>')) { @@ -377,7 +379,7 @@ export class QueryParser { ); } - return undefined + return undefined; } private ifChar(c: string): boolean { @@ -392,7 +394,7 @@ export class QueryParser { private parseValue(): AASQueryValueType { this.skipBlanks(); const s = this.getText(true); - if (s[0] === '"' || s[0] === '\'') { + if (s[0] === '"' || s[0] === "'") { return s.substring(1, s.length - 1); } @@ -494,4 +496,4 @@ export class QueryParser { return undefined; } } -} \ No newline at end of file +} diff --git a/projects/common/src/lib/server-message.ts b/projects/common/src/lib/server-message.ts index 957429d0..0d3e5089 100644 --- a/projects/common/src/lib/server-message.ts +++ b/projects/common/src/lib/server-message.ts @@ -10,15 +10,15 @@ import { AASContainer, AASDocument, AASEndpoint } from './types.js'; /** Defines the message types. */ export type AASServerMessageType = - 'Added' | - 'Removed' | - 'Changed' | - 'Offline' | - 'ContainerAdded' | - 'ContainerRemoved' | - 'EndpointAdded' | - 'EndpointRemoved' | - 'Reset'; + | 'Added' + | 'Removed' + | 'Changed' + | 'Offline' + | 'ContainerAdded' + | 'ContainerRemoved' + | 'EndpointAdded' + | 'EndpointRemoved' + | 'Reset'; /** Server message. */ export interface AASServerMessage { @@ -26,8 +26,8 @@ export interface AASServerMessage { type: AASServerMessageType; /** The container if type `ContainerAdded` and `ContainerRemoved`. */ container?: AASContainer; - /** The endpoint if type `ContainerAdded`, `ContainerRemoved`, `EndpointAdded`, `EndpointRemoved`. */ + /** The endpoint if type `ContainerAdded`, `ContainerRemoved`, `EndpointAdded`, `EndpointRemoved`. */ endpoint?: AASEndpoint; /** The document if type `Added`, `Removed` or `Changed` */ document?: AASDocument; -} \ No newline at end of file +} diff --git a/projects/common/src/lib/types.ts b/projects/common/src/lib/types.ts index 0c00aeb7..69aeb290 100644 --- a/projects/common/src/lib/types.ts +++ b/projects/common/src/lib/types.ts @@ -6,7 +6,7 @@ * *****************************************************************************/ -import * as aas from "./aas.js"; +import * as aas from './aas.js'; /** Defines the supported endpoint types. */ export type EndpointType = 'file' | 'http' | 'opc'; @@ -19,31 +19,31 @@ export interface Endpoint { /** Abbreviations for AAS model elements. */ export type AASAbbreviation = - 'AAS' | - 'Cap' | - 'CD' | - 'DE' | - 'DST' | - 'Ent' | - 'Evt' | - 'InOut' | - 'In' | - 'Id' | - 'MLP' | - 'File' | - 'Blob' | - 'Opr' | - 'Out' | - 'Qfr' | - 'Prop' | - 'Range' | - 'Ref' | - 'Rel' | - 'RelA' | - 'SM' | - 'SMC' | - 'SME' | - 'SML'; + | 'AAS' + | 'Cap' + | 'CD' + | 'DE' + | 'DST' + | 'Ent' + | 'Evt' + | 'InOut' + | 'In' + | 'Id' + | 'MLP' + | 'File' + | 'Blob' + | 'Opr' + | 'Out' + | 'Qfr' + | 'Prop' + | 'Range' + | 'Ref' + | 'Rel' + | 'RelA' + | 'SM' + | 'SMC' + | 'SME' + | 'SML'; /** The kind of AAS container or server. */ export type AASEndpointType = 'AasxDirectory' | 'AasxServer' | 'OpcuaServer' | 'AASRegistry'; @@ -73,7 +73,7 @@ export interface AASDocumentId { export interface AASDocument extends AASDocumentId { /** The address of the AAS in the container. */ address: string; - /** The root element of the AAS structure (content), `null` if the content is not loaded or + /** The root element of the AAS structure (content), `null` if the content is not loaded or * `undefined` if the content is not available. */ content?: aas.Environment | null; /** Checksum to detect changes. */ @@ -126,13 +126,13 @@ export interface AASWorkspace { export interface LiveValue { nodeId: string; - value?: any; + value?: unknown; timeStamp?: number; } export interface LiveNode { nodeId: string; - value?: any; + value?: unknown; valueType: aas.DataTypeDefXsd; timeStamp?: number; } @@ -140,7 +140,7 @@ export interface LiveNode { export interface LiveRequest { endpoint: string; id: string; - nodes: LiveNode[] + nodes: LiveNode[]; } export interface PackageInfo { @@ -204,5 +204,5 @@ export interface WebSocketData { /** The message type. */ type: string; /** The data. */ - data: any; + data: unknown; }