# @harnessio/react-ccm-service-client 中文文档

规范地址：https://npmcn.com/package/%40harnessio/react-ccm-service-client/

版本：0\.4\.9
npm 元数据更新时间：2026-11-16T17:37:16.930Z
中文译文更新时间：2026-11-17T10:15:00.729Z
软件包许可：MIT

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40harnessio/react-ccm-service-client
原文对照：https://npmcn.com/package/%40harnessio/react-ccm-service-client/?lang=original
项目主页：https://github.com/harness/react-api-client
源码仓库：https://github.com/harness/react-api-client

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：1.1 MB，1466 个文件
- 模块格式：CommonJS
- TypeScript 类型：包内自带
- 运行依赖：1 个
- 首次发布：2026-06-10T05:02:14.523Z
- 最新版本发布：2026-11-11T08:12:19.125Z
- 近 30 天下载量：97956（2026-10-18 至 2026-11-16，npm 官方下载统计）
- 已发布版本数：11（近 12 个月 11 个）

## 中文简介

驾驭CM 与反应钩子结合的服务 API

## 安装

```sh
npm install @harnessio/react-ccm-service-client
```

也可以使用：`pnpm add @harnessio/react-ccm-service-client`、`yarn add @harnessio/react-ccm-service-client`、`bun add @harnessio/react-ccm-service-client`

## README

# 反应 CCM 服务客户端

**OpenAPI - > OA**

**类型脚本 - > TS 翻译**

**OpenAPI + TypeScript - > 业务**

这个反应 API 客户端存储了 Harness CCM (Cloud Cost Management) 服务 API 和 接口合同的集合 `OATS CLI`。API被暴露为基于 `@tanstack/react-query`。 。 。 .

## 构建

```
yarn build
```

## 初始化客户端

在使用任何钩之前, 初始化 `CCMServiceAPIClient` 使用您的认证和 URL 配置 :

```ts
import { CCMServiceAPIClient } from '@harnessio/react-ccm-service-client';

new CCMServiceAPIClient({
  urlInterceptor: (url) => `${window.apiUrl}/${url}`,
  getRequestHeaders: () => ({
    Authorization: `Bearer ${yourToken}`,
    'Harness-Account': accountId,
  }),
  requestInterceptor: (request) => {
    // optionally modify the Request object before it is sent
    return request;
  },
  responseInterceptor: (res) => {
    if (res.status === 401) {
      window.dispatchEvent(new CustomEvent('PROMISE_API_RESPONSE', { detail: { response: res } }));
    }
    return res;
  },
});
```

## 运行时更新信头

客户事件曝光 `updateHeaders` 以在初始化后补丁标题( 如在符号刷新后) :

```ts
const client = new CCMServiceAPIClient({ ... })

// later, when the token changes:
client.updateHeaders({ Authorization: `Bearer ${newToken}` })
```

## CCM 一体化

CCM 用户界面 `restful-react` 今时. 要采用此软件包, 您需要三次修改 :

| 变动 | 何处 | 需求 |
| --- | --- | --- |
| `yarn add @tanstack/react-query` | 《集束弹药公约》 `package.json` | 是——对同伴的依赖 |
| 环绕应用 `<QueryClientProvider>` | `App.tsx` 或者说 `bootstrap.tsx` | 是的,没有它钩是行不通的 |
| 打电话 `new CCMServiceAPIClient(...)` | App init/ 拖带 | 是的,如不打电话,采集者会扔出 |

### 最小拖带示例

```tsx
import { QueryClient, QueryClientProvider } from '@tanstack/react-query';
import { CCMServiceAPIClient } from '@harnessio/react-ccm-service-client';

new CCMServiceAPIClient({
  urlInterceptor: (url) => `${window.apiUrl}/${url}`,
  getRequestHeaders: () => ({ Authorization: `Bearer ${token}`, 'Harness-Account': accountId }),
  responseInterceptor: (res) => {
    window.dispatchEvent(new CustomEvent('PROMISE_API_RESPONSE', { detail: { response: res } }));
    return res;
  },
});

const queryClient = new QueryClient();

export default function Root() {
  return (
    <QueryClientProvider client={queryClient}>
      <App />
    </QueryClientProvider>
  );
}
```

## 地方发展与雅尔克

使用 [雅尔克语](https://github.com/wclr/yalc) 在发布前测试 CCM UI 的本地变化 .

**第1步——建设并发布到当地的雅尔克商店:**

```bash
cd packages/ccm-service
yarn build
yalc publish
```

**步骤2——加入《集束弹药公约》**

```bash
cd /path/to/ccm-ui
yalc add @harnessio/react-ccm-service-client
yarn install
yarn add @tanstack/react-query   # if not already present
```

**步骤3——重建后同步:**

```bash
# in packages/ccm-service:
yarn build && yalc push
```

**完成时删除雅尔克链接 :**

```bash
cd /path/to/ccm-ui
yalc remove @harnessio/react-ccm-service-client
yarn install
```

## 版本

![@harnessio/react-ccm-service-client](https://img.shields.io/npm/v/@harnessio/react-ccm-service-client.svg?style=flat-square)

版本由OpenAPI spec驱动. 不手工编辑文件 `src/services/` - 运行 `yarn generate` 更新后 `openapi.json`。 。 。 .

## 许可证

[麻省理工学院](https://npmcn.com/package/%40harnessio/react-ccm-service-client/LICENSE.md)版权(c) [调理公司](https://harness.io/)

## 常见问题

### @harnessio/react-ccm-service-client 是什么？

驾驭CM 与反应钩子结合的服务 API

### 如何安装 @harnessio/react-ccm-service-client？

在项目目录运行 npm install @harnessio/react-ccm-service-client，或使用 pnpm add / yarn add / bun add。

### @harnessio/react-ccm-service-client 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### @harnessio/react-ccm-service-client 支持 ESM 还是 CommonJS？

以 CommonJS 形式发布，可以直接 require\(\)；在 ES Module 项目中也可以用 import 引入（Node\.js 会把 module\.exports 作为默认导出）。

### @harnessio/react-ccm-service-client 可以商用吗？

@harnessio/react-ccm-service-client 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### @harnessio/react-ccm-service-client 的下载量有多少？

根据 npm 官方下载统计，@harnessio/react-ccm-service-client 在 2026/10/18 – 2026/11/16 这 30 天内被下载 97,956 次，日均约 3,265 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @harnessio/react-ccm-service-client 还在维护吗？

最新版本 0\.4\.9 发布于 2026/11/11（6 天前）；至今共发布 11 个版本，其中过去 12 个月发布了 11 个；首次发布于 2026/06/10。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。

