@caboodle-tech/node-simple-server 2.0.1 → 3.0.1

package/README.md

@@ -4,7 +4,7 @@ A small but effective node based server for development sites, customizable live
 
 :heavy_check_mark:  You want to add live reloading to the development process of a static site.
 
-:heavy_check_mark:  You want easy two-way communication from the back-end and front-end of your development site with built-in WebSockets ready for use.
+:heavy_check_mark:  You want easy two-way communication from the back-end and front-end of your development site or web based application with built-in WebSockets ready for use.
 
 :heavy_check_mark:  You want more fine grained control over the whole live reloading process.
 
@@ -12,6 +12,8 @@ A small but effective node based server for development sites, customizable live
 
 :heavy_check_mark:  You want to easily setup a LAN application for educational purposes or other development; must be on the same LAN, please consider security implications.
 
+:heavy_check_mark:  You want to easily setup a web based application that leverages the browser as your apps GUI but can interact with system data via websocket; great for internal applications.
+
 ## Installation
 
 ### Manually:
@@ -50,17 +52,21 @@ NSS is designed to be controlled and/or wrapped by another application. The bare
 
 ```javascript
 /**
- * Import NSS. Here it is being imported from a manual install.
+ * If you want/need to import NSS from a manual install replace the below import statement with:
+ * 
+ * import NodeSimpleServer from './nss.js';
+ * 
  * NOTE: Manual installs must include the handlers directory one directory higher than NSS.
  */
-import NodeSimpleServer from './nss.js';
+import NodeSimpleServer from '@caboodle-tech/node-simple-server'
+import { fileURLToPath } from 'url';
 import path from 'path'
 
 // This is needed for ES modules.
 const __filename = fileURLToPath(import.meta.url);
 const __dirname = path.dirname(__filename);
 
-// Determine what directory to watch for changes.
+// Determine what directory to watch for changes; defaults to project root.
 const websiteRoot = __dirname;
 
 // Build a bare minimum server options object.
@@ -71,9 +77,6 @@ const serverOptions = {
 // Get a new instance of NSS.
 const Server = new NodeSimpleServer(serverOptions);
 
-// Start the server.
-Server.start();
-
 // A bare minimum callback to handle most development changes.
 function watcherCallback(event, path, extension) {
     if (extension === 'css') {
@@ -94,14 +97,30 @@ function watcherCallback(event, path, extension) {
     }
 }
 
-// Build a bare minimum watcher options object.
+// A bare minimum callback to handle all websocket messages from the frontend.
+function websocketCallback(messageObject, pageId) {
+    // Interpret and do what you need to with the message:
+    const datatype = messageObject.type
+    const data = messageObject.data;
+    console.log(`Received ${datatype} data from page ${pageId}: ${data}`)
+
+    // Respond to the page that sent the message if you like:
+    Server.message(pageId, 'Messaged received!');
+}
+
+Server.addWebsocketCallback('.*', websocketCallback);
+
+// A bare minimum watcher options object; use for development, omit for production.
 const watcherOptions = {
     events: {
         all: watcherCallback, // Just send everything to a single function.
     },
 };
 
-// Watch the current directory for changes.
+// Start the server.
+Server.start();
+
+// Watch the current directory for changes; use for development, omit for production.
 Server.watch(websiteRoot, watcherOptions);
 ```
 
@@ -129,10 +148,26 @@ const Server = new NodeSimpleServer(options);
 
 -   If a directory is requested should the directory listing page be shown.
 
+#### **disableAutoRestart**    default: false
+
+-   If the server shuts off or crashes do not attempt to auto reconnect to it.
+
+#### **hostAddress**    default: 127.0.0.1
+
+-   What IPv4 address or domain name to listen on.
+
+**NOTE:** This is an advanced setting and should rarely need to be altered.
+
 #### **indexPage**    default: index.html
 
 -   If a directory is requested consider this file to be the index page if it exits at that location.
 
+#### **liveReloading**    default: true
+
+-   Reload the frontend when changes occur on the backend; disable if using NSS in a *production* setting.
+
+**NOTE:** Even if you are not watching for any events this loads a full NSS developer websocket into all pages on the server address. Disabling this will load only a simplified NSS websocket.
+
 #### **port**    default: 5000
 
 -   The port number the HTTP and WebSocket server should listen on for requests.
@@ -273,7 +308,7 @@ With your new instance of NSS you can call any of the following public methods:
 
 ## Changelog
 
-The [current changelog is here](./changelogs/v2.md). All [other changelogs are here](./changelogs).
+The [current changelog is here](./changelogs/v3.md). All [other changelogs are here](./changelogs).
 
 ## Contributions
 

package/bin/nss.js

@@ -23,13 +23,16 @@ class NodeSimpleServer {
         callbacks: [],
         contentType: 'text/html',
         dirListing: false,
+        disableAutoRestart: false,
+        hostAddress: '127.0.0.1',
         indexPage: 'index.html',
+        liveReloading: true,
         port: 5000,
         root: Path.normalize(`${process.cwd()}${Path.sep}`),
         running: false
     };
 
-    #reload = ['.html', '.htm'];
+    #reload = ['.asp', '.html', '.htm', '.php', '.php3'];
 
     #server = null;
 
@@ -40,7 +43,7 @@ class NodeSimpleServer {
         map: {}
     };
 
-    #VERSION = '2.0.0';
+    #VERSION = '3.0.1';
 
     #watching = [];
 
@@ -60,14 +63,29 @@ class NodeSimpleServer {
      *                              servers root directory.
      */
     constructor(options = {}) {
-        if (options.disableAutoRestart) {
-            this.#OPS.disableAutoRestart = true;
-        }
         if (options.contentType) {
             this.#OPS.contentType = options.contentType;
         }
-        if (options.dirListing) {
-            this.#OPS.dirListing = options.dirListing;
+        if ('dirListing' in options) {
+            if (this.whatIs(options.dirListing) === 'boolean') {
+                this.#OPS.dirListing = options.dirListing;
+            }
+        }
+        if ('disableAutoRestart' in options) {
+            if (this.whatIs(options.disableAutoRestart) === 'boolean') {
+                this.#OPS.disableAutoRestart = options.disableAutoRestart;
+            }
+        }
+        if (options.hostAddress) {
+            this.#OPS.hostAddress = options.hostAddress;
+        }
+        if (options.index) {
+            this.#OPS.index = options.index;
+        }
+        if ('liveReloading' in options) {
+            if (this.whatIs(options.liveReloading) === 'boolean') {
+                this.#OPS.liveReloading = options.liveReloading;
+            }
         }
         if (options.port) {
             this.#OPS.port = options.port;
@@ -78,6 +96,8 @@ class NodeSimpleServer {
                 this.#OPS.root += Path.sep;
             }
         }
+
+        this.#OPS.hostAddress = `${this.#OPS.hostAddress}:${this.#OPS.port}`;
         this.#loadHandlers();
     }
 
@@ -308,9 +328,13 @@ class NodeSimpleServer {
 
         const dirListingSrc = Path.join(APP_ROOT, 'handlers', 'dir-listing.html');
         const forbiddenSrc = Path.join(APP_ROOT, 'handlers', 'forbidden.html');
-        const liveReloadingSrc = Path.join(APP_ROOT, 'handlers', 'live-reloading.html');
         const notFoundSrc = Path.join(APP_ROOT, 'handlers', 'not-found.html');
 
+        let liveReloadingSrc = Path.join(APP_ROOT, 'handlers', 'live-reloading.html');
+        if (!this.#OPS.liveReloading) {
+            liveReloadingSrc = Path.join(APP_ROOT, 'handlers', 'websocket-only.html');
+        }
+
         let dirListingContent = '';
         try {
             dirListingContent = Fs.readFileSync(dirListingSrc, { encoding: 'utf-8', flag: 'r' });
@@ -326,6 +350,8 @@ class NodeSimpleServer {
             liveReloadingContent = Fs.readFileSync(liveReloadingSrc, { encoding: 'utf-8', flag: 'r' });
         } catch (_) { liveReloadingContent = '<!-- 500 Internal Server Error -->'; }
 
+        liveReloadingContent = liveReloadingContent.replace('{{HOST_ADDRESS}}', this.#OPS.hostAddress);
+
         let notFoundContent = '';
         try {
             notFoundContent = Fs.readFileSync(notFoundSrc, { encoding: 'utf-8', flag: 'r' });
@@ -752,8 +778,15 @@ class NodeSimpleServer {
 
         // Handle future incoming WebSocket messages from this page.
         socket.on('message', (message) => {
-            // NSS messages have a standard format
+            // NSS messages have a standard format.
             const msgObj = JSON.parse(message.toString());
+            // If message is a ping send pong and stop.
+            if (msgObj.type === 'string') {
+                if (msgObj.message === 'ping') {
+                    this.message(pageId, 'pong');
+                    return;
+                }
+            }
             // See if the message belongs to a callback and send it there.
             for (let i = 0; i < this.#OPS.callbacks.length; i++) {
                 const regex = this.#OPS.callbacks[i][0];
@@ -820,6 +853,7 @@ class NodeSimpleServer {
         // Create the HTTP server.
         this.#server = Http.createServer(this.#serverListener.bind(this));
         // Capture connection upgrade requests so we don't break WebSocket connections.
+        // eslint-disable-next-line no-unused-vars
         this.#server.on('upgrade', (request, socket) => {
             /*
              * Node's http server is capable of handling websocket but you have to manually

package/changelogs/v3.md

@@ -0,0 +1,8 @@
+### NSS 3.0.1 (18 December 2023)
+
+- chore: Correct and update README. Several settings were undocumented and new ones have been added.
+- !feat: Corrected a bug where frontend websocket messages had the wrong object structure using `data` instead of `message`. Updated the websocket demo to show this correction.
+- feat: Added `websocket-only.html` which will load basic websocket communications into the page and nothing else when `liveReloading` is set to `false`.
+- !feat: Added the `hostAddress` option and modified `live-reloading.html` and `websocket-only.html` to work with this new option.
+
+BREAKING CHANGES: Technically still compatible with v2 but implementations have changed.

package/examples/controllers/prod-website.js

@@ -0,0 +1,62 @@
+import Path from 'path';
+import { fileURLToPath } from 'url';
+import Server from '../../bin/nss.js';
+
+// eslint-disable-next-line no-underscore-dangle
+const __filename = fileURLToPath(import.meta.url);
+// eslint-disable-next-line no-underscore-dangle
+const __dirname = Path.dirname(__filename);
+
+const WebsiteDemo = () => {
+    // Determine where the directory for the website demo is.
+    const websiteRoot = Path.normalize(Path.join(__dirname, '..', 'www-production'));
+
+    // Minimal server configuration.
+    const serverOptions = {
+        disableAutoRestart: true, // Production mode, do not visually show when the server disconnects.
+        liveReloading: false, // Production mode, load only the NSS websocket into pages.
+        dirListing: true,
+        root: websiteRoot
+    };
+
+    // Get a new server instance.
+    const server = new Server(serverOptions);
+
+    // Start the server.
+    server.start();
+
+    // A bare minimum callback to handle changes.
+    function callback(event, path, ext) {
+        console.log(event, path, ext);
+        if (ext === 'css') {
+            server.reloadAllStyles();
+            return;
+        }
+        if (ext === 'js') {
+            server.reloadAllPages();
+            return;
+        }
+        if (event === 'change') {
+            server.reloadSinglePage(path);
+        }
+    }
+
+    // Build a bare minimum watcher options object.
+    const watcherOptions = {
+        events: {
+            all: callback
+        },
+        ignoreInitial: true
+    };
+
+    /**
+     * Watch everything in the www-website directory for changes.
+     *
+     * NOTE: Watching for file changes is optional. If you build a local app or
+     * a monitoring app that only needs NSS's websocket you can safely skip
+     * setting up `watch`.
+     */
+    server.watch(websiteRoot, watcherOptions);
+};
+
+export default WebsiteDemo;

package/examples/controllers/websocket.js

@@ -65,7 +65,7 @@ const WebsocketDemo = () => {
             // We record reply counts by page so make sure we have a record for this page.
             if (!replyCount[pageId]) { replyCount[pageId] = 0; }
             // Display the users message in the servers (NSS's) terminal.
-            console.log(`[websocket:${pageId}] Message from frontend --> ${message.data}`);
+            console.log(`[websocket:${pageId}] Message from frontend --> ${message.message}`);
             // To demonstrate we can reply send a message back after a delay.
             setTimeout(() => {
                 replyCount[pageId] += 1;

package/examples/run.js

@@ -1,3 +1,4 @@
+import ProdWebsiteDemo from './controllers/prod-website.js';
 import WebsiteDemo from './controllers/website.js';
 import WebsocketDemo from './controllers/websocket.js';
 
@@ -8,6 +9,9 @@ if (process.argv.length > 2) {
 }
 
 switch (runDemo) {
+    case 'production':
+        ProdWebsiteDemo();
+        break;
     case 'websocket':
         WebsocketDemo();
         break;

package/examples/www-production/assets/fonts/roboto/LICENSE.txt

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/examples/www-production/css/main.css

@@ -0,0 +1,96 @@
+@font-face {
+    font-family: 'Roboto';
+    src: url('../assets/fonts/roboto/roboto-regular.woff2') format('woff2'),
+         url('../assets/fonts/roboto/roboto-regular.woff') format('woff'),
+         url('../assets/fonts/roboto/roboto-regular.ttf')  format('truetype')
+}
+
+:root {
+    --padding: 15px
+}
+
+html,
+body {
+    margin: 0;
+    padding: 0;
+    font-size: 62.5%;
+    font-family: 'Roboto', sans-serif;
+    height: 100%;
+    overflow: hidden;
+}
+
+body {
+    display: flex;
+    flex-direction: column;
+}
+
+a {
+    text-decoration: none;
+    color: #1170bd;
+    cursor: pointer;
+}
+
+.loader {
+    width: 100px;
+    height: 100px;
+    margin: 20px;
+    display:inline-block;
+}
+
+#page-container {
+    flex: 1;
+    display: flex;
+    flex-direction: column;
+    font-size: 1.5rem;
+    overflow-y: auto;
+}
+
+#page-container .content {
+    display: block;
+    max-width: 1200px;
+    margin: 0 auto;
+}
+
+#page-container .content p {
+    font-size: 1.85rem;
+    line-height: 2.30rem;
+}
+
+header {
+    text-align: center;
+    padding: var(--padding);
+}
+
+header .logo {
+    max-height: 80px;
+    width: auto;
+}
+
+main {
+    flex: 1;
+    padding: var(--padding);
+}
+
+main #fox-container {
+    display: flex;
+    flex-direction: column;
+    justify-content: center;
+    align-items: center;
+    min-height: 300px;
+    background-color: #e1e1e1;
+}
+
+main #fox-details {
+    text-align: center;
+}
+
+footer {
+    text-align: center;
+    font-size: 2rem;
+    padding: var(--padding);
+}
+
+footer .heart-icon {
+    fill: #f06464;
+    margin: 0 2px -5px 2px;
+}