@pelican.ts/sdk 0.2.5 → 0.3.1

package/dist/types.d.ts

@@ -812,6 +812,17 @@ type NodeConfiguration = {
     remote: string;
 };
 
+type Mount = {
+    id: number;
+    uuid: string;
+    name: string;
+    description: Nullable<string>;
+    source: string;
+    target: string;
+    read_only: boolean;
+    user_mountable: boolean;
+};
+
 type DatabaseHost = {
     id: number;
     name: string;
@@ -829,6 +840,41 @@ type Role = {
     updated_at: string;
 };
 
+type Egg = {
+    id: number;
+    uuid: string;
+    name: number;
+    author: string;
+    description: string;
+    features: string[];
+    tags: string[];
+    docker_image: string;
+    docker_images: Record<string, string>;
+    config: {
+        files: Record<string, FileConfig>;
+        startup: Record<string, string>;
+        stop: string;
+        logs: object | [];
+        file_denylist: string[];
+        extends: Nullable<number>;
+    };
+    startup: string;
+    startup_commands: Record<string, string>;
+    script: {
+        privileged: boolean;
+        install: string;
+        entry: string;
+        container: string;
+        extends: Nullable<number>;
+    };
+    created_at: string;
+    updated_at: Nullable<string>;
+};
+type FileConfig = {
+    parser: string;
+    find: Record<string, string>;
+};
+
 type ApplicationUser = {
     id: number;
     external_id: Nullable<string>;
@@ -1072,4 +1118,4 @@ type Permission = {
     keys: Record<string, string>;
 };
 
-export { type APIKey, type Allocation, type AllocationRel, type ApplicationServer, type ApplicationUser, type AuthSuccessWsEvent, type BackupCompletedEvent, type BackupCompletedJson, type BackupRestoreCompletedEvent, type ConsoleLogWsEvent, type Container, type DaemonErrorEvent, type DaemonMessageEvent, type DatabaseHost, type EggVariable, type FeatureLimits, type FileObject, type InstallCompletedEvent, type InstallOutputEvent, type InstallStartedEvent, type JwtErrorEvent, type LanguagesType, type Location, type Node, type NodeConfiguration, type Permission, type PowerState, type Role, SERVER_SIGNAL, SOCKET_EVENT, type SSHKey, type Schedule, type ScheduleTask, type Server, type ServerActivityLog, type ServerAllocation, type ServerBackup, type ServerDatabase, type ServerLimits, type ServerSignalOption, type ServerStats, type ServerStatus, type ServerSubuser, type StartupMeta, type StartupParams, type StatsWsEvent, type StatsWsJson, type StatusWsEvent, type SubuserPermission, type TimezonesType, type TokenExpiredWsEvent, type TokenExpiringWsEvent, type TransferLogsEvent, type TransferStatusEvent, type User, type WebsocketEvent, languagesSchema, timezonesSchema };
+export { type APIKey, type Allocation, type AllocationRel, type ApplicationServer, type ApplicationUser, type AuthSuccessWsEvent, type BackupCompletedEvent, type BackupCompletedJson, type BackupRestoreCompletedEvent, type ConsoleLogWsEvent, type Container, type DaemonErrorEvent, type DaemonMessageEvent, type DatabaseHost, type Egg, type EggVariable, type FeatureLimits, type FileObject, type InstallCompletedEvent, type InstallOutputEvent, type InstallStartedEvent, type JwtErrorEvent, type LanguagesType, type Location, type Mount, type Node, type NodeConfiguration, type Permission, type PowerState, type Role, SERVER_SIGNAL, SOCKET_EVENT, type SSHKey, type Schedule, type ScheduleTask, type Server, type ServerActivityLog, type ServerAllocation, type ServerBackup, type ServerDatabase, type ServerLimits, type ServerSignalOption, type ServerStats, type ServerStatus, type ServerSubuser, type StartupMeta, type StartupParams, type StatsWsEvent, type StatsWsJson, type StatusWsEvent, type SubuserPermission, type TimezonesType, type TokenExpiredWsEvent, type TokenExpiringWsEvent, type TransferLogsEvent, type TransferStatusEvent, type User, type WebsocketEvent, languagesSchema, timezonesSchema };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pelican.ts/sdk",
-  "version": "0.2.5",
+  "version": "0.3.1",
   "description": "Pelican panel SDK for TypeScript",
   "main": "./dist/index.js",
   "module": "./dist/index.mjs",
@@ -11,7 +11,7 @@
     }
   },
   "scripts": {
-    "build:code": "tsup src/index.ts --format esm,cjs --dts --sourcemap --target esnext",
+    "build:code": "tsup src/index.ts --format esm,cjs --dts --target esnext",
     "build:types": "tsup src/types.ts --dts-only --target esnext",
     "build": "npm run build:code && npm run build:types",
     "pub": "npm publish --access=public",

package/src/api/application/client.ts

@@ -7,6 +7,8 @@ import {CreateServerSchema, Servers} from "@/api/application/servers";
 import z from "zod";
 import {DatabaseHosts} from "@/api/application/database_hosts";
 import {Roles} from "@/api/application/roles";
+import {Eggs} from "@/api/application/eggs";
+import {Mounts} from "@/api/application/mounts";
 
 export class Client {
     private readonly r: AxiosInstance
@@ -14,6 +16,8 @@ export class Client {
     nodes: Nodes
     databaseHosts: DatabaseHosts
     roles: Roles
+    eggs: Eggs
+    mounts: Mounts
 
     constructor(requester: AxiosInstance) {
         this.r = requester
@@ -22,6 +26,8 @@ export class Client {
         this.nodes = new Nodes(requester)
         this.databaseHosts = new DatabaseHosts(requester)
         this.roles = new Roles(requester)
+        this.eggs = new Eggs(requester)
+        this.mounts = new Mounts(requester)
     }
 
     listServers = async (

package/src/api/application/eggs.ts

@@ -0,0 +1,31 @@
+import {AxiosInstance} from "axios";
+import {GenericListResponse, GenericResponse} from "@/api/base/types";
+import {Egg} from "@/api/application/types/egg";
+
+// TODO: API is incomplete
+
+export class Eggs {
+    private readonly r: AxiosInstance
+
+    constructor(r: AxiosInstance) {
+        this.r = r
+    }
+
+    list = async (): Promise<Egg[]> => {
+        const {data} = await this.r.get<GenericListResponse<GenericResponse<Egg, "egg">>>("/eggs")
+        return data.data.map(d => d.attributes)
+    }
+
+    info = async (id: number): Promise<Egg> => {
+        const {data} = await this.r.get<GenericResponse<Egg, "egg">>(`/eggs/${id}`)
+        return data.attributes
+    }
+
+    export = async (id: number, format: "json" | "yaml"): Promise<string> => {
+        const {data} = await this.r.get<string>(`/eggs/${id}/export`, {
+            params: {format},
+            transformResponse: r => r
+        })
+        return data
+    }
+}

package/src/api/application/mounts.ts

@@ -0,0 +1,96 @@
+import {AxiosInstance} from "axios";
+import {Mount} from "@/api/application/types/mount";
+import {GenericListResponse, GenericResponse} from "@/api/base/types";
+import z from "zod";
+import {Egg} from "@/api/application/types/egg";
+import {ApplicationServer} from "@/api/application/types";
+
+export class Mounts {
+    private readonly r: AxiosInstance
+
+    constructor(r: AxiosInstance) {
+        this.r = r
+    }
+
+    list = async (): Promise<Mount[]> => {
+        const {data} = await this.r.get<
+            GenericListResponse<GenericResponse<Mount, "mount">>
+        >("/mounts")
+        return data.data.map(d => d.attributes)
+    }
+
+    info = async (id: number): Promise<Mount> => {
+        const {data} = await this.r.get<GenericResponse<Mount, "mount">>(`/mounts/${id}`)
+        return data.attributes
+    }
+
+    create = async (opts: z.infer<typeof CreateMountSchema>): Promise<Mount> => {
+        opts = CreateMountSchema.parse(opts)
+        const {data} = await this.r.post<GenericResponse<Mount, "mount">>("/mounts", opts)
+        return data.attributes
+    }
+
+    update = async (id: number, opts: z.infer<typeof CreateMountSchema>): Promise<Mount> => {
+        opts = CreateMountSchema.parse(opts)
+        const {data} = await this.r.patch<GenericResponse<Mount, "mount">>(`/mounts/${id}`, opts)
+        return data.attributes
+    }
+
+    delete = async (id: number): Promise<void> => {
+        await this.r.delete(`/mounts/${id}`)
+    }
+
+    listAssignedEggs = async (id: number): Promise<Egg[]> => {
+        const {data} = await this.r.get<
+            GenericListResponse<GenericResponse<Egg, "egg">>
+        >(`/mounts/${id}/eggs`)
+        return data.data.map(d => d.attributes)
+    }
+
+    assignEggs = async (id: number, eggs: number[]): Promise<void> => {
+        await this.r.post(`/mounts/${id}/eggs`, {eggs})
+    }
+
+    unassignEgg = async (id: number, egg_id: number): Promise<void> => {
+        await this.r.delete(`/mounts/${id}/eggs/${egg_id}`)
+    }
+
+    listAssignedNodes = async (id: number): Promise<Node[]> => {
+        const {data} = await this.r.get<
+            GenericListResponse<GenericResponse<Node, "node">>
+        >(`/mounts/${id}/nodes`)
+        return data.data.map(d => d.attributes)
+    }
+
+    assignNodes = async (id: number, nodes: number[]): Promise<void> => {
+        await this.r.post(`/mounts/${id}/nodes`, {nodes})
+    }
+
+    unassignNode = async (id: number, node_id: number): Promise<void> => {
+        await this.r.delete(`/mounts/${id}/nodes/${node_id}`)
+    }
+
+    listAssignedServers = async (id: number): Promise<ApplicationServer[]> => {
+        const {data} = await this.r.get<
+            GenericListResponse<GenericResponse<ApplicationServer, "server">>
+        >(`/mounts/${id}/servers`)
+        return data.data.map(d => d.attributes)
+    }
+
+    assignServers = async (id: number, servers: number[]): Promise<void> => {
+        await this.r.post(`/mounts/${id}/servers`, {servers})
+    }
+
+    unassignServer = async (id: number, server_id: number): Promise<void> => {
+        await this.r.delete(`/mounts/${id}/servers/${server_id}`)
+    }
+}
+
+
+const CreateMountSchema = z.object({
+    name: z.string().min(1).max(255),
+    description: z.string().optional(),
+    source: z.string(),
+    target: z.string(),
+    read_only: z.boolean().optional()
+})

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

@@ -0,0 +1,37 @@
+import {Nullable} from "@/utils/types";
+
+export type Egg = {
+    id: number,
+    uuid: string,
+    name: number,
+    author: string,
+    description: string,
+    features: string[],
+    tags: string[],
+    docker_image: string,
+    docker_images: Record<string, string>,
+    config: {
+        files: Record<string, FileConfig>
+        startup: Record<string, string>,
+        stop: string,
+        logs: object | [],
+        file_denylist: string[],
+        extends: Nullable<number>
+    },
+    startup: string,
+    startup_commands: Record<string, string>,
+    script: {
+        privileged: boolean,
+        install: string,
+        entry: string,
+        container: string,
+        extends: Nullable<number>
+    },
+    created_at: string,
+    updated_at: Nullable<string>
+}
+
+type FileConfig = {
+    parser: string,
+    find: Record<string, string>
+}

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

@@ -1,8 +1,10 @@
 export * from "./node"
+export * from "./mount"
 export * from "./location"
 export * from "./database_host"
 export * from "./container"
 export * from "./role"
+export * from "./egg"
 export * from "./server_allocation"
 export * from "./server"
 export * from "./user"

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

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

package/.idea/Pterodactyl.ts.iml

@@ -1,12 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<module type="WEB_MODULE" version="4">
-  <component name="NewModuleRootManager">
-    <content url="file://$MODULE_DIR$">
-      <excludeFolder url="file://$MODULE_DIR$/.tmp" />
-      <excludeFolder url="file://$MODULE_DIR$/temp" />
-      <excludeFolder url="file://$MODULE_DIR$/tmp" />
-    </content>
-    <orderEntry type="inheritedJdk" />
-    <orderEntry type="sourceFolder" forTests="false" />
-  </component>
-</module>

package/.idea/discord.xml

@@ -1,14 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<project version="4">
-  <component name="DiscordProjectSettings">
-    <option name="show" value="ASK" />
-    <option name="description" value="" />
-    <option name="applicationTheme" value="default" />
-    <option name="iconsTheme" value="default" />
-    <option name="button1Title" value="" />
-    <option name="button1Url" value="" />
-    <option name="button2Title" value="" />
-    <option name="button2Url" value="" />
-    <option name="customApplicationId" value="" />
-  </component>
-</project>

package/.idea/modules.xml

@@ -1,8 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<project version="4">
-  <component name="ProjectModuleManager">
-    <modules>
-      <module fileurl="file://$PROJECT_DIR$/.idea/Pterodactyl.ts.iml" filepath="$PROJECT_DIR$/.idea/Pterodactyl.ts.iml" />
-    </modules>
-  </component>
-</project>

package/.idea/vcs.xml

@@ -1,6 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<project version="4">
-  <component name="VcsDirectoryMappings">
-    <mapping directory="" vcs="Git" />
-  </component>
-</project>