kuzzle 2.29.1-beta.1 → 2.29.1

package/lib/kuzzle/kuzzle.d.ts

@@ -1 +1,134 @@
+/// <reference types="node" />
+import KuzzleEventEmitter from "./event/kuzzleEventEmitter";
+import { InstallationConfig, ImportConfig, SupportConfig, StartOptions } from "./../types/Kuzzle";
+import { KuzzleConfiguration } from "../types/config/KuzzleConfiguration";
 export declare const BACKEND_IMPORT_KEY = "backend:init:import";
+declare class Kuzzle extends KuzzleEventEmitter {
+    private config;
+    private _state;
+    private log;
+    private rootPath;
+    /**
+     * Internal index bootstrapper and accessor
+     */
+    private internalIndex;
+    private pluginsManager;
+    private tokenManager;
+    private passport;
+    /**
+     * The funnel dispatches messages to API controllers
+     */
+    private funnel;
+    /**
+     * The router listens to client requests and pass them to the funnel
+     */
+    private router;
+    /**
+     * Statistics core component
+     */
+    private statistics;
+    /**
+     * Network entry point
+     */
+    private entryPoint;
+    /**
+     * Validation core component
+     */
+    private validation;
+    /**
+     * Dump generator
+     */
+    private dumpGenerator;
+    /**
+     * Vault component (will be initialized after bootstrap)
+     */
+    private vault;
+    /**
+     * AsyncLocalStorage wrapper
+     */
+    private asyncStore;
+    /**
+     * Kuzzle internal debugger
+     */
+    private debugger;
+    /**
+     * Kuzzle version
+     */
+    private version;
+    private openApiManager;
+    /**
+     * List of differents imports types and their associated method
+     */
+    private importTypes;
+    private koncorde;
+    private secret;
+    /**
+     * Node unique ID amongst other cluster nodes
+     */
+    id: string;
+    constructor(config: KuzzleConfiguration);
+    /**
+     * Initializes all the needed components of Kuzzle.
+     *
+     * @param {Application} - Application Plugin instance
+     * @param {Object} - Additional options (import, installations, plugins, secretsFile, support, vaultKey)
+     *
+     * @this {Kuzzle}
+     */
+    start(application: any, options?: StartOptions): Promise<void>;
+    /**
+     * Generates the node ID.
+     *
+     * This will init the cluster if it's enabled.
+     */
+    private initKuzzleNode;
+    /**
+     * Gracefully exits after processing remaining requests
+     *
+     * @returns {Promise}
+     */
+    shutdown(): Promise<void>;
+    /**
+     * Execute multiple handlers only once on any given environment
+     *
+     * @param {Array<{ id: string, handler: () => void, description?: string }>} installations - Array of unique methods to execute
+     *
+     * @returns {Promise<void>}
+     */
+    install(installations: InstallationConfig[]): Promise<void>;
+    ask(...args: any[]): Promise<any>;
+    emit(...args: any[]): Promise<any>;
+    pipe(...args: any[]): Promise<any>;
+    private importUserMappings;
+    private importMappings;
+    private importFixtures;
+    private importPermissions;
+    /**
+     * Check if every import has been done, if one of them is not finished yet, wait for it
+     */
+    private _waitForImportToFinish;
+    private isConfigsEmpty;
+    private persistHashedImport;
+    /**
+     * Load into the app several imports
+     *
+     * @param {Object} toImport - Contains `mappings`, `onExistingUsers`, `profiles`, `roles`, `userMappings`, `users`
+     * @param {Object} toSupport - Contains `fixtures`, `mappings`, `securities` (`profiles`, `roles`, `users`)
+     *
+     * @returns {Promise<void>}
+     */
+    loadInitialState(toImport?: ImportConfig, toSupport?: SupportConfig): Promise<void>;
+    dump(suffix: any): any;
+    hash(input: any): string | Buffer;
+    get state(): kuzzleStateEnum;
+    set state(value: kuzzleStateEnum);
+    /**
+     * Register handlers and do a kuzzle dump for:
+     * - system signals
+     * - unhandled-rejection
+     * - uncaught-exception
+     */
+    registerSignalHandlers(): void;
+    dumpAndExit(suffix: any): Promise<void>;
+}
+export { Kuzzle };

package/lib/kuzzle/kuzzle.js

@@ -46,7 +46,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.BACKEND_IMPORT_KEY = void 0;
+exports.Kuzzle = exports.BACKEND_IMPORT_KEY = void 0;
 const path_1 = __importDefault(require("path"));
 const murmurhash_native_1 = require("murmurhash-native");
 const json_stable_stringify_1 = __importDefault(require("json-stable-stringify"));
@@ -583,5 +583,6 @@ class Kuzzle extends kuzzleEventEmitter_1.default {
         await this.shutdown();
     }
 }
+exports.Kuzzle = Kuzzle;
 module.exports = Kuzzle;
 //# sourceMappingURL=kuzzle.js.map

package/lib/types/Global.d.ts

@@ -1,11 +1,13 @@
 import { Backend } from "../core/backend";
+import { Kuzzle } from "../kuzzle";
+/**
+ * This file contains global type declarations for Kuzzle.
+ * We need to use `var` so Typescript extends the globalThis type.
+ * See https://www.typescriptlang.org/docs/handbook/release-notes/typescript-3-4.html#type-checking-for-globalthis
+ */
 declare global {
-    namespace NodeJS {
-        interface Global {
-            kuzzle: any;
-            app: Backend;
-            NODE_ENV: string;
-        }
-    }
+    var app: Backend;
+    var kuzzle: Kuzzle;
+    var NODE_ENV: string;
 }
 export {};

package/lib/types/Global.js

@@ -1,5 +1,5 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 global.NODE_ENV = process.env.NODE_ENV;
-/* eslint-enable @typescript-eslint/no-namespace */
+/* eslint-enable no-var, vars-on-top*/
 //# sourceMappingURL=Global.js.map

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "kuzzle",
   "author": "The Kuzzle Team <support@kuzzle.io>",
-  "version": "2.29.1-beta.1",
+  "version": "2.29.1",
   "description": "Kuzzle is an open-source solution that handles all the data management through a secured API, with a large choice of protocols.",
   "bin": "bin/start-kuzzle-server",
   "scripts": {