@frp-bridge/types 0.0.1 → 0.0.2

package/dist/index.d.mts

@@ -524,4 +524,137 @@ interface SUDPVisitorConfig extends BaseVisitorConfig {
 /** Union type of all visitor configurations */
 type VisitorConfig = STCPVisitorConfig | XTCPVisitorConfig | SUDPVisitorConfig;
 
-export type { AuthClientConfig, AuthMethod, AuthOIDCClientConfig, AuthOIDCServerConfig, AuthScope, AuthServerConfig, BaseProxyConfig, BaseVisitorConfig, ClientCommonConfig, ClientConfig, ClientTransportConfig, ClientTransportProtocol, FileSource, HTTPHeader, HTTPPluginOptions, HTTPProxyConfig, HTTPSProxyConfig, HeaderOperations, LoadBalancerStrategy, LogConfig, LogLevel, NatTraversalConfig, PortsRange, ProxyConfig, ProxyType, QUICOptions, SSHTunnelGateway, STCPProxyConfig, STCPVisitorConfig, SUDPProxyConfig, SUDPVisitorConfig, ServerConfig, ServerTransportConfig, TCPMUXProxyConfig, TCPProxyConfig, TLSClientConfig, TLSConfig, TLSServerConfig, UDPProxyConfig, ValueSource, ValueSourceType, VirtualNetConfig, VisitorConfig, VisitorType, WebServerConfig, XTCPProxyConfig, XTCPVisitorConfig };
+/**
+ * Node management types
+ * Defines types for managing frp-bridge client nodes connected to server
+ */
+
+/** Node information structure */
+interface NodeInfo {
+    id: string;
+    ip: string;
+    port: number;
+    protocol: 'tcp' | 'udp';
+    serverAddr: string;
+    serverPort: number;
+    hostname?: string;
+    osType?: string;
+    osRelease?: string;
+    platform?: string;
+    cpuCores?: number;
+    memTotal?: number;
+    frpVersion?: string;
+    bridgeVersion?: string;
+    status: 'online' | 'offline' | 'connecting' | 'error';
+    lastHeartbeat?: number;
+    connectedAt?: number;
+    labels?: Record<string, string>;
+    metadata?: Record<string, unknown>;
+    token?: string;
+    tunnels?: ProxyConfig[];
+    createdAt: number;
+    updatedAt: number;
+}
+/** Payload for node registration (Client → Server) */
+interface NodeRegisterPayload {
+    ip: string;
+    port: number;
+    serverAddr: string;
+    serverPort: number;
+    protocol: 'tcp' | 'udp';
+    hostname: string;
+    osType: string;
+    osRelease: string;
+    platform: string;
+    cpuCores: number;
+    memTotal: number;
+    frpVersion: string;
+    bridgeVersion: string;
+    token?: string;
+}
+/** Payload for node heartbeat (Client → Server) */
+interface NodeHeartbeatPayload {
+    nodeId: string;
+    status: 'online' | 'error';
+    lastHeartbeat: number;
+    cpuCores?: number;
+    memTotal?: number;
+}
+/** Payload for tunnel synchronization (Client → Server) */
+interface TunnelSyncPayload {
+    nodeId: string;
+    tunnels: ProxyConfig[];
+    timestamp: number;
+}
+/** Payload for tunnel management via RPC (Server → Client) */
+interface TunnelManagePayload {
+    action: 'add' | 'update' | 'remove' | 'list';
+    tunnel?: ProxyConfig | Partial<ProxyConfig>;
+    name?: string;
+}
+/** Response for tunnel management */
+interface TunnelManageResponse {
+    success: boolean;
+    tunnel?: ProxyConfig;
+    tunnels?: ProxyConfig[];
+    error?: string;
+}
+/** Query parameters for listing nodes */
+interface NodeListQuery {
+    page?: number;
+    pageSize?: number;
+    status?: NodeInfo['status'];
+    labels?: Record<string, string>;
+    search?: string;
+}
+/** Response for node list query */
+interface NodeListResponse {
+    items: NodeInfo[];
+    total: number;
+    page: number;
+    pageSize: number;
+    hasMore: boolean;
+}
+/** Node statistics */
+interface NodeStatistics {
+    total: number;
+    online: number;
+    offline: number;
+    connecting: number;
+    error: number;
+}
+/** Error codes for node operations */
+type NodeErrorCode = 'NODE_NOT_FOUND' | 'NODE_ALREADY_EXISTS' | 'INVALID_NODE_DATA' | 'HEARTBEAT_TIMEOUT' | 'STORAGE_ERROR' | 'UNAUTHORIZED';
+
+interface RpcRequest {
+    id: string;
+    method: string;
+    params: Record<string, unknown>;
+    timeout?: number;
+}
+interface RpcResponse {
+    id: string;
+    status: 'success' | 'error';
+    result?: unknown;
+    error?: {
+        code: string;
+        message: string;
+    };
+}
+interface PingMessage {
+    type: 'ping';
+    timestamp: number;
+}
+interface PongMessage {
+    type: 'pong';
+    timestamp: number;
+}
+interface RegisterMessage {
+    type: 'register';
+    nodeId: string;
+    payload: NodeInfo;
+}
+type RpcInboundMessage = RpcResponse | PongMessage;
+type RpcOutboundMessage = RpcRequest | PingMessage | RegisterMessage;
+
+export type { AuthClientConfig, AuthMethod, AuthOIDCClientConfig, AuthOIDCServerConfig, AuthScope, AuthServerConfig, BaseProxyConfig, BaseVisitorConfig, ClientCommonConfig, ClientConfig, ClientTransportConfig, ClientTransportProtocol, FileSource, HTTPHeader, HTTPPluginOptions, HTTPProxyConfig, HTTPSProxyConfig, HeaderOperations, LoadBalancerStrategy, LogConfig, LogLevel, NatTraversalConfig, NodeErrorCode, NodeHeartbeatPayload, NodeInfo, NodeListQuery, NodeListResponse, NodeRegisterPayload, NodeStatistics, PingMessage, PongMessage, PortsRange, ProxyConfig, ProxyType, QUICOptions, RegisterMessage, RpcInboundMessage, RpcOutboundMessage, RpcRequest, RpcResponse, SSHTunnelGateway, STCPProxyConfig, STCPVisitorConfig, SUDPProxyConfig, SUDPVisitorConfig, ServerConfig, ServerTransportConfig, TCPMUXProxyConfig, TCPProxyConfig, TLSClientConfig, TLSConfig, TLSServerConfig, TunnelManagePayload, TunnelManageResponse, TunnelSyncPayload, UDPProxyConfig, ValueSource, ValueSourceType, VirtualNetConfig, VisitorConfig, VisitorType, WebServerConfig, XTCPProxyConfig, XTCPVisitorConfig };

package/dist/index.d.ts

@@ -524,4 +524,137 @@ interface SUDPVisitorConfig extends BaseVisitorConfig {
 /** Union type of all visitor configurations */
 type VisitorConfig = STCPVisitorConfig | XTCPVisitorConfig | SUDPVisitorConfig;
 
-export type { AuthClientConfig, AuthMethod, AuthOIDCClientConfig, AuthOIDCServerConfig, AuthScope, AuthServerConfig, BaseProxyConfig, BaseVisitorConfig, ClientCommonConfig, ClientConfig, ClientTransportConfig, ClientTransportProtocol, FileSource, HTTPHeader, HTTPPluginOptions, HTTPProxyConfig, HTTPSProxyConfig, HeaderOperations, LoadBalancerStrategy, LogConfig, LogLevel, NatTraversalConfig, PortsRange, ProxyConfig, ProxyType, QUICOptions, SSHTunnelGateway, STCPProxyConfig, STCPVisitorConfig, SUDPProxyConfig, SUDPVisitorConfig, ServerConfig, ServerTransportConfig, TCPMUXProxyConfig, TCPProxyConfig, TLSClientConfig, TLSConfig, TLSServerConfig, UDPProxyConfig, ValueSource, ValueSourceType, VirtualNetConfig, VisitorConfig, VisitorType, WebServerConfig, XTCPProxyConfig, XTCPVisitorConfig };
+/**
+ * Node management types
+ * Defines types for managing frp-bridge client nodes connected to server
+ */
+
+/** Node information structure */
+interface NodeInfo {
+    id: string;
+    ip: string;
+    port: number;
+    protocol: 'tcp' | 'udp';
+    serverAddr: string;
+    serverPort: number;
+    hostname?: string;
+    osType?: string;
+    osRelease?: string;
+    platform?: string;
+    cpuCores?: number;
+    memTotal?: number;
+    frpVersion?: string;
+    bridgeVersion?: string;
+    status: 'online' | 'offline' | 'connecting' | 'error';
+    lastHeartbeat?: number;
+    connectedAt?: number;
+    labels?: Record<string, string>;
+    metadata?: Record<string, unknown>;
+    token?: string;
+    tunnels?: ProxyConfig[];
+    createdAt: number;
+    updatedAt: number;
+}
+/** Payload for node registration (Client → Server) */
+interface NodeRegisterPayload {
+    ip: string;
+    port: number;
+    serverAddr: string;
+    serverPort: number;
+    protocol: 'tcp' | 'udp';
+    hostname: string;
+    osType: string;
+    osRelease: string;
+    platform: string;
+    cpuCores: number;
+    memTotal: number;
+    frpVersion: string;
+    bridgeVersion: string;
+    token?: string;
+}
+/** Payload for node heartbeat (Client → Server) */
+interface NodeHeartbeatPayload {
+    nodeId: string;
+    status: 'online' | 'error';
+    lastHeartbeat: number;
+    cpuCores?: number;
+    memTotal?: number;
+}
+/** Payload for tunnel synchronization (Client → Server) */
+interface TunnelSyncPayload {
+    nodeId: string;
+    tunnels: ProxyConfig[];
+    timestamp: number;
+}
+/** Payload for tunnel management via RPC (Server → Client) */
+interface TunnelManagePayload {
+    action: 'add' | 'update' | 'remove' | 'list';
+    tunnel?: ProxyConfig | Partial<ProxyConfig>;
+    name?: string;
+}
+/** Response for tunnel management */
+interface TunnelManageResponse {
+    success: boolean;
+    tunnel?: ProxyConfig;
+    tunnels?: ProxyConfig[];
+    error?: string;
+}
+/** Query parameters for listing nodes */
+interface NodeListQuery {
+    page?: number;
+    pageSize?: number;
+    status?: NodeInfo['status'];
+    labels?: Record<string, string>;
+    search?: string;
+}
+/** Response for node list query */
+interface NodeListResponse {
+    items: NodeInfo[];
+    total: number;
+    page: number;
+    pageSize: number;
+    hasMore: boolean;
+}
+/** Node statistics */
+interface NodeStatistics {
+    total: number;
+    online: number;
+    offline: number;
+    connecting: number;
+    error: number;
+}
+/** Error codes for node operations */
+type NodeErrorCode = 'NODE_NOT_FOUND' | 'NODE_ALREADY_EXISTS' | 'INVALID_NODE_DATA' | 'HEARTBEAT_TIMEOUT' | 'STORAGE_ERROR' | 'UNAUTHORIZED';
+
+interface RpcRequest {
+    id: string;
+    method: string;
+    params: Record<string, unknown>;
+    timeout?: number;
+}
+interface RpcResponse {
+    id: string;
+    status: 'success' | 'error';
+    result?: unknown;
+    error?: {
+        code: string;
+        message: string;
+    };
+}
+interface PingMessage {
+    type: 'ping';
+    timestamp: number;
+}
+interface PongMessage {
+    type: 'pong';
+    timestamp: number;
+}
+interface RegisterMessage {
+    type: 'register';
+    nodeId: string;
+    payload: NodeInfo;
+}
+type RpcInboundMessage = RpcResponse | PongMessage;
+type RpcOutboundMessage = RpcRequest | PingMessage | RegisterMessage;
+
+export type { AuthClientConfig, AuthMethod, AuthOIDCClientConfig, AuthOIDCServerConfig, AuthScope, AuthServerConfig, BaseProxyConfig, BaseVisitorConfig, ClientCommonConfig, ClientConfig, ClientTransportConfig, ClientTransportProtocol, FileSource, HTTPHeader, HTTPPluginOptions, HTTPProxyConfig, HTTPSProxyConfig, HeaderOperations, LoadBalancerStrategy, LogConfig, LogLevel, NatTraversalConfig, NodeErrorCode, NodeHeartbeatPayload, NodeInfo, NodeListQuery, NodeListResponse, NodeRegisterPayload, NodeStatistics, PingMessage, PongMessage, PortsRange, ProxyConfig, ProxyType, QUICOptions, RegisterMessage, RpcInboundMessage, RpcOutboundMessage, RpcRequest, RpcResponse, SSHTunnelGateway, STCPProxyConfig, STCPVisitorConfig, SUDPProxyConfig, SUDPVisitorConfig, ServerConfig, ServerTransportConfig, TCPMUXProxyConfig, TCPProxyConfig, TLSClientConfig, TLSConfig, TLSServerConfig, TunnelManagePayload, TunnelManageResponse, TunnelSyncPayload, UDPProxyConfig, ValueSource, ValueSourceType, VirtualNetConfig, VisitorConfig, VisitorType, WebServerConfig, XTCPProxyConfig, XTCPVisitorConfig };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@frp-bridge/types",
   "type": "module",
-  "version": "0.0.1",
+  "version": "0.0.2",
   "description": "Frp bridge type definitions",
   "license": "MIT",
   "homepage": "https://github.com/frp-web/bridge#readme",