dochub-sdk 0.1.16 → 0.1.17
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/core.ts +1 -13
- package/interfaces/datalake.ts +34 -0
- package/package.json +1 -1
package/interfaces/core.ts
CHANGED
|
@@ -3,6 +3,7 @@ import { IDocHubProtocol } from './protocol';
|
|
|
3
3
|
import { IDocHubDocument } from './document';
|
|
4
4
|
import { IDocHubEditor, EditorEvents } from './editor';
|
|
5
5
|
import { IDocHubUIComponent } from './uicomponent';
|
|
6
|
+
import { IDocHubDataLake } from './datalake';
|
|
6
7
|
|
|
7
8
|
export interface IDocHubEnv {
|
|
8
9
|
[id: string]: string
|
|
@@ -85,19 +86,6 @@ export interface IDocHubUI {
|
|
|
85
86
|
get(slot: string): IDocHubUIComponent[];
|
|
86
87
|
}
|
|
87
88
|
|
|
88
|
-
export interface IDocHubDataLake {
|
|
89
|
-
// Монтирует источник к загружаемым манифестам озера
|
|
90
|
-
// uri: string - URI монтируемого ресурса
|
|
91
|
-
mountManifest(uri: string);
|
|
92
|
-
// Отмонтирует источник к загружаемым манифестам озера
|
|
93
|
-
// uri: string - URI отключаемого ресурса
|
|
94
|
-
unmountManifest(uri: string);
|
|
95
|
-
// Требует перезагрузки ресурсов задействованных в озере данных
|
|
96
|
-
// uriPattern: array | RegEx | undefined - Шаблон проверки соответствия URI ресурса
|
|
97
|
-
// Если undefined - перезагружает все
|
|
98
|
-
reload(uriPattern?: string | string[] | RegExp);
|
|
99
|
-
}
|
|
100
|
-
|
|
101
89
|
// Главный интерфейс
|
|
102
90
|
export interface IDocHubCore {
|
|
103
91
|
problems: IDocHubProblems; // Проблемы
|
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
export enum DataLakeChange {
|
|
2
|
+
update = 'update', // Обновление данных по указанному пути
|
|
3
|
+
remove = 'remove', // Удаляет данные по указанному пути
|
|
4
|
+
};
|
|
5
|
+
|
|
6
|
+
// Хранит состояние редактора
|
|
7
|
+
export interface IDataLakeChange {
|
|
8
|
+
// Действие над DataLake
|
|
9
|
+
action: DataLakeChange;
|
|
10
|
+
// Путь в DataLake куда вносятся изменения
|
|
11
|
+
path: string;
|
|
12
|
+
// Данные, которые вносятся в DataLake
|
|
13
|
+
data: object | string | number | boolean;
|
|
14
|
+
// Комментарии в манифест, где изменения будут зафиксированы
|
|
15
|
+
comment: string;
|
|
16
|
+
}
|
|
17
|
+
|
|
18
|
+
// Интерфейс доступа к DataLake
|
|
19
|
+
export interface IDocHubDataLake {
|
|
20
|
+
// Монтирует источник к загружаемым манифестам озера
|
|
21
|
+
// uri - URI монтируемого ресурса
|
|
22
|
+
mountManifest(uri: string);
|
|
23
|
+
// Отмонтирует источник к загружаемым манифестам озера
|
|
24
|
+
// uri - URI отключаемого ресурса
|
|
25
|
+
unmountManifest(uri: string);
|
|
26
|
+
// Требует перезагрузки ресурсов задействованных в озере данных
|
|
27
|
+
// uriPattern - Шаблон проверки соответствия URI ресурса
|
|
28
|
+
// Если undefined - перезагружает все
|
|
29
|
+
reload(uriPattern?: string | string[] | RegExp);
|
|
30
|
+
// Внесение изменений в DataLake
|
|
31
|
+
// changes - Массив изменений в DataLake
|
|
32
|
+
pushChanges(changes: IDataLakeChange);
|
|
33
|
+
}
|
|
34
|
+
|