0.49.0

Add backwards compatibility check with typescript v3.8.3

.gitlab-ci.yml

@@ -5,6 +5,7 @@ before_script:
 
 stages:
   - build
+  - review
   - test
   - audit
   - deploy
@@ -21,6 +22,46 @@ build:
       - lib
     expire_in: 1 week
 
+build-ts-3.8.3:
+  tags:
+    - performance
+  stage: build
+  script:
+    - npm uninstall typescript
+    - npm install typescript@3.8.3
+    - npm run build
+
+docs_review:
+  dependencies:
+    - build
+  stage: review
+  script:
+    - npm run documentation
+    - ./node_modules/.bin/surge -p ./docs -d https://$CI_PROJECT_PATH_SLUG-$CI_ENVIRONMENT_SLUG.surge.sh/
+  when: manual
+  environment:
+    name: review/$CI_PROJECT_PATH_SLUG-$CI_COMMIT_REF_NAME
+    url: https://$CI_PROJECT_PATH_SLUG-$CI_ENVIRONMENT_SLUG.surge.sh/
+    on_stop: stop_review
+  except:
+    - master
+    - develop
+  tags:
+    - secrecy
+
+stop_review:
+  stage: review
+  variables:
+    GIT_STRATEGY: none
+  script:
+    - ./node_modules/.bin/surge teardown $CI_PROJECT_PATH_SLUG-$CI_ENVIRONMENT_SLUG.surge.sh
+  when: manual
+  environment:
+    name: review/$CI_PROJECT_PATH_SLUG-$CI_COMMIT_REF_NAME
+    action: stop
+  tags:
+    - secrecy
+
 audit:
   stage: audit
   script:
@@ -47,6 +88,21 @@ test:
       - report
       - coverage
 
+mapping:
+  tags:
+    - performance
+  dependencies:
+    - build
+  stage: test
+  services:
+    - name: registry.gitlab.com/openstapps/database:master
+      alias: elasticsearch
+  script:
+    - npm run mappings-integration
+  artifacts:
+    paths:
+      - lib
+
 package:
   dependencies:
     - build

.mailmap

@@ -0,0 +1,5 @@
+Rainer Killinger <mail-openstapps@killinger.co> Rainer Killinger <git@killinger.co>
+Rainer Killinger <mail-openstapps@killinger.co> Rainer Killinger <killinge@hrz.uni-frankfurt.de>
+Rainer Killinger <mail-openstapps@killinger.co> Rainer Killinger <killinger@hrz.uni-frankfurt.de>
+Wieland Schöbl <wulkanat@gmail.com> wulkanat@gmail.com <wulkanat@gmail.com>
+Wieland Schöbl <wulkanat@gmail.com> Wieland Schöbl <wieland.schoebl@campus.tu-berlin.de>

CHANGELOG.md

@@ -1,3 +1,70 @@
+# [0.48.0](https://gitlab.com/openstapps/core/compare/v0.47.0...v0.48.0) (2021-07-14)
+
+
+### Bug Fixes
+
+* correct parameter name of thing update route ([872c1f5](https://gitlab.com/openstapps/core/commit/872c1f5fc3884b6df6f5025287873d98b27dd6b1))
+
+
+### Features
+
+* support geo shape queries ([882483e](https://gitlab.com/openstapps/core/commit/882483ee2490938014904bc26687bd1648992ae6))
+
+
+
+# [0.47.0](https://gitlab.com/openstapps/core/compare/v0.46.0...v0.47.0) (2021-06-15)
+
+
+### Bug Fixes
+
+* set date-series frequency non translatable ([4a4cd4e](https://gitlab.com/openstapps/core/commit/4a4cd4e6d4b01ac34b5338dfcf4aeb959f54461d))
+
+
+### Features
+
+* make SCDateSeries.frequency compliant with schema.org ([942cd11](https://gitlab.com/openstapps/core/commit/942cd1146966aa9e60321160489a6605877925e9))
+
+
+
+# [0.46.0](https://gitlab.com/openstapps/core/compare/v0.45.0...v0.46.0) (2021-05-04)
+
+
+### Features
+
+* change range offer to use date range ([9c6972a](https://gitlab.com/openstapps/core/commit/9c6972af787678567409877b6bc9f9417e1374e2))
+
+
+
+# [0.45.0](https://gitlab.com/openstapps/core/compare/v0.44.0...v0.45.0) (2021-04-26)
+
+
+
+# [0.44.0](https://gitlab.com/openstapps/core/compare/v0.43.0...v0.44.0) (2021-04-12)
+
+
+### Features
+
+* add support for multiple values in the value filter ([913c569](https://gitlab.com/openstapps/core/commit/913c5691da46ad2591fe14bcf7286f12b29ab5ee))
+
+
+
+# [0.43.0](https://gitlab.com/openstapps/core/compare/v0.42.0...v0.43.0) (2021-04-07)
+
+
+
+# [0.42.0](https://gitlab.com/openstapps/core/compare/v0.41.0...v0.42.0) (2021-02-16)
+
+
+
+# [0.41.0](https://gitlab.com/openstapps/core/compare/v0.40.0...v0.41.0) (2021-02-08)
+
+
+### Bug Fixes
+
+* add date, numeric range filter to SCSearchFilter ([8510f11](https://gitlab.com/openstapps/core/commit/8510f11d7b4c62a6b239a70f47fe07e8cc86ab63))
+
+
+
 # [0.40.0](https://gitlab.com/openstapps/core/compare/v0.39.0...v0.40.0) (2021-02-05)
 
 

README.md

@@ -45,7 +45,7 @@ External dependencies can not be covered by the annotations. Documentation about
 | `@sortable`       | field is sortable if the core schema is used to put data into a database/key-value store. Fields are always sortable through generic sort, even without annotation.                                | sort method to be used: `ducet`, `price`, `distance`                             |
 | `@text`           | string field is interpreted as text                                                                                     |                                                                                  |
 | `@date`  | string field is interpreted as a date field | |
-| `@validatable`    | marks the type as validatable if the core schema is used to put data into a database/key-value store                    |                                                                                  |
+| `@validatable`    | Marks the type for json schema generation, which can be checked at runtime. Any top-level type that is put into a database should always be marked as validatable.                   |                                                                                  |
 | `@filterable`     | non-object/nested field is filterable if the core schema is used to put data into a database/key-value store            |                                                                                  |
 | `@inheritTags`    | inherit all tags from another field                                                                                     | `[SCThingType]::[field]`                                                         |
 

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openstapps/core",
-  "version": "0.41.0",
+  "version": "0.49.0",
   "description": "StAppsCore - Generalized model of data",
   "keywords": [
     "Model",
@@ -14,7 +14,7 @@
   "main": "./lib/index.js",
   "types": "./lib/index.d.ts",
   "scripts": {
-    "build": "npm run tslint && npm run compile && npm run pack && npm run schema",
+    "build": "npm run tslint && npm run compile && npm run pack && npm run schema && npm run mappings",
     "changelog": "conventional-changelog -p angular -i CHANGELOG.md -s -r 0 && git add CHANGELOG.md && git commit -m 'docs: update changelog'",
     "check-configuration": "openstapps-configuration",
     "compile": "rimraf lib && tsc",
@@ -25,6 +25,8 @@
     "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",
+    "mappings": "mkdir lib/mappings && openstapps-es-mapping-generator mapping ../core/src -i minlength,pattern,see,tjs-format -m lib/mappings/mappings.json -a lib/mappings/aggregations.json",
+    "mappings-integration": "openstapps-es-mapping-generator put-es-templates lib/mappings/mappings.json http://elasticsearch:9200/",
     "test": "nyc mocha --require ts-node/register --recursive 'test/*.spec.ts'",
     "tslint": "tslint -p tsconfig.json -c tslint.json 'src/**/*.ts'"
   },
@@ -32,44 +34,48 @@
   "contributors": [
     "Andreas Lehmann",
     "Anselm Stordeur <anselmstordeur@gmail.com>",
+    "Axel Nieder-Vahrenholz",
     "Benjamin Jöckel",
-    "Imran Hossain",
+    "Frank Nagel",
     "Jovan Krunić <jovan.krunic@gmail.com>",
     "Michel Jonathan Schmitz",
     "Rainer Killinger <mail-openstapps@killinger.co>",
+    "Roman Klopsch",
     "Sebastian Lange",
-    "Wieland Schöbl",
-    "Roman Klopsch"
+    "Wieland Schöbl"
   ],
   "dependencies": {
-    "@openstapps/core-tools": "0.16.0",
+    "@openstapps/core-tools": "0.23.2",
     "@types/geojson": "1.0.6",
     "@types/json-patch": "0.0.30",
-    "@types/json-schema": "7.0.6",
-    "@types/node": "10.17.44",
+    "@types/json-schema": "7.0.9",
+    "@types/node": "14.17.9",
     "fast-clone": "1.5.13",
+    "fast-deep-equal": "3.1.3",
     "http-status-codes": "2.1.4",
     "json-patch": "0.7.0",
-    "json-schema": "0.2.5",
+    "json-schema": "0.3.0",
     "ts-optchain": "0.1.8"
   },
   "devDependencies": {
-    "@openstapps/configuration": "0.25.0",
-    "@openstapps/logger": "0.5.0",
+    "@openstapps/configuration": "0.27.0",
+    "@openstapps/es-mapping-generator": "0.0.3",
+    "@openstapps/logger": "0.7.0",
     "@testdeck/mocha": "0.1.2",
-    "@types/chai": "4.2.14",
-    "@types/rimraf": "3.0.0",
-    "chai": "4.2.0",
+    "@types/chai": "4.2.21",
+    "@types/rimraf": "3.0.1",
+    "chai": "4.3.4",
     "conditional-type-checks": "1.0.5",
-    "conventional-changelog-cli": "2.1.0",
-    "mocha": "8.2.0",
+    "conventional-changelog-cli": "2.1.1",
+    "mocha": "8.4.0",
     "nyc": "15.1.0",
     "rimraf": "3.0.2",
     "source-map-support": "0.5.19",
-    "ts-node": "9.0.0",
+    "surge": "0.23.0",
+    "ts-node": "9.1.1",
     "tslint": "6.1.3",
-    "typedoc": "0.18.0",
-    "typescript": "3.8.3"
+    "typedoc": "0.21.5",
+    "typescript": "4.3.5"
   },
   "nyc": {
     "all": true,

src/config/app.ts

@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2019 StApps
+ * Copyright (C) 2019-2021 StApps
  * This program is free software: you can redistribute it and/or modify it
  * under the terms of the GNU General Public License as published by the Free
  * Software Foundation, version 3.
@@ -15,7 +15,7 @@
 // tslint:disable-next-line:no-implicit-dependencies
 import {Polygon} from 'geojson';
 import {SCTranslations} from '../general/i18n';
-import {SCSetting} from '../things/setting';
+import {SCLanguageSetting, SCSetting, SCUserGroupSetting} from '../things/setting';
 
 /**
  * An app configuration menu item
@@ -112,8 +112,9 @@ export interface SCAppConfiguration {
 
   /**
    * A list of available settings in the app
+   * !Important! Use provided specific settings, for other settings use general SCSetting
    */
-  settings: SCSetting[];
+  settings: Array<SCUserGroupSetting | SCLanguageSetting | SCSetting>;
 
   /**
    * Map of store URLs

src/meta.ts

@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2019 StApps
+ * Copyright (C) 2019-2021 StApps
  * This program is free software: you can redistribute it and/or modify it
  * under the terms of the GNU General Public License as published by the Free
  * Software Foundation, version 3.
@@ -27,8 +27,14 @@ import {SCFavorite, SCFavoriteMeta, SCFavoriteWithoutReferences} from './things/
 import {SCFloor, SCFloorMeta, SCFloorWithoutReferences} from './things/floor';
 import {SCMessage, SCMessageMeta, SCMessageWithoutReferences} from './things/message';
 import {SCOrganization, SCOrganizationMeta, SCOrganizationWithoutReferences} from './things/organization';
+import {SCPeriodical, SCPeriodicalMeta, SCPeriodicalWithoutReferences} from './things/periodical';
 import {SCPerson, SCPersonMeta, SCPersonWithoutReferences} from './things/person';
 import {SCPointOfInterest, SCPointOfInterestMeta, SCPointOfInterestWithoutReferences} from './things/point-of-interest';
+import {
+  SCPublicationEvent,
+  SCPublicationEventMeta,
+  SCPublicationEventWithoutReferences,
+} from './things/publication-event';
 import {SCRoom, SCRoomMeta, SCRoomWithoutReferences} from './things/room';
 import {SCSemester, SCSemesterMeta, SCSemesterWithoutReferences} from './things/semester';
 import {SCSetting, SCSettingMeta, SCSettingWithoutReferences} from './things/setting';
@@ -59,8 +65,10 @@ export const SCClasses: { [K in SCThingType]: object } = {
   'floor': SCFloorMeta,
   'message': SCMessageMeta,
   'organization': SCOrganizationMeta,
+  'periodical': SCPeriodicalMeta,
   'person': SCPersonMeta,
   'point of interest': SCPointOfInterestMeta,
+  'publication event': SCPublicationEventMeta,
   'room': SCRoomMeta,
   'semester': SCSemesterMeta,
   'setting': SCSettingMeta,
@@ -72,7 +80,7 @@ export const SCClasses: { [K in SCThingType]: object } = {
   'video': SCVideoMeta,
 };
 
-export type SCThingsWithoutDiff =
+export type SCIndexableThings =
   SCAcademicEvent
   | SCArticle
   | SCBook
@@ -82,15 +90,15 @@ export type SCThingsWithoutDiff =
   | SCCourseOfStudies
   | SCDateSeries
   | SCDish
-  | SCFavorite
   | SCFloor
   | SCMessage
   | SCOrganization
+  | SCPeriodical
   | SCPerson
   | SCPointOfInterest
+  | SCPublicationEvent
   | SCRoom
   | SCSemester
-  | SCSetting
   | SCSportCourse
   | SCStudyModule
   | SCTicket
@@ -102,8 +110,8 @@ export type SCThingsWithoutDiff =
  * An object that exists in the StAppsCore
  */
 export type SCThings =
-  SCThingsWithoutDiff
-  | SCDiff;
+  SCIndexableThings
+  | SCDiff | SCFavorite | SCSetting;
 
 /**
  * A field of a thing
@@ -128,18 +136,20 @@ export type SCAssociatedThingWithoutReferences<THING extends SCThings> =
                         THING extends SCFloor ? SCFloorWithoutReferences :
                           THING extends SCMessage ? SCMessageWithoutReferences :
                             THING extends SCOrganization ? SCOrganizationWithoutReferences :
-                              THING extends SCPerson ? SCPersonWithoutReferences :
-                                THING extends SCPointOfInterest ? SCPointOfInterestWithoutReferences :
-                                  THING extends SCRoom ? SCRoomWithoutReferences :
-                                    THING extends SCSemester ? SCSemesterWithoutReferences :
-                                      THING extends SCSetting ? SCSettingWithoutReferences :
-                                        THING extends SCSportCourse ? SCSportCourseWithoutReferences :
-                                          THING extends SCStudyModule ? SCStudyModuleWithoutReferences :
-                                            THING extends SCTicket ? SCTicketWithoutReferences :
-                                              THING extends SCToDo ? SCToDoWithoutReferences :
-                                                THING extends SCTour ? SCTourWithoutReferences :
-                                                  THING extends SCVideo ? SCVideoWithoutReferences :
-                                                    never;
+                              THING extends SCPeriodical ? SCPeriodicalWithoutReferences :
+                                THING extends SCPerson ? SCPersonWithoutReferences :
+                                  THING extends SCPointOfInterest ? SCPointOfInterestWithoutReferences :
+                                    THING extends SCPublicationEvent ? SCPublicationEventWithoutReferences :
+                                      THING extends SCRoom ? SCRoomWithoutReferences :
+                                        THING extends SCSemester ? SCSemesterWithoutReferences :
+                                          THING extends SCSetting ? SCSettingWithoutReferences :
+                                            THING extends SCSportCourse ? SCSportCourseWithoutReferences :
+                                              THING extends SCStudyModule ? SCStudyModuleWithoutReferences :
+                                                THING extends SCTicket ? SCTicketWithoutReferences :
+                                                  THING extends SCToDo ? SCToDoWithoutReferences :
+                                                    THING extends SCTour ? SCTourWithoutReferences :
+                                                      THING extends SCVideo ? SCVideoWithoutReferences :
+                                                        never;
 
 /**
  * Thing for a thing without references
@@ -159,15 +169,17 @@ export type SCAssociatedThing<THING extends SCThings> =
                         THING extends SCFloorWithoutReferences ? SCFloor :
                           THING extends SCMessageWithoutReferences ? SCMessage :
                             THING extends SCOrganizationWithoutReferences ? SCOrganization :
-                              THING extends SCPersonWithoutReferences ? SCPerson :
-                                THING extends SCPointOfInterestWithoutReferences ? SCPointOfInterest :
-                                  THING extends SCRoomWithoutReferences ? SCRoom :
-                                    THING extends SCSemesterWithoutReferences ? SCSemester :
-                                      THING extends SCSettingWithoutReferences ? SCSetting :
-                                        THING extends SCSportCourseWithoutReferences ? SCSportCourse :
-                                          THING extends SCStudyModuleWithoutReferences ? SCStudyModule :
-                                            THING extends SCTicketWithoutReferences ? SCTicket :
-                                              THING extends SCToDoWithoutReferences ? SCToDo :
-                                                THING extends SCTourWithoutReferences ? SCTour :
-                                                  THING extends SCVideoWithoutReferences ? SCVideo :
-                                                    never;
+                              THING extends SCPeriodicalWithoutReferences ? SCPeriodical :
+                                THING extends SCPersonWithoutReferences ? SCPerson :
+                                  THING extends SCPointOfInterestWithoutReferences ? SCPointOfInterest :
+                                    THING extends SCPublicationEventWithoutReferences ? SCPublicationEvent :
+                                      THING extends SCRoomWithoutReferences ? SCRoom :
+                                        THING extends SCSemesterWithoutReferences ? SCSemester :
+                                          THING extends SCSettingWithoutReferences ? SCSetting :
+                                            THING extends SCSportCourseWithoutReferences ? SCSportCourse :
+                                              THING extends SCStudyModuleWithoutReferences ? SCStudyModule :
+                                                THING extends SCTicketWithoutReferences ? SCTicket :
+                                                  THING extends SCToDoWithoutReferences ? SCToDo :
+                                                    THING extends SCTourWithoutReferences ? SCTour :
+                                                      THING extends SCVideoWithoutReferences ? SCVideo :
+                                                        never;

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

@@ -17,6 +17,8 @@ import {SCError} from '../error';
 
 /**
  * An error that is returned, when an internal server error occurred
+ *
+ * @validatable
  */
 export class SCInternalServerErrorResponse extends SCError {
   /**

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

@@ -17,6 +17,8 @@ import {SCError} from '../error';
 
 /**
  * An error that is returned, when the used HTTP method is not allowed on the requested route
+ *
+ * @validatable
  */
 export class SCMethodNotAllowedErrorResponse extends SCError {
   /**

src/protocol/errors/not-found.ts

@@ -17,6 +17,8 @@ import {SCError} from '../error';
 
 /**
  * An error that is returned when the requested route or resource was not found
+ *
+ * @validatable
  */
 export class SCNotFoundErrorResponse extends SCError {
   /**

src/protocol/errors/parameters-not-acceptable.ts

@@ -18,6 +18,8 @@ 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.
+ *
+ * @validatable
  */
 export class SCParametersNotAcceptable extends SCError {
   /**

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

@@ -20,6 +20,8 @@ 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.
+ *
+ * @validatable
  */
 export class SCPluginAlreadyRegisteredErrorResponse extends SCError {
   /**

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

@@ -17,6 +17,8 @@ import {SCError} from '../error';
 
 /**
  * An error that is returned whenever there is an unexpected error while creating a plugin
+ *
+ * @validatable
  */
 export class SCPluginRegisteringFailedErrorResponse extends SCError {
   /**

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

@@ -17,6 +17,8 @@ import {SCError} from '../error';
 
 /**
  * An error that is returned, when the request body is too large.
+ *
+ * @validatable
  */
 export class SCRequestBodyTooLargeErrorResponse extends SCError {
   /**

src/protocol/errors/syntax-error.ts

@@ -17,6 +17,8 @@ import {SCError} from '../error';
 
 /**
  * An error that is returned whenever there is a syntax error
+ * 
+ * @validatable
  */
 export class SCSyntaxErrorResponse extends SCError {
   /**

src/protocol/errors/too-many-requests.ts

@@ -17,6 +17,8 @@ import {SCError} from '../error';
 
 /**
  * An error that is returned, when to many request are submitted at once
+ * 
+ * @validatable
  */
 export class SCTooManyRequestsErrorResponse extends SCError {
   /**

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

@@ -17,6 +17,8 @@ import {SCError} from '../error';
 
 /**
  * An error that is returned when the content type of the request is not supported
+ *
+ * @validatable
  */
 export class SCUnsupportedMediaTypeErrorResponse extends SCError {
   /**

src/protocol/errors/validation.ts

@@ -18,6 +18,8 @@ import {SCError} from '../error';
 
 /**
  * An error that is returned when the validation of a request fails
+ *
+ * @validatable
  */
 export class SCValidationErrorResponse extends SCError {
   /**

src/protocol/routes/thing-update.ts

@@ -55,7 +55,7 @@ export class SCThingUpdateRoute extends SCAbstractRoute {
     ];
     this.method = SCRouteHttpVerbs.PUT;
     this.obligatoryParameters = {
-      TYPE: 'SCThingTypes',
+      TYPE: 'SCThingType',
       UID: 'SCUuid',
     };
     this.requestBodyName = 'SCThingUpdateRequest';

src/protocol/search/filter.ts

@@ -19,6 +19,7 @@ import {SCMap} from '../../general/map';
 import {SCSearchAvailabilityFilter} from './filters/availability';
 import {SCSearchBooleanFilter} from './filters/boolean';
 import {SCSearchDistanceFilter} from './filters/distance';
+import {SCGeoFilter} from './filters/geo';
 import {SCSearchDateRangeFilter, SCSearchNumericRangeFilter} from './filters/range';
 import {SCSearchValueFilter} from './filters/value';
 
@@ -31,7 +32,8 @@ export type SCSearchFilterType =
   | 'distance'
   | 'value'
   | 'date range'
-  | 'numeric range';
+  | 'numeric range'
+  | 'geo';
 
 /**
  * Structure of a filter instruction
@@ -62,4 +64,5 @@ export type SCSearchFilter =
   | SCSearchDistanceFilter
   | SCSearchValueFilter
   | SCSearchNumericRangeFilter
-  | SCSearchDateRangeFilter;
+  | SCSearchDateRangeFilter
+  | SCGeoFilter;

src/protocol/search/filters/availability.ts

@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2019 StApps
+ * Copyright (C) 2019-2021 StApps
  * This program is free software: you can redistribute it and/or modify it
  * under the terms of the GNU General Public License as published by the Free
  * Software Foundation, version 3.
@@ -33,17 +33,17 @@ export interface SCSearchAvailabilityFilter extends SCSearchAbstractFilter<SCAva
  */
 export interface SCAvailabilityFilterArguments extends SCSearchAbstractFilterArguments {
   /**
-   * Field which marks the start of the availability
+   * Field which marks availability range
    */
-  fromField: SCThingsField;
+  field: SCThingsField;
 
   /**
-   * Time to check. Defaults to 'now'
+   * If set, the provided time will apply to the full hour, day, week, etc.
    */
-  time?: SCISO8601Date | 'now';
+  scope?: 's' | 'm' | 'H' | 'd' | 'w' | 'M' | 'y';
 
   /**
-   * Field which marks the end of the availability
+   * Time to check. Defaults current time if not set
    */
-  toField: SCThingsField;
+  time?: SCISO8601Date;
 }

src/protocol/search/filters/geo.ts

@@ -0,0 +1,55 @@
+/*
+ * Copyright (C) 2021 StApps
+ * This program is free software: you can redistribute it and/or modify it
+ * under the terms of the GNU General Public License as published by the Free
+ * Software Foundation, version 3.
+ *
+ * This program is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
+ * more details.
+ *
+ * You should have received a copy of the GNU General Public License along with
+ * this program. If not, see <https://www.gnu.org/licenses/>.
+ */
+// tslint:disable-next-line:no-implicit-dependencies
+import {Polygon} from 'geojson';
+import {SCThingsField} from '../../../meta';
+import {SCSearchAbstractFilter, SCSearchAbstractFilterArguments} from '../filter';
+
+/**
+ * A geo filter
+ *
+ * Filter for documents that are in relation to some geo data
+ */
+export interface SCGeoFilter extends SCSearchAbstractFilter<SCGeoFilterArguments> {
+  /**
+   * @see SCSearchAbstractFilter.type
+   */
+  type: 'geo';
+}
+
+/**
+ * Arguments for filter instruction by geo data
+ */
+export interface SCGeoFilterArguments extends SCSearchAbstractFilterArguments {
+  /**
+   * Field on which to filter
+   */
+  field: SCThingsField;
+
+  /**
+   * Geo data to check up on
+   */
+  shape: Polygon;
+
+  /**
+   * Spatial relation between the provided shape and the shape of the field.
+   *
+   * intersects - both shapes intersect (default)
+   * disjoint   - both shapes don't intersect
+   * within     - the search shape contains the field shape
+   * contains   - the search shape is contained in the field shape
+   */
+  spatialRelation?: 'intersects' | 'disjoint' | 'within' | 'contains';
+}

src/protocol/search/filters/range.ts

@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2020 StApps
+ * Copyright (C) 2020-2021 StApps
  * This program is free software: you can redistribute it and/or modify it
  * under the terms of the GNU General Public License as published by the Free
  * Software Foundation, version 3.
@@ -85,6 +85,15 @@ export interface SCRangeFilterArguments<T> extends SCSearchAbstractFilterArgumen
    * Field where the filter will be applied
    */
   field: SCThingsField;
+
+  /**
+   * Relation when searching on other range fields
+   *
+   * Intersects (Default): Both search and field range intersect
+   * Within: Search range is within the field range
+   * Contains: Search range contains the field range
+   */
+  relation?: 'intersects' | 'within' | 'contains';
 }
 
 export interface Bounds<T> {

src/protocol/search/filters/value.ts

@@ -32,7 +32,7 @@ export interface SCValueFilterArguments extends SCSearchAbstractFilterArguments
   field: SCThingsField;
 
   /**
-   * Value to filter. Value has to match the field exactly.
+   * Value to filter. One or more values has to match the field exactly.
    */
-  value: string;
+  value: string | string[];
 }

src/things/abstract/creative-work.ts

@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2019 StApps
+ * Copyright (C) 2019-2021 StApps
  * This program is free software: you can redistribute it and/or modify it
  * under the terms of the GNU General Public License as published by the Free
  * Software Foundation, version 3.
@@ -12,15 +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 {SCLanguage, SCMetaTranslations, SCTranslations} from '../../general/i18n';
+import {SCLanguageCode, SCMetaTranslations, SCTranslations} from '../../general/i18n';
 import {SCISO8601Date} from '../../general/time';
 import {SCOrganizationWithoutReferences} from '../organization';
 import {SCPersonWithoutReferences} from '../person';
+import {SCPublicationEventWithoutReferences} from '../publication-event';
 import {SCThingMeta, SCThingTranslatableProperties, SCThingWithoutReferences} from './thing';
 import {
   SCAcademicPriceGroup,
-  SCThingThatCanBeOffered,
-  SCThingThatCanBeOfferedMeta,
+  SCThingThatCanBeOffered, SCThingThatCanBeOfferedMeta,
   SCThingThatCanBeOfferedTranslatableProperties,
   SCThingThatCanBeOfferedWithoutReferences,
 } from './thing-that-can-be-offered';
@@ -30,17 +30,37 @@ import {
  */
 export interface SCCreativeWorkWithoutReferences
   extends SCThingWithoutReferences, SCThingThatCanBeOfferedWithoutReferences {
+
+  /**
+   * Languages this creative work is available in
+   */
+  availableLanguages?: SCLanguageCode[];
+
   /**
    * Date the creative work was published
-   *
-   * @filterable
    */
   datePublished?: SCISO8601Date;
 
   /**
-   * List of languages this creative work is written/recorded/... in
+   * Edition of a creative work (e.g. the book edition or edition of an article)
+   *
+   * @keyword
    */
-  inLanguages?: SCLanguage[];
+  edition?: string;
+
+  /**
+   * Date (in text form) the creative work was published for the first time
+   *
+   * @keyword
+   */
+  firstPublished?: string;
+
+  /**
+   * Languages this creative work is written/recorded/... in
+   *
+   * @filterable
+   */
+  inLanguage?: SCLanguageCode;
 
   /**
    * Keywords of the creative work
@@ -67,11 +87,26 @@ export interface SCCreativeWork
    */
   authors?: SCPersonWithoutReferences[];
 
+  /**
+   * A creative work to which the creative work belongs
+   */
+  isPartOf?: SCCreativeWorkWithoutReferences;
+
+  /**
+   * List of events at which the creative work was published
+   */
+  publications?: SCPublicationEventWithoutReferences[];
+
   /**
    * List of publishers of the creative work
    */
   publishers?: Array<SCPersonWithoutReferences | SCOrganizationWithoutReferences>;
 
+  /**
+   * A text representing on organization on whose behalf the creator was working
+   */
+  sourceOrganization?: string;
+
   /**
    * Translated fields of the creative work
    */
@@ -103,20 +138,36 @@ export class SCCreativeWorkMeta
     de: {
       ...SCThingMeta.getInstance<SCThingMeta>().fieldTranslations.de,
       ...SCThingThatCanBeOfferedMeta.getInstance().fieldTranslations.de,
-      authors: 'Authoren',
+      name: 'Titel',
+      authors: 'beteiligte Personen',
+      availableLanguages: 'verfügbare Übersetzungen',
       datePublished: 'Veröffentlichungsdatum',
-      inLanguages: 'verfügbare Übersetzungen',
+      edition: 'Ausgabe',
+      firstPublished: 'erste Veröffentlichung',
+      inLanguage: 'Inhaltssprache',
+      isPartOf: 'erschienen in',
       keywords: 'Schlagwörter',
+      lastPublished: 'aktuellste Veröffentlichung',
       publishers: 'Verleger',
+      publications: 'Veröffentlichungen',
+      sourceOrganization: 'Körperschaft',
     },
     en: {
       ...SCThingMeta.getInstance<SCThingMeta>().fieldTranslations.en,
       ...SCThingThatCanBeOfferedMeta.getInstance().fieldTranslations.en,
-      authors: 'authors',
+      name: 'title',
+      authors: 'involved persons',
+      availableLanguages: 'available languages',
       datePublished: 'release date',
-      inLanguages: 'available Languages',
+      edition: 'edition',
+      firstPublished: 'first published',
+      inLanguage: 'content language',
+      isPartOf: 'published in',
       keywords: 'keywords',
+      lastPublished: 'last published',
       publishers: 'publishers',
+      publications: 'publications',
+      sourceOrganization: 'corporation',
     },
   };
 
@@ -126,7 +177,7 @@ export class SCCreativeWorkMeta
   fieldValueTranslations = {
     de: {
       ...SCThingMeta.getInstance<SCThingMeta>().fieldValueTranslations.de,
-      ...SCThingThatCanBeOfferedMeta.getInstance().fieldValueTranslations.en,
+      ...SCThingThatCanBeOfferedMeta.getInstance().fieldValueTranslations.de,
     },
     en: {
       ...SCThingMeta.getInstance<SCThingMeta>().fieldValueTranslations.en,

src/things/abstract/range.ts

@@ -0,0 +1,64 @@
+/*
+ * Copyright (C) 2021 StApps
+ * This program is free software: you can redistribute it and/or modify it
+ * under the terms of the GNU General Public License as published by the Free
+ * Software Foundation, version 3.
+ *
+ * This program is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
+ * more details.
+ *
+ * You should have received a copy of the GNU General Public License along with
+ * this program. If not, see <https://www.gnu.org/licenses/>.
+ */
+import {SCISO8601Date} from '../../general/time';
+
+/**
+ * Date Range
+ *
+ * CAUTION: Changing the name requires changes in the core-tools premaps
+ */
+export type SCISO8601DateRange = SCRange<SCISO8601Date>;
+
+/**
+ * Generic range type
+ */
+export type SCRange<T> = {
+  /**
+   * Greater than value
+   */
+  gt?: never;
+
+  /**
+   * Greater or equal to value
+   */
+  gte?: T;
+
+  /**
+   * Greater than value
+   */
+  lt?: never;
+
+  /**
+   * Greater or equal to value
+   */
+  lte?: T;
+} | {
+  // tslint:disable:completed-docs
+  gt?: T;
+  gte?: never;
+  lt?: T;
+  lte?: never;
+} | {
+  gt?: T;
+  gte?: never;
+  lt?: never;
+  lte?: T;
+} | {
+  gt?: never;
+  gte?: T;
+  lt?: T;
+  lte?: never;
+  // tslint:enable:completed-docs
+};

src/things/abstract/saveable-thing.ts

@@ -12,6 +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 {SCIndexableThings} from '../../meta';
 import {SCThing, SCThingUserOrigin, SCThingWithoutReferences} from './thing';
 
 /**
@@ -19,18 +20,17 @@ import {SCThing, SCThingUserOrigin, SCThingWithoutReferences} from './thing';
  */
 export interface SCSaveableThingWithoutReferences
   extends SCThingWithoutReferences {
-  // noop
 }
 
 /**
  * An encapsulation of the data (e.g. a thing) that is saved, which provides additional information.
  */
-export interface SCSaveableThing<T extends SCThingWithoutReferences>
+export interface SCSaveableThing
   extends SCSaveableThingWithoutReferences, SCThing {
   /**
    * The contained data
    */
-  data: T;
+  data: SCIndexableThings;
   /**
    * Type of the origin
    */

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

@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2019 StApps
+ * Copyright (C) 2019-2021 StApps
  * This program is free software: you can redistribute it and/or modify it
  * under the terms of the GNU General Public License as published by the Free
  * Software Foundation, version 3.
@@ -13,10 +13,10 @@
  * this program. If not, see <https://www.gnu.org/licenses/>.
  */
 import {SCMetaTranslations, SCTranslations} from '../../general/i18n';
-import {SCISO8601Date} from '../../general/time';
 import {SCOrganizationWithoutReferences} from '../organization';
 import {SCPersonWithoutReferences} from '../person';
 import {SCInPlace} from './place';
+import {SCISO8601DateRange} from './range';
 import {SCThing, SCThingMeta, SCThingTranslatableProperties, SCThingWithoutReferences} from './thing';
 
 /**
@@ -100,14 +100,9 @@ export interface SCThingThatCanBeOfferedOffer<T extends SCPriceGroup>
   availability: SCThingThatCanBeOfferedAvailability;
 
   /**
-   * The time when the thing becomes unavailable as an SCISO8601Date formatted string.
+   * The time when the thing is available.
    */
-  availabilityEnds?: SCISO8601Date;
-
-  /**
-   * The time when the thing becomes available as an SCISO8601Date formatted string.
-   */
-  availabilityStarts?: SCISO8601Date;
+  availabilityRange?: SCISO8601DateRange;
 
   /**
    * List of prices that are distinct for specific groups

src/things/abstract/thing.ts

@@ -13,6 +13,7 @@
  * this program. If not, see <https://www.gnu.org/licenses/>.
  */
 import {SCMetaTranslations, SCTranslations} from '../../general/i18n';
+import {SCMap} from '../../general/map';
 import {SCISO8601Date} from '../../general/time';
 import {SCUuid} from '../../general/uuid';
 import {SCOrganizationWithoutReferences} from '../organization';
@@ -25,6 +26,7 @@ export enum SCThingType {
   AcademicEvent = 'academic event',
   Article = 'article',
   Book = 'book',
+  Periodical = 'periodical',
   Building = 'building',
   Catalog = 'catalog',
   ContactPoint = 'contact point',
@@ -38,6 +40,7 @@ export enum SCThingType {
   Organization = 'organization',
   Person = 'person',
   PointOfInterest = 'point of interest',
+  PublicationEvent = 'publication event',
   Room = 'room',
   Semester = 'semester',
   Setting = 'setting',
@@ -60,6 +63,7 @@ export interface SCThingWithoutReferences {
    * @keyword
    */
   alternateNames?: string[];
+
   /**
    * Description of the thing
    *
@@ -67,12 +71,21 @@ export interface SCThingWithoutReferences {
    * @text
    */
   description?: string;
+
+  /**
+   * The identifier property represents any kind of additional identifier for any kind of SCThing
+   *
+   * E.g. GTIN codes, UUIDs, Database IDs etc.
+   */
+  identifiers?: SCMap<string>;
+
   /**
    * URL of an image of the thing
    *
    * @keyword
    */
   image?: string;
+
   /**
    * Name of the thing
    *
@@ -82,12 +95,21 @@ export interface SCThingWithoutReferences {
    * @text
    */
   name: string;
+
+  /**
+   * URL of a reference Web page that unambiguously indicates the item's identity
+   *
+   * E.g. the URL of the item's Wikipedia page, Wikidata entry, or official website.
+   */
+  sameAs?: string;
+
   /**
    * Translations of specific values of the object
    *
    * Take precedence over "main" value for selected languages.
    */
   translations?: SCTranslations<SCThingTranslatableProperties>;
+
   /**
    * Type of the thing
    *
@@ -96,16 +118,11 @@ export interface SCThingWithoutReferences {
    * @aggregatable global
    */
   type: SCThingType;
+
   /**
    * Universally unique identifier of the thing
    */
   uid: SCUuid;
-  /**
-   * URL of the thing
-   * 
-   * @filterable
-   */
-  url?: string;
 }
 
 /**
@@ -252,7 +269,7 @@ export interface SCThingTranslatablePropertyOrigin {
  */
 export class SCThingMeta implements SCMetaTranslations<SCThing> {
   /**
-   * Set type definiton for singleton instance
+   * Set type definition for singleton instance
    */
   protected static _instance = new Map<string, unknown>();
 
@@ -263,24 +280,26 @@ export class SCThingMeta implements SCMetaTranslations<SCThing> {
     de: {
       alternateNames: 'alternative Namen',
       description: 'Beschreibung',
+      identifiers: 'Alternative Identifikation',
       image: 'Bild',
       name: 'Name',
       origin: 'Ursprung',
+      sameAs: 'ursprünglicher Link',
       translations: 'Übersetzungen',
       type: 'Typ',
       uid: 'Identifikation',
-      url: 'URL',
     },
     en: {
       alternateNames: 'alternate names',
       description: 'description',
+      identifiers: 'alternative identification',
       image: 'image',
       name: 'name',
       origin: 'origin',
+      sameAs: 'original link',
       translations: 'translations',
       type: 'type',
       uid: 'identification',
-      url: 'URL',
     },
   };
 

src/things/abstract/user-groups.ts

@@ -0,0 +1,21 @@
+/*
+ * Copyright (C) 2021 StApps
+ * This program is free software: you can redistribute it and/or modify it
+ * under the terms of the GNU General Public License as published by the Free
+ * Software Foundation, version 3.
+ *
+ * This program is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
+ * more details.
+ *
+ * You should have received a copy of the GNU General Public License along with
+ * this program. If not, see <https://www.gnu.org/licenses/>.
+ */
+/**
+ * Types of data consumers
+ */
+export type SCUserGroup =
+  'students'
+  | 'employees'
+  | 'guests';

src/things/article.ts

@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2019 StApps
+ * Copyright (C) 2019-2021 StApps
  * This program is free software: you can redistribute it and/or modify it
  * under the terms of the GNU General Public License as published by the Free
  * Software Foundation, version 3.
@@ -21,25 +21,37 @@ import {
 } from './abstract/creative-work';
 import {SCThingMeta, SCThingType} from './abstract/thing';
 import {
-  SCThingWithCategories,
   SCThingWithCategoriesSpecificValues,
   SCThingWithCategoriesTranslatableProperties,
   SCThingWithCategoriesWithoutReferences,
   SCThingWithCategoriesWithoutReferencesMeta,
 } from './abstract/thing-with-categories';
+import {SCPeriodicalWithoutReferences} from './periodical';
+
+/**
+ * Categories of an article
+ */
+export type SCArticleCategories = 'unipedia'
+  | 'article'
+  | 'eArticle';
 
 /**
  * An article without references
  */
 export interface SCArticleWithoutReferences
   extends SCCreativeWorkWithoutReferences,
-    SCThingWithCategoriesWithoutReferences<SCArticleCategories, SCThingWithCategoriesSpecificValues> {
+  SCThingWithCategoriesWithoutReferences<SCArticleCategories, SCThingWithCategoriesSpecificValues> {
   /**
    * Article itself as markdown
    *
    * @text
    */
-  articleBody: string;
+  articleBody?: string;
+
+  /**
+   * Categories of an article
+   */
+  categories: SCArticleCategories[];
 
   /**
    * Translated fields of an article
@@ -59,8 +71,16 @@ export interface SCArticleWithoutReferences
  * @indexable
  */
 export interface SCArticle
-  extends SCCreativeWork, SCArticleWithoutReferences,
-    SCThingWithCategories<SCArticleCategories, SCThingWithCategoriesSpecificValues> {
+  extends SCCreativeWork, SCArticleWithoutReferences {
+  /**
+   * A periodical to which this article belongs
+   */
+  isPartOf?: SCPeriodicalWithoutReferences;
+  /**
+   * Additional information about how to find the article inside of its "parent" (which is provided in 'isPartOf')
+   * e.g. "40, 2011, S. 2-3"
+   */
+  reference?: string;
   /**
    * Translated fields of an article
    */
@@ -73,12 +93,7 @@ export interface SCArticle
 }
 
 /**
- * Categories of articles
- */
-export type SCArticleCategories = 'unipedia';
-
-/**
- * Translatable properties of creative works
+ * Translatable properties of an article
  */
 export interface SCArticleTranslatableProperties
   extends SCThingWithCategoriesTranslatableProperties, SCCreativeWorkTranslatableProperties {
@@ -103,14 +118,18 @@ export class SCArticleMeta
       ...SCCreativeWorkMeta.getInstance<SCCreativeWorkMeta>().fieldTranslations
         .de,
       ...SCThingWithCategoriesWithoutReferencesMeta.getInstance<SCArticleCategories,
-        SCThingWithCategoriesSpecificValues>().fieldTranslations.de,
+      SCThingWithCategoriesSpecificValues>().fieldTranslations.de,
+      categories: 'Format',
+      reference: 'Referenz',
       articleBody: 'Artikelinhalt',
     },
     en: {
       ...SCCreativeWorkMeta.getInstance<SCCreativeWorkMeta>().fieldTranslations
         .en,
       ...SCThingWithCategoriesWithoutReferencesMeta.getInstance<SCArticleCategories,
-        SCThingWithCategoriesSpecificValues>().fieldTranslations.en,
+      SCThingWithCategoriesSpecificValues>().fieldTranslations.en,
+      categories: 'format',
+      reference: 'reference',
       articleBody: 'article body',
     },
   };
@@ -122,19 +141,22 @@ export class SCArticleMeta
     de: {
       ...SCCreativeWorkMeta.getInstance<SCCreativeWorkMeta>()
         .fieldValueTranslations.de,
-      ...SCThingWithCategoriesWithoutReferencesMeta.getInstance<SCArticleCategories,
-        SCThingWithCategoriesSpecificValues>().fieldValueTranslations.de,
       categories: {
-        'unipedia': 'Unipedia',
+        article: 'Artikel',
+        eArticle: 'E-Aufsatz',
+        unipedia: 'Unipedia',
       },
       type: 'Artikel',
     },
     en: {
       ...SCCreativeWorkMeta.getInstance<SCCreativeWorkMeta>()
         .fieldValueTranslations.en,
-      ...SCThingWithCategoriesWithoutReferencesMeta.getInstance<SCArticleCategories,
-        SCThingWithCategoriesSpecificValues>().fieldValueTranslations.en,
       type: SCThingType.Article,
+      categories: {
+        article: 'article',
+        eArticle: 'E-Article',
+        unipedia: 'unipedia',
+      },
     },
   };
 }

src/things/book.ts

@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2019 StApps
+ * Copyright (C) 2019-2021 StApps
  * This program is free software: you can redistribute it and/or modify it
  * under the terms of the GNU General Public License as published by the Free
  * Software Foundation, version 3.
@@ -20,29 +20,52 @@ import {
   SCCreativeWorkWithoutReferences,
 } from './abstract/creative-work';
 import {SCThingMeta, SCThingType} from './abstract/thing';
-import {SCThingWithCategoriesTranslatableProperties} from './abstract/thing-with-categories';
-import {SCPersonWithoutReferences} from './person';
+import {
+  SCThingWithCategoriesSpecificValues,
+  SCThingWithCategoriesTranslatableProperties,
+  SCThingWithCategoriesWithoutReferences,
+  SCThingWithCategoriesWithoutReferencesMeta,
+} from './abstract/thing-with-categories';
+
+/**
+ * Categories of a book
+ */
+export type SCBookCategories = 'audio'
+  | 'book'
+  | 'cd'
+  | 'dvd'
+  | 'ePhoto'
+  | 'ebook'
+  | 'hierarchy'
+  | 'kit'
+  | 'manuscript'
+  | 'map'
+  | 'microfilm'
+  | 'musicalscore'
+  | 'photo'
+  | 'retro'
+  | 'sensorimage'
+  | 'unknown'
+  | 'video';
 
 /**
  * A book without references
  */
 export interface SCBookWithoutReferences
-  extends SCCreativeWorkWithoutReferences {
+  extends SCCreativeWorkWithoutReferences,
+  SCThingWithCategoriesWithoutReferences<SCBookCategories, SCThingWithCategoriesSpecificValues> {
   /**
-   * Edition of a book
-   *
-   * @filterable
-   * @keyword
+   * Categories of a book
    */
-  bookEdition?: string;
+  categories: SCBookCategories[];
 
   /**
-   * ISBN of a book
+   * ISBNs of a book
    *
    * @filterable
    * @keyword
    */
-  isbn?: string;
+  ISBNs?: string[];
 
   /**
    * Number of pages of a book
@@ -70,11 +93,6 @@ export interface SCBookWithoutReferences
  */
 export interface SCBook
   extends SCCreativeWork, SCBookWithoutReferences {
-  /**
-   * Authors of the creative work
-   */
-  authors: SCPersonWithoutReferences[];
-
   /**
    * Translated properties of a book
    */
@@ -91,12 +109,6 @@ export interface SCBook
  */
 export interface SCBookTranslatableFields
   extends SCThingWithCategoriesTranslatableProperties, SCCreativeWorkTranslatableProperties {
-  /**
-   * Translation of an edition of a book
-   *
-   * @keyword
-   */
-  bookEdition?: string;
 }
 
 /**
@@ -108,17 +120,19 @@ export class SCBookMeta extends SCThingMeta implements SCMetaTranslations<SCBook
    */
   fieldTranslations = {
     de: {
-      ...SCCreativeWorkMeta.getInstance<SCCreativeWorkMeta>().fieldTranslations
-        .de,
-      bookEdition: 'Buchausgabe',
-      isbn: 'ISBN',
-      numberOfPages: 'Seitenzahl',
+      ...SCCreativeWorkMeta.getInstance<SCCreativeWorkMeta>().fieldTranslations.de,
+      ...SCThingWithCategoriesWithoutReferencesMeta.getInstance<SCBookCategories,
+      SCThingWithCategoriesSpecificValues>().fieldTranslations.de,
+      categories: 'Format',
+      ISBNs: 'ISBN',
+      numberOfPages: 'Seitenanzahl',
     },
     en: {
-      ...SCCreativeWorkMeta.getInstance<SCCreativeWorkMeta>().fieldTranslations
-        .en,
-      bookEdition: 'book edition',
-      isbn: 'ISBN',
+      ...SCCreativeWorkMeta.getInstance<SCCreativeWorkMeta>().fieldTranslations.en,
+      ...SCThingWithCategoriesWithoutReferencesMeta.getInstance<SCBookCategories,
+      SCThingWithCategoriesSpecificValues>().fieldTranslations.en,
+      categories: 'format',
+      ISBNs: 'ISBN',
       numberOfPages: 'number of pages',
     },
   };
@@ -130,12 +144,56 @@ export class SCBookMeta extends SCThingMeta implements SCMetaTranslations<SCBook
     de: {
       ...SCCreativeWorkMeta.getInstance<SCCreativeWorkMeta>()
         .fieldValueTranslations.de,
+      ...SCThingWithCategoriesWithoutReferencesMeta.getInstance<SCBookCategories,
+      SCThingWithCategoriesSpecificValues>().fieldValueTranslations.de,
+      categories: {
+        audio: 'Tonträger',
+        book: 'Buch',
+        cd: 'CD',
+        dvd: 'DVD',
+        ePhoto: 'E-Photo',
+        ebook: 'E-Book',
+        hierarchy: 'mehrteiliges Werk',
+        kit: 'Medienkombination',
+        manuscript: 'Handschrift',
+        map: 'Karte',
+        microfilm: 'Mikrofilm, Mikrofiche',
+        musicalscore: 'Noten',
+        photo: 'Abbildung',
+        physicalobject: 'Objekt',
+        retro: 'Retro (Buch)',
+        sensorimage: 'Blindenschrift',
+        unknown: 'Unbekannt',
+        video: 'Film',
+      },
       type: 'Buch',
     },
     en: {
       ...SCCreativeWorkMeta.getInstance<SCCreativeWorkMeta>()
         .fieldValueTranslations.en,
+      ...SCThingWithCategoriesWithoutReferencesMeta.getInstance<SCBookCategories,
+      SCThingWithCategoriesSpecificValues>().fieldValueTranslations.en,
       type: SCThingType.Book,
+      categories: {
+        audio: 'audio material',
+        book: 'book',
+        cd: 'CD',
+        dvd: 'DVD',
+        ePhoto: 'E-Photo',
+        ebook: 'E-Book',
+        hierarchy: 'multipart item',
+        kit: 'media combination',
+        manuscript: 'manuscript',
+        map: 'map',
+        microfilm: 'microfilm, microfiche',
+        musicalscore: 'sheet music',
+        photo: 'illustration',
+        physicalobject: 'object',
+        retro: 'retro (book)',
+        sensorimage: 'braille',
+        unknown: 'unknown',
+        video: 'film',
+      },
     },
   };
 }

src/things/catalog.ts

@@ -33,6 +33,7 @@ export interface SCCatalogWithoutReferences
    *
    * Needed for keeping order in catalog inheritance array.
    *
+   * @filterable
    * @integer
    */
   level: number;

src/things/date-series.ts

@@ -65,9 +65,9 @@ export interface SCDateSeriesWithoutReferences
   /**
    * Frequency of the date series
    *
-   * @keyword
+   * @filterable
    */
-  frequency: string;
+  repeatFrequency?: SCISO8601Duration;
 
   /**
    * Translated properties
@@ -131,7 +131,7 @@ export class SCDateSeriesMeta
       duration: 'Dauer',
       event: 'Event',
       exceptions: 'Ausnahmen',
-      frequency: 'Frequenz',
+      repeatFrequency: 'Frequenz',
       performers: 'Vortragende',
     },
     en: {
@@ -143,7 +143,7 @@ export class SCDateSeriesMeta
       duration: 'duration',
       event: 'event',
       exceptions: 'exceptions',
-      frequency: 'frequency',
+      repeatFrequency: 'frequency',
       performers: 'performers',
     },
   };
@@ -174,8 +174,4 @@ export class SCDateSeriesMeta
  */
 export interface SCDateSeriesTranslatableProperties
   extends SCThingThatCanBeOfferedTranslatableProperties {
-  /**
-   * @see SCDateSeriesWithoutReferences.frequency
-   */
-  frequency?: string;
 }

src/things/diff.ts

@@ -15,7 +15,7 @@
 import * as jsonpatch from 'json-patch';
 import {SCMetaTranslations} from '../general/i18n';
 import {SCISO8601Date} from '../general/time';
-import {SCThingsWithoutDiff} from '../meta';
+import {SCIndexableThings} from '../meta';
 import {SCThing, SCThingMeta, SCThingType, SCThingWithoutReferences} from './abstract/thing';
 
 /**
@@ -48,14 +48,13 @@ export interface SCDiffWithoutReferences
  * A diff
  *
  * @validatable
- * @indexable
  */
 export interface SCDiff
   extends SCDiffWithoutReferences, SCThing {
   /**
    * Original object the diff was generated on
    */
-  object: SCThingsWithoutDiff;
+  object: SCIndexableThings;
 
   /**
    * Type of a diff

src/things/favorite.ts

@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2019 StApps
+ * Copyright (C) 2019-2021 StApps
  * This program is free software: you can redistribute it and/or modify it
  * under the terms of the GNU General Public License as published by the Free
  * Software Foundation, version 3.
@@ -14,45 +14,24 @@
  */
 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)
- */
-export type SCFavoriteDataTypes = SCAcademicEventWithoutReferences
-  | SCArticleWithoutReferences
-  | SCBookWithoutReferences
-  | SCBuildingWithoutReferences
-  | SCPersonWithoutReferences
-  | SCPointOfInterestWithoutReferences
-  | SCRoomWithoutReferences
-  | SCSportCourseWithoutReferences
-  | SCToDoWithoutReferences;
 
 /**
  * A favorite without references
  */
 export interface SCFavoriteWithoutReferences
   extends SCSaveableThingWithoutReferences {
-  // noop
+  /**
+   * Type of a favorite
+   */
+  type: SCThingType.Favorite;
 }
 
 /**
  * A favorite
  *
  * @validatable
- * @indexable
  */
-export interface SCFavorite
-  extends SCSaveableThing<SCFavoriteDataTypes>, SCFavoriteWithoutReferences {
+export interface SCFavorite extends SCSaveableThing {
   /**
    * Type of a favorite
    */

src/things/message.ts

@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2019 StApps
+ * Copyright (C) 2019-2021 StApps
  * This program is free software: you can redistribute it and/or modify it
  * under the terms of the GNU General Public License as published by the Free
  * Software Foundation, version 3.
@@ -22,13 +22,24 @@ import {
 } from './abstract/creative-work';
 import {SCThingMeta, SCThingType} from './abstract/thing';
 import {SCThingThatCanBeOfferedTranslatableProperties} from './abstract/thing-that-can-be-offered';
+import {
+  SCThingWithCategoriesSpecificValues,
+  SCThingWithCategoriesWithoutReferences, SCThingWithCategoriesWithoutReferencesMeta,
+} from './abstract/thing-with-categories';
+import {SCUserGroup} from './abstract/user-groups';
 import {SCOrganizationWithoutReferences} from './organization';
 
+/**
+ * Categories of a message
+ */
+export type SCMessageCategories = 'news';
+
 /**
  * A message without references
  */
 export interface SCMessageWithoutReferences
-  extends SCCreativeWorkWithoutReferences {
+  extends SCCreativeWorkWithoutReferences,
+  SCThingWithCategoriesWithoutReferences<SCMessageCategories, SCThingWithCategoriesSpecificValues> {
   /**
    * Organizational unit for which the message is intended
    */
@@ -39,7 +50,12 @@ export interface SCMessageWithoutReferences
    *
    * @filterable
    */
-  audiences: SCMessageAudience[];
+  audiences: SCUserGroup[];
+
+  /**
+   * Categories of a message
+   */
+  categories: SCMessageCategories[];
 
   /**
    * When the message was created
@@ -90,14 +106,6 @@ export interface SCMessage
   type: SCThingType.Message;
 }
 
-/**
- * Audiences for messages
- */
-export type SCMessageAudience =
-  'students'
-  | 'employees'
-  | 'guests';
-
 /**
  * Translatable properties of a message
  */
@@ -124,6 +132,8 @@ export class SCMessageMeta
     de: {
       ...SCCreativeWorkMeta.getInstance<SCCreativeWorkMeta>().fieldTranslations
         .de,
+      ...SCThingWithCategoriesWithoutReferencesMeta.getInstance<SCMessageCategories,
+      SCThingWithCategoriesSpecificValues>().fieldTranslations.de,
       audienceOrganizations: 'Zielgruppenorganisationen',
       audiences: 'Zielgruppen',
       dateCreated: 'Erstellungsdatum',
@@ -133,6 +143,8 @@ export class SCMessageMeta
     en: {
       ...SCCreativeWorkMeta.getInstance<SCCreativeWorkMeta>().fieldTranslations
         .en,
+      ...SCThingWithCategoriesWithoutReferencesMeta.getInstance<SCMessageCategories,
+      SCThingWithCategoriesSpecificValues>().fieldTranslations.en,
       audienceOrganizations: 'audience organizations',
       audiences: 'audiences',
       dateCreated: 'date created',
@@ -149,9 +161,12 @@ export class SCMessageMeta
       ...SCCreativeWorkMeta.getInstance<SCCreativeWorkMeta>()
         .fieldValueTranslations.de,
       audiences: {
-        'employees': 'Angestellte',
-        'guests': 'Gäste',
-        'students': 'Studenten',
+        employees: 'Angestellte',
+        guests: 'Gäste',
+        students: 'Studenten',
+      },
+      categories: {
+        news: 'Neuigkeiten',
       },
       type: 'Nachricht',
     },

src/things/periodical.ts

@@ -0,0 +1,137 @@
+/*
+ * Copyright (C) 2021 StApps
+ * This program is free software: you can redistribute it and/or modify it
+ * under the terms of the GNU General Public License as published by the Free
+ * Software Foundation, version 3.
+ *
+ * This program is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
+ * more details.
+ *
+ * You should have received a copy of the GNU General Public License along with
+ * this program. If not, see <https://www.gnu.org/licenses/>.
+ */
+import {SCMetaTranslations, SCTranslations} from '../general/i18n';
+import {
+  SCCreativeWork,
+  SCCreativeWorkMeta,
+  SCCreativeWorkTranslatableProperties,
+  SCCreativeWorkWithoutReferences,
+} from './abstract/creative-work';
+import {SCThingMeta, SCThingType} from './abstract/thing';
+import {
+  SCThingWithCategoriesSpecificValues,
+  SCThingWithCategoriesTranslatableProperties,
+  SCThingWithCategoriesWithoutReferences,
+  SCThingWithCategoriesWithoutReferencesMeta,
+} from './abstract/thing-with-categories';
+
+/**
+ * Categories of a periodical
+ */
+export type SCPeriodicalCategories = 'journal' | 'electronic';
+
+/**
+ * A periodical without references
+ */
+export interface SCPeriodicalWithoutReferences
+  extends SCCreativeWorkWithoutReferences,
+  SCThingWithCategoriesWithoutReferences<SCPeriodicalCategories, SCThingWithCategoriesSpecificValues> {
+  /**
+   * Categories of a periodical
+   */
+  categories: SCPeriodicalCategories[];
+  /**
+   * A list of ISSNs of a periodical
+   *
+   * @filterable
+   * @keyword
+   */
+  ISSNs?: string[];
+
+  /**
+   * Translated properties of a periodical
+   */
+  translations?: SCTranslations<SCPeriodicalTranslatableFields>;
+
+  /**
+   * Type of a periodical
+   */
+  type: SCThingType.Periodical;
+}
+
+/**
+ * A publication published at regular intervals (e.g. a magazine or newspaper)
+ *
+ * @validatable
+ * @indexable
+ */
+export interface SCPeriodical
+  extends SCCreativeWork, SCPeriodicalWithoutReferences {
+  /**
+   * Translated properties of a periodical
+   */
+  translations?: SCTranslations<SCPeriodicalTranslatableFields>;
+
+  /**
+   * Type of a periodical
+   */
+  type: SCThingType.Periodical;
+}
+
+/**
+ * Translatable properties of a periodical
+ */
+export interface SCPeriodicalTranslatableFields
+  extends SCThingWithCategoriesTranslatableProperties, SCCreativeWorkTranslatableProperties {
+}
+
+/**
+ * Meta information about a periodical
+ */
+export class SCPeriodicalMeta extends SCThingMeta implements SCMetaTranslations<SCPeriodical> {
+  /**
+   * Translations of fields
+   */
+  fieldTranslations = {
+    de: {
+      ...SCCreativeWorkMeta.getInstance<SCCreativeWorkMeta>().fieldTranslations.de,
+      ...SCThingWithCategoriesWithoutReferencesMeta.getInstance<SCPeriodicalCategories,
+      SCThingWithCategoriesSpecificValues>().fieldTranslations.de,
+      categories: 'Format',
+      ISSNs: 'ISSN',
+    },
+    en: {
+      ...SCCreativeWorkMeta.getInstance<SCCreativeWorkMeta>().fieldTranslations.en,
+      ...SCThingWithCategoriesWithoutReferencesMeta.getInstance<SCPeriodicalCategories,
+      SCThingWithCategoriesSpecificValues>().fieldTranslations.en,
+      categories: 'format',
+      ISSNs: 'ISSN',
+    },
+  };
+
+  /**
+   * Translations of values of fields
+   */
+  fieldValueTranslations = {
+    de: {
+      ...SCCreativeWorkMeta.getInstance<SCCreativeWorkMeta>()
+        .fieldValueTranslations.de,
+      type: 'Periodikum',
+      categories: {
+        electronic: 'E-Journal',
+        journal: 'Zeitschrift',
+      },
+    },
+    en: {
+      ...SCCreativeWorkMeta.getInstance<SCCreativeWorkMeta>()
+        .fieldValueTranslations.en,
+      type: 'periodical',
+      categories: {
+        electronic: 'E-Journal',
+        journal: 'journal',
+      },
+    },
+  };
+}

src/things/person.ts

@@ -57,7 +57,7 @@ export interface SCPersonWithoutReferences
    * @filterable
    * @keyword
    */
-  familyName: string;
+  familyName?: string;
 
   /**
    * The private fax number of the person.
@@ -80,7 +80,7 @@ export interface SCPersonWithoutReferences
    * @filterable
    * @keyword
    */
-  givenName: string;
+  givenName?: string;
 
   /**
    * Honorific prefix of the person.

src/things/publication-event.ts

@@ -0,0 +1,105 @@
+/*
+ * Copyright (C) 2021 StApps
+ * This program is free software: you can redistribute it and/or modify it
+ * under the terms of the GNU General Public License as published by the Free
+ * Software Foundation, version 3.
+ *
+ * This program is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
+ * more details.
+ *
+ * You should have received a copy of the GNU General Public License along with
+ * this program. If not, see <https://www.gnu.org/licenses/>.
+ */
+import {SCMetaTranslations, SCTranslations} from '../general/i18n';
+import {SCEvent, SCEventMeta, SCEventWithoutReferences} from './abstract/event';
+import {SCThingMeta, SCThingTranslatableProperties, SCThingType} from './abstract/thing';
+
+/**
+ * An publication event without references
+ */
+export interface SCPublicationEventWithoutReferences
+  extends SCEventWithoutReferences {
+  /**
+   * All the locations related to the event (e.g. where a creative work was published)
+   */
+  locations?: string[];
+
+  /**
+   * An organization (or a person) that is publishing at the event
+   */
+  publisher?: string;
+
+  /**
+   * Translated fields of an publication event
+   */
+  translations?: SCTranslations<SCPublicationEventTranslatableProperties>;
+
+  /**
+   * Type of an publication event
+   */
+  type: SCThingType.PublicationEvent;
+}
+
+/**
+ * An publication event
+ *
+ * @validatable
+ * @indexable
+ */
+export interface SCPublicationEvent
+  extends SCEvent, SCPublicationEventWithoutReferences {
+  /**
+   * Translated fields of an publication event
+   */
+  translations?: SCTranslations<SCPublicationEventTranslatableProperties>;
+
+  /**
+   * Type of an publication event
+   */
+  type: SCThingType.PublicationEvent;
+}
+
+/**
+ * Translatable properties of an publication event
+ */
+export interface SCPublicationEventTranslatableProperties extends SCThingTranslatableProperties {
+}
+
+/**
+ * Meta information about publication events
+ */
+export class SCPublicationEventMeta
+  extends SCThingMeta
+  implements SCMetaTranslations<SCPublicationEvent> {
+  /**
+   * Translations of fields
+   */
+  fieldTranslations = {
+    de: {
+      ...SCEventMeta.getInstance<SCEventMeta>().fieldTranslations.de,
+      locations: 'Erscheinungsorte',
+      publisher: 'Verlag',
+    },
+    en: {
+      ...SCEventMeta.getInstance<SCEventMeta>().fieldTranslations.en,
+      locations: 'places of publication',
+      publisher: 'publisher',
+    },
+  };
+
+  /**
+   * Translations of values of fields
+   */
+  fieldValueTranslations = {
+    de: {
+      ...SCEventMeta.getInstance<SCEventMeta>().fieldValueTranslations.de,
+      type: 'Veröffentlichung',
+    },
+    en: {
+      ...SCEventMeta.getInstance<SCEventMeta>().fieldValueTranslations.en,
+      type: 'publication event',
+    },
+  };
+}

src/things/setting.ts

@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2019 StApps
+ * Copyright (C) 2019-2021 StApps
  * This program is free software: you can redistribute it and/or modify it
  * under the terms of the GNU General Public License as published by the Free
  * Software Foundation, version 3.
@@ -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 {SCMetaTranslations, SCTranslations} from '../general/i18n';
+import {SCLanguageCode, SCMetaTranslations, SCTranslations} from '../general/i18n';
 import {SCThing, SCThingMeta, SCThingType} from './abstract/thing';
 import {
   SCThingWithCategories,
@@ -21,6 +21,7 @@ import {
   SCThingWithCategoriesWithoutReferences,
   SCThingWithCategoriesWithoutReferencesMeta,
 } from './abstract/thing-with-categories';
+import {SCUserGroup} from './abstract/user-groups';
 
 /**
  * A setting without references
@@ -83,7 +84,6 @@ export enum SCSettingInputType {
  * A setting with references
  *
  * @validatable
- * @indexable
  */
 export interface SCSetting
   extends SCSettingWithoutReferences, SCThing,
@@ -177,3 +177,55 @@ export class SCSettingMeta extends SCThingMeta implements SCMetaTranslations<SCS
     },
   };
 }
+
+/**
+ * A user group setting
+ */
+export interface SCUserGroupSetting extends SCSetting {
+  /**
+   * Exact categories of the setting
+   */
+  categories: ['profile'];
+  /**
+   * The default value of the setting
+   */
+  defaultValue: SCUserGroup;
+  /**
+   * Specific name of the setting
+   */
+  name: 'group';
+  /**
+   * Chosen value of the setting
+   */
+  value?: SCUserGroup;
+  /**
+   * The possible values of the setting
+   */
+  values: SCUserGroup[];
+}
+
+/**
+ * A language setting
+ */
+export interface SCLanguageSetting extends SCSetting {
+  /**
+   * Exact categories of the setting
+   */
+  categories: ['profile'];
+  /**
+   * The default value of the setting
+   */
+  defaultValue: SCLanguageCode;
+  /**
+   * Specific name of the setting
+   */
+  name: 'language';
+  /**
+   * Chosen value of the setting
+   */
+  value?: SCLanguageCode;
+  /**
+   * The possible values of the setting
+   */
+  values: SCLanguageCode[];
+}

src/translator.ts

@@ -13,8 +13,9 @@
  * this program. If not, see <https://www.gnu.org/licenses/>.
  */
 import clone = require('fast-clone');
+import equal = require('fast-deep-equal/es6');
 import {Defined, TSOCType} from 'ts-optchain';
-import {SCTranslations} from './general/i18n';
+import {SCLanguageCode} from './general/i18n';
 import {isThing} from './guards';
 import {SCClasses} from './meta';
 import {SCThing, SCThingType} from './things/abstract/thing';
@@ -27,13 +28,32 @@ const standardCacheSize = 200;
  */
 export class SCThingTranslator {
 
+  /**
+   * Getter for language property
+   */
+  get language(): SCLanguageCode {
+    return this._language;
+  }
+
+  /**
+   * Setter for language property. Also flushes translation cache
+   *
+   * @param language The language the translator instance will use from now on
+   */
+  set language(language: SCLanguageCode) {
+    if (language !== this._language) {
+      this.cache.flush();
+    }
+    this._language = language;
+  }
+
   /**
    * Property representing the translators target language
    */
-  private _language: keyof SCTranslations<SCThing>;
+  private _language: SCLanguageCode;
+
   /**
-   * Property representing the translators base language
-   * This means every translation is given for this language
+   * LRU cache containing already translated SCThings
    */
   private readonly cache: LRUCache<SCThing>;
 
@@ -42,36 +62,23 @@ export class SCThingTranslator {
    */
   private readonly metaClasses: typeof SCClasses;
 
+  /**
+   * LRU cache containing SCThings translations have been provided for
+   */
+  private readonly sourceCache: LRUCache<SCThing>;
+
   /**
    * @example
    * // returns translator instance for german
    * new SCThingTranslator('de');
    */
-  constructor(language: keyof SCTranslations<SCThing>, cacheCapacity: number = standardCacheSize) {
+  constructor(language: SCLanguageCode, cacheCapacity: number = standardCacheSize) {
     this.cache = new LRUCache(cacheCapacity);
+    this.sourceCache = new LRUCache(cacheCapacity);
     this._language = language;
     this.metaClasses = SCClasses;
   }
 
-  /**
-   * Getter for language property
-   */
-  get language(): keyof SCTranslations<SCThing> {
-    return this._language;
-  }
-
-  /**
-   * Setter for language property. Also flushes translation cache
-   *
-   * @param language The language the translator instance will use from now on
-   */
-  set language(language: keyof SCTranslations<SCThing>) {
-    if (language !== this._language) {
-      this.cache.flush();
-    }
-    this._language = language;
-  }
-
   /**
    * Get field value translation recursively
    *
@@ -101,8 +108,8 @@ export class SCThingTranslator {
    * @param language The language the thing property values are translated to
    * @returns The thing with all known meta values translated
    */
-  private getAllMetaFieldTranslations<T extends SCThing>(thingType: SCThingType,
-                                                         language: keyof SCTranslations<T>): object | undefined {
+  private getAllMetaFieldTranslations(thingType: SCThingType,
+                                      language: SCLanguageCode): object | undefined {
     const fieldTranslations = {};
     const metaClass = this.getMetaClassInstance(thingType);
     if (typeof metaClass === 'undefined') {
@@ -151,7 +158,7 @@ export class SCThingTranslator {
    * @returns The thing with translated meta field values
    */
   private replaceAvailableMetaFieldValueTranslations(instance: any,
-                                                     language: keyof SCTranslations<any>): any {
+                                                     language: SCLanguageCode): any {
     const metaClass = this.getMetaClassInstance(instance.type);
     if (typeof metaClass === 'undefined') {
       return instance;
@@ -181,6 +188,60 @@ export class SCThingTranslator {
     return instance;
   }
 
+  /**
+   * Recursively translates the given object in-place
+   * Translated values overwrite current values (destructive)
+   *
+   * @param instance The thing / object that will be translated
+   * @returns The thing translated
+   */
+  private translateThingInPlaceDestructively<T>(instance: T): T {
+    const targetLanguage = this.language;
+
+    let nextInstance = instance as any;
+    // Recursively call this function on all nested SCThings, arrays and objects
+    Object.keys(nextInstance)
+      .forEach((key) => {
+        if (
+          isThing(nextInstance[key]) ||
+          nextInstance[key] instanceof Array ||
+          nextInstance[key] instanceof Object) {
+            nextInstance[key] = this.translateThingInPlaceDestructively(nextInstance[key]);
+        }
+      });
+
+    // Spread variable translations given by the connector into thing
+    if (typeof nextInstance.translations?.[targetLanguage] !== 'undefined') {
+      nextInstance = {...nextInstance, ...nextInstance.translations![targetLanguage]} as T;
+    }
+    // Spread known translations from meta classes into (partly) translated thing
+    this.replaceAvailableMetaFieldValueTranslations(nextInstance, targetLanguage);
+
+    return nextInstance;
+  }
+
+  /**
+   * Recursively translates the given object in-place
+   * Translated values overwrite current values (destructive)
+   *
+   * @param instance The thing / object that will be translated
+   * @returns The thing translated
+   */
+  public translate<T extends SCThing>(thing: T): T {
+    if (equal(this.sourceCache.get(thing), thing)) {
+      const cachedInstance = this.cache.get(thing);
+      if (typeof cachedInstance !== 'undefined') {
+        return cachedInstance as T;
+      }
+    }
+    const translatedInstance = this.translateThingInPlaceDestructively(clone(thing));
+    delete translatedInstance.translations;
+    this.cache.putObject(translatedInstance);
+    this.sourceCache.putObject(thing);
+
+    return translatedInstance as T;
+  }
+
   /**
    * Get field value translation recursively
    * @example
@@ -191,21 +252,24 @@ export class SCThingTranslator {
    * dishTranslatedAccess.offers[0].inPlace.categories[1]();
    * // undoing the TSOCType<T>
    * const dishAsBefore: SCDish = dishTranslatedAccess()!;
-   * @param data Top level object that gets passed through the recursion
+   * @param thing Top level object that gets passed through the recursion
    * @returns an TSOCType<T> object allowing for access to translations or a translated value(s)
    */
-  public translate<T extends SCThing>(data: T): TSOCType<T> {
+  public translatedAccess<T extends SCThing>(thing: T): TSOCType<T> {
     return new Proxy(
-      ((defaultValue?: Defined<T>) => (data == null ? defaultValue : data)) as TSOCType<T>,
+      ((defaultValue?: Defined<T>) => (thing == null ? defaultValue : thing)) as TSOCType<T>,
       {
         get: (target, key) => {
           const obj: any = target();
-          const objTranslatedFromCache = this.cache.get(data);
-          if (typeof objTranslatedFromCache !== 'undefined') {
-            return this.deeptranslate((objTranslatedFromCache as any)[key]);
+          if (equal(this.sourceCache.get(thing), thing)) {
+            const objTranslatedFromCache = this.cache.get(thing);
+            if (typeof objTranslatedFromCache !== 'undefined') {
+              return this.deeptranslate((objTranslatedFromCache as any)[key]);
+            }
           }
-          const objTranslated = this.translateWholeThingDestructively(clone(obj));
+          const objTranslated = this.translateThingInPlaceDestructively(clone(obj));
           this.cache.putObject(objTranslated);
+          this.sourceCache.putObject(thing);
 
           return this.deeptranslate(objTranslated[key]);
         },
@@ -219,69 +283,31 @@ export class SCThingTranslator {
    * @example
    * const translatedMetaDish = translator.translatedPropertyNames<SCCourseOfStudies>(SCThingType.CourseOfStudies);
    * @param type The type whose property names will be translated
-   * @param language The language all property names will be translated to
    * @returns An object with the properties of the SCThingType where the values are the known property tranlations
    */
-  public translatedPropertyNames<T extends SCThing>(type: SCThingType,
-                                                    language?: keyof SCTranslations<T>): T | undefined {
-    return this.getAllMetaFieldTranslations(type, language ?? this.language) as T;
+  public translatedPropertyNames<T extends SCThing>(type: SCThingType): T | undefined {
+    return this.getAllMetaFieldTranslations(type, this.language) as T;
   }
 
   /**
    * Given a SCThingType and a corresponding property name it returns the known property value translation
    * Access pattern to the meta object containing the translation can be thought of as type.field[key] with key being optional
    * @example
-   * const translatedMetaDish = translator.translatedPropertyNames(SCThingType.Dish, 'categories', 'main dish');
+   * const singleValueTranslation = translator.translatedPropertyValue(SCThingType.Dish, 'categories', 'main dish');
    * @param type The type for whose property values a translation is required
    * @param field The property for which a translation is required
    * @param key If specified tries to access the field with this key
-   * @param language The language all property names will be translated to
    * @returns Known translation for the property
    */
-  public translatedPropertyValue<T extends unknown>(type: SCThingType,
-                                                    field: string,
-                                                    key?: string,
-                                                    language?: keyof SCTranslations<T>): string | undefined {
-    const fieldTranslation = this.getMetaClassInstance(type).fieldValueTranslations[language ?? this.language]?.[field];
+  public translatedPropertyValue(type: SCThingType,
+                                 field: string,
+                                 key?: string): string | undefined {
+    const fieldValueTranslations = this.getMetaClassInstance(type).fieldValueTranslations[this.language] ??
+                                   this.getMetaClassInstance(type).fieldValueTranslations.en;
+    const fieldTranslation = fieldValueTranslations?.[field];
 
-    return fieldTranslation?.[key ?? '']  ?? key ?? fieldTranslation;
+    return fieldTranslation?.[key ?? ''] ?? key ?? fieldTranslation;
   }
-
-  /**
-   * Recursively translates the given object in-place
-   * Translated values overwrite current values (destructive)
-   *
-   * @param instance The thing / object that will be translated
-   * @param language The language the thing / object is translated to
-   * @returns The thing translated
-   */
-  public translateWholeThingDestructively(instance: any,
-                                          language?: keyof SCTranslations<any>): any {
-    const targetLanguage = (typeof language !== 'undefined') ? language : this.language;
-    let nextInstance = instance;
-    // Recursively call this function on all nested SCThings, arrays and objects
-    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 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(nextInstance, targetLanguage);
-
-    return nextInstance;
-  }
-
 }
 
 /**

test/guards.spec.ts

@@ -116,8 +116,10 @@ export class GuardsSpec {
   @test
   public isSearchResponse() {
     const notASearchResponse = {...GuardsSpec.searchResponse};
+    // @ts-ignore
     delete notASearchResponse.pagination;
     expect(isSearchResponse(notASearchResponse)).to.be.equal(false);
+    // @ts-ignore
     delete notASearchResponse.data;
     expect(isSearchResponse(notASearchResponse)).to.be.equal(false);
     expect(isSearchResponse(null)).to.be.equal(false);

test/resources/Article.1.json

@@ -6,7 +6,7 @@
     "categories": [
       "unipedia"
     ],
-    "url": "https://www.mydesk.tu-berlin.de/wiki/abk%C3%BCrzungen",
+    "sameAs": "https://www.mydesk.tu-berlin.de/wiki/abk%C3%BCrzungen",
     "name": "Abkürzungen",
     "keywords": [
       "Abkürzungen",

test/resources/Article.2.json

@@ -6,7 +6,7 @@
     "categories": [
       "unipedia"
     ],
-    "url": "https://www.mydesk.tu-berlin.de/wiki/ag_ziethen",
+    "sameAs": "https://www.mydesk.tu-berlin.de/wiki/ag_ziethen",
     "name": "AG Ziethen",
     "keywords": [
       "Bologna",

test/resources/Article.3.json

@@ -0,0 +1,36 @@
+{
+  "errorNames": [],
+  "instance": {
+    "type": "article",
+    "uid": "d541eda5-1542-59b2-969e-7dbbee0bd2a8",
+    "name": "Mozart und Frankfurt am Main : drei Generationen Mozart in Frankfurt am Main",
+    "description": "Ill.",
+    "categories": [
+      "article"
+    ],
+    "authors": [
+      {
+        "type": "person",
+        "uid": "56d46c9b-8ede-52ae-a40f-6800cff577e5",
+        "name": "Greve, Clemens"
+      }
+    ],
+    "firstPublished": "2008",
+    "sameAs": "https://hds2test.hebis.de/ubffm/Record/HEB198305427",
+    "origin": {
+      "indexed": "2018-09-11T12:30:00Z",
+      "name": "HeBIS HDS",
+      "originalId": "HEB198305427",
+      "type": "remote",
+      "url": "https://hds2test.hebis.de/ubffm/"
+    },
+    "isPartOf": {
+      "uid": "bc5e5399-a24c-5c01-9c1b-0c8b83272087",
+      "name": "Archiv für Frankfurts Geschichte und Kunst",
+      "type": "periodical",
+      "categories": []
+    },
+    "reference": "Band 71 (2008), Seite 27-40"
+  },
+  "schema": "SCArticle"
+}

test/resources/Article.4.json

@@ -0,0 +1,36 @@
+{
+  "errorNames": [],
+  "instance": {
+    "type": "article",
+    "uid": "554a4a89-df73-5197-ac85-c8a5a3a9c5b0",
+    "name": "Ursula Janik : [Markthändlerin]",
+    "description": "Ill.",
+    "categories": [
+      "article"
+    ],
+    "authors": [
+      {
+        "type": "person",
+        "uid": "c6e44e1f-f76c-53f8-a18f-47fa54ae0e90",
+        "name": "Fröhlich, Ute B."
+      }
+    ],
+    "firstPublished": "2002",
+    "sameAs": "https://hds2test.hebis.de/ubffm/Record/HEB107025590",
+    "origin": {
+      "indexed": "2018-09-11T12:30:00Z",
+      "name": "HeBIS HDS",
+      "originalId": "HEB107025590",
+      "type": "remote",
+      "url": "https://hds2test.hebis.de/ubffm/"
+    },
+    "isPartOf": {
+      "uid": "f84c1851-042e-542f-ba7a-158b32dfb82f",
+      "name": "Frankfurter Allgemeine. R, Rhein-Main-Zeitung",
+      "type": "periodical",
+      "categories": []
+    },
+    "reference": "Heft 190 (17. 8 2002), Seite 62"
+  },
+  "schema": "SCArticle"
+}

test/resources/Book.1.json

@@ -21,15 +21,15 @@
         "name": "Symposion Publishing"
       }
     ],
-    "inLanguages": [
-      {
-        "name": "german",
-        "code": "de"
-      }
+    "inLanguage": "de",
+    "edition": "2., überarb. u. erw. Aufl.",
+    "ISBNs": [
+      "3936608776"
     ],
-    "bookEdition": "2., überarb. u. erw. Aufl.",
-    "isbn": "3936608776",
     "numberOfPages": 537,
+    "categories": [
+      "book"
+    ],
     "origin": {
       "indexed": "2018-09-11T12:30:00Z",
       "name": "Dummy",

test/resources/Book.2.json

@@ -4,6 +4,9 @@
     "type": "book",
     "uid": "db47f7f4-7699-5a37-afcc-24beaa998d36",
     "name": "Minimal Book",
+    "categories": [
+      "ebook"
+    ],
     "authors": [
       {
         "type": "person",
@@ -14,7 +17,9 @@
       }
     ],
     "datePublished": "2007-08-01",
-    "isbn": "3936608776",
+    "ISBNs": [
+      "3936608776"
+    ],
     "origin": {
       "indexed": "2018-09-11T12:30:00Z",
       "name": "Dummy",

test/resources/Book.3.json

@@ -0,0 +1,40 @@
+{
+  "errorNames": [],
+  "instance": {
+    "type": "book",
+    "uid": "188cb2bd-724d-543d-97ac-9aa1dda68cb7",
+    "name": "Frauen im Ingenieurberuf : FIB ; 1. Gesamtdeutsches Symposium VDI-FIB 17. - 18. November 1990, Bad Homburg ; 1. überregionales Treffen VDI-FIB 11. - 12. November 1989, Düsseldorf",
+    "description": "47 S. : Ill., Kt.",
+    "categories": [
+      "book"
+    ],
+    "authors": [
+      {
+        "uid": "a276588c-ecee-5d2e-8b9c-73cb902bc165",
+        "name": "Saatweber, Jutta (Hrsg.)",
+        "type": "person"
+      }
+    ],
+    "firstPublished": "[ca. 1991]",
+    "publications": [
+      {
+        "uid": "603a6574-8910-588a-9e83-cd26e6988c74",
+        "type": "publication event",
+        "locations": [
+          "Frankfurt/M"
+        ],
+        "publisher": "VDI",
+        "name": "VDI"
+      }
+    ],
+    "sameAs": "https://hds2test.hebis.de/ubffm/Record/HEB022992618",
+    "origin": {
+      "indexed": "2018-09-11T12:30:00Z",
+      "name": "HeBIS HDS",
+      "originalId": "HEB022992618",
+      "type": "remote",
+      "url": "https://hds2test.hebis.de/ubffm/"
+    }
+  },
+  "schema": "SCBook"
+}

test/resources/Book.4.json

@@ -0,0 +1,43 @@
+{
+  "errorNames": [],
+  "instance": {
+    "type": "book",
+    "uid": "f6ee5744-a441-595d-9dae-a9f579c0660f",
+    "name": "Kant",
+    "description": "176 S.",
+    "categories": [
+      "book"
+    ],
+    "authors": [
+      {
+        "uid": "7e198ecf-966a-5f99-8a45-266243583023",
+        "name": "Thouard, Denis",
+        "type": "person"
+      }
+    ],
+    "firstPublished": "2001",
+    "publications": [
+      {
+        "uid": "603a6574-8910-588a-9e83-cd26e6988c74",
+        "type": "publication event",
+        "locations": [
+          "Paris"
+        ],
+        "publisher": "Belles Lettres",
+        "name": "Belles Lettres"
+      }
+    ],
+    "sameAs": "https://hds2test.hebis.de/ubffm/Record/HEB102248788",
+    "ISBNs": [
+      "2251760385"
+    ],
+    "origin": {
+      "indexed": "2018-09-11T12:30:00Z",
+      "name": "HeBIS HDS",
+      "originalId": "HEB102248788",
+      "type": "remote",
+      "url": "https://hds2test.hebis.de/ubffm/"
+    }
+  },
+  "schema": "SCBook"
+}

test/resources/DateSeries.1.json

@@ -22,7 +22,7 @@
         }
       }
     },
-    "frequency": "once",
+    "repeatFrequency": "P1W",
     "dates": [
       "2016-04-15T17:00:00+00:00"
     ],

test/resources/DateSeries.2.json

@@ -23,7 +23,6 @@
       "name": "EMH 225",
       "floorName": "2"
     },
-    "frequency": "once",
     "dates": [
       "2016-04-12T11:00:00+00:00"
     ],

test/resources/DateSeries.3.json

@@ -23,7 +23,6 @@
       "name": "EMH 225",
       "floorName": "2"
     },
-    "frequency": "once",
     "dates": [
       "2016-04-12T11:00:00+00:00"
     ],
@@ -43,8 +42,10 @@
     "offers": [
       {
         "availability": "in stock",
-        "availabilityStarts": "2017-01-30T00:00:00.000Z",
-        "availabilityEnds": "2017-01-30T23:59:59.999Z",
+        "availabilityRange": {
+          "gte": "2017-01-30T00:00:00.000Z",
+          "lte": "2017-01-30T23:59:59.999Z"
+        },
         "prices": {
           "default": 6.5,
           "student": 5,

test/resources/Diff.1.json

@@ -21,6 +21,9 @@
       "audiences": [
         "students"
       ],
+      "categories": [
+        "news"
+      ],
       "sequenceIndex": 1010,
       "origin": {
         "indexed": "2018-09-11T12:30:00Z",

test/resources/Diff.2.json

@@ -21,6 +21,9 @@
       "audiences": [
         "students"
       ],
+      "categories": [
+        "news"
+      ],
       "sequenceIndex": 1020,
       "origin": {
         "indexed": "2018-09-11T12:30:00Z",

test/resources/Dish.1.json

@@ -19,8 +19,10 @@
     "offers": [
       {
         "availability": "in stock",
-        "availabilityStarts": "2017-01-30T00:00:00.000Z",
-        "availabilityEnds": "2017-01-30T23:59:59.999Z",
+        "availabilityRange": {
+          "gte": "2017-01-30T00:00:00.000Z",
+          "lte": "2017-01-30T23:59:59.999Z"
+        },
         "prices": {
           "default": 4.85,
           "student": 2.85,

test/resources/Dish.2.json

@@ -20,8 +20,10 @@
           "uid": "3b9b3df6-3a7a-58cc-922f-c7335c002634"
         },
         "availability": "in stock",
-        "availabilityStarts": "2017-01-30T00:00:00.000Z",
-        "availabilityEnds": "2017-01-30T23:59:59.999Z",
+        "availabilityRange": {
+          "gte": "2017-01-30T00:00:00.000Z",
+          "lte": "2017-01-30T23:59:59.999Z"
+        },
         "inPlace": {
           "geo": {
             "point": {

test/resources/Dish.3.json

@@ -11,9 +11,11 @@
     ],
     "offers": [
       {
-        "availabilityEnds": "2017-03-27T23:59:59.000Z",
-        "availabilityStarts": "2017-03-27T00:00:00.000Z",
         "availability": "in stock",
+        "availabilityRange": {
+          "gte": "2017-03-27T00:00:00.000Z",
+          "lte": "2017-03-27T23:59:59.000Z"
+        },
         "inPlace": {
           "type": "room",
           "name": "Cafeteria LEVEL",

test/resources/Favorite.json

@@ -6,17 +6,67 @@
     "uid": "3af3ccaa-f066-5eff-9a3d-a70567f3d70d",
     "data": {
       "type": "academic event",
-      "description": "Grundlagen, algebraische Grundbegriffe, Vektorräume, lineare Abbildungen und Gleichungen, Determinanten",
-      "uid": "b17eb963-42b5-5861-adce-2b7b2607ef0a",
-      "name": "Lineare Algebra I für Mathematiker",
+      "description": "Fortsetzung der Algebra I: Galoistheorie mit Anwendungen, ausgewählte Spezialthemen.",
+      "uid": "681a59a1-23c2-5d78-861a-8c86a3abf2b9",
+      "name": "Algebra II",
       "categories": [
         "lecture"
       ],
+      "academicTerms": [
+        {
+          "uid": "aacd5611-b5be-54ce-b39f-c52f7e9a631d",
+          "type": "semester",
+          "name": "Sommersemester 2018",
+          "acronym": "SS 2018",
+          "alternateNames": [
+            "SoSe 2018"
+          ],
+          "startDate": "2018-04-01",
+          "endDate": "2018-09-30",
+          "eventsStartDate": "2018-04-09",
+          "eventsEndDate": "2018-07-13"
+        }
+      ],
+      "performers": [
+        {
+          "type": "person",
+          "uid": "7f8ce700-2679-51a5-86b5-3dfba85a33ff",
+          "givenName": "Peter",
+          "familyName": "Bürgisser",
+          "gender": "male",
+          "honorificPrefix": "Prof. Dr.",
+          "name": "Peter Bürgisser"
+        }
+      ],
       "majors": [
-        "Wirtschaftsmathematik BSc",
-        "Technomathematik BSc",
-        "Mathematik BSc"
-      ]
+        "Mathematik D",
+        "Mathematik L2",
+        "Mathematik StRGym",
+        "Mathematik StRBeruf",
+        "Mathematik BSc",
+        "Mathematik MSc"
+      ],
+      "origin": {
+        "indexed": "2018-09-11T12:30:00Z",
+        "name": "Dummy",
+        "type": "remote",
+        "maintainer": {
+          "type": "organization",
+          "name": "tubIT",
+          "uid": "25f76840-db89-5da2-a8a2-75992f637613"
+        },
+        "modified": "2018-09-01T10:00:00Z",
+        "originalId": "foo bar",
+        "responsibleEntity": {
+          "type": "person",
+          "uid": "7f8ce700-2679-51a5-86b5-3dfba85a33ff",
+          "givenName": "Peter",
+          "familyName": "Bürgisser",
+          "gender": "male",
+          "honorificPrefix": "Prof. Dr.",
+          "name": "Peter Bürgisser"
+        }
+      }
     },
     "origin": {
       "created": "2018-09-11T12:30:00Z",

test/resources/Message.1.json

@@ -9,6 +9,9 @@
     "audiences": [
       "students"
     ],
+    "categories": [
+      "news"
+    ],
     "sequenceIndex": 1001,
     "origin": {
       "indexed": "2018-09-11T12:30:00Z",

test/resources/Message.2.json

@@ -11,6 +11,9 @@
     "audiences": [
       "students"
     ],
+    "categories": [
+      "news"
+    ],
     "sequenceIndex": 1004,
     "origin": {
       "indexed": "2018-09-11T12:30:00Z",

test/resources/Periodical.1.json

@@ -0,0 +1,35 @@
+{
+  "errorNames": [],
+  "instance": {
+    "type": "periodical",
+    "uid": "d921479e-4d35-5cd1-b64a-939cbe40a5b0",
+    "name": "London magazine : a review of literature and the arts",
+    "categories": [
+      "journal"
+    ],
+    "firstPublished": "1954",
+    "publications": [
+      {
+        "uid": "603a6574-8910-588a-9e83-cd26e6988c74",
+        "type": "publication event",
+        "locations": [
+          "London"
+        ],
+        "publisher": "London Magazine",
+        "name": "London Magazine"
+      }
+    ],
+    "ISSNs": [
+      "0024-6085"
+    ],
+    "sameAs": "https://hds2test.hebis.de/ubffm/Record/HEB046847146",
+    "origin": {
+      "indexed": "2018-09-11T12:30:00Z",
+      "name": "HeBIS HDS",
+      "originalId": "HEB046847146",
+      "type": "remote",
+      "url": "https://hds2test.hebis.de/ubffm/"
+    }
+  },
+  "schema": "SCPeriodical"
+}

test/resources/Periodical.2.json

@@ -0,0 +1,32 @@
+{
+  "errorNames": [],
+  "instance": {
+    "type": "periodical",
+    "uid": "c8d7a4f7-88ac-5da3-86c7-32b93d16f00a",
+    "name": "[Frankfurter Allgemeine \/ R F A Z FAZ Republik Heroes], Frankfurter Allgemeine : Zeitung für Deutschland, R. Rhein-Main-Zeitung : Zeitung für Frankfurt",
+    "categories": [
+      "journal"
+    ],
+    "firstPublished": "1988",
+    "publications": [
+      {
+        "uid": "64829217-9eea-532f-8730-7e609efffbca",
+        "type": "publication event",
+        "locations": [
+          "Frankfurt, M."
+        ],
+        "publisher": "Frankfurter Allg. Zeitung",
+        "name": "Frankfurter Allg. Zeitung"
+      }
+    ],
+    "sameAs": "https://hds2test.hebis.de/ubffm/Record/HEB048624853",
+    "origin": {
+      "indexed": "2018-09-11T12:30:00Z",
+      "name": "HeBIS HDS",
+      "originalId": "HEB048624853",
+      "type": "remote",
+      "url": "https://hds2test.hebis.de/ubffm/"
+    }
+  },
+  "schema": "SCPeriodical"
+}

test/resources/SearchRequest.1.json

@@ -22,8 +22,8 @@
           },
           {
             "arguments": {
-              "fromField": "availabilityStarts",
-              "toField": "availabilityEnds",
+              "scope": "d",
+              "field": "availabilityRange",
               "time": "2018-01-15T04:13:00+00:00"
             },
             "type": "availability"

test/resources/Video.1.json

@@ -3,7 +3,7 @@
   "instance": {
     "type": "video",
     "uid": "e274cc82-f51c-566b-b8da-85763ff375e8",
-    "url": "https://vimeo.com/1084537",
+    "sameAs": "https://vimeo.com/1084537",
     "name": "Big Buck Bunny",
     "origin": {
       "indexed": "2018-09-11T12:30:00Z",

test/resources/Video.2.json

@@ -3,7 +3,7 @@
   "instance": {
     "type": "video",
     "uid": "2def52c8-f901-5b30-96fc-ba570a038508",
-    "url": "https://vimeo.com/1084537",
+    "sameAs": "https://vimeo.com/1084537",
     "name": "Big Buck Bunny",
     "sources": [
       {

test/schema.spec.ts

@@ -12,21 +12,55 @@
  * 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 {getProjectReflection} from '@openstapps/core-tools/lib/common';
+import {getTsconfigPath} from '@openstapps/core-tools/lib/common';
 import {validateFiles, writeReport} from '@openstapps/core-tools/lib/validate';
 import {Logger} from '@openstapps/logger';
 import {fail} from 'assert';
 import {expect} from 'chai';
-import {mkdirSync} from 'fs';
+import {mkdirSync, PathLike} from 'fs';
 import {slow, suite, test, timeout} from '@testdeck/mocha';
 import {join, resolve} from 'path';
-import {DeclarationReflection, ProjectReflection} from 'typedoc';
-import {ArrayType, IntrinsicType, ReferenceType, StringLiteralType, Type, UnionType} from 'typedoc/dist/lib/models';
+import {Application, DeclarationReflection, ProjectReflection, TSConfigReader} from 'typedoc';
+import {ArrayType, IntrinsicType, ReferenceType, LiteralType, Type, UnionType} from 'typedoc/dist/lib/models';
 
 process.on('unhandledRejection', (err) => {
   throw err;
 });
 
+/**
+ * Get a project reflection from a path
+ *
+ * @param srcPath Path to get reflection from
+ * @param excludeExternals Exclude external dependencies
+ */
+export function getProjectReflection(srcPath: PathLike, excludeExternals = true): ProjectReflection {
+  Logger.info(`Generating project reflection for ${srcPath.toString()}.`);
+
+  const tsconfigPath = getTsconfigPath(srcPath.toString());
+  let inputFilePath = srcPath;
+  if (inputFilePath === tsconfigPath) {
+    inputFilePath = join(tsconfigPath, 'src');
+  }
+
+  // initialize new Typedoc application
+  const app = new Application();
+  app.options.addReader(new TSConfigReader());
+  app.bootstrap({
+    entryPoints: [inputFilePath.toString()],
+    excludeExternals: excludeExternals,
+    tsconfig: join(tsconfigPath, 'tsconfig.json'),
+  });
+
+  // get project reflection from input files
+  const result = app.convert();
+
+  if (typeof result === 'undefined') {
+    throw new Error('Project reflection could not be generated.');
+  }
+
+  return result;
+}
+
 /**
  * Check if type is a union type
  *
@@ -68,8 +102,8 @@ function isIntrinsicType(type: Type): type is IntrinsicType {
  *
  * @param type Type to check
  */
-function isStringLiteralType(type: Type): type is StringLiteralType {
-  return type.type === 'stringLiteral';
+function isLiteralType(type: Type): type is LiteralType {
+  return type.type === 'literal';
 }
 
 /**
@@ -102,7 +136,7 @@ function getExtendedTypes(thingReflection: DeclarationReflection,
   return extendedTypes;
 }
 
-@suite(timeout(10000), slow(5000))
+@suite(timeout(15000), slow(10000))
 export class SchemaSpec {
   static objects: { [name: string]: DeclarationReflection } = {};
   static reflection: ProjectReflection;
@@ -121,7 +155,7 @@ export class SchemaSpec {
       }
     }
 
-    const thingsReflection = SchemaSpec.objects.SCThingsWithoutDiff;
+    const thingsReflection = SchemaSpec.objects.SCIndexableThings;
 
     // tslint:disable-next-line:no-unused-expression
     expect(thingsReflection).not.to.be.undefined;
@@ -182,6 +216,22 @@ export class SchemaSpec {
 
   @test
   'no property is an SCThing'() {
+    const handleUnionType = (type: UnionType, thingName: string, property: DeclarationReflection) => {
+      for (const nestedType of type.types) {
+        if (isIntrinsicType(nestedType) || isLiteralType(nestedType)) {
+          continue;
+        } else if (isReferenceType(nestedType)) {
+          expect(SchemaSpec.thingNames).not.to.contain(
+            nestedType.name,
+            `Union property '${property.name}' on type '${thingName}' contains type '${nestedType.name}'.`,
+          );
+        } else {
+          // tslint:disable-next-line:max-line-length
+          fail(`'${thingName}'#'${property.name}' union type '${nestedType.type}' is not handled by this test!`);
+        }
+      }
+    }
+
     for (const thingName of SchemaSpec.thingNames) {
       const thingReflection = SchemaSpec.objects[`${thingName}`];
 
@@ -199,8 +249,10 @@ export class SchemaSpec {
           } else if (isArrayType(type)) {
             const elementType = type.elementType;
 
-            if (isIntrinsicType(elementType)) {
+            if (isIntrinsicType(elementType) || isLiteralType(elementType)) {
               continue;
+            } else if (isUnionType(elementType)) {
+              handleUnionType(elementType, thingName, property);
             } else if (isReferenceType(elementType)) {
               expect(SchemaSpec.thingNames).not.to.contain(
                 elementType.name,
@@ -230,19 +282,7 @@ export class SchemaSpec {
               }
             } while (isReferenceType(type));
           } else if (isUnionType(type)) {
-            for (const nestedType of type.types) {
-              if (isIntrinsicType(nestedType) || isStringLiteralType(nestedType)) {
-                continue;
-              } else if (isReferenceType(nestedType)) {
-                expect(SchemaSpec.thingNames).not.to.contain(
-                  nestedType.name,
-                  `Union property '${property.name}' on type '${thingName}' contains type '${nestedType.name}'.`,
-                );
-              } else {
-                // tslint:disable-next-line:max-line-length
-                fail(`'${thingName}'#'${property.name}' union type '${nestedType.type}' is not handled by this test!`);
-              }
-            }
+            handleUnionType(type, thingName, property);
           } else {
             // tslint:disable-next-line:max-line-length
             fail(`'${thingName}'#'${property.name}' with type '${type.type}' is not handled by this test!`);

test/translator.spec.ts

@@ -15,7 +15,7 @@
 import {expect} from 'chai';
 import clone = require('fast-clone');
 import {slow, suite, test, timeout} from '@testdeck/mocha';
-import {SCThingOriginType, SCThingType} from '../src/things/abstract/thing';
+import {SCThingOriginType, SCThingType, SCThingRemoteOrigin} from '../src/things/abstract/thing';
 import {SCBuildingWithoutReferences} from '../src/things/building';
 import {SCDish, SCDishMeta} from '../src/things/dish';
 import {SCSetting, SCSettingInputType} from '../src/things/setting';
@@ -105,142 +105,182 @@ const setting: SCSetting = {
 };
 
 const translator = new SCThingTranslator('de');
-// tslint:disable-next-line:no-eval
-const languageNonExistant = eval("'jp'");
+const translatorEN = new SCThingTranslator('en');
 // this will simulate a translator always utilizing the base language translations
-const translatorWithFallback = new SCThingTranslator(languageNonExistant);
+const translatorWithFallback = new SCThingTranslator('tt');
+
+const translatedThingDE = translator.translate(dish);
+const translatedThingFallback = translatorWithFallback.translate(dish);
 
 // tslint:disable:max-line-length member-ordering newline-per-chained-call prefer-function-over-method completed-docs TranslationSpecInplace
 @suite(timeout(10000), slow(5000))
 export class TranslationSpecInplace {
   @test
-  public directEnumSingleValue () {
-    expect(translator.translate(setting).inputType()).to.equal('einfache Auswahl');
+  public directEnumSingleValue() {
+    expect(translator.translatedAccess(setting).inputType()).to.equal('einfache Auswahl');
   }
 
   @test
   public directStringLiteralType() {
-    expect(translator.translate(dish).type()).to.equal('Essen');
+    expect(translator.translatedAccess(dish).type()).to.equal('Essen');
+    expect(translatedThingDE.type).to.equal('Essen');
   }
 
   @test
   public directStringProperty() {
-    expect(translator.translate(dish).name()).to.equal('de-dish-name');
+    expect(translator.translatedAccess(dish).name()).to.equal('de-dish-name');
+    expect(translatedThingDE.name).to.equal('de-dish-name');
+
   }
 
   @test
   public directArrayOfString() {
-    expect(translator.translate(dish).characteristics()).to.deep
+    expect(translator.translatedAccess(dish).characteristics()).to.deep
       .equal([{name: 'de-characteristic0'}, {name: 'de-characteristic1'}]);
+    expect(translatedThingDE.characteristics).to.deep
+    .equal([{name: 'de-characteristic0'}, {name: 'de-characteristic1'}]);
   }
 
   @test
   public directArrayOfStringSubscript() {
-    expect(translator.translate(dish).characteristics[1]()).to.deep.equal({name: 'de-characteristic1'});
+    expect(translator.translatedAccess(dish).characteristics[1]()).to.deep.equal({name: 'de-characteristic1'});
+    expect(translatedThingDE.characteristics![1]).to.deep.equal({name: 'de-characteristic1'});
   }
 
   @test
   public directMetaArrayOfString() {
-    expect(translator.translate(dish).categories()).to.deep.equal(['Hauptgericht', 'Nachtisch']);
+    expect(translator.translatedAccess(dish).categories()).to.deep.equal(['Hauptgericht', 'Nachtisch']);
+    expect(translatedThingDE.categories).to.deep.equal(['Hauptgericht', 'Nachtisch']);
   }
 
   @test
   public directMetaArrayOfStringSubscript() {
-    expect(translator.translate(dish).categories[1]()).to.equal('Nachtisch');
+    expect(translator.translatedAccess(dish).categories[1]()).to.equal('Nachtisch');
+    expect(translatedThingDE.categories[1]).to.equal('Nachtisch');
   }
 
   @test
   public nestedStringLiteralType() {
-    expect(translator.translate(dish).offers[0].inPlace.type()).to.equal('Gebäude');
+    expect(translator.translatedAccess(dish).offers[0].inPlace.type()).to.equal('Gebäude');
+    expect(translatedThingDE.offers![0].inPlace!.type).to.equal('Gebäude');
   }
 
   @test
   public nestedStringProperty() {
-    expect(translator.translate(dish).offers[0].inPlace.name()).to.equal('de-space-name');
+    expect(translator.translatedAccess(dish).offers[0].inPlace.name()).to.equal('de-space-name');
+    expect(translatedThingDE.offers![0].inPlace!.name).to.equal('de-space-name');
   }
 
   @test
   public nestedMetaArrayOfString() {
-    expect(translator.translate(dish).offers[0].inPlace.categories()).to.deep.equal(['Büro', 'Bildung']);
+    expect(translator.translatedAccess(dish).offers[0].inPlace.categories()).to.deep.equal(['Büro', 'Bildung']);
+    expect(translatedThingDE.offers![0].inPlace!.categories).to.deep.equal(['Büro', 'Bildung']);
   }
 
   @test
   public nestedMetaArrayOfStringSubscript() {
-    expect(translator.translate(dish).offers[0].inPlace.categories[1]()).to.equal('Bildung');
+    expect(translator.translatedAccess(dish).offers[0].inPlace.categories[1]()).to.equal('Bildung');
+    expect(translatedThingDE.offers![0].inPlace!.categories[1]).to.equal('Bildung');
   }
 
   @test
   public directStringLiteralTypeFallback() {
-    expect(translatorWithFallback.translate(dish).type()).to.equal('dish');
+    expect(translatorWithFallback.translatedAccess(dish).type()).to.equal('dish');
+    expect(translatedThingFallback.type).to.equal('dish');
   }
 
   @test
   public directStringPropertyFallback() {
-    expect(translatorWithFallback.translate(dish).name()).to.equal('base-dish-name');
+    expect(translatorWithFallback.translatedAccess(dish).name()).to.equal('base-dish-name');
+    expect(translatedThingFallback.name).to.equal('base-dish-name');
+
   }
 
   @test
   public directArrayOfStringSubscriptFallback() {
-    expect(translatorWithFallback.translate(dish).characteristics[1]())
+    expect(translatorWithFallback.translatedAccess(dish).characteristics[1]())
+      .to.deep.equal({name: 'base-characteristic1'});
+    expect(translatedThingFallback.characteristics![1])
       .to.deep.equal({name: 'base-characteristic1'});
   }
 
   @test
   public directMetaArrayOfStringFallback() {
-    expect(translatorWithFallback.translate(dish).categories()).to.deep.equal(['main dish', 'dessert']);
+    expect(translatorWithFallback.translatedAccess(dish).categories()).to.deep.equal(['main dish', 'dessert']);
+    expect(translatedThingFallback.categories).to.deep.equal(['main dish', 'dessert']);
   }
 
   @test
   public directMetaArrayOfStringSubscriptFallback() {
-    expect(translatorWithFallback.translate(dish).categories[1]()).to.equal('dessert');
+    expect(translatorWithFallback.translatedAccess(dish).categories[1]()).to.equal('dessert');
+    expect(translatedThingFallback.categories[1]).to.equal('dessert');
   }
 
   @test
   public nestedStringLiteralTypeFallback() {
-    expect(translatorWithFallback.translate(dish).offers[0].inPlace.type()).to.equal('building');
+    expect(translatorWithFallback.translatedAccess(dish).offers[0].inPlace.type()).to.equal('building');
+    expect(translatedThingFallback.offers![0].inPlace!.type).to.equal('building');
   }
 
   @test
   public nestedStringPropertyFallback() {
-    expect(translatorWithFallback.translate(dish).offers[0].inPlace.name()).to.equal('base-space-name');
+    expect(translatorWithFallback.translatedAccess(dish).offers[0].inPlace.name()).to.equal('base-space-name');
+    expect(translatedThingFallback.offers![0].inPlace!.name).to.equal('base-space-name');
   }
 
   @test
   public nestedMetaArrayOfStringFallback() {
-    expect(translatorWithFallback.translate(dish).offers[0].inPlace.categories())
+    expect(translatorWithFallback.translatedAccess(dish).offers[0].inPlace.categories())
+      .to.deep.equal(['office', 'education']);
+    expect(translatedThingFallback.offers![0].inPlace!.categories)
       .to.deep.equal(['office', 'education']);
   }
 
   @test
   public nestedMetaArrayOfStringSubscriptFallback() {
-    expect(translatorWithFallback.translate(dish).offers[0].inPlace.categories[1]()).to.equal('education');
+    expect(translatorWithFallback.translatedAccess(dish).offers[0].inPlace.categories[1]()).to.equal('education');
+    expect(translatedThingFallback.offers![0].inPlace!.categories[1]).to.equal('education');
   }
 
   @test
   public directStringLiteralTypeUndefined() {
     // tslint:disable-next-line:no-eval
     const undefinedThing = eval('(x) => undefined;');
-    expect(translator.translate(undefinedThing())('defaultValue')).to.equal('defaultValue');
-    expect(translator.translate(dish).name('defaultValue')).to.not.equal('defaultValue');
+    expect(translator.translatedAccess(undefinedThing())('defaultValue')).to.equal('defaultValue');
+    expect(translator.translatedAccess(dish).name('defaultValue')).to.not.equal('defaultValue');
   }
 
   @test
   public nestedMetaArrayOfStringSubscriptUndefined() {
     // tslint:disable-next-line: no-eval
-    const workingTranslation = eval('translator.translate(dish).offers[0].inPlace.categories[1](\'printer\');');
+    const workingTranslation = eval('translator.translatedAccess(dish).offers[0].inPlace.categories[1](\'printer\');');
     // tslint:disable-next-line: no-eval
-    const defaultValueTranslation = eval('translator.translate(dish).offers[0].inPlace.categories[1234](\'printer\');');
+    const defaultValueTranslation = eval('translator.translatedAccess(dish).offers[0].inPlace.categories[1234](\'printer\');');
 
     expect(defaultValueTranslation).to.equal('printer');
     expect(workingTranslation).to.not.equal('printer');
   }
 
+  @test
+  public reaccessWithChangedSourceOmitsLRUCache() {
+    const translatorDE = new SCThingTranslator('de');
+    const dishCopy = clone(dish);
+    const translatedDish = translatorDE.translatedAccess(dish);
+    const distructivelyTranslatedDish = translatorDE.translate(dish);
+
+    (dishCopy.origin as SCThingRemoteOrigin).name = 'tranlator.spec';
+    expect(translatorDE.translatedAccess(dishCopy)).not.to.deep.equal(translatedDish);
+    expect(translatorDE.translate(dishCopy)).not.to.equal(distructivelyTranslatedDish);
+  }
+
   @test
   public changingTranslatorLanguageFlushesItsLRUCache() {
     const translatorDE = new SCThingTranslator('de');
-    expect(translatorDE.translate(dish).name()).to.equal('de-dish-name');
+    expect(translatorDE.translatedAccess(dish).name()).to.equal('de-dish-name');
+    expect(translatorDE.translate(dish).name).to.equal('de-dish-name');
     translatorDE.language = 'en';
-    expect(translatorDE.translate(dish).name()).to.equal('base-dish-name');
+    expect(translatorDE.translatedAccess(dish).name()).to.equal('base-dish-name');
+    expect(translatorDE.translate(dish).name).to.equal('base-dish-name');
   }
 
   @test
@@ -250,7 +290,7 @@ export class TranslationSpecInplace {
     for (let i = 0; i < 201; i++) {
       const anotherDish = Object.assign({}, dish);
       anotherDish.uid = String(i);
-      expect(translatorDE.translate(anotherDish).name()).to.equal('de-dish-name');
+      expect(translatorDE.translatedAccess(anotherDish).name()).to.equal('de-dish-name');
     }
   }
 }
@@ -262,7 +302,7 @@ export class MetaTranslationSpec {
   @test
   public consistencyWithMetaClass() {
     const dishMetaTranslationsDE = translator.translatedPropertyNames(dish.type);
-    const dishMetaTranslationsEN = translator.translatedPropertyNames(dish.type, 'en');
+    const dishMetaTranslationsEN = translatorEN.translatedPropertyNames(dish.type);
     expect(dishMetaTranslationsEN).to.not.deep.equal(dishMetaTranslationsDE);
     expect(dishMetaTranslationsDE).to.deep.equal(SCDishMeta.getInstance().fieldTranslations.de);
     expect(dishMetaTranslationsEN).to.deep.equal(SCDishMeta.getInstance().fieldTranslations.en);
@@ -271,17 +311,17 @@ export class MetaTranslationSpec {
   @test
   public retrieveTranslatedPropertyValueType() {
     const dishTypeDE = translator.translatedPropertyValue(dish.type, 'type');
-    const dishTypeEN = translator.translatedPropertyValue(dish.type, 'type', undefined, 'en');
+    const dishTypeEN = translatorEN.translatedPropertyValue(dish.type, 'type', undefined);
     const dishTypeBASE = translatorWithFallback.translatedPropertyValue(dish.type, 'type');
     expect(dishTypeDE).to.deep.equal(SCDishMeta.getInstance().fieldValueTranslations.de.type);
     expect(dishTypeEN).to.deep.equal(SCDishMeta.getInstance().fieldValueTranslations.en.type);
-    expect(dishTypeBASE).to.be.undefined;
+    expect(dishTypeBASE).to.deep.equal(SCDishMeta.getInstance().fieldValueTranslations.en.type);
   }
 
   @test
   public retrieveTranslatedPropertyValueNested() {
-    const dishTypeDE = translator.translatedPropertyValue<SCDish>(dish.type, 'categories', 'main dish');
-    const dishTypeEN = translator.translatedPropertyValue<SCDish>(dish.type, 'categories', 'main dish', 'en');
+    const dishTypeDE = translator.translatedPropertyValue(dish.type, 'categories', 'main dish');
+    const dishTypeEN = translatorEN.translatedPropertyValue(dish.type, 'categories', 'main dish');
     const dishTypeBASE = translatorWithFallback.translatedPropertyValue(dish.type, 'categories', 'main dish');
     expect(dishTypeDE).to.deep.equal(SCDishMeta.getInstance<SCDishMeta>().fieldValueTranslations.de.categories['main dish']);
     expect(dishTypeEN).to.deep.equal(dish.categories[0]);

test/type.spec.ts

@@ -39,6 +39,8 @@ import {SCTicket, SCTicketWithoutReferences} from '../src/things/ticket';
 import {SCToDo, SCToDoWithoutReferences} from '../src/things/todo';
 import {SCTour, SCTourWithoutReferences} from '../src/things/tour';
 import {SCVideo, SCVideoWithoutReferences} from '../src/things/video';
+import {SCPeriodical, SCPeriodicalWithoutReferences} from '../src/things/periodical';
+import {SCPublicationEvent, SCPublicationEventWithoutReferences} from '../src/things/publication-event';
 
 // tslint:disable:no-any
 // tslint:disable:completed-docs
@@ -226,6 +228,17 @@ assert<Has<SCOrganizationPropertyTypes, SCThing>>(false);
 assert<Extends<SCOrganizationWithoutReferences, SCThing>>(false);
 assert<Extends<SCOrganization, SCThing>>(true);
 
+/**
+ * Types of properties of SCPeriodical
+ */
+type SCPeriodicalPropertyTypes = PropertyTypesNested<SCPeriodical>;
+assert<NotHas<SCPeriodicalPropertyTypes, SCThingWithoutReferences>>(false);
+assert<Has<SCPeriodicalPropertyTypes, SCThingWithoutReferences>>(true);
+assert<NotHas<SCPeriodicalPropertyTypes, SCThing>>(true);
+assert<Has<SCPeriodicalPropertyTypes, SCThing>>(false);
+assert<Extends<SCPeriodicalWithoutReferences, SCThing>>(false);
+assert<Extends<SCPeriodical, SCThing>>(true);
+
 /**
  * Types of properties of SCPerson
  */
@@ -248,6 +261,17 @@ assert<Has<SCPointOfInterestPropertyTypes, SCThing>>(false);
 assert<Extends<SCPointOfInterestWithoutReferences, SCThing>>(false);
 assert<Extends<SCPointOfInterest, SCThing>>(true);
 
+/**
+ * Types of properties of SCPublicationEvent
+ */
+type SCPublicationEventPropertyTypes = PropertyTypesNested<SCPublicationEvent>;
+assert<NotHas<SCPublicationEventPropertyTypes, SCThingWithoutReferences>>(false);
+assert<Has<SCPublicationEventPropertyTypes, SCThingWithoutReferences>>(true);
+assert<NotHas<SCPublicationEventPropertyTypes, SCThing>>(true);
+assert<Has<SCPublicationEventPropertyTypes, SCThing>>(false);
+assert<Extends<SCPublicationEventWithoutReferences, SCThing>>(false);
+assert<Extends<SCPublicationEvent, SCThing>>(true);
+
 /**
  * Types of properties of SCRoom
  */