@lenne.tech/nest-server 8.6.4 → 8.6.7

package/src/core/common/interfaces/server-options.interface.ts

@@ -1,4 +1,5 @@
 import { ApolloDriverConfig } from '@nestjs/apollo';
+import { GqlModuleAsyncOptions } from '@nestjs/graphql';
 import { JwtModuleOptions } from '@nestjs/jwt';
 import { MongooseModuleOptions } from '@nestjs/mongoose/dist/interfaces/mongoose-options.interface';
 import { ServeStaticOptions } from '@nestjs/platform-express/interfaces/serve-static-options.interface';
@@ -9,12 +10,58 @@ import { MailjetOptions } from './mailjet-options.interface';
  * Options for the server
  */
 export interface IServerOptions {
+  /**
+   * SMTP and template configuration for sending emails
+   */
+  email?: {
+    /**
+     * Data for default sender
+     */
+    defaultSender?: {
+      /**
+       * Default email for sending emails
+       */
+      email?: string;
+
+      /**
+       * Default name for sending emails
+       */
+      name?: string;
+    };
+
+    /**
+     * Options for Mailjet
+     */
+    mailjet?: MailjetOptions;
+
+    /**
+     * Password reset link for email
+     */
+    passwordResetLink?: string;
+
+    /**
+     * SMTP configuration for nodemailer
+     */
+    smtp?: SMTPTransport | SMTPTransport.Options | string;
+
+    /**
+     * Verification link for email
+     */
+    verificationLink?: string;
+  };
+
   /**
    * Environment
    * e.g. 'development'
    */
   env?: string;
 
+  /**
+   * Exec a command after server is initialized
+   * e.g. 'npm run docs:bootstrap'
+   */
+  execAfterInit?: string;
+
   /**
    * Configuration of the GraphQL module
    * see https://docs.nestjs.com/graphql/quick-start
@@ -30,6 +77,11 @@ export interface IServerOptions {
      * Subscription authentication
      */
     enableSubscriptionAuth?: boolean;
+
+    /**
+     * Module options (forRootAsync)
+     */
+    options?: GqlModuleAsyncOptions;
   };
 
   /**
@@ -67,6 +119,11 @@ export interface IServerOptions {
     secretOrPrivateKey?: string;
   } & JwtModuleOptions;
 
+  /**
+   * Configuration for Mongoose
+   */
+  mongoose?: { uri: string; options?: MongooseModuleOptions };
+
   /**
    * Port number of the server
    * e.g. 8080
@@ -74,77 +131,36 @@ export interface IServerOptions {
   port?: number;
 
   /**
-   * SMTP and template configuration for sending emails
+   * Configuration for useStaticAssets
    */
-  email?: {
-    /**
-     * SMTP configuration for nodemailer
-     */
-    smtp?: SMTPTransport | SMTPTransport.Options | string;
-
-    mailjet?: MailjetOptions;
-    /**
-     * Verification link for email
-     */
-    verificationLink?: string;
-
-    /**
-     * Password reset link for email
-     */
-    passwordResetLink?: string;
-
+  staticAssets?: {
     /**
-     * Data for default sender
+     * Additional options for useStaticAssets
+     * e.g. {prefix: '/public/'}
      */
-    defaultSender?: {
-      /**
-       * Default email for sending emails
-       */
-      email?: string;
-
-      /**
-       * Default name for sending emails
-       */
-      name?: string;
-    };
-  };
-
-  /**
-   * Configuration for Mongoose
-   */
-  mongoose?: { uri: string; options?: MongooseModuleOptions };
+    options?: ServeStaticOptions;
 
-  /**
-   * Configuration for useStaticAssets
-   */
-  staticAssets?: {
     /**
      * Root directory for static assets
      * e.g. join(__dirname, '..', 'public')
      */
     path?: string;
-
-    /**
-     * Additional options for useStaticAssets
-     * e.g. {prefix: '/public/'}
-     */
-    options?: ServeStaticOptions;
   };
 
   /**
    * Templates
    */
   templates?: {
-    /**
-     * Directory for templates
-     *  e.g. join(__dirname, '..', 'templates')
-     */
-    path?: string;
-
     /**
      * View engine
      * e.g. 'ejs'
      */
     engine?: string;
+
+    /**
+     * Directory for templates
+     *  e.g. join(__dirname, '..', 'templates')
+     */
+    path?: string;
   };
 }

package/src/core/common/interfaces/service-options.interface.ts

@@ -1,4 +1,4 @@
-import { Model } from 'mongoose';
+import { Model, PopulateOptions } from 'mongoose';
 import { FieldSelection } from '../types/field-selection.type';
 import { PrepareInputOptions } from './prepare-input-options.interface';
 import { PrepareOutputOptions } from './prepare-output-options.interface';
@@ -22,15 +22,21 @@ export interface ServiceOptions {
     roles?: string[];
   };
 
-  // Field selection for results
+  // Field selection for results (will be overwritten by populate if populate was set)
   fieldSelection?: FieldSelection;
 
+  // Determines whether all restrictions are ignored
+  force?: boolean;
+
   // Overwrites type of input (array items)
   inputType?: new (...params: any[]) => any;
 
   // Overwrites type of output (array items)
   outputType?: new (...params: any[]) => any;
 
+  // Alias for fieldSelection (if both are set fieldSelection is overwritten by populate)
+  populate?: PopulateOptions | (PopulateOptions | string)[];
+
   // Process field selection
   // If {} or not set, then the field selection runs with defaults
   // If falsy, then the field selection will not be automatically executed

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

@@ -92,7 +92,10 @@ export abstract class CoreModel {
       mapId: false,
       ...options,
     };
-    return config.init ? map(data, this, config).init(config.init) : map(data, this, config);
+    if (config.init) {
+      this.init(config.init);
+    }
+    return map(data, this, config);
   }
 
   /**

package/src/core/common/services/crud.service.ts

@@ -2,6 +2,7 @@ import { NotFoundException } from '@nestjs/common';
 import { FilterArgs } from '../args/filter.args';
 import { merge } from '../helpers/config.helper';
 import { convertFilterArgsToQuery } from '../helpers/filter.helper';
+import { assignPlain } from '../helpers/input.helper';
 import { ServiceOptions } from '../interfaces/service-options.interface';
 import { CoreModel } from '../models/core-model.model';
 import { ModuleService } from './module.service';
@@ -14,7 +15,8 @@ export abstract class CrudService<T extends CoreModel = any> extends ModuleServi
     merge({ prepareInput: { create: true } }, serviceOptions);
     return this.process(
       async (data) => {
-        return new this.mainDbModel({ ...data.input }).save();
+        const currentUserId = serviceOptions?.currentUser?.id;
+        return new this.mainDbModel({ ...data.input, createdBy: currentUserId, updatedBy: currentUserId }).save();
       },
       { input, serviceOptions }
     );
@@ -75,7 +77,8 @@ export abstract class CrudService<T extends CoreModel = any> extends ModuleServi
     }
     return this.process(
       async (data) => {
-        return await Object.assign(dbObject, data.input).save();
+        const currentUserId = serviceOptions?.currentUser?.id;
+        return await assignPlain(dbObject, data.input, { updatedBy: currentUserId }).save();
       },
       { dbObject, input, serviceOptions }
     );
@@ -90,11 +93,11 @@ export abstract class CrudService<T extends CoreModel = any> extends ModuleServi
       throw new NotFoundException(`No ${this.mainModelConstructor.name} found with ID: ${id}`);
     }
     return this.process(
-      async (data) => {
+      async () => {
         await this.mainDbModel.findByIdAndDelete(id).exec();
         return dbObject;
       },
-      { dbObject, input: id, serviceOptions }
+      { dbObject, serviceOptions }
     );
   }
 }

package/src/core/common/services/module.service.ts

@@ -74,6 +74,7 @@ export abstract class ModuleService<T extends CoreModel = any> {
     const config = {
       checkRights: true,
       dbObject: options?.dbObject,
+      force: false,
       input: options?.input,
       processFieldSelection: {},
       prepareInput: {},
@@ -82,6 +83,22 @@ export abstract class ModuleService<T extends CoreModel = any> {
       ...options?.serviceOptions,
     };
 
+    // Note force configuration
+    if (config.force) {
+      config.checkRights = false;
+      if (typeof config.prepareInput === 'object') {
+        config.prepareInput.checkRoles = false;
+      }
+      if (typeof config.prepareOutput === 'object') {
+        config.prepareOutput.removeSecrets = false;
+      }
+    }
+
+    // Note populate
+    if (config.populate) {
+      config.fieldSelection = config.populate;
+    }
+
     // Prepare input
     if (config.prepareInput && this.prepareInput) {
       const opts = config.prepareInput;
@@ -150,7 +167,6 @@ export abstract class ModuleService<T extends CoreModel = any> {
    */
   async prepareInput(input: Record<string, any>, options: ServiceOptions = {}) {
     const config = {
-      targetModel: this.mainModelConstructor,
       ...options?.prepareInput,
     };
     return prepareInput(input, options.currentUser, config);

package/src/core/common/types/field-selection.type.ts

@@ -5,4 +5,4 @@ import { ResolveSelector } from '../interfaces/resolve-selector.interface';
 /**
  * Field selection to set fields of (populated) result
  */
-export type FieldSelection = PopulateOptions[] | SelectionNode[] | ResolveSelector;
+export type FieldSelection = PopulateOptions | (PopulateOptions | string)[] | SelectionNode[] | ResolveSelector;

package/src/core/modules/auth/guards/roles.guard.ts

@@ -38,7 +38,7 @@ export class RolesGuard extends AuthGuard('jwt') {
     }
 
     // Check user and user roles
-    if (!user || !user.hasRole(roles)) {
+    if (!user?.hasRole?.(roles)) {
       // Get args
       const args: any = GqlExecutionContext.create(context).getArgs();
 

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

@@ -3,6 +3,7 @@ import * as bcrypt from 'bcrypt';
 import * as crypto from 'crypto';
 import { Document, Model } from 'mongoose';
 import { merge } from '../../common/helpers/config.helper';
+import { assignPlain } from '../../common/helpers/input.helper';
 import { ServiceOptions } from '../../common/interfaces/service-options.interface';
 import { CrudService } from '../../common/services/crud.service';
 import { EmailService } from '../../common/services/email.service';
@@ -39,9 +40,12 @@ export abstract class CoreUserService<
     return this.process(
       async (data) => {
         // Create user with verification token
+        const currentUserId = serviceOptions?.currentUser?._id;
         const createdUser = new this.mainDbModel({
           ...data.input,
           verificationToken: crypto.randomBytes(32).toString('hex'),
+          createdBy: currentUserId,
+          updatedBy: currentUserId,
         });
 
         // Distinguish between different error messages when saving
@@ -105,21 +109,15 @@ export abstract class CoreUserService<
     }
     return this.process(
       async () => {
-        // Update user
-        await Object.assign(dbObject, {
-          verified: true,
-          verificationToken: null,
-        }).save();
-
-        // Return prepared user
-        return dbObject;
+        // Update and return user
+        return await assignPlain(dbObject, { verified: true, verificationToken: null }).save();
       },
       { dbObject, serviceOptions }
     );
   }
 
   /**
-   * Set newpassword for user with token
+   * Set new password for user with token
    */
   async resetPassword(token: string, newPassword: string, serviceOptions?: ServiceOptions): Promise<TUser> {
     // Get user
@@ -130,14 +128,11 @@ export abstract class CoreUserService<
 
     return this.process(
       async () => {
-        // Update user
-        await Object.assign(dbObject, {
+        // Update and return user
+        return await assignPlain(dbObject, {
           password: await bcrypt.hash(newPassword, 10),
           passwordResetToken: null,
         }).save();
-
-        // Return user
-        return dbObject;
       },
       { dbObject, serviceOptions }
     );
@@ -154,13 +149,9 @@ export abstract class CoreUserService<
     }
     return this.process(
       async () => {
-        // Set reset token
-        const resetToken = crypto.randomBytes(32).toString('hex');
-        dbObject.passwordResetToken = resetToken;
-        await dbObject.save();
-
-        // Return user
-        return dbObject;
+        // Set reset token and return
+        dbObject.passwordResetToken = crypto.randomBytes(32).toString('hex');
+        return await dbObject.save();
       },
       { dbObject, serviceOptions }
     );
@@ -182,7 +173,7 @@ export abstract class CoreUserService<
 
     // Update and return user
     return this.process(
-      async (data) => {
+      async () => {
         return await this.mainDbModel.findByIdAndUpdate(userId, { roles }).exec();
       },
       { serviceOptions }

package/src/core.module.ts

@@ -1,15 +1,17 @@
-import { DynamicModule, Global, Module, UnauthorizedException } from '@nestjs/common';
+import { ApolloDriver, ApolloDriverConfig } from '@nestjs/apollo';
+import { DynamicModule, Global, MiddlewareConsumer, Module, NestModule, UnauthorizedException } from '@nestjs/common';
 import { APP_PIPE } from '@nestjs/core';
 import { GraphQLModule } from '@nestjs/graphql';
+import { MongooseModule } from '@nestjs/mongoose';
+import { Context } from 'apollo-server-core';
+import { graphqlUploadExpress } from 'graphql-upload';
 import { merge } from './core/common/helpers/config.helper';
 import { IServerOptions } from './core/common/interfaces/server-options.interface';
 import { MapAndValidatePipe } from './core/common/pipes/map-and-validate.pipe';
 import { ConfigService } from './core/common/services/config.service';
 import { EmailService } from './core/common/services/email.service';
-import { TemplateService } from './core/common/services/template.service';
-import { MongooseModule } from '@nestjs/mongoose';
 import { MailjetService } from './core/common/services/mailjet.service';
-import { ApolloDriver, ApolloDriverConfig } from '@nestjs/apollo';
+import { TemplateService } from './core/common/services/template.service';
 
 /**
  * Core module (dynamic)
@@ -26,7 +28,13 @@ import { ApolloDriver, ApolloDriverConfig } from '@nestjs/apollo';
  */
 @Global()
 @Module({})
-export class CoreModule {
+export class CoreModule implements NestModule {
+  /**
+   * Integrate middleware, e.g. GraphQL upload handing for express
+   */
+  configure(consumer: MiddlewareConsumer) {
+    consumer.apply(graphqlUploadExpress()).forRoutes('graphql');
+  }
   /**
    * Dynamic module
    * see https://docs.nestjs.com/modules#dynamic-modules
@@ -66,6 +74,28 @@ export class CoreModule {
                         }
                       },
                     },
+                    'graphql-ws': {
+                      onConnect: async (context: Context<any>) => {
+                        const { connectionParams, extra } = context;
+                        if (config.graphQl.enableSubscriptionAuth) {
+                          // get authToken from authorization header
+                          const authToken: string =
+                            'Authorization' in connectionParams && connectionParams?.Authorization?.split(' ')[1];
+                          if (authToken) {
+                            // verify authToken/getJwtPayLoad
+                            const payload = authService.decodeJwt(authToken);
+                            const user = await authService.validateUser(payload);
+                            // the user/jwtPayload object found will be available as context.currentUser/jwtPayload in your GraphQL resolvers
+                            extra.user = user;
+                            extra.header = connectionParams;
+                            return extra;
+                          }
+
+                          throw new UnauthorizedException();
+                        }
+                      },
+                      context: ({ extra }) => extra,
+                    },
                   },
                 },
                 options?.graphQl?.driver
@@ -113,7 +143,9 @@ export class CoreModule {
       module: CoreModule,
       imports: [
         MongooseModule.forRoot(config.mongoose.uri, config.mongoose.options),
-        GraphQLModule.forRootAsync<ApolloDriverConfig>(Object.assign({ driver: ApolloDriver }, config.graphQl.driver)),
+        GraphQLModule.forRootAsync<ApolloDriverConfig>(
+          Object.assign({ driver: ApolloDriver }, config.graphQl.driver, config.graphQl.options)
+        ),
       ],
       providers,
       exports: [ConfigService, EmailService, TemplateService, MailjetService],

package/src/main.ts

@@ -1,5 +1,6 @@
 import { NestFactory } from '@nestjs/core';
 import { NestExpressApplication } from '@nestjs/platform-express';
+import { exec } from 'child_process';
 import envConfig from './config.env';
 import { ServerModule } from './server/server.module';
 
@@ -25,6 +26,21 @@ async function bootstrap() {
 
   // Start server on configured port
   await server.listen(envConfig.port);
+
+  // Run command after server init
+  if (envConfig.execAfterInit) {
+    exec(envConfig.execAfterInit, (error, stdout, stderr) => {
+      if (error) {
+        console.error(`error: ${error.message}`);
+        return;
+      }
+
+      if (stderr) {
+        console.error(`stderr: ${stderr}`);
+        return;
+      }
+    });
+  }
 }
 
 // Start server

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

@@ -27,9 +27,8 @@ export class AuthModule {
             // providers: [] // Integrate additional Providers here to resolve dependencies
           },
         }),
-        EmailService,
       ],
-      providers: [AuthResolver, AuthService],
+      providers: [AuthResolver, AuthService, EmailService],
       exports: [AuthResolver, CoreAuthModule],
     };
   }

package/src/server/modules/file/file.controller.ts

@@ -32,6 +32,6 @@ export class FileController {
     })
   )
   uploadFile(@UploadedFiles() files, @Body() fields: any) {
-    console.log(files, fields);
+    console.log(JSON.stringify({ files, fields }, null, 2));
   }
 }

package/src/server/modules/file/file.resolver.ts

@@ -0,0 +1,55 @@
+import { Args, Mutation, Resolver } from '@nestjs/graphql';
+import { createWriteStream } from 'fs';
+import { FileUpload, GraphQLUpload } from 'graphql-upload';
+
+/**
+ * File resolver
+ */
+@Resolver()
+export class FileResolver {
+  /**
+   * Upload file
+   */
+  @Mutation(() => Boolean)
+  async uploadFile(
+    @Args({ name: 'file', type: () => GraphQLUpload })
+    file: FileUpload
+  ) {
+    console.log(JSON.stringify(file, null, 2));
+    /*
+    const {filename, mimetype, encoding, createReadStream} = file;
+    await new Promise((resolve, reject) =>
+      createReadStream()
+        .pipe(createWriteStream(`./uploads/${filename}`))
+        .on('finish', () => resolve(true))
+        .on('error', (error) => reject(error))
+    );
+    */
+    return true;
+  }
+
+  /**
+   * Upload files
+   */
+  @Mutation(() => Boolean)
+  async uploadFiles(
+    @Args({ name: 'files', type: () => [GraphQLUpload] })
+    files: FileUpload[]
+  ) {
+    const promises: Promise<any>[] = [];
+    for (const file of files) {
+      console.log(JSON.stringify(await file, null, 2));
+      /*
+      const {filename, mimetype, encoding, createReadStream} = await file
+      promises.push(new Promise((resolve, reject) =>
+        createReadStream()
+          .pipe(createWriteStream(`./uploads/${filename}`))
+          .on('finish', () => resolve(true))
+          .on('error', (error) => reject(error))
+      ));
+      */
+    }
+    await Promise.all(promises);
+    return true;
+  }
+}

package/src/server/modules/user/user.resolver.ts

@@ -145,7 +145,7 @@ export class UserResolver {
    */
   @Subscription(() => User, {
     filter(this: UserResolver, payload, variables, context) {
-      return context.user.roles.include(RoleEnum.ADMIN);
+      return context?.user?.hasRole?.(RoleEnum.ADMIN);
     },
     resolve: (user) => user,
   })

package/src/server/server.module.ts

@@ -1,10 +1,11 @@
 import { Module } from '@nestjs/common';
 import envConfig from '../config.env';
 import { CoreModule } from '../core.module';
+import { CoreAuthService } from '../core/modules/auth/services/core-auth.service';
 import { AuthModule } from './modules/auth/auth.module';
 import { FileController } from './modules/file/file.controller';
+import { FileResolver } from './modules/file/file.resolver';
 import { ServerController } from './server.controller';
-import { CoreAuthService } from '../core/modules/auth/services/core-auth.service';
 
 /**
  * Server module (dynamic)
@@ -26,6 +27,9 @@ import { CoreAuthService } from '../core/modules/auth/services/core-auth.service
   // Include REST controllers
   controllers: [FileController, ServerController],
 
+  // Include resolvers, services and other providers
+  providers: [FileResolver],
+
   // Export modules for reuse in other modules
   exports: [CoreModule, AuthModule],
 })