@dsh-workbench/shared 0.3.11 → 1.0.0-beta.1

package/src/api/unit.ts

@@ -1,93 +0,0 @@
-/**
- * 一张卡片在清单里的静态声明（文案键加排序位）；默认显不显示由运行期面板配置定。
- */
-export interface UnitCard {
-  readonly titleKey: string;
-  readonly order: number;
-}
-
-/**
- * 一条工具在清单里的样子：全名加会不会写；审批按 writes 认领。
- */
-export interface UnitTool {
-  readonly name: string;
-  readonly writes: boolean;
-}
-
-/**
- * 模块要外壳的哪些服务：inject 缺一个就挂不上，optional 缺了照挂。
- */
-export interface UnitHostNeeds {
-  readonly inject: readonly string[];
-  readonly optional?: readonly string[];
-}
-
-/**
- * 一个 opencli 插件的来源三选一（git / 本地 / npm）；npm 那支的安装源先看 registryEnv 那个环境变量，没设才用 registryDefault。
- */
-export type PluginSource =
-  | { readonly kind: 'git'; readonly url: string }
-  | { readonly kind: 'local'; readonly env: string }
-  | {
-      readonly kind: 'npm';
-      readonly package: string;
-      readonly registryEnv: string;
-      readonly registryDefault?: string;
-    };
-
-/**
- * 模块要的一个 opencli 插件：名字、它得提供的命令，以及装它的来源（没写就是不代装）。
- */
-export interface UnitPluginNeed {
-  readonly name: string;
-  readonly commands?: readonly string[];
-  readonly installSource?: PluginSource;
-}
-
-/**
- * 模块要的一个共用库：名字、期望范围与它为什么要这个版本（purpose 会进申报文案）。
- */
-export interface UnitLibNeed {
-  readonly name: string;
-  readonly version?: string | undefined;
-  readonly registryEnv: string;
-  readonly registryDefault: string;
-  readonly purpose: string;
-}
-
-/**
- * 模块的整份环境需要：一条自检命令，加上插件与共用库两张表。
- */
-export interface UnitEnvNeeds {
-  readonly command?: string;
-  readonly plugins?: readonly UnitPluginNeed[];
-  readonly libs?: readonly UnitLibNeed[];
-}
-
-/**
- * 已装插件与源上最新版那一对，用来判该不该提示升级；latest 缺省表示还没查到。
- */
-export interface PluginRelease {
-  readonly installed: string;
-  readonly latest?: string;
-}
-
-/**
- * 装配期用的模块清单：单元 id、卡片、工具与宿主 / 环境需要，比声明少一层协议包装。
- */
-export interface UnitManifest {
-  readonly id: string;
-  readonly card: UnitCard | null;
-  readonly tools: readonly UnitTool[];
-  readonly host: UnitHostNeeds;
-  readonly env?: UnitEnvNeeds;
-}
-
-/**
- * 判这个模块要不要往外装东西。
- * @param manifest 模块清单。
- * @returns 插件与共用库两张表都空时给 false。
- */
-export function hasEnvSupply(manifest: UnitManifest): boolean {
-  return (manifest.env?.plugins ?? []).length > 0 || (manifest.env?.libs ?? []).length > 0;
-}

package/src/api/workbench-contract.ts

@@ -1,59 +0,0 @@
-import type { PluginRelease } from '../api/unit.js';
-
-/**
- * 供给动作的那几档（装 / 升 / 卸，模块、共用依赖与插件各一套）；写口按它分派。
- */
-export type ProvisionAction =
-  | 'install'
-  | 'update'
-  | 'uninstall'
-  | 'update-dependency'
-  | 'install-bundle'
-  | 'update-bundle'
-  | 'remove-bundle'
-  | 'cancel-install'
-  | 'update-plugin'
-  | 'uninstall-plugin'
-  | 'update-workbench';
-
-/**
- * 宿主报的一个 opencli 插件此刻的状态：装没装、缺哪些命令、该不该升，以及怎么升。
- */
-export interface PluginStatePayload {
-  readonly name: string;
-  readonly status: 'ok' | 'outdated' | 'missing';
-  readonly missing: readonly string[];
-  readonly install?: 'ready' | 'not-declared' | 'env-missing' | 'malformed';
-  readonly command?: string;
-  readonly release?: PluginRelease;
-}
-
-/**
- * 宿主对「这个单元现在能不能用」的那份读数：状态、缺的命令与插件、修复动作和供给细节。
- */
-export interface CapabilityPayload {
-  readonly unit: string;
-  readonly status: 'ok' | 'failed' | 'missing-commands' | 'missing-plugin' | 'unchecked';
-  readonly plugin?: string;
-  readonly required: readonly string[];
-  readonly missing: readonly string[];
-  readonly detail: string;
-  readonly command?: string;
-  readonly fix?: 'install' | 'update';
-  readonly plugins?: readonly PluginStatePayload[];
-  readonly released?: boolean;
-  readonly install?: 'ready' | 'not-declared' | 'env-missing' | 'malformed';
-  readonly libs?: readonly LibStatePayload[];
-}
-
-/**
- * 宿主报的一个共用库此刻的状态（装没装、版本对不对）与它为什么要这个版本。
- */
-export interface LibStatePayload {
-  readonly name: string;
-  readonly purpose: string;
-  readonly status: 'ok' | 'outdated' | 'missing' | 'unsatisfied';
-  readonly installed?: string;
-  readonly latest?: string;
-  readonly command?: string;
-}

package/src/host/__tests__/browser-find.test.ts

@@ -1,330 +0,0 @@
-import { describe, expect, it } from 'vitest';
-import { BROWSER_SCREEN_SESSION } from '../browser-read.js';
-import {
-  browserFind,
-  cellRows,
-  cellRowsOf,
-  entriesOf,
-  reasonOf,
-  sameOrigin,
-  urlOf,
-} from '../browser-find.js';
-
-interface Step {
-  readonly stdout?: string;
-  readonly stderr?: string;
-  readonly exitCode?: number;
-  readonly timedOut?: boolean;
-  readonly throws?: boolean;
-}
-
-interface Plan {
-  readonly url?: string | readonly string[];
-  readonly find?: readonly Step[];
-  readonly open?: readonly Step[];
-}
-
-function fakeShell(plan: Plan) {
-  const commands: string[] = [];
-  const counters = { url: 0, find: 0, open: 0 };
-  const pick = <T>(list: readonly T[] | undefined, index: number, fallback: T): T =>
-    (list ?? [])[Math.min(index, Math.max(0, (list ?? []).length - 1))] ?? fallback;
-
-  const shell = {
-    resolve(request: { command: string }) {
-      commands.push(request.command);
-      return request;
-    },
-    async execute(spec: { command: string }) {
-      const command = String(spec.command);
-      let step: Step = {};
-      let stdout = '';
-      if (command.includes("'get'") && command.includes("'url'")) {
-        const urls = typeof plan.url === 'string' ? [plan.url] : (plan.url ?? []);
-        stdout = pick(urls, counters.url, '') as string;
-        counters.url += 1;
-      } else if (command.includes("'find'")) {
-        step = pick(plan.find, counters.find, {});
-        stdout = step.stdout ?? '';
-        counters.find += 1;
-      } else if (command.includes("'open'")) {
-        step = pick(plan.open, counters.open, {});
-        stdout = step.stdout ?? JSON.stringify({ page: 'AE4021' });
-        counters.open += 1;
-      }
-      if (step.throws === true) throw new Error('spawn opencli ENOENT');
-      return {
-        result: async () => ({
-          exitCode: step.exitCode ?? 0,
-          timedOut: step.timedOut ?? false,
-          aborted: false,
-          stdout: { text: stdout, truncated: false },
-          stderr: { text: step.stderr ?? '', truncated: false },
-        }),
-      };
-    },
-  };
-  return { shell: shell as never, commands };
-}
-
-const FAST = { settleMs: 1, timeoutMs: 50 } as const;
-const SITE = 'https://example.test/rates';
-const OTHER = 'https://example.test/elsewhere';
-const CSS = 'table tr';
-const MATCH = JSON.stringify({ entries: [{ text: '美元\n673.30', tag: 'tr', nth: 1 }] });
-const ZERO_MATCH = JSON.stringify({
-  error: {
-    code: 'selector_not_found',
-    hint: 'try a less specific selector',
-    message: 'CSS selector table tr matched 0 elements',
-  },
-});
-
-describe('browserFind · 停在哪一页', () => {
-  it('已经在目标站点上：只问一次 get url，然后一次 find', async () => {
-    const { shell, commands } = fakeShell({ url: SITE, find: [{ stdout: MATCH }] });
-    const out = await browserFind({ shell, css: CSS, url: SITE, ...FAST });
-
-    expect(out.ok).toBe(true);
-    expect(out.count).toBe(1);
-    expect(out.entries[0]?.text).toBe('美元\n673.30');
-    expect(commands.filter((one) => one.includes("'find'"))).toHaveLength(1);
-    expect(commands.some((one) => one.includes("'open'"))).toBe(false);
-    expect(commands[0]).toContain("'get' 'url'");
-  });
-
-  it('新会话还停在 about:blank：先 open 再读，命令走 find --css', async () => {
-    const { shell, commands } = fakeShell({
-      url: ['about:blank', SITE],
-      find: [{ stdout: MATCH }],
-    });
-    const out = await browserFind({ shell, css: CSS, url: SITE, ...FAST });
-
-    expect(out.ok).toBe(true);
-    expect(out.count).toBe(1);
-    expect(commands.some((one) => one.includes("'open'"))).toBe(true);
-    expect(commands.filter((one) => one.includes("'find'"))).toHaveLength(1);
-    expect(commands[1]).toContain("'open'");
-    expect(commands[1]).toContain(SITE);
-  });
-
-  it('问不出来在哪一页（get url 空）时不乱开，直接找', async () => {
-    const { shell, commands } = fakeShell({ url: '', find: [{ stdout: MATCH }] });
-    const out = await browserFind({ shell, css: CSS, url: SITE, ...FAST });
-
-    expect(out.ok).toBe(true);
-    expect(commands.some((one) => one.includes("'open'"))).toBe(false);
-  });
-
-  it('open 失败 → cli-exec-failed，带上 helpUrl 与原因', async () => {
-    const { shell } = fakeShell({
-      url: 'about:blank',
-      open: [{ stdout: JSON.stringify({ error: { message: 'browser session is not bound' } }), exitCode: 1 }],
-    });
-    const out = await browserFind({ shell, css: CSS, url: SITE, ...FAST });
-
-    expect(out.ok).toBe(false);
-    expect(out.code).toBe('cli-exec-failed');
-    expect(out.message).toContain('打不开');
-    expect(out.detail).toContain('not bound');
-    expect(out.helpUrl).toBe(SITE);
-  });
-
-  it('open 那条命令直接抛（opencli 不在）也要报出来，不许把异常漏出去', async () => {
-    const { shell } = fakeShell({ url: 'about:blank', open: [{ throws: true }] });
-    const out = await browserFind({ shell, css: CSS, url: SITE, ...FAST });
-
-    expect(out.ok).toBe(false);
-    expect(out.code).toBe('cli-exec-failed');
-    expect(out.detail).toContain('ENOENT');
-  });
-});
-
-describe('browserFind · 找到与找不到', () => {
-  it('页面上就是没有匹配元素 → ok，但 count 是 0（空不撒谎）', async () => {
-    const { shell } = fakeShell({ url: SITE, find: [{ stdout: JSON.stringify({ entries: [] }) }] });
-    const out = await browserFind({ shell, css: CSS, url: SITE, ...FAST });
-
-    expect(out.ok).toBe(true);
-    expect(out.count).toBe(0);
-    expect(out.message).toContain('没有匹配');
-  });
-
-  it('在站点上但 find 失败（会话刚重启那类）：安全网再 open 一次并重读', async () => {
-    const { shell, commands } = fakeShell({
-      url: SITE,
-      find: [{ stdout: ZERO_MATCH, exitCode: 1 }, { stdout: MATCH }],
-    });
-    const out = await browserFind({ shell, css: CSS, url: SITE, ...FAST });
-
-    expect(out.ok).toBe(true);
-    expect(out.count).toBe(1);
-    expect(commands.filter((one) => one.includes("'find'"))).toHaveLength(2);
-    expect(commands.some((one) => one.includes("'open'"))).toBe(true);
-  });
-
-  it('一直失败：把 opencli 自己在 stdout JSON 里说的原因当 message（不是 stderr）', async () => {
-    const { shell } = fakeShell({
-      url: SITE,
-      find: [{ stdout: ZERO_MATCH, exitCode: 1 }, { stdout: ZERO_MATCH, exitCode: 1 }],
-    });
-    const out = await browserFind({ shell, css: CSS, url: SITE, ...FAST });
-
-    expect(out.ok).toBe(false);
-    expect(out.code).toBe('cli-exec-failed');
-    expect(out.message).toContain('matched 0 elements');
-    expect(out.hint).toBe('try a less specific selector');
-    expect(out.helpUrl).toBe(SITE);
-  });
-
-  it('超时归成 cli-timeout，且不再折腾页面', async () => {
-    const { shell, commands } = fakeShell({
-      url: SITE,
-      find: [{ timedOut: true, exitCode: 124 }],
-    });
-    const out = await browserFind({ shell, css: CSS, url: SITE, ...FAST });
-
-    expect(out.ok).toBe(false);
-    expect(out.code).toBe('cli-timeout');
-    expect(out.detail).toContain('秒内返回');
-    expect(commands.some((one) => one.includes("'open'"))).toBe(false);
-  });
-
-  it('url 没给：只 find，不问页面也不开', async () => {
-    const { shell, commands } = fakeShell({ find: [{ stdout: MATCH }] });
-    const out = await browserFind({ shell, css: CSS, ...FAST });
-
-    expect(out.ok).toBe(true);
-    expect(commands).toHaveLength(1);
-    expect(commands[0]).toContain("'find'");
-  });
-
-  it('open:false：只 find（不说自己在哪一页，也不开）', async () => {
-    const { shell, commands } = fakeShell({
-      url: SITE,
-      find: [{ stdout: ZERO_MATCH, exitCode: 1 }, { stdout: MATCH }],
-    });
-    const out = await browserFind({ shell, css: CSS, url: SITE, open: false, ...FAST });
-
-    expect(out.ok).toBe(false);
-    expect(commands).toHaveLength(1);
-  });
-
-  it('opencli 根本没起来（find 那条抛）→ cli-exec-failed，带照做的话', async () => {
-    const { shell } = fakeShell({ url: SITE, find: [{ throws: true }] });
-    const out = await browserFind({ shell, css: CSS, url: SITE, ...FAST });
-
-    expect(out.ok).toBe(false);
-    expect(out.code).toBe('cli-exec-failed');
-    expect(out.detail).toContain('ENOENT');
-    expect(out.hint).toContain('后台服务');
-  });
-
-  it('session / command / limit / textMax 都能覆盖（命令行每个 token 都加引号）', async () => {
-    const { shell, commands } = fakeShell({ url: SITE, find: [{ stdout: MATCH }] });
-    await browserFind({
-      shell,
-      css: CSS,
-      url: SITE,
-      session: 'dsh-fx-rate',
-      command: '/usr/local/bin/opencli',
-      limit: 60,
-      textMax: 400,
-      ...FAST,
-    });
-
-    const findLine = commands.find((one) => one.includes("'find'")) ?? '';
-    expect(commands[0]).toContain("'/usr/local/bin/opencli'");
-    expect(commands[0]).toContain("'dsh-fx-rate'");
-    expect(findLine).toContain("'--limit' '60'");
-    expect(findLine).toContain("'--text-max' '400'");
-  });
-});
-
-describe('cellRowsOf / reasonOf / sameOrigin', () => {
-  it('按换行切格、丢掉空行、按 minCells 过滤', () => {
-    const rows = cellRowsOf([
-      { text: '货币名称\n现汇买入价\n\n现钞买入价\n现汇卖出价' },
-      { text: '只有一个' },
-      { text: undefined },
-    ]);
-
-    expect(rows).toHaveLength(1);
-    expect(rows[0]).toEqual(['货币名称', '现汇买入价', '现钞买入价', '现汇卖出价']);
-    expect(cellRowsOf([{ text: '一\n二' }], 3)).toEqual([]);
-    expect(cellRows('a\n b \n\n')).toEqual(['a', 'b']);
-  });
-
-  it('reasonOf 优先取 error.message，没有才退回到最后一行', () => {
-    expect(reasonOf(JSON.stringify({ error: { message: 'matched 0 elements' } }), '')).toBe(
-      'matched 0 elements',
-    );
-    expect(reasonOf('', 'opencli: daemon not ready\nboom')).toBe('boom');
-    expect(reasonOf('not json', '')).toBe('not json');
-  });
-
-  it('entriesOf 只认有 text 的项，缺 nth 用序号补', () => {
-    const entries = entriesOf({
-      entries: [{ text: 'a', tag: 'tr' }, { tag: 'tr' }, 'nope', { text: 'b', tag: 'tr', nth: 9 }],
-    });
-
-    expect(entries).toHaveLength(3);
-    expect(entries[0]).toEqual({ text: 'a', tag: 'tr', nth: 0 });
-    expect(entries[2]).toEqual({ text: 'b', tag: 'tr', nth: 9 });
-    expect(entriesOf(undefined)).toEqual([]);
-    expect(entriesOf({ entries: 'nope' })).toEqual([]);
-  });
-
-  it('urlOf 认裸 URL、认带引号的、也认 {url} 的 JSON（判错的代价是每次多开一次页面）', () => {
-    expect(urlOf('https://a.test/x\n')).toBe('https://a.test/x');
-    expect(urlOf('URL: https://a.test/x')).toBe('https://a.test/x');
-    expect(urlOf('"https://a.test/x"')).toBe('https://a.test/x');
-    expect(urlOf('{"url":"https://a.test/x","title":"t"}')).toBe('https://a.test/x');
-    expect(urlOf('')).toBe('');
-  });
-
-  it('sameOrigin 只看同源；空串或不是 URL 一律不算', () => {
-    expect(sameOrigin('https://a.test/x', 'https://a.test/y')).toBe(true);
-    expect(sameOrigin('https://a.test/x', 'https://b.test/y')).toBe(false);
-    expect(sameOrigin('about:blank', SITE)).toBe(false);
-    expect(sameOrigin('', SITE)).toBe(false);
-    expect(sameOrigin('not a url', SITE)).toBe(false);
-    expect(OTHER).toContain('elsewhere');
-  });
-});
-
-function backgroundless(commands: readonly string[]): readonly string[] {
-  return commands
-    .filter((one) => one.includes("'browser'"))
-    .filter(
-      (one) => !one.includes("'--window' 'background'") || !one.includes("'OPENCLI_WINDOW=background'"),
-    );
-}
-
-describe('browserFind · 后台静默（问页 + 读 + 打开都不许抢焦点）', () => {
-  it('已经在目标站点上：get url + find 两条全带', async () => {
-    const { shell, commands } = fakeShell({ url: SITE, find: [{ stdout: MATCH }] });
-    await browserFind({ shell, css: CSS, url: SITE, ...FAST });
-
-    expect(commands).toHaveLength(2);
-    expect(backgroundless(commands)).toEqual([]);
-  });
-
-  it('不在目标站点上：get url + open + find 三条全带', async () => {
-    const { shell, commands } = fakeShell({ url: ['about:blank', SITE], find: [{ stdout: MATCH }] });
-    await browserFind({ shell, css: CSS, url: SITE, ...FAST });
-
-    expect(commands.filter((one) => one.includes("'open'"))).toHaveLength(1);
-    expect(backgroundless(commands)).toEqual([]);
-  });
-});
-
-describe('browserFind · 读有它自己那条会话（不许碰屏那条）', () => {
-  it('默认那条命令里一条都不带屏那条会话名', async () => {
-    const { shell, commands } = fakeShell({ url: ['about:blank', SITE], find: [{ stdout: MATCH }] });
-    await browserFind({ shell, css: CSS, url: SITE, ...FAST });
-
-    expect(commands.length).toBeGreaterThan(0);
-    expect(commands.some((one) => one.includes(`'${BROWSER_SCREEN_SESSION}'`))).toBe(false);
-  });
-});