@lenne.tech/nest-server 8.0.2 → 8.3.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lenne.tech/nest-server",
-  "version": "8.0.2",
+  "version": "8.3.0",
   "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",
@@ -20,7 +20,7 @@
     "format:staged": "pretty-quick --staged",
     "lint": "eslint \"{src,apps,libs,test}/**/*.ts\" --fix",
     "prestart:prod": "npm run build",
-    "reinit": "rimraf package-lock.json && rimraf node_modules && npm cache clean --force && npm i && npm run test:e2e",
+    "reinit": "rimraf package-lock.json && rimraf node_modules && npm cache clean --force && npm i && npm run test:e2e && npm run build",
     "reinit:force": "rimraf package-lock.json && rimraf node_modules && npm cache clean --force && npm i --force && npm run test:e2e",
     "reinit:legacy": "rimraf package-lock.json && rimraf node_modules && npm cache clean --force && npm i --legacy-peer-deps && npm run test:e2e",
     "start": "./node_modules/.bin/grunt",
@@ -29,13 +29,13 @@
     "start:nodemon": "ts-node -r tsconfig-paths/register src/main.ts",
     "start:debug": "nodemon --config nodemon-debug.json",
     "start:dev": "nodemon",
-    "test": "jest",
-    "test:cov": "jest --coverage",
-    "test:debug": "node --inspect-brk -r tsconfig-paths/register -r ts-node/register node_modules/.bin/jest --runInBand",
-    "test:e2e": "jest --detectOpenHandles --config jest-e2e.json",
-    "test:e2e-cov": "jest --detectOpenHandles --config jest-e2e.json --coverage",
-    "test:ci": "jest --detectOpenHandles --config jest-e2e.json --ci",
-    "test:watch": "jest --watch",
+    "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",
+    "test:e2e-cov": "NODE_ENV=local jest --config jest-e2e.json --coverage",
+    "test:ci": "NODE_ENV=local jest --config jest-e2e.json --ci",
+    "test:watch": "NODE_ENV=local jest --watch",
     "prepack": "npm run prestart:prod",
     "prepare": "husky install",
     "prepublishOnly": "npm run format && npm run lint && npm run test:ci",
@@ -52,72 +52,71 @@
     "node": ">= 16.13.0"
   },
   "dependencies": {
-    "@apollo/gateway": "0.48.3",
-    "@nestjs/apollo": "10.0.8",
-    "@nestjs/common": "8.4.2",
-    "@nestjs/core": "8.4.2",
-    "@nestjs/graphql": "10.0.8",
+    "@apollo/gateway": "0.50.2",
+    "@nestjs/apollo": "10.0.11",
+    "@nestjs/common": "8.4.4",
+    "@nestjs/core": "8.4.4",
+    "@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.2",
-    "@nestjs/testing": "8.4.2",
-    "@types/ejs": "3.1.0",
-    "@types/jest": "27.4.1",
-    "@types/lodash": "4.14.180",
-    "@types/multer": "1.4.7",
-    "@types/node": "17.0.22",
-    "@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.16.0",
-    "@typescript-eslint/parser": "5.16.0",
-    "apollo-server-core": "3.6.5",
-    "apollo-server-express": "3.6.5",
+    "@nestjs/platform-express": "8.4.4",
+    "apollo-server-core": "3.6.8",
+    "apollo-server-express": "3.6.8",
     "bcrypt": "5.0.1",
     "class-transformer": "0.5.1",
     "class-validator": "0.13.2",
-    "coffeescript": "2.6.1",
-    "ejs": "3.1.6",
-    "eslint": "8.11.0",
-    "eslint-config-prettier": "8.5.0",
-    "fastify": "3.27.4",
-    "graphql": "16.3.0",
+    "ejs": "3.1.7",
+    "graphql": "16.4.0",
     "graphql-subscriptions": "2.0.0",
-    "grunt": "1.4.1",
-    "grunt-bg-shell": "2.3.3",
-    "grunt-contrib-clean": "2.0.0",
-    "grunt-contrib-watch": "1.1.0",
-    "grunt-sync": "0.8.2",
-    "husky": "7.0.4",
-    "jest": "27.5.1",
-    "json-to-graphql-query": "2.2.3",
-    "light-my-request": "4.8.0",
+    "json-to-graphql-query": "2.2.4",
+    "light-my-request": "4.10.1",
     "lodash": "4.17.21",
-    "mongodb": "4.4.1",
-    "mongoose": "6.2.8",
+    "mongodb": "4.5.0",
+    "mongoose": "6.3.2",
     "multer": "1.4.4",
-    "node-mailjet": "3.3.7",
-    "nodemailer": "6.7.3",
-    "nodemon": "2.0.15",
+    "node-mailjet": "3.4.1",
+    "nodemailer": "6.7.5",
+    "nodemon": "2.0.16",
     "passport": "0.5.2",
     "passport-jwt": "4.0.0",
-    "prettier": "2.6.0",
-    "pretty-quick": "3.1.3",
     "reflect-metadata": "0.1.13",
     "rimraf": "3.0.2",
-    "rxjs": "7.5.5",
-    "supertest": "6.2.2",
-    "ts-jest": "27.1.3",
-    "ts-morph": "13.0.3",
-    "ts-node": "10.7.0",
-    "tsconfig-paths": "3.14.1",
-    "typescript": "4.6.2"
+    "rxjs": "7.5.5"
   },
   "devDependencies": {
+    "@nestjs/testing": "8.4.4",
+    "@types/ejs": "3.1.0",
+    "@types/jest": "27.5.0",
+    "@types/lodash": "4.14.182",
+    "@types/multer": "1.4.7",
+    "@types/node": "16.11.33",
+    "@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",
+    "coffeescript": "2.7.0",
+    "eslint": "8.14.0",
+    "eslint-config-prettier": "8.5.0",
     "find-file-up": "2.0.1",
-    "pm2": "5.2.0"
+    "grunt": "1.5.2",
+    "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",
+    "jest": "28.0.3",
+    "pm2": "5.2.0",
+    "prettier": "2.6.2",
+    "pretty-quick": "3.1.3",
+    "supertest": "6.2.3",
+    "ts-jest": "28.0.1",
+    "ts-morph": "14.0.0",
+    "ts-node": "10.7.0",
+    "tsconfig-paths": "4.0.0",
+    "typescript": "4.6.4"
   },
   "jest": {
     "collectCoverage": true,

package/src/config.env.ts

@@ -109,8 +109,9 @@ const config: { [env: string]: IServerOptions } = {
  *
  * default: development
  */
-const envConfig = config[process.env['NODE' + '_ENV'] || 'development'] || config.development;
-console.log('Server starts in mode: ', process.env['NODE' + '_ENV'] || 'development');
+const env = process.env['NODE' + '_ENV'] || 'development';
+const envConfig = config[env] || config.development;
+console.log('Configured for: ' + envConfig.env + (env !== envConfig.env ? ' (requested: ' + env + ')' : ''));
 
 /**
  * Export envConfig as default

package/src/core/common/args/pagination.args.ts

@@ -1,6 +1,6 @@
 import { IsOptional, Max } from 'class-validator';
 import { ArgsType, Field, Int } from '@nestjs/graphql';
-import { ModelHelper } from '../helpers/model.helper';
+import { maps } from '../helpers/model.helper';
 import { CoreInput } from '../inputs/core-input.input';
 import { SortInput } from '../inputs/sort.input';
 
@@ -90,7 +90,7 @@ export class PaginationArgs extends CoreInput {
     } = {}
   ): this {
     super.map(data, options);
-    this.sort = ModelHelper.maps(data.sort, SortInput, options.cloneDeep);
+    this.sort = maps(data.sort, SortInput, options.cloneDeep);
     Object.keys(this).forEach((key) => this[key] === undefined && delete this[key]);
     return this;
   }

package/src/core/common/decorators/restricted.decorator.ts

@@ -1,6 +1,8 @@
 import 'reflect-metadata';
 import { UnauthorizedException } from '@nestjs/common';
 import { RoleEnum } from '../enums/role.enum';
+import { equalIds, getStringIds } from '../helpers/db.helper';
+import { IdsType } from '../types/ids.type';
 
 /**
  * Restricted meta key
@@ -28,11 +30,14 @@ export const getRestricted = (object: unknown, propertyKey: string) => {
 
 /**
  * Check data for restricted properties (properties with `Restricted` decorator)
+ *
+ * If restricted roles includes RoleEnum.S_CREATOR, `creator` (createdBy) from current (DB) data must be set in options
+ * If restricted roles includes RoleEnum.S_OWNER, `ownerIds` from current (DB) data must be set in options
  */
 export const checkRestricted = (
   data: any,
   user: { id: any; hasRole: (roles: string[]) => boolean },
-  options: { ignoreUndefined?: boolean; throwError?: boolean } = {},
+  options: { creator?: IdsType; ignoreUndefined?: boolean; ownerIds?: IdsType; throwError?: boolean } = {},
   processedObjects: any[] = []
 ) => {
   const config = {
@@ -55,7 +60,7 @@ export const checkRestricted = (
   // Array
   if (Array.isArray(data)) {
     // Check array items
-    return data.map((item) => checkRestricted(item, user, options, processedObjects));
+    return data.map((item) => checkRestricted(item, user, config, processedObjects));
   }
 
   // Object
@@ -72,20 +77,27 @@ export const checkRestricted = (
     if (roles && roles.some((value) => !!value)) {
       // Check user and user roles
       if (!user || !user.hasRole(roles)) {
-        // Check special role for owner
-        if (user && roles.includes(RoleEnum.OWNER)) {
-          const userId = user.id.toString();
+        // Check special creator role
+        if (user?.id && roles.includes(RoleEnum.S_CREATOR) && equalIds(user.id, config.creator)) {
+          continue;
+        }
+
+        // Check special owner role
+        else if (user && roles.includes(RoleEnum.S_OWNER)) {
+          const userId = getStringIds(user);
+          const ownerIds = config.ownerIds ? getStringIds(config.ownerIds) : null;
 
           if (
-            !data.ownerIds ||
-            !(
-              data.ownerIds === userId ||
-              (Array.isArray(data.ownerIds) &&
-                data.ownerIds.some((item) => (item.id ? item.id.toString() === userId : item.toString() === userId)))
-            )
+            // No owner IDs
+            !ownerIds ||
+            // User is not the owner
+            !(ownerIds === userId || (Array.isArray(ownerIds) && ownerIds.includes(userId)))
           ) {
             // The user does not have the required rights and is not the owner
             if (config.throwError) {
+              if (!config.ownerIds) {
+                throw new UnauthorizedException('Lack of ownerIds to verify ownership of ' + propertyKey);
+              }
               throw new UnauthorizedException('Current user is not allowed to set ' + propertyKey);
             }
             continue;
@@ -101,7 +113,7 @@ export const checkRestricted = (
     }
 
     // Check property data
-    data[propertyKey] = checkRestricted(data[propertyKey], user, options, processedObjects);
+    data[propertyKey] = checkRestricted(data[propertyKey], user, config, processedObjects);
   }
 
   // Return processed data

package/src/core/common/enums/role.enum.ts

@@ -2,12 +2,30 @@
  * Enums for role decorator
  */
 export enum RoleEnum {
-  // User must be an administrator
+  // ===================================================================================================================
+  // Real roles (integrated into user.roles), which can be used via @Roles for Models (properties)
+  // and Resolvers (methods)
+  // ===================================================================================================================
+
+  // User must be an administrator (see roles of user)
   ADMIN = 'admin',
 
-  // User must be the owner of the processed object(s)
-  OWNER = 'owner',
+  // ===================================================================================================================
+  // Special system roles, which can be used via @Roles for Models (properties) and Resolvers (methods)
+  // and via ServiceOptions for Resolver methods. This roles should not be integrated into user.roles!
+  // ===================================================================================================================
+
+  // User must be signed in (see context user, e.g. @GraphQLUser)
+  S_USER = 's_user',
+
+  // ===================================================================================================================
+  // Special system roles that check rights for DB objects and can be used via @Roles for Models (properties)
+  // and via ServiceOptions for Resolver methods. These roles should not be integrated in user.roles!
+  // ===================================================================================================================
+
+  // User must be the creator of the processed object(s) (see createdBy property of object(s))
+  S_CREATOR = 's_creator',
 
-  // User must be signed in
-  USER = 'user',
+  // User must be an owner of the processed object(s) (see owners property of object(s))
+  S_OWNER = 's_owner',
 }

package/src/core/common/helpers/config.helper.ts

@@ -2,8 +2,9 @@ import * as _ from 'lodash';
 
 /**
  * Helper class for configurations
+ * @deprecated use functions directly
  */
-export class Config {
+export default class Config {
   /**
    * Special merge function (e.g. for configurations)
    *
@@ -19,10 +20,29 @@ export class Config {
    * @returns {any}
    */
   public static merge(obj: Record<string, any>, ...sources: any[]): any {
-    return _.mergeWith(obj, ...sources, (objValue: any, srcValue: any) => {
-      if (Array.isArray(srcValue)) {
-        return srcValue;
-      }
-    });
+    return merge(obj, sources);
   }
 }
+
+/**
+ * Special merge function (e.g. for configurations)
+ *
+ * It acts like the merge function of lodash:
+ * - Source objects are merged into the destination object
+ * - Source objects are applied from left to right
+ * - Subsequent sources overwrite property assignments of previous sources
+ *
+ * except that arrays are not merged but overwrite arrays of previous sources.
+ *
+ * @param {any} obj destination object
+ * @param {any[]} sources source objects
+ * @returns {any}
+ */
+
+export function merge(obj: Record<string, any>, ...sources: any[]): any {
+  return _.mergeWith(obj, ...sources, (objValue: any, srcValue: any) => {
+    if (Array.isArray(srcValue)) {
+      return srcValue;
+    }
+  });
+}

package/src/core/common/helpers/context.helper.ts

@@ -3,48 +3,57 @@ import { GqlExecutionContext } from '@nestjs/graphql';
 
 /**
  * Helper for context processing
+ * @deprecated use functions directly
  */
-export class Context {
+export default class Context {
   /**
    * Get data from Context
+   * @deprecated use getContextData function
    */
   public static getData(context: ExecutionContext): { currentUser: { [key: string]: any }; args: any } {
-    // Check context
-    if (!context) {
-      return { currentUser: null, args: null };
-    }
+    return getContextData(context);
+  }
+}
 
-    // Init data
-    let user: { [key: string]: any };
-    let ctx: any = null;
-    try {
-      ctx = GqlExecutionContext.create(context)?.getContext();
-    } catch (e) {
-      // console.log(e);
-    }
+/**
+ * Get data from Context
+ */
+export function getContextData(context: ExecutionContext): { currentUser: { [key: string]: any }; args: any } {
+  // Check context
+  if (!context) {
+    return { currentUser: null, args: null };
+  }
 
-    let args: any;
-    try {
-      args = GqlExecutionContext.create(context)?.getArgs();
-    } catch (e) {
-      // console.log(e);
-    }
+  // Init data
+  let user: { [key: string]: any };
+  let ctx: any = null;
+  try {
+    ctx = GqlExecutionContext.create(context)?.getContext();
+  } catch (e) {
+    // console.log(e);
+  }
+
+  let args: any;
+  try {
+    args = GqlExecutionContext.create(context)?.getArgs();
+  } catch (e) {
+    // console.log(e);
+  }
 
-    // Get data
-    if (ctx) {
-      // User from GraphQL context
-      user = ctx?.user || ctx?.req?.user;
-    } else {
-      const request = context?.switchToHttp ? context.switchToHttp()?.getRequest() : null;
-      if (request) {
-        args = request.body;
+  // Get data
+  if (ctx) {
+    // User from GraphQL context
+    user = ctx?.user || ctx?.req?.user;
+  } else {
+    const request = context?.switchToHttp ? context.switchToHttp()?.getRequest() : null;
+    if (request) {
+      args = request.body;
 
-        // User from REST context
-        user = request.user;
-      }
+      // User from REST context
+      user = request.user;
     }
-
-    // Return data
-    return { currentUser: user, args };
   }
+
+  // Return data
+  return { currentUser: user, args };
 }