@udhold/udhold-api-types
v2.1.0
Published
UDhold 插件 API 类型与能力目录(window.udhold 类型提示 + plugin.json JSON Schema + 权限目录单一真相源)
Readme
udhold-api-types(项目内插件 API 类型契约)
本目录是 udhold-tauri 项目内的插件 API 类型契约:window.udhold 的类型定义 + 对外接口文档,
作为 plugin-api-restore(插件 API 桥还原)与统一桥/SDK 实现的契约依据。还原逻辑遵循
udo-tools(Electron/Node.js)版,以还原功能点为核心,不虚增新功能。
目录内容
| 文件 | 说明 |
| ---- | ---- |
| API.md | 对外 API 接口文档:命名空间总览、plugin.json 声明契约、逐命名空间方法说明、兼容性映射、类型与运行时差异 |
| udhold.api.d.ts | window.udhold 类型定义(基线 + 项目扩展,见下) |
| index.d.ts / udbrowser.d.ts | 类型入口与辅助声明(udbrowser.d.ts 即 uTools 包的 ubw.d.ts,UDhold 化改名) |
| enums.ts | 市场域接口枚举与展示文案(运行时值,唯一运行时导出模块;插件统一 import { ... } from '@udhold/udhold-api-types/enums',2026-09-24 自 dev-launch/ud-plugins 的重复自持份上收) |
| resource/ | udhold.schema.json(plugin.json JSON Schema)+ udhold-type.d.ts(模块化 re-export) |
| tsconfig.json | 本目录类型校验配置 |
| LICENSE | MIT(类型定义派生自 uTools-Labs/utools-api-types) |
基线与扩展
- 基线:拷贝自 udo-tools 仓库
udhold-api-types子模块(npm 包@udhold/udhold-api-types的发布源,保持只读、不改动)。 - 项目扩展(本目录
udhold.api.d.ts在基线上叠加,清单与背景见 API.md「类型定义与运行时差异」):UDholdSettingApi(udhold.setting.*)——core 设置类方法的开放形态重组,general-setting 桥已按此形态落地UDholdClipboardApi(udhold.clipboard.*)——preload 实际暴露但基线未收录的剪贴板历史命名空间showContextMenu/onContextMenuCommand/onFindInPageResult/offFindInPageResult/sendInputEvent——preload 实际暴露但基线未收录的顶层方法
- 扩展段若需进入 npm 类型包,须回传 udo-tools 仓库的子模块(那边是发布源)。
本地校验
cd udhold-api-types
# 用项目内 tsc
../../node_modules/.bin/tsc -p tsconfig.json