@wooksjs/http-proxy 0.1.0

package/README.md

@@ -0,0 +1,102 @@
+# Wooks Proxy
+
+**!!! This is work-in-progress library, breaking changes are expected !!!**
+
+<p align="center">
+<img src="../../logo.png" width="128px"><br>
+<a  href="https://github.com/prostojs/wooks/blob/main/LICENSE">
+    <img src="https://img.shields.io/badge/License-MIT-green?style=for-the-badge" />
+</a>
+</p>
+
+
+Wooks Proxy is composable proxy for [@wooksjs/event-http](https://github.com/wooksjs/wooksjs/tree/main/packages/event-http)
+
+🔥 An easy way to proxy request!
+
+## Install
+
+`npm install @wooksjs/http-proxy`
+
+## Usage
+
+```ts
+import { useProxy } from '@wooksjs/http-proxy'
+app.get('/to-proxy', () => {
+    const proxy = useProxy()
+    return proxy('https://target-website.com/target-path?query=123')
+})
+
+```
+
+### Restrict cookies/headers to pass
+
+```ts
+import { useProxy } from '@wooksjs/http-proxy'
+app.get('/to-proxy', () => {
+    const proxy = useProxy()
+    return proxy('https://target-website.com/target-path?query=123', {
+        reqHeaders: { block: ['referer'] }, // block referer header
+        reqCookies: { block: '*' }, // block all req cookies
+    })
+})
+
+```
+
+### Change response
+
+It's easy as `proxy` returns fetch response
+
+```ts
+import { useProxy } from '@wooksjs/http-proxy'
+app.get('/to-proxy', async () => {
+    const proxy = useProxy()
+    const response = proxy('https://mayapi.com/json-api')
+    const data = { ...(await response.json()), newField: 'new value' }
+    return data
+})
+
+```
+
+## Proxy advanced options
+```ts
+import { useProxy } from '@wooksjs/http-proxy'
+import { useRequest } from '@wooksjs/composables'
+//...
+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| string> | ((data: object) -> object) - object or fn to overwrite data
+        reqHeaders: { block: ['referer'] },
+        reqCookies: { allow: ['cookie-to-pass-upstream'] },
+        resHeaders: { overwrite: { 'x-proxied-by': 'wooks-proxy' } },
+        resCookies: { allow: ['cookie-to-pass-downstream'] },
+
+        // debug: true - will print proxy paths and headers/cookies
+        debug: true,
+    })
+    return fetchResponse // fetch response is supported, the body will be downstreamed
+
+    // > 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
+})
+//...
+```
+

package/dist/index.cjs

@@ -0,0 +1,175 @@
+'use strict';
+
+var nodeFetchNative = require('node-fetch-native');
+var eventHttp = require('@wooksjs/event-http');
+
+/******************************************************************************
+Copyright (c) Microsoft Corporation.
+
+Permission to use, copy, modify, and/or distribute this software for any
+purpose with or without fee is hereby granted.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
+REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
+AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
+INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
+LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
+OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
+PERFORMANCE OF THIS SOFTWARE.
+***************************************************************************** */
+
+function __awaiter(thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+}
+
+const banner = () => `[${"@wooksjs/http-proxy"}][${new Date().toISOString().replace('T', ' ').replace(/\.\d{3}z$/i, '')}] `;
+
+/* istanbul ignore file */
+function warn(text) {
+    console.warn('' + banner() + text + '');
+}
+
+class IterableRecords {
+    constructor() {
+        this.index = 0;
+    }
+    [Symbol.iterator]() {
+        return this;
+    }
+    next() {
+        return { value: undefined, done: true };
+    }
+}
+class CookiesIterable extends IterableRecords {
+    constructor(cookiesString) {
+        super();
+        this.cookies = cookiesString.split(/,\s(?!\d{2}[\s-])/);
+    }
+    next() {
+        const str = this.cookies[this.index++];
+        const ind = str ? str.indexOf('=') : 0;
+        return this.index <= this.cookies.length ?
+            { value: [str.slice(0, ind), str.slice(ind + 1)], done: false } :
+            { value: undefined, done: true };
+    }
+}
+class HeadersIterable extends IterableRecords {
+    constructor(headers) {
+        super();
+        this.entries = Object.entries(headers);
+    }
+    next() {
+        return this.index < this.entries.length ?
+            { value: this.entries[this.index++], done: false } :
+            { value: undefined, done: true };
+    }
+}
+function applyProxyControls(records, controls, additionalBlockers) {
+    let result = {};
+    const { allow, block, overwrite } = controls;
+    const defaultedAllow = allow || '*';
+    if (defaultedAllow) {
+        for (const [name, value] of records) {
+            const add = block !== '*' &&
+                (!additionalBlockers || !additionalBlockers.includes(name)) && (defaultedAllow === '*' ||
+                (defaultedAllow.find(item => typeof item === 'string' && name.toLowerCase() === item.toLowerCase() || item instanceof RegExp && item.test(name)))) && (!block || !block.find(item => typeof item === 'string' && name.toLowerCase() === item.toLowerCase() || item instanceof RegExp && item.test(name)));
+            if (add) {
+                result[name] = value;
+            }
+        }
+    }
+    if (overwrite) {
+        if (typeof overwrite === 'function') {
+            result = overwrite(result);
+        }
+        else {
+            result = Object.assign(Object.assign({}, result), overwrite);
+        }
+    }
+    return result;
+}
+
+const reqHeadersToBlock = [
+    'connection',
+    'accept-encoding',
+    'content-length',
+    'upgrade-insecure-requests',
+    'cookie',
+];
+const resHeadersToBlock = [
+    'transfer-encoding',
+    'content-encoding',
+    'set-cookie',
+];
+function useProxy() {
+    const status = eventHttp.useStatus();
+    const { setHeader, headers: getSetHeaders } = eventHttp.useSetHeaders();
+    const { req } = eventHttp.useHttpContext().getCtx().event;
+    const setHeadersObject = getSetHeaders();
+    return function proxy(target, opts) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const targetUrl = new URL(target);
+            const path = targetUrl.pathname || '/';
+            const url = new URL(path, targetUrl.origin).toString() + (targetUrl.search);
+            // preparing request headers and cookies
+            const modifiedHeaders = Object.assign(Object.assign({}, req.headers), { host: targetUrl.hostname });
+            const headers = (opts === null || opts === void 0 ? void 0 : opts.reqHeaders) ? applyProxyControls(new HeadersIterable(modifiedHeaders), opts === null || opts === void 0 ? void 0 : opts.reqHeaders, reqHeadersToBlock) : {};
+            const cookies = (opts === null || opts === void 0 ? void 0 : opts.reqCookies) && req.headers.cookie ? applyProxyControls(new CookiesIterable(req.headers.cookie), opts === null || opts === void 0 ? void 0 : opts.reqCookies) : null;
+            if (cookies) {
+                headers.cookie = Object.entries(cookies).map(v => v.join('=')).join('; ');
+            }
+            const method = (opts === null || opts === void 0 ? void 0 : opts.method) || req.method;
+            // actual request
+            if (opts === null || opts === void 0 ? void 0 : opts.debug) {
+                console.log();
+                warn(`[proxy] ${''}${req.method} ${req.url}${''} → ${''}${method} ${url}${''}`);
+                console.log('' + 'headers:', JSON.stringify(headers, null, '  '), '');
+            }
+            const resp = yield nodeFetchNative.fetch(url, {
+                method,
+                body: ['GET', 'HEAD'].includes(method) ? undefined : req,
+                headers: headers,
+            });
+            // preparing response
+            status.value = resp.status;
+            if (opts === null || opts === void 0 ? void 0 : opts.debug) {
+                console.log();
+                warn(`[proxy] ${resp.status} ${''}${req.method} ${req.url}${''} → ${''}${method} ${url}${''}`);
+                console.log(`${''}response headers:${''}`);
+            }
+            // preparing response headers
+            const resHeaders = (opts === null || opts === void 0 ? void 0 : opts.resHeaders) ? applyProxyControls(resp.headers.entries(), opts === null || opts === void 0 ? void 0 : opts.resHeaders, resHeadersToBlock) : null;
+            const resCookies = (opts === null || opts === void 0 ? void 0 : opts.resCookies) ? applyProxyControls(new CookiesIterable(resp.headers.get('set-cookie') || ''), opts === null || opts === void 0 ? void 0 : opts.resCookies) : null;
+            if (resHeaders) {
+                for (const [name, value] of Object.entries(resHeaders)) {
+                    if (name) {
+                        setHeader(name, value);
+                        if (opts === null || opts === void 0 ? void 0 : opts.debug) {
+                            console.log(`\t${''}${name}=${''}${value}${''}`);
+                        }
+                    }
+                }
+            }
+            if (resCookies) {
+                setHeadersObject['set-cookie'] = (setHeadersObject['set-cookie'] || []);
+                for (const [name, value] of Object.entries(resCookies)) {
+                    if (name) {
+                        setHeadersObject['set-cookie'].push(`${name}=${value}`);
+                        if (opts === null || opts === void 0 ? void 0 : opts.debug) {
+                            console.log(`\t${''}${''}set-cookie=${''}${name}=${value}${''}`);
+                        }
+                    }
+                }
+            }
+            return resp;
+        });
+    };
+}
+
+exports.useProxy = useProxy;

package/dist/index.d.ts

@@ -0,0 +1,18 @@
+export declare interface TWooksProxyControls {
+    overwrite?: Record<string, string> | ((data: Record<string, string>) => Record<string, string>);
+    allow?: (string | RegExp)[] | '*';
+    block?: (string | RegExp)[] | '*';
+}
+
+export declare interface TWooksProxyOptions {
+    method?: string;
+    reqHeaders?: TWooksProxyControls;
+    reqCookies?: TWooksProxyControls;
+    resHeaders?: TWooksProxyControls;
+    resCookies?: TWooksProxyControls;
+    debug?: boolean;
+}
+
+export declare function useProxy(): (target: string, opts?: TWooksProxyOptions) => Promise<Response>;
+
+export { }

package/dist/index.mjs

@@ -0,0 +1,173 @@
+import { fetch } from 'node-fetch-native';
+import { useStatus, useSetHeaders, useHttpContext } from '@wooksjs/event-http';
+
+/******************************************************************************
+Copyright (c) Microsoft Corporation.
+
+Permission to use, copy, modify, and/or distribute this software for any
+purpose with or without fee is hereby granted.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
+REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
+AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
+INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
+LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
+OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
+PERFORMANCE OF THIS SOFTWARE.
+***************************************************************************** */
+
+function __awaiter(thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+}
+
+const banner = () => `[${"@wooksjs/http-proxy"}][${new Date().toISOString().replace('T', ' ').replace(/\.\d{3}z$/i, '')}] `;
+
+/* istanbul ignore file */
+function warn(text) {
+    console.warn('' + banner() + text + '');
+}
+
+class IterableRecords {
+    constructor() {
+        this.index = 0;
+    }
+    [Symbol.iterator]() {
+        return this;
+    }
+    next() {
+        return { value: undefined, done: true };
+    }
+}
+class CookiesIterable extends IterableRecords {
+    constructor(cookiesString) {
+        super();
+        this.cookies = cookiesString.split(/,\s(?!\d{2}[\s-])/);
+    }
+    next() {
+        const str = this.cookies[this.index++];
+        const ind = str ? str.indexOf('=') : 0;
+        return this.index <= this.cookies.length ?
+            { value: [str.slice(0, ind), str.slice(ind + 1)], done: false } :
+            { value: undefined, done: true };
+    }
+}
+class HeadersIterable extends IterableRecords {
+    constructor(headers) {
+        super();
+        this.entries = Object.entries(headers);
+    }
+    next() {
+        return this.index < this.entries.length ?
+            { value: this.entries[this.index++], done: false } :
+            { value: undefined, done: true };
+    }
+}
+function applyProxyControls(records, controls, additionalBlockers) {
+    let result = {};
+    const { allow, block, overwrite } = controls;
+    const defaultedAllow = allow || '*';
+    if (defaultedAllow) {
+        for (const [name, value] of records) {
+            const add = block !== '*' &&
+                (!additionalBlockers || !additionalBlockers.includes(name)) && (defaultedAllow === '*' ||
+                (defaultedAllow.find(item => typeof item === 'string' && name.toLowerCase() === item.toLowerCase() || item instanceof RegExp && item.test(name)))) && (!block || !block.find(item => typeof item === 'string' && name.toLowerCase() === item.toLowerCase() || item instanceof RegExp && item.test(name)));
+            if (add) {
+                result[name] = value;
+            }
+        }
+    }
+    if (overwrite) {
+        if (typeof overwrite === 'function') {
+            result = overwrite(result);
+        }
+        else {
+            result = Object.assign(Object.assign({}, result), overwrite);
+        }
+    }
+    return result;
+}
+
+const reqHeadersToBlock = [
+    'connection',
+    'accept-encoding',
+    'content-length',
+    'upgrade-insecure-requests',
+    'cookie',
+];
+const resHeadersToBlock = [
+    'transfer-encoding',
+    'content-encoding',
+    'set-cookie',
+];
+function useProxy() {
+    const status = useStatus();
+    const { setHeader, headers: getSetHeaders } = useSetHeaders();
+    const { req } = useHttpContext().getCtx().event;
+    const setHeadersObject = getSetHeaders();
+    return function proxy(target, opts) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const targetUrl = new URL(target);
+            const path = targetUrl.pathname || '/';
+            const url = new URL(path, targetUrl.origin).toString() + (targetUrl.search);
+            // preparing request headers and cookies
+            const modifiedHeaders = Object.assign(Object.assign({}, req.headers), { host: targetUrl.hostname });
+            const headers = (opts === null || opts === void 0 ? void 0 : opts.reqHeaders) ? applyProxyControls(new HeadersIterable(modifiedHeaders), opts === null || opts === void 0 ? void 0 : opts.reqHeaders, reqHeadersToBlock) : {};
+            const cookies = (opts === null || opts === void 0 ? void 0 : opts.reqCookies) && req.headers.cookie ? applyProxyControls(new CookiesIterable(req.headers.cookie), opts === null || opts === void 0 ? void 0 : opts.reqCookies) : null;
+            if (cookies) {
+                headers.cookie = Object.entries(cookies).map(v => v.join('=')).join('; ');
+            }
+            const method = (opts === null || opts === void 0 ? void 0 : opts.method) || req.method;
+            // actual request
+            if (opts === null || opts === void 0 ? void 0 : opts.debug) {
+                console.log();
+                warn(`[proxy] ${''}${req.method} ${req.url}${''} → ${''}${method} ${url}${''}`);
+                console.log('' + 'headers:', JSON.stringify(headers, null, '  '), '');
+            }
+            const resp = yield fetch(url, {
+                method,
+                body: ['GET', 'HEAD'].includes(method) ? undefined : req,
+                headers: headers,
+            });
+            // preparing response
+            status.value = resp.status;
+            if (opts === null || opts === void 0 ? void 0 : opts.debug) {
+                console.log();
+                warn(`[proxy] ${resp.status} ${''}${req.method} ${req.url}${''} → ${''}${method} ${url}${''}`);
+                console.log(`${''}response headers:${''}`);
+            }
+            // preparing response headers
+            const resHeaders = (opts === null || opts === void 0 ? void 0 : opts.resHeaders) ? applyProxyControls(resp.headers.entries(), opts === null || opts === void 0 ? void 0 : opts.resHeaders, resHeadersToBlock) : null;
+            const resCookies = (opts === null || opts === void 0 ? void 0 : opts.resCookies) ? applyProxyControls(new CookiesIterable(resp.headers.get('set-cookie') || ''), opts === null || opts === void 0 ? void 0 : opts.resCookies) : null;
+            if (resHeaders) {
+                for (const [name, value] of Object.entries(resHeaders)) {
+                    if (name) {
+                        setHeader(name, value);
+                        if (opts === null || opts === void 0 ? void 0 : opts.debug) {
+                            console.log(`\t${''}${name}=${''}${value}${''}`);
+                        }
+                    }
+                }
+            }
+            if (resCookies) {
+                setHeadersObject['set-cookie'] = (setHeadersObject['set-cookie'] || []);
+                for (const [name, value] of Object.entries(resCookies)) {
+                    if (name) {
+                        setHeadersObject['set-cookie'].push(`${name}=${value}`);
+                        if (opts === null || opts === void 0 ? void 0 : opts.debug) {
+                            console.log(`\t${''}${''}set-cookie=${''}${name}=${value}${''}`);
+                        }
+                    }
+                }
+            }
+            return resp;
+        });
+    };
+}
+
+export { useProxy };

package/package.json

@@ -0,0 +1,40 @@
+{
+  "name": "@wooksjs/http-proxy",
+  "version": "0.1.0",
+  "description": "Proxy Wooks composable",
+  "main": "dist/index.cjs",
+  "module": "dist/index.mjs",
+  "types": "dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/wooksjs/wooksjs.git",
+    "directory": "packages/http-proxy"
+  },
+  "keywords": [
+    "http",
+    "wooks",
+    "composables",
+    "web",
+    "framework",
+    "app",
+    "api",
+    "rest",
+    "restful",
+    "prostojs"
+  ],
+  "author": "Artem Maltsev",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/wooksjs/wooksjs/issues"
+  },
+  "peerDependencies": {
+    "@wooksjs/event-http": "0.1.0"
+  },
+  "dependencies": {
+    "node-fetch-native": "^0.1.8"
+  },
+  "homepage": "https://github.com/wooksjs/wooksjs/tree/main/packages/http-proxy#readme"
+}