dochub-sdk 0.1.387 → 0.1.388

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/index.ts CHANGED
@@ -29,6 +29,7 @@ export * from './interfaces/shared';
29
29
  export * from './schemas/basetypes';
30
30
  export * from './schemas/formats';
31
31
  export * from './schemas/dochub-yaml';
32
+ export * from './schemas/schema';
32
33
 
33
34
  export * from './plugins/manifest';
34
35
  export * from './plugins/module';
@@ -1,8 +1,9 @@
1
1
  import { IProtocolResponseOptions, IDocHubProtocolResponse, IDocHubResourceVersion } from './protocols';
2
2
  import { DocHubDataSetProfileSource, DocHubJSONataQuery, IDocHubDataSetProfile } from './jsonata';
3
3
  import { DocHubUITargetWindow } from './ui';
4
- import { DocHubJSONSchema, DocHubJSONSchemaPath, DocHubJSONSchemaPathPattern, DocHubJSONSchemaPathResolver } from '../schemas/basetypes';
4
+ import { DocHubJSONSchema } from '../schemas/basetypes';
5
5
  import { DocHubJSONSchemaFormat, DocHubJSONSchemaFormatCollection, DocHubJSONSchemaFormatController } from '../schemas/formats';
6
+ import { IDocHubDataLakeSchema } from '../schemas/schema';
6
7
 
7
8
  export enum DataLakeChange {
8
9
  update = 'update', // Обновление данных по указанному пути
@@ -548,21 +549,8 @@ export interface IDocHubDataLake {
548
549
 
549
550
 
550
551
  /**
551
- * Возвращает JSONSchema DataLake
552
- * @param path - Путь к необходимому сегменту схемы
552
+ * Возвращает интерфейс доступа к схеме данных DataLake
553
553
  */
554
- fetchSchema(path?: DocHubJSONSchemaPath): Promise<DocHubJSONSchema>;
555
-
556
- /**
557
- * Регистрирует кастомный формат для валидации JSONSchema и реализации подсказок в редакторах
558
- * @param pattern - Шаблон пути по которому подключается резолвер
559
- * @param context - Контекст работы резолвера
560
- */
561
- registerSchemaFormat(format: DocHubJSONSchemaFormat, controller: DocHubJSONSchemaFormatController);
562
-
563
- /**
564
- * Возвращает коллекцию доступных форматов
565
- */
566
- fetchSchemaFormats(): Promise<DocHubJSONSchemaFormatCollection>;
554
+ schema(): Promise<IDocHubDataLakeSchema>;
567
555
  }
568
556
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "dochub-sdk",
3
- "version": "0.1.387",
3
+ "version": "0.1.388",
4
4
  "description": "The DocHub System Development Kit.",
5
5
  "private": false,
6
6
  "main": "index.ts",
@@ -0,0 +1,29 @@
1
+ import { DocHubJSONSchema } from "./basetypes";
2
+ import {
3
+ DocHubJSONSchemaFormat,
4
+ DocHubJSONSchemaFormatCollection,
5
+ DocHubJSONSchemaFormatController
6
+ } from "./formats";
7
+
8
+ /**
9
+ * Схема данных DataLake
10
+ */
11
+ export interface IDocHubDataLakeSchema {
12
+ /**
13
+ * Возвращает JSONSchema DataLake
14
+ * @param path - Путь к необходимому сегменту схемы
15
+ */
16
+ fetch(): Promise<DocHubJSONSchema>;
17
+
18
+ /**
19
+ * Регистрирует кастомный формат для валидации JSONSchema и реализации подсказок в редакторах
20
+ * @param format - Идентификатор формата
21
+ * @param controller - Контроллер обрабатывающий запросы к формату
22
+ */
23
+ registerSchemaFormat(format: DocHubJSONSchemaFormat, controller: DocHubJSONSchemaFormatController);
24
+
25
+ /**
26
+ * Возвращает коллекцию доступных форматов
27
+ */
28
+ fetchSchemaFormats(): Promise<DocHubJSONSchemaFormatCollection>;
29
+ }