bun-crumb 0.6.0 → 0.8.0

package/dist/index.d.ts

@@ -48,7 +48,8 @@ type Validate = (data: unknown, schema: SchemaData) => boolean;
  * const method: HttpMethod = 'GET';
  * ```
  */
-type HttpMethod = 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE' | 'OPTIONS';
+type HttpMethod = 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE' | 'OPTIONS' | 'HEAD';
+type RedirectStatusCode = 300 | 301 | 302 | 303 | 304 | 307 | 308;
 /**
  * HTTP Header struct.
  */
@@ -57,16 +58,47 @@ type Header = {
     value: string;
 };
 type Headers = ResponseInit['headers'];
+type RouteRequestParams<T extends string | undefined = undefined> = [
+    T
+] extends [string] ? {
+    [K in T]: string;
+} : {
+    [key: string]: string | undefined;
+};
+/**
+ *
+ *
+ * Type of RouteRequest generic
+ *
+ *
+ *
+ *
+ *
+ */
+interface RouteRequestGeneric {
+    body?: unknown;
+    params?: string;
+}
 /**
  * Type of route handler `request`
  */
-interface RouteRequest<T extends {
-    body: unknown;
-} = {
-    body: unknown;
-}> extends Omit<BunRequest, 'body'> {
+interface RouteRequest<T extends RouteRequestGeneric = RouteRequestGeneric> extends Omit<BunRequest, 'params'> {
+    params: RouteRequestParams<T['params']>;
     /**
-     * Parsed, validated from schema body of reqeust
+     * #### Parses and validates body of request.
+     *
+     * - Parses body to JSON or text
+     * - Validates body with `schemaValidator` if it is provided.
+     *
+     * @returns Promise with handled body
+     *
+     * @example
+     *
+     * ```typescript
+     * request.handleBody().then((bodyData) => {
+     *   console.log(bodyData);
+     * })
+     * ```
      */
     handleBody: () => Promise<T extends {
         body: unknown;
@@ -87,6 +119,7 @@ interface RouteResponse<T extends {
 }> {
     setHeader: (name: Header['name'], value: Header['value']) => void;
     send: (data: T['body'], options?: ResponseOptions) => void;
+    redirect: (url: string, status: RedirectStatusCode | (number & {})) => void;
 }
 type Route = Partial<Record<HttpMethod, RouteOptions>>;
 type RouteHandler = (request: RouteRequest, response: RouteResponse) => Promise<void> | void;
@@ -143,7 +176,7 @@ interface ListenOptions {
  * listen(PORT, 'localhost');
  * ```
  */
-declare const listen: (options: ListenOptions) => void;
+declare const listen: (options?: ListenOptions) => void;
 
 /**
  * Creates a route with `url`, `method` and `handler`.
@@ -201,4 +234,4 @@ declare const listen: (options: ListenOptions) => void;
 declare const createRoute: (routeOptions: RouteOptions) => void;
 
 export { createRoute, listen };
-export type { Header, Headers, HttpMethod, ListenOptions, ResponseOptions, Route, RouteHandler, RouteOptions, RouteRequest, RouteResponse, Schema, SchemaData, Validate };
+export type { Header, Headers, HttpMethod, ListenOptions, RedirectStatusCode, ResponseOptions, Route, RouteHandler, RouteOptions, RouteRequest, RouteRequestGeneric, RouteRequestParams, RouteResponse, Schema, SchemaData, Validate };

package/dist/index.js

@@ -1 +1 @@
-import{serve as t}from"bun";class e extends Error{status;constructor(t,e){super(e),this.status=t,this.name="HttpError"}}const s=new Map,n=(t,s)=>n=>{const o=n.headers.get("Content-Type")??"text/plain",r=n;return r.handleBody=()=>((t,s,n,o)=>{const r={"application/json":t=>t.json().catch(()=>{throw new e(400,"Bad Request")}).then(t=>{if(n&&o&&!o(t,n))throw new e(400,"Request does not match schema");return t}),"text/plain":t=>t.text().catch(t=>{throw new e(400,t)}).then(t=>{if(n&&o&&!o(t,n))throw new e(400,"Request does not match schema");return t})};return s in r?r[s](t):Promise.reject(new e(415,"Unsupported media type"))})(n,o,t.schema,s),Promise.resolve(((t,e)=>{let s=200,n="",o="";const r={},a={setHeader:(t,e)=>{r[t]=e},send:(t,e)=>{"object"==typeof t?(r["Content-Type"]="application/json",o=JSON.stringify(t)):"string"==typeof t&&(r["Content-Type"]="text/plain",o=t),e&&(s=e.status,n=e.statusText)}};return Promise.resolve(e.handler(t,a)).then(()=>new Response(o,{headers:r,status:s,statusText:n}))})(r,t)).then(t=>t).catch(t=>t instanceof e?new Response(t.message,{status:t.status}):new Response("Internal server error",{status:500}))},o=(t,e)=>{const s={};for(const o in t)Object.hasOwn(t,o)&&(s[o]=n(t[o],e));return s},r=(t,e)=>{const s={};for(const n of t)s[n[0]]=o(n[1],e);return t.clear(),s},a=e=>{t({port:e.port,hostname:e.hostname,development:e.development??!1,routes:r(s,e?.schemaValidator)})},c=t=>{const e=s.get(t.url);e?e[t.method]=t:s.set(t.url,{[t.method]:t})};export{c as createRoute,a as listen};
+import{serve as t}from"bun";class e extends Error{status;constructor(t,e){super(e),this.status=t,this.name="HttpError"}}const s=new Map,n=(t,s)=>n=>{const o=n.headers.get("Content-Type")??"text/plain",r=n;return r.handleBody=()=>((t,s,n,o)=>{const r={"application/json":t=>t.json().catch(()=>{throw new e(400,"Bad Request")}).then(t=>{if(n&&o&&!o(t,n))throw new e(400,"Request does not match schema");return t}),"text/plain":t=>t.text().catch(t=>{throw new e(400,t)}).then(t=>{if(n&&o&&!o(t,n))throw new e(400,"Request does not match schema");return t})};return s in r?r[s](t):Promise.reject(new e(415,"Unsupported media type"))})(n,o,t.schema,s),Promise.resolve(((t,e)=>{let s=200,n="",o="";const r={},a={setHeader:(t,e)=>{r[t]=e},send:(t,e)=>{"object"==typeof t?(r["Content-Type"]="application/json",o=JSON.stringify(t)):"string"==typeof t&&(r["Content-Type"]="text/plain",o=t),e&&(s=e.status,n=e.statusText)},redirect:(t,e)=>{o="",s=e,r.Location=t}};return Promise.resolve(e.handler(t,a)).then(()=>new Response(o,{headers:r,status:s,statusText:n}))})(r,t)).then(t=>t).catch(t=>t instanceof e?new Response(t.message,{status:t.status}):new Response("Internal server error",{status:500}))},o=(t,e)=>{const s={};for(const o in t)Object.hasOwn(t,o)&&(s[o]=n(t[o],e));return s},r=(t,e)=>{const s={};for(const n of t)s[n[0]]=o(n[1],e);return t.clear(),s},a=e=>{t({port:e?.port,hostname:e?.hostname,development:e?.development??!1,routes:r(s,e?.schemaValidator)})},c=t=>{const e=s.get(t.url);e?e[t.method]=t:s.set(t.url,{[t.method]:t})};export{c as createRoute,a as listen};

package/dist/server.d.ts

@@ -104,5 +104,5 @@ export declare const prepareRoutes: (routes: Routes, schemaValidator?: Validate)
  * listen(PORT, 'localhost');
  * ```
  */
-export declare const listen: (options: ListenOptions) => void;
+export declare const listen: (options?: ListenOptions) => void;
 export {};

package/dist/types/route.d.ts

@@ -8,7 +8,8 @@ import type { SchemaData } from './schema';
  * const method: HttpMethod = 'GET';
  * ```
  */
-export type HttpMethod = 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE' | 'OPTIONS';
+export type HttpMethod = 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE' | 'OPTIONS' | 'HEAD';
+export type RedirectStatusCode = 300 | 301 | 302 | 303 | 304 | 307 | 308;
 /**
  * HTTP Header struct.
  */
@@ -17,16 +18,47 @@ export type Header = {
     value: string;
 };
 export type Headers = ResponseInit['headers'];
+export type RouteRequestParams<T extends string | undefined = undefined> = [
+    T
+] extends [string] ? {
+    [K in T]: string;
+} : {
+    [key: string]: string | undefined;
+};
+/**
+ *
+ *
+ * Type of RouteRequest generic
+ *
+ *
+ *
+ *
+ *
+ */
+export interface RouteRequestGeneric {
+    body?: unknown;
+    params?: string;
+}
 /**
  * Type of route handler `request`
  */
-export interface RouteRequest<T extends {
-    body: unknown;
-} = {
-    body: unknown;
-}> extends Omit<BunRequest, 'body'> {
+export interface RouteRequest<T extends RouteRequestGeneric = RouteRequestGeneric> extends Omit<BunRequest, 'params'> {
+    params: RouteRequestParams<T['params']>;
     /**
-     * Parsed, validated from schema body of reqeust
+     * #### Parses and validates body of request.
+     *
+     * - Parses body to JSON or text
+     * - Validates body with `schemaValidator` if it is provided.
+     *
+     * @returns Promise with handled body
+     *
+     * @example
+     *
+     * ```typescript
+     * request.handleBody().then((bodyData) => {
+     *   console.log(bodyData);
+     * })
+     * ```
      */
     handleBody: () => Promise<T extends {
         body: unknown;
@@ -47,6 +79,7 @@ export interface RouteResponse<T extends {
 }> {
     setHeader: (name: Header['name'], value: Header['value']) => void;
     send: (data: T['body'], options?: ResponseOptions) => void;
+    redirect: (url: string, status: RedirectStatusCode | (number & {})) => void;
 }
 export type Route = Partial<Record<HttpMethod, RouteOptions>>;
 export type RouteHandler = (request: RouteRequest, response: RouteResponse) => Promise<void> | void;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "bun-crumb",
-    "version": "0.6.0",
+    "version": "0.8.0",
     "author": "marigold",
     "module": "dist/index.js",
     "license": "UNLICENSED",