npm - @caboodle-tech/node-simple-server - Versions diffs - 1.3.1 → 2.0.0 - Mend

@caboodle-tech/node-simple-server 1.3.1 → 2.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (40) hide show

package/.eslintrc.json +35 -23
package/COPYING.txt +7 -0
package/LICENSE.txt +22 -0
package/README.md +73 -40
package/bin/nss.js +1039 -0
package/changelogs/v1.md +7 -0
package/changelogs/v2.md +28 -0
package/examples/README.md +15 -0
package/examples/controllers/website.js +60 -0
package/examples/controllers/websocket.js +83 -0
package/examples/run.js +17 -0
package/examples/www-website/assets/fonts/roboto/LICENSE.txt +202 -0
package/examples/www-website/assets/fonts/roboto/roboto-regular.ttf +0 -0
package/examples/www-website/assets/fonts/roboto/roboto-regular.woff +0 -0
package/examples/www-website/assets/fonts/roboto/roboto-regular.woff2 +0 -0
package/examples/www-website/assets/imgs/logo.png +0 -0
package/examples/www-website/css/main.css +96 -0
package/examples/www-website/css/normalize.css +349 -0
package/examples/www-website/index.html +47 -0
package/examples/www-website/js/main.js +33 -0
package/examples/www-websockets/assets/fonts/roboto/LICENSE.txt +202 -0
package/examples/www-websockets/assets/fonts/roboto/roboto-regular.ttf +0 -0
package/examples/www-websockets/assets/fonts/roboto/roboto-regular.woff +0 -0
package/examples/www-websockets/assets/fonts/roboto/roboto-regular.woff2 +0 -0
package/examples/www-websockets/assets/imgs/logo.png +0 -0
package/examples/www-websockets/css/main.css +148 -0
package/examples/www-websockets/css/normalize.css +349 -0
package/examples/www-websockets/index.html +45 -0
package/examples/www-websockets/js/main.js +63 -0
package/{sources → handlers}/dir-listing.html +68 -5
package/handlers/forbidden.html +43 -0
package/{js → handlers/js}/content-types.js +3 -1
package/{js → handlers/js}/http-status.js +2 -1
package/handlers/live-reloading.html +209 -0
package/handlers/not-found.html +43 -0
package/package.json +13 -10
package/LICENSE +0 -21
package/server.js +0 -866
package/sources/socket.html +0 -204
/package/{sources → handlers}/favicon.ico +0 -0

package/{sources → handlers}/dir-listing.html RENAMED Viewed

@@ -10,9 +10,19 @@
             body {
                 margin: 0;
                 padding: 0;
+                height: 100%;
+                overflow: hidden;
             }
             body {
+                display: grid;
+                grid-template-areas:
+                    "listing"
+                    "content"
+                    "footer";
+                grid-template-columns: 1fr ;
+                grid-template-rows: auto 1fr auto;
                 padding: 15px;
+                overflow-y: auto;
             }
             a {
                 color: #008fcc;
@@ -23,6 +33,20 @@
                 display: flex;
                 flex-direction: column;
             }
+            .row.listing {
+                grid-area: listing;
+            }
+            .row.content {
+                grid-area: content;
+            }
+            .row.footer {
+                grid-area: footer;
+            }
+            .row.footer .col {
+                display: flex;
+                flex-direction: column;
+                justify-content: end;
+            }
             .row .col {
                 flex: 1;
                 margin-bottom: 15px;
@@ -49,6 +73,8 @@
             @media (min-width: 768px) {
                 .row {
                     flex-direction: row;
+                    flex-basis: 100%;
+                    height: auto;
                 }
                 .row .col:nth-of-type(odd) {
                     margin-right: 10px;
@@ -60,19 +86,24 @@
         </style>
     </head>
     <body>
-        <div class="row">
+        <div class="row listing">
             <div class="col">
-                <h1>Listing ${path}</h1>
+                <h1>
+                    Listing
+                    <script type="text/javascript">
+                        document.write(document.location.pathname);
+                    </script>
+                </h1>
             </div>
         </div>
-        <div class="row">
+        <div class="row content">
             <div class="col">
                 <svg class="icon" width="24" height="24" xmlns="http://www.w3.org/2000/svg" fill-rule="evenodd" clip-rule="evenodd">
                     <path d="M22 24h-20v-24h14l6 6v18zm-7-23h-12v22h18v-16h-6v-6zm3 15v1h-12v-1h12zm0-3v1h-12v-1h12zm0-3v1h-12v-1h12zm-2-4h4.586l-4.586-4.586v4.586z" />
                 </svg>
                 <span class="title">Files</span>
                 <ul>
-                    ${files}
+                    {{files}}
                 </ul>
             </div>
             <div class="col">
@@ -81,9 +112,41 @@
                 </svg>
                 <span class="title">Directories</span>
                 <ul>
-                    ${directories}
+                    {{directories}}
                 </ul>
             </div>
         </div>
+        <div class="row footer">
+            <div class="col">
+                <p>
+                    <i>
+                        Node Simple Server (NSS) {{version}} Server
+                        <script type="text/javascript">
+                            document.write(`${document.location.protocol}//${document.location.hostname}`);
+                        </script>
+                        Port
+                        <script type="text/javascript">
+                            document.write(document.location.port);
+                        </script>
+                    </i>
+                </p>
+            </div>
+        </div>
+        <script>
+            (function fixLinks() {
+                let base = document.location.href;
+                if (base[base.length - 1] == '/') {
+                    base = base.substring(0, base.length - 1);
+                }
+                const links  = document.querySelectorAll('a');
+                links.forEach((link) => {
+                    const href = link.getAttribute('href');
+                    if (href.slice(0, 3) === '[b]') {
+                        link.href = `${base + href.substring(3)}`;
+                    }
+                });
+            })();
+        </script>
+        {{live_reload}}
     </body>
 </html>

package/handlers/forbidden.html ADDED Viewed

@@ -0,0 +1,43 @@
+<!DOCTYPE html>
+<html>
+    <head>
+        <!-- This is NSS's forbidden page. -->
+        <meta charset="UTF-8" />
+        <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+        <title>403 Forbidden</title>
+        <style>
+            html,
+            body {
+                margin: 0;
+                padding: 0;
+            }
+            body {
+                padding: 15px;
+            }
+        </style>
+    </head>
+    <body>
+        <h1>403 Forbidden</h1>
+        <p>
+            You don't have permission to access
+            <script type="text/javascript">
+                document.write(document.location.pathname);
+            </script>
+            on this server.
+        </p>
+        <hr>
+        <p>
+            <i>
+                Node Simple Server (NSS) {{version}} Server
+                <script type="text/javascript">
+                    document.write(`${document.location.protocol}//${document.location.hostname}`);
+                </script>
+                port
+                <script type="text/javascript">
+                    document.write(document.location.port);
+                </script>
+            </i>
+        </p>
+        {{live_reload}}
+    </body>
+</html>

package/{js → handlers/js}/content-types.js RENAMED Viewed

@@ -4,6 +4,7 @@
  * what content its serving, its up to the browser to do the rest of the work.
  */
 const contentTypes = {
+    '': 'application/octet-stream',
     '.aac': 'audio/aac',
     '.avi': 'video/x-msvideo',
     '.bmp': 'image/bmp',
@@ -15,6 +16,7 @@ const contentTypes = {
     '.epub': 'application/epub+zip',
     '.gif': 'image/gif',
     '.gz': 'application/gzip',
+    '.htm': 'text/html',
     '.html': 'text/html',
     '.ico': 'image/x-icon',
     '.jpeg': 'image/jpeg',
@@ -60,4 +62,4 @@ const contentTypes = {
     '.zip': 'application/zip'
 };
-module.exports = contentTypes;
+export default contentTypes;

package/{js → handlers/js}/http-status.js RENAMED Viewed

@@ -4,10 +4,11 @@
 const HTTPStatus = {
     continue: 100,
     ok: 200,
+    noContent: 204,
     found: 302,
     forbidden: 403,
     notFound: 404,
     error: 500
 };
-module.exports = HTTPStatus;
+export default HTTPStatus;

package/handlers/live-reloading.html ADDED Viewed

@@ -0,0 +1,209 @@
+<!-- Code injected by Node Simple Server for live reloading. -->
+<style>
+    #NSS_WS{display:flex;justify-content:center;align-items:center;position:fixed;right:15px;bottom:15px;z-index:9000;width:80px;height:45px;border-radius:25px;background:#000}#NSS_WS svg{margin-left:5px;fill:#ffffff}#NSS_WS span{display:inline-block;margin-right:5px;font-family:monospace;font-size:22px;color:#fff}
+</style>
+<script type="text/javascript">
+    // <![CDATA[
+    if ("WebSocket" in window) {
+        NSS_WS = (() => {
+            /** Handles showing the user the server disconnected and attempts to reconnect */
+            const disconnected = () => {
+                const icon = '<svg width="24" height="24" xmlns="http://www.w3.org/2000/svg" fill-rule="evenodd" clip-rule="evenodd"><path d="M6.817 5.084l-2.057-2.937 1.639-1.147 14.601 20.853-1.638 1.147-1.401-2h-12.461c-3.037 0-5.5-2.463-5.5-5.5 0-2.702 1.951-4.945 4.521-5.408.105-1.965.965-3.73 2.296-5.008zm3.032-1.771c.681-.204 1.403-.313 2.151-.313 4.006 0 7.267 3.141 7.479 7.092 2.57.463 4.521 2.706 4.521 5.408 0 1.898-.962 3.571-2.424 4.56l-1.149-1.64c.947-.627 1.573-1.702 1.573-2.92 0-2.969-2.688-3.766-4.433-3.72.324-3.983-2.114-6.78-5.567-6.78-.317 0-.624.023-.922.068l-1.229-1.755zm-4.349 15.687h11.061l-8.595-12.274c-1.038 1.169-1.618 2.895-1.533 5.054-1.954-.113-4.433.923-4.433 3.72 0 1.93 1.57 3.5 3.5 3.5z"></path></svg>';
+                // Create the icon container.
+                let div = document.createElement("DIV");
+                div.id = "NSS_WS";
+                div.innerHTML = '<span id="NSS_WS_RETRY">02</span>' + icon;
+                // Add the container to the page.
+                if (document.body.firstChild) {
+                    document.body.insertBefore(div, document.body.firstChild);
+                } else {
+                    document.body.appendChild(div);
+                }
+                // Keep updating the reconnect timer.
+                counterInterval = setInterval(function () {
+                    var counter = document.getElementById("NSS_WS_RETRY");
+                    var seconds = parseInt(counter.innerHTML) - 1;
+                    if (seconds <= 0) {
+                        seconds = 3000 * restartAttempts * 0.001;
+                    }
+                    if (seconds < 10) {
+                        seconds = `0${seconds}`;
+                    }
+                    counter.innerHTML = seconds;
+                }, 1000);
+            };
+            /** Expose the random page ID that was assigned to this page. */
+            const getId = () => {
+                return pageId;
+            };
+            /** Reload the pages stylesheets. */
+            const refreshCSS = () => {
+                const sheets = [].slice.call(document.getElementsByTagName("link"));
+                const head = document.getElementsByTagName("head")[0];
+                for (let i = 0; i < sheets.length; i++) {
+                    const elem = sheets[i];
+                    const parent = elem.parentElement || head;
+                    parent.removeChild(elem);
+                    const rel = elem.rel;
+                    if ((elem.href && typeof rel != "string") || rel.length == 0 || rel.toLowerCase() == "stylesheet") {
+                        const url = elem.href.replace(/(&|\?)_cacheOverride=\d+/, "");
+                        let newUrl = url + (url.indexOf("?") >= 0 ? "&" : "?");
+                        newUrl += "_cacheOverride=" + new Date().valueOf();
+                        elem.href = newUrl;
+                    }
+                    parent.appendChild(elem);
+                }
+            };
+            /** Register a function or functions to call when this page receives a WebSocket message. */
+            const registerCallback = (func) => {
+                if (whatIs(func) === "function") {
+                    callbacks.push(func);
+                }
+            };
+            /** Attempt to reestablish a connection to the WebSocket server; used with disconnected(). */
+            const restart = () => {
+                const http = new XMLHttpRequest();
+                http.onerror = function (e) {
+                    // Ignore the error in browsers that respect that.
+                };
+                // Attempt a reconnect.
+                http.onreadystatechange = () => {
+                    if (http.readyState === 4) {
+                        if (http.status >= 200 && http.status < 400) {
+                            window.location.reload();
+                        }
+                    }
+                };
+                http.open("GET", window.location.href);
+                http.send();
+                // Keep attempting to reconnect unless told not to.
+                if (autoRestart) {
+                    if (restartAttempts < 10) {
+                        restartAttempts += 1;
+                    }
+                    clearInterval(restartInterval);
+                    restartInterval = setInterval(restart, 3000 * restartAttempts);
+                }
+            };
+            /** Send a WebSocket message to the WebSocket server. */
+            const send = (message) => {
+                if (ready && socket.readyState === WebSocket.OPEN) {
+                    socket.send(JSON.stringify({
+                        data: message,
+                        type: whatIs(message)
+                    }));
+                    return;
+                }
+                console.warn("Node Simple Server: The WebSocket is not ready or the connection was closed.");
+            };
+            /** Generate a random unique ID for this page; will be registered in the back-end. */
+            const uid = () => {
+                return Math.random().toString(16).slice(2);
+            };
+            /** Remove a callback function previously registered with registerCallback(). */
+            const unregisterCallback = (func) => {
+                for (let i = 0; i < callbacks.length; i++) {
+                    if (callbacks[i] == func) {
+                        callbacks.splice(i, 1);
+                    }
+                }
+            };
+            /**
+             * The fastest way to get the actual type of anything in JavaScript.
+             *
+             * {@link https://jsbench.me/ruks9jljcu/2 | See benchmarks}.
+             *
+             * @param {*} unknown Anything you wish to check the type of.
+             * @return {string|undefined} The type in lowercase of the unknown value passed in or undefined.
+             */
+            const whatIs = (unknown) => {
+                try {
+                    return ({}).toString.call(unknown).match(/\s([^\]]+)/)[1].toLowerCase();
+                } catch (e) { return undefined; }
+            };
+            // NSS_WS internal global variables.
+            let autoRestart = true;
+            const callbacks = [];
+            let counterInterval = null;
+            const pageId = uid();
+            let ready = false;
+            let restartAttempts = 0;
+            let restartInterval = null;
+            // Socket specific variables.
+            const protocol = window.location.protocol === "http:" ? "ws://" : "wss://";
+            const address = protocol + window.location.host + window.location.pathname + "/ws?id=" + pageId;
+            const socket = new WebSocket(address);
+            // Respond to messages the socket receives.
+            socket.onmessage = (evt) => {
+                const msgObj = JSON.parse(evt.data); // NSS uses a standard messaging object.
+                switch (msgObj.message) {
+                    case "close":
+                        ready = false;
+                        break;
+                    case "disableAutoRestart":
+                        autoRestart = false;
+                        clearInterval(restartInterval);
+                        clearInterval(counterInterval);
+                        console.log("Node Simple Server: Auto restart disabled, manually refresh page if server disconnects.");
+                        break;
+                    case 'ping':
+                        send('pong');
+                        break;
+                    case "refreshCSS":
+                        refreshCSS();
+                        break;
+                    case "reload":
+                        window.location.reload();
+                        break;
+                    default:
+                        if (callbacks.length > 0) {
+                            for (let i = 0; i < callbacks.length; i++) {
+                                callbacks[i](msgObj);
+                            }
+                            return;
+                        }
+                        console.log(`Received from WebSocket: ${msgObj.data}`);
+                }
+            };
+            // Mark the script as not ready when the websocket connection is closed.
+            socket.addEventListener("close", () => {
+                ready = false;
+                console.warn("Node Simple Server: Connection closed, live reload disabled.");
+                if (autoRestart) {
+                    disconnected();
+                    restartInterval = setInterval(restart, 3000);
+                }
+            });
+            // Mark the script as ready when a websocket connection is established.
+            socket.addEventListener("open", () => {
+                console.log("Node Simple Server: Live reload enabled.");
+                ready = true;
+            });
+            // Expose some of NSS_WS methods.
+            return {
+                getId,
+                registerCallback,
+                send,
+                unregisterCallback,
+                whatIs
+            };
+        })();
+    } else {
+        console.error("Node Simple Server: This Browser does NOT support WebSocket for live reloading.");
+    }
+    // ]]>
+</script>

package/handlers/not-found.html ADDED Viewed

@@ -0,0 +1,43 @@
+<!DOCTYPE html>
+<html>
+    <head>
+        <!-- This is NSS's 404 page. -->
+        <meta charset="UTF-8" />
+        <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+        <title>404 Not Found</title>
+        <style>
+            html,
+            body {
+                margin: 0;
+                padding: 0;
+            }
+            body {
+                padding: 15px;
+            }
+        </style>
+    </head>
+    <body>
+        <h1>404 Not Found</h1>
+        <p>
+            The requested URL
+            <script type="text/javascript">
+                document.write(document.location.pathname);
+            </script>
+            was not found on this server.
+        </p>
+        <hr>
+        <p>
+            <i>
+                Node Simple Server (NSS) {{version}} Server
+                <script type="text/javascript">
+                    document.write(`${document.location.protocol}//${document.location.hostname}`);
+                </script>
+                Port
+                <script type="text/javascript">
+                    document.write(document.location.port);
+                </script>
+            </i>
+        </p>
+        {{live_reload}}
+    </body>
+</html>

package/package.json CHANGED Viewed

@@ -1,12 +1,15 @@
 {
     "name": "@caboodle-tech/node-simple-server",
-    "version": "1.3.1",
-    "description": "Node Simple Server (NSS): A small but effective node based server for development sites and self controlled live reloading.",
-    "main": "server.js",
+    "version": "2.0.0",
+    "description": "Node Simple Server (NSS): A small but effective node based server for development sites, customizable live reloading, and websocket support built-in.",
+    "main": "bin/nss.js",
     "scripts": {
         "test": "echo \"Error: no test specified\" && exit 1",
-        "start": "node server.js"
+        "example": "node ./examples/run.js",
+        "example:website": "node ./examples/run.js website",
+        "example:websocket": "node ./examples/run.js websocket"
     },
+    "type": "module",
     "repository": {
         "type": "git",
         "url": "git+https://github.com/caboodle-tech/node-simple-server.git"
@@ -25,18 +28,18 @@
     "contributors": [
         "Caboodle Tech Inc (https://github.com/caboodle-tech)"
     ],
-    "license": "MIT",
+    "license": "Common Clause with MIT",
     "bugs": {
         "url": "https://github.com/caboodle-tech/node-simple-server/issues"
     },
     "homepage": "https://github.com/caboodle-tech/node-simple-server#readme",
     "dependencies": {
-        "chokidar": "^3.5.2",
-        "ws": "^8.2.3"
+        "chokidar": "^3.5.3",
+        "ws": "^8.13.0"
     },
     "devDependencies": {
-        "eslint": "^7.32.0",
-        "eslint-config-airbnb-base": "^14.2.1",
+        "eslint": "^8.2.0",
+        "eslint-config-airbnb-base": "^15.0.0",
         "eslint-plugin-import": "^2.25.2"
     }
-}
+}

package/LICENSE DELETED Viewed

@@ -1,21 +0,0 @@
-MIT License
-Copyright (c) 2021 Caboodle Tech Inc
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.