@pelican.ts/sdk 0.4.0 → 0.4.1

package/.husky/pre-commit

@@ -1,3 +1,3 @@
-echo "🙄 Nonchalantly saving you from big commit deltas due to formatting..."
-bun run format
-git update-index --again
+#echo "🙄 Nonchalantly saving you from big commit deltas due to formatting..."
+#bun run format
+#git update-index --again

package/README.md

@@ -4,10 +4,6 @@
 
 # Pelican.ts — Typescript client for Pelican panel
 
-> [!WARNING]  
-> This is a `next` version of Pelican.ts, it is based on [Pelican-contrib](https://github.com/m41denx/pelican-contrib) 
-> fork and is not compatible with upstream Pelican panel.
-
 ## Installation
 ```shell
 npm install @pelican.ts/sdk
@@ -44,7 +40,7 @@ What's done:
 - [ ] Examples
 - [ ] Tests
 - [ ] Documentation
-- [ ] Humane wrapper
+- [X] Humane wrapper
 
 ## Copyright Notice
 [Pterodactyl®](https://github.com/pterodactyl) is a registered trademark of Dane Everitt and contributors.

package/biome.json

@@ -1,39 +1,36 @@
 {
-  "$schema": "https://biomejs.dev/schemas/2.3.6/schema.json",
-  "vcs": {
-    "enabled": true,
-    "clientKind": "git",
-    "useIgnoreFile": true
-  },
-  "files": {
-    "includes": [
-      "**",
-      "!!**/dist"
-    ]
-  },
-  "formatter": {
-    "enabled": true,
-    "indentStyle": "space",
-    "indentWidth": 4
-  },
-  "linter": {
-    "enabled": true,
-    "rules": {
-      "recommended": true
-    }
-  },
-  "javascript": {
+    "$schema": "https://biomejs.dev/schemas/2.3.6/schema.json",
+    "vcs": {
+        "enabled": true,
+        "clientKind": "git",
+        "useIgnoreFile": true
+    },
+    "files": {
+        "includes": ["**", "!!**/dist"]
+    },
     "formatter": {
-      "quoteStyle": "double",
-      "semicolons": "asNeeded"
-    }
-  },
-  "assist": {
-    "enabled": true,
-    "actions": {
-      "source": {
-        "organizeImports": "on"
-      }
+        "enabled": true,
+        "indentStyle": "space",
+        "indentWidth": 4
+    },
+    "linter": {
+        "enabled": true,
+        "rules": {
+            "recommended": true
+        }
+    },
+    "javascript": {
+        "formatter": {
+            "quoteStyle": "double",
+            "semicolons": "asNeeded"
+        }
+    },
+    "assist": {
+        "enabled": true,
+        "actions": {
+            "source": {
+                "organizeImports": "on"
+            }
+        }
     }
-  }
 }

package/dist/api/index.d.mts

@@ -447,12 +447,12 @@ declare enum SOCKET_EVENT {
 }
 type BackupCompletedJson = {
     checksum: string;
-    checksum_type: 'sha1';
+    checksum_type: "sha1";
     file_size: number;
     is_successful: boolean;
     uuid: string;
 };
-type PowerState = 'starting' | 'stopping' | 'running' | 'offline';
+type PowerState = "starting" | "stopping" | "running" | "offline";
 type StatsWsJson = {
     memory_bytes: number;
     memory_limit_bytes: number;

package/dist/api/index.d.ts

@@ -447,12 +447,12 @@ declare enum SOCKET_EVENT {
 }
 type BackupCompletedJson = {
     checksum: string;
-    checksum_type: 'sha1';
+    checksum_type: "sha1";
     file_size: number;
     is_successful: boolean;
     uuid: string;
 };
-type PowerState = 'starting' | 'stopping' | 'running' | 'offline';
+type PowerState = "starting" | "stopping" | "running" | "offline";
 type StatsWsJson = {
     memory_bytes: number;
     memory_limit_bytes: number;

package/dist/index.d.mts

@@ -223,12 +223,12 @@ declare enum SOCKET_EVENT {
 }
 type BackupCompletedJson = {
     checksum: string;
-    checksum_type: 'sha1';
+    checksum_type: "sha1";
     file_size: number;
     is_successful: boolean;
     uuid: string;
 };
-type PowerState = 'starting' | 'stopping' | 'running' | 'offline';
+type PowerState = "starting" | "stopping" | "running" | "offline";
 type StatsWsJson = {
     memory_bytes: number;
     memory_limit_bytes: number;
@@ -792,7 +792,7 @@ declare class Server {
     runCommand: (command: string) => Promise<void>;
     sendPowerSignal: (signal: "start" | "stop" | "restart" | "kill") => Promise<void>;
     getDatabases: (opts?: {
-        include?: ("password")[];
+        include?: "password"[];
         page?: number;
     }) => Promise<ServerDatabase[]>;
     createDatabase: (database: string, remote: string) => Promise<ServerDatabase>;
@@ -830,4 +830,4 @@ declare class Client {
 
 declare const createPelicanClient: (url: string, token: string, suffix?: string) => Client;
 
-export { createPelicanClient };
+export { Account, Client, Server, ServerAllocation, ServerBackup, ServerDatabase, ServerFile, ServerSchedule, ServerUser, createPelicanClient };

package/dist/index.d.ts

@@ -223,12 +223,12 @@ declare enum SOCKET_EVENT {
 }
 type BackupCompletedJson = {
     checksum: string;
-    checksum_type: 'sha1';
+    checksum_type: "sha1";
     file_size: number;
     is_successful: boolean;
     uuid: string;
 };
-type PowerState = 'starting' | 'stopping' | 'running' | 'offline';
+type PowerState = "starting" | "stopping" | "running" | "offline";
 type StatsWsJson = {
     memory_bytes: number;
     memory_limit_bytes: number;
@@ -792,7 +792,7 @@ declare class Server {
     runCommand: (command: string) => Promise<void>;
     sendPowerSignal: (signal: "start" | "stop" | "restart" | "kill") => Promise<void>;
     getDatabases: (opts?: {
-        include?: ("password")[];
+        include?: "password"[];
         page?: number;
     }) => Promise<ServerDatabase[]>;
     createDatabase: (database: string, remote: string) => Promise<ServerDatabase>;
@@ -830,4 +830,4 @@ declare class Client {
 
 declare const createPelicanClient: (url: string, token: string, suffix?: string) => Client;
 
-export { createPelicanClient };
+export { Account, Client, Server, ServerAllocation, ServerBackup, ServerDatabase, ServerFile, ServerSchedule, ServerUser, createPelicanClient };

package/dist/index.js

@@ -30,6 +30,15 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
 // src/index.ts
 var index_exports = {};
 __export(index_exports, {
+  Account: () => Account2,
+  Client: () => Client3,
+  Server: () => Server,
+  ServerAllocation: () => ServerAllocation,
+  ServerBackup: () => ServerBackup,
+  ServerDatabase: () => ServerDatabase,
+  ServerFile: () => ServerFile,
+  ServerSchedule: () => ServerSchedule,
+  ServerUser: () => ServerUser,
   createPelicanClient: () => createPelicanClient
 });
 module.exports = __toCommonJS(index_exports);
@@ -1859,7 +1868,12 @@ var ServerFile = class {
   rename = async (newName) => this.client.files.rename(this.dir, [{ from: this.name, to: newName }]);
   copy = async () => this.client.files.copy(this.path);
   write = async (content) => this.client.files.write(this.path, content);
-  compress = async (archive_name, extension) => this.client.files.compress(this.dir, [this.name], archive_name, extension);
+  compress = async (archive_name, extension) => this.client.files.compress(
+    this.dir,
+    [this.name],
+    archive_name,
+    extension
+  );
   decompress = async () => this.client.files.decompress(this.dir, this.name);
   delete = async () => this.client.files.delete(this.dir, [this.name]);
   chmod = async (mode) => this.client.files.chmod(this.dir, [{ file: this.name, mode }]);
@@ -2074,10 +2088,16 @@ var Server = class {
     this.isSuspended = server.is_suspended;
     this.isInstalling = server.is_installing;
     this.isTransferring = server.is_transferring;
-    this.allocations = server.relationships.allocations.data.map((d) => new ServerAllocation(this.client, d.attributes));
-    this.variables = server.relationships.variables.data.map((d) => d.attributes);
+    this.allocations = server.relationships.allocations.data.map(
+      (d) => new ServerAllocation(this.client, d.attributes)
+    );
+    this.variables = server.relationships.variables.data.map(
+      (d) => d.attributes
+    );
     this.egg = server.relationships.egg?.attributes;
-    this.subusers = server.relationships.subusers?.data.map((d) => new ServerUser(this.client, d.attributes));
+    this.subusers = server.relationships.subusers?.data.map(
+      (d) => new ServerUser(this.client, d.attributes)
+    );
   }
   rename = async (name) => {
     await this.client.settings.rename(name);
@@ -2097,7 +2117,10 @@ var Server = class {
   getServerStats = async () => this.client.resources();
   runCommand = async (command) => this.client.command(command);
   sendPowerSignal = async (signal) => this.client.power(signal);
-  getDatabases = async (opts = { include: [], page: 1 }) => {
+  getDatabases = async (opts = {
+    include: [],
+    page: 1
+  }) => {
     const data = await this.client.databases.list(opts.include, opts.page);
     return data.map((d) => new ServerDatabase(this.client, d));
   };
@@ -2164,7 +2187,12 @@ var Client3 = class {
   };
   listPermissions = async () => this.client.listPermissions();
   listServers = async (opts = { type: "accessible", page: 1, per_page: 50 }) => {
-    const data = await this.client.listServers(opts.type, opts.page, opts.per_page, opts.include);
+    const data = await this.client.listServers(
+      opts.type,
+      opts.page,
+      opts.per_page,
+      opts.include
+    );
     return data.map((d) => new Server(this.client.server(d.uuid), d));
   };
   getServer = async (uuid, include) => {
@@ -2180,6 +2208,15 @@ var createPelicanClient = (url, token, suffix = "/api") => {
 };
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
+  Account,
+  Client,
+  Server,
+  ServerAllocation,
+  ServerBackup,
+  ServerDatabase,
+  ServerFile,
+  ServerSchedule,
+  ServerUser,
   createPelicanClient
 });
 /*

package/dist/index.mjs

@@ -1823,7 +1823,12 @@ var ServerFile = class {
   rename = async (newName) => this.client.files.rename(this.dir, [{ from: this.name, to: newName }]);
   copy = async () => this.client.files.copy(this.path);
   write = async (content) => this.client.files.write(this.path, content);
-  compress = async (archive_name, extension) => this.client.files.compress(this.dir, [this.name], archive_name, extension);
+  compress = async (archive_name, extension) => this.client.files.compress(
+    this.dir,
+    [this.name],
+    archive_name,
+    extension
+  );
   decompress = async () => this.client.files.decompress(this.dir, this.name);
   delete = async () => this.client.files.delete(this.dir, [this.name]);
   chmod = async (mode) => this.client.files.chmod(this.dir, [{ file: this.name, mode }]);
@@ -2038,10 +2043,16 @@ var Server = class {
     this.isSuspended = server.is_suspended;
     this.isInstalling = server.is_installing;
     this.isTransferring = server.is_transferring;
-    this.allocations = server.relationships.allocations.data.map((d) => new ServerAllocation(this.client, d.attributes));
-    this.variables = server.relationships.variables.data.map((d) => d.attributes);
+    this.allocations = server.relationships.allocations.data.map(
+      (d) => new ServerAllocation(this.client, d.attributes)
+    );
+    this.variables = server.relationships.variables.data.map(
+      (d) => d.attributes
+    );
     this.egg = server.relationships.egg?.attributes;
-    this.subusers = server.relationships.subusers?.data.map((d) => new ServerUser(this.client, d.attributes));
+    this.subusers = server.relationships.subusers?.data.map(
+      (d) => new ServerUser(this.client, d.attributes)
+    );
   }
   rename = async (name) => {
     await this.client.settings.rename(name);
@@ -2061,7 +2072,10 @@ var Server = class {
   getServerStats = async () => this.client.resources();
   runCommand = async (command) => this.client.command(command);
   sendPowerSignal = async (signal) => this.client.power(signal);
-  getDatabases = async (opts = { include: [], page: 1 }) => {
+  getDatabases = async (opts = {
+    include: [],
+    page: 1
+  }) => {
     const data = await this.client.databases.list(opts.include, opts.page);
     return data.map((d) => new ServerDatabase(this.client, d));
   };
@@ -2128,7 +2142,12 @@ var Client3 = class {
   };
   listPermissions = async () => this.client.listPermissions();
   listServers = async (opts = { type: "accessible", page: 1, per_page: 50 }) => {
-    const data = await this.client.listServers(opts.type, opts.page, opts.per_page, opts.include);
+    const data = await this.client.listServers(
+      opts.type,
+      opts.page,
+      opts.per_page,
+      opts.include
+    );
     return data.map((d) => new Server(this.client.server(d.uuid), d));
   };
   getServer = async (uuid, include) => {
@@ -2143,6 +2162,15 @@ var createPelicanClient = (url, token, suffix = "/api") => {
   return new Client3(client);
 };
 export {
+  Account2 as Account,
+  Client3 as Client,
+  Server,
+  ServerAllocation,
+  ServerBackup,
+  ServerDatabase,
+  ServerFile,
+  ServerSchedule,
+  ServerUser,
   createPelicanClient
 };
 /*

package/dist/types.d.ts

@@ -995,12 +995,12 @@ declare class ServerWebsocket {
     sendCommand(cmd: string): void;
 }
 
-type ServerStatus = 'starting' | 'stopping' | 'online' | 'offline';
+type ServerStatus = "starting" | "stopping" | "online" | "offline";
 declare enum SERVER_SIGNAL {
-    'START' = "start",
-    'STOP' = "stop",
-    'RESTART' = "restart",
-    'KILL' = "kill"
+    START = "start",
+    STOP = "stop",
+    RESTART = "restart",
+    KILL = "kill"
 }
 type WebsocketEvent = AuthSuccessWsEvent | StatusWsEvent | ConsoleLogWsEvent | StatsWsEvent | TokenExpiringWsEvent | TokenExpiredWsEvent | DaemonErrorEvent | DaemonMessageEvent | InstallOutputEvent | InstallStartedEvent | InstallCompletedEvent | TransferLogsEvent | TransferStatusEvent | BackupCompletedEvent | BackupRestoreCompletedEvent | JwtErrorEvent;
 /**
@@ -1048,7 +1048,7 @@ type BackupCompletedEvent = {
 };
 type BackupCompletedJson = {
     checksum: string;
-    checksum_type: 'sha1';
+    checksum_type: "sha1";
     file_size: number;
     is_successful: boolean;
     uuid: string;
@@ -1063,7 +1063,7 @@ type StatusWsEvent = {
     event: SOCKET_EVENT.STATUS;
     args: [PowerState];
 };
-type PowerState = 'starting' | 'stopping' | 'running' | 'offline';
+type PowerState = "starting" | "stopping" | "running" | "offline";
 type ConsoleLogWsEvent = {
     event: SOCKET_EVENT.CONSOLE_OUTPUT;
     args: [string];

package/package.json

@@ -1,64 +1,64 @@
 {
-  "name": "@pelican.ts/sdk",
-  "version": "0.4.0",
-  "description": "Pelican panel SDK for TypeScript",
-  "main": "./dist/index.js",
-  "module": "./dist/index.mjs",
-  "types": "./dist/index.d.ts",
-  "exports": {
-    ".": {
-      "types": "./dist/index.d.ts",
-      "require": "./dist/index.js",
-      "import": "./dist/index.mjs"
+    "name": "@pelican.ts/sdk",
+    "version": "0.4.1",
+    "description": "Pelican panel SDK for TypeScript",
+    "main": "./dist/index.js",
+    "module": "./dist/index.mjs",
+    "types": "./dist/index.d.ts",
+    "exports": {
+        ".": {
+            "types": "./dist/index.d.ts",
+            "require": "./dist/index.js",
+            "import": "./dist/index.mjs"
+        },
+        "./api": {
+            "types": "./dist/api/index.d.ts",
+            "require": "./dist/api/index.js",
+            "import": "./dist/api/index.mjs"
+        },
+        "./types": {
+            "types": "./dist/types.d.ts"
+        }
     },
-    "./api": {
-      "types": "./dist/api/index.d.ts",
-      "require": "./dist/api/index.js",
-      "import": "./dist/api/index.mjs"
+    "scripts": {
+        "build:api": "tsup src/api/index.ts --format esm,cjs --dts --target esnext -d dist/api",
+        "build:humane": "tsup src/index.ts --format esm,cjs --dts --target esnext",
+        "build:types": "tsup src/types.ts --dts-only --target esnext",
+        "build": "rm -rf ./dist && npm run build:api && npm run build:humane && npm run build:types",
+        "pub": "npm publish --access=public",
+        "pub:next": "npm publish --access=public --tag=next",
+        "generate-types": "bun run scripts/create-types.ts",
+        "pipeline:next": "bun run generate-types && bun run build && bun run pub:next",
+        "pipeline": "bun run generate-types && bun run build && bun run pub",
+        "format": "biome format --no-errors-on-unmatched --files-ignore-unknown=true --write .",
+        "prepare": "husky"
     },
-    "./types": {
-      "types": "./dist/types.d.ts"
+    "keywords": [
+        "pterodactyl",
+        "pterodactyl.ts",
+        "pterodactyl.js",
+        "pelican",
+        "pelican.ts",
+        "pelican.js"
+    ],
+    "author": "M41den",
+    "license": "MIT",
+    "repository": {
+        "url": "git+https://github.com/m41denx/Pelican.ts"
+    },
+    "devDependencies": {
+        "@biomejs/biome": "2.3.6",
+        "@types/node": "^22.18.12",
+        "@types/strip-color": "^0.1.2",
+        "husky": "^9.1.7",
+        "tsc-alias": "^1.8.16",
+        "tsup": "^8.5.0",
+        "typescript": "^5.9.3"
+    },
+    "dependencies": {
+        "axios": "^1.12.2",
+        "isomorphic-ws": "^5.0.0",
+        "strip-color": "^0.1.0",
+        "zod": "^4.1.12"
     }
-  },
-  "scripts": {
-    "build:api": "tsup src/api/index.ts --format esm,cjs --dts --target esnext -d dist/api",
-    "build:humane": "tsup src/index.ts --format esm,cjs --dts --target esnext",
-    "build:types": "tsup src/types.ts --dts-only --target esnext",
-    "build": "rm -rf ./dist && npm run build:api && npm run build:humane && npm run build:types",
-    "pub": "npm publish --access=public",
-    "pub:next": "npm publish --access=public --tag=next",
-    "generate-types": "bun run scripts/create-types.ts",
-    "pipeline:next": "bun run generate-types && bun run build && bun run pub:next",
-    "pipeline": "bun run generate-types && bun run build && bun run pub",
-    "format": "biome format --no-errors-on-unmatched --files-ignore-unknown=true --write .",
-    "prepare": "husky"
-  },
-  "keywords": [
-    "pterodactyl",
-    "pterodactyl.ts",
-    "pterodactyl.js",
-    "pelican",
-    "pelican.ts",
-    "pelican.js"
-  ],
-  "author": "M41den",
-  "license": "MIT",
-  "repository": {
-    "url": "git+https://github.com/m41denx/Pelican.ts"
-  },
-  "devDependencies": {
-    "@biomejs/biome": "2.3.6",
-    "@types/node": "^22.18.12",
-    "@types/strip-color": "^0.1.2",
-    "husky": "^9.1.7",
-    "tsc-alias": "^1.8.16",
-    "tsup": "^8.5.0",
-    "typescript": "^5.9.3"
-  },
-  "dependencies": {
-    "axios": "^1.12.2",
-    "isomorphic-ws": "^5.0.0",
-    "strip-color": "^0.1.0",
-    "zod": "^4.1.12"
-  }
 }

package/src/api/client/types/server.ts

@@ -1,69 +1,82 @@
-import {GenericListResponse, GenericResponse} from "@/api/base/types";
-import {EggVariable} from "@/api/common/types/egg";
-import {ServerSubuser} from "@/api/client/types/server_subuser";
-import {FeatureLimits, ServerLimits} from "@/api/common/types/server_limits";
-import {ServerAllocation} from "@/api/client/types/server_allocation";
-import {Nullable} from "@/utils/types";
+import { GenericListResponse, GenericResponse } from "@/api/base/types"
+import { EggVariable } from "@/api/common/types/egg"
+import { ServerSubuser } from "@/api/client/types/server_subuser"
+import { FeatureLimits, ServerLimits } from "@/api/common/types/server_limits"
+import { ServerAllocation } from "@/api/client/types/server_allocation"
+import { Nullable } from "@/utils/types"
 
 export type Server = {
-    server_owner: boolean,
-    identifier: string,
-    internal_id?: number,
-    uuid: string,
-    name: string,
-    node: string,
-    is_node_under_maintenance: boolean,
+    server_owner: boolean
+    identifier: string
+    internal_id?: number
+    uuid: string
+    name: string
+    node: string
+    is_node_under_maintenance: boolean
     sftp_details: {
-        ip: string,
-        alias: Nullable<string>,
+        ip: string
+        alias: Nullable<string>
         port: number
-    },
-    description: string,
-    limits: ServerLimits,
-    invocation: string,
-    docker_image: string,
-    egg_features: Nullable<string[]>,
-    feature_limits: FeatureLimits,
-    status: Nullable<unknown>,
-    is_suspended: boolean,
-    is_installing: boolean,
-    is_transferring: boolean,
+    }
+    description: string
+    limits: ServerLimits
+    invocation: string
+    docker_image: string
+    egg_features: Nullable<string[]>
+    feature_limits: FeatureLimits
+    status: Nullable<unknown>
+    is_suspended: boolean
+    is_installing: boolean
+    is_transferring: boolean
     relationships: {
-        allocations: GenericListResponse<GenericResponse<ServerAllocation, "allocation">>,
-        variables: GenericListResponse<GenericResponse<EggVariable, "egg_variable">>,
-        egg?: GenericResponse<{
-            uuid: string,
-            name: string
-        }, "egg">,
-        subusers?: GenericListResponse<GenericResponse<ServerSubuser, "server_subuser">>
+        allocations: GenericListResponse<
+            GenericResponse<ServerAllocation, "allocation">
+        >
+        variables: GenericListResponse<
+            GenericResponse<EggVariable, "egg_variable">
+        >
+        egg?: GenericResponse<
+            {
+                uuid: string
+                name: string
+            },
+            "egg"
+        >
+        subusers?: GenericListResponse<
+            GenericResponse<ServerSubuser, "server_subuser">
+        >
     }
 }
 
-
 export type ServerStats = {
-    current_state: "installing" | "install_failed" | "reinstall_failed" | "suspended"
-        | "restoring_backup" | "running" | "stopped" | "offline",
-    is_suspended: boolean,
+    current_state:
+        | "installing"
+        | "install_failed"
+        | "reinstall_failed"
+        | "suspended"
+        | "restoring_backup"
+        | "running"
+        | "stopped"
+        | "offline"
+    is_suspended: boolean
     resources: ServerResources
 }
 
 type ServerResources = {
-    memory_bytes: number,
-    cpu_absolute: number,
-    disk_bytes: number,
-    network_tx_bytes: number,
-    network_rx_bytes: number,
+    memory_bytes: number
+    cpu_absolute: number
+    disk_bytes: number
+    network_tx_bytes: number
+    network_rx_bytes: number
     uptime: number
 }
 export type ServerActivityLog = {
-    id: string,
-    event: string,
-    is_api: boolean,
-    ip: string,
-    description: Nullable<string>,
-    properties: Record<string, string>,
-    has_additional_metadata: boolean,
+    id: string
+    event: string
+    is_api: boolean
+    ip: string
+    description: Nullable<string>
+    properties: Record<string, string>
+    has_additional_metadata: boolean
     timestamp: string
 }
-
-