@xiuchang-midscene/shared 2.0.2

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

@@ -0,0 +1,91 @@
+import { parseBase64 } from "@xiuchang-midscene/shared/img";
+import { getDebug } from "@xiuchang-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/base-tools.mjs.bak

@@ -0,0 +1,91 @@
+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

@@ -0,0 +1,35 @@
+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/chrome-path.mjs.bak

@@ -0,0 +1,35 @@
+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

@@ -0,0 +1,7 @@
+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/index.mjs.bak

@@ -0,0 +1,7 @@
+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

@@ -0,0 +1,53 @@
+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] @xiuchang-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/inject-report-html-plugin.mjs.bak

@@ -0,0 +1,53 @@
+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

@@ -0,0 +1,52 @@
+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 };

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

@@ -0,0 +1,52 @@
+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 };