@lenne.tech/nest-server 8.6.3 → 8.6.6

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lenne.tech/nest-server",
-  "version": "8.6.3",
+  "version": "8.6.6",
   "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",
@@ -53,60 +57,61 @@
   },
   "dependencies": {
     "@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/apollo": "10.0.12",
+    "@nestjs/common": "8.4.5",
+    "@nestjs/core": "8.4.5",
+    "@nestjs/graphql": "10.0.12",
+    "@nestjs/jwt": "8.0.1",
+    "@nestjs/mongoose": "9.1.0",
     "@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",
+    "light-my-request": "5.0.0",
     "lodash": "4.17.21",
-    "mongodb": "4.5.0",
-    "mongoose": "6.3.2",
+    "mongodb": "4.6.0",
+    "mongoose": "6.3.4",
     "multer": "1.4.4",
     "node-mailjet": "3.4.1",
     "nodemailer": "6.7.5",
     "nodemon": "2.0.16",
-    "passport": "0.5.2",
+    "passport": "0.5.3",
     "passport-jwt": "4.0.0",
     "reflect-metadata": "0.1.13",
     "rimraf": "3.0.2",
     "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-mailjet": "3.3.8",
+    "@types/node": "16.11.36",
+    "@types/node-mailjet": "3.3.9",
     "@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.25.0",
+    "@typescript-eslint/parser": "5.25.0",
     "coffeescript": "2.7.0",
-    "eslint": "8.15.0",
+    "eslint": "8.16.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",
@@ -114,7 +119,7 @@
     "supertest": "6.2.3",
     "ts-jest": "28.0.2",
     "ts-morph": "14.0.0",
-    "ts-node": "10.7.0",
+    "ts-node": "10.8.0",
     "tsconfig-paths": "4.0.0",
     "typescript": "4.6.4"
   },

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/decorators/restricted.decorator.ts

@@ -118,9 +118,8 @@ export const checkRestricted = (
 
       // Check roles
       if (roles.length) {
-        // Check roles
         if (
-          user?.hasRole(roles) ||
+          user?.hasRole?.(roles) ||
           (user?.id && roles.includes(RoleEnum.S_USER)) ||
           (roles.includes(RoleEnum.S_CREATOR) && getIncludedIds(config.dbObject?.createdBy, user))
         ) {

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

@@ -75,23 +75,21 @@ export function multerOptionsForImageUpload(options: {
   fileSize?: number;
   fileTypeRegex?: RegExp;
 }): MulterOptions {
-  // Default options
-  options = Object.assign(
-    {
-      fileSize: 1024 * 1024, // 1MB
-      fileTypeRegex: /jpeg|jpg|png/, // Images only
-    },
-    options
-  );
+  // Set config
+  const config = {
+    fileSize: 1024 * 1024, // 1MB
+    fileTypeRegex: /jpeg|jpg|png/, // Images only
+    ...options,
+  };
 
   return {
     // File filter
-    fileFilter: options.fileTypeRegex ? multerFileFilter(options.fileTypeRegex) : undefined,
+    fileFilter: config.fileTypeRegex ? multerFileFilter(config.fileTypeRegex) : undefined,
 
     // Limits
     limits: {
       // Limit of file size
-      fileSize: options.fileSize ? options.fileSize : undefined,
+      fileSize: config.fileSize ? config.fileSize : undefined,
     },
 
     // Automatic storage handling
@@ -100,7 +98,7 @@ export function multerOptionsForImageUpload(options: {
       // Destination for uploaded file
       // If destination is not set file will be buffered and can be processed
       // in the method
-      destination: options.destination ? options.destination : undefined,
+      destination: config.destination ? config.destination : undefined,
 
       // Generated random file name
       filename: multerRandomFileName(),

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

@@ -4,6 +4,8 @@ import { ComparisonOperatorEnum } from '../enums/comparison-operator.enum';
 import { LogicalOperatorEnum } from '../enums/logical-operator.enum';
 import { FilterInput } from '../inputs/filter.input';
 import { SortInput } from '../inputs/sort.input';
+import { getObjectIds } from './db.helper';
+import { assignPlain } from './input.helper';
 
 /**
  * Helper for filter handling
@@ -33,9 +35,72 @@ export class Filter {
   }
 }
 
+/**
+ * Helper function to create $and, $or or $nor filter
+ */
+export function findFilter(options?: {
+  conditions?: Record<string, any>[];
+  filterOptions?: FilterQuery<any>;
+  id?: any;
+  ids?: any[];
+  type?: '$and' | '$or' | '$nor';
+}): FilterQuery<any> {
+  const config = {
+    type: '$and',
+    ...options,
+  };
+
+  // Init filter Option
+  let filterOptions: FilterQuery<any> = config?.filterOptions;
+
+  // Check where condition
+  if (!filterOptions) {
+    filterOptions = {};
+    filterOptions[config.type] = [];
+  }
+
+  // Convert where condition to array
+  if (!Array.isArray(filterOptions?.[config.type])) {
+    filterOptions = {};
+    filterOptions[config.type] = [config?.filterOptions];
+  }
+
+  // ObjectId
+  if (config?.id) {
+    filterOptions[config.type].push({ _id: getObjectIds(config.id) });
+  }
+
+  // ObjectIds
+  if (config?.ids) {
+    if (!Array.isArray(config.ids)) {
+      config.ids = [config.ids];
+    }
+    filterOptions[config.type].push({ _id: { $in: getObjectIds(config.ids) } });
+  }
+
+  // Integrate conditions
+  if (config?.conditions) {
+    filterOptions[config.type] = [...filterOptions[config.type], ...config.conditions];
+  }
+
+  // Filter falsy values
+  filterOptions[config.type] = filterOptions[config.type].filter((value) => value);
+
+  // Optimizations
+  if (!filterOptions[config.type].length) {
+    filterOptions = {};
+  } else if (filterOptions[config.type].length === 1) {
+    const additionalProperties = filterOptions[config.type][0];
+    delete filterOptions[config.type];
+    assignPlain(filterOptions, additionalProperties);
+  }
+
+  // Return filter config
+  return filterOptions;
+}
+
 /**
  * Convert filter arguments to a query array
- * @param filterArgs
  */
 export function convertFilterArgsToQuery<T = any>(filterArgs: Partial<FilterArgs>): [FilterQuery<T>, QueryOptions] {
   return [generateFilterQuery(filterArgs?.filter), generateFindOptions(filterArgs)];

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

@@ -1,6 +1,7 @@
 import { BadRequestException, UnauthorizedException } from '@nestjs/common';
 import { plainToInstance } from 'class-transformer';
 import { validate } from 'class-validator';
+import { ValidatorOptions } from 'class-validator/types/validation/ValidatorOptions';
 import * as _ from 'lodash';
 import { checkRestricted } from '../decorators/restricted.decorator';
 import { ProcessType } from '../enums/process-type.enum';
@@ -182,6 +183,24 @@ export default class InputHelper {
   }
 }
 
+/**
+ * Assign plain objects to the target object and ignores undefined
+ */
+export function assignPlain(target: Record<any, any>, ...args: Record<any, any>[]): any {
+  return Object.assign(
+    target,
+    ...args.map(
+      // Prepare records
+      (item) =>
+        !item
+          ? // Return item if not an object
+            item
+          : // Return cloned record with undefined properties removed
+            filterProperties(JSON.parse(JSON.stringify(item)), (prop) => prop !== undefined)
+    )
+  );
+}
+
 /**
  * Check input
  */
@@ -194,11 +213,16 @@ export async function check(
     processType?: ProcessType;
     roles?: string | string[];
     throwError?: boolean;
+    validatorOptions?: ValidatorOptions;
   }
 ): Promise<any> {
   const config = {
     throwError: true,
     ...options,
+    validatorOptions: {
+      skipUndefinedProperties: true,
+      ...options?.validatorOptions,
+    },
   };
 
   // Check roles
@@ -212,7 +236,7 @@ export async function check(
       // check if user is logged in
       (roles.includes(RoleEnum.S_USER) && user?.id) ||
       // check if the user has at least one of the required roles
-      user.hasRole(roles) ||
+      user?.hasRole?.(roles) ||
       // check if the user is the creator
       (roles.includes(RoleEnum.S_CREATOR) && equalIds(config.dbObject?.createdBy, user))
     ) {
@@ -254,7 +278,7 @@ export async function check(
   }
 
   // Validate
-  const errors = await validate(value);
+  const errors = await validate(value, config.validatorOptions);
   if (errors.length > 0 && config.throwError) {
     throw new BadRequestException('Validation failed');
   }
@@ -264,6 +288,13 @@ export async function check(
   return value;
 }
 
+/**
+ * Combines objects to a new single plain object and ignores undefined
+ */
+export function combinePlain(...args: Record<any, any>[]): any {
+  return assignPlain({}, ...args);
+}
+
 /**
  * Standard error function
  */
@@ -273,6 +304,18 @@ export function errorFunction(caller: (...params) => any, message = 'Required pa
   throw err;
 }
 
+/**
+ * Filter function for objects
+ */
+export function filterProperties<T = Record<string, any>>(
+  obj: T,
+  filterFunction: (value?: any, key?: string, obj?: T) => boolean
+): Partial<T> {
+  return Object.keys(obj)
+    .filter((key) => filterFunction(obj[key], key, obj))
+    .reduce((res, key) => Object.assign(res, { [key]: obj[key] }), {});
+}
+
 /**
  * Check if parameter is an array
  */
@@ -433,6 +476,22 @@ export function returnFalse(): boolean {
   return false;
 }
 
+/**
+ * Match function to use instead of switch case
+ * Inspired by https://yusfuu.medium.com/dont-use-switch-or-if-else-in-javascript-instead-try-this-82f32616c269
+ *
+ * Example:
+ * const matched = match(expr, {
+ *   Oranges: 'Oranges are $0.59 a pound.',
+ *   Mangoes: 'Mangoes and papayas are $2.79 a pound.',
+ *   Papayas: 'Mangoes and papayas are $2.79 a pound.',
+ *   default: `Sorry, we are out of ${expr}.`,
+ * });
+ */
+export function match(expression: any, cases: Record<any, any>): any {
+  return cases[expression] || cases?.default;
+}
+
 /**
  * Map values into specific type
  */

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

@@ -68,7 +68,7 @@ export async function prepareInput<T = any>(
     clone: false,
     create: false,
     getNewArray: false,
-    removeUndefined: false,
+    removeUndefined: true,
     ...options,
   };
 
@@ -107,11 +107,7 @@ export async function prepareInput<T = any>(
   }
 
   // Process roles
-  if (
-    config.checkRoles &&
-    (input as Record<string, any>).roles &&
-    (!currentUser?.hasRole || !currentUser.hasRole(RoleEnum.ADMIN))
-  ) {
+  if (config.checkRoles && (input as Record<string, any>).roles && !currentUser?.hasRole?.(RoleEnum.ADMIN)) {
     if (!(currentUser as any)?.roles) {
       throw new UnauthorizedException('Missing roles of current user');
     } else {

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/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

@@ -150,7 +150,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);