oceanic.js 1.0.0-dev.3cfdac7 → 1.0.0-dev.3d69a0f

package/examples/applicationCommand.js

@@ -1,6 +1,6 @@
-// the application command management functions are on ClientApplication (client.application) & client.rest.applicationCommands
-// https://oceanic.owo-whats-this.dev/classes/structures_ClientApplication.ClientApplication.html
-// https://oceanic.owo-whats-this.dev/classes/routes_ApplicationCommands.ApplicationCommands.html
+// The application command management functions are on ClientApplication (client.application) & client.rest.applicationCommands
+// https://oceanic.owo-whats-this.dev/latest/classes/ClientApplication.ClientApplication.html
+// https://oceanic.owo-whats-this.dev/latest/classes/Routes_ApplicationCommands.ApplicationCommands.html
 const { ApplicationCommandOptionTypes, ApplicationCommandTypes, Client } = require("oceanic.js");
 
 const client = new Client({
@@ -13,24 +13,24 @@ const client = new Client({
 client.on("ready", async() => {
     console.log("Ready as", client.user.tag);
 
-    // https://oceanic.owo-whats-this.dev/classes/structures_ClientApplication.ClientApplication.html#createGlobalCommand
+    // https://oceanic.owo-whats-this.dev/classes/ClientApplication.ClientApplication.html#createGlobalCommand
     // Create a single command
     await client.application.createGlobalCommand({
-        type: ApplicationCommandTypes.CHAT_INPUT, // CHAT_INPUT = slash commands - full list: https://oceanic.owo-whats-this.dev/enums/Constants.ApplicationCommandTypes.html
+        type: ApplicationCommandTypes.CHAT_INPUT, // CHAT_INPUT = slash commands - full list: https://oceanic.owo-whats-this.dev/latest/enums/Constants.ApplicationCommandTypes.html
         name: "global-command",
         description: "A global command.",
         options: [
             {
-                type: ApplicationCommandOptionTypes.STRING, // A string input - full list: https://oceanic.owo-whats-this.dev/enums/Constants.ApplicationCommandOptionTypes.html
+                type: ApplicationCommandOptionTypes.STRING, // A string input - full list: https://oceanic.owo-whats-this.dev/latest/enums/Constants.ApplicationCommandOptionTypes.html
                 name: "suspicious",
                 nameLocalizations: { // (optional) a dictionary of locales to localized names (see: https://discord.com/developers/docs/reference#locales)
                     "es-ES": "sospechoso"
                 },
                 description: "Are you sus?",
-                descriptionLocalizations: { // same as above
+                descriptionLocalizations: { // Same as above
                     "es-ES": "¿Eres sus?"
                 },
-                choices: [ // a BOOLEAN can also be used instead
+                choices: [ // A BOOLEAN can also be used instead
                     {
                         name: "Yes",
                         nameLocalizations: {
@@ -49,10 +49,10 @@ client.on("ready", async() => {
             }
         ],
         dmPermission: false, // false = usable in guilds only, true = both guild & direct message
-        defaultMemberPermissions: "8" // The default permissions required to use this command (8 = Administrator)
+        defaultMemberPermissions: "8" // The bitfield of the default permissions required to use this command (8 = Administrator)
     });
 
-    // https://oceanic.owo-whats-this.dev/classes/structures_ClientApplication.ClientApplication.html#bulkEditGlobalCommands
+    // https://oceanic.owo-whats-this.dev/latest/classes/ClientApplication.ClientApplication.html#bulkEditGlobalCommands
     // Instead of deleting individual commands or creating commands one at a time, you can create them in bulk.
     await client.application.bulkEditGlobalCommands([
         {
@@ -65,7 +65,7 @@ client.on("ready", async() => {
         },
         {
             type: ApplicationCommandTypes.MESSAGE, // This will display in the `Apps` context menu, when clicking on a message.
-            // same as above
+            // Same as above
             name: "Raw Json",
             nameLocalizations: {
                 "es-ES": "json crudo"
@@ -73,18 +73,18 @@ client.on("ready", async() => {
         }
     ]);
 
-    // https://oceanic.owo-whats-this.dev/classes/structures_ClientApplication.ClientApplication.html#getGlobalCommands
+    // https://oceanic.owo-whats-this.dev/latest/classes/ClientApplication.ClientApplication.html#getGlobalCommands
     // if you need to fetch your commands
     const commands = await client.application.getGlobalCommands();
-    console.log(commands); // an array of ApplicationCommand classes
+    console.log(commands); // An array of ApplicationCommand classes
 
-    for(const command of commands) {
-        // https://oceanic.owo-whats-this.dev/classes/structures_ApplicationCommand.ApplicationCommand.html#delete
-        await command.delete(); // DON'T DO THIS! This is just an example. Use `bulkedit` with an empty array if you want to delete all commands.
+    for (const command of commands) {
+        // https://oceanic.owo-whats-this.dev/latest/classes/ApplicationCommand.ApplicationCommand.html#delete
+        await command.delete(); // DON'T DO THIS! This is just an example. Use `bulkEdit` with an empty array if you want to delete all commands
     }
 
-    // https://oceanic.owo-whats-this.dev/classes/structures_ClientApplication.ClientApplication.html#createGuildCommand
-    // guilds commands are exactly the same thing, but with a guild id included.
+    // https://oceanic.owo-whats-this.dev/latest/classes/ClientApplication.ClientApplication.html#createGuildCommand
+    // Guilds commands are exactly the same thing, but with a guild ID included
     await client.application.createGuildCommand("1005489770278953112", {
         type: ApplicationCommandTypes.CHAT_INPUT,
         name: "guild-command",
@@ -98,10 +98,10 @@ client.on("ready", async() => {
     });
 });
 
-// an error handler
+// An error handler
 client.on("error", (error) => {
     console.error("Something went wrong:", error);
 });
 
-// connect to Discord
+// Connect to Discord
 client.connect();

package/examples/components.js

@@ -9,25 +9,25 @@ const client = new Client({
 
 client.on("ready", () => console.log("Ready as", client.user.tag));
 
-client.on("messageCreate", async(msg) => {
+client.on("messageCreate", async (msg) => {
     if(msg.content.includes("!component")) {
         await client.rest.channels.createMessage(msg.channel.id, {
             content: `Here's some buttons for you, ${msg.author.mention}.`,
             components: [
                 {
-                    // the top level component must always be an action row.
-                    // Full list of types: https://oceanic.owo-whats-this.dev/enums/Constants.ComponentTypes.html
-                    // https://oceanic.owo-whats-this.dev/interfaces/types_channels.MessageActionRow.html
+                    // The top level component must always be an action row.
+                    // Full list of types: https://oceanic.owo-whats-this.dev/latest/enums/Constants.ComponentTypes.html
+                    // https://oceanic.owo-whats-this.dev/latest/interfaces/types_channels.MessageActionRow.html
                     type: ComponentTypes.ACTION_ROW,
                     components: [
                         {
-                            // https://oceanic.owo-whats-this.dev/interfaces/types_channels.TextButton.html
+                            // https://oceanic.owo-whats-this.dev/latest/interfaces/types_channels.TextButton.html
                             type: ComponentTypes.BUTTON,
-                            style: ButtonStyles.PRIMARY, // the style of button - full list: https://oceanic.owo-whats-this.dev/enums/Constants.ButtonStyles.html
+                            style: ButtonStyles.PRIMARY, // The style of button - full list: https://oceanic.owo-whats-this.dev/latest/enums/Constants.ButtonStyles.html
                             customID: "some-string-you-will-see-later",
                             label: "Click!",
                             disabled: false, // If the button is disabled, false by default.
-                            emoji: { // an optional emoji
+                            emoji: { // An optional emoji
                                 id: "1013346070606123009",
                                 name: "oceanic"
                             }
@@ -40,25 +40,25 @@ client.on("messageCreate", async(msg) => {
                             disabled: true
                         },
                         {
-                            // https://oceanic.owo-whats-this.dev/interfaces/types_channels.URLButton.html
+                            // https://oceanic.owo-whats-this.dev/latest/interfaces/types_channels.URLButton.html
                             type: ComponentTypes.BUTTON,
                             style: ButtonStyles.LINK,
                             label: "Open Link",
                             url: "https://oceanic.owo-whats-this.dev"
                         },
                         {
-                            // https://oceanic.owo-whats-this.dev/interfaces/types_channels.SelectMenu.html
+                            // https://oceanic.owo-whats-this.dev/latest/interfaces/types_channels.SelectMenu.html
                             type: ComponentTypes.SELECT_MENU,
                             customID: "select-menu",
                             disabled: false,
-                            maxValues: 1, // the maximum number of values that can be selected (default 1)
-                            minValues: 1, // the minimum number of values that can be selected (default 1)
+                            maxValues: 1, // The maximum number of values that can be selected (default 1)
+                            minValues: 1, // The minimum number of values that can be selected (default 1)
                             options: [
-                                // https://oceanic.owo-whats-this.dev/interfaces/types_channels.SelectOption.html
+                                // https://oceanic.owo-whats-this.dev/latest/interfaces/types_channels.SelectOption.html
                                 {
-                                    default: true, // if this option is selected by default
-                                    description: "The description of the option", // optional description
-                                    emoji: { // an optional emoji
+                                    default: true, // If this option is selected by default
+                                    description: "The description of the option", // Optional description
+                                    emoji: { // An optional emoji
                                         id: "1013346070606123009",
                                         name: "oceanic"
                                     },
@@ -79,10 +79,10 @@ client.on("messageCreate", async(msg) => {
     }
 });
 
-// an error handler
+// An error handler
 client.on("error", (error) => {
     console.error("Something went wrong:", error);
 });
 
-// connect to Discord
+// Connect to Discord
 client.connect();

package/examples/embeds.js

@@ -1,5 +1,5 @@
 const { Client } = require("oceanic.js");
-const fs = require("fs");
+const { readFileSync } = require("fs");
 
 const client = new Client({
     auth: "Bot [TOKEN]",
@@ -10,26 +10,27 @@ const client = new Client({
 
 client.on("ready", () => console.log("Ready as", client.user.tag));
 
-client.on("messageCreate", async(msg) => {
+client.on("messageCreate", async (msg) => {
     if(msg.content.includes("!embed")) {
 		await client.rest.channels.createMessage(msg.channel.id, {
-			// https://oceanic.owo-whats-this.dev/interfaces/types_channels.EmbedOptions.html
-			// up to 10 in one message
+			// https://oceanic.owo-whats-this.dev/latest/interfaces/types_channels.EmbedOptions.html
+			// Up to 10 in one message
 			embeds: [
 				{
-					// https://oceanic.owo-whats-this.dev/interfaces/types_channels.EmbedAuthorOptions.html
+					// https://oceanic.owo-whats-this.dev/latest/interfaces/types_channels.EmbedAuthorOptions.html
 					author: {
 						name: "Author Name",
-						// an image url, or attachment://filename.ext
-						icon_url: "https://i.furry.cool/DonPride.png", // optional
-						url: "https://oceanic.owo-whats-this.dev" // optional
+						// An image url, or attachment://filename.ext
+						iconURL: "https://i.furry.cool/DonPride.png", // Optional
+						url: "https://oceanic.owo-whats-this.dev" // Optional
 					},
-					// array of https://oceanic.owo-whats-this.dev/interfaces/types_channels.EmbedField.html
+					// Array of https://oceanic.owo-whats-this.dev/latest/interfaces/types_channels.EmbedField.html
+					// Up to 25 in one message
 					fields: [
 						{
 							name: "Field One",
 							value: "Field One Value",
-							inline: true // if this field should be displayed inline (default: true)
+							inline: true // If this field should be displayed inline (default: false)
 						},
 						{
 							name: "Field Two",
@@ -37,26 +38,26 @@ client.on("messageCreate", async(msg) => {
 							inline: false
 						}
 					],
-					// https://oceanic.owo-whats-this.dev/interfaces/types_channels.EmbedFooterOptions.html
+					// https://oceanic.owo-whats-this.dev/latest/interfaces/types_channels.EmbedFooterOptions.html
 					footer: {
 						text: "Footer Text",
-						// an image url, or attachment://filename.ext
-						icon_url: "https://i.furry.cool/DonPride.png" // optional
+						// An image url, or attachment://filename.ext
+						iconURL: "https://i.furry.cool/DonPride.png" // Optional
 					},
-					// https://oceanic.owo-whats-this.dev/interfaces/types_channels.EmbedImageOptions.html
+					// https://oceanic.owo-whats-this.dev/latest/interfaces/types_channels.EmbedImageOptions.html
 					image: {
-						// an image url, or attachment://filename.ext
+						// An image url, or attachment://filename.ext
 						url: "https://i.furry.cool/DonPride.png"
 					},
-					// https://oceanic.owo-whats-this.dev/interfaces/types_channels.EmbedThumbnailOptions.html
+					// https://oceanic.owo-whats-this.dev/latest/interfaces/types_channels.EmbedThumbnailOptions.html
 					thumbnail: {
-						// an image url, or attachment://filename.ext
+						// An image url, or attachment://filename.ext
 						url: "https://i.furry.cool/DonPride.png"
 					},
-					// https://oceanic.owo-whats-this.dev/interfaces/types_channels.EmbedOptions.html
-					color: 0xFFA500, // base-10 color (0x prefix can be used for hex codes)
+					// https://oceanic.owo-whats-this.dev/latest/interfaces/types_channels.EmbedOptions.html
+					color: 0xFFA500, // Base-10 color (0x prefix can be used for hex codes)
 					description: "My Cool Embed",
-					timestamp: new Date().toISOString(), // the current time - ISO 8601 format
+					timestamp: new Date().toISOString(), // The current time - ISO 8601 format
 					title: "My Amazing Embed",
 					url: "https://oceanic.owo-whats-this.dev"
 				}
@@ -67,7 +68,7 @@ client.on("messageCreate", async(msg) => {
 			embeds: [
 				{
 					image: {
-						// this can also be used for author & footer images
+						// This can also be used for author & footer images
 						url: "attachment://image.png"
 					}
 				}
@@ -75,17 +76,17 @@ client.on("messageCreate", async(msg) => {
 			files: [
 				{
 					name: "image.png",
-					contents: fs.readFileSync(`${__dirname}/image.png`)
+					contents: readFileSync(`${__dirname}/image.png`)
 				}
 			]
 		});
 	}
 });
 
-// an error handler
+// An error handler
 client.on("error", (error) => {
     console.error("Something went wrong:", error);
 });
 
-// connect to Discord
+// Connect to Discord
 client.connect();

package/examples/intents.js

@@ -1,41 +1,40 @@
 const { Client } = require("oceanic.js");
-const fs = require("fs");
 
 const client = new Client({
     auth: "Bot [TOKEN]",
     gateway: {
-		// list of intents: https://discord.com/developers/docs/topics/gateway#list-of-intents
-		// they roughly map on to events we use
-        // most events also list if they require an intent: https://oceanic.owo-whats-this.dev/dev/interfaces/types_events.ClientEvents.html
+		// List of intents: https://discord.com/developers/docs/topics/gateway#list-of-intents
+		// They change what events our client receives to lower the amount of computer power needed to run it
+        // Most events also list if they require an intent: https://oceanic.owo-whats-this.dev/latest/interfaces/types_events.ClientEvents.html
         intents: ["GUILDS", "GUILD_MESSAGES", "MESSAGE_CONTENT"]
-        // if you do not have the MESSAGE_CONTENT intent, various fields like `content`, `components`, `embeds` and more will be empty unless your client is specifically addressed.
+        // If you do not have the MESSAGE_CONTENT intent, various fields like `content`, `components`, `embeds` and more will be empty unless the message belongs to or mentions your client
     }
 });
 
 client.on("ready", () => console.log("Ready as", client.user.tag));
 
-// an error handler
+// An error handler
 client.on("error", (error) => {
     console.error("Something went wrong:", error);
 });
 
 // New Guild Joined
-// https://oceanic.owo-whats-this.dev/dev/interfaces/types_events.ClientEvents.html#guildCreate
+// https://oceanic.owo-whats-this.dev/latest/interfaces/types_events.ClientEvents.html#guildCreate
 bot.on("guildCreate", (guild) => {
     console.log("Guild Joined:", guild.name);
 });
 
 // Message Sent
-// https://oceanic.owo-whats-this.dev/dev/interfaces/types_events.ClientEvents.html#messageCreate
+// https://oceanic.owo-whats-this.dev/latest/interfaces/types_events.ClientEvents.html#messageCreate
 bot.on("messageCreate", (msg) => {
     console.log(`New message: ${msg.content}`);
 });
 
 // This event will never be seen as neither `GUILD_MESSAGE_TYPING` or `DIRECT_MESSAGE_TYPING` were included in the intents
-// https://oceanic.owo-whats-this.dev/dev/interfaces/types_events.ClientEvents.html#typingStart
+// https://oceanic.owo-whats-this.dev/latest/interfaces/types_events.ClientEvents.html#typingStart
 bot.on("typingStart", (channel, user) => { // When a user starts typing
-    console.log(`${user.username} is typing in ${channel.name}`);
+    console.log(`${user.id} is typing in ${channel.id}`); // User or channel are not necessarily complete (Uncached) to retrieve names
 });
 
-// connect to Discord
+// Connect to Discord
 client.connect();

package/examples/interactions.js

@@ -0,0 +1,171 @@
+const { Client, InteractionTypes, MessageFlags, ComponentTypes, ApplicationCommandTypes } = require("oceanic.js");
+
+const client = new Client({
+    auth: "Bot [TOKEN]",
+    gateway: {
+        intents: 0 // No intents are needed if you are only using interactions
+    }
+});
+
+
+client.on("ready", async() => {
+    console.log("Ready as", client.user.tag);
+});
+
+client.on("interactionCreate", async(interaction) => {
+    switch(interaction.type) {
+        // https://oceanic.owo-whats-this.dev/latest/classes/CommandInteraction.CommandInteraction.html
+        case InteractionTypes.APPLICATION_COMMAND: {
+            // defer interactions as soon as possible, you have three seconds to send any initial response
+            // if you wait too long, the interaction may be invalidated
+            await interaction.defer();
+            // If you want the response to be ephemeral, you can provide the flag to the defer function, like so:
+            // await interaction.defer(MessageFlags.EPHEMERAL);
+
+            // data = https://oceanic.owo-whats-this.dev/latest/interfaces/Types_Interactions.ApplicationCommandInteractionData.html
+            switch(interaction.data.type) {
+                // Chat Input commands are what you use in the chat, i.e. slash commands
+                case ApplicationCommandTypes.CHAT_INPUT: {
+                    if(interaction.data.name === "greet") {
+                        // assume we have two options, user (called user) then string (called greeting) - first is required, second is not
+
+                        // Get an option named `user` with the type USER - https://oceanic.owo-whats-this.dev/dev/classes/InteractionOptionsWrapper.InteractionOptionsWrapper.html#getUser
+                        // Setting the second parameter to true will throw an error if the option is not present
+                        const user = interaction.data.options.getUser("user", true);
+                        const greeting = interaction.data.options.getString("greeting", false) || "Hello, ";
+
+                        // since we've already deferred the interaction, we cannot use createMessage (this is an initial response)
+                        // we can only have one initial response, so we use createFollowup
+                        await interaction.createFollowup({
+                            content: `${greeting} ${user.mention}!`,
+                            allowedMentions: {
+                                users: [user.id]
+                            }
+                        });
+                    }
+
+                // Chat Input application command interactions also have a set of resolved data, which is structured as so:
+                // https://oceanic.owo-whats-this.dev/latest/interfaces/Types_Interactions.ApplicationCommandInteractionResolvedData.html
+                // the options wrapper pulls values out of resolved automatically, if you use the right method
+                    break;
+                }
+
+                // User application commands are shown in the context menu when right clicking on users
+                // `data` will have a target (and targetID) property with the user that the command was executed on
+                // These don't have options
+                case ApplicationCommandTypes.USER: {
+                    if(interaction.data.name === "ping") {
+                        await interaction.createFollowup({
+                            content: `Pong! ${interaction.data.target.mention}`,
+                            allowedMentions: {
+                                users: [interaction.data.target.id]
+                            }
+                        });
+                    }
+                    break;
+                }
+
+                // Message application commands are shown in the context menu when right clicking on  essages
+                // `data` will have a target (and targetID) property with the message that the command was executed on
+                // Same as user commands, these don't have options
+                case ApplicationCommandTypes.MESSAGE: {
+                    if(interaction.data.name === "author") {
+                        await interaction.createFollowup({
+                            content: `${interaction.data.target.author.mention} is the author of that message!`,
+                            allowedMentions: {
+                                users: [interaction.data.target.author.id]
+                            }
+                        });
+                    }
+                    break;
+                }
+            }
+            break;
+        }
+
+        // https://oceanic.owo-whats-this.dev/latest/classes/ComponentInteraction.ComponentInteraction.html
+        case InteractionTypes.MESSAGE_COMPONENT: {
+            // same spiel as above
+            await interaction.defer();
+            // when you create a message with components, this will correspond with what you provided as the customID there
+            if(interaction.data.componentType === ComponentTypes.BUTTON) {
+                if(interaction.data.customID === "edit-message") {
+                    // Edits the original message. This has an initial response variant: editParent
+                    await interaction.editOriginal({
+                        content: `This message was edited by ${interaction.user.mention}!`,
+                        allowedMentions: {
+                            users: [interaction.user.id]
+                        }
+                    });
+                } else if(interaction.data.customID === "my-amazing-button") {
+                    await interaction.createFollowup({
+                        content: "You clicked an amazing button!"
+                    });
+                }
+            } else if(interaction.data.componentType === ComponentTypes.SELECT_MENU) {
+                // The `values` property under data contains all of the selected values
+                await interaction.createFollowup({
+                    content: `You selected: **${interaction.data.values.join("**, **")}**`
+                });
+            }
+            break;
+        }
+
+        // https://oceanic.owo-whats-this.dev/latest/classes/AutocompleteInteraction.AutocompleteInteraction.html
+        case InteractionTypes.APPLICATION_COMMAND_AUTOCOMPLETE: {
+            // Autocomplete Interactions cannot be deferred
+            switch(interaction.data.name) {
+                case "test-autocomplete": {
+                    // Autocomplete interactions data has a partial `options` property, which is the tree of options that are currently being filled in
+                    // along with one at the end, which will have focused
+                    // Setting the first parameter to true will throw an error if no focused option is present
+                    const option = interaction.data.options.getFocused(true);
+                    switch(option.name) {
+                        case "test-option": {
+                            return interaction.result([
+                                {
+                                    name: "Choice 1",
+                                    nameLocalizations: {
+                                        "es-ES": "Opción 1"
+                                    },
+                                    value: "choice-1"
+                                },
+                                {
+                                    name: "Choice 2",
+                                    nameLocalizations: {
+                                        "es-ES": "Opción 2"
+                                    },
+                                    value: "choice-2"
+                                }
+                            ]);
+                            break;
+                        }
+                    }
+                }
+            }
+            break;
+        }
+
+        // https://oceanic.owo-whats-this.dev/latest/classes/ModalSubmitInteraction.ModalSubmitInteraction.html
+        case InteractionTypes.MODAL_SUBMIT: {
+            // this will correspond with the customID you provided when creating the modal
+            switch(interaction.data.customID) {
+                case "test-modal": {
+                    // the `components` property under data contains all of the components that were submitted
+                    // https://oceanic.owo-whats-this.dev/latest/interfaces/Types_Channels.ModalActionRow.html
+                    console.log(interaction.data.components);
+                    break;
+                }
+            }
+            break;
+        }
+    }
+});
+
+// An error handler
+client.on("error", (error) => {
+    console.error("Something went wrong:", error);
+});
+
+// Connect to Discord
+client.connect();

package/examples/voice.js

@@ -0,0 +1,47 @@
+const { Client } = require("oceanic.js");
+const { VoiceConnectionStatus, AudioPlayerStatus, createAudioPlayer, createAudioResource } = require("@discordjs/voice");
+
+const client = new Client({
+    auth: "Bot [TOKEN]",
+    gateway: {
+        intents: ["GUILDS", "GUILD_VOICE_STATES"] // Voice connections require the GUILDS intent; We specify the GUILD_VOICE_STATES intent to reconnect to the voice channel in case we get disconnected
+    }
+});
+
+client.on("ready", () => {
+    console.log("Ready as", client.user.tag);
+
+    const guild = client.guilds.get("1005489770278953112"); // We need the guild to get the voiceAdapterCreator
+
+    const voiceConnection = client.joinVoiceChannel({
+        channelID: "1005489770849382443", // The ID of the channel to connect to
+        guildID: "1005489770278953112", // The ID of the guild the channel belongs to
+        selfDeaf: true, // Whether our client joins defeaned
+        selfMute: false, // Whether our client joins muted
+        voiceAdapterCreator: guild.voiceAdapterCreator // The voiceAdapterCreator the guild provides
+    })
+    voiceConnection.on(VoiceConnectionStatus.Disconnected, () => {
+        voiceConnection.rejoin(); // In case we get disconnected, rejoin
+    });
+
+    const player = createAudioPlayer(); // Create the player we will use to play audio
+    voiceConnection.subscribe(player); // Subscribe the player to the voice connection to the channel we have
+
+    player.on(AudioPlayerStatus.Playing, () => {
+        console.log("Audio started playing");
+    });
+    player.on(AudioPlayerStatus.Idle, () => {
+        console.log("The player is not playing any audio");
+    })
+
+    const audio = createAudioResource(`${__dirname}/audio.mp3`); // Create the audio resource from the mp3 we have to play through the player
+    player.play(audio); // Play the audio
+});
+
+// An error handler
+client.on("error", (error) => {
+    console.error("Something went wrong:", error);
+});
+
+// Connect to Discord
+client.connect();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "oceanic.js",
-  "version": "1.0.0-dev.3cfdac7",
+  "version": "1.0.0-dev.3d69a0f",
   "description": "A NodeJS library for interfacing with Discord.",
   "main": "./dist/lib/index.js",
   "types": "./dist/lib/index.d.ts",
@@ -15,7 +15,8 @@
   "scripts": {
     "lint": "eslint lib --ext .ts",
     "lint:fix": "eslint lib --ext .ts --fix",
-    "prepublishOnly": "node build"
+    "prepublishOnly": "node scripts/build",
+    "test:docs": "npm i --no-save --ignore-scripts typedoc typedoc-plugin-extras typedoc-plugin-rename-defaults && node scripts/doc-test.js && npx --yes typedoc"
   },
   "repository": {
     "type": "git",
@@ -58,5 +59,8 @@
   },
   "engines": {
     "node": ">=16.16.0"
+  },
+  "optionalDependencies": {
+    "@discordjs/voice": "^0.11.0"
   }
 }

package/build.js

@@ -1,6 +0,0 @@
-const { execSync } = require("child_process");
-const { rmSync, readFileSync, writeFileSync, existsSync, cpSync } = require("fs");
-if(existsSync(`${__dirname}/dist`)) rmSync(`${__dirname}/dist`, { recursive: true });
-execSync("tsc", { stdio: "inherit" });
-writeFileSync(`${__dirname}/dist/lib/index.js`, readFileSync(`${__dirname}/dist/lib/index.js`).toString().replace(/__exportStar\(require\("\.\/types\/index"\), exports\);\r?\n/, ""))
-cpSync(`${__dirname}/lib/types`, `${__dirname}/dist/lib/types`, { recursive: true });

package/dist/lib/types/stage-instances.d.ts

@@ -1,12 +0,0 @@
-import type { StageInstancePrivacyLevels } from "../Constants";
-
-export interface RawStageInstance {
-    channel_id: string;
-    /** @deprecated */
-    discoverable_disabled: boolean;
-    guild_id: string;
-    guild_scheduled_event_id?: string;
-    id: string;
-    privacy_level: StageInstancePrivacyLevels;
-    topic: string;
-}

package/dist/lib/util/Properties.d.ts

@@ -1,9 +0,0 @@
-export default class Properties<C = unknown> {
-    #private;
-    constructor(obj: unknown);
-    static define<T, K extends keyof T>(obj: T, property: K, value: T[K], writable?: boolean, configurable?: boolean, enumerable?: boolean): Properties<T>;
-    static looseDefine<T>(obj: T, property: string, value: unknown, writable?: boolean, configurable?: boolean, enumerable?: boolean): Properties<T>;
-    static new<T>(obj: T): Properties<T>;
-    define<K extends keyof C>(property: K, value: C[K], writable?: boolean, configurable?: boolean, enumerable?: boolean): this;
-    looseDefine(property: string, value: unknown, writable?: boolean, configurable?: boolean, enumerable?: boolean): this;
-}