@mearl/client 2.22.0 → 2.22.2

package/dist/script.d.ts

@@ -0,0 +1,30 @@
+import { type UnifiedInvokeOptions } from './unified.js';
+export interface ScriptExecutionOptions extends UnifiedInvokeOptions {
+    serverUrl?: string;
+    /** Overall deadline, independent of individual action timeouts. Default: 60 seconds. */
+    executionTimeoutSec?: number;
+    /** Combined stdout/stderr limit in bytes. Default: 256 KiB; maximum: 1 MiB. */
+    maxOutputBytes?: number;
+    signal?: AbortSignal;
+    source?: 'cli' | 'mcp' | 'sdk';
+}
+export interface ScriptExecutionResult {
+    success: boolean;
+    stdout: string;
+    stderr: string;
+    session?: Record<string, unknown>;
+    error?: {
+        code: string;
+        message: string;
+        stack?: string;
+        details?: unknown;
+        stage?: string;
+        attempt?: unknown;
+    };
+    executionStopped: boolean;
+    /** Dispatched browser/plugin calls can finish after the script has stopped. */
+    mayHaveLateEffects: boolean;
+    pendingActions: string[];
+}
+/** Runs trusted agent code in a short-lived Node process, with one shared SDK client. */
+export declare function executeScript(code: string, options?: ScriptExecutionOptions): Promise<ScriptExecutionResult>;

package/dist/script.js

@@ -0,0 +1,260 @@
+import { spawn } from 'node:child_process';
+import { isBrowserCommandAction } from './generated/browser-action-protocol.js';
+import { exportArtifact } from './artifacts.js';
+import { UnifiedClient } from './unified.js';
+import { loadCloudServerConfig } from './unifiedConfig.js';
+import { stopPluginProcessTree } from './plugins/runtime/pluginProcessTree.js';
+import { SCRIPT_WORKER_PATH } from './runtimePaths.js';
+import { SDK_METHOD_ACTIONS as METHOD_ACTIONS, SDK_OPTIONS_ONLY_METHODS as OPTIONS_ONLY, } from './sdkMethods.js';
+import { getCommandHelp } from './commandHelp.js';
+import { executeRegisteredPlugin } from './plugins/runtime/pluginExecutor.js';
+import { findPluginRegistration } from './plugins/pluginRegistry.js';
+import { findOfficialPlugin } from './plugins/officialPluginCatalog.js';
+import { ensureOfficialPluginRegistered } from './plugins/officialPluginInstaller.js';
+import { serializeScriptError as serializeError } from './scriptErrors.js';
+const METHODS = [...METHOD_ACTIONS.keys(), 'invoke', 'invokePlugin', 'saveArtifact', 'help'];
+const MAX_SCRIPT_BYTES = 1024 * 1024;
+/** Runs trusted agent code in a short-lived Node process, with one shared SDK client. */
+export async function executeScript(code, options = {}) {
+    if (typeof code !== 'string' || !code.trim() || Buffer.byteLength(code) > MAX_SCRIPT_BYTES)
+        throw new Error('Script must be non-empty JavaScript of at most 1 MiB');
+    const { serverUrl, executionTimeoutSec = 60, maxOutputBytes = 256 * 1024, signal, source = 'sdk', ...defaults } = options;
+    if (!Number.isFinite(executionTimeoutSec) ||
+        executionTimeoutSec <= 0 ||
+        executionTimeoutSec * 1000 > 2_147_483_647)
+        throw new Error('executionTimeoutSec must be positive and within the timer range');
+    if (!Number.isSafeInteger(maxOutputBytes) || maxOutputBytes < 1 || maxOutputBytes > 1024 * 1024)
+        throw new Error('maxOutputBytes must be an integer between 1 and 1048576');
+    const client = new UnifiedClient({
+        serverUrl: serverUrl ?? process.env.MEARL_SERVER_URL ?? loadCloudServerConfig()?.server,
+    });
+    let session = defaults.session && defaults.session !== 'new' ? { sessionId: defaults.session } : undefined;
+    let sessionId = defaults.session;
+    let uncertainEffects = false;
+    const pending = new Map();
+    const controller = new AbortController();
+    const invoke = async (action, payload, overrides = {}) => {
+        controller.signal.throwIfAborted();
+        const result = await client.invoke(action, payload, {
+            ...defaults,
+            session: sessionId,
+            ...overrides,
+        });
+        if (result?.action?.stage === 'dispatch-uncertain' || result?.stage === 'dispatch-uncertain')
+            uncertainEffects = true;
+        if (result?.session?.sessionId &&
+            (!overrides.session || overrides.session === 'new' || overrides.session === sessionId)) {
+            session = result.session;
+            if (!overrides.session || overrides.session === 'new')
+                sessionId = result.session.sessionId;
+        }
+        return result;
+    };
+    try {
+        return await new Promise((resolve, reject) => {
+            if (signal?.aborted) {
+                resolve({
+                    success: false,
+                    stdout: '',
+                    stderr: '',
+                    ...(session ? { session } : {}),
+                    error: { code: 'SCRIPT_CANCELLED', message: 'Script execution cancelled' },
+                    executionStopped: true,
+                    mayHaveLateEffects: false,
+                    pendingActions: [],
+                });
+                return;
+            }
+            const child = spawn(process.execPath, [SCRIPT_WORKER_PATH], {
+                stdio: ['ignore', 'pipe', 'pipe', 'ipc'],
+                serialization: 'advanced',
+                detached: process.platform !== 'win32',
+            });
+            const output = { stdout: [], stderr: [] };
+            let outputBytes = 0;
+            let outcome;
+            let cleanup;
+            let cleanupError;
+            let pendingActions = [];
+            let closed = false;
+            const pluginCalls = new Set();
+            const stop = (error) => {
+                if (outcome !== undefined || closed)
+                    return;
+                outcome = error ?? true;
+                pendingActions = [...pending.values()];
+                controller.abort();
+                client.disconnect();
+                if (child.pid) {
+                    cleanup = stopPluginProcessTree(child.pid).catch(error => {
+                        cleanupError = error;
+                        child.kill('SIGKILL');
+                    });
+                }
+            };
+            const abort = () => stop({ code: 'SCRIPT_CANCELLED', message: 'Script execution cancelled' });
+            const deadline = setTimeout(() => stop({ code: 'SCRIPT_TIMEOUT', message: 'Script execution deadline exceeded' }), executionTimeoutSec * 1000);
+            signal?.addEventListener('abort', abort, { once: true });
+            if (signal?.aborted)
+                abort();
+            const appendOutput = (stream, chunk) => {
+                const remaining = maxOutputBytes - outputBytes;
+                output[stream].push(chunk.subarray(0, Math.max(0, remaining)));
+                outputBytes += Math.min(chunk.length, Math.max(0, remaining));
+                if (chunk.length > remaining)
+                    stop({
+                        code: 'SCRIPT_OUTPUT_LIMIT',
+                        message: `Script output exceeded ${maxOutputBytes} bytes`,
+                    });
+            };
+            for (const stream of ['stdout', 'stderr']) {
+                child[stream].on('data', (chunk) => appendOutput(stream, chunk));
+            }
+            const runPlugin = async (name, invocation, overrides = {}, help) => {
+                if (!findPluginRegistration(name) && findOfficialPlugin(name))
+                    await ensureOfficialPluginRegistered(name);
+                controller.signal.throwIfAborted();
+                const pluginOptions = { ...defaults, session: sessionId, ...overrides };
+                if (pluginOptions.session === 'new' && !help)
+                    throw new Error('Create the control session with a browser action before calling a Skill command');
+                const operation = executeRegisteredPlugin(name, invocation, {
+                    invoke: (action, payload = {}, options) => invoke(action, payload, options),
+                }, {
+                    ...pluginOptions,
+                    source,
+                    signal: controller.signal,
+                    cancellationGraceMs: 50,
+                    onOutput: appendOutput,
+                    ...(help ? { help } : {}),
+                });
+                pluginCalls.add(operation);
+                try {
+                    return await operation;
+                }
+                finally {
+                    pluginCalls.delete(operation);
+                }
+            };
+            const send = (message) => {
+                if (outcome !== undefined || !child.connected)
+                    return;
+                child.send(message, error => {
+                    if (error)
+                        stop(serializeError(error));
+                });
+            };
+            child.on('message', (message) => {
+                if (outcome !== undefined || !message || typeof message !== 'object')
+                    return;
+                if (message.type === 'done' || message.type === 'error') {
+                    stop(message.type === 'error'
+                        ? serializeError(message.error)
+                        : pending.size
+                            ? {
+                                code: 'SCRIPT_PENDING_CALLS',
+                                message: 'Script finished with unawaited SDK calls',
+                            }
+                            : undefined);
+                    return;
+                }
+                if (message.type !== 'call')
+                    return;
+                const { id, method, args } = message;
+                if (!Number.isSafeInteger(id) ||
+                    pending.has(id) ||
+                    !METHODS.includes(method) ||
+                    !Array.isArray(args)) {
+                    stop({ code: 'SCRIPT_PROTOCOL_ERROR', message: 'Invalid script SDK call' });
+                    return;
+                }
+                if (method !== 'help' && sessionId === 'new' && pending.size) {
+                    send({
+                        type: 'response',
+                        id,
+                        error: {
+                            code: 'SCRIPT_SESSION_INITIALIZING',
+                            message: 'Await the first session call before starting concurrent calls',
+                        },
+                    });
+                    return;
+                }
+                pending.set(id, method === 'invoke' || method === 'invokePlugin' ? String(args[0]) : method);
+                void Promise.resolve()
+                    .then(async () => {
+                    if (outcome !== undefined)
+                        throw new Error('Script execution stopped');
+                    if (method === 'help') {
+                        const target = args[0];
+                        if (target && typeof target === 'object') {
+                            if (typeof target.plugin !== 'string' ||
+                                !target.plugin.trim() ||
+                                (target.command !== undefined && typeof target.command !== 'string'))
+                                throw new Error('Plugin help requires { plugin, command? }');
+                            return runPlugin(target.plugin, { command: '', input: {} }, {}, { namespace: `mearl ${target.plugin}`, command: target.command });
+                        }
+                        return getCommandHelp(target);
+                    }
+                    if (method === 'invoke') {
+                        if (!isBrowserCommandAction(args[0]) && args[0] !== 'browser_select_browser')
+                            throw new Error(`Unsupported browser action: ${args[0]}; use invokePlugin for registered Skill commands`);
+                        return invoke(args[0], args[1] ?? {}, args[2]);
+                    }
+                    if (method === 'invokePlugin') {
+                        return runPlugin(args[0], args[1], args[2]);
+                    }
+                    if (method === 'saveArtifact')
+                        return exportArtifact({ invoke }, args[0], args[1], {
+                            ...defaults,
+                            session: sessionId,
+                            ...args[2],
+                        });
+                    const optionsOnly = OPTIONS_ONLY.has(method) || (method === 'browserRelease' && args.length < 2);
+                    return invoke(METHOD_ACTIONS.get(method), optionsOnly ? {} : (args[0] ?? {}), optionsOnly ? args[0] : args[1]);
+                })
+                    .then(result => send({ type: 'response', id, result, session }), error => send({ type: 'response', id, error: serializeError(error), session }))
+                    .finally(() => pending.delete(id));
+            });
+            child.once('error', error => {
+                stop(serializeError(error));
+            });
+            child.once('exit', () => {
+                if (outcome === undefined)
+                    stop({
+                        code: 'SCRIPT_EXITED',
+                        message: 'Script process exited before reporting completion',
+                    });
+            });
+            child.once('close', () => {
+                closed = true;
+                clearTimeout(deadline);
+                signal?.removeEventListener('abort', abort);
+                void Promise.allSettled([cleanup, ...pluginCalls])
+                    .then(outcomes => {
+                    if (outcomes.some(result => result.status === 'rejected' &&
+                        result.reason?.code === 'PLUGIN_EXECUTOR_CLEANUP_FAILED'))
+                        cleanupError = new Error('Unable to confirm Skill process cleanup');
+                    const error = cleanupError
+                        ? serializeError(cleanupError, 'SCRIPT_CLEANUP_FAILED')
+                        : outcome === true
+                            ? undefined
+                            : outcome;
+                    resolve({
+                        success: !error && outcome === true,
+                        stdout: Buffer.concat(output.stdout).toString('utf8'),
+                        stderr: Buffer.concat(output.stderr).toString('utf8'),
+                        ...(session ? { session } : {}),
+                        ...(error ? { error } : {}),
+                        executionStopped: !cleanupError,
+                        mayHaveLateEffects: pendingActions.length > 0 || uncertainEffects,
+                        pendingActions,
+                    });
+                })
+                    .catch(reject);
+            });
+            send({ type: 'start', code, methods: METHODS, session });
+        });
+    }
+    finally {
+        client.disconnect();
+    }
+}

package/dist/scriptCli.d.ts

@@ -0,0 +1 @@
+export declare function runScriptCli(args: string[], commandName: string): Promise<number>;

package/dist/scriptCli.js

@@ -0,0 +1,94 @@
+import { readFile } from 'node:fs/promises';
+import { resolve } from 'node:path';
+import { Command } from 'commander';
+import { executeScript } from './script.js';
+export async function runScriptCli(args, commandName) {
+    const program = new Command()
+        .name(`${commandName} run`)
+        .description('执行 Node.js 脚本；预注入 mearl SDK，支持顶层 await、条件和循环')
+        .option('--file <path>', '读取 JavaScript 文件；省略时从 stdin 读取')
+        .option('--session <new-or-id>', '首次建立或复用控制会话')
+        .option('--browser <id-or-name>', '指定浏览器')
+        .option('--connector <id-or-name>', '限制到远端 connector')
+        .option('--local', '仅使用本机浏览器')
+        .option('--cdp', '强制本机 CDP')
+        .option('--server <url>', '覆盖 cloud-server 地址')
+        .option('--timeout <seconds>', '整个脚本的执行时限（默认 60 秒）', '60')
+        .allowExcessArguments(false)
+        .exitOverride()
+        .addHelpText('after', `\n示例：\n  ${commandName} run --file task.mjs\n  ${commandName} run <<'JS'\n  console.log(await mearl.tabList());\n  JS\n\n脚本拥有当前宿主的 Node.js 权限；使用 await import() 加载模块。\n调用 Skill 命令：await mearl.invokePlugin('yuque', { command: 'read', input: { url: '...' } })。\n用 console.log(await mearl.help('pageClick')) 查询共享帮助，mearl.structure(value) 查看结果结构。\n每次运行重建 JS 变量；复用 session 和 tabId 可继续同一浏览器任务。\n`);
+    let source;
+    let options;
+    try {
+        program.parse(args, { from: 'user' });
+        options = program.opts();
+        const timeout = Number(options.timeout);
+        if (!Number.isFinite(timeout) || timeout <= 0 || timeout * 1000 > 2_147_483_647)
+            throw new Error('--timeout 必须是有效范围内的大于 0 的秒数');
+        if ((options.local || options.cdp) && options.connector)
+            throw new Error('--local/--cdp 不能与 --connector 同时使用');
+        if (options.file)
+            source = await readFile(resolve(options.file), 'utf8');
+        else {
+            if (process.stdin.isTTY)
+                throw new Error('通过 stdin 提交脚本，或使用 --file <path>');
+            const chunks = [];
+            let size = 0;
+            for await (const chunk of process.stdin) {
+                const buffer = Buffer.from(chunk);
+                size += buffer.length;
+                if (size > 1024 * 1024)
+                    throw new Error('脚本不能超过 1 MiB');
+                chunks.push(buffer);
+            }
+            source = Buffer.concat(chunks).toString('utf8');
+        }
+        if (!source.trim() || Buffer.byteLength(source) > 1024 * 1024)
+            throw new Error('脚本必须是非空且不超过 1 MiB 的 JavaScript');
+    }
+    catch (error) {
+        if (error.code === 'commander.helpDisplayed')
+            return 0;
+        console.error(error instanceof Error ? error.message : String(error));
+        return 2;
+    }
+    const controller = new AbortController();
+    const abort = () => controller.abort();
+    process.once('SIGINT', abort);
+    process.once('SIGTERM', abort);
+    try {
+        const result = await executeScript(source, {
+            executionTimeoutSec: Number(options.timeout),
+            signal: controller.signal,
+            source: 'cli',
+            ...(options.session ? { session: options.session } : {}),
+            ...(options.browser ? { browser: options.browser } : {}),
+            ...(options.connector ? { connector: options.connector } : {}),
+            ...(options.local || options.cdp ? { local: true } : {}),
+            ...(options.cdp ? { transport: 'cdp' } : {}),
+            ...(options.server ? { serverUrl: options.server } : {}),
+        });
+        if (result.stdout)
+            process.stdout.write(result.stdout);
+        if (result.stderr)
+            process.stderr.write(result.stderr);
+        if (result.session)
+            console.error(JSON.stringify({ session: result.session }));
+        if (!result.success)
+            console.error(JSON.stringify({
+                error: result.error,
+                executionStopped: result.executionStopped,
+                mayHaveLateEffects: result.mayHaveLateEffects,
+                pendingActions: result.pendingActions,
+            }));
+        return result.success ? 0 : 1;
+    }
+    catch (error) {
+        console.error(error instanceof Error ? error.message : String(error));
+        return 1;
+    }
+    finally {
+        process.removeListener('SIGINT', abort);
+        process.removeListener('SIGTERM', abort);
+    }
+}

package/dist/scriptErrors.d.ts

@@ -0,0 +1,8 @@
+export declare function serializeScriptError(error: unknown, fallback?: string): {
+    stack?: string | undefined;
+    attempt?: {} | null | undefined;
+    stage?: string | undefined;
+    details?: Record<string, unknown> | undefined;
+    code: string;
+    message: string;
+};

package/dist/scriptErrors.js

@@ -0,0 +1,21 @@
+import { serializePluginExecutionError } from './plugins/runtime/pluginExecutorProtocol.js';
+export function serializeScriptError(error, fallback = 'SCRIPT_ERROR') {
+    const value = error;
+    const diagnostic = serializePluginExecutionError({
+        message: typeof value?.message === 'string' ? value.message : String(error),
+        code: typeof value?.code === 'string' ? value.code : fallback,
+        details: {
+            ...value?.details,
+            ...(value?.attempt !== undefined ? { attempt: value.attempt } : {}),
+        },
+        ...(typeof value?.stage === 'string' ? { stage: value.stage } : {}),
+    });
+    return {
+        code: diagnostic.code ?? fallback,
+        message: diagnostic.message,
+        ...(diagnostic.details ? { details: diagnostic.details } : {}),
+        ...(typeof diagnostic.metadata?.stage === 'string' ? { stage: diagnostic.metadata.stage } : {}),
+        ...(diagnostic.details?.attempt !== undefined ? { attempt: diagnostic.details.attempt } : {}),
+        ...(typeof value?.stack === 'string' ? { stack: value.stack.slice(0, 16384) } : {}),
+    };
+}

package/dist/scriptWorker.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/scriptWorker.js

@@ -0,0 +1,50 @@
+import { getStructure } from './generated/data-structure.js';
+import { serializeScriptError } from './scriptErrors.js';
+const pending = new Map();
+let sequence = 0;
+let session;
+const call = (method, args) => new Promise((resolve, reject) => {
+    const id = ++sequence;
+    pending.set(id, { resolve, reject });
+    process.send({ type: 'call', id, method, args });
+});
+process.on('disconnect', () => process.exit(1));
+process.on('message', async (message) => {
+    if (message.type === 'response') {
+        const entry = pending.get(message.id);
+        if (!entry)
+            return;
+        pending.delete(message.id);
+        session = message.session ?? session;
+        if (message.error)
+            entry.reject(Object.assign(new Error(message.error.message), message.error));
+        else
+            entry.resolve(message.result);
+        return;
+    }
+    if (message.type !== 'start')
+        return;
+    session = message.session;
+    const api = Object.fromEntries(message.methods.map((method) => [method, (...args) => call(method, args)]));
+    api.structure = getStructure;
+    Object.defineProperty(api, 'session', { get: () => session, enumerable: true });
+    Object.defineProperty(globalThis, 'mearl', { value: Object.freeze(api), configurable: true });
+    let failure;
+    try {
+        const AsyncFunction = Object.getPrototypeOf(async function () { }).constructor;
+        const fn = new AsyncFunction('mearl', '"use strict";\n' + message.code + '\n//# sourceURL=mearl-script.js');
+        await fn(api);
+        if (pending.size)
+            throw Object.assign(new Error('Script finished with unawaited SDK calls'), {
+                code: 'SCRIPT_PENDING_CALLS',
+            });
+    }
+    catch (error) {
+        failure = serializeScriptError(error);
+    }
+    await Promise.all([
+        new Promise(resolve => process.stdout.write('', resolve)),
+        new Promise(resolve => process.stderr.write('', resolve)),
+    ]);
+    process.send(failure ? { type: 'error', error: failure } : { type: 'done' });
+});

package/dist/sdkMethods.d.ts

@@ -0,0 +1,3 @@
+/** Method names and signature exceptions shared by script dispatch and command help. */
+export declare const SDK_METHOD_ACTIONS: Map<string, string>;
+export declare const SDK_OPTIONS_ONLY_METHODS: Set<string>;

package/dist/sdkMethods.js

@@ -0,0 +1,9 @@
+import { BROWSER_COMMAND_ACTIONS } from './generated/browser-action-protocol.js';
+/** Method names and signature exceptions shared by script dispatch and command help. */
+export const SDK_METHOD_ACTIONS = new Map(Object.keys(BROWSER_COMMAND_ACTIONS).map(action => [
+    action.replace(/_([a-z])/g, (_, letter) => letter.toUpperCase()),
+    action,
+]));
+SDK_METHOD_ACTIONS.set('selectBrowser', 'browser_select_browser');
+SDK_METHOD_ACTIONS.set('captureCheckpoint', 'tab_checkpoint');
+export const SDK_OPTIONS_ONLY_METHODS = new Set(['browserList', 'tabList', 'getRules']);

package/package.json

@@ -1,11 +1,15 @@
 {
   "name": "@mearl/client",
-  "version": "2.22.0",
+  "version": "2.22.2",
   "description": "Unified Mearl SDK & CLI for local and remote browsers",
   "type": "module",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "exports": {
+    "./script": {
+      "types": "./dist/script.d.ts",
+      "import": "./dist/script.js"
+    },
     ".": {
       "types": "./dist/index.d.ts",
       "import": "./dist/index.js"
@@ -60,23 +64,22 @@
     "registry": "https://registry.npmjs.org"
   },
   "dependencies": {
-    "acorn": "^8.16.0",
-    "ajv": "^8.18.0",
     "commander": "^15.0.0",
     "fastest-levenshtein": "^1.0.16",
     "ws": "^8.18.0",
-    "@mearl/daemon-core": "2.22.0",
-    "@mearl/cloud-types": "2.22.0",
-    "@mearl/provider": "2.22.0",
-    "@mearl/agent-runtime": "2.22.0"
+    "@mearl/cloud-types": "2.22.2",
+    "@mearl/provider": "2.22.2",
+    "@mearl/agent-runtime": "2.22.2",
+    "@mearl/daemon-core": "2.22.2"
   },
   "devDependencies": {
     "@types/node": "^24.9.1",
     "@types/ws": "^8.18.1",
+    "esbuild": "^0.25.12",
     "typescript": "^5.8.3"
   },
   "scripts": {
-    "build": "node ../../scripts/generate-client-action-protocol.mjs --check && rm -rf dist/ && tsc && chmod +x dist/bin.js",
+    "build": "node ../../scripts/generate-client-action-protocol.mjs --check && node ../../scripts/generate-plugin-host-build.mjs && rm -rf dist/ && tsc && chmod +x dist/bin.js",
     "dev": "tsc --watch",
     "typecheck": "node ../../scripts/generate-client-action-protocol.mjs --check && tsc --noEmit",
     "test": "vitest run"