dochub-sdk 0.1.191 → 0.1.193

package/classes/errors.ts

@@ -1,3 +1,6 @@
+import { DocHub } from '..';
+import { DataLakePath } from '../interfaces/datalake';
+import { IDocHubProblem } from '../interfaces/problems';
 /**
  * Класс внутренних ошибок DocHub
  */
@@ -5,4 +8,25 @@ export class DocHubError extends Error {
     constructor(...params) {
       super(...params);
     }
+}
+/**
+ * Класс ошибок, являющихся проблемами для разрешения пользователем
+ */
+export class DocHubProblem extends DocHubError implements IDocHubProblem {
+  uid: string;
+  title: string;
+  description: string;
+  location?: string | undefined;
+  path?: DataLakePath | DataLakePath[] | undefined;
+  correction?: string | undefined;
+  constructor(data: IDocHubProblem) {
+    super(`Registered problem [${data.uid}]: ${data.title}`, { cause: data });
+    this.uid = data.uid;
+    this.title = data.uid;
+    this.description = data.description;
+    this.location = data.location;
+    this.path = data.path;
+    this.correction = data.correction;
+    DocHub.problems.emit(this);
+  }
 }

package/interfaces/problems.ts

@@ -1,4 +1,86 @@
+import { DataLakePath } from "./datalake";
+import { IDocHubDataSetProfile } from "./datasets";
+
+export type IDocHubProblemUID = string;
+export type IDocHubValidatorUID = string;
+
+/**
+ * Валидаторы проблем
+ */
+export interface IDocHubValidator extends IDocHubDataSetProfile {
+    /**
+     * Идентификатор валидатора
+     */
+    uid: IDocHubValidatorUID;
+    /**
+     * Название валидатора
+     */
+    title: string;
+}
+/**
+ * Исключения для регистрации проблем
+ */
+export interface IDocHubException {
+    /**
+     * Идентификатор проблемы, которая считается исключением
+     */
+    uid: IDocHubProblemUID;
+    /**
+     * Причина исключения
+     */
+    reason: string;
+}
+/**
+ * Зарегистрированная проблема
+ */
+export interface IDocHubProblem {
+    /**
+     * Уникальный идентификатор выявленной проблемы
+     */
+    uid: IDocHubProblemUID; 
+    /**
+     * Краткое описание / название проблемы
+     */
+    title: string;
+    /**
+     * Описание возникшей проблемы
+     */
+    description: string;
+    /**
+     * URI выявленной проблемы
+     */
+    location?: string;
+    /**
+     * Путь к проблемному объекту/ам в datalake
+     */
+    path?: DataLakePath | DataLakePath[];
+    /**
+     * Предложения о том, как исправить проблему
+     */
+    correction?: string;
+}
+
 export interface IDocHubProblems {
-    // Регистрирует ошибку в системе
+    /**
+     * Очищает список зарегистрированных проблем
+     */
+    clean();
+    /**
+     * Запускает процесс анализа проблем
+     */
+    review();
+    /**
+     * Регистрирует проблему в системе
+     * @param problem       - 
+     * @param title 
+     * @param uid 
+     */
     emit(problem: Error, title?: string, uid?: string);
+    /**
+     * Регистрирует проблему в системе
+     * @param problem 
+     * @param title 
+     * @param uid 
+     */
+    emit(problem: IDocHubProblem);
 }

package/interfaces/ui.ts

@@ -11,6 +11,13 @@ export enum DocHubUISlot {
     codeViewer = 'code-viewer'      // Компонент используется при рендере кода
 }
 
+/**
+ * События интерфейса
+ */
+export enum DocHubUIEvents {
+    mountedToSlot = 'dochub-ui-slot-mounted'        // В слот смонтирован компонент
+}
+
 export interface IDocHubUISlotOptions {
     /**
      * Заголовок компонента
@@ -156,5 +163,4 @@ export interface IDocHubUI {
      * @param options           - Параметры сохранения на клиентском устройстве
      */
     copyToClipboard(content: string | ArrayBuffer, options?:IDocHubUICopyClipboardOptions): Promise<void>;
-
 }

package/package.json

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