0.55.0

CHANGELOG.md

@@ -1,3 +1,55 @@
+# [0.54.0](https://gitlab.com/openstapps/core/compare/v0.53.0...v0.54.0) (2021-11-17)
+
+
+### Features
+
+* add SCAssessment ([7a2e0f2](https://gitlab.com/openstapps/core/commit/7a2e0f20d1c64ab1deb7ab30bfb4bab4daaabd6d))
+
+
+
+# [0.53.0](https://gitlab.com/openstapps/core/compare/v0.52.0...v0.53.0) (2021-10-19)
+
+
+
+# [0.52.0](https://gitlab.com/openstapps/core/compare/v0.51.0...v0.52.0) (2021-09-28)
+
+
+### Features
+
+* add about config ([aa294c4](https://gitlab.com/openstapps/core/commit/aa294c4e29e9191bef6d79487b0b321fbc34f6fb))
+
+
+
+# [0.51.0](https://gitlab.com/openstapps/core/compare/v0.50.0...v0.51.0) (2021-09-10)
+
+
+### Bug Fixes
+
+* add physicalobject to book categories ([ded8e7d](https://gitlab.com/openstapps/core/commit/ded8e7dfd51094c02a86e1383a4e94c069c10e64))
+
+
+
+# [0.50.0](https://gitlab.com/openstapps/core/compare/v0.49.5...v0.50.0) (2021-09-01)
+
+
+
+## [0.49.5](https://gitlab.com/openstapps/core/compare/v0.49.3...v0.49.5) (2021-08-27)
+
+
+### Bug Fixes
+
+* test resources from hds2 ([dfe35d7](https://gitlab.com/openstapps/core/commit/dfe35d71a38c35064726365f99714abff3b30ba6))
+
+
+
+## [0.49.3](https://gitlab.com/openstapps/core/compare/v0.49.2...v0.49.3) (2021-08-18)
+
+
+
+## [0.49.2](https://gitlab.com/openstapps/core/compare/v0.49.1...v0.49.2) (2021-08-17)
+
+
+
 ## [0.49.1](https://gitlab.com/openstapps/core/compare/v0.49.0...v0.49.1) (2021-08-13)
 
 

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openstapps/core",
-  "version": "0.49.2",
+  "version": "0.55.0",
   "description": "StAppsCore - Generalized model of data",
   "keywords": [
     "Model",
@@ -45,36 +45,39 @@
     "Wieland Schöbl"
   ],
   "dependencies": {
-    "@openstapps/core-tools": "0.23.2",
+    "@openstapps/core-tools": "0.27.0",
     "@types/geojson": "1.0.6",
     "@types/json-patch": "0.0.30",
     "@types/json-schema": "7.0.9",
-    "@types/node": "14.17.9",
+    "@types/node": "14.18.0",
     "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.3.0",
+    "json-schema": "0.4.0",
     "ts-optchain": "0.1.8"
   },
   "devDependencies": {
-    "@openstapps/configuration": "0.27.0",
+    "@openstapps/configuration": "0.29.0",
     "@openstapps/es-mapping-generator": "0.0.3",
-    "@openstapps/logger": "0.7.0",
-    "@testdeck/mocha": "0.1.2",
-    "@types/chai": "4.2.21",
-    "@types/rimraf": "3.0.1",
+    "@openstapps/logger": "0.8.0",
+    "@testdeck/mocha": "0.2.0",
+    "@types/chai": "4.3.0",
+    "@types/lodash": "4.14.178",
+    "@types/mocha": "9.0.0",
+    "@types/rimraf": "3.0.2",
     "chai": "4.3.4",
     "conditional-type-checks": "1.0.5",
     "conventional-changelog-cli": "2.1.1",
-    "mocha": "8.4.0",
+    "lodash": "4.17.21",
+    "mocha": "9.1.3",
     "nyc": "15.1.0",
     "rimraf": "3.0.2",
-    "source-map-support": "0.5.19",
+    "source-map-support": "0.5.21",
     "surge": "0.23.0",
-    "ts-node": "9.1.1",
+    "ts-node": "10.4.0",
     "tslint": "6.1.3",
-    "typedoc": "0.21.5",
+    "typedoc": "0.21.6",
     "typescript": "4.3.5"
   },
   "nyc": {

src/config/app.ts

@@ -15,6 +15,7 @@
 // tslint:disable-next-line:no-implicit-dependencies
 import {Polygon} from 'geojson';
 import {SCTranslations} from '../general/i18n';
+import {SCMap} from '../general/map';
 import {SCLanguageSetting, SCSetting, SCUserGroupSetting} from '../things/setting';
 
 /**
@@ -80,6 +81,13 @@ export interface SCAppConfigurationMenuCategory {
  * An app configuration
  */
 export interface SCAppConfiguration {
+  /**
+   * The about page
+   *
+   * Mapping route -> page config
+   */
+  aboutPages: SCMap<SCAboutPage>;
+
   /**
    * Polygon that encapsulates the main campus
    */
@@ -174,3 +182,147 @@ export interface SCAppConfigurationMenuCategoryTranslationName {
    */
   name: string;
 }
+
+export enum SCAboutPageContentType {
+  SECTION = 'section',
+  ROUTER_LINK = 'router link',
+  TABLE = 'table',
+  MARKDOWN = 'markdown',
+}
+
+export interface SCAboutPageTranslationTitle {
+  /**
+   * Translation of the title
+   */
+  title: string;
+}
+
+export interface SCAboutPageTranslationValue {
+  /**
+   * Translation of the value
+   */
+  value: string;
+}
+
+/**
+ * A (mostly) self-contained section, akin to markdown `# Title`
+ */
+export interface SCAboutPageSection {
+  /**
+   * If the section should be contained in a card
+   */
+  card?: true;
+
+  /**
+   * The content of the section
+   */
+  content: SCAboutPageContent;
+
+  /**
+   * The title of the section
+   */
+  title: string;
+
+  /**
+   * Translations
+   */
+  translations: SCTranslations<SCAboutPageTranslationTitle>;
+
+  /**
+   * Type
+   */
+  type: SCAboutPageContentType.SECTION;
+}
+
+/**
+ * A router link that can lead to a new page
+ *
+ * For external links, prefer markdown `[destination](link)`
+ */
+export interface SCAboutPageRouterLink {
+  /**
+   * Icon of the destination
+   */
+  icon?: string;
+
+  /**
+   * Router link
+   */
+  link: string;
+
+  /**
+   * Title of the destination
+   */
+  title: string;
+
+  /**
+   * Translations
+   */
+  translations: SCTranslations<SCAboutPageTranslationTitle>;
+
+  /**
+   * Type
+   */
+  type: SCAboutPageContentType.ROUTER_LINK;
+}
+
+/**
+ * A simple table element
+ */
+export interface SCAboutPageTable {
+  /**
+   * Rows of the table
+   */
+  rows: SCAboutPageContent[][];
+
+  /**
+   * Type
+   */
+  type: SCAboutPageContentType.TABLE;
+}
+
+/**
+ * A markdown element
+ */
+export interface SCAboutPageMarkdown {
+  /**
+   * Translations
+   */
+  translations: SCTranslations<SCAboutPageTranslationValue>;
+
+  /**
+   * Type
+   */
+  type: SCAboutPageContentType.MARKDOWN;
+
+  /**
+   * Value (Markdown)
+   */
+  value: string;
+}
+
+export type SCAboutPageContent =
+  | SCAboutPageMarkdown
+  | SCAboutPageTable
+  | SCAboutPageSection
+  | SCAboutPageRouterLink;
+
+/**
+ * Root of the about page
+ */
+export interface SCAboutPage {
+  /**
+   * Content of the page
+   */
+  content: SCAboutPageContent[];
+
+  /**
+   * Header (title) of the page
+   */
+  title: string;
+
+  /**
+   * Translations
+   */
+  translations: SCTranslations<SCAboutPageTranslationTitle>;
+}

src/general/time.ts

@@ -16,7 +16,7 @@
 /**
  * An ISO8601 date
  *
- * @pattern ^([\+-]?\d{4}(?!\d{2}\b))((-?)((0[1-9]|1[0-2])(\3([12]\d|0[1-9]|3[01]))?|W([0-4]\d|5[0-2])(-?[1-7])?|(00[1-9]|0[1-9]\d|[12]\d{2}|3([0-5]\d|6[1-6])))([T\s]((([01]\d|2[0-3])((:?)[0-5]\d)?|24\:?00)([\.,]\d+(?!:))?)?(\17[0-5]\d([\.,]\d+)?)?([zZ]|([\+-])([01]\d|2[0-3]):?([0-5]\d)?)?)?)?$
+ * @pattern ^(-?(?:[1-9][0-9]*)?[0-9]{4})-(1[0-2]|0[1-9])-(3[01]|0[1-9]|[12][0-9])(T(2[0-3]|[01][0-9]):([0-5][0-9]):([0-5][0-9])([\.,][0-9]{0,7})?(Z|[+-](?:2[0-3]|[01][0-9])(:?[0-5][0-9])?)?)?$
  * @see https://gist.github.com/philipashlock/8830168
  *
  * @date
@@ -37,6 +37,6 @@ export type SCISO8601Duration = string;
 /**
  * An ISO8601 time
  *
- * @pattern \d{2}:\d{2}(:\d{2})?
+ * @pattern ^(2[0-3]|[01][0-9]):?([0-5][0-9]):?([0-5][0-9])$
  */
 export type SCISO8601Time = string;

src/meta.ts

@@ -15,11 +15,12 @@
 import {SCThingType} from './things/abstract/thing';
 import {SCAcademicEvent, SCAcademicEventMeta, SCAcademicEventWithoutReferences} from './things/academic-event';
 import {SCArticle, SCArticleMeta, SCArticleWithoutReferences} from './things/article';
+import {SCAssessment, SCAssessmentMeta, SCAssessmentWithoutReferences} from './things/assessment';
 import {SCBook, SCBookMeta, SCBookWithoutReferences} from './things/book';
 import {SCBuilding, SCBuildingMeta, SCBuildingWithoutReferences} from './things/building';
 import {SCCatalog, SCCatalogMeta, SCCatalogWithoutReferences} from './things/catalog';
 import {SCContactPoint, SCContactPointMeta, SCContactPointWithoutReferences} from './things/contact-point';
-import {SCCourseOfStudies, SCCourseOfStudiesMeta, SCCourseOfStudiesWithoutReferences} from './things/course-of-studies';
+import {SCCourseOfStudy, SCCourseOfStudyMeta, SCCourseOfStudyWithoutReferences} from './things/course-of-study';
 import {SCDateSeries, SCDateSeriesMeta, SCDateSeriesWithoutReferences} from './things/date-series';
 import {SCDiff, SCDiffMeta, SCDiffWithoutReferences} from './things/diff';
 import {SCDish, SCDishMeta, SCDishWithoutReferences} from './things/dish';
@@ -51,13 +52,14 @@ import {SCVideo, SCVideoMeta, SCVideoWithoutReferences} from './things/video';
  */
 export const SCClasses: { [K in SCThingType]: object } = {
   /* tslint:enable */
+  'assessment': SCAssessmentMeta,
   'academic event': SCAcademicEventMeta,
   'article': SCArticleMeta,
   'book': SCBookMeta,
   'building': SCBuildingMeta,
   'catalog': SCCatalogMeta,
   'contact point': SCContactPointMeta,
-  'course of studies': SCCourseOfStudiesMeta,
+  'course of study': SCCourseOfStudyMeta,
   'date series': SCDateSeriesMeta,
   'diff': SCDiffMeta,
   'dish': SCDishMeta,
@@ -81,13 +83,14 @@ export const SCClasses: { [K in SCThingType]: object } = {
 };
 
 export type SCIndexableThings =
-  SCAcademicEvent
+  SCAssessment
+  | SCAcademicEvent
   | SCArticle
   | SCBook
   | SCBuilding
   | SCCatalog
   | SCContactPoint
-  | SCCourseOfStudies
+  | SCCourseOfStudy
   | SCDateSeries
   | SCDish
   | SCFloor
@@ -122,64 +125,66 @@ export type SCThingsField = keyof SCThings | string;
  * Thing without references for a thing
  */
 export type SCAssociatedThingWithoutReferences<THING extends SCThings> =
-  THING extends SCAcademicEvent ? SCAcademicEventWithoutReferences :
-    THING extends SCArticle ? SCArticleWithoutReferences :
-      THING extends SCBook ? SCBookWithoutReferences :
-        THING extends SCBuilding ? SCBuildingWithoutReferences :
-          THING extends SCCatalog ? SCCatalogWithoutReferences :
-            THING extends SCContactPoint ? SCContactPointWithoutReferences :
-              THING extends SCCourseOfStudies ? SCCourseOfStudiesWithoutReferences :
-                THING extends SCDateSeries ? SCDateSeriesWithoutReferences :
-                  THING extends SCDiff ? SCDiffWithoutReferences :
-                    THING extends SCDish ? SCDishWithoutReferences :
-                      THING extends SCFavorite ? SCFavoriteWithoutReferences :
-                        THING extends SCFloor ? SCFloorWithoutReferences :
-                          THING extends SCMessage ? SCMessageWithoutReferences :
-                            THING extends SCOrganization ? SCOrganizationWithoutReferences :
-                              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 extends SCAssessment ? SCAssessmentWithoutReferences :
+    THING extends SCAcademicEvent ? SCAcademicEventWithoutReferences :
+      THING extends SCArticle ? SCArticleWithoutReferences :
+        THING extends SCBook ? SCBookWithoutReferences :
+          THING extends SCBuilding ? SCBuildingWithoutReferences :
+            THING extends SCCatalog ? SCCatalogWithoutReferences :
+              THING extends SCContactPoint ? SCContactPointWithoutReferences :
+                THING extends SCCourseOfStudy ? SCCourseOfStudyWithoutReferences :
+                  THING extends SCDateSeries ? SCDateSeriesWithoutReferences :
+                    THING extends SCDiff ? SCDiffWithoutReferences :
+                      THING extends SCDish ? SCDishWithoutReferences :
+                        THING extends SCFavorite ? SCFavoriteWithoutReferences :
+                          THING extends SCFloor ? SCFloorWithoutReferences :
+                            THING extends SCMessage ? SCMessageWithoutReferences :
+                              THING extends SCOrganization ? SCOrganizationWithoutReferences :
+                                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
  */
 export type SCAssociatedThing<THING extends SCThings> =
-  THING extends SCAcademicEventWithoutReferences ? SCAcademicEvent :
-    THING extends SCArticleWithoutReferences ? SCArticle :
-      THING extends SCBookWithoutReferences ? SCBook :
-        THING extends SCBuildingWithoutReferences ? SCBuilding :
-          THING extends SCCatalogWithoutReferences ? SCCatalog :
-            THING extends SCContactPointWithoutReferences ? SCContactPoint :
-              THING extends SCCourseOfStudiesWithoutReferences ? SCCourseOfStudies :
-                THING extends SCDateSeriesWithoutReferences ? SCDateSeries :
-                  THING extends SCDiffWithoutReferences ? SCDiff :
-                    THING extends SCDishWithoutReferences ? SCDish :
-                      THING extends SCFavoriteWithoutReferences ? SCFavorite :
-                        THING extends SCFloorWithoutReferences ? SCFloor :
-                          THING extends SCMessageWithoutReferences ? SCMessage :
-                            THING extends SCOrganizationWithoutReferences ? SCOrganization :
-                              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;
+  THING extends SCAssessmentWithoutReferences ? SCAssessment :
+    THING extends SCAcademicEventWithoutReferences ? SCAcademicEvent :
+      THING extends SCArticleWithoutReferences ? SCArticle :
+        THING extends SCBookWithoutReferences ? SCBook :
+          THING extends SCBuildingWithoutReferences ? SCBuilding :
+            THING extends SCCatalogWithoutReferences ? SCCatalog :
+              THING extends SCContactPointWithoutReferences ? SCContactPoint :
+                THING extends SCCourseOfStudyWithoutReferences ? SCCourseOfStudy :
+                  THING extends SCDateSeriesWithoutReferences ? SCDateSeries :
+                    THING extends SCDiffWithoutReferences ? SCDiff :
+                      THING extends SCDishWithoutReferences ? SCDish :
+                        THING extends SCFavoriteWithoutReferences ? SCFavorite :
+                          THING extends SCFloorWithoutReferences ? SCFloor :
+                            THING extends SCMessageWithoutReferences ? SCMessage :
+                              THING extends SCOrganizationWithoutReferences ? SCOrganization :
+                                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

@@ -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 {BAD_GATEWAY} from 'http-status-codes';
+import {StatusCodes} from 'http-status-codes';
 import {SCError} from '../error';
 
 /**
@@ -34,7 +34,7 @@ export class SCInternalServerErrorResponse extends SCError {
    * and the internal server error should be displayed to the client
    */
   constructor(err?: Error, stack = false) {
-    super('InternalServerError', 'Internal server error', BAD_GATEWAY, stack);
+    super('InternalServerError', 'Internal server error', StatusCodes.BAD_GATEWAY, stack);
 
     if (stack) {
       this.additionalData = err;

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

@@ -12,7 +12,7 @@
  * You should have received a copy of the GNU General Public License along with
  * this program. If not, see <https://www.gnu.org/licenses/>.
  */
-import {METHOD_NOT_ALLOWED} from 'http-status-codes';
+import {StatusCodes} from 'http-status-codes';
 import {SCError} from '../error';
 
 /**
@@ -27,6 +27,6 @@ export class SCMethodNotAllowedErrorResponse extends SCError {
    * @param stack Set to true if a stack trace should be created
    */
   constructor(stack?: boolean) {
-    super('MethodNotAllowedError', 'HTTP method is not allowed on this route', METHOD_NOT_ALLOWED, stack);
+    super('MethodNotAllowedError', 'HTTP method is not allowed on this route', StatusCodes.METHOD_NOT_ALLOWED, stack);
   }
 }

src/protocol/errors/not-found.ts

@@ -12,7 +12,7 @@
  * You should have received a copy of the GNU General Public License along with
  * this program. If not, see <https://www.gnu.org/licenses/>.
  */
-import {NOT_FOUND} from 'http-status-codes';
+import {StatusCodes} from 'http-status-codes';
 import {SCError} from '../error';
 
 /**
@@ -27,6 +27,6 @@ export class SCNotFoundErrorResponse extends SCError {
    * @param stack Set to true if a stack trace should be created
    */
   constructor(stack?: boolean) {
-    super('NotFoundError', 'Resource not found', NOT_FOUND, stack);
+    super('NotFoundError', 'Resource not found', StatusCodes.NOT_FOUND, stack);
   }
 }

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

@@ -12,7 +12,7 @@
  * You should have received a copy of the GNU General Public License along with
  * this program. If not, see <https://www.gnu.org/licenses/>.
  */
-import {NOT_ACCEPTABLE} from 'http-status-codes';
+import {StatusCodes} from 'http-status-codes';
 import {SCError} from '../error';
 
 /**
@@ -29,6 +29,6 @@ export class SCParametersNotAcceptable extends SCError {
    * @param stack Set to true if a stack trace should be created
    */
   constructor(message: string, stack?: boolean) {
-    super('ParametersNotAcceptable', message, NOT_ACCEPTABLE, stack);
+    super('ParametersNotAcceptable', message, StatusCodes.NOT_ACCEPTABLE, stack);
   }
 }

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

@@ -12,7 +12,7 @@
  * You should have received a copy of the GNU General Public License along with
  * this program. If not, see <https://www.gnu.org/licenses/>.
  */
-import {CONFLICT} from 'http-status-codes';
+import {StatusCodes} from 'http-status-codes';
 import {SCError} from '../error';
 import {SCPluginMetaData} from '../routes/plugin-register';
 
@@ -38,7 +38,7 @@ export class SCPluginAlreadyRegisteredErrorResponse extends SCError {
    * @param stack Set to true if a stack trace should be created
    */
   constructor(message: string, plugin: SCPluginMetaData, stack = false) {
-    super('SCPluginAlreadyRegisteredError', message, CONFLICT, stack);
+    super('SCPluginAlreadyRegisteredError', message, StatusCodes.CONFLICT, stack);
     if (stack) {
       this.additionalData = plugin;
     }

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

@@ -12,7 +12,7 @@
  * You should have received a copy of the GNU General Public License along with
  * this program. If not, see <https://www.gnu.org/licenses/>.
  */
-import {INTERNAL_SERVER_ERROR} from 'http-status-codes';
+import {StatusCodes} from 'http-status-codes';
 import {SCError} from '../error';
 
 /**
@@ -28,6 +28,6 @@ export class SCPluginRegisteringFailedErrorResponse extends SCError {
    * @param stack Set to true if a stack trace should be created
    */
   constructor(message: string, stack?: boolean) {
-    super('PluginRegisteringFailedError', message, INTERNAL_SERVER_ERROR, stack);
+    super('PluginRegisteringFailedError', message, StatusCodes.INTERNAL_SERVER_ERROR, stack);
   }
 }

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

@@ -12,7 +12,7 @@
  * You should have received a copy of the GNU General Public License along with
  * this program. If not, see <https://www.gnu.org/licenses/>.
  */
-import {REQUEST_TOO_LONG} from 'http-status-codes';
+import {StatusCodes} from 'http-status-codes';
 import {SCError} from '../error';
 
 /**
@@ -27,6 +27,6 @@ export class SCRequestBodyTooLargeErrorResponse extends SCError {
    * @param stack Set to true if a stack trace should be created
    */
   constructor(stack?: boolean) {
-    super('RequestBodyTooLargeError', 'The request body is too large.', REQUEST_TOO_LONG, stack);
+    super('RequestBodyTooLargeError', 'The request body is too large.', StatusCodes.REQUEST_TOO_LONG, stack);
   }
 }

src/protocol/errors/syntax-error.ts

@@ -12,12 +12,12 @@
  * You should have received a copy of the GNU General Public License along with
  * this program. If not, see <https://www.gnu.org/licenses/>.
  */
-import {BAD_REQUEST} from 'http-status-codes';
+import {StatusCodes} from 'http-status-codes';
 import {SCError} from '../error';
 
 /**
  * An error that is returned whenever there is a syntax error
- * 
+ *
  * @validatable
  */
 export class SCSyntaxErrorResponse extends SCError {
@@ -28,6 +28,6 @@ export class SCSyntaxErrorResponse extends SCError {
    * @param stack Set to true if a stack trace should be created
    */
   constructor(message: string, stack?: boolean) {
-    super('SyntaxError', message, BAD_REQUEST, stack);
+    super('SyntaxError', message, StatusCodes.BAD_REQUEST, stack);
   }
 }

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

@@ -12,12 +12,12 @@
  * You should have received a copy of the GNU General Public License along with
  * this program. If not, see <https://www.gnu.org/licenses/>.
  */
-import {TOO_MANY_REQUESTS} from 'http-status-codes';
+import {StatusCodes} from 'http-status-codes';
 import {SCError} from '../error';
 
 /**
  * An error that is returned, when to many request are submitted at once
- * 
+ *
  * @validatable
  */
 export class SCTooManyRequestsErrorResponse extends SCError {
@@ -30,7 +30,7 @@ export class SCTooManyRequestsErrorResponse extends SCError {
     super(
       'TooManyRequestsError',
       'Too many requests. You can not submit more than 5 queries an once',
-      TOO_MANY_REQUESTS,
+      StatusCodes.TOO_MANY_REQUESTS,
       stack,
     );
   }

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

@@ -12,7 +12,7 @@
  * You should have received a copy of the GNU General Public License along with
  * this program. If not, see <https://www.gnu.org/licenses/>.
  */
-import {UNSUPPORTED_MEDIA_TYPE} from 'http-status-codes';
+import {StatusCodes} from 'http-status-codes';
 import {SCError} from '../error';
 
 /**
@@ -27,6 +27,6 @@ export class SCUnsupportedMediaTypeErrorResponse extends SCError {
    * @param stack Set to true if a stack trace should be created
    */
   constructor(stack?: boolean) {
-    super('UnsupportedMediaTypeError', 'Unsupported media type', UNSUPPORTED_MEDIA_TYPE, stack);
+    super('UnsupportedMediaTypeError', 'Unsupported media type', StatusCodes.UNSUPPORTED_MEDIA_TYPE, stack);
   }
 }

src/protocol/errors/validation.ts

@@ -12,8 +12,8 @@
  * You should have received a copy of the GNU General Public License along with
  * this program. If not, see <https://www.gnu.org/licenses/>.
  */
-import {ValidationError} from '@openstapps/core-tools/lib/common';
-import {BAD_REQUEST} from 'http-status-codes';
+import {ValidationError} from '@openstapps/core-tools/lib/types/validator';
+import {StatusCodes} from 'http-status-codes';
 import {SCError} from '../error';
 
 /**
@@ -34,7 +34,7 @@ export class SCValidationErrorResponse extends SCError {
    * @param stack Set to true if a stack trace should be created
    */
   constructor(errors: ValidationError[], stack?: boolean) {
-    super('ValidationError', 'Validation of request failed', BAD_REQUEST, stack);
+    super('ValidationError', 'Validation of request failed', StatusCodes.BAD_REQUEST, stack);
     this.additionalData = errors;
   }
 }

src/protocol/routes/book-availability.ts

@@ -12,7 +12,7 @@
  * You should have received a copy of the GNU General Public License along with
  * this program. If not, see <https://www.gnu.org/licenses/>.
  */
-import {OK} from 'http-status-codes';
+import {StatusCodes} from 'http-status-codes';
 import {SCUuid} from '../../general/uuid';
 import {SCAcademicPriceGroup, SCThingThatCanBeOfferedOffer} from '../../things/abstract/thing-that-can-be-offered';
 import {SCInternalServerErrorResponse} from '../errors/internal-server-error';
@@ -88,7 +88,7 @@ export class SCBookAvailabilityRoute extends SCAbstractRoute {
     this.method = SCRouteHttpVerbs.POST;
     this.requestBodyName = 'SCBookAvailabilityRequest';
     this.responseBodyName = 'SCBookAvailabilityResponse';
-    this.statusCodeSuccess = OK;
+    this.statusCodeSuccess = StatusCodes.OK;
     this.urlFragment = '/bookAvailability';
   }
 }

src/protocol/routes/bulk-add.ts

@@ -12,7 +12,7 @@
  * You should have received a copy of the GNU General Public License along with
  * this program. If not, see <https://www.gnu.org/licenses/>.
  */
-import {CREATED} from 'http-status-codes';
+import {StatusCodes} from 'http-status-codes';
 import {SCThings} from '../../meta';
 import {SCInternalServerErrorResponse} from '../errors/internal-server-error';
 import {SCMethodNotAllowedErrorResponse} from '../errors/method-not-allowed';
@@ -59,7 +59,7 @@ export class SCBulkAddRoute extends SCAbstractRoute {
     };
     this.requestBodyName = 'SCBulkAddRequest';
     this.responseBodyName = 'SCBulkAddResponse';
-    this.statusCodeSuccess = CREATED;
+    this.statusCodeSuccess = StatusCodes.CREATED;
     this.urlFragment = '/bulk/:UID';
   }
 }

src/protocol/routes/bulk-done.ts

@@ -12,7 +12,7 @@
  * You should have received a copy of the GNU General Public License along with
  * this program. If not, see <https://www.gnu.org/licenses/>.
  */
-import {NO_CONTENT} from 'http-status-codes';
+import {StatusCodes} from 'http-status-codes';
 import {SCInternalServerErrorResponse} from '../errors/internal-server-error';
 import {SCMethodNotAllowedErrorResponse} from '../errors/method-not-allowed';
 import {SCNotFoundErrorResponse} from '../errors/not-found';
@@ -59,7 +59,7 @@ export class SCBulkDoneRoute extends SCAbstractRoute {
     };
     this.requestBodyName = 'SCBulkDoneRequest';
     this.responseBodyName = 'SCBulkDoneResponse';
-    this.statusCodeSuccess = NO_CONTENT;
+    this.statusCodeSuccess = StatusCodes.NO_CONTENT;
     this.urlFragment = '/bulk/:UID/done';
   }
 }

src/protocol/routes/bulk-request.ts

@@ -12,7 +12,7 @@
  * You should have received a copy of the GNU General Public License along with
  * this program. If not, see <https://www.gnu.org/licenses/>.
  */
-import {OK} from 'http-status-codes';
+import {StatusCodes} from 'http-status-codes';
 import {SCISO8601Date} from '../../general/time';
 import {SCUuid} from '../../general/uuid';
 import {SCThingType} from '../../things/abstract/thing';
@@ -98,7 +98,7 @@ export class SCBulkRoute extends SCAbstractRoute {
     this.method = SCRouteHttpVerbs.POST;
     this.requestBodyName = 'SCBulkRequest';
     this.responseBodyName = 'SCBulkResponse';
-    this.statusCodeSuccess = OK;
+    this.statusCodeSuccess = StatusCodes.OK;
     this.urlFragment = '/bulk';
   }
 }

src/protocol/routes/feedback.ts

@@ -12,7 +12,7 @@
  * You should have received a copy of the GNU General Public License along with
  * this program. If not, see <https://www.gnu.org/licenses/>.
  */
-import {NO_CONTENT} from 'http-status-codes';
+import {StatusCodes} from 'http-status-codes';
 import {SCMessage} from '../../things/message';
 import {SCInternalServerErrorResponse} from '../errors/internal-server-error';
 import {SCMethodNotAllowedErrorResponse} from '../errors/method-not-allowed';
@@ -59,7 +59,7 @@ export class SCFeedbackRoute extends SCAbstractRoute {
     this.method = SCRouteHttpVerbs.POST;
     this.requestBodyName = 'SCFeedbackRequest';
     this.responseBodyName = 'SCFeedbackResponse';
-    this.statusCodeSuccess = NO_CONTENT;
+    this.statusCodeSuccess = StatusCodes.OK;
     this.urlFragment = '/feedback';
   }
 }

src/protocol/routes/index.ts

@@ -12,7 +12,7 @@
  * You should have received a copy of the GNU General Public License along with
  * this program. If not, see <https://www.gnu.org/licenses/>.
  */
-import {OK} from 'http-status-codes';
+import {StatusCodes} from 'http-status-codes';
 import {SCAppConfiguration} from '../../config/app';
 import {SCBackendConfiguration} from '../../config/backend';
 import {SCInternalServerErrorResponse} from '../errors/internal-server-error';
@@ -65,7 +65,7 @@ export class SCIndexRoute extends SCAbstractRoute {
     this.method = SCRouteHttpVerbs.POST;
     this.requestBodyName = 'SCIndexRequest';
     this.responseBodyName = 'SCIndexResponse';
-    this.statusCodeSuccess = OK;
+    this.statusCodeSuccess = StatusCodes.OK;
     this.urlFragment = '/';
   }
 }

src/protocol/routes/plugin-register.ts

@@ -12,7 +12,7 @@
  * You should have received a copy of the GNU General Public License along with
  * this program. If not, see <https://www.gnu.org/licenses/>.
  */
-import {OK} from 'http-status-codes';
+import {StatusCodes} from 'http-status-codes';
 import {JSONSchema7} from 'json-schema';
 import {SCInternalServerErrorResponse} from '../errors/internal-server-error';
 import {SCMethodNotAllowedErrorResponse} from '../errors/method-not-allowed';
@@ -122,7 +122,7 @@ export class SCPluginRegisterRoute extends SCAbstractRoute {
     this.method = SCRouteHttpVerbs.POST;
     this.requestBodyName = 'SCPluginRegisterRequest';
     this.responseBodyName = 'SCPluginRegisterResponse';
-    this.statusCodeSuccess = OK;
+    this.statusCodeSuccess = StatusCodes.OK;
     this.urlFragment = '/plugin/register';
   }
 }

src/protocol/routes/search-multi.ts

@@ -12,7 +12,7 @@
  * You should have received a copy of the GNU General Public License along with
  * this program. If not, see <https://www.gnu.org/licenses/>.
  */
-import {OK} from 'http-status-codes';
+import {StatusCodes} from 'http-status-codes';
 import {SCMap} from '../../general/map';
 import {SCInternalServerErrorResponse} from '../errors/internal-server-error';
 import {SCMethodNotAllowedErrorResponse} from '../errors/method-not-allowed';
@@ -63,7 +63,7 @@ export class SCMultiSearchRoute extends SCAbstractRoute {
     this.method = SCRouteHttpVerbs.POST;
     this.requestBodyName = 'SCMultiSearchRequest';
     this.responseBodyName = 'SCMultiSearchResponse';
-    this.statusCodeSuccess = OK;
+    this.statusCodeSuccess = StatusCodes.OK;
     this.urlFragment = '/search/multi';
   }
 }

src/protocol/routes/search.ts

@@ -12,7 +12,7 @@
  * You should have received a copy of the GNU General Public License along with
  * this program. If not, see <https://www.gnu.org/licenses/>.
  */
-import {OK} from 'http-status-codes';
+import {StatusCodes} from 'http-status-codes';
 import {SCInternalServerErrorResponse} from '../errors/internal-server-error';
 import {SCMethodNotAllowedErrorResponse} from '../errors/method-not-allowed';
 import {SCRequestBodyTooLargeErrorResponse} from '../errors/request-body-too-large';
@@ -56,7 +56,7 @@ export class SCSearchRoute extends SCAbstractRoute {
     this.method = SCRouteHttpVerbs.POST;
     this.requestBodyName = 'SCSearchRequest';
     this.responseBodyName = 'SCSearchResponse';
-    this.statusCodeSuccess = OK;
+    this.statusCodeSuccess = StatusCodes.OK;
     this.urlFragment = '/search';
   }
 }

src/protocol/routes/thing-update.ts

@@ -12,7 +12,7 @@
  * You should have received a copy of the GNU General Public License along with
  * this program. If not, see <https://www.gnu.org/licenses/>.
  */
-import {OK} from 'http-status-codes';
+import {StatusCodes} from 'http-status-codes';
 import {SCThings} from '../../meta';
 import {SCInternalServerErrorResponse} from '../errors/internal-server-error';
 import {SCMethodNotAllowedErrorResponse} from '../errors/method-not-allowed';
@@ -60,7 +60,7 @@ export class SCThingUpdateRoute extends SCAbstractRoute {
     };
     this.requestBodyName = 'SCThingUpdateRequest';
     this.responseBodyName = 'SCThingUpdateResponse';
-    this.statusCodeSuccess = OK;
+    this.statusCodeSuccess = StatusCodes.OK;
     this.urlFragment = '/:TYPE/:UID';
   }
 }

src/things/abstract/academic-degree.ts

@@ -22,26 +22,25 @@ export interface SCAcademicDegreeWithoutReferences
   extends SCThingWithoutReferences {
   /**
    * The achievable academic degree
+   *
+   * @filterable
+   * @sortable ducet
    */
-  academicDegree: SCGermanAcademicDegree;
+  academicDegree: string;
 
   /**
    * The achievable academic degree with academic field specification
    * (eg. Master of Science)
    *
-   * @filterable
-   * @keyword
    */
-  academicDegreewithField: string;
+  academicDegreewithField?: string;
 
   /**
    * The achievable academic degree with academic field specification
    * shorted (eg. M.Sc.).
    *
-   * @filterable
-   * @keyword
    */
-  academicDegreewithFieldShort: string;
+  academicDegreewithFieldShort?: string;
 }
 
 /**
@@ -63,9 +62,9 @@ export class SCAcademicDegreeMeta
   fieldTranslations = {
     de: {
       ...SCThingMeta.getInstance<SCThingMeta>().fieldTranslations.de,
-      academicDegree: 'Hochschulgrad',
-      academicDegreewithField: 'Abschlussbezeichnungen',
-      academicDegreewithFieldShort: 'Abschlussbezeichnungen (kurz)',
+      academicDegree: 'Abschlussgrad',
+      academicDegreewithField: 'Abschlussbezeichnung',
+      academicDegreewithFieldShort: 'Abschlussbezeichnung (kurz)',
     },
     en: {
       ...SCThingMeta.getInstance<SCThingMeta>().fieldTranslations.en,
@@ -81,32 +80,9 @@ export class SCAcademicDegreeMeta
   fieldValueTranslations = {
     de: {
       ...SCThingMeta.getInstance<SCThingMeta>().fieldValueTranslations.de,
-      academicDegree: {
-        'bachelor': 'Bachelor',
-        'diploma': 'Diplom',
-        'doctor': 'Doktor',
-        'licentiate': 'Lizenziat',
-        'magister': 'Magister',
-        'master': 'Master',
-        'masterstudent': 'Meisterschüler',
-        'state examination': 'Staatsexamen',
-      },
     },
     en: {
       ...SCThingMeta.getInstance<SCThingMeta>().fieldValueTranslations.en,
     },
   };
 }
-
-/**
- * Types of (german) academic degrees
- */
-export type SCGermanAcademicDegree =
-  'bachelor'
-  | 'diploma'
-  | 'doctor'
-  | 'licentiate'
-  | 'magister'
-  | 'master'
-  | 'master pupil'
-  | 'state examination' ;

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

@@ -107,7 +107,7 @@ export interface SCThingThatCanBeOfferedOffer<T extends SCPriceGroup>
   /**
    * List of prices that are distinct for specific groups
    */
-  prices: T;
+  prices?: T;
 
   /**
    * Provider of an offer

src/things/abstract/thing.ts

@@ -23,6 +23,7 @@ import {SCPersonWithoutReferences} from '../person';
  * Types a thing can be
  */
 export enum SCThingType {
+  Assessment = 'assessment',
   AcademicEvent = 'academic event',
   Article = 'article',
   Book = 'book',
@@ -30,7 +31,7 @@ export enum SCThingType {
   Building = 'building',
   Catalog = 'catalog',
   ContactPoint = 'contact point',
-  CourseOfStudies = 'course of studies',
+  CourseOfStudy = 'course of study',
   DateSeries = 'date series',
   Diff = 'diff',
   Dish = 'dish',

src/things/assessment.ts

@@ -0,0 +1,162 @@
+/*
+ * 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.
+ *
+ * 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 {SCISO8601Date} from '../general/time';
+import {SCThing, SCThingMeta, SCThingType} from './abstract/thing';
+import {SCThingWithCategories, SCThingWithCategoriesSpecificValues, SCThingWithCategoriesTranslatableProperties, SCThingWithCategoriesWithoutReferences, SCThingWithCategoriesWithoutReferencesMeta} from './abstract/thing-with-categories';
+import {SCCourseOfStudyWithoutReferences} from './course-of-study';
+
+
+/**
+ * Categories of assessments
+ */
+ export type SCAssessmentCategories = 'university assessment';
+
+/**
+ * An assessment without references
+ *
+ */
+export interface SCAssessmentWithoutReferences
+  extends SCThingWithCategoriesWithoutReferences<SCAssessmentCategories, SCThingWithCategoriesSpecificValues> {
+    /**
+     * Number of attempts
+     *
+     * @integer
+     */
+    attempt?: number;
+
+    /**
+     * Date assessment was taken or graded
+     */
+    date?: SCISO8601Date;
+
+    /**
+     * ECTS (credit-points)
+     *
+     * @float
+     */
+    ects?: number;
+
+    /**
+     * Grade
+     */
+    grade: string;
+
+    /**
+     * Current status
+     */
+    status?: string;
+
+    /**
+     * Translated fields of an assessment
+     */
+    translations?: SCTranslations<SCAssessmentTranslatableProperties>;
+
+    /**
+     * Type of an assessment
+     */
+    type: SCThingType.Assessment;
+}
+
+/**
+ * An assessment
+ *
+ * @validatable
+ */
+export interface SCAssessment
+  extends SCAssessmentWithoutReferences, SCThing,
+    SCThingWithCategories<SCAssessmentCategories, SCThingWithCategoriesSpecificValues> {
+
+  /**
+   * Course of study the assessment was taken for
+   */
+  courseOfStudy?: SCCourseOfStudyWithoutReferences;
+
+  /**
+   * An array of assessments from the 'level 0' (root) assessment to the direct parent
+   */
+  superAssessments?: SCAssessmentWithoutReferences[];
+
+  /**
+   * Translated fields of an assessment
+   */
+  translations?: SCTranslations<SCAssessmentTranslatableProperties>;
+
+  /**
+   * Type of an assessment
+   */
+  type: SCThingType.Assessment;
+
+}
+
+export interface SCAssessmentTranslatableProperties
+  extends SCThingWithCategoriesTranslatableProperties {
+  /**
+   * @see SCAssessmentWithoutReferences.status
+   */
+   status?: string;
+}
+
+/**
+ * Study module meta data
+ */
+ export class SCAssessmentMeta
+ extends SCThingMeta
+ implements SCMetaTranslations<SCAssessment> {
+  /**
+   * Translations of fields
+   */
+  fieldTranslations = {
+    de: {
+      ...SCThingWithCategoriesWithoutReferencesMeta.getInstance<SCAssessmentCategories,
+         SCThingWithCategoriesSpecificValues>().fieldTranslations.de,
+      attempt: 'Versuch',
+      courseOfStudy: 'Studiengang',
+      date: 'Datum',
+      ects: 'ECTS-Punkte',
+      grade: 'Note',
+      status: 'Status',
+      superAssessments: 'übergeordnete Prüfungen',
+    },
+    en: {
+     ...SCThingWithCategoriesWithoutReferencesMeta.getInstance<SCAssessmentCategories,
+        SCThingWithCategoriesSpecificValues>().fieldTranslations.en,
+      attempt: 'attempt',
+      courseOfStudy: 'course of study',
+      date: 'date',
+      ects: 'ECTS points',
+      grade: 'grade',
+      status: 'status',
+      superAssessments: 'parent assessments',
+    },
+  };
+
+  /**
+   * Translations of values of fields
+   */
+  fieldValueTranslations = {
+    de: {
+      ...SCThingWithCategoriesWithoutReferencesMeta.getInstance<SCAssessmentCategories,
+      SCThingWithCategoriesSpecificValues>().fieldValueTranslations.de,
+      type: 'Prüfung',
+    },
+    en: {
+      ...SCThingWithCategoriesWithoutReferencesMeta.getInstance<SCAssessmentCategories,
+      SCThingWithCategoriesSpecificValues>().fieldValueTranslations.en,
+      type: SCThingType.Assessment,
+    },
+  };
+}

src/things/book.ts

@@ -43,6 +43,7 @@ export type SCBookCategories = 'audio'
   | 'microfilm'
   | 'musicalscore'
   | 'photo'
+  | 'physicalobject'
   | 'retro'
   | 'sensorimage'
   | 'unknown'

src/things/course-of-study.ts

@@ -26,94 +26,90 @@ import {SCDateSeriesWithoutReferences} from './date-series';
 import {SCOrganizationWithoutReferences} from './organization';
 
 /**
- * A course of studies without references
+ * A course of study without references
  */
-export interface SCCourseOfStudiesWithoutReferences
+export interface SCCourseOfStudyWithoutReferences
   extends SCAcademicDegreeWithoutReferences, SCThingThatCanBeOfferedWithoutReferences {
   /**
-   * The main language in which the course of studies
+   * The main language in which the course of study
    * is beeing offered
    */
-  mainLanguage: SCLanguage;
+  mainLanguage?: SCLanguage;
 
   /**
-   * Actual major of the course of studies (eg. physics)
+   * The modes the course of study is offered in
    *
    * @filterable
-   * @keyword
    */
-  major: string;
+  mode?: SCCourseOfStudyMode;
 
   /**
-   * The modes the course of studies is offered in
+   * The time modes the course of study is offered in
+   *
+   * @filterable
    */
-  mode: SCCourseOfStudiesMode;
-
-  /**
-   * The time modes the course of studies is offered in
-   */
-  timeMode: SCCourseOfStudiesTimeMode;
+  timeMode?: SCCourseOfStudyTimeMode;
 
   /**
    * Translated fields of a dish
    */
-  translations?: SCTranslations<SCCourseOfStudiesTranslatableProperties>;
+  translations?: SCTranslations<SCCourseOfStudyTranslatableProperties>;
 
   /**
-   * Type of the course of studies
+   * Type of the course of study
    */
-  type: SCThingType.CourseOfStudies;
+  type: SCThingType.CourseOfStudy;
 }
 
 /**
- * A course of studies
+ * A course of study
  *
  * @validatable
  * @indexable
  */
-export interface SCCourseOfStudies
-  extends SCCourseOfStudiesWithoutReferences, SCThingThatCanBeOffered<SCAcademicPriceGroup>, SCAcademicDegree {
+export interface SCCourseOfStudy
+  extends SCCourseOfStudyWithoutReferences, SCThingThatCanBeOffered<SCAcademicPriceGroup>, SCAcademicDegree {
   /**
-   * The department that manages the course of studies
+   * The department that manages the course of study
    */
-  department: SCOrganizationWithoutReferences;
+  department?: SCOrganizationWithoutReferences;
 
   /**
    * The secretary that administers requests and
-   * questions concerning the course of studies
+   * questions concerning the course of study
    */
-  secretary: SCOrganizationWithoutReferences;
+  secretary?: SCOrganizationWithoutReferences;
 
   /**
-   * Dates at which the course of studies is planned to start
+   * Dates at which the course of study is planned to start
    */
   startDates?: SCDateSeriesWithoutReferences[];
 
   /**
-   * Translated fields of a course of studies
+   * Translated fields of a course of study
    */
-  translations?: SCTranslations<SCCourseOfStudiesTranslatableProperties>;
+  translations?: SCTranslations<SCCourseOfStudyTranslatableProperties>;
 
   /**
-   * Type of the course of studies
+   * Type of the course of study
    */
-  type: SCThingType.CourseOfStudies;
+  type: SCThingType.CourseOfStudy;
 }
 
 /**
- * Translatable properties of a course of studies
+ * Translatable properties of a course of study
  */
-export interface SCCourseOfStudiesTranslatableProperties
+export interface SCCourseOfStudyTranslatableProperties
   extends SCThingThatCanBeOfferedTranslatableProperties {
-  // noop
+    // noop
 }
 
 /**
- * Meta information about a course of studies
+ * Meta information about a course of study
  */
-export class SCCourseOfStudiesMeta
+export class SCCourseOfStudyMeta
   extends SCThingMeta
-  implements SCMetaTranslations<SCCourseOfStudies> {
+  implements SCMetaTranslations<SCCourseOfStudy> {
   /**
    * Translations of fields
    */
@@ -125,7 +121,6 @@ export class SCCourseOfStudiesMeta
         .fieldTranslations.de,
       department: 'Fachbereich',
       mainLanguage: 'Unterrichtssprache',
-      major: 'Studienfach',
       mode: 'Studiengangsart',
       secretary: 'Sekretariat',
       startDates: 'Startdatum',
@@ -138,7 +133,6 @@ export class SCCourseOfStudiesMeta
         .fieldTranslations.de,
       department: 'department',
       mainLanguage: 'main language',
-      major: 'major',
       mode: 'mode',
       secretary: 'secretary',
       startDates: 'start dates',
@@ -167,30 +161,30 @@ export class SCCourseOfStudiesMeta
     en: {
       ...SCAcademicDegreeMeta.getInstance().fieldValueTranslations.en,
       modes: {
-        combination: 'combination course of studies',
-        'double-degree': 'double degree course of studies',
-        dual: 'dual course of studies',
-        standard: 'course of studies',
+        combination: 'combination course of study',
+        'double-degree': 'double degree course of study',
+        dual: 'dual course of study',
+        standard: 'course of study',
       },
       timeMode: {
         fulltime: 'full-time',
         parttime: 'part-time',
       },
-      type: SCThingType.CourseOfStudies,
+      type: SCThingType.CourseOfStudy,
     },
   };
 }
 
 /**
- * Types of (german) course of studies modes
+ * Types of (german) course of study modes
  */
-export type SCCourseOfStudiesMode = 'combination'
+export type SCCourseOfStudyMode = 'combination'
   | 'dual'
   | 'double-degree'
   | 'standard' ;
 
 /**
- * Types of (german) course of studies time modes
+ * Types of (german) course of study time modes
  */
-export type SCCourseOfStudiesTimeMode = 'fulltime'
+export type SCCourseOfStudyTimeMode = 'fulltime'
   | 'parttime' ;

src/translator.ts

@@ -281,7 +281,7 @@ export class SCThingTranslator {
    * Given a SCThingType this function returns an object with the same basic structure as the corresponding SCThing
    * All the values will be set to the known translations of the property/key name
    * @example
-   * const translatedMetaDish = translator.translatedPropertyNames<SCCourseOfStudies>(SCThingType.CourseOfStudies);
+   * const translatedMetaDish = translator.translatedPropertyNames<SCCourseOfStudy>(SCThingType.CourseOfStudy);
    * @param type The type whose property names will be translated
    * @returns An object with the properties of the SCThingType where the values are the known property tranlations
    */

test/compat.spec.ts

@@ -0,0 +1,44 @@
+/*
+ * 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 {lightweightProjectFromPath} from '@openstapps/core-tools/lib/easy-ast/easy-ast';
+import {LightweightProject} from '@openstapps/core-tools/lib/easy-ast/types/lightweight-project';
+import {expect} from 'chai';
+import {reduce} from 'lodash';
+
+process.on('unhandledRejection', (err) => {
+  throw err;
+});
+
+describe('Mapping Compatibility', () => {
+  let project: LightweightProject;
+
+  before(function () {
+    this.timeout(15000);
+    this.slow(10000);
+
+    project = lightweightProjectFromPath('src');
+  });
+
+  it('non-exported definitions should not have duplicate names across files', () => {
+    reduce(project, (result, file) => reduce(file, (result2, _, key) => {
+      expect(result2[key]).to.be.undefined;
+      return {
+        [key]: true,
+        ...result2,
+      };
+    }, result), {} as Record<string, boolean>);
+  });
+});

test/features.spec.ts

@@ -0,0 +1,140 @@
+/*
+ * Copyright (C) 2018 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 {isLightweightClass, isLightweightEnum, isUnionType} from '@openstapps/core-tools/lib/easy-ast/ast-util';
+import {LightweightAliasDefinition} from '@openstapps/core-tools/lib/easy-ast/types/lightweight-alias-definition';
+import {LightweightProjectWithIndex} from '@openstapps/core-tools/lib/easy-ast/types/lightweight-project';
+import {LightweightType} from '@openstapps/core-tools/lib/easy-ast/types/lightweight-type';
+import {LightweightClassDefinition} from '@openstapps/core-tools/src/easy-ast/types/lightweight-class-definition';
+import {LightweightDefinition} from '@openstapps/core-tools/src/easy-ast/types/lightweight-definition';
+import {LightweightProperty} from '@openstapps/core-tools/src/easy-ast/types/lightweight-property';
+import {expect} from 'chai';
+import {assign, chain, clone, flatMap, isNil, reduce, reject, some} from 'lodash';
+
+process.on('unhandledRejection', (err) => {
+  throw err;
+});
+
+describe('Features', () => {
+  let project: LightweightProjectWithIndex;
+  let thingNames: string[];
+  let things: LightweightClassDefinition[];
+  let thingsWithoutReferences: LightweightClassDefinition[];
+
+  before(function () {
+    this.timeout(15000);
+    this.slow(10000);
+
+    project = new LightweightProjectWithIndex('src');
+
+    const thingsReflection = project.definitions['SCIndexableThings'] as LightweightAliasDefinition;
+    expect(isLightweightEnum(thingsReflection)).to.be.true;
+    expect(isUnionType(thingsReflection.type!)).to.be.true;
+
+    thingsReflection.type!.specificationTypes!.push({
+      flags: 524_288,
+      referenceName: 'SCDiff',
+    });
+
+    // tslint:disable-next-line:no-unused-expression
+    expect(thingsReflection.type?.specificationTypes?.every(it => typeof it.referenceName !== 'undefined')).to.be.true;
+    thingNames = thingsReflection.type?.specificationTypes?.map(type => type.referenceName!) ?? [];
+    things = thingNames
+      .map(it => project.definitions[it])
+      .filter(isLightweightClass);
+    thingsWithoutReferences = thingNames
+      .map(it => project.definitions[`${it}WithoutReferences`])
+      .filter(isLightweightClass);
+  });
+
+  const inheritedProperties = function (classLike: LightweightClassDefinition):
+    Record<string, LightweightProperty> | undefined {
+    return reduce(
+      [...(classLike.implementedDefinitions ?? []), ...(classLike.extendedDefinitions ?? [])],
+      (obj, extension) => {
+        const object = project.definitions[extension.referenceName ?? ''];
+
+        return assign(obj, isLightweightClass(object)
+          ? inheritedProperties(object)
+          : obj);
+      },
+      clone(classLike.properties)
+    );
+  };
+
+  it('should have an origin', () => {
+    for (const thing of things) {
+      expect(inheritedProperties(thing)?.['origin']).not.to.be.undefined;
+    }
+  });
+
+  it('should not have duplicate names', () => {
+    reduce(project.files, (fileResult, file) =>
+      reduce(file, (definitionResult, definition: LightweightDefinition) => {
+        expect(definitionResult[definition.name]).to.be.undefined;
+        definitionResult[definition.name] = true; // something that's not undefined
+
+        return definitionResult;
+      }, fileResult), {} as Record<string, true>);
+  });
+
+  it('should not have properties referencing SCThing', () => {
+    const allPropertyReferenceNames: (property: LightweightProperty) => string[] = property => reject([
+      property.type.referenceName!,
+      ...flatMap(property.properties, allPropertyReferenceNames),
+    ], isNil);
+
+    const typeHasSCThingReferences: (type?: LightweightType) => boolean = type => type?.referenceName
+      ? hasSCThingReferences(project.definitions[type.referenceName])
+      : some(type?.specificationTypes, typeHasSCThingReferences);
+
+    const hasSCThingReferences: (definition?: LightweightDefinition) => boolean = definition =>
+      isLightweightClass(definition)
+        ? chain(inheritedProperties(definition))
+          .flatMap(it => flatMap(it.properties, allPropertyReferenceNames))
+          .map(it => project.definitions[it] as LightweightDefinition)
+          .some(it => it.name === 'SCThing' || hasSCThingReferences(it))
+          .value()
+        : definition ? typeHasSCThingReferences(definition.type) : false;
+
+    for (const thing of things) {
+      expect(hasSCThingReferences(thing)).to.be.false;
+    }
+  });
+
+  function extendsSCThing(definition?: LightweightDefinition): boolean {
+    return isLightweightClass(definition)
+      ? chain([
+        ...(definition as LightweightClassDefinition).extendedDefinitions ?? [],
+        ...(definition as LightweightClassDefinition).implementedDefinitions ?? [],
+      ])
+        .map(it => it.referenceName)
+        .reject(isNil)
+        .some(it => it === 'SCThing' || extendsSCThing(project.definitions[it!]))
+        .value()
+      : false;
+  }
+
+  it('should extend SCThing if it is an SCThing', () => {
+    for (const thing of things) {
+      expect(extendsSCThing(thing)).to.be.true;
+    }
+  });
+
+  it('should not extend SCThing if it is an SCThingWithoutReferences', () => {
+    for (const thingWithoutReferences of thingsWithoutReferences) {
+      expect(extendsSCThing(thingWithoutReferences)).to.be.false;
+    }
+  });
+});

test/resources/indexable/Article.3.json

@@ -22,7 +22,7 @@
       "name": "HeBIS HDS",
       "originalId": "HEB198305427",
       "type": "remote",
-      "url": "https://hds2test.hebis.de/ubffm/"
+      "url": "https://hds2.hebis.de/ubffm/"
     },
     "isPartOf": {
       "uid": "bc5e5399-a24c-5c01-9c1b-0c8b83272087",

test/resources/indexable/Article.4.json

@@ -22,7 +22,7 @@
       "name": "HeBIS HDS",
       "originalId": "HEB107025590",
       "type": "remote",
-      "url": "https://hds2test.hebis.de/ubffm/"
+      "url": "https://hds2.hebis.de/ubffm/"
     },
     "isPartOf": {
       "uid": "f84c1851-042e-542f-ba7a-158b32dfb82f",

test/resources/indexable/Assessment.1.json

@@ -0,0 +1,36 @@
+{
+  "errorNames": [],
+  "instance": {
+    "attempt": 1,
+    "date": "2020-04-01",
+    "ects": 20,
+    "grade": "N/A",
+    "status": "ongoing",
+    "uid": "681a59a1-23c2-5d78-861a-8c86a3abf404",
+    "name": "Introductory courses extreme math",
+    "categories": [
+      "university assessment"
+    ],
+    "courseOfStudy": {
+      "academicDegree": "bachelor",
+      "academicDegreewithField": "Bachelor of Arts",
+      "academicDegreewithFieldShort": "B.A.",
+      "mainLanguage": {
+        "code": "de",
+        "name": "german"
+      },
+      "mode": "dual",
+      "name": "Astroturfing",
+      "timeMode": "parttime",
+      "type": "course of study",
+      "uid": "4c6f0a18-343d-5175-9fb1-62d28545c2aa"
+    },
+    "origin": {
+      "indexed": "2020-04-11T12:30:00Z",
+      "name": "Dummy",
+      "type": "remote"
+    },
+    "type": "assessment"
+  },
+  "schema": "SCAssessment"
+}

test/resources/indexable/Assessment.2.json

@@ -0,0 +1,51 @@
+{
+  "errorNames": [],
+  "instance": {
+    "attempt": 1,
+    "date": "2020-04-01",
+    "ects": 6,
+    "grade": "very much 1.0",
+    "status": "passed",
+    "uid": "681a59a1-23c2-5d78-861a-8c86a3abf303",
+    "name": "Mathe 9001",
+    "categories": [
+      "university assessment"
+    ],
+    "superAssessments": [
+      {
+        "attempt": 1,
+        "date": "2020-04-01",
+        "ects": 20,
+        "grade": "N/A",
+        "status": "ongoing",
+        "uid": "681a59a1-23c2-5d78-861a-8c86a3abf404",
+        "name": "Introductory courses extreme math",
+        "categories": [
+          "university assessment"
+        ],
+        "type": "assessment"
+      }
+    ],
+    "courseOfStudy": {
+      "academicDegree": "bachelor",
+      "academicDegreewithField": "Bachelor of Arts",
+      "academicDegreewithFieldShort": "B.A.",
+      "mainLanguage": {
+        "code": "de",
+        "name": "german"
+      },
+      "mode": "dual",
+      "name": "Astroturfing",
+      "timeMode": "parttime",
+      "type": "course of study",
+      "uid": "4c6f0a18-343d-5175-9fb1-62d28545c2aa"
+    },
+    "origin": {
+      "indexed": "2020-04-11T12:30:00Z",
+      "name": "Dummy",
+      "type": "remote"
+    },
+    "type": "assessment"
+  },
+  "schema": "SCAssessment"
+}

test/resources/indexable/Book.3.json

@@ -33,7 +33,7 @@
       "name": "HeBIS HDS",
       "originalId": "HEB022992618",
       "type": "remote",
-      "url": "https://hds2test.hebis.de/ubffm/"
+      "url": "https://hds2.hebis.de/ubffm/"
     }
   },
   "schema": "SCBook"

test/resources/indexable/Book.4.json

@@ -18,7 +18,7 @@
     "firstPublished": "2001",
     "publications": [
       {
-        "uid": "603a6574-8910-588a-9e83-cd26e6988c74",
+        "uid": "6333427c-0725-5398-9a04-11604680dae3",
         "type": "publication event",
         "locations": [
           "Paris"
@@ -36,7 +36,7 @@
       "name": "HeBIS HDS",
       "originalId": "HEB102248788",
       "type": "remote",
-      "url": "https://hds2test.hebis.de/ubffm/"
+      "url": "https://hds2.hebis.de/ubffm/"
     }
   },
   "schema": "SCBook"

test/resources/indexable/CourseOfStudy.1.json

@@ -13,9 +13,8 @@
       "code": "de",
       "name": "german"
     },
-    "major": "Astroturfing",
     "mode": "dual",
-    "name": "Astroturfing Bachelor",
+    "name": "Astroturfing",
     "origin": {
       "indexed": "2018-09-11T12:30:00Z",
       "name": "Dummy",
@@ -27,8 +26,8 @@
       "uid": "b0f878fd-8fda-53b8-b065-a8d854c3d0d2"
     },
     "timeMode": "parttime",
-    "type": "course of studies",
+    "type": "course of study",
     "uid": "4c6f0a18-343d-5175-9fb1-62d28545c2aa"
   },
-  "schema": "SCCourseOfStudies"
+  "schema": "SCCourseOfStudy"
 }

test/resources/indexable/Message.2.json

@@ -1,6 +1,6 @@
 {
   "errorNames": [
-    "enum"
+    "const"
   ],
   "instance": {
     "type": "invalid-value-in-schema",

test/resources/indexable/Message.3.json

@@ -12,6 +12,9 @@
     "audiences": [
       "students"
     ],
+    "categories": [
+      "news"
+    ],
     "audienceOrganizations": [{
       "name": "TU Berlin",
       "type": "organization",

test/resources/indexable/Message.4.json

@@ -0,0 +1,28 @@
+{
+  "errorNames": [
+    "required"
+  ],
+  "instance": {
+    "type": "message",
+    "invalid-non-existing-key-in-schema": 1,
+    "uid": "4706ef24-b631-5c20-91d1-3c627decca5a",
+    "image": "https://backend/res/img/message_small.png",
+    "name": "Lösung für das Problem des Zurücksetzens der StApps-App gefunden",
+    "messageBody": "Wie bereits berichtet, klagten User über das Löschen ihres Stundenplans beim Update von Version 0.8.0 auf 0.8.1. Wir haben eine Lösung für das Problem gefunden und testen diese ausführlich bis zum Ende dieser Woche. Wenn alles glatt verläuft, dann kommt am Wochenende die fehlerbereinige Version 0.8.2 heraus.\n\n*(25.Okt 2016)*",
+    "audiences": [
+      "students"
+    ],
+    "audienceOrganizations": [{
+      "name": "TU Berlin",
+      "type": "organization",
+      "uid": "4806ef14-b631-5c20-91d1-3c627decca5a"
+    }],
+    "sequenceIndex": 1005,
+    "origin": {
+      "indexed": "2018-09-11T12:30:00Z",
+      "name": "Dummy",
+      "type": "remote"
+    }
+  },
+  "schema": "SCMessage"
+}

test/resources/indexable/Periodical.1.json

@@ -28,7 +28,7 @@
       "name": "HeBIS HDS",
       "originalId": "HEB046847146",
       "type": "remote",
-      "url": "https://hds2test.hebis.de/ubffm/"
+      "url": "https://hds2.hebis.de/ubffm/"
     }
   },
   "schema": "SCPeriodical"

test/resources/indexable/Periodical.2.json

@@ -25,7 +25,7 @@
       "name": "HeBIS HDS",
       "originalId": "HEB048624853",
       "type": "remote",
-      "url": "https://hds2test.hebis.de/ubffm/"
+      "url": "https://hds2.hebis.de/ubffm/"
     }
   },
   "schema": "SCPeriodical"

test/schema.spec.ts

@@ -1,321 +1,11 @@
-/*
- * Copyright (C) 2018 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 {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, PathLike} from 'fs';
 import {slow, suite, test, timeout} from '@testdeck/mocha';
+import {expect} from 'chai';
+import {mkdirSync} from 'fs';
 import {join, resolve} from 'path';
-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
- *
- * @param type Type to check
- */
-function isUnionType(type: Type): type is UnionType {
-  return type.type === 'union';
-}
-
-/**
- * Check if a type is reference type
- *
- * @param type Type to check
- */
-function isReferenceType(type: Type): type is ReferenceType {
-  return type.type === 'reference';
-}
-
-/**
- * Check if a type is an array type
- *
- * @param type Type to check
- */
-function isArrayType(type: Type): type is ArrayType {
-  return type.type === 'array';
-}
-
-/**
- * Check if a type is an intrinsic type
- *
- * @param type Type to check
- */
-function isIntrinsicType(type: Type): type is IntrinsicType {
-  return type.type === 'intrinsic';
-}
-
-/**
- * Check if a type is a string literal type
- *
- * @param type Type to check
- */
-function isLiteralType(type: Type): type is LiteralType {
-  return type.type === 'literal';
-}
-
-/**
- * Get extended types of a declaration reflection
- * @param thingReflection Reflection of the thing
- * @param objects Map of reflections by name
- */
-function getExtendedTypes(thingReflection: DeclarationReflection,
-                          objects: { [name: string]: DeclarationReflection }): string[] {
-  const extendedTypes: string[] = [];
-
-  if (Array.isArray(thingReflection.extendedTypes)) {
-    const typesToCheck = thingReflection.extendedTypes.slice();
-
-    while (typesToCheck.length > 0) {
-      const extendedType = typesToCheck.splice(0, 1)[0];
-
-      extendedTypes.push((extendedType as unknown as ReferenceType).name);
-
-      const extendedObject = objects[(extendedType as unknown as ReferenceType).name];
-
-      if (typeof extendedObject !== 'undefined') {
-        if (Array.isArray(extendedObject.extendedTypes)) {
-          typesToCheck.push.apply(typesToCheck, extendedObject.extendedTypes);
-        }
-      }
-    }
-  }
-
-  return extendedTypes;
-}
 
 @suite(timeout(15000), slow(10000))
 export class SchemaSpec {
-  static objects: { [name: string]: DeclarationReflection } = {};
-  static reflection: ProjectReflection;
-  static thingNames: string[];
-
-  static before() {
-    SchemaSpec.reflection = getProjectReflection(resolve(__dirname, '..', 'src'));
-
-    if (Array.isArray(SchemaSpec.reflection.children)) {
-      for (const module of SchemaSpec.reflection.children) {
-        if (Array.isArray(module.children)) {
-          for (const object of module.children) {
-            SchemaSpec.objects[object.name] = object;
-          }
-        }
-      }
-    }
-
-    const thingsReflection = SchemaSpec.objects.SCIndexableThings;
-
-    // tslint:disable-next-line:no-unused-expression
-    expect(thingsReflection).not.to.be.undefined;
-
-    // tslint:disable-next-line:no-unused-expression
-    expect(isUnionType(thingsReflection.type!)).to.be.true;
-
-    (thingsReflection.type! as UnionType).types.push({
-      'id': 0,
-      'name': 'SCDiff',
-      'type': 'reference',
-    } as unknown as ReferenceType);
-
-    // tslint:disable-next-line:no-unused-expression
-    expect((thingsReflection.type! as UnionType).types.every(isReferenceType)).to.be.true;
-
-    SchemaSpec.thingNames = (thingsReflection.type! as UnionType).types.map((type) => {
-      return (type as ReferenceType).name;
-    });
-  }
-
-  @test
-  'all things have an origin'() {
-    for (const thingName of SchemaSpec.thingNames) {
-      const thingReflection = SchemaSpec.objects[`${thingName}`];
-
-      let originFound = false;
-
-      if (Array.isArray(thingReflection.children)) {
-        for (const property of thingReflection.children) {
-          if (property.name === 'origin') {
-            originFound = true;
-            break;
-          }
-        }
-      }
-
-      // tslint:disable-next-line:no-unused-expression
-      expect(originFound).to.be.equal(true, `'${thingName}' must have property 'origin'.`);
-    }
-  }
-
-  @test
-  'does not have duplicate names'() {
-    const names: string[] = [];
-
-    if (Array.isArray(SchemaSpec.reflection.children)) {
-      for (const module of SchemaSpec.reflection.children) {
-        if (Array.isArray(module.children)) {
-          for (const object of module.children) {
-            expect(names).not.to.contain(object.name);
-            names.push(object.name);
-          }
-        }
-      }
-    }
-  }
-
-  @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}`];
-
-      if (Array.isArray(thingReflection.children)) {
-        for (const property of thingReflection.children) {
-          if (typeof property.type === 'undefined') {
-            Logger.error(thingName, property.name);
-            continue;
-          }
-
-          let type = property.type!;
-
-          if (isIntrinsicType(type)) {
-            continue;
-          } else if (isArrayType(type)) {
-            const elementType = type.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,
-                `Array property '${property.name}' on type '${thingName}' has element type '${elementType.name}'.`,
-              );
-            } else {
-              // tslint:disable-next-line:max-line-length
-              fail(`'${thingName}'#'${property.name}' element type '${elementType.type}' is not handled by this test!`);
-            }
-          } else if (isReferenceType(type)) {
-            do {
-              expect(SchemaSpec.thingNames).not.to.contain(
-                type.name,
-                `Property '${property.name}' on type '${thingName}' has element type '${type.name}'.`,
-              );
-
-              const referencedObject = SchemaSpec.objects[type.name];
-              if (typeof referencedObject !== 'undefined') {
-                const referencedType = referencedObject.type;
-                if (typeof referencedType !== 'undefined') {
-                  type = referencedType;
-                } else {
-                  break;
-                }
-              } else {
-                break;
-              }
-            } while (isReferenceType(type));
-          } else if (isUnionType(type)) {
-            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
-  'things extend SCThing'() {
-    for (const thingName of SchemaSpec.thingNames) {
-      const thingReflection = SchemaSpec.objects[`${thingName}`];
-
-      expect(getExtendedTypes(thingReflection, SchemaSpec.objects)).to.contain(
-        'SCThing',
-        `'${thingName}' neither extends 'SCThing' transitively nor directly.`,
-      );
-    }
-  }
-
-  @test
-  'things without references do not extend SCThing'() {
-    for (const thingName of SchemaSpec.thingNames) {
-      const thingWithoutReferencesReflection = SchemaSpec.objects[`${thingName}WithoutReferences`];
-
-      expect(getExtendedTypes(thingWithoutReferencesReflection, SchemaSpec.objects)).not.to.contain(
-        'SCThing',
-        `'${thingName}WithoutReferences' extends 'SCThing' either transitively or directly.`,
-      );
-    }
-  }
-
   @test
   async 'validate against test files'() {
     const errorsPerFile = {

test/type.spec.ts

@@ -16,11 +16,12 @@ import {assert, Has, IsAny, IsNever, NotHas} from 'conditional-type-checks';
 import {SCThing, SCThingWithoutReferences} from '../src/things/abstract/thing';
 import {SCAcademicEvent, SCAcademicEventWithoutReferences} from '../src/things/academic-event';
 import {SCArticle, SCArticleWithoutReferences} from '../src/things/article';
+import {SCAssessment, SCAssessmentWithoutReferences} from '../src/things/assessment';
 import {SCBook, SCBookWithoutReferences} from '../src/things/book';
 import {SCBuilding, SCBuildingWithoutReferences} from '../src/things/building';
 import {SCCatalog, SCCatalogWithoutReferences} from '../src/things/catalog';
 import {SCContactPoint, SCContactPointWithoutReferences} from '../src/things/contact-point';
-import {SCCourseOfStudies, SCCourseOfStudiesWithoutReferences} from '../src/things/course-of-studies';
+import {SCCourseOfStudy, SCCourseOfStudyWithoutReferences} from '../src/things/course-of-study';
 import {SCDateSeries, SCDateSeriesWithoutReferences} from '../src/things/date-series';
 import {SCDiff, SCDiffWithoutReferences} from '../src/things/diff';
 import {SCDish, SCDishWithoutReferences} from '../src/things/dish';
@@ -107,6 +108,17 @@ assert<Has<SCArticlePropertyTypes, SCThing>>(false);
 assert<Extends<SCArticleWithoutReferences, SCThing>>(false);
 assert<Extends<SCArticle, SCThing>>(true);
 
+/**
+ * Types of properties of SCAssessment
+ */
+ type SCAssessmentPropertyTypes = PropertyTypesNested<SCAssessment>;
+ assert<NotHas<SCAssessmentPropertyTypes, SCThingWithoutReferences>>(false);
+ assert<Has<SCAssessmentPropertyTypes, SCThingWithoutReferences>>(true);
+ assert<NotHas<SCAssessmentPropertyTypes, SCThing>>(true);
+ assert<Has<SCAssessmentPropertyTypes, SCThing>>(false);
+ assert<Extends<SCAssessmentWithoutReferences, SCThing>>(false);
+ assert<Extends<SCAssessment, SCThing>>(true);
+
 /**
  * Types of properties of SCBook
  */
@@ -152,15 +164,15 @@ assert<Extends<SCCatalogWithoutReferences, SCThing>>(false);
 assert<Extends<SCCatalog, SCThing>>(true);
 
 /**
- * Types of properties of SCCourseOfStudies
+ * Types of properties of SCCourseOfStudy
  */
-type SCCourseOfStudiesPropertyTypes = PropertyTypesNested<SCCourseOfStudies>;
-assert<NotHas<SCCourseOfStudiesPropertyTypes, SCThingWithoutReferences>>(false);
-assert<Has<SCCourseOfStudiesPropertyTypes, SCThingWithoutReferences>>(true);
-assert<NotHas<SCCourseOfStudiesPropertyTypes, SCThing>>(true);
-assert<Has<SCCourseOfStudiesPropertyTypes, SCThing>>(false);
-assert<Extends<SCCourseOfStudiesWithoutReferences, SCThing>>(false);
-assert<Extends<SCCourseOfStudies, SCThing>>(true);
+type SCCourseOfStudyPropertyTypes = PropertyTypesNested<SCCourseOfStudy>;
+assert<NotHas<SCCourseOfStudyPropertyTypes, SCThingWithoutReferences>>(false);
+assert<Has<SCCourseOfStudyPropertyTypes, SCThingWithoutReferences>>(true);
+assert<NotHas<SCCourseOfStudyPropertyTypes, SCThing>>(true);
+assert<Has<SCCourseOfStudyPropertyTypes, SCThing>>(false);
+assert<Extends<SCCourseOfStudyWithoutReferences, SCThing>>(false);
+assert<Extends<SCCourseOfStudy, SCThing>>(true);
 
 /**
  * Types of properties of SCDateSeries

tslint.json

@@ -1,6 +1,7 @@
 {
   "extends": "./node_modules/@openstapps/configuration/tslint.json",
   "rules": {
-    "no-empty-interface": false
+    "no-empty-interface": false,
+    "no-redundant-jsdoc": false
   }
 }