@kaito-http/core 3.0.0-beta.10 → 3.0.0-beta.11

package/dist/index.cjs

@@ -24,7 +24,6 @@ __export(index_exports, {
   KaitoRequest: () => KaitoRequest,
   Router: () => Router,
   WrappedError: () => WrappedError,
-  apiresponse: () => apiresponse,
   createKaitoHandler: () => createKaitoHandler,
   createUtilities: () => createUtilities,
   parsable: () => parsable
@@ -56,53 +55,77 @@ var KaitoError = class extends Error {
 
 // src/request.ts
 var KaitoRequest = class {
-  request;
-  _url;
-  constructor(request) {
-    this.request = request;
+  url;
+  _request;
+  constructor(url, request) {
+    this._request = request;
+    this.url = url;
   }
   get headers() {
-    return this.request.headers;
+    return this._request.headers;
   }
   get method() {
-    return this.request.method;
-  }
-  get url() {
-    return this.request.url;
-  }
-  parseURL() {
-    if (!this._url) {
-      this._url = new URL(this.url);
-    }
-    return this._url;
+    return this._request.method;
   }
   async arrayBuffer() {
-    return this.request.arrayBuffer();
+    return this._request.arrayBuffer();
   }
   async blob() {
-    return this.request.blob();
+    return this._request.blob();
   }
   async formData() {
-    return this.request.formData();
+    return this._request.formData();
   }
   async bytes() {
     const buffer = await this.arrayBuffer();
     return new Uint8Array(buffer);
   }
   async json() {
-    return this.request.json();
+    return this._request.json();
   }
   async text() {
-    return this.request.text();
+    return this._request.text();
+  }
+  get request() {
+    return this._request;
+  }
+};
+
+// src/response.ts
+var KaitoResponse = class {
+  _headers;
+  _status;
+  constructor() {
+    this._headers = null;
+    this._status = 200;
+  }
+  get headers() {
+    if (this._headers === null) {
+      this._headers = new Headers();
+    }
+    return this._headers;
+  }
+  status(status) {
+    this._status = status;
+    return this;
+  }
+  /**
+   * Turn this KaitoResponse instance into a Response instance
+   * @param body The Kaito JSON format to be sent as the response body
+   * @returns A Response instance, ready to be sent
+   */
+  toResponse(body) {
+    const init = {
+      status: this._status
+    };
+    if (this._headers) {
+      init.headers = this._headers;
+    }
+    return Response.json(body, init);
   }
 };
 
 // src/util.ts
-function apiresponse(status, response) {
-  return Response.json(response, {
-    status
-  });
-}
 function createUtilities(getContext) {
   return {
     getContext,
@@ -198,15 +221,17 @@ var Router = class _Router {
       const method = req.method;
       const { route, params } = findRoute(method, url.pathname);
       if (!route) {
-        return apiresponse(404, {
+        const body = {
           success: false,
           data: null,
           message: `Cannot ${method} ${url.pathname}`
-        });
+        };
+        return Response.json(body, { status: 404 });
       }
-      const request = new KaitoRequest(req);
+      const request = new KaitoRequest(url, req);
+      const response = new KaitoResponse();
       try {
-        const rootCtx = await server.getContext(request);
+        const rootCtx = await server.getContext(request, response);
         const ctx = await route.through(rootCtx);
         const body = route.body ? await route.body.parse(await req.json()) : void 0;
         const query = _Router.parseQuery(route.query, url);
@@ -216,7 +241,10 @@ var Router = class _Router {
           query,
           params
         });
-        return apiresponse(200, {
+        if (result instanceof Response) {
+          return result;
+        }
+        return response.toResponse({
           success: true,
           data: result,
           message: "OK"
@@ -224,14 +252,14 @@ var Router = class _Router {
       } catch (e) {
         const error = WrappedError.maybe(e);
         if (error instanceof KaitoError) {
-          return apiresponse(error.status, {
+          return response.status(error.status).toResponse({
             success: false,
             data: null,
             message: error.message
           });
         }
         const { status, message } = await server.onError({ error, req: request }).catch(() => ({ status: 500, message: "Internal Server Error" }));
-        return apiresponse(status, {
+        return response.status(status).toResponse({
           success: false,
           data: null,
           message
@@ -283,7 +311,6 @@ function createKaitoHandler(config) {
   KaitoRequest,
   Router,
   WrappedError,
-  apiresponse,
   createKaitoHandler,
   createUtilities,
   parsable

package/dist/index.d.cts

@@ -10,23 +10,50 @@ declare class KaitoError extends Error {
 }
 
 declare class KaitoRequest {
-    private readonly request;
-    private _url;
-    constructor(request: Request);
+    readonly url: URL;
+    private readonly _request;
+    constructor(url: URL, request: Request);
     get headers(): Headers;
     get method(): string;
-    get url(): string;
-    parseURL(): URL;
     arrayBuffer(): Promise<ArrayBuffer>;
     blob(): Promise<Blob>;
     formData(): Promise<FormData>;
     bytes(): Promise<Uint8Array>;
     json(): Promise<unknown>;
     text(): Promise<string>;
+    get request(): Request;
 }
 
 type KaitoMethod = 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE' | 'HEAD' | 'OPTIONS' | 'CONNECT' | 'TRACE';
 
+/**
+ * This class is similar to a `Response` object from the Web Fetch API, but
+ * this with no body stream, and is only used for setting status codes/headers.
+ *
+ * @example
+ * ```ts
+ * const response = new KaitoResponse();
+ *
+ * response.status = 200;
+ * response.header('Content-Type', 'application/json');
+ *
+ * console.log(response.headers); // Headers { 'content-type': 'application/json' }
+ * ```
+ */
+declare class KaitoResponse {
+    private _headers;
+    private _status;
+    constructor();
+    get headers(): Headers;
+    status(status: number): this;
+    /**
+     * Turn this KaitoResponse instance into a Response instance
+     * @param body The Kaito JSON format to be sent as the response body
+     * @returns A Response instance, ready to be sent
+     */
+    toResponse<T>(body: APIResponse<T>): Response;
+}
+
 type Before<BeforeAfterContext> = (req: Request) => Promise<BeforeAfterContext | Response>;
 type After<BeforeAfterContext> = (ctx: BeforeAfterContext, response: Response) => Promise<void>;
 type ServerConfigWithBefore<BeforeAfterContext> = {
@@ -63,7 +90,7 @@ declare class Router<ContextFrom, ContextTo, R extends AnyRoute> {
     get routes(): Set<R>;
     add: <Result, Path extends string, Method extends KaitoMethod, Query extends AnyQueryDefinition = {}, Body extends Parsable = never>(method: Method, path: Path, route: (Method extends "GET" ? Omit<Route<ContextFrom, ContextTo, Result, Path, Method, Query, Body>, "body" | "path" | "method" | "through"> : Omit<Route<ContextFrom, ContextTo, Result, Path, Method, Query, Body>, "path" | "method" | "through">) | Route<ContextFrom, ContextTo, Result, Path, Method, Query, Body>["run"]) => Router<ContextFrom, ContextTo, R | Route<ContextFrom, ContextTo, Result, Path, Method, Query, Body>>;
     readonly merge: <PathPrefix extends `/${string}`, OtherRoutes extends AnyRoute>(pathPrefix: PathPrefix, other: Router<ContextFrom, unknown, OtherRoutes>) => Router<ContextFrom, ContextTo, Extract<R | PrefixRoutesPath<PathPrefix, OtherRoutes>, AnyRoute>>;
-    freeze: (server: ServerConfig<ContextFrom, any>) => (req: Request) => Promise<Response>;
+    freeze: (server: Omit<ServerConfig<ContextFrom, any>, "router">) => (req: Request) => Promise<Response>;
     private readonly method;
     get: <Result, Path extends string, Query extends AnyQueryDefinition = {}, Body extends Parsable = never>(path: Path, route: ((arg: RouteArgument<Path, ContextTo, { [Key in keyof Query]: InferParsable<Query[Key]>["output"]; }, InferParsable<Body>["output"]>) => Promise<Result>) | Omit<Route<ContextFrom, ContextTo, Result, Path, "GET", Query, Body>, "body" | "path" | "method" | "through">) => Router<ContextFrom, ContextTo, R | Route<ContextFrom, ContextTo, Result, Path, "GET", Query, Body>>;
     post: <Result, Path extends string, Query extends AnyQueryDefinition = {}, Body extends Parsable = never>(path: Path, route: ((arg: RouteArgument<Path, ContextTo, { [Key in keyof Query]: InferParsable<Query[Key]>["output"]; }, InferParsable<Body>["output"]>) => Promise<Result>) | Omit<Route<ContextFrom, ContextTo, Result, Path, "POST", Query, Body>, "path" | "method" | "through">) => Router<ContextFrom, ContextTo, R | Route<ContextFrom, ContextTo, Result, Path, "POST", Query, Body>>;
@@ -87,13 +114,12 @@ type SuccessfulAPIResponse<T> = {
 };
 type APIResponse<T> = ErroredAPIResponse | SuccessfulAPIResponse<T>;
 type AnyResponse = APIResponse<unknown>;
-declare function apiresponse<T>(status: number, response: APIResponse<T>): Response;
 type ExtractRouteParams<T extends string> = string extends T ? Record<string, string> : T extends `${string}:${infer Param}/${infer Rest}` ? {
     [k in Param | keyof ExtractRouteParams<Rest>]: string;
 } : T extends `${string}:${infer Param}` ? {
     [k in Param]: string;
 } : {};
-type GetContext<Result> = (req: KaitoRequest) => Promise<Result>;
+type GetContext<Result> = (req: KaitoRequest, res: KaitoResponse) => Promise<Result>;
 /**
  * A helper function to create typed necessary functions
  *
@@ -146,4 +172,4 @@ type Route<ContextFrom, ContextTo, Result, Path extends string, Method extends K
 };
 type AnyRoute<ContextFrom = any, ContextTo = any> = Route<ContextFrom, ContextTo, any, any, any, AnyQueryDefinition, any>;
 
-export { type APIResponse, type After, type AnyQueryDefinition, type AnyResponse, type AnyRoute, type Before, type ErroredAPIResponse, type ExtractRouteParams, type GetContext, type InferParsable, type InferRoutes, KaitoError, type KaitoMethod, KaitoRequest, type Parsable, type Route, type RouteArgument, Router, type RouterState, type ServerConfig, type ServerConfigWithBefore, type SuccessfulAPIResponse, type Through, WrappedError, apiresponse, createKaitoHandler, createUtilities, parsable };
+export { type APIResponse, type After, type AnyQueryDefinition, type AnyResponse, type AnyRoute, type Before, type ErroredAPIResponse, type ExtractRouteParams, type GetContext, type InferParsable, type InferRoutes, KaitoError, type KaitoMethod, KaitoRequest, type Parsable, type Route, type RouteArgument, Router, type RouterState, type ServerConfig, type ServerConfigWithBefore, type SuccessfulAPIResponse, type Through, WrappedError, createKaitoHandler, createUtilities, parsable };

package/dist/index.d.ts

@@ -10,23 +10,50 @@ declare class KaitoError extends Error {
 }
 
 declare class KaitoRequest {
-    private readonly request;
-    private _url;
-    constructor(request: Request);
+    readonly url: URL;
+    private readonly _request;
+    constructor(url: URL, request: Request);
     get headers(): Headers;
     get method(): string;
-    get url(): string;
-    parseURL(): URL;
     arrayBuffer(): Promise<ArrayBuffer>;
     blob(): Promise<Blob>;
     formData(): Promise<FormData>;
     bytes(): Promise<Uint8Array>;
     json(): Promise<unknown>;
     text(): Promise<string>;
+    get request(): Request;
 }
 
 type KaitoMethod = 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE' | 'HEAD' | 'OPTIONS' | 'CONNECT' | 'TRACE';
 
+/**
+ * This class is similar to a `Response` object from the Web Fetch API, but
+ * this with no body stream, and is only used for setting status codes/headers.
+ *
+ * @example
+ * ```ts
+ * const response = new KaitoResponse();
+ *
+ * response.status = 200;
+ * response.header('Content-Type', 'application/json');
+ *
+ * console.log(response.headers); // Headers { 'content-type': 'application/json' }
+ * ```
+ */
+declare class KaitoResponse {
+    private _headers;
+    private _status;
+    constructor();
+    get headers(): Headers;
+    status(status: number): this;
+    /**
+     * Turn this KaitoResponse instance into a Response instance
+     * @param body The Kaito JSON format to be sent as the response body
+     * @returns A Response instance, ready to be sent
+     */
+    toResponse<T>(body: APIResponse<T>): Response;
+}
+
 type Before<BeforeAfterContext> = (req: Request) => Promise<BeforeAfterContext | Response>;
 type After<BeforeAfterContext> = (ctx: BeforeAfterContext, response: Response) => Promise<void>;
 type ServerConfigWithBefore<BeforeAfterContext> = {
@@ -63,7 +90,7 @@ declare class Router<ContextFrom, ContextTo, R extends AnyRoute> {
     get routes(): Set<R>;
     add: <Result, Path extends string, Method extends KaitoMethod, Query extends AnyQueryDefinition = {}, Body extends Parsable = never>(method: Method, path: Path, route: (Method extends "GET" ? Omit<Route<ContextFrom, ContextTo, Result, Path, Method, Query, Body>, "body" | "path" | "method" | "through"> : Omit<Route<ContextFrom, ContextTo, Result, Path, Method, Query, Body>, "path" | "method" | "through">) | Route<ContextFrom, ContextTo, Result, Path, Method, Query, Body>["run"]) => Router<ContextFrom, ContextTo, R | Route<ContextFrom, ContextTo, Result, Path, Method, Query, Body>>;
     readonly merge: <PathPrefix extends `/${string}`, OtherRoutes extends AnyRoute>(pathPrefix: PathPrefix, other: Router<ContextFrom, unknown, OtherRoutes>) => Router<ContextFrom, ContextTo, Extract<R | PrefixRoutesPath<PathPrefix, OtherRoutes>, AnyRoute>>;
-    freeze: (server: ServerConfig<ContextFrom, any>) => (req: Request) => Promise<Response>;
+    freeze: (server: Omit<ServerConfig<ContextFrom, any>, "router">) => (req: Request) => Promise<Response>;
     private readonly method;
     get: <Result, Path extends string, Query extends AnyQueryDefinition = {}, Body extends Parsable = never>(path: Path, route: ((arg: RouteArgument<Path, ContextTo, { [Key in keyof Query]: InferParsable<Query[Key]>["output"]; }, InferParsable<Body>["output"]>) => Promise<Result>) | Omit<Route<ContextFrom, ContextTo, Result, Path, "GET", Query, Body>, "body" | "path" | "method" | "through">) => Router<ContextFrom, ContextTo, R | Route<ContextFrom, ContextTo, Result, Path, "GET", Query, Body>>;
     post: <Result, Path extends string, Query extends AnyQueryDefinition = {}, Body extends Parsable = never>(path: Path, route: ((arg: RouteArgument<Path, ContextTo, { [Key in keyof Query]: InferParsable<Query[Key]>["output"]; }, InferParsable<Body>["output"]>) => Promise<Result>) | Omit<Route<ContextFrom, ContextTo, Result, Path, "POST", Query, Body>, "path" | "method" | "through">) => Router<ContextFrom, ContextTo, R | Route<ContextFrom, ContextTo, Result, Path, "POST", Query, Body>>;
@@ -87,13 +114,12 @@ type SuccessfulAPIResponse<T> = {
 };
 type APIResponse<T> = ErroredAPIResponse | SuccessfulAPIResponse<T>;
 type AnyResponse = APIResponse<unknown>;
-declare function apiresponse<T>(status: number, response: APIResponse<T>): Response;
 type ExtractRouteParams<T extends string> = string extends T ? Record<string, string> : T extends `${string}:${infer Param}/${infer Rest}` ? {
     [k in Param | keyof ExtractRouteParams<Rest>]: string;
 } : T extends `${string}:${infer Param}` ? {
     [k in Param]: string;
 } : {};
-type GetContext<Result> = (req: KaitoRequest) => Promise<Result>;
+type GetContext<Result> = (req: KaitoRequest, res: KaitoResponse) => Promise<Result>;
 /**
  * A helper function to create typed necessary functions
  *
@@ -146,4 +172,4 @@ type Route<ContextFrom, ContextTo, Result, Path extends string, Method extends K
 };
 type AnyRoute<ContextFrom = any, ContextTo = any> = Route<ContextFrom, ContextTo, any, any, any, AnyQueryDefinition, any>;
 
-export { type APIResponse, type After, type AnyQueryDefinition, type AnyResponse, type AnyRoute, type Before, type ErroredAPIResponse, type ExtractRouteParams, type GetContext, type InferParsable, type InferRoutes, KaitoError, type KaitoMethod, KaitoRequest, type Parsable, type Route, type RouteArgument, Router, type RouterState, type ServerConfig, type ServerConfigWithBefore, type SuccessfulAPIResponse, type Through, WrappedError, apiresponse, createKaitoHandler, createUtilities, parsable };
+export { type APIResponse, type After, type AnyQueryDefinition, type AnyResponse, type AnyRoute, type Before, type ErroredAPIResponse, type ExtractRouteParams, type GetContext, type InferParsable, type InferRoutes, KaitoError, type KaitoMethod, KaitoRequest, type Parsable, type Route, type RouteArgument, Router, type RouterState, type ServerConfig, type ServerConfigWithBefore, type SuccessfulAPIResponse, type Through, WrappedError, createKaitoHandler, createUtilities, parsable };

package/dist/index.js

@@ -23,53 +23,77 @@ var KaitoError = class extends Error {
 
 // src/request.ts
 var KaitoRequest = class {
-  request;
-  _url;
-  constructor(request) {
-    this.request = request;
+  url;
+  _request;
+  constructor(url, request) {
+    this._request = request;
+    this.url = url;
   }
   get headers() {
-    return this.request.headers;
+    return this._request.headers;
   }
   get method() {
-    return this.request.method;
-  }
-  get url() {
-    return this.request.url;
-  }
-  parseURL() {
-    if (!this._url) {
-      this._url = new URL(this.url);
-    }
-    return this._url;
+    return this._request.method;
   }
   async arrayBuffer() {
-    return this.request.arrayBuffer();
+    return this._request.arrayBuffer();
   }
   async blob() {
-    return this.request.blob();
+    return this._request.blob();
   }
   async formData() {
-    return this.request.formData();
+    return this._request.formData();
   }
   async bytes() {
     const buffer = await this.arrayBuffer();
     return new Uint8Array(buffer);
   }
   async json() {
-    return this.request.json();
+    return this._request.json();
   }
   async text() {
-    return this.request.text();
+    return this._request.text();
+  }
+  get request() {
+    return this._request;
+  }
+};
+
+// src/response.ts
+var KaitoResponse = class {
+  _headers;
+  _status;
+  constructor() {
+    this._headers = null;
+    this._status = 200;
+  }
+  get headers() {
+    if (this._headers === null) {
+      this._headers = new Headers();
+    }
+    return this._headers;
+  }
+  status(status) {
+    this._status = status;
+    return this;
+  }
+  /**
+   * Turn this KaitoResponse instance into a Response instance
+   * @param body The Kaito JSON format to be sent as the response body
+   * @returns A Response instance, ready to be sent
+   */
+  toResponse(body) {
+    const init = {
+      status: this._status
+    };
+    if (this._headers) {
+      init.headers = this._headers;
+    }
+    return Response.json(body, init);
   }
 };
 
 // src/util.ts
-function apiresponse(status, response) {
-  return Response.json(response, {
-    status
-  });
-}
 function createUtilities(getContext) {
   return {
     getContext,
@@ -165,15 +189,17 @@ var Router = class _Router {
       const method = req.method;
       const { route, params } = findRoute(method, url.pathname);
       if (!route) {
-        return apiresponse(404, {
+        const body = {
           success: false,
           data: null,
           message: `Cannot ${method} ${url.pathname}`
-        });
+        };
+        return Response.json(body, { status: 404 });
       }
-      const request = new KaitoRequest(req);
+      const request = new KaitoRequest(url, req);
+      const response = new KaitoResponse();
       try {
-        const rootCtx = await server.getContext(request);
+        const rootCtx = await server.getContext(request, response);
         const ctx = await route.through(rootCtx);
         const body = route.body ? await route.body.parse(await req.json()) : void 0;
         const query = _Router.parseQuery(route.query, url);
@@ -183,7 +209,10 @@ var Router = class _Router {
           query,
           params
         });
-        return apiresponse(200, {
+        if (result instanceof Response) {
+          return result;
+        }
+        return response.toResponse({
           success: true,
           data: result,
           message: "OK"
@@ -191,14 +220,14 @@ var Router = class _Router {
       } catch (e) {
         const error = WrappedError.maybe(e);
         if (error instanceof KaitoError) {
-          return apiresponse(error.status, {
+          return response.status(error.status).toResponse({
             success: false,
             data: null,
             message: error.message
           });
         }
         const { status, message } = await server.onError({ error, req: request }).catch(() => ({ status: 500, message: "Internal Server Error" }));
-        return apiresponse(status, {
+        return response.status(status).toResponse({
           success: false,
           data: null,
           message
@@ -249,7 +278,6 @@ export {
   KaitoRequest,
   Router,
   WrappedError,
-  apiresponse,
   createKaitoHandler,
   createUtilities,
   parsable

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kaito-http/core",
-  "version": "3.0.0-beta.10",
+  "version": "3.0.0-beta.11",
   "type": "module",
   "author": "Alistair Smith <hi@alistair.sh>",
   "description": "Functional HTTP Framework for TypeScript",