0.33.0

Refactor SCPerson and SCOrganization

.gitlab-ci.yml

@@ -11,6 +11,7 @@ before_script:
 stages:
   - build
   - test
+  - audit
   - deploy
   - publish
 
@@ -26,7 +27,7 @@ build:
     expire_in: 1 week
 
 audit:
-  stage: test
+  stage: audit
   script:
     - npm audit
   allow_failure: true
@@ -34,7 +35,7 @@ audit:
     - schedules
 
 scheduled-audit:
-  stage: test
+  stage: audit
   script:
     - npm audit
   only:

CHANGELOG.md

@@ -1,3 +1,73 @@
+# [0.32.0](https://gitlab.com/openstapps/core/compare/v0.31.0...v0.32.0) (2020-02-04)
+
+
+### Features
+
+* make SCContactPoint extend SCThing ([0d89b14](https://gitlab.com/openstapps/core/commit/0d89b14))
+
+
+
+# [0.31.0](https://gitlab.com/openstapps/core/compare/v0.30.0...v0.31.0) (2019-11-14)
+
+
+### Bug Fixes
+
+* remove categories from custom translations ([9658f05](https://gitlab.com/openstapps/core/commit/9658f05))
+* translator can now handle enum translations ([abda5cf](https://gitlab.com/openstapps/core/commit/abda5cf))
+
+
+
+# [0.30.0](https://gitlab.com/openstapps/core/compare/v0.29.0...v0.30.0) (2019-11-08)
+
+
+### Features
+
+* add aggregatable tag for type field ([443cb74](https://gitlab.com/openstapps/core/commit/443cb74))
+* add new field sequenceIndex to message ([01f92ba](https://gitlab.com/openstapps/core/commit/01f92ba))
+
+
+
+# [0.29.0](https://gitlab.com/openstapps/core/compare/v0.28.0...v0.29.0) (2019-09-17)
+
+
+### Features
+
+* add mappingIgnoredTags property to SCBackend ([149f3ff](https://gitlab.com/openstapps/core/commit/149f3ff))
+
+
+
+# [0.28.0](https://gitlab.com/openstapps/core/compare/v0.27.0...v0.28.0) (2019-09-10)
+
+
+### Features
+
+* add onlyOnType field for SCFacet ([fba63db](https://gitlab.com/openstapps/core/commit/fba63db))
+
+
+
+# [0.27.0](https://gitlab.com/openstapps/core/compare/v0.26.0...v0.27.0) (2019-09-03)
+
+
+### Features
+
+* add [@filterable](https://gitlab.com/filterable) tags ([fec3371](https://gitlab.com/openstapps/core/commit/fec3371))
+
+
+
+# [0.26.0](https://gitlab.com/openstapps/core/compare/v0.25.0...v0.26.0) (2019-08-19)
+
+
+### Bug Fixes
+
+* complete german translations ([bad15dc](https://gitlab.com/openstapps/core/commit/bad15dc))
+
+
+### Features
+
+* add pluginRequestTimeout field to backend config ([88f579e](https://gitlab.com/openstapps/core/commit/88f579e))
+
+
+
 # [0.25.0](https://gitlab.com/openstapps/core/compare/v0.24.0...v0.25.0) (2019-07-25)
 
 

CONTRIBUTING.md

@@ -28,6 +28,33 @@ The [core tools](https://openstapps.gitlab.io/core-tools) are more or less not d
 
 App and connectors should be updated regularly to new releases of the core but not as important like API and backend. Since the app is just a view for the data stored in the backend it is not necessary to be up to date with the newest core immediately and the connectors are developed independently by every school and up to their responsibility.
 
+## Adding new Types
+
+Adding new types requires changes at multiple locations for it to work correctly
+
+### Required changes
+* Add your SCThing and SCThingWithoutReferences to `src/things/your-thing-name.ts` and make them extend `SCThingWithoutReferences` and `SCThing` respectively
+* Add your SCThingMeta to `src/things/your-thing-name.ts` and make it extend `SCThingMeta`
+* Add your SCThingMeta to `SCClasses` in `src/meta.ts`
+* Add your SCThing to `SCThingsWithoutDiff` in `src/meta.ts`
+* Add your SCThingWithoutReferences to `SCAssociatedThingWithoutReferences` in `src/meta.ts`
+* Add your SCThing to `SCAssociatedThing` in `src/meta.ts`
+* Add your SCThing to the `SCThingType` enum in `src/things/abstract/thing.ts`
+* Add an example file for your SCThing in `test/resources/YourThingName.json`
+* Add the following lines for your SCThing in `test/type.spec.ts`: 
+```typescript
+/**
+ * Types of properties of SCYourThingName
+ */
+type SCYourThingNamePropertyTypes = PropertyTypesNested<SCYourThingName>;
+assert<NotHas<SCYourThingNamePropertyTypes, SCThingWithoutReferences>>(false);
+assert<Has<SCYourThingNamePropertyTypes, SCThingWithoutReferences>>(true);
+assert<NotHas<SCYourThingNamePropertyTypes, SCThing>>(true);
+assert<Has<SCYourThingNamePropertyTypes, SCThing>>(false);
+assert<Extends<SCYourThingNameWithoutReferences, SCThing>>(false);
+assert<Extends<SCYourThingName, SCThing>>(true);
+```
+
 ## Additional coding style
 
 ### Extract inline type definitions 

README.md

@@ -37,13 +37,14 @@ External dependencies can not be covered by the annotations. Documentation about
 
 | annotation        | description                               | parameters    |
 |-------------------|-------------------------------------------|---------------|
-| `@aggregatable`   | used for generating of aggregations of the field if the core schema is used to put data into a database/key-value store |               |
+| `@aggregatable`   | used for generating of aggregations of the field if the core schema is used to put data into a database/key-value store | whether the property is being used on the top type or across all types: `global` |
 | `@float`          | number field is interpreted as float      |               |
 | `@indexable`      | marks the type as indexable if the core schema is used to put data into a database/key-value store|               |
 | `@integer`        | number field is interpreted as integer    |               |
 | `@keyword`        | string field is interpreted as keyword    |               |
-| `@sortable`       | field is sortable if the core schema is used to put data into a database/key-value store | sort method to be used: ducet, price, distance |
+| `@sortable`       | field is sortable if the core schema is used to put data into a database/key-value store | sort method to be used: `ducet`, `price`, `distance` |
 | `@text`           | string field is interpreted as text       |               |
 | `@validatable`    | marks the type as validatable if the core schema is used to put data into a database/key-value store |               |
+| `@filterable`     | non-object/nested field is filterable if the core schema is used to put data into a database/key-value store    |               |
 
 

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openstapps/core",
-  "version": "0.26.0",
+  "version": "0.33.0",
   "description": "StAppsCore - Generalized model of data",
   "keywords": [
     "Model",
@@ -44,30 +44,30 @@
   "dependencies": {
     "@types/geojson": "1.0.6",
     "@types/json-patch": "0.0.30",
-    "@types/node": "10.14.14",
+    "@types/node": "10.17.14",
     "fast-clone": "1.5.13",
-    "http-status-codes": "1.3.2",
+    "http-status-codes": "1.4.0",
     "json-patch": "0.7.0",
-    "jsonschema": "1.2.4",
+    "jsonschema": "1.2.5",
     "ts-optchain": "0.1.3"
   },
   "devDependencies": {
     "@krlwlfrt/async-pool": "0.1.0",
-    "@openstapps/configuration": "0.21.1",
-    "@openstapps/core-tools": "0.8.0",
+    "@openstapps/configuration": "0.23.0",
+    "@openstapps/core-tools": "0.14.0",
     "@openstapps/logger": "0.4.0",
-    "@types/chai": "4.1.7",
-    "@types/rimraf": "2.0.2",
+    "@types/chai": "4.2.8",
+    "@types/rimraf": "2.0.3",
     "chai": "4.2.0",
     "commander": "2.20.0",
-    "conditional-type-checks": "1.0.1",
-    "conventional-changelog-cli": "2.0.23",
+    "conditional-type-checks": "1.0.5",
+    "conventional-changelog-cli": "2.0.31",
     "mocha": "6.2.0",
     "mocha-typescript": "1.1.17",
     "nyc": "14.1.1",
-    "rimraf": "2.6.3",
+    "rimraf": "3.0.2",
     "source-map-support": "0.5.13",
-    "ts-node": "8.3.0",
+    "ts-node": "8.6.2",
     "tslint": "5.18.0",
     "typedoc": "0.14.2",
     "typescript": "3.5.3"

src/config/backend.ts

@@ -37,6 +37,13 @@ export interface SCBackendConfiguration {
    */
   hiddenTypes: SCThingType[];
 
+  /**
+   * A list of tags that will be ignored by the mapping generator
+   *
+   * The ignored tags should mainly be tags that are irrelevant to the mapping. The tags should include the '@'.
+   */
+  mappingIgnoredTags: string[];
+
   /**
    * Maximum number of queries, that can be used in MultiSearchRoute
    */

src/general/i18n.ts

@@ -18,11 +18,15 @@
 export interface SCLanguage {
   /**
    * The two letter ISO 639-1 Code of the Language
+   *
+   * @filterable
    */
   code: SCLanguageCode;
 
   /**
    * The Fulltext name of the Language
+   *
+   * @filterable
    */
   name: SCLanguageName;
 }

src/meta.ts

@@ -18,6 +18,7 @@ import {SCArticle, SCArticleMeta, SCArticleWithoutReferences} from './things/art
 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 {SCDateSeries, SCDateSeriesMeta, SCDateSeriesWithoutReferences} from './things/date-series';
 import {SCDiff, SCDiffMeta, SCDiffWithoutReferences} from './things/diff';
@@ -49,6 +50,7 @@ export const SCClasses: { [K in SCThingType]: object } = {
   'book': SCBookMeta,
   'building': SCBuildingMeta,
   'catalog': SCCatalogMeta,
+  'contact point': SCContactPointMeta,
   'course of studies': SCCourseOfStudiesMeta,
   'date series': SCDateSeriesMeta,
   'diff': SCDiffMeta,
@@ -76,6 +78,7 @@ export type SCThingsWithoutDiff =
   | SCBook
   | SCBuilding
   | SCCatalog
+  | SCContactPoint
   | SCCourseOfStudies
   | SCDateSeries
   | SCDish
@@ -116,26 +119,27 @@ export type SCAssociatedThingWithoutReferences<THING extends SCThings> =
       THING extends SCBook ? SCBookWithoutReferences :
         THING extends SCBuilding ? SCBuildingWithoutReferences :
           THING extends SCCatalog ? SCCatalogWithoutReferences :
-            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 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 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 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 for a thing without references
@@ -146,23 +150,24 @@ export type SCAssociatedThing<THING extends SCThings> =
       THING extends SCBookWithoutReferences ? SCBook :
         THING extends SCBuildingWithoutReferences ? SCBuilding :
           THING extends SCCatalogWithoutReferences ? SCCatalog :
-            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 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 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 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;

src/protocol/search/facet.ts

@@ -13,6 +13,7 @@
  * this program. If not, see <https://www.gnu.org/licenses/>.
  */
 import {SCThingsField} from '../../meta';
+import {SCThingType} from '../../things/abstract/thing';
 
 /**
  * A search facet
@@ -27,6 +28,11 @@ export interface SCFacet {
    * Field of the aggregation
    */
   field: SCThingsField;
+
+  /**
+   * Type of the aggregation
+   */
+  onlyOnType?: SCThingType;
 }
 
 /**

src/things/abstract/academic-degree.ts

@@ -29,6 +29,7 @@ export interface SCAcademicDegreeWithoutReferences
    * The achievable academic degree with academic field specification
    * (eg. Master of Science)
    *
+   * @filterable
    * @keyword
    */
   academicDegreewithField: string;
@@ -37,6 +38,7 @@ export interface SCAcademicDegreeWithoutReferences
    * The achievable academic degree with academic field specification
    * shorted (eg. M.Sc.).
    *
+   * @filterable
    * @keyword
    */
   academicDegreewithFieldShort: string;

src/things/abstract/academic-term.ts

@@ -25,27 +25,36 @@ export interface SCAcademicTermWithoutReferences
    * Short name of the academic term, using the given pattern
    *
    * @aggregatable
+   * @filterable
    * @keyword
    */
   acronym: string;
 
   /**
    * End date of the academic term
+   *
+   * @filterable
    */
   endDate: SCISO8601Date;
 
   /**
    * End date of lectures in the academic term
+   *
+   * @filterable
    */
   eventsEndDate?: SCISO8601Date;
 
   /**
    * Start date of lectures in the academic term
+   *
+   * @filterable
    */
   eventsStartDate?: SCISO8601Date;
 
   /**
    * Start date of the academic term
+   *
+   * @filterable
    */
   startDate: SCISO8601Date;
 }

src/things/abstract/creative-work.ts

@@ -32,6 +32,8 @@ export interface SCCreativeWorkWithoutReferences
   extends SCThingWithoutReferences, SCThingThatCanBeOfferedWithoutReferences {
   /**
    * Date the creative work was published
+   *
+   * @filterable
    */
   datePublished?: SCISO8601Date;
 
@@ -44,6 +46,7 @@ export interface SCCreativeWorkWithoutReferences
    * Keywords of the creative work
    *
    * @aggregatable
+   * @filterable
    * @keyword
    */
   keywords?: string[];

src/things/abstract/place.ts

@@ -40,31 +40,43 @@ export interface SCGeoInformation {
 export interface SCPostalAddress {
   /**
    * Country of the address
+   *
+   * @filterable
    */
   addressCountry: string;
 
   /**
    * City of the address
+   *
+   * @filterable
    */
   addressLocality: string;
 
   /**
    * State of the address
+   *
+   * @filterable
    */
   addressRegion?: string;
 
   /**
    * Zip code of the address
+   *
+   * @filterable
    */
   postalCode: string;
 
   /**
    * Optional post box number
+   *
+   * @filterable
    */
   postOfficeBoxNumber?: string;
 
   /**
    * Street of the address - with house number!
+   *
+   * @filterable
    */
   streetAddress: string;
 }

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

@@ -30,6 +30,8 @@ export interface SCThingThatAcceptsPaymentsWithoutReferences
   extends SCThingWithoutReferences {
   /**
    * Accepted payments of the place
+   *
+   * @filterable
    */
   paymentsAccepted?: SCThingThatAcceptsPaymentsAcceptedPayments[];
 }

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

@@ -29,6 +29,7 @@ export interface SCThingWithCategoriesWithoutReferences<T, U extends SCThingWith
    *
    * @sortable ducet
    * @aggregatable
+   * @filterable
    */
   categories: T[];
 
@@ -61,10 +62,6 @@ export interface SCThingWithCategories<T, U extends SCThingWithCategoriesSpecifi
  */
 export interface SCThingWithCategoriesTranslatableProperties
   extends SCThingTranslatableProperties {
-  /**
-   * translations of the categories of a thing with categories
-   */
-  categories?: string[];
 }
 
 /**

src/things/abstract/thing.ts

@@ -27,6 +27,7 @@ export enum SCThingType {
   Book = 'book',
   Building = 'building',
   Catalog = 'catalog',
+  ContactPoint = 'contact point',
   CourseOfStudies = 'course of studies',
   DateSeries = 'date series',
   Diff = 'diff',
@@ -55,6 +56,7 @@ export interface SCThingWithoutReferences {
   /**
    * Alternate names of the thing
    *
+   * @filterable
    * @keyword
    */
   alternateNames?: string[];
@@ -74,6 +76,7 @@ export interface SCThingWithoutReferences {
   /**
    * Name of the thing
    *
+   * @filterable
    * @minLength 1
    * @sortable ducet
    * @text
@@ -89,7 +92,8 @@ export interface SCThingWithoutReferences {
    * Type of the thing
    *
    * @sortable ducet
-   * @aggregatable
+   * @filterable
+   * @aggregatable global
    */
   type: SCThingType;
   /**

src/things/academic-event.ts

@@ -33,6 +33,7 @@ export interface SCAcademicEventWithoutReferences
    * Majors of the academic event that this event belongs to
    *
    * @aggregatable
+   * @filterable
    * @keyword
    */
   majors?: string[];
@@ -40,6 +41,7 @@ export interface SCAcademicEventWithoutReferences
   /**
    * Original unmapped category from the source of the academic event
    *
+   * @filterable
    * @keyword
    */
   originalCategory?: string;

src/things/book.ts

@@ -31,6 +31,7 @@ export interface SCBookWithoutReferences
   /**
    * Edition of a book
    *
+   * @filterable
    * @keyword
    */
   bookEdition?: string;
@@ -38,6 +39,7 @@ export interface SCBookWithoutReferences
   /**
    * ISBN of a book
    *
+   * @filterable
    * @keyword
    */
   isbn: string;

src/things/building.ts

@@ -46,12 +46,14 @@ export interface SCBuildingWithoutReferences
    *
    * @sortable ducet
    * @aggregatable
+   * @filterable
    */
   categories: SCBuildingCategories[];
 
   /**
    * List of floor names of the place
    *
+   * @filterable
    * @keyword
    */
   floors?: string[];

src/things/contact-point.ts

@@ -0,0 +1,136 @@
+/*
+ * Copyright (C) 2019 StApps
+ * This program is free software: you can redistribute it and/or modify it
+ * under the terms of the GNU General Public License as published by the Free
+ * Software Foundation, version 3.
+ *
+ * This program is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
+ * more details.
+ *
+ * You should have received a copy of the GNU General Public License along with
+ * this program. If not, see <https://www.gnu.org/licenses/>.
+ */
+
+import {SCMetaTranslations} from '../general/i18n';
+import {
+  SCThing,
+  SCThingMeta,
+  SCThingType,
+  SCThingWithoutReferences,
+  } from './abstract/thing';
+import {SCRoomWithoutReferences} from './room';
+
+/**
+ * A contact point without references
+ */
+export interface SCContactPointWithoutReferences
+  extends SCThingWithoutReferences  {
+  /**
+   * E-mail at the work location
+   *
+   * @keyword
+   */
+  email?: string;
+
+  /**
+   * Fax number at the work location
+   *
+   * @keyword
+   */
+  faxNumber?: string;
+
+  /**
+   * Office hours for contacting someone at the work location
+   *
+   * @see http://wiki.openstreetmap.org/wiki/Key:opening_hours/specification
+   * @keyword
+   */
+  officeHours?: string;
+
+  /**
+   * Contact number at the work location
+   *
+   * @keyword
+   */
+  telephone?: string;
+
+  /**
+   * Type of a contact point
+   */
+  type: SCThingType.ContactPoint;
+
+  /**
+   * URL at the work location
+   *
+   * @keyword
+   */
+  url?: string;
+}
+
+/**
+ * A contact point
+ *
+ * @see http://schema.org/ContactPoint
+ * 
+ * @validatable
+ * @indexable
+ */
+export interface SCContactPoint
+  extends SCContactPointWithoutReferences, SCThing  {
+  /**
+   * Exact place where work is performed
+   */
+  areaServed?: SCRoomWithoutReferences;
+
+  /**
+   * Type of a contact point
+   */
+  type: SCThingType.ContactPoint;
+}
+
+/**
+ * Meta information about a contact point
+ */
+export class SCContactPointMeta
+  extends SCThingMeta
+  implements SCMetaTranslations<SCContactPoint> {
+  /**
+   * Translations of fields
+   */
+  fieldTranslations = {
+    de: {
+      ...SCThingMeta.getInstance<SCThingMeta>().fieldTranslations.de,
+      areaServed: 'Arbeitsraum',
+      email: 'E-Mail-Addresse',
+      faxNumber: 'Faxnummer',
+      officeHours: 'Sprechzeiten',
+      telephone: 'Telefonnummer',
+      url: 'Link',
+    },
+    en: {
+      ...SCThingMeta.getInstance<SCThingMeta>().fieldTranslations.en,
+      areaServed: 'location',
+      email: 'email address',
+      faxNumber: 'fax number',
+      officeHours: 'office hours',
+      telephone: 'telephone number',
+      url: 'link',
+    },
+  };
+
+  /**
+   * Translations of values of fields
+   */
+  fieldValueTranslations = {
+    de: {
+      ...SCThingMeta.getInstance<SCThingMeta>().fieldValueTranslations.de,
+      type: 'Kontaktinformation',
+    },
+    en: {
+      ...SCThingMeta.getInstance<SCThingMeta>().fieldValueTranslations.en,
+      type: SCThingType.ContactPoint,
+    },
+  };
+}

src/things/course-of-studies.ts

@@ -39,6 +39,7 @@ export interface SCCourseOfStudiesWithoutReferences
   /**
    * Actual major of the course of studies (eg. physics)
    *
+   * @filterable
    * @keyword
    */
   major: string;

src/things/date-series.ts

@@ -47,6 +47,8 @@ export interface SCDateSeriesWithoutReferences
   extends SCThingThatCanBeOfferedWithoutReferences {
   /**
    * Dates of the date series that are initially planned to be held
+   *
+   * @filterable
    */
   dates: SCISO8601Date[];
 

src/things/dish.ts

@@ -38,6 +38,7 @@ export interface SCDishWithoutReferences
   /**
    * Additives of the dish
    *
+   * @filterable
    * @keyword
    */
   additives?: string[];
@@ -47,6 +48,7 @@ export interface SCDishWithoutReferences
    *
    * @sortable ducet
    * @aggregatable
+   * @filterable
    */
   categories: SCDishCategories[];
 
@@ -118,6 +120,7 @@ export interface SCDishCharacteristic {
   /**
    * Name of the characteristic
    *
+   * @filterable
    * @text
    */
   name: string;

src/things/message.ts

@@ -36,11 +36,15 @@ export interface SCMessageWithoutReferences
 
   /**
    * Roles for which the message is intended
+   *
+   * @filterable
    */
   audiences: SCMessageAudience[];
 
   /**
    * When the message was created
+   *
+   * @filterable
    */
   dateCreated?: SCISO8601Date;
 
@@ -51,6 +55,11 @@ export interface SCMessageWithoutReferences
    */
   messageBody: string;
 
+  /**
+   * An index for applying a custom sorting of multiple messages
+   */
+  sequenceIndex?: number;
+
   /**
    * Translated fields of a message
    */
@@ -119,6 +128,7 @@ export class SCMessageMeta
       audiences: 'Zielgruppen',
       dateCreated: 'Erstellungsdatum',
       messageBody: 'Nachrichteninhalt',
+      sequenceIndex: 'Sequenzindex',
     },
     en: {
       ...SCCreativeWorkMeta.getInstance<SCCreativeWorkMeta>().fieldTranslations
@@ -127,6 +137,7 @@ export class SCMessageMeta
       audiences: 'audiences',
       dateCreated: 'date created',
       messageBody: 'message body',
+      sequenceIndex: 'sequence index',
     },
   };
 

src/things/organization.ts

@@ -15,6 +15,7 @@
 import {SCMetaTranslations} from '../general/i18n';
 import {SCThingMeta, SCThingType, SCThingWithoutReferences} from './abstract/thing';
 import {SCThingInPlace, SCThingInPlaceMeta} from './abstract/thing-in-place';
+import {SCContactPointWithoutReferences} from './contact-point';
 
 /**
  * An organization without references
@@ -35,6 +36,11 @@ export interface SCOrganizationWithoutReferences
  */
 export interface SCOrganization
   extends SCOrganizationWithoutReferences, SCThingInPlace {
+  /**
+   * A list of contact points concerning the organization
+   */
+  contactPoints?: SCContactPointWithoutReferences[];
+
   /**
    * Type of an organization
    */
@@ -52,9 +58,11 @@ export class SCOrganizationMeta
   fieldTranslations = {
     de: {
       ...SCThingInPlaceMeta.getInstance<SCThingInPlaceMeta>().fieldTranslations.de,
+      contactPoints: 'Kontaktinformationen',
     },
     en: {
       ...SCThingInPlaceMeta.getInstance<SCThingInPlaceMeta>().fieldTranslations.en,
+      contactPoints: 'contact details',
     },
   };
 

src/things/person.ts

@@ -16,6 +16,7 @@ import {SCMetaTranslations, SCNationality} from '../general/i18n';
 import {SCISO8601Date} from '../general/time';
 import {SCThing, SCThingMeta, SCThingType, SCThingWithoutReferences} from './abstract/thing';
 import {SCBuildingWithoutReferences} from './building';
+import {SCContactPointWithoutReferences} from './contact-point';
 import {SCOrganizationWithoutReferences} from './organization';
 import {SCPointOfInterestWithoutReferences} from './point-of-interest';
 import {SCRoomWithoutReferences} from './room';
@@ -28,12 +29,15 @@ export interface SCPersonWithoutReferences
   /**
    * Additional first names of the person.
    *
+   * @filterable
    * @keyword
    */
   additionalName?: string;
 
   /**
    * The birth date of the person.
+   *
+   * @filterable
    */
   birthDate?: SCISO8601Date;
 
@@ -42,6 +46,7 @@ export interface SCPersonWithoutReferences
    *
    * @TJS-format email
    *
+   * @filterable
    * @keyword
    */
   email?: string;
@@ -49,6 +54,7 @@ export interface SCPersonWithoutReferences
   /**
    * The family name of the person.
    *
+   * @filterable
    * @keyword
    */
   familyName: string;
@@ -56,18 +62,22 @@ export interface SCPersonWithoutReferences
   /**
    * The private fax number of the person.
    *
+   * @filterable
    * @keyword
    */
   faxNumber?: string;
 
   /**
    * The gender of the person.
+   *
+   * @filterable
    */
   gender?: SCPersonGender;
 
   /**
    * The first name of the person.
    *
+   * @filterable
    * @keyword
    */
   givenName: string;
@@ -75,6 +85,7 @@ export interface SCPersonWithoutReferences
   /**
    * Honorific prefix of the person.
    *
+   * @filterable
    * @keyword
    */
   honorificPrefix?: string;
@@ -82,6 +93,7 @@ export interface SCPersonWithoutReferences
   /**
    * Honorific suffix of the person.
    *
+   * @filterable
    * @keyword
    */
   honorificSuffix?: string;
@@ -89,6 +101,7 @@ export interface SCPersonWithoutReferences
   /**
    * Titles of jobs that the person has.
    *
+   * @filterable
    * @keyword
    */
   jobTitles?: string[];
@@ -96,6 +109,7 @@ export interface SCPersonWithoutReferences
   /**
    * The complete name of the person combining all the parts of the name into one.
    *
+   * @filterable
    * @text
    */
   name: string;
@@ -146,7 +160,7 @@ export interface SCPerson
   /**
    * Locations where the person performs her/his work
    */
-  workLocations?: SCContactPoint[];
+  workLocations?: SCContactPointWithoutReferences[];
 }
 
 /**
@@ -175,13 +189,14 @@ export class SCPersonMeta
       jobTitles: 'Berufsbezeichnungen',
       nationality: 'Staatsangehörigkeit',
       telephone: 'Telefonnummer',
-      workLocations: 'Arbeitsorte',
+      workLocations: 'Arbeitsstandorte',
     },
     en: {
       ...SCThingMeta.getInstance<SCThingMeta>().fieldTranslations.en,
       additionalName: 'additional name',
       affiliations: 'affiliations',
       birthDate: 'birth date',
+      contactDetails: 'contact details',
       email: 'email',
       familyName: 'family name',
       faxNumber: 'fax',
@@ -218,53 +233,6 @@ export class SCPersonMeta
   };
 }
 
-/**
- * A contact point
- *
- * @see http://schema.org/ContactPoint
- */
-export interface SCContactPoint {
-  /**
-   * Exact place where work is performed
-   */
-  areaServed?: SCRoomWithoutReferences;
-
-  /**
-   * E-mail at the work location
-   *
-   * @keyword
-   */
-  email?: string;
-
-  /**
-   * Fax number at the work location
-   *
-   * @keyword
-   */
-  faxNumber?: string;
-
-  /**
-   * Times available for contacting at the work location
-   *
-   * @keyword
-   */
-  hoursAvailable?: string;
-
-  /**
-   * Contact number at the work location
-   *
-   * @keyword
-   */
-  telephone?: string;
-
-  /**
-   * URL at the work location
-   *
-   * @keyword
-   */
-  url?: string;
-}
-
 /**
  * Gender of a person
  */

src/things/room.ts

@@ -58,6 +58,7 @@ export interface SCRoomWithoutReferences
   /**
    * The name of the floor in which the room is in.
    *
+   * @filterable
    * @text
    */
   floorName?: string;

src/things/semester.ts

@@ -28,6 +28,7 @@ export interface SCSemesterWithoutReferences
   /**
    * The short name of the semester, using the given pattern.
    *
+   * @filterable
    * @pattern ^(WS|SS) [0-9]{4}(/[0-9]{2})?$
    * @keyword
    */

src/things/study-module.ts

@@ -47,6 +47,7 @@ export interface SCStudyModuleWithoutReferences
   /**
    * Majors that this study module is meant for
    *
+   * @filterable
    * @keyword
    */
   majors: string[];

src/things/todo.ts

@@ -35,6 +35,8 @@ export interface SCToDoWithoutReferences
 
   /**
    * A date when the "to do" is due
+   *
+   * @filterable
    */
   dueDate?: SCISO8601Date;
 

src/things/video.ts

@@ -68,6 +68,8 @@ export interface SCVideoSource {
 
   /**
    * MIME-Type of the source File
+   *
+   * @filterable
    */
   mimeType: SCVideoMimeType;
 
@@ -101,6 +103,8 @@ export interface SCVideoTrack {
 
   /**
    * Content Type of the Track File
+   *
+   * @filterable
    */
   type: SCVideoTrackTypes;
 

src/translator.ts

@@ -146,8 +146,8 @@ export class SCThingTranslator {
    * Applies known field value translations of the given SCThings meta class to an instance
    * Translated values overwrite current values inplace (destructive)
    *
-   * @param language The language the thing is translated to
-   * @param thing The thing that will be translated
+   * @param instance The thing / object that will be translated
+   * @param language The language the thing / object is translated to
    * @returns The thing with translated meta field values
    */
   private replaceAvailableMetaFieldValueTranslations(instance: any,
@@ -159,13 +159,18 @@ export class SCThingTranslator {
     if (typeof metaClass.fieldValueTranslations[language] !== 'undefined') {
       Object.keys(metaClass.fieldValueTranslations[language])
         .forEach((key) => {
-          if (metaClass.fieldValueTranslations[language][key] instanceof Object) {
+          if (metaClass.fieldValueTranslations[language][key] instanceof Object
+          && (instance as any)[key] instanceof Object) {
             // Assigns known translations of subproperties to property in given language (e.g. categories)
             Object.keys((instance as any)[key])
               .forEach((subKey) => {
                 (instance as any)[key][subKey] =
                   metaClass.fieldValueTranslations[language][key][(instance as any)[key][subKey]];
               });
+          } else if (metaClass.fieldValueTranslations[language][key] instanceof Object
+            && typeof (instance as any)[key] === 'string') {
+            // Assigns known translations of enum to property in given language (e.g. SCSettingInputType)
+            (instance as any)[key] = metaClass.fieldValueTranslations[language][key][(instance as any)[key]];
           } else {
             // Assigns property to known translation of fieldValueTranslations in given language
             (instance as any)[key] = metaClass.fieldValueTranslations[language][key];
@@ -213,8 +218,8 @@ export class SCThingTranslator {
    * All the values will be set to the known translations of the property/key name
    * @example
    * const translatedMetaDish = translator.translatedPropertyNames<SCCourseOfStudies>(SCThingType.CourseOfStudies);
-   * @param language The language the object is translated to
-   * @param thingType Type of the thing
+   * @param thing The thing 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>(thing: T,
@@ -228,8 +233,8 @@ export class SCThingTranslator {
    * Recursively translates the given object in-place
    * Translated values overwrite current values (destructive)
    *
-   * @param language The language the thing is translated to
-   * @param thing The thing that will be translated
+   * @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,

test/resources/ContactPoint.1.json

@@ -0,0 +1,39 @@
+{
+  "errorNames": [],
+  "instance": {
+    "type": "contact point",
+    "name": "Dienstadresse",
+    "areaServed": {
+      "type": "room",
+      "categories": [
+        "education"
+      ],
+      "uid": "39c1a574-04ef-5157-9c6f-e271d93eb273",
+      "name": "3.G 121",
+      "alternateNames": [
+        "Dienstzimmer"
+      ],
+      "geo": {
+        "point": {
+          "coordinates": [
+            8.66919,
+            50.12834
+          ],
+          "type": "Point"
+        }
+      }
+    },
+    "email": "info@example.com",
+    "faxNumber": "069 / 123450",
+    "officeHours": "Mo, Mi 8:00-13:00",
+    "telephone": "069 / 12345",
+    "url": "https://example.com",
+    "uid": "be34a419-e9e8-5de0-b998-dd1b19e7beef",
+    "origin": {
+      "indexed": "2018-09-11T12:30:00Z",
+      "name": "Dummy",
+      "type": "remote"
+    }
+  },
+  "schema": "SCContactPoint"
+}

test/resources/Diff.1.json

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

test/resources/Diff.2.json

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

test/resources/Message.1.json

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

test/resources/Message.2.json

@@ -11,6 +11,7 @@
     "audiences": [
       "students"
     ],
+    "sequenceIndex": 1004,
     "origin": {
       "indexed": "2018-09-11T12:30:00Z",
       "name": "foo",

test/resources/Message.3.json

@@ -17,6 +17,7 @@
       "type": "organization",
       "uid": "4806ef14-b631-5c20-91d1-3c627decca5a"
     }],
+    "sequenceIndex": 1005,
     "origin": {
       "indexed": "2018-09-11T12:30:00Z",
       "name": "Dummy",

test/resources/Organization.2.json

@@ -0,0 +1,26 @@
+{
+  "errorNames": [],
+  "instance": {
+    "type": "organization",
+    "uid": "20e48393-0d2b-5bdc-9d92-5e0dc1e2860f",
+    "contactPoints": [
+      {
+        "type": "contact point",
+        "name": "Dienstadresse",
+        "email": "info@example.com",
+        "faxNumber": "069 / 123450",
+        "officeHours": "Mo, Mi 8:00-13:00",
+        "telephone": "069 / 12345",
+        "url": "https://example.com",
+        "uid": "be34a419-e9e8-5de0-b998-dd1b19e7beef"
+      }
+    ],
+    "name": "Technische Universität Berlin",
+    "origin": {
+      "indexed": "2018-09-11T12:30:00Z",
+      "name": "Dummy",
+      "type": "remote"
+    }
+  },
+  "schema": "SCOrganization"
+}

test/resources/Person.3.json

@@ -17,58 +17,14 @@
     "uid": "be34a419-e9e8-5de0-b998-dd1b19e7f451",
     "workLocations": [
       {
-        "url": "http://www.fb03.uni-frankfurt.de/1234567",
-        "email": "mustermann@soz.uni-frankfurt.de",
-        "faxNumber": "",
-        "telephone": "069/123-36232; -1324325",
-        "hoursAvailable": "siehe Homepage",
-        "areaServed": {
-          "type": "room",
-          "categories": [
-            "education"
-          ],
-          "uid": "39c1a574-04ef-5157-9c6f-e271d93eb273",
-          "name": "3.G 121",
-          "alternateNames": [
-            "Dienstzimmer"
-          ],
-          "geo": {
-            "point": {
-              "coordinates": [
-                8.66919,
-                50.12834
-              ],
-              "type": "Point"
-            }
-          }
-        }
-      },
-      {
-        "url": "http://www2.uni-frankfurt.de/12345/vizepraesidenten",
-        "email": "",
-        "faxNumber": "",
-        "telephone": "069/123-1235",
-        "hoursAvailable": "siehe Homepage",
-        "areaServed": {
-          "type": "room",
-          "categories": [
-            "education"
-          ],
-          "uid": "5e54aefd-078b-5007-bca1-53dc60f79d37",
-          "name": "4.P 22",
-          "alternateNames": [
-            "Dienstzimmer"
-          ],
-          "geo": {
-            "point": {
-              "coordinates": [
-                8.66898,
-                50.12772
-              ],
-              "type": "Point"
-            }
-          }
-        }
+        "type": "contact point",
+        "name": "Dienstadresse",
+        "email": "info@example.com",
+        "faxNumber": "069 / 123450",
+        "officeHours": "Mo, Mi 8:00-13:00",
+        "telephone": "069 / 12345",
+        "url": "https://example.com",
+        "uid": "be34a419-e9e8-5de0-b998-dd1b19e7beef"
       }
     ],
     "origin": {

test/resources/Setting.3.json

@@ -16,7 +16,6 @@
     },
     "translations": {
       "de": {
-        "categories": ["Benutzer"],
         "description": "Die Sprache in der die App angezeigt wird.",
         "name": "Sprache",
         "values": [
@@ -25,9 +24,6 @@
         ]
       },
       "en": {
-        "categories": [
-          "User"
-        ],
         "description": "The language this app is going to use.",
         "name": "Language",
         "values": [

test/schema.spec.ts

@@ -24,8 +24,7 @@ import {DeclarationReflection, ProjectReflection} from 'typedoc';
 import {ArrayType, IntrinsicType, ReferenceType, StringLiteralType, Type, UnionType} from 'typedoc/dist/lib/models';
 
 process.on('unhandledRejection', (err) => {
-  Logger.error('UNHANDLED REJECTION', err.stack);
-  process.exit(1);
+  throw err;
 });
 
 /**

test/translator.spec.ts

@@ -18,6 +18,7 @@ import {slow, suite, test, timeout} from 'mocha-typescript';
 import {SCThingOriginType, SCThingType} 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';
 import {SCThingTranslator} from '../src/translator';
 
 const building: SCBuildingWithoutReferences = {
@@ -86,6 +87,23 @@ const dish: SCDish = {
   uid: '540862f3-ea30-5b8f-8678-56b4dc217140',
 };
 
+const setting: SCSetting = {
+  categories: ['profile'],
+  defaultValue: 'student',
+  description: 'base-description',
+  inputType: SCSettingInputType.SingleChoice,
+  name: 'group',
+  order: 1,
+  origin: {
+    indexed: '2018-11-11T14:30:00Z',
+    name: 'Dummy',
+    type: SCThingOriginType.Remote,
+  },
+  type: SCThingType.Setting,
+  uid: '2c97aa36-4aa2-43de-bc5d-a2b2cb3a530e',
+  values: ['student', 'employee', true, 42],
+};
+
 const translator = new SCThingTranslator('de');
 // tslint:disable-next-line:no-eval
 const languageNonExistant = eval("'jp'");
@@ -95,6 +113,10 @@ const translatorWithFallback = new SCThingTranslator(languageNonExistant);
 // tslint:disable:member-ordering TranslationSpecInplace
 @suite(timeout(10000), slow(5000))
 export class TranslationSpecInplace {
+  @test
+  public directEnumSingleValue () {
+    expect(translator.translate(setting).inputType()).to.equal('einfache Auswahl');
+  }
 
   @test
   public directStringLiteralType() {

test/type.spec.ts

@@ -19,6 +19,7 @@ import {SCArticle, SCArticleWithoutReferences} from '../src/things/article';
 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 {SCDateSeries, SCDateSeriesWithoutReferences} from '../src/things/date-series';
 import {SCDiff, SCDiffWithoutReferences} from '../src/things/diff';
@@ -126,6 +127,17 @@ assert<Has<SCBuildingPropertyTypes, SCThing>>(false);
 assert<Extends<SCBuildingWithoutReferences, SCThing>>(false);
 assert<Extends<SCBuilding, SCThing>>(true);
 
+/**
+ * Types of properties of SCContactPoint
+ */
+type SCContactPointPropertyTypes = PropertyTypesNested<SCContactPoint>;
+assert<NotHas<SCContactPointPropertyTypes, SCThingWithoutReferences>>(false);
+assert<Has<SCContactPointPropertyTypes, SCThingWithoutReferences>>(true);
+assert<NotHas<SCContactPointPropertyTypes, SCThing>>(true);
+assert<Has<SCContactPointPropertyTypes, SCThing>>(false);
+assert<Extends<SCContactPointWithoutReferences, SCThing>>(false);
+assert<Extends<SCContactPoint, SCThing>>(true);
+
 /**
  * Types of properties of SCCatalog
  */