# @forge/jira-bridge 中文文档

规范地址：https://npmcn.com/package/%40forge/jira-bridge/

版本：1\.3\.0
npm 元数据更新时间：2026-11-09T07:45:20.258Z
中文译文更新时间：2026-11-15T07:25:40.256Z
软件包许可：SEE LICENSE IN LICENSE\.txt

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

原始 npm 页面：https://www.npmjs.com/package/%40forge/jira-bridge
原文对照：https://npmcn.com/package/%40forge/jira-bridge/?lang=original

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

- 包体积（解压后）：128 kB，187 个文件
- TypeScript 类型：包内自带
- 运行依赖：0 个
- peer 依赖：typescript \>=5\.0\.0
- 首次发布：2022-01-11T10:19:57.595Z
- 最新版本发布：2026-11-09T07:45:20.062Z
- 近 30 天下载量：86128（2026-10-16 至 2026-11-14，npm 官方下载统计）
- 已发布版本数：206（近 12 个月 30 个）

## 中文简介

用于自定义 UI 应用程序的 Forge Jira Bridge API

## 安装

```sh
npm install @forge/jira-bridge
```

也可以使用：`pnpm add @forge/jira-bridge`、`yarn add @forge/jira-bridge`、`bun add @forge/jira-bridge`

## README

# Forge Jira桥 API

## 注册自定义域 UIM 处理器

`customFieldApi.registerUIMHandlers` 允许选择的 Forge 对象自定义字段 在其挂载视图或编辑运行时间中验证 UIM 值和选项可见性建议 . 这个API需要有一个Jira主机,并启用完成的自控器能力. 拒绝的旧主机 `error.code === 'FCF_UIM_HANDLERS_UNSUPPORTED'`。 。 。 . 使用 `isFcfError(error)` 在树枝之前 `error.code` 在一个 `catch (error: unknown)` 块.

```ts
import { customFieldApi, isFcfError, type UIMHandlers } from '@forge/jira-bridge';

type Service = { id: string; name: string };
const handlers: UIMHandlers<Service> = {
  setValue(proposed, context) {
    // Validate the caller and proposed value using your app's domain policy.
    // Return a canonical JSON object, or null to clear the field.
    return { accepted: true, value: proposed };
  }
};

const registration = await customFieldApi.registerUIMHandlers(handlers);
// When this runtime unmounts:
await registration.unregister();
```

`setValue` 财务报告和审定财务报表 `setOptionsVisibility` 独立选择。 登记无论是, 或空处理器地图。 没有请求的处理器的注册运行时间 不支持这项行动: `FCF_OPERATION_UNSUPPORTED` 通过UIM的错误通道而不应用建议. 缺失的注册 仍然遵循东道主的准备规则. 两个处理器都支持同步 和同步结果: `{ accepted: true, value }` 或者说 `{ accepted: false, code, message? }`。 。 。 . `null` 清除对象字段, `undefined`, (中文(简体) ), 非JSON值和错误结果无效。 Jira验证和适用已接受 通过其现有形式或持久性途径取得结果。 帮手不能坚持 建议或呼吁 `view.submit` 他们自己.

东道方用品 `callerAppId`, (中文(简体) ), `fieldId`, (中文(简体) ), `requestId`, (中文(简体) ), `renderContext`, (中文(简体) ), `currentValue` 财务报告和审定财务报表 `optionsVisibility`。这些描述UIM的引用,而不是 提供经认证的应用软件解析器出处。 UIM 设置保持同步 可连锁,应用失败通过 `uiModificationsApi.onError`。 。 。 .

注册在主机存储可调用处理器后解决. 注册一次 每个挂载运行时间。 重新登记取代运行时的处理器,处理一个 旧的登记不能取消替换. `unregister()` 返回等元符 承诺并立即禁用本地调用, 即使主机清理拒绝 . 申请清理还必须处理卸载后解决的登记.

保留 `isUIModificationsEnabled: true` 在现有的 `jira:customField` 或者说 `jira:customFieldType` 模块。 没有额外的显示资源或通用桥 API 所需经费。 主机部署和控制的应用程序迁移必须先于一般使用, 旧主机保留其先前的对象- UIM 行为 .

## 常见问题

### @forge/jira-bridge 是什么？

用于自定义 UI 应用程序的 Forge Jira Bridge API

### 如何安装 @forge/jira-bridge？

在项目目录运行 npm install @forge/jira-bridge，或使用 pnpm add / yarn add / bun add。

### @forge/jira-bridge 支持 TypeScript 吗？

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

### @forge/jira-bridge 可以商用吗？

@forge/jira-bridge 使用 SEE LICENSE IN LICENSE\.txt 许可。许可条款写在包内的独立文件中，请阅读该文件确认可否商用。以上为概括，不构成法律意见，请以许可原文为准。

### @forge/jira-bridge 的下载量有多少？

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

### @forge/jira-bridge 还在维护吗？

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