@pelican.ts/sdk 0.4.6 → 0.4.8

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

@@ -62,15 +62,6 @@ declare class Account {
         create: (name: string, public_key: string) => Promise<SSHKey>;
         delete: (fingerprint: string) => Promise<void>;
     };
-    twoFactor: {
-        info: () => Promise<{
-            image_url_data: string;
-        }>;
-        enable: (code: string) => Promise<{
-            tokens: string[];
-        }>;
-        disable: (password: string) => Promise<void>;
-    };
 }
 
 type GenericResponse<T, N extends string = string, M = undefined> = {

package/dist/api/index.d.ts

@@ -62,15 +62,6 @@ declare class Account {
         create: (name: string, public_key: string) => Promise<SSHKey>;
         delete: (fingerprint: string) => Promise<void>;
     };
-    twoFactor: {
-        info: () => Promise<{
-            image_url_data: string;
-        }>;
-        enable: (code: string) => Promise<{
-            tokens: string[];
-        }>;
-        disable: (password: string) => Promise<void>;
-    };
 }
 
 type GenericResponse<T, N extends string = string, M = undefined> = {

package/dist/api/index.js

@@ -84,19 +84,6 @@ var Account = class {
       await this.r.post(`/account/ssh-keys/remove`, { fingerprint });
     }
   };
-  twoFactor = {
-    info: async () => {
-      const { data } = await this.r.get("/account/two-factor");
-      return data;
-    },
-    enable: async (code) => {
-      const { data } = await this.r.post("/account/two-factor", { code });
-      return data;
-    },
-    disable: async (password) => {
-      await this.r.delete("/account/two-factor", { data: { password } });
-    }
-  };
 };
 
 // src/api/client/client.ts

package/dist/api/index.mjs

@@ -47,19 +47,6 @@ var Account = class {
       await this.r.post(`/account/ssh-keys/remove`, { fingerprint });
     }
   };
-  twoFactor = {
-    info: async () => {
-      const { data } = await this.r.get("/account/two-factor");
-      return data;
-    },
-    enable: async (code) => {
-      const { data } = await this.r.post("/account/two-factor", { code });
-      return data;
-    },
-    disable: async (password) => {
-      await this.r.delete("/account/two-factor", { data: { password } });
-    }
-  };
 };
 
 // src/api/client/client.ts

package/dist/index.d.mts

@@ -370,15 +370,6 @@ declare class Account$1 {
         create: (name: string, public_key: string) => Promise<SSHKey>;
         delete: (fingerprint: string) => Promise<void>;
     };
-    twoFactor: {
-        info: () => Promise<{
-            image_url_data: string;
-        }>;
-        enable: (code: string) => Promise<{
-            tokens: string[];
-        }>;
-        disable: (password: string) => Promise<void>;
-    };
 }
 
 declare class ServerDatabases {
@@ -579,13 +570,6 @@ declare class Account {
     listSshKeys: () => Promise<SSHKey[]>;
     createSshKey: (name: string, public_key: string) => Promise<SSHKey>;
     deleteSshKey: (fingerprint: string) => Promise<void>;
-    get2faQR: () => Promise<{
-        image_url_data: string;
-    }>;
-    enable2fa: (code: string) => Promise<{
-        tokens: string[];
-    }>;
-    disable2fa: (password: string) => Promise<void>;
 }
 
 declare class ServerAllocation {

package/dist/index.d.ts

@@ -370,15 +370,6 @@ declare class Account$1 {
         create: (name: string, public_key: string) => Promise<SSHKey>;
         delete: (fingerprint: string) => Promise<void>;
     };
-    twoFactor: {
-        info: () => Promise<{
-            image_url_data: string;
-        }>;
-        enable: (code: string) => Promise<{
-            tokens: string[];
-        }>;
-        disable: (password: string) => Promise<void>;
-    };
 }
 
 declare class ServerDatabases {
@@ -579,13 +570,6 @@ declare class Account {
     listSshKeys: () => Promise<SSHKey[]>;
     createSshKey: (name: string, public_key: string) => Promise<SSHKey>;
     deleteSshKey: (fingerprint: string) => Promise<void>;
-    get2faQR: () => Promise<{
-        image_url_data: string;
-    }>;
-    enable2fa: (code: string) => Promise<{
-        tokens: string[];
-    }>;
-    disable2fa: (password: string) => Promise<void>;
 }
 
 declare class ServerAllocation {

package/dist/index.js

@@ -92,19 +92,6 @@ var Account = class {
       await this.r.post(`/account/ssh-keys/remove`, { fingerprint });
     }
   };
-  twoFactor = {
-    info: async () => {
-      const { data } = await this.r.get("/account/two-factor");
-      return data;
-    },
-    enable: async (code) => {
-      const { data } = await this.r.post("/account/two-factor", { code });
-      return data;
-    },
-    disable: async (password) => {
-      await this.r.delete("/account/two-factor", { data: { password } });
-    }
-  };
 };
 
 // src/api/client/client.ts
@@ -1721,16 +1708,6 @@ var Account2 = class {
   listSshKeys = async () => this.client.account.sshKeys.list();
   createSshKey = async (name, public_key) => this.client.account.sshKeys.create(name, public_key);
   deleteSshKey = async (fingerprint) => this.client.account.sshKeys.delete(fingerprint);
-  get2faQR = async () => this.client.account.twoFactor.info();
-  enable2fa = async (code) => {
-    const tokens = await this.client.account.twoFactor.enable(code);
-    this.$has2faEnabled = true;
-    return tokens;
-  };
-  disable2fa = async (password) => {
-    await this.client.account.twoFactor.disable(password);
-    this.$has2faEnabled = false;
-  };
 };
 
 // src/humane/ServerAllocation.ts

package/dist/index.mjs

@@ -47,19 +47,6 @@ var Account = class {
       await this.r.post(`/account/ssh-keys/remove`, { fingerprint });
     }
   };
-  twoFactor = {
-    info: async () => {
-      const { data } = await this.r.get("/account/two-factor");
-      return data;
-    },
-    enable: async (code) => {
-      const { data } = await this.r.post("/account/two-factor", { code });
-      return data;
-    },
-    disable: async (password) => {
-      await this.r.delete("/account/two-factor", { data: { password } });
-    }
-  };
 };
 
 // src/api/client/client.ts
@@ -1676,16 +1663,6 @@ var Account2 = class {
   listSshKeys = async () => this.client.account.sshKeys.list();
   createSshKey = async (name, public_key) => this.client.account.sshKeys.create(name, public_key);
   deleteSshKey = async (fingerprint) => this.client.account.sshKeys.delete(fingerprint);
-  get2faQR = async () => this.client.account.twoFactor.info();
-  enable2fa = async (code) => {
-    const tokens = await this.client.account.twoFactor.enable(code);
-    this.$has2faEnabled = true;
-    return tokens;
-  };
-  disable2fa = async (password) => {
-    await this.client.account.twoFactor.disable(password);
-    this.$has2faEnabled = false;
-  };
 };
 
 // src/humane/ServerAllocation.ts

package/package.json

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

package/src/api/client/account.ts

@@ -69,24 +69,4 @@ export class Account {
             await this.r.post(`/account/ssh-keys/remove`, {fingerprint})
         }
     }
-
-    twoFactor = {
-        info: async (): Promise<{ image_url_data: string }> => {
-            const {data} = await this.r.get<
-                Awaited<ReturnType<typeof this.twoFactor.info>>
-            >("/account/two-factor")
-            return data
-        },
-
-        enable: async (code: string): Promise<{ tokens: string[] }> => {
-            const {data} = await this.r.post<
-                Awaited<ReturnType<typeof this.twoFactor.enable>>
-            >("/account/two-factor", {code})
-            return data
-        },
-
-        disable: async (password: string): Promise<void> => {
-            await this.r.delete("/account/two-factor", {data: {password}})
-        }
-    }
 }

package/src/humane/Account.ts

@@ -57,17 +57,4 @@ export class Account {
 
     deleteSshKey = async (fingerprint: string) =>
         this.client.account.sshKeys.delete(fingerprint)
-
-    get2faQR = async () => this.client.account.twoFactor.info()
-
-    enable2fa = async (code: string) => {
-        const tokens = await this.client.account.twoFactor.enable(code)
-        this.$has2faEnabled = true
-        return tokens
-    }
-
-    disable2fa = async (password: string) => {
-        await this.client.account.twoFactor.disable(password)
-        this.$has2faEnabled = false
-    }
 }