release version 1.5.0

Features:
- added support for RBAC with BaSyx
- added settings page to add, edit and delete RBAC rules with mnestix
- added a product overview page hidden behind a feature flag
- added submodel visualization for 'Technical Data'
- added a licence and about dialog
- added a button to copy AAS ID and asset ID to clipboard
- added support for PCN lifecycle phases
- added whitelist to only show relevant submodels

Documentation and Administration
- added documentation for RBAC
- updated mnestix-api version to 1.3.2
- added validation for environment variables
- added server side logging for some features

Development:
- added dependabot, type checking and code quality to pipeline actions
- added project summary as markdown to include in copilot prompts
- full support of next-intl translations, removed react-intl translations

further bug fixes

Author: JonathanXITASO

.env.example

@@ -1,3 +1,7 @@
-AD_SECRET_VALUE: '<<YOUR_SECRET>>'
-MNESTIX_BACKEND_API_KEY: '<<YOUR_API_KEY>>'
-NEXTAUTH_SECRET: '<<YOUR_SECRET>>'
+# This is an example .env for the project.
+# Copy this file to .env and fill in the values. This file is not tracked by git.
+# This will then be used for docker and next
+
+MNESTIX_BACKEND_API_KEY="<<YOUR_API_KEY>>"
+NEXTAUTH_SECRET=        "<<YOUR_SECRET>>"  # https://next-auth.js.org/configuration/options#nextauth_secret
+AD_SECRET_VALUE=        "<<YOUR_SECRET>>"  # Only needed if you use Azure AD authentication

.env.local

@@ -1,29 +1,35 @@
-APPLICATION_ID_URI: 'api://mnestix-test-web-api/'
-LOCK_TIMESERIES_PERIOD_FEATURE_FLAG: true
-COMPARISON_FEATURE_FLAG: true
-AAS_LIST_FEATURE_FLAG: true
-TRANSFER_FEATURE_FLAG: false
-AAS_REPO_API_URL: 'http://localhost:5064/repo'
-SUBMODEL_REPO_API_URL: 'http://localhost:5064/repo'
-MNESTIX_BACKEND_API_URL: 'http://localhost:5064'
-DISCOVERY_API_URL: 'http://localhost:5064/discovery'
-REGISTRY_API_URL: 'http://localhost:8083'
-SUBMODEL_REGISTRY_API_URL: 'http://localhost:8084'
-THEME_LOGO_MIME_TYPE: 'image/svg+xml'
-THEME_PRIMARY_COLOR: '#005962'
-THEME_SECONDARY_COLOR: '#147f8a'
-THEME_LOGO_URL: 
+# This file is used to set the default environment variables for the Mnestix.
+# We use .env.local to have this setup for next start and next dev and don't interfere with docker-compose
+# To set your local envs please use .env.development.local and .env.production.local (maybe hard-link them)
 
-AUTHENTICATION_FEATURE_FLAG: false
-AD_CLIENT_ID: 'c8fa36e4-a260-40b2-9298-8279bbd872e8'
-AD_TENANT_ID: '6c4ccecf-2dd4-4241-b7fc-6e95b32dcfac'
+LOCK_TIMESERIES_PERIOD_FEATURE_FLAG="true"
+COMPARISON_FEATURE_FLAG=            "true"
+AAS_LIST_FEATURE_FLAG=              "true"
+TRANSFER_FEATURE_FLAG=              "false"
+BASYX_RBAC_ENABLED=                 "false"
+WHITELIST_FEATURE_FLAG=             "false"
+PRODUCT_VIEW_FEATURE_FLAG=          "false"
 
-KEYCLOAK_ENABLED: false
-KEYCLOAK_CLIENT_ID: "mnestix-browser-client-demo"
-KEYCLOAK_LOCAL_URL: ""
-KEYCLOAK_REALM: "BaSyx"
-KEYCLOAK_ISSUER: "http://localhost:8080"
-NEXTAUTH_URL: http://localhost:3000
+AAS_REPO_API_URL=                   "http://localhost:5064/repo"
+SUBMODEL_REPO_API_URL=              "http://localhost:5064/repo"
+CONCEPT_DESCRIPTION_REPO_API_URL=   "http://localhost:5064/repo"
+MNESTIX_BACKEND_API_URL=            "http://localhost:5064"
+DISCOVERY_API_URL=                  "http://localhost:5064/discovery"
+REGISTRY_API_URL=                   "http://localhost:8083"
+SUBMODEL_REGISTRY_API_URL=          "http://localhost:8084"
 
-IMPRINT_URL: 
-DATA_PRIVACY_URL: 
+AUTHENTICATION_FEATURE_FLAG=    "false"
+AD_CLIENT_ID=                   "c8fa36e4-a260-40b2-9298-8279bbd872e8"
+AD_TENANT_ID=                   "6c4ccecf-2dd4-4241-b7fc-6e95b32dcfac"
+APPLICATION_ID_URI=             "api://mnestix-test-web-api/"
+
+KEYCLOAK_ENABLED=          "false"
+KEYCLOAK_CLIENT_ID=        "mnestix-browser-client-demo"
+KEYCLOAK_LOCAL_URL=        ""
+KEYCLOAK_REALM=            "Mnestix"
+KEYCLOAK_ISSUER=           "http://localhost:8080"
+NEXTAUTH_URL=              "http://localhost:3000"
+BASYX_RBAC_SEC_SM_API_URL= "http://localhost:8089"
+
+IMPRINT_URL=        ""
+DATA_PRIVACY_URL=   "" 

.eslintignore

@@ -1 +1 @@
-* @GailMelanie @hofermo @JonathanXITASO @pawel-baran-se @XAlinaGS @Xmilofranke @NilsXitaso
+* @GailMelanie @hofermo @JonathanXITASO @pawel-baran-se @XAlinaGS @NilsXitaso @milofranke @sirchnik-xitaso

.eslintrc.js

@@ -0,0 +1,74 @@
+# Mnestix Project Coding Instructions
+
+## Project Structure
+- Frontend is built with Next.js 14+, using the App Router
+- Translations are in src/locale/[lang].json files 
+- We are using next-intl for internationalization
+- Components are in src/components
+- Page components are in src/app/[locale]/...
+
+## Code Style
+- We use TypeScript for all new code
+- We prefer functional components with hooks over class components
+- We use absolute imports instead of relative imports
+- We prefer normal functions over arrow functions for better readability
+- We use Material-UI (MUI) for our UI components
+- We use single quotes
+- Follow eslint.config.js guidelines
+
+## State Management
+- We use React Context for global state where needed
+- We prefer local component state when possible
+
+## API Integration
+- RESTful API communication is handled via fetch
+- Backend API integrations should include proper error handling
+- All frontend-backend communication is wrapped in `apiResponseWrapper.ts` to ensure correct typing
+- Primary call from frontend to backend should be a stateless async function in `Actions.ts` files in `src/lib/services` directory, marked with `use server;`
+
+## Documentation
+- Add JSDoc comments for exported functions and components
+- Include detailed PR descriptions with test coverage information
+- Documentation can be added in docs/ and wiki/
+
+## Testing
+We use three different testing principles in our project.
+### Unit tests
+- They are testing small parts of our logic, like single functions in the backend.
+- They are written with the jest testing framework
+- All communication to external services should be mocked using the nullability testing paradigm. That means services which perform logic operations should not be performing network calls themselves, but need to be injected the correct interface abstractions, which can be mocked by implementing a in-memory version. We use `create()` and `createNull()` as constructors to differentiate the mocked variation.
+- They should be placed in the same directory as the functionality itself and should follow the pattern [filename].test.tsx
+- They should be added or edited on bug fixes, logic related features and refactorings.
+### Component tests
+- They are testing the UI and basic functionality of single react components.
+- They are written with the jest testing framework.
+- Data should be provided in the tests and no network calls should be made.
+- They test, if the relevant information is shown in the correct way.
+- They test all different functionality of the component, e.g. clickable buttons, text inputs, navigation controls
+- We pay special attention to the state management of a component, e.g. if a component kept its state after closing  a dialog popup or if the data has been updated correctly after an update of some  parts of it
+- They should be added for all new or edited frontend components.
+### End-to-End tests (E2E tests)
+- we use cypress for E2E tests.
+- E2E tests are located in src/cypress/e2e and are called [testCase]Test.spec.tsx.
+- They are costly and should be used sparingly.
+- They are used for happypaths only, testing the most common usages and not all the edge cases.
+- They should guarantee the correct working of the application as a whole.
+- They will use network communication and a docker setup as defined in `docker-compose/compose.test.yml`
+- We will ask for creation separately, as they are fairly complex. Please hint, if a e2e test might be relevant in the current code.
+
+
+## Accessibility
+- Interactive elements must have appropriate ARIA attributes
+- Components should be keyboard navigable
+- Use semantic HTML elements
+- Meet WCAG 2.1 AA color contrast standards
+- Add alt text for images and aria-labels for SVGs
+- Form elements must have proper labels and error messages
+
+## Dependencies
+- Use yarn as package manager
+- Our project is open source
+
+## Versioning
+- Follow semantic commit messages pattern
+- Code is hosted on GitHub

.github/CODEOWNERS

@@ -0,0 +1,44 @@
+version: 2
+updates:
+  - package-ecosystem: npm
+    target-branch: dev
+    directory: '/'
+    schedule:
+      interval: weekly
+      day: monday
+      time: '07:00'
+      timezone: 'Europe/Berlin'
+    groups:
+      yarn-patch:
+        update-types: ['patch']
+      yarn-minor:
+        update-types: ['minor']
+      yarn-major:
+        update-types: ['major']
+  - package-ecosystem: 'docker'
+    target-branch: dev
+    directory: '/'
+    groups:
+      docker-all:
+        patterns:
+          - '*'
+    schedule:
+      interval: weekly
+  - package-ecosystem: docker-compose
+    target-branch: dev
+    directory: '/'
+    groups:
+      compose-all:
+        patterns:
+          - '*'
+    schedule:
+      interval: weekly
+  - package-ecosystem: github-actions
+    target-branch: dev
+    directory: '/'
+    groups:
+      actions-all:
+        patterns:
+          - '*'
+    schedule:
+      interval: weekly

.github/copilot-instructions.md

@@ -15,7 +15,7 @@ env:
   # github.repository as <account>/<repo>
   IMAGE_NAME: mnestix-browser
   # Update the version manually
-  IMAGE_TAG_VERSION: 1.4.2
+  IMAGE_TAG_VERSION: 1.5.0
 
 jobs:
   build-browser-image:
@@ -37,6 +37,7 @@ jobs:
         with:
           platforms: linux/amd64
           context: '.'
+          cache-from: mnestix/mnestix-browser:dev
           cache-to: type=local,dest=/tmp/buildx-amd64-cache,mode=max
           target: production
           push: false
@@ -89,6 +90,11 @@ jobs:
       - name: Pull images
         run: docker compose -f compose.yml -f docker-compose/compose.test.yml --profile tests pull
 
+      # Remove old image to avoid conflicts, before sometimes the old image wasn't loaded
+      # If this step fails please check docker-compose/compose.test.yml if tag is still correct
+      - name: Remove Docker image mnestix/mnestix-browser:latest, to avoid conflicts
+        run: docker rmi mnestix/mnestix-browser:latest
+
       # overwrite the pulled image with the new image
       - name: Load mnestix-browser image
         run: docker load -i mnestix-browser.tar
@@ -114,8 +120,8 @@ jobs:
           name: cypress-artifacts-${{ matrix.containers }}
           path: cypress-artifacts/
 
-  unit-tests:
-    name: Unit Tests
+  unit-test:
+    name: Unit Test
     runs-on: ubuntu-latest
     permissions:
       contents: read
@@ -124,15 +130,37 @@ jobs:
       - name: Checkout repository
         uses: actions/checkout@v4
       - name: Install dependencies
-        run: yarn install
+        run: yarn install --frozen-lockfile
+
       - name: Run unit tests
         run: npx jest
 
+  lint:
+    name: Lint and Typecheck
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+      - name: Install dependencies
+        run: yarn install --frozen-lockfile
+
+      - name: Typescript check
+        run: yarn typecheck
+      - name: Typescript e2e check
+        run: yarn typecheck:e2e
+      - name: Linting check
+        run: yarn lint
+
   # Target for PR Merge Check
   ci-success:
     name: Successful build and tests
     runs-on: ubuntu-latest
-    needs: ['unit-tests', 'e2e-tests']
+    needs: ['lint', 'unit-test', 'e2e-tests']
+    permissions:
+      contents: read
     steps:
       - name: Success
         run: echo "Success"

.github/dependabot.yml

@@ -1,7 +1,7 @@
 name: Publish wiki
 on:
   push:
-    branches: [ main ]
+    branches: [main]
     paths:
       - wiki/**
       - .github/workflows/publish-wiki.yml
@@ -14,5 +14,5 @@ jobs:
   publish-wiki:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
-      - uses: Andrew-Chen-Wang/github-wiki-action@v4
+      - uses: actions/checkout@v4
+      - uses: Andrew-Chen-Wang/github-wiki-action@50650fccf3a10f741995523cf9708c53cec8912a # pinned version CWE-829

.github/workflows/docker-build.yml

@@ -1,12 +1,18 @@
-# ...
-.next
-next-env.d.ts
-dist
-node_modules
-cypress-artifacts
-/.idea/.idea.mnestix-frontend.dir/.idea/
-.env
+/next-env.d.ts
+/dist
+/node_modules
+/tsconfig.tsbuildinfo
+/.next
+
 /cypress/videos/
 /cypress/screenshots/
-/prisma/mnestix-database.db
 /cypress/results/*
+
+/prisma/database/
+
+/.idea/.idea.mnestix-frontend.dir/.idea/
+
+/.env
+!.env.local
+/.env*.local
+/cypress-artifacts