ShieldForTCB SDK

ShieldForTCB Node.js SDK - 敏感信息管理服务客户端

安装

npm install @be-link/shield-for-tcb-node-sdk
# 或
pnpm add @be-link/shield-for-tcb-node-sdk

使用

import { backendConfigService, frontendConfigService } from '@be-link/shield-for-tcb-node-sdk'

// 服务端使用（默认，包含异常处理）
const config = await backendConfigService.fetchConfig({ key: 'your-key', type: 'json' })

// 前端使用（跳过异常处理，直接抛出原始错误）
const frontendConfig = await frontendConfigService.fetchConfig({ key: 'your-key', type: 'json' })

// 获取全局动态配置
const globalConfig = await backendConfigService.fetchGlobalDynamicConfig()

// 获取 COS 临时密钥
const cosTempSecret = await backendConfigService.getCosTempSecret()

发布流程

自动发布（推荐）

使用发布脚本，会自动完成版本更新、构建和发布：

# 在 SDK 目录下执行
cd packages/sdk
pnpm publish

# 或在根目录执行
pnpm publish:sdk

发布脚本会自动：

1. 设置 npm 配置和认证（需要 NPM_DEPLOY_TOKEN 环境变量）
2. 更新版本号（使用 npm version patch，只读模式）
3. 构建项目
4. 发布到 npm（使用 pnpm publish --no-git-checks，只读文件发布）
5. 发送飞书通知（需要 FEISHU_WEBHOOK_URL 环境变量）

环境变量

发布脚本需要以下环境变量（可选）：

• NPM_DEPLOY_TOKEN: npm 发布 token
• FEISHU_WEBHOOK_URL: 飞书 webhook URL（用于发送发布通知）

CI/CD 集成

在 Jenkins 或其他 CI/CD 平台中，可以这样使用：

export NPM_DEPLOY_TOKEN="your-token"
export FEISHU_WEBHOOK_URL="https://open.feishu.cn/open-apis/bot/v2/hook/xxx"
cd packages/sdk
pnpm publish

手动发布

如果需要手动发布：

# 1. 构建
pnpm build

# 2. 进入 dist 目录发布（只读文件发布）
cd dist
pnpm publish --no-git-checks --access public
cd ..

License

ISC