@pelican.ts/sdk 0.4.8 → 0.4.10

package/src/api/base/types.ts

@@ -1,30 +1,25 @@
 export type GenericResponse<T, N extends string = string, M = undefined> = {
-    object: N,
-    attributes: T,
+    object: N
+    attributes: T
     meta?: M
 }
 
 type PaginationMeta = {
-    total: number,
-    count: number,
-    per_page: number,
-    current_page: number,
-    total_pages: number,
+    total: number
+    count: number
+    per_page: number
+    current_page: number
+    total_pages: number
     links: any
 }
 
 export type GenericListResponse<T> = {
-    object: "list",
-    data: T[],
-    meta?: { pagination: PaginationMeta }
-}
-
-export type CustomListResponse<T, M> = {
-    object: "list",
-    data: T[],
-    meta?: M
+    object: "list"
+    data: T[]
+    meta?: {pagination: PaginationMeta}
 }
 
+export type CustomListResponse<T, M> = {object: "list"; data: T[]; meta?: M}
 
 export class PterodactylException extends Error {
     data: PterodactylError[]
@@ -38,10 +33,8 @@ export class PterodactylException extends Error {
 }
 
 export type PterodactylError = {
-    code: string,
-    status?: number,
-    detail: string,
-    source?: {
-        [key: string]: string
-    }
-}
+    code: string
+    status?: number
+    detail: string
+    source?: {[key: string]: string}
+}

package/src/api/client/account.ts

@@ -1,8 +1,7 @@
-import {AxiosInstance} from "axios";
-import {APIKey, SSHKey, User} from "@/api/client/types/user";
-import {GenericListResponse, GenericResponse} from "@/api/base/types";
-import z from "zod";
-
+import {AxiosInstance} from "axios"
+import {APIKey, SSHKey, User} from "@/api/client/types/user"
+import {GenericListResponse, GenericResponse} from "@/api/base/types"
+import z from "zod"
 
 export class Account {
     private readonly r: AxiosInstance
@@ -12,7 +11,8 @@ export class Account {
     }
 
     info = async (): Promise<User> => {
-        const {data} = await this.r.get<GenericResponse<User, "user">>("/account")
+        const {data} =
+            await this.r.get<GenericResponse<User, "user">>("/account")
         return data.attributes
     }
 
@@ -31,16 +31,20 @@ export class Account {
 
     apiKeys = {
         list: async (): Promise<APIKey[]> => {
-            const {data} = await this.r.get<
-                GenericListResponse<GenericResponse<APIKey, "api_key">>
-            >("/account/api-keys")
+            const {data} =
+                await this.r.get<
+                    GenericListResponse<GenericResponse<APIKey, "api_key">>
+                >("/account/api-keys")
             return data.data.map(k => k.attributes)
         },
 
-        create: async (description: string, allowed_ips?: string[]): Promise<APIKey & { secret_token: string }> => {
+        create: async (
+            description: string,
+            allowed_ips?: string[]
+        ): Promise<APIKey & {secret_token: string}> => {
             allowed_ips = z.array(z.ipv4()).optional().parse(allowed_ips)
             const {data} = await this.r.post<
-                GenericResponse<APIKey, "api_key", { secret_token: string }>
+                GenericResponse<APIKey, "api_key", {secret_token: string}>
             >("/account/api-keys", {description, allowed_ips})
             return {...data.attributes, secret_token: data.meta!.secret_token}
         },
@@ -52,9 +56,10 @@ export class Account {
 
     sshKeys = {
         list: async (): Promise<SSHKey[]> => {
-            const {data} = await this.r.get<
-                GenericListResponse<GenericResponse<SSHKey, "ssh_key">>
-            >("/account/ssh-keys")
+            const {data} =
+                await this.r.get<
+                    GenericListResponse<GenericResponse<SSHKey, "ssh_key">>
+                >("/account/ssh-keys")
             return data.data.map(k => k.attributes)
         },
 
@@ -69,4 +74,4 @@ export class Account {
             await this.r.post(`/account/ssh-keys/remove`, {fingerprint})
         }
     }
-}
+}

package/src/api/client/client.ts

@@ -1,11 +1,10 @@
-import {Account} from "@/api/client/account";
-import {AxiosInstance} from "axios";
-import {Permission} from "@/api/client/types/user";
-import {GenericListResponse, GenericResponse} from "@/api/base/types";
-import {Server} from "@/api/client/types/server";
-import z from "zod";
-import {ServerClient} from "@/api/client/server";
-
+import {Account} from "@/api/client/account"
+import {AxiosInstance} from "axios"
+import {Permission} from "@/api/client/types/user"
+import {GenericListResponse, GenericResponse} from "@/api/base/types"
+import {Server} from "@/api/client/types/server"
+import z from "zod"
+import {ServerClient} from "@/api/client/server"
 
 export class Client {
     account: Account
@@ -22,9 +21,13 @@ export class Client {
     }
 
     listPermissions = async (): Promise<Record<string, Permission>> => {
-        const {data} = await this.r.get<
-            GenericResponse<{ permissions: Record<string, Permission> }, "system_permissions">
-        >("/permissions")
+        const {data} =
+            await this.r.get<
+                GenericResponse<
+                    {permissions: Record<string, Permission>},
+                    "system_permissions"
+                >
+            >("/permissions")
 
         return data.attributes.permissions
     }
@@ -33,25 +36,21 @@ export class Client {
         type: "accessible" | "mine" | "admin" | "admin-all" = "accessible",
         page: number = 1,
         per_page: number = 50,
-        include?: ("egg" | "subusers")[],
+        include?: ("egg" | "subusers")[]
     ): Promise<Server[]> => {
         z.number().positive().parse(page)
         const {data} = await this.r.get<
             GenericListResponse<GenericResponse<Server, "server">>
-        >("/", {
-            params: {type, page, include: include?.join(",")}
-        })
+        >("/", {params: {type, page, include: include?.join(",")}})
         return data.data.map(s => s.attributes)
     }
 
     server = (uuid: string): ServerClient => new ServerClient(this.r, uuid)
-
 }
 
-
 /*
 Include:    ?include=param1,param2
 Avail:      ?param1=val1&param2=val2
 Filters:    ?filter[param1]=val1&filter[param2]=val2
 Sort:       ?sort=-param, param=asc, -param=desc
-*/
+*/

package/src/api/client/server.ts

@@ -1,17 +1,16 @@
-import {AxiosInstance} from "axios";
-import {GenericResponse} from "@/api/base/types";
-import {Server, ServerStats} from "@/api/client/types/server";
-import {ServerDatabases} from "@/api/client/server_databases";
-import {ServerFiles} from "@/api/client/server_files";
-import {ServerSchedules} from "@/api/client/server_schedules";
-import {ServerAllocations} from "@/api/client/server_allocations";
-import {ServerUsers} from "@/api/client/server_users";
-import {ServerBackups} from "@/api/client/server_backups";
-import {ServerStartup} from "@/api/client/server_startup";
-import {ServerSettings} from "@/api/client/server_settings";
-import {ServerWebsocket} from "@/api/client/server_websocket";
-import {ServerActivity} from "@/api/client/server_activity";
-
+import {AxiosInstance} from "axios"
+import {GenericResponse} from "@/api/base/types"
+import {Server, ServerStats} from "@/api/client/types/server"
+import {ServerDatabases} from "@/api/client/server_databases"
+import {ServerFiles} from "@/api/client/server_files"
+import {ServerSchedules} from "@/api/client/server_schedules"
+import {ServerAllocations} from "@/api/client/server_allocations"
+import {ServerUsers} from "@/api/client/server_users"
+import {ServerBackups} from "@/api/client/server_backups"
+import {ServerStartup} from "@/api/client/server_startup"
+import {ServerSettings} from "@/api/client/server_settings"
+import {ServerWebsocket} from "@/api/client/server_websocket"
+import {ServerActivity} from "@/api/client/server_activity"
 
 export class ServerClient {
     private readonly r: AxiosInstance
@@ -45,9 +44,10 @@ export class ServerClient {
     }
 
     info = async (include?: ("egg" | "subusers")[]): Promise<Server> => {
-        const {data} = await this.r.get<GenericResponse<Server, "server">>(`/servers/${this.id}`, {
-            params: {include: include?.join(",")}
-        })
+        const {data} = await this.r.get<GenericResponse<Server, "server">>(
+            `/servers/${this.id}`,
+            {params: {include: include?.join(",")}}
+        )
         return data.attributes
     }
 
@@ -56,7 +56,9 @@ export class ServerClient {
     }
 
     resources = async (): Promise<ServerStats> => {
-        const {data} = await this.r.get<GenericResponse<ServerStats, "stats">>(`/servers/${this.id}/resources`)
+        const {data} = await this.r.get<GenericResponse<ServerStats, "stats">>(
+            `/servers/${this.id}/resources`
+        )
         return data.attributes
     }
 
@@ -64,7 +66,9 @@ export class ServerClient {
         await this.r.post(`/servers/${this.id}/command`, {command})
     }
 
-    power = async (signal: "start" | "stop" | "restart" | "kill"): Promise<void> => {
+    power = async (
+        signal: "start" | "stop" | "restart" | "kill"
+    ): Promise<void> => {
         await this.r.post(`/servers/${this.id}/power`, {signal})
     }
-}
+}

package/src/api/client/server_activity.ts

@@ -1,6 +1,6 @@
-import {AxiosInstance} from "axios";
-import {ServerActivityLog} from "@/api/client/types/server";
-import {GenericListResponse, GenericResponse} from "@/api/base/types";
+import {AxiosInstance} from "axios"
+import {ServerActivityLog} from "@/api/client/types/server"
+import {GenericListResponse, GenericResponse} from "@/api/base/types"
 
 export class ServerActivity {
     private readonly r: AxiosInstance
@@ -13,14 +13,13 @@ export class ServerActivity {
 
     list = async (
         page: number = 1,
-        per_page: number = 25,
+        per_page: number = 25
     ): Promise<ServerActivityLog[]> => {
-        const {data} = await this.r.get<GenericListResponse<GenericResponse<ServerActivityLog, "activity_log">>>(`/server/${this.id}/activity`, {
-            params: {
-                page,
-                per_page,
-            },
-        })
+        const {data} = await this.r.get<
+            GenericListResponse<
+                GenericResponse<ServerActivityLog, "activity_log">
+            >
+        >(`/server/${this.id}/activity`, {params: {page, per_page}})
         return data.data.map(log => log.attributes)
     }
-}
+}

package/src/api/client/server_allocations.ts

@@ -1,6 +1,6 @@
-import {AxiosInstance} from "axios";
-import {GenericListResponse, GenericResponse} from "@/api/base/types";
-import {ServerAllocation} from "@/api/client/types/server_allocation";
+import {AxiosInstance} from "axios"
+import {GenericListResponse, GenericResponse} from "@/api/base/types"
+import {ServerAllocation} from "@/api/client/types/server_allocation"
 
 export class ServerAllocations {
     private readonly r: AxiosInstance
@@ -25,7 +25,10 @@ export class ServerAllocations {
         return data.attributes
     }
 
-    setNotes = async (alloc_id: number, notes: string): Promise<ServerAllocation> => {
+    setNotes = async (
+        alloc_id: number,
+        notes: string
+    ): Promise<ServerAllocation> => {
         const {data} = await this.r.post<
             GenericResponse<ServerAllocation, "allocation">
         >(`/servers/${this.id}/network/allocations/${alloc_id}`, {notes})
@@ -40,6 +43,8 @@ export class ServerAllocations {
     }
 
     unassign = async (alloc_id: number): Promise<void> => {
-        await this.r.delete(`/servers/${this.id}/network/allocations/${alloc_id}`)
+        await this.r.delete(
+            `/servers/${this.id}/network/allocations/${alloc_id}`
+        )
     }
-}
+}

package/src/api/client/server_backups.ts

@@ -1,8 +1,7 @@
-import axios, {AxiosInstance} from "axios";
-import {ServerBackup} from "@/api/common/types/server_backup";
-import z, {string} from "zod";
-import {GenericListResponse, GenericResponse} from "@/api/base/types";
-
+import axios, {AxiosInstance} from "axios"
+import {ServerBackup} from "@/api/common/types/server_backup"
+import z, {string} from "zod"
+import {GenericListResponse, GenericResponse} from "@/api/base/types"
 
 export class ServerBackups {
     private readonly r: AxiosInstance
@@ -17,17 +16,15 @@ export class ServerBackups {
         z.number().positive().parse(page)
         const {data} = await this.r.get<
             GenericListResponse<GenericResponse<ServerBackup, "backup">>
-        >(`/servers/${this.id}/backups`, {
-            params: {page}
-        })
+        >(`/servers/${this.id}/backups`, {params: {page}})
 
-        return data.data.map(d=>d.attributes)
+        return data.data.map(d => d.attributes)
     }
 
     create = async (args: {
-        name?: string,
-        is_locked: boolean,
-        ignored_files: string[],
+        name?: string
+        is_locked: boolean
+        ignored_files: string[]
     }): Promise<ServerBackup> => {
         args.name = z.string().max(255).optional().parse(args.name)
         const {data} = await this.r.post<
@@ -49,14 +46,16 @@ export class ServerBackups {
 
     downloadGetUrl = async (backup_uuid: string): Promise<string> => {
         const {data} = await this.r.get<
-            GenericResponse<{ url: string }, "signed_url">
+            GenericResponse<{url: string}, "signed_url">
         >(`/servers/${this.id}/backups/${backup_uuid}/download`)
         return data.attributes.url
     }
 
     download = async (backup_uuid: string): Promise<ArrayBuffer> => {
         const url = await this.downloadGetUrl(backup_uuid)
-        const {data} = await axios.get<ArrayBuffer>(url, {responseType: "arraybuffer"})
+        const {data} = await axios.get<ArrayBuffer>(url, {
+            responseType: "arraybuffer"
+        })
         return data
     }
 
@@ -65,7 +64,9 @@ export class ServerBackups {
     }
 
     rename = async (backup_uuid: string, name: string): Promise<void> => {
-        await this.r.put(`/servers/${this.id}/backups/${backup_uuid}/rename`, {name})
+        await this.r.put(`/servers/${this.id}/backups/${backup_uuid}/rename`, {
+            name
+        })
     }
 
     toggleLock = async (backup_uuid: string): Promise<void> => {
@@ -73,6 +74,9 @@ export class ServerBackups {
     }
 
     restore = async (backup_uuid: string, truncate: boolean): Promise<void> => {
-        await this.r.post(`/servers/${this.id}/backups/${backup_uuid}/restore`, {truncate})
+        await this.r.post(
+            `/servers/${this.id}/backups/${backup_uuid}/restore`,
+            {truncate}
+        )
     }
-}
+}

package/src/api/client/server_databases.ts

@@ -1,7 +1,7 @@
-import {AxiosInstance} from "axios";
-import z from "zod";
-import {GenericListResponse, GenericResponse} from "@/api/base/types";
-import {ServerDatabase} from "@/api/common/types/server_database";
+import {AxiosInstance} from "axios"
+import z from "zod"
+import {GenericListResponse, GenericResponse} from "@/api/base/types"
+import {ServerDatabase} from "@/api/common/types/server_database"
 // TODO: Check for validity
 
 export class ServerDatabases {
@@ -14,18 +14,24 @@ export class ServerDatabases {
     }
 
     list = async (
-        include?: ("password")[], page: number = 1
+        include?: "password"[],
+        page: number = 1
     ): Promise<ServerDatabase[]> => {
         z.number().positive().parse(page)
         const {data} = await this.r.get<
-            GenericListResponse<GenericResponse<ServerDatabase, "server_database">>
+            GenericListResponse<
+                GenericResponse<ServerDatabase, "server_database">
+            >
         >(`/servers/${this.id}/databases`, {
             params: {include: include?.join(","), page}
         })
         return data.data.map(d => d.attributes)
     }
 
-    create = async (database: string, remote: string): Promise<ServerDatabase> => {
+    create = async (
+        database: string,
+        remote: string
+    ): Promise<ServerDatabase> => {
         const {data} = await this.r.post<
             GenericResponse<ServerDatabase, "server_database">
         >(`/servers/${this.id}/databases`, {database, remote})
@@ -42,4 +48,4 @@ export class ServerDatabases {
     delete = async (database_id: string): Promise<void> => {
         await this.r.delete(`/servers/${this.id}/databases/${database_id}`)
     }
-}
+}

package/src/api/client/server_files.ts

@@ -1,8 +1,7 @@
-import axios, {AxiosInstance} from "axios";
-import {string} from "zod";
-import {FileObject} from "@/api/common/types/server_files";
-import {GenericListResponse, GenericResponse} from "@/api/base/types";
-
+import axios, {AxiosInstance} from "axios"
+import {string} from "zod"
+import {FileObject} from "@/api/common/types/server_files"
+import {GenericListResponse, GenericResponse} from "@/api/base/types"
 
 export class ServerFiles {
     private readonly r: AxiosInstance
@@ -16,9 +15,7 @@ export class ServerFiles {
     list = async (path?: string): Promise<FileObject[]> => {
         const {data} = await this.r.get<
             GenericListResponse<GenericResponse<FileObject, "file_object">>
-        >(`/servers/${this.id}/files/list`, {
-            params: {directory: path}
-        })
+        >(`/servers/${this.id}/files/list`, {params: {directory: path}})
         return data.data.map(r => r.attributes)
     }
 
@@ -26,30 +23,31 @@ export class ServerFiles {
      * Return the contents of a file. To read binary file (non-editable) use {@link download} instead
      */
     contents = async (path: string): Promise<string> => {
-        const {data} = await this.r.get<string>(`/servers/${this.id}/files/contents`, {
-            params: {file: path}
-        })
+        const {data} = await this.r.get<string>(
+            `/servers/${this.id}/files/contents`,
+            {params: {file: path}}
+        )
         return data
     }
 
     downloadGetUrl = async (path: string): Promise<string> => {
         const {data} = await this.r.get<
-            GenericResponse<{ url: string }, "signed_url">
-        >(`/servers/${this.id}/files/download`, {
-            params: {file: path}
-        })
+            GenericResponse<{url: string}, "signed_url">
+        >(`/servers/${this.id}/files/download`, {params: {file: path}})
         return data.attributes.url
     }
 
     download = async (path: string): Promise<ArrayBuffer> => {
         const url = await this.downloadGetUrl(path)
-        const {data} = await axios.get<ArrayBuffer>(url, {responseType: "arraybuffer"})
+        const {data} = await axios.get<ArrayBuffer>(url, {
+            responseType: "arraybuffer"
+        })
         return data
     }
 
     rename = async (
         root: string = "/",
-        files: { from: string, to: string }[]
+        files: {from: string; to: string}[]
     ): Promise<void> => {
         await this.r.put(`/servers/${this.id}/files/rename`, {root, files})
     }
@@ -60,7 +58,7 @@ export class ServerFiles {
 
     write = async (path: string, content: string): Promise<void> => {
         await this.r.post(`/servers/${this.id}/files/write`, content, {
-            params: {file: path},
+            params: {file: path}
         })
     }
 
@@ -68,38 +66,44 @@ export class ServerFiles {
         root: string = "/",
         files: string[],
         archive_name?: string,
-        extension?: "zip" | "tgz" | "tar.gz" | "txz" | "tar.xz" | "tbz2" | "tar.bz2"
+        extension?:
+            | "zip"
+            | "tgz"
+            | "tar.gz"
+            | "txz"
+            | "tar.xz"
+            | "tbz2"
+            | "tar.bz2"
     ): Promise<FileObject> => {
         const {data} = await this.r.post<
             GenericResponse<FileObject, "file_object">
-        >(`/servers/${this.id}/files/compress`, {root, files, archive_name, extension})
+        >(`/servers/${this.id}/files/compress`, {
+            root,
+            files,
+            archive_name,
+            extension
+        })
         return data.attributes
     }
 
-    decompress = async (
-        root: string = "/",
-        file: string,
-    ): Promise<void> => {
+    decompress = async (root: string = "/", file: string): Promise<void> => {
         await this.r.post(`/servers/${this.id}/files/decompress`, {root, file})
     }
 
-    delete = async (
-        root: string = "/",
-        files: string[],
-    ): Promise<void> => {
+    delete = async (root: string = "/", files: string[]): Promise<void> => {
         await this.r.post(`/servers/${this.id}/files/delete`, {root, files})
     }
 
-    createFolder = async (
-        root: string = "/",
-        name: string,
-    ): Promise<void> => {
-        await this.r.post(`/servers/${this.id}/files/create-folder`, {root, name})
+    createFolder = async (root: string = "/", name: string): Promise<void> => {
+        await this.r.post(`/servers/${this.id}/files/create-folder`, {
+            root,
+            name
+        })
     }
 
     chmod = async (
         root: string = "/",
-        files: Array<{ file: string, mode: number }>
+        files: Array<{file: string; mode: number}>
     ): Promise<void> => {
         await this.r.post(`/servers/${this.id}/files/chmod`, {root, files})
     }
@@ -111,21 +115,31 @@ export class ServerFiles {
         use_header: boolean = false, // Unused
         foreground: boolean = false // Unused
     ): Promise<void> => {
-        await this.r.post(`/servers/${this.id}/files/pull`, {url, directory, filename, use_header, foreground})
+        await this.r.post(`/servers/${this.id}/files/pull`, {
+            url,
+            directory,
+            filename,
+            use_header,
+            foreground
+        })
     }
 
     uploadGetUrl = async (): Promise<string> => {
         const {data} = await this.r.get<
-            GenericResponse<{ url: string }, "signed_url">
+            GenericResponse<{url: string}, "signed_url">
         >(`/servers/${this.id}/files/upload`)
         return data.attributes.url
     }
 
     upload = async (file: File, root: string = "/"): Promise<void> => {
         const url = await this.uploadGetUrl()
-        await axios.post(url, {files: file}, {
-            headers: {"Content-Type": "multipart/form-data"},
-            params: {directory: root}
-        })
-    }
-}
+        await axios.post(
+            url,
+            {files: file},
+            {
+                headers: {"Content-Type": "multipart/form-data"},
+                params: {directory: root}
+            }
+        )
+    }
+}