dochub-sdk 0.1.62 → 0.1.63

package/.vscode/settings.json

@@ -4,6 +4,7 @@
         "Задекларированные",
         "задекларированным",
         "задекларированных",
-        "Параметризируемый"
+        "Параметризируемый",
+        "PROPFIND"
     ]
 }

package/interfaces/protocols.ts

@@ -5,32 +5,100 @@ import { IDocHubContext } from './contexts';
 export interface IDocHubProtocolRequestConfig extends AxiosRequestConfig {
     decoder?: Function;  // Декодировщик ответа
 };
+
 export interface IDocHubProtocolResponse extends AxiosResponse {};
 
+/**
+ * Предопределенные типы контентов
+ */
+export enum DocHubContentType {
+    folder = 'dochub/folder'
+}
+
+/**
+ * Тип ресурса
+ */
+export enum DocHubResourceType {
+    file = 'file',
+    folder = 'folder',
+    other = 'other'
+}
+
+/**
+ * Метаинформация о файле
+ */
+export type DocHubResourceMetaFile = {
+    type: DocHubResourceType.file,
+    name: string,
+    contentType: DocHubContentType | string
+}
+
+/**
+ * Метаинформация о папке
+ */
+export type DocHubResourceMetaFolder = {
+    type: DocHubResourceType.folder,
+    files: DocHubResourceMetaFile[]
+}
+
+/**
+ * Метаинформация о прочих ресурсах
+ */
+export type DocHubResourceMetaOther = {
+    type: DocHubResourceType.other,
+    [prop: string]: any
+}
+
+type DocHubResourceMeta = DocHubResourceMetaFile | DocHubResourceMetaFolder | DocHubResourceMetaOther;
+
 /**
  * Методы доступные над ресурсом
  */
 export enum IDocHubProtocolMethods {
+    // Classic
     GET = 'GET',
     POST = 'POST',
     DELETE = 'DELETE',
     HEAD = 'HEAD',
     PUT = 'PUT',
     PATCH = 'PATCH',
-    OPTIONS = 'OPTIONS'
+    OPTIONS = 'OPTIONS',
+    // WebDAV - Расширенные методы для работы ресурсами
+    SCAN = 'SCAN'       // Сканирует ресурс URI и возвращает о нем расширенную информацию в формате DocHubResourceMeta
+                        // Позволяет получать список файлов в папке
 };
 
-// Интерфейс транспортного протокола
+/**
+ * Интерфейс транспортного протокола
+ */
 export interface IDocHubProtocol {
-    // Признак активности протокола
+    /**
+     * Признак активности протокола
+     * @returns          - Возвращает true если протолок активен
+     */
     isActive(): boolean;
-    // Метод инициализации протокола
+    /**
+     * Метод инициализации протокола
+     * @param context    - Контекст функционирования протокола
+     */
     bootstrap(context: IDocHubContext);
-    // Разрешение ссылок
+    /**
+     * Разрешает ссылки
+     * @param args       - Массив прямых и/или относительных URI
+     * @returns          - Результирующий URI в формате протокола
+     */
     resolveURL(...args: string[]): string;
-    // Выполняет запрос к DataLake
+    /**
+     * Выполняет запрос к ресурсу по аналогии с axios
+     * @param config
+     * @returns          - Результат выполнения запроса
+     */
     request(config: IDocHubProtocolRequestConfig): Promise<IDocHubProtocolResponse>;
-    // Возвращает список методов доступных для указанного ресурса
+    /**
+     * Возвращает список методов доступных для указанного ресурса
+     * @param uri        - Идентификатор ресурса
+     * @returns          - Массив доступных методов для ресурса
+     */
     availableMethodsFor(uri: string): Promise<IDocHubProtocolMethods[]>;
 }
 

package/package.json

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