@remix-run/fetch-proxy 0.7.0 → 0.7.1

package/README.md

@@ -2,16 +2,18 @@
 
 `fetch-proxy` is an HTTP proxy for the [JavaScript Fetch API](https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API).
 
+HTTP proxies are essential for many web architectures: load balancing, API gateways, development servers that forward to backend services, and middleware that needs to intercept and modify traffic. Traditional proxy implementations often require platform-specific APIs or complex server setups.
+
 In the context of servers, an HTTP proxy server is a server that forwards all requests it receives to another server and returns the responses it receives. When you think about it this way, a [`fetch` function](https://developer.mozilla.org/en-US/docs/Web/API/Window/fetch) is like a mini proxy server sitting right there in your code. You send it requests, it goes and talks to some other server, and it gives you back the response it received.
 
-`fetch-proxy` allows you to easily create `fetch` functions that act as proxies to "target" servers.
+`fetch-proxy` allows you to easily create `fetch` functions that act as proxies to "target" servers using the familiar web-standard Fetch API.
 
 ## Features
 
-- Built on the standard [JavaScript Fetch API](https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API)
-- Supports rewriting `Set-Cookie` headers received from target server
-- Supports `X-Forwarded-Proto` and `X-Forwarded-Host` headers
-- Supports custom `fetch` implementations
+- **Web Standards** - Built on the standard [JavaScript Fetch API](https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API)
+- **Cookie Rewriting** - Supports rewriting `Set-Cookie` headers received from target server
+- **Forwarding Headers** - Supports `X-Forwarded-Proto` and `X-Forwarded-Host` headers
+- **Custom Fetch** - Supports custom `fetch` implementations
 
 ## Installation
 

package/dist/lib/fetch-proxy.d.ts

@@ -1,33 +1,48 @@
+/**
+ * Options for `createFetchProxy`.
+ */
 export interface FetchProxyOptions {
     /**
-     * The `fetch` function to use for the actual fetch. Defaults to the global `fetch` function.
+     * The `fetch` function to use for the actual fetch.
+     *
+     * @default globalThis.fetch
      */
     fetch?: typeof globalThis.fetch;
     /**
      * Set `false` to prevent the `Domain` attribute of `Set-Cookie` headers from being rewritten. By
      * default the domain will be rewritten to the domain of the incoming request.
+     *
+     * @default true
      */
     rewriteCookieDomain?: boolean;
     /**
      * Set `false` to prevent the `Path` attribute of `Set-Cookie` headers from being rewritten. By
      * default the portion of the pathname that matches the proxy target's pathname will be removed.
+     *
+     * @default true
      */
     rewriteCookiePath?: boolean;
     /**
      * Set `true` to add `X-Forwarded-Proto` and `X-Forwarded-Host` headers to the proxied request.
-     * Defaults to `false`.
+     *
+     * @default false
      */
     xForwardedHeaders?: boolean;
 }
 /**
  * A [`fetch` function](https://developer.mozilla.org/en-US/docs/Web/API/Window/fetch)
  * that forwards requests to another server.
+ *
+ * @param input The URL or request to forward
+ * @param init Optional request init options
+ * @returns A promise that resolves to the proxied response
  */
 export interface FetchProxy {
     (input: URL | RequestInfo, init?: RequestInit): Promise<Response>;
 }
 /**
  * Creates a `fetch` function that forwards requests to another server.
+ *
  * @param target The URL of the server to proxy requests to
  * @param options Options to customize the behavior of the proxy
  * @returns A fetch function that forwards requests to the target server

package/dist/lib/fetch-proxy.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"fetch-proxy.d.ts","sourceRoot":"","sources":["../../src/lib/fetch-proxy.ts"],"names":[],"mappings":"AAEA,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,KAAK,CAAC,EAAE,OAAO,UAAU,CAAC,KAAK,CAAA;IAC/B;;;OAGG;IACH,mBAAmB,CAAC,EAAE,OAAO,CAAA;IAC7B;;;OAGG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAA;IAC3B;;;OAGG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAA;CAC5B;AAED;;;GAGG;AACH,MAAM,WAAW,UAAU;IACzB,CAAC,KAAK,EAAE,GAAG,GAAG,WAAW,EAAE,IAAI,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,QAAQ,CAAC,CAAA;CAClE;AAED;;;;;GAKG;AACH,wBAAgB,gBAAgB,CAAC,MAAM,EAAE,MAAM,GAAG,GAAG,EAAE,OAAO,CAAC,EAAE,iBAAiB,GAAG,UAAU,CAoF9F"}
+{"version":3,"file":"fetch-proxy.d.ts","sourceRoot":"","sources":["../../src/lib/fetch-proxy.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC;;;;OAIG;IACH,KAAK,CAAC,EAAE,OAAO,UAAU,CAAC,KAAK,CAAA;IAC/B;;;;;OAKG;IACH,mBAAmB,CAAC,EAAE,OAAO,CAAA;IAC7B;;;;;OAKG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAA;IAC3B;;;;OAIG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAA;CAC5B;AAED;;;;;;;GAOG;AACH,MAAM,WAAW,UAAU;IACzB,CAAC,KAAK,EAAE,GAAG,GAAG,WAAW,EAAE,IAAI,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,QAAQ,CAAC,CAAA;CAClE;AAED;;;;;;GAMG;AACH,wBAAgB,gBAAgB,CAAC,MAAM,EAAE,MAAM,GAAG,GAAG,EAAE,OAAO,CAAC,EAAE,iBAAiB,GAAG,UAAU,CAoF9F"}

package/dist/lib/fetch-proxy.js

@@ -1,6 +1,7 @@
 import { SetCookie } from '@remix-run/headers';
 /**
  * Creates a `fetch` function that forwards requests to another server.
+ *
  * @param target The URL of the server to proxy requests to
  * @param options Options to customize the behavior of the proxy
  * @returns A fetch function that forwards requests to the target server

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@remix-run/fetch-proxy",
-  "version": "0.7.0",
+  "version": "0.7.1",
   "description": "An HTTP proxy for the web Fetch API",
   "author": "Michael Jackson <mjijackson@gmail.com>",
   "license": "MIT",
@@ -25,12 +25,12 @@
     },
     "./package.json": "./package.json"
   },
-  "peerDependencies": {
-    "@remix-run/headers": "^0.16.0"
+  "dependencies": {
+    "@remix-run/headers": "^0.19.0"
   },
   "devDependencies": {
     "@types/node": "^24.6.0",
-    "typescript": "^5.9.3"
+    "@typescript/native-preview": "7.0.0-dev.20251125.1"
   },
   "keywords": [
     "fetch",
@@ -38,9 +38,9 @@
     "proxy"
   ],
   "scripts": {
-    "build": "tsc -p tsconfig.build.json",
+    "build": "tsgo -p tsconfig.build.json",
     "clean": "git clean -fdX",
-    "test": "node --disable-warning=ExperimentalWarning --test './src/**/*.test.ts'",
-    "typecheck": "tsc --noEmit"
+    "test": "node --disable-warning=ExperimentalWarning --test",
+    "typecheck": "tsgo --noEmit"
   }
 }

package/src/lib/fetch-proxy.ts

@@ -1,23 +1,33 @@
 import { SetCookie } from '@remix-run/headers'
 
+/**
+ * Options for `createFetchProxy`.
+ */
 export interface FetchProxyOptions {
   /**
-   * The `fetch` function to use for the actual fetch. Defaults to the global `fetch` function.
+   * The `fetch` function to use for the actual fetch.
+   *
+   * @default globalThis.fetch
    */
   fetch?: typeof globalThis.fetch
   /**
    * Set `false` to prevent the `Domain` attribute of `Set-Cookie` headers from being rewritten. By
    * default the domain will be rewritten to the domain of the incoming request.
+   *
+   * @default true
    */
   rewriteCookieDomain?: boolean
   /**
    * Set `false` to prevent the `Path` attribute of `Set-Cookie` headers from being rewritten. By
    * default the portion of the pathname that matches the proxy target's pathname will be removed.
+   *
+   * @default true
    */
   rewriteCookiePath?: boolean
   /**
    * Set `true` to add `X-Forwarded-Proto` and `X-Forwarded-Host` headers to the proxied request.
-   * Defaults to `false`.
+   *
+   * @default false
    */
   xForwardedHeaders?: boolean
 }
@@ -25,6 +35,10 @@ export interface FetchProxyOptions {
 /**
  * A [`fetch` function](https://developer.mozilla.org/en-US/docs/Web/API/Window/fetch)
  * that forwards requests to another server.
+ *
+ * @param input The URL or request to forward
+ * @param init Optional request init options
+ * @returns A promise that resolves to the proxied response
  */
 export interface FetchProxy {
   (input: URL | RequestInfo, init?: RequestInit): Promise<Response>
@@ -32,6 +46,7 @@ export interface FetchProxy {
 
 /**
  * Creates a `fetch` function that forwards requests to another server.
+ *
  * @param target The URL of the server to proxy requests to
  * @param options Options to customize the behavior of the proxy
  * @returns A fetch function that forwards requests to the target server