notherbase-fs 4.3.6 → 4.4.0

package/controllers/spirit-world.js

@@ -3,6 +3,7 @@ import { stripHtml } from "string-strip-html";
 import { success, fail } from "./util.js";
 import User from "./user.js";
 import fs from 'fs';
+import { log } from "console";
 
 /**
 * The spirit world is the API of a base.
@@ -21,6 +22,7 @@ export default class SpiritWorld {
         this.router = express.Router();
         this.router.post("/loadAll", this.loadAll);
         this.router.post("/load", this.load);
+        this.router.post("/save", this.save);
         this.router.post("/serve", this.serve);
         this.router.use("/user", this.user.router);
     }
@@ -125,7 +127,6 @@ export default class SpiritWorld {
      * This API route requests a spirit of a kind from the database.
      * @param {Object} req
      * @param {Object} res
-     * @returns {Object} The requested spirit.
      */
     load = async (req, res) => {
         try {
@@ -145,6 +146,7 @@ export default class SpiritWorld {
 
             // recall all spirits with the given service name and parent
             let spirit = await req.db.Spirit.recallOne(req.body.service, parent, data, id);
+            console.log("loaded spirit ", spirit.memory);
 
             res.send(spirit);
         } catch (error) {
@@ -153,6 +155,48 @@ export default class SpiritWorld {
         }
     }
 
+    /**
+     * This API route saves a spirit to the database.
+     * @param {Object} req 
+     * @param {Object} res 
+     */
+    save = async (req, res) => {
+        console.log("saving spirit ");
+        try {
+            let parent = null;
+            let spiritData = 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.Spirit.recallOne("user",  null, { username: req.session?.currentUser });
+                if (user?.memory?._id) parent = user.memory._id;
+                else {
+                    fail(res, "User had no id on load()");
+                    return;
+                }
+            }
+
+            // save the spirit with the given service name and parent
+            let spirit = await req.db.Spirit.recallOne(req.body.service, parent, {}, id);
+            
+            if (spirit) {
+                console.log("saving spirit ", spirit.memory.data, " with new data ", spiritData);
+                // update existing spirit
+                await spirit.commit({ ...spirit.memory.data, ...spiritData });
+            }
+            else {
+                // create new spirit
+                spirit = await req.db.Spirit.create(req.body.service, spiritData, parent);
+            }
+
+            res.send("spirit saved");
+        } 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 

package/package.json

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

package/public/js/base.js

@@ -128,6 +128,19 @@ class Base {
         return response;
     }
 
+    /**
+     * Saves a spirit of a certain service.
+     * @param {String} service The name of the spirit to save.
+     * @param {String} scope Defaults to local, else global.
+     * @param {Object} data Data to save the spirit with.
+     * @param {ObjectID} id The id of the spirit to save.
+     * @returns Spirit world response.
+     */
+    save = async (service, scope = "local", data = {}, id = null) => {
+        let response = await $.post("/s/save", JSON.stringify({ service, scope, data, id }));
+        return response;
+    }
+
     /**
      * Appends html to the head.
      * @param {String} html The html to append.

package/test/the-front/index.ejs

@@ -15,7 +15,7 @@
 
 <input type="number" id="token">
 <button onclick="test.continueTest()">Continue Test</button>
-<button onclick="base.do('add-gold', { route: '/the-front' })">add gold</button>
+<button onclick="myGold = myGold + 1; base.save('front-gold', 'local', { amount: myGold })">add gold</button>
 <!-- download you data -->
 <button onclick="downloadData()">Download Data</button>
 <!-- delete all your data -->
@@ -40,6 +40,8 @@
 </a>
 
 <script>
+    let myGold = 0;
+
     class Test {
         constructor() {
             this.$info = $("main #info");
@@ -65,11 +67,10 @@
             this.$info.append(this.newUsername + "<br>");
             this.$info.append(this.newPassword + "<br>");
 
-            let loaded = await base.load("gold", "global");
-            console.log("global gold ", loaded);
-            this.$gold.text(`?/${loaded?.memory?.data?.amount !== null ? loaded.memory.data.amount : 0} Gold Added`);
-            loaded = await base.loadAll("gold");
-            console.log("local gold ", loaded);
+            let loaded = await base.load("front-gold");
+            console.log("gold ", loaded);
+            myGold = loaded?.memory?.data?.amount || 0;
+            this.$gold.text(`${myGold} Gold Added`);
         }
 
         runTest = async () => {