v3.0.0-next.0

refactor: add changesets
refactor: chose packages to publish

.c8rc.json

@@ -0,0 +1,5 @@
+{
+  "all": true,
+  "src": "./src",
+  "reporter": ["text", "text-summary", "cobertura"]
+}

.changeset/README.md

@@ -0,0 +1,8 @@
+# Changesets
+
+Hello and welcome! This folder has been automatically generated by `@changesets/cli`, a build tool that works
+with multi-package repos, or single-package repos to help you version and publish your code. You can
+find the full documentation for it [in our repository](https://github.com/changesets/changesets)
+
+We have a quick list of common questions to get you started engaging with this project in
+[our documentation](https://github.com/changesets/changesets/blob/main/docs/common-questions.md)

.changeset/config.json

@@ -0,0 +1,11 @@
+{
+  "$schema": "https://unpkg.com/@changesets/config@2.3.0/schema.json",
+  "changelog": "@changesets/changelog-git",
+  "commit": false,
+  "fixed": [],
+  "linked": [["@openstapps/*"]],
+  "access": "restricted",
+  "baseBranch": "master",
+  "updateInternalDependencies": "patch",
+  "ignore": []
+}

.changeset/cool-jars-kiss.md

@@ -0,0 +1,8 @@
+---
+'@openstapps/core-tools': major
+---
+
+Removed pack tool
+
+Use a bundler like `tsup` in conjunction with an
+`index.ts` that aggregates all exports instead.

.changeset/cuddly-bobcats-roll.md

@@ -0,0 +1,11 @@
+---
+'@openstapps/api-plugin': major
+'@openstapps/api-cli': major
+'@openstapps/api': major
+---
+
+Split API into API, API-CLI and API-Plugin
+
+Plugins are now required to use `api-plugin`.
+Consumers of `api` can benefit from a slimmer package with
+no NodeJS dependencies.

.changeset/dull-news-appear.md

@@ -0,0 +1,31 @@
+---
+'@openstapps/backend': major
+---
+
+Migrate config system to cosmiconfig
+
+Configs are now written using type-checked JavaScript
+
+```js
+// @ts-check
+
+// This file is now type-safe just like TypeScript, but
+// without the compilation step
+
+/** @type {import('@openstapps/package').Type} */
+const foo = {};
+```
+
+You can write config files in JavaScript, JSON, or other
+cosmiconfig-supported formats.
+
+The config files now are
+
+- `backendrc.{js,json,...}`
+- `elasticsearchrc.{js,json,...}`
+- `prometheusrc.{js,json,...}`
+
+You can also split them into multiple files,
+as well as using the `markdown.js` helper in
+`config/default/tools` to include markdown files
+as text (see `config/f-u/about-pages`)

.changeset/five-ears-wash.md

@@ -0,0 +1,51 @@
+---
+'@openstapps/projectmanagement': major
+'@openstapps/prettier-config': major
+'@openstapps/es-mapping-generator': major
+'@openstapps/backend-config': major
+'@openstapps/eslint-config': major
+'@openstapps/minimal-connector': major
+'@openstapps/collection-utils': major
+'@openstapps/minimal-plugin': major
+'@openstapps/tsconfig': major
+'@openstapps/api-plugin': major
+'@openstapps/core-tools': major
+'@openstapps/gitlab-api': major
+'@openstapps/easy-ast': major
+'@openstapps/api-cli': major
+'@openstapps/backend': major
+'@openstapps/logger': major
+'@openstapps/proxy': major
+'@openstapps/core': major
+'@openstapps/app': major
+'@openstapps/api': major
+---
+
+Move project to a turbo monorepo & pnpm
+
+Internal dependencies are now defined using `"@openstapps/package": "workspace:*"`
+
+- Removed extraneous files from packages
+  - `.npmrc`
+  - `.npmignore`
+  - `.mailmap`
+  - `.gitignore`
+  - `CONTRIBUTING.md`
+  - `LICENSE` (Project license file is added upon publishing, see [pnpm.io](https://pnpm.io/cli/publish))
+  - `package-lock.json`
+  - `.editorconfig`
+  - `.eslintrc.json` (moved eslint config to `package.json`)
+  - `.eslintignore`
+  - `.gitlab-ci.yml` (Most workflows are workspace-level)
+  - `.gitlab/**` (issue templates etc. are now workspace-level)
+  - `.dockerignore` (Docker files are determined by which files are deployed with `pnpm deploy`, as per `package.json/files`)
+- TSConfig has been moved to its own package (You can now use `"extends": "@openstapps/tsconfig"`)
+- Removed ESLint and Prettier peer dependency hell by injecting them through the `.pnpmfile.cjs`
+- Added syncpack for keeping dependency versions in sync (and consistent key ordering in `package.json`)
+- Replaced conventional changelog with changesets
+- Apps with binaries now use a top level `app.js`
+
+```js
+#!/usr/bin/env node
+import './lib/app.js';
+```

.changeset/fuzzy-walls-greet.md

@@ -0,0 +1,13 @@
+---
+'@openstapps/core': major
+---
+
+Migrate away from [ts-optchain](https://www.npmjs.com/package/ts-optchain)
+
+The package has been deprecated with the last releast being 4 years ago.
+
+TypeScript as well as ECMAScript have native support for optional
+chaining with the `?.` operator now.
+
+You will need to update any packages that rely on the translator
+module.

.changeset/giant-crabs-cheer.md

@@ -0,0 +1,25 @@
+---
+'@openstapps/projectmanagement': patch
+'@openstapps/prettier-config': patch
+'@openstapps/es-mapping-generator': patch
+'@openstapps/eslint-config': patch
+'@openstapps/minimal-connector': patch
+'@openstapps/minimal-plugin': patch
+'@openstapps/core-tools': patch
+'@openstapps/gitlab-api': patch
+'@openstapps/backend': patch
+'@openstapps/logger': patch
+'@openstapps/proxy': patch
+'@openstapps/core': patch
+'@openstapps/api': patch
+---
+
+Migrated changelogs to changeset format
+
+```js
+import fs from 'fs';
+
+const path = 'packages/logger/CHANGELOG.md';
+
+fs.writeFileSync(path, fs.readFileSync(path, 'utf8').replace(/^#+\s+\[/gm, '## ['));
+```

.changeset/gorgeous-flowers-reflect.md

@@ -0,0 +1,8 @@
+---
+'@openstapps/backend': minor
+'@openstapps/api-cli': major
+---
+
+Migrate integration tests from docker-compose solution to a shell script
+
+`api-cli` no longer builds as a Docker container as a result.

.changeset/healthy-steaks-shop.md

@@ -0,0 +1,34 @@
+---
+'@openstapps/projectmanagement': major
+'@openstapps/prettier-config': major
+'@openstapps/es-mapping-generator': major
+'@openstapps/backend-config': major
+'@openstapps/eslint-config': major
+'@openstapps/minimal-connector': major
+'@openstapps/collection-utils': major
+'@openstapps/minimal-plugin': major
+'@openstapps/tsconfig': major
+'@openstapps/api-plugin': major
+'@openstapps/core-tools': major
+'@openstapps/gitlab-api': major
+'@openstapps/easy-ast': major
+'@openstapps/api-cli': major
+'@openstapps/backend': major
+'@openstapps/logger': major
+'@openstapps/proxy': major
+'@openstapps/core': major
+'@openstapps/app': major
+'@openstapps/api': major
+---
+
+Migrate to ESM
+
+CommonJS is no longer supported in any capacity. To use the new
+version, you will need to migrate your package to ESM.
+We recommend using `tsup` and `Node 18`.
+
+```json
+{
+  "type": "module"
+}
+```

.changeset/honest-sheep-train.md

@@ -0,0 +1,30 @@
+---
+'@openstapps/projectmanagement': major
+'@openstapps/prettier-config': major
+'@openstapps/es-mapping-generator': major
+'@openstapps/backend-config': major
+'@openstapps/eslint-config': major
+'@openstapps/minimal-connector': major
+'@openstapps/collection-utils': major
+'@openstapps/minimal-plugin': major
+'@openstapps/tsconfig': major
+'@openstapps/api-plugin': major
+'@openstapps/core-tools': major
+'@openstapps/gitlab-api': major
+'@openstapps/easy-ast': major
+'@openstapps/api-cli': major
+'@openstapps/backend': major
+'@openstapps/logger': major
+'@openstapps/proxy': major
+'@openstapps/core': major
+'@openstapps/app': major
+'@openstapps/api': major
+---
+
+Migrate package to Node 18
+
+- Consumers of this package will need to migrate to Node 18 or
+  higher.
+- Packages have been migrated from promisified `readFile` or
+  `readFileSync` towards `fs/promises`
+- Packages use native `flatMap` now

.changeset/late-zoos-breathe.md

@@ -0,0 +1,5 @@
+---
+'@openstapps/gitlab-api': minor
+---
+
+Migrate from request-promise-native to got

.changeset/moody-parrots-develop.md

@@ -0,0 +1,5 @@
+---
+'@openstapps/projectmanagement': patch
+---
+
+Moved project-docs to the [GitLab Wiki](https://gitlab.com/openstapps/openstapps/-/wikis/home) repo.

.changeset/neat-hats-trade.md

@@ -0,0 +1,31 @@
+---
+'@openstapps/projectmanagement': minor
+'@openstapps/prettier-config': minor
+'@openstapps/es-mapping-generator': minor
+'@openstapps/backend-config': minor
+'@openstapps/eslint-config': minor
+'@openstapps/minimal-connector': minor
+'@openstapps/collection-utils': minor
+'@openstapps/minimal-plugin': minor
+'@openstapps/tsconfig': minor
+'@openstapps/api-plugin': minor
+'@openstapps/core-tools': minor
+'@openstapps/gitlab-api': minor
+'@openstapps/easy-ast': minor
+'@openstapps/api-cli': minor
+'@openstapps/backend': minor
+'@openstapps/logger': minor
+'@openstapps/proxy': minor
+'@openstapps/core': minor
+'@openstapps/app': minor
+'@openstapps/api': minor
+---
+
+Migrate tests to C8/Chai/Mocha
+
+- `@testdeck` OOP testing has been removed.
+- Tests have been unified
+- CommonJS module mocking has been replaced through
+  refactoring of tests, as ES Modules cannot be mocked
+  (do yourself a favor and don't try to mock them)
+- C8 now replaces NYC as a native coverage tool

.changeset/new-pianos-joke.md

@@ -0,0 +1,5 @@
+---
+'@openstapps/es-mapping-generator': patch
+---
+
+Remove @openstapps/logger dependency

.changeset/pre.json

@@ -0,0 +1,59 @@
+{
+  "mode": "pre",
+  "tag": "next",
+  "initialVersions": {
+    "@openstapps/backend": "2.0.0",
+    "@openstapps/database": "2.0.0",
+    "@openstapps/proxy": "2.0.0",
+    "@openstapps/backend-config": "2.0.0",
+    "@openstapps/eslint-config": "2.0.0",
+    "@openstapps/prettier-config": "2.0.0",
+    "@openstapps/projectmanagement": "2.0.0",
+    "@openstapps/tsconfig": "2.0.0",
+    "@openstapps/minimal-connector": "2.0.0",
+    "@openstapps/minimal-deployment": "2.0.0",
+    "@openstapps/minimal-plugin": "2.0.0",
+    "@openstapps/app": "2.0.0",
+    "@openstapps/app-release-template": "2.0.0",
+    "@openstapps/api": "2.0.0",
+    "@openstapps/api-cli": "2.0.0",
+    "@openstapps/api-plugin": "2.0.0",
+    "@openstapps/collection-utils": "2.0.0",
+    "@openstapps/core": "2.0.0",
+    "@openstapps/core-tools": "2.0.0",
+    "@openstapps/easy-ast": "2.0.0",
+    "@openstapps/es-mapping-generator": "2.0.0",
+    "@openstapps/gitlab-api": "2.0.0",
+    "@openstapps/logger": "2.0.0"
+  },
+  "changesets": [
+    "cool-jars-kiss",
+    "cuddly-bobcats-roll",
+    "dull-news-appear",
+    "five-ears-wash",
+    "fuzzy-walls-greet",
+    "giant-crabs-cheer",
+    "gorgeous-flowers-reflect",
+    "healthy-steaks-shop",
+    "honest-sheep-train",
+    "late-zoos-breathe",
+    "moody-parrots-develop",
+    "neat-hats-trade",
+    "new-pianos-joke",
+    "proud-wolves-end",
+    "quick-houses-count",
+    "rare-squids-bake",
+    "soft-donuts-fail",
+    "sour-coins-visit",
+    "spicy-snails-sort",
+    "stale-garlics-share",
+    "strange-hounds-repair",
+    "tall-ducks-dream",
+    "tame-mayflies-hug",
+    "tame-rings-dream",
+    "thick-weeks-compete",
+    "thin-camels-give",
+    "tidy-buses-reflect",
+    "tough-hairs-provide"
+  ]
+}

.changeset/proud-wolves-end.md

@@ -0,0 +1,9 @@
+---
+'@openstapps/eslint-config': minor
+---
+
+Update rules
+
+- `unicorn/no-array-reduce` is now off
+- `unicorn/no-non-null-assertion` is now off
+- Removed prettier rules (use prettier formatting instead)

.changeset/quick-houses-count.md

@@ -0,0 +1,7 @@
+---
+'@openstapps/es-mapping-generator': major
+---
+
+Remove put-es-templates
+
+The `put-es-templates` functionality has been removed.

.changeset/rare-squids-bake.md

@@ -0,0 +1,24 @@
+---
+'@openstapps/projectmanagement': patch
+'@openstapps/prettier-config': patch
+'@openstapps/es-mapping-generator': patch
+'@openstapps/backend-config': patch
+'@openstapps/eslint-config': patch
+'@openstapps/minimal-connector': patch
+'@openstapps/collection-utils': patch
+'@openstapps/minimal-plugin': patch
+'@openstapps/tsconfig': patch
+'@openstapps/api-plugin': patch
+'@openstapps/core-tools': patch
+'@openstapps/gitlab-api': patch
+'@openstapps/easy-ast': patch
+'@openstapps/api-cli': patch
+'@openstapps/backend': patch
+'@openstapps/logger': patch
+'@openstapps/proxy': patch
+'@openstapps/core': patch
+'@openstapps/app': patch
+'@openstapps/api': patch
+---
+
+Migrate away from @openstapps/configuration

.changeset/soft-donuts-fail.md

@@ -0,0 +1,7 @@
+---
+'@openstapps/api': minor
+---
+
+Migrate HttpClient to Node 18's native `fetch` API
+
+HttpClient can now be used both in NodeJS and browsers.

.changeset/sour-coins-visit.md

@@ -0,0 +1,7 @@
+---
+'@openstapps/es-mapping-generator': major
+'@openstapps/backend': major
+'@openstapps/core': major
+---
+
+Migrate es mapping types from es-mapping-generator to .d.ts next to generated mappings

.changeset/spicy-snails-sort.md

@@ -0,0 +1,5 @@
+---
+'@openstapps/eslint-config': patch
+---
+
+Add license header enforcement rule (unfinished)

.changeset/stale-garlics-share.md

@@ -0,0 +1,5 @@
+---
+'@openstapps/core': minor
+---
+
+Include openapi.json in built package

.changeset/strange-hounds-repair.md

@@ -0,0 +1,26 @@
+---
+'@openstapps/projectmanagement': minor
+'@openstapps/minimal-connector': minor
+'@openstapps/minimal-plugin': minor
+'@openstapps/collection-utils': minor
+'@openstapps/core-tools': minor
+'@openstapps/gitlab-api': minor
+'@openstapps/backend': minor
+'@openstapps/logger': minor
+'@openstapps/core': minor
+'@openstapps/api': minor
+---
+
+Migrate away from `@krlwlfrt/async-pool`
+
+```ts
+import {mapAsyncLimit} from '@openstapps/collection-utils';
+
+await mapAsyncLimit(
+  [1, 2, 3],
+  async it => {
+    await someNetworkRequest(it);
+  },
+  5,
+);
+```

.changeset/tall-ducks-dream.md

@@ -0,0 +1,5 @@
+---
+'@openstapps/app': minor
+---
+
+Migrate away from JIT compilation

.changeset/tame-mayflies-hug.md

@@ -0,0 +1,5 @@
+---
+'@openstapps/logger': patch
+---
+
+Fix an issue with chalk terminal colors in tests

.changeset/tame-rings-dream.md

@@ -0,0 +1,9 @@
+---
+'@openstapps/core-tools': major
+---
+
+Migrate openapi generation to output single file
+
+The OpenAPI generator now outputs a single file instead
+of a directory with the `openapi.json` and copied schema
+files.

.changeset/thick-weeks-compete.md

@@ -0,0 +1,5 @@
+---
+'@openstapps/projectmanagement': minor
+---
+
+Migrate moment.js to date-fns

.changeset/thin-camels-give.md

@@ -0,0 +1,23 @@
+---
+'@openstapps/projectmanagement': major
+'@openstapps/es-mapping-generator': major
+'@openstapps/minimal-connector': major
+'@openstapps/collection-utils': major
+'@openstapps/minimal-plugin': major
+'@openstapps/api-plugin': major
+'@openstapps/core-tools': major
+'@openstapps/gitlab-api': major
+'@openstapps/easy-ast': major
+'@openstapps/api-cli': major
+'@openstapps/backend': major
+'@openstapps/logger': major
+'@openstapps/proxy': major
+'@openstapps/core': major
+'@openstapps/api': major
+---
+
+Migrate build system to `tsup`
+
+All packages now use an `index.ts` file to expose contents.
+
+You will need to migrate paths from `import foo from '@scope/package/lib/foo` to `import foo from '@scope/package'`

.changeset/tidy-buses-reflect.md

@@ -0,0 +1,9 @@
+---
+'@openstapps/core-tools': major
+'@openstapps/easy-ast': major
+---
+
+Migrate easy-ast to separate package
+
+The `easy-ast` part of `core-tools` has been moved to its own package.
+For migration, simply use the new package.

.changeset/tough-hairs-provide.md

@@ -0,0 +1,5 @@
+---
+'@openstapps/core-tools': patch
+---
+
+Migrate from away from lodash

.gitattributes

@@ -0,0 +1,17 @@
+# Auto detect text files and perform LF normalization
+* text=auto
+
+# Custom for Visual Studio
+*.cs     diff=csharp
+
+# Standard to msysgit
+*.doc	 diff=astextplain
+*.DOC	 diff=astextplain
+*.docx diff=astextplain
+*.DOCX diff=astextplain
+*.dot  diff=astextplain
+*.DOT  diff=astextplain
+*.pdf  diff=astextplain
+*.PDF	 diff=astextplain
+*.rtf	 diff=astextplain
+*.RTF	 diff=astextplain

.gitignore

@@ -10,9 +10,15 @@ pids
 *.pid
 *.seed
 *.pid.lock
+.DS_Store
 
-# Schema generation data
-Diagram-*.svg
+.angular/
+www/
+
+.docs.json
+coverage.xml
+report-junit.xml
+.deploy/
 
 # Directory for instrumented libs generated by jscoverage/JSCover
 lib-cov
@@ -37,6 +43,7 @@ build/Release
 
 # Dependency directories
 node_modules/
+.pnpm-store/
 jspm_packages/
 
 # TypeScript v1 declaration files
@@ -58,7 +65,7 @@ typings/
 .yarn-integrity
 
 # dotenv environment variables file
-.env
+.env.local
 
 # parcel-bundler cache (https://parceljs.org/)
 .cache
@@ -87,11 +94,14 @@ typings/
 .idea
 .vscode
 
-# ignore lib directory
-lib/
+# ignore lib
+lib
 
-# ignore docs directory
-docs/
+# ignore docs
+docs
 
-# ignore openapi resources
-openapi/
+# report directory
+report
+
+# turbo cache
+.turbo/

.gitlab-ci.yml

@@ -1,71 +1,128 @@
-image: registry.gitlab.com/openstapps/projectmanagement/node
+# `rules: if $CI_PIPELINE_SOURCE == 'merge_request_event'` seems to convert the whole
+# workflow into a merge request pipeline, effectively removing all the jobs.
+# To work around that, add:
+# ```
+# rules:
+#   when: on_success
+# ```
+# To your pipeline.
+# https://docs.gitlab.com/ee/ci/pipelines/merge_request_pipelines.html#use-rules-to-add-jobs
+include:
+  - local: /backend/backend/.gitlab-ci.yml
+  - local: /frontend/app/.gitlab-ci.yml
+  - local: /.gitlab/publishing.gitlab-ci.yml
+    rules:
+      - if: $CI_PIPELINE_SOURCE == "merge_request_event"
+        when: never
 
-cache:
-  key: ${CI_COMMIT_REF_SLUG}
-  paths:
-    - node_modules
+variables:
+  TURBO_CACHE_BYPASS:
+    value: ''
+    options:
+      - '--force'
+      - '--no-cache'
+      - ''
+    description: Bypass turbo cache
 
-before_script:
-  - npm install
+default:
+  image: registry.gitlab.com/openstapps/projectmanagement/builder:v18
+  tags:
+    - performance
+  interruptible: true
+  before_script:
+    - corepack enable
+    - corepack prepare pnpm@latest-8 --activate
+    - echo TURBO_API=$TURBO_API >> .env.local
+    - echo TURBO_TOKEN=$TURBO_TOKEN >> .env.local
+    - echo TURBO_TEAM=$TURBO_TEAM >> .env.local
+    - pnpm config set store-dir .pnpm-store
+  cache: &pnpm_cache
+    key:
+      files:
+          - pnpm-lock.yaml
+    paths:
+      - .pnpm-store/
+    policy: pull
 
 stages:
   - build
   - test
   - audit
-  - deploy
+  - publish
 
 build:
   stage: build
   script:
-    - npm run build
-  artifacts:
-    paths:
-      - lib
+    # - pnpm config set recursive-install false
+    # - pnpm i --prefer-offline
+    # - pnpm build:full:skip || pnpm i -r --prefer-offline
+    - pnpm install
+    # TODO: something doesn't work with git here...
+    # "🦋  error Error: Failed to find where HEAD diverged from master. Does master exist?"
+    # - pnpm changeset:status
+    - pnpm build:full $TURBO_CACHE_BYPASS
+    # pretty sure this is deprecated?
+    # TODO: - .gitlab/ci/enableGitlabReviewToolbar.sh www/index.html "$CI_PROJECT_ID" "$CI_OPEN_MERGE_REQUESTS"
+    - cp frontend/app/www/index.html frontend/app/www/200.html
+    - pnpm dlx surge -p frontend/app/www -d https://$CI_PROJECT_NAME-$DEPLOY_ID.surge.sh/
+  cache:
+    <<: *pnpm_cache
+    policy: pull-push
+  environment:
+    name: review/$DEPLOY_ID
+    url: https://$CI_PROJECT_NAME-$DEPLOY_ID.surge.sh/
+    on_stop: stop review
+  rules: &deploy-rules
+    - if: $CI_PIPELINE_SOURCE == 'merge_request_event'
+      variables:
+        DEPLOY_ID: $CI_MERGE_REQUEST_SOURCE_BRANCH_NAME
+    - if: $CI_COMMIT_BRANCH == 'main'
+      variables:
+        DEPLOY_ID: production
+    - if: $CI_COMMIT_BRANCH == 'develop'
+      variables:
+        DEPLOY_ID: staging
 
-test:
-  tags:
-    - docker
-  stage: test
+stop review:
+  stage: build
+  needs: ['build']
   script:
-    - npm test
+    - pnpm dlx surge teardown $CI_PROJECT_NAME-$DEPLOY_ID.surge.sh
+  environment:
+    name: review/$DEPLOY_ID
+    action: stop
+  when: manual
+  rules: *deploy-rules
+
+unit:
+  stage: test
+  needs: ['build']
+  script:
+    # - pnpm config set recursive-install false
+    # - pnpm i --prefer-offline
+    # - pnpm test:skip || pnpm i -r --prefer-offline
+    - pnpm install
+    - pnpm test $TURBO_CACHE_BYPASS
+  coverage: '/Statements[^:]*\:[^:]*\s+([\d\.]+)%/'
+  artifacts:
+    when: always
+    paths:
+      - report-junit.xml
+      - coverage.xml
+    reports:
+      junit:
+        - report-junit.xml
+      coverage_report:
+        coverage_format: cobertura
+        path: coverage.xml
+  rules:
+    - when: on_success
 
 audit:
   stage: audit
+  needs: []
   script:
-    - npm audit
-  allow_failure: true
-  except:
-    - schedules
-
-scheduled-audit:
-  stage: audit
-  script:
-    - npm audit --audit-level=high
-  only:
-    - schedules
-
-package:
-  dependencies:
-    - build
-  tags:
-    - secrecy
-  stage: deploy
-  script:
-    - echo "//registry.npmjs.org/:_authToken=$NPM_AUTH_TOKEN" > ~/.npmrc
-    - npm publish
-  only:
-    - /^v[0-9]+.[0-9]+.[0-9]+$/
-  artifacts:
-    paths:
-      - lib
-
-pages:
-  stage: deploy
-  script:
-    - npm run documentation
-    - mv docs public
-  only:
-    - /^v[0-9]+\.[0-9]+\.[0-9]+$/
-  artifacts:
-    paths:
-      - public
+    - pnpm audit --prod
+  rules:
+    - when: on_success
+      allow_failure: true

.gitlab/ci/enableGitlabReviewToolbar.sh

@@ -0,0 +1,15 @@
+#!/usr/bin/env sh
+
+# Adds a preedefined script tag including the merge current request id to the angular web app index.html.
+# This enables the interactive gitlab review toolbar.
+
+MERGE_REQUEST_ID=""
+if echo -n $3 | grep -Eq '[0-9]+$'; then
+  MERGE_REQUEST_ID="$(echo -n "$3" | grep -Eo '[0-9]+$')"
+fi
+
+INDEX_PATH=$(dirname $1)
+SCRIPT_TAG="<script defer data-project-id=\"$2\" data-project-path=\"openstapps/app\" data-merge-request-id=\"$MERGE_REQUEST_ID\" data-mr-url=\"https://gitlab.com\" id=\"review-app-toolbar-script\" src=\"visual_review_toolbar.js\"></script>"
+
+curl https://gitlab.com/assets/webpack/visual_review_toolbar.js --output  "$INDEX_PATH/visual_review_toolbar.js" --silent
+sed -i -e "\@</head>@i\\$SCRIPT_TAG" $1

.gitlab/ci/getRegistryBranch.sh

@@ -0,0 +1,4 @@
+#!/usr/bin/env sh
+
+# script returns string with everything after the last colon of $1 input
+echo -n $1 | grep -oE '[^:]+$'

.gitlab/ci/getRegistryTag.sh

@@ -0,0 +1,8 @@
+#!/usr/bin/env sh
+
+# script returns semantical versioning string like 2.0.0 (if $1 is v2.0.0) or $1
+if echo -n $1 | grep -Eq 'v[0-9]+\.[0-9]+\.[0-9]+'; then
+  echo $(echo -n "$1" | cut -c 2-);
+else
+  echo $1;
+fi

.gitlab/ci/install-for-turbo.sh

@@ -0,0 +1,6 @@
+#!/usr/bin/env sh
+
+if pnpm dlx turbo-ignore "$@"
+then
+  pnpm config --location=project set recursive-install false
+fi

.gitlab/ci/pushAsLatestVersion.sh

@@ -0,0 +1,7 @@
+#!/usr/bin/env sh
+
+# If this is a pipeline of a version tag, also push this version 
+# as latest to the registry alias $2:latest
+if echo -n $1 | grep -Eq 'v[0-9]+\.[0-9]+\.[0-9]+'; then
+  docker push $2:latest;
+fi

.gitlab/ci/setup_turbo_env.sh

@@ -0,0 +1,5 @@
+#!/bin/bash
+
+echo TURBO_API=$TURBO_API >> .env.local
+echo TURBO_TOKEN=$TURBO_TOKEN >> .env.local
+echo TURBO_TEAM=$TURBO_TEAM >> .env.local

.gitlab/ci/testCIScripts.sh

@@ -0,0 +1,29 @@
+#!/usr/bin/env sh
+
+# test all CI scripts
+
+SCRIPT_DIR=$(dirname "$0")
+
+TAG_VERSION=$(sh $SCRIPT_DIR/getRegistryTag.sh "v1.0.0")
+TAG_TEST=$(sh $SCRIPT_DIR/getRegistryTag.sh "TEST")
+BRANCH_NAME=$(sh $SCRIPT_DIR/getRegistryBranch.sh "very:first:test")
+
+# Leaving out pushAsLatestVersion.sh as its control flow
+# is based on the same condition as getRegistryTag.sh
+
+if [ $TAG_VERSION != "1.0.0" ]; then
+	echo "ERROR in CI SCRIPT: $SCRIPT_DIR/getRegistryTag.sh"
+	return 1
+fi
+
+if [ $TAG_TEST != "TEST" ]; then
+	echo "ERROR in CI SCRIPT: $SCRIPT_DIR/getRegistryTag.sh"
+	return 2
+fi
+
+if [ $BRANCH_NAME != "test" ]; then
+	echo "ERROR in CI SCRIPT: $SCRIPT_DIR/getRegistryBranch.sh"
+	return 3
+fi
+
+return 0

.gitlab/issue_templates/bug.md

@@ -0,0 +1,32 @@
+## Summary
+
+(Summarize the bug encountered concisely)
+
+## Steps to reproduce
+
+(How one can reproduce the issue - this is very important)
+
+## Example Project
+
+(If possible, please create an example project here on GitLab.com that exhibits the problematic behaviour, and link to it here in the bug report)
+
+(If you are using an older version of GitLab, this will also determine whether the bug has been fixed in a more recent version)
+
+## What is the current bug behavior?
+
+(What actually happens)
+
+## What is the expected correct behavior?
+
+(What you should see instead)
+
+## Relevant logs and/or screenshots
+
+(Paste any relevant logs - please use code blocks (```) to format console output,
+logs, and code as it's very hard to read otherwise.)
+
+## Possible fixes
+
+(If you can, link to the line of code that might be responsible for the problem)
+
+/label ~bug ~meeting

.gitlab/issue_templates/feature.md

@@ -0,0 +1,17 @@
+## Description
+
+(Describe the feature that you're requesting concisely)
+
+## Explanation
+
+(Explain why the feature is necessary)
+
+## Mockups/Screenshots
+
+(If possible, provide mockups or screenshots, which demonstrate the feature)
+
+## Dependencies, issues to be resolved beforehand
+
+(List issues or dependencies that need to be resolved before this feature can be implemented)
+
+/label ~feature ~meeting

.gitlab/issue_templates/improvement.md

@@ -0,0 +1,17 @@
+## What needs to be changed?
+
+??? - Describe use case!
+
+## How is the current state not sufficient?
+
+???
+
+## Which changes are necessary?
+
+???
+
+## Do the proposed changes impact current use cases?
+
+???
+
+/label ~improvement ~meeting

.gitlab/publishing.gitlab-ci.yml

@@ -0,0 +1,70 @@
+deploy:
+  stage: publish
+  needs: ['build']
+  script:
+    - pnpm install
+    - pnpm run deploy
+  artifacts:
+    paths:
+      - ./.deploy
+  rules:
+    - if: $CI_PIPELINE_SOURCE == "merge_request_event"
+      when: manual
+    - if: $CI_COMMIT_TAG
+
+publish images:
+  stage: publish
+  inherit:
+    default:
+      - tags
+  needs: ['deploy']
+  image:
+    name: gcr.io/kaniko-project/executor:v1.9.0-debug
+    entrypoint: [""]
+  script:
+    - /kaniko/executor
+      --context "${CI_PROJECT_DIR}/${DEPLOY_DIR}"
+      --dockerfile "${CI_PROJECT_DIR}/${DEPLOY_DIR}/Dockerfile"
+      --destination "${CI_REGISTRY_IMAGE}/${IMAGE_NAME}:${DOCKER_TAG}"
+  rules:
+    - if: $CI_COMMIT_TAG
+      variables:
+        DOCKER_TAG: $CI_COMMIT_TAG
+    - if: $CI_PIPELINE_SOURCE == "merge_request_event"
+      variables:
+        DOCKER_TAG: $CI_MERGE_REQUEST_SOURCE_BRANCH_NAME
+  parallel:
+    matrix:
+      - DEPLOY_DIR: backend/database
+        IMAGE_NAME: database
+      - DEPLOY_DIR: .deploy/backend
+        IMAGE_NAME: backend
+      - DEPLOY_DIR: .deploy/proxy
+        IMAGE_NAME: proxy
+
+publish:
+  stage: publish
+  needs: ['deploy']
+  script:
+    - pnpm install --prefer-offline
+    - pnpm build
+    - pnpm changeset version $PUBLISH_TYPE
+    - pnpm changeset publish
+  rules:
+    - if: $CI_PIPELINE_SOURCE == "merge_request_event"
+      variables:
+        PUBLISH_TYPE: --snapshot $CI_MERGE_REQUEST_SOURCE_BRANCH_NAME
+
+pages:docs:
+  stage: publish
+  needs: ['deploy']
+  script:
+    - pnpm install --prefer-offline
+    - pnpm run docs
+    - mv docs public
+  artifacts:
+    paths:
+      - public
+  rules:
+    - if: $CI_COMMIT_TAG
+      when: on_success

.mailmap

@@ -0,0 +1,3 @@
+Rainer Killinger <mail-openstapps@killinger.co> Rainer Killinger <git@killinger.co>
+Rainer Killinger <mail-openstapps@killinger.co> Rainer Killinger <killinge@hrz.uni-frankfurt.de>
+Rainer Killinger <mail-openstapps@killinger.co> Rainer Killinger <killinger@hrz.uni-frankfurt.de>

.mocharc.json

@@ -0,0 +1,7 @@
+{
+  "extension": ["ts"],
+  "node-option": ["loader=ts-node/esm"],
+  "reporter": "mocha-junit-reporter",
+  "reporter-option": ["mochaFile=coverage/report-junit.xml"],
+  "spec": ["test/**/*.spec.ts"]
+}

.npmrc

@@ -0,0 +1,2 @@
+auto-install-peers=true
+package-import-method=hardlink

.pnpmfile.cjs

@@ -0,0 +1,23 @@
+const path = require("path");
+// const merge = require("deepmerge");
+
+const additionalDeps = {
+  '@openstapps/eslint-config': require('./configuration/eslint-config/package.json'),
+  '@openstapps/prettier-config': require('./configuration/prettier-config/package.json'),
+}
+
+function readPackage(pkg, context) {
+  for (const dep in additionalDeps) {
+    if (dep in pkg.devDependencies) {
+      Object.assign(pkg.devDependencies, additionalDeps[dep].peerDependencies)
+    }
+  }
+
+  return pkg
+}
+
+module.exports = {
+  hooks: {
+    readPackage,
+  }
+}

.syncpackrc.cjs

@@ -0,0 +1,58 @@
+// @ts-check
+
+/** @type {import('syncpack').RcFile} */
+const config = {
+  semverRange: '',
+  source: ['package.json', '**/package.json'],
+  indent: '  ',
+  sortFirst: [
+    'name',
+    'description',
+    'version',
+    'private',
+    'type',
+    'license',
+    'repository',
+    'author',
+    'contributors',
+    'keywords',
+    'main',
+    'types',
+    'bin',
+    'files',
+    'engines',
+    'scripts',
+    'dependencies',
+    'devDependencies',
+    'peerDependencies',
+    'pnpm',
+    'tsup',
+    'prettier',
+    'eslintConfig',
+    'eslintIgnore',
+    'nyc',
+  ],
+  versionGroups: [
+    {
+      label: 'ES Mapping Generator Special Dependencies',
+      dependencies: ['typescript', 'typedoc', 'ts-node', '@types/node', 'got'],
+      packages: ['@openstapps/es-mapping-generator'],
+      isIgnored: true,
+    },
+    {
+      label: 'Packages should use workspace version',
+      dependencies: ['@openstapps/**'],
+      dependencyTypes: ['prod', 'dev'],
+      packages: ['**'],
+      pinVersion: 'workspace:*',
+    },
+    {
+      label: 'App may have some dependency exceptions',
+      dependencies: ['typescript', '@typescript-eslint/**', 'eslint**'],
+      packages: ['@openstapps/app'],
+      isIgnored: true,
+    },
+  ],
+};
+
+module.exports = config;

CHANGELOG.md

@@ -1,6 +0,0 @@
-### Features
-
-* add es-mapping-gen ([42c9d020](https://gitlab.com/openstapps/es-mapping-gen/commit/42c9d020361eca12370b7af27fb4502335df82bc))
-
-
-

CONTRIBUTING.md

@@ -0,0 +1,100 @@
+# Contributing to `@openstapps/core`
+
+Please see the appropriate general group contributing guides in [project-management](https://gitlab.com/openstapps/projectmanagement/tree/master/project-docs/workflow).
+
+## Updating and releasing related projects
+
+Following semantic versioning patches to the core should not break existing usage.
+
+### API
+
+Every minor and major version of the core needs a corresponding version of the [API](https://openstapps.gitlab.io/api) to be used in the app and connectors.
+
+Because the API is an integral part of the App and Node.js-based connectors this should be done for every new minor and major release of the core.
+
+### Backend
+
+The [backend](https://openstapps.gitlab.io/backend) uses the core to validate requests and responses. With the use of the [core tools](https://openstapps.gitlab.io/core-tools) it uses the core to set up the database according to the model.
+
+Like for the API there should be a new release of the backend for every minor and major release of the core.
+
+### Core tools
+
+The [core tools](https://openstapps.gitlab.io/core-tools) are more or less not dependent on a specific core version and should normally not need adjustments for new core versions as long the structure of the code in the core stays the same.
+
+### App and connectors
+
+[App](https://openstapps.gitlab.io/app) and connectors use the API to communicate with the backend. To ensure compatibility the version of the used core must be the same as the one that is used in the used API.
+
+App and connectors should be updated regularly to new releases of the core but not as important like API and backend. Since the app is just a view for the data stored in the backend it is not necessary to be up to date with the newest core immediately and the connectors are developed independently by every school and up to their responsibility.
+
+## Adding new Types
+
+Adding new types requires changes at multiple locations for it to work correctly
+
+### Required changes
+
+- Add your SCThing and SCThingWithoutReferences to `src/things/your-thing-name.ts` and make them extend `SCThingWithoutReferences` and `SCThing` respectively
+- Add your SCThingMeta to `src/things/your-thing-name.ts` and make it extend `SCThingMeta`
+- Add your SCThingMeta to `SCClasses` in `src/meta.ts`
+- Add your SCThing to `SCThingsWithoutDiff` in `src/meta.ts`
+- Add your SCThingWithoutReferences to `SCAssociatedThingWithoutReferences` in `src/meta.ts`
+- Add your SCThing to `SCAssociatedThing` in `src/meta.ts`
+- Add your SCThing to the `SCThingType` enum in `src/things/abstract/thing.ts`
+- Add an example file for your SCThing in `test/resources/YourThingName.json`
+- Add the following lines for your SCThing in `test/type.spec.ts`:
+
+```typescript
+/**
+ * Types of properties of SCYourThingName
+ */
+type SCYourThingNamePropertyTypes = PropertyTypesNested<SCYourThingName>;
+assert<NotHas<SCYourThingNamePropertyTypes, SCThingWithoutReferences>>(false);
+assert<Has<SCYourThingNamePropertyTypes, SCThingWithoutReferences>>(true);
+assert<NotHas<SCYourThingNamePropertyTypes, SCThing>>(true);
+assert<Has<SCYourThingNamePropertyTypes, SCThing>>(false);
+assert<Extends<SCYourThingNameWithoutReferences, SCThing>>(false);
+assert<Extends<SCYourThingName, SCThing>>(true);
+```
+
+## Additional coding style
+
+### Extract inline type definitions
+
+For consistency and correct functionality of `core-tools` we need well-defined type assignments.
+
+Type assignments shall always be primitive types, classes, interfaces, enums or unions. Not allowed are inline type-definitions. Those shall be refactored accordingly:
+
+```typescript
+export interface SCPlaceWithoutReferences extends SCThing {
+    ...
+    // Use this:
+    geo: SCGeoInformation;
+
+    // Instead of:
+    geo: {
+        point: Point,
+        polygon?: Polygon,
+    };
+}
+```
+
+### Reuse the map structure
+
+If you come around a map-like-type use `SCMap<T>`.
+
+```typescript
+// Use this:
+interface AnyClass {
+  inventory: SCMap<number>;
+}
+
+// Instead of:
+interface AnyClass {
+  inventory?: Array<{key: string; value: number}>;
+}
+// or instead of
+interface AnyClass {
+  inventory?: {[key: string]: number};
+}
+```

README.md

@@ -1,64 +1,94 @@
-# @openstapps/es-mapping-generator
+# Open StApps Monorepo
 
-[![pipeline status](https://img.shields.io/gitlab/pipeline/openstapps/es-mapping-gen.svg?style=flat-square)](https://gitlab.com/openstapps/es-mapping-gen/commits/master)
-[![npm](https://img.shields.io/npm/v/@openstapps/es-mapping-gen.svg?style=flat-square)](https://npmjs.com/package/@openstapps/es-mapping-gen)
-[![license)](https://img.shields.io/npm/l/@openstapps/es-mapping-gen.svg?style=flat-square)](https://www.gnu.org/licenses/gpl-3.0.en.html)
-[![documentation](https://img.shields.io/badge/documentation-online-blue.svg?style=flat-square)](https://openstapps.gitlab.io/es-mapping-gen)
+Refer to the [contribution guide](./CONTRIBUTING.md)
 
-Tools to convert and validate StAppsCore
+## Projects
 
-## What is the ES Mapping Generator for?
+### Apps
 
-The ES Mapping Generator is for converting TypeScript interfaces to Elasticsearch mappings,
-with support for Integer and Float types, Dates, etc.
+| Name     | Version                                                                                                                           | License                                                                                                                              | Readme                                             |
+| -------- | --------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------ | -------------------------------------------------- |
+| Core     | [![npm](https://img.shields.io/npm/v/@openstapps/app.svg?style=flat-square)](https://npmjs.com/package/@openstapps/app)           | [![license)](https://img.shields.io/npm/l/@openstapps/app.svg?style=flat-square)](https://www.gnu.org/licenses/gpl-3.0.en.html)      | [`frontend/app`](./frontend/app/README.md)         |
+| Backend  | [![npm](https://img.shields.io/npm/v/@openstapps/backend.svg?style=flat-square)](https://npmjs.com/package/@openstapps/backend)   | [![license)](https://img.shields.io/npm/l/@openstapps/backend.svg?style=flat-square)](https://www.gnu.org/licenses/gpl-3.0.en.html)  | [`backend/backend`](./backend/backend/README.md)   |
+| Proxy    | [![npm](https://img.shields.io/npm/v/@openstapps/proxy.svg?style=flat-square)](https://npmjs.com/package/@openstapps/proxy)       | [![license)](https://img.shields.io/npm/l/@openstapps/proxy.svg?style=flat-square)](https://www.gnu.org/licenses/gpl-3.0.en.html)    | [`backend/proxy`](./backend/proxy/README.md)       |
+| Database | [![npm](https://img.shields.io/npm/v/@openstapps/database.svg?style=flat-square)](https://npmjs.com/package/@openstapps/database) | [![license)](https://img.shields.io/npm/l/@openstapps/database.svg?style=flat-square)](https://www.gnu.org/licenses/gpl-3.0.en.html) | [`backend/database`](./backend/database/README.md) |
 
-## Why is this a separate package?
+### Libraries
 
-The ES Mapping Generator relies on an outdated version of TypeDoc, that can't be updated.
-Because of that, it then also relies on an outdated version of TypeScript, resulting
-in a cascade effect things that can't be updated. Because of that, we decided to isolate
-it to the best of our abilities.
+| Name       | Version                                                                                                                               | License                                                                                                                                | Readme                                                   |
+| ---------- | ------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------- |
+| Core       | [![npm](https://img.shields.io/npm/v/@openstapps/core.svg?style=flat-square)](https://npmjs.com/package/@openstapps/core)             | [![license)](https://img.shields.io/npm/l/@openstapps/core.svg?style=flat-square)](https://www.gnu.org/licenses/gpl-3.0.en.html)       | [`packages/core`](./packages/core/README.md)             |
+| API        | [![npm](https://img.shields.io/npm/v/@openstapps/api.svg?style=flat-square)](https://npmjs.com/package/@openstapps/api)               | [![license)](https://img.shields.io/npm/l/@openstapps/api.svg?style=flat-square)](https://www.gnu.org/licenses/gpl-3.0.en.html)        | [`packages/api`](./packages/api/README.md)               |
+| API Plugin | [![npm](https://img.shields.io/npm/v/@openstapps/api-plugin.svg?style=flat-square)](https://npmjs.com/package/@openstapps/api-plugin) | [![license)](https://img.shields.io/npm/l/@openstapps/api-plugin.svg?style=flat-square)](https://www.gnu.org/licenses/gpl-3.0.en.html) | [`packages/api-plugin`](./packages/api-plugin/README.md) |
+| Logger     | [![npm](https://img.shields.io/npm/v/@openstapps/logger.svg?style=flat-square)](https://npmjs.com/package/@openstapps/logger)         | [![license)](https://img.shields.io/npm/l/@openstapps/logger.svg?style=flat-square)](https://www.gnu.org/licenses/gpl-3.0.en.html)     | [`packages/logger`](./packages/logger/README.md)         |
+| Core Tools | [![npm](https://img.shields.io/npm/v/@openstapps/core-tools.svg?style=flat-square)](https://npmjs.com/package/@openstapps/core-tools) | [![license)](https://img.shields.io/npm/l/@openstapps/core-tools.svg?style=flat-square)](https://www.gnu.org/licenses/gpl-3.0.en.html) | [`packages/core-tools`](./packages/core-tools/README.md) |
 
-## How to use the Elasticsearch Mapping generator
+## Publishing
 
-The mapping generator is intended to be used by the backend directly, but it can also be used to generate these files
-manually.
+After having added all changes using `pnpm changeset`
 
-### Generating the mapping files by hand
-
-To generate the mapping files by hand, you need a local copy of the core-tools and the core, both need to be built first.
-After that you can run
+```shell
+pnpm changeset version # bump versions
+pnpm install # update lockfile and rebuild packages
+pnpm build # make sure all packages are built
+pnpm publish -r # publish all packages not yet in the registry
+git add .
+git commit -m "v[VERSION]"
+git tag -a "v[VERSION]"
+git push --follow-tags
 ```
-node lib/cli.js mapping path/to/core path/to/destination ignoredTag1,ignoredTag2,ignoredTag3
+
+## Remote caching
+
+Turbo supports remote caching, which massively speeds up build processes.
+
+### Connecting to the remote cache locally
+
+`.env.local`
+
+```dotenv
+TURBO_API=http://example:3000
+TURBO_TEAM=openstapps
+TURBO_TOKEN=abc123
 ```
-If you don't pass in any ignored tags, you will likely be prompted with errors, despite the core being absolutely correct.
-This is because there are some tags that are not relevant to Elasticsearch, but the program has no direct way to tell
-which ones simply lack an implementation and which ones can be ignored. Currently the ignored tags include
-`minlength`, `pattern` and `see`.
 
-### Generating the mapping directly from another TypeScript program
+### Connecting to the remote cache in GitLab Pipelines
 
-This is the more easy way, and it gives you direct access to the generated mapping as a (mostly typesafe) object. To
-use it, call `generateTemplate`, However you will first need to generate a ProjectReflection of the core you are working
-with. If you use the core as a dependency, you can for example use
-```typescript
-const map = generateTemplate(getProjectReflection(resolve('node_modules', '@openstapps', 'core', 'src')),
-      ignoredTags, false);
+You will need to define
+
+- `TURBO_API`
+- `TURBO_TEAM`
+- `TURBO_TOKEN`
+  Like you did locally as described in [this](https://turbo.build/repo/docs/ci/gitlabci#remote-caching)
+  guide.
+
+### Hosting a cache
+
+Self-hosting via Docker is extremely simple, just follow
+[this](http://v2202207178592194230.supersrv.de:6341) guide
+or in short:
+
+`.env`
+
+```dotenv
+PORT=...
+TURBO_TOKEN=...
 ```
-to generate the mappings. Note that the result object contains both a list of errors in `map.errors` and the actual mapping
-in `map.template`. You can also specify whether you want the generator to show any errors while generating the mappings
-in the console in the last parameter, `true` (default) being show errors and `false` to suppress them. That said it is very
-easy to replace all `type: "MISSING_PREMAP"`, `type: "PARSE_ERROR"`, `type: "TYPE_CONFLICT"` with `dynamic: true` (you
-can take these exactly like written here and run a replace over the file).
 
-### Fixing a generated mapping by hand
+```shell
+docker run --env-file=.env -p 3000:3000 fox1t/turborepo-remote-cache
+```
 
-If you get errors when generating the mappings, the mappings might not work, however they will still be generated to the
-programs best efforts. Most small issues can be fixed after the mapping was generated as a temporary solution and without
-changing anything in the mapper's code. This however requires some understanding of how mappings work.
+## Useful commands
 
-The output of the program can easily reach 25.000 lines, but you can find errors quickly by searching for `MISSING_PREMAP`,
-`PARSE_ERROR` and `TYPE_CONFLICT`. When you reach them you can then manually replace them with your code.
+#### Why is this package bloating the app?
 
-As a last resort you can also replace all errors with dynamic types, this should get the mapping working, but it is NOT
-RECOMMENDED as a fix other than using it locally.
+```shell
+pnpm why --prod -r --filter @openstapps/app PACKAGE
+```
+
+#### Licenses
+
+```shell
+pnpm licenses --prod --filter PROJECT
+```

backend/backend/.gitlab-ci.yml

@@ -0,0 +1,22 @@
+integration:
+  image: registry.gitlab.com/openstapps/projectmanagement/builder:v18
+  stage: test
+  needs: ['build']
+  variables:
+    DOCKER_DRIVER: overlay2
+    WAIT_FOR_SERVICES_TIMEOUT: 1
+  services:
+    - name: registry.gitlab.com/openstapps/database:latest
+      alias: elasticsearch
+  script:
+    - pnpm --filter=@openstapps/backend install
+    - pnpm test:integration:backend
+  artifacts:
+    when: always
+    paths:
+      - backend/backend/coverage/integration-report-junit.xml
+    reports:
+      junit:
+        - backend/backend/coverage/integration-report-junit.xml
+  rules:
+    - when: on_success

backend/backend/CHANGELOG.md

@@ -0,0 +1,248 @@
+# @openstapps/backend
+
+## 3.0.0-next.0
+
+### Major Changes
+
+- 64caebaf: Migrate config system to cosmiconfig
+
+  Configs are now written using type-checked JavaScript
+
+  ```js
+  // @ts-check
+
+  // This file is now type-safe just like TypeScript, but
+  // without the compilation step
+
+  /** @type {import('@openstapps/package').Type} */
+  const foo = {};
+  ```
+
+  You can write config files in JavaScript, JSON, or other
+  cosmiconfig-supported formats.
+
+  The config files now are
+
+  - `backendrc.{js,json,...}`
+  - `elasticsearchrc.{js,json,...}`
+  - `prometheusrc.{js,json,...}`
+
+  You can also split them into multiple files,
+  as well as using the `markdown.js` helper in
+  `config/default/tools` to include markdown files
+  as text (see `config/f-u/about-pages`)
+
+- 64caebaf: Move project to a turbo monorepo & pnpm
+
+  Internal dependencies are now defined using `"@openstapps/package": "workspace:*"`
+
+  - Removed extraneous files from packages
+    - `.npmrc`
+    - `.npmignore`
+    - `.mailmap`
+    - `.gitignore`
+    - `CONTRIBUTING.md`
+    - `LICENSE` (Project license file is added upon publishing, see [pnpm.io](https://pnpm.io/cli/publish))
+    - `package-lock.json`
+    - `.editorconfig`
+    - `.eslintrc.json` (moved eslint config to `package.json`)
+    - `.eslintignore`
+    - `.gitlab-ci.yml` (Most workflows are workspace-level)
+    - `.gitlab/**` (issue templates etc. are now workspace-level)
+    - `.dockerignore` (Docker files are determined by which files are deployed with `pnpm deploy`, as per `package.json/files`)
+  - TSConfig has been moved to its own package (You can now use `"extends": "@openstapps/tsconfig"`)
+  - Removed ESLint and Prettier peer dependency hell by injecting them through the `.pnpmfile.cjs`
+  - Added syncpack for keeping dependency versions in sync (and consistent key ordering in `package.json`)
+  - Replaced conventional changelog with changesets
+  - Apps with binaries now use a top level `app.js`
+
+  ```js
+  #!/usr/bin/env node
+  import './lib/app.js';
+  ```
+
+- 64caebaf: Migrate to ESM
+
+  CommonJS is no longer supported in any capacity. To use the new
+  version, you will need to migrate your package to ESM.
+  We recommend using `tsup` and `Node 18`.
+
+  ```json
+  {
+    "type": "module"
+  }
+  ```
+
+- 64caebaf: Migrate package to Node 18
+
+  - Consumers of this package will need to migrate to Node 18 or
+    higher.
+  - Packages have been migrated from promisified `readFile` or
+    `readFileSync` towards `fs/promises`
+  - Packages use native `flatMap` now
+
+- 0a7e6af1: Migrate es mapping types from es-mapping-generator to .d.ts next to generated mappings
+- 64caebaf: Migrate build system to `tsup`
+
+  All packages now use an `index.ts` file to expose contents.
+
+  You will need to migrate paths from `import foo from '@scope/package/lib/foo` to `import foo from '@scope/package'`
+
+### Minor Changes
+
+- 64caebaf: Migrate integration tests from docker-compose solution to a shell script
+
+  `api-cli` no longer builds as a Docker container as a result.
+
+- 64caebaf: Migrate tests to C8/Chai/Mocha
+
+  - `@testdeck` OOP testing has been removed.
+  - Tests have been unified
+  - CommonJS module mocking has been replaced through
+    refactoring of tests, as ES Modules cannot be mocked
+    (do yourself a favor and don't try to mock them)
+  - C8 now replaces NYC as a native coverage tool
+
+- 64caebaf: Migrate away from `@krlwlfrt/async-pool`
+
+  ```ts
+  import {mapAsyncLimit} from '@openstapps/collection-utils';
+
+  await mapAsyncLimit(
+    [1, 2, 3],
+    async it => {
+      await someNetworkRequest(it);
+    },
+    5,
+  );
+  ```
+
+### Patch Changes
+
+- 64caebaf: Migrated changelogs to changeset format
+
+  ```js
+  import fs from 'fs';
+
+  const path = 'packages/logger/CHANGELOG.md';
+
+  fs.writeFileSync(path, fs.readFileSync(path, 'utf8').replace(/^#+\s+\[/gm, '## ['));
+  ```
+
+- 98546a97: Migrate away from @openstapps/configuration
+- Updated dependencies [98546a97]
+- Updated dependencies [64caebaf]
+- Updated dependencies [98546a97]
+- Updated dependencies [64caebaf]
+- Updated dependencies [64caebaf]
+- Updated dependencies [64caebaf]
+- Updated dependencies [64caebaf]
+- Updated dependencies [98546a97]
+- Updated dependencies [0a7e6af1]
+- Updated dependencies [64caebaf]
+- Updated dependencies [64caebaf]
+- Updated dependencies [98546a97]
+- Updated dependencies [64caebaf]
+- Updated dependencies [64caebaf]
+- Updated dependencies [64caebaf]
+- Updated dependencies [98546a97]
+  - @openstapps/core-tools@3.0.0-next.0
+  - @openstapps/logger@3.0.0-next.0
+  - @openstapps/core@3.0.0-next.0
+
+## [1.0.0](https://gitlab.com/openstapps/backend/compare/v0.6.0...v1.0.0) (2023-05-08)
+
+### Bug Fixes
+
+- openapi docs generation ([4ebe44a](https://gitlab.com/openstapps/backend/commit/4ebe44a5a7a1b7bfd0aa5b84d47d4056d3068ffe))
+- rename deprecated Gitlab CI variables ([3471591](https://gitlab.com/openstapps/backend/commit/3471591a7d458df70447c8dac91f96f3c83e763c))
+- semster boosting ([515a6ee](https://gitlab.com/openstapps/backend/commit/515a6eeea56305a37510d99b9f84a6b118b66f8a))
+
+### Features
+
+- update to of elasticsearch 8.4 ([c9b83b5](https://gitlab.com/openstapps/backend/commit/c9b83b5d71610f82bd1d99e837e29ad445758aea))
+
+## [0.6.0](https://gitlab.com/openstapps/backend/compare/v0.5.0...v0.6.0) (2023-01-30)
+
+## [0.5.0](https://gitlab.com/openstapps/backend/compare/v0.4.1...v0.5.0) (2022-12-06)
+
+## [0.4.1](https://gitlab.com/openstapps/backend/compare/v0.4.0...v0.4.1) (2022-11-02)
+
+## [0.4.0](https://gitlab.com/openstapps/backend/compare/v0.3.1...v0.4.0) (2022-10-21)
+
+## [0.3.1](https://gitlab.com/openstapps/backend/compare/v0.3.0...v0.3.1) (2022-09-02)
+
+## [0.3.0](https://gitlab.com/openstapps/backend/compare/v0.2.0...v0.3.0) (2022-08-24)
+
+## [0.2.0](https://gitlab.com/openstapps/backend/compare/v0.1.0...v0.2.0) (2022-08-22)
+
+### Bug Fixes
+
+- update PAIA API URL ([a20200e](https://gitlab.com/openstapps/backend/commit/a20200e52a725ede42cb5e026a5a693b1ba3d149))
+
+## [0.1.0](https://gitlab.com/openstapps/backend/compare/16bbb7e9e36b7adf27452e1b09f7970e98aa27df...v0.1.0) (2022-06-30)
+
+### Bug Fixes
+
+- Add default configuration file for prometheus monitoring ([7ed2921](https://gitlab.com/openstapps/backend/commit/7ed2921efbce7fa5134206763eea986c6ef9a919))
+- add prefix to schema names ([90822f5](https://gitlab.com/openstapps/backend/commit/90822f5888ed34d594b02df3f5cd9ec8ce74251e))
+- apply correct types and tslint rules ([0cbf9b2](https://gitlab.com/openstapps/backend/commit/0cbf9b26a972563ad9483d78cea9ba809381f7dd))
+- automatically remove invalid characters for aliases generated from index names ([6f7e23d](https://gitlab.com/openstapps/backend/commit/6f7e23df20af54abf2459da8aaebe236b82a5f1c))
+- Don't force Mapping generation with 'npm start' ([4cfb560](https://gitlab.com/openstapps/backend/commit/4cfb560954ca97e22091e13d515475218885b1de))
+- enhance default search query generation ([24a9122](https://gitlab.com/openstapps/backend/commit/24a91229f28fb17cb4941aab688a08266437c1eb))
+- error thrown on consecutive connector executions ([2259da3](https://gitlab.com/openstapps/backend/commit/2259da317a848660fc2b0a14e50e2ae5ae329889)), closes [#73](https://gitlab.com/openstapps/backend/issues/73)
+- esacpe mappin template filename ([496e6c5](https://gitlab.com/openstapps/backend/commit/496e6c5bd0563bd2dc0c6eff45c9bd685d95b453))
+- fix markdown formatting in config ([9c5581a](https://gitlab.com/openstapps/backend/commit/9c5581af2cc131b81c288eadc39827124963ce55))
+- fix reading url path as parameters ([9b889c8](https://gitlab.com/openstapps/backend/commit/9b889c873624d43baed4769a788db39528b143d8))
+- imports from src in config files lead to crash ([f6003d7](https://gitlab.com/openstapps/backend/commit/f6003d7f8709d4424acd261cc7804e4d2684a9f4))
+- invalid monthly cron execution time ([7a9f3ea](https://gitlab.com/openstapps/backend/commit/7a9f3eaca4667870ed19b17fd26c3c6d8e1fadd5))
+- make config compatible with core, update database version ([f11376e](https://gitlab.com/openstapps/backend/commit/f11376ecf8c4997f6d0a85b3f3fde9e8b02bd61b))
+- make facets work again ([d917627](https://gitlab.com/openstapps/backend/commit/d917627d588783d8734bd1d0c30d3d2782d02761))
+- make index route work correctly ([fa2c9d7](https://gitlab.com/openstapps/backend/commit/fa2c9d7a881d9e94da8512349056b69206e4e3d0))
+- properly check if an object exists before update ([e165837](https://gitlab.com/openstapps/backend/commit/e165837a154243305dc300acaa29605732290f6a)), closes [#70](https://gitlab.com/openstapps/backend/issues/70)
+- remove onlyOnTypes from mustMatch ([1d5f99b](https://gitlab.com/openstapps/backend/commit/1d5f99b1fa74c486dc4df29daf9c0aa453935821)), closes [#83](https://gitlab.com/openstapps/backend/issues/83)
+- replace isProductiveEnvironment with isTestEnvironment ([8c48552](https://gitlab.com/openstapps/backend/commit/8c48552abf7b7983e966ebc22299b334cae46167))
+- return syntax error when receiving bad json ([12b71ba](https://gitlab.com/openstapps/backend/commit/12b71ba1f1f3e45a84b001b395dcfa1578355276)), closes [#3](https://gitlab.com/openstapps/backend/issues/3)
+- return validation error instead of internal server error ([24e27c1](https://gitlab.com/openstapps/backend/commit/24e27c1d9e002db3b8f4afb4a31ad994c0eaad42))
+- route for news ([7e35fae](https://gitlab.com/openstapps/backend/commit/7e35fae34e02bf2e12cf0d0b960d48de97fd4200))
+- set config file before accessing it ([e17db52](https://gitlab.com/openstapps/backend/commit/e17db521e2a3f4f15dc5e5b758bd1ada10c78161)), closes [#27](https://gitlab.com/openstapps/backend/issues/27)
+- stapps core version in config ([32c8a21](https://gitlab.com/openstapps/backend/commit/32c8a2149ad18179610af02483b794b426b7b9dc)), closes [#74](https://gitlab.com/openstapps/backend/issues/74)
+- take coordinates in right order ([bb3be5a](https://gitlab.com/openstapps/backend/commit/bb3be5a816f7e4eb85b69ec558572bed9c3b6b39)), closes [#116](https://gitlab.com/openstapps/backend/issues/116)
+- use SCRequestBodyTooLargeError ([e70e50a](https://gitlab.com/openstapps/backend/commit/e70e50a1eab00cd180479c5e0299f974da92fe94)), closes [#20](https://gitlab.com/openstapps/backend/issues/20)
+- use specific time from filter if defined ([80e6249](https://gitlab.com/openstapps/backend/commit/80e62496f0731af721193875d5a6cdbf10b34607))
+- wait for config file validation ([30082f8](https://gitlab.com/openstapps/backend/commit/30082f87262fa7428172fcbb6710b66d4bfe6261))
+- wrong way alias names are generated ([9488451](https://gitlab.com/openstapps/backend/commit/94884510802906cdbfdd3490fac5fc9401937da7)), closes [#79](https://gitlab.com/openstapps/backend/issues/79)
+
+### Features
+
+- add backend ([16bbb7e](https://gitlab.com/openstapps/backend/commit/16bbb7e9e36b7adf27452e1b09f7970e98aa27df))
+- add boosting to context based search ([dd4be92](https://gitlab.com/openstapps/backend/commit/dd4be92f90c6e7047eea0d00a2442b75673329f6))
+- add catalog menu entry and rearrange ([4e42772](https://gitlab.com/openstapps/backend/commit/4e42772ca3788d3ee7af78266ee223e05fe6a8f3))
+- add default app settings and menus ([54301ae](https://gitlab.com/openstapps/backend/commit/54301ae8fb656db17e231197c3a64fc27f541024))
+- add dummy about config ([d6f126f](https://gitlab.com/openstapps/backend/commit/d6f126f19776ee7902e65d9248501b4986657ed9))
+- add favorites to personal menu ([de0617b](https://gitlab.com/openstapps/backend/commit/de0617b8dd51182326094543110b8ed294a6e940))
+- add feedback to config as menu item ([7ba6472](https://gitlab.com/openstapps/backend/commit/7ba647271efd87c422ce302bd5baf5760671e1a1))
+- add functionality to register plugins via http ([3d51ccf](https://gitlab.com/openstapps/backend/commit/3d51ccfac26b2c3ad1271c29c1e736aaf7fcd88f)), closes [#2](https://gitlab.com/openstapps/backend/issues/2) [#37](https://gitlab.com/openstapps/backend/issues/37)
+- add hebis proxy url ([ca1d244](https://gitlab.com/openstapps/backend/commit/ca1d2444e03aacad37219d93d657968b7a933f78)), closes [#120](https://gitlab.com/openstapps/backend/issues/120)
+- add openapi docs generation to api ([614a1b1](https://gitlab.com/openstapps/backend/commit/614a1b1e9b3c525d5524065851689f793a4b3b4b))
+- Add prometheus middleware to express ([b42e911](https://gitlab.com/openstapps/backend/commit/b42e911a117c59b2d70c1587f9e9b20a846e92d0))
+- add routes doc generation to npm documentation script ([4a64f26](https://gitlab.com/openstapps/backend/commit/4a64f26e43979cdd4390bad796e1b7dc3f8c7027))
+- add schedule route ([785813c](https://gitlab.com/openstapps/backend/commit/785813c3fb92bbebd7b07246bbcec77a9a4520e3))
+- Add start-debug npm run script ([23eb1e2](https://gitlab.com/openstapps/backend/commit/23eb1e2263d2dd9d55f9a6ac5fca2a8fad7f1e84))
+- add support for generated elasticsearch mappings ([8eab6b8](https://gitlab.com/openstapps/backend/commit/8eab6b8531d91d4569fe13743624f5ce91a7dc1e)), closes [#38](https://gitlab.com/openstapps/backend/issues/38)
+- add support for multiple values in value filter ([de60311](https://gitlab.com/openstapps/backend/commit/de60311bd072db01eaf50965f3fdc307bfedc4c2))
+- add support for new availability filter ([47f3232](https://gitlab.com/openstapps/backend/commit/47f3232f155a13ea39abb2aaaecafd54fa7d98ce))
+- add support for range filters ([dc16974](https://gitlab.com/openstapps/backend/commit/dc169746e7fa0f50a1f969653043e5a4d5fa0f01))
+- add support for range filters ([dcf7906](https://gitlab.com/openstapps/backend/commit/dcf7906f79f07d9cfee704454eedddb452a1f255))
+- adjust to changes of SCFacet in core v0.12.0 ([2f13010](https://gitlab.com/openstapps/backend/commit/2f13010480b87a4a06634084033b3b0822eb78ee)), closes [#30](https://gitlab.com/openstapps/backend/issues/30)
+- allow for searching illegal elasticsearch characters ([b629d05](https://gitlab.com/openstapps/backend/commit/b629d058eb64c7a785648fab0a7073eeaa37e895))
+- boost academic terms dynamically ([13938ec](https://gitlab.com/openstapps/backend/commit/13938ecf211060a3f50747ac7fed343b71a6aa4b))
+- log registration and removal of plugins ([006bbeb](https://gitlab.com/openstapps/backend/commit/006bbebe60b7f5015d80ac825622cefbc25cd959)), closes [#71](https://gitlab.com/openstapps/backend/issues/71)
+- make backend work with automatically generated aggregations ([ba2c6f6](https://gitlab.com/openstapps/backend/commit/ba2c6f655c263f0b1d1e55b739adde0004bbf408))
+- move EXTERNAL_REQUEST_TIMEOUT to config file ([5d6d4b5](https://gitlab.com/openstapps/backend/commit/5d6d4b53f01550365a330daecbcb4e0f6bdb8aef))
+- move up and enable cors ([6483221](https://gitlab.com/openstapps/backend/commit/6483221b62d84c5871ee4ec82158f8b9ef1ed54e))
+- support geo shape filter ([dd8a6b3](https://gitlab.com/openstapps/backend/commit/dd8a6b3abcc90c50a16167054e2f3cdcee40c863))
+- use config file for maxRequestBodySize ([d110d60](https://gitlab.com/openstapps/backend/commit/d110d60123a28563fe0c58ab903f61255a9644a2))
+- use config for MultiSearchRoute ([8278279](https://gitlab.com/openstapps/backend/commit/827827905b71c71dfa9299a9deb92a8c9cfc0e20))
+- use new Elasticsearch package ([1bad092](https://gitlab.com/openstapps/backend/commit/1bad092185d989078badc66f9c138d2e1baa27e4))
+- utilize api-cli for e2e integration test ([ce06e73](https://gitlab.com/openstapps/backend/commit/ce06e735bea379c9ad955a627e3e1cead37c85fe))

backend/backend/Dockerfile

@@ -0,0 +1,12 @@
+FROM registry.gitlab.com/openstapps/projectmanagement/node:v18
+
+USER root
+RUN apk add --update python3 py3-pip make g++ gcompat
+
+USER node
+ADD --chown=node:node . /app
+ENV NODE_ENV=production
+WORKDIR /app
+
+EXPOSE 3000
+ENTRYPOINT ["node", "app.js"]

backend/backend/README.md

@@ -0,0 +1,114 @@
+[![pipeline status](https://img.shields.io/gitlab/pipeline/openstapps/backend.svg?style=flat-square)](https://gitlab.com/openstapps/backend/commits/master)
+
+# backend (a reference implementation of a StApps backend)
+
+This project is a reference implementation for a StApps backend. It provides an HTTP API to index data into a database,
+perform full text search, sorts and filters. It also delivers the configuration needed by the app. The API is specified
+within the [@openstapps/core](https://gitlab.com/openstapps/core).
+
+If you want to perform requests, index data or search within JavaScript or TypeScript you should consider using our client
+[@openstapps/api](https://gitlab.com/openstapps/api).
+
+Or generate your own client using the openapi/swagger definitions you can get form the [API documentation](https://openstapps.gitlab.io/backend).
+
+# Usage
+
+This backend is not a standalone software. It needs a database like Elasticsearch to work.
+
+If you just want to use the backend you should consider using
+[minimal-deployment](https://gitlab.com/openstapps/minimal-deployment). The minimal-deployment will provide
+you with everything you need to run this backend.
+
+# Local usage for development purposes
+
+## Requirements
+
+- Elasticsearch (8.4)
+  - [ICU analysis plugin](https://www.elastic.co/guide/en/elasticsearch/plugins/current/analysis-icu.html)
+  - OR Docker
+- Node.js (~14) / NPM
+
+### Startup Behaviour
+
+_This might be important if you work on the Core_
+
+The backend is using Elasticsearch Mappings and Aggregations from its currently used `core` dependency.
+
+## Start Database (Elasticsearch)
+
+Elasticsearch needs some configuration and plugins to be able to work
+with the backend. To save you some work we provide a
+[docker image](https://gitlab.com/openstapps/database) which
+only needs to be executed to work with the backend.
+
+Run `docker run -d -p 9200:9200 registry.gitlab.com/openstapps/database:latest`
+
+Elasticsearch should be running at port 9200 now. If you have problems with
+getting elasticsearch to work, have a look in the
+[README](https://gitlab.com/openstapps/database) of the image
+first.
+
+## Metrics collection
+
+The backend contains an express middleware which can be optionally enabled by setting the environment variable
+`PROMETHEUS_MIDDLEWARE` to `true`. The middleware collects metrics and provides a [Prometheus](https://prometheus.io/)
+compatible endpoint from which the metrics may be scraped by Prometheus.
+
+The middleware may be configured with JSON provided in `config/prometheus.json`, i.e.
+
+```JSON
+{
+  "metricsPath": "/metrics",
+  "collectDefaultMetrics": true,
+  "requestDurationBuckets": [0.1, 0.5, 1, 2, 5, 10, 20],
+  "requestLengthBuckets": [512, 1024, 5120, 10240, 51200, 102400],
+  "responseLengthBuckets": [512, 1024, 5120, 10240, 51200, 102400]
+}
+```
+
+The available options are documented on [npmjs](https://www.npmjs.com/package/express-prometheus-middleware) or the [homepage](https://github.com/joao-fontenele/express-prometheus-middleware#readme) of the express-prometheus-middleware project. You may get a compatible grafana dashboard at [grafana.com](https://grafana.com/grafana/dashboards/14565).
+
+## Start backend
+
+Run `npm install` and `npm run build`, then start with `npm start`. The server should now be accepting connections at `http://localhost:3000`.
+
+# Environment Variables
+
+To select a database implementation you have to set the `NODE_CONFIG_ENV` variable. At the time only `NODE_CONFIG_ENV=elasticsearch` is supported.
+Set `NODE_ENV=production` to run backend for production usages. In production the backend expects some kind of monitoring to be set via the
+environment. At the time only SMTP is being implemented. The backend wouldn't start if you don't provide SMTP authentification. Alternatively
+you can set `ALLOW_NO_TRANSPORT=true`. To set up an SMTP configuration have a look at
+[@openstapps/logger](https://gitlab.com/openstapps/logger).
+
+The list of environment variables includes:
+
+- `NODE_ENV` when set to `production`, there will be a reduced amount of output from the logger
+- `PORT` when this is not set, the backend will default to port 3000
+- `ES_ADDR` the Elasticsearch address, if not set it will default the Elasticsearch address to `http://localhost:9200`
+- `ALLOW_NO_TRANSPORT` if set to true, the backend will allow starting without an Email configured that receives critical errors.
+- `ES_DEBUG` setting this to `true` will result in Elasticsearch logging to be **VERY** extensive, in almost all situation this should no be enabled.
+- `PROMETHEUS_MIDDLEWARE` if set to `true` will enable metrics collection with [Express Prometheus Middleware](https://www.npmjs.com/package/express-prometheus-middleware)
+
+## Config files
+
+Each university can have it's specific config for the general backend and app and for all databases.
+
+All config files can be found in `./config/`. There is a `default.ts` which is used by default. You can create an
+university specific file with following naming scheme: `default-<university license plate>.ts`
+
+A university specific file will only overwrite all properties of the `default.ts` that are set in the file itself.
+To start the backend using your configuration you have to provide the `NODE_APP_INSTANCE` environment variable
+with your university license plate.
+
+To set a database you have to provide the `NODE_CONFIG_ENV` environment variable with the name of the database.
+At the time only Elasticsearch is implemented.
+
+To create your university specific config file for the elasticsearch you have to create a file with following naming
+scheme: `elasticsearch-<university license plate>.ts`.
+
+## Debugging
+
+Set `ES_DEBUG=true` to enable verbose Elasticsearch tracing information.
+This can be useful to debug some issues between backend and elasticsearch.
+
+## [Contributing](https://gitlab.com/openstapps/projectmanagement/blob/master/CONTRIBUTING.md)

backend/backend/ROUTES.md

@@ -0,0 +1,145 @@
+# Routes
+
+## `POST /bookAvailability` [Book availability route](https://openstapps.gitlab.io/core/classes/_index.d_.scbookavailabilityroute.html)
+
+**Route for book availability**
+
+This checks if a book is available in a library.<br>
+**Example**:
+
+`POST https://example.com/bookAvailability`
+
+```json
+{
+  "isbn": "978-3-16-148410-0"
+}
+```
+
+### Definition
+
+| parameter    | value                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
+| ------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| request      | [SCBookAvailabilityRequest](https://openstapps.gitlab.io/core/modules/_index.d_.html#scbookavailabilityrequest)                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
+| response     | [SCBookAvailabilityResponse](https://openstapps.gitlab.io/core/modules/_index.d_.html#scbookavailabilityresponse)                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
+| success code | 200                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
+| errors       | [SCInternalServerErrorResponse](https://openstapps.gitlab.io/core/classes/_index.d_.scinternalservererrorresponse.html)<br>[SCMethodNotAllowedErrorResponse](https://openstapps.gitlab.io/core/classes/_index.d_.scmethodnotallowederrorresponse.html)<br>[SCNotFoundErrorResponse](https://openstapps.gitlab.io/core/classes/_index.d_.scnotfounderrorresponse.html)<br>[SCRequestBodyTooLargeErrorResponse](https://openstapps.gitlab.io/core/classes/_index.d_.screquestbodytoolargeerrorresponse.html)<br>[SCSyntaxErrorResponse](https://openstapps.gitlab.io/core/classes/_index.d_.scsyntaxerrorresponse.html)<br>[SCUnsupportedMediaTypeErrorResponse](https://openstapps.gitlab.io/core/classes/_index.d_.scunsupportedmediatypeerrorresponse.html)<br>[SCValidationErrorResponse](https://openstapps.gitlab.io/core/classes/_index.d_.scvalidationerrorresponse.html) |
+
+## `POST /bulk/:UID` [Bulk add route](https://openstapps.gitlab.io/core/classes/_index.d_.scbulkaddroute.html)
+
+**Route for indexing SC things in a bulk**
+
+### Definition
+
+| parameter             | value                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
+| --------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| request               | [SCBulkAddRequest](https://openstapps.gitlab.io/core/modules/_index.d_.html#scbulkaddrequest)                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
+| response              | [SCBulkAddResponse](https://openstapps.gitlab.io/core/interfaces/_index.d_.scbulkaddresponse.html)                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
+| success code          | 201                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
+| errors                | [SCInternalServerErrorResponse](https://openstapps.gitlab.io/core/classes/_index.d_.scinternalservererrorresponse.html)<br>[SCMethodNotAllowedErrorResponse](https://openstapps.gitlab.io/core/classes/_index.d_.scmethodnotallowederrorresponse.html)<br>[SCNotFoundErrorResponse](https://openstapps.gitlab.io/core/classes/_index.d_.scnotfounderrorresponse.html)<br>[SCRequestBodyTooLargeErrorResponse](https://openstapps.gitlab.io/core/classes/_index.d_.screquestbodytoolargeerrorresponse.html)<br>[SCSyntaxErrorResponse](https://openstapps.gitlab.io/core/classes/_index.d_.scsyntaxerrorresponse.html)<br>[SCUnsupportedMediaTypeErrorResponse](https://openstapps.gitlab.io/core/classes/_index.d_.scunsupportedmediatypeerrorresponse.html)<br>[SCValidationErrorResponse](https://openstapps.gitlab.io/core/classes/_index.d_.scvalidationerrorresponse.html) |
+| obligatory parameters | <table><tr><th>parameter</th><th>type</th></tr><tr><td>UID</td><td>[SCUuid](https://openstapps.gitlab.io/core/modules/_index.d_.html#scuuid)</td></tr></table>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
+
+## `POST /bulk/:UID/done` [Bulk done route](https://openstapps.gitlab.io/core/classes/_index.d_.scbulkdoneroute.html)
+
+**Route for closing bulks**
+
+### Definition
+
+| parameter             | value                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
+| --------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| request               | [SCBulkDoneRequest](https://openstapps.gitlab.io/core/interfaces/_index.d_.scbulkdonerequest.html)                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
+| response              | [SCBulkDoneResponse](https://openstapps.gitlab.io/core/interfaces/_index.d_.scbulkdoneresponse.html)                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
+| success code          | 204                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
+| errors                | [SCInternalServerErrorResponse](https://openstapps.gitlab.io/core/classes/_index.d_.scinternalservererrorresponse.html)<br>[SCMethodNotAllowedErrorResponse](https://openstapps.gitlab.io/core/classes/_index.d_.scmethodnotallowederrorresponse.html)<br>[SCNotFoundErrorResponse](https://openstapps.gitlab.io/core/classes/_index.d_.scnotfounderrorresponse.html)<br>[SCRequestBodyTooLargeErrorResponse](https://openstapps.gitlab.io/core/classes/_index.d_.screquestbodytoolargeerrorresponse.html)<br>[SCSyntaxErrorResponse](https://openstapps.gitlab.io/core/classes/_index.d_.scsyntaxerrorresponse.html)<br>[SCUnsupportedMediaTypeErrorResponse](https://openstapps.gitlab.io/core/classes/_index.d_.scunsupportedmediatypeerrorresponse.html)<br>[SCValidationErrorResponse](https://openstapps.gitlab.io/core/classes/_index.d_.scvalidationerrorresponse.html) |
+| obligatory parameters | <table><tr><th>parameter</th><th>type</th></tr><tr><td>UID</td><td>[SCUuid](https://openstapps.gitlab.io/core/modules/_index.d_.html#scuuid)</td></tr></table>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
+
+## `POST /bulk` [Bulk route](https://openstapps.gitlab.io/core/classes/_index.d_.scbulkroute.html)
+
+**Route for bulk creation**
+
+### Definition
+
+| parameter    | value                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
+| ------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| request      | [SCBulkRequest](https://openstapps.gitlab.io/core/interfaces/_index.d_.scbulkrequest.html)                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
+| response     | [SCBulkResponse](https://openstapps.gitlab.io/core/interfaces/_index.d_.scbulkresponse.html)                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
+| success code | 200                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
+| errors       | [SCInternalServerErrorResponse](https://openstapps.gitlab.io/core/classes/_index.d_.scinternalservererrorresponse.html)<br>[SCMethodNotAllowedErrorResponse](https://openstapps.gitlab.io/core/classes/_index.d_.scmethodnotallowederrorresponse.html)<br>[SCRequestBodyTooLargeErrorResponse](https://openstapps.gitlab.io/core/classes/_index.d_.screquestbodytoolargeerrorresponse.html)<br>[SCSyntaxErrorResponse](https://openstapps.gitlab.io/core/classes/_index.d_.scsyntaxerrorresponse.html)<br>[SCUnsupportedMediaTypeErrorResponse](https://openstapps.gitlab.io/core/classes/_index.d_.scunsupportedmediatypeerrorresponse.html)<br>[SCValidationErrorResponse](https://openstapps.gitlab.io/core/classes/_index.d_.scvalidationerrorresponse.html) |
+
+## `POST /feedback` [Feedback route](https://openstapps.gitlab.io/core/classes/_index.d_.scfeedbackroute.html)
+
+**Route for feedback submission**
+
+### Definition
+
+| parameter    | value                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
+| ------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| request      | [SCFeedbackRequest](https://openstapps.gitlab.io/core/interfaces/_index.d_.scfeedbackrequest.html)                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
+| response     | [SCFeedbackResponse](https://openstapps.gitlab.io/core/interfaces/_index.d_.scfeedbackresponse.html)                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
+| success code | 204                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
+| errors       | [SCInternalServerErrorResponse](https://openstapps.gitlab.io/core/classes/_index.d_.scinternalservererrorresponse.html)<br>[SCMethodNotAllowedErrorResponse](https://openstapps.gitlab.io/core/classes/_index.d_.scmethodnotallowederrorresponse.html)<br>[SCRequestBodyTooLargeErrorResponse](https://openstapps.gitlab.io/core/classes/_index.d_.screquestbodytoolargeerrorresponse.html)<br>[SCSyntaxErrorResponse](https://openstapps.gitlab.io/core/classes/_index.d_.scsyntaxerrorresponse.html)<br>[SCUnsupportedMediaTypeErrorResponse](https://openstapps.gitlab.io/core/classes/_index.d_.scunsupportedmediatypeerrorresponse.html)<br>[SCValidationErrorResponse](https://openstapps.gitlab.io/core/classes/_index.d_.scvalidationerrorresponse.html) |
+
+## `POST /` [Index route](https://openstapps.gitlab.io/core/classes/_index.d_.scindexroute.html)
+
+**Route to request meta information about the deployment**
+
+### Definition
+
+| parameter    | value                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
+| ------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| request      | [SCIndexRequest](https://openstapps.gitlab.io/core/interfaces/_index.d_.scindexrequest.html)                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
+| response     | [SCIndexResponse](https://openstapps.gitlab.io/core/interfaces/_index.d_.scindexresponse.html)                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
+| success code | 200                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
+| errors       | [SCInternalServerErrorResponse](https://openstapps.gitlab.io/core/classes/_index.d_.scinternalservererrorresponse.html)<br>[SCMethodNotAllowedErrorResponse](https://openstapps.gitlab.io/core/classes/_index.d_.scmethodnotallowederrorresponse.html)<br>[SCRequestBodyTooLargeErrorResponse](https://openstapps.gitlab.io/core/classes/_index.d_.screquestbodytoolargeerrorresponse.html)<br>[SCSyntaxErrorResponse](https://openstapps.gitlab.io/core/classes/_index.d_.scsyntaxerrorresponse.html)<br>[SCUnsupportedMediaTypeErrorResponse](https://openstapps.gitlab.io/core/classes/_index.d_.scunsupportedmediatypeerrorresponse.html)<br>[SCValidationErrorResponse](https://openstapps.gitlab.io/core/classes/_index.d_.scvalidationerrorresponse.html) |
+
+## `POST /search/multi` [Multi search route](https://openstapps.gitlab.io/core/classes/_index.d_.scmultisearchroute.html)
+
+**Route for submission of multiple search requests at once**
+
+### Definition
+
+| parameter    | value                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
+| ------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| request      | [SCMultiSearchRequest](https://openstapps.gitlab.io/core/modules/_index.d_.html#scmultisearchrequest)                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
+| response     | [SCMultiSearchResponse](https://openstapps.gitlab.io/core/modules/_index.d_.html#scmultisearchresponse)                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
+| success code | 200                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
+| errors       | [SCInternalServerErrorResponse](https://openstapps.gitlab.io/core/classes/_index.d_.scinternalservererrorresponse.html)<br>[SCMethodNotAllowedErrorResponse](https://openstapps.gitlab.io/core/classes/_index.d_.scmethodnotallowederrorresponse.html)<br>[SCRequestBodyTooLargeErrorResponse](https://openstapps.gitlab.io/core/classes/_index.d_.screquestbodytoolargeerrorresponse.html)<br>[SCSyntaxErrorResponse](https://openstapps.gitlab.io/core/classes/_index.d_.scsyntaxerrorresponse.html)<br>[SCTooManyRequestsErrorResponse](https://openstapps.gitlab.io/core/classes/_index.d_.sctoomanyrequestserrorresponse.html)<br>[SCUnsupportedMediaTypeErrorResponse](https://openstapps.gitlab.io/core/classes/_index.d_.scunsupportedmediatypeerrorresponse.html)<br>[SCValidationErrorResponse](https://openstapps.gitlab.io/core/classes/_index.d_.scvalidationerrorresponse.html) |
+
+## `POST /plugin/register` [Plugin register route](https://openstapps.gitlab.io/core/classes/_index.d_.scpluginregisterroute.html)
+
+**Route to register plugins**
+
+### Definition
+
+| parameter    | value                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
+| ------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| request      | [SCPluginRegisterRequest](https://openstapps.gitlab.io/core/modules/_index.d_.html#scpluginregisterrequest)                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
+| response     | [SCPluginRegisterResponse](https://openstapps.gitlab.io/core/interfaces/_index.d_.scpluginregisterresponse.html)                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
+| success code | 200                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
+| errors       | [SCInternalServerErrorResponse](https://openstapps.gitlab.io/core/classes/_index.d_.scinternalservererrorresponse.html)<br>[SCMethodNotAllowedErrorResponse](https://openstapps.gitlab.io/core/classes/_index.d_.scmethodnotallowederrorresponse.html)<br>[SCNotFoundErrorResponse](https://openstapps.gitlab.io/core/classes/_index.d_.scnotfounderrorresponse.html)<br>[SCParametersNotAcceptable](https://openstapps.gitlab.io/core/classes/_index.d_.scparametersnotacceptable.html)<br>[SCPluginAlreadyRegisteredErrorResponse](https://openstapps.gitlab.io/core/classes/_index.d_.scpluginalreadyregisterederrorresponse.html)<br>[SCPluginRegisteringFailedErrorResponse](https://openstapps.gitlab.io/core/classes/_index.d_.scpluginregisteringfailederrorresponse.html)<br>[SCRequestBodyTooLargeErrorResponse](https://openstapps.gitlab.io/core/classes/_index.d_.screquestbodytoolargeerrorresponse.html)<br>[SCSyntaxErrorResponse](https://openstapps.gitlab.io/core/classes/_index.d_.scsyntaxerrorresponse.html) |
+
+## `POST /search` [Search route](https://openstapps.gitlab.io/core/classes/_index.d_.scsearchroute.html)
+
+**Route for searching things**
+
+### Definition
+
+| parameter    | value                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
+| ------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| request      | [SCSearchRequest](https://openstapps.gitlab.io/core/interfaces/_index.d_.scsearchrequest.html)                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
+| response     | [SCSearchResponse](https://openstapps.gitlab.io/core/interfaces/_index.d_.scsearchresponse.html)                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
+| success code | 200                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
+| errors       | [SCInternalServerErrorResponse](https://openstapps.gitlab.io/core/classes/_index.d_.scinternalservererrorresponse.html)<br>[SCMethodNotAllowedErrorResponse](https://openstapps.gitlab.io/core/classes/_index.d_.scmethodnotallowederrorresponse.html)<br>[SCRequestBodyTooLargeErrorResponse](https://openstapps.gitlab.io/core/classes/_index.d_.screquestbodytoolargeerrorresponse.html)<br>[SCSyntaxErrorResponse](https://openstapps.gitlab.io/core/classes/_index.d_.scsyntaxerrorresponse.html)<br>[SCUnsupportedMediaTypeErrorResponse](https://openstapps.gitlab.io/core/classes/_index.d_.scunsupportedmediatypeerrorresponse.html)<br>[SCValidationErrorResponse](https://openstapps.gitlab.io/core/classes/_index.d_.scvalidationerrorresponse.html) |
+
+## `PUT /:TYPE/:UID` [Thing update route](https://openstapps.gitlab.io/core/classes/_index.d_.scthingupdateroute.html)
+
+**Route for updating existing things**
+
+### Definition
+
+| parameter             | value                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
+| --------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| request               | [SCThingUpdateRequest](https://openstapps.gitlab.io/core/modules/_index.d_.html#scthingupdaterequest)                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
+| response              | [SCThingUpdateResponse](https://openstapps.gitlab.io/core/interfaces/_index.d_.scthingupdateresponse.html)                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
+| success code          | 200                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
+| errors                | [SCInternalServerErrorResponse](https://openstapps.gitlab.io/core/classes/_index.d_.scinternalservererrorresponse.html)<br>[SCMethodNotAllowedErrorResponse](https://openstapps.gitlab.io/core/classes/_index.d_.scmethodnotallowederrorresponse.html)<br>[SCNotFoundErrorResponse](https://openstapps.gitlab.io/core/classes/_index.d_.scnotfounderrorresponse.html)<br>[SCRequestBodyTooLargeErrorResponse](https://openstapps.gitlab.io/core/classes/_index.d_.screquestbodytoolargeerrorresponse.html)<br>[SCSyntaxErrorResponse](https://openstapps.gitlab.io/core/classes/_index.d_.scsyntaxerrorresponse.html)<br>[SCUnsupportedMediaTypeErrorResponse](https://openstapps.gitlab.io/core/classes/_index.d_.scunsupportedmediatypeerrorresponse.html)<br>[SCValidationErrorResponse](https://openstapps.gitlab.io/core/classes/_index.d_.scvalidationerrorresponse.html) |
+| obligatory parameters | <table><tr><th>parameter</th><th>type</th></tr><tr><td>TYPE</td><td>SCThingTypes</td></tr><tr><td>UID</td><td>[SCUuid](https://openstapps.gitlab.io/core/modules/_index.d_.html#scuuid)</td></tr></table>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |

backend/backend/app.js

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+import './lib/cli.js';

backend/backend/config/b-tu/elasticsearchrc.js

@@ -0,0 +1,20 @@
+// @ts-check
+
+/**
+ * This is the database configuration for the technical university of berlin
+ *
+ * @type {import('@openstapps/logger').RecursivePartial<import('../../src/storage/elasticsearch/types/elasticsearch-config.js').ElasticsearchConfigFile>}
+ */
+const config = {
+  internal: {
+    database: {
+      name: 'elasticsearch',
+      query: {
+        minMatch: '60%',
+        queryType: 'query_string',
+      },
+    },
+  },
+};
+
+export default config;

backend/backend/config/default/app/index.js

@@ -0,0 +1,27 @@
+import userGroupSetting from './user-group-setting.js';
+import languageSetting from './language-setting.js';
+import menus from './menu.js';
+
+/** @type {import('@openstapps/core').SCAppConfiguration} */
+const app = {
+  aboutPages: {},
+  campusPolygon: {
+    coordinates: [
+      [
+        [8.660_432_999_690_723, 50.123_027_017_044_436],
+        [8.675_496_285_518_358, 50.123_027_017_044_436],
+        [8.675_496_285_518_358, 50.130_661_764_486_42],
+        [8.660_432_999_690_723, 50.130_661_764_486_42],
+        [8.660_432_999_690_723, 50.123_027_017_044_436],
+      ],
+    ],
+    type: 'Polygon',
+  },
+  features: {},
+  menus,
+  name: 'Goethe-Uni',
+  privacyPolicyUrl: 'https://mobile.server.uni-frankfurt.de/_static/privacy.md',
+  settings: [userGroupSetting, languageSetting],
+};
+
+export default app;

backend/backend/config/default/app/language-setting.js

@@ -0,0 +1,34 @@
+// @ts-check
+import {SCSettingInputType, SCThingOriginType, SCThingType} from '@openstapps/core';
+
+/** @type {import('@openstapps/core').SCLanguageSetting}  */
+const languageSetting = {
+  categories: ['profile'],
+  defaultValue: 'en',
+  description: 'The language this app is going to use.',
+  inputType: SCSettingInputType.SingleChoice,
+  name: 'language',
+  order: 0,
+  origin: {
+    indexed: '2018-09-11T12:30:00Z',
+    name: 'SCConfigFile Default Values',
+    type: SCThingOriginType.Remote,
+  },
+  translations: {
+    de: {
+      description: 'Die Sprache in der die App angezeigt wird.',
+      name: 'Sprache',
+      values: ['Deutsch', 'English'],
+    },
+    en: {
+      description: 'The language this app is going to use.',
+      name: 'Language',
+      values: ['Deutsch', 'English'],
+    },
+  },
+  type: SCThingType.Setting,
+  uid: 'dc9d6dec-6576-45ef-9e35-3598c0d6a662',
+  values: ['de', 'en'],
+};
+
+export default languageSetting;

backend/backend/config/default/app/menu.js

@@ -0,0 +1,195 @@
+// @ts-check
+/** @type {import('@openstapps/core').SCAppConfigurationMenuCategory[]} */
+const menus = [
+  {
+    icon: 'home',
+    items: [
+      {
+        icon: 'newspaper',
+        route: '/news',
+        title: 'news',
+        translations: {
+          de: {
+            title: 'Aktuelles',
+          },
+          en: {
+            title: 'news',
+          },
+        },
+      },
+      {
+        icon: 'search',
+        route: '/search',
+        title: 'search',
+        translations: {
+          de: {
+            title: 'Suche',
+          },
+          en: {
+            title: 'search',
+          },
+        },
+      },
+      {
+        icon: 'local_library',
+        route: '/hebis-search',
+        title: 'library catalog',
+        translations: {
+          de: {
+            title: 'Bibliothekskatalog',
+          },
+          en: {
+            title: 'library catalog',
+          },
+        },
+      },
+      {
+        icon: 'inventory_2',
+        route: '/catalog',
+        title: 'course catalog',
+        translations: {
+          de: {
+            title: 'Vorlesungsverzeichnis',
+          },
+          en: {
+            title: 'course catalog',
+          },
+        },
+      },
+    ],
+    title: 'overview',
+    route: '/overview',
+    translations: {
+      de: {
+        title: 'Übersicht',
+      },
+      en: {
+        title: 'overview',
+      },
+    },
+  },
+  {
+    icon: 'local_cafe',
+    items: [],
+    route: '/canteen',
+    title: 'canteen',
+    translations: {
+      de: {
+        title: 'Mensa',
+      },
+      en: {
+        title: 'canteen',
+      },
+    },
+  },
+  {
+    icon: 'map',
+    items: [],
+    route: '/map',
+    title: 'campus map',
+    translations: {
+      de: {
+        title: 'Campus Karte',
+      },
+      en: {
+        title: 'campus map',
+      },
+    },
+  },
+  {
+    icon: 'school',
+    items: [
+      {
+        icon: 'grade',
+        route: '/favorites',
+        title: 'favorites',
+        translations: {
+          de: {
+            title: 'Favoriten',
+          },
+          en: {
+            title: 'favorites',
+          },
+        },
+      },
+      {
+        icon: 'calendar_today',
+        route: '/schedule',
+        title: 'schedule',
+        translations: {
+          de: {
+            title: 'Stundenplan',
+          },
+          en: {
+            title: 'schedule',
+          },
+        },
+      },
+      {
+        authProvider: 'paia',
+        icon: 'badge',
+        route: '/library-account',
+        title: 'library account',
+        translations: {
+          de: {
+            title: 'Bibliothekskonto',
+          },
+          en: {
+            title: 'library account',
+          },
+        },
+      },
+      {
+        icon: 'settings',
+        route: '/settings',
+        title: 'settings',
+        translations: {
+          de: {
+            title: 'Einstellungen',
+          },
+          en: {
+            title: 'settings',
+          },
+        },
+      },
+      {
+        icon: 'rate_review',
+        route: '/feedback',
+        title: 'feedback',
+        translations: {
+          de: {
+            title: 'Feedback',
+          },
+          en: {
+            title: 'feedback',
+          },
+        },
+      },
+      {
+        icon: 'info',
+        route: '/about',
+        title: 'about',
+        translations: {
+          de: {
+            title: 'Über die App',
+          },
+          en: {
+            title: 'About the App',
+          },
+        },
+      },
+    ],
+    title: 'my app',
+    route: '/profile',
+    translations: {
+      de: {
+        title: 'Meine App',
+      },
+      en: {
+        title: 'my app',
+      },
+    },
+  },
+];
+
+export default menus;

backend/backend/config/default/app/user-group-setting.js

@@ -0,0 +1,40 @@
+// @ts-check
+import {SCSettingInputType, SCThingOriginType, SCThingType} from '@openstapps/core';
+
+/** @type {import('@openstapps/core').SCUserGroupSetting} */
+const userGroupSetting = {
+  categories: ['profile'],
+  defaultValue: 'students',
+  description:
+    'The user group the app is going to be used.' +
+    'This settings for example is getting used for the predefined price category of mensa meals.',
+  inputType: SCSettingInputType.SingleChoice,
+  name: 'group',
+  order: 1,
+  origin: {
+    indexed: '2018-09-11T12:30:00Z',
+    name: 'SCConfigFile Default Values',
+    type: SCThingOriginType.Remote,
+  },
+  translations: {
+    de: {
+      description:
+        'Mit welcher Benutzergruppe soll die App verwendet werden?' +
+        ' Die Einstellung wird beispielsweise für die Vorauswahl der Preiskategorie der Mensa verwendet.',
+      name: 'Gruppe',
+      values: ['Studierende', 'Angestellte', 'Gäste'],
+    },
+    en: {
+      description:
+        'The user group the app is going to be used.' +
+        ' This settings for example is getting used for the predefined price category of mensa meals.',
+      name: 'Group',
+      values: ['students', 'employees', 'guests'],
+    },
+  },
+  type: SCThingType.Setting,
+  uid: '2c97aa36-4aa2-43de-bc5d-a2b2cb3a530e',
+  values: ['students', 'employees', 'guests'],
+};
+
+export default userGroupSetting;

backend/backend/config/default/backend/aggregations.js

@@ -0,0 +1,51 @@
+// @ts-check
+import {SCThingType} from '@openstapps/core';
+
+/** @type {import('@openstapps/core').SCBackendAggregationConfiguration[]} */
+const aggregations = [
+  {
+    fieldName: 'categories',
+    onlyOnTypes: [
+      SCThingType.AcademicEvent,
+      SCThingType.Article,
+      SCThingType.Building,
+      SCThingType.Catalog,
+      SCThingType.Dish,
+      SCThingType.PointOfInterest,
+      SCThingType.Room,
+    ],
+  },
+  {
+    fieldName: 'inPlace.name',
+    onlyOnTypes: [
+      SCThingType.DateSeries,
+      SCThingType.Dish,
+      SCThingType.Floor,
+      SCThingType.Organization,
+      SCThingType.PointOfInterest,
+      SCThingType.Room,
+      SCThingType.Ticket,
+    ],
+  },
+  {
+    fieldName: 'academicTerms.acronym',
+    onlyOnTypes: [SCThingType.AcademicEvent, SCThingType.SportCourse],
+  },
+  {
+    fieldName: 'academicTerm.acronym',
+    onlyOnTypes: [SCThingType.Catalog],
+  },
+  {
+    fieldName: 'majors',
+    onlyOnTypes: [SCThingType.AcademicEvent],
+  },
+  {
+    fieldName: 'keywords',
+    onlyOnTypes: [SCThingType.Article, SCThingType.Book, SCThingType.Message, SCThingType.Video],
+  },
+  {
+    fieldName: 'type',
+  },
+];
+
+export default aggregations;

backend/backend/config/default/backend/boostings.js

@@ -0,0 +1,103 @@
+// @ts-check
+import {
+  month,
+  sommerRange,
+  ssAcronymLong,
+  ssAcronymShort,
+  winterRange,
+  wsAcronymLong,
+  wsAcronymShort,
+} from '../tools/semester-acronym.js';
+import {SCThingType} from '@openstapps/core';
+
+/** @type {import('@openstapps/core').SCBackendConfigurationSearchBoostingContext} */
+const boostings = {
+  default: [
+    {
+      factor: 1,
+      fields: {
+        'academicTerms.acronym': {
+          [ssAcronymShort]: sommerRange.includes(month) ? 1.1 : 1.05,
+          [wsAcronymShort]: winterRange.includes(month) ? 1.1 : 1.05,
+          [ssAcronymLong]: sommerRange.includes(month) ? 1.1 : 1.05,
+          [wsAcronymLong]: winterRange.includes(month) ? 1.1 : 1.05,
+        },
+      },
+      type: SCThingType.AcademicEvent,
+    },
+    {
+      factor: 1,
+      fields: {
+        categories: {
+          'course': 1.08,
+          'integrated course': 1.08,
+          'introductory class': 1.05,
+          'lecture': 1.1,
+          'seminar': 1.01,
+          'tutorial': 1.05,
+        },
+      },
+      type: SCThingType.AcademicEvent,
+    },
+    {
+      factor: 1.6,
+      type: SCThingType.Building,
+    },
+    {
+      factor: 1,
+      fields: {
+        categories: {
+          cafe: 1.1,
+          learn: 1.1,
+          library: 1.2,
+          restaurant: 1.1,
+        },
+      },
+      type: SCThingType.PointOfInterest,
+    },
+    {
+      factor: 1,
+      fields: {
+        categories: {
+          'main dish': 2,
+        },
+      },
+      type: SCThingType.Dish,
+    },
+  ],
+  dining: [
+    {
+      factor: 1,
+      fields: {
+        categories: {
+          'cafe': 2,
+          'canteen': 2,
+          'restaurant': 2,
+          'restroom': 1.2,
+          'student canteen': 2,
+        },
+      },
+      type: SCThingType.Building,
+    },
+    {
+      factor: 2,
+      type: SCThingType.Dish,
+    },
+  ],
+  place: [
+    {
+      factor: 2,
+      type: SCThingType.Building,
+    },
+    {
+      factor: 2,
+      type: SCThingType.PointOfInterest,
+    },
+    {
+      factor: 2,
+      type: SCThingType.Room,
+    },
+  ],
+};
+
+export default boostings;

backend/backend/config/default/backend/index.js

@@ -0,0 +1,73 @@
+// @ts-check
+import {SCThingType} from '@openstapps/core';
+import aggregations from './aggregations.js';
+import boostings from './boostings.js';
+import {readFile} from 'fs/promises';
+
+/** @type {import('@openstapps/core').SCBackendInternalConfiguration} */
+export const internal = {
+  aggregations,
+  boostings,
+};
+
+/** @type {import('@openstapps/core').SCBackendConfiguration} */
+export const backend = {
+  SCVersion: JSON.parse(await readFile('package.json', 'utf8')).version,
+  externalRequestTimeout: 5000,
+  hiddenTypes: [SCThingType.DateSeries, SCThingType.Diff, SCThingType.Floor],
+  mappingIgnoredTags: ['minlength', 'pattern', 'see', 'tjs-format'],
+  maxMultiSearchRouteQueries: 5,
+  maxRequestBodySize: 512 * 1024,
+  name: 'Goethe-Universität Frankfurt am Main',
+  namespace: '909a8cbc-8520-456c-b474-ef1525f14209',
+  sortableFields: [
+    {
+      fieldName: 'name',
+      sortTypes: ['ducet'],
+    },
+    {
+      fieldName: 'type',
+      sortTypes: ['ducet'],
+    },
+    {
+      fieldName: 'categories',
+      onlyOnTypes: [
+        SCThingType.AcademicEvent,
+        SCThingType.Building,
+        SCThingType.Catalog,
+        SCThingType.Dish,
+        SCThingType.PointOfInterest,
+        SCThingType.Room,
+      ],
+      sortTypes: ['ducet'],
+    },
+    {
+      fieldName: 'geo',
+      onlyOnTypes: [SCThingType.Building, SCThingType.PointOfInterest, SCThingType.Room],
+      sortTypes: ['distance'],
+    },
+    {
+      fieldName: 'geo',
+      onlyOnTypes: [SCThingType.Building, SCThingType.PointOfInterest, SCThingType.Room],
+      sortTypes: ['distance'],
+    },
+    {
+      fieldName: 'inPlace.geo',
+      onlyOnTypes: [
+        SCThingType.DateSeries,
+        SCThingType.Dish,
+        SCThingType.Floor,
+        SCThingType.Organization,
+        SCThingType.PointOfInterest,
+        SCThingType.Room,
+        SCThingType.Ticket,
+      ],
+      sortTypes: ['distance'],
+    },
+    {
+      fieldName: 'offers',
+      onlyOnTypes: [SCThingType.Dish],
+      sortTypes: ['price'],
+    },
+  ],
+};

backend/backend/config/default/backendrc.js

@@ -0,0 +1,26 @@
+// @ts-check
+import app from './app/index.js';
+import {backend, internal} from './backend/index.js';
+
+/**
+ * This is the default configuration for app and backend
+ *
+ * University-specific files can be created with the following naming scheme: default-<university license plate>.ts
+ *
+ * To select your university-specific configuration which is merged from this default file and your university-specific
+ * file, you have to supply the `NODE_APP_INSTANCE` environment variable with your license plate
+ *
+ * To get more information about the meaning of specific fields, please have a look at `@openstapps/core` or use your
+ * IDE to read the TSDoc documentation.
+ *
+ * @type {import('@openstapps/core').SCConfigFile}
+ */
+const config = {
+  app,
+  auth: {},
+  backend,
+  internal,
+  uid: 'f-u',
+};
+
+export default config;

backend/backend/config/default/elasticsearchrc.js

@@ -0,0 +1,33 @@
+// @ts-check
+
+/**
+ * This is the default configuration for elasticsearch (a database)
+ *
+ * To select your university-specific configuration which is merged from this default file and your university-specific
+ * file, you have to supply the `NODE_APP_INSTANCE` environment variable with your license plate
+ *
+ * To select a different database, you have to supply the `NODE_CONFIG_ENV` environment variable with a database name
+ * that is implemented in the backend
+ *
+ * To get more information about the meaning of specific fields, please use your IDE to read the TSDoc documentation.
+ *
+ * @type {import('../../src/storage/elasticsearch/types/elasticsearch-config.js')}
+ */
+const config = {
+  internal: {
+    database: {
+      name: 'elasticsearch',
+      version: '5.6',
+      query: {
+        minMatch: '75%',
+        queryType: 'dis_max',
+        matchBoosting: 1.3,
+        fuzziness: 'AUTO',
+        cutoffFrequency: 0,
+        tieBreaker: 0,
+      },
+    },
+  },
+};
+
+export default config;

backend/backend/config/default/prometheusrc.json

@@ -0,0 +1,9 @@
+{
+  "metricsPath": "/metrics",
+  "includeMethod": true,
+  "includePath": true,
+  "promClient": {
+    "collectDefaultMetrics": {}
+  },
+  "for-more-options-see": "https://github.com/jochen-schweizer/express-prom-bundle#options"
+}

backend/backend/config/default/tools/markdown.js

@@ -0,0 +1,29 @@
+// @ts-check
+import {readFile} from 'fs/promises';
+import {SCAboutPageContentType} from '@openstapps/core';
+
+/**
+ * Usage:
+ *
+ * ```js
+ * await markdown('./page.md', import.meta.url)
+ * ```
+ *
+ * @param {string} path relative path to the file, omitting the language marker
+ * @param {string | URL} base base path, usually import.meta.url
+ * @returns {Promise<import('@openstapps/core').SCAboutPageMarkdown>}
+ */
+export async function markdown(path, base) {
+  const de = await readFile(new URL(path.replace(/\.md$/, '.de.md'), base), 'utf8');
+  const en = await readFile(new URL(path.replace(/\.md$/, '.en.md'), base), 'utf8');
+
+  return {
+    value: de,
+    translations: {
+      en: {
+        value: en,
+      },
+    },
+    type: SCAboutPageContentType.MARKDOWN,
+  };
+}

backend/backend/config/default/tools/semester-acronym.js

@@ -0,0 +1,34 @@
+// @ts-check
+/**
+ * Generates a range of numbers that represent consecutive calendar months
+ *
+ * @param {number} startMonth The month to start with (inclusive)
+ * @param {number} endMonth The month to end with (inclusive)
+ * @returns {number[]}
+ */
+export function yearSlice(startMonth, endMonth) {
+  let months = [...Array.from({length: 13}).keys()].slice(1);
+  months = [...months, ...months];
+  if (!months.includes(startMonth) || !months.includes(endMonth)) {
+    throw new Error(`Given months not part of a year! Check ${startMonth} or ${endMonth}!`);
+  }
+
+  const startIndex = months.indexOf(startMonth);
+  const endIndex =
+    months.indexOf(endMonth) <= startIndex ? months.lastIndexOf(endMonth) : months.indexOf(endMonth);
+
+  return months.slice(startIndex, endIndex + 1);
+}
+
+export const sommerRange = yearSlice(3, 8);
+export const winterRange = yearSlice(9, 2);
+export const month = new Date().getMonth();
+export const year = new Date().getFullYear();
+export const winterYearOffset = month < winterRange[0] ? -1 : 0;
+export const sommerYear = year + (month <= winterRange[winterRange.length] ? -1 : 0);
+export const winterYear = `${year + winterYearOffset}/${(year + 1 + winterYearOffset).toString().slice(-2)}`;
+
+export const wsAcronymShort = `WS ${winterYear}`;
+export const ssAcronymShort = `SS ${sommerYear}`;
+export const wsAcronymLong = `WiSe ${winterYear}`;
+export const ssAcronymLong = `SoSe ${sommerYear}`;

backend/backend/config/f-u/about-pages/about.de.md

@@ -0,0 +1,7 @@
+Open StApps bietet Studierenden aller beteiligten Hochschulen eine qualitativ
+hochwertige App für den Studienalltag. Open StApps-Verbundpartner integrieren
+generalisierbare Studierendenprozesse so in App-Module, dass diese auch
+von anderen Hochschulen verwendet werden können. Die in der Open StApps App
+verwendeten Daten einer Datenquelle sind in einem generalisierten Datenmodell
+so aufbereitet, dass ein Austausch oder Abschaltung der Datenquelle problemlos möglich
+ist und die Open StApps App problemlos weiterhin funktionsfähig bleibt.

backend/backend/config/f-u/about-pages/about.en.md

@@ -0,0 +1,6 @@
+Open StApps provides students from all participating universities with a
+high-quality app for everyday study. Open StApps partners integrate
+generalizable student processes into app modules in such a way that they can be
+used by other universities. The data of a data source used in the Open StApps app
+is prepared in a generalized data model in a way that the data source can be easily
+exchanged or switched off while the app continues to function without any problems.

backend/backend/config/f-u/about-pages/about.js

@@ -0,0 +1,126 @@
+// @ts-check
+import {SCAboutPageContentType} from '@openstapps/core';
+import {markdown} from '../../default/tools/markdown.js';
+
+/** @type {import('@openstapps/core').SCAboutPage} */
+export const about = {
+  title: 'Über Open StApps',
+  content: [
+    {
+      title: 'Verbundprojekt mehrerer Hochschulen für eine generische Studierenden-App',
+      content: await markdown('./about.md', import.meta.url),
+      translations: {
+        en: {
+          title: 'Collaborative project of multiple universities for a single generic study app',
+        },
+      },
+      type: SCAboutPageContentType.SECTION,
+    },
+    {
+      title: 'Goethe-Uni Kontakt',
+      content: {
+        rows: [
+          [
+            {
+              value: 'Adresse',
+              translations: {
+                en: {
+                  value: 'Address',
+                },
+              },
+              type: SCAboutPageContentType.MARKDOWN,
+            },
+            {
+              // language=Markdown
+              value:
+                'Goethe Universität<br>' +
+                'Hochschulrechenzentrum (HRZ)<br>' +
+                'Norbert-Wollheim-Platz 1<br>' +
+                '60629 Frankfurt',
+              translations: {},
+              type: SCAboutPageContentType.MARKDOWN,
+            },
+          ],
+          [
+            {
+              value: 'Kontaktinformation',
+              translations: {
+                en: {
+                  value: 'Contact information',
+                },
+              },
+              type: SCAboutPageContentType.MARKDOWN,
+            },
+            {
+              // language=Markdown
+              value:
+                '[app@rz.uni-frankfurt.de](mailto:app@rz.uni-frankfurt.de)<br>' +
+                '[+49 69 798 32936](tel:+496979832936)<br>' +
+                '[https://app.rz.uni-frankfurt.de](https://app.rz.uni-frankfurt.de)',
+              translations: {},
+              type: SCAboutPageContentType.MARKDOWN,
+            },
+          ],
+        ],
+        type: SCAboutPageContentType.TABLE,
+      },
+      translations: {
+        en: {
+          title: 'Goethe-Uni Contact',
+        },
+      },
+      type: SCAboutPageContentType.SECTION,
+    },
+    {
+      icon: 'newspaper',
+      title: 'Neue Funktionen / Gelöste Probleme',
+      link: 'changelog',
+      translations: {
+        en: {
+          title: 'New features / Resolved issues',
+        },
+      },
+      type: SCAboutPageContentType.ROUTER_LINK,
+    },
+    {
+      icon: 'description',
+      title: 'Impressum',
+      link: 'imprint',
+      translations: {
+        en: {
+          title: 'Imprint',
+        },
+      },
+      type: SCAboutPageContentType.ROUTER_LINK,
+    },
+    {
+      icon: 'policy',
+      title: 'Datenschutz',
+      link: 'privacy',
+      translations: {
+        en: {
+          title: 'Privacy policy',
+        },
+      },
+      type: SCAboutPageContentType.ROUTER_LINK,
+    },
+    {
+      icon: 'copyright',
+      title: 'Bibliotheken und Lizenzen',
+      link: 'licenses',
+      translations: {
+        en: {
+          title: 'Libraries and licenses',
+        },
+      },
+      type: SCAboutPageContentType.ROUTER_LINK,
+    },
+  ],
+  translations: {
+    en: {
+      title: 'About Open StApps',
+    },
+  },
+};
+
+export default about;

backend/backend/config/f-u/about-pages/imprint.js

@@ -0,0 +1,27 @@
+// @ts-check
+import {SCAboutPageContentType} from '@openstapps/core';
+
+/** @type {import('@openstapps/core').SCAboutPage} */
+export const imprint = {
+  title: 'Impressum',
+  content: [
+    {
+      // language=Markdown
+      value: `[Impressum der Johann Wolfgang Goethe-Universität Frankfurt am Main](https://www.uni-frankfurt.de/impressum)`,
+      translations: {
+        en: {
+          // language=Markdown
+          value: `[Imprint of the Goethe University Frankfurt](https://www.uni-frankfurt.de/impressum)`,
+        },
+      },
+      type: SCAboutPageContentType.MARKDOWN,
+    },
+  ],
+  translations: {
+    en: {
+      title: 'Imprint',
+    },
+  },
+};
+
+export default imprint;

backend/backend/config/f-u/about-pages/index.js

@@ -0,0 +1,13 @@
+// @ts-check
+import about from './about.js';
+import imprint from './imprint.js';
+import privacy from './privacy.js';
+
+/** @type {import('@openstapps/core').SCMap<import('@openstapps/core').SCAboutPage>} */
+const aboutPages = {
+  'about': about,
+  'about/imprint': imprint,
+  'about/privacy': privacy,
+};
+
+export default aboutPages;

backend/backend/config/f-u/about-pages/privacy.de.md

@@ -0,0 +1,166 @@
+# Datenschutzerklärung
+
+## Kontaktdaten des Verantwortlichen
+
+Verantwortlich im Sinne der Datenschutz-Grundverordnung und weiterer Vorschriften zum Datenschutz ist die:
+
+Johann Wolfgang Goethe-Universität Frankfurt am Main vertreten durch ihren Präsidenten<br />
+Theodor-W.-Adorno-Platz 1<br />
+60323 Frankfurt am Main
+
+Postanschrift:<br />
+Goethe-Universität Frankfurt am Main<br />
+60629 Frankfurt
+
+Website: http://www.uni-frankfurt.de
+
+## Kontaktdaten der Datenschutzbeauftragten an der Goethe-Universität
+
+Sie erreichen die behördlichen Datenschutzbeauftragten der Johann Wolfgang Goethe-Universität Frankfurt am Main unter:<br />
+Mail: <dsb@uni-frankfurt.de><br />
+Website: http://www.uni-frankfurt.de/47859992/datenschutzbeauftragte
+
+## Informationen zur Verarbeitung personenbezogener Daten
+
+### <u>1. Umfang der Verarbeitung personenbezogener Daten</u>
+
+Personenbezogene Daten sind gemäß Artikel 4 DSGVO alle Informationen, die sich auf eine identifizierte oder identifizierbare natürliche Person beziehen.
+
+Wir verarbeiten personenbezogene Daten von Ihnen als Nutzer:innen der Goethe-Uni-App, soweit dies zur Bereitstellung einer **funktionsfähigen Applikation** technisch erforderlich ist.
+
+Weiterhin kann eine Datenverarbeitung auf Ihrer freiwilligen Einwilligung basieren, wenn Sie **spezifische Funktionen** nutzen möchten.
+
+Wir unterscheiden daher nachfolgend zwischen
+
+- Zugriffsdaten bei der Nutzung der App: Inhalt der Anfragen, IP-Adressen, Datum/Uhrzeit der Anfrage, Angefragte URL, Fehlermeldungen, Browser-Kennung, HTTP-Header
+
+- Standortbestimmung und Navigation: freiwillige Standortangaben
+
+- Nutzer:inneneinstellungen: freiwillige Angabe von a) Sprachpräferenzen (derzeit: deutsch/englisch), b) Status (z. B. Gast/Student) oder c) spezifischen Suchanfragen und Suchergebnissen (Notifications)
+
+- Kalenderfunktion: freiwillige Nutzung der Kalenderfunktion (optional mit freiwilliger Nutzung einer Synchronisationsfunktion: Opt-in) oder der integrierten Stundenplanfunktion, hierbei werden folgende Daten auf dem Endgerät verarbeitet und gespeichert: Termine und Veranstaltungen
+
+- Feedbackfunktion und Kontaktaufnahme: freiwillige Nutzung mit der Angabe von Kontaktdaten und ggf. freiwilliger Übermittlung von Protokolldaten
+
+- Campus Dienste: freiwillige Nutzung mit Verarbeitung von Notenansicht, Matrikelnummer, E-Mailadresse, Name
+
+- Funktionen der Bibliothek: freiwillige Nutzung mit Verarbeitung von Bibliothekskontodaten, wie z.B. Ausweisnummer mit Name, E-Mailadresse, postalischer Adresse, Nutzungsberechtigung, Bestelldaten, Gebühren, Vormerkung, Ausleihdaten. Die vollständigen Angaben zur Verarbeitung finden Sie in der Datenschutzerklärung der Bibliothek:<br />
+  https://www.ub.uni-frankfurt.de/benutzung/datenschutz.html
+
+Die App verlinkt an einigen Stellen auf die Website der Goethe-Universität sowie auf andere, externe Websites, die in einem In-App-Browser dargestellt werden. Wir bitten Sie bei Aufruf dieser Websites, die dort geltenden gesonderte Datenschutzhinweise und Erklärungen zu beachten.
+
+### <u>2. Zweck(e) der Datenverarbeitung</u>
+
+**Zugriff auf Standortdaten**
+
+Für die Navigation benötigt die Goethe-Uni-App Zugriff auf den Standort des verwendeten Endgerätes (Location Based Services). Bei einer Anfrage erhebt die App den aktuellen Standort über GPS, Funkzellendaten und WLAN-Datenbanken, um Ihnen als Nutzer:in Informationen zu Ihrer unmittelbaren Umgebung geben zu können. Der Zugriff auf die Standortdaten erfolgt nur, wenn Sie den Zugriff auf die Standortdaten erlauben. Daten zu Ihrem Standort werden ausschließlich für die Bearbeitung von standortbezogenen Anfragen genutzt und um Ihren Standort auf der Karte anzuzeigen.
+
+**Zugriff auf Zugriffsdaten**
+
+Die Speicherung und Verarbeitung von Protokolldateien erfolgt, um die Funktionsfähigkeit der Goethe Uni-App für Sie sicherzustellen. Zudem benötigen wir die die Daten aus Gründen der Sicherheit unserer informationstechnischen Systeme. Eine anderweitige Auswertung oder Weitergabe findet in diesem Zusammenhang nicht statt.
+
+**Zugriff auf Spracheinstellungen**
+
+Der Zugriff auf die Spracheinstellung erfolgt um Ihnen die Oberfläche der App in der von Ihnen gewünschten Sprache anzuzeigen.
+
+**Zugriff auf die Einstellung der Statusgruppe**
+
+Der Zugriff auf die Einstellung der Statusgruppe erfolgt um Ihnen in der App die für Ihre Gruppe zutreffenden Informationen anzuzeigen, z.B. Mensapreise
+
+**Zugriff auf personenbezogene Daten bei der Nutzung der Feedbackfunktion**
+
+Die Verarbeitung der personenbezogenen Daten aus der Feedbackfunktion dient uns zur Kontaktaufnahme und Fehlerbehebung.
+
+**Zugriff auf personenbezogene Daten bei der Kalendersynchronisation**
+
+Der Zugriff auf die Termindaten erfolgt um sie bei aktivierter Kalenderfunktion in den Gerätekalender zu schreiben.
+
+**Zugriff auf Daten der Campus Dienste**
+
+Der Zugriff auf das Campus Management Systems erfolgt ausschließlich um persönliche Daten der Studierendenverwaltung in der App anzuzeigen (z.B. Prüfungsnoten).
+
+**Zugriff auf bibliotheksspezifische personenbezogene Daten**
+
+Der Zugriff auf die Daten (z.B. Ausweisnummer, Name, Postanschrift) erfolgt zur Durchführung von Bestell- und Ausleihverfahren von Büchern und sonstigen Materialien der Universitätsbibliothek. Die vollständigen Angaben zu den Verarbeitungszwecken finden Sie in der Datenschutzerklärung der Bibliothek: https://www.ub.uni-frankfurt.de/benutzung/datenschutz.html
+
+### <u>3. Rechtsgrundlage(n) für die Datenverarbeitung</u>
+
+Die Nutzung der Nutzungs-/Zugriffsdaten („Protokolldateien") basiert auf Artikel 6 Absatz 1 lit. f) DSGVO.
+
+Für alle spezifischen Funktionen, bei denen die Datenverarbeitung auf Ihrer freiwilligen Einwilligung als Nutzer:innen basiert, werden explizit Einwilligungen bzw. aktive Zustimmungsakte („Opt-In") eingeholt. Die Bereitstellung personenbezogener Daten zu Ihrer Person gegenüber der Goethe-Universität erfolgen dabei auf freiwilliger Basis. Die Rechtsgrundlage ist in diesen Fällen jeweils Artikel 6 Absatz 1 lit. a) DSGVO. Sie können Ihre jeweilige Einwilligung jederzeit einzeln widerrufen bzw. Ihre Einstellungen ändern.
+
+### <u>4. Datenlöschung und Speicherdauer</u>
+
+Die in den Protokolldateien der App erfassten Daten werden sieben Tage nach dem Ende des Zugriffs automatisch gelöscht oder anonymisiert.
+
+Die Löschfristen bzw. Speicherdauer der in den Bibliotheksystemen erfassten Daten finden Sie in der Datenschutzerklärung der Bibliothek: https://www.ub.uni-frankfurt.de/benutzung/datenschutz.html
+
+Für alle anderen Funktionen und Dienste gilt: Die Löschung erfolgt hier je nach Vorgabe des genutzten Dienstes. Die personenbezogenen Daten der betroffenen Person werden gelöscht oder gesperrt, sobald der Zweck der Speicherung entfällt.
+
+### <u>5. Datenweitergabe/Datenübermittlung</u>
+
+Ihre personenbezogenen Daten werden von uns nicht an Dritte weitergegeben.
+
+Von Betreiberseite wird durch technische und organisatorische Maßnahmen sichergestellt, dass Dritte keinen Zugriff auf die verarbeiteten Daten, wie z. B. Nutzungsdaten, erhalten. Ein Auftragsverarbeitungsverhältnis nach Art. 28 DSGVO besteht nicht, da ausschließlich eigene Server verwendet werden.
+
+### <u>6. Automatisierte Entscheidungsfindung</u>
+
+Eine automatisierte Entscheidungsfindung einschließlich Profiling erfolgt nicht.
+
+## Rechte der betroffenen Person
+
+Werden personenbezogene Daten von Ihnen verarbeitet, sind Sie Betroffener im Sinne der DSGVO. Die Geltendmachung Ihrer Betroffenenrechte ist kostenfrei. Sie können sich dafür selbstverständlich an uns wenden. Es stehen Ihnen folgende Betroffenenrechte gegenüber der Goethe-Universität zu:
+
+### <u>1. Auskunftsrecht</u>
+
+Sie können von uns als verantwortlicher Stelle eine Bestätigung darüber verlangen, ob und welche Ihrer personenbezogenen Daten von uns verarbeitet werden. Sie haben das Recht, von uns Kopien Ihrer personenbezogenen Daten zu verlangen. Bitte beachten Sie die Ausnahmen, die sich durch spezifische Vorschriften ergeben können.
+
+### <u>2. Recht auf Berichtigung</u>
+
+Sie haben das Recht von uns die Berichtigung und/oder Vervollständigung zu verlangen, sofern die verarbeiteten personenbezogenen Daten, die Sie betreffen, nicht (mehr) richtig oder nicht (mehr) vollständig sind.
+
+### <u>3. Recht auf Einschränkung der Verarbeitung</u>
+
+Unter bestimmten Voraussetzungen können Sie die Einschränkung der Verarbeitung der Sie betreffenden personenbezogenen Daten verlangen, d. h. dass dann Ihre personenbezogenen Daten zwar nicht gelöscht, aber gekennzeichnet werden, so dass eine weitere Verarbeitung eingeschränkt ist.
+
+### <u>4. Recht auf Löschung</u>
+
+Sie können unter bestimmten Voraussetzungen von uns verlangen, dass die Sie betreffenden personenbezogenen Daten unverzüglich gelöscht werden. Dies ist insbesondere der Fall, wenn die personenbezogenen Daten zu dem Zweck, zu dem sie ursprünglich erhoben oder verarbeitet wurden, nicht mehr erforderlich sind.
+
+### <u>5. Recht auf Unterrichtung</u>
+
+Haben Sie das Recht auf Berichtigung, Löschung oder Einschränkung der Verarbeitung uns gegenüber geltend gemacht, sind wir verpflichtet, allen Empfänger/innen, denen die Sie betreffenden personenbezogenen Daten offengelegt wurden, diese Berichtigung oder Löschung der Daten oder Einschränkung der Verarbeitung mitzuteilen, es sei denn, dies erweist sich als unmöglich oder ist mit einem unverhältnismäßigen Aufwand verbunden. Sie sind berechtigt, über diese Empfänger unterrichtet zu werden.
+
+### <u>6. Recht auf Datenübertragbarkeit</u>
+
+Sie haben unter bestimmten Voraussetzungen das Recht von uns zu verlangen, dass Ihre personenbezogenen Daten von uns direkt an einen anderen Verantwortlichen oder an eine andere Organisation übermittelt werden. Alternativ haben Sie unter bestimmten Voraussetzungen das Recht von uns zu verlangen, dass wir Ihnen selbst die Daten in einem maschinenlesbaren Format bereitstellen.
+
+### <u>7. Widerspruchsrecht</u>
+
+Wenn wir Ihre personenbezogenen Daten verarbeiten, weil die Verarbeitung im öffentlichen Interesse, Teil unserer öffentlichen Aufgaben ist bzw. wenn wir Ihre Daten auf Basis eines berechtigten Interesses verarbeiten, haben Sie aus Gründen, die sich aus Ihrer besonderen Situation ergeben, das Recht, jederzeit der Verarbeitung der Sie betreffenden Daten zu widersprechen.
+
+### <u>8. Recht auf Widerruf der datenschutzrechtlichen Einwilligungserklärung</u>
+
+Wenn wir Ihre personenbezogenen Daten verarbeiten, weil Sie uns Ihre Einwilligung gegeben haben, haben Sie jederzeit das Recht, Ihre Einwilligungserklärung zu widerrufen.
+
+### <u>9. Recht auf Beschwerde bei einer Aufsichtsbehörde</u>
+
+Sie haben ferner das Recht auf Beschwerde bei einer Aufsichtsbehörde. Die zuständige Aufsichtsbehörde wird Ihre Beschwerde prüfen.
+
+## **Kontaktdaten der Aufsichtsbehörde im Bereich Datenschutz**
+
+Wenn Sie der Ansicht sind, dass eine Verarbeitung der Sie betreffenden personenbezogenen Daten gegen Datenschutzvorschriften verstößt, wenn Sie eine allgemeine Anfrage haben oder wenn Sie sich bei einer zuständigen Fachaufsichtsbehörde beschweren wollen, können Sie sich an den Hessischen Beauftragten für Datenschutz und Informationsfreiheit (HBDI) wenden.
+
+**Der Hessische Beauftragte für Datenschutz und Informationsfreiheit ist auf unterschiedlichen Wegen erreichbar:**
+
+<u>**Der Hessische Beauftragte für Datenschutz und Informationsfreiheit**</u><br />
+Postfach 3163<br />
+65021 Wiesbaden
+
+Telefon: +49 611 1408 -- 0
+
+Für allgemeine Anfragen können Sie ein Kontaktformular nutzen:<br />
+<https://datenschutz.hessen.de/kontakt><br />
+<br />
+Für Beschwerden steht Ihnen zudem ein Beschwerdeformular zur Verfügung:<br />
+<https://datenschutz.hessen.de/service/beschwerde-uebermitteln>

backend/backend/config/f-u/about-pages/privacy.en.md

@@ -0,0 +1,166 @@
+# Privacy policy
+
+## Contact details of the person responsible
+
+Responsible in the sense of the General Data Protection Regulation and further regulations on data protection is the:
+
+Johann Wolfgang Goethe-Universität Frankfurt am Main represented by its president<br />
+Theodor-W.-Adorno-Platz 1<br />
+60323 Frankfurt am Main
+
+Postanschrift:<br />
+Goethe-Universität Frankfurt am Main<br />
+60629 Frankfurt
+
+Website: http://www.uni-frankfurt.de
+
+## Contact details of the data protection officer at Goethe University
+
+You can reach the data protection officers at Johann Wolfgang Goethe University Frankfurt am Main at:<br />
+Mail: <dsb@uni-frankfurt.de><br />
+Website: http://www.uni-frankfurt.de/47859992/datenschutzbeauftragte
+
+## Information on the processing of personal data
+
+### <u>1. Scope of the processing of personal data</u>.
+
+According to Article 4 DSGVO, personal data is any information relating to an identified or identifiable natural person.
+
+We process personal data of you as a user inside of the Goethe University App to the extent that this is technically necessary for the provision of a **functional application**.
+
+Furthermore, data processing may be based on your voluntary consent if you wish to use **specific functions**.
+
+We therefore distinguish below between
+
+- Access data when using the app: content of requests, IP addresses, date/time of request, requested URL, error codes, browser identifier, HTTP header.
+
+- Location and navigation: voluntary location information
+
+- User settings: voluntary specification of a) language preferences (currently: German/English), b) status (e.g. guest/student) or c) specific search queries and search results (notifications)
+
+- Calendar function: voluntary use of the calendar function (optional with voluntary use of a sync function: opt-in) or the integrated timetable function. The following data is processed and stored on the users device: appointments and events
+
+- Feedback function and contacting: voluntary use with the provision of contact data and, if applicable, voluntary transmission of log data
+
+- Campus services: voluntary use with processing of grade view, matriculation number, email address, name
+
+- Services of the library: voluntary use with processing of library account data, such as ID number with name, e-mail address, postal address, right of use, order data, fees, reservation, loan data. Full details of processing can be found in the library's privacy policy:<br />
+  https://www.ub.uni-frankfurt.de/benutzung/datenschutz.html
+
+In some places, the app links to the Goethe University website and to other external websites that are displayed in an in-app browser. When you visit these websites, we ask you to pay attention to the separate data protection notices and declarations that apply there.
+
+### <u>2. Purpose(s) of data processing</u>
+
+**Access to location data**.
+
+For navigation, the Goethe University app requires access to the location of the end device used (location-based services). When a request is made, the app collects the current location via GPS, radio cell data and WLAN databases in order to be able to give you as a user:in information about your immediate surroundings. The location data is only accessed if you allow access to the location data. Data about your location is only used to process location-related requests and to display your location on the map.
+
+**Access to access data**.
+
+Log files are stored and processed to ensure that the Goethe Uni app functions properly for you. In addition, we need the data for reasons of security of our information technology systems. No other evaluation or disclosure takes place in this context.
+
+**Access to language settings**.
+
+Access to the language setting is made in order to display the interface of the app in the language of your choice.
+
+**Access to the status group setting**.
+
+Access to the status group setting is provided to show you the information in the app that applies to your group, e.g. canteen prices.
+
+**Access to personal data when using the feedback function**.
+
+We use the processing of personal data from the feedback function to contact you and troubleshoot problems.
+
+**Access to personal data when synchronizing calendars**.
+
+Appointment data is accessed in order to write it to the device calendar when the calendar function is enabled.
+
+**Access to Campus Services data**.
+
+Access to the Campus Management System is solely for the purpose of displaying personal student management data in the app (e.g., exam grades).
+
+**Access to library-specific personal data**.
+
+Access to data (e.g., ID number, name, mailing address) is for the purpose of carrying out ordering and borrowing procedures for books and other materials from the University Library. Full details of the purposes of processing can be found in the Library's Privacy Policy: https://www.ub.uni-frankfurt.de/benutzung/datenschutz.html
+
+### <u>3. Rechtsgrundlage(n) für die Datenverarbeitung</u>
+
+The use of usage/access data ("log files") is based on Article 6(1)(f) DSGVO.
+
+For all specific functions where data processing is based on your voluntary consent as a user:in, explicit consent or active acts of consent ("opt-in") are obtained. The provision of personal data about you to Goethe University is done on a voluntary basis. The legal basis in each of these cases is Article 6 (1) a) DSGVO. You can individually revoke your respective consent or change your settings at any time.
+
+### <u>4. Data deletion and storage duration</u>
+
+The data collected in the log files of the app are automatically deleted or anonymized seven days after the end of the access.
+
+The deletion periods or storage duration of the data collected in the library systems can be found in the library's privacy policy: https://www.ub.uni-frankfurt.de/benutzung/datenschutz.html
+
+For all other functions and services, the following applies: deletion takes place here depending on the specifications of the service used. The personal data of the data subject will be deleted or blocked as soon as the purpose of the storage no longer applies.
+
+### <u>5. Data disclosure/data transfer</u>
+
+We will not pass on your personal data to third parties.
+
+On the part of the operator, technical and organizational measures are taken to ensure that third parties do not gain access to the processed data, such as usage data. An order processing relationship according to Art. 28 DSGVO does not exist, as only our own servers are used.
+
+### <u>6. Automated decision-making</u>
+
+Automated decision-making, including profiling, does not take place.
+
+## Rights of the data subject
+
+If personal data is processed by you, you are a data subject within the meaning of the GDPR. The assertion of your data subject rights is free of charge. You can, of course, contact us for this purpose. You are entitled to the following data subject rights vis-à-vis Goethe University:
+
+### <u>1. Right of access</u>
+
+You can request confirmation from us as the controller as to whether and which of your personal data is being processed by us. You have the right to request copies of your personal data from us. Please note the exceptions that may arise due to specific regulations.
+
+### <u>2. Right of rectification</u>
+
+You have the right to request us to rectify and/or complete, if the processed personal data concerning you is not (anymore) accurate or not (anymore) complete.
+
+### <u>3. Right to restriction of processing</u>
+
+Under certain conditions, you can request the restriction of the processing of personal data concerning you, i.e. that your personal data is then not deleted, but marked so that further processing is restricted.
+
+### <u>4. Right to erasure</u>
+
+Under certain conditions, you can demand that we delete the personal data concerning you without delay. This is particularly the case if the personal data is no longer necessary for the purpose for which it was originally collected or processed.
+
+### <u>5. Right to information</u>
+
+If you have asserted the right to rectification, erasure or restriction of processing against us, we are obliged to inform all recipients to whom the personal data concerning you have been disclosed of this rectification or erasure of the data or restriction of processing, unless this proves impossible or involves a disproportionate effort. You are entitled to be informed about these recipients.
+
+### <u>6. Right to data portability</u>
+
+Under certain conditions, you have the right to request that we transfer your personal data directly to another controller or organization. Alternatively, under certain conditions, you have the right to request that we ourselves provide you with the data in a machine-readable format.
+
+### <u>7. Right to object</u>
+
+If we process your personal data because the processing is in the public interest, part of our public duties, or if we process your data on the basis of a legitimate interest, you have the right to object at any time to the processing of data relating to you for reasons arising from your particular situation.
+
+### <u>8. Right to revoke the declaration of consent under data protection law</u>
+
+If we process your personal data because you have given us your consent, you have the right to revoke your declaration of consent at any time.
+
+### <u>9. Right to lodge a complaint with a supervisory authority</u>
+
+You also have the right to lodge a complaint with a supervisory authority. The competent supervisory authority will examine your complaint.
+
+## **Contact details of the supervisory authority in the area of data protection**
+
+If you believe that the processing of your personal data violates data protection regulations, if you have a general inquiry or if you want to complain to a competent supervisory authority, you can contact the Hessian Commissioner for Data Protection and Freedom of Information (HBDI).
+
+**The Hessian Commissioner for Data Protection and Freedom of Information can be reached in different ways:**
+
+<u>**The Hessian Commissioner for Data Protection and Freedom of Information**</u><br />
+PO Box 3163<br />
+65021 Wiesbaden
+
+Telephone: +49 611 1408 -- 0
+
+For general inquiries you can use a contact form:<br />
+<https://datenschutz.hessen.de/kontakt><br />
+<br />
+A complaint form is also available for complaints:<br />
+<https://datenschutz.hessen.de/service/beschwerde-uebermitteln>

backend/backend/config/f-u/about-pages/privacy.js

@@ -0,0 +1,15 @@
+// @ts-check
+import {markdown} from '../../default/tools/markdown.js';
+
+/** @type {import('@openstapps/core').SCAboutPage} */
+export const privacy = {
+  title: 'Datenschutz',
+  content: [await markdown('./privacy.md', import.meta.url)],
+  translations: {
+    en: {
+      title: 'Privacy Policy',
+    },
+  },
+};
+
+export default privacy;

backend/backend/config/f-u/backendrc.js

@@ -0,0 +1,82 @@
+// @ts-check
+import aboutPages from './about-pages/index.js';
+import defaultApp from '../default/app/index.js';
+import {backend as defaultBackend, internal as defaultInternal} from '../default/backend/index.js';
+
+/**
+ * This is the default configuration for the Goethe university of Frankfurt
+ *
+ * @type {import('@openstapps/core').SCConfigFile}
+ */
+const config = {
+  auth: {
+    default: {
+      client: {
+        clientId: '1cac3f99-33fa-4234-8438-979f07e0cdab',
+        scopes: '',
+        url: 'https://cas.rz.uni-frankfurt.de/cas/oauth2.0',
+      },
+      endpoints: {
+        authorization: 'https://cas.rz.uni-frankfurt.de/cas/oauth2.0/authorize',
+        endSession: 'https://cas.rz.uni-frankfurt.de/cas/logout',
+        mapping: {
+          id: '$.id',
+          email: '$.attributes.mailPrimaryAddress',
+          familyName: '$.attributes.sn',
+          givenName: '$.attributes.givenName',
+          name: '$.attributes.givenName',
+          role: '$.attributes.eduPersonPrimaryAffiliation',
+          studentId: '$.attributes.employeeNumber',
+        },
+        token: 'https://cas.rz.uni-frankfurt.de/cas/oauth2.0/accessToken',
+        userinfo: 'https://cas.rz.uni-frankfurt.de/cas/oauth2.0/profile',
+      },
+    },
+    paia: {
+      client: {
+        clientId: '',
+        scopes: '',
+        url: 'https://hds.hebis.de/Shibboleth.sso/UBFFM?target=https://hds.hebis.de/ubffm/paia_login_stub.php',
+      },
+      endpoints: {
+        authorization:
+          'https://hds.hebis.de/Shibboleth.sso/UBFFM?target=https://hds.hebis.de/ubffm/paia_login_stub.php',
+        endSession: 'https://ubffm.hds.hebis.de/Shibboleth.sso/Logout',
+        mapping: {
+          id: '$.email',
+          name: '$.name',
+          role: '$.type',
+        },
+        token: 'https://hds.hebis.de/paia/auth/login',
+        userinfo: 'https://hds.hebis.de/paia/core',
+      },
+    },
+  },
+  app: {
+    ...defaultApp,
+    features: {
+      extern: {
+        hisometry: {
+          authProvider: 'default',
+          url: 'https://his-self-service.rz.uni-frankfurt.de',
+        },
+        daia: {
+          url: 'https://daia.hebis.de/DAIA2/UB_Frankfurt',
+        },
+        hebisProxy: {
+          url: 'https://proxy.ub.uni-frankfurt.de/login?qurl=',
+        },
+        paia: {
+          authProvider: 'paia',
+          url: 'https://hds.hebis.de/paia/core',
+        },
+      },
+    },
+    aboutPages,
+  },
+  backend: defaultBackend,
+  internal: defaultInternal,
+  uid: 'f-u',
+};
+
+export default config;

backend/backend/integration-test.sh

@@ -0,0 +1,22 @@
+ES_HOST="elasticsearch"
+BACKEND_HOST="localhost"
+if [ -z $GITLAB_CI ]; then
+    ES_HOST=localhost
+fi
+
+( STAPPS_LOG_LEVEL=31 STAPPS_EXIT_LEVEL=8 NODE_CONFIG_ENV=elasticsearch NODE_ENV=integration-test ALLOW_NO_TRANSPORT=true ES_ADDR=http://$ES_HOST:9200 node app.js ) & backend_pid=$!
+( openstapps-api e2e http://$BACKEND_HOST:3000 --reportPath coverage/integration-report-junit.xml --waiton tcp:$BACKEND_HOST:3000 --samples node_modules/@openstapps/core/test/resources/indexable ) & api_cli_pid=$!
+
+## Check output codes
+# api-cli output defines passing the test
+# backend should not exit early
+
+wait $api_cli_pid
+api_cli_exit=$?
+wait $backend_pid
+backend_exit=$?
+
+if [ "$api_cli_exit" -eq "0" ]; then
+   echo "FINISHED";
+   exit;
+fi

backend/backend/package.json

@@ -0,0 +1,128 @@
+{
+  "name": "@openstapps/backend",
+  "description": "A reference implementation for a StApps backend",
+  "version": "3.0.0-next.0",
+  "private": true,
+  "type": "module",
+  "license": "AGPL-3.0-only",
+  "author": "André Bierlein <andre.mt.bierlein@gmail.com>",
+  "contributors": [
+    "Anselm Stordeur <anselmstordeur@gmail.com>",
+    "Benjamin Jöckel",
+    "Jovan Krunić <jovan.krunic@gmail.com>",
+    "Karl-Philipp Wulfert <krlwlfrt@gmail.com>",
+    "Michel Jonathan Schmitz",
+    "Rainer Killinger <mail-openstapps@killinger.co>",
+    "Sebastian Lange",
+    "Thea Schöbl <dev@theaninova.de>"
+  ],
+  "main": "lib/app.js",
+  "bin": "app.js",
+  "files": [
+    "app.js",
+    "lib",
+    "config",
+    "Dockerfile",
+    "README.md",
+    "ROUTES.md",
+    "CHANGELOG.md"
+  ],
+  "scripts": {
+    "build": "tsup-node",
+    "build:docker": "docker build -t openstapps:backend ../../.deploy/backend",
+    "deploy": "pnpm --prod --filter=@openstapps/backend deploy ../../.deploy/backend",
+    "dev": "tsup --watch --onSuccess \"pnpm run start\"",
+    "docs": "openapi build-docs ./node_modules/@openstapps/core/lib/openapi.json -o docs/openapi/index.html",
+    "format": "prettier . -c --ignore-path ../../.gitignore",
+    "format:fix": "prettier --write . --ignore-path ../../.gitignore",
+    "lint": "tsc --noEmit && eslint --ext .ts src/",
+    "lint:fix": "eslint --fix --ext .ts src/",
+    "start": "cross-env NODE_CONFIG_ENV=elasticsearch ALLOW_NO_TRANSPORT=true node app.js",
+    "start:debug": "cross-env STAPPS_LOG_LEVEL=31 NODE_CONFIG_ENV=elasticsearch ALLOW_NO_TRANSPORT=true node app.js",
+    "test": "pnpm run test:unit",
+    "test:integration": "sh integration-test.sh",
+    "test:unit": "cross-env NODE_CONFIG_ENV=elasticsearch ALLOW_NO_TRANSPORT=true STAPPS_LOG_LEVEL=0 mocha --exit"
+  },
+  "dependencies": {
+    "@elastic/elasticsearch": "8.4.0",
+    "@openstapps/core": "workspace:*",
+    "@openstapps/core-tools": "workspace:*",
+    "@openstapps/logger": "workspace:*",
+    "@types/body-parser": "1.19.2",
+    "@types/cors": "2.8.13",
+    "@types/express": "4.17.17",
+    "@types/geojson": "1.0.6",
+    "@types/node": "18.15.3",
+    "@types/node-cron": "3.0.7",
+    "@types/nodemailer": "6.4.7",
+    "@types/promise-queue": "2.2.0",
+    "@types/uuid": "8.3.4",
+    "body-parser": "1.20.2",
+    "cors": "2.8.5",
+    "cosmiconfig": "8.1.3",
+    "express": "4.18.2",
+    "express-prom-bundle": "6.6.0",
+    "express-promise-router": "4.1.1",
+    "got": "12.6.0",
+    "moment": "2.29.4",
+    "morgan": "1.10.0",
+    "nock": "13.3.1",
+    "node-cache": "5.1.2",
+    "node-cron": "3.0.2",
+    "nodemailer": "6.9.1",
+    "prom-client": "14.1.1",
+    "promise-queue": "2.2.5",
+    "uuid": "8.3.2"
+  },
+  "devDependencies": {
+    "@openstapps/api-cli": "workspace:*",
+    "@openstapps/eslint-config": "workspace:*",
+    "@openstapps/prettier-config": "workspace:*",
+    "@openstapps/tsconfig": "workspace:*",
+    "@testdeck/mocha": "0.3.3",
+    "@types/chai": "4.3.5",
+    "@types/chai-as-promised": "7.1.5",
+    "@types/mocha": "10.0.1",
+    "@types/morgan": "1.9.4",
+    "@types/sinon": "10.0.14",
+    "@types/sinon-express-mock": "1.3.9",
+    "@types/supertest": "2.0.12",
+    "c8": "7.14.0",
+    "chai": "4.3.7",
+    "chai-as-promised": "7.1.1",
+    "cross-env": "7.0.3",
+    "get-port": "5.1.1",
+    "mocha": "10.2.0",
+    "mocha-junit-reporter": "2.2.0",
+    "mocked-env": "1.3.5",
+    "openapi": "1.0.1",
+    "redoc-cli": "0.13.20",
+    "sinon": "15.0.4",
+    "sinon-express-mock": "2.2.1",
+    "supertest": "6.3.3",
+    "ts-node": "10.9.1",
+    "tsup": "6.7.0",
+    "typescript": "4.9.5"
+  },
+  "tsup": {
+    "entry": [
+      "src/cli.ts"
+    ],
+    "sourcemap": true,
+    "clean": true,
+    "target": "es2022",
+    "format": "esm",
+    "outDir": "lib"
+  },
+  "prettier": "@openstapps/prettier-config",
+  "eslintConfig": {
+    "extends": [
+      "@openstapps"
+    ]
+  },
+  "openstapps-configuration": {
+    "overrides": [
+      "test"
+    ]
+  }
+}

backend/backend/src/app.ts

@@ -0,0 +1,226 @@
+/*
+ * Copyright (C) 2019 StApps
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as
+ * published by the Free Software Foundation, either version 3 of the
+ * License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program.  If not, see <https://www.gnu.org/licenses/>.
+ */
+import {
+  SCNotFoundErrorResponse,
+  SCRequestBodyTooLargeErrorResponse,
+  SCSyntaxErrorResponse,
+  SCUnsupportedMediaTypeErrorResponse,
+} from '@openstapps/core';
+import {Logger} from '@openstapps/logger';
+import cors from 'cors';
+import {Express} from 'express';
+import morgan from 'morgan';
+import path from 'path';
+import {DEFAULT_TIMEOUT, isTestEnvironment, mailer, plugins, validator} from './common.js';
+import {getPrometheusMiddleware} from './middleware/prometheus.js';
+import {MailQueue} from './notification/mail-queue.js';
+import {bulkAddRouter} from './routes/bulk-add-route.js';
+import {bulkDoneRouter} from './routes/bulk-done-route.js';
+import {bulkRouter} from './routes/bulk-route.js';
+import {indexRouter} from './routes/index-route.js';
+import {multiSearchRouter} from './routes/multi-search-route.js';
+import {pluginRegisterRouter} from './routes/plugin-register-route.js';
+import {searchRouter} from './routes/search-route.js';
+import {thingUpdateRouter} from './routes/thing-update-route.js';
+import {virtualPluginRoute} from './routes/virtual-plugin-route.js';
+import {BulkStorage} from './storage/bulk-storage.js';
+import {DatabaseConstructor} from './storage/database.js';
+import {backendConfig} from './config.js';
+import {fileURLToPath} from 'url';
+
+/**
+ * Configure the backend
+ */
+export async function configureApp(app: Express, databases: {[name: string]: DatabaseConstructor}) {
+  let integrationTestTimeout: NodeJS.Timeout;
+  // request loggers have to be the first middleware to be set in express
+  app.use(
+    morgan('dev', {
+      skip: (_request, response) => {
+        if (process.env.NODE_ENV === 'integration-test') {
+          clearTimeout(integrationTestTimeout);
+          integrationTestTimeout = setTimeout(() => {
+            process.exit(1);
+          }, DEFAULT_TIMEOUT);
+
+          return false;
+        }
+
+        return response.statusCode < 400;
+      },
+      stream: process.stdout,
+    }),
+  );
+
+  /* istanbul ignore if */
+  if (process.env.PROMETHEUS_MIDDLEWARE === 'true') {
+    app.use(getPrometheusMiddleware());
+  }
+
+  const corsOptions = {
+    allowedHeaders: [
+      'DNT',
+      'Keep-Alive',
+      'User-Agent',
+      'X-Requested-With',
+      'If-Modified-Since',
+      'Cache-Control',
+      'Content-Type',
+      'X-StApps-Version',
+    ],
+    credentials: true,
+    maxAge: 1_728_000,
+    methods: ['GET', 'POST', 'PUT', 'OPTIONS'],
+    optionsSuccessStatus: 204,
+  };
+
+  // allow all origins on all routes
+  app.use(cors(corsOptions));
+  // TODO: See if it can handle options request with no content-type
+
+  // allow cors preflight requests on every route
+  app.options('*', [cors(corsOptions)]);
+
+  // only accept json as content-type for all requests
+  app.use((request, response, next) => {
+    // Only accept json as content-type
+    if (request.is('application/json') !== 'application/json') {
+      // return an error in the response
+      const error = new SCUnsupportedMediaTypeErrorResponse(isTestEnvironment);
+      response.status(error.statusCode);
+      response.json(error);
+
+      return;
+    }
+
+    const bodyBuffer: Buffer[] = [];
+    // we don't know the full size, the only way we can get is by adding up all individual chunk sizes
+    let bodySize = 0;
+    const chunkGatherer = (chunk: Buffer) => {
+      bodySize += chunk.byteLength;
+      // when adding each chunk size to the total size, check how large it now is.
+      if (bodySize > backendConfig.backend.maxRequestBodySize) {
+        request.off('data', chunkGatherer);
+        request.off('end', endCallback);
+        // return an error in the response
+        const error = new SCRequestBodyTooLargeErrorResponse(isTestEnvironment);
+        response.status(error.statusCode);
+        response.json(error);
+
+        return;
+      }
+      // push the chunk in the buffer
+      bodyBuffer.push(chunk);
+    };
+
+    const endCallback = () => {
+      request.body = Buffer.concat(bodyBuffer).toString();
+
+      try {
+        request.body = JSON.parse(request.body);
+        next();
+      } catch (error) {
+        const error_ = new SCSyntaxErrorResponse(error.message, isTestEnvironment);
+        response.status(error_.statusCode);
+        response.json(error_);
+
+        return;
+      }
+    };
+    request.on('data', chunkGatherer).on('end', endCallback);
+  });
+
+  // validate config file
+  const directory = path.dirname(fileURLToPath(import.meta.url));
+  await validator.addSchemas(
+    path.join(directory, '..', 'node_modules', '@openstapps', 'core', 'lib', 'schema'),
+  );
+
+  // validate the config file
+  const configValidation = validator.validate(backendConfig, 'SCConfigFile');
+
+  // validation failed
+  if (configValidation.errors.length > 0) {
+    throw new Error(
+      `Validation of config file failed. Errors were: ${JSON.stringify(configValidation.errors)}`,
+    );
+  }
+
+  // check if a database name was given
+  if (!backendConfig.internal.database?.name) {
+    throw new Error('You have to configure a database');
+  }
+
+  const database = new databases[backendConfig.internal.database.name](
+    backendConfig,
+    // mailQueue
+    mailer !== undefined && backendConfig.internal.monitoring ? new MailQueue(mailer) : undefined,
+  );
+
+  await database.init();
+
+  if (database === undefined) {
+    throw new TypeError('No implementation for configured database found. Please check your configuration.');
+  }
+
+  Logger.ok('Validated config file successfully');
+
+  // treats /foo and /foo/ as two different routes
+  // see http://expressjs.com/en/api.html#app.set
+  app.enable('strict routing');
+
+  // make the bulk storage available to all http middlewares/routes
+  app.set('bulk', new BulkStorage(database));
+
+  app.set('env', process.env.NODE_ENV);
+
+  // load routes before plugins
+  // they now can be used or overwritten by any plugin
+  app.use(
+    bulkAddRouter,
+    bulkDoneRouter,
+    bulkRouter,
+    indexRouter,
+    multiSearchRouter,
+    pluginRegisterRouter,
+    searchRouter,
+    thingUpdateRouter,
+  );
+
+  // for plugins, as Express doesn't really want you to unregister routes (and doesn't offer any method to do so at all)
+  app.all('*', async (request, response, next) => {
+    // if the route exists, call virtual route on the plugin that registered that route
+    if (plugins.has(request.originalUrl)) {
+      try {
+        response.json(await virtualPluginRoute(request, plugins.get(request.originalUrl)!));
+      } catch (error) {
+        // in case of an error: send an error response
+        response.status(error.statusCode);
+        response.json(error);
+      }
+    } else {
+      // pass to the next matching route (which is 404)
+      next();
+    }
+  });
+
+  // add a route for a missing resource (404)
+  app.use((_request, response) => {
+    const errorResponse = new SCNotFoundErrorResponse(isTestEnvironment);
+    response.status(errorResponse.statusCode);
+    response.json(errorResponse);
+  });
+}

backend/backend/src/cli.ts

@@ -0,0 +1,110 @@
+/*
+ * Copyright (C) 2019 StApps
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as
+ * published by the Free Software Foundation, either version 3 of the
+ * License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program.  If not, see <https://www.gnu.org/licenses/>.
+ */
+import {Logger} from '@openstapps/logger';
+import express from 'express';
+import http from 'http';
+import {configureApp} from './app.js';
+import {Elasticsearch} from './storage/elasticsearch/elasticsearch.js';
+
+const app = express();
+
+/**
+ * Get port from environment and store in Express.
+ */
+const port = normalizePort(process.env.PORT || '3000');
+
+/**
+ * Create HTTP server.
+ */
+const server = http.createServer(app);
+
+/**
+ * Define server handling for specific events
+ */
+server.on('error', onError);
+server.on('listening', onListening);
+
+/**
+ * Normalize a port into a number, string, or false.
+ */
+function normalizePort(value: string) {
+  const portNumber = Number.parseInt(value, 10);
+
+  if (Number.isNaN(portNumber)) {
+    // named pipe
+    return value;
+  }
+
+  if (portNumber >= 0) {
+    // port number
+    return portNumber;
+  }
+
+  return false;
+}
+
+/**
+ * Event listener for HTTP server "error" event.
+ */
+async function onError(error: {code: string; syscall: string}) {
+  if (error.syscall !== 'listen') {
+    throw error;
+  }
+
+  const bind = typeof port === 'string' ? `Pipe ${port}` : `Port ${port}`;
+
+  // handle specific listen errors with friendly messages
+  switch (error.code) {
+    case 'EACCES': {
+      await Logger.error(`${bind} requires elevated privileges`);
+      process.exit(1);
+      break;
+    }
+    case 'EADDRINUSE': {
+      await Logger.error(`${bind} is already in use`);
+      process.exit(1);
+      break;
+    }
+    default: {
+      throw error;
+    }
+  }
+}
+
+/**
+ * Event listener for HTTP server "listening" event.
+ */
+function onListening() {
+  const addr = server.address();
+
+  if (addr === null) {
+    void Logger.error(`Failed to start binding`);
+  } else {
+    const bind = typeof addr === 'string' ? `pipe ${addr}` : `port ${addr.port}`;
+    Logger.ok(`Listening on ${bind}`);
+  }
+}
+
+configureApp(app, {elasticsearch: Elasticsearch})
+  .then(() => {
+    Logger.ok('Successfully configured express server');
+    // After app setup listen on provided port, on all network interfaces
+    server.listen(port);
+  })
+  // eslint-disable-next-line unicorn/prefer-top-level-await
+  .catch(error => {
+    throw error;
+  });

backend/backend/src/common.ts

@@ -0,0 +1,43 @@
+/*
+ * Copyright (C) 2019 StApps
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as
+ * published by the Free Software Foundation, either version 3 of the
+ * License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program.  If not, see <https://www.gnu.org/licenses/>.
+ */
+import {SCPluginMetaData} from '@openstapps/core';
+import {Validator} from '@openstapps/core-tools';
+import {BackendTransport} from './notification/backend-transport.js';
+
+/**
+ * Instance of the transport for sending mails
+ */
+export const mailer = BackendTransport.getTransportInstance();
+
+/**
+ * A validator instance to check if something is a valid JSON object (e.g. a request or a thing)
+ */
+export const validator = new Validator();
+
+/**
+ * Provides information if the backend is executed in the "test" (non-production) environment
+ */
+export const isTestEnvironment = process.env.NODE_ENV !== 'production';
+
+/*
+ * Stores a ("key-value") list of plugins where key is route and value is plugin information
+ */
+export const plugins = new Map<string, SCPluginMetaData>();
+
+/**
+ * The default timeout in milliseconds
+ */
+export const DEFAULT_TIMEOUT = 20_000;

backend/backend/src/config.ts

@@ -0,0 +1,53 @@
+import {cosmiconfig, PublicExplorer} from 'cosmiconfig';
+import {SCConfigFile} from '@openstapps/core';
+import path from 'path';
+import deepmerge from 'deepmerge';
+
+const fallbackNamespace = 'default';
+const configPath = 'config';
+
+/**
+ * Creates a config loader
+ * @param moduleName the name of the config file (module)
+ */
+function configLoader(moduleName: string): PublicExplorer {
+  return cosmiconfig(moduleName, {
+    searchPlaces: ['js', 'json', 'yml', 'yaml'].map(it => `${moduleName}rc.${it}`),
+    loaders: {
+      '.js': filepath => import(`file://${filepath}`).then(it => it.default),
+    },
+  });
+}
+
+/**
+ * Find and load a config file
+ */
+async function findConfig<T>(moduleName: string, namespace = fallbackNamespace): Promise<T> {
+  return configLoader(moduleName)
+    .search(path.posix.join('.', configPath, namespace))
+    .then(it => it!.config as T)
+    .catch(() =>
+      configLoader(moduleName)
+        .search(path.posix.join('.', configPath, fallbackNamespace))
+        .then(it => it!.config),
+    );
+}
+
+/**
+ * Loads a config file
+ */
+async function loadConfig<T>(moduleName: string): Promise<T> {
+  const namespace = process.env.NODE_APP_INSTANCE;
+  const database = process.env.NODE_CONFIG_ENV;
+
+  const config = await findConfig<T>(moduleName, namespace);
+  if (database) {
+    const databaseConfig = await findConfig<T>(database, namespace);
+    return deepmerge(config, databaseConfig);
+  }
+
+  return config;
+}
+
+export const backendConfig = await loadConfig<SCConfigFile>('backend');
+export const prometheusConfig = await loadConfig<unknown>('prometheus');

backend/backend/src/environment.d.ts

@@ -0,0 +1,17 @@
+declare global {
+  namespace NodeJS {
+    // eslint-disable-next-line unicorn/prevent-abbreviations
+    interface ProcessEnv {
+      NODE_APP_INSTANCE: 'default' | 'b-tu' | 'f-u' | 'fb-fh' | 'ks-ug' | string | undefined;
+      NODE_CONFIG_ENV: 'elasticsearch' | string | undefined;
+      STAPPS_LOG_LEVEL: `${number}`;
+      ALLOW_NO_TRANSPORT: `${boolean}`;
+      PORT: `${number}`;
+      ES_DEBUG: `${boolean}`;
+      ES_ADDR: string;
+      PROMETHEUS_MIDDLEWARE: `${boolean}`;
+    }
+  }
+}
+
+export {};

backend/backend/src/middleware/prometheus.ts

@@ -0,0 +1,39 @@
+/*
+ * Copyright (C) 2021 StApps
+ * This program is free software: you can redistribute it and/or modify it
+ * under the terms of the GNU General Public License as published by the Free
+ * Software Foundation, version 3.
+ *
+ * This program is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
+ * more details.
+ *
+ * You should have received a copy of the GNU General Public License along with
+ * this program. If not, see <https://www.gnu.org/licenses/>.
+ */
+import {Logger} from '@openstapps/logger';
+import express_prom_bundle from 'express-prom-bundle';
+import fs from 'fs';
+import path from 'path';
+
+/**
+ * Create and configure a new Express Prometheus Middleware instance
+ *
+ * This function tries to configure the new instance with JSON read from
+ * `./conf/prometheus.json`. When this fails an instance configured with
+ * default options is returned.
+ * @returns express.Express
+ */
+export function getPrometheusMiddleware(): express_prom_bundle.Middleware {
+  const configFileName = path.join('./config', 'prometheus.json');
+  let options: express_prom_bundle.Opts = {};
+
+  try {
+    options = JSON.parse(fs.readFileSync(configFileName, 'utf8'));
+  } catch (error) {
+    Logger.warn("Couldn't get options from config file for Prometheus Middleware.", error);
+  }
+
+  return express_prom_bundle(options);
+}

backend/backend/src/notification/backend-transport.ts

@@ -0,0 +1,116 @@
+/*
+ * Copyright (C) 2019 StApps
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as
+ * published by the Free Software Foundation, either version 3 of the
+ * License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program.  If not, see <https://www.gnu.org/licenses/>.
+ */
+import {Logger, SMTP, Transport, VerifiableTransport} from '@openstapps/logger';
+
+/**
+ * Provides information if a transport is a verifiable transport
+ * @param instance A transport that needs to be checked
+ */
+export function isTransportWithVerification(instance: Transport): instance is VerifiableTransport {
+  return typeof (instance as VerifiableTransport).verify === 'function';
+}
+
+/**
+ * Singleton for getting only one transport service
+ *
+ * In the future this may support more than loading SMTP as a transport.
+ */
+export class BackendTransport {
+  /**
+   * One (and only one) instance of the backend transport
+   */
+  private static _instance?: BackendTransport;
+
+  /**
+   * Stores information if transport is in state of waiting for the verification
+   */
+  private waitingForVerification = false;
+
+  /**
+   * A (SMTP) transport which includes settings for sending mails
+   */
+  protected transport: SMTP | undefined;
+
+  /**
+   * Destroys the singleton instance of the class (for unit test purposes)
+   */
+  public static destroy() {
+    delete BackendTransport._instance;
+  }
+
+  /**
+   * Provides instance of a backend transport
+   */
+  public static getInstance(): BackendTransport {
+    if (BackendTransport._instance !== undefined) {
+      return BackendTransport._instance;
+    }
+
+    BackendTransport._instance = new BackendTransport();
+
+    return BackendTransport._instance;
+  }
+
+  /**
+   * Provides an instance of a transport
+   */
+  public static getTransportInstance(): SMTP | undefined {
+    return BackendTransport.getInstance().transport;
+  }
+
+  private constructor() {
+    // get SMTP instance for the time
+    // in the future we may implement some other transport services which can be selected
+    // via the configuration files
+    try {
+      this.transport = SMTP.getInstance();
+    } catch (error) {
+      if (process.env.ALLOW_NO_TRANSPORT === 'true') {
+        Logger.warn('SMTP error was ignored.');
+      } else {
+        throw error;
+      }
+    }
+
+    if (this.transport !== undefined && isTransportWithVerification(this.transport)) {
+      void this.verifyTransport(this.transport);
+    }
+  }
+
+  /**
+   * Verifies the transport using its verification method
+   */
+  private async verifyTransport(transport: VerifiableTransport): Promise<void> {
+    this.waitingForVerification = true;
+    try {
+      const successful = await transport.verify();
+      if (successful) {
+        Logger.log('SMTP verification successful.');
+      }
+    } catch (error) {
+      throw error;
+    } finally {
+      this.waitingForVerification = false;
+    }
+  }
+
+  /**
+   * Provides information if transport is in state of waiting for the verification
+   */
+  public isWaitingForVerification(): boolean {
+    return this.waitingForVerification;
+  }
+}

backend/backend/src/notification/mail-queue.ts

@@ -0,0 +1,111 @@
+/*
+ * Copyright (C) 2019 StApps
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as
+ * published by the Free Software Foundation, either version 3 of the
+ * License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program.  If not, see <https://www.gnu.org/licenses/>.nse along with
+ * this program. If not, see <https://www.gnu.org/licenses/>.
+ */
+import {Logger, SMTP} from '@openstapps/logger';
+import {MailOptions} from 'nodemailer/lib/sendmail-transport';
+import Queue from 'promise-queue';
+/**
+ * A queue that can send mails in serial
+ */
+export class MailQueue {
+  /**
+   * Number of allowed verification attempts after which the initialization of transport fails
+   */
+  static readonly MAX_VERIFICATION_ATTEMPTS = 5;
+
+  /**
+   * Number of milliseconds after which verification check should be repeated
+   */
+  static readonly VERIFICATION_TIMEOUT = 5000;
+
+  /**
+   * A queue that saves mails, before the transport is ready. When
+   * the transport gets ready this mails are getting pushed in to
+   * the normal queue.
+   */
+  dryQueue: MailOptions[];
+
+  /**
+   * A queue that saves mails, that are being sent in series
+   */
+  queue: Queue;
+
+  /**
+   * A counter for the number of verifications that failed
+   */
+  verificationCounter: number;
+
+  /**
+   * Creates a mail queue
+   * @param transport Transport which is used for sending mails
+   */
+  constructor(private readonly transport: SMTP) {
+    this.queue = new Queue(1);
+
+    // this queue saves all request when the transport is not ready yet
+    this.dryQueue = [];
+
+    this.verificationCounter = 0;
+
+    // if the transport can be verified it should check if it was done...
+    this.checkForVerification();
+  }
+
+  /**
+   * Adds a mail into the queue so it gets send when the queue is ready
+   * @param mail Information required for sending a mail
+   */
+  private async addToQueue(mail: MailOptions) {
+    return this.queue.add<string>(() => this.transport.sendMail(mail));
+  }
+
+  /**
+   * Verify the given transport
+   */
+  private checkForVerification() {
+    if (this.verificationCounter >= MailQueue.MAX_VERIFICATION_ATTEMPTS) {
+      throw new Error('Failed to initialize the SMTP transport for the mail queue');
+    }
+
+    if (this.transport.isVerified()) {
+      Logger.ok('Transport for mail queue was verified. We can send mails now');
+      // if the transport finally was verified send all our mails from the dry queue
+      for (const mail of this.dryQueue) {
+        void this.addToQueue(mail);
+      }
+    } else {
+      this.verificationCounter++;
+      setTimeout(() => {
+        Logger.warn('Transport not verified yet. Trying to send mails here...');
+        this.checkForVerification();
+      }, MailQueue.VERIFICATION_TIMEOUT);
+    }
+  }
+
+  /**
+   * Push a mail into the queue so it gets send when the queue is ready
+   * @param mail Information required for sending a mail
+   */
+  public async push(mail: MailOptions) {
+    if (this.transport.isVerified()) {
+      await this.addToQueue(mail);
+    } else {
+      // the transport has verification, but is not verified yet
+      // push to a dry queue which gets pushed to the real queue when the transport is verified
+      this.dryQueue.push(mail);
+    }
+  }
+}

backend/backend/src/routes/bulk-add-route.ts

@@ -0,0 +1,45 @@
+/*
+ * Copyright (C) 2019 StApps
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as
+ * published by the Free Software Foundation, either version 3 of the
+ * License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program.  If not, see <https://www.gnu.org/licenses/>.
+ */
+import {SCBulkAddRequest, SCBulkAddResponse, SCBulkAddRoute, SCNotFoundErrorResponse} from '@openstapps/core';
+import {Logger} from '@openstapps/logger';
+import {isTestEnvironment} from '../common.js';
+import {BulkStorage} from '../storage/bulk-storage.js';
+import {createRoute} from './route.js';
+
+/**
+ * Contains information for using the route for adding bulks
+ */
+const bulkRouteModel = new SCBulkAddRoute();
+
+/**
+ * Implementation of the bulk add route (SCBulkAddRoute)
+ */
+export const bulkAddRouter = createRoute<SCBulkAddRequest, SCBulkAddResponse>(
+  bulkRouteModel,
+  async (request, app, parameters) => {
+    const bulkMemory: BulkStorage = app.get('bulk');
+    const bulk = bulkMemory.read(parameters.UID);
+
+    if (bulk === undefined) {
+      Logger.warn(`Bulk with ${parameters.UID} not found.`);
+      throw new SCNotFoundErrorResponse(isTestEnvironment);
+    }
+
+    await bulkMemory.database.post(request, bulk);
+
+    return {};
+  },
+);

backend/backend/src/routes/bulk-done-route.ts

@@ -0,0 +1,51 @@
+/*
+ * Copyright (C) 2019 StApps
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as
+ * published by the Free Software Foundation, either version 3 of the
+ * License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program.  If not, see <https://www.gnu.org/licenses/>.
+ */
+import {
+  SCBulkDoneRequest,
+  SCBulkDoneResponse,
+  SCBulkDoneRoute,
+  SCNotFoundErrorResponse,
+} from '@openstapps/core';
+import {Logger} from '@openstapps/logger';
+import {isTestEnvironment} from '../common.js';
+import {BulkStorage} from '../storage/bulk-storage.js';
+import {createRoute} from './route.js';
+
+/**
+ * Contains information for using the route for closing bulks
+ */
+const bulkDoneRouteModel = new SCBulkDoneRoute();
+
+/**
+ * Implementation of the bulk done request route (SCBulkDoneRoute)
+ */
+export const bulkDoneRouter = createRoute<SCBulkDoneRequest, SCBulkDoneResponse>(
+  bulkDoneRouteModel,
+  async (_request, app, parameters) => {
+    const bulkMemory: BulkStorage = app.get('bulk');
+    const bulk = bulkMemory.read(parameters.UID);
+
+    if (bulk === undefined) {
+      Logger.warn(`Bulk with ${parameters.UID} not found.`);
+      throw new SCNotFoundErrorResponse(isTestEnvironment);
+    }
+
+    bulk.state = 'done';
+    await bulkMemory.markAsDone(bulk);
+
+    return {};
+  },
+);

backend/backend/src/routes/bulk-route.ts

@@ -0,0 +1,32 @@
+/*
+ * Copyright (C) 2019 StApps
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as
+ * published by the Free Software Foundation, either version 3 of the
+ * License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program.  If not, see <https://www.gnu.org/licenses/>.
+ */
+import {SCBulkRequest, SCBulkResponse, SCBulkRoute} from '@openstapps/core';
+import {BulkStorage} from '../storage/bulk-storage.js';
+import {createRoute} from './route.js';
+
+/**
+ * Contains information for using the route for creating bulks
+ */
+const bulkRouteModel = new SCBulkRoute();
+
+/**
+ * Implementation of the bulk request route (SCBulkRoute)
+ */
+export const bulkRouter = createRoute<SCBulkRequest, SCBulkResponse>(bulkRouteModel, async (request, app) => {
+  const bulkMemory: BulkStorage = app.get('bulk');
+
+  return bulkMemory.create(request);
+});

backend/backend/src/routes/http-types.ts

@@ -0,0 +1,53 @@
+/*
+ * Copyright (C) 2019 StApps
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as
+ * published by the Free Software Foundation, either version 3 of the
+ * License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program.  If not, see <https://www.gnu.org/licenses/>.
+ */
+// the list provides option to easily implement "isHttpMethod" guard
+const httpVerbs = [
+  'get',
+  'post',
+  'put',
+  'delete',
+  'patch',
+  'options',
+  'head',
+  'checkout',
+  'copy',
+  'lock',
+  'merge',
+  'mkactivity',
+  'mkcol',
+  'move',
+  'm-search',
+  'notify',
+  'purge',
+  'report',
+  'search',
+  'subscribe',
+  'trace',
+  'unlock',
+  'unsubscribe',
+] as const;
+/**
+ * Strings that can be used as HTTP verbs (e.g. in requests): 'get' | 'post' | 'put' | 'delete' etc.
+ */
+export type HTTPVerb = (typeof httpVerbs)[number];
+
+/**
+ * Provides information if a text (representing a method) is an HTTP verb
+ * @param method A text (representing a method) to check
+ */
+export function isHttpMethod(method: string): method is HTTPVerb {
+  return (httpVerbs as unknown as string[]).includes(method);
+}

backend/backend/src/routes/index-route.ts

@@ -0,0 +1,37 @@
+/*
+ * Copyright (C) 2019 StApps
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as
+ * published by the Free Software Foundation, either version 3 of the
+ * License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program.  If not, see <https://www.gnu.org/licenses/>.
+ */
+import {SCIndexResponse, SCIndexRoute} from '@openstapps/core';
+import {createRoute} from './route.js';
+import {backendConfig} from '../config.js';
+
+/**
+ * Contains information for using the index route
+ */
+const indexRouteModel = new SCIndexRoute();
+
+/**
+ * Implementation of the index route (SCIndexRoute)
+ */
+export const indexRouter = createRoute<unknown, SCIndexResponse>(
+  indexRouteModel,
+  async (): Promise<SCIndexResponse> => {
+    return {
+      app: backendConfig.app,
+      auth: backendConfig.auth,
+      backend: backendConfig.backend,
+    };
+  },
+);

backend/backend/src/routes/multi-search-route.ts

@@ -0,0 +1,59 @@
+/*
+ * Copyright (C) 2019 StApps
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as
+ * published by the Free Software Foundation, either version 3 of the
+ * License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program.  If not, see <https://www.gnu.org/licenses/>.
+ */
+import {
+  SCMultiSearchRequest,
+  SCMultiSearchResponse,
+  SCMultiSearchRoute,
+  SCSearchResponse,
+  SCTooManyRequestsErrorResponse,
+} from '@openstapps/core';
+import {isTestEnvironment} from '../common.js';
+import {BulkStorage} from '../storage/bulk-storage.js';
+import {createRoute} from './route.js';
+import {backendConfig} from '../config.js';
+/**
+ * Contains information for using the multi search route
+ */
+const multiSearchRouteModel = new SCMultiSearchRoute();
+
+/**
+ * Implementation of the multi search route (SCMultiSearchRoute)
+ */
+export const multiSearchRouter = createRoute<
+  SCMultiSearchRequest,
+  SCMultiSearchResponse | SCTooManyRequestsErrorResponse
+>(multiSearchRouteModel, async (request, app) => {
+  const bulkMemory: BulkStorage = app.get('bulk');
+  const queryNames = Object.keys(request);
+
+  if (queryNames.length > backendConfig.backend.maxMultiSearchRouteQueries) {
+    throw new SCTooManyRequestsErrorResponse(isTestEnvironment);
+  }
+
+  // get a map of promises for each query
+  const searchRequests = queryNames.map(async queryName => {
+    return bulkMemory.database.search(request[queryName]);
+  });
+
+  const listOfSearchResponses = await Promise.all(searchRequests);
+
+  const response: {[queryName: string]: SCSearchResponse} = {};
+  for (const [index, queryName] of queryNames.entries()) {
+    response[queryName] = listOfSearchResponses[index];
+  }
+
+  return response;
+});

backend/backend/src/routes/plugin-register-route.ts

@@ -0,0 +1,110 @@
+/*
+ * Copyright (C) 2019 StApps
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as
+ * published by the Free Software Foundation, either version 3 of the
+ * License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program.  If not, see <https://www.gnu.org/licenses/>.
+ */
+import {
+  SCNotFoundErrorResponse,
+  SCPluginAlreadyRegisteredErrorResponse,
+  SCPluginMetaData,
+  SCPluginRegisterRequest,
+  SCPluginRegisterResponse,
+  SCPluginRegisterRoute,
+} from '@openstapps/core';
+import {Logger} from '@openstapps/logger';
+import {deepStrictEqual} from 'assert';
+import {isTestEnvironment, plugins} from '../common.js';
+import {createRoute} from './route.js';
+import {backendConfig} from '../config.js';
+
+/**
+ * Contains information for using the route for registering routes
+ */
+const pluginRegisterRouteModel = new SCPluginRegisterRoute();
+
+/**
+ * Implementation of the plugin registration route (SCPluginRegisterRoute)
+ */
+export const pluginRegisterRouter = createRoute(pluginRegisterRouteModel, pluginRegisterHandler);
+
+/**
+ * Handles requests on route for registering plugins
+ * @param request Request received for registering or unregistering a plugin
+ * @param _app Express application
+ */
+export async function pluginRegisterHandler(
+  request: SCPluginRegisterRequest,
+  _app: Express.Application,
+): Promise<SCPluginRegisterResponse> {
+  switch (request.action) {
+    case 'add': {
+      return addPlugin(request.plugin);
+    }
+    case 'remove': {
+      return removePlugin(request.route);
+    }
+  }
+}
+
+/**
+ * Adds a plugin to the list (map) of registered plugins
+ * @param plugin Meta data of the plugin
+ */
+function addPlugin(plugin: SCPluginMetaData): SCPluginRegisterResponse {
+  // check if plugin (its route) has already been registered
+  if (plugins.has(plugin.route)) {
+    const previouslyRegistered = plugins.get(plugin.route);
+    try {
+      deepStrictEqual(previouslyRegistered, plugin);
+
+      return {success: true};
+    } catch {
+      throw new SCPluginAlreadyRegisteredErrorResponse(
+        'Plugin already registered',
+        plugins.get(plugin.route)!,
+        isTestEnvironment,
+      );
+    }
+  }
+  // it's a new plugin so it can be added to the map of plugins
+  plugins.set(plugin.route, plugin);
+  // add plugin  info to app config
+  if (backendConfig.app.features.plugins === undefined) {
+    backendConfig.app.features.plugins = {};
+  }
+  backendConfig.app.features.plugins[plugin.name] = {urlPath: plugin.route};
+  Logger.log(
+    `Registered plugin (name: ${plugin.name}, address: ${plugin.address}) on the route "${plugin.route}".`,
+  );
+
+  return {success: true};
+}
+
+/**
+ * Removes a plugin from the list (map) of registered plugins using the provided route
+ * @param route Route of the plugin which needs to be unregistered
+ */
+function removePlugin(route: string): SCPluginRegisterResponse {
+  if (!plugins.has(route)) {
+    throw new SCNotFoundErrorResponse(isTestEnvironment);
+  }
+  if (plugins.has(route)) {
+    const plugin = plugins.get(route)!;
+    delete backendConfig.app.features.plugins?.[plugin.name];
+  }
+  // remove the plugin information using its route as a key
+  plugins.delete(route);
+  Logger.log(`Removed plugin that used the route "${route}".`);
+
+  return {success: true};
+}

backend/backend/src/routes/route.ts

@@ -0,0 +1,128 @@
+/*
+ * Copyright (C) 2019 StApps
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as
+ * published by the Free Software Foundation, either version 3 of the
+ * License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program.  If not, see <https://www.gnu.org/licenses/>.
+ */
+import {
+  SCInternalServerErrorResponse,
+  SCMethodNotAllowedErrorResponse,
+  SCRoute,
+  SCValidationErrorResponse,
+} from '@openstapps/core';
+import {ValidationError} from '@openstapps/core-tools/src/types/validator.js';
+import {Logger} from '@openstapps/logger';
+import {Application, Router} from 'express';
+import PromiseRouter from 'express-promise-router';
+import {isTestEnvironment, validator} from '../common.js';
+import {isHttpMethod} from './http-types.js';
+
+/**
+ * Creates a router from a route class and a handler function which implements the logic
+ *
+ * The given router performs a request and response validation, sets status codes and checks if the given handler
+ * only returns errors that are allowed for the client to see
+ * @param routeClass Model of a route
+ * @param handler Implements the logic of the route
+ */
+export function createRoute<REQUESTTYPE, RETURNTYPE>(
+  routeClass: SCRoute,
+  handler: (
+    validatedBody: REQUESTTYPE,
+    app: Application,
+    parameters: {[parameterName: string]: string},
+  ) => Promise<RETURNTYPE>,
+): Router {
+  // create router
+  const router = PromiseRouter({mergeParams: true});
+
+  // create route
+  // the given type has no index signature so we have to cast to get the IRouteHandler when a HTTP method is given
+  const route = router.route(routeClass.urlPath);
+
+  const verb = routeClass.method.toLowerCase();
+
+  // check if route has a valid http verb
+  if (isHttpMethod(verb)) {
+    // create a route handler for the given HTTP method
+    route[verb](async (request, response) => {
+      try {
+        // validate request
+        const requestValidation = validator.validate(request.body, routeClass.requestBodyName);
+
+        if (requestValidation.errors.length > 0) {
+          const error = new SCValidationErrorResponse(requestValidation.errors, isTestEnvironment);
+          response.status(error.statusCode);
+          response.json(error);
+          await Logger.error(error);
+
+          return;
+        }
+
+        // hand over request to handler with path parameters
+        const handlerResponse = await handler(request.body, request.app, request.params);
+
+        // validate response generated by handler
+        const responseErrors: ValidationError[] = validator.validate(
+          handlerResponse,
+          routeClass.responseBodyName,
+        ).errors;
+
+        if (responseErrors.length > 0) {
+          const validationError = new SCValidationErrorResponse(responseErrors, isTestEnvironment);
+          // The validation error is not caused by faulty user input, but through an error that originates somewhere in
+          // the backend, therefore we use this "stacked" error.
+          const internalServerError = new SCInternalServerErrorResponse(validationError, isTestEnvironment);
+          response.status(internalServerError.statusCode);
+          response.json(internalServerError);
+          await Logger.error(internalServerError);
+
+          return;
+        }
+
+        // set status code
+        response.status(routeClass.statusCodeSuccess);
+
+        // respond
+        response.json(handlerResponse);
+      } catch (error) {
+        // if the error response is allowed on the route
+        if (routeClass.errorNames.some(constructorType => error instanceof constructorType)) {
+          // respond with the error from the handler
+          response.status(error.statusCode);
+          response.json(error);
+          await Logger.error(error);
+        } else {
+          // the error is not allowed so something went wrong
+          const internalServerError = new SCInternalServerErrorResponse(error, isTestEnvironment);
+          response.status(internalServerError.statusCode);
+          response.json(internalServerError);
+          await Logger.error(error);
+        }
+      }
+    });
+  } else {
+    throw new Error(
+      'Invalid HTTP verb in route definition. Please check route definitions in `@openstapps/core`',
+    );
+  }
+
+  // return a SCMethodNotAllowedErrorResponse on all other HTTP methods
+  route.all((_request, response) => {
+    const error = new SCMethodNotAllowedErrorResponse(isTestEnvironment);
+    response.status(error.statusCode);
+    response.json(error);
+    Logger.warn(error);
+  });
+
+  return router;
+}