@guojinpeng/dsh-cost-meter 0.0.0-stage → 0.1.2

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 dsh-cost-meter contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,3 +1,134 @@
-# Temporary Holding Version
+# @guojinpeng/dsh-cost-meter
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+[English](README.md) | [简体中文](README.zh-CN.md)
+
+This plugin shows estimated session and turn costs in DSH.
+Use DSH 0.2.0-rc.2 or later.
+Tests use DSH 0.2.0-rc.2.
+
+## Install
+
+1. Install the npm package:
+
+```powershell
+dsh plugin --profile web add -w @guojinpeng/dsh-cost-meter
+```
+
+2. Restart DSH.
+3. Open **Plugins**.
+4. Select **@guojinpeng/dsh-cost-meter** to change prices.
+
+Replace `web` with your profile name.
+If you used the old unscoped package, disable it before you install this package.
+
+If the npm package is not available, download the scoped package from
+[GitHub Releases](https://github.com/guojinpeng/dsh-cost-meter/releases).
+Run this command in the download directory:
+
+```powershell
+dsh plugin --profile web add -w ./guojinpeng-dsh-cost-meter-0.1.2.tgz
+```
+
+Restart DSH.
+Keep the downloaded file at the installation path.
+
+## Features
+
+- Shows session and completed-turn cost estimates.
+- Shows a short initialization message while prices load.
+- Shows input, output, cache-read and cache-write cost details.
+- Groups used models by provider. The list comes from DSH session history.
+- Supports separate prices for each full `provider/model` name.
+- Gets initial prices from models.dev. Uses the local catalog cache first.
+- Syncs only configured models. Asks for confirmation before prices are overwritten.
+- Matches source prices by model ID. Prefers the manufacturer's usage-based price. Keeps existing prices if matching is unclear.
+- Keeps existing prices when the source cannot supply a supported rate.
+- Uses USD per million tokens for model prices. Supports USD and CNY cost display.
+- Updates cost estimates after you save or sync prices.
+- Supports price reset and separate session/turn visibility controls.
+- Stores configuration at `~/.dsh/guojinpeng/dsh-cost-meter/config.json`. Uses `DSH_HOME` when set.
+- Copies the old `~/.dsh/dsh-cost-meter/config.json` on first start if the new file does not exist. Keeps the old file.
+- Uses isolated plugin, client, API, projection, style and configuration identifiers.
+
+These screenshots use example model prices. They do not show a billing statement.
+
+Session cost details:
+
+![Session cost card](docs/images/session-cost.png)
+
+Turn cost details:
+
+![Turn cost card](docs/images/turn-cost.png)
+
+Model price settings:
+
+![Model price settings on desktop](docs/images/model-prices-desktop.png)
+
+## Develop From Source
+
+Install Node.js, pnpm 9 and Git. Install DSH globally before you run the tests:
+
+```powershell
+npm install -g @deepseek-ai/dsh@0.2.0-rc.2
+git clone https://github.com/guojinpeng/dsh-cost-meter.git
+cd dsh-cost-meter
+pnpm install --frozen-lockfile
+```
+
+Edit files in `src/`. Run tests and create a package:
+
+```powershell
+npm test
+npm run build
+npm pack
+```
+
+`npm pack` also runs the build. It creates `guojinpeng-dsh-cost-meter-<version>.tgz`.
+Install the generated file in your DSH profile. For version 0.1.2:
+
+```powershell
+dsh plugin --profile web add -w ./guojinpeng-dsh-cost-meter-0.1.2.tgz
+```
+
+Restart DSH and check the plugin. Repeat the build, package and install steps after changes.
+Tests use the global DSH installation. Set `DSH_RUNTIME_ROOT` to the DSH package directory if its location is different.
+Commit source files and `pnpm-lock.yaml`. Do not commit generated files or local configuration.
+
+## Publish To npm
+
+Use an npm account with publish access to `@guojinpeng/dsh-cost-meter`.
+Run these commands in the project directory:
+
+```powershell
+npm login --registry=https://registry.npmjs.org/
+npm whoami --registry=https://registry.npmjs.org/
+npm view @guojinpeng/dsh-cost-meter version --registry=https://registry.npmjs.org/
+```
+
+An unpublished package can return `E404` from `npm view`.
+For an update, choose a version that is newer than the published version.
+Update `package.json`. You can use this command to increase the patch version without creating a Git tag:
+
+```powershell
+npm version patch --no-git-tag-version
+pnpm install --lockfile-only
+npm test
+npm pack --dry-run
+```
+
+Check the file list from `npm pack --dry-run`. Then publish the public package:
+
+```powershell
+npm publish --access public --registry=https://registry.npmjs.org/
+npm view @guojinpeng/dsh-cost-meter version --registry=https://registry.npmjs.org/
+```
+
+Complete npm's authentication steps when prompted.
+Each package version can be published only once.
+Commit and push the version change. Create the matching Git tag and GitHub Release.
+
+Users can then install the package:
+
+```powershell
+dsh plugin --profile web add -w @guojinpeng/dsh-cost-meter
+```

package/README.zh-CN.md

@@ -0,0 +1,134 @@
+# @guojinpeng/dsh-cost-meter
+
+[English](README.md) | [简体中文](README.zh-CN.md)
+
+此插件用于估算 DSH 的会话费用和每轮费用。
+需要 DSH 0.2.0-rc.2 或更高版本。
+已在 DSH 0.2.0-rc.2 上测试。
+
+## 安装
+
+1. 安装 npm 包：
+
+```powershell
+dsh plugin --profile web add -w @guojinpeng/dsh-cost-meter
+```
+
+2. 重启 DSH。
+3. 打开**插件**页面。
+4. 选择 **@guojinpeng/dsh-cost-meter**，修改模型单价。
+
+将 `web` 替换为你使用的 profile 名称。
+如果已安装旧版无 scope 的插件，请先禁用旧版，再安装此插件。
+
+如果 npm 包尚不可用，请从
+[GitHub Releases](https://github.com/guojinpeng/dsh-cost-meter/releases)
+下载 scoped 安装包。在下载目录执行：
+
+```powershell
+dsh plugin --profile web add -w ./guojinpeng-dsh-cost-meter-0.1.2.tgz
+```
+
+安装后重启 DSH。
+请保留下载的安装包，不要改变其安装路径。
+
+## 功能
+
+- 显示会话费用和已完成轮次的费用估算。
+- 加载价格时显示简短的“初始化中”提示。
+- 显示输入、输出、缓存读取和缓存写入的费用明细。
+- 按提供方分组显示模型。模型列表来自 DSH 调用历史。
+- 按完整的 `provider/model` 名称分别设置单价。
+- 从 models.dev 初始化价格。优先读取本地目录缓存。
+- 仅同步当前配置中的模型。覆盖价格前要求确认。
+- 按模型 ID 匹配第三方价格。优先使用原厂按量价格。匹配不明确时保留已有价格。
+- 第三方数据无法提供受支持的单价时，保留已有价格。
+- 模型单价使用 USD / 百万 token。费用支持 USD 和 CNY 显示。
+- 保存或同步价格后，立即更新费用估算。
+- 支持价格归零，以及分别控制会话和轮次费用标签的显示。
+- 配置保存在 `~/.dsh/guojinpeng/dsh-cost-meter/config.json`。设置 `DSH_HOME` 后，使用该目录。
+- 新配置不存在时，首次启动会复制旧的 `~/.dsh/dsh-cost-meter/config.json`。保留旧文件。
+- 插件、客户端、接口、费用 projection、样式和配置使用独立命名空间。
+
+以下截图使用示例模型价格，不代表实际账单。
+
+会话费用明细：
+
+![会话费用卡片](docs/images/session-cost.png)
+
+本轮费用明细：
+
+![本轮费用卡片](docs/images/turn-cost.png)
+
+模型单价配置：
+
+![桌面端模型单价配置](docs/images/model-prices-desktop.png)
+
+## 从源码开发
+
+安装 Node.js、pnpm 9 和 Git。运行测试前，先全局安装 DSH：
+
+```powershell
+npm install -g @deepseek-ai/dsh@0.2.0-rc.2
+git clone https://github.com/guojinpeng/dsh-cost-meter.git
+cd dsh-cost-meter
+pnpm install --frozen-lockfile
+```
+
+修改 `src/` 中的代码。运行测试并生成安装包：
+
+```powershell
+npm test
+npm run build
+npm pack
+```
+
+`npm pack` 也会执行构建，生成 `guojinpeng-dsh-cost-meter-<版本号>.tgz`。
+将生成的文件安装到你的 DSH profile。以 0.1.2 为例：
+
+```powershell
+dsh plugin --profile web add -w ./guojinpeng-dsh-cost-meter-0.1.2.tgz
+```
+
+重启 DSH，检查插件。每次修改后，重新构建、打包并安装。
+测试使用全局安装的 DSH。如果安装位置不同，将 `DSH_RUNTIME_ROOT` 设置为 DSH 包目录。
+提交源码和 `pnpm-lock.yaml`。不要提交生成文件或本地配置。
+
+## 发布到 npm
+
+使用有权发布 `@guojinpeng/dsh-cost-meter` 的 npm 账号。
+在项目目录执行：
+
+```powershell
+npm login --registry=https://registry.npmjs.org/
+npm whoami --registry=https://registry.npmjs.org/
+npm view @guojinpeng/dsh-cost-meter version --registry=https://registry.npmjs.org/
+```
+
+包尚未发布时，`npm view` 可能返回 `E404`。
+更新已发布的包时，新版本必须高于已发布版本。
+修改 `package.json`。也可以用以下命令递增补丁版本，不自动创建 Git 标签：
+
+```powershell
+npm version patch --no-git-tag-version
+pnpm install --lockfile-only
+npm test
+npm pack --dry-run
+```
+
+检查 `npm pack --dry-run` 列出的文件。然后发布公开包：
+
+```powershell
+npm publish --access public --registry=https://registry.npmjs.org/
+npm view @guojinpeng/dsh-cost-meter version --registry=https://registry.npmjs.org/
+```
+
+根据提示完成 npm 身份验证。
+同一包版本只能发布一次。
+提交并推送版本变更，创建对应的 Git 标签和 GitHub Release。
+
+发布后，用户可执行以下命令安装：
+
+```powershell
+dsh plugin --profile web add -w @guojinpeng/dsh-cost-meter
+```

package/cordis.patch.yml

@@ -0,0 +1,13 @@
+# dsh-cost-meter bundle patch: inserts the cost chip plugin into the profile
+# root as a single entry. All runtime configuration (currency, exchange rate,
+# chip visibility, model price table) lives in
+# <DSH_HOME>/guojinpeng/dsh-cost-meter/config.json and is edited from the plugin's detail
+# page in the DSH Plugins UI. Browser requests must be same-origin.
+#
+# `name` is the plugin's own package name, matching the fixture plugins under
+# apps/web/tests/fixtures/plugins/. Use the scoped npm package
+# name: the profile resolves it through the node_modules link `dsh plugin add`
+# creates for the installed package directory.
+- insert:
+  - id: guojinpeng/dsh-cost-meter
+    name: '@guojinpeng/dsh-cost-meter'