initial commit; mvp status

Author: mia-z

.gitignore

@@ -0,0 +1,109 @@
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+lerna-debug.log*
+
+# Diagnostic reports (https://nodejs.org/api/report.html)
+report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
+
+# Runtime data
+pids
+*.pid
+*.seed
+*.pid.lock
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
+*.lcov
+
+# nyc test coverage
+.nyc_output
+
+# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+
+# Bower dependency directory (https://bower.io/)
+bower_components
+
+# node-waf configuration
+.lock-wscript
+
+# Compiled binary addons (https://nodejs.org/api/addons.html)
+build/Release
+
+# Dependency directories
+node_modules/
+jspm_packages/
+
+# TypeScript v1 declaration files
+typings/
+
+# TypeScript cache
+*.tsbuildinfo
+
+# Optional npm cache directory
+.npm
+
+# Optional eslint cache
+.eslintcache
+
+# Microbundle cache
+.rpt2_cache/
+.rts2_cache_cjs/
+.rts2_cache_es/
+.rts2_cache_umd/
+
+# Optional REPL history
+.node_repl_history
+
+# Output of 'npm pack'
+*.tgz
+
+# Yarn Integrity file
+.yarn-integrity
+
+# dotenv environment variables file
+.env
+.env.test
+
+# parcel-bundler cache (https://parceljs.org/)
+.cache
+
+# Next.js build output
+.next
+
+# Nuxt.js build / generate output
+.nuxt
+dist
+
+# Gatsby files
+.cache/
+# Comment in the public line in if your project uses Gatsby and *not* Next.js
+# https://nextjs.org/blog/next-9-1#public-directory-support
+# public
+
+# vuepress build output
+.vuepress/dist
+
+# Serverless directories
+.serverless/
+
+# FuseBox cache
+.fusebox/
+
+# DynamoDB Local files
+.dynamodb/
+
+# TernJS port file
+.tern-port
+
+# Buxt ignores
+routes
+dev.ts
+*.http

.npmignore

@@ -0,0 +1 @@
+__tests__

__tests__/fixtures/default_export.ts

@@ -0,0 +1,3 @@
+export default async function() {
+    //fixture
+}

__tests__/fixtures/no_default_export.ts

@@ -0,0 +1,3 @@
+export async function no_default_export() {
+    //fixture
+}

__tests__/scan-paths.test.ts

@@ -0,0 +1,32 @@
+import { describe, it, expect } from "bun:test";
+import { join } from "path";
+import { cwd } from "process";
+import ScanPaths from "src/utils/ScanPaths";
+
+const root = join(cwd(), "__tests__", "routes");
+
+describe("Route mapper tests", () => {
+    it("will recursively fetch the paths of files inside the 'routes' folder", async () => {
+        const paths: Array<RoutePath> = [ 
+            { AbsolutePath: "messages.ts", FullPath: root + "/messages.ts", EffectiveRoute: "messages", },
+            { AbsolutePath: "messages/[id].ts", FullPath: root + "/messages/[id].ts", EffectiveRoute: "messages/[id]" },
+            { AbsolutePath: "messages/new_message.ts", FullPath: root + "/messages/new_message.ts", EffectiveRoute: "messages/new_message"  },
+            { AbsolutePath: "user/[user]/[likes].ts", FullPath: root + "/user/[user]/[likes].ts", EffectiveRoute: "user/[user]/[likes]"  },
+            { AbsolutePath: "user/[user].ts", FullPath: root + "/user/[user].ts", EffectiveRoute: "user/[user]"  }
+        ];
+
+        const routePaths = await ScanPaths(root, "");
+
+        expect(JSON.stringify(routePaths)).toBe(JSON.stringify(paths));
+
+        expect(routePaths.length).toBe(5);
+
+        for (let x = 0; x < paths.length; x++) {
+            expect(routePaths[x].FullPath).toBe(paths[x].FullPath);
+        }
+
+        for (let x = 0; x < paths.length; x++) {
+            expect(routePaths[x].AbsolutePath).toBe(paths[x].AbsolutePath);
+        }
+    });
+});

__tests__/validate-route.test.ts

@@ -0,0 +1,8 @@
+import { describe, it, expect } from "bun:test";
+import ValidateRoutes from "../src/utils/ValidateRoutes";
+
+describe("Path validator tests", () => {
+    it("will make sure the paths point to a module with a default export", async () => {
+        //Cant actually do this with the current bun testing library?
+    });
+});

bun.lockb

@@ -0,0 +1,5 @@
+[bundle]
+entryPoints = ["./dist/index.ts"]
+
+[dev]
+port = 3000

bunfig.toml

@@ -0,0 +1,68 @@
+declare type ScanPaths = (path: string, currentLevel: string) => Promise<Array<RoutePath>>
+declare type ValidateRoute = (routepath: RoutePath) => Promise<Route> | never;
+
+declare type RequestMethod = "GET" | "POST" | "PUT" | "DELETE" | "OPTIONS" | "HEAD" | "PATCH";
+
+declare class BuxtRequest {
+    constructor(baseRequest: Request);
+
+    request: Request;
+    method: string;
+    path: string;
+    matchPath: string;
+
+    query: { [key: string]: string };
+    headers: { [key: string]: string };
+    params: { [key: string]: string };
+
+    body: any;
+    blob: any;
+
+    static buildRequest(req: Request): Promise<BuxtRequest>;
+}
+
+export declare class BuxtResponse {
+    response: Response;
+    options: ResponseInit;
+    isUsed: boolean;
+
+    headers(header: HeadersInit): BuxtResponse;
+
+    setStatusCode(code: number): BuxtResponse;
+    setOptions(options: ResponseInit): BuxtResponse;
+    setStatusText(text: string): BuxtResponse;
+    setHeader(key: string, value: string): BuxtResponse;
+    
+    getHeaders(): HeadersInit;
+    getResponse(): Response;
+    
+    send(body: any): void;
+    json(body: any): void;
+}
+
+export declare class BuxtServer {
+    routes: string[];
+    port: number;
+    baseAddress: string;
+
+    private constructor(port: number);
+
+    static createServer(): Promise<BuxtServer>;
+
+    private registerRoutes(): Promise<void>;
+    private handleRequest(): Promise<Response> | Response;
+
+    listen(): Promise<void>;
+    stop(): void;
+}
+
+export declare type RoutePath = {
+    FullPath: string,
+    AbsolutePath: string
+}
+
+export declare type Route = {
+    route: string,
+    parameters: string[],
+    delegate: (req: BuxtRequest, res: BuxtResponse) => Promise<BuxtResponse>;
+}

index.d.ts

@@ -0,0 +1,11 @@
+"use strict";
+
+import { BuxtServer } from "./src/BuxtServer";
+import { BuxtRequest, BuxtResponse } from "buxt";
+
+const factoryFunction = BuxtServer.createServer;
+
+export { factoryFunction as CreateServer };
+
+export type { BuxtResponse, BuxtRequest };
+export default BuxtServer.createServer;

index.ts

@@ -0,0 +1,30 @@
+{
+  "name": "buxt",
+  "version": "0.0.1",
+  "author": "Ryan C",
+  "type": "module",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/mia-z/buxt"
+  },
+  "main": "index.ts",
+  "types": "index.d.ts",
+  "exports": {
+    ".": {
+      "browser": {
+        "default": "./index.ts"
+      }
+    }
+  },
+  "bugs": {
+    "url": "https://github.com/mia-z/buxt/issues"
+  },
+  "license": "MIT",
+  "scripts": {
+    "dev": "bun dev.ts",
+    "test": "bun wiptest test"
+  },
+  "devDependencies": {
+    "bun-types": "^0.2.2"
+  }
+}

package.json

@@ -0,0 +1,38 @@
+export default class BuxtRequest {
+    request: Request;
+    method: string;
+    path: string;
+    matchPath: string;
+    
+    query: { [key: string]: string } = {};
+    headers: { [key: string]: string } = {};
+    params: { [key: string]: string } = {};
+
+    body: any;
+    blob: any;
+
+    constructor(req: Request) {
+        this.request = req;
+        const { searchParams, pathname } = new URL(req.url);
+        this.path = pathname;
+        this.matchPath = pathname.slice(1, pathname.length);
+        this.method = req.method;
+        
+        searchParams.forEach((value, key) => {
+            this.query[key] = value;
+        });
+
+        req.headers.forEach((value, key) => {
+            this.headers[key] = value;
+        });
+    }
+
+    static async buildRequest(req: Request): Promise<BuxtRequest> {
+        const br = new BuxtRequest(req);
+        const body = await req.json();
+        req.arrayBuffer;
+        br.body = body;
+        br.blob = req.blob();
+        return br;
+    }
+}

src/BuxtRequest.ts

@@ -0,0 +1,56 @@
+export default class BuxtResponse {
+    response: Response;
+    options: ResponseInit = {};
+    isUsed: boolean;
+
+    headers(header: HeadersInit): BuxtResponse {
+        this.options.headers = header;
+        return this;
+    }
+
+    setStatusCode(code: number): BuxtResponse {
+        this.options.status = code;
+        return this;
+    }
+
+    setOptions(options: ResponseInit): BuxtResponse {
+        this.options = options;
+        return this;
+    }
+
+    setStatusText(text: string): BuxtResponse {
+        this.options.statusText = text;
+        return this;
+    }
+
+    setHeader(key: string, value: string): BuxtResponse {
+        if (!key || !value) {
+            throw new Error('Headers key or value should not be empty');
+        }
+
+        const headers = this.options.headers;
+        if (!headers) {
+            this.options.headers = { keys: value };
+        }
+        this.options.headers[key] = value;
+        return this;
+    }
+    
+    getHeaders(): HeadersInit {
+        return this.options.headers;
+    }
+
+    getResponse(): Response {
+        return this.response;
+    }
+    
+    send(body?: any): void {
+        this.response = new Response(body, this.options);
+        this.isUsed = true;
+    }
+
+    json(body: any): void {
+        this.response = Response.json(body, this.options);
+        this.isUsed = true;
+    }
+}