@open-discord-bots/framework 0.3.13 → 0.3.15

package/src/api/modules/session.ts

@@ -1,181 +0,0 @@
-///////////////////////////////////////
-//SESSION MODULE
-///////////////////////////////////////
-import { ODId, ODManager, ODManagerData, ODNoGeneric, ODValidId } from "./base.js"
-import { ODDebugger } from "./console.js"
-import * as crypto from "crypto"
-
-/**## ODSessionManagerIdConstraint `type`
- * The constraint/layout for id mappings/interfaces of the `ODSessionManager` class.
- */
-export type ODSessionManagerIdConstraint = Record<string,ODSession>
-
-/**## ODSessionManager `class`
- * This is an Open Discord session manager.
- * 
- * It contains all sessions in Open Discord. Sessions are a sort of temporary storage which will be cleared when the bot stops.
- * Data in sessions have a randomly generated key which will always be unique.
- * 
- * Visit the `ODSession` class for more info
- */
-export class ODSessionManager<IdList extends ODSessionManagerIdConstraint = ODSessionManagerIdConstraint> extends ODManager<ODSession> {
-    constructor(debug:ODDebugger){
-        super(debug,"session")
-    }
-
-    get<SessionId extends keyof ODNoGeneric<IdList>>(id:SessionId): IdList[SessionId]
-    get(id:ODValidId): ODSession|null
-    
-    get(id:ODValidId): ODSession|null {
-        return super.get(id)
-    }
-
-    remove<SessionId extends keyof ODNoGeneric<IdList>>(id:SessionId): IdList[SessionId]
-    remove(id:ODValidId): ODSession|null
-    
-    remove(id:ODValidId): ODSession|null {
-        return super.remove(id)
-    }
-
-    exists(id:keyof ODNoGeneric<IdList>): boolean
-    exists(id:ODValidId): boolean
-    
-    exists(id:ODValidId): boolean {
-        return super.exists(id)
-    }
-}
-
-/**## ODSessionInstance `interface`
- * This interface represents a single session instance. It contains an id, data & some dates.
- */
-export interface ODSessionInstance {
-    /**The id of this session instance. */
-    id:string,
-    /**The creation date of this session instance. */
-    creation:number,
-    /**The custom amount of minutes before this session expires. */
-    timeout:number|null,
-    /**This is the data from this session instance */
-    data:any
-}
-
-/**## ODSessionTimeoutCallback `type`
- * This is the callback used for session timeout listeners.
- */
-export type ODSessionTimeoutCallback = (id:string, timeout:"default"|"custom", data:any, creation:Date) => void
-
-/**## ODSession `class`
- * This is an Open Discord session.
- * 
- * It can be used to create unique user sessions with an ID. Each session can store additional data which isn't saved to the filesystem.
- * You can almost compare it to the PHP session system.
- */
-export class ODSession extends ODManagerData {
-    /**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 = 500
-    /**An array of all the currently active session instances. */
-    sessions: ODSessionInstance[] = []
-    /**The default amount of minutes before a session automatically stops. */
-    timeoutMinutes: number = 30
-    /**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){
-        super(id)
-
-        //create the auto-timeout session checker
-        this.intervalId = setInterval(() => {
-            const deletableSessions: {instance:ODSessionInstance,reason:"default"|"custom"}[] = []
-            
-            //collect all deletable sessions
-            this.sessions.forEach((session) => {
-                if (session.timeout && (new Date().getTime() - session.creation) > session.timeout*60000){
-                    //stop session => custom timeout
-                    deletableSessions.push({instance:session,reason:"custom"})
-                }else if (!session.timeout && (new Date().getTime() - session.creation) > this.timeoutMinutes*60000){
-                    //stop session => default timeout
-                    deletableSessions.push({instance:session,reason:"default"})
-                }
-            })
-
-            //permanently delete sessions
-            deletableSessions.forEach((session) => {
-                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)))
-            })
-
-        },((intervalSeconds) ? (intervalSeconds * 1000) : 60000))
-    }
-
-    /**Create a unique hex id of 8 characters and add it to the instance id history */
-    protected createUniqueId(): string {
-        const hex = crypto.randomBytes(4).toString("hex")
-        if (this.idHistory.includes(hex)){
-            return this.createUniqueId()
-        }else{
-            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)
-    }
-
-    /**Start a session instance with data. Returns the unique id required to access the session. */
-    start(data?:any): string {
-        const id = this.createUniqueId()
-        this.sessions.push({
-            id,data,
-            creation:new Date().getTime(),
-            timeout:null
-        })
-        return id
-    }
-    /**Get the data of a session instance. Returns `null` when not found. */
-    data(id:string): any|null {
-        const session = this.sessions.find((session) => session.id === id)
-        if (!session) return null
-        return session.data
-    }
-    /**Stop & delete a session instance. Returns `true` when sucessful. */
-    stop(id:string): boolean {
-        const index = this.sessions.findIndex((session) => session.id === id)
-        if (index < 0) return false
-        this.sessions.splice(index,1)
-        return true
-    }
-    /**Update the data of a session instance. Returns `true` when sucessful. */
-    update(id:string, data:any): boolean {
-        const session = this.sessions.find((session) => session.id === id)
-        if (!session) return false
-        session.data = data
-        return true
-    }
-    /**Change the global or session timeout minutes. Returns `true` when sucessful. */
-    setTimeout(min:number, id?:string): boolean {
-        if (!id){
-            //change global timeout minutes
-            this.timeoutMinutes = min
-            return true
-        }else{
-            //change session instance timeout minutes
-            const session = this.sessions.find((session) => session.id === id)
-            if (!session) return false
-            session.timeout = min
-            return true
-        }
-    }
-    /**Listen for a session timeout (default or custom) */
-    onTimeout(callback:ODSessionTimeoutCallback){
-        this.timeoutListeners.push(callback)
-    }
-}

package/src/api/modules/startscreen.ts

@@ -1,345 +0,0 @@
-///////////////////////////////////////
-//STARTSCREEN MODULE
-///////////////////////////////////////
-import { ODId, ODManager, ODManagerData, ODNoGeneric, ODValidId } from "./base.js"
-import { ODDebugger, ODError, ODLiveStatusManager, ODLiveStatusManagerIdConstraint } from "./console.js"
-import { ODFlag } from "./flag.js"
-import { ODPlugin, ODUnknownCrashedPlugin } from "./plugin.js"
-import ansis from "ansis"
-
-/**## ODStartScreenComponentRenderCallback `type`
- * This is the render function of a startscreen component. It also sends the location of where the component is rendered.
- */
-export type ODStartScreenComponentRenderCallback = (location:number) => string|Promise<string>
-
-/**## ODStartScreenManagerIdConstraint `type`
- * The constraint/layout for id mappings/interfaces of the `ODStartScreenManager` class.
- */
-export type ODStartScreenManagerIdConstraint = Record<string,ODStartScreenComponent>
-
-/**## ODStartScreenManager `class`
- * This is an Open Discord startscreen manager.
- * 
- * This class is responsible for managing & rendering the startscreen of the bot.
- * 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<IdList extends ODStartScreenManagerIdConstraint = ODStartScreenManagerIdConstraint,LiveStatus extends ODLiveStatusManager = ODLiveStatusManager> extends ODManager<ODStartScreenComponent> {
-    /**Alias to the livestatus manager. */
-    livestatus: LiveStatus
-
-    constructor(debug:ODDebugger,livestatus:LiveStatus){
-        super(debug,"startscreen component")
-        this.livestatus = livestatus
-    }
-
-    /**Get all components in sorted order. */
-    getSortedComponents(priority:"ascending"|"descending"){
-        return this.getAll().sort((a,b) => {
-            if (priority == "ascending") return a.priority-b.priority
-            else return b.priority-a.priority
-        })
-    }
-    /**Render all startscreen components in priority order. */
-    async renderAllComponents(){
-        const components = this.getSortedComponents("descending")
-        
-        let location = 0
-        for (const component of components){
-            try {
-                const renderedText = await component.renderAll(location)
-                console.log(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"))
-            }
-            location++
-        }
-    }
-
-    get<StartScreenId extends keyof ODNoGeneric<IdList>>(id:StartScreenId): IdList[StartScreenId]
-    get(id:ODValidId): ODStartScreenComponent|null
-    
-    get(id:ODValidId): ODStartScreenComponent|null {
-        return super.get(id)
-    }
-
-    remove<StartScreenId extends keyof ODNoGeneric<IdList>>(id:StartScreenId): IdList[StartScreenId]
-    remove(id:ODValidId): ODStartScreenComponent|null
-    
-    remove(id:ODValidId): ODStartScreenComponent|null {
-        return super.remove(id)
-    }
-
-    exists(id:keyof ODNoGeneric<IdList>): boolean
-    exists(id:ODValidId): boolean
-    
-    exists(id:ODValidId): boolean {
-        return super.exists(id)
-    }
-}
-
-/**## ODStartScreenComponent `class`
- * This is an Open Discord startscreen component.
- * 
- * This component can be rendered to the start screen of the bot.
- * An optional priority can be specified to choose the location of the component.
- * 
- * It's recommended to use pre-built components except if you really need a custom one.
- */
-export abstract class ODStartScreenComponent extends ODManagerData {
-    /**The priority of this component. */
-    priority: number
-    /**An optional render function which will be inserted before the default renderer. */
-    renderBefore: ODStartScreenComponentRenderCallback|null
-    /**The render function which will render the contents of this component. */
-    render: ODStartScreenComponentRenderCallback
-    /**An optional render function which will be inserted behind the default renderer. */
-    renderAfter: ODStartScreenComponentRenderCallback|null
-
-    constructor(id:ODValidId, priority:number, render:ODStartScreenComponentRenderCallback,renderBefore?:ODStartScreenComponentRenderCallback,renderAfter?:ODStartScreenComponentRenderCallback){
-        super(id)
-        this.priority = priority
-        this.render = render
-        this.renderBefore = renderBefore ?? null
-        this.renderAfter = renderAfter ?? null
-    }
-
-    /**Render this component and combine it with the `renderBefore` & `renderAfter` contents. */
-    async renderAll(location:number){
-        const textBefore = (this.renderBefore) ? await this.renderBefore(location) : ""
-        const text = await this.render(location)
-        const textAfter = (this.renderAfter) ? await this.renderAfter(location) : ""
-        return (textBefore ? textBefore+"\n" : "")+text+(textAfter ? "\n"+textAfter : "")
-    }
-}
-
-/**## ODStartScreenProperty `type`
- * This interface contains properties used in a few default templates of the startscreen component.
- */
-export interface ODStartScreenProperty {
-    /**The key or name of this property. */
-    key:string,
-    /**The value or contents of this property. */
-    value:string
-}
-
-/**## ODStartScreenLogoComponent `class`
- * This is an Open Discord startscreen logo component.
- * 
- * This component will render an ASCII art logo (from an array) to the startscreen. Every property in the array is another row.
- * An optional priority can be specified to choose the location of the component.
- */
-export class ODStartScreenLogoComponent extends ODStartScreenComponent {
-    /**The ASCII logo contents. */
-    logo: string[]
-    /**When enabled, the component will add a new line above the logo. */
-    topPadding: boolean
-    /**When enabled, the component will add a new line below the logo. */
-    bottomPadding: boolean
-    /**The color of the logo in hex format. */
-    logoHexColor: string
-
-    constructor(id:ODValidId, priority:number, logo:string[], topPadding?:boolean, bottomPadding?:boolean, logoHexColor?:string){
-        super(id,priority,() => {
-            const renderedTop = (this.topPadding ? "\n" : "")
-            const renderedLogo = this.logo.join("\n")
-            const renderedBottom = (this.bottomPadding ? "\n" : "")
-            return ansis.hex(this.logoHexColor)(renderedTop+renderedLogo+renderedBottom)
-        })
-        this.logo = logo
-        this.topPadding = topPadding ?? false
-        this.bottomPadding = bottomPadding ?? false
-        this.logoHexColor = logoHexColor ?? "#f8ba00"
-    }
-}
-
-/**## ODStartScreenHeaderAlignmentSettings `type`
- * This interface contains all settings used in the startscreen header component.
- */
-export interface ODStartScreenHeaderAlignmentSettings {
-    /**The alignment settings for this header. */
-    align:"center"|"left"|"right",
-    /**The width or component to use when calculating center & right alignment. */
-    width:number|ODStartScreenComponent
-}
-
-/**## ODStartScreenHeaderComponent `class`
- * This is an Open Discord startscreen header component.
- * 
- * This component will render a header to the startscreen. Properties can be aligned left, right or centered.
- * An optional priority can be specified to choose the location of the component.
- */
-export class ODStartScreenHeaderComponent extends ODStartScreenComponent {
-    /**All properties of this header component. */
-    properties: ODStartScreenProperty[]
-    /**The spacer used between properties. */
-    spacer: string
-    /**The alignment settings of this header component. */
-    align: ODStartScreenHeaderAlignmentSettings|null
-
-    constructor(id:ODValidId, priority:number, properties:ODStartScreenProperty[], spacer?:string, align?:ODStartScreenHeaderAlignmentSettings){
-        super(id,priority,async () => {
-            const renderedProperties = ansis.bold(this.properties.map((prop) => prop.key+": "+prop.value).join(this.spacer))
-            if (!this.align || this.align.align == "left"){
-                return renderedProperties
-            }else if (this.align.align == "right"){
-                const width = (typeof this.align.width == "number") ? this.align.width : (
-                    ansis.strip(await this.align.width.renderAll(0)).split("\n").map((row) => row.length).reduce((prev,curr) => {
-                        if (prev < curr) return curr
-                        else return prev
-                    },0)
-                )
-                const offset = width - ansis.strip(renderedProperties).length
-                if (offset < 0) return renderedProperties
-                else{
-                    return (" ".repeat(offset) + renderedProperties)
-                }
-            }else if (this.align.align == "center"){
-                const width = (typeof this.align.width == "number") ? this.align.width : (
-                    ansis.strip(await this.align.width.renderAll(0)).split("\n").map((row) => row.length).reduce((prev,curr) => {
-                        if (prev < curr) return curr
-                        else return prev
-                    })
-                )
-                const offset = Math.round((width - ansis.strip(renderedProperties).length)/2)
-                if (offset < 0) return renderedProperties
-                else{
-                    return (" ".repeat(offset) + renderedProperties)
-                }
-            }
-            return renderedProperties
-        })
-        this.properties = properties
-        this.spacer = spacer ?? "  -  "
-        this.align = align ?? null
-    }
-}
-
-/**## ODStartScreenCategoryComponent `class`
- * This is an Open Discord startscreen category component.
- * 
- * This component will render a category to the startscreen. This will only render the category name. You'll need to provide your own renderer for the contents.
- * An optional priority can be specified to choose the location of the component.
- */
-export class ODStartScreenCategoryComponent extends ODStartScreenComponent {
-    /**The name of this category. */
-    name: string
-    /**When enabled, this category will still be rendered when the contents are empty. (enabled by default) */
-    renderIfEmpty: boolean
-
-    constructor(id:ODValidId, priority:number, name:string, render:ODStartScreenComponentRenderCallback, renderIfEmpty?:boolean){
-        super(id,priority,async (location) => {
-            const contents = await render(location)
-            if (contents != "" || this.renderIfEmpty){
-                return ansis.bold.underline("\n"+this.name.toUpperCase()+(contents != "" ? ":\n" : ":")) + contents
-            }else return ""
-        })
-        this.name = name
-        this.renderIfEmpty = renderIfEmpty ?? true
-    }
-}
-
-/**## ODStartScreenPropertiesCategoryComponent `class`
- * This is an Open Discord startscreen properties category component.
- * 
- * This component will render a properties category to the startscreen. This will list the properties in the category.
- * An optional priority can be specified to choose the location of the component.
- */
-export class ODStartScreenPropertiesCategoryComponent extends ODStartScreenCategoryComponent {
-    /**The properties of this category component. */
-    properties: ODStartScreenProperty[]
-    /**The hex color for the key/name of all the properties. */
-    propertyHexColor: string
-
-    constructor(id:ODValidId, priority:number, name:string, properties:ODStartScreenProperty[], propertyHexColor?:string, renderIfEmpty?:boolean){
-        super(id,priority,name,() => {
-            return this.properties.map((prop) => ansis.hex(this.propertyHexColor)(prop.key+": ")+prop.value).join("\n")
-        },renderIfEmpty)
-
-        this.properties = properties
-        this.propertyHexColor = propertyHexColor ?? "#f8ba00"
-    }
-}
-
-/**## ODStartScreenFlagsCategoryComponent `class`
- * This is an Open Discord startscreen flags category component.
- * 
- * This component will render a flags category to the startscreen. This will list the enabled flags in the category.
- * An optional priority can be specified to choose the location of the component.
- */
-export class ODStartScreenFlagsCategoryComponent extends ODStartScreenCategoryComponent {
-    /**A list of all flags to render. */
-    flags: ODFlag[]
-
-    constructor(id:ODValidId, priority:number, flags:ODFlag[]){
-        super(id,priority,"flags",() => {
-            return this.flags.filter((flag) => (flag.value == true)).map((flag) => ansis.blue("["+flag.name+"] "+flag.description)).join("\n")
-        },false)
-        this.flags = flags
-    }
-}
-
-/**## ODStartScreenPluginsCategoryComponent `class`
- * This is an Open Discord startscreen plugins category component.
- * 
- * This component will render a plugins category to the startscreen. This will list the enabled, disabled & crashed plugins in the category.
- * An optional priority can be specified to choose the location of the component.
- */
-export class ODStartScreenPluginsCategoryComponent extends ODStartScreenCategoryComponent {
-    /**A list of all plugins to render. */
-    plugins: ODPlugin[]
-    /**A list of all crashed plugins to render. */
-    unknownCrashedPlugins: ODUnknownCrashedPlugin[]
-
-    constructor(id:ODValidId, priority:number, plugins:ODPlugin[], unknownCrashedPlugins:ODUnknownCrashedPlugin[]){
-        super(id,priority,"plugins",() => {
-            const disabledPlugins = this.plugins.filter((plugin) => !plugin.enabled)
-
-            const renderedActivePlugins = this.plugins.filter((plugin) => plugin.enabled && plugin.executed).sort((a,b) => b.priority-a.priority).map((plugin) => ansis.green("✅ ["+plugin.name+"] "+plugin.details.shortDescription))
-            const renderedCrashedPlugins = this.plugins.filter((plugin) => plugin.enabled && plugin.crashed).sort((a,b) => b.priority-a.priority).map((plugin) => ansis.red("❌ ["+plugin.name+"] "+plugin.details.shortDescription))
-            const renderedDisabledPlugins = (disabledPlugins.length > 4) ? [ansis.gray("💤 (+"+disabledPlugins.length+" disabled plugins)")] : disabledPlugins.sort((a,b) => b.priority-a.priority).map((plugin) => ansis.gray("💤 ["+plugin.name+"] "+plugin.details.shortDescription))
-            const renderedUnknownPlugins = unknownCrashedPlugins.map((plugin) => ansis.red("❌ ["+plugin.name+"] "+plugin.description))
-
-            return [
-                ...renderedActivePlugins,
-                ...renderedDisabledPlugins,
-                ...renderedCrashedPlugins,
-                ...renderedUnknownPlugins
-            ].join("\n")
-        },false)
-        this.plugins = plugins
-        this.unknownCrashedPlugins = unknownCrashedPlugins
-    }
-}
-
-/**## ODStartScreenLiveStatusCategoryComponent `class`
- * This is an Open Discord startscreen livestatus category component.
- * 
- * This component will render a livestatus category to the startscreen. This will list the livestatus messages in the category.
- * An optional priority can be specified to choose the location of the component.
- */
-export class ODStartScreenLiveStatusCategoryComponent<LiveStatus extends ODLiveStatusManager<ODLiveStatusManagerIdConstraint>> extends ODStartScreenCategoryComponent {
-    /**A reference to the Open Discord livestatus manager. */
-    livestatus: LiveStatus
-
-    constructor(id:ODValidId, priority:number, livestatus:LiveStatus){
-        super(id,priority,"news & updates",async () => {
-            const messages = await this.livestatus.getAllMessages()
-            return this.livestatus.renderer.render(messages)
-        },false)
-        this.livestatus = livestatus
-    }
-}
-
-/**## ODStartScreenLogsCategoryComponent `class`
- * This is an Open Discord startscreen logs category component.
- * 
- * This component will render a logs category to the startscreen. This will only render the logs category name.
- * An optional priority can be specified to choose the location of the component.
- */
-export class ODStartScreenLogCategoryComponent extends ODStartScreenCategoryComponent {
-    constructor(id:ODValidId, priority:number){
-        super(id,priority,"logs",() => "",true)
-    }
-}