dochub-sdk 0.1.263 → 0.1.266
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.vscode/settings.json +1 -0
- package/interfaces/datalake.ts +2 -1
- package/interfaces/protocols.ts +27 -1
- package/package.json +1 -1
package/.vscode/settings.json
CHANGED
package/interfaces/datalake.ts
CHANGED
|
@@ -328,8 +328,9 @@ export interface IDocHubDataLake {
|
|
|
328
328
|
/**
|
|
329
329
|
* Отправляет транзакцию в DataLake
|
|
330
330
|
* @param transaction - Объект транзакции
|
|
331
|
+
* @param comment - Комментарий к фиксируемой транзакции
|
|
331
332
|
*/
|
|
332
|
-
commitTransaction(transaction: IDocHubTransaction): Promise<IDocHubTransaction>;
|
|
333
|
+
commitTransaction(transaction: IDocHubTransaction, comment?: string): Promise<IDocHubTransaction>;
|
|
333
334
|
|
|
334
335
|
/**
|
|
335
336
|
* Отменяет транзакцию
|
package/interfaces/protocols.ts
CHANGED
|
@@ -1,5 +1,6 @@
|
|
|
1
1
|
import { AxiosResponse, AxiosRequestConfig, ResponseType, Method } from 'axios';
|
|
2
2
|
import { IDocHubContext } from './contexts';
|
|
3
|
+
import { IDocHubTransactionFileHeaders } from './datalake';
|
|
3
4
|
|
|
4
5
|
export enum ProtocolOptionsResponseTypes {
|
|
5
6
|
arraybuffer = 'arraybuffer',
|
|
@@ -86,6 +87,29 @@ export interface IDocHubResourceVersion {
|
|
|
86
87
|
author: string; // Автор версии
|
|
87
88
|
}
|
|
88
89
|
|
|
90
|
+
/**
|
|
91
|
+
* Запись коммита о измененном файле
|
|
92
|
+
*/
|
|
93
|
+
export interface IDocHubCommitFile {
|
|
94
|
+
uri: string;
|
|
95
|
+
headers?: IDocHubTransactionFileHeaders;
|
|
96
|
+
content: string | ArrayBuffer | (() => string | ArrayBuffer);
|
|
97
|
+
encoded?: 'plain' | 'base64' | 'ArrayBuffer'; // default: plain
|
|
98
|
+
}
|
|
99
|
+
|
|
100
|
+
/**
|
|
101
|
+
* Данные для создания коммита
|
|
102
|
+
*/
|
|
103
|
+
export interface IDocHubCommitBatch extends IDocHubProtocolRequestConfig {
|
|
104
|
+
method: DocHubProtocolMethods.COMMIT,
|
|
105
|
+
comment: string;
|
|
106
|
+
data: IDocHubCommitFile[];
|
|
107
|
+
}
|
|
108
|
+
|
|
109
|
+
/**
|
|
110
|
+
* Структура коммита
|
|
111
|
+
*/
|
|
112
|
+
export interface IDocHubCommitTree extends AxiosResponse {}
|
|
89
113
|
|
|
90
114
|
/**
|
|
91
115
|
* Методы доступные над ресурсом
|
|
@@ -102,7 +126,9 @@ export enum DocHubProtocolMethods {
|
|
|
102
126
|
// WebDAV - Расширенные методы для работы ресурсами
|
|
103
127
|
SCAN = 'SCAN', // Сканирует ресурс URI и возвращает о нем расширенную информацию в формате DocHubResourceMeta
|
|
104
128
|
// Позволяет получать список файлов в папке
|
|
105
|
-
VERSIONS = 'VERSIONS'
|
|
129
|
+
VERSIONS = 'VERSIONS', // Возвращает доступные версии ресурса в формате IDocHubResourceVersion
|
|
130
|
+
COMMIT = 'COMMIT', // Аналог git commit. На вход получает IDocHubCommitBatch, возвращает 201 и IDocHubCommitTree при успешном выполнении
|
|
131
|
+
PUSH = 'PUSH' // Аналог git push. На вход получает IDocHubCommit на выходе 201 при успешном выполнении
|
|
106
132
|
};
|
|
107
133
|
|
|
108
134
|
/**
|