@open-discord-bots/framework 0.3.0 → 0.3.2

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

@@ -45,12 +45,21 @@ export type ODSessionTimeoutCallback = (id: string, timeout: "default" | "custom
  * You can almost compare it to the PHP session system.
  */
 export declare class ODSession extends ODManagerData {
-    #private;
+    /**The history of previously generated instance ids. Used to reduce the risk of generating the same id twice. */
+    protected idHistory: string[];
+    /**The max length of the instance id history. */
+    protected maxIdHistoryLength: number;
     /**An array of all the currently active session instances. */
     sessions: ODSessionInstance[];
     /**The default amount of minutes before a session automatically stops. */
     timeoutMinutes: number;
+    /**The id of the auto-timeout session checker interval */
+    protected intervalId: NodeJS.Timeout;
+    /**Listeners for when a session times-out. */
+    protected timeoutListeners: ODSessionTimeoutCallback[];
     constructor(id: ODValidId, intervalSeconds?: number);
+    /**Create a unique hex id of 8 characters and add it to the instance id history */
+    protected createUniqueId(): string;
     /**Stop the global interval that automatically deletes timed-out sessions. (This action can't be reverted!) */
     stopAutoTimeout(): void;
     /**Start a session instance with data. Returns the unique id required to access the session. */

package/dist/api/modules/session.js

@@ -33,21 +33,21 @@ export class ODSessionManager extends ODManager {
  */
 export class ODSession extends ODManagerData {
     /**The history of previously generated instance ids. Used to reduce the risk of generating the same id twice. */
-    #idHistory = [];
+    idHistory = [];
     /**The max length of the instance id history. */
-    #maxIdHistoryLength = 500;
+    maxIdHistoryLength = 500;
     /**An array of all the currently active session instances. */
     sessions = [];
     /**The default amount of minutes before a session automatically stops. */
     timeoutMinutes = 30;
     /**The id of the auto-timeout session checker interval */
-    #intervalId;
+    intervalId;
     /**Listeners for when a session times-out. */
-    #timeoutListeners = [];
+    timeoutListeners = [];
     constructor(id, intervalSeconds) {
         super(id);
         //create the auto-timeout session checker
-        this.#intervalId = setInterval(() => {
+        this.intervalId = setInterval(() => {
             const deletableSessions = [];
             //collect all deletable sessions
             this.sessions.forEach((session) => {
@@ -65,30 +65,30 @@ export class ODSession extends ODManagerData {
                 const index = this.sessions.findIndex((s) => s.id === session.instance.id);
                 this.sessions.splice(index, 1);
                 //emit timeout listeners
-                this.#timeoutListeners.forEach((cb) => cb(session.instance.id, session.reason, session.instance.data, new Date(session.instance.creation)));
+                this.timeoutListeners.forEach((cb) => cb(session.instance.id, session.reason, session.instance.data, new Date(session.instance.creation)));
             });
         }, ((intervalSeconds) ? (intervalSeconds * 1000) : 60000));
     }
     /**Create a unique hex id of 8 characters and add it to the instance id history */
-    #createUniqueId() {
+    createUniqueId() {
         const hex = crypto.randomBytes(4).toString("hex");
-        if (this.#idHistory.includes(hex)) {
-            return this.#createUniqueId();
+        if (this.idHistory.includes(hex)) {
+            return this.createUniqueId();
         }
         else {
-            this.#idHistory.push(hex);
-            if (this.#idHistory.length > this.#maxIdHistoryLength)
-                this.#idHistory.shift();
+            this.idHistory.push(hex);
+            if (this.idHistory.length > this.maxIdHistoryLength)
+                this.idHistory.shift();
             return hex;
         }
     }
     /**Stop the global interval that automatically deletes timed-out sessions. (This action can't be reverted!) */
     stopAutoTimeout() {
-        clearInterval(this.#intervalId);
+        clearInterval(this.intervalId);
     }
     /**Start a session instance with data. Returns the unique id required to access the session. */
     start(data) {
-        const id = this.#createUniqueId();
+        const id = this.createUniqueId();
         this.sessions.push({
             id, data,
             creation: new Date().getTime(),
@@ -137,6 +137,6 @@ export class ODSession extends ODManagerData {
     }
     /**Listen for a session timeout (default or custom) */
     onTimeout(callback) {
-        this.#timeoutListeners.push(callback);
+        this.timeoutListeners.push(callback);
     }
 }

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

@@ -17,7 +17,6 @@ export type ODStartScreenManagerIdConstraint = Record<string, ODStartScreenCompo
  * The startscreen is the part you see when the bot has started up successfully. (e.g. the Open Discord logo, logs, livestatus, flags, ...)
  */
 export declare class ODStartScreenManager<IdList extends ODStartScreenManagerIdConstraint = ODStartScreenManagerIdConstraint, LiveStatus extends ODLiveStatusManager = ODLiveStatusManager> extends ODManager<ODStartScreenComponent> {
-    #private;
     /**Alias to the livestatus manager. */
     livestatus: LiveStatus;
     constructor(debug: ODDebugger, livestatus: LiveStatus);

package/dist/api/modules/startscreen.js

@@ -11,13 +11,10 @@ import ansis from "ansis";
  * The startscreen is the part you see when the bot has started up successfully. (e.g. the Open Discord logo, logs, livestatus, flags, ...)
  */
 export class ODStartScreenManager extends ODManager {
-    /**Alias to the Open Discord debugger. */
-    #debug;
     /**Alias to the livestatus manager. */
     livestatus;
     constructor(debug, livestatus) {
         super(debug, "startscreen component");
-        this.#debug = debug;
         this.livestatus = livestatus;
     }
     /**Get all components in sorted order. */
@@ -37,11 +34,11 @@ export class ODStartScreenManager extends ODManager {
             try {
                 const renderedText = await component.renderAll(location);
                 console.log(renderedText);
-                this.#debug.console.debugfile.writeText("[STARTSCREEN] Component: \"" + component.id + "\"\n" + ansis.strip(renderedText));
+                this.debug?.console.debugfile.writeText("[STARTSCREEN] Component: \"" + component.id + "\"\n" + ansis.strip(renderedText));
             }
             catch (e) {
-                this.#debug.console.log("Unable to render \"" + component.id + "\" startscreen component!", "error");
-                this.#debug.console.debugfile.writeErrorMessage(new ODError(e, "uncaughtException"));
+                this.debug?.console.log("Unable to render \"" + component.id + "\" startscreen component!", "error");
+                this.debug?.console.debugfile.writeErrorMessage(new ODError(e, "uncaughtException"));
             }
             location++;
         }

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

@@ -29,9 +29,10 @@ export type ODStatisticManagerIdConstraint = Record<string, ODStatisticScope>;
  * Statistic can be accessed in the individual scopes.
  */
 export declare class ODStatisticManager<IdList extends ODStatisticManagerIdConstraint = ODStatisticManagerIdConstraint> extends ODManager<ODStatisticScope> {
-    #private;
     /**Alias to Open Discord statistics database. */
     database: ODDatabase<ODDatabaseIdConstraint> | null;
+    /**All the listeners for the init event. */
+    protected initListeners: ODStatisticManagerInitCallback[];
     constructor(debug: ODDebugger);
     /**Select the database to use to read/write all statistics from/to. */
     useDatabase(database: ODDatabase<ODDatabaseIdConstraint>): void;

package/dist/api/modules/statistic.js

@@ -11,22 +11,19 @@ import { ODId, ODManager, ODManagerData, ODSystemError } from "./base.js";
  * Statistic can be accessed in the individual scopes.
  */
 export class ODStatisticManager extends ODManager {
-    /**Alias to Open Discord debugger. */
-    #debug;
     /**Alias to Open Discord statistics database. */
     database = null;
     /**All the listeners for the init event. */
-    #initListeners = [];
+    initListeners = [];
     constructor(debug) {
         super(debug, "statistic scope");
-        this.#debug = debug;
     }
     /**Select the database to use to read/write all statistics from/to. */
     useDatabase(database) {
         this.database = database;
     }
     add(data, overwrite) {
-        data.useDebug(this.#debug, "stat");
+        data.useDebug(this.debug, "stat");
         if (this.database)
             data.useDatabase(this.database);
         return super.add(data, overwrite);
@@ -48,7 +45,7 @@ export class ODStatisticManager extends ODManager {
                 deletableStats.push(data);
         });
         //do additional deletion
-        for (const cb of this.#initListeners) {
+        for (const cb of this.initListeners) {
             await cb(data, deletableStats);
         }
         //delete all deletable statistics
@@ -69,7 +66,7 @@ export class ODStatisticManager extends ODManager {
     }
     /**Run a function when the statistics are initialized. This can be used to clear statistics from users that left the server or tickets which don't exist anymore. */
     onInit(callback) {
-        this.#initListeners.push(callback);
+        this.initListeners.push(callback);
     }
     get(id) {
         return super.get(id);

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

@@ -28,7 +28,8 @@ export declare class ODWorker<Instance, Origin extends string, Params> extends O
  * You can register a custom worker in this class to create a message or button.
  */
 export declare class ODWorkerManager<Instance, Origin extends string, Params, WorkerIds extends string = string> extends ODManager<ODWorker<Instance, Origin, Params>> {
-    #private;
+    /**The order of execution for workers inside this manager. */
+    protected priorityOrder: "ascending" | "descending";
     /**The backup worker will be executed when one of the workers fails or cancels execution. */
     backupWorker: ODWorker<{
         reason: "error" | "cancel";

package/dist/api/modules/worker.js

@@ -32,12 +32,12 @@ export class ODWorker extends ODManagerData {
  */
 export class ODWorkerManager extends ODManager {
     /**The order of execution for workers inside this manager. */
-    #priorityOrder;
+    priorityOrder;
     /**The backup worker will be executed when one of the workers fails or cancels execution. */
     backupWorker = null;
     constructor(priorityOrder) {
         super();
-        this.#priorityOrder = priorityOrder;
+        this.priorityOrder = priorityOrder;
     }
     /**Get all workers in sorted order. */
     getSortedWorkers(priority) {
@@ -52,7 +52,7 @@ export class ODWorkerManager extends ODManager {
     /**Execute all workers on an instance using the given origin & parameters. */
     async executeWorkers(instance, origin, params) {
         const derefParams = { ...params };
-        const workers = this.getSortedWorkers(this.#priorityOrder);
+        const workers = this.getSortedWorkers(this.priorityOrder);
         let didCancel = false;
         let didCrash = false;
         for (const worker of workers) {

package/dist/utilities/index.d.ts

@@ -1,4 +1,5 @@
 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!
  */
@@ -55,6 +56,12 @@ export declare function ordinalNumber(num: number): string;
  * Trim/remove all emoji's from a Javascript string.
  */
 export declare function trimEmojis(text: string): string;
+/**## getMessageFromBuildResult `utility function`
+ * Get the final `messageCreateOptions` from a returned build result from builders/components.
+ */
+export declare function getMessageFromBuildResult(build: api.ODMessageBuildResult | api.ODMessageComponentBuildResult, type: "interaction" | "message"): discord.MessageCreateOptions & {
+    flags: number[];
+};
 /**## easterEggs `utility object`
  * Object containing data for Open Ticket easter eggs.
  */

package/dist/utilities/index.js

@@ -1,6 +1,7 @@
 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!
  */
@@ -163,6 +164,32 @@ export function ordinalNumber(num) {
 export function trimEmojis(text) {
     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, type) {
+    const msgFlags = [];
+    let msgData;
+    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.
  */

package/package.json

@@ -1,7 +1,7 @@
 {
     "name": "@open-discord-bots/framework",
     "author": "DJj123dj",
-    "version": "0.3.0",
+    "version": "0.3.2",
     "description": "The core framework of the popular open-source discord bots: Open Ticket & Open Moderation.",
     "main": "dist/index.js",
     "module": "dist/index.js",

package/src/api/main.ts

@@ -150,7 +150,7 @@ export abstract class ODMain implements ODMainManagers {
     constructor(managers:ODMainManagers,project:ODProjectType){
         this.project = project
         this.versions = managers.versions
-        this.versions.add(ODVersion.fromString("opendiscord:api","v0.3.0"))
+        this.versions.add(ODVersion.fromString("opendiscord:api","v0.3.2"))
         this.versions.add(ODVersion.fromString("opendiscord:livestatus","v2.0.0"))
 
         this.debugfile = managers.debugfile