Merge pull request #125 from JsSucks/external-modules

External modules

client/src/modules/contentmanager.js

@@ -153,7 +153,7 @@ export default class {
                 mainPath
             }
 
-            const content = await this.loadContent(paths, configs, readConfig.info, readConfig.main);
+            const content = await this.loadContent(paths, configs, readConfig.info, readConfig.main, readConfig.type);
             if (reload) this.localContent[index] = content;
             else this.localContent.push(content);
             return content;

client/src/modules/plugin.js

@@ -20,6 +20,7 @@ export default class {
         this.stop = this.stop.bind(this);
     }
 
+    get type() { return 'plugin' }
     get configs() { return this.__pluginInternals.configs }
     get info() { return this.__pluginInternals.info }
     get icon() { return this.info.icon }

client/src/modules/pluginapi.js

@@ -99,4 +99,10 @@ export default class PluginApi {
         return plugin.exports;
     }
 
+    import(m) {
+        const module = PluginManager.findPlugin(m);
+        if (module && module.__require) return module.__require;
+        return null;
+    }
+
 }

client/src/modules/pluginmanager.js

@@ -15,6 +15,32 @@ import Vendor from './vendor';
 import { ClientLogger as Logger } from 'common';
 import { Events } from 'modules';
 
+class Module {
+
+    constructor(pluginInternals) {
+        this.__pluginInternals = pluginInternals;
+        this.__require = window.require(this.paths.mainPath);
+        this.hasSettings = false;
+    }
+
+    get type() { return 'module' }
+    get configs() { return this.__pluginInternals.configs }
+    get info() { return this.__pluginInternals.info }
+    get icon() { return this.info.icon }
+    get paths() { return this.__pluginInternals.paths }
+    get main() { return this.__pluginInternals.main }
+    get defaultConfig() { return this.configs.defaultConfig }
+    get userConfig() { return this.configs.userConfig }
+    get id() { return this.info.id || this.info.name.replace(/[^a-zA-Z0-9-]/g, '-').replace(/--/g, '-') }
+    get name() { return this.info.name }
+    get authors() { return this.info.authors }
+    get version() { return this.info.version }
+    get pluginPath() { return this.paths.contentPath }
+    get dirName() { return this.paths.dirName }
+    get enabled() { return true }
+    get pluginConfig() { return this.userConfig.config || [] }
+}
+
 export default class extends ContentManager {
 
     static get localPlugins() {
@@ -33,15 +59,24 @@ export default class extends ContentManager {
         return 'plugins';
     }
 
-    static get loadAllPlugins() { return this.loadAllContent }
+    static async loadAllPlugins() {
+        const loadAll = await this.loadAllContent();
+        this.localPlugins.forEach(plugin => {
+            if (plugin.type === 'module') return;
+            if (plugin.enabled) plugin.start();
+        });
+
+        return loadAll;
+    }
     static get refreshPlugins() { return this.refreshContent }
 
     static get loadContent() { return this.loadPlugin }
-    static async loadPlugin(paths, configs, info, main) {
-        const plugin = window.require(paths.mainPath)(Plugin, new PluginApi(info), Vendor);
-        const instance = new plugin({ configs, info, main, paths: { contentPath: paths.contentPath, dirName: paths.dirName } });
+    static async loadPlugin(paths, configs, info, main, type) {
 
-        if (instance.enabled) instance.start();
+        if (type === 'module') return new Module({ configs, info, main, paths: { contentPath: paths.contentPath, dirName: paths.dirName, mainPath: paths.mainPath } });
+
+        const plugin = window.require(paths.mainPath)(Plugin, new PluginApi(info), Vendor);
+        const instance = new plugin({ configs, info, main, paths: { contentPath: paths.contentPath, dirName: paths.dirName, mainPath: paths.mainPath } });
         return instance;
     }
 

client/src/ui/components/bd/PluginCard.vue

@@ -10,7 +10,7 @@
 
 <template>
     <Card :item="plugin">
-        <SettingSwitch slot="toggle" :checked="plugin.enabled" :change="() => plugin.enabled ? plugin.stop() : plugin.start()" />
+        <SettingSwitch v-if="plugin.type === 'plugin'" slot="toggle" :checked="plugin.enabled" :change="() => plugin.enabled ? plugin.stop() : plugin.start()" />
         <ButtonGroup slot="controls">
             <Button v-tooltip="'Settings'" v-if="plugin.hasSettings" :onClick="() => showSettings(plugin)">
                 <MiSettings size="18" />

tests/plugins/Example 2/config.json

@@ -5,6 +5,7 @@
     "version": 1.0,
     "description": "Example Plugin 2 Description"
   },
-  "main": "index.js",
+    "main": "index.js",
+    "type":  "plugin", 
     "defaultConfig": []
 }

tests/plugins/Example Module/config.json

@@ -0,0 +1,10 @@
+{
+    "info": {
+        "name": "Example Module",
+        "authors": [ "Jiiks" ],
+        "version": 1.0,
+        "description": "Module Example"
+    },
+    "main": "index.js",
+    "type":  "module" 
+}

tests/plugins/Example Module/index.js

@@ -0,0 +1,14 @@
+module.exports = class {
+
+    constructor() {
+    }
+
+    get foo() {
+        return 'Bar';
+    }
+
+    add(i1, i2) {
+        return i1 + i2;
+    }
+
+}

tests/plugins/Example/config.json

@@ -8,6 +8,7 @@
         "icon": "data:image/svg+xml;base64,PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0idXRmLTgiPz48IURPQ1RZUEUgc3ZnIFBVQkxJQyAiLS8vVzNDLy9EVEQgU1ZHIDEuMS8vRU4iICJodHRwOi8vd3d3LnczLm9yZy9HcmFwaGljcy9TVkcvMS4xL0RURC9zdmcxMS5kdGQiPjxzdmcgdmVyc2lvbj0iMS4xIiBpZD0iQ2FscXVlXzEiIHhtbG5zPSJodHRwOi8vd3d3LnczLm9yZy8yMDAwL3N2ZyIgeG1sbnM6eGxpbms9Imh0dHA6Ly93d3cudzMub3JnLzE5OTkveGxpbmsiIHg9IjBweCIgeT0iMHB4IiB2aWV3Qm94PSIwIDAgMjAwMCAyMDAwIiBlbmFibGUtYmFja2dyb3VuZD0ibmV3IDAgMCAyMDAwIDIwMDAiIHhtbDpzcGFjZT0icHJlc2VydmUiPjxnPjxwYXRoIGZpbGw9IiMzRTgyRTUiIGQ9Ik0xNDAyLjIsNjMxLjdjLTkuNy0zNTMuNC0yODYuMi00OTYtNjQyLjYtNDk2SDY4LjR2NzE0LjFsNDQyLDM5OFY0OTAuN2gyNTdjMjc0LjUsMCwyNzQuNSwzNDQuOSwwLDM0NC45SDU5Ny42djMyOS41aDE2OS44YzI3NC41LDAsMjc0LjUsMzQ0LjgsMCwzNDQuOGgtNjk5djM1NC45aDY5MS4yYzM1Ni4zLDAsNjMyLjgtMTQyLjYsNjQyLjYtNDk2YzAtMTYyLjYtNDQuNS0yODQuMS0xMjIuOS0zNjguNkMxMzU3LjcsOTE1LjgsMTQwMi4yLDc5NC4zLDE0MDIuMiw2MzEuN3oiLz48cGF0aCBmaWxsPSIjRkZGRkZGIiBkPSJNMTI2Mi41LDEzNS4yTDEyNjIuNSwxMzUuMmwtNzYuOCwwYzI2LjYsMTMuMyw1MS43LDI4LjEsNzUsNDQuM2M3MC43LDQ5LjEsMTI2LjEsMTExLjUsMTY0LjYsMTg1LjNjMzkuOSw3Ni42LDYxLjUsMTY1LjYsNjQuMywyNjQuNmwwLDEuMnYxLjJjMCwxNDEuMSwwLDU5Ni4xLDAsNzM3LjF2MS4ybDAsMS4yYy0yLjcsOTktMjQuMywxODgtNjQuMywyNjQuNmMtMzguNSw3My44LTkzLjgsMTM2LjItMTY0LjYsMTg1LjNjLTIyLjYsMTUuNy00Ni45LDMwLjEtNzIuNiw0My4xaDcyLjVjMzQ2LjIsMS45LDY3MS0xNzEuMiw2NzEtNTY3LjlWNzE2LjdDMTkzMy41LDMxMi4yLDE2MDguNywxMzUuMiwxMjYyLjUsMTM1LjJ6Ii8+PC9nPjwvc3ZnPg=="
     },
     "main": "index.js",
+    "type": "plugin", 
     "defaultConfig": [
         {
             "category_default_comment": "default category has no header and is always displayed first",

tests/plugins/Example/index.js

@@ -8,6 +8,9 @@ module.exports = (Plugin, Api, Vendor) => {
             Events.subscribe('TEST_EVENT', this.eventTest);
             Logger.log('onStart');
             Logger.log(`Setting "default-0" value: ${this.getSetting('default-0')}`);
+
+            const exampleModule = new (Api.import('Example Module'));
+            Logger.log(`2+4=${exampleModule.add(2, 4)}`);
             return true;
         }