Files
deepseek-harness/packages/util/plugin-market-index
Turtle 38c7a9fbf4 feat(release): publish package source, declaration maps, and documentation (#5884)
* feat(release): publish package source, declaration maps, and documentation

Every release member publishes its TypeScript source and the declaration
maps that resolve into it, and @deepseek-ai/dsh publishes the repository
Markdown documentation staged from docs/ at prepack time.

The ./src/* export most members already declared now resolves for an
installed consumer, and a consumer editor follows a declaration to the
implementation. Bundled JavaScript maps stay unpublished; the vendored
family and the Desktop runtime file policy are unchanged.

Rationale: .agents/notes/implemented/process/2026-10-08-published-source-and-docs.md

* feat(release): publish JavaScript maps and compress bundles

Every emitted JavaScript map ships beside the bundle it describes, and the
workspace build and the client preset compress bundles without mangling
identifiers.

The documentation payload now mirrors the website publication manifest and
is removed again by `postpack`; Desktop and the Python executable exclude
the published source, documentation, and maps; `clean` removes a staged
copy. Typert's publication contract gains the Remote declaration map.

* fix(release): keep node bundles readable for the worker image

The browser worker image lowers `yield*` only as a whole statement and
rewrites `for await` loops by their source layout, so compressed node-side
entries either fail that lowering or lower to unparseable code. Only the
browser bundles keep compression, which removes about a third of their text.

The bundle-purity assertion now matches the module-loader call regardless of
the quote style compression picks, and the release-pack fixture exercises
the installed package's new documentation requirement.

* feat(release): publish the whole documentation tree

`@deepseek-ai/dsh` copies `docs/` in full instead of the website's page
set: the maintainer documents, the generated migration records, the
translation guidelines, and the `*.i18n.yaml` consistency records ship
with the installed package, so the documentation's own links resolve
without a checkout.

* feat(release): publish the upgrade guides with the documentation

The staged documentation keeps the website's page set and adds every
`docs/upgrade-guide/` document, which is what an installed reader consults
when a released change breaks something. The rest of the maintainer tree
stays out.

* test(release): expect source and maps in master's new payload cases

* feat(release): keep installed docs and source readable in Desktop

Desktop keeps the published src/ and docs/ trees inside app.asar, and
every model shell call receives DSH_INSTALL_DIR and DSH_NODE_EXECUTABLE
so an agent can read them through Electron's Node mode. Staging also
generates docs/upgrade-guide/README.md, an index of the upgrade guides
grouped by the release they upgrade from.

Minified client bundles print string literals with backticks: the
worker image packer now recognizes those chunk requests, client license
banners are prepended after minification so their text survives, and
the affected artifact tests accept either quote.

* test(desktop): read archived docs through the Windows PowerShell form

Regenerate the config catalog for the shifted shell-env source line.

* test(desktop): wait for the GUI-subsystem Electron process from PowerShell

* build(release): publish source and maps from the message-quotes package

* build(release): publish source and maps from packages new on master

* build(release): publish source and maps from the tool-office package
2026-11-05 00:22:36 +08:00
..

description, kind
description kind
Plugin market index format 1 validation and install arguments for DSH readers and index generators. package-library

dsh-plugin-market-index

English | 中文

Summary

Validator without runtime dependencies for format 1 of the plugin market index, the single JSON file that lists installable DSH bundles with their display metadata. The format Agent Note defines the document; this package is its executable rule set. DSH's dsh-plugin-market reads indexes with it, and index generators validate their output with it before publishing.

Table of Contents


Use this package

It is a library, not a service or plugin: no ctx, no registrations, no state, no I/O.

Parse the fetched document as JSON, then pass the value and the URL it was read from to parseMarketIndex. The first violated rule throws MarketIndexError with the JSON path of the offending value. A successful result drops members the format does not define, fills absent metadata groups, keywords, labels, sortKeys, and engines with empty values, orders each plugin's versions by descending SemVer precedence, and replaces each relative icon reference with its absolute URL.

Install one version with marketInstallTarget(name, version): it returns the exact pnpm spec, name@version for npm and a commit-pinned git+https URL with an optional path: parameter for Git, and the registry to ask first when the version names one.


API

import { MarketIndexError, marketInstallTarget, parseMarketIndex } from '@deepseek-ai/dsh-plugin-market-index'
Export Role
parseMarketIndex(value, indexUrl) Validated MarketIndex; throws MarketIndexError for the first violated rule.
marketInstallTarget(name, version) { spec, registry? } that installs that exact version.
MarketIndexError Validation failure carrying path and reason.
MAX_INLINE_ICON_BYTES Largest decoded payload of an inline data: icon, 32 KiB.
MarketIndex, MarketPlugin, MarketVersion, MarketEngines, MarketSource, MarketRepository, MarketIndexMetadata, MarketPluginMetadata, MarketDeclaration, MarketSortKeyDeclaration, MarketInstallTarget Validated record types.

Model Experience

Indirectly, through dsh-plugin-market, whose plugin_market tool returns validated plugins to the model.

KV Cache effect

None of its own. The tool result that carries plugins owns its request's cache behavior.

Known Limitations and Deferred Work

  • Generator obligations are unchecked — the validator cannot verify that name, version, publishTimestamp, engines.dsh, or display fields match the package they describe, or that the package declares a bundle.
  • No size bound — the caller bounds the document before parsing it.

Dev Note

Working context for maintainers — click to expand

None.