@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
|
@@ -0,0 +1,261 @@
|
|
|
1
|
+
// 登录页插件(page 类,slot auth.login)前端契约(定稿)。
|
|
2
|
+
// 覆盖:LoginPageProps / LoginMethod、AuthLoginHostBridge、各 kind 的 UI 义务与错误码词表;
|
|
3
|
+
// 使用说明见 SDK 第三方指南 docs/third-party/auth-and-hooks.md。
|
|
4
|
+
//
|
|
5
|
+
// 四者分工(务必牢记,决定本文件的类型边界):
|
|
6
|
+
// 登录页插件 ←(本文件 AuthLoginHostBridge,前端契约)→ 宿主 ←(auth.proto,后端契约)→ auth 插件
|
|
7
|
+
// 登录页插件与 auth 插件互不相识,唯一共享的知识是 6 个 kind 的交互形态词表(AuthKind)。
|
|
8
|
+
//
|
|
9
|
+
// 红线(写进类型注释供插件作者随手可见):
|
|
10
|
+
// 不持凭证 / 不知协议(providerCode 只能挑图标文案,禁止 if (providerCode==='dingtalk') 特殊协议逻辑)/
|
|
11
|
+
// 不调第三方 / 不建会话 / 不接触敏感配置(只拿得到 publicConfig 的 x-public 子集)。
|
|
12
|
+
|
|
13
|
+
import type { HostI18n } from '../i18n';
|
|
14
|
+
import type { SurfaceCreateInput, SurfaceMountResult } from '../surface';
|
|
15
|
+
import { definePluginSurface } from '../surface';
|
|
16
|
+
|
|
17
|
+
/** 登录交互形态词表(六 kind)。宿主按 methods[].kind 分组渲染,插件按 kind 画对应 UI。 */
|
|
18
|
+
export type AuthKind = 'password' | 'redirect' | 'qr' | 'otp' | 'challenge' | 'passkey';
|
|
19
|
+
|
|
20
|
+
/**
|
|
21
|
+
* 登录方式目录条目。
|
|
22
|
+
* 宿主已完成「插件声明的 supported_auth_kinds ∩ 实例启用的认证源」交集与敏感字段过滤,
|
|
23
|
+
* 插件拿到的即是可直接渲染的公开子集。
|
|
24
|
+
*/
|
|
25
|
+
export interface LoginMethod {
|
|
26
|
+
/** 认证源实例 ID —— bridge 各方法的 methodId/qrSessionId 之外的入参就是它。 */
|
|
27
|
+
id: string;
|
|
28
|
+
kind: AuthKind;
|
|
29
|
+
/** 'google' | 'oidc' | 'dingtalk' | ... 仅用于选内置图标/默认文案,禁止据此写协议分支逻辑。 */
|
|
30
|
+
providerCode?: string;
|
|
31
|
+
/** 已按当前 locale 解析好的展示名。 */
|
|
32
|
+
displayName: string;
|
|
33
|
+
logo?: string;
|
|
34
|
+
description?: string;
|
|
35
|
+
/** config 的 x-public 字段子集,只用于样式/品牌展示,不含 client_id/secret 等敏感字段。 */
|
|
36
|
+
publicConfig?: Record<string, unknown>;
|
|
37
|
+
}
|
|
38
|
+
|
|
39
|
+
/** 登录页顶层数据输入,由宿主经 SurfaceCreateInput.props 注入。 */
|
|
40
|
+
export interface LoginPageProps {
|
|
41
|
+
/** 登录方式目录;为空数组时插件需展示"暂无可用登录方式,请联系管理员",不得白屏。 */
|
|
42
|
+
methods: LoginMethod[];
|
|
43
|
+
/** 初始是否需要验证码;运行中还会由 AUTH_NEED_CAPTCHA 错误码动态触发。 */
|
|
44
|
+
captcha: { required: boolean };
|
|
45
|
+
/** 改密续步表单的即时强度提示(三期后有);仅 UX 提示,权威校验永远在宿主。 */
|
|
46
|
+
passwordRuleHint?: {
|
|
47
|
+
minLength?: number;
|
|
48
|
+
requireClasses?: number;
|
|
49
|
+
};
|
|
50
|
+
/** 品牌公开配置(来自认证源/实例配置的 x-public 子集);缺省插件应有默认视觉,不得硬编码品牌资产。 */
|
|
51
|
+
brand?: {
|
|
52
|
+
logo?: string;
|
|
53
|
+
background?: string;
|
|
54
|
+
slogan?: string;
|
|
55
|
+
};
|
|
56
|
+
/**
|
|
57
|
+
* 当前登录页插件自身配置中标记为公开的字段(login-bootstrap 的 login_page.public_config 原样透传),
|
|
58
|
+
* 含义由登录页插件自己解释(如样式、标语);宿主不认识其中的枚举值。缺省或空对象时插件按默认外观渲染。
|
|
59
|
+
*/
|
|
60
|
+
pageConfig?: Record<string, unknown>;
|
|
61
|
+
/**
|
|
62
|
+
* 宿主记住的登录名(安全设置「登录行为策略」的记住用户名开关开、且本浏览器记住过时才下发)。
|
|
63
|
+
* 插件只用它预填用户名输入框(用户已输入时不覆盖),不得自行写本地存储:登录名在 login()
|
|
64
|
+
* 凭证校验通过后由宿主保存,开关关闭时由宿主清除。缺省表示不预填。
|
|
65
|
+
*/
|
|
66
|
+
rememberedUsername?: string;
|
|
67
|
+
}
|
|
68
|
+
|
|
69
|
+
/**
|
|
70
|
+
* login()/verifyOtp()/answerChallenge() 的统一返回结构。
|
|
71
|
+
* ok:true → 宿主已建会话,插件调 redirectFromLogin() 进系统。
|
|
72
|
+
* ok:false → errorCode 按 AUTH_ERROR_CODES 词表映射 UI 行为。
|
|
73
|
+
* challenge 存在时 → 既不算失败也不算成功,切换到对应续步 UI。
|
|
74
|
+
*/
|
|
75
|
+
export interface LoginOutcome {
|
|
76
|
+
ok: boolean;
|
|
77
|
+
errorCode?: AuthErrorCode | (string & {});
|
|
78
|
+
challenge?: {
|
|
79
|
+
type: string;
|
|
80
|
+
challengeToken: string;
|
|
81
|
+
};
|
|
82
|
+
}
|
|
83
|
+
|
|
84
|
+
/**
|
|
85
|
+
* 登录页能收到的宿主错误码词表(login() / verifyOtp() / answerChallenge() 等的 errorCode,与宿主登录接口
|
|
86
|
+
* 对外返回的码一致;v1.1.0-tp.19 按宿主实际对外码核定)。
|
|
87
|
+
* 用 const + 联合类型(而非纯 enum)落地:既给插件作者类型安全的枚举提示,
|
|
88
|
+
* 又保留 `(string & {})` 兜底位——宿主未来新增错误码时插件不会因联合类型收窄而编译失败,
|
|
89
|
+
* 只是失去该新 code 的类型提示,运行时仍走"未知 code → 通用失败文案 + log('warn', ...)"分支。
|
|
90
|
+
*
|
|
91
|
+
* 注意:认证插件后端(Authenticate 等)返回给宿主的是 proto 冻结的标准码闭集(如 AUTH_ACCOUNT_DISABLED、
|
|
92
|
+
* AUTH_USER_NOT_FOUND),宿主会翻译后再交给登录页(停用 → AUTH_USER_DISABLED,用户不存在 → 并入
|
|
93
|
+
* AUTH_INVALID_CREDENTIALS),所以那几个插件侧码不在本词表里。
|
|
94
|
+
*/
|
|
95
|
+
export const AUTH_ERROR_CODES = [
|
|
96
|
+
/** 凭证错误(密码错 / 验证码错或过期);宿主已合并"用户不存在"防枚举,UI 不做区分。 */
|
|
97
|
+
'AUTH_INVALID_CREDENTIALS',
|
|
98
|
+
/** 账户被停用(本地停用,或认证插件报告上游停用)。 */
|
|
99
|
+
'AUTH_USER_DISABLED',
|
|
100
|
+
/** kimpo 登录行为策略锁定(失败次数过多,临时锁定)。 */
|
|
101
|
+
'AUTH_ACCOUNT_LOCKED',
|
|
102
|
+
/** 账户在企业目录等上游被锁定,需与 AUTH_ACCOUNT_LOCKED 可区分展示。 */
|
|
103
|
+
'AUTH_ACCOUNT_LOCKED_UPSTREAM',
|
|
104
|
+
/** 密码已在上游过期:引导去认证源改密。 */
|
|
105
|
+
'AUTH_PASSWORD_EXPIRED',
|
|
106
|
+
/** 上游要求先改密、宿主无法代改:引导去认证源改密(可改密的场景走 challenge 续步)。 */
|
|
107
|
+
'AUTH_MUST_CHANGE_PASSWORD',
|
|
108
|
+
/** 需要验证码:显示 captcha 区并自动 refreshCaptcha()。 */
|
|
109
|
+
'AUTH_NEED_CAPTCHA',
|
|
110
|
+
/** 验证码错误:提示 + 自动刷新验证码。 */
|
|
111
|
+
'AUTH_CAPTCHA_INVALID',
|
|
112
|
+
/** 续步令牌(challengeToken)无效或已过期:回到第一步重新登录。 */
|
|
113
|
+
'AUTH_CHALLENGE_INVALID',
|
|
114
|
+
/** 改密续步:新密码不满足复杂度要求。 */
|
|
115
|
+
'AUTH_PASSWORD_COMPLEXITY',
|
|
116
|
+
/** 改密续步:新密码与当前或近期密码相同。 */
|
|
117
|
+
'AUTH_PASSWORD_HISTORY',
|
|
118
|
+
/** 改密续步:该账户密码由外部系统管理,宿主不能改。 */
|
|
119
|
+
'AUTH_PASSWORD_CHANGE_UNSUPPORTED',
|
|
120
|
+
/** 上游不可达(LDAP 连不上 / IdP 超时 / 网络错)。 */
|
|
121
|
+
'AUTH_UPSTREAM_UNAVAILABLE',
|
|
122
|
+
/** 外部身份无预建账户且首次登录建号关闭。 */
|
|
123
|
+
'AUTH_NO_ACCOUNT_JIT_DISABLED',
|
|
124
|
+
/** state 校验失败:提示登录会话已失效,重新发起。 */
|
|
125
|
+
'AUTH_STATE_MISMATCH',
|
|
126
|
+
/** 登录方式不存在或未启用(methodId 失效):刷新登录方式目录。 */
|
|
127
|
+
'AUTH_METHOD_NOT_FOUND',
|
|
128
|
+
/** 该登录方式不支持所请求的交互形态(如对 redirect 方式调 login())。 */
|
|
129
|
+
'AUTH_METHOD_KIND_UNSUPPORTED',
|
|
130
|
+
/** 二维码会话不存在或已过期:qr 状态机进 expired,重新取码。 */
|
|
131
|
+
'AUTH_QR_SESSION_NOT_FOUND',
|
|
132
|
+
/** 验证码登录未启用。 */
|
|
133
|
+
'AUTH_OTP_NOT_ENABLED',
|
|
134
|
+
/** 验证码短信发送失败:稍后重试。 */
|
|
135
|
+
'AUTH_OTP_SMS_FAILED',
|
|
136
|
+
/** 限频:提示操作过于频繁(发码限频也归到这个码,见 sendOtp 的 retryAfter)。 */
|
|
137
|
+
'AUTH_RATE_LIMITED',
|
|
138
|
+
/** 登录前钩子(auth.before_login)拒绝本次登录:只给通用文案,插件原因不回前端。 */
|
|
139
|
+
'AUTH_LOGIN_HOOK_REJECTED',
|
|
140
|
+
/** 本机授权尚未激活。 */
|
|
141
|
+
'AUTH_LICENSE_NOT_ACTIVATED',
|
|
142
|
+
/** 授权进入最终宽限期,仅系统管理员可登录。 */
|
|
143
|
+
'AUTH_LICENSE_FINAL_GRACE_ADMIN_ONLY',
|
|
144
|
+
/** 授权状态异常,禁止登录。 */
|
|
145
|
+
'AUTH_LICENSE_LOGIN_BLOCKED',
|
|
146
|
+
/** 在线用户数已达授权上限。 */
|
|
147
|
+
'AUTH_LICENSE_SEAT_FULL',
|
|
148
|
+
/** 授权校验服务暂不可达:稍后重试。 */
|
|
149
|
+
'AUTH_LICENSE_ARBITER_UNAVAILABLE'
|
|
150
|
+
] as const;
|
|
151
|
+
|
|
152
|
+
/** AUTH_ERROR_CODES 的类型投影,供 LoginOutcome.errorCode 等字段做类型安全消费。 */
|
|
153
|
+
export type AuthErrorCode = (typeof AUTH_ERROR_CODES)[number];
|
|
154
|
+
|
|
155
|
+
/**
|
|
156
|
+
* AuthLoginHostBridge —— 宿主注入给登录页插件的能力面(冻结契约)。
|
|
157
|
+
* 由宿主实现并经 SurfaceCreateInput.hostBridge 注入;所有方法保证真实可执行,
|
|
158
|
+
* 不存在"想象中的端点"。插件不得自行拼接 URL 绕过 bridge 直接发请求( 红线③)。
|
|
159
|
+
*/
|
|
160
|
+
export interface AuthLoginHostBridge {
|
|
161
|
+
// —— password kind ——
|
|
162
|
+
/** 提交账密登录;密码只在此调用瞬间经桥传给宿主,不落任何本地存储( 红线①)。 */
|
|
163
|
+
login(input: {
|
|
164
|
+
loginName: string;
|
|
165
|
+
password: string;
|
|
166
|
+
captchaId?: string;
|
|
167
|
+
captchaCode?: string;
|
|
168
|
+
/**
|
|
169
|
+
* 所选登录方式目录条目 id(宿主本地为 `local`)。只有一种 password 方式时可省略;
|
|
170
|
+
* 多种时由用户选择后传入,宿主按它定向认证并校验其可用。
|
|
171
|
+
*/
|
|
172
|
+
methodId?: string;
|
|
173
|
+
}): Promise<LoginOutcome>;
|
|
174
|
+
|
|
175
|
+
// —— redirect kind ——
|
|
176
|
+
/**
|
|
177
|
+
* 发起 SSO 跳转;宿主拉取 login_url 后整页跳转。
|
|
178
|
+
* 正常情况下本 Promise 不会 resolve(页面已离开);失败(上游不可用等)时 reject,errorCode 见 AUTH_ERROR_CODES。
|
|
179
|
+
*/
|
|
180
|
+
startRedirect(methodId: string): Promise<void>;
|
|
181
|
+
|
|
182
|
+
// —— qr kind ——
|
|
183
|
+
/** 创建二维码会话;返回 embedUrl 则渲染 iframe,返回 qrContent 则用 SDK QrCodeRenderer 自绘(二选一)。 */
|
|
184
|
+
createQr(methodId: string): Promise<{
|
|
185
|
+
qrSessionId: string;
|
|
186
|
+
/** 与 embedUrl 二选一:自渲染内容,交给 QrCodeRenderer。 */
|
|
187
|
+
qrContent?: string;
|
|
188
|
+
/** 二选一:第三方官方 iframe 地址。 */
|
|
189
|
+
embedUrl?: string;
|
|
190
|
+
/** 二维码有效期,单位秒。 */
|
|
191
|
+
expiresIn: number;
|
|
192
|
+
}>;
|
|
193
|
+
/** 轮询二维码状态;loggedIn:true 表示宿主已在本响应种下会话 cookie。 */
|
|
194
|
+
pollQr(qrSessionId: string): Promise<{
|
|
195
|
+
status: 'pending' | 'scanned' | 'confirmed' | 'expired';
|
|
196
|
+
loggedIn: boolean;
|
|
197
|
+
}>;
|
|
198
|
+
|
|
199
|
+
// —— otp kind(契约已定,实现推后至五期)——
|
|
200
|
+
sendOtp(methodId: string, identifier: string): Promise<{ retryAfter: number }>;
|
|
201
|
+
verifyOtp(methodId: string, identifier: string, code: string): Promise<LoginOutcome>;
|
|
202
|
+
|
|
203
|
+
// —— challenge 续步——
|
|
204
|
+
answerChallenge(input: {
|
|
205
|
+
challengeToken: string;
|
|
206
|
+
/** 首个 challenge 类型;MFA 等类型五期扩展,未识别类型插件应提示"当前登录页版本不支持"。 */
|
|
207
|
+
type: 'password_change';
|
|
208
|
+
newPassword?: string;
|
|
209
|
+
oldPassword?: string;
|
|
210
|
+
}): Promise<LoginOutcome>;
|
|
211
|
+
|
|
212
|
+
// —— 辅助 ——
|
|
213
|
+
refreshCaptcha(): Promise<{ captchaId: string; imageBase64: string }>;
|
|
214
|
+
/** 登录完成后由插件调用(或宿主在 loggedIn 后自动调,实施后校准)进入系统。 */
|
|
215
|
+
redirectFromLogin(): void;
|
|
216
|
+
message: {
|
|
217
|
+
success(m: string): void;
|
|
218
|
+
error(m: string): void;
|
|
219
|
+
info(m: string): void;
|
|
220
|
+
};
|
|
221
|
+
/** 复用现有宿主 i18n 能力,不自建语言探测。 */
|
|
222
|
+
i18n: HostI18n;
|
|
223
|
+
/**
|
|
224
|
+
* 日志上报进宿主日志中心;宿主 bridge 层做脱敏兜底,但插件自身必须先保证:
|
|
225
|
+
* 日志参数里永不出现密码、captcha 答案、challengeToken 原文。
|
|
226
|
+
*/
|
|
227
|
+
log(level: 'debug' | 'info' | 'warn' | 'error', message: string, fields?: Record<string, unknown>): void;
|
|
228
|
+
}
|
|
229
|
+
|
|
230
|
+
/**
|
|
231
|
+
* 登录页 surface 的强类型 createSurface 输入。
|
|
232
|
+
* 与通用 SurfaceCreateInput(surface.ts)结构一致,仅将 props/hostBridge 收窄为
|
|
233
|
+
* LoginPageProps/AuthLoginHostBridge 具体类型,供 definePluginLoginSurface 做类型推导。
|
|
234
|
+
* 登录页 surface 在 manifest 里声明为 `{ type: "page-slot", slot: "auth.login" }`,
|
|
235
|
+
* 故 surfaceType 固定为 'page-slot'(SurfaceType 中的 'login-form' 是未启用的历史取值,登录页插件不使用该类型)。
|
|
236
|
+
*/
|
|
237
|
+
export interface LoginSurfaceCreateInput extends Omit<SurfaceCreateInput, 'props' | 'hostBridge' | 'surfaceType'> {
|
|
238
|
+
surfaceType: 'page-slot';
|
|
239
|
+
props: LoginPageProps;
|
|
240
|
+
hostBridge: AuthLoginHostBridge;
|
|
241
|
+
}
|
|
242
|
+
|
|
243
|
+
/**
|
|
244
|
+
* definePluginLoginSurface —— 登录页版的 definePluginSurface:给插件作者收敛 createSurface 到登录页类型
|
|
245
|
+
* (props/hostBridge 强类型化),返回值签名与宿主实际调用的 `(input: SurfaceCreateInput) => SurfaceMountResult`
|
|
246
|
+
* 保持一致。同源档里只做类型收窄;在宿主沙箱框架里(第三方插件恒为沙箱档)经 definePluginSurface 登记工厂并
|
|
247
|
+
* 启动框架运行时——否则 bundle 不会响应宿主握手,登录页约 15 秒后被判加载失败。
|
|
248
|
+
* 沙箱档下 hostBridge 的方法一律返回 Promise(`redirectFromLogin()`、`message.success()` 等也一样),请 await。
|
|
249
|
+
*
|
|
250
|
+
* @example
|
|
251
|
+
* ```ts
|
|
252
|
+
* export const createSurface = definePluginLoginSurface((input) => {
|
|
253
|
+
* return { component: LoginPage, props: input.props };
|
|
254
|
+
* });
|
|
255
|
+
* ```
|
|
256
|
+
*/
|
|
257
|
+
export function definePluginLoginSurface(
|
|
258
|
+
factory: (input: LoginSurfaceCreateInput) => SurfaceMountResult
|
|
259
|
+
): (input: SurfaceCreateInput) => SurfaceMountResult {
|
|
260
|
+
return definePluginSurface((input: SurfaceCreateInput): SurfaceMountResult => factory(input as unknown as LoginSurfaceCreateInput));
|
|
261
|
+
}
|