@pelican.ts/sdk 0.3.3 → 0.3.4-next.2

package/README.md

@@ -4,6 +4,10 @@
 
 # Pelican.ts — Typescript client for Pelican panel
 
+> [!WARNING]  
+> This is a `next` version of Pelican.ts, it is based on [Pelican-contrib](https://github.com/m41denx/pelican-contrib) 
+> fork and is not compatible with upstream Pelican panel.
+
 ## Installation
 ```shell
 npm install @pelican.ts/sdk
@@ -32,7 +36,7 @@ What's done:
   - [X] Nodes
   - [X] Servers
     - [X] Databases (TODO: Check if server database type is valid)
-  - [X] Database Hosts (TODO: find out why create API returns 500 No Route)
+  - [X] Database Hosts (~~TODO: find out why create API returns 500 No Route~~ Fix was merged to upstream)
   - [X] Roles
   - [X] Eggs
   - [X] Mounts

package/dist/index.d.mts

@@ -11,7 +11,6 @@ type ExactlyOneKey<K extends keyof any, V, KK extends keyof any = K> = {
         [Q in keyof O]: O[Q];
     } : never;
 }[K];
-type Omit<T, K extends keyof T> = Pick<T, Exclude<keyof T, K>>;
 type PartialBy<T, K extends keyof T> = Omit<T, K> & Partial<Pick<T, K>>;
 type Nullable<T> = T | null;
 
@@ -360,9 +359,9 @@ declare class ServerUsers {
     constructor(requester: AxiosInstance, id: string);
     list: () => Promise<ServerSubuser[]>;
     create: (email: string, permissions: SubuserPermission[] | string[]) => Promise<ServerSubuser>;
-    info: (user_id: number) => Promise<ServerSubuser>;
-    update: (user_id: number, permissions: SubuserPermission[] | string[]) => Promise<ServerSubuser>;
-    delete: (user_id: number) => Promise<void>;
+    info: (user_uuid: string) => Promise<ServerSubuser>;
+    update: (user_uuid: string, permissions: SubuserPermission[] | string[]) => Promise<ServerSubuser>;
+    delete: (user_uuid: string) => Promise<void>;
 }
 
 type ServerBackup = {
@@ -556,6 +555,7 @@ declare class Client$1 {
     account: Account;
     private readonly r;
     constructor(requester: AxiosInstance);
+    get $r(): AxiosInstance;
     listPermissions: () => Promise<Record<string, Permission>>;
     listServers: (type?: "accessible" | "mine" | "admin" | "admin-all", page?: number, per_page?: number, include?: ("egg" | "subusers")[]) => Promise<Server[]>;
     server: (uuid: string) => ServerClient;
@@ -579,6 +579,7 @@ type ApplicationServer = {
     name: string;
     description: string;
     status: Nullable<unknown>;
+    docker_labels: Record<string, string>;
     suspended: boolean;
     limits: ServerLimits;
     feature_limits: FeatureLimits;
@@ -607,6 +608,19 @@ type ApplicationUser = {
         servers: GenericListResponse<GenericResponse<ApplicationServer>>;
     };
 };
+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;
+    updated_at: string;
+};
 
 declare class Users {
     private readonly r;
@@ -623,6 +637,13 @@ declare class Users {
     delete: (id: number) => Promise<void>;
     addRoles: (id: number, roles: number[]) => Promise<void>;
     removeRoles: (id: number, roles: number[]) => Promise<void>;
+    apiKeys: {
+        list: (id: number) => Promise<ApplicationUserApiKey[]>;
+        create: (id: number, description: string, allowed_ips?: string[]) => Promise<ApplicationUserApiKey & {
+            secret_token: string;
+        }>;
+        delete: (id: number, identifier: string) => Promise<void>;
+    };
 }
 type ListType = {
     include?: ("servers")[];
@@ -1369,10 +1390,11 @@ declare const CreateServerSchema: z.ZodObject<{
     egg: z.ZodNumber;
     docker_image: z.ZodOptional<z.ZodString>;
     startup: z.ZodOptional<z.ZodString>;
-    environment: z.ZodArray<z.ZodString>;
+    environment: z.ZodRecord<z.ZodString, z.ZodString>;
     skip_scripts: z.ZodOptional<z.ZodBoolean>;
     oom_killer: z.ZodOptional<z.ZodBoolean>;
     start_on_completion: z.ZodOptional<z.ZodBoolean>;
+    docker_labels: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
     limits: z.ZodObject<{
         memory: z.ZodNumber;
         swap: z.ZodNumber;
@@ -1401,6 +1423,7 @@ declare const UpdateDetailsSchema: z.ZodObject<{
     description: z.ZodOptional<z.ZodString>;
     name: z.ZodString;
     external_id: z.ZodOptional<z.ZodString>;
+    docker_labels: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
 }, z.core.$strip>;
 declare const UpdateBuildSchema: z.ZodObject<{
     oom_killer: z.ZodOptional<z.ZodBoolean>;
@@ -1424,7 +1447,7 @@ declare const UpdateBuildSchema: z.ZodObject<{
 declare const UpdateStartupSchema: z.ZodObject<{
     egg: z.ZodNumber;
     startup: z.ZodOptional<z.ZodString>;
-    environment: z.ZodArray<z.ZodString>;
+    environment: z.ZodRecord<z.ZodString, z.ZodString>;
     skip_scripts: z.ZodOptional<z.ZodBoolean>;
     image: z.ZodOptional<z.ZodString>;
 }, z.core.$strip>;
@@ -1487,7 +1510,7 @@ type Egg = {
     description: string;
     features: string[];
     tags: string[];
-    docker_image: string;
+    docker_image: Nullable<string>;
     docker_images: Record<string, string>;
     config: {
         files: Record<string, FileConfig>;
@@ -1513,6 +1536,38 @@ type FileConfig = {
     parser: string;
     find: Record<string, string>;
 };
+type ApplicationEggVariable = Omit<EggVariable, "server_value" | "is_editable" | "rules"> & {
+    rules: string[];
+    sort: number;
+    user_viewable: boolean;
+    user_editable: boolean;
+};
+type ExportedEgg = {
+    meta: {
+        version: "PLCN_v3";
+        update_url: Nullable<string>;
+    };
+    exported_at: string;
+    name: number;
+    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>;
+    config: Omit<Egg["config"], "extends" | "file_denylist">;
+    scripts: {
+        installation: {
+            script: string;
+            container: string;
+            entrypoint: string;
+        };
+    };
+    variables: ApplicationEggVariable[];
+};
 
 declare class Eggs {
     private readonly r;
@@ -1520,6 +1575,7 @@ declare class Eggs {
     list: () => Promise<Egg[]>;
     info: (id: number) => Promise<Egg>;
     export: (id: number, format: "json" | "yaml") => Promise<string>;
+    infoExportable: (id: number) => Promise<ExportedEgg>;
 }
 
 type Mount = {
@@ -1568,6 +1624,7 @@ declare class Client {
     eggs: Eggs;
     mounts: Mounts;
     constructor(requester: AxiosInstance);
+    get $r(): AxiosInstance;
     listServers: (search?: string, page?: number) => Promise<ApplicationServer[]>;
     createServer: (opts: z.infer<typeof CreateServerSchema>) => Promise<ApplicationServer>;
     getServerByExternalId: (external_id: string, include?: ("egg" | "subusers")[]) => Promise<ApplicationServer>;

package/dist/index.d.ts

@@ -11,7 +11,6 @@ type ExactlyOneKey<K extends keyof any, V, KK extends keyof any = K> = {
         [Q in keyof O]: O[Q];
     } : never;
 }[K];
-type Omit<T, K extends keyof T> = Pick<T, Exclude<keyof T, K>>;
 type PartialBy<T, K extends keyof T> = Omit<T, K> & Partial<Pick<T, K>>;
 type Nullable<T> = T | null;
 
@@ -360,9 +359,9 @@ declare class ServerUsers {
     constructor(requester: AxiosInstance, id: string);
     list: () => Promise<ServerSubuser[]>;
     create: (email: string, permissions: SubuserPermission[] | string[]) => Promise<ServerSubuser>;
-    info: (user_id: number) => Promise<ServerSubuser>;
-    update: (user_id: number, permissions: SubuserPermission[] | string[]) => Promise<ServerSubuser>;
-    delete: (user_id: number) => Promise<void>;
+    info: (user_uuid: string) => Promise<ServerSubuser>;
+    update: (user_uuid: string, permissions: SubuserPermission[] | string[]) => Promise<ServerSubuser>;
+    delete: (user_uuid: string) => Promise<void>;
 }
 
 type ServerBackup = {
@@ -556,6 +555,7 @@ declare class Client$1 {
     account: Account;
     private readonly r;
     constructor(requester: AxiosInstance);
+    get $r(): AxiosInstance;
     listPermissions: () => Promise<Record<string, Permission>>;
     listServers: (type?: "accessible" | "mine" | "admin" | "admin-all", page?: number, per_page?: number, include?: ("egg" | "subusers")[]) => Promise<Server[]>;
     server: (uuid: string) => ServerClient;
@@ -579,6 +579,7 @@ type ApplicationServer = {
     name: string;
     description: string;
     status: Nullable<unknown>;
+    docker_labels: Record<string, string>;
     suspended: boolean;
     limits: ServerLimits;
     feature_limits: FeatureLimits;
@@ -607,6 +608,19 @@ type ApplicationUser = {
         servers: GenericListResponse<GenericResponse<ApplicationServer>>;
     };
 };
+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;
+    updated_at: string;
+};
 
 declare class Users {
     private readonly r;
@@ -623,6 +637,13 @@ declare class Users {
     delete: (id: number) => Promise<void>;
     addRoles: (id: number, roles: number[]) => Promise<void>;
     removeRoles: (id: number, roles: number[]) => Promise<void>;
+    apiKeys: {
+        list: (id: number) => Promise<ApplicationUserApiKey[]>;
+        create: (id: number, description: string, allowed_ips?: string[]) => Promise<ApplicationUserApiKey & {
+            secret_token: string;
+        }>;
+        delete: (id: number, identifier: string) => Promise<void>;
+    };
 }
 type ListType = {
     include?: ("servers")[];
@@ -1369,10 +1390,11 @@ declare const CreateServerSchema: z.ZodObject<{
     egg: z.ZodNumber;
     docker_image: z.ZodOptional<z.ZodString>;
     startup: z.ZodOptional<z.ZodString>;
-    environment: z.ZodArray<z.ZodString>;
+    environment: z.ZodRecord<z.ZodString, z.ZodString>;
     skip_scripts: z.ZodOptional<z.ZodBoolean>;
     oom_killer: z.ZodOptional<z.ZodBoolean>;
     start_on_completion: z.ZodOptional<z.ZodBoolean>;
+    docker_labels: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
     limits: z.ZodObject<{
         memory: z.ZodNumber;
         swap: z.ZodNumber;
@@ -1401,6 +1423,7 @@ declare const UpdateDetailsSchema: z.ZodObject<{
     description: z.ZodOptional<z.ZodString>;
     name: z.ZodString;
     external_id: z.ZodOptional<z.ZodString>;
+    docker_labels: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
 }, z.core.$strip>;
 declare const UpdateBuildSchema: z.ZodObject<{
     oom_killer: z.ZodOptional<z.ZodBoolean>;
@@ -1424,7 +1447,7 @@ declare const UpdateBuildSchema: z.ZodObject<{
 declare const UpdateStartupSchema: z.ZodObject<{
     egg: z.ZodNumber;
     startup: z.ZodOptional<z.ZodString>;
-    environment: z.ZodArray<z.ZodString>;
+    environment: z.ZodRecord<z.ZodString, z.ZodString>;
     skip_scripts: z.ZodOptional<z.ZodBoolean>;
     image: z.ZodOptional<z.ZodString>;
 }, z.core.$strip>;
@@ -1487,7 +1510,7 @@ type Egg = {
     description: string;
     features: string[];
     tags: string[];
-    docker_image: string;
+    docker_image: Nullable<string>;
     docker_images: Record<string, string>;
     config: {
         files: Record<string, FileConfig>;
@@ -1513,6 +1536,38 @@ type FileConfig = {
     parser: string;
     find: Record<string, string>;
 };
+type ApplicationEggVariable = Omit<EggVariable, "server_value" | "is_editable" | "rules"> & {
+    rules: string[];
+    sort: number;
+    user_viewable: boolean;
+    user_editable: boolean;
+};
+type ExportedEgg = {
+    meta: {
+        version: "PLCN_v3";
+        update_url: Nullable<string>;
+    };
+    exported_at: string;
+    name: number;
+    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>;
+    config: Omit<Egg["config"], "extends" | "file_denylist">;
+    scripts: {
+        installation: {
+            script: string;
+            container: string;
+            entrypoint: string;
+        };
+    };
+    variables: ApplicationEggVariable[];
+};
 
 declare class Eggs {
     private readonly r;
@@ -1520,6 +1575,7 @@ declare class Eggs {
     list: () => Promise<Egg[]>;
     info: (id: number) => Promise<Egg>;
     export: (id: number, format: "json" | "yaml") => Promise<string>;
+    infoExportable: (id: number) => Promise<ExportedEgg>;
 }
 
 type Mount = {
@@ -1568,6 +1624,7 @@ declare class Client {
     eggs: Eggs;
     mounts: Mounts;
     constructor(requester: AxiosInstance);
+    get $r(): AxiosInstance;
     listServers: (search?: string, page?: number) => Promise<ApplicationServer[]>;
     createServer: (opts: z.infer<typeof CreateServerSchema>) => Promise<ApplicationServer>;
     getServerByExternalId: (external_id: string, include?: ("egg" | "subusers")[]) => Promise<ApplicationServer>;

package/dist/index.js

@@ -309,16 +309,16 @@ var ServerUsers = class {
     const { data } = await this.r.post(`/servers/${this.id}/users`, { email, permissions });
     return data.attributes;
   };
-  info = async (user_id) => {
-    const { data } = await this.r.get(`/servers/${this.id}/users/${user_id}`);
+  info = async (user_uuid) => {
+    const { data } = await this.r.get(`/servers/${this.id}/users/${user_uuid}`);
     return data.attributes;
   };
-  update = async (user_id, permissions) => {
-    const { data } = await this.r.put(`/servers/${this.id}/users/${user_id}`, { permissions });
+  update = async (user_uuid, permissions) => {
+    const { data } = await this.r.put(`/servers/${this.id}/users/${user_uuid}`, { permissions });
     return data.attributes;
   };
-  delete = async (user_id) => {
-    await this.r.delete(`/servers/${this.id}/users/${user_id}`);
+  delete = async (user_uuid) => {
+    await this.r.delete(`/servers/${this.id}/users/${user_uuid}`);
   };
 };
 
@@ -901,13 +901,16 @@ var Client = class {
     this.r = requester;
     this.account = new Account(requester);
   }
+  get $r() {
+    return this.r;
+  }
   listPermissions = async () => {
     const { data } = await this.r.get("/permissions");
     return data.attributes.permissions;
   };
   listServers = async (type = "accessible", page = 1, per_page = 50, include) => {
     import_zod5.default.number().positive().parse(page);
-    const { data } = await this.r.get("/servers", {
+    const { data } = await this.r.get("/", {
       params: { type, page, include: include?.join(",") }
     });
     return data.data.map((s) => s.attributes);
@@ -1546,6 +1549,20 @@ var Users = class {
     import_zod7.default.number().positive().parse(id);
     await this.r.patch(`/users/${id}/roles/remove`, { roles });
   };
+  apiKeys = {
+    list: async (id) => {
+      const { data } = await this.r.get(`/users/${id}/api-keys`);
+      return data.data.map((k) => k.attributes);
+    },
+    create: async (id, description, allowed_ips) => {
+      allowed_ips = import_zod7.default.array(import_zod7.default.ipv4()).optional().parse(allowed_ips);
+      const { data } = await this.r.post(`/users/${id}/api-keys`, { description, allowed_ips });
+      return { ...data.attributes, secret_token: data.meta.secret_token };
+    },
+    delete: async (id, identifier) => {
+      await this.r.delete(`/users/${id}/api-keys/${identifier}`);
+    }
+  };
 };
 var CreateSchema = import_zod7.default.object({
   email: import_zod7.default.email(),
@@ -1759,10 +1776,11 @@ var CreateServerSchema = import_zod11.default.object({
   egg: import_zod11.default.number(),
   docker_image: import_zod11.default.string().optional(),
   startup: import_zod11.default.string().optional(),
-  environment: import_zod11.default.array(import_zod11.default.string()),
+  environment: import_zod11.default.record(import_zod11.default.string(), import_zod11.default.string()),
   skip_scripts: import_zod11.default.boolean().optional(),
   oom_killer: import_zod11.default.boolean().optional(),
   start_on_completion: import_zod11.default.boolean().optional(),
+  docker_labels: import_zod11.default.record(import_zod11.default.string(), import_zod11.default.string()).optional(),
   limits: import_zod11.default.object({
     memory: import_zod11.default.number().min(0),
     swap: import_zod11.default.number().min(-1),
@@ -1790,7 +1808,8 @@ var UpdateDetailsSchema = CreateServerSchema.pick({
   external_id: true,
   name: true,
   user: true,
-  description: true
+  description: true,
+  docker_labels: true
 });
 var UpdateBuildSchema = CreateServerSchema.pick({
   oom_killer: true,
@@ -1900,6 +1919,10 @@ var Eggs = class {
     });
     return data;
   };
+  infoExportable = async (id) => {
+    const { data } = await this.r.get(`/eggs/${id}/export`, { params: { format: "json" } });
+    return data;
+  };
 };
 
 // src/api/application/mounts.ts
@@ -1987,6 +2010,9 @@ var Client2 = class {
     this.eggs = new Eggs(requester);
     this.mounts = new Mounts(requester);
   }
+  get $r() {
+    return this.r;
+  }
   listServers = async (search, page = 1) => {
     const { data } = await this.r.get("/servers", {
       params: { search, page }

package/dist/index.mjs

@@ -272,16 +272,16 @@ var ServerUsers = class {
     const { data } = await this.r.post(`/servers/${this.id}/users`, { email, permissions });
     return data.attributes;
   };
-  info = async (user_id) => {
-    const { data } = await this.r.get(`/servers/${this.id}/users/${user_id}`);
+  info = async (user_uuid) => {
+    const { data } = await this.r.get(`/servers/${this.id}/users/${user_uuid}`);
     return data.attributes;
   };
-  update = async (user_id, permissions) => {
-    const { data } = await this.r.put(`/servers/${this.id}/users/${user_id}`, { permissions });
+  update = async (user_uuid, permissions) => {
+    const { data } = await this.r.put(`/servers/${this.id}/users/${user_uuid}`, { permissions });
     return data.attributes;
   };
-  delete = async (user_id) => {
-    await this.r.delete(`/servers/${this.id}/users/${user_id}`);
+  delete = async (user_uuid) => {
+    await this.r.delete(`/servers/${this.id}/users/${user_uuid}`);
   };
 };
 
@@ -864,13 +864,16 @@ var Client = class {
     this.r = requester;
     this.account = new Account(requester);
   }
+  get $r() {
+    return this.r;
+  }
   listPermissions = async () => {
     const { data } = await this.r.get("/permissions");
     return data.attributes.permissions;
   };
   listServers = async (type = "accessible", page = 1, per_page = 50, include) => {
     z5.number().positive().parse(page);
-    const { data } = await this.r.get("/servers", {
+    const { data } = await this.r.get("/", {
       params: { type, page, include: include?.join(",") }
     });
     return data.data.map((s) => s.attributes);
@@ -1509,6 +1512,20 @@ var Users = class {
     z7.number().positive().parse(id);
     await this.r.patch(`/users/${id}/roles/remove`, { roles });
   };
+  apiKeys = {
+    list: async (id) => {
+      const { data } = await this.r.get(`/users/${id}/api-keys`);
+      return data.data.map((k) => k.attributes);
+    },
+    create: async (id, description, allowed_ips) => {
+      allowed_ips = z7.array(z7.ipv4()).optional().parse(allowed_ips);
+      const { data } = await this.r.post(`/users/${id}/api-keys`, { description, allowed_ips });
+      return { ...data.attributes, secret_token: data.meta.secret_token };
+    },
+    delete: async (id, identifier) => {
+      await this.r.delete(`/users/${id}/api-keys/${identifier}`);
+    }
+  };
 };
 var CreateSchema = z7.object({
   email: z7.email(),
@@ -1722,10 +1739,11 @@ var CreateServerSchema = z11.object({
   egg: z11.number(),
   docker_image: z11.string().optional(),
   startup: z11.string().optional(),
-  environment: z11.array(z11.string()),
+  environment: z11.record(z11.string(), z11.string()),
   skip_scripts: z11.boolean().optional(),
   oom_killer: z11.boolean().optional(),
   start_on_completion: z11.boolean().optional(),
+  docker_labels: z11.record(z11.string(), z11.string()).optional(),
   limits: z11.object({
     memory: z11.number().min(0),
     swap: z11.number().min(-1),
@@ -1753,7 +1771,8 @@ var UpdateDetailsSchema = CreateServerSchema.pick({
   external_id: true,
   name: true,
   user: true,
-  description: true
+  description: true,
+  docker_labels: true
 });
 var UpdateBuildSchema = CreateServerSchema.pick({
   oom_killer: true,
@@ -1863,6 +1882,10 @@ var Eggs = class {
     });
     return data;
   };
+  infoExportable = async (id) => {
+    const { data } = await this.r.get(`/eggs/${id}/export`, { params: { format: "json" } });
+    return data;
+  };
 };
 
 // src/api/application/mounts.ts
@@ -1950,6 +1973,9 @@ var Client2 = class {
     this.eggs = new Eggs(requester);
     this.mounts = new Mounts(requester);
   }
+  get $r() {
+    return this.r;
+  }
   listServers = async (search, page = 1) => {
     const { data } = await this.r.get("/servers", {
       params: { search, page }

package/dist/types.d.ts

@@ -716,6 +716,7 @@ type ApplicationServer = {
     name: string;
     description: string;
     status: Nullable<unknown>;
+    docker_labels: Record<string, string>;
     suspended: boolean;
     limits: ServerLimits;
     feature_limits: FeatureLimits;
@@ -848,7 +849,7 @@ type Egg = {
     description: string;
     features: string[];
     tags: string[];
-    docker_image: string;
+    docker_image: Nullable<string>;
     docker_images: Record<string, string>;
     config: {
         files: Record<string, FileConfig>;
@@ -874,6 +875,38 @@ type FileConfig = {
     parser: string;
     find: Record<string, string>;
 };
+type ApplicationEggVariable = Omit<EggVariable, "server_value" | "is_editable" | "rules"> & {
+    rules: string[];
+    sort: number;
+    user_viewable: boolean;
+    user_editable: boolean;
+};
+type ExportedEgg = {
+    meta: {
+        version: "PLCN_v3";
+        update_url: Nullable<string>;
+    };
+    exported_at: string;
+    name: number;
+    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>;
+    config: Omit<Egg["config"], "extends" | "file_denylist">;
+    scripts: {
+        installation: {
+            script: string;
+            container: string;
+            entrypoint: string;
+        };
+    };
+    variables: ApplicationEggVariable[];
+};
 
 type ApplicationUser = {
     id: number;
@@ -891,6 +924,19 @@ type ApplicationUser = {
         servers: GenericListResponse<GenericResponse<ApplicationServer>>;
     };
 };
+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;
+    updated_at: string;
+};
 
 type ServerStatus = 'starting' | 'stopping' | 'online' | 'offline';
 declare enum SERVER_SIGNAL {
@@ -1118,4 +1164,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 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 };
+export { type APIKey, type Allocation, type AllocationRel, type ApplicationEggVariable, type ApplicationServer, type ApplicationUser, type ApplicationUserApiKey, type AuthSuccessWsEvent, type BackupCompletedEvent, type BackupCompletedJson, type BackupRestoreCompletedEvent, type ConsoleLogWsEvent, type Container, type DaemonErrorEvent, type DaemonMessageEvent, type DatabaseHost, type Egg, type EggVariable, type ExportedEgg, 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,15 +1,15 @@
 {
   "name": "@pelican.ts/sdk",
-  "version": "0.3.3",
+  "version": "0.3.4-next.2",
   "description": "Pelican panel SDK for TypeScript",
   "main": "./dist/index.js",
   "module": "./dist/index.mjs",
   "types": "./dist/index.d.ts",
   "exports": {
     ".": {
+      "types": "./dist/index.d.ts",
       "require": "./dist/index.js",
-      "import": "./dist/index.mjs",
-      "types": "./dist/index.d.ts"
+      "import": "./dist/index.mjs"
     },
     "./types": {
       "types": "./dist/types.d.ts"
@@ -20,9 +20,18 @@
     "build:types": "tsup src/types.ts --dts-only --target esnext",
     "build": "rm -rf ./dist && npm run build:code && npm run build:types",
     "pub": "npm publish --access=public",
-    "generate-types": "bun run scripts/create-types.ts"
+    "pub:next": "npm publish --access=public --tag=next",
+    "generate-types": "bun run scripts/create-types.ts",
+    "pipeline": "bun run generate-types && bun run build && bun run pub:next"
   },
-  "keywords": ["pterodactyl", "pterodactyl.ts", "pterodactyl.js", "pelican", "pelican.ts", "pelican.js"],
+  "keywords": [
+    "pterodactyl",
+    "pterodactyl.ts",
+    "pterodactyl.js",
+    "pelican",
+    "pelican.ts",
+    "pelican.js"
+  ],
   "author": "M41den",
   "license": "MIT",
   "repository": {

package/src/api/application/client.ts

@@ -30,6 +30,10 @@ export class Client {
         this.mounts = new Mounts(requester)
     }
 
+    get $r(): AxiosInstance {
+        return this.r
+    }
+
     listServers = async (
         search?: string,
         page: number = 1

package/src/api/application/eggs.ts

@@ -1,6 +1,6 @@
 import {AxiosInstance} from "axios";
 import {GenericListResponse, GenericResponse} from "@/api/base/types";
-import {Egg} from "@/api/application/types/egg";
+import {Egg, ExportedEgg} from "@/api/application/types/egg";
 
 // TODO: API is incomplete
 
@@ -28,4 +28,9 @@ export class Eggs {
         })
         return data
     }
+
+    infoExportable = async (id: number): Promise<ExportedEgg> => {
+        const {data} = await this.r.get<ExportedEgg>(`/eggs/${id}/export`, {params: {format: "json"}})
+        return data
+    }
 }

package/src/api/application/servers.ts

@@ -80,10 +80,11 @@ export const CreateServerSchema = z.object({
     egg: z.number(),
     docker_image: z.string().optional(),
     startup: z.string().optional(),
-    environment: z.array(z.string()),
+    environment: z.record(z.string(), z.string()),
     skip_scripts: z.boolean().optional(),
     oom_killer: z.boolean().optional(),
     start_on_completion: z.boolean().optional(),
+    docker_labels: z.record(z.string(), z.string()).optional(),
     limits: z.object({
         memory: z.number().min(0),
         swap: z.number().min(-1),
@@ -112,7 +113,8 @@ const UpdateDetailsSchema = CreateServerSchema.pick({
     external_id: true,
     name: true,
     user: true,
-    description: true
+    description: true,
+    docker_labels: true
 })
 
 const UpdateBuildSchema = CreateServerSchema.pick({

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

@@ -1,4 +1,5 @@
 import {Nullable} from "@/utils/types";
+import {EggVariable} from "@/api/common/types";
 
 export type Egg = {
     id: number,
@@ -8,7 +9,7 @@ export type Egg = {
     description: string,
     features: string[],
     tags: string[],
-    docker_image: string,
+    docker_image: Nullable<string>,
     docker_images: Record<string, string>,
     config: {
         files: Record<string, FileConfig>
@@ -34,4 +35,38 @@ export type Egg = {
 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 ExportedEgg = {
+    meta: {
+        version: "PLCN_v3",
+        update_url: Nullable<string>
+    },
+    exported_at: string,
+    name: number,
+    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>,
+    config: Omit<Egg["config"], "extends" | "file_denylist">
+    scripts: {
+        installation: {
+            script: string,
+            container: string,
+            entrypoint: string
+        }
+    },
+    variables: ApplicationEggVariable[]
 }

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

@@ -11,6 +11,7 @@ export type ApplicationServer = {
     name: string,
     description: string,
     status: Nullable<unknown>,
+    docker_labels: Record<string, string>,
     suspended: boolean,
     limits: ServerLimits,
     feature_limits: FeatureLimits,

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

@@ -17,4 +17,18 @@ export type ApplicationUser = {
     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,
+    updated_at: string
 }

package/src/api/application/users.ts

@@ -1,10 +1,11 @@
 import {AxiosInstance} from "axios";
 import z from "zod";
 import {GenericListResponse, GenericResponse} from "@/api/base/types";
-import {ApplicationUser} from "@/api/application/types/user";
+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 {
@@ -90,6 +91,27 @@ export class Users {
         z.number().positive().parse(id)
         await this.r.patch(`/users/${id}/roles/remove`, {roles})
     }
+
+    apiKeys = {
+        list: async (id: number): Promise<ApplicationUserApiKey[]> => {
+            const {data} = await this.r.get<
+                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 }> => {
+            allowed_ips = z.array(z.ipv4()).optional().parse(allowed_ips)
+            const {data} = await this.r.post<
+                GenericResponse<ApplicationUserApiKey, "api_key", { secret_token: string }>
+            >(`/users/${id}/api-keys`, {description, allowed_ips})
+            return {...data.attributes, secret_token: data.meta!.secret_token}
+        },
+
+        delete: async (id: number, identifier: string): Promise<void> => {
+            await this.r.delete(`/users/${id}/api-keys/${identifier}`)
+        }
+    }
 }
 
 type ListType = {

package/src/api/client/client.ts

@@ -17,6 +17,10 @@ export class Client {
         this.account = new Account(requester)
     }
 
+    get $r(): AxiosInstance {
+        return this.r
+    }
+
     listPermissions = async (): Promise<Record<string, Permission>> => {
         const {data} = await this.r.get<
             GenericResponse<{ permissions: Record<string, Permission> }, "system_permissions">
@@ -34,7 +38,7 @@ export class Client {
         z.number().positive().parse(page)
         const {data} = await this.r.get<
             GenericListResponse<GenericResponse<Server, "server">>
-        >("/servers", {
+        >("/", {
             params: {type, page, include: include?.join(",")}
         })
         return data.data.map(s => s.attributes)

package/src/api/client/server_users.ts

@@ -25,22 +25,22 @@ export class ServerUsers {
         return data.attributes
     }
 
-    info = async (user_id: number): Promise<ServerSubuser> => {
+    info = async (user_uuid: string): Promise<ServerSubuser> => {
         const {data} = await this.r.get<
             GenericResponse<ServerSubuser, "user">
-        >(`/servers/${this.id}/users/${user_id}`)
+        >(`/servers/${this.id}/users/${user_uuid}`)
         return data.attributes
     }
 
-    update = async (user_id: number, permissions: SubuserPermission[] | string[]): Promise<ServerSubuser> => {
+    update = async (user_uuid: string, permissions: SubuserPermission[] | string[]): Promise<ServerSubuser> => {
         const {data} = await this.r.put<
             GenericResponse<ServerSubuser, "user">
-        >(`/servers/${this.id}/users/${user_id}`, {permissions})
+        >(`/servers/${this.id}/users/${user_uuid}`, {permissions})
         return data.attributes
     }
 
-    delete = async (user_id: number): Promise<void> => {
-        await this.r.delete(`/servers/${this.id}/users/${user_id}`)
+    delete = async (user_uuid: string): Promise<void> => {
+        await this.r.delete(`/servers/${this.id}/users/${user_uuid}`)
     }
 
 }

package/src/utils/types.ts

@@ -5,7 +5,6 @@ export type ExactlyOneKey<K extends keyof any, V, KK extends keyof any = K> =
         { [Q in keyof O]: O[Q] } : never
     }[K];
 
-export type Omit<T, K extends keyof T> = Pick<T, Exclude<keyof T, K>>
 export type PartialBy<T, K extends keyof T> = Omit<T, K> & Partial<Pick<T, K>>