Compare commits
25 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| 4d90bb01cf | |||
| e9dc0a7fa3 | |||
| 9feb49a3d4 | |||
| 879f16dd98 | |||
| e94004742f | |||
| 82940c7c0f | |||
| 016eaf1b91 | |||
| cbb9f364ae | |||
| ef688115d6 | |||
| 3aaa0f7e68 | |||
| 1cd7c62431 | |||
| 8f85104136 | |||
| c8059fb1c0 | |||
| 413c4be172 | |||
| e7cfd5dec1 | |||
| e002e90bd0 | |||
| f460b92c3a | |||
| 65e5575494 | |||
| 4da6b14dc2 | |||
| 95c5870252 | |||
| b0f56f5948 | |||
| cc00a78e2c | |||
| cf7e69e74a | |||
| 5cc3aeb27c | |||
| 098a9c64c6 |
3
.gitignore
vendored
3
.gitignore
vendored
@@ -3,7 +3,6 @@
|
||||
# artifacts
|
||||
coverage/
|
||||
public/
|
||||
pages/
|
||||
|
||||
# installs
|
||||
node_modules/
|
||||
@@ -17,4 +16,4 @@ node_modules/
|
||||
dist/
|
||||
dist_*/
|
||||
|
||||
# custom
|
||||
#------# custom
|
||||
|
||||
137
.gitlab-ci.yml
137
.gitlab-ci.yml
@@ -1,137 +0,0 @@
|
||||
# gitzone ci_default
|
||||
image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
|
||||
|
||||
cache:
|
||||
paths:
|
||||
- .npmci_cache/
|
||||
key: '$CI_BUILD_STAGE'
|
||||
|
||||
stages:
|
||||
- security
|
||||
- test
|
||||
- release
|
||||
- metadata
|
||||
|
||||
# ====================
|
||||
# security stage
|
||||
# ====================
|
||||
mirror:
|
||||
stage: security
|
||||
script:
|
||||
- npmci git mirror
|
||||
only:
|
||||
- tags
|
||||
tags:
|
||||
- lossless
|
||||
- docker
|
||||
- notpriv
|
||||
|
||||
auditProductionDependencies:
|
||||
image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
|
||||
stage: security
|
||||
script:
|
||||
- npmci npm prepare
|
||||
- npmci command npm install --production --ignore-scripts
|
||||
- npmci command npm config set registry https://registry.npmjs.org
|
||||
- npmci command npm audit --audit-level=high --only=prod --production
|
||||
tags:
|
||||
- docker
|
||||
|
||||
auditDevDependencies:
|
||||
image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
|
||||
stage: security
|
||||
script:
|
||||
- npmci npm prepare
|
||||
- npmci command npm install --ignore-scripts
|
||||
- npmci command npm config set registry https://registry.npmjs.org
|
||||
- npmci command npm audit --audit-level=high --only=dev
|
||||
tags:
|
||||
- docker
|
||||
allow_failure: true
|
||||
|
||||
# ====================
|
||||
# test stage
|
||||
# ====================
|
||||
|
||||
testStable:
|
||||
stage: test
|
||||
script:
|
||||
- npmci npm prepare
|
||||
- npmci node install stable
|
||||
- npmci npm install
|
||||
- npmci npm test
|
||||
coverage: /\d+.?\d+?\%\s*coverage/
|
||||
tags:
|
||||
- docker
|
||||
|
||||
testBuild:
|
||||
stage: test
|
||||
script:
|
||||
- npmci npm prepare
|
||||
- npmci node install stable
|
||||
- npmci npm install
|
||||
- npmci command npm run build
|
||||
coverage: /\d+.?\d+?\%\s*coverage/
|
||||
tags:
|
||||
- docker
|
||||
|
||||
release:
|
||||
stage: release
|
||||
script:
|
||||
- npmci node install stable
|
||||
- npmci npm publish
|
||||
only:
|
||||
- tags
|
||||
tags:
|
||||
- lossless
|
||||
- docker
|
||||
- notpriv
|
||||
|
||||
# ====================
|
||||
# metadata stage
|
||||
# ====================
|
||||
codequality:
|
||||
stage: metadata
|
||||
allow_failure: true
|
||||
only:
|
||||
- tags
|
||||
script:
|
||||
- npmci command npm install -g tslint typescript
|
||||
- npmci npm prepare
|
||||
- npmci npm install
|
||||
- npmci command "tslint -c tslint.json ./ts/**/*.ts"
|
||||
tags:
|
||||
- lossless
|
||||
- docker
|
||||
- priv
|
||||
|
||||
trigger:
|
||||
stage: metadata
|
||||
script:
|
||||
- npmci trigger
|
||||
only:
|
||||
- tags
|
||||
tags:
|
||||
- lossless
|
||||
- docker
|
||||
- notpriv
|
||||
|
||||
pages:
|
||||
stage: metadata
|
||||
script:
|
||||
- npmci node install lts
|
||||
- npmci command npm install -g @gitzone/tsdoc
|
||||
- npmci npm prepare
|
||||
- npmci npm install
|
||||
- npmci command tsdoc
|
||||
tags:
|
||||
- lossless
|
||||
- docker
|
||||
- notpriv
|
||||
only:
|
||||
- tags
|
||||
artifacts:
|
||||
expire_in: 1 week
|
||||
paths:
|
||||
- public
|
||||
allow_failure: true
|
||||
29
.vscode/launch.json
vendored
29
.vscode/launch.json
vendored
@@ -1,29 +0,0 @@
|
||||
{
|
||||
"version": "0.2.0",
|
||||
"configurations": [
|
||||
{
|
||||
"name": "current file",
|
||||
"type": "node",
|
||||
"request": "launch",
|
||||
"args": [
|
||||
"${relativeFile}"
|
||||
],
|
||||
"runtimeArgs": ["-r", "@gitzone/tsrun"],
|
||||
"cwd": "${workspaceRoot}",
|
||||
"protocol": "inspector",
|
||||
"internalConsoleOptions": "openOnSessionStart"
|
||||
},
|
||||
{
|
||||
"name": "test.ts",
|
||||
"type": "node",
|
||||
"request": "launch",
|
||||
"args": [
|
||||
"test/test.ts"
|
||||
],
|
||||
"runtimeArgs": ["-r", "@gitzone/tsrun"],
|
||||
"cwd": "${workspaceRoot}",
|
||||
"protocol": "inspector",
|
||||
"internalConsoleOptions": "openOnSessionStart"
|
||||
}
|
||||
]
|
||||
}
|
||||
26
.vscode/settings.json
vendored
26
.vscode/settings.json
vendored
@@ -1,26 +0,0 @@
|
||||
{
|
||||
"json.schemas": [
|
||||
{
|
||||
"fileMatch": ["/npmextra.json"],
|
||||
"schema": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"npmci": {
|
||||
"type": "object",
|
||||
"description": "settings for npmci"
|
||||
},
|
||||
"gitzone": {
|
||||
"type": "object",
|
||||
"description": "settings for gitzone",
|
||||
"properties": {
|
||||
"projectType": {
|
||||
"type": "string",
|
||||
"enum": ["website", "element", "service", "npm", "wcc"]
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
||||
80
changelog.md
Normal file
80
changelog.md
Normal file
@@ -0,0 +1,80 @@
|
||||
# Changelog
|
||||
|
||||
## 2026-03-02 - 2.5.0 - feat(gitlab)
|
||||
add pipelines and jobs API support, including list/get/trigger/delete/retry/cancel operations, job controls, and related types and list options
|
||||
|
||||
- Add new pipeline methods: getPipelines (with filtering, ordering and pagination), getPipeline, triggerPipeline, deletePipeline, retryPipeline, cancelPipeline, getPipelineVariables, getPipelineTestReport
|
||||
- Add new job methods: getPipelineJobs (with scope filtering and pagination), getJob, retryJob, cancelJob, playJob, eraseJob; preserve getJobLog
|
||||
- Introduce IPipelineListOptions and IJobListOptions for richer listing filters
|
||||
- Extend and add interfaces: IGitLabPipeline (additional metadata fields), IGitLabJob (expanded fields including pipeline, runner, artifacts), IGitLabPipelineVariable, IGitLabTestReport, IGitLabTestSuite, IGitLabTestCase and other minor interface reorganizations
|
||||
- Export the new interfaces from the package entry (ts/index.ts)
|
||||
|
||||
## 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
|
||||
|
||||
- Adds getGroupByPath(fullPath) to fetch a group by full path
|
||||
- Adds getGroupProjects(groupId, opts?) to list projects in a group (include_subgroups=true, default perPage=50, optional search)
|
||||
- Adds getDescendantGroups(groupId, opts?) to list descendant subgroups (paginated, default perPage=50, optional search)
|
||||
- Adds createGroup(name, path, parentId?) to create groups (defaults to private visibility)
|
||||
- Adds createProject(name, opts?) to create projects with optional path, namespaceId, visibility (default private) and description
|
||||
|
||||
## 2026-02-24 - 2.0.3 - fix()
|
||||
no changes detected; nothing to commit
|
||||
|
||||
- No files changed in the provided diff
|
||||
- No updates to source, dependencies, or package files
|
||||
|
||||
## 2026-02-24 - 2.0.2 - fix()
|
||||
no changes detected in diff; no version bump required
|
||||
|
||||
- No files changed in this commit/diff.
|
||||
- No code or dependency changes detected; no release necessary.
|
||||
|
||||
## 2026-02-24 - 2.0.1 - fix()
|
||||
no changes detected; no version bump required
|
||||
|
||||
- No files changed in diff
|
||||
- package.json current version is 2.0.0
|
||||
|
||||
## 2026-02-24 - 2.0.0 - gitlab
|
||||
Renamed package to @apiclient.xyz/gitlab and introduced a new ESM TypeScript GitLabClient API. Breaking release that replaces the legacy @mojoio/gitlab client.
|
||||
|
||||
- BREAKING CHANGE: package renamed to @apiclient.xyz/gitlab and API migrated to a new GitLabClient (v2.0.0).
|
||||
- New modern ESM TypeScript client with support for projects, groups, CI/CD variables, and pipelines.
|
||||
- fix(core): add npm release registry configuration (release tooling improvement).
|
||||
|
||||
## 2021-10-05 - 1.0.4..1.0.10 - core maintenance
|
||||
Series of patch releases containing maintenance updates and small fixes across the 1.0.x line.
|
||||
|
||||
- Multiple "fix(core): update" commits applying minor fixes and internal updates across 1.0.4–1.0.10.
|
||||
- Mostly patch-level changes and version bumps; no documented breaking or feature changes.
|
||||
|
||||
## 2017-06-10 - 1.0.1..1.0.3 - initial release & docs
|
||||
Initial project setup and first releases.
|
||||
|
||||
- 1.0.1 — initial commit.
|
||||
- 1.0.2 — add README.
|
||||
- 1.0.3 — patch/versioned release.
|
||||
21
license.md
Normal file
21
license.md
Normal file
@@ -0,0 +1,21 @@
|
||||
MIT License
|
||||
|
||||
Copyright (c) 2025 Lossless GmbH (https://lossless.com)
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all
|
||||
copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||
SOFTWARE.
|
||||
@@ -1,19 +1,35 @@
|
||||
{
|
||||
"npmci": {
|
||||
"npmGlobalTools": [],
|
||||
"npmAccessLevel": "public"
|
||||
},
|
||||
"gitzone": {
|
||||
"projectType": "npm",
|
||||
"module": {
|
||||
"githost": "gitlab.com",
|
||||
"gitscope": "mojoio",
|
||||
"githost": "code.foss.global",
|
||||
"gitscope": "apiclient.xyz",
|
||||
"gitrepo": "gitlab",
|
||||
"shortDescription": "a gitlab api abstraction package",
|
||||
"npmPackagename": "@mojoio/gitlab",
|
||||
"description": "A TypeScript client for the GitLab API, providing easy access to projects, groups, CI/CD variables, and pipelines.",
|
||||
"npmPackagename": "@apiclient.xyz/gitlab",
|
||||
"license": "MIT",
|
||||
"projectDomain": "mojo.io"
|
||||
"keywords": [
|
||||
"gitlab",
|
||||
"api client",
|
||||
"TypeScript",
|
||||
"CI/CD",
|
||||
"pipelines",
|
||||
"variables",
|
||||
"devops"
|
||||
]
|
||||
}
|
||||
},
|
||||
"npmci": {
|
||||
"npmGlobalTools": [],
|
||||
"npmRegistryUrl": "registry.npmjs.org",
|
||||
"npmAccessLevel": "public"
|
||||
"@git.zone/cli": {
|
||||
"release": {
|
||||
"registries": [
|
||||
"https://verdaccio.lossless.digital",
|
||||
"https://registry.npmjs.org"
|
||||
],
|
||||
"accessLevel": "public"
|
||||
}
|
||||
}
|
||||
}
|
||||
11585
package-lock.json
generated
11585
package-lock.json
generated
File diff suppressed because it is too large
Load Diff
55
package.json
55
package.json
@@ -1,32 +1,42 @@
|
||||
{
|
||||
"name": "@mojoio/gitlab",
|
||||
"version": "1.0.8",
|
||||
"description": "api abstraction package for gitlab",
|
||||
"name": "@apiclient.xyz/gitlab",
|
||||
"version": "2.5.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",
|
||||
"typings": "dist_ts/index.d.ts",
|
||||
"type": "module",
|
||||
"scripts": {
|
||||
"test": "(tstest test/ --verbose --timeout 600)",
|
||||
"build": "(tsbuild --web --allowimplicitany)"
|
||||
},
|
||||
"repository": {
|
||||
"type": "git",
|
||||
"url": "https://code.foss.global/apiclient.xyz/gitlab.git"
|
||||
},
|
||||
"keywords": [
|
||||
"gitlab",
|
||||
"api client",
|
||||
"TypeScript",
|
||||
"CI/CD",
|
||||
"pipelines",
|
||||
"variables",
|
||||
"devops"
|
||||
],
|
||||
"author": "Lossless GmbH",
|
||||
"license": "MIT",
|
||||
"scripts": {
|
||||
"test": "(tstest test/)",
|
||||
"build": "(tsbuild --web)"
|
||||
"dependencies": {
|
||||
"@push.rocks/smartlog": "^3.1.10",
|
||||
"@push.rocks/smartrequest": "^5.0.1"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@gitzone/tsbuild": "^2.1.25",
|
||||
"@gitzone/tsrun": "^1.2.12",
|
||||
"@gitzone/tstest": "^1.0.54",
|
||||
"@pushrocks/tapbundle": "^3.2.14",
|
||||
"tslint": "^6.1.3",
|
||||
"tslint-config-prettier": "^1.18.0"
|
||||
"@git.zone/tsbuild": "^3.1.0",
|
||||
"@git.zone/tsrun": "^2.0.0",
|
||||
"@git.zone/tstest": "^2.8.2",
|
||||
"@push.rocks/qenv": "^6.1.3",
|
||||
"@push.rocks/tapbundle": "^5.6.0",
|
||||
"@types/node": "^22.15.3"
|
||||
},
|
||||
"dependencies": {
|
||||
"@pushrocks/smartfile": "^8.0.10",
|
||||
"@pushrocks/smartrequest": "^1.1.52",
|
||||
"@pushrocks/smarturl": "^2.0.1"
|
||||
},
|
||||
"private": false,
|
||||
"browserslist": [
|
||||
"last 1 chrome versions"
|
||||
],
|
||||
"files": [
|
||||
"ts/**/*",
|
||||
"ts_web/**/*",
|
||||
@@ -38,5 +48,8 @@
|
||||
"cli.js",
|
||||
"npmextra.json",
|
||||
"readme.md"
|
||||
],
|
||||
"browserslist": [
|
||||
"last 1 chrome versions"
|
||||
]
|
||||
}
|
||||
|
||||
9914
pnpm-lock.yaml
generated
Normal file
9914
pnpm-lock.yaml
generated
Normal file
File diff suppressed because it is too large
Load Diff
314
readme.md
314
readme.md
@@ -1,46 +1,296 @@
|
||||
# @mojoio/gitlab
|
||||
a gitlab api abstraction package
|
||||
# @apiclient.xyz/gitlab
|
||||
|
||||
## Availabililty and Links
|
||||
* [npmjs.org (npm package)](https://www.npmjs.com/package/@mojoio/gitlab)
|
||||
* [gitlab.com (source)](https://gitlab.com/mojoio/gitlab)
|
||||
* [github.com (source mirror)](https://github.com/mojoio/gitlab)
|
||||
* [docs (typedoc)](https://mojoio.gitlab.io/gitlab/)
|
||||
A TypeScript client for the GitLab API, providing easy access to projects, groups, CI/CD variables, and pipelines.
|
||||
|
||||
## Status for master
|
||||
## Install
|
||||
|
||||
Status Category | Status Badge
|
||||
-- | --
|
||||
GitLab Pipelines | [](https://lossless.cloud)
|
||||
GitLab Pipline Test Coverage | [](https://lossless.cloud)
|
||||
npm | [](https://lossless.cloud)
|
||||
Snyk | [](https://lossless.cloud)
|
||||
TypeScript Support | [](https://lossless.cloud)
|
||||
node Support | [](https://nodejs.org/dist/latest-v10.x/docs/api/)
|
||||
Code Style | [](https://lossless.cloud)
|
||||
PackagePhobia (total standalone install weight) | [](https://lossless.cloud)
|
||||
PackagePhobia (package size on registry) | [](https://lossless.cloud)
|
||||
BundlePhobia (total size when bundled) | [](https://lossless.cloud)
|
||||
Platform support | [](https://lossless.cloud) [](https://lossless.cloud)
|
||||
```bash
|
||||
npm install @apiclient.xyz/gitlab
|
||||
```
|
||||
|
||||
## Usage
|
||||
|
||||
Use TypeScript for best in class instellisense.
|
||||
All examples below use ESM imports and async/await.
|
||||
|
||||
For further information read the linked docs at the top of this README.
|
||||
### Creating a Client
|
||||
|
||||
> MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh)
|
||||
> | By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy.html)
|
||||
```typescript
|
||||
import { GitLabClient } from '@apiclient.xyz/gitlab';
|
||||
|
||||
[](https://mojo.io)
|
||||
const client = new GitLabClient('https://gitlab.example.com', 'your-private-token');
|
||||
```
|
||||
|
||||
## Contribution
|
||||
The constructor accepts the base URL of your GitLab instance and a personal access token (or project/group token) used for authentication via the `PRIVATE-TOKEN` header.
|
||||
|
||||
We are always happy for code contributions. If you are not the code contributing type that is ok. Still, maintaining Open Source repositories takes considerable time and thought. If you like the quality of what we do and our modules are useful to you we would appreciate a little monthly contribution: You can [contribute one time](https://lossless.link/contribute-onetime) or [contribute monthly](https://lossless.link/contribute). :)
|
||||
### Testing the Connection
|
||||
|
||||
For further information read the linked docs at the top of this readme.
|
||||
```typescript
|
||||
const result = await client.testConnection();
|
||||
|
||||
> MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh)
|
||||
| By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy)
|
||||
if (result.ok) {
|
||||
console.log('Connected successfully.');
|
||||
} else {
|
||||
console.error('Connection failed:', result.error);
|
||||
}
|
||||
```
|
||||
|
||||
[](https://maintainedby.lossless.com)
|
||||
### Listing Projects
|
||||
|
||||
Retrieve projects you are a member of, ordered by most recently updated.
|
||||
|
||||
```typescript
|
||||
// First page, default 50 per page
|
||||
const projects = await client.getProjects();
|
||||
|
||||
// Search with pagination
|
||||
const filtered = await client.getProjects({
|
||||
search: 'my-service',
|
||||
page: 1,
|
||||
perPage: 20,
|
||||
});
|
||||
|
||||
for (const project of filtered) {
|
||||
console.log(`${project.id} - ${project.path_with_namespace}`);
|
||||
}
|
||||
```
|
||||
|
||||
### Listing Groups
|
||||
|
||||
```typescript
|
||||
const groups = await client.getGroups();
|
||||
|
||||
// Search groups by name
|
||||
const matchingGroups = await client.getGroups({ search: 'platform' });
|
||||
|
||||
for (const group of matchingGroups) {
|
||||
console.log(`${group.id} - ${group.full_path}`);
|
||||
}
|
||||
```
|
||||
|
||||
### Managing Project Variables
|
||||
|
||||
```typescript
|
||||
const projectId = 42;
|
||||
|
||||
// List all variables
|
||||
const vars = await client.getProjectVariables(projectId);
|
||||
|
||||
// Create a variable
|
||||
await client.createProjectVariable(projectId, 'DATABASE_URL', 'postgres://...', {
|
||||
protected: true,
|
||||
masked: true,
|
||||
environment_scope: 'production',
|
||||
});
|
||||
|
||||
// Update a variable
|
||||
await client.updateProjectVariable(projectId, 'DATABASE_URL', 'postgres://new-host/...', {
|
||||
protected: true,
|
||||
});
|
||||
|
||||
// Delete a variable
|
||||
await client.deleteProjectVariable(projectId, 'DATABASE_URL');
|
||||
```
|
||||
|
||||
### Managing Group Variables
|
||||
|
||||
The group variable API mirrors the project variable API.
|
||||
|
||||
```typescript
|
||||
const groupId = 7;
|
||||
|
||||
// List all variables
|
||||
const groupVars = await client.getGroupVariables(groupId);
|
||||
|
||||
// Create a variable
|
||||
await client.createGroupVariable(groupId, 'NPM_TOKEN', 'tok-xxx', {
|
||||
protected: false,
|
||||
masked: true,
|
||||
environment_scope: '*',
|
||||
});
|
||||
|
||||
// Update a variable
|
||||
await client.updateGroupVariable(groupId, 'NPM_TOKEN', 'tok-yyy', {
|
||||
masked: true,
|
||||
});
|
||||
|
||||
// Delete a variable
|
||||
await client.deleteGroupVariable(groupId, 'NPM_TOKEN');
|
||||
```
|
||||
|
||||
### Working with Pipelines
|
||||
|
||||
```typescript
|
||||
const projectId = 42;
|
||||
|
||||
// List recent pipelines
|
||||
const pipelines = await client.getPipelines(projectId, { page: 1, perPage: 10 });
|
||||
|
||||
for (const pipeline of pipelines) {
|
||||
console.log(`Pipeline #${pipeline.id} [${pipeline.status}] on ${pipeline.ref}`);
|
||||
}
|
||||
|
||||
// Get jobs for a specific pipeline
|
||||
const jobs = await client.getPipelineJobs(projectId, pipelines[0].id);
|
||||
for (const job of jobs) {
|
||||
console.log(` Job "${job.name}" (${job.stage}): ${job.status}`);
|
||||
}
|
||||
|
||||
// Read the raw log output of a job
|
||||
const log = await client.getJobLog(projectId, jobs[0].id);
|
||||
console.log(log);
|
||||
|
||||
// Retry a failed pipeline
|
||||
await client.retryPipeline(projectId, pipelines[0].id);
|
||||
|
||||
// Cancel a running pipeline
|
||||
await client.cancelPipeline(projectId, pipelines[0].id);
|
||||
```
|
||||
|
||||
## API Reference
|
||||
|
||||
### `GitLabClient`
|
||||
|
||||
| Method | Signature | Returns | Description |
|
||||
|---|---|---|---|
|
||||
| `constructor` | `(baseUrl: string, token: string)` | `GitLabClient` | Create a new client instance. |
|
||||
| `testConnection` | `()` | `Promise<ITestConnectionResult>` | Verify the token and connectivity. |
|
||||
| `getProjects` | `(opts?: IListOptions)` | `Promise<IGitLabProject[]>` | List projects you are a member of. |
|
||||
| `getGroups` | `(opts?: IListOptions)` | `Promise<IGitLabGroup[]>` | List accessible groups. |
|
||||
| `getProjectVariables` | `(projectId: number \| string)` | `Promise<IGitLabVariable[]>` | List all CI/CD variables for a project. |
|
||||
| `createProjectVariable` | `(projectId: number \| string, key: string, value: string, opts?: IVariableOptions)` | `Promise<IGitLabVariable>` | Create a CI/CD variable on a project. |
|
||||
| `updateProjectVariable` | `(projectId: number \| string, key: string, value: string, opts?: IVariableOptions)` | `Promise<IGitLabVariable>` | Update an existing project variable. |
|
||||
| `deleteProjectVariable` | `(projectId: number \| string, key: string)` | `Promise<void>` | Delete a project variable. |
|
||||
| `getGroupVariables` | `(groupId: number \| string)` | `Promise<IGitLabVariable[]>` | List all CI/CD variables for a group. |
|
||||
| `createGroupVariable` | `(groupId: number \| string, key: string, value: string, opts?: IVariableOptions)` | `Promise<IGitLabVariable>` | Create a CI/CD variable on a group. |
|
||||
| `updateGroupVariable` | `(groupId: number \| string, key: string, value: string, opts?: IVariableOptions)` | `Promise<IGitLabVariable>` | Update an existing group variable. |
|
||||
| `deleteGroupVariable` | `(groupId: number \| string, key: string)` | `Promise<void>` | Delete a group variable. |
|
||||
| `getPipelines` | `(projectId: number \| string, opts?: IListOptions)` | `Promise<IGitLabPipeline[]>` | List pipelines for a project, newest first. |
|
||||
| `getPipelineJobs` | `(projectId: number \| string, pipelineId: number)` | `Promise<IGitLabJob[]>` | Get all jobs for a pipeline. |
|
||||
| `getJobLog` | `(projectId: number \| string, jobId: number)` | `Promise<string>` | Retrieve the raw trace/log of a job. |
|
||||
| `retryPipeline` | `(projectId: number \| string, pipelineId: number)` | `Promise<void>` | Retry all failed jobs in a pipeline. |
|
||||
| `cancelPipeline` | `(projectId: number \| string, pipelineId: number)` | `Promise<void>` | Cancel a running pipeline. |
|
||||
|
||||
## Types
|
||||
|
||||
### `IListOptions`
|
||||
|
||||
Pagination and search options used by `getProjects`, `getGroups`, and `getPipelines`.
|
||||
|
||||
```typescript
|
||||
interface IListOptions {
|
||||
search?: string; // Filter results by keyword
|
||||
page?: number; // Page number (default: 1)
|
||||
perPage?: number; // Items per page (default: 50 for projects/groups, 30 for pipelines)
|
||||
}
|
||||
```
|
||||
|
||||
### `IVariableOptions`
|
||||
|
||||
Options when creating or updating CI/CD variables.
|
||||
|
||||
```typescript
|
||||
interface IVariableOptions {
|
||||
protected?: boolean; // Only expose to protected branches/tags (default: false)
|
||||
masked?: boolean; // Mask the value in job logs (default: false)
|
||||
environment_scope?: string; // Environment scope (default: '*' for all environments)
|
||||
}
|
||||
```
|
||||
|
||||
### `ITestConnectionResult`
|
||||
|
||||
```typescript
|
||||
interface ITestConnectionResult {
|
||||
ok: boolean;
|
||||
error?: string; // Present when ok is false
|
||||
}
|
||||
```
|
||||
|
||||
### `IGitLabProject`
|
||||
|
||||
```typescript
|
||||
interface IGitLabProject {
|
||||
id: number;
|
||||
name: string;
|
||||
path_with_namespace: string;
|
||||
description: string;
|
||||
default_branch: string;
|
||||
web_url: string;
|
||||
visibility: string;
|
||||
topics: string[];
|
||||
last_activity_at: string;
|
||||
}
|
||||
```
|
||||
|
||||
### `IGitLabGroup`
|
||||
|
||||
```typescript
|
||||
interface IGitLabGroup {
|
||||
id: number;
|
||||
name: string;
|
||||
full_path: string;
|
||||
description: string;
|
||||
web_url: string;
|
||||
visibility: string;
|
||||
}
|
||||
```
|
||||
|
||||
### `IGitLabVariable`
|
||||
|
||||
```typescript
|
||||
interface IGitLabVariable {
|
||||
key: string;
|
||||
value: string;
|
||||
variable_type: string;
|
||||
protected: boolean;
|
||||
masked: boolean;
|
||||
environment_scope: string;
|
||||
}
|
||||
```
|
||||
|
||||
### `IGitLabPipeline`
|
||||
|
||||
```typescript
|
||||
interface IGitLabPipeline {
|
||||
id: number;
|
||||
project_id: number;
|
||||
status: string;
|
||||
ref: string;
|
||||
sha: string;
|
||||
web_url: string;
|
||||
duration: number;
|
||||
created_at: string;
|
||||
source: string;
|
||||
}
|
||||
```
|
||||
|
||||
### `IGitLabJob`
|
||||
|
||||
```typescript
|
||||
interface IGitLabJob {
|
||||
id: number;
|
||||
name: string;
|
||||
stage: string;
|
||||
status: string;
|
||||
duration: number;
|
||||
}
|
||||
```
|
||||
|
||||
### `IGitLabUser`
|
||||
|
||||
Returned internally by `testConnection` to verify credentials.
|
||||
|
||||
```typescript
|
||||
interface IGitLabUser {
|
||||
id: number;
|
||||
username: string;
|
||||
name: string;
|
||||
email: string;
|
||||
avatar_url: string;
|
||||
web_url: string;
|
||||
state: string;
|
||||
}
|
||||
```
|
||||
|
||||
## License
|
||||
|
||||
MIT
|
||||
|
||||
34
test/test.node.ts
Normal file
34
test/test.node.ts
Normal file
@@ -0,0 +1,34 @@
|
||||
import { tap, expect } from '@push.rocks/tapbundle';
|
||||
import * as qenv from '@push.rocks/qenv';
|
||||
import { GitLabClient } from '../ts/index.js';
|
||||
|
||||
const testQenv = new qenv.Qenv('./', '.nogit/');
|
||||
|
||||
let gitlabClient: GitLabClient;
|
||||
|
||||
tap.test('should create a GitLabClient instance', async () => {
|
||||
const baseUrl = (await testQenv.getEnvVarOnDemand('GITLAB_BASE_URL')) || 'https://gitlab.com';
|
||||
const token = (await testQenv.getEnvVarOnDemand('GITLAB_TOKEN')) || '';
|
||||
gitlabClient = new GitLabClient(baseUrl, token);
|
||||
expect(gitlabClient).toBeInstanceOf(GitLabClient);
|
||||
});
|
||||
|
||||
tap.test('should test connection', async () => {
|
||||
const result = await gitlabClient.testConnection();
|
||||
expect(result).toHaveProperty('ok');
|
||||
console.log('Connection test:', result);
|
||||
});
|
||||
|
||||
tap.test('should get projects', async () => {
|
||||
const projects = await gitlabClient.getProjects({ perPage: 5 });
|
||||
expect(projects).toBeArray();
|
||||
console.log(`Found ${projects.length} projects`);
|
||||
});
|
||||
|
||||
tap.test('should get groups', async () => {
|
||||
const groups = await gitlabClient.getGroups({ perPage: 5 });
|
||||
expect(groups).toBeArray();
|
||||
console.log(`Found ${groups.length} groups`);
|
||||
});
|
||||
|
||||
export default tap.start();
|
||||
35
test/test.ts
35
test/test.ts
@@ -1,35 +0,0 @@
|
||||
import { expect, tap } from '@pushrocks/tapbundle';
|
||||
import * as gitlab from '../ts/index';
|
||||
|
||||
let testGitlabAccount: gitlab.GitlabAccount;
|
||||
|
||||
tap.test('should create an anonymous Gitlab Account', async () => {
|
||||
testGitlabAccount = gitlab.GitlabAccount.createAnonymousAccount();
|
||||
expect(testGitlabAccount).to.be.instanceOf(gitlab.GitlabAccount);
|
||||
});
|
||||
|
||||
tap.test('should get the pushrocks group', async () => {
|
||||
const pushrocksGroup = await testGitlabAccount.getGroupByName('pushrocks');
|
||||
expect(pushrocksGroup).to.be.instanceOf(gitlab.GitlabGroup);
|
||||
console.log(pushrocksGroup);
|
||||
});
|
||||
|
||||
tap.test('should get the pushrocks group', async () => {
|
||||
const pushrocksGroup = await testGitlabAccount.getGroupByName('pushrocks');
|
||||
expect(pushrocksGroup).to.be.instanceOf(gitlab.GitlabGroup);
|
||||
await pushrocksGroup.getProjects();
|
||||
});
|
||||
|
||||
tap.test('should get the readme of a project', async () => {
|
||||
const pushrocksGroup = await testGitlabAccount.getGroupByName('pushrocks');
|
||||
expect(pushrocksGroup).to.be.instanceOf(gitlab.GitlabGroup);
|
||||
const projects = await pushrocksGroup.getProjects();
|
||||
const selectedProject = projects.find((project) => {
|
||||
return project.data?.name === 'smartfile';
|
||||
});
|
||||
expect(selectedProject.data.name).to.equal('smartfile');
|
||||
const readme = await selectedProject.getReadmeAsMarkdown('master');
|
||||
expect(readme).to.startWith('# @pushrocks/smartfile');
|
||||
});
|
||||
|
||||
tap.start();
|
||||
8
ts/00_commitinfo_data.ts
Normal file
8
ts/00_commitinfo_data.ts
Normal file
@@ -0,0 +1,8 @@
|
||||
/**
|
||||
* autocreated commitinfo by @push.rocks/commitinfo
|
||||
*/
|
||||
export const commitinfo = {
|
||||
name: '@apiclient.xyz/gitlab',
|
||||
version: '2.5.0',
|
||||
description: 'A TypeScript client for the GitLab API, providing easy access to projects, groups, CI/CD variables, and pipelines.'
|
||||
}
|
||||
@@ -1,64 +0,0 @@
|
||||
import { GitlabGroup } from './gitlab.classes.group';
|
||||
import * as plugins from './gitlab.plugins';
|
||||
|
||||
export class GitlabAccount {
|
||||
public static createAnonymousAccount() {
|
||||
return new GitlabAccount();
|
||||
}
|
||||
|
||||
// INSTANCE
|
||||
public async getGroupByName(nameArg: string): Promise<GitlabGroup> {
|
||||
return GitlabGroup.getByName(nameArg, this);
|
||||
}
|
||||
|
||||
/**
|
||||
* handles the basic request/response patterns with the gitlab.com API
|
||||
*/
|
||||
public async request(
|
||||
methodArg: 'GET' | 'POST',
|
||||
routeArg: string,
|
||||
searchParamsArg: { [key: string]: string }
|
||||
) {
|
||||
if (!routeArg.startsWith('/')) {
|
||||
throw new Error(`"${routeArg}" -> routeArg must start with a slash`);
|
||||
}
|
||||
const smarturlInstance = plugins.smarturl.Smarturl.createFromUrl(
|
||||
`https://gitlab.com/api/v4${routeArg}`,
|
||||
{
|
||||
searchParams: searchParamsArg,
|
||||
}
|
||||
);
|
||||
const response = await plugins.smartrequest.request(smarturlInstance.toString(), {
|
||||
method: methodArg,
|
||||
});
|
||||
|
||||
// lets deal with pagination headers
|
||||
const findLinkName = (markup) => {
|
||||
const pattern = /<([^\s>]+)(\s|>)+/;
|
||||
return markup.match(pattern)[1];
|
||||
};
|
||||
if (typeof response.headers.link === 'string') {
|
||||
const links = response.headers.link.split(',');
|
||||
const linkObjects: {
|
||||
original: string;
|
||||
link: string;
|
||||
}[] = [];
|
||||
for (const link of links) {
|
||||
linkObjects.push({
|
||||
original: link,
|
||||
link: findLinkName(link),
|
||||
});
|
||||
}
|
||||
const next = linkObjects.find((linkObject) => linkObject.original.includes('rel="next"'));
|
||||
if (next && response.body instanceof Array) {
|
||||
const nextResponse = await this.request(
|
||||
methodArg,
|
||||
next.link.replace('https://gitlab.com/api/v4', ''),
|
||||
{}
|
||||
);
|
||||
response.body = response.body.concat(nextResponse);
|
||||
}
|
||||
}
|
||||
return response.body;
|
||||
}
|
||||
}
|
||||
564
ts/gitlab.classes.gitlabclient.ts
Normal file
564
ts/gitlab.classes.gitlabclient.ts
Normal file
@@ -0,0 +1,564 @@
|
||||
import * as plugins from './gitlab.plugins.js';
|
||||
import { logger } from './gitlab.logging.js';
|
||||
import type {
|
||||
IGitLabUser,
|
||||
IGitLabProject,
|
||||
IGitLabGroup,
|
||||
IGitLabVariable,
|
||||
IVariableOptions,
|
||||
IGitLabProtectedBranch,
|
||||
IGitLabBranch,
|
||||
IGitLabTag,
|
||||
IGitLabPipeline,
|
||||
IGitLabPipelineVariable,
|
||||
IGitLabTestReport,
|
||||
IGitLabJob,
|
||||
ITestConnectionResult,
|
||||
IListOptions,
|
||||
IPipelineListOptions,
|
||||
IJobListOptions,
|
||||
} from './gitlab.interfaces.js';
|
||||
|
||||
export class GitLabClient {
|
||||
private baseUrl: string;
|
||||
private token: string;
|
||||
|
||||
constructor(baseUrl: string, token: string) {
|
||||
// Remove trailing slash if present
|
||||
this.baseUrl = baseUrl.replace(/\/+$/, '');
|
||||
this.token = token;
|
||||
}
|
||||
|
||||
// ---------------------------------------------------------------------------
|
||||
// HTTP helpers
|
||||
// ---------------------------------------------------------------------------
|
||||
|
||||
private async request<T = any>(
|
||||
method: 'GET' | 'POST' | 'PUT' | 'DELETE',
|
||||
path: string,
|
||||
data?: any,
|
||||
customHeaders?: Record<string, string>,
|
||||
): Promise<T> {
|
||||
const url = `${this.baseUrl}${path}`;
|
||||
|
||||
let builder = plugins.smartrequest.SmartRequest.create()
|
||||
.url(url)
|
||||
.header('PRIVATE-TOKEN', this.token)
|
||||
.header('Content-Type', 'application/json');
|
||||
|
||||
if (customHeaders) {
|
||||
for (const [k, v] of Object.entries(customHeaders)) {
|
||||
builder = builder.header(k, v);
|
||||
}
|
||||
}
|
||||
|
||||
if (data) {
|
||||
builder = builder.json(data);
|
||||
}
|
||||
|
||||
let response: Awaited<ReturnType<typeof builder.get>>;
|
||||
switch (method) {
|
||||
case 'GET':
|
||||
response = await builder.get();
|
||||
break;
|
||||
case 'POST':
|
||||
response = await builder.post();
|
||||
break;
|
||||
case 'PUT':
|
||||
response = await builder.put();
|
||||
break;
|
||||
case 'DELETE':
|
||||
response = await builder.delete();
|
||||
break;
|
||||
}
|
||||
|
||||
if (!response.ok) {
|
||||
const errorText = await response.text();
|
||||
throw new Error(`${method} ${path}: ${response.status} ${response.statusText} - ${errorText}`);
|
||||
}
|
||||
|
||||
try {
|
||||
return await response.json() as T;
|
||||
} catch {
|
||||
return undefined as unknown as T;
|
||||
}
|
||||
}
|
||||
|
||||
private async requestText(
|
||||
method: 'GET' | 'POST' | 'PUT' | 'DELETE',
|
||||
path: string,
|
||||
): Promise<string> {
|
||||
const url = `${this.baseUrl}${path}`;
|
||||
|
||||
let builder = plugins.smartrequest.SmartRequest.create()
|
||||
.url(url)
|
||||
.header('PRIVATE-TOKEN', this.token)
|
||||
.header('Accept', 'text/plain');
|
||||
|
||||
let response: Awaited<ReturnType<typeof builder.get>>;
|
||||
switch (method) {
|
||||
case 'GET':
|
||||
response = await builder.get();
|
||||
break;
|
||||
case 'POST':
|
||||
response = await builder.post();
|
||||
break;
|
||||
case 'PUT':
|
||||
response = await builder.put();
|
||||
break;
|
||||
case 'DELETE':
|
||||
response = await builder.delete();
|
||||
break;
|
||||
}
|
||||
|
||||
if (!response.ok) {
|
||||
const errorText = await response.text();
|
||||
throw new Error(`${method} ${path}: ${response.status} ${response.statusText} - ${errorText}`);
|
||||
}
|
||||
|
||||
return response.text();
|
||||
}
|
||||
|
||||
// ---------------------------------------------------------------------------
|
||||
// Connection
|
||||
// ---------------------------------------------------------------------------
|
||||
|
||||
public async testConnection(): Promise<ITestConnectionResult> {
|
||||
try {
|
||||
await this.request<IGitLabUser>('GET', '/api/v4/user');
|
||||
return { ok: true };
|
||||
} catch (err) {
|
||||
return { ok: false, error: err instanceof Error ? err.message : String(err) };
|
||||
}
|
||||
}
|
||||
|
||||
// ---------------------------------------------------------------------------
|
||||
// Groups — scoped queries
|
||||
// ---------------------------------------------------------------------------
|
||||
|
||||
/**
|
||||
* Get a single group by its full path (e.g. "foss.global" or "foss.global/push.rocks")
|
||||
*/
|
||||
public async getGroupByPath(fullPath: string): Promise<IGitLabGroup> {
|
||||
return this.request<IGitLabGroup>(
|
||||
'GET',
|
||||
`/api/v4/groups/${encodeURIComponent(fullPath)}`,
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* List projects within a group (includes subgroups when include_subgroups=true)
|
||||
*/
|
||||
public async getGroupProjects(groupId: number | string, opts?: IListOptions): Promise<IGitLabProject[]> {
|
||||
const page = opts?.page || 1;
|
||||
const perPage = opts?.perPage || 50;
|
||||
let url = `/api/v4/groups/${encodeURIComponent(groupId)}/projects?include_subgroups=true&order_by=updated_at&sort=desc&page=${page}&per_page=${perPage}`;
|
||||
if (opts?.search) {
|
||||
url += `&search=${encodeURIComponent(opts.search)}`;
|
||||
}
|
||||
return this.request<IGitLabProject[]>('GET', url);
|
||||
}
|
||||
|
||||
/**
|
||||
* List all descendant groups (recursive subgroups) within a group
|
||||
*/
|
||||
public async getDescendantGroups(groupId: number | string, opts?: IListOptions): Promise<IGitLabGroup[]> {
|
||||
const page = opts?.page || 1;
|
||||
const perPage = opts?.perPage || 50;
|
||||
let url = `/api/v4/groups/${encodeURIComponent(groupId)}/descendant_groups?order_by=name&sort=asc&page=${page}&per_page=${perPage}`;
|
||||
if (opts?.search) {
|
||||
url += `&search=${encodeURIComponent(opts.search)}`;
|
||||
}
|
||||
return this.request<IGitLabGroup[]>('GET', url);
|
||||
}
|
||||
|
||||
/**
|
||||
* Create a new group. Optionally nested under a parent group.
|
||||
*/
|
||||
public async createGroup(name: string, path: string, parentId?: number): Promise<IGitLabGroup> {
|
||||
const body: any = { name, path, visibility: 'private' };
|
||||
if (parentId) body.parent_id = parentId;
|
||||
return this.request<IGitLabGroup>('POST', '/api/v4/groups', body);
|
||||
}
|
||||
|
||||
/**
|
||||
* Create a new project (repository).
|
||||
*/
|
||||
public async createProject(name: string, opts?: {
|
||||
path?: string;
|
||||
namespaceId?: number;
|
||||
visibility?: string;
|
||||
description?: string;
|
||||
}): Promise<IGitLabProject> {
|
||||
return this.request<IGitLabProject>('POST', '/api/v4/projects', {
|
||||
name,
|
||||
path: opts?.path || name,
|
||||
namespace_id: opts?.namespaceId,
|
||||
visibility: opts?.visibility || 'private',
|
||||
description: opts?.description || '',
|
||||
});
|
||||
}
|
||||
|
||||
// ---------------------------------------------------------------------------
|
||||
// Projects
|
||||
// ---------------------------------------------------------------------------
|
||||
|
||||
public async getProjects(opts?: IListOptions): Promise<IGitLabProject[]> {
|
||||
const page = opts?.page || 1;
|
||||
const perPage = opts?.perPage || 50;
|
||||
let url = `/api/v4/projects?membership=true&order_by=updated_at&sort=desc&page=${page}&per_page=${perPage}`;
|
||||
if (opts?.search) {
|
||||
url += `&search=${encodeURIComponent(opts.search)}`;
|
||||
}
|
||||
return this.request<IGitLabProject[]>('GET', url);
|
||||
}
|
||||
|
||||
// ---------------------------------------------------------------------------
|
||||
// Groups
|
||||
// ---------------------------------------------------------------------------
|
||||
|
||||
public async getGroups(opts?: IListOptions): Promise<IGitLabGroup[]> {
|
||||
const page = opts?.page || 1;
|
||||
const perPage = opts?.perPage || 50;
|
||||
let url = `/api/v4/groups?order_by=name&sort=asc&page=${page}&per_page=${perPage}`;
|
||||
if (opts?.search) {
|
||||
url += `&search=${encodeURIComponent(opts.search)}`;
|
||||
}
|
||||
return this.request<IGitLabGroup[]>('GET', url);
|
||||
}
|
||||
|
||||
// ---------------------------------------------------------------------------
|
||||
// Project Variables (CI/CD)
|
||||
// ---------------------------------------------------------------------------
|
||||
|
||||
public async getProjectVariables(projectId: number | string): Promise<IGitLabVariable[]> {
|
||||
return this.request<IGitLabVariable[]>(
|
||||
'GET',
|
||||
`/api/v4/projects/${encodeURIComponent(projectId)}/variables`,
|
||||
);
|
||||
}
|
||||
|
||||
public async createProjectVariable(
|
||||
projectId: number | string,
|
||||
key: string,
|
||||
value: string,
|
||||
opts?: IVariableOptions,
|
||||
): Promise<IGitLabVariable> {
|
||||
return this.request<IGitLabVariable>(
|
||||
'POST',
|
||||
`/api/v4/projects/${encodeURIComponent(projectId)}/variables`,
|
||||
{
|
||||
key,
|
||||
value,
|
||||
protected: opts?.protected ?? false,
|
||||
masked: opts?.masked ?? false,
|
||||
environment_scope: opts?.environment_scope ?? '*',
|
||||
},
|
||||
);
|
||||
}
|
||||
|
||||
public async updateProjectVariable(
|
||||
projectId: number | string,
|
||||
key: string,
|
||||
value: string,
|
||||
opts?: IVariableOptions,
|
||||
): Promise<IGitLabVariable> {
|
||||
const body: any = { value };
|
||||
if (opts?.protected !== undefined) body.protected = opts.protected;
|
||||
if (opts?.masked !== undefined) body.masked = opts.masked;
|
||||
if (opts?.environment_scope !== undefined) body.environment_scope = opts.environment_scope;
|
||||
return this.request<IGitLabVariable>(
|
||||
'PUT',
|
||||
`/api/v4/projects/${encodeURIComponent(projectId)}/variables/${encodeURIComponent(key)}`,
|
||||
body,
|
||||
);
|
||||
}
|
||||
|
||||
public async deleteProjectVariable(projectId: number | string, key: string): Promise<void> {
|
||||
await this.request(
|
||||
'DELETE',
|
||||
`/api/v4/projects/${encodeURIComponent(projectId)}/variables/${encodeURIComponent(key)}`,
|
||||
);
|
||||
}
|
||||
|
||||
// ---------------------------------------------------------------------------
|
||||
// Group Variables (CI/CD)
|
||||
// ---------------------------------------------------------------------------
|
||||
|
||||
public async getGroupVariables(groupId: number | string): Promise<IGitLabVariable[]> {
|
||||
return this.request<IGitLabVariable[]>(
|
||||
'GET',
|
||||
`/api/v4/groups/${encodeURIComponent(groupId)}/variables`,
|
||||
);
|
||||
}
|
||||
|
||||
public async createGroupVariable(
|
||||
groupId: number | string,
|
||||
key: string,
|
||||
value: string,
|
||||
opts?: IVariableOptions,
|
||||
): Promise<IGitLabVariable> {
|
||||
return this.request<IGitLabVariable>(
|
||||
'POST',
|
||||
`/api/v4/groups/${encodeURIComponent(groupId)}/variables`,
|
||||
{
|
||||
key,
|
||||
value,
|
||||
protected: opts?.protected ?? false,
|
||||
masked: opts?.masked ?? false,
|
||||
environment_scope: opts?.environment_scope ?? '*',
|
||||
},
|
||||
);
|
||||
}
|
||||
|
||||
public async updateGroupVariable(
|
||||
groupId: number | string,
|
||||
key: string,
|
||||
value: string,
|
||||
opts?: IVariableOptions,
|
||||
): Promise<IGitLabVariable> {
|
||||
const body: any = { value };
|
||||
if (opts?.protected !== undefined) body.protected = opts.protected;
|
||||
if (opts?.masked !== undefined) body.masked = opts.masked;
|
||||
if (opts?.environment_scope !== undefined) body.environment_scope = opts.environment_scope;
|
||||
return this.request<IGitLabVariable>(
|
||||
'PUT',
|
||||
`/api/v4/groups/${encodeURIComponent(groupId)}/variables/${encodeURIComponent(key)}`,
|
||||
body,
|
||||
);
|
||||
}
|
||||
|
||||
public async deleteGroupVariable(groupId: number | string, key: string): Promise<void> {
|
||||
await this.request(
|
||||
'DELETE',
|
||||
`/api/v4/groups/${encodeURIComponent(groupId)}/variables/${encodeURIComponent(key)}`,
|
||||
);
|
||||
}
|
||||
|
||||
// ---------------------------------------------------------------------------
|
||||
// Pipelines
|
||||
// ---------------------------------------------------------------------------
|
||||
|
||||
/**
|
||||
* List pipelines for a project with optional filters.
|
||||
* Supports status, ref, source, scope, username, date range, ordering.
|
||||
*/
|
||||
public async getPipelines(projectId: number | string, opts?: IPipelineListOptions): Promise<IGitLabPipeline[]> {
|
||||
const page = opts?.page || 1;
|
||||
const perPage = opts?.perPage || 30;
|
||||
const orderBy = opts?.orderBy || 'updated_at';
|
||||
const sort = opts?.sort || 'desc';
|
||||
let url = `/api/v4/projects/${encodeURIComponent(projectId)}/pipelines?page=${page}&per_page=${perPage}&order_by=${orderBy}&sort=${sort}`;
|
||||
if (opts?.status) url += `&status=${encodeURIComponent(opts.status)}`;
|
||||
if (opts?.ref) url += `&ref=${encodeURIComponent(opts.ref)}`;
|
||||
if (opts?.source) url += `&source=${encodeURIComponent(opts.source)}`;
|
||||
if (opts?.scope) url += `&scope=${encodeURIComponent(opts.scope)}`;
|
||||
if (opts?.username) url += `&username=${encodeURIComponent(opts.username)}`;
|
||||
if (opts?.updatedAfter) url += `&updated_after=${encodeURIComponent(opts.updatedAfter)}`;
|
||||
if (opts?.updatedBefore) url += `&updated_before=${encodeURIComponent(opts.updatedBefore)}`;
|
||||
return this.request<IGitLabPipeline[]>('GET', url);
|
||||
}
|
||||
|
||||
/**
|
||||
* Get a single pipeline's full details.
|
||||
*/
|
||||
public async getPipeline(projectId: number | string, pipelineId: number): Promise<IGitLabPipeline> {
|
||||
return this.request<IGitLabPipeline>(
|
||||
'GET',
|
||||
`/api/v4/projects/${encodeURIComponent(projectId)}/pipelines/${pipelineId}`,
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* Trigger a new pipeline on the given ref, optionally with variables.
|
||||
*/
|
||||
public async triggerPipeline(
|
||||
projectId: number | string,
|
||||
ref: string,
|
||||
variables?: { key: string; value: string; variable_type?: string }[],
|
||||
): Promise<IGitLabPipeline> {
|
||||
const body: any = { ref };
|
||||
if (variables && variables.length > 0) {
|
||||
body.variables = variables;
|
||||
}
|
||||
return this.request<IGitLabPipeline>(
|
||||
'POST',
|
||||
`/api/v4/projects/${encodeURIComponent(projectId)}/pipeline`,
|
||||
body,
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* Delete a pipeline and all its jobs.
|
||||
*/
|
||||
public async deletePipeline(projectId: number | string, pipelineId: number): Promise<void> {
|
||||
await this.request(
|
||||
'DELETE',
|
||||
`/api/v4/projects/${encodeURIComponent(projectId)}/pipelines/${pipelineId}`,
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* Get variables used in a specific pipeline run.
|
||||
*/
|
||||
public async getPipelineVariables(projectId: number | string, pipelineId: number): Promise<IGitLabPipelineVariable[]> {
|
||||
return this.request<IGitLabPipelineVariable[]>(
|
||||
'GET',
|
||||
`/api/v4/projects/${encodeURIComponent(projectId)}/pipelines/${pipelineId}/variables`,
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the test report for a pipeline.
|
||||
*/
|
||||
public async getPipelineTestReport(projectId: number | string, pipelineId: number): Promise<IGitLabTestReport> {
|
||||
return this.request<IGitLabTestReport>(
|
||||
'GET',
|
||||
`/api/v4/projects/${encodeURIComponent(projectId)}/pipelines/${pipelineId}/test_report`,
|
||||
);
|
||||
}
|
||||
|
||||
public async retryPipeline(projectId: number | string, pipelineId: number): Promise<IGitLabPipeline> {
|
||||
return this.request<IGitLabPipeline>(
|
||||
'POST',
|
||||
`/api/v4/projects/${encodeURIComponent(projectId)}/pipelines/${pipelineId}/retry`,
|
||||
);
|
||||
}
|
||||
|
||||
public async cancelPipeline(projectId: number | string, pipelineId: number): Promise<IGitLabPipeline> {
|
||||
return this.request<IGitLabPipeline>(
|
||||
'POST',
|
||||
`/api/v4/projects/${encodeURIComponent(projectId)}/pipelines/${pipelineId}/cancel`,
|
||||
);
|
||||
}
|
||||
|
||||
// ---------------------------------------------------------------------------
|
||||
// Jobs
|
||||
// ---------------------------------------------------------------------------
|
||||
|
||||
/**
|
||||
* List jobs for a pipeline with optional scope filter and pagination.
|
||||
*/
|
||||
public async getPipelineJobs(projectId: number | string, pipelineId: number, opts?: IJobListOptions): Promise<IGitLabJob[]> {
|
||||
const page = opts?.page || 1;
|
||||
const perPage = opts?.perPage || 100;
|
||||
let url = `/api/v4/projects/${encodeURIComponent(projectId)}/pipelines/${pipelineId}/jobs?page=${page}&per_page=${perPage}`;
|
||||
if (opts?.scope && opts.scope.length > 0) {
|
||||
for (const s of opts.scope) {
|
||||
url += `&scope[]=${encodeURIComponent(s)}`;
|
||||
}
|
||||
}
|
||||
return this.request<IGitLabJob[]>('GET', url);
|
||||
}
|
||||
|
||||
/**
|
||||
* Get a single job's full details.
|
||||
*/
|
||||
public async getJob(projectId: number | string, jobId: number): Promise<IGitLabJob> {
|
||||
return this.request<IGitLabJob>(
|
||||
'GET',
|
||||
`/api/v4/projects/${encodeURIComponent(projectId)}/jobs/${jobId}`,
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* Get a job's raw log (trace) output.
|
||||
*/
|
||||
public async getJobLog(projectId: number | string, jobId: number): Promise<string> {
|
||||
return this.requestText(
|
||||
'GET',
|
||||
`/api/v4/projects/${encodeURIComponent(projectId)}/jobs/${jobId}/trace`,
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* Retry a single job.
|
||||
*/
|
||||
public async retryJob(projectId: number | string, jobId: number): Promise<IGitLabJob> {
|
||||
return this.request<IGitLabJob>(
|
||||
'POST',
|
||||
`/api/v4/projects/${encodeURIComponent(projectId)}/jobs/${jobId}/retry`,
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* Cancel a running job.
|
||||
*/
|
||||
public async cancelJob(projectId: number | string, jobId: number): Promise<IGitLabJob> {
|
||||
return this.request<IGitLabJob>(
|
||||
'POST',
|
||||
`/api/v4/projects/${encodeURIComponent(projectId)}/jobs/${jobId}/cancel`,
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* Trigger a manual job (play action).
|
||||
*/
|
||||
public async playJob(projectId: number | string, jobId: number): Promise<IGitLabJob> {
|
||||
return this.request<IGitLabJob>(
|
||||
'POST',
|
||||
`/api/v4/projects/${encodeURIComponent(projectId)}/jobs/${jobId}/play`,
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* Erase a job's trace and artifacts.
|
||||
*/
|
||||
public async eraseJob(projectId: number | string, jobId: number): Promise<void> {
|
||||
await this.request(
|
||||
'POST',
|
||||
`/api/v4/projects/${encodeURIComponent(projectId)}/jobs/${jobId}/erase`,
|
||||
);
|
||||
}
|
||||
|
||||
// ---------------------------------------------------------------------------
|
||||
// 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)}`,
|
||||
);
|
||||
}
|
||||
}
|
||||
@@ -1,54 +0,0 @@
|
||||
import * as plugins from './gitlab.plugins';
|
||||
import { GitlabAccount } from './gitlab.classes.account';
|
||||
import { GitlabProject } from './gitlab.classes.project';
|
||||
|
||||
export interface IGitlabGroup {
|
||||
id: number;
|
||||
web_url: string;
|
||||
name: string;
|
||||
path: string;
|
||||
description: string;
|
||||
visibility: string;
|
||||
share_with_group_lock: string;
|
||||
require_two_factor_authentication: string;
|
||||
two_factor_grace_period: number;
|
||||
project_creation_level: string;
|
||||
auto_devops_enabled: null;
|
||||
subgroup_creation_level: string;
|
||||
emails_disabled: null;
|
||||
mentions_disabled: null;
|
||||
lfs_enabled: boolean;
|
||||
default_branch_protection: number;
|
||||
avatar_url: string;
|
||||
request_access_enabled: boolean;
|
||||
full_name: string;
|
||||
full_path: string;
|
||||
created_at: string;
|
||||
parent_id: null;
|
||||
ldap_cn: null;
|
||||
ldap_access: null;
|
||||
}
|
||||
|
||||
export class GitlabGroup {
|
||||
public static async getByName(nameArg: string, gitlabAccountArg: GitlabAccount) {
|
||||
const response = await gitlabAccountArg.request('GET', '/groups', {
|
||||
search: 'pushrocks',
|
||||
});
|
||||
// console.log(response);
|
||||
const returnGroup = new GitlabGroup(response[0], gitlabAccountArg);
|
||||
return returnGroup;
|
||||
}
|
||||
|
||||
// INSTANCE
|
||||
public gitlabAccountRef: GitlabAccount;
|
||||
public data: IGitlabGroup;
|
||||
|
||||
constructor(dataArg: IGitlabGroup, gitlabAccountArg: GitlabAccount) {
|
||||
this.gitlabAccountRef = gitlabAccountArg;
|
||||
this.data = dataArg;
|
||||
}
|
||||
|
||||
public async getProjects() {
|
||||
return GitlabProject.getProjectsForGroup(this);
|
||||
}
|
||||
}
|
||||
@@ -1,151 +0,0 @@
|
||||
import { GitlabGroup } from './gitlab.classes.group';
|
||||
import * as plugins from './gitlab.plugins';
|
||||
|
||||
export interface IGitlabData {
|
||||
id: number;
|
||||
description: string;
|
||||
name: string;
|
||||
name_with_namespace: string;
|
||||
path: string;
|
||||
path_with_namespace: string;
|
||||
created_at: string;
|
||||
default_branch: string;
|
||||
tag_list: string[];
|
||||
ssh_url_to_repo: string;
|
||||
http_url_to_repo: string;
|
||||
web_url: string;
|
||||
readme_url: string;
|
||||
avatar_url: null;
|
||||
forks_count: number;
|
||||
star_count: number;
|
||||
last_activity_at: string;
|
||||
namespace: {
|
||||
id: number;
|
||||
name: string;
|
||||
path: string;
|
||||
kind: string;
|
||||
full_path: string;
|
||||
parent_id: null;
|
||||
avatar_url: string;
|
||||
web_url: string;
|
||||
};
|
||||
container_registry_image_prefix: string;
|
||||
_links: {
|
||||
self: string;
|
||||
issues: string;
|
||||
merge_requests: string;
|
||||
repo_branches: string;
|
||||
labels: string;
|
||||
events: string;
|
||||
members: string;
|
||||
};
|
||||
packages_enabled: null;
|
||||
empty_repo: boolean;
|
||||
archived: boolean;
|
||||
visibility: 'public' | 'private';
|
||||
resolve_outdated_diff_discussions: null;
|
||||
container_registry_enabled: boolean;
|
||||
issues_enabled: boolean;
|
||||
merge_requests_enabled: boolean;
|
||||
wiki_enabled: boolean;
|
||||
jobs_enabled: boolean;
|
||||
snippets_enabled: boolean;
|
||||
service_desk_enabled: null;
|
||||
service_desk_address: null;
|
||||
can_create_merge_request_in: boolean;
|
||||
issues_access_level: 'enabled' | 'disabled';
|
||||
repository_access_level: 'enabled' | 'disabled';
|
||||
merge_requests_access_level: 'enabled' | 'disabled';
|
||||
forking_access_level: 'enabled' | 'disabled';
|
||||
wiki_access_level: 'enabled' | 'disabled';
|
||||
builds_access_level: 'enabled' | 'disabled';
|
||||
snippets_access_level: 'enabled' | 'disabled';
|
||||
pages_access_level: 'enabled' | 'disabled';
|
||||
operations_access_level: 'enabled' | 'disabled';
|
||||
analytics_access_level: 'enabled' | 'disabled';
|
||||
emails_disabled: null;
|
||||
shared_runners_enabled: boolean;
|
||||
lfs_enabled: boolean;
|
||||
creator_id: number;
|
||||
import_status: 'none';
|
||||
open_issues_count: number;
|
||||
ci_default_git_depth: null;
|
||||
ci_forward_deployment_enabled: null;
|
||||
public_jobs: boolean;
|
||||
build_timeout: number;
|
||||
auto_cancel_pending_pipelines: 'enabled' | 'disabled';
|
||||
build_coverage_regex: '';
|
||||
ci_config_path: '';
|
||||
shared_with_groups: [];
|
||||
only_allow_merge_if_pipeline_succeeds: boolean;
|
||||
allow_merge_on_skipped_pipeline: null;
|
||||
restrict_user_defined_variables: boolean;
|
||||
request_access_enabled: boolean;
|
||||
only_allow_merge_if_all_discussions_are_resolved: boolean;
|
||||
remove_source_branch_after_merge: null;
|
||||
printing_merge_request_link_enabled: boolean;
|
||||
merge_method: 'merge';
|
||||
suggestion_commit_message: null;
|
||||
auto_devops_enabled: boolean;
|
||||
auto_devops_deploy_strategy: 'continuous';
|
||||
autoclose_referenced_issues: boolean;
|
||||
approvals_before_merge: number;
|
||||
mirror: boolean;
|
||||
external_authorization_classification_label: '';
|
||||
marked_for_deletion_at: null;
|
||||
marked_for_deletion_on: null;
|
||||
requirements_enabled: boolean;
|
||||
security_and_compliance_enabled: null;
|
||||
compliance_frameworks: [];
|
||||
issues_template: '';
|
||||
merge_requests_template: '';
|
||||
}
|
||||
|
||||
export class GitlabProject {
|
||||
// STATIC
|
||||
public static async getProjectsForGroup(gitlabGroupArg: GitlabGroup): Promise<GitlabProject[]> {
|
||||
const response = await gitlabGroupArg.gitlabAccountRef.request(
|
||||
'GET',
|
||||
`/groups/${gitlabGroupArg.data.id}/projects`,
|
||||
{
|
||||
per_page: '100',
|
||||
}
|
||||
);
|
||||
const allProjects: GitlabProject[] = [];
|
||||
for (const projectData of response) {
|
||||
allProjects.push(new GitlabProject(projectData, gitlabGroupArg));
|
||||
}
|
||||
return allProjects;
|
||||
}
|
||||
|
||||
// INSTANCE
|
||||
gitlabGroupRef: GitlabGroup;
|
||||
data: IGitlabData;
|
||||
|
||||
constructor(dataArg: IGitlabData, gitlabGroupRefArg: GitlabGroup) {
|
||||
this.data = dataArg;
|
||||
this.gitlabGroupRef = gitlabGroupRefArg;
|
||||
}
|
||||
|
||||
public async getFileFromProject(
|
||||
filePathArg: string,
|
||||
refArg: string
|
||||
): Promise<plugins.smartfile.Smartfile> {
|
||||
const response = await this.gitlabGroupRef.gitlabAccountRef.request(
|
||||
'GET',
|
||||
`/projects/${this.data.id}/repository/files/${filePathArg}`,
|
||||
{
|
||||
ref: refArg,
|
||||
}
|
||||
);
|
||||
return plugins.smartfile.Smartfile.fromBuffer(
|
||||
filePathArg,
|
||||
Buffer.from(response.content, response.encoding)
|
||||
);
|
||||
}
|
||||
|
||||
public async getReadmeAsMarkdown(refArg: string = 'master'): Promise<string> {
|
||||
const readmeFile = await this.getFileFromProject('readme.md', refArg);
|
||||
return readmeFile.contents.toString('utf8');
|
||||
}
|
||||
}
|
||||
247
ts/gitlab.interfaces.ts
Normal file
247
ts/gitlab.interfaces.ts
Normal file
@@ -0,0 +1,247 @@
|
||||
// ---------------------------------------------------------------------------
|
||||
// Common
|
||||
// ---------------------------------------------------------------------------
|
||||
|
||||
export interface ITestConnectionResult {
|
||||
ok: boolean;
|
||||
error?: string;
|
||||
}
|
||||
|
||||
export interface IListOptions {
|
||||
search?: string;
|
||||
page?: number;
|
||||
perPage?: number;
|
||||
}
|
||||
|
||||
// ---------------------------------------------------------------------------
|
||||
// Pipeline / Job list options
|
||||
// ---------------------------------------------------------------------------
|
||||
|
||||
export interface IPipelineListOptions extends IListOptions {
|
||||
/** Filter by pipeline status */
|
||||
status?: string;
|
||||
/** Filter by branch or tag ref */
|
||||
ref?: string;
|
||||
/** Filter by trigger source (push, web, trigger, schedule, api, external, pipeline, chat, merge_request_event, …) */
|
||||
source?: string;
|
||||
/** Filter by scope (running, pending, finished, branches, tags) */
|
||||
scope?: string;
|
||||
/** Filter by the user who triggered the pipeline */
|
||||
username?: string;
|
||||
/** Return pipelines updated after this ISO 8601 date */
|
||||
updatedAfter?: string;
|
||||
/** Return pipelines updated before this ISO 8601 date */
|
||||
updatedBefore?: string;
|
||||
/** Order by field (id, status, ref, updated_at, user_id). Default: id */
|
||||
orderBy?: string;
|
||||
/** Sort direction (asc, desc). Default: desc */
|
||||
sort?: string;
|
||||
}
|
||||
|
||||
export interface IJobListOptions extends IListOptions {
|
||||
/** Filter by job scope(s) */
|
||||
scope?: string[];
|
||||
}
|
||||
|
||||
// ---------------------------------------------------------------------------
|
||||
// Users
|
||||
// ---------------------------------------------------------------------------
|
||||
|
||||
export interface IGitLabUser {
|
||||
id: number;
|
||||
username: string;
|
||||
name: string;
|
||||
email: string;
|
||||
avatar_url: string;
|
||||
web_url: string;
|
||||
state: string;
|
||||
}
|
||||
|
||||
// ---------------------------------------------------------------------------
|
||||
// Projects
|
||||
// ---------------------------------------------------------------------------
|
||||
|
||||
export interface IGitLabProject {
|
||||
id: number;
|
||||
name: string;
|
||||
path_with_namespace: string;
|
||||
description: string;
|
||||
default_branch: string;
|
||||
web_url: string;
|
||||
visibility: string;
|
||||
topics: string[];
|
||||
last_activity_at: string;
|
||||
}
|
||||
|
||||
// ---------------------------------------------------------------------------
|
||||
// Groups
|
||||
// ---------------------------------------------------------------------------
|
||||
|
||||
export interface IGitLabGroup {
|
||||
id: number;
|
||||
name: string;
|
||||
full_path: string;
|
||||
description: string;
|
||||
web_url: string;
|
||||
visibility: string;
|
||||
}
|
||||
|
||||
// ---------------------------------------------------------------------------
|
||||
// Variables
|
||||
// ---------------------------------------------------------------------------
|
||||
|
||||
export interface IGitLabVariable {
|
||||
key: string;
|
||||
value: string;
|
||||
variable_type: string;
|
||||
protected: boolean;
|
||||
masked: boolean;
|
||||
environment_scope: string;
|
||||
}
|
||||
|
||||
export interface IVariableOptions {
|
||||
protected?: boolean;
|
||||
masked?: boolean;
|
||||
environment_scope?: string;
|
||||
}
|
||||
|
||||
// ---------------------------------------------------------------------------
|
||||
// Protected Branches
|
||||
// ---------------------------------------------------------------------------
|
||||
|
||||
export interface IGitLabProtectedBranch {
|
||||
id: number;
|
||||
name: string;
|
||||
allow_force_push: boolean;
|
||||
}
|
||||
|
||||
// ---------------------------------------------------------------------------
|
||||
// Pipelines
|
||||
// ---------------------------------------------------------------------------
|
||||
|
||||
export interface IGitLabPipeline {
|
||||
id: number;
|
||||
iid: number;
|
||||
project_id: number;
|
||||
status: string;
|
||||
ref: string;
|
||||
sha: string;
|
||||
before_sha: string;
|
||||
tag: boolean;
|
||||
web_url: string;
|
||||
duration: number;
|
||||
queued_duration: number;
|
||||
created_at: string;
|
||||
updated_at: string;
|
||||
started_at: string;
|
||||
finished_at: string;
|
||||
source: string;
|
||||
coverage: string;
|
||||
user: IGitLabUser;
|
||||
detailed_status: {
|
||||
icon: string;
|
||||
text: string;
|
||||
label: string;
|
||||
group: string;
|
||||
tooltip: string;
|
||||
has_details: boolean;
|
||||
details_path: string;
|
||||
favicon: string;
|
||||
};
|
||||
yaml_errors: string;
|
||||
}
|
||||
|
||||
export interface IGitLabPipelineVariable {
|
||||
key: string;
|
||||
value: string;
|
||||
variable_type: string;
|
||||
}
|
||||
|
||||
export interface IGitLabTestReport {
|
||||
total_time: number;
|
||||
total_count: number;
|
||||
success_count: number;
|
||||
failed_count: number;
|
||||
skipped_count: number;
|
||||
error_count: number;
|
||||
test_suites: IGitLabTestSuite[];
|
||||
}
|
||||
|
||||
export interface IGitLabTestSuite {
|
||||
name: string;
|
||||
total_time: number;
|
||||
total_count: number;
|
||||
success_count: number;
|
||||
failed_count: number;
|
||||
skipped_count: number;
|
||||
error_count: number;
|
||||
test_cases: IGitLabTestCase[];
|
||||
}
|
||||
|
||||
export interface IGitLabTestCase {
|
||||
status: string;
|
||||
name: string;
|
||||
classname: string;
|
||||
execution_time: number;
|
||||
system_output: string;
|
||||
stack_trace: string;
|
||||
}
|
||||
|
||||
// ---------------------------------------------------------------------------
|
||||
// Jobs
|
||||
// ---------------------------------------------------------------------------
|
||||
|
||||
export interface IGitLabJob {
|
||||
id: number;
|
||||
name: string;
|
||||
stage: string;
|
||||
status: string;
|
||||
ref: string;
|
||||
tag: boolean;
|
||||
web_url: string;
|
||||
created_at: string;
|
||||
started_at: string;
|
||||
finished_at: string;
|
||||
duration: number;
|
||||
queued_duration: number;
|
||||
coverage: number;
|
||||
allow_failure: boolean;
|
||||
failure_reason: string;
|
||||
pipeline: {
|
||||
id: number;
|
||||
project_id: number;
|
||||
ref: string;
|
||||
sha: string;
|
||||
status: string;
|
||||
};
|
||||
user: IGitLabUser;
|
||||
runner: {
|
||||
id: number;
|
||||
description: string;
|
||||
active: boolean;
|
||||
is_shared: boolean;
|
||||
};
|
||||
artifacts: {
|
||||
filename: string;
|
||||
size: number;
|
||||
}[];
|
||||
artifacts_expire_at: string;
|
||||
}
|
||||
|
||||
// ---------------------------------------------------------------------------
|
||||
// Branches & Tags
|
||||
// ---------------------------------------------------------------------------
|
||||
|
||||
export interface IGitLabBranch {
|
||||
name: string;
|
||||
commit: {
|
||||
id: string;
|
||||
};
|
||||
}
|
||||
|
||||
export interface IGitLabTag {
|
||||
name: string;
|
||||
commit: {
|
||||
id: string;
|
||||
};
|
||||
}
|
||||
3
ts/gitlab.logging.ts
Normal file
3
ts/gitlab.logging.ts
Normal file
@@ -0,0 +1,3 @@
|
||||
import * as plugins from './gitlab.plugins.js';
|
||||
|
||||
export const logger = new plugins.smartlog.ConsoleLog();
|
||||
@@ -1,6 +1,4 @@
|
||||
// pushrocks scope
|
||||
import * as smartfile from '@pushrocks/smartfile';
|
||||
import * as smartrequest from '@pushrocks/smartrequest';
|
||||
import * as smarturl from '@pushrocks/smarturl';
|
||||
import * as smartlog from '@push.rocks/smartlog';
|
||||
import * as smartrequest from '@push.rocks/smartrequest';
|
||||
|
||||
export { smartfile, smartrequest, smarturl };
|
||||
export { smartlog, smartrequest };
|
||||
|
||||
24
ts/index.ts
24
ts/index.ts
@@ -1,2 +1,22 @@
|
||||
export * from './gitlab.classes.group';
|
||||
export * from './gitlab.classes.account';
|
||||
export { GitLabClient } from './gitlab.classes.gitlabclient.js';
|
||||
export type {
|
||||
IGitLabUser,
|
||||
IGitLabProject,
|
||||
IGitLabGroup,
|
||||
IGitLabVariable,
|
||||
IGitLabProtectedBranch,
|
||||
IGitLabBranch,
|
||||
IGitLabTag,
|
||||
IVariableOptions,
|
||||
IGitLabPipeline,
|
||||
IGitLabPipelineVariable,
|
||||
IGitLabTestReport,
|
||||
IGitLabTestSuite,
|
||||
IGitLabTestCase,
|
||||
IGitLabJob,
|
||||
ITestConnectionResult,
|
||||
IListOptions,
|
||||
IPipelineListOptions,
|
||||
IJobListOptions,
|
||||
} from './gitlab.interfaces.js';
|
||||
export { commitinfo } from './00_commitinfo_data.js';
|
||||
|
||||
16
tsconfig.json
Normal file
16
tsconfig.json
Normal file
@@ -0,0 +1,16 @@
|
||||
{
|
||||
"compilerOptions": {
|
||||
"experimentalDecorators": true,
|
||||
"useDefineForClassFields": false,
|
||||
"target": "ES2022",
|
||||
"module": "NodeNext",
|
||||
"moduleResolution": "NodeNext",
|
||||
"esModuleInterop": true,
|
||||
"verbatimModuleSyntax": true,
|
||||
"baseUrl": ".",
|
||||
"paths": {}
|
||||
},
|
||||
"exclude": [
|
||||
"dist_*/**/*.d.ts"
|
||||
]
|
||||
}
|
||||
17
tslint.json
17
tslint.json
@@ -1,17 +0,0 @@
|
||||
{
|
||||
"extends": ["tslint:latest", "tslint-config-prettier"],
|
||||
"rules": {
|
||||
"semicolon": [true, "always"],
|
||||
"no-console": false,
|
||||
"ordered-imports": false,
|
||||
"object-literal-sort-keys": false,
|
||||
"member-ordering": {
|
||||
"options":{
|
||||
"order": [
|
||||
"static-method"
|
||||
]
|
||||
}
|
||||
}
|
||||
},
|
||||
"defaultSeverity": "warning"
|
||||
}
|
||||
Reference in New Issue
Block a user