dochub-sdk 0.1.365 → 0.1.367

package/.vscode/settings.json

@@ -12,6 +12,7 @@
         "datalake",
         "eventbus",
         "GPLV",
+        "jsonata",
         "localstorage",
         "metamodel",
         "Nata",

package/index.ts

@@ -19,7 +19,7 @@ export * from './interfaces/settings';
 export * from './interfaces/ui';
 export * from './interfaces/tools';
 export * from './interfaces/lang';
-export * from './interfaces/datasets';
+export * from './interfaces/jsonata';
 export * from './metamodel/index';
 export * from './interfaces/ai';
 export * from './interfaces/explainer';

package/interfaces/core.ts

@@ -16,6 +16,7 @@ import { IDocHubTools } from './tools';
 import { IDocHubLang } from './lang';
 import { IDocHubAI } from './ai';
 import { IDocHubExplainer } from './explainer';
+import { IDocHubJSONata } from './jsonata';
 /**
  * Интерфейс ядра
  */
@@ -92,6 +93,10 @@ export interface IDocHubCore {
      * Стандартные утилиты облегчающие разработку расширений DocHub
      */
     tools: IDocHubTools;
+    /**
+     * Интерфейс доступа к DocHubJSONata движку
+     */
+    jsonata: IDocHubJSONata;
     /**
      * Версия ядра
      * @returns     - Версия ядра в формате *.*.*

package/interfaces/datalake.ts

@@ -1,5 +1,5 @@
 import { IProtocolResponseOptions, IDocHubProtocolResponse, IDocHubResourceVersion } from './protocols';
-import { DocHubDataSetProfileSource, DocHubJSONataQuery, IDocHubDataSetProfile } from './datasets';
+import { DocHubDataSetProfileSource, DocHubJSONataQuery, IDocHubDataSetProfile } from './jsonata';
 import { DocHubUITargetWindow } from './ui';
 import { DocHubJSONSchema } from '../schemas/basetypes';
 
@@ -287,57 +287,6 @@ export interface IDataSetResolveOptions {
 }
 
 
-export enum DocHubDataLakeDebuggerHandleActions {
-    run = 'run',    // Продолжить выполнение
-    next = 'next',  // Перейти на следующий шаг
-    into = 'into',  // Войти в подпрограмму
-    stop = 'stop'   // Прервать выполнение 
-}
-
-/**
- * Специальный тип запросов в отладчик.
- * Если запрос начинается на $, считается, что запрос должен вернуть значение переменной из контекста выполнения
- */
-export type DocHubDebuggerQuery = `$${string}` | DocHubJSONataQuery;
-
-export type DocHubDataLakeDebuggerQuery = (expression: DocHubDebuggerQuery) => Promise<any>;
-
-
-/**
- * Элемент стека выполнения запросов в DataLake
- */
-export interface IDocHubDataLakeDebuggerCallStackItem {
-    position: number;                       // Указывает на каком символе в source сейчас выполнение
-    source: () => Promise<string>;          // Возвращает исходный код запроса
-    variables: () => Promise<string[]>;     // Возвращает список переменных запроса
-    query: DocHubDataLakeDebuggerQuery;     // Выполнение произвольного запроса в контексте данного запроса
-}
-
-/**
- * Стек запросов в DataLake
- */
-export type DocHubDataLakeDebuggerCallStack = IDocHubDataLakeDebuggerCallStackItem[];
-
-/**
- * Контекст запроса в DataLake
- */
-export interface IDocHubDataLakeDebuggerContext {
-    uid: string;                                                    // Идентификатор запроса
-    stack?: () => Promise<DocHubDataLakeDebuggerCallStack>;         // Стек выполнения запроса
-    terminated?: boolean;                                           // Признак завершения выполнения запроса        
-}
-
-/**
- * Интерфейс внутрисистемного отладчика
- */
-export interface IDocHubDataLakeDebugger {
-    /**
-     * Метод вызывается при необходимости отладочного действия
-     * @param context           - контекст исполнения кода
-     */
-    handle(context: IDocHubDataLakeDebuggerContext): Promise<DocHubDataLakeDebuggerHandleActions>;
-}
-
 /**
  * Интерфейс доступа к DataLake
  */
@@ -591,15 +540,6 @@ export interface IDocHubDataLake {
      */
     getContentTypeForFile(file: string): string | null;
 
-    /*********************************************************************
-     *        Внутрисистемный отладчик запросов к DataLake
-     *********************************************************************/
-    /**
-     * Регистрирует отладчик в системе
-     * @param debug             - Объект реализующий отладчик
-     */
-    registerDebugger(debug: IDocHubDataLakeDebugger);
-
     /**
      * Возвращает JSONSchema DataLake
      */

package/interfaces/jsonata.ts

@@ -0,0 +1,185 @@
+import { DocHubJSONSchema } from '../schemas/basetypes';
+import { DocHubDataLakeInitializedStatus, IDocHubTransaction } from './datalake';
+
+/**
+ * Идентификатор источника данных
+ */
+export type DocHubDataSetID =  string;
+/**
+ * Данные не требующие обработку
+ */
+export type DocHubDataSetData = object;
+/**
+ * JSONata запрос с расширенными свойствами
+ */
+
+/**
+ * Простое, строковое определение JSONata запроса
+ */
+export type DocHubJSONataQuerySimple = `(${string})` | `jsonata(${string})`;
+
+/**
+ * Ссылка на JSONata файл
+ */
+export type DocHubJSONataFile = `${string}.jsonata`;
+
+/**
+ * Метаинформация JSONata запроса
+ */
+export interface DocHubJSONataQueryMeta {
+    /**
+     * URI ресурса, где декларирован запрос 
+     */
+    source?: string;
+    /**
+     * Путь к свойству определения
+     */
+    path?: string;
+}
+
+/**
+ * Класс, позволяет создавать запросы с расширенной информацией об источнике его происхождения
+ * для удобства отладки.
+ */
+export class DocHubJSONataQueryObject extends String {
+    /**
+     * URI ресурса, где определен запрос
+     */
+    private uri: string | undefined;
+    /**
+     * Путь к определению запроса
+     */
+    private path: string | undefined;
+    constructor(query: DocHubJSONataQuerySimple, uri?: string, path?: string) {
+        super(query);
+        this.uri = uri;
+        this.path = path;
+        return this;
+    }
+    get __uri__(): string | undefined {
+        return this.uri;
+    }
+    get __path__(): string | undefined {
+        return this.path;
+    }
+}
+
+/**
+ * JSONata запрос
+ */
+export type DocHubJSONataQuery =  DocHubJSONataQuerySimple | DocHubJSONataQueryObject;
+
+/**
+ * Ссылка на файл данных
+ */
+export type DocHubDataFileFile = string;
+/**
+ * Тип поля source описывающий возможные источники данных
+ */
+export type DocHubDataSetProfileSource = DocHubDataSetID | DocHubJSONataQuery | DocHubJSONataFile | DocHubDataFileFile | DocHubDataSetData;
+/**
+ * Набор источников для поля origin
+ */
+export interface DocHubDataSetProfileOriginSet {
+    [key: string]: DocHubDataSetProfileSource
+}
+/**
+ * Тип поля origin для источника данных
+ */
+export type DocHubDataSetProfileOrigin = DocHubDataSetProfileSource | DocHubDataSetProfileOriginSet;
+
+/**
+ * Интерфейс стандартизирующий источник данных
+ */
+export interface IDocHubDataSetProfile {
+    origin?: DocHubDataSetProfileOrigin;
+    source: DocHubDataSetProfileSource;
+}
+
+export enum DocHubDataLakeDebuggerHandleActions {
+    run = 'run',    // Продолжить выполнение
+    next = 'next',  // Перейти на следующий шаг
+    into = 'into',  // Войти в подпрограмму
+    stop = 'stop'   // Прервать выполнение 
+}
+
+/**
+ * Специальный тип запросов в отладчик.
+ * Если запрос начинается на $, считается, что запрос должен вернуть значение переменной из контекста выполнения
+ */
+export type DocHubDebuggerQuery = `$${string}` | DocHubJSONataQuery;
+
+export type DocHubDataLakeDebuggerQuery = (expression: DocHubDebuggerQuery) => Promise<any>;
+
+
+/**
+ * Элемент стека выполнения запросов в DataLake
+ */
+export interface IDocHubDataLakeDebuggerCallStackItem {
+    position: number;                       // Указывает на каком символе в source сейчас выполнение
+    source: () => Promise<string>;          // Возвращает исходный код запроса
+    variables: () => Promise<string[]>;     // Возвращает список переменных запроса
+    query: DocHubDataLakeDebuggerQuery;     // Выполнение произвольного запроса в контексте данного запроса
+}
+
+/**
+ * Стек запросов в DataLake
+ */
+export type DocHubDataLakeDebuggerCallStack = IDocHubDataLakeDebuggerCallStackItem[];
+
+/**
+ * Контекст запроса в DataLake
+ */
+export interface IDocHubDataLakeDebuggerContext {
+    uid: string;                                                    // Идентификатор запроса
+    stack?: () => Promise<DocHubDataLakeDebuggerCallStack>;         // Стек выполнения запроса
+    terminated?: boolean;                                           // Признак завершения выполнения запроса        
+}
+
+/**
+ * Интерфейс внутрисистемного отладчика
+ */
+export interface IDocHubDataLakeDebugger {
+    /**
+     * Метод вызывается при необходимости отладочного действия
+     * @param context           - контекст исполнения кода
+     */
+    handle(context: IDocHubDataLakeDebuggerContext): Promise<DocHubDataLakeDebuggerHandleActions>;
+}
+
+export type JSONataExpression = string;
+export interface JSONataExpressionBinds {
+    [variable: string]: any;
+}
+
+/**
+ * Интерфейс объекта запроса
+ */
+export interface IDocHubJSONataQuery {
+    /**
+     * Выполняет запрос
+     */
+    evaluate(context: JSONataExpression, binds?: JSONataExpressionBinds): Promise<any>;
+}
+
+/**
+ * Интерфейс к движку JSONata
+ */
+export interface IDocHubJSONata {
+    /**
+     * Регистрирует отладчик в системе
+     * @param debug             - Объект реализующий отладчик
+     */
+    registerDebugger(debug: IDocHubDataLakeDebugger);
+
+    /**
+     * Создает объект запроса
+     */
+    expression(query: JSONataExpression): Promise<IDocHubJSONataQuery>;
+
+    /**
+     * Метод временный на период миграции к полной асинхронности
+     */
+    expressionLocal(query: JSONataExpression): IDocHubJSONataQuery;
+}
+

package/interfaces/presentations.ts

@@ -1,4 +1,4 @@
-import { DocHubDataSetProfileSource, IDocHubDataSetProfile } from './datasets';
+import { DocHubDataSetProfileSource, IDocHubDataSetProfile } from './jsonata';
 import { DataLakePath } from './datalake';
 import { DocHubJSONSchema } from './../schemas/basetypes';
 

package/metamodel/entity.ts

@@ -1,4 +1,4 @@
-import { DocHubJSONataQuery } from '../interfaces/datasets';
+import { DocHubJSONataQuery } from '../interfaces/;
 import { 
     DocHubJSONSchema
 } from '../schemas/basetypes';

package/package.json

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

package/plugins/manifest.ts

@@ -19,6 +19,27 @@ export interface IDocHubPluginEnvironmentsOneOf extends IDocHubJSONSchemaBase {
     oneOf: IDocHubJSONSchemaObject[]; 
 }
 
+export interface IDocHubManifestProps {
+    building: {
+        // Момент сборки
+        moment: number;
+        // Версия SDK сборки
+        'dochub-sdk': string;
+        // Коммит
+        commit: string;
+        // Версия node при сборке
+        node: string;
+        // Версия приложения в формате xx.xx.xx
+        version: string;
+    }
+}
+
+export type IDocHubManifestPlugins = string[];
+
+export interface IDocHubManifestEnvironments {
+    [module: string]: string;
+}
+
 export type IDocHubPluginEnvironments = 
     | IDocHubJSONSchemaObject
     | IDocHubPluginEnvironmentsAllOf
@@ -33,8 +54,6 @@ export interface IDocHubPluginManifest {
     name: string;
     // Описание плагина
     description?: string;
-    // Версия в формате xx.xx.xx
-    version: string;
     // Ключевые слова для поиска в репозитории плагинов
     keywords?: string[];
     // Автор/вендор
@@ -47,15 +66,10 @@ export interface IDocHubPluginManifest {
         repository: string;
         support: string;
     }
-    // Информация о сборке
-    building?: {
-        // Момент сборки
-        moment: number;
-        // Коммит
-        commit: string;
-    },
-    // Зависимости
-    dependencies?: IDocHubManifestDependencies;
-    // Переменные окружения требуемые для работы плагина
-    environments?: IDocHubPluginEnvironments;
+    // Свойства приложения
+    app_props: IDocHubManifestProps;
+    // Подключаемые плагины
+    app_plugins?: IDocHubManifestPlugins;
+    // Переменные среды исполнения
+    app_environments?: IDocHubManifestEnvironments;
 }

package/interfaces/datasets.ts

@@ -1,95 +0,0 @@
-/**
- * Идентификатор источника данных
- */
-export type DocHubDataSetID =  string;
-/**
- * Данные не требующие обработку
- */
-export type DocHubDataSetData = object;
-/**
- * JSONata запрос с расширенными свойствами
- */
-
-/**
- * Простое, строковое определение JSONata запроса
- */
-export type DocHubJSONataQuerySimple = `(${string})` | `jsonata(${string})`;
-
-/**
- * Ссылка на JSONata файл
- */
-export type DocHubJSONataFile = `${string}.jsonata`;
-
-/**
- * Метаинформация JSONata запроса
- */
-export interface DocHubJSONataQueryMeta {
-    /**
-     * URI ресурса, где декларирован запрос 
-     */
-    source?: string;
-    /**
-     * Путь к свойству определения
-     */
-    path?: string;
-}
-
-/**
- * Класс, позволяет создавать запросы с расширенной информацией об источнике его происхождения
- * для удобства отладки.
- */
-export class DocHubJSONataQueryObject extends String {
-    /**
-     * URI ресурса, где определен запрос
-     */
-    private uri: string | undefined;
-    /**
-     * Путь к определению запроса
-     */
-    private path: string | undefined;
-    constructor(query: DocHubJSONataQuerySimple, uri?: string, path?: string) {
-        super(query);
-        this.uri = uri;
-        this.path = path;
-        return this;
-    }
-    get __uri__(): string | undefined {
-        return this.uri;
-    }
-    get __path__(): string | undefined {
-        return this.path;
-    }
-}
-
-/**
- * JSONata запрос
- */
-export type DocHubJSONataQuery =  DocHubJSONataQuerySimple | DocHubJSONataQueryObject;
-
-/**
- * Ссылка на файл данных
- */
-export type DocHubDataFileFile = string;
-/**
- * Тип поля source описывающий возможные источники данных
- */
-export type DocHubDataSetProfileSource = DocHubDataSetID | DocHubJSONataQuery | DocHubJSONataFile | DocHubDataFileFile | DocHubDataSetData;
-/**
- * Набор источников для поля origin
- */
-export interface DocHubDataSetProfileOriginSet {
-    [key: string]: DocHubDataSetProfileSource
-}
-/**
- * Тип поля origin для источника данных
- */
-export type DocHubDataSetProfileOrigin = DocHubDataSetProfileSource | DocHubDataSetProfileOriginSet;
-
-/**
- * Интерфейс стандартизирующий источник данных
- */
-export interface IDocHubDataSetProfile {
-    origin?: DocHubDataSetProfileOrigin;
-    source: DocHubDataSetProfileSource;
-}
-