chemicaljs 1.2.5 → 1.3.1

package/README.md

@@ -3,7 +3,9 @@ Easily create your own web proxy with no experience required.
 
 ## Setup
 
-A simple example can be found in `/example/`.
+A simple example can be found in [`/example/`](https://github.com/chemicaljs/chemical/tree/main/example).
+
+A example with the vite plugin can be found in [`/example-vite/`](https://github.com/chemicaljs/chemical/tree/main/example-vite).
 
 ### Server
 
@@ -79,6 +81,12 @@ If you want to set the wisp server to an external server just change the `wisp`
 <script wisp="wss://wisp.mercurywork.shop" src="/chemical.js"></script>
 ```
 
+If you want to set the transport just change the `transport` attribute. Choose `libcurl` (default becuase it supports Firefox) or `epoxy`.
+
+```html
+<script transport="epoxy" src="/chemical.js"></script>
+```
+
 2. In a inline script or javascript file, encode a URL with Chemical using the async function `window.chemicalEncode`.
 
 ```js
@@ -105,6 +113,12 @@ window.addEventListener("chemicalLoaded", function(e) {
 });
 ```
 
+4. Change the transport and Wisp URL with `chemicalTransport`
+
+```js
+await chemicalTransport("libcurl", "wss://wisp.mercurywork.shop")
+```
+
 Below is a simple example of a simple input that redirects to the encoded URL when the user presses enter. It checks if there is any input and if Chemical has loaded before loading.
 
 ```html
@@ -123,6 +137,36 @@ Below is a simple example of a simple input that redirects to the encoded URL wh
 </script>
 ```
 
+### Vite Plugin
+
+1. Create a new vite app and open `vite.config.js` or `vite.config.ts`
+
+2. Import `ChemicalPluginVite` and add it to plugins.
+
+```js
+import { defineConfig } from "vite"
+import { ChemicalPluginVite } from "chemicaljs"
+
+export default defineConfig({
+    plugins: [/*Other plugins*/ChemicalPluginVite()],
+})
+```
+
+You can pass options to just like on the main server.
+
+```js
+export default defineConfig({
+    plugins: [
+        ChemicalPluginVite({
+            default: "rammerhead",
+            uv: true,
+            scramjet: false,
+            rammerhead: true
+        })
+    ],
+})
+```
+
 ## Future Addition
 
 Some features that may come in the future are:

package/client/chemical.js

@@ -202,11 +202,29 @@ async function chemicalEncode(url, service = defaultService) {
     }
 }
 
+function getTransport(transport) {
+    switch (transport) {
+        case "libcurl":
+            return "/libcurl/index.mjs"
+            break;
+        case "epoxy":
+            return "/epoxy/index.mjs"
+            break;
+    }
+}
+
+let connection;
+
 let wispURL = document.currentScript.getAttribute("wisp");
+let transport = document.currentScript.getAttribute("transport");
+
+async function chemicalTransport(transport, wisp) {
+    await connection.setTransport(getTransport(transport) || "/libcurl/index.mjs", [{ wisp: wisp || (location.protocol === "https:" ? "wss" : "ws") + "://" + location.host + "/wisp/" }]);
+}
 
 async function registerSW() {
-    const connection = new window.BareMux.BareMuxConnection("/baremux/worker.js");
-    await connection.setTransport("/epoxy/index.mjs", [{ wisp: wispURL || (location.protocol === "https:" ? "wss" : "ws") + "://" + location.host + "/wisp/" }]);
+    connection = new window.BareMux.BareMuxConnection("/baremux/worker.js");
+    await chemicalTransport();
 
     if ("serviceWorker" in navigator) {
         await navigator.serviceWorker.register("/chemical.sw.js");

package/example/index.js

@@ -1,4 +1,4 @@
-import { ChemicalServer } from "chemicaljs";
+import { ChemicalServer } from "../index.js";
 import express from "express";
 
 const chemical = new ChemicalServer();

package/example/package-lock.json

@@ -9,7 +9,7 @@
       "version": "1.0.0",
       "license": "MIT",
       "dependencies": {
-        "chemicaljs": "^1.2.4",
+        "chemicaljs": "^1.3.0",
         "express": "^4.19.2"
       }
     },
@@ -1146,12 +1146,12 @@
       }
     },
     "node_modules/chemicaljs": {
-      "version": "1.2.4",
-      "resolved": "https://registry.npmjs.org/chemicaljs/-/chemicaljs-1.2.4.tgz",
-      "integrity": "sha512-gHFje3KkFNHT49jsRibzcSFACAg49VjNAy9mcqB7yII2vwIQr41SvRZ2+BwHIa8uA3ep/ovlty6qGBZxkTjgbg==",
+      "version": "1.3.0",
+      "resolved": "https://registry.npmjs.org/chemicaljs/-/chemicaljs-1.3.0.tgz",
+      "integrity": "sha512-WJf2OA33QuFxhqRJCECk8lh8VWzURVc2CqIPfkAYBBIY/6XO98xvEbsxjkrQoxGegz7ilC7BqvQkV3h2ASIjQQ==",
       "dependencies": {
         "@mercuryworkshop/bare-mux": "^2.0.1",
-        "@mercuryworkshop/epoxy-transport": "^2.1.2",
+        "@mercuryworkshop/epoxy-transport": "^2.1.3",
         "@mercuryworkshop/scramjet": "^1.0.2",
         "@titaniumnetwork-dev/ultraviolet": "^3.2.1",
         "express": "^4.19.2",

package/example/package.json

@@ -18,7 +18,7 @@
   },
   "homepage": "https://github.com/chemicaljs/chemical#readme",
   "dependencies": {
-    "chemicaljs": "^1.2.4",
+    "chemicaljs": "^1.3.0",
     "express": "^4.19.2"
   }
 }

package/example-vite/README.md

@@ -0,0 +1,9 @@
+# Chemical Example Vite
+
+Note: This example uses Preact but any framework will work.
+
+Run `npm install` to install dependencies.
+
+Run `npm run build` to build and `npm start` to start.
+
+Run `npm run dev` to start the dev server which is the point of this example.

package/example-vite/index.html

@@ -0,0 +1,12 @@
+<!doctype html>
+<html lang="en">
+<head>
+    <meta charset="UTF-8" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+    <script src="/chemical.js"></script>
+</head>
+<body>
+    <div id="app"></div>
+    <script type="module" src="/src/main.jsx"></script>
+</body>
+</html>

package/example-vite/index.js

@@ -0,0 +1,14 @@
+import { ChemicalServer } from "chemicaljs";
+import express from "express";
+
+const chemical = new ChemicalServer();
+const port = process.env.PORT || 3000;
+
+chemical.app.use(express.static("dist", {
+    index: "index.html",
+    extensions: ["html"]
+}));
+
+chemical.server.listen(port, () => {
+    console.log(`Chemical example vite listening on port ${port}`);
+});