@pelican.ts/sdk 0.4.16-next.3 → 0.5.0

package/CHANGELOG.md

@@ -1,3 +1,18 @@
+## 0.5.0
+## What's Changed
+### ✨ New Features
+- (feat) Application API: Node Allocations now support pagination and specifying page size
+- (feat) Added TSDoc and autogenerated web docs
+- (feat) Support for egg import and deletion (pelican-dev/panel#1947)
+- (feat) Support for new `is_managed_externally` field for user (pelican-dev/panel#1947)
+- ~Full feature parity with beta 30
+
+### 📦 Other changes
+- (fix) Fixed reading JSON files (axios was deserializing them automatically)
+- (fix) Fixed issue when ServerFile had no root by default
+- (fix) Client API: Fixed server state for servers
+- (feat) BREAKING: Removed deprecation `location` from types
+
 ## 0.4.15
 ## What's Changed
 ### 📦 Other changes

package/dist/api/index.d.mts

@@ -43,7 +43,17 @@ declare const CreateDBHostSchema: z.ZodObject<{
     max_databases: z.ZodOptional<z.ZodNumber>;
 }, z.core.$strip>;
 
-type ServerSignalOption = "start" | "stop" | "restart" | "kill";
+type FileObject = {
+    name: string;
+    mode: string;
+    mode_bits: string;
+    size: number;
+    is_file: boolean;
+    is_symlink: boolean;
+    mimetype: string;
+    created_at: string;
+    modified_at: string;
+};
 
 type GenericResponse<T, N extends string = string, M = undefined> = {
     object: N;
@@ -88,16 +98,74 @@ type ServerDatabase = {
     };
 };
 
+type ServerBackup = {
+    uuid: string;
+    is_successful: boolean;
+    is_locked: boolean;
+    name: string;
+    ignored_files: string[];
+    checksum: Nullable<string>;
+    bytes: number;
+    created_at: string;
+    completed_at: Nullable<string>;
+};
+
+type ServerSignalOption = "start" | "stop" | "restart" | "kill";
+
+/**
+ * Server limits indicate how many resources can be used by the server
+ */
 type ServerLimits = {
+    /**
+     * Memory limit in megabytes, 0 = unlimited
+     * @remarks
+     * This is not a pterodactyl's MiB, it's a MB (multiple of 1000).
+     * That means to set 8GB RAM, you should set 8000 instead of 8192
+     */
     memory: number;
+    /**
+     * Swap limit in megabytes, 0 = disabled, -1 = unlimited
+     * @see memory
+     */
     swap: number;
+    /**
+     * Disk limit in megabytes, 0 = unlimited
+     * @see memory
+     */
     disk: number;
+    /**
+     * IO is an arbitrary value indicating IO importance relative to other servers
+     */
     io: number;
+    /**
+     * CPU limit in percentage, 0 = unlimited (1 core = 100%)
+     */
     cpu: number;
+    /**
+     * CPU pinning (Optional)
+     * @usage
+     * ```
+     * 1 or 1,2,4 or 1-4
+     * ```
+     * @remarks
+     * Can be useful to pin workloads to P-cores and avoid E-cores or HT/SMT cores
+     * @see https://superuser.com/questions/122536/what-is-hyper-threading-and-how-does-it-work
+     */
     threads: Nullable<number | string>;
+    /**
+     * If OOM killer should be disabled, opposite of {@link oom_killer}
+     * @deprecated use {@link oom_killer}
+     */
     oom_disabled: boolean;
+    /**
+     * If OOM killer should be enabled, opposite of {@link oom_disabled}
+     */
     oom_killer: boolean;
 };
+/**
+ * Feature limits indicate how many features can user enable by themselves. It doesn't include features assigned
+ * by admins
+ */
 type FeatureLimits = {
     databases: number;
     allocations: number;
@@ -118,40 +186,6 @@ type StartupMeta = {
     raw_startup_command: string;
 };
 
-type ServerBackup = {
-    uuid: string;
-    is_successful: boolean;
-    is_locked: boolean;
-    name: string;
-    ignored_files: string[];
-    checksum: Nullable<string>;
-    bytes: number;
-    created_at: string;
-    completed_at: Nullable<string>;
-};
-
-type EggVariable = {
-    name: string;
-    description: string;
-    env_variable: string;
-    default_value: string;
-    server_value: string;
-    is_editable: boolean;
-    rules: string;
-};
-
-type FileObject = {
-    name: string;
-    mode: string;
-    mode_bits: string;
-    size: number;
-    is_file: boolean;
-    is_symlink: boolean;
-    mimetype: string;
-    created_at: string;
-    modified_at: string;
-};
-
 type Schedule = {
     id: number;
     name: string;
@@ -184,6 +218,16 @@ type ScheduleTask = {
     updated_at: Nullable<string>;
 };
 
+type EggVariable = {
+    name: string;
+    description: string;
+    env_variable: string;
+    default_value: string;
+    server_value: string;
+    is_editable: boolean;
+    rules: string;
+};
+
 type Egg = {
     id: number;
     uuid: string;
@@ -258,8 +302,22 @@ declare class Eggs {
     info: (id: number) => Promise<Egg>;
     export: (id: number, format: "json" | "yaml") => Promise<string>;
     infoExportable: (id: number) => Promise<ExportedEgg>;
+    import: (egg: ExportedEgg | string, format?: "json" | "yaml") => Promise<ExportedEgg>;
+    delete: (id: number) => Promise<void>;
+    deleteByUUID: (uuid: string) => Promise<void>;
 }
 
+type Mount = {
+    id: number;
+    uuid: string;
+    name: string;
+    description: Nullable<string>;
+    source: string;
+    target: string;
+    read_only: boolean;
+    user_mountable: boolean;
+};
+
 type Container = {
     startup_command: string;
     image: string;
@@ -291,21 +349,6 @@ type ApplicationServer = {
     updated_at: Nullable<string>;
 };
 
-type Allocation = {
-    id: number;
-    ip: string;
-    alias: Nullable<string>;
-    port: number;
-    notes: Nullable<string>;
-    assigned: boolean;
-};
-type AllocationRel = Allocation & {
-    relationships?: {
-        node?: GenericResponse<Node$1, "node">;
-        server?: GenericResponse<ApplicationServer, "server">;
-    };
-};
-
 type Node$1 = {
     id: number;
     uuid: string;
@@ -366,27 +409,25 @@ type NodeConfiguration = {
     remote: string;
 };
 
-type Mount = {
+type Allocation = {
     id: number;
-    uuid: string;
-    name: string;
-    description: Nullable<string>;
-    source: string;
-    target: string;
-    read_only: boolean;
-    user_mountable: boolean;
+    ip: string;
+    alias: Nullable<string>;
+    port: number;
+    notes: Nullable<string>;
+    assigned: boolean;
 };
-
-type Role = {
-    id: number;
-    name: string;
-    created_at: string;
-    updated_at: string;
+type AllocationRel = Allocation & {
+    relationships?: {
+        node?: GenericResponse<Node$1, "node">;
+        server?: GenericResponse<ApplicationServer, "server">;
+    };
 };
 
 type ApplicationUser = {
     id: number;
     external_id: Nullable<string>;
+    is_managed_externally: boolean;
     uuid: string;
     username: string;
     email: string;
@@ -414,6 +455,13 @@ type ApplicationUserApiKey = {
     updated_at: string;
 };
 
+type Role = {
+    id: number;
+    name: string;
+    created_at: string;
+    updated_at: string;
+};
+
 declare class Mounts {
     private readonly r;
     constructor(r: AxiosInstance);
@@ -639,6 +687,7 @@ type ListSort = ExactlyOneKey<"id" | "uuid", "asc" | "desc">;
 declare const CreateSchema: z.ZodObject<{
     email: z.ZodEmail;
     external_id: z.ZodOptional<z.ZodString>;
+    is_managed_externally: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
     username: z.ZodString;
     password: z.ZodOptional<z.ZodString>;
     language: z.ZodEnum<{
@@ -1308,7 +1357,7 @@ type Server = {
     docker_image: string;
     egg_features: Nullable<string[]>;
     feature_limits: FeatureLimits;
-    status: Nullable<unknown>;
+    status: Nullable<ServerStats["current_state"]>;
     is_suspended: boolean;
     is_installing: boolean;
     is_transferring: boolean;

package/dist/api/index.d.ts

@@ -43,7 +43,17 @@ declare const CreateDBHostSchema: z.ZodObject<{
     max_databases: z.ZodOptional<z.ZodNumber>;
 }, z.core.$strip>;
 
-type ServerSignalOption = "start" | "stop" | "restart" | "kill";
+type FileObject = {
+    name: string;
+    mode: string;
+    mode_bits: string;
+    size: number;
+    is_file: boolean;
+    is_symlink: boolean;
+    mimetype: string;
+    created_at: string;
+    modified_at: string;
+};
 
 type GenericResponse<T, N extends string = string, M = undefined> = {
     object: N;
@@ -88,16 +98,74 @@ type ServerDatabase = {
     };
 };
 
+type ServerBackup = {
+    uuid: string;
+    is_successful: boolean;
+    is_locked: boolean;
+    name: string;
+    ignored_files: string[];
+    checksum: Nullable<string>;
+    bytes: number;
+    created_at: string;
+    completed_at: Nullable<string>;
+};
+
+type ServerSignalOption = "start" | "stop" | "restart" | "kill";
+
+/**
+ * Server limits indicate how many resources can be used by the server
+ */
 type ServerLimits = {
+    /**
+     * Memory limit in megabytes, 0 = unlimited
+     * @remarks
+     * This is not a pterodactyl's MiB, it's a MB (multiple of 1000).
+     * That means to set 8GB RAM, you should set 8000 instead of 8192
+     */
     memory: number;
+    /**
+     * Swap limit in megabytes, 0 = disabled, -1 = unlimited
+     * @see memory
+     */
     swap: number;
+    /**
+     * Disk limit in megabytes, 0 = unlimited
+     * @see memory
+     */
     disk: number;
+    /**
+     * IO is an arbitrary value indicating IO importance relative to other servers
+     */
     io: number;
+    /**
+     * CPU limit in percentage, 0 = unlimited (1 core = 100%)
+     */
     cpu: number;
+    /**
+     * CPU pinning (Optional)
+     * @usage
+     * ```
+     * 1 or 1,2,4 or 1-4
+     * ```
+     * @remarks
+     * Can be useful to pin workloads to P-cores and avoid E-cores or HT/SMT cores
+     * @see https://superuser.com/questions/122536/what-is-hyper-threading-and-how-does-it-work
+     */
     threads: Nullable<number | string>;
+    /**
+     * If OOM killer should be disabled, opposite of {@link oom_killer}
+     * @deprecated use {@link oom_killer}
+     */
     oom_disabled: boolean;
+    /**
+     * If OOM killer should be enabled, opposite of {@link oom_disabled}
+     */
     oom_killer: boolean;
 };
+/**
+ * Feature limits indicate how many features can user enable by themselves. It doesn't include features assigned
+ * by admins
+ */
 type FeatureLimits = {
     databases: number;
     allocations: number;
@@ -118,40 +186,6 @@ type StartupMeta = {
     raw_startup_command: string;
 };
 
-type ServerBackup = {
-    uuid: string;
-    is_successful: boolean;
-    is_locked: boolean;
-    name: string;
-    ignored_files: string[];
-    checksum: Nullable<string>;
-    bytes: number;
-    created_at: string;
-    completed_at: Nullable<string>;
-};
-
-type EggVariable = {
-    name: string;
-    description: string;
-    env_variable: string;
-    default_value: string;
-    server_value: string;
-    is_editable: boolean;
-    rules: string;
-};
-
-type FileObject = {
-    name: string;
-    mode: string;
-    mode_bits: string;
-    size: number;
-    is_file: boolean;
-    is_symlink: boolean;
-    mimetype: string;
-    created_at: string;
-    modified_at: string;
-};
-
 type Schedule = {
     id: number;
     name: string;
@@ -184,6 +218,16 @@ type ScheduleTask = {
     updated_at: Nullable<string>;
 };
 
+type EggVariable = {
+    name: string;
+    description: string;
+    env_variable: string;
+    default_value: string;
+    server_value: string;
+    is_editable: boolean;
+    rules: string;
+};
+
 type Egg = {
     id: number;
     uuid: string;
@@ -258,8 +302,22 @@ declare class Eggs {
     info: (id: number) => Promise<Egg>;
     export: (id: number, format: "json" | "yaml") => Promise<string>;
     infoExportable: (id: number) => Promise<ExportedEgg>;
+    import: (egg: ExportedEgg | string, format?: "json" | "yaml") => Promise<ExportedEgg>;
+    delete: (id: number) => Promise<void>;
+    deleteByUUID: (uuid: string) => Promise<void>;
 }
 
+type Mount = {
+    id: number;
+    uuid: string;
+    name: string;
+    description: Nullable<string>;
+    source: string;
+    target: string;
+    read_only: boolean;
+    user_mountable: boolean;
+};
+
 type Container = {
     startup_command: string;
     image: string;
@@ -291,21 +349,6 @@ type ApplicationServer = {
     updated_at: Nullable<string>;
 };
 
-type Allocation = {
-    id: number;
-    ip: string;
-    alias: Nullable<string>;
-    port: number;
-    notes: Nullable<string>;
-    assigned: boolean;
-};
-type AllocationRel = Allocation & {
-    relationships?: {
-        node?: GenericResponse<Node$1, "node">;
-        server?: GenericResponse<ApplicationServer, "server">;
-    };
-};
-
 type Node$1 = {
     id: number;
     uuid: string;
@@ -366,27 +409,25 @@ type NodeConfiguration = {
     remote: string;
 };
 
-type Mount = {
+type Allocation = {
     id: number;
-    uuid: string;
-    name: string;
-    description: Nullable<string>;
-    source: string;
-    target: string;
-    read_only: boolean;
-    user_mountable: boolean;
+    ip: string;
+    alias: Nullable<string>;
+    port: number;
+    notes: Nullable<string>;
+    assigned: boolean;
 };
-
-type Role = {
-    id: number;
-    name: string;
-    created_at: string;
-    updated_at: string;
+type AllocationRel = Allocation & {
+    relationships?: {
+        node?: GenericResponse<Node$1, "node">;
+        server?: GenericResponse<ApplicationServer, "server">;
+    };
 };
 
 type ApplicationUser = {
     id: number;
     external_id: Nullable<string>;
+    is_managed_externally: boolean;
     uuid: string;
     username: string;
     email: string;
@@ -414,6 +455,13 @@ type ApplicationUserApiKey = {
     updated_at: string;
 };
 
+type Role = {
+    id: number;
+    name: string;
+    created_at: string;
+    updated_at: string;
+};
+
 declare class Mounts {
     private readonly r;
     constructor(r: AxiosInstance);
@@ -639,6 +687,7 @@ type ListSort = ExactlyOneKey<"id" | "uuid", "asc" | "desc">;
 declare const CreateSchema: z.ZodObject<{
     email: z.ZodEmail;
     external_id: z.ZodOptional<z.ZodString>;
+    is_managed_externally: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
     username: z.ZodString;
     password: z.ZodOptional<z.ZodString>;
     language: z.ZodEnum<{
@@ -1308,7 +1357,7 @@ type Server = {
     docker_image: string;
     egg_features: Nullable<string[]>;
     feature_limits: FeatureLimits;
-    status: Nullable<unknown>;
+    status: Nullable<ServerStats["current_state"]>;
     is_suspended: boolean;
     is_installing: boolean;
     is_transferring: boolean;

package/dist/api/index.js

@@ -109,6 +109,25 @@ var Eggs = class {
     });
     return data;
   };
+  import = async (egg, format = "json") => {
+    let body;
+    if (format === "yaml" && typeof egg === "string") {
+      throw new Error("YAML import is not supported yet");
+    } else if (format === "json" && typeof egg === "object")
+      body = egg;
+    else
+      throw new Error("Invalid format or egg type");
+    const { data } = await this.r.post(`/eggs/import`, body, {
+      params: { format }
+    });
+    return data;
+  };
+  delete = async (id) => {
+    await this.r.delete(`/eggs/${id}`);
+  };
+  deleteByUUID = async (uuid) => {
+    await this.r.delete(`/eggs/uuid/${uuid}`);
+  };
 };
 
 // src/api/application/mounts.ts
@@ -1122,6 +1141,7 @@ var Users = class {
 var CreateSchema = import_zod8.default.object({
   email: import_zod8.default.email(),
   external_id: import_zod8.default.string().max(255).optional(),
+  is_managed_externally: import_zod8.default.boolean().optional().default(false),
   username: import_zod8.default.string().min(1).max(255),
   password: import_zod8.default.string().optional(),
   language: languagesSchema,

package/dist/api/index.mjs

@@ -72,6 +72,25 @@ var Eggs = class {
     });
     return data;
   };
+  import = async (egg, format = "json") => {
+    let body;
+    if (format === "yaml" && typeof egg === "string") {
+      throw new Error("YAML import is not supported yet");
+    } else if (format === "json" && typeof egg === "object")
+      body = egg;
+    else
+      throw new Error("Invalid format or egg type");
+    const { data } = await this.r.post(`/eggs/import`, body, {
+      params: { format }
+    });
+    return data;
+  };
+  delete = async (id) => {
+    await this.r.delete(`/eggs/${id}`);
+  };
+  deleteByUUID = async (uuid) => {
+    await this.r.delete(`/eggs/uuid/${uuid}`);
+  };
 };
 
 // src/api/application/mounts.ts
@@ -1085,6 +1104,7 @@ var Users = class {
 var CreateSchema = z8.object({
   email: z8.email(),
   external_id: z8.string().max(255).optional(),
+  is_managed_externally: z8.boolean().optional().default(false),
   username: z8.string().min(1).max(255),
   password: z8.string().optional(),
   language: languagesSchema,