@buape/carbon 0.1.3 → 0.3.0

package/src/structures/GuildTextChannel.ts

@@ -1,21 +0,0 @@
-import { type APIGuildTextChannel, ChannelType } from "discord-api-types/v10"
-import { BaseGuildTextChannel } from "../abstracts/BaseGuildTextChannel.js"
-
-export class GuildTextChannel extends BaseGuildTextChannel<ChannelType.GuildText> {
-	type: ChannelType.GuildText = ChannelType.GuildText
-	/**
-	 * The default auto archive duration of threads in the channel.
-	 */
-	defaultAutoArchiveDuration?: number | null
-	/**
-	 * The default thread rate limit per user of the channel.
-	 */
-	defaultThreadRateLimitPerUser?: number | null
-
-	protected setMoreSpecificData(
-		data: APIGuildTextChannel<ChannelType.GuildText>
-	) {
-		this.defaultAutoArchiveDuration = data.default_auto_archive_duration
-		this.defaultThreadRateLimitPerUser = data.default_thread_rate_limit_per_user
-	}
-}

package/src/structures/GuildThreadChannel.ts

@@ -1,150 +0,0 @@
-import {
-	type APIThreadChannel,
-	Routes,
-	type ThreadChannelType
-} from "discord-api-types/v10"
-import { BaseGuildChannel } from "../abstracts/BaseGuildChannel.js"
-
-export class GuildThreadChannel<
-	Type extends ThreadChannelType
-> extends BaseGuildChannel<Type> {
-	/**
-	 * Whether the thread is archived.
-	 */
-	archived?: boolean
-	/**
-	 * The duration until the thread is auto archived.
-	 */
-	autoArchiveDuration?: number
-	/**
-	 * The timestamp of when the thread was archived.
-	 */
-	archiveTimestamp?: string
-	/**
-	 * Whether the thread is locked.
-	 */
-	locked?: boolean
-	/**
-	 * Whether non-moderators can add other non-moderators to a thread; only available on private threads
-	 */
-	invitable?: boolean
-	/**
-	 * The timestamp of when the thread was created.
-	 */
-	createTimestamp?: string
-	/**
-	 * The number of messages in the thread.
-	 */
-	messageCount?: number
-	/**
-	 * The number of members in the thread.
-	 *
-	 * @remarks
-	 * This is only accurate until 50, after that, Discord stops counting.
-	 */
-	memberCount?: number
-	/**
-	 * The ID of the owner of the thread.
-	 */
-	ownerId?: string
-	/**
-	 * The number of messages sent in the thread.
-	 */
-	totalMessageSent?: number
-	/**
-	 * The tags applied to the thread.
-	 */
-	appliedTags?: string[]
-
-	protected setSpecificData(data: APIThreadChannel) {
-		this.archived = data.thread_metadata?.archived
-		this.autoArchiveDuration = data.thread_metadata?.auto_archive_duration
-		this.archiveTimestamp = data.thread_metadata?.archive_timestamp
-		this.locked = data.thread_metadata?.locked
-		this.invitable = data.thread_metadata?.invitable
-		this.createTimestamp = data.thread_metadata?.create_timestamp
-		this.messageCount = data.message_count
-		this.memberCount = data.member_count
-		this.ownerId = data.owner_id
-		this.totalMessageSent = data.total_message_sent
-		this.appliedTags = data.applied_tags
-	}
-
-	/**
-	 * Join the thread
-	 */
-	async join() {
-		await this.addMember("@me")
-	}
-
-	/**
-	 * Add a member to the thread
-	 */
-	async addMember(userId: string) {
-		await this.client.rest.put(Routes.threadMembers(this.id, userId))
-	}
-
-	/**
-	 * Leave the thread
-	 */
-	async leave() {
-		await this.removeMember("@me")
-	}
-
-	/**
-	 * Get the pinned messages in the thread
-	 */
-	async removeMember(userId: string) {
-		await this.client.rest.delete(Routes.threadMembers(this.id, userId))
-	}
-
-	/**
-	 * Archive the thread
-	 */
-	async archive() {
-		await this.client.rest.patch(Routes.channel(this.id), {
-			body: { archive: true }
-		})
-		this.archived = true
-	}
-
-	/**
-	 * Unarchive the thread
-	 */
-	async unarchive() {
-		await this.client.rest.patch(Routes.channel(this.id), {
-			body: { archive: false }
-		})
-		this.archived = false
-	}
-
-	/**
-	 * Set the auto archive duration of the thread
-	 */
-	async setAutoArchiveDuration(duration: number) {
-		await this.client.rest.patch(Routes.channel(this.id), {
-			body: { auto_archive_duration: duration }
-		})
-		this.autoArchiveDuration = duration
-	}
-
-	/**
-	 * Lock the thread
-	 */
-	async lock() {
-		await this.client.rest.put(Routes.channel(this.id), {
-			body: { locked: true }
-		})
-		this.locked = true
-	}
-
-	/**
-	 * Unlock the thread
-	 */
-	async unlock() {
-		await this.client.rest.put(Routes.channel(this.id), {
-			body: { locked: false }
-		})
-		this.locked = false
-	}
-}

package/src/structures/Message.ts

@@ -1,124 +0,0 @@
-import {
-	type APIChannel,
-	type APIMessage,
-	type APIThreadChannel,
-	type RESTPostAPIChannelThreadsJSONBody,
-	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 { GuildThreadChannel } from "./GuildThreadChannel.js"
-import { User } from "./User.js"
-
-export class Message extends Base {
-	/**
-	 * The ID of the message
-	 */
-	id: string
-	/**
-	 * The ID of the channel the message is in
-	 */
-	channelId: string
-	/**
-	 * Whether the message is a partial message (meaning it does not have all the data).
-	 * If this is true, you should use {@link Message.fetch} to get the full data of the message.
-	 */
-	partial: boolean
-
-	private rawData: APIMessage | null = null
-
-	constructor(
-		client: Client,
-		rawDataOrIds:
-			| APIMessage
-			| {
-					id: string
-					channel_id: string
-			  }
-	) {
-		super(client)
-		this.id = rawDataOrIds.id
-		this.channelId = rawDataOrIds.channel_id
-		if (Object.keys(rawDataOrIds).length === 2) {
-			this.partial = true
-		} else {
-			this.partial = false
-			this.setData(rawDataOrIds as APIMessage)
-		}
-	}
-
-	private setData(data: typeof this.rawData) {
-		this.rawData = data
-		if (!data) throw new Error("Cannot set data without having data... smh")
-	}
-
-	/**
-	 * Fetch updated data for this message.
-	 * If the message is partial, this will fetch all the data for the message and populate the fields.
-	 * If the message is not partial, all fields will be updated with new values from Discord.
-	 */
-	async fetch() {
-		const newData = (await this.client.rest.get(
-			Routes.channelMessage(this.channelId, this.id)
-		)) as APIMessage
-		if (!newData) throw new Error(`Message ${this.id} not found`)
-
-		this.setData(newData)
-	}
-
-	/**
-	 * Delete this message from Discord
-	 */
-	async delete() {
-		return await this.client.rest.delete(
-			Routes.channelMessage(this.channelId, this.id)
-		)
-	}
-
-	get author(): User | null {
-		if (this.rawData?.webhook_id) return null // TODO: Add webhook user
-		// Check if we have an additional property on the author object, in which case we have a full user object
-		if (this.rawData?.author.username)
-			return new User(this.client, this.rawData.author)
-		// This means we only have a partial user object
-		if (this.rawData?.author.id)
-			return new User(this.client, this.rawData.author.id)
-		return null
-	}
-
-	async fetchChannel() {
-		const data = (await this.client.rest.get(
-			Routes.channel(this.channelId)
-		)) as APIChannel
-		return channelFactory(this.client, data)
-	}
-
-	/**
-	 * Pin this message
-	 */
-	async pin() {
-		await this.client.rest.put(Routes.channelPin(this.channelId, this.id))
-	}
-
-	/**
-	 * Unpin this message
-	 */
-	async unpin() {
-		await this.client.rest.delete(Routes.channelPin(this.channelId, this.id))
-	}
-
-	/**
-	 * Start a thread with this message as the associated start message.
-	 * If you want to start a thread without a start message, use {@link BaseGuildTextChannel.startThread}
-	 */
-	async startThread(data: RESTPostAPIChannelThreadsJSONBody) {
-		const thread = (await this.client.rest.post(
-			Routes.threads(this.channelId, this.id),
-			{
-				body: { ...data }
-			}
-		)) as APIThreadChannel
-		return new GuildThreadChannel(this.client, thread)
-	}
-}

package/src/structures/Role.ts

@@ -1,201 +0,0 @@
-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

@@ -1,153 +0,0 @@
-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

@@ -1,13 +0,0 @@
-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

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

package/tsconfig.json

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

package/typedoc.json

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