Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/xeaone/server
X-Server a Deno server module with middleware
https://github.com/xeaone/server
deno framework javascript library module server session typescript
Last synced: 2 months ago
JSON representation
X-Server a Deno server module with middleware
- Host: GitHub
- URL: https://github.com/xeaone/server
- Owner: xeaone
- License: mit
- Created: 2022-03-28T19:25:47.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2024-05-30T22:46:09.000Z (8 months ago)
- Last Synced: 2024-11-08T02:49:34.534Z (2 months ago)
- Topics: deno, framework, javascript, library, module, server, session, typescript
- Language: TypeScript
- Homepage:
- Size: 166 KB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://deno.land/x/xserver)
[](https://github.com/xeaone/server/actions/workflows/codeql-analysis.yml)
# X-Server
Deno server module with built in middleware.
## Use
https://deno.land/x/xserver/src/mod.ts
## Example
```ts
import { Handler, Normalize, Router, Server } from 'https://deno.land/x/xserver/src/mod.ts';
const router = new Router();
const handler = new Handler();
const normalize = new Normalize();
normalize.any('/*', true);
router.get('/*', (context) => context.html`
Hello World
`);
router.post('/*', (context) => context.ok({ message: 'posted' }));
handler.add(normalize);
handler.add(router);
Server((request) => handler.handle(request));
```
### Server
Wraps Deno.serve
### Handler
Constructor that stores the middleware/plugins/tools used on each request.
```ts
import { Handler, Normalize, Server } from 'https://deno.land/x/xserver/src/mod.ts';
const handler = new Handler();
const normalize = new Normalize();
handler.add(normalize);
Server((request) => handler.handle(request));
```
### Normalize
Constructor Plugin that will remove `index.html`, `.html`, and `//` from the url then redirect. Optionally you can redirect `http` to `https` and `www` to `non-www`.
```ts
import { Normalize } from 'https://deno.land/x/xserver/src/mod.ts';
const normalize = new Normalize();
normalize.www(true); // redirects www to non www
normalize.https(true); // redirects http to https
normalize.any('/*', true); // any method and any path Normalize
```
### Cors
Constructor Plugin that will add cors header.
```ts
import { Cors } from 'https://deno.land/x/xserver/src/mod.ts';
const cors = new Cors();
cors.get('/foo', 'https://foo.com/'); // get method test path and CORS on only foo.com domain
cors.any('/*', '*'); // any method any path and CORS on any domain
```
### Payload
Constructor Plugin that will parse the request body.
```ts
import { Payload } from 'https://deno.land/x/xserver/src/mod.ts';
const payload = new Payload();
payload.parse('json'); // default is json
payload.post('/*', true); // post method any path
```
### Router
Constructor Plugin that will route request to a handle method.
```ts
import { Router } from 'https://deno.land/x/xserver/src/mod.ts';
const router = new Router();
router.post('/*', (context) => context.ok('hello world')); // post method any path
```
### File
Constructor Plugin that will serve files. SPA mode will route all non existent files in the path folder to the `/index.html`.
```ts
import { File } from 'https://deno.land/x/xserver/src/mod.ts';
const file = new File();
file.spa(true);
file.path('./web');
file.get('/*', true); // get method any path serve files from the ./web folder
```
### Session
Constructor Plugin that will provide session using Secure Session Cookies https://tools.ietf.org/html/rfc6896.
```ts
import { Session } from 'https://deno.land/x/xserver/src/mod.ts';
const sessions = new Map();
const session = new Session();
session.validate((context) => {
const { session } = context.tool.session.data;
// return a response to prevent access end exit the handler loop early
if (!sessions.has(session)) return context.unauthorized();
});
session.secret('secret'); // unique secret
session.signature('signature'); // unique signature
session.any('/*', true); // any method and any path is protected
session.get('/*', false); // get method any path disable session protection
session.post('/sign-up', false); // post method specific path disable session protection
session.post('/sign-in', false); // post method specific path disable session protection
```
### Forwarded
Constructor Plugin that will parse the `forwarded` header.
This is good for getting client/remote IP address behind a proxy/loadbalancer.
```ts
import { Forwarded } from 'https://deno.land/x/xserver/src/mod.ts';
import { Handler, Server } from 'https://deno.land/x/xserver/src/mod.ts';
const forwarded = new Forwarded();
const handler = new Handler();
forwarded.any('/*', true); // any method and any path parse forwarded header
handler.add(forwarded);
/*
type ForwardedData = {
by: Array;
for: Array;
host: Array;
proto: Array;
};
*/
handler.add(function (context) {
const { for: [client] } = context.tool.forwarded.data;
return context.ok(client);
});
Server((request) => handler.handle(request), { port: 8080 });
```
### Socket
Constructor Plugin that will
```ts
```