Files
deepseek-harness/packages/util/workspace-path
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
Browser-safe Workspace path helpers for joining relative paths, abbreviating POSIX homes, and deriving display titles. package-library

dsh-util-workspace-path

English | 中文

Summary

Browser-safe path helpers shared by Workspace-facing client and controller packages. The package joins Workspace-relative paths, abbreviates POSIX home directories for display, derives Workspace titles from POSIX or Windows paths, splits a path into its directories and final segment for display, and owns the dsh-resource://file/… address grammar that names a workspace file across the Sidebar and the resource model. relativizeToCwd removes the workspace prefix for display while preserving paths outside that directory. It has no Cordis service or runtime state.

Table of Contents


File addresses

A resource address is dsh-resource://<type>/…, and the type — the URI host — is the resource protocol key (file, or one a plugin declares in ResourceProtocolMap); any other scheme is a navigation protocol, defined elsewhere. dsh-resource://file/session/<sessionId>/<path> names the Session that authorizes the Host read and a workspace-relative or absolute path. Leading slashes remain part of the path: /etc/hosts is dsh-resource://file/session/s//etc/hosts, a Windows drive is dsh-resource://file/session/s/C:/x/y.txt, and UNC is dsh-resource://file/session/s///server/share/y.txt. The Host resolves paths and enforces access. The absolute/<path> form remains parseable but carries no authorizing Session, so the file provider cannot read it and Preview does not claim it; neither current nor Tab Session is borrowed. The grammar lives in src/file-address.ts; the path helpers stay in src/index.ts, which re-exports it.

sessionFileAddress(sessionId, path) normalizes \ to / and drops leading ./, but preserves leading / characters. Every id and path segment is component-encoded with : kept literal. fileAddressFor(sessionId, cwd, path) always builds a Session address: paths inside cwd become relative; other absolute paths, including when cwd is unknown, stay absolute within that Session address. absoluteFileAddress(absolutePath) builds only the Session-less form. parseFileAddress(address) checks the exact file-address prefix, ignores query and fragment suffixes, decodes each segment, and returns { scope, sessionId, path } for a Session address or { scope, path } for the Session-less form. Another type or scheme, an unknown scope, a missing id or path, or a malformed escape returns undefined.

fileMediaUrl(base, path) builds an authenticated file-route URL from an already-decoded absolute path. It accepts HTTP(S) application bases and the Desktop dsh-app://app/ origin, preserves literal percent signs and deployment prefixes, and rejects other application bases, relative paths, network-path prefixes, and control characters. Markdown owners decode authored URLs before calling it; native file-card paths are passed unchanged.


Known Limitations and Deferred Work

  • Resolution is lexical — it recognizes POSIX absolute paths, Windows drive paths, and UNC paths, preserves the Workspace path's separator when joining a relative path, and does not access a filesystem or canonicalize . and .. segments.
  • Home abbreviation is POSIX-only — Windows paths remain unchanged because a portable browser cannot infer Windows home-path equivalence safely.

Dev Note

Working context for maintainers — click to expand

None.