dochub-sdk 0.1.83 → 0.1.85

package/interfaces/constructors.ts

@@ -1,3 +1,5 @@
+import { DocHubEditorContext } from './editors';
+
 // Компонент конструктора
 export interface IDocHubConstructorComponent {
 }
@@ -15,11 +17,6 @@ export interface IDocHubConstructorMeta {
     img?: string;           // Картинка для пользователя
 }
 
-// Параметры передаваемые в конструктор для его первичной инициализации
-export interface IDocHubConstructorParams {
-    [key: string]: any;
-}
-
 // Интерфейс конструкторов
 export interface IDocHubConstructors {
     // Регистрирует конструктор
@@ -35,7 +32,7 @@ export interface IDocHubConstructors {
     get(uid: string):Promise<IDocHubConstructorItem>;
     // Вызывает магазин выбора конструкторов по указанному шаблону идентификаторов
     //  pattern     - шаблон идентификаторов по которому отбираются конструкторы
-    //  target      - Целевое пространство для создания объекта
-    showStore(pattern?: RegExp, target?: string, params?:IDocHubConstructorParams);
+    //  context     - Контекст который должен учесть конструктор, если он не определен, контекст будет создан автоматически
+    showStore(pattern?: RegExp, context?: DocHubEditorContext);
 }
 

package/interfaces/datalake.ts

@@ -53,6 +53,17 @@ export interface IDocHubFileEditorItem {
     title: string;
 }
 
+/**
+ * Описывает контекст открытого на редактирования файла
+ */
+export interface IDocHubFileEditorContext {
+    uri?: string;           // URI файла открытого на редактирование. 
+                            // Если не определено берется из параметра openFileEditor
+    contentType: string;    // Тип контента файла. 
+                            // Если не определено берется из данных полученных о файле в процессе открытия.
+    [key: string]: any;     // Произвольные ключи и значения
+}
+
 // Интерфейс доступа к DataLake
 export interface IDocHubDataLake {
     /**
@@ -129,9 +140,10 @@ export interface IDocHubDataLake {
      * Запрос на открытие файла на пользовательское редактирование. Не обязательно будет выполнен.
      * Если редактор уже открыт, активирует его.
      * @param uri           - URI файла 
+     * @param context       - Контекст редактирования файла. Необходим для связных редакторов и конструкторов.
      * @returns             - Компонент редактора, если открытие оказалось успешным
      */
-    openFileEditor(uri: string): Promise<IDocHubFileEditorComponent>;
+    openFileEditor(uri: string, context?: IDocHubFileEditorContext): Promise<IDocHubFileEditorComponent>;
 
     /**
      * Запрос на завершение пользовательского редактирования файла. Не обязательно будет выполнен.

package/interfaces/editors.ts

@@ -1,3 +1,6 @@
+import { IDocHubFileEditorContext } from './datalake';
+import { IDocHubObjectEditorContext } from './objects';
+
 /**
  * Режим функционирования 
  */
@@ -15,18 +18,45 @@ export enum EditorEvents {
      * События режимов
      */
     modeChanged = '$mode-changed',  // Режим портала изменился
+    /**
+     * События контекста редактора
+     */
+    contextUpdated = '$edit-context-updated',   // Контекст претерпел изменения
     /**
      * События редактора
      */
-    close = '$close',               // Требует закрыть редактор
-    save = '$save',                 // Требует произвести сохранение 
-    create = '$create',             // Требует создать новый объект
-    delete = '$delete'              // Требует удалить объект
+    close = '$close',                           // Требует закрыть редактор
+    save = '$save',                             // Требует произвести сохранение 
+    create = '$create',                         // Требует создать новый объект
+    delete = '$delete'                          // Требует удалить объект
 };
 
+
+/**
+ * Тип редактора
+ */
+export enum DocHubEditorType {
+    file = 'file',
+    object = 'object'
+}
+
 /**
- * Хранит состояние редактора
+ * Контекст редактора
  */
-export interface IEditorState {
-    title: string
+export type DocHubEditorFileContext = {
+    type: DocHubEditorType.file,
+    meta: IDocHubFileEditorContext
 }
+
+/**
+ * Контекст редактора объекта
+ */
+export type DocHubEditorObjectContext = {
+    type: DocHubEditorType.object,
+    meta: IDocHubObjectEditorContext
+}
+
+/**
+ * Универсальный контекст редактора
+ */
+export type DocHubEditorContext = DocHubEditorFileContext | DocHubEditorObjectContext;

package/interfaces/objects.ts

@@ -27,6 +27,16 @@ export interface IDocHubObjectEditorItem {
     title: string;
 }
 
+/**
+ * Описывает контекст редактируемого объекта
+ */
+export interface IDocHubObjectEditorContext {
+    path?: string;          // Путь к объекту в Data Lake
+                            // Если не определено берется из параметра openObjectEditor
+    [key: string]: any;     // Произвольные ключи и значения
+}
+
+
 // Интерфейс доступа к задекларированным объектам в DataLake
 export interface IDocHubObjects {
     /**

package/package.json

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