revbot.js 0.1.9 → 0.1.10

package/README.md

@@ -1,133 +1,156 @@
-# revbot.js
-
-# Note: this package is currently in the early stages of development and testing
-
-`revbot.js` is a Node.js library for building bots on the Revolt platform. It provides an easy-to-use interface for interacting with Revolt's API, managing events, and handling various bot functionalities. NOTE: node 21 is required to run this
-[revolt server](https://rvlt.gg/2NcCgYZ0) [docs](https://jade3375.github.io/revbot.js/)
-
-## Installation
-
-```bash
-npm install revbot.js
-```
-
-or
-
-```bash
-yarn add revbot.js
-```
-
-## Basic Setup
-
-Below is an example of how to set up a basic bot using `revbot.js`:
-
-### Example Code
-
-```ts
-import { client } from "revbot.js";
-
-const bot = new client({});
-
-bot.on("ready", () => {
-  console.log("Bot is ready!");
-});
-
-bot.on("message", (message) => {
-  if (message.content === "ping") {
-    message.reply("pong");
-  }
-});
-
-bot.login("YOUR_BOT_TOKEN");
-```
-
-## Features
-
-- Event-based architecture for handling messages, server updates, and more.
-- Easy-to-use managers for channels, servers, users, and roles.
-
-## Development
-
-To contribute or modify the library:
-
-1. Clone the repository:
-
-   ```bash
-   git clone https://github.com/Jade3375/revbot.js.git
-   cd revbot.js
-   ```
-
-2. Install dependencies:
-
-   ```bash
-   yarn install
-   ```
-
-3. Build the project:
-
-   ```bash
-   yarn build
-   ```
-
-## Contribution
-
-We welcome contributions to `revbot.js`! To contribute, follow these steps:
-
-1. **Fork the Repository**  
-   Go to the [repository](https://github.com/Jade3375/revbot.js) and click the "Fork" button to create your own copy.
-
-2. **Clone Your Fork**  
-   Clone your forked repository to your local machine:
-
-   ```bash
-   git clone https://github.com/your-username/revbot.js
-   cd revbot.js
-   ```
-
-3. **Create a Branch**  
-   Create a new branch for your feature or bug fix:
-
-   ```bash
-   git checkout -b feature-or-bugfix-name
-   ```
-
-4. **Make Changes**  
-   Implement your changes or fixes in the codebase.
-
-5. **Test Your Changes**  
-   Ensure your changes work as expected by running the project and any relevant tests:
-
-   ```bash
-   yarn test
-   ```
-
-6. **Commit Your Changes**  
-   Commit your changes with a descriptive message:
-
-   ```bash
-   git add .
-   git commit -m "Description of your changes"
-   ```
-
-7. **Push Your Branch**  
-   Push your branch to your forked repository:
-
-   ```bash
-   git push origin feature-or-bugfix-name
-   ```
-
-8. **Open a Pull Request**  
-   Go to the original repository and open a pull request from your branch. Provide a clear description of your changes and why they should be merged.
-
-### Guidelines
-
-- Follow the existing code style and structure.
-- Write clear and concise commit messages.
-- Add or update documentation if necessary.
-- Ensure your changes do not break existing functionality.
-
-Thank you for contributing to `revbot.js`!
-
-## License
-
-This project is licensed under the MIT License.
+# revbot.js
+
+# Note: this package is currently in the early stages of development and testing
+
+`revbot.js` is a Node.js library for building bots on the Revolt platform. It provides an easy-to-use interface for interacting with Revolt's API, managing events, and handling various bot functionalities. NOTE: node 21 is required to run this
+[revolt server](https://rvlt.gg/2NcCgYZ0) [docs](https://jade3375.github.io/revbot.js/)
+
+## Installation
+
+```bash
+npm install revbot.js
+```
+
+or
+
+```bash
+yarn add revbot.js
+```
+
+## Basic Setup
+
+Below is an example of how to set up a basic bot using `revbot.js`:
+
+### Example Code
+
+### typescript
+
+```ts
+import { client, MessageStruct } from "revbot.js";
+
+const bot = new client({});
+
+bot.on("ready", () => {
+  console.log("Bot is ready!");
+});
+
+bot.on("message", (message: MessageStruct) => {
+  if (message.content === "ping") {
+    message.reply("pong");
+  }
+});
+
+bot.login("YOUR_BOT_TOKEN");
+```
+
+### javascript
+
+```js
+const { client } = require("revbot.js");
+
+const bot = new client({});
+
+bot.on("ready", () => {
+  console.log("Bot is ready!");
+});
+
+bot.on("message", (message) => {
+  if (message.content === "ping") {
+    message.reply("pong");
+  }
+});
+
+bot.login("YOUR_BOT_TOKEN");
+```
+
+## Features
+
+- Event-based architecture for handling messages, server updates, and more.
+- Easy-to-use managers for channels, servers, users, and roles.
+- Experimental support for 3rd party instances using backend version 0.7 +
+
+## Development
+
+To contribute or modify the library:
+
+1. Clone the repository:
+
+   ```bash
+   git clone https://github.com/Jade3375/revbot.js.git
+   cd revbot.js
+   ```
+
+2. Install dependencies:
+
+   ```bash
+   yarn install
+   ```
+
+3. Build the project:
+
+   ```bash
+   yarn build
+   ```
+
+## Contribution
+
+We welcome contributions to `revbot.js`! To contribute, follow these steps:
+
+1. **Fork the Repository**  
+   Go to the [repository](https://github.com/Jade3375/revbot.js) and click the "Fork" button to create your own copy.
+
+2. **Clone Your Fork**  
+   Clone your forked repository to your local machine:
+
+   ```bash
+   git clone https://github.com/your-username/revbot.js
+   cd revbot.js
+   ```
+
+3. **Create a Branch**  
+   Create a new branch for your feature or bug fix:
+
+   ```bash
+   git checkout -b feature-or-bugfix-name
+   ```
+
+4. **Make Changes**  
+   Implement your changes or fixes in the codebase.
+
+5. **Test Your Changes**  
+   Ensure your changes work as expected by running the project and any relevant tests:
+
+   ```bash
+   yarn test
+   ```
+
+6. **Commit Your Changes**  
+   Commit your changes with a descriptive message:
+
+   ```bash
+   git add .
+   git commit -m "Description of your changes"
+   ```
+
+7. **Push Your Branch**  
+   Push your branch to your forked repository:
+
+   ```bash
+   git push origin feature-or-bugfix-name
+   ```
+
+8. **Open a Pull Request**  
+   Go to the original repository and open a pull request from your branch. Provide a clear description of your changes and why they should be merged.
+
+### Guidelines
+
+- Follow the existing code style and structure.
+- Write clear and concise commit messages.
+- Add or update documentation if necessary.
+- Ensure your changes do not break existing functionality.
+
+Thank you for contributing to `revbot.js`!
+
+## License
+
+This project is licensed under the MIT License.

package/dist/index.d.mts

@@ -72,6 +72,9 @@ declare class UUID extends null {
     static timestampOf(id: string): Date;
 }
 
+/** A type that can be a BitField, number, string, or an array of these types.
+ * @private
+ */
 type BitFieldResolvable = BitField | number | string | BitFieldResolvable[];
 /**
  * Represents a bitfield that can be used to manage flags or permissions.
@@ -355,6 +358,7 @@ declare abstract class BaseClient extends EventEmitter {
 
 /**
  * Enum representing the client events that can be emitted.
+ * @private
  */
 declare enum Events {
     CHANNEL_CREATE = "channelCreate",
@@ -387,6 +391,7 @@ declare enum Events {
 }
 /**
  * Enum representing the WebSocket events used for communication.
+ * @private
  */
 declare enum WSEvents {
     AUTHENTICATE = "Authenticate",
@@ -1668,6 +1673,10 @@ declare class NotesChannel extends Channel implements TextBasedChannel {
     get user(): User;
 }
 
+/**
+ * Represents a channel in the API.
+ * @private
+ */
 type APIServerChannel = Extract<Channel$1, {
     channel_type: "TextChannel" | "VoiceChannel";
 }>;
@@ -1690,6 +1699,8 @@ declare class ServerChannel extends Channel {
     description: string | null;
     /** The icon of the channel, or `null` if none is set. */
     icon: Attachment | null;
+    /** Manages the messages in this Server channel. */
+    messages: MessageManager;
     /** The permission overwrites for the channel. */
     overwrites: Map<string, Overwrite>;
     /** Whether the channel is marked as NSFW (Not Safe For Work). */
@@ -1728,6 +1739,18 @@ declare class ServerChannel extends Channel {
      * @returns {Server} The server instance.
      */
     get server(): Server;
+    /**
+     * Sends a message to this Server channel.
+     *
+     * @param {MessageOptions | string} options - The message content or options for the message.
+     * @returns {Promise<Message>} A promise that resolves with the sent message.
+     *
+     * @example
+     * ```typescript
+     * await serverChannel.send("Hello, world!");
+     * ```
+     */
+    send(options: MessageOptions | string): Promise<MessageStruct>;
     /**
      * Retrieves the category this channel belongs to, if any.
      *

package/dist/index.d.ts

@@ -72,6 +72,9 @@ declare class UUID extends null {
     static timestampOf(id: string): Date;
 }
 
+/** A type that can be a BitField, number, string, or an array of these types.
+ * @private
+ */
 type BitFieldResolvable = BitField | number | string | BitFieldResolvable[];
 /**
  * Represents a bitfield that can be used to manage flags or permissions.
@@ -355,6 +358,7 @@ declare abstract class BaseClient extends EventEmitter {
 
 /**
  * Enum representing the client events that can be emitted.
+ * @private
  */
 declare enum Events {
     CHANNEL_CREATE = "channelCreate",
@@ -387,6 +391,7 @@ declare enum Events {
 }
 /**
  * Enum representing the WebSocket events used for communication.
+ * @private
  */
 declare enum WSEvents {
     AUTHENTICATE = "Authenticate",
@@ -1668,6 +1673,10 @@ declare class NotesChannel extends Channel implements TextBasedChannel {
     get user(): User;
 }
 
+/**
+ * Represents a channel in the API.
+ * @private
+ */
 type APIServerChannel = Extract<Channel$1, {
     channel_type: "TextChannel" | "VoiceChannel";
 }>;
@@ -1690,6 +1699,8 @@ declare class ServerChannel extends Channel {
     description: string | null;
     /** The icon of the channel, or `null` if none is set. */
     icon: Attachment | null;
+    /** Manages the messages in this Server channel. */
+    messages: MessageManager;
     /** The permission overwrites for the channel. */
     overwrites: Map<string, Overwrite>;
     /** Whether the channel is marked as NSFW (Not Safe For Work). */
@@ -1728,6 +1739,18 @@ declare class ServerChannel extends Channel {
      * @returns {Server} The server instance.
      */
     get server(): Server;
+    /**
+     * Sends a message to this Server channel.
+     *
+     * @param {MessageOptions | string} options - The message content or options for the message.
+     * @returns {Promise<Message>} A promise that resolves with the sent message.
+     *
+     * @example
+     * ```typescript
+     * await serverChannel.send("Hello, world!");
+     * ```
+     */
+    send(options: MessageOptions | string): Promise<MessageStruct>;
     /**
      * Retrieves the category this channel belongs to, if any.
      *

package/dist/index.js

@@ -2101,6 +2101,8 @@ var ServerChannel = class extends Channel {
     this.description = null;
     /** The icon of the channel, or `null` if none is set. */
     this.icon = null;
+    /** Manages the messages in this Server channel. */
+    this.messages = new MessageManager(this);
     /** The permission overwrites for the channel. */
     this.overwrites = /* @__PURE__ */ new Map();
     /** Whether the channel is marked as NSFW (Not Safe For Work). */
@@ -2171,6 +2173,20 @@ var ServerChannel = class extends Channel {
   get server() {
     return this.client.servers.cache.get(this.serverId);
   }
+  /**
+   * Sends a message to this Server channel.
+   *
+   * @param {MessageOptions | string} options - The message content or options for the message.
+   * @returns {Promise<Message>} A promise that resolves with the sent message.
+   *
+   * @example
+   * ```typescript
+   * await serverChannel.send("Hello, world!");
+   * ```
+   */
+  send(options) {
+    return this.messages.send(options);
+  }
   /**
    * Retrieves the category this channel belongs to, if any.
    *
@@ -3292,7 +3308,7 @@ var import_node_events = require("events");
 var import_axios4 = require("axios");
 
 // package.json
-var version = "0.1.8";
+var version = "0.1.10";
 
 // src/rest/restUtils/rateLimitQueue.ts
 var import_axios3 = __toESM(require("axios"));
@@ -4428,21 +4444,21 @@ var WebSocketClient = class {
               this.client.users._add(user);
             }
           }
-          for (const server of packet.servers) {
-            const s = this.client.servers._add(server);
-            if (this.client.options.fetchMembers) {
-              promises.push(s.members.fetch());
-            }
-          }
-          for (const channel of packet.channels) {
-            this.client.channels._add(channel);
-          }
           for (const member of packet.members) {
             (_a = this.client.servers.cache.get(member._id.server)) == null ? void 0 : _a.members._add(member);
           }
           for (const emoji of packet.emojis) {
             (_b = this.client.servers.cache.get(emoji.parent.id)) == null ? void 0 : _b.emojis.set(emoji._id, __spreadProps(__spreadValues({}, emoji), { _id: emoji._id }));
           }
+          for (const channel of packet.channels) {
+            this.client.channels._add(channel);
+          }
+          for (const server of packet.servers) {
+            const s = this.client.servers._add(server);
+            if (this.client.options.fetchMembers) {
+              promises.push(s.members.fetch());
+            }
+          }
           this.setHeartbeatTimer(
             (_d = (_c = this.client.options.ws) == null ? void 0 : _c.heartbeatInterval) != null ? _d : 3e4
           );