@pelican.ts/sdk 0.2.4 → 0.2.5

package/README.md

@@ -2,7 +2,7 @@
     <img src=".github/logo.png" width="420" />
 </h1>
 
-# Pelican.ts Typescript Client for Pelican panel
+# Pelican.ts — Typescript client for Pelican panel
 
 ## Installation
 ```shell

package/dist/index.d.mts

@@ -15,7 +15,7 @@ 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;
 
-type User$1 = {
+type User = {
     uuid: string;
     username: string;
     email: string;
@@ -48,7 +48,7 @@ type Permission = {
 declare class Account {
     private readonly r;
     constructor(requester: AxiosInstance);
-    info: () => Promise<User$1>;
+    info: () => Promise<User>;
     updateEmail: (newEmail: string, password: string) => Promise<void>;
     updatePassword: (newPassword: string) => Promise<void>;
     apiKeys: {
@@ -140,7 +140,7 @@ type FeatureLimits = {
     backups: number;
 };
 
-type Allocation$1 = {
+type ServerAllocation = {
     id: number;
     ip: string;
     alias: Nullable<string>;
@@ -149,7 +149,7 @@ type Allocation$1 = {
     is_default: boolean;
 };
 
-type Server$1 = {
+type Server = {
     server_owner: boolean;
     identifier: string;
     internal_id?: number;
@@ -173,7 +173,7 @@ type Server$1 = {
     is_installing: boolean;
     is_transferring: boolean;
     relationships: {
-        allocations: GenericListResponse<GenericResponse<Allocation$1, "allocation">>;
+        allocations: GenericListResponse<GenericResponse<ServerAllocation, "allocation">>;
         variables: GenericListResponse<GenericResponse<EggVariable, "egg_variable">>;
         egg?: GenericResponse<{
             uuid: string;
@@ -347,10 +347,10 @@ declare class ServerAllocations {
     private readonly r;
     private readonly id;
     constructor(requester: AxiosInstance, id: string);
-    list: () => Promise<Allocation$1[]>;
-    autoAssign: () => Promise<Allocation$1>;
-    setNotes: (alloc_id: number, notes: string) => Promise<Allocation$1>;
-    setPrimary: (alloc_id: number) => Promise<Allocation$1>;
+    list: () => Promise<ServerAllocation[]>;
+    autoAssign: () => Promise<ServerAllocation>;
+    setNotes: (alloc_id: number, notes: string) => Promise<ServerAllocation>;
+    setPrimary: (alloc_id: number) => Promise<ServerAllocation>;
     unassign: (alloc_id: number) => Promise<void>;
 }
 
@@ -365,7 +365,7 @@ declare class ServerUsers {
     delete: (user_id: number) => Promise<void>;
 }
 
-type Backup = {
+type ServerBackup = {
     uuid: string;
     is_successful: boolean;
     is_locked: boolean;
@@ -381,13 +381,13 @@ declare class ServerBackups {
     private readonly r;
     private readonly id;
     constructor(requester: AxiosInstance, id: string);
-    list: (page?: number) => Promise<Backup[]>;
+    list: (page?: number) => Promise<ServerBackup[]>;
     create: (args: {
         name?: string;
         is_locked: boolean;
         ignored_files: string[];
-    }) => Promise<Backup>;
-    info: (backup_uuid: string) => Promise<Backup>;
+    }) => Promise<ServerBackup>;
+    info: (backup_uuid: string) => Promise<ServerBackup>;
     downloadGetUrl: (backup_uuid: string) => Promise<string>;
     download: (backup_uuid: string) => Promise<ArrayBuffer>;
     delete: (backup_uuid: string) => Promise<void>;
@@ -545,7 +545,7 @@ declare class ServerClient {
     variables: ServerStartup;
     settings: ServerSettings;
     constructor(requester: AxiosInstance, id: string);
-    info: (include?: ("egg" | "subusers")[]) => Promise<Server$1>;
+    info: (include?: ("egg" | "subusers")[]) => Promise<Server>;
     websocket: (stripColors?: boolean) => ServerWebsocket;
     resources: () => Promise<ServerStats>;
     command: (command: string) => Promise<void>;
@@ -557,7 +557,7 @@ declare class Client$1 {
     private readonly r;
     constructor(requester: AxiosInstance);
     listPermissions: () => Promise<Record<string, Permission>>;
-    listServers: (type?: "accessible" | "mine" | "admin" | "admin-all", page?: number, per_page?: number, include?: ("egg" | "subusers")[]) => Promise<Server$1[]>;
+    listServers: (type?: "accessible" | "mine" | "admin" | "admin-all", page?: number, per_page?: number, include?: ("egg" | "subusers")[]) => Promise<Server[]>;
     server: (uuid: string) => ServerClient;
 }
 
@@ -571,7 +571,7 @@ type Container = {
     network_mode: string;
 };
 
-type Server = {
+type ApplicationServer = {
     id: number;
     external_id: Nullable<string>;
     uuid: string;
@@ -591,7 +591,7 @@ type Server = {
     updated_at: Nullable<string>;
 };
 
-type User = {
+type ApplicationUser = {
     id: number;
     external_id: Nullable<string>;
     uuid: string;
@@ -604,22 +604,22 @@ type User = {
     created_at: string;
     updated_at: Nullable<string>;
     relationships?: {
-        servers: GenericListResponse<GenericResponse<Server>>;
+        servers: GenericListResponse<GenericResponse<ApplicationServer>>;
     };
 };
 
 declare class Users {
     private readonly r;
     constructor(requester: AxiosInstance);
-    list: (opts: ListType, page?: number) => Promise<User[]>;
+    list: (opts: ListType, page?: number) => Promise<ApplicationUser[]>;
     info: (id: number, { include }: {
         include?: ("servers")[];
-    }) => Promise<User>;
+    }) => Promise<ApplicationUser>;
     infoByExternal: (external_id: string, { include }: {
         include?: ("servers")[];
-    }) => Promise<User>;
-    create: (user: z.infer<typeof CreateSchema>) => Promise<User>;
-    update: (id: number, user: z.infer<typeof CreateSchema>) => Promise<User>;
+    }) => Promise<ApplicationUser>;
+    create: (user: z.infer<typeof CreateSchema>) => Promise<ApplicationUser>;
+    update: (id: number, user: z.infer<typeof CreateSchema>) => Promise<ApplicationUser>;
     delete: (id: number) => Promise<void>;
     addRoles: (id: number, roles: number[]) => Promise<void>;
     removeRoles: (id: number, roles: number[]) => Promise<void>;
@@ -1238,7 +1238,7 @@ type Node = {
     relationships?: {
         allocations?: GenericListResponse<GenericResponse<Allocation, "allocation">>;
         location?: GenericResponse<Location, "location">;
-        servers?: GenericListResponse<GenericResponse<Server, "server">>;
+        servers?: GenericListResponse<GenericResponse<ApplicationServer, "server">>;
     };
 };
 type NodeConfiguration = {
@@ -1277,7 +1277,7 @@ type Allocation = {
 type AllocationRel = Allocation & {
     relationships?: {
         node?: GenericResponse<Node, "node">;
-        server?: GenericResponse<Server, "server">;
+        server?: GenericResponse<ApplicationServer, "server">;
     };
 };
 
@@ -1350,7 +1350,7 @@ declare class Servers {
     private readonly id;
     databases: ServersDatabases;
     constructor(r: AxiosInstance, server_id: number);
-    info: (include?: ("egg" | "subusers")[]) => Promise<Server>;
+    info: (include?: ("egg" | "subusers")[]) => Promise<ApplicationServer>;
     delete: (force?: boolean) => Promise<void>;
     updateDetails: (opts: z.infer<typeof UpdateDetailsSchema>) => Promise<void>;
     updateBuild: (opts: z.infer<typeof UpdateBuildSchema>) => Promise<void>;
@@ -1486,9 +1486,9 @@ declare class Client {
     databaseHosts: DatabaseHosts;
     roles: Roles;
     constructor(requester: AxiosInstance);
-    listServers: (search?: string, page?: number) => Promise<Server[]>;
-    createServer: (opts: z.infer<typeof CreateServerSchema>) => Promise<Server>;
-    getServerByExternalId: (external_id: string, include?: ("egg" | "subusers")[]) => Promise<Server>;
+    listServers: (search?: string, page?: number) => Promise<ApplicationServer[]>;
+    createServer: (opts: z.infer<typeof CreateServerSchema>) => Promise<ApplicationServer>;
+    getServerByExternalId: (external_id: string, include?: ("egg" | "subusers")[]) => Promise<ApplicationServer>;
     servers: (server_id: number) => Servers;
 }
 

package/dist/index.d.ts

@@ -15,7 +15,7 @@ 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;
 
-type User$1 = {
+type User = {
     uuid: string;
     username: string;
     email: string;
@@ -48,7 +48,7 @@ type Permission = {
 declare class Account {
     private readonly r;
     constructor(requester: AxiosInstance);
-    info: () => Promise<User$1>;
+    info: () => Promise<User>;
     updateEmail: (newEmail: string, password: string) => Promise<void>;
     updatePassword: (newPassword: string) => Promise<void>;
     apiKeys: {
@@ -140,7 +140,7 @@ type FeatureLimits = {
     backups: number;
 };
 
-type Allocation$1 = {
+type ServerAllocation = {
     id: number;
     ip: string;
     alias: Nullable<string>;
@@ -149,7 +149,7 @@ type Allocation$1 = {
     is_default: boolean;
 };
 
-type Server$1 = {
+type Server = {
     server_owner: boolean;
     identifier: string;
     internal_id?: number;
@@ -173,7 +173,7 @@ type Server$1 = {
     is_installing: boolean;
     is_transferring: boolean;
     relationships: {
-        allocations: GenericListResponse<GenericResponse<Allocation$1, "allocation">>;
+        allocations: GenericListResponse<GenericResponse<ServerAllocation, "allocation">>;
         variables: GenericListResponse<GenericResponse<EggVariable, "egg_variable">>;
         egg?: GenericResponse<{
             uuid: string;
@@ -347,10 +347,10 @@ declare class ServerAllocations {
     private readonly r;
     private readonly id;
     constructor(requester: AxiosInstance, id: string);
-    list: () => Promise<Allocation$1[]>;
-    autoAssign: () => Promise<Allocation$1>;
-    setNotes: (alloc_id: number, notes: string) => Promise<Allocation$1>;
-    setPrimary: (alloc_id: number) => Promise<Allocation$1>;
+    list: () => Promise<ServerAllocation[]>;
+    autoAssign: () => Promise<ServerAllocation>;
+    setNotes: (alloc_id: number, notes: string) => Promise<ServerAllocation>;
+    setPrimary: (alloc_id: number) => Promise<ServerAllocation>;
     unassign: (alloc_id: number) => Promise<void>;
 }
 
@@ -365,7 +365,7 @@ declare class ServerUsers {
     delete: (user_id: number) => Promise<void>;
 }
 
-type Backup = {
+type ServerBackup = {
     uuid: string;
     is_successful: boolean;
     is_locked: boolean;
@@ -381,13 +381,13 @@ declare class ServerBackups {
     private readonly r;
     private readonly id;
     constructor(requester: AxiosInstance, id: string);
-    list: (page?: number) => Promise<Backup[]>;
+    list: (page?: number) => Promise<ServerBackup[]>;
     create: (args: {
         name?: string;
         is_locked: boolean;
         ignored_files: string[];
-    }) => Promise<Backup>;
-    info: (backup_uuid: string) => Promise<Backup>;
+    }) => Promise<ServerBackup>;
+    info: (backup_uuid: string) => Promise<ServerBackup>;
     downloadGetUrl: (backup_uuid: string) => Promise<string>;
     download: (backup_uuid: string) => Promise<ArrayBuffer>;
     delete: (backup_uuid: string) => Promise<void>;
@@ -545,7 +545,7 @@ declare class ServerClient {
     variables: ServerStartup;
     settings: ServerSettings;
     constructor(requester: AxiosInstance, id: string);
-    info: (include?: ("egg" | "subusers")[]) => Promise<Server$1>;
+    info: (include?: ("egg" | "subusers")[]) => Promise<Server>;
     websocket: (stripColors?: boolean) => ServerWebsocket;
     resources: () => Promise<ServerStats>;
     command: (command: string) => Promise<void>;
@@ -557,7 +557,7 @@ declare class Client$1 {
     private readonly r;
     constructor(requester: AxiosInstance);
     listPermissions: () => Promise<Record<string, Permission>>;
-    listServers: (type?: "accessible" | "mine" | "admin" | "admin-all", page?: number, per_page?: number, include?: ("egg" | "subusers")[]) => Promise<Server$1[]>;
+    listServers: (type?: "accessible" | "mine" | "admin" | "admin-all", page?: number, per_page?: number, include?: ("egg" | "subusers")[]) => Promise<Server[]>;
     server: (uuid: string) => ServerClient;
 }
 
@@ -571,7 +571,7 @@ type Container = {
     network_mode: string;
 };
 
-type Server = {
+type ApplicationServer = {
     id: number;
     external_id: Nullable<string>;
     uuid: string;
@@ -591,7 +591,7 @@ type Server = {
     updated_at: Nullable<string>;
 };
 
-type User = {
+type ApplicationUser = {
     id: number;
     external_id: Nullable<string>;
     uuid: string;
@@ -604,22 +604,22 @@ type User = {
     created_at: string;
     updated_at: Nullable<string>;
     relationships?: {
-        servers: GenericListResponse<GenericResponse<Server>>;
+        servers: GenericListResponse<GenericResponse<ApplicationServer>>;
     };
 };
 
 declare class Users {
     private readonly r;
     constructor(requester: AxiosInstance);
-    list: (opts: ListType, page?: number) => Promise<User[]>;
+    list: (opts: ListType, page?: number) => Promise<ApplicationUser[]>;
     info: (id: number, { include }: {
         include?: ("servers")[];
-    }) => Promise<User>;
+    }) => Promise<ApplicationUser>;
     infoByExternal: (external_id: string, { include }: {
         include?: ("servers")[];
-    }) => Promise<User>;
-    create: (user: z.infer<typeof CreateSchema>) => Promise<User>;
-    update: (id: number, user: z.infer<typeof CreateSchema>) => Promise<User>;
+    }) => Promise<ApplicationUser>;
+    create: (user: z.infer<typeof CreateSchema>) => Promise<ApplicationUser>;
+    update: (id: number, user: z.infer<typeof CreateSchema>) => Promise<ApplicationUser>;
     delete: (id: number) => Promise<void>;
     addRoles: (id: number, roles: number[]) => Promise<void>;
     removeRoles: (id: number, roles: number[]) => Promise<void>;
@@ -1238,7 +1238,7 @@ type Node = {
     relationships?: {
         allocations?: GenericListResponse<GenericResponse<Allocation, "allocation">>;
         location?: GenericResponse<Location, "location">;
-        servers?: GenericListResponse<GenericResponse<Server, "server">>;
+        servers?: GenericListResponse<GenericResponse<ApplicationServer, "server">>;
     };
 };
 type NodeConfiguration = {
@@ -1277,7 +1277,7 @@ type Allocation = {
 type AllocationRel = Allocation & {
     relationships?: {
         node?: GenericResponse<Node, "node">;
-        server?: GenericResponse<Server, "server">;
+        server?: GenericResponse<ApplicationServer, "server">;
     };
 };
 
@@ -1350,7 +1350,7 @@ declare class Servers {
     private readonly id;
     databases: ServersDatabases;
     constructor(r: AxiosInstance, server_id: number);
-    info: (include?: ("egg" | "subusers")[]) => Promise<Server>;
+    info: (include?: ("egg" | "subusers")[]) => Promise<ApplicationServer>;
     delete: (force?: boolean) => Promise<void>;
     updateDetails: (opts: z.infer<typeof UpdateDetailsSchema>) => Promise<void>;
     updateBuild: (opts: z.infer<typeof UpdateBuildSchema>) => Promise<void>;
@@ -1486,9 +1486,9 @@ declare class Client {
     databaseHosts: DatabaseHosts;
     roles: Roles;
     constructor(requester: AxiosInstance);
-    listServers: (search?: string, page?: number) => Promise<Server[]>;
-    createServer: (opts: z.infer<typeof CreateServerSchema>) => Promise<Server>;
-    getServerByExternalId: (external_id: string, include?: ("egg" | "subusers")[]) => Promise<Server>;
+    listServers: (search?: string, page?: number) => Promise<ApplicationServer[]>;
+    createServer: (opts: z.infer<typeof CreateServerSchema>) => Promise<ApplicationServer>;
+    getServerByExternalId: (external_id: string, include?: ("egg" | "subusers")[]) => Promise<ApplicationServer>;
     servers: (server_id: number) => Servers;
 }