kuzzle 2.16.11 → 2.17.0

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "kuzzle",
   "author": "The Kuzzle Team <support@kuzzle.io>",
-  "version": "2.16.11",
+  "version": "2.17.0",
   "description": "Kuzzle is an open-source solution that handles all the data management through a secured API, with a large choice of protocols.",
   "bin": {
     "kuzzle": "bin/start-kuzzle-server"
@@ -34,7 +34,8 @@
     "test:lint:js": "eslint --max-warnings=0 ./lib ./test ./features-legacy ./bin ./features ./doc/build-error-codes.js ./plugins/available/functional-test-plugin",
     "test:lint:js:fix": "eslint --max-warnings=0 --fix ./lib ./test ./features-legacy ./bin ./features ./doc/build-error-codes.js",
     "doc-error-codes": "node -r ts-node/register doc/build-error-codes",
-    "docker:install": "docker-compose run kuzzle_node_1 npm install"
+    "docker:install": "docker-compose run kuzzle_node_1 npm install",
+    "docker:test:unit": "docker-compose run kuzzle_node_1 npm run test:unit"
   },
   "directories": {
     "lib": "lib"
@@ -51,6 +52,7 @@
     "didyoumean": "^1.2.2",
     "dumpme": "^1.0.3",
     "eventemitter3": "^4.0.7",
+    "express": "^4.17.2",
     "inquirer": "^8.2.0",
     "ioredis": "^4.28.3",
     "js-yaml": "^4.1.0",
@@ -68,8 +70,8 @@
     "ms": "^2.1.3",
     "murmurhash-native": "^3.5.0",
     "nanoid": "^3.2.0",
+    "ndjson": "^2.0.0",
     "node-segfault-handler": "^1.0.4",
-    "openapi-enforcer": "^1.16.1",
     "passport": "^0.5.2",
     "protobufjs": "~6.11.2",
     "rc": "1.2.8",

package/lib/api/openApiGenerator.d.ts

@@ -1,7 +0,0 @@
-import { JSONObject } from '../../index';
-/**
- * Generates JSON OpenApi object
- *
- * @returns {object} openApi object
- */
-export declare function generateOpenApi(): JSONObject;

package/lib/api/openApiGenerator.js

@@ -1,197 +0,0 @@
-"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.
- */
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.generateOpenApi = void 0;
-const lodash_1 = __importDefault(require("lodash"));
-const package_json_1 = require("../../package.json");
-const openapi_1 = require("./openapi");
-const inflector_1 = require("../util/inflector");
-const routeUrlMatch = /:([^/]*)/g;
-/**
- * Generate basic openApi Controller
- */
-function generateController(route, response) {
-    if (route.controller !== undefined) {
-        if (!lodash_1.default.some(response.tags, { name: route.controller })) {
-            const capitalizedController = inflector_1.Inflector.upFirst(route.controller);
-            response.tags.push({ description: `${capitalizedController} Controller`, name: route.controller });
-        }
-        if (route.openapi.tags === undefined) {
-            route.openapi.tags = [];
-        }
-        if (!route.openapi.tags.includes(route.controller)) {
-            route.openapi.tags.push(route.controller);
-        }
-    }
-}
-/**
- * Generate basic openApi Summary
- */
-function generateSummary(route) {
-    if (route.openapi.description === undefined) {
-        route.openapi.description = `Controller: ${route.controller}.`;
-    }
-    if (route.openapi.summary === undefined) {
-        route.openapi.summary = `Action: ${route.action}.`;
-    }
-}
-/**
- * Generate basic openApi Parameters
- */
-function generateParameters(route) {
-    if (route.openapi.parameters === undefined) {
-        route.openapi.parameters = [];
-        let m = routeUrlMatch.exec(route.path);
-        while (m !== null) {
-            routeUrlMatch.lastIndex++;
-            route.openapi.parameters.push({
-                in: 'path',
-                name: m[1],
-                required: true,
-                schema: { type: 'string' }
-            });
-            m = routeUrlMatch.exec(route.path);
-        }
-    }
-    if (route.openapi.parameters.length === 0) {
-        route.openapi.parameters = undefined;
-    }
-}
-/**
- * Generate basic openApi Response
- */
-function generateResponse(route) {
-    if (route.openapi.responses === undefined) {
-        route.openapi.responses = {
-            '200': {
-                description: 'OK'
-            }
-        };
-    }
-}
-/**
- * Generates JSON OpenApi object
- *
- * @returns {object} openApi object
- */
-function generateOpenApi() {
-    const routes = [];
-    global.kuzzle.config.http.routes.forEach(route => routes.push({ ...route }));
-    global.kuzzle.pluginsManager.routes.forEach(route => routes.push({ ...route }));
-    /* eslint-disable sort-keys */
-    const response = {
-        swagger: '2.0',
-        info: {
-            title: 'Kuzzle API',
-            description: 'Kuzzle 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: package_json_1.version
-        },
-        externalDocs: {
-            description: 'Kuzzle API Documentation',
-            url: 'https://docs.kuzzle.io/core/2/api/'
-        },
-        servers: [
-            {
-                url: 'https://{baseUrl}:{port}',
-                description: 'Kuzzle Base Url',
-                variables: {
-                    baseUrl: {
-                        default: 'localhost'
-                    },
-                    port: {
-                        default: '7512'
-                    }
-                }
-            }
-        ],
-        tags: [
-            {
-                name: 'document',
-                description: 'document controller'
-            }
-        ],
-        schemes: [
-            'https',
-            'http'
-        ],
-        paths: {},
-        components: {
-            ...openapi_1.OpenApiPayloadsDefinitions,
-            schemas: {
-                ...openapi_1.OpenApiDocumentCountComponent,
-                ...openapi_1.OpenApiDocumentDeleteByQueryComponent,
-                ...openapi_1.OpenApiDocumentDeleteComponent,
-                ...openapi_1.OpenApiDocumentScrollComponent,
-                ...openapi_1.OpenApiDocumentExistsComponent,
-                ...openapi_1.OpenApiDocumentUpdateComponent,
-                ...openapi_1.OpenApiDocumentReplaceComponent,
-                ...openapi_1.OpenApiDocumentGetComponent,
-                ...openapi_1.OpenApiDocumentCreateOrReplaceComponent,
-                ...openapi_1.OpenApiDocumentCreateComponent,
-            }
-        }
-    };
-    /* eslint-enable sort-keys */
-    for (const route of routes) {
-        // Make sure route verbs are lowercase
-        if (route.verb !== undefined) {
-            route.verb = route.verb.toLowerCase();
-        }
-        // Set :param notation to {param}
-        route.formattedPath = route.path.replace(routeUrlMatch, '{$1}');
-        if (response.paths[route.formattedPath] === undefined) {
-            response.paths[route.formattedPath] = {};
-        }
-        if (response.paths[route.formattedPath][route.verb] !== undefined) {
-            continue;
-        }
-        // If custom specification, return as it is
-        if (route.openapi) {
-            response.paths[route.formattedPath][route.verb] = route.openapi;
-            continue;
-        }
-        if (route.openapi === undefined) {
-            route.openapi = {};
-        }
-        generateController(route, response);
-        generateSummary(route);
-        generateParameters(route);
-        generateResponse(route);
-        response.paths[route.formattedPath][route.verb] = route.openapi;
-    }
-    return response;
-}
-exports.generateOpenApi = generateOpenApi;
-//# sourceMappingURL=openApiGenerator.js.map

package/lib/types/InternalLogger.d.ts

@@ -1,25 +0,0 @@
-/**
- * Internal logger.
- */
-export declare type InternalLogger = {
-    /**
-     * Logs a debug message
-     */
-    debug: (message: any) => void;
-    /**
-     * Logs an error message
-     */
-    error: (message: any) => void;
-    /**
-     * Logs an info message
-     */
-    info: (message: any) => void;
-    /**
-     * Logs a verbose message
-     */
-    verbose: (message: any) => void;
-    /**
-     * Logs a warn message
-     */
-    warn: (message: any) => void;
-};