remnote-bridge 0.1.0

package/dist/cli/main.js

@@ -0,0 +1,300 @@
+#!/usr/bin/env node
+/**
+ * remnote-bridge 主入口
+ *
+ * 伞命令：CLI 命令 + mcp 子命令 + install 子命令。
+ */
+import { Command } from 'commander';
+import { connectCommand } from './commands/connect.js';
+import { healthCommand } from './commands/health.js';
+import { disconnectCommand } from './commands/disconnect.js';
+import { readRemCommand } from './commands/read-rem.js';
+import { editRemCommand } from './commands/edit-rem.js';
+import { readTreeCommand } from './commands/read-tree.js';
+import { editTreeCommand } from './commands/edit-tree.js';
+import { readGlobeCommand } from './commands/read-globe.js';
+import { readContextCommand } from './commands/read-context.js';
+import { searchCommand } from './commands/search.js';
+import { installSkillCommand } from './commands/install-skill.js';
+const program = new Command();
+/**
+ * --json 模式下解析 JSON 输入参数。
+ * 返回 null 表示解析失败（已输出错误并设置 exitCode）。
+ */
+function parseJsonInput(command, jsonStr, requiredFields = []) {
+    if (!jsonStr) {
+        console.log(JSON.stringify({ ok: false, command, error: '--json 模式需要传入 JSON 参数，例如: command --json \'{"remId":"..."}\'' }));
+        process.exitCode = 1;
+        return null;
+    }
+    let input;
+    try {
+        input = JSON.parse(jsonStr);
+    }
+    catch {
+        console.log(JSON.stringify({ ok: false, command, error: `JSON 解析失败: ${jsonStr}` }));
+        process.exitCode = 1;
+        return null;
+    }
+    if (!input.remId) {
+        console.log(JSON.stringify({ ok: false, command, error: 'JSON 参数中缺少 remId 字段' }));
+        process.exitCode = 1;
+        return null;
+    }
+    for (const field of requiredFields) {
+        if (input[field] === undefined) {
+            console.log(JSON.stringify({ ok: false, command, error: `JSON 参数中缺少 ${field} 字段` }));
+            process.exitCode = 1;
+            return null;
+        }
+    }
+    return input;
+}
+program
+    .name('remnote-bridge')
+    .description('RemNote Bridge — CLI + MCP Server + Plugin')
+    .version('0.1.0')
+    .option('--json', '以 JSON 格式输出（适用于程序化调用）');
+program
+    .command('connect')
+    .description('启动守护进程（WS Server + webpack-dev-server），等待 Plugin 连接')
+    .action(async () => {
+    const { json } = program.opts();
+    await connectCommand({ json });
+});
+program
+    .command('health')
+    .description('检查守护进程、Plugin 连接和 SDK 状态')
+    .action(async () => {
+    const { json } = program.opts();
+    await healthCommand({ json });
+});
+program
+    .command('disconnect')
+    .description('停止守护进程，释放端口和资源')
+    .action(async () => {
+    const { json } = program.opts();
+    await disconnectCommand({ json });
+});
+program
+    .command('read-rem [remIdOrJson]')
+    .description('读取单个 Rem 的完整 JSON 对象')
+    .option('--fields <fields>', '只返回指定字段（逗号分隔）')
+    .option('--full', '输出全部 51 个字段（含 R-F 低频字段）')
+    .option('--includePowerup', '包含 Powerup 系统数据（默认过滤）')
+    .action(async (remIdOrJson, cmdOpts) => {
+    const { json } = program.opts();
+    if (json) {
+        const input = parseJsonInput('read-rem', remIdOrJson);
+        if (!input)
+            return;
+        await readRemCommand(input.remId, { json, fields: input.fields?.join(','), full: input.full, includePowerup: input.includePowerup });
+    }
+    else {
+        if (!remIdOrJson) {
+            console.error('错误: 缺少 remId');
+            process.exitCode = 1;
+            return;
+        }
+        await readRemCommand(remIdOrJson, { json, ...cmdOpts });
+    }
+});
+program
+    .command('read-tree [remIdOrJson]')
+    .description('读取 Rem 子树并序列化为 Markdown 大纲')
+    .option('--depth <depth>', '展开深度（默认 3，-1 = 全部展开）')
+    .option('--max-nodes <maxNodes>', '全局节点上限（默认 200）')
+    .option('--max-siblings <maxSiblings>', '每个父节点下展示的 children 上限（默认 20）')
+    .option('--ancestor-levels <ancestorLevels>', '向上追溯祖先层数（默认 0，上限 10）')
+    .option('--includePowerup', '包含 Powerup 系统数据（默认过滤）')
+    .action(async (remIdOrJson, cmdOpts) => {
+    const { json } = program.opts();
+    if (json) {
+        const input = parseJsonInput('read-tree', remIdOrJson);
+        if (!input)
+            return;
+        await readTreeCommand(input.remId, {
+            json,
+            depth: input.depth?.toString(),
+            maxNodes: input.maxNodes?.toString(),
+            maxSiblings: input.maxSiblings?.toString(),
+            ancestorLevels: input.ancestorLevels?.toString(),
+            includePowerup: input.includePowerup,
+        });
+    }
+    else {
+        if (!remIdOrJson) {
+            console.error('错误: 缺少 remId');
+            process.exitCode = 1;
+            return;
+        }
+        await readTreeCommand(remIdOrJson, { json, ...cmdOpts });
+    }
+});
+program
+    .command('read-globe [jsonStr]')
+    .description('读取知识库全局概览（仅 Document 层级）')
+    .option('--depth <depth>', 'Document 嵌套深度（默认 -1 无限）')
+    .option('--max-nodes <maxNodes>', '全局节点上限（默认 200）')
+    .option('--max-siblings <maxSiblings>', '每个父节点下展示的 children 上限（默认 20）')
+    .action(async (jsonStr, cmdOpts) => {
+    const { json } = program.opts();
+    if (json) {
+        let input = {};
+        if (jsonStr) {
+            try {
+                input = JSON.parse(jsonStr);
+            }
+            catch {
+                console.log(JSON.stringify({ ok: false, command: 'read-globe', error: `JSON 解析失败: ${jsonStr}` }));
+                process.exitCode = 1;
+                return;
+            }
+        }
+        await readGlobeCommand({
+            json,
+            depth: input.depth?.toString(),
+            maxNodes: input.maxNodes?.toString(),
+            maxSiblings: input.maxSiblings?.toString(),
+        });
+    }
+    else {
+        await readGlobeCommand({ json, ...cmdOpts });
+    }
+});
+program
+    .command('read-context [jsonStr]')
+    .description('读取当前上下文视图（focus 鱼眼 / page 页面）')
+    .option('--mode <mode>', '模式：focus（默认）或 page')
+    .option('--ancestor-levels <levels>', '向上追溯几层祖先（默认 2，仅 focus 模式）')
+    .option('--depth <depth>', '展开深度（默认 3，仅 page 模式）')
+    .option('--max-nodes <maxNodes>', '全局节点上限（默认 200）')
+    .option('--max-siblings <maxSiblings>', '每个父节点下展示的 children 上限（默认 20）')
+    .action(async (jsonStr, cmdOpts) => {
+    const { json } = program.opts();
+    if (json) {
+        let input = {};
+        if (jsonStr) {
+            try {
+                input = JSON.parse(jsonStr);
+            }
+            catch {
+                console.log(JSON.stringify({ ok: false, command: 'read-context', error: `JSON 解析失败: ${jsonStr}` }));
+                process.exitCode = 1;
+                return;
+            }
+        }
+        await readContextCommand({
+            json,
+            mode: input.mode,
+            ancestorLevels: input.ancestorLevels?.toString(),
+            depth: input.depth?.toString(),
+            maxNodes: input.maxNodes?.toString(),
+            maxSiblings: input.maxSiblings?.toString(),
+        });
+    }
+    else {
+        await readContextCommand({ json, ...cmdOpts });
+    }
+});
+program
+    .command('edit-tree [remIdOrJson]')
+    .description('通过 str_replace 编辑 Rem 子树结构（行级增/删/移/重排）')
+    .option('--old-str <oldStr>', '要替换的原始文本片段')
+    .option('--new-str <newStr>', '替换后的新文本片段')
+    .action(async (remIdOrJson, cmdOpts) => {
+    const { json } = program.opts();
+    if (json) {
+        const input = parseJsonInput('edit-tree', remIdOrJson, ['oldStr', 'newStr']);
+        if (!input)
+            return;
+        await editTreeCommand(input.remId, { json, oldStr: input.oldStr, newStr: input.newStr });
+    }
+    else {
+        if (!remIdOrJson) {
+            console.error('错误: 缺少 remId');
+            process.exitCode = 1;
+            return;
+        }
+        if (!cmdOpts.oldStr || cmdOpts.newStr === undefined) {
+            console.error('错误: --old-str 和 --new-str 是必需的');
+            process.exitCode = 1;
+            return;
+        }
+        await editTreeCommand(remIdOrJson, { json, oldStr: cmdOpts.oldStr, newStr: cmdOpts.newStr });
+    }
+});
+program
+    .command('search [queryOrJson]')
+    .description('在知识库中按文本搜索 Rem')
+    .option('--limit <limit>', '结果数量上限（默认 20）')
+    .action(async (queryOrJson, cmdOpts) => {
+    const { json } = program.opts();
+    if (json) {
+        let input = {};
+        if (queryOrJson) {
+            try {
+                input = JSON.parse(queryOrJson);
+            }
+            catch {
+                console.log(JSON.stringify({ ok: false, command: 'search', error: `JSON 解析失败: ${queryOrJson}` }));
+                process.exitCode = 1;
+                return;
+            }
+        }
+        if (!input.query) {
+            console.log(JSON.stringify({ ok: false, command: 'search', error: 'JSON 参数中缺少 query 字段' }));
+            process.exitCode = 1;
+            return;
+        }
+        await searchCommand(input.query, { json, limit: input.numResults?.toString() });
+    }
+    else {
+        if (!queryOrJson) {
+            console.error('错误: 缺少搜索关键词');
+            process.exitCode = 1;
+            return;
+        }
+        await searchCommand(queryOrJson, { json, ...cmdOpts });
+    }
+});
+program
+    .command('edit-rem [remIdOrJson]')
+    .description('通过 str_replace 编辑 Rem 的 JSON 字段')
+    .option('--old-str <oldStr>', '要替换的原始文本片段')
+    .option('--new-str <newStr>', '替换后的新文本片段')
+    .action(async (remIdOrJson, cmdOpts) => {
+    const { json } = program.opts();
+    if (json) {
+        const input = parseJsonInput('edit-rem', remIdOrJson, ['oldStr', 'newStr']);
+        if (!input)
+            return;
+        await editRemCommand(input.remId, { json, oldStr: input.oldStr, newStr: input.newStr });
+    }
+    else {
+        if (!remIdOrJson) {
+            console.error('错误: 缺少 remId');
+            process.exitCode = 1;
+            return;
+        }
+        if (!cmdOpts.oldStr || cmdOpts.newStr === undefined) {
+            console.error('错误: --old-str 和 --new-str 是必需的');
+            process.exitCode = 1;
+            return;
+        }
+        await editRemCommand(remIdOrJson, { json, oldStr: cmdOpts.oldStr, newStr: cmdOpts.newStr });
+    }
+});
+// mcp 子命令
+program.command('mcp')
+    .description('启动 MCP Server（stdio）')
+    .action(async () => {
+    const { startMcpServer } = await import('../mcp/index.js');
+    await startMcpServer();
+});
+// install 子命令组
+const installCmd = program.command('install').description('安装组件');
+installCmd.command('skill')
+    .description('安装 Skill 到 ~/.claude/skills/remnote-bridge/')
+    .action(async () => { await installSkillCommand(); });
+program.parse();

package/dist/cli/protocol.d.ts

@@ -0,0 +1,39 @@
+/**
+ * WS 通信协议类型定义
+ *
+ * 定义 CLI 守护进程与 Plugin 之间的 WebSocket 消息格式。
+ * 与 remnote-plugin 各自独立定义，不共享代码。
+ */
+export type ConnectionStatus = 'disconnected' | 'connecting' | 'connected';
+export interface HelloMessage {
+    type: 'hello';
+    version: string;
+    sdkReady: boolean;
+}
+export interface PingMessage {
+    type: 'ping';
+}
+export interface PongMessage {
+    type: 'pong';
+}
+export interface BridgeRequest {
+    id: string;
+    action: string;
+    payload: Record<string, unknown>;
+}
+export interface BridgeResponse {
+    id: string;
+    result?: unknown;
+    error?: string;
+}
+export interface StatusResult {
+    pluginConnected: boolean;
+    sdkReady: boolean;
+    uptime: number;
+    timeoutRemaining: number;
+}
+export declare function isHelloMessage(msg: unknown): msg is HelloMessage;
+export declare function isPingMessage(msg: unknown): msg is PingMessage;
+export declare function isPongMessage(msg: unknown): msg is PongMessage;
+export declare function isBridgeRequest(msg: unknown): msg is BridgeRequest;
+export declare function isBridgeResponse(msg: unknown): msg is BridgeResponse;

package/dist/cli/protocol.js

@@ -0,0 +1,35 @@
+/**
+ * WS 通信协议类型定义
+ *
+ * 定义 CLI 守护进程与 Plugin 之间的 WebSocket 消息格式。
+ * 与 remnote-plugin 各自独立定义，不共享代码。
+ */
+// ── 消息类型判断辅助 ──
+export function isHelloMessage(msg) {
+    return (typeof msg === 'object' &&
+        msg !== null &&
+        msg.type === 'hello' &&
+        typeof msg.version === 'string');
+}
+export function isPingMessage(msg) {
+    return (typeof msg === 'object' &&
+        msg !== null &&
+        msg.type === 'ping');
+}
+export function isPongMessage(msg) {
+    return (typeof msg === 'object' &&
+        msg !== null &&
+        msg.type === 'pong');
+}
+export function isBridgeRequest(msg) {
+    return (typeof msg === 'object' &&
+        msg !== null &&
+        typeof msg.id === 'string' &&
+        typeof msg.action === 'string');
+}
+export function isBridgeResponse(msg) {
+    return (typeof msg === 'object' &&
+        msg !== null &&
+        typeof msg.id === 'string' &&
+        !('action' in msg));
+}

package/dist/cli/server/config-server.d.ts

@@ -0,0 +1,26 @@
+/**
+ * ConfigServer — HTTP 配置管理服务器
+ *
+ * 绑定 127.0.0.1:<configPort>，提供可视化配置页面。
+ * - GET /          — 返回内联 HTML/CSS/JS 配置页面
+ * - GET /api/config — 返回当前配置 JSON
+ * - POST /api/config — 校验 → saveConfig → 返回成功
+ * - POST /api/restart — 调用 onRestart() 回调 → 返回成功
+ */
+export interface ConfigServerOptions {
+    port: number;
+    host?: string;
+    projectRoot: string;
+    onRestart: () => Promise<void>;
+    onLog?: (message: string, level: 'info' | 'warn' | 'error') => void;
+}
+export declare class ConfigServer {
+    private server;
+    private options;
+    constructor(options: ConfigServerOptions);
+    private log;
+    start(): Promise<void>;
+    stop(): Promise<void>;
+    private handleRequest;
+    private renderPage;
+}