dochub-sdk 0.1.389 → 0.1.390

package/index.ts

@@ -27,7 +27,7 @@ export * from './interfaces/libraries';
 export * from './interfaces/shared';
 
 export * from './schemas/basetypes';
-export * from './schemas/formats';
+export * from './schemas/fields/suggester';
 export * from './schemas/dochub-yaml';
 export * from './schemas/schema';
 

package/interfaces/datalake.ts

@@ -2,7 +2,7 @@ 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 { DocHubJSONSchemaFormat, DocHubJSONSchemaFormatCollection, DocHubJSONSchemaFormatController } from '../schemas/fields/suggester';
 import { IDocHubDataLakeSchema } from '../schemas/schema';
 
 export enum DataLakeChange {

package/interfaces/protocols.ts

@@ -66,7 +66,7 @@ export type DocHubResourceMetaFile = {
 export type DocHubResourceMetaFolder = {
     type: DocHubResourceType.folder;
     uri: string;
-    files?: DocHubResourceMetaFile[]        // Если undefined - статус содержания файлов не определен
+    files?: DocHubResourceMetaFile[] | DocHubResourceMetaFolder[]        // Если undefined - статус содержания файлов не определен
 }
 
 /**
@@ -75,7 +75,7 @@ export type DocHubResourceMetaFolder = {
 export type DocHubResourceMetaBranch = {
     type: DocHubResourceType.branch,
     uri: string;
-    files?: DocHubResourceMetaFile[]        // Если undefined - статус содержания файлов не определен
+    files?: DocHubResourceMetaFile[] | DocHubResourceMetaFolder[]        // Если undefined - статус содержания файлов не определен
 }
 
 /**

package/package.json

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

package/schemas/fields/suggester.ts

@@ -0,0 +1,70 @@
+import { DocHubJSONSchema } from "../basetypes";
+
+/**
+ * Идентификатор применяемого подсказчика
+ */
+export type DocHubJSONSchemaSuggesterID = string;
+
+/**
+ * Структура подсказки
+ */
+export interface DocHubJSONSchemaSuggest {
+    // Отображаемая подсказка
+    label: string;
+    // Значение, которое будет применено. Если не указано, то label
+    apply?: string;
+    // Детальное описание для выбора подсказки
+    detail?: string;
+}
+
+/**
+ * Метод получения следующей порции подсказок
+ * @param limit     - лимит на количество подсказок
+ */
+export type DocHubJSONSchemaSuggestFetch = (limit?: number) => Promise<DocHubJSONSchemaSuggests>;
+
+/**
+ * Список подсказок.
+ * Если элемент списка является функцией, это является промисом на вставку элементов списка при ее вызове
+ */
+export type DocHubJSONSchemaSuggests = (DocHubJSONSchemaSuggest | DocHubJSONSchemaSuggestFetch)[];
+
+export interface DocHubJSONSchemaSuggestControllerParams {
+    // Значение
+    value: any;
+    // Схема, которая применяется к значению
+    valueSchema: DocHubJSONSchema;
+    // URI ресурса, который редактируется
+    uri?: string;
+    // Контекст в котором происходит валидация значения
+    context?: any;
+    // Схема контекста
+    contextSchema?: DocHubJSONSchema;
+}
+
+/**
+ * Интерфейс для кастомного формата
+ */
+export interface DocHubJSONSchemaSuggestController {
+    /**
+     * Возвращает список подсказок в виде списка 
+     * @param params            - параметры для выбора
+     * @returns                 - список подсказок
+     */
+    suggests(params: DocHubJSONSchemaSuggestControllerParams): Promise<DocHubJSONSchemaSuggests>;
+    /**
+     * Если метод определен, его вызов должен открыть специальный UI, 
+     * который позволит пользователю осуществить корректный ввод или выбор значения
+     * @param params            - параметры для выбора
+     * @returns                 - значение для заполнения поля
+     */
+    input?: (params: DocHubJSONSchemaSuggestControllerParams) => Promise<any>;
+}
+
+/**
+ * Коллекция форматов 
+ */
+export interface DocHubJSONSchemaSuggesterCollection {
+    [id: DocHubJSONSchemaSuggesterID]: DocHubJSONSchemaSuggestController;
+}
+

package/schemas/schema.ts

@@ -1,9 +1,9 @@
 import { DocHubJSONSchema } from "./basetypes";
 import {
-    DocHubJSONSchemaFormat,
-    DocHubJSONSchemaFormatCollection,
-    DocHubJSONSchemaFormatController
-} from "./formats";
+    DocHubJSONSchemaSuggestController,
+    DocHubJSONSchemaSuggesterCollection,
+    DocHubJSONSchemaSuggesterID
+} from "./fields/suggester";
 
 /**
  * Схема данных DataLake
@@ -16,14 +16,18 @@ export interface IDocHubDataLakeSchema {
     fetch(): Promise<DocHubJSONSchema>;
 
     /**
-     * Регистрирует кастомный формат для валидации JSONSchema и реализации подсказок в редакторах
+     * Регистрирует кастомный подсказчик для JSONSchema
      * @param format            - Идентификатор формата
      * @param controller        - Контроллер обрабатывающий запросы к формату
      */
-    registerSchemaFormat(format: DocHubJSONSchemaFormat, controller: DocHubJSONSchemaFormatController);
+    registerSuggester(suggester: DocHubJSONSchemaSuggesterID, controller: DocHubJSONSchemaSuggestController);
 
     /**
-     * Возвращает коллекцию доступных форматов
+     * Возвращает список доступных подсказчиков 
      */
-    fetchSchemaFormats(): Promise<DocHubJSONSchemaFormatCollection>;
+    fetchSuggesters(): Promise<DocHubJSONSchemaSuggesterID[]>;
+    /**
+     * Возвращает контроллер подсказчика
+     */
+    getSuggester(suggesterId: DocHubJSONSchemaSuggesterID): Promise<DocHubJSONSchemaSuggestController>;
 }

package/schemas/formats.ts

@@ -1,80 +0,0 @@
-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;
-}
-