Webhooks Fixes

Author: SirBlobby

README.md

@@ -12,6 +12,14 @@
 
 A powerful and easy-to-use JavaScript/TypeScript package to interact with the [MCSS (MC Server Soft) API](https://www.mcserversoft.com/). This library provides a complete interface for managing Minecraft servers, users, backups, scheduled tasks, API keys, and webhooks.
 
+## 🔗 Useful Links
+
+- **Website**: [https://mcserversoft.com](https://mcserversoft.com)
+- **MCSS Documentation**: [MCSS Documentation](https://docs.mcserversoft.com/)
+- **MCSS API Documentation**: [API Documentation](https://docs.mcserversoft.com/apis/v2)
+- **Documentation**: [https://mcserversoft-community.github.io/mcss-api-js/](https://mcserversoft-community.github.io/mcss-api-js/)
+- **GitHub**: [https://github.com/mcserversoft-community/mcss-api-js](https://github.com/mcserversoft-community/mcss-api-js)
+
 ## 📦 Installation
 
 You can install the package using your preferred package manager:
@@ -35,88 +43,118 @@ import { Client } from '@mcserversoft/mcss-api';
 const client = new Client("127.0.0.1", 8080, "YOUR_API_KEY", true);
 ```
 
-### 🎮 Server Management
+The `client` object is your main entry point and provides access to:
+
+- **Modules**:
+    - `client.servers`: Manage servers.
+    - `client.users`: Manage users.
+    - `client.webhooks`: Manage webhooks.
+    - `client.apikeys`: Manage API keys.
+- **Direct Methods**:
+    - `client.getStats()`: Get panel stats.
+    - `client.getServers()`: Get all servers.
+    - `client.getServerCount()`: Get server count.
+    - `client.getSettings()`: Get MCSS settings.
+    - `client.updateSettings()`: Update MCSS settings.
+
+## ✨ Builder Classes
+
+This library includes builder classes to make creating complex objects straightforward. These builders use a fluent interface, allowing you to chain methods together.
 
-#### Get all servers
+- `Server`: For creating new server configurations.
+- `User`: For creating new users.
+- `Backup`: For creating new backup configurations.
+- `Task`: For creating new scheduled tasks.
+- `Key`: For creating new API keys.
+
+### Example Usage of a Builder
 
 ```javascript
-async function getServers() {
-    const servers = await client.getServers();
-    if (Array.isArray(servers)) {
-        servers.forEach(server => {
-            console.log(`Server: ${server.name} (${server.status})`);
-            console.log(`Players: ${server.players}/${server.maxPlayers}`);
-        });
-    }
-}
+import { Backup, Compression } from '@mcserversoft/mcss-api';
 
-getServers();
+const newBackup = new Backup("My Important Backup", "local_destination")
+    .setCompression(Compression.HIGH)
+    .setSuspend(true)
+    .setDeleteOldBackups(true);
+
+// You can then use this `newBackup` object in the API methods.
+// For example:
+// await server.backups.create(newBackup);
 ```
 
-#### Get a specific server
+## 🎮 Server Management
+
+When you fetch a server, you get a `ServerObject` which has its own methods and properties.
+
+### The `ServerObject`
+
+A `ServerObject` contains all the information about a server, as well as instance-specific modules for backups and scheduling.
+
+- **Properties**: `id`, `name`, `status`, `players`, `maxPlayers`, etc.
+- **Modules**:
+    - `server.backups`: Manage backups for this specific server.
+    - `server.scheduler`: Manage scheduled tasks for this specific server.
+- **Methods**:
+    - `server.getStats()`: Get server-specific stats.
+    - `server.execute()`: Execute commands or actions.
+    - `server.edit()`: Edit the server's properties.
+
+### Get a specific server
 
 ```javascript
 async function getServer() {
-    const response = await client.servers.get("YOUR_SERVER_ID");
-    if (response.status === 200) {
-        console.log(`Server data:`, response.data);
+    const server = await client.servers.get("YOUR_SERVER_ID");
+    if (server.status === 200) {
+        console.log(`Server Name: ${server.name}`);
+        console.log(`Status: ${server.status}`);
+        
+        // You can access backups and scheduler directly
+        const backups = await server.backups.get();
+        console.log('Backups:', backups.data);
     }
 }
 
 getServer();
 ```
 
-#### Control server operations
+### Control server operations
 
 ```javascript
 import { ServerAction } from '@mcserversoft/mcss-api';
 
 async function manageServer() {
-    // First get all servers to find the one we want
-    const servers = await client.getServers();
-    if (Array.isArray(servers) && servers.length > 0) {
-        const server = servers[0]; // Use the first server as example
-        
+    const server = await client.servers.get("YOUR_SERVER_ID");
+    if (server.status === 200) {
         // Start the server
         const startResult = await server.execute(ServerAction.Start);
         console.log('Start result:', startResult.status);
 
         // Send a command
         const commandResult = await server.execute("say Hello from the API!");
         console.log('Command result:', commandResult.status);
-
-        // Stop the server
-        const stopResult = await server.execute(ServerAction.Stop);
-        console.log('Stop result:', stopResult.status);
     }
 }
 
 manageServer();
 ```
 
-### 👥 User Management
+## 👥 User Management
 
 ```javascript
+import { User } from '@mcserversoft/mcss-api';
+
 async function manageUsers() {
     // Get all users
     const usersResponse = await client.users.get();
     if (usersResponse.status === 200) {
         console.log('Users:', usersResponse.data);
     }
 
-    // Get a specific user
-    const userResponse = await client.users.getUser("USER_ID");
-    if (userResponse.status === 200) {
-        console.log('User:', userResponse.data);
-    }
+    // Create a new user using the User builder
+    const newUser = new User("testuser", "password123", true, false, false)
+        .setUsername("new-test-user")
+        .setPassword("securePassword123");
 
-    // Create a new user
-    const newUser = {
-        username: "testuser",
-        password: "password123",
-        email: "test@example.com",
-        role: "user"
-    };
     const createdUser = await client.users.createUser(newUser);
     if (createdUser.status === 200) {
         console.log('User created:', createdUser.data);
@@ -126,27 +164,26 @@ async function manageUsers() {
 manageUsers();
 ```
 
-### 💾 Backup Management
+## 💾 Backup Management
 
 ```javascript
+import { Backup, Compression } from '@mcserversoft/mcss-api';
+
 async function manageBackups() {
-    // First get all servers to find the one we want
-    const servers = await client.getServers();
-    if (Array.isArray(servers) && servers.length > 0) {
-        const serverId = servers[0].id; // Use the first server's ID
-        
+    const server = await client.servers.get("YOUR_SERVER_ID");
+    if (server.status === 200) {
         // Get all backups for a server
-        const backupsResponse = await servers[0].backups.get();
+        const backupsResponse = await server.backups.get();
         if (backupsResponse.status === 200) {
             console.log('Backups:', backupsResponse.data);
         }
 
-        // Create a new backup
-        const newBackup = {
-            name: "My Backup",
-            destination: "local"
-        };
-        const createdBackup = await servers[0].backups.create(newBackup);
+        // Create a new backup using the Backup builder
+        const newBackup = new Backup("My New Backup", "local")
+            .setCompression(Compression.HIGH)
+            .setSuspend(true);
+            
+        const createdBackup = await server.backups.create(newBackup);
         if (createdBackup.status === 200) {
             console.log('Backup created:', createdBackup.data);
         }
@@ -156,26 +193,26 @@ async function manageBackups() {
 manageBackups();
 ```
 
-### ⏰ Scheduled Tasks
+## ⏰ Scheduled Tasks
 
 ```javascript
+import { Task, ServerAction } from '@mcserversoft/mcss-api';
+
 async function manageTasks() {
-    // First get all servers to find the one we want
-    const servers = await client.getServers();
-    if (Array.isArray(servers) && servers.length > 0) {
+    const server = await client.servers.get("YOUR_SERVER_ID");
+    if (server.status === 200) {
         // Get all tasks for a server
-        const tasksResponse = await servers[0].scheduler.getTasks();
+        const tasksResponse = await server.scheduler.getTasks();
         if (tasksResponse.status === 200) {
             console.log('Tasks:', tasksResponse.data);
         }
 
-        // Create a new scheduled task
-        const newTask = {
-            name: "Daily Restart",
-            action: "restart",
-            schedule: "0 6 * * *" // Daily at 6 AM
-        };
-        const createdTask = await servers[0].scheduler.create(newTask);
+        // Create a new scheduled task using the Task builder
+        const newTask = new Task("Daily Restart", true, 0)
+            .setTiming(true, 86400) // Repeat every 24 hours
+            .addJob(ServerAction.Restart);
+
+        const createdTask = await server.scheduler.create(newTask);
         if (createdTask.status === 200) {
             console.log('Task created:', createdTask.data);
         }
@@ -185,7 +222,7 @@ async function manageTasks() {
 manageTasks();
 ```
 
-### 🔑 API Key Management
+## 🔑 API Key Management
 
 ```javascript
 import { Key, ServerPermissions } from '@mcserversoft/mcss-api';
@@ -197,16 +234,15 @@ async function manageApiKeys() {
         console.log('API Keys:', keysResponse.data);
     }
 
-    // Create a new API key
-    const newKey = new Key(
-        "My API Key",
-        [
-            {
-                serverId: "YOUR_SERVER_ID",
-                permissions: [ServerPermissions.Start, ServerPermissions.Stop]
-            }
-        ]
-    );
+    // Create a new API key using the Key builder
+    const newKey = new Key("My Test Key")
+        .setIsAdmin(false)
+        .setHasAccessToAllServers(false)
+        .addCustomServerPermission("YOUR_SERVER_ID", {
+            [ServerPermissions.VIEW_STATS]: true,
+            [ServerPermissions.USE_CONSOLE]: true,
+        });
+
     const createdKey = await client.apikeys.create(newKey);
     if (createdKey.status === 200) {
         console.log('API Key created:', createdKey.data);
@@ -216,7 +252,7 @@ async function manageApiKeys() {
 manageApiKeys();
 ```
 
-### 🪝 Webhook Management
+## 🪝 Webhook Management
 
 ```javascript
 import { WebhookTrigger } from '@mcserversoft/mcss-api';
@@ -228,13 +264,13 @@ async function manageWebhooks() {
         console.log('Webhooks:', webhooksResponse.data);
     }
 
-    // Create a new webhook
-    const createdWebhook = await client.webhooks.create(
-        "My Webhook",
-        "https://example.com/webhook",
-        0,
-        [WebhookTrigger.SERVER_STATUS_CHANGED]
-    );
+    // Create a new webhook using the Webhook builder
+    const newWebhook = new Webhook("My Webhook", "https://example.com/webhook")
+        .setMessageFormat(0) // 0 for JSON
+        .setWebhookTriggers([WebhookTrigger.SERVER_STATUS_CHANGED])
+        .addOptionalHeader("X-Custom-Header", "SomeValue");
+
+    const createdWebhook = await client.webhooks.create(newWebhook);
     if (createdWebhook.status === 200) {
         console.log('Webhook created:', createdWebhook.data);
     }
@@ -243,6 +279,24 @@ async function manageWebhooks() {
 manageWebhooks();
 ```
 
+## 📚 API Reference
+
+### Enums
+
+The library exports several enums to make working with specific values easier:
+
+- `GB`: Memory allocation for servers (e.g., `GB.ONE`).
+- `Compression`: Backup compression levels (`HIGH`, `LOW`, `NONE`).
+- `KeepOnline`: Server keep-online strategies.
+- `ServerAction`: Actions like `Start`, `Stop`, `Restart`.
+- `ServerFilter`: Filters for listing servers.
+- `ServerCountFilter`: Filters for counting servers.
+- `ServerType`: Specific server types (e.g., `VANILLA`, `PAPER`).
+- `TaskFilter`: Filters for scheduled tasks.
+- `WebhookTrigger`: Events that trigger webhooks.
+- `WebhookMessageFormat`: Message formats for webhooks (e.g., `GENERAL`, `DISCORD`).
+- `ServerPermissions`: Permissions for API keys.
+
 ## 📚 API Documentation
 
 For comprehensive API documentation with detailed examples, type definitions, and method signatures, visit our [TypeDoc documentation](https://mcserversoft-community.github.io/mcss-api-js/).
@@ -254,17 +308,6 @@ To generate the documentation locally, run:
 ```bash
 npm run docs
 ```
-
-## 🤝 Contributing
-
-We welcome contributions! Here's how you can help:
-
-1. 🍴 **Fork** the repository
-2. 🌿 **Create** your feature branch (`git checkout -b feature/amazing-feature`)
-3. ✅ **Commit** your changes (`git commit -m 'Add some amazing feature'`)
-4. 📤 **Push** to the branch (`git push origin feature/amazing-feature`)
-5. 🔀 **Open** a Pull Request
-
 ### Development Setup
 
 ```bash
@@ -283,7 +326,7 @@ npm test
 
 ## 📋 Requirements
 
-- Node.js 16.x or higher
+- Node.js 18.x or higher
 - MCSS (MC Server Soft) instance with API enabled
 - Valid API key with appropriate permissions
 
@@ -304,4 +347,4 @@ This project is licensed under the MIT License - see the [LICENSE](LICENSE) file
 
 [Website](https://mcserversoft.com) • [GitHub](https://github.com/mcserversoft-community) • [Documentation](https://mcserversoft-community.github.io/mcss-api-js/)
 
-</div>
+</div>

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mcserversoft/mcss-api",
-  "version": "1.3.0",
+  "version": "1.3.1",
   "description": "Simple package to interact with MCSS's API",
   "license": "MIT",
   "main": "dist/index.js",