feat: add model for plugin register route

2026-01-20 16:42:56 +00:00 · 2019-03-25 16:59:33 +01:00
parent 55687daca9
commit 81887315f8
3 changed files with 151 additions and 0 deletions
--- a/src/core/protocol/routes/plugin/PluginRegisterRequest.ts
+++ b/src/core/protocol/routes/plugin/PluginRegisterRequest.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 {Schema} from 'jsonschema';
+import {SCAbstractRoute, SCRouteHttpVerbs} from '../../../Route';
+import {
+  SCInternalServerErrorResponse,
+  SCMethodNotAllowedErrorResponse, 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,
+      SCPluginRegisteringFailedErrorResponse,
+      SCPluginRouteAlreadyRegisteredErrorResponse,
+      SCRequestBodyTooLargeErrorResponse,
+      SCSyntaxErrorResponse,
+    ];
+    this.method = SCRouteHttpVerbs.POST;
+    this.requestBodyName = 'SCPluginRegisterRequest';
+    this.responseBodyName = 'SCPluginRegisterResponse';
+    this.statusCodeSuccess = 200;
+    this.urlFragment = '/plugin/register';
+  }
+}