Added minor documentation and typing.

Author: Chriztiaan

.changeset/hip-lamps-draw.md

@@ -0,0 +1,5 @@
+---
+'@powersync/node': minor
+---
+
+Introduced support for specifying proxy environment variables for the connection methods. For HTTP it supports `HTTP_PROXY` or `HTTPS_PROXY`, and for WebSockets it supports `WS_PROXY` and `WSS_PROXY`.

.changeset/thick-lies-invent.md

@@ -0,0 +1,5 @@
+---
+'@powersync/common': minor
+---
+
+Added `fetchOptions` to AbstractRemoteOptions. Allows consumers to include fields such as `dispatcher` (e.g. for proxy support) to the fetch invocations.

packages/common/src/client/sync/stream/AbstractRemote.ts

@@ -86,7 +86,12 @@ export type AbstractRemoteOptions = {
    */
   fetchImplementation: FetchImplementation | FetchImplementationProvider;
 
-  // TODO
+  /**
+   * Optional options to pass directly to all `fetch` calls.
+   *
+   * This can include fields such as `dispatcher` (e.g. for proxy support),
+   * `cache`, or any other fetch-compatible options.
+   */
   fetchOptions?: {};
 };
 

packages/node/README.md

@@ -56,6 +56,22 @@ contains everything you need to know to get started implementing PowerSync in yo
 
 A simple example using `@powersync/node` is available in the [`demos/example-node/`](../demos/example-node) directory.
 
+# Proxy Support
+
+This SDK supports HTTP, HTTPS, and WebSocket proxies via environment variables.
+
+## HTTP Connection Method
+
+Internally we probe the http environment variables and apply it to fetch requests ([undici](https://www.npmjs.com/package/undici/v/5.6.0))
+
+- Set the `HTTPS_PROXY` or `HTTP_PROXY` environment variable to automatically route HTTP requests through a proxy.
+
+## WEB Socket Connection Method
+
+Internally the [proxy-agent](https://www.npmjs.com/package/proxy-agent) dependency for WebSocket proxies, which has its own internal code for automatically picking up the appropriate environment variables:
+
+- Set the `WS_PROXY` or `WSS_PROXY` environment variable to route the webocket connections through a proxy.
+
 # Found a bug or need help?
 
 - Join our [Discord server](https://discord.gg/powersync) where you can browse topics from our community, ask questions, share feedback, or just say hello :)

packages/node/src/sync/stream/NodeRemote.ts

@@ -50,12 +50,13 @@ export class NodeRemote extends AbstractRemote {
 
   protected createSocket(url: string): globalThis.WebSocket {
     return new WebSocket(url, {
-      // Undici does not seem to be compatible with ws
+      // Undici does not seem to be compatible with ws, using `proxy-agent` instead.
+      // Automatically uses WS_PROXY or WSS_PROXY env vars
       agent: new Agent.ProxyAgent(),
       headers: {
         'User-Agent': this.getUserAgent()
       }
-    }) as any as globalThis.WebSocket; // TODO
+    }) as any as globalThis.WebSocket; // This is compatible in Node environments
   }
 
   getUserAgent(): string {