dochub-sdk 0.1.386 → 0.1.388

package/index.ts

@@ -27,7 +27,9 @@ export * from './interfaces/libraries';
 export * from './interfaces/shared';
 
 export * from './schemas/basetypes';
+export * from './schemas/formats';
 export * from './schemas/dochub-yaml';
+export * from './schemas/schema';
 
 export * from './plugins/manifest';
 export * from './plugins/module';

package/interfaces/ai.ts

@@ -1,7 +1,7 @@
-import { description } from '@front/lang/en/validators';
 import { DocHubJSONSchema } from '../schemas/basetypes';
 import { DataLakePath } from './datalake';
 import { DocHubEditorContext } from './editors';
+import { DocHubLangString } from './lang';
 
 /**
  * События AI 
@@ -10,11 +10,15 @@ export enum DocHubAIEvents {
     /**
      * Глобальные события
      */
-    setDefaultDriver = '$ai-change-default-driver',  // Драйвер AI по умолчанию изменился
+    changedDefaultDriver = '$ai-changed-default-driver',    // Драйвер AI по умолчанию изменился
+    /**
+     * Изменены настройки AI-агента
+     */
+    changedDriverConfig = '$ai-changed-driver-config',      // Изменилась конфигурация драйвера
     /**
      * Локальные события
      */
-    registeredDriver = '#ai-registered-driver',  // Зарегистрирован драйвер AI
+    registeredDriver = '#ai-registered-driver',             // Зарегистрирован драйвер AI
 };
 
 /**
@@ -61,7 +65,7 @@ export interface IDocHubAIRequest {
      * Отправляет следующий запрос в AI
      * @returns 
      */
-    next(question: string): Promise<void>;
+    next(question: string, attachment?: DocHubAIAskAttachment): Promise<void>;
 }
 
 export type DocHubAIAskAttachmentFileContent = string;
@@ -233,16 +237,16 @@ export enum DocHubAICapabilityID {
     contextWindow = 'context-window'
 }
 
-export type DocHubAIAttachmentFileContentType = string;
+export type DocHubAIAttachmentFileContentType = string; // Тип файла в формате расширения (.png) или в формате MIME type (image/*)
 
 /**
  * Метаинформация о возможностях AI-агента
  */
 export interface IDocHubAICapabilities {
     /**
-     * Текстовое резюме от AI
+     * Текстовое резюме от AI о себе
      */
-    description?: string;
+    description?: DocHubLangString;
     /**
      * Способность обрабатывать прикрепленные файлы к сообщению
      */
@@ -257,7 +261,6 @@ export interface IDocHubAICapabilities {
     [DocHubAICapabilityID.contextWindow]?: number;
 }
 
-
 /**
  * Интерфейс AI ассистента
  */

package/interfaces/datalake.ts

@@ -2,6 +2,8 @@ import { IProtocolResponseOptions, IDocHubProtocolResponse, IDocHubResourceVersi
 import { DocHubDataSetProfileSource, DocHubJSONataQuery, IDocHubDataSetProfile } from './jsonata';
 import { DocHubUITargetWindow } from './ui';
 import { DocHubJSONSchema } from '../schemas/basetypes';
+import { DocHubJSONSchemaFormat, DocHubJSONSchemaFormatCollection, DocHubJSONSchemaFormatController } from '../schemas/formats';
+import { IDocHubDataLakeSchema } from '../schemas/schema';
 
 export enum DataLakeChange {
     update = 'update',          // Обновление данных по указанному пути  
@@ -539,11 +541,16 @@ export interface IDocHubDataLake {
      * @param file              - Полный путь к файлу. Например: README.md
      * @returns                 - Тип контента. Например: text/markdown
      */
-    getContentTypeForFile(file: string): string | null;
+    getContentTypeForFile(uri: string): string | null;
+
+    /**********************************************************************
+     *                    Работа с схемой данных DataLake
+     *********************************************************************/
+
 
     /**
-     * Возвращает JSONSchema DataLake
+     * Возвращает интерфейс доступа к схеме данных DataLake
      */
-    fetchSchema(): Promise<DocHubJSONSchema>;
+    schema(): Promise<IDocHubDataLakeSchema>;
 }
 

package/interfaces/lang.ts

@@ -1,3 +1,16 @@
+/**
+ * Строковое значение для нескольких языков
+ */
+export type DocHubLangStringMultilang = {
+    [lang: string]: string;
+}
+
+/**
+ * Строковое значение для организации мультиязычности.
+ * Если имеет простой тип string - предполагается, что строка на английском. 
+ */
+export type DocHubLangString = string | DocHubLangStringMultilang;
+
 /**
  * События языковых пакетов
  */
@@ -52,4 +65,5 @@ export interface IDocHubLang {
      * @returns             - Возвращает действующий язык
      */
     switchTo(lang: string): Promise<string>;
+
 }

package/package.json

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

package/schemas/basetypes.ts

@@ -108,6 +108,7 @@ export interface IDocHubJSONSchemaObject extends IDocHubJSONSchemaBase {
     examples?: any[];
 }
 
+
 export type DocHubJSONSchema = 
     IDocHubJSONSchemaArray 
     | IDocHubJSONSchemaString
@@ -118,4 +119,3 @@ export type DocHubJSONSchema =
     | IDocHubJSONSchemaAllOf
     | IDocHubJSONSchemaOneOf
     | IDocHubJSONSchemaAnyOf;
-

package/schemas/formats.ts

@@ -0,0 +1,80 @@
+import { DocHubJSONSchema } from "./basetypes";
+
+/**
+ * Идентификатор применяемого формата
+ */
+export type DocHubJSONSchemaFormat = string;
+
+/**
+ * Идентификатор подсказки
+ */
+export type DocHubJSONSchemaFormatSuggestId = string;
+
+/**
+ * Структура подсказки
+ */
+export interface DocHubJSONSchemaFormatSuggest {
+    // Идентификатор
+    id: DocHubJSONSchemaFormatSuggestId;
+    // Значение, которое будет вставлено в структуру, при выборе подсказки
+    value: any;
+    // Краткое название для вывода в списке. Если поля нет, берется value
+    title?: string;
+    // Описание элемента подсказки
+    description?: string;
+}
+
+/**
+ * Метод получения следующей порции подсказок
+ * @param limit     - лимит на количество подсказок
+ */
+export type DocHubJSONSchemaFormatSuggestFetch = (limit?: number) => Promise<DocHubJSONSchemaFormatSuggests>;
+
+/**
+ * Список подсказок.
+ * Если элемент списка является функцией, это является промисом на вставку элементов списка при ее вызове
+ */
+export type DocHubJSONSchemaFormatSuggests = (DocHubJSONSchemaFormatSuggest | DocHubJSONSchemaFormatSuggestFetch)[];
+
+export interface DocHubJSONSchemaFormatControllerParams {
+    // Значение
+    value: any;
+    // Схема, которая применяется к значению
+    valueSchema: DocHubJSONSchema;
+    // Контекст в котором происходит валидация значения
+    context?: any;
+    // Схема контекста
+    contextSchema?: DocHubJSONSchema;
+}
+
+/**
+ * Интерфейс для кастомного формата
+ */
+export interface DocHubJSONSchemaFormatController {
+    /**
+     * Валидатор значения
+     * @returns                 - true если все в порядке, иначе false
+     */
+    validate(params: DocHubJSONSchemaFormatControllerParams): Promise<boolean>;
+    /**
+     * Возвращает список простых подсказок в виде списка 
+     * @param params            - параметры для выбора
+     * @returns                 - список подсказок
+     */
+    suggests?: (params: DocHubJSONSchemaFormatControllerParams) => Promise<DocHubJSONSchemaFormatSuggests>;
+    /**
+     * Если метод определен, его вызов должен открыть специальный UI, 
+     * который позволит пользователю осуществить корректный ввод или выбор значения
+     * @param params            - параметры для выбора
+     * @returns                 - значение для заполнения поля
+     */
+    input?: (params: DocHubJSONSchemaFormatControllerParams) => Promise<any>;
+}
+
+/**
+ * Коллекция форматов 
+ */
+export interface DocHubJSONSchemaFormatCollection {
+    [id: DocHubJSONSchemaFormat]: DocHubJSONSchemaFormatController;
+}
+

package/schemas/schema.ts

@@ -0,0 +1,29 @@
+import { DocHubJSONSchema } from "./basetypes";
+import {
+    DocHubJSONSchemaFormat,
+    DocHubJSONSchemaFormatCollection,
+    DocHubJSONSchemaFormatController
+} from "./formats";
+
+/**
+ * Схема данных DataLake
+ */
+export interface IDocHubDataLakeSchema {
+    /**
+     * Возвращает JSONSchema DataLake
+     * @param path              - Путь к необходимому сегменту схемы
+     */
+    fetch(): Promise<DocHubJSONSchema>;
+
+    /**
+     * Регистрирует кастомный формат для валидации JSONSchema и реализации подсказок в редакторах
+     * @param format            - Идентификатор формата
+     * @param controller        - Контроллер обрабатывающий запросы к формату
+     */
+    registerSchemaFormat(format: DocHubJSONSchemaFormat, controller: DocHubJSONSchemaFormatController);
+
+    /**
+     * Возвращает коллекцию доступных форматов
+     */
+    fetchSchemaFormats(): Promise<DocHubJSONSchemaFormatCollection>;
+}