# 📦 @goodandready/dsh-cost-meter

<div align="center">

<h3>面向 DeepSeek Harness 的会话实时花费计费芯片、波峰/波谷阶梯电价与 Token 监控插件</h3>

<p align="center">
  <a href="https://www.npmjs.com/package/@goodandready/dsh-cost-meter"><img src="https://img.shields.io/npm/v/@goodandready/dsh-cost-meter.svg?style=for-the-badge&color=6366f1&labelColor=1e1b4b" alt="npm version"></a>
  <a href="../LICENSE"><img src="https://img.shields.io/github/license/GooDAnDReaDY/dsh-cost-meter.svg?style=for-the-badge&color=10b981&labelColor=064e3b" alt="license"></a>
  <a href="https://github.com/topics/dsh-plugin"><img src="https://img.shields.io/badge/DSH-Plugin-8b5cf6.svg?style=for-the-badge&labelColor=2e1065" alt="DSH Plugin"></a>
  <a href="https://nodejs.org"><img src="https://img.shields.io/badge/Node-20%2B-f59e0b.svg?style=for-the-badge&labelColor=451a03" alt="Node version"></a>
</p>

<!-- 作者所有项目展示页面链接 -->
<p align="center">
  <a href="https://goodandready.app/"><img src="https://img.shields.io/badge/作者所有开源项目-goodandready.app-ff4500.svg?style=for-the-badge&logo=rocket&logoColor=white&labelColor=1a1a2e" alt="所有项目"></a>
</p>

<p align="center">
  <a href="README.md"><b>🇬🇧 English</b></a> •
  <a href="README.ru.md"><b>🇷🇺 Русский</b></a> •
  <a href="README.zh.md"><b>🇨🇳 中文说明</b></a>
</p>

<table align="center">
  <tr>
    <td align="center">
      ⭐ <strong>如果您喜欢这个插件，请在 GitHub 上为它点亮 Star</strong> — 这能让我知道插件对您有用，并鼓励我继续开发和维护它。
      <br><br>
      🐛 <strong>如果您发现 Bug 或希望增加功能</strong>，请使用任意语言在 GitHub 上提交 Issue — 我会评估您的建议，并在后续版本中实现有价值的改进。
    </td>
  </tr>
</table>

</div>

---

## ⚡ 概述与核心痛点

在使用智能体与大语言模型编程时，模型推理、长上下文以及缓存读写会产生大量 Token 消耗。如果缺乏实时的财务监控，开发者容易错过官方 50% 闲时折扣窗口，或因死循环导致账单超出预算。

**`@goodandready/dsh-cost-meter`** 在 DeepSeek Harness 会话顶部工具栏（`conversation.session.header.utilities`）无缝嵌入高精度花费微件芯片：

```text
● ≈ ¥0.85  0:17     ← 会话顶部实时花费芯片与换价倒计时
```

点击芯片可展开交互式详情面板：按每 1M Token 展示峰谷两档费率表格（高亮显示当前激活档位）、UTC 优惠时间段状态以及各模型在当前会话中的累计消费明细。

---

## 🏛️ 架构设计

```mermaid
graph TD
    subgraph StreamTelemetry ["DSH 流式遥测运行时"]
        Req["LLM 请求 / 报头<br/>(provider, model)"]
        StreamHook["增量流式分片 Hook"]
        Proj["costByModel 会话投影<br/>(半小时 UTC 时隙)"]
    end

    subgraph PricingCatalog ["费率解析引擎"]
        Manual["自定义费率配置<br/>(settings.yaml: prices)"]
        DeepSeekTier["DeepSeek 官方费率<br/>(高峰 / 闲时 50% 折扣)"]
        OpenRouterTier["OpenRouter 公开目录<br/>(每日自动缓存)"]
    end

    subgraph UI ["用户交互界面"]
        Chip["顶部花费芯片<br/>(实时计费 + 换价倒计时)"]
        Modal["消费明细抽屉面板<br/>(1M 单价表, UTC 时段, 模型清单)"]
        Settings["设置卡片<br/>(币种符号, 汇率, 时区)"]
    end

    Req --> Proj
    StreamHook --> Proj
    Proj --> Chip
    PricingCatalog --> Proj
    Manual --> PricingCatalog
    DeepSeekTier --> PricingCatalog
    OpenRouterTier --> PricingCatalog
    Chip --> Modal
```

---

## ✨ 核心特性

1. **增量流式实时计算**：在模型打字生成过程中毫秒级更新 Prompt、Completion 和 Cache 费用，无轮询无卡顿。
2. **两级阶梯电价引擎**：支持 DeepSeek 官方高峰时段（UTC 01:00–04:00 与 06:00–10:00）及闲时 50% 优惠折扣自动匹配。
3. **UTC 半小时时隙不可变性**：历史消费严格锁定在消耗发生时刻的时隙费率，切换费率不溯及既往。
4. **服务商智能路由**：精准区分直连 DeepSeek 服务商与 OpenRouter 等代理网关。
5. **多币种与本地化**：支持自定义货币符号（`¥`, `$`, `€`, `₽`）、汇率换算与显示时区。

---

## 📦 快速安装

```bash
dsh plugin --profile web add @goodandready/dsh-cost-meter
```

重启 DeepSeek Harness 实例并刷新浏览器页面。

---

## ⚙️ 配置项说明 (`settings.yaml`)

```yaml
dsh-cost-meter:
  currency: "¥"
  usdRate: 7.2
  displayTimeZone: "Asia/Shanghai"
  useOpenRouter: true
  prices: {}
  modelMap: {}
```

### 配置参数列表

| 参数项 | 类型 | 默认值 | 说明 |
|:---|:---|:---|:---|
| `currency` | `string` | `"¥"` | 显示的货币符号或代码 |
| `usdRate` | `number` | `7.2` | 美元到目标货币的换算汇率 |
| `displayTimeZone` | `string` | `"Asia/Shanghai"` | 界面中优惠时间段显示的参考时区 |
| `useOpenRouter` | `boolean` | `true` | 是否加载 OpenRouter 价格表作为备用 |
| `prices` | `object` | `{}` | 自定义每 1M Token 的费率覆盖 |
| `modelMap` | `object` | `{}` | 模型别名映射表 |

---

## 🧪 自动化测试

运行单元测试套件：

```bash
npm test
```

---

## 📄 许可证

MIT © [GooDAnDReaDY](https://github.com/GooDAnDReaDY)