dochub-sdk 0.1.86 → 0.1.88

package/interfaces/constructors.ts

@@ -1,38 +1,61 @@
 import { DocHubEditorContext } from './editors';
 
-// Компонент конструктора
+/**
+ * Компонент конструктора
+ */
 export interface IDocHubConstructorComponent {
 }
 
-// Запись в коллекции о конструкторе
+/**
+ * Функция проверки корректности контекста для работы конструктора
+ */
+export type FContextValidator = (context: DocHubEditorContext) => Promise<boolean>;
+
+// Дополнительная информация и опциональные методы конструктора
+export interface IDocHubConstructorOptions {
+    description?: string;               // Описание смысла конструктора
+    img?: string;                       // Картинка для пользователя
+    isValidContext?: FContextValidator; // Функция проверки корректности контекста для работы конструктора
+}
+
+/**
+ * Запись в коллекции о конструкторе
+ */
 export interface IDocHubConstructorItem {
     component: IDocHubConstructorComponent;
     uid: string;
     title: string;
+    options?: IDocHubConstructorOptions;
 }
 
-// Дополнительная метаинформация о конструкторе
-export interface IDocHubConstructorMeta {
-    description?: string;   // Описание смысла конструктора
-    img?: string;           // Картинка для пользователя
-}
-
-// Интерфейс конструкторов
+/**
+ * Интерфейс конструкторов
+ */
 export interface IDocHubConstructors {
-    // Регистрирует конструктор
-    //  uid         - Идентификатор конструктора
-    //  title       - Краткое название конструктора
-    //  component   - UI компонент конструктора
-    //  meta        - Мета-информация о конструкторе
-    register(uid: string, title: string, component: IDocHubConstructorComponent, meta?: IDocHubConstructorMeta);
-    // Возвращает список конструкторов
+    /**
+     * Регистрирует конструктор
+     * @param uid           - Идентификатор конструктора
+     * @param title         - Краткое название конструктора
+     * @param component     - UI компонент конструктора
+     * @param options       - Опции конструктора и дополнительные сведения о нем
+     */
+    register(uid: string, title: string, component: IDocHubConstructorComponent, options?: IDocHubConstructorOptions);
+    /**
+     * Возвращает коллекцию конструкторов
+     * @returns             - Массив записей коллекции конструкторов
+     */
     fetch():Promise<IDocHubConstructorItem[]>;
-    // Возвращает запись коллекции по идентификатору 
-    //  uid         - Идентификатор конструктора
-    get(uid: string):Promise<IDocHubConstructorItem>;
-    // Вызывает магазин выбора конструкторов по указанному шаблону идентификаторов
-    //  pattern     - шаблон идентификаторов по которому отбираются конструкторы
-    //  context     - Контекст который должен учесть конструктор, если он не определен, контекст будет создан автоматически
+    /**
+     * Возвращает запись коллекции по идентификатору 
+     * @param uid           - Идентификатор конструктора
+     * @returns             - Найденная запись коллекции конструкторов или null
+     */
+    get(uid: string):Promise<IDocHubConstructorItem | null>;
+    /**
+     * Вызывает магазин выбора конструкторов по указанному шаблону идентификаторов
+     * @param pattern       - Шаблон идентификаторов по которому отбираются конструкторы
+     * @param context       - Контекст который должен учесть конструктор, если он не определен, контекст будет создан автоматически
+     */
     showStore(pattern?: RegExp, context?: DocHubEditorContext);
 }
 

package/interfaces/editors.ts

@@ -21,7 +21,9 @@ export enum EditorEvents {
     /**
      * События контекста редактора
      */
+    contextAppend  = '$edit-context-append',    // Контекст добавлен 
     contextUpdated = '$edit-context-updated',   // Контекст претерпел изменения
+    contextRemoved = '$edit-context-removed',   // Контекст удален
     /**
      * События редактора
      */

package/package.json

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