@moostjs/event-http 0.3.10 → 0.3.12

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 '@prostojs/infact';
-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 };