Compare commits
3 Commits
5dad5bc0b1
...
3b1a969145
Author | SHA1 | Date | |
---|---|---|---|
3b1a969145 | |||
5de39d8573 | |||
fa73b0bdc0 |
@ -1,7 +1,7 @@
|
||||
{
|
||||
"name": "@bearmetal/router",
|
||||
"description": "A simple router for Deno",
|
||||
"version": "0.2.1",
|
||||
"version": "0.2.3-b",
|
||||
"stable": true,
|
||||
"files": [
|
||||
"mod.ts",
|
||||
@ -10,7 +10,8 @@
|
||||
],
|
||||
"exports": {
|
||||
".": "./mod.ts",
|
||||
"./types": "./types.ts"
|
||||
"./types": "./types.ts",
|
||||
"./util/response": "./util/response.ts"
|
||||
},
|
||||
"exclude": [
|
||||
".vscode/"
|
||||
@ -19,4 +20,4 @@
|
||||
"@std/assert": "jsr:@std/assert@^1.0.7",
|
||||
"@std/testing": "jsr:@std/testing@^1.0.4"
|
||||
}
|
||||
}
|
||||
}
|
||||
|
7
fileRouterTest/test.ts
Executable file
7
fileRouterTest/test.ts
Executable file
@ -0,0 +1,7 @@
|
||||
const handlers = {
|
||||
get: () => {
|
||||
return new Response("Hello World");
|
||||
},
|
||||
};
|
||||
|
||||
export default handlers;
|
@ -1,5 +1,6 @@
|
||||
import Router from "./router.ts";
|
||||
import type { Handler, RouteConfigurator } from "./types.ts";
|
||||
import { isRelativePath } from "./util/isRelativePath.ts";
|
||||
|
||||
function crawl(dir: string, callback: (path: string) => void) {
|
||||
for (const entry of Deno.readDirSync(dir)) {
|
||||
@ -24,13 +25,20 @@ function crawl(dir: string, callback: (path: string) => void) {
|
||||
* ```
|
||||
*/
|
||||
export class FileRouter extends Router {
|
||||
constructor(root: string) {
|
||||
constructor(root: string, _import?: (path: string) => Promise<unknown>) {
|
||||
super();
|
||||
crawl(root, async (path) => {
|
||||
let relativePath = path.replace(root, "");
|
||||
let relativePath = path.replace(root, "").replace(/index\/?/, "");
|
||||
if (path.endsWith(".ts") || path.endsWith(".js")) {
|
||||
if (isRelativePath(path)) {
|
||||
path = Deno.build.os === "windows"
|
||||
? `${Deno.cwd()}\\${path.replace(/^.?.?\\/, "")}`
|
||||
: `${Deno.cwd()}/${path.replace(/^.?.?\//, "")}`;
|
||||
}
|
||||
relativePath = relativePath.replace(/\.[tj]s/, "");
|
||||
const handlers = await import(path);
|
||||
const handlers = _import
|
||||
? await _import(path)
|
||||
: await import("file://" + path);
|
||||
|
||||
if (handlers.default) {
|
||||
handlers.default instanceof Router
|
||||
@ -55,6 +63,15 @@ export class FileRouter extends Router {
|
||||
});
|
||||
}
|
||||
});
|
||||
|
||||
if (Deno.env.get("BEARMETAL_ROUTER_DEBUG") === "true") {
|
||||
this.route("/debug/dump").get((_ctx) => {
|
||||
console.log("Dumping routes:");
|
||||
return new Response(
|
||||
this.routes.map((r) => r.pattern.pathname).join("\n"),
|
||||
);
|
||||
});
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
|
2
mod.ts
2
mod.ts
@ -5,5 +5,3 @@
|
||||
|
||||
export { Router } from "./router.ts";
|
||||
export { FileRouter } from "./file_router.ts";
|
||||
|
||||
export type { Handler, Middleware } from "./types.ts";
|
||||
|
@ -73,7 +73,7 @@ import { NotFound } from "./util/response.ts";
|
||||
* });
|
||||
*/
|
||||
export class Router {
|
||||
private routes: RouteConfig[] = [];
|
||||
protected routes: RouteConfig[] = [];
|
||||
private middleware: MiddlewareConfig[] = [];
|
||||
|
||||
/**
|
||||
|
12
types.ts
12
types.ts
@ -3,6 +3,9 @@
|
||||
* BearMetal Router types
|
||||
*/
|
||||
|
||||
/**
|
||||
* @description a context object for a request
|
||||
*/
|
||||
export interface RouterContext {
|
||||
url: URL;
|
||||
params: Record<string, string | undefined>;
|
||||
@ -27,17 +30,26 @@ export type Middleware = (
|
||||
next: () => Promise<Response>,
|
||||
) => Promise<Response>;
|
||||
|
||||
/**
|
||||
* @description a route configuration
|
||||
*/
|
||||
export interface RouteConfig {
|
||||
pattern: URLPattern;
|
||||
handlers: { [method: string]: Handler };
|
||||
}
|
||||
|
||||
/**
|
||||
* @description a middleware configuration
|
||||
*/
|
||||
export interface MiddlewareConfig {
|
||||
pattern: URLPattern;
|
||||
handler: Middleware;
|
||||
path: string;
|
||||
}
|
||||
|
||||
/**
|
||||
* @description a route configurator
|
||||
*/
|
||||
export interface RouteConfigurator {
|
||||
get(handler: Handler): RouteConfigurator;
|
||||
post(handler: Handler): RouteConfigurator;
|
||||
|
4
util/isRelativePath.ts
Executable file
4
util/isRelativePath.ts
Executable file
@ -0,0 +1,4 @@
|
||||
export function isRelativePath(path: string) {
|
||||
return !path.startsWith("/") &&
|
||||
(path.startsWith("./") || path.startsWith("../"));
|
||||
}
|
@ -1,4 +1,35 @@
|
||||
export const NotFound = (msg?: string) =>
|
||||
/**
|
||||
* @module
|
||||
* BearMetal Router response utilities
|
||||
*/
|
||||
|
||||
/**
|
||||
* @description a response with a status of 404
|
||||
*/
|
||||
export const NotFound = (msg?: string): Response =>
|
||||
new Response(msg ?? "Not Found", { status: 404 });
|
||||
export const InternalError = (msg?: string) =>
|
||||
/**
|
||||
* @description a response with a status of 500
|
||||
*/
|
||||
export const InternalError = (msg?: string): Response =>
|
||||
new Response(msg ?? "Internal Server Error", { status: 500 });
|
||||
/**
|
||||
* @description a response with a status of 400
|
||||
*/
|
||||
export const BadRequest = (msg?: string): Response =>
|
||||
new Response(msg ?? "Bad Request", { status: 400 });
|
||||
/**
|
||||
* @description a response with a status of 401
|
||||
*/
|
||||
export const Unauthorized = (msg?: string): Response =>
|
||||
new Response(msg ?? "Unauthorized", { status: 401 });
|
||||
/**
|
||||
* @description a response with a status of 403
|
||||
*/
|
||||
export const Forbidden = (msg?: string): Response =>
|
||||
new Response(msg ?? "Forbidden", { status: 403 });
|
||||
/**
|
||||
* @description a response with a status of 200
|
||||
*/
|
||||
export const Ok = (msg?: string): Response =>
|
||||
new Response(msg ?? "OK", { status: 200 });
|
||||
|
Loading…
x
Reference in New Issue
Block a user