@dsh-workbench/shared 1.1.1 → 1.1.3

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

@@ -2,11 +2,17 @@ export declare const MARKET_INDEX_FORMAT = 1;
 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";
+export declare const MARKET_GIT_PROBE_ROUTE = "panels/git-probe";
 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 GitProbeStatus = 'ok' | 'auth' | 'unreachable';
+export interface GitProbePayload {
+    readonly status: GitProbeStatus;
+    readonly detail?: string;
+}
 export type MarketSourcePolicy = 'artifacts-in-repo' | 'catalog-only';
 export interface IndexSourceSpec {
     readonly kind: MarketSourceKind;
@@ -45,6 +51,8 @@ export interface MarketIndexVersion {
     readonly engines?: MarketIndexEngines;
 }
 export interface MarketIndexEntryMetadata {
+    readonly workbench?: boolean;
+    readonly unit?: string;
     readonly category?: string;
     readonly labels?: readonly string[];
     readonly keywords?: readonly string[];
@@ -55,11 +63,31 @@ export interface MarketIndexEntry {
     readonly title?: MarketLocalizedText;
     readonly description?: MarketLocalizedText;
     readonly author?: string;
+    readonly owner?: string;
     readonly homepage?: string;
     readonly icon?: string;
     readonly metadata?: MarketIndexEntryMetadata;
     readonly versions: readonly MarketIndexVersion[];
 }
+export type MarketClaim = {
+    readonly state: 'new';
+} | {
+    readonly state: 'owned';
+    readonly owner: string;
+} | {
+    readonly state: 'unowned';
+} | {
+    readonly state: 'conflict';
+    readonly owner: string;
+} | {
+    readonly state: 'unit-taken';
+    readonly entry: string;
+} | {
+    readonly state: 'path-taken';
+    readonly entry: string;
+} | {
+    readonly state: 'unknown';
+};
 export interface MarketIndexCategory {
     readonly title?: MarketLocalizedText;
 }
@@ -82,7 +110,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';
+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 interface MarketIndexProblem {
     readonly kind: MarketIndexProblemKind;
     readonly detail: string;
@@ -158,6 +186,7 @@ export interface PublishChangelog {
     readonly version: string;
     readonly text?: string;
     readonly missing?: boolean;
+    readonly pending?: boolean;
 }
 export interface PublishPreview {
     readonly name: string;
@@ -165,6 +194,7 @@ export interface PublishPreview {
     readonly author?: string;
     readonly registry?: string;
     readonly market?: MarketPublishDestination;
+    readonly claim?: MarketClaim;
     readonly changelog?: PublishChangelog;
 }
 export type DiscoverDocKind = 'readme' | 'changelog';
@@ -194,4 +224,8 @@ export type MarketSourcesAction = {
     readonly action: 'init';
     readonly id: string;
     readonly ref?: string;
+    readonly stampOnly?: boolean;
+} | {
+    readonly action: 'read-only';
+    readonly id: string;
 };

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

@@ -2,6 +2,7 @@ export const MARKET_INDEX_FORMAT = 1;
 export const MARKET_INDEX_PATH = 'market.json';
 export const MARKET_DISCOVER_ROUTE = 'panels/market-discover';
 export const MARKET_DOC_ROUTE = 'panels/market-doc';
+export const MARKET_GIT_PROBE_ROUTE = 'panels/git-probe';
 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';

package/dist/host/changelog.d.ts

@@ -19,3 +19,10 @@ export declare function parseChangelog(text: string): readonly ChangelogSection[
 export declare function changelogSectionOf(text: string, version: string): string | undefined;
 export declare function changelogHasEntry(text: string, version: string): boolean;
 export declare function appendChangelogEntry(text: string, options: ChangelogEntryOptions): string;
+export interface ChangelogPlan {
+    readonly action: 'kept' | 'written';
+    readonly version: string;
+    readonly text: string;
+    readonly section: string;
+}
+export declare function planChangelog(text: string, options: ChangelogEntryOptions): ChangelogPlan | undefined;

package/dist/host/changelog.js

@@ -177,6 +177,18 @@ export function appendChangelogEntry(text, options) {
     out.splice(at, 0, ...bullets);
     return `${normalizeWhitespace(out)}\n`;
 }
+export function planChangelog(text, options) {
+    const source = normalizeChangelogText(text);
+    const version = changelogVersion(options.version);
+    const section = changelogSectionOf(source, version);
+    if (section !== undefined && changelogHasEntry(source, version)) {
+        return { action: 'kept', version, text: source, section };
+    }
+    if (bulletsOf(options.note).length === 0)
+        return undefined;
+    const next = appendChangelogEntry(source, options);
+    return { action: 'written', version, text: next, section: changelogSectionOf(next, version) ?? '' };
+}
 function normalizeWhitespace(rows) {
     const out = [];
     for (const row of rows) {

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

@@ -0,0 +1,18 @@
+import type { MarketClaim, MarketIndex, MarketIndexEntry } from '../contract/protocol/market-index.js';
+export interface PublisherIdentity {
+    readonly name: string;
+    readonly email?: string;
+}
+export declare function publisherIdentityOf(text: string | undefined): PublisherIdentity | undefined;
+export declare function samePublisher(left: string, right: string): boolean;
+export declare function entryOwnerOf(entry: MarketIndexEntry): string | undefined;
+export declare function claimOfEntry(entry: MarketIndexEntry | undefined, publisher: string | undefined): MarketClaim;
+export interface MarketClaimInput {
+    readonly name: string;
+    readonly publisher: string | undefined;
+    readonly unit?: string | undefined;
+    readonly artifactPath?: string | undefined;
+}
+export declare function marketArtifactPath(name: 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

@@ -0,0 +1,83 @@
+function foldedName(name) {
+    return name.replace(/\s+/gu, ' ').trim().toLowerCase();
+}
+export function publisherIdentityOf(text) {
+    const raw = (text ?? '').trim();
+    if (raw === '')
+        return undefined;
+    const match = /^(.*?)\s*<([^<>]*)>\s*$/u.exec(raw);
+    const name = (match === null ? raw : match[1]).trim();
+    const email = match === null ? '' : match[2].trim().toLowerCase();
+    if (name === '')
+        return undefined;
+    return email === '' ? { name } : { name, email };
+}
+export function samePublisher(left, right) {
+    const a = publisherIdentityOf(left);
+    const b = publisherIdentityOf(right);
+    if (a === undefined || b === undefined)
+        return false;
+    if (a.email !== undefined && b.email !== undefined)
+        return a.email === b.email;
+    return foldedName(a.name) === foldedName(b.name);
+}
+export function entryOwnerOf(entry) {
+    const owner = (entry.owner ?? '').trim();
+    if (owner !== '')
+        return owner;
+    const author = (entry.author ?? '').trim();
+    return author === '' ? undefined : author;
+}
+export function claimOfEntry(entry, publisher) {
+    if (entry === undefined)
+        return { state: 'new' };
+    const owner = entryOwnerOf(entry);
+    if (owner === undefined)
+        return { state: 'unowned' };
+    if (publisher === undefined || publisher.trim() === '')
+        return { state: 'unknown' };
+    return samePublisher(owner, publisher) ? { state: 'owned', owner } : { state: 'conflict', owner };
+}
+export function marketArtifactPath(name) {
+    return `packages/${name}`;
+}
+export function entryUnitOf(entry) {
+    const unit = entry.metadata?.unit?.trim();
+    if (unit !== undefined && unit !== '')
+        return unit;
+    for (const version of entry.versions) {
+        if (version.source.type !== 'git')
+            continue;
+        const match = /^packages\/([^/]+)$/u.exec(version.source.path ?? '');
+        const legacy = match?.[1];
+        if (legacy !== undefined)
+            return legacy;
+    }
+    return undefined;
+}
+export function claimOf(index, input) {
+    const base = claimOfEntry(index.plugins.find((one) => one.name === input.name), input.publisher);
+    if (base.state === 'conflict' || base.state === 'unknown')
+        return base;
+    const unit = (input.unit ?? '').trim();
+    if (unit !== '') {
+        for (const other of index.plugins) {
+            if (other.name === input.name)
+                continue;
+            if (entryUnitOf(other) !== unit)
+                continue;
+            return { state: 'unit-taken', entry: other.name };
+        }
+    }
+    const path = (input.artifactPath ?? '').trim();
+    if (path !== '') {
+        for (const other of index.plugins) {
+            if (other.name === input.name)
+                continue;
+            if (!other.versions.some((one) => one.source.type === 'git' && (one.source.path ?? '') === path))
+                continue;
+            return { state: 'path-taken', entry: other.name };
+        }
+    }
+    return base;
+}

package/dist/host/market-index.js

@@ -17,7 +17,10 @@ export const MARKET_INDEX_README_LINES = [
     'dsh-wb-module release --index <本仓库地址> --index-policy artifacts-in-repo',
     '```',
     '',
-    '产物会提交到 `packages/<unit>/`，并更新 `market.json`。',
+    '产物会提交到 `packages/<包名>/`（带 scope 时是 `packages/@scope/名字/`），并更新 `market.json`。',
+    '',
+    '一个包名归第一次发布的人（`market.json` 里的 `owner`）。换一个署名发同名会被拒；要换人，先把这一条的 `owner` 改成新的人。',
+    '同一个市场里，一个模块 id（`metadata.unit`）只能被一个条目使用；另一个包名想用同一个 id / 产物目录也会被拒。',
     '',
     '## 使用这个索引',
     '',
@@ -137,10 +140,21 @@ function iconProblem(icon) {
         return undefined;
     return problem('icon', 'icon 只能是 base64 data URL 或 http(s) URL');
 }
+const MAX_OWNER_CHARS = 200;
+const UNIT_ID = /^[a-z][a-z0-9-]*$/;
+function ownerProblem(owner) {
+    if (/[\r\n]/u.test(owner))
+        return problem('owner', 'owner 只能是一行署名');
+    if (owner.length > MAX_OWNER_CHARS)
+        return problem('owner', 'owner 超过 200 字');
+    return undefined;
+}
 function metadataOf(raw) {
     const record = asRecord(raw);
     if (record === undefined)
         return undefined;
+    const workbench = record['workbench'] === true;
+    const unit = asText(record['unit']);
     const category = asText(record['category']);
     const labels = asTextArray(record['labels']);
     const keywords = asTextArray(record['keywords']);
@@ -149,6 +163,8 @@ function metadataOf(raw) {
         ? undefined
         : Object.fromEntries(Object.entries(sortKeysRecord).flatMap(([key, value]) => typeof value === 'string' || typeof value === 'number' ? [[key, value]] : []));
     return {
+        ...(workbench ? { workbench: true } : {}),
+        ...(unit === '' ? {} : { unit }),
         ...(category === '' ? {} : { category }),
         ...(labels.length === 0 ? {} : { labels }),
         ...(keywords.length === 0 ? {} : { keywords }),
@@ -175,14 +191,24 @@ function entryOf(raw, at) {
     const title = asLocalized(record['title']);
     const description = asLocalized(record['description']);
     const author = asText(record['author']);
+    const owner = asText(record['owner']);
+    if (owner !== '') {
+        const badOwner = ownerProblem(owner);
+        if (badOwner !== undefined)
+            return badOwner;
+    }
     const homepage = asText(record['homepage']);
     const metadata = metadataOf(record['metadata']);
+    if (metadata?.unit !== undefined && !UNIT_ID.test(metadata.unit)) {
+        return problem('unit', `metadata.unit 只能是小写字母开头的 a-z0-9-（现在是 ${JSON.stringify(metadata.unit)}）`, at);
+    }
     return {
         name,
         versions,
         ...(title === undefined ? {} : { title }),
         ...(description === undefined ? {} : { description }),
         ...(author === '' ? {} : { author }),
+        ...(owner === '' ? {} : { owner }),
         ...(homepage === '' ? {} : { homepage }),
         ...(icon === '' ? {} : { icon }),
         ...(metadata === undefined ? {} : { metadata }),
@@ -259,8 +285,14 @@ export function upsertMarketEntry(index, entry) {
         merged.set(one.version, one);
     for (const one of entry.versions)
         merged.set(one.version, one);
+    const owner = current.owner ?? entry.owner;
     const plugins = [...index.plugins];
-    plugins[found] = { ...current, ...entry, versions: sortMarketVersions([...merged.values()]) };
+    plugins[found] = {
+        ...current,
+        ...entry,
+        ...(owner === undefined ? {} : { owner }),
+        versions: sortMarketVersions([...merged.values()]),
+    };
     return { ...index, plugins };
 }
 export function marketEntryLabels(entry) {

package/dist/host.d.ts

@@ -15,6 +15,7 @@ export * from './contract/long-task.js';
 export * from './lib/text.js';
 export * from './lib/ui.js';
 export * from './lib/board-fact.js';
+export * from './lib/git-address.js';
 export * from './api/blocker-table.js';
 export * from './contract/unit-declaration.js';
 export * from './host/board-fact.js';
@@ -72,4 +73,5 @@ export * from './host/extension.js';
 export * from './host/port-types.js';
 export * from './host/version-range.js';
 export * from './host/market-index.js';
+export * from './host/market-index-claim.js';
 export * from './host/changelog.js';

package/dist/host.js

@@ -15,6 +15,7 @@ export * from './contract/long-task.js';
 export * from './lib/text.js';
 export * from './lib/ui.js';
 export * from './lib/board-fact.js';
+export * from './lib/git-address.js';
 export * from './api/blocker-table.js';
 export * from './contract/unit-declaration.js';
 export * from './host/board-fact.js';
@@ -72,4 +73,5 @@ export * from './host/extension.js';
 export * from './host/port-types.js';
 export * from './host/version-range.js';
 export * from './host/market-index.js';
+export * from './host/market-index-claim.js';
 export * from './host/changelog.js';

package/dist/i18n/en.js

@@ -248,6 +248,7 @@ export const en = {
     'panels.market.add.failurePnpmMissing': 'pnpm was not found, cannot install',
     'panels.market.add.failureInstalled': 'It is already installed in this workbench. The same package cannot be installed over itself: uninstall it first, then install again. The uninstall did not succeed this time.',
     'panels.market.add.failureGeneric': 'Something went wrong during install — see the install details',
+    'panels.market.add.failureCredentials': 'This repository needs credentials: this machine has none for it. Clone it once in a terminal, set up a credential helper, or install from the SSH address.',
     'panels.market.add.approveTitle': 'Your approval is needed for install scripts',
     'panels.market.add.approveCaution': 'Only allow packages you trust: install scripts run on this machine with your permissions.',
     'panels.market.add.approveRun': 'Allow and continue installing',
@@ -289,10 +290,16 @@ export const en = {
     'panels.discover.addingSource': 'Adding…',
     'panels.discover.addFirstSource': 'Add index source',
     'panels.discover.removeSource': 'Remove',
-    'panels.discover.removeSourceNamed': 'Remove {url}',
-    'panels.discover.useSource': 'Use',
-    'panels.discover.useSourceNamed': 'Use {label}',
-    'panels.discover.sourceCurrent': 'In use',
+    'panels.discover.removeTitle': 'Remove this index source?',
+    'panels.discover.removeBody': '"{label}" will be removed from this list; the repository itself is not deleted, and you can add it back later.',
+    'panels.discover.sourceActions': 'Actions for {label}',
+    'panels.discover.sourceStateWritable': 'Publish target',
+    'panels.discover.sourceStateReadOnly': 'Read-only list',
+    'panels.discover.sourceEnable': 'Set up for publishing',
+    'panels.discover.sourceDisable': 'Set to read-only',
+    'panels.discover.sourceWorking': 'Updating…',
+    'panels.discover.sourceEnabled': '"{label}" is ready for publishing',
+    'panels.discover.sourceReadOnly': '"{label}" is now read-only',
     'panels.discover.refresh': 'Refresh',
     'panels.discover.search': 'Search modules',
     'panels.discover.clearSearch': 'Clear search',
@@ -314,12 +321,13 @@ export const en = {
     'panels.discover.noSourceHint': 'Add a module market index (http address or git repository) to browse and install its modules here',
     'panels.discover.sourcesFailed': 'Could not read the index sources.',
     'panels.discover.unreadable': 'Could not read this index.',
+    'panels.discover.sourceAuth': 'This index source could not be read: this machine has no git credentials for it. Set up credentials (or switch the source to its SSH address), then refresh.',
     'panels.discover.invalid': 'This index is not in a valid format.',
     'panels.discover.emptyRepo': 'This repository has no commits yet.',
     'panels.discover.missingIndex': 'This repository has no {path} yet.',
     'panels.discover.initTitle': 'Initialize this repository as a module market index?',
     'panels.discover.initCta': 'Initialize market index',
-    'panels.discover.initWhat': 'It will write market.json and README.md on {branch}, commit once, and push. Modules you publish from this workbench will commit their build files under packages/<unit>/. The repository stays owned by its owner.',
+    'panels.discover.initWhat': 'It will write market.json and README.md on {branch}, commit once, and push. Modules you publish from this workbench will commit their build files under packages/<package-name>/. The repository stays owned by its owner.',
     'panels.discover.initBranch': 'Branch',
     'panels.discover.initBranchHint': 'The index and build files go to this branch; an empty repository gets it created.',
     'panels.discover.initBranchBad': 'Use only letters, digits, dots, underscores, slashes, or dashes in a branch name.',
@@ -337,8 +345,23 @@ export const en = {
     'panels.discover.badShellDetail': 'This version is not compatible with the running workbench {current}; it requires {peer}',
     'panels.discover.unverified': 'Workbench unverified',
     'panels.discover.installing': 'Installing…',
+    'panels.discover.installingNamed': 'Installing {name}…',
+    'panels.discover.cancelInstall': 'Cancel install',
+    'panels.discover.cancelling': 'Cancelling…',
+    'panels.discover.installCancelled': 'Install cancelled: {name}',
     'panels.discover.installedDone': 'Installed: {name}',
     'panels.discover.failed': 'Failed: {reason}',
+    'panels.discover.transportTitle': 'Where to read this repository',
+    'panels.discover.transportSsh': 'SSH',
+    'panels.discover.transportHttps': 'HTTPS',
+    'panels.discover.transportOk': 'Readable',
+    'panels.discover.transportAuth': 'Needs credentials',
+    'panels.discover.transportUnreachable': 'Unreachable',
+    'panels.discover.transportUnknown': 'Not probed',
+    'panels.discover.transportChecking': 'Checking…',
+    'panels.discover.transportTest': 'Test this address',
+    'panels.discover.transportPlaceholder': 'Or paste another address (mirror, alias)',
+    'panels.discover.transportNeedsAuth': 'This repository needs credentials: clone it once in a terminal, or set up an SSH key / credential helper, then install again.',
     'panels.discover.expand': 'Show versions',
     'panels.discover.collapse': 'Hide versions',
     'panels.discover.versionCount': '{n} versions',
@@ -629,6 +652,13 @@ export const en = {
     'approval.publish.version': 'Version',
     'approval.publish.author': 'Author',
     'approval.publish.authorMissing': 'unsigned',
+    'approval.publish.owner': 'Owner',
+    'approval.publish.ownerUnowned': 'originally unattributed',
+    'approval.publish.ownerTaken': 'Owned by {owner}',
+    'approval.publish.unit': 'Module id',
+    'approval.publish.unitTaken': 'Taken by {entry}',
+    'approval.publish.path': 'Artifact dir',
+    'approval.publish.pathTaken': 'Taken by {entry}',
     'approval.publish.registry': 'Registry',
     'approval.publish.repo': 'Repository',
     'approval.publish.branch': 'Branch',
@@ -639,6 +669,7 @@ export const en = {
     'approval.publish.twoCommits': 'build files + market.json in 2 commits, one push',
     'approval.publish.reading': 'Reading…',
     'approval.publish.changelog': 'Changelog for {version}',
+    'approval.publish.changelogPending': 'This release writes the {version} changelog entry',
     'approval.publish.changelogMissing': 'No changelog entry for {version}; publishing will be blocked',
     'approval.publish.targetAuto': 'configured default',
     'approval.publish.targetTeam': 'team registry',
@@ -647,6 +678,15 @@ export const en = {
     'approval.publish.targetGit': 'git repository',
     'approval.publish.targetMarket': 'module market index',
     'approval.publish.targetLocal': 'keep local',
+    'approval.market.source': 'Index source',
+    'approval.market.url': 'URL',
+    'approval.market.action': 'This action',
+    'approval.market.policy': 'Current state',
+    'approval.market.enable': 'make it publishable',
+    'approval.market.disable': 'make it read-only',
+    'approval.market.writable': 'publishable',
+    'approval.market.readOnly': 'read-only module list',
+    'approval.market.reading': 'Reading…',
     'markdown.copy': 'Copy',
     'markdown.copied': 'Copied',
     'markdown.footnotes': 'Footnotes',