@pelican.ts/sdk 0.4.5 → 0.4.7

package/README.md

@@ -4,16 +4,63 @@
 
 # Pelican.ts — Typescript client for Pelican panel
 
-## Installation
+## 🧭 Installation
 ```shell
 npm install @pelican.ts/sdk
 ```
 
-## Usage
+## 📦 What's inside?
+### 🤗 Humane Client `@pelican.ts/sdk`
+**Humane Client** is an object-oriented client that provides a more comfortable experience. Each method corresponds to 
+an API endpoint, so each update causes only one request. Objects are updated automatically after each API call.
+
+I found the most use of it for file management, as each ServerFile knows exactly where is it located and what is its 
+parent folder, so you don't have to use `PelicanAPIClient`, `currentDir` and `FileObject` to achieve simple file operations.
+
+Also, each Humane object can be created from API client and corresponding API data object:
+```ts
+import { ServerBackup } from "@pelican.ts/sdk"
+const backup = new ServerBackup(serverClient, backupObject)
+````
+
+**Usage:**
 ```ts
-import { PelicanClient } from "@pelican.ts/sdk"
-const client = new PelicanClient("https://demo.pelican.dev", "token")
+import { createPelicanClient } from "@pelican.ts/sdk"
+const client = createPelicanClient("https://demo.pelican.dev", "token")
 
+// Create server backup and restore it
+const main = async () => {
+    const servers = await client.listServers()
+    const myServer = servers[0]
+    if (myServer.isInstalling || myServer.isSuspended)
+        return
+    const backup = await myServer.createBackup({
+        name: "first backup",
+        is_locked: false,
+        ignored_files: ["/dynmap/*"]
+    })
+    setTimeout(
+        async () => {
+            await backup.restore()
+        }, 60000
+    )
+}
+
+main()
+```
+
+
+### 🤖 API Client `@pelican.ts/sdk/api`
+**API Client** takes a more functional approach, consider it a direct API wrapper. It's stateless and doesn't save objects
+for you. Uses zod for input validation.
+
+**Usage:**
+```ts
+import { PelicanAPIClient } from "@pelican.ts/sdk/api"
+const client = new PelicanAPIClient("https://demo.pelican.dev", "token")
+// API client is also obtainable from Humane Client via createPelicanClient(...).$client
+
+// Create server backup and restore it
 const main = async () => {
     const servers = await client.listServers()
     const serverID = servers[0].identifier // babcaed0 for example
@@ -25,24 +72,27 @@ const main = async () => {
 main()
 ```
 
-What's done:
+### 📚 Types `@pelican.ts/sdk/types`
+Contains every API response type
+```ts
+import type {ApplicationServer, ServerBackup} from "@pelican.ts/sdk/types"
+
+const backup: ServerBackup = {
+    ...
+}
+```
+
+
+**What's done:**
 - [X] Client
 - [X] Application
-  - [X] Users
-  - [X] Nodes
-  - [X] Servers
-    - [X] Databases (TODO: Check if server database type is valid)
-  - [X] Database Hosts (~~TODO: find out why create API returns 500 No Route~~ Fix was merged to upstream)
-  - [X] Roles
-  - [X] Eggs
-  - [X] Mounts
 - [ ] TSDoc
 - [ ] Examples
 - [ ] Tests
 - [ ] Documentation
 - [X] Humane wrapper
 
-## Copyright Notice
+## 🧐 Copyright Notice
 [Pterodactyl®](https://github.com/pterodactyl) is a registered trademark of Dane Everitt and contributors.
 
 [Pelican®](https://github.com/pelican-dev) is a registered trademark of Pelican contributors.
@@ -51,5 +101,5 @@ Pelican.ts is Open Source under the [MIT License](LICENSE) and is the copyright
 of its contributors stated below. Pelican.ts is not endorsed by or affiliated with Pterodactyl® nor Pelican® team.
 
 
-## Contributors
+## 🧑‍💻 Contributors
 [M41den](https://github.com/m41denx) © 2024-2025

package/dist/api/index.d.mts

@@ -390,6 +390,9 @@ declare class ServerBackups {
     downloadGetUrl: (backup_uuid: string) => Promise<string>;
     download: (backup_uuid: string) => Promise<ArrayBuffer>;
     delete: (backup_uuid: string) => Promise<void>;
+    rename: (backup_uuid: string, name: string) => Promise<void>;
+    toggleLock: (backup_uuid: string) => Promise<void>;
+    restore: (backup_uuid: string, truncate: boolean) => Promise<void>;
 }
 
 type StartupParams = {

package/dist/api/index.d.ts

@@ -390,6 +390,9 @@ declare class ServerBackups {
     downloadGetUrl: (backup_uuid: string) => Promise<string>;
     download: (backup_uuid: string) => Promise<ArrayBuffer>;
     delete: (backup_uuid: string) => Promise<void>;
+    rename: (backup_uuid: string, name: string) => Promise<void>;
+    toggleLock: (backup_uuid: string) => Promise<void>;
+    restore: (backup_uuid: string, truncate: boolean) => Promise<void>;
 }
 
 type StartupParams = {

package/dist/api/index.js

@@ -365,6 +365,15 @@ var ServerBackups = class {
   delete = async (backup_uuid) => {
     await this.r.delete(`/servers/${this.id}/backups/${backup_uuid}`);
   };
+  rename = async (backup_uuid, name) => {
+    await this.r.put(`/servers/${this.id}/backups/${backup_uuid}/rename`, { name });
+  };
+  toggleLock = async (backup_uuid) => {
+    await this.r.post(`/servers/${this.id}/backups/${backup_uuid}/lock`);
+  };
+  restore = async (backup_uuid, truncate) => {
+    await this.r.post(`/servers/${this.id}/backups/${backup_uuid}/restore`, { truncate });
+  };
 };
 
 // src/api/client/server_startup.ts

package/dist/api/index.mjs

@@ -328,6 +328,15 @@ var ServerBackups = class {
   delete = async (backup_uuid) => {
     await this.r.delete(`/servers/${this.id}/backups/${backup_uuid}`);
   };
+  rename = async (backup_uuid, name) => {
+    await this.r.put(`/servers/${this.id}/backups/${backup_uuid}/rename`, { name });
+  };
+  toggleLock = async (backup_uuid) => {
+    await this.r.post(`/servers/${this.id}/backups/${backup_uuid}/lock`);
+  };
+  restore = async (backup_uuid, truncate) => {
+    await this.r.post(`/servers/${this.id}/backups/${backup_uuid}/restore`, { truncate });
+  };
 };
 
 // src/api/client/server_startup.ts

package/dist/index.d.mts

@@ -493,6 +493,9 @@ declare class ServerBackups {
     downloadGetUrl: (backup_uuid: string) => Promise<string>;
     download: (backup_uuid: string) => Promise<ArrayBuffer>;
     delete: (backup_uuid: string) => Promise<void>;
+    rename: (backup_uuid: string, name: string) => Promise<void>;
+    toggleLock: (backup_uuid: string) => Promise<void>;
+    restore: (backup_uuid: string, truncate: boolean) => Promise<void>;
 }
 
 declare class ServerStartup {
@@ -616,6 +619,9 @@ declare class ServerBackup {
     downloadGetUrl: () => Promise<string>;
     download: () => Promise<ArrayBuffer>;
     delete: () => Promise<void>;
+    rename: (name: string) => Promise<void>;
+    toggleLock: () => Promise<void>;
+    restore: (truncate: boolean) => Promise<void>;
 }
 
 declare class ServerDatabase {

package/dist/index.d.ts

@@ -493,6 +493,9 @@ declare class ServerBackups {
     downloadGetUrl: (backup_uuid: string) => Promise<string>;
     download: (backup_uuid: string) => Promise<ArrayBuffer>;
     delete: (backup_uuid: string) => Promise<void>;
+    rename: (backup_uuid: string, name: string) => Promise<void>;
+    toggleLock: (backup_uuid: string) => Promise<void>;
+    restore: (backup_uuid: string, truncate: boolean) => Promise<void>;
 }
 
 declare class ServerStartup {
@@ -616,6 +619,9 @@ declare class ServerBackup {
     downloadGetUrl: () => Promise<string>;
     download: () => Promise<ArrayBuffer>;
     delete: () => Promise<void>;
+    rename: (name: string) => Promise<void>;
+    toggleLock: () => Promise<void>;
+    restore: (truncate: boolean) => Promise<void>;
 }
 
 declare class ServerDatabase {

package/dist/index.js

@@ -373,6 +373,15 @@ var ServerBackups = class {
   delete = async (backup_uuid) => {
     await this.r.delete(`/servers/${this.id}/backups/${backup_uuid}`);
   };
+  rename = async (backup_uuid, name) => {
+    await this.r.put(`/servers/${this.id}/backups/${backup_uuid}/rename`, { name });
+  };
+  toggleLock = async (backup_uuid) => {
+    await this.r.post(`/servers/${this.id}/backups/${backup_uuid}/lock`);
+  };
+  restore = async (backup_uuid, truncate) => {
+    await this.r.post(`/servers/${this.id}/backups/${backup_uuid}/restore`, { truncate });
+  };
 };
 
 // src/api/client/server_startup.ts
@@ -1786,6 +1795,9 @@ var ServerBackup = class {
   downloadGetUrl = async () => this.client.backups.downloadGetUrl(this.uuid);
   download = async () => this.client.backups.download(this.uuid);
   delete = async () => this.client.backups.delete(this.uuid);
+  rename = async (name) => this.client.backups.rename(this.uuid, name);
+  toggleLock = async () => this.client.backups.toggleLock(this.uuid);
+  restore = async (truncate) => this.client.backups.restore(this.uuid, truncate);
 };
 
 // src/humane/ServerDatabase.ts

package/dist/index.mjs

@@ -328,6 +328,15 @@ var ServerBackups = class {
   delete = async (backup_uuid) => {
     await this.r.delete(`/servers/${this.id}/backups/${backup_uuid}`);
   };
+  rename = async (backup_uuid, name) => {
+    await this.r.put(`/servers/${this.id}/backups/${backup_uuid}/rename`, { name });
+  };
+  toggleLock = async (backup_uuid) => {
+    await this.r.post(`/servers/${this.id}/backups/${backup_uuid}/lock`);
+  };
+  restore = async (backup_uuid, truncate) => {
+    await this.r.post(`/servers/${this.id}/backups/${backup_uuid}/restore`, { truncate });
+  };
 };
 
 // src/api/client/server_startup.ts
@@ -1741,6 +1750,9 @@ var ServerBackup = class {
   downloadGetUrl = async () => this.client.backups.downloadGetUrl(this.uuid);
   download = async () => this.client.backups.download(this.uuid);
   delete = async () => this.client.backups.delete(this.uuid);
+  rename = async (name) => this.client.backups.rename(this.uuid, name);
+  toggleLock = async () => this.client.backups.toggleLock(this.uuid);
+  restore = async (truncate) => this.client.backups.restore(this.uuid, truncate);
 };
 
 // src/humane/ServerDatabase.ts

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@pelican.ts/sdk",
-    "version": "0.4.5",
+    "version": "0.4.7",
     "description": "Pelican panel SDK for TypeScript",
     "main": "./dist/index.js",
     "module": "./dist/index.mjs",

package/src/api/client/server_backups.ts

@@ -64,4 +64,15 @@ export class ServerBackups {
         await this.r.delete(`/servers/${this.id}/backups/${backup_uuid}`)
     }
 
+    rename = async (backup_uuid: string, name: string): Promise<void> => {
+        await this.r.put(`/servers/${this.id}/backups/${backup_uuid}/rename`, {name})
+    }
+
+    toggleLock = async (backup_uuid: string): Promise<void> => {
+        await this.r.post(`/servers/${this.id}/backups/${backup_uuid}/lock`)
+    }
+
+    restore = async (backup_uuid: string, truncate: boolean): Promise<void> => {
+        await this.r.post(`/servers/${this.id}/backups/${backup_uuid}/restore`, {truncate})
+    }
 }

package/src/humane/ServerBackup.ts

@@ -34,4 +34,14 @@ export class ServerBackup {
     download = async () => this.client.backups.download(this.uuid)
 
     delete = async () => this.client.backups.delete(this.uuid)
+
+    rename = async (
+        name: string
+    ) => this.client.backups.rename(this.uuid, name)
+
+    toggleLock = async () => this.client.backups.toggleLock(this.uuid)
+
+    restore = async (
+        truncate: boolean
+    ) => this.client.backups.restore(this.uuid, truncate)
 }