📈 Open source, privacy-first web analytics — a cookie-less Google Analytics alternative with built-in error tracking and performance monitoring. Self-host it or use our cloud. Get started for free!
TypeScript chartsclickhousedockergdprgoogle-analyticsmetricsmonitoringmysqlnestjsprivacyredisself-hostedselfhostedstatisticstailwindcssweb-analyticswebanalyticswebsite
(improvement) Swagger ApiBearerAuth auth decorator (#208)
Yehor Dremliuha8f60ea56e5ee
diff --git a/apps/production/src/alert/alert.controller.ts b/apps/production/src/alert/alert.controller.tsindex 925514286..718b27aaa 100644--- a/apps/production/src/alert/alert.controller.ts+++ b/apps/production/src/alert/alert.controller.ts@@ -15,7 +15,7 @@ import {HttpStatus,} from '@nestjs/common'import { In } from 'typeorm'-import { ApiTags, ApiResponse } from '@nestjs/swagger'+import { ApiTags, ApiResponse, ApiBearerAuth } from '@nestjs/swagger'import * as _isEmpty from 'lodash/isEmpty'import * as _map from 'lodash/map'import * as _omit from 'lodash/omit'@@ -45,6 +45,7 @@ export class AlertController {private readonly userService: UserService,) {}+ @ApiBearerAuth()@Get('/')@UseGuards(JwtAccessTokenGuard, RolesGuard)@Roles(UserType.ADMIN, UserType.CUSTOMER)@@ -78,6 +79,7 @@ export class AlertController {return result}+ @ApiBearerAuth()@Post('/')@UseGuards(JwtAccessTokenGuard, RolesGuard)@Roles(UserType.ADMIN, UserType.CUSTOMER)@@ -154,6 +156,7 @@ export class AlertController {}}+ @ApiBearerAuth()@Put('/:id')@UseGuards(JwtAccessTokenGuard, RolesGuard)@Roles(UserType.ADMIN, UserType.CUSTOMER)@@ -203,7 +206,8 @@ export class AlertController {pid: alert.project.id,}}-++ @ApiBearerAuth()@Delete('/:id')@UseGuards(JwtAccessTokenGuard, RolesGuard)@Roles(UserType.ADMIN, UserType.CUSTOMER)diff --git a/apps/production/src/auth/auth.controller.ts b/apps/production/src/auth/auth.controller.tsindex 06a27811a..68c7fd1eb 100644--- a/apps/production/src/auth/auth.controller.ts+++ b/apps/production/src/auth/auth.controller.ts@@ -22,6 +22,7 @@ import {ApiOperation,ApiCreatedResponse,ApiOkResponse,+ ApiBearerAuth,} from '@nestjs/swagger'import { I18nValidationExceptionFilter, I18n, I18nContext } from 'nestjs-i18n'import * as _pick from 'lodash/pick'@@ -236,6 +237,7 @@ export class AuthController {await this.authService.resetPassword(actionToken, body.newPassword)}+ @ApiBearerAuth()@ApiOperation({ summary: 'Change a password' })@ApiOkResponse({description: 'Password changed',@@ -266,6 +268,7 @@ export class AuthController {await this.authService.changePassword(user.id, body.newPassword)}+ @ApiBearerAuth()@ApiOperation({ summary: 'Request a resend of the verification email' })@ApiOkResponse({description: 'Resend of the verification email requested',@@ -297,6 +300,7 @@ export class AuthController {await this.authService.sendVerificationEmail(user.id, user.email)}+ @ApiBearerAuth()@ApiOperation({ summary: 'Change a user email' })@ApiOkResponse({description: 'User email changed',@@ -503,6 +507,7 @@ export class AuthController {)}+ @ApiBearerAuth()@ApiOperation({ summary: 'Link SSO provider to an existing account' })@ApiOkResponse({description: 'SSO provider linked to an existing account',@@ -519,6 +524,7 @@ export class AuthController {await this.authService.linkSSOAccount(userId, hash, provider)}+ @ApiBearerAuth()@ApiOperation({ summary: 'Unlink SSO provider from an existing account' })@ApiOkResponse({description: 'SSO provider unlinked from an existing account',diff --git a/apps/production/src/main.ts b/apps/production/src/main.tsindex 99588f89c..b1f28e89a 100644--- a/apps/production/src/main.ts+++ b/apps/production/src/main.ts@@ -42,6 +42,7 @@ async function bootstrap() {.setTitle('Swetrix API').setDescription('Swetrix Analytics & Marketplace API').setVersion(process.env.npm_package_version)+ .addBearerAuth().build()const document = SwaggerModule.createDocument(app, config)SwaggerModule.setup('api', app, document)diff --git a/apps/production/src/marketplace/categories/categories.controller.ts b/apps/production/src/marketplace/categories/categories.controller.tsindex 4ce08428d..8f7c33350 100644--- a/apps/production/src/marketplace/categories/categories.controller.ts+++ b/apps/production/src/marketplace/categories/categories.controller.ts@@ -13,7 +13,7 @@ import {UsePipes,ValidationPipe,} from '@nestjs/common'-import { ApiParam, ApiQuery, ApiTags } from '@nestjs/swagger'+import { ApiBearerAuth, ApiParam, ApiQuery, ApiTags } from '@nestjs/swagger'import { JwtAccessTokenGuard } from 'src/auth/guards'import { Roles } from '../../auth/decorators/roles.decorator'import { RolesGuard } from '../../auth/guards/roles.guard'@@ -91,6 +91,7 @@ export class CategoriesController {return category}+ @ApiBearerAuth()@UseGuards(JwtAccessTokenGuard, RolesGuard)@Roles(UserType.ADMIN)@Post()@@ -108,6 +109,7 @@ export class CategoriesController {return this.categoriesService.save(categoryInstance)}+ @ApiBearerAuth()@ApiParam({name: 'categoryId',description: 'Category ID',@@ -140,6 +142,7 @@ export class CategoriesController {return body}+ @ApiBearerAuth()@ApiParam({name: 'categoryId',description: 'Category ID',diff --git a/apps/production/src/marketplace/complaints/complaints.controller.ts b/apps/production/src/marketplace/complaints/complaints.controller.tsindex e910d9f45..56f8c8d09 100644--- a/apps/production/src/marketplace/complaints/complaints.controller.ts+++ b/apps/production/src/marketplace/complaints/complaints.controller.ts@@ -8,7 +8,7 @@ import {UseGuards,Query,} from '@nestjs/common'-import { ApiParam, ApiQuery, ApiTags } from '@nestjs/swagger'+import { ApiBearerAuth, ApiParam, ApiQuery, ApiTags } from '@nestjs/swagger'import { UserType } from 'src/user/entities/user.entity'import { RolesGuard } from 'src/auth/guards/roles.guard'import { Roles } from 'src/auth/decorators/roles.decorator'@@ -33,6 +33,7 @@ export class ComplaintsController {private readonly extensionsService: ExtensionsService,) {}+ @ApiBearerAuth()@Get()@ApiQuery({ name: 'offset', required: false, type: String })@ApiQuery({ name: 'limit', required: false, type: String })@@ -56,6 +57,7 @@ export class ComplaintsController {return { complaints, count }}+ @ApiBearerAuth()@Get(':complaintId')@ApiParam({ name: 'complaintId', required: true, type: String })@UseGuards(JwtAccessTokenGuard, RolesGuard)@@ -101,6 +103,7 @@ export class ComplaintsController {})}+ @ApiBearerAuth()@Post(':complaintId/resolve')@ApiParam({ name: 'complaintId', required: true, type: String })@UseGuards(JwtAccessTokenGuard, RolesGuard)diff --git a/apps/production/src/marketplace/extensions/extensions.controller.ts b/apps/production/src/marketplace/extensions/extensions.controller.tsindex a08f45607..461129778 100644--- a/apps/production/src/marketplace/extensions/extensions.controller.ts+++ b/apps/production/src/marketplace/extensions/extensions.controller.ts@@ -15,7 +15,7 @@ import {UsePipes,ValidationPipe,} from '@nestjs/common'-import { ApiParam, ApiQuery, ApiTags } from '@nestjs/swagger'+import { ApiBearerAuth, ApiParam, ApiQuery, ApiTags } from '@nestjs/swagger'import { FormDataRequest } from 'nestjs-form-data'import { Like } from 'typeorm'import * as _map from 'lodash/map'@@ -339,6 +339,8 @@ export class ExtensionsController {required: false,type: String,})++ @ApiBearerAuth()@Roles(UserType.ADMIN)@UseGuards(JwtAccessTokenGuard, RolesGuard)@Get('admin/search')@@ -461,6 +463,7 @@ export class ExtensionsController {)}+ @ApiBearerAuth()@ApiParam({name: 'extensionId',description: 'Extension ID',@@ -488,6 +491,7 @@ export class ExtensionsController {return this.extensionsService.save(extension)}+ @ApiBearerAuth()@ApiParam({name: 'extensionId',description: 'Extension ID',diff --git a/apps/production/src/project/project.controller.ts b/apps/production/src/project/project.controller.tsindex a57c7228b..3c305f30a 100644--- a/apps/production/src/project/project.controller.ts+++ b/apps/production/src/project/project.controller.ts@@ -22,7 +22,7 @@ import {UnauthorizedException,} from '@nestjs/common'import { Response } from 'express'-import { ApiTags, ApiQuery, ApiResponse } from '@nestjs/swagger'+import { ApiTags, ApiQuery, ApiResponse, ApiBearerAuth } from '@nestjs/swagger'import { ILike } from 'typeorm'import * as _isEmpty from 'lodash/isEmpty'import * as _map from 'lodash/map'@@ -254,6 +254,7 @@ export class ProjectController {return this.projectService.paginate({ take, skip }, where)}+ @ApiBearerAuth()@Get('/user/:id')@ApiQuery({ name: 'take', required: false })@ApiQuery({ name: 'skip', required: false })@@ -280,6 +281,7 @@ export class ProjectController {}}+ @ApiBearerAuth()@Post('/admin/:id')@ApiResponse({ status: 201, type: Project })@UseGuards(JwtAccessTokenGuard, RolesGuard)@@ -627,6 +629,7 @@ export class ProjectController {return this.projectService.getFunnels(project.id)}+ @ApiBearerAuth()@Delete('/reset/:id')@HttpCode(204)@UseGuards(JwtAccessTokenGuard, RolesGuard)@@ -671,6 +674,7 @@ export class ProjectController {}}+ @ApiBearerAuth()@Delete('/captcha/reset/:id')@HttpCode(204)@UseGuards(JwtAccessTokenGuard, RolesGuard)@@ -713,6 +717,7 @@ export class ProjectController {}}+ @ApiBearerAuth()@Post('/secret-gen/:pid')@HttpCode(200)@UseGuards(JwtAccessTokenGuard, RolesGuard)@@ -751,6 +756,7 @@ export class ProjectController {return secret}+ @ApiBearerAuth()@Delete('/captcha/:id')@HttpCode(204)@UseGuards(JwtAccessTokenGuard, RolesGuard)@@ -893,6 +899,7 @@ export class ProjectController {await this.projectService.deleteByFilters(pid, type, filters)}+ @ApiBearerAuth()@Post('/:pid/share')@HttpCode(200)@UseGuards(JwtAccessTokenGuard, RolesGuard)@@ -1015,6 +1022,7 @@ export class ProjectController {}}+ @ApiBearerAuth()@Put('/share/:shareId')@HttpCode(200)@UseGuards(JwtAccessTokenGuard, RolesGuard)@@ -1055,6 +1063,7 @@ export class ProjectController {return this.projectService.findOneShare(shareId)}+ @ApiBearerAuth()@HttpCode(204)// @UseGuards(JwtAccessTokenGuard, RolesGuard)// @Roles(UserType.CUSTOMER, UserType.ADMIN)@@ -1456,6 +1465,7 @@ export class ProjectController {return 'Project deleted successfully'}+ @ApiBearerAuth()@Put('captcha/inherited/:id')@HttpCode(200)@UseGuards(JwtAccessTokenGuard, RolesGuard)@@ -1647,6 +1657,7 @@ export class ProjectController {}// The routes related to sharing projects feature+ @ApiBearerAuth()@Delete('/:pid/:shareId')@HttpCode(204)@UseGuards(JwtAccessTokenGuard, RolesGuard)diff --git a/apps/production/src/twoFactorAuth/twoFactorAuth.controller.ts b/apps/production/src/twoFactorAuth/twoFactorAuth.controller.tsindex 2d677f952..c8847f14f 100644--- a/apps/production/src/twoFactorAuth/twoFactorAuth.controller.ts+++ b/apps/production/src/twoFactorAuth/twoFactorAuth.controller.ts@@ -8,7 +8,7 @@ import {Headers,Ip,} from '@nestjs/common'-import { ApiTags } from '@nestjs/swagger'+import { ApiBearerAuth, ApiTags } from '@nestjs/swagger'import { JwtAccessTokenGuard } from '../auth/guards'import { TwoFactorAuthService } from './twoFactorAuth.service'@@ -38,6 +38,7 @@ export class TwoFactorAuthController {private readonly mailerService: MailerService,) {}+ @ApiBearerAuth()@Post('generate')@UseGuards(JwtAccessTokenGuard, RolesGuard)@Roles(UserType.CUSTOMER, UserType.ADMIN)@@ -48,6 +49,7 @@ export class TwoFactorAuthController {return this.twoFactorAuthService.generateTwoFactorAuthenticationSecret(user)}+ @ApiBearerAuth()@Post('enable')@UseGuards(JwtAccessTokenGuard, RolesGuard)@Roles(UserType.CUSTOMER, UserType.ADMIN)@@ -95,6 +97,7 @@ export class TwoFactorAuthController {}}+ @ApiBearerAuth()@Post('disable')@HttpCode(200)@UseGuards(JwtAccessTokenGuard, RolesGuard)@@ -133,6 +136,7 @@ export class TwoFactorAuthController {})}+ @ApiBearerAuth()@Post('authenticate')@HttpCode(200)@UseGuards(JwtAccessTokenGuard, RolesGuard)diff --git a/apps/production/src/user/user.controller.ts b/apps/production/src/user/user.controller.tsindex a75bae9a5..c3fa92451 100644--- a/apps/production/src/user/user.controller.ts+++ b/apps/production/src/user/user.controller.ts@@ -18,7 +18,7 @@ import {Patch,} from '@nestjs/common'import { Request } from 'express'-import { ApiTags, ApiQuery, ApiResponse } from '@nestjs/swagger'+import { ApiTags, ApiQuery, ApiResponse, ApiBearerAuth } from '@nestjs/swagger'import * as dayjs from 'dayjs'import * as utc from 'dayjs/plugin/utc'import * as _map from 'lodash/map'@@ -91,6 +91,7 @@ export class UserController {private readonly telegramService: TelegramService,) {}+ @ApiBearerAuth()@Get('/me')@UseGuards(RolesGuard)@Roles(UserType.CUSTOMER, UserType.ADMIN)@@ -112,6 +113,7 @@ export class UserController {return user}+ @ApiBearerAuth()@Get('/')@ApiQuery({ name: 'take', required: false })@ApiQuery({ name: 'skip', required: false })@@ -125,6 +127,7 @@ export class UserController {return this.userService.paginate({ take, skip })}+ @ApiBearerAuth()@Put('/theme')@UseGuards(JwtAccessTokenGuard, RolesGuard)@Roles(UserType.CUSTOMER, UserType.ADMIN)@@ -135,6 +138,7 @@ export class UserController {return this.userService.update(userId, { theme })}+ @ApiBearerAuth()@Put('/live-visitors')@UseGuards(JwtAccessTokenGuard, RolesGuard)@Roles(UserType.CUSTOMER, UserType.ADMIN)@@ -151,6 +155,7 @@ export class UserController {}}+ @ApiBearerAuth()@Get('/search')@ApiQuery({ name: 'query', required: false })@UseGuards(JwtAccessTokenGuard, RolesGuard)@@ -162,6 +167,7 @@ export class UserController {return this.userService.search(query)}+ @ApiBearerAuth()@Post('/')@UseGuards(JwtAccessTokenGuard, RolesGuard)@Roles(UserType.ADMIN)@@ -184,6 +190,7 @@ export class UserController {return null}+ @ApiBearerAuth()@Post('/recieve-login-notifications')@UseGuards(JwtAccessTokenGuard, RolesGuard)@Roles(UserType.CUSTOMER, UserType.ADMIN)@@ -199,6 +206,7 @@ export class UserController {return this.userService.update(userId, { receiveLoginNotifications })}+ @ApiBearerAuth()@Patch('/set-paypal-email')@UseGuards(JwtAccessTokenGuard, RolesGuard)@Roles(UserType.CUSTOMER, UserType.ADMIN)@@ -233,6 +241,7 @@ export class UserController {})}+ @ApiBearerAuth()@Post('/api-key')@UseGuards(JwtAccessTokenGuard, RolesGuard)@Roles(UserType.CUSTOMER, UserType.ADMIN)@@ -262,6 +271,7 @@ export class UserController {return { apiKey }}+ @ApiBearerAuth()@Delete('/api-key')@UseGuards(JwtAccessTokenGuard, RolesGuard)@Roles(UserType.CUSTOMER, UserType.ADMIN)@@ -277,6 +287,7 @@ export class UserController {await this.userService.update(userId, { apiKey: null })}+ @ApiBearerAuth()@Delete('/:id')@HttpCode(204)@UseGuards(JwtAccessTokenGuard, RolesGuard)@@ -320,6 +331,7 @@ export class UserController {}}+ @ApiBearerAuth()@Delete('/')@HttpCode(204)@UseGuards(JwtAccessTokenGuard, RolesGuard)@@ -373,6 +385,7 @@ export class UserController {return 'accountDeleted'}+ @ApiBearerAuth()@Delete('/share/:shareId')@HttpCode(204)@UseGuards(JwtAccessTokenGuard, RolesGuard)@@ -402,6 +415,7 @@ export class UserController {return 'shareDeleted'}+ @ApiBearerAuth()@Get('/share/:shareId')@HttpCode(204)@UseGuards(JwtAccessTokenGuard, RolesGuard)@@ -433,6 +447,7 @@ export class UserController {return 'shareAccepted'}+ @ApiBearerAuth()@Post('/confirm_email')@UseGuards(JwtAccessTokenGuard, RolesGuard)@Roles(UserType.CUSTOMER, UserType.ADMIN)@@ -468,6 +483,7 @@ export class UserController {return true}+ @ApiBearerAuth()@Put('/:id')@UseGuards(JwtAccessTokenGuard, RolesGuard)@Roles(UserType.ADMIN)@@ -503,6 +519,7 @@ export class UserController {}}+ @ApiBearerAuth()@Delete('/tg/:id')@UseGuards(JwtAccessTokenGuard, RolesGuard)@Roles(UserType.CUSTOMER, UserType.ADMIN)@@ -523,6 +540,7 @@ export class UserController {}}+ @ApiBearerAuth()@Put('/')@UseGuards(JwtAccessTokenGuard, RolesGuard)@Roles(UserType.CUSTOMER, UserType.ADMIN)@@ -666,6 +684,7 @@ export class UserController {}}+ // @ApiBearerAuth()// @Get('payouts/list')// @ApiQuery({ name: 'take', required: false })// @ApiQuery({ name: 'skip', required: false })@@ -687,6 +706,7 @@ export class UserController {// return this.userService.getPayoutsList(user)// }+ @ApiBearerAuth()@Get('referrals')@UseGuards(JwtAccessTokenGuard, RolesGuard)@Roles(UserType.CUSTOMER, UserType.ADMIN)@@ -702,6 +722,7 @@ export class UserController {return this.userService.getReferralsList(user)}+ @ApiBearerAuth()@Get('payouts/info')@UseGuards(JwtAccessTokenGuard, RolesGuard)@Roles(UserType.CUSTOMER, UserType.ADMIN)@@ -717,6 +738,7 @@ export class UserController {return this.userService.getPayoutsInfo(user)}+ @ApiBearerAuth()@Post('generate-ref-code')@UseGuards(JwtAccessTokenGuard, RolesGuard)@Roles(UserType.CUSTOMER, UserType.ADMIN)@@ -747,6 +769,7 @@ export class UserController {}}+ @ApiBearerAuth()@Get('/export')@UseGuards(JwtAccessTokenGuard, RolesGuard)@Roles(UserType.CUSTOMER, UserType.ADMIN)@@ -834,6 +857,7 @@ export class UserController {return info}+ @ApiBearerAuth()@Post('change-plan')@UseGuards(JwtAccessTokenGuard, RolesGuard)@Roles(UserType.CUSTOMER, UserType.ADMIN)@@ -848,6 +872,7 @@ export class UserController {await this.projectService.clearProjectsRedisCache(id)}+ @ApiBearerAuth()@Post('preview-plan')@UseGuards(JwtAccessTokenGuard, RolesGuard)@Roles(UserType.CUSTOMER, UserType.ADMIN)diff --git a/apps/selfhosted/src/project/project.controller.ts b/apps/selfhosted/src/project/project.controller.tsindex f474f065b..ae449dee0 100644--- a/apps/selfhosted/src/project/project.controller.ts+++ b/apps/selfhosted/src/project/project.controller.ts@@ -12,7 +12,7 @@ import {HttpCode,NotFoundException,} from '@nestjs/common'-import { ApiTags, ApiQuery, ApiResponse } from '@nestjs/swagger'+import { ApiTags, ApiQuery, ApiResponse, ApiBearerAuth } from '@nestjs/swagger'import * as _isEmpty from 'lodash/isEmpty'import * as _map from 'lodash/map'import * as _trim from 'lodash/trim'@@ -88,6 +88,7 @@ export class ProjectController {return formatted}+ @ApiBearerAuth()@Post('/')@ApiResponse({ status: 201, type: Project })@UseGuards(JwtAccessTokenGuard, RolesGuard)@@ -117,6 +118,7 @@ export class ProjectController {return project}+ @ApiBearerAuth()@Delete('/reset/:id')@HttpCode(204)@UseGuards(JwtAccessTokenGuard, RolesGuard)@@ -197,6 +199,7 @@ export class ProjectController {await this.projectService.removeDataFromClickhouse(pid, from, to)}+ @ApiBearerAuth()@Delete('/:id')@HttpCode(204)@UseGuards(JwtAccessTokenGuard, RolesGuard)@@ -228,6 +231,7 @@ export class ProjectController {}}+ @ApiBearerAuth()@Put('/:id')@HttpCode(200)@UseGuards(JwtAccessTokenGuard, RolesGuard)diff --git a/apps/selfhosted/src/user/user.controller.ts b/apps/selfhosted/src/user/user.controller.tsindex 060eb0de1..9a07cf77f 100644--- a/apps/selfhosted/src/user/user.controller.ts+++ b/apps/selfhosted/src/user/user.controller.ts@@ -6,7 +6,7 @@ import {Body,BadRequestException,} from '@nestjs/common'-import { ApiTags } from '@nestjs/swagger'+import { ApiBearerAuth, ApiTags } from '@nestjs/swagger'import * as _omit from 'lodash/omit'import { JwtAccessTokenGuard } from '../auth/guards'@@ -30,6 +30,7 @@ import { updateUserClickhouse, getUserClickhouse } from '../common/utils'export class UserController {constructor(private readonly logger: AppLoggerService) {}+ @ApiBearerAuth()@Get('/me')@UseGuards(RolesGuard)@Roles(UserType.CUSTOMER, UserType.ADMIN)@@ -39,6 +40,7 @@ export class UserController {return getSelfhostedUser()}+ @ApiBearerAuth()@Put('/live-visitors')@UseGuards(JwtAccessTokenGuard, RolesGuard)@Roles(UserType.CUSTOMER, UserType.ADMIN)@@ -66,6 +68,7 @@ export class UserController {}}+ @ApiBearerAuth()@Put('/')@UseGuards(JwtAccessTokenGuard, RolesGuard)@Roles(UserType.CUSTOMER, UserType.ADMIN)