dochub-sdk 0.1.100 → 0.1.102

package/index.ts

@@ -17,9 +17,11 @@ export * from './interfaces/eventbus';
 export * from './interfaces/router';
 export * from './interfaces/settings';
 export * from './interfaces/problems';
+export * from './interfaces/collabarations';
 export * from './schemas/basetypes';
 export * from './schemas/dochub-yaml';
 
+
 export const DocHub: IDocHubCore = window['DocHub'];
 export const Vue2 = () => window['Vue'];
 export const Vuetify2 = () => window['Vuetify'];

package/interfaces/collabarations.ts

@@ -0,0 +1,90 @@
+export type DocHubCollaborationInvite = string;
+
+export type DocHubCollaborationChannel = string;
+export type DocHubCollaborationEvent = string | RegExp;
+export type DocHubCollaborationChannelHandler = (channel: DocHubCollaborationChannel) => void;
+
+/**
+ *  Транспортный драйвер коллаборации
+ */
+export interface IDocHubCollaborationDriver {
+
+}
+
+/**
+ *  Сессия коллаборации
+ */
+export interface IDocHubCollaborationSession {
+
+}
+
+/**
+ *  Интерфейс реализующий коллаборативную работу групп
+ */
+export interface IDocHubCollaboration {
+    /**
+     *  Признак доступности режима коллаборации
+     *  @returns        - true если режим коллаборации доступен, иначе false
+     */
+    isAvailable(): Promise<boolean>;
+
+    /**
+     * Регистрирует коллаборативный драйвер. Возможен только один.
+     * Если драйвер уже зарегистрирован, метод должен генерировать ошибку.
+     * @param driver        - Драйвер
+     */
+    registerDriver(driver: IDocHubCollaborationDriver): Promise<void>;
+
+    /**
+     * Создает коллаборативную сессию
+     * @returns         - Открытая сессия
+     */
+    createSession(): Promise<IDocHubCollaborationSession>;
+
+    /**
+     * Возвращает текущую сессию, если она открыта
+     * @returns         - Текущая сессия или null
+     */
+    getSession(): Promise<IDocHubCollaborationSession | null>;
+
+    /**
+     * Покинуть коллаборативную сессию
+     */
+    liveSession(): Promise<void>;
+
+    /**
+     * Создает приглашение в виде URL для подключения к сессии
+     * @requires        - Инвайт в виде URL
+     */
+    makeInvite(): Promise<DocHubCollaborationInvite>;
+
+    /**
+     * Осуществляет вход по приглашению
+     * @requires        - Инвайт в виде URL
+     */
+    enter(invite: DocHubCollaborationInvite): Promise<IDocHubCollaborationSession>;
+
+    /**
+     * Осуществляет подписку на канал и события
+     * @param channel   - Канал, который будет слушать подписчик 
+     * @param events    - События, которые подписчик собирается обрабатывать
+     * @param handler   - Обработчик событий
+     */
+    subscribe(channel: DocHubCollaborationChannel, events: DocHubCollaborationEvent[], handler: DocHubCollaborationChannelHandler);
+
+    /**
+     * Отписывает слушателя
+     * @param channel   - Канал, от которого описывается слушатель
+     * @param events    - События, от которых описывается слушатель
+     * @param handler   - Обработчик событий
+     */
+    unsubscribe(channel: DocHubCollaborationChannel, events: DocHubCollaborationEvent[], handler: DocHubCollaborationChannelHandler);
+
+    /**
+     * Отсылает сообщение в канал
+     * @param channel   - Канал
+     * @param event     - Событие
+     * @param data      - Данные для обработки
+     */
+    sendEvent(channel: DocHubCollaborationChannel, event: DocHubCollaborationEvent, data: any): Promise<void>;
+}

package/interfaces/core.ts

@@ -10,6 +10,7 @@ import { IDocHubEventBus } from './eventbus';
 import { IDocHubRouter } from './router';
 import { IDocHubSettings } from './settings';
 import { IDocHubProblems } from './problems';
+import { IDocHubCollaboration } from './collabarations';
 import { DocHubEditMode, IDocHubEditors } from './editors';
 
 /**
@@ -68,6 +69,10 @@ export interface IDocHubCore {
      * Интерфейс взаимодействия с подсистемой редактирования
      */
     editors: IDocHubEditors;
+    /**
+     * Интерфейс коллаборативного взаимодействия
+     */
+    collaboration: IDocHubCollaboration;
     /**
      * Версия ядра
      * @returns     - Версия ядра в формате *.*.*

package/interfaces/datalake.ts

@@ -147,6 +147,11 @@ export interface IDocHubFileEditorContext {
     [key: string]: any;     // Произвольные ключи и значения
 }
 
+/**
+ *  Обработчик событий изменения файла
+ */
+export type DocHubDataLakeFileFollower = () => void;
+
 // Интерфейс доступа к DataLake
 export interface IDocHubDataLake {
     /**
@@ -229,6 +234,20 @@ export interface IDocHubDataLake {
      */
     pushFile(uri: string, content: any, contentType: string): Promise<AxiosResponse>;
 
+    /**
+     * Устанавливает слежение за изменениями в файле
+     * @param uri               - URI файла
+     * @param handler           - Обработчик события
+     */
+    followFile(uri: string, handler: DocHubDataLakeFileFollower);
+    
+    /**
+     * Отменяет слежение за файлом
+     * @param uri               - URI файла
+     * @param handler           - Обработчик события
+     */
+    unfollowFile(uri: string, handler: DocHubDataLakeFileFollower);
+
     /**
      * Загружает файл из DataLake
      * @param uri               - URI файла во внутреннем формате DocHub

package/package.json

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