@open-discord-bots/framework 0.3.1 → 0.3.2

package/dist/api/main.js

@@ -43,7 +43,7 @@ export class ODMain {
     constructor(managers, project) {
         this.project = project;
         this.versions = managers.versions;
-        this.versions.add(ODVersion.fromString("opendiscord:api", "v0.3.1"));
+        this.versions.add(ODVersion.fromString("opendiscord:api", "v0.3.2"));
         this.versions.add(ODVersion.fromString("opendiscord:livestatus", "v2.0.0"));
         this.debugfile = managers.debugfile;
         this.console = managers.console;

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.1",
+    "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.1"))
+        this.versions.add(ODVersion.fromString("opendiscord:api","v0.3.2"))
         this.versions.add(ODVersion.fromString("opendiscord:livestatus","v2.0.0"))
 
         this.debugfile = managers.debugfile

package/src/utilities/index.ts

@@ -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!
@@ -166,6 +167,27 @@ 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.
  */