@pelican.ts/sdk 0.4.12 → 0.4.14
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/api/index.d.mts +1 -1
- package/dist/api/index.d.ts +1 -1
- package/dist/api/index.js +1 -1
- package/dist/api/index.mjs +1 -1
- package/dist/index.d.mts +139 -139
- package/dist/index.d.ts +139 -139
- package/dist/index.js +1 -1
- package/dist/index.mjs +1 -1
- package/dist/types.d.ts +258 -258
- package/package.json +1 -1
- package/.husky/pre-commit +0 -2
- package/scripts/create-types.ts +0 -24
- package/src/api/application/client.ts +0 -70
- package/src/api/application/database_hosts.ts +0 -65
- package/src/api/application/eggs.ts +0 -43
- package/src/api/application/mounts.ts +0 -109
- package/src/api/application/nodes.ts +0 -126
- package/src/api/application/nodes_allocations.ts +0 -47
- package/src/api/application/roles.ts +0 -39
- package/src/api/application/servers.ts +0 -145
- package/src/api/application/servers_databases.ts +0 -53
- package/src/api/application/types/container.ts +0 -9
- package/src/api/application/types/database_host.ts +0 -11
- package/src/api/application/types/egg.ts +0 -65
- package/src/api/application/types/index.ts +0 -10
- package/src/api/application/types/location.ts +0 -7
- package/src/api/application/types/mount.ts +0 -12
- package/src/api/application/types/node.ts +0 -58
- package/src/api/application/types/role.ts +0 -6
- package/src/api/application/types/server.ts +0 -24
- package/src/api/application/types/server_allocation.ts +0 -20
- package/src/api/application/types/user.ts +0 -34
- package/src/api/application/users.ts +0 -146
- package/src/api/base/request.ts +0 -44
- package/src/api/base/types.ts +0 -40
- package/src/api/client/account.ts +0 -77
- package/src/api/client/client.ts +0 -56
- package/src/api/client/server.ts +0 -74
- package/src/api/client/server_activity.ts +0 -25
- package/src/api/client/server_allocations.ts +0 -50
- package/src/api/client/server_backups.ts +0 -82
- package/src/api/client/server_databases.ts +0 -51
- package/src/api/client/server_files.ts +0 -145
- package/src/api/client/server_schedules.ts +0 -130
- package/src/api/client/server_settings.ts +0 -36
- package/src/api/client/server_startup.ts +0 -41
- package/src/api/client/server_users.ts +0 -55
- package/src/api/client/server_websocket.ts +0 -570
- package/src/api/client/types/index.ts +0 -5
- package/src/api/client/types/server.ts +0 -72
- package/src/api/client/types/server_allocation.ts +0 -10
- package/src/api/client/types/server_subuser.ts +0 -55
- package/src/api/client/types/user.ts +0 -31
- package/src/api/client/types/websocket.ts +0 -138
- package/src/api/common/types/egg.ts +0 -9
- package/src/api/common/types/enums.ts +0 -21
- package/src/api/common/types/index.ts +0 -9
- package/src/api/common/types/server_backup.ts +0 -13
- package/src/api/common/types/server_database.ts +0 -13
- package/src/api/common/types/server_files.ts +0 -11
- package/src/api/common/types/server_limits.ts +0 -18
- package/src/api/common/types/server_power.ts +0 -1
- package/src/api/common/types/server_schedule.ts +0 -37
- package/src/api/common/types/server_startup.ts +0 -11
- package/src/api/index.ts +0 -17
- package/src/humane/Account.ts +0 -60
- package/src/humane/Client.ts +0 -44
- package/src/humane/Server.ts +0 -206
- package/src/humane/ServerAllocation.ts +0 -41
- package/src/humane/ServerBackup.ts +0 -44
- package/src/humane/ServerDatabase.ts +0 -37
- package/src/humane/ServerFile.ts +0 -91
- package/src/humane/ServerSchedule.ts +0 -160
- package/src/humane/ServerUser.ts +0 -44
- package/src/index.ts +0 -21
- package/src/types.ts +0 -3
- package/src/utils/sized.ts +0 -13
- package/src/utils/transform.ts +0 -21
- package/src/utils/types.ts +0 -10
package/dist/api/index.d.mts
CHANGED
|
@@ -1373,7 +1373,7 @@ declare class Servers {
|
|
|
1373
1373
|
suspend: () => Promise<void>;
|
|
1374
1374
|
unsuspend: () => Promise<void>;
|
|
1375
1375
|
reinstall: () => Promise<void>;
|
|
1376
|
-
transferStart: (node_id: number, allocation_id: number, allocation_additional?:
|
|
1376
|
+
transferStart: (node_id: number, allocation_id: number, allocation_additional?: number[]) => Promise<void>;
|
|
1377
1377
|
transferCancel: () => Promise<void>;
|
|
1378
1378
|
}
|
|
1379
1379
|
declare const CreateServerSchema: z.ZodObject<{
|
package/dist/api/index.d.ts
CHANGED
|
@@ -1373,7 +1373,7 @@ declare class Servers {
|
|
|
1373
1373
|
suspend: () => Promise<void>;
|
|
1374
1374
|
unsuspend: () => Promise<void>;
|
|
1375
1375
|
reinstall: () => Promise<void>;
|
|
1376
|
-
transferStart: (node_id: number, allocation_id: number, allocation_additional?:
|
|
1376
|
+
transferStart: (node_id: number, allocation_id: number, allocation_additional?: number[]) => Promise<void>;
|
|
1377
1377
|
transferCancel: () => Promise<void>;
|
|
1378
1378
|
}
|
|
1379
1379
|
declare const CreateServerSchema: z.ZodObject<{
|
package/dist/api/index.js
CHANGED
package/dist/api/index.mjs
CHANGED
package/dist/index.d.mts
CHANGED
|
@@ -1,7 +1,17 @@
|
|
|
1
1
|
import { AxiosInstance } from 'axios';
|
|
2
2
|
import WebSocket from 'isomorphic-ws';
|
|
3
3
|
|
|
4
|
-
type
|
|
4
|
+
type FileObject = {
|
|
5
|
+
name: string;
|
|
6
|
+
mode: string;
|
|
7
|
+
mode_bits: string;
|
|
8
|
+
size: number;
|
|
9
|
+
is_file: boolean;
|
|
10
|
+
is_symlink: boolean;
|
|
11
|
+
mimetype: string;
|
|
12
|
+
created_at: string;
|
|
13
|
+
modified_at: string;
|
|
14
|
+
};
|
|
5
15
|
|
|
6
16
|
type GenericResponse<T, N extends string = string, M = undefined> = {
|
|
7
17
|
object: N;
|
|
@@ -49,6 +59,20 @@ type ServerDatabase$1 = {
|
|
|
49
59
|
type PartialBy<T, K extends keyof T> = Omit<T, K> & Partial<Pick<T, K>>;
|
|
50
60
|
type Nullable<T> = T | null;
|
|
51
61
|
|
|
62
|
+
type ServerBackup$1 = {
|
|
63
|
+
uuid: string;
|
|
64
|
+
is_successful: boolean;
|
|
65
|
+
is_locked: boolean;
|
|
66
|
+
name: string;
|
|
67
|
+
ignored_files: string[];
|
|
68
|
+
checksum: Nullable<string>;
|
|
69
|
+
bytes: number;
|
|
70
|
+
created_at: string;
|
|
71
|
+
completed_at: Nullable<string>;
|
|
72
|
+
};
|
|
73
|
+
|
|
74
|
+
type ServerSignalOption = "start" | "stop" | "restart" | "kill";
|
|
75
|
+
|
|
52
76
|
type ServerLimits = {
|
|
53
77
|
memory: number;
|
|
54
78
|
swap: number;
|
|
@@ -79,40 +103,6 @@ type StartupMeta = {
|
|
|
79
103
|
raw_startup_command: string;
|
|
80
104
|
};
|
|
81
105
|
|
|
82
|
-
type ServerBackup$1 = {
|
|
83
|
-
uuid: string;
|
|
84
|
-
is_successful: boolean;
|
|
85
|
-
is_locked: boolean;
|
|
86
|
-
name: string;
|
|
87
|
-
ignored_files: string[];
|
|
88
|
-
checksum: Nullable<string>;
|
|
89
|
-
bytes: number;
|
|
90
|
-
created_at: string;
|
|
91
|
-
completed_at: Nullable<string>;
|
|
92
|
-
};
|
|
93
|
-
|
|
94
|
-
type EggVariable = {
|
|
95
|
-
name: string;
|
|
96
|
-
description: string;
|
|
97
|
-
env_variable: string;
|
|
98
|
-
default_value: string;
|
|
99
|
-
server_value: string;
|
|
100
|
-
is_editable: boolean;
|
|
101
|
-
rules: string;
|
|
102
|
-
};
|
|
103
|
-
|
|
104
|
-
type FileObject = {
|
|
105
|
-
name: string;
|
|
106
|
-
mode: string;
|
|
107
|
-
mode_bits: string;
|
|
108
|
-
size: number;
|
|
109
|
-
is_file: boolean;
|
|
110
|
-
is_symlink: boolean;
|
|
111
|
-
mimetype: string;
|
|
112
|
-
created_at: string;
|
|
113
|
-
modified_at: string;
|
|
114
|
-
};
|
|
115
|
-
|
|
116
106
|
type Schedule = {
|
|
117
107
|
id: number;
|
|
118
108
|
name: string;
|
|
@@ -145,110 +135,14 @@ type ScheduleTask = {
|
|
|
145
135
|
updated_at: Nullable<string>;
|
|
146
136
|
};
|
|
147
137
|
|
|
148
|
-
type
|
|
149
|
-
|
|
150
|
-
|
|
151
|
-
|
|
152
|
-
|
|
153
|
-
|
|
154
|
-
|
|
155
|
-
|
|
156
|
-
[SOCKET_EVENT.INSTALL_STARTED]: undefined;
|
|
157
|
-
[SOCKET_EVENT.INSTALL_COMPLETED]: undefined;
|
|
158
|
-
[SOCKET_EVENT.TRANSFER_LOGS]: string;
|
|
159
|
-
[SOCKET_EVENT.TRANSFER_STATUS]: string;
|
|
160
|
-
[SOCKET_EVENT.BACKUP_COMPLETED]: BackupCompletedJson;
|
|
161
|
-
[SOCKET_EVENT.BACKUP_RESTORE_COMPLETED]: undefined;
|
|
162
|
-
[SOCKET_EVENT.TOKEN_EXPIRING]: undefined;
|
|
163
|
-
[SOCKET_EVENT.TOKEN_EXPIRED]: undefined;
|
|
164
|
-
[SOCKET_EVENT.JWT_ERROR]: string;
|
|
165
|
-
};
|
|
166
|
-
type Listener<E extends SOCKET_EVENT> = SocketEventPayloadMap[E] extends undefined ? () => void : (payload: SocketEventPayloadMap[E]) => void;
|
|
167
|
-
type CloseEventLike = Parameters<NonNullable<WebSocket["onclose"]>>[0];
|
|
168
|
-
type ErrorEventLike = Parameters<NonNullable<WebSocket["onerror"]>>[0];
|
|
169
|
-
declare class ServerWebsocket {
|
|
170
|
-
private readonly r;
|
|
171
|
-
private readonly serverId;
|
|
172
|
-
private socket?;
|
|
173
|
-
private currentToken?;
|
|
174
|
-
private readonly bus;
|
|
175
|
-
private debugLogging;
|
|
176
|
-
private stripColors;
|
|
177
|
-
private detachMessageListener?;
|
|
178
|
-
constructor(requester: AxiosInstance, id: string, stripColors?: boolean);
|
|
179
|
-
on<E extends SOCKET_EVENT>(event: E, listener: Listener<E>): () => void;
|
|
180
|
-
deregister<E extends SOCKET_EVENT>(event: E, listener: Listener<E>): void;
|
|
181
|
-
private emit;
|
|
182
|
-
connect(resumable?: boolean, debugLogging?: boolean): Promise<void>;
|
|
183
|
-
onSocketDisconnect(handler: (event: CloseEventLike) => void): void;
|
|
184
|
-
onSocketError(handler: (event: ErrorEventLike) => void): void;
|
|
185
|
-
makeResumable(disconnectsToo: boolean): void;
|
|
186
|
-
private attachMessageListener;
|
|
187
|
-
private handleIncomingMessage;
|
|
188
|
-
private parseMessage;
|
|
189
|
-
private normalisePayload;
|
|
190
|
-
private dispatchMessage;
|
|
191
|
-
private refreshCredentials;
|
|
192
|
-
private authenticate;
|
|
193
|
-
disconnect(): void;
|
|
194
|
-
requestStats(): void;
|
|
195
|
-
requestLogs(): void;
|
|
196
|
-
private send;
|
|
197
|
-
getStats(): Promise<StatsWsJson>;
|
|
198
|
-
getLogs(): Promise<string[]>;
|
|
199
|
-
sendPoweraction(action: ServerSignalOption): void;
|
|
200
|
-
sendCommand(cmd: string): void;
|
|
201
|
-
}
|
|
202
|
-
|
|
203
|
-
/**
|
|
204
|
-
* Source: https://github.com/pterodactyl/panel/blob/1.0-develop/resources/scripts/components/server/events.ts
|
|
205
|
-
*/
|
|
206
|
-
declare enum SOCKET_EVENT {
|
|
207
|
-
AUTH_SUCCESS = "auth success",
|
|
208
|
-
DAEMON_MESSAGE = "daemon message",
|
|
209
|
-
DAEMON_ERROR = "daemon error",
|
|
210
|
-
INSTALL_OUTPUT = "install output",
|
|
211
|
-
INSTALL_STARTED = "install started",
|
|
212
|
-
INSTALL_COMPLETED = "install completed",
|
|
213
|
-
CONSOLE_OUTPUT = "console output",
|
|
214
|
-
STATUS = "status",
|
|
215
|
-
STATS = "stats",
|
|
216
|
-
TRANSFER_LOGS = "transfer logs",
|
|
217
|
-
TRANSFER_STATUS = "transfer status",
|
|
218
|
-
BACKUP_COMPLETED = "backup completed",
|
|
219
|
-
BACKUP_RESTORE_COMPLETED = "backup restore completed",
|
|
220
|
-
TOKEN_EXPIRING = "token expiring",
|
|
221
|
-
TOKEN_EXPIRED = "token expired",
|
|
222
|
-
JWT_ERROR = "jwt error"
|
|
223
|
-
}
|
|
224
|
-
type BackupCompletedJson = {
|
|
225
|
-
checksum: string;
|
|
226
|
-
checksum_type: "sha1";
|
|
227
|
-
file_size: number;
|
|
228
|
-
is_successful: boolean;
|
|
229
|
-
uuid: string;
|
|
230
|
-
};
|
|
231
|
-
type PowerState = "starting" | "stopping" | "running" | "offline";
|
|
232
|
-
type StatsWsJson = {
|
|
233
|
-
memory_bytes: number;
|
|
234
|
-
memory_limit_bytes: number;
|
|
235
|
-
cpu_absolute: number;
|
|
236
|
-
network: {
|
|
237
|
-
rx_bytes: number;
|
|
238
|
-
tx_bytes: number;
|
|
239
|
-
};
|
|
240
|
-
state: PowerState;
|
|
241
|
-
uptime: number;
|
|
242
|
-
disk_bytes: number;
|
|
243
|
-
};
|
|
244
|
-
|
|
245
|
-
type ServerAllocation$1 = {
|
|
246
|
-
id: number;
|
|
247
|
-
ip: string;
|
|
248
|
-
ip_alias: Nullable<string>;
|
|
249
|
-
port: number;
|
|
250
|
-
notes: Nullable<string>;
|
|
251
|
-
is_default: boolean;
|
|
138
|
+
type EggVariable = {
|
|
139
|
+
name: string;
|
|
140
|
+
description: string;
|
|
141
|
+
env_variable: string;
|
|
142
|
+
default_value: string;
|
|
143
|
+
server_value: string;
|
|
144
|
+
is_editable: boolean;
|
|
145
|
+
rules: string;
|
|
252
146
|
};
|
|
253
147
|
|
|
254
148
|
type ServerSubuser = {
|
|
@@ -265,6 +159,15 @@ type ServerSubuser = {
|
|
|
265
159
|
};
|
|
266
160
|
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";
|
|
267
161
|
|
|
162
|
+
type ServerAllocation$1 = {
|
|
163
|
+
id: number;
|
|
164
|
+
ip: string;
|
|
165
|
+
ip_alias: Nullable<string>;
|
|
166
|
+
port: number;
|
|
167
|
+
notes: Nullable<string>;
|
|
168
|
+
is_default: boolean;
|
|
169
|
+
};
|
|
170
|
+
|
|
268
171
|
type Server$1 = {
|
|
269
172
|
server_owner: boolean;
|
|
270
173
|
identifier: string;
|
|
@@ -352,6 +255,103 @@ type Permission = {
|
|
|
352
255
|
keys: Record<string, string>;
|
|
353
256
|
};
|
|
354
257
|
|
|
258
|
+
type SocketEventPayloadMap = {
|
|
259
|
+
[SOCKET_EVENT.AUTH_SUCCESS]: undefined;
|
|
260
|
+
[SOCKET_EVENT.STATUS]: PowerState;
|
|
261
|
+
[SOCKET_EVENT.CONSOLE_OUTPUT]: string;
|
|
262
|
+
[SOCKET_EVENT.STATS]: StatsWsJson;
|
|
263
|
+
[SOCKET_EVENT.DAEMON_ERROR]: undefined;
|
|
264
|
+
[SOCKET_EVENT.DAEMON_MESSAGE]: string;
|
|
265
|
+
[SOCKET_EVENT.INSTALL_OUTPUT]: string;
|
|
266
|
+
[SOCKET_EVENT.INSTALL_STARTED]: undefined;
|
|
267
|
+
[SOCKET_EVENT.INSTALL_COMPLETED]: undefined;
|
|
268
|
+
[SOCKET_EVENT.TRANSFER_LOGS]: string;
|
|
269
|
+
[SOCKET_EVENT.TRANSFER_STATUS]: string;
|
|
270
|
+
[SOCKET_EVENT.BACKUP_COMPLETED]: BackupCompletedJson;
|
|
271
|
+
[SOCKET_EVENT.BACKUP_RESTORE_COMPLETED]: undefined;
|
|
272
|
+
[SOCKET_EVENT.TOKEN_EXPIRING]: undefined;
|
|
273
|
+
[SOCKET_EVENT.TOKEN_EXPIRED]: undefined;
|
|
274
|
+
[SOCKET_EVENT.JWT_ERROR]: string;
|
|
275
|
+
};
|
|
276
|
+
type Listener<E extends SOCKET_EVENT> = SocketEventPayloadMap[E] extends undefined ? () => void : (payload: SocketEventPayloadMap[E]) => void;
|
|
277
|
+
type CloseEventLike = Parameters<NonNullable<WebSocket["onclose"]>>[0];
|
|
278
|
+
type ErrorEventLike = Parameters<NonNullable<WebSocket["onerror"]>>[0];
|
|
279
|
+
declare class ServerWebsocket {
|
|
280
|
+
private readonly r;
|
|
281
|
+
private readonly serverId;
|
|
282
|
+
private socket?;
|
|
283
|
+
private currentToken?;
|
|
284
|
+
private readonly bus;
|
|
285
|
+
private debugLogging;
|
|
286
|
+
private stripColors;
|
|
287
|
+
private detachMessageListener?;
|
|
288
|
+
constructor(requester: AxiosInstance, id: string, stripColors?: boolean);
|
|
289
|
+
on<E extends SOCKET_EVENT>(event: E, listener: Listener<E>): () => void;
|
|
290
|
+
deregister<E extends SOCKET_EVENT>(event: E, listener: Listener<E>): void;
|
|
291
|
+
private emit;
|
|
292
|
+
connect(resumable?: boolean, debugLogging?: boolean): Promise<void>;
|
|
293
|
+
onSocketDisconnect(handler: (event: CloseEventLike) => void): void;
|
|
294
|
+
onSocketError(handler: (event: ErrorEventLike) => void): void;
|
|
295
|
+
makeResumable(disconnectsToo: boolean): void;
|
|
296
|
+
private attachMessageListener;
|
|
297
|
+
private handleIncomingMessage;
|
|
298
|
+
private parseMessage;
|
|
299
|
+
private normalisePayload;
|
|
300
|
+
private dispatchMessage;
|
|
301
|
+
private refreshCredentials;
|
|
302
|
+
private authenticate;
|
|
303
|
+
disconnect(): void;
|
|
304
|
+
requestStats(): void;
|
|
305
|
+
requestLogs(): void;
|
|
306
|
+
private send;
|
|
307
|
+
getStats(): Promise<StatsWsJson>;
|
|
308
|
+
getLogs(): Promise<string[]>;
|
|
309
|
+
sendPoweraction(action: ServerSignalOption): void;
|
|
310
|
+
sendCommand(cmd: string): void;
|
|
311
|
+
}
|
|
312
|
+
|
|
313
|
+
/**
|
|
314
|
+
* Source: https://github.com/pterodactyl/panel/blob/1.0-develop/resources/scripts/components/server/events.ts
|
|
315
|
+
*/
|
|
316
|
+
declare enum SOCKET_EVENT {
|
|
317
|
+
AUTH_SUCCESS = "auth success",
|
|
318
|
+
DAEMON_MESSAGE = "daemon message",
|
|
319
|
+
DAEMON_ERROR = "daemon error",
|
|
320
|
+
INSTALL_OUTPUT = "install output",
|
|
321
|
+
INSTALL_STARTED = "install started",
|
|
322
|
+
INSTALL_COMPLETED = "install completed",
|
|
323
|
+
CONSOLE_OUTPUT = "console output",
|
|
324
|
+
STATUS = "status",
|
|
325
|
+
STATS = "stats",
|
|
326
|
+
TRANSFER_LOGS = "transfer logs",
|
|
327
|
+
TRANSFER_STATUS = "transfer status",
|
|
328
|
+
BACKUP_COMPLETED = "backup completed",
|
|
329
|
+
BACKUP_RESTORE_COMPLETED = "backup restore completed",
|
|
330
|
+
TOKEN_EXPIRING = "token expiring",
|
|
331
|
+
TOKEN_EXPIRED = "token expired",
|
|
332
|
+
JWT_ERROR = "jwt error"
|
|
333
|
+
}
|
|
334
|
+
type BackupCompletedJson = {
|
|
335
|
+
checksum: string;
|
|
336
|
+
checksum_type: "sha1";
|
|
337
|
+
file_size: number;
|
|
338
|
+
is_successful: boolean;
|
|
339
|
+
uuid: string;
|
|
340
|
+
};
|
|
341
|
+
type PowerState = "starting" | "stopping" | "running" | "offline";
|
|
342
|
+
type StatsWsJson = {
|
|
343
|
+
memory_bytes: number;
|
|
344
|
+
memory_limit_bytes: number;
|
|
345
|
+
cpu_absolute: number;
|
|
346
|
+
network: {
|
|
347
|
+
rx_bytes: number;
|
|
348
|
+
tx_bytes: number;
|
|
349
|
+
};
|
|
350
|
+
state: PowerState;
|
|
351
|
+
uptime: number;
|
|
352
|
+
disk_bytes: number;
|
|
353
|
+
};
|
|
354
|
+
|
|
355
355
|
declare class Account$1 {
|
|
356
356
|
private readonly r;
|
|
357
357
|
constructor(requester: AxiosInstance);
|
package/dist/index.d.ts
CHANGED
|
@@ -1,7 +1,17 @@
|
|
|
1
1
|
import { AxiosInstance } from 'axios';
|
|
2
2
|
import WebSocket from 'isomorphic-ws';
|
|
3
3
|
|
|
4
|
-
type
|
|
4
|
+
type FileObject = {
|
|
5
|
+
name: string;
|
|
6
|
+
mode: string;
|
|
7
|
+
mode_bits: string;
|
|
8
|
+
size: number;
|
|
9
|
+
is_file: boolean;
|
|
10
|
+
is_symlink: boolean;
|
|
11
|
+
mimetype: string;
|
|
12
|
+
created_at: string;
|
|
13
|
+
modified_at: string;
|
|
14
|
+
};
|
|
5
15
|
|
|
6
16
|
type GenericResponse<T, N extends string = string, M = undefined> = {
|
|
7
17
|
object: N;
|
|
@@ -49,6 +59,20 @@ type ServerDatabase$1 = {
|
|
|
49
59
|
type PartialBy<T, K extends keyof T> = Omit<T, K> & Partial<Pick<T, K>>;
|
|
50
60
|
type Nullable<T> = T | null;
|
|
51
61
|
|
|
62
|
+
type ServerBackup$1 = {
|
|
63
|
+
uuid: string;
|
|
64
|
+
is_successful: boolean;
|
|
65
|
+
is_locked: boolean;
|
|
66
|
+
name: string;
|
|
67
|
+
ignored_files: string[];
|
|
68
|
+
checksum: Nullable<string>;
|
|
69
|
+
bytes: number;
|
|
70
|
+
created_at: string;
|
|
71
|
+
completed_at: Nullable<string>;
|
|
72
|
+
};
|
|
73
|
+
|
|
74
|
+
type ServerSignalOption = "start" | "stop" | "restart" | "kill";
|
|
75
|
+
|
|
52
76
|
type ServerLimits = {
|
|
53
77
|
memory: number;
|
|
54
78
|
swap: number;
|
|
@@ -79,40 +103,6 @@ type StartupMeta = {
|
|
|
79
103
|
raw_startup_command: string;
|
|
80
104
|
};
|
|
81
105
|
|
|
82
|
-
type ServerBackup$1 = {
|
|
83
|
-
uuid: string;
|
|
84
|
-
is_successful: boolean;
|
|
85
|
-
is_locked: boolean;
|
|
86
|
-
name: string;
|
|
87
|
-
ignored_files: string[];
|
|
88
|
-
checksum: Nullable<string>;
|
|
89
|
-
bytes: number;
|
|
90
|
-
created_at: string;
|
|
91
|
-
completed_at: Nullable<string>;
|
|
92
|
-
};
|
|
93
|
-
|
|
94
|
-
type EggVariable = {
|
|
95
|
-
name: string;
|
|
96
|
-
description: string;
|
|
97
|
-
env_variable: string;
|
|
98
|
-
default_value: string;
|
|
99
|
-
server_value: string;
|
|
100
|
-
is_editable: boolean;
|
|
101
|
-
rules: string;
|
|
102
|
-
};
|
|
103
|
-
|
|
104
|
-
type FileObject = {
|
|
105
|
-
name: string;
|
|
106
|
-
mode: string;
|
|
107
|
-
mode_bits: string;
|
|
108
|
-
size: number;
|
|
109
|
-
is_file: boolean;
|
|
110
|
-
is_symlink: boolean;
|
|
111
|
-
mimetype: string;
|
|
112
|
-
created_at: string;
|
|
113
|
-
modified_at: string;
|
|
114
|
-
};
|
|
115
|
-
|
|
116
106
|
type Schedule = {
|
|
117
107
|
id: number;
|
|
118
108
|
name: string;
|
|
@@ -145,110 +135,14 @@ type ScheduleTask = {
|
|
|
145
135
|
updated_at: Nullable<string>;
|
|
146
136
|
};
|
|
147
137
|
|
|
148
|
-
type
|
|
149
|
-
|
|
150
|
-
|
|
151
|
-
|
|
152
|
-
|
|
153
|
-
|
|
154
|
-
|
|
155
|
-
|
|
156
|
-
[SOCKET_EVENT.INSTALL_STARTED]: undefined;
|
|
157
|
-
[SOCKET_EVENT.INSTALL_COMPLETED]: undefined;
|
|
158
|
-
[SOCKET_EVENT.TRANSFER_LOGS]: string;
|
|
159
|
-
[SOCKET_EVENT.TRANSFER_STATUS]: string;
|
|
160
|
-
[SOCKET_EVENT.BACKUP_COMPLETED]: BackupCompletedJson;
|
|
161
|
-
[SOCKET_EVENT.BACKUP_RESTORE_COMPLETED]: undefined;
|
|
162
|
-
[SOCKET_EVENT.TOKEN_EXPIRING]: undefined;
|
|
163
|
-
[SOCKET_EVENT.TOKEN_EXPIRED]: undefined;
|
|
164
|
-
[SOCKET_EVENT.JWT_ERROR]: string;
|
|
165
|
-
};
|
|
166
|
-
type Listener<E extends SOCKET_EVENT> = SocketEventPayloadMap[E] extends undefined ? () => void : (payload: SocketEventPayloadMap[E]) => void;
|
|
167
|
-
type CloseEventLike = Parameters<NonNullable<WebSocket["onclose"]>>[0];
|
|
168
|
-
type ErrorEventLike = Parameters<NonNullable<WebSocket["onerror"]>>[0];
|
|
169
|
-
declare class ServerWebsocket {
|
|
170
|
-
private readonly r;
|
|
171
|
-
private readonly serverId;
|
|
172
|
-
private socket?;
|
|
173
|
-
private currentToken?;
|
|
174
|
-
private readonly bus;
|
|
175
|
-
private debugLogging;
|
|
176
|
-
private stripColors;
|
|
177
|
-
private detachMessageListener?;
|
|
178
|
-
constructor(requester: AxiosInstance, id: string, stripColors?: boolean);
|
|
179
|
-
on<E extends SOCKET_EVENT>(event: E, listener: Listener<E>): () => void;
|
|
180
|
-
deregister<E extends SOCKET_EVENT>(event: E, listener: Listener<E>): void;
|
|
181
|
-
private emit;
|
|
182
|
-
connect(resumable?: boolean, debugLogging?: boolean): Promise<void>;
|
|
183
|
-
onSocketDisconnect(handler: (event: CloseEventLike) => void): void;
|
|
184
|
-
onSocketError(handler: (event: ErrorEventLike) => void): void;
|
|
185
|
-
makeResumable(disconnectsToo: boolean): void;
|
|
186
|
-
private attachMessageListener;
|
|
187
|
-
private handleIncomingMessage;
|
|
188
|
-
private parseMessage;
|
|
189
|
-
private normalisePayload;
|
|
190
|
-
private dispatchMessage;
|
|
191
|
-
private refreshCredentials;
|
|
192
|
-
private authenticate;
|
|
193
|
-
disconnect(): void;
|
|
194
|
-
requestStats(): void;
|
|
195
|
-
requestLogs(): void;
|
|
196
|
-
private send;
|
|
197
|
-
getStats(): Promise<StatsWsJson>;
|
|
198
|
-
getLogs(): Promise<string[]>;
|
|
199
|
-
sendPoweraction(action: ServerSignalOption): void;
|
|
200
|
-
sendCommand(cmd: string): void;
|
|
201
|
-
}
|
|
202
|
-
|
|
203
|
-
/**
|
|
204
|
-
* Source: https://github.com/pterodactyl/panel/blob/1.0-develop/resources/scripts/components/server/events.ts
|
|
205
|
-
*/
|
|
206
|
-
declare enum SOCKET_EVENT {
|
|
207
|
-
AUTH_SUCCESS = "auth success",
|
|
208
|
-
DAEMON_MESSAGE = "daemon message",
|
|
209
|
-
DAEMON_ERROR = "daemon error",
|
|
210
|
-
INSTALL_OUTPUT = "install output",
|
|
211
|
-
INSTALL_STARTED = "install started",
|
|
212
|
-
INSTALL_COMPLETED = "install completed",
|
|
213
|
-
CONSOLE_OUTPUT = "console output",
|
|
214
|
-
STATUS = "status",
|
|
215
|
-
STATS = "stats",
|
|
216
|
-
TRANSFER_LOGS = "transfer logs",
|
|
217
|
-
TRANSFER_STATUS = "transfer status",
|
|
218
|
-
BACKUP_COMPLETED = "backup completed",
|
|
219
|
-
BACKUP_RESTORE_COMPLETED = "backup restore completed",
|
|
220
|
-
TOKEN_EXPIRING = "token expiring",
|
|
221
|
-
TOKEN_EXPIRED = "token expired",
|
|
222
|
-
JWT_ERROR = "jwt error"
|
|
223
|
-
}
|
|
224
|
-
type BackupCompletedJson = {
|
|
225
|
-
checksum: string;
|
|
226
|
-
checksum_type: "sha1";
|
|
227
|
-
file_size: number;
|
|
228
|
-
is_successful: boolean;
|
|
229
|
-
uuid: string;
|
|
230
|
-
};
|
|
231
|
-
type PowerState = "starting" | "stopping" | "running" | "offline";
|
|
232
|
-
type StatsWsJson = {
|
|
233
|
-
memory_bytes: number;
|
|
234
|
-
memory_limit_bytes: number;
|
|
235
|
-
cpu_absolute: number;
|
|
236
|
-
network: {
|
|
237
|
-
rx_bytes: number;
|
|
238
|
-
tx_bytes: number;
|
|
239
|
-
};
|
|
240
|
-
state: PowerState;
|
|
241
|
-
uptime: number;
|
|
242
|
-
disk_bytes: number;
|
|
243
|
-
};
|
|
244
|
-
|
|
245
|
-
type ServerAllocation$1 = {
|
|
246
|
-
id: number;
|
|
247
|
-
ip: string;
|
|
248
|
-
ip_alias: Nullable<string>;
|
|
249
|
-
port: number;
|
|
250
|
-
notes: Nullable<string>;
|
|
251
|
-
is_default: boolean;
|
|
138
|
+
type EggVariable = {
|
|
139
|
+
name: string;
|
|
140
|
+
description: string;
|
|
141
|
+
env_variable: string;
|
|
142
|
+
default_value: string;
|
|
143
|
+
server_value: string;
|
|
144
|
+
is_editable: boolean;
|
|
145
|
+
rules: string;
|
|
252
146
|
};
|
|
253
147
|
|
|
254
148
|
type ServerSubuser = {
|
|
@@ -265,6 +159,15 @@ type ServerSubuser = {
|
|
|
265
159
|
};
|
|
266
160
|
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";
|
|
267
161
|
|
|
162
|
+
type ServerAllocation$1 = {
|
|
163
|
+
id: number;
|
|
164
|
+
ip: string;
|
|
165
|
+
ip_alias: Nullable<string>;
|
|
166
|
+
port: number;
|
|
167
|
+
notes: Nullable<string>;
|
|
168
|
+
is_default: boolean;
|
|
169
|
+
};
|
|
170
|
+
|
|
268
171
|
type Server$1 = {
|
|
269
172
|
server_owner: boolean;
|
|
270
173
|
identifier: string;
|
|
@@ -352,6 +255,103 @@ type Permission = {
|
|
|
352
255
|
keys: Record<string, string>;
|
|
353
256
|
};
|
|
354
257
|
|
|
258
|
+
type SocketEventPayloadMap = {
|
|
259
|
+
[SOCKET_EVENT.AUTH_SUCCESS]: undefined;
|
|
260
|
+
[SOCKET_EVENT.STATUS]: PowerState;
|
|
261
|
+
[SOCKET_EVENT.CONSOLE_OUTPUT]: string;
|
|
262
|
+
[SOCKET_EVENT.STATS]: StatsWsJson;
|
|
263
|
+
[SOCKET_EVENT.DAEMON_ERROR]: undefined;
|
|
264
|
+
[SOCKET_EVENT.DAEMON_MESSAGE]: string;
|
|
265
|
+
[SOCKET_EVENT.INSTALL_OUTPUT]: string;
|
|
266
|
+
[SOCKET_EVENT.INSTALL_STARTED]: undefined;
|
|
267
|
+
[SOCKET_EVENT.INSTALL_COMPLETED]: undefined;
|
|
268
|
+
[SOCKET_EVENT.TRANSFER_LOGS]: string;
|
|
269
|
+
[SOCKET_EVENT.TRANSFER_STATUS]: string;
|
|
270
|
+
[SOCKET_EVENT.BACKUP_COMPLETED]: BackupCompletedJson;
|
|
271
|
+
[SOCKET_EVENT.BACKUP_RESTORE_COMPLETED]: undefined;
|
|
272
|
+
[SOCKET_EVENT.TOKEN_EXPIRING]: undefined;
|
|
273
|
+
[SOCKET_EVENT.TOKEN_EXPIRED]: undefined;
|
|
274
|
+
[SOCKET_EVENT.JWT_ERROR]: string;
|
|
275
|
+
};
|
|
276
|
+
type Listener<E extends SOCKET_EVENT> = SocketEventPayloadMap[E] extends undefined ? () => void : (payload: SocketEventPayloadMap[E]) => void;
|
|
277
|
+
type CloseEventLike = Parameters<NonNullable<WebSocket["onclose"]>>[0];
|
|
278
|
+
type ErrorEventLike = Parameters<NonNullable<WebSocket["onerror"]>>[0];
|
|
279
|
+
declare class ServerWebsocket {
|
|
280
|
+
private readonly r;
|
|
281
|
+
private readonly serverId;
|
|
282
|
+
private socket?;
|
|
283
|
+
private currentToken?;
|
|
284
|
+
private readonly bus;
|
|
285
|
+
private debugLogging;
|
|
286
|
+
private stripColors;
|
|
287
|
+
private detachMessageListener?;
|
|
288
|
+
constructor(requester: AxiosInstance, id: string, stripColors?: boolean);
|
|
289
|
+
on<E extends SOCKET_EVENT>(event: E, listener: Listener<E>): () => void;
|
|
290
|
+
deregister<E extends SOCKET_EVENT>(event: E, listener: Listener<E>): void;
|
|
291
|
+
private emit;
|
|
292
|
+
connect(resumable?: boolean, debugLogging?: boolean): Promise<void>;
|
|
293
|
+
onSocketDisconnect(handler: (event: CloseEventLike) => void): void;
|
|
294
|
+
onSocketError(handler: (event: ErrorEventLike) => void): void;
|
|
295
|
+
makeResumable(disconnectsToo: boolean): void;
|
|
296
|
+
private attachMessageListener;
|
|
297
|
+
private handleIncomingMessage;
|
|
298
|
+
private parseMessage;
|
|
299
|
+
private normalisePayload;
|
|
300
|
+
private dispatchMessage;
|
|
301
|
+
private refreshCredentials;
|
|
302
|
+
private authenticate;
|
|
303
|
+
disconnect(): void;
|
|
304
|
+
requestStats(): void;
|
|
305
|
+
requestLogs(): void;
|
|
306
|
+
private send;
|
|
307
|
+
getStats(): Promise<StatsWsJson>;
|
|
308
|
+
getLogs(): Promise<string[]>;
|
|
309
|
+
sendPoweraction(action: ServerSignalOption): void;
|
|
310
|
+
sendCommand(cmd: string): void;
|
|
311
|
+
}
|
|
312
|
+
|
|
313
|
+
/**
|
|
314
|
+
* Source: https://github.com/pterodactyl/panel/blob/1.0-develop/resources/scripts/components/server/events.ts
|
|
315
|
+
*/
|
|
316
|
+
declare enum SOCKET_EVENT {
|
|
317
|
+
AUTH_SUCCESS = "auth success",
|
|
318
|
+
DAEMON_MESSAGE = "daemon message",
|
|
319
|
+
DAEMON_ERROR = "daemon error",
|
|
320
|
+
INSTALL_OUTPUT = "install output",
|
|
321
|
+
INSTALL_STARTED = "install started",
|
|
322
|
+
INSTALL_COMPLETED = "install completed",
|
|
323
|
+
CONSOLE_OUTPUT = "console output",
|
|
324
|
+
STATUS = "status",
|
|
325
|
+
STATS = "stats",
|
|
326
|
+
TRANSFER_LOGS = "transfer logs",
|
|
327
|
+
TRANSFER_STATUS = "transfer status",
|
|
328
|
+
BACKUP_COMPLETED = "backup completed",
|
|
329
|
+
BACKUP_RESTORE_COMPLETED = "backup restore completed",
|
|
330
|
+
TOKEN_EXPIRING = "token expiring",
|
|
331
|
+
TOKEN_EXPIRED = "token expired",
|
|
332
|
+
JWT_ERROR = "jwt error"
|
|
333
|
+
}
|
|
334
|
+
type BackupCompletedJson = {
|
|
335
|
+
checksum: string;
|
|
336
|
+
checksum_type: "sha1";
|
|
337
|
+
file_size: number;
|
|
338
|
+
is_successful: boolean;
|
|
339
|
+
uuid: string;
|
|
340
|
+
};
|
|
341
|
+
type PowerState = "starting" | "stopping" | "running" | "offline";
|
|
342
|
+
type StatsWsJson = {
|
|
343
|
+
memory_bytes: number;
|
|
344
|
+
memory_limit_bytes: number;
|
|
345
|
+
cpu_absolute: number;
|
|
346
|
+
network: {
|
|
347
|
+
rx_bytes: number;
|
|
348
|
+
tx_bytes: number;
|
|
349
|
+
};
|
|
350
|
+
state: PowerState;
|
|
351
|
+
uptime: number;
|
|
352
|
+
disk_bytes: number;
|
|
353
|
+
};
|
|
354
|
+
|
|
355
355
|
declare class Account$1 {
|
|
356
356
|
private readonly r;
|
|
357
357
|
constructor(requester: AxiosInstance);
|
package/dist/index.js
CHANGED
package/dist/index.mjs
CHANGED