Artur

Artur is a modern web framework for building web applications with ease. It provides a powerful router system, middleware support, and an easy-to-use API.

Example Usage

On Bun https://bun.sh

const router = new Router();

router.use("GET", "/hello", {
  fetch: (request) => new Response("Hello world"),
});

serve({
  port: 3000,
  fetch(request) {
    return router.fetch(request);
  },
});

On NodeJS https://nodejs.org

import { createServer } from "node:http";

const router = new Router();

router.use("GET", "/hello", {
  fetch: (request) => new Response("Hello world"),
});

const server = createServer((req, res) => {
  router.requestListener(req, res);
});

// starts a simple http server locally on port 3000
server.listen(3000, "127.0.0.1", () => {
  console.log("Listening on 127.0.0.1:3000");
});

Installation

To install Artur, simply run the following command in your terminal:

npm i @jondotsoy/artur

Fetch Router

The artur/http/router module provides a router manager to handle Request/Response patterns.

import { Router, params } from "artur/http/router";

const router = new Router();

router.use("GET", "/users/:name", {
  fetch: async (request) => {
    const { name } = params(request);
    return new Response(`hello ${name}`);
  },
});

const response = await router.fetch(new Request("http://localhost/users/mark"));

expect(await response.text()).toEqual("hello mark");

Middleware

Middleware wraps the fetch function and modifies the input and output of this function.

router.use("GET", "/hello", {
  middleware: [
    (fetch) => async (request) => {
      const response = await fetch(request);
      return response;
    },
  ],
  fetch: (request) => new Response("ok"),
});

Router

The route describes how to match a request object. To describe a route, use the API Router.prototype.use(method: string, path_pattern: string).

router.use("GET", "/hello", {
  fetch: (request) => new Response("ok"),
});

Methods allowed are GET, POST, DELETE, OPTIONS, HEAD, PUT, PATCH. You can also use ALL to match any method.

The path pattern uses the URLPattern API to match the request object. If the path pattern is a string, only evaluate the pathname to evaluate the URL; use a URLPattern object otherwise.

router.use("GET", new URLPattern({ protocol: "https", pathname: "/hello" }), {
  fetch: (request) => new Response("ok"),
});

Catch Errors

By default, the router catches any error and returns a response with status 500. You can also customize the response related to an error using the describeErrorResponse function. The next sample catches a JWT message and responds with a response with status 401.

try {
  verifyHeaderAuthorization(request.headers.get('authorization'));
} catch (ex) {
  if (ex instanceof JWTError) {
    describeErrorResponse(ex, new Response(ex.message, {status: 401}));
  }
  throw ex;
}

CORS

Artur provides built-in support for Cross-Origin Resource Sharing (CORS). To enable CORS, you can use the cors() middleware function.

const router = new Router({ middlewares: [cors()] });

router.use("OPTIONS", "/hello", {
  fetch: () => new Response(null, { status: 204 }),
});

Note that this sets the Access-Control-Allow-Origin header to *, allowing requests from any origin. You can also specify a specific origin or origins by passing an options object to the cors() function.

For example:

const router = new Router({
  middlewares: [cors({ origin: "https://example.com" })],
});

router.use("OPTIONS", "/hello", {
  fetch: () => new Response(null, { status: 204 }),
});

This sets the Access-Control-Allow-Origin header to https://example.com, allowing requests only from that specific origin.

License

Artur is licensed under the MIT license. See LICENSE for details.

JonDotsoy/artur