@wooksjs/event-http 0.4.26 → 0.4.28

package/dist/index.d.ts

@@ -1,92 +1,13 @@
-import * as http from 'http';
-import http__default, { IncomingHttpHeaders, IncomingMessage, ServerResponse, Server } from 'http';
 import * as _wooksjs_event_core from '@wooksjs/event-core';
 import { TEventOptions, TEmpty } from '@wooksjs/event-core';
+import * as http from 'http';
+import { IncomingMessage, ServerResponse, IncomingHttpHeaders, Server } from 'http';
 import { URLSearchParams } from 'url';
 import { TConsoleBase } from '@prostojs/logger';
 import * as _prostojs_router from '@prostojs/router';
+import { ListenOptions } from 'net';
 import { TWooksHandler, TWooksOptions, WooksAdapterBase, Wooks } from 'wooks';
 
-declare function useHeaders(): IncomingHttpHeaders;
-declare function useSetHeaders(): {
-    setHeader: (name: string, value: string | number) => void;
-    getHeader: <K2 extends string | number>(key2: K2) => {
-        [name: string]: string | string[];
-    }[K2];
-    removeHeader: <K2_1 extends string | number>(key2: K2_1) => void;
-    setContentType: (value: string) => void;
-    headers: () => {
-        [name: string]: string | string[];
-    };
-    enableCors: (origin?: string) => void;
-};
-declare function useSetHeader(name: string): {
-    value: string | string[];
-    isDefined: boolean;
-};
-type THeaderHook = ReturnType<typeof useSetHeader>;
-
-declare function useAccept(): {
-    accept: string | undefined;
-    accepts: (mime: string) => unknown;
-    acceptsJson: () => unknown;
-    acceptsXml: () => unknown;
-    acceptsText: () => unknown;
-    acceptsHtml: () => unknown;
-};
-
-declare function useAuthorization(): {
-    authorization: string | undefined;
-    authType: () => string | null;
-    authRawCredentials: () => string | null;
-    isBasic: () => boolean;
-    isBearer: () => boolean;
-    basicCredentials: () => {
-        username: string;
-        password: string;
-    } | null;
-};
-
-type TTimeUnit = 'ms' | 's' | 'm' | 'h' | 'd' | 'w' | 'M' | 'Y';
-type TTimeSingleString = `${number}${TTimeUnit}`;
-type TTimeMultiString = `${TTimeSingleString}${TTimeSingleString | ''}${TTimeSingleString | ''}${TTimeSingleString | ''}`;
-
-type TCacheControl = {
-    mustRevalidate?: boolean;
-    noCache?: boolean | string;
-    noStore?: boolean;
-    noTransform?: boolean;
-    public?: boolean;
-    private?: boolean | string;
-    proxyRevalidate?: boolean;
-    maxAge?: number | TTimeMultiString;
-    sMaxage?: number | TTimeMultiString;
-};
-declare function renderCacheControl(data: TCacheControl): string;
-
-declare function useSetCacheControl(): {
-    setExpires: (value: Date | string | number) => void;
-    setAge: (value: number | TTimeMultiString) => void;
-    setPragmaNoCache: (value?: boolean) => void;
-    setCacheControl: (data: TCacheControl) => void;
-};
-
-declare function useRequest(): {
-    rawRequest: http.IncomingMessage;
-    url: string | undefined;
-    method: string | undefined;
-    headers: http.IncomingHttpHeaders;
-    rawBody: () => Promise<Buffer>;
-    reqId: () => string;
-    getIp: (options?: {
-        trustProxy: boolean;
-    }) => string;
-    getIpList: () => {
-        remoteIp: string;
-        forwarded: string[];
-    };
-};
-
 declare const httpStatusCodes: {
     100: string;
     101: string;
@@ -221,19 +142,9 @@ type THttpBadRequestCodes = 400 | 401 | 402 | 403 | 404 | 405 | 406 | 407 | 408
 type THttpServerErrorCodes = 500 | 501 | 502 | 503 | 504 | 505 | 506 | 507 | 508 | 510 | 511;
 type THttpErrorCodes = THttpBadRequestCodes | THttpServerErrorCodes;
 
-type TUseResponseOptions = {
-    passthrough: boolean;
-};
-declare function useResponse(): {
-    rawResponse: (options?: TUseResponseOptions) => http.ServerResponse<http.IncomingMessage>;
-    hasResponded: () => boolean;
-    status: ((code?: EHttpStatusCode) => EHttpStatusCode) & _wooksjs_event_core.THook<EHttpStatusCode, "value">;
-};
-declare function useStatus(): {
-    value: EHttpStatusCode;
-    isDefined: boolean;
-};
-type TStatusHook = ReturnType<typeof useStatus>;
+type TTimeUnit = 'ms' | 's' | 'm' | 'h' | 'd' | 'w' | 'M' | 'Y';
+type TTimeSingleString = `${number}${TTimeUnit}`;
+type TTimeMultiString = `${TTimeSingleString}${TTimeSingleString | ''}${TTimeSingleString | ''}${TTimeSingleString | ''}`;
 
 declare class WooksURLSearchParams extends URLSearchParams {
     toJson<T = unknown>(): T;
@@ -248,19 +159,11 @@ interface THttpEvent {
 }
 interface THttpContextStore {
     searchParams?: TSearchParamsCache;
-    cookies?: {
-        [name: string]: string | null;
-    };
-    setCookies?: {
-        [name: string]: TSetCookieData;
-    };
-    accept?: {
-        [name: string]: boolean;
-    };
+    cookies?: Record<string, string | null>;
+    setCookies?: Record<string, TSetCookieData>;
+    accept?: Record<string, boolean>;
     authorization?: TAuthCache;
-    setHeader?: {
-        [name: string]: string | string[];
-    };
+    setHeader?: Record<string, string | string[]>;
     request?: TRequestCache;
     response?: {
         responded: boolean;
@@ -269,10 +172,10 @@ interface THttpContextStore {
         code: EHttpStatusCode;
     };
 }
-type TSetCookieData = {
+interface TSetCookieData {
     value: string;
     attrs: TCookieAttributesInput;
-};
+}
 type TCookieAttributesInput = Partial<TCookieAttributes>;
 interface TCookieAttributes {
     expires: Date | string | number;
@@ -283,15 +186,15 @@ interface TCookieAttributes {
     httpOnly: boolean;
     sameSite: boolean | 'Lax' | 'None' | 'Strict';
 }
-type TAuthCache = {
+interface TAuthCache {
     type: string | null;
     credentials: string | null;
     basicCredentials: {
         username: string;
         password: string;
     } | null;
-};
-type TRequestCache = {
+}
+interface TRequestCache {
     rawBody: Promise<Buffer>;
     parsed: unknown;
     forwardedIp?: string;
@@ -300,11 +203,11 @@ type TRequestCache = {
         remoteIp: string;
         forwarded: string[];
     };
-};
-type TSearchParamsCache = {
+}
+interface TSearchParamsCache {
     raw?: string;
     urlSearchParams?: WooksURLSearchParams;
-};
+}
 
 declare function useCookies(): {
     rawCookies: string | undefined;
@@ -312,10 +215,8 @@ declare function useCookies(): {
 };
 declare function useSetCookies(): {
     setCookie: (name: string, value: string, attrs?: Partial<TCookieAttributes>) => void;
-    getCookie: <K2 extends string | number>(key2: K2) => {
-        [name: string]: TSetCookieData;
-    }[K2];
-    removeCookie: <K2_1 extends string | number>(key2: K2_1) => void;
+    getCookie: <K2 extends string>(key2: K2) => TSetCookieData | undefined;
+    removeCookie: <K2_1 extends string>(key2: K2_1) => void;
     clearCookies: () => void;
     cookies: () => string[];
 };
@@ -325,6 +226,92 @@ declare function useSetCookie(name: string): {
 } & _wooksjs_event_core.THook<string, "value"> & _wooksjs_event_core.THook<TCookieAttributes, "attrs">;
 type TCookieHook = ReturnType<typeof useSetCookie>;
 
+declare function useAccept(): {
+    accept: string | undefined;
+    accepts: (mime: string) => unknown;
+    acceptsJson: () => unknown;
+    acceptsXml: () => unknown;
+    acceptsText: () => unknown;
+    acceptsHtml: () => unknown;
+};
+
+declare function useAuthorization(): {
+    authorization: string | undefined;
+    authType: () => string | null;
+    authRawCredentials: () => string | null;
+    isBasic: () => boolean;
+    isBearer: () => boolean;
+    basicCredentials: () => {
+        username: string;
+        password: string;
+    } | null;
+};
+
+interface TCacheControl {
+    mustRevalidate?: boolean;
+    noCache?: boolean | string;
+    noStore?: boolean;
+    noTransform?: boolean;
+    public?: boolean;
+    private?: boolean | string;
+    proxyRevalidate?: boolean;
+    maxAge?: number | TTimeMultiString;
+    sMaxage?: number | TTimeMultiString;
+}
+declare function renderCacheControl(data: TCacheControl): string;
+
+declare function useSetCacheControl(): {
+    setExpires: (value: Date | string | number) => void;
+    setAge: (value: number | TTimeMultiString) => void;
+    setPragmaNoCache: (value?: boolean) => void;
+    setCacheControl: (data: TCacheControl) => void;
+};
+
+declare function useHeaders(): IncomingHttpHeaders;
+declare function useSetHeaders(): {
+    setHeader: (name: string, value: string | number) => void;
+    getHeader: <K2 extends string>(key2: K2) => string | string[] | undefined;
+    removeHeader: <K2_1 extends string>(key2: K2_1) => void;
+    setContentType: (value: string) => void;
+    headers: () => Record<string, string | string[]>;
+    enableCors: (origin?: string) => void;
+};
+declare function useSetHeader(name: string): {
+    value: string | string[];
+    isDefined: boolean;
+};
+type THeaderHook = ReturnType<typeof useSetHeader>;
+
+declare function useRequest(): {
+    rawRequest: http.IncomingMessage;
+    url: string | undefined;
+    method: string | undefined;
+    headers: http.IncomingHttpHeaders;
+    rawBody: () => Promise<Buffer>;
+    reqId: () => string;
+    getIp: (options?: {
+        trustProxy: boolean;
+    }) => string;
+    getIpList: () => {
+        remoteIp: string;
+        forwarded: string[];
+    };
+};
+
+interface TUseResponseOptions {
+    passthrough: boolean;
+}
+declare function useResponse(): {
+    rawResponse: (options?: TUseResponseOptions) => http.ServerResponse<http.IncomingMessage>;
+    hasResponded: () => boolean;
+    status: ((code?: EHttpStatusCode) => EHttpStatusCode) & _wooksjs_event_core.THook<EHttpStatusCode, "value">;
+};
+declare function useStatus(): {
+    value: EHttpStatusCode;
+    isDefined: boolean;
+};
+type TStatusHook = ReturnType<typeof useStatus>;
+
 declare function useSearchParams(): {
     rawSearchParams: () => string;
     urlSearchParams: () => WooksURLSearchParams;
@@ -366,16 +353,10 @@ declare class BaseHttpResponse<BodyType = unknown> {
     respond(): Promise<unknown>;
 }
 
-declare class HttpErrorRenderer extends BaseHttpResponseRenderer<TWooksErrorBodyExt> {
-    renderHtml(response: BaseHttpResponse<TWooksErrorBodyExt>): string;
-    renderText(response: BaseHttpResponse<TWooksErrorBodyExt>): string;
-    renderJson(response: BaseHttpResponse<TWooksErrorBodyExt>): string;
-    render(response: BaseHttpResponse<TWooksErrorBodyExt>): string;
-}
-
 declare class HttpError<T extends TWooksErrorBody = TWooksErrorBody> extends Error {
     protected code: THttpErrorCodes;
     protected _body: string | T;
+    name: string;
     constructor(code?: THttpErrorCodes, _body?: string | T);
     get body(): TWooksErrorBodyExt;
     protected renderer?: HttpErrorRenderer;
@@ -391,10 +372,12 @@ interface TWooksErrorBodyExt extends TWooksErrorBody {
     error: string;
 }
 
-declare function createWooksResponder(renderer?: TWooksResponseRenderer<any>, errorRenderer?: TWooksResponseRenderer<any>): {
-    createResponse: <T = unknown>(data: T) => BaseHttpResponse<TWooksErrorBodyExt | T> | null;
-    respond: (data: unknown) => Promise<unknown> | undefined;
-};
+declare class HttpErrorRenderer extends BaseHttpResponseRenderer<TWooksErrorBodyExt> {
+    renderHtml(response: BaseHttpResponse<TWooksErrorBodyExt>): string;
+    renderText(response: BaseHttpResponse<TWooksErrorBodyExt>): string;
+    renderJson(response: BaseHttpResponse<TWooksErrorBodyExt>): string;
+    render(response: BaseHttpResponse<TWooksErrorBodyExt>): string;
+}
 
 declare function createHttpContext(data: THttpEventData, options: TEventOptions): {
     getCtx: () => THttpContextStore & _wooksjs_event_core.TGenericContextStore<THttpEventData>;
@@ -408,7 +391,7 @@ declare function createHttpContext(data: THttpEventData, options: TEventOptions)
         };
         init: <K2_1 extends keyof Required<THttpContextStore & _wooksjs_event_core.TGenericContextStore<THttpEventData>>[K]>(key2: K2_1, getter: () => Required<Required<THttpContextStore & _wooksjs_event_core.TGenericContextStore<THttpEventData>>[K]>[K2_1]) => Required<Required<THttpContextStore & _wooksjs_event_core.TGenericContextStore<THttpEventData>>[K]>[K2_1];
         set: <K2_2 extends keyof Required<THttpContextStore & _wooksjs_event_core.TGenericContextStore<THttpEventData>>[K]>(key2: K2_2, v: Required<(THttpContextStore & _wooksjs_event_core.TGenericContextStore<THttpEventData>)[K]>[K2_2]) => Required<(THttpContextStore & _wooksjs_event_core.TGenericContextStore<THttpEventData>)[K]>[K2_2];
-        get: <K2_3 extends keyof Required<THttpContextStore & _wooksjs_event_core.TGenericContextStore<THttpEventData>>[K]>(key2: K2_3) => Required<THttpContextStore & _wooksjs_event_core.TGenericContextStore<THttpEventData>>[K][K2_3];
+        get: <K2_3 extends keyof Required<THttpContextStore & _wooksjs_event_core.TGenericContextStore<THttpEventData>>[K]>(key2: K2_3) => Required<THttpContextStore & _wooksjs_event_core.TGenericContextStore<THttpEventData>>[K][K2_3] | undefined;
         has: <K2_4 extends keyof Required<THttpContextStore & _wooksjs_event_core.TGenericContextStore<THttpEventData>>[K]>(key2: K2_4) => boolean;
         del: <K2_5 extends keyof Required<THttpContextStore & _wooksjs_event_core.TGenericContextStore<THttpEventData>>[K]>(key2: K2_5) => void;
         entries: () => [string, unknown][];
@@ -433,7 +416,7 @@ declare function useHttpContext<T extends TEmpty>(): {
         };
         init: <K2_1 extends keyof Required<THttpContextStore & T & _wooksjs_event_core.TGenericContextStore<THttpEventData>>[K]>(key2: K2_1, getter: () => Required<Required<THttpContextStore & T & _wooksjs_event_core.TGenericContextStore<THttpEventData>>[K]>[K2_1]) => Required<Required<THttpContextStore & T & _wooksjs_event_core.TGenericContextStore<THttpEventData>>[K]>[K2_1];
         set: <K2_2 extends keyof Required<THttpContextStore & T & _wooksjs_event_core.TGenericContextStore<THttpEventData>>[K]>(key2: K2_2, v: Required<(THttpContextStore & T & _wooksjs_event_core.TGenericContextStore<THttpEventData>)[K]>[K2_2]) => Required<(THttpContextStore & T & _wooksjs_event_core.TGenericContextStore<THttpEventData>)[K]>[K2_2];
-        get: <K2_3 extends keyof Required<THttpContextStore & T & _wooksjs_event_core.TGenericContextStore<THttpEventData>>[K]>(key2: K2_3) => Required<THttpContextStore & T & _wooksjs_event_core.TGenericContextStore<THttpEventData>>[K][K2_3];
+        get: <K2_3 extends keyof Required<THttpContextStore & T & _wooksjs_event_core.TGenericContextStore<THttpEventData>>[K]>(key2: K2_3) => Required<THttpContextStore & T & _wooksjs_event_core.TGenericContextStore<THttpEventData>>[K][K2_3] | undefined;
         has: <K2_4 extends keyof Required<THttpContextStore & T & _wooksjs_event_core.TGenericContextStore<THttpEventData>>[K]>(key2: K2_4) => boolean;
         del: <K2_5 extends keyof Required<THttpContextStore & T & _wooksjs_event_core.TGenericContextStore<THttpEventData>>[K]>(key2: K2_5) => void;
         entries: () => [string, unknown][];
@@ -443,10 +426,15 @@ declare function useHttpContext<T extends TEmpty>(): {
     setStore: <K_2 extends keyof THttpContextStore | keyof _wooksjs_event_core.TGenericContextStore<THttpEventData> | keyof T>(key: K_2, v: (THttpContextStore & T & _wooksjs_event_core.TGenericContextStore<THttpEventData>)[K_2]) => void;
 };
 
+declare function createWooksResponder(renderer?: TWooksResponseRenderer<any>, errorRenderer?: TWooksResponseRenderer<any>): {
+    createResponse: <T = unknown>(data: T) => BaseHttpResponse<TWooksErrorBodyExt | T> | null;
+    respond: (data: unknown) => Promise<unknown> | undefined;
+};
+
 interface TWooksHttpOptions {
     logger?: TConsoleBase;
     eventOptions?: TEventOptions;
-    onNotFound?: TWooksHandler<unknown>;
+    onNotFound?: TWooksHandler;
     router?: TWooksOptions['router'];
 }
 declare class WooksHttp extends WooksAdapterBase {
@@ -467,7 +455,15 @@ declare class WooksHttp extends WooksAdapterBase {
      *
      * Use this only if you rely on Wooks server.
      */
-    listen(...args: Parameters<Server['listen']>): Promise<unknown>;
+    listen(port?: number, hostname?: string, backlog?: number, listeningListener?: () => void): this;
+    listen(port?: number, hostname?: string, listeningListener?: () => void): this;
+    listen(port?: number, backlog?: number, listeningListener?: () => void): this;
+    listen(port?: number, listeningListener?: () => void): this;
+    listen(path: string, backlog?: number, listeningListener?: () => void): this;
+    listen(path: string, listeningListener?: () => void): this;
+    listen(options: ListenOptions, listeningListener?: () => void): this;
+    listen(handle: any, backlog?: number, listeningListener?: () => void): this;
+    listen(handle: any, listeningListener?: () => void): this;
     /**
      * Stops the server if it was attached or passed via argument
      * @param server
@@ -479,7 +475,7 @@ declare class WooksHttp extends WooksAdapterBase {
      * See attachServer method docs
      * @returns Server
      */
-    getServer(): http__default.Server<typeof http__default.IncomingMessage, typeof http__default.ServerResponse> | undefined;
+    getServer(): Server<typeof IncomingMessage, typeof ServerResponse> | undefined;
     /**
      * Attaches http(s) server instance
      * to Wooks.
@@ -506,7 +502,7 @@ declare class WooksHttp extends WooksAdapterBase {
      * ```
      */
     getServerCb(): (req: IncomingMessage, res: ServerResponse) => Promise<void>;
-    protected processHandlers(handlers: TWooksHandler<unknown>[]): Promise<void>;
+    protected processHandlers(handlers: TWooksHandler[]): Promise<void>;
 }
 /**
  * Factory for WooksHttp App