@buape/carbon 0.1.0

package/src/structures/Role.ts

@@ -0,0 +1,201 @@
+import {
+	type APIRole,
+	type APIRoleTags,
+	type RoleFlags,
+	Routes
+} from "discord-api-types/v10"
+import { Base } from "../abstracts/Base.js"
+import type { Client } from "../classes/Client.js"
+
+export class Role extends Base {
+	/**
+	 * The ID of the role.
+	 */
+	id: string
+	/**
+	 * The name of the role.
+	 */
+	name?: string | null
+	/**
+	 * The color of the role.
+	 */
+	color?: number | null
+	/**
+	 * The icon hash of the role.
+	 * You can use {@link Role.iconUrl} to get the URL of the icon.
+	 */
+	icon?: string | null
+	/**
+	 * If this role is mentionable.
+	 */
+	mentionable?: boolean | null
+	/**
+	 * If this role is hoisted.
+	 */
+	hoisted?: boolean | null
+	/**
+	 * The position of the role.
+	 */
+	position?: number | null
+	/**
+	 * The permissions of the role.
+	 */
+	permissions?: string | null
+	/**
+	 * If this role is managed by an integration.
+	 */
+	managed?: boolean | null
+	/**
+	 * The unicode emoji for the role.
+	 */
+	unicodeEmoji?: string | null
+	/**
+	 * The flags of this role.
+	 * @see https://discord.com/developers/docs/topics/permissions#role-object-role-flags
+	 */
+	flags?: RoleFlags | null
+	/**
+	 * The tags of this role.
+	 * @see https://discord.com/developers/docs/topics/permissions#role-object-role-tags-structure
+	 */
+	tags?: APIRoleTags | null
+
+	/**
+	 * Whether the role is a partial role (meaning it does not have all the data).
+	 * If this is true, you should use {@link Role.fetch} to get the full data of the role.
+	 */
+	partial: boolean
+
+	private rawData: APIRole | null = null
+
+	constructor(client: Client, rawDataOrId: APIRole | 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.color = data.color
+		this.icon = data.icon
+		this.mentionable = data.mentionable
+		this.hoisted = data.hoist
+		this.position = data.position
+		this.permissions = data.permissions
+		this.managed = data.managed
+		this.unicodeEmoji = data.unicode_emoji
+		this.flags = data.flags
+		this.tags = data.tags
+		this.partial = false
+	}
+
+	/**
+	 * Fetch updated data for this role.
+	 * If the role is partial, this will fetch all the data for the role and populate the fields.
+	 * If the role is not partial, all fields will be updated with new values from Discord.
+	 */
+	async fetch(guildId: string) {
+		const newData = (await this.client.rest.get(
+			Routes.guildRole(guildId, this.id)
+		)) as APIRole
+		if (!newData) throw new Error(`Role ${this.id} not found`)
+
+		this.setData(newData)
+	}
+
+	/**
+	 * Set the name of the role
+	 */
+	async setName(guildId: string, name: string) {
+		await this.client.rest.patch(Routes.guildRole(guildId, this.id), {
+			body: {
+				name
+			}
+		})
+		this.name = name
+	}
+
+	/**
+	 * Set the color of the role
+	 */
+	async setColor(guildId: string, color: number) {
+		await this.client.rest.patch(Routes.guildRole(guildId, this.id), {
+			body: { color }
+		})
+		this.color = color
+	}
+
+	/**
+	 * Set the icon of the role
+	 * @param icon The unicode emoji or icon URL to set
+	 */
+	async setIcon(guildId: string, icon: string) {
+		await this.client.rest.patch(Routes.guildRole(guildId, this.id), {
+			body: { icon }
+		})
+		this.icon = icon
+	}
+
+	/**
+	 * Set the mentionable status of the role
+	 */
+	async setMentionable(guildId: string, mentionable: boolean) {
+		await this.client.rest.patch(Routes.guildRole(guildId, this.id), {
+			body: { mentionable }
+		})
+		this.mentionable = mentionable
+	}
+
+	/**
+	 * Set the hoisted status of the role
+	 */
+	async setHoisted(guildId: string, hoisted: boolean) {
+		await this.client.rest.patch(Routes.guildRole(guildId, this.id), {
+			body: { hoist: hoisted }
+		})
+		this.hoisted = hoisted
+	}
+
+	/**
+	 * Set the position of the role
+	 */
+	async setPosition(guildId: string, position: number) {
+		await this.client.rest.patch(Routes.guildRole(guildId, this.id), {
+			body: { position }
+		})
+		this.position = position
+	}
+
+	/**
+	 * Set the permissions of the role
+	 * @param permissions The permissions to set as a BitField string, until a better permission structure is implemented
+	 */
+	async setPermissions(guildId: string, permissions: string) {
+		await this.client.rest.patch(Routes.guildRole(guildId, this.id), {
+			body: { permissions }
+		})
+		this.permissions = permissions
+	}
+
+	async delete(guildId: string) {
+		await this.client.rest.delete(Routes.guildRole(guildId, this.id))
+	}
+
+	/**
+	 * Get the URL of the role's icon
+	 */
+	get iconUrl(): string | null {
+		return this.icon
+			? `https://cdn.discordapp.com/role-icons/${this.id}/${this.icon}.png`
+			: null
+	}
+}

package/src/structures/User.ts

@@ -0,0 +1,153 @@
+import {
+	type APIDMChannel,
+	type APIMessage,
+	type APIUser,
+	type RESTPostAPIChannelMessageJSONBody,
+	Routes,
+	type UserFlags
+} from "discord-api-types/v10"
+import { Base } from "../abstracts/Base.js"
+import type { Client } from "../classes/Client.js"
+import { Message } from "./Message.js"
+
+export class User extends Base {
+	/**
+	 * The ID of the user
+	 */
+	id: string
+	/**
+	 * The username of the user.
+	 */
+	username?: string
+	/**
+	 * The global name of the user.
+	 */
+	globalName?: string | null
+	/**
+	 * The discriminator of the user.
+	 */
+	discriminator?: string
+	/**
+	 * The avatar hash of the user.
+	 * You can use {@link User.avatarUrl} to get the URL of the avatar.
+	 */
+	avatar?: string | null
+	/**
+	 * Is this user a bot?
+	 */
+	bot?: boolean
+	/**
+	 * Is this user a system user?
+	 */
+	system?: boolean
+	/**
+	 * The public flags of the user. (Bitfield)
+	 * @see https://discord.com/developers/docs/resources/user#user-object-user-flags
+	 */
+	flags?: UserFlags
+	/**
+	 * The banner hash of the user.
+	 * You can use {@link User.bannerUrl} to get the URL of the banner.
+	 */
+	banner?: string | null
+	/**
+	 * The accent color of the user.
+	 */
+	accentColor?: number | null
+
+	/**
+	 * Whether the user is a partial user (meaning it does not have all the data).
+	 * If this is true, you should use {@link User.fetch} to get the full data of the user.
+	 */
+	partial: boolean
+
+	private rawData: APIUser | null = null
+
+	constructor(client: Client, rawDataOrId: APIUser | 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.username = data.username
+		this.globalName = data.global_name
+		this.discriminator = data.discriminator
+		this.avatar = data.avatar
+		this.bot = data.bot
+		this.system = data.system
+		this.flags = data.public_flags
+		this.banner = data.banner
+		this.accentColor = data.accent_color
+		this.partial = false
+	}
+
+	/**
+	 * Fetch updated data for this user.
+	 * If the user is partial, this will fetch all the data for the user and populate the fields.
+	 * If the user is not partial, all fields will be updated with new values from Discord.
+	 */
+	async fetch() {
+		const newData = (await this.client.rest.get(
+			Routes.user(this.id)
+		)) as APIUser
+		if (!newData) throw new Error(`User ${this.id} not found`)
+
+		this.setData(newData)
+	}
+
+	/**
+	 * Instantiate a new DM channel with this user.
+	 */
+	async createDm(userId: string) {
+		const dmChannel = (await this.client.rest.post(Routes.userChannels(), {
+			body: {
+				recipient_id: userId
+			}
+		})) as APIDMChannel
+		return dmChannel
+	}
+
+	/**
+	 * Send a message to this user.
+	 */
+	async send(data: RESTPostAPIChannelMessageJSONBody) {
+		const dmChannel = await this.createDm(this.id)
+		const message = (await this.client.rest.post(
+			Routes.channelMessages(dmChannel.id),
+			{
+				body: {
+					...data
+				}
+			}
+		)) as APIMessage
+		return new Message(this.client, message)
+	}
+
+	/**
+	 * Get the URL of the user's avatar
+	 */
+	get avatarUrl(): string | null {
+		return this.avatar
+			? `https://cdn.discordapp.com/avatars/${this.id}/${this.avatar}.png`
+			: null
+	}
+
+	/**
+	 * Get the URL of the user's banner
+	 */
+	get bannerUrl(): string | null {
+		return this.banner
+			? `https://cdn.discordapp.com/banners/${this.id}/${this.banner}.png`
+			: null
+	}
+}

package/src/utils.ts

@@ -0,0 +1,13 @@
+export const splitCustomId = (
+	customId: string
+): [string, Record<string, string>] => {
+	const [id, ...args] = customId.split(":")
+	if (!id) throw new Error("Invalid custom ID was provided")
+	const data = Object.fromEntries(
+		args.map((arg) => {
+			const [key, value] = arg.split("=")
+			return [key, value]
+		})
+	)
+	return [id, data]
+}

package/tests/index.test.ts

@@ -0,0 +1,4 @@
+import { expect, test } from "vitest"
+import { Command } from "../src"
+
+test("Stub", () => {})

package/tsconfig.json

@@ -0,0 +1,12 @@
+{
+	"extends": "../../tsconfig.base.json",
+	"include": [
+		"src/**/*.ts",
+		"src/*.ts",
+		"package.json"
+	],
+	"compilerOptions": {
+		"outDir": "dist",
+		"rootDir": ".",
+	}
+}

package/typedoc.json

@@ -0,0 +1,9 @@
+{
+	"$schema": "https://typedoc.org/schema.json",
+	"extends": ["../../typedoc.json"],
+	"entryPoints": ["src/index.ts"],
+	"name": "@buape/carbon",
+	"out": "docs",
+	"excludeExternals": true,
+	"externalPattern": ["**/node_modules/**"]
+}