@kaito-http/core 2.7.2 → 2.8.1

package/dist/declarations/src/router.d.ts

@@ -14,13 +14,6 @@ export declare class Router<Context, R extends Routes> {
     static create: <Context_1>() => Router<Context_1, []>;
     private static handle;
     constructor(routes: R);
-    /**
-     * Adds a new route to the router
-     * @param route The route specification to add to this router
-     * @returns A new router with this route added
-     * @deprecated Use `Router#add` instead
-     */
-    old_add: <Result, Path extends string, Method extends KaitoMethod, Query extends AnyQueryDefinition = {}, BodyOutput = never, BodyDef extends z.ZodTypeDef = z.ZodTypeDef, BodyInput = BodyOutput>(route: Method extends "GET" ? Omit<Route<Context, Result, Path, Method, Query, BodyOutput, BodyDef, BodyInput>, "body"> : Route<Context, Result, Path, Method, Query, BodyOutput, BodyDef, BodyInput>) => Router<Context, [...R, Route<Context, Result, Path, Method, Query, BodyOutput, BodyDef, BodyInput>]>;
     /**
      * Adds a new route to the router
      * @param method The HTTP method to add a route for
@@ -29,7 +22,15 @@ export declare class Router<Context, R extends Routes> {
      * @returns A new router with this route added
      */
     add: <Result, Path extends string, Method extends KaitoMethod, Query extends AnyQueryDefinition = {}, BodyOutput = never, BodyDef extends z.ZodTypeDef = z.ZodTypeDef, BodyInput = BodyOutput>(method: Method, path: Path, route: ((args: import("./route").RouteArgument<Path, Context, z.objectUtil.addQuestionMarks<{ [k_1 in keyof Query]: Query[k_1]["_output"]; }> extends infer T extends object ? { [k in keyof T]: z.objectUtil.addQuestionMarks<{ [k_1 in keyof Query]: Query[k_1]["_output"]; }>[k]; } : never, BodyOutput>) => Promise<Result>) | (Method extends "GET" ? Omit<Route<Context, Result, Path, Method, Query, BodyOutput, BodyDef, BodyInput>, "path" | "body" | "method"> : Omit<Route<Context, Result, Path, Method, Query, BodyOutput, BodyDef, BodyInput>, "path" | "method">)) => Router<Context, [...R, Route<Context, Result, Path, Method, Query, BodyOutput, BodyDef, BodyInput>]>;
-    merge: <PathPrefix extends `/${string}`, OtherRoutes extends Routes>(pathPrefix: PathPrefix, other: Router<Context, OtherRoutes>) => Router<Context, [...R, ...PrefixRoutesPath<PathPrefix, OtherRoutes>]>;
-    toFindMyWay: (server: ServerConfig<Context, any>) => fmw.Instance<fmw.HTTPVersion.V1>;
+    readonly merge: <PathPrefix extends `/${string}`, OtherRoutes extends Routes>(pathPrefix: PathPrefix, other: Router<Context, OtherRoutes>) => Router<Context, [...R, ...PrefixRoutesPath<PathPrefix, OtherRoutes>]>;
+    freeze: (server: ServerConfig<Context, any>) => fmw.Instance<fmw.HTTPVersion.V1>;
+    private readonly method;
+    get: <Result, Path extends string, Query extends AnyQueryDefinition = {}, BodyOutput = never, BodyDef extends z.ZodTypeDef = z.ZodTypeDef, BodyInput = BodyOutput>(path: Path, route: ((args: import("./route").RouteArgument<Path, Context, z.objectUtil.addQuestionMarks<{ [k_1 in keyof Query]: Query[k_1]["_output"]; }> extends infer T extends object ? { [k in keyof T]: z.objectUtil.addQuestionMarks<{ [k_1 in keyof Query]: Query[k_1]["_output"]; }>[k]; } : never, BodyOutput>) => Promise<Result>) | Omit<Route<Context, Result, Path, "GET", Query, BodyOutput, BodyDef, BodyInput>, "path" | "body" | "method">) => Router<Context, [...R, Route<Context, Result, Path, "GET", Query, BodyOutput, BodyDef, BodyInput>]>;
+    post: <Result, Path extends string, Query extends AnyQueryDefinition = {}, BodyOutput = never, BodyDef extends z.ZodTypeDef = z.ZodTypeDef, BodyInput = BodyOutput>(path: Path, route: ((args: import("./route").RouteArgument<Path, Context, z.objectUtil.addQuestionMarks<{ [k_1 in keyof Query]: Query[k_1]["_output"]; }> extends infer T extends object ? { [k in keyof T]: z.objectUtil.addQuestionMarks<{ [k_1 in keyof Query]: Query[k_1]["_output"]; }>[k]; } : never, BodyOutput>) => Promise<Result>) | Omit<Route<Context, Result, Path, "POST", Query, BodyOutput, BodyDef, BodyInput>, "path" | "method">) => Router<Context, [...R, Route<Context, Result, Path, "POST", Query, BodyOutput, BodyDef, BodyInput>]>;
+    put: <Result, Path extends string, Query extends AnyQueryDefinition = {}, BodyOutput = never, BodyDef extends z.ZodTypeDef = z.ZodTypeDef, BodyInput = BodyOutput>(path: Path, route: ((args: import("./route").RouteArgument<Path, Context, z.objectUtil.addQuestionMarks<{ [k_1 in keyof Query]: Query[k_1]["_output"]; }> extends infer T extends object ? { [k in keyof T]: z.objectUtil.addQuestionMarks<{ [k_1 in keyof Query]: Query[k_1]["_output"]; }>[k]; } : never, BodyOutput>) => Promise<Result>) | Omit<Route<Context, Result, Path, "PUT", Query, BodyOutput, BodyDef, BodyInput>, "path" | "method">) => Router<Context, [...R, Route<Context, Result, Path, "PUT", Query, BodyOutput, BodyDef, BodyInput>]>;
+    patch: <Result, Path extends string, Query extends AnyQueryDefinition = {}, BodyOutput = never, BodyDef extends z.ZodTypeDef = z.ZodTypeDef, BodyInput = BodyOutput>(path: Path, route: ((args: import("./route").RouteArgument<Path, Context, z.objectUtil.addQuestionMarks<{ [k_1 in keyof Query]: Query[k_1]["_output"]; }> extends infer T extends object ? { [k in keyof T]: z.objectUtil.addQuestionMarks<{ [k_1 in keyof Query]: Query[k_1]["_output"]; }>[k]; } : never, BodyOutput>) => Promise<Result>) | Omit<Route<Context, Result, Path, "PATCH", Query, BodyOutput, BodyDef, BodyInput>, "path" | "method">) => Router<Context, [...R, Route<Context, Result, Path, "PATCH", Query, BodyOutput, BodyDef, BodyInput>]>;
+    delete: <Result, Path extends string, Query extends AnyQueryDefinition = {}, BodyOutput = never, BodyDef extends z.ZodTypeDef = z.ZodTypeDef, BodyInput = BodyOutput>(path: Path, route: ((args: import("./route").RouteArgument<Path, Context, z.objectUtil.addQuestionMarks<{ [k_1 in keyof Query]: Query[k_1]["_output"]; }> extends infer T extends object ? { [k in keyof T]: z.objectUtil.addQuestionMarks<{ [k_1 in keyof Query]: Query[k_1]["_output"]; }>[k]; } : never, BodyOutput>) => Promise<Result>) | Omit<Route<Context, Result, Path, "DELETE", Query, BodyOutput, BodyDef, BodyInput>, "path" | "method">) => Router<Context, [...R, Route<Context, Result, Path, "DELETE", Query, BodyOutput, BodyDef, BodyInput>]>;
+    head: <Result, Path extends string, Query extends AnyQueryDefinition = {}, BodyOutput = never, BodyDef extends z.ZodTypeDef = z.ZodTypeDef, BodyInput = BodyOutput>(path: Path, route: ((args: import("./route").RouteArgument<Path, Context, z.objectUtil.addQuestionMarks<{ [k_1 in keyof Query]: Query[k_1]["_output"]; }> extends infer T extends object ? { [k in keyof T]: z.objectUtil.addQuestionMarks<{ [k_1 in keyof Query]: Query[k_1]["_output"]; }>[k]; } : never, BodyOutput>) => Promise<Result>) | Omit<Route<Context, Result, Path, "HEAD", Query, BodyOutput, BodyDef, BodyInput>, "path" | "method">) => Router<Context, [...R, Route<Context, Result, Path, "HEAD", Query, BodyOutput, BodyDef, BodyInput>]>;
+    options: <Result, Path extends string, Query extends AnyQueryDefinition = {}, BodyOutput = never, BodyDef extends z.ZodTypeDef = z.ZodTypeDef, BodyInput = BodyOutput>(path: Path, route: ((args: import("./route").RouteArgument<Path, Context, z.objectUtil.addQuestionMarks<{ [k_1 in keyof Query]: Query[k_1]["_output"]; }> extends infer T extends object ? { [k in keyof T]: z.objectUtil.addQuestionMarks<{ [k_1 in keyof Query]: Query[k_1]["_output"]; }>[k]; } : never, BodyOutput>) => Promise<Result>) | Omit<Route<Context, Result, Path, "OPTIONS", Query, BodyOutput, BodyDef, BodyInput>, "path" | "method">) => Router<Context, [...R, Route<Context, Result, Path, "OPTIONS", Query, BodyOutput, BodyDef, BodyInput>]>;
 }
 export {};

package/dist/declarations/src/util.d.ts

@@ -1,6 +1,7 @@
 import type { HTTPMethod } from 'find-my-way';
 import type { KaitoRequest } from './req';
 import type { KaitoResponse } from './res';
+import { Router } from './router';
 export 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}` ? {
@@ -8,7 +9,32 @@ export type ExtractRouteParams<T extends string> = string extends T ? Record<str
 } : {};
 export type KaitoMethod = HTTPMethod | '*';
 export type GetContext<Result> = (req: KaitoRequest, res: KaitoResponse) => Promise<Result>;
+/**
+ * @deprecated use `createUtilities` instead
+ */
 export declare function createGetContext<Context>(callback: GetContext<Context>): GetContext<Context>;
+/**
+ * A helper function to create typed necessary functions
+ *
+ * @example
+ * ```ts
+ * const {router, getContext} = createUtilities(async (req, res) => {
+ *   // Return context here
+ * })
+ *
+ * const app = router().get('/', async () => "hello");
+ *
+ * const server = createServer({
+ *   router: app,
+ *   getContext,
+ *   // ...
+ * });
+ * ```
+ */
+export declare function createUtilities<Context>(getContext: GetContext<Context>): {
+    getContext: GetContext<Context>;
+    router: () => Router<Context, []>;
+};
 export type InferContext<T> = T extends (req: KaitoRequest, res: KaitoResponse) => Promise<infer U> ? U : never;
 export declare function getLastEntryInMultiHeaderValue(headerValue: string | string[]): string;
 type RemoveEndSlashes<T extends string> = T extends `${infer U}/` ? U : T;

package/dist/kaito-http-core.cjs.dev.js

@@ -7,9 +7,9 @@ var contentType = require('content-type');
 var node_stream = require('node:stream');
 var consumers = require('node:stream/consumers');
 var getRawBody = require('raw-body');
-var cookie = require('cookie');
 var fmw = require('find-my-way');
 var zod = require('zod');
+var cookie = require('cookie');
 var http = require('node:http');
 
 function _interopDefault (e) { return e && e.__esModule ? e : { 'default': e }; }
@@ -103,104 +103,26 @@ function _asyncToGenerator(fn) {
   };
 }
 
-function createGetContext(callback) {
-  return callback;
-}
-function getLastEntryInMultiHeaderValue(headerValue) {
-  var normalized = Array.isArray(headerValue) ? headerValue.join(',') : headerValue;
-  var lastIndex = normalized.lastIndexOf(',');
-  return lastIndex === -1 ? normalized.trim() : normalized.slice(lastIndex + 1).trim();
-}
-function getBody(_x) {
-  return _getBody.apply(this, arguments);
-}
-function _getBody() {
-  _getBody = _asyncToGenerator(function* (req) {
-    if (!req.headers['content-type']) {
-      return null;
-    }
-    var buffer = yield getRawBody__default["default"](req.raw);
-    var {
-      type
-    } = contentType.parse(req.headers['content-type']);
-    switch (type) {
-      case 'application/json':
-        {
-          return consumers.json(node_stream.Readable.from(buffer));
-        }
-      default:
-        {
-          if (process.env.NODE_ENV === 'development') {
-            console.warn('[kaito] Unsupported content type:', type);
-            console.warn('[kaito] This message is only shown in development mode.');
-          }
-          return null;
-        }
-    }
-  });
-  return _getBody.apply(this, arguments);
-}
-
-class KaitoRequest {
-  constructor(raw) {
-    _defineProperty(this, "_url", null);
-    this.raw = raw;
-  }
-
-  /**
-   * The full URL of the request, including the protocol, hostname, and path.
-   * Note: does not include the query string or hash
-   */
-  get fullURL() {
-    var _this$raw$url;
-    return "".concat(this.protocol, "://").concat(this.hostname).concat((_this$raw$url = this.raw.url) !== null && _this$raw$url !== void 0 ? _this$raw$url : '');
-  }
-
-  /**
-   * A new URL instance for the full URL of the request.
-   */
-  get url() {
-    if (this._url) {
-      return this._url;
-    }
-    this._url = new URL(this.fullURL);
-    return this._url;
-  }
-
-  /**
-   * The HTTP method of the request.
-   */
-  get method() {
-    if (!this.raw.method) {
-      throw new Error('Request method is not defined, somehow...');
-    }
-    return this.raw.method;
-  }
-
-  /**
-   * The protocol of the request, either `http` or `https`.
-   */
-  get protocol() {
-    if (this.raw.socket instanceof node_tls.TLSSocket) {
-      return this.raw.socket.encrypted ? 'https' : 'http';
-    }
-    return 'http';
-  }
-
-  /**
-   * The request headers
-   */
-  get headers() {
-    return this.raw.headers;
+function ownKeys(object, enumerableOnly) {
+  var keys = Object.keys(object);
+  if (Object.getOwnPropertySymbols) {
+    var symbols = Object.getOwnPropertySymbols(object);
+    enumerableOnly && (symbols = symbols.filter(function (sym) {
+      return Object.getOwnPropertyDescriptor(object, sym).enumerable;
+    })), keys.push.apply(keys, symbols);
   }
-
-  /**
-   * The hostname of the request.
-   */
-  get hostname() {
-    var _this$raw$headers$hos, _this$raw$headers$Au;
-    return (_this$raw$headers$hos = this.raw.headers.host) !== null && _this$raw$headers$hos !== void 0 ? _this$raw$headers$hos : getLastEntryInMultiHeaderValue((_this$raw$headers$Au = this.raw.headers[':authority']) !== null && _this$raw$headers$Au !== void 0 ? _this$raw$headers$Au : []);
+  return keys;
+}
+function _objectSpread2(target) {
+  for (var i = 1; i < arguments.length; i++) {
+    var source = null != arguments[i] ? arguments[i] : {};
+    i % 2 ? ownKeys(Object(source), !0).forEach(function (key) {
+      _defineProperty(target, key, source[key]);
+    }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)) : ownKeys(Object(source)).forEach(function (key) {
+      Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key));
+    });
   }
+  return target;
 }
 
 class KaitoResponse {
@@ -255,28 +177,6 @@ class KaitoResponse {
   }
 }
 
-function ownKeys(object, enumerableOnly) {
-  var keys = Object.keys(object);
-  if (Object.getOwnPropertySymbols) {
-    var symbols = Object.getOwnPropertySymbols(object);
-    enumerableOnly && (symbols = symbols.filter(function (sym) {
-      return Object.getOwnPropertyDescriptor(object, sym).enumerable;
-    })), keys.push.apply(keys, symbols);
-  }
-  return keys;
-}
-function _objectSpread2(target) {
-  for (var i = 1; i < arguments.length; i++) {
-    var source = null != arguments[i] ? arguments[i] : {};
-    i % 2 ? ownKeys(Object(source), !0).forEach(function (key) {
-      _defineProperty(target, key, source[key]);
-    }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)) : ownKeys(Object(source)).forEach(function (key) {
-      Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key));
-    });
-  }
-  return target;
-}
-
 var getSend = res => (status, response) => {
   if (res.raw.headersSent) {
     return;
@@ -353,7 +253,6 @@ class Router {
     })();
   }
   constructor(routes) {
-    _defineProperty(this, "old_add", route => new Router([...this.routes, route]));
     _defineProperty(this, "add", (method, path, route) => {
       var merged = _objectSpread2(_objectSpread2({}, typeof route === 'object' ? route : {
         run: route
@@ -369,7 +268,7 @@ class Router {
       }));
       return new Router([...this.routes, ...newRoutes]);
     });
-    _defineProperty(this, "toFindMyWay", server => {
+    _defineProperty(this, "freeze", server => {
       var instance = fmw__default["default"]({
         ignoreTrailingSlash: true,
         defaultRoute(req, serverResponse) {
@@ -419,21 +318,158 @@ class Router {
       }
       return instance;
     });
+    _defineProperty(this, "method", method => (path, route) => this.add(method, path, route));
+    _defineProperty(this, "get", this.method('GET'));
+    _defineProperty(this, "post", this.method('POST'));
+    _defineProperty(this, "put", this.method('PUT'));
+    _defineProperty(this, "patch", this.method('PATCH'));
+    _defineProperty(this, "delete", this.method('DELETE'));
+    _defineProperty(this, "head", this.method('HEAD'));
+    _defineProperty(this, "options", this.method('OPTIONS'));
     this.routes = routes;
   }
 
   /**
    * Adds a new route to the router
+   * @param method The HTTP method to add a route for
+   * @param path The path to add a route for
    * @param route The route specification to add to this router
    * @returns A new router with this route added
-   * @deprecated Use `Router#add` instead
    */
 }
 _defineProperty(Router, "create", () => new Router([]));
 
+/**
+ * @deprecated use `createUtilities` instead
+ */
+function createGetContext(callback) {
+  return callback;
+}
+
+/**
+ * A helper function to create typed necessary functions
+ *
+ * @example
+ * ```ts
+ * const {router, getContext} = createUtilities(async (req, res) => {
+ *   // Return context here
+ * })
+ *
+ * const app = router().get('/', async () => "hello");
+ *
+ * const server = createServer({
+ *   router: app,
+ *   getContext,
+ *   // ...
+ * });
+ * ```
+ */
+function createUtilities(getContext) {
+  return {
+    getContext,
+    router: () => Router.create()
+  };
+}
+function getLastEntryInMultiHeaderValue(headerValue) {
+  var normalized = Array.isArray(headerValue) ? headerValue.join(',') : headerValue;
+  var lastIndex = normalized.lastIndexOf(',');
+  return lastIndex === -1 ? normalized.trim() : normalized.slice(lastIndex + 1).trim();
+}
+function getBody(_x) {
+  return _getBody.apply(this, arguments);
+}
+function _getBody() {
+  _getBody = _asyncToGenerator(function* (req) {
+    if (!req.headers['content-type']) {
+      return null;
+    }
+    var buffer = yield getRawBody__default["default"](req.raw);
+    var {
+      type
+    } = contentType.parse(req.headers['content-type']);
+    switch (type) {
+      case 'application/json':
+        {
+          return consumers.json(node_stream.Readable.from(buffer));
+        }
+      default:
+        {
+          if (process.env.NODE_ENV === 'development') {
+            console.warn('[kaito] Unsupported content type:', type);
+            console.warn('[kaito] This message is only shown in development mode.');
+          }
+          return null;
+        }
+    }
+  });
+  return _getBody.apply(this, arguments);
+}
+
+class KaitoRequest {
+  constructor(raw) {
+    _defineProperty(this, "_url", null);
+    this.raw = raw;
+  }
+
+  /**
+   * The full URL of the request, including the protocol, hostname, and path.
+   * Note: does not include the query string or hash
+   */
+  get fullURL() {
+    var _this$raw$url;
+    return "".concat(this.protocol, "://").concat(this.hostname).concat((_this$raw$url = this.raw.url) !== null && _this$raw$url !== void 0 ? _this$raw$url : '');
+  }
+
+  /**
+   * A new URL instance for the full URL of the request.
+   */
+  get url() {
+    if (this._url) {
+      return this._url;
+    }
+    this._url = new URL(this.fullURL);
+    return this._url;
+  }
+
+  /**
+   * The HTTP method of the request.
+   */
+  get method() {
+    if (!this.raw.method) {
+      throw new Error('Request method is not defined, somehow...');
+    }
+    return this.raw.method;
+  }
+
+  /**
+   * The protocol of the request, either `http` or `https`.
+   */
+  get protocol() {
+    if (this.raw.socket instanceof node_tls.TLSSocket) {
+      return this.raw.socket.encrypted ? 'https' : 'http';
+    }
+    return 'http';
+  }
+
+  /**
+   * The request headers
+   */
+  get headers() {
+    return this.raw.headers;
+  }
+
+  /**
+   * The hostname of the request.
+   */
+  get hostname() {
+    var _this$raw$headers$hos, _this$raw$headers$Au;
+    return (_this$raw$headers$hos = this.raw.headers.host) !== null && _this$raw$headers$hos !== void 0 ? _this$raw$headers$hos : getLastEntryInMultiHeaderValue((_this$raw$headers$Au = this.raw.headers[':authority']) !== null && _this$raw$headers$Au !== void 0 ? _this$raw$headers$Au : []);
+  }
+}
+
 function createFMWServer(config) {
   var _config$rawRoutes;
-  var fmw = config.router.toFindMyWay(config);
+  var router = config.router.freeze(config);
   var rawRoutes = (_config$rawRoutes = config.rawRoutes) !== null && _config$rawRoutes !== void 0 ? _config$rawRoutes : {};
   for (var method in rawRoutes) {
     if (!Object.prototype.hasOwnProperty.call(rawRoutes, method)) {
@@ -445,10 +481,10 @@ function createFMWServer(config) {
     }
     for (var route of routes) {
       if (method === '*') {
-        fmw.all(route.path, route.handler);
+        router.all(route.path, route.handler);
         continue;
       }
-      fmw[method.toLowerCase()](route.path, route.handler);
+      router[method.toLowerCase()](route.path, route.handler);
     }
   }
   var server = http__namespace.createServer( /*#__PURE__*/function () {
@@ -464,7 +500,7 @@ function createFMWServer(config) {
       if (res.headersSent) {
         return;
       }
-      var result = yield fmw.lookup(req, res);
+      var result = yield router.lookup(req, res);
       if ('after' in config && config.after) {
         yield config.after(before, result);
       }
@@ -475,7 +511,7 @@ function createFMWServer(config) {
   }());
   return {
     server,
-    fmw
+    fmw: router
   };
 }
 function createServer(config) {
@@ -490,5 +526,6 @@ exports.WrappedError = WrappedError;
 exports.createFMWServer = createFMWServer;
 exports.createGetContext = createGetContext;
 exports.createServer = createServer;
+exports.createUtilities = createUtilities;
 exports.getBody = getBody;
 exports.getLastEntryInMultiHeaderValue = getLastEntryInMultiHeaderValue;

package/dist/kaito-http-core.cjs.prod.js

@@ -7,9 +7,9 @@ var contentType = require('content-type');
 var node_stream = require('node:stream');
 var consumers = require('node:stream/consumers');
 var getRawBody = require('raw-body');
-var cookie = require('cookie');
 var fmw = require('find-my-way');
 var zod = require('zod');
+var cookie = require('cookie');
 var http = require('node:http');
 
 function _interopDefault (e) { return e && e.__esModule ? e : { 'default': e }; }
@@ -103,100 +103,26 @@ function _asyncToGenerator(fn) {
   };
 }
 
-function createGetContext(callback) {
-  return callback;
-}
-function getLastEntryInMultiHeaderValue(headerValue) {
-  var normalized = Array.isArray(headerValue) ? headerValue.join(',') : headerValue;
-  var lastIndex = normalized.lastIndexOf(',');
-  return lastIndex === -1 ? normalized.trim() : normalized.slice(lastIndex + 1).trim();
-}
-function getBody(_x) {
-  return _getBody.apply(this, arguments);
-}
-function _getBody() {
-  _getBody = _asyncToGenerator(function* (req) {
-    if (!req.headers['content-type']) {
-      return null;
-    }
-    var buffer = yield getRawBody__default["default"](req.raw);
-    var {
-      type
-    } = contentType.parse(req.headers['content-type']);
-    switch (type) {
-      case 'application/json':
-        {
-          return consumers.json(node_stream.Readable.from(buffer));
-        }
-      default:
-        {
-          return null;
-        }
-    }
-  });
-  return _getBody.apply(this, arguments);
-}
-
-class KaitoRequest {
-  constructor(raw) {
-    _defineProperty(this, "_url", null);
-    this.raw = raw;
-  }
-
-  /**
-   * The full URL of the request, including the protocol, hostname, and path.
-   * Note: does not include the query string or hash
-   */
-  get fullURL() {
-    var _this$raw$url;
-    return "".concat(this.protocol, "://").concat(this.hostname).concat((_this$raw$url = this.raw.url) !== null && _this$raw$url !== void 0 ? _this$raw$url : '');
-  }
-
-  /**
-   * A new URL instance for the full URL of the request.
-   */
-  get url() {
-    if (this._url) {
-      return this._url;
-    }
-    this._url = new URL(this.fullURL);
-    return this._url;
-  }
-
-  /**
-   * The HTTP method of the request.
-   */
-  get method() {
-    if (!this.raw.method) {
-      throw new Error('Request method is not defined, somehow...');
-    }
-    return this.raw.method;
-  }
-
-  /**
-   * The protocol of the request, either `http` or `https`.
-   */
-  get protocol() {
-    if (this.raw.socket instanceof node_tls.TLSSocket) {
-      return this.raw.socket.encrypted ? 'https' : 'http';
-    }
-    return 'http';
-  }
-
-  /**
-   * The request headers
-   */
-  get headers() {
-    return this.raw.headers;
+function ownKeys(object, enumerableOnly) {
+  var keys = Object.keys(object);
+  if (Object.getOwnPropertySymbols) {
+    var symbols = Object.getOwnPropertySymbols(object);
+    enumerableOnly && (symbols = symbols.filter(function (sym) {
+      return Object.getOwnPropertyDescriptor(object, sym).enumerable;
+    })), keys.push.apply(keys, symbols);
   }
-
-  /**
-   * The hostname of the request.
-   */
-  get hostname() {
-    var _this$raw$headers$hos, _this$raw$headers$Au;
-    return (_this$raw$headers$hos = this.raw.headers.host) !== null && _this$raw$headers$hos !== void 0 ? _this$raw$headers$hos : getLastEntryInMultiHeaderValue((_this$raw$headers$Au = this.raw.headers[':authority']) !== null && _this$raw$headers$Au !== void 0 ? _this$raw$headers$Au : []);
+  return keys;
+}
+function _objectSpread2(target) {
+  for (var i = 1; i < arguments.length; i++) {
+    var source = null != arguments[i] ? arguments[i] : {};
+    i % 2 ? ownKeys(Object(source), !0).forEach(function (key) {
+      _defineProperty(target, key, source[key]);
+    }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)) : ownKeys(Object(source)).forEach(function (key) {
+      Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key));
+    });
   }
+  return target;
 }
 
 class KaitoResponse {
@@ -251,28 +177,6 @@ class KaitoResponse {
   }
 }
 
-function ownKeys(object, enumerableOnly) {
-  var keys = Object.keys(object);
-  if (Object.getOwnPropertySymbols) {
-    var symbols = Object.getOwnPropertySymbols(object);
-    enumerableOnly && (symbols = symbols.filter(function (sym) {
-      return Object.getOwnPropertyDescriptor(object, sym).enumerable;
-    })), keys.push.apply(keys, symbols);
-  }
-  return keys;
-}
-function _objectSpread2(target) {
-  for (var i = 1; i < arguments.length; i++) {
-    var source = null != arguments[i] ? arguments[i] : {};
-    i % 2 ? ownKeys(Object(source), !0).forEach(function (key) {
-      _defineProperty(target, key, source[key]);
-    }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)) : ownKeys(Object(source)).forEach(function (key) {
-      Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key));
-    });
-  }
-  return target;
-}
-
 var getSend = res => (status, response) => {
   if (res.raw.headersSent) {
     return;
@@ -349,7 +253,6 @@ class Router {
     })();
   }
   constructor(routes) {
-    _defineProperty(this, "old_add", route => new Router([...this.routes, route]));
     _defineProperty(this, "add", (method, path, route) => {
       var merged = _objectSpread2(_objectSpread2({}, typeof route === 'object' ? route : {
         run: route
@@ -365,7 +268,7 @@ class Router {
       }));
       return new Router([...this.routes, ...newRoutes]);
     });
-    _defineProperty(this, "toFindMyWay", server => {
+    _defineProperty(this, "freeze", server => {
       var instance = fmw__default["default"]({
         ignoreTrailingSlash: true,
         defaultRoute(req, serverResponse) {
@@ -415,21 +318,154 @@ class Router {
       }
       return instance;
     });
+    _defineProperty(this, "method", method => (path, route) => this.add(method, path, route));
+    _defineProperty(this, "get", this.method('GET'));
+    _defineProperty(this, "post", this.method('POST'));
+    _defineProperty(this, "put", this.method('PUT'));
+    _defineProperty(this, "patch", this.method('PATCH'));
+    _defineProperty(this, "delete", this.method('DELETE'));
+    _defineProperty(this, "head", this.method('HEAD'));
+    _defineProperty(this, "options", this.method('OPTIONS'));
     this.routes = routes;
   }
 
   /**
    * Adds a new route to the router
+   * @param method The HTTP method to add a route for
+   * @param path The path to add a route for
    * @param route The route specification to add to this router
    * @returns A new router with this route added
-   * @deprecated Use `Router#add` instead
    */
 }
 _defineProperty(Router, "create", () => new Router([]));
 
+/**
+ * @deprecated use `createUtilities` instead
+ */
+function createGetContext(callback) {
+  return callback;
+}
+
+/**
+ * A helper function to create typed necessary functions
+ *
+ * @example
+ * ```ts
+ * const {router, getContext} = createUtilities(async (req, res) => {
+ *   // Return context here
+ * })
+ *
+ * const app = router().get('/', async () => "hello");
+ *
+ * const server = createServer({
+ *   router: app,
+ *   getContext,
+ *   // ...
+ * });
+ * ```
+ */
+function createUtilities(getContext) {
+  return {
+    getContext,
+    router: () => Router.create()
+  };
+}
+function getLastEntryInMultiHeaderValue(headerValue) {
+  var normalized = Array.isArray(headerValue) ? headerValue.join(',') : headerValue;
+  var lastIndex = normalized.lastIndexOf(',');
+  return lastIndex === -1 ? normalized.trim() : normalized.slice(lastIndex + 1).trim();
+}
+function getBody(_x) {
+  return _getBody.apply(this, arguments);
+}
+function _getBody() {
+  _getBody = _asyncToGenerator(function* (req) {
+    if (!req.headers['content-type']) {
+      return null;
+    }
+    var buffer = yield getRawBody__default["default"](req.raw);
+    var {
+      type
+    } = contentType.parse(req.headers['content-type']);
+    switch (type) {
+      case 'application/json':
+        {
+          return consumers.json(node_stream.Readable.from(buffer));
+        }
+      default:
+        {
+          return null;
+        }
+    }
+  });
+  return _getBody.apply(this, arguments);
+}
+
+class KaitoRequest {
+  constructor(raw) {
+    _defineProperty(this, "_url", null);
+    this.raw = raw;
+  }
+
+  /**
+   * The full URL of the request, including the protocol, hostname, and path.
+   * Note: does not include the query string or hash
+   */
+  get fullURL() {
+    var _this$raw$url;
+    return "".concat(this.protocol, "://").concat(this.hostname).concat((_this$raw$url = this.raw.url) !== null && _this$raw$url !== void 0 ? _this$raw$url : '');
+  }
+
+  /**
+   * A new URL instance for the full URL of the request.
+   */
+  get url() {
+    if (this._url) {
+      return this._url;
+    }
+    this._url = new URL(this.fullURL);
+    return this._url;
+  }
+
+  /**
+   * The HTTP method of the request.
+   */
+  get method() {
+    if (!this.raw.method) {
+      throw new Error('Request method is not defined, somehow...');
+    }
+    return this.raw.method;
+  }
+
+  /**
+   * The protocol of the request, either `http` or `https`.
+   */
+  get protocol() {
+    if (this.raw.socket instanceof node_tls.TLSSocket) {
+      return this.raw.socket.encrypted ? 'https' : 'http';
+    }
+    return 'http';
+  }
+
+  /**
+   * The request headers
+   */
+  get headers() {
+    return this.raw.headers;
+  }
+
+  /**
+   * The hostname of the request.
+   */
+  get hostname() {
+    var _this$raw$headers$hos, _this$raw$headers$Au;
+    return (_this$raw$headers$hos = this.raw.headers.host) !== null && _this$raw$headers$hos !== void 0 ? _this$raw$headers$hos : getLastEntryInMultiHeaderValue((_this$raw$headers$Au = this.raw.headers[':authority']) !== null && _this$raw$headers$Au !== void 0 ? _this$raw$headers$Au : []);
+  }
+}
+
 function createFMWServer(config) {
   var _config$rawRoutes;
-  var fmw = config.router.toFindMyWay(config);
+  var router = config.router.freeze(config);
   var rawRoutes = (_config$rawRoutes = config.rawRoutes) !== null && _config$rawRoutes !== void 0 ? _config$rawRoutes : {};
   for (var method in rawRoutes) {
     if (!Object.prototype.hasOwnProperty.call(rawRoutes, method)) {
@@ -441,10 +477,10 @@ function createFMWServer(config) {
     }
     for (var route of routes) {
       if (method === '*') {
-        fmw.all(route.path, route.handler);
+        router.all(route.path, route.handler);
         continue;
       }
-      fmw[method.toLowerCase()](route.path, route.handler);
+      router[method.toLowerCase()](route.path, route.handler);
     }
   }
   var server = http__namespace.createServer( /*#__PURE__*/function () {
@@ -460,7 +496,7 @@ function createFMWServer(config) {
       if (res.headersSent) {
         return;
       }
-      var result = yield fmw.lookup(req, res);
+      var result = yield router.lookup(req, res);
       if ('after' in config && config.after) {
         yield config.after(before, result);
       }
@@ -471,7 +507,7 @@ function createFMWServer(config) {
   }());
   return {
     server,
-    fmw
+    fmw: router
   };
 }
 function createServer(config) {
@@ -486,5 +522,6 @@ exports.WrappedError = WrappedError;
 exports.createFMWServer = createFMWServer;
 exports.createGetContext = createGetContext;
 exports.createServer = createServer;
+exports.createUtilities = createUtilities;
 exports.getBody = getBody;
 exports.getLastEntryInMultiHeaderValue = getLastEntryInMultiHeaderValue;

package/dist/kaito-http-core.esm.js

@@ -3,9 +3,9 @@ import { parse } from 'content-type';
 import { Readable } from 'node:stream';
 import { json } from 'node:stream/consumers';
 import getRawBody from 'raw-body';
-import { serialize } from 'cookie';
 import fmw from 'find-my-way';
 import { z } from 'zod';
+import { serialize } from 'cookie';
 import * as http from 'node:http';
 
 class WrappedError extends Error {
@@ -75,104 +75,26 @@ function _asyncToGenerator(fn) {
   };
 }
 
-function createGetContext(callback) {
-  return callback;
-}
-function getLastEntryInMultiHeaderValue(headerValue) {
-  var normalized = Array.isArray(headerValue) ? headerValue.join(',') : headerValue;
-  var lastIndex = normalized.lastIndexOf(',');
-  return lastIndex === -1 ? normalized.trim() : normalized.slice(lastIndex + 1).trim();
-}
-function getBody(_x) {
-  return _getBody.apply(this, arguments);
-}
-function _getBody() {
-  _getBody = _asyncToGenerator(function* (req) {
-    if (!req.headers['content-type']) {
-      return null;
-    }
-    var buffer = yield getRawBody(req.raw);
-    var {
-      type
-    } = parse(req.headers['content-type']);
-    switch (type) {
-      case 'application/json':
-        {
-          return json(Readable.from(buffer));
-        }
-      default:
-        {
-          if (process.env.NODE_ENV === 'development') {
-            console.warn('[kaito] Unsupported content type:', type);
-            console.warn('[kaito] This message is only shown in development mode.');
-          }
-          return null;
-        }
-    }
-  });
-  return _getBody.apply(this, arguments);
-}
-
-class KaitoRequest {
-  constructor(raw) {
-    _defineProperty(this, "_url", null);
-    this.raw = raw;
-  }
-
-  /**
-   * The full URL of the request, including the protocol, hostname, and path.
-   * Note: does not include the query string or hash
-   */
-  get fullURL() {
-    var _this$raw$url;
-    return "".concat(this.protocol, "://").concat(this.hostname).concat((_this$raw$url = this.raw.url) !== null && _this$raw$url !== void 0 ? _this$raw$url : '');
-  }
-
-  /**
-   * A new URL instance for the full URL of the request.
-   */
-  get url() {
-    if (this._url) {
-      return this._url;
-    }
-    this._url = new URL(this.fullURL);
-    return this._url;
-  }
-
-  /**
-   * The HTTP method of the request.
-   */
-  get method() {
-    if (!this.raw.method) {
-      throw new Error('Request method is not defined, somehow...');
-    }
-    return this.raw.method;
-  }
-
-  /**
-   * The protocol of the request, either `http` or `https`.
-   */
-  get protocol() {
-    if (this.raw.socket instanceof TLSSocket) {
-      return this.raw.socket.encrypted ? 'https' : 'http';
-    }
-    return 'http';
-  }
-
-  /**
-   * The request headers
-   */
-  get headers() {
-    return this.raw.headers;
+function ownKeys(object, enumerableOnly) {
+  var keys = Object.keys(object);
+  if (Object.getOwnPropertySymbols) {
+    var symbols = Object.getOwnPropertySymbols(object);
+    enumerableOnly && (symbols = symbols.filter(function (sym) {
+      return Object.getOwnPropertyDescriptor(object, sym).enumerable;
+    })), keys.push.apply(keys, symbols);
   }
-
-  /**
-   * The hostname of the request.
-   */
-  get hostname() {
-    var _this$raw$headers$hos, _this$raw$headers$Au;
-    return (_this$raw$headers$hos = this.raw.headers.host) !== null && _this$raw$headers$hos !== void 0 ? _this$raw$headers$hos : getLastEntryInMultiHeaderValue((_this$raw$headers$Au = this.raw.headers[':authority']) !== null && _this$raw$headers$Au !== void 0 ? _this$raw$headers$Au : []);
+  return keys;
+}
+function _objectSpread2(target) {
+  for (var i = 1; i < arguments.length; i++) {
+    var source = null != arguments[i] ? arguments[i] : {};
+    i % 2 ? ownKeys(Object(source), !0).forEach(function (key) {
+      _defineProperty(target, key, source[key]);
+    }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)) : ownKeys(Object(source)).forEach(function (key) {
+      Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key));
+    });
   }
+  return target;
 }
 
 class KaitoResponse {
@@ -227,28 +149,6 @@ class KaitoResponse {
   }
 }
 
-function ownKeys(object, enumerableOnly) {
-  var keys = Object.keys(object);
-  if (Object.getOwnPropertySymbols) {
-    var symbols = Object.getOwnPropertySymbols(object);
-    enumerableOnly && (symbols = symbols.filter(function (sym) {
-      return Object.getOwnPropertyDescriptor(object, sym).enumerable;
-    })), keys.push.apply(keys, symbols);
-  }
-  return keys;
-}
-function _objectSpread2(target) {
-  for (var i = 1; i < arguments.length; i++) {
-    var source = null != arguments[i] ? arguments[i] : {};
-    i % 2 ? ownKeys(Object(source), !0).forEach(function (key) {
-      _defineProperty(target, key, source[key]);
-    }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)) : ownKeys(Object(source)).forEach(function (key) {
-      Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key));
-    });
-  }
-  return target;
-}
-
 var getSend = res => (status, response) => {
   if (res.raw.headersSent) {
     return;
@@ -325,7 +225,6 @@ class Router {
     })();
   }
   constructor(routes) {
-    _defineProperty(this, "old_add", route => new Router([...this.routes, route]));
     _defineProperty(this, "add", (method, path, route) => {
       var merged = _objectSpread2(_objectSpread2({}, typeof route === 'object' ? route : {
         run: route
@@ -341,7 +240,7 @@ class Router {
       }));
       return new Router([...this.routes, ...newRoutes]);
     });
-    _defineProperty(this, "toFindMyWay", server => {
+    _defineProperty(this, "freeze", server => {
       var instance = fmw({
         ignoreTrailingSlash: true,
         defaultRoute(req, serverResponse) {
@@ -391,21 +290,158 @@ class Router {
       }
       return instance;
     });
+    _defineProperty(this, "method", method => (path, route) => this.add(method, path, route));
+    _defineProperty(this, "get", this.method('GET'));
+    _defineProperty(this, "post", this.method('POST'));
+    _defineProperty(this, "put", this.method('PUT'));
+    _defineProperty(this, "patch", this.method('PATCH'));
+    _defineProperty(this, "delete", this.method('DELETE'));
+    _defineProperty(this, "head", this.method('HEAD'));
+    _defineProperty(this, "options", this.method('OPTIONS'));
     this.routes = routes;
   }
 
   /**
    * Adds a new route to the router
+   * @param method The HTTP method to add a route for
+   * @param path The path to add a route for
    * @param route The route specification to add to this router
    * @returns A new router with this route added
-   * @deprecated Use `Router#add` instead
    */
 }
 _defineProperty(Router, "create", () => new Router([]));
 
+/**
+ * @deprecated use `createUtilities` instead
+ */
+function createGetContext(callback) {
+  return callback;
+}
+
+/**
+ * A helper function to create typed necessary functions
+ *
+ * @example
+ * ```ts
+ * const {router, getContext} = createUtilities(async (req, res) => {
+ *   // Return context here
+ * })
+ *
+ * const app = router().get('/', async () => "hello");
+ *
+ * const server = createServer({
+ *   router: app,
+ *   getContext,
+ *   // ...
+ * });
+ * ```
+ */
+function createUtilities(getContext) {
+  return {
+    getContext,
+    router: () => Router.create()
+  };
+}
+function getLastEntryInMultiHeaderValue(headerValue) {
+  var normalized = Array.isArray(headerValue) ? headerValue.join(',') : headerValue;
+  var lastIndex = normalized.lastIndexOf(',');
+  return lastIndex === -1 ? normalized.trim() : normalized.slice(lastIndex + 1).trim();
+}
+function getBody(_x) {
+  return _getBody.apply(this, arguments);
+}
+function _getBody() {
+  _getBody = _asyncToGenerator(function* (req) {
+    if (!req.headers['content-type']) {
+      return null;
+    }
+    var buffer = yield getRawBody(req.raw);
+    var {
+      type
+    } = parse(req.headers['content-type']);
+    switch (type) {
+      case 'application/json':
+        {
+          return json(Readable.from(buffer));
+        }
+      default:
+        {
+          if (process.env.NODE_ENV === 'development') {
+            console.warn('[kaito] Unsupported content type:', type);
+            console.warn('[kaito] This message is only shown in development mode.');
+          }
+          return null;
+        }
+    }
+  });
+  return _getBody.apply(this, arguments);
+}
+
+class KaitoRequest {
+  constructor(raw) {
+    _defineProperty(this, "_url", null);
+    this.raw = raw;
+  }
+
+  /**
+   * The full URL of the request, including the protocol, hostname, and path.
+   * Note: does not include the query string or hash
+   */
+  get fullURL() {
+    var _this$raw$url;
+    return "".concat(this.protocol, "://").concat(this.hostname).concat((_this$raw$url = this.raw.url) !== null && _this$raw$url !== void 0 ? _this$raw$url : '');
+  }
+
+  /**
+   * A new URL instance for the full URL of the request.
+   */
+  get url() {
+    if (this._url) {
+      return this._url;
+    }
+    this._url = new URL(this.fullURL);
+    return this._url;
+  }
+
+  /**
+   * The HTTP method of the request.
+   */
+  get method() {
+    if (!this.raw.method) {
+      throw new Error('Request method is not defined, somehow...');
+    }
+    return this.raw.method;
+  }
+
+  /**
+   * The protocol of the request, either `http` or `https`.
+   */
+  get protocol() {
+    if (this.raw.socket instanceof TLSSocket) {
+      return this.raw.socket.encrypted ? 'https' : 'http';
+    }
+    return 'http';
+  }
+
+  /**
+   * The request headers
+   */
+  get headers() {
+    return this.raw.headers;
+  }
+
+  /**
+   * The hostname of the request.
+   */
+  get hostname() {
+    var _this$raw$headers$hos, _this$raw$headers$Au;
+    return (_this$raw$headers$hos = this.raw.headers.host) !== null && _this$raw$headers$hos !== void 0 ? _this$raw$headers$hos : getLastEntryInMultiHeaderValue((_this$raw$headers$Au = this.raw.headers[':authority']) !== null && _this$raw$headers$Au !== void 0 ? _this$raw$headers$Au : []);
+  }
+}
+
 function createFMWServer(config) {
   var _config$rawRoutes;
-  var fmw = config.router.toFindMyWay(config);
+  var router = config.router.freeze(config);
   var rawRoutes = (_config$rawRoutes = config.rawRoutes) !== null && _config$rawRoutes !== void 0 ? _config$rawRoutes : {};
   for (var method in rawRoutes) {
     if (!Object.prototype.hasOwnProperty.call(rawRoutes, method)) {
@@ -417,10 +453,10 @@ function createFMWServer(config) {
     }
     for (var route of routes) {
       if (method === '*') {
-        fmw.all(route.path, route.handler);
+        router.all(route.path, route.handler);
         continue;
       }
-      fmw[method.toLowerCase()](route.path, route.handler);
+      router[method.toLowerCase()](route.path, route.handler);
     }
   }
   var server = http.createServer( /*#__PURE__*/function () {
@@ -436,7 +472,7 @@ function createFMWServer(config) {
       if (res.headersSent) {
         return;
       }
-      var result = yield fmw.lookup(req, res);
+      var result = yield router.lookup(req, res);
       if ('after' in config && config.after) {
         yield config.after(before, result);
       }
@@ -447,11 +483,11 @@ function createFMWServer(config) {
   }());
   return {
     server,
-    fmw
+    fmw: router
   };
 }
 function createServer(config) {
   return createFMWServer(config).server;
 }
 
-export { KaitoError, KaitoRequest, KaitoResponse, Router, WrappedError, createFMWServer, createGetContext, createServer, getBody, getLastEntryInMultiHeaderValue };
+export { KaitoError, KaitoRequest, KaitoResponse, Router, WrappedError, createFMWServer, createGetContext, createServer, createUtilities, getBody, getLastEntryInMultiHeaderValue };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kaito-http/core",
-  "version": "2.7.2",
+  "version": "2.8.1",
   "description": "Functional HTTP Framework for TypeScript",
   "repository": "https://github.com/kaito-http/kaito",
   "author": "Alistair Smith <hi@alistair.sh>",