@pelican.ts/sdk 0.4.13 → 0.4.15

package/CHANGELOG.md

@@ -0,0 +1,127 @@
+## 0.4.15
+## What's Changed
+### 📦 Other changes
+- (fix) Application API container docker_labels field
+
+## 0.4.14
+## What's Changed
+### 📦 Other changes
+- (feat) BREAKING: Changed new Client API keys delete route
+- (chore) fixed ci and autoreleaser
+
+
+## 0.4.13
+## What's Changed
+### 📦 Other changes
+- (fix) Fixed migration endpoint types
+
+## 0.4.12
+## What's Changed
+### 📦 Other changes
+- (chore) Fixed GitHub workflow
+- (fix) Fixed IP Alias field
+
+## 0.4.11
+## What's Changed
+### 📦 Other changes
+- (fix) Fixed UpdatedStartupSchema
+- (fix) Fixed changeDockerImage
+
+## 0.4.9
+## What's Changed
+### 📦 Other changes
+- (chore) Applied biome formatting for consistency
+- (fix) Fixed files directory context
+
+## 0.4.8
+## What's Changed
+### 📦 Other changes
+- (feat) BREAKING: Removed deprecated 2fa routes
+
+## 0.4.6
+
+0.4.1-0.4.5 were sacrificed to release gods
+
+## What's Changed
+### ✨ New Features
+- (feat) Added server file bulk actions (compress, rename, delete)
+
+### 📦 Other changes
+- (feat) Export humane classes
+- (fix) Fixed file compress return
+- (fix) Added missing methods from ServerBackup
+- (chore) Updated README to add examples and description
+
+## 0.4.0
+## What's Changed
+### ✨ New Features
+- (new) New stateful "humane client", api is moved into `@pelican.ts/sdk/api`
+- (feat) Added support for editing Docker labels via application API (doesn't supported at upstream)
+- (feat) Added support for editing user api keys via application API (doesn't supported at upstream)
+
+### 📦 Other changes
+- (fix) Server subusers invalid types
+- (fix) Fixed server environment type in CreateServerSchema
+- (fix) User list servers endpoint is incorrect
+- (fix) Fixed egg types and exported egg endpoint
+- (chore) Added biome formatter/linter
+
+## 0.3.2
+
+0.3.1 was sacrificed to release gods
+
+## What's Changed
+### 📦 Other changes
+- Fix typos
+- Updated .npmignore
+
+## What's Changed
+### ✨ New Features
+- Application API eggs endpoints
+- Application API mounts endpoints
+
+## 0.3.0
+## What's Changed
+### ✨ New Features
+- Application API eggs endpoints
+- Application API mounts endpoints
+
+## 0.2.5
+## What's Changed
+### ✨ New Features
+- Created `@pelican.ts/sdk/types` subpackage
+
+## 0.2.4
+## What's Changed
+### ✨ New Features
+- Application API database host endpoints
+- Application API roles endpoints
+
+### 📦 Other changes
+- Fix typos
+
+## 0.2.3
+
+0.2.2 was sacrificed to release gods
+
+## What's Changed
+### ✨ New Features
+- Application API account endpoints 
+- Application API nodes endpoints
+- Application API allocations endpoints
+- Application API servers endpoints
+- Application API server databases endpoints
+
+### 📦 Other changes
+- Fixed compatibility with Pelican (allocation and node types)
+
+## 0.2.1
+## What's Changed
+### 📦 Other changes
+- Added MIT license
+- Updated logo
+
+## 0.2.0
+## What's Changed
+### ✨ New Features
+- Initial NPM release

package/dist/api/index.d.mts

@@ -559,6 +559,7 @@ type Container = {
     startup_command: string;
     image: string;
     installed: number;
+    docker_labels: Record<string, string>;
     environment: Record<string, string>;
     ports: number[];
     volumes: string[];
@@ -573,7 +574,6 @@ type ApplicationServer = {
     name: string;
     description: string;
     status: Nullable<unknown>;
-    docker_labels: Record<string, string>;
     suspended: boolean;
     limits: ServerLimits;
     feature_limits: FeatureLimits;

package/dist/api/index.d.ts

@@ -559,6 +559,7 @@ type Container = {
     startup_command: string;
     image: string;
     installed: number;
+    docker_labels: Record<string, string>;
     environment: Record<string, string>;
     ports: number[];
     volumes: string[];
@@ -573,7 +574,6 @@ type ApplicationServer = {
     name: string;
     description: string;
     status: Nullable<unknown>;
-    docker_labels: Record<string, string>;
     suspended: boolean;
     limits: ServerLimits;
     feature_limits: FeatureLimits;

package/dist/api/index.js

@@ -81,7 +81,7 @@ var Account = class {
       return data.attributes;
     },
     delete: async (fingerprint) => {
-      await this.r.post(`/account/ssh-keys/remove`, { fingerprint });
+      await this.r.delete(`/account/ssh-keys/${fingerprint}`);
     }
   };
 };

package/dist/api/index.mjs

@@ -44,7 +44,7 @@ var Account = class {
       return data.attributes;
     },
     delete: async (fingerprint) => {
-      await this.r.post(`/account/ssh-keys/remove`, { fingerprint });
+      await this.r.delete(`/account/ssh-keys/${fingerprint}`);
     }
   };
 };

package/dist/index.d.mts

@@ -1,7 +1,17 @@
 import { AxiosInstance } from 'axios';
 import WebSocket from 'isomorphic-ws';
 
-type ServerSignalOption = "start" | "stop" | "restart" | "kill";
+type FileObject = {
+    name: string;
+    mode: string;
+    mode_bits: string;
+    size: number;
+    is_file: boolean;
+    is_symlink: boolean;
+    mimetype: string;
+    created_at: string;
+    modified_at: string;
+};
 
 type GenericResponse<T, N extends string = string, M = undefined> = {
     object: N;
@@ -49,6 +59,20 @@ type ServerDatabase$1 = {
 type PartialBy<T, K extends keyof T> = Omit<T, K> & Partial<Pick<T, K>>;
 type Nullable<T> = T | null;
 
+type ServerBackup$1 = {
+    uuid: string;
+    is_successful: boolean;
+    is_locked: boolean;
+    name: string;
+    ignored_files: string[];
+    checksum: Nullable<string>;
+    bytes: number;
+    created_at: string;
+    completed_at: Nullable<string>;
+};
+
+type ServerSignalOption = "start" | "stop" | "restart" | "kill";
+
 type ServerLimits = {
     memory: number;
     swap: number;
@@ -79,40 +103,6 @@ type StartupMeta = {
     raw_startup_command: string;
 };
 
-type ServerBackup$1 = {
-    uuid: string;
-    is_successful: boolean;
-    is_locked: boolean;
-    name: string;
-    ignored_files: string[];
-    checksum: Nullable<string>;
-    bytes: number;
-    created_at: string;
-    completed_at: Nullable<string>;
-};
-
-type EggVariable = {
-    name: string;
-    description: string;
-    env_variable: string;
-    default_value: string;
-    server_value: string;
-    is_editable: boolean;
-    rules: string;
-};
-
-type FileObject = {
-    name: string;
-    mode: string;
-    mode_bits: string;
-    size: number;
-    is_file: boolean;
-    is_symlink: boolean;
-    mimetype: string;
-    created_at: string;
-    modified_at: string;
-};
-
 type Schedule = {
     id: number;
     name: string;
@@ -145,110 +135,14 @@ type ScheduleTask = {
     updated_at: Nullable<string>;
 };
 
-type SocketEventPayloadMap = {
-    [SOCKET_EVENT.AUTH_SUCCESS]: undefined;
-    [SOCKET_EVENT.STATUS]: PowerState;
-    [SOCKET_EVENT.CONSOLE_OUTPUT]: string;
-    [SOCKET_EVENT.STATS]: StatsWsJson;
-    [SOCKET_EVENT.DAEMON_ERROR]: undefined;
-    [SOCKET_EVENT.DAEMON_MESSAGE]: string;
-    [SOCKET_EVENT.INSTALL_OUTPUT]: string;
-    [SOCKET_EVENT.INSTALL_STARTED]: undefined;
-    [SOCKET_EVENT.INSTALL_COMPLETED]: undefined;
-    [SOCKET_EVENT.TRANSFER_LOGS]: string;
-    [SOCKET_EVENT.TRANSFER_STATUS]: string;
-    [SOCKET_EVENT.BACKUP_COMPLETED]: BackupCompletedJson;
-    [SOCKET_EVENT.BACKUP_RESTORE_COMPLETED]: undefined;
-    [SOCKET_EVENT.TOKEN_EXPIRING]: undefined;
-    [SOCKET_EVENT.TOKEN_EXPIRED]: undefined;
-    [SOCKET_EVENT.JWT_ERROR]: string;
-};
-type Listener<E extends SOCKET_EVENT> = SocketEventPayloadMap[E] extends undefined ? () => void : (payload: SocketEventPayloadMap[E]) => void;
-type CloseEventLike = Parameters<NonNullable<WebSocket["onclose"]>>[0];
-type ErrorEventLike = Parameters<NonNullable<WebSocket["onerror"]>>[0];
-declare class ServerWebsocket {
-    private readonly r;
-    private readonly serverId;
-    private socket?;
-    private currentToken?;
-    private readonly bus;
-    private debugLogging;
-    private stripColors;
-    private detachMessageListener?;
-    constructor(requester: AxiosInstance, id: string, stripColors?: boolean);
-    on<E extends SOCKET_EVENT>(event: E, listener: Listener<E>): () => void;
-    deregister<E extends SOCKET_EVENT>(event: E, listener: Listener<E>): void;
-    private emit;
-    connect(resumable?: boolean, debugLogging?: boolean): Promise<void>;
-    onSocketDisconnect(handler: (event: CloseEventLike) => void): void;
-    onSocketError(handler: (event: ErrorEventLike) => void): void;
-    makeResumable(disconnectsToo: boolean): void;
-    private attachMessageListener;
-    private handleIncomingMessage;
-    private parseMessage;
-    private normalisePayload;
-    private dispatchMessage;
-    private refreshCredentials;
-    private authenticate;
-    disconnect(): void;
-    requestStats(): void;
-    requestLogs(): void;
-    private send;
-    getStats(): Promise<StatsWsJson>;
-    getLogs(): Promise<string[]>;
-    sendPoweraction(action: ServerSignalOption): void;
-    sendCommand(cmd: string): void;
-}
-
-/**
- * Source: https://github.com/pterodactyl/panel/blob/1.0-develop/resources/scripts/components/server/events.ts
- */
-declare 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"
-}
-type BackupCompletedJson = {
-    checksum: string;
-    checksum_type: "sha1";
-    file_size: number;
-    is_successful: boolean;
-    uuid: string;
-};
-type PowerState = "starting" | "stopping" | "running" | "offline";
-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;
-};
-
-type ServerAllocation$1 = {
-    id: number;
-    ip: string;
-    ip_alias: Nullable<string>;
-    port: number;
-    notes: Nullable<string>;
-    is_default: boolean;
+type EggVariable = {
+    name: string;
+    description: string;
+    env_variable: string;
+    default_value: string;
+    server_value: string;
+    is_editable: boolean;
+    rules: string;
 };
 
 type ServerSubuser = {
@@ -265,6 +159,15 @@ type ServerSubuser = {
 };
 type SubuserPermission = "activity.read" | "allocation.create" | "allocation.delete" | "allocation.read" | "allocation.update" | "backup.create" | "backup.delete" | "backup.download" | "backup.read" | "backup.restore" | "control.console" | "control.restart" | "control.start" | "control.stop" | "database.create" | "database.delete" | "database.read" | "database.update" | "database.view-password" | "file.archive" | "file.create" | "file.delete" | "file.read" | "file.read-content" | "file.sftp" | "file.update" | "schedule.create" | "schedule.delete" | "schedule.read" | "schedule.update" | "settings.description" | "settings.reinstall" | "settings.rename" | "startup.docker-image" | "startup.read" | "startup.update" | "user.create" | "user.delete" | "user.read" | "user.update" | "websocket.connect";
 
+type ServerAllocation$1 = {
+    id: number;
+    ip: string;
+    ip_alias: Nullable<string>;
+    port: number;
+    notes: Nullable<string>;
+    is_default: boolean;
+};
+
 type Server$1 = {
     server_owner: boolean;
     identifier: string;
@@ -352,6 +255,103 @@ type Permission = {
     keys: Record<string, string>;
 };
 
+type SocketEventPayloadMap = {
+    [SOCKET_EVENT.AUTH_SUCCESS]: undefined;
+    [SOCKET_EVENT.STATUS]: PowerState;
+    [SOCKET_EVENT.CONSOLE_OUTPUT]: string;
+    [SOCKET_EVENT.STATS]: StatsWsJson;
+    [SOCKET_EVENT.DAEMON_ERROR]: undefined;
+    [SOCKET_EVENT.DAEMON_MESSAGE]: string;
+    [SOCKET_EVENT.INSTALL_OUTPUT]: string;
+    [SOCKET_EVENT.INSTALL_STARTED]: undefined;
+    [SOCKET_EVENT.INSTALL_COMPLETED]: undefined;
+    [SOCKET_EVENT.TRANSFER_LOGS]: string;
+    [SOCKET_EVENT.TRANSFER_STATUS]: string;
+    [SOCKET_EVENT.BACKUP_COMPLETED]: BackupCompletedJson;
+    [SOCKET_EVENT.BACKUP_RESTORE_COMPLETED]: undefined;
+    [SOCKET_EVENT.TOKEN_EXPIRING]: undefined;
+    [SOCKET_EVENT.TOKEN_EXPIRED]: undefined;
+    [SOCKET_EVENT.JWT_ERROR]: string;
+};
+type Listener<E extends SOCKET_EVENT> = SocketEventPayloadMap[E] extends undefined ? () => void : (payload: SocketEventPayloadMap[E]) => void;
+type CloseEventLike = Parameters<NonNullable<WebSocket["onclose"]>>[0];
+type ErrorEventLike = Parameters<NonNullable<WebSocket["onerror"]>>[0];
+declare class ServerWebsocket {
+    private readonly r;
+    private readonly serverId;
+    private socket?;
+    private currentToken?;
+    private readonly bus;
+    private debugLogging;
+    private stripColors;
+    private detachMessageListener?;
+    constructor(requester: AxiosInstance, id: string, stripColors?: boolean);
+    on<E extends SOCKET_EVENT>(event: E, listener: Listener<E>): () => void;
+    deregister<E extends SOCKET_EVENT>(event: E, listener: Listener<E>): void;
+    private emit;
+    connect(resumable?: boolean, debugLogging?: boolean): Promise<void>;
+    onSocketDisconnect(handler: (event: CloseEventLike) => void): void;
+    onSocketError(handler: (event: ErrorEventLike) => void): void;
+    makeResumable(disconnectsToo: boolean): void;
+    private attachMessageListener;
+    private handleIncomingMessage;
+    private parseMessage;
+    private normalisePayload;
+    private dispatchMessage;
+    private refreshCredentials;
+    private authenticate;
+    disconnect(): void;
+    requestStats(): void;
+    requestLogs(): void;
+    private send;
+    getStats(): Promise<StatsWsJson>;
+    getLogs(): Promise<string[]>;
+    sendPoweraction(action: ServerSignalOption): void;
+    sendCommand(cmd: string): void;
+}
+
+/**
+ * Source: https://github.com/pterodactyl/panel/blob/1.0-develop/resources/scripts/components/server/events.ts
+ */
+declare 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"
+}
+type BackupCompletedJson = {
+    checksum: string;
+    checksum_type: "sha1";
+    file_size: number;
+    is_successful: boolean;
+    uuid: string;
+};
+type PowerState = "starting" | "stopping" | "running" | "offline";
+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;
+};
+
 declare class Account$1 {
     private readonly r;
     constructor(requester: AxiosInstance);