@open-discord-bots/framework 0.3.4 → 0.3.6

package/dist/api/main.js

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

package/dist/api/modules/client.js

@@ -348,7 +348,7 @@ export class ODClientManager {
                     return { success: false };
                 const channel = await user.createDM();
                 const msg = await channel.send(finalMessage);
-                return { success: true, message: msg };
+                return { success: true, message: msg, ephemeral: false };
             }
             else {
                 const newUser = await this.fetchUser(user);
@@ -358,7 +358,7 @@ export class ODClientManager {
                     return { success: false };
                 const channel = await newUser.createDM();
                 const msg = await channel.send(finalMessage);
-                return { success: true, message: msg };
+                return { success: true, message: msg, ephemeral: false };
             }
         }
         catch {

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

@@ -129,7 +129,7 @@ export declare class ODPermissionManager<IdList extends ODPermissionManagerIdCon
     private defaultGlobalCalculation;
     /**Check for channel permissions. Result will be compared with the global perms in `#defaultCalculation()`. */
     private defaultChannelCalculation;
-    /**Check the permissions for a certain command of the bot. */
+    /**Check the permissions for a certain command of the bot. Permission mode: `none`, `everyone`, `admin` or any valid discord role ID. */
     checkCommandPerms(permissionMode: string, requiredLevel: ODPermissionType, user: discord.User, member?: discord.GuildMember | null, channel?: discord.Channel | null, guild?: discord.Guild | null, settings?: ODPermissionSettings): Promise<ODPermissionCommandResult>;
     get<PermissionId extends keyof ODNoGeneric<IdList>>(id: PermissionId): IdList[PermissionId];
     get(id: ODValidId): ODPermission | null;

package/dist/api/modules/permission.js

@@ -238,7 +238,7 @@ export class ODPermissionManager extends ODManager {
         //spread result to prevent accidental modification because of referencing
         return { ...this.defaultResult };
     }
-    /**Check the permissions for a certain command of the bot. */
+    /**Check the permissions for a certain command of the bot. Permission mode: `none`, `everyone`, `admin` or any valid discord role ID. */
     async checkCommandPerms(permissionMode, requiredLevel, user, member, channel, guild, settings) {
         if (permissionMode === "none") {
             return { hasPerms: false, reason: "disabled" };

package/dist/api/modules/post.js

@@ -89,7 +89,7 @@ export class ODPost extends ODManagerData {
         try {
             const finalMessage = this.getMessageFromBuildResult(build, "message");
             const sent = await this.channel.send(finalMessage);
-            return { success: true, message: sent };
+            return { success: true, message: sent, ephemeral: false };
         }
         catch {
             return { success: false };

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

@@ -33,6 +33,8 @@ export type ODResponderSendResult<InGuild extends boolean> = {
     success: true;
     /**The message that got sent. */
     message: discord.Message<InGuild>;
+    /**Was the message sent as ephemeral? */
+    ephemeral: boolean;
 } | {
     /**Did the message get sent successfully? */
     success: false;

package/dist/api/modules/responder.js

@@ -428,18 +428,18 @@ export class ODCommandResponderInstance extends ODBaseResponderInstance {
                 if (this.interaction.replied || this.interaction.deferred) {
                     const sent = await this.interaction.editReply(finalMessage);
                     this.ignoreResponderTimeout = true;
-                    return { success: true, message: sent };
+                    return { success: true, message: sent, ephemeral: build.ephemeral };
                 }
                 else {
                     const sent = await this.interaction.reply(finalMessage);
                     this.ignoreResponderTimeout = true;
-                    return { success: true, message: await sent.fetch() };
+                    return { success: true, message: await sent.fetch(), ephemeral: build.ephemeral };
                 }
             }
             else if (this.type == "message" && this.interaction instanceof discord.Message && this.interaction.channel.type != discord.ChannelType.GroupDM) {
                 const sent = await this.interaction.channel.send(finalMessage);
                 this.ignoreResponderTimeout = true;
-                return { success: true, message: sent };
+                return { success: true, message: sent, ephemeral: false };
             }
             else
                 return { success: false };
@@ -600,12 +600,12 @@ export class ODButtonResponderInstance extends ODBaseResponderInstance {
             if (this.interaction.replied || this.interaction.deferred) {
                 const sent = await this.interaction.editReply(finalMessage);
                 this.ignoreResponderTimeout = true;
-                return { success: true, message: sent };
+                return { success: true, message: sent, ephemeral: build.ephemeral };
             }
             else {
                 const sent = await this.interaction.reply(finalMessage);
                 this.ignoreResponderTimeout = true;
-                return { success: true, message: await sent.fetch() };
+                return { success: true, message: await sent.fetch(), ephemeral: build.ephemeral };
             }
         }
         catch {
@@ -619,12 +619,12 @@ export class ODButtonResponderInstance extends ODBaseResponderInstance {
             if (this.interaction.replied || this.interaction.deferred) {
                 const sent = await this.interaction.editReply(finalMessage);
                 this.ignoreResponderTimeout = true;
-                return { success: true, message: await sent.fetch() };
+                return { success: true, message: await sent.fetch(), ephemeral: build.ephemeral };
             }
             else {
                 const sent = await this.interaction.update(finalMessage);
                 this.ignoreResponderTimeout = true;
-                return { success: true, message: await sent.fetch() };
+                return { success: true, message: await sent.fetch(), ephemeral: build.ephemeral };
             }
         }
         catch {
@@ -908,12 +908,12 @@ export class ODDropdownResponderInstance extends ODBaseResponderInstance {
             if (this.interaction.replied || this.interaction.deferred) {
                 const sent = await this.interaction.editReply(finalMessage);
                 this.ignoreResponderTimeout = true;
-                return { success: true, message: sent };
+                return { success: true, message: sent, ephemeral: build.ephemeral };
             }
             else {
                 const sent = await this.interaction.reply(finalMessage);
                 this.ignoreResponderTimeout = true;
-                return { success: true, message: await sent.fetch() };
+                return { success: true, message: await sent.fetch(), ephemeral: build.ephemeral };
             }
         }
         catch {
@@ -927,12 +927,12 @@ export class ODDropdownResponderInstance extends ODBaseResponderInstance {
             if (this.interaction.replied || this.interaction.deferred) {
                 const sent = await this.interaction.editReply(finalMessage);
                 this.ignoreResponderTimeout = true;
-                return { success: true, message: await sent.fetch() };
+                return { success: true, message: await sent.fetch(), ephemeral: build.ephemeral };
             }
             else {
                 const sent = await this.interaction.update(finalMessage);
                 this.ignoreResponderTimeout = true;
-                return { success: true, message: await sent.fetch() };
+                return { success: true, message: await sent.fetch(), ephemeral: build.ephemeral };
             }
         }
         catch {
@@ -1132,7 +1132,7 @@ export class ODModalResponderInstance extends ODBaseResponderInstance {
             const finalMessage = this.getMessageFromBuildResult(build, "interaction");
             const sent = await this.interaction.followUp(finalMessage);
             this.ignoreResponderTimeout = true;
-            return { success: true, message: sent };
+            return { success: true, message: sent, ephemeral: build.ephemeral };
         }
         catch {
             return { success: false };
@@ -1145,12 +1145,12 @@ export class ODModalResponderInstance extends ODBaseResponderInstance {
             if (this.interaction.replied || this.interaction.deferred) {
                 const sent = await this.interaction.editReply(finalMessage);
                 this.ignoreResponderTimeout = true;
-                return { success: true, message: await sent.fetch() };
+                return { success: true, message: await sent.fetch(), ephemeral: build.ephemeral };
             }
             else {
                 const sent = await this.interaction.reply(finalMessage);
                 this.ignoreResponderTimeout = true;
-                return { success: true, message: await sent.fetch() };
+                return { success: true, message: await sent.fetch(), ephemeral: build.ephemeral };
             }
         }
         catch {
@@ -1296,12 +1296,12 @@ export class ODContextMenuResponderInstance extends ODBaseResponderInstance {
             if (this.interaction.replied || this.interaction.deferred) {
                 const sent = await this.interaction.editReply(finalMessage);
                 this.ignoreResponderTimeout = true;
-                return { success: true, message: sent };
+                return { success: true, message: sent, ephemeral: build.ephemeral };
             }
             else {
                 const sent = await this.interaction.reply(finalMessage);
                 this.ignoreResponderTimeout = true;
-                return { success: true, message: await sent.fetch() };
+                return { success: true, message: await sent.fetch(), ephemeral: build.ephemeral };
             }
         }
         catch {
@@ -1315,7 +1315,7 @@ export class ODContextMenuResponderInstance extends ODBaseResponderInstance {
             if (this.interaction.replied || this.interaction.deferred) {
                 const sent = await this.interaction.editReply(finalMessage);
                 this.ignoreResponderTimeout = true;
-                return { success: true, message: await sent.fetch() };
+                return { success: true, message: await sent.fetch(), ephemeral: build.ephemeral };
             }
             else
                 throw new ODSystemError("Unable to update context menu interaction!");

package/dist/api/modules/startscreen.js

@@ -182,7 +182,7 @@ export class ODStartScreenCategoryComponent extends ODStartScreenComponent {
         super(id, priority, async (location) => {
             const contents = await render(location);
             if (contents != "" || this.renderIfEmpty) {
-                return ansis.bold.underline("\n" + name.toUpperCase() + (contents != "" ? ":\n" : ":")) + contents;
+                return ansis.bold.underline("\n" + this.name.toUpperCase() + (contents != "" ? ":\n" : ":")) + contents;
             }
             else
                 return "";
@@ -265,7 +265,7 @@ export class ODStartScreenLiveStatusCategoryComponent extends ODStartScreenCateg
     /**A reference to the Open Discord livestatus manager. */
     livestatus;
     constructor(id, priority, livestatus) {
-        super(id, priority, "livestatus", async () => {
+        super(id, priority, "news & updates", async () => {
             const messages = await this.livestatus.getAllMessages();
             return this.livestatus.renderer.render(messages);
         }, false);

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

@@ -6,16 +6,18 @@ import * as discord from "discord.js";
 /**## ODStateKey `type`
  * The key template for message states.
  */
-export interface ODStateKey {
-    /**A valid discord server/guild ID or instance. */
-    guild?: discord.Guild | string | null;
+export type ODStateKey<WithGuildKey extends boolean, WithUserKey extends boolean> = {
     /**A valid discord channel ID or instance. */
     channel: discord.Channel | string;
     /**A valid discord message ID or instance. */
     message: discord.Message | string;
+} & (WithGuildKey extends true ? {
+    /**A valid discord server/guild ID or instance. */
+    guild: discord.Guild | string;
+} : {}) & (WithUserKey extends true ? {
     /**A valid discord user ID or instance. */
-    user?: discord.User | discord.GuildMember | string | null;
-}
+    user: discord.User | discord.GuildMember | string;
+} : {});
 /**## ODStateData `type`
  * The raw data template for message states used for storing in the database.
  */
@@ -65,7 +67,7 @@ export interface ODStateSettings {
  *
  * Features automatic garbage collection to clear expired states.
  */
-export declare class ODState<StateData extends any> extends ODManagerData {
+export declare class ODState<StateData extends any, WithGuildKey extends boolean = true, WithUserKey extends boolean = true> extends ODManagerData {
     /**Alias to Open Discord message states database. */
     protected database: ODDatabase<ODDatabaseIdConstraint>;
     /**Alias to Open Discord client manager. */
@@ -82,17 +84,17 @@ export declare class ODState<StateData extends any> extends ODManagerData {
     /**Purge all expired message states that reached a timeout or ephemeral. */
     protected purgeExpiredStates(): Promise<void>;
     /**Transform the object-based message state key contents to a string. */
-    protected transformKey(key: ODStateKey): string;
+    protected transformKey(key: ODStateKey<WithGuildKey, WithUserKey>): string;
     /**Transform the message state data contents for storage in the database. */
-    protected transformData(key: ODStateKey, data: StateData, isEphemeral: boolean, keepCreatedDate?: number): ODStateData<StateData>;
+    protected transformData(key: ODStateKey<WithGuildKey, WithUserKey>, data: StateData, isEphemeral: boolean, keepCreatedDate?: number): ODStateData<StateData>;
     /**Calculate milliseconds from a time + unit. */
     protected timeoutToUnixTime(): number | null;
     /**Set a message state using guild, channel & message id as key. Returns `true` when overwritten. */
-    setMsgState(key: ODStateKey, data: StateData, isEphemeral: boolean): Promise<boolean>;
+    setMsgState(key: ODStateKey<WithGuildKey, WithUserKey>, data: StateData, isEphemeral: boolean): Promise<boolean>;
     /**Get a message state using guild, channel & message id as key. */
-    getMsgState(key: ODStateKey): Promise<ODStateData<StateData> | null>;
+    getMsgState(key: ODStateKey<WithGuildKey, WithUserKey>): Promise<ODStateData<StateData> | null>;
     /**Delete a message state using guild, channel & message id as key. Returns `true` when deleted. */
-    deleteMsgState(key: ODStateKey): Promise<boolean>;
+    deleteMsgState(key: ODStateKey<WithGuildKey, WithUserKey>): Promise<boolean>;
     /**List all message states of this `ODState`. */
     listMsgStates(): Promise<{
         key: string;

package/dist/api/modules/state.js

@@ -120,18 +120,18 @@ export class ODState extends ODManagerData {
     }
     /**Transform the object-based message state key contents to a string. */
     transformKey(key) {
-        const newGuild = (!key.guild) ? "NULL" : (typeof key.guild === "string" ? key.guild : key.guild.id);
+        const newGuild = (!("guild" in key) || !key.guild) ? "NULL" : (typeof key.guild === "string" ? key.guild : key.guild.id);
         const newChannel = (!key.channel) ? "NULL" : (typeof key.channel === "string" ? key.channel : key.channel.id);
         const newMessage = (!key.message) ? "NULL" : (typeof key.message === "string" ? key.message : key.message.id);
-        const newUser = (!key.user) ? "NULL" : (typeof key.user === "string" ? key.user : key.user.id);
+        const newUser = (!("user" in key) || !key.user) ? "NULL" : (typeof key.user === "string" ? key.user : key.user.id);
         return `G:${newGuild},C:${newChannel},M:${newMessage},U:${newUser}`;
     }
     /**Transform the message state data contents for storage in the database. */
     transformData(key, data, isEphemeral, keepCreatedDate) {
-        const guildId = (!key.guild) ? null : (typeof key.guild === "string" ? key.guild : key.guild.id);
+        const guildId = (!("guild" in key) || !key.guild) ? null : (typeof key.guild === "string" ? key.guild : key.guild.id);
         const channelId = (typeof key.channel === "string" ? key.channel : key.channel.id);
         const messageId = (typeof key.message === "string" ? key.message : key.message.id);
-        const userId = (!key.user) ? null : (typeof key.user === "string" ? key.user : key.user.id);
+        const userId = (!("user" in key) || !key.user) ? null : (typeof key.user === "string" ? key.user : key.user.id);
         const createdDate = keepCreatedDate ?? Date.now();
         const modifiedDate = Date.now();
         const unmodifiedTimeoutDate = this.timeoutToUnixTime();

package/package.json

@@ -1,7 +1,7 @@
 {
     "name": "@open-discord-bots/framework",
     "author": "DJj123dj",
-    "version": "0.3.4",
+    "version": "0.3.6",
     "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

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

package/src/api/modules/client.ts

@@ -332,14 +332,14 @@ export class ODClientManager<SlashIdList extends ODSlashCommandManagerIdConstrai
                 if (user.bot) return {success:false}
                 const channel = await user.createDM()
                 const msg = await channel.send(finalMessage)
-                return {success:true,message:msg}
+                return {success:true,message:msg,ephemeral:false}
             }else{
                 const newUser = await this.fetchUser(user)
                 if (!newUser) throw new Error()
                 if (newUser.bot) return {success:false}
                 const channel = await newUser.createDM()
                 const msg = await channel.send(finalMessage)
-                return {success:true,message:msg}
+                return {success:true,message:msg,ephemeral:false}
             }
         }catch{
             try{

package/src/api/modules/permission.ts

@@ -310,7 +310,7 @@ export class ODPermissionManager<IdList extends ODPermissionManagerIdConstraint
         return {...this.defaultResult}
     }
 
-    /**Check the permissions for a certain command of the bot. */
+    /**Check the permissions for a certain command of the bot. Permission mode: `none`, `everyone`, `admin` or any valid discord role ID. */
     async checkCommandPerms(permissionMode:string,requiredLevel:ODPermissionType,user:discord.User,member?:discord.GuildMember|null,channel?:discord.Channel|null,guild?:discord.Guild|null,settings?:ODPermissionSettings): Promise<ODPermissionCommandResult> {
         if (permissionMode === "none"){
             return {hasPerms:false,reason:"disabled"}

package/src/api/modules/post.ts

@@ -111,7 +111,7 @@ export class ODPost<ChannelType extends discord.GuildBasedChannel> extends ODMan
         try{
             const finalMessage = this.getMessageFromBuildResult(build,"message")
             const sent = await this.channel.send(finalMessage)
-            return {success:true,message:sent}
+            return {success:true,message:sent,ephemeral:false}
         }catch{
             return {success:false}
         }

package/src/api/modules/responder.ts

@@ -44,7 +44,9 @@ export type ODResponderSendResult<InGuild extends boolean> = {
     /**Did the message get sent successfully? */
     success:true,
     /**The message that got sent. */
-    message:discord.Message<InGuild>
+    message:discord.Message<InGuild>,
+    /**Was the message sent as ephemeral? */
+    ephemeral:boolean
 } | {
     /**Did the message get sent successfully? */
     success:false
@@ -473,16 +475,16 @@ export class ODCommandResponderInstance extends ODBaseResponderInstance {
                 if (this.interaction.replied || this.interaction.deferred){
                     const sent = await this.interaction.editReply(finalMessage)
                     this.ignoreResponderTimeout = true
-                    return {success:true,message:sent}
+                    return {success:true,message:sent,ephemeral:build.ephemeral}
                 }else{
                     const sent = await this.interaction.reply(finalMessage)
                     this.ignoreResponderTimeout = true
-                    return {success:true,message:await sent.fetch()}
+                    return {success:true,message:await sent.fetch(),ephemeral:build.ephemeral}
                 }
             }else if (this.type == "message" && this.interaction instanceof discord.Message && this.interaction.channel.type != discord.ChannelType.GroupDM){
                 const sent = await this.interaction.channel.send(finalMessage)
                 this.ignoreResponderTimeout = true
-                return {success:true,message:sent}
+                return {success:true,message:sent,ephemeral:false}
             }else return {success:false}
         }catch{
             return {success:false}
@@ -661,11 +663,11 @@ export class ODButtonResponderInstance extends ODBaseResponderInstance {
             if (this.interaction.replied || this.interaction.deferred){
                 const sent = await this.interaction.editReply(finalMessage)
                 this.ignoreResponderTimeout = true
-                return {success:true,message:sent}
+                return {success:true,message:sent,ephemeral:build.ephemeral}
             }else{
                 const sent = await this.interaction.reply(finalMessage)
                 this.ignoreResponderTimeout = true
-                return {success:true,message:await sent.fetch()}
+                return {success:true,message:await sent.fetch(),ephemeral:build.ephemeral}
             }
         }catch{
             return {success:false}
@@ -678,11 +680,11 @@ export class ODButtonResponderInstance extends ODBaseResponderInstance {
             if (this.interaction.replied || this.interaction.deferred){
                 const sent = await this.interaction.editReply(finalMessage)
                 this.ignoreResponderTimeout = true
-                return {success:true,message:await sent.fetch()}
+                return {success:true,message:await sent.fetch(),ephemeral:build.ephemeral}
             }else{
                 const sent = await this.interaction.update(finalMessage)
                 this.ignoreResponderTimeout = true
-                return {success:true,message:await sent.fetch()}
+                return {success:true,message:await sent.fetch(),ephemeral:build.ephemeral}
             }
         }catch{
             return {success:false}
@@ -976,11 +978,11 @@ export class ODDropdownResponderInstance extends ODBaseResponderInstance {
             if (this.interaction.replied || this.interaction.deferred){
                 const sent = await this.interaction.editReply(finalMessage)
                 this.ignoreResponderTimeout = true
-                return {success:true,message:sent}
+                return {success:true,message:sent,ephemeral:build.ephemeral}
             }else{
                 const sent = await this.interaction.reply(finalMessage)
                 this.ignoreResponderTimeout = true
-                return {success:true,message:await sent.fetch()}
+                return {success:true,message:await sent.fetch(),ephemeral:build.ephemeral}
             }
         }catch{
             return {success:false}
@@ -993,11 +995,11 @@ export class ODDropdownResponderInstance extends ODBaseResponderInstance {
             if (this.interaction.replied || this.interaction.deferred){
                 const sent = await this.interaction.editReply(finalMessage)
                 this.ignoreResponderTimeout = true
-                return {success:true,message:await sent.fetch()}
+                return {success:true,message:await sent.fetch(),ephemeral:build.ephemeral}
             }else{
                 const sent = await this.interaction.update(finalMessage)
                 this.ignoreResponderTimeout = true
-                return {success:true,message:await sent.fetch()}
+                return {success:true,message:await sent.fetch(),ephemeral:build.ephemeral}
             }
         }catch{
             return {success:false}
@@ -1225,7 +1227,7 @@ export class ODModalResponderInstance extends ODBaseResponderInstance {
             const finalMessage = this.getMessageFromBuildResult(build,"interaction")
             const sent = await this.interaction.followUp(finalMessage)
             this.ignoreResponderTimeout = true
-            return {success:true,message:sent}
+            return {success:true,message:sent,ephemeral:build.ephemeral}
         }catch{
             return {success:false}
         }
@@ -1237,11 +1239,11 @@ export class ODModalResponderInstance extends ODBaseResponderInstance {
             if (this.interaction.replied || this.interaction.deferred){
                 const sent = await this.interaction.editReply(finalMessage)
                 this.ignoreResponderTimeout = true
-                return {success:true,message:await sent.fetch()}
+                return {success:true,message:await sent.fetch(),ephemeral:build.ephemeral}
             }else{
                 const sent = await this.interaction.reply(finalMessage)
                 this.ignoreResponderTimeout = true
-                return {success:true,message:await sent.fetch()}
+                return {success:true,message:await sent.fetch(),ephemeral:build.ephemeral}
             }
         }catch{
             return {success:false}
@@ -1405,11 +1407,11 @@ export class ODContextMenuResponderInstance extends ODBaseResponderInstance {
             if (this.interaction.replied || this.interaction.deferred){
                 const sent = await this.interaction.editReply(finalMessage)
                 this.ignoreResponderTimeout = true
-                return {success:true,message:sent}
+                return {success:true,message:sent,ephemeral:build.ephemeral}
             }else{
                 const sent = await this.interaction.reply(finalMessage)
                 this.ignoreResponderTimeout = true
-                return {success:true,message:await sent.fetch()}
+                return {success:true,message:await sent.fetch(),ephemeral:build.ephemeral}
             }
         }catch{
             return {success:false}
@@ -1422,7 +1424,7 @@ export class ODContextMenuResponderInstance extends ODBaseResponderInstance {
             if (this.interaction.replied || this.interaction.deferred){
                 const sent = await this.interaction.editReply(finalMessage)
                 this.ignoreResponderTimeout = true
-                return {success:true,message:await sent.fetch()}
+                return {success:true,message:await sent.fetch(),ephemeral:build.ephemeral}
             }else throw new ODSystemError("Unable to update context menu interaction!")
         }catch{
             return {success:false}

package/src/api/modules/startscreen.ts

@@ -232,7 +232,7 @@ export class ODStartScreenCategoryComponent extends ODStartScreenComponent {
         super(id,priority,async (location) => {
             const contents = await render(location)
             if (contents != "" || this.renderIfEmpty){
-                return ansis.bold.underline("\n"+name.toUpperCase()+(contents != "" ? ":\n" : ":")) + contents
+                return ansis.bold.underline("\n"+this.name.toUpperCase()+(contents != "" ? ":\n" : ":")) + contents
             }else return ""
         })
         this.name = name
@@ -324,7 +324,7 @@ export class ODStartScreenLiveStatusCategoryComponent<LiveStatus extends ODLiveS
     livestatus: LiveStatus
 
     constructor(id:ODValidId, priority:number, livestatus:LiveStatus){
-        super(id,priority,"livestatus",async () => {
+        super(id,priority,"news & updates",async () => {
             const messages = await this.livestatus.getAllMessages()
             return this.livestatus.renderer.render(messages)
         },false)

package/src/api/modules/state.ts

@@ -10,16 +10,20 @@ import * as discord from "discord.js"
 /**## ODStateKey `type`
  * The key template for message states.
  */
-export interface ODStateKey {
-    /**A valid discord server/guild ID or instance. */
-    guild?:discord.Guild|string|null,
+export type ODStateKey<WithGuildKey extends boolean,WithUserKey extends boolean> = {
     /**A valid discord channel ID or instance. */
     channel:discord.Channel|string,
     /**A valid discord message ID or instance. */
     message:discord.Message|string,
-    /**A valid discord user ID or instance. */
-    user?:discord.User|discord.GuildMember|string|null
 }
+& (WithGuildKey extends true ? {
+    /**A valid discord server/guild ID or instance. */
+    guild:discord.Guild|string,
+} : {})
+& (WithUserKey extends true ? {
+    /**A valid discord user ID or instance. */
+    user:discord.User|discord.GuildMember|string
+} : {})
 
 /**## ODStateData `type`
  * The raw data template for message states used for storing in the database.
@@ -69,7 +73,7 @@ export interface ODStateSettings {
  * 
  * Features automatic garbage collection to clear expired states. 
  */
-export class ODState<StateData extends any> extends ODManagerData {
+export class ODState<StateData extends any,WithGuildKey extends boolean = true,WithUserKey extends boolean = true> extends ODManagerData {
     /**Alias to Open Discord message states database. */
     protected database: ODDatabase<ODDatabaseIdConstraint>
     /**Alias to Open Discord client manager. */
@@ -175,20 +179,20 @@ export class ODState<StateData extends any> extends ODManagerData {
         }
     }
     /**Transform the object-based message state key contents to a string. */
-    protected transformKey(key:ODStateKey){
-        const newGuild = (!key.guild) ? "NULL" : (typeof key.guild === "string" ? key.guild : key.guild.id)
+    protected transformKey(key:ODStateKey<WithGuildKey,WithUserKey>){
+        const newGuild = (!("guild" in key) || !key.guild) ? "NULL" : (typeof key.guild === "string" ? key.guild : key.guild.id)
         const newChannel = (!key.channel) ? "NULL" : (typeof key.channel === "string" ? key.channel : key.channel.id)
         const newMessage = (!key.message) ? "NULL" : (typeof key.message === "string" ? key.message : key.message.id)
-        const newUser = (!key.user) ? "NULL" : (typeof key.user === "string" ? key.user : key.user.id)
+        const newUser = (!("user" in key) || !key.user) ? "NULL" : (typeof key.user === "string" ? key.user : key.user.id)
 
         return `G:${newGuild},C:${newChannel},M:${newMessage},U:${newUser}`
     }
     /**Transform the message state data contents for storage in the database. */
-    protected transformData(key:ODStateKey,data:StateData,isEphemeral:boolean,keepCreatedDate?:number): ODStateData<StateData> {
-        const guildId = (!key.guild) ? null : (typeof key.guild === "string" ? key.guild : key.guild.id)
+    protected transformData(key:ODStateKey<WithGuildKey,WithUserKey>,data:StateData,isEphemeral:boolean,keepCreatedDate?:number): ODStateData<StateData> {
+        const guildId = (!("guild" in key) || !key.guild) ? null : (typeof key.guild === "string" ? key.guild : key.guild.id)
         const channelId = (typeof key.channel === "string" ? key.channel : key.channel.id)
         const messageId = (typeof key.message === "string" ? key.message : key.message.id)
-        const userId = (!key.user) ? null : (typeof key.user === "string" ? key.user : key.user.id)
+        const userId = (!("user" in key) || !key.user) ? null : (typeof key.user === "string" ? key.user : key.user.id)
         const createdDate = keepCreatedDate ?? Date.now()
         const modifiedDate = Date.now()
 
@@ -209,7 +213,7 @@ export class ODState<StateData extends any> extends ODManagerData {
         else return null
     }
     /**Set a message state using guild, channel & message id as key. Returns `true` when overwritten. */
-    async setMsgState(key:ODStateKey,data:StateData,isEphemeral:boolean): Promise<boolean> {
+    async setMsgState(key:ODStateKey<WithGuildKey,WithUserKey>,data:StateData,isEphemeral:boolean): Promise<boolean> {
         const rawKey = this.transformKey(key)
         
         const existingData = await this.getMsgState(key)
@@ -217,14 +221,14 @@ export class ODState<StateData extends any> extends ODManagerData {
         return await this.database.set(this.id.value,rawKey,contents)
     }
     /**Get a message state using guild, channel & message id as key. */
-    async getMsgState(key:ODStateKey): Promise<ODStateData<StateData>|null> {
+    async getMsgState(key:ODStateKey<WithGuildKey,WithUserKey>): Promise<ODStateData<StateData>|null> {
         const rawKey = this.transformKey(key)
         const rawData = await this.database.get(this.id.value,rawKey)
         if (typeof rawData !== "object") return null
         else return rawData as ODStateData<StateData>
     }
     /**Delete a message state using guild, channel & message id as key. Returns `true` when deleted. */
-    async deleteMsgState(key:ODStateKey): Promise<boolean> {
+    async deleteMsgState(key:ODStateKey<WithGuildKey,WithUserKey>): Promise<boolean> {
         const rawKey = this.transformKey(key)
         return await this.database.delete(this.id.value,rawKey)
     }