@open-discord-bots/framework 0.2.11 → 0.2.13

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

@@ -1,7 +1,7 @@
-import { ODId, ODValidButtonColor, ODValidId, ODInterfaceWithPartialProperty, ODManagerWithSafety, ODManagerData, ODNoGeneric } from "./base";
+import { ODId, ODValidButtonColor, ODValidId, ODInterfaceWithPartialProperty, ODManagerWithSafety, ODManagerData, ODNoGeneric } from "./base.js";
 import * as discord from "discord.js";
-import { ODWorkerManager, ODWorkerCallback } from "./worker";
-import { ODDebugger } from "./console";
+import { ODWorkerManager, ODWorkerCallback } from "./worker.js";
+import { ODDebugger } from "./console.js";
 /**## ODBuilderImplementation `class`
  * This is an Open Discord builder implementation.
  *
@@ -9,24 +9,24 @@ import { ODDebugger } from "./console";
  *
  * This class can't be used stand-alone & needs to be extended from!
  */
-export declare class ODBuilderImplementation<Instance, Source extends string, Params, BuildType extends {
+export declare class ODBuilderImplementation<Instance, Origin extends string, Params, BuildType extends {
     id: ODId;
 }, WorkerIds extends string = string> extends ODManagerData {
     /**The manager that has all workers of this implementation */
-    workers: ODWorkerManager<Instance, Source, Params, WorkerIds>;
+    workers: ODWorkerManager<Instance, Origin, Params, WorkerIds>;
     /**Cache a build or create it every time from scratch when this.build() gets executed. */
     allowCache: boolean;
     /**Did the build already got created/cached? */
     didCache: boolean;
     /**The cache of this build. */
     cache: BuildType | null;
-    constructor(id: ODValidId, callback?: ODWorkerCallback<Instance, Source, Params>, priority?: number, callbackId?: ODValidId);
+    constructor(id: ODValidId, callback?: ODWorkerCallback<Instance, Origin, Params>, priority?: number, callbackId?: ODValidId);
     /**Set if caching is allowed */
     setCacheMode(allowed: boolean): this;
     /**Reset the current cache */
     resetCache(): this;
     /**Execute all workers & return the result. */
-    build(source: Source, params: Params): Promise<BuildType>;
+    build(origin: Origin, params: Params): Promise<BuildType>;
 }
 /**## ODBuilderManager `class`
  * This is an Open Discord builder manager.
@@ -39,7 +39,7 @@ export declare class ODBuilderImplementation<Instance, Source extends string, Pa
  * - independent workers (with priority)
  * - fail-safe design using try-catch
  * - cache frequently used objects
- * - get to know the source of the build request for a specific message, button, etc
+ * - get to know the origin of the build request for a specific message, button, etc
  * - And so much more!
  */
 export declare class ODBuilderManager<ButtonIdList extends ODButtonManagerIdConstraint = ODButtonManagerIdConstraint, DropdownIdList extends ODDropdownManagerIdConstraint = ODDropdownManagerIdConstraint, FileIdList extends ODFileManagerIdConstraint = ODFileManagerIdConstraint, EmbedIdList extends ODEmbedManagerIdConstraint = ODEmbedManagerIdConstraint, MessageIdList extends ODMessageManagerIdConstraint = ODMessageManagerIdConstraint, ModalIdList extends ODModalManagerIdConstraint = ODModalManagerIdConstraint> {
@@ -70,7 +70,7 @@ export interface ODComponentBuildResult {
  * The constraint/layout for id mappings/interfaces of the `ODButtonManager` class.
  */
 export type ODButtonManagerIdConstraint = Record<string, {
-    source: string;
+    origin: string;
     params: object;
     workers: string;
 }>;
@@ -85,13 +85,13 @@ export declare class ODButtonManager<IdList extends ODButtonManagerIdConstraint
     constructor(debug: ODDebugger);
     /**Get a newline component for buttons & dropdowns! */
     getNewLine(id: ODValidId): ODComponentBuildResult;
-    get<ButtonId extends keyof ODNoGeneric<IdList>>(id: ButtonId): ODButton<IdList[ButtonId]["source"], IdList[ButtonId]["params"], IdList[ButtonId]["workers"]>;
+    get<ButtonId extends keyof ODNoGeneric<IdList>>(id: ButtonId): ODButton<IdList[ButtonId]["origin"], IdList[ButtonId]["params"], IdList[ButtonId]["workers"]>;
     get(id: ODValidId): ODButton<string, {}, string> | null;
-    remove<ButtonId extends keyof ODNoGeneric<IdList>>(id: ButtonId): ODButton<IdList[ButtonId]["source"], IdList[ButtonId]["params"], IdList[ButtonId]["workers"]>;
+    remove<ButtonId extends keyof ODNoGeneric<IdList>>(id: ButtonId): ODButton<IdList[ButtonId]["origin"], IdList[ButtonId]["params"], IdList[ButtonId]["workers"]>;
     remove(id: ODValidId): ODButton<string, {}, string> | null;
     exists(id: keyof ODNoGeneric<IdList>): boolean;
     exists(id: ODValidId): boolean;
-    getSafe<ButtonId extends keyof ODNoGeneric<IdList>>(id: ButtonId): ODButton<IdList[ButtonId]["source"], IdList[ButtonId]["params"], IdList[ButtonId]["workers"]>;
+    getSafe<ButtonId extends keyof ODNoGeneric<IdList>>(id: ButtonId): ODButton<IdList[ButtonId]["origin"], IdList[ButtonId]["params"], IdList[ButtonId]["workers"]>;
     getSafe(id: ODValidId): ODButton<string, {}, string>;
 }
 /**## ODButtonData `interface`
@@ -144,9 +144,9 @@ export declare class ODButtonInstance {
  *
  * This is possible by using "workers" or multiple functions that will be executed in priority order!
  */
-export declare class ODButton<Source extends string, Params, WorkerIds extends string = string> extends ODBuilderImplementation<ODButtonInstance, Source, Params, ODComponentBuildResult, WorkerIds> {
+export declare class ODButton<Origin extends string, Params, WorkerIds extends string = string> extends ODBuilderImplementation<ODButtonInstance, Origin, Params, ODComponentBuildResult, WorkerIds> {
     /**Build this button & compile it for discord.js */
-    build(source: Source, params: Params): Promise<ODComponentBuildResult>;
+    build(origin: Origin, params: Params): Promise<ODComponentBuildResult>;
 }
 /**## ODQuickButton `class`
  * This is an Open Discord quick button builder.
@@ -169,7 +169,7 @@ export declare class ODQuickButton {
  * The constraint/layout for id mappings/interfaces of the `ODDropdownManager` class.
  */
 export type ODDropdownManagerIdConstraint = Record<string, {
-    source: string;
+    origin: string;
     params: object;
     workers: string;
 }>;
@@ -184,13 +184,13 @@ export declare class ODDropdownManager<IdList extends ODDropdownManagerIdConstra
     constructor(debug: ODDebugger);
     /**Get a newline component for buttons & dropdowns! */
     getNewLine(id: ODValidId): ODComponentBuildResult;
-    get<DropdownId extends keyof ODNoGeneric<IdList>>(id: DropdownId): ODDropdown<IdList[DropdownId]["source"], IdList[DropdownId]["params"], IdList[DropdownId]["workers"]>;
+    get<DropdownId extends keyof ODNoGeneric<IdList>>(id: DropdownId): ODDropdown<IdList[DropdownId]["origin"], IdList[DropdownId]["params"], IdList[DropdownId]["workers"]>;
     get(id: ODValidId): ODDropdown<string, {}, string> | null;
-    remove<DropdownId extends keyof ODNoGeneric<IdList>>(id: DropdownId): ODDropdown<IdList[DropdownId]["source"], IdList[DropdownId]["params"], IdList[DropdownId]["workers"]>;
+    remove<DropdownId extends keyof ODNoGeneric<IdList>>(id: DropdownId): ODDropdown<IdList[DropdownId]["origin"], IdList[DropdownId]["params"], IdList[DropdownId]["workers"]>;
     remove(id: ODValidId): ODDropdown<string, {}, string> | null;
     exists(id: keyof ODNoGeneric<IdList>): boolean;
     exists(id: ODValidId): boolean;
-    getSafe<DropdownId extends keyof ODNoGeneric<IdList>>(id: DropdownId): ODDropdown<IdList[DropdownId]["source"], IdList[DropdownId]["params"], IdList[DropdownId]["workers"]>;
+    getSafe<DropdownId extends keyof ODNoGeneric<IdList>>(id: DropdownId): ODDropdown<IdList[DropdownId]["origin"], IdList[DropdownId]["params"], IdList[DropdownId]["workers"]>;
     getSafe(id: ODValidId): ODDropdown<string, {}, string>;
 }
 /**## ODDropdownData `interface`
@@ -263,9 +263,9 @@ export declare class ODDropdownInstance {
  *
  * This is possible by using "workers" or multiple functions that will be executed in priority order!
  */
-export declare class ODDropdown<Source extends string, Params, WorkerIds extends string = string> extends ODBuilderImplementation<ODDropdownInstance, Source, Params, ODComponentBuildResult, WorkerIds> {
+export declare class ODDropdown<Origin extends string, Params, WorkerIds extends string = string> extends ODBuilderImplementation<ODDropdownInstance, Origin, Params, ODComponentBuildResult, WorkerIds> {
     /**Build this dropdown & compile it for discord.js */
-    build(source: Source, params: Params): Promise<ODComponentBuildResult>;
+    build(origin: Origin, params: Params): Promise<ODComponentBuildResult>;
 }
 /**## ODQuickDropdown `class`
  * This is an Open Discord quick dropdown builder.
@@ -288,7 +288,7 @@ export declare class ODQuickDropdown {
  * The constraint/layout for id mappings/interfaces of the `ODFileManager` class.
  */
 export type ODFileManagerIdConstraint = Record<string, {
-    source: string;
+    origin: string;
     params: object;
     workers: string;
 }>;
@@ -301,13 +301,13 @@ export type ODFileManagerIdConstraint = Record<string, {
  */
 export declare class ODFileManager<IdList extends ODFileManagerIdConstraint = ODFileManagerIdConstraint> extends ODManagerWithSafety<ODFile<string, {}, string>> {
     constructor(debug: ODDebugger);
-    get<FileId extends keyof ODNoGeneric<IdList>>(id: FileId): ODFile<IdList[FileId]["source"], IdList[FileId]["params"], IdList[FileId]["workers"]>;
+    get<FileId extends keyof ODNoGeneric<IdList>>(id: FileId): ODFile<IdList[FileId]["origin"], IdList[FileId]["params"], IdList[FileId]["workers"]>;
     get(id: ODValidId): ODFile<string, {}, string> | null;
-    remove<FileId extends keyof ODNoGeneric<IdList>>(id: FileId): ODFile<IdList[FileId]["source"], IdList[FileId]["params"], IdList[FileId]["workers"]>;
+    remove<FileId extends keyof ODNoGeneric<IdList>>(id: FileId): ODFile<IdList[FileId]["origin"], IdList[FileId]["params"], IdList[FileId]["workers"]>;
     remove(id: ODValidId): ODFile<string, {}, string> | null;
     exists(id: keyof ODNoGeneric<IdList>): boolean;
     exists(id: ODValidId): boolean;
-    getSafe<FileId extends keyof ODNoGeneric<IdList>>(id: FileId): ODFile<IdList[FileId]["source"], IdList[FileId]["params"], IdList[FileId]["workers"]>;
+    getSafe<FileId extends keyof ODNoGeneric<IdList>>(id: FileId): ODFile<IdList[FileId]["origin"], IdList[FileId]["params"], IdList[FileId]["workers"]>;
     getSafe(id: ODValidId): ODFile<string, {}, string>;
 }
 /**## ODFileData `interface`
@@ -359,9 +359,9 @@ export declare class ODFileInstance {
  *
  * This is possible by using "workers" or multiple functions that will be executed in priority order!
  */
-export declare class ODFile<Source extends string, Params, WorkerIds extends string = string> extends ODBuilderImplementation<ODFileInstance, Source, Params, ODFileBuildResult, WorkerIds> {
+export declare class ODFile<Origin extends string, Params, WorkerIds extends string = string> extends ODBuilderImplementation<ODFileInstance, Origin, Params, ODFileBuildResult, WorkerIds> {
     /**Build this attachment & compile it for discord.js */
-    build(source: Source, params: Params): Promise<ODFileBuildResult>;
+    build(origin: Origin, params: Params): Promise<ODFileBuildResult>;
 }
 /**## ODQuickFile `class`
  * This is an Open Discord quick file builder.
@@ -384,7 +384,7 @@ export declare class ODQuickFile {
  * The constraint/layout for id mappings/interfaces of the `ODEmbedManager` class.
  */
 export type ODEmbedManagerIdConstraint = Record<string, {
-    source: string;
+    origin: string;
     params: object;
     workers: string;
 }>;
@@ -397,13 +397,13 @@ export type ODEmbedManagerIdConstraint = Record<string, {
  */
 export declare class ODEmbedManager<IdList extends ODEmbedManagerIdConstraint = ODEmbedManagerIdConstraint> extends ODManagerWithSafety<ODEmbed<string, {}, string>> {
     constructor(debug: ODDebugger);
-    get<EmbedId extends keyof ODNoGeneric<IdList>>(id: EmbedId): ODEmbed<IdList[EmbedId]["source"], IdList[EmbedId]["params"], IdList[EmbedId]["workers"]>;
+    get<EmbedId extends keyof ODNoGeneric<IdList>>(id: EmbedId): ODEmbed<IdList[EmbedId]["origin"], IdList[EmbedId]["params"], IdList[EmbedId]["workers"]>;
     get(id: ODValidId): ODEmbed<string, {}, string> | null;
-    remove<EmbedId extends keyof ODNoGeneric<IdList>>(id: EmbedId): ODEmbed<IdList[EmbedId]["source"], IdList[EmbedId]["params"], IdList[EmbedId]["workers"]>;
+    remove<EmbedId extends keyof ODNoGeneric<IdList>>(id: EmbedId): ODEmbed<IdList[EmbedId]["origin"], IdList[EmbedId]["params"], IdList[EmbedId]["workers"]>;
     remove(id: ODValidId): ODEmbed<string, {}, string> | null;
     exists(id: keyof ODNoGeneric<IdList>): boolean;
     exists(id: ODValidId): boolean;
-    getSafe<EmbedId extends keyof ODNoGeneric<IdList>>(id: EmbedId): ODEmbed<IdList[EmbedId]["source"], IdList[EmbedId]["params"], IdList[EmbedId]["workers"]>;
+    getSafe<EmbedId extends keyof ODNoGeneric<IdList>>(id: EmbedId): ODEmbed<IdList[EmbedId]["origin"], IdList[EmbedId]["params"], IdList[EmbedId]["workers"]>;
     getSafe(id: ODValidId): ODEmbed<string, {}, string>;
 }
 /**## ODEmbedData `interface`
@@ -487,9 +487,9 @@ export declare class ODEmbedInstance {
  *
  * This is possible by using "workers" or multiple functions that will be executed in priority order!
  */
-export declare class ODEmbed<Source extends string, Params, WorkerIds extends string = string> extends ODBuilderImplementation<ODEmbedInstance, Source, Params, ODEmbedBuildResult, WorkerIds> {
+export declare class ODEmbed<Origin extends string, Params, WorkerIds extends string = string> extends ODBuilderImplementation<ODEmbedInstance, Origin, Params, ODEmbedBuildResult, WorkerIds> {
     /**Build this embed & compile it for discord.js */
-    build(source: Source, params: Params): Promise<ODEmbedBuildResult>;
+    build(origin: Origin, params: Params): Promise<ODEmbedBuildResult>;
 }
 /**## ODQuickEmbed `class`
  * This is an Open Discord quick embed builder.
@@ -512,7 +512,7 @@ export declare class ODQuickEmbed {
  * The constraint/layout for id mappings/interfaces of the `ODMessageManager` class.
  */
 export type ODMessageManagerIdConstraint = Record<string, {
-    source: string;
+    origin: string;
     params: object;
     workers: string;
 }>;
@@ -525,13 +525,13 @@ export type ODMessageManagerIdConstraint = Record<string, {
  */
 export declare class ODMessageManager<IdList extends ODMessageManagerIdConstraint = ODMessageManagerIdConstraint> extends ODManagerWithSafety<ODMessage<string, {}, string>> {
     constructor(debug: ODDebugger);
-    get<MessageId extends keyof ODNoGeneric<IdList>>(id: MessageId): ODMessage<IdList[MessageId]["source"], IdList[MessageId]["params"], IdList[MessageId]["workers"]>;
+    get<MessageId extends keyof ODNoGeneric<IdList>>(id: MessageId): ODMessage<IdList[MessageId]["origin"], IdList[MessageId]["params"], IdList[MessageId]["workers"]>;
     get(id: ODValidId): ODMessage<string, {}, string> | null;
-    remove<MessageId extends keyof ODNoGeneric<IdList>>(id: MessageId): ODMessage<IdList[MessageId]["source"], IdList[MessageId]["params"], IdList[MessageId]["workers"]>;
+    remove<MessageId extends keyof ODNoGeneric<IdList>>(id: MessageId): ODMessage<IdList[MessageId]["origin"], IdList[MessageId]["params"], IdList[MessageId]["workers"]>;
     remove(id: ODValidId): ODMessage<string, {}, string> | null;
     exists(id: keyof ODNoGeneric<IdList>): boolean;
     exists(id: ODValidId): boolean;
-    getSafe<MessageId extends keyof ODNoGeneric<IdList>>(id: MessageId): ODMessage<IdList[MessageId]["source"], IdList[MessageId]["params"], IdList[MessageId]["workers"]>;
+    getSafe<MessageId extends keyof ODNoGeneric<IdList>>(id: MessageId): ODMessage<IdList[MessageId]["origin"], IdList[MessageId]["params"], IdList[MessageId]["workers"]>;
     getSafe(id: ODValidId): ODMessage<string, {}, string>;
 }
 /**## ODMessageData `interface`
@@ -620,9 +620,9 @@ export declare class ODMessageInstance {
  *
  * This is possible by using "workers" or multiple functions that will be executed in priority order!
  */
-export declare class ODMessage<Source extends string, Params, WorkerIds extends string = string> extends ODBuilderImplementation<ODMessageInstance, Source, Params, ODMessageBuildResult, WorkerIds> {
+export declare class ODMessage<Origin extends string, Params, WorkerIds extends string = string> extends ODBuilderImplementation<ODMessageInstance, Origin, Params, ODMessageBuildResult, WorkerIds> {
     /**Build this message & compile it for discord.js */
-    build(source: Source, params: Params): Promise<ODMessageBuildResult>;
+    build(origin: Origin, params: Params): Promise<ODMessageBuildResult>;
 }
 /**## ODQuickMessage `class`
  * This is an Open Discord quick message builder.
@@ -645,7 +645,7 @@ export declare class ODQuickMessage {
  * The constraint/layout for id mappings/interfaces of the `ODModalManager` class.
  */
 export type ODModalManagerIdConstraint = Record<string, {
-    source: string;
+    origin: string;
     params: object;
     workers: string;
 }>;
@@ -658,13 +658,13 @@ export type ODModalManagerIdConstraint = Record<string, {
  */
 export declare class ODModalManager<IdList extends ODModalManagerIdConstraint = ODModalManagerIdConstraint> extends ODManagerWithSafety<ODModal<string, {}, string>> {
     constructor(debug: ODDebugger);
-    get<ModalId extends keyof ODNoGeneric<IdList>>(id: ModalId): ODModal<IdList[ModalId]["source"], IdList[ModalId]["params"], IdList[ModalId]["workers"]>;
+    get<ModalId extends keyof ODNoGeneric<IdList>>(id: ModalId): ODModal<IdList[ModalId]["origin"], IdList[ModalId]["params"], IdList[ModalId]["workers"]>;
     get(id: ODValidId): ODModal<string, {}, string> | null;
-    remove<ModalId extends keyof ODNoGeneric<IdList>>(id: ModalId): ODModal<IdList[ModalId]["source"], IdList[ModalId]["params"], IdList[ModalId]["workers"]>;
+    remove<ModalId extends keyof ODNoGeneric<IdList>>(id: ModalId): ODModal<IdList[ModalId]["origin"], IdList[ModalId]["params"], IdList[ModalId]["workers"]>;
     remove(id: ODValidId): ODModal<string, {}, string> | null;
     exists(id: keyof ODNoGeneric<IdList>): boolean;
     exists(id: ODValidId): boolean;
-    getSafe<ModalId extends keyof ODNoGeneric<IdList>>(id: ModalId): ODModal<IdList[ModalId]["source"], IdList[ModalId]["params"], IdList[ModalId]["workers"]>;
+    getSafe<ModalId extends keyof ODNoGeneric<IdList>>(id: ModalId): ODModal<IdList[ModalId]["origin"], IdList[ModalId]["params"], IdList[ModalId]["workers"]>;
     getSafe(id: ODValidId): ODModal<string, {}, string>;
 }
 /**## ODModalDataQuestion `interface`
@@ -737,7 +737,7 @@ export declare class ODModalInstance {
  *
  * This is possible by using "workers" or multiple functions that will be executed in priority order!
  */
-export declare class ODModal<Source extends string, Params, WorkerIds extends string = string> extends ODBuilderImplementation<ODModalInstance, Source, Params, ODModalBuildResult, WorkerIds> {
+export declare class ODModal<Origin extends string, Params, WorkerIds extends string = string> extends ODBuilderImplementation<ODModalInstance, Origin, Params, ODModalBuildResult, WorkerIds> {
     /**Build this modal & compile it for discord.js */
-    build(source: Source, params: Params): Promise<ODModalBuildResult>;
+    build(origin: Origin, params: Params): Promise<ODModalBuildResult>;
 }