@lenne.tech/nest-server 10.8.6 → 10.8.7

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lenne.tech/nest-server",
-  "version": "10.8.6",
+  "version": "10.8.7",
   "description": "Modern, fast, powerful Node.js web framework in TypeScript based on Nest with a GraphQL API and a connection to MongoDB (or other databases).",
   "keywords": [
     "node",

package/src/core/common/decorators/common-error.decorator.ts

@@ -0,0 +1,28 @@
+import { applyDecorators } from '@nestjs/common';
+import { ApiBadRequestResponse, ApiNotFoundResponse, ApiUnauthorizedResponse } from '@nestjs/swagger';
+
+export const commonErrorSchema = {
+  properties: {
+    message: { type: 'string' },
+    name: { type: 'string' },
+    options: { type: 'object' },
+    response: {
+      properties: {
+        error: { type: 'string' },
+        message: { type: 'string' },
+        statusCode: { type: 'number' },
+      },
+      type: 'object',
+    },
+    status: { type: 'number' },
+  },
+  type: 'object',
+};
+
+export function ApiCommonErrorResponses() {
+  return applyDecorators(
+    ApiUnauthorizedResponse({ schema: commonErrorSchema }),
+    ApiNotFoundResponse({ schema: commonErrorSchema }),
+    ApiBadRequestResponse({ schema: commonErrorSchema }),
+  );
+}

package/src/core/common/models/core-persistence.model.ts

@@ -1,5 +1,6 @@
 import { Field, ID, ObjectType } from '@nestjs/graphql';
 import { Prop, Schema } from '@nestjs/mongoose';
+import { ApiProperty } from '@nestjs/swagger';
 import { Types } from 'mongoose';
 
 import { Restricted } from '../decorators/restricted.decorator';
@@ -47,6 +48,7 @@ export abstract class CorePersistenceModel extends CoreModel {
     description: 'ID of the persistence object',
     nullable: true,
   })
+  @ApiProperty({ type: String })
   id: string = undefined;
 
   /**
@@ -55,6 +57,7 @@ export abstract class CorePersistenceModel extends CoreModel {
   @Restricted(RoleEnum.S_EVERYONE)
   @Field({ description: 'Created date', nullable: true })
   @Prop({ onCreate: () => new Date() })
+  @ApiProperty({ example: 1740037703939, format: 'int64', type: Date })
   createdAt: Date = undefined;
 
   /**
@@ -63,6 +66,7 @@ export abstract class CorePersistenceModel extends CoreModel {
   @Restricted(RoleEnum.S_EVERYONE)
   @Field({ description: 'Updated date', nullable: true })
   @Prop({ onUpdate: () => new Date() })
+  @ApiProperty({ example: 1740037703939, format: 'int64', type: String })
   updatedAt: Date = undefined;
 
   // ===========================================================================

package/src/core/modules/auth/core-auth.controller.ts

@@ -1,7 +1,13 @@
 import { Body, Controller, Get, ParseBoolPipe, Post, Query, Res, UseGuards } from '@nestjs/common';
-import { ApiBody, ApiOperation, ApiResponse } from '@nestjs/swagger';
+import {
+  ApiBody, ApiCreatedResponse,
+  ApiOkResponse,
+  ApiOperation,
+  ApiQuery,
+} from '@nestjs/swagger';
 import { Response as ResponseType } from 'express';
 
+import { ApiCommonErrorResponses } from '../../common/decorators/common-error.decorator';
 import { CurrentUser } from '../../common/decorators/current-user.decorator';
 import { Roles } from '../../common/decorators/roles.decorator';
 import { RoleEnum } from '../../common/enums/role.enum';
@@ -17,6 +23,7 @@ import { Tokens } from './tokens.decorator';
 
 @Roles(RoleEnum.ADMIN)
 @Controller('auth')
+@ApiCommonErrorResponses()
 export class CoreAuthController {
   /**
    * Import services
@@ -30,6 +37,8 @@ export class CoreAuthController {
    * Logout user (from specific device)
    */
   @ApiOperation({ description: 'Logs a user out from a specific device' })
+  @ApiQuery({ description: 'If all devices should be logged out,', name: 'allDevices', required: false, type: Boolean })
+  @ApiOkResponse({ type: Boolean })
   @Get('logout')
   @Roles(RoleEnum.S_EVERYONE)
   @UseGuards(AuthGuard(AuthGuardStrategy.JWT))
@@ -37,7 +46,7 @@ export class CoreAuthController {
     @CurrentUser() currentUser: ICoreAuthUser,
     @Tokens('token') token: string,
     @Res({ passthrough: true }) res: ResponseType,
-    @Query('allDevices', ParseBoolPipe) allDevices?: boolean,
+    @Query('allDevices', new ParseBoolPipe({ optional: true })) allDevices?: boolean,
   ): Promise<boolean> {
     const result = await this.authService.logout(token, { allDevices, currentUser });
     return this.processCookies(res, result);
@@ -46,7 +55,8 @@ export class CoreAuthController {
   /**
    * Refresh token (for specific device)
    */
-  @ApiResponse({ type: CoreAuthModel })
+  @ApiOperation({ description: 'Refresh token (for specific device)' })
+  @ApiOkResponse({ type: CoreAuthModel })
   @Get('refresh-token')
   @Roles(RoleEnum.S_EVERYONE)
   @UseGuards(AuthGuard(AuthGuardStrategy.JWT_REFRESH))
@@ -63,6 +73,7 @@ export class CoreAuthController {
    * Sign in user via email and password (on specific device)
    */
   @ApiOperation({ description: 'Sign in via email and password' })
+  @ApiCreatedResponse({ description: 'Signed in successfully', type: CoreAuthModel })
   @Post('signin')
   @Roles(RoleEnum.S_EVERYONE)
   async signIn(@Res({ passthrough: true }) res: ResponseType, @Body() input: CoreAuthSignInInput): Promise<CoreAuthModel> {
@@ -75,9 +86,10 @@ export class CoreAuthController {
    */
   @ApiBody({ type: CoreAuthSignUpInput })
   @ApiOperation({ description: 'Sign up via email and password' })
+  @ApiCreatedResponse({ type: CoreAuthSignUpInput })
   @Post('signup')
   @Roles(RoleEnum.S_EVERYONE)
-  async signUp(@Res() res: ResponseType, @Body() input: CoreAuthSignUpInput): Promise<CoreAuthModel> {
+  async signUp(@Res({ passthrough: true }) res: ResponseType, @Body() input: CoreAuthSignUpInput): Promise<CoreAuthModel> {
     const result = await this.authService.signUp(input);
     return this.processCookies(res, result);
   }

package/src/core/modules/user/core-user.model.ts

@@ -1,6 +1,6 @@
 import { Field, ObjectType } from '@nestjs/graphql';
 import { Schema as MongooseSchema, Prop, raw } from '@nestjs/mongoose';
-import { ApiProperty } from '@nestjs/swagger';
+import { ApiExtraModels, ApiProperty } from '@nestjs/swagger';
 import { IsOptional } from 'class-validator';
 import { Document } from 'mongoose';
 
@@ -17,6 +17,7 @@ export type CoreUserModelDocument = CoreUserModel & Document;
 @Restricted(RoleEnum.S_EVERYONE)
 @ObjectType({ description: 'User', isAbstract: true })
 @MongooseSchema({ timestamps: true })
+@ApiExtraModels(CorePersistenceModel)
 export abstract class CoreUserModel extends CorePersistenceModel {
   // ===================================================================================================================
   // Properties

package/src/index.ts

@@ -9,6 +9,7 @@ export * from './core.module';
 // =====================================================================================================================
 export * from './core/common/args/filter.args';
 export * from './core/common/args/pagination.args';
+export * from './core/common/decorators/common-error.decorator';
 export * from './core/common/decorators/current-user.decorator';
 export * from './core/common/decorators/graphql-populate.decorator';
 export * from './core/common/decorators/graphql-service-options.decorator';

package/src/server/common/models/persistence.model.ts

@@ -1,5 +1,6 @@
 import { Field, ObjectType } from '@nestjs/graphql';
 import { Prop } from '@nestjs/mongoose';
+import { ApiExtraModels, ApiProperty } from '@nestjs/swagger';
 import { Types } from 'mongoose';
 
 import { Restricted } from '../../../core/common/decorators/restricted.decorator';
@@ -19,6 +20,7 @@ import mongoose = require('mongoose');
   description: 'Persistence model which will be saved in DB',
   isAbstract: true,
 })
+@ApiExtraModels(CorePersistenceModel)
 export abstract class PersistenceModel extends CorePersistenceModel {
   // ===================================================================================================================
   // Properties
@@ -35,6 +37,7 @@ export abstract class PersistenceModel extends CorePersistenceModel {
     nullable: true,
   })
   @Prop({ ref: 'User', type: mongoose.Schema.Types.ObjectId })
+  @ApiProperty({ type: String })
   createdBy?: Types.ObjectId | string = undefined;
 
   /**
@@ -48,6 +51,7 @@ export abstract class PersistenceModel extends CorePersistenceModel {
     nullable: true,
   })
   @Prop({ ref: 'User', type: mongoose.Schema.Types.ObjectId })
+  @ApiProperty({ type: User })
   updatedBy?: Types.ObjectId | string = undefined;
 
   // ===================================================================================================================