@buape/carbon 0.2.0 → 0.3.0

package/src/internals/OptionsHandler.ts

@@ -1,148 +0,0 @@
-import {
-	type APIApplicationCommandInteractionDataBasicOption,
-	type APIChannel,
-	ApplicationCommandOptionType,
-	Routes
-} from "discord-api-types/v10"
-import { Base } from "../abstracts/Base.js"
-import { type Client, Role, User, channelFactory } from "../index.js"
-
-export type RawOptions = {
-	[key: string]:
-		| APIApplicationCommandInteractionDataBasicOption["value"]
-		| undefined
-}
-
-/**
- * This class is used to parse the options of a command, and provide errors for any missing or invalid options.
- * It is used internally by the Command class.
- */
-export class OptionsHandler extends Base {
-	/**
-	 * The raw options that were in the interaction data, before they were parsed.
-	 */
-	readonly raw: APIApplicationCommandInteractionDataBasicOption[]
-	/**
-	 * The errors that were encountered while parsing the options.
-	 */
-	readonly errors: Array<string> = []
-
-	constructor(
-		client: Client,
-		options: APIApplicationCommandInteractionDataBasicOption[]
-	) {
-		super(client)
-		this.raw = options
-	}
-
-	/**
-	 * Get the value of a string option.
-	 * @param key The name of the option to get the value of.
-	 * @returns The value of the option, or undefined if the option was not provided.
-	 */
-	public getString(key: string) {
-		const value = this.raw.find(
-			(x) => x.name === key && x.type === ApplicationCommandOptionType.String
-		)?.value
-		if (!value || typeof value !== "string") return undefined
-		return value
-	}
-
-	/**
-	 * Get the value of an integer option.
-	 * @param key The name of the option to get the value of.
-	 * @returns The value of the option, or undefined if the option was not provided.
-	 */
-	public getInteger(key: string) {
-		const num = this.raw.find(
-			(x) => x.name === key && x.type === ApplicationCommandOptionType.Integer
-		)?.value
-		if (!num || typeof num !== "number" || !Number.isSafeInteger(num))
-			return undefined
-		return num
-	}
-
-	/**
-	 * Get the value of a number option.
-	 * @param key The name of the option to get the value of.
-	 * @returns The value of the option, or undefined if the option was not provided.
-	 */
-	public getNumber(key: string) {
-		const value = this.raw.find(
-			(x) => x.name === key && x.type === ApplicationCommandOptionType.Number
-		)?.value
-		if (!value || typeof value !== "number") return undefined
-		return value
-	}
-
-	/**
-	 * Get the value of a boolean option.
-	 * @param key The name of the option to get the value of.
-	 * @returns The value of the option, or undefined if the option was not provided.
-	 */
-	public getBoolean(key: string) {
-		const value = this.raw.find(
-			(x) => x.name === key && x.type === ApplicationCommandOptionType.Boolean
-		)?.value
-		if (!value || typeof value !== "boolean") return undefined
-		return value
-	}
-
-	/**
-	 * Get the value of a user option.
-	 * @param key The name of the option to get the value of.
-	 * @returns The value of the option, or undefined if the option was not provided.
-	 */
-	public getUser(key: string) {
-		const id = this.raw.find(
-			(x) => x.name === key && x.type === ApplicationCommandOptionType.User
-		)?.value
-		if (!id || typeof id !== "string") return undefined
-		return new User(this.client, id)
-	}
-
-	/**
-	 * Get the value of a channel option.
-	 * @param key The name of the option to get the value of.
-	 * @returns The value of the option, or undefined if the option was not provided.
-	 */
-	public async getChannel(key: string) {
-		const id = this.raw.find(
-			(x) => x.name === key && x.type === ApplicationCommandOptionType.Channel
-		)?.value
-		if (!id || typeof id !== "string") return undefined
-		const data = (await this.client.rest.get(Routes.channel(id))) as APIChannel
-		return channelFactory(this.client, data)
-	}
-
-	/**
-	 * Get the value of a role option.
-	 * @param key The name of the option to get the value of.
-	 * @returns The value of the option, or undefined if the option was not provided.
-	 */
-	public getRole(key: string): Role | undefined {
-		const id = this.raw.find(
-			(x) => x.name === key && x.type === ApplicationCommandOptionType.Role
-		)?.value
-		if (!id || typeof id !== "string") return undefined
-		return new Role(this.client, id)
-	}
-
-	/**
-	 * Get the value of a mentionable option.
-	 * @param key The name of the option to get the value of.
-	 * @returns The value of the option, or undefined if the option was not provided.
-	 */
-	public async getMentionable(key: string): Promise<User | Role | undefined> {
-		const id = this.raw.find(
-			(x) =>
-				x.name === key && x.type === ApplicationCommandOptionType.Mentionable
-		)?.value
-		if (!id || typeof id !== "string") return undefined
-		const user = new User(this.client, id)
-		await user.fetch().catch(() => {
-			return new Role(this.client, id)
-		})
-		return user
-	}
-}

package/src/internals/RoleSelectMenuInteraction.ts

@@ -1,20 +0,0 @@
-import {
-	type APIMessageComponentSelectMenuInteraction,
-	type APIMessageRoleSelectInteractionData,
-	ComponentType
-} from "discord-api-types/v10"
-import { AnySelectMenuInteraction } from "../abstracts/AnySelectMenuInteraction.js"
-import type { Client } from "../classes/Client.js"
-
-export class RoleSelectMenuInteraction extends AnySelectMenuInteraction {
-	constructor(client: Client, data: APIMessageComponentSelectMenuInteraction) {
-		super(client, data)
-		if (data.data.component_type !== ComponentType.RoleSelect) {
-			throw new Error("Invalid component type was used to create this class")
-		}
-	}
-
-	get values(): string[] {
-		return (this.rawData.data as APIMessageRoleSelectInteractionData).values
-	}
-}

package/src/internals/StringSelectMenuInteraction.ts

@@ -1,20 +0,0 @@
-import {
-	type APIMessageComponentSelectMenuInteraction,
-	type APIMessageStringSelectInteractionData,
-	ComponentType
-} from "discord-api-types/v10"
-import { AnySelectMenuInteraction } from "../abstracts/AnySelectMenuInteraction.js"
-import type { Client } from "../classes/Client.js"
-
-export class StringSelectMenuInteraction extends AnySelectMenuInteraction {
-	constructor(client: Client, data: APIMessageComponentSelectMenuInteraction) {
-		super(client, data)
-		if (data.data.component_type !== ComponentType.StringSelect) {
-			throw new Error("Invalid component type was used to create this class")
-		}
-	}
-
-	get values(): string[] {
-		return (this.rawData.data as APIMessageStringSelectInteractionData).values
-	}
-}

package/src/internals/UserSelectMenuInteraction.ts

@@ -1,20 +0,0 @@
-import {
-	type APIMessageComponentSelectMenuInteraction,
-	type APIMessageUserSelectInteractionData,
-	ComponentType
-} from "discord-api-types/v10"
-import { AnySelectMenuInteraction } from "../abstracts/AnySelectMenuInteraction.js"
-import type { Client } from "../classes/Client.js"
-
-export class UserSelectMenuInteraction extends AnySelectMenuInteraction {
-	constructor(client: Client, data: APIMessageComponentSelectMenuInteraction) {
-		super(client, data)
-		if (data.data.component_type !== ComponentType.UserSelect) {
-			throw new Error("Invalid component type was used to create this class")
-		}
-	}
-
-	get values(): string[] {
-		return (this.rawData.data as APIMessageUserSelectInteractionData).values
-	}
-}

package/src/structures/DmChannel.ts

@@ -1,31 +0,0 @@
-import {
-	type APIDMChannel,
-	type APIMessage,
-	ChannelType,
-	Routes
-} from "discord-api-types/v10"
-import { BaseChannel } from "../abstracts/BaseChannel.js"
-
-/**
- * Represents a DM between two users.
- */
-export class DmChannel extends BaseChannel<ChannelType.DM> {
-	/**
-	 * The name of the channel. This is always null for DM channels.
-	 */
-	name?: null = null
-	type: ChannelType.DM = ChannelType.DM
-
-	protected setSpecificData(data: APIDMChannel) {
-		this.name = data.name
-	}
-
-	/**
-	 * Send a message to the channel
-	 */
-	async send(message: APIMessage) {
-		this.client.rest.post(Routes.channelMessages(this.id), {
-			body: { ...message }
-		})
-	}
-}

package/src/structures/GroupDmChannel.ts

@@ -1,132 +0,0 @@
-import {
-	type APIGroupDMChannel,
-	ChannelType,
-	Routes
-} from "discord-api-types/v10"
-import { BaseChannel } from "../abstracts/BaseChannel.js"
-import { Message } from "./Message.js"
-import { User } from "./User.js"
-
-/**
- * Represents a group DM channel.
- */
-export class GroupDmChannel extends BaseChannel<ChannelType.GroupDM> {
-	/**
-	 * The name of the channel.
-	 */
-	name?: string | null
-	/**
-	 * The recipients of the channel.
-	 */
-	recipients?: User[]
-	type: ChannelType.GroupDM = ChannelType.GroupDM
-	/**
-	 * The ID of the application that created the channel, if it was created by a bot.
-	 */
-	applicationId?: string | null
-	/**
-	 * The icon hash of the channel.
-	 */
-	icon?: string | null
-	/**
-	 * The ID of the user who created the channel.
-	 */
-	ownerId?: string | null
-	/**
-	 * The ID of the last message sent in the channel.
-	 *
-	 * @remarks
-	 * This might not always resolve to a message. The ID still stays a part of the channel's data, even if the message is deleted.
-	 */
-	lastMessageId?: string | null
-	/**
-	 * Whether the channel is managed by an Oauth2 application.
-	 */
-	managed?: boolean | null
-
-	protected setSpecificData(data: APIGroupDMChannel) {
-		this.name = data.name
-		this.recipients = data.recipients?.map((x) => new User(this.client, x))
-		this.applicationId = data.application_id
-		this.icon = data.icon
-		this.ownerId = data.owner_id
-		this.lastMessageId = data.last_message_id
-		this.managed = data.managed
-	}
-
-	/**
-	 * Get the URL of the channel's icon.
-	 */
-	get iconUrl(): string | null {
-		return this.icon
-			? `https://cdn.discordapp.com/channel-icons/${this.id}/${this.icon}.png`
-			: null
-	}
-
-	/**
-	 * Get the owner of the channel.
-	 */
-	get owner(): User {
-		if (!this.ownerId) throw new Error("Cannot get owner without owner ID")
-		return new User(this.client, this.ownerId)
-	}
-
-	/**
-	 * The last message sent in the channel.
-	 *
-	 * @remarks
-	 * This might not always resolve to a message. The ID still stays a part of the channel's data, even if the message is deleted.
-	 * This will always return a partial message, so you can use {@link Message.fetch} to get the full message data.
-	 *
-	 */
-	get lastMessage() {
-		if (!this.lastMessageId) return null
-		return new Message(this.client, {
-			id: this.lastMessageId,
-			channel_id: this.id
-		})
-	}
-
-	/**
-	 * Set the name of the channel
-	 * @param name The new name of the channel
-	 */
-	async setName(name: string) {
-		await this.client.rest.patch(Routes.channel(this.id), {
-			body: {
-				name
-			}
-		})
-		this.name = name
-	}
-
-	async addRecipient(user: User | string) {
-		await this.client.rest.put(
-			Routes.channelRecipient(
-				this.id,
-				typeof user === "string" ? user : user.id
-			)
-		)
-		if (this.recipients)
-			this.recipients.push(
-				typeof user === "string" ? new User(this.client, user) : user
-			)
-		else
-			this.recipients = [
-				typeof user === "string" ? new User(this.client, user) : user
-			]
-	}
-
-	async removeRecipient(user: User | string) {
-		await this.client.rest.delete(
-			Routes.channelRecipient(
-				this.id,
-				typeof user === "string" ? user : user.id
-			)
-		)
-		if (this.recipients)
-			this.recipients = this.recipients.filter(
-				(x) => x.id !== (typeof user === "string" ? user : user.id)
-			)
-	}
-}

package/src/structures/Guild.ts

@@ -1,154 +0,0 @@
-import {
-	type APIChannel,
-	type APIGuild,
-	type APIGuildMember,
-	type APIRole,
-	type RESTPostAPIGuildRoleJSONBody,
-	Routes
-} from "discord-api-types/v10"
-import { Base } from "../abstracts/Base.js"
-import type { Client } from "../classes/Client.js"
-import { channelFactory } from "../factories/channelFactory.js"
-import { GuildMember } from "./GuildMember.js"
-import { Role } from "./Role.js"
-
-export class Guild extends Base {
-	/**
-	 * The ID of the guild
-	 */
-	id: string
-	/**
-	 * The name of the guild.
-	 */
-	name?: string
-	/**
-	 * The description of the guild.
-	 */
-	description?: string | null
-	/**
-	 * The icon hash of the guild.
-	 * You can use {@link Guild.iconUrl} to get the URL of the icon.
-	 */
-	icon?: string | null
-	/**
-	 * The splash hash of the guild.
-	 * You can use {@link Guild.splashUrl} to get the URL of the splash.
-	 */
-	splash?: string | null
-	/**
-	 * The ID of the owner of the guild.
-	 */
-	ownerId?: string
-
-	/**
-	 * Whether the guild is a partial guild (meaning it does not have all the data).
-	 * If this is true, you should use {@link Guild.fetch} to get the full data of the guild.
-	 */
-	partial: boolean
-
-	private rawData: APIGuild | null = null
-
-	constructor(client: Client, rawDataOrId: APIGuild | string) {
-		super(client)
-		if (typeof rawDataOrId === "string") {
-			this.id = rawDataOrId
-			this.partial = true
-		} else {
-			this.rawData = rawDataOrId
-			this.id = rawDataOrId.id
-			this.partial = false
-			this.setData(rawDataOrId)
-		}
-	}
-
-	private setData(data: typeof this.rawData) {
-		if (!data) throw new Error("Cannot set data without having data... smh")
-		this.rawData = data
-		this.name = data.name
-		this.description = data.description
-		this.icon = data.icon
-		this.splash = data.splash
-		this.ownerId = data.owner_id
-		this.partial = false
-	}
-
-	/**
-	 * Fetch updated data for this guild.
-	 * If the guild is partial, this will fetch all the data for the guild and populate the fields.
-	 * If the guild is not partial, all fields will be updated with new values from Discord.
-	 */
-	async fetch() {
-		const newData = (await this.client.rest.get(
-			Routes.guild(this.id)
-		)) as APIGuild
-		if (!newData) throw new Error(`Guild ${this.id}not found`)
-
-		this.setData(newData)
-	}
-
-	/**
-	 * Leave the guild
-	 */
-	async leave() {
-		return await this.client.rest.delete(Routes.guild(this.id))
-	}
-
-	/**
-	 * Create a role in the guild
-	 */
-	async createRole(data: RESTPostAPIGuildRoleJSONBody) {
-		const role = (await this.client.rest.post(Routes.guildRoles(this.id), {
-			body: {
-				...data
-			}
-		})) as APIRole
-		return new Role(this.client, role)
-	}
-
-	/**
-	 * Get a member in the guild by ID
-	 */
-	async fetchMember(memberId: string) {
-		const member = (await this.client.rest.get(
-			Routes.guildMember(this.id, memberId)
-		)) as APIGuildMember
-		return new GuildMember(this.client, member, this)
-	}
-
-	/**
-	 * Get the URL of the guild's icon
-	 */
-	get iconUrl(): string | null {
-		return this.icon
-			? `https://cdn.discordapp.com/icons/${this.id}/${this.icon}.png`
-			: null
-	}
-
-	/**
-	 * Get the URL of the guild's splash
-	 */
-	get splashUrl(): string | null {
-		return this.splash
-			? `https://cdn.discordapp.com/splashes/${this.id}/${this.splash}.png`
-			: null
-	}
-
-	/**
-	 * Get all roles in the guild
-	 */
-	get roles() {
-		const roles = this.rawData?.roles
-		if (!roles) throw new Error("Cannot get roles without having data... smh")
-		return roles.map((role) => new Role(this.client, role))
-	}
-
-	/**
-	 * Fetch a channel from the guild by ID
-	 */
-	async fetchChannel(channelId: string) {
-		const channel = (await this.client.rest.get(
-			Routes.channel(channelId)
-		)) as APIChannel
-		return channelFactory(this.client, channel)
-	}
-}

package/src/structures/GuildAnnouncementChannel.ts

@@ -1,20 +0,0 @@
-import { ChannelType, Routes } from "discord-api-types/v10"
-import { BaseGuildTextChannel } from "../abstracts/BaseGuildTextChannel.js"
-import type { GuildTextChannel } from "./GuildTextChannel.js"
-
-/**
- * Represents a guild announcement channel.
- */
-export class GuildAnnouncementChannel extends BaseGuildTextChannel<ChannelType.GuildAnnouncement> {
-	type: ChannelType.GuildAnnouncement = ChannelType.GuildAnnouncement
-	protected setMoreSpecificData() {}
-
-	async follow(targetChannel: GuildTextChannel | string) {
-		await this.client.rest.put(Routes.channelFollowers(this.id), {
-			body: {
-				webhook_channel_id:
-					typeof targetChannel === "string" ? targetChannel : targetChannel.id
-			}
-		})
-	}
-}

package/src/structures/GuildCategoryChannel.ts

@@ -1,16 +0,0 @@
-import type { ChannelType } from "discord-api-types/v10"
-import { BaseGuildChannel } from "../abstracts/BaseGuildChannel.js"
-
-/**
- * Represents a guild category channel.
- */
-export class GuildCategoryChannel extends BaseGuildChannel<ChannelType.GuildCategory> {
-	protected setSpecificData() {}
-
-	/**
-	 * You cannot send a message to a category channel, so this method throws an error
-	 */
-	override async send(): Promise<void> {
-		throw new Error("Category channels cannot be sent to")
-	}
-}

package/src/structures/GuildForumChannel.ts

@@ -1,20 +0,0 @@
-import type {
-	APIGuildForumChannel,
-	ChannelType,
-	ForumLayoutType
-} from "discord-api-types/v10"
-import { GuildThreadOnlyChannel } from "../abstracts/GuildThreadOnlyChannel.js"
-
-/**
- * Represents a guild forum channel.
- */
-export class GuildForumChannel extends GuildThreadOnlyChannel<ChannelType.GuildForum> {
-	/**
-	 * The default forum layout of the channel.
-	 */
-	defaultForumLayout?: ForumLayoutType
-
-	protected setMoreSpecificData(data: APIGuildForumChannel) {
-		this.defaultForumLayout = data.default_forum_layout
-	}
-}

package/src/structures/GuildMediaChannel.ts

@@ -1,13 +0,0 @@
-import type { ChannelType, ForumLayoutType } from "discord-api-types/v10"
-import { GuildThreadOnlyChannel } from "../abstracts/GuildThreadOnlyChannel.js"
-
-/**
- * Represents a guild media channel (a forum channel )
- */
-export class GuildMediaChannel extends GuildThreadOnlyChannel<ChannelType.GuildMedia> {
-	/**
-	 * The default forum layout of the channel.
-	 */
-	defaultForumLayout?: ForumLayoutType
-	protected setMoreSpecificData() {}
-}