dochub-sdk 0.1.163 → 0.1.165

package/classes/vue2/Documents.ts

@@ -6,6 +6,16 @@ import type { IDocHubEditableComponent, IDocHubPresentationProfile, IDocHubPrese
 import ajv from 'ajv';
 import ajv_localize from 'ajv-i18n/localize/ru';
 
+/**
+ * Тип в источнике данных
+ */
+export enum DocumentSourceType {
+  data          = 'data',         // Объект данных не требующий обработки
+  jsonata       = 'jsonata',      // JSONata запрос
+  dataFile      = 'data-file',    // Ссылка на файл с данными
+  jsonataFile   = 'jsonata-file'  // Ссылка на файл с запросом jsonata
+};
+
 @Component
 export class DocHubDocumentProto extends Vue implements IDocHubEditableComponent {
   onRefresher: any = null;          // Таймер отложенного выполнения обновления
@@ -81,6 +91,14 @@ export class DocHubDocumentProto extends Vue implements IDocHubEditableComponent
    */
   getSchemaData(): any {}
 
+  /**
+   * Определяет тип данных 
+   * @param source 
+   */
+  getSourceType(source: any) {
+
+  }
+
   /** 
    * Для переопределения
    */

package/index.ts

@@ -19,6 +19,8 @@ export * from './interfaces/ui';
 export * from './interfaces/tools';
 export * from './interfaces/lang';
 
+export * from './interfaces/datasets';
+
 export * from './schemas/basetypes';
 export * from './schemas/dochub-yaml';
 

package/interfaces/datalake.ts

@@ -1,5 +1,6 @@
-import { AxiosResponse } from "axios";
-import { IProtocolResponseOptions } from "./protocols";
+import { AxiosResponse } from 'axios';
+import { IProtocolResponseOptions } from './protocols';
+import { IDocHubDataSetProfile } from './datasets';
 
 export enum DataLakeChange {
     update = 'update',          // Обновление данных по указанному пути  
@@ -194,12 +195,18 @@ export type DocHubDataLakeRequest = string;
 export interface IDataLakePullFileOptions extends IProtocolResponseOptions {
 }
 
-
 /**
  *  Обработчик событий изменения файла
  */
 export type DocHubDataLakeFileFollower = () => void;
 
+/**
+ * Дополнительные параметры разрешения профиля набора данных
+ */
+export interface IDataSetResolveOptions {
+    baseURI?: string;               // Базовый URI от которого будут разрешаться все относительные пути на файлы
+    params?: IDocHubPullDataParams; // Передаваемые параметры
+}
 
 // Интерфейс доступа к DataLake
 export interface IDocHubDataLake {
@@ -288,6 +295,14 @@ export interface IDocHubDataLake {
      */
     pullData(expression: DocHubDataLakeRequest, params?: IDocHubPullDataParams, context?: any): Promise<any>;
 
+    /**
+     * Реализует профиль набора данных (выполняет профиль)
+     * @param profile           - Профиль набора данных
+     * @param options           - Параметры реализации профиля
+     * @returns                 - Результат реализации профиля (результат выполненных запросов)
+     */
+    resolveDataSetProfile(profile: IDocHubDataSetProfile, options?: IDataSetResolveOptions): Promise<any>;
+
     /**
      * Сохраняет файла в DataLake
      * @param uri               - URI файла во внутреннем формате DocHub

package/interfaces/datasets.ts

@@ -0,0 +1,43 @@
+/**
+ * Идентификатор источника данных
+ */
+export type DocHubDataSetID =  string;
+/**
+ * Данные не требующие обработку
+ */
+export type DocHubDataSetData = object;
+/**
+ * JSONata запрос
+ */
+export type DocHubJSONataQuery =  `(${string})` | `jsonata(${string})`;
+/**
+ * Ссылка на JSONata файл
+ */
+export type DocHubJSONataFile =  `${string}.jsonata`;
+/**
+ * Ссылка на файл данных
+ */
+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;
+}
+

package/package.json

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