@pelican.ts/sdk 0.4.8 → 0.4.10

package/src/api/client/server_schedules.ts

@@ -1,7 +1,7 @@
-import {AxiosInstance} from "axios";
-import {Schedule, ScheduleTask} from "@/api/common/types/server_schedule";
-import {GenericListResponse, GenericResponse} from "@/api/base/types";
-import {PartialBy} from "@/utils/types";
+import {AxiosInstance} from "axios"
+import {Schedule, ScheduleTask} from "@/api/common/types/server_schedule"
+import {GenericListResponse, GenericResponse} from "@/api/base/types"
+import {PartialBy} from "@/utils/types"
 
 export class ServerSchedules {
     private readonly r: AxiosInstance
@@ -26,17 +26,18 @@ export class ServerSchedules {
         return data.attributes
     }
 
-    control = (sched_id: number) => new ScheduleControl(this.r, this.id, sched_id)
+    control = (sched_id: number) =>
+        new ScheduleControl(this.r, this.id, sched_id)
 }
 
 type ScheduleCreateParams = {
-    name: string,
-    is_active?: boolean,
-    only_when_online?: boolean,
-    minute: string,
-    hour: string,
-    day_of_week: string,
-    month: string,
+    name: string
+    is_active?: boolean
+    only_when_online?: boolean
+    minute: string
+    hour: string
+    day_of_week: string
+    month: string
     day_of_month: string
 }
 
@@ -70,13 +71,22 @@ class ScheduleControl {
     }
 
     execute = async (): Promise<void> => {
-        await this.r.post(`/servers/${this.id}/schedules/${this.sched_id}/execute`)
+        await this.r.post(
+            `/servers/${this.id}/schedules/${this.sched_id}/execute`
+        )
     }
 
     tasks = {
         create: async (
             opts: PartialBy<
-                Pick<ScheduleTask, "action" | "payload" | "time_offset" | "sequence_id" | "continue_on_failure">,
+                Pick<
+                    ScheduleTask,
+                    | "action"
+                    | "payload"
+                    | "time_offset"
+                    | "sequence_id"
+                    | "continue_on_failure"
+                >,
                 "payload" | "sequence_id" | "continue_on_failure"
             >
         ): Promise<ScheduleTask> => {
@@ -86,21 +96,35 @@ class ScheduleControl {
             return data.attributes
         },
 
-        update: async <T extends "command" | "power" | "backup" | "delete_files">(
+        update: async <
+            T extends "command" | "power" | "backup" | "delete_files"
+        >(
             task_id: number,
             opts: PartialBy<
-                Pick<ScheduleTask, "action" | "payload" | "time_offset" | "sequence_id" | "continue_on_failure">,
+                Pick<
+                    ScheduleTask,
+                    | "action"
+                    | "payload"
+                    | "time_offset"
+                    | "sequence_id"
+                    | "continue_on_failure"
+                >,
                 "payload" | "sequence_id" | "continue_on_failure"
             >
         ): Promise<ScheduleTask> => {
             const {data} = await this.r.post<
                 GenericResponse<ScheduleTask, "server_schedule_task">
-            >(`/servers/${this.id}/schedules/${this.sched_id}/tasks/${task_id}`, opts)
+            >(
+                `/servers/${this.id}/schedules/${this.sched_id}/tasks/${task_id}`,
+                opts
+            )
             return data.attributes
         },
 
         delete: async (task_id: number): Promise<void> => {
-            await this.r.delete(`/servers/${this.id}/schedules/${this.sched_id}/tasks/${task_id}`)
+            await this.r.delete(
+                `/servers/${this.id}/schedules/${this.sched_id}/tasks/${task_id}`
+            )
         }
     }
-}
+}

package/src/api/client/server_settings.ts

@@ -1,7 +1,6 @@
-import {AxiosInstance} from "axios";
-import z from "zod";
-import {Nullable} from "@/utils/types";
-
+import {AxiosInstance} from "axios"
+import z from "zod"
+import {Nullable} from "@/utils/types"
 
 export class ServerSettings {
     private readonly r: AxiosInstance
@@ -17,8 +16,12 @@ export class ServerSettings {
         await this.r.post(`/servers/${this.id}/settings/rename`, {name})
     }
 
-    updateDescription = async (description: Nullable<string>): Promise<void> => {
-        await this.r.post(`/servers/${this.id}/settings/description`, {description})
+    updateDescription = async (
+        description: Nullable<string>
+    ): Promise<void> => {
+        await this.r.post(`/servers/${this.id}/settings/description`, {
+            description
+        })
     }
 
     reinstall = async (): Promise<void> => {
@@ -26,6 +29,6 @@ export class ServerSettings {
     }
 
     changeDockerImage = async (image: string): Promise<void> => {
-        await this.r.post(`/servers/${this.id}/settings/docker-image`, {image})
+        await this.r.put(`/servers/${this.id}/settings/docker-image`, {image})
     }
-}
+}

package/src/api/client/server_startup.ts

@@ -1,7 +1,10 @@
-import {AxiosInstance} from "axios";
-import {CustomListResponse, GenericListResponse, GenericResponse} from "@/api/base/types";
-import {StartupMeta, StartupParams} from "@/api/common/types/server_startup";
-
+import {AxiosInstance} from "axios"
+import {
+    CustomListResponse,
+    GenericListResponse,
+    GenericResponse
+} from "@/api/base/types"
+import {StartupMeta, StartupParams} from "@/api/common/types/server_startup"
 
 export class ServerStartup {
     private readonly r: AxiosInstance
@@ -12,15 +15,20 @@ export class ServerStartup {
         this.id = id
     }
 
-    list = async (): Promise<CustomListResponse<StartupParams, StartupMeta>> => {
+    list = async (): Promise<
+        CustomListResponse<StartupParams, StartupMeta>
+    > => {
         const {data} = await this.r.get<
-            CustomListResponse<GenericResponse<StartupParams, "egg_variable">, StartupMeta>
+            CustomListResponse<
+                GenericResponse<StartupParams, "egg_variable">,
+                StartupMeta
+            >
         >(`/servers/${this.id}/startup`)
 
         return {
             object: "list",
             meta: data.meta,
-            data: data.data.map(d=>d.attributes)
+            data: data.data.map(d => d.attributes)
         }
     }
 
@@ -30,4 +38,4 @@ export class ServerStartup {
         >(`/servers/${this.id}/startup/variable`, {key, value})
         return data.attributes
     }
-}
+}

package/src/api/client/server_users.ts

@@ -1,6 +1,9 @@
-import {AxiosInstance} from "axios";
-import {GenericListResponse, GenericResponse} from "@/api/base/types";
-import {ServerSubuser, SubuserPermission} from "@/api/client/types/server_subuser";
+import {AxiosInstance} from "axios"
+import {GenericListResponse, GenericResponse} from "@/api/base/types"
+import {
+    ServerSubuser,
+    SubuserPermission
+} from "@/api/client/types/server_subuser"
 
 export class ServerUsers {
     private readonly r: AxiosInstance
@@ -18,7 +21,10 @@ export class ServerUsers {
         return data.data.map(d => d.attributes)
     }
 
-    create = async (email: string, permissions: SubuserPermission[] | string[]): Promise<ServerSubuser> => {
+    create = async (
+        email: string,
+        permissions: SubuserPermission[] | string[]
+    ): Promise<ServerSubuser> => {
         const {data} = await this.r.post<
             GenericResponse<ServerSubuser, "user">
         >(`/servers/${this.id}/users`, {email, permissions})
@@ -26,21 +32,24 @@ export class ServerUsers {
     }
 
     info = async (user_uuid: string): Promise<ServerSubuser> => {
-        const {data} = await this.r.get<
-            GenericResponse<ServerSubuser, "user">
-        >(`/servers/${this.id}/users/${user_uuid}`)
+        const {data} = await this.r.get<GenericResponse<ServerSubuser, "user">>(
+            `/servers/${this.id}/users/${user_uuid}`
+        )
         return data.attributes
     }
 
-    update = async (user_uuid: string, permissions: SubuserPermission[] | string[]): Promise<ServerSubuser> => {
-        const {data} = await this.r.put<
-            GenericResponse<ServerSubuser, "user">
-        >(`/servers/${this.id}/users/${user_uuid}`, {permissions})
+    update = async (
+        user_uuid: string,
+        permissions: SubuserPermission[] | string[]
+    ): Promise<ServerSubuser> => {
+        const {data} = await this.r.put<GenericResponse<ServerSubuser, "user">>(
+            `/servers/${this.id}/users/${user_uuid}`,
+            {permissions}
+        )
         return data.attributes
     }
 
     delete = async (user_uuid: string): Promise<void> => {
         await this.r.delete(`/servers/${this.id}/users/${user_uuid}`)
     }
-
-}
+}

package/src/api/client/server_websocket.ts

@@ -8,18 +8,12 @@ import {
     SOCKET_EVENT,
     StatsWsJson,
     WebsocketEvent
-} from "@/api/client/types/websocket";
-import {ServerSignalOption} from "@/api/common/types/server_power";
+} from "@/api/client/types/websocket"
+import {ServerSignalOption} from "@/api/common/types/server_power"
 
 const isBrowser = typeof window !== "undefined"
 
-
-type WebsocketHandshakePayload = {
-    data: {
-        token: string
-        socket: string
-    }
-}
+type WebsocketHandshakePayload = {data: {token: string; socket: string}}
 
 type SocketEventPayloadMap = {
     [SOCKET_EVENT.AUTH_SUCCESS]: undefined
@@ -40,9 +34,10 @@ type SocketEventPayloadMap = {
     [SOCKET_EVENT.JWT_ERROR]: string
 }
 
-type Listener<E extends SOCKET_EVENT> = SocketEventPayloadMap[E] extends undefined
-    ? () => void
-    : (payload: SocketEventPayloadMap[E]) => void
+type Listener<E extends SOCKET_EVENT> =
+    SocketEventPayloadMap[E] extends undefined
+        ? () => void
+        : (payload: SocketEventPayloadMap[E]) => void
 
 type MessageEventLike = {data?: unknown}
 
@@ -52,7 +47,7 @@ type ErrorEventLike = Parameters<NonNullable<WebSocket["onerror"]>>[0]
 
 const RECONNECT_ERRORS = new Set([
     "jwt: exp claim is invalid",
-    "jwt: created too far in past (denylist)",
+    "jwt: created too far in past (denylist)"
 ])
 
 const FALLBACK_LOG_MESSAGE = "No logs - is the server online?"
@@ -67,13 +62,20 @@ export class ServerWebsocket {
     private stripColors: boolean
     private detachMessageListener?: () => void
 
-    constructor(requester: AxiosInstance, id: string, stripColors: boolean = false) {
+    constructor(
+        requester: AxiosInstance,
+        id: string,
+        stripColors: boolean = false
+    ) {
         this.r = requester
         this.serverId = id
         this.stripColors = stripColors
     }
 
-    public on<E extends SOCKET_EVENT>(event: E, listener: Listener<E>): () => void {
+    public on<E extends SOCKET_EVENT>(
+        event: E,
+        listener: Listener<E>
+    ): () => void {
         const handler = listener as (...args: unknown[]) => void
         this.bus.on(event, handler)
         return () => {
@@ -81,12 +83,20 @@ export class ServerWebsocket {
         }
     }
 
-    public deregister<E extends SOCKET_EVENT>(event: E, listener: Listener<E>): void {
+    public deregister<E extends SOCKET_EVENT>(
+        event: E,
+        listener: Listener<E>
+    ): void {
         const handler = listener as (...args: unknown[]) => void
         this.bus.removeListener(event, handler)
     }
 
-    private emit<E extends SOCKET_EVENT>(event: E, ...args: SocketEventPayloadMap[E] extends undefined ? [] : [SocketEventPayloadMap[E]]): void {
+    private emit<E extends SOCKET_EVENT>(
+        event: E,
+        ...args: SocketEventPayloadMap[E] extends undefined
+            ? []
+            : [SocketEventPayloadMap[E]]
+    ): void {
         if (args.length === 0) {
             this.bus.emit(event)
         } else {
@@ -94,7 +104,10 @@ export class ServerWebsocket {
         }
     }
 
-    public async connect(resumable?: boolean, debugLogging?: boolean): Promise<void> {
+    public async connect(
+        resumable?: boolean,
+        debugLogging?: boolean
+    ): Promise<void> {
         this.debugLogging = debugLogging ?? false
 
         if (this.socket) {
@@ -105,7 +118,9 @@ export class ServerWebsocket {
 
         this.socket = isBrowser
             ? new WebSocket(socketUrl)
-            : new WebSocket(socketUrl, undefined, {origin: new URL(socketUrl).origin})
+            : new WebSocket(socketUrl, undefined, {
+                  origin: new URL(socketUrl).origin
+              })
 
         await new Promise<void>((resolve, reject) => {
             const socket = this.socket
@@ -124,14 +139,22 @@ export class ServerWebsocket {
                 } catch (error) {
                     socket.onopen = null
                     socket.onerror = null
-                    reject(error instanceof Error ? error : new Error("Websocket authentication failed"))
+                    reject(
+                        error instanceof Error
+                            ? error
+                            : new Error("Websocket authentication failed")
+                    )
                 }
             }
 
             socket.onerror = (event: ErrorEventLike) => {
                 socket.onopen = null
                 socket.onerror = null
-                reject(event instanceof Error ? event : new Error("Websocket connection error"))
+                reject(
+                    event instanceof Error
+                        ? event
+                        : new Error("Websocket connection error")
+                )
             }
         })
 
@@ -189,21 +212,33 @@ export class ServerWebsocket {
         }
 
         if (typeof this.socket.addEventListener === "function") {
-            this.socket.addEventListener("message", handler as (event: MessageEventLike) => void)
+            this.socket.addEventListener(
+                "message",
+                handler as (event: MessageEventLike) => void
+            )
             this.detachMessageListener = () => {
-                this.socket?.removeEventListener?.("message", handler as (event: MessageEventLike) => void)
+                this.socket?.removeEventListener?.(
+                    "message",
+                    handler as (event: MessageEventLike) => void
+                )
             }
         } else {
-            const fallback = (data: unknown) => handler({data} satisfies MessageEventLike)
+            const fallback = (data: unknown) =>
+                handler({data} satisfies MessageEventLike)
             const socket = this.socket as unknown as {
                 on?: (event: string, listener: (data: unknown) => void) => void
                 off?: (event: string, listener: (data: unknown) => void) => void
-                removeListener?: (event: string, listener: (data: unknown) => void) => void
+                removeListener?: (
+                    event: string,
+                    listener: (data: unknown) => void
+                ) => void
             }
 
             socket.on?.("message", fallback)
             this.detachMessageListener = () => {
-                const target = this.socket as unknown as typeof socket | undefined
+                const target = this.socket as unknown as
+                    | typeof socket
+                    | undefined
                 if (!target) {
                     return
                 }
@@ -261,7 +296,10 @@ export class ServerWebsocket {
             return event.toString("utf8")
         }
 
-        if (typeof ArrayBuffer !== "undefined" && event instanceof ArrayBuffer) {
+        if (
+            typeof ArrayBuffer !== "undefined"
+            && event instanceof ArrayBuffer
+        ) {
             if (typeof TextDecoder !== "undefined") {
                 return new TextDecoder().decode(new Uint8Array(event))
             }
@@ -318,7 +356,9 @@ export class ServerWebsocket {
             }
             case SOCKET_EVENT.BACKUP_COMPLETED: {
                 try {
-                    const payload = JSON.parse(message.args[0]) as BackupCompletedJson
+                    const payload = JSON.parse(
+                        message.args[0]
+                    ) as BackupCompletedJson
                     this.emit(SOCKET_EVENT.BACKUP_COMPLETED, payload)
                 } catch (error) {
                     if (this.debugLogging) {
@@ -401,7 +441,9 @@ export class ServerWebsocket {
     }
 
     private async refreshCredentials(): Promise<string> {
-        const {data} = await this.r.get<WebsocketHandshakePayload>(`/servers/${this.serverId}/websocket`)
+        const {data} = await this.r.get<WebsocketHandshakePayload>(
+            `/servers/${this.serverId}/websocket`
+        )
         this.currentToken = data.data.token
         return data.data.socket
     }
@@ -415,7 +457,9 @@ export class ServerWebsocket {
             throw new Error("Missing websocket token")
         }
 
-        this.socket.send(JSON.stringify({event: "auth", args: [this.currentToken]}))
+        this.socket.send(
+            JSON.stringify({event: "auth", args: [this.currentToken]})
+        )
     }
 
     public disconnect(): void {
@@ -438,7 +482,9 @@ export class ServerWebsocket {
     private send(event: string, args: unknown[]): void {
         if (!this.socket) {
             if (this.debugLogging) {
-                console.warn(`Attempted to send "${event}" without an active websocket connection`)
+                console.warn(
+                    `Attempted to send "${event}" without an active websocket connection`
+                )
             }
             return
         }
@@ -459,7 +505,7 @@ export class ServerWebsocket {
                 reject(new Error("Timed out waiting for stats"))
             }, 5000)
 
-            off = this.on(SOCKET_EVENT.STATS, (payload) => {
+            off = this.on(SOCKET_EVENT.STATS, payload => {
                 clearTimeout(timeout)
                 off?.()
                 resolve(payload)
@@ -496,7 +542,7 @@ export class ServerWebsocket {
                 finalize(lines.length > 0 ? lines : [FALLBACK_LOG_MESSAGE])
             }, 5000)
 
-            off = this.on(SOCKET_EVENT.CONSOLE_OUTPUT, (line) => {
+            off = this.on(SOCKET_EVENT.CONSOLE_OUTPUT, line => {
                 lines.push(line)
                 if (initialTimeout) {
                     clearTimeout(initialTimeout)

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

@@ -1,9 +1,9 @@
-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
@@ -13,11 +13,7 @@ export type Server = {
     name: string
     node: string
     is_node_under_maintenance: boolean
-    sftp_details: {
-        ip: string
-        alias: Nullable<string>
-        port: number
-    }
+    sftp_details: {ip: string; alias: Nullable<string>; port: number}
     description: string
     limits: ServerLimits
     invocation: string
@@ -35,13 +31,7 @@ export type Server = {
         variables: GenericListResponse<
             GenericResponse<EggVariable, "egg_variable">
         >
-        egg?: GenericResponse<
-            {
-                uuid: string
-                name: string
-            },
-            "egg"
-        >
+        egg?: GenericResponse<{uuid: string; name: string}, "egg">
         subusers?: GenericListResponse<
             GenericResponse<ServerSubuser, "server_subuser">
         >

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

@@ -1,11 +1,10 @@
-import {Nullable} from "@/utils/types";
-
+import {Nullable} from "@/utils/types"
 
 export type ServerAllocation = {
-    id: number,
-    ip: string,
-    alias: Nullable<string>,
-    port: number,
-    notes: Nullable<string>,
+    id: number
+    ip: string
+    alias: Nullable<string>
+    port: number
+    notes: Nullable<string>
     is_default: boolean
-}
+}

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

@@ -1,17 +1,16 @@
 export type ServerSubuser = {
-    uuid: string,
-    username: string,
-    email: string,
-    language: string,
-    image: string,
-    admin: false,
-    root_admin: false,
-    "2fa_enabled": boolean,
-    created_at: string,
+    uuid: string
+    username: string
+    email: string
+    language: string
+    image: string
+    admin: false
+    root_admin: false
+    "2fa_enabled": boolean
+    created_at: string
     permissions: SubuserPermission[] | string[]
 }
 
-
 export type SubuserPermission =
     | "activity.read"
     | "allocation.create"
@@ -53,4 +52,4 @@ export type SubuserPermission =
     | "user.delete"
     | "user.read"
     | "user.update"
-    | "websocket.connect"
+    | "websocket.connect"

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

@@ -1,4 +1,4 @@
-import { Nullable } from "@/utils/types"
+import {Nullable} from "@/utils/types"
 
 export type User = {
     uuid: string
@@ -28,7 +28,4 @@ export type SSHKey = {
     created_at: string
 }
 
-export type Permission = {
-    description: string
-    keys: Record<string, string>
-}
+export type Permission = {description: string; keys: Record<string, string>}