@radatek/microserver 2.0.2 → 2.2.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@radatek/microserver",
-  "version": "2.0.2",
+  "version": "2.2.0",
   "description": "HTTP MicroServer",
   "author": "Darius Kisonas",
   "license": "MIT",
@@ -11,14 +11,19 @@
     "httpserver"
   ],
   "type": "module",
-  "main": "./dist/microserver.js",
-  "module": "./dist/microserver.js",
-  "types": "./dist/microserver.d.ts",
+  "main": "microserver.ts",
   "files": [
     "dist"
   ],
   "repository": {
     "type": "git",
     "url": "git+https://github.com/radateklt/microserver.git"
+  },
+  "devDependencies": {
+    "@types/node": "^22.19.0"
+  },
+  "scripts": {
+    "build": "pnpm --package typescript dlx tsc -d -m nodenext -t es2021 microserver.ts --outDir dist && sed -Ei 's/\\\"use strict\\\";\\n\\n//g' dist/microserver.js && sed -Ei ':a;N;$!ba;s/\\n +private _[^\\n]+//g;s/export \\{\\};//g' dist/microserver.d.ts",
+    "test": "node test.ts"
   }
 }

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)
+```