dochub-sdk 0.1.328 → 0.1.330

package/.vscode/settings.json

@@ -7,11 +7,18 @@
         "коммита",
         "коммите",
         "Параметризируемый",
+        "Промис",
         "basetypes",
         "datalake",
         "eventbus",
+        "GPLV",
         "localstorage",
+        "metamodel",
         "Nata",
-        "PROPFIND"
+        "Piontik",
+        "PROPFIND",
+        "uids",
+        "unfollow",
+        "Vuetify"
     ]
 }

package/interfaces/ai.ts

@@ -1,3 +1,5 @@
+import { DocHubEditorContext } from "./editors";
+
 /**
  * Интерфейс открытого запроса к AI
  */
@@ -69,6 +71,12 @@ export interface IDocHubAI {
      * @returns           - Запрос к AI
     */
     ask: DocHubAskFunction;
+    /**
+     * Создает глобальный контекст на основании встроенных механизмов
+     * @param context   - Пользовательский контекст. Если не указан, то будет использован текущий контекст
+     * @returns         - Глобальный контекст
+     */
+    makeGlobalContext(context?: DocHubEditorContext): Promise<string>;
     /**
      * Регистрирует драйвер AI
      * @param alias     - Алиас драйвера

package/interfaces/datalake.ts

@@ -1,6 +1,7 @@
 import { IProtocolResponseOptions, IDocHubProtocolResponse, IDocHubResourceVersion } from './protocols';
 import { DocHubDataSetProfileSource, DocHubJSONataQuery, IDocHubDataSetProfile } from './datasets';
 import { DocHubUITargetWindow } from './ui';
+import { DocHubJSONSchema } from '../schemas/basetypes';
 
 export enum DataLakeChange {
     update = 'update',          // Обновление данных по указанному пути  
@@ -592,5 +593,10 @@ export interface IDocHubDataLake {
      * @param debug             - Объект реализующий отладчик
      */
     registerDebugger(debug: IDocHubDataLakeDebugger);
+
+    /**
+     * Возвращает JSONSchema DataLake
+     */
+    fetchSchema(): Promise<DocHubJSONSchema>;
 }
 

package/interfaces/presentations.ts

@@ -1,6 +1,6 @@
 import { DocHubDataSetProfileSource, IDocHubDataSetProfile } from './datasets';
 import { DataLakePath } from './datalake';
-import { IDocHubSchema } from './../schemas/basetypes';
+import { DocHubJSONSchema } from './../schemas/basetypes';
 
 /**
  * Идентификатор типа презентации
@@ -30,7 +30,7 @@ export interface IDocHubPresentationProfile extends IDocHubDataSetProfile {
     // Шаблон представления
     template?: string;
     // Схема требуемых параметров для презентации
-    params?: IDocHubSchema;
+    params?: DocHubJSONSchema;
     // Пользовательский конструктор профиля презентации
     $constructor?: DocHubDataSetProfileSource;
     // Базовый путь к объекту от которого будут разрешаться все относительные пути

package/package.json

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

package/schemas/basetypes.ts

@@ -1,28 +1,95 @@
 /**
- * Базовые типы схем
+ * Базовая схема для всех типов
  */
-export enum BaseTypes {
-    object = 'object',
-    string = 'string'
+export interface IDocHubJSONSchemaBase {
+    title?: string;             // Название
+    description?: string;       // Описание
+    default?: any;              // Значение по умолчанию
+    examples?: any[];           // Примеры использования
 }
 
 /**
- * Свойства объекта
+ * Базовые типы
  */
-export interface IDocHubSchemaProperties {
-    [key: string]: IDocHubSchema;
+export enum DocHubJSONSchemaBasicTypes {
+    boolean     = 'boolean',
+    null        = 'null',
+    string      = 'string',
+    number      = 'number',
+    integer     = 'integer',
+    array       = 'array',
+    object      = 'object'
 }
 
-/**
- * JSON Schema
- */
-export interface IDocHubSchema {
-    title: string;
-    type: BaseTypes;
-    properties?: IDocHubSchemaProperties;
-    patternProperties?: IDocHubSchemaProperties;
-    required?: string[];
-    pattern?: string;
+export interface ISchemaArray extends IDocHubJSONSchemaBase {
+    type: DocHubJSONSchemaBasicTypes.array;
+    items: DocHubJSONSchema;
+    minItems?: number;
+    maxItems?: number;
+    uniqueItems?: boolean;
+}
+
+export interface ISchemaBoolean extends IDocHubJSONSchemaBase {
+    type: DocHubJSONSchemaBasicTypes.boolean;
+}
+
+export interface ISchemaNull extends IDocHubJSONSchemaBase {
+    type: DocHubJSONSchemaBasicTypes.null;
+}
+
+export enum SchemaStringFormat {
+    date        = 'date',
+    datetime    = 'date-time',
+    enum        = 'enum',
+    string      = 'string',
+    label       = 'label',
+    textarea    = 'textarea',
+    alert       = 'alert'
+}
+
+export interface ISchemaString extends IDocHubJSONSchemaBase {
+    type: DocHubJSONSchemaBasicTypes.string;
+    minLength?: number;
+    maxLength?: number;
+    enum?: string[];
+    format?: SchemaStringFormat;
+}
+
+export interface ISchemaNumber extends IDocHubJSONSchemaBase {
+    type: DocHubJSONSchemaBasicTypes.number;
+    minimum?: number;
+    maximum?: number;
+    exclusiveMinimum?: number;
+    exclusiveMaximum?: number;
+    multipleOf?: any;
+}
+
+export interface ISchemaInteger extends IDocHubJSONSchemaBase {
+    type: DocHubJSONSchemaBasicTypes.integer;
+    minimum?: number;
+    maximum?: number;
+    exclusiveMinimum?: number;
+    exclusiveMaximum?: number;
+    multipleOf?: any;
+}
+
+export interface ISchemaObjectProperties {
+    [key: string]: DocHubJSONSchema;
+}
+
+export interface ISchemaObject extends IDocHubJSONSchemaBase {
+    type: DocHubJSONSchemaBasicTypes.object;
+    properties: ISchemaObjectProperties;
     additionalProperties?: boolean;
+    required?: string[];
+    minProperties?: number;
+    maxProperties?: number;
+    patternProperties?: RegExp;
+    regexp?: RegExp;
+    dependencies?: any;
+    // Порядок вывода полей сверху вниз и слева направо
+    order?: string[];
 }
 
+export type DocHubJSONSchema = ISchemaArray | ISchemaString | ISchemaNumber | ISchemaInteger | ISchemaObject | ISchemaBoolean;
+