@officesdk/editor-sdk-core 0.0.0-14 → 0.0.0-16
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/cjs/docx/index.js +1 -1
- package/cjs/docx/menu.js +1 -1
- package/cjs/docx/sdk.js +1 -1
- package/cjs/docx/theme.js +1 -1
- package/cjs/docx/toolbar.js +3 -0
- package/cjs/presentation/export.js +14 -0
- package/cjs/presentation/index.js +4 -2
- package/cjs/presentation/sdk.js +1 -1
- package/cjs/shared/attachment.js +1 -1
- package/cjs/shared/checkpoints.js +19 -0
- package/cjs/shared/collaboration.js +3 -0
- package/cjs/shared/collaborators.js +3 -0
- package/cjs/shared/comments.js +1 -1
- package/cjs/shared/decryption.js +3 -0
- package/cjs/shared/download.js +3 -0
- package/cjs/shared/editor.js +1 -1
- package/cjs/shared/export.js +1 -1
- package/cjs/shared/feature.js +3 -0
- package/cjs/shared/file-picker.js +1 -1
- package/cjs/shared/file.js +50 -0
- package/cjs/shared/follow-mode.js +3 -0
- package/cjs/shared/history.js +3 -0
- package/cjs/shared/index.js +1 -1
- package/cjs/shared/link.js +1 -1
- package/cjs/shared/mention.js +3 -0
- package/cjs/shared/menu.js +1 -1
- package/cjs/shared/performance.js +3 -0
- package/cjs/shared/print.js +1 -1
- package/cjs/shared/render.js +3 -0
- package/cjs/shared/tool-box.js +40 -0
- package/cjs/shared/toolbar.js +1 -1
- package/cjs/shared/ui.js +18 -0
- package/cjs/shared/version.js +3 -0
- package/cjs/sheet/cell.js +29 -1
- package/cjs/sheet/chart.js +3 -0
- package/cjs/sheet/checklist.js +3 -0
- package/cjs/sheet/combine-sheets.js +3 -0
- package/cjs/sheet/comments.js +3 -0
- package/cjs/sheet/data-transfer.js +3 -0
- package/cjs/sheet/export.js +3 -0
- package/cjs/sheet/font.js +3 -0
- package/cjs/sheet/form.js +3 -0
- package/cjs/sheet/import-formula.js +3 -0
- package/cjs/sheet/index.js +4 -2
- package/cjs/sheet/lock.js +14 -0
- package/cjs/sheet/mention.js +13 -0
- package/cjs/sheet/range.js +1 -1
- package/cjs/sheet/render.js +3 -0
- package/cjs/sheet/sdk.js +1 -1
- package/cjs/sheet/sensitization.js +3 -0
- package/cjs/sheet/sheet2table.js +3 -0
- package/cjs/sheet/worksheet.js +1 -1
- package/cjs/table/sdk.js +1 -1
- package/esm/docx/index.js +1 -1
- package/esm/docx/menu.js +1 -1
- package/esm/docx/sdk.js +1 -1
- package/esm/docx/theme.js +1 -1
- package/esm/docx/toolbar.js +2 -0
- package/esm/presentation/export.js +11 -0
- package/esm/presentation/index.js +2 -1
- package/esm/presentation/sdk.js +1 -1
- package/esm/shared/attachment.js +1 -1
- package/esm/shared/checkpoints.js +16 -0
- package/esm/shared/collaboration.js +2 -0
- package/esm/shared/collaborators.js +2 -0
- package/esm/shared/comments.js +1 -1
- package/esm/shared/decryption.js +2 -0
- package/esm/shared/download.js +2 -0
- package/esm/shared/editor.js +1 -1
- package/esm/shared/export.js +1 -1
- package/esm/shared/feature.js +2 -0
- package/esm/shared/file-picker.js +1 -1
- package/esm/shared/file.js +47 -0
- package/esm/shared/follow-mode.js +2 -0
- package/esm/shared/history.js +2 -0
- package/esm/shared/index.js +1 -1
- package/esm/shared/link.js +1 -1
- package/esm/shared/mention.js +2 -0
- package/esm/shared/menu.js +1 -1
- package/esm/shared/performance.js +2 -0
- package/esm/shared/print.js +1 -1
- package/esm/shared/render.js +2 -0
- package/esm/shared/tool-box.js +37 -0
- package/esm/shared/toolbar.js +1 -1
- package/esm/shared/ui.js +15 -0
- package/esm/shared/version.js +2 -0
- package/esm/sheet/cell.js +28 -2
- package/esm/sheet/chart.js +2 -0
- package/esm/sheet/checklist.js +2 -0
- package/esm/sheet/combine-sheets.js +2 -0
- package/esm/sheet/comments.js +2 -0
- package/esm/sheet/data-transfer.js +2 -0
- package/esm/sheet/export.js +2 -0
- package/esm/sheet/font.js +2 -0
- package/esm/sheet/form.js +2 -0
- package/esm/sheet/import-formula.js +2 -0
- package/esm/sheet/index.js +2 -1
- package/esm/sheet/lock.js +11 -0
- package/esm/sheet/mention.js +10 -0
- package/esm/sheet/range.js +1 -1
- package/esm/sheet/render.js +2 -0
- package/esm/sheet/sdk.js +1 -1
- package/esm/sheet/sensitization.js +2 -0
- package/esm/sheet/sheet2table.js +2 -0
- package/esm/sheet/worksheet.js +1 -1
- package/esm/table/sdk.js +1 -1
- package/package.json +1 -1
- package/types/diagram.d.ts +769 -41
- package/types/docs.d.ts +769 -41
- package/types/docx.d.ts +878 -43
- package/types/pdf.d.ts +769 -41
- package/types/presentation.d.ts +783 -41
- package/types/shared.d.ts +769 -41
- package/types/sheet.d.ts +1238 -76
- package/types/table.d.ts +781 -48
package/types/presentation.d.ts
CHANGED
|
@@ -30,6 +30,10 @@ export declare abstract class AbstractedPresentationSDK extends EditorSDK {
|
|
|
30
30
|
* 打印幻灯片
|
|
31
31
|
*/
|
|
32
32
|
abstract print(): Promise<void>;
|
|
33
|
+
/**
|
|
34
|
+
* 导出
|
|
35
|
+
*/
|
|
36
|
+
abstract export(type: PresentationExportType): Promise<void>;
|
|
33
37
|
/**
|
|
34
38
|
* 幻灯片集合接口
|
|
35
39
|
*/
|
|
@@ -49,6 +53,43 @@ export declare abstract class AbstractedPresentationSDK extends EditorSDK {
|
|
|
49
53
|
abstract get text(): PresentationText;
|
|
50
54
|
}
|
|
51
55
|
|
|
56
|
+
export declare type CheckLimitationResult = {
|
|
57
|
+
status: 'limited';
|
|
58
|
+
/**
|
|
59
|
+
* 被限制原因
|
|
60
|
+
*/
|
|
61
|
+
reason?: string;
|
|
62
|
+
} | {
|
|
63
|
+
status: 'unlimited';
|
|
64
|
+
};
|
|
65
|
+
|
|
66
|
+
/**
|
|
67
|
+
* 协作者信息接口
|
|
68
|
+
*/
|
|
69
|
+
export declare interface CollaboratorInfo {
|
|
70
|
+
/** 协作者唯一标识 */
|
|
71
|
+
id: number;
|
|
72
|
+
/** 协作者名称 */
|
|
73
|
+
name: string;
|
|
74
|
+
/** 协作者头像URL */
|
|
75
|
+
avatar: string;
|
|
76
|
+
}
|
|
77
|
+
|
|
78
|
+
export declare interface ConfirmButtonConfig {
|
|
79
|
+
/**
|
|
80
|
+
* 按钮文本
|
|
81
|
+
*/
|
|
82
|
+
label?: string;
|
|
83
|
+
/**
|
|
84
|
+
* 是否隐藏
|
|
85
|
+
*/
|
|
86
|
+
hidden?: boolean;
|
|
87
|
+
/**
|
|
88
|
+
* 按钮点击回调
|
|
89
|
+
*/
|
|
90
|
+
onClick?: () => void;
|
|
91
|
+
}
|
|
92
|
+
|
|
52
93
|
/**
|
|
53
94
|
* 匿名用户信息
|
|
54
95
|
* 当前用户信息未知时的缺省值
|
|
@@ -195,8 +236,9 @@ export declare interface EditorAttachmentMaxSizeOptions {
|
|
|
195
236
|
* 编辑器附件信息
|
|
196
237
|
*/
|
|
197
238
|
export declare interface EditorAttachmentOptions {
|
|
198
|
-
|
|
199
|
-
|
|
239
|
+
picker?: EditorFilePicker;
|
|
240
|
+
uploader?: AbstractedEditorFileUploader;
|
|
241
|
+
download?: (url: string) => void;
|
|
200
242
|
/**
|
|
201
243
|
* 图片附件相关配置
|
|
202
244
|
*/
|
|
@@ -270,6 +312,80 @@ export declare interface EditorBrandOptions {
|
|
|
270
312
|
};
|
|
271
313
|
}
|
|
272
314
|
|
|
315
|
+
export declare interface EditorCheckpointsOptions {
|
|
316
|
+
/**
|
|
317
|
+
* 获取功能卡点限制
|
|
318
|
+
* undefined代表无限制
|
|
319
|
+
*/
|
|
320
|
+
getFeatureLimitation?: (key: string) => Limitation | undefined;
|
|
321
|
+
/**
|
|
322
|
+
* 检查是否超限
|
|
323
|
+
* @param key 功能卡点key
|
|
324
|
+
* @param value 功能卡点检查值,如文件大小/行列数量等
|
|
325
|
+
*/
|
|
326
|
+
checkFeatureLimitation?: (key: string, value: number) => CheckLimitationResult;
|
|
327
|
+
/**
|
|
328
|
+
* 获取功能卡点状态,如某功能入口是否开启
|
|
329
|
+
*/
|
|
330
|
+
getFeatureStatus?: (key: string) => FeatureStatus;
|
|
331
|
+
}
|
|
332
|
+
|
|
333
|
+
export declare interface EditorCollaborationOptions {
|
|
334
|
+
/**
|
|
335
|
+
* 是否允许离线编辑
|
|
336
|
+
*/
|
|
337
|
+
offlineEditable: boolean;
|
|
338
|
+
/**
|
|
339
|
+
* 保存状态外部接口委托
|
|
340
|
+
*/
|
|
341
|
+
saveStatus: SaveStatusDelegation;
|
|
342
|
+
/**
|
|
343
|
+
* 同步状态外部接口委托(部分套件不支持离线编辑)
|
|
344
|
+
*/
|
|
345
|
+
syncStatus?: SyncStatusDelegation;
|
|
346
|
+
/**
|
|
347
|
+
* 是否使用严格的长度校验规则,默认关闭,在开启后如果出现长度校验失败会立刻禁止编辑器继续编写,并将保存状态设置为错误状态
|
|
348
|
+
*/
|
|
349
|
+
strictCLC?: boolean;
|
|
350
|
+
}
|
|
351
|
+
|
|
352
|
+
/**
|
|
353
|
+
* 编辑器协作者管理接口
|
|
354
|
+
*/
|
|
355
|
+
export declare interface EditorCollaborators {
|
|
356
|
+
/**
|
|
357
|
+
* 获取当前所有协作者列表
|
|
358
|
+
* @returns 返回所有协作者信息数组
|
|
359
|
+
*/
|
|
360
|
+
getCollaborators: () => CollaboratorInfo[];
|
|
361
|
+
/**
|
|
362
|
+
* 开始监听协作者状态变化
|
|
363
|
+
* 调用此方法后,将开始接收协作者进入/离开的事件
|
|
364
|
+
*/
|
|
365
|
+
start: () => void;
|
|
366
|
+
/**
|
|
367
|
+
* 停止监听协作者状态变化
|
|
368
|
+
* 调用此方法后,将不再接收协作者进入/离开的事件
|
|
369
|
+
*/
|
|
370
|
+
stop: () => void;
|
|
371
|
+
/**
|
|
372
|
+
* 添加协作者进入事件监听器
|
|
373
|
+
* @param listener - 监听器回调函数,参数如下:
|
|
374
|
+
* - allUsers: 当前所有协作者列表
|
|
375
|
+
* - enteredUsers: 新进入的协作者列表
|
|
376
|
+
* @returns 返回一个函数,调用该函数可以移除监听器
|
|
377
|
+
*/
|
|
378
|
+
addUserEnterListener: (listener: (allUsers: CollaboratorInfo[], enteredUsers: CollaboratorInfo[]) => void) => () => void;
|
|
379
|
+
/**
|
|
380
|
+
* 添加协作者离开事件监听器
|
|
381
|
+
* @param listener - 监听器回调函数
|
|
382
|
+
* - allUsers: 当前所有协作者列表
|
|
383
|
+
* - leftUsers: 离开的协作者列表
|
|
384
|
+
* @returns 返回一个函数,调用该函数可以移除监听器
|
|
385
|
+
*/
|
|
386
|
+
addUserLeaveListener: (listener: (allUsers: CollaboratorInfo[], leftUsers: CollaboratorInfo[]) => void) => () => void;
|
|
387
|
+
}
|
|
388
|
+
|
|
273
389
|
/**
|
|
274
390
|
* 单条评论数据
|
|
275
391
|
*/
|
|
@@ -336,7 +452,7 @@ export declare interface EditorComments {
|
|
|
336
452
|
/**
|
|
337
453
|
* 编辑器评论初始化配置
|
|
338
454
|
*/
|
|
339
|
-
export declare interface EditorCommentsOptions {
|
|
455
|
+
export declare interface EditorCommentsOptions extends EditorFeatureConfig {
|
|
340
456
|
/**
|
|
341
457
|
* 评论作者信息,如果这里的信息为空,将会使用 user 信息
|
|
342
458
|
*/
|
|
@@ -365,6 +481,12 @@ export declare interface EditorCommentsOptions {
|
|
|
365
481
|
*/
|
|
366
482
|
mode: 'none' | 'card';
|
|
367
483
|
};
|
|
484
|
+
/**
|
|
485
|
+
* 评论变化监听
|
|
486
|
+
* @param listener
|
|
487
|
+
* @returns 返回一个函数,调用该函数可以移除监听器
|
|
488
|
+
*/
|
|
489
|
+
addChangedListener?: (listener: (type: 'create' | 'update' | 'close', data: EditorCommentItem) => void) => () => void;
|
|
368
490
|
}
|
|
369
491
|
|
|
370
492
|
export declare interface EditorContent<Delta = EditorDelta> {
|
|
@@ -390,6 +512,19 @@ export declare interface EditorContent<Delta = EditorDelta> {
|
|
|
390
512
|
*/
|
|
391
513
|
export declare type EditorContextMenuOptions<TName extends string> = EditorMenuOptions<TName>;
|
|
392
514
|
|
|
515
|
+
/**
|
|
516
|
+
* 编辑器解密选项接口
|
|
517
|
+
* 用于配置编辑器中需要解密的内容的相关选项
|
|
518
|
+
*/
|
|
519
|
+
export declare interface EditorDecryptionOptions {
|
|
520
|
+
/**
|
|
521
|
+
* 图片附件解密函数
|
|
522
|
+
* @param buffer - 需要解密的二进制数据
|
|
523
|
+
* @returns 解密后的二进制数据
|
|
524
|
+
*/
|
|
525
|
+
decrypt?: (buffer: ArrayBuffer) => ArrayBuffer;
|
|
526
|
+
}
|
|
527
|
+
|
|
393
528
|
export declare interface EditorDelta {
|
|
394
529
|
compose: (other: EditorDelta, isDocument?: boolean) => EditorDelta;
|
|
395
530
|
transform: (other: EditorDelta, priority?: boolean) => EditorDelta;
|
|
@@ -449,16 +584,81 @@ export declare interface EditorEmbeddedObjectOptions {
|
|
|
449
584
|
export declare interface EditorExportOptions {
|
|
450
585
|
/**
|
|
451
586
|
* 可导出类型
|
|
452
|
-
* @description
|
|
453
587
|
*/
|
|
454
588
|
supportedTypes?: string[];
|
|
455
589
|
/**
|
|
456
590
|
* 导出文件
|
|
457
|
-
* @description
|
|
458
591
|
*/
|
|
459
592
|
exportFile: (type: string) => Promise<void>;
|
|
460
593
|
}
|
|
461
594
|
|
|
595
|
+
export declare interface EditorFeatureConfig {
|
|
596
|
+
/**
|
|
597
|
+
* 功能是否被禁用(入口还在)
|
|
598
|
+
*/
|
|
599
|
+
disabled?: boolean;
|
|
600
|
+
/**
|
|
601
|
+
* 功能入口是否被隐藏
|
|
602
|
+
*/
|
|
603
|
+
hidden?: boolean;
|
|
604
|
+
}
|
|
605
|
+
|
|
606
|
+
export declare interface EditorFileOptions {
|
|
607
|
+
/**
|
|
608
|
+
* 文件guid
|
|
609
|
+
*/
|
|
610
|
+
guid: string;
|
|
611
|
+
/**
|
|
612
|
+
* 文件名
|
|
613
|
+
*/
|
|
614
|
+
name?: string;
|
|
615
|
+
}
|
|
616
|
+
|
|
617
|
+
export declare interface EditorFilePicker {
|
|
618
|
+
open: (option: EditorFilePickerOpenOptions) => Promise<EditorPickedFile[]>;
|
|
619
|
+
}
|
|
620
|
+
|
|
621
|
+
export declare interface EditorFilePickerOpenOptions {
|
|
622
|
+
mimeTypes?: string[];
|
|
623
|
+
maxSize?: number;
|
|
624
|
+
extensions?: string[];
|
|
625
|
+
multiple?: boolean;
|
|
626
|
+
directory?: boolean;
|
|
627
|
+
}
|
|
628
|
+
|
|
629
|
+
export declare interface EditorFollowMode {
|
|
630
|
+
/**
|
|
631
|
+
* 演讲者/跟随者进入跟随模式
|
|
632
|
+
* 当演讲者调用此方法时,其他用户将可以开始跟随该演讲者
|
|
633
|
+
*/
|
|
634
|
+
enter: () => void;
|
|
635
|
+
/**
|
|
636
|
+
* 当前是否处于跟随模式
|
|
637
|
+
* @returns 返回布尔值,true表示正在跟随,false表示未在跟随
|
|
638
|
+
*/
|
|
639
|
+
isFollowModeActive: () => boolean;
|
|
640
|
+
/**
|
|
641
|
+
* 获取当前演讲者信息
|
|
642
|
+
* @returns 返回包含演讲者ID、姓名和头像信息的对象
|
|
643
|
+
*/
|
|
644
|
+
getSpeaker: () => Speaker;
|
|
645
|
+
/**
|
|
646
|
+
* 添加跟随状态变化的监听器
|
|
647
|
+
* @param listener 状态变化时的回调函数
|
|
648
|
+
* @returns 返回一个用于移除监听器的函数
|
|
649
|
+
*/
|
|
650
|
+
addChangedListener: (listener: () => void) => () => void;
|
|
651
|
+
}
|
|
652
|
+
|
|
653
|
+
export declare interface EditorFollowModeOptions extends EditorFeatureConfig {
|
|
654
|
+
/**
|
|
655
|
+
* 推送跟随消息的 socket 对象
|
|
656
|
+
* 实际类型为socketIO.client
|
|
657
|
+
* TODO: 抽象为接口
|
|
658
|
+
*/
|
|
659
|
+
socket?: unknown;
|
|
660
|
+
}
|
|
661
|
+
|
|
462
662
|
export declare interface EditorFontFace {
|
|
463
663
|
/**
|
|
464
664
|
* 字体的名称,用于在用户界面上显示的名称
|
|
@@ -537,6 +737,19 @@ export declare interface EditorFontsOptions {
|
|
|
537
737
|
list: EditorFontsList;
|
|
538
738
|
}
|
|
539
739
|
|
|
740
|
+
export declare interface EditorHistory {
|
|
741
|
+
/**
|
|
742
|
+
* 显示历史记录侧边栏
|
|
743
|
+
*/
|
|
744
|
+
showSidebar: () => void;
|
|
745
|
+
/**
|
|
746
|
+
* 隐藏历史记录侧边栏
|
|
747
|
+
*/
|
|
748
|
+
hideSidebar: () => void;
|
|
749
|
+
}
|
|
750
|
+
|
|
751
|
+
export declare type EditorHistoryOptions = EditorFeatureConfig;
|
|
752
|
+
|
|
540
753
|
/**
|
|
541
754
|
* i18n 相关设置
|
|
542
755
|
*/
|
|
@@ -557,13 +770,39 @@ export declare type EditorImageCropPoint = 'nw' | 'north' | 'ne' | 'west' | 'cen
|
|
|
557
770
|
* 链接配置,抽象打开链接等操作
|
|
558
771
|
*/
|
|
559
772
|
export declare interface EditorLinkOptions {
|
|
773
|
+
/**
|
|
774
|
+
* 链接识别配置
|
|
775
|
+
*/
|
|
776
|
+
detection?: {
|
|
777
|
+
/**
|
|
778
|
+
* 支持识别的链接格式
|
|
779
|
+
*/
|
|
780
|
+
pattern?: string | RegExp | (string | RegExp)[];
|
|
781
|
+
/**
|
|
782
|
+
* 是否启用链接识别,默认关闭
|
|
783
|
+
*/
|
|
784
|
+
enabled?: boolean;
|
|
785
|
+
};
|
|
560
786
|
/**
|
|
561
787
|
* 打开链接,如果取消了打开链接操作,返回 false
|
|
562
788
|
* @param url
|
|
563
789
|
* @param target
|
|
564
790
|
* @returns
|
|
565
791
|
*/
|
|
566
|
-
open
|
|
792
|
+
open?: (url: string, target: string) => Promise<boolean>;
|
|
793
|
+
/**
|
|
794
|
+
* 根据文件guid以及其他参数生成链接
|
|
795
|
+
*/
|
|
796
|
+
generate?: (params: FileLinkParams) => Promise<string>;
|
|
797
|
+
/**
|
|
798
|
+
* 从文档链接中解析得到文件guid等参数
|
|
799
|
+
*/
|
|
800
|
+
parse?: (url: string) => Promise<FileLinkParams | undefined>;
|
|
801
|
+
/**
|
|
802
|
+
* 生成sdk2.0内部链接
|
|
803
|
+
* 使用场景:专业表格跨表格引用
|
|
804
|
+
*/
|
|
805
|
+
generateInternal?: (params: FileLinkParams) => Promise<string>;
|
|
567
806
|
}
|
|
568
807
|
|
|
569
808
|
/**
|
|
@@ -648,29 +887,27 @@ export declare interface EditorMenuEntryMenuItemConfig<TName extends string> ext
|
|
|
648
887
|
/**
|
|
649
888
|
* 菜单功能按钮配置
|
|
650
889
|
*/
|
|
651
|
-
export declare interface EditorMenuFeatureConfig {
|
|
890
|
+
export declare interface EditorMenuFeatureConfig extends EditorFeatureConfig {
|
|
652
891
|
/**
|
|
653
|
-
*
|
|
892
|
+
* 按钮标签(显示文本)一般工具栏上的按钮不会显示文本,如果需要显示文本,配置此项。
|
|
654
893
|
*/
|
|
655
|
-
|
|
894
|
+
label?: string;
|
|
656
895
|
/**
|
|
657
|
-
*
|
|
896
|
+
* 按钮图标,可以是 base64 的图片信息,也可以是图片 url
|
|
658
897
|
*/
|
|
659
|
-
|
|
660
|
-
}
|
|
661
|
-
|
|
662
|
-
/**
|
|
663
|
-
* 菜单功能按钮配置
|
|
664
|
-
*/
|
|
665
|
-
export declare interface EditorMenuFeatureConfig {
|
|
898
|
+
icon?: string;
|
|
666
899
|
/**
|
|
667
|
-
*
|
|
900
|
+
* 按钮点击事件.接受一个函数,可以自定义点击事件。
|
|
668
901
|
*/
|
|
669
|
-
|
|
902
|
+
callback?: () => void;
|
|
670
903
|
/**
|
|
671
|
-
*
|
|
904
|
+
* 按钮提示文本,鼠标悬浮到按钮上时显示的tooltip文字
|
|
672
905
|
*/
|
|
673
|
-
|
|
906
|
+
tooltip?: string;
|
|
907
|
+
/**
|
|
908
|
+
* 按钮在工具栏中位置,不设置则按照默认位置
|
|
909
|
+
*/
|
|
910
|
+
index?: number;
|
|
674
911
|
}
|
|
675
912
|
|
|
676
913
|
/**
|
|
@@ -728,9 +965,9 @@ export declare interface EditorMenuOptions<TName extends string> {
|
|
|
728
965
|
entries?: EditorMenuEntryConfig<TName>[];
|
|
729
966
|
/**
|
|
730
967
|
* 菜单栏功能按钮配置
|
|
731
|
-
*
|
|
968
|
+
* 更加间接的配置项
|
|
732
969
|
*/
|
|
733
|
-
features?: Record<TName, EditorMenuFeatureConfig
|
|
970
|
+
features?: Partial<Record<TName, EditorMenuFeatureConfig>>;
|
|
734
971
|
/**
|
|
735
972
|
* 自定义按钮配置
|
|
736
973
|
*/
|
|
@@ -800,6 +1037,10 @@ export declare interface EditorOptions {
|
|
|
800
1037
|
* 匿名用户的缺省信息
|
|
801
1038
|
*/
|
|
802
1039
|
anonymous?: EditorAnonymousOptions;
|
|
1040
|
+
/**
|
|
1041
|
+
* 当前文件信息
|
|
1042
|
+
*/
|
|
1043
|
+
file?: EditorFileOptions;
|
|
803
1044
|
/**
|
|
804
1045
|
* i18n 相关设置
|
|
805
1046
|
*/
|
|
@@ -807,13 +1048,13 @@ export declare interface EditorOptions {
|
|
|
807
1048
|
/**
|
|
808
1049
|
* 品牌相关设置
|
|
809
1050
|
*/
|
|
810
|
-
brand?: EditorBrandOptions
|
|
1051
|
+
brand?: MaybePromiseValue<EditorBrandOptions>;
|
|
811
1052
|
/**
|
|
812
1053
|
* 编辑器内部资源请求配置
|
|
813
1054
|
*/
|
|
814
1055
|
assets?: EditorAssetsOptions;
|
|
815
1056
|
/**
|
|
816
|
-
*
|
|
1057
|
+
* 编辑器链接相关配置
|
|
817
1058
|
*/
|
|
818
1059
|
link?: EditorLinkOptions;
|
|
819
1060
|
/**
|
|
@@ -840,6 +1081,38 @@ export declare interface EditorOptions {
|
|
|
840
1081
|
* 导出设置
|
|
841
1082
|
*/
|
|
842
1083
|
export?: EditorExportOptions;
|
|
1084
|
+
/**
|
|
1085
|
+
* 解密设置
|
|
1086
|
+
*/
|
|
1087
|
+
decryption?: EditorDecryptionOptions;
|
|
1088
|
+
/**
|
|
1089
|
+
* 网络请求设置
|
|
1090
|
+
*/
|
|
1091
|
+
http?: HTTPProxy;
|
|
1092
|
+
/**
|
|
1093
|
+
* 编辑器渲染设置项
|
|
1094
|
+
*/
|
|
1095
|
+
render?: EditorRenderOptions;
|
|
1096
|
+
/**
|
|
1097
|
+
* 编辑器 UI 相关
|
|
1098
|
+
*/
|
|
1099
|
+
ui?: EditorUiOptions;
|
|
1100
|
+
/**
|
|
1101
|
+
* 编辑器卡点限制
|
|
1102
|
+
*/
|
|
1103
|
+
checkpoints?: EditorCheckpointsOptions;
|
|
1104
|
+
/**
|
|
1105
|
+
* 编辑器工具箱设置
|
|
1106
|
+
*/
|
|
1107
|
+
toolbox?: EditorToolboxOptions;
|
|
1108
|
+
/**
|
|
1109
|
+
* 编辑器历史设置
|
|
1110
|
+
*/
|
|
1111
|
+
history?: EditorHistoryOptions;
|
|
1112
|
+
/**
|
|
1113
|
+
* 编辑器协作相关
|
|
1114
|
+
*/
|
|
1115
|
+
collaboration?: EditorCollaborationOptions;
|
|
843
1116
|
}
|
|
844
1117
|
|
|
845
1118
|
/**
|
|
@@ -900,10 +1173,33 @@ export declare interface EditorOutlineOptions {
|
|
|
900
1173
|
visible?: boolean;
|
|
901
1174
|
}
|
|
902
1175
|
|
|
1176
|
+
export declare interface EditorPickedFile {
|
|
1177
|
+
/**
|
|
1178
|
+
* 文件大小
|
|
1179
|
+
*/
|
|
1180
|
+
size: number;
|
|
1181
|
+
/**
|
|
1182
|
+
* 文件名
|
|
1183
|
+
*/
|
|
1184
|
+
name: string;
|
|
1185
|
+
/**
|
|
1186
|
+
* 文件路径,仅显示有意义的相对路径,可用在上传文件夹和识别文件使用
|
|
1187
|
+
*/
|
|
1188
|
+
path?: string;
|
|
1189
|
+
/**
|
|
1190
|
+
* 文件类型,mime-type
|
|
1191
|
+
*/
|
|
1192
|
+
type: string;
|
|
1193
|
+
/**
|
|
1194
|
+
* 文件原始数据,用于给上传控件使用
|
|
1195
|
+
*/
|
|
1196
|
+
raw: File;
|
|
1197
|
+
}
|
|
1198
|
+
|
|
903
1199
|
/**
|
|
904
1200
|
* 编辑器打印设置
|
|
905
1201
|
*/
|
|
906
|
-
export declare interface EditorPrintOptions {
|
|
1202
|
+
export declare interface EditorPrintOptions extends EditorFeatureConfig {
|
|
907
1203
|
/**
|
|
908
1204
|
* 部分套件如果绕过了编辑器预设的打印接口,直接通过拉起了浏览器的打印页面,这时打印页面无法获取到编辑器的内容,
|
|
909
1205
|
* 这种情况下就会 fallback 到这个 options 上,显示一个提示信息。
|
|
@@ -911,10 +1207,6 @@ export declare interface EditorPrintOptions {
|
|
|
911
1207
|
fallback?: {
|
|
912
1208
|
message: string;
|
|
913
1209
|
};
|
|
914
|
-
/**
|
|
915
|
-
* 是否禁用打印功能
|
|
916
|
-
*/
|
|
917
|
-
disabled?: boolean;
|
|
918
1210
|
}
|
|
919
1211
|
|
|
920
1212
|
/**
|
|
@@ -928,6 +1220,13 @@ export declare interface EditorRemoteUploadableFile extends EditorBaseUploadable
|
|
|
928
1220
|
raw?: never;
|
|
929
1221
|
}
|
|
930
1222
|
|
|
1223
|
+
export declare interface EditorRenderOptions {
|
|
1224
|
+
/**
|
|
1225
|
+
* 渲染的容器
|
|
1226
|
+
*/
|
|
1227
|
+
container?: HTMLElement;
|
|
1228
|
+
}
|
|
1229
|
+
|
|
931
1230
|
/**
|
|
932
1231
|
* 编辑器通用接口
|
|
933
1232
|
*/
|
|
@@ -962,8 +1261,24 @@ export declare abstract class EditorSDK {
|
|
|
962
1261
|
abstract get mode(): EditorMode;
|
|
963
1262
|
/**
|
|
964
1263
|
* 编辑器评论相关接口
|
|
1264
|
+
* 部分环境不存在,如离线客户端
|
|
1265
|
+
*/
|
|
1266
|
+
abstract get comments(): EditorComments | undefined;
|
|
1267
|
+
/**
|
|
1268
|
+
* 编辑器协作者相关接口
|
|
1269
|
+
* 部分环境不存在,如离线客户端
|
|
965
1270
|
*/
|
|
966
|
-
abstract get
|
|
1271
|
+
abstract get collaborators(): EditorCollaborators | undefined;
|
|
1272
|
+
/**
|
|
1273
|
+
* 编辑器历史相关接口
|
|
1274
|
+
* 部分环境不存在,如离线客户端
|
|
1275
|
+
*/
|
|
1276
|
+
abstract get history(): EditorHistory | undefined;
|
|
1277
|
+
/**
|
|
1278
|
+
* 编辑器版本相关接口
|
|
1279
|
+
* 部分环境不存在,如离线客户端
|
|
1280
|
+
*/
|
|
1281
|
+
abstract get version(): EditorVersion | undefined;
|
|
967
1282
|
}
|
|
968
1283
|
|
|
969
1284
|
/**
|
|
@@ -1099,11 +1414,11 @@ export declare interface EditorTextOptions<Color = string> {
|
|
|
1099
1414
|
/**
|
|
1100
1415
|
* 工具栏功能按钮配置(包括内置按钮和自定义按钮)
|
|
1101
1416
|
*/
|
|
1102
|
-
export declare interface EditorToolbarFeatureButton<TName extends string> {
|
|
1417
|
+
export declare interface EditorToolbarFeatureButton<TName extends string> extends EditorFeatureConfig {
|
|
1103
1418
|
/**
|
|
1104
1419
|
* 按钮的唯一标识,用以确定配置的是哪个按钮。
|
|
1105
1420
|
*/
|
|
1106
|
-
name
|
|
1421
|
+
name?: TName;
|
|
1107
1422
|
/**
|
|
1108
1423
|
* 按钮标签(显示文本)一般工具栏上的按钮不会显示文本,如果需要显示文本,配置此项。
|
|
1109
1424
|
*/
|
|
@@ -1112,14 +1427,6 @@ export declare interface EditorToolbarFeatureButton<TName extends string> {
|
|
|
1112
1427
|
* 按钮图标,可以是 base64 的图片信息,也可以是图片 url
|
|
1113
1428
|
*/
|
|
1114
1429
|
icon?: string;
|
|
1115
|
-
/**
|
|
1116
|
-
* 按钮是否隐藏,设置为true则隐藏按钮
|
|
1117
|
-
*/
|
|
1118
|
-
hidden?: boolean;
|
|
1119
|
-
/**
|
|
1120
|
-
* 按钮是否禁用,设置为true则变为灰色不可点击
|
|
1121
|
-
*/
|
|
1122
|
-
disabled?: boolean;
|
|
1123
1430
|
/**
|
|
1124
1431
|
* 按钮点击事件.接受一个函数,可以自定义点击事件。
|
|
1125
1432
|
*/
|
|
@@ -1163,6 +1470,90 @@ export declare interface EditorToolbarOptions<TName extends string> {
|
|
|
1163
1470
|
custom?: EditorToolbarFeatureButtonConfig<string>;
|
|
1164
1471
|
}
|
|
1165
1472
|
|
|
1473
|
+
/**
|
|
1474
|
+
* 编辑器工具箱配置选项接口
|
|
1475
|
+
*/
|
|
1476
|
+
export declare interface EditorToolboxOptions {
|
|
1477
|
+
/**
|
|
1478
|
+
* 获取工具箱配置
|
|
1479
|
+
* @param attachGuidList - 附件GUID列表
|
|
1480
|
+
* @returns 返回工具箱工具项列表
|
|
1481
|
+
*/
|
|
1482
|
+
getToolbox?: (attachGuidList: string[]) => Promise<{
|
|
1483
|
+
tools: ToolboxToolItem[];
|
|
1484
|
+
}>;
|
|
1485
|
+
}
|
|
1486
|
+
|
|
1487
|
+
/**
|
|
1488
|
+
* 编辑器UI选项接口
|
|
1489
|
+
* 定义了编辑器可以使用的UI相关功能
|
|
1490
|
+
*/
|
|
1491
|
+
export declare interface EditorUiOptions {
|
|
1492
|
+
/**
|
|
1493
|
+
* 侧边栏
|
|
1494
|
+
*/
|
|
1495
|
+
sidebar?: {
|
|
1496
|
+
/**
|
|
1497
|
+
* 打开使用指南/快捷键侧边栏
|
|
1498
|
+
*/
|
|
1499
|
+
open?: (activeKey: 'userGuide' | 'shortcut') => void;
|
|
1500
|
+
};
|
|
1501
|
+
/**
|
|
1502
|
+
* 升级弹窗
|
|
1503
|
+
*/
|
|
1504
|
+
upgrade?: {
|
|
1505
|
+
/**
|
|
1506
|
+
* 显示升级弹窗
|
|
1507
|
+
*/
|
|
1508
|
+
showModal?: (options: ShowUpgradeModalProps) => Promise<ShowUpgradeModalResponse>;
|
|
1509
|
+
};
|
|
1510
|
+
notification?: {
|
|
1511
|
+
/**
|
|
1512
|
+
* 渲染通知条
|
|
1513
|
+
*/
|
|
1514
|
+
render?: (params: RenderNotificationProps) => void;
|
|
1515
|
+
};
|
|
1516
|
+
/**
|
|
1517
|
+
* 用户名片
|
|
1518
|
+
*/
|
|
1519
|
+
userCard?: {
|
|
1520
|
+
/**
|
|
1521
|
+
* 需要排除的用户卡片字段(不会在用户卡片中展示)
|
|
1522
|
+
*/
|
|
1523
|
+
excludeFields?: string[];
|
|
1524
|
+
/**
|
|
1525
|
+
* 渲染用户卡片
|
|
1526
|
+
*/
|
|
1527
|
+
render?: (params: RenderUserCardProps) => RenderUserCardResult;
|
|
1528
|
+
};
|
|
1529
|
+
/**
|
|
1530
|
+
* toast
|
|
1531
|
+
*/
|
|
1532
|
+
toast?: {
|
|
1533
|
+
/**
|
|
1534
|
+
* 显示自定义toast
|
|
1535
|
+
*/
|
|
1536
|
+
show?: (options: ShowToastOptions) => void;
|
|
1537
|
+
/**
|
|
1538
|
+
* 是否禁用toast
|
|
1539
|
+
*/
|
|
1540
|
+
disabled?: boolean;
|
|
1541
|
+
};
|
|
1542
|
+
/**
|
|
1543
|
+
* confirm
|
|
1544
|
+
*/
|
|
1545
|
+
confirm?: {
|
|
1546
|
+
/**
|
|
1547
|
+
* 显示自定义confirm
|
|
1548
|
+
*/
|
|
1549
|
+
show?: (options: ShowConfirmOptions) => void;
|
|
1550
|
+
/**
|
|
1551
|
+
* 是否禁用confirm
|
|
1552
|
+
*/
|
|
1553
|
+
disabled?: boolean;
|
|
1554
|
+
};
|
|
1555
|
+
}
|
|
1556
|
+
|
|
1166
1557
|
export declare type EditorUploadableFile = EditorLocalUploadableFile;
|
|
1167
1558
|
|
|
1168
1559
|
/**
|
|
@@ -1226,6 +1617,13 @@ export declare interface EditorUserOptions {
|
|
|
1226
1617
|
defaultAvatar?: string;
|
|
1227
1618
|
}
|
|
1228
1619
|
|
|
1620
|
+
export declare interface EditorVersion {
|
|
1621
|
+
/**
|
|
1622
|
+
* 保存版本
|
|
1623
|
+
*/
|
|
1624
|
+
createRevision: () => void;
|
|
1625
|
+
}
|
|
1626
|
+
|
|
1229
1627
|
/**
|
|
1230
1628
|
* 编辑器外部水印信息
|
|
1231
1629
|
*/
|
|
@@ -1249,6 +1647,86 @@ export declare type EditorWatermarkResource = {
|
|
|
1249
1647
|
url: string;
|
|
1250
1648
|
};
|
|
1251
1649
|
|
|
1650
|
+
export declare enum FeatureStatus {
|
|
1651
|
+
/**
|
|
1652
|
+
* 隐藏
|
|
1653
|
+
*/
|
|
1654
|
+
Hidden = 0,
|
|
1655
|
+
/**
|
|
1656
|
+
* 正常
|
|
1657
|
+
*/
|
|
1658
|
+
Normal = 1,
|
|
1659
|
+
/**
|
|
1660
|
+
* 禁用
|
|
1661
|
+
*/
|
|
1662
|
+
Disabled = 2
|
|
1663
|
+
}
|
|
1664
|
+
|
|
1665
|
+
export declare interface FileLinkParams {
|
|
1666
|
+
/**
|
|
1667
|
+
* 文件guid
|
|
1668
|
+
*/
|
|
1669
|
+
fileGuid: string;
|
|
1670
|
+
/**
|
|
1671
|
+
* 文件类型,如docs,sheets
|
|
1672
|
+
*/
|
|
1673
|
+
type: string;
|
|
1674
|
+
/**
|
|
1675
|
+
* 用于定位到 mention、评论等位置。
|
|
1676
|
+
*/
|
|
1677
|
+
hash?: string;
|
|
1678
|
+
/**
|
|
1679
|
+
* 其他自定义字段
|
|
1680
|
+
*/
|
|
1681
|
+
[key: string]: unknown;
|
|
1682
|
+
}
|
|
1683
|
+
|
|
1684
|
+
/**
|
|
1685
|
+
* 文件子类型枚举
|
|
1686
|
+
*/
|
|
1687
|
+
export declare enum FileSubtype {
|
|
1688
|
+
/** 专业版幻灯片 */
|
|
1689
|
+
ProSlide = -10,
|
|
1690
|
+
/** 白板 */
|
|
1691
|
+
Whiteboard = -9,
|
|
1692
|
+
/** 表单 */
|
|
1693
|
+
Form = -8,
|
|
1694
|
+
/** 思维导图 */
|
|
1695
|
+
Mind = -7,
|
|
1696
|
+
/** 专业文档 */
|
|
1697
|
+
ProDoc = -6,
|
|
1698
|
+
/** 幻灯片 */
|
|
1699
|
+
Slide = -5,
|
|
1700
|
+
/** 新表格 */
|
|
1701
|
+
NewSheet = -4,
|
|
1702
|
+
/** 老表格 */
|
|
1703
|
+
Sheet = -3,
|
|
1704
|
+
/** 新文档 */
|
|
1705
|
+
NewDoc = -2,
|
|
1706
|
+
/** 老老表格 */
|
|
1707
|
+
OldSheet = -1,
|
|
1708
|
+
/** 旧文档 */
|
|
1709
|
+
OldDoc = 0,
|
|
1710
|
+
/** 文件夹 */
|
|
1711
|
+
Folder = 1,
|
|
1712
|
+
/** 协作 */
|
|
1713
|
+
Collaboration = 2
|
|
1714
|
+
}
|
|
1715
|
+
|
|
1716
|
+
/**
|
|
1717
|
+
* 文件类型枚举
|
|
1718
|
+
*/
|
|
1719
|
+
export declare enum FileType {
|
|
1720
|
+
/** 未知类型 */
|
|
1721
|
+
Unknown = 0,
|
|
1722
|
+
/** 文件夹或空间 */
|
|
1723
|
+
FolderOrSpace = 1,
|
|
1724
|
+
/** 石墨文件 */
|
|
1725
|
+
ShimoFile = 2,
|
|
1726
|
+
/** 云文件 */
|
|
1727
|
+
CloudFile = 3
|
|
1728
|
+
}
|
|
1729
|
+
|
|
1252
1730
|
/**
|
|
1253
1731
|
* 请求、响应头
|
|
1254
1732
|
*/
|
|
@@ -1356,8 +1834,45 @@ export declare interface HTTPResponse<Data = unknown> {
|
|
|
1356
1834
|
*/
|
|
1357
1835
|
export declare type HTTPResponseType = 'arraybuffer' | 'blob' | 'document' | 'json' | 'text' | 'stream';
|
|
1358
1836
|
|
|
1837
|
+
export declare interface Limitation {
|
|
1838
|
+
/**
|
|
1839
|
+
* 限制原因(错误码)
|
|
1840
|
+
*/
|
|
1841
|
+
code?: number;
|
|
1842
|
+
/**
|
|
1843
|
+
* 单位(不参与计算,仅作显示)
|
|
1844
|
+
* minutes、MB
|
|
1845
|
+
*/
|
|
1846
|
+
unit?: string;
|
|
1847
|
+
/**
|
|
1848
|
+
* 描述
|
|
1849
|
+
*/
|
|
1850
|
+
desc?: string;
|
|
1851
|
+
/**
|
|
1852
|
+
* min/max int64 默认表示 MB/个/分钟/行
|
|
1853
|
+
*/
|
|
1854
|
+
max?: number;
|
|
1855
|
+
min?: number;
|
|
1856
|
+
}
|
|
1857
|
+
|
|
1359
1858
|
export declare type MaybePromiseValue<T> = T | Promise<T>;
|
|
1360
1859
|
|
|
1860
|
+
/**
|
|
1861
|
+
* 升级弹窗类型
|
|
1862
|
+
* 个人版或企业版
|
|
1863
|
+
*/
|
|
1864
|
+
export declare type OpenType = 'personal' | 'enterprise';
|
|
1865
|
+
|
|
1866
|
+
/**
|
|
1867
|
+
* 幻灯片可导出类型
|
|
1868
|
+
*/
|
|
1869
|
+
export declare enum PresentationExportType {
|
|
1870
|
+
Pptx = "pptx",
|
|
1871
|
+
Pdf = "pdf",
|
|
1872
|
+
ImagePdf = "imagePdf",
|
|
1873
|
+
Image = "image"
|
|
1874
|
+
}
|
|
1875
|
+
|
|
1361
1876
|
export declare type PresentationFontFace = EditorFontFace;
|
|
1362
1877
|
|
|
1363
1878
|
export declare type PresentationFontMeta = EditorFontMeta;
|
|
@@ -1649,4 +2164,231 @@ export declare interface PresentationZoom {
|
|
|
1649
2164
|
zoomOut: () => void;
|
|
1650
2165
|
}
|
|
1651
2166
|
|
|
2167
|
+
export declare interface RenderNotificationProps {
|
|
2168
|
+
/**
|
|
2169
|
+
* 渲染的容器
|
|
2170
|
+
*/
|
|
2171
|
+
container: HTMLElement;
|
|
2172
|
+
/**
|
|
2173
|
+
* 自定义样式,实际类型为React.CSSProperties
|
|
2174
|
+
*/
|
|
2175
|
+
style?: Record<string, string | number>;
|
|
2176
|
+
}
|
|
2177
|
+
|
|
2178
|
+
export declare interface RenderUserCardProps {
|
|
2179
|
+
uid: string | number;
|
|
2180
|
+
rect: {
|
|
2181
|
+
left: number;
|
|
2182
|
+
top: number;
|
|
2183
|
+
width: number;
|
|
2184
|
+
height: number;
|
|
2185
|
+
hasReducedHeaderHeight?: boolean;
|
|
2186
|
+
};
|
|
2187
|
+
position?: 'top' | 'left' | 'right' | 'bottom' | 'left_top' | 'left_bottom' | 'right_top' | 'bottom_top' | 'top_left' | 'top_right' | 'bottom_left' | 'bottom_right';
|
|
2188
|
+
trigger: 'hover' | 'click';
|
|
2189
|
+
}
|
|
2190
|
+
|
|
2191
|
+
export declare interface RenderUserCardResult {
|
|
2192
|
+
/**
|
|
2193
|
+
* 关闭用户卡片
|
|
2194
|
+
*/
|
|
2195
|
+
close: (force?: boolean) => void;
|
|
2196
|
+
}
|
|
2197
|
+
|
|
2198
|
+
/**
|
|
2199
|
+
* 升级操作结果类型枚举
|
|
2200
|
+
*/
|
|
2201
|
+
export declare enum ResultType {
|
|
2202
|
+
/** 操作成功 */
|
|
2203
|
+
Success = "success",
|
|
2204
|
+
/** 用户取消操作 */
|
|
2205
|
+
Cancel = "cancel",
|
|
2206
|
+
/** 发生错误 */
|
|
2207
|
+
Error = "error",
|
|
2208
|
+
/** 跳转(目前仅在企业版用户过期时返回) */
|
|
2209
|
+
Redirect = "redirect"
|
|
2210
|
+
}
|
|
2211
|
+
|
|
2212
|
+
export declare interface SaveContext {
|
|
2213
|
+
clientId: string;
|
|
2214
|
+
}
|
|
2215
|
+
|
|
2216
|
+
export declare interface SaveStatusDelegation {
|
|
2217
|
+
/**
|
|
2218
|
+
* 保存状态发生变化时触发回调
|
|
2219
|
+
* @param state
|
|
2220
|
+
* @returns
|
|
2221
|
+
*/
|
|
2222
|
+
onChangeState: (state: unknown, context: SaveContext) => void;
|
|
2223
|
+
/**
|
|
2224
|
+
* 出现致命错误时触发回调,出现致命错误后,编辑器将无法继续编辑
|
|
2225
|
+
* @param error
|
|
2226
|
+
* @returns
|
|
2227
|
+
*/
|
|
2228
|
+
onError: (error: unknown, context: SaveContext) => void;
|
|
2229
|
+
}
|
|
2230
|
+
|
|
2231
|
+
/**
|
|
2232
|
+
* 付费场景类型
|
|
2233
|
+
*/
|
|
2234
|
+
export declare type Scene = 'history' | 'version' | 'public' | 'search' | 'attachments';
|
|
2235
|
+
|
|
2236
|
+
export declare interface ShowConfirmOptions {
|
|
2237
|
+
/**
|
|
2238
|
+
* 确认框标题
|
|
2239
|
+
*/
|
|
2240
|
+
title: string;
|
|
2241
|
+
/**
|
|
2242
|
+
* 确认框描述
|
|
2243
|
+
*/
|
|
2244
|
+
description: string;
|
|
2245
|
+
/**
|
|
2246
|
+
* 确认按钮配置
|
|
2247
|
+
*/
|
|
2248
|
+
confirmButton?: ConfirmButtonConfig;
|
|
2249
|
+
/**
|
|
2250
|
+
* 取消按钮配置
|
|
2251
|
+
*/
|
|
2252
|
+
cancelButton?: ConfirmButtonConfig;
|
|
2253
|
+
}
|
|
2254
|
+
|
|
2255
|
+
export declare interface ShowToastOptions {
|
|
2256
|
+
/**
|
|
2257
|
+
* toast标题
|
|
2258
|
+
*/
|
|
2259
|
+
title: string;
|
|
2260
|
+
/**
|
|
2261
|
+
* toast类型
|
|
2262
|
+
*/
|
|
2263
|
+
type: 'success' | 'error' | 'warn' | 'info';
|
|
2264
|
+
/**
|
|
2265
|
+
* 显示时长,默认3s
|
|
2266
|
+
*/
|
|
2267
|
+
duration?: number;
|
|
2268
|
+
/**
|
|
2269
|
+
* 是否自动隐藏,默认true
|
|
2270
|
+
*/
|
|
2271
|
+
autoHide?: boolean;
|
|
2272
|
+
}
|
|
2273
|
+
|
|
2274
|
+
/**
|
|
2275
|
+
* 升级弹窗配置选项接口
|
|
2276
|
+
*/
|
|
2277
|
+
export declare interface ShowUpgradeModalProps {
|
|
2278
|
+
/** 打开个人升级弹窗还是企业弹窗 */
|
|
2279
|
+
openType: OpenType;
|
|
2280
|
+
/** 触发功能的Key值 */
|
|
2281
|
+
serviceKey: string;
|
|
2282
|
+
/** 文件类型(如果业务能够获取到则为必传) */
|
|
2283
|
+
fileType?: FileType;
|
|
2284
|
+
/** 文件子类型(如果业务能够获取到则为必传) */
|
|
2285
|
+
fileSubtype?: FileSubtype;
|
|
2286
|
+
/** 付费场景,用于升级弹窗的定制化文案显示 */
|
|
2287
|
+
scene?: Scene;
|
|
2288
|
+
}
|
|
2289
|
+
|
|
2290
|
+
/**
|
|
2291
|
+
* 升级弹窗响应接口
|
|
2292
|
+
*/
|
|
2293
|
+
export declare interface ShowUpgradeModalResponse {
|
|
2294
|
+
/** 操作结果 */
|
|
2295
|
+
result: ResultType;
|
|
2296
|
+
/** 错误信息(供开发人员查看) */
|
|
2297
|
+
errorMsg?: string;
|
|
2298
|
+
}
|
|
2299
|
+
|
|
2300
|
+
/**
|
|
2301
|
+
* 演讲者信息接口
|
|
2302
|
+
* 包含演讲者的基本信息
|
|
2303
|
+
*/
|
|
2304
|
+
export declare interface Speaker {
|
|
2305
|
+
/** 演讲者ID */
|
|
2306
|
+
id: number;
|
|
2307
|
+
/** 演讲者姓名 */
|
|
2308
|
+
name: string;
|
|
2309
|
+
/** 演讲者头像URL */
|
|
2310
|
+
avatar: string;
|
|
2311
|
+
}
|
|
2312
|
+
|
|
2313
|
+
export declare interface SyncContext {
|
|
2314
|
+
clientId: string;
|
|
2315
|
+
timestamp: number;
|
|
2316
|
+
}
|
|
2317
|
+
|
|
2318
|
+
export declare interface SyncStatusDelegation {
|
|
2319
|
+
/**
|
|
2320
|
+
* 同步状态发生变化时触发回调
|
|
2321
|
+
* @param state
|
|
2322
|
+
* @param context
|
|
2323
|
+
* @returns
|
|
2324
|
+
*/
|
|
2325
|
+
onChangeState: (state: unknown, context: SyncContext) => void;
|
|
2326
|
+
/**
|
|
2327
|
+
* 出现致命错误时触发回调,出现致命错误后,编辑器将无法继续编辑
|
|
2328
|
+
* @param error
|
|
2329
|
+
* @param context
|
|
2330
|
+
* @returns
|
|
2331
|
+
*/
|
|
2332
|
+
onError: (error: unknown, context: SyncContext) => void;
|
|
2333
|
+
}
|
|
2334
|
+
|
|
2335
|
+
/**
|
|
2336
|
+
* 工具箱工具项接口
|
|
2337
|
+
*/
|
|
2338
|
+
export declare interface ToolboxToolItem {
|
|
2339
|
+
/** 工具类型 */
|
|
2340
|
+
type: ToolTypes;
|
|
2341
|
+
/** 工具名称 */
|
|
2342
|
+
name: string;
|
|
2343
|
+
/** 工具图标 */
|
|
2344
|
+
icon: string;
|
|
2345
|
+
/** 工具分组 */
|
|
2346
|
+
group: ToolGroupTypes;
|
|
2347
|
+
/** 分组名称 */
|
|
2348
|
+
groupName: string;
|
|
2349
|
+
/** 是否为测试版功能 */
|
|
2350
|
+
isBeta: boolean;
|
|
2351
|
+
/** 工具回调函数 */
|
|
2352
|
+
callback: () => Promise<{
|
|
2353
|
+
result: 'success' | 'failed';
|
|
2354
|
+
error?: unknown;
|
|
2355
|
+
}>;
|
|
2356
|
+
}
|
|
2357
|
+
|
|
2358
|
+
/**
|
|
2359
|
+
* 工具分组类型枚举
|
|
2360
|
+
*/
|
|
2361
|
+
export declare enum ToolGroupTypes {
|
|
2362
|
+
/** 转换工具组 */
|
|
2363
|
+
Convert = "convert",
|
|
2364
|
+
/** 处理工具组 */
|
|
2365
|
+
Processing = "processing",
|
|
2366
|
+
/** 智能工具组 */
|
|
2367
|
+
Intelligent = "intelligent"
|
|
2368
|
+
}
|
|
2369
|
+
|
|
2370
|
+
/**
|
|
2371
|
+
* 工具类型枚举
|
|
2372
|
+
*/
|
|
2373
|
+
export declare enum ToolTypes {
|
|
2374
|
+
/** PDF转Word */
|
|
2375
|
+
PdfToWord = "pdfToWord",
|
|
2376
|
+
/** PDF转Excel */
|
|
2377
|
+
PdfToExcel = "pdfToExcel",
|
|
2378
|
+
/** PDF转PPT */
|
|
2379
|
+
PdfToPpt = "pdfToPpt",
|
|
2380
|
+
/** 图片转PDF */
|
|
2381
|
+
ImgToPdf = "imgToPdf",
|
|
2382
|
+
/** PDF合并 */
|
|
2383
|
+
PdfMerge = "pdfMerge",
|
|
2384
|
+
/** PDF拆分 */
|
|
2385
|
+
PdfSplit = "pdfSplit",
|
|
2386
|
+
/** 文件内容提取 */
|
|
2387
|
+
FileContentExtraction = "fileContentExtraction",
|
|
2388
|
+
/** 图片转文字 */
|
|
2389
|
+
COR = "imgToText",
|
|
2390
|
+
/** 音频转文字 */
|
|
2391
|
+
STT = "audioToText"
|
|
2392
|
+
}
|
|
2393
|
+
|
|
1652
2394
|
export { }
|