@radatek/microserver 3.0.4 → 3.0.6

package/microserver.d.ts

@@ -1,6 +1,6 @@
 /**
  * MicroServer
- * @version 3.0.3
+ * @version 3.0.6
  * @package @radatek/microserver
  * @copyright Darius Kisonas 2022
  * @license MIT
@@ -86,7 +86,6 @@ export declare class ServerRequest<T = any> extends http.IncomingMessage {
     rawBody: Buffer[];
     /** Request raw body size */
     rawBodySize: number;
-    private constructor();
     /** Extend http.IncomingMessage */
     static extend(req: http.IncomingMessage, res: http.ServerResponse, server: MicroServer): ServerRequest;
     /** Check if request is ready */
@@ -115,7 +114,6 @@ export declare class ServerResponse<T = any> extends http.ServerResponse {
     readonly req: ServerRequest<T>;
     /** Should response be json */
     isJson: boolean;
-    private constructor();
     /** Extends http.ServerResponse */
     static extend(res: http.ServerResponse): void;
     /** Send error reponse */
@@ -329,8 +327,6 @@ export declare class WebSocket extends EventEmitter {
     constructor(req: ServerRequest, options?: WebSocketOptions);
     /** Close connection */
     close(reason?: number, data?: Buffer): void;
-    /** Generate WebSocket frame from data */
-    static getFrame(data: number | string | Buffer | undefined, options?: any): Buffer;
     /** Send data */
     send(data: string | Buffer): void;
     /** Send ping frame */
@@ -346,8 +342,7 @@ export declare class WebSocket extends EventEmitter {
 export declare class WebSocketPlugin extends Plugin {
     name: string;
     constructor(options?: any, server?: MicroServer);
-    private addUpgradeHandler;
-    upgradeHandler(server: MicroServer, req: ServerRequest, socket: net.Socket, head: any): void;
+    upgradeHandler(server: MicroServer, req: ServerRequest, socket: net.Socket, head: any): any;
 }
 /** Trust proxy plugin, adds `req.ip` and `req.localip` */
 export declare class TrustProxyPlugin extends Plugin {
@@ -584,22 +579,11 @@ export declare class Auth {
     };
     /** Encode token */
     encode(data: string, expire?: number): string;
-    /**
-     * Check acl over authenticated user with: `id`, `group/*`, `*`
-     * @param {string} id - to authenticate: `id`, `group/id`, `model/action`, comma separated best: true => false => def
-     * @param {boolean} [def=false] - default access
-     */
+    /** Check acl over authenticated user with: `id`, `group/*`, `*` */
     acl(id: string, def?: boolean): boolean;
-    /**
-       * Authenticate user and setup cookie
-       * @param {string|UserInfo} usr - user id used with options.users to retrieve user object. User object must contain `id` and `acl` object (Ex. usr = {id:'usr', acl:{'users/*':true}})
-       * @param {string} [psw] - user password (if used for user authentication with options.users)
-       * @param {number} [expire] - expire time in seconds (default: options.expire)
-       */
+    /** Generate token from user info */
     token(usr: string | UserInfo | undefined, psw: string | undefined, expire?: number): Promise<string | undefined>;
-    /**
-     * Authenticate user and setup cookie
-     */
+    /** Authenticate user and setup cookie */
     login(usr: string | UserInfo | undefined, psw?: string, options?: {
         expire?: number;
         salt?: string;
@@ -937,4 +921,4 @@ export declare class MicroCollection<TSchema extends ModelSchema = any> {
         modifiedCount: number;
     }>;
 }
-
+export {};

package/microserver.js

@@ -1,6 +1,6 @@
 /**
  * MicroServer
- * @version 3.0.3
+ * @version 3.0.6
  * @package @radatek/microserver
  * @copyright Darius Kisonas 2022
  * @license MIT
@@ -116,8 +116,11 @@ export class ServerRequest extends http.IncomingMessage {
     rawBody;
     /** Request raw body size */
     rawBodySize;
+    // @internal
     _body;
+    // @internal
     _isReady;
+    // @internal
     constructor(res, server) {
         super(new net.Socket());
         ServerRequest.extend(this, res, server);
@@ -212,6 +215,7 @@ 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);
@@ -365,9 +369,13 @@ export class MicroServer extends EventEmitter {
     config;
     /** Authorization object */
     auth;
+    // @internal
     _plugins = {};
+    // @internal
     _stack = [];
+    // @internal
     _router = new RouterPlugin();
+    // @internal
     _worker = new Worker();
     /** All sockets */
     sockets;
@@ -499,6 +507,7 @@ export class MicroServer extends EventEmitter {
         return this._worker.wait('listen');
     }
     /* 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' */
+    // @internal
     _bind(fn) {
         if (typeof fn === 'string') {
             let name = fn;
@@ -683,6 +692,7 @@ export class MicroServer extends EventEmitter {
         this._router.add(method, url, args.filter(o => o).map((o) => this._bind(o)), true);
         return this._worker.endJob();
     }
+    // @internal
     async _plugin(plugin) {
         if (plugin.handler) {
             const middleware = plugin.handler.bind(plugin);
@@ -695,7 +705,9 @@ export class MicroServer extends EventEmitter {
             if (routes)
                 await this.use(routes);
         }
-        if (plugin.handler && plugin.name) {
+        if (plugin.name) {
+            if (this._plugins[plugin.name])
+                throw new Error(`Plugin ${plugin.name} already added`);
             this._plugins[plugin.name] = plugin;
             this.emit('plugin', plugin.name);
             this.emit('plugin:' + plugin.name);
@@ -791,16 +803,23 @@ export class MicroServer extends EventEmitter {
 }
 // #region RouterPlugin
 class RouterItem {
+    // @internal
     _stack; // add if middlewares added if not last
+    // @internal
     _next; // next middlewares
+    // @internal
     _paramName; // param name if param is used
+    // @internal
     _paramWild;
+    // @internal
     _withParam; // next middlewares if param is used
+    // @internal
     _last;
 }
 class RouterPlugin extends Plugin {
     priority = 100;
     name = 'router';
+    // @internal
     _tree = {};
     constructor() {
         super();
@@ -850,6 +869,7 @@ class RouterPlugin extends Plugin {
             node._stack.push(...middlewares);
         }
     }
+    // @internal
     _getStack(path, treeItems) {
         const out = [];
         const segments = path.split('/').filter(s => s);
@@ -963,7 +983,9 @@ export class CorsPlugin extends Plugin {
 export class MethodsPlugin extends Plugin {
     priority = -90;
     name = 'methods';
+    // @internal
     _methods;
+    // @internal
     _methodsIdx;
     constructor(methods) {
         super();
@@ -987,6 +1009,7 @@ export class MethodsPlugin extends Plugin {
 export class BodyPlugin extends Plugin {
     priority = -80;
     name = 'body';
+    // @internal
     _maxBodySize;
     constructor(options) {
         super();
@@ -1041,7 +1064,9 @@ export class BodyPlugin extends Plugin {
 export class UploadPlugin extends Plugin {
     priority = -70;
     name = 'upload';
+    // @internal
     _maxFileSize;
+    // @internal
     _uploadDir;
     constructor(options) {
         super();
@@ -1131,6 +1156,10 @@ export class UploadPlugin extends Plugin {
                         const safeWriteLength = buffer.length - lookahead;
                         if (safeWriteLength > 0) {
                             lastFile.size += safeWriteLength;
+                            if (lastFile.size > this._maxFileSize) {
+                                req.setReady(new ResponseError("file too big", 413));
+                                return;
+                            }
                             fileStream.write(buffer.subarray(0, safeWriteLength));
                             buffer = buffer.subarray(safeWriteLength);
                         }
@@ -1167,10 +1196,15 @@ const EMPTY_BUFFER = Buffer.alloc(0);
 const DEFLATE_TRAILER = Buffer.from([0x00, 0x00, 0xff, 0xff]);
 /** WebSocket class */
 export class WebSocket extends EventEmitter {
+    // @internal
     _socket;
+    // @internal
     _frame;
+    // @internal
     _buffers = [EMPTY_BUFFER];
+    // @internal
     _buffersLength = 0;
+    // @internal
     _options;
     ready = false;
     constructor(req, options) {
@@ -1189,7 +1223,7 @@ export class WebSocket extends EventEmitter {
         const version = +(req.headers['sec-websocket-version'] || 0);
         const extensions = req.headers['sec-websocket-extensions'];
         const headers = [];
-        if (!key || !upgrade || upgrade.toLocaleLowerCase() !== 'websocket' || version !== 13 || req.method !== 'GET') {
+        if (!key || upgrade?.toLocaleLowerCase() !== 'websocket' || version !== 13) {
             this._abort('Invalid WebSocket request', 400);
             return;
         }
@@ -1200,12 +1234,12 @@ export class WebSocket extends EventEmitter {
             headers.push(header);
             this._options.deflate = true;
         }
-        this.ready = true;
         this._upgrade(key, headers, () => {
-            req.setReady();
+            this.ready = true;
             this.emit('open');
         });
     }
+    // @internal
     _upgrade(key, headers = [], cb) {
         const digest = crypto.createHash('sha1')
             .update(key + '258EAFA5-E914-47DA-95CA-C5AB0DC85B11')
@@ -1236,45 +1270,6 @@ export class WebSocket extends EventEmitter {
         }
         return this._sendFrame(0x88, data || EMPTY_BUFFER, () => this._socket.destroy());
     }
-    /** Generate WebSocket frame from data */
-    static getFrame(data, options) {
-        let msgType = 8;
-        let dataLength = 0;
-        if (typeof data === 'string') {
-            msgType = 1;
-            dataLength = Buffer.byteLength(data, 'utf8');
-        }
-        else if (data instanceof Buffer) {
-            msgType = 2;
-            dataLength = data.length;
-        }
-        else if (typeof data === 'number') {
-            msgType = data;
-        }
-        const headerSize = 2 + (dataLength < 126 ? 0 : dataLength < 65536 ? 2 : 8) + (dataLength && options?.mask ? 4 : 0);
-        const frame = Buffer.allocUnsafe(headerSize + dataLength);
-        frame[0] = 0x80 | msgType;
-        frame[1] = dataLength > 65535 ? 127 : dataLength > 125 ? 126 : dataLength;
-        if (dataLength > 65535)
-            frame.writeBigUInt64BE(dataLength, 2);
-        else if (dataLength > 125)
-            frame.writeUInt16BE(dataLength, 2);
-        if (dataLength && frame.length > dataLength) {
-            if (typeof data === 'string')
-                frame.write(data, headerSize, 'utf8');
-            else
-                data.copy(frame, headerSize);
-        }
-        if (dataLength && options?.mask) {
-            let i = headerSize, h = headerSize - 4;
-            for (let i = 0; i < 4; i++)
-                frame[h + i] = Math.floor(Math.random() * 256);
-            for (let j = 0; j < dataLength; j++, i++) {
-                frame[i] ^= frame[h + (j & 3)];
-            }
-        }
-        return frame;
-    }
     /** Send data */
     send(data) {
         let msgType = typeof data === 'string' ? 1 : 2;
@@ -1296,6 +1291,7 @@ export class WebSocket extends EventEmitter {
         else
             return this._sendFrame(0x80 | msgType, data);
     }
+    // @internal
     _errorHandler(error) {
         this.emit('error', error);
         if (this.ready)
@@ -1304,6 +1300,7 @@ export class WebSocket extends EventEmitter {
             this._socket.destroy();
         this.ready = false;
     }
+    // @internal
     _headerLength(buffer) {
         if (this._frame)
             return 0;
@@ -1312,6 +1309,7 @@ export class WebSocket extends EventEmitter {
         let hederInfo = buffer[1];
         return 2 + (hederInfo & 0x80 ? 4 : 0) + ((hederInfo & 0x7F) === 126 ? 2 : 0) + ((hederInfo & 0x7F) === 127 ? 8 : 0);
     }
+    // @internal
     _dataHandler(data) {
         while (data.length) {
             let frame = this._frame;
@@ -1418,6 +1416,7 @@ export class WebSocket extends EventEmitter {
             this._buffers.push(EMPTY_BUFFER);
         }
     }
+    // @internal
     _abort(message, code, headers) {
         code = code || 400;
         message = message || http.STATUS_CODES[code] || 'Closed';
@@ -1444,6 +1443,7 @@ export class WebSocket extends EventEmitter {
     pong(buffer) {
         this._sendFrame(0x8A, buffer || EMPTY_BUFFER);
     }
+    // @internal
     _sendFrame(opcode, data, cb) {
         if (!this.ready)
             return;
@@ -1463,24 +1463,21 @@ export class WebSocket extends EventEmitter {
         else
             this._socket.write(frame, () => this._socket.write(data, cb));
     }
-    on(event, listener) { return super.on(event, listener); }
-    addListener(event, listener) { return super.addListener(event, listener); }
-    once(event, listener) { return super.once(event, listener); }
-    off(event, listener) { return super.off(event, listener); }
-    removeListener(event, listener) { return super.removeListener(event, listener); }
 }
 export class WebSocketPlugin extends Plugin {
     name = 'websocket';
+    // @internal
     _handler;
     constructor(options, server) {
         super();
         if (!server)
             throw new Error('Server instance is required');
         this._handler = this.upgradeHandler.bind(this, server);
-        server.servers?.forEach(srv => this.addUpgradeHandler(srv));
-        server.on('listen', (port, address, srv) => this.addUpgradeHandler(srv));
+        server.servers?.forEach(srv => this._addUpgradeHandler(srv));
+        server.on('listen', (port, address, srv) => this._addUpgradeHandler(srv));
     }
-    addUpgradeHandler(srv) {
+    // @internal
+    _addUpgradeHandler(srv) {
         if (!srv.listeners('upgrade').includes(this._handler))
             srv.on('upgrade', this._handler);
     }
@@ -1488,7 +1485,6 @@ export class WebSocketPlugin extends Plugin {
         const host = req.headers.host || '';
         const vhostPlugin = server.getPlugin('vhost');
         const vserver = vhostPlugin?.vhosts?.[host] || server;
-        req.method = 'WEBSOCKET';
         const res = {
             req,
             get headersSent() {
@@ -1519,7 +1515,9 @@ export class WebSocketPlugin extends Plugin {
                 socket.write(headers.join('\r\n'), () => { socket.destroy(); });
             },
             error(code) {
-                res.statusCode = code || 403;
+                if (typeof code !== 'number')
+                    code = 405;
+                res.statusCode = code || 405;
                 res.end();
             },
             send(data) {
@@ -1529,15 +1527,18 @@ export class WebSocketPlugin extends Plugin {
             setHeader() { }
         };
         ServerRequest.extend(req, res, server);
-        let _ws;
+        let ws;
         Object.defineProperty(req, 'websocket', {
             get: () => {
-                if (!_ws)
-                    _ws = new WebSocket(req, server.config.websocket);
-                return _ws;
+                if (!ws)
+                    ws = new WebSocket(req, server.config.websocket);
+                return ws;
             },
             enumerable: true
         });
+        if (req.method !== 'GET' || req.headers.upgrade?.toLowerCase() !== 'websocket')
+            return res.error(400);
+        req.method = 'WEBSOCKET';
         vserver.handler(req, res);
     }
 }
@@ -1547,6 +1548,7 @@ export class WebSocketPlugin extends Plugin {
 export class TrustProxyPlugin extends Plugin {
     priority = -60;
     name = 'trustproxy';
+    // @internal
     _trustProxy = [];
     constructor(options) {
         super();
@@ -1672,9 +1674,6 @@ export class StaticFilesPlugin extends Plugin {
             options = {};
         if (typeof options === 'string')
             options = { root: options };
-        // allow multiple instances
-        if (server && !server.getPlugin('static'))
-            this.name = 'static';
         this.mimeTypes = options.mimeTypes ? { ...StaticFilesPlugin.mimeTypes, ...options.mimeTypes } : Object.freeze(StaticFilesPlugin.mimeTypes);
         this.root = (options.root && path.isAbsolute(options.root) ? options.root : path.resolve(options.root || options?.path || 'public')).replace(/[\/\\]$/, '') + path.sep;
         this.ignore = (options.ignore || []).map((p) => path.normalize(path.join(this.root, p)) + path.sep);
@@ -1686,24 +1685,28 @@ export class StaticFilesPlugin extends Plugin {
         this.errors = options.errors;
         this.prefix = ('/' + (options.path?.replace(/^[.\/]*/, '') || '').replace(/\/$/, '')).replace(/\/$/, '');
         const defSend = ServerResponse.prototype.send;
-        ServerResponse.prototype.send = function (data) {
-            const plugin = this.req.server.getPlugin('static');
-            if (this.statusCode < 400 || this.isJson || typeof data !== 'string' || !plugin?.errors || this.getHeader('Content-Type'))
+        if (server && !server.getPlugin('static')) {
+            this.name = 'static'; // only first plugin instance is registered as
+            const defSend = ServerResponse.prototype.send;
+            ServerResponse.prototype.send = function (data) {
+                const plugin = this.req.server.getPlugin('static');
+                if (this.statusCode < 400 || this.isJson || typeof data !== 'string' || !plugin?.errors || this.getHeader('Content-Type'))
+                    return defSend.call(this, data);
+                const errFile = plugin.errors[this.statusCode] || plugin.errors['*'];
+                if (errFile)
+                    plugin.serveFile(this.req, this, { path: errFile, mimeType: 'text/html' });
                 return defSend.call(this, data);
-            const errFile = plugin.errors[this.statusCode] || plugin.errors['*'];
-            if (errFile)
-                plugin.serveFile(this.req, this, { path: errFile, mimeType: 'text/html' });
-            return defSend.call(this, data);
-        };
-        ServerResponse.prototype.file = function (path) {
-            const plugin = this.req.server.getPlugin('static');
-            if (!plugin)
-                throw new Error('Server error');
-            plugin.serveFile(this.req, this, typeof path === 'object' ? path : {
-                path,
-                mimeType: StaticFilesPlugin.mimeTypes[extname(path)] || 'application/octet-stream'
-            });
-        };
+            };
+            ServerResponse.prototype.file = function (path) {
+                const plugin = this.req.server.getPlugin('static');
+                if (!plugin)
+                    throw new Error('Server error');
+                plugin.serveFile(this.req, this, typeof path === 'object' ? path : {
+                    path,
+                    mimeType: StaticFilesPlugin.mimeTypes[extname(path)] || 'application/octet-stream'
+                });
+            };
+        }
     }
     /** Default static files handler */
     handler(req, res, next) {
@@ -1962,11 +1965,7 @@ export class Auth {
         encrypted = iv.toString('base64').slice(0, 22) + cipher.getAuthTag().toString('base64').slice(0, 22) + encrypted;
         return encrypted.replace(/==?/, '').replace(/\//g, '.').replace(/\+/g, '-');
     }
-    /**
-     * Check acl over authenticated user with: `id`, `group/*`, `*`
-     * @param {string} id - to authenticate: `id`, `group/id`, `model/action`, comma separated best: true => false => def
-     * @param {boolean} [def=false] - default access
-     */
+    /** Check acl over authenticated user with: `id`, `group/*`, `*` */
     acl(id, def = false) {
         if (!this.req?.user)
             return false;
@@ -1988,12 +1987,7 @@ export class Auth {
             access = reqAcl['*'];
         return access ?? def;
     }
-    /**
-       * Authenticate user and setup cookie
-       * @param {string|UserInfo} usr - user id used with options.users to retrieve user object. User object must contain `id` and `acl` object (Ex. usr = {id:'usr', acl:{'users/*':true}})
-       * @param {string} [psw] - user password (if used for user authentication with options.users)
-       * @param {number} [expire] - expire time in seconds (default: options.expire)
-       */
+    /** Generate token from user info */
     async token(usr, psw, expire) {
         let data;
         if (typeof usr === 'object' && usr && (usr.id || usr._id))
@@ -2009,9 +2003,7 @@ export class Auth {
         if (data)
             return this.encode(data, expire);
     }
-    /**
-     * Authenticate user and setup cookie
-     */
+    /** Authenticate user and setup cookie */
     async login(usr, psw, options) {
         let usrInfo;
         if (typeof usr === 'object')
@@ -2484,7 +2476,9 @@ export class Controller {
 // #endregion Controller
 // #region Worker
 class WorkerJob {
+    // @internal
     _promises = [];
+    // @internal
     _busy = 0;
     start() {
         this._busy++;
@@ -2502,7 +2496,9 @@ class WorkerJob {
     }
 }
 class Worker {
+    // @internal
     _id = 0;
+    // @internal
     _jobs = {};
     isBusy(id) {
         const job = this._jobs[id || 'ready'];
@@ -2531,11 +2527,17 @@ class Worker {
 }
 /** JSON File store */
 export class FileStore {
+    // @internal
     _cache;
+    // @internal
     _dir;
+    // @internal
     _cacheTimeout;
+    // @internal
     _cacheItems;
+    // @internal
     _debounceTimeout;
+    // @internal
     _iter;
     constructor(options) {
         this._cache = {};
@@ -2559,7 +2561,9 @@ export class FileStore {
             }
         }
     }
+    // @internal
     _queue = Promise.resolve();
+    // @internal
     async _sync(cb) {
         let r;
         let p = new Promise(resolve => r = resolve);
@@ -2738,8 +2742,11 @@ function newObjectId() {
     return (new Date().getTime() / 1000 | 0).toString(16) + globalObjectId.toString('hex');
 }
 class ModelCollectionsInternal {
+    // @internal
     _ready;
+    // @internal
     _wait = new Promise(resolve => this._ready = resolve);
+    // @internal
     _db;
     set db(db) {
         Promise.resolve(db).then(db => this._ready(this._db = db));
@@ -3042,6 +3049,7 @@ export class Model {
         }
         return res;
     }
+    // @internal
     _fieldFunction(value, def) {
         if (typeof value === 'string' && value.startsWith('${') && value.endsWith('}')) {
             const names = value.slice(2, -1).split('.');
@@ -3059,6 +3067,7 @@ export class Model {
             return () => def;
         return () => value;
     }
+    // @internal
     _validateField(value, options) {
         const field = options.field;
         if (value == null) {
@@ -3186,7 +3195,9 @@ export class Model {
 }
 /** Collection factory */
 export class MicroCollectionStore {
+    // @internal
     _collections = new Map();
+    // @internal
     _store;
     constructor(dataPath, storeTimeDelay) {
         if (dataPath)
@@ -3209,6 +3220,7 @@ export class MicroCollection {
     name;
     /** Collection data */
     data;
+    // @internal
     _save;
     constructor(options = {}) {
         this.name = options.name || this.constructor.name;

package/package.json

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