Bonsai is a japanese art of growing and shaping miniature trees in containers
As the version implies (v0.x.x), this API is not yet stable and can be breaking changed without warnings.
BunSai is a full-stack, zero dependency, agnostic framework for the web, built upon Bun (in fact, it has Nunjucks, Sass and Stylus as optional dependencies). You can install it:
bun add bunsai
And use it as a handler:
import BunSai from "bunsai";
const { fetch } = new BunSai({
/* ... */
});
Bun.serve({
fetch,
});
Powered by Bun.FileSystemRouter and some fancy tricks, BunSai takes an approach where you declare the files you want to become "routes"
new BunSai({
loaders: {
".ext": loaderInitiator,
},
});
And all files with that file extension will be served as routes.
Lets say you have the following files:
pages
├── index.njk
├── settings.tsx
├── blog
│ ├── [slug].svelte
│ └── index.ts
└── [[...catchall]].vue
You can configure BunSai to serve those files:
new BunSai({
loaders: {
".njk": nunjucksLoaderInit,
".ts": apiLoaderInit,
".tsx": reactLoaderInit,
".svelte": svelteLoaderInit,
".vue": vueLoaderInit,
},
});
Check the
LoaderInitiatorinterface
You can also specify file extensions that will be served staticly (return new Response(Bun.file(filePath))), like so:
new BunSai({
staticFiles: [".jpg", ".css", ".aac"],
});
There is a caveat around
staticFiles: as all files are served using the FileSystemRouter,pages/pic.jpegwill be served as/pic
BunSai is 100% flexible, but this does not mean that it cannot be opinionated. BunSai ships with built-in (optional) loaders:
Since v0.1.0. Last change v0.3.0
Nunjucks is a rich powerful templating language with block inheritance, autoescaping, macros, asynchronous control, and more. Heavily inspired by jinja2.
bun add nunjucks @types/nunjucks
import getNunjucksLoader from "bunsai/loaders/nunjucks";
const nunjucks =
getNunjucksLoader(/* (optional) root path and nunjucks configure options */);
new BunSai({
loaders: {
".njk": nunjucks.loaderInit,
},
});
nunjucks.env;
// you can make changes on the nunjucks Environment object (the 'nunjuck.env' object),
// **after** BunSai instance creation.
// See https://mozilla.github.io/nunjucks/api.html#environment
<body>
{# 'server', 'route' and 'request' #}
<p>
All those objects are passed to the Nunjucks renderer to be available
globally
</p>
</body>
Since v0.1.0. Last change v0.2.0
Sass is the most mature, stable, and powerful professional grade CSS extension language in the world.
bun add sass
import getSassLoader from "bunsai/loaders/sass";
const loaderInit = getSassLoader(/* (optional) sass compiler options */);
new BunSai({
loaders: {
".scss": loaderInit,
},
});
Since v0.3.0
Stylus is an expressive, robust, feature-rich CSS language. It's compiler is a bit less performant than Sass, but I thought it was a nice feature to add.
bun add stylus
import getStylusLoader from "bunsai/loaders/stylus";
const loaderInit = getStylusLoader(/* (optional) stylus compiler options */);
new BunSai({
loaders: {
".styl": loaderInit,
},
});
Since v0.1.0. Last change v0.3.0
BunSai offers a simple module implementation to handle .ts, .tsx, .js and .node files:
import { ModuleLoaderInit } from "bunsai/loaders";
new BunSai({
loaders: {
".ts": ModuleLoaderInit,
},
});
A server module is a regular TS/TSX/JS/NAPI (anything that Bun can import) file that have the following structure:
// optional
export const headers = {
// All reponse headers go here.
// The default Content-Type header is "text/html; charset=utf-8", but you can override it.
};
// optional
export function invalidate(data: ModuleData) {
/**
* Returning true will invalidate the cached result, deleting it from the disk and rerunning the handler.
*
* If this method is not implemented, the ModuleLoader will always run the handler.
*
* **NOTE:** caching is ignored if dev mode is enabled.
*/
}
// required
export function handler(data: ModuleData) {
// data.server => Server
// data.route => MatchedRoute
// data.request => Request
// The handler must return a BodyInit or an instance of Response, whether synchronously or asynchronously.
// If Response is returned, the loader will send it and the "headers" export will be ignored.
}
Since v0.1.0. Last change v0.3.0
If you liked BunSai's opinion and want to enjoy all this beauty, you can use the recommended configuration:
import getRecommended from "bunsai/recommended";
// NOTE: Stylus is not included in the recommended interface
const { loaders, staticFiles, middlewares, nunjucks } =
getRecommended(/* (optional) nunjucks and sass options */);
new BunSai({
loaders,
staticFiles,
middlewares,
});
// Get nunjucks environment **after** BunSai instance creation
nunjucks.env();
Check the
Recommendedinterface.
Middlewares can be used both on "start up" and during lifetime.
Since v0.3.0
Builtin middlewares are Middleware class extensions and can be used on BunSai construction:
new BunSai({
middlewares: [new Middleware()],
});
And during lifetime (using the inject static method):
const { middlewares } = new BunSai();
Middleware.inject(middlewares /*, ... constructor args */);
At this moment, BunSai ships with:
import DDOS from "bunsai/middlewares/ddos"import CORS, { CORSPreflight, CORSResponse } from "bunsai/middlewares/cors"To ask for more middlewares, click here
A distributable middleware should extend the Middleware abstract class
import Middleware from "bunsai/internals/middleware";
export default class MyMiddleware extends Middleware<
"response" | "request" | "notFound" | "error"
> {
name = "unique name";
runsOn = "response" | "request" | "notFound" | "error";
protected $runner: MiddlewareRunnerWithThis<MiddlewareData, this> = function (
data
) {
// middleware implementation
};
}
During lifetime, BunSai categorizes middlewares into 4 groups:
Since v0.1.0. Last change v0.2.0
You can use response middlewares to override or customize the response given by the loader.
const { middlewares } = new BunSai(/* ... */);
middlewares.response
.add("name", (data) => {
// you can stop the middleware execution chain by returning a Response
// if you want to stop the chain and override the response, return a new Response object
return new Response();
// if you want to just stop the chain, return the same Response object
return data.response;
})
.add(/* can be chained */);
middlewares.response.remove("name").remove(/* can be chained */);
Since v0.1.0. Last change v0.2.0
You can use request middlewares to do things before anything else, like sending an early response (e.g. 429 Too Many Requests).
const { middlewares } = new BunSai(/* ... */);
middlewares.request
.add("name", (data) => {
// returning a response on the 'request' phase will stop both the middleware execution chain and all other operations,
// sending the given response to the client.
return new Response();
})
.add(/* can be chained */);
middlewares.request.remove("name").remove(/* can be chained */);
Since v0.1.0. Last change v0.2.0
"Not Found" middlewares are only called when the router did not found the asset. The main purpose of the NF middleware is to override the default behavior (sending an empty 404 response).
const { middlewares } = new BunSai(/* ... */);
middlewares.notFound
.add("name", (data) => {
/* ... */
})
.add(/* can be chained */);
middlewares.notFound.remove("name").remove(/* can be chained */);
Since v0.3.0
"Error" middlewares are only called when something went really wrong. The main purpose of the error middleware is to override the default behavior (let Bun handle it).
const { middlewares } = new BunSai(/* ... */);
middlewares.error
.add("name", (data) => {
/* ... */
})
.add(/* can be chained */);
middlewares.error.remove("name").remove(/* can be chained */);
Since v0.3.0
Router was designed to be a facilitator in building APIs that use the Module loader.
It makes more sense to use Router on files that use the following filename syntaxes: [...catch-all] | [[...optional-catch-all]] | [dynamic]
The Router is a simple utility that abstracts the workflow of an HTTP API. HTTP methods are classified as class methods.
405 Method Not Allowed (e.g.);true for the given path, the Router returns 404 Not Found;501 Not Implemented is returned and with the following status text: '%pathname%' handlers returned nothing;String.endsWith approach, except if the string is '*' which has the default wildcard behavior;regex.test(route.pathname) will be used;true if the request should be accepted;Array.some approach will be used;// pages/[...fun].ts
import { Router } from "bunsai/util";
// or
import Router from "bunsai/util/router";
// a function matcher should always be a unique named function,
// to avoid the MiddlewareChannel error "'' already exists on this middleware channel"
// (Router uses MiddlewareChannel under the hood).
function matcher({ pathname }) {
return pathname == "/c";
}
export const { handler } = new Router()
.get("/a", ({ response }) =>
// You can set the response using the 'response' method, thus not breaking the call chain
// and also allowing other handlers to access the response by calling 'response()'
response(new Response(null, { status: 204 }))
)
.post(
/\/b/,
() => {
// Or you can return a response and break the call chain.
// This is the fastest way, but you must have in mind that this will be the last called handler
return new Response(null, { status: 206 });
},
() => {
// This handler will never be called
}
)
.put(matcher, () => {})
.delete(/* ... */);
headers object will be ignored by the loader."*".matcher.name ?? matcher.toString().Error: '' already exists on this middleware channel when declaring two unnamed functions on the GET channel (e.g.).FAQs
SSR Engine for Bun
The npm package bunsai receives a total of 0 weekly downloads. As such, bunsai popularity was classified as not popular.
We found that bunsai demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Research
A malicious npm package disguised as a WhatsApp client is exploiting authentication flows with a remote kill switch to exfiltrate data and destroy files.
Security News
PyPI now supports digital attestations, enhancing security and trust by allowing package maintainers to verify the authenticity of Python packages.
Security News
GitHub removed 27 malicious pull requests attempting to inject harmful code across multiple open source repositories, in another round of low-effort attacks.