notherbase-fs 4.0.22 → 4.0.23

package/models/index.js

@@ -1,34 +1,34 @@
-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, { 
-        useNewUrlParser: true,
-        useUnifiedTopology: true
-    });
-}
-catch (err) {
-    console.log(`Mongoose on connect: ${err}`);
-}
-
-export default {
-    SendMail: SendMail,
-    Spirit: Spirit
+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, { 
+        useNewUrlParser: true,
+        useUnifiedTopology: true
+    });
+}
+catch (err) {
+    console.log(`Mongoose on connect: ${err}`);
+}
+
+export default {
+    SendMail: SendMail,
+    Spirit: Spirit
 }

package/models/send-mail.js

@@ -1,59 +1,59 @@
-import dotenv from "dotenv";
-dotenv.config();
-import nodemailer from "nodemailer";
-import { google } from "googleapis";
-
-const OAuth2 = google.auth.OAuth2;
-const OAuth2Client = new OAuth2(process.env.CLIENTID, process.env.CLIENTSECRET);
-OAuth2Client.setCredentials({ refresh_token: process.env.CLIENTREFRESH });
-
-
-/**
- * Sends an email with a password reset code. WIP
- * @param {String} toEmail Email address to send to.
- * @param {Number} resetToken Token to reset by.
- */
-const passwordReset = async (toEmail, resetToken) => {
-    return await send(toEmail, 'Password Reset for NotherBase', 
-        `<h1>Your One-Time Password Reset Code:<h1>
-        <h2>${resetToken}<h2>
-        <p>Visit <a href="https://www.notherbase.com/the-front/keeper">notherbase.com/the-front/keeper</a> to finish changing your password.</p>`);
-};
-
-/**
- * Sends an email. WIP
- * @param {String} toEmail Email Address to send to.
- * @param {String} subject Subject of the email.   
- * @param {String} html Body of the email.
- * @returns 
- */
-const send = async (toEmail, subject, html, name = "NotherBase") => {
-    let accessToken = OAuth2Client.getAccessToken();
-
-    let transporter = nodemailer.createTransport({
-        service: 'gmail',
-        auth: {
-            type: 'OAuth2',
-            user: process.env.NOREPLY,
-            clientId: process.env.CLIENTID,
-            clientSecret: process.env.CLIENTSECRET,
-            refreshToken: process.env.CLIENTREFRESH,
-            accessToken: accessToken
-        }
-    });
-
-    let mailOptions = {
-        from: name + " <" + process.env.NOREPLY +">",
-        to: toEmail,
-        subject: subject,
-        html: html
-    };
-    
-    let sent = await transporter.sendMail(mailOptions, function(error, info){
-        if (error) console.log(error);
-    });
-
-    return sent;
-}
-
+import dotenv from "dotenv";
+dotenv.config();
+import nodemailer from "nodemailer";
+import { google } from "googleapis";
+
+const OAuth2 = google.auth.OAuth2;
+const OAuth2Client = new OAuth2(process.env.CLIENTID, process.env.CLIENTSECRET);
+OAuth2Client.setCredentials({ refresh_token: process.env.CLIENTREFRESH });
+
+
+/**
+ * Sends an email with a password reset code. WIP
+ * @param {String} toEmail Email address to send to.
+ * @param {Number} resetToken Token to reset by.
+ */
+const passwordReset = async (toEmail, resetToken) => {
+    return await send(toEmail, 'Password Reset for NotherBase', 
+        `<h1>Your One-Time Password Reset Code:<h1>
+        <h2>${resetToken}<h2>
+        <p>Visit <a href="https://www.notherbase.com/the-front/keeper">notherbase.com/the-front/keeper</a> to finish changing your password.</p>`);
+};
+
+/**
+ * Sends an email. WIP
+ * @param {String} toEmail Email Address to send to.
+ * @param {String} subject Subject of the email.   
+ * @param {String} html Body of the email.
+ * @returns 
+ */
+const send = async (toEmail, subject, html, name = "NotherBase") => {
+    let accessToken = OAuth2Client.getAccessToken();
+
+    let transporter = nodemailer.createTransport({
+        service: 'gmail',
+        auth: {
+            type: 'OAuth2',
+            user: process.env.NOREPLY,
+            clientId: process.env.CLIENTID,
+            clientSecret: process.env.CLIENTSECRET,
+            refreshToken: process.env.CLIENTREFRESH,
+            accessToken: accessToken
+        }
+    });
+
+    let mailOptions = {
+        from: name + " <" + process.env.NOREPLY +">",
+        to: toEmail,
+        subject: subject,
+        html: html
+    };
+    
+    let sent = await transporter.sendMail(mailOptions, function(error, info){
+        if (error) console.log(error);
+    });
+
+    return sent;
+}
+
 export default { passwordReset, send };

package/models/spirit.js

@@ -1,235 +1,235 @@
-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");
-    }
+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");
+    }
 };