revbot.js 0.1.9 → 0.2.0

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.
@@ -135,6 +138,7 @@ declare class RestClient {
      * @returns The API response.
      */
     private request;
+    getConfig(): Promise<void>;
     private retryRequest;
     /**
      * GET request.
@@ -355,6 +359,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 +392,7 @@ declare enum Events {
 }
 /**
  * Enum representing the WebSocket events used for communication.
+ * @private
  */
 declare enum WSEvents {
     AUTHENTICATE = "Authenticate",
@@ -434,12 +440,8 @@ declare enum ChannelTypes {
  * The default options for configuring the client.
  */
 declare const DEFAULT_CLIENT_OPTIONS: clientOptions;
-/** The WebSocket URL for connecting to the Revolt API. */
-declare const wsUrl = "wss://ws.revolt.chat?version=1&format=json";
-/** The base API URL for interacting with the Revolt API. */
-declare const apiUrl = "https://api.revolt.chat";
-/** The base URL for the Revolt CDN, used for serving static assets. */
-declare const cdnUrl = "https://cdn.revoltusercontent.com";
+/** The base API URL for interacting with the Stoat API. */
+declare const apiUrl = "https://api.stoat.chat";
 /** The system user ID used for identifying system messages. */
 declare const SYSTEM_USER_ID: string;
 
@@ -1668,6 +1670,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 +1696,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 +1736,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.
      *
@@ -2275,6 +2295,11 @@ declare class client extends BaseClient {
     user: ClientUser | null;
     /** The timestamp when the client became ready, or `null` if not ready. */
     readyAt: Date | null;
+    /**
+     * Initializes the client.
+     * @private
+     */
+    init(): Promise<void>;
     /**
      * Gets the timestamp when the client became ready.
      *
@@ -2677,4 +2702,4 @@ declare class ServerMemberManager extends BaseManager<ServerMember, Member> {
     resolveId(member: ServerMemberResolvable): string | null;
 }
 
-export { Attachment, type BadgeString, Badges, type BadgesResolvable, Base, BaseManager, BitField, type BitFieldResolvable, Category, Channel, ChannelManager, ChannelPermissions, type ChannelPermissionsResolvable, type ChannelPermissionsString, type ChannelResolvable, ChannelTypes, type CreateChannelOptions, DEFAULT_CLIENT_OPTIONS, DEFAULT_PERMISSION_DM, DMChannel, type EditServerMemberOptions, type EditServerOptions, type Embed, type EmbedImage, type EmbedSpecial, type EmbedVideo, Emoji, Events, FullPermissions, GroupChannel, Invite, Mentions, type MessageEditOptions, MessageEmbed, MessageManager, type MessageOptions, type MessageQueryOptions, type MessageReply, type MessageResolvable, type MessageSearchOptions, MessageStruct, NotesChannel, type Overwrite, type PartialObject, Presence, Role, RoleManager, type RoleResolvable, SYSTEM_USER_ID, Server, ServerChannel, ServerChannelManager, type ServerChannelResolvable, ServerManager, ServerMember, ServerMemberManager, type ServerMemberResolvable, ServerPermissions, type ServerPermissionsResolvable, type ServerPermissionsString, type ServerResolvable, Status, TextChannel, UUID, User, UserManager, UserPermissions, type UserPermissionsResolvable, type UserPermissionsString, type UserResolvable, VoiceChannel, WSEvents, apiUrl, cdnUrl, client, wsUrl };
+export { Attachment, type BadgeString, Badges, type BadgesResolvable, Base, BaseManager, BitField, type BitFieldResolvable, Category, Channel, ChannelManager, ChannelPermissions, type ChannelPermissionsResolvable, type ChannelPermissionsString, type ChannelResolvable, ChannelTypes, type CreateChannelOptions, DEFAULT_CLIENT_OPTIONS, DEFAULT_PERMISSION_DM, DMChannel, type EditServerMemberOptions, type EditServerOptions, type Embed, type EmbedImage, type EmbedSpecial, type EmbedVideo, Emoji, Events, FullPermissions, GroupChannel, Invite, Mentions, type MessageEditOptions, MessageEmbed, MessageManager, type MessageOptions, type MessageQueryOptions, type MessageReply, type MessageResolvable, type MessageSearchOptions, MessageStruct, NotesChannel, type Overwrite, type PartialObject, Presence, Role, RoleManager, type RoleResolvable, SYSTEM_USER_ID, Server, ServerChannel, ServerChannelManager, type ServerChannelResolvable, ServerManager, ServerMember, ServerMemberManager, type ServerMemberResolvable, ServerPermissions, type ServerPermissionsResolvable, type ServerPermissionsString, type ServerResolvable, Status, TextChannel, UUID, User, UserManager, UserPermissions, type UserPermissionsResolvable, type UserPermissionsString, type UserResolvable, VoiceChannel, WSEvents, apiUrl, client };

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.
@@ -135,6 +138,7 @@ declare class RestClient {
      * @returns The API response.
      */
     private request;
+    getConfig(): Promise<void>;
     private retryRequest;
     /**
      * GET request.
@@ -355,6 +359,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 +392,7 @@ declare enum Events {
 }
 /**
  * Enum representing the WebSocket events used for communication.
+ * @private
  */
 declare enum WSEvents {
     AUTHENTICATE = "Authenticate",
@@ -434,12 +440,8 @@ declare enum ChannelTypes {
  * The default options for configuring the client.
  */
 declare const DEFAULT_CLIENT_OPTIONS: clientOptions;
-/** The WebSocket URL for connecting to the Revolt API. */
-declare const wsUrl = "wss://ws.revolt.chat?version=1&format=json";
-/** The base API URL for interacting with the Revolt API. */
-declare const apiUrl = "https://api.revolt.chat";
-/** The base URL for the Revolt CDN, used for serving static assets. */
-declare const cdnUrl = "https://cdn.revoltusercontent.com";
+/** The base API URL for interacting with the Stoat API. */
+declare const apiUrl = "https://api.stoat.chat";
 /** The system user ID used for identifying system messages. */
 declare const SYSTEM_USER_ID: string;
 
@@ -1668,6 +1670,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 +1696,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 +1736,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.
      *
@@ -2275,6 +2295,11 @@ declare class client extends BaseClient {
     user: ClientUser | null;
     /** The timestamp when the client became ready, or `null` if not ready. */
     readyAt: Date | null;
+    /**
+     * Initializes the client.
+     * @private
+     */
+    init(): Promise<void>;
     /**
      * Gets the timestamp when the client became ready.
      *
@@ -2677,4 +2702,4 @@ declare class ServerMemberManager extends BaseManager<ServerMember, Member> {
     resolveId(member: ServerMemberResolvable): string | null;
 }
 
-export { Attachment, type BadgeString, Badges, type BadgesResolvable, Base, BaseManager, BitField, type BitFieldResolvable, Category, Channel, ChannelManager, ChannelPermissions, type ChannelPermissionsResolvable, type ChannelPermissionsString, type ChannelResolvable, ChannelTypes, type CreateChannelOptions, DEFAULT_CLIENT_OPTIONS, DEFAULT_PERMISSION_DM, DMChannel, type EditServerMemberOptions, type EditServerOptions, type Embed, type EmbedImage, type EmbedSpecial, type EmbedVideo, Emoji, Events, FullPermissions, GroupChannel, Invite, Mentions, type MessageEditOptions, MessageEmbed, MessageManager, type MessageOptions, type MessageQueryOptions, type MessageReply, type MessageResolvable, type MessageSearchOptions, MessageStruct, NotesChannel, type Overwrite, type PartialObject, Presence, Role, RoleManager, type RoleResolvable, SYSTEM_USER_ID, Server, ServerChannel, ServerChannelManager, type ServerChannelResolvable, ServerManager, ServerMember, ServerMemberManager, type ServerMemberResolvable, ServerPermissions, type ServerPermissionsResolvable, type ServerPermissionsString, type ServerResolvable, Status, TextChannel, UUID, User, UserManager, UserPermissions, type UserPermissionsResolvable, type UserPermissionsString, type UserResolvable, VoiceChannel, WSEvents, apiUrl, cdnUrl, client, wsUrl };
+export { Attachment, type BadgeString, Badges, type BadgesResolvable, Base, BaseManager, BitField, type BitFieldResolvable, Category, Channel, ChannelManager, ChannelPermissions, type ChannelPermissionsResolvable, type ChannelPermissionsString, type ChannelResolvable, ChannelTypes, type CreateChannelOptions, DEFAULT_CLIENT_OPTIONS, DEFAULT_PERMISSION_DM, DMChannel, type EditServerMemberOptions, type EditServerOptions, type Embed, type EmbedImage, type EmbedSpecial, type EmbedVideo, Emoji, Events, FullPermissions, GroupChannel, Invite, Mentions, type MessageEditOptions, MessageEmbed, MessageManager, type MessageOptions, type MessageQueryOptions, type MessageReply, type MessageResolvable, type MessageSearchOptions, MessageStruct, NotesChannel, type Overwrite, type PartialObject, Presence, Role, RoleManager, type RoleResolvable, SYSTEM_USER_ID, Server, ServerChannel, ServerChannelManager, type ServerChannelResolvable, ServerManager, ServerMember, ServerMemberManager, type ServerMemberResolvable, ServerPermissions, type ServerPermissionsResolvable, type ServerPermissionsString, type ServerResolvable, Status, TextChannel, UUID, User, UserManager, UserPermissions, type UserPermissionsResolvable, type UserPermissionsString, type UserResolvable, VoiceChannel, WSEvents, apiUrl, client };