chemicaljs 1.7.3 → 1.7.4

package/README.md

@@ -1,374 +1,8 @@
 # Chemical
 Easily create your own web proxy with no experience required.
 
-> [!IMPORTANT]  
-> I am in the process of creating a documentation site. These docs might be outdated.
-
-## Setup
-
-A simple example can be found in [`/example/`](https://github.com/chemicaljs/chemical/tree/main/examples/example).
-
-A example with the vite plugin can be found in [`/example-vite/`](https://github.com/chemicaljs/chemical/tree/main/examples/example-vite).
-
-A example with all the components can be found in [`/example-components/`](https://github.com/chemicaljs/chemical/tree/main/examples/example-components).
-
-A real world styled example can be found in [`/example-styled/`](https://github.com/chemicaljs/chemical/tree/main/examples/example-styled).
-
-A example with a build command and an external wisp server can be found in [`/example-build/`](https://github.com/chemicaljs/chemical/tree/main/examples/example-build).
-
-
-### Server
-
-Create a new Node.js project and create a script file for the server.
-
-1. Install Chemical `npm install chemicaljs`.
-
-2. Import `ChemicalServer` and create a new server.
-
-```js
-import { ChemicalServer } from "chemicaljs";
-
-const [app, listen] = new ChemicalServer();
-```
-
-You can pass options to disable proxy services and set the default service.
-
-```js
-const [app, listen] = new ChemicalServer({
-    default: "rammerhead",
-    uv: true,
-    scramjet: false,
-    rammerhead: true,
-    hostname_blacklist: [ /google\.com/, /reddit\.com/ ],
-    hostname_whitelist: [ /example\.com/ ]
-});
-```
-
-`hostname_whitelist` overrides `hostname_blacklist` if you try to set them both.
-
-3. Use `app` which is an express app. You may need to import express for certain APIs.
-
-```js
-app.get("/", function(req, res){
-    res.send("Hello World");
-});
-```
-
-4. Use `app.serveChemical()` to serve Chemical routes.
-
-5. Use `serveChemical` after main routes but before 404 routes. Example 404 page.
-
-```js
-app.use((req, res) => {
-    res.status(404);
-    res.send("404 Error");
-});
-```
-
-4. Use `listen` on a port of your choosing.
-
-```js
-listen(3000);
-```
-
-Below is an example of a simple backend. This example will setup Chemical and serve the "public" folder along with the `index.html` file as `/` and `.html` files without the extension.
-
-
-```js
-import { ChemicalServer } from "chemicaljs";
-import express from "express";
-
-const [app, listen] = new ChemicalServer();
-const port = process.env.PORT || 3000;
-
-app.use(express.static("public", {
-    index: "index.html",
-    extensions: ["html"]
-}));
-
-app.serveChemical();
-
-app.use((req, res) => {
-    res.status(404);
-    res.send("404 Error");
-});
-
-listen(port, () => {
-    console.log(`Chemical demo listening on port ${port}`);
-});
-```
-
-### Build
-
-Want to use Chemical without using a custom wisp and/or rammerhead server or without a server at all?
-
-Using the build command you can clone all needed assets into your build folder (like BareMux, Libcurl, and proxies enabled). Note that UV and Scramjet will need an external wisp server to function if you do not provide your own and Rammerhead will not work without your own Rammerhead server running.
-
-1. Import `ChemicalBuild` and create a new build.
-
-```js
-const build = new ChemicalBuild({
-    path: "dist",
-    default: "uv",
-    uv: true,
-    scramjet: true,
-    rammerhead: false,
-});
-```
-
-2. Use `build.write()` to write into the build path.
-
-3. Use `build.write(true)` to first empty the build path.
-
-Below if a full example of building Chemical.
-
-```js
-const build = new ChemicalBuild({
-    path: "dist",
-    default: "uv",
-    uv: true,
-    scramjet: true,
-    rammerhead: false,
-});
-
-await build.write(true);
-```
-
-### Client
-
-In your project create a folder to store your static assets. Create an index.html file which will be the homepage of your website.
-
-1. Add the Chemical script to the top of your page. This will load all needed scripts for Chemical and other packages.
-
-```html
-<script src="/chemical.js"></script>
-```
-
-If you want to set the wisp server to an external server just change the `wisp` attribute.
-
-```html
-<script data-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 data-transport="epoxy" src="/chemical.js"></script>
-```
-
-2. In a inline script or javascript file, encode a URL with Chemical using the async function `chemical.encode`.
-
-```js
-await chemical.encode("https://example.com")
-```
-
-Optional: Change service to `uv`, `scramjet`, or `rammerhead`. Defaults to `uv` or server option.
-
-```js
-await chemical.encode("https://example.com", {
-    service: "rammerhead"
-})
-```
-
-3. To decode a URL use `chemical.decode`
-
-```js
-const encodedURL = await chemical.encode("https://example.com")
-const decodedURL = await chemical.decode(encodedURL)
-```
-
-4. Set `autoHttps` to make `example.com` > `https://example.com`
-
-```js
-await chemical.encode("example.com", {
-    autoHttps: true
-})
-```
-
-5. Use a search engine with the `searchEngine` property. Use a search engine URL with "%s" in place of query.
-
-```js
-await chemical.encode("cheese", {
-    searchEngine: "https://www.google.com/search?q=%s"
-})
-```
-
-6. You may want to check if Chemical has loaded before encoding a URL.
-
-```js
-if (window.chemical.loaded) {
-    //Chemical is loaded
-}
-```
-
-```js
-window.addEventListener("chemicalLoaded", function(e) {
-    //Chemical has loaded
-});
-```
-
-7. Change the transport with `chemical.setTransport`
-
-```js
-await chemical.setTransport("libcurl") //libcurl or epoxy
-```
-
-8. Change the Wisp URL with `chemical.setWisp`
-
-```js
-await chemical.setWisp("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
-<h1>Chemical Example</h1>
-<input id="search" placeholder="Enter URL">
-
-<script src="/chemical.js"></script>
-<script>
-    const search = document.getElementById("search");
-
-    search.addEventListener("keydown", async function (e) {
-        if (e.key == "Enter" && chemical.loaded && e.target.value) {
-            window.location = await chemical.encode(e.target.value)
-        }
-    })
-</script>
-```
-
-9. Fetch websites through Wisp using `chemical.fetch`. This works the same as the fetch API.
-
-10. Get search suggestions via DuckDuckGo using `chemical.getSuggestions`
-
-```js
-await chemical.getSuggestions("google")
-```
-
-## Vite Plugin
-
-1. Create a new vite app and open `vite.config.js` or `vite.config.ts`
-
-2. Import `ChemicalVitePlugin` and add it to plugins.
-
-```js
-import { defineConfig } from "vite"
-import { ChemicalVitePlugin } from "chemicaljs"
-
-export default defineConfig({
-    plugins: [/*Other plugins*/ChemicalVitePlugin()],
-})
-```
-
-You can pass options to just like on the main server.
-
-```js
-export default defineConfig({
-    plugins: [
-        ChemicalVitePlugin({
-            default: "rammerhead",
-            uv: true,
-            scramjet: false,
-            rammerhead: true,
-            hostname_blacklist: [ /google\.com/, /reddit\.com/ ],
-            hostname_whitelist: [ /example\.com/ ]
-        })
-    ],
-})
-```
-
-## Components
-Setup a proxy site with easy HTML components.
-
-1. Add the Chemical components along with the main script to the top of your page.
-
-```html
-<script src="/chemical.js"></script>
-<script src="/chemical.components.js"></script>
-```
-
-2. Now add any component to your site!
-
-### Link
-
-An anchor link but it automatically encodes the URL.
-
-```html
-<a data-href="https://example.com" is="chemical-link">Link</a>
-```
-
-You can also add `data-service="uv"`, `data-autoHttps`, and `data-search-engine="https://www.google.com/search?q=%s"`
-
-You can style the link as chemical is loading.
-
-```css
-a[data-chemical-loading="true"] {
-    cursor: wait;
-}
-```
-
-### Basic Input
-
-Opens in the current tab when the enter key is pressed.
-
-```html
-<input data-target="_self" placeholder="Enter URL" is="chemical-input">
-```
-
-You can also add `data-service="uv"`, `data-autoHttps`, and `data-search-engine="https://www.google.com/search?q=%s"`
-
-Opens in current tab when the enter key is pressed.
-
-```html
-<input data-target="_blank" placeholder="Enter URL" is="chemical-input">
-```
-
-Custom action when the enter key is pressed. Change `data-action` to your function name. The first parameter of the action will be the encoded URL.
-
-```html
-<input data-action="logURL" placeholder="Enter URL" is="chemical-input">
-<script>
-    function logURL(url) {
-        console.log(url)
-    }
-</script>
-```
-
-### Input with Button
-
-Opens when the enter key is pressed or button is clicked. Set the `for` attribute to the `id` of the button.
-
-```html
-<input id="my-input" data-target="_blank" placeholder="Enter URL" is="chemical-input">
-<button data-for="my-input" is="chemical-button">Go!</button>
-```
-
-### With iframe
-
-A hidden iframe that is shown when the enter key is pressed. Set the `frame` attribute to the `id` of the iframe.
-
-```html
-<input data-frame="my-iframe" placeholder="Enter URL" is="chemical-input">
-<iframe id="my-iframe" is="chemical-iframe"></iframe>
-```
-
-A hidden iframe that is shown when the enter key is pressed. Includes controls the are hidden when the iframe is hidden and can control websites in the iframe as well as hiding the iframe and controls.
-
-Set the `frame` attribute to the `id` of the iframe.
-Set the `controls` attribute to the `id` of the controls.
-
-Set the second parameter of `chemicalAction` to the `id` of the iframe.
-
-```html
-<input data-frame="my-iframe-2" placeholder="Enter URL" is="chemical-input">
-<section id="my-controls-2" is="chemical-controls">
-    <button onclick="chemicalAction('back', 'my-iframe-2')">←</button>
-    <button onclick="chemicalAction('forward', 'my-iframe-2')">→</button>
-    <button onclick="chemicalAction('reload', 'my-iframe-2')">⟳</button>
-    <button onclick="chemicalAction('close', 'my-iframe-2')">🗙</button>
-</section>
-<iframe data-controls="my-controls-2" id="my-iframe-2" is="chemical-iframe"></iframe>
-```
+## Docs
+You can find documentation for Chemical on our website [https://chemicaljs.github.io](chemicaljs.github.io).
 
 ## License
 Chemical uses the AGPL 3.0 license.

package/index.js

@@ -296,6 +296,8 @@ class ChemicalBuild {
         chemicalMain = "const scramjetEnabled = " + String(this.options.scramjet) + ";\n" + chemicalMain
         chemicalMain = "const rammerheadEnabled = " + String(this.options.rammerhead) + ";\n" + chemicalMain
 
+        chemicalMain = "(async () => {\n" + chemicalMain + "\n})();";
+
         writeFileSync(resolve(this.options.path, "chemical.js"), chemicalMain);
 
         let chemicalSW = await readFileSync(resolve(__dirname, "client/chemical.sw.js"), "utf8");

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "chemicaljs",
-    "version": "1.7.3",
+    "version": "1.7.4",
     "description": "Easily create your own web proxy with no experience required.",
     "repository": {
         "type": "git",

package/examples/example/README.md

@@ -1,3 +0,0 @@
-# Chemical Example
-
-Run `npm install` to install dependencies and then `npm start` to start.

package/examples/example/index.js

@@ -1,21 +0,0 @@
-import { ChemicalServer } from "chemicaljs";
-import express from "express";
-
-const [app, listen] = new ChemicalServer();
-const port = process.env.PORT || 3000;
-
-app.use(express.static("public", {
-    index: "index.html",
-    extensions: ["html"]
-}));
-
-app.serveChemical();
-
-app.use((req, res) => {
-    res.status(404);
-    res.send("404 Error");
-});
-
-listen(port, () => {
-    console.log(`Chemical example listening on port ${port}`);
-});