@lenne.tech/nest-server 8.6.2 → 8.6.5

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lenne.tech/nest-server",
-  "version": "8.6.2",
+  "version": "8.6.5",
   "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",
@@ -16,6 +16,9 @@
   "scripts": {
     "build": "rimraf dist && tsc -p tsconfig.build.json",
     "build:pack": "npm pack && echo 'use file:/ROOT_PATH_TO_TGZ_FILE to integrate the package'",
+    "docs": "npm run docs:ci && open ./public/index.html",
+    "docs:bootstrap": "node extras/update-spectaql-version.mjs && npx -y spectaql ./spectaql.yml",
+    "docs:ci": "ts-node ./scripts/init-server.ts && npm run docs:boostrap",
     "format": "prettier --write 'src/**/*.ts'",
     "format:staged": "pretty-quick --staged",
     "lint": "eslint \"{src,apps,libs,test}/**/*.ts\" --fix",
@@ -32,9 +35,10 @@
     "test": "NODE_ENV=local jest",
     "test:cov": "NODE_ENV=local jest --coverage",
     "test:debug": "NODE_ENV=local node --inspect-brk -r tsconfig-paths/register -r ts-node/register node_modules/.bin/jest --runInBand",
-    "test:e2e": "NODE_ENV=local jest --config jest-e2e.json --forceExit --detectOpenHandles",
-    "test:e2e-cov": "NODE_ENV=local jest --config jest-e2e.json --coverage --forceExit --detectOpenHandles",
-    "test:ci": "NODE_ENV=local jest --config jest-e2e.json --ci --forceExit --detectOpenHandles",
+    "test:e2e": "NODE_ENV=local jest --config jest-e2e.json --forceExit",
+    "test:e2e-cov": "NODE_ENV=local jest --config jest-e2e.json --coverage --forceExit",
+    "test:e2e-doh": "NODE_ENV=local jest --config jest-e2e.json --forceExit --detectOpenHandles",
+    "test:ci": "NODE_ENV=local jest --config jest-e2e.json --ci --forceExit",
     "test:watch": "NODE_ENV=local jest --watch",
     "prepack": "npm run prestart:prod",
     "prepare": "husky install",
@@ -54,26 +58,27 @@
   "dependencies": {
     "@apollo/gateway": "0.50.2",
     "@nestjs/apollo": "10.0.11",
-    "@nestjs/common": "8.4.4",
-    "@nestjs/core": "8.4.4",
+    "@nestjs/common": "8.4.5",
+    "@nestjs/core": "8.4.5",
     "@nestjs/graphql": "10.0.11",
     "@nestjs/jwt": "8.0.0",
     "@nestjs/mongoose": "9.0.3",
     "@nestjs/passport": "8.2.1",
-    "@nestjs/platform-express": "8.4.4",
+    "@nestjs/platform-express": "8.4.5",
     "apollo-server-core": "3.7.0",
     "apollo-server-express": "3.7.0",
     "bcrypt": "5.0.1",
     "class-transformer": "0.5.1",
     "class-validator": "0.13.2",
-    "ejs": "3.1.7",
-    "graphql": "16.4.0",
+    "ejs": "3.1.8",
+    "graphql": "16.5.0",
     "graphql-subscriptions": "2.0.0",
+    "graphql-upload": "13.0.0",
     "json-to-graphql-query": "2.2.4",
     "light-my-request": "4.10.1",
     "lodash": "4.17.21",
-    "mongodb": "4.5.0",
-    "mongoose": "6.3.2",
+    "mongodb": "4.6.0",
+    "mongoose": "6.3.3",
     "multer": "1.4.4",
     "node-mailjet": "3.4.1",
     "nodemailer": "6.7.5",
@@ -85,28 +90,28 @@
     "rxjs": "7.5.5"
   },
   "devDependencies": {
-    "@nestjs/testing": "8.4.4",
-    "@types/ejs": "3.1.0",
-    "@types/jest": "27.5.0",
+    "@nestjs/testing": "8.4.5",
+    "@types/ejs": "3.1.1",
+    "@types/jest": "27.5.1",
     "@types/lodash": "4.14.182",
     "@types/multer": "1.4.7",
-    "@types/node": "16.11.33",
+    "@types/node": "16.11.35",
     "@types/node-mailjet": "3.3.8",
     "@types/nodemailer": "6.4.4",
     "@types/passport": "1.0.7",
     "@types/supertest": "2.0.12",
-    "@typescript-eslint/eslint-plugin": "5.22.0",
-    "@typescript-eslint/parser": "5.22.0",
+    "@typescript-eslint/eslint-plugin": "5.23.0",
+    "@typescript-eslint/parser": "5.23.0",
     "coffeescript": "2.7.0",
     "eslint": "8.15.0",
     "eslint-config-prettier": "8.5.0",
     "find-file-up": "2.0.1",
-    "grunt": "1.5.2",
+    "grunt": "1.5.3",
     "grunt-bg-shell": "2.3.3",
     "grunt-contrib-clean": "2.0.1",
     "grunt-contrib-watch": "1.1.0",
     "grunt-sync": "0.8.2",
-    "husky": "7.0.4",
+    "husky": "8.0.1",
     "jest": "28.1.0",
     "pm2": "5.2.0",
     "prettier": "2.6.2",

package/src/config.env.ts

@@ -31,6 +31,7 @@ const config: { [env: string]: IServerOptions } = {
       passwordResetLink: 'http://localhost:4200/user/password-reset',
     },
     env: 'development',
+    execAfterInit: 'npm run docs:bootstrap',
     graphQl: {
       driver: {
         debug: true,
@@ -46,7 +47,7 @@ const config: { [env: string]: IServerOptions } = {
     port: 3000,
     staticAssets: {
       path: join(__dirname, '..', 'public'),
-      options: { prefix: '/public/' },
+      options: { prefix: '' },
     },
     templates: {
       path: join(__dirname, 'templates'),
@@ -80,6 +81,7 @@ const config: { [env: string]: IServerOptions } = {
       passwordResetLink: 'http://localhost:4200/user/password-reset',
     },
     env: 'productive',
+    execAfterInit: 'npm run docs:bootstrap',
     graphQl: {
       driver: {
         debug: false,
@@ -95,7 +97,7 @@ const config: { [env: string]: IServerOptions } = {
     port: 3000,
     staticAssets: {
       path: join(__dirname, '..', 'public'),
-      options: { prefix: '/public/' },
+      options: { prefix: '' },
     },
     templates: {
       path: join(__dirname, 'templates'),

package/src/core/common/inputs/filter.input.ts

@@ -1,5 +1,4 @@
 import { Field, InputType } from '@nestjs/graphql';
-import { ModelHelper } from '../helpers/model.helper';
 import { CombinedFilterInput } from './combined-filter.input';
 import { CoreInput } from './core-input.input';
 import { SingleFilterInput } from './single-filter.input';

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.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/modules/user/user.service.ts

@@ -50,7 +50,7 @@ export class UserService extends CoreUserService<User, UserInput, UserCreateInpu
     // and could not exist as currentUser before
     if (!user.createdBy) {
       await this.mainDbModel.findByIdAndUpdate(user.id, { createdBy: user.id });
-      user = await this.get(user.id, { ...serviceOptions, currentUser: serviceOptions.currentUser || user });
+      user = await this.get(user.id, { ...serviceOptions, currentUser: serviceOptions?.currentUser || user });
     }
 
     // Publish action

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],
 })

package/src/test/test.helper.ts

@@ -1,9 +1,11 @@
 import { INestApplication } from '@nestjs/common';
+import { createClient } from 'graphql-ws';
 // import { FastifyInstance } from 'fastify';
 import { jsonToGraphQLQuery } from 'json-to-graphql-query';
 import * as LightMyRequest from 'light-my-request';
 import * as supertest from 'supertest';
 import * as util from 'util';
+import * as ws from 'ws';
 
 /**
  * GraphQL request type
@@ -64,6 +66,11 @@ export interface TestGraphQLOptions {
    */
   convertEnums?: boolean | string[];
 
+  /**
+   * Count of subscription messages, specifies how many messages are to be received on subscription
+   */
+  countOfSubscriptionMessages?: number;
+
   /**
    * Print console logs
    */
@@ -104,11 +111,16 @@ export class TestHelper {
   // app: FastifyInstance | INestApplication;
   app: INestApplication;
 
+  // URL with port and directory to subscription endpoint
+  // e.g.: ws://localhost:3030/graphql
+  subscriptionUrl: string;
+
   /**
    * Constructor
    */
-  constructor(app: any) {
+  constructor(app: any, subscriptionUrl?: string) {
     this.app = app;
+    this.subscriptionUrl = subscriptionUrl;
   }
 
   /**
@@ -121,6 +133,7 @@ export class TestHelper {
     options = Object.assign(
       {
         convertEnums: true,
+        countOfSubscriptionMessages: 1,
         token: null,
         statusCode: 200,
         log: false,
@@ -174,6 +187,10 @@ export class TestHelper {
       query = jsonToGraphQLQuery(queryObj, { pretty: true });
     }
 
+    if ((graphql as TestGraphQLConfig).type === TestGraphQLType.SUBSCRIPTION) {
+      return this.getSubscription(graphql as TestGraphQLConfig, query, options);
+    }
+
     // Convert uppercase strings in arguments of query to enums
     if (options.convertEnums) {
       if (Array.isArray(options.convertEnums)) {
@@ -354,7 +371,7 @@ export class TestHelper {
 
     // Log response
     if (log) {
-      console.log(response);
+      console.log(JSON.stringify(response, null, 2));
     }
 
     // Log error
@@ -373,4 +390,52 @@ export class TestHelper {
     // Return response
     return response;
   }
+
+  /**
+   * Get subscription
+   */
+  async getSubscription(graphql: TestGraphQLConfig, query: string, options?: TestGraphQLOptions) {
+    // Check url
+    if (!this.subscriptionUrl) {
+      throw new Error("Missing subscriptionUrl in TestHelper: new TestHelper(app, 'ws://localhost:3030/graphql')");
+    }
+
+    // Prepare subscription
+    let connectionParams;
+    if (options?.token) {
+      connectionParams = { Authorization: `Bearer ${options?.token}` };
+    }
+
+    // Init client
+    if (options.log) {
+      console.log('Subscription query', JSON.stringify(query, null, 2));
+    }
+    const client = createClient({ url: this.subscriptionUrl, connectionParams, webSocketImpl: ws });
+    const messages: any[] = [];
+    let unsubscribe: () => void;
+    const onNext = (message) => {
+      if (options.log) {
+        console.log('Subscription message', JSON.stringify(message, null, 2));
+      }
+      messages.push(message?.data?.[graphql.name]);
+      if (messages.length <= options.countOfSubscriptionMessages) {
+        unsubscribe();
+      }
+    };
+
+    // Subscribe
+    await new Promise((resolve, reject) => {
+      unsubscribe = client.subscribe(
+        { query },
+        {
+          next: onNext,
+          error: reject,
+          complete: resolve as any,
+        }
+      );
+    });
+
+    // Return subscribed messages
+    return messages;
+  }
 }