notherbase-fs 3.2.21 → 3.3.1

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);
 
@@ -85,14 +85,18 @@ 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;
@@ -102,9 +106,22 @@ export default class SpiritWorld {
                 }
             } 
 
-            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

@@ -124,6 +124,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.

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;
@@ -147,4 +165,36 @@ export default class Spirit {
 
         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 {
+            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();
+            }
+        }
+    }
 };

package/package.json

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

package/public/js/base.js

@@ -161,13 +161,13 @@ class Base {
     }
 
     /**
-     * Loads a certain spirit.
-     * @param {String} service The name of the spirit to load.
+     * Loads all spirits of a certain service.
+     * @param {String} service The name of the spirits 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 }));
+    loadAll = async (service, scope = "local", data = {}, id = null) => {
+        let response = await $.post("/s/loadAll", JSON.stringify({ service, scope, data, id }));
 
         return response;
     }