@open-discord-bots/framework 0.2.4 → 0.2.5

package/README.md

@@ -45,7 +45,7 @@ We do currently <b>NOT</b> provide support for <b>3rd party implementations</b>
 
 - **Permissions** - An easy to use system for managing bot permissions for users, roles & channels at the same time.
 
-- **Stats** - Save, modify and keep track of statistics for users, channels, roles or custom entities.
+- **Statistics** - Save, modify and keep track of statistics for users, channels, roles or custom entities.
 
 - **Workers** - Many features use a worker-based system to allow extensible/overwritable code by plugins.
 

package/dist/api/index.d.ts

@@ -17,7 +17,7 @@ export * from "./modules/action";
 export * from "./modules/permission";
 export * from "./modules/helpmenu";
 export * from "./modules/session";
-export * from "./modules/stat";
+export * from "./modules/statistic";
 export * from "./modules/code";
 export * from "./modules/cooldown";
 export * from "./modules/post";

package/dist/api/index.js

@@ -35,7 +35,7 @@ __exportStar(require("./modules/action"), exports);
 __exportStar(require("./modules/permission"), exports);
 __exportStar(require("./modules/helpmenu"), exports);
 __exportStar(require("./modules/session"), exports);
-__exportStar(require("./modules/stat"), exports);
+__exportStar(require("./modules/statistic"), exports);
 __exportStar(require("./modules/code"), exports);
 __exportStar(require("./modules/cooldown"), exports);
 __exportStar(require("./modules/post"), exports);

package/dist/api/main.d.ts

@@ -16,7 +16,7 @@ import { ODVerifyBarManager } from "./modules/verifybar";
 import { ODPermissionManager } from "./modules/permission";
 import { ODCooldownManager } from "./modules/cooldown";
 import { ODHelpMenuManager } from "./modules/helpmenu";
-import { ODStatsManager } from "./modules/stat";
+import { ODStatisticManager } from "./modules/statistic";
 import { ODCodeManager } from "./modules/code";
 import { ODPostManager } from "./modules/post";
 import { ODClientManager } from "./modules/client";
@@ -71,7 +71,7 @@ export interface ODMainManagers {
     /**The manager that manages & renders the Open Discord help menu. (not the embed, but the text) */
     helpmenu: ODHelpMenuManager;
     /**The manager that manages, saves & renders the Open Discord statistics. (not the embed, but the text & database) */
-    stats: ODStatsManager;
+    statistics: ODStatisticManager;
     /**This manager is a place where you can put code that executes when the bot almost finishes the setup. (can be used for less important stuff that doesn't require an exact time-order) */
     code: ODCodeManager;
     /**The manager that manages all posts (static discord channels) in the bot. (e.g. transcripts, logs, etc) */
@@ -117,7 +117,7 @@ export declare class ODMain implements ODMainManagers {
     readonly permissions: ODPermissionManager;
     readonly cooldowns: ODCooldownManager;
     readonly helpmenu: ODHelpMenuManager;
-    readonly stats: ODStatsManager;
+    readonly statistics: ODStatisticManager;
     readonly code: ODCodeManager;
     readonly posts: ODPostManager;
     readonly client: ODClientManager;

package/dist/api/main.js

@@ -34,7 +34,7 @@ class ODMain {
     permissions;
     cooldowns;
     helpmenu;
-    stats;
+    statistics;
     code;
     posts;
     client;
@@ -67,7 +67,7 @@ class ODMain {
         this.permissions = managers.permissions;
         this.cooldowns = managers.cooldowns;
         this.helpmenu = managers.helpmenu;
-        this.stats = managers.stats;
+        this.statistics = managers.statistics;
         this.code = managers.code;
         this.posts = managers.posts;
         this.sharedFuses = managers.sharedFuses;

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

@@ -7,7 +7,7 @@ import { ODDebugger } from "./console";
  * You can also specify a priority to change the execution order.
  * In Open Discord, this is used for the following processes:
  * - Autoclose/delete
- * - Database syncronisation (with tickets, stats & used options)
+ * - Database syncronisation (with tickets, statistics & used options)
  * - Panel auto-update
  * - Database Garbage Collection (removing tickets that don't exist anymore)
  * - And more!

package/dist/api/modules/code.js

@@ -12,7 +12,7 @@ const base_1 = require("./base");
  * You can also specify a priority to change the execution order.
  * In Open Discord, this is used for the following processes:
  * - Autoclose/delete
- * - Database syncronisation (with tickets, stats & used options)
+ * - Database syncronisation (with tickets, statistics & used options)
  * - Panel auto-update
  * - Database Garbage Collection (removing tickets that don't exist anymore)
  * - And more!

package/dist/api/modules/console.js

@@ -334,7 +334,7 @@ class ODDebugFileManager {
             fs_1.default.writeFileSync(this.path, newtext);
         }
     }
-    /**Generate the stats/header of the debug file (containing the version) */
+    /**Generate the statistics/header of the debug file (containing the version) */
     #createStatsText() {
         const date = new Date();
         const dstring = `${date.getDate()}/${date.getMonth() + 1}/${date.getFullYear()} ${date.getHours()}:${date.getMinutes()}:${date.getSeconds()}`;
@@ -346,7 +346,7 @@ class ODDebugFileManager {
             "=========================\n\n"
         ].join("\n");
     }
-    /**Write the stats/header to the debug file on startup */
+    /**Write the statistics/header to the debug file on startup */
     #writeStartupStats() {
         const currenttext = this.#readDebugFile();
         if (currenttext) {

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

@@ -182,12 +182,12 @@ export interface ODSharedFuseList {
     helpMenuCategoryLoading: boolean;
     /**Load the default Open Discord help menu components. */
     helpMenuComponentLoading: boolean;
-    /**Load the default Open Discord stat scopes. */
-    statScopesLoading: boolean;
-    /**Load the default Open Discord stats. */
-    statLoading: boolean;
-    /**Initiate the default Open Discord stats. */
-    statInitiating: boolean;
+    /**Load the default Open Discord statistic scopes. */
+    statisticScopesLoading: boolean;
+    /**Load the default Open Discord statistics. */
+    statisticLoading: boolean;
+    /**Initiate the default Open Discord statistics. */
+    statisticInitiating: boolean;
     /**Load the default Open Discord code/functions. */
     codeLoading: boolean;
     /**Execute the default Open Discord code/functions. */

package/dist/api/modules/fuse.js

@@ -106,9 +106,9 @@ class ODSharedFuseManager extends ODFuseManager {
             cooldownsInitiating: true,
             helpMenuCategoryLoading: true,
             helpMenuComponentLoading: true,
-            statScopesLoading: true,
-            statLoading: true,
-            statInitiating: true,
+            statisticScopesLoading: true,
+            statisticLoading: true,
+            statisticInitiating: true,
             codeLoading: true,
             codeExecution: true,
             liveStatusLoading: true,

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

@@ -0,0 +1,176 @@
+import { ODId, ODManager, ODManagerData, ODValidId } from "./base";
+import { ODDebugger } from "./console";
+import { ODDatabase, ODDatabaseIdConstraint, ODJsonDatabaseStructure } from "./database";
+import * as discord from "discord.js";
+/**## ODValidStatisticValue `type`
+ * These are the only allowed types for a statistic value to improve compatibility with different database systems.
+ */
+export type ODValidStatisticValue = string | number | boolean;
+/**## ODStatisticManagerInitCallback `type`
+ * This callback can be used to execute something when the statistics have been initiated.
+ *
+ * By default this is used to clear statistics from users that left the server or tickets which don't exist anymore.
+ */
+export type ODStatisticManagerInitCallback = (database: ODJsonDatabaseStructure, deletables: ODJsonDatabaseStructure) => void | Promise<void>;
+/**## ODStatisticScopeSetMode `type`
+ * This type contains all valid methods for changing the value of a statistic.
+ */
+export type ODStatisticScopeSetMode = "set" | "increase" | "decrease";
+/**## ODStatisticManagerIdConstraint `type`
+ * The constraint/layout for id mappings/interfaces of the `ODStatisticManager` class.
+ */
+export type ODStatisticManagerIdConstraint = Record<string, ODStatisticScope>;
+/**## ODStatisticManager `class`
+ * This is an Open Discord statistics manager.
+ *
+ * This class is responsible for managing all statistics of the bot.
+ * Statistic are categorized in "scopes" which can be accessed in this manager.
+ *
+ * Statistic can be accessed in the individual scopes.
+ */
+export declare class ODStatisticManager<IdList extends ODStatisticManagerIdConstraint = ODStatisticManagerIdConstraint> extends ODManager<ODStatisticScope> {
+    #private;
+    /**Alias to Open Discord statistics database. */
+    database: ODDatabase<ODDatabaseIdConstraint> | null;
+    constructor(debug: ODDebugger);
+    /**Select the database to use to read/write all statistics from/to. */
+    useDatabase(database: ODDatabase<ODDatabaseIdConstraint>): void;
+    add(data: ODStatisticScope, overwrite?: boolean): boolean;
+    /**Init all statistics and run `onInit()` listeners. */
+    init(): Promise<void>;
+    /**Reset all statistics. (clears the entire database) */
+    reset(): Promise<void>;
+    /**Run a function when the statistics are initialized. This can be used to clear statistics from users that left the server or tickets which don't exist anymore. */
+    onInit(callback: ODStatisticManagerInitCallback): void;
+    get<ScopeId extends keyof IdList>(id: ScopeId): IdList[ScopeId];
+    get(id: ODValidId): ODStatisticScope | null;
+    remove<ScopeId extends keyof IdList>(id: ScopeId): IdList[ScopeId];
+    remove(id: ODValidId): ODStatisticScope | null;
+    exists(id: keyof IdList): boolean;
+    exists(id: ODValidId): boolean;
+}
+/**## ODStatisticScopeIdConstraint `type`
+ * The constraint/layout for id mappings/interfaces of the `ODStatisticScope` class.
+ */
+export type ODStatisticScopeIdConstraint = Record<string, ODStatistic>;
+/**## ODStatisticScope `class`
+ * This is an Open Discord statistic scope.
+ *
+ * A scope can contain multiple statistics. Every scope is seperated from other scopes.
+ * Here, you can read & write the values of all statistics.
+ *
+ * The built-in Open Discord scopes are: `global`, `user`, `ticket`
+ */
+export declare class ODStatisticScope<IdList extends ODStatisticScopeIdConstraint = ODStatisticScopeIdConstraint> extends ODManager<ODStatistic> {
+    /**The id of this statistics scope. */
+    id: ODId;
+    /**Is this scope already initialized? */
+    ready: boolean;
+    /**Alias to Open Discord statistics database. */
+    database: ODDatabase<ODDatabaseIdConstraint> | null;
+    /**The name of this scope (used in embed title) */
+    name: string;
+    constructor(id: ODValidId, name: string);
+    /**Select the database to use to read/write all statistics from/to. (Automatically assigned when used in `ODStatisticManager`) */
+    useDatabase(database: ODDatabase<ODDatabaseIdConstraint>): void;
+    /**Get the value of a statistic. The `scopeId` is the unique id of the user, channel, role, etc that the statistics are related to. */
+    getStat<StatisticId extends keyof IdList>(id: StatisticId, scopeId: string): Promise<ODValidStatisticValue | null>;
+    getStat(id: ODValidId, scopeId: string): Promise<ODValidStatisticValue | null>;
+    /**Get the value of a statistic for all `scopeId`'s. The `scopeId` is the unique id of the user, channel, role, etc that the statistics are related to. */
+    getAllStats<StatisticId extends keyof IdList>(id: StatisticId): Promise<{
+        id: string;
+        value: ODValidStatisticValue;
+    }[]>;
+    getAllStats(id: ODValidId): Promise<{
+        id: string;
+        value: ODValidStatisticValue;
+    }[]>;
+    /**Set, increase or decrease the value of a statistic. The `scopeId` is the unique id of the user, channel, role, etc that the statistics are related to. */
+    setStat<StatisticId extends keyof IdList>(id: StatisticId, scopeId: string, value: ODValidStatisticValue, mode: ODStatisticScopeSetMode): Promise<boolean>;
+    setStat(id: ODValidId, scopeId: string, value: ODValidStatisticValue, mode: ODStatisticScopeSetMode): Promise<boolean>;
+    /**Reset the value of a statistic to the initial value. The `scopeId` is the unique id of the user, channel, role, etc that the statistics are related to. */
+    resetStat<StatisticId extends keyof IdList>(id: ODValidId, scopeId: string): Promise<ODValidStatisticValue | null>;
+    resetStat(id: ODValidId, scopeId: string): Promise<ODValidStatisticValue | null>;
+    /**Initialize this statistic scope & return a list of all statistic ids in the following format: `<scopeid>_<statid>`  */
+    init(): string[];
+    /**Render all statistics in this scope for usage in a discord message/embed. */
+    render(scopeId: string, guild: discord.Guild, channel: discord.TextBasedChannel, user: discord.User): Promise<string>;
+    get<StatisticId extends keyof IdList>(id: StatisticId): IdList[StatisticId];
+    get(id: ODValidId): ODStatistic | null;
+    remove<StatisticId extends keyof IdList>(id: StatisticId): IdList[StatisticId];
+    remove(id: ODValidId): ODStatistic | null;
+    exists(id: keyof IdList): boolean;
+    exists(id: ODValidId): boolean;
+}
+/**## ODStatisticGlobalScope `class`
+ * This is an Open Discord statistic global scope.
+ *
+ * A scope can contain multiple statistics. Every scope is seperated from other scopes.
+ * Here, you can read & write the values of all statistics.
+ *
+ * This scope is made specifically for the global statistics of Open Discord.
+ */
+export declare class ODStatisticGlobalScope<IdList extends ODStatisticScopeIdConstraint = ODStatisticScopeIdConstraint> extends ODStatisticScope<IdList> {
+    getStat<StatisticId extends keyof IdList>(id: StatisticId): Promise<ODValidStatisticValue | null>;
+    getStat(id: ODValidId): Promise<ODValidStatisticValue | null>;
+    getAllStats<StatisticId extends keyof IdList>(id: StatisticId): Promise<{
+        id: string;
+        value: ODValidStatisticValue;
+    }[]>;
+    getAllStats(id: ODValidId): Promise<{
+        id: string;
+        value: ODValidStatisticValue;
+    }[]>;
+    setStat<StatisticId extends keyof IdList>(id: StatisticId, value: ODValidStatisticValue, mode: ODStatisticScopeSetMode): Promise<boolean>;
+    setStat(id: ODValidId, value: ODValidStatisticValue, mode: ODStatisticScopeSetMode): Promise<boolean>;
+    resetStat<StatisticId extends keyof IdList>(id: ODValidId): Promise<ODValidStatisticValue | null>;
+    resetStat(id: ODValidId): Promise<ODValidStatisticValue | null>;
+    render(scopeId: "GLOBAL", guild: discord.Guild, channel: discord.TextBasedChannel, user: discord.User): Promise<string>;
+}
+/**## ODStatisticRenderer `type`
+ * This callback will render a single statistic for a discord embed/message.
+ */
+export type ODStatisticRenderer = (value: ODValidStatisticValue, scopeId: string, guild: discord.Guild, channel: discord.TextBasedChannel, user: discord.User) => string | Promise<string>;
+/**## ODStatistic `class`
+ * This is an Open Discord statistic.
+ *
+ * This single statistic doesn't do anything except defining the rules of this statistic.
+ * Use it in a statistics scope to register a new statistic. A statistic can also include a priority to choose the render priority.
+ *
+ * It's recommended to use the `ODBaseStatistic` & `ODDynamicStatistic` classes instead of this one!
+ */
+export declare class ODStatistic extends ODManagerData {
+    /**The priority of this statistic. */
+    priority: number;
+    /**The render function of this statistic. */
+    render: ODStatisticRenderer;
+    /**The value of this statistic. */
+    value: ODValidStatisticValue | null;
+    constructor(id: ODValidId, priority: number, render: ODStatisticRenderer, value?: ODValidStatisticValue);
+}
+/**## ODBaseStatistic `class`
+ * This is an Open Discord basic statistic.
+ *
+ * This single statistic will store a number, boolean or string in the database.
+ * Use it to create a simple statistic for any statistics scope.
+ */
+export declare class ODBaseStatistic extends ODStatistic {
+    /**The name of this statistic. Rendered in discord embeds/messages. */
+    name: string;
+    constructor(id: ODValidId, priority: number, name: string, value: ODValidStatisticValue);
+}
+/**## ODDynamicStatisticRenderer `type`
+ * This callback will render a single dynamic statistic for a discord embed/message.
+ */
+export type ODDynamicStatisticRenderer = (scopeId: string, guild: discord.Guild, channel: discord.TextBasedChannel, user: discord.User) => string | Promise<string>;
+/**## ODDynamicStatistic `class`
+ * This is an Open Discord dynamic statistic.
+ *
+ * A dynamic statistic does not store anything in the database! Instead, it will execute a function to return a custom result.
+ * This can be used to show statistics which are not stored in the database.
+ *
+ * This is used in Open Discord for the live ticket status, participants & system status.
+ */
+export declare class ODDynamicStatistic extends ODStatistic {
+    constructor(id: ODValidId, priority: number, render: ODDynamicStatisticRenderer);
+}

package/dist/api/modules/{stat.js → statistic.js}

@@ -1,30 +1,30 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ODDynamicStat = exports.ODBasicStat = exports.ODStat = exports.ODStatGlobalScope = exports.ODStatScope = exports.ODStatsManager = void 0;
+exports.ODDynamicStatistic = exports.ODBaseStatistic = exports.ODStatistic = exports.ODStatisticGlobalScope = exports.ODStatisticScope = exports.ODStatisticManager = void 0;
 ///////////////////////////////////////
-//STAT MODULE
+//STATISTIC MODULE
 ///////////////////////////////////////
 const base_1 = require("./base");
-/**## ODStatsManager `class`
- * This is an Open Discord stats manager.
+/**## ODStatisticManager `class`
+ * This is an Open Discord statistics manager.
  *
- * This class is responsible for managing all stats of the bot.
- * Stats are categorized in "scopes" which can be accessed in this manager.
+ * This class is responsible for managing all statistics of the bot.
+ * Statistic are categorized in "scopes" which can be accessed in this manager.
  *
- * Stats can be accessed in the individual scopes.
+ * Statistic can be accessed in the individual scopes.
  */
-class ODStatsManager extends base_1.ODManager {
+class ODStatisticManager extends base_1.ODManager {
     /**Alias to Open Discord debugger. */
     #debug;
-    /**Alias to Open Discord stats database. */
+    /**Alias to Open Discord statistics database. */
     database = null;
     /**All the listeners for the init event. */
     #initListeners = [];
     constructor(debug) {
-        super(debug, "stat scope");
+        super(debug, "statistic scope");
         this.#debug = debug;
     }
-    /**Select the database to use to read/write all stats from/to. */
+    /**Select the database to use to read/write all statistics from/to. */
     useDatabase(database) {
         this.database = database;
     }
@@ -34,16 +34,16 @@ class ODStatsManager extends base_1.ODManager {
             data.useDatabase(this.database);
         return super.add(data, overwrite);
     }
-    /**Init all stats and run `onInit()` listeners. */
+    /**Init all statistics and run `onInit()` listeners. */
     async init() {
         if (!this.database)
-            throw new base_1.ODSystemError("Unable to initialize stats scopes due to missing database!");
+            throw new base_1.ODSystemError("Unable to initialize statistics scopes due to missing database!");
         //get all valid categories
         const validCategories = [];
         for (const scope of this.getAll()) {
             validCategories.push(...scope.init());
         }
-        //filter out the deletable stats
+        //filter out the deletable statistics
         const deletableStats = [];
         const data = await this.database.getAll();
         data.forEach((data) => {
@@ -54,14 +54,14 @@ class ODStatsManager extends base_1.ODManager {
         for (const cb of this.#initListeners) {
             await cb(data, deletableStats);
         }
-        //delete all deletable stats
+        //delete all deletable statistics
         for (const data of deletableStats) {
             if (!this.database)
                 return;
             await this.database.delete(data.category, data.key);
         }
     }
-    /**Reset all stats. (clears the entire database) */
+    /**Reset all statistics. (clears the entire database) */
     async reset() {
         if (!this.database)
             return;
@@ -72,7 +72,7 @@ class ODStatsManager extends base_1.ODManager {
             await this.database.delete(d.category, d.key);
         }
     }
-    /**Run a function when the stats are initialized. This can be used to clear stats from users that left the server or tickets which don't exist anymore. */
+    /**Run a function when the statistics are initialized. This can be used to clear statistics from users that left the server or tickets which don't exist anymore. */
     onInit(callback) {
         this.#initListeners.push(callback);
     }
@@ -86,21 +86,21 @@ class ODStatsManager extends base_1.ODManager {
         return super.exists(id);
     }
 }
-exports.ODStatsManager = ODStatsManager;
-/**## ODStatScope `class`
- * This is an Open Discord stat scope.
+exports.ODStatisticManager = ODStatisticManager;
+/**## ODStatisticScope `class`
+ * This is an Open Discord statistic scope.
  *
- * A scope can contain multiple stats. Every scope is seperated from other scopes.
- * Here, you can read & write the values of all stats.
+ * A scope can contain multiple statistics. Every scope is seperated from other scopes.
+ * Here, you can read & write the values of all statistics.
  *
  * The built-in Open Discord scopes are: `global`, `user`, `ticket`
  */
-class ODStatScope extends base_1.ODManager {
+class ODStatisticScope extends base_1.ODManager {
     /**The id of this statistics scope. */
     id;
-    /**Is this stat scope already initialized? */
+    /**Is this scope already initialized? */
     ready = false;
-    /**Alias to Open Discord stats database. */
+    /**Alias to Open Discord statistics database. */
     database = null;
     /**The name of this scope (used in embed title) */
     name;
@@ -109,7 +109,7 @@ class ODStatScope extends base_1.ODManager {
         this.id = new base_1.ODId(id);
         this.name = name;
     }
-    /**Select the database to use to read/write all stats from/to. (Automatically assigned when used in `ODStatsManager`) */
+    /**Select the database to use to read/write all statistics from/to. (Automatically assigned when used in `ODStatisticManager`) */
     useDatabase(database) {
         this.database = database;
     }
@@ -119,7 +119,7 @@ class ODStatScope extends base_1.ODManager {
         const newId = new base_1.ODId(id);
         const data = await this.database.get(this.id.value + "_" + newId.value, scopeId);
         if (typeof data == "undefined") {
-            //set stats to default value & return
+            //set statistics to default value & return
             return this.resetStat(id, scopeId);
         }
         else if (typeof data == "string" || typeof data == "boolean" || typeof data == "number") {
@@ -179,13 +179,13 @@ class ODStatScope extends base_1.ODManager {
             await this.database.set(this.id.value + "_" + stat.id.value, scopeId, stat.value);
         return stat.value;
     }
-    /**Initialize this stat scope & return a list of all statistic ids in the following format: `<scopeid>_<statid>`  */
+    /**Initialize this statistic scope & return a list of all statistic ids in the following format: `<scopeid>_<statid>`  */
     init() {
-        //get all valid stats categories
+        //get all valid statistics categories
         this.ready = true;
         return this.getAll().map((stat) => this.id.value + "_" + stat.id.value);
     }
-    /**Render all stats in this scope for usage in a discord message/embed. */
+    /**Render all statistics in this scope for usage in a discord message/embed. */
     async render(scopeId, guild, channel, user) {
         //sort from high priority to low
         const derefArray = [...this.getAll()];
@@ -195,7 +195,7 @@ class ODStatScope extends base_1.ODManager {
         const result = [];
         for (const stat of derefArray) {
             try {
-                if (stat instanceof ODDynamicStat) {
+                if (stat instanceof ODDynamicStatistic) {
                     //dynamic render (without value)
                     result.push(await stat.render("", scopeId, guild, channel, user));
                 }
@@ -222,16 +222,16 @@ class ODStatScope extends base_1.ODManager {
         return super.exists(id);
     }
 }
-exports.ODStatScope = ODStatScope;
-/**## ODStatGlobalScope `class`
- * This is an Open Discord stat global scope.
+exports.ODStatisticScope = ODStatisticScope;
+/**## ODStatisticGlobalScope `class`
+ * This is an Open Discord statistic global scope.
  *
- * A scope can contain multiple stats. Every scope is seperated from other scopes.
- * Here, you can read & write the values of all stats.
+ * A scope can contain multiple statistics. Every scope is seperated from other scopes.
+ * Here, you can read & write the values of all statistics.
  *
- * This scope is made specifically for the global stats of Open Discord.
+ * This scope is made specifically for the global statistics of Open Discord.
  */
-class ODStatGlobalScope extends ODStatScope {
+class ODStatisticGlobalScope extends ODStatisticScope {
     getStat(id) {
         return super.getStat(id, "GLOBAL");
     }
@@ -248,16 +248,16 @@ class ODStatGlobalScope extends ODStatScope {
         return super.render("GLOBAL", guild, channel, user);
     }
 }
-exports.ODStatGlobalScope = ODStatGlobalScope;
-/**## ODStat `class`
+exports.ODStatisticGlobalScope = ODStatisticGlobalScope;
+/**## ODStatistic `class`
  * This is an Open Discord statistic.
  *
  * This single statistic doesn't do anything except defining the rules of this statistic.
- * Use it in a stats scope to register a new statistic. A statistic can also include a priority to choose the render priority.
+ * Use it in a statistics scope to register a new statistic. A statistic can also include a priority to choose the render priority.
  *
- * It's recommended to use the `ODBasicStat` & `ODDynamicStat` classes instead of this one!
+ * It's recommended to use the `ODBaseStatistic` & `ODDynamicStatistic` classes instead of this one!
  */
-class ODStat extends base_1.ODManagerData {
+class ODStatistic extends base_1.ODManagerData {
     /**The priority of this statistic. */
     priority;
     /**The render function of this statistic. */
@@ -271,15 +271,15 @@ class ODStat extends base_1.ODManagerData {
         this.value = value ?? null;
     }
 }
-exports.ODStat = ODStat;
-/**## ODBasicStat `class`
+exports.ODStatistic = ODStatistic;
+/**## ODBaseStatistic `class`
  * This is an Open Discord basic statistic.
  *
  * This single statistic will store a number, boolean or string in the database.
- * Use it to create a simple statistic for any stats scope.
+ * Use it to create a simple statistic for any statistics scope.
  */
-class ODBasicStat extends ODStat {
-    /**The name of this stat. Rendered in discord embeds/messages. */
+class ODBaseStatistic extends ODStatistic {
+    /**The name of this statistic. Rendered in discord embeds/messages. */
     name;
     constructor(id, priority, name, value) {
         super(id, priority, (value) => {
@@ -288,8 +288,8 @@ class ODBasicStat extends ODStat {
         this.name = name;
     }
 }
-exports.ODBasicStat = ODBasicStat;
-/**## ODDynamicStat `class`
+exports.ODBaseStatistic = ODBaseStatistic;
+/**## ODDynamicStatistic `class`
  * This is an Open Discord dynamic statistic.
  *
  * A dynamic statistic does not store anything in the database! Instead, it will execute a function to return a custom result.
@@ -297,11 +297,11 @@ exports.ODBasicStat = ODBasicStat;
  *
  * This is used in Open Discord for the live ticket status, participants & system status.
  */
-class ODDynamicStat extends ODStat {
+class ODDynamicStatistic extends ODStatistic {
     constructor(id, priority, render) {
         super(id, priority, (value, scopeId, guild, channel, user) => {
             return render(scopeId, guild, channel, user);
         });
     }
 }
-exports.ODDynamicStat = ODDynamicStat;
+exports.ODDynamicStatistic = ODDynamicStatistic;

package/package.json

@@ -1,7 +1,7 @@
 {
     "name": "@open-discord-bots/framework",
     "author": "DJj123dj",
-    "version": "0.2.4",
+    "version": "0.2.5",
     "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/index.ts

@@ -20,7 +20,7 @@ export * from "./modules/action"
 export * from "./modules/permission"
 export * from "./modules/helpmenu"
 export * from "./modules/session"
-export * from "./modules/stat"
+export * from "./modules/statistic"
 export * from "./modules/code"
 export * from "./modules/cooldown"
 export * from "./modules/post"