@open-discord-bots/framework 0.3.14 → 0.3.16

package/src/startup/pluginLauncher.ts

@@ -1,265 +0,0 @@
-import * as api from "../api/index.js"
-import * as utilities from "../utilities/index.js"
-import fs from "fs"
-
-export const loadAllPlugins = async (opendiscord:api.ODMain) => {
-    //start launching plugins
-    opendiscord.log("Loading plugins...","system")
-    let initPluginError: boolean = false
-
-    if (!fs.existsSync("./plugins")){
-        opendiscord.log("Couldn't find ./plugins directory, canceling all plugin execution!","error")
-        return
-    }
-    const plugins = fs.readdirSync("./plugins")
-    const pluginVersionRegex = /^(OT|OM)v(\d+)\.(\d+|x)\.(\d+|x)$/
-
-    //check & validate
-    for (const p of plugins){
-        //prechecks
-        if (p === ".DS_Store") continue //ignore MacOS DS_Store file
-        if (!fs.statSync("./plugins/"+p).isDirectory()){
-            opendiscord.log("Plugin is not a directory, canceling plugin execution...","plugin",[
-                {key:"plugin",value:"./plugins/"+p}
-            ])
-            continue
-        }
-        if (!fs.existsSync("./plugins/"+p+"/plugin.json")){
-            initPluginError = true
-            opendiscord.log("Plugin doesn't have a plugin.json, canceling plugin execution...","plugin",[
-                {key:"plugin",value:"./plugins/"+p}
-            ])
-            continue
-        }
-
-        //plugin loading
-        try {
-            const rawplugindata: api.ODPluginData = JSON.parse(fs.readFileSync("./plugins/"+p+"/plugin.json").toString())
-
-            if (typeof rawplugindata != "object") throw new api.ODPluginError("Failed to load plugin.json")
-            if (typeof rawplugindata.id != "string") throw new api.ODPluginError("Failed to load plugin.json/id")
-            if (typeof rawplugindata.name != "string") throw new api.ODPluginError("Failed to load plugin.json/name")
-            if (typeof rawplugindata.version != "string") throw new api.ODPluginError("Failed to load plugin.json/version")
-            if (typeof rawplugindata.startFile != "string") 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 api.ODPluginError("Failed to load plugin.json/supportedVersions (must be array)")
-                for (const version of rawplugindata.supportedVersions){
-                    if (typeof version !== "string"){
-                        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 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 api.ODPluginError("Failed to load plugin.json/enabled")
-            if (typeof rawplugindata.priority != "number") throw new api.ODPluginError("Failed to load plugin.json/priority")
-            if (!Array.isArray(rawplugindata.events)) throw new api.ODPluginError("Failed to load plugin.json/events")
-            
-            if (!Array.isArray(rawplugindata.npmDependencies)) throw new api.ODPluginError("Failed to load plugin.json/npmDependencies")
-            if (!Array.isArray(rawplugindata.requiredPlugins)) throw new api.ODPluginError("Failed to load plugin.json/requiredPlugins")
-            if (!Array.isArray(rawplugindata.incompatiblePlugins)) throw new api.ODPluginError("Failed to load plugin.json/incompatiblePlugins")
-            
-            if (typeof rawplugindata.details != "object") throw new api.ODPluginError("Failed to load plugin.json/details")
-            if (typeof rawplugindata.details.author != "string") 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 api.ODPluginError("Failed to load plugin.json/details/contributors (must be array)")
-            
-            if (typeof rawplugindata.details.shortDescription != "string") throw new api.ODPluginError("Failed to load plugin.json/details/shortDescription")
-            if (typeof rawplugindata.details.longDescription != "string") throw new api.ODPluginError("Failed to load plugin.json/details/longDescription")
-            if (typeof rawplugindata.details.imageUrl != "string") throw new api.ODPluginError("Failed to load plugin.json/details/imageUrl")
-            if (typeof rawplugindata.details.projectUrl != "string") throw new api.ODPluginError("Failed to load plugin.json/details/projectUrl")
-            if (!Array.isArray(rawplugindata.details.tags)) throw new api.ODPluginError("Failed to load plugin.json/details/tags")
-            
-            if (rawplugindata.id != p) throw new api.ODPluginError("Failed to load plugin, directory name is required to match the id")
-            
-            if (opendiscord.plugins.exists(rawplugindata.id)) throw new api.ODPluginError("Failed to load plugin, this id already exists in another plugin")
-
-            //plugin.json is valid => load plugin
-            const plugin = new api.ODPlugin(p,rawplugindata)
-            opendiscord.plugins.add(plugin)
-
-        }catch(e:any){
-            //when any of the above errors happen, crash the bot when soft mode isn't enabled
-            initPluginError = true
-            opendiscord.log(e.message+", canceling plugin execution...","plugin",[
-                {key:"path",value:"./plugins/"+p}
-            ])
-            opendiscord.log("You can see more about this error in the ./debug.txt file!","info")
-            opendiscord.debugfile.writeText(e.stack)
-            
-            //try to get some crashed plugin data
-            try{
-                const rawplugindata: api.ODPluginData = JSON.parse(fs.readFileSync("./plugins/"+p+"/plugin.json").toString())
-                opendiscord.plugins.unknownCrashedPlugins.push({
-                    name:rawplugindata.name ?? "./plugins/"+p,
-                    description:(rawplugindata.details && rawplugindata.details.shortDescription) ? rawplugindata.details.shortDescription : "This plugin crashed :(",
-                })
-            }catch{}
-        }
-    }
-
-    //sorted plugins (sorted on priority. All plugins are loaded & enabled)
-    const sortedPlugins = opendiscord.plugins.getAll().sort((a,b) => {
-        return (b.priority - a.priority)
-    })
-
-    //check for incompatible & missing plugins/dependencies
-    const incompatibilities: {from:string,to:string}[] = []
-    const missingDependencies: {id:string,missing:string}[] = []
-    const missingPlugins: {id:string,missing:string}[] = []
-    const versionIncompatibilities: {id:string}[] = []
-
-    //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 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: string[] = []
-    incompatibilities.forEach((match) => {
-        if (alreadyLoggedCompatPlugins.includes(match.from) || alreadyLoggedCompatPlugins.includes(match.to)) return
-        else alreadyLoggedCompatPlugins.push(match.from,match.to)
-
-        const fromPlugin = opendiscord.plugins.get(match.from)
-        if (fromPlugin && !fromPlugin.crashed){
-            fromPlugin.crashed = true
-            fromPlugin.crashReason = "incompatible.plugin"
-        }
-        const toPlugin = opendiscord.plugins.get(match.to)
-        if (toPlugin && !toPlugin.crashed){
-            toPlugin.crashed = true
-            toPlugin.crashReason = "incompatible.plugin"
-        }
-
-        opendiscord.log(`Incompatible plugins => "${match.from}" & "${match.to}", canceling plugin execution...`,"plugin",[
-            {key:"path1",value:"./plugins/"+match.from},
-            {key:"path2",value:"./plugins/"+match.to}
-        ])
-        initPluginError = true
-    })
-
-    //handle all missing dependencies
-    missingDependencies.forEach((match) => {
-        const plugin = opendiscord.plugins.get(match.id)
-        if (plugin && !plugin.crashed){
-            plugin.crashed = true
-            plugin.crashReason = "missing.dependency"
-        }
-
-        opendiscord.log(`Missing npm dependency "${match.missing}", canceling plugin execution...`,"plugin",[
-            {key:"path",value:"./plugins/"+match.id}
-        ])
-        initPluginError = true
-    })
-
-    //handle all missing plugins
-    missingPlugins.forEach((match) => {
-        const plugin = opendiscord.plugins.get(match.id)
-        if (plugin && !plugin.crashed){
-            plugin.crashed = true
-            plugin.crashReason = "missing.plugin"
-        }
-
-        opendiscord.log(`Missing required plugin "${match.missing}", canceling plugin execution...`,"plugin",[
-            {key:"path",value:"./plugins/"+match.id}
-        ])
-        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("")
-        opendiscord.log("Please fix all plugin errors above & try again!","error")
-        process.exit(1)
-    }
-
-    //preload all events required for every plugin
-    for (const plugin of sortedPlugins){
-        if (plugin.enabled) plugin.data.events.forEach((event) => opendiscord.events.add(new api.ODEvent(event)))
-    }
-    
-    //execute all working plugins
-    for (const plugin of sortedPlugins){
-        const status = await plugin.execute(opendiscord.debug,false)
-        
-        //exit on error (when soft mode disabled)
-        if (!status && !opendiscord.sharedFuses.getFuse("softPluginLoading")){
-            console.log("")
-            opendiscord.log("Please fix all plugin errors above & try again!","error")
-            process.exit(1)
-        }
-    }
-
-    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:"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:"authors",value:authors},
-                {key:"version",value:plugin.version.toString()},
-                {key:"priority",value:plugin.priority.toString()}
-            ])
-        }
-    }
-}

package/src/utilities/index.ts

@@ -1,229 +0,0 @@
-import * as fs from "fs"
-import ansis from "ansis"
-import * as api from "../api/index.js"
-import * as discord from "discord.js"
-
-/**## sharedFuses `utility variable`
- * All shared fuses from Open Discord. Please use `opendiscord.sharedFuses` instead!
- */
-export const sharedFuses: api.ODSharedFuseManager = new api.ODSharedFuseManager()
-
-/**## checkNodeVersion `utility function`
- * Check if the node.js version is v20 or higher.
- */
-export function checkNodeVersion(project:api.ODProjectType){
-    const nodev = process.versions.node.split(".")
-    if (Number(nodev[0]) < 20){
-        const title = (project == "openticket") ? "OPEN TICKET" : "OPEN MODERATION"
-        console.log("\n\n==============================\n["+title+" ERROR]: Invalid node.js version. Open Ticket requires node.js v20 or above!\n==============================\n\n")
-        process.exit(1)
-    }
-}
-
-/**## moduleInstalled `utility function`
- * Use this function to check if an npm package is installed or not!
- * @example utilities.moduleInstalled("discord.js") //check if discord.js is installed
- */
-export function moduleInstalled(id:string,throwError?:boolean): boolean {
-    try{
-        import.meta.resolve(id)
-        return true
-    }catch{
-        if (throwError) throw new Error("npm module \""+id+"\" is not installed! Install it via 'npm install "+id+"'")
-        return false
-    }
-}
-
-/**## initialStartupLogs `utility function`
- * Use this function to check if an npm package is installed or not!
- * @example utilities.moduleInstalled("discord.js") //check if discord.js is installed
- */
-export function initialStartupLogs(opendiscord:api.ODMain,project:api.ODProjectType){
-    const title = (project == "openticket") ? "OPEN TICKET" : "OPEN MODERATION"
-    console.log("\n--------------------------- "+title+" STARTUP ---------------------------")
-    opendiscord.log("Logging system activated!","system")
-    opendiscord.debug.debug("Using Node.js "+process.version+"!")
-
-    try{
-        const packageJson = JSON.parse(fs.readFileSync("./package.json").toString())
-        opendiscord.debug.debug("Using discord.js "+packageJson.dependencies["discord.js"]+"!")
-        opendiscord.debug.debug("Using @discordjs/rest "+packageJson.dependencies["@discordjs/rest"]+"!")
-        opendiscord.debug.debug("Using ansis "+packageJson.dependencies["ansis"]+"!")
-        opendiscord.debug.debug("Using formatted-json-stringify "+packageJson.dependencies["formatted-json-stringify"]+"!")
-        opendiscord.debug.debug("Using terminal-kit "+packageJson.dependencies["terminal-kit"]+"!")
-        opendiscord.debug.debug("Using typescript "+packageJson.dependencies["typescript"]+"!")
-        opendiscord.debug.debug("Using @open-discord-bots/framework "+packageJson.dependencies["@open-discord-bots/framework"]+"!")
-    }catch{
-        opendiscord.debug.debug("Failed to fetch module versions!")
-    }
-}
-
-/**## timer `utility function`
- * Use this to wait for a certain amount of milliseconds. This only works when using `await`
- * @example await utilities.timer(1000) //wait 1sec
- */
-export async function timer(ms:number): Promise<void> {
-    return new Promise((resolve) => {
-        setTimeout(() => {
-            resolve()
-        },ms)
-    })
-}
-
-/**## emojiTitle `utility function`
- * Use this function to create a title with an emoji before/after the text. The style & divider are set in `opendiscord.sharedFuses`
- * @example utilities.emojiTitle("📎","Links") //create a title with an emoji based on the bot emoji style
- */
-export function emojiTitle(emoji:string, text:string){
-    const style = sharedFuses.getFuse("emojiTitleStyle")
-    const divider = sharedFuses.getFuse("emojiTitleDivider")
-
-    if (style == "disabled") return text
-    else if (style == "before") return emoji+divider+text
-    else if (style == "after") return text+divider+emoji
-    else if (style == "double") return emoji+divider+text+divider+emoji
-    else return text
-}
-
-/**## runAsync `utility function`
- * Use this function to run a snippet of code asyncronous without creating a separate function for it!
- */
-export async function runAsync(func:() => Promise<void>): Promise<void> {
-    func()
-}
-
-/**## timedAwait `utility function`
- * Use this function to await a promise but reject after the certain timeout has been reached.
- */
-export function timedAwait<ReturnValue>(promise:ReturnValue,timeout:number,onError:(err:Error) => void): ReturnValue {
-    let allowResolve = true
-    return new Promise(async (resolve,reject) => {
-        //set timeout & stop if it is before the promise resolved
-        setTimeout(() => {
-            allowResolve = false
-            reject("utilities.timedAwait() => Promise Timeout")
-        },timeout)
-
-        //get promise result & return if not already rejected
-        try{
-            const res = await promise
-            if (allowResolve) resolve(res)
-        }catch(err:any){
-            onError(err)
-        }
-    return promise
-    }) as ReturnValue
-}
-
-/**## dateString `utility function`
- * Use this function to create a short date string in the following format: `DD/MM/YYYY HH:MM:SS`
- */
-export function dateString(date:Date): string {
-    return `${date.getDate()}/${date.getMonth()+1}/${date.getFullYear()} ${date.getHours()}:${date.getMinutes()}:${date.getSeconds()}`
-}
-
-/**## asyncReplace `utility function`
- * Same as `string.replace(search, value)` but with async compatibility
- */
-export async function asyncReplace(text:string, regex:RegExp, func:(value:string,...args:any[]) => Promise<string>): Promise<string> {
-    const promises: Promise<string>[] = []
-    text.replace(regex,(match,...args) => {
-        promises.push(func(match,...args))
-        return match
-    })
-    const data = await Promise.all(promises)
-    const result = text.replace(regex,(match) => {
-        const replaceResult = data.shift()
-        return replaceResult ?? match
-    })
-    return result
-}
-
-/**## getLongestLength `utility function`
- * Get the length of the longest string in the array.
- */
-export function getLongestLength(texts:string[]): number {
-    return Math.max(...texts.map((t) => ansis.strip(t).length))
-}
-
-/**## ordinalNumber `utility function`
- * Get a human readable ordinal number (e.g. 1st, 2nd, 3rd, 4th, ...) from a Javascript number.
- */
-export function ordinalNumber(num:number){
-    const i = Math.abs(Math.round(num))
-    const cent = i % 100
-    if (cent >= 10 && cent <= 20) return i+'th'
-    const dec = i % 10
-    if (dec === 1) return i+'st'
-    if (dec === 2) return i+'nd'
-    if (dec === 3) return i+'rd'
-    return i+'th'
-}
-
-/**## trimEmojis `utility function`
- * Trim/remove all emoji's from a Javascript string.
- */
-export function trimEmojis(text:string){
-    return text.replace(/(\p{Extended_Pictographic}(?:\uFE0F|\uFE0E)?(?:\u200D\p{Extended_Pictographic}(?:\uFE0F|\uFE0E)?)*)/gu,"")
-}
-
-/**## getMessageFromBuildResult `utility function`
- * Get the final `messageCreateOptions` from a returned build result from builders/components.
- */
-export function getMessageFromBuildResult(build:api.ODMessageBuildResult|api.ODMessageComponentBuildResult,type:"interaction"|"message"){
-    const msgFlags: number[] = []
-    let msgData: discord.MessageCreateOptions
-    if ('message' in build){
-        //USING BUILDERS (deprecated)
-        msgData = build.message
-        if (build.ephemeral) msgFlags.push(discord.MessageFlags.Ephemeral)
-    }else{
-        //USING COMPONENTS
-        msgData = build.msg
-        if (type == "interaction" && build.ephemeral) msgFlags.push(discord.MessageFlags.Ephemeral) //disabled with regular messages
-        if (build.componentsV2) msgFlags.push(discord.MessageFlags.IsComponentsV2)
-        if (build.supressEmbeds) msgFlags.push(discord.MessageFlags.SuppressEmbeds)
-        if (build.supressNotifications) msgFlags.push(discord.MessageFlags.SuppressNotifications)
-    }
-    return Object.assign(msgData,{flags:msgFlags})
-}
-
-/**## easterEggs `utility object`
- * Object containing data for Open Ticket easter eggs.
- */
-export const easterEggs: api.ODEasterEggs = {
-    /* THANK YOU TO ALL OUR CONTRIBUTORS!!! */
-    creator:"779742674932072469", //DJj123dj
-    translators:[
-        "779742674932072469", //DJj123dj
-        "574172558006681601", //Sanke
-        "540639725300613136", //Guillee.3
-        "547231585368539136", //Mods HD
-        "664934139954331649", //SpyEye
-        "498055992962187264", //Redactado
-        "912052735950618705", //T0miiis
-        "366673202610569227", //johusens
-        "360780292853858306", //David.3
-        "950611418389024809", //Sarcastic
-        "461603955517161473", //Maurizo
-        "465111430274875402", //The_Gamer
-        "586376952470831104", //Erxg
-        "226695254433202176", //Mkevas
-        "437695615095275520", //NoOneNook
-        "530047191222583307", //Anderskiy
-        "719072181631320145", //ToStam
-        "1172870906377408512", //Stragar
-        "1084794575945744445", //Sasanwm
-        "449613814049275905", //Benzorich
-        "905373133085741146", //Ronalds
-        "918504977369018408", //Palestinian
-        "807970841035145216", //Kornel0706
-        "1198883915826475080", //Nova
-        "669988226819162133", //Danoglez
-        "1313597620996018271", //Fraden1
-        "547809968145956884", //TsgIndrius
-        "264120132660363267", //Quiradon
-        "1272034143777329215", //NotMega
-        "LOREMIPSUM", //TODO, ADD MORE IDS IN FUTURE!
-    ]
-}

package/tools/cleanup.js

@@ -1,2 +0,0 @@
-import fs from "fs"
-fs.rmSync("./dist",{recursive: true, force:true})

package/tsconfig.json

@@ -1,15 +0,0 @@
-{
-    "compilerOptions": {
-        "target": "es2025",
-        "strictNullChecks": true,
-        "strictPropertyInitialization": true,
-        "declaration": true,
-        "module": "NodeNext",
-        "moduleResolution": "NodeNext",
-        "rootDir": "./src",
-        "outDir": "./dist"
-    },
-    "include": [
-        "src/**/*"
-    ]
-}