@open-discord-bots/framework 0.4.0 → 0.4.1

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

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

@@ -243,6 +243,14 @@ export declare class ODVersion extends ODManagerData {
     /**Check if this version is matches the minor version (`vX.X.X`) of the provided `requirement`. */
     minor(requirement: string | ODVersion): boolean;
 }
+export interface ODVersionMigrationFunctions {
+    /**The migration to run before any part of the bot is started (pure node.js). */
+    beforeStartupMigrate?: () => void | Promise<void>;
+    /**The migration to run in the Open Discord migration context (incl. flags, configs, database). */
+    contextMigrate?: () => void | Promise<void>;
+    /**The migration to run when the bot starts like normal (incl. plugins) */
+    afterStartupMigrate?: () => void | Promise<void>;
+}
 /**## ODVersionMigration `class`
  * This class is used to manage data migration between Open Ticket versions.
  *
@@ -251,15 +259,15 @@ export declare class ODVersion extends ODManagerData {
 export declare class ODVersionMigration {
     /**The version to migrate data to */
     version: ODVersion;
-    /**The migration function */
-    private migrateFunc;
-    /**The migration function */
-    private migrateAfterInitFunc;
-    constructor(version: ODVersion, migrateFunc: () => void | Promise<void>, migrateAfterInitFunc: () => void | Promise<void>);
-    /**Run this version migration as a plugin. Returns `false` when something goes wrong. */
-    migrate(): Promise<boolean>;
-    /**Run this version migration as a plugin (after other plugins have loaded). Returns `false` when something goes wrong. */
-    migrateAfterInit(): Promise<boolean>;
+    /**The migration functions */
+    private functions;
+    constructor(version: ODVersion, functions: ODVersionMigrationFunctions);
+    /**Run this migration before any other part of the bot is started (pure node.js). */
+    migrateBeforeStartup(): Promise<boolean>;
+    /**Run this migration in the Open Discord migration context (incl. flags, configs, database). */
+    migrateInContext(): Promise<boolean>;
+    /**Run this migration when the bot starts like normal (incl. plugins) */
+    migrateAfterStartup(): Promise<boolean>;
 }
 /**## ODHTTPGetRequest `class`
  * This is a class that can help you with creating simple HTTP GET requests.

package/dist/api/modules/base.js

@@ -505,19 +505,17 @@ export class ODVersion extends ODManagerData {
 export class ODVersionMigration {
     /**The version to migrate data to */
     version;
-    /**The migration function */
-    migrateFunc;
-    /**The migration function */
-    migrateAfterInitFunc;
-    constructor(version, migrateFunc, migrateAfterInitFunc) {
+    /**The migration functions */
+    functions;
+    constructor(version, functions) {
         this.version = version;
-        this.migrateFunc = migrateFunc;
-        this.migrateAfterInitFunc = migrateAfterInitFunc;
+        this.functions = functions;
     }
-    /**Run this version migration as a plugin. Returns `false` when something goes wrong. */
-    async migrate() {
+    /**Run this migration before any other part of the bot is started (pure node.js). */
+    async migrateBeforeStartup() {
         try {
-            await this.migrateFunc();
+            if (this.functions.beforeStartupMigrate)
+                await this.functions.beforeStartupMigrate();
             return true;
         }
         catch (err) {
@@ -525,10 +523,23 @@ export class ODVersionMigration {
             return false;
         }
     }
-    /**Run this version migration as a plugin (after other plugins have loaded). Returns `false` when something goes wrong. */
-    async migrateAfterInit() {
+    /**Run this migration in the Open Discord migration context (incl. flags, configs, database). */
+    async migrateInContext() {
         try {
-            await this.migrateAfterInitFunc();
+            if (this.functions.contextMigrate)
+                await this.functions.contextMigrate();
+            return true;
+        }
+        catch (err) {
+            process.emit("uncaughtException", err);
+            return false;
+        }
+    }
+    /**Run this migration when the bot starts like normal (incl. plugins) */
+    async migrateAfterStartup() {
+        try {
+            if (this.functions.afterStartupMigrate)
+                await this.functions.afterStartupMigrate();
             return true;
         }
         catch (err) {

package/package.json

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