CDX 扩展性 SDK - 网络畅通
发表于 @cdx-extensions/di-sdk-web. 模拟实施CDX扩展SDK,用于本地开发网页扩展. 与真实的web SDK同名的软件包;注册(public npm vs JFrog)决定了安装哪个执行.
概览
Web Harness为建设没有完整生产平台的平台扩展提供了现实的发展环境. 它包括:
- 模拟用户上下文数据
- 模拟网络延迟
- 可配置的 API 端点
- 品牌/支持
- 用错误模拟安全 HTTP 客户端
这个图书馆是独立的. 运行时由 JFrog 解决依赖性 pnpm install 在此文件夹中。 从此目录构建并发布 .
安装
pnpm add @cdx-extensions/di-sdk-web
(当使用公共npm时,消费者得到这种被子;当使用Candescent JFrog时,他们得到真正的执行. )
使用量
绳子暴露了 平台 举个例子 通过它 WebPlatform.getInstance() 并用它的方法在您的反应组件中.
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',
});
发展
从寄存器根 :
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 端点的环境变量.
文档
许可证
公务员制度委员会
CDX = 干燥开发者经验