@lenne.tech/nest-server 11.2.0 → 11.4.0

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

@@ -1,10 +1,10 @@
-import { Field, ObjectType } from '@nestjs/graphql';
+import { ObjectType } from '@nestjs/graphql';
 import { Schema as MongooseSchema, Prop, raw } from '@nestjs/mongoose';
 import { ApiExtraModels, ApiProperty } from '@nestjs/swagger';
-import { IsOptional } from 'class-validator';
 import { Document } from 'mongoose';
 
 import { Restricted } from '../../common/decorators/restricted.decorator';
+import { UnifiedField } from '../../common/decorators/unified-field.decorator';
 import { RoleEnum } from '../../common/enums/role.enum';
 import { CorePersistenceModel } from '../../common/models/core-persistence.model';
 import { CoreTokenData } from '../auth/interfaces/core-token-data.interface';
@@ -26,67 +26,78 @@ export abstract class CoreUserModel extends CorePersistenceModel {
   /**
    * E-Mail address of the user
    */
-  @ApiProperty()
-  @Field({ description: 'Email of the user', nullable: true })
-  @Prop({ index: true, lowercase: true, trim: true })
-  @Restricted(RoleEnum.S_EVERYONE)
+  @UnifiedField({
+    description: 'Email of the user',
+    isOptional: true,
+    mongoose: { index: true, lowercase: true, trim: true },
+    roles: RoleEnum.S_EVERYONE,
+  })
   email: string = undefined;
 
   /**
    * First name of the user
    */
-  @ApiProperty()
-  @Field({ description: 'First name of the user', nullable: true })
-  @IsOptional()
-  @Prop()
-  @Restricted(RoleEnum.S_EVERYONE)
+  @UnifiedField({
+    description: 'First name of the user',
+    isOptional: true,
+    mongoose: true,
+    roles: RoleEnum.S_EVERYONE,
+  })
   firstName: string = undefined;
 
   /**
    * Last name of the user
    */
-  @ApiProperty()
-  @Field({ description: 'Last name of the user', nullable: true })
-  @IsOptional()
-  @Prop()
-  @Restricted(RoleEnum.S_EVERYONE)
+  @UnifiedField({
+    description: 'Last name of the user',
+    isOptional: true,
+    mongoose: true,
+    roles: RoleEnum.S_EVERYONE,
+  })
   lastName: string = undefined;
 
   /**
    * Password of the user
    */
-  @ApiProperty()
-  @Prop()
-  @Restricted(RoleEnum.S_NO_ONE)
+  @UnifiedField({
+    isOptional: true,
+    mongoose: true,
+    roles: RoleEnum.S_NO_ONE,
+  })
   password: string = undefined;
 
   /**
    * Roles of the user
    */
-  @ApiProperty()
-  @Field(() => [String], { description: 'Roles of the user', nullable: true })
-  @IsOptional()
-  @Prop([String])
-  @Restricted(RoleEnum.S_EVERYONE)
+  @UnifiedField({
+    description: 'Roles of the user',
+    isArray: true,
+    isOptional: true,
+    mongoose: [String],
+    roles: RoleEnum.S_EVERYONE,
+    type: () => String,
+  })
   roles: string[] = undefined;
 
   /**
    * Username of the user
    */
-  @ApiProperty()
-  @Field({ description: 'Username of the user', nullable: true })
-  @IsOptional()
-  @Prop()
-  @Restricted(RoleEnum.S_EVERYONE)
+  @UnifiedField({
+    description: 'Username of the user',
+    isOptional: true,
+    mongoose: true,
+    roles: RoleEnum.S_EVERYONE,
+  })
   username: string = undefined;
 
   /**
    * Password reset token of the user
    */
-  @ApiProperty()
-  @IsOptional()
-  @Prop()
-  @Restricted(RoleEnum.S_NO_ONE)
+  @UnifiedField({
+    isOptional: true,
+    mongoose: true,
+    roles: RoleEnum.S_NO_ONE,
+  })
   passwordResetToken: string = undefined;
 
   /**
@@ -96,30 +107,41 @@ export abstract class CoreUserModel extends CorePersistenceModel {
    */
   @ApiProperty({ isArray: true })
   @ApiProperty({
-      additionalProperties: {
+    additionalProperties: {
       properties: {
-        deviceDescription: { description: 'Description of the device from which the token was generated', nullable: true, type: 'string' },
-        deviceId: { description: 'ID of the device from which the token was generated', nullable: true, type: 'string' },
-        tokenId: { description: 'Token ID to make sure that there is only one RefreshToken for each device', nullable: false, type: 'string' },
+        deviceDescription: {
+          description: 'Description of the device from which the token was generated',
+          nullable: true,
+          type: 'string',
+        },
+        deviceId: {
+          description: 'ID of the device from which the token was generated',
+          nullable: true,
+          type: 'string',
+        },
+        tokenId: {
+          description: 'Token ID to make sure that there is only one RefreshToken for each device',
+          nullable: false,
+          type: 'string',
+        },
       },
       type: 'object',
     },
     description: 'Refresh tokens for devices (key: Token, value: TokenData)',
     example: {
-        '49b5c7d6-94ae-4efe-b377-9b50d1a9c2cb': {
-          deviceDescription: null,
-          deviceId: '49b5c7d6-94ae-4efe-b377-9b50d1a9c2cb',
-          tokenId: '50937407-4282-480e-8679-14ecc113f9c7',
-        },
-        'e9e60a3e-2004-479f-8e79-13a0d1981d76': {
-          deviceDescription: null,
-          deviceId: 'e9e60a3e-2004-479f-8e79-13a0d1981d76',
-          tokenId: '0604aa59-4fc8-4848-9fe7-c12d9cdf6ec0',
-        },
+      '49b5c7d6-94ae-4efe-b377-9b50d1a9c2cb': {
+        deviceDescription: null,
+        deviceId: '49b5c7d6-94ae-4efe-b377-9b50d1a9c2cb',
+        tokenId: '50937407-4282-480e-8679-14ecc113f9c7',
+      },
+      'e9e60a3e-2004-479f-8e79-13a0d1981d76': {
+        deviceDescription: null,
+        deviceId: 'e9e60a3e-2004-479f-8e79-13a0d1981d76',
+        tokenId: '0604aa59-4fc8-4848-9fe7-c12d9cdf6ec0',
       },
+    },
     type: 'object',
   })
-  @IsOptional()
   @Prop(raw({}))
   @Restricted(RoleEnum.S_NO_ONE)
   refreshTokens: Record<string, CoreTokenData> = undefined;
@@ -130,30 +152,44 @@ export abstract class CoreUserModel extends CorePersistenceModel {
    */
   @ApiProperty()
   @ApiProperty({
-      additionalProperties: {
+    additionalProperties: {
       properties: {
-        createdAt: { description: 'Token Created At', example: 1740037703939, format: 'int64', nullable: true, type: 'number' },
-        deviceId: { description: 'ID of the device from which the token was generated', nullable: true, type: 'string' },
-        tokenId: { description: 'Token ID to make sure that there is only one RefreshToken for each device', nullable: false, type: 'string' },
+        createdAt: {
+          description: 'Token Created At',
+          example: 1740037703939,
+          format: 'int64',
+          nullable: true,
+          type: 'number',
+        },
+        deviceId: {
+          description: 'ID of the device from which the token was generated',
+          nullable: true,
+          type: 'string',
+        },
+        tokenId: {
+          description: 'Token ID to make sure that there is only one RefreshToken for each device',
+          nullable: false,
+          type: 'string',
+        },
       },
       type: 'object',
     },
     description: 'Temporary token for parallel requests during the token refresh process',
-    example: { // 👈 Add explicit example keys
-        '49b5c7d6-94ae-4efe-b377-9b50d1a9c2cb': {
-          createdAt: 1740037703939,
-          deviceId: '49b5c7d6-94ae-4efe-b377-9b50d1a9c2cb',
-          tokenId: '50937407-4282-480e-8679-14ecc113f9c7',
-        },
-        'f83ae5f6-90bf-4b4e-b318-651e0eaa67ae': {
-          createdAt: 1740037703940,
-          deviceId: 'f83ae5f6-90bf-4b4e-b318-651e0eaa67ae',
-          tokenId: '4f0dc3c5-e74e-41f4-9bd9-642869462c1e',
-        },
+    example: {
+      // 👈 Add explicit example keys
+      '49b5c7d6-94ae-4efe-b377-9b50d1a9c2cb': {
+        createdAt: 1740037703939,
+        deviceId: '49b5c7d6-94ae-4efe-b377-9b50d1a9c2cb',
+        tokenId: '50937407-4282-480e-8679-14ecc113f9c7',
       },
+      'f83ae5f6-90bf-4b4e-b318-651e0eaa67ae': {
+        createdAt: 1740037703940,
+        deviceId: 'f83ae5f6-90bf-4b4e-b318-651e0eaa67ae',
+        tokenId: '4f0dc3c5-e74e-41f4-9bd9-642869462c1e',
+      },
+    },
     type: 'object',
   })
-  @IsOptional()
   @Prop(raw({}))
   @Restricted(RoleEnum.S_NO_ONE)
   tempTokens: Record<string, { createdAt: number; deviceId: string; tokenId: string }> = undefined;
@@ -161,28 +197,34 @@ export abstract class CoreUserModel extends CorePersistenceModel {
   /**
    * Verification token of the user
    */
-  @ApiProperty()
-  @IsOptional()
-  @Prop()
-  @Restricted(RoleEnum.S_NO_ONE)
+  @UnifiedField({
+    isOptional: true,
+    mongoose: true,
+    roles: RoleEnum.S_NO_ONE,
+  })
   verificationToken: string = undefined;
 
   /**
    * Verification of the user
    */
-  @ApiProperty()
-  @Field(() => Boolean, { description: 'Verification state of the user', nullable: true })
-  @Prop({ type: Boolean })
-  @Restricted(RoleEnum.S_EVERYONE)
+  @UnifiedField({
+    description: 'Verification state of the user',
+    isOptional: true,
+    mongoose: { type: Boolean },
+    roles: RoleEnum.S_EVERYONE,
+    type: () => Boolean,
+  })
   verified: boolean = undefined;
 
   /**
    * Verification date
    */
-  @ApiProperty()
-  @Field({ description: 'Verified date', nullable: true })
-  @Prop()
-  @Restricted(RoleEnum.S_EVERYONE)
+  @UnifiedField({
+    description: 'Verified date',
+    isOptional: true,
+    mongoose: true,
+    roles: RoleEnum.S_EVERYONE,
+  })
   verifiedAt: Date = undefined;
 
   // ===================================================================================================================
@@ -199,7 +241,7 @@ export abstract class CoreUserModel extends CorePersistenceModel {
     if (!this.roles || this.roles.length < 1) {
       return false;
     }
-    return !roles || roles.length < 1 ? true : this.roles.some(role => roles.includes(role));
+    return !roles || roles.length < 1 ? true : this.roles.some((role) => roles.includes(role));
   }
 
   /**
@@ -212,7 +254,7 @@ export abstract class CoreUserModel extends CorePersistenceModel {
     if (!this.roles || this.roles.length < 1) {
       return false;
     }
-    return !roles ? true : roles.every(role => this.roles.includes(role));
+    return !roles ? true : roles.every((role) => this.roles.includes(role));
   }
 
   /**

package/src/index.ts

@@ -132,19 +132,25 @@ export * from './core/modules/file/interfaces/file-service-options.interface';
 export * from './core/modules/file/interfaces/file-upload.interface';
 
 // =====================================================================================================================
-// Core - Modules - User
+// Core - Modules - HealthCheck
 // =====================================================================================================================
 
 export * from './core/modules/health-check/core-health-check-result.model';
 export * from './core/modules/health-check/core-health-check.controller';
 export * from './core/modules/health-check/core-health-check.module';
 export * from './core/modules/health-check/core-health-check.resolver';
+export * from './core/modules/health-check/core-health-check.service';
 
 // =====================================================================================================================
-// Core - Modules - HealthCheck
+// Core - Modules - Migrate
+// =====================================================================================================================
+
+export * from './core/modules/migrate';
+
+// =====================================================================================================================
+// Core - Modules - User
 // =====================================================================================================================
 
-export * from './core/modules/health-check/core-health-check.service';
 export * from './core/modules/user/core-user.model';
 export * from './core/modules/user/core-user.service';
 export * from './core/modules/user/inputs/core-user-create.input';

package/src/main.ts

@@ -1,11 +1,19 @@
 import { NestFactory } from '@nestjs/core';
 import { NestExpressApplication } from '@nestjs/platform-express';
+import { DocumentBuilder, SwaggerModule } from '@nestjs/swagger';
 import { exec } from 'child_process';
 import compression = require('compression');
 import cookieParser = require('cookie-parser');
 
 import envConfig from './config.env';
+import { FilterArgs } from './core/common/args/filter.args';
 import { HttpExceptionLogFilter } from './core/common/filters/http-exception-log.filter';
+import { CorePersistenceModel } from './core/common/models/core-persistence.model';
+import { CoreAuthModel } from './core/modules/auth/core-auth.model';
+import { CoreUserModel } from './core/modules/user/core-user.model';
+import { PersistenceModel } from './server/common/models/persistence.model';
+import { Auth } from './server/modules/auth/auth.model';
+import { User } from './server/modules/user/user.model';
 import { ServerModule } from './server/server.module';
 
 /**
@@ -54,6 +62,23 @@ async function bootstrap() {
   // Enable cors to allow requests from other domains
   server.enableCors();
 
+  // Swagger documentation
+  const config = new DocumentBuilder()
+    .setTitle('Nest Server API')
+    .setDescription('API lenne.Tech Nest Server')
+    .setVersion('1.0.0')
+    .addBearerAuth()
+    .build();
+  const documentFactory = () =>
+    SwaggerModule.createDocument(server, config, {
+      autoTagControllers: true,
+      deepScanRoutes: true,
+      extraModels: [CoreUserModel, CoreAuthModel, Auth, User, PersistenceModel, CorePersistenceModel, FilterArgs],
+    });
+  SwaggerModule.setup('swagger', server, documentFactory, {
+    jsonDocumentUrl: '/api-docs-json',
+  });
+
   // Start server on configured port
   await server.listen(envConfig.port, envConfig.hostname);
   console.debug(`Server startet at ${await server.getUrl()}`);

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

@@ -1,10 +1,10 @@
-import { Field, ObjectType } from '@nestjs/graphql';
-import { Prop } from '@nestjs/mongoose';
-import { ApiExtraModels, ApiProperty } from '@nestjs/swagger';
+import { ObjectType } from '@nestjs/graphql';
+import { ApiExtraModels } from '@nestjs/swagger';
 import { Types } from 'mongoose';
 import mongoose = require('mongoose');
 
 import { Restricted } from '../../../core/common/decorators/restricted.decorator';
+import { UnifiedField } from '../../../core/common/decorators/unified-field.decorator';
 import { RoleEnum } from '../../../core/common/enums/role.enum';
 import { CorePersistenceModel } from '../../../core/common/models/core-persistence.model';
 import { User } from '../../modules/user/user.model';
@@ -30,13 +30,14 @@ export abstract class PersistenceModel extends CorePersistenceModel {
    *
    * Not set when created by system
    */
-  @ApiProperty({ type: String })
-  @Field(() => User, {
+  @UnifiedField({
     description: 'ID of the user who created the object',
-    nullable: true,
+    isOptional: true,
+    mongoose: { ref: 'User', type: mongoose.Schema.Types.ObjectId },
+    roles: RoleEnum.ADMIN,
+    swaggerApiOptions: { type: String },
+    type: () => User,
   })
-  @Prop({ ref: 'User', type: mongoose.Schema.Types.ObjectId })
-  @Restricted(RoleEnum.ADMIN)
   createdBy?: string | Types.ObjectId = undefined;
 
   /**
@@ -44,13 +45,14 @@ export abstract class PersistenceModel extends CorePersistenceModel {
    *
    * Not set when updated by system
    */
-  @ApiProperty({ type: User })
-  @Field(() => User, {
+  @UnifiedField({
     description: 'ID of the user who updated the object',
-    nullable: true,
+    isOptional: true,
+    mongoose: { ref: 'User', type: mongoose.Schema.Types.ObjectId },
+    roles: RoleEnum.ADMIN,
+    swaggerApiOptions: { type: User },
+    type: () => User,
   })
-  @Prop({ ref: 'User', type: mongoose.Schema.Types.ObjectId })
-  @Restricted(RoleEnum.ADMIN)
   updatedBy?: string | Types.ObjectId = undefined;
 
   // ===================================================================================================================

package/src/server/modules/auth/auth.model.ts

@@ -1,6 +1,7 @@
-import { Field, ObjectType } from '@nestjs/graphql';
+import { ObjectType } from '@nestjs/graphql';
 
 import { Restricted } from '../../../core/common/decorators/restricted.decorator';
+import { UnifiedField } from '../../../core/common/decorators/unified-field.decorator';
 import { RoleEnum } from '../../../core/common/enums/role.enum';
 import { mapClasses } from '../../../core/common/helpers/model.helper';
 import { CoreAuthModel } from '../../../core/modules/auth/core-auth.model';
@@ -19,8 +20,11 @@ export class Auth extends CoreAuthModel {
   /**
    * Signed-in user
    */
-  @Field(() => User, { description: 'User who signed in' })
-  @Restricted(RoleEnum.S_EVERYONE)
+  @UnifiedField({
+    description: 'User who signed in',
+    roles: RoleEnum.S_EVERYONE,
+    type: () => User,
+  })
   override user: User = undefined;
 
   // ===================================================================================================================