@mercuryworkshop/epoxy-transport 2.1.28 → 3.0.0

package/esbuild.bundle.mjs

@@ -1,4 +1,4 @@
-// import { dtsPlugin } from "esbuild-plugin-d.ts";
+import { dtsPlugin } from "esbuild-plugin-d.ts";
 import { build } from "esbuild";
 import path from 'node:path'
 import fs, { readFileSync } from 'node:fs'
@@ -89,24 +89,32 @@ let makeAllPackagesExternalPlugin = {
   },
 }
 
+
 build({
   bundle: true,
   format: "esm",
   entryPoints: [`./src/main.ts`],
   outfile: `./dist/index.mjs`,
   plugins: [wasmPlugin],
-  external: ["fs", "ws", "path"],
+  external: ["fs", "path"],
+  logLevel: "info",
 })
 
-build({
+await build({
   bundle: true,
   format: "cjs",
-  entryPoints: [`./src/main.ts`],
-  outfile: `./dist/index.js`,
-  external: ["fs", "ws", "path"],
-  plugins: [wasmPlugin, dataUrl, umdWrapper(umdWrapperOptions)]
-  // plugins: [dtsPlugin({
-  //   outDir: `./dist/`,
-  //   tsconfig: "tsconfig.json"
-  // })]
+  entryPoints: { index: './src/main.ts' },
+  outdir: `./dist/`,
+  external: ["fs", "path"],
+  logLevel: "info",
+  plugins: [
+    wasmPlugin,
+    umdWrapper(umdWrapperOptions),
+    dtsPlugin({
+      outDir: `./dist/`,
+      tsconfig: "tsconfig.json"
+    })
+  ]
 })
+
+fs.renameSync('./dist/main.d.ts', './dist/index.d.ts');

package/package.json

@@ -1,35 +1,33 @@
 {
-	"name": "@mercuryworkshop/epoxy-transport",
-	"version": "2.1.28",
-	"description": "a bare transport that implements end-to-end encryption with epoxy-tls and wisp",
-	"main": "./dist/index.mjs",
-	"keywords": [],
-	"author": "",
-	"type": "module",
-	"license": "AGPL-3.0-only",
-	"scripts": {
-		"build": "node esbuild.bundle.mjs",
-		"prepack": "npm run build"
-	},
-	"dependencies": {
-		"@mercuryworkshop/epoxy-tls": "2.1.18-1"
-	},
-	"devDependencies": {
-		"@mercuryworkshop/bare-mux": "^2.1.7",
-		"esbuild": "^0.25.8",
-		"esbuild-plugin-d.ts": "^1.3.1",
-		"esbuild-plugin-umd-wrapper": "^3.0.0"
-	},
-	"exports": {
-		".": {
-			"browser": {
-				"import": "./dist/index.mjs",
-				"require": "./dist/index.js"
-			},
-			"node": {
-				"require": "./lib/index.cjs",
-				"import": "./lib/index.cjs"
-			}
-		}
-	}
-}
+  "name": "@mercuryworkshop/epoxy-transport",
+  "version": "3.0.0",
+  "description": "a bare transport that implements end-to-end encryption with epoxy-tls and wisp",
+  "main": "./dist/index.mjs",
+  "keywords": [],
+  "author": "",
+  "type": "module",
+  "license": "AGPL-3.0-only",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/MercuryWorkshop/EpoxyTransport.git"
+  },
+  "dependencies": {
+    "@mercuryworkshop/epoxy-tls": "2.1.19-1"
+  },
+  "devDependencies": {
+    "@mercuryworkshop/proxy-transports": "^1.0.2",
+    "esbuild": "^0.25.8",
+    "esbuild-plugin-d.ts": "^1.3.1",
+    "esbuild-plugin-umd-wrapper": "^3.0.0"
+  },
+  "exports": {
+    ".": {
+      "import": "./dist/index.mjs",
+      "require": "./dist/index.js",
+      "types": "./dist/index.d.ts"
+    }
+  },
+  "scripts": {
+    "build": "node esbuild.bundle.mjs"
+  }
+}

package/src/main.ts

@@ -1,21 +1,30 @@
-import type { BareHeaders, TransferrableResponse, BareTransport } from "@mercuryworkshop/bare-mux";
-import initEpoxy, { EpoxyClient, EpoxyClientOptions, EpoxyHandlers, info as epoxyInfo } from "@mercuryworkshop/epoxy-tls";
+import type {
+	RawHeaders,
+	TransferrableResponse,
+	ProxyTransport,
+} from "@mercuryworkshop/proxy-transports";
+import initEpoxy, {
+	EpoxyClient,
+	EpoxyClientOptions,
+	EpoxyHandlers,
+	info as epoxyInfo,
+} from "@mercuryworkshop/epoxy-tls";
 
 export { epoxyInfo };
 
 export type EpoxyOptions = {
-	wisp_v2?: boolean,
-	udp_extension_required?: boolean,
+	wisp_v2?: boolean;
+	udp_extension_required?: boolean;
 
-	title_case_headers?: boolean,
-	ws_title_case_headers?: boolean,
+	title_case_headers?: boolean;
+	ws_title_case_headers?: boolean;
 
-	wisp_ws_protocols?: string[],
+	wisp_ws_protocols?: string[];
 
-	redirect_limit?: number,
-	header_limit?: number,
-	buffer_size?: number,
-}
+	redirect_limit?: number;
+	header_limit?: number;
+	buffer_size?: number;
+};
 const opts = [
 	"wisp_v2",
 	"udp_extension_required",
@@ -24,10 +33,10 @@ const opts = [
 	"wisp_ws_protocols",
 	"redirect_limit",
 	"header_limit",
-	"buffer_size"
+	"buffer_size",
 ];
 
-export default class EpoxyTransport implements BareTransport {
+export default class EpoxyTransport implements ProxyTransport {
 	ready = false;
 
 	client_version: typeof epoxyInfo;
@@ -52,29 +61,54 @@ export default class EpoxyTransport implements BareTransport {
 
 		let options = new EpoxyClientOptions();
 		options.user_agent = navigator.userAgent;
-		opts.forEach(x => this.setopt(options, x))
+		opts.forEach((x) => this.setopt(options, x));
 		this.client = new EpoxyClient(this.wisp, options);
 
 		this.ready = true;
 	}
 
-	async meta() { }
+	async meta() {}
 
 	async request(
 		remote: URL,
 		method: string,
 		body: BodyInit | null,
-		headers: BareHeaders,
+		headers: RawHeaders,
 		signal: AbortSignal | undefined
 	): Promise<TransferrableResponse> {
-		if (body instanceof Blob)
-			body = await body.arrayBuffer();
+		if (body instanceof Blob) body = await body.arrayBuffer();
 
 		try {
-			let res = await this.client.fetch(remote.href, { method, body, headers, redirect: "manual" });
+			let headersObj: Record<string, string> = {};
+			for (let [key, value] of headers) {
+				if (headersObj[key]) {
+					// epoxy does not support multiple headers with the same key
+					console.warn(
+						`Duplicate header key "${key}" detected. Overwriting previous value.`
+					);
+				}
+				headersObj[key] = value;
+			}
+
+			let res = await this.client.fetch(remote.href, {
+				method,
+				body,
+				headers: headersObj,
+				redirect: "manual",
+			});
+			let headersEntries: RawHeaders = [];
+			for (let [key, value] of Object.entries((res as any).rawHeaders) as any) {
+				if (Array.isArray(value)) {
+					for (let v of value) {
+						headersEntries.push([key, v]);
+					}
+				} else {
+					headersEntries.push([key, value]);
+				}
+			}
 			return {
 				body: res.body!,
-				headers: (res as any).rawHeaders,
+				headers: headersEntries,
 				status: res.status,
 				statusText: res.statusText,
 			};
@@ -87,24 +121,41 @@ export default class EpoxyTransport implements BareTransport {
 	connect(
 		url: URL,
 		protocols: string[],
-		requestHeaders: BareHeaders,
-		onopen: (protocol: string) => void,
+		requestHeaders: RawHeaders,
+		onopen: (protocol: string, extensions: string) => void,
 		onmessage: (data: Blob | ArrayBuffer | string) => void,
 		onclose: (code: number, reason: string) => void,
-		onerror: (error: string) => void,
-	): [(data: Blob | ArrayBuffer | string) => void, (code: number, reason: string) => void] {
+		onerror: (error: string) => void
+	): [
+		(data: Blob | ArrayBuffer | string) => void,
+		(code: number, reason: string) => void,
+	] {
 		let handlers = new EpoxyHandlers(
-			onopen,
-			onclose,
+			// epoxy does not support getting the server selected protocol/extension
+			() => onopen("", ""),
+			// epoxy does not support getting close code/reason
+			() => onclose(1000, "Closed by remote"),
 			onerror,
-			(data: Uint8Array | string) => data instanceof Uint8Array ? onmessage(data.buffer) : onmessage(data)
+			(data: Uint8Array | string) =>
+				//@ts-ignore
+				data instanceof Uint8Array ? onmessage(data.buffer) : onmessage(data)
 		);
 
+		let headersObj: Record<string, string> = {};
+		for (let [key, value] of requestHeaders) {
+			if (headersObj[key]) {
+				console.warn(
+					`Duplicate header key "${key}" detected. Overwriting previous value.`
+				);
+			}
+			headersObj[key] = value;
+		}
+
 		let ws = this.client.connect_websocket(
 			handlers,
 			url.href,
 			protocols,
-			Object.assign(requestHeaders)
+			headersObj
 		);
 
 		return [
@@ -113,8 +164,8 @@ export default class EpoxyTransport implements BareTransport {
 				(await ws).send(data);
 			},
 			async (code, reason) => {
-				(await ws).close(code, reason || "")
-			}
-		]
+				(await ws).close(code, reason || "");
+			},
+		];
 	}
 }

package/tsconfig.json

@@ -1,9 +1,9 @@
 {
 	"compilerOptions": {
-		"outDir": "build",
+		"outDir": "dist",
 		"sourceMap": true,
 		"target": "ES2022",
-		"lib": ["DOM", "DOM.Iterable", "ES2019"],
+		"lib": ["DOM", "DOM.Iterable", "ESNext"],
 		"strict": true,
 		"stripInternal": true,
 		"module": "ES6",