@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/editor.ts
ADDED
|
@@ -0,0 +1,1720 @@
|
|
|
1
|
+
// editor 方向的前端契约(host ↔ editor 插件)。
|
|
2
|
+
// 对应 Go 侧 direction/editor,是 host 与编辑器插件之间前端类型的唯一真相来源。
|
|
3
|
+
import type { HostI18n, HostTimezoneRef } from './i18n';
|
|
4
|
+
import type { HostTheme } from './theme';
|
|
5
|
+
import type { ImageToolsClient } from './image-tools';
|
|
6
|
+
import type { OrgDirectoryClient } from './org-directory';
|
|
7
|
+
import type { OzRealtimeClient } from './oz-realtime';
|
|
8
|
+
import type { InteractiveSessionHandle } from './interactive-session';
|
|
9
|
+
|
|
10
|
+
export type EditorScene = 'template-design' | 'form-runtime';
|
|
11
|
+
export type EditorFormMode = 'create' | 'edit' | 'view';
|
|
12
|
+
export type EditorPluginEntry = 'designer' | 'runtime';
|
|
13
|
+
export type EditorPluginComponent = unknown;
|
|
14
|
+
|
|
15
|
+
// 早期版本的 EditorDataAuthority / EditorRuntimeDataPolicy 类型已删除:宿主能力配置里没有
|
|
16
|
+
// 对应字段,manifest 的 runtimeDataPolicy 声明也已一并移除。
|
|
17
|
+
|
|
18
|
+
export interface EditorDesignDocument<TPayload = unknown> {
|
|
19
|
+
document_id: string;
|
|
20
|
+
template_id: string;
|
|
21
|
+
template_version_no: string;
|
|
22
|
+
designer_type: string;
|
|
23
|
+
plugin_id: string;
|
|
24
|
+
plugin_instance_id?: string | null;
|
|
25
|
+
document_status: string;
|
|
26
|
+
workbook?: TPayload;
|
|
27
|
+
design_file?: TPayload;
|
|
28
|
+
payload?: TPayload;
|
|
29
|
+
content_revision: number;
|
|
30
|
+
version_no: number;
|
|
31
|
+
}
|
|
32
|
+
|
|
33
|
+
export interface HostRequestInput {
|
|
34
|
+
url: string;
|
|
35
|
+
method?: string;
|
|
36
|
+
data?: unknown;
|
|
37
|
+
params?: Record<string, unknown>;
|
|
38
|
+
headers?: Record<string, string>;
|
|
39
|
+
responseType?: 'arrayBuffer' | 'blob' | 'json' | 'text';
|
|
40
|
+
}
|
|
41
|
+
|
|
42
|
+
export interface HostRequestResult<T = unknown> {
|
|
43
|
+
data?: T | null;
|
|
44
|
+
/** 失败时的错误体:code 为宿主错误码,message 为本地化文案,params 为可选的纯数据参数(如 {field_ids: [...]})。 */
|
|
45
|
+
error?: { code?: string; message?: string; params?: Record<string, unknown> } | null;
|
|
46
|
+
/**
|
|
47
|
+
* 原始响应元信息:非 JSON 响应(blob/arrayBuffer)需要读响应头时使用,
|
|
48
|
+
* 如导出下载的文件名(Content-Disposition)与降级警示头。可选——老宿主未透传时
|
|
49
|
+
* 插件侧应容忍缺席(头部信息按"尽力而为"降级)。header 名一律小写。
|
|
50
|
+
*/
|
|
51
|
+
response?: { status?: number; headers?: Record<string, string> };
|
|
52
|
+
}
|
|
53
|
+
|
|
54
|
+
/**
|
|
55
|
+
* Enter 键在填报态提交单元格后的光标移动方向。
|
|
56
|
+
*
|
|
57
|
+
* 仅填报态生效;设计态不受影响(恒为 Enter 向下、Tab 向右)。
|
|
58
|
+
* 'none' = 提交后光标不动。
|
|
59
|
+
*/
|
|
60
|
+
export type EditorEnterMoveDirection = 'down' | 'up' | 'right' | 'left' | 'none';
|
|
61
|
+
|
|
62
|
+
/**
|
|
63
|
+
* 填报态按钮的显示配置。
|
|
64
|
+
*
|
|
65
|
+
* label 留空 = 用编辑器插件自带的默认多语言文案;一旦设置,该按钮在所有语言下都显示这一个名字。
|
|
66
|
+
*/
|
|
67
|
+
export interface EditorButtonConfig {
|
|
68
|
+
visible?: boolean;
|
|
69
|
+
label?: string;
|
|
70
|
+
}
|
|
71
|
+
|
|
72
|
+
/**
|
|
73
|
+
* 宿主动作按钮:由宿主决定「有没有、叫什么、点了做什么」的填报态工具栏附加按钮。
|
|
74
|
+
*
|
|
75
|
+
* 角色分离:编辑器插件只负责把它画在工具栏「关闭」按钮旁边,并在点击时把 key 原样交还宿主
|
|
76
|
+
* (RecordDataClient.invokeHostAction);插件不理解 key 的业务含义,也不为它准备任何文案——
|
|
77
|
+
* label 必须是宿主已按当前语言翻译好的可见文字。宿主可在表单打开期间随时增删本清单
|
|
78
|
+
* (例如单据发起流程后才出现的入口),插件应按响应式属性处理。
|
|
79
|
+
*
|
|
80
|
+
* 呈现面只加不改地扩展过(位置 / 样式 / 色调 / 图标 / 禁用 / 加载 / 悬停说明 / 徽标 / 测试标识)。
|
|
81
|
+
* 全部为可选字段:旧宿主只给 key + label 时,按钮仍画在「关闭」左侧、次级描边样式,行为与扩展前一致。
|
|
82
|
+
* 这些字段只描述「怎么画」,不携带业务含义——插件依旧不得按 key 分支、不得为宿主动作准备文案。
|
|
83
|
+
*/
|
|
84
|
+
export interface EditorHostActionButton {
|
|
85
|
+
/** 宿主侧自定义的动作标识,同一清单内唯一;插件只透传、不解释。 */
|
|
86
|
+
key: string;
|
|
87
|
+
/** 已翻译的按钮文字。 */
|
|
88
|
+
label: string;
|
|
89
|
+
/** 位置:'primary' = 工具栏最左的主动作区(排在插件自带的编辑 / 提交 / 保存之前);'page' = 「关闭」左侧的页面区。缺省 'page'。 */
|
|
90
|
+
placement?: EditorHostActionPlacement;
|
|
91
|
+
/** 样式:'solid' 实心 / 'outline' 描边 / 'quiet' 无边框弱按钮。缺省 'outline'。宿主给出实心主动作时,插件自带按钮一律不再实心(整条工具栏只有一个实心按钮)。 */
|
|
92
|
+
variant?: EditorHostActionVariant;
|
|
93
|
+
/** 色调,缺省 'neutral'(实心时按 'primary' 处理)。 */
|
|
94
|
+
tone?: EditorHostActionTone;
|
|
95
|
+
/** 具名图标,由插件自绘;缺省无图标。未识别的名字按无图标处理。 */
|
|
96
|
+
icon?: EditorHostActionIcon;
|
|
97
|
+
/** 禁用(宿主自己的忙态 / 不可用态)。插件不得再叠加自己的表单形态判断。 */
|
|
98
|
+
disabled?: boolean;
|
|
99
|
+
/** 加载中:按钮内显示转圈并视同禁用。 */
|
|
100
|
+
loading?: boolean;
|
|
101
|
+
/** 已翻译的悬停说明,可含换行。 */
|
|
102
|
+
tooltip?: string;
|
|
103
|
+
/** 按钮文字后的状态徽标(已翻译)。 */
|
|
104
|
+
badge?: EditorHostActionBadge;
|
|
105
|
+
/** 渲染为 data-testid,供宿主侧测试与真机脚本定位。 */
|
|
106
|
+
testId?: string;
|
|
107
|
+
}
|
|
108
|
+
|
|
109
|
+
export type EditorHostActionPlacement = 'primary' | 'page';
|
|
110
|
+
export type EditorHostActionVariant = 'solid' | 'outline' | 'quiet';
|
|
111
|
+
export type EditorHostActionTone = 'primary' | 'success' | 'warning' | 'danger' | 'neutral';
|
|
112
|
+
export type EditorHostActionIcon = 'back' | 'undo' | 'flow' | 'retry';
|
|
113
|
+
|
|
114
|
+
export interface EditorHostActionBadge {
|
|
115
|
+
/** 已翻译的徽标文字。 */
|
|
116
|
+
text: string;
|
|
117
|
+
tone?: EditorHostActionTone;
|
|
118
|
+
}
|
|
119
|
+
|
|
120
|
+
/**
|
|
121
|
+
* 主动作区提示位:宿主的主动作清单尚未就绪或取不到时,在工具栏最左原位给用户一个交代,
|
|
122
|
+
* 避免按钮区忽有忽无。'loading' = 画占位骨架(不需要 text);'warning' = 警示图标 + 一句已翻译的 text。
|
|
123
|
+
* 与 hostActions 并存时提示位画在主动作按钮之前。
|
|
124
|
+
*/
|
|
125
|
+
export interface EditorHostActionsNotice {
|
|
126
|
+
kind: 'loading' | 'warning';
|
|
127
|
+
text?: string;
|
|
128
|
+
}
|
|
129
|
+
|
|
130
|
+
/**
|
|
131
|
+
* 宿主 → 编辑器插件的填报态行为配置(仅 scene === 'form-runtime' 时下发)。
|
|
132
|
+
*
|
|
133
|
+
* 其中 enterMoveDirection / queryMode / buttons 三项来自【模板属性设置】,由设计者在模板属性弹窗里配置。
|
|
134
|
+
*
|
|
135
|
+
* 注意 queryMode 只负责「隐藏保存按钮」这一层体验:真正的落库拦截是后端硬闸
|
|
136
|
+
* (templates.Service 的记录写方法),前端隐藏不是安全边界。
|
|
137
|
+
*/
|
|
138
|
+
export interface EditorFormRuntimeOptions {
|
|
139
|
+
restrictToDefinedFields?: boolean;
|
|
140
|
+
hideFillHandleInMainTable?: boolean;
|
|
141
|
+
hideSingleSheetTab?: boolean;
|
|
142
|
+
/** Enter 提交单元格后的光标移动方向,默认 'down'。 */
|
|
143
|
+
enterMoveDirection?: EditorEnterMoveDirection;
|
|
144
|
+
/** 查询模式:表单只能打开用于查询、不能保存 —— 编辑器应隐藏「保存」按钮。 */
|
|
145
|
+
queryMode?: boolean;
|
|
146
|
+
/** 填报态工具栏按钮的显隐与自定义名称(导出PDF 不在配置范围内)。 */
|
|
147
|
+
buttons?: {
|
|
148
|
+
edit?: EditorButtonConfig;
|
|
149
|
+
save?: EditorButtonConfig;
|
|
150
|
+
/**
|
|
151
|
+
* 「提交」按钮。不来自模板属性设置:由宿主按运行期事实下发
|
|
152
|
+
* (例如该模板当前没有可发起的流程时置 visible:false)。缺省 = 可见;宿主未注入提交能力时插件本就不画。
|
|
153
|
+
*/
|
|
154
|
+
submit?: EditorButtonConfig;
|
|
155
|
+
close?: EditorButtonConfig;
|
|
156
|
+
};
|
|
157
|
+
/** 宿主动作按钮清单(见 EditorHostActionButton);缺省或空数组 = 不显示任何附加按钮。 */
|
|
158
|
+
hostActions?: EditorHostActionButton[];
|
|
159
|
+
/** 主动作区提示位(见 EditorHostActionsNotice);缺省 = 不显示。 */
|
|
160
|
+
hostActionsNotice?: EditorHostActionsNotice;
|
|
161
|
+
/**
|
|
162
|
+
* 单据锁定:宿主按开会话应答 meta.recordLocked 权威判定后下发,编辑器插件
|
|
163
|
+
* 只消费本字段禁用「编辑」入口,不得自行判断记录锁定状态(角色分离:锁定的判定与执法都在
|
|
164
|
+
* 宿主/服务端,插件仅呈现)。缺省/undefined = 未锁定,行为与本字段引入前一致。
|
|
165
|
+
*/
|
|
166
|
+
recordLocked?: boolean;
|
|
167
|
+
/** 单据已锁定时的提示文案(宿主已翻译好):用于「编辑」按钮禁用时的悬停说明。recordLocked
|
|
168
|
+
* 为 false/缺省时本字段无意义。 */
|
|
169
|
+
recordLockedText?: string;
|
|
170
|
+
}
|
|
171
|
+
|
|
172
|
+
export interface EditorPluginProps {
|
|
173
|
+
runtimeInstanceId?: string;
|
|
174
|
+
pluginId?: string;
|
|
175
|
+
pluginInstanceId?: string;
|
|
176
|
+
clientId?: string;
|
|
177
|
+
autoOpen?: boolean;
|
|
178
|
+
pluginEntry?: EditorPluginEntry;
|
|
179
|
+
scene?: EditorScene;
|
|
180
|
+
formMode?: EditorFormMode;
|
|
181
|
+
templateVersionNo?: string;
|
|
182
|
+
recordId?: string;
|
|
183
|
+
formRuntimeOptions?: EditorFormRuntimeOptions;
|
|
184
|
+
readonly?: boolean;
|
|
185
|
+
permissions?: Record<string, unknown>;
|
|
186
|
+
designDocument?: EditorDesignDocument | unknown;
|
|
187
|
+
designDataHostApi?: DesignDataClient;
|
|
188
|
+
formDataHostApi?: RecordDataClient;
|
|
189
|
+
hostBridge?: EditorHostBridge;
|
|
190
|
+
/**
|
|
191
|
+
* 宿主已打开的 bound editor session(宿主 hostCaps 含 editor.runtime 时下发)。
|
|
192
|
+
* 不含任何传输凭据;host-mirror 编辑器从 recordSnapshot 渲染初始数据,再经 editor-frame/1 帧收 mirror.patch。
|
|
193
|
+
*/
|
|
194
|
+
boundSession?: BoundEditorSessionSnapshot;
|
|
195
|
+
}
|
|
196
|
+
|
|
197
|
+
export interface EditorPluginCreateInput {
|
|
198
|
+
props?: EditorPluginProps & Record<string, unknown>;
|
|
199
|
+
hostContext?: unknown;
|
|
200
|
+
runtime?: unknown;
|
|
201
|
+
hostBridge?: EditorHostBridge;
|
|
202
|
+
}
|
|
203
|
+
|
|
204
|
+
export interface EditorPluginMountResult {
|
|
205
|
+
component: EditorPluginComponent;
|
|
206
|
+
props?: Record<string, unknown>;
|
|
207
|
+
}
|
|
208
|
+
|
|
209
|
+
export interface EditorPluginFrontend {
|
|
210
|
+
pluginId?: string;
|
|
211
|
+
version?: string;
|
|
212
|
+
createEditor(input: EditorPluginCreateInput): EditorPluginMountResult;
|
|
213
|
+
}
|
|
214
|
+
|
|
215
|
+
export interface RuntimeInstanceClient {
|
|
216
|
+
heartbeat(input: Record<string, unknown>): Promise<unknown>;
|
|
217
|
+
close(reason?: string): Promise<unknown>;
|
|
218
|
+
forceClose(reason?: string): Promise<unknown>;
|
|
219
|
+
bindSession(sessionId: string): Promise<unknown>;
|
|
220
|
+
}
|
|
221
|
+
|
|
222
|
+
export interface FieldDefinitionClient {
|
|
223
|
+
defineFields(input: unknown): Promise<unknown>;
|
|
224
|
+
}
|
|
225
|
+
|
|
226
|
+
/** Host-authoritative expression catalog (data semantic service) exposed to editor plugins.
|
|
227
|
+
* Text equality, DISTINCT and ordering are an immutable target-database fact,
|
|
228
|
+
* not a plugin-selectable collation strategy. */
|
|
229
|
+
export interface EditorExpressionCatalogV2 {
|
|
230
|
+
system_variables: Array<{ var_id: string; label: string; type: 'string' | 'number' | 'datetime' }>;
|
|
231
|
+
functions: Array<{ name: string; label: string; min_args: number; aggregate?: boolean }>;
|
|
232
|
+
window_functions: Array<{ name: string; label: string; needs_arg: boolean }>;
|
|
233
|
+
public_capabilities: {
|
|
234
|
+
schema_version: 2;
|
|
235
|
+
text_equality_distinct_ordering: 'TARGET_DATABASE_NATIVE';
|
|
236
|
+
pattern_matching_mode: 'NATIVE' | 'UNSUPPORTED';
|
|
237
|
+
compare_operators: Array<'eq' | 'neq' | 'lt' | 'lte' | 'gt' | 'gte' | 'like' | 'in' | 'not_in' | 'is_null' | 'is_not_null'>;
|
|
238
|
+
};
|
|
239
|
+
}
|
|
240
|
+
|
|
241
|
+
export interface DesignDataClient {
|
|
242
|
+
save(input: {
|
|
243
|
+
expectedVersionNo: number;
|
|
244
|
+
workbook?: unknown;
|
|
245
|
+
designFile?: unknown;
|
|
246
|
+
payload?: unknown;
|
|
247
|
+
pluginInstanceId?: string;
|
|
248
|
+
}): Promise<unknown>;
|
|
249
|
+
init?(): Promise<EditorDesignDocument | unknown>;
|
|
250
|
+
open?(): Promise<EditorDesignDocument | unknown>;
|
|
251
|
+
/** Load the scoped expression catalog through the Host bridge. The Host owns
|
|
252
|
+
* app/profile/locale resolution; plugins never receive those identifiers. */
|
|
253
|
+
loadExpressionCatalog?(): Promise<EditorExpressionCatalogV2>;
|
|
254
|
+
defineFields?(input: unknown): Promise<unknown>;
|
|
255
|
+
defineMainTableFields?(input: unknown): Promise<unknown>;
|
|
256
|
+
// 定义明细表(扩展表 detail):创建扩展表区域+元数据,可选携带首批字段。
|
|
257
|
+
defineExtensionTable?(input: unknown): Promise<unknown>;
|
|
258
|
+
// 在已有明细表下补充定义字段。
|
|
259
|
+
defineExtensionTableFields?(input: unknown): Promise<unknown>;
|
|
260
|
+
// 打开动作设计器:设计态编辑器(如官方表格编辑器工具栏)请求宿主打开「动作设计」界面。
|
|
261
|
+
// 设计器本体由宿主持有(不在编辑器插件内),编辑器仅经此回调触发打开,作用域由宿主据当前
|
|
262
|
+
// 模板上下文决定。可选——宿主不支持时编辑器侧应优雅降级(提示不可用)。
|
|
263
|
+
openActionDesigner?(): void | Promise<void>;
|
|
264
|
+
}
|
|
265
|
+
|
|
266
|
+
export interface RecordDataClient {
|
|
267
|
+
init?(input?: Record<string, unknown>): Promise<unknown>;
|
|
268
|
+
open?(input?: { recordId?: string; templateVersionNo?: string } & Record<string, unknown>): Promise<ReportRecordSnapshot>;
|
|
269
|
+
enterEdit?(input?: Record<string, unknown>): Promise<void>;
|
|
270
|
+
// 保存成功回调:保存通路(如 WS report.save)绕过宿主 HTTP save 时,由插件在保存成功后主动调用,
|
|
271
|
+
// 把「保存后状态机/tab/路由怎么走」的决定权交还宿主——宿主据 mode 分流:
|
|
272
|
+
// edit → 转查看态(与 enterEdit 对称);
|
|
273
|
+
// create→ 弹「是否继续填写」:是=就地重置为空白新建态,否=关 tab。
|
|
274
|
+
// 携带最新 recordId(新建保存后正式记录 id 由插件侧获知);mode 缺省时宿主回退自身上下文。
|
|
275
|
+
notifySaved?(input?: { recordId?: string; mode?: 'create' | 'edit'; templateVersionNo?: string } & Record<string, unknown>): Promise<void>;
|
|
276
|
+
// 保存前提醒:插件在发起任何保存(含 WS report.save 直达通路)前询问
|
|
277
|
+
// 宿主是否放行。宿主若持有「当前记录已被旁路写改动」的静默标记会弹确认提醒,按用户选择返回:
|
|
278
|
+
// false = 用户取消,插件应中止本次保存(不报错、状态回 dirty)。宿主未实现(旧宿主)时插件按放行处理。
|
|
279
|
+
confirmBeforeSave?(): Promise<boolean>;
|
|
280
|
+
close?(input?: { reason?: string } & Record<string, unknown>): Promise<void>;
|
|
281
|
+
// 宿主动作按钮的点击回传:插件把 formRuntimeOptions.hostActions 里被点中的那一项的 key 原样交回,
|
|
282
|
+
// 由宿主自行处理(弹窗/跳转等)。宿主未实现(旧宿主)时插件不应渲染这些按钮。
|
|
283
|
+
invokeHostAction?(input: { key: string }): Promise<void>;
|
|
284
|
+
save?(input: ReportSaveRequest): Promise<ReportSaveResult>;
|
|
285
|
+
saveDraft?(input: unknown): Promise<unknown>;
|
|
286
|
+
submit?(input: ReportSubmitRequest): Promise<ReportSubmitResult>;
|
|
287
|
+
validate?(input: unknown): Promise<unknown>;
|
|
288
|
+
}
|
|
289
|
+
|
|
290
|
+
/** Task-workbench field decision. It is supplied by the Host after it has intersected
|
|
291
|
+
* workflow policy with the ordinary permission-framework grant; an editor must only narrow access further. */
|
|
292
|
+
export interface TaskWorkbenchFieldPolicy {
|
|
293
|
+
fieldStableKey: string;
|
|
294
|
+
access: 'hidden' | 'read_only' | 'editable';
|
|
295
|
+
required: boolean;
|
|
296
|
+
}
|
|
297
|
+
|
|
298
|
+
export type TaskWorkbenchFieldType =
|
|
299
|
+
| 'FIELD_TYPE_STRING' | 'FIELD_TYPE_INT64' | 'FIELD_TYPE_DECIMAL' | 'FIELD_TYPE_BOOL'
|
|
300
|
+
| 'FIELD_TYPE_DATE' | 'FIELD_TYPE_TIMESTAMP' | 'FIELD_TYPE_ENUM' | 'FIELD_TYPE_REFERENCE' | 'FIELD_TYPE_ASSET';
|
|
301
|
+
|
|
302
|
+
export type TaskWorkbenchScalar =
|
|
303
|
+
| { nullValue: Record<string, never> }
|
|
304
|
+
| { stringValue: string }
|
|
305
|
+
| { int64Value: string }
|
|
306
|
+
| { decimalValue: { canonicalDecimal: string; precision: number; scale: number } }
|
|
307
|
+
| { boolValue: boolean }
|
|
308
|
+
| { dateValue: { isoDate: string } }
|
|
309
|
+
| { timestampValue: string }
|
|
310
|
+
| { enumValue: { stableOptionKey: string } }
|
|
311
|
+
| { referenceValue: { user?: { userId: string }; organization?: { organizationUnitId: string }; record?: { object: { template: { appId: string; templateId: string; templateStableKey: string; releaseId: string; schemaChecksumSha256: string; catalogRevision: string }; recordId: string; recordVersion: string } }; asset?: { assetId: string } } }
|
|
312
|
+
/** contentSha256 is protojson base64 for exactly 32 bytes; it is never optional. */
|
|
313
|
+
| { assetValue: { assetId: string; contentSha256: string } };
|
|
314
|
+
|
|
315
|
+
/** Protojson-compatible field-value envelope produced by the host runtime; never carries an untyped editor raw value. */
|
|
316
|
+
export interface TaskWorkbenchFieldValue {
|
|
317
|
+
fieldStableKey: string;
|
|
318
|
+
fieldType: TaskWorkbenchFieldType;
|
|
319
|
+
multiple: boolean;
|
|
320
|
+
value: { scalar: TaskWorkbenchScalar } | { multi: { values: TaskWorkbenchScalar[] } };
|
|
321
|
+
}
|
|
322
|
+
|
|
323
|
+
/** A detail-row mutation read from the runtime Mirror. `rowKey` is the Mirror stable key,
|
|
324
|
+
* never a display-row index. */
|
|
325
|
+
export type TaskWorkbenchDetailRowMutation =
|
|
326
|
+
| { create: { detailTableStableKey: string; clientRowKey: string; values: TaskWorkbenchFieldValue[] } }
|
|
327
|
+
| { update: { detailTableStableKey: string; rowStableId: string; expectedRowVersion: number; values: TaskWorkbenchFieldValue[] } }
|
|
328
|
+
| { delete: { detailTableStableKey: string; rowStableId: string; expectedRowVersion: number } };
|
|
329
|
+
|
|
330
|
+
/** Canonical frontend payload passed unchanged to task draft and CompleteTask adapters. */
|
|
331
|
+
export interface TaskWorkbenchChanges {
|
|
332
|
+
values: TaskWorkbenchFieldValue[];
|
|
333
|
+
detailRowMutations: TaskWorkbenchDetailRowMutation[];
|
|
334
|
+
}
|
|
335
|
+
|
|
336
|
+
export interface TaskWorkbenchValidationResult {
|
|
337
|
+
valid: boolean;
|
|
338
|
+
missingRequiredFieldKeys: string[];
|
|
339
|
+
}
|
|
340
|
+
|
|
341
|
+
/** Host-to-editor task mode. This is an editor API rather than a DOM convention so the Host
|
|
342
|
+
* can collect and restore typed Mirror values without scraping rendered controls. */
|
|
343
|
+
export interface TaskWorkbenchConfig {
|
|
344
|
+
/** Opaque Host-issued capability. Editors may transport it, but only the Host may validate it. */
|
|
345
|
+
workspaceHandle: string;
|
|
346
|
+
effectiveFields: TaskWorkbenchFieldPolicy[];
|
|
347
|
+
readonly?: boolean;
|
|
348
|
+
}
|
|
349
|
+
|
|
350
|
+
export type ReportScalarValue = string | number | boolean | null;
|
|
351
|
+
|
|
352
|
+
export interface ReportSourcePlugin {
|
|
353
|
+
pluginId?: string;
|
|
354
|
+
pluginInstanceId?: string;
|
|
355
|
+
runtimeKind?: string;
|
|
356
|
+
}
|
|
357
|
+
|
|
358
|
+
export interface ReportFieldSource {
|
|
359
|
+
sheetId?: string;
|
|
360
|
+
range?: unknown;
|
|
361
|
+
kind?: 'cell' | 'merged-cell' | 'range' | string;
|
|
362
|
+
}
|
|
363
|
+
|
|
364
|
+
export interface ReportFieldValuePayload {
|
|
365
|
+
fieldId: string;
|
|
366
|
+
value: ReportScalarValue;
|
|
367
|
+
source?: ReportFieldSource;
|
|
368
|
+
}
|
|
369
|
+
|
|
370
|
+
export interface ReportDataTablePayload {
|
|
371
|
+
dataTableId: string;
|
|
372
|
+
tableRole: 'main' | 'extension' | string;
|
|
373
|
+
recordId?: string;
|
|
374
|
+
parentRecordId?: string;
|
|
375
|
+
rowNo?: number;
|
|
376
|
+
/** 客户端行键(明细行去重/回填 record_id 用,对齐后端 client_row_key)。 */
|
|
377
|
+
clientRowKey?: string;
|
|
378
|
+
/** 行状态('removed' 表软删;空/其它表 upsert,对齐后端 row_state added/dirty/removed)。 */
|
|
379
|
+
rowState?: string;
|
|
380
|
+
/** 行级乐观并发版本号(明细行更新冲突检测,对齐后端 expected_version_no)。 */
|
|
381
|
+
expectedVersionNo?: number;
|
|
382
|
+
fields: ReportFieldValuePayload[];
|
|
383
|
+
}
|
|
384
|
+
|
|
385
|
+
export interface ReportSaveRequest {
|
|
386
|
+
appId?: string;
|
|
387
|
+
templateId?: string;
|
|
388
|
+
templateVersionNo: string;
|
|
389
|
+
recordId?: string;
|
|
390
|
+
mode: 'create' | 'edit';
|
|
391
|
+
sourcePlugin: ReportSourcePlugin;
|
|
392
|
+
dataTables: ReportDataTablePayload[];
|
|
393
|
+
clientMutationId: string;
|
|
394
|
+
expectedVersionNo?: number;
|
|
395
|
+
}
|
|
396
|
+
|
|
397
|
+
export interface ReportFieldError {
|
|
398
|
+
fieldId: string;
|
|
399
|
+
code: string;
|
|
400
|
+
message: string;
|
|
401
|
+
}
|
|
402
|
+
|
|
403
|
+
/** 明细行保存回声:把后端分配的 record_id/version 按 client_row_key 回带,供前端回灌镜像。 */
|
|
404
|
+
export interface SavedReportRow {
|
|
405
|
+
dataTableId: string;
|
|
406
|
+
clientRowKey: string;
|
|
407
|
+
rowNo: number;
|
|
408
|
+
recordId: string;
|
|
409
|
+
versionNo: number;
|
|
410
|
+
}
|
|
411
|
+
|
|
412
|
+
export interface ReportSaveResult {
|
|
413
|
+
recordId: string;
|
|
414
|
+
templateId?: string;
|
|
415
|
+
templateVersionNo: string;
|
|
416
|
+
versionNo: number;
|
|
417
|
+
statusCode: 'draft' | 'submitted' | string;
|
|
418
|
+
savedAt: string;
|
|
419
|
+
fieldErrors?: ReportFieldError[];
|
|
420
|
+
/** 明细行保存回声(new 行回带 record_id/version,前端据此把行转 clean)。 */
|
|
421
|
+
savedRows?: SavedReportRow[];
|
|
422
|
+
}
|
|
423
|
+
|
|
424
|
+
export interface ReportSubmitRequest extends ReportSaveRequest {
|
|
425
|
+
submitAction?: string;
|
|
426
|
+
}
|
|
427
|
+
|
|
428
|
+
// submit() 出参不含流程实例 id:填报态发起流程由宿主处理,插件只拿到提交状态。
|
|
429
|
+
export interface ReportSubmitResult extends ReportSaveResult {
|
|
430
|
+
statusCode: 'submitted' | string;
|
|
431
|
+
}
|
|
432
|
+
|
|
433
|
+
export interface ReportRecordFieldValue {
|
|
434
|
+
fieldId: string;
|
|
435
|
+
fieldCode?: string;
|
|
436
|
+
fieldName?: string;
|
|
437
|
+
value: unknown;
|
|
438
|
+
}
|
|
439
|
+
|
|
440
|
+
export interface ReportRecordDataTable {
|
|
441
|
+
dataTableId: string;
|
|
442
|
+
tableRole: 'main' | 'extension' | string;
|
|
443
|
+
recordId?: string;
|
|
444
|
+
fields: ReportRecordFieldValue[];
|
|
445
|
+
}
|
|
446
|
+
|
|
447
|
+
export interface ReportRecordSnapshot {
|
|
448
|
+
recordId: string;
|
|
449
|
+
templateId: string;
|
|
450
|
+
templateVersionNo: string;
|
|
451
|
+
versionNo: number;
|
|
452
|
+
statusCode: string;
|
|
453
|
+
dataTables: ReportRecordDataTable[];
|
|
454
|
+
}
|
|
455
|
+
|
|
456
|
+
// ---- 资产(附件 / 图片)类型契约----
|
|
457
|
+
|
|
458
|
+
/**
|
|
459
|
+
* 资产种类:attachment 普通附件(PDF / Office / 文本 / 压缩包,宿主原样存储、下载强制附件、禁止嗅探);
|
|
460
|
+
* image 图片(宿主按图片管线压缩、生成缩略图)。资产 ID 前缀分别为 `ast_` / `img_`。
|
|
461
|
+
*/
|
|
462
|
+
export type EditorAssetKind = 'attachment' | 'image';
|
|
463
|
+
|
|
464
|
+
/** 上传入参。 */
|
|
465
|
+
export interface EditorAssetUploadInput {
|
|
466
|
+
/** 待上传文件(File 或 Blob;沙箱档经结构化克隆整体传给宿主)。 */
|
|
467
|
+
file: Blob;
|
|
468
|
+
/** 文件名;Blob 没有 name 时必填,File 缺省取 file.name。附件按扩展名与类型双重校验。 */
|
|
469
|
+
fileName?: string;
|
|
470
|
+
/** 缺省按 content type:`image/*` → image,其余 → attachment。 */
|
|
471
|
+
kind?: EditorAssetKind;
|
|
472
|
+
/** 目标字段(只用于宿主日志归因,不参与鉴权)。 */
|
|
473
|
+
dataTableId?: string;
|
|
474
|
+
fieldId?: string;
|
|
475
|
+
}
|
|
476
|
+
|
|
477
|
+
/**
|
|
478
|
+
* 上传回执 = 附件字段值的一项(写进 Mirror 时用 snake_case:`asset_id` / `name` / `content_type` / `byte_size` /
|
|
479
|
+
* `checksum`,与官方表格编辑器同一值面)。资产在被单据引用前只对上传人可读。
|
|
480
|
+
*/
|
|
481
|
+
export interface EditorAssetRef {
|
|
482
|
+
assetId: string;
|
|
483
|
+
name: string;
|
|
484
|
+
contentType: string;
|
|
485
|
+
byteSize: number;
|
|
486
|
+
checksum?: string;
|
|
487
|
+
kind: EditorAssetKind;
|
|
488
|
+
/** 图片像素尺寸(image 才有)。 */
|
|
489
|
+
pixelWidth?: number;
|
|
490
|
+
pixelHeight?: number;
|
|
491
|
+
}
|
|
492
|
+
|
|
493
|
+
/** 预览入参:宿主按当前用户的资产读权限取字节。 */
|
|
494
|
+
export interface EditorAssetPreviewInput {
|
|
495
|
+
assetId: string;
|
|
496
|
+
/** 缺省按资产 ID 前缀判断。 */
|
|
497
|
+
kind?: EditorAssetKind;
|
|
498
|
+
/** 图片取缩略图(thumb)或原图(original,缺省);附件忽略。 */
|
|
499
|
+
variant?: 'original' | 'thumb';
|
|
500
|
+
}
|
|
501
|
+
|
|
502
|
+
/**
|
|
503
|
+
* 预览回执:字节以 Blob 交回(沙箱档里用 `URL.createObjectURL(blob)` 显示,用完 revoke)。
|
|
504
|
+
* 宿主对预览大小设上限(超限拒绝 `EDITOR_ASSET_TOO_LARGE`,请改用 download)。
|
|
505
|
+
*/
|
|
506
|
+
export interface EditorAssetPreview {
|
|
507
|
+
assetId: string;
|
|
508
|
+
blob: Blob;
|
|
509
|
+
contentType: string;
|
|
510
|
+
byteSize: number;
|
|
511
|
+
}
|
|
512
|
+
|
|
513
|
+
/** 下载入参:宿主在主文档触发浏览器下载(框架没有 allow-downloads)。 */
|
|
514
|
+
export interface EditorAssetDownloadInput {
|
|
515
|
+
assetId: string;
|
|
516
|
+
kind?: EditorAssetKind;
|
|
517
|
+
/** 图片下载时的建议文件名;附件一律以宿主存储的文件名为准(客户端不能覆盖)。 */
|
|
518
|
+
fileName?: string;
|
|
519
|
+
}
|
|
520
|
+
|
|
521
|
+
/** 资产能力。沙箱档只开放 upload / preview / download({@link EDITOR_FRAME_HOST_METHODS})。 */
|
|
522
|
+
export interface AssetClient {
|
|
523
|
+
/** 上传:失败抛错(code 如 `EDITOR_ASSET_INVALID` / `EDITOR_ASSET_TOO_LARGE` / 宿主 `VALIDATION_ERROR`)。 */
|
|
524
|
+
upload?(input: EditorAssetUploadInput): Promise<EditorAssetRef>;
|
|
525
|
+
/** 取字节(预览):无读权限或不存在抛错(code `NOT_FOUND` / `FORBIDDEN`)。 */
|
|
526
|
+
preview?(input: EditorAssetPreviewInput): Promise<EditorAssetPreview>;
|
|
527
|
+
/** 由宿主触发下载,返回是否已发起。 */
|
|
528
|
+
download?(input: EditorAssetDownloadInput): Promise<{ started: boolean }>;
|
|
529
|
+
/** @deprecated 同源档历史口径(宿主地址带会话);沙箱档不下发,请用 preview / download。 */
|
|
530
|
+
getUrl?(assetId: string, options?: Record<string, unknown>): string | Promise<string>;
|
|
531
|
+
/** @deprecated 同源档历史口径;沙箱档不下发。 */
|
|
532
|
+
request?<T = unknown>(input: HostRequestInput): Promise<HostRequestResult<T>>;
|
|
533
|
+
}
|
|
534
|
+
|
|
535
|
+
// ---- 宿主代选记录----
|
|
536
|
+
|
|
537
|
+
/** selectRecord 入参:只能指定本应用内的模板;宿主不向编辑器返回候选列表。 */
|
|
538
|
+
export interface EditorRecordSelectInput {
|
|
539
|
+
/** 目标模板(须与当前单据同一应用)。 */
|
|
540
|
+
templateId: string;
|
|
541
|
+
/** 选择器显示的主表字段(最多 5 个,非主表 / 不存在的字段忽略);缺省宿主取前几个文本 / 数值字段。 */
|
|
542
|
+
displayFieldIds?: string[];
|
|
543
|
+
/** 初始搜索关键词(最长 64 字符)。 */
|
|
544
|
+
keyword?: string;
|
|
545
|
+
}
|
|
546
|
+
|
|
547
|
+
/** selectRecord 回执:用户选中的那一条记录的引用;取消返回 null。 */
|
|
548
|
+
export interface EditorRecordSelection {
|
|
549
|
+
recordId: string;
|
|
550
|
+
templateId: string;
|
|
551
|
+
/** 显示文本(第一个显示字段的值,空时为记录 ID)。 */
|
|
552
|
+
label: string;
|
|
553
|
+
/** 选中记录在显示字段上的文本值(键 = 字段 ID,只含 displayFieldIds 里可见的字段)。 */
|
|
554
|
+
display: Record<string, string>;
|
|
555
|
+
}
|
|
556
|
+
|
|
557
|
+
// ---- 宿主代打印(档案 print.basic)----
|
|
558
|
+
|
|
559
|
+
/**
|
|
560
|
+
* printHtml 入参:编辑器给出静态打印视图,宿主放进无脚本的隐藏框架(sandbox 不含 allow-scripts,另加 CSP
|
|
561
|
+
* `default-src 'none'`),在主文档调起打印。脚本、事件属性、表单、内嵌框架、外链样式与外部资源一律剔除或被拦截;
|
|
562
|
+
* 图片请先经 assets.preview 取 Blob 再转成 data: 地址内联。
|
|
563
|
+
*/
|
|
564
|
+
export interface EditorPrintHtmlInput {
|
|
565
|
+
/** body 内的 HTML 片段(上限 5 MB)。 */
|
|
566
|
+
html: string;
|
|
567
|
+
/** 打印样式(会放进 <style>;`@import` 与外部 url() 被拦截)。 */
|
|
568
|
+
css?: string;
|
|
569
|
+
/** 打印标题(浏览器页眉 / 另存 PDF 的缺省文件名)。 */
|
|
570
|
+
title?: string;
|
|
571
|
+
}
|
|
572
|
+
|
|
573
|
+
/** printPdf 入参:编辑器自己生成的 PDF(如 exportPdfBlob 的产物),宿主核对 `%PDF-` 文件头后在主文档打印。 */
|
|
574
|
+
export interface EditorPrintPdfInput {
|
|
575
|
+
blob: Blob;
|
|
576
|
+
title?: string;
|
|
577
|
+
}
|
|
578
|
+
|
|
579
|
+
/** 宿主代打印能力(沙箱档桥键 `print`,只给声明档案 `print.basic` 的编辑器)。 */
|
|
580
|
+
export interface EditorPrintClient {
|
|
581
|
+
printHtml?(input: EditorPrintHtmlInput): Promise<{ started: boolean }>;
|
|
582
|
+
printPdf?(input: EditorPrintPdfInput): Promise<{ started: boolean }>;
|
|
583
|
+
}
|
|
584
|
+
|
|
585
|
+
/**
|
|
586
|
+
* 提示弹出选项(宿主 message 客户端第二参,可选):字段语义与 Naive UI MessageOption 的同名项一致。
|
|
587
|
+
* 为界面动作「提示语」(ui.message) 的「持续时间」配置而加;老宿主忽略本参数即退回其默认停留时长,
|
|
588
|
+
* 老 editor 不传本参数则行为完全不变(向后兼容的纯增量扩展)。
|
|
589
|
+
*/
|
|
590
|
+
export interface HostMessageOptions {
|
|
591
|
+
/** 停留毫秒数;0 表示不自动关闭——此时须同时给 closable,否则用户无从关掉。 */
|
|
592
|
+
duration?: number;
|
|
593
|
+
/** 是否显示关闭角标。 */
|
|
594
|
+
closable?: boolean;
|
|
595
|
+
}
|
|
596
|
+
|
|
597
|
+
export interface HostMessageClient {
|
|
598
|
+
success?(message: string, options?: HostMessageOptions): void;
|
|
599
|
+
error?(message: string, options?: HostMessageOptions): void;
|
|
600
|
+
warning?(message: string, options?: HostMessageOptions): void;
|
|
601
|
+
info?(message: string, options?: HostMessageOptions): void;
|
|
602
|
+
}
|
|
603
|
+
|
|
604
|
+
/**
|
|
605
|
+
* 宿主导航客户端(hostBridge.navigation):以路由跳转(tab)方式打开某模板的某条单据,
|
|
606
|
+
* 供 kimpo-form-open 插件 ui.open_form 动作产出的 form.open 命令落地消费。
|
|
607
|
+
* 路由细节(目标模板 id 怎么定位、query 带哪些参数)留在宿主内部,editor 只表达业务意图。
|
|
608
|
+
* 可选——老宿主未注入时 editor 侧应优雅降级(命令收到但无法执行时静默忽略/提示)。
|
|
609
|
+
*/
|
|
610
|
+
export interface HostNavigationClient {
|
|
611
|
+
/** 打开某模板下某条已有记录(查看或编辑)。 */
|
|
612
|
+
openRecord(templateId: string, recordId: string, editType: 'view' | 'edit'): void | Promise<void>;
|
|
613
|
+
/**
|
|
614
|
+
* 多命中时请求宿主弹出记录选择列表,用户点选后返回其 record_id;取消/关闭返回 null。
|
|
615
|
+
* 供 kimpo-form-open 插件 ui.open_form 动作命中多条记录时产出的 form.pick-open 命令落地消费。
|
|
616
|
+
* 可选——老宿主未注入时 editor 侧应优雅降级(命令收到但无法执行时静默忽略)。
|
|
617
|
+
*/
|
|
618
|
+
pickRecord?(input: {
|
|
619
|
+
templateId: string;
|
|
620
|
+
records: Array<{ record_id: string; preview: Record<string, unknown> }>;
|
|
621
|
+
previewFieldIds: string[]; // preview 列顺序(= 后端 target.outputs 顺序)
|
|
622
|
+
}): Promise<{ record_id: string } | null>;
|
|
623
|
+
/**
|
|
624
|
+
* 打开某模板的「填报历史」列表页(宿主历史记录页 apps_template-records)。
|
|
625
|
+
* 供填报态操作条的「填报历史」按钮消费:**当前页跳转**(不是新开标签页),跳转后原填报
|
|
626
|
+
* 会话按宿主既有的路由离开流程收尾。
|
|
627
|
+
*
|
|
628
|
+
* 权限由插件侧按会话 meta.canViewHistory 门控显隐(复用权限框架的 view 位),宿主这里不再二次判权——
|
|
629
|
+
* 历史记录页自身仍有准入闸,越权进入会被它拦下。
|
|
630
|
+
*
|
|
631
|
+
* 可选——老宿主未注入时插件侧应优雅降级(按钮不显示,而非点了无响应)。
|
|
632
|
+
*/
|
|
633
|
+
openRecordList?(templateId: string): void | Promise<void>;
|
|
634
|
+
/**
|
|
635
|
+
* 以弹窗方式打开目标模板的新建表单(供 kimpo-form-fill 插件 ui.fill_form 动作产出的
|
|
636
|
+
* form.open-create 命令落地消费):宿主经 DesignerHostContainer 挂载 FormRuntimeDialog,
|
|
637
|
+
* 可携带从当前表单映射来的预填值;保存成功后按 writeback 配置把新表单字段值写回当前表单
|
|
638
|
+
* (经 R2 服务端权威端点 POST /api/v1/action-trigger/form-fill/writeback),writeback.enabled
|
|
639
|
+
* 且映射非空时才发起写回;autoCloseOnSave 为 true 时写回完成(或未声明写回)后自动关闭弹窗。
|
|
640
|
+
* 可选——老宿主未注入时 editor 侧应优雅降级(命令收到但无法执行时静默忽略)。
|
|
641
|
+
*
|
|
642
|
+
* R6b:返回值放宽为可携带 dialog 关闭结果(resolve 时机=FormRuntimeDialog 真正 close,
|
|
643
|
+
* 而非发起打开即 resolve),供 form.open-create 的 E1 回执续段据此映射 outcome=
|
|
644
|
+
* 'saved'|'cancelled' + ctxVars={record_id};旧宿主/route 模式不返回结果时仍是 void,
|
|
645
|
+
* editor 侧按 undefined 兜底不影响既有行为。
|
|
646
|
+
*/
|
|
647
|
+
openFormFill?(input: {
|
|
648
|
+
templateId: string;
|
|
649
|
+
prefill?: Array<{ fieldId: string; text: string }>;
|
|
650
|
+
/**
|
|
651
|
+
* 宿主签发的「填报表单」预填票据号(form.open-create 效果的 args.prefill_ticket):
|
|
652
|
+
* 预填值由宿主持有,宿主打开新单时凭它取值;编辑器原样转交,不解释。新宿主不再在效果里下发 prefill 明文。
|
|
653
|
+
*/
|
|
654
|
+
prefillTicket?: string;
|
|
655
|
+
autoCloseOnSave?: boolean;
|
|
656
|
+
writeback?: {
|
|
657
|
+
enabled: boolean;
|
|
658
|
+
mappings: Array<{ source_field_id: string; target_field_id: string; target_data_table_id?: string }>;
|
|
659
|
+
} | null;
|
|
660
|
+
bindingId?: string;
|
|
661
|
+
nodeId?: string;
|
|
662
|
+
/**
|
|
663
|
+
* 新建表单的打开方式(form.open-create 效果的 args.presentation):'tab'=宿主以新页签打开,
|
|
664
|
+
* 其余或缺省=弹窗。编辑器原样转交,不解释;宿主做不到新页签时(如内嵌弹窗里的表单)按弹窗打开。
|
|
665
|
+
*/
|
|
666
|
+
presentation?: 'dialog' | 'tab';
|
|
667
|
+
}): void | Promise<{ saved: boolean; recordId?: string } | void>;
|
|
668
|
+
/**
|
|
669
|
+
* 宿主代选记录:宿主按当前用户数据权限查目标模板记录、弹出既有记录选择器,只把用户选中的
|
|
670
|
+
* 那一条引用交回(取消 null);编辑器拿不到候选列表,也不能借此做任意记录查询。供引用控件使用。
|
|
671
|
+
* 可选——老宿主未注入时编辑器侧应降级(引用控件走字段点击动作或手填)。
|
|
672
|
+
*/
|
|
673
|
+
selectRecord?(input: EditorRecordSelectInput): Promise<EditorRecordSelection | null>;
|
|
674
|
+
}
|
|
675
|
+
|
|
676
|
+
// ---- Action system (phase 1 skeleton) ----
|
|
677
|
+
// Wire DTO fields below are snake_case to match the backend pipeline contract exactly, so
|
|
678
|
+
// the host can pass them through to /api/v1/action-trigger/dispatch without remapping.
|
|
679
|
+
|
|
680
|
+
/**
|
|
681
|
+
* 退役的触发事件键:`before-save` / `after-save`。宿主只为旧文档保留只读兼容——按表单模式改写成
|
|
682
|
+
* `create-before-save` / `edit-before-save`(或 `create-after-save` / `edit-after-save`)再匹配绑定;
|
|
683
|
+
* 动作设计器不再产出,编辑器也不应再发。
|
|
684
|
+
*
|
|
685
|
+
* @deprecated 改用按表单模式区分的四档保存键;后续版本会从 ActionTriggerEventKey 中移除。
|
|
686
|
+
*/
|
|
687
|
+
export type RetiredActionTriggerEventKey = 'before-save' | 'after-save';
|
|
688
|
+
|
|
689
|
+
/**
|
|
690
|
+
* 动作触发事件键(与宿主闭集一致)。保存前 / 保存后按表单模式分四档;`before-save` / `after-save`
|
|
691
|
+
* 是退役别名(见 RetiredActionTriggerEventKey,为不破坏已有代码暂留在联合类型里)。
|
|
692
|
+
*/
|
|
693
|
+
export type ActionTriggerEventKey =
|
|
694
|
+
| 'create-time'
|
|
695
|
+
| 'edit-time'
|
|
696
|
+
| 'view-time'
|
|
697
|
+
// 办理时:经流程任务打开表单。
|
|
698
|
+
| 'handle-time'
|
|
699
|
+
// 新建 / 修改态的保存前(可阻断)与保存后。
|
|
700
|
+
| 'create-before-save'
|
|
701
|
+
| 'edit-before-save'
|
|
702
|
+
| 'create-after-save'
|
|
703
|
+
| 'edit-after-save'
|
|
704
|
+
| RetiredActionTriggerEventKey
|
|
705
|
+
| 'value-change'
|
|
706
|
+
| 'field-click' // 点击字段时(左键单击命中触发根指定字段的单元格),不带 values,坐标信号走 Mirror overlay
|
|
707
|
+
| 'manual'
|
|
708
|
+
// 服务端定时触发(headless,由宿主定时任务到期后直接派发,无 editor
|
|
709
|
+
// 参与)。类型对齐仅为完整性——editor 永不 emit 本事件,只是让联合类型与后端闭集保持一致。
|
|
710
|
+
| 'scheduled'
|
|
711
|
+
// 记录删除前(可阻断)/ 删除后:只在记录页发生,由宿主后端直接派发,editor 永不 emit。
|
|
712
|
+
| 'before-delete'
|
|
713
|
+
| 'after-delete';
|
|
714
|
+
|
|
715
|
+
export type EditorRuntimeMode = 'active' | 'test';
|
|
716
|
+
|
|
717
|
+
/**
|
|
718
|
+
* TriggerContext the host supplies for a single trigger. The host owns
|
|
719
|
+
* app/template/record/routing; the editor only names the event (event_key/scope/field_id)
|
|
720
|
+
* and provides the current-form values used to evaluate execution conditions.
|
|
721
|
+
*/
|
|
722
|
+
export interface EditorTriggerContext {
|
|
723
|
+
app_id: string;
|
|
724
|
+
template_id: string;
|
|
725
|
+
template_version_no?: string;
|
|
726
|
+
record_id?: string;
|
|
727
|
+
form_mode: EditorFormMode;
|
|
728
|
+
runtime_mode: EditorRuntimeMode;
|
|
729
|
+
test_session_id?: string;
|
|
730
|
+
event_key: ActionTriggerEventKey;
|
|
731
|
+
scope: string; // 'form' | `field:${fieldId}`
|
|
732
|
+
field_id?: string;
|
|
733
|
+
values?: Record<string, unknown>;
|
|
734
|
+
blockable?: boolean;
|
|
735
|
+
// —— 模型 B 读写侧(动作从 host 权威 Mirror 取数/回写)——
|
|
736
|
+
// 当前 官方表格编辑器的填报会话 id:host 据此定位该会话的权威业务数据层(Mirror),供动作读现编值/回写字段。
|
|
737
|
+
sheet_session_id?: string;
|
|
738
|
+
// 主表 dataTableId(本阶段仅主表);computed 字段按 (main_table_id, main:0, field_id) 定位 Mirror。
|
|
739
|
+
main_table_id?: string;
|
|
740
|
+
// 当前表单中「公式派生」字段的 field_id 列表:条件求值仅对这些字段读 host 权威算后值(带读屏障)。
|
|
741
|
+
computed_fields?: string[];
|
|
742
|
+
// 明细行触发坐标(与后端 TriggerContext.DetailTableID/DetailRowKey 对齐):host 透传给 dispatch,
|
|
743
|
+
// 使条件求值的 computed 读取按明细行定位 Mirror。
|
|
744
|
+
detail_table_id?: string;
|
|
745
|
+
detail_row_key?: string;
|
|
746
|
+
// 明细触发的几何行号(band 相对、非 deleted 可见序,约定):host 原样透传,由后端 dispatch
|
|
747
|
+
// 边界经 Mirror 翻译成稳定 rowKey(覆写 detail_row_key)。
|
|
748
|
+
detail_row_index?: number;
|
|
749
|
+
// 填充柄一次手势多行的几何行号集合(约定):与单数 detail_row_index 互斥,同时给出时优先生效。
|
|
750
|
+
// host 在 dispatch 边界统一翻译成稳定 rowKey。
|
|
751
|
+
detail_row_indexes?: number[];
|
|
752
|
+
// 交互按钮点击:命中规则指定的目标手动绑定 id,host 据此透传后端 wire 字段 target_binding_id,
|
|
753
|
+
// 与后端 TriggerContext.TargetBindingID 对齐,供 dispatch 精确定位单个动作。
|
|
754
|
+
target_binding_id?: string;
|
|
755
|
+
// 值变动事件源是宿主 Mirror 字段变更事件,编辑器不自派 value-change,故早期的
|
|
756
|
+
// target_rows / affected(编辑器回带的稳定行键批)已整体退役、不留兼容位;
|
|
757
|
+
// 编辑器仍负责的只有几何坐标(detail_row_index 等)与生命周期/点击/保存锚点。
|
|
758
|
+
}
|
|
759
|
+
|
|
760
|
+
/**
|
|
761
|
+
* 派发后等待整链结算(waitAsyncSettled)的兜底超时(毫秒):防会话事件流断线导致编辑器的 busy 锁 /
|
|
762
|
+
* 在途活动项永久挂起。宿主 useActionPipeline 与 editor 侧共用同一常量,不各自维护一份。
|
|
763
|
+
* 略宽于后端 dispatch 整体超时 + 级联链 TTL(10 分钟由服务端兜底,前端只等本次派发的链)。
|
|
764
|
+
*/
|
|
765
|
+
export const ACTION_ASYNC_SETTLED_FALLBACK_MS = 150_000;
|
|
766
|
+
|
|
767
|
+
/**
|
|
768
|
+
* 会话触发链活动事件:宿主订阅本填报会话的服务端事件流,把「一条触发链开始 / 结束」转给
|
|
769
|
+
* 编辑器用作「动作在途」提示。chain_id 由服务端分配;mutation_id 为链根的变更 id(服务端自铸或编辑器
|
|
770
|
+
* 派发所带);done 时 code/error 非空表示链以失败/中止收尾(如 CASCADE_LIMIT_EXCEEDED)。
|
|
771
|
+
*/
|
|
772
|
+
export interface EditorChainActivityEvent {
|
|
773
|
+
type: 'start' | 'done';
|
|
774
|
+
chain_id: string;
|
|
775
|
+
mutation_id?: string;
|
|
776
|
+
event_key?: ActionTriggerEventKey;
|
|
777
|
+
code?: string;
|
|
778
|
+
error?: string;
|
|
779
|
+
}
|
|
780
|
+
|
|
781
|
+
/**
|
|
782
|
+
* One ordered result the host returns to the editor.
|
|
783
|
+
*
|
|
784
|
+
* 表单数据权威层 Mirror:动作的业务值写回**唯一走 Mirror WriteField**(直写权威后 host 渲染通知 editor),故**没有 fill
|
|
785
|
+
* 效果**(前端直写单元格会绕过 Mirror,违反唯一值权威/单一网关)。EditorEffect 仅保留 'command'。
|
|
786
|
+
*/
|
|
787
|
+
export interface EditorEffect {
|
|
788
|
+
effect_id: string;
|
|
789
|
+
kind: 'command';
|
|
790
|
+
command?: string;
|
|
791
|
+
args?: Record<string, unknown>;
|
|
792
|
+
// E1 回执续段(R6a/R6b,additive):本效果有「完成语义」,需前端跑完对应 editor 命令后
|
|
793
|
+
// 回执引擎(postContinuation)才继续该节点的后续。缺省/false=旧行为不变(发出即完成)。
|
|
794
|
+
await?: boolean;
|
|
795
|
+
// 引擎在检测到 await 效果并决定停等时回填的续走令牌;editor 跑完命令后原样带回
|
|
796
|
+
// hostBridge.actions.postContinuation({ token: continuation_token, ... })。
|
|
797
|
+
continuation_token?: string;
|
|
798
|
+
}
|
|
799
|
+
|
|
800
|
+
export interface EditorEffectEnvelope {
|
|
801
|
+
mutation_id: string;
|
|
802
|
+
effects: EditorEffect[];
|
|
803
|
+
blocked?: boolean;
|
|
804
|
+
async_pending?: boolean;
|
|
805
|
+
}
|
|
806
|
+
|
|
807
|
+
/**
|
|
808
|
+
* The editor-supplied portion of a trigger. The editor names the event and provides the
|
|
809
|
+
* current-form values; the host completes app/template/record/routing into a full
|
|
810
|
+
* EditorTriggerContext before dispatching.
|
|
811
|
+
*/
|
|
812
|
+
export interface EditorTriggerInput {
|
|
813
|
+
event_key: ActionTriggerEventKey;
|
|
814
|
+
scope: string; // 'form' | `field:${fieldId}`
|
|
815
|
+
field_id?: string;
|
|
816
|
+
values?: Record<string, unknown>;
|
|
817
|
+
blockable?: boolean;
|
|
818
|
+
// 模型 B 读写侧:editor 在发起触发时带上当前填报会话 id + 主表 id + computed 字段清单,
|
|
819
|
+
// host 据此让动作从权威 Mirror 取数/回写(见 EditorTriggerContext 同名字段)。
|
|
820
|
+
sheet_session_id?: string;
|
|
821
|
+
main_table_id?: string;
|
|
822
|
+
computed_fields?: string[];
|
|
823
|
+
// 明细行触发:该行坐标(detail_table_id + row:N)。二者同时给出时,条件求值的 computed 读取改从
|
|
824
|
+
// 该明细行取权威值(而非主表单行),使「明细多行 computed」能进入动作条件判断。
|
|
825
|
+
detail_table_id?: string;
|
|
826
|
+
detail_row_key?: string;
|
|
827
|
+
// 明细触发的几何行号(band 相对、非 deleted 可见序):editor 拿不到 Mirror 稳定 rowKey,只报几何行号;
|
|
828
|
+
// host 在 dispatch 边界经 Mirror 翻译成稳定 rowKey(覆写 detail_row_key,约定),
|
|
829
|
+
// 前端不再自拼 row:N 冒充稳定键。
|
|
830
|
+
detail_row_index?: number;
|
|
831
|
+
// 填充柄一次手势多行的几何行号集合(约定):与单数 detail_row_index 互斥,同时给出时优先生效;
|
|
832
|
+
// host 在 dispatch 边界统一翻译成稳定 rowKey。
|
|
833
|
+
detail_row_indexes?: number[];
|
|
834
|
+
// 交互按钮点击:命中规则指定的目标手动绑定 id,host 透传给 dispatch 精确定位单个动作(TargetBindingID)。
|
|
835
|
+
target_binding_id?: string;
|
|
836
|
+
// value-change 不由编辑器发起(宿主 Mirror 字段变更事件驱动),
|
|
837
|
+
// 编辑器发起的事件只剩生命周期 / 点击 / 保存 / 手动四类;target_rows 与 affected 已退役。
|
|
838
|
+
}
|
|
839
|
+
|
|
840
|
+
/** 手动触发绑定摘要(来自 GET /api/v1/action-trigger/manual-bindings),供按钮设置框挑选动作。
|
|
841
|
+
* 字段 snake_case 与后端响应逐字对齐,host 无需 remap。 */
|
|
842
|
+
export interface ManualActionSummary {
|
|
843
|
+
binding_id: string;
|
|
844
|
+
name: string;
|
|
845
|
+
scope: string;
|
|
846
|
+
/** 该动作事件是否已被设计器停用:停用的动作**仍在清单里**(不从选择器抹掉,否则
|
|
847
|
+
* 按钮上已绑定的动作会凭空消失),按钮设置框应灰显并标注「已停用」;停用动作绑定的按钮照常可点,
|
|
848
|
+
* 点击后运行期匹配不到任何绑定,静默无反应(不报错不提示)。缺省/老宿主不下发 = 启用。 */
|
|
849
|
+
disabled?: boolean;
|
|
850
|
+
}
|
|
851
|
+
|
|
852
|
+
/**
|
|
853
|
+
* Host-side action bus exposed to the editor through the host bridge. The editor calls
|
|
854
|
+
* emit() at lifecycle anchors with an EditorTriggerInput; the host dispatches through the
|
|
855
|
+
* pipeline and returns the resulting effect envelope for the editor to apply.
|
|
856
|
+
*/
|
|
857
|
+
export interface EditorHostActions {
|
|
858
|
+
emit(input: EditorTriggerInput): Promise<EditorEffectEnvelope>;
|
|
859
|
+
/** 列出当前模板的手动触发绑定,供交互按钮设置框挑选要触发的动作。可选:老宿主不实现时按钮设计器降级(列表为空)。 */
|
|
860
|
+
listManualActions?(): Promise<ManualActionSummary[]>;
|
|
861
|
+
/**
|
|
862
|
+
* 列出当前模板配置了「点击字段时」(field-click)触发的字段 id 清单。
|
|
863
|
+
* editor 挂载时拉取,用作点击派发前的前置过滤——未命中清单的格子不触发。
|
|
864
|
+
* 可选:老宿主不实现时视为空清单(不派发任何 field-click)。
|
|
865
|
+
*/
|
|
866
|
+
listFieldClickFields?(): Promise<string[]>;
|
|
867
|
+
/**
|
|
868
|
+
* 等待某次派发(mutationId)触发的整条异步动作链全部完成(busy 锁解锁时机)。
|
|
869
|
+
* 若该次派发无异步节点(envelope.async_pending 为假),host 侧应立即 resolve。
|
|
870
|
+
* 可选:老宿主不实现时 editor 侧应自行兜底(如不启用 busy 锁或退化为同步返回即解锁)。
|
|
871
|
+
*/
|
|
872
|
+
waitAsyncSettled?(mutationId: string): Promise<void>;
|
|
873
|
+
/**
|
|
874
|
+
* E1 回执续段(R6b):editor 执行完带 continuation_token 的效果对应的命令后,调用本方法
|
|
875
|
+
* 回执引擎恢复该节点的后续(子流程/续接组)。outcome 非空时覆盖 handler 出口路由;
|
|
876
|
+
* ctxVars 会以 "ctx." 前缀并入引擎变量池供后续节点表达式引用。
|
|
877
|
+
* 可选——老宿主不实现时 editor 侧 fire-and-forget 调用即可(无回执能力,续段能力整体降级)。
|
|
878
|
+
*/
|
|
879
|
+
postContinuation?(input: { token: string; outcome?: string; ctxVars?: Record<string, unknown> }): Promise<void>;
|
|
880
|
+
/**
|
|
881
|
+
* 订阅本填报会话的触发链活动:宿主从服务端会话事件流转出 chain-start / chain-done,编辑器据此
|
|
882
|
+
* 显示「动作在途」并在链结束时收起;订阅时宿主应回放当前仍在途的链(start)。返回取消订阅函数。
|
|
883
|
+
* 可选——老宿主不实现时编辑器不显示动作链在途提示(其余功能不受影响)。
|
|
884
|
+
*/
|
|
885
|
+
onChainActivity?(listener: (event: EditorChainActivityEvent) => void): () => void;
|
|
886
|
+
}
|
|
887
|
+
|
|
888
|
+
/** Editor capabilities the host uses to gate which command actions are offered. */
|
|
889
|
+
export interface EditorActionCapabilities {
|
|
890
|
+
commands: string[];
|
|
891
|
+
effectKinds: string[];
|
|
892
|
+
triggers: ActionTriggerEventKey[];
|
|
893
|
+
}
|
|
894
|
+
|
|
895
|
+
/**
|
|
896
|
+
* 填报态三态就地切换的入参(查看 ↔ 修改、保存后转查看、保存后继续新建)。
|
|
897
|
+
* 宿主已完成交互会话转态(后端端点)并把 formMode / recordId / readonly / hostContext 等 props
|
|
898
|
+
* 换成目标态之后,才以本入参调用 {@link EditorPluginExposedApi.switchFormMode}。
|
|
899
|
+
*/
|
|
900
|
+
export interface EditorFormModeSwitchInput {
|
|
901
|
+
/** 目标填报形态:'view' | 'edit' | 'create'(create = 保存后继续新建,同一会话就地重建为空白新单)。 */
|
|
902
|
+
formMode: EditorFormMode;
|
|
903
|
+
/** 目标单据 id(查看 / 修改态必有;create 时为宿主占位值,编辑器按空单据处理)。 */
|
|
904
|
+
recordId: string;
|
|
905
|
+
/** 目标态是否只读(查看态恒为 true)。 */
|
|
906
|
+
readonly: boolean;
|
|
907
|
+
/** 宿主端点应答里的单据版本号;编辑器优先以会话 meta 中的版本号为准,缺席时才用它。 */
|
|
908
|
+
recordVersionNo?: number;
|
|
909
|
+
/** 保存/提交后被动转查看:true 时不触发 view-time 打开锚点 */
|
|
910
|
+
suppressOpenLifecycleTrigger?: boolean;
|
|
911
|
+
}
|
|
912
|
+
|
|
913
|
+
/** Imperative API the editor exposes (via Vue defineExpose) for the host to push results in. */
|
|
914
|
+
export interface EditorPluginExposedApi {
|
|
915
|
+
applyEffectEnvelope(envelope: EditorEffectEnvelope): Promise<{ failedEffectId?: string; error?: string } | void>;
|
|
916
|
+
executeHostCommand(command: string, args?: Record<string, unknown>): Promise<void>;
|
|
917
|
+
getCapabilities(scene?: EditorScene): EditorActionCapabilities;
|
|
918
|
+
/**
|
|
919
|
+
* 把当前已打开的填报态单据渲染为 PDF Blob,不触发浏览器下载;由调用方决定是否落盘。
|
|
920
|
+
* 编辑器自身的「导出 PDF」按钮即走这条链(拿到 Blob 后触发下载)。
|
|
921
|
+
*/
|
|
922
|
+
exportPdfBlob?(): Promise<{ blob: Blob; pageCount: number; warnings: string[] }>;
|
|
923
|
+
/**
|
|
924
|
+
* 使用编辑器自身的 PDF 依赖保序合并,避免宿主主包静态引入 pdf-lib。
|
|
925
|
+
* 批量打印功能未完成(2026-08-04),宿主侧不再有调用方;能力本身保留待重启。
|
|
926
|
+
*/
|
|
927
|
+
mergePdfBlobs?(
|
|
928
|
+
blobs: Blob[],
|
|
929
|
+
limits?: { maxPages?: number; maxInputBytes?: number; maxOutputBytes?: number }
|
|
930
|
+
): Promise<{ blob: Blob; pageCount: number }>;
|
|
931
|
+
/** Read current changes from the live runtime Mirror. Available only in form-runtime task mode. */
|
|
932
|
+
getTaskDraftChanges?(): Promise<TaskWorkbenchChanges>;
|
|
933
|
+
/**
|
|
934
|
+
* Restore a typed draft into the live runtime without using DOM inputs.
|
|
935
|
+
*
|
|
936
|
+
* @deprecated 新版宿主不再调用:该链路是「外部草稿值 → 编辑器写格 → 编辑器投影回 Mirror」,
|
|
937
|
+
* 违反填报态业务数据经 Mirror。新编辑器不必实现;已实现的保留无害,下个主版本从契约中移除。
|
|
938
|
+
*/
|
|
939
|
+
applyTaskDraftChanges?(changes: TaskWorkbenchChanges): Promise<void>;
|
|
940
|
+
/** Replace the Host policy after workspace refresh/revoke. */
|
|
941
|
+
setTaskFieldPolicy?(config: TaskWorkbenchConfig): void;
|
|
942
|
+
/** Validate effective required fields in the live runtime before draft/complete. */
|
|
943
|
+
validateTaskRequired?(): Promise<TaskWorkbenchValidationResult>;
|
|
944
|
+
/** Upload a task-level attachment through the same authorised asset client as form attachments. */
|
|
945
|
+
uploadTaskAttachment?(file: File): Promise<{ assetId: string; fileName: string; mediaType: string; sizeBytes: number }>;
|
|
946
|
+
/**
|
|
947
|
+
* 填报态就地切换形态:同一编辑器会话不卸载、不重开,只复位插件侧与单据状态相关的
|
|
948
|
+
* 本地状态(单据 id / 版本号 / 保存与提交状态 / 错误提示),并按目标态触发 create-time / edit-time / view-time
|
|
949
|
+
* 打开锚点(入参 suppressOpenLifecycleTrigger 为真时不触发)。create 的打开锚点在编辑器收到会话重建为新单的
|
|
950
|
+
* 元信息后(或等待超时后)才触发,不阻塞本方法返回。
|
|
951
|
+
*
|
|
952
|
+
* 调用时机:宿主已完成交互会话转态端点调用、并把 formMode / recordId / readonly / hostContext 等 props
|
|
953
|
+
* 换成新对象之后再调用;编辑器据 props 计算的只读门控此时已翻转。
|
|
954
|
+
*
|
|
955
|
+
* 可选:老插件不实现,或本方法抛错(如会话尚未打开)时,宿主回落为整面重开。
|
|
956
|
+
*/
|
|
957
|
+
switchFormMode?(input: EditorFormModeSwitchInput): Promise<void>;
|
|
958
|
+
}
|
|
959
|
+
|
|
960
|
+
/**
|
|
961
|
+
* 宿主日志端口:编辑器前端的异常与关键降级路径经此上报宿主日志中心。
|
|
962
|
+
* 形态对齐 records-view HostLogBridge / auth bridge log:四级方法 + 可选上下文。
|
|
963
|
+
* 契约要求:
|
|
964
|
+
* - 日志动作本身永不影响业务流程——插件侧必须包一层 try/catch,桥缺席或抛错时降级 console;
|
|
965
|
+
* - 脱敏责任在宿主 bridge 层兜底(敏感键遮蔽/截断/防循环),插件侧不得依赖上报明文;
|
|
966
|
+
* - 可选端口,属 frontend.surface 域的兼容演进(新增可选键),不递增代际。
|
|
967
|
+
*/
|
|
968
|
+
export interface HostLogClient {
|
|
969
|
+
debug(message: string, context?: unknown): void;
|
|
970
|
+
info(message: string, context?: unknown): void;
|
|
971
|
+
warn(message: string, context?: unknown): void;
|
|
972
|
+
error(message: string, context?: unknown): void;
|
|
973
|
+
}
|
|
974
|
+
|
|
975
|
+
// 第二代设计澄清:editor 前端与 host 后台权威 Mirror **完全解耦**——
|
|
976
|
+
// 前端只渲染单元格(经 sidecar→WS 帧),业务值就是单元格值,无需也不应读 host Mirror。
|
|
977
|
+
// host Mirror 是给「其它读写上下文」(动作=host 侧 pipeline、消费插件、SDK 消费方)的业务权威视图,
|
|
978
|
+
// 由 editor **后台**(sidecar)单向投影喂数(见 MirrorService);前端零参与。
|
|
979
|
+
// 故 EditorHostBridge 不含任何 mirror 读端口。
|
|
980
|
+
export interface EditorHostBridge {
|
|
981
|
+
/**
|
|
982
|
+
* 资源已绑定的 Host 交互会话。编辑器不得自行 Acquire/Renew,也看不到租约与传输凭据。
|
|
983
|
+
* 登录认证结束时 Host 会先 scrub runtime/恢复内容,再把状态收敛为 lost/auth-ended。
|
|
984
|
+
*/
|
|
985
|
+
readonly interactiveSession: InteractiveSessionHandle;
|
|
986
|
+
request?<T = unknown>(input: HostRequestInput): Promise<HostRequestResult<T>>;
|
|
987
|
+
runtime?: RuntimeInstanceClient;
|
|
988
|
+
designData?: DesignDataClient;
|
|
989
|
+
recordData?: RecordDataClient;
|
|
990
|
+
assets?: AssetClient;
|
|
991
|
+
templateSchema?: FieldDefinitionClient;
|
|
992
|
+
/**
|
|
993
|
+
* 宿主 IAM 目录能力。member/department 字段只保存稳定 ID,编辑器经此解析显示名、
|
|
994
|
+
* 候选与停用状态;编辑器不得直接查询宿主组织表。
|
|
995
|
+
*/
|
|
996
|
+
orgDirectory?: OrgDirectoryClient;
|
|
997
|
+
message?: HostMessageClient;
|
|
998
|
+
actions?: EditorHostActions;
|
|
999
|
+
// 多语言能力(两级查找方案):宿主注入响应式 locale + 中央包查询 + 切换订阅。
|
|
1000
|
+
// 可选——老宿主不注入时插件降级为自带语言包纯本地链(createPluginI18n 已处理)。
|
|
1001
|
+
i18n?: HostI18n;
|
|
1002
|
+
/**
|
|
1003
|
+
* 用户时区(K4,user-locale-timezone-preference-plan-2026-07-11.md §2.5/§3.3):宿主注入
|
|
1004
|
+
* 响应式 IANA 时区名(来源 = app store `timezone`,已含"服务端偏好→浏览器时区→Asia/Shanghai"
|
|
1005
|
+
* 三级兜底链),供官方表格编辑器等编辑器插件在字段级"自动匹配时区"开关下换算显示。
|
|
1006
|
+
* 可选——老宿主未注入时插件侧应自行兜底 `Intl.DateTimeFormat().resolvedOptions().timeZone`。
|
|
1007
|
+
*/
|
|
1008
|
+
timezone?: HostTimezoneRef;
|
|
1009
|
+
/**
|
|
1010
|
+
* 宿主设计数值(theme 能力):颜色 / 圆角 / 控件高度与字号 / 间距 / 阴影 / 层级,
|
|
1011
|
+
* 随明暗、主题色、界面缩放变化,可 subscribe。**常驻可见**——不需要在 manifest 声明,也不受
|
|
1012
|
+
* hostCaps 裁剪。可选——老宿主未注入时用 readHostTheme(bridge) 得 null,插件用自己的回退值。
|
|
1013
|
+
*/
|
|
1014
|
+
theme?: HostTheme;
|
|
1015
|
+
// 导航能力(tab 方式打开目标模板单据):form.open 命令落地消费,见 HostNavigationClient。
|
|
1016
|
+
navigation?: HostNavigationClient;
|
|
1017
|
+
/**
|
|
1018
|
+
* 图片工具能力:宿主内置「图片裁切/调整」通用弹窗,供 editor 插件复用,避免各插件
|
|
1019
|
+
* 各自实现裁切 UI。仅产出裁切/压缩参数,真正的像素级压缩权威在后端 libvips。
|
|
1020
|
+
* 可选——老宿主未注入时插件侧应优雅降级(该能力入口不可用)。
|
|
1021
|
+
*/
|
|
1022
|
+
imageTools?: ImageToolsClient;
|
|
1023
|
+
/**
|
|
1024
|
+
* 日志端口:可选——老宿主未注入时插件侧降级为 console。
|
|
1025
|
+
* 宿主实现应接平台实例日志攒批上报器(runtime 维度),并做脱敏兜底。
|
|
1026
|
+
*/
|
|
1027
|
+
log?: HostLogClient;
|
|
1028
|
+
/**
|
|
1029
|
+
* 宿主实时订阅通道:按「主题 + key」订阅服务端推送,
|
|
1030
|
+
* 全页面共用宿主持有的那一条 WebSocket,插件不自建长连接。
|
|
1031
|
+
*
|
|
1032
|
+
* 可选——老宿主未注入时插件侧必须优雅降级(被订阅的功能本身不得依赖这条通道才能完成)。
|
|
1033
|
+
*
|
|
1034
|
+
* ⚠️ 宿主侧的 hostCaps 裁剪表是**显式白名单**(web-next 的 hostCapsPrune),未登记的能力键
|
|
1035
|
+
* 在插件访问时会**抛异常而不是返回 undefined**。因此插件 manifest 声明 `editor.realtime` 与
|
|
1036
|
+
* 宿主裁剪表登记必须同批到位,且宿主侧要先于插件侧上线。
|
|
1037
|
+
*/
|
|
1038
|
+
realtime?: OzRealtimeClient;
|
|
1039
|
+
}
|
|
1040
|
+
|
|
1041
|
+
export function defineEditorPlugin(plugin: EditorPluginFrontend): EditorPluginFrontend {
|
|
1042
|
+
return plugin;
|
|
1043
|
+
}
|
|
1044
|
+
|
|
1045
|
+
export function emitExternalSessionOpened(detail: {
|
|
1046
|
+
runtimeInstanceId?: string;
|
|
1047
|
+
pluginInstanceId?: string;
|
|
1048
|
+
pluginId?: string;
|
|
1049
|
+
sessionId?: string;
|
|
1050
|
+
clientId?: string;
|
|
1051
|
+
pluginEntry?: EditorPluginEntry;
|
|
1052
|
+
scene?: EditorScene;
|
|
1053
|
+
}) {
|
|
1054
|
+
if (typeof window === 'undefined') return;
|
|
1055
|
+
window.dispatchEvent(new CustomEvent('kimpo-plugin-session-opened', { detail }));
|
|
1056
|
+
}
|
|
1057
|
+
|
|
1058
|
+
// ════════════════════════════════════════════════════════════════════════════════════════
|
|
1059
|
+
// 编辑器解耦契约面(SDK 1.1.0-tp.14 起)
|
|
1060
|
+
//
|
|
1061
|
+
// 链路:任意合格编辑器插件(第三方编辑器 / 官方表格编辑器)↔ kimpo 宿主(插件基座、通用 editor transport、
|
|
1062
|
+
// 表单数据权威层 Mirror、模板域、动作设计器)。设计态(声明、设计文件信封、typed 设计态桥、表单结构)
|
|
1063
|
+
// 与填报态(bound session 快照、Mirror 快照、宿主驱动保存)都在这里;帧协议与沙箱档入口见 ./editor-frame。
|
|
1064
|
+
// 与 Go 侧对称:proto editor/v1 editor_session.proto、host/v1 EditorDesignFile、direction/editor(闭集与校验)、
|
|
1065
|
+
// schema/editor(JSON Schema 与黄金夹具)。下面的 wire 形状键名为 snake_case(与 proto 字段名一致)。
|
|
1066
|
+
// ════════════════════════════════════════════════════════════════════════════════════════
|
|
1067
|
+
|
|
1068
|
+
/** 会话模式:host-mirror 为必需核心(无会话后端),sidecar 为可选档案 session.sidecar(表格编辑器现状)。 */
|
|
1069
|
+
export type EditorSessionMode = 'host-mirror' | 'sidecar';
|
|
1070
|
+
|
|
1071
|
+
/** 会话模式闭集。 */
|
|
1072
|
+
export const EDITOR_SESSION_MODES: readonly EditorSessionMode[] = ['host-mirror', 'sidecar'];
|
|
1073
|
+
|
|
1074
|
+
/** 控件式编辑器的 designer_type(designer_type 是开放集,form 是新增的公共取值)。 */
|
|
1075
|
+
export const EDITOR_DESIGNER_TYPE_FORM = 'form';
|
|
1076
|
+
|
|
1077
|
+
/** 可选档案闭集。档案能力经能力总线以 `<plugin_id>/<能力短名>` 寻址,宿主按模板绑定编辑器拼名。 */
|
|
1078
|
+
export const EDITOR_PROFILES = [
|
|
1079
|
+
'session.sidecar',
|
|
1080
|
+
'save.editor',
|
|
1081
|
+
'design-file.compose',
|
|
1082
|
+
'design-file.transform',
|
|
1083
|
+
'design-file.summarize',
|
|
1084
|
+
'design-file.preview',
|
|
1085
|
+
'formula.compile',
|
|
1086
|
+
'chart',
|
|
1087
|
+
'sheet-catalog',
|
|
1088
|
+
'subtotal',
|
|
1089
|
+
'print.spec',
|
|
1090
|
+
'print.basic',
|
|
1091
|
+
'export.headless',
|
|
1092
|
+
'design-thumbnail',
|
|
1093
|
+
'task-workbench',
|
|
1094
|
+
'ai-proposal'
|
|
1095
|
+
] as const;
|
|
1096
|
+
|
|
1097
|
+
export type EditorProfile = (typeof EDITOR_PROFILES)[number];
|
|
1098
|
+
|
|
1099
|
+
/**
|
|
1100
|
+
* 无会话导出(档案 `export.headless`)产物格式闭集(`capabilities.editor.export_formats` 取值,1.1.0-tp.21 起)。
|
|
1101
|
+
* `export_formats` 不写 = 全部支持;宿主据此决定记录页「导出表单」菜单项显隐,建任务时格式不在声明内回 501。
|
|
1102
|
+
*/
|
|
1103
|
+
export const EDITOR_EXPORT_FORMATS = ['xlsx', 'pdf'] as const;
|
|
1104
|
+
|
|
1105
|
+
export type EditorExportFormat = (typeof EDITOR_EXPORT_FORMATS)[number];
|
|
1106
|
+
|
|
1107
|
+
/**
|
|
1108
|
+
* 平台单元格录入控件类型闭集(`capabilities.editor.supported_controls` 取值,与宿主控件枚举逐项一致,1.1.0-tp.21 起)。
|
|
1109
|
+
* 'member' / 'department' 是存量读兼容控件:声明合法,但宿主不把它们作为字段面板可选项。
|
|
1110
|
+
*/
|
|
1111
|
+
export const EDITOR_PLATFORM_CONTROL_TYPES = [
|
|
1112
|
+
'radio',
|
|
1113
|
+
'checkbox',
|
|
1114
|
+
'select',
|
|
1115
|
+
'list',
|
|
1116
|
+
'cascader',
|
|
1117
|
+
'datetime',
|
|
1118
|
+
'switch',
|
|
1119
|
+
'rate',
|
|
1120
|
+
'slider',
|
|
1121
|
+
'member',
|
|
1122
|
+
'department'
|
|
1123
|
+
] as const;
|
|
1124
|
+
|
|
1125
|
+
export type EditorPlatformControlType = (typeof EDITOR_PLATFORM_CONTROL_TYPES)[number];
|
|
1126
|
+
|
|
1127
|
+
/**
|
|
1128
|
+
* 打印方案 spec 内容语义版本(档案 `print.spec` 配套):官方表格编辑器现语义。
|
|
1129
|
+
* manifest `print_modes[].print_spec` 缺省即此值;编辑器在 `capabilities.editor.print_specs` 声明自己能解释的语义,
|
|
1130
|
+
* 宿主只把语义匹配的插件打印方案下发给该编辑器的会话(会话 meta `printModes`;不下发时 meta `printModesUnavailable` 给原因)。
|
|
1131
|
+
*/
|
|
1132
|
+
export const PRINT_SPEC_PAIMON_FRAGMENT_V1 = 'paimon-fragment@1';
|
|
1133
|
+
|
|
1134
|
+
/** H 宿主代办命令:与编辑器无关,宿主前端先处理;编辑器在 commands 声明同名命令时可接管。 */
|
|
1135
|
+
export const EDITOR_HOST_COMMANDS = ['message.show', 'form.open', 'form.pick-open', 'form.open-create'] as const;
|
|
1136
|
+
|
|
1137
|
+
/** C 核心命令:每个编辑器必须实现(host-mirror 下 form.save 最终落宿主驱动保存)。 */
|
|
1138
|
+
export const EDITOR_CORE_COMMANDS = ['form.save', 'form.close', 'form.edit', 'report.save', 'block-save', 'allow-save'] as const;
|
|
1139
|
+
|
|
1140
|
+
/** P 档案命令 → 所需档案:声明了对应档案才有。 */
|
|
1141
|
+
export const EDITOR_PROFILE_COMMANDS: Readonly<Record<string, EditorProfile>> = {
|
|
1142
|
+
'sheet.switch': 'sheet-catalog',
|
|
1143
|
+
'sheet.print': 'print.basic',
|
|
1144
|
+
'chart.set-inline-data': 'chart',
|
|
1145
|
+
'preview.enter': 'ai-proposal',
|
|
1146
|
+
'preview.exit': 'ai-proposal',
|
|
1147
|
+
'highlight.set': 'ai-proposal',
|
|
1148
|
+
'highlight.clear': 'ai-proposal',
|
|
1149
|
+
'design.save': 'ai-proposal'
|
|
1150
|
+
};
|
|
1151
|
+
|
|
1152
|
+
/** 命令分级:H 宿主代办 / C 核心 / P 档案;不认识的命令(编辑器私有)返回 null。 */
|
|
1153
|
+
export type EditorCommandTier = 'H' | 'C' | 'P';
|
|
1154
|
+
|
|
1155
|
+
/** 按前缀整族归档案的 P 级命令(preview.* / highlight.* 需 ai-proposal)。 */
|
|
1156
|
+
export const EDITOR_PROFILE_COMMAND_FAMILIES: Readonly<Record<string, EditorProfile>> = {
|
|
1157
|
+
'preview.': 'ai-proposal',
|
|
1158
|
+
'highlight.': 'ai-proposal'
|
|
1159
|
+
};
|
|
1160
|
+
|
|
1161
|
+
/** P 级命令所需档案;不是 P 级命令返回 null。 */
|
|
1162
|
+
export function editorCommandProfile(command: string): EditorProfile | null {
|
|
1163
|
+
if (Object.prototype.hasOwnProperty.call(EDITOR_PROFILE_COMMANDS, command)) return EDITOR_PROFILE_COMMANDS[command];
|
|
1164
|
+
for (const [prefix, profile] of Object.entries(EDITOR_PROFILE_COMMAND_FAMILIES)) {
|
|
1165
|
+
if (command.startsWith(prefix) && command.length > prefix.length) return profile;
|
|
1166
|
+
}
|
|
1167
|
+
return null;
|
|
1168
|
+
}
|
|
1169
|
+
|
|
1170
|
+
export function editorCommandTier(command: string): EditorCommandTier | null {
|
|
1171
|
+
if ((EDITOR_HOST_COMMANDS as readonly string[]).includes(command)) return 'H';
|
|
1172
|
+
if ((EDITOR_CORE_COMMANDS as readonly string[]).includes(command)) return 'C';
|
|
1173
|
+
if (editorCommandProfile(command)) return 'P';
|
|
1174
|
+
return null;
|
|
1175
|
+
}
|
|
1176
|
+
|
|
1177
|
+
/** 编辑器错误码(宿主四语文案键 err.editor.<小写码>;与第三方指南错误码表同表,v1.1.0-tp.19 按宿主核定)。 */
|
|
1178
|
+
export const EDITOR_ERROR_CODES = {
|
|
1179
|
+
/** 503:模板绑定编辑器停用 / 未安装(带插件 ID),不回落表格编辑器。 */
|
|
1180
|
+
TEMPLATE_EDITOR_UNAVAILABLE: 'TEMPLATE_EDITOR_UNAVAILABLE',
|
|
1181
|
+
/** 400:新建模板时所选编辑器插件未安装或未启用。 */
|
|
1182
|
+
TEMPLATE_EDITOR_PLUGIN_INVALID: 'TEMPLATE_EDITOR_PLUGIN_INVALID',
|
|
1183
|
+
/** 409:插件不满足合格编辑器判据。 */
|
|
1184
|
+
EDITOR_NOT_ELIGIBLE: 'EDITOR_NOT_ELIGIBLE',
|
|
1185
|
+
/** 501:请求了编辑器未声明的档案(带档案名)。 */
|
|
1186
|
+
EDITOR_PROFILE_UNSUPPORTED: 'EDITOR_PROFILE_UNSUPPORTED',
|
|
1187
|
+
/** 效果失败回执:命令不在编辑器能力里(带命令名)。 */
|
|
1188
|
+
EDITOR_COMMAND_UNSUPPORTED: 'EDITOR_COMMAND_UNSUPPORTED',
|
|
1189
|
+
/** editor-frame/1 协议错误:帧不合法(类型未知、v≠1、JSON 不合法等)时宿主回 error 帧、连接不断;附着的 last_seq 不合法、保存请求的会话与路径不符时为 HTTP 400。 */
|
|
1190
|
+
EDITOR_FRAME_PROTOCOL: 'EDITOR_FRAME_PROTOCOL',
|
|
1191
|
+
/** 帧:重放缓冲不足,须重拉快照。 */
|
|
1192
|
+
EDITOR_RESYNC_REQUIRED: 'EDITOR_RESYNC_REQUIRED',
|
|
1193
|
+
/** 403 / ack 拒写:会话只读(查看态等),任何编辑都被拒。 */
|
|
1194
|
+
EDITOR_SESSION_READONLY: 'EDITOR_SESSION_READONLY',
|
|
1195
|
+
/** ack 拒写:字段不可编辑(隐藏 / 只读 / 派生只读)。 */
|
|
1196
|
+
EDITOR_FIELD_NOT_EDITABLE: 'EDITOR_FIELD_NOT_EDITABLE',
|
|
1197
|
+
/** ack 拒写:表只读,不能增删行。 */
|
|
1198
|
+
EDITOR_TABLE_READONLY: 'EDITOR_TABLE_READONLY',
|
|
1199
|
+
/** ack 拒写:表单数据权威层拒绝了这次写入(值不合法等)。 */
|
|
1200
|
+
EDITOR_MIRROR_REJECTED: 'EDITOR_MIRROR_REJECTED',
|
|
1201
|
+
/** 404:编辑会话不存在或已关闭(宿主驱动保存、必填预检)。 */
|
|
1202
|
+
EDITOR_SESSION_NOT_FOUND: 'EDITOR_SESSION_NOT_FOUND',
|
|
1203
|
+
/** 409:会话模式不符(如对 sidecar 会话调宿主驱动保存)。 */
|
|
1204
|
+
EDITOR_SESSION_MODE_MISMATCH: 'EDITOR_SESSION_MODE_MISMATCH',
|
|
1205
|
+
/** 宿主驱动保存失败(落库出错)。 */
|
|
1206
|
+
EDITOR_SAVE_FAILED: 'EDITOR_SAVE_FAILED',
|
|
1207
|
+
/** 409:卸载阻断(仍有模板绑定,含软删)。 */
|
|
1208
|
+
EDITOR_PLUGIN_HAS_TEMPLATES: 'EDITOR_PLUGIN_HAS_TEMPLATES',
|
|
1209
|
+
/** 422:导出等功能需要的编辑器插件不可用。 */
|
|
1210
|
+
EDITOR_PLUGIN_UNAVAILABLE: 'EDITOR_PLUGIN_UNAVAILABLE',
|
|
1211
|
+
/** 400:designer_type 不被任何合格编辑器声明。 */
|
|
1212
|
+
TEMPLATE_DESIGNER_TYPE_UNSUPPORTED: 'TEMPLATE_DESIGNER_TYPE_UNSUPPORTED'
|
|
1213
|
+
} as const;
|
|
1214
|
+
|
|
1215
|
+
/**
|
|
1216
|
+
* manifest `capabilities.editor` 声明(Go 侧 editorpb.EditorCapabilities,校验见 direction/editor 与 manifestlint)。
|
|
1217
|
+
* 合格编辑器 = category=editor + 本声明 + designer 与 runtime 两个 surface + active 实例。
|
|
1218
|
+
*/
|
|
1219
|
+
export interface EditorCapabilitiesDecl {
|
|
1220
|
+
session_mode: EditorSessionMode;
|
|
1221
|
+
/** 本编辑器负责的 designer_type(至少一项;控件式编辑器用 'form')。 */
|
|
1222
|
+
designer_types: string[];
|
|
1223
|
+
/** 是否有公式计算;true 时必须经 calc.state 上报计算状态。 */
|
|
1224
|
+
computes: boolean;
|
|
1225
|
+
/** 设计文件信封 format:不含空白、至多 128 字符,推荐写成 'org.example.editor/form@1'。 */
|
|
1226
|
+
design_file_format: string;
|
|
1227
|
+
/** 静态声明支持的动作界面命令(应含全部 C 级核心命令;缺了宿主只告警,但对应动作效果会具名失败)。 */
|
|
1228
|
+
commands: string[];
|
|
1229
|
+
profiles?: EditorProfile[];
|
|
1230
|
+
/** 能解释的打印方案 spec 语义版本(`<语义名>@<主版本>`,如 'paimon-fragment@1');非空须同时声明档案 'print.spec'。 */
|
|
1231
|
+
print_specs?: string[];
|
|
1232
|
+
/**
|
|
1233
|
+
* 无会话导出支持的格式(可选,只能随档案 'export.headless';不重复、写了不能为空)。不写 = 'xlsx' 与 'pdf' 都支持。tp.21 起。
|
|
1234
|
+
*/
|
|
1235
|
+
export_formats?: EditorExportFormat[];
|
|
1236
|
+
/** 本编辑器能渲染的录入控件类型(可选,不重复);不写 = 不提供录入控件。tp.21 起。 */
|
|
1237
|
+
supported_controls?: EditorPlatformControlType[];
|
|
1238
|
+
/** sidecar 会话模式的帧类型 → 宿主转发 RPC 映射(可选,只能随 sidecar;留空项取缺省表,见 DEFAULT_EDITOR_SIDECAR_FRAMES)。tp.15 起。 */
|
|
1239
|
+
sidecar_frames?: EditorSidecarFramesDecl;
|
|
1240
|
+
}
|
|
1241
|
+
|
|
1242
|
+
/**
|
|
1243
|
+
* sidecar 帧类型表(每项为帧 JSON 的 type 取值)。宿主对 sidecar 帧哑管道转发,只按帧类型决定调哪个 EditorPlugin RPC;
|
|
1244
|
+
* 支持编辑器解耦的宿主开 sidecar 会话时按本声明覆盖缺省表转发;更早的宿主一律按缺省表转发。
|
|
1245
|
+
*/
|
|
1246
|
+
export interface EditorSidecarFramesDecl {
|
|
1247
|
+
attached?: string;
|
|
1248
|
+
ping?: string;
|
|
1249
|
+
pong?: string;
|
|
1250
|
+
/** → DispatchCommand。 */
|
|
1251
|
+
command?: string;
|
|
1252
|
+
/** → JournalCatchup。 */
|
|
1253
|
+
journal_catchup?: string;
|
|
1254
|
+
/** → MaterializeViewport。 */
|
|
1255
|
+
viewport_subscribe?: string;
|
|
1256
|
+
viewport_update?: string;
|
|
1257
|
+
/** MaterializeViewport 应答包装成的服务端帧类型。 */
|
|
1258
|
+
viewport_data_batch?: string;
|
|
1259
|
+
/** 浏览器本地状态帧,宿主忽略。 */
|
|
1260
|
+
viewport_unsubscribe?: string;
|
|
1261
|
+
/** DispatchCommand 的 channel 入参。 */
|
|
1262
|
+
transport_channel?: string;
|
|
1263
|
+
}
|
|
1264
|
+
|
|
1265
|
+
/** sidecar 帧类型缺省表(官方表格编辑器现值,与 Go direction/editor DefaultSidecarFrames 一致)。 */
|
|
1266
|
+
export const DEFAULT_EDITOR_SIDECAR_FRAMES: Readonly<Required<EditorSidecarFramesDecl>> = {
|
|
1267
|
+
attached: 'session-attached',
|
|
1268
|
+
ping: 'ping',
|
|
1269
|
+
pong: 'pong',
|
|
1270
|
+
command: 'command',
|
|
1271
|
+
journal_catchup: 'journal-catchup',
|
|
1272
|
+
viewport_subscribe: 'viewport-subscribe',
|
|
1273
|
+
viewport_update: 'viewport-update',
|
|
1274
|
+
viewport_data_batch: 'viewport-data-batch',
|
|
1275
|
+
viewport_unsubscribe: 'viewport-unsubscribe',
|
|
1276
|
+
transport_channel: 'websocket'
|
|
1277
|
+
};
|
|
1278
|
+
|
|
1279
|
+
/** 字段业务值(与 Mirror TypedValue{Raw, Text} 同口径)。 */
|
|
1280
|
+
export interface EditorTypedValue {
|
|
1281
|
+
raw?: unknown;
|
|
1282
|
+
text?: string;
|
|
1283
|
+
}
|
|
1284
|
+
|
|
1285
|
+
export interface EditorFieldValue {
|
|
1286
|
+
field_id: string;
|
|
1287
|
+
value?: EditorTypedValue;
|
|
1288
|
+
}
|
|
1289
|
+
|
|
1290
|
+
/** Mirror 里一行的快照:row_key 为 Mirror 稳定行键(主表 main:0、明细 row:N),不是显示行号。 */
|
|
1291
|
+
export interface EditorRowSnapshot {
|
|
1292
|
+
row_key: string;
|
|
1293
|
+
/** clean | new | dirty(deleted 行不进快照)。 */
|
|
1294
|
+
row_state?: string;
|
|
1295
|
+
display_order?: number;
|
|
1296
|
+
record_id?: string;
|
|
1297
|
+
fields?: EditorFieldValue[];
|
|
1298
|
+
}
|
|
1299
|
+
|
|
1300
|
+
export interface EditorTableSnapshot {
|
|
1301
|
+
data_table_id: string;
|
|
1302
|
+
role?: 'main' | 'detail' | string;
|
|
1303
|
+
rows?: EditorRowSnapshot[];
|
|
1304
|
+
}
|
|
1305
|
+
|
|
1306
|
+
/** 来自 Mirror 的记录快照(隐藏字段的值已由宿主剔除)。 */
|
|
1307
|
+
export interface EditorRecordSnapshot {
|
|
1308
|
+
record_id?: string;
|
|
1309
|
+
template_version_no?: string;
|
|
1310
|
+
record_version_no?: number;
|
|
1311
|
+
/** 快照对应的 Mirror 写序;后续 mirror.patch 从 mirror_seq + 1 起连续。 */
|
|
1312
|
+
mirror_seq?: number;
|
|
1313
|
+
tables?: EditorTableSnapshot[];
|
|
1314
|
+
}
|
|
1315
|
+
|
|
1316
|
+
/** 宿主下发的会话元数据(打开应答与 session.meta 帧同形)。编辑器只呈现,不自行判定权限与锁。 */
|
|
1317
|
+
export interface EditorSessionMeta {
|
|
1318
|
+
readonly?: boolean;
|
|
1319
|
+
record_locked?: boolean;
|
|
1320
|
+
hidden_field_ids?: string[];
|
|
1321
|
+
readonly_field_ids?: string[];
|
|
1322
|
+
readonly_table_ids?: string[];
|
|
1323
|
+
derived_readonly_field_ids?: string[];
|
|
1324
|
+
/** 模板权限位(键名由宿主定义,如 can_print / can_view_history)。 */
|
|
1325
|
+
permissions?: Record<string, boolean>;
|
|
1326
|
+
locale?: string;
|
|
1327
|
+
timezone?: string;
|
|
1328
|
+
form_mode?: EditorFormMode | string;
|
|
1329
|
+
scene?: EditorScene | string;
|
|
1330
|
+
/** 宿主附加元数据(如 print_modes),未知键忽略。 */
|
|
1331
|
+
extensions?: Record<string, unknown>;
|
|
1332
|
+
/**
|
|
1333
|
+
* 宿主字段模型里的必填字段:已扣掉隐藏 / 只读 / 派生只读字段(本步填不了的不要求必填)。
|
|
1334
|
+
* 编辑器据此标星号、本地提前拦截;最终裁决仍是宿主保存回执的 fieldErrors。旧宿主不下发时缺省。
|
|
1335
|
+
*/
|
|
1336
|
+
required_field_ids?: string[];
|
|
1337
|
+
}
|
|
1338
|
+
|
|
1339
|
+
/**
|
|
1340
|
+
* 通用 bound editor session 快照(取代宿主与表格编辑器各自私有的 BoundSheetSessionSnapshot)。
|
|
1341
|
+
* 宿主前端把 `POST …/interactive-sessions/{id}/editor-sessions` 应答归一成本形状交给编辑器:顶层键 camelCase
|
|
1342
|
+
* (与旧 BoundSheetSessionSnapshot 同口径),meta / recordSnapshot 原样保持 wire 形状(snake_case,与帧体一致)。
|
|
1343
|
+
* 不含任何传输凭据(route / attach token 留在宿主)。
|
|
1344
|
+
*/
|
|
1345
|
+
export interface BoundEditorSessionSnapshot {
|
|
1346
|
+
editorSessionId: string;
|
|
1347
|
+
/** @deprecated 与 editorSessionId 同值,兼容表格编辑器读取旧键名。 */
|
|
1348
|
+
sheetSessionId?: string;
|
|
1349
|
+
pluginId?: string;
|
|
1350
|
+
sessionMode?: EditorSessionMode;
|
|
1351
|
+
credentialRevision: number;
|
|
1352
|
+
expiresAt: string;
|
|
1353
|
+
serverTime: string;
|
|
1354
|
+
/** WS 附着路径(宿主页持有 WS;沙箱档编辑器不拿 attach token,帧经宿主桥 editorFrames 转发)。 */
|
|
1355
|
+
attachPath: string;
|
|
1356
|
+
meta?: EditorSessionMeta;
|
|
1357
|
+
/** host-mirror 模式的初始快照;sidecar 模式为空。 */
|
|
1358
|
+
recordSnapshot?: EditorRecordSnapshot;
|
|
1359
|
+
/** sidecar 编辑器私有 bootstrap(宿主不解释);host-mirror 模式为空。 */
|
|
1360
|
+
bootstrap?: unknown;
|
|
1361
|
+
/** host-mirror 为 'editor-frame/1';sidecar 为空。 */
|
|
1362
|
+
frameProtocol?: string;
|
|
1363
|
+
}
|
|
1364
|
+
|
|
1365
|
+
// ---- 设计文件信封与中立绑定投影(Host RPC TemplateService.OpenEditorDesign / SaveEditorDesign)----
|
|
1366
|
+
|
|
1367
|
+
export interface EditorTableBinding {
|
|
1368
|
+
data_table_id: string;
|
|
1369
|
+
role: 'main' | 'detail';
|
|
1370
|
+
/** 不透明落位(表格编辑器 sheetId!A1,控件式编辑器控件 id),宿主不解释。 */
|
|
1371
|
+
anchor?: string;
|
|
1372
|
+
}
|
|
1373
|
+
|
|
1374
|
+
export interface EditorFieldBinding {
|
|
1375
|
+
field_id: string;
|
|
1376
|
+
data_table_id: string;
|
|
1377
|
+
anchor: string;
|
|
1378
|
+
}
|
|
1379
|
+
|
|
1380
|
+
/** 中立绑定投影:宿主唯一会解释的部分(字段落位核对、资产引用抽取、KimpoAI 核对、动作设计器字段候选)。 */
|
|
1381
|
+
export interface EditorBindingsProjection {
|
|
1382
|
+
tables: EditorTableBinding[];
|
|
1383
|
+
fields: EditorFieldBinding[];
|
|
1384
|
+
}
|
|
1385
|
+
|
|
1386
|
+
/** 设计文件信封(JSON Schema 见 SDK schema/editor/design-file-envelope@1.json)。payload 是编辑器私有文档,宿主不解释。 */
|
|
1387
|
+
export interface EditorDesignFile<TPayload = unknown> {
|
|
1388
|
+
format: string;
|
|
1389
|
+
format_version: number;
|
|
1390
|
+
bindings: EditorBindingsProjection;
|
|
1391
|
+
payload: TPayload;
|
|
1392
|
+
}
|
|
1393
|
+
|
|
1394
|
+
/** 设计保存核对诊断(如 EDITOR_BINDING_FIELD_UNPLACED 字段未落位)。 */
|
|
1395
|
+
export interface EditorDesignDiagnostic {
|
|
1396
|
+
code: string;
|
|
1397
|
+
severity: 'error' | 'warn' | 'info';
|
|
1398
|
+
message: string;
|
|
1399
|
+
field_id?: string;
|
|
1400
|
+
data_table_id?: string;
|
|
1401
|
+
}
|
|
1402
|
+
|
|
1403
|
+
// ---- typed 设计态桥(入参出参与宿主模板域同形,字段条目键名 snake_case)----
|
|
1404
|
+
|
|
1405
|
+
/** 可新建的字段数据类型。boolean 与 date 已退役:date 用 datetime,boolean 用 text 或 number。 */
|
|
1406
|
+
export type EditorFieldDataType = 'text' | 'number' | 'decimal' | 'datetime' | 'json' | 'attachment' | 'member' | 'department';
|
|
1407
|
+
|
|
1408
|
+
/** 一个待定义字段(与宿主 DefineMainTableFieldInput 同形)。 */
|
|
1409
|
+
export interface EditorDefineFieldInput {
|
|
1410
|
+
/** 前端临时回声键(结果里原样带回)。 */
|
|
1411
|
+
client_id: string;
|
|
1412
|
+
field_name: string;
|
|
1413
|
+
data_type: EditorFieldDataType;
|
|
1414
|
+
display_style?: string;
|
|
1415
|
+
sort_no?: number;
|
|
1416
|
+
/** 编辑器私有落位引用(不透明 JSON)。 */
|
|
1417
|
+
binding_ref?: unknown;
|
|
1418
|
+
/** 可选:指定字段编号(留空由宿主生成)。 */
|
|
1419
|
+
field_id?: string;
|
|
1420
|
+
/** 只接受 '' 或 'row_serial'(明细序号,仅明细表)。 */
|
|
1421
|
+
default_kind?: '' | 'row_serial';
|
|
1422
|
+
}
|
|
1423
|
+
|
|
1424
|
+
export interface EditorDefineFieldsInput {
|
|
1425
|
+
fields: EditorDefineFieldInput[];
|
|
1426
|
+
/** 设计态编辑会话 id(宿主沿用旧键名)。 */
|
|
1427
|
+
sheetSessionId?: string;
|
|
1428
|
+
}
|
|
1429
|
+
|
|
1430
|
+
export interface EditorDefinedTable {
|
|
1431
|
+
data_table_id: string;
|
|
1432
|
+
table_name: string;
|
|
1433
|
+
table_role: 'main' | 'extension' | string;
|
|
1434
|
+
physical_table_name?: string;
|
|
1435
|
+
sort_no?: number;
|
|
1436
|
+
version_no?: number;
|
|
1437
|
+
table_code?: string;
|
|
1438
|
+
extension_mode?: string;
|
|
1439
|
+
extension_layout?: string;
|
|
1440
|
+
client_id?: string;
|
|
1441
|
+
}
|
|
1442
|
+
|
|
1443
|
+
export interface EditorDefinedField {
|
|
1444
|
+
client_id: string;
|
|
1445
|
+
field_id: string;
|
|
1446
|
+
field_name: string;
|
|
1447
|
+
data_type: string;
|
|
1448
|
+
display_style?: string;
|
|
1449
|
+
storage_column_name?: string;
|
|
1450
|
+
sort_no?: number;
|
|
1451
|
+
version_no?: number;
|
|
1452
|
+
}
|
|
1453
|
+
|
|
1454
|
+
export interface EditorDefineFieldsResult {
|
|
1455
|
+
data_table: EditorDefinedTable;
|
|
1456
|
+
created_fields: EditorDefinedField[];
|
|
1457
|
+
}
|
|
1458
|
+
|
|
1459
|
+
export interface EditorDefineExtensionTableInput {
|
|
1460
|
+
clientId?: string;
|
|
1461
|
+
tableName?: string;
|
|
1462
|
+
tableCode?: string;
|
|
1463
|
+
/** 首版固定 detail。 */
|
|
1464
|
+
extensionMode?: 'detail';
|
|
1465
|
+
/** 扩展方向,缺省 vertical。 */
|
|
1466
|
+
layout?: 'vertical' | 'horizontal';
|
|
1467
|
+
sortNo?: number;
|
|
1468
|
+
fields?: EditorDefineFieldInput[];
|
|
1469
|
+
sheetSessionId?: string;
|
|
1470
|
+
}
|
|
1471
|
+
|
|
1472
|
+
export interface EditorDefineExtensionTableFieldsInput {
|
|
1473
|
+
dataTableId: string;
|
|
1474
|
+
fields: EditorDefineFieldInput[];
|
|
1475
|
+
sheetSessionId?: string;
|
|
1476
|
+
}
|
|
1477
|
+
|
|
1478
|
+
/** 设计态打开结果(与 EditorDesignDocument 同元数据,设计文件为信封)。 */
|
|
1479
|
+
export interface EditorDesignDocumentV1 {
|
|
1480
|
+
document_id: string;
|
|
1481
|
+
template_id: string;
|
|
1482
|
+
template_version_no: string;
|
|
1483
|
+
designer_type: string;
|
|
1484
|
+
plugin_id: string;
|
|
1485
|
+
document_status: string;
|
|
1486
|
+
content_revision: number;
|
|
1487
|
+
version_no: number;
|
|
1488
|
+
read_only?: boolean;
|
|
1489
|
+
/** 新建空文档时为 null(编辑器自行初始化)。 */
|
|
1490
|
+
design_file: EditorDesignFile | null;
|
|
1491
|
+
diagnostics?: EditorDesignDiagnostic[];
|
|
1492
|
+
}
|
|
1493
|
+
|
|
1494
|
+
// ---- 设计态模板模型读 / 字段属性写(宿主字段模型是权威,编辑器只读写其公开投影)----
|
|
1495
|
+
|
|
1496
|
+
/** 字段固定选项(宿主控件内联预设 source_inline.kind=preset)。 */
|
|
1497
|
+
export interface EditorFieldOption {
|
|
1498
|
+
value: string;
|
|
1499
|
+
label?: string;
|
|
1500
|
+
}
|
|
1501
|
+
|
|
1502
|
+
/** 引用目标(引用另一模板的数据表字段)。 */
|
|
1503
|
+
export interface EditorFieldReference {
|
|
1504
|
+
templateId: string;
|
|
1505
|
+
tableId: string;
|
|
1506
|
+
fieldId: string;
|
|
1507
|
+
}
|
|
1508
|
+
|
|
1509
|
+
/** 模板模型里的一个字段(宿主字段模型的公开投影:不含物理列名等存储细节)。 */
|
|
1510
|
+
export interface EditorTemplateModelField {
|
|
1511
|
+
field_id: string;
|
|
1512
|
+
data_table_id: string;
|
|
1513
|
+
field_code: string;
|
|
1514
|
+
field_name: string;
|
|
1515
|
+
data_type: EditorFieldDataType | string;
|
|
1516
|
+
control_type?: string;
|
|
1517
|
+
display_style?: string;
|
|
1518
|
+
sort_no?: number;
|
|
1519
|
+
required: boolean;
|
|
1520
|
+
readonly: boolean;
|
|
1521
|
+
default_kind?: string;
|
|
1522
|
+
default_value?: string;
|
|
1523
|
+
options?: EditorFieldOption[];
|
|
1524
|
+
reference?: EditorFieldReference;
|
|
1525
|
+
/** 字段行版本(写字段属性 / 删字段时作乐观锁基线)。 */
|
|
1526
|
+
version_no: number;
|
|
1527
|
+
}
|
|
1528
|
+
|
|
1529
|
+
/** 模板模型里的一张数据表。 */
|
|
1530
|
+
export interface EditorTemplateModelTable {
|
|
1531
|
+
data_table_id: string;
|
|
1532
|
+
table_code?: string;
|
|
1533
|
+
table_name: string;
|
|
1534
|
+
role: 'main' | 'detail';
|
|
1535
|
+
version_no?: number;
|
|
1536
|
+
fields: EditorTemplateModelField[];
|
|
1537
|
+
}
|
|
1538
|
+
|
|
1539
|
+
/** 当前模板版本的表与字段(含尚未落位到设计文件的字段:编辑器据此列出「未放置字段」)。 */
|
|
1540
|
+
export interface EditorTemplateModel {
|
|
1541
|
+
template_id: string;
|
|
1542
|
+
template_version_no: string;
|
|
1543
|
+
tables: EditorTemplateModelTable[];
|
|
1544
|
+
}
|
|
1545
|
+
|
|
1546
|
+
/**
|
|
1547
|
+
* 一个字段的属性改动(只列出要改的键;未给 = 不改)。dataType 不得为已退役的 boolean / date。
|
|
1548
|
+
* defaultValue / options / reference 传 null 表示清除。
|
|
1549
|
+
*/
|
|
1550
|
+
export interface EditorFieldPropertyPatch {
|
|
1551
|
+
fieldId: string;
|
|
1552
|
+
/** 字段行版本(取自 listTemplateModel);不一致时宿主拒绝(VERSION_CONFLICT),编辑器应重读模型。 */
|
|
1553
|
+
expectedVersionNo: number;
|
|
1554
|
+
fieldName?: string;
|
|
1555
|
+
dataType?: EditorFieldDataType;
|
|
1556
|
+
displayStyle?: string;
|
|
1557
|
+
required?: boolean;
|
|
1558
|
+
readonly?: boolean;
|
|
1559
|
+
defaultValue?: string | null;
|
|
1560
|
+
options?: EditorFieldOption[] | null;
|
|
1561
|
+
reference?: EditorFieldReference | null;
|
|
1562
|
+
}
|
|
1563
|
+
|
|
1564
|
+
/** 字段属性写 / 删字段的回执。 */
|
|
1565
|
+
export interface EditorFieldChangeResult {
|
|
1566
|
+
updated_field_ids: string[];
|
|
1567
|
+
deleted_field_ids: string[];
|
|
1568
|
+
}
|
|
1569
|
+
|
|
1570
|
+
/** 删字段被宿主拦下的原因(有引用 / 有数据时宿主不替编辑器做强制删除,交用户去数据表管理器处理)。 */
|
|
1571
|
+
export const EDITOR_FIELD_DELETE_BLOCKED = 'EDITOR_FIELD_DELETE_BLOCKED';
|
|
1572
|
+
|
|
1573
|
+
/**
|
|
1574
|
+
* typed 设计态桥(hostBridge.designData 的形状;沙箱档经 frame RPC 白名单暴露)。
|
|
1575
|
+
* 旧 DesignDataClient 保持不变以兼容既有宿主实现;新编辑器按本接口调用。
|
|
1576
|
+
*/
|
|
1577
|
+
export interface EditorDesignBridgeV1 {
|
|
1578
|
+
open(): Promise<EditorDesignDocumentV1>;
|
|
1579
|
+
save(input: { expectedVersionNo: number; designFile: EditorDesignFile; pluginInstanceId?: string }): Promise<EditorDesignDocumentV1>;
|
|
1580
|
+
loadExpressionCatalog?(): Promise<EditorExpressionCatalogV2>;
|
|
1581
|
+
defineFields(input: EditorDefineFieldsInput): Promise<EditorDefineFieldsResult>;
|
|
1582
|
+
defineMainTableFields?(input: EditorDefineFieldsInput): Promise<EditorDefineFieldsResult>;
|
|
1583
|
+
defineExtensionTable(input: EditorDefineExtensionTableInput): Promise<EditorDefineFieldsResult>;
|
|
1584
|
+
defineExtensionTableFields(input: EditorDefineExtensionTableFieldsInput): Promise<EditorDefineFieldsResult>;
|
|
1585
|
+
openActionDesigner?(): void | Promise<void>;
|
|
1586
|
+
/** 读当前模板版本的表与字段(新宿主才有)。 */
|
|
1587
|
+
listTemplateModel?(): Promise<EditorTemplateModel>;
|
|
1588
|
+
/** 写字段属性:改名 / 必填 / 只读 / 默认值 / 选项 / 引用目标 / 数据类型(按宿主字段模型校验)。 */
|
|
1589
|
+
updateFields?(input: { dataTableId: string; fields: EditorFieldPropertyPatch[] }): Promise<EditorFieldChangeResult>;
|
|
1590
|
+
/** 删字段(宿主先做删除影响预检;有引用或有数据时拒绝,错误码 EDITOR_FIELD_DELETE_BLOCKED)。 */
|
|
1591
|
+
deleteFields?(input: { dataTableId: string; fields: Array<{ fieldId: string; expectedVersionNo: number }> }): Promise<EditorFieldChangeResult>;
|
|
1592
|
+
}
|
|
1593
|
+
|
|
1594
|
+
// ---- 宿主驱动保存----
|
|
1595
|
+
|
|
1596
|
+
/**
|
|
1597
|
+
* 请宿主按 Mirror 保存:不带字段载荷(前端载荷直存已退役,按旧语义发的载荷被拒)。
|
|
1598
|
+
* 宿主依次 WaitSettled → BuildPayload → 落库 → CommitSaveResult;失败按 ReportSaveResult.fieldErrors 返回。
|
|
1599
|
+
*/
|
|
1600
|
+
export interface EditorHostSaveRequest {
|
|
1601
|
+
mode: 'create' | 'edit';
|
|
1602
|
+
/** 幂等键:同一键重复提交只保存一次。 */
|
|
1603
|
+
clientMutationId: string;
|
|
1604
|
+
/** 记录级乐观锁基线(缺省由 Mirror 基线决定)。 */
|
|
1605
|
+
expectedVersionNo?: number;
|
|
1606
|
+
/** 非空表示保存并提交(发起流程等由宿主处理)。 */
|
|
1607
|
+
submitAction?: string;
|
|
1608
|
+
}
|
|
1609
|
+
|
|
1610
|
+
/** host-mirror 编辑器的填报态桥(hostBridge.recordData 的形状)。 */
|
|
1611
|
+
export interface EditorRecordBridgeV1 {
|
|
1612
|
+
save(input: EditorHostSaveRequest): Promise<ReportSaveResult>;
|
|
1613
|
+
enterEdit?(input?: Record<string, unknown>): Promise<void>;
|
|
1614
|
+
close?(input?: { reason?: string }): Promise<void>;
|
|
1615
|
+
confirmBeforeSave?(): Promise<boolean>;
|
|
1616
|
+
invokeHostAction?(input: { key: string }): Promise<void>;
|
|
1617
|
+
}
|
|
1618
|
+
|
|
1619
|
+
// ---- 表单结构 form-structure/1(JSON Schema 见 SDK schema/editor/form-structure@1.json)----
|
|
1620
|
+
// 编辑器无关:不含坐标、合并、列宽、sheetId、分区、页面设置。字段路径写作 `<table_code>/<field_code>`(主表 table_code 留空时写 main)。
|
|
1621
|
+
|
|
1622
|
+
export type FormStructureKind = 'plain' | 'detail' | 'report' | 'query';
|
|
1623
|
+
|
|
1624
|
+
export interface FormStructureField {
|
|
1625
|
+
field_id: string;
|
|
1626
|
+
field_code: string;
|
|
1627
|
+
field_name?: string;
|
|
1628
|
+
data_type: EditorFieldDataType;
|
|
1629
|
+
display_style?: string;
|
|
1630
|
+
sort_no?: number;
|
|
1631
|
+
group?: string;
|
|
1632
|
+
/** 主表字段上下归属:'' 编辑器自判 / upper 表头 / lower 表尾。 */
|
|
1633
|
+
region?: '' | 'upper' | 'lower';
|
|
1634
|
+
default_kind?: '' | 'manual' | 'auto_number' | 'system_var' | 'row_serial';
|
|
1635
|
+
derived?: boolean;
|
|
1636
|
+
control?: string;
|
|
1637
|
+
width_hint?: number;
|
|
1638
|
+
/** 宿主字段模型的必填(/1 内新增的可选键)。最终裁决仍是宿主保存时的必填校验。 */
|
|
1639
|
+
required?: boolean;
|
|
1640
|
+
/** 下拉 / 单选 / 多选的固定选项(宿主控件内联预设);label 空 = 同 value。 */
|
|
1641
|
+
options?: FormStructureOption[];
|
|
1642
|
+
/** 手填默认值文本(与宿主 default_value_text 同值;仅 default_kind 为空或 manual 时有意义)。 */
|
|
1643
|
+
default_value?: string;
|
|
1644
|
+
}
|
|
1645
|
+
|
|
1646
|
+
/** 表单结构里的一个固定选项(value 落库值,label 显示名)。 */
|
|
1647
|
+
export interface FormStructureOption {
|
|
1648
|
+
value: string;
|
|
1649
|
+
label?: string;
|
|
1650
|
+
}
|
|
1651
|
+
|
|
1652
|
+
export interface FormStructureTable {
|
|
1653
|
+
data_table_id: string;
|
|
1654
|
+
table_code?: string;
|
|
1655
|
+
table_name?: string;
|
|
1656
|
+
fields: FormStructureField[];
|
|
1657
|
+
}
|
|
1658
|
+
|
|
1659
|
+
export interface FormStructureDetailTable extends FormStructureTable {
|
|
1660
|
+
table_code: string;
|
|
1661
|
+
layout?: '' | 'vertical' | 'horizontal';
|
|
1662
|
+
placement?: '' | 'inline' | 'separate';
|
|
1663
|
+
/** 合计行要求和的本表字段 code。 */
|
|
1664
|
+
footer_totals?: string[];
|
|
1665
|
+
}
|
|
1666
|
+
|
|
1667
|
+
export interface FormStructureFilter {
|
|
1668
|
+
field_path: string;
|
|
1669
|
+
label?: string;
|
|
1670
|
+
operator?: 'eq' | 'neq' | 'lt' | 'lte' | 'gt' | 'gte' | 'like' | 'in' | 'between';
|
|
1671
|
+
}
|
|
1672
|
+
|
|
1673
|
+
export interface FormStructureButton {
|
|
1674
|
+
button_id: string;
|
|
1675
|
+
binding_id?: string;
|
|
1676
|
+
text: string;
|
|
1677
|
+
}
|
|
1678
|
+
|
|
1679
|
+
export interface FormStructureFormula {
|
|
1680
|
+
field_path: string;
|
|
1681
|
+
kind: 'expression' | 'arithmetic' | 'detail_sum' | 'total' | 'summary';
|
|
1682
|
+
expression?: string;
|
|
1683
|
+
operands?: Array<{ field_path?: string; constant?: number }>;
|
|
1684
|
+
operators?: Array<'add' | 'subtract' | 'multiply' | 'divide'>;
|
|
1685
|
+
source?: string;
|
|
1686
|
+
}
|
|
1687
|
+
|
|
1688
|
+
export interface FormStructurePalette {
|
|
1689
|
+
head: string;
|
|
1690
|
+
accent: string;
|
|
1691
|
+
tint: string;
|
|
1692
|
+
tint2: string;
|
|
1693
|
+
line: string;
|
|
1694
|
+
ink: string;
|
|
1695
|
+
mute: string;
|
|
1696
|
+
}
|
|
1697
|
+
|
|
1698
|
+
/** 表单结构 form-structure/1。 */
|
|
1699
|
+
export interface FormStructureV1 {
|
|
1700
|
+
schema: 'form-structure/1';
|
|
1701
|
+
kind: FormStructureKind;
|
|
1702
|
+
template_name?: string;
|
|
1703
|
+
locale?: string;
|
|
1704
|
+
main_table: FormStructureTable;
|
|
1705
|
+
details?: FormStructureDetailTable[];
|
|
1706
|
+
query?: { filters?: FormStructureFilter[]; result?: FormStructureDetailTable };
|
|
1707
|
+
buttons?: FormStructureButton[];
|
|
1708
|
+
formulas?: FormStructureFormula[];
|
|
1709
|
+
signs?: string[];
|
|
1710
|
+
notes?: string[];
|
|
1711
|
+
style?: { layout_hint?: string; palette_id?: string; palette?: FormStructurePalette };
|
|
1712
|
+
}
|
|
1713
|
+
|
|
1714
|
+
/** 可选档案 design-file.compose 的回执。 */
|
|
1715
|
+
export interface FormComposeResult {
|
|
1716
|
+
design_file: EditorDesignFile;
|
|
1717
|
+
self_check?: Array<{ code: string; severity: 'error' | 'warn' | 'info'; message: string; field_path?: string }>;
|
|
1718
|
+
/** 字段路径 → 编辑器内定位(anchor 不透明)。 */
|
|
1719
|
+
formula_refs?: Array<{ field_path: string; anchor: string }>;
|
|
1720
|
+
}
|