dochub-sdk 0.1.118 → 0.1.120
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 +7 -0
- package/interfaces/editors.ts +16 -0
- package/interfaces/presentations.ts +23 -1
- package/package.json +1 -1
package/interfaces/core.ts
CHANGED
|
@@ -12,6 +12,7 @@ import { IDocHubSettings } from './settings';
|
|
|
12
12
|
import { IDocHubProblems } from './problems';
|
|
13
13
|
import { IDocHubCollaboration } from './collaborations';
|
|
14
14
|
import { DocHubEditMode, IDocHubEditors } from './editors';
|
|
15
|
+
import { IDocHubPresentations } from './presentations';
|
|
15
16
|
|
|
16
17
|
/**
|
|
17
18
|
* Интерфейс ядра
|
|
@@ -42,9 +43,15 @@ export interface IDocHubCore {
|
|
|
42
43
|
*/
|
|
43
44
|
protocols: IDocHubProtocols;
|
|
44
45
|
/**
|
|
46
|
+
* !!!!!!!!!!! УСТАРЕЛО !!!!!!!!!!!
|
|
47
|
+
* См presentations
|
|
45
48
|
* Документы
|
|
46
49
|
*/
|
|
47
50
|
documents: IDocHubDocuments;
|
|
51
|
+
/**
|
|
52
|
+
* Презентации сущностей
|
|
53
|
+
*/
|
|
54
|
+
presentations: IDocHubPresentations;
|
|
48
55
|
/**
|
|
49
56
|
* Конструкторы объектов
|
|
50
57
|
*/
|
package/interfaces/editors.ts
CHANGED
|
@@ -11,6 +11,22 @@ export enum DocHubEditMode {
|
|
|
11
11
|
view = 'view'
|
|
12
12
|
}
|
|
13
13
|
|
|
14
|
+
|
|
15
|
+
/**
|
|
16
|
+
* Если компонент имеет возможность контекстного редактирования, он должен реализовывать данный интерфейс
|
|
17
|
+
*/
|
|
18
|
+
export interface IDocHubEditableComponent {
|
|
19
|
+
/**
|
|
20
|
+
* Указывает на то, что компонент может быть отредактирован
|
|
21
|
+
* @returns - возвращает true если компонент может быть отредактирован, иначе false
|
|
22
|
+
*/
|
|
23
|
+
isEditable(): boolean;
|
|
24
|
+
/**
|
|
25
|
+
* Отправляет запрос на начало редактирования
|
|
26
|
+
*/
|
|
27
|
+
openEditor(): void;
|
|
28
|
+
}
|
|
29
|
+
|
|
14
30
|
/**
|
|
15
31
|
* События, которые должен обрабатывать редактор
|
|
16
32
|
*/
|
|
@@ -1,6 +1,16 @@
|
|
|
1
1
|
import { DocHubDataLakeRequest, DataLakePath } from './datalake';
|
|
2
2
|
import { IDocHubSchema } from './../schemas/basetypes';
|
|
3
3
|
|
|
4
|
+
/**
|
|
5
|
+
* Идентификатор типа презентации
|
|
6
|
+
*/
|
|
7
|
+
export type DocHubPresentationUID = string;
|
|
8
|
+
|
|
9
|
+
/**
|
|
10
|
+
* VUE компонент презентации
|
|
11
|
+
*/
|
|
12
|
+
export interface IDocHubPresentationComponent {}
|
|
13
|
+
|
|
4
14
|
/**
|
|
5
15
|
* Входящие параметры в презентацию
|
|
6
16
|
*/
|
|
@@ -28,9 +38,21 @@ export interface IDocHubPresentationProfile {
|
|
|
28
38
|
$base: DataLakePath
|
|
29
39
|
}
|
|
30
40
|
|
|
31
|
-
|
|
32
41
|
/**
|
|
33
42
|
* Интерфейс управления презентациями сущностей
|
|
34
43
|
*/
|
|
35
44
|
export interface IDocHubPresentations {
|
|
45
|
+
/**
|
|
46
|
+
* Регистрирует тип презентации
|
|
47
|
+
* @param type - Тип презентации. Например "markdown"
|
|
48
|
+
* @param component - VUE компонент презентации
|
|
49
|
+
* @param title - Название типа презентации для пользователя
|
|
50
|
+
*/
|
|
51
|
+
register(type: DocHubPresentationUID, component: IDocHubPresentationComponent, title?: string);
|
|
52
|
+
/**
|
|
53
|
+
* Возвращает компонент презентации по идентификатору типа
|
|
54
|
+
* @param type - Тип презентации. Например "markdown"
|
|
55
|
+
* @returns - VUE компонент для представления
|
|
56
|
+
*/
|
|
57
|
+
getComponentByType(type: DocHubPresentationUID): Promise<IDocHubPresentationComponent>;
|
|
36
58
|
}
|