notherbase-fs 3.1.5 → 3.1.6

package/models/spirit.js

@@ -1,6 +1,10 @@
 import mongoose from "mongoose";
 
+/**
+ * Curated Mongoose.js documents for use in bases.
+ */
 export default class Spirit {
+    // The actual Mongoose.js model for accessing the database.
     static db = mongoose.model('spirits', new mongoose.Schema({
         _lastUpdate: Number,
         service: String,
@@ -12,6 +16,14 @@ export default class Spirit {
         data: {}
     }));
 
+    /**
+     * Builds query objects for Mongoose.js searches.
+     * @param {String} service The name of the spirit.
+     * @param {Object} data An object with data to query the spirit by.
+     * @param {ObjectID} parent The MongoDB id of the parent spirit to search by.
+     * @param {ObjectID} id The exact id of the MongoDB document.
+     * @returns A query object.
+     */
     static buildQuery = (service, data = null, parent = null, id = null) => {
         let query = {
             service: service,
@@ -19,8 +31,7 @@ export default class Spirit {
         };
         
         if (id) query._id = id;
-
-        if (data){
+        else if (data){
             let keys = Object.keys(data);
             for (let i = 0; i < keys.length; i++) {
                 query[`data.${keys[i]}`] = data[keys[i]];
@@ -30,6 +41,13 @@ export default class Spirit {
         return query;
     }
 
+    /**
+     * Creates a spirit in the database.
+     * @param {String} service The name of the spirit.
+     * @param {Object} data An object with data to create the spirit with.
+     * @param {ObjectID} parent The MongoDB id of the parent of the spirit to be created.
+     * @returns A new user spirit.
+     */
     static create = async (service, data = {}, parent = null) => {
         let spirit = new Spirit();
 
@@ -43,14 +61,15 @@ export default class Spirit {
         return spirit;
     }
 
+    /**
+     * Recalls all spirits in the database with a given name.
+     * @param {String} service The name of the spirit.
+     * @returns All spirits of the given name.
+     */
     static recallAll = async (service) => {
         let spirit = new Spirit();
 
-        let query = Spirit.buildQuery(service);
-
-        let found = await Spirit.db.find({
-            service: service
-        });
+        let found = await Spirit.db.find({ service: service });
 
         if (found) {
             spirit.memory = found;
@@ -60,24 +79,36 @@ export default class Spirit {
         else return null;
     }
 
+    /**
+     * Recalls one spirit from the database or creates a new one.
+     * @param {String} service The name of the spirit.
+     * @param {ObjectID} parent The MongoDB id of the parent spirit to search by.
+     * @param {Object} data An object with data to query the spirit by.
+     * @param {ObjectID} id The exact id of the MongoDB document.
+     * @returns The spirit found or a new one created in the database..
+     */
     static recallOne = async (service, parent = null, data = {}, id = null) => {
         let spirit = new Spirit();
 
         let query = Spirit.buildQuery(service, data, parent, id);
 
         let found = await Spirit.db.findOne(query);
+        
+        if (found) spirit.memory = found;
+        else spirit = await Spirit.create(service, {}, parent);
 
-        if (found) {
-            spirit.memory = found;
-            return spirit;
-        }
-        else {
-            let newSpirit = await Spirit.create(service, {}, parent);
-            return newSpirit;
-        }
+        return spirit;
     }
 
-    static delete = async (service, data = {}, id = null) => {
+    /**
+     * Deletes all of the specified spirit.
+     * @param {String} service The name of the spirit.
+     * @param {Object} data An object with data to query the spirit by.
+     * @param {ObjectID} parent The MongoDB id of the parent spirit to search with.
+     * @param {ObjectID} id The exact id of the MongoDB document.
+     * @returns The number of documents deleted.
+     */
+    static delete = async (service, data = {}, parent = null, id = null) => {
         let found = await Spirit.db.deleteMany(Spirit.buildQuery(service, data, id));
 
         return found.deletedCount;
@@ -89,6 +120,11 @@ export default class Spirit {
         };
     }
 
+    /**
+     * Commits new data to a spirit.
+     * @param {Object} data Data to save.
+     * @returns Updated
+     */
     commit = async (data = this.memory.data) => {
         this.memory._lastUpdate = Date.now();
 

package/models/user.js

@@ -2,45 +2,61 @@ import Spirit from "./spirit.js";
 import Item from "./item.js";
 import bcrypt from "bcrypt";
 
+/**
+ * A user spirit.
+ * @extends Spirit
+ */
 export default class User extends Spirit {
+    /**
+     * Recalls one user from the database.
+     * @param {String} email Email address of the user.
+     * @param {String} username The user's name.
+     * @param {ObjectID} id The MongoDB id of the user.
+     * @returns A user found or null.
+     */
     static recallOne = async (email = null, username = null, id = null) => {
-        let spirit = new User(email, id);
+        let user = new User(email, id);
 
         let query = null;
 
-        if (email) {
-            query = Spirit.buildQuery("user", { email: email });
+        if (id) {
+            query = Spirit.buildQuery("user", null, null, id);
         }
         else if (username) {
             query = Spirit.buildQuery("user", { username: username });
         }
-        else if (id) {
-            query = Spirit.buildQuery("user", null, null, id);
+        else if (email) {
+            query = Spirit.buildQuery("user", { email: email });
         }
+        else return null;
         
-        let found = null;
-
-        if (query) found = await Spirit.db.findOne(query);
+        let found = await Spirit.db.findOne(query);
 
         if (found) {
-            spirit.memory = found;
-            spirit.id = found._id;
+            user.memory = found;
+            user.id = found._id;
+            user.email = found.data.email;
             
-            return spirit;
+            return user;
         }
         else return null;
     }
 
+    /**
+     * Creates one user in the database.
+     * @param {String} email Email address of the user.
+     * @param {String} password The user's ****.
+     * @param {String} username The user's name.
+     * @returns The user created.
+     */
     static create = async (username, password, email) => {
-        let spirit = new User(email);
+        let user = new User(email);
 
         const salt = await bcrypt.genSalt(10);
         const hash = await bcrypt.hash(password, salt);
 
-        spirit.memory = await Spirit.db.create({
-            route: "/",
+        user.memory = await Spirit.db.create({
             service: "user",
-            scope: "global",
             parent: null,
             _lastUpdate: Date.now(),
             data: {
@@ -63,9 +79,14 @@ export default class User extends Spirit {
             }
         });
 
-        return spirit;
+        return user;
     }
 
+    /**
+     * Delete a user account.
+     * @param {String} email Email address of the account to delete.
+     * @returns 
+     */
     static delete = async (email) => {
         let found = await Spirit.db.findAndDelete(Spirit.buildQuery({
             service: "user",
@@ -81,6 +102,12 @@ export default class User extends Spirit {
         this.id = id;
     }
 
+    /**
+     * Attempts to offset the user's inventory of a certain item.
+     * @param {String} name The item's name.
+     * @param {Number} offset The amount to offset by.
+     * @returns True if successful.
+     */
     offsetItem = async (name, offset) => {
         let item = await Item.recallOne(name);
     
@@ -122,12 +149,24 @@ export default class User extends Spirit {
         else return false;
     }
 
+    /**
+     * Tests if an attribute meets a requirement.
+     * @param {String} check The attribute to check.
+     * @param {Number} against The number to meet.
+     * @returns 
+     */
     checkAttribute = async (check, against) => {
         let att = this.memory.data.attributes;
     
         return att[check] >= against;
     }
 
+    /**
+     * Sets a user's attribute score.
+     * @param {String} change The attribute to change.
+     * @param {Number} to The number to set it to.
+     * @returns Attributes set
+     */
     setAttribute = async (change, to) => {
         let att = this.memory.data.attributes;
     
@@ -138,6 +177,12 @@ export default class User extends Spirit {
         return "Attributes set.";
     }
 
+    /**
+     * Increments a user's attribute by one.
+     * @param {String} change The attribute to increment.
+     * @param {Number} max The ceiling.
+     * @returns The resulting attribute score.
+     */
     incrementAttribute = async (change, max) => {
         let att = this.memory.data.attributes;
     

package/notherbase-fs.js

@@ -13,6 +13,9 @@ const __dirname = fileURLToPath(new URL('./', import.meta.url));
 import Creation from "./controllers/creation.js";
 import SpiritWorld from "./controllers/spirit-world.js";
 
+/**
+ * The engine that runs a nother base.
+ */
 class NotherBaseFS {
     constructor(contentPath) {
         this.app = express();
@@ -51,6 +54,7 @@ class NotherBaseFS {
             saveUninitialized: false
         }));
 
+        //provide database access and etc to use in routes
         this.app.use((req, res, next) => {
             req.db = Models;
             req.contentPath = contentPath;
@@ -58,10 +62,13 @@ class NotherBaseFS {
             next();
         });
 
+        //spirit world routes
         this.app.use("/s", this.spiritWorld.router);
         
+        //all actual pages
         this.app.use("/", this.creation.router);
     
+        //start the server
         this.server.listen(process.env.PORT, function () {
             console.log(`Server started at ${process.env.PORT}`);
             this.started = true;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "notherbase-fs",
-  "version": "3.1.5",
+  "version": "3.1.6",
   "description": "Functions to help make developing for NotherBase easier.",
   "exports": "./notherbase-fs.js",
   "scripts": {

package/public/js/base.js

@@ -1,4 +1,10 @@
 class Base {
+    /**
+     * Communes with the user spirit for easy access to those functions.
+     * @param {String} route /s/user/[route]
+     * @param {Object} data Data to send with the communion.
+     * @returns Communion response.
+     */
     static commune = async (route, data = {}) => {
         let response = await $.post("/s/user/" + route, JSON.stringify(data));
 
@@ -7,6 +13,9 @@ class Base {
         return response;
     }
 
+    /**
+     * The player's inventory.
+     */
     #Inventory = class Inventory {
         constructor() {
             this.items = [];
@@ -15,6 +24,9 @@ class Base {
             this.refresh();
         }
         
+        /**
+         * Reloads the inventory.
+         */
         async refresh() {
             let $list = $(".inventory .item-list");
 
@@ -42,12 +54,19 @@ class Base {
             }
         }
         
+        /**
+         * Clears the error on screen.
+         */
         clearError() {
             let $error = $("#inventory #error");
 
             $error.addClass("invisible");
         }
     
+        /**
+         * Shows an error on screen.
+         * @param {String} text The error message.
+         */
         setError(text) {
             let $error = $("#inventory #error");
 
@@ -56,6 +75,9 @@ class Base {
         }
     }
 
+    /**
+     * The player's attributes.
+     */
     #PlayerAttributes = class PlayerAttributes {
         constructor() {
             this.attributes = [];
@@ -64,6 +86,9 @@ class Base {
             this.refresh();
         }
 
+        /**
+         * Reloads the player's attributes.
+         */
         async refresh() {
             let response = await Base.commune("getAttributes", { _lastUpdate: this.lastUpdate });
             if (response.status === "success") {
@@ -74,6 +99,9 @@ class Base {
             }
         }
 
+        /**
+         * Renders the attributes.
+         */
         render() {
             let $content = $(".menu .content#player");
 
@@ -87,6 +115,9 @@ class Base {
         }
     }
 
+    /**
+     * Services for the player's account.
+     */
     #AccountServices = class AccountServices {
         constructor() {
             this.username = "";
@@ -96,6 +127,9 @@ class Base {
             this.refresh();
         }
     
+        /**
+         * Reloads the player's basic info.
+         */
         async refresh() {
             let response = await Base.commune("getInfo", { _lastUpdate: this.lastUpdate });
             if (response.status === "success") {
@@ -118,6 +152,9 @@ class Base {
             $(".content#account #please-login").addClass("invisible");
         }
     
+        /**
+         * Initiates email editing.
+         */
         editEmail() {
             let $emailSetting = $(".content#account .setting#email");
             let $emailEdit = $(".content#account .edit#email");
@@ -126,6 +163,9 @@ class Base {
             $emailEdit.removeClass("invisible");
         }
     
+        /**
+         * Cancels editing the email.
+         */
         cancelEmail() {
             let $email = $(".content#account .setting#email p");
             let $emailSetting = $(".content#account .setting#email");
@@ -137,6 +177,9 @@ class Base {
             $emailInput.val($email.text());
         }
     
+        /**
+         * Confirms and submits an email edit.
+         */
         async updateEmail() {
             let $info = $(".content#account #info");
             let $email = $(".content#account .setting#email p");
@@ -155,6 +198,9 @@ class Base {
             this.cancelEmail();
         }
     
+        /**
+         * Initiates username editing.
+         */
         editUsername() {
             let $usernameSetting = $(".content#account .setting#username");
             let $usernameEdit = $(".content#account .edit#username");
@@ -163,6 +209,9 @@ class Base {
             $usernameEdit.removeClass("invisible");
         }
     
+        /**
+         * Cancels username editing.
+         */
         cancelUsername() {
             let $usernameSetting = $(".content#account .setting#username");
             let $usernameEdit = $(".content#account .edit#username");
@@ -174,6 +223,9 @@ class Base {
             $usernameInput.val($username.text());
         }
     
+        /**
+         * Confirms and submits a username edit.
+         */
         async updateUsername() {
             let $info = $(".content#account #info");
             let $username = $(".content#account .setting#username p");
@@ -202,6 +254,9 @@ class Base {
         this.switchTab("inventory");
     }
 
+    /**
+     * Closes the menu.
+     */
     closeMenu = () => {
         let $menu = $(".ui .menu");
         let $fade = $(".ui .fade");
@@ -218,6 +273,9 @@ class Base {
         }
     }
 
+    /**
+     * Opens the menu.
+     */
     openMenu = () => {
         let $menu = $(".ui .menu");
         let $fade = $(".ui .fade");
@@ -227,6 +285,10 @@ class Base {
         $fade.removeClass("invisible");
     }
 
+    /**
+     * Switches tabs in the menu.
+     * @param {String} id The name of the tab to switch to.
+     */
     switchTab = function switchTab(id) {
         $("#content-window .content").addClass("invisible");
         $(".menu .tabs button").removeClass("selected");
@@ -234,12 +296,23 @@ class Base {
         $(`.menu .tabs #${id}`).addClass("selected");
     }
     
+    /**
+     * Communes to logout.
+     * @returns Communion response.
+     */
     logout = async () => {
         let response = await Base.commune("logout");
 
         return response;
     }
 
+    /**
+     * Communes to register a new account.
+     * @param {String} email The user's email address.
+     * @param {String} username The user's display name.
+     * @param {String} password The user's ****.
+     * @returns Communion response.
+     */
     attemptRegister = async (email, username, password) => {
         let response = await Base.commune("register", { 
             email, username, password 
@@ -248,6 +321,12 @@ class Base {
         return response;
     }
 
+    /**
+     * Communes to login.
+     * @param {String} email The user's email address.
+     * @param {String} password The user's password.
+     * @returns Communion response.
+     */
     attemptLogin = async (email, password) => {
         let response = await Base.commune("login", {
             email: email,
@@ -265,18 +344,38 @@ class Base {
         return response;
     };
 
+    /**
+     * Communes to send a password reset email.
+     * @param {String} email The user's email.
+     * @param {Boolean} test Debug mode
+     * @returns Communion response.
+     */
     resetPassword = async (email, test = false) => {
         let response = await Base.commune("sendPasswordReset", { email, test });
         
         return response;
     }
 
+    /**
+     * Communes to finalize a password change.
+     * @param {Number} token The password reset token.
+     * @param {String} email The user's email address.
+     * @param {String} password The user's new password.
+     * @param {String} confirmation Confirmation of the user's new password.
+     * @returns Communion response.
+     */
     changePassword = async (token, email, password, confirmation) => {
         let response = await Base.commune("changePassword", { token, email, password, confirmation });
         
         return response;
     }
 
+    /**
+     * Runs a script on the server.
+     * @param {String} what The script to run.
+     * @param {Object} data Data to send as input for the script.
+     * @returns Communion response.
+     */
     do = async (what, data = null) => {
         let response = await $.post("/s/serve", JSON.stringify({ 
             script: what,
@@ -292,6 +391,12 @@ class Base {
         return response;
     }
 
+    /**
+     * Loads a certain spirit.
+     * @param {String} service The name of the spirit to load.
+     * @param {String} scope Defaults to local, else global.
+     * @returns Spirit world response.
+     */
     load = async (service, scope = "local") => {
         let response = await $.post("/s/load", JSON.stringify({ service, scope }));
 

package/public/js/chat-box.js

@@ -1,3 +1,6 @@
+/**
+ * Creates a chat box from a div.chat-box.
+ */
 class ChatBox {
     constructor(username, room) {
         this.socket = null;
@@ -16,9 +19,14 @@ class ChatBox {
         });
 
         this.socket.on('chat message', this.newMessage);
+        this.socket.on('chat info', this.updateInfo);
         this.render();
     }
 
+    /**
+     * Renders a new message in the chat.
+     * @param {Object} msg An object including the text to render.
+     */
     newMessage = (msg) => {
         let time = new Date(msg.time);
         this.$chatLog.append(`<p>[${time.toLocaleTimeString('en-US')}] ${msg.name}: ${msg.text}</p>`);
@@ -31,6 +39,20 @@ class ChatBox {
         }
     }
 
+    /**
+     * Updates info about the chat room in the chat box.
+     * @param {Object} msg An object including the users in the room.
+     */
+    updateInfo = (msg) => {
+        this.$users.empty();
+        for (let i = 0; i < msg.data.users.length; i++) {
+            this.$users.append(`<li>${msg.data.users[i]}</li>`);
+        }
+    }
+
+    /**
+     * Sends a new chat message to the server.
+     */
     sendMessage = () => {
         if (this.$entry.val() !== ""){
             let val = this.$entry.val();
@@ -44,18 +66,19 @@ class ChatBox {
         }
     }
 
+    /**
+     * Renders necessary child elements.
+     */
     render() {
         this.$div.empty();
 
-        this.$div.append(`<h4>Chatting with the name ${this.username}:`);
-        this.$div.append(`<div class="chat-log"> </div>`);
-        this.$div.append(`<input autocomplete="off" type="text" class="chat-entry">`);
-        this.$div.append(`<button class="chat-send">Send</button>`);
-
-        this.$chatLog = this.$div.find(".chat-log");
-        this.$entry = this.$div.find(".chat-entry");
+        this.$header = $(`<h4>Chatting with the name ${this.username}:`).appendTo(this.$div);
+        this.$chatLog = $(`<div class="chat-log"></div>`).appendTo(this.$div);
+        this.$users = $(`<ul class="users"></ul>`).appendTo(this.$div);
+        this.$entry = $(`<input autocomplete="off" type="text" class="chat-entry">`).appendTo(this.$div);
+        this.$send = $(`<button class="chat-send">Send</button>`).appendTo(this.$div);
 
-        this.$div.find("button").on("click", this.sendMessage);
+        this.$send.on("click", this.sendMessage);
         this.$entry.on("keyup", (e) => {
             if (e.keyCode == 13) this.sendMessage();
         });

package/public/styles/account.css

@@ -1,4 +1,8 @@
 .content#account {
+    padding: 20px;
+}
+
+.content#account h3 {
     padding: 10px;
 }