Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/hexenq/nest-gitlab
A Gitlab API library module for Nest framework.
https://github.com/hexenq/nest-gitlab
api gitbeaker gitlab nest nestjs node-gitlab
Last synced: 2 months ago
JSON representation
A Gitlab API library module for Nest framework.
- Host: GitHub
- URL: https://github.com/hexenq/nest-gitlab
- Owner: hexenq
- License: mit
- Created: 2019-06-24T06:39:07.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2022-12-10T20:01:38.000Z (about 2 years ago)
- Last Synced: 2024-10-01T15:07:58.699Z (3 months ago)
- Topics: api, gitbeaker, gitlab, nest, nestjs, node-gitlab
- Language: TypeScript
- Homepage:
- Size: 416 KB
- Stars: 9
- Watchers: 0
- Forks: 8
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
A gitbeaker wrapper for NestJS framework.
## Description
Gitlab API library module for Nest.
## Installation
```bash
npm install --save nest-gitlab @gitbeaker/node
```
## Compatibility
| gitbeaker | nest-gitlab |
| :----------------------------: | :---------: |
| node-gitlab (former gitbeaker) | 1.x |
| 19.0.0 ~ 23.5.0 | 2.x |
| 23.6.0 ~ | 3.x |
## Quick Start
Import `GitlabModule` and configure it with the same initiating options as the gitbeaker package.
```ts
import { GitlabModule } from 'nest-gitlab';
@Module({
imports: [
GitlabModule.forRoot({
// options
}),
],
})
export class AppModule {}
```
Afterward, the gitlab instance will be ready to be injected across the entire project using the `gitlab` injection token.
```ts
import { Controller, Inject } from '@nestjs/common';
import { GitlabInstance } from 'nest-gitlab';
@Controller('cats')
export class CatsController {
constructor(@Inject('gitlab') private readonly gitlab: GitlabInstance) { }
}
```
You could also use the `InjectGitlabInstance` decorator to inject gitlab instance.
```ts
import { Controller, Inject } from '@nestjs/common';
import { GitlabInstance, InjectGitlabInstance } from 'nest-gitlab';
@Controller('cats')
export class CatsController {
constructor(@InjectGitlabInstance() private readonly gitlab: GitlabInstance) { }
@Get('/projects')
public async getProjects() {
return await this.gitlab.Projects.all();
}
}
```
## Async Configuration
You might want to asynchronously pass your module options. In such case, use the `forRootAsync()` method. The option object could be returned by `useFactory` method:
```ts
import { Module } from '@nestjs/common';
import { GitlabModule } from 'nest-gitlab';
@Module({
imports: [
GitlabModule.forRootAsync({
imports: [ConfigModule],
useFactory: async (config: ConfigService) => {
// return options
},
inject: [ConfigService],
}),
],
})
export class AppModule {}
```
## Bundle Support
gitbeaker provides [bundle](https://github.com/jdalrymple/gitbeaker#bundle-imports) feature which is a export for importing and instantiating all related API's of a specific resource at once. In order to use this feature, you could use the `InjectBundleRef` decorator combined with `forFeature` method:
```ts
import { GitlabModule } from 'nest-gitlab';
@Module({
imports: [
GitlabModule.forRoot({
// options
}),
],
})
export class AppModule {}
```
```ts
import { Module } from '@nestjs/common';
import { BundleType, GitlabModule } from 'nest-gitlab';
@Module({
imports: [
GitlabModule.forFeature([BundleType.Projects]),
],
controllers: [CatsController],
providers: [CatsService],
})
export class CatsModule {}
```
`BundleType` could be `Projects`, `Users`, or `Groups`.
```ts
import { Controller, Inject } from '@nestjs/common';
import { BundleType, GitlabInstance, InjectBundleRef, ProjectsBundleRef } from 'nest-gitlab';
@Controller('cats')
export class CatsController {
constructor(@InjectBundleRef(BundleType.Projects) private readonly pbr: ProjectsBundleRef) { }
@Get('/projects')
public async getProjects() {
return await this.pbr.Projects.all();
}
}
```
## Multiple GitLab Instances
In some cases, your projects may require multiple GitLab instances. This can be achieved by naming the gitlab instances:
```ts
import { Module } from '@nestjs/common';
import { GitlabModule } from 'nest-gitlab';
@Module({
imports: [
GitlabModule.forRootAsync({
name: 'ins1',
imports: [ConfigModule],
useFactory: async (config: ConfigService) => {
// return options
},
inject: [ConfigService],
}),
GitlabModule.forRoot({
name: 'ins2',
// options
}),
],
})
export class AppModule {}
```
```ts
import { Module } from '@nestjs/common';
import { BundleType, GitlabModule } from 'nest-gitlab';
@Module({
imports: [
GitlabModule.forFeature([BundleType.Projects], 'ins1'),
],
controllers: [CatsController],
providers: [CatsService],
})
export class CatsModule {}
```
```ts
import { Controller, Inject } from '@nestjs/common';
import { BundleType, GitlabInstance, InjectBundleRef, InjectGitlabInstance, ProjectsBundleRef } from 'nest-gitlab';
@Controller('cats')
export class CatsController {
constructor(@InjectBundleRef(BundleType.Projects, 'ins1') private readonly pbr1: ProjectsBundleRef,
@InjectGitlabInstance('ins2') private readonly gitlab2: GitlabInstance) { }
}
```
## License
MIT