dochub-sdk 0.1.79 → 0.1.80
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/interfaces/datalake.ts +38 -22
- package/package.json +1 -1
package/interfaces/datalake.ts
CHANGED
|
@@ -16,7 +16,9 @@ export enum DataLakeEvents {
|
|
|
16
16
|
onChanged = 'datalake.reloading.onChange' // В DataLake произошли изменения
|
|
17
17
|
}
|
|
18
18
|
|
|
19
|
-
|
|
19
|
+
/**
|
|
20
|
+
* Запись об изменении DataLake
|
|
21
|
+
*/
|
|
20
22
|
export interface IDataLakeChange {
|
|
21
23
|
// Действие над DataLake
|
|
22
24
|
action: DataLakeChange;
|
|
@@ -38,16 +40,15 @@ export interface IDocHubTransaction {
|
|
|
38
40
|
}
|
|
39
41
|
|
|
40
42
|
/**
|
|
41
|
-
* VUE компонент редактора
|
|
43
|
+
* VUE компонент редактора файла
|
|
42
44
|
*/
|
|
43
|
-
export interface
|
|
44
|
-
}
|
|
45
|
+
export interface IDocHubFileEditorComponent {}
|
|
45
46
|
|
|
46
47
|
/**
|
|
47
|
-
* Метаинформация о редакторе
|
|
48
|
+
* Метаинформация о редакторе файла
|
|
48
49
|
*/
|
|
49
|
-
export interface
|
|
50
|
-
component:
|
|
50
|
+
export interface IDocHubFileEditorItem {
|
|
51
|
+
component: IDocHubFileEditorComponent;
|
|
51
52
|
pattern: RegExp;
|
|
52
53
|
title: string;
|
|
53
54
|
}
|
|
@@ -75,15 +76,15 @@ export interface IDocHubDataLake {
|
|
|
75
76
|
*/
|
|
76
77
|
getRootManifest(): string;
|
|
77
78
|
/**
|
|
78
|
-
* Монтирует произвольный
|
|
79
|
-
* @param uri - URI монтируемого
|
|
79
|
+
* Монтирует произвольный файл в DataLake
|
|
80
|
+
* @param uri - URI монтируемого файла
|
|
80
81
|
*/
|
|
81
82
|
mount(uri: string);
|
|
82
|
-
// Демонтирует
|
|
83
|
-
// uri - URI демонтируемого
|
|
83
|
+
// Демонтирует файл из DataLake
|
|
84
|
+
// uri - URI демонтируемого файла
|
|
84
85
|
unmount(uri: string);
|
|
85
|
-
// Требует перезагрузки
|
|
86
|
-
// uriPattern - Шаблон проверки соответствия URI
|
|
86
|
+
// Требует перезагрузки файла задействованных в озере данных
|
|
87
|
+
// uriPattern - Шаблон проверки соответствия URI файла
|
|
87
88
|
// Если undefined - перезагружает все
|
|
88
89
|
reload(uriPattern?: string | string[] | RegExp);
|
|
89
90
|
// Внесение изменений в DataLake
|
|
@@ -107,22 +108,37 @@ export interface IDocHubDataLake {
|
|
|
107
108
|
// Возвращает конечный URI на основании массива относительных и прямых URI
|
|
108
109
|
resolveURI(...uri: string[]): string;
|
|
109
110
|
/**
|
|
110
|
-
* Регистрирует редактор
|
|
111
|
-
* @param pattern - RegExp contentType
|
|
112
|
-
* @param component - VUE компонент для редактирования
|
|
113
|
-
* @param title - Название редактора
|
|
111
|
+
* Регистрирует редактор файлов
|
|
112
|
+
* @param pattern - RegExp contentType файла. Например: ^.*\/markdown($|;.*$)
|
|
113
|
+
* @param component - VUE компонент для редактирования файла
|
|
114
|
+
* @param title - Название редактора файла
|
|
114
115
|
*/
|
|
115
|
-
|
|
116
|
+
registerFileEditor(pattern: string, component: IDocHubFileEditorComponent, title?: string);
|
|
116
117
|
/**
|
|
117
|
-
* Возвращает массив зарегистрированных редакторов
|
|
118
|
+
* Возвращает массив зарегистрированных редакторов файлов
|
|
118
119
|
* @returns - Массив зарегистрированных редакторов объектов
|
|
119
120
|
*/
|
|
120
|
-
|
|
121
|
+
fetchFileEditors(): Promise<IDocHubFileEditorItem[]>;
|
|
121
122
|
/**
|
|
122
|
-
* Возвращает актуальный редактор для
|
|
123
|
+
* Возвращает актуальный редактор для файла по contentType
|
|
123
124
|
* @param contentType - Тип контента. Например: text/markdown
|
|
124
125
|
*/
|
|
125
|
-
|
|
126
|
+
getFileEditor(contentType: string): Promise<IDocHubFileEditorItem | null>;
|
|
127
|
+
|
|
128
|
+
/**
|
|
129
|
+
* Запрос на открытие файла на пользовательское редактирование. Не обязательно будет выполнен.
|
|
130
|
+
* Если редактор уже открыт, активирует его.
|
|
131
|
+
* @param uri - URI файла
|
|
132
|
+
* @returns - Компонент редактора, если открытие оказалось успешным
|
|
133
|
+
*/
|
|
134
|
+
openFileEditor(uri: string): Promise<IDocHubFileEditorComponent>;
|
|
135
|
+
|
|
136
|
+
/**
|
|
137
|
+
* Запрос на завершение пользовательского редактирования файла. Не обязательно будет выполнен.
|
|
138
|
+
* @param uri - URI файла
|
|
139
|
+
* @returns - true, если закрытие оказалось успешным
|
|
140
|
+
*/
|
|
141
|
+
closeFileEditor(uri: string): Promise<boolean>;
|
|
126
142
|
|
|
127
143
|
/**
|
|
128
144
|
* Регистрирует соответствие шаблона файла типу контента.
|