@yuhere/js-jsonrpc2 2.1.11 → 2.1.13

package/webui/index.html

@@ -1,12 +0,0 @@
-<!DOCTYPE html>
-<html lang="zh-CN">
-  <head>
-    <meta charset="UTF-8" />
-    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>JSON-RPC 2.0</title>
-  </head>
-  <body>
-    <div id="root"></div>
-    <script type="module" src="/src/main.tsx"></script>
-  </body>
-</html>

package/webui/src/App.tsx

@@ -1,164 +0,0 @@
-import { useCallback, useEffect, useMemo, useState } from 'react';
-import { createRpc, type TransportKind } from './api/rpc';
-import { useMethods } from './hooks/useMethods';
-import { useMethodDetail } from './hooks/useMethodDetail';
-import { useMetrics } from './hooks/useMetrics';
-import { Toolbar } from './components/Toolbar';
-import { MethodTree } from './components/MethodTree';
-import { MethodDetail } from './components/MethodDetail';
-import { TestPanel } from './components/TestPanel';
-import { MetricsPanel } from './components/MetricsPanel';
-import { compileGlobFilter, filterSnapshotMethods } from './api/glob';
-import type { MetricsSnapshot } from './api/metrics';
-import {
-    collectApiDoc,
-    downloadText,
-    renderMarkdown,
-} from './api/docGen';
-
-const ENDPOINT = '';
-type View = 'methods' | 'metrics';
-
-export default function App() {
-    const [transport, setTransport] = useState<TransportKind>('http');
-    const [selected, setSelected] = useState('');
-    const [generatingDocs, setGeneratingDocs] = useState(false);
-    const [view, setView] = useState<View>('methods');
-    const [methodFilter, setMethodFilter] = useState('');
-
-    const rpc = useMemo(() => createRpc({ transport, endpoint: ENDPOINT }), [transport]);
-
-    useEffect(() => () => rpc.close(), [rpc]);
-
-    const { methods, loading, error, refresh } = useMethods(rpc);
-    const detail = useMethodDetail(rpc, selected);
-    const metrics = useMetrics(rpc, view === 'metrics');
-
-    const compiledFilter = useMemo(() => compileGlobFilter(methodFilter), [methodFilter]);
-
-    // 过滤后的快照：不改变拉取范围，只裁剪 methods。
-    const filteredSnapshot = useMemo<MetricsSnapshot | undefined>(() => {
-        if (!metrics.snapshot) return undefined;
-        if (compiledFilter.passthrough) return metrics.snapshot;
-        return {
-            ...metrics.snapshot,
-            methods: filterSnapshotMethods(compiledFilter, metrics.snapshot.methods) as MetricsSnapshot['methods'],
-        };
-    }, [metrics.snapshot, compiledFilter]);
-
-    const generateDocs = useCallback(async () => {
-        if (methods.length === 0) {
-            alert('方法列表为空，请先刷新方法列表。');
-            return;
-        }
-        setGeneratingDocs(true);
-        try {
-            const doc = await collectApiDoc(rpc, methods);
-            const md = renderMarkdown(doc);
-            const ts = new Date().toISOString().replace(/[:.]/g, '-').slice(0, 19);
-            downloadText(`jsonrpc-api-doc-${ts}.md`, md, 'text/markdown');
-        } catch (e) {
-            alert(`生成文档失败：${e instanceof Error ? e.message : String(e)}`);
-        } finally {
-            setGeneratingDocs(false);
-        }
-    }, [rpc, methods]);
-
-    return (
-        <div className="app">
-            <Toolbar
-                transport={transport}
-                onTransportChange={setTransport}
-                onRefresh={refresh}
-                loading={loading}
-                error={error}
-                onGenerateDocs={generateDocs}
-                generatingDocs={generatingDocs}
-            />
-            <main>
-                <aside className="sidebar">
-                    <div className="view-switch segmented" role="group" aria-label="视图">
-                        <button
-                            type="button"
-                            className={view === 'methods' ? 'active' : ''}
-                            onClick={() => setView('methods')}
-                        >
-                            Methods
-                        </button>
-                        <button
-                            type="button"
-                            className={view === 'metrics' ? 'active' : ''}
-                            onClick={() => setView('metrics')}
-                        >
-                            Metrics
-                        </button>
-                    </div>
-
-                    {view === 'methods' ? (
-                        <>
-                            <h2>Methods</h2>
-                            <MethodTree methods={methods} selected={selected} onSelect={setSelected} />
-                        </>
-                    ) : (
-                        <div className="metrics-sidebar">
-                            <h2>Metrics</h2>
-                            <p className="hint" style={{ margin: '0 0 8px' }}>
-                                📊 服务端 RPC 调用统计。
-                            </p>
-                            <label className="metrics-filter">
-                                <span className="metrics-filter-label">Filter</span>
-                                <input
-                                    className="sf-input"
-                                    type="text"
-                                    placeholder="user.*, !system.*"
-                                    value={methodFilter}
-                                    onChange={(e) => setMethodFilter(e.target.value)}
-                                    spellCheck={false}
-                                />
-                            </label>
-                            <p className="hint metrics-filter-help">
-                                支持 <code>*</code> / <code>?</code> / <code>!</code>，多个模式用 <code>,</code> 分隔。
-                                <br />
-                                例：<code>user.*</code>、<code>*.get</code>、<code>!system.*</code>、<code>user.*,!user.secret</code>
-                            </p>
-                            {metrics.snapshot && (
-                                <p className="hint metrics-filter-stat">
-                                    匹配 {Object.keys(filteredSnapshot?.methods ?? {}).length} /{' '}
-                                    {Object.keys(metrics.snapshot.methods).length} 个方法
-                                </p>
-                            )}
-                        </div>
-                    )}
-                </aside>
-                <div className="content">
-                    {view === 'methods' ? (
-                        <>
-                            <MethodDetail method={selected} detail={detail} />
-                            <TestPanel
-                                method={selected}
-                                detail={detail}
-                                rpc={rpc}
-                                transport={transport}
-                                endpoint={ENDPOINT}
-                            />
-                        </>
-                    ) : (
-                        <MetricsPanel
-                            snapshot={filteredSnapshot}
-                            previous={metrics.previous}
-                            fetchedAt={metrics.fetchedAt}
-                            loading={metrics.loading}
-                            error={metrics.error}
-                            available={metrics.available}
-                            onRefresh={() => void metrics.refresh()}
-                            autoRefresh={metrics.autoRefresh}
-                            onAutoRefreshChange={metrics.setAutoRefresh}
-                            intervalMs={metrics.intervalMs}
-                            onIntervalChange={metrics.setIntervalMs}
-                        />
-                    )}
-                </div>
-            </main>
-        </div>
-    );
-}

package/webui/src/api/docGen.ts

@@ -1,188 +0,0 @@
-import type { RpcClient } from './rpc';
-import type { SchemaDescription } from './schema';
-
-export interface MethodDoc {
-    name: string;
-    help: string;
-    signature: SchemaDescription[];
-    error?: string;
-}
-
-export interface ApiDoc {
-    generatedAt: string;
-    methods: MethodDoc[];
-}
-
-function isSchema(v: unknown): v is SchemaDescription {
-    return !!v && typeof v === 'object' && typeof (v as SchemaDescription).kind === 'string';
-}
-
-/** 逐个方法拉取 help + signature */
-export async function collectApiDoc(
-    rpc: RpcClient,
-    methods: string[],
-    onProgress?: (done: number, total: number) => void,
-): Promise<ApiDoc> {
-    const out: MethodDoc[] = [];
-    for (let i = 0; i < methods.length; i++) {
-        const name = methods[i];
-        try {
-            const [help, sig] = await Promise.all([
-                rpc.call<string>('system.methodHelp', name).catch(() => ''),
-                rpc.call<unknown[]>('system.methodSignature', name).catch(() => []),
-            ]);
-            out.push({
-                name,
-                help: typeof help === 'string' ? help : '',
-                signature: Array.isArray(sig) ? sig.filter(isSchema) : [],
-            });
-        } catch (e) {
-            out.push({
-                name,
-                help: '',
-                signature: [],
-                error: e instanceof Error ? e.message : String(e),
-            });
-        }
-        onProgress?.(i + 1, methods.length);
-    }
-    return { generatedAt: new Date().toISOString(), methods: out };
-}
-
-// ─────────────────────────────────────────────────────────────
-// Markdown 渲染
-// ─────────────────────────────────────────────────────────────
-
-function renderSchema(schema: SchemaDescription): string {
-    // 简单的单行描述：kind + constraints + nullable
-    let s = schema.kind;
-    if (schema.nullable) s += ' | null';
-    const c = schema.constraints;
-    if (c && Object.keys(c).length > 0) {
-        const parts = Object.entries(c)
-            .filter(([, v]) => v !== undefined)
-            .map(([k, v]) => `${k}=${JSON.stringify(v)}`);
-        if (parts.length) s += ` { ${parts.join(', ')} }`;
-    }
-    return s;
-}
-
-function renderSchemaTree(schema: SchemaDescription, indent = 0): string[] {
-    const pad = '  '.repeat(indent);
-    const lines: string[] = [];
-    let head = `${pad}- \`${schema.kind}\``;
-    if (schema.nullable) head += ' _(nullable)_';
-    if (schema.description) head += ` — ${schema.description}`;
-    const c = schema.constraints;
-    if (c && Object.keys(c).length > 0) {
-        const parts = Object.entries(c)
-            .filter(([, v]) => v !== undefined)
-            .map(([k, v]) => `${k}=${JSON.stringify(v)}`);
-        if (parts.length) head += ` \`{ ${parts.join(', ')} }\``;
-    }
-    lines.push(head);
-
-    const ch = schema.children ?? {};
-    const pushChild = (label: string, child: SchemaDescription) => {
-        const sub = renderSchemaTree(child, indent + 1);
-        if (sub.length) {
-            sub[0] = `${'  '.repeat(indent + 1)}- **${label}**: ${sub[0].trim().replace(/^- /, '')}`;
-            lines.push(...sub);
-        }
-    };
-
-    if (isSchema(ch.inner)) pushChild('inner', ch.inner);
-    if (Array.isArray(ch.items)) {
-        (ch.items as unknown[]).forEach((it, i) => {
-            if (isSchema(it)) pushChild(`[${i}]`, it);
-        });
-    } else if (isSchema(ch.items)) {
-        pushChild('items', ch.items);
-    }
-    if (Array.isArray(ch.options)) {
-        (ch.options as unknown[]).forEach((opt, i) => {
-            if (isSchema(opt)) pushChild(`option[${i}]`, opt);
-        });
-    }
-    if (ch.properties && typeof ch.properties === 'object') {
-        for (const [k, v] of Object.entries(ch.properties)) {
-            if (isSchema(v)) pushChild(k, v);
-        }
-    }
-    if (isSchema(ch.values)) pushChild('values', ch.values);
-
-    return lines;
-}
-
-export function renderMarkdown(doc: ApiDoc): string {
-    const lines: string[] = [];
-    lines.push('# JSON-RPC API 文档');
-    lines.push('');
-    lines.push(`> 生成时间：${doc.generatedAt}`);
-    lines.push(`> 方法总数：${doc.methods.length}`);
-    lines.push('');
-    lines.push('## 目录');
-    lines.push('');
-    for (const m of doc.methods) {
-        const anchor = m.name.toLowerCase().replace(/[^\w]+/g, '-');
-        lines.push(`- [\`${m.name}\`](#${anchor})`);
-    }
-    lines.push('');
-
-    for (const m of doc.methods) {
-        lines.push(`## \`${m.name}\``);
-        lines.push('');
-        if (m.error) {
-            lines.push(`> ⚠️ 获取失败：${m.error}`);
-            lines.push('');
-            continue;
-        }
-        lines.push('**帮助**');
-        lines.push('');
-        lines.push(m.help ? m.help : '_（无帮助信息）_');
-        lines.push('');
-
-        if (m.signature.length === 0) {
-            lines.push('**签名**：_（无）_');
-            lines.push('');
-            continue;
-        }
-
-        const [ret, ...params] = m.signature;
-        lines.push('**返回类型**');
-        lines.push('');
-        lines.push(...renderSchemaTree(ret, 0));
-        lines.push('');
-        lines.push(`**参数**（${params.length} 个）`);
-        lines.push('');
-        if (params.length === 0) {
-            lines.push('_（无参数）_');
-        } else {
-            params.forEach((p, i) => {
-                const sub = renderSchemaTree(p, 0);
-                if (sub.length) {
-                    sub[0] = `- **参数 [${i}]**: ${sub[0].trim().replace(/^- /, '')}`;
-                    lines.push(...sub);
-                }
-            });
-        }
-        lines.push('');
-        lines.push('---');
-        lines.push('');
-    }
-
-    return lines.join('\n');
-}
-
-/** 触发浏览器下载 */
-export function downloadText(filename: string, text: string, mime = 'text/plain') {
-    const blob = new Blob([text], { type: `${mime};charset=utf-8` });
-    const url = URL.createObjectURL(blob);
-    const a = document.createElement('a');
-    a.href = url;
-    a.download = filename;
-    document.body.appendChild(a);
-    a.click();
-    document.body.removeChild(a);
-    setTimeout(() => URL.revokeObjectURL(url), 1000);
-}

package/webui/src/api/glob.ts

@@ -1,90 +0,0 @@
-/**
- * 极简 glob 匹配 + 多模式过滤。
- *
- * 语法：
- * - `*` 任意字符（含 `.`）
- * - `?` 单个字符
- * - `**` 与 `*` 等价（兼容常见 glob 方言）
- * - `!pat` 取反；多个 `!` 之间是「且」
- * - 多个模式用 `,` 分隔；正向模式之间是「或」，取反模式与整体是「且」
- * - 空串或纯空白 → 不过滤
- */
-
-export interface CompiledFilter {
-    /** 正向模式（OR）；为空表示「全部」。 */
-    includes: RegExp[];
-    /** 取反模式（AND NOT）。 */
-    excludes: RegExp[];
-    /** 原始输入，便于回显。 */
-    raw: string;
-    /** 是否等价于「不过滤」。 */
-    passthrough: boolean;
-}
-
-function globToRegExp(glob: string): RegExp {
-    let re = '^';
-    for (let i = 0; i < glob.length; i++) {
-        const ch = glob[i]!;
-        if (ch === '*') {
-            // 吞掉连续 *（** 视为 *）
-            while (i + 1 < glob.length && glob[i + 1] === '*') i++;
-            re += '.*';
-        } else if (ch === '?') {
-            re += '.';
-        } else if ('\\^$+{}()|[]'.includes(ch)) {
-            re += '\\' + ch;
-        } else {
-            re += ch;
-        }
-    }
-    re += '$';
-    return new RegExp(re);
-}
-
-export function compileGlobFilter(input: string): CompiledFilter {
-    const raw = input ?? '';
-    const trimmed = raw.trim();
-    if (trimmed.length === 0) {
-        return { includes: [], excludes: [], raw, passthrough: true };
-    }
-    const includes: RegExp[] = [];
-    const excludes: RegExp[] = [];
-    for (const part of trimmed.split(',')) {
-        const pat = part.trim();
-        if (pat.length === 0) continue;
-        if (pat.startsWith('!')) {
-            const body = pat.slice(1).trim();
-            if (body.length > 0) excludes.push(globToRegExp(body));
-        } else {
-            includes.push(globToRegExp(pat));
-        }
-    }
-    // 只有 !pat 时，includes 为空 → 视为「从全部里排除」
-    return { includes, excludes, raw, passthrough: false };
-}
-
-export function matchMethod(filter: CompiledFilter, method: string): boolean {
-    if (filter.passthrough) return true;
-    if (filter.excludes.some((re) => re.test(method))) return false;
-    if (filter.includes.length === 0) return true; // 只有 !pat 时，保留所有未排除的
-    return filter.includes.some((re) => re.test(method));
-}
-
-/** 对一组 method 名做过滤；返回过滤后的列表（保持原顺序）。 */
-export function filterMethods<T extends string>(filter: CompiledFilter, methods: T[]): T[] {
-    if (filter.passthrough) return methods;
-    return methods.filter((m) => matchMethod(filter, m));
-}
-
-/** 便捷：直接对 MetricsSnapshot 的 methods 做过滤，返回浅拷贝。 */
-export function filterSnapshotMethods(
-    filter: CompiledFilter,
-    methods: Record<string, unknown>,
-): Record<string, unknown> {
-    if (filter.passthrough) return methods;
-    const out: Record<string, unknown> = {};
-    for (const [method, stats] of Object.entries(methods)) {
-        if (matchMethod(filter, method)) out[method] = stats;
-    }
-    return out;
-}

package/webui/src/api/httpTransport.ts

@@ -1,148 +0,0 @@
-import type { RpcResponse } from './types';
-import {
-    RPCError,
-    type CallResult,
-    type RpcClient,
-} from './rpc';
-
-export interface HttpRpcOptions {
-    endpoint?: string;
-    headers?: Record<string, string>;
-    fetchImpl?: typeof fetch;
-}
-
-let idCounter = 0;
-
-interface StreamFrame {
-    jsonrpc: '2.0';
-    id: number | string;
-    done: boolean;
-    index?: number;
-    value?: unknown;
-    error?: { code: number; message: string };
-}
-
-async function readLine(
-    reader: ReadableStreamDefaultReader<Uint8Array>,
-    decoder: TextDecoder,
-    state: { buf: string },
-): Promise<string | undefined> {
-    while (true) {
-        const nl = state.buf.indexOf('\n');
-        if (nl >= 0) {
-            const line = state.buf.slice(0, nl).trim();
-            state.buf = state.buf.slice(nl + 1);
-            if (line) return line;
-            continue;
-        }
-        const { done, value } = await reader.read();
-        if (done) {
-            const trailing = state.buf.trim();
-            state.buf = '';
-            return trailing.length > 0 ? trailing : undefined;
-        }
-        state.buf += decoder.decode(value, { stream: true });
-    }
-}
-
-function isStreamFrame(v: unknown): v is StreamFrame {
-    return !!v && typeof v === 'object' && typeof (v as StreamFrame).done === 'boolean';
-}
-
-export function createHttpRpc(options: HttpRpcOptions = {}): RpcClient {
-    const {
-        endpoint = '',
-        headers = {},
-        fetchImpl = fetch,
-    } = options;
-
-    function call<T = unknown>(method: string, ...params: unknown[]): CallResult<T> {
-        const id = ++idCounter;
-        const body = { jsonrpc: '2.0', method, params, id };
-
-        return (async () => {
-            const res = await fetchImpl(endpoint, {
-                method: 'POST',
-                headers: {
-                    'Content-Type': 'application/json',
-                    'Accept': 'application/x-ndjson',
-                    ...headers,
-                },
-                body: JSON.stringify(body),
-            });
-
-            if (!res.ok) {
-                throw new Error(`HTTP ${res.status} ${res.statusText}`);
-            }
-
-            if (!res.body) {
-                const payload = (await res.json()) as RpcResponse<T>;
-                if (payload.error) throw new RPCError(payload.error);
-                return payload.result as T;
-            }
-
-            const reader = res.body.getReader();
-            const decoder = new TextDecoder();
-            const state = { buf: '' };
-
-            const firstLine = await readLine(reader, decoder, state);
-            if (firstLine === undefined) {
-                await reader.cancel().catch(() => { /* ignore */ });
-                throw new Error(`Empty response for ${method}`);
-            }
-
-            let first: StreamFrame | RpcResponse<T>;
-            try {
-                first = JSON.parse(firstLine);
-            } catch (e) {
-                await reader.cancel().catch(() => { /* ignore */ });
-                throw new Error(
-                    `Invalid JSON response for ${method}: ${e instanceof Error ? e.message : String(e)}`,
-                );
-            }
-
-            if (!isStreamFrame(first)) {
-                const payload = first as RpcResponse<T>;
-                await reader.cancel().catch(() => { /* ignore */ });
-                if (payload.error) throw new RPCError(payload.error);
-                return payload.result as T;
-            }
-
-            return (async function* (): AsyncGenerator<T, void, unknown> {
-                let drained = false;
-                try {
-                    let chunk = first;
-                    while (true) {
-                        if (chunk.error) throw new RPCError(chunk.error);
-                        if (chunk.done) { drained = true; return; }
-                        if (chunk.value !== undefined) yield chunk.value as T;
-                        const line = await readLine(reader, decoder, state);
-                        if (line === undefined) {
-                            throw new Error('Stream ended without terminal frame');
-                        }
-                        chunk = JSON.parse(line);
-                    }
-                } finally {
-                    if (!drained) {
-                        await reader.cancel().catch(() => { /* ignore */ });
-                    }
-                }
-            })();
-        })();
-    }
-
-    return {
-        call,
-        close() {
-        },
-    };
-}
-
-export function absoluteEndpoint(endpoint?: string): string {
-    const raw = endpoint && endpoint.trim().length > 0 ? endpoint : '/';
-    try {
-        return new URL(raw, window.location.href).toString();
-    } catch {
-        return raw;
-    }
-}