kuzzle 2.16.11 → 2.17.0

package/lib/core/backend/backendOpenApi.d.ts

@@ -0,0 +1,9 @@
+import { ApplicationManager, Backend } from './index';
+import { OpenApiDefinition } from '../../types';
+export declare class BackendOpenApi extends ApplicationManager {
+    /**
+     * Application Open API definition
+     */
+    definition: Partial<OpenApiDefinition>;
+    constructor(application: Backend);
+}

package/lib/core/backend/backendOpenApi.js

@@ -0,0 +1,69 @@
+"use strict";
+/*
+ * Kuzzle, a backend software, self-hostable and ready to use
+ * to power modern apps
+ *
+ * Copyright 2015-2020 Kuzzle
+ * mailto: support AT kuzzle.io
+ * website: http://kuzzle.io
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BackendOpenApi = void 0;
+const index_1 = require("./index");
+class BackendOpenApi extends index_1.ApplicationManager {
+    constructor(application) {
+        super(application);
+        /* eslint-disable sort-keys */
+        this.definition = {
+            swagger: '2.0',
+            info: {
+                title: `${application.name} API`,
+                description: `${application.name} HTTP API definition`,
+                contact: {
+                    name: 'Kuzzle team',
+                    url: 'https://kuzzle.io',
+                    email: 'support@kuzzle.io',
+                    discord: 'http://join.discord.kuzzle.io'
+                },
+                license: {
+                    name: 'Apache 2',
+                    url: 'http://opensource.org/licenses/apache2.0'
+                },
+                version: application.version
+            },
+            externalDocs: {
+                description: 'Kuzzle API Documentation',
+                url: 'https://docs.kuzzle.io/core/2/api/'
+            },
+            servers: [
+                {
+                    url: 'https://{baseUrl}:{port}',
+                    description: `${application.name} Base Url`,
+                    variables: {
+                        baseUrl: { default: 'localhost' },
+                        port: { default: 7512 },
+                    }
+                }
+            ],
+            tags: [],
+            schemes: ['https', 'http'],
+            paths: {},
+            components: {}
+        };
+        /* eslint-enable sort-keys */
+    }
+}
+exports.BackendOpenApi = BackendOpenApi;
+//# sourceMappingURL=backendOpenApi.js.map

package/lib/core/backend/index.d.ts

@@ -9,4 +9,5 @@ export * from './backendPipe';
 export * from './backendPlugin';
 export * from './backendStorage';
 export * from './backendVault';
+export * from './backendOpenApi';
 export * from './internalLogger';

package/lib/core/backend/index.js

@@ -21,5 +21,6 @@ __exportStar(require("./backendPipe"), exports);
 __exportStar(require("./backendPlugin"), exports);
 __exportStar(require("./backendStorage"), exports);
 __exportStar(require("./backendVault"), exports);
+__exportStar(require("./backendOpenApi"), exports);
 __exportStar(require("./internalLogger"), exports);
 //# sourceMappingURL=index.js.map

package/lib/core/network/accessLogger.js

@@ -54,15 +54,15 @@ class AccessLogger {
     const config = global.kuzzle.config.server;
 
     for (const out of config.logs.transports) {
-      if (out.transport && !ALLOWED_TRANSPORTS.includes(out.transport)) {
+      if (out.transport && ! ALLOWED_TRANSPORTS.includes(out.transport)) {
         global.kuzzle.log.error(`Failed to initialize logger transport "${out.transport}": unsupported transport. Skipped.`);
       }
       else {
-        this.isActive = this.isActive || !out.silent;
+        this.isActive = this.isActive || ! out.silent;
       }
     }
 
-    if (!this.isActive) {
+    if (! this.isActive) {
       return;
     }
 
@@ -78,7 +78,7 @@ class AccessLogger {
   }
 
   log (connection, request, extra) {
-    if (!this.isActive) {
+    if (! this.isActive) {
       return;
     }
 
@@ -212,7 +212,7 @@ class AccessLoggerWorker {
       }
     }
 
-    this.logger = winston.createLogger({transports});
+    this.logger = winston.createLogger({ transports });
   }
 
   /**
@@ -325,7 +325,7 @@ class AccessLoggerWorker {
   }
 }
 
-if (!isMainThread) {
+if (! isMainThread) {
   // Needed for instantiating a serialized KuzzleRequest object
   global.kuzzle = { id: workerData.kuzzleId };
 

package/lib/core/network/clientConnection.js

@@ -36,7 +36,7 @@ class ClientConnection {
     this.protocol = protocol;
     this.headers = {};
 
-    if (!Array.isArray(ips)) {
+    if (! Array.isArray(ips)) {
       throw new TypeError(`Expected ips to be an Array, got ${typeof ips}`);
     }
     this.ips = ips;

package/lib/core/network/entryPoint.js

@@ -99,7 +99,7 @@ class EntryPoint {
   async startListening () {
     // We need to verify the port ourselves, to make sure Node.js won't open
     // a named pipe if the provided port number is a string
-    if (!Number.isInteger(this.config.port)) {
+    if (! Number.isInteger(this.config.port)) {
       throw networkError.get('invalid_port', this.config.port);
     }
 
@@ -140,7 +140,7 @@ class EntryPoint {
 
     const client = this._clients.get(connectionId);
 
-    if (!client || !client.protocol) {
+    if (! client || ! client.protocol) {
       return;
     }
 
@@ -160,7 +160,7 @@ class EntryPoint {
 
     const client = this._clients.get(connectionId);
 
-    if (!client || !client.protocol) {
+    if (! client || ! client.protocol) {
       return;
     }
 
@@ -248,7 +248,7 @@ class EntryPoint {
     global.kuzzle.funnel.execute(request, (error, result) => {
       const _res = result || request;
 
-      if (error && !_res.error) {
+      if (error && ! _res.error) {
         _res.setError(error);
       }
 
@@ -327,7 +327,7 @@ class EntryPoint {
 
     const client = this._clients.get(data.connectionId);
 
-    if (!client || !client.protocol) {
+    if (! client || ! client.protocol) {
       return;
     }
 

package/lib/core/network/httpRouter/index.js

@@ -142,7 +142,7 @@ class Router {
   route (message, cb) {
     debug('Routing HTTP message: %a', message);
 
-    if (!has(this.routes, message.method)) {
+    if (! has(this.routes, message.method)) {
       this.routeUnhandledHttpMethod(message, cb);
       return;
     }
@@ -165,8 +165,8 @@ class Router {
     }
     catch (err) {
       let request;
-      if (!routeHandler || !routeHandler._request) {
-        request = new Request({requestId: message.requestId}, {});
+      if (! routeHandler || ! routeHandler._request) {
+        request = new Request({ requestId: message.requestId }, {});
         // Set Headers if not present
         request.response.setHeaders(this.defaultHeaders, true);
 
@@ -190,7 +190,7 @@ class Router {
    * @param  {HttpMessage} message
    * @param {function} cb
    */
-  routeUnhandledHttpMethod(message, cb) {
+  routeUnhandledHttpMethod (message, cb) {
     const
       requestContext = global.kuzzle.router.connections.get(message.connection.id),
       request = new Request(
@@ -253,7 +253,7 @@ function applyACAOHeader (message, request) {
 function attach (path, handler, target) {
   const sanitized = path[path.length - 1] === '/' ? path.slice(0, -1) : path;
 
-  if (!attachParts(sanitized.split('/'), handler, target)) {
+  if (! attachParts(sanitized.split('/'), handler, target)) {
     throw kerror.get('duplicate_url', sanitized);
   }
 }

package/lib/core/network/httpRouter/routeHandler.js

@@ -38,7 +38,7 @@ const kerror = require('../../../kerror').wrap('network', 'http');
  *                           in JSON format
  */
 class RouteHandler {
-  constructor(url, query, message) {
+  constructor (url, query, message) {
     this.handler = null;
     this._request = null;
     this.url = url;
@@ -92,7 +92,7 @@ class RouteHandler {
    * @param {string} name
    * @param {string} value
    */
-  addArgument(name, value) {
+  addArgument (name, value) {
     this.data[name] = value;
   }
 
@@ -101,7 +101,7 @@ class RouteHandler {
    *
    * @param {Function} callback
    */
-  invokeHandler(callback) {
+  invokeHandler (callback) {
     this.handler(this.request, callback);
   }
 }

package/lib/core/network/httpRouter/routePart.js

@@ -32,7 +32,7 @@ const { has } = require('../../../util/safeObject');
  * @class RoutePart
  */
 class RoutePart {
-  constructor() {
+  constructor () {
     this.subparts = {};
     this.placeholders = null;
 
@@ -45,7 +45,7 @@ class RoutePart {
    * @param {string} part
    * @returns {boolean}
    */
-  exists(part) {
+  exists (part) {
     return this.subparts[part] !== undefined && this.subparts[part].handler !== null;
   }
 
@@ -56,8 +56,8 @@ class RoutePart {
    * @param {string} part
    * @returns {RoutePart}
    */
-  getNext(part) {
-    if (!has(this.subparts, part)) {
+  getNext (part) {
+    if (! has(this.subparts, part)) {
       this.subparts[part] = new RoutePart();
     }
 
@@ -71,7 +71,7 @@ class RoutePart {
    * @param {HttpMessage} message
    * @returns {RouteHandler} registered function handler
    */
-  getHandler(message) {
+  getHandler (message) {
     // Do not use WHATWG API yet, stick with the legacy (and deprecated) URL
     // There are two issues:
     //   - Heavy performance impact: https://github.com/nodejs/node/issues/30334

package/lib/core/network/protocolManifest.js

@@ -24,7 +24,7 @@
 const AbstractManifest = require('../shared/abstractManifest');
 
 class ProtocolManifest extends AbstractManifest {
-  constructor(protocolPath, protocol) {
+  constructor (protocolPath, protocol) {
     super(protocolPath);
 
     this.protocol = protocol;

package/lib/core/network/protocols/httpMessage.js

@@ -29,7 +29,7 @@ class HttpMessage {
    * @param {ClientConnection} connection
    * @param {uWS.HttpRequest} request
    */
-  constructor(connection, request) {
+  constructor (connection, request) {
     this.connection = connection;
     this._content = null;
     this.ips = connection.ips;
@@ -54,7 +54,7 @@ class HttpMessage {
   }
 
   set content (value) {
-    if (!value || value.length === 0) {
+    if (! value || value.length === 0) {
       this._content = null;
     }
     else {