dsh-auth-remote 0.1.0 → 0.1.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/CHANGELOG.md CHANGED
@@ -8,6 +8,11 @@ This file records user-visible changes to the released package. Version numbers
8
8
 
9
9
  No changes recorded yet.
10
10
 
11
+ ## 0.1.1 - 2026-09-28
12
+
13
+ - Documented installation from the published npm package in English and Chinese.
14
+ - Made the release workflow publish the tested archive by an explicit file path, with a dedicated archive preparation command.
15
+
11
16
  ## 0.1.0 - 2026-09-28
12
17
 
13
18
  - Initial public release of the single-user DSH remote authentication plugin.
@@ -8,6 +8,11 @@
8
8
 
9
9
  暂无记录。
10
10
 
11
+ ## 0.1.1 - 2026-09-28
12
+
13
+ - 中英文文档改为指导从已发布的 npm 包安装插件。
14
+ - 发布工作流改用明确的文件路径发布已测试压缩包,并加入专用的发布打包命令。
15
+
11
16
  ## 0.1.0 - 2026-09-28
12
17
 
13
18
  - 首次公开发布 DSH 单用户远程认证插件。
package/README.md CHANGED
@@ -6,22 +6,21 @@ Single-user remote sign-in for DeepSeek Harness (DSH), with password, TOTP, one-
6
6
 
7
7
  ## Requirements
8
8
 
9
- - Linux with `/proc`, Node.js 24 or newer, pnpm 12.5.1, and the tested DSH **0.1.7-rc.1** runtime.
9
+ - Linux with `/proc`, Node.js 24 or newer, and the tested DSH **0.1.7-rc.1** runtime. pnpm 12.5.1 is needed only when building from source.
10
10
  - DSH's default `~/.dsh` data directory and a `web` profile. The account state belongs to that profile; it is not shared with another profile.
11
- - For browser tests, install Playwright Chromium with `pnpm exec playwright install chromium`. The tests use that managed browser and a dedicated, self-signed TLS fixture.
11
+ - For source browser tests, install Playwright Chromium with `pnpm exec playwright install chromium`. The tests use that managed browser and a dedicated, self-signed TLS fixture.
12
12
 
13
- ## Minimal local installation from source
13
+ ## Install from npm
14
14
 
15
- From a source checkout:
15
+ With DSH installed, verify its version and install the published plugin into the default `web` profile:
16
16
 
17
17
  ```sh
18
- pnpm install --frozen-lockfile
19
- pnpm pack:local
20
18
  dsh --version
21
- dsh plugin --profile web add "$PWD/artifacts/dsh-auth-remote-0.1.0.tgz"
19
+ dsh plugin --profile web add dsh-auth-remote@0.1.1
20
+ dsh plugin --profile web list
22
21
  ```
23
22
 
24
- Check that `dsh --version` prints `0.1.7-rc.1`. Run the commands from the checkout so `$PWD` names the built archive; DSH runs the plugin installer inside the profile directory. `pnpm pack:local` builds and checks a local archive; it does not publish one. These `dsh` commands use the default data directory. An isolated development runtime can be prepared with `pnpm dev:prepare`; see the [development guide](docs/development.md).
23
+ Check that `dsh --version` prints `0.1.7-rc.1` and the plugin list includes `dsh-auth-remote@0.1.1`. These commands use DSH's default data directory. For source builds and an isolated development runtime, see the [development guide](docs/development.md).
25
24
 
26
25
  ## Configure the web profile
27
26
 
package/README.zh-CN.md CHANGED
@@ -6,22 +6,21 @@ DeepSeek Harness(DSH)的单用户远程登录插件,提供密码、TOTP、
6
6
 
7
7
  ## 前置条件
8
8
 
9
- - Linux(含 `/proc`)、Node.js 24 或更高版本、pnpm 12.5.1,以及已测试的 DSH **0.1.7-rc.1** 运行时。
9
+ - Linux(含 `/proc`)、Node.js 24 或更高版本,以及已测试的 DSH **0.1.7-rc.1** 运行时。仅从源码构建时需要 pnpm 12.5.1。
10
10
  - DSH 默认的 `~/.dsh` 数据目录和 `web` profile。账号状态属于该 profile,不与其他 profile 共用。
11
- - 浏览器测试先执行 `pnpm exec playwright install chromium`。测试使用 Playwright 管理的浏览器和专用自签 TLS 夹具。
11
+ - 源码浏览器测试先执行 `pnpm exec playwright install chromium`。测试使用 Playwright 管理的浏览器和专用自签 TLS 夹具。
12
12
 
13
- ## 从源码最小化本地安装
13
+ ## 从 npm 安装
14
14
 
15
- 在源码检出目录执行:
15
+ 安装 DSH 后,核对版本并把已发布的插件安装到默认 `web` profile:
16
16
 
17
17
  ```sh
18
- pnpm install --frozen-lockfile
19
- pnpm pack:local
20
18
  dsh --version
21
- dsh plugin --profile web add "$PWD/artifacts/dsh-auth-remote-0.1.0.tgz"
19
+ dsh plugin --profile web add dsh-auth-remote@0.1.1
20
+ dsh plugin --profile web list
22
21
  ```
23
22
 
24
- 确认 `dsh --version` 输出 `0.1.7-rc.1`。在源码目录运行命令,使 `$PWD` 指向生成的压缩包;DSH 会在 profile 目录执行插件安装。`pnpm pack:local` 只构建、检查本地压缩包,不发布。这些 `dsh` 命令使用默认数据目录。需要隔离开发运行时时可执行 `pnpm dev:prepare`;参见[开发指南](docs/development.zh-CN.md)。
23
+ 确认 `dsh --version` 输出 `0.1.7-rc.1`,且插件列表中有 `dsh-auth-remote@0.1.1`。这些命令使用 DSH 默认数据目录。源码构建及隔离开发运行时参见[开发指南](docs/development.zh-CN.md)。
25
24
 
26
25
  ## 配置 web profile
27
26
 
@@ -4,18 +4,17 @@
4
4
 
5
5
  This guide describes a new installation with the verified DSH `0.1.7-rc.1` runtime and its default `~/.dsh` data directory. It does not depend on a particular public hostname, proxy network, service manager, or existing account database.
6
6
 
7
- ## Minimal local installation
7
+ ## Minimal installation from npm
8
8
 
9
- From the source checkout, build the local archive and install it into the default `web` profile:
9
+ Install the published package into the default `web` profile:
10
10
 
11
11
  ```sh
12
- pnpm install --frozen-lockfile
13
- pnpm pack:local
14
12
  dsh --version
15
- dsh plugin --profile web add "$PWD/artifacts/dsh-auth-remote-0.1.0.tgz"
13
+ dsh plugin --profile web add dsh-auth-remote@0.1.1
14
+ dsh plugin --profile web list
16
15
  ```
17
16
 
18
- Verify that `dsh --version` prints `0.1.7-rc.1`. DSH runs the plugin installer inside the profile directory, so `$PWD` supplies an absolute archive path. The bundle supplies an auth listener with `allowedOrigins: []`, which admits only literal loopback hosts. No profile patch is needed for this setup. Start DSH in one terminal:
17
+ Verify that `dsh --version` prints `0.1.7-rc.1` and the list includes `dsh-auth-remote@0.1.1`. The bundle supplies an auth listener with `allowedOrigins: []`, which admits only literal loopback hosts. No profile patch is needed for this setup. Start DSH in one terminal:
19
18
 
20
19
  ```sh
21
20
  dsh web --no-open --port 13090
@@ -73,7 +72,7 @@ Binding to an interface does not restrict client source addresses. Apply any req
73
72
 
74
73
  ## Start and verify the public entry
75
74
 
76
- 1. Verify Linux, Node.js 24+, pnpm 12.5.1, and the installed DSH version. Install the archive with the minimal commands above. Keep any test or development runtime separate from the default account profile.
75
+ 1. Verify Linux, Node.js 24+, and the installed DSH version. Install the npm package with the minimal commands above. Keep any test or development runtime separate from the default account profile.
77
76
  2. Merge the public-origin profile configuration above. The independent `webserver` disable is recommended. A proxy should reach only the private listener through a transport you control; see the [proxy guide](reverse-proxy.md).
78
77
  3. Start with `dsh web --no-open --port 13090`. Before opening external access, inspect `curl -fsS -H 'Host: dsh.example.com' http://127.0.0.1:13090/auth-remote/ready` and require JSON containing `"plugin":"dsh-auth-remote"`, `"protocolVersion":1`, and `"ready":true`.
79
78
  4. Confirm an anonymous HTML request redirects to `/auth-remote/login`, and an anonymous API request such as `/api/settings` is denied. Initialize through the local CLI if needed, then sign in, bind TOTP, save backup codes and exercise official settings, workspace, preview, uploads and streams through the chosen browser origin.
@@ -4,18 +4,17 @@
4
4
 
5
5
  本指南说明使用已验证的 DSH `0.1.7-rc.1` 和默认的 `~/.dsh` 数据目录进行全新安装,不假定公网域名、代理网络、服务管理器或现有账号数据库。
6
6
 
7
- ## 最小化本地安装
7
+ ## 从 npm 最小化安装
8
8
 
9
- 在源码检出目录构建本地压缩包,并安装到默认的 `web` profile:
9
+ 把已发布的包安装到默认 `web` profile:
10
10
 
11
11
  ```sh
12
- pnpm install --frozen-lockfile
13
- pnpm pack:local
14
12
  dsh --version
15
- dsh plugin --profile web add "$PWD/artifacts/dsh-auth-remote-0.1.0.tgz"
13
+ dsh plugin --profile web add dsh-auth-remote@0.1.1
14
+ dsh plugin --profile web list
16
15
  ```
17
16
 
18
- 确认 `dsh --version` 输出 `0.1.7-rc.1`。DSH 会在 profile 目录执行插件安装,因此 `$PWD` 为压缩包提供绝对路径。bundle 提供认证监听,默认 `allowedOrigins: []`,因此只准入字面回环主机。最小安装无需修改 profile 补丁。在一个终端启动 DSH:
17
+ 确认 `dsh --version` 输出 `0.1.7-rc.1`,且列表中有 `dsh-auth-remote@0.1.1`。bundle 提供认证监听,默认 `allowedOrigins: []`,因此只准入字面回环主机。最小安装无需修改 profile 补丁。在一个终端启动 DSH:
19
18
 
20
19
  ```sh
21
20
  dsh web --no-open --port 13090
@@ -73,7 +72,7 @@ dsh plugin --profile web exec dsh-auth-remote init --lang zh
73
72
 
74
73
  ## 启动并检查公网入口
75
74
 
76
- 1. 核对 Linux、Node.js 24+、pnpm 12.5.1 和已安装的 DSH 版本。按上文最小化命令安装压缩包。测试和开发运行时应与默认账号 profile 分开。
75
+ 1. 核对 Linux、Node.js 24+ 和已安装的 DSH 版本。按上文最小化命令安装 npm 包。测试和开发运行时应与默认账号 profile 分开。
77
76
  2. 合并上文公网入口的 profile 配置;建议独立禁用 `webserver`。代理只应通过受控私有传输访问监听;参见[代理指南](reverse-proxy.zh-CN.md)。
78
77
  3. 用 `dsh web --no-open --port 13090` 启动。开放外部入口前检查 `curl -fsS -H 'Host: dsh.example.com' http://127.0.0.1:13090/auth-remote/ready`,要求 JSON 同时包含 `"plugin":"dsh-auth-remote"`、`"protocolVersion":1` 和 `"ready":true`。
79
78
  4. 确认匿名 HTML 请求跳转 `/auth-remote/login`,匿名 `/api/settings` 等 API 被拒绝。若尚未初始化账号,先用本地 CLI 初始化;随后登录、绑定 TOTP、保存备用码,并经选定浏览器入口测试官方设置、工作区、预览、上传和流。
@@ -14,7 +14,7 @@ pnpm pack:local
14
14
  pnpm smoke
15
15
  ```
16
16
 
17
- `pnpm check` runs type checking, formatting, build, package/deployment/document checks, then unit, integration, CLI, and browser tests. `pnpm pack:local` writes `artifacts/dsh-auth-remote-0.1.0.tgz` after static checks; it does not publish. `pnpm smoke` installs that archive into an isolated DSH home, starts the pinned DSH runtime briefly, checks readiness, anonymous redirection/denial and an online CLI status, then stops it.
17
+ `pnpm check` runs type checking, formatting, build, package/deployment/document checks, then unit, integration, CLI, and browser tests. `pnpm pack:local` writes `artifacts/dsh-auth-remote-0.1.1.tgz` after static checks; it does not publish. `pnpm smoke` installs that archive into an isolated DSH home, starts the pinned DSH runtime briefly, checks readiness, anonymous redirection/denial and an online CLI status, then stops it.
18
18
 
19
19
  ## Use the isolated development profile
20
20
 
@@ -14,7 +14,7 @@ pnpm pack:local
14
14
  pnpm smoke
15
15
  ```
16
16
 
17
- `pnpm check` 依次执行类型、格式、构建、包/部署/文档检查,以及单元、集成、CLI 和浏览器测试。`pnpm pack:local` 在静态检查后写出 `artifacts/dsh-auth-remote-0.1.0.tgz`,不会发布。`pnpm smoke` 将包安装到隔离 DSH_HOME,短暂启动固定版本的 DSH,验证就绪、匿名重定向/拒绝和在线 CLI 状态,然后停止。
17
+ `pnpm check` 依次执行类型、格式、构建、包/部署/文档检查,以及单元、集成、CLI 和浏览器测试。`pnpm pack:local` 在静态检查后写出 `artifacts/dsh-auth-remote-0.1.1.tgz`,不会发布。`pnpm smoke` 将包安装到隔离 DSH_HOME,短暂启动固定版本的 DSH,验证就绪、匿名重定向/拒绝和在线 CLI 状态,然后停止。
18
18
 
19
19
  ## 使用隔离开发 profile
20
20
 
package/docs/releasing.md CHANGED
@@ -14,11 +14,11 @@ To verify the merged checkout locally, run:
14
14
  pnpm install --frozen-lockfile
15
15
  pnpm exec playwright install chromium
16
16
  pnpm check
17
- pnpm pack:local
18
- pnpm smoke
17
+ pnpm release:pack
18
+ pnpm smoke:packed
19
19
  ```
20
20
 
21
- `pnpm pack:local` creates and checks `artifacts/dsh-auth-remote-X.Y.Z.tgz`; `pnpm smoke` installs that archive into an isolated DSH home and tests startup. Neither command publishes a package.
21
+ `pnpm release:pack` runs static checks, creates and verifies `artifacts/dsh-auth-remote-X.Y.Z.tgz`; `pnpm smoke:packed` installs that exact archive into an isolated DSH home and tests startup. The tag workflow publishes the verified archive to npm with `npm publish ./artifacts/dsh-auth-remote-X.Y.Z.tgz --access public`. No local npm publication is needed.
22
22
 
23
23
  ## Tag and inspect the release
24
24
 
@@ -27,18 +27,18 @@ Use the version that is already on `master`:
27
27
  ```sh
28
28
  git switch master
29
29
  git pull --ff-only origin master
30
- git tag -a v0.1.0 -m "Release v0.1.0"
31
- git push origin v0.1.0
30
+ git tag -a v0.1.1 -m "Release v0.1.1"
31
+ git push origin v0.1.1
32
32
  ```
33
33
 
34
- Replace `0.1.0` in these commands with the intended version. The tag must point to a commit reachable from `master`. A mismatched tag, missing changelog entry, failed test, or mismatched existing npm archive stops the release.
34
+ Replace `0.1.1` in these commands with the intended version. The tag must point to a commit reachable from `master`. A mismatched tag, missing changelog entry, failed test, or mismatched existing npm archive stops the release.
35
35
 
36
36
  After the workflow completes, confirm the run, GitHub Release, and npm version:
37
37
 
38
38
  ```sh
39
39
  gh run list --workflow release.yml --limit 5
40
- gh release view v0.1.0
41
- npm view dsh-auth-remote@0.1.0 version dist.integrity
40
+ gh release view v0.1.1
41
+ npm view dsh-auth-remote@0.1.1 version dist.integrity
42
42
  ```
43
43
 
44
44
  The GitHub Release includes the `.tgz` and `SHA256SUMS`. Download them into the same directory and run `sha256sum -c SHA256SUMS` there to check the release asset. A failed workflow should be inspected in **Actions → Release** before retrying; npm versions are immutable, so the workflow only skips an existing version when its archive bytes match.
@@ -14,11 +14,11 @@
14
14
  pnpm install --frozen-lockfile
15
15
  pnpm exec playwright install chromium
16
16
  pnpm check
17
- pnpm pack:local
18
- pnpm smoke
17
+ pnpm release:pack
18
+ pnpm smoke:packed
19
19
  ```
20
20
 
21
- `pnpm pack:local` 创建并检查 `artifacts/dsh-auth-remote-X.Y.Z.tgz`;`pnpm smoke` 将压缩包安装到隔离的 DSH home 并测试启动。这两个命令都不会发布包。
21
+ `pnpm release:pack` 执行静态检查,创建并验证 `artifacts/dsh-auth-remote-X.Y.Z.tgz`;`pnpm smoke:packed` 将这个压缩包安装到隔离 DSH home 并测试启动。标签工作流使用 `npm publish ./artifacts/dsh-auth-remote-X.Y.Z.tgz --access public` 将已验证的压缩包发布到 npm,无需在本地手动发布。
22
22
 
23
23
  ## 打标签并核对结果
24
24
 
@@ -27,18 +27,18 @@ pnpm smoke
27
27
  ```sh
28
28
  git switch master
29
29
  git pull --ff-only origin master
30
- git tag -a v0.1.0 -m "Release v0.1.0"
31
- git push origin v0.1.0
30
+ git tag -a v0.1.1 -m "Release v0.1.1"
31
+ git push origin v0.1.1
32
32
  ```
33
33
 
34
- 执行时把 `0.1.0` 换成目标版本。标签必须指向 `master` 可达的提交。标签版本不匹配、缺少更新日志条目、测试失败,或 npm 现存版本与本次压缩包字节不同,都会阻止发布。
34
+ 执行时把 `0.1.1` 换成目标版本。标签必须指向 `master` 可达的提交。标签版本不匹配、缺少更新日志条目、测试失败,或 npm 现存版本与本次压缩包字节不同,都会阻止发布。
35
35
 
36
36
  工作流结束后检查运行状态、GitHub Release 和 npm 版本:
37
37
 
38
38
  ```sh
39
39
  gh run list --workflow release.yml --limit 5
40
- gh release view v0.1.0
41
- npm view dsh-auth-remote@0.1.0 version dist.integrity
40
+ gh release view v0.1.1
41
+ npm view dsh-auth-remote@0.1.1 version dist.integrity
42
42
  ```
43
43
 
44
44
  GitHub Release 包含 `.tgz` 和 `SHA256SUMS`。把两者下载到同一个目录,在该目录运行 `sha256sum -c SHA256SUMS` 验证附件。工作流失败时先查看 **Actions → Release** 再重试;npm 版本不可覆盖,因此只有现存版本的压缩包字节与本次构建一致时,工作流才会跳过重复发布。
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "dsh-auth-remote",
3
- "version": "0.1.0",
3
+ "version": "0.1.1",
4
4
  "description": "Single-user remote authentication for DeepSeek Harness: password, TOTP and revocable sessions.",
5
5
  "license": "MIT",
6
6
  "repository": {
@@ -106,7 +106,9 @@
106
106
  "test:browser": "node scripts/prepare-test.mjs && pnpm build && node scripts/pack.mjs && tsx --test --test-concurrency=1 tests/browser/*.spec.ts",
107
107
  "check:static": "pnpm typecheck && pnpm format:check && pnpm build && pnpm check:package && pnpm check:deployment && pnpm check:docs && pnpm check:release",
108
108
  "check": "pnpm check:static && pnpm test:unit && pnpm test:integration && pnpm test:cli && pnpm test:browser",
109
- "pack:local": "pnpm check:static && node scripts/pack.mjs",
110
- "smoke": "pnpm dev:install && node scripts/smoke.mjs"
109
+ "release:pack": "pnpm check:static && node scripts/pack.mjs",
110
+ "pack:local": "pnpm release:pack",
111
+ "smoke:packed": "pnpm dev:prepare && node scripts/dev-install.mjs && node scripts/smoke.mjs",
112
+ "smoke": "pnpm pack:local && pnpm smoke:packed"
111
113
  }
112
114
  }