@dsh-workbench/shared 1.0.1 → 1.1.0

package/dist/contract/protocol/bundle-install.d.ts

@@ -1,3 +1,4 @@
+import type { UnitTitle } from '../unit.js';
 export declare const BUNDLE_REGISTRIES_ROUTE = "bundle-registries";
 export declare const BUNDLE_INSPECT_ROUTE = "bundle-inspect";
 export declare const BUNDLE_REGISTRY_DEFAULT = "default";
@@ -52,7 +53,6 @@ export interface WorkbenchSelfUpdate {
     readonly version?: string;
     readonly at?: string;
     readonly tail?: string;
-    readonly migration?: 'needed';
 }
 export declare const RESTART_REASONS: readonly ["no-hmr", "package-moved", "host-module", "unmanaged-plugin", "module-comparison"];
 export type RestartReason = (typeof RESTART_REASONS)[number];
@@ -115,11 +115,14 @@ export interface BundleRemovePayload {
 export interface BundleCancellationPayload {
     readonly cancellation: BundleCancellation | null;
 }
+export type ModuleUpdateBlock = 'needs-workbench' | 'incompatible';
 export interface ModuleVersion {
     readonly unit: string;
     readonly pkg: string;
     readonly installed: string;
+    readonly title?: UnitTitle;
     readonly latest?: string;
+    readonly latestBlocked?: ModuleUpdateBlock;
     readonly local?: boolean;
     readonly refused?: readonly string[];
 }
@@ -129,6 +132,11 @@ export interface WorkbenchVersion {
     readonly latest?: string;
     readonly running?: string;
     readonly local?: boolean;
+    readonly followUp?: {
+        readonly id: string;
+        readonly kind: 'data-migration';
+        readonly hard: boolean;
+    };
 }
 export interface ModuleVersionsPayload {
     readonly modules: readonly ModuleVersion[];

package/dist/contract/protocol/market-index.d.ts

@@ -4,6 +4,7 @@ export declare const MARKET_DISCOVER_ROUTE = "panels/market-discover";
 export declare const MARKET_DOC_ROUTE = "panels/market-doc";
 export declare const MARKET_PUBLISH_PREVIEW_ROUTE = "panels/market-publish-preview";
 export declare const MARKET_SOURCES_RESOURCE = "market-sources";
+export declare const MARKET_SOURCES_ROUTE = "panels/market-sources";
 export declare const MARKET_WORKBENCH_LABEL = "workbench";
 export type MarketSourceKind = 'http' | 'git';
 export type MarketSourcePolicy = 'artifacts-in-repo' | 'catalog-only';

package/dist/contract/protocol/market-index.js

@@ -4,4 +4,5 @@ export const MARKET_DISCOVER_ROUTE = 'panels/market-discover';
 export const MARKET_DOC_ROUTE = 'panels/market-doc';
 export const MARKET_PUBLISH_PREVIEW_ROUTE = 'panels/market-publish-preview';
 export const MARKET_SOURCES_RESOURCE = 'market-sources';
+export const MARKET_SOURCES_ROUTE = 'panels/market-sources';
 export const MARKET_WORKBENCH_LABEL = 'workbench';

package/dist/contract/unit-declaration.d.ts

@@ -1,18 +1,17 @@
-import type { UnitHostNeeds, UnitManifest } from '../contract/unit.js';
+import type { UnitHostNeeds, UnitManifest, UnitTitle } from '../contract/unit.js';
 import { type Need } from './needs.js';
 /**
  * 声明协议当前版本；模块清单的 dsh.workbench.apiVersion 要写这个整数。
  */
-export declare const WORKBENCH_API_VERSION = 2;
+export declare const WORKBENCH_API_VERSION = 3;
 /**
  * 外壳愿意认的协议版本；不在表里的模块当场被拒，不猜语义。
  */
 export declare const SUPPORTED_API_VERSIONS: readonly number[];
 /**
- * 清单里那半张卡片声明：文案键加排序位；卡片默认显不显示不在这里（那是运行期面板配置的事）。
+ * 清单里那半张卡片声明：只剩排序位；卡片默认显不显示不在这里（那是运行期面板配置的事）。
  */
 export interface UnitCardDeclaration {
-    readonly titleKey: string;
     readonly order: number;
 }
 /**
@@ -24,11 +23,12 @@ export interface UnitToolDeclaration {
     readonly key?: string;
 }
 /**
- * 模块清单里 dsh.workbench 那一段的完整形状（协议版本、单元 id、卡片、工具、宿主与环境需要）。
+ * 模块清单里 dsh.workbench 那一段的完整形状（协议版本、单元 id、名字、卡片、工具、宿主与环境需要）。
  */
 export interface UnitDeclaration {
     readonly apiVersion: number;
     readonly unit: string;
+    readonly title: UnitTitle;
     readonly card: UnitCardDeclaration | null;
     readonly tools: readonly UnitToolDeclaration[];
     readonly host: UnitHostNeeds;
@@ -42,6 +42,12 @@ export declare const DECLARATION_KEYS: readonly string[];
  * 协议要求必写的键；needs 不在其中（没有环境需要就不写）。
  */
 export declare const DECLARATION_REQUIRED_KEYS: readonly string[];
+/**
+ * 读一份声明里的协议版本；不是对象或 apiVersion 不是整数时给 undefined。
+ * @param raw 清单里 dsh.workbench 那段原始值。
+ * @returns 声明声明的协议版本，读不出来时 undefined。
+ */
+export declare function declarationApiVersionOf(raw: unknown): number | undefined;
 /**
  * 查清单里 dsh.workbench 那一段的形状，回一串给人看的问题（中文，带字段路径）。
  * @param subject 报错时用的主语，一般是包名。

package/dist/contract/unit-declaration.js

@@ -1,8 +1,9 @@
+import { unitTitleKey } from '../contract/unit.js';
 import { needsProblemsOf } from './needs.js';
 /**
  * 声明协议当前版本；模块清单的 dsh.workbench.apiVersion 要写这个整数。
  */
-export const WORKBENCH_API_VERSION = 2;
+export const WORKBENCH_API_VERSION = 3;
 /**
  * 外壳愿意认的协议版本；不在表里的模块当场被拒，不猜语义。
  */
@@ -13,6 +14,7 @@ export const SUPPORTED_API_VERSIONS = [WORKBENCH_API_VERSION];
 export const DECLARATION_KEYS = [
     'apiVersion',
     'unit',
+    'title',
     'card',
     'tools',
     'host',
@@ -24,11 +26,13 @@ export const DECLARATION_KEYS = [
 export const DECLARATION_REQUIRED_KEYS = [
     'apiVersion',
     'unit',
+    'title',
     'card',
     'tools',
     'host',
 ];
-const CARD_KEYS = ['titleKey', 'order'];
+const CARD_KEYS = ['order'];
+const TITLE_KEYS = ['zh', 'en'];
 const TOOL_KEYS = ['name', 'writes', 'key'];
 const TOOL_KEY_SHAPE = /^[a-z][a-zA-Z0-9]*$/;
 const HOST_KEYS = ['inject', 'optional'];
@@ -38,6 +42,17 @@ function text(value) {
 function isRecord(value) {
     return typeof value === 'object' && value !== null && !Array.isArray(value);
 }
+/**
+ * 读一份声明里的协议版本；不是对象或 apiVersion 不是整数时给 undefined。
+ * @param raw 清单里 dsh.workbench 那段原始值。
+ * @returns 声明声明的协议版本，读不出来时 undefined。
+ */
+export function declarationApiVersionOf(raw) {
+    if (!isRecord(raw))
+        return undefined;
+    const version = raw.apiVersion;
+    return Number.isInteger(version) ? version : undefined;
+}
 function outsideKeys(value, allowed) {
     return Object.keys(value).filter((key) => !allowed.includes(key));
 }
@@ -66,10 +81,9 @@ export function declarationProblemsOf(subject, raw) {
         ];
     }
     if (!Number.isInteger(version) || !SUPPORTED_API_VERSIONS.includes(version)) {
-        const hint = version === 1
-            ? ` —— v2 把 \`env\` 的三张表（command / plugins / libs）换成了 \`needs\`：` +
-                '把外部需要逐条写成 `{ kind, name, purpose, ... }`（kind 是 bin / extension / lib / env），' +
-                '再把 apiVersion 改成 2'
+        const hint = version === 2
+            ? ' —— v3 把卡片标题挪成了顶层 `title`（`{ "zh": "…", "en": "…" }` 字面量）：' +
+                '把 `card.titleKey` 删掉、在顶层写 title，再把 apiVersion 改成 3'
             : '';
         return [
             `${subject}: dsh.workbench.apiVersion 是 ${JSON.stringify(version)}，这里只认 ` +
@@ -88,6 +102,23 @@ export function declarationProblemsOf(subject, raw) {
                 (key === 'card' ? '（这个模块没有卡片就写 `"card": null`）' : ''));
         }
     }
+    const title = raw.title;
+    if (title !== undefined) {
+        if (!isRecord(title)) {
+            problems.push(`${subject}: dsh.workbench.title 要是对象（中英各一份），现在是 ${JSON.stringify(title)}`);
+        }
+        else {
+            const extra = outsideKeys(title, TITLE_KEYS);
+            if (extra.length > 0) {
+                problems.push(`${subject}: dsh.workbench.title 里有不认的键 ${listOf(extra)} —— title 只有 ${listOf(TITLE_KEYS)}`);
+            }
+            for (const language of TITLE_KEYS) {
+                if (text(title[language]) === '') {
+                    problems.push(`${subject}: dsh.workbench.title.${language} 要是非空字符串（市场和面板里显示的名字）`);
+                }
+            }
+        }
+    }
     const card = raw.card;
     if (card !== undefined && card !== null) {
         if (!isRecord(card)) {
@@ -97,10 +128,7 @@ export function declarationProblemsOf(subject, raw) {
             const extra = outsideKeys(card, CARD_KEYS);
             if (extra.length > 0) {
                 problems.push(`${subject}: dsh.workbench.card 里有不认的键 ${listOf(extra)} —— card 只有 ${listOf(CARD_KEYS)}` +
-                    `（卡片默认显不显示由运行期的面板配置决定，清单里没有这一位）`);
-            }
-            if (text(card.titleKey) === '') {
-                problems.push(`${subject}: dsh.workbench.card.titleKey 要是非空字符串（面板那一格的文案键）`);
+                    `（名字写在顶层的 title 里；卡片默认显不显示由运行期的面板配置决定，清单里没有这一位）`);
             }
             if (typeof card.order !== 'number' || !Number.isFinite(card.order)) {
                 problems.push(`${subject}: dsh.workbench.card.order 要是数字，现在是 ${JSON.stringify(card.order)}`);
@@ -193,15 +221,17 @@ export function readDeclaration(subject, raw) {
     if (needsRead.errors.length > 0)
         return { problems: needsRead.errors, warnings: needsRead.warnings };
     const card = declaration.card;
+    const id = text(declaration.unit);
     return {
         declaration,
         problems: [],
         manifest: {
-            id: text(declaration.unit),
+            id,
+            title: { zh: text(declaration.title.zh), en: text(declaration.title.en) },
             card: card === null
                 ? null
                 : {
-                    titleKey: text(card.titleKey),
+                    titleKey: unitTitleKey(id),
                     order: card.order,
                 },
             tools: declaration.tools.map((tool) => ({

package/dist/contract/unit.d.ts

@@ -1,4 +1,17 @@
 import type { ExtensionNeed, LibNeed, Need } from './needs.js';
+/**
+ * 模块的人类可读名字：中英各一份，写在 package.json 的 dsh.workbench.title 里。
+ */
+export interface UnitTitle {
+    readonly zh: string;
+    readonly en: string;
+}
+/**
+ * 外壳替模块名合成的词表键：模块自己不必写名字键，名字直接从清单里的 title 注册进来。
+ * @param unit 单元 id。
+ * @returns 该单元名字在词表里的键。
+ */
+export declare function unitTitleKey(unit: string): string;
 /**
  * 一张卡片在清单里的静态声明（文案键加排序位）；默认显不显示由运行期面板配置定。
  */
@@ -28,10 +41,11 @@ export interface PluginRelease {
     readonly latest?: string;
 }
 /**
- * 装配期用的模块清单：单元 id、卡片、工具、宿主服务与环境需要，比声明少一层协议包装。
+ * 装配期用的模块清单：单元 id、名字、卡片、工具、宿主服务与环境需要，比声明少一层协议包装。
  */
 export interface UnitManifest {
     readonly id: string;
+    readonly title?: UnitTitle;
     readonly card: UnitCard | null;
     readonly tools: readonly UnitTool[];
     readonly host: UnitHostNeeds;

package/dist/contract/unit.js

@@ -1,3 +1,11 @@
+/**
+ * 外壳替模块名合成的词表键：模块自己不必写名字键，名字直接从清单里的 title 注册进来。
+ * @param unit 单元 id。
+ * @returns 该单元名字在词表里的键。
+ */
+export function unitTitleKey(unit) {
+    return `dsh-workbench.unit.${unit}.title`;
+}
 /**
  * 模块声明的全部环境需要（没写就是空表）。
  * @param manifest 模块清单。

package/dist/contract/workbench-contract.d.ts

@@ -2,7 +2,7 @@ import type { NeedState } from '../contract/unit-capability.js';
 /**
  * 供给动作的那几档（装 / 升 / 卸，模块、共用依赖与插件各一套）；写口按它分派。
  */
-export type ProvisionAction = 'install' | 'update' | 'uninstall' | 'update-dependency' | 'install-bundle' | 'install-version' | 'update-bundle' | 'remove-bundle' | 'cancel-install' | 'update-plugin' | 'uninstall-plugin' | 'update-workbench';
+export type ProvisionAction = 'install' | 'update' | 'uninstall' | 'update-dependency' | 'install-bundle' | 'install-version' | 'update-bundle' | 'remove-bundle' | 'cancel-install' | 'update-plugin' | 'uninstall-plugin' | 'update-workbench' | 'migrate-workbench' | 'dismiss-followup';
 /**
  * 宿主对「这个单元现在能不能用」的那份读数：状态汇总加逐条 need 的细节。
  */

package/dist/host/provision.d.ts

@@ -1,6 +1,6 @@
 import type { ProvisionAction } from '../contract/workbench-contract.js';
 export type { ProvisionAction };
-export declare const PROVISION_ACTIONS: readonly ["install", "update", "uninstall", "install-bundle", "install-version", "update-bundle", "remove-bundle", "cancel-install", "update-dependency", "update-plugin", "uninstall-plugin", "update-workbench"];
+export declare const PROVISION_ACTIONS: readonly ["install", "update", "uninstall", "install-bundle", "install-version", "update-bundle", "remove-bundle", "cancel-install", "update-dependency", "update-plugin", "uninstall-plugin", "update-workbench", "migrate-workbench", "dismiss-followup"];
 export declare const DEPENDENCY_ACTIONS: readonly ["update-dependency"];
 export declare function isDependencyAction(action: ProvisionAction): action is (typeof DEPENDENCY_ACTIONS)[number];
 export type ProvisionTarget = 'unit' | 'id' | 'spec' | 'name' | 'requestId';

package/dist/host/provision.js

@@ -11,6 +11,8 @@ export const PROVISION_ACTIONS = [
     'update-plugin',
     'uninstall-plugin',
     'update-workbench',
+    'migrate-workbench',
+    'dismiss-followup',
 ];
 export const DEPENDENCY_ACTIONS = ['update-dependency'];
 export function isDependencyAction(action) {
@@ -27,8 +29,10 @@ export function provisionTargetOf(action) {
         return 'name';
     if (action === 'update-plugin' || action === 'uninstall-plugin')
         return 'name';
-    if (action === 'update-workbench')
+    if (action === 'update-workbench' || action === 'migrate-workbench')
         return 'name';
+    if (action === 'dismiss-followup')
+        return 'id';
     if (action === 'cancel-install')
         return 'requestId';
     return 'unit';
@@ -58,8 +62,10 @@ function requestOf(action, value) {
         return { action, name: value };
     if (action === 'update-plugin' || action === 'uninstall-plugin')
         return { action, name: value };
-    if (action === 'update-workbench')
+    if (action === 'update-workbench' || action === 'migrate-workbench')
         return { action, name: value };
+    if (action === 'dismiss-followup')
+        return { action, id: value };
     if (action === 'cancel-install')
         return { action, requestId: value };
     return { action, unit: value };

package/dist/host/supply-index.d.ts

@@ -3,6 +3,9 @@ export interface SupplyDeclaration {
     readonly id: string;
     readonly needs?: readonly Need[];
 }
+export interface SupplyIndexOptions {
+    readonly env?: Readonly<Record<string, string | undefined>>;
+}
 export interface SupplyEntry {
     readonly key: string;
     readonly kind: 'extension' | 'lib';
@@ -31,4 +34,4 @@ export interface SupplyIndex {
 export declare function npmSourceOf(sources: readonly SupplySource[] | undefined): Extract<SupplySource, {
     kind: 'npm';
 }> | undefined;
-export declare function buildSupplyIndex(declarations: readonly SupplyDeclaration[]): SupplyIndex;
+export declare function buildSupplyIndex(declarations: readonly SupplyDeclaration[], options?: SupplyIndexOptions): SupplyIndex;

package/dist/host/supply-index.js

@@ -1,3 +1,4 @@
+import { npmRegistryOf } from './plugin-source.js';
 export function npmSourceOf(sources) {
     return sources?.find((source) => source.kind === 'npm');
 }
@@ -29,18 +30,22 @@ function packageOf(need) {
 function keyOf(kind, pkg) {
     return `${kind}:${pkg}`;
 }
-function sourceCompatible(left, right) {
+function registryAddressOf(source, env) {
+    const resolved = npmRegistryOf(source, env);
+    return resolved.ok ? resolved.value : undefined;
+}
+function sourceCompatible(left, right, env) {
     if (left.kind !== right.kind)
         return false;
     if (left.kind === 'npm' && right.kind === 'npm') {
         if (text(left.package) !== '' && text(right.package) !== '' && text(left.package) !== text(right.package)) {
             return false;
         }
-        if (text(left.registryEnv) !== text(right.registryEnv))
-            return false;
-        const l = text(left.registryDefault);
-        const r = text(right.registryDefault);
-        return l === '' || r === '' || l === r;
+        const l = registryAddressOf(left, env);
+        const r = registryAddressOf(right, env);
+        if (l !== undefined && r !== undefined)
+            return l === r;
+        return text(left.registryEnv) === text(right.registryEnv);
     }
     if (left.kind === 'git' && right.kind === 'git')
         return text(left.url) === text(right.url);
@@ -49,12 +54,12 @@ function sourceCompatible(left, right) {
     }
     return false;
 }
-function sourcesCompatible(left, right) {
+function sourcesCompatible(left, right, env) {
     if (left.length !== right.length)
         return false;
     return left.every((source, index) => {
         const other = right[index];
-        return other !== undefined && sourceCompatible(source, other);
+        return other !== undefined && sourceCompatible(source, other, env);
     });
 }
 function mergedSource(left, right) {
@@ -69,13 +74,13 @@ function mergedSource(left, right) {
     }
     return left;
 }
-function mergeSources(entry, sources) {
+function mergeSources(entry, sources, env) {
     if (!entry.declared) {
         entry.declared = true;
         entry.sources = [...sources];
         return true;
     }
-    if (!sourcesCompatible(entry.sources, sources)) {
+    if (!sourcesCompatible(entry.sources, sources, env)) {
         entry.conflicted = true;
         return false;
     }
@@ -100,7 +105,8 @@ function addDeclarer(entry, unit, commands) {
         if (!entry.commands.includes(command))
             entry.commands.push(command);
 }
-export function buildSupplyIndex(declarations) {
+export function buildSupplyIndex(declarations, options = {}) {
+    const env = options.env ?? {};
     const entries = new Map();
     const byName = new Map();
     const conflicts = [];
@@ -138,7 +144,7 @@ export function buildSupplyIndex(declarations) {
             else {
                 addDeclarer(entry, declaration.id, []);
             }
-            const same = mergeSources(entry, need.sources ?? []);
+            const same = mergeSources(entry, need.sources ?? [], env);
             if (!same) {
                 conflicts.push({
                     kind: 'source-mismatch',