revbot.js 0.1.8 → 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.
@@ -194,7 +197,6 @@ declare class CDNClient {
      * POST request.
      * @param url The URL for the request.
      * @param data The request body.
-     * @param query Query parameters (if applicable).
      * @returns The API response.
      */
     post<T>(url: string, data: FormData): Promise<T>;
@@ -356,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",
@@ -388,6 +391,7 @@ declare enum Events {
 }
 /**
  * Enum representing the WebSocket events used for communication.
+ * @private
  */
 declare enum WSEvents {
     AUTHENTICATE = "Authenticate",
@@ -1669,9 +1673,14 @@ declare class NotesChannel extends Channel implements TextBasedChannel {
     get user(): User;
 }
 
-type APIServerChannel$1 = Extract<Channel$1, {
+/**
+ * Represents a channel in the API.
+ * @private
+ */
+type APIServerChannel = Extract<Channel$1, {
     channel_type: "TextChannel" | "VoiceChannel";
 }>;
+
 interface Overwrite {
     allow: FullPermissions;
     deny: FullPermissions;
@@ -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). */
@@ -1700,7 +1711,7 @@ declare class ServerChannel extends Channel {
      * @param {client} client - The client instance.
      * @param {APIServerChannel} data - The raw data for the server channel from the API.
      */
-    constructor(client: client, data: APIServerChannel$1);
+    constructor(client: client, data: APIServerChannel);
     /**
      * Updates the server channel instance with new data from the API.
      *
@@ -1709,7 +1720,7 @@ declare class ServerChannel extends Channel {
      * @returns {this} The updated server channel instance.
      * @protected
      */
-    protected _patch(data: APIServerChannel$1, clear?: FieldsChannel[]): this;
+    protected _patch(data: APIServerChannel, clear?: FieldsChannel[]): this;
     /**
      * Creates an invite for the server channel.
      *
@@ -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.
      *
@@ -2033,6 +2056,7 @@ declare class Emoji extends Base {
 
 type UserResolvable = User | User$1 | MessageStruct | string;
 declare class UserManager extends BaseManager<User, User$1> {
+    /** @private */
     holds: typeof User;
     /**
      *
@@ -2081,10 +2105,12 @@ declare class ClientUser extends User {
      * ```
      */
     setUsername(username: string, password?: string): Promise<void>;
+    setStatus(text?: string | null): Promise<void>;
+    setStatus(presence?: Status): Promise<void>;
     /**
      * Updates the status of the client user.
      *
-     * @param {string | null} text - The status text to set, or `null` to clear the status.
+     * @param {string | null} [text] - The status text to set, or `null` to clear the status.
      * @param {Status} [presence] - The presence status (e.g., online, idle, etc.).
      * @returns {Promise<void>} A promise that resolves when the status has been successfully updated.
      *
@@ -2093,14 +2119,13 @@ declare class ClientUser extends User {
      * await clientUser.setStatus("Available", "Online");
      * ```
      */
-    setStatus(text?: string | null): Promise<void>;
-    setStatus(presence?: Status): Promise<void>;
     setStatus(text?: string | null, presence?: keyof typeof Status): Promise<void>;
 }
 
 /**
  * Represents the base class for all event handlers.
  * All event handlers must extend this class and implement the `handle` method.
+ *  @private
  */
 declare abstract class Event {
     protected readonly client: client;
@@ -2122,6 +2147,8 @@ declare abstract class Event {
 
 /**
  * Manages the registration and retrieval of events for the client.
+ * @private
+ * @extends Event
  */
 declare class EventManager {
     #private;
@@ -2332,14 +2359,18 @@ declare abstract class BaseManager<Holds extends {
     readonly cache: Map<string, Holds>;
     /** Instance level max size (can be changed per manager instance). */
     protected maxSize: number;
+    /** @private */
     Holds: any;
     constructor(client: client, maxSize?: number);
     /**
      * Adds a raw object to the cache, constructing the holdable class.
      * Automatically evicts oldest entries if the max size is exceeded.
+     * @private
      */
     _add(raw: R): Holds;
-    /** Remove an entry by id. */
+    /** Remove an entry by id.
+     * @private
+     */
     _remove(id: string): void;
     /** Adjust the maximum size for this manager at runtime. */
     setMaxSize(size: number): void;
@@ -2355,7 +2386,9 @@ declare abstract class BaseManager<Holds extends {
 
 type ChannelResolvable = Channel | Channel$1 | string;
 declare class ChannelManager extends BaseManager<Channel, Channel$1> {
+    /** @private */
     holds: null;
+    /** @private */
     _add(data: Channel$1): Channel;
     _remove(id: string): void;
     /**
@@ -2395,7 +2428,9 @@ interface EditServerOptions {
     description?: string;
 }
 declare class ServerManager extends BaseManager<Server, Server$1> {
+    /** @private */
     readonly holds: typeof Server;
+    /** @private */
     _remove(id: string): void;
     /**
      * edits a server
@@ -2449,6 +2484,7 @@ interface MessageQueryOptions {
 }
 declare class MessageManager extends BaseManager<MessageStruct, Message> {
     protected readonly channel: Channel;
+    /** @private */
     holds: typeof MessageStruct;
     constructor(channel: Channel, maxSize?: number);
     /**
@@ -2540,8 +2576,10 @@ declare class RoleManager extends BaseManager<Role, Role$1 & {
     id: string;
 }> {
     protected readonly server: Server;
+    /** @private */
     holds: typeof Role;
     constructor(server: Server);
+    /** @private */
     _add(data: Role$1 & {
         id: string;
     }): Role;
@@ -2573,9 +2611,6 @@ declare class RoleManager extends BaseManager<Role, Role$1 & {
     edit(role: RoleResolvable, data: editableRole): Promise<Role>;
 }
 
-type APIServerChannel = Extract<Channel$1, {
-    channel_type: "TextChannel" | "VoiceChannel";
-}>;
 type ServerChannelResolvable = ServerChannel | APIServerChannel | string;
 interface CreateChannelOptions {
     name: string;
@@ -2584,15 +2619,18 @@ interface CreateChannelOptions {
 }
 declare class ServerChannelManager extends BaseManager<ServerChannel> {
     protected readonly server: Server;
+    /** @private */
     holds: typeof ServerChannel;
     constructor(server: Server);
+    /** @private */
     _add(data: APIServerChannel): ServerChannel;
     /**
-     * creates a new channel in the server
-     * @param name The name of the channel to create
-     * @param type The type of the channel to create. Can be "Text" or "Voice". Defaults to "Text".
-     * @param description The description of the channel to create. Only used for voice channels.
-     * @returns A promise that resolves to the created channel
+     * Creates a new channel in the server.
+     * @param options - Options for creating the channel.
+     * @param options.name - The name of the channel to create.
+     * @param [options.type="Text"] - The type of the channel to create. Can be "Text" or "Voice". Defaults to "Text".
+     * @param [options.description] - The description of the channel to create. Only used for voice channels.
+     * @returns A promise that resolves to the created channel.
      */
     create({ name, type, description, }: CreateChannelOptions): Promise<ServerChannel>;
     /**
@@ -2615,6 +2653,7 @@ interface EditServerMemberOptions {
 }
 declare class ServerMemberManager extends BaseManager<ServerMember, Member> {
     protected readonly server: Server;
+    /** @private */
     holds: typeof ServerMember;
     constructor(server: Server);
     /**
@@ -2661,4 +2700,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, 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, cdnUrl, client, wsUrl };