dochub-sdk 0.1.70 → 0.1.72

package/interfaces/datalake.ts

@@ -37,6 +37,20 @@ export interface IDocHubTransaction {
 
 }
 
+/**
+ * VUE компонент редактора ресурса
+ */
+export interface IDocHubResourceEditorComponent {
+}
+
+/**
+ * Метаинформация о редакторе ресурса
+ */
+export interface IDocHubResourceEditorItem {
+    component: IDocHubResourceEditorComponent;
+    pattern: string;
+}
+
 // Интерфейс доступа к DataLake
 export interface IDocHubDataLake {
     /**
@@ -91,5 +105,21 @@ export interface IDocHubDataLake {
     pullFile(uri: string): Promise<any>;
     // Возвращает конечный URI на основании массива относительных и прямых URI
     resolveURI(...uri: string[]): string;
+    /**
+     * Регистрирует редактор ресурсов
+     * @param pattern       - RegExp contentType ресурса
+     * @param component     - VUE компонент для редактирования ресурса
+     */
+    registerEditor(pattern: string, component: IDocHubResourceEditorItem);
+    /**
+     * Возвращает массив зарегистрированных редакторов ресурсов
+     * @returns             - Массив зарегистрированных редакторов объектов
+     */
+    fetchEditors(): Promise<IDocHubResourceEditorItem[]>;
+    /**
+     * Возвращает актуальный редактор для ресурса по contentType
+     * @param contentType   - Тип ресурса
+     */
+    getEditor(contentType: string): Promise<IDocHubResourceEditorItem>;    
 }
 

package/interfaces/editors.ts

@@ -17,28 +17,9 @@ export enum EditorEvents {
     delete = '$delete'              // Требует удалить объект
 };
 
-// Хранит состояние редактора
+/**
+ * Хранит состояние редактора
+ */
 export interface IEditorState {
     title: string
 }
-
-// VUE компонент редактора
-export interface IDocHubEditorComponent {
-}
-
-// Метаинформация о редакторе
-export interface IDocHubEditorItem {
-    component: IDocHubEditorComponent;
-    uid: string;
-}
-
-// Редакторы документов
-export interface IDocHubEditors {
-    // Регистрирует редактор для типа документа
-    register(uid: string, component: IDocHubEditorComponent);
-    // Возвращает массив зарегистрированных редакторов 
-    fetch(): string[];
-    // Возвращает компонент редактора по идентификатору
-    get(uid: string): IDocHubEditorItem;
-}
-

package/interfaces/objects.ts

@@ -1,4 +1,6 @@
-// Содержит метаданные задекларированного объекта
+/**
+ * Содержит метаданные задекларированного объекта
+ */
 export interface IDocHubObjectMeta {
     uid: string;            // Идентификатор объекта
     entity: string;         // Идентификатор сущности
@@ -10,14 +12,53 @@ export interface IDocHubObjectMeta {
     constructor?: string;   // RegEx паттерн конструктора объектов
 }
 
+/**
+ * VUE компонент редактора объекта
+ */
+export interface IDocHubObjectEditorComponent {
+}
+
+/**
+ * Метаинформация о редакторе объекта
+ */
+export interface IDocHubEditorObjectItem {
+    component: IDocHubObjectEditorComponent;
+    uid: string;
+}
+
 // Интерфейс доступа к задекларированным объектам в DataLake
 export interface IDocHubObjects {
-    // Возвращает коллекцию задекларированных объектов
+    /**
+     * Возвращает коллекцию задекларированных объектов
+     * @returns             - Коллекция задекларированных объектов
+     */
     fetch(): Promise<IDocHubObjectMeta[]>;
-    // Возвращает объект по идентификатору
+    /**
+     * Возвращает объект
+     * @param uid           - Идентификатор объекта
+     */
     get(uid: string): Promise<IDocHubObjectMeta>;
-    // Возвращает метаданные декларированного объекта для указанного пути
-    //  path    - путь к объекту 
+    /**
+     * Возвращает метаданные задекларированного объекта для указанного пути
+     * @param path          - Путь к объекту 
+     */
     getMetaObjectByPath(path: string): Promise<IDocHubObjectMeta | null>;
+    /**
+     * Регистрирует редактор объекта
+     * @param uid           - Идентификатор типа объекта
+     * @param component     - VUE компонент для редактирования объекта
+     */
+    registerEditor(uid: string, component: IDocHubObjectEditorComponent);
+    /**
+     * Возвращает массив зарегистрированных редакторов объектов
+     * @returns             - Массив зарегистрированных редакторов объектов
+     */
+    fetchEditors(): Promise<IDocHubEditorObjectItem[]>;
+    /**
+     * Возвращает компонент редактора объекта
+     * @param uid           - Идентификатор типа объекта
+     * @returns             - IDocHubEditorItem
+     */
+    getEditor(uid: string): Promise<IDocHubEditorObjectItem>;    
 }
 

package/interfaces/protocols.ts

@@ -8,13 +8,6 @@ export interface IDocHubProtocolRequestConfig extends AxiosRequestConfig {
 
 export interface IDocHubProtocolResponse extends AxiosResponse {};
 
-/**
- * Предопределенные типы контентов
- */
-export enum DocHubContentType {
-    folder = 'dochub/folder'
-}
-
 /**
  * Тип ресурса
  */
@@ -30,7 +23,9 @@ export enum DocHubResourceType {
 export type DocHubResourceMetaFile = {
     type: DocHubResourceType.file,
     uri: string,
-    contentType: DocHubContentType | string
+    contentType?: string,
+    size?: number,
+    sha?: string
 }
 
 /**

package/package.json

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