@kimposoft/plugin-sdk 0.0.0-stage → 1.1.0-tp.22
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +202 -0
- package/NOTICE +9 -0
- package/README.md +48 -2
- package/package.json +145 -4
- package/src/action-designer.ts +267 -0
- package/src/attachment-open.ts +574 -0
- package/src/attachment-url.ts +235 -0
- package/src/auth/index.ts +6 -0
- package/src/auth/qrcode.ts +519 -0
- package/src/auth/types.ts +261 -0
- package/src/display-style.ts +532 -0
- package/src/editor-frame.ts +625 -0
- package/src/editor-session.ts +1214 -0
- package/src/editor-testing.ts +838 -0
- package/src/editor.ts +1720 -0
- package/src/frame-transport.ts +516 -0
- package/src/frontend-routes.ts +99 -0
- package/src/hooks.ts +48 -0
- package/src/host-caps.ts +93 -0
- package/src/i18n.ts +238 -0
- package/src/im-panel.ts +132 -0
- package/src/image-tools.ts +91 -0
- package/src/index.ts +125 -0
- package/src/interactive-session.ts +94 -0
- package/src/nahida-im.ts +391 -0
- package/src/nahida-ws.ts +23 -0
- package/src/org-directory.ts +78 -0
- package/src/oz-realtime.ts +144 -0
- package/src/page.ts +591 -0
- package/src/print.ts +393 -0
- package/src/surface.ts +310 -0
- package/src/theme-mocks.ts +140 -0
- package/src/theme.ts +125 -0
- package/src/ui-fixtures/attachment.ts +24 -0
- package/src/ui-fixtures/confirm.ts +16 -0
- package/src/ui-fixtures/entity-picker.ts +24 -0
- package/src/ui-fixtures/expression-editor.ts +52 -0
- package/src/ui-fixtures/image-cropper.ts +23 -0
- package/src/ui-fixtures/index.ts +17 -0
- package/src/ui-fixtures/org-tri-picker.ts +19 -0
- package/src/ui-fixtures/prompt.ts +19 -0
- package/src/ui-fixtures/record-picker.ts +17 -0
- package/src/ui-fixtures/template-picker.ts +13 -0
- package/src/ui-mocks.ts +264 -0
- package/src/ui.ts +491 -0
- package/src/workflow-designer.ts +475 -0
package/src/ui.ts
ADDED
|
@@ -0,0 +1,491 @@
|
|
|
1
|
+
// ui.ts —— 宿主 UI 服务总线(平台级契约面,非任何插件分类独占)。
|
|
2
|
+
//
|
|
3
|
+
// 「常用界面由宿主渲染一次,kimpo 内部与所有插件用同一个入口唤起」。插件侧**零 UI 代码、
|
|
4
|
+
// 零样式拷贝、零鉴权自理**:调用即弹出宿主对话框,确认后拿回一份纯 JSON 结果。宿主升级
|
|
5
|
+
// 组件,所有调用方即时生效。
|
|
6
|
+
//
|
|
7
|
+
// 【为什么是 ui.* 而不是挂在某个分类下】
|
|
8
|
+
// 表达式编辑器这类界面是平台级 UI 能力,不属于任何插件分类:如果挂在某个分类的命名空间下
|
|
9
|
+
// (例如 `workflow.*`),其他分类的插件(如表格编辑器)想用就得先声明别人的能力。
|
|
10
|
+
// 因此本文件把这类能力统一收到平台级 `ui.*` 域。
|
|
11
|
+
//
|
|
12
|
+
// 【请求必须是纯 JSON】
|
|
13
|
+
// 宿主与插件目前同 realm,传函数在今天能跑;但插件将来可能被放进 iframe 沙箱,届时请求要过
|
|
14
|
+
// 一次结构化克隆。所以插件门面的请求一律纯 JSON——宿主侧有对应闸门,带函数会当场抛错,
|
|
15
|
+
// 而不是等到沙箱化那天才断。
|
|
16
|
+
|
|
17
|
+
import type { ImageCropperOptions, ImageCropperResult } from './image-tools';
|
|
18
|
+
// 附件打开服务:请求 / 结果类型随附件插件契约放在 attachment-open.ts,这里只接进总线。
|
|
19
|
+
import type { OpenAttachmentRequest, OpenAttachmentResult } from './attachment-open';
|
|
20
|
+
|
|
21
|
+
// ---------------------------------------------------------------------------
|
|
22
|
+
// 服务一:全局表达式编辑器
|
|
23
|
+
// ---------------------------------------------------------------------------
|
|
24
|
+
|
|
25
|
+
/**
|
|
26
|
+
* 统一表达式中间模型(ExpressionModel)。
|
|
27
|
+
*
|
|
28
|
+
* **本 SDK 刻意不描述它的内部结构**:模型的权威定义与编译在宿主
|
|
29
|
+
* (宿主表达式引擎与表达式编辑器组件),
|
|
30
|
+
* 插件只负责原样存取——把编辑器产出的模型塞进自己的设计文档、下次打开时原样递回。
|
|
31
|
+
* 若在这里镜像一份字段定义,两侧就会各自演进、迟早漂移。
|
|
32
|
+
*/
|
|
33
|
+
export type ExpressionModel = Record<string, unknown>;
|
|
34
|
+
|
|
35
|
+
/** 编辑目的:judge=产出布尔条件(隐藏目标段);output=产出写入目标字段的值。 */
|
|
36
|
+
export type ExpressionEditorMode = 'judge' | 'output';
|
|
37
|
+
|
|
38
|
+
export interface OpenExpressionEditorRequest {
|
|
39
|
+
mode: ExpressionEditorMode;
|
|
40
|
+
/** 弹窗标题(如「分支条件」)。缺省按 mode 取通用标题。 */
|
|
41
|
+
title?: string;
|
|
42
|
+
/** 编辑区上方的场景化引导语。缺省按 mode 取。 */
|
|
43
|
+
guide?: string;
|
|
44
|
+
/** 打开时的初始模型;缺省=新建一份空模型。 */
|
|
45
|
+
value?: ExpressionModel;
|
|
46
|
+
context: {
|
|
47
|
+
appId: string;
|
|
48
|
+
/** 字段目录的根模板(编辑器据此解析 模板→数据表→字段 三层树)。 */
|
|
49
|
+
templateId: string;
|
|
50
|
+
/**
|
|
51
|
+
* 可选(追加字段,不递增代际):调用方按当前上下文追加的系统变量,
|
|
52
|
+
* 拼在宿主静态系统变量目录之后展示(同 var_id 去重,宿主内置项优先保留)。典型消费方=流程设计器
|
|
53
|
+
* 用它注入「流程变量 + 上游审批按钮结果」(边条件里的 flow.* / node["id"].result.* 两类系统变量
|
|
54
|
+
* 不在宿主内置目录里,需要调用方注入才能在编辑器里选到)。
|
|
55
|
+
* 缺省=不追加。设计态预览只验证语法(宿主按 NULL 占位),真值仅在
|
|
56
|
+
* 运行期由调用方自行解析——本字段只解决"编辑器里选得到",不改变求值链路。
|
|
57
|
+
*/
|
|
58
|
+
extraSystemVariables?: Array<{
|
|
59
|
+
var_id: string;
|
|
60
|
+
label: string;
|
|
61
|
+
type: 'string' | 'number' | 'datetime' | 'boolean';
|
|
62
|
+
}>;
|
|
63
|
+
};
|
|
64
|
+
/**
|
|
65
|
+
* 可选(追加字段,不递增代际):来源锁定策略。
|
|
66
|
+
* 'current_record_only' = 编辑器锁定来源面——不可新增来源表/JOIN(隐式当前记录主/明细上下文表
|
|
67
|
+
* 仍由编辑器自动纳入,存量越界来源仍可查看/移除);缺省/'any' = 不限制。
|
|
68
|
+
* 用途:某些场景(如流程边条件)不装配来源表,调用方判定当前场景只应引用"当前记录"时传
|
|
69
|
+
* 'current_record_only',从源头避免用户配出无法求值的来源引用。
|
|
70
|
+
*/
|
|
71
|
+
sourcePolicy?: 'any' | 'current_record_only';
|
|
72
|
+
}
|
|
73
|
+
|
|
74
|
+
export interface OpenExpressionEditorResult {
|
|
75
|
+
/** 用户点了确认=true;取消/关闭=false(此时 model 恒为 null,调用方不应写回)。 */
|
|
76
|
+
confirmed: boolean;
|
|
77
|
+
model: ExpressionModel | null;
|
|
78
|
+
}
|
|
79
|
+
|
|
80
|
+
// ---------------------------------------------------------------------------
|
|
81
|
+
// 服务二:通讯录选人器
|
|
82
|
+
// ---------------------------------------------------------------------------
|
|
83
|
+
|
|
84
|
+
/**
|
|
85
|
+
* 可选实体类型:'user' 选人 / 'dept' 选部门。
|
|
86
|
+
*
|
|
87
|
+
* 宿主两档都支持。
|
|
88
|
+
*/
|
|
89
|
+
export type EntityPickerKind = 'user' | 'dept';
|
|
90
|
+
|
|
91
|
+
/**
|
|
92
|
+
* 选中的部门条目(仅镜像插件真正会用到的字段,不搬宿主 dept-picker.vue 的全部字段——同下方
|
|
93
|
+
* `PickedUser` 的既定原则:插件拿部门是为了存 ID 与展示路径,多余字段只会制造漂移面)。
|
|
94
|
+
*/
|
|
95
|
+
export interface PickedDept {
|
|
96
|
+
id: string;
|
|
97
|
+
org_name: string;
|
|
98
|
+
/** 部门全路径名(如「金宝量行/研发部」),供插件侧直接展示,不必自行拼接。 */
|
|
99
|
+
path_name: string;
|
|
100
|
+
include_children: boolean;
|
|
101
|
+
}
|
|
102
|
+
|
|
103
|
+
export interface OpenEntityPickerRequest {
|
|
104
|
+
/** 要选什么,缺省 ['user']。未支持的档位被忽略而非抛错(调用方常按配置渲染)。 */
|
|
105
|
+
kinds?: EntityPickerKind[];
|
|
106
|
+
/** 是否多选,缺省 true。 */
|
|
107
|
+
multiple?: boolean;
|
|
108
|
+
/** 最多可选,缺省 1000。 */
|
|
109
|
+
max?: number;
|
|
110
|
+
/** 弹窗标题,缺省走宿主的 i18n 默认值。 */
|
|
111
|
+
title?: string;
|
|
112
|
+
/** 标题右侧警示文案,仅 dept 档透传给宿主 dept-picker(user 档忽略)。 */
|
|
113
|
+
warnText?: string;
|
|
114
|
+
/** 新勾选部门的 include_children 初始值,仅 dept 档透传给宿主 dept-picker(user 档忽略)。 */
|
|
115
|
+
defaultIncludeChildren?: boolean;
|
|
116
|
+
/** 打开时的预选部门,仅 dept 档透传给宿主 dept-picker(user 档忽略;user 档宿主暂不支持
|
|
117
|
+
* 预选,见宿主 entity-picker/types.ts OpenEntityPickerRequest 注释)。 */
|
|
118
|
+
initialSelected?: PickedDept[];
|
|
119
|
+
}
|
|
120
|
+
|
|
121
|
+
/**
|
|
122
|
+
* 选人结果条目。
|
|
123
|
+
*
|
|
124
|
+
* 只镜像插件真正会用到的身份字段(不搬宿主 DirectoryUser 的全部字段)——插件拿人是为了
|
|
125
|
+
* 存 ID 与显示名,多余字段搬过来只会制造漂移面。
|
|
126
|
+
*/
|
|
127
|
+
export interface PickedUser {
|
|
128
|
+
user_id: string;
|
|
129
|
+
login_name: string;
|
|
130
|
+
display_name: string;
|
|
131
|
+
/** 停用/离职等状态由宿主判定;插件一般只做展示。 */
|
|
132
|
+
status_code?: string;
|
|
133
|
+
}
|
|
134
|
+
|
|
135
|
+
/**
|
|
136
|
+
* 选择结果:`{confirmed, users, depts}` 两个数组、未选的那档恒为空——对齐宿主侧
|
|
137
|
+
* `OpenEntityPickerResult` 的既定形态(不用判别联合,理由见宿主 entity-picker/types.ts 同名
|
|
138
|
+
* 类型注释:调用方发起时已经通过字面量 `kinds` 静态知道自己要哪一档,两个数组模式下直接读
|
|
139
|
+
* `result.users`/`result.depts` 即可,无需再收窄一次)。
|
|
140
|
+
*/
|
|
141
|
+
export interface OpenEntityPickerResult {
|
|
142
|
+
confirmed: boolean;
|
|
143
|
+
users: PickedUser[];
|
|
144
|
+
depts: PickedDept[];
|
|
145
|
+
}
|
|
146
|
+
|
|
147
|
+
// ---------------------------------------------------------------------------
|
|
148
|
+
// 服务三:记录选择器(X20:界面动作「打开表单」多命中场景)
|
|
149
|
+
// ---------------------------------------------------------------------------
|
|
150
|
+
|
|
151
|
+
/** 待选记录:record_id + 预览字段值(预览列顺序由 previewFieldIds 决定)。 */
|
|
152
|
+
export interface RecordPickerRecord {
|
|
153
|
+
record_id: string;
|
|
154
|
+
preview: Record<string, unknown>;
|
|
155
|
+
}
|
|
156
|
+
|
|
157
|
+
export interface OpenRecordPickerRequest {
|
|
158
|
+
records: RecordPickerRecord[];
|
|
159
|
+
/** 预览列顺序(= 后端 target.outputs 顺序)。 */
|
|
160
|
+
previewFieldIds: string[];
|
|
161
|
+
}
|
|
162
|
+
|
|
163
|
+
export interface OpenRecordPickerResult {
|
|
164
|
+
/** 用户点了某一条=true;取消/关闭=false(此时 recordId 恒为 null)。 */
|
|
165
|
+
confirmed: boolean;
|
|
166
|
+
recordId: string | null;
|
|
167
|
+
}
|
|
168
|
+
|
|
169
|
+
// ---------------------------------------------------------------------------
|
|
170
|
+
// 服务四:图片裁切/调整弹窗
|
|
171
|
+
// ---------------------------------------------------------------------------
|
|
172
|
+
// 请求/结果直接复用本包 image-tools.ts 的 ImageCropperOptions/ImageCropperResult(同一份像素
|
|
173
|
+
// 裁切参数权威定义),不重新镜像一份字段——这与本文件其余三个服务「刻意不复用宿主/其他模块
|
|
174
|
+
// 类型」的做法不同,是因为 image-tools.ts 本就是 SDK 内的平台级契约,不存在"两侧各自演进"的
|
|
175
|
+
// 漂移风险。
|
|
176
|
+
|
|
177
|
+
/**
|
|
178
|
+
* 请求即 ImageCropperOptions。
|
|
179
|
+
*
|
|
180
|
+
* 🔴 其中 `file?: File` 不是纯 JSON(JSON.stringify 会把它变成 `{}`),但也不是插件门面的
|
|
181
|
+
* 可序列化闸门会拦的类型(function/symbol/bigint)——File 是浏览器原生可结构化克隆对象
|
|
182
|
+
* (与 Blob/ArrayBuffer 同列),宿主与插件今天同 realm 直接传引用没有问题;即便将来插件搬进
|
|
183
|
+
* iframe 沙箱走 postMessage 结构化克隆,File 也能完整跨界存活,不会像函数那样直接失败。
|
|
184
|
+
*/
|
|
185
|
+
export type OpenImageCropperRequest = ImageCropperOptions;
|
|
186
|
+
|
|
187
|
+
export interface OpenImageCropperResult {
|
|
188
|
+
/** 用户点了确认=true;取消/关闭=false(此时 result 恒为 null)。 */
|
|
189
|
+
confirmed: boolean;
|
|
190
|
+
result: ImageCropperResult | null;
|
|
191
|
+
}
|
|
192
|
+
|
|
193
|
+
// ---------------------------------------------------------------------------
|
|
194
|
+
// 服务五:通用模板选择弹窗(流程设计器等设计层场景挑一个业务表单模板)
|
|
195
|
+
// ---------------------------------------------------------------------------
|
|
196
|
+
// 与宿主 features/host-ui/services/template-picker/types.ts 逐字对齐。只列本应用「表单类」
|
|
197
|
+
// 模板(宿主按 designer_type 白名单过滤,插件侧不需要关心该判据)。
|
|
198
|
+
|
|
199
|
+
export interface TemplatePickerRequest {
|
|
200
|
+
/** 只列这个应用下的模板。 */
|
|
201
|
+
appId: string;
|
|
202
|
+
/** 弹窗标题,缺省走宿主内置默认文案。 */
|
|
203
|
+
title?: string;
|
|
204
|
+
/** 打开时预选中的模板 id(回显选中态)。 */
|
|
205
|
+
selectedTemplateId?: string;
|
|
206
|
+
}
|
|
207
|
+
|
|
208
|
+
/** 选中的模板(只镜像插件真正会用到的展示/标识字段,不搬宿主 Template 的全部字段)。 */
|
|
209
|
+
export interface TemplatePickerResultTemplate {
|
|
210
|
+
template_id: string;
|
|
211
|
+
template_name: string;
|
|
212
|
+
/** 当前是否已发布过设计;false 时仍可选中,仅供调用方提示。 */
|
|
213
|
+
published: boolean;
|
|
214
|
+
}
|
|
215
|
+
|
|
216
|
+
export interface TemplatePickerResult {
|
|
217
|
+
/** 用户点了确认=true;取消/关闭=false(此时 template 恒为 null)。 */
|
|
218
|
+
confirmed: boolean;
|
|
219
|
+
template: TemplatePickerResultTemplate | null;
|
|
220
|
+
}
|
|
221
|
+
|
|
222
|
+
// ---------------------------------------------------------------------------
|
|
223
|
+
// 服务六:用户 / 角色 / 部门三维选择器(与模板权限同一套选择内核)
|
|
224
|
+
// ---------------------------------------------------------------------------
|
|
225
|
+
// 与宿主 features/host-ui/services/org-tri-picker/types.ts 逐字对齐。
|
|
226
|
+
|
|
227
|
+
/**
|
|
228
|
+
* 选中的用户。只镜像插件真正会用到的身份字段——与本文件 `PickedUser`(entityPicker 服务的
|
|
229
|
+
* 结果条目)字段完全一致,两个服务各自独立声明同名接口是刻意的:entityPicker 与
|
|
230
|
+
* orgTriPicker 是两个不同的服务位,即便当前碰巧字段相同,也不应该因为共享一个类型别名而
|
|
231
|
+
* 在某一方新增字段时意外牵连另一方。
|
|
232
|
+
*/
|
|
233
|
+
export interface OrgTriPickedUser {
|
|
234
|
+
user_id: string;
|
|
235
|
+
login_name: string;
|
|
236
|
+
display_name: string;
|
|
237
|
+
status_code?: string;
|
|
238
|
+
}
|
|
239
|
+
|
|
240
|
+
/** 选中的角色:scope 区分全局(实例)角色与应用角色。 */
|
|
241
|
+
export interface PickedRoleRef {
|
|
242
|
+
id: string;
|
|
243
|
+
name: string;
|
|
244
|
+
scope: 'instance' | 'app';
|
|
245
|
+
/** scope='app' 时所属应用 id。 */
|
|
246
|
+
app_id?: string;
|
|
247
|
+
}
|
|
248
|
+
|
|
249
|
+
/** 选中的部门:不含 include_children(部门页签选中的是部门本身,用于按直属成员计算的场景)。 */
|
|
250
|
+
export interface PickedDeptRef {
|
|
251
|
+
id: string;
|
|
252
|
+
org_name: string;
|
|
253
|
+
/** 部门全路径名(如「金宝量行/研发部」)。 */
|
|
254
|
+
path_name: string;
|
|
255
|
+
}
|
|
256
|
+
|
|
257
|
+
export interface OrgTriPickerRequest {
|
|
258
|
+
/** 角色页签「本应用角色」分组的来源应用;缺省时角色页签只显示全局角色。 */
|
|
259
|
+
appId?: string;
|
|
260
|
+
title?: string;
|
|
261
|
+
/** 打开时默认停留的页签(缺省 'user'):调用方明确只要某一类时传入,如「添加来源 → 角色」传 'role'。 */
|
|
262
|
+
initialTab?: 'user' | 'role' | 'dept';
|
|
263
|
+
/** 打开时的预选(回显),三类互相独立、缺省即空。 */
|
|
264
|
+
initial?: {
|
|
265
|
+
users?: OrgTriPickedUser[];
|
|
266
|
+
roles?: PickedRoleRef[];
|
|
267
|
+
depts?: PickedDeptRef[];
|
|
268
|
+
};
|
|
269
|
+
}
|
|
270
|
+
|
|
271
|
+
export interface OrgTriPickerResult {
|
|
272
|
+
/** 用户点了确认=true;取消/关闭=false(此时三个数组恒为空)。 */
|
|
273
|
+
confirmed: boolean;
|
|
274
|
+
users: OrgTriPickedUser[];
|
|
275
|
+
roles: PickedRoleRef[];
|
|
276
|
+
depts: PickedDeptRef[];
|
|
277
|
+
}
|
|
278
|
+
|
|
279
|
+
// ---------------------------------------------------------------------------
|
|
280
|
+
// 服务七:确认框
|
|
281
|
+
// ---------------------------------------------------------------------------
|
|
282
|
+
// 取代浏览器原生 window.confirm(插件不得使用原生弹框)。请求纯 JSON;正文是纯文本,
|
|
283
|
+
// 换行符按换行显示,宿主不解析 HTML。
|
|
284
|
+
|
|
285
|
+
/** 确认框外观档位:决定图标与确认按钮颜色(删除类不可恢复操作用 'error')。 */
|
|
286
|
+
export type ConfirmType = 'info' | 'success' | 'warning' | 'error';
|
|
287
|
+
|
|
288
|
+
export interface OpenConfirmRequest {
|
|
289
|
+
/** 正文(必填,纯文本,换行符按换行显示)。 */
|
|
290
|
+
content: string;
|
|
291
|
+
/** 标题;缺省走宿主多语言默认标题。 */
|
|
292
|
+
title?: string;
|
|
293
|
+
/** 外观档位,缺省 'warning'。 */
|
|
294
|
+
type?: ConfirmType;
|
|
295
|
+
/** 确认按钮文案;缺省走宿主多语言「确认」。调用方传入的文案原样显示,多语言由调用方负责。 */
|
|
296
|
+
positiveText?: string;
|
|
297
|
+
/** 取消按钮文案;缺省走宿主多语言「取消」。 */
|
|
298
|
+
negativeText?: string;
|
|
299
|
+
}
|
|
300
|
+
|
|
301
|
+
export interface OpenConfirmResult {
|
|
302
|
+
/** 点确认=true;点取消/关闭按钮/按 Esc=false(遮罩点击不关闭)。 */
|
|
303
|
+
confirmed: boolean;
|
|
304
|
+
}
|
|
305
|
+
|
|
306
|
+
// ---------------------------------------------------------------------------
|
|
307
|
+
// 服务八:输入框
|
|
308
|
+
// ---------------------------------------------------------------------------
|
|
309
|
+
// 取代浏览器原生 window.prompt(插件不得使用原生弹框)。请求纯 JSON。
|
|
310
|
+
|
|
311
|
+
export interface OpenPromptRequest {
|
|
312
|
+
/** 标题;缺省走宿主多语言默认标题。 */
|
|
313
|
+
title?: string;
|
|
314
|
+
/** 输入框上方的说明文字(纯文本)。 */
|
|
315
|
+
content?: string;
|
|
316
|
+
/** 输入框标签。 */
|
|
317
|
+
label?: string;
|
|
318
|
+
/** 预填值。 */
|
|
319
|
+
defaultValue?: string;
|
|
320
|
+
placeholder?: string;
|
|
321
|
+
/** true 时为多行文本框,缺省 false(单行,回车等同确认)。 */
|
|
322
|
+
multiline?: boolean;
|
|
323
|
+
/** true 时去掉首尾空白后为空则确认按钮不可点,缺省 false。 */
|
|
324
|
+
required?: boolean;
|
|
325
|
+
maxLength?: number;
|
|
326
|
+
positiveText?: string;
|
|
327
|
+
negativeText?: string;
|
|
328
|
+
}
|
|
329
|
+
|
|
330
|
+
export interface OpenPromptResult {
|
|
331
|
+
confirmed: boolean;
|
|
332
|
+
/**
|
|
333
|
+
* 确认时为用户输入的原文(**不去空白**,空串合法,由调用方自行解释,如「留空即清除」);
|
|
334
|
+
* 取消/关闭时恒为 null,调用方不应把 null 当成「输入了空串」。
|
|
335
|
+
*/
|
|
336
|
+
value: string | null;
|
|
337
|
+
}
|
|
338
|
+
|
|
339
|
+
// ---------------------------------------------------------------------------
|
|
340
|
+
// 总线调用面
|
|
341
|
+
// ---------------------------------------------------------------------------
|
|
342
|
+
|
|
343
|
+
/** 服务名(与宿主 features/host-ui 登记表一一对应)。 */
|
|
344
|
+
export type HostUiServiceName =
|
|
345
|
+
| 'expressionEditor'
|
|
346
|
+
| 'entityPicker'
|
|
347
|
+
| 'recordPicker'
|
|
348
|
+
| 'imageCropper'
|
|
349
|
+
| 'templatePicker'
|
|
350
|
+
| 'orgTriPicker'
|
|
351
|
+
| 'confirm'
|
|
352
|
+
| 'prompt'
|
|
353
|
+
// 附件打开(1.1.0-tp.21 起):宿主附件外壳 + 附件插件;能力键 ui.attachment。
|
|
354
|
+
| 'attachment';
|
|
355
|
+
|
|
356
|
+
/** 单个服务域。留成对象而非裸函数,方便将来加 open 之外的动词而不破坏调用面。 */
|
|
357
|
+
export interface HostUiServiceBridge<Req, Res> {
|
|
358
|
+
open(req: Req): Promise<Res>;
|
|
359
|
+
}
|
|
360
|
+
|
|
361
|
+
/**
|
|
362
|
+
* hostBridge.ui 的形状。各服务是否真的可见,由宿主按 surface 的 hostCaps 裁剪
|
|
363
|
+
* (能力键 `ui.<服务名>`);未声明的键**访问即抛** SEC-012,不是 undefined。
|
|
364
|
+
*/
|
|
365
|
+
export interface HostUiBridge {
|
|
366
|
+
expressionEditor?: HostUiServiceBridge<OpenExpressionEditorRequest, OpenExpressionEditorResult>;
|
|
367
|
+
entityPicker?: HostUiServiceBridge<OpenEntityPickerRequest, OpenEntityPickerResult>;
|
|
368
|
+
recordPicker?: HostUiServiceBridge<OpenRecordPickerRequest, OpenRecordPickerResult>;
|
|
369
|
+
imageCropper?: HostUiServiceBridge<OpenImageCropperRequest, OpenImageCropperResult>;
|
|
370
|
+
templatePicker?: HostUiServiceBridge<TemplatePickerRequest, TemplatePickerResult>;
|
|
371
|
+
orgTriPicker?: HostUiServiceBridge<OrgTriPickerRequest, OrgTriPickerResult>;
|
|
372
|
+
confirm?: HostUiServiceBridge<OpenConfirmRequest, OpenConfirmResult>;
|
|
373
|
+
prompt?: HostUiServiceBridge<OpenPromptRequest, OpenPromptResult>;
|
|
374
|
+
attachment?: HostUiServiceBridge<OpenAttachmentRequest, OpenAttachmentResult>;
|
|
375
|
+
}
|
|
376
|
+
|
|
377
|
+
/** 插件侧好用的窄化调用面。 */
|
|
378
|
+
export interface HostUi {
|
|
379
|
+
/** 某个服务当前是否可用(能力已声明 + 宿主已提供)。用于决定禁用按钮还是照常渲染。 */
|
|
380
|
+
has(service: HostUiServiceName): boolean;
|
|
381
|
+
openExpressionEditor(req: OpenExpressionEditorRequest): Promise<OpenExpressionEditorResult>;
|
|
382
|
+
openEntityPicker(req?: OpenEntityPickerRequest): Promise<OpenEntityPickerResult>;
|
|
383
|
+
openRecordPicker(req: OpenRecordPickerRequest): Promise<OpenRecordPickerResult>;
|
|
384
|
+
openImageCropper(req: OpenImageCropperRequest): Promise<OpenImageCropperResult>;
|
|
385
|
+
openTemplatePicker(req: TemplatePickerRequest): Promise<TemplatePickerResult>;
|
|
386
|
+
openOrgTriPicker(req?: OrgTriPickerRequest): Promise<OrgTriPickerResult>;
|
|
387
|
+
/** 确认框:取代 window.confirm。 */
|
|
388
|
+
openConfirm(req: OpenConfirmRequest): Promise<OpenConfirmResult>;
|
|
389
|
+
/** 输入框:取代 window.prompt。 */
|
|
390
|
+
openPrompt(req: OpenPromptRequest): Promise<OpenPromptResult>;
|
|
391
|
+
/** 打开附件(查看 / 编辑):宿主外壳按类型路由到附件插件;调用方不再自带查看器。 */
|
|
392
|
+
openAttachment(req: OpenAttachmentRequest): Promise<OpenAttachmentResult>;
|
|
393
|
+
}
|
|
394
|
+
|
|
395
|
+
/** createNotWiredHostUi 的 reject 错误码(error.code),SDK 1.1.0-tp.19 起。 */
|
|
396
|
+
export const HOST_UI_NOT_WIRED = 'HOST_UI_NOT_WIRED';
|
|
397
|
+
|
|
398
|
+
/**
|
|
399
|
+
* NOT_WIRED 兜底:明确 reject 并指出缺的是哪条能力,不返回一个假的「用户取消了」。
|
|
400
|
+
* reject 的错误带 `code = HOST_UI_NOT_WIRED` 与 `service`(缺的服务名),可按码判断。
|
|
401
|
+
*/
|
|
402
|
+
export function createNotWiredHostUi(): HostUi {
|
|
403
|
+
const reject = (service: HostUiServiceName) => () =>
|
|
404
|
+
Promise.reject(
|
|
405
|
+
Object.assign(
|
|
406
|
+
new Error(`ui.${service} 能力未接线:宿主未提供该 UI 服务(hostBridge.ui.${service} 缺席或 hostCaps 未声明)`),
|
|
407
|
+
{ code: HOST_UI_NOT_WIRED, service }
|
|
408
|
+
)
|
|
409
|
+
);
|
|
410
|
+
return {
|
|
411
|
+
has: () => false,
|
|
412
|
+
openExpressionEditor: reject('expressionEditor'),
|
|
413
|
+
openEntityPicker: reject('entityPicker'),
|
|
414
|
+
openRecordPicker: reject('recordPicker'),
|
|
415
|
+
openImageCropper: reject('imageCropper'),
|
|
416
|
+
openTemplatePicker: reject('templatePicker'),
|
|
417
|
+
openOrgTriPicker: reject('orgTriPicker'),
|
|
418
|
+
openConfirm: reject('confirm'),
|
|
419
|
+
openPrompt: reject('prompt'),
|
|
420
|
+
openAttachment: reject('attachment')
|
|
421
|
+
};
|
|
422
|
+
}
|
|
423
|
+
|
|
424
|
+
/**
|
|
425
|
+
* 从 hostBridge 解析出 HostUi。
|
|
426
|
+
*
|
|
427
|
+
* bridge 收成 unknown:插件拿到的是被 Proxy 包过的 hostBridge,在这里按需窄化。
|
|
428
|
+
* 取用一律 try/catch —— 未声明的能力键**访问时抛**(SEC-012),不 catch 会把「这个 surface
|
|
429
|
+
* 没声明这条能力」变成插件崩溃。取不到时退化为明确 reject 的实现,而不是静默失败。
|
|
430
|
+
*/
|
|
431
|
+
export function createHostUi(hostBridge: unknown): HostUi {
|
|
432
|
+
let ui: HostUiBridge | undefined;
|
|
433
|
+
try {
|
|
434
|
+
ui = (hostBridge as { ui?: HostUiBridge } | undefined)?.ui;
|
|
435
|
+
} catch {
|
|
436
|
+
return createNotWiredHostUi();
|
|
437
|
+
}
|
|
438
|
+
if (!ui) return createNotWiredHostUi();
|
|
439
|
+
|
|
440
|
+
const fallback = createNotWiredHostUi();
|
|
441
|
+
|
|
442
|
+
/** 逐服务取域:单个服务未声明不应连累其它服务,故每次取用独立 try/catch。 */
|
|
443
|
+
function resolve<K extends HostUiServiceName>(name: K): HostUiBridge[K] | undefined {
|
|
444
|
+
try {
|
|
445
|
+
const domain = (ui as HostUiBridge)[name];
|
|
446
|
+
return typeof domain?.open === 'function' ? domain : undefined;
|
|
447
|
+
} catch {
|
|
448
|
+
return undefined;
|
|
449
|
+
}
|
|
450
|
+
}
|
|
451
|
+
|
|
452
|
+
return {
|
|
453
|
+
has: name => resolve(name) !== undefined,
|
|
454
|
+
openExpressionEditor: req => {
|
|
455
|
+
const domain = resolve('expressionEditor');
|
|
456
|
+
return domain ? domain.open(req) : fallback.openExpressionEditor(req);
|
|
457
|
+
},
|
|
458
|
+
openEntityPicker: (req = {}) => {
|
|
459
|
+
const domain = resolve('entityPicker');
|
|
460
|
+
return domain ? domain.open(req) : fallback.openEntityPicker(req);
|
|
461
|
+
},
|
|
462
|
+
openRecordPicker: req => {
|
|
463
|
+
const domain = resolve('recordPicker');
|
|
464
|
+
return domain ? domain.open(req) : fallback.openRecordPicker(req);
|
|
465
|
+
},
|
|
466
|
+
openImageCropper: req => {
|
|
467
|
+
const domain = resolve('imageCropper');
|
|
468
|
+
return domain ? domain.open(req) : fallback.openImageCropper(req);
|
|
469
|
+
},
|
|
470
|
+
openTemplatePicker: req => {
|
|
471
|
+
const domain = resolve('templatePicker');
|
|
472
|
+
return domain ? domain.open(req) : fallback.openTemplatePicker(req);
|
|
473
|
+
},
|
|
474
|
+
openOrgTriPicker: (req = {}) => {
|
|
475
|
+
const domain = resolve('orgTriPicker');
|
|
476
|
+
return domain ? domain.open(req) : fallback.openOrgTriPicker(req);
|
|
477
|
+
},
|
|
478
|
+
openConfirm: req => {
|
|
479
|
+
const domain = resolve('confirm');
|
|
480
|
+
return domain ? domain.open(req) : fallback.openConfirm(req);
|
|
481
|
+
},
|
|
482
|
+
openPrompt: req => {
|
|
483
|
+
const domain = resolve('prompt');
|
|
484
|
+
return domain ? domain.open(req) : fallback.openPrompt(req);
|
|
485
|
+
},
|
|
486
|
+
openAttachment: req => {
|
|
487
|
+
const domain = resolve('attachment');
|
|
488
|
+
return domain ? domain.open(req) : fallback.openAttachment(req);
|
|
489
|
+
}
|
|
490
|
+
};
|
|
491
|
+
}
|