@radatek/microserver 2.0.2 → 2.2.0

package/dist/microserver.d.ts

@@ -1,6 +1,6 @@
 /**
  * MicroServer
- * @version 2.0.2
+ * @version 2.2.0
  * @package @radatek/microserver
  * @copyright Darius Kisonas 2022
  * @license MIT
@@ -8,6 +8,7 @@
 import http from 'http';
 import net from 'net';
 import { Readable } from 'stream';
+import fs from 'fs';
 import { EventEmitter } from 'events';
 export declare class Warning extends Error {
     constructor(text: string);
@@ -39,9 +40,9 @@ export type Routes = () => {
 export declare abstract class Plugin {
     name?: string;
     priority?: number;
-    handler?(req: ServerRequest, res: ServerResponse, next: Function): void;
-    controller?: typeof Controller;
-    routes?: () => Routes | Routes;
+    handler?(req: ServerRequest, res: ServerResponse, next: Function): Promise<string | object | void> | string | object | void;
+    routes?(): Promise<Routes> | Routes;
+    initialise?(): Promise<void> | void;
     constructor(router: Router, ...args: any);
 }
 interface PluginClass {
@@ -65,8 +66,8 @@ export declare class ServerRequest extends http.IncomingMessage {
     baseUrl: string;
     /** Original url */
     originalUrl?: string;
-    /** GET parameters */
-    get: {
+    /** Query parameters */
+    query: {
         [key: string]: string;
     };
     /** Router named parameters */
@@ -117,17 +118,20 @@ export declare class ServerResponse extends http.ServerResponse {
     headersOnly: boolean;
     private constructor();
     /** Send error reponse */
-    error(error: string | number | Error, text?: string): void;
+    error(error: string | number | Error): void;
     /** Sets Content-Type acording to data and sends response */
     send(data?: string | Buffer | Error | Readable | object): void;
     /** Send json response */
     json(data: any): void;
     /** Send json response in form { success: false, error: err } */
-    jsonError(error: string | number | object | Error, code?: number): void;
+    jsonError(error: string | number | object | Error): void;
     /** Send json response in form { success: true, ... } */
-    jsonSuccess(data?: object | string, code?: number): void;
+    jsonSuccess(data?: object | string): void;
     /** Send redirect response to specified URL with optional status code (default: 302) */
     redirect(code: number | string, url?: string): void;
+    /** Set status code */
+    status(code: number): this;
+    download(path: string, filename?: string): void;
 }
 /** WebSocket options */
 export interface WebSocketOptions {
@@ -219,6 +223,14 @@ export interface Middleware {
     priority?: number;
     plugin?: Plugin;
 }
+declare class Waiter {
+    get busy(): boolean;
+    startJob(): void;
+    endJob(id?: string): void;
+    get nextId(): string;
+    wait(id: string): Promise<void>;
+    resolve(id: string): void;
+}
 /** Router */
 export declare class Router extends EventEmitter {
     server: MicroServer;
@@ -226,8 +238,11 @@ export declare class Router extends EventEmitter {
     plugins: {
         [key: string]: Plugin;
     };
+    _waiter: Waiter;
     /** @param {MicroServer} server  */
     constructor(server: MicroServer);
+    /** bind middleware or create one from string like: 'redirect:302,https://redirect.to', 'error:422', 'param:name=value', 'acl:users/get', 'model:User', 'group:Users', 'user:admin' */
+    bind(fn: string | Function | object): Function;
     /** Handler */
     handler(req: ServerRequest, res: ServerResponse, next: Function, method?: string): any;
     /** Clear routes and middlewares */
@@ -238,54 +253,55 @@ export declare class Router extends EventEmitter {
      *
      * @signature add(plugin: Plugin)
      * @param {Plugin} plugin plugin module instance
-     * @return {Router} current router
+     * @return {Promise<>}
      *
      * @signature add(pluginid: string, ...args: any)
      * @param {string} pluginid pluginid module
      * @param {...any} args arguments passed to constructor
-     * @return {Router} current router
+     * @return {Promise<>}
      *
      * @signature add(pluginClass: typeof Plugin, ...args: any)
      * @param {typeof Plugin} pluginClass plugin class
      * @param {...any} args arguments passed to constructor
-     * @return {Router} current router
+     * @return {Promise<>}
      *
      * @signature add(middleware: Middleware)
      * @param {Middleware} middleware
-     * @return {Router} current router
+     * @return {Promise<>}
      *
      * @signature add(methodUrl: string, ...middlewares: any)
      * @param {string} methodUrl 'METHOD /url' or '/url'
      * @param {...any} middlewares
-     * @return {Router} current router
+     * @return {Promise<>}
      *
      * @signature add(methodUrl: string, controllerClass: typeof Controller)
      * @param {string} methodUrl 'METHOD /url' or '/url'
      * @param {typeof Controller} controllerClass
-     * @return {Router} current router
+     * @return {Promise<>}
      *
      * @signature add(methodUrl: string, routes: Array<Array<any>>)
      * @param {string} methodUrl 'METHOD /url' or '/url'
      * @param {Array<Array<any>>} routes list with subroutes: ['METHOD /suburl', ...middlewares]
-     * @return {Router} current router
+     * @return {Promise<>}
      *
      * @signature add(methodUrl: string, routes: Array<Array<any>>)
      * @param {string} methodUrl 'METHOD /url' or '/url'
      * @param {Array<Array<any>>} routes list with subroutes: ['METHOD /suburl', ...middlewares]
-     * @return {Router} current router
+     * @return {Promise<>}
      *
      * @signature add(routes: { [key: string]: Array<any> })
      * @param { {[key: string]: Array<any>} } routes list with subroutes: 'METHOD /suburl': [...middlewares]
-     * @return {Router} current router
+     * @return {Promise<>}
      *
      * @signature add(methodUrl: string, routes: { [key: string]: Array<any> })
      * @param {string} methodUrl 'METHOD /url' or '/url'
      * @param { {[key: string]: Array<any>} } routes list with subroutes: 'METHOD /suburl': [...middlewares]
-     * @return {Router} current router
+     * @return {Promise<>}
      */
-    use(...args: any): Router;
+    use(...args: any): Promise<void>;
+    waitPlugin(id: string): Promise<Plugin>;
     /** Add hook */
-    hook(url: string, ...mid: Middleware[]): Router;
+    hook(url: string, ...mid: Middleware[]): void;
     /** Check if middleware allready added */
     has(mid: Middleware): boolean;
 }
@@ -361,23 +377,22 @@ export declare class MicroServer extends EventEmitter {
     sockets: Set<net.Socket>;
     /** server instances */
     servers: Set<net.Server>;
+    _waiter: Waiter;
     static plugins: {
         [key: string]: PluginClass;
     };
-    get plugins(): {
-        [key: string]: Plugin;
-    };
     constructor(config: MicroServerConfig);
     /** Add one time listener or call immediatelly for 'ready' */
     once(name: string, cb: Function): this;
     /** Add listener and call immediatelly for 'ready'  */
     on(name: string, cb: Function): this;
+    isReady(): boolean;
+    waitReady(): Promise<void>;
+    waitPlugin(id: string): Promise<void>;
     /** Listen server, should be used only if config.listen is not set */
-    listen(config?: ListenConfig): Promise<unknown>;
-    /** bind middleware or create one from string like: 'redirect:302,https://redirect.to', 'error:422', 'param:name=value', 'acl:users/get', 'model:User', 'group:Users', 'user:admin' */
-    bind(fn: string | Function | object): Function;
-    /** Add middleware, routes, etc.. see {Router.add} */
-    use(...args: any): MicroServer;
+    listen(config?: ListenConfig): Promise<void>;
+    /** Add middleware, routes, etc.. see {router.use} */
+    use(...args: any): Promise<void>;
     /** Default server handler */
     handler(req: ServerRequest, res: ServerResponse): void;
     protected requestInit(req: ServerRequest, res?: ServerResponse): void;
@@ -389,17 +404,19 @@ export declare class MicroServer extends EventEmitter {
     handlerUpgrade(req: ServerRequest, socket: net.Socket, head: any): void;
     /** Close server instance */
     close(): Promise<void>;
-    /** Add route, alias to `server.router.add('GET ' + url, ...args)` */
+    /** Add route, alias to `server.router.use(url, ...args)` */
+    all(url: string, ...args: any): MicroServer;
+    /** Add route, alias to `server.router.use('GET ' + url, ...args)` */
     get(url: string, ...args: any): MicroServer;
-    /** Add route, alias to `server.router.add('POST ' + url, ...args)` */
+    /** Add route, alias to `server.router.use('POST ' + url, ...args)` */
     post(url: string, ...args: any): MicroServer;
-    /** Add route, alias to `server.router.add('PUT ' + url, ...args)` */
+    /** Add route, alias to `server.router.use('PUT ' + url, ...args)` */
     put(url: string, ...args: any): MicroServer;
-    /** Add route, alias to `server.router.add('PATCH ' + url, ...args)` */
+    /** Add route, alias to `server.router.use('PATCH ' + url, ...args)` */
     patch(url: string, ...args: any): MicroServer;
-    /** Add route, alias to `server.router.add('DELETE ' + url, ...args)` */
+    /** Add route, alias to `server.router.use('DELETE ' + url, ...args)` */
     delete(url: string, ...args: any): MicroServer;
-    /** Add websocket handler, alias to `server.router.add('WEBSOCKET ' + url, ...args)` */
+    /** Add websocket handler, alias to `server.router.use('WEBSOCKET ' + url, ...args)` */
     websocket(url: string, ...args: any): MicroServer;
     /** Add router hook, alias to `server.router.hook(url, ...args)` */
     hook(url: string, ...args: any): MicroServer;
@@ -429,6 +446,26 @@ export interface StaticOptions {
     /** Max file age in seconds */
     maxAge?: number;
 }
+export interface ServeFileOptions {
+    /** path */
+    path: string;
+    /** root */
+    root?: string;
+    /** file name */
+    filename?: string;
+    /** file mime type */
+    mimeType?: string;
+    /** last modified date */
+    lastModified?: boolean;
+    /** etag */
+    etag?: boolean;
+    /** max age */
+    maxAge?: number;
+    /** range */
+    range?: boolean;
+    /** stat */
+    stats?: fs.Stats;
+}
 /** Proxy plugin options */
 export interface ProxyPluginOptions {
     /** Base path */