@xiuchang-midscene/shared 2.0.2 → 2.0.3

package/dist/es/logger.mjs.bak

@@ -1,64 +0,0 @@
-import node_fs from "node:fs";
-import node_path from "node:path";
-import node_util from "node:util";
-import debug from "debug";
-import { getMidsceneRunSubDir } from "./common.mjs";
-import { ifInNode } from "./utils.mjs";
-const topicPrefix = 'midscene';
-const logStreams = new Map();
-const debugInstances = new Map();
-function getLogStream(topic) {
-    const topicFileName = topic.replace(/:/g, '-');
-    if (!logStreams.has(topicFileName)) {
-        const logFile = node_path.join(getMidsceneRunSubDir('log'), `${topicFileName}.log`);
-        const stream = node_fs.createWriteStream(logFile, {
-            flags: 'a'
-        });
-        logStreams.set(topicFileName, stream);
-    }
-    return logStreams.get(topicFileName);
-}
-function writeLogToFile(topic, message) {
-    if (!ifInNode) return;
-    const stream = getLogStream(topic);
-    const now = new Date();
-    const isoDate = now.toLocaleDateString('sv-SE');
-    const isoTime = now.toLocaleTimeString('sv-SE');
-    const milliseconds = now.getMilliseconds().toString().padStart(3, '0');
-    const timezoneOffsetMinutes = now.getTimezoneOffset();
-    const sign = timezoneOffsetMinutes <= 0 ? '+' : '-';
-    const hours = Math.floor(Math.abs(timezoneOffsetMinutes) / 60).toString().padStart(2, '0');
-    const minutes = (Math.abs(timezoneOffsetMinutes) % 60).toString().padStart(2, '0');
-    const timezoneString = `${sign}${hours}:${minutes}`;
-    const localISOTime = `${isoDate}T${isoTime}.${milliseconds}${timezoneString}`;
-    stream.write(`[${localISOTime}] ${message}\n`);
-}
-function getDebug(topic, options) {
-    const fullTopic = `${topicPrefix}:${topic}`;
-    const withConsole = options?.console ?? false;
-    const cacheKey = withConsole ? `${fullTopic}:withConsole` : fullTopic;
-    if (!debugInstances.has(cacheKey)) if (withConsole) {
-        const baseFn = getDebug(topic);
-        const wrapper = (...args)=>{
-            baseFn(...args);
-            console.warn('[Midscene]', ...args);
-        };
-        debugInstances.set(cacheKey, wrapper);
-    } else {
-        const debugFn = debug(fullTopic);
-        const wrapper = (...args)=>{
-            if (ifInNode) {
-                const message = node_util.format(...args);
-                writeLogToFile(topic, message);
-            }
-            debugFn(...args);
-        };
-        debugInstances.set(cacheKey, wrapper);
-    }
-    return debugInstances.get(cacheKey);
-}
-function enableDebug(topic) {
-    if (ifInNode) return;
-    debug.enable(`${topicPrefix}:${topic}`);
-}
-export { enableDebug, getDebug };

package/dist/es/mcp/base-server.mjs.bak

@@ -1,281 +0,0 @@
-import { randomUUID } from "node:crypto";
-import { setIsMcp } from "@midscene/shared/utils";
-import { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js";
-import { StdioServerTransport } from "@modelcontextprotocol/sdk/server/stdio.js";
-import { StreamableHTTPServerTransport } from "@modelcontextprotocol/sdk/server/streamableHttp.js";
-import express from "express";
-function _define_property(obj, key, value) {
-    if (key in obj) Object.defineProperty(obj, key, {
-        value: value,
-        enumerable: true,
-        configurable: true,
-        writable: true
-    });
-    else obj[key] = value;
-    return obj;
-}
-const CLI_ARGS_CONFIG = {
-    mode: {
-        type: 'string',
-        default: 'stdio'
-    },
-    port: {
-        type: 'string',
-        default: '3000'
-    },
-    host: {
-        type: 'string',
-        default: 'localhost'
-    }
-};
-function launchMCPServer(server, args) {
-    if ('http' === args.mode) return server.launchHttp({
-        port: Number.parseInt(args.port || '3000', 10),
-        host: args.host || 'localhost'
-    });
-    return server.launch();
-}
-const SESSION_TIMEOUT_MS = 1800000;
-const CLEANUP_INTERVAL_MS = 300000;
-const MAX_SESSIONS = 100;
-class BaseMCPServer {
-    async initializeToolsManager() {
-        setIsMcp(true);
-        this.toolsManager = this.providedToolsManager || this.createToolsManager();
-        try {
-            await this.toolsManager.initTools();
-        } catch (error) {
-            const message = error instanceof Error ? error.message : String(error);
-            console.error(`Failed to initialize tools: ${message}`);
-            console.error('Tools will be initialized on first use');
-        }
-        this.toolsManager.attachToServer(this.mcpServer);
-    }
-    async performCleanup() {
-        console.error(`${this.config.name} closing...`);
-        this.mcpServer.close();
-        await this.toolsManager?.destroy?.().catch(console.error);
-    }
-    async launch() {
-        console.log = (...args)=>{
-            console.error('[LOG]', ...args);
-        };
-        console.info = (...args)=>{
-            console.error('[INFO]', ...args);
-        };
-        console.debug = (...args)=>{
-            console.error('[DEBUG]', ...args);
-        };
-        await this.initializeToolsManager();
-        const transport = new StdioServerTransport();
-        try {
-            await this.mcpServer.connect(transport);
-        } catch (error) {
-            const message = error instanceof Error ? error.message : String(error);
-            console.error(`Failed to connect MCP stdio transport: ${message}`);
-            throw new Error(`Failed to initialize MCP stdio transport: ${message}`);
-        }
-        let isShuttingDown = false;
-        const cleanup = ()=>{
-            if (isShuttingDown) return;
-            isShuttingDown = true;
-            console.error(`${this.config.name} shutting down...`);
-            this.performCleanup().finally(()=>process.exit(0));
-        };
-        process.on('uncaughtException', (error)=>{
-            if ('EPIPE' === error.code || 'ERR_STREAM_DESTROYED' === error.code) return void cleanup();
-            console.error(`[${this.config.name}] Uncaught Exception:`, error);
-            console.error('Stack:', error.stack);
-        });
-        process.on('unhandledRejection', (reason)=>{
-            console.error(`[${this.config.name}] Unhandled Rejection:`, reason);
-            if (reason instanceof Error) console.error('Stack:', reason.stack);
-        });
-        process.stdin.on('close', cleanup);
-        process.stdin.on('end', cleanup);
-        process.stdout.on('error', cleanup);
-        process.once('SIGINT', cleanup);
-        process.once('SIGTERM', cleanup);
-        process.once('SIGHUP', cleanup);
-        return {
-            close: async ()=>{
-                this.performCleanup();
-            }
-        };
-    }
-    async launchHttp(options) {
-        if (!Number.isInteger(options.port) || options.port < 1 || options.port > 65535) throw new Error(`Invalid port number: ${options.port}. Port must be between 1 and 65535.`);
-        await this.initializeToolsManager();
-        const app = express();
-        app.use(express.json({
-            limit: '10mb'
-        }));
-        const sessions = new Map();
-        app.all('/mcp', async (req, res)=>{
-            const startTime = Date.now();
-            const requestId = randomUUID().substring(0, 8);
-            try {
-                const rawSessionId = req.headers['mcp-session-id'];
-                const sessionId = Array.isArray(rawSessionId) ? rawSessionId[0] : rawSessionId;
-                let session = sessionId ? sessions.get(sessionId) : void 0;
-                if (!session && 'POST' === req.method) {
-                    if (sessions.size >= MAX_SESSIONS) {
-                        console.error(`[${new Date().toISOString()}] [${requestId}] Session limit reached: ${sessions.size}/${MAX_SESSIONS}`);
-                        res.status(503).json({
-                            error: 'Too many active sessions',
-                            message: 'Server is at maximum capacity. Please try again later.'
-                        });
-                        return;
-                    }
-                    session = await this.createHttpSession(sessions);
-                    console.log(`[${new Date().toISOString()}] [${requestId}] New session created: ${session.transport.sessionId}`);
-                }
-                if (session) {
-                    session.lastAccessedAt = new Date();
-                    await session.transport.handleRequest(req, res, req.body);
-                    const duration = Date.now() - startTime;
-                    console.log(`[${new Date().toISOString()}] [${requestId}] Request completed in ${duration}ms`);
-                } else {
-                    console.error(`[${new Date().toISOString()}] [${requestId}] Invalid session or GET without session`);
-                    res.status(400).json({
-                        error: 'Invalid session or GET without session'
-                    });
-                }
-            } catch (error) {
-                const message = error instanceof Error ? error.message : String(error);
-                const duration = Date.now() - startTime;
-                console.error(`[${new Date().toISOString()}] [${requestId}] MCP request error after ${duration}ms: ${message}`);
-                if (!res.headersSent) res.status(500).json({
-                    error: 'Internal server error',
-                    message: 'Failed to process MCP request'
-                });
-            }
-        });
-        const host = options.host || 'localhost';
-        const server = app.listen(options.port, host, ()=>{
-            console.log(`${this.config.name} HTTP server listening on http://${host}:${options.port}/mcp`);
-        }).on('error', (error)=>{
-            if ('EADDRINUSE' === error.code) console.error(`ERROR: Port ${options.port} is already in use.\nPlease try a different port: --port=<number>\nExample: --mode=http --port=${options.port + 1}`);
-            else if ('EACCES' === error.code) console.error(`ERROR: Permission denied to bind to port ${options.port}.\nPorts below 1024 require root/admin privileges.\nPlease use a port above 1024 or run with elevated privileges.`);
-            else console.error(`ERROR: Failed to start HTTP server on ${host}:${options.port}\nReason: ${error.message}\nCode: ${error.code || 'unknown'}`);
-            process.exit(1);
-        });
-        const cleanupInterval = this.startSessionCleanup(sessions);
-        this.setupHttpShutdownHandlers(server, sessions, cleanupInterval);
-        return {
-            port: options.port,
-            host,
-            close: async ()=>{
-                clearInterval(cleanupInterval);
-                for (const session of sessions.values())try {
-                    await session.transport.close();
-                } catch (error) {
-                    const message = error instanceof Error ? error.message : String(error);
-                    console.error(`Failed to close session ${session.transport.sessionId}: ${message}`);
-                }
-                sessions.clear();
-                return new Promise((resolve)=>{
-                    server.close(async (err)=>{
-                        if (err) console.error('Error closing HTTP server:', err);
-                        await this.performCleanup();
-                        resolve();
-                    });
-                });
-            }
-        };
-    }
-    async createHttpSession(sessions) {
-        const transport = new StreamableHTTPServerTransport({
-            sessionIdGenerator: ()=>randomUUID(),
-            onsessioninitialized: (sid)=>{
-                sessions.set(sid, {
-                    transport,
-                    createdAt: new Date(),
-                    lastAccessedAt: new Date()
-                });
-                console.log(`[${new Date().toISOString()}] Session ${sid} initialized (total: ${sessions.size})`);
-            }
-        });
-        transport.onclose = ()=>{
-            if (transport.sessionId) {
-                sessions.delete(transport.sessionId);
-                console.log(`[${new Date().toISOString()}] Session ${transport.sessionId} closed (remaining: ${sessions.size})`);
-            }
-        };
-        try {
-            await this.mcpServer.connect(transport);
-        } catch (error) {
-            const message = error instanceof Error ? error.message : String(error);
-            console.error(`[${new Date().toISOString()}] Failed to connect MCP transport: ${message}`);
-            if (transport.sessionId) sessions.delete(transport.sessionId);
-            throw new Error(`Failed to initialize MCP session: ${message}`);
-        }
-        return {
-            transport,
-            createdAt: new Date(),
-            lastAccessedAt: new Date()
-        };
-    }
-    startSessionCleanup(sessions) {
-        return setInterval(()=>{
-            const now = Date.now();
-            for (const [sid, session] of sessions)if (now - session.lastAccessedAt.getTime() > SESSION_TIMEOUT_MS) try {
-                session.transport.close();
-                sessions.delete(sid);
-                console.log(`[${new Date().toISOString()}] Session ${sid} cleaned up due to inactivity (remaining: ${sessions.size})`);
-            } catch (error) {
-                const message = error instanceof Error ? error.message : String(error);
-                console.error(`[${new Date().toISOString()}] Failed to close session ${sid} during cleanup: ${message}`);
-                sessions.delete(sid);
-            }
-        }, CLEANUP_INTERVAL_MS);
-    }
-    setupHttpShutdownHandlers(server, sessions, cleanupInterval) {
-        const cleanup = ()=>{
-            console.error(`${this.config.name} shutting down...`);
-            clearInterval(cleanupInterval);
-            for (const session of sessions.values())try {
-                session.transport.close();
-            } catch (error) {
-                const message = error instanceof Error ? error.message : String(error);
-                console.error(`Error closing session during shutdown: ${message}`);
-            }
-            sessions.clear();
-            try {
-                server.close(()=>{
-                    this.performCleanup().finally(()=>process.exit(0));
-                });
-                setTimeout(()=>{
-                    console.error('Forcefully shutting down after timeout');
-                    this.performCleanup().finally(()=>process.exit(1));
-                }, 5000);
-            } catch (error) {
-                const message = error instanceof Error ? error.message : String(error);
-                console.error(`Error closing HTTP server: ${message}`);
-                this.performCleanup().finally(()=>process.exit(1));
-            }
-        };
-        process.once('SIGINT', cleanup);
-        process.once('SIGTERM', cleanup);
-    }
-    getServer() {
-        return this.mcpServer;
-    }
-    getToolsManager() {
-        return this.toolsManager;
-    }
-    constructor(config, toolsManager){
-        _define_property(this, "mcpServer", void 0);
-        _define_property(this, "toolsManager", void 0);
-        _define_property(this, "config", void 0);
-        _define_property(this, "providedToolsManager", void 0);
-        this.config = config;
-        this.mcpServer = new McpServer({
-            name: config.name,
-            version: config.version,
-            description: config.description
-        });
-        this.providedToolsManager = toolsManager;
-    }
-}
-export { BaseMCPServer, CLI_ARGS_CONFIG, launchMCPServer };

package/dist/es/mcp/base-tools.mjs.bak

@@ -1,91 +0,0 @@
-import { parseBase64 } from "@midscene/shared/img";
-import { getDebug } from "@midscene/shared/logger";
-import { generateCommonTools, generateToolsFromActionSpace } from "./tool-generator.mjs";
-function _define_property(obj, key, value) {
-    if (key in obj) Object.defineProperty(obj, key, {
-        value: value,
-        enumerable: true,
-        configurable: true,
-        writable: true
-    });
-    else obj[key] = value;
-    return obj;
-}
-const debug = getDebug('mcp:base-tools');
-class BaseMidsceneTools {
-    preparePlatformTools() {
-        return [];
-    }
-    async initTools() {
-        this.toolDefinitions = [];
-        const platformTools = this.preparePlatformTools();
-        this.toolDefinitions.push(...platformTools);
-        let actionSpace;
-        if (this.agent) {
-            actionSpace = await this.agent.getActionSpace();
-            debug('Action space from agent:', actionSpace.map((a)=>a.name).join(', '));
-        } else {
-            const tempDevice = this.createTemporaryDevice();
-            actionSpace = tempDevice.actionSpace();
-            await tempDevice.destroy?.();
-            debug('Action space from temporary device:', actionSpace.map((a)=>a.name).join(', '));
-        }
-        const actionTools = generateToolsFromActionSpace(actionSpace, ()=>this.ensureAgent());
-        const commonTools = generateCommonTools(()=>this.ensureAgent());
-        this.toolDefinitions.push(...actionTools, ...commonTools);
-        debug('Total tools prepared:', this.toolDefinitions.length);
-    }
-    attachToServer(server) {
-        this.mcpServer = server;
-        if (0 === this.toolDefinitions.length) debug('Warning: No tools to register. Tools may be initialized lazily.');
-        for (const toolDef of this.toolDefinitions)this.mcpServer.tool(toolDef.name, toolDef.description, toolDef.schema, toolDef.handler);
-        debug('Registered', this.toolDefinitions.length, 'tools');
-    }
-    async destroy() {
-        await this.agent?.destroy?.();
-    }
-    getToolDefinitions() {
-        return this.toolDefinitions;
-    }
-    setAgent(agent) {
-        this.agent = agent;
-    }
-    buildScreenshotContent(screenshot) {
-        const { mimeType, body } = parseBase64(screenshot);
-        return [
-            {
-                type: 'image',
-                data: body,
-                mimeType
-            }
-        ];
-    }
-    buildTextResult(text) {
-        return {
-            content: [
-                {
-                    type: 'text',
-                    text
-                }
-            ]
-        };
-    }
-    createDisconnectHandler(platformName) {
-        return async ()=>{
-            if (!this.agent) return this.buildTextResult('No active connection to disconnect');
-            try {
-                await this.agent.destroy?.();
-            } catch (error) {
-                debug('Failed to destroy agent during disconnect:', error);
-            }
-            this.agent = void 0;
-            return this.buildTextResult(`Disconnected from ${platformName}`);
-        };
-    }
-    constructor(){
-        _define_property(this, "mcpServer", void 0);
-        _define_property(this, "agent", void 0);
-        _define_property(this, "toolDefinitions", []);
-    }
-}
-export { BaseMidsceneTools };

package/dist/es/mcp/chrome-path.mjs.bak

@@ -1,35 +0,0 @@
-import { existsSync } from "node:fs";
-import { MIDSCENE_MCP_CHROME_PATH, globalConfigManager } from "../env/index.mjs";
-function getSystemChromePath() {
-    const platform = process.platform;
-    const chromePaths = {
-        darwin: [
-            '/Applications/Google Chrome.app/Contents/MacOS/Google Chrome',
-            '/Applications/Chromium.app/Contents/MacOS/Chromium'
-        ],
-        win32: [
-            'C:\\Program Files\\Google\\Chrome\\Application\\chrome.exe',
-            'C:\\Program Files (x86)\\Google\\Chrome\\Application\\chrome.exe',
-            `C:\\Users\\${process.env.USERNAME ?? process.env.USER}\\AppData\\Local\\Google\\Chrome\\Application\\chrome.exe`
-        ],
-        linux: [
-            '/opt/google/chrome/chrome',
-            '/opt/google/chrome/google-chrome',
-            '/usr/bin/google-chrome-stable',
-            '/usr/bin/google-chrome',
-            '/usr/bin/chromium-browser',
-            '/usr/bin/chromium',
-            '/snap/bin/chromium'
-        ]
-    };
-    const paths = chromePaths[platform] ?? [];
-    return paths.find((p)=>existsSync(p));
-}
-function resolveChromePath() {
-    const envPath = globalConfigManager.getEnvConfigValue(MIDSCENE_MCP_CHROME_PATH);
-    if (envPath && 'auto' !== envPath && existsSync(envPath)) return envPath;
-    const systemPath = getSystemChromePath();
-    if (systemPath) return systemPath;
-    throw new Error('Chrome not found. Install Google Chrome or set MIDSCENE_MCP_CHROME_PATH environment variable.');
-}
-export { getSystemChromePath, resolveChromePath };

package/dist/es/mcp/index.mjs.bak

@@ -1,7 +0,0 @@
-export * from "./base-server.mjs";
-export * from "./base-tools.mjs";
-export * from "./tool-generator.mjs";
-export * from "./types.mjs";
-export * from "./inject-report-html-plugin.mjs";
-export * from "./launcher-helper.mjs";
-export * from "./chrome-path.mjs";

package/dist/es/mcp/inject-report-html-plugin.mjs.bak

@@ -1,53 +0,0 @@
-import node_fs from "node:fs";
-import node_path from "node:path";
-const MAGIC_STRING = 'REPLACE_ME_WITH_REPORT_HTML';
-const REPLACED_MARK = '/*REPORT_HTML_REPLACED*/';
-const REG_EXP_FOR_REPLACE = /\/\*REPORT_HTML_REPLACED\*\/.*/;
-function injectReportHtmlFromCore(packageDir) {
-    return {
-        name: 'inject-report-html-from-core',
-        setup (api) {
-            api.onAfterBuild(()=>{
-                const coreUtilsPath = node_path.resolve(packageDir, '..', 'core', 'dist', 'lib', 'utils.js');
-                if (!node_fs.existsSync(coreUtilsPath)) return void console.warn('[inject-report-html] @midscene/core dist not found, skipping');
-                const coreContent = node_fs.readFileSync(coreUtilsPath, 'utf-8');
-                if (!coreContent.includes(REPLACED_MARK)) return void console.warn('[inject-report-html] HTML not found in core dist. Ensure report builds first.');
-                const markerIndex = coreContent.indexOf(REPLACED_MARK);
-                const jsonStart = markerIndex + REPLACED_MARK.length;
-                let jsonEnd = jsonStart;
-                if ('"' === coreContent[jsonStart]) {
-                    jsonEnd = jsonStart + 1;
-                    while(jsonEnd < coreContent.length)if ('\\' === coreContent[jsonEnd]) jsonEnd += 2;
-                    else if ('"' === coreContent[jsonEnd]) {
-                        jsonEnd += 1;
-                        break;
-                    } else jsonEnd += 1;
-                }
-                const jsonString = coreContent.slice(jsonStart, jsonEnd);
-                if (!jsonString || jsonString.length < 10) return void console.warn('[inject-report-html] Failed to extract HTML from core');
-                const finalContent = `${REPLACED_MARK}${jsonString}`;
-                const distDir = node_path.join(packageDir, 'dist');
-                if (!node_fs.existsSync(distDir)) return;
-                const jsFiles = node_fs.readdirSync(distDir).filter((f)=>f.endsWith('.js'));
-                let injectedCount = 0;
-                for (const file of jsFiles){
-                    const filePath = node_path.join(distDir, file);
-                    const content = node_fs.readFileSync(filePath, 'utf-8');
-                    if (content.includes(REPLACED_MARK)) {
-                        if (REG_EXP_FOR_REPLACE.test(content)) {
-                            node_fs.writeFileSync(filePath, content.replace(REG_EXP_FOR_REPLACE, ()=>finalContent));
-                            console.log(`[inject-report-html] Updated: ${file}`);
-                            injectedCount++;
-                        }
-                    } else if (content.includes(`'${MAGIC_STRING}'`)) {
-                        node_fs.writeFileSync(filePath, content.replace(`'${MAGIC_STRING}'`, ()=>finalContent));
-                        console.log(`[inject-report-html] Injected: ${file}`);
-                        injectedCount++;
-                    }
-                }
-                if (injectedCount > 0) console.log(`[inject-report-html] Completed: ${injectedCount} file(s)`);
-            });
-        }
-    };
-}
-export { injectReportHtmlFromCore };

package/dist/es/mcp/launcher-helper.mjs.bak

@@ -1,52 +0,0 @@
-function createMCPServerLauncher(config) {
-    const { agent, platformName, ToolsManagerClass, MCPServerClass } = config;
-    function validateAgent() {
-        const device = agent.interface;
-        if (!device) throw new Error(`Agent must have an 'interface' property that references the underlying device.
-Please ensure your agent instance is properly initialized with a device interface.
-Expected: agent.interface to be defined, but got: ${typeof device}
-Solution: Check that your agent constructor properly sets the interface property.`);
-    }
-    function createToolsManager() {
-        const toolsManager = new ToolsManagerClass();
-        toolsManager.agent = agent;
-        return toolsManager;
-    }
-    function logStartupInfo(mode, additionalInfo) {
-        const device = agent.interface;
-        console.log(`Starting Midscene ${platformName} MCP Server (${mode})...`);
-        console.log(`Agent: ${agent.constructor.name}`);
-        console.log(`Device: ${device.constructor.name}`);
-        if (additionalInfo?.port !== void 0) console.log(`Port: ${additionalInfo.port}`);
-        if (additionalInfo?.host) console.log(`Host: ${additionalInfo.host}`);
-    }
-    return {
-        async launch (options = {}) {
-            const { verbose = true } = options;
-            validateAgent();
-            if (verbose) logStartupInfo('stdio');
-            const toolsManager = createToolsManager();
-            const server = new MCPServerClass(toolsManager);
-            const result = await server.launch();
-            if (verbose) console.log(`${platformName} MCP Server started (stdio mode)`);
-            return result;
-        },
-        async launchHttp (options) {
-            const { port, host = 'localhost', verbose = true } = options;
-            validateAgent();
-            if (verbose) logStartupInfo('HTTP', {
-                port,
-                host
-            });
-            const toolsManager = createToolsManager();
-            const server = new MCPServerClass(toolsManager);
-            const result = await server.launchHttp({
-                port,
-                host
-            });
-            if (verbose) console.log(`${platformName} MCP Server started on http://${result.host}:${result.port}/mcp`);
-            return result;
-        }
-    };
-}
-export { createMCPServerLauncher };