6 Commits

6 changed files with 102 additions and 2 deletions

View File

@@ -1,5 +1,28 @@
# Changelog
## 2026-03-02 - 2.4.0 - feat(gitlab)
add repository branches and tags endpoints and corresponding types
- Add getRepoBranches(projectId, opts?) to list repository branches (supports pagination with page and perPage; defaults to page=1, perPage=50).
- Add getRepoTags(projectId, opts?) to list repository tags (supports pagination with page and perPage; defaults to page=1, perPage=50).
- Introduce IGitLabBranch and IGitLabTag interfaces and export them from ts/index.ts.
## 2026-02-28 - 2.3.0 - feat(gitlab)
add support for GitLab protected branches (list and unprotect)
- Added IGitLabProtectedBranch interface
- Added GitLabClient.getProtectedBranches(projectId) returning IGitLabProtectedBranch[]
- Added GitLabClient.unprotectBranch(projectId, branchName) to remove branch protection
- Exported IGitLabProtectedBranch from index.ts
- Non-breaking API additions; recommended minor version bump
## 2026-02-28 - 2.2.0 - feat(gitlabclient)
add deleteProject method to delete a project using GitLab API DELETE /api/v4/projects/:id
- Adds GitlabClient.deleteProject(projectId: number | string): Promise<void>.
- Implements DELETE /api/v4/projects/:id and URL-encodes the projectId.
- Non-breaking API addition — bump minor version.
## 2026-02-28 - 2.1.0 - feat(gitlab)
add group- and project-management methods to GitLab client

View File

@@ -1,6 +1,6 @@
{
"name": "@apiclient.xyz/gitlab",
"version": "2.1.0",
"version": "2.4.0",
"private": false,
"description": "A TypeScript client for the GitLab API, providing easy access to projects, groups, CI/CD variables, and pipelines.",
"main": "dist_ts/index.js",

View File

@@ -3,6 +3,6 @@
*/
export const commitinfo = {
name: '@apiclient.xyz/gitlab',
version: '2.1.0',
version: '2.4.0',
description: 'A TypeScript client for the GitLab API, providing easy access to projects, groups, CI/CD variables, and pipelines.'
}

View File

@@ -6,6 +6,9 @@ import type {
IGitLabGroup,
IGitLabVariable,
IVariableOptions,
IGitLabProtectedBranch,
IGitLabBranch,
IGitLabTag,
IGitLabPipeline,
IGitLabJob,
ITestConnectionResult,
@@ -368,4 +371,55 @@ export class GitLabClient {
`/api/v4/projects/${encodeURIComponent(projectId)}/pipelines/${pipelineId}/cancel`,
);
}
// ---------------------------------------------------------------------------
// Repository Branches & Tags
// ---------------------------------------------------------------------------
public async getRepoBranches(projectId: number | string, opts?: IListOptions): Promise<IGitLabBranch[]> {
const page = opts?.page || 1;
const perPage = opts?.perPage || 50;
return this.request<IGitLabBranch[]>(
'GET',
`/api/v4/projects/${encodeURIComponent(projectId)}/repository/branches?page=${page}&per_page=${perPage}`,
);
}
public async getRepoTags(projectId: number | string, opts?: IListOptions): Promise<IGitLabTag[]> {
const page = opts?.page || 1;
const perPage = opts?.perPage || 50;
return this.request<IGitLabTag[]>(
'GET',
`/api/v4/projects/${encodeURIComponent(projectId)}/repository/tags?page=${page}&per_page=${perPage}`,
);
}
// ---------------------------------------------------------------------------
// Protected Branches
// ---------------------------------------------------------------------------
public async getProtectedBranches(projectId: number | string): Promise<IGitLabProtectedBranch[]> {
return this.request<IGitLabProtectedBranch[]>(
'GET',
`/api/v4/projects/${encodeURIComponent(projectId)}/protected_branches`,
);
}
public async unprotectBranch(projectId: number | string, branchName: string): Promise<void> {
await this.request(
'DELETE',
`/api/v4/projects/${encodeURIComponent(projectId)}/protected_branches/${encodeURIComponent(branchName)}`,
);
}
// ---------------------------------------------------------------------------
// Project Deletion
// ---------------------------------------------------------------------------
public async deleteProject(projectId: number | string): Promise<void> {
await this.request(
'DELETE',
`/api/v4/projects/${encodeURIComponent(projectId)}`,
);
}
}

View File

@@ -44,6 +44,12 @@ export interface IVariableOptions {
environment_scope?: string;
}
export interface IGitLabProtectedBranch {
id: number;
name: string;
allow_force_push: boolean;
}
export interface IGitLabPipeline {
id: number;
project_id: number;
@@ -64,6 +70,20 @@ export interface IGitLabJob {
duration: number;
}
export interface IGitLabBranch {
name: string;
commit: {
id: string;
};
}
export interface IGitLabTag {
name: string;
commit: {
id: string;
};
}
export interface ITestConnectionResult {
ok: boolean;
error?: string;

View File

@@ -4,6 +4,9 @@ export type {
IGitLabProject,
IGitLabGroup,
IGitLabVariable,
IGitLabProtectedBranch,
IGitLabBranch,
IGitLabTag,
IVariableOptions,
IGitLabPipeline,
IGitLabJob,