@radatek/microserver 3.0.6 → 3.0.7

package/microserver.d.ts

@@ -1,6 +1,6 @@
 /**
  * MicroServer
- * @version 3.0.6
+ * @version 3.0.7
  * @package @radatek/microserver
  * @copyright Darius Kisonas 2022
  * @license MIT
@@ -44,7 +44,6 @@ export declare abstract class Plugin {
     priority?: number;
     handler?(req: ServerRequest, res: ServerResponse, next: Function): Promise<string | object | void> | string | object | void;
     routes?(): Promise<RoutesSet | void> | RoutesSet | void;
-    constructor();
 }
 interface PluginClass {
     new (options: any, server: MicroServer): Plugin;
@@ -86,6 +85,7 @@ export declare class ServerRequest<T = any> extends http.IncomingMessage {
     rawBody: Buffer[];
     /** Request raw body size */
     rawBodySize: number;
+    protected constructor(res: http.ServerResponse, server: MicroServer);
     /** Extend http.IncomingMessage */
     static extend(req: http.IncomingMessage, res: http.ServerResponse, server: MicroServer): ServerRequest;
     /** Check if request is ready */
@@ -114,6 +114,7 @@ export declare class ServerResponse<T = any> extends http.ServerResponse {
     readonly req: ServerRequest<T>;
     /** Should response be json */
     isJson: boolean;
+    protected constructor(server: MicroServer);
     /** Extends http.ServerResponse */
     static extend(res: http.ServerResponse): void;
     /** Send error reponse */
@@ -162,7 +163,7 @@ export interface MicroServerConfig extends ListenConfig {
     /** extra options for plugins */
     [key: string]: any;
 }
-interface MicroServerEvents {
+export interface MicroServerEvents {
     ready: () => void;
     close: () => void;
     listen: (port: number, address: string, server: http.Server) => void;
@@ -258,6 +259,7 @@ export interface CorsOptions {
     /** Max age */
     maxAge?: number;
 }
+/** CORS plugin. Config may be: true - allow all, string - allow specific origin, or CorsOptions */
 export declare class CorsPlugin extends Plugin {
     priority: number;
     name: string;
@@ -265,6 +267,7 @@ export declare class CorsPlugin extends Plugin {
     constructor(options?: CorsOptions | string | true);
     handler?(req: ServerRequest, res: ServerResponse, next: Function): Promise<string | object | void> | string | object | void;
 }
+/** Methods plugin to support OPTIONS method, and restrict allowed methods. Configuration is comma separated string  */
 export declare class MethodsPlugin extends Plugin {
     priority: number;
     name: string;
@@ -274,6 +277,7 @@ export declare class MethodsPlugin extends Plugin {
 export interface BodyOptions {
     maxBodySize?: number;
 }
+/** Body parser plugin */
 export declare class BodyPlugin extends Plugin {
     priority: number;
     name: string;
@@ -291,6 +295,7 @@ export interface UploadFile {
     size: number;
     filePath?: string;
 }
+/** Upload plugin, At least uploadDir option is required */
 export declare class UploadPlugin extends Plugin {
     priority: number;
     name: string;
@@ -321,7 +326,7 @@ interface WebSocketEvents {
     message: (data: string | Buffer | ArrayBuffer | Blob) => void;
     open: () => void;
 }
-/** WebSocket class */
+/** WebSocket class used in upgrade handler */
 export declare class WebSocket extends EventEmitter {
     ready: boolean;
     constructor(req: ServerRequest, options?: WebSocketOptions);
@@ -339,6 +344,7 @@ export declare class WebSocket extends EventEmitter {
     off<K extends keyof WebSocketEvents>(event: K, listener: WebSocketEvents[K]): this;
     removeListener<K extends keyof WebSocketEvents>(event: K, listener: WebSocketEvents[K]): this;
 }
+/** WebSocket plugin to support `WEBSOCKET /url` routes */
 export declare class WebSocketPlugin extends Plugin {
     name: string;
     constructor(options?: any, server?: MicroServer);
@@ -385,6 +391,8 @@ export interface StaticFilesOptions {
     maxAge?: number;
     /** static errors file for status code, '*' - default */
     errors?: Record<string, string>;
+    /** check precompressed file */
+    precompressedGzip?: boolean;
 }
 export interface ServeFileOptions {
     /** path */
@@ -406,11 +414,7 @@ export interface ServeFileOptions {
     /** stat */
     stats?: fs.Stats;
 }
-/**
- * Static files middleware plugin
- * Usage: server.use('static', '/public')
- * Usage: server.use('static', { root: 'public', path: '/static' })
- */
+/** Static files plugin. At least must be path to public folder as string or StaticFilesOptions */
 export declare class StaticFilesPlugin extends Plugin {
     priority: number;
     /** Default mime types */
@@ -439,6 +443,7 @@ export declare class StaticFilesPlugin extends Plugin {
     maxAge?: number;
     prefix: string;
     errors?: Record<string, string>;
+    checkPrecompressedGzip?: boolean;
     constructor(options?: StaticFilesOptions | string, server?: MicroServer);
     /** Default static files handler */
     handler(req: ServerRequest, res: ServerResponse, next: Function): any;
@@ -462,9 +467,9 @@ export interface ProxyOptions {
         [key: string]: boolean;
     };
 }
+/** Reverse proxy plugin, At least remote url as string or in ProxyOptions is required */
 export declare class ProxyPlugin extends Plugin {
     priority: number;
-    name: string;
     /** Default valid headers */
     static validHeaders: {
         [key: string]: boolean;
@@ -610,6 +615,7 @@ export declare class AuthPlugin extends Plugin {
     /** Authentication middleware */
     handler(req: ServerRequest, res: ServerResponse, next: Function): Promise<any>;
 }
+/** Load standard plugins with predefined configs: MethodsPlugin, CorsPlugin, TrustProxyPlugin, BodyPlugin, AuthPlugin, StaticFilesPlugin */
 export declare class StandardPlugins extends Plugin {
     constructor(options?: any, server?: MicroServer);
 }
@@ -706,7 +712,7 @@ export declare class FileStore {
     observe(data: object, cb: (data: object, key: string, value: any) => void): object;
 }
 /** Model validation options */
-interface ModelContextOptions {
+export interface ModelContextOptions {
     /** User info */
     user?: UserInfo;
     /** Request params */
@@ -725,12 +731,12 @@ interface ModelContextOptions {
     projection?: Record<string, 0 | 1 | true | false>;
 }
 /** Model field validation options */
-interface ModelValidateFieldOptions extends ModelContextOptions {
+export interface ModelValidateFieldOptions extends ModelContextOptions {
     name: string;
     field: ResolvedFieldSchema;
     model: Model<any>;
 }
-export interface ModelCallbackFunc {
+interface ModelCallbackFunc {
     (options: any): any;
 }
 type ModelBasicCtorType = typeof String | typeof Number | typeof Boolean | typeof Date;
@@ -764,7 +770,7 @@ export interface ModelFieldSchema {
     /** Regex validation or 'email', 'url', 'date', 'time', 'date-time' */
     format?: string;
 }
-interface ResolvedFieldSchema {
+export interface ResolvedFieldSchema {
     type: string;
     model?: Model<any>;
     primaryKey?: boolean;

package/microserver.js

@@ -1,6 +1,6 @@
 /**
  * MicroServer
- * @version 3.0.6
+ * @version 3.0.7
  * @package @radatek/microserver
  * @copyright Darius Kisonas 2022
  * @license MIT
@@ -77,7 +77,6 @@ function deferPromise(cb) {
 export class Plugin {
     name;
     priority;
-    constructor() { }
 }
 // #region ServerRequest/ServerResponse
 /** Extended http.IncomingMessage */
@@ -120,7 +119,6 @@ export class ServerRequest extends http.IncomingMessage {
     _body;
     // @internal
     _isReady;
-    // @internal
     constructor(res, server) {
         super(new net.Socket());
         ServerRequest.extend(this, res, server);
@@ -215,7 +213,6 @@ export class ServerRequest extends http.IncomingMessage {
 export class ServerResponse extends http.ServerResponse {
     /** Should response be json */
     isJson;
-    // @internal
     constructor(server) {
         super(new http.IncomingMessage(new net.Socket()));
         ServerRequest.extend(this.req, this, server);
@@ -816,6 +813,7 @@ class RouterItem {
     // @internal
     _last;
 }
+/** Router plugin */
 class RouterPlugin extends Plugin {
     priority = 100;
     name = 'router';
@@ -947,6 +945,7 @@ class RouterPlugin extends Plugin {
         this.walk(this._getStack(req.pathname, ['hook', method, '*']), req, res, next);
     }
 }
+/** CORS plugin. Config may be: true - allow all, string - allow specific origin, or CorsOptions */
 export class CorsPlugin extends Plugin {
     priority = -100;
     name = 'cors';
@@ -980,6 +979,7 @@ export class CorsPlugin extends Plugin {
 }
 // #enregion CorsPlugin
 // #region MethodsPlugin
+/** Methods plugin to support OPTIONS method, and restrict allowed methods. Configuration is comma separated string  */
 export class MethodsPlugin extends Plugin {
     priority = -90;
     name = 'methods';
@@ -1006,6 +1006,7 @@ export class MethodsPlugin extends Plugin {
         return next();
     }
 }
+/** Body parser plugin */
 export class BodyPlugin extends Plugin {
     priority = -80;
     name = 'body';
@@ -1061,6 +1062,7 @@ export class BodyPlugin extends Plugin {
         });
     }
 }
+/** Upload plugin, At least uploadDir option is required */
 export class UploadPlugin extends Plugin {
     priority = -70;
     name = 'upload';
@@ -1194,7 +1196,7 @@ export class UploadPlugin extends Plugin {
 }
 const EMPTY_BUFFER = Buffer.alloc(0);
 const DEFLATE_TRAILER = Buffer.from([0x00, 0x00, 0xff, 0xff]);
-/** WebSocket class */
+/** WebSocket class used in upgrade handler */
 export class WebSocket extends EventEmitter {
     // @internal
     _socket;
@@ -1464,6 +1466,7 @@ export class WebSocket extends EventEmitter {
             this._socket.write(frame, () => this._socket.write(data, cb));
     }
 }
+/** WebSocket plugin to support `WEBSOCKET /url` routes */
 export class WebSocketPlugin extends Plugin {
     name = 'websocket';
     // @internal
@@ -1483,8 +1486,6 @@ export class WebSocketPlugin extends Plugin {
     }
     upgradeHandler(server, req, socket, head) {
         const host = req.headers.host || '';
-        const vhostPlugin = server.getPlugin('vhost');
-        const vserver = vhostPlugin?.vhosts?.[host] || server;
         const res = {
             req,
             get headersSent() {
@@ -1539,7 +1540,7 @@ export class WebSocketPlugin extends Plugin {
         if (req.method !== 'GET' || req.headers.upgrade?.toLowerCase() !== 'websocket')
             return res.error(400);
         req.method = 'WEBSOCKET';
-        vserver.handler(req, res);
+        server.handler(req, res);
     }
 }
 // #endregion WebSocket
@@ -1618,13 +1619,7 @@ export class VHostPlugin extends Plugin {
     }
 }
 const etagPrefix = crypto.randomBytes(4).toString('hex');
-//TODO: add precompressed .gz support
-//TODO: add unknown file extension handler
-/**
- * Static files middleware plugin
- * Usage: server.use('static', '/public')
- * Usage: server.use('static', { root: 'public', path: '/static' })
- */
+/** Static files plugin. At least must be path to public folder as string or StaticFilesOptions */
 export class StaticFilesPlugin extends Plugin {
     priority = 110;
     /** Default mime types */
@@ -1668,6 +1663,7 @@ export class StaticFilesPlugin extends Plugin {
     maxAge;
     prefix;
     errors;
+    checkPrecompressedGzip;
     constructor(options, server) {
         super();
         if (!options)
@@ -1683,8 +1679,8 @@ export class StaticFilesPlugin extends Plugin {
         this.etag = options.etag !== false;
         this.maxAge = options.maxAge;
         this.errors = options.errors;
+        this.checkPrecompressedGzip = options.precompressedGzip;
         this.prefix = ('/' + (options.path?.replace(/^[.\/]*/, '') || '').replace(/\/$/, '')).replace(/\/$/, '');
-        const defSend = ServerResponse.prototype.send;
         if (server && !server.getPlugin('static')) {
             this.name = 'static'; // only first plugin instance is registered as
             const defSend = ServerResponse.prototype.send;
@@ -1744,11 +1740,27 @@ export class StaticFilesPlugin extends Plugin {
                 req.filename = filename;
                 return handler.call(this, req, res, next);
             }
-            this.serveFile(req, res, {
-                path: filename,
-                mimeType,
-                stats
-            });
+            if (this.checkPrecompressedGzip && (req.headers['accept-encoding'] || '').includes('gzip')) {
+                const gzipped = filename + '.gz';
+                fs.stat(gzipped, (err, statsGz) => {
+                    if (!err && statsGz.isFile()) {
+                        res.setHeader('Content-Encoding', 'gzip');
+                        filename = gzipped;
+                        stats = statsGz;
+                    }
+                    this.serveFile(req, res, {
+                        path: filename,
+                        mimeType,
+                        stats
+                    });
+                });
+            }
+            else
+                this.serveFile(req, res, {
+                    path: filename,
+                    mimeType,
+                    stats
+                });
         });
     }
     /** Send static file */
@@ -1802,9 +1814,9 @@ export class StaticFilesPlugin extends Plugin {
             statRes(null, options.stats);
     }
 }
+/** Reverse proxy plugin, At least remote url as string or in ProxyOptions is required */
 export class ProxyPlugin extends Plugin {
     priority = 120;
-    name = 'proxy';
     /** Default valid headers */
     static validHeaders = {
         authorization: true,
@@ -1838,6 +1850,8 @@ export class ProxyPlugin extends Plugin {
             options = { remote: options };
         if (!options.remote)
             throw new Error('Invalid param');
+        if (server && !server.getPlugin('proxy'))
+            this.name = 'proxy';
         this.remoteUrl = new URL(options.remote);
         this.regex = options.match ? new RegExp(options.match) : undefined;
         this.headers = options.headers;
@@ -2278,6 +2292,7 @@ export class AuthPlugin extends Plugin {
     }
 }
 // #endregion AuthPlugin
+/** Load standard plugins with predefined configs: MethodsPlugin, CorsPlugin, TrustProxyPlugin, BodyPlugin, AuthPlugin, StaticFilesPlugin */
 export class StandardPlugins extends Plugin {
     constructor(options, server) {
         super();
@@ -2293,9 +2308,9 @@ export class StandardPlugins extends Plugin {
         use(MethodsPlugin);
         use(CorsPlugin, 'cors');
         use(TrustProxyPlugin, 'trustproxy');
+        use(AuthPlugin, 'auth');
         use(BodyPlugin);
         use(StaticFilesPlugin, 'static');
-        use(AuthPlugin, 'auth');
     }
 }
 /**
@@ -2763,7 +2778,7 @@ export class Models {
 }
 export class Model {
     static collections = new ModelCollectionsInternal();
-    static models = {};
+    static models = new Models();
     static set db(db) {
         this.collections.db = db;
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@radatek/microserver",
-  "version": "3.0.6",
+  "version": "3.0.7",
   "description": "HTTP MicroServer",
   "author": "Darius Kisonas",
   "license": "MIT",