bun-crumb 0.3.1 → 0.7.0

package/README.md

@@ -2,7 +2,7 @@
 
 <div align='center'>
 
-[![CI](https://github.com/a-marigold/crumb/actions/workflows/ci.yaml/badge.svg)](https://github.com/a-marigold/crumb/actions) [![Status](https://img.shields.io/badge/BETA-darkgreen?style=for-the-badge)](https://npmjs.com/package/bun-crumb)
+[![CI](https://github.com/a-marigold/crumb/actions/workflows/ci.yaml/badge.svg)](https://github.com/a-marigold/bun-crumb/actions) [![Status](https://img.shields.io/badge/BETA-darkgreen?style=for-the-badge)](https://npmjs.com/package/bun-crumb)
 [![bun](https://img.shields.io/badge/Bun-000?logo=bun&logoColor=fff)](https://bun.com) [![npm](https://img.shields.io/npm/v/bun-crumb)](https://npmjs.com/package/bun-crumb)
 
 </div>

package/dist/index.d.ts

@@ -49,6 +49,7 @@ type Validate = (data: unknown, schema: SchemaData) => boolean;
  * ```
  */
 type HttpMethod = 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE' | 'OPTIONS';
+type RedirectStatusCode = 300 | 301 | 302 | 303 | 304 | 307 | 308;
 /**
  * HTTP Header struct.
  */
@@ -87,6 +88,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;
@@ -94,11 +96,14 @@ type RouteOptions = {
     url: string;
     method: HttpMethod;
     schema?: SchemaData;
-    onRequest?: RouteHandler;
-    preHandler?: RouteHandler;
     handler: RouteHandler;
 };
 
+/**
+ *
+ *
+ * Type of `options` parameter in `listen` function
+ */
 interface ListenOptions {
     /**
      * Server port to listen
@@ -106,7 +111,6 @@ interface ListenOptions {
     port?: number | string;
     /**
      * Server hostname to listen
-     *
      * @example `localhost`, `0.0.0.0`
      *
      */
@@ -123,90 +127,6 @@ interface ListenOptions {
     schemaValidator?: Validate;
 }
 
-type PreparedRoute = Partial<Record<HttpMethod, WrappedRouteCallback>>;
-type WrappedRouteCallback = (request: BunRequest) => Promise<Response>;
-/**
- * Used straight as Bun.serve `routes` object.
- */
-type PreparedRoutes = Record<RouteOptions['url'], PreparedRoute>;
-type Routes = Map<RouteOptions['url'], Route>;
-/**
- * An internal Map with routes of app. Do not use it in user code to prevent undefined errors
- */
-declare const _routes: Routes;
-/**
- * Runtime function that used in request.
- * Parses body to supported content type (json, plain text) and validates it with route schema.
- *
- * @param {BunRequest} request incoming bun request.
- * @param {string} contentType request `Content-Type` header value.
- * @param {Schema} schema json or any schema with declared `Schema` type.
- * @param {Validate} schemaValidator schema validator function that receives `data` and `schema` arguments.
- *
- * @returns {Promise<unknown>} Promise with body
- */
-declare const handleBody: (request: BunRequest, contentType: string, schema?: SchemaData, schemaValidator?: Validate) => Promise<unknown>;
-/**
- * Internal `server` function.
- * Creates a function with handler and all route hooks.
- *
- * The created function can be used as a callback for route in Bun.serve `routes` object.
- *
- *
- *
- *
- *
- * @param routeOptions options of route
- * @returns {WrappedRouteCallback} Function that is ready to be used in Bun.serve `routes`
- */
-declare const wrapRouteCallback: (routeOptions: RouteOptions, schemaValidator?: Validate) => WrappedRouteCallback;
-/**
- * Internal `server` function.
- * Prepares a route to be used in Bun.serve `routes` object.
- *
- * @param {Route} route
- *
- * @returns {PreparedRoute} Route object with `GET` or other http method keys with wrapped route callbacks.
- *
- * @example
- *
- * ```typescript
- * prepareRoute({
- *   GET: {
- *     url: '/products',
- *       method: 'GET',
- *       handler: (request, response) => {},
- *   },
- *   POST: {
- *     url: '/products/:id',
- *       method: 'POST',
- *       handler: (request, response) => {},
- *   },
- * });
- * // Output will be:
- * ({
- *   GET: (request: BunRequest) => {
- *     // ...code
- *     return new Response();
- *   },
- *   POST: (request: BunRequest) => {
- *     // ...code
- *     return new Response();
- *   },
- * })
- * ```
- *
- */
-declare const prepareRoute: (route: Route, schemaValidator?: Validate) => PreparedRoute;
-/**
- * Internal server function.
- * Calls `prepareRoute` for every route of `routes` Map and returns prepared routes to use in Bun.serve `routes`.
- *
- * @param {Routes} routes Map with routes to prepare.
- *
- * @returns {PreparedRoutes} An object that is used straight in Bun.serve `routes` object.
- */
-declare const prepareRoutes: (routes: Routes, schemaValidator?: Validate) => PreparedRoutes;
 /**
  * Starts serving http server.
  *
@@ -225,7 +145,7 @@ declare const prepareRoutes: (routes: Routes, schemaValidator?: Validate) => Pre
  * listen(PORT, 'localhost');
  * ```
  */
-declare const listen: (options: ListenOptions) => void;
+declare const listen: (options?: ListenOptions) => void;
 
 /**
  * Creates a route with `url`, `method` and `handler`.
@@ -282,5 +202,5 @@ declare const listen: (options: ListenOptions) => void;
  */
 declare const createRoute: (routeOptions: RouteOptions) => void;
 
-export { _routes, createRoute, handleBody, listen, prepareRoute, prepareRoutes, wrapRouteCallback };
-export type { Header, Headers, HttpMethod, ListenOptions, ResponseOptions, Route, RouteHandler, RouteOptions, RouteRequest, RouteResponse, Routes, Schema, SchemaData, Validate, WrappedRouteCallback };
+export { createRoute, listen };
+export type { Header, Headers, HttpMethod, ListenOptions, RedirectStatusCode, ResponseOptions, Route, RouteHandler, RouteOptions, RouteRequest, 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 n=new Map,s=(t,n,s,o)=>{const r={"application/json":t=>t.json().catch(t=>{throw new e(400,t)}).then(t=>{if(s&&o&&!o(t,s))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(s&&o&&!o(t,s))throw new e(400,"Request does not match schema");return t})};return n in r?r[n](t):Promise.reject(new e(415,"Unsupported media type"))},o=(t,n)=>o=>{const r=o.headers.get("Content-Type")??"text/plain",a=o;return a.handleBody=()=>s(o,r,t.schema,n).then(t=>t),Promise.resolve(((t,e)=>{let n,s,o=null;const r={},a={setHeader:(t,e)=>{r[t]=e},send:(t,e)=>{"object"==typeof t?r["Content-Type"]="application/json":"string"==typeof t&&(r["Content-Type"]="text/plain"),o=t,n=e?.status,s=e?.statusText}};return Promise.all([e.onRequest?.(t,a),e.preHandler?.(t,a),e.handler(t,a)]).then(()=>new Response(null==o?null:JSON.stringify(o),{headers:r,status:n,statusText:s}))})(a,t)).then(t=>t).catch(t=>t instanceof e?new Response(t.message,{status:t.status}):new Response("Internal server error",{status:500}))},r=(t,e)=>{const n={};for(const s in t)Object.hasOwn(t,s)&&(n[s]=o(t[s],e));return n},a=(t,e)=>{const n={};for(const s of t)n[s[0]]=r(s[1],e);return t.clear(),n},c=e=>{t({port:e.port,hostname:e.hostname,development:e.development??!1,routes:a(n,e?.schemaValidator)})},h=t=>{const e=n.get(t.url);e?e[t.method]=t:n.set(t.url,{[t.method]:t})};export{n as _routes,h as createRoute,s as handleBody,c as listen,r as prepareRoute,a as prepareRoutes,o as wrapRouteCallback};
+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

@@ -9,6 +9,7 @@ import type { SchemaData } from './schema';
  * ```
  */
 export type HttpMethod = 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE' | 'OPTIONS';
+export type RedirectStatusCode = 300 | 301 | 302 | 303 | 304 | 307 | 308;
 /**
  * HTTP Header struct.
  */
@@ -47,6 +48,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;
@@ -54,7 +56,5 @@ export type RouteOptions = {
     url: string;
     method: HttpMethod;
     schema?: SchemaData;
-    onRequest?: RouteHandler;
-    preHandler?: RouteHandler;
     handler: RouteHandler;
 };

package/dist/types/server.d.ts

@@ -1,4 +1,9 @@
 import type { Validate } from './schema';
+/**
+ *
+ *
+ * Type of `options` parameter in `listen` function
+ */
 export interface ListenOptions {
     /**
      * Server port to listen
@@ -6,7 +11,6 @@ export interface ListenOptions {
     port?: number | string;
     /**
      * Server hostname to listen
-     *
      * @example `localhost`, `0.0.0.0`
      *
      */

package/package.json

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