@pelican.ts/sdk 0.4.8 → 0.4.10

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

@@ -1,72 +1,65 @@
-import {Nullable} from "@/utils/types";
-import {EggVariable} from "@/api/common/types";
+import {Nullable} from "@/utils/types"
+import {EggVariable} from "@/api/common/types"
 
 export type Egg = {
-    id: number,
-    uuid: string,
-    name: string,
-    author: string,
-    description: string,
-    features: string[],
-    tags: string[],
-    docker_image: Nullable<string>,
-    docker_images: Record<string, string>,
+    id: number
+    uuid: string
+    name: string
+    author: string
+    description: string
+    features: string[]
+    tags: string[]
+    docker_image: Nullable<string>
+    docker_images: Record<string, string>
     config: {
         files: Record<string, FileConfig>
-        startup: Record<string, string>,
-        stop: string,
-        logs: object | [],
-        file_denylist: string[],
+        startup: Record<string, string>
+        stop: string
+        logs: object | []
+        file_denylist: string[]
         extends: Nullable<number>
-    },
-    startup: string,
-    startup_commands: Record<string, string>,
+    }
+    startup: string
+    startup_commands: Record<string, string>
     script: {
-        privileged: boolean,
-        install: string,
-        entry: string,
-        container: string,
+        privileged: boolean
+        install: string
+        entry: string
+        container: string
         extends: Nullable<number>
-    },
-    created_at: string,
+    }
+    created_at: string
     updated_at: Nullable<string>
 }
 
-type FileConfig = {
-    parser: string,
-    find: Record<string, string>
-}
+type FileConfig = {parser: string; find: Record<string, string>}
 
-export type ApplicationEggVariable = Omit<EggVariable, "server_value" | "is_editable" | "rules"> & {
-    rules: string[],
-    sort: number,
-    user_viewable: boolean,
-    user_editable: boolean,
+export type ApplicationEggVariable = Omit<
+    EggVariable,
+    "server_value" | "is_editable" | "rules"
+> & {
+    rules: string[]
+    sort: number
+    user_viewable: boolean
+    user_editable: boolean
 }
 
 export type ExportedEgg = {
-    meta: {
-        version: "PLCN_v3",
-        update_url: Nullable<string>
-    },
-    exported_at: string,
-    name: string,
-    author: string,
-    description: string,
-    uuid: string,
+    meta: {version: "PLCN_v3"; update_url: Nullable<string>}
+    exported_at: string
+    name: string
+    author: string
+    description: string
+    uuid: string
     image: Nullable<string>
-    docker_images: Record<string, string>,
-    features: string[],
-    tags: string[],
-    file_denylist: string[],
-    startup_commands: Record<string, string>,
+    docker_images: Record<string, string>
+    features: string[]
+    tags: string[]
+    file_denylist: string[]
+    startup_commands: Record<string, string>
     config: Omit<Egg["config"], "extends" | "file_denylist">
     scripts: {
-        installation: {
-            script: string,
-            container: string,
-            entrypoint: string
-        }
-    },
+        installation: {script: string; container: string; entrypoint: string}
+    }
     variables: ApplicationEggVariable[]
-}
+}

package/src/api/application/types/location.ts

@@ -1,9 +1,7 @@
-
-
 export type Location = {
-    id: number,
-    short: string,
-    long: string,
-    created_at: string,
+    id: number
+    short: string
+    long: string
+    created_at: string
     updated_at: string | null
-}
+}

package/src/api/application/types/mount.ts

@@ -1,12 +1,12 @@
-import {Nullable} from "@/utils/types";
+import {Nullable} from "@/utils/types"
 
 export type Mount = {
-    id: number,
-    uuid: string,
-    name: string,
-    description: Nullable<string>,
-    source: string,
-    target: string,
-    read_only: boolean,
+    id: number
+    uuid: string
+    name: string
+    description: Nullable<string>
+    source: string
+    target: string
+    read_only: boolean
     user_mountable: boolean
-}
+}

package/src/api/application/types/node.ts

@@ -1,68 +1,58 @@
-import {GenericListResponse, GenericResponse} from "@/api/base/types";
-import {Allocation} from "@/api/application/types/server_allocation";
-import {Location} from "@/api/application/types/location";
-import {ApplicationServer} from "@/api/application/types/server";
-import {Nullable} from "@/utils/types";
-
+import {GenericListResponse, GenericResponse} from "@/api/base/types"
+import {Allocation} from "@/api/application/types/server_allocation"
+import {Location} from "@/api/application/types/location"
+import {ApplicationServer} from "@/api/application/types/server"
+import {Nullable} from "@/utils/types"
 
 export type Node = {
-    id: number,
-    uuid: string,
-    public: boolean,
-    name: string,
-    description: Nullable<string>,
-    fqdn: string,
-    scheme: "https" | "http",
-    behind_proxy: boolean,
-    maintenance_mode: boolean,
-    memory: number,
-    memory_overallocate: number,
-    disk: number,
-    disk_overallocate: number,
-    cpu: number,
-    cpu_overallocate: number,
-    upload_size: number,
-    daemon_listen: number,
-    daemon_sftp: number,
-    daemon_sftp_alias: Nullable<string>,
-    daemon_base: string,
-    daemon_connect: number,
-    created_at: string,
-    updated_at: Nullable<string>,
-    tags: string[],
-    allocated_resources: {
-        memory: number,
-        disk: number,
-        cpu: number
-    },
+    id: number
+    uuid: string
+    public: boolean
+    name: string
+    description: Nullable<string>
+    fqdn: string
+    scheme: "https" | "http"
+    behind_proxy: boolean
+    maintenance_mode: boolean
+    memory: number
+    memory_overallocate: number
+    disk: number
+    disk_overallocate: number
+    cpu: number
+    cpu_overallocate: number
+    upload_size: number
+    daemon_listen: number
+    daemon_sftp: number
+    daemon_sftp_alias: Nullable<string>
+    daemon_base: string
+    daemon_connect: number
+    created_at: string
+    updated_at: Nullable<string>
+    tags: string[]
+    allocated_resources: {memory: number; disk: number; cpu: number}
     relationships?: {
-        allocations?: GenericListResponse<GenericResponse<Allocation, "allocation">>,
-        location?: GenericResponse<Location, "location">,
-        servers?: GenericListResponse<GenericResponse<ApplicationServer, "server">>
+        allocations?: GenericListResponse<
+            GenericResponse<Allocation, "allocation">
+        >
+        location?: GenericResponse<Location, "location">
+        servers?: GenericListResponse<
+            GenericResponse<ApplicationServer, "server">
+        >
     }
 }
 
 export type NodeConfiguration = {
-    debug: boolean,
-    uuid: string,
-    token_id: string,
-    token: string,
+    debug: boolean
+    uuid: string
+    token_id: string
+    token: string
     api: {
-        host: string,
-        port: number,
-        upload_limit: number,
-        ssl: {
-            enabled: boolean,
-            cert: string,
-            key: string
-        }
-    },
-    system: {
-        data: string,
-        sftp: {
-            bind_port: number,
-        }
-    },
-    allowed_mounts: string[],
+        host: string
+        port: number
+        upload_limit: number
+        ssl: {enabled: boolean; cert: string; key: string}
+    }
+    system: {data: string; sftp: {bind_port: number}}
+    allowed_mounts: string[]
     remote: string
-}
+}

package/src/api/application/types/role.ts

@@ -1,8 +1,6 @@
-
-
 export type Role = {
-    id: number,
-    name: string,
-    created_at: string,
+    id: number
+    name: string
+    created_at: string
     updated_at: string
-}
+}

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

@@ -1,25 +1,24 @@
-import {FeatureLimits, ServerLimits} from "@/api/common/types/server_limits";
-import {Container} from "@/api/application/types/container";
-import {Nullable} from "@/utils/types";
-
+import {FeatureLimits, ServerLimits} from "@/api/common/types/server_limits"
+import {Container} from "@/api/application/types/container"
+import {Nullable} from "@/utils/types"
 
 export type ApplicationServer = {
-    id: number,
-    external_id: Nullable<string>,
-    uuid: string,
-    identifier: string,
-    name: string,
-    description: string,
-    status: Nullable<unknown>,
-    docker_labels: Record<string, string>,
-    suspended: boolean,
-    limits: ServerLimits,
-    feature_limits: FeatureLimits,
-    user: number,
-    node: number,
-    allocation: number,
-    egg: number,
-    container: Container,
-    created_at: string,
+    id: number
+    external_id: Nullable<string>
+    uuid: string
+    identifier: string
+    name: string
+    description: string
+    status: Nullable<unknown>
+    docker_labels: Record<string, string>
+    suspended: boolean
+    limits: ServerLimits
+    feature_limits: FeatureLimits
+    user: number
+    node: number
+    allocation: number
+    egg: number
+    container: Container
+    created_at: string
     updated_at: Nullable<string>
-}
+}

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

@@ -1,21 +1,20 @@
-import {GenericResponse} from "@/api/base/types";
-import {ApplicationServer} from "@/api/application/types/server";
-import {Node} from "@/api/application/types/node";
-import {Nullable} from "@/utils/types";
-
+import {GenericResponse} from "@/api/base/types"
+import {ApplicationServer} from "@/api/application/types/server"
+import {Node} from "@/api/application/types/node"
+import {Nullable} from "@/utils/types"
 
 export type Allocation = {
-    id: number,
-    ip: string,
-    alias: Nullable<string>,
-    port: number,
-    notes: Nullable<string>,
+    id: number
+    ip: string
+    alias: Nullable<string>
+    port: number
+    notes: Nullable<string>
     assigned: boolean
 }
 
 export type AllocationRel = Allocation & {
     relationships?: {
-        node?: GenericResponse<Node, "node">,
+        node?: GenericResponse<Node, "node">
         server?: GenericResponse<ApplicationServer, "server">
     }
-}
+}

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

@@ -1,34 +1,34 @@
-import {GenericListResponse, GenericResponse} from "@/api/base/types";
-import {ApplicationServer} from "@/api/application/types/server";
-import {Nullable} from "@/utils/types";
+import {GenericListResponse, GenericResponse} from "@/api/base/types"
+import {ApplicationServer} from "@/api/application/types/server"
+import {Nullable} from "@/utils/types"
 
 export type ApplicationUser = {
-    id: number,
-    external_id: Nullable<string>,
-    uuid: string,
-    username: string,
-    email: string,
-    language: string,
-    root_admin: string,
-    "2fa_enabled": boolean,
-    "2fa": boolean,
-    created_at: string,
-    updated_at: Nullable<string>,
+    id: number
+    external_id: Nullable<string>
+    uuid: string
+    username: string
+    email: string
+    language: string
+    root_admin: string
+    "2fa_enabled": boolean
+    "2fa": boolean
+    created_at: string
+    updated_at: Nullable<string>
     relationships?: {
         servers: GenericListResponse<GenericResponse<ApplicationServer>>
     }
 }
 
 export type ApplicationUserApiKey = {
-    id: number,
-    user_id: number,
-    key_type: 1,
-    identifier: string,
-    memo: string,
-    allowed_ips: Array<string>,
-    permissions: [],
-    last_used_at: Nullable<string>,
-    expires_at: Nullable<string>,
-    created_at: string,
+    id: number
+    user_id: number
+    key_type: 1
+    identifier: string
+    memo: string
+    allowed_ips: Array<string>
+    permissions: []
+    last_used_at: Nullable<string>
+    expires_at: Nullable<string>
+    created_at: string
     updated_at: string
-}
+}

package/src/api/application/users.ts

@@ -1,12 +1,14 @@
-import {AxiosInstance} from "axios";
-import z from "zod";
-import {GenericListResponse, GenericResponse} from "@/api/base/types";
-import {ApplicationUser, ApplicationUserApiKey} from "@/api/application/types/user";
-import {ArrayQueryParams, SortParam} from "@/utils/transform";
-import {ExactlyOneKey} from "@/utils/types";
-import {languagesSchema, timezonesSchema} from "@/api/common/types/enums";
-import {APIKey} from "@/api/client/types";
-
+import {AxiosInstance} from "axios"
+import z from "zod"
+import {GenericListResponse, GenericResponse} from "@/api/base/types"
+import {
+    ApplicationUser,
+    ApplicationUserApiKey
+} from "@/api/application/types/user"
+import {ArrayQueryParams, SortParam} from "@/utils/transform"
+import {ExactlyOneKey} from "@/utils/types"
+import {languagesSchema, timezonesSchema} from "@/api/common/types/enums"
+import {APIKey} from "@/api/client/types"
 
 export class Users {
     private readonly r: AxiosInstance
@@ -38,20 +40,18 @@ export class Users {
 
     info = async (
         id: number,
-        {include}: { include?: ("servers")[] }
+        {include}: {include?: "servers"[]}
     ): Promise<ApplicationUser> => {
         z.number().positive().parse(id)
         const {data} = await this.r.get<
             GenericResponse<ApplicationUser, "user">
-        >(`/users/${id}`, {
-            params: {include: include?.join(",")}
-        })
+        >(`/users/${id}`, {params: {include: include?.join(",")}})
         return data.attributes
     }
 
     infoByExternal = async (
         external_id: string,
-        {include}: { include?: ("servers")[] }
+        {include}: {include?: "servers"[]}
     ): Promise<ApplicationUser> => {
         const {data} = await this.r.get<
             GenericResponse<ApplicationUser, "user">
@@ -61,7 +61,9 @@ export class Users {
         return data.attributes
     }
 
-    create = async (user: z.infer<typeof CreateSchema>): Promise<ApplicationUser> => {
+    create = async (
+        user: z.infer<typeof CreateSchema>
+    ): Promise<ApplicationUser> => {
         user = CreateSchema.parse(user)
         const {data} = await this.r.post<
             GenericResponse<ApplicationUser, "user">
@@ -69,7 +71,10 @@ export class Users {
         return data.attributes
     }
 
-    update = async (id: number, user: z.infer<typeof CreateSchema>): Promise<ApplicationUser> => {
+    update = async (
+        id: number,
+        user: z.infer<typeof CreateSchema>
+    ): Promise<ApplicationUser> => {
         user = CreateSchema.parse(user)
         const {data} = await this.r.patch<
             GenericResponse<ApplicationUser, "user">
@@ -95,15 +100,25 @@ export class Users {
     apiKeys = {
         list: async (id: number): Promise<ApplicationUserApiKey[]> => {
             const {data} = await this.r.get<
-                GenericListResponse<GenericResponse<ApplicationUserApiKey, "api_key">>
+                GenericListResponse<
+                    GenericResponse<ApplicationUserApiKey, "api_key">
+                >
             >(`/users/${id}/api-keys`)
             return data.data.map(k => k.attributes)
         },
 
-        create: async (id: number, description: string, allowed_ips?: string[]): Promise<ApplicationUserApiKey & { secret_token: string }> => {
+        create: async (
+            id: number,
+            description: string,
+            allowed_ips?: string[]
+        ): Promise<ApplicationUserApiKey & {secret_token: string}> => {
             allowed_ips = z.array(z.ipv4()).optional().parse(allowed_ips)
             const {data} = await this.r.post<
-                GenericResponse<ApplicationUserApiKey, "api_key", { secret_token: string }>
+                GenericResponse<
+                    ApplicationUserApiKey,
+                    "api_key",
+                    {secret_token: string}
+                >
             >(`/users/${id}/api-keys`, {description, allowed_ips})
             return {...data.attributes, secret_token: data.meta!.secret_token}
         },
@@ -114,14 +129,10 @@ export class Users {
     }
 }
 
-type ListType = {
-    include?: ("servers")[],
-    filters?: ListFilters,
-    sort?: ListSort
-}
+type ListType = {include?: "servers"[]; filters?: ListFilters; sort?: ListSort}
 type ListFilters = {
-    [key in "email" | "uuid" | "username" | "external_id"]: string;
-};
+    [key in "email" | "uuid" | "username" | "external_id"]: string
+}
 
 type ListSort = ExactlyOneKey<"id" | "uuid", "asc" | "desc">
 
@@ -132,4 +143,4 @@ const CreateSchema = z.object({
     password: z.string().optional(),
     language: languagesSchema,
     timezone: timezonesSchema
-})
+})

package/src/api/base/request.ts

@@ -1,33 +1,44 @@
 import z from "zod"
-import axios, {AxiosInstance, AxiosResponse} from "axios";
-import {PterodactylError, PterodactylException} from "@/api/base/types";
+import axios, {AxiosInstance, AxiosResponse} from "axios"
+import {PterodactylError, PterodactylException} from "@/api/base/types"
 
 export class Agent {
     private readonly base_url: string
     private readonly token: string
     readonly requester: AxiosInstance
 
-    constructor(url: string, token: string, type: "client" | "application", suffix: string = "/api") {
-        this.base_url = z.url("Invalid URL Schema").transform(url => new URL(url).href).parse(url)
-        this.token = z.string().regex(/^(ptl[ac]|pacc|papp)_.+$/, "Invalid token type").parse(token)
+    constructor(
+        url: string,
+        token: string,
+        type: "client" | "application",
+        suffix: string = "/api"
+    ) {
+        this.base_url = z
+            .url("Invalid URL Schema")
+            .transform(url => new URL(url).href)
+            .parse(url)
+        this.token = z
+            .string()
+            .regex(/^(ptl[ac]|pacc|papp)_.+$/, "Invalid token type")
+            .parse(token)
 
         this.requester = axios.create({
-            baseURL: this.base_url.replace(/\/+$/, "")+`${suffix}/${type}`,
+            baseURL: this.base_url.replace(/\/+$/, "") + `${suffix}/${type}`,
             timeout: 3000,
-            headers: {
-                Authorization: `Bearer ${this.token}`
-            }
+            headers: {Authorization: `Bearer ${this.token}`}
         })
 
-        this.requester.interceptors.response.use(undefined, (error: any)=>{
+        this.requester.interceptors.response.use(undefined, (error: any) => {
             if (error.response && error.response.status === 400) {
-                return Promise.reject(new PterodactylException(
-                    'Invalid request data',
-                    error.response.data as PterodactylError[],
-                    error.response.status
-                ));
+                return Promise.reject(
+                    new PterodactylException(
+                        "Invalid request data",
+                        error.response.data as PterodactylError[],
+                        error.response.status
+                    )
+                )
             }
-            return Promise.reject(error);
+            return Promise.reject(error)
         })
     }
-}
+}