dochub-sdk 0.1.379 → 0.1.380

package/index.ts

@@ -23,6 +23,7 @@ export * from './interfaces/jsonata';
 export * from './metamodel/index';
 export * from './interfaces/ai';
 export * from './interfaces/explainer';
+export * from './interfaces/libraries';
 
 export * from './schemas/basetypes';
 export * from './schemas/dochub-yaml';

package/interfaces/core.ts

@@ -17,6 +17,8 @@ import { IDocHubLang } from './lang';
 import { IDocHubAI } from './ai';
 import { IDocHubExplainer } from './explainer';
 import { IDocHubJSONata } from './jsonata';
+import { IDocHubLibraries } from './libraries';
+
 /**
  * Интерфейс ядра
  */
@@ -25,6 +27,10 @@ export interface IDocHubCore {
      * Интерфейс работы с AI
      */
     ai: IDocHubAI;
+    /**
+     * Shared-библиотеки
+     */
+    libraries: IDocHubLibraries;
     /**
      * Интерфейс подсистемы объяснения
      */
@@ -113,4 +119,4 @@ export interface IDocHubCore {
      * @returns         - Режим, в который переведен портал в результате выполнения запроса
      */
     switchToMode(mode: DocHubEditMode): Promise<DocHubEditMode>;
-}
+}

package/interfaces/libraries.ts

@@ -0,0 +1,48 @@
+export type IDocHubLibrary = any;
+/**
+ * Интерфейсы публикуемых плагинами библиотек
+ */
+export interface IDocHubLibraryExportProfile {
+    /**
+     * Если библиотека имеет исходники для сборки, здесь указывается путь к ним.
+     * Ссылка на исходники позволяет при разработке обращаться к декларациям интерфейсов и функций библиотек,
+     * а также, при необходимости внедрять библиотеки непосредственно в плагины.
+     */
+    srcPath?: string;
+    /**
+     * Реализация загрузки модуля.
+     * В результате вызова данной функции необходимо вернуть ссылку на загруженный модуль.
+     */
+    import(): Promise<IDocHubLibrary>;
+}
+
+/**
+ * Декларирует публикуемые плагином библиотеки
+ */
+export interface IDocHubLibrariesExport {
+    [id: string]: IDocHubLibraryExportProfile;
+}
+
+/**
+ * Интерфейс управления библиотеками
+ */
+export interface IDocHubLibraries {
+    /**
+     * Публикует библиотеки для всех желающих
+     * @param libraries - структура экспорта
+     */
+    export(libraries: IDocHubLibrariesExport);
+    /**
+     * При вызове будет ожидать загрузки необходимых библиотек.
+     * Если загрузка хотя бы одной библиотеки не удастся, возникнет ошибка.
+     * @param libraries - список необходимых библиотек
+     */
+    requires(libraries: string[]): Promise<void>;
+    /**
+     * Проверяет доступна ли библиотека. 
+     * Возвращает структуру где для каждой библиотеки указывается true если она доступна, либо false
+     * @param libraries 
+     */
+    isAvailable(libraries: string[]): Promise<{ [library: string]: boolean }>;
+}
+

package/package.json

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