dochub-sdk 0.1.155 → 0.1.157

package/classes/vue2/Documents.ts

@@ -0,0 +1,131 @@
+/* eslint-disable no-unused-vars */
+import { Vue, Prop, Watch, Component } from 'vue-property-decorator';
+import { DocHub, IDocHubEditableComponent, IDocHubPresentationProfile, IDocHubPresentationsParams } from '../..';
+
+import ajv from 'ajv';
+import ajv_localize from 'ajv-i18n/localize/ru';
+
+@Component
+export class DocHubDocumentProto extends Vue implements IDocHubEditableComponent {
+  onRefresher: any = null;          // Таймер отложенного выполнения обновления
+  followURI: string | null =  null; // URI файла за которым установлено слежение 
+  error: string | null = null;      // Ошибка 
+
+  /**
+   * Профиль документа
+   */
+  @Prop({
+    type: Object,
+    required: true
+  }) readonly profile: IDocHubPresentationProfile;
+
+  /**
+   * Параметры
+   */
+  @Prop({
+    type: Object,
+    default: {}
+  }) readonly params: IDocHubPresentationsParams;
+
+  /**
+   * Следим за изменением профиля документа
+   */
+  @Watch('profile') onProfileChanged() {
+    this.onRefresh();
+  }
+
+  /**
+   * Следим за изменением параметров
+   */
+  @Watch('params') onParamsChanged() {
+    this.onRefresh();
+  }
+
+  mounted() {
+    // При монтировании компонента в DOM, генерируем событие обновления
+    this.onRefresh();
+  }
+
+  destroyed() {
+    // Отключаем слежку за файлом
+    this.refreshFileFollow(true);
+  }
+
+  /**
+   * Подтверждаем, что презентация может редактироваться
+   * @returns 
+   */
+  isEditable(): boolean {
+    return true;
+  }
+  /**
+   * Открываем редактор
+   */
+  openEditor(): void {
+    this.followURI && DocHub.dataLake.openFileEditor(this.followURI, {
+      targetPath: this.profile.$base
+    });
+  }
+
+  /**
+   * Обработка полученных данных документа.
+   * Необходимо переопределить.
+   */
+  processingData(data: any | undefined) {}
+
+  /**
+   * Возвращает схему данных для контроля структуры и состава данных.
+   * Необходимо переопределить.
+   */
+  getSchemaData(): any {}
+
+  /** 
+   * Для переопределения
+   */
+  async doRefresh(): Promise<void> {
+    try {
+      await this.refreshFileFollow();
+      if (this.profile?.source) {
+        DocHub.dataLake.pullData(this.profile.source, this.params).then(async(result) => {
+          // Валидируем данные по структуре
+          const rules = new ajv({ allErrors: true });
+          const validator = rules.compile(this.getSchemaData());
+          if (!validator(result)) {
+            ajv_localize(validator.errors);
+            this.error = JSON.stringify(validator.errors, null, 4);
+            return;
+          } 
+          // Если все в порядке, вызываем процессинг данных
+          this.processingData(result);
+          this.error = null;
+        });
+      } else this.processingData(undefined);
+    } catch (error) {
+      // eslint-disable-next-line no-console
+      console.error(error);
+      this.error = error;
+      this.processingData(undefined);
+    }
+  }
+
+  // Обновляет URI файла за которым установлено наблюдение
+  async refreshFileFollow(disable = false): Promise<void> {
+    // Устанавливаем слежение за файлом для оперативного обновления
+    this.followURI && DocHub.dataLake.unfollowFile(this.followURI, this.onRefresh);
+    if (!disable) {
+      this.followURI = (await DocHub.dataLake.getURIForPath(this.profile.$base) || []).pop() || null;
+      this.followURI && DocHub.dataLake.followFile(this.followURI, this.onRefresh);
+    }
+  }
+
+  // Обработчик события обновления
+  onRefresh(): void {
+    // Если обработчик уже запущен, останавливаем его
+    if (this.onRefresher) clearTimeout(this.onRefresher);
+    // Для исключения избыточных обращений к Data Lake откладываем обновление на 50мс
+    this.onRefresher = setTimeout(() => {
+      this.onRefresher = null;
+      this.doRefresh();
+    }, 50);
+  }      
+}

package/classes/vue2/index.ts

@@ -0,0 +1 @@
+export * from './Documents';

package/index.ts

@@ -5,7 +5,6 @@ export * from './interfaces/contexts';
 export * from './interfaces/constructors';
 export * from './interfaces/collaborations';
 export * from './interfaces/datalake';
-export * from './interfaces/documents';
 export * from './interfaces/editors';
 export * from './interfaces/eventbus';
 export * from './interfaces/localstorage';

package/interfaces/core.ts

@@ -1,6 +1,5 @@
 import { IDocHubContentProviders } from './providers';
 import { IDocHubProtocols } from './protocols';
-import { IDocHubDocuments } from './documents';
 import { IDocHubDataLake } from './datalake';
 import { IDocHubConstructors } from './constructors';
 import { IDocHubObjects } from './objects';
@@ -48,12 +47,6 @@ export interface IDocHubCore {
      * Протоколы доступа к данным
      */
     protocols: IDocHubProtocols;
-    /**
-     * !!!!!!!!!!! УСТАРЕЛО !!!!!!!!!!!
-     * См presentations
-     * Документы
-     */
-    documents: IDocHubDocuments;
     /**
      * Презентации сущностей
      */

package/interfaces/ui.ts

@@ -5,9 +5,10 @@ export interface IDocHubUIComponent {
 }
 
 export enum DocHubUISlot {
-    avatar = 'avatar',
-    toolbar = 'toolbar',
-    explorer = 'explorer'
+    avatar = 'avatar',              // Компонент монтируется в область аватаров
+    toolbar = 'toolbar',            // Компонент монтируется в область панелей инструментов
+    explorer = 'explorer',          // Компонент монтируется в область навигации 
+    codeViewer = 'code-viewer'      // Компонент используется при рендере кода
 }
 
 export interface IDocHubUISlotOptions {
@@ -15,6 +16,12 @@ export interface IDocHubUISlotOptions {
      * Заголовок компонента
      */
     title?: string;
+    /**
+     * Актуально для слота codeViewer. Определяет поддерживаемые языки. 
+     * Если не указано, то считается, что поддерживаются все.
+     * Приоритет при выборе вьювера будет отдаваться с явно определенной поддержкой.
+     */
+    languages?: string[];           
     /**
      * Режимы, в которых данный компонент актуален
      * Если пусто, то во всех
@@ -141,4 +148,5 @@ export interface IDocHubUI {
      * @param options           - Параметры сохранения на клиентском устройстве
      */
     copyToClipboard(content: string | ArrayBuffer, options?:IDocHubUICopyClipboardOptions): Promise<void>;
+
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "dochub-sdk",
-  "version": "0.1.155",
+  "version": "0.1.157",
   "description": "The DocHub System Development Kit.",
   "private": false,
   "main": "index.ts",
@@ -23,6 +23,9 @@
   "author": "R.Piontik",
   "license": "GPLV3",
   "dependencies": {
-    "axios": "0.21.4"
+    "ajv": "8.17.1",
+    "ajv-i18n": "4.2.0",
+    "axios": "0.21.4",
+    "vue-property-decorator": "9.1.2"
   }
 }

package/interfaces/documents.ts

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