@open-discord-bots/framework 0.0.3 → 0.0.5

package/README.md

@@ -1,8 +1,8 @@
 <p align="center">
-<img src="https://apis.dj-dj.be/cdn/opendiscord/logo.png" alt="Open Ticket" width="650px"><br>
+<img src="https://apis.dj-dj.be/cdn/opendiscord/logo.png" alt="Open Discord Logo" width="650px"><br>
 <span align="center"><b>A modular framework for the next-generation of Discord bots</b></span><br><br>
-<a href="https://otgithub.dj-dj.be"><img src="https://apis.dj-dj.be/cdn/openticket/logo.png" alt="Open Ticket" height="55px"></a>
-<a href="https://otgithub.dj-dj.be"><img src="https://apis.dj-dj.be/cdn/openmoderation/logo.png" alt="Open Moderation" height="60px"></a><br><br>
+<a href="https://otgithub.dj-dj.be"><img src="https://apis.dj-dj.be/cdn/openticket/logo.png" alt="Open Ticket Logo" height="55px"></a>
+<a href="https://otgithub.dj-dj.be"><img src="https://apis.dj-dj.be/cdn/openmoderation/logo.png" alt="Open Moderation Logo" height="60px"></a><br><br>
 <a href="https://discord.com/invite/26vT9wt3n3"><img alt="Discord Invite Link" src="https://img.shields.io/badge/discord-support%20server-5865F2.svg?style=flat-square&logo=discord"></img></a>
 <a href="https://github.com/open-discord-bots/plugins/blob/main/LICENSE"><img alt="Open Discord Plugins License" src="https://img.shields.io/badge/license-MIT-important.svg?style=flat-square"></img></a>
 <a href="https://discord.dj-dj.be"><img alt="Open Discord Plugins Stars" src="https://img.shields.io/github/stars/open-discord-bots/framework?color=yellow&label=stars&logo=github&style=flat-square"></img></a>

package/dist/api/modules/plugin.d.ts

@@ -39,6 +39,11 @@ export interface ODPluginData {
     version: string;
     /**The location of the start file of the plugin relative to the rootDir of the plugin */
     startFile: string;
+    /**A list of compatible versions. (e.g. `["OTv4.0.x", "OMv1.x.x"]`) (optional, will be required in future version)
+     * - `OT` --> Open Ticket support
+     * - `OM` --> Open Moderation support
+     */
+    supportedVersions?: string[];
     /**Is this plugin enabled? */
     enabled: boolean;
     /**The priority of this plugin. Higher priority will load before lower priority. */
@@ -58,8 +63,10 @@ export interface ODPluginData {
  * Additional details in the `plugin.json` file from a plugin.
  */
 export interface ODPluginDetails {
-    /**The author of the plugin. */
+    /**The main author of the plugin. Additional contributors can be specified in `contributors`. */
     author: string;
+    /**A list of plugin contributors. (optional, will be required in future version) */
+    contributors?: string[];
     /**A short description of this plugin. */
     shortDescription: string;
     /**A large description of this plugin. */
@@ -100,7 +107,7 @@ export declare class ODPlugin extends ODManagerData {
     /**Did this plugin crash? (A reason is available in the `crashReason`) */
     crashed: boolean;
     /**The reason which caused this plugin to crash. */
-    crashReason: null | "incompatible.plugin" | "missing.plugin" | "missing.dependency" | "executed";
+    crashReason: null | "incompatible.plugin" | "missing.plugin" | "missing.dependency" | "incompatible.version" | "executed";
     constructor(dir: string, jsondata: ODPluginData);
     /**Get the startfile location relative to the `./plugins/` directory. (`./dist/plugins/`) when compiled) */
     getStartFile(): string;
@@ -112,6 +119,8 @@ export declare class ODPlugin extends ODManagerData {
     pluginsInstalled(manager: ODPluginManager): string[];
     /**Get a list of all enabled incompatible plugins that interfere with this plugin. */
     pluginsIncompatible(manager: ODPluginManager): string[];
+    /**Get a list of all authors & contributors of this plugin. */
+    getAuthors(): string[];
 }
 /**## ODPluginClassManager `class`
  * This is an Open Discord plugin class manager.

package/dist/api/modules/plugin.js

@@ -148,6 +148,10 @@ class ODPlugin extends base_1.ODManagerData {
         });
         return incompatible;
     }
+    /**Get a list of all authors & contributors of this plugin. */
+    getAuthors() {
+        return [this.details.author, ...(this.details.contributors ?? [])];
+    }
 }
 exports.ODPlugin = ODPlugin;
 /**## ODPluginClassManager `class`

package/dist/cli/cli.d.ts

@@ -0,0 +1,35 @@
+import { api } from "../index";
+import { Terminal } from "terminal-kit";
+import * as discord from "discord.js";
+export * from "./editConfig";
+/**## ODCliHeaderOpts `interface`
+ * All metadata required for rendering the Interactive Setup CLI header.
+ */
+export interface ODCliHeaderOpts {
+    /**The main logo to display (multiple lines splitted in string array). */
+    logo: string[];
+    /**The main color of the project. */
+    projectColor: discord.HexColorString;
+    /**The version of the project. */
+    projectVersion: api.ODVersion;
+    /**The name of the project in display style (e.g. `Open Ticket`) */
+    projectName: string;
+}
+/**## ODCliStartFunction `type`
+ * A function used to start a sub-system of the interactive setup CLI.
+ */
+export type ODCliStartFunction = (backFn: () => api.ODPromiseVoid) => Promise<void>;
+/**A utility function to center text to a certain width. */
+export declare function centerText(text: string, width: number): string;
+/**A utility function to terminate the interactive CLI. */
+export declare function terminate(opts: ODCliHeaderOpts): Promise<void>;
+/**A utility function generate a unique config ID based on a user-named input. */
+export declare function generateUniqueIdFromName(name: string): string;
+/**Render the header of the interactive setup CLI. */
+export declare function renderHeader(opts: ODCliHeaderOpts, path: (string | number)[] | string): void;
+/**Execute/start the Interactive Setup CLI. Make sure no other processes disturb the flow. */
+export declare function execute(opts: ODCliHeaderOpts, renderEditConfig: ODCliStartFunction | null, renderQuickSetup: ODCliStartFunction | null): Promise<void>;
+/**A basic style template for select menu's in the interactive setup CLI. */
+export declare const autoCompleteMenuOpts: Terminal.SingleLineMenuOptions;
+/**A set of preset colors to be used when auto-filling colors in the interactive setup CLI. */
+export declare const presetColors: Map<string, string>;

package/dist/cli/cli.js

@@ -0,0 +1,157 @@
+"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 __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.presetColors = exports.autoCompleteMenuOpts = void 0;
+exports.centerText = centerText;
+exports.terminate = terminate;
+exports.generateUniqueIdFromName = generateUniqueIdFromName;
+exports.renderHeader = renderHeader;
+exports.execute = execute;
+const terminal_kit_1 = require("terminal-kit");
+const ansis_1 = __importDefault(require("ansis"));
+const crypto_1 = __importDefault(require("crypto"));
+__exportStar(require("./editConfig"), exports);
+/**A utility function to center text to a certain width. */
+function centerText(text, width) {
+    if (width < text.length)
+        return text;
+    let newWidth = width - ansis_1.default.strip(text).length + 1;
+    let final = " ".repeat(newWidth / 2) + text;
+    return final;
+}
+/**A utility function to terminate the interactive CLI. */
+async function terminate(opts) {
+    terminal_kit_1.terminal.grabInput(false);
+    terminal_kit_1.terminal.clear();
+    terminal_kit_1.terminal.green("👋 Exited the " + opts.projectName + " Interactive Setup CLI.\n");
+    process.exit(0);
+}
+/**A utility function generate a unique config ID based on a user-named input. */
+function generateUniqueIdFromName(name) {
+    //id only allows a-z, 0-9 & dash characters (& replace spaces with dashes)
+    const filteredChars = name.toLowerCase().replaceAll(" ", "-").split("").filter((ch) => /^[a-zA-Z0-9-]{1}$/.test(ch));
+    const randomSuffix = "-" + crypto_1.default.randomBytes(4).toString("hex");
+    return filteredChars.join("") + randomSuffix;
+}
+/**Render the header of the interactive setup CLI. */
+function renderHeader(opts, path) {
+    terminal_kit_1.terminal.grabInput(true);
+    terminal_kit_1.terminal.clear().moveTo(1, 1);
+    (0, terminal_kit_1.terminal)(ansis_1.default.hex("#f8ba00")(opts.logo.join("\n") + "\n"));
+    terminal_kit_1.terminal.bold(centerText("Interactive Setup CLI  -  Version: " + opts.projectVersion.toString() + "  -  Support: https://discord.dj-dj.be\n", 88));
+    if (typeof path == "string")
+        terminal_kit_1.terminal.cyan(centerText(path + "\n\n", 88));
+    else if (path.length < 1)
+        terminal_kit_1.terminal.cyan(centerText("👋 Hi! Welcome to the " + opts.projectName + " Interactive Setup CLI! 👋\n\n", 88));
+    else
+        terminal_kit_1.terminal.cyan(centerText("🌐 Current Location: " + path.map((v, i) => {
+            if (i == 0)
+                return v.toString();
+            else if (typeof v == "string")
+                return ".\"" + v + "\"";
+            else if (typeof v == "number")
+                return "." + v;
+        }).join("") + "\n\n", 88));
+}
+/**Render the mode selector for the interactive setup CLI */
+async function renderCliModeSelector(opts, backFn, renderEditConfig, renderQuickSetup) {
+    renderHeader(opts, []);
+    (0, terminal_kit_1.terminal)(ansis_1.default.bold.green("Please select what CLI module you want to use.\n") + ansis_1.default.italic.gray("(use arrow keys to navigate, exit using escape)\n"));
+    const answer = await terminal_kit_1.terminal.singleColumnMenu([
+        "✏️ Edit Config     " + ansis_1.default.gray("=> Edit the current config, add/remove settings & more!"),
+        "⏱️ Quick Setup     " + ansis_1.default.gray("=> A quick and easy way of setting up the bot in your Discord server."),
+    ], {
+        leftPadding: "> ",
+        style: terminal_kit_1.terminal.cyan,
+        selectedStyle: terminal_kit_1.terminal.bgDefaultColor.bold,
+        submittedStyle: terminal_kit_1.terminal.bgBlue,
+        extraLines: 2,
+        cancelable: true
+    }).promise;
+    if (answer.canceled)
+        return await backFn();
+    else if (answer.selectedIndex == 0 && renderEditConfig)
+        await renderEditConfig(async () => { await renderCliModeSelector(opts, backFn, renderEditConfig, renderQuickSetup); });
+    else if (answer.selectedIndex == 1 && renderQuickSetup)
+        await renderQuickSetup(async () => { await renderCliModeSelector(opts, backFn, renderEditConfig, renderQuickSetup); });
+    else
+        return await backFn();
+}
+/**Execute/start the Interactive Setup CLI. Make sure no other processes disturb the flow. */
+async function execute(opts, renderEditConfig, renderQuickSetup) {
+    terminal_kit_1.terminal.on("key", (name) => {
+        if (name == "CTRL_C")
+            terminate(opts);
+    });
+    if (terminal_kit_1.terminal.width < 100 || terminal_kit_1.terminal.height < 35) {
+        (0, terminal_kit_1.terminal)(ansis_1.default.red.bold("\n\nMake sure your console, terminal or CMD window has a " + ansis_1.default.cyan("minimum width & height") + " of " + ansis_1.default.cyan("100x35") + " characters."));
+        (0, terminal_kit_1.terminal)(ansis_1.default.red.bold("\nOtherwise the " + opts.projectName + " Interactive Setup CLI will be rendered incorrectly."));
+        (0, terminal_kit_1.terminal)(ansis_1.default.red.bold("\nThe current terminal dimensions are: " + ansis_1.default.cyan(terminal_kit_1.terminal.width + "x" + terminal_kit_1.terminal.height) + "."));
+    }
+    else
+        await renderCliModeSelector(opts, async () => { await terminate(opts); }, renderEditConfig, renderQuickSetup);
+}
+/**A basic style template for select menu's in the interactive setup CLI. */
+exports.autoCompleteMenuOpts = {
+    style: terminal_kit_1.terminal.white,
+    selectedStyle: terminal_kit_1.terminal.bgBlue.white
+};
+/**A set of preset colors to be used when auto-filling colors in the interactive setup CLI. */
+exports.presetColors = new Map([
+    ["dark red", "#992d22"],
+    ["red", "#ff0000"],
+    ["light red", "#f06c6c"],
+    ["dark orange", "#ed510e"],
+    ["orange", "#ed6f0e"],
+    ["light orange", "#f0b06c"],
+    ["openticket", "#f8ba00"],
+    ["dark yellow", "#deb100"],
+    ["yellow", "#ffff00"],
+    ["light yellow", "#ffff8c"],
+    ["banana", "#ffe896"],
+    ["lime", "#a8e312"],
+    ["dark green", "#009600"],
+    ["green", "#00ff00"],
+    ["light green", "#76f266"],
+    ["dark cyan", "#00abab"],
+    ["cyan", "#00ffff"],
+    ["light cyan", "#63ffff"],
+    ["aquamarine", "#7fffd4"],
+    ["dark skyblue", "#006bc9"],
+    ["skyblue", "#0095ff"],
+    ["light skyblue", "#40bfff"],
+    ["dark blue", "#00006e"],
+    ["blue", "#0000ff"],
+    ["light blue", "#5353fc"],
+    ["blurple", "#5865F2"],
+    ["dark purple", "#3f009e"],
+    ["purple", "#8000ff"],
+    ["light purple", "#9257eb"],
+    ["dark pink", "#b82ab0"],
+    ["pink", "#ff6bf8"],
+    ["light pink", "#ff9cfa"],
+    ["magenta", "#ff00ff"],
+    ["black", "#000000"],
+    ["brown", "#806050"],
+    ["dark gray", "#4f4f4f"],
+    ["gray", "#808080"],
+    ["light gray", "#b3b3b3"],
+    ["white", "#ffffff"],
+    ["invisible", "#393A41"]
+]);

package/dist/cli/editConfig.d.ts

@@ -0,0 +1,35 @@
+import { api } from "../index";
+import { ODCliHeaderOpts } from "./cli";
+export declare class ODCliEditConfigInstance {
+    private readonly opts;
+    private readonly opendiscord;
+    constructor(opts: ODCliHeaderOpts, opendiscord: api.ODMain);
+    renderEditConfig(backFn: (() => api.ODPromiseVoid)): Promise<void>;
+    private chooseConfigStructure;
+    private renderConfigObjectStructureSelector;
+    private renderConfigEnabledObjectStructureSelector;
+    private renderConfigObjectSwitchStructureSelector;
+    private renderConfigArrayStructureSelector;
+    private renderConfigArrayStructureEditSelector;
+    private renderConfigArrayStructureMoveSelector;
+    private renderConfigArrayStructureRemoveSelector;
+    private renderConfigArrayStructureDuplicateSelector;
+    private renderConfigBooleanStructureEditor;
+    private renderConfigNumberStructureEditor;
+    private renderConfigStringStructureEditor;
+    private renderConfigNullStructureEditor;
+    private renderConfigTypeSwitchStructureEditor;
+    private getArrayPreviewStructureNameLength;
+    private getArrayPreviewFromStructure;
+    private chooseAdditionConfigStructure;
+    private renderAdditionConfigObjectStructure;
+    private configureAdditionObjectProperties;
+    private renderAdditionConfigEnabledObjectStructure;
+    private renderAdditionConfigObjectSwitchStructure;
+    private renderAdditionConfigBooleanStructure;
+    private renderAdditionConfigNumberStructure;
+    private renderAdditionConfigStringStructure;
+    private renderAdditionConfigNullStructure;
+    private renderAdditionConfigArrayStructureSelector;
+    private renderAdditionConfigTypeSwitchStructure;
+}