@wooksjs/http-proxy 0.6.2 → 0.6.3

package/README.md

@@ -48,7 +48,7 @@ It's easy as `proxy` returns fetch response
 import { useProxy } from '@wooksjs/http-proxy'
 app.get('/to-proxy', async () => {
   const proxy = useProxy()
-  const response = proxy('https://mayapi.com/json-api')
+  const response = await proxy('https://mayapi.com/json-api')
   const data = { ...(await response.json()), newField: 'new value' }
   return data
 })
@@ -58,7 +58,7 @@ app.get('/to-proxy', async () => {
 
 ```ts
 import { useProxy } from '@wooksjs/http-proxy'
-import { useRequest } from '@wooksjs/composables'
+import { useRequest } from '@wooksjs/event-http'
 //...
 app.get('*', async () => {
   const proxy = useProxy()

package/dist/index.cjs

@@ -103,6 +103,23 @@ const resHeadersToBlock = [
 	"content-encoding",
 	SET_COOKIE
 ];
+/**
+* Composable that returns a `proxy` function for forwarding HTTP requests to a target URL.
+*
+* @example
+* ```ts
+* app.get('/api/*', async () => {
+*   const proxy = useProxy()
+*   const response = await proxy('https://backend.example.com/api', {
+*     reqHeaders: { allow: '*' },
+*     resHeaders: { allow: '*' },
+*   })
+*   return response
+* })
+* ```
+*
+* @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)();

package/dist/index.d.ts

@@ -1,17 +1,46 @@
+/** Controls for filtering and transforming proxied headers or cookies. */
 interface TWooksProxyControls {
+    /** Override specific key-value pairs, or provide a transform function. */
     overwrite?: Record<string, string> | ((data: Record<string, string>) => Record<string, string>);
+    /** Allowlist of keys (strings or patterns) to forward; use `'*'` to allow all. */
     allow?: Array<string | RegExp> | '*';
+    /** Blocklist of keys (strings or patterns) to suppress; use `'*'` to block all. */
     block?: Array<string | RegExp> | '*';
 }
+/** Options for configuring the proxy request, including header/cookie controls and debugging. */
 interface TWooksProxyOptions {
+    /** Override the HTTP method used for the proxied request. */
     method?: string;
+    /** Controls for filtering/transforming outgoing request headers. */
     reqHeaders?: TWooksProxyControls;
+    /** Controls for filtering/transforming outgoing request cookies. */
     reqCookies?: TWooksProxyControls;
+    /** Controls for filtering/transforming incoming response headers. */
     resHeaders?: TWooksProxyControls;
+    /** Controls for filtering/transforming incoming response cookies. */
     resCookies?: TWooksProxyControls;
+    /** When true, logs proxy request and response details. */
     debug?: boolean;
 }
 
+/**
+ * Composable that returns a `proxy` function for forwarding HTTP requests to a target URL.
+ *
+ * @example
+ * ```ts
+ * app.get('/api/*', async () => {
+ *   const proxy = useProxy()
+ *   const response = await proxy('https://backend.example.com/api', {
+ *     reqHeaders: { allow: '*' },
+ *     resHeaders: { allow: '*' },
+ *   })
+ *   return response
+ * })
+ * ```
+ *
+ * @returns An async `proxy(target, opts?)` function that forwards the current request to the given target URL.
+ */
 declare function useProxy(): (target: string, opts?: TWooksProxyOptions) => Promise<Response>;
 
-export { type TWooksProxyControls, type TWooksProxyOptions, useProxy };
+export { useProxy };
+export type { TWooksProxyControls, TWooksProxyOptions };

package/dist/index.mjs

@@ -80,6 +80,23 @@ const resHeadersToBlock = [
 	"content-encoding",
 	SET_COOKIE
 ];
+/**
+* Composable that returns a `proxy` function for forwarding HTTP requests to a target URL.
+*
+* @example
+* ```ts
+* app.get('/api/*', async () => {
+*   const proxy = useProxy()
+*   const response = await proxy('https://backend.example.com/api', {
+*     reqHeaders: { allow: '*' },
+*     resHeaders: { allow: '*' },
+*   })
+*   return response
+* })
+* ```
+*
+* @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();

package/package.json

@@ -1,52 +1,53 @@
 {
   "name": "@wooksjs/http-proxy",
-  "version": "0.6.2",
+  "version": "0.6.3",
   "description": "Proxy Wooks composable",
-  "main": "dist/index.cjs",
-  "module": "dist/index.mjs",
-  "types": "dist/index.d.ts",
-  "files": [
-    "dist"
-  ],
-  "exports": {
-    "./package.json": "./package.json",
-    ".": {
-      "require": "./dist/index.cjs",
-      "import": "./dist/index.mjs",
-      "types": "./dist/index.d.ts"
-    }
-  },
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/wooksjs/wooksjs.git",
-    "directory": "packages/http-proxy"
-  },
   "keywords": [
-    "http",
-    "wooks",
+    "api",
+    "app",
     "composables",
-    "web",
     "framework",
-    "app",
-    "api",
+    "http",
+    "prostojs",
     "rest",
     "restful",
-    "prostojs"
+    "web",
+    "wooks"
   ],
-  "author": "Artem Maltsev",
-  "license": "MIT",
+  "homepage": "https://github.com/wooksjs/wooksjs/tree/main/packages/http-proxy#readme",
   "bugs": {
     "url": "https://github.com/wooksjs/wooksjs/issues"
   },
-  "peerDependencies": {
-    "@wooksjs/event-core": "^0.6.2",
-    "@wooksjs/event-http": "^0.6.2"
+  "license": "MIT",
+  "author": "Artem Maltsev",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/wooksjs/wooksjs.git",
+    "directory": "packages/http-proxy"
+  },
+  "files": [
+    "dist"
+  ],
+  "main": "dist/index.cjs",
+  "module": "dist/index.mjs",
+  "types": "dist/index.d.ts",
+  "exports": {
+    "./package.json": "./package.json",
+    ".": {
+      "types": "./dist/index.d.ts",
+      "require": "./dist/index.cjs",
+      "import": "./dist/index.mjs"
+    }
   },
-  "dependencies": {},
-  "homepage": "https://github.com/wooksjs/wooksjs/tree/main/packages/http-proxy#readme",
   "devDependencies": {
-    "typescript": "^5.8.3",
-    "vitest": "^3.2.4"
+    "typescript": "^5.9.3",
+    "vitest": "^3.2.4",
+    "@wooksjs/event-http": "^0.6.3",
+    "@wooksjs/event-core": "^0.6.3"
+  },
+  "peerDependencies": {
+    "@wooksjs/event-core": "^0.6.3",
+    "@wooksjs/event-http": "^0.6.3"
   },
   "scripts": {
     "build": "rolldown -c ../../rolldown.config.mjs"