0.14.0

CHANGELOG.md

@@ -1,3 +1,19 @@
+# [0.13.0](https://gitlab.com/openstapps/core/compare/v0.12.0...v0.13.0) (2019-04-02)
+
+
+### Bug Fixes
+
+* correct isThing guard ([67868e9](https://gitlab.com/openstapps/core/commit/67868e9))
+* update tslint  dependencies ([bbe4fca](https://gitlab.com/openstapps/core/commit/bbe4fca))
+
+
+### Features
+
+* add conditional "maps" for associated types ([c8bda2e](https://gitlab.com/openstapps/core/commit/c8bda2e)), closes [#50](https://gitlab.com/openstapps/core/issues/50)
+* provide sample JSON files with the package ([5d1e79d](https://gitlab.com/openstapps/core/commit/5d1e79d)), closes [#46](https://gitlab.com/openstapps/core/issues/46)
+
+
+
 # [0.12.0](https://gitlab.com/openstapps/core/compare/v0.11.0...v0.12.0) (2019-03-14)
 
 

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "@openstapps/core",
-  "version": "0.13.0",
+  "version": "0.14.0",
   "lockfileVersion": 1,
   "requires": true,
   "dependencies": {

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openstapps/core",
-  "version": "0.13.0",
+  "version": "0.14.0",
   "description": "StAppsCore - Generalized model of data",
   "keywords": [
     "Model",

src/core/protocol/errors/ErrorResponse.ts

@@ -42,6 +42,7 @@ export abstract class SCError implements SCErrorResponse {
 
   /**
    * 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
@@ -66,6 +67,7 @@ export class SCValidationErrorResponse extends SCError {
 
   /**
    * Create a SCValidationErrorResponse
+   *
    * @param errors List of validation errors
    * @param stack Set to true if a stack trace should be created
    */
@@ -81,6 +83,7 @@ export class SCValidationErrorResponse extends SCError {
 export class SCUnsupportedMediaTypeErrorResponse extends SCError {
   /**
    * Create a SCUnsupportedMediaTypeErrorResponse
+   *
    * @param stack Set to true if a stack trace should be created
    */
   constructor(stack?: boolean) {
@@ -94,6 +97,7 @@ export class SCUnsupportedMediaTypeErrorResponse extends SCError {
 export class SCMethodNotAllowedErrorResponse extends SCError {
   /**
    * Create a SCMethodNotAllowedErrorResponse
+   *
    * @param stack Set to true if a stack trace should be created
    */
   constructor(stack?: boolean) {
@@ -120,6 +124,7 @@ export class SCRequestBodyTooLargeErrorResponse extends SCError {
 export class SCTooManyRequestsErrorResponse extends SCError {
   /**
    * Create a SCTooManyRequestsErrorResponse
+   *
    * @param stack Set to true if a stack trace should be created
    */
   constructor(stack?: boolean) {
@@ -133,6 +138,7 @@ export class SCTooManyRequestsErrorResponse extends SCError {
 export class SCNotFoundErrorResponse extends SCError {
   /**
    * Create a SCNotFoundErrorResponse
+   *
    * @param stack Set to true if a stack trace should be created
    */
   constructor(stack?: boolean) {
@@ -140,12 +146,80 @@ export class SCNotFoundErrorResponse extends SCError {
   }
 }
 
+/**
+ * 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, 406, stack);
+  }
+}
+
+/**
+ * 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 {
+  /**
+   * Create a PluginAlreadyRegisteredError
+   *
+   * @param message contains potential differences in other parameters outside of the name
+   * @param stack Set to true if a stack trace should be created
+   */
+  constructor(message: string, stack?: boolean) {
+    super('PluginRegisteringFailedError', message, 409, stack);
+  }
+}
+
+/**
+ * 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, 500, stack);
+  }
+}
+
+/**
+ * An error that is returned whenever there is a plugin request that is supposed to register a route, that is already
+ * registered
+ * This usually indicates that two **different** plugins use the same route.
+ */
+export class SCPluginRouteAlreadyRegisteredErrorResponse extends SCError {
+  /**
+   * Create a PluginRouteAlreadyRegisteredError
+   *
+   * @param registeredName The name by the plugin that has already registered the route previously
+   * @param registeredUrl  The URL by the plugin that has already registered the route previously
+   * @param stack Set to true if a stack trace should be created
+   */
+  constructor(registeredName: string, registeredUrl: string, stack?: boolean) {
+    super('PluginRouteAlreadyRegisteredError',
+      `Already registered by "${registeredName}" under URL "${registeredUrl}".`, 409, stack);
+  }
+}
+
 /**
  * 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
    */
@@ -165,6 +239,7 @@ export class SCInternalServerErrorResponse extends SCError {
 
   /**
    * 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

src/core/protocol/routes/plugin/PluginRegisterRequest.ts

@@ -0,0 +1,100 @@
+/*
+ * 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 {Schema} from 'jsonschema';
+import {SCAbstractRoute, SCRouteHttpVerbs} from '../../../Route';
+import {
+  SCInternalServerErrorResponse,
+  SCMethodNotAllowedErrorResponse, SCParametersNotAcceptable,
+  SCPluginAlreadyRegisteredErrorResponse,
+  SCPluginRegisteringFailedErrorResponse,
+  SCPluginRouteAlreadyRegisteredErrorResponse,
+  SCRequestBodyTooLargeErrorResponse,
+  SCSyntaxErrorResponse,
+} from '../../errors/ErrorResponse';
+
+/**
+ * Plugin register request
+ *
+ * @validatable
+ */
+export type SCPluginRegisterRequest = AddPlugin | RemovePlugin;
+interface AddPlugin {
+  /**
+   * The desired action, so whether the plugin should be added or removed
+   */
+  action: 'add';
+
+  /**
+   * The address of the plugin
+   */
+  address: string;
+
+  /**
+   * The name of the plugin
+   * Just for debugging purposes, to more easily identify conflicts.
+   */
+  name: string;
+
+  /**
+   * How the requests of the plugin looks like, a JSON schema for validation
+   */
+  pluginRequestSchema: Schema;
+
+  /**
+   * How the responses of the plugin looks like, a JSON schema for validation
+   */
+  pluginResponseSchema: Schema;
+
+  /**
+   * The desired route, for example /feedback.
+   */
+  route: string;
+}
+interface RemovePlugin {
+  /**
+   * 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;
+}
+
+/**
+ * Route to register plugins
+ */
+export class SCPluginRegisterRoute extends SCAbstractRoute {
+  constructor() {
+    super();
+    this.errorNames = [
+      SCInternalServerErrorResponse,
+      SCMethodNotAllowedErrorResponse,
+      SCParametersNotAcceptable,
+      SCPluginAlreadyRegisteredErrorResponse,
+      SCPluginRouteAlreadyRegisteredErrorResponse,
+      SCPluginRegisteringFailedErrorResponse,
+      SCPluginRouteAlreadyRegisteredErrorResponse,
+      SCRequestBodyTooLargeErrorResponse,
+      SCSyntaxErrorResponse,
+    ];
+    this.method = SCRouteHttpVerbs.POST;
+    this.requestBodyName = 'SCPluginRegisterRequest';
+    this.responseBodyName = 'SCPluginRegisterResponse';
+    this.statusCodeSuccess = 200;
+    this.urlFragment = '/plugin/register';
+  }
+}

src/core/protocol/routes/plugin/PluginRegisterResponse.ts

@@ -0,0 +1,26 @@
+/*
+ * 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/>.
+ */
+
+/**
+ * Plugin register response
+ *
+ * @validatable
+ */
+export interface SCPluginRegisterResponse {
+  /**
+   * Whether the desired action succeeded or failed (true for success, false if an error occurred)
+   */
+  success: boolean;
+}