@open-discord-bots/framework 0.0.7 → 0.1.0

package/dist/cli/{cli.d.ts → index.d.ts}

@@ -1,4 +1,4 @@
-import { api } from "../index";
+import * as api from "../api/index";
 import { Terminal } from "terminal-kit";
 import * as discord from "discord.js";
 export * from "./editConfig";

package/dist/index.d.ts

@@ -1,6 +1,3 @@
-export * as api from "./api/api";
-export * as utilities from "./api/utils";
-export * as cli from "./cli/cli";
 export { loadDumpCommand } from "./startup/dump";
 export { loadAllPlugins } from "./startup/pluginLauncher";
 export { frameworkStartup } from "./startup/compilation";

package/dist/index.js

@@ -1,42 +1,6 @@
 "use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || (function () {
-    var ownKeys = function(o) {
-        ownKeys = Object.getOwnPropertyNames || function (o) {
-            var ar = [];
-            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
-            return ar;
-        };
-        return ownKeys(o);
-    };
-    return function (mod) {
-        if (mod && mod.__esModule) return mod;
-        var result = {};
-        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
-        __setModuleDefault(result, mod);
-        return result;
-    };
-})();
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.frameworkStartup = exports.loadAllPlugins = exports.loadDumpCommand = exports.cli = exports.utilities = exports.api = void 0;
-exports.api = __importStar(require("./api/api"));
-exports.utilities = __importStar(require("./api/utils"));
-exports.cli = __importStar(require("./cli/cli"));
+exports.frameworkStartup = exports.loadAllPlugins = exports.loadDumpCommand = void 0;
 var dump_1 = require("./startup/dump");
 Object.defineProperty(exports, "loadDumpCommand", { enumerable: true, get: function () { return dump_1.loadDumpCommand; } });
 var pluginLauncher_1 = require("./startup/pluginLauncher");

package/dist/startup/compilation.d.ts

@@ -1,3 +1,3 @@
-import type { ODProjectType } from "../api/api";
+import type { ODProjectType } from "../api";
 export declare function checkFrameworkAllowed(project?: ODProjectType): void;
 export declare function frameworkStartup(startupFlags: string[], project: ODProjectType, startCallback: () => void): void;

package/dist/startup/dump.d.ts

@@ -1,4 +1,4 @@
-import { api } from "../index";
+import * as api from "../api/index";
 /** ### What is this?
  * This is the `!OPENTICKET:dump` command.
  * It's a utility command which can only be used by the creator of Open Discord/Ticket/Moderation or the owner of the bot.

package/dist/startup/dump.js

@@ -34,7 +34,7 @@ var __importStar = (this && this.__importStar) || (function () {
 })();
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.loadDumpCommand = void 0;
-const index_1 = require("../index");
+const api = __importStar(require("../api/index"));
 const discord = __importStar(require("discord.js"));
 const fs = __importStar(require("fs"));
 /** ### What is this?
@@ -52,7 +52,7 @@ const fs = __importStar(require("fs"));
 const loadDumpCommand = (opendiscord) => {
     if (!opendiscord.sharedFuses.getFuse("allowDumpCommand"))
         return;
-    opendiscord.client.textCommands.add(new index_1.api.ODTextCommand("opendiscord:dump", {
+    opendiscord.client.textCommands.add(new api.ODTextCommand("opendiscord:dump", {
         allowBots: false,
         guildPermission: true,
         dmPermission: true,

package/dist/startup/errorHandling.d.ts

@@ -1,2 +1,2 @@
-import { api } from "../index";
+import * as api from "../api/index";
 export declare function loadErrorHandling(opendiscord: api.ODMain, project: api.ODProjectType): void;

package/dist/startup/errorHandling.js

@@ -1,7 +1,40 @@
 "use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.loadErrorHandling = loadErrorHandling;
-const index_1 = require("../index");
+const api = __importStar(require("../api/index"));
 function loadErrorHandling(opendiscord, project) {
     process.on("uncaughtException", async (error, origin) => {
         try {
@@ -26,7 +59,7 @@ function loadErrorHandling(opendiscord, project) {
                 }
                 else {
                     //unknown error
-                    const errmsg = new index_1.api.ODError(error, origin);
+                    const errmsg = new api.ODError(error, origin);
                     opendiscord.log(errmsg);
                     if (opendiscord.sharedFuses.getFuse("crashOnError"))
                         process.exit(1);

package/dist/startup/pluginLauncher.d.ts

@@ -1,2 +1,2 @@
-import { api } from "../index";
+import * as api from "../api/index";
 export declare const loadAllPlugins: (opendiscord: api.ODMain) => Promise<void>;

package/dist/startup/pluginLauncher.js

@@ -1,10 +1,43 @@
 "use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.loadAllPlugins = void 0;
-const index_1 = require("../index");
+const api = __importStar(require("../api/index"));
 const fs_1 = __importDefault(require("fs"));
 const loadAllPlugins = async (opendiscord) => {
     //start launching plugins
@@ -36,64 +69,64 @@ const loadAllPlugins = async (opendiscord) => {
         try {
             const rawplugindata = JSON.parse(fs_1.default.readFileSync("./plugins/" + p + "/plugin.json").toString());
             if (typeof rawplugindata != "object")
-                throw new index_1.api.ODPluginError("Failed to load plugin.json");
+                throw new api.ODPluginError("Failed to load plugin.json");
             if (typeof rawplugindata.id != "string")
-                throw new index_1.api.ODPluginError("Failed to load plugin.json/id");
+                throw new api.ODPluginError("Failed to load plugin.json/id");
             if (typeof rawplugindata.name != "string")
-                throw new index_1.api.ODPluginError("Failed to load plugin.json/name");
+                throw new api.ODPluginError("Failed to load plugin.json/name");
             if (typeof rawplugindata.version != "string")
-                throw new index_1.api.ODPluginError("Failed to load plugin.json/version");
+                throw new api.ODPluginError("Failed to load plugin.json/version");
             if (typeof rawplugindata.startFile != "string")
-                throw new index_1.api.ODPluginError("Failed to load plugin.json/startFile");
+                throw new api.ODPluginError("Failed to load plugin.json/startFile");
             //only check "supportedVersions" if it exists (should be array)
             if (rawplugindata.supportedVersions) {
                 if (!Array.isArray(rawplugindata.supportedVersions))
-                    throw new index_1.api.ODPluginError("Failed to load plugin.json/supportedVersions (must be array)");
+                    throw new api.ODPluginError("Failed to load plugin.json/supportedVersions (must be array)");
                 for (const version of rawplugindata.supportedVersions) {
                     if (typeof version !== "string") {
-                        throw new index_1.api.ODPluginError("Failed to load plugin.json/supportedVersions (all items must be strings)");
+                        throw new api.ODPluginError("Failed to load plugin.json/supportedVersions (all items must be strings)");
                     }
                     //only OT (Open Ticket) & OM (Open Moderation) are supported at the moment
                     if (!pluginVersionRegex.test(version)) {
-                        throw new index_1.api.ODPluginError(`Failed to load plugin.json/supportedVersions (invalid format: "${version}", expected format like "OTv4.0.x" or "OMv1.0.0")`);
+                        throw new api.ODPluginError(`Failed to load plugin.json/supportedVersions (invalid format: "${version}", expected format like "OTv4.0.x" or "OMv1.0.0")`);
                     }
                 }
             }
             if (typeof rawplugindata.enabled != "boolean")
-                throw new index_1.api.ODPluginError("Failed to load plugin.json/enabled");
+                throw new api.ODPluginError("Failed to load plugin.json/enabled");
             if (typeof rawplugindata.priority != "number")
-                throw new index_1.api.ODPluginError("Failed to load plugin.json/priority");
+                throw new api.ODPluginError("Failed to load plugin.json/priority");
             if (!Array.isArray(rawplugindata.events))
-                throw new index_1.api.ODPluginError("Failed to load plugin.json/events");
+                throw new api.ODPluginError("Failed to load plugin.json/events");
             if (!Array.isArray(rawplugindata.npmDependencies))
-                throw new index_1.api.ODPluginError("Failed to load plugin.json/npmDependencies");
+                throw new api.ODPluginError("Failed to load plugin.json/npmDependencies");
             if (!Array.isArray(rawplugindata.requiredPlugins))
-                throw new index_1.api.ODPluginError("Failed to load plugin.json/requiredPlugins");
+                throw new api.ODPluginError("Failed to load plugin.json/requiredPlugins");
             if (!Array.isArray(rawplugindata.incompatiblePlugins))
-                throw new index_1.api.ODPluginError("Failed to load plugin.json/incompatiblePlugins");
+                throw new api.ODPluginError("Failed to load plugin.json/incompatiblePlugins");
             if (typeof rawplugindata.details != "object")
-                throw new index_1.api.ODPluginError("Failed to load plugin.json/details");
+                throw new api.ODPluginError("Failed to load plugin.json/details");
             if (typeof rawplugindata.details.author != "string")
-                throw new index_1.api.ODPluginError("Failed to load plugin.json/details/author");
+                throw new api.ODPluginError("Failed to load plugin.json/details/author");
             //only check "contributors" if it exists (should be array)
             if (rawplugindata.details.contributors && !Array.isArray(rawplugindata.details.contributors))
-                throw new index_1.api.ODPluginError("Failed to load plugin.json/details/contributors (must be array)");
+                throw new api.ODPluginError("Failed to load plugin.json/details/contributors (must be array)");
             if (typeof rawplugindata.details.shortDescription != "string")
-                throw new index_1.api.ODPluginError("Failed to load plugin.json/details/shortDescription");
+                throw new api.ODPluginError("Failed to load plugin.json/details/shortDescription");
             if (typeof rawplugindata.details.longDescription != "string")
-                throw new index_1.api.ODPluginError("Failed to load plugin.json/details/longDescription");
+                throw new api.ODPluginError("Failed to load plugin.json/details/longDescription");
             if (typeof rawplugindata.details.imageUrl != "string")
-                throw new index_1.api.ODPluginError("Failed to load plugin.json/details/imageUrl");
+                throw new api.ODPluginError("Failed to load plugin.json/details/imageUrl");
             if (typeof rawplugindata.details.projectUrl != "string")
-                throw new index_1.api.ODPluginError("Failed to load plugin.json/details/projectUrl");
+                throw new api.ODPluginError("Failed to load plugin.json/details/projectUrl");
             if (!Array.isArray(rawplugindata.details.tags))
-                throw new index_1.api.ODPluginError("Failed to load plugin.json/details/tags");
+                throw new api.ODPluginError("Failed to load plugin.json/details/tags");
             if (rawplugindata.id != p)
-                throw new index_1.api.ODPluginError("Failed to load plugin, directory name is required to match the id");
+                throw new api.ODPluginError("Failed to load plugin, directory name is required to match the id");
             if (opendiscord.plugins.exists(rawplugindata.id))
-                throw new index_1.api.ODPluginError("Failed to load plugin, this id already exists in another plugin");
+                throw new api.ODPluginError("Failed to load plugin, this id already exists in another plugin");
             //plugin.json is valid => load plugin
-            const plugin = new index_1.api.ODPlugin(p, rawplugindata);
+            const plugin = new api.ODPlugin(p, rawplugindata);
             opendiscord.plugins.add(plugin);
         }
         catch (e) {
@@ -134,7 +167,7 @@ const loadAllPlugins = async (opendiscord) => {
         if (plugin.data.supportedVersions && plugin.data.supportedVersions.length > 0) {
             const currentVersion = opendiscord.versions.get("opendiscord:version");
             if (!currentVersion)
-                throw new index_1.api.ODSystemError("Unable to get project version: opendiscord.versions.get('opendiscord:version')!");
+                throw new api.ODSystemError("Unable to get project version: opendiscord.versions.get('opendiscord:version')!");
             let isCompatible = false;
             for (const versionStr of plugin.data.supportedVersions) {
                 const match = versionStr.match(pluginVersionRegex);
@@ -231,7 +264,7 @@ const loadAllPlugins = async (opendiscord) => {
     //preload all events required for every plugin
     for (const plugin of sortedPlugins) {
         if (plugin.enabled)
-            plugin.data.events.forEach((event) => opendiscord.events.add(new index_1.api.ODEvent(event)));
+            plugin.data.events.forEach((event) => opendiscord.events.add(new api.ODEvent(event)));
     }
     //execute all working plugins
     for (const plugin of sortedPlugins) {

package/dist/{api/utils.d.ts → utilities/index.d.ts}

@@ -1,4 +1,4 @@
-import * as api from "./api";
+import * as api from "../api/index";
 /**## sharedFuses `utility variable`
  * All shared fuses from Open Discord. Please use `opendiscord.sharedFuses` instead!
  */

package/dist/{api/utils.js → utilities/index.js}

@@ -51,7 +51,7 @@ exports.ordinalNumber = ordinalNumber;
 exports.trimEmojis = trimEmojis;
 const fs = __importStar(require("fs"));
 const ansis_1 = __importDefault(require("ansis"));
-const api = __importStar(require("./api"));
+const api = __importStar(require("../api/index"));
 /**## sharedFuses `utility variable`
  * All shared fuses from Open Discord. Please use `opendiscord.sharedFuses` instead!
  */

package/package.json

@@ -1,7 +1,7 @@
 {
     "name": "@open-discord-bots/framework",
     "author": "DJj123dj",
-    "version": "0.0.7",
+    "version": "0.1.0",
     "description": "The core framework of the popular open-source discord bots: Open Ticket & Open Moderation.",
     "main": "dist/index.js",
     "module": "dist/index.js",
@@ -25,5 +25,10 @@
     },
     "publishConfig": {
         "access": "public"
+    },
+    "exports": {
+        ".": "./dist/index.js",
+        "./api": "./dist/api/index.js",
+        "./utilities": "./dist/utilities/index.js"
     }
 }

package/src/api/modules/console.ts

@@ -592,16 +592,16 @@ export class ODLiveStatusManager extends ODManager<ODLiveStatusSource> {
     /**The class responsible for rendering the livestatus messages. */
     renderer: ODLiveStatusRenderer
     /**A reference to the ODMain or "opendiscord" global variable */
-    #main: ODMain
+    #main: ODMain|null = null
 
-    constructor(debug:ODDebugger, main:ODMain){
+    constructor(debug:ODDebugger,console:ODConsoleManager){
         super(debug,"livestatus source")
-        this.renderer = new ODLiveStatusRenderer(main.console)
-        this.#main = main
+        this.renderer = new ODLiveStatusRenderer(console)
     }
 
     /**Get the messages from all sources combined! */
     async getAllMessages(): Promise<ODLiveStatusSourceData[]> {
+        if (!this.#main) throw new ODSystemError("ODLiveStatusManager:getAllMessages() --> Unable to get messages, 'opendiscord/ODMain' has not been connected!")
         const messages: ODLiveStatusSourceData[] = []
         for (const source of this.getAll()){
             try {
@@ -610,6 +610,10 @@ export class ODLiveStatusManager extends ODManager<ODLiveStatusSource> {
         }
         return messages
     }
+    /**Set the opendiscord `ODMain` class to use for fetching message filters. */
+    useMain(main:ODMain){
+        this.#main = main
+    }
 }
 
 /**## ODLiveStatusRenderer `class`

package/src/cli/editConfig.ts

@@ -1,7 +1,8 @@
-import {api, utilities} from "../index"
+import * as api from "../api/index"
+import * as utilities from "../utilities/index"
 import {Terminal, terminal} from "terminal-kit"
 import ansis from "ansis"
-import {ODCliHeaderOpts, renderHeader} from "./cli"
+import {ODCliHeaderOpts, renderHeader} from "."
 
 export class ODCliEditConfigInstance {
     private readonly opts: ODCliHeaderOpts

package/src/cli/{cli.ts → index.ts}

@@ -1,4 +1,5 @@
-import {api, utilities} from "../index"
+import * as api from "../api/index"
+import * as utilities from "../utilities/index"
 import {Terminal, terminal} from "terminal-kit"
 import * as discord from "discord.js"
 import ansis from "ansis"

package/src/index.ts

@@ -1,7 +1,3 @@
-
-export * as api from "./api/api"
-export * as utilities from "./api/utils"
-export * as cli from "./cli/cli"
 export { loadDumpCommand } from "./startup/dump"
 export { loadAllPlugins } from "./startup/pluginLauncher"
 export { frameworkStartup } from "./startup/compilation"

package/src/startup/compilation.ts

@@ -3,7 +3,7 @@ import ts from "typescript"
 import { createHash, Hash } from "crypto"
 import nodepath from "path"
 import ansis from "ansis"
-import type { ODProjectType } from "../api/api"
+import type { ODProjectType } from "../api"
 
 /** ## What is this?
  * This is a function which compares `./src/` with a hash stored in `./dist/hash.txt`.

package/src/startup/dump.ts

@@ -1,4 +1,5 @@
-import {api, utilities} from "../index"
+import * as api from "../api/index"
+import * as utilities from "../utilities/index"
 import * as discord from "discord.js"
 import * as fs from "fs"
 

package/src/startup/errorHandling.ts

@@ -1,4 +1,5 @@
-import {api, utilities} from "../index"
+import * as api from "../api/index"
+import * as utilities from "../utilities/index"
 
 export function loadErrorHandling(opendiscord:api.ODMain,project:api.ODProjectType){
     process.on("uncaughtException",async (error,origin) => {

package/src/startup/pluginLauncher.ts

@@ -1,4 +1,5 @@
-import {api, utilities} from "../index"
+import * as api from "../api/index"
+import * as utilities from "../utilities/index"
 import fs from "fs"
 
 export const loadAllPlugins = async (opendiscord:api.ODMain) => {

package/src/{api/utils.ts → utilities/index.ts}

@@ -1,6 +1,6 @@
 import * as fs from "fs"
 import ansis from "ansis"
-import * as api from "./api"
+import * as api from "../api/index"
 
 /**## sharedFuses `utility variable`
  * All shared fuses from Open Discord. Please use `opendiscord.sharedFuses` instead!