wooks 0.0.1-beta.6 → 0.0.1-beta.7

package/README.md

@@ -15,7 +15,7 @@ Wooks is a Web Application Framework with hooks.
 As an alternative for `express` and `fastify`, `wooks` brings the whole different approach for processing http requests.
 It utilizes such a technique as you can see in React Hooks or Vue Composables. It has only a dependency on [@prostojs/router](https://github.com/prostojs/router) (an alternative to `find-my-way` used by `fastify`) which is a very fast (see benchmarks [here](https://github.com/prostojs/router-benchmark)) and robust URI router. 
 
-`wooks` supports cookie parsing and serving files out of the box with no impact on performance.
+`wooks` supports cookie parsing, proxy and serving files out of the box with no impact on performance.
 
 The main ideas behind wooks are:
 
@@ -24,11 +24,20 @@ The main ideas behind wooks are:
 3. Get rid of complex predefined data objects containing everything (cookies, headers, body, parsed body etc.) and use composable functions (hooks) instead;
 4. Get rid of tons of dependencies (middlewares) and implement everything that is needed for web app in a simple way.
 
+`wooks` uses [@wooksjs/composables](https://github.com/wooksjs/composables) under the hood.
+
+### Official Composables packs:
+
+- [@wooksjs/body](https://github.com/wooksjs/body) - to parse body
+- [@wooksjs/serve-file](https://github.com/wooksjs/serve-file) - to serve static files
+- [@wooksjs/proxy](https://github.com/wooksjs/proxy) - to proxy requests
 
 ## Quick Start
 
 ```js
-const { Wooks } = require('wooks')
+import { Wooks } from 'wooks'
+// commonjs
+// const { Wooks } = require('wooks')
 
 const app = new Wooks()
 
@@ -73,7 +82,7 @@ app.get('wildcard/start-*/*.html', () => {})
 To get access to URL parameters use composable function `useRouteParams`
 
 ```js
-import { useRouteParams } from 'wooks'
+import { useRouteParams } from '@wooksjs/composables'
 app.get('parametric/:param1/:param2/...', () => {
     const { routeParams, getRouteParam } = useRouteParams()
     // presume we had a request on `/parametric/value1/value2`
@@ -94,7 +103,7 @@ app.get('parametric/:param1/:param2/...', () => {
 To get access to Query parameters use composable function `useSearchParams`
 
 ```js
-import { useSearchParams } from 'wooks'
+import { useSearchParams } from '@wooksjs/composables'
 app.get('with-query', () => {
     const { jsonSearchParams, urlSearchParams } = useSearchParams()
     // presume we had a request on `/with-query?param1=abc&param2=cde`
@@ -117,7 +126,7 @@ To get a reference to the raw request instance use composable function `useReque
 You probably don't need a `rawRequest` unless you are developing some new feature. All the base use-cases covered with other composable functions.
 
 ```js
-import { useRequest } from 'wooks'
+import { useRequest } from '@wooksjs/composables'
 app.get('test', () => {
     const { rawRequest } = useRequest()
 })
@@ -128,7 +137,7 @@ app.get('test', () => {
 `useRequest` provides some more shortcuts for useful data
 
 ```js
-import { useRequest } from 'wooks'
+import { useRequest } from '@wooksjs/composables'
 app.get('test', async () => {
     const { 
         url,        // request url      (string) 
@@ -146,7 +155,7 @@ app.get('test', async () => {
 Cookies are not parsed unless requested. Composable function `useCookies` provides cookie getter and raw cookies string.
 
 ```js
-import { useCookies } from 'wooks'
+import { useCookies } from '@wooksjs/composables'
 app.get('test', async () => {
     const { 
         rawCookies, // "cookie" from headers (string | undefined)
@@ -160,6 +169,8 @@ app.get('test', async () => {
 
 ### Request Body Parser
 
+`npm install @wooksjs/body`
+
 Function `useBody` provides utilities for getting decoded and parsed body.
 
 Body parser supports json, string, multipart/form-data and application/x-www-form-urlencoded content-types.
@@ -169,7 +180,7 @@ Body parser does not parse every request's body. The parsing happens only when y
 The request handler is invoked even before the request body was sent to the server.
 
 ```js
-import { useBody } from 'wooks'
+import { useBody } from '@wooksjs/body'
 app.post('test', async () => {
     const {
         isJson, // checks if content-type is "application/json" : () => boolean;
@@ -200,7 +211,7 @@ app.post('test', async () => {
 `useAuthorization` function provides useful helpers for auth-headers:
 
 ```js
-import { useAuthorization } from 'wooks'
+import { useAuthorization } from '@wooksjs/composables'
 app.get('test', async () => {
     const {
         authorization,      // the raw value of "authorization" header : string
@@ -263,7 +274,7 @@ When you get a raw response instance you take away the control of the response o
 
 An example of using raw response instance:
 ```js
-import { useResponse } from 'wooks'
+import { useResponse } from '@wooksjs/composables'
 app.get('test', () => {
     const { rawResponse } = useResponse()
     const res = rawResponse()
@@ -276,7 +287,7 @@ If you don't want to take away a responsibility for the response but still need
 The next example does the same thing as the previous example using `passthrough` options:
 
 ```js
-import { useResponse } from 'wooks'
+import { useResponse } from '@wooksjs/composables'
 app.get('test', () => {
     const { rawResponse } = useResponse()
     const res = rawResponse({ passthrough: true })
@@ -289,7 +300,7 @@ app.get('test', () => {
 A function `useSetHeaders` provides variety of response headers helpers:
 
 ```js
-import { useSetHeaders, contentTypes } from 'wooks'
+import { useSetHeaders, contentTypes } from '@wooksjs/composables'
 app.get('test', async () => {
     const {
         setHeader,      //sets header: (name: string, value: string | number) => void;
@@ -309,7 +320,7 @@ app.get('test', async () => {
 Another hook for set header
 
 ```js
-import { useRespHeader } from 'wooks'
+import { useRespHeader } from '@wooksjs/composables'
 app.get('test', async () => {
     const server = useRespHeader('server')
     server.value = 'myServer v1.0'
@@ -321,7 +332,7 @@ app.get('test', async () => {
 A function `useSetCookies` provides variety of set-cookie helpers:
 
 ```js
-import { useSetCookies } from 'wooks'
+import { useSetCookies } from '@wooksjs/composables'
 app.get('test', async () => {
     const {
         setCookie,      // sets cookie : (name: string, value: string, attrs?) => void;
@@ -345,7 +356,7 @@ app.get('test', async () => {
 Another hook for set-cookie
 
 ```js
-import { useRespCookie } from 'wooks'
+import { useRespCookie } from '@wooksjs/composables'
 app.get('test', async () => {
     const session = useRespCookie('session')
     session.value = 'value'
@@ -366,7 +377,7 @@ app.get('test', async () => {
 It's possible to control the response status via `status` function that is available in `useResponse()`
 
 ```js
-import { useResponse } from 'wooks'
+import { useResponse } from '@wooksjs/composables'
 app.get('test', async () => {
     const { status } = useResponse()
     status(201) // sets status 201 for the response
@@ -377,7 +388,7 @@ app.get('test', async () => {
 
 Another status hook:
 ```js
-import { useStatus } from 'wooks'
+import { useStatus } from '@wooksjs/composables'
 app.get('test', async () => {
     const status = useStatus()
     status.value = 201
@@ -390,7 +401,7 @@ app.get('test', async () => {
 `useSetCacheControl` function provides helpers for headers responsible for cache control
 
 ```js
-import { useSetCacheControl } from 'wooks'
+import { useSetCacheControl } from '@wooksjs/composables'
 app.get('static/*', () => {
     const { 
         setAge,             // sets Age (v: number | TProstoTimeMultiString) => void
@@ -417,10 +428,13 @@ app.get('static/*', () => {
 
 ### Proxy Requests
 
+`npm install @wooksjs/proxy`
+
 Wooks provides support for proxy request/response
 
 ```js
-import { useProxy, useRequest } from 'wooks'
+import { useProxy } from '@wooksjs/proxy'
+import { useRequest } from '@wooksjs/composables'
 //...
 app.get('*', async () => {
     const proxy = useProxy()
@@ -461,11 +475,15 @@ app.get('*', async () => {
 
 ### Serve File (Serve-Static)
 
+`npm install @wooksjs/serve-file`
+
 Function `serveFile` returns a readable stream and prepares all the neccessary response headers (like content-length, content-type etc).
 
 It can handle etag and range as well.
 
 ```js
+import { serveFile } from '@wooksjs/serve-file'
+// ...
 serveFile(filePath, options)
 ```
 
@@ -502,7 +520,8 @@ serveFile(filePath, options)
 Built-in file server example:
 
 ```js
-import { serveFile, useRouteParams } from 'wooks'
+import { useRouteParams } from '@wooksjs/composables'
+import { serveFile } from '@wooksjs/serve-file'
 app.get('static/*', () => {
     const { getRouteParam } = useRouteParams()
     return serveFile(getRouteParam('*'), { cacheControl: { maxAge: '10m' } })
@@ -534,7 +553,7 @@ By default the Error Handler renders the response according to the `Accept` requ
 It's possible to return your own error:
 
 ```js
-import { WooksError } from 'wooks'
+import { WooksError } from '@wooksjs/composables'
 app.get('error', () => {
     throw new WooksError('429', 'My Description')
     // A call of this endpoint will result in
@@ -548,7 +567,7 @@ In this case if you have an alternative (fallback) handler for the same route th
 As an alternative you may not throw the error but return its instance:
 
 ```js
-import { WooksError } from 'wooks'
+import { WooksError } from '@wooksjs/composables'
 app.get('error', () => {
     return new WooksError('429', 'My Description')
     // A call of this endpoint will result in
@@ -570,7 +589,8 @@ If the previous handler returns an Error Instance then the fallback handler won'
 For example you serve files, but for some 'not found' files you want to do something else:
 
 ```js
-import { Wooks, serveFile, useRouteParams } from 'wooks'
+import { Wooks, useRouteParams } from '@wooksjs/composables'
+import { serveFile } from '@wooksjs/serve-file'
 const app = new Wooks()
 
 app.get('static/*', () => {
@@ -590,7 +610,8 @@ app.listen(3000)
 In order to prevent the fallback to be invoked you must return an Error Instance explicitly:
 
 ```js
-import { Wooks, serveFile, useRouteParams } from 'wooks'
+import { Wooks, useRouteParams } from '@wooksjs/composables'
+import { serveFile } from '@wooksjs/serve-file'
 const app = new Wooks()
 
 app.get('static/*', () => {

package/dist/src/index.d.ts

@@ -1,9 +1,3 @@
 export * from './wooks';
-export * from './errors';
-export * from './response';
-export * from './composables';
-export * from './content-types';
-export * from './status-codes';
-export * from './serve-file/serve-file';
 export { TWooksOptions, TWooksHandler } from './types';
 //# sourceMappingURL=index.d.ts.map

package/dist/src/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,SAAS,CAAA;AACvB,cAAc,UAAU,CAAA;AACxB,cAAc,YAAY,CAAA;AAC1B,cAAc,eAAe,CAAA;AAC7B,cAAc,iBAAiB,CAAA;AAC/B,cAAc,gBAAgB,CAAA;AAC9B,cAAc,yBAAyB,CAAA;AACvC,OAAO,EAAE,aAAa,EAAE,aAAa,EAAE,MAAM,SAAS,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,SAAS,CAAA;AAEvB,OAAO,EAAE,aAAa,EAAE,aAAa,EAAE,MAAM,SAAS,CAAA"}

package/dist/src/types.d.ts

@@ -1,4 +1,4 @@
-import { BaseWooksResponse } from './response';
+import { BaseWooksResponse } from '@wooksjs/composables';
 export interface TWooksOptions {
 }
 export declare type TWooksHandler<ResType = unknown> = () => Promise<ResType> | ResType | Error | Promise<Error> | BaseWooksResponse<ResType> | Promise<BaseWooksResponse<ResType>>;

package/dist/src/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,YAAY,CAAA;AAE9C,MAAM,WAAW,aAAa;CAE7B;AAED,oBAAY,aAAa,CAAC,OAAO,GAAG,OAAO,IAAI,MACxC,OAAO,CAAC,OAAO,CAAC,GAAG,OAAO,GAAG,KAAK,GAAG,OAAO,CAAC,KAAK,CAAC,GAAG,iBAAiB,CAAC,OAAO,CAAC,GAAG,OAAO,CAAC,iBAAiB,CAAC,OAAO,CAAC,CAAC,CAAA"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,sBAAsB,CAAA;AAExD,MAAM,WAAW,aAAa;CAE7B;AAED,oBAAY,aAAa,CAAC,OAAO,GAAG,OAAO,IAAI,MACxC,OAAO,CAAC,OAAO,CAAC,GAAG,OAAO,GAAG,KAAK,GAAG,OAAO,CAAC,KAAK,CAAC,GAAG,iBAAiB,CAAC,OAAO,CAAC,GAAG,OAAO,CAAC,iBAAiB,CAAC,OAAO,CAAC,CAAC,CAAA"}

package/dist/src/wooks.d.ts

@@ -6,6 +6,10 @@ export declare class Wooks {
     private options?;
     protected router: ProstoRouter<TWooksHandler>;
     protected server?: Server;
+    protected responder: {
+        createResponse: <T = unknown>(data: T) => import("@wooksjs/composables").BaseWooksResponse<T | import("@wooksjs/composables").TWooksErrorBodyExt> | null;
+        respond: (data: unknown) => void | undefined;
+    };
     protected _uncoughtExceptionHandler: (error: Error) => void;
     constructor(options?: TWooksOptions | undefined);
     getRouter(): ProstoRouter<TWooksHandler<unknown>>;
@@ -17,6 +21,7 @@ export declare class Wooks {
     protected processRequest(req: IncomingMessage, res: ServerResponse): void;
     protected processHandlers(req: IncomingMessage, res: ServerResponse, found: TProstoLookupResult<TWooksHandler>): Promise<void>;
     protected printError(expl: string, e: Error): void;
+    protected respond(data: unknown): void;
     get<ResType = unknown, ParamsType = TProstoParamsType>(path: string, handler: TWooksHandler<ResType>): import("@prostojs/router").TProstoRouterPathBuilder<ParamsType>;
     post<ResType = unknown, ParamsType = TProstoParamsType>(path: string, handler: TWooksHandler<ResType>): import("@prostojs/router").TProstoRouterPathBuilder<ParamsType>;
     put<ResType = unknown, ParamsType = TProstoParamsType>(path: string, handler: TWooksHandler<ResType>): import("@prostojs/router").TProstoRouterPathBuilder<ParamsType>;

package/dist/src/wooks.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"wooks.d.ts","sourceRoot":"","sources":["../../src/wooks.ts"],"names":[],"mappings":";AAAA,OAAO,EAAE,YAAY,EAAE,WAAW,EAAE,mBAAmB,EAAE,iBAAiB,EAAE,MAAM,kBAAkB,CAAA;AACpG,OAAO,EAAE,eAAe,EAAE,MAAM,EAAE,cAAc,EAAE,MAAM,MAAM,CAAA;AAK9D,OAAO,EAAE,aAAa,EAAE,aAAa,EAAE,MAAM,SAAS,CAAA;AAItD,qBAAa,KAAK;IAOF,OAAO,CAAC,OAAO,CAAC;IAN5B,SAAS,CAAC,MAAM,EAAE,YAAY,CAAC,aAAa,CAAC,CAAA;IAE7C,SAAS,CAAC,MAAM,CAAC,EAAE,MAAM,CAAA;IAEzB,SAAS,CAAC,yBAAyB,EAAE,CAAC,KAAK,EAAE,KAAK,KAAK,IAAI,CAAA;gBAEvC,OAAO,CAAC,2BAAe;IAOpC,SAAS;IAIT,MAAM,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAEnC,MAAM,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC;IAEnD,MAAM,CAAC,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAErD,MAAM,CAAC,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC;IA2BrE,KAAK;IAUZ,SAAS,CAAC,cAAc,CAAC,GAAG,EAAE,eAAe,EAAE,GAAG,EAAE,cAAc;cAiClD,eAAe,CAAC,GAAG,EAAE,eAAe,EAAE,GAAG,EAAE,cAAc,EAAE,KAAK,EAAE,mBAAmB,CAAC,aAAa,CAAC;IA0BpH,SAAS,CAAC,UAAU,CAAC,IAAI,EAAE,MAAM,EAAE,CAAC,EAAE,KAAK;IAO3C,GAAG,CAAC,OAAO,GAAG,OAAO,EAAE,UAAU,GAAG,iBAAiB,EAAE,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,aAAa,CAAC,OAAO,CAAC;IAKpG,IAAI,CAAC,OAAO,GAAG,OAAO,EAAE,UAAU,GAAG,iBAAiB,EAAE,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,aAAa,CAAC,OAAO,CAAC;IAIrG,GAAG,CAAC,OAAO,GAAG,OAAO,EAAE,UAAU,GAAG,iBAAiB,EAAE,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,aAAa,CAAC,OAAO,CAAC;IAIpG,MAAM,CAAC,OAAO,GAAG,OAAO,EAAE,UAAU,GAAG,iBAAiB,EAAE,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,aAAa,CAAC,OAAO,CAAC;IAIvG,KAAK,CAAC,OAAO,GAAG,OAAO,EAAE,UAAU,GAAG,iBAAiB,EAAE,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,aAAa,CAAC,OAAO,CAAC;IAItG,EAAE,CAAC,OAAO,GAAG,OAAO,EAAE,UAAU,GAAG,iBAAiB,EAAE,MAAM,EAAE,WAAW,GAAG,GAAG,EAAE,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,aAAa,CAAC,OAAO,CAAC;CAGjI"}
+{"version":3,"file":"wooks.d.ts","sourceRoot":"","sources":["../../src/wooks.ts"],"names":[],"mappings":";AAAA,OAAO,EAAE,YAAY,EAAE,WAAW,EAAE,mBAAmB,EAAE,iBAAiB,EAAE,MAAM,kBAAkB,CAAA;AACpG,OAAO,EAAE,eAAe,EAAE,MAAM,EAAE,cAAc,EAAE,MAAM,MAAM,CAAA;AAG9D,OAAO,EAAE,aAAa,EAAE,aAAa,EAAE,MAAM,SAAS,CAAA;AAItD,qBAAa,KAAK;IASF,OAAO,CAAC,OAAO,CAAC;IAR5B,SAAS,CAAC,MAAM,EAAE,YAAY,CAAC,aAAa,CAAC,CAAA;IAE7C,SAAS,CAAC,MAAM,CAAC,EAAE,MAAM,CAAA;IAEzB,SAAS,CAAC,SAAS;;;MAAyB;IAE5C,SAAS,CAAC,yBAAyB,EAAE,CAAC,KAAK,EAAE,KAAK,KAAK,IAAI,CAAA;gBAEvC,OAAO,CAAC,2BAAe;IAOpC,SAAS;IAIT,MAAM,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAEnC,MAAM,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC;IAEnD,MAAM,CAAC,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAErD,MAAM,CAAC,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC;IA2BrE,KAAK;IAUZ,SAAS,CAAC,cAAc,CAAC,GAAG,EAAE,eAAe,EAAE,GAAG,EAAE,cAAc;cA0BlD,eAAe,CAAC,GAAG,EAAE,eAAe,EAAE,GAAG,EAAE,cAAc,EAAE,KAAK,EAAE,mBAAmB,CAAC,aAAa,CAAC;IA0BpH,SAAS,CAAC,UAAU,CAAC,IAAI,EAAE,MAAM,EAAE,CAAC,EAAE,KAAK;IAO3C,SAAS,CAAC,OAAO,CAAC,IAAI,EAAE,OAAO;IAI/B,GAAG,CAAC,OAAO,GAAG,OAAO,EAAE,UAAU,GAAG,iBAAiB,EAAE,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,aAAa,CAAC,OAAO,CAAC;IAKpG,IAAI,CAAC,OAAO,GAAG,OAAO,EAAE,UAAU,GAAG,iBAAiB,EAAE,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,aAAa,CAAC,OAAO,CAAC;IAIrG,GAAG,CAAC,OAAO,GAAG,OAAO,EAAE,UAAU,GAAG,iBAAiB,EAAE,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,aAAa,CAAC,OAAO,CAAC;IAIpG,MAAM,CAAC,OAAO,GAAG,OAAO,EAAE,UAAU,GAAG,iBAAiB,EAAE,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,aAAa,CAAC,OAAO,CAAC;IAIvG,KAAK,CAAC,OAAO,GAAG,OAAO,EAAE,UAAU,GAAG,iBAAiB,EAAE,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,aAAa,CAAC,OAAO,CAAC;IAItG,EAAE,CAAC,OAAO,GAAG,OAAO,EAAE,UAAU,GAAG,iBAAiB,EAAE,MAAM,EAAE,WAAW,GAAG,GAAG,EAAE,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,aAAa,CAAC,OAAO,CAAC;CAGjI"}