notherbase-fs 4.4.7 → 4.5.1

package/controllers/spirit-world.js

@@ -1,247 +0,0 @@
-import express from "express";
-import { stripHtml } from "string-strip-html";
-import { success, fail } from "./util.js";
-import User from "./user.js";
-import fs from 'fs';
-
-/**
-* The spirit world is the API of a base.
-*/
-export default class SpiritWorld {
-    /**
-     * Sets up the spirit world.
-     * @param {Server} io 
-     */
-    constructor(io) {
-        this.io = io;
-        this.rooms = {};
-        this.io.on('connection', this.setupChat);
-
-        this.user = new User();
-        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("/delete", this.delete);
-        this.router.post("/serve", this.serve);
-        this.router.use("/user", this.user.router);
-    }
-
-    /**
-     * Sets up socket.io for instant messaging and etc.
-     * @param {*} socket 
-     */
-    setupChat = (socket) => {
-        try {
-            let roomName = socket.handshake.query.room;
-            socket.join(roomName);
-            let room = this.rooms[roomName];
-            if (room) room.users.push(socket.handshake.query.name);
-            else {
-                this.rooms[roomName] = {
-                    users: [ socket.handshake.query.name ]
-                }
-                room = this.rooms[roomName];
-            }
-        
-            this.io.to(roomName).emit("chat message", {
-                name: "Server",
-                time: Date.now(),
-                text: `${socket.handshake.query.name} has joined the room.`
-            });
-
-            this.io.to(roomName).emit("chat info", {
-                name: socket.handshake.query.room,
-                time: Date.now(),
-                data: {
-                    users: room.users
-                }
-            });
-        
-            socket.on("chat message", (msg) => {
-                this.io.to(roomName).emit("chat message", {
-                    name: msg.name,
-                    time: msg.time,
-                    text: stripHtml(msg.text).result
-                });
-            });
-        
-            socket.on('disconnect', () => {
-                room.users.splice(room.users.indexOf(socket.handshake.query.name));
-
-                this.io.to(roomName).emit("chat message", {
-                    name: "Server",
-                    time: Date.now(),
-                    text: `${socket.handshake.query.name} has left the room.`
-                });
-
-                this.io.to(roomName).emit("chat info", {
-                    name: socket.handshake.query.room,
-                    time: Date.now(),
-                    data: {
-                        users: room.users
-                    }
-                });
-
-                if (room.users.length < 1) delete this.rooms[roomName];
-            });
-        } catch (error) {
-            console.log(error);
-            fail(res, "Server error: Sockets");
-        }        
-    }
-
-    /**
-     * This API route requests all spirits of a kind from the database.
-     * @param {Object} req
-     * @param {Object} res
-     * @returns {Object} The requested spirits.
-     */
-    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.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;
-                }
-            } 
-
-            // recall all spirits with the given service name and parent
-            let spirits = await req.db.Spirit.recallAll(req.body.service, parent, data, id);
-
-            res.send(spirits);
-        } catch (error) {
-            console.log(error);
-            fail(res, "Server error");
-        }
-    }
-
-    /**
-     * This API route requests a spirit of a kind from the database.
-     * @param {Object} req
-     * @param {Object} res
-     */
-    load = 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.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;
-                }
-            } 
-
-            // recall all spirits with the given service name and parent
-            let spirit = await req.db.Spirit.recallOne(req.body.service, parent, data, id);
-
-            res.send(spirit);
-        } catch (error) {
-            console.log(error);
-            fail(res, "Server error");
-        }
-    }
-
-    /**
-     * This API route saves a spirit to the database.
-     * @param {Object} req 
-     * @param {Object} res 
-     */
-    save = async (req, res) => {
-        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 = null;
-            if (id !== "new") spirit = await req.db.Spirit.recallOne(req.body.service, parent, {}, id);
-            
-            if (spirit) {
-                // 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.memory._id);
-        } catch (error) {
-            console.log(error);
-            fail(res, "Server error");
-        }
-    }
-
-    delete = 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.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;
-                }
-            }
-
-            // delete the spirits
-            let deleted = await req.db.Spirit.delete(req.body.service, parent, data, id);
-            res.send(`${deleted}`);
-        } 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 
-     * @param {Object} res 
-     */
-    serve = async (req, res) => {
-        try {
-            let scriptPath = `${req.contentPath}${req.body.route}/${req.body.script}.js`;
-        
-            let script, result = null;
-
-            if (fs.existsSync(scriptPath)) {
-                let user = await req.db.Spirit.recallOne("user",  null, { username: req.session?.currentUser });
-
-                script = await import(process.env.WINDOWS == "true" ? `file://${scriptPath}` : scriptPath);
-                result = await script.default(req, user, this.io);
-                success(res, "Served.", result);
-            }
-            else fail(res, `Script not found: ${req.body.script} at ${scriptPath}`);
-        } catch (error) {
-            console.log(error);
-            fail(res, "Server error");
-        }        
-    }
-}

package/models/index.js

@@ -1,31 +0,0 @@
-import mongoose from "mongoose";
-import dotenv from "dotenv";
-dotenv.config();
-import Spirit from "./spirit.js";
-import SendMail from "./send-mail.js";
-
-mongoose.set('strictQuery', true);
-
-mongoose.connection.on('connected', (err) => {
-    console.log(`Mongoose connected to db`);
-});
-
-mongoose.connection.on('error', (err) => {
-    console.log(`Mongoose ${err}`);
-});
-
-mongoose.connection.on('disconnected', () => {
-    console.log('Mongoose disconnected');
-});
-
-try {
-    mongoose.connect(process.env.MONGODB_URI);
-}
-catch (err) {
-    console.log(`Mongoose on connect: ${err}`);
-}
-
-export default {
-    SendMail: SendMail,
-    Spirit: Spirit
-}

package/models/spirit.js

@@ -1,235 +0,0 @@
-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,
-        parent: { 
-            type: mongoose.Schema.Types.ObjectId, 
-            ref: "spirits",
-            required: false
-        },
-        data: {},
-        backups: []
-    }));
-
-    /**
-     * 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 = {
-            parent: parent
-        };
-        
-        if (service) query.service = service;
-        if (id) query._id = id;
-        else if (data){
-            let keys = Object.keys(data);
-            for (let i = 0; i < keys.length; i++) {
-                query[`data.${keys[i]}`] = data[keys[i]];
-            }
-        }
-    
-        return query;
-    }
-
-    // static buildBackupQuery = (service, data = null, parent = null, id = null) => {
-    //     let query = {
-    //         service: service,
-    //         parent: parent
-    //     };
-        
-    //     if (id) query._id = id;
-    //     else if (data){
-    //         let keys = Object.keys(data);
-    //         for (let i = 0; i < keys.length; i++) {
-                
-    //             query[`data.backups.0.data.${keys[i]}`] = data[keys[i]];
-    //         }
-    //     }
-    
-    //     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 spirit.
-     */
-    static create = async (service, data = {}, parent = null) => {
-        let spirit = new Spirit();
-
-        spirit.memory = await Spirit.db.create({
-            service,
-            parent,
-            _lastUpdate: Date.now(),
-            data: data,
-            backups: []
-        });
-
-        return spirit;
-    }
-
-    /**
-     * Recalls all spirits in the database with a given name.
-     * @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 All spirits found.
-     */
-    static recallAll = async (service, parent = null, data = {}, id = null) => {
-        let spirits = [];
-
-        let query = Spirit.buildQuery(service, data, parent, id);
-
-        let found = await Spirit.db.find(query);
-
-        if (found) {
-            for (let i = 0; i < found.length; i++) {
-                let spirit = new Spirit(found[i]);
-                spirits.push(spirit);
-                // convert old backups to new format
-                if (spirit.memory.data?._backupsEnabled) {
-                    spirit.memory.backups = spirit.memory.data.backups;
-                    spirit.memory.data = spirit.memory.backups[0].data;
-                    spirit.memory.markModified("backups");
-                    await spirit.commit();
-                }
-            }
-
-            return spirits;
-        }
-        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 = null;
-
-        let query = Spirit.buildQuery(service, data, parent, id);
-
-        let found = await Spirit.db.findOne(query);
-        
-        if (found) {
-            spirit = new Spirit(found);
-
-            // convert old backups to new format
-            if (spirit.memory.data?._backupsEnabled) {
-                spirit.memory.backups = spirit.memory.data.backups;
-                spirit.memory.data = spirit.memory.backups[0].data;
-                spirit.memory.markModified("backups");
-                await spirit.commit();
-            }
-
-            return spirit;
-        }
-        else return null;
-    }
-
-    /**
-     * Recalls or creates a spirit in the database.
-     * @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 recallOrCreateOne = async (service, parent = null, data = {}, id = null) => {
-        let spirit = null;
-
-        let query = Spirit.buildQuery(service, data, parent, id);
-
-        let found = await Spirit.db.findOne(query);
-
-        if (found) spirit = new Spirit(found);
-        else spirit = await Spirit.create(service, data, parent);
-
-        // convert old backups to new format
-        if (spirit.memory.data?._backupsEnabled) {
-            spirit.memory.backups = spirit.memory.data.backups;
-            spirit.memory.data = spirit.memory.backups[0].data;
-            spirit.memory.markModified("backups");
-            await spirit.commit();
-        }
-
-        return spirit;
-    }
-
-    /**
-     * Deletes all of the specified spirit.
-     * @param {String} service The name of the spirit.
-     * @param {ObjectID} parent The MongoDB id of the parent spirit to search with.
-     * @param {Object} data An object with data to query the spirit by.
-     * @param {ObjectID} id The exact id of the MongoDB document.
-     * @returns The number of documents deleted.
-     */
-    static delete = async (service, parent = null, data = {}, id = null) => {
-        let found = await Spirit.db.deleteMany(Spirit.buildQuery(service, data, parent, id));
-
-        return found.deletedCount;
-    }
-
-    constructor(memory = {}) {
-        this.memory = memory;
-    }
-
-    /**
-     * 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();
-
-        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.
-     * @param {Object} data Data to add to the backup.
-     */
-    addBackup = (data, max = 5) => {
-        this.memory.backups.unshift({
-            _lastUpdate: Date.now(),
-            data: this.memory.data
-        });
-
-        this.memory.data = data;
-
-        if (max > 1) {
-            while (this.memory.backups.length > max) this.memory.backups.pop();
-        }
-
-        this.memory.markModified("backups");
-    }
-};

package/test2/the-front/add-gold.js

@@ -1,14 +0,0 @@
-export default async (req, user, io) => {
-    // let deleted = await req.db.Spirit.delete("gold");
-    let spirit = await req.db.Spirit.recallOrCreateOne("gold");
-    spirit.addBackup({
-        amount: spirit.memory?.data?.amount != null ? spirit.memory.data.amount + 1 : 1
-    });
-    await spirit.commit();
-
-    spirit = await req.db.Spirit.recallOrCreateOne("gold", user.memory._id);
-    spirit.addBackup({
-        amount: spirit.memory?.data?.amount != null ? spirit.memory.data.amount + 1 : 1
-    });
-    await spirit.commit();
-}

package/test2/the-front/check/check.css

@@ -1,3 +0,0 @@
-.flipped {
-    background: black;
-}

package/test2/the-front/check/emailTime.js

@@ -1,10 +0,0 @@
-export default async function emailTime(req, user) {
-    await req.db.SendMail.send(
-        'wyattsushi@gmail.com',
-        'Test',
-        'sdntndtjln l',
-        "NB"
-    );
-
-    return "Sent";
-}

package/test2/the-front/check/flip.js

@@ -1,10 +0,0 @@
-export default async (req, user, io) => {
-    let bigSwitch = await req.db.Spirit.recallOne("big-switch");
-
-    if (!bigSwitch.memory.data.flipped) await bigSwitch.commit({ flipped: true });
-    else await bigSwitch.commit({ flipped: false });
-    console.log(bigSwitch.memory.data);
-
-    io.to("big-switch").emit("big-switch", { flipped: bigSwitch.memory.data.flipped });
-    return "success";
-}

package/test2/the-front/check/index.ejs

@@ -1,55 +0,0 @@
-<style>
-    <%- include("./check.css"); %> 
-</style>
-
-<h1>The Big Check</h1>
-
-<hr>
-
-<button onclick="base.do('add-more-gold')">+3</button>
-<button onclick="base.do('subtract-gold')">-30</button>
-<button onclick="base.do('emailTime', { route: '/the-front/check'})">email</button>
-<button class="switch" onclick="base.do('flip')">Flip Me</button>
-<input type="text" id="test" placeholder="Loading...">
-<button onclick="saveInput()">Save</button>
-
-<hr>
-
-<a href="/the-front">
-    Go to The Front
-</a>
-
-<script>
-    const $inp = $("input#test");
-
-    base.loadAll("test-save3").then((res) => {
-        console.log(res);
-        if (res[0]?.memory.data.text) $inp.attr("placeholder", res[0].memory.data.text);
-        else  $inp.attr("placeholder", "No Input Saved");
-    });
-
-    const saveInput = function saveInput() {
-        let inp = $inp.val();
-
-        base.do("save-input", { 
-            text: inp,
-            route: "/the-front/check"
-         });
-    }
-
-    let switchSocket = io({
-        query: {
-            room: "big-switch",
-            name: "player"
-        }
-    });
-
-    switchSocket.on('big-switch', (update) => {
-        flipSwitch(update.flipped);
-    });
-
-    let flipSwitch = function flipSwitch(flipped) {
-        if (flipped) $(".switch").addClass("flipped");
-        else $(".switch").removeClass("flipped");
-    }
-</script>

package/test2/the-front/check/save-input.js

@@ -1,8 +0,0 @@
-export default async (req, user, io) => {
-    let spirit = await req.db.Spirit.recallOne("test-save3", user.memory._id);
-    // console.log(req.body.text, spirit.memory);
-
-    await spirit.commit({
-        text: req.body.text
-    });
-}