@open-discord-bots/framework 0.2.11 → 0.2.13

package/dist/utilities/index.js

@@ -1,65 +1,14 @@
-"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.easterEggs = exports.sharedFuses = void 0;
-exports.checkNodeVersion = checkNodeVersion;
-exports.moduleInstalled = moduleInstalled;
-exports.initialStartupLogs = initialStartupLogs;
-exports.timer = timer;
-exports.emojiTitle = emojiTitle;
-exports.runAsync = runAsync;
-exports.timedAwait = timedAwait;
-exports.dateString = dateString;
-exports.asyncReplace = asyncReplace;
-exports.getLongestLength = getLongestLength;
-exports.ordinalNumber = ordinalNumber;
-exports.trimEmojis = trimEmojis;
-const fs = __importStar(require("fs"));
-const ansis_1 = __importDefault(require("ansis"));
-const api = __importStar(require("../api/index"));
+import * as fs from "fs";
+import ansis from "ansis";
+import * as api from "../api/index.js";
 /**## sharedFuses `utility variable`
  * All shared fuses from Open Discord. Please use `opendiscord.sharedFuses` instead!
  */
-exports.sharedFuses = new api.ODSharedFuseManager();
+export const sharedFuses = new api.ODSharedFuseManager();
 /**## checkNodeVersion `utility function`
  * Check if the node.js version is v20 or higher.
  */
-function checkNodeVersion(project) {
+export function checkNodeVersion(project) {
     const nodev = process.versions.node.split(".");
     if (Number(nodev[0]) < 20) {
         const title = (project == "openticket") ? "OPEN TICKET" : "OPEN MODERATION";
@@ -71,7 +20,7 @@ function checkNodeVersion(project) {
  * Use this function to check if an npm package is installed or not!
  * @example utilities.moduleInstalled("discord.js") //check if discord.js is installed
  */
-function moduleInstalled(id, throwError) {
+export function moduleInstalled(id, throwError) {
     try {
         require.resolve(id);
         return true;
@@ -86,7 +35,7 @@ function moduleInstalled(id, throwError) {
  * Use this function to check if an npm package is installed or not!
  * @example utilities.moduleInstalled("discord.js") //check if discord.js is installed
  */
-function initialStartupLogs(opendiscord, project) {
+export function initialStartupLogs(opendiscord, project) {
     const title = (project == "openticket") ? "OPEN TICKET" : "OPEN MODERATION";
     console.log("\n--------------------------- " + title + " STARTUP ---------------------------");
     opendiscord.log("Logging system activated!", "system");
@@ -109,7 +58,7 @@ function initialStartupLogs(opendiscord, project) {
  * Use this to wait for a certain amount of milliseconds. This only works when using `await`
  * @example await utilities.timer(1000) //wait 1sec
  */
-async function timer(ms) {
+export async function timer(ms) {
     return new Promise((resolve) => {
         setTimeout(() => {
             resolve();
@@ -120,9 +69,9 @@ async function timer(ms) {
  * 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
  */
-function emojiTitle(emoji, text) {
-    const style = exports.sharedFuses.getFuse("emojiTitleStyle");
-    const divider = exports.sharedFuses.getFuse("emojiTitleDivider");
+export function emojiTitle(emoji, text) {
+    const style = sharedFuses.getFuse("emojiTitleStyle");
+    const divider = sharedFuses.getFuse("emojiTitleDivider");
     if (style == "disabled")
         return text;
     else if (style == "before")
@@ -137,13 +86,13 @@ function emojiTitle(emoji, text) {
 /**## runAsync `utility function`
  * Use this function to run a snippet of code asyncronous without creating a separate function for it!
  */
-async function runAsync(func) {
+export async function runAsync(func) {
     func();
 }
 /**## timedAwait `utility function`
  * Use this function to await a promise but reject after the certain timeout has been reached.
  */
-function timedAwait(promise, timeout, onError) {
+export function timedAwait(promise, timeout, onError) {
     let allowResolve = true;
     return new Promise(async (resolve, reject) => {
         //set timeout & stop if it is before the promise resolved
@@ -166,13 +115,13 @@ function timedAwait(promise, timeout, onError) {
 /**## dateString `utility function`
  * Use this function to create a short date string in the following format: `DD/MM/YYYY HH:MM:SS`
  */
-function dateString(date) {
+export function dateString(date) {
     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
  */
-async function asyncReplace(text, regex, func) {
+export async function asyncReplace(text, regex, func) {
     const promises = [];
     text.replace(regex, (match, ...args) => {
         promises.push(func(match, ...args));
@@ -188,13 +137,13 @@ async function asyncReplace(text, regex, func) {
 /**## getLongestLength `utility function`
  * Get the length of the longest string in the array.
  */
-function getLongestLength(texts) {
-    return Math.max(...texts.map((t) => ansis_1.default.strip(t).length));
+export function getLongestLength(texts) {
+    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.
  */
-function ordinalNumber(num) {
+export function ordinalNumber(num) {
     const i = Math.abs(Math.round(num));
     const cent = i % 100;
     if (cent >= 10 && cent <= 20)
@@ -211,13 +160,13 @@ function ordinalNumber(num) {
 /**## trimEmojis `utility function`
  * Trim/remove all emoji's from a Javascript string.
  */
-function trimEmojis(text) {
+export function trimEmojis(text) {
     return text.replace(/(\p{Extended_Pictographic}(?:\uFE0F|\uFE0E)?(?:\u200D\p{Extended_Pictographic}(?:\uFE0F|\uFE0E)?)*)/gu, "");
 }
 /**## easterEggs `utility object`
  * Object containing data for Open Ticket easter eggs.
  */
-exports.easterEggs = {
+export const easterEggs = {
     /* THANK YOU TO ALL OUR CONTRIBUTORS!!! */
     creator: "779742674932072469", //DJj123dj
     translators: [

package/package.json

@@ -1,10 +1,11 @@
 {
     "name": "@open-discord-bots/framework",
     "author": "DJj123dj",
-    "version": "0.2.11",
+    "version": "0.2.13",
     "description": "The core framework of the popular open-source discord bots: Open Ticket & Open Moderation.",
     "main": "dist/index.js",
     "module": "dist/index.js",
+    "type": "module",
     "scripts": {
         "build": "node ./tools/cleanup.js && tsc -p ./tsconfig.json"
     },
@@ -14,10 +15,10 @@
         "@discordjs/rest": "^2.6.1",
         "@types/terminal-kit": "^2.5.7",
         "ansis": "^4.2.0",
-        "discord.js": "^14.26.0",
-        "formatted-json-stringify": "^1.2.1",
+        "discord.js": "^14.26.3",
+        "formatted-json-stringify": "^1.3.0",
         "terminal-kit": "^3.1.2",
-        "typescript": "^5.9.3"
+        "typescript": "^6.0.3"
     },
     "repository": {
         "type": "git",

package/src/api/index.ts

@@ -1,29 +1,29 @@
 //MAIN MODULE
-export * from "./main"
+export * from "./main.js"
 
 //BASE MODULES
-export * from "./modules/base"
-export * from "./modules/event"
-export * from "./modules/config"
-export * from "./modules/database"
-export * from "./modules/language"
-export * from "./modules/flag"
-export * from "./modules/console"
-export * from "./modules/fuse"
-export * from "./modules/plugin"
-export * from "./modules/checker"
-export * from "./modules/client"
-export * from "./modules/worker"
-export * from "./modules/builder"
-export * from "./modules/responder"
-export * from "./modules/action"
-export * from "./modules/permission"
-export * from "./modules/helpmenu"
-export * from "./modules/session"
-export * from "./modules/statistic"
-export * from "./modules/code"
-export * from "./modules/cooldown"
-export * from "./modules/post"
-export * from "./modules/verifybar"
-export * from "./modules/progressbar"
-export * from "./modules/startscreen"
+export * from "./modules/base.js"
+export * from "./modules/event.js"
+export * from "./modules/config.js"
+export * from "./modules/database.js"
+export * from "./modules/language.js"
+export * from "./modules/flag.js"
+export * from "./modules/console.js"
+export * from "./modules/fuse.js"
+export * from "./modules/plugin.js"
+export * from "./modules/checker.js"
+export * from "./modules/client.js"
+export * from "./modules/worker.js"
+export * from "./modules/builder.js"
+export * from "./modules/responder.js"
+export * from "./modules/action.js"
+export * from "./modules/permission.js"
+export * from "./modules/helpmenu.js"
+export * from "./modules/session.js"
+export * from "./modules/statistic.js"
+export * from "./modules/code.js"
+export * from "./modules/cooldown.js"
+export * from "./modules/post.js"
+export * from "./modules/verifybar.js"
+export * from "./modules/progressbar.js"
+export * from "./modules/startscreen.js"

package/src/api/main.ts

@@ -1,28 +1,28 @@
 //BASE MODULES
-import { ODEnvHelper, ODProjectType, ODVersion, ODVersionManager } from "./modules/base"
-import { ODConsoleManager, ODConsoleMessage, ODConsoleMessageParam, ODConsoleMessageTypes, ODDebugFileManager, ODDebugger, ODError, ODLiveStatusManager } from "./modules/console"
-import { ODCheckerManager } from "./modules/checker"
-import { ODEventManager } from "./modules/event"
-import { ODPluginManager } from "./modules/plugin"
-import { ODFlagManager } from "./modules/flag"
-import { ODProgressBarManager } from "./modules/progressbar"
-import { ODConfigManager } from "./modules/config"
-import { ODDatabaseManager } from "./modules/database"
-import { ODSessionManager } from "./modules/session"
-import { ODLanguageManager } from "./modules/language"
-import { ODBuilderManager } from "./modules/builder"
-import { ODResponderManager } from "./modules/responder"
-import { ODActionManager } from "./modules/action"
-import { ODVerifyBarManager } from "./modules/verifybar"
-import { ODPermissionManager } from "./modules/permission"
-import { ODCooldownManager } from "./modules/cooldown"
-import { ODHelpMenuManager } from "./modules/helpmenu"
-import { ODStatisticManager } from "./modules/statistic"
-import { ODCodeManager } from "./modules/code"
-import { ODPostManager } from "./modules/post"
-import { ODClientManager } from "./modules/client"
-import { ODSharedFuseManager } from "./modules/fuse"
-import { ODStartScreenManager } from "./modules/startscreen"
+import { ODEnvHelper, ODProjectType, ODVersion, ODVersionManager } from "./modules/base.js"
+import { ODConsoleManager, ODConsoleMessage, ODConsoleMessageParam, ODConsoleMessageTypes, ODDebugFileManager, ODDebugger, ODError, ODLiveStatusManager } from "./modules/console.js"
+import { ODCheckerManager } from "./modules/checker.js"
+import { ODEventManager } from "./modules/event.js"
+import { ODPluginManager } from "./modules/plugin.js"
+import { ODFlagManager } from "./modules/flag.js"
+import { ODProgressBarManager } from "./modules/progressbar.js"
+import { ODConfigManager } from "./modules/config.js"
+import { ODDatabaseManager } from "./modules/database.js"
+import { ODSessionManager } from "./modules/session.js"
+import { ODLanguageManager } from "./modules/language.js"
+import { ODBuilderManager } from "./modules/builder.js"
+import { ODResponderManager } from "./modules/responder.js"
+import { ODActionManager } from "./modules/action.js"
+import { ODVerifyBarManager } from "./modules/verifybar.js"
+import { ODPermissionManager } from "./modules/permission.js"
+import { ODCooldownManager } from "./modules/cooldown.js"
+import { ODHelpMenuManager } from "./modules/helpmenu.js"
+import { ODStatisticManager } from "./modules/statistic.js"
+import { ODCodeManager } from "./modules/code.js"
+import { ODPostManager } from "./modules/post.js"
+import { ODClientManager } from "./modules/client.js"
+import { ODSharedFuseManager } from "./modules/fuse.js"
+import { ODStartScreenManager } from "./modules/startscreen.js"
 
 /**## ODMainManagers `interface`
  * The global properties for the main class of the bot.
@@ -142,7 +142,7 @@ export class ODMain implements ODMainManagers {
     constructor(managers:ODMainManagers,project:ODProjectType){
         this.project = project
         this.versions = managers.versions
-        this.versions.add(ODVersion.fromString("opendiscord:api","v0.2.11"))
+        this.versions.add(ODVersion.fromString("opendiscord:api","v0.2.13"))
         this.versions.add(ODVersion.fromString("opendiscord:livestatus","v2.0.0"))
 
         this.debugfile = managers.debugfile

package/src/api/modules/action.ts

@@ -1,9 +1,9 @@
 ///////////////////////////////////////
 //ACTION MODULE
 ///////////////////////////////////////
-import { ODId, ODManager, ODValidId, ODSystemError, ODManagerData, ODNoGeneric } from "./base"
-import { ODWorkerManager, ODWorkerCallback, ODWorker } from "./worker"
-import { ODDebugger } from "./console"
+import { ODId, ODManager, ODValidId, ODSystemError, ODManagerData, ODNoGeneric } from "./base.js"
+import { ODWorkerManager, ODWorkerCallback, ODWorker } from "./worker.js"
+import { ODDebugger } from "./console.js"
 
 /**## ODActionImplementation `class`
  * This is an Open Discord action implementation.
@@ -12,17 +12,17 @@ import { ODDebugger } from "./console"
  * 
  * This class can't be used stand-alone & needs to be extended from!
  */
-export class ODActionImplementation<Source extends string,Params extends object,Result extends object,WorkerIds extends string = string> extends ODManagerData {
+export class ODActionImplementation<Origin extends string,Params extends object,Result extends object,WorkerIds extends string = string> extends ODManagerData {
     /**The manager that has all workers of this implementation */
-    workers: ODWorkerManager<Partial<Result>,Source,Params,WorkerIds>
+    workers: ODWorkerManager<Partial<Result>,Origin,Params,WorkerIds>
 
-    constructor(id:ODValidId, callback?:ODWorkerCallback<Result,Source,Params>, priority?:number, callbackId?:ODValidId){
+    constructor(id:ODValidId, callback?:ODWorkerCallback<Partial<Result>,Origin,Params>, priority?:number, callbackId?:ODValidId){
         super(id)
         this.workers = new ODWorkerManager("descending")
         if (callback) this.workers.add(new ODWorker(callbackId ? callbackId : id,priority ?? 0,callback))
     }
     /**Execute all workers & return the result. */
-    async run(source:Source, params:Params): Promise<Partial<Result>> {
+    async run(origin:Origin, params:Params): Promise<Partial<Result>> {
         throw new ODSystemError("Tried to build an unimplemented ODResponderImplementation")
     }
 }
@@ -30,7 +30,7 @@ export class ODActionImplementation<Source extends string,Params extends object,
 /**## ODActionManagerIdConstraint `type`
  * The constraint/layout for id mappings/interfaces of the `ODActionManager` class.
  */
-export type ODActionManagerIdConstraint = Record<string,{source:string,params:object,result:object,workers:string}>
+export type ODActionManagerIdConstraint = Record<string,{origin:string,params:object,result:object,workers:string}>
 
 /**## ODActionManager `class`
  * This is an Open Discord action manager.
@@ -47,14 +47,14 @@ export class ODActionManager<IdList extends ODActionManagerIdConstraint = ODActi
         super(debug,"action")
     }
 
-    get<ActionId extends keyof ODNoGeneric<IdList>>(id:ActionId): ODAction<IdList[ActionId]["source"],IdList[ActionId]["params"],IdList[ActionId]["result"],IdList[ActionId]["workers"]>
+    get<ActionId extends keyof ODNoGeneric<IdList>>(id:ActionId): ODAction<IdList[ActionId]["origin"],IdList[ActionId]["params"],IdList[ActionId]["result"],IdList[ActionId]["workers"]>
     get(id:ODValidId): ODAction<string,{},{},string>|null
     
     get(id:ODValidId): ODAction<string,{},{},string>|null {
         return super.get(id)
     }
 
-    remove<ActionId extends keyof ODNoGeneric<IdList>>(id:ActionId): ODAction<IdList[ActionId]["source"],IdList[ActionId]["params"],IdList[ActionId]["result"],IdList[ActionId]["workers"]>
+    remove<ActionId extends keyof ODNoGeneric<IdList>>(id:ActionId): ODAction<IdList[ActionId]["origin"],IdList[ActionId]["params"],IdList[ActionId]["result"],IdList[ActionId]["workers"]>
     remove(id:ODValidId): ODAction<string,{},{},string>|null
     
     remove(id:ODValidId): ODAction<string,{},{},string>|null {
@@ -76,14 +76,14 @@ export class ODActionManager<IdList extends ODActionManagerIdConstraint = ODActi
  * 
  * Can be used standalone.
  */
-export class ODAction<Source extends string,Params extends object,Result extends object,WorkerIds extends string = string> extends ODActionImplementation<Source,Params,Result,WorkerIds> {
+export class ODAction<Origin extends string,Params extends object,Result extends object,WorkerIds extends string = string> extends ODActionImplementation<Origin,Params,Result,WorkerIds> {
     /**Run this action */
-    async run(source:Source, params:Params): Promise<Partial<Result>> {
+    async run(origin:Origin, params:Params): Promise<Partial<Result>> {
         //create instance
         const instance = {}
         
         //wait for workers to finish
-        await this.workers.executeWorkers(instance,source,params)
+        await this.workers.executeWorkers(instance,origin,params)
 
         //return data generated by workers
         return instance

package/src/api/modules/base.ts

@@ -2,8 +2,8 @@
 //BASE MODULE
 ///////////////////////////////////////
 import * as fs from "fs"
-import { ODDebugger } from "./console"
-import type { ODMain } from "../main"
+import { ODDebugger } from "./console.js"
+import type { ODMain } from "../main.js"
 
 /**## ODPromiseVoid `type`
  * This is a simple type to represent a callback return value that could be a promise or not.
@@ -37,7 +37,7 @@ export type ODValidId = string|number|symbol|ODId
  * 
  * list: `string`, `number`, `boolean`, `array`, `object`, `null`
  */
-export type ODValidJsonType = string|number|boolean|object|ODValidJsonType[]|null
+export type ODValidJsonType = string|number|boolean|{[key:string]:ODValidJsonType}|ODValidJsonType[]|null
 
 /**## ODInterfaceWithPartialProperty `type`
  * A utility type to create an interface where some properties are optional!
@@ -734,9 +734,9 @@ export class ODHTTPPostRequest {
  */
 export class ODEnvHelper {
     /**All variables found in the `.env` file */
-    dotenv: object
+    dotenv: Record<string,any>
     /**All variables found in `process.env` */
-    env: object
+    env: Record<string,any>
 
     constructor(customEnvPath?:string){
         if (typeof customEnvPath != "undefined" && typeof customEnvPath != "string") throw new ODSystemError("Invalid constructor parameter => customEnvPath?:string")
@@ -767,7 +767,7 @@ export class ODEnvHelper {
     //Source: https://github.com/motdotla/dotenv/blob/master/lib/main.js#L12
     #readDotEnv(src:Buffer){
         const LINE = /(?:^|^)\s*(?:export\s+)?([\w.-]+)(?:\s*=\s*?|:\s+?)(\s*'(?:\\'|[^'])*'|\s*"(?:\\"|[^"])*"|\s*`(?:\\`|[^`])*`|[^#\r\n]+)?\s*(?:#.*)?(?:$|$)/mg
-        const obj = {}
+        const obj: Record<string,any> = {}
         
         // Convert buffer to string
         let lines = src.toString()
@@ -815,8 +815,10 @@ export class ODSystemError extends Error {
 
     /**Create an `ODSystemError` directly from an `Error` class */
     static fromError(err:Error){
-        err["_ODErrorType"] = "system"
-        return err as ODSystemError
+        const modifiedErr: ODSystemError = Object.assign(err,{
+            _ODErrorType:"system"
+        })
+        return modifiedErr as ODSystemError
     }
 }
 
@@ -831,8 +833,10 @@ export class ODPluginError extends Error {
 
     /**Create an `ODPluginError` directly from an `Error` class */
     static fromError(err:Error){
-        err["_ODErrorType"] = "plugin"
-        return err as ODPluginError
+        const modifiedErr: ODPluginError = Object.assign(err,{
+            _ODErrorType:"plugin"
+        })
+        return modifiedErr as ODPluginError
     }
 }