# @cdx-extensions/di-sdk-web 中文文档

规范地址：https://npmcn.com/package/%40cdx-extensions/di-sdk-web/

版本：2\.1\.8
npm 元数据更新时间：2026-09-01T06:12:41.032Z
中文译文更新时间：2026-11-09T10:36:12.209Z
软件包许可：ISC

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

原始 npm 页面：https://www.npmjs.com/package/%40cdx-extensions/di-sdk-web
原文对照：https://npmcn.com/package/%40cdx-extensions/di-sdk-web/?lang=original
项目主页：https://github.com/dfh-digital-insight/cdx-extensibility-sdk/tree/main/libs/public/extensibility-sdk-web-harness
源码仓库：https://github.com/dfh-digital-insight/cdx-extensibility-sdk

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

- 包体积（解压后）：80.2 kB，28 个文件
- 模块格式：CommonJS
- TypeScript 类型：包内自带
- 运行依赖：3 个
- peer 依赖：@cdx-extensions/di-sdk-types 1\.1\.8，@mui/material 7\.3\.4，react 18\.2\.0
- 首次发布：2026-03-31T14:06:25.587Z
- 最新版本发布：2026-09-01T06:12:40.797Z
- 近 30 天下载量：2891（2026-10-10 至 2026-11-08，npm 官方下载统计）
- 已发布版本数：14（近 12 个月 14 个）

## 中文简介

开发本地网络扩展的利用——Candescent开发者经验的一部分

## 安装

```sh
npm install @cdx-extensions/di-sdk-web
```

也可以使用：`pnpm add @cdx-extensions/di-sdk-web`、`yarn add @cdx-extensions/di-sdk-web`、`bun add @cdx-extensions/di-sdk-web`

## README

# CDX 扩展性 SDK - 网络畅通

> 部分 [Candescent 开发者经验( CDX)](https://github.com/candescent-dx/extensibility-docs)

发表于 **`@cdx-extensions/di-sdk-web`**. 模拟实施CDX扩展SDK,用于本地开发网页扩展. 与真实的web SDK同名的软件包;注册(public npm vs JFrog)决定了安装哪个执行.

## 概览

Web Harness为建设没有完整生产平台的平台扩展提供了现实的发展环境. 它包括:

-   模拟用户上下文数据
-   模拟网络延迟
-   可配置的 API 端点
-   品牌/支持
-   用错误模拟安全 HTTP 客户端

**这个图书馆是独立的.** 运行时由 JFrog 解决依赖性 `pnpm install` 在此文件夹中。 从此目录构建并发布 .

## 安装

```bash
pnpm add @cdx-extensions/di-sdk-web
```

(当使用公共npm时,消费者得到这种被子;当使用Candescent JFrog时,他们得到真正的执行. )

## 使用量

绳子暴露了 **平台** 举个例子 通过它 `WebPlatform.getInstance()` 并用它的方法在您的反应组件中.

```typescript
import {
  getUserContext,
  getConfig,
  getBranding,
  httpClient,
  UserContext,
  ExtensibilityConfig,
  BrandingConfig,
} from '@cdx-extensions/di-sdk-web';

const platform = WebPlatform.getInstance();

// Get configuration
const config: ExtensibilityConfig = getConfig();
console.log(config.apiBaseUrl);

// Get branding
const branding: BrandingConfig = getBranding();

// Make API calls (use httpClient, not fetch directly)
const response = await httpClient.post('/api/agent/chat', {
  message: 'Hello',
  conversationId: 'conv-123',
});
```

## 发展

从寄存器根 :

```bash
cd libs/public/extensibility-sdk-web-harness
pnpm install
pnpm run build
```

**正在开发的出版:** 要发布此 lib 在开发过程中不影响主版本, 请从此目录中运行 : `pnpm publish --tag development`。 。 。 .

制作版本在合并改动后更新 `main` (CI运行发布工作流程).

## API 参考

-   **`getUserContext(): Promise<UserContext>`** ——返回模拟用户上下文.
-   **`getConfig(): ExtensibilityConfig`** ——回归平台配置(环境,API基础URL,特征旗).
-   **`getBranding(): BrandingConfig`** ——回归品牌/品牌配置.
-   **`httpClient`** 安全 HTTP 客户端; 使用代替 `fetch()`方法: `get`, (中文(简体) ), `post`, (中文(简体) ), `put`, (中文(简体) ), `patch`, (中文(简体) ), `delete`。 。 。 .

## 模拟数据

自定义模拟 `src/mocks/` (例如:. `userContext.json`) (中文(简体) ). 设定 `API_BASE_URL` 用于自定义 API 端点的环境变量.

## 文档

-   [完整文档](https://github.com/candescent-dx/extensibility-docs)
-   [开始](https://github.com/candescent-dx/extensibility-docs/docs/getting-started)

## 许可证

公务员制度委员会

**CDX = 干燥开发者经验**

## 常见问题

### @cdx-extensions/di-sdk-web 是什么？

开发本地网络扩展的利用——Candescent开发者经验的一部分

### 如何安装 @cdx-extensions/di-sdk-web？

在项目目录运行 npm install @cdx-extensions/di-sdk-web，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：@cdx-extensions/di-sdk-types（1\.1\.8）、@mui/material（7\.3\.4）、react（18\.2\.0）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @cdx-extensions/di-sdk-web 支持 TypeScript 吗？

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

### @cdx-extensions/di-sdk-web 支持 ESM 还是 CommonJS？

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

### @cdx-extensions/di-sdk-web 可以商用吗？

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

### @cdx-extensions/di-sdk-web 的下载量有多少？

根据 npm 官方下载统计，@cdx-extensions/di-sdk-web 在 2026/10/10 – 2026/11/08 这 30 天内被下载 2,891 次，日均约 96 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @cdx-extensions/di-sdk-web 还在维护吗？

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