dochub-sdk 0.1.53 → 0.1.55

package/index.ts

@@ -9,10 +9,14 @@ export * from './interfaces/uicomponents';
 export * from './interfaces/editors';
 export * from './interfaces/datalake';
 export * from './interfaces/constructors';
-export * from './interfaces/contents';
+export * from './interfaces/providers';
 export * from './interfaces/objects';
 export * from './interfaces/ui';
 export * from './interfaces/localstorage';
+export * from './interfaces/eventbus';
+export * from './interfaces/router';
+export * from './interfaces/settings';
+export * from './interfaces/problems';
 
 export const DocHub: IDocHubCore = window['DocHub'];
 export const Vue2 = () => window['Vue'];

package/interfaces/core.ts

@@ -1,111 +1,76 @@
-import { IDocHubContentProvider } from './contents';
-import { IDocHubProtocol } from './protocols';
-import { IDocHubDocument } from './documents';
+import { IDocHubContentProviders } from './providers';
+import { IDocHubProtocols } from './protocols';
+import { IDocHubDocuments } from './documents';
 import { IDocHubEditors } from './editors';
 import { IDocHubDataLake } from './datalake';
 import { IDocHubConstructors } from './constructors';
 import { IDocHubObjects } from './objects';
 import { IDocHubUI } from './ui';
 import { IDocHubLocalStorage } from './localstorage';
+import { IDocHubEventBus } from './eventbus';
+import { IDocHubRouter } from './router';
+import { IDocHubSettings } from './settings';
+import { IDocHubProblems } from './problems';
 
-export interface IDocHubEnv {
-    [id: string]: string
-}
-
-export interface IDocHubProblems {
-    // Регистрирует ошибку в системе
-    emit(problem: Error, title?: string, uid?: string);
-}
-
-export interface IDocHubSettingsCollection {
-    [id: string]: any;
-}
-
-export interface IDocHubSettings {
-    // Регистрирует UI компонент настроек
-    //  component - VUE компонент
-    //  location  - размещение UI компонента в дереве настроек
-    //  tags      - массив тегов для поиска компонента настроек
-    registerUI(component: any, location: string, tags: string[]);
-
-    // Сохраняет структуру с настройками
-    //  settings    -   сохраняемая структура
-    push(settings: IDocHubSettingsCollection);
-
-    // Получает настройки 
-    //  fields      - требуемый массив полей
-    pull(fields: IDocHubSettingsCollection | string[]): IDocHubSettingsCollection;
-}
-
-export enum DocHubNavigateCommands {
-    back = '$_back_$',
-    root = '$_root_$'
-}
-
-export enum DocHubNavigateTarget {
-    blank = '_blank',
-    self = '_self',
-    parent = '_parent',
-    top = '_top'
-}
-
-export interface IDocHubRouter {
-    // Регистрирует роут в формате VUE2
-    registerRoute(route: object);
-    // Регистрирует middleware в формате VUE2
-    registerMiddleware(middleware: object);
-    // Указывает на какой роут перейти в DocHub
-    navigate(url: string | DocHubNavigateCommands, target?:DocHubNavigateTarget);
-}
-
-export interface IDocHubContentProviders {
-    // Возвращает контент-провайдер по типу контента
-    get(contentType: string): IDocHubContentProvider;
-    // Регистрирует контент-провайдер
-    register(contentType: string, provider: IDocHubContentProvider);
-    // Возвращает массив зарегистрированных типов 
-    fetch(): string[];
-}
-
-export interface IDocHubProtocols {
-    // Возвращает драйвер протокола по идентификатору
-    get(protocol: string): IDocHubProtocol;
-    // Регистрирует драйвер протокола
-    register(protocol: string, driver: IDocHubProtocol);
-    // Возвращает массив зарегистрированных протоколов 
-    fetch(): string[];
-}
-
-export interface IDocHubDocuments {
-    // Регистрирует тип документа
-    register(type: string, document: IDocHubDocument);
-    // Возвращает массив зарегистрированных типов документов 
-    fetch(): string[];
-}
-
-// Интерфейс внутренней шины событий 
-export interface IDocHubEventBus {
-    // Отправляет событие в шину
-    $emit(event: string, data: any);
-    // Монтирует слушателя в шину
-    $on(event: string, func: Function);
-    // Отмонтирует слушателя от шины
-    $off(event: string, func: Function);
-}
-
-// Главный интерфейс
+/**
+ * Интерфейс ядра
+ */
 export interface IDocHubCore {
-    problems: IDocHubProblems;                  // Проблемы
-    settings: IDocHubSettings;                  // Пользовательские настройки
-    localStore: IDocHubLocalStorage;            // Интерфейс локального хранилища
-    router: IDocHubRouter;                      // Работа с UI роутами
-    contentProviders: IDocHubContentProviders;  // Провайдеры контента
-    protocols: IDocHubProtocols;                // Протоколы доступа к данным
-    documents: IDocHubDocuments;                // Документы
-    editors: IDocHubEditors;                    // Редакторы
-    constructors: IDocHubConstructors;          // Конструкторы
-    ui: IDocHubUI;                              // UI порт
-    dataLake: IDocHubDataLake;                  // Интерфейс к архкоду
-    objects: IDocHubObjects;                    // Задекларированные объекты сущностей 
-    eventBus: IDocHubEventBus;                  // Внутренняя шина событий
+    /**
+     * Интерфейс регистрации возникающих проблем
+     */
+    problems: IDocHubProblems;
+    /**
+     * Пользовательские настройки
+     */
+    settings: IDocHubSettings;
+    /**
+     *  Интерфейс локального хранилища
+     */
+    localStore: IDocHubLocalStorage;
+    /**
+     * Работа с UI роутами
+     */
+    router: IDocHubRouter;
+    /**
+     * Провайдеры контента
+     */
+    contentProviders: IDocHubContentProviders; 
+    /**
+     * Протоколы доступа к данным
+     */
+    protocols: IDocHubProtocols;
+    /**
+     * Документы
+     */
+    documents: IDocHubDocuments;
+    /**
+     * Редакторы объектов
+     */
+    editors: IDocHubEditors;
+    /**
+     * Конструкторы объектов
+     */
+    constructors: IDocHubConstructors;    
+    /**
+     * UI порт
+     */
+    ui: IDocHubUI;
+    /**
+     * Интерфейс к архкоду
+     */
+    dataLake: IDocHubDataLake;                  
+    /**
+     * Задекларированные объекты сущностей 
+     */
+    objects: IDocHubObjects;                   
+    /**
+     * Внутренняя шина событий
+     */
+    eventBus: IDocHubEventBus;                 
+    /**
+     * Версия ядра
+     * @returns     - Версия ядра в формате *.*.*
+     */
+    version(): string;
 }

package/interfaces/datalake.ts

@@ -32,8 +32,29 @@ export interface IDocHubPullDataParams  {
     [key: string]: any;
 }
 
+// Контекст транзации
+export interface IDocHubTransaction {
+
+}
+
 // Интерфейс доступа к DataLake
 export interface IDocHubDataLake {
+    /**
+     * Открывает транзакцию на изменения в DataLake
+     * @returns             - Объект транзакции
+     */
+    beginTransaction(): Promise<IDocHubTransaction>;
+    /**
+     * Отправляет транзакцию в DataLake
+     * @param transaction   - Объект транзакции
+     */
+    commitTransaction(transaction: IDocHubTransaction): Promise<IDocHubTransaction>;
+    /**
+     * Отменяет транзакцию
+     * @param transaction   - Объект транзакции
+     */
+    rollbackTransaction(transaction: IDocHubTransaction): Promise<IDocHubTransaction>;
+
     // Монтирует ресурс в озера
     //  uri         - URI монтируемого ресурса
     mount(uri: string);

package/interfaces/documents.ts

@@ -1,3 +1,23 @@
+/**
+ *  Интерфейс, который требуется реализовать объектам документов
+ */
 export interface IDocHubDocument {
     
+}
+
+/**
+ * Интерфейс управления документами
+ */
+export interface IDocHubDocuments {
+    /**
+     * Регистрирует тип документа
+     * @param type      - Тип документа. Например "markdown"
+     * @param document  - Объект реализующий документ
+     */
+    register(type: string, document: IDocHubDocument);
+    /**
+     * Возвращает массив зарегистрированных типов документов 
+     * @returns         - Массив зарегистрированных типов документов
+     */
+    fetch(): string[];
 }

package/interfaces/eventbus.ts

@@ -0,0 +1,23 @@
+/**
+ * Интерфейс внутренней шины событий 
+ */
+export interface IDocHubEventBus {
+    /**
+     * Отправляет событие в шину
+     * @param event     - Идентификатор события
+     * @param data      - Данные события
+     */
+    $emit(event: string, data: any);
+    /**
+     * Монтирует слушателя в шину
+     * @param event     - Идентификатор события
+     * @param func      - Обработчик события
+     */
+    $on(event: string, func: Function);
+    /**
+     * Отмонтирует слушателя от шины
+     * @param event     - Идентификатор события
+     * @param func      - Обработчик события
+     */
+    $off(event: string, func: Function);
+}

package/interfaces/problems.ts

@@ -0,0 +1,4 @@
+export interface IDocHubProblems {
+    // Регистрирует ошибку в системе
+    emit(problem: Error, title?: string, uid?: string);
+}

package/interfaces/protocols.ts

@@ -7,7 +7,9 @@ export interface IDocHubProtocolRequestConfig extends AxiosRequestConfig {
 };
 export interface IDocHubProtocolResponse extends AxiosResponse {};
 
-// Методы доступные над ресурсом
+/**
+ * Методы доступные над ресурсом
+ */
 export enum IDocHubProtocolMethods {
     GET = 'GET',
     POST = 'POST',
@@ -30,4 +32,27 @@ export interface IDocHubProtocol {
     request(config: IDocHubProtocolRequestConfig): Promise<IDocHubProtocolResponse>;
     // Возвращает список методов доступных для указанного ресурса
     availableMethodsFor(uri: string): Promise<IDocHubProtocolMethods[]>;
+}
+
+/**
+ * Интерфейс управления транспортными протоколами ресурсов
+ */
+export interface IDocHubProtocols {
+    /**
+     * Возвращает драйвер протокола по идентификатору
+     * @param protocol  - Идентификатор протокола. Например, "gitlab"
+     * @returns         - Возвращает драйвер протокола
+     */
+    get(protocol: string): IDocHubProtocol;
+    /**
+     * Регистрирует драйвер протокола
+     * @param protocol  - Идентификатор протокола. Например, "gitlab"
+     * @param driver    - Объект драйвера протокола
+     */
+    register(protocol: string, driver: IDocHubProtocol);
+    /**
+     * Возвращает массив зарегистрированных протоколов 
+     * @returns         - Массив идентификаторов протоколов
+     */
+    fetch(): string[];
 }

package/interfaces/providers.ts

@@ -0,0 +1,56 @@
+import { IDocHubContext } from './contexts';
+import { IDataLakeChange } from './datalake';
+
+/**
+ * Интерфейс, который должен реализовывать провайдер данных
+ */
+export interface IDocHubContentProvider {
+    /**
+     * Флаг активности провайдера
+     * @returns     - возвращает true если провайдер активен
+     */
+    isActive(): boolean; 
+    /**
+     * Вызывается ядром для инициализация провайдера
+     * @param context   - Контекст функционирования драйвера
+     */
+    bootstrap(context: IDocHubContext);
+    /**
+     * Конвертация контента в объекты DataLake
+     * @param content   - Контент в формате обрабатываемом драйвером
+     * @returns         - Объект DataLake
+     */
+    toObject(content: any): any;
+    /**
+     * Конвертация объектов в контент для хранения
+     * @param data      - Объект DataLake
+     * @returns         - Контент в формате обрабатываемом драйвером
+     */
+    toContent(data: any): any;
+    /**
+     * Вносит изменения из ченж-лога в контент
+     * @param content   - Контент в формате обрабатываемом драйвером
+     * @param changes   - Список изменений, который требуется внести в контент
+     */
+    mutation(content: string, changes: IDataLakeChange[]): string;
+}
+
+export interface IDocHubContentProviders {
+    /**
+     * Возвращает контент-провайдер по типу контента
+     * @param contentType   - Тип контента
+     * @returns             - Объект драйвера провайдера
+     */
+    get(contentType: string): IDocHubContentProvider;
+    /**
+     * Регистрация контент-провайдера
+     * @param contentType   - Типа контента. Например, "yaml"
+     * @param provider      - Объект контент-провайдера
+     */
+    register(contentType: string, provider: IDocHubContentProvider);
+    /**
+     * Возвращает массив зарегистрированных типов 
+     * @returns             - Массив зарегистрированных типов контента
+     */
+    fetch(): string[];
+}

package/interfaces/router.ts

@@ -0,0 +1,20 @@
+export enum DocHubNavigateCommands {
+    back = '$_back_$',
+    root = '$_root_$'
+}
+
+export enum DocHubNavigateTarget {
+    blank = '_blank',
+    self = '_self',
+    parent = '_parent',
+    top = '_top'
+}
+
+export interface IDocHubRouter {
+    // Регистрирует роут в формате VUE2
+    registerRoute(route: object);
+    // Регистрирует middleware в формате VUE2
+    registerMiddleware(middleware: object);
+    // Указывает на какой роут перейти в DocHub
+    navigate(url: string | DocHubNavigateCommands, target?:DocHubNavigateTarget);
+}

package/interfaces/settings.ts

@@ -0,0 +1,19 @@
+export interface IDocHubSettingsCollection {
+    [id: string]: any;
+}
+
+export interface IDocHubSettings {
+    // Регистрирует UI компонент настроек
+    //  component - VUE компонент
+    //  location  - размещение UI компонента в дереве настроек
+    //  tags      - массив тегов для поиска компонента настроек
+    registerUI(component: any, location: string, tags: string[]);
+
+    // Сохраняет структуру с настройками
+    //  settings    -   сохраняемая структура
+    push(settings: IDocHubSettingsCollection);
+
+    // Получает настройки 
+    //  fields      - требуемый массив полей
+    pull(fields: IDocHubSettingsCollection | string[]): IDocHubSettingsCollection;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "dochub-sdk",
-  "version": "0.1.53",
+  "version": "0.1.55",
   "description": "The DocHub System Development Kit.",
   "private": false,
   "main": "index.ts",

package/interfaces/contents.ts

@@ -1,14 +0,0 @@
-import { IDocHubContext } from './contexts';
-import { IDataLakeChange } from './datalake';
-export interface IDocHubContentProvider {
-    // Флаг активности провайдера
-    isActive(): boolean; 
-    // Инициализация провайдера
-    bootstrap(context: IDocHubContext);
-    // Конвертация контента в объекты DataLake
-    toObject(content: any): any;
-    // Конвертация объектов в контент для хранения
-    toContent(data: any): any;
-    // Вносит изменения из ченж-лога
-    mutation(content: string, changes: IDataLakeChange[]): string;
-}