@wooksjs/event-http 0.5.25 → 0.6.1

package/dist/index.d.ts

@@ -1,5 +1,5 @@
 import * as _wooksjs_event_core from '@wooksjs/event-core';
-import { TEventOptions, TEmpty } from '@wooksjs/event-core';
+import { TEventOptions, TEmpty, TCtxHelpers, TGenericContextStore } from '@wooksjs/event-core';
 export { useEventLogger, useRouteParams } from '@wooksjs/event-core';
 import * as http from 'http';
 import { IncomingMessage, ServerResponse, IncomingHttpHeaders, Server } from 'http';
@@ -205,6 +205,12 @@ interface TRequestCache {
         remoteIp: string;
         forwarded: string[];
     };
+    contentEncodings?: string[];
+    isCompressed?: boolean;
+    maxCompressed?: number;
+    maxInflated?: number;
+    maxRatio?: number;
+    readTimeoutMs?: number;
 }
 interface TSearchParamsCache {
     raw?: string;
@@ -284,6 +290,12 @@ declare function useSetHeader(name: string): {
 };
 type THeaderHook = ReturnType<typeof useSetHeader>;
 
+declare const DEFAULT_LIMITS: {
+    readonly maxCompressed: number;
+    readonly maxInflated: number;
+    readonly maxRatio: 100;
+    readonly readTimeoutMs: 10000;
+};
 declare function useRequest(): {
     rawRequest: http.IncomingMessage;
     url: string | undefined;
@@ -298,6 +310,13 @@ declare function useRequest(): {
         remoteIp: string;
         forwarded: string[];
     };
+    isCompressed: () => boolean;
+    getMaxCompressed: () => number;
+    setMaxCompressed: (limit: number) => unknown;
+    getReadTimeoutMs: () => number;
+    setReadTimeoutMs: (limit: number) => unknown;
+    getMaxInflated: () => number;
+    setMaxInflated: (limit: number) => unknown;
 };
 
 interface TUseResponseOptions {
@@ -382,7 +401,11 @@ declare class HttpErrorRenderer extends BaseHttpResponseRenderer<TWooksErrorBody
 }
 
 declare function createHttpContext(data: THttpEventData, options: TEventOptions): <T>(cb: (...a: any[]) => T) => T;
-declare function useHttpContext<T extends TEmpty>(): _wooksjs_event_core.TCtxHelpers<THttpContextStore & T & _wooksjs_event_core.TGenericContextStore<THttpEventData>>;
+/**
+ * Wrapper on useEventContext with HTTP event types
+ * @returns set of hooks { getCtx, restoreCtx, clearCtx, hookStore, getStore, setStore }
+ */
+declare function useHttpContext<T extends TEmpty>(): TCtxHelpers<THttpContextStore & T & TGenericContextStore<THttpEventData>>;
 
 declare function createWooksResponder(renderer?: TWooksResponseRenderer<any>, errorRenderer?: TWooksResponseRenderer<any>): {
     createResponse: <T = unknown>(data: T) => BaseHttpResponse<T | TWooksErrorBodyExt> | null;
@@ -408,6 +431,11 @@ declare class WooksHttp extends WooksAdapterBase {
     head<ResType = unknown, ParamsType = Record<string, string | string[]>>(path: string, handler: TWooksHandler<ResType>): wooks.TProstoRouterPathHandle<ParamsType>;
     options<ResType = unknown, ParamsType = Record<string, string | string[]>>(path: string, handler: TWooksHandler<ResType>): wooks.TProstoRouterPathHandle<ParamsType>;
     protected server?: Server;
+    /**
+     * Starts the http(s) server.
+     *
+     * Use this only if you rely on Wooks server.
+     */
     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>;
@@ -417,17 +445,52 @@ declare class WooksHttp extends WooksAdapterBase {
     listen(options: ListenOptions, listeningListener?: () => void): Promise<void>;
     listen(handle: any, backlog?: number, listeningListener?: () => void): Promise<void>;
     listen(handle: any, listeningListener?: () => void): Promise<void>;
+    /**
+     * Stops the server if it was attached or passed via argument
+     * @param server
+     */
     close(server?: Server): Promise<unknown>;
+    /**
+     * Returns http(s) server that was attached to Wooks
+     *
+     * See attachServer method docs
+     * @returns Server
+     */
     getServer(): Server<typeof IncomingMessage, typeof ServerResponse> | undefined;
+    /**
+     * Attaches http(s) server instance
+     * to Wooks.
+     *
+     * Use it only if you want to `close` method to stop the server.
+     * @param server Server
+     */
     attachServer(server?: Server): void;
     protected responder: {
         createResponse: <T = unknown>(data: T) => BaseHttpResponse<T | TWooksErrorBodyExt> | null;
         respond: (data: unknown) => Promise<unknown> | undefined;
     };
     protected respond(data: unknown): void;
+    /**
+     * Returns server callback function
+     * that can be passed to any node server:
+     * ```js
+     * import { createHttpApp } from '@wooksjs/event-http'
+     * import http from 'http'
+     *
+     * const app = createHttpApp()
+     * const server = http.createServer(app.getServerCb())
+     * server.listen(3000)
+     * ```
+     */
     getServerCb(): (req: IncomingMessage, res: ServerResponse) => void;
     protected processHandlers(handlers: TWooksHandler[]): Promise<unknown>;
 }
+/**
+ * Factory for WooksHttp App
+ * @param opts TWooksHttpOptions
+ * @param wooks Wooks | WooksAdapterBase
+ * @returns WooksHttp
+ */
 declare function createHttpApp(opts?: TWooksHttpOptions, wooks?: Wooks | WooksAdapterBase): WooksHttp;
 
-export { BaseHttpResponse, BaseHttpResponseRenderer, EHttpStatusCode, HttpError, HttpErrorRenderer, type TAuthCache, type TCacheControl, type TCookieAttributes, type TCookieAttributesInput, type TCookieHook, type THeaderHook, type THttpContextStore, type THttpEvent, type THttpEventData, type TRequestCache, type TSearchParamsCache, type TSetCookieData, type TStatusHook, type TWooksErrorBody, type TWooksErrorBodyExt, type TWooksHttpOptions, type TWooksResponseRenderer, WooksHttp, WooksURLSearchParams, createHttpApp, createHttpContext, createWooksResponder, httpStatusCodes, renderCacheControl, useAccept, useAuthorization, useCookies, useHeaders, useHttpContext, useRequest, useResponse, useSearchParams, useSetCacheControl, useSetCookie, useSetCookies, useSetHeader, useSetHeaders, useStatus };
+export { BaseHttpResponse, BaseHttpResponseRenderer, DEFAULT_LIMITS, EHttpStatusCode, HttpError, HttpErrorRenderer, type TAuthCache, type TCacheControl, type TCookieAttributes, type TCookieAttributesInput, type TCookieHook, type THeaderHook, type THttpContextStore, type THttpEvent, type THttpEventData, type TRequestCache, type TSearchParamsCache, type TSetCookieData, type TStatusHook, type TWooksErrorBody, type TWooksErrorBodyExt, type TWooksHttpOptions, type TWooksResponseRenderer, WooksHttp, WooksURLSearchParams, createHttpApp, createHttpContext, createWooksResponder, httpStatusCodes, renderCacheControl, useAccept, useAuthorization, useCookies, useHeaders, useHttpContext, useRequest, useResponse, useSearchParams, useSetCacheControl, useSetCookie, useSetCookies, useSetHeader, useSetHeaders, useStatus };