feat: add core

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

@@ -0,0 +1,73 @@
+/*
+ * 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 {SCSearchFilter} from '../../../types/filters/Abstract';
+import {SCSearchSort} from '../../../types/sorts/Abstract';
+
+/**
+ * A search request
+ */
+export interface SCSearchRequest extends SCSearchQuery {
+}
+
+/**
+ * A search query
+ */
+export interface SCSearchQuery {
+  /**
+   *  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[];
+}
+
+/**
+ * Route for searching things
+ */
+export class SCSearchRoute extends SCAbstractRoute {
+  constructor() {
+    super();
+    this.errorNames = [
+      'SCInternalServerErrorResponse',
+      'SCMethodNotAllowedErrorResponse',
+      'SCUnsupportedMediaTypeErrorResponse',
+      'SCValidationErrorResponse',
+    ];
+    this.method = 'POST';
+    this.requestBodyName = 'SCSearchRequest';
+    this.responseBodyName = 'SCSearchResponse';
+    this.statusCodeSuccess = 200;
+    this.urlFragment = '/search';
+  }
+}