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

package/changelogs/v1.md

@@ -1,3 +1,14 @@
+### NSS 1.3.2 (25 May 2023) (Unpublished)
+
+- Chore: Update projects eslint rules to better match Caboodle Tech's latest rules.
+- Chore: Update various packages.
+- Chore: Correct manual (main README) that incorrectly explained the Server's `root` method.
+- Started using [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) for project.
+
+### NSS 1.3.1 (11 Dec 2021)
+
+- Bug Fix: Added missing content-types (MIME types) for several standard and non-standard file types.
+
 ### NSS 1.3.0 (23 Nov 2021)
 
 - Bug Fix: Inject script and styles are now correctly added to HTML files only.

package/changelogs/v2.md

@@ -0,0 +1,28 @@
+### NSS 2.0.0 (May 2023 - Jun 2023)
+
+- chore: Bumped `nss.js` version number to `2.0.0` and insured it now displays in appropriate locations.
+- chore: Changed the license for v2 to Commons Clause License Condition v1.0 -> MIT.
+- chore: Started using Conventional Commits for NSS.
+- demo: Created various demos to showcase the new features of NSS.
+- change!: Renamed the `sources` directory to `handlers` and moved the `js` directory into it.
+- change!: Renamed the `registerCallback` method to `addWebsocketCallback`.
+- change!: Renamed the `unregisterCallback` method to `removeWebsocketCallback`.
+- fix: NSS favicon was not being served when the user does not have their own. We also hide the 404
+       if no favicon can be found.
+- fix: We correctly watch and respond to index pages now when they are omitted in the http request.
+- fix!: NSS now standardizes all watched paths to linux/unix style paths; no backslashes even on
+        windows. This should not affect users using NSS's helper methods but advanced users may
+        run into this gotcha.
+- feat!: Changed NSS from cjs to esm and modified several properties and various methods.
+    - `getHeaders` now takes an options object instead of string(s).
+- feat!: completely overhauled `serverListener` method and added helper methods:
+    - `showDirListing` to handle showing directory listing pages when enabled otherwise 403 or 404.
+    - `showForbidden` to handle resource access that is forbidden (not allowed or missing permissions) 403.
+    - `showNotFound` to handle pages that do not exists; 404 not found.
+- feat!: Improved the `message` method by adding a socket map allowing users to directly message a
+         socket based on its id.
+- feat!: Removed the `bin/cli.js` file that used to be the entry point for NSS. You should now import
+         `bin/nss.js` into your own projects and use the server with your own settings. See `examples`
+         for additional help.
+
+BREAKING CHANGES: Not compatible in the slightest with v1, see above details.

package/examples/README.md

@@ -0,0 +1,15 @@
+# Examples
+
+You will find several example use cases of NSS in this directory. The `run.js` file is responsible for launching the various demos and has been preconfigured to be called by `npm`:
+
+| command | purpose |
+|---|---|
+| npm run example | Runs the default NSS demo which is the same as running `npm run example:website` |
+| num run example:website | Demo using NSS for website development. |
+| num run example:websocket | Demo using the websocket features of NSS to communicate from a website to a server and vice-versa. |
+
+The `controllers` directory contains the scripts that control (run) the actual demos. You should review these files to get an idea of how to best implement NSS for your use case.
+
+Other directories like `www-website` and `www-websocket` hold the code for the live demo websites. You can start a demo and modify files in the demos directory to see the changes live.
+
+**NOTE:** Please do not modify any of the example files if you plan to contribute to NSS's codebase! These examples are meant for everyone's benefit and the only changes that will be accepted to this directory are the additions of examples that benefit NSS users as a whole.

package/examples/controllers/website.js

@@ -0,0 +1,60 @@
+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-website'));
+
+    // Minimal server configuration.
+    const serverOptions = {
+        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

@@ -0,0 +1,83 @@
+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 WebsocketDemo = () => {
+    // Determine where the directory for the website demo is.
+    const websiteRoot = Path.normalize(Path.join(__dirname, '..', 'www-websockets'));
+
+    // Minimal server configuration.
+    const serverOptions = {
+        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) {
+        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-socket 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);
+
+    // Keep a reply count so we can distinguish replies.
+    const replyCount = {};
+
+    // Build a simple websocket watcher (handler).
+    function websocketHandler(message, pageId) {
+        // Our demo only sends stings so ignore anything else.
+        if (message.type === 'string') {
+            // 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}`);
+            // To demonstrate we can reply send a message back after a delay.
+            setTimeout(() => {
+                replyCount[pageId] += 1;
+                server.message(pageId, `Reply ${replyCount[pageId]} from backend to page with id: ${pageId}`);
+            }, 2000);
+        }
+    }
+
+    // Register our websocket handler to respond to only index pages.
+    server.addWebsocketCallback('index.html', websocketHandler);
+
+    // NOTE: We could add as many callbacks as we like for different pages or patterns.
+};
+
+export default WebsocketDemo;

package/examples/run.js

@@ -0,0 +1,17 @@
+import WebsiteDemo from './controllers/website.js';
+import WebsocketDemo from './controllers/websocket.js';
+
+let runDemo = 'website';
+
+if (process.argv.length > 2) {
+    runDemo = process.argv[2];
+}
+
+switch (runDemo) {
+    case 'websocket':
+        WebsocketDemo();
+        break;
+    case 'website':
+    default:
+        WebsiteDemo();
+}

package/examples/www-website/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-website/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;
+}