Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/narazaka/shiorack.js
Middleware based Ukagaka SHIORI subsystem interface builder inspired by rack and koa
https://github.com/narazaka/shiorack.js
shiori ukagaka
Last synced: about 1 month ago
JSON representation
Middleware based Ukagaka SHIORI subsystem interface builder inspired by rack and koa
- Host: GitHub
- URL: https://github.com/narazaka/shiorack.js
- Owner: Narazaka
- Created: 2018-02-11T06:16:46.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2020-12-29T11:46:56.000Z (about 4 years ago)
- Last Synced: 2024-04-25T12:43:53.484Z (8 months ago)
- Topics: shiori, ukagaka
- Language: TypeScript
- Size: 245 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: Readme.md
Awesome Lists containing this project
README
# [shiorack.js](https://github.com/Narazaka/shiorack.js)
[](https://www.npmjs.com/package/shiorack)
[](https://www.npmjs.com/package/shiorack)
[](https://www.npmjs.com/package/shiorack)
[](https://www.npmjs.com/package/shiorack)
[](https://david-dm.org/Narazaka/shiorack.js)
[](https://david-dm.org/Narazaka/shiorack.js?type=dev)
[](https://github.com/Narazaka/shiorack.js/actions?query=workflow:build)
[](https://codecov.io/github/Narazaka/shiorack.js?branch=master)
Middleware based Ukagaka SHIORI subsystem interface builder inspired by rack and koa
## Install
```bash
npm install shiorack
```
## Usage
```typescript
///
import { NoContent, OK, wrapRequestCallback } from "shiori-request-helper";
import * as ShioriJK from "shiorijk";
import { ShioriBuilder } from "shiorack";
interface HeadersState {
defaultHeaders: { [name: string]: string };
}
const builder = new ShioriBuilder()
.use({
state: {} as { dirpath: string },
// set dirpath
load: (ctx, next) => {
ctx.state.dirpath = ctx.dirpath;
return next();
},
// exit
unload: async (_ctx, next) => {
await next();
process.exit();
},
})
.use({
state: {
defaultHeaders: { Charset: "UTF-8" },
} as HeadersState,
// error handler
request: async (ctx, next) => {
try {
return await next();
} catch (error) {
return new ShioriJK.Message.Response({
status_line: { code: 400, version: "3.0" },
headers: {
...ctx.state.defaultHeaders,
"X-Shiori-Error": error.message.replace(/\r?\n/g, "\\n"),
},
});
}
},
})
// ignore OnTranslate
.useRequest((ctx, next) => {
if (ctx.request.headers.ID === "OnTranslate") {
return new ShioriJK.Message.Response({
status_line: { code: 400, version: "3.0" },
headers: {
Charset: "UTF-8",
},
});
}
return next();
})
// set ghost name to sender
.useRequest((ctx, next) => {
if (ctx.request.headers.ID === "ownerghostname") {
const sender = ctx.request.headers.Reference(0);
if (typeof sender === "string" && sender.length) {
ctx.state.defaultHeaders.Sender = sender;
ctx.state.sender = sender;
}
}
return next();
}, {} as { sender: string });
// process request events
const requestCallback = wrapRequestCallback(
(request: ShioriJK.Message.Request) => {
switch (request.headers.ID) {
case "OnBoot":
return OK("\\h\\s[0]hello.\\e");
default:
return NoContent();
}
},
builder.state.defaultHeaders
);
const builder2 = builder.useRequest((ctx) => requestCallback(ctx.request));
export default builder2.build(); // build SHIORI interface
```
```bash
shiolinkjs ./myShiori.js
```
## API Document
[https://narazaka.github.io/shiorack.js/](https://narazaka.github.io/shiorack.js/)
## License
This is released under [MIT License](http://narazaka.net/license/MIT?2018).