dochub-sdk 0.1.1 → 0.1.2

package/interfaces/content.ts

@@ -0,0 +1,4 @@
+import { IDocHubContext } from "./context";
+export interface IDocHubContentProvider {
+    bootstrap(context: IDocHubContext);
+}

package/interfaces/context.ts

@@ -0,0 +1,14 @@
+import { IDocHubCore } from "dochub-sdk/interfaces/core";
+
+// Интерфейс переменных среды исполнения
+export interface IDocHubContextEnv {
+    readonly [key: string]: any;
+}
+
+// Интерфейс контекста для выполнения плагина
+export interface IDocHubContext {
+    // Переменные среды
+    env: IDocHubContextEnv;
+    // Интерфейс к DocHub
+    dochub: IDocHubCore;
+}

package/interfaces/core.ts

@@ -0,0 +1,98 @@
+import { IDocHubContentProvider } from './content';
+import { IDocHubProtocol } from './protocol';
+import { IDocHubDocument } from './document';
+import { IDocHubUIComponent } from './uicomponent';
+
+
+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 interface IDocHubRouter {
+    // Регистрирует роут в формате VUE2
+    registerRoute(route: object);
+    // Регистрирует middleware в формате VUE2
+    registerMiddleware(middleware: object);
+}
+
+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 IDocHubUI {
+    // Регистрирует UI компонент в слоте
+    register(slot: string, component: IDocHubUIComponent);
+    // Возвращает зарегистрированный компонент по слоту
+    get(slot: string): IDocHubUIComponent[];
+}
+
+export interface IDocHubDataLake {
+    // Монтирует источник к загружаемым манифестам озера
+    //  uri: string     - URI монтируемого ресурса
+    mountManifest(uri: string);
+    // Отмонтирует источник к загружаемым манифестам озера
+    //  uri: string     - URI отключаемого ресурса
+    unmountManifest(uri: string);
+    // Требует перезагрузки ресурсов задействованных в озере данных
+    //  uriPattern: array | RegEx | undefined  - Шаблон проверки соответствия URI ресурса
+    //                                           Если undefined - перезагружает все
+    reload(uriPattern?: string | string[] | RegExp);
+}
+
+// Главный интерфейс
+export interface IDocHubCore {
+    problems: IDocHubProblems;                  // Проблемы
+    settings: IDocHubSettings;                  // Пользовтельские настройки
+    router: IDocHubRouter;                      // Работа с UI роутами
+    contentProviders: IDocHubContentProviders;  // Провайдеры контента
+    protocols: IDocHubProtocols;                // Протоколы доступа к данным
+    documents: IDocHubDocuments;                // Документы
+    ui: IDocHubUI;                              // UI порт
+    dataLake: IDocHubDataLake;                  // Интерфейс к архкоду
+}

package/interfaces/document.ts

@@ -0,0 +1,3 @@
+export interface IDocHubDocument {
+    
+}

package/interfaces/protocol.ts

@@ -0,0 +1,33 @@
+import { AxiosResponse, AxiosRequestConfig } from 'axios';
+import { IDocHubContext } from './context';
+
+// Прослойка интерфейсов Axios для последующей кастомизации и поддержания совместимости
+export interface IDocHubProtocolRequestConfig extends AxiosRequestConfig {
+    decoder?: Function;  // Декодировщик ответа
+};
+export interface IDocHubProtocolResponse extends AxiosResponse {};
+
+// Методы доступные над ресурсом
+export enum IDocHubProtocolMethods {
+    GET = 'GET',
+    POST = 'POST',
+    DELETE = 'DELETE',
+    HEAD = 'HEAD',
+    PUT = 'PUT',
+    PATCH = 'PATCH',
+    OPTIONS = 'OPTIONS'
+};
+
+// Интерфейс транспортного протокола
+export interface IDocHubProtocol {
+    // Признак активности протокола
+    isActive(): boolean;
+    // Метод инициализации протокола
+    bootstrap(context: IDocHubContext);
+    // Разрешение ссылок
+    resolveURL(...args: string[]): string;
+    // Выполняет запрос к DataLake
+    request(config: IDocHubProtocolRequestConfig): Promise<IDocHubProtocolResponse>;
+    // Возвращает список методов доступных для указанного ресурса
+    availableMethodsFor(uri: string): Promise<IDocHubProtocolMethods[]>;
+}

package/interfaces/uicomponent.ts

@@ -0,0 +1,3 @@
+export interface IDocHubUIComponent {
+    
+}

package/package.json

@@ -1,13 +1,10 @@
 {
   "name": "dochub-sdk",
-  "version": "0.1.1",
+  "version": "0.1.2",
   "description": "The DocHub System Development Kit.",
   "private": false,
   "main": "index.ts",
   "module": "index.ts",
-  "files": [
-    "."
-  ],
   "homepage": "https://dochub.info",
   "bin": {
     "dochub-cli": "cli/main.js"