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

package/dist/index.d.mts

@@ -1505,7 +1505,7 @@ declare class Roles {
 type Egg = {
     id: number;
     uuid: string;
-    name: number;
+    name: string;
     author: string;
     description: string;
     features: string[];
@@ -1548,7 +1548,7 @@ type ExportedEgg = {
         update_url: Nullable<string>;
     };
     exported_at: string;
-    name: number;
+    name: string;
     author: string;
     description: string;
     uuid: string;

package/dist/index.d.ts

@@ -1505,7 +1505,7 @@ declare class Roles {
 type Egg = {
     id: number;
     uuid: string;
-    name: number;
+    name: string;
     author: string;
     description: string;
     features: string[];
@@ -1548,7 +1548,7 @@ type ExportedEgg = {
         update_url: Nullable<string>;
     };
     exported_at: string;
-    name: number;
+    name: string;
     author: string;
     description: string;
     uuid: string;

package/dist/types.d.ts

@@ -1,4 +1,6 @@
 import z from 'zod';
+import { AxiosInstance } from 'axios';
+import WebSocket from 'isomorphic-ws';
 
 type ServerSignalOption = 'start' | 'stop' | 'restart' | 'kill';
 
@@ -844,7 +846,7 @@ type Role = {
 type Egg = {
     id: number;
     uuid: string;
-    name: number;
+    name: string;
     author: string;
     description: string;
     features: string[];
@@ -887,7 +889,7 @@ type ExportedEgg = {
         update_url: Nullable<string>;
     };
     exported_at: string;
-    name: number;
+    name: string;
     author: string;
     description: string;
     uuid: string;
@@ -938,6 +940,61 @@ type ApplicationUserApiKey = {
     updated_at: string;
 };
 
+type SocketEventPayloadMap = {
+    [SOCKET_EVENT.AUTH_SUCCESS]: undefined;
+    [SOCKET_EVENT.STATUS]: PowerState;
+    [SOCKET_EVENT.CONSOLE_OUTPUT]: string;
+    [SOCKET_EVENT.STATS]: StatsWsJson;
+    [SOCKET_EVENT.DAEMON_ERROR]: undefined;
+    [SOCKET_EVENT.DAEMON_MESSAGE]: string;
+    [SOCKET_EVENT.INSTALL_OUTPUT]: string;
+    [SOCKET_EVENT.INSTALL_STARTED]: undefined;
+    [SOCKET_EVENT.INSTALL_COMPLETED]: undefined;
+    [SOCKET_EVENT.TRANSFER_LOGS]: string;
+    [SOCKET_EVENT.TRANSFER_STATUS]: string;
+    [SOCKET_EVENT.BACKUP_COMPLETED]: BackupCompletedJson;
+    [SOCKET_EVENT.BACKUP_RESTORE_COMPLETED]: undefined;
+    [SOCKET_EVENT.TOKEN_EXPIRING]: undefined;
+    [SOCKET_EVENT.TOKEN_EXPIRED]: undefined;
+    [SOCKET_EVENT.JWT_ERROR]: string;
+};
+type Listener<E extends SOCKET_EVENT> = SocketEventPayloadMap[E] extends undefined ? () => void : (payload: SocketEventPayloadMap[E]) => void;
+type CloseEventLike = Parameters<NonNullable<WebSocket["onclose"]>>[0];
+type ErrorEventLike = Parameters<NonNullable<WebSocket["onerror"]>>[0];
+declare class ServerWebsocket {
+    private readonly r;
+    private readonly serverId;
+    private socket?;
+    private currentToken?;
+    private readonly bus;
+    private debugLogging;
+    private stripColors;
+    private detachMessageListener?;
+    constructor(requester: AxiosInstance, id: string, stripColors?: boolean);
+    on<E extends SOCKET_EVENT>(event: E, listener: Listener<E>): () => void;
+    deregister<E extends SOCKET_EVENT>(event: E, listener: Listener<E>): void;
+    private emit;
+    connect(resumable?: boolean, debugLogging?: boolean): Promise<void>;
+    onSocketDisconnect(handler: (event: CloseEventLike) => void): void;
+    onSocketError(handler: (event: ErrorEventLike) => void): void;
+    makeResumable(disconnectsToo: boolean): void;
+    private attachMessageListener;
+    private handleIncomingMessage;
+    private parseMessage;
+    private normalisePayload;
+    private dispatchMessage;
+    private refreshCredentials;
+    private authenticate;
+    disconnect(): void;
+    requestStats(): void;
+    requestLogs(): void;
+    private send;
+    getStats(): Promise<StatsWsJson>;
+    getLogs(): Promise<string[]>;
+    sendPoweraction(action: ServerSignalOption): void;
+    sendCommand(cmd: string): void;
+}
+
 type ServerStatus = 'starting' | 'stopping' | 'online' | 'offline';
 declare enum SERVER_SIGNAL {
     'START' = "start",
@@ -1164,4 +1221,4 @@ type Permission = {
     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 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, 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.3.4-next.2",
+  "version": "0.3.4-next.4",
   "description": "Pelican panel SDK for TypeScript",
   "main": "./dist/index.js",
   "module": "./dist/index.mjs",

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

@@ -4,7 +4,7 @@ import {EggVariable} from "@/api/common/types";
 export type Egg = {
     id: number,
     uuid: string,
-    name: number,
+    name: string,
     author: string,
     description: string,
     features: string[],
@@ -50,7 +50,7 @@ export type ExportedEgg = {
         update_url: Nullable<string>
     },
     exported_at: string,
-    name: number,
+    name: string,
     author: string,
     description: string,
     uuid: string,

package/src/api/client/types/websocket.ts

@@ -147,4 +147,4 @@ export type JwtErrorEvent = {
     args: [string];
 };
 
-
+export {ServerWebsocket} from "@/api/client/server_websocket";