dochub-sdk 0.1.108 → 0.1.111

package/.vscode/settings.json

@@ -5,6 +5,7 @@
         "задекларированным",
         "задекларированных",
         "Параметризируемый",
+        "datalake",
         "PROPFIND"
     ]
 }

package/README.md

@@ -2,6 +2,8 @@
 
 Набор утилит и интерфейсов для разработки плагинов DocHub.
 
+В активное разработке.
+
 # Лицензия 
 
 GPLv3

package/interfaces/datalake.ts

@@ -5,6 +5,15 @@ export enum DataLakeChange {
     remove = 'remove',          // Удаляет данные по указанному пути
 };
 
+/**
+ * Путь к объекту в DataLake.
+ * Последовательность ключей коллекций через "/".
+ * Например: 
+ *  docs/example
+ *  components/dochub.main
+ */
+export type DataLakePath = string;
+
 // Паттерн изменившихся файлов в DataLake 
 export type DocHubDataLakeChangeItem = RegExp;
 
@@ -33,7 +42,7 @@ export interface IDataLakeChange {
     // Действие над DataLake
     action: DataLakeChange;
     // Путь в DataLake куда вносятся изменения
-    path: string;
+    path: DataLakePath;
     // Данные, которые вносятся в DataLake
     data: object | string | number | boolean;
     // Комментарии в манифест, где изменения будут зафиксированы
@@ -280,11 +289,11 @@ export interface IDocHubDataLake {
     resolveURI(...uri: string[]): string;
 
     /**
-     * Возвращает URI ресурсов в которых определен данный путь в DataLake
+     * Возвращает URI файлов в которых определен данный путь в DataLake
      * @param path              - Путь к области DataLake через "/"
      * @returns                 - Массив URI фалов
      */
-    getURIForPath(path: string): Promise<string[]>;
+    getURIForPath(path: DataLakePath): Promise<string[]>;
 
     /**
      * Регистрирует редактор файлов

package/interfaces/objects.ts

@@ -1,4 +1,5 @@
 import { DocHubEditorURI } from './editors';
+import { DataLakePath } from './datalake';
 /**
  * Содержит метаданные задекларированного объекта
  */
@@ -32,7 +33,7 @@ export interface IDocHubObjectEditorItem {
  * Описывает контекст редактируемого объекта
  */
 export interface IDocHubObjectEditorContext {
-    path?: string;          // Путь к объекту в Data Lake
+    path?: DataLakePath;    // Путь к объекту в Data Lake
                             // Если не определено берется из параметра openObjectEditor
     [key: string]: any;     // Произвольные ключи и значения
 }
@@ -54,7 +55,7 @@ export interface IDocHubObjects {
      * Возвращает метаданные задекларированного объекта для указанного пути
      * @param path          - Путь к объекту 
      */
-    getMetaObjectByPath(path: string): Promise<IDocHubObjectMeta | null>;
+    getMetaObjectByPath(path: DataLakePath): Promise<IDocHubObjectMeta | null>;
     /**
      * Регистрирует редактор объекта
      * @param uid           - Идентификатор типа объекта
@@ -78,6 +79,15 @@ export interface IDocHubObjects {
      * Генерирует URL для редактирования объекта по указанному пути
      * @param path          - Путь к объекту, разделенный "/"
      */
-    makeEditURLByPath(path: string): Promise<DocHubEditorURI>;
+    makeEditURLByPath(path: DataLakePath): Promise<DocHubEditorURI>;
+    /**
+     * Запрос на открытие объекта на пользовательское редактирование. Необязательно будет выполнен.
+     * Если редактор уже открыт, активирует его.
+     * @param path              - Путь к редактируемому объекту
+     * @param context           - Контекст редактирования объекта. Необходим для связных редакторов и конструкторов.
+     * @returns                 - Компонент редактора, если открытие оказалось успешным
+     */
+    openObjectEditor(path: DataLakePath, context?: IDocHubObjectEditorContext): Promise<IDocHubObjectEditorComponent>;
+
 }
 

package/package.json

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