gitverse-api-sdk 4.0.2 → 5.0.1
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/README.md +106 -270
- package/dist/api/actions.d.ts +360 -363
- package/dist/api/actions.js +3 -3
- package/dist/api/actions.js.map +3 -3
- package/dist/api/emails.d.ts +56 -51
- package/dist/api/emails.js +3 -3
- package/dist/api/emails.js.map +3 -3
- package/dist/api/issues.d.ts +297 -214
- package/dist/api/issues.js +3 -3
- package/dist/api/issues.js.map +3 -3
- package/dist/api/organizations.d.ts +78 -7
- package/dist/api/organizations.js +3 -3
- package/dist/api/organizations.js.map +3 -3
- package/dist/api/pulls.d.ts +338 -427
- package/dist/api/pulls.js +3 -3
- package/dist/api/pulls.js.map +3 -3
- package/dist/api/releases.d.ts +198 -231
- package/dist/api/releases.js +3 -3
- package/dist/api/releases.js.map +3 -3
- package/dist/api/repositories.d.ts +878 -330
- package/dist/api/repositories.js +3 -3
- package/dist/api/repositories.js.map +3 -3
- package/dist/api/stars.d.ts +109 -182
- package/dist/api/stars.js +3 -3
- package/dist/api/stars.js.map +3 -3
- package/dist/api/teams.d.ts +118 -134
- package/dist/api/teams.js +3 -3
- package/dist/api/teams.js.map +3 -3
- package/dist/api/users.d.ts +99 -97
- package/dist/api/users.js +3 -3
- package/dist/api/users.js.map +3 -3
- package/dist/client.d.ts +14 -0
- package/dist/client.js +3 -3
- package/dist/client.js.map +3 -3
- package/dist/enums.d.ts +27 -71
- package/dist/enums.js +3 -3
- package/dist/enums.js.map +3 -3
- package/dist/errors.d.ts +12 -10
- package/dist/errors.js +2 -2
- package/dist/errors.js.map +1 -1
- package/dist/index.d.ts +2042 -2130
- package/dist/index.js +2 -2
- package/dist/index.js.map +3 -3
- package/dist/types.d.ts +779 -1223
- package/dist/utils.js +1 -2
- package/dist/utils.js.map +1 -1
- package/package.json +2 -2
- package/dist/api/branches.d.ts +0 -173
- package/dist/api/branches.js +0 -4
- package/dist/api/branches.js.map +0 -10
- package/dist/api/collaborators.d.ts +0 -243
- package/dist/api/collaborators.js +0 -4
- package/dist/api/collaborators.js.map +0 -10
- package/dist/api/commits.d.ts +0 -321
- package/dist/api/commits.js +0 -4
- package/dist/api/commits.js.map +0 -10
- package/dist/api/contents.d.ts +0 -364
- package/dist/api/contents.js +0 -4
- package/dist/api/contents.js.map +0 -10
- package/dist/api/forks.d.ts +0 -344
- package/dist/api/forks.js +0 -4
- package/dist/api/forks.js.map +0 -10
- package/dist/api/git.d.ts +0 -247
- package/dist/api/git.js +0 -4
- package/dist/api/git.js.map +0 -10
package/dist/api/commits.d.ts
DELETED
|
@@ -1,321 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* Типы пользователей в системе
|
|
3
|
-
*/
|
|
4
|
-
declare const UserType: {
|
|
5
|
-
readonly Organization: "Organization"
|
|
6
|
-
readonly User: "User"
|
|
7
|
-
};
|
|
8
|
-
/**
|
|
9
|
-
* Тип для типов пользователей
|
|
10
|
-
*/
|
|
11
|
-
type UserType = (typeof UserType)[keyof typeof UserType];
|
|
12
|
-
/**
|
|
13
|
-
* Типы видимости для репозиториев и пользователей
|
|
14
|
-
*/
|
|
15
|
-
declare const VisibilityType: {
|
|
16
|
-
readonly Limited: "limited"
|
|
17
|
-
readonly Private: "private"
|
|
18
|
-
readonly Public: "public"
|
|
19
|
-
};
|
|
20
|
-
/**
|
|
21
|
-
* Тип для типов видимости
|
|
22
|
-
*/
|
|
23
|
-
type VisibilityType = (typeof VisibilityType)[keyof typeof VisibilityType];
|
|
24
|
-
/**
|
|
25
|
-
* Опции для выполнения HTTP-запросов
|
|
26
|
-
*/
|
|
27
|
-
interface RequestOptions {
|
|
28
|
-
/**
|
|
29
|
-
* AbortSignal для отмены запроса
|
|
30
|
-
* @example
|
|
31
|
-
* const controller = new AbortController();
|
|
32
|
-
* const promise = client.users.getCurrent({ signal: controller.signal });
|
|
33
|
-
* controller.abort(); // Отменяет запрос
|
|
34
|
-
*/
|
|
35
|
-
signal?: AbortSignal;
|
|
36
|
-
}
|
|
37
|
-
/**
|
|
38
|
-
* Интерфейс пользователя
|
|
39
|
-
*/
|
|
40
|
-
interface User2 {
|
|
41
|
-
/** Уникальный идентификатор пользователя */
|
|
42
|
-
id: number;
|
|
43
|
-
/** Имя пользователя */
|
|
44
|
-
name?: string;
|
|
45
|
-
/** Логин пользователя */
|
|
46
|
-
login: string;
|
|
47
|
-
/** Полное имя пользователя */
|
|
48
|
-
full_name?: string;
|
|
49
|
-
/** Тип аккаунта: пользователь или организация */
|
|
50
|
-
type: UserType;
|
|
51
|
-
/** Биография пользователя */
|
|
52
|
-
bio?: string;
|
|
53
|
-
/** Электронная почта пользователя */
|
|
54
|
-
email?: string;
|
|
55
|
-
/** URL аватара пользователя */
|
|
56
|
-
avatar_url: string;
|
|
57
|
-
/** Веб-ссылка на профиль пользователя */
|
|
58
|
-
html_url: string;
|
|
59
|
-
/** API-ссылка на профиль пользователя */
|
|
60
|
-
url?: string;
|
|
61
|
-
/** API-ссылка на список подписчиков пользователя */
|
|
62
|
-
followers_url?: string;
|
|
63
|
-
/** API-ссылка на репозитории пользователя */
|
|
64
|
-
repos_url?: string;
|
|
65
|
-
/** API-ссылка на организации пользователя */
|
|
66
|
-
organizations_url?: string;
|
|
67
|
-
/** Права администратора */
|
|
68
|
-
site_admin: boolean;
|
|
69
|
-
/** Местоположение пользователя */
|
|
70
|
-
location?: string;
|
|
71
|
-
/** Верификация аккаунта */
|
|
72
|
-
is_verified?: boolean;
|
|
73
|
-
/** Настройки приватности профиля */
|
|
74
|
-
visibility?: VisibilityType;
|
|
75
|
-
/** Персональный веб-сайт */
|
|
76
|
-
website?: string;
|
|
77
|
-
/** Количество подписчиков */
|
|
78
|
-
followers?: number;
|
|
79
|
-
/** Количество подписок */
|
|
80
|
-
following?: number;
|
|
81
|
-
/** Количество публичных репозиториев */
|
|
82
|
-
public_repos?: number;
|
|
83
|
-
/** Количество репозиториев, отмеченных звездой */
|
|
84
|
-
stars_count?: number;
|
|
85
|
-
/** Дата создания аккаунта */
|
|
86
|
-
created_at: string;
|
|
87
|
-
/** Дата последнего обновления аккаунта */
|
|
88
|
-
updated_at?: string;
|
|
89
|
-
}
|
|
90
|
-
/**
|
|
91
|
-
* Интерфейс коммита
|
|
92
|
-
*/
|
|
93
|
-
interface Commit {
|
|
94
|
-
/** SHA-хеш коммита */
|
|
95
|
-
sha: string;
|
|
96
|
-
/** Node ID коммита */
|
|
97
|
-
node_id?: string;
|
|
98
|
-
/** Информация о коммите */
|
|
99
|
-
commit: {
|
|
100
|
-
/** Автор коммита */
|
|
101
|
-
author: {
|
|
102
|
-
name: string
|
|
103
|
-
email: string
|
|
104
|
-
date: string
|
|
105
|
-
}
|
|
106
|
-
/** Коммиттер */
|
|
107
|
-
committer: {
|
|
108
|
-
name: string
|
|
109
|
-
email: string
|
|
110
|
-
date: string
|
|
111
|
-
}
|
|
112
|
-
/** Сообщение коммита */
|
|
113
|
-
message: string
|
|
114
|
-
/** Дерево коммита */
|
|
115
|
-
tree: {
|
|
116
|
-
sha: string
|
|
117
|
-
url: string
|
|
118
|
-
}
|
|
119
|
-
};
|
|
120
|
-
/** Автор (пользователь GitVerse) */
|
|
121
|
-
author?: User2 | null;
|
|
122
|
-
/** Коммиттер (пользователь GitVerse) */
|
|
123
|
-
committer?: User2 | null;
|
|
124
|
-
/** Родительские коммиты */
|
|
125
|
-
parents: Array<{
|
|
126
|
-
sha: string
|
|
127
|
-
url: string
|
|
128
|
-
html_url: string
|
|
129
|
-
}>;
|
|
130
|
-
/** API-ссылка на коммит */
|
|
131
|
-
url: string;
|
|
132
|
-
/** Веб-ссылка на коммит */
|
|
133
|
-
html_url: string;
|
|
134
|
-
}
|
|
135
|
-
/**
|
|
136
|
-
* Параметры для создания коммита
|
|
137
|
-
*/
|
|
138
|
-
interface CreateCommitParams {
|
|
139
|
-
/** Сообщение коммита */
|
|
140
|
-
message: string;
|
|
141
|
-
/** SHA-хеш дерева */
|
|
142
|
-
tree: string;
|
|
143
|
-
/** SHA-хеши родительских коммитов */
|
|
144
|
-
parents?: string[];
|
|
145
|
-
/** Информация об авторе */
|
|
146
|
-
author?: {
|
|
147
|
-
name: string
|
|
148
|
-
email: string
|
|
149
|
-
date?: string
|
|
150
|
-
};
|
|
151
|
-
/** Информация о коммиттере */
|
|
152
|
-
committer?: {
|
|
153
|
-
name: string
|
|
154
|
-
email: string
|
|
155
|
-
date?: string
|
|
156
|
-
};
|
|
157
|
-
/** GPG подпись */
|
|
158
|
-
signature?: string;
|
|
159
|
-
}
|
|
160
|
-
/**
|
|
161
|
-
* Предупреждение об устаревшей версии API
|
|
162
|
-
*/
|
|
163
|
-
declare class ApiVersionWarning {
|
|
164
|
-
/** Текущая используемая версия */
|
|
165
|
-
readonly currentVersion: string;
|
|
166
|
-
/** Последняя доступная версия */
|
|
167
|
-
readonly latestVersion: string;
|
|
168
|
-
/** Дата вывода из эксплуатации */
|
|
169
|
-
readonly decommissioning?: string;
|
|
170
|
-
constructor(currentVersion: string, latestVersion: string, decommissioning?: string);
|
|
171
|
-
/**
|
|
172
|
-
* Возвращает сообщение о предупреждении
|
|
173
|
-
*/
|
|
174
|
-
getMessage(): string;
|
|
175
|
-
}
|
|
176
|
-
declare const HTTPMethods: {
|
|
177
|
-
readonly DELETE: "DELETE"
|
|
178
|
-
readonly GET: "GET"
|
|
179
|
-
readonly PATCH: "PATCH"
|
|
180
|
-
readonly POST: "POST"
|
|
181
|
-
readonly PUT: "PUT"
|
|
182
|
-
};
|
|
183
|
-
type HTTPMethods = (typeof HTTPMethods)[keyof typeof HTTPMethods];
|
|
184
|
-
/**
|
|
185
|
-
* Параметры для конфигурации GitVerse клиента
|
|
186
|
-
*/
|
|
187
|
-
interface GitVerseClientConfig {
|
|
188
|
-
/**
|
|
189
|
-
* Базовый URL API GitVerse
|
|
190
|
-
* @default 'https://api.gitverse.ru'
|
|
191
|
-
*/
|
|
192
|
-
baseUrl?: string;
|
|
193
|
-
/**
|
|
194
|
-
* Токен доступа для авторизации в API
|
|
195
|
-
*/
|
|
196
|
-
token?: string;
|
|
197
|
-
/**
|
|
198
|
-
* Версия API
|
|
199
|
-
* @default '1'
|
|
200
|
-
*/
|
|
201
|
-
apiVersion?: string;
|
|
202
|
-
}
|
|
203
|
-
/**
|
|
204
|
-
* Основной класс для работы с GitVerse API
|
|
205
|
-
*/
|
|
206
|
-
declare class GitVerseClient {
|
|
207
|
-
private baseUrl;
|
|
208
|
-
private token?;
|
|
209
|
-
private apiVersion;
|
|
210
|
-
/**
|
|
211
|
-
* Callback для обработки предупреждений об устаревшей версии API
|
|
212
|
-
*/
|
|
213
|
-
onApiVersionWarning?: (warning: ApiVersionWarning) => void;
|
|
214
|
-
/**
|
|
215
|
-
* Создает новый экземпляр GitVerse клиента
|
|
216
|
-
* @param config Конфигурация клиента
|
|
217
|
-
*/
|
|
218
|
-
constructor(config?: GitVerseClientConfig);
|
|
219
|
-
/**
|
|
220
|
-
* Устанавливает токен авторизации
|
|
221
|
-
* @param token Токен доступа
|
|
222
|
-
*/
|
|
223
|
-
setToken(token: string): void;
|
|
224
|
-
/**
|
|
225
|
-
* Извлекает информацию о Rate Limit из заголовков ответа
|
|
226
|
-
*/
|
|
227
|
-
private extractRateLimitInfo;
|
|
228
|
-
/**
|
|
229
|
-
* Извлекает информацию о версии API из заголовков ответа
|
|
230
|
-
*/
|
|
231
|
-
private extractApiVersionInfo;
|
|
232
|
-
/**
|
|
233
|
-
* Извлекает метаданные из заголовков ответа
|
|
234
|
-
*/
|
|
235
|
-
private extractMetadata;
|
|
236
|
-
/**
|
|
237
|
-
* Выполняет API-запрос с учетом авторизации и версии API
|
|
238
|
-
* @param path Путь к API-ресурсу
|
|
239
|
-
* @param method HTTP-метод
|
|
240
|
-
* @param body Тело запроса (опционально)
|
|
241
|
-
* @param options Опции запроса (опционально)
|
|
242
|
-
* @returns Ответ от API
|
|
243
|
-
* @throws {RateLimitError} При превышении лимита запросов (429)
|
|
244
|
-
* @throws {GitVerseApiError} При других ошибках API
|
|
245
|
-
*/
|
|
246
|
-
request<T>(path: string, method: HTTPMethods, body?: unknown, options?: RequestOptions): Promise<T>;
|
|
247
|
-
/**
|
|
248
|
-
* Выполняет GET-запрос
|
|
249
|
-
* @param path Путь к API-ресурсу
|
|
250
|
-
* @param options Опции запроса (опционально)
|
|
251
|
-
* @returns Ответ от API
|
|
252
|
-
*/
|
|
253
|
-
get<T>(path: string, options?: RequestOptions): Promise<T>;
|
|
254
|
-
/**
|
|
255
|
-
* Выполняет POST-запрос
|
|
256
|
-
* @param path Путь к API-ресурсу
|
|
257
|
-
* @param body Тело запроса
|
|
258
|
-
* @param options Опции запроса (опционально)
|
|
259
|
-
* @returns Ответ от API
|
|
260
|
-
*/
|
|
261
|
-
post<T>(path: string, body?: unknown, options?: RequestOptions): Promise<T>;
|
|
262
|
-
/**
|
|
263
|
-
* Выполняет PUT-запрос
|
|
264
|
-
* @param path Путь к API-ресурсу
|
|
265
|
-
* @param body Тело запроса
|
|
266
|
-
* @param options Опции запроса (опционально)
|
|
267
|
-
* @returns Ответ от API
|
|
268
|
-
*/
|
|
269
|
-
put<T>(path: string, body?: unknown, options?: RequestOptions): Promise<T>;
|
|
270
|
-
/**
|
|
271
|
-
* Выполняет DELETE-запрос
|
|
272
|
-
* @param path Путь к API-ресурсу
|
|
273
|
-
* @param body Тело запроса (опционально)
|
|
274
|
-
* @param options Опции запроса (опционально)
|
|
275
|
-
* @returns Ответ от API
|
|
276
|
-
*/
|
|
277
|
-
delete<T>(path: string, body?: unknown, options?: RequestOptions): Promise<T>;
|
|
278
|
-
/**
|
|
279
|
-
* Выполняет PATCH-запрос
|
|
280
|
-
* @param path Путь к API-ресурсу
|
|
281
|
-
* @param body Тело запроса
|
|
282
|
-
* @param options Опции запроса (опционально)
|
|
283
|
-
* @returns Ответ от API
|
|
284
|
-
*/
|
|
285
|
-
patch<T>(path: string, body?: unknown, options?: RequestOptions): Promise<T>;
|
|
286
|
-
}
|
|
287
|
-
/**
|
|
288
|
-
* API для работы с коммитами
|
|
289
|
-
*/
|
|
290
|
-
declare class CommitsApi {
|
|
291
|
-
private client;
|
|
292
|
-
/**
|
|
293
|
-
* Создает новый экземпляр API для работы с коммитами
|
|
294
|
-
* @param client GitVerse клиент
|
|
295
|
-
*/
|
|
296
|
-
constructor(client: GitVerseClient);
|
|
297
|
-
/**
|
|
298
|
-
* Получает список коммитов в репозитории
|
|
299
|
-
* @param owner Владелец репозитория
|
|
300
|
-
* @param repo Название репозитория
|
|
301
|
-
* @returns Список коммитов
|
|
302
|
-
*/
|
|
303
|
-
list(owner: string, repo: string, options?: RequestOptions): Promise<Commit[]>;
|
|
304
|
-
/**
|
|
305
|
-
* Получает информацию о коммите по SHA
|
|
306
|
-
* @param owner Владелец репозитория
|
|
307
|
-
* @param repo Название репозитория
|
|
308
|
-
* @param sha SHA-хеш коммита
|
|
309
|
-
* @returns Информация о коммите
|
|
310
|
-
*/
|
|
311
|
-
get(owner: string, repo: string, sha: string, options?: RequestOptions): Promise<Commit>;
|
|
312
|
-
/**
|
|
313
|
-
* Создает новый коммит
|
|
314
|
-
* @param owner Владелец репозитория
|
|
315
|
-
* @param repo Название репозитория
|
|
316
|
-
* @param params Параметры создания коммита
|
|
317
|
-
* @returns Созданный коммит
|
|
318
|
-
*/
|
|
319
|
-
create(owner: string, repo: string, params: CreateCommitParams, options?: RequestOptions): Promise<Commit>;
|
|
320
|
-
}
|
|
321
|
-
export { CommitsApi };
|
package/dist/api/commits.js
DELETED
|
@@ -1,4 +0,0 @@
|
|
|
1
|
-
class j{client;constructor(b){this.client=b}list(b,d,f){return this.client.get(`/repos/${b}/${d}/commits`,f)}get(b,d,f,g){return this.client.get(`/repos/${b}/${d}/commits/${f}`,g)}create(b,d,f,g){return this.client.post(`/repos/${b}/${d}/git/commits`,f,g)}}export{j as CommitsApi};
|
|
2
|
-
export{j as d};
|
|
3
|
-
|
|
4
|
-
//# debugId=1E898D8DF9AD170A64756E2164756E21
|
package/dist/api/commits.js.map
DELETED
|
@@ -1,10 +0,0 @@
|
|
|
1
|
-
{
|
|
2
|
-
"version": 3,
|
|
3
|
-
"sources": ["../src/api/commits.ts"],
|
|
4
|
-
"sourcesContent": [
|
|
5
|
-
"import type { GitVerseClient } from \"../client\";\nimport type { Commit, CreateCommitParams, RequestOptions } from \"../types\";\n\n/**\n * API для работы с коммитами\n */\nexport class CommitsApi {\n private client: GitVerseClient;\n\n /**\n * Создает новый экземпляр API для работы с коммитами\n * @param client GitVerse клиент\n */\n constructor(client: GitVerseClient) {\n this.client = client;\n }\n\n /**\n * Получает список коммитов в репозитории\n * @param owner Владелец репозитория\n * @param repo Название репозитория\n * @returns Список коммитов\n */\n list(owner: string, repo: string, options?: RequestOptions): Promise<Commit[]> {\n return this.client.get<Commit[]>(`/repos/${owner}/${repo}/commits`, options);\n }\n\n /**\n * Получает информацию о коммите по SHA\n * @param owner Владелец репозитория\n * @param repo Название репозитория\n * @param sha SHA-хеш коммита\n * @returns Информация о коммите\n */\n get(owner: string, repo: string, sha: string, options?: RequestOptions): Promise<Commit> {\n return this.client.get<Commit>(`/repos/${owner}/${repo}/commits/${sha}`, options);\n }\n\n /**\n * Создает новый коммит\n * @param owner Владелец репозитория\n * @param repo Название репозитория\n * @param params Параметры создания коммита\n * @returns Созданный коммит\n */\n create(owner: string, repo: string, params: CreateCommitParams, options?: RequestOptions): Promise<Commit> {\n return this.client.post<Commit>(`/repos/${owner}/${repo}/git/commits`, params, options);\n }\n}\n"
|
|
6
|
-
],
|
|
7
|
-
"mappings": "AAMO,MAAM,CAAW,CACd,OAMR,WAAW,CAAC,EAAwB,CAClC,KAAK,OAAS,EAShB,IAAI,CAAC,EAAe,EAAc,EAA6C,CAC7E,OAAO,KAAK,OAAO,IAAc,UAAU,KAAS,YAAgB,CAAO,EAU7E,GAAG,CAAC,EAAe,EAAc,EAAa,EAA2C,CACvF,OAAO,KAAK,OAAO,IAAY,UAAU,KAAS,aAAgB,IAAO,CAAO,EAUlF,MAAM,CAAC,EAAe,EAAc,EAA4B,EAA2C,CACzG,OAAO,KAAK,OAAO,KAAa,UAAU,KAAS,gBAAoB,EAAQ,CAAO,EAE1F",
|
|
8
|
-
"debugId": "1E898D8DF9AD170A64756E2164756E21",
|
|
9
|
-
"names": []
|
|
10
|
-
}
|
package/dist/api/contents.d.ts
DELETED
|
@@ -1,364 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* Типы содержимого в репозитории
|
|
3
|
-
*/
|
|
4
|
-
declare const ContentType: {
|
|
5
|
-
readonly Directory: "dir"
|
|
6
|
-
readonly File: "file"
|
|
7
|
-
};
|
|
8
|
-
/**
|
|
9
|
-
* Тип для типов содержимого
|
|
10
|
-
*/
|
|
11
|
-
type ContentType = (typeof ContentType)[keyof typeof ContentType];
|
|
12
|
-
/**
|
|
13
|
-
* Опции для выполнения HTTP-запросов
|
|
14
|
-
*/
|
|
15
|
-
interface RequestOptions {
|
|
16
|
-
/**
|
|
17
|
-
* AbortSignal для отмены запроса
|
|
18
|
-
* @example
|
|
19
|
-
* const controller = new AbortController();
|
|
20
|
-
* const promise = client.users.getCurrent({ signal: controller.signal });
|
|
21
|
-
* controller.abort(); // Отменяет запрос
|
|
22
|
-
*/
|
|
23
|
-
signal?: AbortSignal;
|
|
24
|
-
}
|
|
25
|
-
/**
|
|
26
|
-
* Интерфейс информации о файле
|
|
27
|
-
*/
|
|
28
|
-
interface FileContent {
|
|
29
|
-
/** Имя файла */
|
|
30
|
-
name: string;
|
|
31
|
-
/** Путь к файлу относительно корня репозитория */
|
|
32
|
-
path: string;
|
|
33
|
-
/** SHA-хеш содержимого файла */
|
|
34
|
-
sha: string;
|
|
35
|
-
/** Размер файла в байтах */
|
|
36
|
-
size: number;
|
|
37
|
-
/** Тип объекта (всегда 'file' для файла) */
|
|
38
|
-
type: typeof ContentType.File;
|
|
39
|
-
/** Кодировка содержимого файла (например, 'base64') */
|
|
40
|
-
encoding?: string;
|
|
41
|
-
/** Содержимое файла в формате Base64 */
|
|
42
|
-
content?: string;
|
|
43
|
-
/** Определенный язык программирования файла */
|
|
44
|
-
language?: string;
|
|
45
|
-
/** API-ссылка на файл */
|
|
46
|
-
url?: string;
|
|
47
|
-
/** Веб-ссылка на файл */
|
|
48
|
-
html_url?: string;
|
|
49
|
-
/** Git-URL для файла */
|
|
50
|
-
git_url?: string;
|
|
51
|
-
/** URL для скачивания файла */
|
|
52
|
-
download_url?: string;
|
|
53
|
-
}
|
|
54
|
-
/**
|
|
55
|
-
* Интерфейс информации о директории
|
|
56
|
-
*/
|
|
57
|
-
interface DirectoryContent {
|
|
58
|
-
/** Тип объекта (всегда 'dir' для директории) */
|
|
59
|
-
type: typeof ContentType.Directory;
|
|
60
|
-
/** Размер директории (всегда 0) */
|
|
61
|
-
size: number;
|
|
62
|
-
/** Имя директории */
|
|
63
|
-
name: string;
|
|
64
|
-
/** Путь к директории относительно корня репозитория */
|
|
65
|
-
path: string;
|
|
66
|
-
/** SHA-хеш объекта директории */
|
|
67
|
-
sha: string;
|
|
68
|
-
/** Список файлов и поддиректорий внутри директории */
|
|
69
|
-
entries: Array<FileContent | DirectoryContent>;
|
|
70
|
-
}
|
|
71
|
-
/**
|
|
72
|
-
* Тип для содержимого репозитория (файл или директория)
|
|
73
|
-
*/
|
|
74
|
-
type Content = FileContent | DirectoryContent;
|
|
75
|
-
/**
|
|
76
|
-
* Интерфейс информации о коммите
|
|
77
|
-
*/
|
|
78
|
-
interface CommitInfo {
|
|
79
|
-
/** SHA-хеш коммита */
|
|
80
|
-
sha: string;
|
|
81
|
-
/** Node ID коммита */
|
|
82
|
-
node_id?: string;
|
|
83
|
-
/** API-ссылка на коммит */
|
|
84
|
-
url: string;
|
|
85
|
-
/** Веб-ссылка на коммит */
|
|
86
|
-
html_url: string;
|
|
87
|
-
/** Информация об авторе коммита */
|
|
88
|
-
author: {
|
|
89
|
-
/** Имя автора */
|
|
90
|
-
name: string
|
|
91
|
-
/** Email автора */
|
|
92
|
-
email: string
|
|
93
|
-
/** Дата создания коммита */
|
|
94
|
-
date: string
|
|
95
|
-
};
|
|
96
|
-
/** Информация о коммиттере */
|
|
97
|
-
committer: {
|
|
98
|
-
/** Имя коммиттера */
|
|
99
|
-
name: string
|
|
100
|
-
/** Email коммиттера */
|
|
101
|
-
email: string
|
|
102
|
-
/** Дата коммита */
|
|
103
|
-
date: string
|
|
104
|
-
};
|
|
105
|
-
/** Сообщение коммита */
|
|
106
|
-
message: string;
|
|
107
|
-
/** Информация о дереве коммита */
|
|
108
|
-
tree: {
|
|
109
|
-
/** SHA-хеш дерева */
|
|
110
|
-
sha: string
|
|
111
|
-
/** URL дерева */
|
|
112
|
-
url: string
|
|
113
|
-
};
|
|
114
|
-
/** Родительские коммиты */
|
|
115
|
-
parents: Array<{
|
|
116
|
-
/** SHA-хеш родительского коммита */
|
|
117
|
-
sha: string
|
|
118
|
-
/** API-ссылка на родительский коммит */
|
|
119
|
-
url: string
|
|
120
|
-
/** Веб-ссылка на родительский коммит */
|
|
121
|
-
html_url: string
|
|
122
|
-
}>;
|
|
123
|
-
}
|
|
124
|
-
/**
|
|
125
|
-
* Интерфейс ответа на создание файла
|
|
126
|
-
*/
|
|
127
|
-
interface FileCreationResponse {
|
|
128
|
-
/** Информация о созданном файле */
|
|
129
|
-
content: FileContent;
|
|
130
|
-
/** Информация о коммите */
|
|
131
|
-
commit: CommitInfo;
|
|
132
|
-
}
|
|
133
|
-
/**
|
|
134
|
-
* Интерфейс ответа на удаление файла
|
|
135
|
-
*/
|
|
136
|
-
interface FileDeletionResponse {
|
|
137
|
-
/** Информация о содержимом (null для удаленного файла) */
|
|
138
|
-
content: null;
|
|
139
|
-
/** Информация о коммите удаления */
|
|
140
|
-
commit: CommitInfo;
|
|
141
|
-
}
|
|
142
|
-
/**
|
|
143
|
-
* Интерфейс параметров для создания файла
|
|
144
|
-
*/
|
|
145
|
-
interface CreateFileParams {
|
|
146
|
-
/** Имя ветки, в которую будет добавлен файл (по умолчанию - основная ветка) */
|
|
147
|
-
branch?: string;
|
|
148
|
-
/** Содержимое файла, закодированное в Base64 */
|
|
149
|
-
content: string;
|
|
150
|
-
/** Сообщение коммита */
|
|
151
|
-
message?: string;
|
|
152
|
-
/** Имя новой ветки, которая будет создана для этого изменения */
|
|
153
|
-
new_branch?: string;
|
|
154
|
-
/** Добавлять ли подпись (Signed-off-by) в коммит */
|
|
155
|
-
signoff?: boolean;
|
|
156
|
-
}
|
|
157
|
-
/**
|
|
158
|
-
* Интерфейс параметров для обновления файла
|
|
159
|
-
*/
|
|
160
|
-
interface UpdateFileParams {
|
|
161
|
-
/** Имя ветки, в которой находится файл */
|
|
162
|
-
branch?: string;
|
|
163
|
-
/** Новое содержимое файла, закодированное в Base64 */
|
|
164
|
-
content: string;
|
|
165
|
-
/** SHA-хеш текущего содержимого файла */
|
|
166
|
-
sha: string;
|
|
167
|
-
/** Если файл переименовывается, указывает старый путь к файлу */
|
|
168
|
-
from_path?: string;
|
|
169
|
-
/** Сообщение коммита */
|
|
170
|
-
message?: string;
|
|
171
|
-
/** Имя новой ветки, которая будет создана для этого изменения */
|
|
172
|
-
new_branch?: string;
|
|
173
|
-
/** Добавлять ли подпись (Signed-off-by) в коммит */
|
|
174
|
-
signoff?: boolean;
|
|
175
|
-
}
|
|
176
|
-
/**
|
|
177
|
-
* Интерфейс параметров для удаления файла
|
|
178
|
-
*/
|
|
179
|
-
interface DeleteFileParams {
|
|
180
|
-
/** SHA-хеш текущего содержимого файла */
|
|
181
|
-
sha: string;
|
|
182
|
-
/** Имя ветки, в которой находится файл */
|
|
183
|
-
branch?: string;
|
|
184
|
-
/** Сообщение коммита */
|
|
185
|
-
message?: string;
|
|
186
|
-
/** Имя новой ветки, которая будет создана для этого изменения */
|
|
187
|
-
new_branch?: string;
|
|
188
|
-
/** Добавлять ли подпись (Signed-off-by) в коммит */
|
|
189
|
-
signoff?: boolean;
|
|
190
|
-
}
|
|
191
|
-
/**
|
|
192
|
-
* Предупреждение об устаревшей версии API
|
|
193
|
-
*/
|
|
194
|
-
declare class ApiVersionWarning {
|
|
195
|
-
/** Текущая используемая версия */
|
|
196
|
-
readonly currentVersion: string;
|
|
197
|
-
/** Последняя доступная версия */
|
|
198
|
-
readonly latestVersion: string;
|
|
199
|
-
/** Дата вывода из эксплуатации */
|
|
200
|
-
readonly decommissioning?: string;
|
|
201
|
-
constructor(currentVersion: string, latestVersion: string, decommissioning?: string);
|
|
202
|
-
/**
|
|
203
|
-
* Возвращает сообщение о предупреждении
|
|
204
|
-
*/
|
|
205
|
-
getMessage(): string;
|
|
206
|
-
}
|
|
207
|
-
declare const HTTPMethods: {
|
|
208
|
-
readonly DELETE: "DELETE"
|
|
209
|
-
readonly GET: "GET"
|
|
210
|
-
readonly PATCH: "PATCH"
|
|
211
|
-
readonly POST: "POST"
|
|
212
|
-
readonly PUT: "PUT"
|
|
213
|
-
};
|
|
214
|
-
type HTTPMethods = (typeof HTTPMethods)[keyof typeof HTTPMethods];
|
|
215
|
-
/**
|
|
216
|
-
* Параметры для конфигурации GitVerse клиента
|
|
217
|
-
*/
|
|
218
|
-
interface GitVerseClientConfig {
|
|
219
|
-
/**
|
|
220
|
-
* Базовый URL API GitVerse
|
|
221
|
-
* @default 'https://api.gitverse.ru'
|
|
222
|
-
*/
|
|
223
|
-
baseUrl?: string;
|
|
224
|
-
/**
|
|
225
|
-
* Токен доступа для авторизации в API
|
|
226
|
-
*/
|
|
227
|
-
token?: string;
|
|
228
|
-
/**
|
|
229
|
-
* Версия API
|
|
230
|
-
* @default '1'
|
|
231
|
-
*/
|
|
232
|
-
apiVersion?: string;
|
|
233
|
-
}
|
|
234
|
-
/**
|
|
235
|
-
* Основной класс для работы с GitVerse API
|
|
236
|
-
*/
|
|
237
|
-
declare class GitVerseClient {
|
|
238
|
-
private baseUrl;
|
|
239
|
-
private token?;
|
|
240
|
-
private apiVersion;
|
|
241
|
-
/**
|
|
242
|
-
* Callback для обработки предупреждений об устаревшей версии API
|
|
243
|
-
*/
|
|
244
|
-
onApiVersionWarning?: (warning: ApiVersionWarning) => void;
|
|
245
|
-
/**
|
|
246
|
-
* Создает новый экземпляр GitVerse клиента
|
|
247
|
-
* @param config Конфигурация клиента
|
|
248
|
-
*/
|
|
249
|
-
constructor(config?: GitVerseClientConfig);
|
|
250
|
-
/**
|
|
251
|
-
* Устанавливает токен авторизации
|
|
252
|
-
* @param token Токен доступа
|
|
253
|
-
*/
|
|
254
|
-
setToken(token: string): void;
|
|
255
|
-
/**
|
|
256
|
-
* Извлекает информацию о Rate Limit из заголовков ответа
|
|
257
|
-
*/
|
|
258
|
-
private extractRateLimitInfo;
|
|
259
|
-
/**
|
|
260
|
-
* Извлекает информацию о версии API из заголовков ответа
|
|
261
|
-
*/
|
|
262
|
-
private extractApiVersionInfo;
|
|
263
|
-
/**
|
|
264
|
-
* Извлекает метаданные из заголовков ответа
|
|
265
|
-
*/
|
|
266
|
-
private extractMetadata;
|
|
267
|
-
/**
|
|
268
|
-
* Выполняет API-запрос с учетом авторизации и версии API
|
|
269
|
-
* @param path Путь к API-ресурсу
|
|
270
|
-
* @param method HTTP-метод
|
|
271
|
-
* @param body Тело запроса (опционально)
|
|
272
|
-
* @param options Опции запроса (опционально)
|
|
273
|
-
* @returns Ответ от API
|
|
274
|
-
* @throws {RateLimitError} При превышении лимита запросов (429)
|
|
275
|
-
* @throws {GitVerseApiError} При других ошибках API
|
|
276
|
-
*/
|
|
277
|
-
request<T>(path: string, method: HTTPMethods, body?: unknown, options?: RequestOptions): Promise<T>;
|
|
278
|
-
/**
|
|
279
|
-
* Выполняет GET-запрос
|
|
280
|
-
* @param path Путь к API-ресурсу
|
|
281
|
-
* @param options Опции запроса (опционально)
|
|
282
|
-
* @returns Ответ от API
|
|
283
|
-
*/
|
|
284
|
-
get<T>(path: string, options?: RequestOptions): Promise<T>;
|
|
285
|
-
/**
|
|
286
|
-
* Выполняет POST-запрос
|
|
287
|
-
* @param path Путь к API-ресурсу
|
|
288
|
-
* @param body Тело запроса
|
|
289
|
-
* @param options Опции запроса (опционально)
|
|
290
|
-
* @returns Ответ от API
|
|
291
|
-
*/
|
|
292
|
-
post<T>(path: string, body?: unknown, options?: RequestOptions): Promise<T>;
|
|
293
|
-
/**
|
|
294
|
-
* Выполняет PUT-запрос
|
|
295
|
-
* @param path Путь к API-ресурсу
|
|
296
|
-
* @param body Тело запроса
|
|
297
|
-
* @param options Опции запроса (опционально)
|
|
298
|
-
* @returns Ответ от API
|
|
299
|
-
*/
|
|
300
|
-
put<T>(path: string, body?: unknown, options?: RequestOptions): Promise<T>;
|
|
301
|
-
/**
|
|
302
|
-
* Выполняет DELETE-запрос
|
|
303
|
-
* @param path Путь к API-ресурсу
|
|
304
|
-
* @param body Тело запроса (опционально)
|
|
305
|
-
* @param options Опции запроса (опционально)
|
|
306
|
-
* @returns Ответ от API
|
|
307
|
-
*/
|
|
308
|
-
delete<T>(path: string, body?: unknown, options?: RequestOptions): Promise<T>;
|
|
309
|
-
/**
|
|
310
|
-
* Выполняет PATCH-запрос
|
|
311
|
-
* @param path Путь к API-ресурсу
|
|
312
|
-
* @param body Тело запроса
|
|
313
|
-
* @param options Опции запроса (опционально)
|
|
314
|
-
* @returns Ответ от API
|
|
315
|
-
*/
|
|
316
|
-
patch<T>(path: string, body?: unknown, options?: RequestOptions): Promise<T>;
|
|
317
|
-
}
|
|
318
|
-
/**
|
|
319
|
-
* API для работы с содержимым репозитория (файлами и папками)
|
|
320
|
-
*/
|
|
321
|
-
declare class ContentsApi {
|
|
322
|
-
private client;
|
|
323
|
-
/**
|
|
324
|
-
* Создает новый экземпляр API для работы с содержимым репозитория
|
|
325
|
-
* @param client GitVerse клиент
|
|
326
|
-
*/
|
|
327
|
-
constructor(client: GitVerseClient);
|
|
328
|
-
/**
|
|
329
|
-
* Получает содержимое файла или список файлов в директории
|
|
330
|
-
* @param owner Владелец репозитория
|
|
331
|
-
* @param repo Название репозитория
|
|
332
|
-
* @param path Путь к файлу или директории
|
|
333
|
-
* @returns Содержимое файла или директории
|
|
334
|
-
*/
|
|
335
|
-
get(owner: string, repo: string, path: string, options?: RequestOptions): Promise<Content>;
|
|
336
|
-
/**
|
|
337
|
-
* Создает новый файл в репозитории
|
|
338
|
-
* @param owner Владелец репозитория
|
|
339
|
-
* @param repo Название репозитория
|
|
340
|
-
* @param path Путь к файлу, который будет создан
|
|
341
|
-
* @param params Параметры создания файла
|
|
342
|
-
* @returns Информация о созданном файле и коммите
|
|
343
|
-
*/
|
|
344
|
-
createFile(owner: string, repo: string, path: string, params: CreateFileParams, options?: RequestOptions): Promise<FileCreationResponse>;
|
|
345
|
-
/**
|
|
346
|
-
* Обновляет существующий файл в репозитории
|
|
347
|
-
* @param owner Владелец репозитория
|
|
348
|
-
* @param repo Название репозитория
|
|
349
|
-
* @param path Путь к файлу, который будет обновлен
|
|
350
|
-
* @param params Параметры обновления файла
|
|
351
|
-
* @returns Информация об обновленном файле и коммите
|
|
352
|
-
*/
|
|
353
|
-
updateFile(owner: string, repo: string, path: string, params: UpdateFileParams, options?: RequestOptions): Promise<FileCreationResponse>;
|
|
354
|
-
/**
|
|
355
|
-
* Удаляет файл из репозитория
|
|
356
|
-
* @param owner Владелец репозитория
|
|
357
|
-
* @param repo Название репозитория
|
|
358
|
-
* @param path Путь к файлу, который будет удален
|
|
359
|
-
* @param params Параметры удаления файла
|
|
360
|
-
* @returns Информация об удаленном файле и коммите
|
|
361
|
-
*/
|
|
362
|
-
deleteFile(owner: string, repo: string, path: string, params: DeleteFileParams, options?: RequestOptions): Promise<FileDeletionResponse>;
|
|
363
|
-
}
|
|
364
|
-
export { ContentsApi };
|