refactor: tidy structure of source files

Fixes #79

src/protocol/error.ts

@@ -0,0 +1,56 @@
+/*
+ * Copyright (C) 2019 StApps
+ * This program is free software: you can redistribute it and/or modify it
+ * under the terms of the GNU General Public License as published by the Free
+ * Software Foundation, version 3.
+ *
+ * This program is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
+ * more details.
+ *
+ * You should have received a copy of the GNU General Public License along with
+ * this program. If not, see <https://www.gnu.org/licenses/>.
+ */
+
+/**
+ * A generic error that can be returned by the backend if somethings fails during the processing of a request
+ *
+ * @validatable
+ */
+export interface SCErrorResponse extends Error {
+  /**
+   * Additional data that describes the error
+   */
+  additionalData?: unknown;
+
+  /**
+   * HTTP status code to return this error with
+   */
+  statusCode: number;
+}
+
+/**
+ * An error that can be created by the backend during the processing of a request
+ */
+export abstract class SCError implements SCErrorResponse {
+  /**
+   * Call stack of the error
+   */
+  stack?: string;
+
+  /**
+   * Instatiate an SCError
+   *
+   * @param name Name of the error
+   * @param message Message of the error
+   * @param statusCode  HTTP status code to return this error with
+   * @param stack Set to true if a stack trace should be created
+   */
+  constructor(public name: string, public message: string, public statusCode: number, stack = false) {
+    // generate stacktrace if needed
+    if (stack) {
+      this.stack = (new Error()).stack;
+    }
+  }
+}

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

@@ -0,0 +1,41 @@
+/*
+ * Copyright (C) 2019 StApps
+ * This program is free software: you can redistribute it and/or modify it
+ * under the terms of the GNU General Public License as published by the Free
+ * Software Foundation, version 3.
+ *
+ * This program is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
+ * more details.
+ *
+ * You should have received a copy of the GNU General Public License along with
+ * this program. If not, see <https://www.gnu.org/licenses/>.
+ */
+import {BAD_GATEWAY} from 'http-status-codes';
+import {SCError} from '../error';
+
+/**
+ * An error that is returned, when an internal server error occurred
+ */
+export class SCInternalServerErrorResponse extends SCError {
+  /**
+   * Internal error that occurred. If the stack is disabled this error is not set for security reasons
+   */
+  additionalData?: Error;
+
+  /**
+   * Create a SCInternalServerErrorResponse
+   *
+   * @param err Internal server error
+   * @param stack Set to true if a stack trace should be created
+   * and the internal server error should be displayed to the client
+   */
+  constructor(err?: Error, stack = false) {
+    super('InternalServerError', 'Internal server error', BAD_GATEWAY, stack);
+
+    if (stack) {
+      this.additionalData = err;
+    }
+  }
+}

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

@@ -0,0 +1,30 @@
+/*
+ * Copyright (C) 2019 StApps
+ * This program is free software: you can redistribute it and/or modify it
+ * under the terms of the GNU General Public License as published by the Free
+ * Software Foundation, version 3.
+ *
+ * This program is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
+ * more details.
+ *
+ * You should have received a copy of the GNU General Public License along with
+ * this program. If not, see <https://www.gnu.org/licenses/>.
+ */
+import {METHOD_NOT_ALLOWED} from 'http-status-codes';
+import {SCError} from '../error';
+
+/**
+ * An error that is returned, when the used HTTP method is not allowed on the requested route
+ */
+export class SCMethodNotAllowedErrorResponse extends SCError {
+  /**
+   * Create a SCMethodNotAllowedErrorResponse
+   *
+   * @param stack Set to true if a stack trace should be created
+   */
+  constructor(stack?: boolean) {
+    super('MethodNotAllowedError', 'HTTP method is not allowed on this route', METHOD_NOT_ALLOWED, stack);
+  }
+}

src/protocol/errors/not-found.ts

@@ -0,0 +1,30 @@
+/*
+ * Copyright (C) 2019 StApps
+ * This program is free software: you can redistribute it and/or modify it
+ * under the terms of the GNU General Public License as published by the Free
+ * Software Foundation, version 3.
+ *
+ * This program is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
+ * more details.
+ *
+ * You should have received a copy of the GNU General Public License along with
+ * this program. If not, see <https://www.gnu.org/licenses/>.
+ */
+import {NOT_FOUND} from 'http-status-codes';
+import {SCError} from '../error';
+
+/**
+ * An error that is returned when the requested route or resource was not found
+ */
+export class SCNotFoundErrorResponse extends SCError {
+  /**
+   * Create a SCNotFoundErrorResponse
+   *
+   * @param stack Set to true if a stack trace should be created
+   */
+  constructor(stack?: boolean) {
+    super('NotFoundError', 'Resource not found', NOT_FOUND, stack);
+  }
+}

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

@@ -0,0 +1,32 @@
+/*
+ * Copyright (C) 2019 StApps
+ * This program is free software: you can redistribute it and/or modify it
+ * under the terms of the GNU General Public License as published by the Free
+ * Software Foundation, version 3.
+ *
+ * This program is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
+ * more details.
+ *
+ * You should have received a copy of the GNU General Public License along with
+ * this program. If not, see <https://www.gnu.org/licenses/>.
+ */
+import {NOT_ACCEPTABLE} from 'http-status-codes';
+import {SCError} from '../error';
+
+/**
+ * An error that is returned when the request is in the right format, but contains parameters that are invalid or not
+ * acceptable.
+ */
+export class SCParametersNotAcceptable extends SCError {
+  /**
+   * Create a ParametersNotAcceptable
+   *
+   * @param message contains more details to what you did wrong
+   * @param stack Set to true if a stack trace should be created
+   */
+  constructor(message: string, stack?: boolean) {
+    super('ParametersNotAcceptable', message, NOT_ACCEPTABLE, stack);
+  }
+}

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

@@ -0,0 +1,44 @@
+/*
+ * Copyright (C) 2019 StApps
+ * This program is free software: you can redistribute it and/or modify it
+ * under the terms of the GNU General Public License as published by the Free
+ * Software Foundation, version 3.
+ *
+ * This program is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
+ * more details.
+ *
+ * You should have received a copy of the GNU General Public License along with
+ * this program. If not, see <https://www.gnu.org/licenses/>.
+ */
+import {CONFLICT} from 'http-status-codes';
+import {SCError} from '../error';
+import {SCPluginMetaData} from '../routes/plugin-register';
+
+/**
+ * An error that is returned when a plugin with the same name is already registered, to prevent two copies of a plugin
+ * running at the same time.
+ * This usually indicates that there is more than one instance a plugin running.
+ */
+export class SCPluginAlreadyRegisteredErrorResponse extends SCError {
+  /**
+   * Meta data of a registered plugin, which is in a conflict with the plugin we want to register.
+   * If the stack is disabled this is not set for security reasons
+   */
+  additionalData?: SCPluginMetaData;
+
+  /**
+   * Create a SCPluginAlreadyRegisteredError
+   *
+   * @param message Provide further information why an already registered plugin matches the one we want to register
+   * @param plugin Provides meta data of a registered plugin, which is in a conflict with the plugin we want to register
+   * @param stack Set to true if a stack trace should be created
+   */
+  constructor(message: string, plugin: SCPluginMetaData, stack = false) {
+    super('SCPluginAlreadyRegisteredError', message, CONFLICT, stack);
+    if (stack) {
+      this.additionalData = plugin;
+    }
+  }
+}

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

@@ -0,0 +1,31 @@
+/*
+ * Copyright (C) 2019 StApps
+ * This program is free software: you can redistribute it and/or modify it
+ * under the terms of the GNU General Public License as published by the Free
+ * Software Foundation, version 3.
+ *
+ * This program is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
+ * more details.
+ *
+ * You should have received a copy of the GNU General Public License along with
+ * this program. If not, see <https://www.gnu.org/licenses/>.
+ */
+import {INTERNAL_SERVER_ERROR} from 'http-status-codes';
+import {SCError} from '../error';
+
+/**
+ * An error that is returned whenever there is an unexpected error while creating a plugin
+ */
+export class SCPluginRegisteringFailedErrorResponse extends SCError {
+  /**
+   * Create a PluginRegisteringFailedError
+   *
+   * @param message Describes what went wrong wile registering the plugin
+   * @param stack Set to true if a stack trace should be created
+   */
+  constructor(message: string, stack?: boolean) {
+    super('PluginRegisteringFailedError', message, INTERNAL_SERVER_ERROR, stack);
+  }
+}

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

@@ -0,0 +1,30 @@
+/*
+ * Copyright (C) 2019 StApps
+ * This program is free software: you can redistribute it and/or modify it
+ * under the terms of the GNU General Public License as published by the Free
+ * Software Foundation, version 3.
+ *
+ * This program is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
+ * more details.
+ *
+ * You should have received a copy of the GNU General Public License along with
+ * this program. If not, see <https://www.gnu.org/licenses/>.
+ */
+import {REQUEST_TOO_LONG} from 'http-status-codes';
+import {SCError} from '../error';
+
+/**
+ * An error that is returned, when the request body is too large.
+ */
+export class SCRequestBodyTooLargeErrorResponse extends SCError {
+  /**
+   * Create a SCRequestBodyTooLargeErrorResponse
+   *
+   * @param stack Set to true if a stack trace should be created
+   */
+  constructor(stack?: boolean) {
+    super('RequestBodyTooLargeError', 'The request body is too large.', REQUEST_TOO_LONG, stack);
+  }
+}

src/protocol/errors/syntax-error.ts

@@ -0,0 +1,31 @@
+/*
+ * Copyright (C) 2019 StApps
+ * This program is free software: you can redistribute it and/or modify it
+ * under the terms of the GNU General Public License as published by the Free
+ * Software Foundation, version 3.
+ *
+ * This program is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
+ * more details.
+ *
+ * You should have received a copy of the GNU General Public License along with
+ * this program. If not, see <https://www.gnu.org/licenses/>.
+ */
+import {BAD_REQUEST} from 'http-status-codes';
+import {SCError} from '../error';
+
+/**
+ * An error that is returned whenever there is a syntax error
+ */
+export class SCSyntaxErrorResponse extends SCError {
+  /**
+   * Create a SyntaxError
+   *
+   * @param message Describes the syntax error
+   * @param stack Set to true if a stack trace should be created
+   */
+  constructor(message: string, stack?: boolean) {
+    super('SyntaxError', message, BAD_REQUEST, stack);
+  }
+}

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

@@ -0,0 +1,35 @@
+/*
+ * Copyright (C) 2019 StApps
+ * This program is free software: you can redistribute it and/or modify it
+ * under the terms of the GNU General Public License as published by the Free
+ * Software Foundation, version 3.
+ *
+ * This program is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
+ * more details.
+ *
+ * You should have received a copy of the GNU General Public License along with
+ * this program. If not, see <https://www.gnu.org/licenses/>.
+ */
+import {TOO_MANY_REQUESTS} from 'http-status-codes';
+import {SCError} from '../error';
+
+/**
+ * An error that is returned, when to many request are submitted at once
+ */
+export class SCTooManyRequestsErrorResponse extends SCError {
+  /**
+   * Create a SCTooManyRequestsErrorResponse
+   *
+   * @param stack Set to true if a stack trace should be created
+   */
+  constructor(stack?: boolean) {
+    super(
+      'TooManyRequestsError',
+      'Too many requests. You can not submit more than 5 queries an once',
+      TOO_MANY_REQUESTS,
+      stack,
+    );
+  }
+}

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

@@ -0,0 +1,30 @@
+/*
+ * Copyright (C) 2019 StApps
+ * This program is free software: you can redistribute it and/or modify it
+ * under the terms of the GNU General Public License as published by the Free
+ * Software Foundation, version 3.
+ *
+ * This program is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
+ * more details.
+ *
+ * You should have received a copy of the GNU General Public License along with
+ * this program. If not, see <https://www.gnu.org/licenses/>.
+ */
+import {UNSUPPORTED_MEDIA_TYPE} from 'http-status-codes';
+import {SCError} from '../error';
+
+/**
+ * An error that is returned when the content type of the request is not supported
+ */
+export class SCUnsupportedMediaTypeErrorResponse extends SCError {
+  /**
+   * Create a SCUnsupportedMediaTypeErrorResponse
+   *
+   * @param stack Set to true if a stack trace should be created
+   */
+  constructor(stack?: boolean) {
+    super('UnsupportedMediaTypeError', 'Unsupported media type', UNSUPPORTED_MEDIA_TYPE, stack);
+  }
+}

src/protocol/errors/validation.ts

@@ -0,0 +1,38 @@
+/*
+ * Copyright (C) 2019 StApps
+ * This program is free software: you can redistribute it and/or modify it
+ * under the terms of the GNU General Public License as published by the Free
+ * Software Foundation, version 3.
+ *
+ * This program is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
+ * more details.
+ *
+ * You should have received a copy of the GNU General Public License along with
+ * this program. If not, see <https://www.gnu.org/licenses/>.
+ */
+import {BAD_REQUEST} from 'http-status-codes';
+import {ValidationError} from 'jsonschema';
+import {SCError} from '../error';
+
+/**
+ * An error that is returned when the validation of a request fails
+ */
+export class SCValidationErrorResponse extends SCError {
+  /**
+   * List of validatation errors
+   */
+  additionalData: ValidationError[];
+
+  /**
+   * Create a SCValidationErrorResponse
+   *
+   * @param errors List of validation errors
+   * @param stack Set to true if a stack trace should be created
+   */
+  constructor(errors: ValidationError[], stack?: boolean) {
+    super('ValidationError', 'Validation of request failed', BAD_REQUEST, stack);
+    this.additionalData = errors;
+  }
+}

src/protocol/route.ts

@@ -0,0 +1,176 @@
+/*
+ * Copyright (C) 2019 StApps
+ * This program is free software: you can redistribute it and/or modify it
+ * under the terms of the GNU General Public License as published by the Free
+ * Software Foundation, version 3.
+ *
+ * This program is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
+ * more details.
+ *
+ * You should have received a copy of the GNU General Public License along with
+ * this program. If not, see <https://www.gnu.org/licenses/>.
+ */
+import {SCMap} from '../general/map';
+import {SCErrorResponse} from './error';
+import {SCIndexRequest, SCIndexResponse} from './routes';
+import {SCBookAvailabilityRequest, SCBookAvailabilityResponse} from './routes/book-availability';
+import {SCBulkAddRequest, SCBulkAddResponse} from './routes/bulk-add';
+import {SCBulkDoneRequest, SCBulkDoneResponse} from './routes/bulk-done';
+import {SCBulkRequest, SCBulkResponse} from './routes/bulk-request';
+import {SCFeedbackRequest, SCFeedbackResponse} from './routes/feedback';
+import {SCSearchRequest, SCSearchResponse} from './routes/search';
+import {SCMultiSearchRequest, SCMultiSearchResponse} from './routes/search-multi';
+import {SCThingUpdateRequest, SCThingUpdateResponse} from './routes/thing-update';
+
+/**
+ * Possible Verbs for HTTP requests
+ */
+export enum SCRouteHttpVerbs {
+  GET = 'GET',
+  POST = 'POST',
+  PUT = 'PUT',
+}
+
+/**
+ * The constructor of an error response
+ */
+// tslint:disable-next-line:no-any
+export type SCErrorResponseConstructor = new (...args: any[]) => SCErrorResponse;
+
+/**
+ * A description of a route
+ */
+export interface SCRoute {
+  /**
+   * A map of names of possible errors that can be returned by the route with their appropriate status codes
+   */
+  errorNames: SCErrorResponseConstructor[];
+
+  /**
+   * HTTP verb to use to request the route
+   */
+  method: SCRouteHttpVerbs;
+
+  /**
+   * Map of obligatory parameters and their type that have to be set via the requested path
+   */
+  obligatoryParameters?: SCMap<string>;
+
+  /**
+   * Name of the type of the request body
+   */
+  requestBodyName: string;
+
+  /**
+   * Name of the type of the response body
+   */
+  responseBodyName: string;
+
+  /**
+   * Status code for success
+   */
+  statusCodeSuccess: number;
+
+  /**
+   * URL fragment of the route
+   */
+  urlFragment: string;
+}
+
+/**
+ * An abstract route
+ */
+export abstract class SCAbstractRoute implements SCRoute {
+  /**
+   * @see SCRoute.errorNames
+   */
+  errorNames: SCErrorResponseConstructor[] = [];
+  /**
+   * @see SCRoute.method
+   */
+  method: SCRouteHttpVerbs = SCRouteHttpVerbs.GET;
+  /**
+   * @see SCRoute.obligatoryParameters
+   */
+  obligatoryParameters?: SCMap<string>;
+  /**
+   * @see SCRoute.requestBodyName
+   */
+  requestBodyName = 'any';
+  /**
+   * @see SCRoute.responseBodyName
+   */
+  responseBodyName = 'any';
+  /**
+   * @see SCRoute.statusCodeSuccess
+   */
+  statusCodeSuccess = 200;
+  /**
+   * @see SCRoute.urlFragment
+   */
+  urlFragment = '/';
+
+  /**
+   * Get "compiled" URL fragment
+   *
+   * @param parameters Parameters to compile URL fragment with
+   */
+  public getUrlFragment(parameters: SCMap<string> = {}): string {
+    let obligatoryParameters: string[] = [];
+
+    if (typeof this.obligatoryParameters === 'object') {
+      obligatoryParameters = Object.keys(this.obligatoryParameters);
+    }
+
+    if (Object.keys(parameters).length > obligatoryParameters.length) {
+      throw new Error('Extraneous parameters provided.');
+    }
+
+    return this.urlFragment
+      .split('/')
+      .map((part) => {
+        if (part.indexOf(':') !== 0) {
+          return part;
+        }
+
+        const parameter = part.substr(1);
+
+        if (typeof parameters[parameter] === 'undefined') {
+          throw new Error(`Parameter '${parameter}' not provided.`);
+        }
+
+        return parameters[parameter];
+      })
+      .join('/');
+  }
+}
+
+/**
+ * Possible requests
+ */
+export type SCRequests =
+  SCBookAvailabilityRequest
+  | SCBulkRequest
+  | SCBulkAddRequest
+  | SCBulkDoneRequest
+  | SCFeedbackRequest
+  | SCIndexRequest
+  | SCMultiSearchRequest
+  | SCSearchRequest
+  | SCThingUpdateRequest;
+
+/**
+ * Possible responses
+ */
+export type SCResponses =
+  SCBookAvailabilityResponse
+  | SCBulkResponse
+  | SCBulkAddResponse
+  | SCBulkDoneResponse
+  | SCFeedbackResponse
+  | SCIndexResponse
+  | SCMultiSearchResponse
+  | SCSearchResponse
+  | SCThingUpdateResponse;

src/protocol/routes/book-availability.ts

@@ -0,0 +1,94 @@
+/*
+ * 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 {OK} from 'http-status-codes';
+import {SCUuid} from '../../general/uuid';
+import {SCAcademicPriceGroup, SCThingThatCanBeOfferedOffer} from '../../things/abstract/thing-that-can-be-offered';
+import {SCInternalServerErrorResponse} from '../errors/internal-server-error';
+import {SCMethodNotAllowedErrorResponse} from '../errors/method-not-allowed';
+import {SCNotFoundErrorResponse} from '../errors/not-found';
+import {SCRequestBodyTooLargeErrorResponse} from '../errors/request-body-too-large';
+import {SCSyntaxErrorResponse} from '../errors/syntax-error';
+import {SCUnsupportedMediaTypeErrorResponse} from '../errors/unsupported-media-type';
+import {SCValidationErrorResponse} from '../errors/validation';
+import {SCAbstractRoute, SCRouteHttpVerbs} from '../route';
+
+/**
+ * Request to check the availability of books
+ *
+ * @validatable
+ */
+export type SCBookAvailabilityRequest = SCBookAvailabilityRequestByIsbn | SCBookAvailabilityRequestByUuid;
+
+/**
+ * Availability request by ISBN
+ */
+export interface SCBookAvailabilityRequestByIsbn {
+  /**
+   * ISBN of the book to check availability for
+   */
+  isbn: string;
+}
+
+/**
+ * Availability request by UUID
+ */
+export interface SCBookAvailabilityRequestByUuid {
+  /**
+   * UID of the book to check availability for
+   */
+  uid: SCUuid;
+}
+
+/**
+ * List of availabilities of a book
+ *
+ * @validatable
+ */
+export type SCBookAvailabilityResponse = Array<SCThingThatCanBeOfferedOffer<SCAcademicPriceGroup>>;
+
+/**
+ * Route for book availability
+ *
+ * This checks if a book is available in a library.
+ *
+ * **Example**:
+ *
+ * `POST https://example.com/bookAvailability`
+ *
+ * ```json
+ * {
+ *   "isbn": "978-3-16-148410-0"
+ * }
+ * ```
+ */
+export class SCBookAvailabilityRoute extends SCAbstractRoute {
+  constructor() {
+    super();
+    this.errorNames = [
+      SCInternalServerErrorResponse,
+      SCMethodNotAllowedErrorResponse,
+      SCNotFoundErrorResponse,
+      SCRequestBodyTooLargeErrorResponse,
+      SCSyntaxErrorResponse,
+      SCUnsupportedMediaTypeErrorResponse,
+      SCValidationErrorResponse,
+    ];
+    this.method = SCRouteHttpVerbs.POST;
+    this.requestBodyName = 'SCBookAvailabilityRequest';
+    this.responseBodyName = 'SCBookAvailabilityResponse';
+    this.statusCodeSuccess = OK;
+    this.urlFragment = '/bookAvailability';
+  }
+}

src/protocol/routes/bulk-add.ts

@@ -0,0 +1,65 @@
+/*
+ * 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 {CREATED} from 'http-status-codes';
+import {SCThings} from '../../meta';
+import {SCInternalServerErrorResponse} from '../errors/internal-server-error';
+import {SCMethodNotAllowedErrorResponse} from '../errors/method-not-allowed';
+import {SCNotFoundErrorResponse} from '../errors/not-found';
+import {SCRequestBodyTooLargeErrorResponse} from '../errors/request-body-too-large';
+import {SCSyntaxErrorResponse} from '../errors/syntax-error';
+import {SCUnsupportedMediaTypeErrorResponse} from '../errors/unsupported-media-type';
+import {SCValidationErrorResponse} from '../errors/validation';
+import {SCAbstractRoute, SCRouteHttpVerbs} from '../route';
+
+/**
+ * Request to add a thing to a bulk
+ *
+ * @validatable
+ */
+export type SCBulkAddRequest = SCThings;
+
+/**
+ * Response to a request to add a thing to a bulk
+ *
+ * @validatable
+ */
+export interface SCBulkAddResponse {
+}
+
+/**
+ * Route for indexing SC things in a bulk
+ */
+export class SCBulkAddRoute extends SCAbstractRoute {
+  constructor() {
+    super();
+    this.errorNames = [
+      SCInternalServerErrorResponse,
+      SCMethodNotAllowedErrorResponse,
+      SCNotFoundErrorResponse,
+      SCRequestBodyTooLargeErrorResponse,
+      SCSyntaxErrorResponse,
+      SCUnsupportedMediaTypeErrorResponse,
+      SCValidationErrorResponse,
+    ];
+    this.method = SCRouteHttpVerbs.POST;
+    this.obligatoryParameters = {
+      UID: 'SCUuid',
+    };
+    this.requestBodyName = 'SCBulkAddRequest';
+    this.responseBodyName = 'SCBulkAddResponse';
+    this.statusCodeSuccess = CREATED;
+    this.urlFragment = '/bulk/:UID';
+  }
+}

src/protocol/routes/bulk-done.ts

@@ -0,0 +1,65 @@
+/*
+ * 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 {NO_CONTENT} from 'http-status-codes';
+import {SCInternalServerErrorResponse} from '../errors/internal-server-error';
+import {SCMethodNotAllowedErrorResponse} from '../errors/method-not-allowed';
+import {SCNotFoundErrorResponse} from '../errors/not-found';
+import {SCRequestBodyTooLargeErrorResponse} from '../errors/request-body-too-large';
+import {SCSyntaxErrorResponse} from '../errors/syntax-error';
+import {SCUnsupportedMediaTypeErrorResponse} from '../errors/unsupported-media-type';
+import {SCValidationErrorResponse} from '../errors/validation';
+import {SCAbstractRoute, SCRouteHttpVerbs} from '../route';
+
+/**
+ * Request to change the bulk state to done (close the bulk process)
+ *
+ * @validatable
+ */
+export interface SCBulkDoneRequest {
+}
+
+/**
+ * Response to a request to change the state of a bulk to done
+ *
+ * @validatable
+ */
+export interface SCBulkDoneResponse {
+}
+
+/**
+ * Route for closing bulks
+ */
+export class SCBulkDoneRoute extends SCAbstractRoute {
+  constructor() {
+    super();
+    this.errorNames = [
+      SCInternalServerErrorResponse,
+      SCMethodNotAllowedErrorResponse,
+      SCNotFoundErrorResponse,
+      SCRequestBodyTooLargeErrorResponse,
+      SCSyntaxErrorResponse,
+      SCUnsupportedMediaTypeErrorResponse,
+      SCValidationErrorResponse,
+    ];
+    this.method = SCRouteHttpVerbs.POST;
+    this.obligatoryParameters = {
+      UID: 'SCUuid',
+    };
+    this.requestBodyName = 'SCBulkDoneRequest';
+    this.responseBodyName = 'SCBulkDoneResponse';
+    this.statusCodeSuccess = NO_CONTENT;
+    this.urlFragment = '/bulk/:UID/done';
+  }
+}

src/protocol/routes/bulk-request.ts

@@ -0,0 +1,104 @@
+/*
+ * 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 {OK} from 'http-status-codes';
+import {SCISO8601Date} from '../../general/time';
+import {SCUuid} from '../../general/uuid';
+import {SCThingType} from '../../things/abstract/thing';
+import {SCInternalServerErrorResponse} from '../errors/internal-server-error';
+import {SCMethodNotAllowedErrorResponse} from '../errors/method-not-allowed';
+import {SCRequestBodyTooLargeErrorResponse} from '../errors/request-body-too-large';
+import {SCSyntaxErrorResponse} from '../errors/syntax-error';
+import {SCUnsupportedMediaTypeErrorResponse} from '../errors/unsupported-media-type';
+import {SCValidationErrorResponse} from '../errors/validation';
+import {SCAbstractRoute, SCRouteHttpVerbs} from '../route';
+
+/**
+ * A bulk request
+ *
+ * Parameters to be sent to request a new bulk.
+ *
+ * @validatable
+ */
+export interface SCBulkRequest extends SCBulkParameters {
+}
+
+/**
+ * Parameters for a bulk
+ */
+export interface SCBulkParameters {
+  /**
+   * Expiration of bulk
+   *
+   * If the date is hit and the bulk is not done, it will be deleted and all data removed.
+   * Defaults to one hour.
+   */
+  expiration?: SCISO8601Date;
+
+  /**
+   * Source of data for this bulk
+   *
+   * A short "description" of the source of the data to identify it inside the database.
+   * A second bulk with the same source overrides the data of the first bulk once it is done.
+   */
+  source: string;
+
+  /**
+   * Type of things that are indexed in this bulk.
+   *
+   */
+  type: SCThingType;
+}
+
+/**
+ * Requested Bulk from backend
+ *
+ * @validatable
+ */
+export interface SCBulkResponse extends SCBulkParameters {
+  /**
+   * State of bulk
+   *
+   * The state is `in progress` while it accepts things to be added to the bulk.
+   * The state is `done` once it is closed.
+   */
+  state: 'in progress' | 'done';
+
+  /**
+   * Universally unique identifier of the bulk
+   */
+  uid: SCUuid;
+}
+
+/**
+ * Route for bulk creation
+ */
+export class SCBulkRoute extends SCAbstractRoute {
+  constructor() {
+    super();
+    this.errorNames = [
+      SCInternalServerErrorResponse,
+      SCMethodNotAllowedErrorResponse,
+      SCRequestBodyTooLargeErrorResponse,
+      SCSyntaxErrorResponse,
+      SCUnsupportedMediaTypeErrorResponse,
+      SCValidationErrorResponse,
+    ];
+    this.method = SCRouteHttpVerbs.POST;
+    this.requestBodyName = 'SCBulkRequest';
+    this.responseBodyName = 'SCBulkResponse';
+    this.statusCodeSuccess = OK;
+    this.urlFragment = '/bulk';
+  }
+}

src/protocol/routes/feedback.ts

@@ -0,0 +1,105 @@
+/*
+ * 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 {NO_CONTENT} from 'http-status-codes';
+import {SCMessage} from '../../things/message';
+import {SCInternalServerErrorResponse} from '../errors/internal-server-error';
+import {SCMethodNotAllowedErrorResponse} from '../errors/method-not-allowed';
+import {SCRequestBodyTooLargeErrorResponse} from '../errors/request-body-too-large';
+import {SCSyntaxErrorResponse} from '../errors/syntax-error';
+import {SCUnsupportedMediaTypeErrorResponse} from '../errors/unsupported-media-type';
+import {SCValidationErrorResponse} from '../errors/validation';
+import {SCAbstractRoute, SCRouteHttpVerbs} from '../route';
+
+/**
+ * User feedback
+ *
+ * @validatable
+ */
+export interface SCFeedbackRequest extends SCMessage {
+  /**
+   * Meta data that helps to understand the feedback
+   */
+  metaData: SCFeedbackRequestMetaData;
+}
+
+/**
+ * A response to a feedback request
+ *
+ * @validatable
+ */
+export interface SCFeedbackResponse {
+}
+
+/**
+ * Route for feedback submission
+ */
+export class SCFeedbackRoute extends SCAbstractRoute {
+  constructor() {
+    super();
+    this.errorNames = [
+      SCInternalServerErrorResponse,
+      SCMethodNotAllowedErrorResponse,
+      SCRequestBodyTooLargeErrorResponse,
+      SCSyntaxErrorResponse,
+      SCUnsupportedMediaTypeErrorResponse,
+      SCValidationErrorResponse,
+    ];
+    this.method = SCRouteHttpVerbs.POST;
+    this.requestBodyName = 'SCFeedbackRequest';
+    this.responseBodyName = 'SCFeedbackResponse';
+    this.statusCodeSuccess = NO_CONTENT;
+    this.urlFragment = '/feedback';
+  }
+}
+
+/**
+ * Request Meta Data
+ */
+export interface SCFeedbackRequestMetaData {
+  /**
+   * Whether or not the user enabled the debug mode
+   */
+  debug?: boolean;
+
+  /**
+   * Platform identifier
+   */
+  platform: string;
+
+  /**
+   * Scope/app state at feedback invocation
+   */
+  scope: unknown;
+
+  /**
+   * Whether or not the feedback is sendable
+   */
+  sendable?: boolean;
+
+  /**
+   * App state that feedback was invoked from
+   */
+  state: unknown;
+
+  /**
+   * User agent
+   */
+  userAgent: string;
+
+  /**
+   * StApps version string
+   */
+  version: string;
+}

src/protocol/routes/index.ts

@@ -0,0 +1,71 @@
+/*
+ * 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 {OK} from 'http-status-codes';
+import {SCAppConfiguration} from '../../config/app';
+import {SCBackendConfiguration} from '../../config/backend';
+import {SCInternalServerErrorResponse} from '../errors/internal-server-error';
+import {SCMethodNotAllowedErrorResponse} from '../errors/method-not-allowed';
+import {SCRequestBodyTooLargeErrorResponse} from '../errors/request-body-too-large';
+import {SCSyntaxErrorResponse} from '../errors/syntax-error';
+import {SCUnsupportedMediaTypeErrorResponse} from '../errors/unsupported-media-type';
+import {SCValidationErrorResponse} from '../errors/validation';
+import {SCAbstractRoute, SCRouteHttpVerbs} from '../route';
+
+/**
+ * Index request
+ *
+ * @validatable
+ */
+export interface SCIndexRequest {
+}
+
+/**
+ * A response to an index request
+ *
+ * @validatable
+ */
+export interface SCIndexResponse {
+  /**
+   * @see SCAppConfiguration
+   */
+  app: SCAppConfiguration;
+
+  /**
+   * @see SCBackendConfiguration
+   */
+  backend: SCBackendConfiguration;
+}
+
+/**
+ * Route to request meta information about the deployment
+ */
+export class SCIndexRoute extends SCAbstractRoute {
+  constructor() {
+    super();
+    this.errorNames = [
+      SCInternalServerErrorResponse,
+      SCMethodNotAllowedErrorResponse,
+      SCRequestBodyTooLargeErrorResponse,
+      SCSyntaxErrorResponse,
+      SCUnsupportedMediaTypeErrorResponse,
+      SCValidationErrorResponse,
+    ];
+    this.method = SCRouteHttpVerbs.POST;
+    this.requestBodyName = 'SCIndexRequest';
+    this.responseBodyName = 'SCIndexResponse';
+    this.statusCodeSuccess = OK;
+    this.urlFragment = '/';
+  }
+}

src/protocol/routes/plugin-register.ts

@@ -0,0 +1,126 @@
+/*
+ * Copyright (C) 2019 StApps
+ * This program is free software: you can redistribute it and/or modify it
+ * under the terms of the GNU General Public License as published by the Free
+ * Software Foundation, version 3.
+ *
+ * This program is distributed in the hope that it will be useful, but WITHOUT
+ * 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 {OK} from 'http-status-codes';
+import {Schema} from 'jsonschema';
+import {SCInternalServerErrorResponse} from '../errors/internal-server-error';
+import {SCMethodNotAllowedErrorResponse} from '../errors/method-not-allowed';
+import {SCParametersNotAcceptable} from '../errors/parameters-not-acceptable';
+import {SCPluginAlreadyRegisteredErrorResponse} from '../errors/plugin-already-registered';
+import {SCPluginRegisteringFailedErrorResponse} from '../errors/plugin-registering-failed';
+import {SCRequestBodyTooLargeErrorResponse} from '../errors/request-body-too-large';
+import {SCSyntaxErrorResponse} from '../errors/syntax-error';
+import {SCAbstractRoute, SCRouteHttpVerbs} from '../route';
+
+/**
+ * Plugin register request
+ *
+ * @validatable
+ */
+export type SCPluginRegisterRequest = SCPluginAdd | SCPluginRemove;
+
+/**
+ * Plugin request for adding a plugin registration to the backend
+ */
+export interface SCPluginAdd {
+  /**
+   * The desired action, so whether the plugin should be added or removed
+   */
+  action: 'add';
+
+  /**
+   * Plugin information needed for its registration
+   */
+  plugin: SCPluginMetaData;
+}
+
+/**
+ * Plugin request for removing a plugin registration from the backend
+ */
+export interface SCPluginRemove {
+  /**
+   * The desired action, so whether the plugin should be added or removed
+   */
+  action: 'remove';
+
+  /**
+   * The route of the plugin you want to remove
+   */
+  route: string;
+}
+
+/**
+ * Plugin meta data - contains needed information for a plugin registration
+ */
+export interface SCPluginMetaData {
+  /**
+   * The address of the plugin, to which the backend routes the requests
+   */
+  address: string;
+
+  /**
+   * The name of the plugin (for debugging purposes, to more easily identify conflicts)
+   */
+  name: string;
+
+  /**
+   * How the requests of the plugin looks like, a JSON schema for validation
+   */
+  requestSchema: Schema;
+
+  /**
+   * How the responses of the plugin looks like, a JSON schema for validation
+   */
+  responseSchema: Schema;
+
+  /**
+   * The desired route, for example /feedback.
+   */
+  route: string;
+}
+
+/**
+ * Plugin register response
+ *
+ * @validatable
+ */
+export interface SCPluginRegisterResponse {
+  /**
+   * Whether the desired action succeeded or failed (true for success, false if an error occurred)
+   */
+  success: boolean;
+}
+
+/**
+ * Route to register plugins
+ */
+export class SCPluginRegisterRoute extends SCAbstractRoute {
+  constructor() {
+    super();
+    this.errorNames = [
+      SCInternalServerErrorResponse,
+      SCMethodNotAllowedErrorResponse,
+      SCParametersNotAcceptable,
+      SCPluginAlreadyRegisteredErrorResponse,
+      SCPluginRegisteringFailedErrorResponse,
+      SCRequestBodyTooLargeErrorResponse,
+      SCSyntaxErrorResponse,
+    ];
+    this.method = SCRouteHttpVerbs.POST;
+    this.requestBodyName = 'SCPluginRegisterRequest';
+    this.responseBodyName = 'SCPluginRegisterResponse';
+    this.statusCodeSuccess = OK;
+    this.urlFragment = '/plugin/register';
+  }
+}

src/protocol/routes/search-multi.ts

@@ -0,0 +1,69 @@
+/*
+ * 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 {OK} from 'http-status-codes';
+import {SCMap} from '../../general/map';
+import {SCInternalServerErrorResponse} from '../errors/internal-server-error';
+import {SCMethodNotAllowedErrorResponse} from '../errors/method-not-allowed';
+import {SCRequestBodyTooLargeErrorResponse} from '../errors/request-body-too-large';
+import {SCSyntaxErrorResponse} from '../errors/syntax-error';
+import {SCTooManyRequestsErrorResponse} from '../errors/too-many-requests';
+import {SCUnsupportedMediaTypeErrorResponse} from '../errors/unsupported-media-type';
+import {SCValidationErrorResponse} from '../errors/validation';
+import {SCAbstractRoute, SCRouteHttpVerbs} from '../route';
+import {SCSearchQuery} from '../search/query';
+import {SCSearchResult} from '../search/result';
+
+/**
+ * A multi search request
+ *
+ * This is a map of [[SCSearchRequest]]s indexed by name.
+ *
+ * **CAUTION: This is limited to an amount of queries. Currently this limit is 5.**
+ *
+ * @validatable
+ */
+export type SCMultiSearchRequest = SCMap<SCSearchQuery>;
+
+/**
+ * A multi search response
+ *
+ * This is a map of [[SCSearchResponse]]s indexed by name
+ *
+ * @validatable
+ */
+export type SCMultiSearchResponse = SCMap<SCSearchResult>;
+
+/**
+ * Route for submission of multiple search requests at once
+ */
+export class SCMultiSearchRoute extends SCAbstractRoute {
+  constructor() {
+    super();
+    this.errorNames = [
+      SCInternalServerErrorResponse,
+      SCMethodNotAllowedErrorResponse,
+      SCRequestBodyTooLargeErrorResponse,
+      SCSyntaxErrorResponse,
+      SCTooManyRequestsErrorResponse,
+      SCUnsupportedMediaTypeErrorResponse,
+      SCValidationErrorResponse,
+    ];
+    this.method = SCRouteHttpVerbs.POST;
+    this.requestBodyName = 'SCMultiSearchRequest';
+    this.responseBodyName = 'SCMultiSearchResponse';
+    this.statusCodeSuccess = OK;
+    this.urlFragment = '/search/multi';
+  }
+}

src/protocol/routes/search.ts

@@ -0,0 +1,62 @@
+/*
+ * 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 {OK} from 'http-status-codes';
+import {SCInternalServerErrorResponse} from '../errors/internal-server-error';
+import {SCMethodNotAllowedErrorResponse} from '../errors/method-not-allowed';
+import {SCRequestBodyTooLargeErrorResponse} from '../errors/request-body-too-large';
+import {SCSyntaxErrorResponse} from '../errors/syntax-error';
+import {SCUnsupportedMediaTypeErrorResponse} from '../errors/unsupported-media-type';
+import {SCValidationErrorResponse} from '../errors/validation';
+import {SCAbstractRoute, SCRouteHttpVerbs} from '../route';
+import {SCSearchQuery} from '../search/query';
+import {SCSearchResult} from '../search/result';
+
+/**
+ * A search request
+ *
+ * @validatable
+ */
+export interface SCSearchRequest extends SCSearchQuery {
+}
+
+/**
+ * A search response
+ *
+ * @validatable
+ */
+export interface SCSearchResponse extends SCSearchResult {
+}
+
+/**
+ * Route for searching things
+ */
+export class SCSearchRoute extends SCAbstractRoute {
+  constructor() {
+    super();
+    this.errorNames = [
+      SCInternalServerErrorResponse,
+      SCMethodNotAllowedErrorResponse,
+      SCRequestBodyTooLargeErrorResponse,
+      SCSyntaxErrorResponse,
+      SCUnsupportedMediaTypeErrorResponse,
+      SCValidationErrorResponse,
+    ];
+    this.method = SCRouteHttpVerbs.POST;
+    this.requestBodyName = 'SCSearchRequest';
+    this.responseBodyName = 'SCSearchResponse';
+    this.statusCodeSuccess = OK;
+    this.urlFragment = '/search';
+  }
+}

src/protocol/routes/thing-update.ts

@@ -0,0 +1,66 @@
+/*
+ * 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 {OK} from 'http-status-codes';
+import {SCThings} from '../../meta';
+import {SCInternalServerErrorResponse} from '../errors/internal-server-error';
+import {SCMethodNotAllowedErrorResponse} from '../errors/method-not-allowed';
+import {SCNotFoundErrorResponse} from '../errors/not-found';
+import {SCRequestBodyTooLargeErrorResponse} from '../errors/request-body-too-large';
+import {SCSyntaxErrorResponse} from '../errors/syntax-error';
+import {SCUnsupportedMediaTypeErrorResponse} from '../errors/unsupported-media-type';
+import {SCValidationErrorResponse} from '../errors/validation';
+import {SCAbstractRoute, SCRouteHttpVerbs} from '../route';
+
+/**
+ * Request to update an existing thing
+ *
+ * @validatable
+ */
+export type SCThingUpdateRequest = SCThings;
+
+/**
+ * Response for an entity update request
+ *
+ * @validatable
+ */
+export interface SCThingUpdateResponse {
+}
+
+/**
+ * Route for updating existing things
+ */
+export class SCThingUpdateRoute extends SCAbstractRoute {
+  constructor() {
+    super();
+    this.errorNames = [
+      SCInternalServerErrorResponse,
+      SCMethodNotAllowedErrorResponse,
+      SCNotFoundErrorResponse,
+      SCRequestBodyTooLargeErrorResponse,
+      SCSyntaxErrorResponse,
+      SCUnsupportedMediaTypeErrorResponse,
+      SCValidationErrorResponse,
+    ];
+    this.method = SCRouteHttpVerbs.PUT;
+    this.obligatoryParameters = {
+      TYPE: 'SCThingTypes',
+      UID: 'SCUuid',
+    };
+    this.requestBodyName = 'SCThingUpdateRequest';
+    this.responseBodyName = 'SCThingUpdateResponse';
+    this.statusCodeSuccess = OK;
+    this.urlFragment = '/:TYPE/:UID';
+  }
+}

src/protocol/search/facet.ts

@@ -0,0 +1,45 @@
+/*
+ * 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 {SCThingsField} from '../../meta';
+
+/**
+ * A search facet
+ */
+export interface SCFacet {
+  /**
+   * Buckets for the aggregation
+   */
+  buckets: SCFacetBucket[];
+
+  /**
+   * Field of the aggregation
+   */
+  field: SCThingsField;
+}
+
+/**
+ * A bucket of a facet
+ */
+export interface SCFacetBucket {
+  /**
+   * Count of matching search results
+   */
+  count: number;
+
+  /**
+   * Key of a bucket
+   */
+  key: string;
+}

src/protocol/search/filter.ts

@@ -0,0 +1,60 @@
+/*
+ * Copyright (C) 2019 StApps
+ * This program is free software: you can redistribute it and/or modify it
+ * under the terms of the GNU General Public License as published by the Free
+ * Software Foundation, version 3.
+ *
+ * This program is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
+ * more details.
+ *
+ * You should have received a copy of the GNU General Public License along with
+ * this program. If not, see <https://www.gnu.org/licenses/>.
+ */
+import {SCMap} from '../../general/map';
+/**
+ * All available filter types
+ */
+import {SCSearchAvailabilityFilter} from './filters/availability';
+import {SCSearchBooleanFilter} from './filters/boolean';
+import {SCSearchDistanceFilter} from './filters/distance';
+import {SCSearchValueFilter} from './filters/value';
+
+/**
+ * Filter instruction types
+ */
+export type SCSearchFilterType =
+  'availability'
+  | 'boolean'
+  | 'distance'
+  | 'value';
+
+/**
+ * Structure of a filter instruction
+ */
+export interface SCSearchAbstractFilter<T extends SCSearchAbstractFilterArguments> {
+  /**
+   * Arguments of filter
+   */
+  arguments: T;
+
+  /**
+   * Type of filter
+   */
+  type: SCSearchFilterType;
+}
+
+/**
+ * Arguments for the filter instruction
+ */
+export type SCSearchAbstractFilterArguments = SCMap<unknown>;
+
+/**
+ * Available filter instructions
+ */
+export type SCSearchFilter =
+  SCSearchAvailabilityFilter
+  | SCSearchBooleanFilter
+  | SCSearchDistanceFilter
+  | SCSearchValueFilter;

src/protocol/search/filters/availability.ts

@@ -0,0 +1,49 @@
+/*
+ * 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 {SCISO8601Date} from '../../../general/time';
+import {SCThingsField} from '../../../meta';
+import {SCSearchAbstractFilter, SCSearchAbstractFilterArguments} from '../filter';
+
+/**
+ * An availability filter
+ *
+ * Filter for documents where it cannot be safely determined that they are not available
+ */
+export interface SCSearchAvailabilityFilter extends SCSearchAbstractFilter<SCAvailabilityFilterArguments> {
+  /**
+   * @see SCSearchAbstractFilter.type
+   */
+  type: 'availability';
+}
+
+/**
+ * Arguments for filter instruction by availability
+ */
+export interface SCAvailabilityFilterArguments extends SCSearchAbstractFilterArguments {
+  /**
+   * Field which marks the start of the availability
+   */
+  fromField: SCThingsField;
+
+  /**
+   * Time to check. Defaults to 'now'
+   */
+  time?: SCISO8601Date | 'now';
+
+  /**
+   * Field which marks the end of the availability
+   */
+  toField: SCThingsField;
+}

src/protocol/search/filters/boolean.ts

@@ -0,0 +1,42 @@
+/*
+ * 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 {SCSearchAbstractFilter, SCSearchAbstractFilterArguments, SCSearchFilter} from '../filter';
+
+/**
+ * A boolean filter
+ *
+ * This filter can be used to combine multiple filters with boolean operations.
+ */
+export interface SCSearchBooleanFilter extends SCSearchAbstractFilter<SCBooleanFilterArguments> {
+  /**
+   * @see SCSearchAbstractFilter.type
+   */
+  type: 'boolean';
+}
+
+/**
+ * Additional arguments for boolean filters
+ */
+export interface SCBooleanFilterArguments extends SCSearchAbstractFilterArguments {
+  /**
+   * A list of filter to apply the boolean operation to
+   */
+  filters: SCSearchFilter[];
+
+  /**
+   * Boolean operation to apply to the filters
+   */
+  operation: 'and' | 'not' | 'or';
+}

src/protocol/search/filters/distance.ts

@@ -0,0 +1,50 @@
+/*
+ * 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/>.
+ */
+// tslint:disable-next-line:no-implicit-dependencies
+import {Position} from 'geojson';
+import {SCThingsField} from '../../../meta';
+import {SCSearchAbstractFilter, SCSearchAbstractFilterArguments} from '../filter';
+
+/**
+ * A distance filter
+ *
+ * Filter for documents that are in the given distance of the given location
+ */
+export interface SCSearchDistanceFilter extends SCSearchAbstractFilter<SCSearchAbstractFilterArguments> {
+  /**
+   * @see SCSearchAbstractFilter.type
+   */
+  type: 'distance';
+}
+
+/**
+ * Additional arguments for distance filters
+ */
+export interface SCDistanceFilterArguments extends SCSearchAbstractFilterArguments {
+  /**
+   * Distance in meters to filter from given location
+   */
+  distance: number;
+
+  /**
+   * Field which contains the location you want to filter
+   */
+  field: SCThingsField;
+
+  /**
+   * Position to calculate the distance to
+   */
+  position: Position;
+}

src/protocol/search/filters/value.ts

@@ -0,0 +1,38 @@
+/*
+ * Copyright (C)  2019 StApps
+ * This program is free software: you can redistribute it and/or modify it
+ * under the terms of the GNU General Public License as published by the Free
+ * Software Foundation, version 3.
+ *
+ * This program is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
+ * more details.
+ *
+ * You should have received a copy of the GNU General Public License along with
+ * this program. If not, see <https://www.gnu.org/licenses/>.
+ */
+import {SCThingsField} from '../../../meta';
+import {SCSearchAbstractFilter, SCSearchAbstractFilterArguments} from '../filter';
+
+/**
+ * Filters for documents that match the value on the given field
+ */
+export interface SCSearchValueFilter extends SCSearchAbstractFilter<SCValueFilterArguments> {
+  /**
+   * @see SCSearchAbstractFilter.type
+   */
+  type: 'value';
+}
+
+export interface SCValueFilterArguments extends SCSearchAbstractFilterArguments {
+  /**
+   * Field to filter for a value.
+   */
+  field: SCThingsField;
+
+  /**
+   * Value to filter. Value has to match the field exactly.
+   */
+  value: string;
+}

src/protocol/search/query.ts

@@ -0,0 +1,52 @@
+/*
+ * Copyright (C) 2019 StApps
+ * This program is free software: you can redistribute it and/or modify it
+ * under the terms of the GNU General Public License as published by the Free
+ * Software Foundation, version 3.
+ *
+ * This program is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
+ * more details.
+ *
+ * You should have received a copy of the GNU General Public License along with
+ * this program. If not, see <https://www.gnu.org/licenses/>.
+ */
+import {SCSearchContext} from '../../config/backend';
+import {SCSearchFilter} from './filter';
+import {SCSearchSort} from './sort';
+
+/**
+ * A search query
+ */
+export interface SCSearchQuery {
+  /**
+   * The context name from where the search query was initiated
+   */
+  context?: SCSearchContext;
+
+  /**
+   * A filter structure that combines any number of filters with boolean methods ('AND', 'OR', 'NOT')
+   */
+  filter?: SCSearchFilter;
+
+  /**
+   * Number of things to skip in result set (paging)
+   */
+  from?: number;
+
+  /**
+   * A term to search for
+   */
+  query?: string;
+
+  /**
+   * Number of things to have in the result set (paging)
+   */
+  size?: number;
+
+  /**
+   * A list of sorting parameters to order the result set by
+   */
+  sort?: SCSearchSort[];
+}

src/protocol/search/result.ts

@@ -0,0 +1,71 @@
+/*
+ * 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 {SCThings} from '../../meta';
+import {SCFacet} from './facet';
+
+/**
+ * A search response
+ */
+export interface SCSearchResult {
+  /**
+   * Data (any data object)
+   */
+  data: SCThings[];
+
+  /**
+   * Facets (aggregations over all matching data)
+   */
+  facets: SCFacet[];
+
+  /**
+   * Pagination information
+   */
+  pagination: SCSearchResultPagination;
+
+  /**
+   * Stats of the search engine
+   */
+  stats: SCSearchResultSearchEngineStats;
+}
+
+/**
+ * Stores information about Pagination
+ */
+export interface SCSearchResultPagination {
+  /**
+   * Count of given data. Same as data.length
+   */
+  count: number;
+
+  /**
+   * Offset of data on all matching data. Given by [[SCSearchQuery.from]]
+   */
+  offset: number;
+
+  /**
+   * Number of total matching data
+   */
+  total: number;
+}
+
+/**
+ * Statistics of search engine
+ */
+export interface SCSearchResultSearchEngineStats {
+  /**
+   * Response time of the search engine in ms
+   */
+  time: number;
+}

src/protocol/search/sort.ts

@@ -0,0 +1,59 @@
+/*
+ * Copyright (C) 2019 StApps
+ * This program is free software: you can redistribute it and/or modify it
+ * under the terms of the GNU General Public License as published by the Free
+ * Software Foundation, version 3.
+ *
+ * This program is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
+ * more details.
+ *
+ * You should have received a copy of the GNU General Public License along with
+ * this program. If not, see <https://www.gnu.org/licenses/>.
+ */
+import {SCMap} from '../../general/map';
+import {SCThingsField} from '../../meta';
+import {SCDistanceSort} from './sorts/distance';
+import {SCDucetSort} from './sorts/ducet';
+import {SCPriceSort} from './sorts/price';
+
+/**
+ * Abstract sort instruction
+ */
+export interface SCSearchAbstractSort<T extends SCSearchAbstractSortArguments> {
+  /**
+   * Map of arguments for the sort instruction
+   */
+  arguments: T;
+
+  /**
+   * Direction of the sort instruction: `asc`ending or `desc`ending.
+   */
+  order: 'asc' | 'desc';
+
+  /**
+   * Type of the sort instruction
+   */
+  type: SCSearchSortType;
+}
+
+/**
+ * Map of arguments for the sort instruction
+ */
+export interface SCSearchAbstractSortArguments extends SCMap<unknown> {
+  /**
+   * Field to sort by
+   */
+  field: SCThingsField;
+}
+
+/**
+ * Type of a sort instruction
+ */
+export type SCSearchSortType = 'distance' | 'price' | 'ducet';
+
+/**
+ * A sort instruction
+ */
+export type SCSearchSort = SCDistanceSort | SCPriceSort | SCDucetSort;

src/protocol/search/sorts/distance.ts

@@ -0,0 +1,37 @@
+/*
+ * 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/>.
+ */
+// tslint:disable-next-line:no-implicit-dependencies
+import {Position} from 'geojson';
+import {SCSearchAbstractSort, SCSearchAbstractSortArguments} from '../sort';
+
+/**
+ * Sort instruction to sort by distance
+ */
+export interface SCDistanceSort extends SCSearchAbstractSort<SCDistanceSortArguments> {
+  /**
+   * @see SCSearchAbstractSort.type
+   */
+  type: 'distance';
+}
+
+/**
+ * Additional arguments for sort instruction to sort by distance
+ */
+export interface SCDistanceSortArguments extends SCSearchAbstractSortArguments {
+  /**
+   * Position to calculate distances to
+   */
+  position: Position;
+}

src/protocol/search/sorts/ducet.ts

@@ -0,0 +1,25 @@
+/*
+ * 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 {SCSearchAbstractSort, SCSearchAbstractSortArguments} from '../sort';
+
+/**
+ * Sort instruction for ducet sort
+ */
+export interface SCDucetSort extends SCSearchAbstractSort<SCSearchAbstractSortArguments> {
+  /**
+   * @see SCSearchAbstractSort.type
+   */
+  type: 'ducet';
+}

src/protocol/search/sorts/price.ts

@@ -0,0 +1,36 @@
+/*
+ * 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 {SCSportCoursePriceGroup} from '../../../things/date-series';
+import {SCSearchAbstractSort, SCSearchAbstractSortArguments} from '../sort';
+
+/**
+ * Sort instruction to sort by price
+ */
+export interface SCPriceSort extends SCSearchAbstractSort<SCPriceSortArguments> {
+  /**
+   * @see SCSearchAbstractSort.type
+   */
+  type: 'price';
+}
+
+/**
+ * Additional arguments for sort instruction to sort by price
+ */
+export interface SCPriceSortArguments extends SCSearchAbstractSortArguments {
+  /**
+   * University role to sort price for
+   */
+  universityRole: keyof SCSportCoursePriceGroup;
+}