chemicaljs 1.5.0 → 1.6.0

package/README.md

@@ -11,6 +11,9 @@ A example with all the components can be found in [`/example-components/`](https
 
 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.
@@ -73,6 +76,42 @@ chemical.server.listen(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.
@@ -250,5 +289,14 @@ Set the second parameter of `chemicalAction` to the `id` of the iframe.
 <iframe controls="my-controls-2" id="my-iframe-2" is="chemical-iframe"></iframe>
 ```
 
+## Future Additions
+
+- Link chemical component
+- Automatically add https:// if needed
+- Search engine option for search
+- Easy tab cloaking
+- Easy about:blank
+- Proxy switcher/searchengine switcher/cloak switcher
+
 ## License
 Chemical Uses the MIT license.

package/examples/example/package-lock.json

@@ -9,7 +9,7 @@
       "version": "1.0.0",
       "license": "MIT",
       "dependencies": {
-        "chemicaljs": "^1.4.9",
+        "chemicaljs": "^1.5.0",
         "express": "^4.19.2"
       }
     },
@@ -404,9 +404,9 @@
       "optional": true
     },
     "node_modules/@mercuryworkshop/bare-mux": {
-      "version": "2.0.2",
-      "resolved": "https://registry.npmjs.org/@mercuryworkshop/bare-mux/-/bare-mux-2.0.2.tgz",
-      "integrity": "sha512-1rnqFfI29VXi3jrMbkotHV+NnafJ3tpTIuH3Ov/BtVAfZMNGcsCRr3dwEKRWc+mDb0tWdNWC0PnZghgfAlbr+A=="
+      "version": "2.0.4",
+      "resolved": "https://registry.npmjs.org/@mercuryworkshop/bare-mux/-/bare-mux-2.0.4.tgz",
+      "integrity": "sha512-Y5jByKQ/5ZhyKd3adHUQ18nB+HOUpopxRXIJh6KHXEq4rkG2AazHyMm42dvtAxHvkKlHkLxR7/5oxKZSD6rE4A=="
     },
     "node_modules/@mercuryworkshop/epoxy-tls": {
       "version": "2.0.6-1",
@@ -426,12 +426,12 @@
       }
     },
     "node_modules/@mercuryworkshop/libcurl-transport": {
-      "version": "1.3.6",
-      "resolved": "https://registry.npmjs.org/@mercuryworkshop/libcurl-transport/-/libcurl-transport-1.3.6.tgz",
-      "integrity": "sha512-K4/TSfHlkjuzY6j0XXFmIbG8m3tpMoTxLga46fhmeuX8k3EJR/FVbW8JTXOD34Iofu0vCZuuY8n/ywNCcB6XjA==",
+      "version": "1.3.7",
+      "resolved": "https://registry.npmjs.org/@mercuryworkshop/libcurl-transport/-/libcurl-transport-1.3.7.tgz",
+      "integrity": "sha512-Ef2BpZRPzkWaCf6FDv63uYyocz96sIwbScI2GrU/Oiu5Etyyq5bOo0mA6sHh8KCwioFSulvh61lO2MbfaEzH9g==",
       "dependencies": {
         "esbuild-plugin-umd-wrapper": "^2.0.0",
-        "libcurl.js": "^0.6.10",
+        "libcurl.js": "^0.6.11",
         "rollup": "^4.12.0",
         "rollup-plugin-node-resolve": "^5.2.0",
         "rollup-plugin-typescript2": "^0.36.0"
@@ -713,9 +713,9 @@
       ]
     },
     "node_modules/@titaniumnetwork-dev/ultraviolet": {
-      "version": "3.2.4",
-      "resolved": "https://registry.npmjs.org/@titaniumnetwork-dev/ultraviolet/-/ultraviolet-3.2.4.tgz",
-      "integrity": "sha512-vdYVDtk5n0bGOpcDFIUDyW/Nmlu7y5QToomed2Ewo1R9HwO6ewy3eTctpNKZJF0vv0XfGPrTWsozBU3rLX07Ng=="
+      "version": "3.2.6",
+      "resolved": "https://registry.npmjs.org/@titaniumnetwork-dev/ultraviolet/-/ultraviolet-3.2.6.tgz",
+      "integrity": "sha512-kMyUdXBWKIOjO/0sGlj/uTNjNK2/3dn+gnhlBTs/CB3EPUPD+DAKnH99yYqBs0R+YE0Hjm54pCyBHY7ztq6iOQ=="
     },
     "node_modules/@tootallnate/once": {
       "version": "1.1.2",
@@ -1167,16 +1167,16 @@
       }
     },
     "node_modules/chemicaljs": {
-      "version": "1.4.9",
-      "resolved": "https://registry.npmjs.org/chemicaljs/-/chemicaljs-1.4.9.tgz",
-      "integrity": "sha512-1fTpJy+AE79XCM7MDrvwIeBSTozyGKkVexucETVWktVcWjbG7PSFS4UxD5W+R8fRE4qdb2Tzxsd/yQlJIUgj7g==",
+      "version": "1.5.0",
+      "resolved": "https://registry.npmjs.org/chemicaljs/-/chemicaljs-1.5.0.tgz",
+      "integrity": "sha512-kDNm1OZfKEVQgaUv2dANM75/9Eg3xKzkKQ1C7tZT745sHEMYmRhRP98uHpLpVsmtfvE0hULN1U97KifPuWDxTg==",
       "dependencies": {
-        "@mercuryworkshop/bare-mux": "^2.0.2",
+        "@mercuryworkshop/bare-mux": "^2.0.4",
         "@mercuryworkshop/epoxy-transport": "^2.1.3",
-        "@mercuryworkshop/libcurl-transport": "^1.3.6",
+        "@mercuryworkshop/libcurl-transport": "^1.3.7",
         "@mercuryworkshop/scramjet": "^1.0.2",
         "@mercuryworkshop/wisp-js": "^0.1.1",
-        "@titaniumnetwork-dev/ultraviolet": "^3.2.4",
+        "@titaniumnetwork-dev/ultraviolet": "^3.2.6",
         "express": "^4.19.2",
         "rammerhead": "https://github.com/chemicaljs/chemical/raw/main/rammerhead.tgz"
       }
@@ -2204,9 +2204,9 @@
       }
     },
     "node_modules/libcurl.js": {
-      "version": "0.6.10",
-      "resolved": "https://registry.npmjs.org/libcurl.js/-/libcurl.js-0.6.10.tgz",
-      "integrity": "sha512-GDyxCRi7+R7XFhcCRFAsNYxg3x91LiwiBISo+pWfUXfgO45J/9ZWcHqjKQg8/FbWHRkV1wwSCyPOZ8pLlbdivg=="
+      "version": "0.6.11",
+      "resolved": "https://registry.npmjs.org/libcurl.js/-/libcurl.js-0.6.11.tgz",
+      "integrity": "sha512-mCYCfjb5hnThNq0qzKPDUCRnHkDZENpCqGZ1flh4npu+zqWGun2/gsDmXCi+0J3TOsCDjmyMEt+W/eGNvqEHvQ=="
     },
     "node_modules/locate-path": {
       "version": "5.0.0",

package/examples/example/package.json

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

package/examples/example build/README.md

@@ -0,0 +1,5 @@
+# Chemical Example Build
+
+Run `npm install` to install dependencies and then `npm start` to start.
+
+Run `npm run build` to build chemical for static use.

package/examples/example build/build.js

@@ -0,0 +1,11 @@
+import { ChemicalBuild } from "chemicaljs";
+
+const build = new ChemicalBuild({
+    path: "dist",
+    default: "uv",
+    uv: true,
+    scramjet: true,
+    rammerhead: false,
+});
+
+await build.write(true);

package/examples/example build/index.js

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