oceanic.js 1.0.0-dev.5de1d4e → 1.0.0-dev.65b4872

package/examples/embeds.js

@@ -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
+			// Up to 10 in one message
 			embeds: [
 				{
 					// https://oceanic.owo-whats-this.dev/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/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: to false)
 						},
 						{
 							name: "Field Two",
@@ -40,23 +41,23 @@ client.on("messageCreate", async(msg) => {
 					// https://oceanic.owo-whats-this.dev/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
 					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
 					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)
+					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"
 					}
 				}
@@ -82,10 +83,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/intents.js

@@ -1,20 +1,19 @@
 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/dev/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);
 });
@@ -34,8 +33,8 @@ bot.on("messageCreate", (msg) => {
 // 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
 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/voice.js

@@ -0,0 +1,48 @@
+const { Client } = require("oceanic.js");
+const { VoiceConnectionStatus, AudioPlayerStatus, createAudioPlayer, createAudioResource } = require("@discordjs/voice");
+const path = require("path");
+
+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(path.join(__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.5de1d4e",
+  "version": "1.0.0-dev.65b4872",
   "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 build",
+    "test:docs": "npm i --no-save --ignore-scripts typedoc typedoc-plugin-extras typedoc-plugin-rename-defaults && node 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/dist/lib/voice/VoiceConnection.d.ts

@@ -1,7 +0,0 @@
-import { VoiceEvents } from "../types/events";
-import TypedEmitter from "../util/TypedEmitter";
-/** Represents a voice connection. See {@link types/events~VoiceEvents | Voice Events} for a list of events. */
-export default class VoiceConnection extends TypedEmitter<VoiceEvents> {
-    id: string;
-    constructor(id: string);
-}

package/dist/lib/voice/VoiceConnection.js

@@ -1,16 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const TypedEmitter_1 = __importDefault(require("../util/TypedEmitter"));
-/** Represents a voice connection. See {@link types/events~VoiceEvents | Voice Events} for a list of events. */
-class VoiceConnection extends TypedEmitter_1.default {
-    id;
-    constructor(id) {
-        super();
-        this.id = id;
-    }
-}
-exports.default = VoiceConnection;
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiVm9pY2VDb25uZWN0aW9uLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vLi4vbGliL3ZvaWNlL1ZvaWNlQ29ubmVjdGlvbi50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOzs7OztBQUNBLHdFQUFnRDtBQUVoRCwrR0FBK0c7QUFDL0csTUFBcUIsZUFBZ0IsU0FBUSxzQkFBeUI7SUFDbEUsRUFBRSxDQUFTO0lBQ1gsWUFBWSxFQUFVO1FBQ2xCLEtBQUssRUFBRSxDQUFDO1FBQ1IsSUFBSSxDQUFDLEVBQUUsR0FBRyxFQUFFLENBQUM7SUFDakIsQ0FBQztDQUNKO0FBTkQsa0NBTUMifQ==

package/dist/lib/voice/VoiceConnectionManager.d.ts

@@ -1,7 +0,0 @@
-import type VoiceConnection from "./VoiceConnection";
-import type Client from "../Client";
-import Collection from "../util/Collection";
-export default class VoiceConnectionManager extends Collection<string, VoiceConnection> {
-    #private;
-    constructor(client: Client);
-}

package/dist/lib/voice/VoiceConnectionManager.js

@@ -1,15 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const Collection_1 = __importDefault(require("../util/Collection"));
-class VoiceConnectionManager extends Collection_1.default {
-    #client;
-    constructor(client) {
-        super();
-        this.#client = client;
-    }
-}
-exports.default = VoiceConnectionManager;
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiVm9pY2VDb25uZWN0aW9uTWFuYWdlci5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uLy4uL2xpYi92b2ljZS9Wb2ljZUNvbm5lY3Rpb25NYW5hZ2VyLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7Ozs7O0FBRUEsb0VBQTRDO0FBRTVDLE1BQXFCLHNCQUF1QixTQUFRLG9CQUFtQztJQUNuRixPQUFPLENBQVM7SUFDaEIsWUFBWSxNQUFjO1FBQ3RCLEtBQUssRUFBRSxDQUFDO1FBQ1IsSUFBSSxDQUFDLE9BQU8sR0FBRyxNQUFNLENBQUM7SUFDMUIsQ0FBQztDQUNKO0FBTkQseUNBTUMifQ==