@open-discord-bots/framework 0.4.4 → 0.4.6

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

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

@@ -15,7 +15,7 @@ export declare class ODComponentFactoryInstance<Component extends ODComponent<ob
     /**The root component of this factory. */
     getComponent(): Component | null;
     /**Set the root component of this factory. */
-    setComponent(c: Component | null): void;
+    setComponent<SetComponent extends Component | null>(c: SetComponent): SetComponent;
 }
 /**## ODComponentFactory `class`
  * An Open Discord component factory.
@@ -192,9 +192,9 @@ export declare abstract class ODGroupComponent<Data extends object, ChildCompone
      * - `after`: insert after an existing component `referenceId` (`end` if `referenceId` is invalid)
      * - `index`: insert at a certain index `referenceIndex` (`end` if `referenceIndex` is invalid)
      */
-    addComponent(c: ChildComponent, mode: "start" | "end"): void;
-    addComponent(c: ChildComponent, mode: "before" | "after", referenceId: ODValidId): void;
-    addComponent(c: ChildComponent, mode: "index", referenceIndex: number): void;
+    addComponent(c: ChildComponent, mode: "start" | "end"): ChildComponent;
+    addComponent(c: ChildComponent, mode: "before" | "after", referenceId: ODValidId): ChildComponent;
+    addComponent(c: ChildComponent, mode: "index", referenceIndex: number): ChildComponent;
     /**Get a component with a certain ID in this group. Returns `null` if non-existent. Also able to search for components recursively. */
     getComponent(id: ODValidId): ChildComponent | null;
     getComponent(id: ODValidId, recursive: true, recursiveLimit?: number): ODComponent<any, any, ODComponentType> | null;
@@ -234,7 +234,7 @@ export declare abstract class ODParentComponent<Data extends object, ChildCompon
     /**The child component of this parent. */
     get child(): ChildComponent | null;
     /**Set the child component of this parent. */
-    setComponent(c: ChildComponent | null): void;
+    setComponent(c: ChildComponent | null): ChildComponent | null;
 }
 /**## ODMessageComponentModifier `class`
  * This is an Open Discord message component modifier.
@@ -314,13 +314,13 @@ export declare class ODMessageComponent extends ODGroupComponent<ODMessageCompon
         supressNotifications: boolean;
     }>;
     /**Enable/disable ephemeral mode. */
-    setEphemeral(value: boolean): void;
+    setEphemeral(value: boolean): this;
     /**Enable supress (hide) embeds mode. */
-    setSupressEmbeds(value: boolean): void;
+    setSupressEmbeds(value: boolean): this;
     /**Enable supress (hide) notifications mode. */
-    setSupressNotifications(value: boolean): void;
+    setSupressNotifications(value: boolean): this;
     /**Add an additional attachment which can be used in components as `attachment://...` */
-    addAdditionalAttachments(...attachments: discord.AttachmentBuilder[]): void;
+    addAdditionalAttachments(...attachments: discord.AttachmentBuilder[]): this;
 }
 /**## ODSimpleMessageComponentData `type`
  * The configurable settings/options for the `ODSimpleMessageComponent`.
@@ -370,13 +370,13 @@ export declare class ODSimpleMessageComponent extends ODGroupComponent<ODSimpleM
         supressNotifications: boolean;
     }>;
     /**Enable/disable ephemeral mode. */
-    setEphemeral(value: boolean): void;
+    setEphemeral(value: boolean): this;
     /**Enable supress (hide) embeds mode. */
-    setSupressEmbeds(value: boolean): void;
+    setSupressEmbeds(value: boolean): this;
     /**Enable supress (hide) notifications mode. */
-    setSupressNotifications(value: boolean): void;
+    setSupressNotifications(value: boolean): this;
     /**Add an additional attachment which can be used in components as `attachment://...` */
-    addAdditionalAttachments(...attachments: discord.AttachmentBuilder[]): void;
+    addAdditionalAttachments(...attachments: discord.AttachmentBuilder[]): this;
 }
 /**## ODModalComponentData `type`
  * The configurable settings/options for the `ODModalComponent`.
@@ -399,7 +399,7 @@ export declare class ODModalComponent extends ODGroupComponent<ODModalComponentD
     constructor(id: ODValidId, data?: Partial<ODModalComponentData>);
     build(): Promise<discord.ModalBuilder>;
     /**Set the title of the modal. */
-    setTitle(title: string): void;
+    setTitle(title: string): this;
     /**Set the custom id of this modal. */
     setCustomId(id: string | null): this;
 }
@@ -445,9 +445,9 @@ export declare class ODContainerComponent extends ODGroupComponent<ODContainerCo
         attachments: discord.AttachmentBuilder[];
     }>;
     /**Set the accent color of this embed-like container. */
-    setColor(color: discord.ColorResolvable | null): void;
+    setColor(color: discord.ColorResolvable | null): this;
     /**Mark the contents of this container as spoiler. */
-    setSpoiler(spoiler: boolean): void;
+    setSpoiler(spoiler: boolean): this;
 }
 /**## ODSectionComponentData `type`
  * The configurable settings/options for the `ODSectionComponent`.
@@ -465,7 +465,7 @@ export declare class ODSectionComponent extends ODGroupComponent<ODSectionCompon
     constructor(id: ODValidId, data?: Partial<ODSectionComponentData>);
     build(): Promise<discord.SectionBuilder>;
     /**Set the accessory component shown on the right side of the section. */
-    setAccessory(accessory: ODButtonComponent | ODThumbnailComponent | null): void;
+    setAccessory(accessory: ODButtonComponent | ODThumbnailComponent | null): this;
 }
 /**## ODLabelComponentData `type`
  * The configurable settings/options for the `ODLabelComponent`.
@@ -487,9 +487,9 @@ export declare class ODLabelComponent extends ODParentComponent<ODLabelComponent
     constructor(id: ODValidId, data: Partial<ODLabelComponentData>);
     build(): Promise<discord.LabelBuilder>;
     /**Set the title of the child component in the modal. */
-    setTitle(title: string): void;
+    setTitle(title: string): this;
     /**Set the description of the child component in the modal. */
-    setDescription(description: string | null): void;
+    setDescription(description: string | null): this;
 }
 /**## ODSeparatorComponentData `type`
  * The configurable settings/options for the `ODSeparatorComponent`.
@@ -507,9 +507,9 @@ export declare class ODSeparatorComponent extends ODComponent<ODSeparatorCompone
     constructor(id: ODValidId, data: Partial<ODSeparatorComponentData>);
     build(): Promise<discord.SeparatorBuilder>;
     /**Set whether a visual divider should be displayed in the component. (Default: `true`). */
-    setDivider(divider: boolean): void;
+    setDivider(divider: boolean): this;
     /**Set the size of separator padding (Default `small`). */
-    setSpacing(spacing: "small" | "large"): void;
+    setSpacing(spacing: "small" | "large"): this;
 }
 /**## ODTextComponentData `type`
  * The configurable settings/options for the `ODTextComponent`.
@@ -525,7 +525,7 @@ export declare class ODTextComponent extends ODComponent<ODTextComponentData, di
     constructor(id: ODValidId, data: Partial<ODTextComponentData>);
     build(): Promise<discord.TextDisplayBuilder>;
     /**Set the text to display. */
-    setContent(value: string): void;
+    setContent(value: string): this;
 }
 /**## ODFileComponentData `type`
  * The configurable settings/options for the `ODFileComponent`.
@@ -555,15 +555,15 @@ export declare class ODFileComponent extends ODComponent<ODFileComponentData, {
         file: discord.FileBuilder;
     }>;
     /**Set the filename + extension. */
-    setName(value: string): void;
+    setName(value: string): this;
     /**Set the file description. */
-    setDescription(value: string | null): void;
+    setDescription(value: string | null): this;
     /**Set the text/binary contents of the file. */
-    setContent(value: discord.BufferResolvable | null): void;
+    setContent(value: discord.BufferResolvable | null): this;
     /**Set a URL to an external file or image. When used, `setContent()` will be ignored! */
-    setExternalUrl(value: string | null): void;
+    setExternalUrl(value: string | null): this;
     /**Mark the file as spoiler. */
-    setSpoiler(value: boolean): void;
+    setSpoiler(value: boolean): this;
 }
 /**## ODGalleryComponentData `type`
  * The configurable settings/options for the `ODGalleryComponent`.
@@ -603,11 +603,11 @@ export declare class ODThumbnailComponent extends ODComponent<ODThumbnailCompone
     constructor(id: ODValidId, data: Partial<ODThumbnailComponentData>);
     build(): Promise<discord.ThumbnailBuilder>;
     /**Set the URL of the thumbnail image. */
-    setUrl(value: string): void;
+    setUrl(value: string): this;
     /**Set the alt text/description of the thumbnail image. */
-    setDescription(value: string | null): void;
+    setDescription(value: string | null): this;
     /**Mark the thumbnail as a spoiler. */
-    setSpoiler(value: boolean): void;
+    setSpoiler(value: boolean): this;
 }
 /**## ODContentComponentData `type`
  * The configurable settings/options for the `ODContentComponent`.
@@ -627,7 +627,7 @@ export declare class ODContentComponent extends ODComponent<ODContentComponentDa
         content: string;
     }>;
     /**Set the text to display. */
-    setContent(value: string): void;
+    setContent(value: string): this;
 }
 /**## ODEmbedComponentData `type`
  * The configurable settings/options for the `ODEmbedComponent`.
@@ -719,15 +719,15 @@ export declare class ODPollComponent extends ODComponent<ODPollComponentData, di
         answers: discord.PollAnswerData[];
     }>;
     /**Set the poll question. */
-    setQuestion(question: string): void;
+    setQuestion(question: string): this;
     /**Set the poll duration in hours. */
-    setDurationHours(duration: number): void;
+    setDurationHours(duration: number): this;
     /**Allow selecting multiple answers. */
-    setMultiSelect(multi: boolean): void;
+    setMultiSelect(multi: boolean): this;
     /**Set the poll answers. */
-    setAnswers(answers: discord.PollAnswerData[]): void;
+    setAnswers(answers: discord.PollAnswerData[]): this;
     /**Add additional poll answers. */
-    addAnswers(...answers: discord.PollAnswerData[]): void;
+    addAnswers(...answers: discord.PollAnswerData[]): this;
 }
 /**## ODButtonComponentData `type`
  * The configurable settings/options for the `ODButtonComponent`.

package/dist/api/modules/component.js

@@ -20,6 +20,7 @@ export class ODComponentFactoryInstance {
     /**Set the root component of this factory. */
     setComponent(c) {
         this.rootComponent = c;
+        return c;
     }
 }
 /**## ODComponentFactory `class`
@@ -209,6 +210,7 @@ export class ODGroupComponent extends ODComponent {
                 this.children.splice(reference, 0, c); //insert at position 'reference'
             }
         }
+        return c;
     }
     getComponent(id, recursive, recursiveLimit = 15) {
         const component = this.children.find((c) => c.id.value === new ODId(id).value);
@@ -308,6 +310,7 @@ export class ODParentComponent extends ODComponent {
     /**Set the child component of this parent. */
     setComponent(c) {
         this.rawChild = c;
+        return this.rawChild;
     }
 }
 /////////////////////////////
@@ -404,20 +407,24 @@ export class ODMessageComponent extends ODGroupComponent {
     /**Enable/disable ephemeral mode. */
     setEphemeral(value) {
         this.data.ephemeral = value;
+        return this;
     }
     /**Enable supress (hide) embeds mode. */
     setSupressEmbeds(value) {
         this.data.supressEmbeds = value;
+        return this;
     }
     /**Enable supress (hide) notifications mode. */
     setSupressNotifications(value) {
         this.data.supressNotifications = value;
+        return this;
     }
     /**Add an additional attachment which can be used in components as `attachment://...` */
     addAdditionalAttachments(...attachments) {
         if (!this.data.additionalAttachments)
             this.data.additionalAttachments = [];
         this.data.additionalAttachments.push(...attachments);
+        return this;
     }
 }
 /**## ODSimpleMessageComponent `class`
@@ -482,20 +489,24 @@ export class ODSimpleMessageComponent extends ODGroupComponent {
     /**Enable/disable ephemeral mode. */
     setEphemeral(value) {
         this.data.ephemeral = value;
+        return this;
     }
     /**Enable supress (hide) embeds mode. */
     setSupressEmbeds(value) {
         this.data.supressEmbeds = value;
+        return this;
     }
     /**Enable supress (hide) notifications mode. */
     setSupressNotifications(value) {
         this.data.supressNotifications = value;
+        return this;
     }
     /**Add an additional attachment which can be used in components as `attachment://...` */
     addAdditionalAttachments(...attachments) {
         if (!this.data.additionalAttachments)
             this.data.additionalAttachments = [];
         this.data.additionalAttachments.push(...attachments);
+        return this;
     }
 }
 /**## ODModalComponent `class`
@@ -536,6 +547,7 @@ export class ODModalComponent extends ODGroupComponent {
     /**Set the title of the modal. */
     setTitle(title) {
         this.data.title = title;
+        return this;
     }
     /**Set the custom id of this modal. */
     setCustomId(id) {
@@ -615,10 +627,12 @@ export class ODContainerComponent extends ODGroupComponent {
     /**Set the accent color of this embed-like container. */
     setColor(color) {
         this.data.color = color ?? undefined;
+        return this;
     }
     /**Mark the contents of this container as spoiler. */
     setSpoiler(spoiler) {
         this.data.spoiler = spoiler;
+        return this;
     }
 }
 /**## ODSectionComponent `class`
@@ -654,6 +668,7 @@ export class ODSectionComponent extends ODGroupComponent {
     /**Set the accessory component shown on the right side of the section. */
     setAccessory(accessory) {
         this.data.accessory = accessory ?? undefined;
+        return this;
     }
 }
 /**## ODLabelComponent `class`
@@ -680,10 +695,12 @@ export class ODLabelComponent extends ODParentComponent {
     /**Set the title of the child component in the modal. */
     setTitle(title) {
         this.data.title = title;
+        return this;
     }
     /**Set the description of the child component in the modal. */
     setDescription(description) {
         this.data.description = description ?? undefined;
+        return this;
     }
 }
 /**## ODSeparatorComponent `class`
@@ -703,10 +720,12 @@ export class ODSeparatorComponent extends ODComponent {
     /**Set whether a visual divider should be displayed in the component. (Default: `true`). */
     setDivider(divider) {
         this.data.divider = divider;
+        return this;
     }
     /**Set the size of separator padding (Default `small`). */
     setSpacing(spacing) {
         this.data.spacing = spacing;
+        return this;
     }
 }
 /**## ODTextComponent `class`
@@ -727,6 +746,7 @@ export class ODTextComponent extends ODComponent {
     /**Set the text to display. */
     setContent(value) {
         this.data.content = value;
+        return this;
     }
 }
 /**## ODFileComponent `class`
@@ -757,22 +777,27 @@ export class ODFileComponent extends ODComponent {
     /**Set the filename + extension. */
     setName(value) {
         this.data.name = value;
+        return this;
     }
     /**Set the file description. */
     setDescription(value) {
         this.data.description = value ?? undefined;
+        return this;
     }
     /**Set the text/binary contents of the file. */
     setContent(value) {
         this.data.content = value ?? undefined;
+        return this;
     }
     /**Set a URL to an external file or image. When used, `setContent()` will be ignored! */
     setExternalUrl(value) {
         this.data.externalUrl = value ?? undefined;
+        return this;
     }
     /**Mark the file as spoiler. */
     setSpoiler(value) {
         this.data.spoiler = value;
+        return this;
     }
 }
 /**## ODGalleryComponent `class`
@@ -829,14 +854,17 @@ export class ODThumbnailComponent extends ODComponent {
     /**Set the URL of the thumbnail image. */
     setUrl(value) {
         this.data.url = value;
+        return this;
     }
     /**Set the alt text/description of the thumbnail image. */
     setDescription(value) {
         this.data.description = value ?? undefined;
+        return this;
     }
     /**Mark the thumbnail as a spoiler. */
     setSpoiler(value) {
         this.data.spoiler = value;
+        return this;
     }
 }
 /**## ODContentComponent `class`
@@ -857,6 +885,7 @@ export class ODContentComponent extends ODComponent {
     /**Set the text to display. */
     setContent(value) {
         this.data.content = value;
+        return this;
     }
 }
 /**## ODEmbedComponent `class`
@@ -1009,22 +1038,27 @@ export class ODPollComponent extends ODComponent {
     /**Set the poll question. */
     setQuestion(question) {
         this.data.question = question;
+        return this;
     }
     /**Set the poll duration in hours. */
     setDurationHours(duration) {
         this.data.durationHours = duration;
+        return this;
     }
     /**Allow selecting multiple answers. */
     setMultiSelect(multi) {
         this.data.allowMultiSelect = multi;
+        return this;
     }
     /**Set the poll answers. */
     setAnswers(answers) {
         this.data.answers = answers;
+        return this;
     }
     /**Add additional poll answers. */
     addAnswers(...answers) {
         this.data.answers.push(...answers);
+        return this;
     }
 }
 /**## ODButtonComponent `class`

package/package.json

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