wooks 0.0.1-beta.4 → 0.0.1-beta.6

package/README.md

@@ -306,6 +306,16 @@ app.get('test', async () => {
 })
 ```
 
+Another hook for set header
+
+```js
+import { useRespHeader } from 'wooks'
+app.get('test', async () => {
+    const server = useRespHeader('server')
+    server.value = 'myServer v1.0'
+})
+```
+
 ### Response Cookies (Set-Cookie)
 
 A function `useSetCookies` provides variety of set-cookie helpers:
@@ -332,6 +342,25 @@ app.get('test', async () => {
 })
 ```
 
+Another hook for set-cookie
+
+```js
+import { useRespCookie } from 'wooks'
+app.get('test', async () => {
+    const session = useRespCookie('session')
+    session.value = 'value'
+    session.attrs = {
+        expires: '2029-01-01',  // Date | string | number;
+        maxAge:  '1h',          // number | TProstoTimeMultiString;
+        domain:  'my-domain',   // string;
+        path:    '/home',       // string;
+        secure:   true,         // boolean;
+        httpOnly: false,        // boolean;
+        sameSite: true,         // boolean | 'Lax' | 'None' | 'Strict';        
+    }
+})
+```
+
 ### Response Status
 
 It's possible to control the response status via `status` function that is available in `useResponse()`
@@ -346,6 +375,16 @@ app.get('test', async () => {
 })
 ```
 
+Another status hook:
+```js
+import { useStatus } from 'wooks'
+app.get('test', async () => {
+    const status = useStatus()
+    status.value = 201
+    return 'response with status 201'
+})
+```
+
 ### Cache-Control
 
 `useSetCacheControl` function provides helpers for headers responsible for cache control
@@ -376,6 +415,50 @@ app.get('static/*', () => {
 })
 ```
 
+### Proxy Requests
+
+Wooks provides support for proxy request/response
+
+```js
+import { useProxy, useRequest } from 'wooks'
+//...
+app.get('*', async () => {
+    const proxy = useProxy()
+    const { url } = useRequest()
+    const fetchResponse = await proxy('https://www.google.com' + url, {
+        // optional method, be default is set with
+        // the original request method
+        method: 'GET',
+
+        // the next four options help to filter out
+        // request/response headers/cookies
+        // each of the option accepts an object with:
+        // - allow: '*' | (string | RegExp)[] - a list to allow (default '*')
+        // - block: '*' | (string | RegExp)[] - a list to block
+        // - overwrite: Record<string| strgin> | ((data: object) -> object) - object or fn to overwrite data
+        reqHeaders: { block: ['referer'] },
+        reqCookies: { allow: ['cookie-to-pass-downstream'] },
+        resHeaders: { overwrite: { 'x-proxied-by': 'wooks-proxy' } },
+        resCookies: { allow: ['cookie-to-pass-upstream'] },
+
+        // debug: true - will print proxy paths and headers/cookies
+        debug: true,
+    })
+    return fetchResponse // fetch response is supported, the body will be upstreamed
+
+    // > you can also return fully buffered body as Uint8Array
+    // return new Uint8Array(await fetchResponse.arrayBuffer())
+
+    // > or as string
+    // return fetchResponse.text()
+
+    // > or change response before return
+    // const data = await fetchResponse.text() + '<new data>'
+    // return data
+})
+//...
+```
+
 ### Serve File (Serve-Static)
 
 Function `serveFile` returns a readable stream and prepares all the neccessary response headers (like content-length, content-type etc).

package/dist/src/composables/headers.d.ts

@@ -5,7 +5,7 @@ export declare function useSetHeaders(): {
     setHeader: (name: string, value: string | number) => void;
     removeHeader: (name: string) => void;
     setContentType: (value: string) => void;
-    headers: Record<string, string>;
+    headers: Record<string, string | string[]>;
     enableCors: (origin?: string) => void;
 };
 //# sourceMappingURL=headers.d.ts.map

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

@@ -9,4 +9,5 @@ export * from './body';
 export * from './core-test';
 export { useCurrentWooksContext, useCacheObject, clearCacheObject, } from './core';
 export * from './hooks';
+export * from './proxy';
 //# sourceMappingURL=index.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/composables/index.ts"],"names":[],"mappings":"AAAA,cAAc,WAAW,CAAA;AACzB,cAAc,iBAAiB,CAAA;AAC/B,cAAc,wBAAwB,CAAA;AACtC,cAAc,4BAA4B,CAAA;AAC1C,cAAc,WAAW,CAAA;AACzB,cAAc,WAAW,CAAA;AACzB,cAAc,iBAAiB,CAAA;AAC/B,cAAc,QAAQ,CAAA;AACtB,cAAc,aAAa,CAAA;AAC3B,OAAO,EACH,sBAAsB,EACtB,cAAc,EACd,gBAAgB,GACnB,MAAM,QAAQ,CAAA;AACf,cAAc,SAAS,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/composables/index.ts"],"names":[],"mappings":"AAAA,cAAc,WAAW,CAAA;AACzB,cAAc,iBAAiB,CAAA;AAC/B,cAAc,wBAAwB,CAAA;AACtC,cAAc,4BAA4B,CAAA;AAC1C,cAAc,WAAW,CAAA;AACzB,cAAc,WAAW,CAAA;AACzB,cAAc,iBAAiB,CAAA;AAC/B,cAAc,QAAQ,CAAA;AACtB,cAAc,aAAa,CAAA;AAC3B,OAAO,EACH,sBAAsB,EACtB,cAAc,EACd,gBAAgB,GACnB,MAAM,QAAQ,CAAA;AACf,cAAc,SAAS,CAAA;AACvB,cAAc,SAAS,CAAA"}

package/dist/src/composables/proxy-utils.d.ts

@@ -0,0 +1,25 @@
+/// <reference types="node" />
+import { IncomingHttpHeaders } from 'http';
+declare class IterableRecords {
+    [Symbol.iterator](): this;
+    protected index: number;
+    next(): IteratorResult<[string, string]>;
+}
+export declare class CookiesIterable extends IterableRecords {
+    private cookies;
+    constructor(cookiesString: string);
+    next(): IteratorResult<[string, string]>;
+}
+export declare class HeadersIterable extends IterableRecords {
+    private entries;
+    constructor(headers: Record<string, string> | IncomingHttpHeaders);
+    next(): IteratorResult<[string, string]>;
+}
+export interface TWooksProxyControls {
+    overwrite?: Record<string, string> | ((data: Record<string, string>) => Record<string, string>);
+    allow?: (string | RegExp)[] | '*';
+    block?: (string | RegExp)[] | '*';
+}
+export declare function applyProxyControls(records: IterableIterator<[string, string]>, controls: TWooksProxyControls, additionalBlockers?: string[]): Record<string, string>;
+export {};
+//# sourceMappingURL=proxy-utils.d.ts.map

package/dist/src/composables/proxy-utils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"proxy-utils.d.ts","sourceRoot":"","sources":["../../../src/composables/proxy-utils.ts"],"names":[],"mappings":";AAAA,OAAO,EAAE,mBAAmB,EAAE,MAAM,MAAM,CAAA;AAE1C,cAAM,eAAe;IACjB,CAAC,MAAM,CAAC,QAAQ,CAAC;IAIjB,SAAS,CAAC,KAAK,SAAI;IAEnB,IAAI,IAAI,cAAc,CAAC,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CAG3C;AAED,qBAAa,eAAgB,SAAQ,eAAe;IAChD,OAAO,CAAC,OAAO,CAAU;gBAEb,aAAa,EAAE,MAAM;IAKjC,IAAI,IAAI,cAAc,CAAC,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CAO3C;AAED,qBAAa,eAAgB,SAAQ,eAAe;IAChD,OAAO,CAAC,OAAO,CAAoB;gBAEvB,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,mBAAmB;IAKjE,IAAI,IAAI,cAAc,CAAC,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CAK3C;AAED,MAAM,WAAW,mBAAmB;IAChC,SAAS,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,KAAK,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAA;IAC/F,KAAK,CAAC,EAAE,CAAC,MAAM,GAAG,MAAM,CAAC,EAAE,GAAG,GAAG,CAAA;IACjC,KAAK,CAAC,EAAE,CAAC,MAAM,GAAG,MAAM,CAAC,EAAE,GAAG,GAAG,CAAA;CACpC;AAED,wBAAgB,kBAAkB,CAAC,OAAO,EAAE,gBAAgB,CAAC,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,EAAE,QAAQ,EAAE,mBAAmB,EAAE,kBAAkB,CAAC,EAAE,MAAM,EAAE,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CA0BpK"}

package/dist/src/composables/proxy.d.ts

@@ -0,0 +1,12 @@
+import { TWooksProxyControls } from './proxy-utils';
+export { TWooksProxyControls } from './proxy-utils';
+export declare function useProxy(): (target: string, opts?: TWooksProxyOptions) => Promise<Response>;
+export interface TWooksProxyOptions {
+    method?: string;
+    reqHeaders?: TWooksProxyControls;
+    reqCookies?: TWooksProxyControls;
+    resHeaders?: TWooksProxyControls;
+    resCookies?: TWooksProxyControls;
+    debug?: boolean;
+}
+//# sourceMappingURL=proxy.d.ts.map

package/dist/src/composables/proxy.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"proxy.d.ts","sourceRoot":"","sources":["../../../src/composables/proxy.ts"],"names":[],"mappings":"AAIA,OAAO,EAAwD,mBAAmB,EAAE,MAAM,eAAe,CAAA;AACzG,OAAO,EAAE,mBAAmB,EAAE,MAAM,eAAe,CAAA;AAgBnD,wBAAgB,QAAQ,aAKgB,MAAM,SAAS,kBAAkB,KAAG,QAAQ,QAAQ,CAAC,CAkE5F;AAED,MAAM,WAAW,kBAAkB;IAC/B,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,UAAU,CAAC,EAAE,mBAAmB,CAAA;IAChC,UAAU,CAAC,EAAE,mBAAmB,CAAA;IAChC,UAAU,CAAC,EAAE,mBAAmB,CAAA;IAChC,UAAU,CAAC,EAAE,mBAAmB,CAAA;IAChC,KAAK,CAAC,EAAE,OAAO,CAAA;CAClB"}

package/dist/src/composables/tests/proxy.spec.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=proxy.spec.d.ts.map

package/dist/src/composables/tests/proxy.spec.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"proxy.spec.d.ts","sourceRoot":"","sources":["../../../../src/composables/tests/proxy.spec.ts"],"names":[],"mappings":""}

package/dist/src/response/core.d.ts

@@ -24,7 +24,7 @@ export declare class BaseWooksResponse<BodyType = unknown> {
     setHeader(name: string, value: string): this;
     getHeader(name: string): string | string[];
     protected mergeHeaders(): this;
-    protected mergeStatus(renderedBody: string): this;
+    protected mergeStatus(renderedBody: string | Uint8Array): this;
     respond(): void;
 }
 //# sourceMappingURL=core.d.ts.map

package/dist/src/response/core.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"core.d.ts","sourceRoot":"","sources":["../../../src/response/core.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,yBAAyB,EAAE,MAAM,YAAY,CAAA;AAEtD,OAAO,EAAE,eAAe,EAAE,MAAM,iBAAiB,CAAA;AAEjD,OAAO,EAAgB,iBAAiB,EAAE,MAAM,qBAAqB,CAAA;AAErE,OAAO,EAAsB,aAAa,EAAE,MAAM,wBAAwB,CAAA;AAY1E,qBAAa,iBAAiB,CAAC,QAAQ,GAAG,OAAO;IACjC,SAAS,CAAC,QAAQ,EAAE,yBAAyB;gBAAnC,QAAQ,GAAE,yBAAwC;IAExE,SAAS,CAAC,OAAO,EAAE,eAAe,CAAI;IAEtC,SAAS,CAAC,KAAK,CAAC,EAAE,QAAQ,CAAA;IAE1B,SAAS,CAAC,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC,CAAK;IAE1D,IAAI,MAAM,IAIQ,eAAe,CAFhC;IAED,IAAI,MAAM,CAAC,KAAK,EAAE,eAAe,EAEhC;IAED,IAAI,IAAI,IAIQ,QAAQ,GAAG,SAAS,CAFnC;IAED,IAAI,IAAI,CAAC,KAAK,EAAE,QAAQ,GAAG,SAAS,EAEnC;IAED,SAAS,CAAC,KAAK,EAAE,eAAe;IAKhC,OAAO,CAAC,KAAK,EAAE,QAAQ;IAKvB,cAAc;IAId,cAAc,CAAC,KAAK,EAAE,MAAM;IAK5B,UAAU,CAAC,MAAM,GAAE,MAAY;IAK/B,SAAS,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,OAAO,CAAC,iBAAiB,CAAC;IAMzE,eAAe,CAAC,IAAI,EAAE,aAAa;IAInC,YAAY,CAAC,QAAQ,EAAE,MAAM;IAM7B,MAAM,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM;IAKlC,SAAS,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM;IAIrC,SAAS,CAAC,IAAI,EAAE,MAAM;IAItB,SAAS,CAAC,YAAY;IAmBtB,SAAS,CAAC,WAAW,CAAC,YAAY,EAAE,MAAM;IAS1C,OAAO;CAuCV"}
+{"version":3,"file":"core.d.ts","sourceRoot":"","sources":["../../../src/response/core.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,yBAAyB,EAAE,MAAM,YAAY,CAAA;AAEtD,OAAO,EAAE,eAAe,EAAE,MAAM,iBAAiB,CAAA;AAEjD,OAAO,EAAgB,iBAAiB,EAAE,MAAM,qBAAqB,CAAA;AAErE,OAAO,EAAsB,aAAa,EAAE,MAAM,wBAAwB,CAAA;AAe1E,qBAAa,iBAAiB,CAAC,QAAQ,GAAG,OAAO;IACjC,SAAS,CAAC,QAAQ,EAAE,yBAAyB;gBAAnC,QAAQ,GAAE,yBAAwC;IAExE,SAAS,CAAC,OAAO,EAAE,eAAe,CAAI;IAEtC,SAAS,CAAC,KAAK,CAAC,EAAE,QAAQ,CAAA;IAE1B,SAAS,CAAC,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC,CAAK;IAE1D,IAAI,MAAM,IAIQ,eAAe,CAFhC;IAED,IAAI,MAAM,CAAC,KAAK,EAAE,eAAe,EAEhC;IAED,IAAI,IAAI,IAIQ,QAAQ,GAAG,SAAS,CAFnC;IAED,IAAI,IAAI,CAAC,KAAK,EAAE,QAAQ,GAAG,SAAS,EAEnC;IAED,SAAS,CAAC,KAAK,EAAE,eAAe;IAKhC,OAAO,CAAC,KAAK,EAAE,QAAQ;IAKvB,cAAc;IAId,cAAc,CAAC,KAAK,EAAE,MAAM;IAK5B,UAAU,CAAC,MAAM,GAAE,MAAY;IAK/B,SAAS,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,OAAO,CAAC,iBAAiB,CAAC;IAMzE,eAAe,CAAC,IAAI,EAAE,aAAa;IAInC,YAAY,CAAC,QAAQ,EAAE,MAAM;IAM7B,MAAM,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM;IAKlC,SAAS,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM;IAIrC,SAAS,CAAC,IAAI,EAAE,MAAM;IAItB,SAAS,CAAC,YAAY;IAoBtB,SAAS,CAAC,WAAW,CAAC,YAAY,EAAE,MAAM,GAAG,UAAU;IASvD,OAAO;CAgDV"}

package/dist/src/response/renderer.d.ts

@@ -1,8 +1,8 @@
 import { BaseWooksResponse } from './core';
 export declare class BaseWooksResponseRenderer<T = unknown> implements TWooksResponseRenderer<T> {
-    render(response: BaseWooksResponse<T>): string;
+    render(response: BaseWooksResponse<T>): string | Uint8Array;
 }
 export interface TWooksResponseRenderer<T = unknown> {
-    render: (response: BaseWooksResponse<T>) => string;
+    render: (response: BaseWooksResponse<T>) => string | Uint8Array;
 }
 //# sourceMappingURL=renderer.d.ts.map

package/dist/src/response/renderer.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"renderer.d.ts","sourceRoot":"","sources":["../../../src/response/renderer.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,QAAQ,CAAA;AAI1C,qBAAa,yBAAyB,CAAC,CAAC,GAAG,OAAO,CAAE,YAAW,sBAAsB,CAAC,CAAC,CAAC;IACpF,MAAM,CAAC,QAAQ,EAAE,iBAAiB,CAAC,CAAC,CAAC,GAAG,MAAM;CAcjD;AAED,MAAM,WAAW,sBAAsB,CAAC,CAAC,GAAG,OAAO;IAC/C,MAAM,EAAE,CAAC,QAAQ,EAAE,iBAAiB,CAAC,CAAC,CAAC,KAAK,MAAM,CAAA;CACrD"}
+{"version":3,"file":"renderer.d.ts","sourceRoot":"","sources":["../../../src/response/renderer.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,QAAQ,CAAA;AAI1C,qBAAa,yBAAyB,CAAC,CAAC,GAAG,OAAO,CAAE,YAAW,sBAAsB,CAAC,CAAC,CAAC;IACpF,MAAM,CAAC,QAAQ,EAAE,iBAAiB,CAAC,CAAC,CAAC,GAAG,MAAM,GAAG,UAAU;CAiB9D;AAED,MAAM,WAAW,sBAAsB,CAAC,CAAC,GAAG,OAAO;IAC/C,MAAM,EAAE,CAAC,QAAQ,EAAE,iBAAiB,CAAC,CAAC,CAAC,KAAK,MAAM,GAAG,UAAU,CAAA;CAClE"}

package/dist/src/utils/log.d.ts

@@ -0,0 +1,5 @@
+export declare function log(text: string): void;
+export declare function logBright(text: string): void;
+export declare function warn(text: string): void;
+export declare function logError(error: string): void;
+//# sourceMappingURL=log.d.ts.map

package/dist/src/utils/log.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"log.d.ts","sourceRoot":"","sources":["../../../src/utils/log.ts"],"names":[],"mappings":"AAGA,wBAAgB,GAAG,CAAC,IAAI,EAAE,MAAM,QAE/B;AAED,wBAAgB,SAAS,CAAC,IAAI,EAAE,MAAM,QAErC;AAED,wBAAgB,IAAI,CAAC,IAAI,EAAE,MAAM,QAEhC;AAED,wBAAgB,QAAQ,CAAC,KAAK,EAAE,MAAM,QAErC"}