refactor: split api into api, api-cli & api-plugin

This commit is contained in:
2023-06-02 16:41:25 +02:00
parent 495a63977c
commit b21833de40
205 changed files with 1981 additions and 1492 deletions

View File

@@ -21,7 +21,6 @@ import {SCThing, SCThingMeta, SCThingWithoutReferences} from './thing.js';
export interface SCAcademicDegreeWithoutReferences extends SCThingWithoutReferences {
/**
* The achievable academic degree
*
* @filterable
* @sortable ducet
*/

View File

@@ -22,7 +22,6 @@ import {SCThing, SCThingMeta, SCThingWithoutReferences} from './thing.js';
export interface SCAcademicTermWithoutReferences extends SCThingWithoutReferences {
/**
* Short name of the academic term, using the given pattern
*
* @aggregatable
* @filterable
* @keyword
@@ -31,28 +30,24 @@ export interface SCAcademicTermWithoutReferences extends SCThingWithoutReference
/**
* 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;

View File

@@ -35,28 +35,24 @@ export interface SCCreativeWorkWithoutReferences extends SCThingWithoutReference
/**
* Edition of a creative work (e.g. the book edition or edition of an article)
*
* @keyword
*/
edition?: string;
/**
* Date (in text form) the creative work was published for the first time
*
* @keyword
*/
firstPublished?: string;
/**
* Languages this creative work is written/recorded/... in
*
* @filterable
*/
inLanguage?: SCLanguageCode;
/**
* Keywords of the creative work
*
* @aggregatable
* @filterable
* @keyword
@@ -65,7 +61,6 @@ export interface SCCreativeWorkWithoutReferences extends SCThingWithoutReference
/**
* Date (in text form) the creative work was most recently
*
* @keyword
*/
lastPublished?: string;
@@ -117,7 +112,6 @@ export interface SCCreativeWork extends SCCreativeWorkWithoutReferences, SCThing
export interface SCCreativeWorkTranslatableProperties extends SCThingTranslatableProperties {
/**
* Translation of the keywords of the creative work
*
* @keyword
*/
keywords?: string[];

View File

@@ -27,7 +27,6 @@ export interface SCEventWithoutReferences extends SCThingWithoutReferences {
* Maximum number of participants of the event
*
* A maximum number of people that can participate in the event.
*
* @integer
*/
maximumParticipants?: number;
@@ -36,7 +35,6 @@ export interface SCEventWithoutReferences extends SCThingWithoutReferences {
* Remaining attendee capacity of the event
*
* This number represents the remaining open spots.
*
* @integer
*/
remainingAttendeeCapacity?: number;

View File

@@ -39,42 +39,36 @@ 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;
@@ -99,7 +93,6 @@ export interface SCPlaceWithoutReferences extends SCThingWithoutReferences {
/**
* Opening hours of the place
*
* @see http://wiki.openstreetmap.org/wiki/Key:opening_hours/specification
* @keyword
*/

View File

@@ -26,7 +26,6 @@ export type SCThingThatAcceptsPaymentsAcceptedPayments = 'cash' | 'credit' | 'ca
export interface SCThingThatAcceptsPaymentsWithoutReferences extends SCThingWithoutReferences {
/**
* Accepted payments of the place
*
* @filterable
*/
paymentsAccepted?: SCThingThatAcceptsPaymentsAcceptedPayments[];

View File

@@ -25,7 +25,6 @@ import {SCThing, SCThingMeta, SCThingTranslatableProperties, SCThingWithoutRefer
export interface SCPriceGroup {
/**
* Default price of the thing
*
* @sortable price
* @float
*/
@@ -38,7 +37,6 @@ export interface SCPriceGroup {
export interface SCAcademicPriceGroup extends SCPriceGroup {
/**
* Price for employees
*
* @sortable price
* @float
*/
@@ -46,7 +44,6 @@ export interface SCAcademicPriceGroup extends SCPriceGroup {
/**
* Price for guests
*
* @sortable price
* @float
*/
@@ -54,7 +51,6 @@ export interface SCAcademicPriceGroup extends SCPriceGroup {
/**
* Price for students
*
* @sortable price
* @float
*/
@@ -119,7 +115,6 @@ export interface SCThingThatCanBeOfferedOffer<T extends SCPriceGroup> extends SC
export interface SCThingThatCanBeOfferedTranslatableProperties extends SCThingTranslatableProperties {
/**
* Availability of an offer
*
* @keyword
*/
'offers[].availability'?: string;

View File

@@ -26,7 +26,6 @@ export interface SCThingWithCategoriesWithoutReferences<T, U extends SCThingWith
extends SCThingWithoutReferences {
/**
* Categories of a thing with categories
*
* @sortable ducet
* @aggregatable
* @filterable
@@ -64,7 +63,6 @@ export interface SCThingWithCategories<T, U extends SCThingWithCategoriesSpecifi
export interface SCThingWithCategoriesTranslatableProperties extends SCThingTranslatableProperties {
/**
* translations of the categories of a thing with categories
*
* @sortable ducet
*/
categories?: string[];
@@ -78,28 +76,24 @@ export interface SCThingWithCategoriesTranslatableProperties extends SCThingTran
export interface SCThingWithCategoriesSpecificValues {
/**
* Category specific alternate names of a thing
*
* @keyword
*/
alternateNames?: string[];
/**
* Category specific description of a thing
*
* @text
*/
description?: string;
/**
* URL of a category specific image of a thing
*
* @keyword
*/
image?: string;
/**
* Category specific name of a thing
*
* @sortable ducet
* @text
*/
@@ -107,7 +101,6 @@ export interface SCThingWithCategoriesSpecificValues {
/**
* Category specific URL of a thing
*
* @keyword
*/
url?: string;

View File

@@ -60,7 +60,6 @@ export enum SCThingType {
export interface SCThingWithoutReferences {
/**
* Alternate names of the thing
*
* @filterable
* @keyword
*/
@@ -68,7 +67,6 @@ export interface SCThingWithoutReferences {
/**
* Description of the thing
*
* @minLength 1
* @text
*/
@@ -83,14 +81,12 @@ export interface SCThingWithoutReferences {
/**
* URL of an image of the thing
*
* @keyword
*/
image?: string;
/**
* Name of the thing
*
* @filterable
* @minLength 1
* @sortable ducet
@@ -114,7 +110,6 @@ export interface SCThingWithoutReferences {
/**
* Type of the thing
*
* @sortable ducet
* @filterable
* @aggregatable global
@@ -178,7 +173,6 @@ export interface SCThingRemoteOrigin extends SCThingOrigin {
/**
* Name of the origin
*
* @text
*/
name: string;
@@ -237,13 +231,11 @@ export interface SCThingUserOrigin extends SCThingOrigin {
export interface SCThingTranslatableProperties {
/**
* Translation of the description of the thing
*
* @text
*/
description?: string;
/**
* Translation of the name of the thing
*
* @sortable ducet
* @text
*/
@@ -260,7 +252,6 @@ export interface SCThingTranslatableProperties {
export interface SCThingTranslatablePropertyOrigin {
/**
* Translation of the name of the origin
*
* @text
*/
name: string;

View File

@@ -31,7 +31,6 @@ export interface SCAcademicEventWithoutReferences
SCThingWithCategoriesWithoutReferences<SCAcademicEventCategories, SCThingWithCategoriesSpecificValues> {
/**
* Majors of the academic event that this event belongs to
*
* @aggregatable
* @filterable
* @keyword
@@ -40,7 +39,6 @@ export interface SCAcademicEventWithoutReferences
/**
* Original unmapped category from the source of the academic event
*
* @filterable
* @keyword
*/
@@ -59,7 +57,6 @@ export interface SCAcademicEventWithoutReferences
/**
* An academic event
*
* @validatable
* @indexable
*/
@@ -104,14 +101,12 @@ export type SCAcademicEventCategories =
export interface SCAcademicEventTranslatableProperties extends SCThingWithCategoriesTranslatableProperties {
/**
* Translations of the majors of the academic event that this event belongs to
*
* @keyword
*/
majors?: string[];
/**
* Translation of the original unmapped category from the source of the academic event
*
* @keyword
*/
originalCategory?: string;

View File

@@ -49,7 +49,6 @@ export interface SCArticleWithoutReferences
SCThingWithCategoriesWithoutReferences<SCArticleCategories, SCThingWithCategoriesSpecificValues> {
/**
* Article itself as markdown
*
* @text
*/
articleBody?: string;
@@ -72,7 +71,6 @@ export interface SCArticleWithoutReferences
/**
* An article
*
* @validatable
* @indexable
*/
@@ -109,7 +107,6 @@ export interface SCArticleTranslatableProperties
SCCreativeWorkTranslatableProperties {
/**
* Translation of the article itself as markdown
*
* @text
*/
articleBody?: string[];

View File

@@ -41,7 +41,6 @@ export interface SCAssessmentWithoutReferences
> {
/**
* Number of attempts
*
* @integer
*/
attempt?: number;
@@ -53,7 +52,6 @@ export interface SCAssessmentWithoutReferences
/**
* ECTS (credit-points)
*
* @float
*/
ects?: number;
@@ -81,7 +79,6 @@ export interface SCAssessmentWithoutReferences
/**
* An assessment
*
* @validatable
*/
export interface SCAssessment

View File

@@ -73,7 +73,6 @@ export interface SCBookWithoutReferences
/**
* ISBNs of a book
*
* @filterable
* @keyword
*/
@@ -81,7 +80,6 @@ export interface SCBookWithoutReferences
/**
* Number of pages of a book
*
* @integer
*/
numberOfPages?: number;
@@ -99,7 +97,6 @@ export interface SCBookWithoutReferences
/**
* A book
*
* @validatable
* @indexable
*/

View File

@@ -43,7 +43,6 @@ export interface SCBuildingWithoutReferences
SCPlaceWithoutReferences {
/**
* List of floor names of the place
*
* @filterable
* @keyword
*/
@@ -62,7 +61,6 @@ export interface SCBuildingWithoutReferences
/**
* A building
*
* @validatable
* @indexable
*/

View File

@@ -32,7 +32,6 @@ export interface SCCatalogWithoutReferences
* Level of the catalog (0 for 'root catalog', 1 for its subcatalog, 2 for its subcatalog etc.)
*
* Needed for keeping order in catalog inheritance array.
*
* @filterable
* @integer
*/
@@ -46,7 +45,6 @@ export interface SCCatalogWithoutReferences
/**
* A catalog
*
* @validatable
* @indexable
*/

View File

@@ -23,21 +23,18 @@ import {SCRoomWithoutReferences} from './room.js';
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
*/
@@ -45,7 +42,6 @@ export interface SCContactPointWithoutReferences extends SCThingWithoutReference
/**
* Contact number at the work location
*
* @keyword
*/
telephone?: string;
@@ -57,7 +53,6 @@ export interface SCContactPointWithoutReferences extends SCThingWithoutReference
/**
* URL at the work location
*
* @keyword
*/
url?: string;
@@ -65,7 +60,6 @@ export interface SCContactPointWithoutReferences extends SCThingWithoutReference
/**
* A contact point
*
* @see http://schema.org/ContactPoint
* @validatable
* @indexable

View File

@@ -43,14 +43,12 @@ export interface SCCourseOfStudyWithoutReferences
/**
* The modes the course of study is offered in
*
* @filterable
*/
mode?: SCCourseOfStudyMode;
/**
* The time modes the course of study is offered in
*
* @filterable
*/
timeMode?: SCCourseOfStudyTimeMode;
@@ -68,7 +66,6 @@ export interface SCCourseOfStudyWithoutReferences
/**
* A course of study
*
* @validatable
* @indexable
*/

View File

@@ -33,7 +33,6 @@ import {SCSportCourseWithoutReferences} from './sport-course.js';
export interface SCSportCoursePriceGroup extends SCAcademicPriceGroup {
/**
* Price for alumnis
*
* @float
*/
alumni?: number;
@@ -45,7 +44,6 @@ export interface SCSportCoursePriceGroup extends SCAcademicPriceGroup {
export interface SCDateSeriesWithoutReferences extends SCThingThatCanBeOfferedWithoutReferences {
/**
* Dates of the date series that are initially planned to be held
*
* @filterable
*/
dates: SCISO8601Date[];
@@ -62,7 +60,6 @@ export interface SCDateSeriesWithoutReferences extends SCThingThatCanBeOfferedWi
/**
* Frequency of the date series
*
* @filterable
*/
repeatFrequency?: SCISO8601Duration;
@@ -80,7 +77,6 @@ export interface SCDateSeriesWithoutReferences extends SCThingThatCanBeOfferedWi
/**
* A date series
*
* @validatable
* @indexable
*/

View File

@@ -45,7 +45,6 @@ export interface SCDiffWithoutReferences extends SCThingWithoutReferences {
/**
* A diff
*
* @validatable
*/
export interface SCDiff extends SCDiffWithoutReferences, SCThing {

View File

@@ -38,7 +38,6 @@ export interface SCDishWithoutReferences
SCThingWithCategoriesWithoutReferences<SCDishCategories, SCThingWithCategoriesSpecificValues> {
/**
* Additives of the dish
*
* @filterable
* @keyword
*/
@@ -72,7 +71,6 @@ export interface SCDishWithoutReferences
/**
* A dish
*
* @validatable
* @indexable
*/
@@ -106,7 +104,6 @@ export interface SCDishTranslatableProperties
SCThingThatCanBeOfferedTranslatableProperties {
/**
* Additives of the dish
*
* @filterable
* @keyword
*/
@@ -123,14 +120,12 @@ export interface SCDishTranslatableProperties
export interface SCDishCharacteristic {
/**
* URL of an image of the characteristic
*
* @keyword
*/
image?: string;
/**
* Name of the characteristic
*
* @filterable
* @text
*/
@@ -144,55 +139,47 @@ export type SCDishCategories = 'appetizer' | 'salad' | 'main dish' | 'dessert' |
/**
* Type definition for SCNutritionInformation
*
* @see https://schema.org/NutritionInformation
*/
export interface SCNutritionInformation {
/**
* Number of calories contained (in kcal)
*
* @float
*/
calories?: number;
/**
* Content of carbohydrates (in grams)
*
* @float
*/
carbohydrateContent?: number;
/**
* Content of fat (in grams)
*
* @float
*/
fatContent?: number;
/**
* Content of proteins (in grams)
*
* @float
*/
proteinContent?: number;
/**
* Content of salt (in grams)
*
* @float
*/
saltContent?: number;
/**
* Content of saturated fat (in grams)
*
* @float
*/
saturatedFatContent?: number;
/**
* Content of sugar (in grams)
*
* @float
*/
sugarContent?: number;
@@ -206,7 +193,6 @@ export interface SCMenuSection {
/**
* The time span when the dishes from the sections are available.
*
* @see http://wiki.openstreetmap.org/wiki/Key:opening_hours/specification
*/
servingHours?: string;

View File

@@ -27,7 +27,6 @@ export interface SCFavoriteWithoutReferences extends SCSaveableThingWithoutRefer
/**
* A favorite
*
* @validatable
*/
export interface SCFavorite extends SCSaveableThing {

View File

@@ -30,7 +30,6 @@ import {SCRoomWithoutReferences} from './room.js';
export interface SCFloorWithoutReferences extends SCThingWithoutReferences {
/**
* Floor name in the place it is in e.g. "first floor", "ground floor". This doesn't reference the building name.
*
* @text
*/
floorName: string;
@@ -53,7 +52,6 @@ export interface SCFloorWithoutReferences extends SCThingWithoutReferences {
/**
* A floor
*
* @validatable
* @indexable
*/
@@ -97,7 +95,6 @@ export interface SCFloorFeatureWithPlace<T extends GeometryObject>
export interface SCFloorTranslatableProperties extends SCThingTranslatableProperties {
/**
* Translation of the floor name
*
* @text
*/
floorName?: string;

View File

@@ -48,7 +48,6 @@ export interface SCMessageWithoutReferences
/**
* Roles for which the message is intended
*
* @filterable
*/
audiences: SCUserGroup[];
@@ -60,14 +59,12 @@ export interface SCMessageWithoutReferences
/**
* When the message was created
*
* @filterable
*/
dateCreated?: SCISO8601Date;
/**
* Message itself
*
* @text
*/
messageBody: string;
@@ -90,7 +87,6 @@ export interface SCMessageWithoutReferences
/**
* A message
*
* @validatable
* @indexable
*/
@@ -114,7 +110,6 @@ export interface SCMessageTranslatableProperties
SCThingThatCanBeOfferedTranslatableProperties {
/**
* Message itself
*
* @text
*/
messageBody?: string;

View File

@@ -29,7 +29,6 @@ export interface SCOrganizationWithoutReferences extends SCThingWithoutReference
/**
* An organization
*
* @validatable
* @indexable
*/

View File

@@ -52,7 +52,6 @@ export interface SCPeriodicalWithoutReferences
categories: SCPeriodicalCategories[];
/**
* A list of ISSNs of a periodical
*
* @filterable
* @keyword
*/
@@ -71,7 +70,6 @@ export interface SCPeriodicalWithoutReferences
/**
* A publication published at regular intervals (e.g. a magazine or newspaper)
*
* @validatable
* @indexable
*/

View File

@@ -27,7 +27,6 @@ import {SCRoomWithoutReferences} from './room.js';
export interface SCPersonWithoutReferences extends SCThingWithoutReferences {
/**
* Additional first names of the person.
*
* @filterable
* @keyword
*/
@@ -35,14 +34,12 @@ export interface SCPersonWithoutReferences extends SCThingWithoutReferences {
/**
* The birth date of the person.
*
* @filterable
*/
birthDate?: SCISO8601Date;
/**
* The private email address of the person.
*
* @TJS-format email
* @filterable
* @keyword
@@ -51,7 +48,6 @@ export interface SCPersonWithoutReferences extends SCThingWithoutReferences {
/**
* The family name of the person.
*
* @filterable
* @keyword
*/
@@ -59,7 +55,6 @@ export interface SCPersonWithoutReferences extends SCThingWithoutReferences {
/**
* The private fax number of the person.
*
* @filterable
* @keyword
*/
@@ -67,14 +62,12 @@ export interface SCPersonWithoutReferences extends SCThingWithoutReferences {
/**
* The gender of the person.
*
* @filterable
*/
gender?: SCPersonGender;
/**
* The first name of the person.
*
* @filterable
* @keyword
*/
@@ -82,7 +75,6 @@ export interface SCPersonWithoutReferences extends SCThingWithoutReferences {
/**
* Honorific prefix of the person.
*
* @filterable
* @keyword
*/
@@ -90,7 +82,6 @@ export interface SCPersonWithoutReferences extends SCThingWithoutReferences {
/**
* Honorific suffix of the person.
*
* @filterable
* @keyword
*/
@@ -98,7 +89,6 @@ export interface SCPersonWithoutReferences extends SCThingWithoutReferences {
/**
* Titles of jobs that the person has.
*
* @filterable
* @keyword
*/
@@ -106,7 +96,6 @@ export interface SCPersonWithoutReferences extends SCThingWithoutReferences {
/**
* The complete name of the person combining all the parts of the name into one.
*
* @filterable
* @text
*/
@@ -119,7 +108,6 @@ export interface SCPersonWithoutReferences extends SCThingWithoutReferences {
/**
* The private telephone number of the person.
*
* @keyword
*/
telephone?: string;
@@ -132,7 +120,6 @@ export interface SCPersonWithoutReferences extends SCThingWithoutReferences {
/**
* A person
*
* @validatable
* @indexable
*/

View File

@@ -46,7 +46,6 @@ export interface SCPointOfInterestWithoutReferences
/**
* A point of interest
*
* @validatable
* @indexable
*/

View File

@@ -43,7 +43,6 @@ export interface SCPublicationEventWithoutReferences extends SCEventWithoutRefer
/**
* An publication event
*
* @validatable
* @indexable
*/

View File

@@ -58,7 +58,6 @@ export interface SCRoomWithoutReferences
SCThingWithCategoriesWithoutReferences<SCRoomCategories, SCRoomSpecificValues> {
/**
* The name of the floor in which the room is in.
*
* @filterable
* @text
*/
@@ -84,7 +83,6 @@ export interface SCRoomWithoutReferences
/**
* A room
*
* @validatable
* @indexable
*/
@@ -113,14 +111,12 @@ export interface SCRoom
export interface SCRoomSpecificValues extends SCThingWithCategoriesSpecificValues {
/**
* Category specific opening hours of the room
*
* @keyword
*/
openingHours?: string;
/**
* Category specific service hours of the room (e.g. cooked food serving hours)
*
* @see http://wiki.openstreetmap.org/wiki/Key:opening_hours/specification
* @keyword
*/

View File

@@ -26,7 +26,6 @@ import {SCThingMeta, SCThingType} from './abstract/thing.js';
export interface SCSemesterWithoutReferences extends SCAcademicTermWithoutReferences {
/**
* The short name of the semester, using the given pattern.
*
* @filterable
* @pattern ^(WS|SS|WiSe|SoSe) [0-9]{4}(/[0-9]{2})?$
* @keyword
@@ -41,7 +40,6 @@ export interface SCSemesterWithoutReferences extends SCAcademicTermWithoutRefere
/**
* A semester
*
* @validatable
* @indexable
*/

View File

@@ -38,7 +38,6 @@ export interface SCSettingWithoutReferences
inputType: SCSettingInputType;
/**
* The order number this setting should show up in its category list
*
* @integer
*/
order: number;
@@ -78,7 +77,6 @@ export enum SCSettingInputType {
/**
* A setting with references
*
* @validatable
*/
export interface SCSetting
@@ -111,7 +109,6 @@ export type SCSettingValues = SCSettingValue[];
export interface SCSettingValueTranslatableProperties extends SCThingWithCategoriesTranslatableProperties {
/**
* The translations of the possible values of a setting
*
* @keyword
*/
values?: string[];

View File

@@ -28,7 +28,6 @@ export interface SCSportCourseWithoutReferences extends SCEventWithoutReferences
/**
* A sport course
*
* @validatable
* @indexable
*/

View File

@@ -32,7 +32,6 @@ import {SCPersonWithoutReferences} from './person.js';
export interface SCStudyModuleWithoutReferences extends SCThingThatCanBeOfferedWithoutReferences {
/**
* ECTS points (European Credit Transfer System)
*
* @float
*/
ects: number;
@@ -44,7 +43,6 @@ export interface SCStudyModuleWithoutReferences extends SCThingThatCanBeOfferedW
/**
* Majors that this study module is meant for
*
* @filterable
* @keyword
*/
@@ -68,7 +66,6 @@ export interface SCStudyModuleWithoutReferences extends SCThingThatCanBeOfferedW
/**
* A study module
*
* @validatable
* @indexable
*/
@@ -115,7 +112,6 @@ export interface SCStudyModule
export interface SCStudyModuleTranslatableProperties extends SCThingThatCanBeOfferedTranslatableProperties {
/**
* Translations of the majors that this study module is meant for
*
* @keyword
*/
majors?: string[];

View File

@@ -28,7 +28,6 @@ export interface SCTicketWithoutReferences extends SCThingWithoutReferences {
/**
* Waiting number of the ticket
*
* @keyword
*/
currentTicketNumber: string;
@@ -46,7 +45,6 @@ export interface SCTicketWithoutReferences extends SCThingWithoutReferences {
/**
* A ticket
*
* @validatable
* @indexable
*/

View File

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

View File

@@ -21,7 +21,6 @@ import {SCThing, SCThingMeta, SCThingType, SCThingWithoutReferences} from './abs
export interface SCTourWithoutReferences extends SCThingWithoutReferences {
/**
* Init script for the tour
*
* @text
*/
init?: string;
@@ -33,7 +32,6 @@ export interface SCTourWithoutReferences extends SCThingWithoutReferences {
/**
* Type of a tour
*
* @keyword
*/
type: SCThingType.Tour;
@@ -41,7 +39,6 @@ export interface SCTourWithoutReferences extends SCThingWithoutReferences {
/**
* A tour
*
* @validatable
* @indexable
*/
@@ -98,7 +95,6 @@ export type SCTourStep = SCTourStepMenu | SCTourStepLocation | SCTourStepTooltip
export interface SCTourStepLocation {
/**
* Location to go to
*
* @keyword
*/
location: string;
@@ -120,7 +116,6 @@ export interface SCTourStepTooltip {
/**
* Element that the tooltip shall be pointing at or a list of elements to try in the specified order
*
* @keyword
*/
element: string | string[];
@@ -137,14 +132,12 @@ export interface SCTourStepTooltip {
/**
* Text that the tooltip shall contain
*
* @text
*/
text: string;
/**
* How often it shall be retried
*
* @integer
*/
tries?: number;
@@ -181,7 +174,6 @@ export interface SCTourStepMenu {
export interface SCTourResolvedElement {
/**
* Element name
*
* @keyword
*/
element: string;
@@ -193,7 +185,6 @@ export interface SCTourResolvedElement {
export interface SCTourResolvedEvent {
/**
* Event name
*
* @keyword
*/
event: string;
@@ -215,7 +206,6 @@ export interface SCTourResolvedLocation {
export interface SCTourResolvedLocationTypeIs {
/**
* Specific location name
*
* @keyword
*/
is: string;
@@ -227,7 +217,6 @@ export interface SCTourResolvedLocationTypeIs {
export interface SCTourResolvedLocationTypeMatch {
/**
* Regex location name
*
* @keyword
*/
match: string;

View File

@@ -48,7 +48,6 @@ export interface SCVideoWithoutReferences
/**
* URLs to a thumbnails for the Video
*
* @keyword
*/
thumbnails?: string[];
@@ -60,7 +59,6 @@ export interface SCVideoWithoutReferences
/**
* A Transcript of the Video
*
* @text
*/
transcript?: string;
@@ -79,35 +77,30 @@ export interface SCVideoWithoutReferences
export interface SCVideoSource {
/**
* Pixel Height of the Video
*
* @integer
*/
height?: number;
/**
* MIME-Type of the source File
*
* @filterable
*/
mimeType: SCVideoMimeType;
/**
* Size of the Video File in bytes
*
* @integer
*/
size?: number;
/**
* URL to the Video File
*
* @keyword
*/
url: string;
/**
* Pixel Width of the Video
*
* @integer
*/
width?: number;
@@ -121,14 +114,12 @@ export interface SCVideoTrack {
/**
* Content Type of the Track File
*
* @filterable
*/
type: SCVideoTrackTypes;
/**
* URL to the Track File
*
* @keyword
*/
url: string;
@@ -136,7 +127,6 @@ export interface SCVideoTrack {
/**
* A video
*
* @validatable
* @indexable
*/