feat: add defineEmbed and defineAttachment

Author: davidabou

src/define.ts

@@ -2,8 +2,12 @@ import {
   ActionRowBuilder,
   type ModalActionRowComponentBuilder,
   ModalBuilder,
-  TextInputBuilder
+  TextInputBuilder,
+  EmbedBuilder,
+  AttachmentBuilder,
+  type BufferResolvable
 } from 'discord.js'
+import type { Stream } from 'node:stream'
 import type {
   ArgsDef,
   CommandExecute,
@@ -15,6 +19,8 @@ import type {
   DefineEvent,
   DefineEventWithOptions,
   DefinePrecondition,
+  EmbedOptions,
+  EmbedSetters,
   EventCallback,
   EventOptions,
   HarmonixCommand,
@@ -98,6 +104,12 @@ export const defineContextMenu: DefineContextMenu &
   }
 }
 
+export const definePrecondition: DefinePrecondition = (
+  callback: PreconditionCallback
+) => {
+  return { options: {}, callback }
+}
+
 export const defineModal = (options: ModalOptions): ModalBuilder => {
   const builder = new ModalBuilder()
     .setCustomId(options.id)
@@ -137,8 +149,30 @@ export const defineModal = (options: ModalOptions): ModalBuilder => {
   return builder
 }
 
-export const definePrecondition: DefinePrecondition = (
-  callback: PreconditionCallback
-) => {
-  return { options: {}, callback }
+export const defineEmbed = (options: EmbedOptions) => {
+  const builder = new EmbedBuilder()
+  const setters: EmbedSetters = {
+    color: (value) => builder.setColor(value ?? null),
+    title: (value) => builder.setTitle(value ?? null),
+    url: (value) => builder.setURL(value ?? null),
+    author: (value) => builder.setAuthor(value ?? null),
+    description: (value) => builder.setDescription(value ?? null),
+    thumbnail: (value) => builder.setThumbnail(value ?? null),
+    image: (value) => builder.setImage(value ?? null),
+    timestamp: () => builder.setTimestamp(),
+    footer: (value) => builder.setFooter(value ?? null),
+    fields: (value) => builder.addFields(...(value ?? []))
+  }
+
+  Object.entries(options).forEach(([key, value]) => {
+    const _key = key as keyof EmbedOptions
+
+    setters[_key]!(value)
+  })
+
+  return builder
+}
+
+export const defineAttachment = (args: BufferResolvable | Stream) => {
+  return new AttachmentBuilder(args)
 }

src/types/index.ts

@@ -2,5 +2,5 @@ export type * from './commands'
 export type * from './events'
 export type * from './contextMenus'
 export type * from './preconditions'
-export type * from './modals'
+export type * from './rich'
 export type * from './harmonix'

src/types/modals.ts

@@ -0,0 +1,41 @@
+import {
+  type ColorResolvable,
+  type EmbedAuthorOptions,
+  type EmbedFooterOptions,
+  type APIEmbedField,
+  type TextInputStyle
+} from 'discord.js'
+
+interface TextInput {
+  id: string
+  label: string
+  style: TextInputStyle
+  maxLength?: number
+  minLength?: number
+  placeholder?: string
+  value?: string
+  required?: boolean
+}
+
+export interface ModalOptions {
+  id: string
+  title: string
+  textInputs?: TextInput[]
+}
+
+export interface EmbedOptions {
+  color?: ColorResolvable
+  title?: string
+  url?: string
+  author?: EmbedAuthorOptions
+  description?: string
+  thumbnail?: string
+  image?: string
+  timestamp?: number | Date | null
+  footer?: EmbedFooterOptions
+  fields?: APIEmbedField[]
+}
+
+export type EmbedSetters = {
+  [K in keyof EmbedOptions]: (value: EmbedOptions[K]) => void
+}