0.28.0

Fixes #80

.gitlab-ci.yml

@@ -12,6 +12,7 @@ stages:
   - build
   - test
   - deploy
+  - publish
 
 build:
   tags:
@@ -50,6 +51,21 @@ test:
       - report
       - coverage
 
+package:
+  dependencies:
+    - build
+  tags:
+    - secrecy
+  stage: publish
+  script:
+    - echo "//registry.npmjs.org/:_authToken=$NPM_AUTH_TOKEN" > ~/.npmrc
+    - npm publish
+  only:
+    - /^v[0-9]+.[0-9]+.[0-9]+$/
+  artifacts:
+    paths:
+      - lib
+
 pages:
   stage: deploy
   script:

CHANGELOG.md

@@ -1,3 +1,103 @@
+# [0.27.0](https://gitlab.com/openstapps/core/compare/v0.26.0...v0.27.0) (2019-09-03)
+
+
+### Features
+
+* add [@filterable](https://gitlab.com/filterable) tags ([fec3371](https://gitlab.com/openstapps/core/commit/fec3371))
+
+
+
+# [0.26.0](https://gitlab.com/openstapps/core/compare/v0.25.0...v0.26.0) (2019-08-19)
+
+
+### Bug Fixes
+
+* complete german translations ([bad15dc](https://gitlab.com/openstapps/core/commit/bad15dc))
+
+
+### Features
+
+* add pluginRequestTimeout field to backend config ([88f579e](https://gitlab.com/openstapps/core/commit/88f579e))
+
+
+
+# [0.25.0](https://gitlab.com/openstapps/core/compare/v0.24.0...v0.25.0) (2019-07-25)
+
+
+### Bug Fixes
+
+* correct package job ([d4a8ef6](https://gitlab.com/openstapps/core/commit/d4a8ef6))
+
+
+
+# [0.24.0](https://gitlab.com/openstapps/core/compare/v0.23.1...v0.24.0) (2019-07-23)
+
+
+### Features
+
+* add new field receivingOrganisations to message ([d781dd6](https://gitlab.com/openstapps/core/commit/d781dd6))
+
+
+
+## [0.23.1](https://gitlab.com/openstapps/core/compare/v0.23.0...v0.23.1) (2019-07-15)
+
+
+### Bug Fixes
+
+* use correct generic for the distance filter ([f262a6b](https://gitlab.com/openstapps/core/commit/f262a6b))
+
+
+### Features
+
+* add type maps from routes to requests and responses ([e1d4b2b](https://gitlab.com/openstapps/core/commit/e1d4b2b)), closes [#80](https://gitlab.com/openstapps/core/issues/80)
+
+
+
+# [0.23.0](https://gitlab.com/openstapps/core/compare/v0.22.0...v0.23.0) (2019-07-03)
+
+
+### Features
+
+* add mapping type from response to request and vice versa ([c18e3c1](https://gitlab.com/openstapps/core/commit/c18e3c1)), closes [#80](https://gitlab.com/openstapps/core/issues/80)
+* support 404 (resource not found) error on plugin register route ([43851d2](https://gitlab.com/openstapps/core/commit/43851d2))
+
+
+
+# [0.22.0](https://gitlab.com/openstapps/core/compare/v0.21.0...v0.22.0) (2019-06-28)
+
+
+
+# [0.21.0](https://gitlab.com/openstapps/core/compare/v0.20.0...v0.21.0) (2019-06-19)
+
+
+### Features
+
+* add ES annotations ([9c424b0](https://gitlab.com/openstapps/core/commit/9c424b0))
+* add static typed test for consistency ([ff1f554](https://gitlab.com/openstapps/core/commit/ff1f554)), closes [#71](https://gitlab.com/openstapps/core/issues/71)
+
+
+
+# [0.20.0](https://gitlab.com/openstapps/core/compare/v0.19.0...v0.20.0) (2019-06-11)
+
+
+### Bug Fixes
+
+* add translations for every SCThing ([f847a2a](https://gitlab.com/openstapps/core/commit/f847a2a))
+* rename properties floor and message so that they are not identical to SCThingTypes ([78b64ba](https://gitlab.com/openstapps/core/commit/78b64ba))
+
+
+
+# [0.19.0](https://gitlab.com/openstapps/core/compare/v0.18.0...v0.19.0) (2019-05-17)
+
+
+### Bug Fixes
+
+* add thing without references, split thing ([da0507e](https://gitlab.com/openstapps/core/commit/da0507e)), closes [#69](https://gitlab.com/openstapps/core/issues/69)
+* adjust model to remove references from things without references ([ca72c20](https://gitlab.com/openstapps/core/commit/ca72c20)), closes [#69](https://gitlab.com/openstapps/core/issues/69)
+* remove references from origins ([1d6a2b7](https://gitlab.com/openstapps/core/commit/1d6a2b7)), closes [#69](https://gitlab.com/openstapps/core/issues/69)
+
+
+
 # [0.18.0](https://gitlab.com/openstapps/core/compare/v0.17.0...v0.18.0) (2019-05-14)
 
 

README.md

@@ -29,3 +29,21 @@ To generate a documentation for the routes use the following command.
 ```shell
 node --require ts-node/register src/cli.ts routes PATH/TO/ROUTES.md
 ```
+
+### Annotations
+
+Annotations are used to add additional informations to fields, which are used to autogenerate mappings from the core objects. 
+External dependencies can not be covered by the annotations. Documentation about some of the annotations can be found in: [typedoc](https://typedoc.org/guides/doccomments/)
+
+| annotation        | description                               | parameters    |
+|-------------------|-------------------------------------------|---------------|
+| `@aggregatable`   | used for generating of aggregations of the field if the core schema is used to put data into a database/key-value store |               |
+| `@float`          | number field is interpreted as float      |               |
+| `@indexable`      | marks the type as indexable if the core schema is used to put data into a database/key-value store|               |
+| `@integer`        | number field is interpreted as integer    |               |
+| `@keyword`        | string field is interpreted as keyword    |               |
+| `@sortable`       | field is sortable if the core schema is used to put data into a database/key-value store | sort method to be used: ducet, price, distance |
+| `@text`           | string field is interpreted as text       |               |
+| `@validatable`    | marks the type as validatable if the core schema is used to put data into a database/key-value store |               |
+
+

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openstapps/core",
-  "version": "0.19.0",
+  "version": "0.28.0",
   "description": "StAppsCore - Generalized model of data",
   "keywords": [
     "Model",
@@ -20,75 +20,89 @@
     "compile": "rimraf lib && tsc",
     "documentation": "typedoc --name \"@openstapps/core\" --includeDeclarations --mode modules --out docs --readme README.md --listInvalidSymbolLinks lib",
     "pack": "openstapps-core-tools pack",
+    "postversion": "npm run changelog",
     "prepublishOnly": "npm ci && npm run build",
-    "schema": "node --max-old-space-size=8192 --stack-size=10240 ./node_modules/.bin/openstapps-core-tools schema src/core lib/schema",
+    "preversion": "npm run prepublishOnly",
+    "push": "git push && git push origin \"v$npm_package_version\"",
+    "schema": "node --max-old-space-size=8192 --stack-size=10240 ./node_modules/.bin/openstapps-core-tools schema src lib/schema",
     "test": "nyc mocha --require ts-node/register --require source-map-support/register --ui mocha-typescript test/*.spec.ts",
-    "tslint": "tslint 'src/**/*.ts'"
+    "tslint": "tslint -p tsconfig.json -c tslint.json 'src/**/*.ts'"
   },
   "author": "Karl-Philipp Wulfert <krlwlfrt@gmail.com>",
   "contributors": [
-    "Anselm Stordeur <anselmstordeur@gmail.com>",
-    "Jovan Krunić <jovan.krunic@gmail.com>",
     "Andreas Lehmann",
-    "Sebastian Lange",
-    "Rainer Killinger",
+    "Anselm Stordeur <anselmstordeur@gmail.com>",
+    "Benjamin Jöckel",
     "Imran Hossain",
+    "Jovan Krunić <jovan.krunic@gmail.com>",
     "Michel Jonathan Schmitz",
-    "Wieland Schöbl"
+    "Rainer Killinger",
+    "Sebastian Lange",
+    "Wieland Schöbl",
+    "Roman Klopsch"
   ],
   "dependencies": {
     "@types/geojson": "1.0.6",
     "@types/json-patch": "0.0.30",
-    "@types/node": "10.14.6",
+    "@types/node": "10.14.14",
     "fast-clone": "1.5.13",
+    "http-status-codes": "1.3.2",
     "json-patch": "0.7.0",
     "jsonschema": "1.2.4",
     "ts-optchain": "0.1.3"
   },
   "devDependencies": {
     "@krlwlfrt/async-pool": "0.1.0",
-    "@openstapps/configuration": "0.14.0",
-    "@openstapps/core-tools": "0.6.0",
-    "@openstapps/logger": "0.1.0",
+    "@openstapps/configuration": "0.21.1",
+    "@openstapps/core-tools": "0.8.0",
+    "@openstapps/logger": "0.4.0",
     "@types/chai": "4.1.7",
     "@types/rimraf": "2.0.2",
     "chai": "4.2.0",
     "commander": "2.20.0",
-    "conventional-changelog-cli": "2.0.21",
-    "mocha": "6.1.4",
+    "conditional-type-checks": "1.0.1",
+    "conventional-changelog-cli": "2.0.23",
+    "mocha": "6.2.0",
     "mocha-typescript": "1.1.17",
     "nyc": "14.1.1",
     "rimraf": "2.6.3",
-    "source-map-support": "0.5.12",
-    "ts-node": "8.1.0",
-    "tslint": "5.16.0",
+    "source-map-support": "0.5.13",
+    "ts-node": "8.3.0",
+    "tslint": "5.18.0",
     "typedoc": "0.14.2",
-    "typescript": "3.4.5"
+    "typescript": "3.5.3"
   },
   "nyc": {
-    "check-coverage": true,
-    "per-file": true,
-    "lines": 95,
-    "statements": 95,
-    "functions": 95,
+    "all": true,
     "branches": 85,
-    "include": [
-      "src/core/Route.ts",
-      "src/core/Thing.ts",
-      "src/core/Translator.ts"
-    ],
+    "check-coverage": true,
     "exclude": [],
     "extension": [
       ".ts"
     ],
+    "functions": 95,
+    "include": [
+      "src/protocol/route.ts",
+      "src/things/abstract/thing.ts",
+      "src/translator.ts",
+      "src/guards.ts"
+    ],
+    "lines": 95,
+    "per-file": true,
     "reporter": [
       "html",
       "text-summary"
     ],
-    "all": true
+    "require": [
+      "ts-node/register"
+    ],
+    "statements": 95
   },
   "openstappsConfiguration": {
     "hasCli": false,
+    "ignoreCiEntries": [
+      "build"
+    ],
     "standardBuild": false,
     "standardDocumentation": false
   }

src/config/app.ts

@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2018, 2019 StApps
+ * Copyright (C) 2019 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.
@@ -12,9 +12,10 @@
  * You should have received a copy of the GNU General Public License along with
  * this program. If not, see <https://www.gnu.org/licenses/>.
  */
+// tslint:disable-next-line:no-implicit-dependencies
 import {Polygon} from 'geojson';
-import {SCSetting} from '../../things/Setting';
-import {SCTranslations} from '../i18n';
+import {SCTranslations} from '../general/i18n';
+import {SCSetting} from '../things/setting';
 
 /**
  * An app configuration menu item
@@ -126,11 +127,11 @@ export interface SCAppConfiguration {
 }
 
 /**
- * 
+ * Map of features
  */
 export interface SCAppConfigurationFeature {
   /**
-   * 
+   * Whether or not widgets are enabled
    */
   widgets: boolean;
 }
@@ -148,7 +149,7 @@ export interface SCAppConfigurationStoreUrl {
    */
   ios?: string;
   /**
-   * Microsoft Store URL 
+   * Microsoft Store URL
    */
   uwp?: string;
 }

src/config/backend.ts

@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2018-2019 StApps
+ * Copyright (C) 2019 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.
@@ -12,16 +12,23 @@
  * 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 {SCThingType} from '../../Thing';
-import {SCSearchSortType} from '../sorts/Abstract';
-import {SCUuid} from '../UUID';
-import {SCMap, SCRestrictedMap} from './../Map';
-import {SCMonitoringConfiguration} from './Monitoring';
+import {SCMap, SCRestrictedMap} from '../general/map';
+import {SCUuid} from '../general/uuid';
+import {SCSearchSortType} from '../protocol/search/sort';
+import {SCThingType} from '../things/abstract/thing';
+import {SCMonitoringConfiguration} from './monitoring';
 
 /**
  * A backend configuration
  */
 export interface SCBackendConfiguration {
+  /**
+   * The maximum amount of time (milliseconds) an external program can take to provide a response to the backend
+   *
+   * This can be used for example for Plugins.
+   */
+  externalRequestTimeout: number;
+
   /**
    * A list of hidden SC types
    *
@@ -96,10 +103,8 @@ export type SCSearchContext =
  * A boosting configuration for one context
  */
 export type SCBackendConfigurationSearchBoostingContext =
-  SCRestrictedMap<
-    SCSearchContext,
-    SCBackendConfigurationSearchBoostingType[]
-  >;
+  SCRestrictedMap<SCSearchContext,
+    SCBackendConfigurationSearchBoostingType[]>;
 
 /**
  * A boosting configuration for one SCType
@@ -176,10 +181,9 @@ export interface SCBackendInternalConfiguration {
 /**
  * Configuration of the database
  */
-export interface SCBackendConfigurationDatabaseConfiguration extends SCMap<any> {
+export interface SCBackendConfigurationDatabaseConfiguration extends SCMap<unknown> {
   /**
    * Name of the database used by the backend
    */
   name: string;
-
 }

src/config/file.ts

@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2018, 2019 StApps
+ * Copyright (C) 2019 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.
@@ -12,9 +12,9 @@
  * 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 {SCAppConfiguration} from '../types/config/App';
-import {SCBackendConfiguration, SCBackendInternalConfiguration} from '../types/config/Backend';
-import {SCLicensePlate} from '../types/namespaces';
+import {SCLicensePlate} from '../general/namespaces';
+import {SCAppConfiguration} from './app';
+import {SCBackendConfiguration, SCBackendInternalConfiguration} from './backend';
 
 /**
  * A configuration file that configures app and backend

src/config/monitoring.ts

@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2018 StApps
+ * Copyright (C) 2019 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.
@@ -140,7 +140,7 @@ export interface SCMonitoringWatcher {
   /**
    * Query to execute against the database
    */
-  query: any;
+  query: unknown;
 
   /**
    * A list of triggers

src/core/Route.ts

@@ -1,166 +0,0 @@
-/*
- * Copyright (C) 2018, 2019 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/>.
- */
-/**
- * Possible HTTP verbs for routes
- */
-import {SCErrorResponse} from './protocol/errors/ErrorResponse';
-import {SCBookAvailabilityRequest} from './protocol/routes/bookAvailability/BookAvailabilityRequest';
-import {SCBookAvailabilityResponse} from './protocol/routes/bookAvailability/BookAvailabilityResponse';
-import {SCBulkRequest} from './protocol/routes/bulk/BulkRequest';
-import {SCBulkResponse} from './protocol/routes/bulk/BulkResponse';
-import {SCBulkAddRequest} from './protocol/routes/bulk/UID/BulkAddRequest';
-import {SCBulkAddResponse} from './protocol/routes/bulk/UID/BulkAddResponse';
-import {SCBulkDoneRequest} from './protocol/routes/bulk/UID/BulkDoneRequest';
-import {SCBulkDoneResponse} from './protocol/routes/bulk/UID/BulkDoneResponse';
-import {SCFeedbackRequest} from './protocol/routes/feedback/FeedbackRequest';
-import {SCFeedbackResponse} from './protocol/routes/feedback/FeedbackResponse';
-import {SCIndexRequest} from './protocol/routes/INDEX/IndexRequest';
-import {SCIndexResponse} from './protocol/routes/INDEX/IndexResponse';
-import {SCMultiSearchRequest} from './protocol/routes/search/MultiSearchRequest';
-import {SCMultiSearchResponse} from './protocol/routes/search/MultiSearchResponse';
-import {SCSearchRequest} from './protocol/routes/search/SearchRequest';
-import {SCSearchResponse} from './protocol/routes/search/SearchResponse';
-import {SCThingUpdateRequest} from './protocol/routes/TYPE/UID/ThingUpdateRequest';
-import {SCThingUpdateResponse} from './protocol/routes/TYPE/UID/ThingUpdateResponse';
-import {SCMap} from './types/Map';
-
-/**
- * Possible Verbs for HTTP requests
- */
-export enum SCRouteHttpVerbs {
-  GET = 'GET',
-  POST = 'POST',
-  PUT = 'PUT',
-}
-
-/**
- * The constructor of an error response
- */
-export type SCErrorResponseConstructor = new (...args: any) => SCErrorResponse;
-
-/**
- * A description of a route
- */
-export interface SCRoute {
-  /**
-   * A map of names of possible errors that can be returned by the route with their appropriate status codes
-   */
-  errorNames: SCErrorResponseConstructor[];
-
-  /**
-   * HTTP verb to use to request the route
-   */
-  method: SCRouteHttpVerbs;
-
-  /**
-   * Map of obligatory parameters and their type that have to be set via the requested path
-   */
-  obligatoryParameters?: SCMap<string>;
-
-  /**
-   * Name of the type of the request body
-   */
-  requestBodyName: string;
-
-  /**
-   * Name of the type of the response body
-   */
-  responseBodyName: string;
-
-  /**
-   * Status code for success
-   */
-  statusCodeSuccess: number;
-
-  /**
-   * URL fragment of the route
-   */
-  urlFragment: string;
-}
-
-/**
- * An abstract route
- */
-export abstract class SCAbstractRoute implements SCRoute {
-  errorNames: SCErrorResponseConstructor[] = [];
-  method: SCRouteHttpVerbs = SCRouteHttpVerbs.GET;
-  obligatoryParameters?: SCMap<string>;
-  requestBodyName = 'any';
-  responseBodyName = 'any';
-  statusCodeSuccess = 200;
-  urlFragment = '/';
-
-  public getUrlFragment(parameters?: SCMap<string>): string {
-    if (typeof parameters === 'undefined') {
-      parameters = {};
-    }
-
-    let obligatoryParameters: string[] = [];
-
-    if (typeof this.obligatoryParameters === 'object') {
-      obligatoryParameters = Object.keys(this.obligatoryParameters);
-    }
-
-    if (Object.keys(parameters).length > obligatoryParameters.length) {
-      throw new Error('Extraneous parameters provided.');
-    }
-
-    return this.urlFragment
-      .split('/')
-      .map((part) => {
-        if (part.indexOf(':') !== 0) {
-          return part;
-        }
-
-        const parameter = part.substr(1);
-
-        // @ts-ignore
-        if (typeof parameters[parameter] === 'undefined') {
-          throw new Error(`Parameter '${parameter}' not provided.`);
-        }
-
-        // @ts-ignore
-        return parameters[parameter];
-      }).join('/');
-  }
-}
-
-/**
- * Possible requests
- */
-export type SCRequests =
-  SCBookAvailabilityRequest
-  | SCBulkRequest
-  | SCBulkAddRequest
-  | SCBulkDoneRequest
-  | SCFeedbackRequest
-  | SCIndexRequest
-  | SCMultiSearchRequest
-  | SCSearchRequest
-  | SCThingUpdateRequest;
-
-/**
- * Possible responses
- */
-export type SCResponses =
-  SCBookAvailabilityResponse
-  | SCBulkResponse
-  | SCBulkAddResponse
-  | SCBulkDoneResponse
-  | SCFeedbackResponse
-  | SCIndexResponse
-  | SCMultiSearchResponse
-  | SCSearchResponse
-  | SCThingUpdateResponse;

src/core/protocol/errors/ErrorResponse.ts

@@ -1,254 +0,0 @@
-/*
- * Copyright (C) 2018-2019 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 {ValidationError} from 'jsonschema';
-
-/**
- * A generic error that can be returned by the backend if somethings fails during the processing of a request
- *
- * @validatable
- */
-export interface SCErrorResponse extends Error {
-  /**
-   * Additional data that describes the error
-   */
-  additionalData?: any;
-
-  /**
-   * HTTP status code to return this error with
-   */
-  statusCode: number;
-}
-
-/**
- * An error that can be created by the backend during the processing of a request
- */
-export abstract class SCError implements SCErrorResponse {
-  /**
-   * Call stack of the error
-   */
-  stack?: string;
-
-  /**
-   * Instatiate an SCError
-   *
-   * @param name Name of the error
-   * @param message Message of the error
-   * @param statusCode  HTTP status code to return this error with
-   * @param stack Set to true if a stack trace should be created
-   */
-  constructor(public name: string, public message: string, public statusCode: number, stack?: boolean) {
-    // generate stacktrace if needed
-    if (stack) {
-      this.stack = (new Error()).stack;
-    }
-  }
-}
-
-/**
- * An error that is returned when the validation of a request fails
- */
-export class SCValidationErrorResponse extends SCError {
-  /**
-   * List of validatation errors
-   */
-  additionalData: ValidationError[];
-
-  /**
-   * Create a SCValidationErrorResponse
-   *
-   * @param errors List of validation errors
-   * @param stack Set to true if a stack trace should be created
-   */
-  constructor(errors: ValidationError[], stack?: boolean) {
-    super('ValidationError', 'Validation of request failed', 400, stack);
-    this.additionalData = errors;
-  }
-}
-
-/**
- * An error that is returned when the content type of the request is not supported
- */
-export class SCUnsupportedMediaTypeErrorResponse extends SCError {
-  /**
-   * Create a SCUnsupportedMediaTypeErrorResponse
-   *
-   * @param stack Set to true if a stack trace should be created
-   */
-  constructor(stack?: boolean) {
-    super('UnsupportedMediaTypeError', 'Unsupported media type', 415, stack);
-  }
-}
-
-/**
- * An error that is returned, when the used HTTP method is not allowed on the requested route
- */
-export class SCMethodNotAllowedErrorResponse extends SCError {
-  /**
-   * Create a SCMethodNotAllowedErrorResponse
-   *
-   * @param stack Set to true if a stack trace should be created
-   */
-  constructor(stack?: boolean) {
-    super('MethodNotAllowedError', 'HTTP method is not allowed on this route', 405, stack);
-  }
-}
-
-/**
- * An error that is returned, when the request body is too large.
- */
-export class SCRequestBodyTooLargeErrorResponse extends SCError {
-  /**
-   * Create a SCRequestBodyTooLargeErrorResponse
-   * @param stack Set to true if a stack trace should be created
-   */
-  constructor(stack?: boolean) {
-    super('RequestBodyTooLargeError', 'The request body is too large.', 413, stack);
-  }
-}
-
-/**
- * An error that is returned, when to many request are submitted at once
- */
-export class SCTooManyRequestsErrorResponse extends SCError {
-  /**
-   * Create a SCTooManyRequestsErrorResponse
-   *
-   * @param stack Set to true if a stack trace should be created
-   */
-  constructor(stack?: boolean) {
-    super('TooManyRequestsError', 'Too many requests. You can not submit more than 5 queries an once', 429, stack);
-  }
-}
-
-/**
- * An error that is returned when the requested route or resource was not found
- */
-export class SCNotFoundErrorResponse extends SCError {
-  /**
-   * Create a SCNotFoundErrorResponse
-   *
-   * @param stack Set to true if a stack trace should be created
-   */
-  constructor(stack?: boolean) {
-    super('NotFoundError', 'Resource not found', 404, stack);
-  }
-}
-
-/**
- * An error that is returned when the request is in the right format, but contains parameters that are invalid or not
- * acceptable.
- */
-export class SCParametersNotAcceptable extends SCError {
-  /**
-   * Create a ParametersNotAcceptable
-   *
-   * @param message contains more details to what you did wrong
-   * @param stack Set to true if a stack trace should be created
-   */
-  constructor(message: string, stack?: boolean) {
-    super('ParametersNotAcceptable', message, 406, stack);
-  }
-}
-
-/**
- * An error that is returned when a plugin with the same name is already registered, to prevent two copies of a plugin
- * running at the same time.
- * This usually indicates that there is more than one instance a plugin running.
- */
-export class SCPluginAlreadyRegisteredErrorResponse extends SCError {
-  /**
-   * Create a PluginAlreadyRegisteredError
-   *
-   * @param message contains potential differences in other parameters outside of the name
-   * @param stack Set to true if a stack trace should be created
-   */
-  constructor(message: string, stack?: boolean) {
-    super('PluginRegisteringFailedError', message, 409, stack);
-  }
-}
-
-/**
- * An error that is returned whenever there is an unexpected error while creating a plugin
- */
-export class SCPluginRegisteringFailedErrorResponse extends SCError {
-  /**
-   * Create a PluginRegisteringFailedError
-   *
-   * @param message Describes what went wrong wile registering the plugin
-   * @param stack Set to true if a stack trace should be created
-   */
-  constructor(message: string, stack?: boolean) {
-    super('PluginRegisteringFailedError', message, 500, stack);
-  }
-}
-
-/**
- * An error that is returned whenever there is a plugin request that is supposed to register a route, that is already
- * registered
- * This usually indicates that two **different** plugins use the same route.
- */
-export class SCPluginRouteAlreadyRegisteredErrorResponse extends SCError {
-  /**
-   * Create a PluginRouteAlreadyRegisteredError
-   *
-   * @param registeredName The name by the plugin that has already registered the route previously
-   * @param registeredUrl  The URL by the plugin that has already registered the route previously
-   * @param stack Set to true if a stack trace should be created
-   */
-  constructor(registeredName: string, registeredUrl: string, stack?: boolean) {
-    super('PluginRouteAlreadyRegisteredError',
-      `Already registered by "${registeredName}" under URL "${registeredUrl}".`, 409, stack);
-  }
-}
-
-/**
- * An error that is returned whenever there is a syntax error
- */
-export class SCSyntaxErrorResponse extends SCError {
-  /**
-   * Create a SyntaxError
-   *
-   * @param message Describes the syntax error
-   * @param stack Set to true if a stack trace should be created
-   */
-  constructor(message: string, stack?: boolean) {
-    super('SyntaxError', message, 400, stack);
-  }
-}
-
-/**
- * An error that is returned, when an internal server error occurred
- */
-export class SCInternalServerErrorResponse extends SCError {
-  /**
-   * Internal error that occurred. If the stack is disabled this error is not set for security reasons
-   */
-  additionalData?: Error;
-
-  /**
-   * Create a SCInternalServerErrorResponse
-   *
-   * @param err Internal server error
-   * @param stack Set to true if a stack trace should be created 
-   * and the internal server error should be displayed to the client
-   */
-  constructor(err?: Error, stack?: boolean) {
-    super('InternalServerError', 'Internal server error', 502, stack);
-
-    if (stack) {
-      this.additionalData = err;
-    }
-  }
-}

src/core/protocol/routes/INDEX/IndexResponse.ts

@@ -1,27 +0,0 @@
-/*
- * Copyright (C) 2018, 2019 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 {SCAppConfiguration} from '../../../types/config/App';
-import {SCBackendConfiguration} from '../../../types/config/Backend';
-
-/**
- * A response to an index request
- *
- * @validatable
- */
-export interface SCIndexResponse {
-  app: SCAppConfiguration;
-
-  backend: SCBackendConfiguration;
-}

src/core/protocol/routes/TYPE/UID/ThingUpdateResponse.ts

@@ -1,21 +0,0 @@
-/*
- * Copyright (C) 2018, 2019 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/>.
- */
-/**
- * Response for an entity update request
- *
- * @validatable
- */
-export interface SCThingUpdateResponse {
-}

src/core/protocol/routes/bookAvailability/BookAvailabilityResponse.ts

@@ -1,21 +0,0 @@
-/*
- * Copyright (C) 2018, 2019 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 {SCAcademicPriceGroup, SCThingThatCanBeOfferedOffer} from '../../../base/ThingThatCanBeOffered';
-
-/**
- * List of availabilities of a book
- * @validatable
- */
-export type SCBookAvailabilityResponse = Array<SCThingThatCanBeOfferedOffer<SCAcademicPriceGroup>>;

src/core/protocol/routes/bulk/UID/BulkAddResponse.ts

@@ -1,20 +0,0 @@
-/*
- * Copyright (C) 2018, 2019 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/>.
- */
-/**
- * Response to a request to add a thing to a bulk
- * @validatable
- */
-export interface SCBulkAddResponse {
-}

src/core/protocol/routes/bulk/UID/BulkDoneResponse.ts

@@ -1,20 +0,0 @@
-/*
- * Copyright (C) 2018, 2019 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/>.
- */
-/**
- * Response to a request to change the state of a bulk to done
- * @validatable
- */
-export interface SCBulkDoneResponse {
-}

src/core/protocol/routes/feedback/FeedbackResponse.ts

@@ -1,21 +0,0 @@
-/*
- * Copyright (C) 2018, 2019 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/>.
- */
-/**
- * A response to a feedback request
- *
- * @validatable
- */
-export interface SCFeedbackResponse {
-}

src/core/protocol/routes/search/MultiSearchResponse.ts

@@ -1,25 +0,0 @@
-/*
- * Copyright (C) 2018-2019 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 {SCMap} from '../../../types/Map';
-import {SCSearchResult} from './SearchResponse';
-
-/**
- * A multi search response
- *
- * This is a map of [[SCSearchResponse]]s indexed by name
- *
- * @validatable
- */
-export type SCMultiSearchResponse = SCMap<SCSearchResult>;

src/core/types/Guards.ts

@@ -1,82 +0,0 @@
-/*
- * Copyright (C) 2018, 2019 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 {SCBulkResponse} from '../protocol/routes/bulk/BulkResponse';
-import {SCMultiSearchResponse} from '../protocol/routes/search/MultiSearchResponse';
-import {SCSearchResponse} from '../protocol/routes/search/SearchResponse';
-import {SCThing, SCThingTranslatableProperties, SCThingType, SCThingWithoutReferences} from '../Thing';
-import {SCTranslations} from './i18n';
-
-/**
- * Type guard to check if something is a SCThing
- *
- * @param something Something to check
- */
-export function isThing(something: any): something is SCThing {
-  return (
-    typeof something === 'object'
-    && typeof something.type === 'string'
-    && Object.values(SCThingType).indexOf(something.type) >= 0
-  );
-}
-
-/**
- * Type guard to check if translations exist
- *
- * @param thing Thing to check
- */
-export function isThingWithTranslations(thing: SCThingWithoutReferences)
-  : thing is SCThingWithoutReferences & { translations: SCTranslations<SCThingTranslatableProperties> } {
-  return typeof thing.translations !== 'undefined';
-}
-
-/**
- * Type guard to check if something is a bulk response
- *
- * @param something Something to check
- */
-export function isBulkResponse(something: any): something is SCBulkResponse {
-  return typeof something.expiration === 'string'
-    && typeof something.source === 'string'
-    && typeof something.state === 'string'
-    && typeof something.type === 'string'
-    && typeof something.uid === 'string';
-}
-
-/**
- * Type guard to check if something is a search response
- *
- * @param something Something to check
- */
-export function isSearchResponse(something: any): something is SCSearchResponse {
-  return Array.isArray(something.data)
-    && Array.isArray(something.facets)
-    && typeof something.pagination !== 'undefined'
-    && typeof something.pagination.count === 'number'
-    && typeof something.pagination.offset === 'number'
-    && typeof something.pagination.total === 'number'
-    && typeof something.stats !== 'undefined'
-    && typeof something.stats.time === 'number';
-}
-
-/**
- * Type guard to check if something is a multi search response
- *
- * @param something Something to check
- */
-export function isMultiSearchResponse(something: any): something is SCMultiSearchResponse {
-  return Object.keys(something).reduce((previousOnesAreSearchResponses, key) => {
-    return previousOnesAreSearchResponses && isSearchResponse(something[key]);
-  }, true as boolean);
-}

src/general/i18n.ts

@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2018, 2019 StApps
+ * Copyright (C) 2019 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.
@@ -29,7 +29,7 @@ export interface SCLanguage {
 
 /**
  * A list of possible languages in english
- * 
+ *
  * @see https://en.wikipedia.org/wiki/ISO_639-1
  */
 export type SCLanguageName =
@@ -221,7 +221,7 @@ export type SCLanguageName =
 
 /**
  * A List of all possible Languages as ISO 639-1 Codes
- * 
+ *
  * @see https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes
  */
 export type SCLanguageCode =
@@ -690,10 +690,10 @@ export interface SCTranslations<T> {
  * (Source: https://stackoverflow.com/a/51365037)
  */
 type RecursivePartial<T> = {
-  [P in keyof T]?:
-    T[P] extends Array<infer U> ? Array<RecursivePartial<U>> :
+  [P in keyof T]-?:
+  T[P] extends Array<infer U> ? Array<RecursivePartial<U>> :
     T[P] extends object ? RecursivePartial<T[P]> :
-    T[P];
+      T[P];
 };
 
 /**
@@ -714,6 +714,12 @@ type SCRequiredTranslation<T> = {
  * Interface to be implemented by all Meta classes
  */
 export interface SCMetaTranslations<T> {
+  /**
+   * Field translations
+   */
   fieldTranslations: SCRequiredTranslation<T>;
-  fieldValueTranslations: any;
+  /**
+   * Field value translations
+   */
+  fieldValueTranslations: unknown;
 }

src/general/namespaces.ts

@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2018 StApps
+ * Copyright (C) 2019 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.

src/general/time.ts

@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2018 StApps
+ * Copyright (C) 2019 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.

src/general/uuid.ts

@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2018 StApps
+ * Copyright (C) 2019 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.

src/guards.ts

@@ -0,0 +1,126 @@
+/*
+ * Copyright (C) 2019 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
+ * unknown 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 {SCTranslations} from './general/i18n';
+import {SCBulkResponse} from './protocol/routes/bulk-request';
+import {SCSearchResponse} from './protocol/routes/search';
+import {SCMultiSearchResponse} from './protocol/routes/search-multi';
+import {SCThing, SCThingTranslatableProperties, SCThingType, SCThingWithoutReferences} from './things/abstract/thing';
+
+/**
+ * Type guard to check if something is a SCThing
+ *
+ * @param something Something to check
+ */
+export function isThing(something: unknown): something is SCThing {
+  if (typeof something !== 'object' || something === null) {
+    return false;
+  }
+
+  if (!('type' in something)) {
+    return false;
+  }
+
+  // tslint:disable-next-line:completed-docs
+  const type = (something as { type: unknown; }).type;
+
+  if (typeof type !== 'string') {
+    return false;
+  }
+
+  return Object
+    .values(SCThingType)
+    .indexOf(type) >= 0;
+}
+
+/**
+ * Type guard to check if translations exist
+ *
+ * @param thing Thing to check
+ */
+export function isThingWithTranslations(thing: SCThingWithoutReferences)
+// tslint:disable-next-line:completed-docs
+  : thing is SCThingWithoutReferences & { translations: SCTranslations<SCThingTranslatableProperties>; } {
+  return typeof thing.translations !== 'undefined';
+}
+
+/**
+ * Type guard to check if something is a bulk response
+ *
+ * @param something Something to check
+ */
+export function isBulkResponse(something: unknown): something is SCBulkResponse {
+  if (typeof something !== 'object' || something === null) {
+    return false;
+  }
+
+  if (!('expiration' in something)
+    || !('source' in something)
+    || !('state' in something)
+    || !('type' in something)
+    || !('uid' in something)) {
+    return false;
+  }
+
+  const {expiration, source, state, type, uid} = something as {
+    // tslint:disable:completed-docs
+    expiration: unknown;
+    source: unknown;
+    state: unknown;
+    type: unknown;
+    uid: unknown;
+    // tslint:enable
+  };
+
+  return typeof expiration === 'string'
+    && typeof source === 'string'
+    && typeof state === 'string'
+    && typeof type === 'string'
+    && typeof uid === 'string';
+}
+
+/**
+ * Type guard to check if something is a search response
+ *
+ * @param something Something to check
+ */
+export function isSearchResponse(something: unknown): something is SCSearchResponse {
+  if (!(typeof something === 'object') || something === null) {
+    return false;
+  }
+  const somethingObject = (something as { [key: string]: { [key: string]: string; }; });
+
+  return Array.isArray(somethingObject.data)
+    && Array.isArray(somethingObject.facets)
+    && typeof somethingObject.pagination !== 'undefined'
+    && typeof somethingObject.pagination.count === 'number'
+    && typeof somethingObject.pagination.offset === 'number'
+    && typeof somethingObject.pagination.total === 'number'
+    && typeof somethingObject.stats !== 'undefined'
+    && typeof somethingObject.stats.time === 'number';
+}
+
+/**
+ * Type guard to check if something is a multi search response
+ *
+ * @param something Something to check
+ */
+export function isMultiSearchResponse(something: unknown): something is SCMultiSearchResponse {
+  const initialValue = Object.keys(something as { [key: string]: string; }).length > 0 ? true : false;
+
+  return Object.keys(something as { [key: string]: string; })
+    .reduce((previousOnesAreSearchResponses, key) => {
+      return previousOnesAreSearchResponses && isSearchResponse((something as { [key: string]: string; })[key]);
+    }, initialValue as boolean);
+}

src/meta.ts

@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2018, 2019 StApps
+ * Copyright (C) 2019 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.
@@ -12,37 +12,37 @@
  * 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 {SCThingType} from './Thing';
-import {SCAcademicEvent, SCAcademicEventMeta, SCAcademicEventWithoutReferences} from './things/AcademicEvent';
-import {SCArticle, SCArticleMeta, SCArticleWithoutReferences} from './things/Article';
-import {SCBook, SCBookMeta, SCBookWithoutReferences} from './things/Book';
-import {SCBuilding, SCBuildingMeta, SCBuildingWithoutReferences} from './things/Building';
-import {SCCatalog, SCCatalogMeta, SCCatalogWithoutReferences} from './things/Catalog';
-import {SCCourseOfStudies, SCCourseOfStudiesMeta, SCCourseOfStudiesWithoutReferences} from './things/CourseOfStudies';
-import {SCDateSeries, SCDateSeriesMeta, SCDateSeriesWithoutReferences} from './things/DateSeries';
-import {SCDiff, SCDiffMeta, SCDiffWithoutReferences} from './things/Diff';
-import {SCDish, SCDishMeta, SCDishWithoutReferences} from './things/Dish';
-import {SCFavorite, SCFavoriteMeta, SCFavoriteWithoutReferences} from './things/Favorite';
-import {SCFloor, SCFloorMeta, SCFloorWithoutReferences} from './things/Floor';
-import {SCMessage, SCMessageMeta, SCMessageWithoutReferences} from './things/Message';
-import {SCOrganization, SCOrganizationMeta, SCOrganizationWithoutReferences} from './things/Organization';
-import {SCPerson, SCPersonMeta, SCPersonWithoutReferences} from './things/Person';
-import {SCPointOfInterest, SCPointOfInterestMeta, SCPointOfInterestWithoutReferences} from './things/PointOfInterest';
-import {SCRoom, SCRoomMeta, SCRoomWithoutReferences} from './things/Room';
-import {SCSemester, SCSemesterMeta, SCSemesterWithoutReferences} from './things/Semester';
-import {SCSetting, SCSettingMeta, SCSettingWithoutReferences} from './things/Setting';
-import {SCSportCourse, SCSportCourseMeta, SCSportCourseWithoutReferences} from './things/SportCourse';
-import {SCStudyModule, SCStudyModuleMeta, SCStudyModuleWithoutReferences} from './things/StudyModule';
-import {SCTicket, SCTicketMeta, SCTicketWithoutReferences} from './things/Ticket';
-import {SCToDo, SCToDoMeta, SCToDoWithoutReferences} from './things/ToDo';
-import {SCTour, SCTourMeta, SCTourWithoutReferences} from './things/Tour';
-import {SCVideo, SCVideoMeta, SCVideoWithoutReferences} from './things/Video';
+import {SCThingType} from './things/abstract/thing';
+import {SCAcademicEvent, SCAcademicEventMeta, SCAcademicEventWithoutReferences} from './things/academic-event';
+import {SCArticle, SCArticleMeta, SCArticleWithoutReferences} from './things/article';
+import {SCBook, SCBookMeta, SCBookWithoutReferences} from './things/book';
+import {SCBuilding, SCBuildingMeta, SCBuildingWithoutReferences} from './things/building';
+import {SCCatalog, SCCatalogMeta, SCCatalogWithoutReferences} from './things/catalog';
+import {SCCourseOfStudies, SCCourseOfStudiesMeta, SCCourseOfStudiesWithoutReferences} from './things/course-of-studies';
+import {SCDateSeries, SCDateSeriesMeta, SCDateSeriesWithoutReferences} from './things/date-series';
+import {SCDiff, SCDiffMeta, SCDiffWithoutReferences} from './things/diff';
+import {SCDish, SCDishMeta, SCDishWithoutReferences} from './things/dish';
+import {SCFavorite, SCFavoriteMeta, SCFavoriteWithoutReferences} from './things/favorite';
+import {SCFloor, SCFloorMeta, SCFloorWithoutReferences} from './things/floor';
+import {SCMessage, SCMessageMeta, SCMessageWithoutReferences} from './things/message';
+import {SCOrganization, SCOrganizationMeta, SCOrganizationWithoutReferences} from './things/organization';
+import {SCPerson, SCPersonMeta, SCPersonWithoutReferences} from './things/person';
+import {SCPointOfInterest, SCPointOfInterestMeta, SCPointOfInterestWithoutReferences} from './things/point-of-interest';
+import {SCRoom, SCRoomMeta, SCRoomWithoutReferences} from './things/room';
+import {SCSemester, SCSemesterMeta, SCSemesterWithoutReferences} from './things/semester';
+import {SCSetting, SCSettingMeta, SCSettingWithoutReferences} from './things/setting';
+import {SCSportCourse, SCSportCourseMeta, SCSportCourseWithoutReferences} from './things/sport-course';
+import {SCStudyModule, SCStudyModuleMeta, SCStudyModuleWithoutReferences} from './things/study-module';
+import {SCTicket, SCTicketMeta, SCTicketWithoutReferences} from './things/ticket';
+import {SCToDo, SCToDoMeta, SCToDoWithoutReferences} from './things/todo';
+import {SCTour, SCTourMeta, SCTourWithoutReferences} from './things/tour';
+import {SCVideo, SCVideoMeta, SCVideoWithoutReferences} from './things/video';
 
 /* tslint:disable:variable-name */
 /**
  * A map of things, from type to meta data
  */
-export const SCClasses: { [K in SCThingType]: any } = {
+export const SCClasses: { [K in SCThingType]: object } = {
   /* tslint:enable */
   'academic event': SCAcademicEventMeta,
   'article': SCArticleMeta,

src/protocol/error.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 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/>.
+ */
+
+/**
+ * A generic error that can be returned by the backend if somethings fails during the processing of a request
+ *
+ * @validatable
+ */
+export interface SCErrorResponse extends Error {
+  /**
+   * Additional data that describes the error
+   */
+  additionalData?: unknown;
+
+  /**
+   * HTTP status code to return this error with
+   */
+  statusCode: number;
+}
+
+/**
+ * An error that can be created by the backend during the processing of a request
+ */
+export abstract class SCError implements SCErrorResponse {
+  /**
+   * Call stack of the error
+   */
+  stack?: string;
+
+  /**
+   * Instatiate an SCError
+   *
+   * @param name Name of the error
+   * @param message Message of the error
+   * @param statusCode  HTTP status code to return this error with
+   * @param stack Set to true if a stack trace should be created
+   */
+  constructor(public name: string, public message: string, public statusCode: number, stack = false) {
+    // generate stacktrace if needed
+    if (stack) {
+      this.stack = (new Error()).stack;
+    }
+  }
+}

src/protocol/errors/internal-server-error.ts

@@ -0,0 +1,41 @@
+/*
+ * Copyright (C) 2019 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 {BAD_GATEWAY} from 'http-status-codes';
+import {SCError} from '../error';
+
+/**
+ * An error that is returned, when an internal server error occurred
+ */
+export class SCInternalServerErrorResponse extends SCError {
+  /**
+   * Internal error that occurred. If the stack is disabled this error is not set for security reasons
+   */
+  additionalData?: Error;
+
+  /**
+   * Create a SCInternalServerErrorResponse
+   *
+   * @param err Internal server error
+   * @param stack Set to true if a stack trace should be created
+   * and the internal server error should be displayed to the client
+   */
+  constructor(err?: Error, stack = false) {
+    super('InternalServerError', 'Internal server error', BAD_GATEWAY, stack);
+
+    if (stack) {
+      this.additionalData = err;
+    }
+  }
+}

src/protocol/errors/method-not-allowed.ts

@@ -0,0 +1,30 @@
+/*
+ * Copyright (C) 2019 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 {METHOD_NOT_ALLOWED} from 'http-status-codes';
+import {SCError} from '../error';
+
+/**
+ * An error that is returned, when the used HTTP method is not allowed on the requested route
+ */
+export class SCMethodNotAllowedErrorResponse extends SCError {
+  /**
+   * Create a SCMethodNotAllowedErrorResponse
+   *
+   * @param stack Set to true if a stack trace should be created
+   */
+  constructor(stack?: boolean) {
+    super('MethodNotAllowedError', 'HTTP method is not allowed on this route', METHOD_NOT_ALLOWED, stack);
+  }
+}

src/protocol/errors/not-found.ts

@@ -12,15 +12,19 @@
  * 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 {NOT_FOUND} from 'http-status-codes';
+import {SCError} from '../error';
 
 /**
- * Plugin register response
- *
- * @validatable
+ * An error that is returned when the requested route or resource was not found
  */
-export interface SCPluginRegisterResponse {
+export class SCNotFoundErrorResponse extends SCError {
   /**
-   * Whether the desired action succeeded or failed (true for success, false if an error occurred)
+   * Create a SCNotFoundErrorResponse
+   *
+   * @param stack Set to true if a stack trace should be created
    */
-  success: boolean;
+  constructor(stack?: boolean) {
+    super('NotFoundError', 'Resource not found', NOT_FOUND, stack);
+  }
 }

src/protocol/errors/parameters-not-acceptable.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 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 {NOT_ACCEPTABLE} from 'http-status-codes';
+import {SCError} from '../error';
+
+/**
+ * An error that is returned when the request is in the right format, but contains parameters that are invalid or not
+ * acceptable.
+ */
+export class SCParametersNotAcceptable extends SCError {
+  /**
+   * Create a ParametersNotAcceptable
+   *
+   * @param message contains more details to what you did wrong
+   * @param stack Set to true if a stack trace should be created
+   */
+  constructor(message: string, stack?: boolean) {
+    super('ParametersNotAcceptable', message, NOT_ACCEPTABLE, stack);
+  }
+}

src/protocol/errors/plugin-already-registered.ts

@@ -0,0 +1,44 @@
+/*
+ * Copyright (C) 2019 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 {CONFLICT} from 'http-status-codes';
+import {SCError} from '../error';
+import {SCPluginMetaData} from '../routes/plugin-register';
+
+/**
+ * An error that is returned when a plugin with the same name is already registered, to prevent two copies of a plugin
+ * running at the same time.
+ * This usually indicates that there is more than one instance a plugin running.
+ */
+export class SCPluginAlreadyRegisteredErrorResponse extends SCError {
+  /**
+   * Meta data of a registered plugin, which is in a conflict with the plugin we want to register.
+   * If the stack is disabled this is not set for security reasons
+   */
+  additionalData?: SCPluginMetaData;
+
+  /**
+   * Create a SCPluginAlreadyRegisteredError
+   *
+   * @param message Provide further information why an already registered plugin matches the one we want to register
+   * @param plugin Provides meta data of a registered plugin, which is in a conflict with the plugin we want to register
+   * @param stack Set to true if a stack trace should be created
+   */
+  constructor(message: string, plugin: SCPluginMetaData, stack = false) {
+    super('SCPluginAlreadyRegisteredError', message, CONFLICT, stack);
+    if (stack) {
+      this.additionalData = plugin;
+    }
+  }
+}

src/protocol/errors/plugin-registering-failed.ts

@@ -0,0 +1,31 @@
+/*
+ * Copyright (C) 2019 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 {INTERNAL_SERVER_ERROR} from 'http-status-codes';
+import {SCError} from '../error';
+
+/**
+ * An error that is returned whenever there is an unexpected error while creating a plugin
+ */
+export class SCPluginRegisteringFailedErrorResponse extends SCError {
+  /**
+   * Create a PluginRegisteringFailedError
+   *
+   * @param message Describes what went wrong wile registering the plugin
+   * @param stack Set to true if a stack trace should be created
+   */
+  constructor(message: string, stack?: boolean) {
+    super('PluginRegisteringFailedError', message, INTERNAL_SERVER_ERROR, stack);
+  }
+}

src/protocol/errors/request-body-too-large.ts

@@ -12,21 +12,19 @@
  * 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 {SCBuildingWithoutReferences} from '../things/Building';
-import {SCPointOfInterestWithoutReferences} from '../things/PointOfInterest';
-import {SCRoomWithoutReferences} from '../things/Room';
+import {REQUEST_TOO_LONG} from 'http-status-codes';
+import {SCError} from '../error';
+
 /**
- * Something that is or happens in a place
- * 
- * !Important!
- * This is not a SCThing.
+ * An error that is returned, when the request body is too large.
  */
-export interface SCInPlace {
+export class SCRequestBodyTooLargeErrorResponse extends SCError {
   /**
-   * Place the thing is or happens in
+   * Create a SCRequestBodyTooLargeErrorResponse
+   *
+   * @param stack Set to true if a stack trace should be created
    */
-  inPlace?:
-    SCBuildingWithoutReferences
-    | SCPointOfInterestWithoutReferences
-    | SCRoomWithoutReferences;
+  constructor(stack?: boolean) {
+    super('RequestBodyTooLargeError', 'The request body is too large.', REQUEST_TOO_LONG, stack);
+  }
 }

src/protocol/errors/syntax-error.ts

@@ -12,18 +12,20 @@
  * 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 {Point, Polygon} from 'geojson';
+import {BAD_REQUEST} from 'http-status-codes';
+import {SCError} from '../error';
 
 /**
- * Positional information
+ * An error that is returned whenever there is a syntax error
  */
-export interface SCGeoInformation {
+export class SCSyntaxErrorResponse extends SCError {
   /**
-   * Center point of a place
+   * Create a SyntaxError
+   *
+   * @param message Describes the syntax error
+   * @param stack Set to true if a stack trace should be created
    */
-  point: Point;
-  /**
-   * Shape of a place
-   */
-  polygon?: Polygon;
+  constructor(message: string, stack?: boolean) {
+    super('SyntaxError', message, BAD_REQUEST, stack);
+  }
 }

src/protocol/errors/too-many-requests.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 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 {TOO_MANY_REQUESTS} from 'http-status-codes';
+import {SCError} from '../error';
+
+/**
+ * An error that is returned, when to many request are submitted at once
+ */
+export class SCTooManyRequestsErrorResponse extends SCError {
+  /**
+   * Create a SCTooManyRequestsErrorResponse
+   *
+   * @param stack Set to true if a stack trace should be created
+   */
+  constructor(stack?: boolean) {
+    super(
+      'TooManyRequestsError',
+      'Too many requests. You can not submit more than 5 queries an once',
+      TOO_MANY_REQUESTS,
+      stack,
+    );
+  }
+}

src/protocol/errors/unsupported-media-type.ts

@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2018, 2019 StApps
+ * Copyright (C) 2019 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.
@@ -12,25 +12,19 @@
  * 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 {SCUuid} from '../../../types/UUID';
-import {SCBulkParameters} from './BulkRequest';
+import {UNSUPPORTED_MEDIA_TYPE} from 'http-status-codes';
+import {SCError} from '../error';
 
 /**
- * Requested Bulk from backend
- *
- * @validatable
+ * An error that is returned when the content type of the request is not supported
  */
-export interface SCBulkResponse extends SCBulkParameters {
+export class SCUnsupportedMediaTypeErrorResponse extends SCError {
   /**
-   * State of bulk
+   * Create a SCUnsupportedMediaTypeErrorResponse
    *
-   * The state is `in progress` while it accepts things to be added to the bulk.
-   * The state is `done` once it is closed.
+   * @param stack Set to true if a stack trace should be created
    */
-  state: 'in progress' | 'done';
-
-  /**
-   * Universally unique identifier of the bulk
-   */
-  uid: SCUuid;
+  constructor(stack?: boolean) {
+    super('UnsupportedMediaTypeError', 'Unsupported media type', UNSUPPORTED_MEDIA_TYPE, stack);
+  }
 }

src/protocol/errors/validation.ts

@@ -0,0 +1,38 @@
+/*
+ * Copyright (C) 2019 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 {BAD_REQUEST} from 'http-status-codes';
+import {ValidationError} from 'jsonschema';
+import {SCError} from '../error';
+
+/**
+ * An error that is returned when the validation of a request fails
+ */
+export class SCValidationErrorResponse extends SCError {
+  /**
+   * List of validatation errors
+   */
+  additionalData: ValidationError[];
+
+  /**
+   * Create a SCValidationErrorResponse
+   *
+   * @param errors List of validation errors
+   * @param stack Set to true if a stack trace should be created
+   */
+  constructor(errors: ValidationError[], stack?: boolean) {
+    super('ValidationError', 'Validation of request failed', BAD_REQUEST, stack);
+    this.additionalData = errors;
+  }
+}

src/protocol/route.ts

@@ -0,0 +1,240 @@
+/*
+ * Copyright (C) 2019 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 {SCMap} from '../general/map';
+import {SCErrorResponse} from './error';
+import {SCIndexRequest, SCIndexResponse, SCIndexRoute} from './routes';
+import {
+  SCBookAvailabilityRequest,
+  SCBookAvailabilityResponse,
+  SCBookAvailabilityRoute,
+} from './routes/book-availability';
+import {SCBulkAddRequest, SCBulkAddResponse, SCBulkAddRoute} from './routes/bulk-add';
+import {SCBulkDoneRequest, SCBulkDoneResponse, SCBulkDoneRoute} from './routes/bulk-done';
+import {SCBulkRequest, SCBulkResponse, SCBulkRoute} from './routes/bulk-request';
+import {SCFeedbackRequest, SCFeedbackResponse, SCFeedbackRoute} from './routes/feedback';
+import {SCSearchRequest, SCSearchResponse, SCSearchRoute} from './routes/search';
+import {SCMultiSearchRequest, SCMultiSearchResponse, SCMultiSearchRoute} from './routes/search-multi';
+import {SCThingUpdateRequest, SCThingUpdateResponse, SCThingUpdateRoute} from './routes/thing-update';
+
+/**
+ * Possible Verbs for HTTP requests
+ */
+export enum SCRouteHttpVerbs {
+  GET = 'GET',
+  POST = 'POST',
+  PUT = 'PUT',
+}
+
+/**
+ * The constructor of an error response
+ */
+// tslint:disable-next-line:no-any
+export type SCErrorResponseConstructor = new (...args: any[]) => SCErrorResponse;
+
+/**
+ * A description of a route
+ */
+export interface SCRoute {
+  /**
+   * A map of names of possible errors that can be returned by the route with their appropriate status codes
+   */
+  errorNames: SCErrorResponseConstructor[];
+
+  /**
+   * HTTP verb to use to request the route
+   */
+  method: SCRouteHttpVerbs;
+
+  /**
+   * Map of obligatory parameters and their type that have to be set via the requested path
+   */
+  obligatoryParameters?: SCMap<string>;
+
+  /**
+   * Name of the type of the request body
+   */
+  requestBodyName: string;
+
+  /**
+   * Name of the type of the response body
+   */
+  responseBodyName: string;
+
+  /**
+   * Status code for success
+   */
+  statusCodeSuccess: number;
+
+  /**
+   * URL fragment of the route
+   */
+  urlFragment: string;
+}
+
+/**
+ * An abstract route
+ */
+export abstract class SCAbstractRoute implements SCRoute {
+  /**
+   * @see SCRoute.errorNames
+   */
+  errorNames: SCErrorResponseConstructor[] = [];
+  /**
+   * @see SCRoute.method
+   */
+  method: SCRouteHttpVerbs = SCRouteHttpVerbs.GET;
+  /**
+   * @see SCRoute.obligatoryParameters
+   */
+  obligatoryParameters?: SCMap<string>;
+  /**
+   * @see SCRoute.requestBodyName
+   */
+  requestBodyName = 'any';
+  /**
+   * @see SCRoute.responseBodyName
+   */
+  responseBodyName = 'any';
+  /**
+   * @see SCRoute.statusCodeSuccess
+   */
+  statusCodeSuccess = 200;
+  /**
+   * @see SCRoute.urlFragment
+   */
+  urlFragment = '/';
+
+  /**
+   * Get "compiled" URL fragment
+   *
+   * @param parameters Parameters to compile URL fragment with
+   */
+  public getUrlFragment(parameters: SCMap<string> = {}): string {
+    let obligatoryParameters: string[] = [];
+
+    if (typeof this.obligatoryParameters === 'object') {
+      obligatoryParameters = Object.keys(this.obligatoryParameters);
+    }
+
+    if (Object.keys(parameters).length > obligatoryParameters.length) {
+      throw new Error('Extraneous parameters provided.');
+    }
+
+    return this.urlFragment
+      .split('/')
+      .map((part) => {
+        if (part.indexOf(':') !== 0) {
+          return part;
+        }
+
+        const parameter = part.substr(1);
+
+        if (typeof parameters[parameter] === 'undefined') {
+          throw new Error(`Parameter '${parameter}' not provided.`);
+        }
+
+        return parameters[parameter];
+      })
+      .join('/');
+  }
+}
+
+/**
+ * Possible requests
+ */
+export type SCRequests =
+  SCBookAvailabilityRequest
+  | SCBulkRequest
+  | SCBulkAddRequest
+  | SCBulkDoneRequest
+  | SCFeedbackRequest
+  | SCIndexRequest
+  | SCMultiSearchRequest
+  | SCSearchRequest
+  | SCThingUpdateRequest;
+
+/**
+ * Possible responses
+ */
+export type SCResponses =
+  SCBookAvailabilityResponse
+  | SCBulkResponse
+  | SCBulkAddResponse
+  | SCBulkDoneResponse
+  | SCFeedbackResponse
+  | SCIndexResponse
+  | SCMultiSearchResponse
+  | SCSearchResponse
+  | SCThingUpdateResponse;
+
+/**
+ * Associated response for a request
+ */
+export type SCAssociatedResponse<REQUEST> =
+  REQUEST extends SCBookAvailabilityRequest ? SCBookAvailabilityResponse :
+    REQUEST extends SCBulkRequest ? SCBulkResponse :
+      REQUEST extends SCBulkAddRequest ? SCBulkAddResponse :
+        REQUEST extends SCBulkDoneRequest ? SCBulkDoneResponse :
+          REQUEST extends SCFeedbackRequest ? SCFeedbackResponse :
+            REQUEST extends SCIndexRequest ? SCIndexResponse :
+              REQUEST extends SCMultiSearchRequest ? SCMultiSearchResponse :
+                REQUEST extends SCSearchRequest ? SCSearchResponse :
+                  REQUEST extends SCThingUpdateRequest ? SCThingUpdateResponse :
+                    never;
+
+/**
+ * Associated request for a response
+ */
+export type SCAssociatedRequest<RESPONSE> =
+  RESPONSE extends SCBookAvailabilityResponse ? SCBookAvailabilityRequest :
+    RESPONSE extends SCBulkResponse ? SCBulkRequest :
+      RESPONSE extends SCBulkAddResponse ? SCBulkAddRequest :
+        RESPONSE extends SCBulkDoneResponse ? SCBulkDoneRequest :
+          RESPONSE extends SCFeedbackResponse ? SCFeedbackRequest :
+            RESPONSE extends SCIndexResponse ? SCIndexRequest :
+              RESPONSE extends SCMultiSearchResponse ? SCMultiSearchRequest :
+                RESPONSE extends SCSearchResponse ? SCSearchRequest :
+                  RESPONSE extends SCThingUpdateResponse ? SCThingUpdateRequest :
+                    never;
+
+/**
+ * Associated request for a route
+ */
+export type SCAssignedRequest<ROUTE extends SCAbstractRoute> =
+  ROUTE extends SCBookAvailabilityRoute ? SCBookAvailabilityRequest :
+    ROUTE extends SCBulkRoute ? SCBulkRequest :
+      ROUTE extends SCBulkAddRoute ? SCBulkAddRequest :
+        ROUTE extends SCBulkDoneRoute ? SCBulkDoneRequest :
+          ROUTE extends SCFeedbackRoute ? SCFeedbackRequest :
+            ROUTE extends SCIndexRoute ? SCIndexRequest :
+              ROUTE extends SCMultiSearchRoute ? SCMultiSearchRequest :
+                ROUTE extends SCSearchRoute ? SCSearchRequest :
+                  ROUTE extends SCThingUpdateRoute ? SCThingUpdateRequest :
+                    never;
+
+/**
+ * Associated response for a route
+ */
+export type SCAssignedResponse<ROUTE extends SCAbstractRoute> =
+  ROUTE extends SCBookAvailabilityRoute ? SCBookAvailabilityResponse :
+    ROUTE extends SCBulkRoute ? SCBulkResponse :
+      ROUTE extends SCBulkAddRoute ? SCBulkAddResponse :
+        ROUTE extends SCBulkDoneRoute ? SCBulkDoneResponse :
+          ROUTE extends SCFeedbackRoute ? SCFeedbackResponse :
+            ROUTE extends SCIndexRoute ? SCIndexResponse :
+              ROUTE extends SCMultiSearchRoute ? SCMultiSearchResponse :
+                ROUTE extends SCSearchRoute ? SCSearchResponse :
+                  ROUTE extends SCThingUpdateRoute ? SCThingUpdateResponse :
+                    never;

src/protocol/routes/book-availability.ts

@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2018-2019 StApps
+ * Copyright (C) 2019 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.
@@ -12,20 +12,21 @@
  * 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 {SCAbstractRoute, SCRouteHttpVerbs} from '../../../Route';
-import {SCUuid} from '../../../types/UUID';
-import {
-  SCInternalServerErrorResponse,
-  SCMethodNotAllowedErrorResponse,
-  SCNotFoundErrorResponse,
-  SCRequestBodyTooLargeErrorResponse,
-  SCSyntaxErrorResponse,
-  SCUnsupportedMediaTypeErrorResponse,
-  SCValidationErrorResponse,
-} from '../../errors/ErrorResponse';
+import {OK} from 'http-status-codes';
+import {SCUuid} from '../../general/uuid';
+import {SCAcademicPriceGroup, SCThingThatCanBeOfferedOffer} from '../../things/abstract/thing-that-can-be-offered';
+import {SCInternalServerErrorResponse} from '../errors/internal-server-error';
+import {SCMethodNotAllowedErrorResponse} from '../errors/method-not-allowed';
+import {SCNotFoundErrorResponse} from '../errors/not-found';
+import {SCRequestBodyTooLargeErrorResponse} from '../errors/request-body-too-large';
+import {SCSyntaxErrorResponse} from '../errors/syntax-error';
+import {SCUnsupportedMediaTypeErrorResponse} from '../errors/unsupported-media-type';
+import {SCValidationErrorResponse} from '../errors/validation';
+import {SCAbstractRoute, SCRouteHttpVerbs} from '../route';
 
 /**
  * Request to check the availability of books
+ *
  * @validatable
  */
 export type SCBookAvailabilityRequest = SCBookAvailabilityRequestByIsbn | SCBookAvailabilityRequestByUuid;
@@ -50,6 +51,13 @@ export interface SCBookAvailabilityRequestByUuid {
   uid: SCUuid;
 }
 
+/**
+ * List of availabilities of a book
+ *
+ * @validatable
+ */
+export type SCBookAvailabilityResponse = Array<SCThingThatCanBeOfferedOffer<SCAcademicPriceGroup>>;
+
 /**
  * Route for book availability
  *
@@ -80,7 +88,7 @@ export class SCBookAvailabilityRoute extends SCAbstractRoute {
     this.method = SCRouteHttpVerbs.POST;
     this.requestBodyName = 'SCBookAvailabilityRequest';
     this.responseBodyName = 'SCBookAvailabilityResponse';
-    this.statusCodeSuccess = 200;
+    this.statusCodeSuccess = OK;
     this.urlFragment = '/bookAvailability';
   }
 }

src/protocol/routes/bulk-add.ts

@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2018-2019 StApps
+ * Copyright (C) 2019 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.
@@ -12,24 +12,32 @@
  * 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 {SCThings} from '../../../../Classes';
-import {SCAbstractRoute, SCRouteHttpVerbs} from '../../../../Route';
-import {
-  SCInternalServerErrorResponse,
-  SCMethodNotAllowedErrorResponse,
-  SCNotFoundErrorResponse,
-  SCRequestBodyTooLargeErrorResponse,
-  SCSyntaxErrorResponse,
-  SCUnsupportedMediaTypeErrorResponse,
-  SCValidationErrorResponse,
-} from '../../../errors/ErrorResponse';
+import {CREATED} from 'http-status-codes';
+import {SCThings} from '../../meta';
+import {SCInternalServerErrorResponse} from '../errors/internal-server-error';
+import {SCMethodNotAllowedErrorResponse} from '../errors/method-not-allowed';
+import {SCNotFoundErrorResponse} from '../errors/not-found';
+import {SCRequestBodyTooLargeErrorResponse} from '../errors/request-body-too-large';
+import {SCSyntaxErrorResponse} from '../errors/syntax-error';
+import {SCUnsupportedMediaTypeErrorResponse} from '../errors/unsupported-media-type';
+import {SCValidationErrorResponse} from '../errors/validation';
+import {SCAbstractRoute, SCRouteHttpVerbs} from '../route';
 
 /**
  * Request to add a thing to a bulk
+ *
  * @validatable
  */
 export type SCBulkAddRequest = SCThings;
 
+/**
+ * Response to a request to add a thing to a bulk
+ *
+ * @validatable
+ */
+export interface SCBulkAddResponse {
+}
+
 /**
  * Route for indexing SC things in a bulk
  */
@@ -51,7 +59,7 @@ export class SCBulkAddRoute extends SCAbstractRoute {
     };
     this.requestBodyName = 'SCBulkAddRequest';
     this.responseBodyName = 'SCBulkAddResponse';
-    this.statusCodeSuccess = 201;
+    this.statusCodeSuccess = CREATED;
     this.urlFragment = '/bulk/:UID';
   }
 }

src/protocol/routes/bulk-done.ts

@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2018-2019 StApps
+ * Copyright (C) 2019 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.
@@ -12,24 +12,32 @@
  * 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 {SCAbstractRoute, SCRouteHttpVerbs} from '../../../../Route';
-import {
-  SCInternalServerErrorResponse,
-  SCMethodNotAllowedErrorResponse,
-  SCNotFoundErrorResponse,
-  SCRequestBodyTooLargeErrorResponse,
-  SCSyntaxErrorResponse,
-  SCUnsupportedMediaTypeErrorResponse,
-  SCValidationErrorResponse,
-} from '../../../errors/ErrorResponse';
+import {NO_CONTENT} from 'http-status-codes';
+import {SCInternalServerErrorResponse} from '../errors/internal-server-error';
+import {SCMethodNotAllowedErrorResponse} from '../errors/method-not-allowed';
+import {SCNotFoundErrorResponse} from '../errors/not-found';
+import {SCRequestBodyTooLargeErrorResponse} from '../errors/request-body-too-large';
+import {SCSyntaxErrorResponse} from '../errors/syntax-error';
+import {SCUnsupportedMediaTypeErrorResponse} from '../errors/unsupported-media-type';
+import {SCValidationErrorResponse} from '../errors/validation';
+import {SCAbstractRoute, SCRouteHttpVerbs} from '../route';
 
 /**
  * Request to change the bulk state to done (close the bulk process)
+ *
  * @validatable
  */
 export interface SCBulkDoneRequest {
 }
 
+/**
+ * Response to a request to change the state of a bulk to done
+ *
+ * @validatable
+ */
+export interface SCBulkDoneResponse {
+}
+
 /**
  * Route for closing bulks
  */
@@ -51,7 +59,7 @@ export class SCBulkDoneRoute extends SCAbstractRoute {
     };
     this.requestBodyName = 'SCBulkDoneRequest';
     this.responseBodyName = 'SCBulkDoneResponse';
-    this.statusCodeSuccess = 204;
+    this.statusCodeSuccess = NO_CONTENT;
     this.urlFragment = '/bulk/:UID/done';
   }
 }

src/protocol/routes/bulk-request.ts

@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2018-2019 StApps
+ * Copyright (C) 2019 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.
@@ -12,17 +12,17 @@
  * 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 {SCAbstractRoute, SCRouteHttpVerbs} from '../../../Route';
-import {SCThingType} from '../../../Thing';
-import {SCISO8601Date} from '../../../types/Time';
-import {
-  SCInternalServerErrorResponse,
-  SCMethodNotAllowedErrorResponse,
-  SCRequestBodyTooLargeErrorResponse,
-  SCSyntaxErrorResponse,
-  SCUnsupportedMediaTypeErrorResponse,
-  SCValidationErrorResponse,
-} from '../../errors/ErrorResponse';
+import {OK} from 'http-status-codes';
+import {SCISO8601Date} from '../../general/time';
+import {SCUuid} from '../../general/uuid';
+import {SCThingType} from '../../things/abstract/thing';
+import {SCInternalServerErrorResponse} from '../errors/internal-server-error';
+import {SCMethodNotAllowedErrorResponse} from '../errors/method-not-allowed';
+import {SCRequestBodyTooLargeErrorResponse} from '../errors/request-body-too-large';
+import {SCSyntaxErrorResponse} from '../errors/syntax-error';
+import {SCUnsupportedMediaTypeErrorResponse} from '../errors/unsupported-media-type';
+import {SCValidationErrorResponse} from '../errors/validation';
+import {SCAbstractRoute, SCRouteHttpVerbs} from '../route';
 
 /**
  * A bulk request
@@ -56,11 +56,31 @@ export interface SCBulkParameters {
 
   /**
    * Type of things that are indexed in this bulk.
-   * 
+   *
    */
   type: SCThingType;
 }
 
+/**
+ * Requested Bulk from backend
+ *
+ * @validatable
+ */
+export interface SCBulkResponse extends SCBulkParameters {
+  /**
+   * State of bulk
+   *
+   * The state is `in progress` while it accepts things to be added to the bulk.
+   * The state is `done` once it is closed.
+   */
+  state: 'in progress' | 'done';
+
+  /**
+   * Universally unique identifier of the bulk
+   */
+  uid: SCUuid;
+}
+
 /**
  * Route for bulk creation
  */
@@ -78,7 +98,7 @@ export class SCBulkRoute extends SCAbstractRoute {
     this.method = SCRouteHttpVerbs.POST;
     this.requestBodyName = 'SCBulkRequest';
     this.responseBodyName = 'SCBulkResponse';
-    this.statusCodeSuccess = 200;
+    this.statusCodeSuccess = OK;
     this.urlFragment = '/bulk';
   }
 }

src/protocol/routes/feedback.ts

@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2018-2019 StApps
+ * Copyright (C) 2019 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.
@@ -12,16 +12,15 @@
  * 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 {SCAbstractRoute, SCRouteHttpVerbs} from '../../../Route';
-import {SCMessage} from '../../../things/Message';
-import {
-  SCInternalServerErrorResponse,
-  SCMethodNotAllowedErrorResponse,
-  SCRequestBodyTooLargeErrorResponse,
-  SCSyntaxErrorResponse,
-  SCUnsupportedMediaTypeErrorResponse,
-  SCValidationErrorResponse,
-} from '../../errors/ErrorResponse';
+import {NO_CONTENT} from 'http-status-codes';
+import {SCMessage} from '../../things/message';
+import {SCInternalServerErrorResponse} from '../errors/internal-server-error';
+import {SCMethodNotAllowedErrorResponse} from '../errors/method-not-allowed';
+import {SCRequestBodyTooLargeErrorResponse} from '../errors/request-body-too-large';
+import {SCSyntaxErrorResponse} from '../errors/syntax-error';
+import {SCUnsupportedMediaTypeErrorResponse} from '../errors/unsupported-media-type';
+import {SCValidationErrorResponse} from '../errors/validation';
+import {SCAbstractRoute, SCRouteHttpVerbs} from '../route';
 
 /**
  * User feedback
@@ -35,6 +34,14 @@ export interface SCFeedbackRequest extends SCMessage {
   metaData: SCFeedbackRequestMetaData;
 }
 
+/**
+ * A response to a feedback request
+ *
+ * @validatable
+ */
+export interface SCFeedbackResponse {
+}
+
 /**
  * Route for feedback submission
  */
@@ -52,7 +59,7 @@ export class SCFeedbackRoute extends SCAbstractRoute {
     this.method = SCRouteHttpVerbs.POST;
     this.requestBodyName = 'SCFeedbackRequest';
     this.responseBodyName = 'SCFeedbackResponse';
-    this.statusCodeSuccess = 204;
+    this.statusCodeSuccess = NO_CONTENT;
     this.urlFragment = '/feedback';
   }
 }
@@ -74,7 +81,7 @@ export interface SCFeedbackRequestMetaData {
   /**
    * Scope/app state at feedback invocation
    */
-  scope: any;
+  scope: unknown;
 
   /**
    * Whether or not the feedback is sendable
@@ -84,7 +91,7 @@ export interface SCFeedbackRequestMetaData {
   /**
    * App state that feedback was invoked from
    */
-  state: any;
+  state: unknown;
 
   /**
    * User agent

src/protocol/routes/index.ts

@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2018-2019 StApps
+ * Copyright (C) 2019 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.
@@ -12,15 +12,16 @@
  * 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 {SCAbstractRoute, SCRouteHttpVerbs} from '../../../Route';
-import {
-  SCInternalServerErrorResponse,
-  SCMethodNotAllowedErrorResponse,
-  SCRequestBodyTooLargeErrorResponse,
-  SCSyntaxErrorResponse,
-  SCUnsupportedMediaTypeErrorResponse,
-  SCValidationErrorResponse,
-} from '../../errors/ErrorResponse';
+import {OK} from 'http-status-codes';
+import {SCAppConfiguration} from '../../config/app';
+import {SCBackendConfiguration} from '../../config/backend';
+import {SCInternalServerErrorResponse} from '../errors/internal-server-error';
+import {SCMethodNotAllowedErrorResponse} from '../errors/method-not-allowed';
+import {SCRequestBodyTooLargeErrorResponse} from '../errors/request-body-too-large';
+import {SCSyntaxErrorResponse} from '../errors/syntax-error';
+import {SCUnsupportedMediaTypeErrorResponse} from '../errors/unsupported-media-type';
+import {SCValidationErrorResponse} from '../errors/validation';
+import {SCAbstractRoute, SCRouteHttpVerbs} from '../route';
 
 /**
  * Index request
@@ -30,6 +31,23 @@ import {
 export interface SCIndexRequest {
 }
 
+/**
+ * A response to an index request
+ *
+ * @validatable
+ */
+export interface SCIndexResponse {
+  /**
+   * @see SCAppConfiguration
+   */
+  app: SCAppConfiguration;
+
+  /**
+   * @see SCBackendConfiguration
+   */
+  backend: SCBackendConfiguration;
+}
+
 /**
  * Route to request meta information about the deployment
  */
@@ -47,7 +65,7 @@ export class SCIndexRoute extends SCAbstractRoute {
     this.method = SCRouteHttpVerbs.POST;
     this.requestBodyName = 'SCIndexRequest';
     this.responseBodyName = 'SCIndexResponse';
-    this.statusCodeSuccess = 200;
+    this.statusCodeSuccess = OK;
     this.urlFragment = '/';
   }
 }

src/protocol/routes/plugin-register.ts

@@ -12,17 +12,17 @@
  * 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 {OK} from 'http-status-codes';
 import {Schema} from 'jsonschema';
-import {SCAbstractRoute, SCRouteHttpVerbs} from '../../../Route';
-import {
-  SCInternalServerErrorResponse,
-  SCMethodNotAllowedErrorResponse, SCParametersNotAcceptable,
-  SCPluginAlreadyRegisteredErrorResponse,
-  SCPluginRegisteringFailedErrorResponse,
-  SCPluginRouteAlreadyRegisteredErrorResponse,
-  SCRequestBodyTooLargeErrorResponse,
-  SCSyntaxErrorResponse,
-} from '../../errors/ErrorResponse';
+import {SCInternalServerErrorResponse} from '../errors/internal-server-error';
+import {SCMethodNotAllowedErrorResponse} from '../errors/method-not-allowed';
+import {SCNotFoundErrorResponse} from '../errors/not-found';
+import {SCParametersNotAcceptable} from '../errors/parameters-not-acceptable';
+import {SCPluginAlreadyRegisteredErrorResponse} from '../errors/plugin-already-registered';
+import {SCPluginRegisteringFailedErrorResponse} from '../errors/plugin-registering-failed';
+import {SCRequestBodyTooLargeErrorResponse} from '../errors/request-body-too-large';
+import {SCSyntaxErrorResponse} from '../errors/syntax-error';
+import {SCAbstractRoute, SCRouteHttpVerbs} from '../route';
 
 /**
  * Plugin register request
@@ -91,6 +91,18 @@ export interface SCPluginMetaData {
   route: string;
 }
 
+/**
+ * Plugin register response
+ *
+ * @validatable
+ */
+export interface SCPluginRegisterResponse {
+  /**
+   * Whether the desired action succeeded or failed (true for success, false if an error occurred)
+   */
+  success: boolean;
+}
+
 /**
  * Route to register plugins
  */
@@ -100,17 +112,17 @@ export class SCPluginRegisterRoute extends SCAbstractRoute {
     this.errorNames = [
       SCInternalServerErrorResponse,
       SCMethodNotAllowedErrorResponse,
+      SCNotFoundErrorResponse,
       SCParametersNotAcceptable,
       SCPluginAlreadyRegisteredErrorResponse,
       SCPluginRegisteringFailedErrorResponse,
-      SCPluginRouteAlreadyRegisteredErrorResponse,
       SCRequestBodyTooLargeErrorResponse,
       SCSyntaxErrorResponse,
     ];
     this.method = SCRouteHttpVerbs.POST;
     this.requestBodyName = 'SCPluginRegisterRequest';
     this.responseBodyName = 'SCPluginRegisterResponse';
-    this.statusCodeSuccess = 200;
+    this.statusCodeSuccess = OK;
     this.urlFragment = '/plugin/register';
   }
 }

src/protocol/routes/search-multi.ts

@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2018-2019 StApps
+ * Copyright (C) 2019 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.
@@ -12,18 +12,18 @@
  * 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 {SCAbstractRoute, SCRouteHttpVerbs} from '../../../Route';
-import {SCMap} from '../../../types/Map';
-import {
-  SCInternalServerErrorResponse,
-  SCMethodNotAllowedErrorResponse,
-  SCRequestBodyTooLargeErrorResponse,
-  SCSyntaxErrorResponse,
-  SCTooManyRequestsErrorResponse,
-  SCUnsupportedMediaTypeErrorResponse,
-  SCValidationErrorResponse,
-} from '../../errors/ErrorResponse';
-import {SCSearchQuery} from './SearchRequest';
+import {OK} from 'http-status-codes';
+import {SCMap} from '../../general/map';
+import {SCInternalServerErrorResponse} from '../errors/internal-server-error';
+import {SCMethodNotAllowedErrorResponse} from '../errors/method-not-allowed';
+import {SCRequestBodyTooLargeErrorResponse} from '../errors/request-body-too-large';
+import {SCSyntaxErrorResponse} from '../errors/syntax-error';
+import {SCTooManyRequestsErrorResponse} from '../errors/too-many-requests';
+import {SCUnsupportedMediaTypeErrorResponse} from '../errors/unsupported-media-type';
+import {SCValidationErrorResponse} from '../errors/validation';
+import {SCAbstractRoute, SCRouteHttpVerbs} from '../route';
+import {SCSearchQuery} from '../search/query';
+import {SCSearchResult} from '../search/result';
 
 /**
  * A multi search request
@@ -36,6 +36,15 @@ import {SCSearchQuery} from './SearchRequest';
  */
 export type SCMultiSearchRequest = SCMap<SCSearchQuery>;
 
+/**
+ * A multi search response
+ *
+ * This is a map of [[SCSearchResponse]]s indexed by name
+ *
+ * @validatable
+ */
+export type SCMultiSearchResponse = SCMap<SCSearchResult>;
+
 /**
  * Route for submission of multiple search requests at once
  */
@@ -54,7 +63,7 @@ export class SCMultiSearchRoute extends SCAbstractRoute {
     this.method = SCRouteHttpVerbs.POST;
     this.requestBodyName = 'SCMultiSearchRequest';
     this.responseBodyName = 'SCMultiSearchResponse';
-    this.statusCodeSuccess = 200;
+    this.statusCodeSuccess = OK;
     this.urlFragment = '/search/multi';
   }
 }

src/protocol/routes/search.ts

@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2018-2019 StApps
+ * Copyright (C) 2019 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.
@@ -12,18 +12,16 @@
  * 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 {SCAbstractRoute, SCRouteHttpVerbs} from '../../../Route';
-import {SCSearchContext} from '../../../types/config/Backend';
-import {SCSearchFilter} from '../../../types/filters/Abstract';
-import {SCSearchSort} from '../../../types/sorts/Abstract';
-import {
-  SCInternalServerErrorResponse,
-  SCMethodNotAllowedErrorResponse,
-  SCRequestBodyTooLargeErrorResponse,
-  SCSyntaxErrorResponse,
-  SCUnsupportedMediaTypeErrorResponse,
-  SCValidationErrorResponse,
-} from '../../errors/ErrorResponse';
+import {OK} from 'http-status-codes';
+import {SCInternalServerErrorResponse} from '../errors/internal-server-error';
+import {SCMethodNotAllowedErrorResponse} from '../errors/method-not-allowed';
+import {SCRequestBodyTooLargeErrorResponse} from '../errors/request-body-too-large';
+import {SCSyntaxErrorResponse} from '../errors/syntax-error';
+import {SCUnsupportedMediaTypeErrorResponse} from '../errors/unsupported-media-type';
+import {SCValidationErrorResponse} from '../errors/validation';
+import {SCAbstractRoute, SCRouteHttpVerbs} from '../route';
+import {SCSearchQuery} from '../search/query';
+import {SCSearchResult} from '../search/result';
 
 /**
  * A search request
@@ -34,38 +32,11 @@ export interface SCSearchRequest extends SCSearchQuery {
 }
 
 /**
- * A search query
+ * A search response
+ *
+ * @validatable
  */
-export interface SCSearchQuery {
-  /**
-   * The context name from where the search query was initiated
-   */
-  context?: SCSearchContext;
-
-  /**
-   * A filter structure that combines any number of filters with boolean methods ('AND', 'OR', 'NOT')
-   */
-  filter?: SCSearchFilter;
-
-  /**
-   * Number of things to skip in result set (paging)
-   */
-  from?: number;
-
-  /**
-   * A term to search for
-   */
-  query?: string;
-
-  /**
-   * Number of things to have in the result set (paging)
-   */
-  size?: number;
-
-  /**
-   * A list of sorting parameters to order the result set by
-   */
-  sort?: SCSearchSort[];
+export interface SCSearchResponse extends SCSearchResult {
 }
 
 /**
@@ -85,7 +56,7 @@ export class SCSearchRoute extends SCAbstractRoute {
     this.method = SCRouteHttpVerbs.POST;
     this.requestBodyName = 'SCSearchRequest';
     this.responseBodyName = 'SCSearchResponse';
-    this.statusCodeSuccess = 200;
+    this.statusCodeSuccess = OK;
     this.urlFragment = '/search';
   }
 }

src/protocol/routes/thing-update.ts

@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2018-2019 StApps
+ * Copyright (C) 2019 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.
@@ -12,17 +12,16 @@
  * 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 {SCThings} from '../../../../Classes';
-import {SCAbstractRoute, SCRouteHttpVerbs} from '../../../../Route';
-import {
-  SCInternalServerErrorResponse,
-  SCMethodNotAllowedErrorResponse,
-  SCNotFoundErrorResponse,
-  SCRequestBodyTooLargeErrorResponse,
-  SCSyntaxErrorResponse,
-  SCUnsupportedMediaTypeErrorResponse,
-  SCValidationErrorResponse,
-} from '../../../errors/ErrorResponse';
+import {OK} from 'http-status-codes';
+import {SCThings} from '../../meta';
+import {SCInternalServerErrorResponse} from '../errors/internal-server-error';
+import {SCMethodNotAllowedErrorResponse} from '../errors/method-not-allowed';
+import {SCNotFoundErrorResponse} from '../errors/not-found';
+import {SCRequestBodyTooLargeErrorResponse} from '../errors/request-body-too-large';
+import {SCSyntaxErrorResponse} from '../errors/syntax-error';
+import {SCUnsupportedMediaTypeErrorResponse} from '../errors/unsupported-media-type';
+import {SCValidationErrorResponse} from '../errors/validation';
+import {SCAbstractRoute, SCRouteHttpVerbs} from '../route';
 
 /**
  * Request to update an existing thing
@@ -31,6 +30,14 @@ import {
  */
 export type SCThingUpdateRequest = SCThings;
 
+/**
+ * Response for an entity update request
+ *
+ * @validatable
+ */
+export interface SCThingUpdateResponse {
+}
+
 /**
  * Route for updating existing things
  */
@@ -53,7 +60,7 @@ export class SCThingUpdateRoute extends SCAbstractRoute {
     };
     this.requestBodyName = 'SCThingUpdateRequest';
     this.responseBodyName = 'SCThingUpdateResponse';
-    this.statusCodeSuccess = 200;
+    this.statusCodeSuccess = OK;
     this.urlFragment = '/:TYPE/:UID';
   }
 }

src/protocol/search/facet.ts

@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2018 StApps
+ * Copyright (C) 2019 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.
@@ -12,37 +12,40 @@
  * 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 {SCThingsField} from '../../meta';
+import {SCThingType} from '../../things/abstract/thing';
+
 /**
- * A postal address
+ * A search facet
  */
-export interface SCPostalAddress {
+export interface SCFacet {
   /**
-   * Country of the address
+   * Buckets for the aggregation
    */
-  addressCountry: string;
+  buckets: SCFacetBucket[];
 
   /**
-   * City of the address
+   * Field of the aggregation
    */
-  addressLocality: string;
+  field: SCThingsField;
 
   /**
-   * State of the address
+   * Type of the aggregation
    */
-  addressRegion?: string;
-
-  /**
-   * Zip code of the address
-   */
-  postalCode: string;
-
-  /**
-   * Optional post box number
-   */
-  postOfficeBoxNumber?: string;
-
-  /**
-   * Street of the address - with house number!
-   */
-  streetAddress: string;
+  onlyOnType?: SCThingType;
+}
+
+/**
+ * A bucket of a facet
+ */
+export interface SCFacetBucket {
+  /**
+   * Count of matching search results
+   */
+  count: number;
+
+  /**
+   * Key of a bucket
+   */
+  key: string;
 }

src/protocol/search/filter.ts

@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2018-2019 StApps
+ * Copyright (C) 2019 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.
@@ -12,14 +12,14 @@
  * 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 {SCMap} from '../Map';
+import {SCMap} from '../../general/map';
 /**
  * All available filter types
  */
-import {SCSearchAvailabilityFilter} from './Availability';
-import {SCSearchBooleanFilter} from './Boolean';
-import {SCSearchDistanceFilter} from './Distance';
-import {SCSearchValueFilter} from './Value';
+import {SCSearchAvailabilityFilter} from './filters/availability';
+import {SCSearchBooleanFilter} from './filters/boolean';
+import {SCSearchDistanceFilter} from './filters/distance';
+import {SCSearchValueFilter} from './filters/value';
 
 /**
  * Filter instruction types
@@ -48,7 +48,7 @@ export interface SCSearchAbstractFilter<T extends SCSearchAbstractFilterArgument
 /**
  * Arguments for the filter instruction
  */
-export type SCSearchAbstractFilterArguments = SCMap<any>;
+export type SCSearchAbstractFilterArguments = SCMap<unknown>;
 
 /**
  * Available filter instructions

src/protocol/search/filters/availability.ts

@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2018 StApps
+ * Copyright (C) 2019 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.
@@ -12,9 +12,9 @@
  * 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 {SCThingsField} from '../../Classes';
-import {SCISO8601Date} from '../Time';
-import {SCSearchAbstractFilter, SCSearchAbstractFilterArguments} from './Abstract';
+import {SCISO8601Date} from '../../../general/time';
+import {SCThingsField} from '../../../meta';
+import {SCSearchAbstractFilter, SCSearchAbstractFilterArguments} from '../filter';
 
 /**
  * An availability filter
@@ -22,6 +22,9 @@ import {SCSearchAbstractFilter, SCSearchAbstractFilterArguments} from './Abstrac
  * Filter for documents where it cannot be safely determined that they are not available
  */
 export interface SCSearchAvailabilityFilter extends SCSearchAbstractFilter<SCAvailabilityFilterArguments> {
+  /**
+   * @see SCSearchAbstractFilter.type
+   */
   type: 'availability';
 }
 

src/protocol/search/filters/boolean.ts

@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2018 StApps
+ * Copyright (C) 2019 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.
@@ -12,7 +12,7 @@
  * 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 {SCSearchAbstractFilter, SCSearchAbstractFilterArguments, SCSearchFilter} from './Abstract';
+import {SCSearchAbstractFilter, SCSearchAbstractFilterArguments, SCSearchFilter} from '../filter';
 
 /**
  * A boolean filter
@@ -20,6 +20,9 @@ import {SCSearchAbstractFilter, SCSearchAbstractFilterArguments, SCSearchFilter}
  * This filter can be used to combine multiple filters with boolean operations.
  */
 export interface SCSearchBooleanFilter extends SCSearchAbstractFilter<SCBooleanFilterArguments> {
+  /**
+   * @see SCSearchAbstractFilter.type
+   */
   type: 'boolean';
 }
 

src/protocol/search/filters/distance.ts

@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2018 StApps
+ * Copyright (C) 2019 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.
@@ -12,16 +12,20 @@
  * You should have received a copy of the GNU General Public License along with
  * this program. If not, see <https://www.gnu.org/licenses/>.
  */
+// tslint:disable-next-line:no-implicit-dependencies
 import {Position} from 'geojson';
-import {SCThingsField} from '../../Classes';
-import {SCSearchAbstractFilter, SCSearchAbstractFilterArguments} from './Abstract';
+import {SCThingsField} from '../../../meta';
+import {SCSearchAbstractFilter, SCSearchAbstractFilterArguments} from '../filter';
 
 /**
  * A distance filter
  *
  * Filter for documents that are in the given distance of the given location
  */
-export interface SCSearchDistanceFilter extends SCSearchAbstractFilter<SCSearchAbstractFilterArguments> {
+export interface SCSearchDistanceFilter extends SCSearchAbstractFilter<SCDistanceFilterArguments> {
+  /**
+   * @see SCSearchAbstractFilter.type
+   */
   type: 'distance';
 }
 

src/protocol/search/filters/value.ts

@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2018 StApps
+ * Copyright (C)  2019 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.
@@ -12,13 +12,16 @@
  * 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 {SCThingsField} from '../../Classes';
-import {SCSearchAbstractFilter, SCSearchAbstractFilterArguments} from './Abstract';
+import {SCThingsField} from '../../../meta';
+import {SCSearchAbstractFilter, SCSearchAbstractFilterArguments} from '../filter';
 
 /**
  * Filters for documents that match the value on the given field
  */
 export interface SCSearchValueFilter extends SCSearchAbstractFilter<SCValueFilterArguments> {
+  /**
+   * @see SCSearchAbstractFilter.type
+   */
   type: 'value';
 }
 

src/protocol/search/query.ts

@@ -0,0 +1,52 @@
+/*
+ * Copyright (C) 2019 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 {SCSearchContext} from '../../config/backend';
+import {SCSearchFilter} from './filter';
+import {SCSearchSort} from './sort';
+
+/**
+ * A search query
+ */
+export interface SCSearchQuery {
+  /**
+   * The context name from where the search query was initiated
+   */
+  context?: SCSearchContext;
+
+  /**
+   * A filter structure that combines any number of filters with boolean methods ('AND', 'OR', 'NOT')
+   */
+  filter?: SCSearchFilter;
+
+  /**
+   * Number of things to skip in result set (paging)
+   */
+  from?: number;
+
+  /**
+   * A term to search for
+   */
+  query?: string;
+
+  /**
+   * Number of things to have in the result set (paging)
+   */
+  size?: number;
+
+  /**
+   * A list of sorting parameters to order the result set by
+   */
+  sort?: SCSearchSort[];
+}

src/protocol/search/result.ts

@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2018, 2019 StApps
+ * Copyright (C) 2019 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.
@@ -12,15 +12,8 @@
  * 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 {SCThings, SCThingsField} from '../../../Classes';
-
-/**
- * A search response
- *
- * @validatable
- */
-export interface SCSearchResponse extends SCSearchResult {
-}
+import {SCThings} from '../../meta';
+import {SCFacet} from './facet';
 
 /**
  * A search response
@@ -39,48 +32,18 @@ export interface SCSearchResult {
   /**
    * Pagination information
    */
-  pagination: SCSearchResponsePagination;
+  pagination: SCSearchResultPagination;
 
   /**
    * Stats of the search engine
    */
-  stats: SCSearchResponseSearchEngineStats;
-}
-
-/**
- * A search facet
- */
-export interface SCFacet {
-  /**
-   * Buckets for the aggregation
-   */
-  buckets: SCFacetBucket[];
-
-  /**
-   * Field of the aggregation
-   */
-  field: SCThingsField;
-}
-
-/**
- * A bucket of a facet
- */
-export interface SCFacetBucket {
-  /**
-   * Count of matching search results
-   */
-  count: number;
-
-  /**
-   * Key of a bucket
-   */
-  key: string;
+  stats: SCSearchResultSearchEngineStats;
 }
 
 /**
  * Stores information about Pagination
  */
-export interface SCSearchResponsePagination {
+export interface SCSearchResultPagination {
   /**
    * Count of given data. Same as data.length
    */
@@ -100,7 +63,7 @@ export interface SCSearchResponsePagination {
 /**
  * Statistics of search engine
  */
-export interface SCSearchResponseSearchEngineStats {
+export interface SCSearchResultSearchEngineStats {
   /**
    * Response time of the search engine in ms
    */

src/protocol/search/sort.ts

@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2018-2019 StApps
+ * Copyright (C) 2019 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.
@@ -12,11 +12,11 @@
  * 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 {SCThingsField} from '../../Classes';
-import {SCMap} from '../Map';
-import {SCDistanceSort} from './Distance';
-import {SCDucetSort} from './Ducet';
-import {SCPriceSort} from './Price';
+import {SCMap} from '../../general/map';
+import {SCThingsField} from '../../meta';
+import {SCDistanceSort} from './sorts/distance';
+import {SCDucetSort} from './sorts/ducet';
+import {SCPriceSort} from './sorts/price';
 
 /**
  * Abstract sort instruction
@@ -41,7 +41,7 @@ export interface SCSearchAbstractSort<T extends SCSearchAbstractSortArguments> {
 /**
  * Map of arguments for the sort instruction
  */
-export interface SCSearchAbstractSortArguments extends SCMap<any> {
+export interface SCSearchAbstractSortArguments extends SCMap<unknown> {
   /**
    * Field to sort by
    */

src/protocol/search/sorts/distance.ts

@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2018 StApps
+ * Copyright (C) 2019 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.
@@ -12,13 +12,17 @@
  * You should have received a copy of the GNU General Public License along with
  * this program. If not, see <https://www.gnu.org/licenses/>.
  */
+// tslint:disable-next-line:no-implicit-dependencies
 import {Position} from 'geojson';
-import {SCSearchAbstractSort, SCSearchAbstractSortArguments} from './Abstract';
+import {SCSearchAbstractSort, SCSearchAbstractSortArguments} from '../sort';
 
 /**
  * Sort instruction to sort by distance
  */
 export interface SCDistanceSort extends SCSearchAbstractSort<SCDistanceSortArguments> {
+  /**
+   * @see SCSearchAbstractSort.type
+   */
   type: 'distance';
 }
 

src/protocol/search/sorts/ducet.ts

@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2018 StApps
+ * Copyright (C) 2019 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.
@@ -12,11 +12,14 @@
  * 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 {SCSearchAbstractSort, SCSearchAbstractSortArguments} from './Abstract';
+import {SCSearchAbstractSort, SCSearchAbstractSortArguments} from '../sort';
 
 /**
  * Sort instruction for ducet sort
  */
 export interface SCDucetSort extends SCSearchAbstractSort<SCSearchAbstractSortArguments> {
+  /**
+   * @see SCSearchAbstractSort.type
+   */
   type: 'ducet';
 }

src/protocol/search/sorts/price.ts

@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2018 StApps
+ * Copyright (C) 2019 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.
@@ -12,13 +12,16 @@
  * 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 {SCSportCoursePriceGroup} from '../../things/DateSeries';
-import {SCSearchAbstractSort, SCSearchAbstractSortArguments} from './Abstract';
+import {SCSportCoursePriceGroup} from '../../../things/date-series';
+import {SCSearchAbstractSort, SCSearchAbstractSortArguments} from '../sort';
 
 /**
  * Sort instruction to sort by price
  */
 export interface SCPriceSort extends SCSearchAbstractSort<SCPriceSortArguments> {
+  /**
+   * @see SCSearchAbstractSort.type
+   */
   type: 'price';
 }
 

src/things/abstract/academic-degree.ts

@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2018, 2019 StApps
+ * Copyright (C) 2019 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.
@@ -12,8 +12,8 @@
  * 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 {SCThing, SCThingMeta, SCThingWithoutReferences} from '../Thing';
-import {SCMetaTranslations} from '../types/i18n';
+import {SCMetaTranslations} from '../../general/i18n';
+import {SCThing, SCThingMeta, SCThingWithoutReferences} from './thing';
 
 /**
  * An academic degree without references
@@ -28,12 +28,16 @@ export interface SCAcademicDegreeWithoutReferences
   /**
    * The achievable academic degree with academic field specification
    * (eg. Master of Science)
+   *
+   * @keyword
    */
   academicDegreewithField: string;
 
   /**
    * The achievable academic degree with academic field specification
    * shorted (eg. M.Sc.).
+   *
+   * @keyword
    */
   academicDegreewithFieldShort: string;
 }
@@ -50,20 +54,22 @@ export interface SCAcademicDegree
  * Meta information about academic degrees
  */
 export class SCAcademicDegreeMeta
-  extends SCThingMeta
-  implements SCMetaTranslations<SCAcademicDegree> {
+  extends SCThingMeta implements SCMetaTranslations<SCAcademicDegree> {
   /**
    * Translations of fields
    */
   fieldTranslations = {
     de: {
-      ...SCThingMeta.getInstance().fieldTranslations.de,
+      ...SCThingMeta.getInstance<SCThingMeta>().fieldTranslations.de,
       academicDegree: 'Hochschulgrad',
       academicDegreewithField: 'Abschlussbezeichnungen',
       academicDegreewithFieldShort: 'Abschlussbezeichnungen (kurz)',
     },
     en: {
-      ...SCThingMeta.getInstance().fieldTranslations.en,
+      ...SCThingMeta.getInstance<SCThingMeta>().fieldTranslations.en,
+      academicDegree: 'academic degree',
+      academicDegreewithField: 'acedemic degree and discipline',
+      academicDegreewithFieldShort: 'acedemic degree and discipline (short)',
     },
   };
 
@@ -72,7 +78,7 @@ export class SCAcademicDegreeMeta
    */
   fieldValueTranslations = {
     de: {
-      ...SCThingMeta.getInstance().fieldValueTranslations.de,
+      ...SCThingMeta.getInstance<SCThingMeta>().fieldValueTranslations.de,
       academicDegree: {
         'bachelor': 'Bachelor',
         'diploma': 'Diplom',
@@ -85,7 +91,7 @@ export class SCAcademicDegreeMeta
       },
     },
     en: {
-      ...SCThingMeta.getInstance().fieldValueTranslations.en,
+      ...SCThingMeta.getInstance<SCThingMeta>().fieldValueTranslations.en,
     },
   };
 }

src/things/abstract/academic-term.ts

@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2018, 2019 StApps
+ * Copyright (C) 2019 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.
@@ -12,9 +12,9 @@
  * 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 {SCThing, SCThingMeta, SCThingWithoutReferences} from '../Thing';
-import {SCMetaTranslations} from '../types/i18n';
-import {SCISO8601Date} from '../types/Time';
+import {SCMetaTranslations} from '../../general/i18n';
+import {SCISO8601Date} from '../../general/time';
+import {SCThing, SCThingMeta, SCThingWithoutReferences} from './thing';
 
 /**
  * An academic term without references
@@ -23,6 +23,10 @@ export interface SCAcademicTermWithoutReferences
   extends SCThingWithoutReferences {
   /**
    * Short name of the academic term, using the given pattern
+   *
+   * @aggregatable
+   * @filterable
+   * @keyword
    */
   acronym: string;
 
@@ -65,10 +69,20 @@ export class SCAcademicTermWithoutReferencesMeta
    */
   fieldTranslations = {
     de: {
-      ...SCThingMeta.getInstance().fieldTranslations.de,
+      ...SCThingMeta.getInstance<SCThingMeta>().fieldTranslations.de,
+      acronym: 'Akronym',
+      endDate: 'Enddatum',
+      eventsEndDate: 'Enddatum der Veranstaltungen',
+      eventsStartDate: 'Startdatum der Veranstaltungen',
+      startDate: 'Startdatum',
     },
     en: {
-      ...SCThingMeta.getInstance().fieldTranslations.en,
+      ...SCThingMeta.getInstance<SCThingMeta>().fieldTranslations.en,
+      acronym: 'acronym',
+      endDate: 'end date',
+      eventsEndDate: 'end date of events',
+      eventsStartDate: 'start date of events',
+      startDate: 'start date',
     },
   };
 
@@ -77,10 +91,10 @@ export class SCAcademicTermWithoutReferencesMeta
    */
   fieldValueTranslations = {
     de: {
-      ...SCThingMeta.getInstance().fieldValueTranslations.de,
+      ...SCThingMeta.getInstance<SCThingMeta>().fieldValueTranslations.de,
     },
     en: {
-      ...SCThingMeta.getInstance().fieldValueTranslations.en,
+      ...SCThingMeta.getInstance<SCThingMeta>().fieldValueTranslations.en,
     },
   };
 }

src/things/abstract/creative-work.ts

@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2018, 2019 StApps
+ * Copyright (C) 2019 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.
@@ -12,17 +12,18 @@
  * 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 {SCThingMeta, SCThingTranslatableProperties, SCThingWithoutReferences} from '../Thing';
-import {SCOrganizationWithoutReferences} from '../things/Organization';
-import {SCPersonWithoutReferences} from '../things/Person';
-import {SCLanguage, SCMetaTranslations, SCTranslations} from '../types/i18n';
-import {SCISO8601Date} from '../types/Time';
+import {SCLanguage, SCMetaTranslations, SCTranslations} from '../../general/i18n';
+import {SCISO8601Date} from '../../general/time';
+import {SCOrganizationWithoutReferences} from '../organization';
+import {SCPersonWithoutReferences} from '../person';
+import {SCThingMeta, SCThingTranslatableProperties, SCThingWithoutReferences} from './thing';
 import {
   SCAcademicPriceGroup,
   SCThingThatCanBeOffered,
+  SCThingThatCanBeOfferedMeta,
   SCThingThatCanBeOfferedTranslatableProperties,
   SCThingThatCanBeOfferedWithoutReferences,
-} from './ThingThatCanBeOffered';
+} from './thing-that-can-be-offered';
 
 /**
  * A creative work without references
@@ -41,6 +42,10 @@ export interface SCCreativeWorkWithoutReferences
 
   /**
    * Keywords of the creative work
+   *
+   * @aggregatable
+   * @filterable
+   * @keyword
    */
   keywords?: string[];
 
@@ -78,6 +83,8 @@ export interface SCCreativeWorkTranslatableProperties
   extends SCThingTranslatableProperties, SCThingThatCanBeOfferedTranslatableProperties {
   /**
    * Translation of the keywords of the creative work
+   *
+   * @keyword
    */
   keywords?: string[];
 }
@@ -92,10 +99,22 @@ export class SCCreativeWorkMeta
    */
   fieldTranslations = {
     de: {
-      ...SCThingMeta.getInstance().fieldTranslations.de,
+      ...SCThingMeta.getInstance<SCThingMeta>().fieldTranslations.de,
+      ...SCThingThatCanBeOfferedMeta.getInstance().fieldTranslations.de,
+      authors: 'Authoren',
+      datePublished: 'Veröffentlichungsdatum',
+      inLanguages: 'verfügbare Übersetzungen',
+      keywords: 'Schlagwörter',
+      publishers: 'Verleger',
     },
     en: {
-      ...SCThingMeta.getInstance().fieldTranslations.en,
+      ...SCThingMeta.getInstance<SCThingMeta>().fieldTranslations.en,
+      ...SCThingThatCanBeOfferedMeta.getInstance().fieldTranslations.en,
+      authors: 'authors',
+      datePublished: 'release date',
+      inLanguages: 'available Languages',
+      keywords: 'keywords',
+      publishers: 'publishers',
     },
   };
 
@@ -104,10 +123,12 @@ export class SCCreativeWorkMeta
    */
   fieldValueTranslations = {
     de: {
-      ...SCThingMeta.getInstance().fieldValueTranslations.de,
+      ...SCThingMeta.getInstance<SCThingMeta>().fieldValueTranslations.de,
+      ...SCThingThatCanBeOfferedMeta.getInstance().fieldValueTranslations.en,
     },
     en: {
-      ...SCThingMeta.getInstance().fieldValueTranslations.en,
+      ...SCThingMeta.getInstance<SCThingMeta>().fieldValueTranslations.en,
+      ...SCThingThatCanBeOfferedMeta.getInstance().fieldValueTranslations.en,
     },
   };
 }

src/things/abstract/event.ts

@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2018, 2019 StApps
+ * Copyright (C) 2019 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.
@@ -12,12 +12,12 @@
  * 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 {SCThing, SCThingMeta, SCThingWithoutReferences} from '../Thing';
-import {SCCatalogWithoutReferences} from '../things/Catalog';
-import {SCPersonWithoutReferences} from '../things/Person';
-import {SCSemesterWithoutReferences} from '../things/Semester';
-import {SCMetaTranslations} from '../types/i18n';
-import {SCCreativeWorkWithoutReferences} from './CreativeWork';
+import {SCMetaTranslations} from '../../general/i18n';
+import {SCCatalogWithoutReferences} from '../catalog';
+import {SCPersonWithoutReferences} from '../person';
+import {SCSemesterWithoutReferences} from '../semester';
+import {SCCreativeWorkWithoutReferences} from './creative-work';
+import {SCThing, SCThingMeta, SCThingWithoutReferences} from './thing';
 
 /**
  * An event without references
@@ -28,6 +28,8 @@ export interface SCEventWithoutReferences
    * Maximum number of participants of the event
    *
    * A maximum number of people that can participate in the event.
+   *
+   * @integer
    */
   maximumParticipants?: number;
 
@@ -35,6 +37,8 @@ export interface SCEventWithoutReferences
    * Remaining attendee capacity of the event
    *
    * This number represents the remaining open spots.
+   *
+   * @integer
    */
   remainingAttendeeCapacity?: number;
 }
@@ -82,10 +86,24 @@ export class SCEventMeta
    */
   fieldTranslations = {
     de: {
-      ...SCThingMeta.getInstance().fieldTranslations.de,
+      ...SCThingMeta.getInstance<SCThingMeta>().fieldTranslations.de,
+      academicTerms: 'Semester',
+      catalogs: 'Verzeichnis',
+      creativeWorks: 'begleitende Werke',
+      maximumParticipants: 'maximale Anzahl an Teilnehmern',
+      organizers: 'Origanisatoren',
+      performers: 'Vortragende',
+      remainingAttendeeCapacity: 'verfügbare Anzahl an Teilnehmern',
     },
     en: {
-      ...SCThingMeta.getInstance().fieldTranslations.en,
+      ...SCThingMeta.getInstance<SCThingMeta>().fieldTranslations.en,
+      academicTerms: 'academic terms',
+      catalogs: 'catalogs',
+      creativeWorks: 'related material',
+      maximumParticipants: 'maximum participants',
+      organizers: 'organizers',
+      performers: 'performers',
+      remainingAttendeeCapacity: 'remaining attendee capacity',
     },
   };
 
@@ -94,10 +112,10 @@ export class SCEventMeta
    */
   fieldValueTranslations = {
     de: {
-      ...SCThingMeta.getInstance().fieldValueTranslations.de,
+      ...SCThingMeta.getInstance<SCThingMeta>().fieldValueTranslations.de,
     },
     en: {
-      ...SCThingMeta.getInstance().fieldValueTranslations.en,
+      ...SCThingMeta.getInstance<SCThingMeta>().fieldValueTranslations.en,
     },
   };
 }

src/things/abstract/place.ts

@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2018, 2019 StApps
+ * Copyright (C) 2019 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.
@@ -12,10 +12,62 @@
  * 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 {SCThing, SCThingMeta, SCThingTranslatableProperties, SCThingWithoutReferences} from '../Thing';
-import {SCGeoInformation} from '../types/GeoInformation';
-import {SCMetaTranslations, SCTranslations} from '../types/i18n';
-import {SCPostalAddress} from '../types/PostalAddress';
+// tslint:disable-next-line:no-implicit-dependencies
+import {Point, Polygon} from 'geojson';
+import {SCMetaTranslations, SCTranslations} from '../../general/i18n';
+import {SCBuildingWithoutReferences} from '../building';
+import {SCPointOfInterestWithoutReferences} from '../point-of-interest';
+import {SCRoomWithoutReferences} from '../room';
+import {SCThing, SCThingMeta, SCThingTranslatableProperties, SCThingWithoutReferences} from './thing';
+
+/**
+ * Positional information
+ */
+export interface SCGeoInformation {
+  /**
+   * Center point of a place
+   */
+  point: Point;
+  /**
+   * Shape of a place
+   */
+  polygon?: Polygon;
+}
+
+/**
+ * A postal address
+ */
+export interface SCPostalAddress {
+  /**
+   * Country of the address
+   */
+  addressCountry: string;
+
+  /**
+   * City of the address
+   */
+  addressLocality: string;
+
+  /**
+   * State of the address
+   */
+  addressRegion?: string;
+
+  /**
+   * Zip code of the address
+   */
+  postalCode: string;
+
+  /**
+   * Optional post box number
+   */
+  postOfficeBoxNumber?: string;
+
+  /**
+   * Street of the address - with house number!
+   */
+  streetAddress: string;
+}
 
 /**
  * A place without references
@@ -37,7 +89,9 @@ export interface SCPlaceWithoutReferences
 
   /**
    * Opening hours of the place
+   *
    * @see http://wiki.openstreetmap.org/wiki/Key:opening_hours/specification
+   * @keyword
    */
   openingHours?: string;
 
@@ -63,6 +117,9 @@ export interface SCPlace
  */
 export interface SCPlaceWithoutReferencesTranslatableProperties
   extends SCThingTranslatableProperties {
+  /**
+   * Address of a place
+   */
   address?: SCPostalAddress;
 }
 
@@ -76,10 +133,16 @@ export class SCPlaceWithoutReferencesMeta
    */
   fieldTranslations = {
     de: {
-      ...SCThingMeta.getInstance().fieldTranslations.de,
+      ...SCThingMeta.getInstance<SCThingMeta>().fieldTranslations.de,
+      address: 'Adresse',
+      geo: 'Geoinformation',
+      openingHours: 'Öffnungszeiten',
     },
     en: {
-      ...SCThingMeta.getInstance().fieldTranslations.en,
+      ...SCThingMeta.getInstance<SCThingMeta>().fieldTranslations.en,
+      address: 'address',
+      geo: 'geographic information',
+      openingHours: 'opening hours',
     },
   };
 
@@ -88,10 +151,26 @@ export class SCPlaceWithoutReferencesMeta
    */
   fieldValueTranslations = {
     de: {
-      ...SCThingMeta.getInstance().fieldValueTranslations.de,
+      ...SCThingMeta.getInstance<SCThingMeta>().fieldValueTranslations.de,
     },
     en: {
-      ...SCThingMeta.getInstance().fieldValueTranslations.en,
+      ...SCThingMeta.getInstance<SCThingMeta>().fieldValueTranslations.en,
     },
   };
 }
+
+/**
+ * Something that is or happens in a place
+ *
+ * !Important!
+ * This is not a SCThing.
+ */
+export interface SCInPlace {
+  /**
+   * Place the thing is or happens in
+   */
+  inPlace?:
+    SCBuildingWithoutReferences
+    | SCPointOfInterestWithoutReferences
+    | SCRoomWithoutReferences;
+}

src/things/abstract/saveable-thing.ts

@@ -12,7 +12,7 @@
  * 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 {SCThing, SCThingUserOrigin, SCThingWithoutReferences} from '../Thing';
+import {SCThing, SCThingUserOrigin, SCThingWithoutReferences} from './thing';
 
 /**
  * An encapsulation of the data (e.g. a thing) that is saved, which provides additional information.

src/things/abstract/thing-in-place.ts

@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2018-2019 StApps
+ * Copyright (C) 2019 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.
@@ -12,9 +12,9 @@
  * 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 {SCThing, SCThingMeta} from '../Thing';
-import {SCMetaTranslations} from '../types/i18n';
-import {SCInPlace} from '../types/Places';
+import {SCMetaTranslations} from '../../general/i18n';
+import {SCInPlace} from './place';
+import {SCThing, SCThingMeta} from './thing';
 
 /**
  * A thing that is or happens in a place
@@ -34,11 +34,11 @@ export class SCThingInPlaceMeta
    */
   fieldTranslations = {
     de: {
-      ...SCThingMeta.getInstance().fieldTranslations.de,
+      ...SCThingMeta.getInstance<SCThingMeta>().fieldTranslations.de,
       inPlace: 'Ort',
     },
     en: {
-      ...SCThingMeta.getInstance().fieldTranslations.en,
+      ...SCThingMeta.getInstance<SCThingMeta>().fieldTranslations.en,
       inPlace: 'location',
     },
   };
@@ -48,10 +48,10 @@ export class SCThingInPlaceMeta
    */
   fieldValueTranslations = {
     de: {
-      ...SCThingMeta.getInstance().fieldValueTranslations.de,
+      ...SCThingMeta.getInstance<SCThingMeta>().fieldValueTranslations.de,
     },
     en: {
-      ...SCThingMeta.getInstance().fieldValueTranslations.en,
+      ...SCThingMeta.getInstance<SCThingMeta>().fieldValueTranslations.en,
     },
   };
 }

src/things/abstract/thing-that-accepts-payments.ts

@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2018, 2019 StApps
+ * Copyright (C) 2019 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.
@@ -12,16 +12,16 @@
  * 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 {SCThing, SCThingMeta, SCThingWithoutReferences} from '../Thing';
-import {SCMetaTranslations} from '../types/i18n';
+import {SCMetaTranslations} from '../../general/i18n';
+import {SCThing, SCThingMeta, SCThingWithoutReferences} from './thing';
 
 /**
  * Types of payment that are accepted at a place.
  */
 export type SCThingThatAcceptsPaymentsAcceptedPayments =
-  'Cash'
-  | 'Credit'
-  | 'Cafeteria Card';
+  'cash'
+  | 'credit'
+  | 'cafeteria card';
 
 /**
  * A thing without references that accepts payments
@@ -52,10 +52,12 @@ export class SCThingThatAcceptsPaymentsWithoutReferencesMeta
    */
   fieldTranslations = {
     de: {
-      ...SCThingMeta.getInstance().fieldTranslations.de,
+      ...SCThingMeta.getInstance<SCThingMeta>().fieldTranslations.de,
+      paymentsAccepted: 'Bezahlmethoden',
     },
     en: {
-      ...SCThingMeta.getInstance().fieldTranslations.en,
+      ...SCThingMeta.getInstance<SCThingMeta>().fieldTranslations.en,
+      paymentsAccepted: 'accepted payment methods',
     },
   };
 
@@ -64,10 +66,15 @@ export class SCThingThatAcceptsPaymentsWithoutReferencesMeta
    */
   fieldValueTranslations = {
     de: {
-      ...SCThingMeta.getInstance().fieldValueTranslations.de,
+      ...SCThingMeta.getInstance<SCThingMeta>().fieldValueTranslations.de,
+      paymentsAccepted: {
+        'cafeteria card': 'Mensakarte',
+        'cash': 'Bar',
+        'credit': 'Kreditkarte',
+      },
     },
     en: {
-      ...SCThingMeta.getInstance().fieldValueTranslations.en,
+      ...SCThingMeta.getInstance<SCThingMeta>().fieldValueTranslations.en,
     },
   };
 }

src/things/abstract/thing-that-can-be-offered.ts

@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2018, 2019 StApps
+ * Copyright (C) 2019 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.
@@ -12,12 +12,12 @@
  * 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 {SCThing, SCThingTranslatableProperties, SCThingWithoutReferences} from '../Thing';
-import {SCOrganizationWithoutReferences} from '../things/Organization';
-import {SCPersonWithoutReferences} from '../things/Person';
-import {SCTranslations} from '../types/i18n';
-import {SCInPlace} from '../types/Places';
-import {SCISO8601Date} from '../types/Time';
+import {SCMetaTranslations, SCTranslations} from '../../general/i18n';
+import {SCISO8601Date} from '../../general/time';
+import {SCOrganizationWithoutReferences} from '../organization';
+import {SCPersonWithoutReferences} from '../person';
+import {SCInPlace} from './place';
+import {SCThing, SCThingMeta, SCThingTranslatableProperties, SCThingWithoutReferences} from './thing';
 
 /**
  * Default price without distinction
@@ -25,6 +25,9 @@ import {SCISO8601Date} from '../types/Time';
 export interface SCPriceGroup {
   /**
    * Default price of the thing
+   *
+   * @sortable price
+   * @float
    */
   default: number;
 }
@@ -36,16 +39,25 @@ export interface SCAcademicPriceGroup
   extends SCPriceGroup {
   /**
    * Price for employees
+   *
+   * @sortable price
+   * @float
    */
   employee?: number;
 
   /**
    * Price for guests
+   *
+   * @sortable price
+   * @float
    */
   guest?: number;
 
   /**
    * Price for students
+   *
+   * @sortable price
+   * @float
    */
   student?: number;
 }
@@ -115,6 +127,8 @@ export interface SCThingThatCanBeOfferedTranslatableProperties
   extends SCThingTranslatableProperties {
   /**
    * Availability of an offer
+   *
+   * @keyword
    */
   'offers[].availability'?: string;
 }
@@ -134,3 +148,57 @@ export type SCThingThatCanBeOfferedAvailability =
   | 'out of stock'
   | 'online only'
   | 'limited availability';
+
+/**
+ * Meta information about a thing without references that accepts payments
+ */
+export class SCThingThatCanBeOfferedMeta<T extends SCPriceGroup>
+  implements SCMetaTranslations<SCThingThatCanBeOffered<T>> {
+
+  /**
+   * Instance
+   */
+  protected static _instance = new Map<string, unknown>();
+
+  /**
+   * Translations of fields
+   */
+  fieldTranslations = {
+    de: {
+      ...SCThingMeta.getInstance().fieldTranslations.de,
+      offers: 'Angebote',
+    },
+    en: {
+      ...SCThingMeta.getInstance().fieldTranslations.en,
+      offers: 'offers',
+    },
+  };
+
+  /**
+   * Translations of values of fields
+   */
+  fieldValueTranslations = {
+    de: {
+      ...SCThingMeta.getInstance<SCThingMeta>().fieldValueTranslations.de,
+    },
+    en: {
+      ...SCThingMeta.getInstance<SCThingMeta>().fieldValueTranslations.en,
+    },
+  };
+
+  // tslint:disable:static-this
+  /**
+   * Function to retrieve typed singleton instance (including generics)
+   */
+  public static getInstance<T extends SCPriceGroup>(): SCThingThatCanBeOfferedMeta<T> {
+    if (!SCThingThatCanBeOfferedMeta._instance.has(this.name)) {
+      SCThingThatCanBeOfferedMeta._instance.set(this.name, new SCThingThatCanBeOfferedMeta<T>());
+    }
+
+    return SCThingThatCanBeOfferedMeta._instance
+      .get(this.name) as SCThingThatCanBeOfferedMeta<T>;
+  }
+
+  protected constructor() {
+  }
+}

src/things/abstract/thing-with-categories.ts

@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2018, 2019 StApps
+ * Copyright (C) 2019 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.
@@ -12,20 +12,24 @@
  * 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 {SCThing, SCThingMeta, SCThingTranslatableProperties, SCThingWithoutReferences} from '../Thing';
-import {SCMetaTranslations, SCTranslations} from '../types/i18n';
-import {SCMap} from '../types/Map';
+import {SCMetaTranslations, SCTranslations} from '../../general/i18n';
+import {SCMap} from '../../general/map';
+import {SCThing, SCThingMeta, SCThingTranslatableProperties, SCThingWithoutReferences} from './thing';
 
 /**
  * A thing without references with categories
  *
  * !!! BEWARE !!!
- * `T` should be a union type - e.g. `T = 'foo' | 'bar' | 'foobar';`
+ * `T` should be a string literal union type - e.g. `T = 'foo' | 'bar' | 'foobar';`
  */
 export interface SCThingWithCategoriesWithoutReferences<T, U extends SCThingWithCategoriesSpecificValues>
   extends SCThingWithoutReferences {
   /**
    * Categories of a thing with categories
+   *
+   * @sortable ducet
+   * @aggregatable
+   * @filterable
    */
   categories: T[];
 
@@ -72,47 +76,65 @@ export interface SCThingWithCategoriesTranslatableProperties
 export interface SCThingWithCategoriesSpecificValues {
   /**
    * Category specific alternate names of a thing
+   *
+   * @keyword
    */
   alternateNames?: string[];
 
   /**
    * Category specific description of a thing
+   *
+   * @text
    */
   description?: string;
 
   /**
    * URL of a category specific image of a thing
+   *
+   * @keyword
    */
   image?: string;
 
   /**
    * Category specific name of a thing
+   *
+   * @text
    */
   name?: string;
 
   /**
    * Category specific URL of a thing
+   *
+   * @keyword
    */
   url?: string;
 }
 
 /**
  * Meta information about a thing without references that accepts payments
+ * It intentionally does not extend the SCThingMeta implementation to be able to include generics.
  */
 export class SCThingWithCategoriesWithoutReferencesMeta<T, U>
   implements SCMetaTranslations<SCThingWithCategoriesWithoutReferences<T, U>> {
 
-  protected static _instance: SCThingMeta;
+  /**
+   * Instance
+   */
+  protected static _instance = new Map<string, unknown>();
 
   /**
    * Translations of fields
    */
   fieldTranslations = {
     de: {
-      ...SCThingMeta.getInstance().fieldTranslations.de,
+      ...SCThingMeta.getInstance<SCThingMeta>().fieldTranslations.de,
+      categories: 'Kategorien',
+      categorySpecificValues: 'besondere Kategorien',
     },
     en: {
-      ...SCThingMeta.getInstance().fieldTranslations.en,
+      ...SCThingMeta.getInstance<SCThingMeta>().fieldTranslations.en,
+      categories: 'categories',
+      categorySpecificValues: 'category with specific values',
     },
   };
 
@@ -121,18 +143,25 @@ export class SCThingWithCategoriesWithoutReferencesMeta<T, U>
    */
   fieldValueTranslations = {
     de: {
-      ...SCThingMeta.getInstance().fieldValueTranslations.de,
+      ...SCThingMeta.getInstance<SCThingMeta>().fieldValueTranslations.de,
     },
     en: {
-      ...SCThingMeta.getInstance().fieldValueTranslations.en,
+      ...SCThingMeta.getInstance<SCThingMeta>().fieldValueTranslations.en,
     },
   };
 
+  // tslint:disable:static-this
   /**
    * Function to retrieve typed singleton instance (including generics)
    */
   public static getInstance<T, U>(): SCThingWithCategoriesWithoutReferencesMeta<T, U> {
-    return this._instance || (this._instance = new this<T, U>());
+    if (!SCThingWithCategoriesWithoutReferencesMeta._instance.has(this.name)) {
+      SCThingWithCategoriesWithoutReferencesMeta._instance
+        .set(this.name, new SCThingWithCategoriesWithoutReferencesMeta<T, U>());
+    }
+
+    return SCThingWithCategoriesWithoutReferencesMeta._instance
+      .get(this.name) as SCThingWithCategoriesWithoutReferencesMeta<T, U>;
   }
 
   protected constructor() {

src/things/abstract/thing.ts

@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2018, 2019 StApps
+ * Copyright (C) 2019 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.
@@ -12,11 +12,11 @@
  * 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 {SCOrganizationWithoutReferences} from './things/Organization';
-import {SCPersonWithoutReferences} from './things/Person';
-import {SCMetaTranslations, SCTranslations} from './types/i18n';
-import {SCISO8601Date} from './types/Time';
-import {SCUuid} from './types/UUID';
+import {SCMetaTranslations, SCTranslations} from '../../general/i18n';
+import {SCISO8601Date} from '../../general/time';
+import {SCUuid} from '../../general/uuid';
+import {SCOrganizationWithoutReferences} from '../organization';
+import {SCPersonWithoutReferences} from '../person';
 
 /**
  * Types a thing can be
@@ -54,22 +54,29 @@ export enum SCThingType {
 export interface SCThingWithoutReferences {
   /**
    * Alternate names of the thing
+   *
+   * @keyword
    */
   alternateNames?: string[];
   /**
    * Description of the thing
    *
    * @minLength 1
+   * @text
    */
   description?: string;
   /**
    * URL of an image of the thing
+   *
+   * @keyword
    */
   image?: string;
   /**
    * Name of the thing
    *
    * @minLength 1
+   * @sortable ducet
+   * @text
    */
   name: string;
   /**
@@ -80,6 +87,10 @@ export interface SCThingWithoutReferences {
   translations?: SCTranslations<SCThingTranslatableProperties>;
   /**
    * Type of the thing
+   *
+   * @sortable ducet
+   * @filterable
+   * @aggregatable
    */
   type: SCThingType;
   /**
@@ -143,6 +154,8 @@ export interface SCThingRemoteOrigin extends SCThingOrigin {
 
   /**
    * Name of the origin
+   *
+   * @text
    */
   name: string;
 
@@ -200,10 +213,14 @@ export interface SCThingUserOrigin extends SCThingOrigin {
 export interface SCThingTranslatableProperties {
   /**
    * Translation of the description of the thing
+   *
+   * @text
    */
   description?: string;
   /**
    * Translation of the name of the thing
+   *
+   * @text
    */
   name?: string;
   /**
@@ -218,6 +235,8 @@ export interface SCThingTranslatableProperties {
 export interface SCThingTranslatablePropertyOrigin {
   /**
    * Translation of the name of the origin
+   *
+   * @text
    */
   name: string;
 }
@@ -271,14 +290,16 @@ export class SCThingMeta implements SCMetaTranslations<SCThing> {
     },
   };
 
+  // tslint:disable:static-this
   /**
    * Function to retrieve typed singleton instance
    */
   public static getInstance<T extends SCThingMeta>(): T {
-    if (!this._instance.has(this.name)) {
-      this._instance.set(this.name, new this());
+    if (!SCThingMeta._instance.has(this.name)) {
+      SCThingMeta._instance.set(this.name, new this());
     }
-    return this._instance.get(this.name) as T;
+
+    return SCThingMeta._instance.get(this.name) as T;
   }
 
   protected constructor() {

src/things/academic-event.ts

@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2018, 2019 StApps
+ * Copyright (C) 2019 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.
@@ -12,16 +12,16 @@
  * 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 {SCEvent, SCEventMeta, SCEventWithoutReferences} from '../base/Event';
+import {SCMetaTranslations, SCTranslations} from '../general/i18n';
+import {SCEvent, SCEventMeta, SCEventWithoutReferences} from './abstract/event';
+import {SCThingMeta, SCThingType} from './abstract/thing';
 import {
   SCThingWithCategories,
   SCThingWithCategoriesSpecificValues,
   SCThingWithCategoriesTranslatableProperties,
   SCThingWithCategoriesWithoutReferences,
   SCThingWithCategoriesWithoutReferencesMeta,
-} from '../base/ThingWithCategories';
-import {SCThingMeta, SCThingType} from '../Thing';
-import {SCMetaTranslations, SCTranslations} from '../types/i18n';
+} from './abstract/thing-with-categories';
 
 /**
  * An academic event without references
@@ -31,11 +31,17 @@ export interface SCAcademicEventWithoutReferences
     SCThingWithCategoriesWithoutReferences<SCAcademicEventCategories, SCThingWithCategoriesSpecificValues> {
   /**
    * Majors of the academic event that this event belongs to
+   *
+   * @aggregatable
+   * @filterable
+   * @keyword
    */
   majors?: string[];
 
   /**
    * Original unmapped category from the source of the academic event
+   *
+   * @keyword
    */
   originalCategory?: string;
 
@@ -54,6 +60,7 @@ export interface SCAcademicEventWithoutReferences
  * An academic event
  *
  * @validatable
+ * @indexable
  */
 export interface SCAcademicEvent
   extends SCEvent, SCAcademicEventWithoutReferences,
@@ -77,6 +84,7 @@ export type SCAcademicEventCategories =
   | 'seminar'
   | 'integrated course'
   | 'written exam'
+  | 'oral exam'
   | 'tutorial'
   | 'project'
   | 'colloquium'
@@ -85,6 +93,7 @@ export type SCAcademicEventCategories =
   | 'course'
   | 'practicum introduction'
   | 'excursion'
+  | 'exercise'
   | 'special';
 
 /**
@@ -94,11 +103,15 @@ export interface SCAcademicEventTranslatableProperties
   extends SCThingWithCategoriesTranslatableProperties {
   /**
    * Translations of the majors of the academic event that this event belongs to
+   *
+   * @keyword
    */
   majors?: string[];
 
   /**
    * Translation of the original unmapped category from the source of the academic event
+   *
+   * @keyword
    */
   originalCategory?: string;
 }
@@ -114,14 +127,18 @@ export class SCAcademicEventMeta
    */
   fieldTranslations = {
     de: {
-      ...SCEventMeta.getInstance().fieldTranslations.de,
+      ...SCEventMeta.getInstance<SCEventMeta>().fieldTranslations.de,
       ...SCThingWithCategoriesWithoutReferencesMeta.getInstance<SCAcademicEventCategories,
         SCThingWithCategoriesSpecificValues>().fieldTranslations.de,
+      majors: 'Hauptfächer',
+      originalCategory: 'ursprüngliche Kategorie',
     },
     en: {
-      ...SCEventMeta.getInstance().fieldTranslations.en,
+      ...SCEventMeta.getInstance<SCEventMeta>().fieldTranslations.en,
       ...SCThingWithCategoriesWithoutReferencesMeta.getInstance<SCAcademicEventCategories,
         SCThingWithCategoriesSpecificValues>().fieldTranslations.en,
+      majors: 'majors',
+      originalCategory: 'original category',
     },
   };
 
@@ -130,13 +147,30 @@ export class SCAcademicEventMeta
    */
   fieldValueTranslations = {
     de: {
-      ...SCEventMeta.getInstance().fieldValueTranslations.de,
+      ...SCEventMeta.getInstance<SCEventMeta>().fieldValueTranslations.de,
       ...SCThingWithCategoriesWithoutReferencesMeta.getInstance<SCAcademicEventCategories,
         SCThingWithCategoriesSpecificValues>().fieldValueTranslations.de,
+      categories: {
+        'colloquium': 'Kolloquium',
+        'course': 'Kurs',
+        'excursion': 'Exkursion',
+        'exercise': 'Übung',
+        'integrated course': 'Integrierter Kurs',
+        'introductory class': 'Einführungsveranstaltung',
+        'lecture': 'Vorlesung',
+        'oral exam': 'mündliche Prüfung',
+        'practicum': 'Praktikum',
+        'practicum introduction': 'Einführungspraktikum',
+        'project': 'Projekt',
+        'seminar': 'Seminar',
+        'special': 'Sonderveranstalltung',
+        'tutorial': 'Tutorium',
+        'written exam': 'Schriftilche Prüfung',
+      },
       type: 'akademische Veranstaltung',
     },
     en: {
-      ...SCEventMeta.getInstance().fieldValueTranslations.en,
+      ...SCEventMeta.getInstance<SCEventMeta>().fieldValueTranslations.en,
       ...SCThingWithCategoriesWithoutReferencesMeta.getInstance<SCAcademicEventCategories,
         SCThingWithCategoriesSpecificValues>().fieldValueTranslations.en,
       type: SCThingType.AcademicEvent,

src/things/article.ts

@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2018, 2019 StApps
+ * Copyright (C) 2019 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.
@@ -12,21 +12,21 @@
  * 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 {SCMetaTranslations, SCTranslations} from '../general/i18n';
 import {
   SCCreativeWork,
   SCCreativeWorkMeta,
   SCCreativeWorkTranslatableProperties,
   SCCreativeWorkWithoutReferences,
-} from '../base/CreativeWork';
+} from './abstract/creative-work';
+import {SCThingMeta, SCThingType} from './abstract/thing';
 import {
   SCThingWithCategories,
   SCThingWithCategoriesSpecificValues,
   SCThingWithCategoriesTranslatableProperties,
   SCThingWithCategoriesWithoutReferences,
   SCThingWithCategoriesWithoutReferencesMeta,
-} from '../base/ThingWithCategories';
-import {SCThingMeta, SCThingType} from '../Thing';
-import {SCMetaTranslations, SCTranslations} from '../types/i18n';
+} from './abstract/thing-with-categories';
 
 /**
  * An article without references
@@ -36,6 +36,8 @@ export interface SCArticleWithoutReferences
     SCThingWithCategoriesWithoutReferences<SCArticleCategories, SCThingWithCategoriesSpecificValues> {
   /**
    * Article itself as markdown
+   *
+   * @text
    */
   articleBody: string;
 
@@ -54,6 +56,7 @@ export interface SCArticleWithoutReferences
  * An article
  *
  * @validatable
+ * @indexable
  */
 export interface SCArticle
   extends SCCreativeWork, SCArticleWithoutReferences,
@@ -81,6 +84,8 @@ export interface SCArticleTranslatableProperties
   extends SCThingWithCategoriesTranslatableProperties, SCCreativeWorkTranslatableProperties {
   /**
    * Translation of the article itself as markdown
+   *
+   * @text
    */
   articleBody?: string[];
 }
@@ -95,14 +100,18 @@ export class SCArticleMeta
    */
   fieldTranslations = {
     de: {
-      ...SCCreativeWorkMeta.getInstance().fieldTranslations.de,
+      ...SCCreativeWorkMeta.getInstance<SCCreativeWorkMeta>().fieldTranslations
+        .de,
       ...SCThingWithCategoriesWithoutReferencesMeta.getInstance<SCArticleCategories,
         SCThingWithCategoriesSpecificValues>().fieldTranslations.de,
+      articleBody: 'Artikelinhalt',
     },
     en: {
-      ...SCCreativeWorkMeta.getInstance().fieldTranslations.en,
+      ...SCCreativeWorkMeta.getInstance<SCCreativeWorkMeta>().fieldTranslations
+        .en,
       ...SCThingWithCategoriesWithoutReferencesMeta.getInstance<SCArticleCategories,
         SCThingWithCategoriesSpecificValues>().fieldTranslations.en,
+      articleBody: 'article body',
     },
   };
 
@@ -111,13 +120,18 @@ export class SCArticleMeta
    */
   fieldValueTranslations = {
     de: {
-      ...SCCreativeWorkMeta.getInstance().fieldValueTranslations.de,
+      ...SCCreativeWorkMeta.getInstance<SCCreativeWorkMeta>()
+        .fieldValueTranslations.de,
       ...SCThingWithCategoriesWithoutReferencesMeta.getInstance<SCArticleCategories,
         SCThingWithCategoriesSpecificValues>().fieldValueTranslations.de,
+      categories: {
+        'unipedia': 'Unipedia',
+      },
       type: 'Artikel',
     },
     en: {
-      ...SCCreativeWorkMeta.getInstance().fieldValueTranslations.en,
+      ...SCCreativeWorkMeta.getInstance<SCCreativeWorkMeta>()
+        .fieldValueTranslations.en,
       ...SCThingWithCategoriesWithoutReferencesMeta.getInstance<SCArticleCategories,
         SCThingWithCategoriesSpecificValues>().fieldValueTranslations.en,
       type: SCThingType.Article,

src/things/book.ts

@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2018, 2019 StApps
+ * Copyright (C) 2019 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.
@@ -12,16 +12,16 @@
  * 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 {SCMetaTranslations, SCTranslations} from '../general/i18n';
 import {
   SCCreativeWork,
   SCCreativeWorkMeta,
   SCCreativeWorkTranslatableProperties,
   SCCreativeWorkWithoutReferences,
-} from '../base/CreativeWork';
-import {SCThingWithCategoriesTranslatableProperties} from '../base/ThingWithCategories';
-import {SCThingMeta, SCThingType} from '../Thing';
-import {SCMetaTranslations, SCTranslations} from '../types/i18n';
-import {SCPersonWithoutReferences} from './Person';
+} from './abstract/creative-work';
+import {SCThingMeta, SCThingType} from './abstract/thing';
+import {SCThingWithCategoriesTranslatableProperties} from './abstract/thing-with-categories';
+import {SCPersonWithoutReferences} from './person';
 
 /**
  * A book without references
@@ -30,16 +30,22 @@ export interface SCBookWithoutReferences
   extends SCCreativeWorkWithoutReferences {
   /**
    * Edition of a book
+   *
+   * @keyword
    */
   bookEdition?: string;
 
   /**
    * ISBN of a book
+   *
+   * @keyword
    */
   isbn: string;
 
   /**
    * Number of pages of a book
+   *
+   * @integer
    */
   numberOfPages?: number;
 
@@ -58,6 +64,7 @@ export interface SCBookWithoutReferences
  * A book
  *
  * @validatable
+ * @indexable
  */
 export interface SCBook
   extends SCCreativeWork, SCBookWithoutReferences {
@@ -84,6 +91,8 @@ export interface SCBookTranslatableFields
   extends SCThingWithCategoriesTranslatableProperties, SCCreativeWorkTranslatableProperties {
   /**
    * Translation of an edition of a book
+   *
+   * @keyword
    */
   bookEdition?: string;
 }
@@ -97,10 +106,18 @@ export class SCBookMeta extends SCThingMeta implements SCMetaTranslations<SCBook
    */
   fieldTranslations = {
     de: {
-      ...SCCreativeWorkMeta.getInstance().fieldTranslations.de,
+      ...SCCreativeWorkMeta.getInstance<SCCreativeWorkMeta>().fieldTranslations
+        .de,
+      bookEdition: 'Buchausgabe',
+      isbn: 'ISBN',
+      numberOfPages: 'Seitenzahl',
     },
     en: {
-      ...SCCreativeWorkMeta.getInstance().fieldTranslations.en,
+      ...SCCreativeWorkMeta.getInstance<SCCreativeWorkMeta>().fieldTranslations
+        .en,
+      bookEdition: 'book edition',
+      isbn: 'ISBN',
+      numberOfPages: 'number of pages',
     },
   };
 
@@ -109,11 +126,13 @@ export class SCBookMeta extends SCThingMeta implements SCMetaTranslations<SCBook
    */
   fieldValueTranslations = {
     de: {
-      ...SCCreativeWorkMeta.getInstance().fieldValueTranslations.de,
+      ...SCCreativeWorkMeta.getInstance<SCCreativeWorkMeta>()
+        .fieldValueTranslations.de,
       type: 'Buch',
     },
     en: {
-      ...SCCreativeWorkMeta.getInstance().fieldValueTranslations.en,
+      ...SCCreativeWorkMeta.getInstance<SCCreativeWorkMeta>()
+        .fieldValueTranslations.en,
       type: SCThingType.Book,
     },
   };

src/things/building.ts

@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2018, 2019 StApps
+ * Copyright (C) 2019 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.
@@ -12,21 +12,21 @@
  * 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 {SCMetaTranslations, SCTranslations} from '../general/i18n';
 import {
   SCPlace,
   SCPlaceWithoutReferences,
   SCPlaceWithoutReferencesMeta,
   SCPlaceWithoutReferencesTranslatableProperties,
-} from '../base/Place';
+} from './abstract/place';
+import {SCThingMeta, SCThingType} from './abstract/thing';
 import {
   SCThingWithCategories,
   SCThingWithCategoriesSpecificValues,
   SCThingWithCategoriesTranslatableProperties,
   SCThingWithCategoriesWithoutReferences,
   SCThingWithCategoriesWithoutReferencesMeta,
-} from '../base/ThingWithCategories';
-import {SCThingMeta, SCThingType} from '../Thing';
-import {SCMetaTranslations, SCTranslations} from '../types/i18n';
+} from './abstract/thing-with-categories';
 
 export type SCBuildingCategories =
   'cafe'
@@ -43,11 +43,17 @@ export interface SCBuildingWithoutReferences
     SCPlaceWithoutReferences {
   /**
    * Categories of a building
+   *
+   * @sortable ducet
+   * @aggregatable
+   * @filterable
    */
   categories: SCBuildingCategories[];
 
   /**
    * List of floor names of the place
+   *
+   * @keyword
    */
   floors?: string[];
 
@@ -66,6 +72,7 @@ export interface SCBuildingWithoutReferences
  * A building
  *
  * @validatable
+ * @indexable
  */
 export interface SCBuilding
   extends SCBuildingWithoutReferences, SCPlace,
@@ -83,6 +90,9 @@ export interface SCBuilding
 
 export interface SCBuildingTranslatableProperties
   extends SCPlaceWithoutReferencesTranslatableProperties, SCThingWithCategoriesTranslatableProperties {
+  /**
+   * @see SCBuilding.floors
+   */
   floors?: string[];
 }
 
@@ -99,13 +109,14 @@ export class SCBuildingMeta
     de: {
       ...SCThingWithCategoriesWithoutReferencesMeta.getInstance<SCBuildingCategories,
         SCThingWithCategoriesSpecificValues>().fieldTranslations.de,
-      ...SCPlaceWithoutReferencesMeta.getInstance().fieldTranslations.de,
+      ...SCPlaceWithoutReferencesMeta.getInstance<SCPlaceWithoutReferencesMeta>().fieldTranslations.de,
       floors: 'Etagen',
     },
     en: {
       ...SCThingWithCategoriesWithoutReferencesMeta.getInstance<SCBuildingCategories,
         SCThingWithCategoriesSpecificValues>().fieldTranslations.en,
-      ...SCPlaceWithoutReferencesMeta.getInstance().fieldTranslations.en,
+      ...SCPlaceWithoutReferencesMeta.getInstance<SCPlaceWithoutReferencesMeta>().fieldTranslations.en,
+      floors: 'floors',
     },
   };
 
@@ -116,7 +127,7 @@ export class SCBuildingMeta
     de: {
       ...SCThingWithCategoriesWithoutReferencesMeta.getInstance<SCBuildingCategories,
         SCThingWithCategoriesSpecificValues>().fieldValueTranslations.de,
-      ...SCPlaceWithoutReferencesMeta.getInstance().fieldValueTranslations.de,
+      ...SCPlaceWithoutReferencesMeta.getInstance<SCPlaceWithoutReferencesMeta>().fieldValueTranslations.de,
       categories: {
         'cafe': 'Café',
         'canteen': 'Kantine',
@@ -132,7 +143,7 @@ export class SCBuildingMeta
     en: {
       ...SCThingWithCategoriesWithoutReferencesMeta.getInstance<SCBuildingCategories,
         SCThingWithCategoriesSpecificValues>().fieldValueTranslations.en,
-      ...SCPlaceWithoutReferencesMeta.getInstance().fieldValueTranslations.en,
+      ...SCPlaceWithoutReferencesMeta.getInstance<SCPlaceWithoutReferencesMeta>().fieldValueTranslations.en,
       type: SCThingType.Building,
     },
   };

src/things/catalog.ts

@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2018, 2019 StApps
+ * Copyright (C) 2019 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.
@@ -12,16 +12,16 @@
  * 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 {SCAcademicTermWithoutReferences} from '../base/AcademicTerm';
+import {SCMetaTranslations, SCTranslations} from '../general/i18n';
+import {SCAcademicTermWithoutReferences} from './abstract/academic-term';
+import {SCThing, SCThingMeta, SCThingType} from './abstract/thing';
 import {
   SCThingWithCategories,
   SCThingWithCategoriesSpecificValues,
   SCThingWithCategoriesTranslatableProperties,
   SCThingWithCategoriesWithoutReferences,
   SCThingWithCategoriesWithoutReferencesMeta,
-} from '../base/ThingWithCategories';
-import {SCThing, SCThingMeta, SCThingType} from '../Thing';
-import {SCMetaTranslations, SCTranslations} from '../types/i18n';
+} from './abstract/thing-with-categories';
 
 /**
  * A catalog without references
@@ -32,6 +32,8 @@ export interface SCCatalogWithoutReferences
    * Level of the catalog (0 for 'root catalog', 1 for its subcatalog, 2 for its subcatalog etc.)
    *
    * Needed for keeping order in catalog inheritance array.
+   *
+   * @integer
    */
   level: number;
 
@@ -45,6 +47,7 @@ export interface SCCatalogWithoutReferences
  * A catalog
  *
  * @validatable
+ * @indexable
  */
 export interface SCCatalog
   extends SCCatalogWithoutReferences, SCThing,
@@ -87,10 +90,18 @@ export class SCCatalogMeta
     de: {
       ...SCThingWithCategoriesWithoutReferencesMeta.getInstance<SCCatalogCategories,
         SCThingWithCategoriesSpecificValues>().fieldTranslations.de,
+      academicTerm: 'Semester',
+      level: 'Ebene',
+      superCatalog: 'übergeordnetes Verzeichniss',
+      superCatalogs: 'übergeordnete Verzeichnisse',
     },
     en: {
       ...SCThingWithCategoriesWithoutReferencesMeta.getInstance<SCCatalogCategories,
         SCThingWithCategoriesSpecificValues>().fieldTranslations.en,
+      academicTerm: 'academic term',
+      level: 'level',
+      superCatalog: 'parent catalog',
+      superCatalogs: 'parent catalogs',
     },
   };
 
@@ -101,6 +112,9 @@ export class SCCatalogMeta
     de: {
       ...SCThingWithCategoriesWithoutReferencesMeta.getInstance<SCCatalogCategories,
         SCThingWithCategoriesSpecificValues>().fieldValueTranslations.de,
+      categories: {
+        'university events': 'Universitätsveranstaltung',
+      },
       type: 'Verzeichnis',
     },
     en: {

src/things/course-of-studies.ts

@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2018, 2019 StApps
+ * Copyright (C) 2019 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.
@@ -12,17 +12,18 @@
  * 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 {SCAcademicDegree, SCAcademicDegreeMeta, SCAcademicDegreeWithoutReferences} from '../base/AcademicDegree';
+import {SCLanguage, SCMetaTranslations, SCTranslations} from '../general/i18n';
+import {SCAcademicDegree, SCAcademicDegreeMeta, SCAcademicDegreeWithoutReferences} from './abstract/academic-degree';
+import {SCThingMeta, SCThingType} from './abstract/thing';
 import {
   SCAcademicPriceGroup,
   SCThingThatCanBeOffered,
+  SCThingThatCanBeOfferedMeta,
   SCThingThatCanBeOfferedTranslatableProperties,
   SCThingThatCanBeOfferedWithoutReferences,
-} from '../base/ThingThatCanBeOffered';
-import {SCThingMeta, SCThingType} from '../Thing';
-import {SCLanguage, SCMetaTranslations, SCTranslations} from '../types/i18n';
-import {SCDateSeriesWithoutReferences} from './DateSeries';
-import {SCOrganizationWithoutReferences} from './Organization';
+} from './abstract/thing-that-can-be-offered';
+import {SCDateSeriesWithoutReferences} from './date-series';
+import {SCOrganizationWithoutReferences} from './organization';
 
 /**
  * A course of studies without references
@@ -37,6 +38,8 @@ export interface SCCourseOfStudiesWithoutReferences
 
   /**
    * Actual major of the course of studies (eg. physics)
+   *
+   * @keyword
    */
   major: string;
 
@@ -65,6 +68,7 @@ export interface SCCourseOfStudiesWithoutReferences
  * A course of studies
  *
  * @validatable
+ * @indexable
  */
 export interface SCCourseOfStudies
   extends SCCourseOfStudiesWithoutReferences, SCThingThatCanBeOffered<SCAcademicPriceGroup>, SCAcademicDegree {
@@ -114,10 +118,30 @@ export class SCCourseOfStudiesMeta
    */
   fieldTranslations = {
     de: {
-      ...SCAcademicDegreeMeta.getInstance().fieldTranslations.de,
+      ...SCAcademicDegreeMeta.getInstance<SCAcademicDegreeMeta>()
+        .fieldTranslations.de,
+      ...SCThingThatCanBeOfferedMeta.getInstance<SCAcademicPriceGroup>()
+        .fieldTranslations.de,
+      department: 'Fachbereich',
+      mainLanguage: 'Unterrichtssprache',
+      major: 'Studienfach',
+      mode: 'Studiengangsart',
+      secretary: 'Sekretariat',
+      startDates: 'Startdatum',
+      timeMode: 'Zeitmodell',
     },
     en: {
-      ...SCAcademicDegreeMeta.getInstance().fieldTranslations.en,
+      ...SCAcademicDegreeMeta.getInstance<SCAcademicDegreeMeta>()
+        .fieldTranslations.en,
+      ...SCThingThatCanBeOfferedMeta.getInstance<SCAcademicPriceGroup>()
+        .fieldTranslations.de,
+      department: 'department',
+      mainLanguage: 'main language',
+      major: 'major',
+      mode: 'mode',
+      secretary: 'secretary',
+      startDates: 'start dates',
+      timeMode: 'time mode',
     },
   };
 
@@ -129,7 +153,11 @@ export class SCCourseOfStudiesMeta
       ...SCAcademicDegreeMeta.getInstance().fieldValueTranslations.de,
       modes: {
         combination: 'Kombinationsstudiengang',
-        dual: 'Dualer Studiengang',
+        'double-degree': 'Doppelstudium',
+        dual: 'duales Studium',
+        standard: 'Studium',
+      },
+      timeMode: {
         fulltime: 'Vollzeitstudiengang',
         parttime: 'Teilzeitstudiengang',
       },
@@ -137,11 +165,16 @@ export class SCCourseOfStudiesMeta
     },
     en: {
       ...SCAcademicDegreeMeta.getInstance().fieldValueTranslations.en,
-      academicDegree: 'Hochschulabschluss',
-      department: 'Fachbereich',
-      major: 'Studienfach',
-      modes: 'Studiengangsarten',
-      secretary: 'Sekretariat',
+      modes: {
+        combination: 'combination course of studies',
+        'double-degree': 'double degree course of studies',
+        dual: 'dual course of studies',
+        standard: 'course of studies',
+      },
+      timeMode: {
+        fulltime: 'full-time',
+        parttime: 'part-time',
+      },
       type: SCThingType.CourseOfStudies,
     },
   };

src/things/date-series.ts

@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2018, 2019 StApps
+ * Copyright (C) 2019 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.
@@ -12,19 +12,20 @@
  * 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 {SCThingInPlace, SCThingInPlaceMeta} from '../base/ThingInPlace';
+import {SCMetaTranslations, SCTranslations} from '../general/i18n';
+import {SCISO8601Date, SCISO8601Duration} from '../general/time';
+import {SCThingMeta, SCThingType} from './abstract/thing';
+import {SCThingInPlace, SCThingInPlaceMeta} from './abstract/thing-in-place';
 import {
   SCAcademicPriceGroup,
   SCThingThatCanBeOffered,
+  SCThingThatCanBeOfferedMeta,
   SCThingThatCanBeOfferedTranslatableProperties,
   SCThingThatCanBeOfferedWithoutReferences,
-} from '../base/ThingThatCanBeOffered';
-import {SCThingMeta, SCThingType} from '../Thing';
-import {SCMetaTranslations, SCTranslations} from '../types/i18n';
-import {SCISO8601Date, SCISO8601Duration} from '../types/Time';
-import {SCAcademicEventWithoutReferences} from './AcademicEvent';
-import {SCPersonWithoutReferences} from './Person';
-import {SCSportCourseWithoutReferences} from './SportCourse';
+} from './abstract/thing-that-can-be-offered';
+import {SCAcademicEventWithoutReferences} from './academic-event';
+import {SCPersonWithoutReferences} from './person';
+import {SCSportCourseWithoutReferences} from './sport-course';
 
 /**
  * Price groups for sport courses
@@ -33,6 +34,8 @@ export interface SCSportCoursePriceGroup
   extends SCAcademicPriceGroup {
   /**
    * Price for alumnis
+   *
+   * @float
    */
   alumni?: number;
 }
@@ -59,6 +62,8 @@ export interface SCDateSeriesWithoutReferences
 
   /**
    * Frequency of the date series
+   *
+   * @keyword
    */
   frequency: string;
 
@@ -77,6 +82,7 @@ export interface SCDateSeriesWithoutReferences
  * A date series
  *
  * @validatable
+ * @indexable
  */
 export interface SCDateSeries
   extends SCDateSeriesWithoutReferences,
@@ -115,10 +121,28 @@ export class SCDateSeriesMeta
    */
   fieldTranslations = {
     de: {
-      ...SCThingInPlaceMeta.getInstance().fieldTranslations.de,
+      ...SCThingInPlaceMeta.getInstance<SCThingInPlaceMeta>().fieldTranslations
+        .de,
+      ...SCThingThatCanBeOfferedMeta.getInstance<SCSportCoursePriceGroup>()
+        .fieldTranslations.de,
+      dates: 'Einzeltermine',
+      duration: 'Dauer',
+      event: 'Event',
+      exceptions: 'Ausnahmen',
+      frequency: 'Frequenz',
+      performers: 'Vortragende',
     },
     en: {
-      ...SCThingInPlaceMeta.getInstance().fieldTranslations.en,
+      ...SCThingInPlaceMeta.getInstance<SCThingInPlaceMeta>().fieldTranslations
+        .en,
+      ...SCThingThatCanBeOfferedMeta.getInstance<SCSportCoursePriceGroup>()
+        .fieldTranslations.en,
+      dates: 'dates',
+      duration: 'duration',
+      event: 'event',
+      exceptions: 'exceptions',
+      frequency: 'frequency',
+      performers: 'performers',
     },
   };
 
@@ -127,14 +151,17 @@ export class SCDateSeriesMeta
    */
   fieldValueTranslations = {
     de: {
-      ...SCThingInPlaceMeta.getInstance().fieldValueTranslations.de,
-      dates: 'Einzeltermine',
-      duration: 'Dauer',
-      frequency: 'Wiederholung',
-      type: 'Wiederholungreihe',
+      ...SCThingInPlaceMeta.getInstance<SCThingInPlaceMeta>()
+        .fieldValueTranslations.de,
+      ...SCThingThatCanBeOfferedMeta.getInstance<SCSportCoursePriceGroup>()
+        .fieldValueTranslations.de,
+      type: 'Terminserie',
     },
     en: {
-      ...SCThingInPlaceMeta.getInstance().fieldValueTranslations.en,
+      ...SCThingInPlaceMeta.getInstance<SCThingInPlaceMeta>()
+        .fieldValueTranslations.en,
+      ...SCThingThatCanBeOfferedMeta.getInstance<SCSportCoursePriceGroup>()
+        .fieldValueTranslations.en,
       type: SCThingType.DateSeries,
     },
   };
@@ -145,5 +172,8 @@ export class SCDateSeriesMeta
  */
 export interface SCDateSeriesTranslatableProperties
   extends SCThingThatCanBeOfferedTranslatableProperties {
+  /**
+   * @see SCDateSeriesWithoutReferences.frequency
+   */
   frequency?: string;
 }

src/things/diff.ts

@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2018, 2019 StApps
+ * Copyright (C) 2019 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.
@@ -13,10 +13,10 @@
  * this program. If not, see <https://www.gnu.org/licenses/>.
  */
 import * as jsonpatch from 'json-patch';
-import {SCThingsWithoutDiff} from '../Classes';
-import {SCThing, SCThingMeta, SCThingType, SCThingWithoutReferences} from '../Thing';
-import {SCMetaTranslations} from '../types/i18n';
-import {SCISO8601Date} from '../types/Time';
+import {SCMetaTranslations} from '../general/i18n';
+import {SCISO8601Date} from '../general/time';
+import {SCThingsWithoutDiff} from '../meta';
+import {SCThing, SCThingMeta, SCThingType, SCThingWithoutReferences} from './abstract/thing';
 
 /**
  * A diff without references
@@ -48,6 +48,7 @@ export interface SCDiffWithoutReferences
  * A diff
  *
  * @validatable
+ * @indexable
  */
 export interface SCDiff
   extends SCDiffWithoutReferences, SCThing {
@@ -73,13 +74,18 @@ export class SCDiffMeta
    */
   fieldTranslations = {
     de: {
-      ...SCThingMeta.getInstance().fieldTranslations.de,
+      ...SCThingMeta.getInstance<SCThingMeta>().fieldTranslations.de,
       action: 'Aktion',
       changes: 'Änderungen',
       dateCreated: 'Erstellungsdatum',
+      object: 'Objekt',
     },
     en: {
-      ...SCThingMeta.getInstance().fieldTranslations.en,
+      ...SCThingMeta.getInstance<SCThingMeta>().fieldTranslations.en,
+      action: 'action',
+      changes: 'changes',
+      dateCreated: 'date created',
+      object: 'object',
     },
   };
 
@@ -89,6 +95,10 @@ export class SCDiffMeta
   fieldValueTranslations = {
     de: {
       ...SCThingMeta.getInstance().fieldValueTranslations.de,
+      action: {
+        'changed': 'geändert',
+        'removed': 'gelöscht',
+      },
       type: 'Unterschied',
     },
     en: {

src/things/dish.ts

@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2018, 2019 StApps
+ * Copyright (C) 2019 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.
@@ -12,21 +12,22 @@
  * 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 {SCMetaTranslations, SCTranslations} from '../general/i18n';
+import {SCThingMeta, SCThingType} from './abstract/thing';
 import {
   SCAcademicPriceGroup,
   SCThingThatCanBeOffered,
+  SCThingThatCanBeOfferedMeta,
   SCThingThatCanBeOfferedTranslatableProperties,
   SCThingThatCanBeOfferedWithoutReferences,
-} from '../base/ThingThatCanBeOffered';
+} from './abstract/thing-that-can-be-offered';
 import {
   SCThingWithCategories,
   SCThingWithCategoriesSpecificValues,
   SCThingWithCategoriesTranslatableProperties,
   SCThingWithCategoriesWithoutReferences,
   SCThingWithCategoriesWithoutReferencesMeta,
-} from '../base/ThingWithCategories';
-import {SCThingMeta, SCThingType} from '../Thing';
-import {SCMetaTranslations, SCTranslations} from '../types/i18n';
+} from './abstract/thing-with-categories';
 
 /**
  * A dish without references
@@ -36,11 +37,17 @@ export interface SCDishWithoutReferences
     SCThingWithCategoriesWithoutReferences<SCDishCategories, SCThingWithCategoriesSpecificValues> {
   /**
    * Additives of the dish
+   *
+   * @keyword
    */
   additives?: string[];
 
   /**
    * Category of the dish
+   *
+   * @sortable ducet
+   * @aggregatable
+   * @filterable
    */
   categories: SCDishCategories[];
 
@@ -69,6 +76,7 @@ export interface SCDishWithoutReferences
  * A dish
  *
  * @validatable
+ * @indexable
  */
 export interface SCDish
   extends SCDishWithoutReferences, SCThingThatCanBeOffered<SCAcademicPriceGroup>,
@@ -103,11 +111,15 @@ export interface SCDishTranslatableProperties
 export interface SCDishCharacteristic {
   /**
    * URL of an image of the characteristic
+   *
+   * @keyword
    */
   image?: string;
 
   /**
    * Name of the characteristic
+   *
+   * @text
    */
   name: string;
 }
@@ -131,36 +143,50 @@ export type SCDishCategories =
 export interface SCNutritionInformation {
   /**
    * Number of calories contained (in kcal)
+   *
+   * @float
    */
   calories?: number;
 
   /**
    * Content of carbohydrates (in grams)
+   *
+   * @float
    */
   carbohydrateContent?: number;
 
   /**
    * Content of fat (in grams)
+   *
+   * @float
    */
   fatContent?: number;
 
   /**
    * Content of proteins (in grams)
+   *
+   * @float
    */
   proteinContent?: number;
 
   /**
    * Content of salt (in grams)
+   *
+   * @float
    */
   saltContent?: number;
 
   /**
    * Content of saturated fat (in grams)
+   *
+   * @float
    */
   saturatedFatContent?: number;
 
   /**
    * Content of sugar (in grams)
+   *
+   * @float
    */
   sugarContent?: number;
 }
@@ -178,10 +204,22 @@ export class SCDishMeta
     de: {
       ...SCThingWithCategoriesWithoutReferencesMeta.getInstance<SCDishCategories,
         SCThingWithCategoriesSpecificValues>().fieldTranslations.de,
+      ...SCThingThatCanBeOfferedMeta.getInstance<SCAcademicPriceGroup>()
+        .fieldTranslations.de,
+      additives: 'Zusatzstoffe',
+      characteristics: 'Merkmale',
+      dishAddOns: 'Beilagen',
+      nutrition: 'Nährwertangaben',
     },
     en: {
       ...SCThingWithCategoriesWithoutReferencesMeta.getInstance<SCDishCategories,
         SCThingWithCategoriesSpecificValues>().fieldTranslations.en,
+      ...SCThingThatCanBeOfferedMeta.getInstance<SCAcademicPriceGroup>()
+        .fieldTranslations.en,
+      additives: 'additives',
+      characteristics: 'characteristics',
+      dishAddOns: 'side dishes',
+      nutrition: 'nutrition information',
     },
   };
 
@@ -192,6 +230,8 @@ export class SCDishMeta
     de: {
       ...SCThingWithCategoriesWithoutReferencesMeta.getInstance<SCDishCategories,
         SCThingWithCategoriesSpecificValues>().fieldValueTranslations.de,
+      ...SCThingThatCanBeOfferedMeta.getInstance<SCAcademicPriceGroup>()
+        .fieldValueTranslations.de,
       categories: {
         appetizer: 'Vorspeise',
         dessert: 'Nachtisch',
@@ -205,6 +245,8 @@ export class SCDishMeta
     en: {
       ...SCThingWithCategoriesWithoutReferencesMeta.getInstance<SCDishCategories,
         SCThingWithCategoriesSpecificValues>().fieldValueTranslations.en,
+      ...SCThingThatCanBeOfferedMeta.getInstance<SCAcademicPriceGroup>()
+        .fieldValueTranslations.en,
       type: SCThingType.Dish,
     },
   };

src/things/favorite.ts

@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2018, 2019 StApps
+ * Copyright (C) 2019 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.
@@ -12,17 +12,17 @@
  * 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 {SCSaveableThing, SCSaveableThingWithoutReferences} from '../base/SaveableThing';
-import {SCThingMeta, SCThingType} from '../Thing';
-import {SCAcademicEventWithoutReferences} from './AcademicEvent';
-import {SCArticleWithoutReferences} from './Article';
-import {SCBookWithoutReferences} from './Book';
-import {SCBuildingWithoutReferences} from './Building';
-import {SCPersonWithoutReferences} from './Person';
-import {SCPointOfInterestWithoutReferences} from './PointOfInterest';
-import {SCRoomWithoutReferences} from './Room';
-import {SCSportCourseWithoutReferences} from './SportCourse';
-import {SCToDoWithoutReferences} from './ToDo';
+import {SCSaveableThing, SCSaveableThingWithoutReferences} from './abstract/saveable-thing';
+import {SCThingMeta, SCThingType} from './abstract/thing';
+import {SCAcademicEventWithoutReferences} from './academic-event';
+import {SCArticleWithoutReferences} from './article';
+import {SCBookWithoutReferences} from './book';
+import {SCBuildingWithoutReferences} from './building';
+import {SCPersonWithoutReferences} from './person';
+import {SCPointOfInterestWithoutReferences} from './point-of-interest';
+import {SCRoomWithoutReferences} from './room';
+import {SCSportCourseWithoutReferences} from './sport-course';
+import {SCToDoWithoutReferences} from './todo';
 
 /**
  * Types that can be made a favorite (added as a favorite)
@@ -49,6 +49,7 @@ export interface SCFavoriteWithoutReferences
  * A favorite
  *
  * @validatable
+ * @indexable
  */
 export interface SCFavorite
   extends SCSaveableThing<SCFavoriteDataTypes>, SCFavoriteWithoutReferences {

src/things/floor.ts

@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2018, 2019 StApps
+ * Copyright (C) 2019 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.
@@ -12,12 +12,13 @@
  * You should have received a copy of the GNU General Public License along with
  * this program. If not, see <https://www.gnu.org/licenses/>.
  */
+// tslint:disable-next-line:no-implicit-dependencies
 import {Feature, FeatureCollection, GeometryObject, LineString} from 'geojson';
-import {SCThingInPlace, SCThingInPlaceMeta} from '../base/ThingInPlace';
-import {SCThingMeta, SCThingTranslatableProperties, SCThingType, SCThingWithoutReferences} from '../Thing';
-import {SCMetaTranslations, SCTranslations} from '../types/i18n';
-import {SCPointOfInterestWithoutReferences} from './PointOfInterest';
-import {SCRoomWithoutReferences} from './Room';
+import {SCMetaTranslations, SCTranslations} from '../general/i18n';
+import {SCThingMeta, SCThingTranslatableProperties, SCThingType, SCThingWithoutReferences} from './abstract/thing';
+import {SCThingInPlace, SCThingInPlaceMeta} from './abstract/thing-in-place';
+import {SCPointOfInterestWithoutReferences} from './point-of-interest';
+import {SCRoomWithoutReferences} from './room';
 
 /**
  * A floor without references
@@ -26,13 +27,15 @@ export interface SCFloorWithoutReferences
   extends SCThingWithoutReferences {
   /**
    * Floor name in the place it is in e.g. "first floor", "ground floor". This doesn't reference the building name.
+   *
+   * @text
    */
   floorName: string;
 
   /**
    * Floor plan
    */
-  plan: SCFloorFeatureCollectionWithPlaces<LineString, any>;
+  plan: SCFloorFeatureCollectionWithPlaces<LineString>;
 
   /**
    * Translated fields of a floor
@@ -49,6 +52,7 @@ export interface SCFloorWithoutReferences
  * A floor
  *
  * @validatable
+ * @indexable
  */
 export interface SCFloor
   extends SCFloorWithoutReferences, SCThingInPlace {
@@ -66,19 +70,20 @@ export interface SCFloor
 /**
  * A feature collection
  */
-export interface SCFloorFeatureCollectionWithPlaces<T extends GeometryObject, P = any>
-  extends FeatureCollection<T, P> {
+export interface SCFloorFeatureCollectionWithPlaces<T extends GeometryObject>
+  extends FeatureCollection<T> {
   /**
    * Features of the collection
    */
-  features: Array<SCFloorFeatureWithPlace<T, P>>;
+  features: Array<SCFloorFeatureWithPlace<T>>;
 }
 
 /***
  * A feature with a place
  */
-export interface SCFloorFeatureWithPlace<T extends GeometryObject, P = any>
-  extends Feature<T, P> {
+export interface SCFloorFeatureWithPlace<T extends GeometryObject>
+  // tslint:disable-next-line:no-any TODO
+  extends Feature<T, any> {
   /**
    * The place of the feature
    */
@@ -92,6 +97,8 @@ export interface SCFloorTranslatableProperties
   extends SCThingTranslatableProperties {
   /**
    * Translation of the floor name
+   *
+   * @text
    */
   floorName?: string;
 }
@@ -107,10 +114,16 @@ export class SCFloorMeta
    */
   fieldTranslations = {
     de: {
-      ...SCThingInPlaceMeta.getInstance().fieldTranslations.de,
+      ...SCThingInPlaceMeta.getInstance<SCThingInPlaceMeta>().fieldTranslations
+        .de,
+      floorName: 'Etagenbezeichnung',
+      plan: 'Grundriss',
     },
     en: {
-      ...SCThingInPlaceMeta.getInstance().fieldTranslations.en,
+      ...SCThingInPlaceMeta.getInstance<SCThingInPlaceMeta>().fieldTranslations
+        .en,
+      floorName: 'floor name',
+      plan: 'plan',
     },
   };
 
@@ -119,11 +132,13 @@ export class SCFloorMeta
    */
   fieldValueTranslations = {
     de: {
-      ...SCThingInPlaceMeta.getInstance().fieldValueTranslations.de,
+      ...SCThingInPlaceMeta.getInstance<SCThingInPlaceMeta>()
+        .fieldValueTranslations.de,
       type: 'Etage',
     },
     en: {
-      ...SCThingInPlaceMeta.getInstance().fieldValueTranslations.en,
+      ...SCThingInPlaceMeta.getInstance<SCThingInPlaceMeta>()
+        .fieldValueTranslations.en,
       type: SCThingType.Floor,
     },
   };

src/things/message.ts

@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2018, 2019 StApps
+ * Copyright (C) 2019 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.
@@ -12,16 +12,17 @@
  * 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 {SCMetaTranslations, SCTranslations} from '../general/i18n';
+import {SCISO8601Date} from '../general/time';
 import {
   SCCreativeWork,
   SCCreativeWorkMeta,
   SCCreativeWorkTranslatableProperties,
   SCCreativeWorkWithoutReferences,
-} from '../base/CreativeWork';
-import {SCThingThatCanBeOfferedTranslatableProperties} from '../base/ThingThatCanBeOffered';
-import {SCThingMeta, SCThingType} from '../Thing';
-import {SCMetaTranslations, SCTranslations} from '../types/i18n';
-import {SCISO8601Date} from '../types/Time';
+} from './abstract/creative-work';
+import {SCThingMeta, SCThingType} from './abstract/thing';
+import {SCThingThatCanBeOfferedTranslatableProperties} from './abstract/thing-that-can-be-offered';
+import {SCOrganizationWithoutReferences} from './organization';
 
 /**
  * A message without references
@@ -29,7 +30,12 @@ import {SCISO8601Date} from '../types/Time';
 export interface SCMessageWithoutReferences
   extends SCCreativeWorkWithoutReferences {
   /**
-   * Audience of the message
+   * Organizational unit for which the message is intended
+   */
+  audienceOrganizations?: SCOrganizationWithoutReferences[];
+
+  /**
+   * Roles for which the message is intended
    */
   audiences: SCMessageAudience[];
 
@@ -40,8 +46,10 @@ export interface SCMessageWithoutReferences
 
   /**
    * Message itself
+   *
+   * @text
    */
-  message: string;
+  messageBody: string;
 
   /**
    * Translated fields of a message
@@ -58,6 +66,7 @@ export interface SCMessageWithoutReferences
  * A message
  *
  * @validatable
+ * @indexable
  */
 export interface SCMessage
   extends SCCreativeWork, SCMessageWithoutReferences {
@@ -87,8 +96,10 @@ export interface SCMessageTranslatableProperties
   extends SCCreativeWorkTranslatableProperties, SCThingThatCanBeOfferedTranslatableProperties {
   /**
    * Message itself
+   *
+   * @text
    */
-  message?: string;
+  messageBody?: string;
 }
 
 /**
@@ -102,10 +113,20 @@ export class SCMessageMeta
    */
   fieldTranslations = {
     de: {
-      ...SCCreativeWorkMeta.getInstance().fieldTranslations.de,
+      ...SCCreativeWorkMeta.getInstance<SCCreativeWorkMeta>().fieldTranslations
+        .de,
+      audienceOrganizations: 'Zielgruppenorganisationen',
+      audiences: 'Zielgruppen',
+      dateCreated: 'Erstellungsdatum',
+      messageBody: 'Nachrichteninhalt',
     },
     en: {
-      ...SCCreativeWorkMeta.getInstance().fieldTranslations.en,
+      ...SCCreativeWorkMeta.getInstance<SCCreativeWorkMeta>().fieldTranslations
+        .en,
+      audienceOrganizations: 'audience organizations',
+      audiences: 'audiences',
+      dateCreated: 'date created',
+      messageBody: 'message body',
     },
   };
 
@@ -114,11 +135,18 @@ export class SCMessageMeta
    */
   fieldValueTranslations = {
     de: {
-      ...SCCreativeWorkMeta.getInstance().fieldValueTranslations.de,
+      ...SCCreativeWorkMeta.getInstance<SCCreativeWorkMeta>()
+        .fieldValueTranslations.de,
+      audiences: {
+        'employees': 'Angestellte',
+        'guests': 'Gäste',
+        'students': 'Studenten',
+      },
       type: 'Nachricht',
     },
     en: {
-      ...SCCreativeWorkMeta.getInstance().fieldValueTranslations.en,
+      ...SCCreativeWorkMeta.getInstance<SCCreativeWorkMeta>()
+        .fieldValueTranslations.en,
       type: SCThingType.Message,
     },
   };

src/things/organization.ts

@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2018, 2019 StApps
+ * Copyright (C) 2019 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.
@@ -12,8 +12,9 @@
  * 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 {SCThingInPlace} from '../base/ThingInPlace';
-import {SCThingMeta, SCThingType, SCThingWithoutReferences} from '../Thing';
+import {SCMetaTranslations} from '../general/i18n';
+import {SCThingMeta, SCThingType, SCThingWithoutReferences} from './abstract/thing';
+import {SCThingInPlace, SCThingInPlaceMeta} from './abstract/thing-in-place';
 
 /**
  * An organization without references
@@ -30,6 +31,7 @@ export interface SCOrganizationWithoutReferences
  * An organization
  *
  * @validatable
+ * @indexable
  */
 export interface SCOrganization
   extends SCOrganizationWithoutReferences, SCThingInPlace {
@@ -42,5 +44,31 @@ export interface SCOrganization
 /**
  * Meta information about an organization
  */
-export class SCOrganizationMeta extends SCThingMeta {
+export class SCOrganizationMeta
+  extends SCThingMeta implements SCMetaTranslations<SCOrganization> {
+  /**
+   * Translations of fields
+   */
+  fieldTranslations = {
+    de: {
+      ...SCThingInPlaceMeta.getInstance<SCThingInPlaceMeta>().fieldTranslations.de,
+    },
+    en: {
+      ...SCThingInPlaceMeta.getInstance<SCThingInPlaceMeta>().fieldTranslations.en,
+    },
+  };
+
+  /**
+   * Translations of values of fields
+   */
+  fieldValueTranslations = {
+    de: {
+      ...SCThingInPlaceMeta.getInstance<SCThingInPlaceMeta>().fieldValueTranslations.de,
+      type: 'Einrichtung',
+    },
+    en: {
+      ...SCThingInPlaceMeta.getInstance<SCThingInPlaceMeta>().fieldValueTranslations.en,
+      type: SCThingType.Organization,
+    },
+  };
 }

src/things/person.ts

@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2018, 2019 StApps
+ * Copyright (C) 2019 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.
@@ -12,13 +12,13 @@
  * 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 {SCThing, SCThingMeta, SCThingType, SCThingWithoutReferences} from '../Thing';
-import {SCMetaTranslations, SCNationality} from '../types/i18n';
-import {SCISO8601Date} from '../types/Time';
-import {SCBuildingWithoutReferences} from './Building';
-import {SCOrganizationWithoutReferences} from './Organization';
-import {SCPointOfInterestWithoutReferences} from './PointOfInterest';
-import {SCRoomWithoutReferences} from './Room';
+import {SCMetaTranslations, SCNationality} from '../general/i18n';
+import {SCISO8601Date} from '../general/time';
+import {SCThing, SCThingMeta, SCThingType, SCThingWithoutReferences} from './abstract/thing';
+import {SCBuildingWithoutReferences} from './building';
+import {SCOrganizationWithoutReferences} from './organization';
+import {SCPointOfInterestWithoutReferences} from './point-of-interest';
+import {SCRoomWithoutReferences} from './room';
 
 /**
  * A person without references
@@ -27,6 +27,8 @@ export interface SCPersonWithoutReferences
   extends SCThingWithoutReferences {
   /**
    * Additional first names of the person.
+   *
+   * @keyword
    */
   additionalName?: string;
 
@@ -39,16 +41,22 @@ export interface SCPersonWithoutReferences
    * The private email address of the person.
    *
    * @TJS-format email
+   *
+   * @keyword
    */
   email?: string;
 
   /**
    * The family name of the person.
+   *
+   * @keyword
    */
   familyName: string;
 
   /**
    * The private fax number of the person.
+   *
+   * @keyword
    */
   faxNumber?: string;
 
@@ -59,26 +67,36 @@ export interface SCPersonWithoutReferences
 
   /**
    * The first name of the person.
+   *
+   * @keyword
    */
   givenName: string;
 
   /**
    * Honorific prefix of the person.
+   *
+   * @keyword
    */
   honorificPrefix?: string;
 
   /**
    * Honorific suffix of the person.
+   *
+   * @keyword
    */
   honorificSuffix?: string;
 
   /**
    * Titles of jobs that the person has.
+   *
+   * @keyword
    */
   jobTitles?: string[];
 
   /**
    * The complete name of the person combining all the parts of the name into one.
+   *
+   * @text
    */
   name: string;
 
@@ -89,6 +107,8 @@ export interface SCPersonWithoutReferences
 
   /**
    * The private telephone number of the person.
+   *
+   * @keyword
    */
   telephone?: string;
 
@@ -102,6 +122,7 @@ export interface SCPersonWithoutReferences
  * A person
  *
  * @validatable
+ * @indexable
  */
 export interface SCPerson
   extends SCPersonWithoutReferences, SCThing {
@@ -139,10 +160,40 @@ export class SCPersonMeta
    */
   fieldTranslations = {
     de: {
-      ...SCThingMeta.getInstance().fieldTranslations.de,
+      ...SCThingMeta.getInstance<SCThingMeta>().fieldTranslations.de,
+      additionalName: 'Zusatzname',
+      affiliations: 'Zugehörigkeiten',
+      birthDate: 'Geburtsdatum',
+      email: 'E-Mail',
+      familyName: 'Nachname',
+      faxNumber: 'Faxnummer',
+      gender: 'Geschlecht',
+      givenName: 'Vorname',
+      homeLocations: 'Heimatstandorte',
+      honorificPrefix: 'Ehrentitel',
+      honorificSuffix: 'Ehrentitel (Suffix)',
+      jobTitles: 'Berufsbezeichnungen',
+      nationality: 'Staatsangehörigkeit',
+      telephone: 'Telefonnummer',
+      workLocations: 'Arbeitsorte',
     },
     en: {
-      ...SCThingMeta.getInstance().fieldTranslations.en,
+      ...SCThingMeta.getInstance<SCThingMeta>().fieldTranslations.en,
+      additionalName: 'additional name',
+      affiliations: 'affiliations',
+      birthDate: 'birth date',
+      email: 'email',
+      familyName: 'family name',
+      faxNumber: 'fax',
+      gender: 'gender',
+      givenName: 'given name',
+      homeLocations: 'home locations',
+      honorificPrefix: 'honorific title',
+      honorificSuffix: 'honorific title (suffix)',
+      jobTitles: 'job titles',
+      nationality: 'nationality',
+      telephone: 'telephone',
+      workLocations: 'work locations',
     },
   };
 
@@ -151,11 +202,17 @@ export class SCPersonMeta
    */
   fieldValueTranslations = {
     de: {
-      ...SCThingMeta.getInstance().fieldValueTranslations.de,
+      ...SCThingMeta.getInstance<SCThingMeta>().fieldValueTranslations.de,
+      gender: {
+        'female': 'weiblich',
+        'inter': 'divers',
+        'male': 'männlich',
+        'undefined': 'undefiniert',
+      },
       type: 'Person',
     },
     en: {
-      ...SCThingMeta.getInstance().fieldValueTranslations.en,
+      ...SCThingMeta.getInstance<SCThingMeta>().fieldValueTranslations.en,
       type: SCThingType.Person,
     },
   };
@@ -174,26 +231,36 @@ export interface SCContactPoint {
 
   /**
    * E-mail at the work location
+   *
+   * @keyword
    */
   email?: string;
 
   /**
    * Fax number at the work location
+   *
+   * @keyword
    */
   faxNumber?: string;
 
   /**
    * Times available for contacting at the work location
+   *
+   * @keyword
    */
   hoursAvailable?: string;
 
   /**
    * Contact number at the work location
+   *
+   * @keyword
    */
   telephone?: string;
 
   /**
    * URL at the work location
+   *
+   * @keyword
    */
   url?: string;
 }

src/things/point-of-interest.ts

@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2018, 2019 StApps
+ * Copyright (C) 2019 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.
@@ -12,17 +12,17 @@
  * 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 {SCPlace, SCPlaceWithoutReferences, SCPlaceWithoutReferencesMeta} from '../base/Place';
-import {SCThingInPlace} from '../base/ThingInPlace';
+import {SCMetaTranslations, SCTranslations} from '../general/i18n';
+import {SCPlace, SCPlaceWithoutReferences, SCPlaceWithoutReferencesMeta} from './abstract/place';
+import {SCThingMeta, SCThingType} from './abstract/thing';
+import {SCThingInPlace, SCThingInPlaceMeta} from './abstract/thing-in-place';
 import {
   SCThingWithCategories,
   SCThingWithCategoriesSpecificValues,
   SCThingWithCategoriesTranslatableProperties,
   SCThingWithCategoriesWithoutReferences,
   SCThingWithCategoriesWithoutReferencesMeta,
-} from '../base/ThingWithCategories';
-import {SCThingMeta, SCThingType} from '../Thing';
-import {SCMetaTranslations, SCTranslations} from '../types/i18n';
+} from './abstract/thing-with-categories';
 
 /**
  * A point of interest without references
@@ -45,6 +45,7 @@ export interface SCPointOfInterestWithoutReferences
  * A point of interest
  *
  * @validatable
+ * @indexable
  */
 export interface SCPointOfInterest
   extends SCPointOfInterestWithoutReferences, SCThingInPlace, SCPlace,
@@ -81,16 +82,18 @@ export class SCPointOfInterestMeta
    */
   fieldTranslations = {
     de: {
-      // tslint:disable-next-line:max-line-length
       ...SCThingWithCategoriesWithoutReferencesMeta.getInstance<SCPointOfInterestCategories,
         SCThingWithCategoriesSpecificValues>().fieldTranslations.de,
-      ...SCPlaceWithoutReferencesMeta.getInstance().fieldTranslations.de,
+      ...SCPlaceWithoutReferencesMeta.getInstance<SCPlaceWithoutReferencesMeta>().fieldTranslations.de,
+      ...SCThingInPlaceMeta.getInstance<SCThingInPlaceMeta>().fieldTranslations
+        .de,
     },
     en: {
-      // tslint:disable-next-line:max-line-length
       ...SCThingWithCategoriesWithoutReferencesMeta.getInstance<SCPointOfInterestCategories,
         SCThingWithCategoriesSpecificValues>().fieldTranslations.en,
-      ...SCPlaceWithoutReferencesMeta.getInstance().fieldTranslations.en,
+      ...SCPlaceWithoutReferencesMeta.getInstance<SCPlaceWithoutReferencesMeta>().fieldTranslations.en,
+      ...SCThingInPlaceMeta.getInstance<SCThingInPlaceMeta>().fieldTranslations
+        .en,
     },
   };
 
@@ -101,13 +104,20 @@ export class SCPointOfInterestMeta
     de: {
       ...SCThingWithCategoriesWithoutReferencesMeta.getInstance<SCPointOfInterestCategories,
         SCThingWithCategoriesSpecificValues>().fieldValueTranslations.de,
-      ...SCPlaceWithoutReferencesMeta.getInstance().fieldValueTranslations.de,
+      ...SCPlaceWithoutReferencesMeta.getInstance<SCPlaceWithoutReferencesMeta>().fieldValueTranslations.de,
+      categories: {
+        'card charger': 'Kartenaufwerter',
+        'computer': 'Computer',
+        'disabled access': 'barrierefreier Zugang',
+        'printer': 'Drucker',
+        'validator': 'Validierer',
+      },
       type: 'Sonderziel',
     },
     en: {
       ...SCThingWithCategoriesWithoutReferencesMeta.getInstance<SCPointOfInterestCategories,
         SCThingWithCategoriesSpecificValues>().fieldValueTranslations.en,
-      ...SCPlaceWithoutReferencesMeta.getInstance().fieldValueTranslations.en,
+      ...SCPlaceWithoutReferencesMeta.getInstance<SCPlaceWithoutReferencesMeta>().fieldValueTranslations.en,
       type: SCThingType.PointOfInterest,
     },
   };

src/things/room.ts

@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2018, 2019 StApps
+ * Copyright (C) 2019 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.
@@ -12,24 +12,24 @@
  * 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 {SCPlace, SCPlaceWithoutReferences, SCPlaceWithoutReferencesMeta} from '../base/Place';
-import {SCThingInPlace, SCThingInPlaceMeta} from '../base/ThingInPlace';
+import {SCMetaTranslations, SCTranslations} from '../general/i18n';
+import {SCMap} from '../general/map';
+import {SCPlace, SCPlaceWithoutReferences, SCPlaceWithoutReferencesMeta} from './abstract/place';
+
+import {SCThingMeta, SCThingType} from './abstract/thing';
+import {SCThingInPlace, SCThingInPlaceMeta} from './abstract/thing-in-place';
 import {
   SCThingThatAcceptsPayments,
   SCThingThatAcceptsPaymentsWithoutReferences,
   SCThingThatAcceptsPaymentsWithoutReferencesMeta,
-} from '../base/ThingThatAcceptsPayments';
+} from './abstract/thing-that-accepts-payments';
 import {
   SCThingWithCategories,
   SCThingWithCategoriesSpecificValues,
   SCThingWithCategoriesTranslatableProperties,
   SCThingWithCategoriesWithoutReferences,
   SCThingWithCategoriesWithoutReferencesMeta,
-} from '../base/ThingWithCategories';
-
-import {SCThingMeta, SCThingType} from '../Thing';
-import {SCMetaTranslations, SCTranslations} from '../types/i18n';
-import {SCMap} from '../types/Map';
+} from './abstract/thing-with-categories';
 
 /**
  * Categories of a room
@@ -57,8 +57,10 @@ export interface SCRoomWithoutReferences
     SCThingWithCategoriesWithoutReferences<SCRoomCategories, SCRoomSpecificValues> {
   /**
    * The name of the floor in which the room is in.
+   *
+   * @text
    */
-  floor?: string;
+  floorName?: string;
 
   /**
    * The inventory of the place/room as a list of items and their quantity.
@@ -82,6 +84,7 @@ export interface SCRoomWithoutReferences
  * A room
  *
  * @validatable
+ * @indexable
  */
 export interface SCRoom
   extends SCRoomWithoutReferences, SCThingInPlace, SCThingThatAcceptsPayments, SCPlace,
@@ -106,6 +109,8 @@ export interface SCRoomSpecificValues
   extends SCThingWithCategoriesSpecificValues {
   /**
    * Category specific opening hours of the room
+   *
+   * @keyword
    */
   openingHours?: string;
 }
@@ -121,18 +126,26 @@ export class SCRoomMeta
    */
   fieldTranslations = {
     de: {
-      ...SCPlaceWithoutReferencesMeta.getInstance().fieldTranslations.de,
-      ...SCThingThatAcceptsPaymentsWithoutReferencesMeta.getInstance().fieldTranslations.de,
+      ...SCPlaceWithoutReferencesMeta.getInstance<SCPlaceWithoutReferencesMeta>().fieldTranslations.de,
+      ...SCThingThatAcceptsPaymentsWithoutReferencesMeta.getInstance<SCThingThatAcceptsPaymentsWithoutReferencesMeta>()
+        .fieldTranslations.de,
       ...SCThingWithCategoriesWithoutReferencesMeta.getInstance<SCRoomCategories,
         SCRoomSpecificValues>().fieldTranslations.de,
-      ...SCThingInPlaceMeta.getInstance().fieldTranslations.de,
+      ...SCThingInPlaceMeta.getInstance<SCThingInPlaceMeta>().fieldTranslations
+        .de,
+      floorName: 'Etagenbezeichnung',
+      inventory: 'Bestand',
     },
     en: {
-      ...SCPlaceWithoutReferencesMeta.getInstance().fieldTranslations.en,
-      ...SCThingThatAcceptsPaymentsWithoutReferencesMeta.getInstance().fieldTranslations.en,
+      ...SCPlaceWithoutReferencesMeta.getInstance<SCPlaceWithoutReferencesMeta>().fieldTranslations.en,
+      ...SCThingThatAcceptsPaymentsWithoutReferencesMeta.getInstance<SCThingThatAcceptsPaymentsWithoutReferencesMeta>()
+        .fieldTranslations.en,
       ...SCThingWithCategoriesWithoutReferencesMeta.getInstance<SCRoomCategories,
         SCRoomSpecificValues>().fieldTranslations.en,
-      ...SCThingInPlaceMeta.getInstance().fieldTranslations.en,
+      ...SCThingInPlaceMeta.getInstance<SCThingInPlaceMeta>().fieldTranslations
+        .en,
+      floorName: 'floor name',
+      inventory: 'inventory',
     },
   };
 
@@ -141,11 +154,13 @@ export class SCRoomMeta
    */
   fieldValueTranslations = {
     de: {
-      ...SCPlaceWithoutReferencesMeta.getInstance().fieldValueTranslations.de,
-      ...SCThingThatAcceptsPaymentsWithoutReferencesMeta.getInstance().fieldValueTranslations.de,
+      ...SCPlaceWithoutReferencesMeta.getInstance<SCPlaceWithoutReferencesMeta>().fieldValueTranslations.de,
+      ...SCThingThatAcceptsPaymentsWithoutReferencesMeta.getInstance<SCThingThatAcceptsPaymentsWithoutReferencesMeta>()
+        .fieldValueTranslations.de,
       ...SCThingWithCategoriesWithoutReferencesMeta.getInstance<SCRoomCategories,
         SCRoomSpecificValues>().fieldValueTranslations.de,
-      ...SCThingInPlaceMeta.getInstance().fieldValueTranslations.de,
+      ...SCThingInPlaceMeta.getInstance<SCThingInPlaceMeta>()
+        .fieldValueTranslations.de,
       categories: {
         'cafe': 'Café',
         'canteen': 'Kantine',
@@ -164,11 +179,13 @@ export class SCRoomMeta
       type: 'Raum',
     },
     en: {
-      ...SCPlaceWithoutReferencesMeta.getInstance().fieldValueTranslations.en,
-      ...SCThingThatAcceptsPaymentsWithoutReferencesMeta.getInstance().fieldValueTranslations.en,
+      ...SCPlaceWithoutReferencesMeta.getInstance<SCPlaceWithoutReferencesMeta>().fieldValueTranslations.en,
+      ...SCThingThatAcceptsPaymentsWithoutReferencesMeta.getInstance<SCThingThatAcceptsPaymentsWithoutReferencesMeta>()
+        .fieldValueTranslations.en,
       ...SCThingWithCategoriesWithoutReferencesMeta.getInstance<SCRoomCategories,
         SCRoomSpecificValues>().fieldValueTranslations.en,
-      ...SCThingInPlaceMeta.getInstance().fieldValueTranslations.en,
+      ...SCThingInPlaceMeta.getInstance<SCThingInPlaceMeta>()
+        .fieldValueTranslations.en,
       type: SCThingType.Room,
     },
   };

src/things/semester.ts

@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2018, 2019 StApps
+ * Copyright (C) 2019 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.
@@ -12,13 +12,13 @@
  * 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 {SCMetaTranslations} from '../general/i18n';
 import {
   SCAcademicTerm,
   SCAcademicTermWithoutReferences,
   SCAcademicTermWithoutReferencesMeta,
-} from '../base/AcademicTerm';
-import {SCThingMeta, SCThingType} from '../Thing';
-import {SCMetaTranslations} from '../types/i18n';
+} from './abstract/academic-term';
+import {SCThingMeta, SCThingType} from './abstract/thing';
 
 /**
  * A semester without references
@@ -29,6 +29,7 @@ export interface SCSemesterWithoutReferences
    * The short name of the semester, using the given pattern.
    *
    * @pattern ^(WS|SS) [0-9]{4}(/[0-9]{2})?$
+   * @keyword
    */
   acronym: string;
 
@@ -42,6 +43,7 @@ export interface SCSemesterWithoutReferences
  * A semester
  *
  * @validatable
+ * @indexable
  */
 export interface SCSemester
   extends SCSemesterWithoutReferences, SCAcademicTerm {
@@ -62,7 +64,7 @@ export class SCSemesterMeta
    */
   fieldTranslations = {
     de: {
-      ...SCAcademicTermWithoutReferencesMeta.getInstance().fieldTranslations.de,
+      ...SCAcademicTermWithoutReferencesMeta.getInstance<SCAcademicTermWithoutReferencesMeta>().fieldTranslations.de,
       acronym: 'Abkürzung',
       endDate: 'Ende',
       eventsEndDate: 'Vorlesungsschluss',
@@ -70,7 +72,12 @@ export class SCSemesterMeta
       startDate: 'Beginn',
     },
     en: {
-      ...SCAcademicTermWithoutReferencesMeta.getInstance().fieldTranslations.en,
+      ...SCAcademicTermWithoutReferencesMeta.getInstance<SCAcademicTermWithoutReferencesMeta>().fieldTranslations.en,
+      acronym: 'acronym',
+      endDate: 'end date',
+      eventsEndDate: 'semester ending',
+      eventsStartDate: 'semester beginning',
+      startDate: 'start date',
     },
   };
 
@@ -79,11 +86,13 @@ export class SCSemesterMeta
    */
   fieldValueTranslations = {
     de: {
-      ...SCAcademicTermWithoutReferencesMeta.getInstance().fieldValueTranslations.de,
+      ...SCAcademicTermWithoutReferencesMeta.getInstance<SCAcademicTermWithoutReferencesMeta>()
+        .fieldValueTranslations.de,
       type: 'Semester',
     },
     en: {
-      ...SCAcademicTermWithoutReferencesMeta.getInstance().fieldValueTranslations.en,
+      ...SCAcademicTermWithoutReferencesMeta.getInstance<SCAcademicTermWithoutReferencesMeta>()
+        .fieldValueTranslations.en,
       type: SCThingType.Semester,
     },
   };

src/things/setting.ts

@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2018, 2019 StApps
+ * Copyright (C) 2019 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.
@@ -12,23 +12,25 @@
  * 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 {SCMetaTranslations, SCTranslations} from '../general/i18n';
+import {SCThing, SCThingMeta, SCThingType} from './abstract/thing';
 import {
   SCThingWithCategories,
   SCThingWithCategoriesSpecificValues,
   SCThingWithCategoriesTranslatableProperties,
   SCThingWithCategoriesWithoutReferences,
   SCThingWithCategoriesWithoutReferencesMeta,
-} from '../base/ThingWithCategories';
-import {SCThing, SCThingMeta, SCThingType} from '../Thing';
-import {SCMetaTranslations, SCTranslations} from '../types/i18n';
-
-export type SCSettingCategories = string;
+} from './abstract/thing-with-categories';
 
 /**
  * A setting without references
  */
 export interface SCSettingWithoutReferences
   extends SCThingWithCategoriesWithoutReferences<SCSettingCategories, SCThingWithCategoriesSpecificValues> {
+  /**
+   * Categories of a setting
+   */
+  categories: SCSettingCategories[];
   /**
    * The default value of a setting
    */
@@ -39,6 +41,8 @@ export interface SCSettingWithoutReferences
   inputType: SCSettingInputType;
   /**
    * The order number this setting should show up in its category list
+   *
+   * @integer
    */
   order: number;
   /**
@@ -59,6 +63,15 @@ export interface SCSettingWithoutReferences
   values?: SCSettingValues;
 }
 
+/**
+ * A list of categories for settings
+ */
+export type SCSettingCategories =
+  'profile'
+  | 'privacy'
+  | 'credentials'
+  | 'others';
+
 /**
  * The types of input/value a setting object can carry
  */
@@ -74,6 +87,7 @@ export enum SCSettingInputType {
  * A setting with references
  *
  * @validatable
+ * @indexable
  */
 export interface SCSetting
   extends SCSettingWithoutReferences, SCThing,
@@ -104,6 +118,8 @@ export type SCSettingValues = SCSettingValue[];
 export interface SCSettingValueTranslatableProperties extends SCThingWithCategoriesTranslatableProperties {
   /**
    * The translations of the possible values of a setting
+   *
+   * @keyword
    */
   values?: string[];
 }
@@ -117,20 +133,22 @@ export class SCSettingMeta extends SCThingMeta implements SCMetaTranslations<SCS
    */
   fieldTranslations = {
     de: {
-      // tslint:disable-next-line:max-line-length
       ...SCThingWithCategoriesWithoutReferencesMeta.getInstance<SCSettingCategories,
         SCThingWithCategoriesSpecificValues>().fieldTranslations.de,
       defaultValue: 'Standard Wert',
       inputType: 'Eingabetyp',
+      order: 'Position',
       value: 'Wert',
       values: 'Werte',
     },
     en: {
-      // tslint:disable-next-line:max-line-length
       ...SCThingWithCategoriesWithoutReferencesMeta.getInstance<SCSettingCategories,
         SCThingWithCategoriesSpecificValues>().fieldTranslations.en,
       defaultValue: 'default value',
       inputType: 'input type',
+      order: 'position',
+      value: 'value',
+      values: 'values',
     },
   };
 
@@ -139,9 +157,14 @@ export class SCSettingMeta extends SCThingMeta implements SCMetaTranslations<SCS
    */
   fieldValueTranslations = {
     de: {
-      // tslint:disable-next-line:max-line-length
       ...SCThingWithCategoriesWithoutReferencesMeta.getInstance<SCSettingCategories,
         SCThingWithCategoriesSpecificValues>().fieldValueTranslations.de,
+      categories: {
+        credentials: 'Anmeldedaten',
+        others: 'Andere',
+        privacy: 'Privatsphäre',
+        profile: 'Profil',
+      },
       inputType: {
         'multiple choice': 'mehrfach Auswahl',
         number: 'Zahl',
@@ -152,7 +175,6 @@ export class SCSettingMeta extends SCThingMeta implements SCMetaTranslations<SCS
       type: 'Einstellung',
     },
     en: {
-      // tslint:disable-next-line:max-line-length
       ...SCThingWithCategoriesWithoutReferencesMeta.getInstance<SCSettingCategories,
         SCThingWithCategoriesSpecificValues>().fieldValueTranslations.en,
       type: SCThingType.Setting,

src/things/sport-course.ts

@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2018, 2019 StApps
+ * Copyright (C) 2019 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.
@@ -12,9 +12,9 @@
  * 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 {SCEvent, SCEventMeta, SCEventWithoutReferences} from '../base/Event';
-import {SCThingMeta, SCThingType} from '../Thing';
-import {SCMetaTranslations} from '../types/i18n';
+import {SCMetaTranslations} from '../general/i18n';
+import {SCEvent, SCEventMeta, SCEventWithoutReferences} from './abstract/event';
+import {SCThingMeta, SCThingType} from './abstract/thing';
 
 /**
  * A sport course without references
@@ -31,6 +31,7 @@ export interface SCSportCourseWithoutReferences
  * A sport course
  *
  * @validatable
+ * @indexable
  */
 export interface SCSportCourse
   extends SCEvent, SCSportCourseWithoutReferences {
@@ -51,12 +52,10 @@ export class SCSportCourseMeta
    */
   fieldTranslations = {
     de: {
-      ...SCThingMeta.getInstance().fieldTranslations.de,
-      ...SCEventMeta.getInstance().fieldTranslations.de,
+      ...SCEventMeta.getInstance<SCEventMeta>().fieldTranslations.de,
     },
     en: {
-      ...SCThingMeta.getInstance().fieldTranslations.en,
-      ...SCEventMeta.getInstance().fieldTranslations.en,
+      ...SCEventMeta.getInstance<SCEventMeta>().fieldTranslations.en,
     },
   };
 
@@ -65,13 +64,11 @@ export class SCSportCourseMeta
    */
   fieldValueTranslations = {
     de: {
-      ...SCThingMeta.getInstance().fieldValueTranslations.de,
-      ...SCEventMeta.getInstance().fieldValueTranslations.de,
+      ...SCEventMeta.getInstance<SCEventMeta>().fieldValueTranslations.de,
       type: 'Sportkurs',
     },
     en: {
-      ...SCThingMeta.getInstance().fieldValueTranslations.en,
-      ...SCEventMeta.getInstance().fieldValueTranslations.en,
+      ...SCEventMeta.getInstance<SCEventMeta>().fieldValueTranslations.en,
       type: SCThingType.SportCourse,
     },
   };

src/things/study-module.ts

@@ -12,18 +12,19 @@
  * 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 {SCLanguage, SCMetaTranslations, SCTranslations} from '../general/i18n';
+import {SCMap} from '../general/map';
+import {SCThingMeta, SCThingType} from './abstract/thing';
 import {
   SCAcademicPriceGroup,
   SCThingThatCanBeOffered,
+  SCThingThatCanBeOfferedMeta,
   SCThingThatCanBeOfferedTranslatableProperties,
   SCThingThatCanBeOfferedWithoutReferences,
-} from '../base/ThingThatCanBeOffered';
-import {SCThingMeta, SCThingType} from '../Thing';
-import {SCLanguage, SCMetaTranslations, SCTranslations} from '../types/i18n';
-import {SCMap} from '../types/Map';
-import {SCAcademicEventWithoutReferences} from './AcademicEvent';
-import {SCOrganizationWithoutReferences} from './Organization';
-import {SCPersonWithoutReferences} from './Person';
+} from './abstract/thing-that-can-be-offered';
+import {SCAcademicEventWithoutReferences} from './academic-event';
+import {SCOrganizationWithoutReferences} from './organization';
+import {SCPersonWithoutReferences} from './person';
 
 /**
  * A study module without references
@@ -33,6 +34,8 @@ export interface SCStudyModuleWithoutReferences
 
   /**
    * ECTS points (European Credit Transfer System)
+   *
+   * @float
    */
   ects: number;
 
@@ -43,6 +46,8 @@ export interface SCStudyModuleWithoutReferences
 
   /**
    * Majors that this study module is meant for
+   *
+   * @keyword
    */
   majors: string[];
 
@@ -66,6 +71,7 @@ export interface SCStudyModuleWithoutReferences
  * A study module
  *
  * @validatable
+ * @indexable
  */
 export interface SCStudyModule
   extends SCStudyModuleWithoutReferences, SCThingThatCanBeOffered<SCAcademicPriceGroup> {
@@ -110,6 +116,8 @@ export interface SCStudyModuleTranslatableProperties
   extends SCThingThatCanBeOfferedTranslatableProperties {
   /**
    * Translations of the majors that this study module is meant for
+   *
+   * @keyword
    */
   majors?: string[];
 
@@ -142,6 +150,8 @@ export class SCStudyModuleMeta
   fieldTranslations = {
     de: {
       ...SCThingMeta.getInstance().fieldTranslations.de,
+      ...SCThingThatCanBeOfferedMeta.getInstance<SCAcademicPriceGroup>()
+        .fieldTranslations.de,
       academicEvents: 'Veranstaltungen',
       ects: 'ECTS-Punkte',
       faculty: 'Fachbereich',
@@ -154,6 +164,8 @@ export class SCStudyModuleMeta
     },
     en: {
       ...SCThingMeta.getInstance().fieldTranslations.en,
+      ...SCThingThatCanBeOfferedMeta.getInstance<SCAcademicPriceGroup>()
+        .fieldTranslations.en,
       academicEvents: 'academic events',
       ects: 'ECTS points',
       faculty: 'faculty',
@@ -171,7 +183,9 @@ export class SCStudyModuleMeta
    */
   fieldValueTranslations = {
     de: {
-      ...SCThingMeta.getInstance().fieldValueTranslations.de,
+      ...SCThingMeta.getInstance<SCThingMeta>().fieldValueTranslations.de,
+      ...SCThingThatCanBeOfferedMeta.getInstance<SCAcademicPriceGroup>()
+        .fieldValueTranslations.de,
       necessity: {
         'elective': 'Wahlfach',
         'optional': 'optional',
@@ -180,7 +194,9 @@ export class SCStudyModuleMeta
       type: 'Studiengangmodul',
     },
     en: {
-      ...SCThingMeta.getInstance().fieldValueTranslations.en,
+      ...SCThingMeta.getInstance<SCThingMeta>().fieldValueTranslations.en,
+      ...SCThingThatCanBeOfferedMeta.getInstance<SCAcademicPriceGroup>()
+        .fieldValueTranslations.en,
       type: SCThingType.StudyModule,
     },
   };

src/things/ticket.ts

@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2018, 2019 StApps
+ * Copyright (C) 2019 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.
@@ -12,10 +12,10 @@
  * 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 {SCThingInPlace, SCThingInPlaceMeta} from '../base/ThingInPlace';
-import {SCThingMeta, SCThingType, SCThingWithoutReferences} from '../Thing';
-import {SCMetaTranslations} from '../types/i18n';
-import {SCISO8601Duration} from '../types/Time';
+import {SCMetaTranslations} from '../general/i18n';
+import {SCISO8601Duration} from '../general/time';
+import {SCThingMeta, SCThingType, SCThingWithoutReferences} from './abstract/thing';
+import {SCThingInPlace, SCThingInPlaceMeta} from './abstract/thing-in-place';
 
 /**
  * A ticket without references
@@ -29,13 +29,15 @@ export interface SCTicketWithoutReferences
 
   /**
    * Waiting number of the ticket
+   *
+   * @keyword
    */
   currentTicketNumber: string;
 
   /**
    * Service type of the ticket
    */
-  serviceType: any;
+  serviceType: string;
 
   /**
    * Type of a ticket
@@ -47,6 +49,7 @@ export interface SCTicketWithoutReferences
  * A ticket
  *
  * @validatable
+ * @indexable
  */
 export interface SCTicket
   extends SCTicketWithoutReferences, SCThingInPlace {
@@ -67,10 +70,18 @@ export class SCTicketMeta
    */
   fieldTranslations = {
     de: {
-      ...SCThingInPlaceMeta.getInstance().fieldTranslations.de,
+      ...SCThingInPlaceMeta.getInstance<SCThingInPlaceMeta>().fieldTranslations
+        .de,
+      approxWaitingTime: 'ungefähre Wartezeit',
+      currentTicketNumber: 'aktuelle Ticketnummer',
+      serviceType: 'Service Kategorie',
     },
     en: {
-      ...SCThingInPlaceMeta.getInstance().fieldTranslations.en,
+      ...SCThingInPlaceMeta.getInstance<SCThingInPlaceMeta>().fieldTranslations
+        .en,
+      approxWaitingTime: 'approximate waiting time',
+      currentTicketNumber: 'current ticket number',
+      serviceType: 'type of service',
     },
   };
 
@@ -79,11 +90,13 @@ export class SCTicketMeta
    */
   fieldValueTranslations = {
     de: {
-      ...SCThingInPlaceMeta.getInstance().fieldValueTranslations.de,
+      ...SCThingInPlaceMeta.getInstance<SCThingInPlaceMeta>()
+        .fieldValueTranslations.de,
       type: 'Ticket',
     },
     en: {
-      ...SCThingInPlaceMeta.getInstance().fieldValueTranslations.en,
+      ...SCThingInPlaceMeta.getInstance<SCThingInPlaceMeta>()
+        .fieldValueTranslations.en,
       type: SCThingType.Ticket,
     },
   };

src/things/todo.ts

@@ -12,16 +12,16 @@
  * 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 {SCMetaTranslations, SCTranslations} from '../general/i18n';
+import {SCISO8601Date} from '../general/time';
+import {SCThing, SCThingMeta, SCThingType} from './abstract/thing';
 import {
   SCThingWithCategories,
   SCThingWithCategoriesSpecificValues,
   SCThingWithCategoriesTranslatableProperties,
   SCThingWithCategoriesWithoutReferences,
   SCThingWithCategoriesWithoutReferencesMeta,
-} from '../base/ThingWithCategories';
-import {SCThing, SCThingMeta, SCThingType} from '../Thing';
-import {SCMetaTranslations, SCTranslations} from '../types/i18n';
-import {SCISO8601Date} from '../types/Time';
+} from './abstract/thing-with-categories';
 
 /**
  * A "to do" without references
@@ -53,6 +53,7 @@ export interface SCToDoWithoutReferences
  * A "to do"
  *
  * @validatable
+ * @indexable
  */
 export interface SCToDo
   extends SCToDoWithoutReferences, SCThing, SCThingWithCategories<string, SCThingWithCategoriesSpecificValues> {
@@ -87,10 +88,16 @@ export class SCToDoMeta extends SCThingMeta implements SCMetaTranslations<SCToDo
     de: {
       ...SCThingWithCategoriesWithoutReferencesMeta.getInstance<string,
         SCThingWithCategoriesSpecificValues>().fieldTranslations.de,
+      done: 'Erledigt',
+      dueDate: 'Fälligkeitsdatum',
+      priority: 'Priorität',
     },
     en: {
       ...SCThingWithCategoriesWithoutReferencesMeta.getInstance<string,
         SCThingWithCategoriesSpecificValues>().fieldTranslations.en,
+      done: 'done',
+      dueDate: 'due date',
+      priority: 'priority',
     },
   };
 

src/things/tour.ts

@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2018, 2019 StApps
+ * Copyright (C) 2019 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.
@@ -12,8 +12,8 @@
  * 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 {SCThing, SCThingMeta, SCThingType, SCThingWithoutReferences} from '../Thing';
-import {SCMetaTranslations} from '../types/i18n';
+import {SCMetaTranslations} from '../general/i18n';
+import {SCThing, SCThingMeta, SCThingType, SCThingWithoutReferences} from './abstract/thing';
 
 /**
  * A tour without references
@@ -22,16 +22,22 @@ export interface SCTourWithoutReferences
   extends SCThingWithoutReferences {
   /**
    * Init script for the tour
+   *
+   * @text
    */
   init?: string;
 
   /**
    * Steps of a tour
+   *
+   * @keyword
    */
   steps: SCTourStep[];
 
   /**
    * Type of a tour
+   *
+   * @keyword
    */
   type: SCThingType.Tour;
 }
@@ -40,6 +46,7 @@ export interface SCTourWithoutReferences
  * A tour
  *
  * @validatable
+ * @indexable
  */
 export interface SCTour
   extends SCTourWithoutReferences, SCThing {
@@ -55,6 +62,35 @@ export interface SCTour
 export class SCTourMeta
   extends SCThingMeta
   implements SCMetaTranslations<SCTour> {
+  /**
+   * Translations of fields
+   */
+  fieldTranslations = {
+    de: {
+      ...SCThingMeta.getInstance<SCThingMeta>().fieldTranslations.de,
+      init: 'Initiales Skript',
+      steps: 'Schritte',
+    },
+    en: {
+      ...SCThingMeta.getInstance<SCThingMeta>().fieldTranslations.en,
+      init: 'initial script',
+      steps: 'steps',
+    },
+  };
+
+  /**
+   * Translations of values of fields
+   */
+  fieldValueTranslations = {
+    de: {
+      ...SCThingMeta.getInstance<SCThingMeta>().fieldValueTranslations.de,
+      type: 'Tour',
+    },
+    en: {
+      ...SCThingMeta.getInstance<SCThingMeta>().fieldValueTranslations.en,
+      type: SCThingType.Tour,
+    },
+  };
 }
 
 /**
@@ -71,6 +107,8 @@ export type SCTourStep =
 export interface SCTourStepLocation {
   /**
    * Location to go to
+   *
+   * @keyword
    */
   location: string;
 
@@ -91,6 +129,8 @@ export interface SCTourStepTooltip {
 
   /**
    * Element that the tooltip shall be pointing at or a list of elements to try in the specified order
+   *
+   * @keyword
    */
   element: string | string[];
 
@@ -106,11 +146,15 @@ export interface SCTourStepTooltip {
 
   /**
    * Text that the tooltip shall contain
+   *
+   * @text
    */
   text: string;
 
   /**
    * How often it shall be retried
+   *
+   * @integer
    */
   tries?: number;
 
@@ -146,6 +190,8 @@ export interface SCTourStepMenu {
 export interface SCTourResolvedElement {
   /**
    * Element name
+   *
+   * @keyword
    */
   element: string;
 }
@@ -156,6 +202,8 @@ export interface SCTourResolvedElement {
 export interface SCTourResolvedEvent {
   /**
    * Event name
+   *
+   * @keyword
    */
   event: string;
 }
@@ -176,6 +224,8 @@ export interface SCTourResolvedLocation {
 export interface SCTourResolvedLocationTypeIs {
   /**
    * Specific location name
+   *
+   * @keyword
    */
   is: string;
 }
@@ -186,6 +236,8 @@ export interface SCTourResolvedLocationTypeIs {
 export interface SCTourResolvedLocationTypeMatch {
   /**
    * Regex location name
+   *
+   * @keyword
    */
   match: string;
 }

src/things/video.ts

@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2018, 2019 StApps
+ * Copyright (C) 2019 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.
@@ -12,11 +12,11 @@
  * 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 {SCCreativeWork, SCCreativeWorkMeta, SCCreativeWorkWithoutReferences} from '../base/CreativeWork';
-import {SCThingMeta, SCThingType} from '../Thing';
-import {SCLanguage, SCMetaTranslations} from '../types/i18n';
-import {SCISO8601Duration} from '../types/Time';
-import {SCPersonWithoutReferences} from './Person';
+import {SCLanguage, SCMetaTranslations} from '../general/i18n';
+import {SCISO8601Duration} from '../general/time';
+import {SCCreativeWork, SCCreativeWorkMeta, SCCreativeWorkWithoutReferences} from './abstract/creative-work';
+import {SCThingMeta, SCThingType} from './abstract/thing';
+import {SCPersonWithoutReferences} from './person';
 
 /**
  * A video without references
@@ -35,6 +35,8 @@ export interface SCVideoWithoutReferences
 
   /**
    * URLs to a thumbnails for the Video
+   *
+   * @keyword
    */
   thumbnails?: string[];
 
@@ -45,6 +47,8 @@ export interface SCVideoWithoutReferences
 
   /**
    * A Transcript of the Video
+   *
+   * @text
    */
   transcript?: string;
 
@@ -57,6 +61,8 @@ export interface SCVideoWithoutReferences
 export interface SCVideoSource {
   /**
    * Pixel Height of the Video
+   *
+   * @integer
    */
   height?: number;
 
@@ -67,16 +73,22 @@ export interface SCVideoSource {
 
   /**
    * Size of the Video File in bytes
+   *
+   * @integer
    */
   size?: number;
 
   /**
    * URL to the Video File
+   *
+   * @keyword
    */
   url: string;
 
   /**
    * Pixel Width of the Video
+   *
+   * @integer
    */
   width?: number;
 }
@@ -94,6 +106,8 @@ export interface SCVideoTrack {
 
   /**
    * URL to the Track File
+   *
+   * @keyword
    */
   url: string;
 }
@@ -102,6 +116,7 @@ export interface SCVideoTrack {
  * A video
  *
  * @validatable
+ * @indexable
  */
 export interface SCVideo
   extends SCCreativeWork, SCVideoWithoutReferences {
@@ -127,10 +142,24 @@ export class SCVideoMeta
    */
   fieldTranslations = {
     de: {
-      ...SCCreativeWorkMeta.getInstance().fieldTranslations.de,
+      ...SCCreativeWorkMeta.getInstance<SCCreativeWorkMeta>().fieldTranslations
+        .de,
+      actors: 'Darsteller',
+      duration: 'Dauer',
+      sources: 'Quellen',
+      thumbnails: 'Vorschaubilder',
+      tracks: 'Spuren',
+      transcript: 'Transkript',
     },
     en: {
-      ...SCCreativeWorkMeta.getInstance().fieldTranslations.en,
+      ...SCCreativeWorkMeta.getInstance<SCCreativeWorkMeta>().fieldTranslations
+        .en,
+      actors: 'actors',
+      duration: 'duration',
+      sources: 'sources',
+      thumbnails: 'thumbnails',
+      tracks: 'tracks',
+      transcript: 'transcript',
     },
   };
 
@@ -139,11 +168,13 @@ export class SCVideoMeta
    */
   fieldValueTranslations = {
     de: {
-      ...SCCreativeWorkMeta.getInstance().fieldValueTranslations.de,
+      ...SCCreativeWorkMeta.getInstance<SCCreativeWorkMeta>()
+        .fieldValueTranslations.de,
       type: 'Video',
     },
     en: {
-      ...SCCreativeWorkMeta.getInstance().fieldValueTranslations.en,
+      ...SCCreativeWorkMeta.getInstance<SCCreativeWorkMeta>()
+        .fieldValueTranslations.en,
       type: SCThingType.Video,
     },
   };
@@ -163,7 +194,7 @@ export type SCVideoMimeType =
  * Video Track Types
  */
 export type SCVideoTrackTypes =
-  'captions'
+  'closed captions'
   | 'chapters'
   | 'description'
   | 'metadata'

src/translator.ts

@@ -12,14 +12,15 @@
  * 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 {SCClasses} from './Classes';
-import {SCThing, SCThingType} from './Thing';
-
-import {isThing} from './types/Guards';
-import {SCTranslations} from './types/i18n';
-
 import clone = require('fast-clone');
 import {Defined, OCType} from 'ts-optchain';
+import {SCTranslations} from './general/i18n';
+import {isThing} from './guards';
+import {SCClasses} from './meta';
+import {SCThing, SCThingType} from './things/abstract/thing';
+
+// tslint:disable:no-any
+const standardCacheSize = 200;
 
 /**
  * SCThingTranslator class
@@ -30,25 +31,23 @@ export class SCThingTranslator {
    * Property representing the translators target language
    */
   private _language: keyof SCTranslations<SCThing>;
-
   /**
    * Property representing the translators base language
    * This means every translation is given for this language
    */
-  private cache: LRUCache<SCThing>;
+  private readonly cache: LRUCache<SCThing>;
 
   /**
    * Property providing a mapping from a SCThingType to its known own meta class
    */
-  private metaClasses: typeof SCClasses;
+  private readonly metaClasses: typeof SCClasses;
 
-  /** 
-   * @constructor
+  /**
    * @example
    * // returns translator instance for german
    * new SCThingTranslator('de');
    */
-  constructor(language: keyof SCTranslations<SCThing>, cacheCapacity: number = 200) {
+  constructor(language: keyof SCTranslations<SCThing>, cacheCapacity: number = standardCacheSize) {
     this.cache = new LRUCache(cacheCapacity);
     this._language = language;
     this.metaClasses = SCClasses;
@@ -79,16 +78,19 @@ export class SCThingTranslator {
    * @param data The intermediate object / primitive returned by the Proxys get() method
    * @returns an OCType<T> object allowing for access to translations or a translated value(s)
    */
+  // tslint:disable-next-line:prefer-function-over-method
   private deeptranslate<T>(data?: T): OCType<T> {
     const proxy = new Proxy(
       ((defaultValue?: Defined<T>) => (data == null ? defaultValue : data)) as OCType<T>,
       {
         get: (target, key) => {
           const obj: any = target();
+
           return this.deeptranslate(obj[key]);
         },
       },
     );
+
     return proxy;
   }
 
@@ -109,30 +111,34 @@ export class SCThingTranslator {
 
     // Assigns every property in fieldTranslations to the known base language translation
     if (typeof metaClass.fieldTranslations.en !== 'undefined') {
-      Object.keys(metaClass.fieldTranslations.en).forEach((key) => {
-        (fieldTranslations as any)[key] = metaClass.fieldTranslations.en[key];
-      });
+      Object.keys(metaClass.fieldTranslations.en)
+        .forEach((key) => {
+          (fieldTranslations as any)[key] = metaClass.fieldTranslations.en[key];
+        });
     }
 
     // Assigns every property in fieldTranslations to the known translation in given language
     if (typeof metaClass.fieldTranslations[language] !== 'undefined') {
-      Object.keys(metaClass.fieldTranslations[language]).forEach((key) => {
-        (fieldTranslations as any)[key] = metaClass.fieldTranslations[language][key];
-      });
+      Object.keys(metaClass.fieldTranslations[language])
+        .forEach((key) => {
+          (fieldTranslations as any)[key] = metaClass.fieldTranslations[language][key];
+        });
     }
+
     return fieldTranslations;
   }
 
   /**
    * Returns meta class needed for translations given a SCThingType
    *
-   * @param thingType 
+   * @param thingType Type of the thing
    * @returns An instance of the metaclass
    */
   private getMetaClassInstance(thingType: SCThingType): any {
     if (thingType in this.metaClasses) {
       return new (this.metaClasses as any)[thingType]();
     }
+
     return undefined;
   }
 
@@ -151,19 +157,22 @@ export class SCThingTranslator {
       return instance;
     }
     if (typeof metaClass.fieldValueTranslations[language] !== 'undefined') {
-      Object.keys(metaClass.fieldValueTranslations[language]).forEach((key) => {
-        if (metaClass.fieldValueTranslations[language][key] instanceof Object) {
-          // Assigns known translations of subproperties to property in given language (e.g. categories)
-          Object.keys((instance as any)[key]).forEach((subKey) => {
-            (instance as any)[key][subKey] =
-              metaClass.fieldValueTranslations[language][key][(instance as any)[key][subKey]];
-          });
-        } else {
-          // Assigns property to known translation of fieldValueTranslations in given language
-          (instance as any)[key] = metaClass.fieldValueTranslations[language][key];
-        }
-      });
+      Object.keys(metaClass.fieldValueTranslations[language])
+        .forEach((key) => {
+          if (metaClass.fieldValueTranslations[language][key] instanceof Object) {
+            // Assigns known translations of subproperties to property in given language (e.g. categories)
+            Object.keys((instance as any)[key])
+              .forEach((subKey) => {
+                (instance as any)[key][subKey] =
+                  metaClass.fieldValueTranslations[language][key][(instance as any)[key][subKey]];
+              });
+          } else {
+            // Assigns property to known translation of fieldValueTranslations in given language
+            (instance as any)[key] = metaClass.fieldValueTranslations[language][key];
+          }
+        });
     }
+
     return instance;
   }
 
@@ -192,6 +201,7 @@ export class SCThingTranslator {
           }
           const objTranslated = this.translateWholeThingDestructively(clone(obj));
           this.cache.putObject(objTranslated);
+
           return this.deeptranslate(objTranslated[key]);
         },
       },
@@ -204,13 +214,13 @@ export class SCThingTranslator {
    * @example
    * const translatedMetaDish = translator.translatedPropertyNames<SCCourseOfStudies>(SCThingType.CourseOfStudies);
    * @param language The language the object is translated to
-   * @param thingType
+   * @param thingType Type of the thing
    * @returns An object with the properties of the SCThingType where the values are the known property tranlations
    */
   public translatedPropertyNames<T extends SCThing>(thing: T,
                                                     language?: keyof SCTranslations<T>): T | undefined {
-    const targetLanguage = (language) ? language : this.language;
-    // return {...{}, ...this.getAllMetaFieldTranslations(thing.type, targetLanguage) as T};
+    const targetLanguage = (typeof language !== 'undefined') ? language : this.language;
+
     return this.getAllMetaFieldTranslations(thing.type, targetLanguage) as T;
   }
 
@@ -224,47 +234,49 @@ export class SCThingTranslator {
    */
   public translateWholeThingDestructively(instance: any,
                                           language?: keyof SCTranslations<any>): any {
-    const targetLanguage = (language) ? language : this.language;
+    const targetLanguage = (typeof language !== 'undefined') ? language : this.language;
+    let nextInstance = instance;
     // Recursively call this function on all nested SCThings, arrays and objects
-    Object.keys(instance).forEach((key) => {
-      if (
-        isThing((instance as any)[key]) ||
-        instance[key] instanceof Array ||
-        instance[key] instanceof Object) {
-        instance[key] = this.translateWholeThingDestructively(instance[key], targetLanguage);
-      }
-    });
+    Object.keys(nextInstance)
+      .forEach((key) => {
+        if (
+          isThing((nextInstance as any)[key]) ||
+          nextInstance[key] instanceof Array ||
+          nextInstance[key] instanceof Object) {
+          nextInstance[key] = this.translateWholeThingDestructively(nextInstance[key], targetLanguage);
+        }
+      });
 
     // Spread variable translations given by the connector into thing
-    if (typeof instance.translations !== 'undefined') {
-      if (typeof instance.translations![targetLanguage] !== 'undefined') {
-        instance = {...instance, ...instance.translations![targetLanguage]} as typeof instance;
+    if (typeof nextInstance.translations !== 'undefined') {
+      if (typeof nextInstance.translations![targetLanguage] !== 'undefined') {
+        nextInstance = {...nextInstance, ...nextInstance.translations![targetLanguage]} as typeof instance;
       }
     }
     // Spread known translations from meta classes into (partly) translated thing
-    this.replaceAvailableMetaFieldValueTranslations(instance, targetLanguage);
-    return instance;
+    this.replaceAvailableMetaFieldValueTranslations(nextInstance, targetLanguage);
+
+    return nextInstance;
   }
 
 }
 
 /**
- * LRUCache class 
+ * LRUCache class
  * Small last recently used cache intended to get used by SCThingTranslator
  */
 class LRUCache<T> {
   /**
    * Map property that manages cached content
    */
-  private entries: Map<string, T> = new Map<string, T>();
+  private readonly entries: Map<string, T> = new Map<string, T>();
 
   /**
    * Property representing cache maximum capacity
    */
-  private maxEntries: number;
+  private readonly maxEntries: number;
 
-  /** 
-   * @constructor
+  /**
    * @example
    * // returns LRUCache instance with a maximum capacity of 500
    * new LRUCache(500);
@@ -293,7 +305,7 @@ class LRUCache<T> {
   /**
    * Get content from cache by key or by another objects uid
    *
-   * @param somethingOrKey The key which maps to the cached content or an object for which content has been cached 
+   * @param somethingOrKey The key which maps to the cached content or an object for which content has been cached
    * @returns If available the content connected to the key or somethingOrKey.uid property
    */
   public get<U extends SCThing>(somethingOrKey: string | U): T | undefined {
@@ -307,11 +319,12 @@ class LRUCache<T> {
     }
 
     const entry = this.entries.get(key);
-    if (entry) {
+    if (typeof entry !== 'undefined') {
       // LRU behavior
       this.entries.delete(key);
       this.entries.set(key, entry);
     }
+
     return entry;
   }
 
@@ -324,7 +337,8 @@ class LRUCache<T> {
   public put(key: string, content: T) {
     if (this.entries.size >= this.maxEntries) {
       // LRU behavior
-      const keyToDelete = this.entries.keys().next().value;
+      const keyToDelete = this.entries.keys()
+        .next().value;
       this.entries.delete(keyToDelete);
     }
     this.entries.set(key, content);
@@ -332,10 +346,10 @@ class LRUCache<T> {
 
   /**
    * Place content in cache by another objects uid
-   * 
+   *
    * @param something The object that should be cached under something.uid
    */
   public putObject<U extends SCThing>(something: U) {
-      this.put(something.uid, (something as any) as T);
+    this.put(something.uid, (something as any) as T);
   }
 }

test/Guards.spec.ts

@@ -1,57 +0,0 @@
-/*
- * Copyright (C) 2018, 2019 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 {expect} from 'chai';
-import {slow, suite, test, timeout} from 'mocha-typescript';
-import {SCThingOriginType, SCThingType} from '../src/core/Thing';
-import {SCDish} from '../src/core/things/Dish';
-import {isThing} from '../src/core/types/Guards';
-
-@suite(timeout(10000), slow(5000))
-export class GuardsSpec {
-  @test
-  public isThing() {
-    const notADish = {
-      categories: [
-        'appetizer',
-      ],
-      name: 'foo',
-      origin: {
-        created: '',
-        type: SCThingOriginType.User,
-      },
-      type: 'foobar',
-      uid: 'bar',
-    };
-
-    const dish: SCDish = {
-      categories: [
-        'appetizer',
-      ],
-      name: 'foo',
-      origin: {
-        created: '',
-        type: SCThingOriginType.User,
-      },
-      type: SCThingType.Dish,
-      uid: 'bar',
-    };
-
-    expect(isThing('foo')).to.be.equal(false);
-
-    expect(isThing(notADish)).to.be.equal(false);
-
-    expect(isThing(dish)).to.be.equal(true);
-  }
-}

test/guards.spec.ts

@@ -0,0 +1,142 @@
+/*
+ * Copyright (C) 2018, 2019 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 {expect} from 'chai';
+import {slow, suite, test, timeout} from 'mocha-typescript';
+import {SCBulkResponse} from '../src/protocol/routes/bulk-request';
+import {SCMultiSearchResponse} from '../src/protocol/routes/search-multi';
+import {SCSearchResponse} from '../src/protocol/routes/search';
+import {SCThingOriginType, SCThingType} from '../src/things/abstract/thing';
+import {SCDish} from '../src/things/dish';
+import {
+  isBulkResponse,
+  isMultiSearchResponse,
+  isSearchResponse,
+  isThing,
+  isThingWithTranslations,
+} from '../src/guards';
+
+@suite(timeout(10000), slow(5000))
+export class GuardsSpec {
+
+  static bulkResponse: SCBulkResponse = {
+    expiration: '2009-06-30T18:30:00+02:00 ',
+    source: 'bar',
+    state: 'done',
+    type: SCThingType.Dish,
+    uid: 'foo',
+  };
+
+  static dishWithTranslation: SCDish = {
+    categories: [
+      'appetizer',
+    ],
+    name: 'foo',
+    origin: {
+      created: '',
+      type: SCThingOriginType.User,
+    },
+    translations: {
+      de: {
+        name: 'Foo',
+      },
+    },
+    type: SCThingType.Dish,
+    uid: 'bar',
+  };
+
+  static notADish = {
+    categories: [
+      'appetizer',
+    ],
+    name: 'foo',
+    origin: {
+      created: '',
+      type: SCThingOriginType.User,
+    },
+    type: 'foobar',
+    uid: 'bar',
+  };
+
+  static searchResponse: SCSearchResponse = {
+    data: [
+      GuardsSpec.dishWithTranslation,
+    ],
+    facets: [
+      {
+       buckets: [
+         {
+          count: 1,
+          key: 'key',
+         },
+        ],
+       field: 'field',
+      },
+    ],
+    pagination: {
+      count: 1,
+      offset: 0,
+      total: 1,
+    },
+    stats: {
+      time: 1,
+    },
+  };
+
+  @test
+  public isBulkResponse() {
+    expect(isBulkResponse(null)).to.be.equal(false);
+    expect(isBulkResponse(GuardsSpec.dishWithTranslation)).to.be.equal(false);
+    expect(isBulkResponse(GuardsSpec.bulkResponse)).to.be.equal(true);
+  }
+
+  @test
+  public isMultiSearchResponse() {
+    const multiSearchResponse: SCMultiSearchResponse = {
+      foo: GuardsSpec.searchResponse,
+    };
+    expect(isMultiSearchResponse(multiSearchResponse)).to.be.equal(true);
+    const notAMultiSearchResponse = {...multiSearchResponse, ...{bar: 'baz'}};
+    expect(isMultiSearchResponse(notAMultiSearchResponse)).to.be.equal(false);
+    delete multiSearchResponse.foo;
+    expect(isMultiSearchResponse(multiSearchResponse)).to.be.equal(false);
+  }
+
+  @test
+  public isSearchResponse() {
+    const notASearchResponse = {...GuardsSpec.searchResponse};
+    delete notASearchResponse.pagination;
+    expect(isSearchResponse(notASearchResponse)).to.be.equal(false);
+    delete notASearchResponse.data;
+    expect(isSearchResponse(notASearchResponse)).to.be.equal(false);
+    expect(isSearchResponse(null)).to.be.equal(false);
+    expect(isSearchResponse(GuardsSpec.searchResponse)).to.be.equal(true);
+  }
+
+  @test
+  public isThing() {
+    expect(isThing('foo')).to.be.equal(false);
+    expect(isThing({type: 'foo'})).to.be.equal(false);
+    expect(isThing(GuardsSpec.notADish)).to.be.equal(false);
+    expect(isThing(GuardsSpec.dishWithTranslation)).to.be.equal(true);
+  }
+
+  @test
+  public isThingWithTranslations() {
+    const dishWithoutTranslation = {...GuardsSpec.dishWithTranslation};
+    delete dishWithoutTranslation.translations;
+    expect(isThingWithTranslations(dishWithoutTranslation)).to.be.equal(false);
+    expect(isThingWithTranslations(GuardsSpec.dishWithTranslation)).to.be.equal(true);
+  }
+}

test/resources/DateSeries.2.json

@@ -21,7 +21,7 @@
       ],
       "uid": "b535c86a-777b-54c3-b89a-cad528d0580f",
       "name": "EMH 225",
-      "floor": "2"
+      "floorName": "2"
     },
     "frequency": "once",
     "dates": [