@moostjs/event-http 0.5.29 → 0.5.31

package/dist/index.cjs

@@ -1,4 +1,3 @@
-"use strict";
 //#region rolldown:runtime
 var __create = Object.create;
 var __defProp = Object.defineProperty;
@@ -47,7 +46,11 @@ const Patch = (path) => HttpMethod("PATCH", path);
 
 //#endregion
 //#region packages/event-http/src/decorators/resolve.decorator.ts
-const StatusHook = () => (0, moost.Resolve)((metas, level) => {
+/**
+* Hook to the Response Status
+* @decorator
+* @paramType TStatusHook
+*/ const StatusHook = () => (0, moost.Resolve)((metas, level) => {
 	const hook = (0, __wooksjs_event_http.useStatus)();
 	if (level === "PARAM") return hook;
 	if (level === "PROP" && metas.instance && metas.key) {
@@ -59,7 +62,12 @@ const StatusHook = () => (0, moost.Resolve)((metas, level) => {
 		return typeof initialValue === "number" ? initialValue : 200;
 	}
 }, "statusCode");
-const HeaderHook = (name) => (0, moost.Resolve)((metas, level) => {
+/**
+* Hook to the Response Header
+* @decorator
+* @param name - header name
+* @paramType THeaderHook
+*/ const HeaderHook = (name) => (0, moost.Resolve)((metas, level) => {
 	const hook = (0, __wooksjs_event_http.useSetHeader)(name);
 	if (level === "PARAM") return hook;
 	if (level === "PROP" && metas.instance && metas.key) {
@@ -71,7 +79,12 @@ const HeaderHook = (name) => (0, moost.Resolve)((metas, level) => {
 		return typeof initialValue === "string" ? initialValue : "";
 	}
 }, name);
-const CookieHook = (name) => (0, moost.Resolve)((metas, level) => {
+/**
+* Hook to the Response Cookie
+* @decorator
+* @param name - cookie name
+* @paramType TCookieHook
+*/ const CookieHook = (name) => (0, moost.Resolve)((metas, level) => {
 	const hook = (0, __wooksjs_event_http.useSetCookie)(name);
 	if (level === "PARAM") return hook;
 	if (level === "PROP" && metas.instance && metas.key) {
@@ -83,7 +96,12 @@ const CookieHook = (name) => (0, moost.Resolve)((metas, level) => {
 		return typeof initialValue === "string" ? initialValue : "";
 	}
 }, name);
-const CookieAttrsHook = (name) => (0, moost.Resolve)((metas, level) => {
+/**
+* Hook to the Response Cookie Attributes
+* @decorator
+* @param name - cookie name
+* @paramType TCookieAttributes
+*/ const CookieAttrsHook = (name) => (0, moost.Resolve)((metas, level) => {
 	const hook = (0, __wooksjs_event_http.useSetCookie)(name);
 	if (level === "PARAM") return (0, __wooksjs_event_core.attachHook)({}, {
 		get: () => hook.attrs,
@@ -98,28 +116,49 @@ const CookieAttrsHook = (name) => (0, moost.Resolve)((metas, level) => {
 		return typeof initialValue === "object" ? initialValue : {};
 	}
 }, name);
-function Authorization(name) {
+/**
+* Parse Authorisation Header
+* @decorator
+* @param name - define what to take from the Auth header
+* @paramType string
+*/ function Authorization(name) {
 	return (0, moost.Resolve)(() => {
 		const auth = (0, __wooksjs_event_http.useAuthorization)();
 		switch (name) {
-			case "username": return auth.isBasic() ? auth.basicCredentials()?.username : undefined;
-			case "password": return auth.isBasic() ? auth.basicCredentials()?.password : undefined;
-			case "bearer": return auth.isBearer() ? auth.authorization : undefined;
+			case "username": return auth.isBasic() ? auth.basicCredentials()?.username : void 0;
+			case "password": return auth.isBasic() ? auth.basicCredentials()?.password : void 0;
+			case "bearer": return auth.isBearer() ? auth.authorization : void 0;
 			case "raw": return auth.authRawCredentials();
 			case "type": return auth.authType();
+			default: return void 0;
 		}
 	}, "authorization");
 }
-function Header(name) {
+/**
+* Get Request Header Value
+* @decorator
+* @param name - header name
+* @paramType string
+*/ function Header(name) {
 	return (0, moost.Resolve)(() => {
 		const headers = (0, __wooksjs_event_http.useHeaders)();
 		return headers[name];
 	}, `header: ${name}`);
 }
-function Cookie(name) {
+/**
+* Get Request Cookie Value
+* @decorator
+* @param name - cookie name
+* @paramType string
+*/ function Cookie(name) {
 	return (0, moost.Resolve)(() => (0, __wooksjs_event_http.useCookies)().getCookie(name), `cookie: ${name}`);
 }
-function Query(name) {
+/**
+* Get Query Item value or the whole parsed Query as an object
+* @decorator
+* @param name - query item name (optional)
+* @paramType string | object
+*/ function Query(name) {
 	const isItem = !!name;
 	const _name = isItem ? name : "Query";
 	return (0, moost.getMoostMate)().apply((0, moost.getMoostMate)().decorate("paramSource", isItem ? "QUERY_ITEM" : "QUERY"), (0, moost.getMoostMate)().decorate("paramName", _name), (0, moost.Resolve)(() => {
@@ -127,37 +166,74 @@ function Query(name) {
 		if (isItem) {
 			const p = urlSearchParams();
 			const value = p.get(name);
-			return value === null ? undefined : value;
+			return value === null ? void 0 : value;
 		}
 		const json = jsonSearchParams();
-		return Object.keys(json).length > 0 ? json : undefined;
+		return Object.keys(json).length > 0 ? json : void 0;
 	}, _name));
 }
-function Url() {
+/**
+* Get Requested URL
+* @decorator
+* @paramType string
+*/ function Url() {
 	return (0, moost.Resolve)(() => (0, __wooksjs_event_http.useRequest)().url || "", "url");
 }
-function Method() {
+/**
+* Get Requested HTTP Method
+* @decorator
+* @paramType string
+*/ function Method() {
 	return (0, moost.Resolve)(() => (0, __wooksjs_event_http.useRequest)().method, "http_method");
 }
-function Req() {
+/**
+* Get Raw Request Instance
+* @decorator
+* @paramType IncomingMessage
+*/ function Req() {
 	return (0, moost.Resolve)(() => (0, __wooksjs_event_http.useRequest)().rawRequest, "request");
 }
-function Res(opts) {
+/**
+* Get Raw Response Instance
+* @decorator
+* @param opts (optional) { passthrough: boolean }
+* @paramType ServerResponse
+*/ function Res(opts) {
 	return (0, moost.Resolve)(() => (0, __wooksjs_event_http.useResponse)().rawResponse(opts), "response");
 }
-function ReqId() {
+/**
+* Get Request Unique Identificator (UUID)
+* @decorator
+* @paramType string
+*/ function ReqId() {
 	return (0, moost.Resolve)(() => (0, __wooksjs_event_http.useRequest)().reqId(), "reqId");
 }
-function Ip(opts) {
+/**
+* Get Request IP Address
+* @decorator
+* @paramType string
+*/ function Ip(opts) {
 	return (0, moost.Resolve)(() => (0, __wooksjs_event_http.useRequest)().getIp(opts), "ip");
 }
-function IpList() {
+/**
+* Get Request IP Address list
+* @decorator
+* @paramType string[]
+*/ function IpList() {
 	return (0, moost.Resolve)(() => (0, __wooksjs_event_http.useRequest)().getIpList(), "ipList");
 }
-function Body() {
+/**
+* Get Parsed Request Body
+* @decorator
+* @paramType object | string | unknown
+*/ function Body() {
 	return (0, moost.getMoostMate)().apply((0, moost.getMoostMate)().decorate("paramSource", "BODY"), (0, moost.Resolve)(() => (0, __wooksjs_http_body.useBody)().parseBody(), "body"));
 }
-function RawBody() {
+/**
+* Get Raw Request Body Buffer
+* @decorator
+* @paramType Promise<Buffer>
+*/ function RawBody() {
 	return (0, moost.Resolve)(() => (0, __wooksjs_http_body.useBody)().rawBody(), "body");
 }
 
@@ -176,7 +252,43 @@ const setHeaderInterceptor = (name, value, opts) => {
 	fn.priority = moost.TInterceptorPriority.AFTER_ALL;
 	return fn;
 };
-function SetHeader(...args) {
+/**
+* Set Header for Request Handler
+*
+* ```ts
+* import { Get, SetHeader } from '@moostjs/event-http';
+* import { Controller } from 'moost';
+*
+* @Controller()
+* export class ExampleController {
+*   @Get('test')
+*   // setting header for request handler
+*   @SetHeader('x-server', 'my-server')
+*   testHandler() {
+*     return '...'
+*   }
+* }
+* ```
+*
+* ```ts
+* import { Get, SetHeader } from '@moostjs/event-http';
+* import { Controller } from 'moost';
+*
+* @Controller()
+* export class ExampleController {
+*   @Get('test')
+*   // setting header only if status = 400
+*   @SetHeader('content-type', 'text/plain', { status: 400 })
+*   testHandler() {
+*     return '...'
+*   }
+* }
+* ```
+*
+* @param name  name of header
+* @param value value for header
+* @param options options { status?: number, force?: boolean }
+*/ function SetHeader(...args) {
 	return (0, moost.Intercept)(setHeaderInterceptor(...args));
 }
 const setCookieInterceptor = (name, value, attrs) => {
@@ -189,7 +301,27 @@ const setCookieInterceptor = (name, value, attrs) => {
 	fn.priority = moost.TInterceptorPriority.AFTER_ALL;
 	return fn;
 };
-function SetCookie(...args) {
+/**
+* Set Cookie for Request Handler
+* ```ts
+* import { Get, SetCookie } from '@moostjs/event-http';
+* import { Controller } from 'moost';
+*
+* @Controller()
+* export class ExampleController {
+*   @Get('test')
+*   // setting 'my-cookie' = 'value' with maxAge of 10 minutes
+*   @SetCookie('my-cookie', 'value', { maxAge: '10m' })
+*   testHandler() {
+*     return '...'
+*   }
+* }
+* ```
+*
+* @param name  name of cookie
+* @param value value for cookie
+* @param attrs cookie attributes
+*/ function SetCookie(...args) {
 	return (0, moost.Intercept)(setCookieInterceptor(...args));
 }
 const setStatusInterceptor = (code, opts) => (0, moost.defineInterceptorFn)((before, after) => {
@@ -198,24 +330,69 @@ const setStatusInterceptor = (code, opts) => (0, moost.defineInterceptorFn)((bef
 		if (!status.isDefined || opts?.force) status.value = code;
 	});
 });
-function SetStatus(...args) {
+/**
+* Set Response Status for Request Handler
+*
+* ```ts
+* import { Get, SetStatus } from '@moostjs/event-http';
+* import { Controller } from 'moost';
+*
+* @Controller()
+* export class ExampleController {
+*   @Get('test')
+*   @SetStatus(201)
+*   testHandler() {
+*     return '...'
+*   }
+* }
+* ```
+* @param code number
+* @param opts optional { force?: boolean }
+*/ function SetStatus(...args) {
 	return (0, moost.Intercept)(setStatusInterceptor(...args));
 }
 
 //#endregion
 //#region packages/event-http/src/decorators/limits.decorator.ts
-const globalBodySizeLimit = (n) => (0, moost.defineInterceptorFn)(() => {
+/**
+* Creates an interceptor that sets the maximum allowed inflated body size in bytes.
+*
+* @param n - Maximum body size in bytes after decompression.
+* @returns Interceptor function to enforce the limit.
+*/ const globalBodySizeLimit = (n) => (0, moost.defineInterceptorFn)(() => {
 	(0, __wooksjs_event_http.useRequest)().setMaxInflated(n);
 }, moost.TInterceptorPriority.BEFORE_ALL);
-const globalCompressedBodySizeLimit = (n) => (0, moost.defineInterceptorFn)(() => {
+/**
+* Creates an interceptor that sets the maximum allowed compressed body size in bytes.
+*
+* @param n - Maximum body size in bytes before decompression.
+* @returns Interceptor function to enforce the limit.
+*/ const globalCompressedBodySizeLimit = (n) => (0, moost.defineInterceptorFn)(() => {
 	(0, __wooksjs_event_http.useRequest)().setMaxCompressed(n);
 }, moost.TInterceptorPriority.BEFORE_ALL);
-const globalBodyReadTimeoutMs = (n) => (0, moost.defineInterceptorFn)(() => {
+/**
+* Creates an interceptor that sets the timeout for reading the request body.
+*
+* @param n - Timeout in milliseconds.
+* @returns Interceptor function to enforce the timeout.
+*/ const globalBodyReadTimeoutMs = (n) => (0, moost.defineInterceptorFn)(() => {
 	(0, __wooksjs_event_http.useRequest)().setReadTimeoutMs(n);
 }, moost.TInterceptorPriority.BEFORE_ALL);
-const BodySizeLimit = (n) => (0, moost.Intercept)(globalBodySizeLimit(n));
-const CompressedBodySizeLimit = (n) => (0, moost.Intercept)(globalCompressedBodySizeLimit(n));
-const BodyReadTimeoutMs = (n) => (0, moost.Intercept)(globalBodyReadTimeoutMs(n));
+/**
+* Decorator to limit the maximum inflated body size for the request. Default: 10 MB
+*
+* @param n - Maximum body size in bytes after decompression.
+*/ const BodySizeLimit = (n) => (0, moost.Intercept)(globalBodySizeLimit(n));
+/**
+* Decorator to limit the maximum compressed body size for the request. Default: 1 MB
+*
+* @param n - Maximum body size in bytes before decompression.
+*/ const CompressedBodySizeLimit = (n) => (0, moost.Intercept)(globalCompressedBodySizeLimit(n));
+/**
+* Decorator to set a timeout (in milliseconds) for reading the request body. Default: 10 s
+*
+* @param n - Timeout duration in milliseconds.
+*/ const BodyReadTimeoutMs = (n) => (0, moost.Intercept)(globalBodyReadTimeoutMs(n));
 
 //#endregion
 //#region packages/event-http/src/event-http.ts
@@ -231,7 +408,31 @@ function _define_property(obj, key, value) {
 }
 const LOGGER_TITLE = "moost-http";
 const CONTEXT_TYPE = "HTTP";
-var MoostHttp = class {
+/**
+* ## Moost HTTP Adapter
+*
+* Moost Adapter for HTTP events
+*
+* ```ts
+* │  // HTTP server example
+* │  import { MoostHttp, Get } from '@moostjs/event-http'
+* │  import { Moost, Param } from 'moost'
+* │
+* │  class MyServer extends Moost {
+* │      @Get('test/:name')
+* │      test(@Param('name') name: string) {
+* │          return { message: `Hello ${name}!` }
+* │      }
+* │  }
+* │
+* │  const app = new MyServer()
+* │  const http = new MoostHttp()
+* │  app.adapter(http).listen(3000, () => {
+* │      app.getLogger('MyApp').log('Up on port 3000')
+* │  })
+* │  app.init()
+* ```
+*/ var MoostHttp = class {
 	getHttpApp() {
 		return this.httpApp;
 	}
@@ -296,7 +497,7 @@ var MoostHttp = class {
 					methods.DELETE = pathBuilder;
 				} else methods[handler.method] = pathBuilder;
 			}
-			opts.logHandler(`${"\x1B[36m"}(${handler.method})${"\x1B[32m"}${targetPath}`);
+			opts.logHandler(`(${handler.method})${targetPath}`);
 			const args = routerBinding.getArgs();
 			const params = {};
 			args.forEach((a) => params[a] = `{${a}}`);
@@ -318,46 +519,46 @@ var MoostHttp = class {
 };
 
 //#endregion
-exports.All = All
-exports.Authorization = Authorization
-exports.Body = Body
-exports.BodyReadTimeoutMs = BodyReadTimeoutMs
-exports.BodySizeLimit = BodySizeLimit
-exports.CompressedBodySizeLimit = CompressedBodySizeLimit
-exports.Cookie = Cookie
-exports.CookieAttrsHook = CookieAttrsHook
-exports.CookieHook = CookieHook
-exports.Delete = Delete
-exports.Get = Get
-exports.Header = Header
-exports.HeaderHook = HeaderHook
+exports.All = All;
+exports.Authorization = Authorization;
+exports.Body = Body;
+exports.BodyReadTimeoutMs = BodyReadTimeoutMs;
+exports.BodySizeLimit = BodySizeLimit;
+exports.CompressedBodySizeLimit = CompressedBodySizeLimit;
+exports.Cookie = Cookie;
+exports.CookieAttrsHook = CookieAttrsHook;
+exports.CookieHook = CookieHook;
+exports.Delete = Delete;
+exports.Get = Get;
+exports.Header = Header;
+exports.HeaderHook = HeaderHook;
 Object.defineProperty(exports, 'HttpError', {
   enumerable: true,
   get: function () {
     return __wooksjs_event_http.HttpError;
   }
 });
-exports.HttpMethod = HttpMethod
-exports.Ip = Ip
-exports.IpList = IpList
-exports.Method = Method
-exports.MoostHttp = MoostHttp
-exports.Patch = Patch
-exports.Post = Post
-exports.Put = Put
-exports.Query = Query
-exports.RawBody = RawBody
-exports.Req = Req
-exports.ReqId = ReqId
-exports.Res = Res
-exports.SetCookie = SetCookie
-exports.SetHeader = SetHeader
-exports.SetStatus = SetStatus
-exports.StatusHook = StatusHook
-exports.Url = Url
-exports.globalBodyReadTimeoutMs = globalBodyReadTimeoutMs
-exports.globalBodySizeLimit = globalBodySizeLimit
-exports.globalCompressedBodySizeLimit = globalCompressedBodySizeLimit
+exports.HttpMethod = HttpMethod;
+exports.Ip = Ip;
+exports.IpList = IpList;
+exports.Method = Method;
+exports.MoostHttp = MoostHttp;
+exports.Patch = Patch;
+exports.Post = Post;
+exports.Put = Put;
+exports.Query = Query;
+exports.RawBody = RawBody;
+exports.Req = Req;
+exports.ReqId = ReqId;
+exports.Res = Res;
+exports.SetCookie = SetCookie;
+exports.SetHeader = SetHeader;
+exports.SetStatus = SetStatus;
+exports.StatusHook = StatusHook;
+exports.Url = Url;
+exports.globalBodyReadTimeoutMs = globalBodyReadTimeoutMs;
+exports.globalBodySizeLimit = globalBodySizeLimit;
+exports.globalCompressedBodySizeLimit = globalCompressedBodySizeLimit;
 Object.defineProperty(exports, 'useHttpContext', {
   enumerable: true,
   get: function () {

package/dist/index.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="node" />
 import { THook } from '@wooksjs/event-core';
 import { TCookieAttributes as TCookieAttributes$1, useSetCookies, WooksHttp, TWooksHttpOptions } from '@wooksjs/event-http';
 export { HttpError, TCacheControl, TCookieAttributesInput, TSetCookieData, useHttpContext } from '@wooksjs/event-http';
@@ -17,26 +16,119 @@ declare const Put: (path?: string) => MethodDecorator;
 declare const Delete: (path?: string) => MethodDecorator;
 declare const Patch: (path?: string) => MethodDecorator;
 
+/**
+ * Hook to the Response Status
+ * @decorator
+ * @paramType TStatusHook
+ */
 declare const StatusHook: () => ParameterDecorator & PropertyDecorator;
+/**
+ * Hook to the Response Header
+ * @decorator
+ * @param name - header name
+ * @paramType THeaderHook
+ */
 declare const HeaderHook: (name: string) => ParameterDecorator & PropertyDecorator;
+/**
+ * Hook to the Response Cookie
+ * @decorator
+ * @param name - cookie name
+ * @paramType TCookieHook
+ */
 declare const CookieHook: (name: string) => ParameterDecorator & PropertyDecorator;
+/**
+ * Hook to the Response Cookie Attributes
+ * @decorator
+ * @param name - cookie name
+ * @paramType TCookieAttributes
+ */
 declare const CookieAttrsHook: (name: string) => ParameterDecorator & PropertyDecorator;
+/**
+ * Parse Authorisation Header
+ * @decorator
+ * @param name - define what to take from the Auth header
+ * @paramType string
+ */
 declare function Authorization(name: 'username' | 'password' | 'bearer' | 'raw' | 'type'): ParameterDecorator & PropertyDecorator;
+/**
+ * Get Request Header Value
+ * @decorator
+ * @param name - header name
+ * @paramType string
+ */
 declare function Header(name: string): ParameterDecorator & PropertyDecorator;
+/**
+ * Get Request Cookie Value
+ * @decorator
+ * @param name - cookie name
+ * @paramType string
+ */
 declare function Cookie(name: string): ParameterDecorator & PropertyDecorator;
+/**
+ * Get Query Item value or the whole parsed Query as an object
+ * @decorator
+ * @param name - query item name (optional)
+ * @paramType string | object
+ */
 declare function Query(name?: string): ParameterDecorator;
+/**
+ * Get Requested URL
+ * @decorator
+ * @paramType string
+ */
 declare function Url(): ParameterDecorator & PropertyDecorator;
+/**
+ * Get Requested HTTP Method
+ * @decorator
+ * @paramType string
+ */
 declare function Method(): ParameterDecorator & PropertyDecorator;
+/**
+ * Get Raw Request Instance
+ * @decorator
+ * @paramType IncomingMessage
+ */
 declare function Req(): ParameterDecorator & PropertyDecorator;
+/**
+ * Get Raw Response Instance
+ * @decorator
+ * @param opts (optional) { passthrough: boolean }
+ * @paramType ServerResponse
+ */
 declare function Res(opts?: {
     passthrough: boolean;
 }): ParameterDecorator & PropertyDecorator;
+/**
+ * Get Request Unique Identificator (UUID)
+ * @decorator
+ * @paramType string
+ */
 declare function ReqId(): ParameterDecorator & PropertyDecorator;
+/**
+ * Get Request IP Address
+ * @decorator
+ * @paramType string
+ */
 declare function Ip(opts?: {
     trustProxy: boolean;
 }): ParameterDecorator & PropertyDecorator;
+/**
+ * Get Request IP Address list
+ * @decorator
+ * @paramType string[]
+ */
 declare function IpList(): ParameterDecorator & PropertyDecorator;
+/**
+ * Get Parsed Request Body
+ * @decorator
+ * @paramType object | string | unknown
+ */
 declare function Body(): MethodDecorator & ClassDecorator & ParameterDecorator & PropertyDecorator;
+/**
+ * Get Raw Request Body Buffer
+ * @decorator
+ * @paramType Promise<Buffer>
+ */
 declare function RawBody(): ParameterDecorator & PropertyDecorator;
 type TStatusHook = THook<number>;
 type THeaderHook = THook;
@@ -48,31 +140,166 @@ declare const setHeaderInterceptor: (name: string, value: string, opts?: {
     status?: number;
     when?: 'always' | 'error' | 'ok';
 }) => TInterceptorFn;
+/**
+ * Set Header for Request Handler
+ *
+ * ```ts
+ * import { Get, SetHeader } from '@moostjs/event-http';
+ * import { Controller } from 'moost';
+ *
+ * @Controller()
+ * export class ExampleController {
+ *   @Get('test')
+ *   // setting header for request handler
+ *   @SetHeader('x-server', 'my-server')
+ *   testHandler() {
+ *     return '...'
+ *   }
+ * }
+ * ```
+ *
+ * ```ts
+ * import { Get, SetHeader } from '@moostjs/event-http';
+ * import { Controller } from 'moost';
+ *
+ * @Controller()
+ * export class ExampleController {
+ *   @Get('test')
+ *   // setting header only if status = 400
+ *   @SetHeader('content-type', 'text/plain', { status: 400 })
+ *   testHandler() {
+ *     return '...'
+ *   }
+ * }
+ * ```
+ *
+ * @param name  name of header
+ * @param value value for header
+ * @param options options { status?: number, force?: boolean }
+ */
 declare function SetHeader(...args: Parameters<typeof setHeaderInterceptor>): ClassDecorator & MethodDecorator;
 declare const setCookieInterceptor: (...args: Parameters<ReturnType<typeof useSetCookies>['setCookie']>) => TInterceptorFn;
+/**
+ * Set Cookie for Request Handler
+ * ```ts
+ * import { Get, SetCookie } from '@moostjs/event-http';
+ * import { Controller } from 'moost';
+ *
+ * @Controller()
+ * export class ExampleController {
+ *   @Get('test')
+ *   // setting 'my-cookie' = 'value' with maxAge of 10 minutes
+ *   @SetCookie('my-cookie', 'value', { maxAge: '10m' })
+ *   testHandler() {
+ *     return '...'
+ *   }
+ * }
+ * ```
+ *
+ * @param name  name of cookie
+ * @param value value for cookie
+ * @param attrs cookie attributes
+ */
 declare function SetCookie(...args: Parameters<typeof setCookieInterceptor>): ClassDecorator & MethodDecorator;
 declare const setStatusInterceptor: (code: number, opts?: {
     force?: boolean;
 }) => TInterceptorFn;
+/**
+ * Set Response Status for Request Handler
+ *
+ * ```ts
+ * import { Get, SetStatus } from '@moostjs/event-http';
+ * import { Controller } from 'moost';
+ *
+ * @Controller()
+ * export class ExampleController {
+ *   @Get('test')
+ *   @SetStatus(201)
+ *   testHandler() {
+ *     return '...'
+ *   }
+ * }
+ * ```
+ * @param code number
+ * @param opts optional { force?: boolean }
+ */
 declare function SetStatus(...args: Parameters<typeof setStatusInterceptor>): ClassDecorator & MethodDecorator;
 
+/**
+ * Creates an interceptor that sets the maximum allowed inflated body size in bytes.
+ *
+ * @param n - Maximum body size in bytes after decompression.
+ * @returns Interceptor function to enforce the limit.
+ */
 declare const globalBodySizeLimit: (n: number) => moost.TInterceptorFn;
+/**
+ * Creates an interceptor that sets the maximum allowed compressed body size in bytes.
+ *
+ * @param n - Maximum body size in bytes before decompression.
+ * @returns Interceptor function to enforce the limit.
+ */
 declare const globalCompressedBodySizeLimit: (n: number) => moost.TInterceptorFn;
+/**
+ * Creates an interceptor that sets the timeout for reading the request body.
+ *
+ * @param n - Timeout in milliseconds.
+ * @returns Interceptor function to enforce the timeout.
+ */
 declare const globalBodyReadTimeoutMs: (n: number) => moost.TInterceptorFn;
+/**
+ * Decorator to limit the maximum inflated body size for the request. Default: 10 MB
+ *
+ * @param n - Maximum body size in bytes after decompression.
+ */
 declare const BodySizeLimit: (n: number) => ClassDecorator & MethodDecorator;
+/**
+ * Decorator to limit the maximum compressed body size for the request. Default: 1 MB
+ *
+ * @param n - Maximum body size in bytes before decompression.
+ */
 declare const CompressedBodySizeLimit: (n: number) => ClassDecorator & MethodDecorator;
+/**
+ * Decorator to set a timeout (in milliseconds) for reading the request body. Default: 10 s
+ *
+ * @param n - Timeout duration in milliseconds.
+ */
 declare const BodyReadTimeoutMs: (n: number) => ClassDecorator & MethodDecorator;
 
 interface THttpHandlerMeta {
     method: string;
     path: string;
 }
+/**
+ * ## Moost HTTP Adapter
+ *
+ * Moost Adapter for HTTP events
+ *
+ * ```ts
+ * │  // HTTP server example
+ * │  import { MoostHttp, Get } from '@moostjs/event-http'
+ * │  import { Moost, Param } from 'moost'
+ * │
+ * │  class MyServer extends Moost {
+ * │      @Get('test/:name')
+ * │      test(@Param('name') name: string) {
+ * │          return { message: `Hello ${name}!` }
+ * │      }
+ * │  }
+ * │
+ * │  const app = new MyServer()
+ * │  const http = new MoostHttp()
+ * │  app.adapter(http).listen(3000, () => {
+ * │      app.getLogger('MyApp').log('Up on port 3000')
+ * │  })
+ * │  app.init()
+ * ```
+ */
 declare class MoostHttp implements TMoostAdapter<THttpHandlerMeta> {
     readonly name = "http";
     protected httpApp: WooksHttp;
     constructor(httpApp?: WooksHttp | TWooksHttpOptions);
     getHttpApp(): WooksHttp;
-    getServerCb(): (req: http.IncomingMessage, res: http.ServerResponse<http.IncomingMessage>) => void;
+    getServerCb(): (req: http.IncomingMessage, res: http.ServerResponse) => void;
     listen(port?: number, hostname?: string, backlog?: number, listeningListener?: () => void): Promise<void>;
     listen(port?: number, hostname?: string, listeningListener?: () => void): Promise<void>;
     listen(port?: number, backlog?: number, listeningListener?: () => void): Promise<void>;
@@ -97,4 +324,5 @@ declare class MoostHttp implements TMoostAdapter<THttpHandlerMeta> {
     bindHandler<T extends object = object>(opts: TMoostAdapterOptions<THttpHandlerMeta, T>): void;
 }
 
-export { All, Authorization, Body, BodyReadTimeoutMs, BodySizeLimit, CompressedBodySizeLimit, Cookie, CookieAttrsHook, CookieHook, Delete, Get, Header, HeaderHook, HttpMethod, Ip, IpList, Method, MoostHttp, Patch, Post, Put, Query, RawBody, Req, ReqId, Res, SetCookie, SetHeader, SetStatus, StatusHook, type TCookieAttributes, type TCookieHook, type THeaderHook, type THttpHandlerMeta, type TStatusHook, Url, globalBodyReadTimeoutMs, globalBodySizeLimit, globalCompressedBodySizeLimit };
+export { All, Authorization, Body, BodyReadTimeoutMs, BodySizeLimit, CompressedBodySizeLimit, Cookie, CookieAttrsHook, CookieHook, Delete, Get, Header, HeaderHook, HttpMethod, Ip, IpList, Method, MoostHttp, Patch, Post, Put, Query, RawBody, Req, ReqId, Res, SetCookie, SetHeader, SetStatus, StatusHook, Url, globalBodyReadTimeoutMs, globalBodySizeLimit, globalCompressedBodySizeLimit };
+export type { TCookieAttributes, TCookieHook, THeaderHook, THttpHandlerMeta, TStatusHook };

package/dist/index.mjs

@@ -1,6 +1,6 @@
 import { Intercept, Resolve, TInterceptorPriority, defineInterceptorFn, defineMoostEventHandler, getMoostMate } from "moost";
 import { attachHook } from "@wooksjs/event-core";
-import { HttpError, WooksHttp, createHttpApp, useAuthorization, useCookies, useHeaders, useHttpContext, useRequest, useResponse, useSearchParams, useSetCookie, useSetCookies, useSetHeader, useStatus } from "@wooksjs/event-http";
+import { HttpError, HttpError as HttpError$1, WooksHttp, createHttpApp, useAuthorization, useCookies, useHeaders, useHttpContext, useRequest, useResponse, useSearchParams, useSetCookie, useSetCookies, useSetHeader, useStatus } from "@wooksjs/event-http";
 import { useBody } from "@wooksjs/http-body";
 import { createProvideRegistry } from "@prostojs/infact";
 import { Server } from "http";
@@ -23,7 +23,11 @@ const Patch = (path) => HttpMethod("PATCH", path);
 
 //#endregion
 //#region packages/event-http/src/decorators/resolve.decorator.ts
-const StatusHook = () => Resolve((metas, level) => {
+/**
+* Hook to the Response Status
+* @decorator
+* @paramType TStatusHook
+*/ const StatusHook = () => Resolve((metas, level) => {
 	const hook = useStatus();
 	if (level === "PARAM") return hook;
 	if (level === "PROP" && metas.instance && metas.key) {
@@ -35,7 +39,12 @@ const StatusHook = () => Resolve((metas, level) => {
 		return typeof initialValue === "number" ? initialValue : 200;
 	}
 }, "statusCode");
-const HeaderHook = (name) => Resolve((metas, level) => {
+/**
+* Hook to the Response Header
+* @decorator
+* @param name - header name
+* @paramType THeaderHook
+*/ const HeaderHook = (name) => Resolve((metas, level) => {
 	const hook = useSetHeader(name);
 	if (level === "PARAM") return hook;
 	if (level === "PROP" && metas.instance && metas.key) {
@@ -47,7 +56,12 @@ const HeaderHook = (name) => Resolve((metas, level) => {
 		return typeof initialValue === "string" ? initialValue : "";
 	}
 }, name);
-const CookieHook = (name) => Resolve((metas, level) => {
+/**
+* Hook to the Response Cookie
+* @decorator
+* @param name - cookie name
+* @paramType TCookieHook
+*/ const CookieHook = (name) => Resolve((metas, level) => {
 	const hook = useSetCookie(name);
 	if (level === "PARAM") return hook;
 	if (level === "PROP" && metas.instance && metas.key) {
@@ -59,7 +73,12 @@ const CookieHook = (name) => Resolve((metas, level) => {
 		return typeof initialValue === "string" ? initialValue : "";
 	}
 }, name);
-const CookieAttrsHook = (name) => Resolve((metas, level) => {
+/**
+* Hook to the Response Cookie Attributes
+* @decorator
+* @param name - cookie name
+* @paramType TCookieAttributes
+*/ const CookieAttrsHook = (name) => Resolve((metas, level) => {
 	const hook = useSetCookie(name);
 	if (level === "PARAM") return attachHook({}, {
 		get: () => hook.attrs,
@@ -74,28 +93,49 @@ const CookieAttrsHook = (name) => Resolve((metas, level) => {
 		return typeof initialValue === "object" ? initialValue : {};
 	}
 }, name);
-function Authorization(name) {
+/**
+* Parse Authorisation Header
+* @decorator
+* @param name - define what to take from the Auth header
+* @paramType string
+*/ function Authorization(name) {
 	return Resolve(() => {
 		const auth = useAuthorization();
 		switch (name) {
-			case "username": return auth.isBasic() ? auth.basicCredentials()?.username : undefined;
-			case "password": return auth.isBasic() ? auth.basicCredentials()?.password : undefined;
-			case "bearer": return auth.isBearer() ? auth.authorization : undefined;
+			case "username": return auth.isBasic() ? auth.basicCredentials()?.username : void 0;
+			case "password": return auth.isBasic() ? auth.basicCredentials()?.password : void 0;
+			case "bearer": return auth.isBearer() ? auth.authorization : void 0;
 			case "raw": return auth.authRawCredentials();
 			case "type": return auth.authType();
+			default: return void 0;
 		}
 	}, "authorization");
 }
-function Header(name) {
+/**
+* Get Request Header Value
+* @decorator
+* @param name - header name
+* @paramType string
+*/ function Header(name) {
 	return Resolve(() => {
 		const headers = useHeaders();
 		return headers[name];
 	}, `header: ${name}`);
 }
-function Cookie(name) {
+/**
+* Get Request Cookie Value
+* @decorator
+* @param name - cookie name
+* @paramType string
+*/ function Cookie(name) {
 	return Resolve(() => useCookies().getCookie(name), `cookie: ${name}`);
 }
-function Query(name) {
+/**
+* Get Query Item value or the whole parsed Query as an object
+* @decorator
+* @param name - query item name (optional)
+* @paramType string | object
+*/ function Query(name) {
 	const isItem = !!name;
 	const _name = isItem ? name : "Query";
 	return getMoostMate().apply(getMoostMate().decorate("paramSource", isItem ? "QUERY_ITEM" : "QUERY"), getMoostMate().decorate("paramName", _name), Resolve(() => {
@@ -103,37 +143,74 @@ function Query(name) {
 		if (isItem) {
 			const p = urlSearchParams();
 			const value = p.get(name);
-			return value === null ? undefined : value;
+			return value === null ? void 0 : value;
 		}
 		const json = jsonSearchParams();
-		return Object.keys(json).length > 0 ? json : undefined;
+		return Object.keys(json).length > 0 ? json : void 0;
 	}, _name));
 }
-function Url() {
+/**
+* Get Requested URL
+* @decorator
+* @paramType string
+*/ function Url() {
 	return Resolve(() => useRequest().url || "", "url");
 }
-function Method() {
+/**
+* Get Requested HTTP Method
+* @decorator
+* @paramType string
+*/ function Method() {
 	return Resolve(() => useRequest().method, "http_method");
 }
-function Req() {
+/**
+* Get Raw Request Instance
+* @decorator
+* @paramType IncomingMessage
+*/ function Req() {
 	return Resolve(() => useRequest().rawRequest, "request");
 }
-function Res(opts) {
+/**
+* Get Raw Response Instance
+* @decorator
+* @param opts (optional) { passthrough: boolean }
+* @paramType ServerResponse
+*/ function Res(opts) {
 	return Resolve(() => useResponse().rawResponse(opts), "response");
 }
-function ReqId() {
+/**
+* Get Request Unique Identificator (UUID)
+* @decorator
+* @paramType string
+*/ function ReqId() {
 	return Resolve(() => useRequest().reqId(), "reqId");
 }
-function Ip(opts) {
+/**
+* Get Request IP Address
+* @decorator
+* @paramType string
+*/ function Ip(opts) {
 	return Resolve(() => useRequest().getIp(opts), "ip");
 }
-function IpList() {
+/**
+* Get Request IP Address list
+* @decorator
+* @paramType string[]
+*/ function IpList() {
 	return Resolve(() => useRequest().getIpList(), "ipList");
 }
-function Body() {
+/**
+* Get Parsed Request Body
+* @decorator
+* @paramType object | string | unknown
+*/ function Body() {
 	return getMoostMate().apply(getMoostMate().decorate("paramSource", "BODY"), Resolve(() => useBody().parseBody(), "body"));
 }
-function RawBody() {
+/**
+* Get Raw Request Body Buffer
+* @decorator
+* @paramType Promise<Buffer>
+*/ function RawBody() {
 	return Resolve(() => useBody().rawBody(), "body");
 }
 
@@ -152,7 +229,43 @@ const setHeaderInterceptor = (name, value, opts) => {
 	fn.priority = TInterceptorPriority.AFTER_ALL;
 	return fn;
 };
-function SetHeader(...args) {
+/**
+* Set Header for Request Handler
+*
+* ```ts
+* import { Get, SetHeader } from '@moostjs/event-http';
+* import { Controller } from 'moost';
+*
+* @Controller()
+* export class ExampleController {
+*   @Get('test')
+*   // setting header for request handler
+*   @SetHeader('x-server', 'my-server')
+*   testHandler() {
+*     return '...'
+*   }
+* }
+* ```
+*
+* ```ts
+* import { Get, SetHeader } from '@moostjs/event-http';
+* import { Controller } from 'moost';
+*
+* @Controller()
+* export class ExampleController {
+*   @Get('test')
+*   // setting header only if status = 400
+*   @SetHeader('content-type', 'text/plain', { status: 400 })
+*   testHandler() {
+*     return '...'
+*   }
+* }
+* ```
+*
+* @param name  name of header
+* @param value value for header
+* @param options options { status?: number, force?: boolean }
+*/ function SetHeader(...args) {
 	return Intercept(setHeaderInterceptor(...args));
 }
 const setCookieInterceptor = (name, value, attrs) => {
@@ -165,7 +278,27 @@ const setCookieInterceptor = (name, value, attrs) => {
 	fn.priority = TInterceptorPriority.AFTER_ALL;
 	return fn;
 };
-function SetCookie(...args) {
+/**
+* Set Cookie for Request Handler
+* ```ts
+* import { Get, SetCookie } from '@moostjs/event-http';
+* import { Controller } from 'moost';
+*
+* @Controller()
+* export class ExampleController {
+*   @Get('test')
+*   // setting 'my-cookie' = 'value' with maxAge of 10 minutes
+*   @SetCookie('my-cookie', 'value', { maxAge: '10m' })
+*   testHandler() {
+*     return '...'
+*   }
+* }
+* ```
+*
+* @param name  name of cookie
+* @param value value for cookie
+* @param attrs cookie attributes
+*/ function SetCookie(...args) {
 	return Intercept(setCookieInterceptor(...args));
 }
 const setStatusInterceptor = (code, opts) => defineInterceptorFn((before, after) => {
@@ -174,24 +307,69 @@ const setStatusInterceptor = (code, opts) => defineInterceptorFn((before, after)
 		if (!status.isDefined || opts?.force) status.value = code;
 	});
 });
-function SetStatus(...args) {
+/**
+* Set Response Status for Request Handler
+*
+* ```ts
+* import { Get, SetStatus } from '@moostjs/event-http';
+* import { Controller } from 'moost';
+*
+* @Controller()
+* export class ExampleController {
+*   @Get('test')
+*   @SetStatus(201)
+*   testHandler() {
+*     return '...'
+*   }
+* }
+* ```
+* @param code number
+* @param opts optional { force?: boolean }
+*/ function SetStatus(...args) {
 	return Intercept(setStatusInterceptor(...args));
 }
 
 //#endregion
 //#region packages/event-http/src/decorators/limits.decorator.ts
-const globalBodySizeLimit = (n) => defineInterceptorFn(() => {
+/**
+* Creates an interceptor that sets the maximum allowed inflated body size in bytes.
+*
+* @param n - Maximum body size in bytes after decompression.
+* @returns Interceptor function to enforce the limit.
+*/ const globalBodySizeLimit = (n) => defineInterceptorFn(() => {
 	useRequest().setMaxInflated(n);
 }, TInterceptorPriority.BEFORE_ALL);
-const globalCompressedBodySizeLimit = (n) => defineInterceptorFn(() => {
+/**
+* Creates an interceptor that sets the maximum allowed compressed body size in bytes.
+*
+* @param n - Maximum body size in bytes before decompression.
+* @returns Interceptor function to enforce the limit.
+*/ const globalCompressedBodySizeLimit = (n) => defineInterceptorFn(() => {
 	useRequest().setMaxCompressed(n);
 }, TInterceptorPriority.BEFORE_ALL);
-const globalBodyReadTimeoutMs = (n) => defineInterceptorFn(() => {
+/**
+* Creates an interceptor that sets the timeout for reading the request body.
+*
+* @param n - Timeout in milliseconds.
+* @returns Interceptor function to enforce the timeout.
+*/ const globalBodyReadTimeoutMs = (n) => defineInterceptorFn(() => {
 	useRequest().setReadTimeoutMs(n);
 }, TInterceptorPriority.BEFORE_ALL);
-const BodySizeLimit = (n) => Intercept(globalBodySizeLimit(n));
-const CompressedBodySizeLimit = (n) => Intercept(globalCompressedBodySizeLimit(n));
-const BodyReadTimeoutMs = (n) => Intercept(globalBodyReadTimeoutMs(n));
+/**
+* Decorator to limit the maximum inflated body size for the request. Default: 10 MB
+*
+* @param n - Maximum body size in bytes after decompression.
+*/ const BodySizeLimit = (n) => Intercept(globalBodySizeLimit(n));
+/**
+* Decorator to limit the maximum compressed body size for the request. Default: 1 MB
+*
+* @param n - Maximum body size in bytes before decompression.
+*/ const CompressedBodySizeLimit = (n) => Intercept(globalCompressedBodySizeLimit(n));
+/**
+* Decorator to set a timeout (in milliseconds) for reading the request body. Default: 10 s
+*
+* @param n - Timeout duration in milliseconds.
+*/ const BodyReadTimeoutMs = (n) => Intercept(globalBodyReadTimeoutMs(n));
 
 //#endregion
 //#region packages/event-http/src/event-http.ts
@@ -207,7 +385,31 @@ function _define_property(obj, key, value) {
 }
 const LOGGER_TITLE = "moost-http";
 const CONTEXT_TYPE = "HTTP";
-var MoostHttp = class {
+/**
+* ## Moost HTTP Adapter
+*
+* Moost Adapter for HTTP events
+*
+* ```ts
+* │  // HTTP server example
+* │  import { MoostHttp, Get } from '@moostjs/event-http'
+* │  import { Moost, Param } from 'moost'
+* │
+* │  class MyServer extends Moost {
+* │      @Get('test/:name')
+* │      test(@Param('name') name: string) {
+* │          return { message: `Hello ${name}!` }
+* │      }
+* │  }
+* │
+* │  const app = new MyServer()
+* │  const http = new MoostHttp()
+* │  app.adapter(http).listen(3000, () => {
+* │      app.getLogger('MyApp').log('Up on port 3000')
+* │  })
+* │  app.init()
+* ```
+*/ var MoostHttp = class {
 	getHttpApp() {
 		return this.httpApp;
 	}
@@ -222,7 +424,7 @@ var MoostHttp = class {
 			loggerTitle: LOGGER_TITLE,
 			getIterceptorHandler: () => this.moost?.getGlobalInterceptorHandler(),
 			getControllerInstance: () => this.moost,
-			callControllerMethod: () => new HttpError(404, "Resource Not Found"),
+			callControllerMethod: () => new HttpError$1(404, "Resource Not Found"),
 			targetPath: "",
 			handlerType: "__SYSTEM__"
 		})();
@@ -272,7 +474,7 @@ var MoostHttp = class {
 					methods.DELETE = pathBuilder;
 				} else methods[handler.method] = pathBuilder;
 			}
-			opts.logHandler(`${"\x1B[36m"}(${handler.method})${"\x1B[32m"}${targetPath}`);
+			opts.logHandler(`(${handler.method})${targetPath}`);
 			const args = routerBinding.getArgs();
 			const params = {};
 			args.forEach((a) => params[a] = `{${a}}`);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@moostjs/event-http",
-  "version": "0.5.29",
+  "version": "0.5.31",
   "description": "@moostjs/event-http",
   "main": "dist/index.cjs",
   "module": "dist/index.mjs",
@@ -37,16 +37,18 @@
     "url": "https://github.com/moostjs/moostjs/issues"
   },
   "homepage": "https://github.com/moostjs/moostjs/tree/main/packages/event-http#readme",
-  "dependencies": {
+  "peerDependencies": {
+    "@wooksjs/event-core": "^0.6.1",
     "@prostojs/infact": "^0.3.3",
     "@prostojs/router": "^0.2.1",
-    "@wooksjs/event-core": "^0.6.0",
-    "@wooksjs/event-http": "^0.6.0",
-    "@wooksjs/http-body": "^0.6.0",
-    "moost": "^0.5.29"
+    "moost": "^0.5.31"
+  },
+  "dependencies": {
+    "@wooksjs/event-http": "^0.6.1",
+    "@wooksjs/http-body": "^0.6.1"
   },
   "devDependencies": {
-    "vitest": "^3.0.5"
+    "vitest": "3.2.4"
   },
   "scripts": {
     "pub": "pnpm publish --access public",