dochub-sdk 0.1.236 → 0.1.238

package/interfaces/datalake.ts

@@ -1,5 +1,4 @@
-import { AxiosResponse } from 'axios';
-import { IProtocolResponseOptions } from './protocols';
+import { IProtocolResponseOptions, IDocHubProtocolResponse } from './protocols';
 import { DocHubDataSetProfileSource, IDocHubDataSetProfile } from './datasets';
 import { DocHubUITargetWindow } from './ui';
 
@@ -214,18 +213,7 @@ export interface IDocHubFileDifferItem {
 /**
  * Функция, которая должна вернуть контент версии при необходимости
  */
-export type DocHubVersionContentResolver = () => Promise<AxiosResponse>;
-
-/**
- * Интерфейс реализует доступ к заданной версии файла
- */
-export interface IDocHubFileVersion {
-    version: string;                        // Идентификатор версии
-    uri: string;                            // URI файла версии
-    moment: Date;                           // Дата и время версии
-    author: string;                         // Автор версии
-    pull: DocHubVersionContentResolver;     // Функция получения контента версии
-}
+export type DocHubVersionContentResolver = () => Promise<IDocHubProtocolResponse>;
 
 /**
  * Тип отображения различий
@@ -365,7 +353,7 @@ export interface IDocHubDataLake {
      * @param contentType       - Тип контента
      * @returns                 - Статус выполненного запроса
      */
-    pushFile(uri: string, content: any, contentType: string): Promise<AxiosResponse>;
+    pushFile(uri: string, content: any, contentType: string): Promise<IDocHubProtocolResponse>;
 
     /**
      * Устанавливает слежение за изменениями в файле
@@ -386,7 +374,7 @@ export interface IDocHubDataLake {
      * @param uri               - URI файла во внутреннем формате DocHub
      * @returns                 - Результат выполнения запроса
      */
-    pullFile(uri: string, options?: IDataLakePullFileOptions): Promise<AxiosResponse>;
+    pullFile(uri: string, options?: IDataLakePullFileOptions): Promise<IDocHubProtocolResponse>;
 
     /**
      * Возвращает конечный URI на основании массива относительных и прямых URI
@@ -436,21 +424,12 @@ export interface IDocHubDataLake {
 
     /**
      * Запрос на открытие визуализатора различий на просмотр. Необязательно будет выполнен.
-     * @param ver1              - Версия 1
-     * @param ver2              - Версия 2
-     * @param context           - Контекст редактирования файла. Необходим для связных редакторов и конструкторов.
+     * @param uri               - URI файла
+     * @param versions          - Версии для сравнения
+     * @param options           - Опции сравнения
      * @returns                 - Компонент редактора, если открытие оказалось успешным
      */
-    openFileDiffer(ver1: IDocHubFileVersion, ver2: IDocHubFileVersion, options?: IDocHubDiffOptions): Promise<void>;
-
-    /**
-     * Запрос на открытие визуализатора различий на просмотр. Необязательно будет выполнен.
-     * @param uri               - URI файла для которого нужно получить список версий
-     * @param from              - С какой версии получать список
-     * @param limit             - Количество записей в возвращаемом массиве
-     * @returns                 - Список доступных версий файла
-     */
-    fetchFileVersions(uri: string, from?: IDocHubFileVersion, limit?: number): Promise<IDocHubFileVersion[]>;
+    openFileDiffer(uri: string, versions: string[], options?: IDocHubDiffOptions): Promise<void>;
 
     /**********************************************************************
      *                    Редактирование файлов

package/interfaces/protocols.ts

@@ -11,23 +11,29 @@ export enum ProtocolOptionsResponseTypes {
 }
 
 /**
- * Опции получения файла из DataLake
+ * Опции получения ответа из DataLake
  */
 export interface IProtocolResponseOptions {
     responseType?: ProtocolOptionsResponseTypes;
     responseEncoding?: string;
+    // Версия файла в формате определяемом драйвером
     timeout?: number;
+    // Версия файла в формате определяемом протоколом
+    version?: string;     
 }
 
-export type FDocHubProtocolResponseDecoder = (response: AxiosResponse, options?: IProtocolResponseOptions) => Promise<AxiosResponse>;
+export interface IDocHubProtocolResponse extends AxiosResponse {
+    // Версия файла в формате определяемом протоколом
+    version?: string;     
+}
+
+export type FDocHubProtocolResponseDecoder = (response: IDocHubProtocolResponse, options?: IProtocolResponseOptions) => Promise<IDocHubProtocolResponse>;
 
 // Прослойка интерфейсов Axios для последующей кастомизации и поддержания совместимости
 export interface IDocHubProtocolRequestConfig extends AxiosRequestConfig {
     decoder?: FDocHubProtocolResponseDecoder;  // Декодировщик ответа
 };
 
-export interface IDocHubProtocolResponse extends AxiosResponse {};
-
 /**
  * Тип ресурса
  */
@@ -68,6 +74,17 @@ export type DocHubResourceMetaOther = {
 
 export type DocHubResourceMeta = DocHubResourceMetaFile | DocHubResourceMetaFolder | DocHubResourceMetaOther;
 
+/**
+ * Информация о версии ресурса
+ */
+export interface IDocHubResourceVersion {
+    version: string;                        // Идентификатор версии в формате определенном протоколом
+    uri: string;                            // URI файла версии
+    moment: Date;                           // Дата и время версии
+    author: string;                         // Автор версии
+}
+
+
 /**
  * Методы доступные над ресурсом
  */
@@ -81,8 +98,9 @@ export enum DocHubProtocolMethods {
     PATCH = 'PATCH',
     OPTIONS = 'OPTIONS',
     // WebDAV - Расширенные методы для работы ресурсами
-    SCAN = 'SCAN'       // Сканирует ресурс URI и возвращает о нем расширенную информацию в формате DocHubResourceMeta
-                        // Позволяет получать список файлов в папке
+    SCAN = 'SCAN',          // Сканирует ресурс URI и возвращает о нем расширенную информацию в формате DocHubResourceMeta
+                            // Позволяет получать список файлов в папке
+    VERSIONS = 'VERSIONS'   // Возвращает доступные версии ресурса в формате IDocHubResourceVersion
 };
 
 /**

package/package.json

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