feat: add core

src/core/protocol/routes/search/MultiSearchRequest.ts

@@ -0,0 +1,48 @@
+/*
+ * Copyright (C) 2018 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 {SCAbstractRoute} from '../../../Route';
+import {SCSearchQuery} from './SearchRequest';
+
+/**
+ * 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.**
+ */
+export interface SCMultiSearchRequest {
+  [k: string]: SCSearchQuery;
+}
+
+/**
+ * Route for submission of multiple search requests at once
+ */
+export class SCMultiSearchRoute extends SCAbstractRoute {
+  constructor() {
+    super();
+    this.errorNames = [
+      'SCInternalServerErrorResponse',
+      'SCMethodNotAllowedErrorResponse',
+      'SCTooManyRequestsErrorResponse',
+      'SCUnsupportedMediaTypeErrorResponse',
+      'SCValidationErrorResponse',
+    ];
+    this.method = 'POST';
+    this.requestBodyName = 'SCMultiSearchRequest';
+    this.responseBodyName = 'SCMultiSearchResponse';
+    this.statusCodeSuccess = 200;
+    this.urlFragment = '/search/multi';
+  }
+}