* 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
description, kind
| description | kind |
|---|---|
| Shared TypeScript declarations for package identity, runtime requirements, and DSH plugin metadata. | package-library |
@deepseek-ai/dsh-package-manifest
English | 中文
Summary
Use DshPackageManifest for package metadata, DshManifest for the public fields under dsh, and member types such as DshClientManifest for one domain. Each reader owns JSON parsing, validation, and default resolution.
Table of Contents
- Use this package
- Understand the implementation
- Further Exploration
- Model Experience
- Known Limitations and Deferred Work
- Dev Note
Use this package
Import from the package root. Use a development dependency when only checking your own source; use a production dependency if your published declarations reference these types.
import type { DshClientManifest, DshPackageManifest } from '@deepseek-ai/dsh-package-manifest'
const client: DshClientManifest = { platform: 'web' }
const manifest: DshPackageManifest = {
name: 'example-dsh-plugin',
version: '1.0.0',
engines: { node: '>=24', dsh: '0.1.5-alpha.1' },
dsh: {
manifestVersion: 1,
bundle: { patch: './cordis.patch.yml' },
client,
},
}
DshPackageManifest describes the package.json fields used by DSH, with required name and version; it includes dependency, peer, and optional dependency declarations but is not an exhaustive npm schema. Local profile readers use Partial<DshPackageManifest> because profiles need no published version. DshManifest describes only public author fields under dsh. DshBundleManifest.patch is one patch file path or an ordered list of them, each relative to the package root; the launcher applies a list in order as one bundle layer. TypeScript checks the example and erases import type; these interfaces do not parse JSON or write a file.
DshBundleManifest.listedByDefault is an optional boolean, defaulting to true. False hides an installation-carried bundle from the default GUI lists until the profile enables or installs it; the management inventory remains complete. Plugin Manager owns the display and explicit activation paths.
The following metadata fields are optional. Omitting them leaves the format version or compatible host versions undeclared; readers do not infer defaults.
| Field | Meaning |
|---|---|
dsh.manifestVersion |
Manifest format identifier; the declared format is 1, independent of the npm package version and Session format version. |
dsh.bundle.platforms |
Optional nonempty list of Node Host platform names, such as ["darwin"]; omission allows every operating system. The launcher and plugin manager enforce it before composing or selecting the bundle. |
engines.dsh |
Author-declared compatible DSH versions as a SemVer range, including exact prerelease versions. This field sits beside engines.node and engines.npm; an engines object may omit dsh. |
LocalizedText carries literal text or a language map with a required English fallback. PluginLocalizedMeta carries optional display title, description, an image data URL resolved from a package root's package.json.icon or an exported <specifier>/icon, and metadata diagnostics for installed plugins. App boot reads these values; this package only supplies their types.
Public composition declarations are defined in src/types.ts. Internal configTrees, sessionFormatMigration, and generated moduleFallback metadata remain owned by their image-packer, catalog, and launcher readers; the public types do not expose them.
Understand the implementation
Implementation internals — click to expand
The package root only re-exports declarations from src/types.ts.
Further Exploration
- Profile launcher — manifest loading and composition.
- Public package metadata — field placement and reader ownership.
Model Experience
None, as this package only exports types.
KV Cache effect
Type declarations add no model input, so provider cache reuse is unaffected.
Known Limitations and Deferred Work
- Static typing only. Consumers read and validate the JSON fields they use, then adapt the shared declarations to their runtime data. The package supplies no parser, getter helpers, file checks, or defaults.
- Compatibility is declarative. Current installers and loaders do not enforce
dsh.manifestVersionorengines.dsh; declaring a range does not reject incompatible hosts or validate SemVer syntax.
Dev Note
Working context for maintainers — click to expand
None.