@dsh-workbench/shared 0.1.15 → 0.1.17

package/src/host/__tests__/provision.test.ts

@@ -12,6 +12,8 @@ describe('provision 请求体：每类动作各有各的目标字段', () => {
       ['remove-bundle', 'name'],
       ['cancel-install', 'requestId'],
       ['update-dependency', 'id'],
+      ['update-plugin', 'name'],
+      ['uninstall-plugin', 'name'],
     ]);
   });
 
@@ -55,6 +57,22 @@ describe('provision 请求体：每类动作各有各的目标字段', () => {
     });
   });
 
+  it('用户装的那两笔插件动作按包名认目标（凭台账记的那个包名）', () => {
+    expect(parseProvisionBody({ action: 'update-plugin', name: ' opencli-plugin-cmdb ' })).toEqual({
+      ok: true,
+      request: { action: 'update-plugin', name: 'opencli-plugin-cmdb' },
+    });
+    expect(parseProvisionBody({ action: 'uninstall-plugin', name: 'opencli-plugin-cmdb' })).toEqual({
+      ok: true,
+      request: { action: 'uninstall-plugin', name: 'opencli-plugin-cmdb' },
+    });
+    expect(parseProvisionBody({ action: 'uninstall-plugin', unit: 'panels' })).toEqual({
+      ok: false,
+      code: 'workbench/no-name',
+      message: '缺少 name',
+    });
+  });
+
   it('拿错字段不算数（spec 动作给了 unit 也要打回）', () => {
     expect(parseProvisionBody({ action: 'install-bundle', unit: 'issues' })).toEqual({
       ok: false,

package/src/host/plugin-ledger.ts

@@ -0,0 +1,152 @@
+import type { ModuleStore } from './workspace-store.js';
+
+export const PLUGIN_LEDGER_FILE = 'plugins.json';
+
+export interface PluginLedgerEntry {
+  readonly opencliHome: string;
+  readonly package: string;
+  readonly name?: string;
+  readonly registry?: string;
+  readonly local?: boolean;
+  readonly installedAt: string;
+  readonly releasedAt?: string;
+}
+
+export function ledgerKeyOf(entry: {
+  readonly opencliHome: string;
+  readonly package: string;
+}): string {
+  return `${entry.opencliHome}\u0000${entry.package}`;
+}
+
+function textOf(value: unknown): string | undefined {
+  if (typeof value !== 'string') return undefined;
+  const trimmed = value.trim();
+  return trimmed === '' ? undefined : trimmed;
+}
+
+function entryOf(value: unknown): PluginLedgerEntry | undefined {
+  if (typeof value !== 'object' || value === null) return undefined;
+  const box = value as Readonly<Record<string, unknown>>;
+  const opencliHome = textOf(box['opencliHome']);
+  const pkg = textOf(box['package']);
+  const installedAt = textOf(box['installedAt']);
+  if (opencliHome === undefined || pkg === undefined || installedAt === undefined) return undefined;
+  const name = textOf(box['name']);
+  const registry = textOf(box['registry']);
+  const releasedAt = textOf(box['releasedAt']);
+  return {
+    opencliHome,
+    package: pkg,
+    installedAt,
+    ...(name === undefined ? {} : { name }),
+    ...(registry === undefined ? {} : { registry }),
+    ...(releasedAt === undefined ? {} : { releasedAt }),
+    ...(box['local'] === true ? { local: true } : {}),
+  };
+}
+
+export function parsePluginLedger(raw: unknown): PluginLedgerEntry[] {
+  if (typeof raw !== 'object' || raw === null) return [];
+  const list = (raw as Readonly<Record<string, unknown>>)['entries'];
+  if (!Array.isArray(list)) return [];
+  const entries: PluginLedgerEntry[] = [];
+  for (const item of list) {
+    const entry = entryOf(item);
+    if (entry === undefined) continue;
+    if (entries.some((known) => ledgerKeyOf(known) === ledgerKeyOf(entry))) continue;
+    entries.push(entry);
+  }
+  return entries;
+}
+
+export function readPluginLedger(store: ModuleStore): PluginLedgerEntry[] {
+  return parsePluginLedger(store.read(PLUGIN_LEDGER_FILE));
+}
+
+export function writePluginLedger(store: ModuleStore, entries: readonly PluginLedgerEntry[]): void {
+  if (entries.length === 0) {
+    store.remove(PLUGIN_LEDGER_FILE);
+    return;
+  }
+  store.write(PLUGIN_LEDGER_FILE, { entries });
+}
+
+export function pluginEntriesOfHome(
+  entries: readonly PluginLedgerEntry[],
+  opencliHome: string,
+): PluginLedgerEntry[] {
+  return entries.filter((entry) => entry.opencliHome === opencliHome);
+}
+
+export function isHeldEntry(entry: PluginLedgerEntry): boolean {
+  return entry.releasedAt === undefined;
+}
+
+export function heldEntriesOfHome(
+  entries: readonly PluginLedgerEntry[],
+  opencliHome: string,
+): PluginLedgerEntry[] {
+  return pluginEntriesOfHome(entries, opencliHome).filter(isHeldEntry);
+}
+
+export function heldEntryOfPlugin(
+  entries: readonly PluginLedgerEntry[],
+  opencliHome: string,
+  plugin: string,
+): PluginLedgerEntry | undefined {
+  const key = plugin.trim();
+  if (key === '') return undefined;
+  return heldEntriesOfHome(entries, opencliHome).find(
+    (entry) => entry.name === key || entry.package === key,
+  );
+}
+
+export function withReleasedEntry(
+  entries: readonly PluginLedgerEntry[],
+  opencliHome: string,
+  pkg: string,
+  releasedAt: string,
+): PluginLedgerEntry[] {
+  const entry = pluginEntryOf(entries, opencliHome, pkg);
+  if (entry === undefined || entry.releasedAt !== undefined) return [...entries];
+  return withPluginEntry(entries, { ...entry, releasedAt });
+}
+
+export type PluginRetention = 'remove' | 'keep-held' | 'keep-claimed' | 'keep-unsure';
+
+export function pluginRetentionOf(options: {
+  readonly held: boolean;
+  readonly claimedBy: readonly string[];
+  readonly trustworthy: boolean;
+}): PluginRetention {
+  if (options.held) return 'keep-held';
+  if (!options.trustworthy) return 'keep-unsure';
+  return options.claimedBy.length > 0 ? 'keep-claimed' : 'remove';
+}
+
+export function pluginEntryOf(
+  entries: readonly PluginLedgerEntry[],
+  opencliHome: string,
+  pkg: string,
+): PluginLedgerEntry | undefined {
+  const key = ledgerKeyOf({ opencliHome, package: pkg });
+  return entries.find((entry) => ledgerKeyOf(entry) === key);
+}
+
+export function withPluginEntry(
+  entries: readonly PluginLedgerEntry[],
+  entry: PluginLedgerEntry,
+): PluginLedgerEntry[] {
+  const key = ledgerKeyOf(entry);
+  return [...entries.filter((item) => ledgerKeyOf(item) !== key), entry];
+}
+
+export function withoutPluginEntry(
+  entries: readonly PluginLedgerEntry[],
+  opencliHome: string,
+  pkg: string,
+): PluginLedgerEntry[] {
+  const key = ledgerKeyOf({ opencliHome, package: pkg });
+  return entries.filter((entry) => ledgerKeyOf(entry) !== key);
+}

package/src/host/provision.ts

@@ -11,6 +11,8 @@ export const PROVISION_ACTIONS = [
   'remove-bundle',
   'cancel-install',
   'update-dependency',
+  'update-plugin',
+  'uninstall-plugin',
 ] as const satisfies readonly ProvisionAction[];
 
 export const DEPENDENCY_ACTIONS = ['update-dependency'] as const satisfies readonly ProvisionAction[];
@@ -32,6 +34,7 @@ export function provisionTargetOf(action: ProvisionAction): ProvisionTarget {
   if (action === 'update-dependency') return 'id';
   if (action === 'install-bundle') return 'spec';
   if (action === 'remove-bundle') return 'name';
+  if (action === 'update-plugin' || action === 'uninstall-plugin') return 'name';
   if (action === 'cancel-install') return 'requestId';
   return 'unit';
 }
@@ -74,6 +77,7 @@ function requestOf(action: ProvisionAction, value: string): ProvisionRequest {
   if (action === 'update-dependency') return { action, id: value };
   if (action === 'install-bundle') return { action, spec: value };
   if (action === 'remove-bundle') return { action, name: value };
+  if (action === 'update-plugin' || action === 'uninstall-plugin') return { action, name: value };
   if (action === 'cancel-install') return { action, requestId: value };
   return { action, unit: value };
 }

package/src/host/unit-face.ts

@@ -9,9 +9,11 @@ import type { ValueHandoff } from '../host/value-handoff.js';
 import type { WorkspaceStore } from '../host/workspace-store.js';
 
 export interface UnitMountDeps {
+  readonly manifest: UnitManifest;
   readonly ctx: DshHostContext;
   readonly logger?: { info?(message: string): void; warn?(message: string): void } | undefined;
   readonly manifests: () => readonly UnitManifest[];
+  readonly ownedUnits: () => readonly string[];
   readonly opencliCommand?: string;
   readonly store: WorkspaceStore;
   readonly values?: ValueHandoff | undefined;
@@ -60,7 +62,11 @@ export interface UnitMountResult {
   readonly needsApproval?: ApprovalPolicy | undefined;
 }
 
-export interface UnitHostFace {
-  readonly manifest: UnitManifest;
+export interface UnitModuleFace {
+  readonly unit: string;
   mount(deps: UnitMountDeps): UnitMountResult;
 }
+
+export interface UnitOwnedFace extends UnitModuleFace {
+  readonly manifest: UnitManifest;
+}

package/src/host.ts

@@ -1,6 +1,7 @@
 export * from './config/constants.js';
 export * from './api/context-ref.js';
 export * from './api/unit.js';
+export * from './api/unit-declaration.js';
 export * from './api/facts.js';
 export * from './api/long-task.js';
 export * from './lib/text.js';
@@ -16,6 +17,7 @@ export * from './host/http.js';
 export * from './host/long-task.js';
 export * from './host/opencli-runtime.js';
 export * from './host/opencli.js';
+export * from './host/plugin-ledger.js';
 export * from './host/plugin-source.js';
 export * from './host/provision.js';
 export * from './host/shell.js';

package/src/i18n/en.ts

@@ -74,6 +74,7 @@ export const en: Record<keyof WorkbenchMessages, string> = {
   'panels.market.sectionPending': 'Not installed',
   'panels.market.sectionShared': 'Shared dependencies',
   'panels.market.sharedUsedBy': 'Used by {modules}',
+  'panels.market.sharedFoot': 'These cannot be uninstalled here: they come with modules, and would be reinstalled anyway. To stop using one, turn off the modules that use it.',
   'panels.market.listSeparator': ', ',
   'panels.market.sharedMissing': 'not installed',
   'panels.market.sharedOutdated': 'update available',
@@ -103,8 +104,18 @@ export const en: Record<keyof WorkbenchMessages, string> = {
   'panels.market.installedSection': 'Installed',
   'panels.market.sectionLocal': 'Linked locally',
   'panels.market.sectionUnlisted': 'Not from the market',
+  'panels.market.sectionPlugins': 'Installed opencli plugins',
   'panels.market.moduleOutdated': 'update available',
+  'panels.market.moduleRefused': 'This module was built for an older version of the workbench, so it does not work here. Update it, or uninstall.',
+  'panels.market.moduleRefusedDetail': 'Why it cannot be used: {reason}',
   'panels.market.moduleRestartHint': 'installed but not active — restart dsh once to bring it up',
+  'panels.market.pluginLocalNoUpdate': 'Installed from a local folder, so there is nowhere to check for a newer version — uninstall only',
+  'panels.market.pluginKeptInUse': 'Files kept for now: {names} still uses it.',
+  'panels.market.pluginKeptUnsure': 'Files kept for now: some modules on this machine do not say what they use, so it is unclear who needs it.',
+  'panels.market.pluginKeptHeld': 'Files kept: this one is yours, and a module letting go will not remove it.',
+  'panels.market.pluginKeptUnnamed': 'Files kept for now: this one cannot be identified as a plugin, so it is unclear who needs it.',
+  'panels.market.pluginAlsoKnownAs': 'Its package is {pkg} (updates and uninstall use that)',
+  'panels.market.pluginBroken': 'This install is broken: it cannot be identified as a plugin. Uninstall it, or install it again by package name above.',
   'panels.market.restartNeeded': 'The new version is installed — restart once to pick it up.',
   'panels.market.foot': 'After installing, enable it in the panel page of that project.',
   'panels.market.recheck': 'Check for updates',
@@ -152,7 +163,12 @@ export const en: Record<keyof WorkbenchMessages, string> = {
   'panels.market.add.problemInstalled': 'This module is already installed',
   'panels.market.add.problemNotFound': 'No such module found',
   'panels.market.add.problemNotPackage': 'That path does not exist or is not a valid module package',
-  'panels.market.add.problemNotBundle': 'This package declares no bundle, so it cannot be installed as a module: {reason}',
+  'panels.market.add.problemNotBundle':
+    'This package cannot be installed here: {reason}. If it is actually an opencli plugin, use its package name (for example opencli-plugin-cmdb) or a local folder — a git URL or tarball does not reveal what it is.',
+  'panels.market.add.problemNotWorkbenchModule': 'This package does not match the workbench you are running, so installing it would not work. Pick another version, or ask the module author.',
+  'panels.market.add.problemNotModuleOrPlugin': 'This package is neither a workbench module nor an opencli plugin, so installing it would do nothing. Pick another version, or ask the package author.',
+  'panels.market.add.failureNotModuleOrPlugin': 'This package is neither a workbench module nor an opencli plugin, so installing it would do nothing',
+  'panels.market.add.installedPlugin': 'Installed: the opencli plugin {name}',
   'panels.market.add.problemNetwork': 'Cannot reach the module source; check the network and retry',
   'panels.market.add.problemUnknown': 'Cannot fetch module information: {reason}',
   'panels.market.add.failureNetwork': 'The network connection failed',
@@ -183,6 +199,7 @@ export const en: Record<keyof WorkbenchMessages, string> = {
   'panels.market.add.registryPnpm': "pnpm's own registry",
   'panels.market.add.check': 'Check',
   'panels.market.add.checking': 'Checking…',
+  'panels.market.add.classifying': 'Working out what it is…',
   'panels.market.add.change': 'Edit',
   'panels.market.add.previewTitle': 'About to install',
   'panels.market.add.fieldName': 'Package',

package/src/i18n/zh.ts

@@ -72,6 +72,7 @@ export const zh = {
   'panels.market.sectionPending': '未安装',
   'panels.market.sectionShared': '共用依赖',
   'panels.market.sharedUsedBy': '供 {modules} 使用',
+  'panels.market.sharedFoot': '这一段不给卸载：它们跟着模块来，卸掉也会被装回来。要停用一份，就去关掉正在用它的那些模块。',
   'panels.market.listSeparator': '、',
   'panels.market.sharedMissing': '未装',
   'panels.market.sharedOutdated': '有新版',
@@ -99,8 +100,18 @@ export const zh = {
   'panels.market.installedSection': '已安装',
   'panels.market.sectionLocal': '本地装的',
   'panels.market.sectionUnlisted': '不是从市场装的',
+  'panels.market.sectionPlugins': '已安装 opencli 插件',
   'panels.market.moduleOutdated': '有新版',
+  'panels.market.moduleRefused': '这个模块是给旧版本的工作台写的，现在用不了。更新它，或者卸载。',
+  'panels.market.moduleRefusedDetail': '装不上的原因：{reason}',
   'panels.market.moduleRestartHint': '装好了但还没生效 —— 重启一次 dsh 就会出来',
+  'panels.market.pluginLocalNoUpdate': '本地装的，没地方查新版，所以只给卸载',
+  'panels.market.pluginKeptInUse': '文件先留着：{names} 还要用它。',
+  'panels.market.pluginKeptUnsure': '文件先留着：这台机器上还有模块看不出用了什么，说不准谁在用它。',
+  'panels.market.pluginKeptHeld': '文件留着：你自己装的那一份，模块放手不动它。',
+  'panels.market.pluginKeptUnnamed': '文件先留着：看不出这是哪个插件，说不准谁在用它。',
+  'panels.market.pluginAlsoKnownAs': '包名是 {pkg}（更新与卸载按它来）',
+  'panels.market.pluginBroken': '这份装坏了：看不出它是个插件。可以卸载，或者去上面按包名再装一次。',
   'panels.market.restartNeeded': '新版装好了，重启一次才生效。',
   'panels.market.foot': '装好后到那个项目的面板页勾选它，模块才会出现。',
   'panels.market.recheck': '重新检查更新',
@@ -148,7 +159,12 @@ export const zh = {
   'panels.market.add.problemInstalled': '该模块已安装',
   'panels.market.add.problemNotFound': '未找到相关模块',
   'panels.market.add.problemNotPackage': '该路径不存在或不是有效的模块包',
-  'panels.market.add.problemNotBundle': '这个包没有声明组合包，无法作为模块安装：{reason}',
+  'panels.market.add.problemNotBundle':
+    '这个包装不进这里：{reason}。要是它其实是个 opencli 插件，请改用包名（例如 opencli-plugin-cmdb）或者本地目录 —— 从 git 地址和 tarball 判断不出它是什么。',
+  'panels.market.add.problemNotWorkbenchModule': '这个包跟现在的工作台对不上，装上也用不了。换一个版本，或者找这个模块的作者。',
+  'panels.market.add.problemNotModuleOrPlugin': '这个包既不是工作台的模块，也不是 opencli 的插件，装了也用不上。换一个版本，或者找这个包的作者。',
+  'panels.market.add.failureNotModuleOrPlugin': '这个包既不是工作台的模块，也不是 opencli 的插件，装了也用不上',
+  'panels.market.add.installedPlugin': '装上了：opencli 插件 {name}',
   'panels.market.add.problemNetwork': '无法连接模块源，请检查网络后重试',
   'panels.market.add.problemUnknown': '无法获取模块信息：{reason}',
   'panels.market.add.failureNetwork': '网络连接失败',
@@ -179,6 +195,7 @@ export const zh = {
   'panels.market.add.registryPnpm': 'pnpm 自己配的源',
   'panels.market.add.check': '预检',
   'panels.market.add.checking': '正在预检…',
+  'panels.market.add.classifying': '判定中…',
   'panels.market.add.change': '改一下',
   'panels.market.add.previewTitle': '将要安装',
   'panels.market.add.fieldName': '包名',

package/src/index.ts

@@ -8,6 +8,7 @@ export * from './api/host-write.js';
 export * from './api/long-task.js';
 export * from './api/unit-board.js';
 export * from './api/unit.js';
+export * from './api/unit-declaration.js';
 export * from './api/workbench-client.js';
 export * from './api/workbench-contract.js';
 export * from './components/Activity.js';