@pelican.ts/sdk 0.4.0 → 0.4.1

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": boolean,
-    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

@@ -1,6 +1,6 @@
-import {Client as UserClient} from "@/api/client/client";
-import {Client as AppClient} from "@/api/application/client";
-import {Agent} from "@/api/base/request";
+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") {
@@ -14,4 +14,4 @@ export class PelicanAPIApplication extends AppClient {
         const ax = new Agent(url, token, "application", suffix)
         super(ax.requester)
     }
-}
+}

package/src/humane/Account.ts

@@ -1,21 +1,24 @@
-import type {Client} from "@/api/client/client";
-import type {User} from "@/api/client/types/user";
-
+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;
+    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
@@ -31,54 +34,40 @@ export class Account {
         this.updatedAt = new Date(user.updated_at)
     }
 
-    updateEmail = async (
-        newEmail: string,
-        password: string
-    ) => {
+    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)
+    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)
+    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)
+    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)
+    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)
+    deleteSshKey = async (fingerprint: string) =>
+        this.client.account.sshKeys.delete(fingerprint)
 
     get2faQR = async () => this.client.account.twoFactor.info()
 
-    enable2fa = async (
-        code: string
-    ) => {
+    enable2fa = async (code: string) => {
         const tokens = await this.client.account.twoFactor.enable(code)
         this.$has2faEnabled = true
         return tokens
     }
 
-    disable2fa = async (
-        password: string
-    ) => {
+    disable2fa = async (password: string) => {
         await this.client.account.twoFactor.disable(password)
         this.$has2faEnabled = false
     }
-}
+}

package/src/humane/Client.ts

@@ -1,7 +1,6 @@
-import type {Client as ClientT} from "@/api/client/client";
-import {Account} from "@/humane/Account";
-import {Server} from "@/humane/Server";
-
+import type { Client as ClientT } from "@/api/client/client"
+import { Account } from "@/humane/Account"
+import { Server } from "@/humane/Server"
 
 export class Client {
     private readonly client: ClientT
@@ -23,21 +22,23 @@ export class Client {
 
     listServers = async (
         opts: {
-            type?: "accessible" | "mine" | "admin" | "admin-all",
-            page?: number,
-            per_page?: number,
-            include?: ("egg" | "subusers")[],
-        } = {type: "accessible", page: 1, per_page: 50}
+            type?: "accessible" | "mine" | "admin" | "admin-all"
+            page?: number
+            per_page?: number
+            include?: ("egg" | "subusers")[]
+        } = { type: "accessible", page: 1, per_page: 50 },
     ) => {
-        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))
+        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: string,
-        include?: ("egg" | "subusers")[]
-    ) => {
+    getServer = async (uuid: string, include?: ("egg" | "subusers")[]) => {
         const server = await this.client.server(uuid).info(include)
         return new Server(this.client.server(uuid), server)
     }
-}
+}