@kaito-http/core 4.0.0-beta.23 → 4.0.0-beta.25

package/dist/index.cjs

@@ -101,14 +101,14 @@ var KaitoHead = class {
    * @param body The Kaito JSON format to be sent as the response body
    * @returns A Response instance, ready to be sent
    */
-  toResponse(body) {
+  toResponse(data) {
     const init = {
       status: this.#status
     };
     if (this.#headers) {
       init.headers = this.#headers;
     }
-    return Response.json(body, init);
+    return Response.json(data, init);
   }
   /**
    * Whether this KaitoHead instance has been touched/modified
@@ -1093,12 +1093,7 @@ var Router = class _Router {
       const method = req.method;
       const { route, params: rawParams } = findRoute(method, url.pathname);
       if (!route) {
-        const body = {
-          success: false,
-          data: null,
-          message: `Cannot ${method} ${url.pathname}`
-        };
-        return Response.json(body, { status: 404 });
+        return Response.json({ message: `Cannot ${method} ${url.pathname}` }, { status: 404 });
       }
       const request = new KaitoRequest(url, req);
       const head = new KaitoHead();
@@ -1136,44 +1131,30 @@ var Router = class _Router {
             );
           }
           const parsed = route.openapi.schema.serialize(result);
-          return head.toResponse({
-            success: true,
-            data: parsed
-          });
+          return head.toResponse(parsed);
         }
-        return head.toResponse({
-          success: true,
-          data: result
-        });
+        return head.toResponse(result);
       } catch (e) {
         const error = WrappedError.maybe(e);
         if (error instanceof KaitoError) {
           return head.status(error.status).toResponse({
-            success: false,
-            data: null,
             message: error.message
           });
         }
         if (!this.#state.config.onError) {
           return head.status(500).toResponse({
-            success: false,
-            data: null,
             message: "Internal Server Error"
           });
         }
         try {
           const { status, message } = await this.#state.config.onError(error, request);
           return head.status(status).toResponse({
-            success: false,
-            data: null,
             message
           });
         } catch (e2) {
           console.error("[Kaito] Failed to handle error inside `.onError()`, returning 500 and Internal Server Error");
           console.error(e2);
           return head.status(500).toResponse({
-            success: false,
-            data: null,
             message: "Internal Server Error"
           });
         }
@@ -1202,6 +1183,27 @@ var Router = class _Router {
       return response;
     };
   };
+  /**
+   * Create a `/openapi.json` route on this router.
+   *
+   * Any routes defined AFTER this method call will NOT be included in the
+   * file. This is because all methods in Kaito are immutable, so there's no
+   * way for the router to know about routes that were created in the future
+   * on another router.
+   *
+   * @example
+   * ```ts
+   * router.get("/", () => "hey").openapi({
+   * 	info: {
+   * 		title: "My API",
+   * 		version: "1.0.0",
+   * 	},
+   * });
+   * ```
+   *
+   * @param options Options object
+   * @returns
+   */
   openapi = ({
     info,
     servers
@@ -1264,10 +1266,7 @@ var Router = class _Router {
             description: route.openapi?.description ?? "Successful response",
             content: {
               [contentType]: {
-                schema: k.object({
-                  success: k.literal(true),
-                  data: route.openapi.schema
-                }).toOpenAPI()
+                schema: route.openapi.schema.toOpenAPI()
               }
             }
           }

package/dist/index.d.cts

@@ -1,5 +1,5 @@
 import * as OpenAPI from 'openapi3-ts/oas31';
-import { JSONValue, AnySchemaFor, BaseSchema, BaseSchemaDef } from './schema/schema.cjs';
+import { JSONValue as JSONValue$1, AnySchemaFor, BaseSchema, BaseSchemaDef } from './schema/schema.cjs';
 export { ArrayChecks, ArrayDef, BooleanDef, Issue, JSONPrimitive, KArray, KBoolean, KLiteral, KNull, KNumber, KObject, KObjectFromURLSearchParams, KRef, KScalar, KString, KUnion, LiteralDef, NullDef, NumberChecks, NumberDef, NumberFormat, ObjectDef, ParseContext, ParseResult, RefDef, STRING_FORMAT_REGEXES, ScalarDef, ScalarOptions, SchemaError, StringChecks, StringDef, StringFormat, UnionDef, isPrimitiveJSONValue, k } from './schema/schema.cjs';
 import { KaitoSSEResponse } from './stream/stream.cjs';
 
@@ -29,6 +29,11 @@ declare class KaitoRequest {
     get request(): Request;
 }
 
+type JSONPrimitive = string | number | boolean | null;
+type JSONValue = JSONPrimitive | JSONValue[] | {
+    [key: string]: JSONValue;
+};
+
 /**
  * This class is merely a wrapper around a `Headers` object and a status code.
  * It's used while the router is executing a route to store any mutations to the status
@@ -67,7 +72,7 @@ declare class KaitoHead {
      * @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;
+    toResponse<T extends JSONValue>(data: T): Response;
     /**
      * Whether this KaitoHead instance has been touched/modified
      */
@@ -97,18 +102,39 @@ declare class Router<ContextFrom, ContextTo, RequiredParams extends string, Rout
         params: Record<string, string>;
     };
     serve: () => (request: Request, ...args: Input) => Promise<Response>;
+    /**
+     * Create a `/openapi.json` route on this router.
+     *
+     * Any routes defined AFTER this method call will NOT be included in the
+     * file. This is because all methods in Kaito are immutable, so there's no
+     * way for the router to know about routes that were created in the future
+     * on another router.
+     *
+     * @example
+     * ```ts
+     * router.get("/", () => "hey").openapi({
+     * 	info: {
+     * 		title: "My API",
+     * 		version: "1.0.0",
+     * 	},
+     * });
+     * ```
+     *
+     * @param options Options object
+     * @returns
+     */
     openapi: ({ info, servers, }: {
         info: OpenAPI.InfoObject;
         servers?: Partial<Record<(`https://` | `http://`) | ({} & string), string>>;
     }) => Router<ContextFrom, ContextTo, RequiredParams, Routes | Route<ContextFrom, ContextTo, Input, never, Response, "/openapi.json", RequiredParams, "GET", {}, never>, Input>;
     private readonly method;
-    readonly get: <Path extends string, ResultInput = never, ResultOutput = ResultInput, Query extends AnyQuery = {}, Body extends JSONValue = never>(path: Path, route: ((data: RouteRunData<RequiredParams | ExtractRouteParams<Path>, ContextTo, Query, Body>) => ResultOutput | Promise<ResultOutput>) | Omit<Route<ContextFrom, ContextTo, Input, ResultInput, ResultOutput, Path, RequiredParams, "GET", Query, Body>, "body" | "path" | "method" | "router">) => Router<ContextFrom, ContextTo, RequiredParams, Routes | Route<ContextFrom, ContextTo, Input, ResultInput, ResultOutput, Path, RequiredParams, "GET", Query, Body>, Input>;
-    readonly post: <Path extends string, ResultInput = never, ResultOutput = ResultInput, Query extends AnyQuery = {}, Body extends JSONValue = never>(path: Path, route: ((data: RouteRunData<RequiredParams | ExtractRouteParams<Path>, ContextTo, Query, Body>) => ResultOutput | Promise<ResultOutput>) | Omit<Route<ContextFrom, ContextTo, Input, ResultInput, ResultOutput, Path, RequiredParams, "POST", Query, Body>, "path" | "method" | "router">) => Router<ContextFrom, ContextTo, RequiredParams, Routes | Route<ContextFrom, ContextTo, Input, ResultInput, ResultOutput, Path, RequiredParams, "POST", Query, Body>, Input>;
-    readonly put: <Path extends string, ResultInput = never, ResultOutput = ResultInput, Query extends AnyQuery = {}, Body extends JSONValue = never>(path: Path, route: ((data: RouteRunData<RequiredParams | ExtractRouteParams<Path>, ContextTo, Query, Body>) => ResultOutput | Promise<ResultOutput>) | Omit<Route<ContextFrom, ContextTo, Input, ResultInput, ResultOutput, Path, RequiredParams, "PUT", Query, Body>, "path" | "method" | "router">) => Router<ContextFrom, ContextTo, RequiredParams, Routes | Route<ContextFrom, ContextTo, Input, ResultInput, ResultOutput, Path, RequiredParams, "PUT", Query, Body>, Input>;
-    readonly patch: <Path extends string, ResultInput = never, ResultOutput = ResultInput, Query extends AnyQuery = {}, Body extends JSONValue = never>(path: Path, route: ((data: RouteRunData<RequiredParams | ExtractRouteParams<Path>, ContextTo, Query, Body>) => ResultOutput | Promise<ResultOutput>) | Omit<Route<ContextFrom, ContextTo, Input, ResultInput, ResultOutput, Path, RequiredParams, "PATCH", Query, Body>, "path" | "method" | "router">) => Router<ContextFrom, ContextTo, RequiredParams, Routes | Route<ContextFrom, ContextTo, Input, ResultInput, ResultOutput, Path, RequiredParams, "PATCH", Query, Body>, Input>;
-    readonly delete: <Path extends string, ResultInput = never, ResultOutput = ResultInput, Query extends AnyQuery = {}, Body extends JSONValue = never>(path: Path, route: ((data: RouteRunData<RequiredParams | ExtractRouteParams<Path>, ContextTo, Query, Body>) => ResultOutput | Promise<ResultOutput>) | Omit<Route<ContextFrom, ContextTo, Input, ResultInput, ResultOutput, Path, RequiredParams, "DELETE", Query, Body>, "path" | "method" | "router">) => Router<ContextFrom, ContextTo, RequiredParams, Routes | Route<ContextFrom, ContextTo, Input, ResultInput, ResultOutput, Path, RequiredParams, "DELETE", Query, Body>, Input>;
-    readonly head: <Path extends string, ResultInput = never, ResultOutput = ResultInput, Query extends AnyQuery = {}, Body extends JSONValue = never>(path: Path, route: ((data: RouteRunData<RequiredParams | ExtractRouteParams<Path>, ContextTo, Query, Body>) => ResultOutput | Promise<ResultOutput>) | Omit<Route<ContextFrom, ContextTo, Input, ResultInput, ResultOutput, Path, RequiredParams, "HEAD", Query, Body>, "path" | "method" | "router">) => Router<ContextFrom, ContextTo, RequiredParams, Routes | Route<ContextFrom, ContextTo, Input, ResultInput, ResultOutput, Path, RequiredParams, "HEAD", Query, Body>, Input>;
-    readonly options: <Path extends string, ResultInput = never, ResultOutput = ResultInput, Query extends AnyQuery = {}, Body extends JSONValue = never>(path: Path, route: ((data: RouteRunData<RequiredParams | ExtractRouteParams<Path>, ContextTo, Query, Body>) => ResultOutput | Promise<ResultOutput>) | Omit<Route<ContextFrom, ContextTo, Input, ResultInput, ResultOutput, Path, RequiredParams, "OPTIONS", Query, Body>, "path" | "method" | "router">) => Router<ContextFrom, ContextTo, RequiredParams, Routes | Route<ContextFrom, ContextTo, Input, ResultInput, ResultOutput, Path, RequiredParams, "OPTIONS", Query, Body>, Input>;
+    readonly get: <Path extends string, ResultInput = never, ResultOutput = ResultInput, Query extends AnyQuery = {}, Body extends JSONValue$1 = never>(path: Path, route: ((data: RouteRunData<RequiredParams | ExtractRouteParams<Path>, ContextTo, Query, Body>) => ResultOutput | Promise<ResultOutput>) | Omit<Route<ContextFrom, ContextTo, Input, ResultInput, ResultOutput, Path, RequiredParams, "GET", Query, Body>, "body" | "path" | "method" | "router">) => Router<ContextFrom, ContextTo, RequiredParams, Routes | Route<ContextFrom, ContextTo, Input, ResultInput, ResultOutput, Path, RequiredParams, "GET", Query, Body>, Input>;
+    readonly post: <Path extends string, ResultInput = never, ResultOutput = ResultInput, Query extends AnyQuery = {}, Body extends JSONValue$1 = never>(path: Path, route: ((data: RouteRunData<RequiredParams | ExtractRouteParams<Path>, ContextTo, Query, Body>) => ResultOutput | Promise<ResultOutput>) | Omit<Route<ContextFrom, ContextTo, Input, ResultInput, ResultOutput, Path, RequiredParams, "POST", Query, Body>, "path" | "method" | "router">) => Router<ContextFrom, ContextTo, RequiredParams, Routes | Route<ContextFrom, ContextTo, Input, ResultInput, ResultOutput, Path, RequiredParams, "POST", Query, Body>, Input>;
+    readonly put: <Path extends string, ResultInput = never, ResultOutput = ResultInput, Query extends AnyQuery = {}, Body extends JSONValue$1 = never>(path: Path, route: ((data: RouteRunData<RequiredParams | ExtractRouteParams<Path>, ContextTo, Query, Body>) => ResultOutput | Promise<ResultOutput>) | Omit<Route<ContextFrom, ContextTo, Input, ResultInput, ResultOutput, Path, RequiredParams, "PUT", Query, Body>, "path" | "method" | "router">) => Router<ContextFrom, ContextTo, RequiredParams, Routes | Route<ContextFrom, ContextTo, Input, ResultInput, ResultOutput, Path, RequiredParams, "PUT", Query, Body>, Input>;
+    readonly patch: <Path extends string, ResultInput = never, ResultOutput = ResultInput, Query extends AnyQuery = {}, Body extends JSONValue$1 = never>(path: Path, route: ((data: RouteRunData<RequiredParams | ExtractRouteParams<Path>, ContextTo, Query, Body>) => ResultOutput | Promise<ResultOutput>) | Omit<Route<ContextFrom, ContextTo, Input, ResultInput, ResultOutput, Path, RequiredParams, "PATCH", Query, Body>, "path" | "method" | "router">) => Router<ContextFrom, ContextTo, RequiredParams, Routes | Route<ContextFrom, ContextTo, Input, ResultInput, ResultOutput, Path, RequiredParams, "PATCH", Query, Body>, Input>;
+    readonly delete: <Path extends string, ResultInput = never, ResultOutput = ResultInput, Query extends AnyQuery = {}, Body extends JSONValue$1 = never>(path: Path, route: ((data: RouteRunData<RequiredParams | ExtractRouteParams<Path>, ContextTo, Query, Body>) => ResultOutput | Promise<ResultOutput>) | Omit<Route<ContextFrom, ContextTo, Input, ResultInput, ResultOutput, Path, RequiredParams, "DELETE", Query, Body>, "path" | "method" | "router">) => Router<ContextFrom, ContextTo, RequiredParams, Routes | Route<ContextFrom, ContextTo, Input, ResultInput, ResultOutput, Path, RequiredParams, "DELETE", Query, Body>, Input>;
+    readonly head: <Path extends string, ResultInput = never, ResultOutput = ResultInput, Query extends AnyQuery = {}, Body extends JSONValue$1 = never>(path: Path, route: ((data: RouteRunData<RequiredParams | ExtractRouteParams<Path>, ContextTo, Query, Body>) => ResultOutput | Promise<ResultOutput>) | Omit<Route<ContextFrom, ContextTo, Input, ResultInput, ResultOutput, Path, RequiredParams, "HEAD", Query, Body>, "path" | "method" | "router">) => Router<ContextFrom, ContextTo, RequiredParams, Routes | Route<ContextFrom, ContextTo, Input, ResultInput, ResultOutput, Path, RequiredParams, "HEAD", Query, Body>, Input>;
+    readonly options: <Path extends string, ResultInput = never, ResultOutput = ResultInput, Query extends AnyQuery = {}, Body extends JSONValue$1 = never>(path: Path, route: ((data: RouteRunData<RequiredParams | ExtractRouteParams<Path>, ContextTo, Query, Body>) => ResultOutput | Promise<ResultOutput>) | Omit<Route<ContextFrom, ContextTo, Input, ResultInput, ResultOutput, Path, RequiredParams, "OPTIONS", Query, Body>, "path" | "method" | "router">) => Router<ContextFrom, ContextTo, RequiredParams, Routes | Route<ContextFrom, ContextTo, Input, ResultInput, ResultOutput, Path, RequiredParams, "OPTIONS", Query, Body>, Input>;
     through: <NextContext>(through: (context: ContextTo, params: Record<RequiredParams, string>) => MaybePromise<NextContext>) => Router<ContextFrom, NextContext, RequiredParams, Routes, Input>;
 }
 
@@ -122,22 +148,22 @@ type AnyQuery = {
     [key in string]: any;
 };
 type Through<From, To, RequiredParams extends string> = (context: From, params: Record<RequiredParams, string>) => Promise<To>;
-type SSEOutputSpec<Result extends JSONValue> = {
+type SSEOutputSpec<Result extends JSONValue$1> = {
     type: 'sse';
     schema: AnySchemaFor<Result>;
     description?: string | undefined;
 };
-type JSONOutputSpec<ResultInput, ResultOutput extends JSONValue> = {
+type JSONOutputSpec<ResultInput, ResultOutput extends JSONValue$1> = {
     type: 'json';
     schema: BaseSchema<ResultOutput, ResultInput, BaseSchemaDef<ResultOutput>>;
     description?: string | undefined;
 };
-type OutputSpec<ResultInput, ResultOutput> = ResultInput extends KaitoSSEResponse<infer R> ? SSEOutputSpec<Extract<R, JSONValue>> & {
+type OutputSpec<ResultInput, ResultOutput> = ResultInput extends KaitoSSEResponse<infer R> ? SSEOutputSpec<Extract<R, JSONValue$1>> & {
     description?: string;
-} : JSONOutputSpec<ResultOutput, Extract<ResultInput, JSONValue>> & {
+} : JSONOutputSpec<ResultOutput, Extract<ResultInput, JSONValue$1>> & {
     description?: string;
 };
-type Route<ContextFrom, ContextTo, RouterInput extends readonly unknown[], ResultInput, ResultOutput, Path extends string, AdditionalParams extends string, Method extends KaitoMethod, Query extends Record<string, JSONValue>, Body extends JSONValue> = {
+type Route<ContextFrom, ContextTo, RouterInput extends readonly unknown[], ResultInput, ResultOutput, Path extends string, AdditionalParams extends string, Method extends KaitoMethod, Query extends Record<string, JSONValue$1>, Body extends JSONValue$1> = {
     body?: AnySchemaFor<Body>;
     query?: {
         [Key in keyof Query]: AnySchemaFor<Query[Key]>;
@@ -154,16 +180,6 @@ type AnyRoute = Route<any, any, any, any, any, any, any, any, any, any>;
  * A helper to check if the environment is Node.js-like and the `NODE_ENV` environment variable is set to `'development'`
  */
 declare const isNodeLikeDev: boolean;
-type ErroredAPIResponse = {
-    success: false;
-    data: null;
-    message: string;
-};
-type SuccessfulAPIResponse<T> = {
-    success: true;
-    data: T;
-};
-type APIResponse<T> = ErroredAPIResponse | SuccessfulAPIResponse<T>;
 type MaybePromise<T> = T | Promise<T>;
 type KaitoMethod = 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE' | 'HEAD' | 'OPTIONS';
 type ExtractRouteParams<T extends string> = string extends T ? string : T extends `${string}:${infer Param}/${infer Rest}` ? Param | ExtractRouteParams<Rest> : T extends `${string}:${infer Param}` ? Param : never;
@@ -260,4 +276,4 @@ interface KaitoConfig<ContextFrom, Input extends readonly unknown[]> {
  */
 declare const create: <Context = null, Input extends readonly unknown[] = []>(config?: KaitoConfig<Context, Input>) => Router<Context, Context, never, never, Input>;
 
-export { type APIResponse, type AnyQuery, type AnyRoute, AnySchemaFor, BaseSchema, BaseSchemaDef, type ErroredAPIResponse, type ExtractRouteParams, type GetContext, type InferRoutes, type JSONOutputSpec, JSONValue, type KaitoConfig, KaitoError, KaitoHead, type KaitoMethod, KaitoRequest, type MaybePromise, type OutputSpec, type Route, type RouteRunData, Router, type RouterState, type SSEOutputSpec, type SuccessfulAPIResponse, type Through, WrappedError, create, isNodeLikeDev };
+export { type AnyQuery, type AnyRoute, AnySchemaFor, BaseSchema, BaseSchemaDef, type ExtractRouteParams, type GetContext, type InferRoutes, type JSONOutputSpec, JSONValue$1 as JSONValue, type KaitoConfig, KaitoError, KaitoHead, type KaitoMethod, KaitoRequest, type MaybePromise, type OutputSpec, type Route, type RouteRunData, Router, type RouterState, type SSEOutputSpec, type Through, WrappedError, create, isNodeLikeDev };

package/dist/index.d.ts

@@ -1,5 +1,5 @@
 import * as OpenAPI from 'openapi3-ts/oas31';
-import { JSONValue, AnySchemaFor, BaseSchema, BaseSchemaDef } from './schema/schema.js';
+import { JSONValue as JSONValue$1, AnySchemaFor, BaseSchema, BaseSchemaDef } from './schema/schema.js';
 export { ArrayChecks, ArrayDef, BooleanDef, Issue, JSONPrimitive, KArray, KBoolean, KLiteral, KNull, KNumber, KObject, KObjectFromURLSearchParams, KRef, KScalar, KString, KUnion, LiteralDef, NullDef, NumberChecks, NumberDef, NumberFormat, ObjectDef, ParseContext, ParseResult, RefDef, STRING_FORMAT_REGEXES, ScalarDef, ScalarOptions, SchemaError, StringChecks, StringDef, StringFormat, UnionDef, isPrimitiveJSONValue, k } from './schema/schema.js';
 import { KaitoSSEResponse } from './stream/stream.js';
 
@@ -29,6 +29,11 @@ declare class KaitoRequest {
     get request(): Request;
 }
 
+type JSONPrimitive = string | number | boolean | null;
+type JSONValue = JSONPrimitive | JSONValue[] | {
+    [key: string]: JSONValue;
+};
+
 /**
  * This class is merely a wrapper around a `Headers` object and a status code.
  * It's used while the router is executing a route to store any mutations to the status
@@ -67,7 +72,7 @@ declare class KaitoHead {
      * @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;
+    toResponse<T extends JSONValue>(data: T): Response;
     /**
      * Whether this KaitoHead instance has been touched/modified
      */
@@ -97,18 +102,39 @@ declare class Router<ContextFrom, ContextTo, RequiredParams extends string, Rout
         params: Record<string, string>;
     };
     serve: () => (request: Request, ...args: Input) => Promise<Response>;
+    /**
+     * Create a `/openapi.json` route on this router.
+     *
+     * Any routes defined AFTER this method call will NOT be included in the
+     * file. This is because all methods in Kaito are immutable, so there's no
+     * way for the router to know about routes that were created in the future
+     * on another router.
+     *
+     * @example
+     * ```ts
+     * router.get("/", () => "hey").openapi({
+     * 	info: {
+     * 		title: "My API",
+     * 		version: "1.0.0",
+     * 	},
+     * });
+     * ```
+     *
+     * @param options Options object
+     * @returns
+     */
     openapi: ({ info, servers, }: {
         info: OpenAPI.InfoObject;
         servers?: Partial<Record<(`https://` | `http://`) | ({} & string), string>>;
     }) => Router<ContextFrom, ContextTo, RequiredParams, Routes | Route<ContextFrom, ContextTo, Input, never, Response, "/openapi.json", RequiredParams, "GET", {}, never>, Input>;
     private readonly method;
-    readonly get: <Path extends string, ResultInput = never, ResultOutput = ResultInput, Query extends AnyQuery = {}, Body extends JSONValue = never>(path: Path, route: ((data: RouteRunData<RequiredParams | ExtractRouteParams<Path>, ContextTo, Query, Body>) => ResultOutput | Promise<ResultOutput>) | Omit<Route<ContextFrom, ContextTo, Input, ResultInput, ResultOutput, Path, RequiredParams, "GET", Query, Body>, "body" | "path" | "method" | "router">) => Router<ContextFrom, ContextTo, RequiredParams, Routes | Route<ContextFrom, ContextTo, Input, ResultInput, ResultOutput, Path, RequiredParams, "GET", Query, Body>, Input>;
-    readonly post: <Path extends string, ResultInput = never, ResultOutput = ResultInput, Query extends AnyQuery = {}, Body extends JSONValue = never>(path: Path, route: ((data: RouteRunData<RequiredParams | ExtractRouteParams<Path>, ContextTo, Query, Body>) => ResultOutput | Promise<ResultOutput>) | Omit<Route<ContextFrom, ContextTo, Input, ResultInput, ResultOutput, Path, RequiredParams, "POST", Query, Body>, "path" | "method" | "router">) => Router<ContextFrom, ContextTo, RequiredParams, Routes | Route<ContextFrom, ContextTo, Input, ResultInput, ResultOutput, Path, RequiredParams, "POST", Query, Body>, Input>;
-    readonly put: <Path extends string, ResultInput = never, ResultOutput = ResultInput, Query extends AnyQuery = {}, Body extends JSONValue = never>(path: Path, route: ((data: RouteRunData<RequiredParams | ExtractRouteParams<Path>, ContextTo, Query, Body>) => ResultOutput | Promise<ResultOutput>) | Omit<Route<ContextFrom, ContextTo, Input, ResultInput, ResultOutput, Path, RequiredParams, "PUT", Query, Body>, "path" | "method" | "router">) => Router<ContextFrom, ContextTo, RequiredParams, Routes | Route<ContextFrom, ContextTo, Input, ResultInput, ResultOutput, Path, RequiredParams, "PUT", Query, Body>, Input>;
-    readonly patch: <Path extends string, ResultInput = never, ResultOutput = ResultInput, Query extends AnyQuery = {}, Body extends JSONValue = never>(path: Path, route: ((data: RouteRunData<RequiredParams | ExtractRouteParams<Path>, ContextTo, Query, Body>) => ResultOutput | Promise<ResultOutput>) | Omit<Route<ContextFrom, ContextTo, Input, ResultInput, ResultOutput, Path, RequiredParams, "PATCH", Query, Body>, "path" | "method" | "router">) => Router<ContextFrom, ContextTo, RequiredParams, Routes | Route<ContextFrom, ContextTo, Input, ResultInput, ResultOutput, Path, RequiredParams, "PATCH", Query, Body>, Input>;
-    readonly delete: <Path extends string, ResultInput = never, ResultOutput = ResultInput, Query extends AnyQuery = {}, Body extends JSONValue = never>(path: Path, route: ((data: RouteRunData<RequiredParams | ExtractRouteParams<Path>, ContextTo, Query, Body>) => ResultOutput | Promise<ResultOutput>) | Omit<Route<ContextFrom, ContextTo, Input, ResultInput, ResultOutput, Path, RequiredParams, "DELETE", Query, Body>, "path" | "method" | "router">) => Router<ContextFrom, ContextTo, RequiredParams, Routes | Route<ContextFrom, ContextTo, Input, ResultInput, ResultOutput, Path, RequiredParams, "DELETE", Query, Body>, Input>;
-    readonly head: <Path extends string, ResultInput = never, ResultOutput = ResultInput, Query extends AnyQuery = {}, Body extends JSONValue = never>(path: Path, route: ((data: RouteRunData<RequiredParams | ExtractRouteParams<Path>, ContextTo, Query, Body>) => ResultOutput | Promise<ResultOutput>) | Omit<Route<ContextFrom, ContextTo, Input, ResultInput, ResultOutput, Path, RequiredParams, "HEAD", Query, Body>, "path" | "method" | "router">) => Router<ContextFrom, ContextTo, RequiredParams, Routes | Route<ContextFrom, ContextTo, Input, ResultInput, ResultOutput, Path, RequiredParams, "HEAD", Query, Body>, Input>;
-    readonly options: <Path extends string, ResultInput = never, ResultOutput = ResultInput, Query extends AnyQuery = {}, Body extends JSONValue = never>(path: Path, route: ((data: RouteRunData<RequiredParams | ExtractRouteParams<Path>, ContextTo, Query, Body>) => ResultOutput | Promise<ResultOutput>) | Omit<Route<ContextFrom, ContextTo, Input, ResultInput, ResultOutput, Path, RequiredParams, "OPTIONS", Query, Body>, "path" | "method" | "router">) => Router<ContextFrom, ContextTo, RequiredParams, Routes | Route<ContextFrom, ContextTo, Input, ResultInput, ResultOutput, Path, RequiredParams, "OPTIONS", Query, Body>, Input>;
+    readonly get: <Path extends string, ResultInput = never, ResultOutput = ResultInput, Query extends AnyQuery = {}, Body extends JSONValue$1 = never>(path: Path, route: ((data: RouteRunData<RequiredParams | ExtractRouteParams<Path>, ContextTo, Query, Body>) => ResultOutput | Promise<ResultOutput>) | Omit<Route<ContextFrom, ContextTo, Input, ResultInput, ResultOutput, Path, RequiredParams, "GET", Query, Body>, "body" | "path" | "method" | "router">) => Router<ContextFrom, ContextTo, RequiredParams, Routes | Route<ContextFrom, ContextTo, Input, ResultInput, ResultOutput, Path, RequiredParams, "GET", Query, Body>, Input>;
+    readonly post: <Path extends string, ResultInput = never, ResultOutput = ResultInput, Query extends AnyQuery = {}, Body extends JSONValue$1 = never>(path: Path, route: ((data: RouteRunData<RequiredParams | ExtractRouteParams<Path>, ContextTo, Query, Body>) => ResultOutput | Promise<ResultOutput>) | Omit<Route<ContextFrom, ContextTo, Input, ResultInput, ResultOutput, Path, RequiredParams, "POST", Query, Body>, "path" | "method" | "router">) => Router<ContextFrom, ContextTo, RequiredParams, Routes | Route<ContextFrom, ContextTo, Input, ResultInput, ResultOutput, Path, RequiredParams, "POST", Query, Body>, Input>;
+    readonly put: <Path extends string, ResultInput = never, ResultOutput = ResultInput, Query extends AnyQuery = {}, Body extends JSONValue$1 = never>(path: Path, route: ((data: RouteRunData<RequiredParams | ExtractRouteParams<Path>, ContextTo, Query, Body>) => ResultOutput | Promise<ResultOutput>) | Omit<Route<ContextFrom, ContextTo, Input, ResultInput, ResultOutput, Path, RequiredParams, "PUT", Query, Body>, "path" | "method" | "router">) => Router<ContextFrom, ContextTo, RequiredParams, Routes | Route<ContextFrom, ContextTo, Input, ResultInput, ResultOutput, Path, RequiredParams, "PUT", Query, Body>, Input>;
+    readonly patch: <Path extends string, ResultInput = never, ResultOutput = ResultInput, Query extends AnyQuery = {}, Body extends JSONValue$1 = never>(path: Path, route: ((data: RouteRunData<RequiredParams | ExtractRouteParams<Path>, ContextTo, Query, Body>) => ResultOutput | Promise<ResultOutput>) | Omit<Route<ContextFrom, ContextTo, Input, ResultInput, ResultOutput, Path, RequiredParams, "PATCH", Query, Body>, "path" | "method" | "router">) => Router<ContextFrom, ContextTo, RequiredParams, Routes | Route<ContextFrom, ContextTo, Input, ResultInput, ResultOutput, Path, RequiredParams, "PATCH", Query, Body>, Input>;
+    readonly delete: <Path extends string, ResultInput = never, ResultOutput = ResultInput, Query extends AnyQuery = {}, Body extends JSONValue$1 = never>(path: Path, route: ((data: RouteRunData<RequiredParams | ExtractRouteParams<Path>, ContextTo, Query, Body>) => ResultOutput | Promise<ResultOutput>) | Omit<Route<ContextFrom, ContextTo, Input, ResultInput, ResultOutput, Path, RequiredParams, "DELETE", Query, Body>, "path" | "method" | "router">) => Router<ContextFrom, ContextTo, RequiredParams, Routes | Route<ContextFrom, ContextTo, Input, ResultInput, ResultOutput, Path, RequiredParams, "DELETE", Query, Body>, Input>;
+    readonly head: <Path extends string, ResultInput = never, ResultOutput = ResultInput, Query extends AnyQuery = {}, Body extends JSONValue$1 = never>(path: Path, route: ((data: RouteRunData<RequiredParams | ExtractRouteParams<Path>, ContextTo, Query, Body>) => ResultOutput | Promise<ResultOutput>) | Omit<Route<ContextFrom, ContextTo, Input, ResultInput, ResultOutput, Path, RequiredParams, "HEAD", Query, Body>, "path" | "method" | "router">) => Router<ContextFrom, ContextTo, RequiredParams, Routes | Route<ContextFrom, ContextTo, Input, ResultInput, ResultOutput, Path, RequiredParams, "HEAD", Query, Body>, Input>;
+    readonly options: <Path extends string, ResultInput = never, ResultOutput = ResultInput, Query extends AnyQuery = {}, Body extends JSONValue$1 = never>(path: Path, route: ((data: RouteRunData<RequiredParams | ExtractRouteParams<Path>, ContextTo, Query, Body>) => ResultOutput | Promise<ResultOutput>) | Omit<Route<ContextFrom, ContextTo, Input, ResultInput, ResultOutput, Path, RequiredParams, "OPTIONS", Query, Body>, "path" | "method" | "router">) => Router<ContextFrom, ContextTo, RequiredParams, Routes | Route<ContextFrom, ContextTo, Input, ResultInput, ResultOutput, Path, RequiredParams, "OPTIONS", Query, Body>, Input>;
     through: <NextContext>(through: (context: ContextTo, params: Record<RequiredParams, string>) => MaybePromise<NextContext>) => Router<ContextFrom, NextContext, RequiredParams, Routes, Input>;
 }
 
@@ -122,22 +148,22 @@ type AnyQuery = {
     [key in string]: any;
 };
 type Through<From, To, RequiredParams extends string> = (context: From, params: Record<RequiredParams, string>) => Promise<To>;
-type SSEOutputSpec<Result extends JSONValue> = {
+type SSEOutputSpec<Result extends JSONValue$1> = {
     type: 'sse';
     schema: AnySchemaFor<Result>;
     description?: string | undefined;
 };
-type JSONOutputSpec<ResultInput, ResultOutput extends JSONValue> = {
+type JSONOutputSpec<ResultInput, ResultOutput extends JSONValue$1> = {
     type: 'json';
     schema: BaseSchema<ResultOutput, ResultInput, BaseSchemaDef<ResultOutput>>;
     description?: string | undefined;
 };
-type OutputSpec<ResultInput, ResultOutput> = ResultInput extends KaitoSSEResponse<infer R> ? SSEOutputSpec<Extract<R, JSONValue>> & {
+type OutputSpec<ResultInput, ResultOutput> = ResultInput extends KaitoSSEResponse<infer R> ? SSEOutputSpec<Extract<R, JSONValue$1>> & {
     description?: string;
-} : JSONOutputSpec<ResultOutput, Extract<ResultInput, JSONValue>> & {
+} : JSONOutputSpec<ResultOutput, Extract<ResultInput, JSONValue$1>> & {
     description?: string;
 };
-type Route<ContextFrom, ContextTo, RouterInput extends readonly unknown[], ResultInput, ResultOutput, Path extends string, AdditionalParams extends string, Method extends KaitoMethod, Query extends Record<string, JSONValue>, Body extends JSONValue> = {
+type Route<ContextFrom, ContextTo, RouterInput extends readonly unknown[], ResultInput, ResultOutput, Path extends string, AdditionalParams extends string, Method extends KaitoMethod, Query extends Record<string, JSONValue$1>, Body extends JSONValue$1> = {
     body?: AnySchemaFor<Body>;
     query?: {
         [Key in keyof Query]: AnySchemaFor<Query[Key]>;
@@ -154,16 +180,6 @@ type AnyRoute = Route<any, any, any, any, any, any, any, any, any, any>;
  * A helper to check if the environment is Node.js-like and the `NODE_ENV` environment variable is set to `'development'`
  */
 declare const isNodeLikeDev: boolean;
-type ErroredAPIResponse = {
-    success: false;
-    data: null;
-    message: string;
-};
-type SuccessfulAPIResponse<T> = {
-    success: true;
-    data: T;
-};
-type APIResponse<T> = ErroredAPIResponse | SuccessfulAPIResponse<T>;
 type MaybePromise<T> = T | Promise<T>;
 type KaitoMethod = 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE' | 'HEAD' | 'OPTIONS';
 type ExtractRouteParams<T extends string> = string extends T ? string : T extends `${string}:${infer Param}/${infer Rest}` ? Param | ExtractRouteParams<Rest> : T extends `${string}:${infer Param}` ? Param : never;
@@ -260,4 +276,4 @@ interface KaitoConfig<ContextFrom, Input extends readonly unknown[]> {
  */
 declare const create: <Context = null, Input extends readonly unknown[] = []>(config?: KaitoConfig<Context, Input>) => Router<Context, Context, never, never, Input>;
 
-export { type APIResponse, type AnyQuery, type AnyRoute, AnySchemaFor, BaseSchema, BaseSchemaDef, type ErroredAPIResponse, type ExtractRouteParams, type GetContext, type InferRoutes, type JSONOutputSpec, JSONValue, type KaitoConfig, KaitoError, KaitoHead, type KaitoMethod, KaitoRequest, type MaybePromise, type OutputSpec, type Route, type RouteRunData, Router, type RouterState, type SSEOutputSpec, type SuccessfulAPIResponse, type Through, WrappedError, create, isNodeLikeDev };
+export { type AnyQuery, type AnyRoute, AnySchemaFor, BaseSchema, BaseSchemaDef, type ExtractRouteParams, type GetContext, type InferRoutes, type JSONOutputSpec, JSONValue$1 as JSONValue, type KaitoConfig, KaitoError, KaitoHead, type KaitoMethod, KaitoRequest, type MaybePromise, type OutputSpec, type Route, type RouteRunData, Router, type RouterState, type SSEOutputSpec, type Through, WrappedError, create, isNodeLikeDev };

package/dist/index.js

@@ -72,14 +72,14 @@ var KaitoHead = class {
    * @param body The Kaito JSON format to be sent as the response body
    * @returns A Response instance, ready to be sent
    */
-  toResponse(body) {
+  toResponse(data) {
     const init = {
       status: this.#status
     };
     if (this.#headers) {
       init.headers = this.#headers;
     }
-    return Response.json(body, init);
+    return Response.json(data, init);
   }
   /**
    * Whether this KaitoHead instance has been touched/modified
@@ -214,12 +214,7 @@ var Router = class _Router {
       const method = req.method;
       const { route, params: rawParams } = findRoute(method, url.pathname);
       if (!route) {
-        const body = {
-          success: false,
-          data: null,
-          message: `Cannot ${method} ${url.pathname}`
-        };
-        return Response.json(body, { status: 404 });
+        return Response.json({ message: `Cannot ${method} ${url.pathname}` }, { status: 404 });
       }
       const request = new KaitoRequest(url, req);
       const head = new KaitoHead();
@@ -257,44 +252,30 @@ var Router = class _Router {
             );
           }
           const parsed = route.openapi.schema.serialize(result);
-          return head.toResponse({
-            success: true,
-            data: parsed
-          });
+          return head.toResponse(parsed);
         }
-        return head.toResponse({
-          success: true,
-          data: result
-        });
+        return head.toResponse(result);
       } catch (e) {
         const error = WrappedError.maybe(e);
         if (error instanceof KaitoError) {
           return head.status(error.status).toResponse({
-            success: false,
-            data: null,
             message: error.message
           });
         }
         if (!this.#state.config.onError) {
           return head.status(500).toResponse({
-            success: false,
-            data: null,
             message: "Internal Server Error"
           });
         }
         try {
           const { status, message } = await this.#state.config.onError(error, request);
           return head.status(status).toResponse({
-            success: false,
-            data: null,
             message
           });
         } catch (e2) {
           console.error("[Kaito] Failed to handle error inside `.onError()`, returning 500 and Internal Server Error");
           console.error(e2);
           return head.status(500).toResponse({
-            success: false,
-            data: null,
             message: "Internal Server Error"
           });
         }
@@ -323,6 +304,27 @@ var Router = class _Router {
       return response;
     };
   };
+  /**
+   * Create a `/openapi.json` route on this router.
+   *
+   * Any routes defined AFTER this method call will NOT be included in the
+   * file. This is because all methods in Kaito are immutable, so there's no
+   * way for the router to know about routes that were created in the future
+   * on another router.
+   *
+   * @example
+   * ```ts
+   * router.get("/", () => "hey").openapi({
+   * 	info: {
+   * 		title: "My API",
+   * 		version: "1.0.0",
+   * 	},
+   * });
+   * ```
+   *
+   * @param options Options object
+   * @returns
+   */
   openapi = ({
     info,
     servers
@@ -385,10 +387,7 @@ var Router = class _Router {
             description: route.openapi?.description ?? "Successful response",
             content: {
               [contentType]: {
-                schema: k.object({
-                  success: k.literal(true),
-                  data: route.openapi.schema
-                }).toOpenAPI()
+                schema: route.openapi.schema.toOpenAPI()
               }
             }
           }

package/dist/schema/schema.d.cts

@@ -255,7 +255,7 @@ interface RefDef<Input extends Record<keyof Output, JSONValue>, Output extends R
     summary?: string | undefined;
 }
 declare class KRef<Input extends Record<keyof Output, JSONValue>, Output extends Record<keyof Input, any>> extends BaseSchema<Input, Output, RefDef<Input, Output>> {
-    static create: <Input_1 extends Record<keyof Output_1, JSONValue>, Output_1 extends Record<keyof Input_1, JSONValue>>(name: string, shape: { [K in keyof Input_1 | keyof Output_1]: BaseSchema<Input_1[K], Output_1[K], BaseSchemaDef<Input_1[K]>>; }) => KRef<Input_1, Output_1>;
+    static create: <Input_1 extends Record<keyof Output_1, JSONValue>, Output_1 extends Record<keyof Input_1, any>>(name: string, shape: { [K in keyof Input_1 | keyof Output_1]: BaseSchema<Input_1[K], Output_1[K], BaseSchemaDef<Input_1[K]>>; }) => KRef<Input_1, Output_1>;
     serialize(value: Output): Input;
     visit(visitor: (schema: BaseSchema<any, any, any>) => void): void;
     example(): never;
@@ -328,7 +328,7 @@ declare const k: {
     boolean: () => KBoolean;
     array: <ItemsInput extends JSONValue, ItemsOutput, Def extends BaseSchemaDef<ItemsInput>>(items: BaseSchema<ItemsInput, ItemsOutput, Def>) => KArray<ItemsInput, ItemsOutput>;
     null: () => KNull;
-    ref: <Input extends Record<keyof Output, JSONValue>, Output extends Record<keyof Input, JSONValue>>(name: string, shape: { [K in keyof Input | keyof Output]: BaseSchema<Input[K], Output[K], BaseSchemaDef<Input[K]>>; }) => KRef<Input, Output>;
+    ref: <Input extends Record<keyof Output, JSONValue>, Output extends Record<keyof Input, any>>(name: string, shape: { [K in keyof Input | keyof Output]: BaseSchema<Input[K], Output[K], BaseSchemaDef<Input[K]>>; }) => KRef<Input, Output>;
     object: <Input extends Record<keyof Output, any>, Output extends Record<keyof Input, any>>(shape: { [K in keyof Input | keyof Output]: BaseSchema<Input[K], Output[K], BaseSchemaDef<Input[K]>>; }) => KObject<Input, Output>;
     scalar: <ClientRepresentation extends JSONPrimitive, ServerRepresentation>(options: ScalarOptions<ClientRepresentation, ServerRepresentation>) => KScalar<ClientRepresentation, ServerRepresentation>;
     literal: <Value extends string | number | boolean>(value: Value) => KLiteral<Value>;

package/dist/schema/schema.d.ts

@@ -255,7 +255,7 @@ interface RefDef<Input extends Record<keyof Output, JSONValue>, Output extends R
     summary?: string | undefined;
 }
 declare class KRef<Input extends Record<keyof Output, JSONValue>, Output extends Record<keyof Input, any>> extends BaseSchema<Input, Output, RefDef<Input, Output>> {
-    static create: <Input_1 extends Record<keyof Output_1, JSONValue>, Output_1 extends Record<keyof Input_1, JSONValue>>(name: string, shape: { [K in keyof Input_1 | keyof Output_1]: BaseSchema<Input_1[K], Output_1[K], BaseSchemaDef<Input_1[K]>>; }) => KRef<Input_1, Output_1>;
+    static create: <Input_1 extends Record<keyof Output_1, JSONValue>, Output_1 extends Record<keyof Input_1, any>>(name: string, shape: { [K in keyof Input_1 | keyof Output_1]: BaseSchema<Input_1[K], Output_1[K], BaseSchemaDef<Input_1[K]>>; }) => KRef<Input_1, Output_1>;
     serialize(value: Output): Input;
     visit(visitor: (schema: BaseSchema<any, any, any>) => void): void;
     example(): never;
@@ -328,7 +328,7 @@ declare const k: {
     boolean: () => KBoolean;
     array: <ItemsInput extends JSONValue, ItemsOutput, Def extends BaseSchemaDef<ItemsInput>>(items: BaseSchema<ItemsInput, ItemsOutput, Def>) => KArray<ItemsInput, ItemsOutput>;
     null: () => KNull;
-    ref: <Input extends Record<keyof Output, JSONValue>, Output extends Record<keyof Input, JSONValue>>(name: string, shape: { [K in keyof Input | keyof Output]: BaseSchema<Input[K], Output[K], BaseSchemaDef<Input[K]>>; }) => KRef<Input, Output>;
+    ref: <Input extends Record<keyof Output, JSONValue>, Output extends Record<keyof Input, any>>(name: string, shape: { [K in keyof Input | keyof Output]: BaseSchema<Input[K], Output[K], BaseSchemaDef<Input[K]>>; }) => KRef<Input, Output>;
     object: <Input extends Record<keyof Output, any>, Output extends Record<keyof Input, any>>(shape: { [K in keyof Input | keyof Output]: BaseSchema<Input[K], Output[K], BaseSchemaDef<Input[K]>>; }) => KObject<Input, Output>;
     scalar: <ClientRepresentation extends JSONPrimitive, ServerRepresentation>(options: ScalarOptions<ClientRepresentation, ServerRepresentation>) => KScalar<ClientRepresentation, ServerRepresentation>;
     literal: <Value extends string | number | boolean>(value: Value) => KLiteral<Value>;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@kaito-http/core",
   "type": "module",
-  "version": "4.0.0-beta.23",
+  "version": "4.0.0-beta.25",
   "author": "Alistair Smith <hi@alistair.sh>",
   "repository": "https://github.com/kaito-http/kaito",
   "dependencies": {