dochub-sdk 0.1.381 → 0.1.383

package/index.ts

@@ -24,11 +24,13 @@ export * from './metamodel/index';
 export * from './interfaces/ai';
 export * from './interfaces/explainer';
 export * from './interfaces/libraries';
+export * from './interfaces/shared';
 
 export * from './schemas/basetypes';
 export * from './schemas/dochub-yaml';
 
 export * from './plugins/manifest';
+export * from './plugins/module';
 
 export * from './environments/variables';
 

package/interfaces/ai.ts

@@ -50,6 +50,24 @@ export interface IDocHubAIRequest {
     next(question: string): Promise<void>;
 }
 
+export type DocHubAIAskAttachmentFileContent = string;
+
+
+/**
+ * Метаданные файла
+ */
+export interface DocHubAIAskAttachmentFile {
+    url: URL;               // Ссылка на файл, либо base64 кодированный файл
+    source?: URL;           // Источник информации для задач AI при указании ссылок на источники
+    description?: string;   // Контекстное описание файла
+}
+
+/**
+ * Структура прикрепляемых файлов к запросу
+ */
+
+export type DocHubAIAskAttachment = DocHubAIAskAttachmentFile[];
+
 /**
  * Опции выполнения AI запроса
  */
@@ -66,6 +84,10 @@ export interface IDocHubAIAskOptions {
      * Признак отображения внутреннего диалога IDE и AI-агента
      */
     trace?: boolean;
+    /**
+     * Файлы прикрепляемые к запросу
+     */
+    attachment?: DocHubAIAskAttachment;
 }
 
 /**
@@ -88,6 +110,10 @@ export interface IDocHubAIDriver {
      * @returns           - Запрос к AI
     */
     ask: DocHubAskFunction;
+    /**
+     * Возвращает информацию о способностях AI
+     */
+    getCapabilities(): Promise<IDocHubAICapabilities>;
 }
 
 export interface IDocHubAITextPartition {
@@ -187,6 +213,37 @@ export interface IDocHubComposerProvider {
     fetchCommands(): Promise<IDocHubAIComposerCommand[]>;
 }
 
+export enum IDocHubAICapabilityID {
+    text = 'text',
+    attachment = 'attachment',
+    contextWindow = 'context-window'
+}
+
+export type DocHubAIAttachmentFileContentType = string;
+
+/**
+ * Метаинформация о возможностях AI-агента
+ */
+export interface IDocHubAICapabilities {
+    /**
+     * Текстовое резюме от AI
+     */
+    description?: string;
+    /**
+     * Способность обрабатывать прикрепленные файлы к сообщению
+     */
+    [IDocHubAICapabilityID.attachment]?: DocHubAIAttachmentFileContentType[];
+    /**
+     * Способность воспринимать текс в запросе
+     */
+    [IDocHubAICapabilityID.text]?: boolean;
+    /**
+     * Размер контекстного окна
+     */
+    [IDocHubAICapabilityID.contextWindow]?: number;
+}
+
+
 /**
  * Интерфейс AI ассистента
  */

package/interfaces/libraries.ts

@@ -2,32 +2,25 @@ export type IDocHubLibrary = any;
 export type DocHubLibraryID = string;
 export type DocHubLibraryVersion = string;
 export type DocHubLibraryRequireVersion = string;
+export type DocHubLibraryExportVersion = string;
+
 /**
- * Интерфейсы публикуемых плагинами библиотек
+ * Декларирует публикуемые плагином библиотеки
  */
-export interface IDocHubLibraryExportProfile {
-    /**
-     * Если библиотека имеет исходники для сборки, здесь указывается путь к ним.
-     * Ссылка на исходники позволяет при разработке обращаться к декларациям интерфейсов и функций библиотек,
-     * а также, при необходимости внедрять библиотеки непосредственно в плагины.
-     */
-    srcPath?: string;
-    /**
-     * Реализация загрузки модуля.
-     * В результате вызова данной функции необходимо вернуть ссылку на загруженный модуль.
-     */
-    import(): Promise<IDocHubLibrary>;
-    /**
-     * Версия библиотеки
-     */
-    version: DocHubLibraryVersion;
+export interface IDocHubLibrariesExport {
+    [id: DocHubLibraryID]: DocHubLibraryExportVersion;
 }
 
 /**
- * Декларирует публикуемые плагином библиотеки
+ * Ручка для разрешения зависимости от библиотеки. Должна возвращать объект module.
  */
-export interface IDocHubLibrariesExport {
-    [id: DocHubLibraryID]: IDocHubLibraryExportProfile;
+export type IDocHubLibraryResolver = (library: DocHubLibraryID) => Promise<IDocHubLibrary>;
+
+/**
+ * Интерфейс доступа к общим библиотекам, которые предоставляет плагин
+ */
+export interface IDocHubSharedLibraries {
+    resolve: IDocHubLibraryResolver;
 }
 
 /**
@@ -41,17 +34,6 @@ export interface IDocHubLibraryRequires {
  * Интерфейс управления библиотеками
  */
 export interface IDocHubLibraries {
-    /**
-     * Публикует библиотеки для всех желающих
-     * @param libraries - структура экспорта
-     */
-    export(libraries: IDocHubLibrariesExport);
-    /**
-     * При вызове будет ожидать загрузки необходимых библиотек.
-     * Если загрузка хотя бы одной библиотеки не удастся, возникнет ошибка.
-     * @param libraries - список необходимых библиотек
-     */
-    requires(libraries: IDocHubLibraryRequires): Promise<void>;
     /**
      * Проверяет доступна ли библиотека. 
      * Возвращает структуру где для каждой библиотеки указывается true если она доступна, либо false

package/interfaces/shared.ts

@@ -0,0 +1,21 @@
+/**
+ * Интерфейс для экспорта общих ресурсов из плагинов
+ */
+import { IDocHubLibraryResolver } from "./libraries";
+
+/**
+ * Экспортный метод общих ресурсов плагина
+ */
+export type DocHubSharedResources = () => Promise<IDocHubSharedResources>;
+
+/**
+ * Интерфейс общих ресурсов поставляемый плагином
+ */
+export interface IDocHubSharedResources {
+    /**
+     * Возвращает объект module для экспортируемой библиотеки
+     */
+    libraries?: {
+        resolve: IDocHubLibraryResolver;
+    }
+}

package/package.json

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

package/plugins/manifest.ts

@@ -1,3 +1,4 @@
+import { IDocHubLibrariesExport, IDocHubLibraryRequires } from "../interfaces/libraries";
 import { DocHubJSONSchema, IDocHubJSONSchemaAllOf, IDocHubJSONSchemaAnyOf, IDocHubJSONSchemaArray, IDocHubJSONSchemaBase, IDocHubJSONSchemaBoolean, IDocHubJSONSchemaInteger, IDocHubJSONSchemaNumber, IDocHubJSONSchemaObject, IDocHubJSONSchemaOneOf, IDocHubJSONSchemaString } from "../schemas/basetypes";
 
 /**
@@ -68,8 +69,10 @@ export interface IDocHubPluginManifest {
     }
     // Свойства приложения
     app_props: IDocHubManifestProps;
-    // Подключаемые плагины
-    app_plugins?: IDocHubManifestPlugins;
     // Переменные среды исполнения
     app_environments?: IDocHubManifestEnvironments;
+    // Зависимость от общих библиотек в DocHub
+    DocHubDependencies?: IDocHubLibraryRequires;
+    // Экспортируемые общие библиотеки в DocHub
+    DocHubExport?: IDocHubLibrariesExport;
 }

package/plugins/module.ts

@@ -0,0 +1,31 @@
+/**
+ * Декларирует интерфейс, который должен реализовать js-модуль плагина
+ */
+
+import { IDocHubSharedResources } from "../interfaces/shared";
+
+/**
+ * Функция инициализации плагина в режиме frontend
+ */
+export type DocHubFrontendBootstrap = () => Promise<void>;
+
+/**
+ * Функция инициализации плагина в режиме backend
+ */
+export type DocHubBackendBootstrap = () => Promise<void>;
+
+/**
+ * Загрузочный интерфейс плагина
+ */
+export interface IDocHubPluginBootstrap {
+    frontend?: DocHubFrontendBootstrap;
+    backend?: DocHubBackendBootstrap;
+}
+
+/**
+ * Интерфейс, который обязан реализовать плагин
+ */
+export interface IDocHubPlugin {
+    bootstrap?: IDocHubPluginBootstrap;
+    shared?: IDocHubSharedResources;
+}