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

package/dist/types.d.ts

@@ -2,100 +2,6 @@ import z from 'zod';
 import { AxiosInstance } from 'axios';
 import WebSocket from 'isomorphic-ws';
 
-type ServerSignalOption = "start" | "stop" | "restart" | "kill";
-
-type GenericResponse<T, N extends string = string, M = undefined> = {
-    object: N;
-    attributes: T;
-    meta?: M;
-};
-type PaginationMeta = {
-    total: number;
-    count: number;
-    per_page: number;
-    current_page: number;
-    total_pages: number;
-    links: unknown;
-};
-type GenericListResponse<T> = {
-    object: "list";
-    data: T[];
-    meta?: {
-        pagination: PaginationMeta;
-    };
-};
-
-type ServerDatabase = {
-    id: string;
-    host: {
-        address: string;
-        port: number;
-    };
-    name: string;
-    username: string;
-    connections_from: string;
-    max_connections: number;
-    relationships?: {
-        password: GenericResponse<{
-            password: string;
-        }, "database_password">;
-    };
-};
-
-type Nullable<T> = T | null;
-
-type ServerLimits = {
-    memory: number;
-    swap: number;
-    disk: number;
-    io: number;
-    cpu: number;
-    threads: Nullable<number | string>;
-    oom_disabled: boolean;
-    oom_killer: boolean;
-};
-type FeatureLimits = {
-    databases: number;
-    allocations: number;
-    backups: number;
-};
-
-type StartupParams = {
-    name: string;
-    description: string;
-    env_variables: string;
-    default_value: string;
-    server_value: string;
-    is_editable: boolean;
-    rules: string;
-};
-type StartupMeta = {
-    startup_command: string;
-    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;
@@ -668,6 +574,134 @@ declare const timezonesSchema: z.ZodEnum<{
 }>;
 type TimezonesType = z.infer<typeof timezonesSchema>;
 
+type GenericResponse<T, N extends string = string, M = undefined> = {
+    object: N;
+    attributes: T;
+    meta?: M;
+};
+type PaginationMeta = {
+    total: number;
+    count: number;
+    per_page: number;
+    current_page: number;
+    total_pages: number;
+    links: unknown;
+};
+type GenericListResponse<T> = {
+    object: "list";
+    data: T[];
+    meta?: {
+        pagination: PaginationMeta;
+    };
+};
+
+type ServerDatabase = {
+    id: string;
+    host: {
+        address: string;
+        port: number;
+    };
+    name: string;
+    username: string;
+    connections_from: string;
+    max_connections: number;
+    relationships?: {
+        password: GenericResponse<{
+            password: string;
+        }, "database_password">;
+    };
+};
+
+type Nullable<T> = T | null;
+
+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;
+    backups: number;
+};
+
+type StartupParams = {
+    name: string;
+    description: string;
+    env_variables: string;
+    default_value: string;
+    server_value: string;
+    is_editable: boolean;
+    rules: string;
+};
+type StartupMeta = {
+    startup_command: string;
+    raw_startup_command: string;
+};
+
 type Schedule = {
     id: number;
     name: string;
@@ -700,6 +734,27 @@ 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 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;
@@ -731,21 +786,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, "node">;
-        server?: GenericResponse<ApplicationServer, "server">;
-    };
-};
-
 type Node = {
     id: number;
     uuid: string;
@@ -806,32 +846,60 @@ 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 AllocationRel = Allocation & {
+    relationships?: {
+        node?: GenericResponse<Node, "node">;
+        server?: GenericResponse<ApplicationServer, "server">;
+    };
 };
 
-type DatabaseHost = {
+type ApplicationUser = {
     id: number;
-    name: string;
-    host: string;
-    port: number;
+    external_id: Nullable<string>;
+    is_managed_externally: boolean;
+    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>>;
+    };
+};
+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 Role = {
+type DatabaseHost = {
     id: number;
     name: string;
+    host: string;
+    port: number;
+    username: string;
     created_at: string;
-    updated_at: string;
+    updated_at: Nullable<string>;
 };
 
 type Egg = {
@@ -901,34 +969,121 @@ type ExportedEgg = {
     variables: ApplicationEggVariable[];
 };
 
-type ApplicationUser = {
+type Role = {
     id: number;
-    external_id: Nullable<string>;
+    name: string;
+    created_at: string;
+    updated_at: string;
+};
+
+type ServerAllocation = {
+    id: number;
+    ip: string;
+    ip_alias: Nullable<string>;
+    port: number;
+    notes: Nullable<string>;
+    is_default: boolean;
+};
+
+type ServerSubuser = {
     uuid: string;
     username: string;
     email: string;
     language: string;
-    root_admin: string;
+    image: string;
+    admin: false;
+    root_admin: false;
     "2fa_enabled": boolean;
-    "2fa": boolean;
     created_at: string;
-    updated_at: Nullable<string>;
-    relationships?: {
-        servers: GenericListResponse<GenericResponse<ApplicationServer>>;
+    permissions: SubuserPermission[] | string[];
+};
+type SubuserPermission = "activity.read" | "allocation.create" | "allocation.delete" | "allocation.read" | "allocation.update" | "backup.create" | "backup.delete" | "backup.download" | "backup.read" | "backup.restore" | "control.console" | "control.restart" | "control.start" | "control.stop" | "database.create" | "database.delete" | "database.read" | "database.update" | "database.view-password" | "file.archive" | "file.create" | "file.delete" | "file.read" | "file.read-content" | "file.sftp" | "file.update" | "schedule.create" | "schedule.delete" | "schedule.read" | "schedule.update" | "settings.description" | "settings.reinstall" | "settings.rename" | "startup.docker-image" | "startup.read" | "startup.update" | "user.create" | "user.delete" | "user.read" | "user.update" | "websocket.connect";
+
+type Server = {
+    server_owner: boolean;
+    identifier: string;
+    internal_id?: number;
+    uuid: string;
+    name: string;
+    node: string;
+    is_node_under_maintenance: boolean;
+    sftp_details: {
+        ip: string;
+        alias: Nullable<string>;
+        port: number;
+    };
+    description: string;
+    limits: ServerLimits;
+    invocation: string;
+    docker_image: string;
+    egg_features: Nullable<string[]>;
+    feature_limits: FeatureLimits;
+    status: Nullable<ServerStats["current_state"]>;
+    is_suspended: boolean;
+    is_installing: boolean;
+    is_transferring: boolean;
+    relationships: {
+        allocations: GenericListResponse<GenericResponse<ServerAllocation, "allocation">>;
+        variables: GenericListResponse<GenericResponse<EggVariable, "egg_variable">>;
+        egg?: GenericResponse<{
+            uuid: string;
+            name: string;
+        }, "egg">;
+        subusers?: GenericListResponse<GenericResponse<ServerSubuser, "server_subuser">>;
     };
 };
-type ApplicationUserApiKey = {
-    id: number;
-    user_id: number;
-    key_type: 1;
+type ServerStats = {
+    current_state: "installing" | "install_failed" | "reinstall_failed" | "suspended" | "restoring_backup" | "running" | "stopped" | "offline";
+    is_suspended: boolean;
+    resources: ServerResources;
+};
+type ServerResources = {
+    memory_bytes: number;
+    cpu_absolute: number;
+    disk_bytes: number;
+    network_tx_bytes: number;
+    network_rx_bytes: number;
+    uptime: number;
+};
+type ServerActivityLog = {
+    id: string;
+    event: string;
+    is_api: boolean;
+    ip: string;
+    description: Nullable<string>;
+    properties: Record<string, string>;
+    has_additional_metadata: boolean;
+    timestamp: string;
+};
+
+type User = {
+    uuid: string;
+    username: string;
+    email: string;
+    language: string;
+    image: string;
+    admin: boolean;
+    root_admin: boolean;
+    "2fa_enabled": boolean;
+    created_at: string;
+    updated_at: string;
+};
+type APIKey = {
     identifier: string;
-    memo: string;
-    allowed_ips: Array<string>;
-    permissions: [];
+    description: string;
+    allowed_ips: string[];
     last_used_at: Nullable<string>;
-    expires_at: Nullable<string>;
     created_at: string;
-    updated_at: string;
+};
+type SSHKey = {
+    name: string;
+    fingerprint: string;
+    pubic_key: string;
+    created_at: string;
+};
+type Permission = {
+    description: string;
+    keys: Record<string, string>;
 };
 
 type SocketEventPayloadMap = {
@@ -1102,114 +1257,4 @@ type JwtErrorEvent = {
     args: [string];
 };
 
-type ServerAllocation = {
-    id: number;
-    ip: string;
-    ip_alias: Nullable<string>;
-    port: number;
-    notes: Nullable<string>;
-    is_default: boolean;
-};
-
-type ServerSubuser = {
-    uuid: string;
-    username: string;
-    email: string;
-    language: string;
-    image: string;
-    admin: false;
-    root_admin: false;
-    "2fa_enabled": boolean;
-    created_at: string;
-    permissions: SubuserPermission[] | string[];
-};
-type SubuserPermission = "activity.read" | "allocation.create" | "allocation.delete" | "allocation.read" | "allocation.update" | "backup.create" | "backup.delete" | "backup.download" | "backup.read" | "backup.restore" | "control.console" | "control.restart" | "control.start" | "control.stop" | "database.create" | "database.delete" | "database.read" | "database.update" | "database.view-password" | "file.archive" | "file.create" | "file.delete" | "file.read" | "file.read-content" | "file.sftp" | "file.update" | "schedule.create" | "schedule.delete" | "schedule.read" | "schedule.update" | "settings.description" | "settings.reinstall" | "settings.rename" | "startup.docker-image" | "startup.read" | "startup.update" | "user.create" | "user.delete" | "user.read" | "user.update" | "websocket.connect";
-
-type Server = {
-    server_owner: boolean;
-    identifier: string;
-    internal_id?: number;
-    uuid: string;
-    name: string;
-    node: string;
-    is_node_under_maintenance: boolean;
-    sftp_details: {
-        ip: string;
-        alias: Nullable<string>;
-        port: number;
-    };
-    description: string;
-    limits: ServerLimits;
-    invocation: string;
-    docker_image: string;
-    egg_features: Nullable<string[]>;
-    feature_limits: FeatureLimits;
-    status: Nullable<unknown>;
-    is_suspended: boolean;
-    is_installing: boolean;
-    is_transferring: boolean;
-    relationships: {
-        allocations: GenericListResponse<GenericResponse<ServerAllocation, "allocation">>;
-        variables: GenericListResponse<GenericResponse<EggVariable, "egg_variable">>;
-        egg?: GenericResponse<{
-            uuid: string;
-            name: string;
-        }, "egg">;
-        subusers?: GenericListResponse<GenericResponse<ServerSubuser, "server_subuser">>;
-    };
-};
-type ServerStats = {
-    current_state: "installing" | "install_failed" | "reinstall_failed" | "suspended" | "restoring_backup" | "running" | "stopped" | "offline";
-    is_suspended: boolean;
-    resources: ServerResources;
-};
-type ServerResources = {
-    memory_bytes: number;
-    cpu_absolute: number;
-    disk_bytes: number;
-    network_tx_bytes: number;
-    network_rx_bytes: number;
-    uptime: number;
-};
-type ServerActivityLog = {
-    id: string;
-    event: string;
-    is_api: boolean;
-    ip: string;
-    description: Nullable<string>;
-    properties: Record<string, string>;
-    has_additional_metadata: boolean;
-    timestamp: string;
-};
-
-type User = {
-    uuid: string;
-    username: string;
-    email: string;
-    language: string;
-    image: string;
-    admin: boolean;
-    root_admin: boolean;
-    "2fa_enabled": boolean;
-    created_at: string;
-    updated_at: string;
-};
-type APIKey = {
-    identifier: string;
-    description: string;
-    allowed_ips: string[];
-    last_used_at: Nullable<string>;
-    created_at: string;
-};
-type SSHKey = {
-    name: string;
-    fingerprint: string;
-    pubic_key: string;
-    created_at: string;
-};
-type Permission = {
-    description: string;
-    keys: Record<string, string>;
-};
-
 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 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, ServerWebsocket, 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.4.16-next.3",
+  "version": "0.5.0",
   "description": "Pelican panel SDK for TypeScript",
   "main": "./dist/index.js",
   "module": "./dist/index.mjs",