dochub-sdk 0.1.104 → 0.1.106

package/interfaces/documents.ts

@@ -1,3 +1,8 @@
+/* !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! */
+/* Нужно отказаться от отдельного представления "Документ" и мигрировать к универсальным презентациям и объектам */
+/* !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! */
+
+
 /**
  *  Интерфейс, который требуется реализовать объектам документов
  */
@@ -16,7 +21,7 @@ export interface IDocHubDocuments {
      */
     register(type: string, document: IDocHubDocument);
     /**
-     * Возвращает массив зарегистрированных типов документов 
+     * Возвращает зарегистрированные документы
      * @returns         - Массив зарегистрированных типов документов
      */
     fetch(): string[];

package/interfaces/editors.ts

@@ -65,6 +65,8 @@ export type DocHubEditorObjectContext = {
     meta: IDocHubObjectEditorContext
 }
 
+export type DocHubEditorURI = string;
+
 /**
  * Универсальный контекст редактора
  */

package/interfaces/objects.ts

@@ -1,3 +1,4 @@
+import { DocHubEditorURI } from './editors';
 /**
  * Содержит метаданные задекларированного объекта
  */
@@ -71,6 +72,12 @@ export interface IDocHubObjects {
      * @param uid           - Идентификатор типа объекта
      * @returns             - IDocHubEditorItem
      */
-    getEditor(uid: string): Promise<IDocHubObjectEditorItem>;    
+    getEditor(uid: string): Promise<IDocHubObjectEditorItem>;
+
+    /**
+     * Генерирует URL для редактирования объекта по указанному пути
+     * @param path          - Путь к объекту, разделенный "/"
+     */
+    makeEditURLByPath(path: string): Promise<DocHubEditorURI>;
 }
 

package/interfaces/ui.ts

@@ -1,5 +1,6 @@
 import { IDocHubUIComponent } from './uicomponents';
-import { DocHubEditMode } from './editors';
+import { DocHubEditMode, DocHubEditorURI } from './editors';
+
 
 export enum DocHubUISlot {
     avatar = 'avatar',
@@ -25,12 +26,33 @@ export interface IDocHubUISlotItem {
     options?: IDocHubUISlotOptions;
 }
 
+export interface IDocHubHTMLElementMeta {
+    /**
+     * Ссылка на редактор 
+     */
+    editor?: DocHubEditorURI;   
+}
+
 /**
  * Интерфейс управления UI компонентами для предопределенных слотов
  */
 export interface IDocHubUI {
-    // Регистрирует UI компонент в слоте
+    /**
+     * Регистрирует UI компонент в слоте
+     * @param slot              - Идентификатор слота DocHubUISlot или произвольный для кастомных слотов
+     * @param component         - VUE component
+     * @param options           - Дополнительные опции
+     */
     register(slot: DocHubUISlot | string, component: IDocHubUIComponent, options?: IDocHubUISlotOptions);
-    // Возвращает зарегистрированные компонент по слоту
+    /**
+     * Возвращает зарегистрированные компонент по слоту
+     * @param slot              - Идентификатор слота DocHubUISlot или произвольный для кастомных слотов
+     * @returns                 - Список UI компонентов
+     */
     get(slot: DocHubUISlot | string): Promise<IDocHubUISlotItem[]>;
+
+    /**
+     * Обогащает HTML элемент метаданными для контекстного взаимодействия в UI
+     */
+    appendMetaToElement(element:any, meta:IDocHubHTMLElementMeta);
 }

package/package.json

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