@wooksjs/http-proxy 0.6.5 → 0.7.0

package/README.md

@@ -1,6 +1,4 @@
-# Wooks Proxy
-
-**!!! This is work-in-progress library, breaking changes are expected !!!**
+# @wooksjs/http-proxy
 
 <p align="center">
 <img src="../../wooks-logo.png" width="450px"><br>
@@ -9,94 +7,18 @@
 </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!
+Composable HTTP proxy for [@wooksjs/event-http](https://github.com/wooksjs/wooksjs/tree/main/packages/event-http). Proxy requests with fine-grained control over headers and cookies filtering.
 
 ## Installation
 
-`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
-  })
-})
+```sh
+npm install @wooksjs/http-proxy
 ```
 
-### 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 = await 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/event-http'
-//...
-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()
+## Documentation
 
-  // > or change response before return
-  // const data = await fetchResponse.text() + '<new data>'
-  // return data
-})
-//...
-```
+For full documentation, visit [wooks.moost.org/webapp/proxy](https://wooks.moost.org/webapp/proxy).
 
-## Documentation
+## License
 
-To check out docs, visit [wooks.moost.org](https://wooks.moost.org/).
+MIT

package/dist/index.cjs

@@ -22,7 +22,6 @@ var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__ge
 
 //#endregion
 const node_url = __toESM(require("node:url"));
-const __wooksjs_event_core = __toESM(require("@wooksjs/event-core"));
 const __wooksjs_event_http = __toESM(require("@wooksjs/event-http"));
 
 //#region packages/http-proxy/src/proxy-utils.ts
@@ -121,12 +120,10 @@ const resHeadersToBlock = [
 * @returns An async `proxy(target, opts?)` function that forwards the current request to the given target URL.
 */
 function useProxy() {
-	const status = (0, __wooksjs_event_http.useStatus)();
-	const { setHeader, headers: getSetHeaders } = (0, __wooksjs_event_http.useSetHeaders)();
-	const { getCtx } = (0, __wooksjs_event_http.useHttpContext)();
-	const { req } = getCtx().event;
-	const logger = (0, __wooksjs_event_core.useEventLogger)("http-proxy");
-	const setHeadersObject = getSetHeaders();
+	const response = (0, __wooksjs_event_http.useResponse)();
+	const { rawRequest } = (0, __wooksjs_event_http.useRequest)();
+	const req = rawRequest;
+	const logger = (0, __wooksjs_event_http.useLogger)();
 	return async function proxy(target, opts) {
 		const targetUrl = new node_url.URL(target);
 		const path = targetUrl.pathname || "/";
@@ -148,7 +145,7 @@ function useProxy() {
 			body: ["GET", "HEAD"].includes(method) ? void 0 : req,
 			headers
 		});
-		status.value = resp.status;
+		response.status = resp.status;
 		if (opts?.debug) {
 			logger.info(`${resp.status} ${req.method} ${req.url} → ${method} ${url}`);
 			logger.info(`response headers:`);
@@ -157,14 +154,13 @@ function useProxy() {
 		const resCookies = opts?.resCookies ? applyProxyControls(new CookiesIterable(resp.headers.get(SET_COOKIE) || ""), opts.resCookies) : null;
 		if (resHeaders) {
 			for (const [name, value] of Object.entries(resHeaders)) if (name) {
-				setHeader(name, value);
+				response.setHeader(name, value);
 				if (opts?.debug) logger.info(`\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}`);
+				response.setCookieRaw(`${name}=${value}`);
 				if (opts?.debug) logger.info(`\t${SET_COOKIE}=${name}=${value}`);
 			}
 		}

package/dist/index.mjs

@@ -1,6 +1,5 @@
 import { URL } from "node:url";
-import { useEventLogger } from "@wooksjs/event-core";
-import { useHttpContext, useSetHeaders, useStatus } from "@wooksjs/event-http";
+import { useLogger, useRequest, useResponse } from "@wooksjs/event-http";
 
 //#region packages/http-proxy/src/proxy-utils.ts
 var IterableRecords = class {
@@ -98,12 +97,10 @@ const resHeadersToBlock = [
 * @returns An async `proxy(target, opts?)` function that forwards the current request to the given target URL.
 */
 function useProxy() {
-	const status = useStatus();
-	const { setHeader, headers: getSetHeaders } = useSetHeaders();
-	const { getCtx } = useHttpContext();
-	const { req } = getCtx().event;
-	const logger = useEventLogger("http-proxy");
-	const setHeadersObject = getSetHeaders();
+	const response = useResponse();
+	const { rawRequest } = useRequest();
+	const req = rawRequest;
+	const logger = useLogger();
 	return async function proxy(target, opts) {
 		const targetUrl = new URL(target);
 		const path = targetUrl.pathname || "/";
@@ -125,7 +122,7 @@ function useProxy() {
 			body: ["GET", "HEAD"].includes(method) ? void 0 : req,
 			headers
 		});
-		status.value = resp.status;
+		response.status = resp.status;
 		if (opts?.debug) {
 			logger.info(`${resp.status} ${req.method} ${req.url} → ${method} ${url}`);
 			logger.info(`response headers:`);
@@ -134,14 +131,13 @@ function useProxy() {
 		const resCookies = opts?.resCookies ? applyProxyControls(new CookiesIterable(resp.headers.get(SET_COOKIE) || ""), opts.resCookies) : null;
 		if (resHeaders) {
 			for (const [name, value] of Object.entries(resHeaders)) if (name) {
-				setHeader(name, value);
+				response.setHeader(name, value);
 				if (opts?.debug) logger.info(`\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}`);
+				response.setCookieRaw(`${name}=${value}`);
 				if (opts?.debug) logger.info(`\t${SET_COOKIE}=${name}=${value}`);
 			}
 		}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wooksjs/http-proxy",
-  "version": "0.6.5",
+  "version": "0.7.0",
   "description": "Proxy Wooks composable",
   "keywords": [
     "api",
@@ -42,12 +42,10 @@
   "devDependencies": {
     "typescript": "^5.9.3",
     "vitest": "^3.2.4",
-    "@wooksjs/event-core": "^0.6.5",
-    "@wooksjs/event-http": "^0.6.5"
+    "@wooksjs/event-http": "^0.7.0"
   },
   "peerDependencies": {
-    "@wooksjs/event-core": "^0.6.5",
-    "@wooksjs/event-http": "^0.6.5"
+    "@wooksjs/event-http": "^0.7.0"
   },
   "scripts": {
     "build": "rolldown -c ../../rolldown.config.mjs"