@vmosedge/proxy-sdk 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 VMOS Edge
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,115 @@
+# VMOS Edge Proxy SDK
+
+一个用于管理和运行代理服务的 Node.js SDK。支持多协议解析和链式代理请求。
+
+## 特性
+
+- **多协议支持**: 自动解析 VLESS, VMESS, SS, SSR, Trojan, TUIC, Hysteria, Hysteria2, Wireguard, HTTP, SOCKS5 等多种代理 URI。
+- **内置二进制**: 自动识别并运行对应平台的二进制文件（支持 Windows, macOS, Linux）。
+- **链式代理**: 支持将多个代理节点串联成代理链。
+- **一键请求**: 提供简便的 API 直接通过代理发起 HTTP/HTTPS 请求。
+- **状态透明**: 所有异步方法均返回统一的响应格式，明确暴露成功或失败状态。
+- **生命周期管理**: 自动管理工作目录、配置文件并在进程退出时自动清理。
+
+## 安装
+
+```bash
+npm install @vmosedge/proxy-sdk
+```
+
+## 快速开始
+
+### 发起代理请求
+
+可以直接使用代理 URI 发起请求，SDK 会自动启动代理服务并在请求完成后关闭。
+
+```typescript
+import { VMOSEdgeProxy } from '@vmosedge/proxy-sdk';
+
+const proxy = new VMOSEdgeProxy();
+
+async function run() {
+  const vlessNode = 'vless://...';
+  const vmessNode = 'vmess://...';
+
+  // 链式代理示例 (节点1 -> 节点2)
+  const res = await proxy.request(
+    [vlessNode, vmessNode],
+    { url: 'https://api.ipify.org?format=json' },
+    { 'mixed-port': 10086 }
+  );
+
+  if (res.success) {
+    console.log('Your IP Info:', res.data);
+  } else {
+    console.error('Request failed:', res.error);
+  }
+}
+
+run();
+```
+
+### 手动管理代理服务
+
+如果需要持久运行代理服务或手动控制开关。
+
+```typescript
+import { VMOSEdgeProxy } from '@vmosedge/proxy-sdk';
+
+const proxy = new VMOSEdgeProxy();
+
+async function startProxy() {
+  const res = await proxy.start({
+    "mixed-port": 10809,
+    "proxies": [] 
+  });
+
+  if (res.success) {
+    console.log('代理服务已启动，监听端口 10809');
+  } else {
+    console.error('启动失败:', res.error);
+  }
+}
+
+// 停止服务
+// proxy.stop();
+```
+
+## API
+
+### `new VMOSEdgeProxy(config?: ProxyConfig)`
+初始化 SDK。
+- `config.timeout`: 默认启动超时时间（毫秒）。
+- `config.logLevel`: 日志级别 (`debug`, `info`, `warn`, `error`, `none`)。
+
+### `async start(config?: any, timeout?: number): Promise<ProxyResponse>`
+启动代理服务。
+- `config`: 配置文件对象。
+- `timeout`: 启动超时时间（毫秒）。
+
+### `async reload(config?: any): Promise<ProxyResponse>`
+重新加载配置而不停止进程。
+
+### `async request(proxies: (string|any)[], req: AxiosRequestConfig, config?: any): Promise<ProxyResponse>`
+通过代理链发起单次请求。
+- `proxies`: 代理 URI 或配置对象数组。
+- `req`: Axios 请求配置。
+- `config`: 额外的全局配置。
+
+### `stop(): ProxyResponse`
+停止代理服务。
+
+## 响应格式
+
+所有异步方法返回 `ProxyResponse` 对象：
+```typescript
+interface ProxyResponse<T = any> {
+  success: boolean;
+  data?: T;
+  error?: string;
+}
+```
+
+## 许可证
+
+MIT

package/dist/defaultConfig.json

@@ -0,0 +1,27 @@
+{
+  "mixed-port": 7891,
+  "allow-lan": false,
+  "mode": "rule",
+  "log-level": "info",
+  "unified-delay": true,
+  "tcp-concurrent": true,
+  "dns": {
+    "enable": true,
+    "ipv6": false,
+    "proxy-server-nameserver": [
+      "223.5.5.5",
+      "8.8.8.8",
+      "https://dns.alidns.com/dns-query",
+      "https://dns.google/dns-query"
+    ],
+    "nameserver": [
+      "223.5.5.5",
+      "8.8.8.8",
+      "https://dns.alidns.com/dns-query",
+      "https://dns.google/dns-query"
+    ]
+  },
+  "proxies": [],
+  "proxy-groups": [],
+  "rules": []
+}

package/dist/index.d.ts

@@ -0,0 +1,60 @@
+import { ProxyResponse, ProxyConfig } from "./types";
+export * from "./types";
+export * from "./uri-parser/types";
+export { default as parseUri } from "./uri-parser";
+export declare class VMOSEdgeProxy {
+    private process;
+    private binPath;
+    private workingDir;
+    private logLevel;
+    private isStopped;
+    private logsDir;
+    private logRetentionMs;
+    private sessionId;
+    private sessionLogStream;
+    private stdoutLogStream;
+    private stderrLogStream;
+    private instanceId;
+    private startCount;
+    private exitHandler;
+    private sigintHandler;
+    private sigtermHandler;
+    private uncaughtHandler;
+    private rejectionHandler;
+    constructor(config?: ProxyConfig);
+    /** 初始化日志系统 */
+    private initLogging;
+    /** 确保日志流可用（多次 start 时重新打开） */
+    private ensureLogStreams;
+    /** 清理过期的日志会话目录 */
+    private cleanupExpiredLogs;
+    /** 关闭所有日志流 */
+    private closeLogStreams;
+    /** 写入会话日志文件 */
+    private writeLog;
+    /** 记录内存快照到日志 */
+    private logMemorySnapshot;
+    /**
+     * 移除全局事件监听器
+     */
+    private removeEventListeners;
+    private log;
+    /** 将启动配置保存到日志目录 */
+    private saveConfigSnapshot;
+    start(config?: any, timeout?: number): Promise<ProxyResponse>;
+    private startInternal;
+    /** 检查 mihomo 启动输出中的关键字 */
+    private checkStartupOutput;
+    reload(config?: any): Promise<ProxyResponse>;
+    /**
+     * One-shot request: starts proxy, makes request, then stops proxy
+     * If multiple proxies are provided, they will be chained using dialer-proxy
+     */
+    request(proxies: (any | string)[], req: {
+        url: string;
+        timeout?: number;
+    }, config?: any): Promise<ProxyResponse>;
+    /** 仅终止子进程，不做完整 stop（给 start 内部复用） */
+    private killProcess;
+    stop(): ProxyResponse;
+}