feat(structures): add Channel base

packages/structures/src/channels/Channel.ts

@@ -0,0 +1,157 @@
+import { DiscordSnowflake } from '@sapphire/snowflake';
+import type { APIChannel, APIPartialChannel, ChannelType } from 'discord-api-types/v10';
+import type { StructureExtraOptions } from '../Structure.js';
+import { Structure } from '../Structure.js';
+import { kData } from '../utils/symbols.js';
+
+export type PartialChannel = Channel<'unknown', Exclude<keyof APIChannel, keyof APIPartialChannel>>;
+
+/**
+ * @internal
+ */
+export type ChannelDataType<Type extends ChannelType | 'unknown'> = Type extends 'unknown'
+	? APIChannel
+	: Extract<APIChannel, { type: Type }>;
+
+export class Channel<
+	Type extends ChannelType | 'unknown' = 'unknown',
+	Omitted extends keyof ChannelDataType<Type> | '' = '',
+> extends Structure<ChannelDataType<Type>, Omitted> {
+	/**
+	 * The template used for removing data from the raw data stored for each Channel.
+	 *
+	 * @remarks This template will only apply to channels constructed
+	 * Use the appropriate subclass template to remove data from that channel type
+	 */
+	public static DataTemplate: Partial<APIChannel> = {};
+
+	public constructor(
+		/**
+		 * The raw data received from the API for the channel
+		 */
+		data: Omit<ChannelDataType<Type>, Omitted>,
+		extraOptions?: StructureExtraOptions,
+	) {
+		super(data as ChannelDataType<Type>, extraOptions ?? { template: Channel.DataTemplate });
+	}
+
+	/**
+	 * {@inheritDoc Structure._patch}
+	 */
+	public override _patch(data: Partial<ChannelDataType<Type>>, extraOptions: StructureExtraOptions) {
+		return super._patch(data, extraOptions ?? { template: Channel.DataTemplate });
+	}
+
+	/**
+	 * The id of the channel
+	 */
+	public get id() {
+		return this[kData].id;
+	}
+
+	/**
+	 * The type of the channel
+	 */
+	public get type() {
+		// This cast can be incorrect when type is omitted and if the wrong type of channel was constructed
+		return this[kData].type as Type extends 'unknown' ? number : Type;
+	}
+
+	/**
+	 * The name of the channel, null for DMs
+	 *
+	 * @privateRemarks The type of `name` can be narrowed in Guild Channels and DM channels to string and null respectively,
+	 * respecting Omit behaviors
+	 */
+	public get name() {
+		return this[kData].name;
+	}
+
+	/**
+	 * The timestamp the channel was created at
+	 */
+	public get createdTimestamp() {
+		return typeof this.id === 'string' ? DiscordSnowflake.timestampFrom(this.id) : null;
+	}
+
+	/**
+	 * The time the channel was created at
+	 */
+	public get createdAt() {
+		const createdTimestamp = this.createdTimestamp;
+		return createdTimestamp ? new Date(createdTimestamp) : null;
+	}
+
+	// TODO: Make these type guards once the mixins are written
+	/**
+	 * Indicates whether this channel is a thread channel
+	 *
+	 * @privateRemarks Overriden to `true` on `ThreadChannelMixin`
+	 */
+	public isThread() {
+		return false;
+	}
+
+	/**
+	 * Indicates whether this channel can contain messages
+	 *
+	 * @privateRemarks Overriden to `true` on `TextChannelMixin`
+	 */
+	public iSTextBased() {
+		return false;
+	}
+
+	/**
+	 * Indiciates whether this channel is in a guild
+	 *
+	 * @privateRemarks OVerriden to `true` on `GuildChannelMixin`
+	 */
+	public isGuildBased() {
+		return false;
+	}
+
+	/**
+	 * Indicates whether this channel is a DM or DM Group
+	 *
+	 * @privateRemarks Overriden to `true` on `DMChannelMixin`
+	 */
+	public isDMBased() {
+		return false;
+	}
+
+	/**
+	 * Indicates whether this channel has voice connection capabilities
+	 *
+	 * @privateRemarks Overriden to `true` on `VoiceChannelMixin`
+	 */
+	public isVoiceBased() {
+		return false;
+	}
+
+	/**
+	 * Indicates whether this channel only allows thread creation
+	 *
+	 * @privateRemarks Overriden to `true` on `ThreadOnlyChannelMixin`
+	 */
+	public isThreadOnly() {
+		return false;
+	}
+
+	/**
+	 * Indicates whether this channel can have permission overwrites
+	 *
+	 * @privateRemarks Overriden to `true` on `ChannelPermissionsMixin`
+	 */
+	public isPermissionCapabale() {
+		return false;
+	}
+
+	/**
+	 * Indicates whether this channel can have webhooks
+	 *
+	 * @privateRemarks Overriden to `true` on `ChannelWebhooksMixin`
+	 */
+	public isWebhookCapable() {
+		return false;
+	}
+}

packages/structures/src/channels/index.ts

@@ -0,0 +1 @@
+export * from './Channel.js';