dsh-plugin-streamnest 0.0.5 → 0.1.0

package/README.en.md

@@ -7,33 +7,37 @@
 
 [中文](README.md) | English
 
-A local audio and video downloader plugin for DeepSeek Harness. Parse media links, select video quality, audio tracks or subtitles, and save files to your computer. The UI and Agent share the same services and download queue.
+Parse audio and video links, select quality, audio tracks or subtitles, and save files locally. The UI and Agent share services and the download queue.
 
 ![StreamNest installed and enabled in the DeepSeek Harness desktop app, showing the Link Download page](assets/screenshots/deepseek-harness-installed.png)
 
 ## Features
 
-- **Link parsing**: Parse media with yt-dlp, with dedicated APIs and browser fallbacks for Douyin and Kuaishou; supports single-video WeChat Channels share links.
-- **Download options**: Select video quality and audio tracks, extract MP3 audio, and download subtitles in their original format or convert them to SRT.
-- **Task management**: Queue downloads, control concurrency, view progress and speed, pause, resume, retry, and inspect local files.
-- **Completed downloads**: Search, view local thumbnails, play media, open folders, and sync the download directory; permanently delete individual or multiple downloads after a second confirmation.
-- **Download acceleration**: Download direct links in chunks with resume support and optional aria2; concurrent HLS / DASH segment downloads.
-- **Settings**: Configure the download directory, filename template, default quality, proxy, explicitly selected browser profile or Cookie file, and Chinese or English UI.
-- **Dependencies and diagnostics**: Detect or install yt-dlp, FFmpeg and ffprobe; inspect redacted logs and generate feedback drafts.
+- Parse media with yt-dlp, dedicated APIs and browser fallbacks for Douyin and Kuaishou, and single-video WeChat Channels share links.
+- Select quality and audio tracks, extract MP3 audio, and download subtitles in their original format or SRT.
+- Queue downloads, control concurrency, view progress and speed, pause, resume and retry; supports chunked direct downloads with resume, concurrent HLS / DASH segments, and optional aria2.
+- Search completed downloads, view local thumbnails, play media, open folders and sync the directory; permanently delete individual or multiple downloads after a second confirmation.
+- Configure the download directory, filename template, default quality, proxy, and explicitly selected browser profile or Cookie file; supports Chinese and English.
+- Detect or install yt-dlp, FFmpeg and ffprobe, inspect redacted logs, and generate feedback drafts.
 
 ## Installation
 
-This version targets DeepSeek Harness Desktop `0.2.1-rc.2`.
+Targets DeepSeek Harness Desktop `0.2.1-rc.2`. In **Plugins → Add Plugin**, enter `dsh-plugin-streamnest`, select the official npm registry, then install and enable it. Alternatively, use the CLI:
 
-In DeepSeek Harness, open **Plugins → Add Plugin**, enter `dsh-plugin-streamnest`, select the official npm registry, then install and enable it. The published package includes build artifacts and requires no compilation during installation.
+```bash
+dsh plugin --profile desktop add dsh-plugin-streamnest --registry=https://registry.npmjs.org/
+
+# Web: run on the server
+dsh plugin --profile web add dsh-plugin-streamnest --registry=https://registry.npmjs.org/
+```
 
-You can also use the official CLI:
+For a local `.tgz` package, select it on the plugin page or run:
 
 ```bash
-dsh plugin --profile desktop add dsh-plugin-streamnest --registry=https://registry.npmjs.org/
+dsh plugin --profile desktop add file:/absolute/path/dsh-plugin-streamnest-0.1.0.tgz
 ```
 
-For the Web version of DeepSeek Harness, replace `desktop` with the appropriate profile, such as `web`. See `peerDependencies` in `package.json` for the supported host SDK versions.
+Replace the path and version with those of your package. Restart the app / Web service after installation or update. Installation requires no compilation. See `peerDependencies` in `package.json` for supported host SDK versions.
 
 ## Usage
 
@@ -41,9 +45,9 @@ For the Web version of DeepSeek Harness, replace `desktop` with the appropriate
 2. Paste a media link into **Link Download**, parse it, select video quality, audio tracks or subtitles, and add a download to the queue.
 3. Monitor and control tasks in **Download Queue**; play media or open its folder in **Completed Downloads**.
 
-You can also ask the Agent in a host conversation to parse links, create downloads, inspect the queue, or pause tasks. Results stay in sync with the UI.
+Ask the Agent in a host conversation to parse links, create downloads, inspect the queue or pause tasks. Results stay in sync with the UI.
 
-### Limitations
+## Limitations
 
 - Parses one video at a time without expanding playlists; live streams are not supported.
 - Site availability depends on platform APIs, access permissions, login state, and runtime tool versions.
@@ -53,34 +57,25 @@ You can also ask the Agent in a host conversation to parse links, create downloa
 - Deleting items in **Completed Downloads** permanently deletes their registered files after a second confirmation and cannot be undone. Directory sync only updates records and does not delete files.
 - aria2 is optional and must be installed separately or provided through a configured path.
 
-## Development and packaging
+## Development and publishing
 
-Requires Node.js ≥ 22.13 and pnpm 11.5.0, as pinned in `package.json`.
+Requires Node.js ≥ 22.13 and pnpm 11.5.0.
 
 ```bash
 pnpm install --frozen-lockfile
-pnpm dev
+pnpm verify                            # Format, lint, types, build and tests
+pnpm pack --pack-destination artifacts  # Verify, build and create a local package
+pnpm release --dry-run                  # Verify and preview the npm package
+pnpm release                           # Log in to npm, verify, build and publish
 ```
 
-The development preview runs at `http://127.0.0.1:5179`, with the API at `http://127.0.0.1:4322/streamnest/api`. The preview uses the official host theme and UI primitives; in the DeepSeek Harness desktop app, the plugin inherits the host theme.
+`verify` runs `check → build → test`. Packing and publishing run the same validation through `prepack`. Local packages are written to `artifacts/dsh-plugin-streamnest-<version>.tgz`.
 
-```bash
-pnpm run check
-pnpm run release
-```
+`release` opens npm browser login, verifies the account with `whoami`, then publishes to the official npm registry (public / latest). Any failure stops the process. `--dry-run` only verifies and previews the package; it does not log in, upload or write an install archive. Update `version` in `package.json` before publishing again; published versions cannot be overwritten.
 
-The release archive is written to `release/streamnest-<version>.tgz` and can be installed locally. It includes the project documentation, reference project sources, original license texts, and bundled client dependency licenses.
+The npm package contains only compiled JavaScript, runtime configuration, locale files, required assets, documentation, licenses and source attribution. It excludes TypeScript / TSX source, source maps, tests and build scripts.
 
-### Publishing to npm
-
-Sign in with `npm login`, or provide an access token with publishing permissions through standard npm configuration, then run:
-
-```bash
-pnpm run publish:npm --dry-run
-pnpm run publish:npm
-```
-
-The publish command runs checks, creates a release archive, and publishes that same archive to the official npm registry. Authentication uses standard npm login or access token configuration, and npm verifies publishing permissions. `--dry-run` performs a rehearsal only. Update the version in `package.json` before each subsequent release; a published version cannot be overwritten.
+Run `pnpm dev` for a local preview at `http://127.0.0.1:5179`, with the API at `http://127.0.0.1:4322/streamnest/api`. The preview uses official theme and UI primitives; Desktop inherits the host theme.
 
 | Directory                        | Responsibility                                            |
 | -------------------------------- | --------------------------------------------------------- |
@@ -91,8 +86,6 @@ The publish command runs checks, creates a release archive, and publishes that s
 | `assets/reference-projects.json` | Reference project source list                             |
 | `licenses`                       | Original license texts for reference projects             |
 
-The UI, API and Agent reuse the same business services. Host adapters live in `packages/harness`.
-
 ## Acknowledgments
 
 Reference implementations: [DownVid](https://github.com/yxxbc/downvid) · [wx_channels_download](https://github.com/ltaoo/wx_channels_download)

package/README.md

@@ -7,33 +7,37 @@
 
 中文 | [English](README.en.md)
 
-适用于 DeepSeek Harness 的本地音视频下载插件。解析媒体链接、选择画质、音轨或字幕并保存到本机，页面与 Agent 共用同一套服务和下载队列。
+解析音视频链接，选择画质、音轨或字幕并保存到本机。页面与 Agent 共用服务和下载队列。
 
 ![拾流已安装并启用：DeepSeek Harness 桌面版中的链接下载界面](assets/screenshots/deepseek-harness-installed.png)
 
 ## 功能
 
-- **链接解析**：通过 yt-dlp 解析媒体，抖音、快手提供专用 API 和浏览器回退；支持微信视频号单视频分享链接。
-- **下载选择**：选择视频画质和音轨，提取 MP3，下载字幕并选择保留源格式或转换为 SRT。
-- **任务管理**：下载排队、并发控制、进度与速度显示、暂停、继续、重试，以及本地文件查看。
-- **已完成下载**：搜索、本地缩略图、播放、打开目录和目录同步；支持二次确认后的单个与批量永久删除。
-- **下载加速**：直链分块下载和断点续传，可选 aria2；支持 HLS / DASH 分片并发。
-- **运行设置**：下载目录、文件名模板、默认画质、代理、明确指定的浏览器账号或 Cookie 文件，以及中英文界面。
-- **依赖与诊断**：探测或安装 yt-dlp、FFmpeg、ffprobe；查看脱敏日志和生成反馈草稿。
+- 通过 yt-dlp 解析媒体；抖音、快手提供专用 API 和浏览器回退，支持微信视频号单视频分享链接。
+- 选择画质和音轨、提取 MP3、下载原格式或 SRT 字幕。
+- 排队、并发下载、进度与速度显示、暂停、继续和重试；支持直链分块续传、HLS / DASH 分片并发及可选 aria2。
+- 搜索已完成下载、显示本地缩略图、播放、打开目录和同步目录；支持二次确认后的单个与批量永久删除。
+- 配置下载目录、文件名模板、默认画质、代理、明确指定的浏览器账号或 Cookie 文件；支持中英文界面。
+- 探测或安装 yt-dlp、FFmpeg、ffprobe，查看脱敏日志并生成反馈草稿。
 
 ## 安装
 
-当前版本适配 DeepSeek Harness Desktop `0.2.1-rc.2`。
+适配 DeepSeek Harness Desktop `0.2.1-rc.2`。在「插件 → 添加插件」中输入 `dsh-plugin-streamnest`，选择 npm 官方源安装并启用，或使用 CLI：
 
-在 DeepSeek Harness 的「插件 → 添加插件」中输入 `dsh-plugin-streamnest`，选择 npm 官方源安装并启用。发布包已包含构建产物，安装时无需编译。
+```bash
+dsh plugin --profile desktop add dsh-plugin-streamnest --registry=https://registry.npmjs.org/
+
+# Web 版：在服务端执行
+dsh plugin --profile web add dsh-plugin-streamnest --registry=https://registry.npmjs.org/
+```
 
-也可以使用官方 CLI：
+本地 `.tgz` 安装包也可在插件页选择安装，或运行：
 
 ```bash
-dsh plugin --profile desktop add dsh-plugin-streamnest --registry=https://registry.npmjs.org/
+dsh plugin --profile desktop add file:/absolute/path/dsh-plugin-streamnest-0.1.0.tgz
 ```
 
-使用 DeepSeek Harness Web 版时，将 `desktop` 换为对应的 profile（例如 `web`）。宿主 SDK 兼容范围见 `package.json` 的 `peerDependencies`。
+替换为安装包的实际路径和版本。安装或更新后重启应用 / Web 服务；安装时无需编译。宿主 SDK 兼容范围见 `package.json` 的 `peerDependencies`。
 
 ## 使用
 
@@ -41,9 +45,9 @@ dsh plugin --profile desktop add dsh-plugin-streamnest --registry=https://regist
 2. 在「链接下载」粘贴媒体链接，解析后选择画质、音轨或字幕，加入下载队列。
 3. 在「下载队列」查看进度和控制任务，在「已完成下载」播放或打开文件目录。
 
-也可以在宿主会话中让 Agent 解析链接、创建下载任务、查询队列或暂停任务，操作结果与页面同步。
+在宿主会话中也可让 Agent 解析链接、创建下载、查询队列或暂停任务，结果与页面同步。
 
-### 功能限制
+## 限制
 
 - 每次解析一个视频，不展开播放列表；不支持正在直播的媒体。
 - 网站可用性取决于站点接口、访问权限、登录状态和运行工具版本。
@@ -53,34 +57,25 @@ dsh plugin --profile desktop add dsh-plugin-streamnest --registry=https://regist
 - 「已完成下载」中的删除会永久删除所选记录登记的文件，二次确认后执行，无法撤销；目录同步只整理记录，不删除文件。
 - aria2 为可选工具，需自行安装或指定路径。
 
-## 开发与打包
+## 开发与发布
 
-需要 Node.js ≥ 22.13，使用 `package.json` 固定的 pnpm 11.5.0。
+要求 Node.js ≥ 22.13、pnpm 11.5.0。
 
 ```bash
 pnpm install --frozen-lockfile
-pnpm dev
+pnpm verify                            # 格式、Lint、类型、构建和测试
+pnpm pack --pack-destination artifacts  # 校验、构建并生成本地安装包
+pnpm release --dry-run                  # 校验并预览 npm 包
+pnpm release                           # 登录 npm 后校验、构建并发布
 ```
 
-开发预览地址为 `http://127.0.0.1:5179`，API 地址为 `http://127.0.0.1:4322/streamnest/api`。开发预览使用官方宿主主题与控件；在 DeepSeek Harness 桌面版中继承宿主主题。
+`verify` 依次执行 `check → build → test`，打包和发布由 `prepack` 自动执行同一验证。本地安装包输出至 `artifacts/dsh-plugin-streamnest-<版本>.tgz`。
 
-```bash
-pnpm run check
-pnpm run release
-```
+`release` 依次执行 npm 浏览器登录、`whoami` 身份校验，再发布到 npm 官方源（public / latest）；任一步失败立即停止。`--dry-run` 仅校验和预览包内容，不登录、不上传、不写入安装包。再次发布前更新 `package.json` 的 `version`，已发布版本不能覆盖。
 
-发布包输出至 `release/streamnest-<版本>.tgz`，可用于本地安装。构建产物包含项目介绍、参考项目来源、原始许可及客户端捆绑依赖许可。
+npm 包仅包含编译后的 JavaScript、运行配置、语言文件、必要资产、说明文档及许可和来源清单；不包含 TypeScript / TSX 源码、source map、测试或构建脚本。
 
-### 发布到 npm
-
-先通过 `npm login` 登录，或通过标准 npm 配置提供具备发布权限的 access token，再执行：
-
-```bash
-pnpm run publish:npm --dry-run
-pnpm run publish:npm
-```
-
-发布命令会先执行检查、生成 release 包，再发布同一个安装包到 npm 官方 registry。认证沿用标准 npm 登录或 access token 配置，发布权限由 npm 校验。`--dry-run` 只演练。后续发布前须更新 `package.json` 的版本号，已发布的同名版本不能覆盖。
+本地预览运行 `pnpm dev`：页面为 `http://127.0.0.1:5179`，API 为 `http://127.0.0.1:4322/streamnest/api`。预览使用官方主题与控件，Desktop 继承宿主主题。
 
 | 目录                             | 职责                                      |
 | -------------------------------- | ----------------------------------------- |
@@ -91,8 +86,6 @@ pnpm run publish:npm
 | `assets/reference-projects.json` | 参考项目来源清单                          |
 | `licenses`                       | 参考项目原始许可文本                      |
 
-页面、API 与 Agent 复用相同业务服务，宿主适配集中在 `packages/harness`。
-
 ## 感谢开源
 
 参考实现：[DownVid](https://github.com/yxxbc/downvid) · [wx_channels_download](https://github.com/ltaoo/wx_channels_download)