notherbase-fs 3.1.5 → 3.1.7

package/README.md

@@ -1,4 +1,6 @@
 # notherbase-fs
-Functions to help one develope a base.
+A package to help one develop a base. 
 
-Visit www.notherbase.com/docs to for documentation on notherbase-fs and notherbase.
+A base is an Express.js server that will render EJS web pages with automatic route creation. It also has a spirit world, a MongoDB-connected API to provide those pages with dynamic data and multiplayer interaction. A little bit of socket.io is sprinkled for good measure.
+
+Visit www.notherbase.com/docs for documentation on notherbase-fs.

package/controllers/creation.js

@@ -1,20 +1,27 @@
 import express from "express";
 import fs from 'fs';
 
+/**
+ * Creation is all the renedered pages in a base.
+ */
 export default class Creation {
     constructor() {
         this.router = express.Router();
 
         //home
         this.router.get("/", function(req, res) { res.redirect("/the-front"); });
+
         //the-front
         this.router.get(`/the-front`, this.front, this.explore);
         this.router.get(`/the-front/:frontDetail`, this.frontDetail, this.explore);
+
         //pages
         this.router.get(`/:page`, this.page, this.explore);
+
         //explorer
         this.router.get(`/:region/:area/:poi`, this.lock, this.poi, this.explore);
         this.router.get(`/:region/:area/:poi/:detail`, this.lock, this.detail, this.explore);
+
         //void
         this.router.use(function(req, res) { 
             console.log(req.path);
@@ -22,11 +29,23 @@ export default class Creation {
         });
     }
 
+    /**
+     * This middleware requires a user to login to access affected routes.
+     * @param {Object} req An Express.js request.
+     * @param {Object} res An Express.js response.
+     * @param {Function} next next()
+     */
     lock = (req, res, next) => {
         req.lock = true;
         next();
     }
 
+    /**
+     * This route renders a page and sends it to the client.
+     * @param {Object} req An Express.js request.
+     * @param {Object} res An Express.js response.
+     * @param {Function} next next()
+     */
     explore = async (req, res, next) => {
         try {
             if (fs.existsSync(req.main + ".ejs")) {
@@ -57,10 +76,16 @@ export default class Creation {
         }
         catch(err) {
             console.log(err);
-            res.status(500).end();
+            res.status(500).send("Server Error");
         }
     }
 
+    /**
+     * This middleware directs exploration to the front.
+     * @param {Object} req An Express.js request.
+     * @param {Object} res An Express.js response.
+     * @param {Function} next next()
+     */
     front = async (req, res, next) => {
         req.main = req.contentPath + "/the-front/index";
         req.siteTitle = "NotherBase - The Front";
@@ -68,6 +93,12 @@ export default class Creation {
         next();
     }
 
+    /**
+     * This middleware directs exploration to a detail in the front.
+     * @param {Object} req An Express.js request.
+     * @param {Object} res An Express.js response.
+     * @param {Function} next next()
+     */
     frontDetail = async (req, res, next) => {
         req.main = `${req.contentPath}/the-front/${req.params.frontDetail}/index`;
         req.siteTitle = `NotherBase - ${req.params.frontDetail}`;
@@ -75,6 +106,12 @@ export default class Creation {
         next();
     }
 
+    /**
+     * This middleware directs exploration to a point of interest.
+     * @param {Object} req An Express.js request.
+     * @param {Object} res An Express.js response.
+     * @param {Function} next next()
+     */
     poi = async (req, res, next) => {
         req.main = `${req.contentPath}/${req.params.region}/${req.params.area}/${req.params.poi}/index`;
         req.siteTitle = `NotherBase - ${req.params.poi}`;
@@ -82,6 +119,12 @@ export default class Creation {
         next();
     }
 
+    /**
+     * This middleware directs exploration to a detail.
+     * @param {Object} req An Express.js request.
+     * @param {Object} res An Express.js response.
+     * @param {Function} next next()
+     */
     detail = async (req, res, next) => {
         req.main = `${req.contentPath}/${req.params.region}/${req.params.area}/${req.params.poi}/${req.params.detail}/index`;
         req.siteTitle = `NotherBase - ${req.params.detail}`;
@@ -89,6 +132,12 @@ export default class Creation {
         next();
     }
 
+    /**
+     * This middleware directs exploration to a one-off page.
+     * @param {Object} req An Express.js request.
+     * @param {Object} res An Express.js response.
+     * @param {Function} next next()
+     */
     page = async (req, res, next) => {
         req.main = `${req.contentPath}/pages/${req.params.page}/index`;
         req.siteTitle = `${req.params.page}`;

package/controllers/spirit-world.js

@@ -1,18 +1,41 @@
 import express from "express";
 import { stripHtml } from "string-strip-html";
-import { success, fail } from "./spirits/util.js";
-import User from "./spirits/user.js";
+import { success, fail } from "./util.js";
+import User from "./user.js";
 import fs from 'fs';
 
+/**
+* The spirit world is the API of a base.
+*/
 export default class SpiritWorld {
+    /**
+     * Sets up socket.io for instant messaging and etc.
+     * @param {*} socket 
+     */
     #setupChat = (socket) => {
         socket.join(socket.handshake.query.room);
+        if (this.rooms[socket.handshake.query.room]) this.rooms[socket.handshake.query.room].users.push(socket.handshake.query.name);
+        else {
+            this.rooms[socket.handshake.query.room] = {
+                users: [
+                    socket.handshake.query.name
+                ]
+            }
+        }
     
         this.io.to(socket.handshake.query.room).emit("chat message", {
             name: "Server",
             time: Date.now(),
             text: `${socket.handshake.query.name} has joined the room.`
         });
+
+        this.io.to(socket.handshake.query.room).emit("chat info", {
+            name: socket.handshake.query.room,
+            time: Date.now(),
+            data: {
+                users: this.rooms[socket.handshake.query.room].users
+            }
+        });
     
         socket.on("chat message", (msg) => {
             this.io.to(socket.handshake.query.room).emit("chat message", {
@@ -23,16 +46,34 @@ export default class SpiritWorld {
         });
     
         socket.on('disconnect', () => {
+            this.rooms[socket.handshake.query.room].users.splice(this.rooms[socket.handshake.query.room].users.indexOf(socket.handshake.query.name));
+
             this.io.to(socket.handshake.query.room).emit("chat message", {
                 name: "Server",
                 time: Date.now(),
                 text: `${socket.handshake.query.name} has left the room.`
             });
+
+            this.io.to(socket.handshake.query.room).emit("chat info", {
+                name: socket.handshake.query.room,
+                time: Date.now(),
+                data: {
+                    users: this.rooms[socket.handshake.query.room].users
+                }
+            });
+
+            if (this.rooms[socket.handshake.query.room].users.length < 1) delete this.rooms[socket.handshake.query.room];
         });
     }
 
+    /**
+     * Sets up the spirit world.
+     * @param {Server} io 
+     */
     constructor(io) {
         this.io = io;
+        this.rooms = {};
+
         this.router = express.Router();
         this.user = new User();
 
@@ -43,21 +84,35 @@ export default class SpiritWorld {
         this.io.on('connection', this.#setupChat);
     }
 
+    /**
+     * This API route requests a spirit from the database.
+     * @param {Object} req 
+     * @param {Object} res 
+     */
     load = async (req, res) => {
-        let parent = null;
-
-        if (req.body.scope === "local") {
-            let user = await req.db.User.recallOne(req.session.currentUser);
-            parent = user.id;
-        } 
+        try {
+            let parent = null;
 
-        let spirit = await req.db.Spirit.recallOne(req.body.service, parent);
+            if (req.body.scope === "local") {
+                let user = await req.db.User.recallOne(req.session.currentUser);
+                if (user?.id) parent = user.id;
+                else throw new Error("User had no id on load(): ", user);
+            } 
 
-        if (!spirit.memory.data) spirit.memory.data = {};
+            let spirit = await req.db.Spirit.recallOne(req.body.service, parent);
 
-        res.send(spirit.memory.data);
+            res.send(spirit.memory.data ? spirit.memory.data : {});
+        } catch (error) {
+            console.log(error);
+            fail(res, "Server error");
+        }
     }
 
+    /**
+     * This API route runs a script on the server. Responds with the result.
+     * @param {Object} req 
+     * @param {Object} res 
+     */
     serve = async (req, res) => {
         try {
             let scriptPath = `${req.contentPath}${req.body.route}/${req.body.script}.js`;

package/controllers/{spirits/user.js → user.js}

@@ -2,6 +2,9 @@ import express from "express";
 import bcrypt from "bcrypt";
 import { check, success, fail, loginCheck } from "./util.js";
 
+/**
+ * API routes for user functions.
+ */
 export default class User {
     constructor() {
         this.router = express.Router();
@@ -19,12 +22,22 @@ export default class User {
         this.router.post("/getInfo", this.getInfo);
     }
 
+    /**
+     * Logs the user out.
+     * @param {Object} req An Express.js request.
+     * @param {Object} res An Express.js response.
+     */
     logout = async (req, res) => {
         await req.session.destroy();
 
         success(res, "Logged out.");
     }
 
+    /**
+     * Sends an email with a password reset code.
+     * @param {Object} req An Express.js request.
+     * @param {Object} res An Express.js response.
+     */
     sendPasswordReset = async (req, res) => {
         let spirit = await req.db.User.recallOne(req.body.email);
 
@@ -44,6 +57,11 @@ export default class User {
         else fail(res, "User not found.");
     }
 
+    /**
+     * Change a user's password.
+     * @param {Object} req An Express.js request.
+     * @param {Object} res An Express.js response.
+     */
     changePassword = async (req, res) => {
         if (check(res, req.body.token, "No token provided!")){
             let spirit = await req.db.User.recallOne(req.body.email);
@@ -66,6 +84,11 @@ export default class User {
         }
     }
 
+    /**
+     * Register a new user account.
+     * @param {Object} req An Express.js request.
+     * @param {Object} res An Express.js response.
+     */
     register = async (req, res) => {
         if (check(res, req.body.password.length > 7, "Password too short.") &&
             check(res, req.body.email.length > 7, "Email too short.") &&
@@ -81,6 +104,11 @@ export default class User {
         }
     }
 
+    /**
+     * Logs a user in.
+     * @param {Object} req An Express.js request.
+     * @param {Object} res An Express.js response.
+     */
     login = async (req, res) => {
         let spirit = await req.db.User.recallOne(req.body.email);
 
@@ -95,6 +123,11 @@ export default class User {
         }
     }
 
+    /**
+     * Changes a user's email address on file.
+     * @param {Object} req An Express.js request.
+     * @param {Object} res An Express.js response.
+     */
     changeEmail = async (req, res) => {
         if (loginCheck(req, res)) {
             let spirit = await req.db.User.recallOne(req.body.email);
@@ -112,6 +145,11 @@ export default class User {
         }
     }
 
+    /**
+     * Changes a user's display name.
+     * @param {Object} req An Express.js request.
+     * @param {Object} res An Express.js response.
+     */
     changeUsername = async (req, res) => {
         if (loginCheck(req, res)) {
             let spirit = await req.db.User.recallOne(null, req.body.username);
@@ -127,6 +165,11 @@ export default class User {
         }
     }
 
+    /**
+     * Deletes a user account premanently.
+     * @param {Object} req An Express.js request.
+     * @param {Object} res An Express.js response.
+     */
     deletePermanently = async (req, res) => {
         if (loginCheck(req, res)) {
             let deleted = await req.db.User.delete(req.session.currentUser);
@@ -139,40 +182,59 @@ export default class User {
         }
     }
 
+    /**
+     * Gets a user's inventory.
+     * @param {Object} req An Express.js request.
+     * @param {Object} res An Express.js response.
+     */
     getInventory = async (req, res) => {
         if (loginCheck(req, res)) {
             let spirit = await req.db.User.recallOne(req.session.currentUser);
-            if (spirit.memory._lastUpdate > req.body._lastUpdate) {
-                let inv = spirit.memory.data.inventory;
-            
-                success(res, "Inventory found", inv, spirit.memory._lastUpdate);
+
+            if (check(res, spirit, "Account not found!")) {
+                if (check(res, spirit.memory._lastUpdate > req.body._lastUpdate, "Inventory up to date.")) {
+                    let inv = spirit.memory.data.inventory;
+                
+                    success(res, "Inventory found", inv, spirit.memory._lastUpdate);
+                }
             }
-            else fail(res, "Inventory up to date.");
         }
     }
 
+    /**
+     * Gets a user attributes.
+     * @param {Object} req An Express.js request.
+     * @param {Object} res An Express.js response.
+     */
     getAttributes = async (req, res) => {
         if (loginCheck(req, res)) {
             let user = await req.db.User.recallOne(req.session.currentUser);
     
-            if (user.memory._lastUpdate > req.body._lastUpdate) {
-                success(res, "Attributes found", user.memory.data.attributes);
+            if(check(res, user, "Account not found!")) {
+                if (check(res, user.memory._lastUpdate > req.body._lastUpdate, "Attributes up to date.")) {
+                    success(res, "Attributes found", user.memory.data.attributes);
+                }
             }
-            else fail(res, "Attributes up to date.");
         }
     }
 
+    /**
+     * Gets basic account information.
+     * @param {Object} req An Express.js request.
+     * @param {Object} res An Express.js response.
+     */
     getInfo = async (req, res) => {
         if (loginCheck(req, res)) {
             let user = await req.db.User.recallOne(req.session.currentUser);
     
-            if (user.memory._lastUpdate > req.body._lastUpdate) {
-                success(res, "Info found", {
-                    email: user.memory.data.email,
-                    username: user.memory.data.username
-                });
+            if (check(res, user, "Account not found!")) {
+                if (check(res, user.memory._lastUpdate > req.body._lastUpdate, "Info up to date.")) {
+                    success(res, "Info found", {
+                        email: user.memory.data.email,
+                        username: user.memory.data.username
+                    });
+                }
             }
-            else fail(res, "Info up to date.");
         }
     }
 }

package/controllers/util.js

@@ -0,0 +1,56 @@
+/**
+ * Check if something is true. Respond with a fail otherwise.
+ * @param {Object} res An Express.js response.
+ * @param {*} checkee What to check against.    
+ * @param {String} failMsg Message to send in a potential failure response.
+ * @returns True or false.
+ */
+export const check = (res, checkee, failMsg = "Failed!") => {
+    if (!checkee) {
+        fail(res, failMsg);
+        return false;
+    }
+    else {
+        return true;
+    }
+};
+
+/**
+ * Respond to the client with success.
+ * @param {Object} res An Express.js response.
+ * @param {String} msg A message describing the success.
+ * @param {Object} data Data to send with the response.
+ * @param {Number} lastUpdate A number date for synchronization.
+ */
+export const success = (res, msg = "Success!", data = null, lastUpdate = 0) => {
+    res.send({
+        status: "success",
+        message: msg,
+        lastUpdate: lastUpdate,
+        data: data
+    });
+};
+
+/**
+ * Respond to the client with failure.
+ * @param {Object} res An Express.js response.
+ * @param {String} msg A message describing the failure.
+ */
+export const fail = (res, msg = "Failed!") => {
+    res.send({
+        status: "failed",
+        message: msg,
+        lastUpdate: 0,
+        data: null
+    });
+};
+
+/**
+ * Check if a user is logged in.
+ * @param {Object} req An Express.js request.
+ * @param {Object} res An Express.js response.
+ * @returns True if a user is logged in, else false.
+ */
+export const loginCheck = (req, res) => {
+    return check(res, req.session.currentUser, "Please login first.");
+}

package/models/item.js

@@ -1,6 +1,13 @@
 import Spirit from "./spirit.js";
 
 export default class Item extends Spirit {
+    /**
+     * Creates an item in the database.
+     * @param {String} name The item name.
+     * @param {String} short A short descrption.
+     * @param {String} long A long description.
+     * @returns The item created.
+     */
     static create = async (name, short, long) => {
         let spirit = new Item(name);
 
@@ -18,8 +25,12 @@ export default class Item extends Spirit {
         return spirit;
     }
 
+    /**
+     * Recalls all items.
+     * @returns The items found or null.
+     */
     static recallAll = async () => {
-        let spirit = new Item();
+        let items = new Item();
 
         let found = await Spirit.db.find({
             service: "items",
@@ -27,13 +38,18 @@ export default class Item extends Spirit {
         });
 
         if (found) {
-            spirit.memory = found;
+            items.memory = found;
             
-            return spirit;
+            return items;
         }
         else return null;
     }
 
+    /**
+     * Recalls one item by name.
+     * @param {String} name The item name.
+     * @returns The item found or null.
+     */
     static recallOne = async (name) => {
         let spirit = new Item(name);
 
@@ -49,6 +65,11 @@ export default class Item extends Spirit {
         else return null;
     }
 
+    /**
+     * Deletes items by name.
+     * @param {String} name The item name.
+     * @returns Number of documents deleted.
+     */
     static delete = async (name) => {
         let found = await Spirit.db.findAndDelete(Spirit.buildQuery("items", { name }));
 

package/models/send-mail.js

@@ -1,5 +1,10 @@
 import nodemailer from "nodemailer";
 
+/**
+ * Sends an email with a password reset code. WIP
+ * @param {String} toEmail Email address to send to.
+ * @param {Number} resetToken Token to reset by.
+ */
 const passwordReset = async (toEmail, resetToken) => {
     var transporter = nodemailer.createTransport({
         service: 'gmail',
@@ -21,9 +26,14 @@ const passwordReset = async (toEmail, resetToken) => {
     });
 };
 
+/**
+ * Sends an email. WIP
+ * @param {String} toEmail Email Address to send to.
+ * @param {String} subject Subject of the email.   
+ * @param {String} html Body of the email.
+ * @returns 
+ */
 const send = async (toEmail, subject, html) => {
-    console.log("dfhd");
-
     var transporter = nodemailer.createTransport({
         service: 'gmail',
         auth: {
@@ -44,5 +54,4 @@ const send = async (toEmail, subject, html) => {
     });
 }
 
-
 export default { passwordReset, send };