docs: update changelogs for release

ci: publish release

.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": "develop",
+  "updateInternalDependencies": "patch",
+  "ignore": []
+}

.editorconfig

@@ -1,4 +1,3 @@
-# EditorConfig helps developers define and maintain consistent coding styles between different editors and IDEs
 # editorconfig.org
 
 root = true
@@ -7,7 +6,6 @@ root = true
 indent_style = space
 indent_size = 2
 
-# We recommend you to keep these unchanged
 end_of_line = lf
 charset = utf-8
 trim_trailing_whitespace = true

.envrc

@@ -0,0 +1 @@
+use flake

.eslintrc.json

@@ -1,3 +0,0 @@
-{
-  "extends": "@openstapps"
-}

.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

@@ -1,5 +1,5 @@
 # Logs
-logs/
+logs
 *.log
 npm-debug.log*
 yarn-debug.log*
@@ -10,12 +10,27 @@ pids
 *.pid
 *.seed
 *.pid.lock
+.DS_Store
+
+.angular/
+www/
+
+.docs.json
+coverage.xml
+report-junit.xml
+.deploy/
+.venv/
+
+# NixOS flake
+result
+hsperfdata_root
+.direnv/
 
 # Directory for instrumented libs generated by jscoverage/JSCover
-lib-cov/
+lib-cov
 
 # Coverage directory used by tools like istanbul
-coverage/
+coverage
 
 # nyc test coverage
 .nyc_output
@@ -24,7 +39,7 @@ coverage/
 .grunt
 
 # Bower dependency directory (https://bower.io/)
-bower_components/
+bower_components
 
 # node-waf configuration
 .lock-wscript
@@ -34,13 +49,14 @@ build/Release
 
 # Dependency directories
 node_modules/
+.pnpm-store/
 jspm_packages/
 
 # TypeScript v1 declaration files
 typings/
 
 # Optional npm cache directory
-.npm/
+.npm
 
 # Optional eslint cache
 .eslintcache
@@ -55,7 +71,7 @@ typings/
 .yarn-integrity
 
 # dotenv environment variables file
-.env
+.env.local
 
 # parcel-bundler cache (https://parceljs.org/)
 .cache
@@ -81,16 +97,18 @@ typings/
 ########## end of https://github.com/github/gitignore/blob/master/Node.gitignore
 
 # ignore ide files
-.idea/
-.vscode/
+.idea
+.vscode?*
+!.vscode/launch.json
 
 # ignore lib
-lib/
+lib
 
 # ignore docs
-docs/
+docs
 
-# Certificates
-*.crt
-*.key
-test/certs
+# report directory
+report
+
+# turbo cache
+.turbo/

.gitlab-ci.yml

@@ -1,91 +1,125 @@
-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
+
+.limit_pipelines:
+  rules:
+    - if: $CI_PIPELINE_SOURCE == 'merge_request_event' || $CI_COMMIT_BRANCH == 'main' || $CI_COMMIT_BRANCH == 'develop'
+      when: on_success
+    - when: never
+
+include:
+  - local: /backend/backend/.gitlab-ci.yml
+  - local: /frontend/app/.gitlab-ci.yml
+  - local: /.gitlab/schedules.gitlab-ci.yml
+  - local: /.gitlab/publishing.gitlab-ci.yml
+
+variables:
+  TURBO_CACHE_BYPASS: "--force --no-cache"
+
+default:
+  image: registry.gitlab.com/openstapps/openstapps/node-builder
+  tags:
+    - saas-linux-xlarge-amd64
+  interruptible: true
+  before_script:
+    - corepack enable
+    - corepack prepare pnpm@latest-10 --activate
+    - pnpm config set store-dir .pnpm-store
+  cache: &pnpm_cache
+    key:
+      files:
+          - pnpm-lock.yaml
+    paths:
+      - .pnpm-store/
+    policy: pull
 
 stages:
+  - setup
   - build
   - test
   - audit
   - publish
 
-before_script:
-  - npm ci
-
 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: whats the benefit for CI? 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
+    - .gitlab/ci/enableGitlabReviewToolbar.sh frontend/app/www/browser/index.html "$CI_PROJECT_ID" "$CI_OPEN_MERGE_REQUESTS"
+    - cp frontend/app/www/browser/index.html frontend/app/www/browser/200.html
+    - pnpm dlx surge -p frontend/app/www/browser -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_IID
+    - if: $CI_COMMIT_BRANCH == 'main'
+      variables:
+        DEPLOY_ID: production
+    - if: $CI_COMMIT_BRANCH == 'develop'
+      variables:
+        DEPLOY_ID: staging
+    - !reference [.limit_pipelines, rules]
+
+stop review:
+  stage: build
+  needs: ['build']
+  script:
+    - pnpm dlx surge teardown $CI_PROJECT_NAME-$DEPLOY_ID.surge.sh
+  environment:
+    name: review/$DEPLOY_ID
+    action: stop
+  when: manual
+  rules: *deploy-rules
 
 unit:
+  image: registry.gitlab.com/openstapps/openstapps/app-builder
   stage: test
+  needs: ['build']
   script:
-    - npm test
+    - pnpm install
+    - pnpm test $TURBO_CACHE_BYPASS
   coverage: '/Statements[^:]*\:[^:]*\s+([\d\.]+)%/'
   artifacts:
+    when: on_failure
+    paths:
+      - report-junit.xml
+      - coverage.xml
     reports:
+      junit:
+        - report-junit.xml
       coverage_report:
         coverage_format: cobertura
-        path: coverage/cobertura-coverage.xml
+        path: coverage.xml
+  rules:
+    - !reference [.limit_pipelines, rules]
 
 audit:
+  stage: audit
   allow_failure: true
-  except:
-    - schedules
+  needs: []
   script:
-    - npm audit
-  stage: audit
-
-scheduled-audit:
-  only:
-    - schedules
-  script:
-    - npm audit --audit-level=high
-  stage: audit
-
-docker image build:
-  image: registry.gitlab.com/openstapps/projectmanagement/builder
-  stage: test
-  dependencies:
-    - build
-  variables:
-    DOCKER_DRIVER: overlay2
-  services:
-    - docker:dind
-  script:
-    - docker build -t $CI_REGISTRY_IMAGE/$REGISTRY_BRANCH$CI_COMMIT_REF_NAME:latest .
-  tags:
-    - docker
-
-docker image:
-  image: registry.gitlab.com/openstapps/projectmanagement/builder
-  stage: publish
-  dependencies:
-    - build
-  variables:
-    DOCKER_DRIVER: overlay2
-  services:
-    - docker:dind
-  script:
-    - export VERSION=$(echo -n "$CI_BUILD_REF_NAME" | cut -c 2-)
-    - export IMAGETAG_BASE=$CI_REGISTRY_IMAGE
-    - export IMAGETAG_VERSION=$IMAGETAG_BASE:$VERSION
-    - export IMAGETAG_LATEST=$IMAGETAG_BASE:latest
-    - docker login -u gitlab-ci-token -p $CI_BUILD_TOKEN $CI_REGISTRY
-    - docker build -t $IMAGETAG_VERSION -t $IMAGETAG_LATEST .
-    - docker push $IMAGETAG_BASE
-  only:
-    - /^v[0-9]+\.[0-9]+\.[0-9]+$/
-  tags:
-    - docker
-
-pages:
-  artifacts:
-    paths:
-      - public
-  only:
-    - /^v[0-9]+\.[0-9]+\.[0-9]+$/
-  script:
-    - npm run documentation
-    - mv docs public
-  stage: publish
+    - pnpm audit --prod --audit-level critical
+  rules:
+    - !reference [.limit_pipelines, rules]
+    # - if: $CI_COMMIT_BRANCH == 'main'
+    #   allow_failure: false

.gitlab/ci/enableGitlabReviewToolbar.sh

@@ -0,0 +1,16 @@
+#!/usr/bin/env sh
+set -e
+
+# 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/openstapps\" 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

@@ -2,37 +2,31 @@
 
 (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 ~meeting ~bug
+/label ~bug ~meeting

.gitlab/issue_templates/feature.md

@@ -2,15 +2,16 @@
 
 (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 ~meeting ~feature
+/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,83 @@
+.limit_publish_pipelines:
+  rules:
+      - if: '$CI_COMMIT_BRANCH == "develop" && $CI_COMMIT_MESSAGE =~ /ci: publish prerelease/ && $CI_PIPELINE_SOURCE != "schedule"'
+        variables:
+          PUBLISH_TAG: next
+      - if: '$CI_COMMIT_BRANCH == "main" && $CI_COMMIT_MESSAGE =~ /ci: publish release/ && $CI_PIPELINE_SOURCE != "schedule"'
+        variables:
+          PUBLISH_TAG: latest
+
+deploy:
+  stage: publish
+  needs: ['build', 'unit', 'integration', 'e2e', 'audit']
+  script:
+    - pnpm install
+    - pnpm run deploy
+  artifacts:
+    paths:
+      - ./.deploy
+      - ./frontend/app/www
+  rules:
+    - !reference [.limit_publish_pipelines, rules]
+
+publish image:
+  stage: publish
+  inherit:
+    default:
+      - tags
+  needs: ['deploy']
+  image:
+    name: gcr.io/kaniko-project/executor:v1.24.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}:$(grep -o '"version": "[^"]*' "${DEPLOY_DIR}/package.json" | cut -d'"' -f4)"
+       --destination "${CI_REGISTRY_IMAGE}/${IMAGE_NAME}:${PUBLISH_TAG}"
+  parallel:
+    matrix:
+      - IMAGE_NAME: database
+        DEPLOY_DIR: backend/database
+      - IMAGE_NAME: backend
+        DEPLOY_DIR: .deploy/backend
+      - IMAGE_NAME: proxy
+        DEPLOY_DIR: .deploy/proxy
+      - IMAGE_NAME: api
+        DEPLOY_DIR: .deploy/api-cli
+      - IMAGE_NAME: minimal-connector
+        DEPLOY_DIR: .deploy/minimal-connector
+      - IMAGE_NAME: minimal-plugin
+        DEPLOY_DIR: .deploy/minimal-plugin
+      - IMAGE_NAME: app
+        DEPLOY_DIR: frontend/app
+  rules:
+    - !reference [.limit_publish_pipelines, rules]
+
+publish packages:
+  stage: publish
+  needs: ['deploy']
+  variables:
+    GIT_STRATEGY: clone
+    GIT_DEPTH: 0
+  script:
+    - pnpm install
+    - pnpm build
+    - pnpm config set '//registry.npmjs.org/:_authToken' "${NPM_AUTH_TOKEN}"
+    - pnpm publish -r --publish-branch ${CI_COMMIT_BRANCH} --tag ${PUBLISH_TAG} --no-git-checks # TODO: Git checks...
+  rules:
+    - !reference [.limit_publish_pipelines, rules]
+
+publish docs:
+  stage: publish
+  needs: ['deploy']
+  script:
+    - pnpm install --prefer-offline
+    - pnpm run docs
+    - mv docs public
+  artifacts:
+    paths:
+      - public
+  rules:
+    - !reference [.limit_publish_pipelines, rules]

.gitlab/schedules.gitlab-ci.yml

@@ -0,0 +1,35 @@
+.limit_scheduled_pipelines:
+  rules:
+    - if: $CI_COMMIT_BRANCH == 'main' && $CI_PIPELINE_SOURCE == "schedule" 
+
+base image:
+  image: docker
+  stage: setup
+  tags: 
+    - gitlab-org-docker
+  inherit:
+    default:
+      - interruptible
+  services:
+    - docker:dind
+  script:
+    - >
+      docker login -u "${CI_REGISTRY_USER}" -p "${CI_JOB_TOKEN}" "${CI_REGISTRY}" && 
+      docker build
+      -t "${CI_REGISTRY_IMAGE}/${IMAGE_NAME}:$(grep -o '"version": "[^"]*' "${DEPLOY_DIR}/package.json" | cut -d'"' -f4)"
+      -t "${CI_REGISTRY_IMAGE}/${IMAGE_NAME}:latest" "${CI_PROJECT_DIR}/${DEPLOY_DIR}" && 
+      docker push "${CI_REGISTRY_IMAGE}/${IMAGE_NAME}" --all-tags
+  cache: {} # disable irrelevant cache for this job
+  before_script: [] # do not run irrelevant before script for this job
+  parallel:
+    matrix:
+      - IMAGE_NAME: node-base
+        DEPLOY_DIR: images/node-base
+      - IMAGE_NAME: node-builder
+        DEPLOY_DIR: images/node-builder
+      - IMAGE_NAME: app-builder
+        DEPLOY_DIR: images/app-builder
+      - IMAGE_NAME: app-cypress
+        DEPLOY_DIR: images/app-cypress
+  rules:
+    - !reference [.limit_scheduled_pipelines, rules]

.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"]
+}

.npmignore

@@ -1,10 +0,0 @@
-# Ignore all files/folders by default
-# See https://stackoverflow.com/a/29932318
-/*
-# Except these files/folders
-!lib
-!LICENSE
-!package.json
-!package-lock.json
-!README.md
-!src

.npmrc

@@ -0,0 +1 @@
+auto-install-peers=true

.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,
+  }
+}

.prettierignore

@@ -0,0 +1 @@
+pnpm-lock.yaml

.syncpackrc.cjs

@@ -0,0 +1,66 @@
+// @ts-check
+
+/** @type {import('syncpack').RcFile} */
+const config = {
+  semverGroups: [
+    {
+      range: '',
+      dependencies: ['**'],
+      packages: ['**'],
+    }
+  ],
+  source: ['package.json', '**/package.json'],
+  indent: '  ',
+  sortFirst: [
+    'name',
+    'description',
+    'version',
+    'private',
+    'type',
+    'license',
+    'repository',
+    'author',
+    'contributors',
+    'keywords',
+    'main',
+    'types',
+    'bin',
+    'files',
+    'engines',
+    'packageManager',
+    'scripts',
+    'dependencies',
+    'devDependencies',
+    'peerDependencies',
+    'pnpm',
+    'tsup',
+    'prettier',
+    'eslintConfig',
+    'eslintIgnore',
+    'nyc',
+  ],
+  versionGroups: [
+    {
+      label: 'Package version is controlled by changesets',
+      dependencies: ['**'],
+      dependencyTypes: ['workspace'],
+      packages: ['**'],
+      isIgnored: true,
+    },
+    {
+      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', 'peer'],
+      packages: ['**'],
+      pinVersion: 'workspace:*',
+    },
+  ],
+};
+
+module.exports = config;

.tool-versions

@@ -0,0 +1,3 @@
+nodejs 22.16.0
+pnpm 10.12.3
+python 3.11.5

.vscode/launch.json

@@ -0,0 +1,23 @@
+{
+    // Use IntelliSense to learn about possible attributes.
+    // Hover to view descriptions of existing attributes.
+    // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
+    "version": "0.2.0",
+    "configurations": [
+        {
+            "name": "Launch Chrome",
+            "request": "launch",
+            "type": "chrome",
+            "url": "http://localhost:8100",
+            "webRoot": "${workspaceFolder}/frontend/app/www"
+        },
+        {
+            "type":"node",
+            "request": "launch",
+            "name": "Run mocha for nodejs workspace",
+            "runtimeExecutable": "${fileDirname}/../node_modules/.bin/c8",
+            "cwd": "${fileDirname}/../",
+            "runtimeArgs": ["--config", "${workspaceFolder}/.c8rc.json", "${fileDirname}/../node_modules/.bin/mocha", "--exit", "--reporter", "spec"]
+        },
+    ]
+}

CHANGELOG.md

@@ -1,55 +0,0 @@
-# [1.2.0](https://gitlab.com/openstapps/proxy/compare/v1.1.0...v1.2.0) (2022-06-08)
-
-
-### Features
-
-* added prometheus metrics support ([5522ac5](https://gitlab.com/openstapps/proxy/commit/5522ac55ac00d4b809d942d0a8c58d15b0432fb8))
-* reload nginx on proxyconfig change ([1fcf734](https://gitlab.com/openstapps/proxy/commit/1fcf7340d49bde993b3acc7bdc90e6a637a05321))
-* support docker swarm deployments ([4bb46d8](https://gitlab.com/openstapps/proxy/commit/4bb46d8a06ff7829b6908bd03c1cf4240767fcc2))
-
-
-
-# [1.1.0](https://gitlab.com/openstapps/proxy/compare/v1.0.1...v1.1.0) (2022-03-10)
-
-
-
-## [1.0.1](https://gitlab.com/openstapps/proxy/compare/v1.0.0...v1.0.1) (2022-03-10)
-
-
-### Bug Fixes
-
-* nginx deleting its own conifg ([edbd739](https://gitlab.com/openstapps/proxy/commit/edbd739db995b72fd3f5b5bec7558442a329f719))
-
-
-
-# [1.0.0](https://gitlab.com/openstapps/proxy/compare/v0.4.0...v1.0.0) (2022-03-09)
-
-
-### Features
-
-* add rate limit allow list ([f10cd6c](https://gitlab.com/openstapps/proxy/commit/f10cd6c4314ee8b5f4bddc54b61231335116376d))
-
-
-
-# [0.4.0](https://gitlab.com/openstapps/proxy/compare/fbe1a65cd1cfed81c26af14690c620c4cb4fbdc0...v0.4.0) (2021-09-06)
-
-
-### Bug Fixes
-
-*  deny PUT method requests ([61ad5ab](https://gitlab.com/openstapps/proxy/commit/61ad5abc2bc45b7cb405b59d6bc095ff1e12a5cf))
-* fix ci job dependencies and caching ([f59cc58](https://gitlab.com/openstapps/proxy/commit/f59cc5832c0b1cfc4b43889e1cedc360e42850e8))
-* handle patch & duplicate versions correctly ([8dffe29](https://gitlab.com/openstapps/proxy/commit/8dffe29146f00b8da98b505b41ab374daf093af2))
-* increase nginx transport security ([8fe6a27](https://gitlab.com/openstapps/proxy/commit/8fe6a2795f0c6f9107662ef9e5a43c6a3c8c066c))
-* remove reasons of linting errors ([b624ed3](https://gitlab.com/openstapps/proxy/commit/b624ed342657f6a574059734f0399ba8539d6c82))
-* remove superfluous visible routes ([96741f3](https://gitlab.com/openstapps/proxy/commit/96741f3789d4a0785124a95475a2ad05b41c9dad)), closes [#10](https://gitlab.com/openstapps/proxy/issues/10)
-
-
-### Features
-
-* accept PUT method ([59db3b5](https://gitlab.com/openstapps/proxy/commit/59db3b5c50be42ef2d2a4acbad8da2e7d813efd6))
-* add issues templates ([9637574](https://gitlab.com/openstapps/proxy/commit/96375740719191850238dca975a153a37fe7d4e6)), closes [#4](https://gitlab.com/openstapps/proxy/issues/4)
-* add proxy ([fbe1a65](https://gitlab.com/openstapps/proxy/commit/fbe1a65cd1cfed81c26af14690c620c4cb4fbdc0))
-* add systemd service examples ([c54aa25](https://gitlab.com/openstapps/proxy/commit/c54aa25f3460e0d08ac4f66621e639a2b46ccc6d))
-
-
-

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 `SCIndexableThings ` 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`:
+- Make sure your SCThing (but not SCThingWithoutReferences!) includes the `@indexable` and `@validatable` JSDoc annotations, otherwise neither JSON Schemas nor Elasticsearch mappings will be generated
+```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};
+}
+```

LICENSE

@@ -169,32 +169,3 @@ IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY C
 If the disclaimer of warranty and limitation of liability provided above cannot be given local legal effect according to their terms, reviewing courts shall apply local law that most closely approximates an absolute waiver of all civil liability in connection with the Program, unless a warranty or assumption of liability accompanies a copy of the Program in return for a fee.
 
 END OF TERMS AND CONDITIONS
-
-How to Apply These Terms to Your New Programs
-
-If you develop a new program, and you want it to be of the greatest possible use to the public, the best way to achieve this is to make it free software which everyone can redistribute and change under these terms.
-
-To do so, attach the following notices to the program. It is safest to attach them to the start of each source file to most effectively state the exclusion of warranty; and each file should have at least the "copyright" line and a pointer to where the full notice is found.
-
-<one line to give the program's name and a brief idea of what it does.>
-Copyright (C) <year> <name of author>
-
-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, 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 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/>.
-
-Also add information on how to contact you by electronic and paper mail.
-
-If the program does terminal interaction, make it output a short notice like this when it starts in an interactive mode:
-
-<program> Copyright (C) <year> <name of author>
-This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
-This is free software, and you are welcome to redistribute it under certain conditions; type `show c' for details.
-
-The hypothetical commands `show w' and `show c' should show the appropriate parts of the General Public License. Of course, your program's commands might be different; for a GUI interface, you would use an "about box".
-
-You should also get your employer (if you work as a programmer) or school, if any, to sign a "copyright disclaimer" for the program, if necessary. For more information on this, and how to apply and follow the GNU GPL, see <https://www.gnu.org/licenses/>.
-
-The GNU General Public License does not permit incorporating your program into proprietary programs. If your program is a subroutine library, you may consider it more useful to permit linking proprietary applications with the library. If this is what you want to do, use the GNU Lesser General Public License instead of this License. But first, please read <https://www.gnu.org/ licenses/why-not-lgpl.html>.

README.md

@@ -1,88 +1,101 @@
-# proxy
+# Open StApps Monorepo
 
-This proxy is based on NGINX. The NGINX configuration is generated by a simple Node.js script which parses
-the docker socket. NGINX acts as a reverse proxy server. The Node.js script reads the docker socket file to generate
-a configuration for each running docker container. The base template for configuration is `nginx.conf.template`
-All `*.template` files are written with [mustache-js](https://github.com/janl/mustache.js "GitHub") syntax.
-The templates are assembled by the Node.js program.
+Refer to the [contribution guide](./CONTRIBUTING.md)
 
-**Important:**
+## Projects
 
-The proxy expects your backend containers to provide following structure:
+### Apps
 
-* Service name for the backend container has to be `backend` in docker-compose.yml. If you don't use docker-compose
-set `com.docker.compose.service`-label to `backend`.
-* Set the `stapps.version`-label of the container/service to coresponing the backend version
-* The proxy container has to be executed with `--net=host`
-* Port 80 or 443 being free for exclusive use by the proxy container
-* Always publish the backend container ports to the host machines internal loopback interface or an interace you control. This is the only way communication with the internet is restricted to going through the proxy. E.g this can be achieved by the `ports` syntax `127.0.0.1:3000-4000:3000` in the docker-compose file (here with a random port to avoid collisions).
+| 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) |
 
-## SSL/TLS
+### Libraries
 
-For a working https configuration you need to have a valid certificate ***including the intemediate certificas without the root*** (*.crt file ) and its private key (*.key file) in two ***seperate*** files. In addition to your certificate you need to provide the certificate chain ***including*** the root certificate. [Read up on](https://medium.com/@superseb/get-your-certificate-chain-right-4b117a9c0fce) how to [create this chain](https://blog.pki.dfn.de/2015/06/ocsp-stapling-in-nginx/) (*.crt file) or ask your admins to provide you one. The final and easiest requirement of the ssl setup is to create custom Diffie-Hellman parameters in a file:
+| 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) |
 
-```sh
-openssl dhparam -out dhparams.pem 4096
+## Publishing
+
+After having added all changes using `pnpm changeset`
+
+```shell
+pnpm publish-packages
 ```
 
-## Configuration file
+Internally, this will run
 
-To Provide your own configuration file you can create a `default.json` file in the `config` directory. The JSON structure has to follow `config/default.ts`. Adding this file via docker mount is also possible (eg. `-v <path JSON file>:/app/config/default.json`)
-
-## Status Codes
-
-* OutdatedVersions return a `HTTP 404`
-* ActiveVersions return a `HTTP 503` if currently unavailable or the given code by running backend-node
-* Unsupported versions (not configured as outdated or active) return a `HTTP 404`
-* No version header given returns a `HTTP 300`
-
-**NOTE:** The default configuration expects the client to set a version header: `X-StApps-Version=<version of app>`
-
-## Logger
-
-The proxy uses [@openstapps/logger](https://gitlab.com/openstapps/logger). You can provide `NODE_ENV=production`
-and SMTP-Configuration via environment-variables for monitoring in production use.
-
-## Usage
-
-The Node.js script reads out the `/var/run/docker.sock` to get the containers of the host system via
-[dockerode](https://github.com/apocas/dockerode "GitHub").
-
-Without ssl:
-
-```sh
-docker run --rm -v /var/run/docker.sock:/var/run/docker.sock --net="host" registry.gitlab.com/openstapps/proxy/master
+```shell
+pnpm changeset version # bump versions
+pnpm syncpack:fix
+pnpm format:fix # changes to the package.json can cause issues
+pnpm install # update lockfile and rebuild packages
+git add .
+git commit -m "refactor: update changelog"
+pnpm changeset tags
+git push --follow-tags
+# from here the pipeline will do the publishing
 ```
 
-With ssl:
+## Remote caching
 
-```sh
-docker run --rm --net="host" \
-    -v /var/run/docker.sock:/var/run/docker.sock \
-    -v <path to *.crt-file>:/etc/nginx/certs/ssl.crt \
-    -v <path to *.key-file>:/etc/nginx/certs/ssl.key \
-    -v <path to certificate chain (*.crt) file>:/etc/nginx/certs/chain.crt \
-    -v <path to dhparam.pem file>:/etc/nginx/certs/dhparam.pem \
-    -v <path RECIPIENTS file>:/app/config/RECIPIENTS \
-    registry.gitlab.com/openstapps/proxy/master
+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
 ```
 
-## Static Folder (docker run option: `-v <path to static folder>:/static`)
+### Connecting to the remote cache in GitLab Pipelines
 
-Der Zugriff erfolgt über: `http(s)://<url>/_static/<path-to-file>`
+You will need to define
 
-Beispiel Proxy auf Localhost für die Datei `static/test.json`: `http://localhost/_static/test.json`
+- `TURBO_API`
+- `TURBO_TEAM`
+- `TURBO_TOKEN`
+  Like you did locally as described in [this](https://turbo.build/repo/docs/ci/gitlabci#remote-caching)
+  guide.
 
-## Bilder im Static Folder
+### Hosting a cache
 
-Bilder sollten folgendermaßen abgelegt und benannt werden:
+Self-hosting via Docker is extremely simple, just follow
+[this](http://v2202207178592194230.supersrv.de:6341) guide
+or in short:
 
-`<pfad analog zur imageURL aus der App>/<type>/<uid>-<size>.[jpg|png|gif]`
+`.env`
 
-Beispiel:
-`_static/images/Place/hautpmensa-thumbnail.jpg`
+```dotenv
+PORT=...
+TURBO_TOKEN=...
+```
 
-Aufgerufen wird das mit:
-'https://server.deiner.uni.de/_static/images/Place/hauptmensa-thumbnail'
+```shell
+docker run --env-file=.env -p 3000:3000 fox1t/turborepo-remote-cache
+```
 
-Bildgrößen sind: thumbnail, small, medium, large
+## Useful commands
+
+#### Why is this package bloating the app?
+
+```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/openstapps/node-builder
+  stage: test
+  needs: ['build']
+  variables:
+    DOCKER_DRIVER: overlay2
+    WAIT_FOR_SERVICES_TIMEOUT: 1
+  services:
+    - name: registry.gitlab.com/openstapps/openstapps/database:latest
+      alias: elasticsearch
+  script:
+    - pnpm install
+    - pnpm test:integration:backend --force --no-cache
+  artifacts:
+    when: on_failure
+    paths:
+      - backend/backend/coverage/integration-report-junit.xml
+    reports:
+      junit:
+        - backend/backend/coverage/integration-report-junit.xml
+  rules:
+    - !reference [.limit_pipelines, rules]

backend/backend/CHANGELOG.md

@@ -0,0 +1,550 @@
+# @openstapps/backend
+
+## 4.0.7
+
+### Patch Changes
+
+- ae1cad3b: upgrade project to Typescript 5.9
+- 93c38b74: dependency updates
+- Updated dependencies [ae1cad3b]
+- Updated dependencies [93c38b74]
+  - @openstapps/core-tools@4.0.7
+  - @openstapps/core@4.0.7
+  - @openstapps/logger@4.0.7
+
+## 4.0.6
+
+### Patch Changes
+
+- 019f8013: Enable ID cards and assessments using Shibboleth as identity provider
+
+## 4.0.5
+
+### Patch Changes
+
+- Updated dependencies [86004881]
+- Updated dependencies [09ad903a]
+  - @openstapps/core-tools@4.0.5
+  - @openstapps/core@4.0.5
+
+## 4.0.3
+
+### Patch Changes
+
+- 3a274a3a: Upgrade to Capacitor 7 and Anuglar 18
+  - @openstapps/core@4.0.2
+  - @openstapps/core-tools@4.0.2
+  - @openstapps/logger@4.0.2
+
+## 4.0.2
+
+### Patch Changes
+
+- 6b06de40: Updated nodemailer dependency
+- Updated dependencies [6b06de40]
+  - @openstapps/logger@4.0.2
+  - @openstapps/core@4.0.2
+  - @openstapps/core-tools@4.0.2
+
+## 4.0.1
+
+### Patch Changes
+
+- b40ba7ad: Updated Elasticsearch dependency
+  - @openstapps/core@4.0.0
+
+## 4.0.0
+
+### Major Changes
+
+- c8e29020: Update to Node 22
+
+### Patch Changes
+
+- Updated dependencies [c8e29020]
+  - @openstapps/core@4.0.0
+  - @openstapps/core-tools@4.0.0
+  - @openstapps/logger@4.0.0
+
+## 3.3.2
+
+### Patch Changes
+
+- @openstapps/core@3.3.2
+- @openstapps/core-tools@3.3.2
+
+## 3.3.1
+
+### Patch Changes
+
+- 67ab1fd6: fix for geo.point mapping
+
+## 3.3.0
+
+### Minor Changes
+
+- 688bc5f2: v3.3.0 changes
+
+### Patch Changes
+
+- Updated dependencies [688bc5f2]
+  - @openstapps/core@3.3.0
+  - @openstapps/core-tools@3.3.0
+  - @openstapps/logger@3.0.0
+
+## 3.2.0
+
+### Minor Changes
+
+- 912ae422: Add the ability to filter by existence of a field
+
+### Patch Changes
+
+- 689ac68b: pin alpine version to 3.18 and add healthchecks
+- e8d72683: Backend unit tests break every year
+- Updated dependencies [912ae422]
+  - @openstapps/core@4.0.0
+  - @openstapps/core-tools@3.0.0
+  - @openstapps/logger@3.0.0
+
+## 3.1.2
+
+### Patch Changes
+
+- Fix backend rejecting plugins
+- Fix backend sliently falling back to default configs
+
+## 3.1.1
+
+### Patch Changes
+
+- Fix version history offered by backend
+- Updated dependencies
+  - @openstapps/core@3.1.1
+
+## 3.1.0
+
+### Minor Changes
+
+- 06b8ca10: Add job portal feature
+
+### Patch Changes
+
+- Updated dependencies [06b8ca10]
+  - @openstapps/core@3.1.0
+
+## 3.0.1
+
+### Patch Changes
+
+- Fix missing dependency
+
+## 3.0.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
+- 23481d0d: Update to TypeScript 5.1.6
+- Updated dependencies [98546a97]
+- Updated dependencies [64caebaf]
+- Updated dependencies [98546a97]
+- Updated dependencies [64caebaf]
+- Updated dependencies [64caebaf]
+- Updated dependencies [64caebaf]
+- Updated dependencies [64caebaf]
+- Updated dependencies [1f62b5c5]
+- Updated dependencies [98546a97]
+- Updated dependencies [23481d0d]
+- 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
+  - @openstapps/logger@3.0.0
+  - @openstapps/core@3.0.0
+
+## 3.0.0-next.4
+
+### Patch Changes
+
+- 23481d0d: Update to TypeScript 5.1.6
+- Updated dependencies [23481d0d]
+  - @openstapps/core-tools@3.0.0-next.4
+  - @openstapps/logger@3.0.0-next.4
+  - @openstapps/core@3.0.0-next.4
+
+## 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,14 @@
+FROM registry.gitlab.com/openstapps/openstapps/node-base
+
+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
+HEALTHCHECK --interval=10s --timeout=10s --start-period=10s --retries=12 CMD curl -s --fail --request POST --data '{}' --header 'Content-Type: application/json' http://localhost:3000/ >/dev/null || exit 1
+
+ENTRYPOINT ["node", "app.js"]

backend/backend/LICENSE

@@ -0,0 +1,619 @@
+                    GNU AFFERO GENERAL PUBLIC LICENSE
+                       Version 3, 19 November 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+Preamble
+
+The GNU Affero General Public License is a free, copyleft license for
+software and other kinds of works, specifically designed to ensure
+cooperation with the community in the case of network server software.
+
+The licenses for most software and other practical works are designed
+to take away your freedom to share and change the works.  By contrast,
+our General Public Licenses are intended to guarantee your freedom to
+share and change all versions of a program--to make sure it remains free
+software for all its users.
+
+When we speak of free software, we are referring to freedom, not
+price.  Our General Public Licenses are designed to make sure that you
+have the freedom to distribute copies of free software (and charge for
+them if you wish), that you receive source code or can get it if you
+want it, that you can change the software or use pieces of it in new
+free programs, and that you know you can do these things.
+
+Developers that use our General Public Licenses protect your rights
+with two steps: (1) assert copyright on the software, and (2) offer
+you this License which gives you legal permission to copy, distribute
+and/or modify the software.
+
+A secondary benefit of defending all users' freedom is that
+improvements made in alternate versions of the program, if they
+receive widespread use, become available for other developers to
+incorporate.  Many developers of free software are heartened and
+encouraged by the resulting cooperation.  However, in the case of
+software used on network servers, this result may fail to come about.
+The GNU General Public License permits making a modified version and
+letting the public access it on a server without ever releasing its
+source code to the public.
+
+The GNU Affero General Public License is designed specifically to
+ensure that, in such cases, the modified source code becomes available
+to the community.  It requires the operator of a network server to
+provide the source code of the modified version running there to the
+users of that server.  Therefore, public use of a modified version, on
+a publicly accessible server, gives the public access to the source
+code of the modified version.
+
+An older license, called the Affero General Public License and
+published by Affero, was designed to accomplish similar goals.  This is
+a different license, not a version of the Affero GPL, but Affero has
+released a new version of the Affero GPL which permits relicensing under
+this license.
+
+The precise terms and conditions for copying, distribution and
+modification follow.
+
+TERMS AND CONDITIONS
+
+0. Definitions.
+
+"This License" refers to version 3 of the GNU Affero General Public License.
+
+"Copyright" also means copyright-like laws that apply to other kinds of
+works, such as semiconductor masks.
+
+"The Program" refers to any copyrightable work licensed under this
+License.  Each licensee is addressed as "you".  "Licensees" and
+"recipients" may be individuals or organizations.
+
+To "modify" a work means to copy from or adapt all or part of the work
+in a fashion requiring copyright permission, other than the making of an
+exact copy.  The resulting work is called a "modified version" of the
+earlier work or a work "based on" the earlier work.
+
+A "covered work" means either the unmodified Program or a work based
+on the Program.
+
+To "propagate" a work means to do anything with it that, without
+permission, would make you directly or secondarily liable for
+infringement under applicable copyright law, except executing it on a
+computer or modifying a private copy.  Propagation includes copying,
+distribution (with or without modification), making available to the
+public, and in some countries other activities as well.
+
+To "convey" a work means any kind of propagation that enables other
+parties to make or receive copies.  Mere interaction with a user through
+a computer network, with no transfer of a copy, is not conveying.
+
+An interactive user interface displays "Appropriate Legal Notices"
+to the extent that it includes a convenient and prominently visible
+feature that (1) displays an appropriate copyright notice, and (2)
+tells the user that there is no warranty for the work (except to the
+extent that warranties are provided), that licensees may convey the
+work under this License, and how to view a copy of this License.  If
+the interface presents a list of user commands or options, such as a
+menu, a prominent item in the list meets this criterion.
+
+1. Source Code.
+
+The "source code" for a work means the preferred form of the work
+for making modifications to it.  "Object code" means any non-source
+form of a work.
+
+A "Standard Interface" means an interface that either is an official
+standard defined by a recognized standards body, or, in the case of
+interfaces specified for a particular programming language, one that
+is widely used among developers working in that language.
+
+The "System Libraries" of an executable work include anything, other
+than the work as a whole, that (a) is included in the normal form of
+packaging a Major Component, but which is not part of that Major
+Component, and (b) serves only to enable use of the work with that
+Major Component, or to implement a Standard Interface for which an
+implementation is available to the public in source code form.  A
+"Major Component", in this context, means a major essential component
+(kernel, window system, and so on) of the specific operating system
+(if any) on which the executable work runs, or a compiler used to
+produce the work, or an object code interpreter used to run it.
+
+The "Corresponding Source" for a work in object code form means all
+the source code needed to generate, install, and (for an executable
+work) run the object code and to modify the work, including scripts to
+control those activities.  However, it does not include the work's
+System Libraries, or general-purpose tools or generally available free
+programs which are used unmodified in performing those activities but
+which are not part of the work.  For example, Corresponding Source
+includes interface definition files associated with source files for
+the work, and the source code for shared libraries and dynamically
+linked subprograms that the work is specifically designed to require,
+such as by intimate data communication or control flow between those
+subprograms and other parts of the work.
+
+The Corresponding Source need not include anything that users
+can regenerate automatically from other parts of the Corresponding
+Source.
+
+The Corresponding Source for a work in source code form is that
+same work.
+
+2. Basic Permissions.
+
+All rights granted under this License are granted for the term of
+copyright on the Program, and are irrevocable provided the stated
+conditions are met.  This License explicitly affirms your unlimited
+permission to run the unmodified Program.  The output from running a
+covered work is covered by this License only if the output, given its
+content, constitutes a covered work.  This License acknowledges your
+rights of fair use or other equivalent, as provided by copyright law.
+
+You may make, run and propagate covered works that you do not
+convey, without conditions so long as your license otherwise remains
+in force.  You may convey covered works to others for the sole purpose
+of having them make modifications exclusively for you, or provide you
+with facilities for running those works, provided that you comply with
+the terms of this License in conveying all material for which you do
+not control copyright.  Those thus making or running the covered works
+for you must do so exclusively on your behalf, under your direction
+and control, on terms that prohibit them from making any copies of
+your copyrighted material outside their relationship with you.
+
+Conveying under any other circumstances is permitted solely under
+the conditions stated below.  Sublicensing is not allowed; section 10
+makes it unnecessary.
+
+3. Protecting Users' Legal Rights From Anti-Circumvention Law.
+
+No covered work shall be deemed part of an effective technological
+measure under any applicable law fulfilling obligations under article
+11 of the WIPO copyright treaty adopted on 20 December 1996, or
+similar laws prohibiting or restricting circumvention of such
+measures.
+
+When you convey a covered work, you waive any legal power to forbid
+circumvention of technological measures to the extent such circumvention
+is effected by exercising rights under this License with respect to
+the covered work, and you disclaim any intention to limit operation or
+modification of the work as a means of enforcing, against the work's
+users, your or third parties' legal rights to forbid circumvention of
+technological measures.
+
+4. Conveying Verbatim Copies.
+
+You may convey verbatim copies of the Program's source code as you
+receive it, in any medium, provided that you conspicuously and
+appropriately publish on each copy an appropriate copyright notice;
+keep intact all notices stating that this License and any
+non-permissive terms added in accord with section 7 apply to the code;
+keep intact all notices of the absence of any warranty; and give all
+recipients a copy of this License along with the Program.
+
+You may charge any price or no price for each copy that you convey,
+and you may offer support or warranty protection for a fee.
+
+5. Conveying Modified Source Versions.
+
+You may convey a work based on the Program, or the modifications to
+produce it from the Program, in the form of source code under the
+terms of section 4, provided that you also meet all of these conditions:
+
+    a) The work must carry prominent notices stating that you modified
+    it, and giving a relevant date.
+
+    b) The work must carry prominent notices stating that it is
+    released under this License and any conditions added under section
+    7.  This requirement modifies the requirement in section 4 to
+    "keep intact all notices".
+
+    c) You must license the entire work, as a whole, under this
+    License to anyone who comes into possession of a copy.  This
+    License will therefore apply, along with any applicable section 7
+    additional terms, to the whole of the work, and all its parts,
+    regardless of how they are packaged.  This License gives no
+    permission to license the work in any other way, but it does not
+    invalidate such permission if you have separately received it.
+
+    d) If the work has interactive user interfaces, each must display
+    Appropriate Legal Notices; however, if the Program has interactive
+    interfaces that do not display Appropriate Legal Notices, your
+    work need not make them do so.
+
+A compilation of a covered work with other separate and independent
+works, which are not by their nature extensions of the covered work,
+and which are not combined with it such as to form a larger program,
+in or on a volume of a storage or distribution medium, is called an
+"aggregate" if the compilation and its resulting copyright are not
+used to limit the access or legal rights of the compilation's users
+beyond what the individual works permit.  Inclusion of a covered work
+in an aggregate does not cause this License to apply to the other
+parts of the aggregate.
+
+6. Conveying Non-Source Forms.
+
+You may convey a covered work in object code form under the terms
+of sections 4 and 5, provided that you also convey the
+machine-readable Corresponding Source under the terms of this License,
+in one of these ways:
+
+    a) Convey the object code in, or embodied in, a physical product
+    (including a physical distribution medium), accompanied by the
+    Corresponding Source fixed on a durable physical medium
+    customarily used for software interchange.
+
+    b) Convey the object code in, or embodied in, a physical product
+    (including a physical distribution medium), accompanied by a
+    written offer, valid for at least three years and valid for as
+    long as you offer spare parts or customer support for that product
+    model, to give anyone who possesses the object code either (1) a
+    copy of the Corresponding Source for all the software in the
+    product that is covered by this License, on a durable physical
+    medium customarily used for software interchange, for a price no
+    more than your reasonable cost of physically performing this
+    conveying of source, or (2) access to copy the
+    Corresponding Source from a network server at no charge.
+
+    c) Convey individual copies of the object code with a copy of the
+    written offer to provide the Corresponding Source.  This
+    alternative is allowed only occasionally and noncommercially, and
+    only if you received the object code with such an offer, in accord
+    with subsection 6b.
+
+    d) Convey the object code by offering access from a designated
+    place (gratis or for a charge), and offer equivalent access to the
+    Corresponding Source in the same way through the same place at no
+    further charge.  You need not require recipients to copy the
+    Corresponding Source along with the object code.  If the place to
+    copy the object code is a network server, the Corresponding Source
+    may be on a different server (operated by you or a third party)
+    that supports equivalent copying facilities, provided you maintain
+    clear directions next to the object code saying where to find the
+    Corresponding Source.  Regardless of what server hosts the
+    Corresponding Source, you remain obligated to ensure that it is
+    available for as long as needed to satisfy these requirements.
+
+    e) Convey the object code using peer-to-peer transmission, provided
+    you inform other peers where the object code and Corresponding
+    Source of the work are being offered to the general public at no
+    charge under subsection 6d.
+
+A separable portion of the object code, whose source code is excluded
+from the Corresponding Source as a System Library, need not be
+included in conveying the object code work.
+
+A "User Product" is either (1) a "consumer product", which means any
+tangible personal property which is normally used for personal, family,
+or household purposes, or (2) anything designed or sold for incorporation
+into a dwelling.  In determining whether a product is a consumer product,
+doubtful cases shall be resolved in favor of coverage.  For a particular
+product received by a particular user, "normally used" refers to a
+typical or common use of that class of product, regardless of the status
+of the particular user or of the way in which the particular user
+actually uses, or expects or is expected to use, the product.  A product
+is a consumer product regardless of whether the product has substantial
+commercial, industrial or non-consumer uses, unless such uses represent
+the only significant mode of use of the product.
+
+"Installation Information" for a User Product means any methods,
+procedures, authorization keys, or other information required to install
+and execute modified versions of a covered work in that User Product from
+a modified version of its Corresponding Source.  The information must
+suffice to ensure that the continued functioning of the modified object
+code is in no case prevented or interfered with solely because
+modification has been made.
+
+If you convey an object code work under this section in, or with, or
+specifically for use in, a User Product, and the conveying occurs as
+part of a transaction in which the right of possession and use of the
+User Product is transferred to the recipient in perpetuity or for a
+fixed term (regardless of how the transaction is characterized), the
+Corresponding Source conveyed under this section must be accompanied
+by the Installation Information.  But this requirement does not apply
+if neither you nor any third party retains the ability to install
+modified object code on the User Product (for example, the work has
+been installed in ROM).
+
+The requirement to provide Installation Information does not include a
+requirement to continue to provide support service, warranty, or updates
+for a work that has been modified or installed by the recipient, or for
+the User Product in which it has been modified or installed.  Access to a
+network may be denied when the modification itself materially and
+adversely affects the operation of the network or violates the rules and
+protocols for communication across the network.
+
+  Corresponding Source conveyed, and Installation Information provided,
+in accord with this section must be in a format that is publicly
+documented (and with an implementation available to the public in
+source code form), and must require no special password or key for
+unpacking, reading or copying.
+
+  7. Additional Terms.
+
+"Additional permissions" are terms that supplement the terms of this
+License by making exceptions from one or more of its conditions.
+Additional permissions that are applicable to the entire Program shall
+be treated as though they were included in this License, to the extent
+that they are valid under applicable law.  If additional permissions
+apply only to part of the Program, that part may be used separately
+under those permissions, but the entire Program remains governed by
+this License without regard to the additional permissions.
+
+When you convey a copy of a covered work, you may at your option
+remove any additional permissions from that copy, or from any part of
+it.  (Additional permissions may be written to require their own
+removal in certain cases when you modify the work.)  You may place
+additional permissions on material, added by you to a covered work,
+for which you have or can give appropriate copyright permission.
+
+Notwithstanding any other provision of this License, for material you
+add to a covered work, you may (if authorized by the copyright holders of
+that material) supplement the terms of this License with terms:
+
+    a) Disclaiming warranty or limiting liability differently from the
+    terms of sections 15 and 16 of this License; or
+
+    b) Requiring preservation of specified reasonable legal notices or
+    author attributions in that material or in the Appropriate Legal
+    Notices displayed by works containing it; or
+
+    c) Prohibiting misrepresentation of the origin of that material, or
+    requiring that modified versions of such material be marked in
+    reasonable ways as different from the original version; or
+
+    d) Limiting the use for publicity purposes of names of licensors or
+    authors of the material; or
+
+    e) Declining to grant rights under trademark law for use of some
+    trade names, trademarks, or service marks; or
+
+    f) Requiring indemnification of licensors and authors of that
+    material by anyone who conveys the material (or modified versions of
+    it) with contractual assumptions of liability to the recipient, for
+    any liability that these contractual assumptions directly impose on
+    those licensors and authors.
+
+All other non-permissive additional terms are considered "further
+restrictions" within the meaning of section 10.  If the Program as you
+received it, or any part of it, contains a notice stating that it is
+governed by this License along with a term that is a further
+restriction, you may remove that term.  If a license document contains
+a further restriction but permits relicensing or conveying under this
+License, you may add to a covered work material governed by the terms
+of that license document, provided that the further restriction does
+not survive such relicensing or conveying.
+
+If you add terms to a covered work in accord with this section, you
+must place, in the relevant source files, a statement of the
+additional terms that apply to those files, or a notice indicating
+where to find the applicable terms.
+
+Additional terms, permissive or non-permissive, may be stated in the
+form of a separately written license, or stated as exceptions;
+the above requirements apply either way.
+
+8. Termination.
+
+You may not propagate or modify a covered work except as expressly
+provided under this License.  Any attempt otherwise to propagate or
+modify it is void, and will automatically terminate your rights under
+this License (including any patent licenses granted under the third
+paragraph of section 11).
+
+However, if you cease all violation of this License, then your
+license from a particular copyright holder is reinstated (a)
+provisionally, unless and until the copyright holder explicitly and
+finally terminates your license, and (b) permanently, if the copyright
+holder fails to notify you of the violation by some reasonable means
+prior to 60 days after the cessation.
+
+Moreover, your license from a particular copyright holder is
+reinstated permanently if the copyright holder notifies you of the
+violation by some reasonable means, this is the first time you have
+received notice of violation of this License (for any work) from that
+copyright holder, and you cure the violation prior to 30 days after
+your receipt of the notice.
+
+Termination of your rights under this section does not terminate the
+licenses of parties who have received copies or rights from you under
+this License.  If your rights have been terminated and not permanently
+reinstated, you do not qualify to receive new licenses for the same
+material under section 10.
+
+9. Acceptance Not Required for Having Copies.
+
+You are not required to accept this License in order to receive or
+run a copy of the Program.  Ancillary propagation of a covered work
+occurring solely as a consequence of using peer-to-peer transmission
+to receive a copy likewise does not require acceptance.  However,
+nothing other than this License grants you permission to propagate or
+modify any covered work.  These actions infringe copyright if you do
+not accept this License.  Therefore, by modifying or propagating a
+covered work, you indicate your acceptance of this License to do so.
+
+10. Automatic Licensing of Downstream Recipients.
+
+Each time you convey a covered work, the recipient automatically
+receives a license from the original licensors, to run, modify and
+propagate that work, subject to this License.  You are not responsible
+for enforcing compliance by third parties with this License.
+
+An "entity transaction" is a transaction transferring control of an
+organization, or substantially all assets of one, or subdividing an
+organization, or merging organizations.  If propagation of a covered
+work results from an entity transaction, each party to that
+transaction who receives a copy of the work also receives whatever
+licenses to the work the party's predecessor in interest had or could
+give under the previous paragraph, plus a right to possession of the
+Corresponding Source of the work from the predecessor in interest, if
+the predecessor has it or can get it with reasonable efforts.
+
+You may not impose any further restrictions on the exercise of the
+rights granted or affirmed under this License.  For example, you may
+not impose a license fee, royalty, or other charge for exercise of
+rights granted under this License, and you may not initiate litigation
+(including a cross-claim or counterclaim in a lawsuit) alleging that
+any patent claim is infringed by making, using, selling, offering for
+sale, or importing the Program or any portion of it.
+
+11. Patents.
+
+A "contributor" is a copyright holder who authorizes use under this
+License of the Program or a work on which the Program is based.  The
+work thus licensed is called the contributor's "contributor version".
+
+A contributor's "essential patent claims" are all patent claims
+owned or controlled by the contributor, whether already acquired or
+hereafter acquired, that would be infringed by some manner, permitted
+by this License, of making, using, or selling its contributor version,
+but do not include claims that would be infringed only as a
+consequence of further modification of the contributor version.  For
+purposes of this definition, "control" includes the right to grant
+patent sublicenses in a manner consistent with the requirements of
+this License.
+
+Each contributor grants you a non-exclusive, worldwide, royalty-free
+patent license under the contributor's essential patent claims, to
+make, use, sell, offer for sale, import and otherwise run, modify and
+propagate the contents of its contributor version.
+
+In the following three paragraphs, a "patent license" is any express
+agreement or commitment, however denominated, not to enforce a patent
+(such as an express permission to practice a patent or covenant not to
+sue for patent infringement).  To "grant" such a patent license to a
+party means to make such an agreement or commitment not to enforce a
+patent against the party.
+
+If you convey a covered work, knowingly relying on a patent license,
+and the Corresponding Source of the work is not available for anyone
+to copy, free of charge and under the terms of this License, through a
+publicly available network server or other readily accessible means,
+then you must either (1) cause the Corresponding Source to be so
+available, or (2) arrange to deprive yourself of the benefit of the
+patent license for this particular work, or (3) arrange, in a manner
+consistent with the requirements of this License, to extend the patent
+license to downstream recipients.  "Knowingly relying" means you have
+actual knowledge that, but for the patent license, your conveying the
+covered work in a country, or your recipient's use of the covered work
+in a country, would infringe one or more identifiable patents in that
+country that you have reason to believe are valid.
+
+If, pursuant to or in connection with a single transaction or
+arrangement, you convey, or propagate by procuring conveyance of, a
+covered work, and grant a patent license to some of the parties
+receiving the covered work authorizing them to use, propagate, modify
+or convey a specific copy of the covered work, then the patent license
+you grant is automatically extended to all recipients of the covered
+work and works based on it.
+
+A patent license is "discriminatory" if it does not include within
+the scope of its coverage, prohibits the exercise of, or is
+conditioned on the non-exercise of one or more of the rights that are
+specifically granted under this License.  You may not convey a covered
+work if you are a party to an arrangement with a third party that is
+in the business of distributing software, under which you make payment
+to the third party based on the extent of your activity of conveying
+the work, and under which the third party grants, to any of the
+parties who would receive the covered work from you, a discriminatory
+patent license (a) in connection with copies of the covered work
+conveyed by you (or copies made from those copies), or (b) primarily
+for and in connection with specific products or compilations that
+contain the covered work, unless you entered into that arrangement,
+or that patent license was granted, prior to 28 March 2007.
+
+Nothing in this License shall be construed as excluding or limiting
+any implied license or other defenses to infringement that may
+otherwise be available to you under applicable patent law.
+
+12. No Surrender of Others' Freedom.
+
+If conditions are imposed on you (whether by court order, agreement or
+otherwise) that contradict the conditions of this License, they do not
+excuse you from the conditions of this License.  If you cannot convey a
+covered work so as to satisfy simultaneously your obligations under this
+License and any other pertinent obligations, then as a consequence you may
+not convey it at all.  For example, if you agree to terms that obligate you
+to collect a royalty for further conveying from those to whom you convey
+the Program, the only way you could satisfy both those terms and this
+License would be to refrain entirely from conveying the Program.
+
+13. Remote Network Interaction; Use with the GNU General Public License.
+
+Notwithstanding any other provision of this License, if you modify the
+Program, your modified version must prominently offer all users
+interacting with it remotely through a computer network (if your version
+supports such interaction) an opportunity to receive the Corresponding
+Source of your version by providing access to the Corresponding Source
+from a network server at no charge, through some standard or customary
+means of facilitating copying of software.  This Corresponding Source
+shall include the Corresponding Source for any work covered by version 3
+of the GNU General Public License that is incorporated pursuant to the
+following paragraph.
+
+Notwithstanding any other provision of this License, you have
+permission to link or combine any covered work with a work licensed
+under version 3 of the GNU General Public License into a single
+combined work, and to convey the resulting work.  The terms of this
+License will continue to apply to the part which is the covered work,
+but the work with which it is combined will remain governed by version
+3 of the GNU General Public License.
+
+14. Revised Versions of this License.
+
+The Free Software Foundation may publish revised and/or new versions of
+the GNU Affero General Public License from time to time.  Such new versions
+will be similar in spirit to the present version, but may differ in detail to
+address new problems or concerns.
+
+Each version is given a distinguishing version number.  If the
+Program specifies that a certain numbered version of the GNU Affero General
+Public License "or any later version" applies to it, you have the
+option of following the terms and conditions either of that numbered
+version or of any later version published by the Free Software
+Foundation.  If the Program does not specify a version number of the
+GNU Affero General Public License, you may choose any version ever published
+by the Free Software Foundation.
+
+If the Program specifies that a proxy can decide which future
+versions of the GNU Affero General Public License can be used, that proxy's
+public statement of acceptance of a version permanently authorizes you
+to choose that version for the Program.
+
+Later license versions may give you additional or different
+permissions.  However, no additional obligations are imposed on any
+author or copyright holder as a result of your choosing to follow a
+later version.
+
+15. Disclaimer of Warranty.
+
+THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
+APPLICABLE LAW.  EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
+HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
+OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
+THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+PURPOSE.  THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
+IS WITH YOU.  SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
+ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
+
+16. Limitation of Liability.
+
+IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
+WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
+THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
+GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
+USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
+DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
+PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
+EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
+SUCH DAMAGES.
+
+17. Interpretation of Sections 15 and 16.
+
+If the disclaimer of warranty and limitation of liability provided
+above cannot be given local legal effect according to their terms,
+reviewing courts shall apply local law that most closely approximates
+an absolute waiver of all civil liability in connection with the
+Program, unless a warranty or assumption of liability accompanies a
+copy of the Program in return for a fee.
+
+END OF TERMS AND CONDITIONS

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,18 @@
+/**
+ * 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,28 @@
+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],
+  versionHistory: [],
+};
+
+export default app;

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

@@ -0,0 +1,33 @@
+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,180 @@
+/** @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: 'inventory_2',
+        route: '/catalog',
+        title: 'course catalog',
+        translations: {
+          de: {
+            title: 'Vorlesungsverzeichnis',
+          },
+          en: {
+            title: 'course catalog',
+          },
+        },
+      },
+      {
+        icon: 'work',
+        route: '/jobs',
+        title: 'job postings',
+        translations: {
+          de: {
+            title: 'Jobangebote',
+          },
+          en: {
+            title: 'job postings',
+          },
+        },
+      },
+    ],
+    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: 'star',
+        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',
+          },
+        },
+      },
+      {
+        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,39 @@
+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 use primarily.' +
+    ' 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 use primarily.' +
+        ' 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,50 @@
+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,102 @@
+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,72 @@
+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: 2e6,
+  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,25 @@
+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,31 @@
+/**
+ * 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').ElasticsearchConfigFile}
+ */
+const config = {
+  internal: {
+    database: {
+      name: 'elasticsearch',
+      version: '8.4.2',
+      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,28 @@
+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,33 @@
+/**
+ * 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/default/tools/version.js

@@ -0,0 +1,37 @@
+import {readFile, readdir} from 'fs/promises';
+import url from 'url';
+import path from 'path';
+
+/**
+ * @example version(1, import.meta.url)
+ * @param options {Omit<import('@openstapps/core').SCAppVersionInfo, 'releaseNotes' | 'translations'>}
+ * @param base {string}
+ * @returns {Promise<import('@openstapps/core').SCAppVersionInfo>}
+ */
+export async function version(options, base) {
+  const de = await readFile(new URL(`${options.version}.de.md`, base), 'utf8');
+  const en = await readFile(new URL(`${options.version}.en.md`, base), 'utf8');
+
+  return {
+    ...options,
+    releaseNotes: de,
+    translations: {
+      en: {
+        releaseNotes: en,
+      },
+    },
+  };
+}
+
+/**
+ * @param base {string} Base path of the file as `import.meta.url`
+ * @returns {Promise<import('@openstapps/core').SCAppVersionInfo[]>}
+ */
+export async function versions(base) {
+  const directory = await readdir(path.dirname(url.fileURLToPath(base)));
+  const versions = [
+    ...new Set(directory.filter(it => it.endsWith('.md')).map(it => it.replace(/\.\w+\.md$/, ''))),
+  ].sort((a, b) => -a.localeCompare(b, undefined, {numeric: true}));
+
+  return Promise.all(versions.map(versionName => version({version: versionName}, base)));
+}

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,125 @@
+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,26 @@
+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,12 @@
+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,14 @@
+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,59 @@
+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';
+import versionHistory from './version-history/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: 'openid profile email offline_access',
+        url: 'https://idp.ub.uni-frankfurt.de/idp/profile/oidc',
+      },
+      endpoints: {
+        authorization: 'https://idp.ub.uni-frankfurt.de/idp/profile/oidc/authorize',
+        endSession: 'https://idp.ub.uni-frankfurt.de/idp/profile/oidc/end-session',
+        mapping: {
+          id: '$.preferred_username',
+          email: '$.mailPrimaryAddress',
+          familyName: '$.family_name',
+          givenName: '$.given_name',
+          name: '$.name',
+          role: '$.eduPersonPrimaryAffiliation',
+          studentId: '$.employeeNumber',
+        },
+        token: 'https://idp.ub.uni-frankfurt.de/idp/profile/oidc/token',
+        userinfo: 'https://idp.ub.uni-frankfurt.de/idp/profile/oidc/userinfo',
+        revoke: 'https://idp.ub.uni-frankfurt.de/idp/profile/oauth2/revocation',
+      },
+    },
+  },
+  app: {
+    ...defaultApp,
+    features: {
+      extern: {
+        hisometry: {
+          authProvider: 'default',
+          url: 'https://his-self-service.rz.uni-frankfurt.de/v2',
+        },
+        idCards: {
+          authProvider: 'default',
+          url: 'https://id-cards.rz.uni-frankfurt.de/v2/id-cards',
+        },
+      },
+    },
+    versionHistory,
+    aboutPages,
+  },
+  backend: defaultBackend,
+  internal: defaultInternal,
+  uid: 'f-u',
+};
+
+export default config;

backend/backend/config/f-u/version-history/2.4.0.de.md

@@ -0,0 +1,52 @@
+# Goethe-Uni App 2.4
+
+Wir freuen uns euch mehr in der Goethe-Uni App
+bieten zu können.
+
+## Navigation zu Gebäuden und Orten
+
+Als eines der Ergebnisse des Ideenwettbewerbs wurde jetzt
+ein Navigationsfeature in die App integriert.
+
+Orte auf der Karte, Mensen, sowie sogar Termine (wenn hinterlegt)
+bieten jetzt direkt die Option eine Verbindung zu finden, gestützt
+durch die Karten App auf deinem Gerät.
+
+## Integration der Jobbörse
+
+Jobs findest du ab sofort auch in der Goethe-Uni App.
+
+Auch das ist ein Ergebnis des Ideenwettbewerbs,
+und wir freuen uns es euch hier präsentieren zu können!
+
+## Der Umweltscore
+
+Der Umweltscore für Gerichte wird nun auch in der App angezeigt.
+
+> Nachhaltigkeit, Umweltschutz, Gesundheit und Klimawandel sind
+> zentrale Begriffe im gesellschaftlichen Miteinander.
+> Unsere Ernährung spielt hierbei eine wichtige Rolle.
+> Das Studierendenwerk Frankfurt am Main zeichnet seine Speisenpläne
+> ab sofort mit einem Umweltscore aus.
+> Anhand dieser Bewertung können Sie direkt ersehen,
+> welchen Einfluss Ihre Essenauswahl auf das Klima hat.
+
+## Weitere Verbesserungen
+
+### Performance
+
+Die Performance der App beim Navigieren wurde stark verbessert und ist datensparender.
+
+### Kalender
+
+Die Kalenderabschnitte haben jetzt neue Namen bekommen:
+
+- Der _Kalender_ zeigt Termine für spezifische Tage
+- Die _Wochenübersicht_ ist ein Stundenplan mit allen Termine, die sich wiederholen (z. B. Vorlesungen)
+- Die _Einzeltermine_ zeigen alle Termine, die sich nicht wiederholen
+  (z. B. Klausuren)
+
+### Meine App
+
+Der "Meine Kurse" Abschnitt wurde überarbeitet, und zeigt jetzt Termine
+für die nächsten Tage und mit mehr Details an.

backend/backend/config/f-u/version-history/2.4.0.en.md

@@ -0,0 +1,49 @@
+# Goethe-Uni App 2.4
+
+The Goethe-Uni App got even better!
+
+## Navigation to buildings and places
+
+As part of the "Ideenwettbewerb," the idea competition,
+we have now integrated a navigation feature into the app.
+
+Orte auf der Karte, Mensen, sowie sogar Termine (wenn hinterlegt)
+bieten jetzt direkt die Option eine Verbindung zu finden, gestützt
+durch die Karten App auf deinem Gerät.
+
+## Integration of the job market
+
+Jobs are now also available in the Goethe-Uni App.
+
+This feature is also a result of the idea competition,
+and we're happy to be able to present it to you here!
+
+## The environment score
+
+The environment score for dishes is now displayed inside the app.
+
+> Sustainability, environment protection, health, and climate change are
+> central topics in how we live today in our society.
+> Our eating habits play an important role in it.
+> The "Studierendenwerk Frankfurt am Main" is marking up its menus
+> from now on with the so-called "Umweltscore," the environment score.
+> Based on this rating, you can see the impact your meal choice would have on our climate.
+
+## Further improvements
+
+### Performance
+
+The performance while navigating around the app has been heavily improved and requires less data to work.
+
+### Calendar
+
+The calendar sections have new names:
+
+- The _calendar_ shows appointments on specific days
+- The _week overview_ is a schedule with all events that repeat (e.g. lectures)
+- The _single events_ show all appointments that don't repeat (e.g. exams)
+
+### My App
+
+The "my courses" section has been revamped,
+and now shows events for the next days and with more detail.

backend/backend/config/f-u/version-history/2.5.0.de.md

@@ -0,0 +1,15 @@
+# Goethe-Uni App 2.5
+
+Die Goethe-Uni App ist noch besser geworden!
+
+## Komplett neue Kartenansicht
+
+Wir haben die Karte überarbeitet, um eine klarere und schnellere Übersicht zu bieten.
+
+## Deutschlandticket mit an Bord
+
+Wenn du das Upgrade des Semesterticket zum Deutschlandticket gemacht hast und eingeloggt bist, findet es sich jetzt auch in der App.
+
+## Bibliotheksdienste sind wieder voll funktionsfähig
+
+Aufgrund einiger Adhoc-Änderungen im Bibliothekssystem haben wir die App so angepasst, dass sie damit umgehen kann.

backend/backend/config/f-u/version-history/2.5.0.en.md

@@ -0,0 +1,15 @@
+# Goethe-Uni App 2.5
+
+The Goethe-Uni App got even better!
+
+## Completely new map view
+
+We overhauled the map to offer you a clearer and faster and overview.
+
+## Deutschlandticket included
+
+If you upgraded your Semesterticket to a Deutschlandticket it will now reside in the App if you are logged in.
+
+## Library services are fully functional again
+
+Due to some adhoc changes in the library system we adjusted the app to handle them properly.

backend/backend/config/f-u/version-history/index.js

@@ -0,0 +1,6 @@
+import {versions} from '../../default/tools/version.js';
+
+/** @type {import('@openstapps/core').SCAppVersionInfo[]} */
+const versionHistory = await versions(import.meta.url);
+
+export default versionHistory;

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,125 @@
+{
+  "name": "@openstapps/backend",
+  "description": "A reference implementation for a StApps backend",
+  "version": "4.0.7",
+  "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\"",
+    "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.14.1",
+    "@openstapps/core": "workspace:*",
+    "@openstapps/core-tools": "workspace:*",
+    "@openstapps/logger": "workspace:*",
+    "@types/body-parser": "1.19.6",
+    "@types/cors": "2.8.13",
+    "@types/express": "4.17.17",
+    "@types/geojson": "1.0.6",
+    "@types/node": "22.15.31",
+    "@types/node-cron": "3.0.7",
+    "@types/promise-queue": "2.2.0",
+    "@types/uuid": "8.3.4",
+    "body-parser": "1.20.3",
+    "cors": "2.8.5",
+    "cosmiconfig": "8.1.3",
+    "deepmerge": "4.3.1",
+    "express": "4.21.2",
+    "express-prom-bundle": "6.6.0",
+    "express-promise-router": "4.1.1",
+    "got": "14.6.6",
+    "moment": "2.30.1",
+    "morgan": "1.10.1",
+    "nock": "13.3.1",
+    "node-cache": "5.1.2",
+    "node-cron": "3.0.2",
+    "nodemailer": "10.1.7",
+    "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.20",
+    "@types/chai-as-promised": "7.1.8",
+    "@types/mocha": "10.0.10",
+    "@types/morgan": "1.9.10",
+    "@types/sinon": "10.0.14",
+    "@types/sinon-express-mock": "1.3.9",
+    "@types/supertest": "2.0.12",
+    "c8": "10.1.3",
+    "chai": "4.5.0",
+    "chai-as-promised": "7.1.2",
+    "cross-env": "7.0.3",
+    "get-port": "5.1.1",
+    "mocha": "10.8.2",
+    "mocha-junit-reporter": "2.2.0",
+    "mocked-env": "1.3.5",
+    "sinon": "15.0.4",
+    "sinon-express-mock": "2.2.1",
+    "supertest": "6.3.3",
+    "ts-node": "10.9.2",
+    "tsup": "8.5.0",
+    "typescript": "5.9.3"
+  },
+  "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,48 @@
+import {cosmiconfig, PublicExplorer} from 'cosmiconfig';
+import {SCConfigFile} from '@openstapps/core';
+import path from 'path';
+import deepmerge from 'deepmerge';
+import {Logger} from '@openstapps/logger';
+
+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> {
+  const config = await configLoader(moduleName).search(path.posix.join('.', configPath, namespace));
+
+  if (config) {
+    Logger.info(`Using ${namespace} config for ${moduleName}`);
+    return config.config;
+  } else {
+    Logger.info(`Using ${fallbackNamespace} config for ${moduleName}`);
+    return configLoader(moduleName)
+      .search(path.posix.join('.', configPath, fallbackNamespace))
+      .then(it => it!.config);
+  }
+}
+
+const namespace = process.env.NODE_APP_INSTANCE;
+const database = process.env.NODE_CONFIG_ENV;
+
+export const prometheusConfig = await findConfig<unknown>('prometheus', namespace);
+
+const backendConfigWithoutDatabase = await findConfig<SCConfigFile>('backend', namespace);
+export const backendConfig = database
+  ? deepmerge(backendConfigWithoutDatabase, await findConfig<never>(database, namespace))
+  : backendConfigWithoutDatabase;

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 {SendMailOptions} from 'nodemailer';
+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: SendMailOptions[];
+
+  /**
+   * 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: SendMailOptions) {
+    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: SendMailOptions) {
+    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;
+}

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

@@ -0,0 +1,35 @@
+/*
+ * 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 {SCSearchRequest, SCSearchResponse, SCSearchRoute} from '@openstapps/core';
+import {BulkStorage} from '../storage/bulk-storage.js';
+import {createRoute} from './route.js';
+
+/**
+ * Contains information for using the search route
+ */
+const searchRouteModel = new SCSearchRoute();
+
+/**
+ * Implementation of the search route (SCSearchRoute)
+ */
+export const searchRouter = createRoute<SCSearchRequest, SCSearchResponse>(
+  searchRouteModel,
+  async (request, app) => {
+    const bulkMemory: BulkStorage = app.get('bulk');
+
+    return bulkMemory.database.search(request);
+  },
+);

backend/backend/src/routes/thing-update-route.ts

@@ -0,0 +1,36 @@
+/*
+ * 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 {SCThingUpdateRequest, SCThingUpdateResponse, SCThingUpdateRoute} from '@openstapps/core';
+import {BulkStorage} from '../storage/bulk-storage.js';
+import {createRoute} from './route.js';
+
+/**
+ * Contains information for using the route for updating single things
+ */
+const thingUpdateRouteModel = new SCThingUpdateRoute();
+
+/**
+ * Implementation of the thing update route (SCThingUpdateRoute)
+ */
+export const thingUpdateRouter = createRoute<SCThingUpdateRequest, SCThingUpdateResponse>(
+  thingUpdateRouteModel,
+  async (request, app) => {
+    const bulkMemory: BulkStorage = app.get('bulk');
+    await bulkMemory.database.put(request);
+
+    return {};
+  },
+);

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

@@ -0,0 +1,56 @@
+/*
+ * 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, SCPluginMetaData, SCValidationErrorResponse} from '@openstapps/core';
+import {Request} from 'express';
+import got from 'got';
+import {isTestEnvironment, validator} from '../common.js';
+import {backendConfig} from '../config.js';
+
+/**
+ * Generic route function used to proxy actual requests to plugins
+ * @param request The request for a plugin resource
+ * @param plugin Meta data of the plugin
+ * @throws {SCInternalServerErrorResponse} On request/response validation or response from the plugin errors
+ */
+export async function virtualPluginRoute(request: Request, plugin: SCPluginMetaData): Promise<object> {
+  try {
+    const requestValidation = validator.validate(request.body, plugin.requestSchema);
+    if (requestValidation.errors.length > 0) {
+      // noinspection ExceptionCaughtLocallyJS
+      throw new SCValidationErrorResponse(requestValidation.errors, isTestEnvironment);
+    }
+    // send the request to the plugin (forward the body) and save the response
+    const response = await got.post(plugin.route.replaceAll(/^\//gi, ''), {
+      prefixUrl: plugin.address,
+      json: request.body,
+      timeout: {
+        response: backendConfig.backend.externalRequestTimeout,
+      },
+      responseType: 'json',
+    });
+    const responseBody = response.body;
+    const responseValidation = validator.validate(responseBody, plugin.responseSchema);
+    if (responseValidation.errors.length > 0) {
+      // noinspection ExceptionCaughtLocallyJS
+      throw new SCValidationErrorResponse(responseValidation.errors, isTestEnvironment);
+    }
+    return responseBody as object;
+  } catch (error) {
+    // wrap exact error inside of the internal server error response
+    throw new SCInternalServerErrorResponse(error, isTestEnvironment);
+  }
+}

backend/backend/src/storage/bulk-storage.ts

@@ -0,0 +1,192 @@
+/*
+ * 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, SCThingType} from '@openstapps/core';
+import {Logger} from '@openstapps/logger';
+import moment from 'moment';
+import NodeCache from 'node-cache';
+import {v4} from 'uuid';
+import {Database} from './database.js';
+
+/**
+ * Possible operations with a bulk
+ */
+export type BulkOperation = 'create' | 'expired' | 'update';
+
+/**
+ * Describes an indexing process
+ */
+export class Bulk implements SCBulkRequest {
+  /**
+   * Expiration of the bulk
+   *
+   * If the bulk is not finished before the expiration date is hit, the bulk
+   * and all data associated with it will be deleted
+   */
+  expiration: string;
+
+  /**
+   * The data source of the bulk
+   *
+   * Bulks with same type and source will be replaced and the data will be
+   * updated when the bulk is marked as done
+   */
+  source: string;
+
+  /**
+   * State of the bulk
+   *
+   * Data can be indexed for this bulk as long as the state is `in progress`
+   * and the bulk is not expired
+   *
+   * When the bulk is marked as `done` it replaces the previous bulk with
+   * the same source and type. The data will be availabe to the user when
+   * the bulk switches to done
+   */
+  state: 'in progress' | 'done';
+
+  /**
+   * Type of data in the bulk
+   */
+  type: SCThingType;
+
+  /**
+   * Unique identifier of the bulk
+   */
+  uid: string;
+
+  /**
+   * Creates a new bulk process
+   * @param request Data needed for requesting a bulk
+   */
+  constructor(request: SCBulkRequest) {
+    this.uid = v4();
+    this.state = 'in progress';
+
+    this.expiration =
+      typeof request.expiration === 'string' ? request.expiration : moment().add(1, 'hour').toISOString();
+    // when should this process be finished
+    // where does the process come from
+    this.source = request.source;
+    // which type of data is this process about to index
+    this.type = request.type;
+  }
+}
+
+/**
+ * Cache for bulk-processes
+ */
+export class BulkStorage {
+  /**
+   * Cache for temporary storage
+   */
+  private readonly cache: NodeCache;
+
+  /**
+   * Creates a new BulkStorage
+   * @param database the database that is controlled by this bulk storage
+   */
+  constructor(public database: Database) {
+    // a bulk lives 60 minutes if no expiration is given
+    // the cache is checked every 60 seconds
+    this.cache = new NodeCache({stdTTL: 3600, checkperiod: 60});
+
+    this.cache.on('expired', async (_key, bulk: Bulk) => {
+      // if the bulk is not done
+      if (bulk.state !== 'done') {
+        // the database can delete the data associated with this bulk
+        await this.database.bulkExpired(bulk);
+      }
+    });
+  }
+
+  /**
+   * Saves a bulk process and assigns to it a user-defined ttl (time-to-live)
+   * @param bulk the bulk process to save
+   * @returns the bulk process that was saved
+   */
+  private save(bulk: Bulk): Bulk {
+    const expirationInSeconds = moment(bulk.expiration).diff(moment.now()) / 1000;
+    Logger.info('Bulk expires in ', expirationInSeconds, 'seconds');
+
+    // save the item in the cache with it's expected expiration
+    this.cache.set(bulk.uid, bulk, expirationInSeconds);
+
+    return bulk;
+  }
+
+  /**
+   * Create and save a new bulk process
+   * @param bulkRequest a request for a new bulk process
+   * @returns a promise that contains the new bulk process
+   */
+  public async create(bulkRequest: SCBulkRequest): Promise<Bulk> {
+    const bulk = new Bulk(bulkRequest);
+    bulk.source = bulkRequest.source;
+    bulk.type = bulkRequest.type;
+
+    this.save(bulk);
+
+    // tell the database that the bulk was created
+    await this.database.bulkCreated(bulk);
+
+    return bulk;
+  }
+
+  /**
+   * Delete a bulk process
+   * @param uid uid of the bulk process
+   * @returns a promise that contains the deleted bulk process
+   */
+  public async delete(uid: string): Promise<Bulk> {
+    const bulk = this.read(uid);
+
+    if (bulk === undefined) {
+      throw new TypeError(`Bulk that should be deleted was not found. UID was "${uid}"`);
+    }
+
+    // delete the bulk process from the cache
+    this.cache.del(uid);
+
+    // tell the database to handle the expiration of the bulk
+    await this.database.bulkExpired(bulk);
+
+    return bulk;
+  }
+
+  /**
+   * Update an old bulk process (replace it with the new one)
+   * @param bulk new bulk process
+   * @returns an empty promise
+   */
+  public async markAsDone(bulk: Bulk): Promise<void> {
+    bulk.state = 'done';
+    this.save(bulk);
+
+    // tell the database that this is the new bulk
+    await this.database.bulkUpdated(bulk);
+
+    return;
+  }
+
+  /**
+   * Read an existing bulk process
+   * @param uid uid of the bulk process
+   * @returns a promise that contains a bulk
+   */
+  public read(uid: string): Bulk | undefined {
+    return this.cache.get(uid);
+  }
+}

backend/backend/src/storage/database.ts

@@ -0,0 +1,109 @@
+/*
+ * 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 {
+  SCConfigFile,
+  SCPlace,
+  SCPlaceWithoutReferences,
+  SCSearchQuery,
+  SCSearchResponse,
+  SCThingWithCategoriesWithoutReferences,
+  SCThings,
+  SCUuid,
+} from '@openstapps/core';
+import {MailQueue} from '../notification/mail-queue.js';
+import {Bulk} from './bulk-storage.js';
+import {FeatureCollection, Point, Polygon} from 'geojson';
+
+/**
+ * Creates an instance of a database
+ */
+export type DatabaseConstructor = new (config: SCConfigFile, mailQueue?: MailQueue) => Database;
+
+export type SupplementaryGeoJSON = FeatureCollection<Point | Polygon, SupplementaryGeoJSONThing>;
+export type SupplementaryGeoJSONThing = Pick<
+  Extract<SCThings, SCPlace>,
+  Exclude<
+    keyof SCPlaceWithoutReferences | keyof SCThingWithCategoriesWithoutReferences<never, never>,
+    'geo' | 'origin' | 'translations'
+  >
+>;
+
+/**
+ * Defines what one database class needs to have defined
+ */
+export interface Database {
+  /**
+   * Gets called if a bulk was created
+   *
+   * The database should
+   * @param bulk A bulk to be created
+   */
+  bulkCreated(bulk: Bulk): Promise<void>;
+
+  /**
+   * Gets called if a bulk expires
+   *
+   * The database should delete all data that is associtated with this bulk
+   * @param bulk A bulk which data needs to be removed
+   */
+  bulkExpired(bulk: Bulk): Promise<void>;
+
+  /**
+   * Gets called if a bulk was updated
+   *
+   * If the database holds a bulk with the same type and source as the given
+   * bulk it should be replaced by the given one
+   * @param bulk A new bulk whose data should be saved instead of the data of the old bulk
+   */
+  bulkUpdated(bulk: Bulk): Promise<void>;
+
+  /**
+   * Get a single document
+   * @param uid Unique identifier of the document
+   */
+  get(uid: SCUuid): Promise<SCThings>;
+
+  /**
+   * Initialize the database (call and wait for all needed methods)
+   */
+  init(): Promise<void>;
+
+  /**
+   * Add a thing to an existing bulk
+   * @param thing A StAppsCore thing to be added
+   * @param bulk A bulk to which the thing should be added
+   */
+  post(thing: SCThings, bulk: Bulk): Promise<void>;
+
+  /**
+   * Replace an existing thing in any Bulk
+   *
+   * Currently it is not possible to put an non-existing object
+   * @param thing A StAppsCore thing to be added to a bulk
+   */
+  put(thing: SCThings): Promise<void>;
+
+  /**
+   * Search for things
+   * @param params Parameters which form a search query to search the backend data
+   */
+  search(parameters: SCSearchQuery): Promise<SCSearchResponse>;
+
+  /**
+   * Get geo info for display on a map
+   */
+  geo(): Promise<SupplementaryGeoJSON>;
+}

backend/backend/src/storage/elasticsearch/aggregations.ts

@@ -0,0 +1,58 @@
+/*
+ * 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 {
+  AggregateName,
+  AggregationsAggregate,
+  AggregationsFiltersAggregate,
+  AggregationsMultiTermsBucket,
+} from '@elastic/elasticsearch/lib/api/types.js';
+import {SCFacet, SCThingType} from '@openstapps/core';
+
+/**
+ * Parses elasticsearch aggregations (response from es) to facets for the app
+ * @param aggregationResponse - aggregations response from elasticsearch
+ */
+export function parseAggregations(
+  aggregationResponse: Record<AggregateName, AggregationsAggregate>,
+): SCFacet[] {
+  const facets: SCFacet[] = [];
+
+  for (const aggregateName in aggregationResponse) {
+    const aggregation = aggregationResponse[aggregateName] as AggregationsMultiTermsBucket;
+    const type = aggregateName === '@all' ? {} : {onlyOnType: aggregateName as SCThingType};
+
+    for (const field in aggregation) {
+      const fieldAggregate = aggregation[field] as AggregationsFiltersAggregate;
+      if (typeof fieldAggregate !== 'object') continue;
+
+      const buckets = Object.values(fieldAggregate.buckets).map(bucket => {
+        return {
+          count: bucket.doc_count,
+          key: bucket.key as string,
+        };
+      });
+      if (buckets.length === 0) continue;
+
+      facets.push({
+        buckets,
+        field,
+        ...type,
+      });
+    }
+  }
+
+  return facets;
+}

backend/backend/src/storage/elasticsearch/elasticsearch.ts

@@ -0,0 +1,454 @@
+/*
+ * Copyright (C) 2022 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 {Client, events} from '@elastic/elasticsearch';
+import {
+  AggregateName,
+  AggregationsMultiTermsBucket,
+  IndicesGetAliasResponse,
+  SearchHit,
+  SearchResponse,
+} from '@elastic/elasticsearch/lib/api/types.js';
+import {SCConfigFile, SCSearchQuery, SCSearchResponse, SCThings, SCUuid} from '@openstapps/core';
+import {Logger} from '@openstapps/logger';
+import moment from 'moment';
+import {MailQueue} from '../../notification/mail-queue.js';
+import {Bulk} from '../bulk-storage.js';
+import {Database, SupplementaryGeoJSON, SupplementaryGeoJSONThing} from '../database.js';
+import {parseAggregations} from './aggregations.js';
+import * as Monitoring from './monitoring.js';
+import {buildQuery} from './query/query.js';
+import {buildSort} from './query/sort.js';
+import {aggregations, putTemplate} from './templating.js';
+import {
+  ElasticsearchConfig,
+  ElasticsearchQueryDisMaxConfig,
+  ElasticsearchQueryQueryStringConfig,
+} from './types/elasticsearch-config.js';
+import {
+  ACTIVE_INDICES_ALIAS,
+  getThingIndexName,
+  INACTIVE_INDICES_ALIAS,
+  matchIndexByType,
+  VALID_INDEX_REGEX,
+} from './util/index.js';
+import {noUndefined} from './util/no-undefined.js';
+import {retryCatch, RetryOptions} from './util/retry.js';
+import {Feature, Point, Polygon} from 'geojson';
+
+/**
+ * A database interface for elasticsearch
+ */
+export class Elasticsearch implements Database {
+  /**
+   * Elasticsearch client
+   */
+  client: Client;
+
+  /**
+   * Queue of mails to be sent
+   */
+  mailQueue: MailQueue | undefined;
+
+  /**
+   * Stores information if elasticsearch is ready (connection to it has been established)
+   */
+  ready: boolean;
+
+  /**
+   * Get the url of elasticsearch
+   */
+  static getElasticsearchUrl(): string {
+    // check if we have a docker link
+    if (process.env.ES_ADDR !== undefined) {
+      return process.env.ES_ADDR;
+    }
+
+    // default
+    return 'http://localhost:9200';
+  }
+
+  /**
+   * Create a new interface for elasticsearch
+   * @param config an assembled config file
+   * @param mailQueue a mail queue for monitoring
+   */
+  constructor(
+    private readonly config: SCConfigFile,
+    mailQueue?: MailQueue,
+  ) {
+    if (config.internal.database === undefined || typeof config.internal.database.version !== 'string') {
+      throw new TypeError('Database version is undefined. Check your config file');
+    }
+
+    this.client = new Client({
+      node: Elasticsearch.getElasticsearchUrl(),
+    });
+    this.client.diagnostic.on(events.REQUEST, async (error: Error | null, result: unknown) => {
+      if (error !== null) {
+        await Logger.error(error);
+      }
+      if (process.env.ES_DEBUG === 'true') {
+        Logger.log(result);
+      }
+    });
+
+    this.ready = false;
+
+    this.mailQueue = mailQueue;
+  }
+
+  /**
+   * Gets a map which contains each alias and all indices that are associated with each alias
+   */
+  private async cleanupDeadIndices(retryOptions: Partial<RetryOptions<IndicesGetAliasResponse>> = {}) {
+    const aliasResponse = await retryCatch({
+      maxRetries: 10,
+      retryInterval: 2000,
+      doAction: () => this.client.indices.getAlias(),
+      onFailedAttempt: (attempt, error, {maxRetries, retryInterval}) => {
+        Logger.warn('Failed getting alias map:', error);
+        Logger.warn(`Retrying in ${retryInterval} milliseconds. (${attempt} of ${maxRetries})`);
+      },
+      onFail: ({maxRetries}) => {
+        throw new TypeError(`Failed to retrieve alias map after ${maxRetries} attempts!`);
+      },
+      ...retryOptions,
+    });
+
+    this.ready = true;
+
+    const inactiveIndices = Object.entries(aliasResponse)
+      .filter(([_, aliases]) => Object.keys(aliases.aliases).includes(INACTIVE_INDICES_ALIAS))
+      .map(([indexName]) => indexName);
+
+    if (inactiveIndices.length > 0) {
+      await this.client.indices.delete({
+        index: inactiveIndices,
+      });
+      Logger.warn(`Deleted old indices: ${inactiveIndices}`);
+    }
+  }
+
+  /**
+   * Provides an elasticsearch object using containing thing's UID
+   * @param uid an UID to use for the search
+   * @returns an elasticsearch object containing the thing
+   */
+  private async getObject(uid: SCUuid): Promise<SearchHit<SCThings> | undefined> {
+    const searchResponse = await this.client.search<SCThings>({
+      body: {
+        query: {
+          term: {
+            'uid.raw': {
+              value: uid,
+            },
+          },
+        },
+      },
+      from: 0,
+      allow_no_indices: true,
+      index: ACTIVE_INDICES_ALIAS,
+      size: 1,
+    });
+
+    // return data from response
+    return searchResponse.hits.hits[0];
+  }
+
+  async prepareBulkWrite(bulk: Bulk): Promise<string> {
+    if (!this.ready) {
+      throw new Error('No connection to elasticsearch established yet.');
+    }
+
+    const index = getThingIndexName(bulk.type, bulk.source, bulk);
+
+    if (!VALID_INDEX_REGEX.test(index)) {
+      throw new Error(
+        `Index names can only consist of lowercase letters from a-z, "-", "_" and integer numbers.
+          Make sure to set the bulk "source" and "type" to names consisting of the characters above.`,
+      );
+    }
+
+    return index;
+  }
+
+  /**
+   * Should be called when a new bulk was created. Creates a new index and applies the mapping to the index
+   * @param bulk the bulk process that was created
+   */
+  public async bulkCreated(bulk: Bulk): Promise<void> {
+    const index = await this.prepareBulkWrite(bulk);
+
+    // re-apply the index template before each new bulk operation
+    await putTemplate(this.client, bulk.type);
+    await this.client.indices.create({
+      index,
+      aliases: {
+        [INACTIVE_INDICES_ALIAS]: {},
+      },
+    });
+
+    Logger.info('Created index', index);
+  }
+
+  /**
+   * Should be called when a bulk process is expired. The index that was created with this bulk gets deleted
+   * @param bulk the bulk process that is expired
+   */
+  public async bulkExpired(bulk: Bulk): Promise<void> {
+    const index = await this.prepareBulkWrite(bulk);
+
+    Logger.info('Bulk expired. Deleting index', index);
+
+    // don't delete indices that are in use already
+    if (bulk.state !== 'done') {
+      Logger.info('deleting obsolete index', index);
+
+      await this.client.indices.delete({index});
+    }
+  }
+
+  /**
+   * Should be called when a bulk process is updated (replaced by a newer bulk). This will replace the old
+   * index and publish all data that was indexed in the new instead
+   * @param bulk the new bulk process that should replace the old one with the same type and source
+   */
+  public async bulkUpdated(bulk: Bulk): Promise<void> {
+    const index = await this.prepareBulkWrite(bulk);
+
+    await this.client.indices.refresh({index, allow_no_indices: false});
+
+    const activeIndices = await this.client.indices
+      .getAlias({
+        index: matchIndexByType(bulk.type, bulk.source),
+        name: ACTIVE_INDICES_ALIAS,
+      })
+      .then(it => Object.entries(it).map(([name]) => name))
+      .catch(() => [] as string[]);
+
+    await this.client.indices.updateAliases({
+      actions: [
+        {
+          add: {index, alias: ACTIVE_INDICES_ALIAS},
+        },
+        {
+          remove: {index, alias: INACTIVE_INDICES_ALIAS},
+        },
+        ...activeIndices.map(index => ({
+          remove_index: {index},
+        })),
+      ],
+    });
+    Logger.info(`Index for ${bulk.type} is now ${index}`);
+    Logger.info(`Also removed obsolete indices ${activeIndices}`);
+  }
+
+  /**
+   * Gets an SCThing from all indexed data
+   * @param uid uid of an SCThing
+   */
+  public async get(uid: SCUuid): Promise<SCThings> {
+    const object = await this.getObject(uid);
+
+    if (object?._source === undefined) {
+      throw new TypeError('Item not found.');
+    }
+
+    return object._source;
+  }
+
+  /**
+   * Initialize the elasticsearch database (call all needed methods)
+   */
+  public async init(retryOptions: Partial<RetryOptions<IndicesGetAliasResponse>> = {}): Promise<void> {
+    const monitoringConfiguration = this.config.internal.monitoring;
+
+    if (monitoringConfiguration !== undefined) {
+      if (this.mailQueue === undefined) {
+        throw new TypeError(
+          'Monitoring is defined, but MailQueue is undefined. A MailQueue is obligatory for monitoring.',
+        );
+      }
+      // read all watches and schedule searches on the client
+      await Monitoring.setUp(monitoringConfiguration, this.client, this.mailQueue);
+    }
+
+    return this.cleanupDeadIndices(retryOptions);
+  }
+
+  /**
+   * Add an item to an index
+   * @param object the SCThing to add to the index
+   * @param bulk the bulk process which item belongs to
+   */
+  public async post(object: SCThings, bulk: Bulk): Promise<void> {
+    const index = await this.prepareBulkWrite(bulk);
+    const thing: SCThings & {creation_date: string} = {
+      ...object,
+      creation_date: moment().format(),
+    };
+
+    const conflictingThing = await this.client.search({
+      query: {
+        term: {
+          'uid.raw': {
+            value: thing.uid,
+          },
+        },
+      },
+      // matches all indices but excludes indices of the same type
+      // https://www.elastic.co/guide/en/elasticsearch/reference/7.14/multi-index.html#multi-index
+      index: ['stapps_*', `-${matchIndexByType(bulk.type, bulk.source)}`],
+    });
+    if (conflictingThing.hits.hits.length > 0) {
+      throw new Error(
+        `UID conflict: ${thing.uid}. ${index} tried to post an object that already exists but which it won't replace.`,
+      );
+    }
+
+    const searchResponse = await this.client.create<SCThings>({
+      document: thing,
+      id: thing.uid,
+      index,
+      timeout: '90s',
+    });
+
+    if (searchResponse.result !== 'created') {
+      throw new Error(
+        `Object creation Error (${searchResponse.result}: Instance was: ${JSON.stringify(thing)}`,
+      );
+    }
+  }
+
+  /**
+   * Put (update) an existing item
+   * @param object SCThing to put
+   */
+  public async put(object: SCThings): Promise<void> {
+    const item = await this.getObject(object.uid);
+
+    if (item !== undefined) {
+      await this.client.update({
+        body: {
+          doc: object,
+        },
+        id: object.uid,
+        index: item._index,
+      });
+
+      return;
+    }
+
+    throw new Error('You tried to PUT an non-existing object. PUT is only supported on existing objects.');
+  }
+
+  /**
+   * Search all indexed data
+   * @param parameters search query
+   */
+  public async search(parameters: SCSearchQuery): Promise<SCSearchResponse> {
+    if (this.config.internal.database === undefined) {
+      throw new TypeError('Database is undefined. You have to configure the query build');
+    }
+
+    const esConfig: ElasticsearchConfig = {
+      name: this.config.internal.database.name as 'elasticsearch',
+      version: this.config.internal.database.version as string,
+      query: this.config.internal.database.query as
+        | ElasticsearchQueryDisMaxConfig
+        | ElasticsearchQueryQueryStringConfig
+        | undefined,
+    };
+
+    const response: SearchResponse<SCThings> = await this.client.search({
+      aggs: aggregations,
+      query: buildQuery(parameters, this.config, esConfig),
+      from: parameters.from,
+      index: ACTIVE_INDICES_ALIAS,
+      allow_no_indices: true,
+      size: parameters.size,
+      sort: parameters.sort === undefined ? undefined : buildSort(parameters.sort),
+    });
+
+    return {
+      data: response.hits.hits
+        .map(hit => {
+          // we only directly return the _source documents
+          // elasticsearch provides much more information, the user shouldn't see
+          return hit._source;
+        })
+        .filter(noUndefined),
+      facets:
+        response.aggregations === undefined
+          ? []
+          : parseAggregations(response.aggregations as Record<AggregateName, AggregationsMultiTermsBucket>),
+      pagination: {
+        count: response.hits.hits.length,
+        offset: typeof parameters.from === 'number' ? parameters.from : 0,
+        total:
+          typeof response.hits.total === 'number' ? response.hits.total : response.hits.total?.value ?? 0,
+      },
+      stats: {
+        time: response.took,
+      },
+    };
+  }
+
+  async geo(): Promise<SupplementaryGeoJSON> {
+    const searchResponse = await this.client.search<Extract<SCThings, {geo: unknown}>>({
+      body: {
+        query: {
+          exists: {
+            field: 'geo',
+          },
+        },
+      },
+      from: 0,
+      allow_no_indices: true,
+      index: ACTIVE_INDICES_ALIAS,
+      size: 1,
+    });
+
+    return {
+      type: 'FeatureCollection',
+      features: searchResponse.hits.hits
+        .map(thing => {
+          return thing._source?.geo
+            ? ({
+                id: Number(thing._source.identifiers?.['OSM']) || undefined,
+                type: 'Feature',
+                geometry: thing._source.geo.polygon ?? thing._source.geo.point,
+                properties: {
+                  name: thing._source.name,
+                  sameAs: thing._source.sameAs,
+                  image: thing._source.image,
+                  alternateNames: thing._source.alternateNames,
+                  description: thing._source.description,
+                  identifiers: thing._source.identifiers,
+                  categories: thing._source.categories,
+                  categorySpecificValues: thing._source.categorySpecificValues,
+                  openingHours: thing._source.openingHours,
+                  address: thing._source.address,
+                  uid: thing._source.uid,
+                  type: thing._source.type,
+                },
+              } satisfies Feature<Polygon | Point, SupplementaryGeoJSONThing>)
+            : undefined;
+        })
+        .filter(noUndefined),
+    };
+  }
+}

backend/backend/src/storage/elasticsearch/monitoring.ts

@@ -0,0 +1,147 @@
+/*
+ * 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 {Client} from '@elastic/elasticsearch';
+import {SearchRequest} from '@elastic/elasticsearch/lib/api/types.js';
+import {
+  SCMonitoringConfiguration,
+  SCMonitoringLogAction,
+  SCMonitoringMailAction,
+  SCMonitoringMaximumLengthCondition,
+  SCMonitoringMinimumLengthCondition,
+  SCThings,
+} from '@openstapps/core';
+import {Logger} from '@openstapps/logger';
+import cron from 'node-cron';
+import {MailQueue} from '../../notification/mail-queue.js';
+
+/**
+ * Check if the given condition fails on the given number of results and the condition
+ * @param condition condition
+ * @param total number of results
+ */
+function conditionFails(
+  condition: SCMonitoringMaximumLengthCondition | SCMonitoringMinimumLengthCondition,
+  total: number,
+) {
+  if (condition.type === 'MaximumLength') {
+    return maxConditionFails(condition.length, total);
+  }
+
+  return minConditionFails(condition.length, total);
+}
+
+/**
+ * Check if the min condition fails
+ * @param minimumLength Minimal length allowed
+ * @param total Number of results
+ */
+function minConditionFails(minimumLength: number, total: number) {
+  return minimumLength > total;
+}
+
+/**
+ * Check if the max condition fails
+ * @param maximumLength Maximal length allowed
+ * @param total Number of results
+ */
+function maxConditionFails(maximumLength: number, total: number) {
+  return maximumLength < total;
+}
+
+/**
+ * Run all the given actions
+ * @param actions actions to perform
+ * @param watcherName name of watcher that wants to perform them
+ * @param triggerName name of trigger that triggered the watcher
+ * @param total total number of results of the query
+ * @param mailQueue mailQueue to execute mail actions
+ */
+function runActions(
+  actions: Array<SCMonitoringLogAction | SCMonitoringMailAction>,
+  watcherName: string,
+  triggerName: string,
+  total: number,
+  mailQueue: MailQueue,
+) {
+  for (const action of actions) {
+    void (action.type === 'log'
+      ? Logger.error(
+          action.prefix,
+          `Watcher '${watcherName}' failed. Watcher was triggered by '${triggerName}'`,
+          `Found ${total} hits instead`,
+          action.message,
+        )
+      : mailQueue.push({
+          subject: action.subject,
+          text: `Watcher '${watcherName}' failed. Watcher was triggered by '${triggerName}'
+          ${action.message} Found ${total} hits instead`,
+          to: action.recipients,
+        }));
+  }
+}
+
+/**
+ * Set up the triggers for the configured watchers
+ * @param monitoringConfig configuration of the monitoring
+ * @param esClient elasticsearch client
+ * @param mailQueue mailQueue for mail actions
+ */
+export async function setUp(
+  monitoringConfig: SCMonitoringConfiguration,
+  esClient: Client,
+  mailQueue: MailQueue,
+) {
+  // set up Watches
+  for (const watcher of monitoringConfig.watchers) {
+    // make a schedule for each trigger
+    for (const trigger of watcher.triggers) {
+      switch (trigger.executionTime) {
+        case 'hourly': {
+          trigger.executionTime = '5 * * * *';
+          break;
+        }
+        case 'daily': {
+          trigger.executionTime = '5 0 * * *';
+          break;
+        }
+        case 'weekly': {
+          trigger.executionTime = '5 0 * * 0';
+          break;
+        }
+        case 'monthly': {
+          trigger.executionTime = '5 0 1 * *';
+        }
+      }
+
+      cron.schedule(trigger.executionTime, async () => {
+        // execute watch (search->condition->action)
+        const result = await esClient.search<SCThings>(watcher.query as SearchRequest);
+
+        // check conditions
+        const total =
+          typeof result.hits.total === 'number' ? result.hits.total : result.hits.total?.value ?? -1;
+
+        for (const condition of watcher.conditions) {
+          if (conditionFails(condition, total)) {
+            runActions(watcher.actions, watcher.name, trigger.name, total, mailQueue);
+          }
+        }
+      });
+    }
+  }
+
+  Logger.log(`Scheduled ${monitoringConfig.watchers.length} watches`);
+}

backend/backend/src/storage/elasticsearch/query/boost/boost-functions.ts

@@ -0,0 +1,74 @@
+/*
+ * Copyright (C) 2022 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 {QueryDslFunctionScoreContainer} from '@elastic/elasticsearch/lib/api/types.js';
+import {SCBackendConfigurationSearchBoostingType} from '@openstapps/core';
+import {QueryDslSpecificQueryContainer} from '../../types/util.js';
+
+/**
+ * Creates boost functions for all type boost configurations
+ * @param boostingTypes Array of type boosting configurations
+ */
+export function buildFunctionsForBoostingTypes(
+  boostingTypes: SCBackendConfigurationSearchBoostingType[],
+): QueryDslFunctionScoreContainer[] {
+  const functions: QueryDslFunctionScoreContainer[] = [];
+
+  for (const boostingForOneSCType of boostingTypes) {
+    const typeFilter: QueryDslSpecificQueryContainer<'term'> = {
+      term: {
+        type: boostingForOneSCType.type,
+      },
+    };
+
+    functions.push({
+      filter: typeFilter,
+      weight: boostingForOneSCType.factor,
+    });
+
+    if (boostingForOneSCType.fields !== undefined) {
+      const fields = boostingForOneSCType.fields;
+
+      for (const fieldName in boostingForOneSCType.fields) {
+        if (boostingForOneSCType.fields.hasOwnProperty(fieldName)) {
+          const boostingForOneField = fields[fieldName];
+
+          for (const value in boostingForOneField) {
+            if (boostingForOneField.hasOwnProperty(value)) {
+              const factor = boostingForOneField[value];
+
+              // build term filter
+              const termFilter: QueryDslSpecificQueryContainer<'term'> = {
+                term: {},
+              };
+              termFilter.term[`${fieldName}.raw`] = value;
+
+              functions.push({
+                filter: {
+                  bool: {
+                    must: [typeFilter, termFilter],
+                    should: [],
+                  },
+                },
+                weight: factor,
+              });
+            }
+          }
+        }
+      }
+    }
+  }
+
+  return functions;
+}

backend/backend/src/storage/elasticsearch/query/boost/scoring-functions.ts

@@ -0,0 +1,37 @@
+/*
+ * Copyright (C) 2022 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 {QueryDslFunctionScoreContainer} from '@elastic/elasticsearch/lib/api/types.js';
+import {SCBackendConfigurationSearchBoostingContext, SCSearchContext} from '@openstapps/core';
+import {buildFunctionsForBoostingTypes} from './boost-functions.js';
+
+/**
+ * Builds scoring functions from boosting config
+ * @param boostings Backend boosting configuration for contexts and types
+ * @param context The context of the app from where the search was initiated
+ */
+export function buildScoringFunctions(
+  boostings: SCBackendConfigurationSearchBoostingContext,
+  context: SCSearchContext | undefined,
+): QueryDslFunctionScoreContainer[] {
+  // default context
+  let functions = buildFunctionsForBoostingTypes(boostings['default' as SCSearchContext]);
+
+  if (context !== undefined && context !== 'default') {
+    // specific context provided, extend default context with additional boosts
+    functions = [...functions, ...buildFunctionsForBoostingTypes(boostings[context])];
+  }
+
+  return functions;
+}

backend/backend/src/storage/elasticsearch/query/filter.ts

@@ -0,0 +1,53 @@
+/*
+ * Copyright (C) 2022 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 {QueryDslQueryContainer} from '@elastic/elasticsearch/lib/api/types.js';
+import {SCSearchFilter} from '@openstapps/core';
+import {buildBooleanFilter} from './filters/boolean.js';
+import {buildAvailabilityFilter} from './filters/availability.js';
+import {buildDateRangeFilter} from './filters/date-range.js';
+import {buildDistanceFilter} from './filters/distance.js';
+import {buildGeoFilter} from './filters/geo.js';
+import {buildNumericRangeFilter} from './filters/numeric-range.js';
+import {buildValueFilter} from './filters/value.js';
+
+/**
+ * Converts Array of Filters to elasticsearch query-syntax
+ * @param filter A search filter for the retrieval of the data
+ */
+export function buildFilter(filter: SCSearchFilter): QueryDslQueryContainer {
+  switch (filter.type) {
+    case 'value': {
+      return buildValueFilter(filter);
+    }
+    case 'availability': {
+      return buildAvailabilityFilter(filter);
+    }
+    case 'distance': {
+      return buildDistanceFilter(filter);
+    }
+    case 'boolean': {
+      return buildBooleanFilter(filter);
+    }
+    case 'numeric range': {
+      return buildNumericRangeFilter(filter);
+    }
+    case 'date range': {
+      return buildDateRangeFilter(filter);
+    }
+    case 'geo': {
+      return buildGeoFilter(filter);
+    }
+  }
+}

backend/backend/src/storage/elasticsearch/query/filters/availability.ts

@@ -0,0 +1,37 @@
+/*
+ * Copyright (C) 2022 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 {SCSearchAvailabilityFilter} from '@openstapps/core';
+import {QueryDslSpecificQueryContainer} from '../../types/util.js';
+
+/**
+ * Converts an availability filter to elasticsearch syntax
+ * @param filter A search filter for the retrieval of the data
+ */
+export function buildAvailabilityFilter(
+  filter: SCSearchAvailabilityFilter,
+): QueryDslSpecificQueryContainer<'range'> {
+  const scope = filter.arguments.scope?.charAt(0) ?? 's';
+  const time = filter.arguments.time === undefined ? 'now' : `${filter.arguments.time}||`;
+
+  return {
+    range: {
+      [filter.arguments.field]: {
+        gte: `${time}/${scope}`,
+        lt: `${time}+1${scope}/${scope}`,
+        relation: 'intersects',
+      },
+    },
+  };
+}

backend/backend/src/storage/elasticsearch/query/filters/boolean.ts

@@ -0,0 +1,48 @@
+/*
+ * Copyright (C) 2022 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 {QueryDslBoolQuery} from '@elastic/elasticsearch/lib/api/types.js';
+import {SCSearchBooleanFilter} from '@openstapps/core';
+import {QueryDslSpecificQueryContainer} from '../../types/util.js';
+import {buildFilter} from '../filter.js';
+
+/**
+ * Converts a boolean filter to elasticsearch syntax
+ * @param filter A search filter for the retrieval of the data
+ */
+export function buildBooleanFilter(filter: SCSearchBooleanFilter): QueryDslSpecificQueryContainer<'bool'> {
+  const result: QueryDslBoolQuery = {
+    minimum_should_match: 0,
+    must: [],
+    must_not: [],
+    should: [],
+  };
+
+  if (filter.arguments.operation === 'and') {
+    result.must = filter.arguments.filters.map(it => buildFilter(it));
+  }
+
+  if (filter.arguments.operation === 'or') {
+    result.should = filter.arguments.filters.map(it => buildFilter(it));
+    result.minimum_should_match = 1;
+  }
+
+  if (filter.arguments.operation === 'not') {
+    result.must_not = filter.arguments.filters.map(it => buildFilter(it));
+  }
+
+  return {
+    bool: result,
+  };
+}