@pelican.ts/sdk 0.3.4-next.4 → 0.4.1

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];
@@ -1151,7 +1151,7 @@ type Server = {
     limits: ServerLimits;
     invocation: string;
     docker_image: string;
-    egg_features: string[] | null;
+    egg_features: Nullable<string[]>;
     feature_limits: FeatureLimits;
     status: Nullable<unknown>;
     is_suspended: boolean;
@@ -1164,7 +1164,7 @@ type Server = {
             uuid: string;
             name: string;
         }, "egg">;
-        subusers: GenericListResponse<GenericResponse<ServerSubuser, "server_subuser">>;
+        subusers?: GenericListResponse<GenericResponse<ServerSubuser, "server_subuser">>;
     };
 };
 type ServerStats = {
@@ -1199,7 +1199,7 @@ type User = {
     image: string;
     admin: boolean;
     root_admin: boolean;
-    "2fa_enabled": number;
+    "2fa_enabled": boolean;
     created_at: string;
     updated_at: string;
 };

package/package.json

@@ -1,53 +1,64 @@
 {
-  "name": "@pelican.ts/sdk",
-  "version": "0.3.4-next.4",
-  "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"
+        }
     },
-    "./types": {
-      "types": "./dist/types.d.ts"
+    "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"
     }
-  },
-  "scripts": {
-    "build:code": "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:code && 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": "bun run generate-types && bun run build && bun run pub:next"
-  },
-  "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": {
-    "@types/node": "^22.18.12",
-    "@types/strip-color": "^0.1.2",
-    "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: string[] | null,
-    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
 }
-
-

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

@@ -1,35 +1,34 @@
-import {Nullable} from "@/utils/types";
+import { Nullable } from "@/utils/types"
 
 export type User = {
-    uuid: string,
-    username: string,
-    email: string,
+    uuid: string
+    username: string
+    email: string
     language: string
-    image: string,
-    admin: boolean,
-    root_admin: boolean,
-    "2fa_enabled": number,
-    created_at: string,
+    image: string
+    admin: boolean
+    root_admin: boolean
+    "2fa_enabled": boolean
+    created_at: string
     updated_at: string
-
 }
 
 export type APIKey = {
-    identifier: string,
-    description: string,
-    allowed_ips: string[],
-    last_used_at: Nullable<string>,
+    identifier: string
+    description: string
+    allowed_ips: string[]
+    last_used_at: Nullable<string>
     created_at: string
 }
 
 export type SSHKey = {
-    name: string,
-    fingerprint: string,
-    pubic_key: string,
+    name: string
+    fingerprint: string
+    pubic_key: string
     created_at: string
 }
 
 export type Permission = {
-    description: string,
+    description: string
     keys: Record<string, string>
-}
+}

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

@@ -3,13 +3,13 @@
  * @license MIT
  */
 
-export type ServerStatus = 'starting' | 'stopping' | 'online' | 'offline';
+export type ServerStatus = "starting" | "stopping" | "online" | "offline"
 
 export enum SERVER_SIGNAL {
-    'START' = 'start',
-    'STOP' = 'stop',
-    'RESTART' = 'restart',
-    'KILL' = 'kill',
+    START = "start",
+    STOP = "stop",
+    RESTART = "restart",
+    KILL = "kill",
 }
 
 export type WebsocketEvent =
@@ -28,101 +28,101 @@ export type WebsocketEvent =
     | TransferStatusEvent
     | BackupCompletedEvent
     | BackupRestoreCompletedEvent
-    | JwtErrorEvent;
+    | JwtErrorEvent
 
 /**
  * Source: https://github.com/pterodactyl/panel/blob/1.0-develop/resources/scripts/components/server/events.ts
  */
 export enum SOCKET_EVENT {
-    AUTH_SUCCESS = 'auth success',
-    DAEMON_MESSAGE = 'daemon message',
-    DAEMON_ERROR = 'daemon error',
-    INSTALL_OUTPUT = 'install output',
-    INSTALL_STARTED = 'install started',
-    INSTALL_COMPLETED = 'install completed',
-    CONSOLE_OUTPUT = 'console output',
-    STATUS = 'status',
-    STATS = 'stats',
-    TRANSFER_LOGS = 'transfer logs',
-    TRANSFER_STATUS = 'transfer status',
-    BACKUP_COMPLETED = 'backup completed',
-    BACKUP_RESTORE_COMPLETED = 'backup restore completed',
-    TOKEN_EXPIRING = 'token expiring',
-    TOKEN_EXPIRED = 'token expired',
-    JWT_ERROR = 'jwt error',
+    AUTH_SUCCESS = "auth success",
+    DAEMON_MESSAGE = "daemon message",
+    DAEMON_ERROR = "daemon error",
+    INSTALL_OUTPUT = "install output",
+    INSTALL_STARTED = "install started",
+    INSTALL_COMPLETED = "install completed",
+    CONSOLE_OUTPUT = "console output",
+    STATUS = "status",
+    STATS = "stats",
+    TRANSFER_LOGS = "transfer logs",
+    TRANSFER_STATUS = "transfer status",
+    BACKUP_COMPLETED = "backup completed",
+    BACKUP_RESTORE_COMPLETED = "backup restore completed",
+    TOKEN_EXPIRING = "token expiring",
+    TOKEN_EXPIRED = "token expired",
+    JWT_ERROR = "jwt error",
 }
 
 export type InstallOutputEvent = {
-    event: SOCKET_EVENT.INSTALL_OUTPUT;
-    args: [string];
-};
+    event: SOCKET_EVENT.INSTALL_OUTPUT
+    args: [string]
+}
 
 export type InstallStartedEvent = {
-    event: SOCKET_EVENT.INSTALL_STARTED;
-};
+    event: SOCKET_EVENT.INSTALL_STARTED
+}
 
 export type InstallCompletedEvent = {
-    event: SOCKET_EVENT.INSTALL_COMPLETED;
-};
+    event: SOCKET_EVENT.INSTALL_COMPLETED
+}
 
 export type TransferLogsEvent = {
-    event: SOCKET_EVENT.TRANSFER_LOGS;
-    args: [string];
-};
+    event: SOCKET_EVENT.TRANSFER_LOGS
+    args: [string]
+}
 
 export type TransferStatusEvent = {
-    event: SOCKET_EVENT.TRANSFER_STATUS;
-    args: [string];
-};
+    event: SOCKET_EVENT.TRANSFER_STATUS
+    args: [string]
+}
 
 export type BackupCompletedEvent = {
-    event: SOCKET_EVENT.BACKUP_COMPLETED;
-    args: [string];
-};
+    event: SOCKET_EVENT.BACKUP_COMPLETED
+    args: [string]
+}
 
 export type BackupCompletedJson = {
-    checksum: string;
-    checksum_type: 'sha1';
-    file_size: number;
-    is_successful: boolean;
-    uuid: string;
-};
+    checksum: string
+    checksum_type: "sha1"
+    file_size: number
+    is_successful: boolean
+    uuid: string
+}
 
 export type BackupRestoreCompletedEvent = {
-    event: SOCKET_EVENT.BACKUP_RESTORE_COMPLETED;
-};
+    event: SOCKET_EVENT.BACKUP_RESTORE_COMPLETED
+}
 
 export type AuthSuccessWsEvent = {
-    event: SOCKET_EVENT.AUTH_SUCCESS;
-};
+    event: SOCKET_EVENT.AUTH_SUCCESS
+}
 
-export type StatusWsEvent = { event: SOCKET_EVENT.STATUS; args: [PowerState] };
+export type StatusWsEvent = { event: SOCKET_EVENT.STATUS; args: [PowerState] }
 
-export type PowerState = 'starting' | 'stopping' | 'running' | 'offline';
+export type PowerState = "starting" | "stopping" | "running" | "offline"
 
 export type ConsoleLogWsEvent = {
-    event: SOCKET_EVENT.CONSOLE_OUTPUT;
-    args: [string];
-};
+    event: SOCKET_EVENT.CONSOLE_OUTPUT
+    args: [string]
+}
 
 export type StatsWsEvent = {
-    event: SOCKET_EVENT.STATS;
-    args: [string];
-};
+    event: SOCKET_EVENT.STATS
+    args: [string]
+}
 
 export type StatsWsJson = {
-    memory_bytes: number;
-    memory_limit_bytes: number;
-    cpu_absolute: number;
-    network: { rx_bytes: number; tx_bytes: number };
-    state: PowerState;
-    uptime: number;
-    disk_bytes: number;
-};
+    memory_bytes: number
+    memory_limit_bytes: number
+    cpu_absolute: number
+    network: { rx_bytes: number; tx_bytes: number }
+    state: PowerState
+    uptime: number
+    disk_bytes: number
+}
 
-export type TokenExpiringWsEvent = { event: SOCKET_EVENT.TOKEN_EXPIRING };
+export type TokenExpiringWsEvent = { event: SOCKET_EVENT.TOKEN_EXPIRING }
 
-export type TokenExpiredWsEvent = { event: SOCKET_EVENT.TOKEN_EXPIRED };
+export type TokenExpiredWsEvent = { event: SOCKET_EVENT.TOKEN_EXPIRED }
 
 /**
  * Example:
@@ -133,18 +133,18 @@ export type TokenExpiredWsEvent = { event: SOCKET_EVENT.TOKEN_EXPIRED };
  * {"event":"daemon message","args":["Completed server restoration from local backup."]}
  */
 export type DaemonMessageEvent = {
-    event: SOCKET_EVENT.DAEMON_MESSAGE;
-    args: [string];
-};
+    event: SOCKET_EVENT.DAEMON_MESSAGE
+    args: [string]
+}
 
 export type DaemonErrorEvent = {
-    event: SOCKET_EVENT.DAEMON_ERROR;
-    args: [string];
-};
+    event: SOCKET_EVENT.DAEMON_ERROR
+    args: [string]
+}
 
 export type JwtErrorEvent = {
-    event: SOCKET_EVENT.JWT_ERROR;
-    args: [string];
-};
+    event: SOCKET_EVENT.JWT_ERROR
+    args: [string]
+}
 
-export {ServerWebsocket} from "@/api/client/server_websocket";
+export { ServerWebsocket } from "@/api/client/server_websocket"

package/src/api/index.ts

@@ -0,0 +1,17 @@
+import { Client as UserClient } from "@/api/client/client"
+import { Client as AppClient } from "@/api/application/client"
+import { Agent } from "@/api/base/request"
+
+export class PelicanAPIClient extends UserClient {
+    constructor(url: string, token: string, suffix: string = "/api") {
+        const ax = new Agent(url, token, "client", suffix)
+        super(ax.requester)
+    }
+}
+
+export class PelicanAPIApplication extends AppClient {
+    constructor(url: string, token: string, suffix: string = "/api") {
+        const ax = new Agent(url, token, "application", suffix)
+        super(ax.requester)
+    }
+}

package/src/humane/Account.ts

@@ -0,0 +1,73 @@
+import type { Client } from "@/api/client/client"
+import type { User } from "@/api/client/types/user"
+
+export class Account {
+    private readonly client: Client
+    readonly uuid: string
+    readonly username: string
+    private $email: string
+    get email() {
+        return this.$email
+    }
+    readonly language: string
+    readonly image: string
+    readonly admin: boolean
+    readonly root_admin: boolean
+    private $has2faEnabled: boolean
+    get has2faEnabled() {
+        return this.$has2faEnabled
+    }
+    readonly createdAt: Date
+    readonly updatedAt: Date
+
+    constructor(client: Client, user: User) {
+        this.client = client
+        this.uuid = user.uuid
+        this.username = user.username
+        this.$email = user.email
+        this.language = user.language
+        this.image = user.image
+        this.admin = user.admin
+        this.root_admin = user.root_admin
+        this.$has2faEnabled = user["2fa_enabled"]
+        this.createdAt = new Date(user.created_at)
+        this.updatedAt = new Date(user.updated_at)
+    }
+
+    updateEmail = async (newEmail: string, password: string) => {
+        await this.client.account.updateEmail(newEmail, password)
+        this.$email = newEmail
+    }
+
+    updatePassword = async (newPassword: string) =>
+        this.client.account.updatePassword(newPassword)
+
+    listApiKeys = async () => this.client.account.apiKeys.list()
+
+    createApiKey = async (description: string, allowed_ips?: string[]) =>
+        this.client.account.apiKeys.create(description, allowed_ips)
+
+    deleteApiKey = async (identifier: string) =>
+        this.client.account.apiKeys.delete(identifier)
+
+    listSshKeys = async () => this.client.account.sshKeys.list()
+
+    createSshKey = async (name: string, public_key: string) =>
+        this.client.account.sshKeys.create(name, public_key)
+
+    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
+    }
+}