notherbase-fs 3.2.21 → 3.3.0

package/controllers/creation.js

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

package/controllers/spirit-world.js

@@ -85,26 +85,40 @@ export default class SpiritWorld {
     }
 
     /**
-     * This API route requests a spirit from the database.
-     * @param {Object} req 
-     * @param {Object} res 
+     * This API route requests all spirits of a kind from the database.
+     * @param {Object} req
+     * @param {Object} res
+     * @returns {Object} The requested spirits.
      */
-    load = async (req, res) => {
+    loadAll = async (req, res) => {
         try {
             let parent = null;
+            let data = req.body.data ? req.body.data : {};
+            let id = req.body.id ? req.body.id : null;
 
+            // if the scope is local, the parent is the user's id
             if (req.body.scope === "local") {
                 let user = await req.db.User.recallOne(req.session.currentUser);
                 if (user?.id) parent = user.id;
-                else {
-                    fail(res, "User had no id on load()");
-                    return;
-                }
+                else throw new Error("User had no id on load(): ", user);
             } 
 
-            let spirit = await req.db.Spirit.recallOne(req.body.service, parent);
+            // recall all spirits with the given service name and parent
+            let spirit = await req.db.Spirit.recallAll(req.body.service, parent, data, id);
 
-            res.send(spirit.memory.data ? spirit.memory.data : {});
+            // if the spirit is not an array, it's a single spirit
+            if (!Array.isArray(spirit.memory)) {
+                let togo = spirit.memory;
+                res.send(togo);
+            }
+            // if the spirit is an array, it's multiple spirits
+            else {
+                let togo = [];
+                for (let i = 0; i < spirit.memory.length; i++) {
+                    togo.push(spirit.memory[i]);
+                }
+                res.send(togo);
+            }
         } catch (error) {
             console.log(error);
             fail(res, "Server error");

package/controllers/user.js

@@ -20,8 +20,6 @@ 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);
     }
 
     /**
@@ -124,6 +122,14 @@ 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.
@@ -238,33 +244,4 @@ 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,8 +6,6 @@ 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

@@ -66,14 +66,32 @@ export default class Spirit {
      * @param {String} service The name of the spirit.
      * @returns All spirits of the given name.
      */
-    static recallAll = async (service, extraQuery) => {
+    static recallAll = async (service, parent = null, data = {}, id = null) => {
         let spirit = new Spirit();
 
-        let found = await Spirit.db.find({ service: service, ...extraQuery });
+        let query = Spirit.buildQuery(service, data, parent, id);
+
+        let found = await Spirit.db.find(query);
+
+        if (found) {
+            spirit.memory = found;
+            return spirit;
+        }
+        else return null;
+    }
+
+    /**
+     * Recalls any spirit from the database.
+     * @param {String} service The name of the spirit.
+     * @returns Any spirit found.
+     */
+    static recallAny = async (service) => {
+        let spirit = new Spirit();
+
+        let found = await Spirit.db.findOne({ service: service });
 
         if (found) {
             spirit.memory = found;
-            
             return spirit;
         }
         else return null;
@@ -109,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, parent, id));
+        let found = await Spirit.db.deleteMany(Spirit.buildQuery(service, data, id));
 
         return found.deletedCount;
     }
@@ -125,26 +143,45 @@ export default class Spirit {
      * @param {Object} data Data to save.
      * @returns Updated
      */
-    commit = async (data = this.memory.data, which = -1) => {
+    commit = async (data = this.memory.data) => {
         this.memory._lastUpdate = Date.now();
 
-        if (!Array.isArray(this.memory)) {
-            this.memory.data = data;
-            this.memory.markModified("data");
-            await this.memory.save();
+        this.memory.data = data;
+        this.memory.markModified("data");
+        await this.memory.save();
+
+        return "Updated";
+    }
+
+    /**
+     * Normalizes the data property to an array.
+     */
+    normalizeDataToArray = () => {
+        if (!Array.isArray(this.memory.data)) this.memory.data = [];
+    }
+
+    /**
+     * Adds a new backup to the spirit's data.
+     * If backups have not already been enabled, the old dat will be moved to a backup.
+     * @param {Object} data Data to add to the backup.
+     */
+    addBackup = async (data, max = 5) => {
+        if (!this.memory.data._backupsEnabled) {
+            let oldData = this.memory.data;
+            this.memory.data = {
+                _backupsEnabled: true,
+                backups: [ oldData ]
+            };
         }
         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();
+            this.memory.data.backups.unshift({
+                _lastUpdate: Date.now(),
+                data: data
+            });
+
+            if (max > 1) {
+                while (this.memory.data.backups.length > max) this.memory.data.backups.pop();
             }
         }
-
-        return "Updated";
     }
 };

package/models/user.js

@@ -101,5 +101,98 @@ export default class User extends Spirit {
         this.email = email;
         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);
+    
+        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;
+        }
+        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,16 +17,11 @@ import SpiritWorld from "./controllers/spirit-world.js";
  * The engine that runs a nother base.
  */
 class NotherBaseFS {
-    constructor(contentPath, globals = null, settings = {}) {
-        this.settings = {
-            siteTitle: "NotherBase",
-            favicon: null,
-            ...settings
-        }
+    constructor(contentPath) {
         this.app = express();
         this.server = http.createServer(this.app);
         this.io = new Server(this.server);
-        this.creation = new Creation(this.settings.siteTitle);
+        this.creation = new Creation();
         this.spiritWorld = new SpiritWorld(this.io);
         
         //set views path
@@ -49,8 +44,7 @@ class NotherBaseFS {
         this.app.use(express.static(`${__dirname}/public`));
     
         // sets the favicon image
-        if (this.settings.favicon) this.app.use(favicon(this.settings.favicon));
-        else this.app.use(favicon(__dirname + '/public/img/logo.png'));
+        this.app.use(favicon(__dirname + '/public/img/logo.png'));
     
         //enable cookies
         this.app.use(session({
@@ -62,7 +56,6 @@ 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.2.21",
+  "version": "3.3.0",
   "description": "Functions to help make developing for NotherBase easier.",
   "exports": "./notherbase-fs.js",
   "scripts": {