@moostjs/event-http 0.3.11 → 0.3.13

package/dist/index.cjs

@@ -9,31 +9,6 @@ var eventCore = require('@wooksjs/event-core');
 
 const LOGGER_TITLE = 'moost-http';
 const CONTEXT_TYPE = 'HTTP';
-/**
- * ## 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()
- * ```
- */
 class MoostHttp {
     constructor(httpApp) {
         this.pathBuilders = {};
@@ -99,7 +74,7 @@ class MoostHttp {
                 : typeof opts.method === 'string'
                     ? opts.method
                     : '';
-            const targetPath = `${opts.prefix || ''}/${path}`.replace(/\/\/+/g, '/') + `${path.endsWith('//') ? '/' : ''}`; // explicit double slash "//" -> force url to end with slash
+            const targetPath = `${opts.prefix || ''}/${path}`.replace(/\/\/+/g, '/') + `${path.endsWith('//') ? '/' : ''}`;
             if (!fn) {
                 fn = moost.defineMoostEventHandler({
                     contextType: CONTEXT_TYPE,
@@ -112,7 +87,7 @@ class MoostHttp {
                     hooks: {
                         init: ({ unscope }) => {
                             const { rawRequest } = eventHttp.useRequest();
-                            rawRequest.on('end', unscope); // will unscope on request end
+                            rawRequest.on('end', unscope);
                         },
                     },
                 });
@@ -303,11 +278,6 @@ function useBody() {
     };
 }
 
-/**
- * Hook to the Response Status
- * @decorator
- * @paramType TStatusHook
- */
 const StatusHook = () => moost.Resolve((metas, level) => {
     const hook = eventHttp.useStatus();
     if (level === 'PARAM') {
@@ -322,12 +292,6 @@ const StatusHook = () => moost.Resolve((metas, level) => {
         return typeof initialValue === 'number' ? initialValue : 200;
     }
 }, 'statusCode');
-/**
- * Hook to the Response Header
- * @decorator
- * @param name - header name
- * @paramType THeaderHook
- */
 const HeaderHook = (name) => moost.Resolve((metas, level) => {
     const hook = eventHttp.useSetHeader(name);
     if (level === 'PARAM') {
@@ -342,12 +306,6 @@ const HeaderHook = (name) => moost.Resolve((metas, level) => {
         return typeof initialValue === 'string' ? initialValue : '';
     }
 }, name);
-/**
- * Hook to the Response Cookie
- * @decorator
- * @param name - cookie name
- * @paramType TCookieHook
- */
 const CookieHook = (name) => moost.Resolve((metas, level) => {
     const hook = eventHttp.useSetCookie(name);
     if (level === 'PARAM') {
@@ -362,12 +320,6 @@ const CookieHook = (name) => moost.Resolve((metas, level) => {
         return typeof initialValue === 'string' ? initialValue : '';
     }
 }, name);
-/**
- * Hook to the Response Cookie Attributes
- * @decorator
- * @param name - cookie name
- * @paramType TCookieAttributes
- */
 const CookieAttrsHook = (name) => moost.Resolve((metas, level) => {
     const hook = eventHttp.useSetCookie(name);
     if (level === 'PARAM') {
@@ -385,12 +337,6 @@ const CookieAttrsHook = (name) => moost.Resolve((metas, level) => {
         return typeof initialValue === 'object' ? initialValue : {};
     }
 }, name);
-/**
- * Parse Authorisation Header
- * @decorator
- * @param name - define what to take from the Auth header
- * @paramType string
- */
 function Authorization(name) {
     return moost.Resolve(() => {
         const auth = eventHttp.useAuthorization();
@@ -412,33 +358,15 @@ function Authorization(name) {
         }
     }, 'authorization');
 }
-/**
- * Get Request Header Value
- * @decorator
- * @param name - header name
- * @paramType string
- */
 function Header(name) {
     return moost.Resolve(() => {
         const headers = eventHttp.useHeaders();
         return headers[name];
     }, 'header: ' + name);
 }
-/**
- * Get Request Cookie Value
- * @decorator
- * @param name - cookie name
- * @paramType string
- */
 function Cookie(name) {
     return moost.Resolve(() => eventHttp.useCookies().getCookie(name), 'cookie: ' + 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';
@@ -453,76 +381,30 @@ function Query(name) {
         return Object.keys(json).length ? json : undefined;
     }, _name));
 }
-/**
- * Get Requested URL
- * @decorator
- * @paramType string
- */
 function Url() {
     return moost.Resolve(() => eventHttp.useRequest().url || '', 'url');
 }
-/**
- * Get Requested HTTP Method
- * @decorator
- * @paramType string
- */
 function Method() {
     return moost.Resolve(() => eventHttp.useRequest().method, 'http_method');
 }
-/**
- * Get Raw Request Instance
- * @decorator
- * @paramType IncomingMessage
- */
 function Req() {
     return moost.Resolve(() => eventHttp.useRequest().rawRequest, 'request');
 }
-/**
- * Get Raw Response Instance
- * @decorator
- * @param opts (optional) { passthrough: boolean }
- * @paramType ServerResponse
- */
 function Res(opts) {
     return moost.Resolve(() => eventHttp.useResponse().rawResponse(opts), 'response');
 }
-/**
- * Get Request Unique Identificator (UUID)
- * @decorator
- * @paramType string
- */
 function ReqId() {
     return moost.Resolve(() => eventHttp.useRequest().reqId(), 'reqId');
 }
-/**
- * Get Request IP Address
- * @decorator
- * @paramType string
- */
 function Ip(opts) {
     return moost.Resolve(() => eventHttp.useRequest().getIp(opts), 'ip');
 }
-/**
- * Get Request IP Address list
- * @decorator
- * @paramType string[]
- */
 function IpList() {
     return moost.Resolve(() => eventHttp.useRequest().getIpList(), 'ipList');
 }
-/**
- * Get Parsed Request Body
- * @decorator
- * @paramType object | string | unknown
- */
 function Body() {
     return moost.getMoostMate().apply(moost.getMoostMate().decorate('paramSource', 'BODY'), moost.Resolve(() => useBody().parseBody(), 'body'));
 }
-/**
- * Get Raw Request Body Buffer
- * @decorator
- * @paramType Promise<Buffer>
- */
 function RawBody() {
     return moost.Resolve(() => useBody().rawBody(), 'body');
 }
@@ -547,43 +429,6 @@ const setHeaderInterceptor = (name, value, opts) => {
     fn.priority = moost.TInterceptorPriority.AFTER_ALL;
     return fn;
 };
-/**
- * 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 moost.Intercept(setHeaderInterceptor(...args));
 }
@@ -599,27 +444,6 @@ const setCookieInterceptor = (name, value, attrs) => {
     fn.priority = moost.TInterceptorPriority.AFTER_ALL;
     return fn;
 };
-/**
- * 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 moost.Intercept(setCookieInterceptor(...args));
 }
@@ -633,25 +457,6 @@ const setStatusInterceptor = (code, opts) => {
         });
     });
 };
-/**
- * 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 moost.Intercept(setStatusInterceptor(...args));
 }

package/dist/index.d.ts

@@ -1,329 +1,279 @@
-/// <reference types="node" />
-
-import { HttpError } from '@wooksjs/event-http';
-import { IncomingMessage } from 'http';
-import { Moost } from 'moost';
-import { ServerResponse } from 'http';
-import { TConsoleBase } from '@prostojs/logger';
-import { TCookieAttributes as TCookieAttributes_2 } from '@wooksjs/event-http';
-import { TCookieAttributesInput } from '@wooksjs/event-http';
-import { THook } from '@wooksjs/event-core';
-import { TInterceptorFn } from 'moost';
-import { TMoostAdapter } from 'moost';
-import { TMoostAdapterOptions } from 'moost';
-import { TProstoRouterPathBuilder } from '@prostojs/router';
-import { TProvideRegistry } from 'moost';
-import { TWooksHttpOptions } from '@wooksjs/event-http';
-import { useHttpContext } from '@wooksjs/event-http';
-import { useSetCookies } from '@wooksjs/event-http';
-import { WooksHttp } from '@wooksjs/event-http';
-
-export declare const All: (path?: string) => MethodDecorator;
-
-/**
- * Parse Authorisation Header
- * @decorator
- * @param name - define what to take from the Auth header
- * @paramType string
- */
-export declare function Authorization(name: 'username' | 'password' | 'bearer' | 'raw' | 'type'): ParameterDecorator & PropertyDecorator;
-
-/**
- * Get Parsed Request Body
- * @decorator
- * @paramType object | string | unknown
- */
-declare function Body_2(): MethodDecorator & ClassDecorator & ParameterDecorator & PropertyDecorator;
-export { Body_2 as Body }
-
-/**
- * Get Request Cookie Value
- * @decorator
- * @param name - cookie name
- * @paramType string
- */
-export declare function Cookie(name: string): ParameterDecorator & PropertyDecorator;
-
-/**
- * Hook to the Response Cookie Attributes
- * @decorator
- * @param name - cookie name
- * @paramType TCookieAttributes
- */
-export declare const CookieAttrsHook: (name: string) => ParameterDecorator & PropertyDecorator;
-
-/**
- * Hook to the Response Cookie
- * @decorator
- * @param name - cookie name
- * @paramType TCookieHook
- */
-export declare const CookieHook: (name: string) => ParameterDecorator & PropertyDecorator;
-
-export declare const Delete: (path?: string) => MethodDecorator;
-
-export declare const Get: (path?: string) => MethodDecorator;
-
-/**
- * Get Request Header Value
- * @decorator
- * @param name - header name
- * @paramType string
- */
-export declare function Header(name: string): ParameterDecorator & PropertyDecorator;
-
-/**
- * Hook to the Response Header
- * @decorator
- * @param name - header name
- * @paramType THeaderHook
- */
-export declare const HeaderHook: (name: string) => ParameterDecorator & PropertyDecorator;
-
-export { HttpError }
-
-export declare function HttpMethod(method: '*' | 'GET' | 'PUT' | 'POST' | 'PATCH' | 'DELETE' | 'HEAD' | 'OPTIONS', path?: string): MethodDecorator;
-
-/**
- * Get Request IP Address
- * @decorator
- * @paramType string
- */
-export declare function Ip(opts?: {
-    trustProxy: boolean;
-}): ParameterDecorator & PropertyDecorator;
-
-/**
- * Get Request IP Address list
- * @decorator
- * @paramType string[]
- */
-export declare function IpList(): ParameterDecorator & PropertyDecorator;
-
-/**
- * Get Requested HTTP Method
- * @decorator
- * @paramType string
- */
-export declare function Method(): ParameterDecorator & PropertyDecorator;
-
-/**
- * ## 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()
- * ```
- */
-export declare class MoostHttp implements TMoostAdapter<THttpHandlerMeta> {
-    protected httpApp: WooksHttp;
-    constructor(httpApp?: WooksHttp | TWooksHttpOptions);
-    getHttpApp(): WooksHttp;
-    getServerCb(): (req: IncomingMessage, res: ServerResponse<IncomingMessage>) => Promise<void>;
-    listen(...args: Parameters<WooksHttp['listen']>): Promise<unknown>;
-    readonly pathBuilders: {
-        [id: string]: {
-            GET?: TProstoRouterPathBuilder<Record<string, string | string[]>>;
-            PUT?: TProstoRouterPathBuilder<Record<string, string | string[]>>;
-            PATCH?: TProstoRouterPathBuilder<Record<string, string | string[]>>;
-            POST?: TProstoRouterPathBuilder<Record<string, string | string[]>>;
-            DELETE?: TProstoRouterPathBuilder<Record<string, string | string[]>>;
-        };
-    };
-    onNotFound(): Promise<{}>;
-    protected moost?: Moost;
-    onInit(moost: Moost): void;
-    getProvideRegistry(): TProvideRegistry;
-    getLogger(): TConsoleBase;
-    bindHandler<T extends object = object>(opts: TMoostAdapterOptions<THttpHandlerMeta, T>): void;
-}
-
-export declare const Patch: (path?: string) => MethodDecorator;
-
-export declare const Post: (path?: string) => MethodDecorator;
-
-export declare const Put: (path?: string) => MethodDecorator;
-
-/**
- * Get Query Item value or the whole parsed Query as an object
- * @decorator
- * @param name - query item name (optional)
- * @paramType string | object
- */
-export declare function Query(name?: string): ParameterDecorator;
-
-/**
- * Get Raw Request Body Buffer
- * @decorator
- * @paramType Promise<Buffer>
- */
-export declare function RawBody(): ParameterDecorator & PropertyDecorator;
-
-/**
- * Get Raw Request Instance
- * @decorator
- * @paramType IncomingMessage
- */
-export declare function Req(): ParameterDecorator & PropertyDecorator;
-
-/**
- * Get Request Unique Identificator (UUID)
- * @decorator
- * @paramType string
- */
-export declare function ReqId(): ParameterDecorator & PropertyDecorator;
-
-/**
- * Get Raw Response Instance
- * @decorator
- * @param opts (optional) { passthrough: boolean }
- * @paramType ServerResponse
- */
-export declare function Res(opts?: {
-    passthrough: boolean;
-}): ParameterDecorator & PropertyDecorator;
-
-/**
- * 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
- */
-export declare function SetCookie(...args: Parameters<typeof setCookieInterceptor>): ClassDecorator & MethodDecorator;
-
-declare const setCookieInterceptor: (...args: Parameters<ReturnType<typeof useSetCookies>['setCookie']>) => 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 }
- */
-export declare function SetHeader(...args: Parameters<typeof setHeaderInterceptor>): ClassDecorator & MethodDecorator;
-
-declare const setHeaderInterceptor: (name: string, value: string, opts?: {
-    force?: boolean;
-    status?: number;
-    when?: 'always' | 'error' | 'ok';
-}) => 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 }
- */
-export declare function SetStatus(...args: Parameters<typeof setStatusInterceptor>): ClassDecorator & MethodDecorator;
-
-declare const setStatusInterceptor: (code: number, opts?: {
-    force?: boolean;
-}) => TInterceptorFn;
-
-/**
- * Hook to the Response Status
- * @decorator
- * @paramType TStatusHook
- */
-export declare const StatusHook: () => ParameterDecorator & PropertyDecorator;
-
-export declare type TCookieAttributes = Partial<TCookieAttributes_2>;
-
-export { TCookieAttributesInput }
-
-export declare type TCookieHook = THook & Partial<THook<TCookieAttributes, 'attrs'>>;
-
-export declare type THeaderHook = THook;
-
-export declare interface THttpHandlerMeta {
-    method: string;
-    path: string;
-}
-
-export declare type TStatusHook = THook<number>;
-
-/**
- * Get Requested URL
- * @decorator
- * @paramType string
- */
-export declare function Url(): ParameterDecorator & PropertyDecorator;
-
-export { useHttpContext }
-
-export { }
+import * as _prostojs_logger from '@prostojs/logger';
+import * as moost from 'moost';
+import { TMoostAdapter, Moost, TMoostAdapterOptions, TInterceptorFn } from 'moost';
+import * as http from 'http';
+import { WooksHttp, TWooksHttpOptions, TCookieAttributes as TCookieAttributes$1, useSetCookies } from '@wooksjs/event-http';
+export { HttpError, TCookieAttributesInput, useHttpContext } from '@wooksjs/event-http';
+import { TProstoRouterPathBuilder } from '@prostojs/router';
+import { THook } from '@wooksjs/event-core';
+
+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> {
+    protected httpApp: WooksHttp;
+    constructor(httpApp?: WooksHttp | TWooksHttpOptions);
+    getHttpApp(): WooksHttp;
+    getServerCb(): (req: http.IncomingMessage, res: http.ServerResponse<http.IncomingMessage>) => Promise<void>;
+    listen(...args: Parameters<WooksHttp['listen']>): Promise<unknown>;
+    readonly pathBuilders: {
+        [id: string]: {
+            GET?: TProstoRouterPathBuilder<Record<string, string | string[]>>;
+            PUT?: TProstoRouterPathBuilder<Record<string, string | string[]>>;
+            PATCH?: TProstoRouterPathBuilder<Record<string, string | string[]>>;
+            POST?: TProstoRouterPathBuilder<Record<string, string | string[]>>;
+            DELETE?: TProstoRouterPathBuilder<Record<string, string | string[]>>;
+        };
+    };
+    onNotFound(): Promise<{}>;
+    protected moost?: Moost;
+    onInit(moost: Moost): void;
+    getProvideRegistry(): moost.TProvideRegistry;
+    getLogger(): _prostojs_logger.TConsoleBase;
+    bindHandler<T extends object = object>(opts: TMoostAdapterOptions<THttpHandlerMeta, T>): void;
+}
+
+declare function HttpMethod(method: '*' | 'GET' | 'PUT' | 'POST' | 'PATCH' | 'DELETE' | 'HEAD' | 'OPTIONS', path?: string): MethodDecorator;
+declare const All: (path?: string) => MethodDecorator;
+declare const Get: (path?: string) => MethodDecorator;
+declare const Post: (path?: string) => MethodDecorator;
+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;
+type TCookieAttributes = Partial<TCookieAttributes$1>;
+type TCookieHook = THook & Partial<THook<TCookieAttributes, 'attrs'>>;
+
+declare const setHeaderInterceptor: (name: string, value: string, opts?: {
+    force?: boolean;
+    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;
+
+export { All, Authorization, Body, 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 };

package/dist/index.mjs

@@ -8,31 +8,6 @@ import { attachHook } from '@wooksjs/event-core';
 
 const LOGGER_TITLE = 'moost-http';
 const CONTEXT_TYPE = 'HTTP';
-/**
- * ## 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()
- * ```
- */
 class MoostHttp {
     constructor(httpApp) {
         this.pathBuilders = {};
@@ -98,7 +73,7 @@ class MoostHttp {
                 : typeof opts.method === 'string'
                     ? opts.method
                     : '';
-            const targetPath = `${opts.prefix || ''}/${path}`.replace(/\/\/+/g, '/') + `${path.endsWith('//') ? '/' : ''}`; // explicit double slash "//" -> force url to end with slash
+            const targetPath = `${opts.prefix || ''}/${path}`.replace(/\/\/+/g, '/') + `${path.endsWith('//') ? '/' : ''}`;
             if (!fn) {
                 fn = defineMoostEventHandler({
                     contextType: CONTEXT_TYPE,
@@ -111,7 +86,7 @@ class MoostHttp {
                     hooks: {
                         init: ({ unscope }) => {
                             const { rawRequest } = useRequest();
-                            rawRequest.on('end', unscope); // will unscope on request end
+                            rawRequest.on('end', unscope);
                         },
                     },
                 });
@@ -302,11 +277,6 @@ function useBody() {
     };
 }
 
-/**
- * Hook to the Response Status
- * @decorator
- * @paramType TStatusHook
- */
 const StatusHook = () => Resolve((metas, level) => {
     const hook = useStatus();
     if (level === 'PARAM') {
@@ -321,12 +291,6 @@ const StatusHook = () => Resolve((metas, level) => {
         return typeof initialValue === 'number' ? initialValue : 200;
     }
 }, 'statusCode');
-/**
- * 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') {
@@ -341,12 +305,6 @@ const HeaderHook = (name) => Resolve((metas, level) => {
         return typeof initialValue === 'string' ? initialValue : '';
     }
 }, name);
-/**
- * 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') {
@@ -361,12 +319,6 @@ const CookieHook = (name) => Resolve((metas, level) => {
         return typeof initialValue === 'string' ? initialValue : '';
     }
 }, name);
-/**
- * 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') {
@@ -384,12 +336,6 @@ const CookieAttrsHook = (name) => Resolve((metas, level) => {
         return typeof initialValue === 'object' ? initialValue : {};
     }
 }, 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();
@@ -411,33 +357,15 @@ function Authorization(name) {
         }
     }, 'authorization');
 }
-/**
- * Get Request Header Value
- * @decorator
- * @param name - header name
- * @paramType string
- */
 function Header(name) {
     return Resolve(() => {
         const headers = useHeaders();
         return headers[name];
     }, 'header: ' + name);
 }
-/**
- * Get Request Cookie Value
- * @decorator
- * @param name - cookie name
- * @paramType string
- */
 function Cookie(name) {
     return Resolve(() => useCookies().getCookie(name), 'cookie: ' + 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';
@@ -452,76 +380,30 @@ function Query(name) {
         return Object.keys(json).length ? json : undefined;
     }, _name));
 }
-/**
- * Get Requested URL
- * @decorator
- * @paramType string
- */
 function Url() {
     return Resolve(() => useRequest().url || '', 'url');
 }
-/**
- * Get Requested HTTP Method
- * @decorator
- * @paramType string
- */
 function Method() {
     return Resolve(() => useRequest().method, 'http_method');
 }
-/**
- * Get Raw Request Instance
- * @decorator
- * @paramType IncomingMessage
- */
 function Req() {
     return Resolve(() => useRequest().rawRequest, 'request');
 }
-/**
- * Get Raw Response Instance
- * @decorator
- * @param opts (optional) { passthrough: boolean }
- * @paramType ServerResponse
- */
 function Res(opts) {
     return Resolve(() => useResponse().rawResponse(opts), 'response');
 }
-/**
- * Get Request Unique Identificator (UUID)
- * @decorator
- * @paramType string
- */
 function ReqId() {
     return Resolve(() => useRequest().reqId(), 'reqId');
 }
-/**
- * Get Request IP Address
- * @decorator
- * @paramType string
- */
 function Ip(opts) {
     return Resolve(() => useRequest().getIp(opts), 'ip');
 }
-/**
- * Get Request IP Address list
- * @decorator
- * @paramType string[]
- */
 function IpList() {
     return Resolve(() => useRequest().getIpList(), 'ipList');
 }
-/**
- * Get Parsed Request Body
- * @decorator
- * @paramType object | string | unknown
- */
 function Body() {
     return getMoostMate().apply(getMoostMate().decorate('paramSource', 'BODY'), Resolve(() => useBody().parseBody(), 'body'));
 }
-/**
- * Get Raw Request Body Buffer
- * @decorator
- * @paramType Promise<Buffer>
- */
 function RawBody() {
     return Resolve(() => useBody().rawBody(), 'body');
 }
@@ -546,43 +428,6 @@ const setHeaderInterceptor = (name, value, opts) => {
     fn.priority = TInterceptorPriority.AFTER_ALL;
     return fn;
 };
-/**
- * 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));
 }
@@ -598,27 +443,6 @@ const setCookieInterceptor = (name, value, attrs) => {
     fn.priority = TInterceptorPriority.AFTER_ALL;
     return fn;
 };
-/**
- * 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));
 }
@@ -632,25 +456,6 @@ const setStatusInterceptor = (code, opts) => {
         });
     });
 };
-/**
- * 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));
 }

package/package.json

@@ -1,12 +1,13 @@
 {
   "name": "@moostjs/event-http",
-  "version": "0.3.11",
+  "version": "0.3.13",
   "description": "@moostjs/event-http",
   "main": "dist/index.cjs",
   "module": "dist/index.mjs",
   "types": "dist/index.d.ts",
   "sideEffects": false,
   "exports": {
+    "./package.json": "./package.json",
     ".": {
       "import": "./dist/index.mjs",
       "require": "./dist/index.cjs",
@@ -37,9 +38,9 @@
   "homepage": "https://github.com/moostjs/moostjs/tree/main/packages/event-http#readme",
   "peerDependencies": {},
   "dependencies": {
-    "moost": "0.3.11",
-    "@wooksjs/event-core": "^0.4.11",
-    "@wooksjs/event-http": "^0.4.11",
+    "moost": "0.3.13",
+    "@wooksjs/event-core": "^0.4.15",
+    "@wooksjs/event-http": "^0.4.15",
     "@prostojs/infact": "^0.1.13",
     "@prostojs/router": "^0.2.1"
   }