@open-discord-bots/framework 0.0.3 → 0.0.5

package/dist/index.d.ts

@@ -1,4 +1,6 @@
 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

@@ -33,10 +33,13 @@ var __importStar = (this && this.__importStar) || (function () {
     };
 })();
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.loadAllPlugins = exports.loadDumpCommand = exports.utilities = exports.api = void 0;
+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"));
 var dump_1 = require("./startup/dump");
 Object.defineProperty(exports, "loadDumpCommand", { enumerable: true, get: function () { return dump_1.loadDumpCommand; } });
 var pluginLauncher_1 = require("./startup/pluginLauncher");
 Object.defineProperty(exports, "loadAllPlugins", { enumerable: true, get: function () { return pluginLauncher_1.loadAllPlugins; } });
+var compilation_1 = require("./startup/compilation");
+Object.defineProperty(exports, "frameworkStartup", { enumerable: true, get: function () { return compilation_1.frameworkStartup; } });

package/dist/startup/compilation.d.ts

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

package/dist/startup/compilation.js

@@ -0,0 +1,187 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.frameworkStartup = frameworkStartup;
+const fs_1 = __importDefault(require("fs"));
+const typescript_1 = __importDefault(require("typescript"));
+const crypto_1 = require("crypto");
+const path_1 = __importDefault(require("path"));
+const ansis_1 = __importDefault(require("ansis"));
+/** ## What is this?
+ * This is a function which compares `./src/` with a hash stored in `./dist/hash.txt`.
+ * The hash is based on the modified date & file metadata of all files in `./src/`.
+ *
+ * If the hash is different, the bot will automatically re-compile.
+ * This will help you save CPU resources because the bot shouldn't re-compile when nothing has been changed :)
+ */
+function computeSourceHash(dir, upperHash) {
+    const hash = upperHash ? upperHash : (0, crypto_1.createHash)("sha256");
+    const info = fs_1.default.readdirSync(dir, { withFileTypes: true });
+    for (const file of info) {
+        const fullPath = path_1.default.join(dir, file.name);
+        if (file.isFile() && [".js", ".ts", ".jsx", ".tsx"].some((ext) => file.name.endsWith(ext))) {
+            const statInfo = fs_1.default.statSync(fullPath);
+            //compute hash using file metadata
+            const fileInfo = `${fullPath}:${statInfo.size}:${statInfo.mtimeMs}`;
+            hash.update(fileInfo);
+        }
+        else if (file.isDirectory()) {
+            //recursively compute all folders
+            computeSourceHash(fullPath, hash);
+        }
+    }
+    //return when not being called recursively
+    if (!upperHash) {
+        return hash.digest("hex");
+    }
+}
+function requiresCompilation(project) {
+    const logTitle = (project == "openticket") ? "OT" : "OM";
+    //check hashes when not using "--compile-only" flag
+    if (process.argv.includes("--compile-only"))
+        return true;
+    console.log(logTitle + ": Comparing prebuilds with source...");
+    const sourceHash = computeSourceHash("./src/");
+    const pluginHash = computeSourceHash("./plugins/");
+    const hash = sourceHash + ":" + pluginHash;
+    if (fs_1.default.existsSync("./dist/hash.txt")) {
+        const distHash = fs_1.default.readFileSync("./dist/hash.txt").toString();
+        if (distHash === hash)
+            return false;
+        else
+            return true;
+    }
+    else
+        return true;
+}
+function saveNewCompilationHash() {
+    const sourceHash = computeSourceHash("./src/");
+    const pluginHash = computeSourceHash("./plugins/");
+    const hash = sourceHash + ":" + pluginHash;
+    fs_1.default.writeFileSync("./dist/hash.txt", hash);
+}
+function frameworkStartup(startupFlags, project, startCallback) {
+    const logTitle = (project == "openticket") ? "OT" : "OM";
+    //push additional startup flags (for pterodactyl panels)
+    process.argv.push(...startupFlags);
+    //check directory structure
+    const requiredStructures = [
+        "index.js",
+        "./package.json",
+        "./README.md",
+        "./LICENSE.md",
+        "./tsconfig.json",
+        "./src/",
+        "./src/index.ts",
+        "./languages/",
+        "./config/",
+        "./plugins/",
+        "./.github/",
+        "./.github/FUNDING.yml",
+        "./.github/SECURITY.md"
+    ];
+    for (const path of requiredStructures) {
+        if (!fs_1.default.existsSync(path))
+            throw new Error(logTitle + ": Project uses invalid structure for Open Discord! (missing: " + path + ")");
+    }
+    if (!fs_1.default.readFileSync("./.github/FUNDING.yml").toString().startsWith("github: DJj123dj"))
+        throw new Error(logTitle + ": Please do not use this framework in third party bots outside Open Ticket/Moderation! (1)");
+    const readmeContents = fs_1.default.readFileSync("./README.md").toString();
+    if (!readmeContents.includes(`<img src="https://apis.dj-dj.be/cdn/openticket/logo.png" alt="Open Ticket" width="650px">`) &&
+        !readmeContents.includes(`<img src="https://apis.dj-dj.be/cdn/openmoderation/logo.png" alt="Open Moderation" width="650px">`))
+        throw new Error(logTitle + ": Please do not use this framework in third party bots or outside Open Ticket/Moderation! (2)");
+    if (!readmeContents.includes("DJdj Development") || !readmeContents.includes("DJj123dj"))
+        throw new Error(logTitle + ": Please do not use this framework in third party bots or outside Open Ticket/Moderation! (3)");
+    //start compilation
+    if (!process.argv.includes("--no-compile")) {
+        const requiredDependencies = new Set();
+        if (fs_1.default.existsSync("./plugins")) {
+            console.log(logTitle + ": Reading plugin.json files...");
+            for (const pluginDir of fs_1.default.readdirSync("./plugins")) {
+                if (pluginDir === ".DS_Store")
+                    continue;
+                const pluginPath = path_1.default.join("./plugins", pluginDir);
+                if (!fs_1.default.statSync(pluginPath).isDirectory())
+                    continue;
+                const pluginJsonPath = path_1.default.join(pluginPath, "plugin.json");
+                if (fs_1.default.existsSync(pluginJsonPath)) {
+                    try {
+                        const pluginData = JSON.parse(fs_1.default.readFileSync(pluginJsonPath).toString());
+                        if (pluginData.npmDependencies && Array.isArray(pluginData.npmDependencies)) {
+                            pluginData.npmDependencies.forEach((dep) => {
+                                if (typeof dep === "string" && dep.trim()) {
+                                    requiredDependencies.add(dep.trim());
+                                }
+                            });
+                        }
+                    }
+                    catch (err) {
+                        // skip invalid plugin.json files, will be caught later
+                    }
+                }
+            }
+            if (requiredDependencies.size > 0) {
+                console.log(logTitle + ": Checking plugin npm dependencies...");
+                const missingDeps = [];
+                for (const dep of requiredDependencies) {
+                    try {
+                        require.resolve(dep);
+                    }
+                    catch (err) {
+                        missingDeps.push(dep);
+                    }
+                }
+                if (missingDeps.length > 0) {
+                    console.log(ansis_1.default.red(logTitle + ": ❌ Fatal Error --> Missing npm dependencies required by plugins:\n\n") + ansis_1.default.cyan(missingDeps.map((dep) => "  - " + dep).join("\n") + "\n"));
+                    console.log(logTitle + ": Please install missing dependencies using the following command:\n> " + ansis_1.default.bold.green("npm install " + missingDeps.join(" ")) + "\n");
+                    process.exit(1);
+                }
+            }
+        }
+        if (requiresCompilation(project)) {
+            console.log(logTitle + ": Compilation Required...");
+            //REMOVE EXISTING BUILDS
+            console.log(logTitle + ": Removing Prebuilds...");
+            fs_1.default.rmSync("./dist", { recursive: true, force: true });
+            //COMPILE TYPESCRIPT
+            console.log(logTitle + ": Compiling Typescript...");
+            const configPath = path_1.default.resolve('./tsconfig.json');
+            const configFile = typescript_1.default.readConfigFile(configPath, typescript_1.default.sys.readFile);
+            //check for tsconfig errors
+            if (configFile.error) {
+                const message = typescript_1.default.formatDiagnosticsWithColorAndContext([configFile.error], typescript_1.default.createCompilerHost({}));
+                console.error(message);
+                process.exit(1);
+            }
+            //parse tsconfig file
+            const parsedConfig = typescript_1.default.parseJsonConfigFileContent(configFile.config, typescript_1.default.sys, path_1.default.dirname(configPath));
+            //create program/compiler
+            const program = typescript_1.default.createProgram({
+                rootNames: parsedConfig.fileNames,
+                options: parsedConfig.options
+            });
+            //emit all compiled files
+            const emitResult = program.emit();
+            //print emit errors/warnings (type errors)
+            const allDiagnostics = typescript_1.default.getPreEmitDiagnostics(program).concat(emitResult.diagnostics);
+            const formattedDiagnostics = typescript_1.default.formatDiagnosticsWithColorAndContext(allDiagnostics, typescript_1.default.createCompilerHost(parsedConfig.options));
+            console.log(formattedDiagnostics);
+            if (emitResult.emitSkipped || allDiagnostics.find((d) => d.category == typescript_1.default.DiagnosticCategory.Error || d.category == typescript_1.default.DiagnosticCategory.Warning)) {
+                console.log(logTitle + ": Compilation Failed!");
+                process.exit(1);
+            }
+        }
+        else
+            console.log(logTitle + ": No Compilation Required...");
+        //save new compilation hash
+        saveNewCompilationHash();
+    }
+    //START BOT
+    console.log(logTitle + ": Compilation Succeeded!");
+    if (process.argv.includes("--compile-only"))
+        process.exit(0); //exit when no startup is required!
+    console.log(logTitle + ": Starting Bot!");
+    startCallback();
+}

package/dist/startup/pluginLauncher.js

@@ -15,6 +15,7 @@ const loadAllPlugins = async (opendiscord) => {
         return;
     }
     const plugins = fs_1.default.readdirSync("./plugins");
+    const pluginVersionRegex = /^(OT|OM)v(\d+)\.(\d+|x)\.(\d+|x)$/;
     //check & validate
     for (const p of plugins) {
         //prechecks
@@ -44,6 +45,20 @@ const loadAllPlugins = async (opendiscord) => {
                 throw new index_1.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");
+            //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)");
+                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)");
+                    }
+                    //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")`);
+                    }
+                }
+            }
             if (typeof rawplugindata.enabled != "boolean")
                 throw new index_1.api.ODPluginError("Failed to load plugin.json/enabled");
             if (typeof rawplugindata.priority != "number")
@@ -60,6 +75,9 @@ const loadAllPlugins = async (opendiscord) => {
                 throw new index_1.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");
+            //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)");
             if (typeof rawplugindata.details.shortDescription != "string")
                 throw new index_1.api.ODPluginError("Failed to load plugin.json/details/shortDescription");
             if (typeof rawplugindata.details.longDescription != "string")
@@ -105,12 +123,43 @@ const loadAllPlugins = async (opendiscord) => {
     const incompatibilities = [];
     const missingDependencies = [];
     const missingPlugins = [];
+    const versionIncompatibilities = [];
     //go through all plugins for errors
     sortedPlugins.filter((plugin) => plugin.enabled).forEach((plugin) => {
         const from = plugin.id.value;
         plugin.dependenciesInstalled().forEach((missing) => missingDependencies.push({ id: from, missing }));
         plugin.pluginsIncompatible(opendiscord.plugins).forEach((incompatible) => incompatibilities.push({ from, to: incompatible }));
         plugin.pluginsInstalled(opendiscord.plugins).forEach((missing) => missingPlugins.push({ id: from, missing }));
+        //check if plugins are compatible with version of bot
+        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')!");
+            let isCompatible = false;
+            for (const versionStr of plugin.data.supportedVersions) {
+                const match = versionStr.match(pluginVersionRegex);
+                if (!match)
+                    continue;
+                const projectPrefix = match[1];
+                const primary = parseInt(match[2]);
+                const secondary = (match[3] === "x") ? null : parseInt(match[3]);
+                const tertiary = (match[4] === "x") ? null : parseInt(match[4]);
+                if (projectPrefix !== "OT")
+                    continue;
+                else if (primary !== currentVersion.primary)
+                    continue;
+                else if (typeof secondary === "number" && secondary !== currentVersion.secondary)
+                    continue;
+                else if (typeof tertiary === "number" && tertiary !== currentVersion.tertiary)
+                    continue;
+                else {
+                    isCompatible = true;
+                    break;
+                }
+            }
+            if (!isCompatible)
+                versionIncompatibilities.push({ id: from });
+        }
     });
     //handle all incompatibilities
     const alreadyLoggedCompatPlugins = [];
@@ -159,6 +208,20 @@ const loadAllPlugins = async (opendiscord) => {
         ]);
         initPluginError = true;
     });
+    //handle all bot version incompatibilities
+    versionIncompatibilities.forEach((match) => {
+        const plugin = opendiscord.plugins.get(match.id);
+        if (plugin && !plugin.crashed) {
+            plugin.crashed = true;
+            plugin.crashReason = "incompatible.version";
+        }
+        const versions = plugin?.data.supportedVersions?.join(", ") ?? "<unknown-version>";
+        const currentVersion = opendiscord.versions.get("opendiscord:version")?.toString() ?? "<OD:UNKNOWN_VERION>";
+        opendiscord.log(`Plugin version incompatibility: plugin requires "${versions}" but current bot version is "${currentVersion}", canceling plugin execution...`, "plugin", [
+            { key: "path", value: "./plugins/" + match.id }
+        ]);
+        initPluginError = true;
+    });
     //exit on error (when soft mode disabled)
     if (!opendiscord.sharedFuses.getFuse("softPluginLoading") && initPluginError) {
         console.log("");
@@ -181,18 +244,19 @@ const loadAllPlugins = async (opendiscord) => {
         }
     }
     for (const plugin of sortedPlugins) {
+        const authors = [plugin.details.author, ...(plugin.details.contributors ?? [])].join(", ");
         if (plugin.enabled) {
             opendiscord.debug.debug("Plugin \"" + plugin.id.value + "\" loaded", [
                 { key: "status", value: (plugin.crashed ? "crashed" : "success") },
                 { key: "crashReason", value: (plugin.crashed ? (plugin.crashReason ?? "/") : "/") },
-                { key: "author", value: plugin.details.author },
+                { key: "authors", value: authors },
                 { key: "version", value: plugin.version.toString() },
                 { key: "priority", value: plugin.priority.toString() }
             ]);
         }
         else {
             opendiscord.debug.debug("Plugin \"" + plugin.id.value + "\" disabled", [
-                { key: "author", value: plugin.details.author },
+                { key: "authors", value: authors },
                 { key: "version", value: plugin.version.toString() },
                 { key: "priority", value: plugin.priority.toString() }
             ]);

package/package.json

@@ -1,7 +1,7 @@
 {
     "name": "@open-discord-bots/framework",
     "author": "DJj123dj",
-    "version": "0.0.3",
+    "version": "0.0.5",
     "description": "The core framework of the popular open-source discord bots: Open Ticket & Open Moderation.",
     "main": "dist/index.js",
     "module": "dist/index.js",
@@ -9,7 +9,7 @@
         "build": "node ./tools/cleanup.js && tsc -p ./tsconfig.json"
     },
     "keywords": [],
-    "license": "MIT",
+    "license": "GPL-3.0-only",
     "dependencies": {
         "@discordjs/rest": "^2.6.0",
         "@types/terminal-kit": "^2.5.7",

package/src/startup/compilation.ts

@@ -80,11 +80,18 @@ export function frameworkStartup(startupFlags:string[],project:ODProjectType,sta
         "./plugins/",
         "./.github/",
         "./.github/FUNDING.yml",
-        "./.github/SECURITY.yml"
+        "./.github/SECURITY.md"
     ]
     for (const path of requiredStructures){
-        if (!fs.existsSync(path)) throw new Error(logTitle+": Project uses invalid structure for Open Discord! ("+path+")")
+        if (!fs.existsSync(path)) throw new Error(logTitle+": Project uses invalid structure for Open Discord! (missing: "+path+")")
     }
+    if (!fs.readFileSync("./.github/FUNDING.yml").toString().startsWith("github: DJj123dj")) throw new Error(logTitle+": Please do not use this framework in third party bots outside Open Ticket/Moderation! (1)")
+    const readmeContents = fs.readFileSync("./README.md").toString()
+    if (
+        !readmeContents.includes(`<img src="https://apis.dj-dj.be/cdn/openticket/logo.png" alt="Open Ticket" width="650px">`) &&
+        !readmeContents.includes(`<img src="https://apis.dj-dj.be/cdn/openmoderation/logo.png" alt="Open Moderation" width="650px">`)
+    ) throw new Error(logTitle+": Please do not use this framework in third party bots or outside Open Ticket/Moderation! (2)")
+    if (!readmeContents.includes("DJdj Development") || !readmeContents.includes("DJj123dj")) throw new Error(logTitle+": Please do not use this framework in third party bots or outside Open Ticket/Moderation! (3)")
 
     //start compilation
     if (!process.argv.includes("--no-compile")){