feat(structures): add SoundboardSound structure (#11390)

* feat(structures): update barrel exports in preparation for new structure

* feat(structures): add SoundboardSound structure

* chore(structures): update doc comment

* chore(structures): address review suggestions

* chore(structures): consistency changes and use isIdSet to retrieve id

* docs(structures): add remarks to conditionally present attributes

---------

Co-authored-by: kodiakhq[bot] <49736102+kodiakhq[bot]@users.noreply.github.com>

packages/structures/src/index.ts

@@ -7,6 +7,7 @@ export * from './interactions/index.js';
 export * from './invites/index.js';
 export * from './messages/index.js';
 export * from './polls/index.js';
+export * from './soundboards/index.js';
 export * from './stickers/index.js';
 export * from './teams/index.js';
 export * from './users/index.js';

packages/structures/src/soundboards/SoundboardSound.ts

@@ -0,0 +1,100 @@
+import { DiscordSnowflake } from '@sapphire/snowflake';
+import type { APISoundboardSound } from 'discord-api-types/v10';
+import { Structure } from '../Structure';
+import { kData } from '../utils/symbols';
+import { isIdSet } from '../utils/type-guards';
+import type { Partialize } from '../utils/types';
+
+/**
+ * Represents any soundboard sound on Discord.
+ *
+ * @typeParam Omitted - Specify the properties that will not be stored in the raw data field as a union, implement via `DataTemplate`
+ * @remarks has substructure `User` which needs to be instantiated and stored by an extending class using it
+ */
+export class SoundboardSound<Omitted extends keyof APISoundboardSound | '' = ''> extends Structure<
+	APISoundboardSound,
+	Omitted
+> {
+	/**
+	 * The template used for removing data from the raw data stored for each soundboard sound.
+	 */
+	public static override readonly DataTemplate: Partial<APISoundboardSound> = {};
+
+	/**
+	 * @param data - The raw data received from the API for the soundboard sound
+	 */
+	public constructor(data: Partialize<APISoundboardSound, Omitted>) {
+		super(data);
+	}
+
+	/**
+	 * The name of this sound
+	 */
+	public get name() {
+		return this[kData].name;
+	}
+
+	/**
+	 * The id of this sound
+	 */
+	public get soundId() {
+		return this[kData].sound_id;
+	}
+
+	/**
+	 * The volume of this sound, from 0 to 1
+	 */
+	public get volume() {
+		return this[kData].volume;
+	}
+
+	/**
+	 * The id of this sound's custom emoji
+	 */
+	public get emojiId() {
+		return this[kData].emoji_id;
+	}
+
+	/**
+	 * The unicode character of this sound's standard emoji
+	 */
+	public get emojiName() {
+		return this[kData].emoji_name;
+	}
+
+	/**
+	 * The id of the guild this sound is in
+	 */
+	public get guildId() {
+		return this[kData].guild_id;
+	}
+
+	/**
+	 * Whether this sound can be used, may be false due to loss of server boosts
+	 */
+	public get available() {
+		return this[kData].available;
+	}
+
+	/**
+	 * The timestamp this sound was created at
+	 *
+	 * @remarks only available for guild soundboard sounds
+	 */
+	public get createdTimestamp() {
+		return isIdSet(this[kData].sound_id) && isIdSet(this[kData].guild_id)
+			? DiscordSnowflake.timestampFrom(this[kData].sound_id)
+			: null;
+	}
+
+	/**
+	 * The time this sound was created at
+	 *
+	 * @remarks only available for guild soundboard sounds
+	 */
+	public get createdAt() {
+		const createdTimestamp = this.createdTimestamp;
+
+		return createdTimestamp ? new Date(createdTimestamp) : null;
+	}
+}

packages/structures/src/soundboards/index.ts

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