donovandmc / oceanic

A NodeJS library for interfacing with Discord.

const { Client } = require("oceanic.js");
const client = new Client({ auth: "Bot [TOKEN]" });

client.on("ready", async() => {
    console.log("Ready as", client.user.tag);
});

// if you do not add a listener for the error event, any errors will cause an UncaughtError to be thrown,
// and your process may be killed as a result.
client.on("error", (err) => {
    console.error("Something Broke!", err);
});

client.connect();

For more examples, see the examples folder on GitHub.

---

Installation

NodeJS 18.13.0 or higher is required.

See Development Builds if you wish to install in-dev versions.

npm i oceanic.js --omit=optional

If you need voice support, add --include=optional. Voice support is currently provided by @discordjs/voice.

See the examples folder on GitHub for some examples, and visit this site for documentation.

Development Builds

npm i oceanic.js@dev

The documentation under dev is always for the latest commit. If something isn't working that's in the documentation, you're likely looking at the wrong documentation.

---

Optional Dependencies

• pako - Compression (gateway)
• zlib-sync - Compression (gateway, faster than pako)
• erlpack - Encoding (gateway, alternative to JSON)

Links

• Examples
• Latest Release Documentation
• Development Documentation
• Discord Server
• Source

oceanic's Issues

is it working with accounts?

            throw new TypeError("Failed to get gateway information.", { cause: err });```

copy paste the example cod and but the token and nothing

"data.map is not a function" when using REST/Channels.getPollAnswerUsers method

Hello 👋
While I was testing the version 1.10.0 to see which users voted the answers from a poll, I used this code

const data = await client.rest.channels.getPollAnswerUsers(
  "CHANNEL_ID",
  "MESSAGE_ID",
  1
);

But when I was executing that code, I saw this error

TypeError: data.map is not a function

I did a custom request to see what was the response, so I used this code

const data = await client.rest.authRequest({
  method: "GET",
  path: "/channels/CHANNEL_ID/polls/MESSAGE_ID/answers/1",
});

{
  users: [
    // Discord API User Objects
  ]
}

So, from this line

Oceanic/lib/routes/Channels.ts

Line 825 in f5123ca

const users = data.map(user => this.#manager.client.users.update(user));

I think it should be changed to this due to response body being an object with an array of users inside

const users = data.users.map(user => this.#manager.client.users.update(user));

Thanks for reading

Unable to nullify content when editing a message or an interaction response

Current Behaviour:

When attempting to edit the original reply to an interaction using CommandInteraction.editOriginal(), the content field of InteractionContent must be of type string or undefined.

This field is inherited from the InteractionContent interface, which extends ExecuteWebhookOptions, which extends CreateMessageOptions.

According to https://discord.com/developers/docs/resources/channel#edit-message "All parameters to this endpoint are optional and nullable.". When nulling the content field, Discord will remove the content from the original message.

Expected Behaviour:

Allowed to pass null as content when editing a message or interaction, to remove content from the message. This is useful when deferring an interaction, and editing the original response to be an embed or an attachment.

Additional Info:

Version: 1.10.0

Random error from Oceanic.js

/home/container/node_modules/oceanic.js/dist/lib/structures/Message.js:125
        if (data.attachments.length !== 0) {
                             ^

TypeError: Cannot read properties of undefined (reading 'length')
    at new Message (/home/container/node_modules/oceanic.js/dist/lib/structures/Message.js:125:30)
    at TypedCollection.update (/home/container/node_modules/oceanic.js/dist/lib/util/TypedCollection.js:54:29)
    at Shard.onDispatch (/home/container/node_modules/oceanic.js/dist/lib/gateway/Shard.js:715:52)
    at Shard.onPacket (/home/container/node_modules/oceanic.js/dist/lib/gateway/Shard.js:1055:27)
    at Shard.onWSMessage (/home/container/node_modules/oceanic.js/dist/lib/gateway/Shard.js:1243:29)
    at WebSocket.emit (node:events:513:28)
    at Receiver.receiverOnMessage (/home/container/node_modules/ws/lib/websocket.js:1184:20)
    at Receiver.emit (node:events:513:28)
    at Receiver.dataMessage (/home/container/node_modules/ws/lib/receiver.js:541:14)
    at Receiver.getData (/home/container/node_modules/ws/lib/receiver.js:459:17)

Node.js v19.9.0

Using Oceanic 1.7.1
It's erroring very randomly but often.

Second parameter is required for the threadUpdate event

SequentialBucket can get stuck processing the queue

See esmBot/esmBot#383. There's a chance that a SequentialBucket instance can have the processing value set to true and never be reset to false, causing all requests sent to an attached endpoint to never be sent. I haven't checked the queue itself in the SequentialBucket since it's private, but it's probably worth looking to see if it gets hung up somehow.

Already exported a member named 'Activity'. Consider explicitly re-exporting to resolve the ambiguity.

Hi, when I run my bot (typescript) I get this error from your package:

node_modules/oceanic.js/dist/lib/types/index.d.ts:9:1 - error TS2308: Module "./gateway" has already exported a member named 'Activity'. Consider explicitly re-exporting to resolve the ambiguity.

9 export * from "./guilds";
  ~~~~~~~~~~~~~~~~~~~~~~~~~


Found 1 error in node_modules/oceanic.js/dist/lib/types/index.d.ts:9

Add es-419

Quite useless and no one cares, but it would be nice

Voice Support

VoiceState and embeds parsing

VoiceState#channel is always null/uncached when the bot is started

Announcement/public thread channels can sometimes cause GUILD_CREATE handler to fail

I occasionally see this error pop up in logs when starting my bot. Running it standalone results in a crash, but running it in PM2 causes it to keep running after this:

TypeError: Cannot read properties of undefined (reading 'archive_timestamp')
    at new ThreadChannel (/home/esmBot/esmBot/node_modules/.pnpm/[email protected][email protected]/node_modules/oceanic.js/dist/lib/structures/ThreadChannel.js:46:61)
    at new AnnouncementThreadChannel (/home/esmBot/esmBot/node_modules/.pnpm/[email protected][email protected]/node_modules/oceanic.js/dist/lib/structures/AnnouncementThreadChannel.js:9:9)
    at Map.update (/home/esmBot/esmBot/node_modules/.pnpm/[email protected][email protected]/node_modules/oceanic.js/dist/lib/util/TypedCollection.js:54:29)
    at new Guild (/home/esmBot/esmBot/node_modules/.pnpm/[email protected][email protected]/node_modules/oceanic.js/dist/lib/structures/Guild.js:214:37)
    at Map.update (/home/esmBot/esmBot/node_modules/.pnpm/[email protected][email protected]/node_modules/oceanic.js/dist/lib/util/TypedCollection.js:54:29)
    at Shard.createGuild (/home/esmBot/esmBot/node_modules/.pnpm/[email protected][email protected]/node_modules/oceanic.js/dist/lib/gateway/Shard.js:146:42)
    at Shard.onDispatch (/home/esmBot/esmBot/node_modules/.pnpm/[email protected][email protected]/node_modules/oceanic.js/dist/lib/gateway/Shard.js:300:40)
    at Shard.onPacket (/home/esmBot/esmBot/node_modules/.pnpm/[email protected][email protected]/node_modules/oceanic.js/dist/lib/gateway/Shard.js:1044:27)
    at Shard.onWSMessage (/home/esmBot/esmBot/node_modules/.pnpm/[email protected][email protected]/node_modules/oceanic.js/dist/lib/gateway/Shard.js:1229:29)
    at WebSocket.emit (node:events:513:28)

Since it seems to mostly occur on startup before the ready event, I'd imagine that it might be due to some missing/uncached data. After some attempts to debug the issue, it seems like a PublicThreadChannel is being passed into the data field of the ThreadChannel constructor. Will keep looking into this.

Unable to suppress embeds with Message.edit due to inheriting other properties.

To suppress embeds, the API only wants flags. Channels.editMessage inherits allowed_mentions, attachments, content and files.

Process errors when trying to access CommandInteraction#guild when app is not installed in that guild

Current Behaviour:

When attempting to access CommandInteraction#guild, if the app is not installed in that guild, you will receive the following error:

UncachedError: CommandInteraction#guild is not present if you don't have the GUILDS intent.

This error is even received when simply logging the interaction console.log(interaction).

Expected Behaviour:

CommandInteraction#guild will be null and will not error when the app is not installed and the current context is 0 (Guild).

What about builders

It would be cool to use them instead of objects

Name Localizations are not registered in "choices"

If a command with an option that has the "choices" property with the "nameLocalizations" property, the locations are not registered correctly

The properties of "choices" should be passed to "raw" instead of registering it as is

Oceanic/lib/util/Util.ts

Line 481 in e86de31

choices: opt.choices,

Follow standard naming conventions of properties for creating messages

Its annoying to have to figure out that things like icon_url are named as iconURL