@kimposoft/plugin-sdk 0.0.0-stage → 1.1.0-tp.20
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 +141 -4
- package/src/action-designer.ts +250 -0
- package/src/attachment-url.ts +195 -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 +250 -0
- package/src/editor-frame.ts +623 -0
- package/src/editor-session.ts +1214 -0
- package/src/editor-testing.ts +838 -0
- package/src/editor.ts +1641 -0
- package/src/frame-transport.ts +491 -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 +118 -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 +404 -0
- package/src/print.ts +393 -0
- package/src/surface.ts +281 -0
- package/src/theme-mocks.ts +140 -0
- package/src/theme.ts +125 -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 +16 -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 +250 -0
- package/src/ui.ts +479 -0
- package/src/workflow-designer.ts +475 -0
package/src/ui-mocks.ts
ADDED
|
@@ -0,0 +1,250 @@
|
|
|
1
|
+
// ui-mocks.ts —— 宿主 UI 服务总线 mock 工厂,供插件在自己的 playground / 单测里
|
|
2
|
+
// **不启动宿主**也能把「唤起弹窗 → 用户操作 → 拿回结果」这条交互跑通。
|
|
3
|
+
//
|
|
4
|
+
// 【为什么落在 src 根目录而不是 ui/mocks.ts】ui.ts 本身是 src 根下的一份扁平文件(没有为自己
|
|
5
|
+
// 起 ui/ 子目录),与 image-tools.ts / org-directory.ts 等同级契约文件同属一种风格;只有
|
|
6
|
+
// workflow/ 这种多文件领域才会开子目录、并在其中放 mocks.ts。本文件与 ui.ts 同级、以 "ui-"
|
|
7
|
+
// 前缀命名,是"文件名前缀 = 领域名"这一扁平文件既有惯例的延伸,不是另起一套约定。
|
|
8
|
+
//
|
|
9
|
+
// 组织与命名风格照抄 ./workflow/mocks.ts:每个服务一份可控假数据 + 顶层
|
|
10
|
+
// createMockHostUi(overrides) 汇总;本文件同样不含任何真实网络调用/DOM 渲染(硬约束)。
|
|
11
|
+
//
|
|
12
|
+
// 【必须能表达的两条路径】插件作者最容易只测"用户点了确认"这一条 happy path,漏测取消与
|
|
13
|
+
// 未接线两种同样真实的路径。因此每个服务位支持三档结果(而不是只给一份写死的 confirm 数据):
|
|
14
|
+
// - 'confirm' (缺省):resolve 一份"用户确认并选了一条合理假数据"的结果;
|
|
15
|
+
// - 'cancel' :resolve 一份 confirmed:false 的结果(数据字段按 ui.ts 既定约定
|
|
16
|
+
// 置空数组/null,与真实宿主取消时的行为一致);
|
|
17
|
+
// - 'not-wired' :reject 一个与 ui.ts createNotWiredHostUi 措辞一致的错误——直接
|
|
18
|
+
// 复用该函数产出的实现,不重抄一遍错误文案,避免两处措辞漂移。
|
|
19
|
+
// 模拟"宿主根本没有提供这条 UI 服务"这一装配态缺陷,而不是伪装成
|
|
20
|
+
// 用户取消(把装配错误伪装成正常交互是最难排查的一类缺陷)。
|
|
21
|
+
// 用法:createMockHostUi({ expressionEditor: 'cancel', entityPicker: 'not-wired' });
|
|
22
|
+
// 未在 overrides 里出现的服务位按 'confirm' 处理。三档假数据不够用时,也可以直接传一个
|
|
23
|
+
// 与 HostUi 同名方法签名一致的自定义实现函数,整体覆盖该服务位(与 workflow/mocks.ts 的
|
|
24
|
+
// overrides 用法一致)。
|
|
25
|
+
//
|
|
26
|
+
// 【busy 档为什么没有】HOSTUI-002(HostUiBusyError)是宿主注册表的重入锁产物——同一服务在途
|
|
27
|
+
// 时二次调用才会触发,属于"调用时序"而非"结果形态",与 confirm/cancel/not-wired 这三档
|
|
28
|
+
// "服务返回什么"不是同一个维度,本工厂不模拟它。要测重入场景,请直接让 mock 的 Promise
|
|
29
|
+
// 保持 pending(如 overrides 传一个不 resolve 的自定义函数)再发起第二次调用并自行断言。
|
|
30
|
+
import {
|
|
31
|
+
createNotWiredHostUi,
|
|
32
|
+
type ExpressionModel,
|
|
33
|
+
type HostUi,
|
|
34
|
+
type HostUiBridge,
|
|
35
|
+
type HostUiServiceName,
|
|
36
|
+
type OrgTriPickedUser,
|
|
37
|
+
type PickedDeptRef,
|
|
38
|
+
type PickedRoleRef,
|
|
39
|
+
type PickedUser,
|
|
40
|
+
type TemplatePickerResultTemplate
|
|
41
|
+
} from './ui';
|
|
42
|
+
import type { ImageCropperResult } from './image-tools';
|
|
43
|
+
|
|
44
|
+
/** 三档结果快捷方式;'confirm'/'cancel' 都代表服务"已接线",区别只是用户的选择。 */
|
|
45
|
+
export type HostUiMockOutcome = 'confirm' | 'cancel' | 'not-wired';
|
|
46
|
+
|
|
47
|
+
/** 每个服务位可传三档字符串走内置假数据,或直接传一个自定义实现整体覆盖。 */
|
|
48
|
+
export interface HostUiMockOverrides {
|
|
49
|
+
expressionEditor?: HostUiMockOutcome | HostUi['openExpressionEditor'];
|
|
50
|
+
entityPicker?: HostUiMockOutcome | HostUi['openEntityPicker'];
|
|
51
|
+
recordPicker?: HostUiMockOutcome | HostUi['openRecordPicker'];
|
|
52
|
+
imageCropper?: HostUiMockOutcome | HostUi['openImageCropper'];
|
|
53
|
+
templatePicker?: HostUiMockOutcome | HostUi['openTemplatePicker'];
|
|
54
|
+
orgTriPicker?: HostUiMockOutcome | HostUi['openOrgTriPicker'];
|
|
55
|
+
confirm?: HostUiMockOutcome | HostUi['openConfirm'];
|
|
56
|
+
prompt?: HostUiMockOutcome | HostUi['openPrompt'];
|
|
57
|
+
}
|
|
58
|
+
|
|
59
|
+
// ---------------------------------------------------------------------------
|
|
60
|
+
// 稳定占位数据(同 workflow/mocks.ts MOCK_TIMESTAMP 的用法:写死而非每次现造,
|
|
61
|
+
// 避免快照/断言抖动,也省得每个插件各自手写一份)。
|
|
62
|
+
// ---------------------------------------------------------------------------
|
|
63
|
+
|
|
64
|
+
const MOCK_EXPRESSION_MODEL: ExpressionModel = {
|
|
65
|
+
// ExpressionModel 内部结构对 SDK 不透明(ui.ts 顶部注释:"本 SDK 刻意不描述它的内部结构"),
|
|
66
|
+
// mock 只需给一个非空、可 JSON 序列化的占位对象,代表"用户已经编好了一条表达式"。
|
|
67
|
+
__mock: true,
|
|
68
|
+
note: '仅供 playground/单测占位使用,不代表真实表达式模型的内部结构'
|
|
69
|
+
};
|
|
70
|
+
|
|
71
|
+
const MOCK_PICKED_USER: PickedUser = {
|
|
72
|
+
user_id: 'mock-user-1',
|
|
73
|
+
login_name: 'mock.user',
|
|
74
|
+
display_name: '模拟用户',
|
|
75
|
+
status_code: 'active'
|
|
76
|
+
};
|
|
77
|
+
|
|
78
|
+
const MOCK_RECORD_ID = 'mock-record-1';
|
|
79
|
+
|
|
80
|
+
const MOCK_IMAGE_CROPPER_RESULT: ImageCropperResult = {
|
|
81
|
+
crop: { x: 0, y: 0, width: 100, height: 100 },
|
|
82
|
+
rotateDegree: 0,
|
|
83
|
+
mode: 'visually_lossless'
|
|
84
|
+
};
|
|
85
|
+
|
|
86
|
+
const MOCK_TEMPLATE: TemplatePickerResultTemplate = {
|
|
87
|
+
template_id: 'mock-template-1',
|
|
88
|
+
template_name: '模拟模板',
|
|
89
|
+
published: true
|
|
90
|
+
};
|
|
91
|
+
|
|
92
|
+
const MOCK_ORG_TRI_USER: OrgTriPickedUser = {
|
|
93
|
+
user_id: 'mock-user-1',
|
|
94
|
+
login_name: 'mock.user',
|
|
95
|
+
display_name: '模拟用户',
|
|
96
|
+
status_code: 'active'
|
|
97
|
+
};
|
|
98
|
+
|
|
99
|
+
const MOCK_ORG_TRI_ROLE: PickedRoleRef = { id: 'mock-role-1', name: '模拟角色', scope: 'instance' };
|
|
100
|
+
|
|
101
|
+
const MOCK_ORG_TRI_DEPT: PickedDeptRef = { id: 'mock-dept-1', org_name: '模拟部门', path_name: '模拟公司/模拟部门' };
|
|
102
|
+
|
|
103
|
+
// 输入框 confirm 档返回的占位输入值(与 ui-fixtures/prompt.ts 的结果夹具一致)。
|
|
104
|
+
const MOCK_PROMPT_VALUE = '夹具默认名称';
|
|
105
|
+
|
|
106
|
+
// ---------------------------------------------------------------------------
|
|
107
|
+
// 每服务三档解析:not-wired 直接借用 createNotWiredHostUi 的实现(措辞不重复维护一份)。
|
|
108
|
+
// ---------------------------------------------------------------------------
|
|
109
|
+
|
|
110
|
+
function resolveExpressionEditorImpl(
|
|
111
|
+
outcome: HostUiMockOutcome | HostUi['openExpressionEditor'] | undefined
|
|
112
|
+
): HostUi['openExpressionEditor'] {
|
|
113
|
+
if (typeof outcome === 'function') return outcome;
|
|
114
|
+
if (outcome === 'not-wired') return createNotWiredHostUi().openExpressionEditor;
|
|
115
|
+
if (outcome === 'cancel') return async () => ({ confirmed: false, model: null });
|
|
116
|
+
return async () => ({ confirmed: true, model: MOCK_EXPRESSION_MODEL });
|
|
117
|
+
}
|
|
118
|
+
|
|
119
|
+
function resolveEntityPickerImpl(
|
|
120
|
+
outcome: HostUiMockOutcome | HostUi['openEntityPicker'] | undefined
|
|
121
|
+
): HostUi['openEntityPicker'] {
|
|
122
|
+
if (typeof outcome === 'function') return outcome;
|
|
123
|
+
if (outcome === 'not-wired') return createNotWiredHostUi().openEntityPicker;
|
|
124
|
+
// depts 恒为空数组:本 mock 只模拟 'user' 档的 happy path(当前唯一消费方 kimpo-workflow
|
|
125
|
+
// 只选人不选部门),'dept' 档需要不同假数据时请用自定义覆盖函数(见本文件头注释"逃生舱")。
|
|
126
|
+
if (outcome === 'cancel') return async () => ({ confirmed: false, users: [], depts: [] });
|
|
127
|
+
return async () => ({ confirmed: true, users: [MOCK_PICKED_USER], depts: [] });
|
|
128
|
+
}
|
|
129
|
+
|
|
130
|
+
function resolveRecordPickerImpl(
|
|
131
|
+
outcome: HostUiMockOutcome | HostUi['openRecordPicker'] | undefined
|
|
132
|
+
): HostUi['openRecordPicker'] {
|
|
133
|
+
if (typeof outcome === 'function') return outcome;
|
|
134
|
+
if (outcome === 'not-wired') return createNotWiredHostUi().openRecordPicker;
|
|
135
|
+
if (outcome === 'cancel') return async () => ({ confirmed: false, recordId: null });
|
|
136
|
+
return async () => ({ confirmed: true, recordId: MOCK_RECORD_ID });
|
|
137
|
+
}
|
|
138
|
+
|
|
139
|
+
function resolveImageCropperImpl(
|
|
140
|
+
outcome: HostUiMockOutcome | HostUi['openImageCropper'] | undefined
|
|
141
|
+
): HostUi['openImageCropper'] {
|
|
142
|
+
if (typeof outcome === 'function') return outcome;
|
|
143
|
+
if (outcome === 'not-wired') return createNotWiredHostUi().openImageCropper;
|
|
144
|
+
if (outcome === 'cancel') return async () => ({ confirmed: false, result: null });
|
|
145
|
+
return async () => ({ confirmed: true, result: MOCK_IMAGE_CROPPER_RESULT });
|
|
146
|
+
}
|
|
147
|
+
|
|
148
|
+
function resolveTemplatePickerImpl(
|
|
149
|
+
outcome: HostUiMockOutcome | HostUi['openTemplatePicker'] | undefined
|
|
150
|
+
): HostUi['openTemplatePicker'] {
|
|
151
|
+
if (typeof outcome === 'function') return outcome;
|
|
152
|
+
if (outcome === 'not-wired') return createNotWiredHostUi().openTemplatePicker;
|
|
153
|
+
if (outcome === 'cancel') return async () => ({ confirmed: false, template: null });
|
|
154
|
+
return async () => ({ confirmed: true, template: MOCK_TEMPLATE });
|
|
155
|
+
}
|
|
156
|
+
|
|
157
|
+
function resolveOrgTriPickerImpl(
|
|
158
|
+
outcome: HostUiMockOutcome | HostUi['openOrgTriPicker'] | undefined
|
|
159
|
+
): HostUi['openOrgTriPicker'] {
|
|
160
|
+
if (typeof outcome === 'function') return outcome;
|
|
161
|
+
if (outcome === 'not-wired') return createNotWiredHostUi().openOrgTriPicker;
|
|
162
|
+
if (outcome === 'cancel') return async () => ({ confirmed: false, users: [], roles: [], depts: [] });
|
|
163
|
+
return async () => ({ confirmed: true, users: [MOCK_ORG_TRI_USER], roles: [MOCK_ORG_TRI_ROLE], depts: [MOCK_ORG_TRI_DEPT] });
|
|
164
|
+
}
|
|
165
|
+
|
|
166
|
+
function resolveConfirmImpl(outcome: HostUiMockOutcome | HostUi['openConfirm'] | undefined): HostUi['openConfirm'] {
|
|
167
|
+
if (typeof outcome === 'function') return outcome;
|
|
168
|
+
if (outcome === 'not-wired') return createNotWiredHostUi().openConfirm;
|
|
169
|
+
if (outcome === 'cancel') return async () => ({ confirmed: false });
|
|
170
|
+
return async () => ({ confirmed: true });
|
|
171
|
+
}
|
|
172
|
+
|
|
173
|
+
function resolvePromptImpl(outcome: HostUiMockOutcome | HostUi['openPrompt'] | undefined): HostUi['openPrompt'] {
|
|
174
|
+
if (typeof outcome === 'function') return outcome;
|
|
175
|
+
if (outcome === 'not-wired') return createNotWiredHostUi().openPrompt;
|
|
176
|
+
// 取消时 value 恒为 null(不是空串),与 ui.ts OpenPromptResult 约定一致。
|
|
177
|
+
if (outcome === 'cancel') return async () => ({ confirmed: false, value: null });
|
|
178
|
+
return async () => ({ confirmed: true, value: MOCK_PROMPT_VALUE });
|
|
179
|
+
}
|
|
180
|
+
|
|
181
|
+
/**
|
|
182
|
+
* 构造满足 HostUi 接口的 mock(插件侧窄化调用面,即 createHostUi() 的产出形状)。
|
|
183
|
+
* 适合在插件自己的 playground/单测里直接替代 `createHostUi(hostBridge)` 的返回值。
|
|
184
|
+
*/
|
|
185
|
+
export function createMockHostUi(overrides?: HostUiMockOverrides): HostUi {
|
|
186
|
+
// has():'not-wired' 档视为该服务未接线(与真实 createHostUi 的 has() 语义一致);
|
|
187
|
+
// 'confirm'/'cancel' 都代表服务"存在",用户点了确认还是取消是另一回事,不影响 has()。
|
|
188
|
+
const wired: Record<HostUiServiceName, boolean> = {
|
|
189
|
+
expressionEditor: overrides?.expressionEditor !== 'not-wired',
|
|
190
|
+
entityPicker: overrides?.entityPicker !== 'not-wired',
|
|
191
|
+
recordPicker: overrides?.recordPicker !== 'not-wired',
|
|
192
|
+
imageCropper: overrides?.imageCropper !== 'not-wired',
|
|
193
|
+
templatePicker: overrides?.templatePicker !== 'not-wired',
|
|
194
|
+
orgTriPicker: overrides?.orgTriPicker !== 'not-wired',
|
|
195
|
+
confirm: overrides?.confirm !== 'not-wired',
|
|
196
|
+
prompt: overrides?.prompt !== 'not-wired'
|
|
197
|
+
};
|
|
198
|
+
|
|
199
|
+
return {
|
|
200
|
+
has: service => wired[service],
|
|
201
|
+
openExpressionEditor: resolveExpressionEditorImpl(overrides?.expressionEditor),
|
|
202
|
+
openEntityPicker: resolveEntityPickerImpl(overrides?.entityPicker),
|
|
203
|
+
openRecordPicker: resolveRecordPickerImpl(overrides?.recordPicker),
|
|
204
|
+
openImageCropper: resolveImageCropperImpl(overrides?.imageCropper),
|
|
205
|
+
openTemplatePicker: resolveTemplatePickerImpl(overrides?.templatePicker),
|
|
206
|
+
openOrgTriPicker: resolveOrgTriPickerImpl(overrides?.orgTriPicker),
|
|
207
|
+
openConfirm: resolveConfirmImpl(overrides?.confirm),
|
|
208
|
+
openPrompt: resolvePromptImpl(overrides?.prompt)
|
|
209
|
+
};
|
|
210
|
+
}
|
|
211
|
+
|
|
212
|
+
/**
|
|
213
|
+
* 构造满足 HostUiBridge 形状的 mock(键 = 服务名,值 = { open }),供需要模拟
|
|
214
|
+
* `hostBridge.ui` 整体(而非已经过 createHostUi 窄化的 HostUi)的场景使用——例如验证
|
|
215
|
+
* 插件自己包在 createHostUi 之上的一层封装代码本身有没有写对。
|
|
216
|
+
*
|
|
217
|
+
* 'not-wired' 档在这一层的表达方式与 createMockHostUi **不同**:真实总线里"未接线"等价于
|
|
218
|
+
* `hostBridge.ui` 上压根没有这个键(见 ui.ts createHostUi 的 resolve():取不到域就退化为
|
|
219
|
+
* NotWired),所以这里直接不写入该键,而不是写入一个恒 reject 的 open——这样插件侧惯用的
|
|
220
|
+
* `typeof bridge.ui?.entityPicker?.open === 'function'` 探测能拿到与真机一致的结果,
|
|
221
|
+
* 用 createHostUi() 包一层后也会自然得到与生产环境相同的 NotWired 报错(见本文件配套测试)。
|
|
222
|
+
*/
|
|
223
|
+
export function createMockHostUiBridge(overrides?: HostUiMockOverrides): HostUiBridge {
|
|
224
|
+
const bridge: HostUiBridge = {};
|
|
225
|
+
if (overrides?.expressionEditor !== 'not-wired') {
|
|
226
|
+
bridge.expressionEditor = { open: resolveExpressionEditorImpl(overrides?.expressionEditor) };
|
|
227
|
+
}
|
|
228
|
+
if (overrides?.entityPicker !== 'not-wired') {
|
|
229
|
+
bridge.entityPicker = { open: resolveEntityPickerImpl(overrides?.entityPicker) };
|
|
230
|
+
}
|
|
231
|
+
if (overrides?.recordPicker !== 'not-wired') {
|
|
232
|
+
bridge.recordPicker = { open: resolveRecordPickerImpl(overrides?.recordPicker) };
|
|
233
|
+
}
|
|
234
|
+
if (overrides?.imageCropper !== 'not-wired') {
|
|
235
|
+
bridge.imageCropper = { open: resolveImageCropperImpl(overrides?.imageCropper) };
|
|
236
|
+
}
|
|
237
|
+
if (overrides?.templatePicker !== 'not-wired') {
|
|
238
|
+
bridge.templatePicker = { open: resolveTemplatePickerImpl(overrides?.templatePicker) };
|
|
239
|
+
}
|
|
240
|
+
if (overrides?.orgTriPicker !== 'not-wired') {
|
|
241
|
+
bridge.orgTriPicker = { open: resolveOrgTriPickerImpl(overrides?.orgTriPicker) };
|
|
242
|
+
}
|
|
243
|
+
if (overrides?.confirm !== 'not-wired') {
|
|
244
|
+
bridge.confirm = { open: resolveConfirmImpl(overrides?.confirm) };
|
|
245
|
+
}
|
|
246
|
+
if (overrides?.prompt !== 'not-wired') {
|
|
247
|
+
bridge.prompt = { open: resolvePromptImpl(overrides?.prompt) };
|
|
248
|
+
}
|
|
249
|
+
return bridge;
|
|
250
|
+
}
|