oceanic.js 0.0.12-dev.b566fc5 → 0.0.12-dev.bcdbabd

package/doc-test.js

@@ -0,0 +1,39 @@
+const { writeFileSync } = require("fs");
+
+writeFileSync(`${__dirname}/dark.js`, "\n\
+const { JSX } = require(\"typedoc\");\n\
+\n\
+// https://github.com/TypeStrong/typedoc/issues/1840#issuecomment-1012736455\n\
+exports.load = function load(app) {\n\
+	app.renderer.hooks.on(\"head.begin\", () => {\n\
+		return JSX.createElement(\"script\", null,\n\
+		JSX.createElement(JSX.Raw, { html: \"localStorage.setItem('tsd-theme', localStorage.getItem('tsd-theme') || 'dark')\" }));\n\
+	});\n\
+}");
+	// note for anyone changing this, this does not effect the docs on https://oceanic.owo-whats-thos.dev
+	// this only effects the test workflow - let Donovan know if something needs to change here
+writeFileSync(`${__dirname}/typedoc.json`, JSON.stringify({
+	name:        "Oceanic",
+	entryPoints: [
+		"lib/"
+	],
+	plugin: [
+		"typedoc-plugin-rename-defaults",
+		"typedoc-plugin-extras",
+		`${__dirname}/dark.js`
+	],
+	tsconfig:           "tsconfig.json",
+	entryPointStrategy: "expand",
+	excludePrivate:     true,
+	excludeProtected:   true,
+	githubPages:        false,
+	hideGenerator:      true,
+	gitRemote:          "origin",
+	readme:             "README.md",
+	out:                "docs",
+	exclude:            [
+		"lib/util/Properties.ts"
+	],
+	favicon: "favicon.ico"
+}));
+writeFileSync(`${__dirname}/favicon.ico`, Buffer.from("AAABAAEAIBUAAAEAIAD8CgAAFgAAACgAAAAgAAAAKgAAAAEAIAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAADcbAACZUCpKmVAqnplQKsyZUCrMmVAqnplQKkoYDxMAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAACZUCoemVAqwJlQKv+ZUCr/mVAq/5lQKv+ZUCr/mVAq/5lQKsCZUCoeAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAmVAqEJlQKuCZUCr/mVAq/5lQKv+ZUCr/mVAq/5lQKv+ZUCr/mVAq/5lQKuCZUCoQAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAACZUCqgmVAq/5lQKv+ZUCrRp2Mqcb6AK2q7fCtvmVAqiplQKvWZUCr/mVAq/5lQKqAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAmVAqFJlQKv2ZUCr/mVAqs9ebLIjaniz32p4s/9qeLP/anizYvX8raZlQKvSZUCr/mVAq/ZlQKhQAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAACZUCpSmVAq/5lQKvPSlSx22p4s9tqeLK3aniyZ2p4s3dqeLMXaniyPn1kqgplQKv+ZUCr/mVAqUgAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAJlQKmaZUCr/mVAqp9qeLKzaniwjAAAAAAAAAADbnisCmVAqiJlQKsCZUCpOmVAq/5lQKv+ZUCpmAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAmVAqUplQKv+ZUCqX2p4sSgAAAAAAAAAAAAAAAAAAAACZUCr/mVAq/5lQKraZUCr/mVAq/5lQKkQAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAACZUCoUmVAq/ZlQKqcDAwAAAAAAAAAAAAAAAAAAAAAAAJlQKrmZUCr/mVAq/plQKv+ZUCqoAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAACZUCqhmVAq75lQKgsAAAAAVzwLANqeLKXaniyxvn8rFZlQKmmZUCqTpmMqYtqeLDoAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAJlQKhGZUCrgmVAqigAAAADaniwk2p4s/9qeLP/aniym2p4s8dqeLNPanizg2p4sEQAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAJlQKh+ZUCrFmVAqadygKwDanizX2p4s/9qeLP/aniz/2p4sxtqeLB8AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAJpPLACZUCpPmVAqVMOGKxvanixs2p4sg9qeLEjani0AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAD///////////////////////gf///gB///wAP//8AD//+AAf//gAH//4MB//+Hgf//j4P//8YD///EA///4gf///gf//////////////////////8=", "base64"));

package/esm.mjs

@@ -83,7 +83,7 @@ export {
     ClientApplication,
     Constants,
     CommandInteraction,
-    Collection as TypedCollection,
+    Collection,
     ComponentInteraction,
     DiscordHTTPError,
     DiscordRESTError,

package/examples/applicationCommand.js

@@ -1,7 +1,7 @@
-// the application command management functions are on ClientApplication (client.application) & ApplicationCommands(client.rest.applicationCommands)
+// 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
-const { ApplicationCommandOptionTypes, ApplicationCommandTypes, Client } =  require("oceanic.js");
+const { ApplicationCommandOptionTypes, ApplicationCommandTypes, Client } = require("oceanic.js");
 
 const client = new Client({
     auth: "Bot [TOKEN]",
@@ -57,7 +57,7 @@ client.on("ready", async() => {
     await client.application.bulkEditGlobalCommands([
         {
             type: ApplicationCommandTypes.USER, // This will display in the `Apps` context menu, when clicking on a user.
-            // These commands do not have options, and cannot have a description. They will have a `target` property when recieved
+            // These commands do not have options, and cannot have a description. They will have a `target` property when received
             name: "User Info",
             nameLocalizations: {
                 "es-ES": "Información del usuario"
@@ -100,7 +100,7 @@ client.on("ready", async() => {
 
 // an error handler
 client.on("error", (error) => {
-    console.error("Something Went Wrong", error);
+    console.error("Something went wrong:", error);
 });
 
 // connect to Discord

package/examples/components.js

@@ -7,7 +7,7 @@ const client = new Client({
     }
 });
 
-client.on("ready", () => console.log("Ready As", client.user.tag));
+client.on("ready", () => console.log("Ready as", client.user.tag));
 
 client.on("messageCreate", async(msg) => {
     if(msg.content.includes("!component")) {
@@ -34,7 +34,7 @@ client.on("messageCreate", async(msg) => {
                         },
                         {
                             type: ComponentTypes.BUTTON,
-                            style: ButtonStyles.PRIMARY, 
+                            style: ButtonStyles.PRIMARY,
                             customID: "some-other-string",
                             label: "This Is Disabled",
                             disabled: true
@@ -42,7 +42,7 @@ client.on("messageCreate", async(msg) => {
                         {
                             // https://oceanic.owo-whats-this.dev/interfaces/types_channels.URLButton.html
                             type: ComponentTypes.BUTTON,
-                            style: ButtonStyles.LINK, 
+                            style: ButtonStyles.LINK,
                             label: "Open Link",
                             url: "https://oceanic.owo-whats-this.dev"
                         },
@@ -81,7 +81,7 @@ client.on("messageCreate", async(msg) => {
 
 // an error handler
 client.on("error", (error) => {
-    console.error("Something Went Wrong", error);
+    console.error("Something went wrong:", error);
 });
 
 // connect to Discord

package/examples/embeds.js

@@ -8,14 +8,13 @@ const client = new Client({
     }
 });
 
-
-client.on("ready", () => console.log("Ready As", client.user.tag));
+client.on("ready", () => console.log("Ready as", client.user.tag));
 
 client.on("messageCreate", async(msg) => {
     if(msg.content.includes("!embed")) {
-		// up to 10 in one message
 		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
 			embeds: [
 				{
 					// https://oceanic.owo-whats-this.dev/interfaces/types_channels.EmbedAuthorOptions.html
@@ -85,7 +84,7 @@ client.on("messageCreate", async(msg) => {
 
 // an error handler
 client.on("error", (error) => {
-    console.error("Something Went Wrong", error);
+    console.error("Something went wrong:", error);
 });
 
 // connect to Discord

package/examples/intents.js

@@ -6,35 +6,33 @@ const client = new Client({
     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/interfaces/types_client.ClientEvents.html
-        intents: ["GUILDS", "GUILD_MESSAGES", "MESSAGE_CONTENT"] 
+        // 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.
     }
 });
 
-
-client.on("ready", () => console.log("Ready As", client.user.tag));
-
+client.on("ready", () => console.log("Ready as", client.user.tag));
 
 // an error handler
 client.on("error", (error) => {
-    console.error("Something Went Wrong", error);
+    console.error("Something went wrong:", error);
 });
 
 // New Guild Joined
-// https://oceanic.owo-whats-this.dev/interfaces/types_client.ClientEvents.html#guildCreate
-bot.on("guildCreate", (guild) => { 
+// https://oceanic.owo-whats-this.dev/dev/interfaces/types_events.ClientEvents.html#guildCreate
+bot.on("guildCreate", (guild) => {
     console.log("Guild Joined:", guild.name);
 });
 
 // Message Sent
-// https://oceanic.owo-whats-this.dev/interfaces/types_client.ClientEvents.html#messageCreate
+// https://oceanic.owo-whats-this.dev/dev/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/interfaces/types_client.ClientEvents.html#typingStart
+// 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}`);
 });

package/package.json

@@ -1,10 +1,10 @@
 {
   "name": "oceanic.js",
-  "version": "0.0.12-dev.b566fc5",
-  "description": "A nodejs library for interfacing with Discord.",
-  "main": "dist/lib/index.js",
-  "types": "dist/lib/index.d.ts",
-  "module": "esm.mjs",
+  "version": "0.0.12-dev.bcdbabd",
+  "description": "A NodeJS library for interfacing with Discord.",
+  "main": "./dist/lib/index.js",
+  "types": "./dist/lib/index.d.ts",
+  "module": "./esm.mjs",
   "exports": {
     ".": {
       "types": "./dist/lib/index.d.ts",
@@ -28,6 +28,9 @@
     "api"
   ],
   "author": "Donovan Daniels <hewwo@yiff.rocks>",
+  "contributors": [
+    "Nuckyz (https://github.com/Nuckyz)"
+  ],
   "license": "MIT",
   "bugs": {
     "url": "https://github.com/OceanicJS/Oceanic/issues"
@@ -55,10 +58,5 @@
   },
   "engines": {
     "node": ">=16.16.0"
-  },
-  "optionalDependencies": {
-    "erlpack": "^0.1.4",
-    "pako": "^2.0.4",
-    "zlib-sync": "^0.1.7"
   }
 }