@mercuryworkshop/bare-mux - npm Package Compare versions

Comparing version 2.0.4 to 2.0.5

dist/client.d.ts

@@ -58,3 +58,3 @@ import { BareHeaders, BareTransport } from './baretypes';
     worker: WorkerConnection;
-    constructor(workerPath: string);
+    constructor(worker: string | Promise<MessagePort> | MessagePort);
     getTransport(): Promise<string>;
@@ -71,5 +71,5 @@ setTransport(path: string, options: any[], transferables?: Transferable[]): Promise<void>;
      */
-    constructor(worker?: string | MessagePort);
+    constructor(worker?: string | Promise<MessagePort> | MessagePort);
     createWebSocket(remote: string | URL, protocols?: string | string[] | undefined, webSocketImpl?: WebSocketImpl, requestHeaders?: BareHeaders, arrayBufferImpl?: ArrayBuffer): WebSocket;
     fetch(url: string | URL, init?: RequestInit): Promise<BareResponseFetch>;
 }

dist/connection.d.ts

@@ -40,5 +40,5 @@ import { BareHeaders, TransferrableResponse } from "./baretypes";
     workerPath: string;
-    constructor(worker?: string | MessagePort);
+    constructor(worker?: string | Promise<MessagePort> | MessagePort);
     createChannel(workerPath?: string, inInit?: boolean): void;
     sendMessage(message: WorkerMessage, transferable?: Transferable[]): Promise<WorkerResponse>;
 }

dist/index.js

@@ -36,3 +36,6 @@ (function (global, factory) {
 	    });
-	    const promise = Promise.race([Promise.any(promises), new Promise((_, reject) => setTimeout(reject, 1000, new TypeError("timeout")))]);
+	    const promise = Promise.race([
+	        Promise.any(promises),
+	        new Promise((_, reject) => setTimeout(reject, 1000, new TypeError("timeout")))
+	    ]);
 	    try {
@@ -109,3 +112,3 @@ return await promise;
 	        this.channel = new BroadcastChannel("bare-mux");
-	        if (worker instanceof MessagePort) {
+	        if (worker instanceof MessagePort || worker instanceof Promise) {
 	            this.port = worker;
@@ -242,4 +245,4 @@ }
 	class BareMuxConnection {
-	    constructor(workerPath) {
-	        this.worker = new WorkerConnection(workerPath);
+	    constructor(worker) {
+	        this.worker = new WorkerConnection(worker);
 	    }
@@ -246,0 +249,0 @@ async getTransport() {

package.json

 {
   "name": "@mercuryworkshop/bare-mux",
-  "version": "2.0.4",
+  "version": "2.0.5",
   "description": "",
@@ -5,0 +5,0 @@ "type": "module",

README.md

@@ -1,4 +0,5 @@
-# Bare-Mux
+# bare-mux
+<a href="https://www.npmjs.com/package/@mercuryworkshop/bare-mux"><img src="https://img.shields.io/npm/v/@mercuryworkshop/bare-mux.svg?maxAge=3600" alt="npm version" /></a>
 
-A system for managing http transports in a project such as [Ultraviolet](https://github.com/Titaniumnetwork-dev/Ultraviolet).
+A system for managing http transports in a project such as [Ultraviolet](https://github.com/Titaniumnetwork-dev/Ultraviolet) and [Scramjet](https://github.com/MercuryWorkshop/Scramjet).
 
@@ -38,7 +39,10 @@ Written to make the job of creating new standards for transporting http data seamless.
 ```
+
+A guide to making a transport can be found [here](./documentation/Transport.md).
+
 ## Upgrading
 
-A guide for updating from v1 to v2 can be found [here](https://github.com/MercuryWorkshop/bare-mux/blob/master/documentation/Upgrading.md).
+A guide for updating from v1 to v2 can be found [here](./documentation/Upgrading.md).
 
-## Older bare-mux versions
+### Older bare-mux versions
 
@@ -55,3 +59,4 @@ Starting from v2, bare-mux uses [SharedWorkers](https://developer.mozilla.org/en-US/docs/Web/API/SharedWorker) to provide stability and improve on resource usage.
 
-Examples of transports include [EpoxyTransport](https://github.com/MercuryWorkshop/EpoxyTransport),  [CurlTransport](https://github.com/MercuryWorkshop/CurlTransport), and [Bare-Client](https://github.com/MercuryWorkshop/Bare-as-module3).
+## Usage
+Examples of transports include [EpoxyTransport](https://github.com/MercuryWorkshop/EpoxyTransport), [CurlTransport](https://github.com/MercuryWorkshop/CurlTransport), and [Bare-Client](https://github.com/MercuryWorkshop/Bare-as-module3).
 
@@ -63,7 +68,9 @@ Here is an example of using bare-mux:
 const conn = new BareMuxConnection("/bare-mux/worker.js");
-
 // Set Bare-Client transport
-// If your transport is an ES module and exports the class as the default export
-await conn.setTransport("/bare-mux/transport-module.js", ["arg1", "ws://localhost:4000"]);
+await conn.setTransport("/path/to/transport/index.mjs", ["arg1", { wisp: "wss://wisp.mercurywork.shop" }, "arg3"]);
+// Epoxy Client as an example
+await conn.setTransport("/epoxy/index.mjs", [{ wisp: "wss://wisp.mercurywork.shop/" }]);
+```
 
+```js
 /// As a proxy developer
@@ -77,12 +84,1 @@ import { BareClient } from "@mercuryworkshop/bare-mux";
 ```
-
-## WebWorker support
-Due to limitations in browsers, there is no way for bare-mux to get a connection to the bare-mux SharedWorker while inside a WebWorker. Proxies that use bare-mux must manually pass in a MessagePort to the SharedWorker to be able to use BareClient in a WebWorker.
-```js
-const connection = new Ultraviolet.BareMuxConnection();
-let port = connection.getInnerPort();
-// this could be a promise, but right now it's only a promise when called inside a service worker
-if (port instanceof Promise) port = await port;
-// ... transfer it to worker ...
-this.bareClient = new BareClient(port)
-```

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Copyleft License

License

(Experimental) Copyleft license information was found.

Found 1 instance in 1 package

Non-permissive License

License

(Experimental) A license not known to be considered permissive was found.

Found 1 instance in 1 package

Improved metrics

Number of low license alerts

0

decreased by-100%

License quality

100

increased by42.86%

Lines of code

1423

increased by0.42%

Worsened metrics

Total package byte prevSize

65246

decreased by-33.95%

Number of lines in readme file

81

decreased by-4.71%

No dependency changes