major bug fixes & breaking change in database code

Major bug fixes and improvements have been made. There's also a breaking change for plugins using the database system. All database related functions are now async based.

src/core/api/modules/base.ts

@@ -9,6 +9,12 @@ import { ODConsoleWarningMessage, ODDebugger } from "./console"
  */
 export type ODPromiseVoid = void|Promise<void>
 
+/**## ODOptionalPromise `type`
+ * This is a simple type to represent a type as normal value or a promise value.
+ */
+export type ODOptionalPromise<T> = T|Promise<T>
+
+
 /**## ODValidButtonColor `type`
  * This is a collection of all the possible button colors.
  */

src/core/api/modules/console.ts

@@ -391,9 +391,9 @@ export class ODDebugFileManager {
     writeText(text:string){
         this.#writeDebugFile(text)
     }
-    /**Write a custom note to the debug file (starting with `[NODE]:`) */
+    /**Write a custom note to the debug file (starting with `[NOTE]:`) */
     writeNote(text:string){
-        this.#writeDebugFile("[NODE]: "+text)
+        this.#writeDebugFile("[NOTE]: "+text)
     }
 }
 

src/core/api/modules/database.ts

@@ -1,7 +1,7 @@
 ///////////////////////////////////////
 //DATABASE MODULE
 ///////////////////////////////////////
-import { ODId, ODManager, ODManagerData, ODSystemError, ODValidId, ODValidJsonType } from "./base"
+import { ODId, ODManager, ODManagerData, ODOptionalPromise, ODSystemError, ODValidId, ODValidJsonType } from "./base"
 import fs from "fs"
 import nodepath from "path"
 import { ODDebugger } from "./console"
@@ -87,27 +87,27 @@ export class ODDatabase extends ODManagerData {
     file: string = ""
 
     /**Add/Overwrite a specific category & key in the database. Returns `true` when overwritten. */
-    set(category:string, key:string, value:ODValidJsonType): boolean {
+    set(category:string, key:string, value:ODValidJsonType): ODOptionalPromise<boolean> {
         return false
     }
     /**Get a specific category & key in the database */
-    get(category:string, key:string): ODValidJsonType|undefined {
+    get(category:string, key:string): ODOptionalPromise<ODValidJsonType|undefined> {
         return undefined
     }
     /**Delete a specific category & key in the database */
-    delete(category:string, key:string): boolean {
+    delete(category:string, key:string): ODOptionalPromise<boolean> {
         return false
     }
     /**Check if a specific category & key exists in the database */
-    exists(category:string, key:string): boolean {
+    exists(category:string, key:string): ODOptionalPromise<boolean> {
         return false
     }
     /**Get a specific category in the database */
-    getCategory(category:string): {key:string, value:ODValidJsonType}[]|undefined {
+    getCategory(category:string): ODOptionalPromise<{key:string, value:ODValidJsonType}[]|undefined> {
         return undefined
     }
     /**Get all values in the database */
-    getAll(): ODJsonDatabaseStructure {
+    getAll(): ODOptionalPromise<ODJsonDatabaseStructure> {
         return []
     }
 }
@@ -145,7 +145,7 @@ export class ODJsonDatabase extends ODDatabase {
      * const didOverwrite = database.setData("category","key","value") //value can be any of the valid types
      * //You need an ODJsonDatabase class named "database" for this example to work!
      */
-    set(category:string, key:string, value:ODValidJsonType): boolean {
+    set(category:string, key:string, value:ODValidJsonType): ODOptionalPromise<boolean> {
         const currentList = this.#system.getData()
         const currentData = currentList.find((d) => (d.category === category) && (d.key === key))
         
@@ -164,7 +164,7 @@ export class ODJsonDatabase extends ODDatabase {
      * const data = database.getData("category","key") //data will be the value
      * //You need an ODJsonDatabase class named "database" for this example to work!
      */
-    get(category:string, key:string): ODValidJsonType|undefined {
+    get(category:string, key:string): ODOptionalPromise<ODValidJsonType|undefined> {
         const currentList = this.#system.getData()
         const tempresult = currentList.find((d) => (d.category === category) && (d.key === key))
         return tempresult ? tempresult.value : undefined
@@ -174,7 +174,7 @@ export class ODJsonDatabase extends ODDatabase {
      * const didExist = database.deleteData("category","key") //delete this value
      * //You need an ODJsonDatabase class named "database" for this example to work!
      */
-    delete(category:string, key:string): boolean {
+    delete(category:string, key:string): ODOptionalPromise<boolean> {
         const currentList = this.#system.getData()
         const currentData = currentList.find((d) => (d.category === category) && (d.key === key))
         if (currentData) currentList.splice(currentList.indexOf(currentData),1)
@@ -183,19 +183,19 @@ export class ODJsonDatabase extends ODDatabase {
         return currentData ? true : false
     }
     /**Check if a value of `category` & `key` exists. Returns `false` when non-existent! */
-    exists(category:string, key:string): boolean {
+    exists(category:string, key:string): ODOptionalPromise<boolean> {
         const currentList = this.#system.getData()
         const tempresult = currentList.find((d) => (d.category === category) && (d.key === key))
         return tempresult ? true : false
     }
     /**Get all values in `category`. Returns `undefined` when non-existent! */
-    getCategory(category:string): {key:string, value:ODValidJsonType}[]|undefined {
+    getCategory(category:string): ODOptionalPromise<{key:string, value:ODValidJsonType}[]|undefined> {
         const currentList = this.#system.getData()
         const tempresult = currentList.filter((d) => (d.category === category))
         return tempresult ? tempresult.map((data) => {return {key:data.key,value:data.value}}) : undefined
     }
     /**Get all values in `category`. */
-    getAll(): ODJsonDatabaseStructure {
+    getAll(): ODOptionalPromise<ODJsonDatabaseStructure> {
         return this.#system.getData()
     }
 
@@ -249,7 +249,7 @@ export class ODFormattedJsonDatabase extends ODDatabase {
      * const didOverwrite = database.setData("category","key","value") //value can be any of the valid types
      * //You need an ODFormattedJsonDatabase class named "database" for this example to work!
      */
-    set(category:string, key:string, value:ODValidJsonType): boolean {
+    set(category:string, key:string, value:ODValidJsonType): ODOptionalPromise<boolean> {
         const currentList = this.#system.getData()
         const currentData = currentList.find((d) => (d.category === category) && (d.key === key))
         
@@ -268,7 +268,7 @@ export class ODFormattedJsonDatabase extends ODDatabase {
      * const data = database.getData("category","key") //data will be the value
      * //You need an ODFormattedJsonDatabase class named "database" for this example to work!
      */
-    get(category:string, key:string): ODValidJsonType|undefined {
+    get(category:string, key:string): ODOptionalPromise<ODValidJsonType|undefined> {
         const currentList = this.#system.getData()
         const tempresult = currentList.find((d) => (d.category === category) && (d.key === key))
         return tempresult ? tempresult.value : undefined
@@ -278,7 +278,7 @@ export class ODFormattedJsonDatabase extends ODDatabase {
      * const didExist = database.deleteData("category","key") //delete this value
      * //You need an ODFormattedJsonDatabase class named "database" for this example to work!
      */
-    delete(category:string, key:string): boolean {
+    delete(category:string, key:string): ODOptionalPromise<boolean> {
         const currentList = this.#system.getData()
         const currentData = currentList.find((d) => (d.category === category) && (d.key === key))
         if (currentData) currentList.splice(currentList.indexOf(currentData),1)
@@ -287,19 +287,19 @@ export class ODFormattedJsonDatabase extends ODDatabase {
         return currentData ? true : false
     }
     /**Check if a value of `category` & `key` exists. Returns `false` when non-existent! */
-    exists(category:string, key:string): boolean {
+    exists(category:string, key:string): ODOptionalPromise<boolean> {
         const currentList = this.#system.getData()
         const tempresult = currentList.find((d) => (d.category === category) && (d.key === key))
         return tempresult ? true : false
     }
     /**Get all values in `category`. Returns `undefined` when non-existent! */
-    getCategory(category:string): {key:string, value:ODValidJsonType}[]|undefined {
+    getCategory(category:string): ODOptionalPromise<{key:string, value:ODValidJsonType}[]|undefined> {
         const currentList = this.#system.getData()
         const tempresult = currentList.filter((d) => (d.category === category))
         return tempresult ? tempresult.map((data) => {return {key:data.key,value:data.value}}) : undefined
     }
     /**Get all values in `category`. */
-    getAll(): ODJsonDatabaseStructure {
+    getAll(): ODOptionalPromise<ODJsonDatabaseStructure> {
         return this.#system.getData()
     }
 

src/core/api/modules/language.ts

@@ -19,7 +19,9 @@ export class ODLanguage extends ODManagerData {
     file: string
     /**The path to the file relative to the main directory. */
     path: string
+    /**The raw object data of the translation. */
     data: any
+    /**The metadata of the language if available. */
     metadata: ODLanguageMetadata|null = null
 
     constructor(id:ODValidId, file:string, customPath?:string){

src/core/api/modules/stat.ts

@@ -42,13 +42,14 @@ export class ODStatsManager extends ODManager<ODStatScope> {
 
         //filter out the deletable stats
         const deletableStats: ODJsonDatabaseStructure = []
-        this.database.getAll().forEach((data) => {
+        const data = await this.database.getAll()
+        data.forEach((data) => {
             if (!validCategories.includes(data.category)) deletableStats.push(data)
         })
 
         //do additional deletion
         for (const cb of this.#initListeners){
-            await cb(this.database.getAll(),deletableStats)
+            await cb(data,deletableStats)
         }
         
         //delete all deletable stats
@@ -57,9 +58,10 @@ export class ODStatsManager extends ODManager<ODStatScope> {
             this.database.delete(data.category,data.key)
         })
     }
-    reset(){
+    async reset(){
         if (!this.database) return
-        this.database.getAll().forEach((data) => {
+        const data = await this.database.getAll()
+        data.forEach((data) => {
             if (!this.database) return
             this.database.delete(data.category,data.key)
         })