chemicaljs 1.2.5 → 1.3.0

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).
 
 ### Server
 
@@ -123,6 +125,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/example/package-lock.json

@@ -9,7 +9,7 @@
       "version": "1.0.0",
       "license": "MIT",
       "dependencies": {
-        "chemicaljs": "^1.2.4",
+        "chemicaljs": "^1.2.5",
         "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.2.5",
+      "resolved": "https://registry.npmjs.org/chemicaljs/-/chemicaljs-1.2.5.tgz",
+      "integrity": "sha512-MHCs5CDzzwKwdT9ce2ZRdaod0+LoDmtbK7bkyl1I0dfg9Xt8rFeR+dyum4JnYJPHXfwgP86KgHTvSkDEVakT6Q==",
       "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.2.5",
     "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}`);
+});