bun-crumb 0.7.0 → 0.9.0

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-import { BunRequest } from 'bun';
+import { BunRequest, CookieInit } from 'bun';
 
 /**
  * The global Schema type that reflects schema type in `Validate` function
@@ -43,13 +43,14 @@ type Validate = (data: unknown, schema: SchemaData) => boolean;
 /**
  * HTTP Method primitive.
  *
+ *
  * @example
  * ```typescript
  * const method: HttpMethod = 'GET';
  * ```
  */
-type HttpMethod = 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE' | 'OPTIONS';
-type RedirectStatusCode = 300 | 301 | 302 | 303 | 304 | 307 | 308;
+type HttpMethod = 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE' | 'OPTIONS' | 'HEAD';
+type RedirectStatusCode = 300 | 301 | 302 | 303 | 304 | 305 | 306 | 307 | 308;
 /**
  * HTTP Header struct.
  */
@@ -58,16 +59,47 @@ type Header = {
     value: string;
 };
 type Headers = ResponseInit['headers'];
+
 /**
- * Type of route handler `request`
+ *
+ * Type of Request search parameters
  */
-interface RouteRequest<T extends {
-    body: unknown;
-} = {
-    body: unknown;
-}> extends Omit<BunRequest, 'body'> {
+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` parameter
+ */
+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;
@@ -86,9 +118,53 @@ interface RouteResponse<T extends {
 } = {
     body: unknown;
 }> {
-    setHeader: (name: Header['name'], value: Header['value']) => void;
     send: (data: T['body'], options?: ResponseOptions) => void;
-    redirect: (url: string, status: RedirectStatusCode | (number & {})) => void;
+    /**
+     * Sets `Location` header to provided `url` and `response.status` to provided `status`
+     *
+     *
+     *
+     * @param url `Location` to redirect
+     *
+     * @param status redirect http code (`3xx`)
+     *
+     * @example
+     *
+     *
+     * ```typescript
+     * return response.redirect('https://bun-crumb.vercel.app', 302);
+     * ```
+     * The same behaviour is
+     * ```typescript
+     * response.setHeader('Location', 'https://bun-crumb.vercel.app');
+     * return response.send('', {status: 302});
+     * ```
+     */
+    redirect: (url: string, status?: RedirectStatusCode | (number & {})) => void;
+    /**
+     * Sets the response header.
+     *
+     *
+     *
+     *
+     * Overrides header if it already exists.
+     *
+     * Case of `name` is not important. Names 'content-type', 'Content-Type', 'CoNteNt=TYPE' are the same.
+     *
+     *
+     * @param name header name
+     * @param value header value
+     *
+     *
+     * @example
+     * ```typescript
+     * response.setHeader('Access-Control-Allow-Origin', '*');
+     * // The code below will override the header above
+     * response.setHeader('access-control-allow-origin', 'https://bun-crumb.vercel.app');
+     * ```
+     */
+    setHeader: (name: Header['name'], value: Header['value']) => void;
+    setCookie: (options: CookieInit) => void;
 }
 type Route = Partial<Record<HttpMethod, RouteOptions>>;
 type RouteHandler = (request: RouteRequest, response: RouteResponse) => Promise<void> | void;
@@ -135,6 +211,7 @@ interface ListenOptions {
  *
  *
  *
+ *
  * @example
  *
  * ```typescript
@@ -203,4 +280,4 @@ declare const listen: (options?: ListenOptions) => void;
 declare const createRoute: (routeOptions: RouteOptions) => void;
 
 export { createRoute, listen };
-export type { Header, Headers, HttpMethod, ListenOptions, RedirectStatusCode, 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)},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};
+import{serve as e,Cookie as t}from"bun";class s extends Error{status;constructor(e,t){super(t),this.status=e,this.name="HttpError"}}const n=new Map,o=(e,n)=>o=>{const r=o.headers.get("Content-Type")??"text/plain",a=o;return a.handleBody=()=>((e,t,n,o)=>{const r={"application/json":e=>e.json().catch(()=>{throw new s(400,"Bad Request")}).then(e=>{if(n&&o&&!o(e,n))throw new s(400,"Request does not match schema");return e}),"text/plain":e=>e.text().catch(e=>{throw new s(400,e)}).then(e=>{if(n&&o&&!o(e,n))throw new s(400,"Request does not match schema");return e})};return t in r?r[t](e):Promise.reject(new s(415,"Unsupported media type"))})(o,r,e.schema,n),Promise.resolve(((e,s)=>{let n=200,o="",r="";const a=new Headers,c={send:(e,t)=>{"object"==typeof e?(a.has("Content-Type")||a.set("Content-Type","application/json"),r=JSON.stringify(e)):"string"==typeof e?(a.has("Content-Type")||a.set("Content-Type","text/plain"),r=e):r=e,t&&(n=t.status,o=t.statusText)},redirect:(e,t)=>{r="",n=t||302,a.set("Location",e)},setHeader:(e,t)=>{a.set(e,t)},setCookie:e=>{a.append("Set-Cookie",new t(e).toString())}};return Promise.resolve(s.handler(e,c)).then(()=>new Response(r,{headers:a,status:n,statusText:o}))})(a,e)).then(e=>e).catch(e=>e instanceof s?new Response(e.message,{status:e.status}):new Response("Internal server error",{status:500}))},r=(e,t)=>{const s={};for(const n in e)Object.hasOwn(e,n)&&(s[n]=o(e[n],t));return s},a=(e,t)=>{const s={};for(const n of e)s[n[0]]=r(n[1],t);return e.clear(),s},c=t=>{e({port:t?.port,hostname:t?.hostname,development:t?.development??!1,routes:a(n,t?.schemaValidator)})},p=e=>{const t=n.get(e.url);t?t[e.method]=e:n.set(e.url,{[e.method]:e})};export{p as createRoute,c as listen};

package/dist/server.d.ts

@@ -1,5 +1,5 @@
 import type { BunRequest } from 'bun';
-import type { Route, RouteOptions, HttpMethod } from './types/route';
+import type { Route, RouteOptions, HttpMethod } from './types';
 import type { SchemaData, Validate } from './types';
 import type { ListenOptions } from './types';
 type PreparedRoute = Partial<Record<HttpMethod, WrappedRouteCallback>>;
@@ -14,6 +14,7 @@ export type Routes = Map<RouteOptions['url'], Route>;
  */
 export 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.
  *
@@ -36,6 +37,7 @@ export declare const handleBody: (request: BunRequest, contentType: string, sche
  *
  *
  * @param routeOptions options of route
+ *
  * @returns {WrappedRouteCallback} Function that is ready to be used in Bun.serve `routes`
  */
 export declare const wrapRouteCallback: (routeOptions: RouteOptions, schemaValidator?: Validate) => WrappedRouteCallback;
@@ -94,6 +96,7 @@ export declare const prepareRoutes: (routes: Routes, schemaValidator?: Validate)
  *
  *
  *
+ *
  * @example
  *
  * ```typescript

package/dist/types/index.d.ts

@@ -1,3 +1,4 @@
 export * from './route';
 export * from './server';
 export * from './schema';
+export * from './utils';

package/dist/types/route.d.ts

@@ -1,33 +1,46 @@
-import type { BunRequest } from 'bun';
+import type { BunRequest, CookieInit } from 'bun';
 import type { SchemaData } from './schema';
+import type { Header, HttpMethod, RedirectStatusCode } from './utils';
 /**
- * HTTP Method primitive.
  *
- * @example
- * ```typescript
- * const method: HttpMethod = 'GET';
- * ```
+ * Type of Request search parameters
  */
-export type HttpMethod = 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE' | 'OPTIONS';
-export type RedirectStatusCode = 300 | 301 | 302 | 303 | 304 | 307 | 308;
+export type RouteRequestParams<T extends string | undefined = undefined> = [
+    T
+] extends [string] ? {
+    [K in T]: string;
+} : {
+    [key: string]: string | undefined;
+};
 /**
- * HTTP Header struct.
+ * Type of RouteRequest generic
  */
-export type Header = {
-    name: string;
-    value: string;
-};
-export type Headers = ResponseInit['headers'];
+export interface RouteRequestGeneric {
+    body?: unknown;
+    params?: string;
+}
 /**
- * Type of route handler `request`
+ *
+ *
+ * Type of route handler `request` parameter
  */
-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;
@@ -46,9 +59,53 @@ export interface RouteResponse<T extends {
 } = {
     body: unknown;
 }> {
-    setHeader: (name: Header['name'], value: Header['value']) => void;
     send: (data: T['body'], options?: ResponseOptions) => void;
-    redirect: (url: string, status: RedirectStatusCode | (number & {})) => void;
+    /**
+     * Sets `Location` header to provided `url` and `response.status` to provided `status`
+     *
+     *
+     *
+     * @param url `Location` to redirect
+     *
+     * @param status redirect http code (`3xx`)
+     *
+     * @example
+     *
+     *
+     * ```typescript
+     * return response.redirect('https://bun-crumb.vercel.app', 302);
+     * ```
+     * The same behaviour is
+     * ```typescript
+     * response.setHeader('Location', 'https://bun-crumb.vercel.app');
+     * return response.send('', {status: 302});
+     * ```
+     */
+    redirect: (url: string, status?: RedirectStatusCode | (number & {})) => void;
+    /**
+     * Sets the response header.
+     *
+     *
+     *
+     *
+     * Overrides header if it already exists.
+     *
+     * Case of `name` is not important. Names 'content-type', 'Content-Type', 'CoNteNt=TYPE' are the same.
+     *
+     *
+     * @param name header name
+     * @param value header value
+     *
+     *
+     * @example
+     * ```typescript
+     * response.setHeader('Access-Control-Allow-Origin', '*');
+     * // The code below will override the header above
+     * response.setHeader('access-control-allow-origin', 'https://bun-crumb.vercel.app');
+     * ```
+     */
+    setHeader: (name: Header['name'], value: Header['value']) => void;
+    setCookie: (options: CookieInit) => void;
 }
 export type Route = Partial<Record<HttpMethod, RouteOptions>>;
 export type RouteHandler = (request: RouteRequest, response: RouteResponse) => Promise<void> | void;

package/dist/types/utils.d.ts

@@ -0,0 +1,19 @@
+/**
+ * HTTP Method primitive.
+ *
+ *
+ * @example
+ * ```typescript
+ * const method: HttpMethod = 'GET';
+ * ```
+ */
+export type HttpMethod = 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE' | 'OPTIONS' | 'HEAD';
+export type RedirectStatusCode = 300 | 301 | 302 | 303 | 304 | 305 | 306 | 307 | 308;
+/**
+ * HTTP Header struct.
+ */
+export type Header = {
+    name: string;
+    value: string;
+};
+export type Headers = ResponseInit['headers'];

package/package.json

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