@officesdk/editor-sdk-core 0.0.0-20 → 0.0.0-21
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/menu.js +1 -1
- package/cjs/shared/collaboration.js +1 -1
- package/cjs/shared/decryption.js +1 -1
- package/cjs/shared/editor.js +1 -1
- package/cjs/shared/import.js +3 -0
- package/cjs/shared/index.js +1 -1
- package/cjs/shared/menu.js +1 -1
- package/cjs/sheet/export.js +1 -1
- package/cjs/sheet/formula.js +3 -0
- package/cjs/sheet/import-range.js +3 -0
- package/cjs/sheet/index.js +1 -1
- package/cjs/sheet/render.js +1 -1
- package/cjs/sheet/sdk.js +1 -1
- package/cjs/table/filed-context-menu.js +3 -0
- package/cjs/table/index.js +1 -1
- package/cjs/table/list-bar.js +3 -0
- package/cjs/table/sdk.js +1 -1
- package/cjs/table/toolbar.js +3 -0
- package/cjs/table/view-context-menu.js +3 -0
- package/esm/docx/menu.js +1 -1
- package/esm/shared/collaboration.js +1 -1
- package/esm/shared/decryption.js +1 -1
- package/esm/shared/editor.js +1 -1
- package/esm/shared/import.js +2 -0
- package/esm/shared/index.js +1 -1
- package/esm/shared/menu.js +1 -1
- package/esm/sheet/export.js +1 -1
- package/esm/sheet/formula.js +2 -0
- package/esm/sheet/import-range.js +2 -0
- package/esm/sheet/index.js +1 -1
- package/esm/sheet/render.js +1 -1
- package/esm/sheet/sdk.js +1 -1
- package/esm/table/filed-context-menu.js +2 -0
- package/esm/table/index.js +1 -1
- package/esm/table/list-bar.js +2 -0
- package/esm/table/sdk.js +1 -1
- package/esm/table/toolbar.js +2 -0
- package/esm/table/view-context-menu.js +2 -0
- package/package.json +1 -1
- package/types/combine.d.ts +302 -27
- package/types/diagram.d.ts +60 -18
- package/types/docs.d.ts +60 -18
- package/types/docx.d.ts +61 -19
- package/types/pdf.d.ts +60 -18
- package/types/presentation.d.ts +60 -18
- package/types/shared.d.ts +60 -18
- package/types/sheet.d.ts +92 -26
- package/types/table.d.ts +269 -18
- package/cjs/shared/render.js +0 -3
- package/cjs/sheet/import-formula.js +0 -3
- package/esm/shared/render.js +0 -2
- package/esm/sheet/import-formula.js +0 -2
package/types/diagram.d.ts
CHANGED
|
@@ -380,6 +380,10 @@ export declare interface EditorCollaborationOptions {
|
|
|
380
380
|
* 是否使用严格的长度校验规则,默认关闭,在开启后如果出现长度校验失败会立刻禁止编辑器继续编写,并将保存状态设置为错误状态
|
|
381
381
|
*/
|
|
382
382
|
strictCLC?: boolean;
|
|
383
|
+
/**
|
|
384
|
+
* 版本号, 需通过内容接口response header获取
|
|
385
|
+
*/
|
|
386
|
+
rev: MaybePromiseValue<number>;
|
|
383
387
|
}
|
|
384
388
|
|
|
385
389
|
/**
|
|
@@ -555,7 +559,7 @@ export declare interface EditorDecryptionOptions {
|
|
|
555
559
|
* @param buffer - 需要解密的二进制数据
|
|
556
560
|
* @returns 解密后的二进制数据
|
|
557
561
|
*/
|
|
558
|
-
|
|
562
|
+
decryptFile?: (buffer: ArrayBuffer) => ArrayBuffer;
|
|
559
563
|
}
|
|
560
564
|
|
|
561
565
|
export declare interface EditorDelta {
|
|
@@ -799,6 +803,37 @@ export declare interface EditorI18nOptions {
|
|
|
799
803
|
|
|
800
804
|
export declare type EditorImageCropPoint = 'nw' | 'north' | 'ne' | 'west' | 'center' | 'east' | 'sw' | 'south' | 'se';
|
|
801
805
|
|
|
806
|
+
export declare interface EditorImportOptions {
|
|
807
|
+
/**
|
|
808
|
+
* 获取导入状态,没有contentUrl时需要显示导入进度
|
|
809
|
+
* 待导入完成后再渲染
|
|
810
|
+
*/
|
|
811
|
+
getImportStatus?: () => Promise<{
|
|
812
|
+
/**
|
|
813
|
+
* 导入进度
|
|
814
|
+
*/
|
|
815
|
+
progress: number;
|
|
816
|
+
/**
|
|
817
|
+
* 导入中
|
|
818
|
+
*/
|
|
819
|
+
status: 'importing';
|
|
820
|
+
} | {
|
|
821
|
+
/**
|
|
822
|
+
* 导入完成
|
|
823
|
+
*/
|
|
824
|
+
status: 'completed';
|
|
825
|
+
} | {
|
|
826
|
+
/**
|
|
827
|
+
* 导入失败
|
|
828
|
+
*/
|
|
829
|
+
status: 'failed';
|
|
830
|
+
/**
|
|
831
|
+
* 导入失败错误信息
|
|
832
|
+
*/
|
|
833
|
+
errorMessage?: string;
|
|
834
|
+
}>;
|
|
835
|
+
}
|
|
836
|
+
|
|
802
837
|
/**
|
|
803
838
|
* 链接配置,抽象打开链接等操作
|
|
804
839
|
*/
|
|
@@ -888,14 +923,18 @@ export declare interface EditorMenuButtonMenuItemConfig<TName extends string> ex
|
|
|
888
923
|
|
|
889
924
|
/**
|
|
890
925
|
* 编辑器菜单配置类型
|
|
891
|
-
*
|
|
926
|
+
* 根据 TName 类型的不同返回不同的菜单配置类型:
|
|
927
|
+
* 1. 当 TName 是对象类型时(如 {pasteMenu: [...]}),会自动提取对象的键作为菜单名称
|
|
928
|
+
* 2. 当 TName 是字符串时,返回普通菜单项配置
|
|
892
929
|
*/
|
|
893
|
-
export declare type EditorMenuEntryConfig<TName extends
|
|
930
|
+
export declare type EditorMenuEntryConfig<TName extends EditorMenuName> = TName extends Record<string, EditorMenuName[]> ? EditorMenuEntryMenuItemConfig<string & keyof TName, TName[keyof TName]> : TName extends string ? EditorMenuHiddenMenuItemConfig<TName> | EditorMenuButtonMenuItemConfig<TName> | EditorMenuLinkMenuItemConfig<TName> | EditorMenuEntryMenuItemConfig<TName, never> : never;
|
|
894
931
|
|
|
895
932
|
/**
|
|
896
933
|
* 子菜单入口配置
|
|
934
|
+
* TName: 菜单项名称(字符串类型)
|
|
935
|
+
* TChildName: 子菜单项名称数组类型,用于配置下一级菜单项
|
|
897
936
|
*/
|
|
898
|
-
export declare interface EditorMenuEntryMenuItemConfig<TName extends string> extends EditorMenuBaseMenuItemConfig<TName> {
|
|
937
|
+
export declare interface EditorMenuEntryMenuItemConfig<TName extends string, TChildName extends EditorMenuName[]> extends EditorMenuBaseMenuItemConfig<TName> {
|
|
899
938
|
type: 'entry';
|
|
900
939
|
/**
|
|
901
940
|
* 是否禁用菜单项,禁用后菜单项依旧显示不过变为灰色,不可点击
|
|
@@ -913,8 +952,9 @@ export declare interface EditorMenuEntryMenuItemConfig<TName extends string> ext
|
|
|
913
952
|
/**
|
|
914
953
|
* 下一级菜单配置,下一级菜单配置项和上一级相同
|
|
915
954
|
* 如果下一级仍然是 entry 类型,可以无限向下扩展
|
|
955
|
+
* 只有当 TName 是对象类型时才应有子菜单
|
|
916
956
|
*/
|
|
917
|
-
children?: EditorMenuEntryConfig<
|
|
957
|
+
children?: TChildName extends EditorMenuName[] ? EditorMenuEntryConfig<TChildName[number]>[] : never;
|
|
918
958
|
}
|
|
919
959
|
|
|
920
960
|
/**
|
|
@@ -979,11 +1019,18 @@ export declare interface EditorMenuLinkMenuItemConfig<TName extends string> exte
|
|
|
979
1019
|
url?: string;
|
|
980
1020
|
}
|
|
981
1021
|
|
|
1022
|
+
/**
|
|
1023
|
+
* 菜单项名称类型
|
|
1024
|
+
* 可以是字符串或包含子菜单数组的对象
|
|
1025
|
+
* 如: 'copy' 或 { pasteMenu: ['pasteAll', 'pasteHead', 'pasteValueOnly'] }
|
|
1026
|
+
*/
|
|
1027
|
+
export declare type EditorMenuName = string | Record<string, EditorMenuName[]>;
|
|
1028
|
+
|
|
982
1029
|
/**
|
|
983
1030
|
* 菜单栏相关配置,目前菜单栏不是所有套件都支持,
|
|
984
1031
|
* 菜单栏是指的编辑器最上放可以展开二级菜单的那一栏。
|
|
985
1032
|
*/
|
|
986
|
-
export declare interface EditorMenuOptions<TName extends
|
|
1033
|
+
export declare interface EditorMenuOptions<TName extends EditorMenuName> {
|
|
987
1034
|
/**
|
|
988
1035
|
* 菜单栏是否隐藏,设置为true, 则整个菜单栏不显示
|
|
989
1036
|
*/
|
|
@@ -994,13 +1041,15 @@ export declare interface EditorMenuOptions<TName extends string> {
|
|
|
994
1041
|
disabled?: boolean;
|
|
995
1042
|
/**
|
|
996
1043
|
* 菜单栏一级菜单配置,指显示在菜单栏上的菜单项。
|
|
1044
|
+
* 支持普通菜单项和嵌套菜单项
|
|
997
1045
|
*/
|
|
998
1046
|
entries?: EditorMenuEntryConfig<TName>[];
|
|
999
1047
|
/**
|
|
1000
1048
|
* 菜单栏功能按钮配置
|
|
1001
1049
|
* 更加间接的配置项
|
|
1050
|
+
* 仅在 TName 为字符串类型时有效
|
|
1002
1051
|
*/
|
|
1003
|
-
features?: Partial<Record<TName, EditorMenuFeatureConfig
|
|
1052
|
+
features?: TName extends string ? Partial<Record<TName, EditorMenuFeatureConfig>> : never;
|
|
1004
1053
|
/**
|
|
1005
1054
|
* 自定义按钮配置
|
|
1006
1055
|
*/
|
|
@@ -1114,6 +1163,10 @@ export declare interface EditorOptions {
|
|
|
1114
1163
|
* 导出设置
|
|
1115
1164
|
*/
|
|
1116
1165
|
export?: EditorExportOptions;
|
|
1166
|
+
/**
|
|
1167
|
+
* 导入相关设置
|
|
1168
|
+
*/
|
|
1169
|
+
import?: EditorImportOptions;
|
|
1117
1170
|
/**
|
|
1118
1171
|
* 解密设置
|
|
1119
1172
|
*/
|
|
@@ -1122,10 +1175,6 @@ export declare interface EditorOptions {
|
|
|
1122
1175
|
* 网络请求设置
|
|
1123
1176
|
*/
|
|
1124
1177
|
http?: HTTPProxy;
|
|
1125
|
-
/**
|
|
1126
|
-
* 编辑器渲染设置项
|
|
1127
|
-
*/
|
|
1128
|
-
render?: EditorRenderOptions;
|
|
1129
1178
|
/**
|
|
1130
1179
|
* 编辑器 UI 相关
|
|
1131
1180
|
*/
|
|
@@ -1253,13 +1302,6 @@ export declare interface EditorRemoteUploadableFile extends EditorBaseUploadable
|
|
|
1253
1302
|
raw?: never;
|
|
1254
1303
|
}
|
|
1255
1304
|
|
|
1256
|
-
export declare interface EditorRenderOptions {
|
|
1257
|
-
/**
|
|
1258
|
-
* 渲染的容器
|
|
1259
|
-
*/
|
|
1260
|
-
container?: HTMLElement;
|
|
1261
|
-
}
|
|
1262
|
-
|
|
1263
1305
|
/**
|
|
1264
1306
|
* 编辑器通用接口
|
|
1265
1307
|
*/
|
package/types/docs.d.ts
CHANGED
|
@@ -507,6 +507,10 @@ export declare interface EditorCollaborationOptions {
|
|
|
507
507
|
* 是否使用严格的长度校验规则,默认关闭,在开启后如果出现长度校验失败会立刻禁止编辑器继续编写,并将保存状态设置为错误状态
|
|
508
508
|
*/
|
|
509
509
|
strictCLC?: boolean;
|
|
510
|
+
/**
|
|
511
|
+
* 版本号, 需通过内容接口response header获取
|
|
512
|
+
*/
|
|
513
|
+
rev: MaybePromiseValue<number>;
|
|
510
514
|
}
|
|
511
515
|
|
|
512
516
|
/**
|
|
@@ -682,7 +686,7 @@ export declare interface EditorDecryptionOptions {
|
|
|
682
686
|
* @param buffer - 需要解密的二进制数据
|
|
683
687
|
* @returns 解密后的二进制数据
|
|
684
688
|
*/
|
|
685
|
-
|
|
689
|
+
decryptFile?: (buffer: ArrayBuffer) => ArrayBuffer;
|
|
686
690
|
}
|
|
687
691
|
|
|
688
692
|
export declare interface EditorDelta {
|
|
@@ -926,6 +930,37 @@ export declare interface EditorI18nOptions {
|
|
|
926
930
|
|
|
927
931
|
export declare type EditorImageCropPoint = 'nw' | 'north' | 'ne' | 'west' | 'center' | 'east' | 'sw' | 'south' | 'se';
|
|
928
932
|
|
|
933
|
+
export declare interface EditorImportOptions {
|
|
934
|
+
/**
|
|
935
|
+
* 获取导入状态,没有contentUrl时需要显示导入进度
|
|
936
|
+
* 待导入完成后再渲染
|
|
937
|
+
*/
|
|
938
|
+
getImportStatus?: () => Promise<{
|
|
939
|
+
/**
|
|
940
|
+
* 导入进度
|
|
941
|
+
*/
|
|
942
|
+
progress: number;
|
|
943
|
+
/**
|
|
944
|
+
* 导入中
|
|
945
|
+
*/
|
|
946
|
+
status: 'importing';
|
|
947
|
+
} | {
|
|
948
|
+
/**
|
|
949
|
+
* 导入完成
|
|
950
|
+
*/
|
|
951
|
+
status: 'completed';
|
|
952
|
+
} | {
|
|
953
|
+
/**
|
|
954
|
+
* 导入失败
|
|
955
|
+
*/
|
|
956
|
+
status: 'failed';
|
|
957
|
+
/**
|
|
958
|
+
* 导入失败错误信息
|
|
959
|
+
*/
|
|
960
|
+
errorMessage?: string;
|
|
961
|
+
}>;
|
|
962
|
+
}
|
|
963
|
+
|
|
929
964
|
/**
|
|
930
965
|
* 链接配置,抽象打开链接等操作
|
|
931
966
|
*/
|
|
@@ -1015,14 +1050,18 @@ export declare interface EditorMenuButtonMenuItemConfig<TName extends string> ex
|
|
|
1015
1050
|
|
|
1016
1051
|
/**
|
|
1017
1052
|
* 编辑器菜单配置类型
|
|
1018
|
-
*
|
|
1053
|
+
* 根据 TName 类型的不同返回不同的菜单配置类型:
|
|
1054
|
+
* 1. 当 TName 是对象类型时(如 {pasteMenu: [...]}),会自动提取对象的键作为菜单名称
|
|
1055
|
+
* 2. 当 TName 是字符串时,返回普通菜单项配置
|
|
1019
1056
|
*/
|
|
1020
|
-
export declare type EditorMenuEntryConfig<TName extends
|
|
1057
|
+
export declare type EditorMenuEntryConfig<TName extends EditorMenuName> = TName extends Record<string, EditorMenuName[]> ? EditorMenuEntryMenuItemConfig<string & keyof TName, TName[keyof TName]> : TName extends string ? EditorMenuHiddenMenuItemConfig<TName> | EditorMenuButtonMenuItemConfig<TName> | EditorMenuLinkMenuItemConfig<TName> | EditorMenuEntryMenuItemConfig<TName, never> : never;
|
|
1021
1058
|
|
|
1022
1059
|
/**
|
|
1023
1060
|
* 子菜单入口配置
|
|
1061
|
+
* TName: 菜单项名称(字符串类型)
|
|
1062
|
+
* TChildName: 子菜单项名称数组类型,用于配置下一级菜单项
|
|
1024
1063
|
*/
|
|
1025
|
-
export declare interface EditorMenuEntryMenuItemConfig<TName extends string> extends EditorMenuBaseMenuItemConfig<TName> {
|
|
1064
|
+
export declare interface EditorMenuEntryMenuItemConfig<TName extends string, TChildName extends EditorMenuName[]> extends EditorMenuBaseMenuItemConfig<TName> {
|
|
1026
1065
|
type: 'entry';
|
|
1027
1066
|
/**
|
|
1028
1067
|
* 是否禁用菜单项,禁用后菜单项依旧显示不过变为灰色,不可点击
|
|
@@ -1040,8 +1079,9 @@ export declare interface EditorMenuEntryMenuItemConfig<TName extends string> ext
|
|
|
1040
1079
|
/**
|
|
1041
1080
|
* 下一级菜单配置,下一级菜单配置项和上一级相同
|
|
1042
1081
|
* 如果下一级仍然是 entry 类型,可以无限向下扩展
|
|
1082
|
+
* 只有当 TName 是对象类型时才应有子菜单
|
|
1043
1083
|
*/
|
|
1044
|
-
children?: EditorMenuEntryConfig<
|
|
1084
|
+
children?: TChildName extends EditorMenuName[] ? EditorMenuEntryConfig<TChildName[number]>[] : never;
|
|
1045
1085
|
}
|
|
1046
1086
|
|
|
1047
1087
|
/**
|
|
@@ -1106,11 +1146,18 @@ export declare interface EditorMenuLinkMenuItemConfig<TName extends string> exte
|
|
|
1106
1146
|
url?: string;
|
|
1107
1147
|
}
|
|
1108
1148
|
|
|
1149
|
+
/**
|
|
1150
|
+
* 菜单项名称类型
|
|
1151
|
+
* 可以是字符串或包含子菜单数组的对象
|
|
1152
|
+
* 如: 'copy' 或 { pasteMenu: ['pasteAll', 'pasteHead', 'pasteValueOnly'] }
|
|
1153
|
+
*/
|
|
1154
|
+
export declare type EditorMenuName = string | Record<string, EditorMenuName[]>;
|
|
1155
|
+
|
|
1109
1156
|
/**
|
|
1110
1157
|
* 菜单栏相关配置,目前菜单栏不是所有套件都支持,
|
|
1111
1158
|
* 菜单栏是指的编辑器最上放可以展开二级菜单的那一栏。
|
|
1112
1159
|
*/
|
|
1113
|
-
export declare interface EditorMenuOptions<TName extends
|
|
1160
|
+
export declare interface EditorMenuOptions<TName extends EditorMenuName> {
|
|
1114
1161
|
/**
|
|
1115
1162
|
* 菜单栏是否隐藏,设置为true, 则整个菜单栏不显示
|
|
1116
1163
|
*/
|
|
@@ -1121,13 +1168,15 @@ export declare interface EditorMenuOptions<TName extends string> {
|
|
|
1121
1168
|
disabled?: boolean;
|
|
1122
1169
|
/**
|
|
1123
1170
|
* 菜单栏一级菜单配置,指显示在菜单栏上的菜单项。
|
|
1171
|
+
* 支持普通菜单项和嵌套菜单项
|
|
1124
1172
|
*/
|
|
1125
1173
|
entries?: EditorMenuEntryConfig<TName>[];
|
|
1126
1174
|
/**
|
|
1127
1175
|
* 菜单栏功能按钮配置
|
|
1128
1176
|
* 更加间接的配置项
|
|
1177
|
+
* 仅在 TName 为字符串类型时有效
|
|
1129
1178
|
*/
|
|
1130
|
-
features?: Partial<Record<TName, EditorMenuFeatureConfig
|
|
1179
|
+
features?: TName extends string ? Partial<Record<TName, EditorMenuFeatureConfig>> : never;
|
|
1131
1180
|
/**
|
|
1132
1181
|
* 自定义按钮配置
|
|
1133
1182
|
*/
|
|
@@ -1241,6 +1290,10 @@ export declare interface EditorOptions {
|
|
|
1241
1290
|
* 导出设置
|
|
1242
1291
|
*/
|
|
1243
1292
|
export?: EditorExportOptions;
|
|
1293
|
+
/**
|
|
1294
|
+
* 导入相关设置
|
|
1295
|
+
*/
|
|
1296
|
+
import?: EditorImportOptions;
|
|
1244
1297
|
/**
|
|
1245
1298
|
* 解密设置
|
|
1246
1299
|
*/
|
|
@@ -1249,10 +1302,6 @@ export declare interface EditorOptions {
|
|
|
1249
1302
|
* 网络请求设置
|
|
1250
1303
|
*/
|
|
1251
1304
|
http?: HTTPProxy;
|
|
1252
|
-
/**
|
|
1253
|
-
* 编辑器渲染设置项
|
|
1254
|
-
*/
|
|
1255
|
-
render?: EditorRenderOptions;
|
|
1256
1305
|
/**
|
|
1257
1306
|
* 编辑器 UI 相关
|
|
1258
1307
|
*/
|
|
@@ -1380,13 +1429,6 @@ export declare interface EditorRemoteUploadableFile extends EditorBaseUploadable
|
|
|
1380
1429
|
raw?: never;
|
|
1381
1430
|
}
|
|
1382
1431
|
|
|
1383
|
-
export declare interface EditorRenderOptions {
|
|
1384
|
-
/**
|
|
1385
|
-
* 渲染的容器
|
|
1386
|
-
*/
|
|
1387
|
-
container?: HTMLElement;
|
|
1388
|
-
}
|
|
1389
|
-
|
|
1390
1432
|
/**
|
|
1391
1433
|
* 编辑器通用接口
|
|
1392
1434
|
*/
|
package/types/docx.d.ts
CHANGED
|
@@ -264,7 +264,7 @@ export declare type DocxMenuEntryConfig<T extends EditorMenuItemType = EditorMen
|
|
|
264
264
|
/**
|
|
265
265
|
* 传统文档菜单栏内置功能按钮
|
|
266
266
|
*/
|
|
267
|
-
export declare type DocxMenuFeatureButtonName = 'file' | 'edit' | 'insert' | 'undo' | 'redo' | 'cut' | 'copy' | 'paste' | 'selectAll' | 'export' | 'saveTemplate' | 'viewHistory' | 'saveHistory' | 'exportWord' | 'exportImage' | 'exportPDF' | 'exportWPS' | 'exportImagePDF' | 'insertAttachment' | 'insertFilesFromDrive' | 'insertSignature' | 'insertImage' | 'insertImageFromLocal' | 'insertImageFromUrl';
|
|
267
|
+
export declare type DocxMenuFeatureButtonName = 'file' | 'edit' | 'view' | 'insert' | 'format' | 'design' | 'transform-file' | 'plugins' | 'undo' | 'redo' | 'cut' | 'copy' | 'paste' | 'selectAll' | 'export' | 'saveTemplate' | 'viewHistory' | 'saveHistory' | 'exportWord' | 'exportImage' | 'exportPDF' | 'exportWPS' | 'exportImagePDF' | 'insertAttachment' | 'insertFilesFromDrive' | 'insertSignature' | 'insertImage' | 'insertImageFromLocal' | 'insertImageFromUrl' | 'enableEditingRestriction';
|
|
268
268
|
|
|
269
269
|
export declare type DocxMenuFeatureConfig = EditorMenuFeatureConfig;
|
|
270
270
|
|
|
@@ -1405,6 +1405,10 @@ export declare interface EditorCollaborationOptions {
|
|
|
1405
1405
|
* 是否使用严格的长度校验规则,默认关闭,在开启后如果出现长度校验失败会立刻禁止编辑器继续编写,并将保存状态设置为错误状态
|
|
1406
1406
|
*/
|
|
1407
1407
|
strictCLC?: boolean;
|
|
1408
|
+
/**
|
|
1409
|
+
* 版本号, 需通过内容接口response header获取
|
|
1410
|
+
*/
|
|
1411
|
+
rev: MaybePromiseValue<number>;
|
|
1408
1412
|
}
|
|
1409
1413
|
|
|
1410
1414
|
/**
|
|
@@ -1580,7 +1584,7 @@ export declare interface EditorDecryptionOptions {
|
|
|
1580
1584
|
* @param buffer - 需要解密的二进制数据
|
|
1581
1585
|
* @returns 解密后的二进制数据
|
|
1582
1586
|
*/
|
|
1583
|
-
|
|
1587
|
+
decryptFile?: (buffer: ArrayBuffer) => ArrayBuffer;
|
|
1584
1588
|
}
|
|
1585
1589
|
|
|
1586
1590
|
export declare interface EditorDelta {
|
|
@@ -1824,6 +1828,37 @@ export declare interface EditorI18nOptions {
|
|
|
1824
1828
|
|
|
1825
1829
|
export declare type EditorImageCropPoint = 'nw' | 'north' | 'ne' | 'west' | 'center' | 'east' | 'sw' | 'south' | 'se';
|
|
1826
1830
|
|
|
1831
|
+
export declare interface EditorImportOptions {
|
|
1832
|
+
/**
|
|
1833
|
+
* 获取导入状态,没有contentUrl时需要显示导入进度
|
|
1834
|
+
* 待导入完成后再渲染
|
|
1835
|
+
*/
|
|
1836
|
+
getImportStatus?: () => Promise<{
|
|
1837
|
+
/**
|
|
1838
|
+
* 导入进度
|
|
1839
|
+
*/
|
|
1840
|
+
progress: number;
|
|
1841
|
+
/**
|
|
1842
|
+
* 导入中
|
|
1843
|
+
*/
|
|
1844
|
+
status: 'importing';
|
|
1845
|
+
} | {
|
|
1846
|
+
/**
|
|
1847
|
+
* 导入完成
|
|
1848
|
+
*/
|
|
1849
|
+
status: 'completed';
|
|
1850
|
+
} | {
|
|
1851
|
+
/**
|
|
1852
|
+
* 导入失败
|
|
1853
|
+
*/
|
|
1854
|
+
status: 'failed';
|
|
1855
|
+
/**
|
|
1856
|
+
* 导入失败错误信息
|
|
1857
|
+
*/
|
|
1858
|
+
errorMessage?: string;
|
|
1859
|
+
}>;
|
|
1860
|
+
}
|
|
1861
|
+
|
|
1827
1862
|
/**
|
|
1828
1863
|
* 链接配置,抽象打开链接等操作
|
|
1829
1864
|
*/
|
|
@@ -1913,14 +1948,18 @@ export declare interface EditorMenuButtonMenuItemConfig<TName extends string> ex
|
|
|
1913
1948
|
|
|
1914
1949
|
/**
|
|
1915
1950
|
* 编辑器菜单配置类型
|
|
1916
|
-
*
|
|
1951
|
+
* 根据 TName 类型的不同返回不同的菜单配置类型:
|
|
1952
|
+
* 1. 当 TName 是对象类型时(如 {pasteMenu: [...]}),会自动提取对象的键作为菜单名称
|
|
1953
|
+
* 2. 当 TName 是字符串时,返回普通菜单项配置
|
|
1917
1954
|
*/
|
|
1918
|
-
export declare type EditorMenuEntryConfig<TName extends
|
|
1955
|
+
export declare type EditorMenuEntryConfig<TName extends EditorMenuName> = TName extends Record<string, EditorMenuName[]> ? EditorMenuEntryMenuItemConfig<string & keyof TName, TName[keyof TName]> : TName extends string ? EditorMenuHiddenMenuItemConfig<TName> | EditorMenuButtonMenuItemConfig<TName> | EditorMenuLinkMenuItemConfig<TName> | EditorMenuEntryMenuItemConfig<TName, never> : never;
|
|
1919
1956
|
|
|
1920
1957
|
/**
|
|
1921
1958
|
* 子菜单入口配置
|
|
1959
|
+
* TName: 菜单项名称(字符串类型)
|
|
1960
|
+
* TChildName: 子菜单项名称数组类型,用于配置下一级菜单项
|
|
1922
1961
|
*/
|
|
1923
|
-
export declare interface EditorMenuEntryMenuItemConfig<TName extends string> extends EditorMenuBaseMenuItemConfig<TName> {
|
|
1962
|
+
export declare interface EditorMenuEntryMenuItemConfig<TName extends string, TChildName extends EditorMenuName[]> extends EditorMenuBaseMenuItemConfig<TName> {
|
|
1924
1963
|
type: 'entry';
|
|
1925
1964
|
/**
|
|
1926
1965
|
* 是否禁用菜单项,禁用后菜单项依旧显示不过变为灰色,不可点击
|
|
@@ -1938,8 +1977,9 @@ export declare interface EditorMenuEntryMenuItemConfig<TName extends string> ext
|
|
|
1938
1977
|
/**
|
|
1939
1978
|
* 下一级菜单配置,下一级菜单配置项和上一级相同
|
|
1940
1979
|
* 如果下一级仍然是 entry 类型,可以无限向下扩展
|
|
1980
|
+
* 只有当 TName 是对象类型时才应有子菜单
|
|
1941
1981
|
*/
|
|
1942
|
-
children?: EditorMenuEntryConfig<
|
|
1982
|
+
children?: TChildName extends EditorMenuName[] ? EditorMenuEntryConfig<TChildName[number]>[] : never;
|
|
1943
1983
|
}
|
|
1944
1984
|
|
|
1945
1985
|
/**
|
|
@@ -2004,11 +2044,18 @@ export declare interface EditorMenuLinkMenuItemConfig<TName extends string> exte
|
|
|
2004
2044
|
url?: string;
|
|
2005
2045
|
}
|
|
2006
2046
|
|
|
2047
|
+
/**
|
|
2048
|
+
* 菜单项名称类型
|
|
2049
|
+
* 可以是字符串或包含子菜单数组的对象
|
|
2050
|
+
* 如: 'copy' 或 { pasteMenu: ['pasteAll', 'pasteHead', 'pasteValueOnly'] }
|
|
2051
|
+
*/
|
|
2052
|
+
export declare type EditorMenuName = string | Record<string, EditorMenuName[]>;
|
|
2053
|
+
|
|
2007
2054
|
/**
|
|
2008
2055
|
* 菜单栏相关配置,目前菜单栏不是所有套件都支持,
|
|
2009
2056
|
* 菜单栏是指的编辑器最上放可以展开二级菜单的那一栏。
|
|
2010
2057
|
*/
|
|
2011
|
-
export declare interface EditorMenuOptions<TName extends
|
|
2058
|
+
export declare interface EditorMenuOptions<TName extends EditorMenuName> {
|
|
2012
2059
|
/**
|
|
2013
2060
|
* 菜单栏是否隐藏,设置为true, 则整个菜单栏不显示
|
|
2014
2061
|
*/
|
|
@@ -2019,13 +2066,15 @@ export declare interface EditorMenuOptions<TName extends string> {
|
|
|
2019
2066
|
disabled?: boolean;
|
|
2020
2067
|
/**
|
|
2021
2068
|
* 菜单栏一级菜单配置,指显示在菜单栏上的菜单项。
|
|
2069
|
+
* 支持普通菜单项和嵌套菜单项
|
|
2022
2070
|
*/
|
|
2023
2071
|
entries?: EditorMenuEntryConfig<TName>[];
|
|
2024
2072
|
/**
|
|
2025
2073
|
* 菜单栏功能按钮配置
|
|
2026
2074
|
* 更加间接的配置项
|
|
2075
|
+
* 仅在 TName 为字符串类型时有效
|
|
2027
2076
|
*/
|
|
2028
|
-
features?: Partial<Record<TName, EditorMenuFeatureConfig
|
|
2077
|
+
features?: TName extends string ? Partial<Record<TName, EditorMenuFeatureConfig>> : never;
|
|
2029
2078
|
/**
|
|
2030
2079
|
* 自定义按钮配置
|
|
2031
2080
|
*/
|
|
@@ -2139,6 +2188,10 @@ export declare interface EditorOptions {
|
|
|
2139
2188
|
* 导出设置
|
|
2140
2189
|
*/
|
|
2141
2190
|
export?: EditorExportOptions;
|
|
2191
|
+
/**
|
|
2192
|
+
* 导入相关设置
|
|
2193
|
+
*/
|
|
2194
|
+
import?: EditorImportOptions;
|
|
2142
2195
|
/**
|
|
2143
2196
|
* 解密设置
|
|
2144
2197
|
*/
|
|
@@ -2147,10 +2200,6 @@ export declare interface EditorOptions {
|
|
|
2147
2200
|
* 网络请求设置
|
|
2148
2201
|
*/
|
|
2149
2202
|
http?: HTTPProxy;
|
|
2150
|
-
/**
|
|
2151
|
-
* 编辑器渲染设置项
|
|
2152
|
-
*/
|
|
2153
|
-
render?: EditorRenderOptions;
|
|
2154
2203
|
/**
|
|
2155
2204
|
* 编辑器 UI 相关
|
|
2156
2205
|
*/
|
|
@@ -2278,13 +2327,6 @@ export declare interface EditorRemoteUploadableFile extends EditorBaseUploadable
|
|
|
2278
2327
|
raw?: never;
|
|
2279
2328
|
}
|
|
2280
2329
|
|
|
2281
|
-
export declare interface EditorRenderOptions {
|
|
2282
|
-
/**
|
|
2283
|
-
* 渲染的容器
|
|
2284
|
-
*/
|
|
2285
|
-
container?: HTMLElement;
|
|
2286
|
-
}
|
|
2287
|
-
|
|
2288
2330
|
/**
|
|
2289
2331
|
* 编辑器通用接口
|
|
2290
2332
|
*/
|
package/types/pdf.d.ts
CHANGED
|
@@ -353,6 +353,10 @@ export declare interface EditorCollaborationOptions {
|
|
|
353
353
|
* 是否使用严格的长度校验规则,默认关闭,在开启后如果出现长度校验失败会立刻禁止编辑器继续编写,并将保存状态设置为错误状态
|
|
354
354
|
*/
|
|
355
355
|
strictCLC?: boolean;
|
|
356
|
+
/**
|
|
357
|
+
* 版本号, 需通过内容接口response header获取
|
|
358
|
+
*/
|
|
359
|
+
rev: MaybePromiseValue<number>;
|
|
356
360
|
}
|
|
357
361
|
|
|
358
362
|
/**
|
|
@@ -528,7 +532,7 @@ export declare interface EditorDecryptionOptions {
|
|
|
528
532
|
* @param buffer - 需要解密的二进制数据
|
|
529
533
|
* @returns 解密后的二进制数据
|
|
530
534
|
*/
|
|
531
|
-
|
|
535
|
+
decryptFile?: (buffer: ArrayBuffer) => ArrayBuffer;
|
|
532
536
|
}
|
|
533
537
|
|
|
534
538
|
export declare interface EditorDelta {
|
|
@@ -772,6 +776,37 @@ export declare interface EditorI18nOptions {
|
|
|
772
776
|
|
|
773
777
|
export declare type EditorImageCropPoint = 'nw' | 'north' | 'ne' | 'west' | 'center' | 'east' | 'sw' | 'south' | 'se';
|
|
774
778
|
|
|
779
|
+
export declare interface EditorImportOptions {
|
|
780
|
+
/**
|
|
781
|
+
* 获取导入状态,没有contentUrl时需要显示导入进度
|
|
782
|
+
* 待导入完成后再渲染
|
|
783
|
+
*/
|
|
784
|
+
getImportStatus?: () => Promise<{
|
|
785
|
+
/**
|
|
786
|
+
* 导入进度
|
|
787
|
+
*/
|
|
788
|
+
progress: number;
|
|
789
|
+
/**
|
|
790
|
+
* 导入中
|
|
791
|
+
*/
|
|
792
|
+
status: 'importing';
|
|
793
|
+
} | {
|
|
794
|
+
/**
|
|
795
|
+
* 导入完成
|
|
796
|
+
*/
|
|
797
|
+
status: 'completed';
|
|
798
|
+
} | {
|
|
799
|
+
/**
|
|
800
|
+
* 导入失败
|
|
801
|
+
*/
|
|
802
|
+
status: 'failed';
|
|
803
|
+
/**
|
|
804
|
+
* 导入失败错误信息
|
|
805
|
+
*/
|
|
806
|
+
errorMessage?: string;
|
|
807
|
+
}>;
|
|
808
|
+
}
|
|
809
|
+
|
|
775
810
|
/**
|
|
776
811
|
* 链接配置,抽象打开链接等操作
|
|
777
812
|
*/
|
|
@@ -861,14 +896,18 @@ export declare interface EditorMenuButtonMenuItemConfig<TName extends string> ex
|
|
|
861
896
|
|
|
862
897
|
/**
|
|
863
898
|
* 编辑器菜单配置类型
|
|
864
|
-
*
|
|
899
|
+
* 根据 TName 类型的不同返回不同的菜单配置类型:
|
|
900
|
+
* 1. 当 TName 是对象类型时(如 {pasteMenu: [...]}),会自动提取对象的键作为菜单名称
|
|
901
|
+
* 2. 当 TName 是字符串时,返回普通菜单项配置
|
|
865
902
|
*/
|
|
866
|
-
export declare type EditorMenuEntryConfig<TName extends
|
|
903
|
+
export declare type EditorMenuEntryConfig<TName extends EditorMenuName> = TName extends Record<string, EditorMenuName[]> ? EditorMenuEntryMenuItemConfig<string & keyof TName, TName[keyof TName]> : TName extends string ? EditorMenuHiddenMenuItemConfig<TName> | EditorMenuButtonMenuItemConfig<TName> | EditorMenuLinkMenuItemConfig<TName> | EditorMenuEntryMenuItemConfig<TName, never> : never;
|
|
867
904
|
|
|
868
905
|
/**
|
|
869
906
|
* 子菜单入口配置
|
|
907
|
+
* TName: 菜单项名称(字符串类型)
|
|
908
|
+
* TChildName: 子菜单项名称数组类型,用于配置下一级菜单项
|
|
870
909
|
*/
|
|
871
|
-
export declare interface EditorMenuEntryMenuItemConfig<TName extends string> extends EditorMenuBaseMenuItemConfig<TName> {
|
|
910
|
+
export declare interface EditorMenuEntryMenuItemConfig<TName extends string, TChildName extends EditorMenuName[]> extends EditorMenuBaseMenuItemConfig<TName> {
|
|
872
911
|
type: 'entry';
|
|
873
912
|
/**
|
|
874
913
|
* 是否禁用菜单项,禁用后菜单项依旧显示不过变为灰色,不可点击
|
|
@@ -886,8 +925,9 @@ export declare interface EditorMenuEntryMenuItemConfig<TName extends string> ext
|
|
|
886
925
|
/**
|
|
887
926
|
* 下一级菜单配置,下一级菜单配置项和上一级相同
|
|
888
927
|
* 如果下一级仍然是 entry 类型,可以无限向下扩展
|
|
928
|
+
* 只有当 TName 是对象类型时才应有子菜单
|
|
889
929
|
*/
|
|
890
|
-
children?: EditorMenuEntryConfig<
|
|
930
|
+
children?: TChildName extends EditorMenuName[] ? EditorMenuEntryConfig<TChildName[number]>[] : never;
|
|
891
931
|
}
|
|
892
932
|
|
|
893
933
|
/**
|
|
@@ -952,11 +992,18 @@ export declare interface EditorMenuLinkMenuItemConfig<TName extends string> exte
|
|
|
952
992
|
url?: string;
|
|
953
993
|
}
|
|
954
994
|
|
|
995
|
+
/**
|
|
996
|
+
* 菜单项名称类型
|
|
997
|
+
* 可以是字符串或包含子菜单数组的对象
|
|
998
|
+
* 如: 'copy' 或 { pasteMenu: ['pasteAll', 'pasteHead', 'pasteValueOnly'] }
|
|
999
|
+
*/
|
|
1000
|
+
export declare type EditorMenuName = string | Record<string, EditorMenuName[]>;
|
|
1001
|
+
|
|
955
1002
|
/**
|
|
956
1003
|
* 菜单栏相关配置,目前菜单栏不是所有套件都支持,
|
|
957
1004
|
* 菜单栏是指的编辑器最上放可以展开二级菜单的那一栏。
|
|
958
1005
|
*/
|
|
959
|
-
export declare interface EditorMenuOptions<TName extends
|
|
1006
|
+
export declare interface EditorMenuOptions<TName extends EditorMenuName> {
|
|
960
1007
|
/**
|
|
961
1008
|
* 菜单栏是否隐藏,设置为true, 则整个菜单栏不显示
|
|
962
1009
|
*/
|
|
@@ -967,13 +1014,15 @@ export declare interface EditorMenuOptions<TName extends string> {
|
|
|
967
1014
|
disabled?: boolean;
|
|
968
1015
|
/**
|
|
969
1016
|
* 菜单栏一级菜单配置,指显示在菜单栏上的菜单项。
|
|
1017
|
+
* 支持普通菜单项和嵌套菜单项
|
|
970
1018
|
*/
|
|
971
1019
|
entries?: EditorMenuEntryConfig<TName>[];
|
|
972
1020
|
/**
|
|
973
1021
|
* 菜单栏功能按钮配置
|
|
974
1022
|
* 更加间接的配置项
|
|
1023
|
+
* 仅在 TName 为字符串类型时有效
|
|
975
1024
|
*/
|
|
976
|
-
features?: Partial<Record<TName, EditorMenuFeatureConfig
|
|
1025
|
+
features?: TName extends string ? Partial<Record<TName, EditorMenuFeatureConfig>> : never;
|
|
977
1026
|
/**
|
|
978
1027
|
* 自定义按钮配置
|
|
979
1028
|
*/
|
|
@@ -1087,6 +1136,10 @@ export declare interface EditorOptions {
|
|
|
1087
1136
|
* 导出设置
|
|
1088
1137
|
*/
|
|
1089
1138
|
export?: EditorExportOptions;
|
|
1139
|
+
/**
|
|
1140
|
+
* 导入相关设置
|
|
1141
|
+
*/
|
|
1142
|
+
import?: EditorImportOptions;
|
|
1090
1143
|
/**
|
|
1091
1144
|
* 解密设置
|
|
1092
1145
|
*/
|
|
@@ -1095,10 +1148,6 @@ export declare interface EditorOptions {
|
|
|
1095
1148
|
* 网络请求设置
|
|
1096
1149
|
*/
|
|
1097
1150
|
http?: HTTPProxy;
|
|
1098
|
-
/**
|
|
1099
|
-
* 编辑器渲染设置项
|
|
1100
|
-
*/
|
|
1101
|
-
render?: EditorRenderOptions;
|
|
1102
1151
|
/**
|
|
1103
1152
|
* 编辑器 UI 相关
|
|
1104
1153
|
*/
|
|
@@ -1226,13 +1275,6 @@ export declare interface EditorRemoteUploadableFile extends EditorBaseUploadable
|
|
|
1226
1275
|
raw?: never;
|
|
1227
1276
|
}
|
|
1228
1277
|
|
|
1229
|
-
export declare interface EditorRenderOptions {
|
|
1230
|
-
/**
|
|
1231
|
-
* 渲染的容器
|
|
1232
|
-
*/
|
|
1233
|
-
container?: HTMLElement;
|
|
1234
|
-
}
|
|
1235
|
-
|
|
1236
1278
|
/**
|
|
1237
1279
|
* 编辑器通用接口
|
|
1238
1280
|
*/
|