@pelican.ts/sdk 0.4.8 → 0.4.10

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

@@ -9,7 +9,7 @@ export enum SERVER_SIGNAL {
     START = "start",
     STOP = "stop",
     RESTART = "restart",
-    KILL = "kill",
+    KILL = "kill"
 }
 
 export type WebsocketEvent =
@@ -49,7 +49,7 @@ export enum SOCKET_EVENT {
     BACKUP_RESTORE_COMPLETED = "backup restore completed",
     TOKEN_EXPIRING = "token expiring",
     TOKEN_EXPIRED = "token expired",
-    JWT_ERROR = "jwt error",
+    JWT_ERROR = "jwt error"
 }
 
 export type InstallOutputEvent = {
@@ -57,13 +57,9 @@ export type InstallOutputEvent = {
     args: [string]
 }
 
-export type InstallStartedEvent = {
-    event: SOCKET_EVENT.INSTALL_STARTED
-}
+export type InstallStartedEvent = {event: SOCKET_EVENT.INSTALL_STARTED}
 
-export type InstallCompletedEvent = {
-    event: SOCKET_EVENT.INSTALL_COMPLETED
-}
+export type InstallCompletedEvent = {event: SOCKET_EVENT.INSTALL_COMPLETED}
 
 export type TransferLogsEvent = {
     event: SOCKET_EVENT.TRANSFER_LOGS
@@ -92,11 +88,9 @@ export type BackupRestoreCompletedEvent = {
     event: SOCKET_EVENT.BACKUP_RESTORE_COMPLETED
 }
 
-export type AuthSuccessWsEvent = {
-    event: SOCKET_EVENT.AUTH_SUCCESS
-}
+export type AuthSuccessWsEvent = {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"
 
@@ -105,24 +99,21 @@ export type ConsoleLogWsEvent = {
     args: [string]
 }
 
-export type StatsWsEvent = {
-    event: SOCKET_EVENT.STATS
-    args: [string]
-}
+export type StatsWsEvent = {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 }
+    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:
@@ -142,9 +133,6 @@ export type DaemonErrorEvent = {
     args: [string]
 }
 
-export type JwtErrorEvent = {
-    event: SOCKET_EVENT.JWT_ERROR
-    args: [string]
-}
+export type JwtErrorEvent = {event: SOCKET_EVENT.JWT_ERROR; args: [string]}
 
-export { ServerWebsocket } from "@/api/client/server_websocket"
+export {ServerWebsocket} from "@/api/client/server_websocket"

package/src/api/common/types/egg.ts

@@ -1,9 +1,9 @@
 export type EggVariable = {
-    name: string,
-    description: string,
-    env_variable: string,
-    default_value: string,
-    server_value: string,
-    is_editable: boolean,
+    name: string
+    description: string
+    env_variable: string
+    default_value: string
+    server_value: string
+    is_editable: boolean
     rules: string
-}
+}

package/src/api/common/types/enums.ts

@@ -1,4 +1,4 @@
-import z from "zod";
+import z from "zod"
 
 export const languagesSchema = z.enum([
     "af", "ak", "am", "ar", "as", "az", "be", "bg", "bm", "bn", "bo", "br", "bs", "ca", "ce", "cs", "cv", "cy",

package/src/api/common/types/server_backup.ts

@@ -1,14 +1,13 @@
-import {Nullable} from "@/utils/types";
-
+import {Nullable} from "@/utils/types"
 
 export type ServerBackup = {
     uuid: string
-    is_successful: boolean,
-    is_locked: boolean,
+    is_successful: boolean
+    is_locked: boolean
     name: string
     ignored_files: string[]
     checksum: Nullable<string>
     bytes: number
     created_at: string
     completed_at: Nullable<string>
-}
+}

package/src/api/common/types/server_database.ts

@@ -1,16 +1,13 @@
-import {GenericResponse} from "@/api/base/types";
+import {GenericResponse} from "@/api/base/types"
 
 export type ServerDatabase = {
-    id: string,
-    host: {
-        address: string,
-        port: number
-    },
-    name: string,
-    username: string,
-    connections_from: string,
-    max_connections: number,
+    id: string
+    host: {address: string; port: number}
+    name: string
+    username: string
+    connections_from: string
+    max_connections: number
     relationships?: {
-        password: GenericResponse<{ password: string }, "database_password">
+        password: GenericResponse<{password: string}, "database_password">
     }
-}
+}

package/src/api/common/types/server_files.ts

@@ -1,11 +1,11 @@
 export type FileObject = {
-    name: string,
-    mode: string,
-    mode_bits: string,
-    size: number,
-    is_file: boolean,
-    is_symlink: boolean,
-    mimetype: string,
-    created_at: string,
+    name: string
+    mode: string
+    mode_bits: string
+    size: number
+    is_file: boolean
+    is_symlink: boolean
+    mimetype: string
+    created_at: string
     modified_at: string
-}
+}

package/src/api/common/types/server_limits.ts

@@ -1,19 +1,18 @@
-import {Nullable} from "@/utils/types";
-
+import {Nullable} from "@/utils/types"
 
 export type ServerLimits = {
-    memory: number,
-    swap: number,
-    disk: number,
-    io: number,
-    cpu: number,
-    threads: Nullable<number|string>,
-    oom_disabled: boolean,
+    memory: number
+    swap: number
+    disk: number
+    io: number
+    cpu: number
+    threads: Nullable<number | string>
+    oom_disabled: boolean
     oom_killer: boolean
 }
 
 export type FeatureLimits = {
-    databases: number,
-    allocations: number,
+    databases: number
+    allocations: number
     backups: number
-}
+}

package/src/api/common/types/server_power.ts

@@ -1 +1 @@
-export type ServerSignalOption = 'start' | 'stop' | 'restart' | 'kill';
+export type ServerSignalOption = "start" | "stop" | "restart" | "kill"

package/src/api/common/types/server_schedule.ts

@@ -1,35 +1,37 @@
-import {GenericListResponse, GenericResponse} from "@/api/base/types";
-import {Nullable} from "@/utils/types";
+import {GenericListResponse, GenericResponse} from "@/api/base/types"
+import {Nullable} from "@/utils/types"
 
 export type Schedule = {
-    id: number,
-    name: string,
+    id: number
+    name: string
     cron: {
-        day_of_week: string,
-        day_of_month: string,
-        hour: string,
+        day_of_week: string
+        day_of_month: string
+        hour: string
         minute: string
-    },
-    is_active: boolean,
-    is_processing: boolean,
-    only_when_online: boolean,
-    last_run_at: Nullable<string>,
-    next_run_at: string,
-    created_at: string,
-    updated_at: string,
+    }
+    is_active: boolean
+    is_processing: boolean
+    only_when_online: boolean
+    last_run_at: Nullable<string>
+    next_run_at: string
+    created_at: string
+    updated_at: string
     relationships: {
-        tasks: GenericListResponse<GenericResponse<ScheduleTask, "schedule_task">>
+        tasks: GenericListResponse<
+            GenericResponse<ScheduleTask, "schedule_task">
+        >
     }
 }
 
 export type ScheduleTask = {
-    id: number,
-    sequence_id: number,
-    action: "command" | "power" | "backup" | "delete_files",
-    payload: string,
-    time_offset: number,
-    is_queued: boolean,
-    continue_on_failure: boolean,
-    created_at: string,
+    id: number
+    sequence_id: number
+    action: "command" | "power" | "backup" | "delete_files"
+    payload: string
+    time_offset: number
+    is_queued: boolean
+    continue_on_failure: boolean
+    created_at: string
     updated_at: Nullable<string>
-}
+}

package/src/api/common/types/server_startup.ts

@@ -1,16 +1,11 @@
-
-
 export type StartupParams = {
-    name: string,
-    description: string,
-    env_variables: string,
-    default_value: string,
-    server_value: string,
-    is_editable: boolean,
+    name: string
+    description: string
+    env_variables: string
+    default_value: string
+    server_value: string
+    is_editable: boolean
     rules: string
 }
 
-export type StartupMeta = {
-    startup_command: string
-    raw_startup_command: string
-}
+export type StartupMeta = {startup_command: string; raw_startup_command: string}

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") {

package/src/humane/Account.ts

@@ -1,5 +1,5 @@
-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

package/src/humane/Client.ts

@@ -1,6 +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
@@ -26,15 +26,15 @@ export class Client {
             page?: number
             per_page?: number
             include?: ("egg" | "subusers")[]
-        } = { type: "accessible", page: 1, per_page: 50 },
+        } = {type: "accessible", page: 1, per_page: 50}
     ) => {
         const data = await this.client.listServers(
             opts.type,
             opts.page,
             opts.per_page,
-            opts.include,
+            opts.include
         )
-        return data.map((d) => new Server(this.client.server(d.uuid), d))
+        return data.map(d => new Server(this.client.server(d.uuid), d))
     }
 
     getServer = async (uuid: string, include?: ("egg" | "subusers")[]) => {

package/src/humane/Server.ts

@@ -1,21 +1,21 @@
-import type { ServerClient } from "@/api/client/server"
-import type { ServerBackups } from "@/api/client/server_backups"
-import type { ServerFiles } from "@/api/client/server_files"
-import type { ServerSchedules } from "@/api/client/server_schedules"
-import type { Server as ServerT } from "@/api/client/types/server"
-import { ServerAllocation } from "@/humane/ServerAllocation"
-import { ServerBackup } from "@/humane/ServerBackup"
-import { ServerDatabase } from "@/humane/ServerDatabase"
-import { ServerFile } from "@/humane/ServerFile"
-import { ServerSchedule } from "@/humane/ServerSchedule"
-import { ServerUser } from "@/humane/ServerUser"
+import type {ServerClient} from "@/api/client/server"
+import type {ServerBackups} from "@/api/client/server_backups"
+import type {ServerFiles} from "@/api/client/server_files"
+import type {ServerSchedules} from "@/api/client/server_schedules"
+import type {Server as ServerT} from "@/api/client/types/server"
+import {ServerAllocation} from "@/humane/ServerAllocation"
+import {ServerBackup} from "@/humane/ServerBackup"
+import {ServerDatabase} from "@/humane/ServerDatabase"
+import {ServerFile} from "@/humane/ServerFile"
+import {ServerSchedule} from "@/humane/ServerSchedule"
+import {ServerUser} from "@/humane/ServerUser"
 import type {
     EggVariable,
     FeatureLimits,
     ServerLimits,
-    SubuserPermission,
+    SubuserPermission
 } from "@/types"
-import type { Nullable } from "@/utils/types"
+import type {Nullable} from "@/utils/types"
 
 export class Server {
     private readonly client: ServerClient
@@ -30,11 +30,7 @@ export class Server {
     }
     readonly node: string
     readonly isNodeUnderMaintenance: boolean
-    readonly sftp: {
-        ip: string
-        alias: Nullable<string>
-        port: number
-    }
+    readonly sftp: {ip: string; alias: Nullable<string>; port: number}
     private $description: string
     get description() {
         return this.$description
@@ -53,10 +49,7 @@ export class Server {
     readonly isTransferring: boolean
     readonly allocations: ServerAllocation[]
     readonly variables: EggVariable[]
-    readonly egg?: {
-        uuid: string
-        name: string
-    }
+    readonly egg?: {uuid: string; name: string}
     readonly subusers?: ServerUser[]
 
     constructor(client: ServerClient, server: ServerT) {
@@ -80,14 +73,14 @@ export class Server {
         this.isInstalling = server.is_installing
         this.isTransferring = server.is_transferring
         this.allocations = server.relationships.allocations.data.map(
-            (d) => new ServerAllocation(this.client, d.attributes),
+            d => new ServerAllocation(this.client, d.attributes)
         )
         this.variables = server.relationships.variables.data.map(
-            (d) => d.attributes,
+            d => d.attributes
         )
         this.egg = server.relationships.egg?.attributes
         this.subusers = server.relationships.subusers?.data.map(
-            (d) => new ServerUser(this.client, d.attributes),
+            d => new ServerUser(this.client, d.attributes)
         )
     }
 
@@ -109,7 +102,7 @@ export class Server {
     }
 
     getActivityLogs = async (
-        opts: { page?: number; per_page?: number } = { page: 1, per_page: 50 },
+        opts: {page?: number; per_page?: number} = {page: 1, per_page: 50}
     ) => this.client.activity.list(opts.page, opts.per_page)
 
     websocket = (stripColors: boolean = false) =>
@@ -123,13 +116,10 @@ export class Server {
         this.client.power(signal)
 
     getDatabases = async (
-        opts: { include?: "password"[]; page?: number } = {
-            include: [],
-            page: 1,
-        },
+        opts: {include?: "password"[]; page?: number} = {include: [], page: 1}
     ) => {
         const data = await this.client.databases.list(opts.include, opts.page)
-        return data.map((d) => new ServerDatabase(this.client, d))
+        return data.map(d => new ServerDatabase(this.client, d))
     }
 
     createDatabase = async (database: string, remote: string) => {
@@ -139,7 +129,7 @@ export class Server {
 
     getSchedules = async () => {
         const data = await this.client.schedules.list()
-        return data.map((d) => new ServerSchedule(this.client, d))
+        return data.map(d => new ServerSchedule(this.client, d))
     }
 
     createSchedule = async (...opts: Parameters<ServerSchedules["create"]>) => {
@@ -149,7 +139,7 @@ export class Server {
 
     getBackups = async (page: number = 1) => {
         const data = await this.client.backups.list(page)
-        return data.map((d) => new ServerBackup(this.client, d))
+        return data.map(d => new ServerBackup(this.client, d))
     }
 
     createBackup = async (...args: Parameters<ServerBackups["create"]>) => {
@@ -159,7 +149,7 @@ export class Server {
 
     getAllocations = async () => {
         const data = await this.client.allocations.list()
-        return data.map((d) => new ServerAllocation(this.client, d))
+        return data.map(d => new ServerAllocation(this.client, d))
     }
 
     createAllocation = async () => {
@@ -169,7 +159,7 @@ export class Server {
 
     getFiles = async (path?: string) => {
         const data = await this.client.files.list(path)
-        return data.map((d) => new ServerFile(this.client, d))
+        return data.map(d => new ServerFile(this.client, d, path))
     }
 
     createFolder = async (...opts: Parameters<ServerFiles["createFolder"]>) =>
@@ -190,22 +180,20 @@ export class Server {
         ...opts: Parameters<ServerFiles["compress"]>
     ) => this.client.files.compress(...opts)
 
-    renameMultipleFiles = async (
-        ...opts: Parameters<ServerFiles["rename"]>
-    ) => this.client.files.rename(...opts)
+    renameMultipleFiles = async (...opts: Parameters<ServerFiles["rename"]>) =>
+        this.client.files.rename(...opts)
 
-    deleteMultipleFiles = async (
-        ...opts: Parameters<ServerFiles["delete"]>
-    ) => this.client.files.delete(...opts)
+    deleteMultipleFiles = async (...opts: Parameters<ServerFiles["delete"]>) =>
+        this.client.files.delete(...opts)
 
     getUsers = async () => {
         const data = await this.client.users.list()
-        return data.map((d) => new ServerUser(this.client, d))
+        return data.map(d => new ServerUser(this.client, d))
     }
 
     createUser = async (
         email: string,
-        permissions: SubuserPermission[] | string[],
+        permissions: SubuserPermission[] | string[]
     ) => {
         const data = await this.client.users.create(email, permissions)
         return new ServerUser(this.client, data)

package/src/humane/ServerAllocation.ts

@@ -1,6 +1,6 @@
-import type { ServerClient } from "@/api/client/server"
-import type { ServerAllocation as ServerAllocationT } from "@/api/client/types/server_allocation"
-import type { Nullable } from "@/utils/types"
+import type {ServerClient} from "@/api/client/server"
+import type {ServerAllocation as ServerAllocationT} from "@/api/client/types/server_allocation"
+import type {Nullable} from "@/utils/types"
 
 export class ServerAllocation {
     private readonly client: ServerClient

package/src/humane/ServerBackup.ts

@@ -1,6 +1,6 @@
-import type { ServerClient } from "@/api/client/server"
-import type { ServerBackup as ServerBackupT } from "@/api/common/types/server_backup"
-import type { Nullable } from "@/utils/types"
+import type {ServerClient} from "@/api/client/server"
+import type {ServerBackup as ServerBackupT} from "@/api/common/types/server_backup"
+import type {Nullable} from "@/utils/types"
 
 export class ServerBackup {
     private readonly client: ServerClient
@@ -35,13 +35,10 @@ export class ServerBackup {
 
     delete = async () => this.client.backups.delete(this.uuid)
 
-    rename = async (
-        name: string
-    ) => this.client.backups.rename(this.uuid, name)
+    rename = async (name: string) => this.client.backups.rename(this.uuid, name)
 
     toggleLock = async () => this.client.backups.toggleLock(this.uuid)
 
-    restore = async (
-        truncate: boolean
-    ) => this.client.backups.restore(this.uuid, truncate)
+    restore = async (truncate: boolean) =>
+        this.client.backups.restore(this.uuid, truncate)
 }

package/src/humane/ServerDatabase.ts

@@ -1,5 +1,5 @@
-import type { ServerClient } from "@/api/client/server"
-import type { ServerDatabase as ServerDatabaseT } from "@/api/common/types/server_database"
+import type {ServerClient} from "@/api/client/server"
+import type {ServerDatabase as ServerDatabaseT} from "@/api/common/types/server_database"
 // TODO: Check for validity
 
 export class ServerDatabase {

package/src/humane/ServerFile.ts

@@ -1,6 +1,6 @@
 import path from "node:path"
-import type { ServerClient } from "@/api/client/server"
-import type { FileObject } from "@/api/common/types/server_files"
+import type {ServerClient} from "@/api/client/server"
+import type {FileObject} from "@/api/common/types/server_files"
 
 export class ServerFile {
     private readonly client: ServerClient
@@ -40,8 +40,8 @@ export class ServerFile {
             "txz",
             "tar.xz",
             "tbz2",
-            "tar.bz2",
-        ].some((ext) => this.name.endsWith(`.${ext}`))
+            "tar.bz2"
+        ].some(ext => this.name.endsWith(`.${ext}`))
     }
 
     /**
@@ -54,7 +54,7 @@ export class ServerFile {
     download = async () => this.client.files.download(this.path)
 
     rename = async (newName: string) =>
-        this.client.files.rename(this.dir, [{ from: this.name, to: newName }])
+        this.client.files.rename(this.dir, [{from: this.name, to: newName}])
 
     copy = async () => this.client.files.copy(this.path)
 
@@ -70,16 +70,22 @@ export class ServerFile {
             | "txz"
             | "tar.xz"
             | "tbz2"
-            | "tar.bz2",
-    ) => new ServerFile(
-        this.client,
-        await this.client.files.compress(this.dir, [this.name], archive_name, extension)
-    )
+            | "tar.bz2"
+    ) =>
+        new ServerFile(
+            this.client,
+            await this.client.files.compress(
+                this.dir,
+                [this.name],
+                archive_name,
+                extension
+            )
+        )
 
     decompress = async () => this.client.files.decompress(this.dir, this.name)
 
     delete = async () => this.client.files.delete(this.dir, [this.name])
 
     chmod = async (mode: number) =>
-        this.client.files.chmod(this.dir, [{ file: this.name, mode }])
+        this.client.files.chmod(this.dir, [{file: this.name, mode}])
 }

package/src/humane/ServerSchedule.ts

@@ -1,6 +1,6 @@
-import type { ServerClient } from "@/api/client/server"
-import type { Schedule, ScheduleTask } from "@/api/common/types/server_schedule"
-import type { Nullable, PartialBy } from "@/utils/types"
+import type {ServerClient} from "@/api/client/server"
+import type {Schedule, ScheduleTask} from "@/api/common/types/server_schedule"
+import type {Nullable, PartialBy} from "@/utils/types"
 
 export class ServerSchedule {
     private readonly client: ServerClient
@@ -12,7 +12,7 @@ export class ServerSchedule {
         minute: string
     }
     get cron() {
-        return { ...this.$cron }
+        return {...this.$cron}
     }
     readonly id: number
     private $isActive: boolean
@@ -53,7 +53,7 @@ export class ServerSchedule {
         this.nextRunAt = new Date(schedule.next_run_at)
         this.$onlyWhenOnline = schedule.only_when_online
         this.tasks = schedule.relationships.tasks.data.map(
-            (d) => new ServerScheduleTask(this.client, this.id, d.attributes),
+            d => new ServerScheduleTask(this.client, this.id, d.attributes)
         )
         this.$updatedAt = new Date(schedule.updated_at)
     }
@@ -144,7 +144,7 @@ export class ServerScheduleTask {
                 | "continue_on_failure"
             >,
             "payload" | "sequence_id" | "continue_on_failure"
-        >,
+        >
     ) => {
         const data = await this.client.schedules
             .control(this.scheduleId)