Compare commits

..

No commits in common. "3b1a969145d3bceedac13b1d3081a72963626911" and "5dad5bc0b1671f528f80ea93658f766d019933cd" have entirely different histories.

8 changed files with 11 additions and 81 deletions

View File

@ -1,7 +1,7 @@
{
"name": "@bearmetal/router",
"description": "A simple router for Deno",
"version": "0.2.3-b",
"version": "0.2.1",
"stable": true,
"files": [
"mod.ts",
@ -10,8 +10,7 @@
],
"exports": {
".": "./mod.ts",
"./types": "./types.ts",
"./util/response": "./util/response.ts"
"./types": "./types.ts"
},
"exclude": [
".vscode/"

View File

@ -1,7 +0,0 @@
const handlers = {
get: () => {
return new Response("Hello World");
},
};
export default handlers;

View File

@ -1,6 +1,5 @@
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)) {
@ -25,20 +24,13 @@ function crawl(dir: string, callback: (path: string) => void) {
* ```
*/
export class FileRouter extends Router {
constructor(root: string, _import?: (path: string) => Promise<unknown>) {
constructor(root: string) {
super();
crawl(root, async (path) => {
let relativePath = path.replace(root, "").replace(/index\/?/, "");
let relativePath = path.replace(root, "");
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 = _import
? await _import(path)
: await import("file://" + path);
const handlers = await import(path);
if (handlers.default) {
handlers.default instanceof Router
@ -63,15 +55,6 @@ 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
View File

@ -5,3 +5,5 @@
export { Router } from "./router.ts";
export { FileRouter } from "./file_router.ts";
export type { Handler, Middleware } from "./types.ts";

View File

@ -73,7 +73,7 @@ import { NotFound } from "./util/response.ts";
* });
*/
export class Router {
protected routes: RouteConfig[] = [];
private routes: RouteConfig[] = [];
private middleware: MiddlewareConfig[] = [];
/**

View File

@ -3,9 +3,6 @@
* BearMetal Router types
*/
/**
* @description a context object for a request
*/
export interface RouterContext {
url: URL;
params: Record<string, string | undefined>;
@ -30,26 +27,17 @@ 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;

View File

@ -1,4 +0,0 @@
export function isRelativePath(path: string) {
return !path.startsWith("/") &&
(path.startsWith("./") || path.startsWith("../"));
}

View File

@ -1,35 +1,4 @@
/**
* @module
* BearMetal Router response utilities
*/
/**
* @description a response with a status of 404
*/
export const NotFound = (msg?: string): Response =>
export const NotFound = (msg?: string) =>
new Response(msg ?? "Not Found", { status: 404 });
/**
* @description a response with a status of 500
*/
export const InternalError = (msg?: string): Response =>
export const InternalError = (msg?: string) =>
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 });