@radatek/microserver 2.0.2 → 2.1.0

package/dist/microserver.d.ts

@@ -1,6 +1,6 @@
 /**
  * MicroServer
- * @version 2.0.2
+ * @version 2.1.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);
@@ -40,7 +41,6 @@ export declare abstract class Plugin {
     name?: string;
     priority?: number;
     handler?(req: ServerRequest, res: ServerResponse, next: Function): void;
-    controller?: typeof Controller;
     routes?: () => Routes | Routes;
     constructor(router: Router, ...args: any);
 }
@@ -65,8 +65,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 +117,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 {
@@ -376,7 +379,7 @@ export declare class MicroServer extends EventEmitter {
     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} */
+    /** Add middleware, routes, etc.. see {router.use} */
     use(...args: any): MicroServer;
     /** Default server handler */
     handler(req: ServerRequest, res: ServerResponse): void;
@@ -389,17 +392,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 +434,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 */

package/dist/microserver.js

@@ -1,6 +1,6 @@
 /**
  * MicroServer
- * @version 2.0.2
+ * @version 2.1.0
  * @package @radatek/microserver
  * @copyright Darius Kisonas 2022
  * @license MIT
@@ -12,7 +12,7 @@ import tls from 'tls';
 import querystring from 'querystring';
 import { Readable } from 'stream';
 import fs from 'fs';
-import path from 'path';
+import path, { basename, extname } from 'path';
 import crypto from 'crypto';
 import zlib from 'zlib';
 import { EventEmitter } from 'events';
@@ -92,8 +92,8 @@ export class ServerRequest extends http.IncomingMessage {
         this.pathname = pathname;
         this.path = pathname.slice(pathname.lastIndexOf('/'));
         this.baseUrl = pathname.slice(0, pathname.length - this.path.length);
-        this.get = {};
-        parsedUrl.searchParams.forEach((v, k) => this.get[k] = v);
+        this.query = {};
+        parsedUrl.searchParams.forEach((v, k) => this.query[k] = v);
     }
     /** Rewrite request url */
     rewrite(url) {
@@ -313,8 +313,9 @@ export class ServerResponse extends http.ServerResponse {
         this.statusCode = 200;
     }
     /** Send error reponse */
-    error(error, text) {
+    error(error) {
         let code = 0;
+        let text;
         if (error instanceof Error) {
             if ('statusCode' in error)
                 code = error.statusCode;
@@ -322,7 +323,7 @@ export class ServerResponse extends http.ServerResponse {
         }
         else if (typeof error === 'number') {
             code = error;
-            text = text || commonCodes[code] || 'Error';
+            text = commonCodes[code] || 'Error';
         }
         else
             text = error.toString();
@@ -399,19 +400,17 @@ export class ServerResponse extends http.ServerResponse {
         this.send(data);
     }
     /** Send json response in form { success: false, error: err } */
-    jsonError(error, code) {
+    jsonError(error) {
         this.isJson = true;
-        this.statusCode = code || 200;
         if (typeof error === 'number')
-            [code, error] = [error, http.STATUS_CODES[error] || 'Error'];
+            error = http.STATUS_CODES[error] || 'Error';
         if (error instanceof Error)
             return this.json(error);
         this.json(typeof error === 'string' ? { success: false, error } : { success: false, ...error });
     }
     /** Send json response in form { success: true, ... } */
-    jsonSuccess(data, code) {
+    jsonSuccess(data) {
         this.isJson = true;
-        this.statusCode = code || 200;
         if (data instanceof Error)
             return this.json(data);
         this.json(typeof data === 'string' ? { success: true, message: data } : { success: true, ...data });
@@ -427,6 +426,18 @@ export class ServerResponse extends http.ServerResponse {
         this.statusCode = code || 302;
         this.end();
     }
+    /** Set status code */
+    status(code) {
+        this.statusCode = code;
+        return this;
+    }
+    download(path, filename) {
+        StaticPlugin.serveFile(this.req, this, {
+            path: path,
+            filename: filename || basename(path),
+            mimeType: StaticPlugin.mimeTypes[extname(path)] || 'application/octet-stream'
+        });
+    }
 }
 const EMPTY_BUFFER = Buffer.alloc(0);
 const DEFLATE_TRAILER = Buffer.from([0x00, 0x00, 0xff, 0xff]);
@@ -1193,8 +1204,6 @@ export class Router extends EventEmitter {
             else
                 this.use(plugin.routes);
         }
-        if (plugin.controller)
-            this.use(plugin.controller);
         return this;
     }
     /** Add hook */
@@ -1438,7 +1447,7 @@ export class MicroServer extends EventEmitter {
             throw new Error('Invalid middleware: ' + String.toString.call(fn));
         return fn.bind(this);
     }
-    /** Add middleware, routes, etc.. see {Router.add} */
+    /** Add middleware, routes, etc.. see {router.use} */
     use(...args) {
         this.router.use(...args);
         return this;
@@ -1587,32 +1596,37 @@ export class MicroServer extends EventEmitter {
             this.emit('close');
         });
     }
-    /** Add route, alias to `server.router.add('GET ' + url, ...args)` */
+    /** Add route, alias to `server.router.use(url, ...args)` */
+    all(url, ...args) {
+        this.router.use(url, ...args);
+        return this;
+    }
+    /** Add route, alias to `server.router.use('GET ' + url, ...args)` */
     get(url, ...args) {
         this.router.use('GET ' + url, ...args);
         return this;
     }
-    /** Add route, alias to `server.router.add('POST ' + url, ...args)` */
+    /** Add route, alias to `server.router.use('POST ' + url, ...args)` */
     post(url, ...args) {
         this.router.use('POST ' + url, ...args);
         return this;
     }
-    /** Add route, alias to `server.router.add('PUT ' + url, ...args)` */
+    /** Add route, alias to `server.router.use('PUT ' + url, ...args)` */
     put(url, ...args) {
         this.router.use('PUT ' + url, ...args);
         return this;
     }
-    /** Add route, alias to `server.router.add('PATCH ' + url, ...args)` */
+    /** Add route, alias to `server.router.use('PATCH ' + url, ...args)` */
     patch(url, ...args) {
         this.router.use('PATCH ' + url, ...args);
         return this;
     }
-    /** Add route, alias to `server.router.add('DELETE ' + url, ...args)` */
+    /** Add route, alias to `server.router.use('DELETE ' + url, ...args)` */
     delete(url, ...args) {
         this.router.use('DELETE ' + url, ...args);
         return this;
     }
-    /** Add websocket handler, alias to `server.router.add('WEBSOCKET ' + url, ...args)` */
+    /** Add websocket handler, alias to `server.router.use('WEBSOCKET ' + url, ...args)` */
     websocket(url, ...args) {
         this.router.use('WEBSOCKET ' + url, ...args);
         return this;
@@ -1697,7 +1711,7 @@ class StaticPlugin extends Plugin {
             options = {};
         if (typeof options === 'string')
             options = { path: options };
-        this.mimeTypes = { ...StaticPlugin.mimeTypes, ...options.mimeTypes };
+        this.mimeTypes = options.mimeTypes ? { ...StaticPlugin.mimeTypes, ...options.mimeTypes } : Object.freeze(StaticPlugin.mimeTypes);
         this.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);
         this.index = options.index || 'index.html';
@@ -1714,7 +1728,7 @@ class StaticPlugin extends Plugin {
         let filename = path.normalize(path.join(this.root, (req.params && req.params.path) || req.pathname));
         if (!filename.startsWith(this.root)) // check root access
             return next();
-        const firstch = path.basename(filename)[0];
+        const firstch = basename(filename)[0];
         if (firstch === '.' || firstch === '_') // hidden file
             return next();
         if (filename.endsWith(path.sep))
@@ -1736,27 +1750,61 @@ class StaticPlugin extends Plugin {
                 req.filename = filename;
                 return handler.call(this, req, res, next);
             }
-            const etagMatch = req.headers['if-none-match'];
-            const etagTime = req.headers['if-modified-since'];
-            const etag = '"' + etagPrefix + stats.mtime.getTime().toString(32) + '"';
-            res.setHeader('Content-Type', mimeType);
-            if (this.lastModified || req.params.lastModified)
+            StaticPlugin.serveFile(req, res, {
+                path: filename,
+                mimeType,
+                stats
+            });
+        });
+    }
+    static serveFile(req, res, options) {
+        const filePath = options.root ? path.join(options.root, options.path) : options.path;
+        const statRes = (err, stats) => {
+            if (err)
+                return res.error(err);
+            if (!stats.isFile())
+                return res.error(404);
+            if (!res.getHeader('Content-Type')) {
+                if (options.mimeType)
+                    res.setHeader('Content-Type', options.mimeType);
+                else
+                    res.setHeader('Content-Type', this.mimeTypes[path.extname(options.path)] || 'application/octet-stream');
+            }
+            if (options.filename)
+                res.setHeader('Content-Disposition', 'attachment; filename="' + options.filename + '"');
+            if (options.lastModified !== false)
                 res.setHeader('Last-Modified', stats.mtime.toUTCString());
-            if (this.etag || req.params.etag)
-                res.setHeader('Etag', etag);
-            if (this.maxAge || req.params.maxAge)
-                res.setHeader('Cache-Control', 'max-age=' + (this.maxAge || req.params.maxAge));
+            res.setHeader('Content-Length', stats.size);
+            if (options.etag !== false) {
+                const etag = '"' + etagPrefix + stats.mtime.getTime().toString(32) + '"';
+                if (req.headers['if-none-match'] === etag || req.headers['if-modified-since'] === stats.mtime.toUTCString()) {
+                    res.statusCode = 304;
+                    res.headersOnly = true;
+                }
+            }
+            if (options.maxAge)
+                res.setHeader('Cache-Control', 'max-age=' + options.maxAge);
             if (res.headersOnly) {
-                res.setHeader('Content-Length', stats.size);
-                return res.end();
+                res.end();
+                return;
             }
-            if (etagMatch === etag || etagTime === stats.mtime.toUTCString()) {
-                res.statusCode = 304;
-                return res.end();
+            const streamOptions = { start: 0, end: stats.size - 1 };
+            if (options.range !== false) {
+                const range = req.headers['range'];
+                if (range && range.startsWith('bytes=')) {
+                    const parts = range.slice(6).split('-');
+                    streamOptions.start = parseInt(parts[0]) || 0;
+                    streamOptions.end = parts[1] ? parseInt(parts[1]) : stats.size - 1;
+                    res.setHeader('Content-Range', `bytes ${streamOptions.start}-${streamOptions.end}/${stats.size}`);
+                    res.setHeader('Content-Length', streamOptions.end - streamOptions.start + 1);
+                }
             }
-            res.setHeader('Content-Length', stats.size);
-            fs.createReadStream(filename).pipe(res);
-        });
+            fs.createReadStream(filePath, streamOptions).pipe(res);
+        };
+        if (!options.stats)
+            fs.stat(filePath, statRes);
+        else
+            statRes(null, options.stats);
     }
 }
 /** Default mime types */
@@ -1770,12 +1818,17 @@ StaticPlugin.mimeTypes = {
     '.css': 'text/css',
     '.png': 'image/png',
     '.jpg': 'image/jpeg',
-    '.mp3': 'audio/mpeg',
     '.svg': 'image/svg+xml',
+    '.mp3': 'audio/mpeg',
+    '.ogg': 'audio/ogg',
+    '.mp4': 'video/mp4',
     '.pdf': 'application/pdf',
     '.woff': 'application/x-font-woff',
     '.woff2': 'application/x-font-woff2',
-    '.ttf': 'application/x-font-ttf'
+    '.ttf': 'application/x-font-ttf',
+    '.gz': 'application/gzip',
+    '.zip': 'application/zip',
+    '.tgz': 'application/gzip',
 };
 MicroServer.plugins.static = StaticPlugin;
 export class ProxyPlugin extends Plugin {
@@ -2201,7 +2254,7 @@ class AuthPlugin extends Plugin {
         if (sid)
             token = sid.slice(sid.indexOf('=') + 1);
         if (!token)
-            token = req.get.token;
+            token = req.query.token;
         if (token) {
             const now = new Date().getTime();
             let usr, expire;
@@ -2794,7 +2847,7 @@ export class Model {
     /** Microserver middleware */
     handler(req, res) {
         res.isJson = true;
-        let filter, filterStr = req.get.filter;
+        let filter, filterStr = req.query.filter;
         if (filterStr) {
             try {
                 if (!filterStr.startsWith('{'))

package/package.json

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

package/readme.md

@@ -1,35 +1,36 @@
 ## HTTP MicroServer
 
-Lightweight all-in-one http web server
+Lightweight all-in-one http web server without dependencies
 
 Features:
   - fast REST API router
   - form/json body decoder
   - file upload
+  - websockets
   - authentication
   - plain/hashed passwords
   - virtual hosts
   - static files
+  - rewrite
+  - redirect
   - reverse proxy routes
   - trust ip for reverse proxy
   - json file storage with autosave
-  - websockets (single file module from ws package)
   - tls with automatic certificate reload
   - data model with validation and mongodb interface
-  - simple file/memory storage adapter for model
+  - simple file/memory storage
   - promises as middleware
   - controller class
   - access rights per route
   - access rights per model field
-  - rewrite
-  - redirect
-  - express like interface
 
 ### Usage examples:
 
 Simple router:
 
 ```ts
+import { MicroServer, AccessDenied } from '@radatek/microserver'
+
 const server = new MicroServer({
   listen: 8080,
   auth: {
@@ -47,7 +48,7 @@ server.use('POST /api/login',
   (req: ServerRequset, res: ServerResponse) =>
   {
     const user = await req.auth.login(req.body.user, req.body.password)
-    return user ? {user} : 403
+    return user ? {user} : new AccessDenied()
   })
 server.use('GET /api/protected', 'acl:auth',
   (req: ServerRequset, res: ServerResponse) =>
@@ -55,49 +56,14 @@ server.use('GET /api/protected', 'acl:auth',
 server.use('static', {root:'public'})
 ```
 
-Using `Controller` class:
-
-```ts
-class RestApi extends Controller {
-  static acl = '' // default acl
-
-  gethello(id) {
-    return {message:'Hello ' + id + '!'}
-  }
-
-  async postlogin() {
-    const user = await this.auth.login(this.body.user, this.body.password)
-    return user ? {user} : 403
-  }
-
-  static 'acl:protected' = 'user'
-  static 'url:protected' = 'GET /protected'
-  protected() {
-    return {message:'Protected'}
-  }
-}
-
-const server = new MicroServer({
-  listen: 8080,
-  auth: {
-    users: {
-      usr: {
-        password: 'secret',
-        acl: {user: true}
-      }
-    }
-  }
-})
-server.use('/api', RestApi)
-```
-
-`Model.handler` automatically detects usage for standard functions: get,insert,update,delete
+Using data schema:
 
 ```js
-import { MicroServer, Model, MicroCollection, FileStore } from '@dariuski/microserver'
+import { MicroServer, Model, MicroCollection, FileStore } from '@radatek/microserver'
 
 const usersCollection = new MicroCollection({ store: new FileStore({ dir: 'data' }), name: 'users' })
-//const usersCollection = await db.collection('users')
+// or using MicroDB collection
+const usersCollection = await db.collection('users')
 
 const userProfile = new Model({
   _id: 'string',
@@ -115,7 +81,7 @@ const server = new MicroServer({
   }
 })
 
-userProfile.insert({name: 'admin', password: 'secret', role: 'admin', acl: {'user/*': true}})
+await userProfile.insert({name: 'admin', password: 'secret', role: 'admin', acl: {'user/*': true}})
 
 server.use('POST /login', async (req) => {
   const user = await req.auth.login(req.body.user, req.body.password)
@@ -134,3 +100,40 @@ server.use('PUT /admin/user/:id', 'acl:user/update', userProfile)
 // delete user if has acl 'user/update'
 server.use('DELETE /admin/user/:id', 'acl:user/delete', userProfile)
 ```
+
+Using controller:
+
+```ts
+const server = new MicroServer({
+  listen: 8080,
+  auth: {
+    users: {
+      usr: {
+        password: 'secret',
+        acl: {user: true}
+      }
+    }
+  }
+})
+
+class RestApi extends Controller {
+  static acl = '' // default acl
+
+  gethello(id) {
+    return {message:'Hello ' + id + '!'}
+  }
+
+  async postlogin() {
+    const user = await this.auth.login(this.body.user, this.body.password)
+    return user ? {user} : 403
+  }
+
+  static 'acl:protected' = 'user'
+  static 'url:protected' = 'GET /protected'
+  protected() {
+    return {message:'Protected'}
+  }
+}
+
+server.use('/api', RestApi)
+```