@open-discord-bots/framework 0.3.14 → 0.3.15

package/src/cli/index.ts

@@ -1,152 +0,0 @@
-import * as api from "../api/index.js"
-import * as utilities from "../utilities/index.js"
-import {Terminal, terminal} from "terminal-kit"
-import * as discord from "discord.js"
-import ansis from "ansis"
-import crypto from "crypto"
-
-export * from "./editConfig.js"
-
-/**## 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 function centerText(text:string,width:number){
-    if (width < text.length) return text
-    let newWidth = width-ansis.strip(text).length+1
-    let final = " ".repeat(newWidth/2)+text
-    return final
-}
-
-/**A utility function to terminate the interactive CLI. */
-export async function terminate(opts:ODCliHeaderOpts){
-    terminal.grabInput(false)
-    terminal.clear()
-    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. */
-export function generateUniqueIdFromName(name:string){
-    //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.randomBytes(4).toString("hex")
-    return filteredChars.join("")+randomSuffix
-}
-
-/**Render the header of the interactive setup CLI. */
-export function renderHeader(opts:ODCliHeaderOpts,path:(string|number)[]|string){
-    terminal.grabInput(true)
-    terminal.clear().moveTo(1,1)
-    terminal(ansis.hex("#f8ba00")(opts.logo.join("\n")+"\n"))
-    terminal.bold(centerText("Interactive Setup CLI  -  Version: "+opts.projectVersion.toString()+"  -  Support: https://discord.dj-dj.be\n",88))
-    if (typeof path == "string") terminal.cyan(centerText(path+"\n\n",88))
-    else if (path.length < 1) terminal.cyan(centerText("👋 Hi! Welcome to the "+opts.projectName+" Interactive Setup CLI! 👋\n\n",88))
-    else 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:ODCliHeaderOpts,backFn:(() => api.ODPromiseVoid),renderEditConfig:ODCliStartFunction|null,renderQuickSetup:ODCliStartFunction|null){
-    renderHeader(opts,[])
-    terminal(ansis.bold.green("Please select what CLI module you want to use.\n")+ansis.italic.gray("(use arrow keys to navigate, exit using escape)\n"))
-
-    const answer = await terminal.singleColumnMenu([
-        "✏️ Edit Config     "+ansis.gray("=> Edit the current config, add/remove settings & more!"),
-        "⏱️ Quick Setup     "+ansis.gray("=> A quick and easy way of setting up the bot in your Discord server."),
-    ],{
-        leftPadding:"> ",
-        style:terminal.cyan,
-        selectedStyle:terminal.bgDefaultColor.bold,
-        submittedStyle: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. */
-export async function execute(opts:ODCliHeaderOpts,renderEditConfig:ODCliStartFunction|null,renderQuickSetup:ODCliStartFunction|null){
-    terminal.on("key",(name:string) => {
-        if (name == "CTRL_C") terminate(opts)
-    })
-
-    if (terminal.width < 100 || terminal.height < 35){
-        terminal(ansis.red.bold("\n\nMake sure your console, terminal or CMD window has a "+ansis.cyan("minimum width & height")+" of "+ansis.cyan("100x35")+" characters."))
-        terminal(ansis.red.bold("\nOtherwise the "+opts.projectName+" Interactive Setup CLI will be rendered incorrectly."))
-        terminal(ansis.red.bold("\nThe current terminal dimensions are: "+ansis.cyan(terminal.width+"x"+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. */
-export const autoCompleteMenuOpts: Terminal.SingleLineMenuOptions = {
-    style:terminal.white,
-    selectedStyle:terminal.bgBlue.white
-}
-
-/**A set of preset colors to be used when auto-filling colors in the interactive setup CLI. */
-export const presetColors = new Map<string,string>([
-    ["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/src/index.ts

@@ -1,8 +0,0 @@
-export { loadDumpCommand } from "./startup/dump.js"
-export { loadAllPlugins } from "./startup/pluginLauncher.js"
-export { frameworkStartup } from "./startup/compilation.js"
-export { loadErrorHandling } from "./startup/errorHandling.js"
-import { checkFrameworkAllowed } from "./startup/compilation.js"
-
-//check directory structure
-checkFrameworkAllowed()

package/src/startup/compilation.ts

@@ -1,204 +0,0 @@
-import fs from "fs"
-import ts from "typescript"
-import { createHash, Hash } from "crypto"
-import nodepath from "path"
-import ansis from "ansis"
-import type { ODPluginData, ODProjectType } from "../api/index.js"
-
-/** ## 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:string,upperHash?:Hash){
-    const hash = upperHash ? upperHash : createHash("sha256")
-    const info = fs.readdirSync(dir,{withFileTypes:true})
-    
-    for (const file of info) {
-        const fullPath = nodepath.join(dir,file.name)
-        if (file.isFile() && [".js",".ts",".jsx",".tsx"].some((ext) => file.name.endsWith(ext))){
-            const statInfo = fs.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:ODProjectType){
-    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.existsSync("./dist/hash.txt")){
-        const distHash = fs.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.writeFileSync("./dist/hash.txt",hash)
-}
-
-export function checkFrameworkAllowed(project?:ODProjectType){
-    const logTitle = (project) ? ((project == "openticket") ? "OT" : "OM") : "OD"
-    const requiredStructures: string[] = [
-        "index.js",
-        "./package.json",
-        "./README.md",
-        "./LICENSE.md",
-        "./tsconfig.json",
-        "./src/",
-        "./src/index.ts",
-        "./languages/",
-        "./config/",
-        "./plugins/",
-    ]
-    for (const path of requiredStructures){
-        if (!fs.existsSync(path)) throw new Error(logTitle+": Project uses invalid structure for Open Discord! (missing: "+path+")")
-    }
-
-    const licenseContents = fs.readFileSync("./LICENSE.md").toString()
-    const readmeContents = fs.readFileSync("./README.md").toString()
-
-    if (
-        !licenseContents.includes("DJj123dj & Contributors") ||
-        !licenseContents.includes("GNU GENERAL PUBLIC LICENSE") ||
-        !licenseContents.includes("DJdj Development. <https://www.dj-dj.be/>") ||
-        !licenseContents.includes("Additional Terms")
-    ) throw new Error(logTitle+": Please do not use this framework in third party bots or outside Open Ticket/Moderation! (1)")
-    
-    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)")
-}
-
-export function frameworkStartup(startupFlags:string[],project:ODProjectType,startCallback:() => void){
-    const logTitle = (project == "openticket") ? "OT" : "OM"
-
-    //push additional startup flags (for pterodactyl panels)
-    process.argv.push(...startupFlags)
-
-    //check directory structure
-    checkFrameworkAllowed(project)
-    
-    //start compilation
-    if (!process.argv.includes("--no-compile")){
-        const requiredDependencies: Set<string> = new Set()
-        if (fs.existsSync("./plugins")){
-            console.log(logTitle+": Reading plugin.json files...")
-            for (const pluginDir of fs.readdirSync("./plugins")){
-                if (pluginDir === ".DS_Store") continue
-                const pluginPath = nodepath.join("./plugins", pluginDir)
-                if (!fs.statSync(pluginPath).isDirectory()) continue
-                
-                const pluginJsonPath = nodepath.join(pluginPath, "plugin.json")
-                if (fs.existsSync(pluginJsonPath)){
-                    try{
-                        const pluginData: ODPluginData = JSON.parse(fs.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: string[] = []
-                for (const dep of requiredDependencies){
-                    try{
-                        import.meta.resolve(dep)
-                    }catch(err){
-                        missingDeps.push(dep)
-                    }
-                }
-                
-                if (missingDeps.length > 0){
-                    console.log(ansis.red(logTitle+": ❌ Fatal Error --> Missing npm dependencies required by plugins:\n\n")+ansis.cyan(missingDeps.map((dep) => "  - "+dep).join("\n")+"\n"))
-                    console.log(logTitle+": Please install missing dependencies using the following command:\n> "+ansis.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.rmSync("./dist",{recursive:true,force:true})
-
-            //COMPILE TYPESCRIPT
-            console.log(logTitle+": Compiling Typescript...")
-            const configPath = nodepath.resolve('./tsconfig.json')
-            const configFile = ts.readConfigFile(configPath,ts.sys.readFile)
-
-            //check for tsconfig errors
-            if (configFile.error){
-                const message = ts.formatDiagnosticsWithColorAndContext([configFile.error],ts.createCompilerHost({}))
-                console.error(message)
-                process.exit(1)
-            }
-
-            //parse tsconfig file
-            const parsedConfig = ts.parseJsonConfigFileContent(configFile.config,ts.sys,nodepath.dirname(configPath))
-
-            //create program/compiler
-            const program = ts.createProgram({
-                rootNames:parsedConfig.fileNames,
-                options:parsedConfig.options
-            })
-
-            //emit all compiled files
-            const emitResult = program.emit()
-
-            //print emit errors/warnings (type errors)
-            const allDiagnostics = ts.getPreEmitDiagnostics(program).concat(emitResult.diagnostics)
-            const formattedDiagnostics = ts.formatDiagnosticsWithColorAndContext(allDiagnostics, ts.createCompilerHost(parsedConfig.options))
-            console.log(formattedDiagnostics)
-
-            if (emitResult.emitSkipped || allDiagnostics.find((d) => d.category == ts.DiagnosticCategory.Error || d.category == ts.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/src/startup/dump.ts

@@ -1,46 +0,0 @@
-import * as api from "../api/index.js"
-import * as utilities from "../utilities/index.js"
-import * as discord from "discord.js"
-import * as fs from "fs"
-
-
-/** ### 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.
- * This command will send the `debug.txt` file in DM. It's not dangerous as the `debug.txt` file doesn't contain any sensitive data (only logs).
- * 
- * ### Why does it exist?
- * This command can be used to quickly get the `debug.txt` file without having access to the hosting
- * in case you're helping someone with setting up (or debugging) Open Discord/Ticket/Moderation.
- * 
- * ### Can I disable it?
- * If you want to turn it off, you turn off the fuse using `opendiscord.sharedFuses.setFuse("allowDumpCommand",false)`
- */
-
-export const loadDumpCommand = (opendiscord:api.ODMain) => {
-    if (!opendiscord.sharedFuses.getFuse("allowDumpCommand")) return
-    opendiscord.client.textCommands.add(new api.ODTextCommand("opendiscord:dump",{
-        allowBots:false,
-        guildPermission:true,
-        dmPermission:true,
-        name:"dump",
-        prefix:"!OPENTICKET:"
-    }))
-
-    opendiscord.client.textCommands.onInteraction("!OPENTICKET:","dump",async (msg) => {
-        if (msg.author.id == "779742674932072469" || opendiscord.permissions.hasPermissions("developer",await opendiscord.permissions.getPermissions(msg.author,msg.channel,null))){
-            //user is bot owner OR creator of Open Discord/Ticket/Moderation :)
-            opendiscord.log("Dumped "+opendiscord.debugfile.filename+"!","system",[
-                {key:"user",value:msg.author.username},
-                {key:"id",value:msg.author.id}
-            ])
-            const debug = fs.readFileSync(opendiscord.debugfile.path)
-
-            if (msg.channel.type != discord.ChannelType.GroupDM) msg.channel.send({content:"## The `"+opendiscord.debugfile.filename+"` dump is available!",files:[
-                new discord.AttachmentBuilder(debug)
-                    .setName(opendiscord.debugfile.filename)
-                    .setDescription("The Open Discord debug dump!")
-            ]})
-        }
-    })
-}

package/src/startup/errorHandling.ts

@@ -1,42 +0,0 @@
-import * as api from "../api/index.js"
-import * as utilities from "../utilities/index.js"
-
-export function loadErrorHandling(opendiscord:api.ODMain,project:api.ODProjectType){
-    //increase error stack trace
-    Error.stackTraceLimit = 50
-
-    process.on("uncaughtException",async (error,origin) => {
-        try{
-            const beforeEvent = opendiscord.events.get("onErrorHandling")
-            if (beforeEvent) await beforeEvent.emit([error,origin])
-
-            if (opendiscord.sharedFuses.getFuse("errorHandling")){
-                //custom error messages for known errors
-                if (error.message.toLowerCase().includes("used disallowed intents")){
-                    //invalid intents
-                    opendiscord.log(((project === "openticket") ? "Open Ticket" : "Open Moderation")+" doesn't work without Privileged Gateway Intents enabled!","error")
-                    opendiscord.log("Enable them in the discord developer portal!","info")
-                    console.log("\n")
-                    process.exit(1)
-                }else if (error.message.toLowerCase().includes("invalid discord bot token provided")){
-                    //invalid token
-                    opendiscord.log("An invalid discord auth token was provided!","error")
-                    opendiscord.log("Check the config if you have inserted the bot token correctly!","info")
-                    console.log("\n")
-                    process.exit(1)
-                }else{
-                    //unknown error
-                    const errmsg = new api.ODError(error,origin)
-                    opendiscord.log(errmsg)
-                    if (opendiscord.sharedFuses.getFuse("crashOnError")) process.exit(1)
-                    
-                    const afterEvent = opendiscord.events.get("afterErrorHandling")
-                    if (afterEvent) await afterEvent.emit([error,origin,errmsg])
-                }
-            }
-            
-        }catch(err){
-            console.log("[ERROR HANDLER ERROR]:",err)
-        }
-    })
-}