dg-lab-mcp-sse-server 1.0.3

package/dist/config.d.ts

@@ -0,0 +1,79 @@
+/**
+ * @fileoverview 配置管理模块
+ *
+ * 这个模块负责加载和验证服务器配置。直接从环境变量读取配置，
+ * 对于未设置的选项会使用合理的默认值。
+ *
+ * 主要功能：
+ * - 从环境变量加载配置
+ * - 验证配置值的有效性
+ * - 提供 IP 地址检测（本地和公网）
+ * - 单例模式确保配置一致性
+ */
+/**
+ * 服务器配置
+ *
+ * 包含服务器运行所需的所有配置项。大部分配置都有合理的默认值，
+ * 只有在需要自定义时才需要通过环境变量设置。
+ */
+export interface ServerConfig {
+    /** 服务端口，HTTP 和 WebSocket 共用这个端口 */
+    port: number;
+    /** 公网 IP 地址，用于生成二维码。留空则自动检测本地 IP */
+    publicIp: string;
+    /** SSE 端点路径，MCP 客户端通过这个路径建立 SSE 连接 */
+    ssePath: string;
+    /** POST 端点路径，MCP 客户端通过这个路径发送 JSON-RPC 消息 */
+    postPath: string;
+    /** 会话存储路径（目前未使用，会话仅存内存） */
+    sessionStorePath: string;
+    /** 波形存储路径，保存用户导入的波形数据 */
+    waveformStorePath: string;
+    /** 心跳间隔（毫秒），用于保持 WebSocket 连接活跃 */
+    heartbeatInterval: number;
+    /** 设备过期超时（毫秒），超过这个时间不活跃的设备会被清理 */
+    staleDeviceTimeout: number;
+    /** 连接超时时间（分钟），会话创建后在此时间内未绑定 APP 则自动销毁 */
+    connectionTimeoutMinutes: number;
+}
+/**
+ * 加载服务器配置
+ *
+ * 从环境变量读取所有配置项，.env 文件在模块加载时已经处理过了。
+ * 加载完成后会验证配置的有效性，确保服务器能正常启动。
+ *
+ * @returns 完整的服务器配置对象
+ */
+export declare function loadConfig(): ServerConfig;
+/**
+ * 获取配置实例
+ *
+ * 使用单例模式，第一次调用时加载配置，后续调用返回同一实例。
+ * 这样可以确保整个应用使用一致的配置，避免重复加载。
+ */
+export declare function getConfig(): ServerConfig;
+/**
+ * 重置配置实例
+ *
+ * 主要用于测试场景，让每个测试用例可以从干净的状态开始。
+ * 生产环境一般不需要调用这个函数。
+ */
+export declare function resetConfig(): void;
+/**
+ * 获取本地 IP 地址
+ *
+ * 遍历所有网络接口，找到第一个非内部的 IPv4 地址。
+ * 这通常是局域网 IP，适合在本地网络中使用。
+ * 如果找不到合适的地址，返回 localhost。
+ */
+export declare function getLocalIP(): string;
+/**
+ * 获取用于生成二维码的 IP 地址
+ *
+ * 优先使用配置中的公网 IP，如果没有设置则自动检测本地 IP。
+ * 这个函数集中了 IP 地址的获取逻辑，避免在多处重复实现。
+ *
+ * @param config - 可选，不传则使用单例配置
+ */
+export declare function getEffectiveIP(config?: ServerConfig): string;
+//# sourceMappingURL=config.d.ts.map

package/dist/config.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"config.d.ts","sourceRoot":"","sources":["../src/config.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;GAWG;AAIH;;;;;GAKG;AACH,MAAM,WAAW,YAAY;IAC3B,mCAAmC;IACnC,IAAI,EAAE,MAAM,CAAC;IACb,oCAAoC;IACpC,QAAQ,EAAE,MAAM,CAAC;IACjB,sCAAsC;IACtC,OAAO,EAAE,MAAM,CAAC;IAChB,4CAA4C;IAC5C,QAAQ,EAAE,MAAM,CAAC;IACjB,2BAA2B;IAC3B,gBAAgB,EAAE,MAAM,CAAC;IACzB,yBAAyB;IACzB,iBAAiB,EAAE,MAAM,CAAC;IAC1B,mCAAmC;IACnC,iBAAiB,EAAE,MAAM,CAAC;IAC1B,kCAAkC;IAClC,kBAAkB,EAAE,MAAM,CAAC;IAC3B,yCAAyC;IACzC,wBAAwB,EAAE,MAAM,CAAC;CAClC;AAiCD;;;;;;;GAOG;AACH,wBAAgB,UAAU,IAAI,YAAY,CAezC;AAyED;;;;;GAKG;AACH,wBAAgB,SAAS,IAAI,YAAY,CAKxC;AAED;;;;;GAKG;AACH,wBAAgB,WAAW,IAAI,IAAI,CAElC;AAED;;;;;;GAMG;AACH,wBAAgB,UAAU,IAAI,MAAM,CAWnC;AAED;;;;;;;GAOG;AACH,wBAAgB,cAAc,CAAC,MAAM,CAAC,EAAE,YAAY,GAAG,MAAM,CAG5D"}

package/dist/errors.d.ts

@@ -0,0 +1,132 @@
+/**
+ * @fileoverview 统一错误处理模块
+ *
+ * 这个模块定义了应用中使用的所有错误类型。通过统一的错误结构，
+ * 可以更方便地进行错误处理、日志记录和用户反馈。
+ *
+ * 错误分类：
+ * - ConfigError: 配置问题，通常需要修复配置后重启
+ * - ConnectionError: 连接问题，单个连接失败不影响其他
+ * - ToolError: 工具调用失败，可以重试或换个方式
+ * - WebSocketError: WebSocket 通信问题
+ * - WaveformError: 波形数据处理问题
+ */
+/**
+ * 错误码枚举
+ *
+ * 按模块分组，方便快速定位问题来源。错误码是字符串而不是数字，
+ * 这样在日志中更容易理解。
+ */
+export declare enum ErrorCode {
+    CONFIG_LOAD_FAILED = "CONFIG_LOAD_FAILED",
+    CONFIG_INVALID_PORT = "CONFIG_INVALID_PORT",
+    CONFIG_INVALID_IP = "CONFIG_INVALID_IP",
+    CONFIG_INVALID_PATH = "CONFIG_INVALID_PATH",
+    CONN_DEVICE_NOT_FOUND = "CONN_DEVICE_NOT_FOUND",
+    CONN_NOT_BOUND = "CONN_NOT_BOUND",
+    CONN_ALREADY_EXISTS = "CONN_ALREADY_EXISTS",
+    CONN_TIMEOUT = "CONN_TIMEOUT",
+    TOOL_INVALID_PARAMS = "TOOL_INVALID_PARAMS",
+    TOOL_EXECUTION_FAILED = "TOOL_EXECUTION_FAILED",
+    TOOL_NOT_FOUND = "TOOL_NOT_FOUND",
+    WS_CONNECTION_FAILED = "WS_CONNECTION_FAILED",
+    WS_MESSAGE_INVALID = "WS_MESSAGE_INVALID",
+    WS_PEER_DISCONNECTED = "WS_PEER_DISCONNECTED",
+    WAVEFORM_PARSE_FAILED = "WAVEFORM_PARSE_FAILED",
+    WAVEFORM_NOT_FOUND = "WAVEFORM_NOT_FOUND",
+    WAVEFORM_INVALID_FORMAT = "WAVEFORM_INVALID_FORMAT"
+}
+/**
+ * 应用错误基类
+ *
+ * 所有自定义错误都继承自这个类。除了标准的 Error 属性外，
+ * 还包含错误码、是否可恢复的标志，以及可选的上下文信息。
+ *
+ * 可恢复的错误意味着程序可以继续运行，比如单个设备连接失败。
+ * 不可恢复的错误通常需要修复后重启，比如配置文件格式错误。
+ */
+export declare class AppError extends Error {
+    /** 错误码，用于程序化处理 */
+    readonly code: ErrorCode;
+    /** 是否可恢复（true 表示可以继续运行，false 表示需要终止） */
+    readonly recoverable: boolean;
+    /** 错误上下文信息，包含相关的调试数据 */
+    readonly context?: Record<string, unknown>;
+    constructor(code: ErrorCode, message: string, options?: {
+        recoverable?: boolean;
+        context?: Record<string, unknown>;
+        cause?: Error;
+    });
+    /**
+     * 格式化错误信息，方便日志输出
+     *
+     * 输出格式包含错误码、消息、上下文和原因，一目了然。
+     */
+    toLogString(): string;
+}
+/**
+ * 配置错误
+ *
+ * 当配置加载或验证失败时使用。这类错误通常是致命的，
+ * 需要用户修复配置文件后重新启动服务器。
+ */
+export declare class ConfigError extends AppError {
+    constructor(message: string, options?: {
+        code?: ErrorCode;
+        context?: Record<string, unknown>;
+        cause?: Error;
+    });
+}
+/**
+ * 连接错误
+ *
+ * 当设备连接、会话管理出现问题时使用。这类错误通常是可恢复的，
+ * 单个连接失败不会影响其他设备的正常使用。
+ */
+export declare class ConnectionError extends AppError {
+    constructor(message: string, options?: {
+        code?: ErrorCode;
+        context?: Record<string, unknown>;
+        cause?: Error;
+    });
+}
+/**
+ * 工具执行错误
+ *
+ * 当 MCP 工具调用失败时使用。这类错误是可恢复的，
+ * 单个工具调用失败不会影响服务器的正常运行。
+ */
+export declare class ToolError extends AppError {
+    constructor(message: string, options?: {
+        code?: ErrorCode;
+        context?: Record<string, unknown>;
+        cause?: Error;
+    });
+}
+/**
+ * WebSocket 错误
+ *
+ * 当 WebSocket 连接或消息处理出现问题时使用。这类错误是可恢复的，
+ * 单个 WebSocket 连接的问题不会影响其他连接。
+ */
+export declare class WebSocketError extends AppError {
+    constructor(message: string, options?: {
+        code?: ErrorCode;
+        context?: Record<string, unknown>;
+        cause?: Error;
+    });
+}
+/**
+ * 波形错误
+ *
+ * 当波形数据解析或存储出现问题时使用。这类错误是可恢复的，
+ * 单个波形处理失败不会影响其他操作。
+ */
+export declare class WaveformError extends AppError {
+    constructor(message: string, options?: {
+        code?: ErrorCode;
+        context?: Record<string, unknown>;
+        cause?: Error;
+    });
+}
+//# sourceMappingURL=errors.d.ts.map

package/dist/errors.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"errors.d.ts","sourceRoot":"","sources":["../src/errors.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;GAYG;AAEH;;;;;GAKG;AACH,oBAAY,SAAS;IAEnB,kBAAkB,uBAAuB;IACzC,mBAAmB,wBAAwB;IAC3C,iBAAiB,sBAAsB;IACvC,mBAAmB,wBAAwB;IAG3C,qBAAqB,0BAA0B;IAC/C,cAAc,mBAAmB;IACjC,mBAAmB,wBAAwB;IAC3C,YAAY,iBAAiB;IAG7B,mBAAmB,wBAAwB;IAC3C,qBAAqB,0BAA0B;IAC/C,cAAc,mBAAmB;IAGjC,oBAAoB,yBAAyB;IAC7C,kBAAkB,uBAAuB;IACzC,oBAAoB,yBAAyB;IAG7C,qBAAqB,0BAA0B;IAC/C,kBAAkB,uBAAuB;IACzC,uBAAuB,4BAA4B;CACpD;AAED;;;;;;;;GAQG;AACH,qBAAa,QAAS,SAAQ,KAAK;IACjC,kBAAkB;IAClB,QAAQ,CAAC,IAAI,EAAE,SAAS,CAAC;IACzB,wCAAwC;IACxC,QAAQ,CAAC,WAAW,EAAE,OAAO,CAAC;IAC9B,wBAAwB;IACxB,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;gBAGzC,IAAI,EAAE,SAAS,EACf,OAAO,EAAE,MAAM,EACf,OAAO,CAAC,EAAE;QACR,WAAW,CAAC,EAAE,OAAO,CAAC;QACtB,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;QAClC,KAAK,CAAC,EAAE,KAAK,CAAC;KACf;IASH;;;;OAIG;IACH,WAAW,IAAI,MAAM;CAUtB;AAED;;;;;GAKG;AACH,qBAAa,WAAY,SAAQ,QAAQ;gBAErC,OAAO,EAAE,MAAM,EACf,OAAO,CAAC,EAAE;QACR,IAAI,CAAC,EAAE,SAAS,CAAC;QACjB,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;QAClC,KAAK,CAAC,EAAE,KAAK,CAAC;KACf;CASJ;AAED;;;;;GAKG;AACH,qBAAa,eAAgB,SAAQ,QAAQ;gBAEzC,OAAO,EAAE,MAAM,EACf,OAAO,CAAC,EAAE;QACR,IAAI,CAAC,EAAE,SAAS,CAAC;QACjB,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;QAClC,KAAK,CAAC,EAAE,KAAK,CAAC;KACf;CASJ;AAED;;;;;GAKG;AACH,qBAAa,SAAU,SAAQ,QAAQ;gBAEnC,OAAO,EAAE,MAAM,EACf,OAAO,CAAC,EAAE;QACR,IAAI,CAAC,EAAE,SAAS,CAAC;QACjB,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;QAClC,KAAK,CAAC,EAAE,KAAK,CAAC;KACf;CASJ;AAED;;;;;GAKG;AACH,qBAAa,cAAe,SAAQ,QAAQ;gBAExC,OAAO,EAAE,MAAM,EACf,OAAO,CAAC,EAAE;QACR,IAAI,CAAC,EAAE,SAAS,CAAC;QACjB,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;QAClC,KAAK,CAAC,EAAE,KAAK,CAAC;KACf;CASJ;AAED;;;;;GAKG;AACH,qBAAa,aAAc,SAAQ,QAAQ;gBAEvC,OAAO,EAAE,MAAM,EACf,OAAO,CAAC,EAAE;QACR,IAAI,CAAC,EAAE,SAAS,CAAC;QACjB,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;QAClC,KAAK,CAAC,EAAE,KAAK,CAAC;KACf;CASJ"}

package/dist/index.d.ts

@@ -0,0 +1,6 @@
+/**
+ * @fileoverview DG-LAB MCP SSE 服务器入口
+ * @description 主入口文件，负责启动应用和处理进程信号
+ */
+export {};
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG"}