dochub-sdk 0.1.376 → 0.1.379

package/classes/vue2/Components.ts

@@ -54,7 +54,7 @@ export class DocHubComponentProto extends Vue {
       styleHeight: element.style.height,
       styleWidth: element.style.width,
       styleFilter: element.style.filter
-    }
+    };
   }
   /**
    * Восстанавливает параметры визуализации из ранее сохраненных

package/classes/vue2/Documents.ts

@@ -3,7 +3,7 @@ import { Prop, Watch, Component } from 'vue-property-decorator';
 import { DocHubComponentProto } from './Components';
 import { DocHub } from '../..';
 import { DocHubError } from '..';
-import type { IDocHubEditableComponent, IDocHubEditableMeta, IDocHubEditableMetaEditEntry, IDocHubPresentationProfile, IDocHubPresentationsParams } from '../..';
+import type { IDocHubAIContextPartition, IDocHubContextProvider, IDocHubEditableComponent, IDocHubEditableMeta, IDocHubEditableMetaEditEntry, IDocHubPresentationProfile, IDocHubPresentationsParams } from '../..';
 import { DocHubUITargetWindow } from '../..';
 import { getIconByURI } from '../../helpers/icons';
 
@@ -23,20 +23,55 @@ export enum DocHubDocumentType {
                           // а в source запрос для генерации данных для его заполнения.
                           // В результате работы вызовет метод processingContent
 
-  data = 'data'           // Работает только со структурированными данными.
+  data = 'data',          // Работает только со структурированными данными.
                           // Предполагается, что в source находится запрос.
                           // В результате работы вызовет метод processingData
+
+  custom = 'custom'       // Неопределенная структура профиля документа
+}
+
+/**
+ * Контекст-провайдер для AI агента
+ */
+export class AIDocumentContextProvider implements IDocHubContextProvider {
+  private docs: DocHubDocumentProto[] = [];
+
+  constructor() {
+    DocHub.ai.registerContextProvider('dochub-document-default', this);
+  }
+
+  register(doc: DocHubDocumentProto) {
+    !this.docs.includes(doc) && this.docs.push(doc);
+  }
+  unregister(doc: DocHubDocumentProto) {
+    this.docs = this.docs.filter((v) => v !== doc);
+  }
+  async pullPartitions(): Promise<IDocHubAIContextPartition[]> {
+    const result: IDocHubAIContextPartition[] = [];
+    for (const doc of this.docs) {
+      result.push({
+        id:  doc.profile.$base.toString(),
+        content: doc.pullAIContext,
+        path: doc.profile.$base,
+        uri: (await DocHub.dataLake.getURIForPath(doc.profile.$base)).pop()
+      });
+    }
+    return result;
+  }
 }
 
 @Component
 export class DocHubDocumentProto extends DocHubComponentProto implements IDocHubEditableComponent {
-  onRefresher: any = null;                              // Таймер отложенного выполнения обновления
-  followFiles: string[] | undefined = undefined;        // Список файлов за изменениями которых нужно следить
-  baseURI: string | undefined = undefined;              // URI документа от которого должны разрешаться все относительные ссылки
-  templateURI: string | undefined = undefined;          // URI файла шаблона, если он определен
-  sourceURI: string | undefined = undefined;            // Файла источника, если он определен как файл
-  error: string | null = null;                          // Ошибка
-  isPending = true;                                     // Признак внутренней работы. Например загрузка данных.
+  onRefresher: any = null;                                                // Таймер отложенного выполнения обновления
+  followFiles: string[] | undefined = undefined;                          // Список файлов за изменениями которых нужно следить
+  baseURI: string | undefined = undefined;                                // URI документа от которого должны разрешаться все относительные ссылки
+  templateURI: string | undefined = undefined;                            // URI файла шаблона, если он определен
+  sourceURI: string | undefined = undefined;                              // Файла источника, если он определен как файл
+  error: string | null = null;                                            // Ошибка
+  isPending = true;                                                       // Признак внутренней работы. Например загрузка данных.
+  contentData: any = null;                                                // Данные, на основе которых рендерится документ
+  private static contextProvider: AIDocumentContextProvider = null;       // Провайдер генерации контекста для AI
+
   /**
    * Профиль документа
    */
@@ -58,6 +93,12 @@ export class DocHubDocumentProto extends DocHubComponentProto implements IDocHub
     type: Boolean,
     default: false
   }) readonly isPrintVersion: boolean;
+  /**
+   * Возвращает провайдер AI-контекста по умолчанию
+   */
+  get contextProvider() : AIDocumentContextProvider {
+    return DocHubDocumentProto.contextProvider ||= new AIDocumentContextProvider();
+  }
   /**
    * Следим за изменением профиля документа
    */
@@ -81,11 +122,15 @@ export class DocHubDocumentProto extends DocHubComponentProto implements IDocHub
   mounted() {
     // При монтировании компонента в DOM, генерируем событие обновления
     this.onRefresh();
+    // Регистрирует документ как поставщик контекста для AI
+    this.contextProvider.register(this);
   }
 
   destroyed() {
     // Отключаем слежку за файлом
     this.refreshFilesFollow(true);
+    // Отменяет регистрацию документа как поставщика контекста для AI
+    this.contextProvider.unregister(this);    
   }
   /**
    * Подтверждаем, что презентация может редактироваться
@@ -118,9 +163,28 @@ export class DocHubDocumentProto extends DocHubComponentProto implements IDocHub
           title: uri,
           icon: getIconByURI(uri),
           handle: () =>  this.openEditor(uri)
-        }
+        };
       })
-    }
+    };
+  }
+  /**
+   * Возвращает контекст документа для AI-агента
+   * @returns 
+   */
+  async pullAIContext(): Promise<string> {
+    if (!this.contentData) return '';
+    let result = '# Пользователь просматривает/изучает документ ';
+    this.profile?.title && (result += ` \`${this.profile?.title}\`\n`);
+    result += '**Документ выведен на экран и пользователь на него смотрит.** Если пользователь говорит "этот документ", значит он имеет ввиду этот документ или другой представленный на экране.\n';
+    this.profile?.title && (result += `* Документ имеет название \`${this.profile?.title}\`\n`);
+    this.profile?.type && (result += `* Документ имеет тип \`${this.profile?.type}\`\n`);
+    this.profile?.$base && (result += `* Документ расположен в Data Lake по пути \`${this.profile?.$base}\`\n`);
+    this.profile?.template && (result += `* Документ использует шаблон для своего представления \`${this.profile?.template}\`\n`);
+    result += `* Источником информации для него служит \`${JSON.stringify(this.profile?.source)}\`\n`;
+    result += '* Содержимое документа начинается после строки `$______DOC____BEGIN_____$` и заканчивается после троки `$______DOC____END_____$` \n\n';
+    const content = typeof this.contentData === 'string' ? this.contentData : JSON.stringify(this.contentData || '');
+    result += `\`$______DOC____BEGIN_____$\`\n${content}\n\`$______DOC____END_____$\``;
+    return result;
   }
   /**
    * Обработка полученных данных документа.
@@ -136,6 +200,12 @@ export class DocHubDocumentProto extends DocHubComponentProto implements IDocHub
   async processingContent(content: AxiosResponse): Promise<void> {
     throw new DocHubError(`The document has ${this.getType()} type. It must have processingContent method. But, the method is not implemented.`);
   }
+  /**
+   * Кастомный обработчик профиля документа.
+   */
+  async processingCustom(): Promise<void> {
+    throw new DocHubError(`The document has ${this.getType()} type. It must have processingCustom method. But, the method is not implemented.`);
+  }
   /**
    * Возвращает список отслеживаемых файлов.
    * Может быть переопределен.
@@ -171,46 +241,56 @@ export class DocHubDocumentProto extends DocHubComponentProto implements IDocHub
   async doRefresh(): Promise<void> {
     try {
       if (!this.profile?.source) throw new DocHubError('Document must have field "source" in profile!');
+
       this.isPending = true;
       await this.refreshFilesFollow();
-      // Если есть шаблон, загружаем его
-      const template = (this.getType() === DocHubDocumentType.content) && this.templateURI 
-        && (await DocHub.dataLake.pullFile(this.templateURI));
-      let result: AxiosResponse | null = (template || (this.getType() === DocHubDocumentType.data)) 
-        && { data: await DocHub.dataLake.resolveDataSetProfile(this.profile, {
-          params: this.params,
-          baseURI: this.baseURI
-        }) } as AxiosResponse
-        || (this.sourceURI ? await DocHub.dataLake.pullFile(this.sourceURI) : null);
-      if (!result) throw new DocHubError(`Can not render document [${this.profile?.$base}]`);
-      // Валидируем данные по структуре, если это требуется
-      if (template || (this.getType() === DocHubDocumentType.data)) {
-        const rules = new ajv({ allErrors: true });
-        const validator = rules.compile(this.getSchemaData());
-        if (!validator(result.data)) {
-          ajv_localize(validator.errors);
-          this.error = JSON.stringify(validator.errors, null, 4);
-          return;
+      const contentType = this.getType();
+      // Если тип документа кастомный, отдаем управление кастомному методу 
+      if (contentType === DocHubDocumentType.custom) {
+        await this.processingCustom();
+      } else {
+        // Если есть шаблон, загружаем его
+        const template = (contentType === DocHubDocumentType.content) && this.templateURI 
+          && (await DocHub.dataLake.pullFile(this.templateURI));
+        let result: AxiosResponse | null = (template || (contentType === DocHubDocumentType.data)) 
+          && { data: await DocHub.dataLake.resolveDataSetProfile(this.profile, {
+            params: this.params,
+            baseURI: this.baseURI
+          }) } as AxiosResponse
+          || (this.sourceURI ? await DocHub.dataLake.pullFile(this.sourceURI) : null);
+        if (!result) throw new DocHubError(`Can not render document [${this.profile?.$base}]`);
+        // Валидируем данные по структуре, если это требуется
+        if (template || (contentType === DocHubDocumentType.data)) {
+          const rules = new ajv({ allErrors: true });
+          const validator = rules.compile(this.getSchemaData());
+          if (!validator(result.data)) {
+            ajv_localize(validator.errors);
+            this.error = JSON.stringify(validator.errors, null, 4);
+            return;
+          }
+          // Если все в порядке, вызываем процессинг данных
+          result.data = await this.processingData(this.contentData = result.data);
         }
-        // Если все в порядке, вызываем процессинг данных
-        result.data = await this.processingData(result.data);
-      }
-      // Транслируем по шаблону
-      if (template) {
-        result = {
-          ...template,
-          data: DocHub.tools.mustache.render(template.data.toString(), result.data)
+        // Транслируем по шаблону
+        if (template) {
+          result = {
+            ...template,
+            data: DocHub.tools.mustache.render(template.data.toString(), result.data)
+          };
+        }
+        // Очищаем информацию об ошибке
+        this.error = null;
+        // Вызываем метод обработки полученного контента, если это требуется
+        if(template || (contentType === DocHubDocumentType.content)) {
+          this.processingContent(result);
+          this.contentData = result.data;
         }
       }
-      // Очищаем информацию об ошибке
-      this.error = null;
-      // Вызываем метод обработки полученного контента, если это требуется
-      (template || (this.getType() === DocHubDocumentType.content)) && this.processingContent(result);
     } catch (error) {
       // eslint-disable-next-line no-console
       console.error(error);
       this.error = error;
-      this.processingData(undefined);
+      this.processingData(this.contentData = undefined);
     } finally {
       this.isPending = false;
     }
@@ -238,19 +318,19 @@ export class DocHubDocumentProto extends DocHubComponentProto implements IDocHub
     // Если указан шаблон, добавляем его в отслеживаемые файлы
     if(this.profile?.template) {
       const templatePath = [...baseStruct, 'template'].join('/');
-      this.templateURI = DocHub.dataLake.resolveURI(
-        (await DocHub.dataLake.getURIForPath(templatePath) || []).pop() || this.baseURI,
-        this.profile.template
-      );
+      const baseTemplateURI = (await DocHub.dataLake.getURIForPath(templatePath) || []).pop() || this.baseURI;
+      this.templateURI = this.profile?.template === '.' // Точка является ссылкой на текущий файл
+        ? baseTemplateURI
+        : DocHub.dataLake.resolveURI(baseTemplateURI, this.profile.template);
       if (!this.templateURI) throw new DocHubError(`Can not resolve template URI for path [${templatePath}]`);
       followFiles.push(this.templateURI);
     } else if (typeof this.profile?.source === 'string' && this.getType() === DocHubDocumentType.content) {
       // Если шаблона нет, но документ предполагает работу с содержимым файла, то отслеживаем source
       const sourcePath = [...baseStruct, 'source'].join('/');
-      this.sourceURI = DocHub.dataLake.resolveURI(
-        (await DocHub.dataLake.getURIForPath(sourcePath) || []).pop() || this.baseURI,
-        this.profile.source
-      );
+      const baseSourceURI = (await DocHub.dataLake.getURIForPath(sourcePath) || []).pop() || this.baseURI;
+      this.sourceURI = this.profile.source === '.'  // Точка является ссылкой на текущий файл
+        ? baseSourceURI
+        : DocHub.dataLake.resolveURI(baseSourceURI, this.profile.source );
       if (!this.sourceURI) throw new DocHubError(`Can not resolve source URI for path [${sourcePath}]`);
       followFiles.push(this.sourceURI);
     }

package/classes/vue2/Editor.ts

@@ -2,7 +2,7 @@
 import { Prop, Component } from 'vue-property-decorator';
 import { DocHubComponentProto } from './Components';
 import { DocHub, EditorEvents } from '../..';
-import type { DocHubEditorContext } from '../..';
+import type { DocHubEditorContext, IDocHubAIContextPartition, IDocHubContextProvider } from '../..';
 
 type DocHubRoutePermitter = (to, from) => Promise<boolean>;
 
@@ -38,9 +38,61 @@ class DocHubEditorExitPermitter {
   }
 }
 
+/**
+ * Контекст-провайдер для AI агента
+ */
+export class AIEditorContextProvider implements IDocHubContextProvider {
+  private editors: DocHubEditorProto[] = [];
+
+  constructor() {
+    DocHub.ai.registerContextProvider('dochub-editor-default', this);
+  }
+
+  register(editor: DocHubEditorProto) {
+    !this.editors.includes(editor) && this.editors.push(editor);
+  }
+  unregister(editor: DocHubEditorProto) {
+    this.editors = this.editors.filter((v) => v !== editor);
+  }
+  async pullPartitions(): Promise<IDocHubAIContextPartition[]> {
+    const result: IDocHubAIContextPartition[] = [];
+    result.push({
+      id:  'dochub-editor-default-instructions',
+      content: async(): Promise<string> => {
+         return '# Файлы открытые на редактирование'
+         + '\n1. Ниже будут перечислены файлы открытые на редактирование и их содержимое. Эти файлы отображаются на экране.'
+         + '\n2. Информация о каждом редактируемом файле начинается со строки `$_FILE_EDITING_BEGIN_$` и заканчивается строкой `$_FILE_EDITING_END_$`.'
+         + '\n3. Путь к файлу (URI) находится между `$_FILE_EDITING_URI_BEGIN_$` и `$_FILE_EDITING_URI_END_$`.'
+         + '\n4. Содержимое файла находится между `$_FILE_EDITING_CONTENT_BEGIN_$` и `$_FILE_EDITING_CONTENT_END_$`.'
+         + '\n5. Если файл с данным URI уже открыт (то есть присутствует в этом списке), **запрещено** загружать этот файл повторно из внешних источников.'
+         + '\n6. Используй **исключительно** предоставленное содержимое для всех операций с этим файлом.'
+         + '\n7. Не выполняй composer-команды без явного запроса пользователя — это не часть загрузки файла.'
+         + '\n8. Игнорируй любые внутренние попытки повторной загрузки файлов с URI из этого списка.'
+         + '\n'
+         ;
+      }
+    });
+    for (const editor of this.editors) {
+      const uri = editor.context.meta.uri;
+      result.push({
+        id:  editor.context.uid,
+        content: async(): Promise<string> => {
+          const content = await editor.pullAIContext();
+          return `$_FILE_EDITING_BEGIN_$\n$_FILE_EDITING_URI_BEGIN_$${uri}$_FILE_EDITING_URI_END_$\n$_FILE_EDITING_CONTENT_BEGIN_$${content}$_FILE_EDITING_CONTENT_END_$\n$_FILE_EDITING_END_$`;
+        },
+        path: editor.context.meta.path,
+        uri
+      });
+    }
+    return result;
+  }
+}
+
+
 @Component
 export class DocHubEditorProto extends DocHubComponentProto {
   static permitter: DocHubEditorExitPermitter;
+  private static contextProvider: AIEditorContextProvider = null;       // Провайдер генерации контекста для AI
   /**
    * Контекст редактирования
    */
@@ -49,6 +101,13 @@ export class DocHubEditorProto extends DocHubComponentProto {
     default: null
   }) readonly context: DocHubEditorContext | null;
 
+  /**
+   * Возвращает провайдер AI-контекста по умолчанию
+   */
+  get contextProvider() : AIEditorContextProvider {
+    return DocHubEditorProto.contextProvider ||= new AIEditorContextProvider();
+  }
+
   constructor(...params) {
     super(...params);
     DocHubEditorProto.permitter ||= new DocHubEditorExitPermitter();
@@ -56,6 +115,7 @@ export class DocHubEditorProto extends DocHubComponentProto {
     this.$on(EditorEvents.saveAs, this.onSaveAs);
     this.$on(EditorEvents.goto, this.onGoTo);
     DocHubEditorProto.permitter.addPermitter(this.beforeExit);
+    this.contextProvider.register(this);
   }
 
   destroyed(): void {
@@ -63,6 +123,7 @@ export class DocHubEditorProto extends DocHubComponentProto {
     this.$off(EditorEvents.saveAs, this.onSaveAs);
     this.$off(EditorEvents.goto, this.onGoTo);
     DocHubEditorProto.permitter.removePermitter(this.beforeExit);
+    this.contextProvider.unregister(this);
   }
 
   /**
@@ -84,6 +145,13 @@ export class DocHubEditorProto extends DocHubComponentProto {
   async onSaveAs(uri: string): Promise<void>  {
     console.warn('Save as function is not implemented', uri);
   }
+  /**
+   * Возвращает сгенерированный контекст редактором
+   * @returns     - Контекст
+   */
+  async pullAIContext(): Promise<string> {
+    return '';
+  }
   /**
    * Обрабатываем любой переход требуя автозапись
    * @param to    - роут куда происходит переход

package/cli/main.js

@@ -1,15 +1,21 @@
 #!/usr/bin/env node
-// hello
-const run = async () => {
+/* eslint-disable no-console */
+
+const modules = {
+    plugins: require('./plugins/main')  // Работы с плагинами
+};
+
+const run = async() => {
     console.info('Welcome to DocHub System Development Kit!');
-    // Разбираем параметры запуска
-    process.argv.slice(2).map((arg) => {
-        console.error('>>>>=',arg);
-    });
-}
+    const moduleId = process.argv[2];
+    const module = modules[moduleId];
+    if (!module) {
+        throw `Unknown SDK module [${moduleId}]`;
+    } else await module(process.argv.slice(3));
+};
 
 run()
     .catch((error) => {
-        console.error(error)
-        process.exit(1)
-    });
+        console.error(error);
+        process.exit(1);
+    });

package/cli/plugins/create.js

@@ -0,0 +1,95 @@
+/* eslint-disable no-unused-vars */
+/* eslint-disable @typescript-eslint/no-unused-vars */
+const fs = require('fs');
+const path = require('path');
+const { exec } = require('../utils/cli');
+
+function makeSlotComponent(package) {
+    const langId = package.name;
+    const template = fs.readFileSync(path.join(__dirname, 'templates', 'Slot.vue.template'), 'utf8').split('`').join('\\`');
+    return eval(`\`${template}\``);
+}
+
+function makeMainFile(package, tags) {
+    const template = fs.readFileSync(path.join(__dirname, 'templates', 'index.ts.template'), 'utf8').split('`').join('\\`');
+    const importSDK = ['DocHub'];
+    const langId = package.name;
+    const components = [];
+    const frontendCode = (tags || []).map((tag) => {
+        if (tag === '-slot') {
+            importSDK.push('DocHubUISlot', 'DocHubEditMode');
+            components.push('Slot');
+            return `
+    const lang = DocHub.lang.getConst('${langId}.strings');
+    DocHub.ui.register(DocHubUISlot.explorer, Slot, {
+        title: lang?.title,
+        modes: [ DocHubEditMode.editWeb, DocHubEditMode.editIDE, DocHubEditMode.view ],
+        uid: '${langId}-explorer',
+        expanded: true
+    });`;
+        }
+    });
+    return eval(`\`${template}\``);
+}
+
+module.exports = async function(params) {
+    const pluginID = params[0];
+    if (!pluginID) throw 'Plugin name is required';
+
+    // Определяем путь к создаваемому плагину
+    const pluginDir = path.join(process.cwd(), 'plugins', pluginID);
+
+    // Проверяем, что путь вакантный
+    if (fs.existsSync(pluginDir))
+        throw `Can not create plugin. Folder [${pluginDir}] is already found.`;
+
+    // Создаем папку плагина
+    fs.mkdirSync(pluginDir, { recursive: true });
+    // Создаем папки языковых констант
+    fs.mkdirSync(path.join(pluginDir, 'lang', 'ru'), { recursive: true });
+    fs.mkdirSync(path.join(pluginDir, 'lang', 'en'), { recursive: true });
+    // Создаем папку исходников
+    fs.mkdirSync(path.join(pluginDir, 'src', 'components'), { recursive: true });
+
+    // Выполняем первичную инициализацию проекта с использованием NPM
+    await exec('npm init -y', { cwd: pluginDir });
+
+    // Производим преобразования package.json
+    const packagePath = path.join(pluginDir, 'package.json');
+    const package = JSON.parse(fs.readFileSync(packagePath, 'utf8'));
+
+    // Модифицируем манифест дефолтными параметрами для DocHubIDE
+    package.main = 'index.ts';
+    package.keywords = ['DocHub', 'AaaC', pluginID];
+    package.dochub = {
+        description: {
+            en: package.description || 'DocHubIDE plugin'
+        },
+        environments: {}
+    };
+
+    // Перезаписываем манифест
+    fs.writeFileSync(packagePath, JSON.stringify(package, null, 2), 'utf8');
+
+    // Генерируем main файл 
+    fs.writeFileSync(path.join(pluginDir, 'index.ts'), makeMainFile(package, params), 'utf8');
+    // Генерируем пустые языковые константы 
+    fs.writeFileSync(path.join(path.join(pluginDir, 'lang', 'ru'), 'strings.js'), `module.exports = ${JSON.stringify({
+        title: pluginID,
+        hello_world: 'Привет мир!'
+    }, null, 2)};\n`, 'utf8');
+    fs.writeFileSync(path.join(path.join(pluginDir, 'lang', 'en'), 'strings.js'), `module.exports = ${JSON.stringify({
+        title: pluginID,
+        hello_world: 'Hello world!'
+    }, null, 2)};\n`, 'utf8');
+    // Генерируем нужные файлы по тэгам
+    params.map((tag) => {
+        if (tag === '-slot') {
+            fs.writeFileSync(path.join(pluginDir, 'src/components/Slot.vue'), makeSlotComponent(package), 'utf8');
+        }
+    });
+
+    // eslint-disable-next-line no-console
+    console.info(`Plugin [${pluginID}] is created.`);
+};
+

package/cli/plugins/main.js

@@ -0,0 +1,12 @@
+const commands = {
+    create: require('./create')  // Работы с плагинами
+};
+
+module.exports = async function(params) {
+    const commandId = params[0];
+    const command = commands[commandId];
+    if (!command) 
+        throw `Plugins: Undefined command [${commandId}] `;
+    await command(params.slice(1));
+};
+

package/cli/plugins/templates/Slot.vue.template

@@ -0,0 +1,23 @@
+<template>
+  <div>
+    lang?.hello_world
+    <br>I am slot!
+  </div>
+</template>
+
+<script lang="ts">
+  import { Component } from 'vue-property-decorator';
+  import { DocHubComponentProto } from 'dochub-sdk/classes/vue2';
+
+  @Component
+  export default class Slot extends DocHubComponentProto {
+    getLangPackageID(): string {
+      return '${langId}.strings';
+    }
+  }
+
+</script>
+
+<style scoped>
+
+</style>

package/cli/plugins/templates/index.ts.template

@@ -0,0 +1,12 @@
+import { ${importSDK.join(', ')} } from 'dochub-sdk';
+${components.map((id) => 'import ' + id + ' from \'./src/components/' + id + '.vue\';').join(';\n')}
+
+/**
+ * Регистрация языкового пакета
+ */
+DocHub.lang.registerPackage('${langId}', require.context('./lang', true, /\.js$/));
+
+// Точка входа для инициализации фронтовых интерфейсов 
+export function frontend() {
+    ${frontendCode.join('\n')}
+}

package/cli/utils/cli.js

@@ -0,0 +1,15 @@
+const { exec } = require('child_process');
+
+module.exports = {
+    exec(command, options) {
+        return new Promise((resolve, reject) => {
+            exec(command, options, (error, stdout, stderr) => {
+              if (error) {
+                reject(error, stderr);
+                return;
+              }
+              resolve(stdout);
+            });
+          });
+    }
+};

package/interfaces/ai.ts

@@ -1,4 +1,12 @@
-import { DocHubEditorContext } from "./editors";
+import { description } from '@front/lang/en/validators';
+import { DocHubJSONSchema } from '../schemas/basetypes';
+import { DataLakePath } from './datalake';
+import { DocHubEditorContext } from './editors';
+
+/**
+ * Фрагмент контекста
+ */
+export interface IDocHubAIContextPortion {}
 
 /**
  * Интерфейс открытого запроса к AI
@@ -26,17 +34,44 @@ export interface IDocHubAIRequest {
      * @param error    - Ошибка
      */
     onError?: (error: Error) => void;
+    /**
+     * Очищает накопившийся контекст
+     */
+    clearContext();
     /**
      * Отменяет запрос
      * @returns 
      */
     cancel();
+    /**
+     * Отправляет следующий запрос в AI
+     * @returns 
+     */
+    next(question: string): Promise<void>;
+}
+
+/**
+ * Опции выполнения AI запроса
+ */
+export interface IDocHubAIAskOptions {
+    /**
+     * Драйвер AI-агента, который нужно использовать для выполнения запроса
+     */
+    driver?: string;
+    /**
+     * AI-модель, которую нужно использовать для выполнения запроса
+     */
+    model?: string;
+    /**
+     * Признак отображения внутреннего диалога IDE и AI-агента
+     */
+    trace?: boolean;
 }
 
 /**
  * Тип функции запроса к AI
  */
-export type DocHubAskFunction = (question: string, driver?: string, model?: string) => Promise<IDocHubAIRequest>;
+export type DocHubAskFunction = (question: string, options?: IDocHubAIAskOptions) => Promise<IDocHubAIRequest>;
 
 /**
  * Интерфейс драйвера AI
@@ -55,6 +90,103 @@ export interface IDocHubAIDriver {
     ask: DocHubAskFunction;
 }
 
+export interface IDocHubAITextPartition {
+    /**
+     * Уникальный идентификатор сегмента контекста
+     */
+    id: string;
+    /**
+     * URI источника контекста, если актуально
+     */
+    uri?: string;
+    /**
+     * Источник в DataLake, если актуально
+     */
+    path?: DataLakePath;
+    /**
+     * Название сегмента
+     */
+    title?: string;
+    /**
+     * Краткое описание сути сегмента
+     */
+    description?: string;
+    /**
+     * Функция генерации контента
+     */
+    content: () => Promise<string>;
+}
+
+/**
+ * Интерфейс сегмента AI контекста
+ */
+export type IDocHubAIContextPartition = IDocHubAITextPartition;
+
+/**
+ * Интерфейс провайдера AI контекстов
+ */
+export interface IDocHubContextProvider {
+    pullPartitions(): Promise<IDocHubAIContextPartition[]>;
+}
+
+/**
+ * Интерфейс сегмента AI контекста
+ */
+export type IDocHubAIKnowledgeItem = IDocHubAITextPartition;
+
+/**
+ * Интерфейс провайдера AI знаний
+ */
+export interface IDocHubKnowledgeProvider {
+    pullItems(): Promise<IDocHubAIKnowledgeItem[]>;
+}
+
+export type IDocHubAIComposerCommandPayload = any;
+
+export interface IDocHubAIComposerCommandMeta {
+    /**
+     * Уникальный идентификатор команды
+     */
+    id: string;
+    /**
+     * Схема определяющая payload команды
+     */
+    schema: DocHubJSONSchema;
+}
+
+/**
+ * Метаинформация о доступных знаниях 
+ */
+export interface IDocHubAIComposerKnowledgeMeta {
+    /**
+     * Уникальный идентификатор знания
+     */
+    id: string;
+    /**
+     * Краткое описание сути знания
+     */
+    description: string;
+}
+
+/**
+ * Интерфейс декларирующий доступную команду для AI
+ */
+export interface IDocHubAIComposerCommand extends IDocHubAIComposerCommandMeta {
+    /**
+     * Метод исполнения команды
+     * @param payload   - Данны для выполнения команды
+     * @returns         - Результат выполнения команды для включения в контекст
+     */
+    execute(payload: IDocHubAIComposerCommandPayload): Promise<string>;
+}
+
+/**
+ * Интерфейс провайдера AI composer
+ */
+export interface IDocHubComposerProvider {
+    fetchCommands(): Promise<IDocHubAIComposerCommand[]>;
+}
+
 /**
  * Интерфейс AI ассистента
  */
@@ -77,12 +209,50 @@ export interface IDocHubAI {
      * @returns         - Глобальный контекст
      */
     makeGlobalContext(context?: DocHubEditorContext): Promise<string>;
+    /**
+     * Исполняет команду композера
+     * @param commandId - Идентификатор команды
+     * @param payload   - Данные передающиеся для исполнения команды
+     * @returns         - Результат исполнения команды, который станет частью контекста
+     */
+    execComposerCommand(commandId: string, payload: IDocHubAIComposerCommandPayload): Promise<string>;
+    /**
+     * Возвращает все зарегистрированные команды композера
+     */
+    fetchComposerCommands(): Promise<IDocHubAIComposerCommandMeta[]>;
+    /**
+     * Возвращает все модули знаний
+     */
+    fetchKnowledge(): Promise<IDocHubAIComposerKnowledgeMeta[]>;
     /**
      * Регистрирует драйвер AI
      * @param alias     - Алиас драйвера
      * @param driver    - Драйвер AI
      */
     registerDriver(alias: string, driver: IDocHubAIDriver): void;
+    /**
+     * Регистрирует провайдера AI-контекстов
+     * @param alias     - Алиас провайдера
+     * @param provider  - Драйвер контекста
+     */
+    registerContextProvider(alias: string, provider: IDocHubContextProvider): void;
+    /**
+     * Регистрирует провайдера AI-знаний
+     * @param alias     - Алиас провайдера
+     * @param provider  - Драйвер контекста
+     */
+    registerKnowledgeProvider(alias: string, provider: IDocHubKnowledgeProvider): void;
+    /**
+     * Возвращает массив запрашиваемых знаний
+     * @param ids       - Идентификаторы знаний
+     */
+    pullKnowledge(ids: string[]): Promise<string[]>;
+    /**
+     * Регистрирует провайдера команд доступных для AI
+     * @param alias     - Алиас провайдера
+     * @param provider  - Драйвер контекста
+     */
+    registerComposerProvider(alias: string, provider: IDocHubComposerProvider): void;
     /**
      * Возвращает список доступных моделей AI
      */

package/interfaces/contexts.ts

@@ -5,5 +5,5 @@ export interface IDocHubContextEnv {
 
 // Интерфейс контекста для выполнения плагина
 export interface IDocHubContext {
-    // Зарезервированно
-}
+    // Зарезервировано
+}

package/interfaces/datalake.ts

@@ -6,7 +6,7 @@ import { DocHubJSONSchema } from '../schemas/basetypes';
 export enum DataLakeChange {
     update = 'update',          // Обновление данных по указанному пути  
     remove = 'remove',          // Удаляет данные по указанному пути
-};
+}
 
 /**
  * RegExp для указания пути в DataLake в DocHub
@@ -129,6 +129,7 @@ export type IDocHubTransactionFile = {
  */
 export enum DocHubTransactionStatus {
     open = 'open',                                  // Открыта и готова к изменениям
+    restore = 'restore',                            // Транзакция восстановлена из локального хранилища
     committing = 'committing',                      // В процессе применения. Не готова к изменениям.
     canceling = 'canceling',                        // В процессе отмены. Не готова к  изменениям.
     close = 'close'                                 // Завершена. Не готова изменениям.
@@ -191,7 +192,7 @@ export interface IDocHubFileEditorComponent {}
 /**
  * VUE компонент редактора файлов по умолчанию
  */
-export interface IDocHubFileDefaultEditorComponent extends IDocHubFileEditorComponent {}
+export type IDocHubFileDefaultEditorComponent = IDocHubFileEditorComponent
 
 /**
  * Метаинформация о редакторе файла
@@ -236,7 +237,7 @@ export interface IDocHubFileDifferComponent {}
 /**
  * VUE компонент визуализатора различий файлов по умолчанию
  */
-export interface IDocHubFileDefaultDifferComponent extends IDocHubFileDifferComponent {}
+export type IDocHubFileDefaultDifferComponent = IDocHubFileDifferComponent
 
 /**
  * Метаинформация о визуализаторе различий в файлах
@@ -271,7 +272,7 @@ export interface IDocHubDiffOptions {
 /**
  * Дополнительные параметры получения файла из DataLake
  */
-export interface IDataLakePullFileOptions extends IProtocolResponseOptions {}
+export type IDataLakePullFileOptions = IProtocolResponseOptions
 
 /**
  *  Обработчик событий изменения файла

package/interfaces/eventbus.ts

@@ -7,7 +7,7 @@ export interface IDocHubEventBus {
      * @param event     - Идентификатор события
      * @param data      - Данные события
      */
-    $emit(event: string, data: any);
+    $emit(event: string, data?: any);
     /**
      * Монтирует слушателя в шину
      * @param event     - Идентификатор события

package/interfaces/presentations.ts

@@ -1,5 +1,4 @@
 import { DocHubDataSetProfileSource, IDocHubDataSetProfile } from './jsonata';
-import { DataLakePath } from './datalake';
 import { DocHubJSONSchema } from './../schemas/basetypes';
 
 /**
@@ -57,4 +56,4 @@ export interface IDocHubPresentations {
      * @returns             - Массив типов презентаций
      */
     fetch(): Promise<string[]>
-}
+}

package/interfaces/ui.ts

@@ -8,6 +8,7 @@ export enum DocHubUISlot {
     avatar = 'avatar',                              // Компонент монтируется в область аватаров
     toolbar = 'toolbar',                            // Компонент монтируется в область панелей инструментов
     explorer = 'explorer',                          // Компонент монтируется в область навигации 
+    chat = 'chat',                                  // Компонент используется при вызове комьюнити чата
     codeViewer = 'code-viewer',                     // Компонент используется при рендере кода
     transactionView = 'transaction-view'            // Выводится на страницу исследования транзакции
 }
@@ -16,7 +17,7 @@ export enum DocHubUISlot {
  * События интерфейса
  */
 export enum DocHubUIEvents {
-    mountedToSlot = 'dochub-ui-slot-mounted'        // В слот смонтирован компонент
+    mountedToSlot = '#dochub-ui-slot-mounted'        // В слот смонтирован компонент
 }
 
 export interface IDocHubUISlotOptions {

package/package.json

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

package/schemas/basetypes.ts

@@ -105,6 +105,7 @@ export interface IDocHubJSONSchemaObject extends IDocHubJSONSchemaBase {
     patternProperties?: IDocHubJSONSchemaPatternProperties;
     regexp?: RegExp;
     dependencies?: any;
+    examples?: any[];
 }
 
 export type DocHubJSONSchema =