dochub-sdk 0.1.276 → 0.1.278

package/.vscode/settings.json

@@ -5,6 +5,7 @@
         "задекларированным",
         "задекларированных",
         "коммита",
+        "коммите",
         "Параметризируемый",
         "basetypes",
         "datalake",

package/interfaces/datalake.ts

@@ -110,7 +110,6 @@ export interface IDocHubTransactionChangeRecord extends IDocHubResourceVersion {
  * Метаданные файла входящего в транзакцию
  */
 export type IDocHubTransactionFile = {
-    uid: string;                                    // UUID записи
     uri: string;                                    // URI файла
     content: string;                                // Содержимое файла
     headers: IDocHubTransactionFileHeaders;         // Заголовки (метаданные) файла
@@ -429,6 +428,21 @@ export interface IDocHubDataLake {
      */
     pushFile(uri: string, content: any, contentType: string): Promise<IDocHubProtocolResponse>;
 
+    /**
+     * Удаляет файл из DataLake
+     * @param uri               - URI файла во внутреннем формате DocHub
+     * @returns                 - Статус выполненного запроса
+     */
+    deleteFile(uri: string): Promise<IDocHubProtocolResponse>;
+
+    /**
+     * Переименовывает файл в DataLake
+     * @param oldURI            - URI файла который переименовывается
+     * @param newURI            - URI в который файл переименовывается
+     * @returns                 - Статус выполненного запроса
+     */
+    renameFile(oldURI: string, newURI: string): Promise<IDocHubProtocolResponse>;
+
     /**
      * Устанавливает слежение за изменениями в файле
      * @param uri               - URI файла

package/interfaces/protocols.ts

@@ -88,22 +88,50 @@ export interface IDocHubResourceVersion {
 }
 
 /**
- * Запись коммита о измененном файле
+ * Тип действия в коммите
  */
-export interface IDocHubCommitFile {
+export enum DocHubCommitAction {
+    post = 'post',
+    delete = 'delete',
+    rename = 'rename'
+}
+/**
+ * Создание файла
+ */
+export type DocHubCommitFilePost = {
+    type: DocHubCommitAction.post,
     uri: string;
     headers?: IDocHubTransactionFileHeaders;
     content: string | ArrayBuffer | (() => string | ArrayBuffer);
     encoded?: 'plain' | 'base64' | 'ArrayBuffer'; // default: plain
 }
+/**
+ * Удаление файла
+ */
+export type DocHubCommitFileDelete = {
+    type: DocHubCommitAction.delete;
+    uri: string;
+}
+/**
+ * Переименование файла
+ */
+export type DocHubCommitFileRename = {
+    type: DocHubCommitAction.rename;
+    oldURI: string;
+    newURI: string;
+}
+/**
+ * Действие в коммите
+ */
+export type DocHubCommitFile = DocHubCommitFilePost | DocHubCommitFileDelete | DocHubCommitFileRename;
 
 /**
  * Данные для создания коммита
  */
-export interface IDocHubCommitBatch extends IDocHubProtocolRequestConfig {
+export interface IDocHubCommit extends IDocHubProtocolRequestConfig {
     method: DocHubProtocolMethods.COMMIT,
     comment: string;
-    data: IDocHubCommitFile[];
+    actions: DocHubCommitFile[];
 }
 
 /**
@@ -141,7 +169,7 @@ export enum DocHubProtocolMethods {
     SCAN = 'SCAN',          // Сканирует ресурс URI и возвращает о нем расширенную информацию в формате DocHubResourceMeta
                             // Позволяет получать список файлов в папке
     VERSIONS = 'VERSIONS',  // Возвращает доступные версии ресурса в формате IDocHubResourceVersion
-    COMMIT = 'COMMIT',      // Аналог git commit. На вход получает IDocHubCommitBatch, возвращает 201 и IDocHubCommitTree при успешном выполнении
+    COMMIT = 'COMMIT',      // Аналог git commit. На вход получает IDocHubCommit, возвращает 201 и IDocHubCommitTree при успешном выполнении
     PUSH = 'PUSH'           // Аналог git push. На вход получает IDocHubCommit на выходе 201 при успешном выполнении
 };
 

package/package.json

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