@dsh-workbench/shared 1.1.5 → 1.1.7

package/dist/contract/needs.d.ts

@@ -76,12 +76,15 @@ export interface ExtensionNeed extends NeedCommon {
 }
 /**
  * 要在隔离运行时里有一个共用依赖包。
+ * `runs` 写它自己会起哪些运行时的命令（如 `["opencli"]`）—— 写了外壳就把那份执行器注入进去
+ * （库侧约定 `setOpencliRunner`）；不写就按它自己在 PATH 上找。
  */
 export interface LibNeed extends NeedCommon {
     readonly kind: 'lib';
     readonly name: string;
     readonly version?: string;
     readonly sources?: readonly SupplySource[];
+    readonly runs?: readonly string[] | undefined;
 }
 /**
  * 跑起来时要有这个环境变量；`secret` 为真时任何地方都不回显它的值。

package/dist/contract/needs.js

@@ -22,6 +22,7 @@ export const NEED_KEYS = [
     'secret',
     'install',
     'docs',
+    'runs',
 ];
 const SOURCE_KEYS = ['kind', 'package', 'registryEnv', 'registryDefault', 'url', 'ref', 'path', 'env'];
 const REGISTRY_PATTERN = /^(?:https?|file):\/\//;
@@ -149,6 +150,20 @@ export function binInstallProblemsOf(raw, at) {
     }
     return errors;
 }
+function libRunsProblemsOf(raw, at) {
+    if (raw === undefined)
+        return [];
+    if (!Array.isArray(raw))
+        return [`${at}.runs 要是数组`];
+    if (raw.length === 0)
+        return [`${at}.runs 是空数组 —— 不自己跑命令就整条删掉`];
+    const names = raw.map((one) => text(one));
+    if (names.some((one) => one === ''))
+        return [`${at}.runs 里有空字符串`];
+    if (new Set(names).size !== names.length)
+        return [`${at}.runs 里有重复的运行时`];
+    return [];
+}
 function perKindProblemsOf(kind, raw, at) {
     const errors = [];
     if (kind === 'bin' || kind === 'lib' || kind === 'env') {
@@ -159,6 +174,8 @@ function perKindProblemsOf(kind, raw, at) {
         errors.push(...binInstallProblemsOf(raw['install'], at));
     if (raw['docs'] !== undefined && text(raw['docs']) === '')
         errors.push(`${at}.docs 是空串`);
+    if (kind === 'lib')
+        errors.push(...libRunsProblemsOf(raw['runs'], at));
     if (kind === 'extension') {
         if (text(raw['runtime']) === '')
             errors.push(`${at}.runtime 没写 —— 扩展属于哪个运行时（如 opencli）`);

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

@@ -1,4 +1,6 @@
 export declare const MARKET_INDEX_FORMAT = 1;
+export declare const MARKET_INDEX_DIR = "market";
+export declare const MARKET_ARTIFACTS_DIR = "artifacts";
 export declare const MARKET_INDEX_PATH = "market.json";
 export declare const MARKET_DISCOVER_ROUTE = "panels/market-discover";
 export declare const MARKET_DOC_ROUTE = "panels/market-doc";
@@ -111,7 +113,7 @@ export interface MarketIndex {
     readonly metadata?: MarketIndexMetadata;
     readonly plugins: readonly MarketIndexEntry[];
 }
-export type MarketIndexProblemKind = 'not-json' | 'not-object' | 'format' | 'plugins' | 'plugin' | 'name' | 'duplicate-name' | 'versions' | 'version' | 'version-order' | 'source' | 'git-commit' | 'timestamp' | 'icon' | 'owner' | 'unit';
+export type MarketIndexProblemKind = 'not-json' | 'not-object' | 'format' | 'plugins' | 'plugin' | 'entry' | 'name' | 'duplicate-name' | 'versions' | 'version' | 'version-order' | 'duplicate-version' | 'source' | 'git-commit' | 'timestamp' | 'icon' | 'owner' | 'unit';
 export interface MarketIndexProblem {
     readonly kind: MarketIndexProblemKind;
     readonly detail: string;

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

@@ -1,4 +1,6 @@
 export const MARKET_INDEX_FORMAT = 1;
+export const MARKET_INDEX_DIR = 'market';
+export const MARKET_ARTIFACTS_DIR = 'artifacts';
 export const MARKET_INDEX_PATH = 'market.json';
 export const MARKET_DISCOVER_ROUTE = 'panels/market-discover';
 export const MARKET_DOC_ROUTE = 'panels/market-doc';

package/dist/host/lib-runners.d.ts

@@ -0,0 +1,20 @@
+import type { LibReader } from '../contract/lib.js';
+import type { OpencliRunner } from './opencli-runner.js';
+export interface LibRuntimes {
+    readonly opencli?: OpencliRunner | undefined;
+}
+interface Logger {
+    warn?(message: string): void;
+}
+/**
+ * 给声明了 `runs` 的 lib 注入「跑这个运行时」的执行器：库侧按约定暴露 `setOpencliRunner`
+ * （运行时名字首字母大写 + `Runner`），外壳在每次 `load` 之后把执行器交给它。
+ *
+ * 没暴露的（版本旧）就保持它自己的行为（按 PATH 找），只记一条 warn；不熟悉的运行时同样只 warn。
+ * @param libs 原来的读库口。
+ * @param runtimes 外壳手上有的执行器，按运行时名字给。
+ * @param logger 记 warn 的地方（默认不记）。
+ * @returns 包好的读库口；`load` 的签名与返回不变。
+ */
+export declare function withLibRunners(libs: LibReader, runtimes: LibRuntimes, logger?: Logger): LibReader;
+export {};

package/dist/host/lib-runners.js

@@ -0,0 +1,46 @@
+function runnerOf(runtimes, runtime) {
+    return runtime === 'opencli' ? runtimes.opencli : undefined;
+}
+function setterNameOf(runtime) {
+    return `set${runtime.charAt(0).toUpperCase()}${runtime.slice(1)}Runner`;
+}
+/**
+ * 给声明了 `runs` 的 lib 注入「跑这个运行时」的执行器：库侧按约定暴露 `setOpencliRunner`
+ * （运行时名字首字母大写 + `Runner`），外壳在每次 `load` 之后把执行器交给它。
+ *
+ * 没暴露的（版本旧）就保持它自己的行为（按 PATH 找），只记一条 warn；不熟悉的运行时同样只 warn。
+ * @param libs 原来的读库口。
+ * @param runtimes 外壳手上有的执行器，按运行时名字给。
+ * @param logger 记 warn 的地方（默认不记）。
+ * @returns 包好的读库口；`load` 的签名与返回不变。
+ */
+export function withLibRunners(libs, runtimes, logger) {
+    const warned = new Set();
+    const warnOnce = (key, message) => {
+        if (warned.has(key))
+            return;
+        warned.add(key);
+        logger?.warn?.(message);
+    };
+    return {
+        async load(need, entry) {
+            const module = await libs.load(need, entry);
+            for (const runtime of need.runs ?? []) {
+                const runner = runnerOf(runtimes, runtime);
+                if (runner === undefined) {
+                    warnOnce(`${need.name}:${runtime}:unsupported`, `[dsh-workbench] ${need.name} 声明了自己会跑 ${runtime}，但工作台没有这个执行器 —— 它会按自己的方式找`);
+                    continue;
+                }
+                const setter = typeof module === 'object' && module !== null
+                    ? module[setterNameOf(runtime)]
+                    : undefined;
+                if (typeof setter !== 'function') {
+                    warnOnce(`${need.name}:${entry}:${runtime}:missing`, `[dsh-workbench] ${need.name} 声明了自己会跑 ${runtime}，但这一版没有 ${setterNameOf(runtime)} —— 它会按 PATH 找`);
+                    continue;
+                }
+                setter.call(module, runner);
+            }
+            return module;
+        },
+    };
+}

package/dist/host/market-index-claim.d.ts

@@ -14,5 +14,7 @@ export interface MarketClaimInput {
     readonly artifactPath?: string | undefined;
 }
 export declare function marketArtifactPath(name: string): string;
+export declare function marketArtifactRoot(name: string): string;
+export declare function marketArtifactPathFor(name: string, version: string): string;
 export declare function entryUnitOf(entry: MarketIndexEntry): string | undefined;
 export declare function claimOf(index: MarketIndex, input: MarketClaimInput): MarketClaim;

package/dist/host/market-index-claim.js

@@ -1,3 +1,4 @@
+import { MARKET_ARTIFACTS_DIR } from '../contract/protocol/market-index.js';
 function foldedName(name) {
     return name.replace(/\s+/gu, ' ').trim().toLowerCase();
 }
@@ -41,6 +42,12 @@ export function claimOfEntry(entry, publisher) {
 export function marketArtifactPath(name) {
     return `packages/${name}`;
 }
+export function marketArtifactRoot(name) {
+    return `${MARKET_ARTIFACTS_DIR}/${name}`;
+}
+export function marketArtifactPathFor(name, version) {
+    return `${MARKET_ARTIFACTS_DIR}/${name}/${version}`;
+}
 export function entryUnitOf(entry) {
     const unit = entry.metadata?.unit?.trim();
     if (unit !== undefined && unit !== '')

package/dist/host/market-index-doc.d.ts

@@ -0,0 +1,56 @@
+import type { MarketIndex, MarketIndexEngines, MarketIndexEntryMetadata, MarketIndexProblem, MarketIndexSource, MarketLocalizedText } from '../contract/protocol/market-index.js';
+export interface MarketVersionDoc {
+    readonly name: string;
+    readonly version: string;
+    readonly source: MarketIndexSource;
+    readonly publishTimestamp?: number;
+    readonly engines?: MarketIndexEngines;
+    readonly title?: MarketLocalizedText;
+    readonly description?: MarketLocalizedText;
+    readonly author?: string;
+    readonly owner?: string;
+    readonly homepage?: string;
+    readonly icon?: string;
+    readonly metadata?: MarketIndexEntryMetadata;
+}
+export interface MarketMetaDoc {
+    readonly name: string;
+    readonly epoch?: number;
+    readonly publishTimestamp: number;
+    readonly title?: MarketLocalizedText;
+    readonly description?: MarketLocalizedText;
+    readonly author?: string;
+    readonly owner?: string;
+    readonly homepage?: string;
+    readonly icon?: string;
+    readonly metadata?: MarketIndexEntryMetadata;
+}
+export type MarketEntryDoc = MarketVersionDoc | MarketMetaDoc;
+export type MarketEntryDocParse = {
+    readonly ok: true;
+    readonly doc: MarketEntryDoc;
+} | {
+    readonly ok: false;
+    readonly problems: readonly MarketIndexProblem[];
+};
+export interface MarketEntryFile {
+    readonly path: string;
+    readonly text: string;
+}
+export type MarketIndexAssemble = {
+    readonly ok: true;
+    readonly index: MarketIndex;
+} | {
+    readonly ok: false;
+    readonly problems: readonly MarketIndexProblem[];
+};
+export interface MarketDocFields {
+    readonly name: string;
+    readonly title?: MarketLocalizedText;
+    readonly description?: MarketLocalizedText;
+    readonly author?: string;
+    readonly owner?: string;
+    readonly homepage?: string;
+    readonly icon?: string;
+    readonly metadata?: MarketIndexEntryMetadata;
+}

package/dist/host/market-index-doc.js

@@ -0,0 +1 @@
+export {};

package/dist/host/market-index-parse.d.ts

@@ -0,0 +1,23 @@
+import type { DiscoverFilter, IndexSourceSpec, MarketIndex, MarketIndexEntry, MarketIndexParse, MarketIndexProblem, MarketIndexVersion, MarketSourceConfig } from '../contract/protocol/market-index.js';
+import type { MarketEntryDocParse } from './market-index-doc.js';
+export declare function compareSemver(left: string, right: string): number | undefined;
+export declare function httpUrlProblem(url: string): string | undefined;
+export declare function gitUrlOk(url: string): boolean;
+export declare function parseMarketIndex(raw: unknown): MarketIndexParse;
+export declare function parseMarketIndexJson(text: string): MarketIndexParse;
+export declare function sortMarketVersions(versions: readonly MarketIndexVersion[]): MarketIndexVersion[];
+export declare function upsertMarketEntry(index: MarketIndex, entry: MarketIndexEntry): MarketIndex;
+export declare function marketEntryLabels(entry: MarketIndexEntry): readonly string[];
+export declare function filterMarketIndex(index: MarketIndex, filter: DiscoverFilter): readonly MarketIndexEntry[];
+export declare function marketSourceKey(source: IndexSourceSpec): string;
+export type SourceConfigParse = {
+    readonly ok: true;
+    readonly source: MarketSourceConfig;
+} | {
+    readonly ok: false;
+    readonly problem: MarketIndexProblem;
+};
+export declare function parseSourceConfig(raw: unknown): SourceConfigParse;
+export declare function parseMarketEntryDoc(raw: unknown): MarketEntryDocParse;
+export declare function marketEntryPath(dir: string, name: string, version: string): string;
+export declare function marketMetaPath(dir: string, name: string, epoch: number, suffix: string): string;