notherbase-fs 3.3.0 → 3.3.2

package/controllers/creation.js

@@ -5,11 +5,12 @@ import fs from 'fs';
  * Creation is all the renedered pages in a base.
  */
 export default class Creation {
-    constructor() {
+    constructor(siteTitle = "Base") {
+        this.siteTitle = siteTitle;
         this.router = express.Router();
 
         //home
-        this.router.get("/", function(req, res) { res.redirect("/the-front"); });
+        this.router.get("/", this.front, this.explore);
 
         //the-front
         this.router.get(`/the-front`, this.front, this.explore);
@@ -18,13 +19,15 @@ export default class Creation {
         //pages
         this.router.get(`/:page`, this.page, this.explore);
 
+        //the-front optional shortcuts
+        this.router.get(`/:frontDetail`, this.frontDetail, 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);
+        this.router.use(function(req, res) {
             res.redirect("/void");
         });
     }
@@ -88,7 +91,7 @@ export default class Creation {
      */
     front = async (req, res, next) => {
         req.main = req.contentPath + "/the-front/index";
-        req.siteTitle = "NotherBase - The Front";
+        req.siteTitle = this.siteTitle;
         req.toRender = "explorer";
         next();
     }
@@ -101,7 +104,7 @@ export default class Creation {
      */
     frontDetail = async (req, res, next) => {
         req.main = `${req.contentPath}/the-front/${req.params.frontDetail}/index`;
-        req.siteTitle = `NotherBase - ${req.params.frontDetail}`;
+        req.siteTitle = `${this.siteTitle} - ${req.params.frontDetail}`;
         req.toRender = "explorer";
         next();
     }
@@ -114,7 +117,7 @@ export default class Creation {
      */
     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}`;
+        req.siteTitle = `${this.siteTitle} - ${req.params.poi}`;
         req.toRender = "explorer";
         next();
     }
@@ -127,7 +130,7 @@ export default class Creation {
      */
     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}`;
+        req.siteTitle = `${this.siteTitle} - ${req.params.detail}`;
         req.toRender = "explorer";
         next();
     }

package/controllers/spirit-world.js

@@ -19,7 +19,7 @@ export default class SpiritWorld {
         this.router = express.Router();
         this.user = new User();
 
-        this.router.post("/load", this.load);
+        this.router.post("/loadAll", this.loadAll);
         this.router.post("/serve", this.serve);
         this.router.use("/user", this.user.router);
 
@@ -100,7 +100,10 @@ export default class SpiritWorld {
             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);
+                else {
+                    fail(res, "User had no id on load()");
+                    return;
+                }
             } 
 
             // recall all spirits with the given service name and parent

package/controllers/user.js

@@ -20,6 +20,8 @@ export default class User {
         this.router.post("/getInventory", this.getInventory);
         this.router.post("/getAttributes", this.getAttributes);
         this.router.post("/getInfo", this.getInfo);
+        this.router.post("/getView", this.getView);
+        this.router.post("/setView", this.setView);
     }
 
     /**
@@ -122,14 +124,6 @@ export default class User {
         }
     }
 
-    /**
-     * Checks if a user is logged in.
-     */
-    loggedIn = () => {
-        if (this.id) return true;
-        else return false;
-    }
-
     /**
      * Changes a user's email address on file.
      * @param {Object} req An Express.js request.
@@ -244,4 +238,33 @@ export default class User {
             }
         }
     }
+
+    /**
+     * Gets a user's saved view state.
+     */
+    getView = async (req, res) => {
+        if (loginCheck(req, res)) {
+            let user = await req.db.User.recallOne(req.session.currentUser);
+
+            if (check(res, user, "Account not found!")) {
+                success(res, "View found", user.memory.data.view);
+            }
+        }
+    }
+
+    /**
+     * Sets a user's view state.
+     */
+    setView = async (req, res) => {
+        if (loginCheck(req, res)) {
+            let user = await req.db.User.recallOne(req.session.currentUser);
+
+            if (check(res, user, "Account not found!")) {
+                user.memory.data.view = req.body.view;
+                await user.commit();
+
+                success(res, "View set");
+            }
+        }
+    }
 }

package/models/index.js

@@ -6,6 +6,8 @@ import Item from "./item.js";
 import User from "./user.js";
 import SendMail from "./send-mail.js";
 
+mongoose.set('strictQuery', true);
+
 mongoose.connection.on('connected', (err) => {
     console.log(`Mongoose connected to db`);
 });

package/models/spirit.js

@@ -127,7 +127,7 @@ export default class Spirit {
      * @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));
+        let found = await Spirit.db.deleteMany(Spirit.buildQuery(service, data, parent, id));
 
         return found.deletedCount;
     }
@@ -143,12 +143,25 @@ export default class Spirit {
      * @param {Object} data Data to save.
      * @returns Updated
      */
-    commit = async (data = this.memory.data) => {
+    commit = async (data = this.memory.data, which = -1) => {
         this.memory._lastUpdate = Date.now();
 
-        this.memory.data = data;
-        this.memory.markModified("data");
-        await this.memory.save();
+        if (!Array.isArray(this.memory)) {
+            this.memory.data = data;
+            this.memory.markModified("data");
+            await this.memory.save();
+        }
+        else {
+            for (let i = 0; i < this.memory.length; i++) {
+                if (data) {
+                    if (which < 0) this.memory[i].data = data;
+                    else if (which === i) this.memory[i].data = data;
+                }
+                
+                this.memory[i].markModified("data");
+                await this.memory[i].save();
+            }
+        }
 
         return "Updated";
     }

package/models/user.js

@@ -103,96 +103,11 @@ export default class User extends Spirit {
     }
 
     /**
-     * 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.
+     * Checks if a user is logged in.
      */
-    offsetItem = async (name, offset) => {
-        let item = await Item.recallOne(name);
-    
-        if (!item) return false;
-    
-        let inv = this.memory.data.inventory;
-
-        for (let j = 0; j < inv.length; j++) {
-            if (inv[j].name === name) {
-                if (inv[j].amount >= -Math.floor(offset)) {
-                    inv[j].amount += Math.floor(offset);
-    
-                    if (inv[j].amount === 0) {
-                        let empty = inv[j];
-    
-                        inv.splice(j, 1);
-                    }
-
-                    this.memory._lastUpdate = Date.now();
-                    await this.commit();
-                    return true;
-                }
-                else return false;
-            }
-        }
-        
-        if (offset > 0) {
-            inv.push({
-                name: name,
-                amount: offset
-            });
-
-            this.memory._lastUpdate = Date.now();
-
-            await this.commit();
-
-            return true;
-        }
+    loggedIn = () => {
+        if (this.id) return true;
         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;
-    
-        att[change] = to;
-        this.memory._lastUpdate = Date.now();
-        await this.commit();
-    
-        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;
-    
-        if (att[change] < max) {
-            att[change]++;
-            this.memory._lastUpdate = Date.now();
-            await this.commit();
-        } 
-        
-        return att[change];
-    }
 }
 

package/notherbase-fs.js

@@ -17,11 +17,16 @@ import SpiritWorld from "./controllers/spirit-world.js";
  * The engine that runs a nother base.
  */
 class NotherBaseFS {
-    constructor(contentPath) {
+    constructor(contentPath, globals = null, settings = {}) {
+        this.settings = {
+            siteTitle: "NotherBase",
+            favicon: null,
+            ...settings
+        }
         this.app = express();
         this.server = http.createServer(this.app);
         this.io = new Server(this.server);
-        this.creation = new Creation();
+        this.creation = new Creation(this.settings.siteTitle);
         this.spiritWorld = new SpiritWorld(this.io);
         
         //set views path
@@ -44,7 +49,8 @@ class NotherBaseFS {
         this.app.use(express.static(`${__dirname}/public`));
     
         // sets the favicon image
-        this.app.use(favicon(__dirname + '/public/img/logo.png'));
+        if (this.settings.favicon) this.app.use(favicon(this.settings.favicon));
+        else this.app.use(favicon(__dirname + '/public/img/logo.png'));
     
         //enable cookies
         this.app.use(session({
@@ -56,6 +62,7 @@ class NotherBaseFS {
 
         //provide database access and etc to use in routes
         this.app.use((req, res, next) => {
+            req.globals = globals;
             req.db = Models;
             req.contentPath = contentPath;
             req.lock = false;

package/package.json

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

package/public/js/base.js

@@ -13,108 +13,6 @@ class Base {
         return response;
     }
 
-    /**
-     * The player's inventory.
-     */
-    #Inventory = class Inventory {
-        constructor() {
-            this.items = [];
-            this.lastUpdate = 0;
-    
-            this.refresh();
-        }
-        
-        /**
-         * Reloads the inventory.
-         */
-        async refresh() {
-            let $list = $(".inventory .item-list");
-
-            let response = await Base.commune("getInventory", { _lastUpdate: this.lastUpdate });
-
-            if (response.status === "success") {
-                this.items = response.data;
-                this.lastUpdate = response.lastUpdate;
-                $list.empty();
-                
-                for (let i = 0; i < this.items.length; i++) {
-                    let $new = $list.append(
-                        `<div class="item-card">
-                            <h5>${this.items[i].name}</h5>
-                            <button id="${i}">X</button>
-                            <hr>
-                            <p>${this.items[i].amount}</p>
-                        </div>`
-                    ).children().last();
-        
-                    $new.find("button").on("click", this.reduceItem);
-                }
-
-                this.clearError();
-            }
-        }
-        
-        /**
-         * 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");
-
-            $error.text(text);
-            $error.removeClass("invisible");
-        }
-    }
-
-    /**
-     * The player's attributes.
-     */
-    #PlayerAttributes = class PlayerAttributes {
-        constructor() {
-            this.attributes = [];
-            this.lastUpdate = 0;
-
-            this.refresh();
-        }
-
-        /**
-         * Reloads the player's attributes.
-         */
-        async refresh() {
-            let response = await Base.commune("getAttributes", { _lastUpdate: this.lastUpdate });
-            if (response.status === "success") {
-                this.lastUpdate = response.lastUpdate;
-                this.attributes = response.data;
-    
-                this.render();
-            }
-        }
-
-        /**
-         * Renders the attributes.
-         */
-        render() {
-            let $content = $(".menu .content#player");
-
-            $content.empty();
-
-            if (this.attributes) {
-                for (const [key, value] of Object.entries(this.attributes)) {
-                    $content.append(`<h3 id="${key}">${key}: ${value}</h3>`);
-                }
-            }
-        }
-    }
-
     /**
      * Services for the player's account.
      */
@@ -123,58 +21,6 @@ class Base {
             this.username = "";
             this.email = "";
             this.lastUpdate = 0;
-            
-            this.refresh();
-        }
-    
-        /**
-         * Reloads the player's basic info.
-         */
-        async refresh() {
-            let response = await Base.commune("getInfo", { _lastUpdate: this.lastUpdate });
-            if (response.status === "success") {
-                this.lastUpdate = response.lastUpdate;
-                this.email = response.data.email;
-                this.username = response.data.username;
-            }
-
-            let $email = $(".content#account .setting#email p");
-            let $emailInput = $(".content#account .edit#email input");
-            let $username = $(".content#account .setting#username p");
-            let $usernameInput = $(".content#account .edit#username input");
-            
-            $email.text(this.email);
-            $emailInput.val(this.email);
-            $username.text(this.username);
-            $usernameInput.val(this.username);
-    
-            $(".content#account .settings").removeClass("invisible");
-            $(".content#account #please-login").addClass("invisible");
-        }
-    
-        /**
-         * Initiates email editing.
-         */
-        editEmail() {
-            let $emailSetting = $(".content#account .setting#email");
-            let $emailEdit = $(".content#account .edit#email");
-
-            $emailSetting.addClass("invisible");
-            $emailEdit.removeClass("invisible");
-        }
-    
-        /**
-         * Cancels editing the email.
-         */
-        cancelEmail() {
-            let $email = $(".content#account .setting#email p");
-            let $emailSetting = $(".content#account .setting#email");
-            let $emailEdit = $(".content#account .edit#email");
-            let $emailInput = $(".content#account .edit#email input");
-
-            $emailSetting.removeClass("invisible");
-            $emailEdit.addClass("invisible");
-            $emailInput.val($email.text());
         }
     
         /**
@@ -198,31 +44,6 @@ class Base {
             this.cancelEmail();
         }
     
-        /**
-         * Initiates username editing.
-         */
-        editUsername() {
-            let $usernameSetting = $(".content#account .setting#username");
-            let $usernameEdit = $(".content#account .edit#username");
-
-            $usernameSetting.addClass("invisible");
-            $usernameEdit.removeClass("invisible");
-        }
-    
-        /**
-         * Cancels username editing.
-         */
-        cancelUsername() {
-            let $usernameSetting = $(".content#account .setting#username");
-            let $usernameEdit = $(".content#account .edit#username");
-            let $usernameInput = $(".content#account .edit#username input");
-            let $username = $(".content#account .setting#username p");
-
-            $usernameSetting.removeClass("invisible");
-            $usernameEdit.addClass("invisible");
-            $usernameInput.val($username.text());
-        }
-    
         /**
          * Confirms and submits a username edit.
          */
@@ -246,56 +67,9 @@ class Base {
     }
     
     constructor() {
-        this.playerInventory = new this.#Inventory();
-        this.playerAttributes = new this.#PlayerAttributes();
         this.playerAccount = new this.#AccountServices();
-        this.menuClosing = false;
-
-        this.switchTab("inventory");
-    }
-
-    /**
-     * Closes the menu.
-     */
-    closeMenu = () => {
-        let $menu = $(".ui .menu");
-        let $fade = $(".ui .fade");
-
-        if (!this.menuClosing) {
-            this.menuClosing = true;
-            $fade.addClass("camo");
-            
-            setTimeout(() => { 
-                $menu.addClass("invisible");
-                $fade.addClass("invisible");
-                this.menuClosing = false;
-            }, 100);
-        }
-    }
-
-    /**
-     * Opens the menu.
-     */
-    openMenu = () => {
-        let $menu = $(".ui .menu");
-        let $fade = $(".ui .fade");
-
-        $menu.removeClass("invisible");
-        $fade.removeClass("camo");
-        $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");
-        $(`#content-window #${id}`).removeClass("invisible");
-        $(`.menu .tabs #${id}`).addClass("selected");
-    }
-    
     /**
      * Communes to logout.
      * @returns Communion response.
@@ -303,7 +77,8 @@ class Base {
     logout = async () => {
         let response = await Base.commune("logout");
 
-        return response;
+        location.reload();
+        //return response;
     }
 
     /**
@@ -334,11 +109,8 @@ class Base {
         });
 
         if (response.status === "success") {
-            this.playerInventory.refresh();
             this.playerAccount.username = response.data;
             this.playerAccount.email = email;
-            this.playerAccount.refresh();
-            this.playerAttributes.refresh();
         }
         
         return response;
@@ -384,9 +156,6 @@ class Base {
         }));
 
         if (response.status != "success") console.log(`${window.location.pathname} - ${response.message}`);
-
-        this.playerInventory.refresh();
-        this.playerAttributes.refresh();
         
         return response;
     }
@@ -402,4 +171,30 @@ class Base {
 
         return response;
     }
+
+    createToggleViewButton = async () => {
+        Base.commune("getView").then((res) => {
+            // add a button to the footer for toggling between compact and full view
+            this.$viewToggle = $("<button>").addClass("view-toggle").text(">");
+            this.$viewToggle.on("click", () => {
+                this.toggleView();
+            });
+            $("footer").append(this.$viewToggle);
+
+            if (res.data === "full") this.toggleView(false);
+        });
+    }
+
+    toggleView = async (save = true) => {
+        if (this.$viewToggle.text() === ">") {
+            this.$viewToggle.text("<");
+            $("main").addClass("full-view");
+            if (save) Base.commune("setView", { view: "full" });
+        }
+        else {
+            this.$viewToggle.text(">");
+            $("main").removeClass("full-view");
+            if (save) Base.commune("setView", { view: "compact" });
+        }
+    }
 }

package/public/js/chat-box.js

@@ -3,6 +3,7 @@
  */
 class ChatBox {
     constructor(username, room) {
+        ChatBox.attemptStyle();
         this.socket = null;
         this.username = username;
         this.room = room;
@@ -23,6 +24,18 @@ class ChatBox {
         this.render();
     }
 
+    static styled = false;
+
+    /**
+     * Adds the chat box styles if needed.
+     */
+    static attemptStyle() {
+        if (!ChatBox.styled) {
+            $("head").append(`<link href='/styles/chat.css' rel='stylesheet' />`);
+            ChatBox.styled = true;
+        }
+    }
+
     /**
      * Renders a new message in the chat.
      * @param {Object} msg An object including the text to render.