@lenne.tech/nest-server 3.1.2 → 3.3.0

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

@@ -2,8 +2,23 @@ import { ModelHelper } from '../helpers/model.helper';
 
 /**
  * Core Model
+ *
+ * HINT: All properties (in this class and all classes that extend this class) must be initialized with a default
+ * value or undefined otherwise the property will not be recognized via Object.keys (this is necessary for mapping).
+ * If the property is initialized with a default value (e.g. an empty array or boolean), there is a risk that the
+ * current value will be overwritten during mapping without this being intentional, so all values should be initialized
+ * with undefined if possible. If necessary and useful, the init method can then be used deliberately:
+ * const coreModel = item ? CoreModel.map(item).init() : CoreModel.init();
  */
 export abstract class CoreModel {
+  /**
+   * Static init method
+   */
+  public static init<T extends CoreModel>(this: new (...args: any[]) => T, ...args: any[]): T {
+    const item = new this();
+    return item.init(args);
+  }
+
   /**
    * Static map method
    */
@@ -13,6 +28,7 @@ export abstract class CoreModel {
     options: {
       cloneDeep?: boolean;
       funcAllowed?: boolean;
+      init?: boolean;
       item?: T;
       mapId?: boolean;
     } = {}
@@ -36,6 +52,7 @@ export abstract class CoreModel {
     options: {
       cloneDeep?: boolean;
       funcAllowed?: boolean;
+      init?: boolean;
       item?: T;
       mapId?: boolean;
     } = {}
@@ -45,6 +62,14 @@ export abstract class CoreModel {
     return item.mapDeep(data, options);
   }
 
+  /**
+   * Initialize instance with default values instead of undefined
+   * Should be overwritten in child class to organize the defaults
+   */
+  public init<T extends CoreModel>(...args: any[]): this {
+    return this;
+  }
+
   /**
    * Map method
    */
@@ -53,16 +78,18 @@ export abstract class CoreModel {
     options: {
       cloneDeep?: boolean;
       funcAllowed?: boolean;
+      init?: any;
       mapId?: boolean;
     } = {}
   ): this {
     const config = {
       cloneDeep: false,
       funcAllowed: false,
+      init: undefined,
       mapId: false,
       ...options,
     };
-    return ModelHelper.map(data, this, config);
+    return config.init ? ModelHelper.map(data, this, config).init(config.init) : ModelHelper.map(data, this, config);
   }
 
   /**
@@ -78,12 +105,14 @@ export abstract class CoreModel {
     options: {
       cloneDeep?: boolean;
       funcAllowed?: boolean;
+      init?: boolean;
       mapId?: boolean;
     } = {}
   ): this {
     const config = {
       cloneDeep: true,
       funcAllowed: false,
+      init: false,
       mapId: false,
       ...options,
     };

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

@@ -1,32 +1,38 @@
 import { Field, ID, ObjectType } from '@nestjs/graphql';
-import * as _ from 'lodash';
-import { ModelHelper } from '../helpers/model.helper';
 import { Prop, Schema } from '@nestjs/mongoose';
-import * as mongoose from 'mongoose';
+import { Types } from 'mongoose';
+import { CoreModel } from './core-model.model';
 
 /**
  * Metadata for persistent objects
  *
  * The models are a combination of Mongoose Entities and TypeGraphQL Types
+ *
+ * HINT: All properties (in this class and all classes that extend this class) must be initialized with a default
+ * value or undefined otherwise the property will not be recognized via Object.keys (this is necessary for mapping).
+ * If the property is initialized with a default value (e.g. an empty array or boolean), there is a risk that the
+ * current value will be overwritten during mapping without this being intentional, so all values should be initialized
+ * with undefined if possible. If necessary and useful, the init method can then be used deliberately:
+ * const corePersistenceModel = item ? CorePersistenceModel.map(item).init() : CorePersistenceModel.init();
  */
 @ObjectType({
   description: 'Persistence model which will be saved in DB',
   isAbstract: true,
 })
-@Schema()
-export abstract class CorePersistenceModel {
+@Schema({ timestamps: true })
+export abstract class CorePersistenceModel extends CoreModel {
   // ===========================================================================
   // Getter
   // ===========================================================================
+
   get _id() {
-    return new mongoose.Types.ObjectId(this.id);
+    return new Types.ObjectId(this.id);
   }
 
   // ===========================================================================
   // Properties
-  //
-  // TestFields: https://typegraphql.ml/docs/types-and-fields.html
   // ===========================================================================
+
   /**
    * ID of the persistence object as string
    */
@@ -37,11 +43,11 @@ export abstract class CorePersistenceModel {
   id: string = undefined;
 
   /**
-   * Created date
+   * Created date, is set automatically by mongoose
    */
   @Field({ description: 'Created date', nullable: true })
-  @Prop()
-  createdAt: Date = new Date();
+  @Prop({ onCreate: () => new Date() })
+  createdAt: Date = undefined;
 
   /**
    * Labels of the object
@@ -51,7 +57,7 @@ export abstract class CorePersistenceModel {
     nullable: true,
   })
   @Prop([String])
-  labels: string[] = [];
+  labels: string[] = undefined;
 
   /**
    * IDs of the Owners
@@ -61,7 +67,7 @@ export abstract class CorePersistenceModel {
     nullable: true,
   })
   @Prop([String])
-  ownerIds: string[] = [];
+  ownerIds: string[] = undefined;
 
   /**
    * Tags for the object
@@ -71,122 +77,29 @@ export abstract class CorePersistenceModel {
     nullable: true,
   })
   @Prop([String])
-  tags: string[] = [];
+  tags: string[] = undefined;
 
   /**
-   * Updated date
+   * Updated date is set automatically by mongoose
    */
   @Field({ description: 'Updated date', nullable: true })
   @Prop({ onUpdate: () => new Date() })
-  updatedAt: Date = new Date();
-
-  /**
-   * Static map method
-   */
-  public static map<T extends CorePersistenceModel>(
-    this: new (...args: any[]) => T,
-    data: Partial<T> | Record<string, any>,
-    options: {
-      cloneDeep?: boolean;
-      funcAllowed?: boolean;
-      item?: T;
-      mapId?: boolean;
-      merge?: boolean;
-    } = {}
-  ): T {
-    const item = options.item || new this();
-    delete options.item;
-    return item.map(data, options);
-  }
+  updatedAt: Date = undefined;
 
-  /**
-   * Static map deep method
-   *
-   * Alias for map with cloneDeep = true
-   *
-   * MapDeep prevents side effects, because objects will be cloned
-   * (cloneDeep = true), but it will be slower than a simple map
-   */
-  public static mapDeep<T extends CorePersistenceModel>(
-    this: new (...args: any[]) => T,
-    data: Partial<T> | Record<string, any>,
-    options: {
-      cloneDeep?: boolean;
-      funcAllowed?: boolean;
-      item?: T;
-      mapId?: boolean;
-      merge?: boolean;
-    } = {}
-  ): T {
-    const item = options.item || new this();
-    delete options.item;
-    return item.mapDeep(data, options);
-  }
+  // ===========================================================================
+  // Properties
+  // ===========================================================================
 
   /**
-   * Map method
+   * Initialize instance with default values instead of undefined
    */
-  public map(
-    data: Partial<this> | Record<string, any>,
-    options: {
-      cloneDeep?: boolean;
-      funcAllowed?: boolean;
-      mapId?: boolean;
-      merge?: boolean;
-    } = {}
-  ): this {
-    const config = {
-      cloneDeep: false,
-      funcAllowed: false,
-      mapId: false,
-      merge: false,
-      ...options,
-    };
-
-    // Prepare data
-    let preparedData = data;
-    preparedData = ModelHelper.prepareMap(preparedData, this, config);
-    if (config.cloneDeep) {
-      preparedData = _.cloneDeep(preparedData);
-    }
-
-    // Assign
-    if (this['assign'] !== 'function') {
-      if (!config.merge) {
-        Object.assign(this, preparedData);
-      }
-    } else {
-      this['assign'](preparedData, { mergeObjects: config.merge });
-    }
-
-    // Return
+  init() {
+    super.init();
+    this.createdAt = this.createdAt === undefined ? new Date() : this.createdAt;
+    this.labels = this.labels === undefined ? [] : this.labels;
+    this.ownerIds = this.ownerIds === undefined ? [] : this.ownerIds;
+    this.tags = this.tags === undefined ? [] : this.tags;
+    this.updatedAt = this.tags === undefined ? this.createdAt : this.updatedAt;
     return this;
   }
-
-  /**
-   * Map deep method
-   *
-   * Alias for map with cloneDeep = true
-   *
-   * MapDeep prevents side effects, because objects will be cloned
-   * (cloneDeep = true), but it will be slower than a simple map
-   */
-  public mapDeep(
-    data: Partial<this> | Record<string, any>,
-    options: {
-      cloneDeep?: boolean;
-      funcAllowed?: boolean;
-      mapId?: boolean;
-      merge?: boolean;
-    } = {}
-  ): this {
-    const config = {
-      cloneDeep: true,
-      funcAllowed: false,
-      mapId: false,
-      merge: false,
-      ...options,
-    };
-    return this.map(data, config);
-  }
 }

package/src/core/common/pipes/check-input.pipe.ts

@@ -1,16 +1,17 @@
-import { ArgumentMetadata, BadRequestException, Inject, Injectable, PipeTransform, Scope } from '@nestjs/common';
+import { ArgumentMetadata, Inject, Injectable, PipeTransform } from '@nestjs/common';
 import { CONTEXT } from '@nestjs/graphql';
-import { plainToClass } from 'class-transformer';
-import { validate, ValidationError } from 'class-validator';
-import { checkRestricted } from '../decorators/restricted.decorator';
 import { Context } from '../helpers/context.helper';
+import { InputHelper } from '../helpers/input.helper';
 
 /**
  * The CheckInputPipe checks the permissibility of individual properties of inputs for the resolvers
  * in relation to the current user
+ *
+ * ATTENTION: Pipe does not work yet, because context is missing: https://github.com/nestjs/graphql/issues/325
+ * Once this works MapAndValidate can be replaced in the CoreModule with this pipe.
  */
-@Injectable({ scope: Scope.REQUEST })
-export class CheckInputPipe implements PipeTransform<any> {
+@Injectable()
+export class CheckInputPipe implements PipeTransform {
   /**
    * Constructor to inject context
    */
@@ -19,35 +20,14 @@ export class CheckInputPipe implements PipeTransform<any> {
   /**
    * Check input
    */
-  async transform(value: any, { metatype }: ArgumentMetadata) {
-    // Return value if it is only a basic type
-    if (!metatype || this.isBasicType(metatype)) {
-      return value;
-    }
+  async transform(value: any, metadata: ArgumentMetadata) {
+    // Get meta type
+    const metatype = metadata?.metatype;
 
-    // Remove restricted values if roles are missing
+    // Get user
     const { user }: any = Context.getData(this.context);
-    value = checkRestricted(value, user);
 
-    // Validate value
-    const plainValue = JSON.parse(JSON.stringify(value));
-    const object = plainToClass(metatype, plainValue);
-    const errors: ValidationError[] = await validate(object);
-
-    // Check errors
-    if (errors.length > 0) {
-      throw new BadRequestException('Validation failed');
-    }
-
-    // Everything is ok
-    return value;
-  }
-
-  /**
-   * Checks if it is a basic type
-   */
-  protected isBasicType(metatype: any): boolean {
-    const types = [String, Boolean, Number, Array, Object, Buffer, ArrayBuffer];
-    return types.includes(metatype);
+    // Check and return
+    return InputHelper.check(value, user, metatype);
   }
 }

package/src/core/common/pipes/map-and-validate.pipe.ts

@@ -0,0 +1,32 @@
+import { PipeTransform, Injectable, ArgumentMetadata, BadRequestException } from '@nestjs/common';
+import { plainToInstance } from 'class-transformer';
+import { validate } from 'class-validator';
+import { InputHelper } from '../helpers/input.helper';
+
+@Injectable()
+export class MapAndValidatePipe implements PipeTransform {
+  async transform(value: any, metadata: ArgumentMetadata) {
+    const { metatype } = metadata;
+
+    if (typeof value !== 'object' || !metatype || InputHelper.isBasicType(metatype)) {
+      return value;
+    }
+
+    // Convert to metatype
+    if (!(value instanceof metatype)) {
+      if ((metatype as any)?.map) {
+        value = (metatype as any)?.map(value);
+      } else {
+        value = plainToInstance(metatype, value);
+      }
+    }
+
+    // Validate
+    const errors = await validate(value);
+    if (errors.length > 0) {
+      throw new BadRequestException('Input validation failed');
+    }
+
+    return value;
+  }
+}

package/src/core/common/types/plain-input.type.ts

@@ -0,0 +1,6 @@
+/**
+ * Type for plain Inputs
+ */
+export type PlainInput<T> = {
+  [P in keyof T]?: Partial<T[P]> | Partial<PlainInput<T[P]>>;
+};

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

@@ -1,10 +1,11 @@
 import { Field, ObjectType } from '@nestjs/graphql';
+import { CoreModel } from '../../common/models/core-model.model';
 
 /**
  * CoreAuth model for the response after the sign in
  */
 @ObjectType({ description: 'CoreAuth', isAbstract: true })
-export class CoreAuthModel {
+export class CoreAuthModel extends CoreModel {
   // ===================================================================================================================
   // Properties
   // ===================================================================================================================
@@ -14,4 +15,17 @@ export class CoreAuthModel {
    */
   @Field({ description: 'JavaScript Web Token (JWT)' })
   token: string = undefined;
+
+  // ===================================================================================================================
+  // Properties
+  // ===================================================================================================================
+
+  /**
+   * Initialize instance with default values instead of undefined
+   */
+  init() {
+    super.init();
+    // Nothing more to initialize yet
+    return this;
+  }
 }

package/src/core/modules/auth/core-auth.resolver.ts

@@ -20,7 +20,7 @@ export class CoreAuthResolver {
    * Get user via ID
    */
   @Query((returns) => CoreAuthModel, { description: 'Get JWT token' })
-  async signIn(@Args('email') email: string, @Args('password') password: string): Promise<CoreAuthModel> {
+  async signIn(@Args('email') email: string, @Args('password') password: string): Promise<Partial<CoreAuthModel>> {
     return await this.authService.signIn(email, password);
   }
 }

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

@@ -1,13 +1,16 @@
 import { Field, ObjectType } from '@nestjs/graphql';
 import { IsEmail, IsOptional } from 'class-validator';
+import { Document } from 'mongoose';
 import { CorePersistenceModel } from '../../common/models/core-persistence.model';
-import { Prop, Schema } from '@nestjs/mongoose';
+import { Prop, Schema as MongooseSchema } from '@nestjs/mongoose';
+
+export type CoreUserModelDocument = CoreUserModel & Document;
 
 /**
  * User model
  */
 @ObjectType({ description: 'User', isAbstract: true })
-@Schema()
+@MongooseSchema({ timestamps: true })
 export abstract class CoreUserModel extends CorePersistenceModel {
   // ===================================================================================================================
   // Properties
@@ -49,7 +52,7 @@ export abstract class CoreUserModel extends CorePersistenceModel {
   @Field((type) => [String], { description: 'Roles of the user', nullable: true })
   @IsOptional()
   @Prop()
-  roles: string[] = [];
+  roles: string[] = undefined;
 
   /**
    * Username of the user
@@ -76,8 +79,9 @@ export abstract class CoreUserModel extends CorePersistenceModel {
   /**
    * Verification of the user
    */
+  @Field((type) => Boolean, { description: 'Verification state of the user', nullable: true })
   @Prop({ type: Boolean })
-  verified = false;
+  verified: boolean = undefined;
 
   // ===================================================================================================================
   // Methods
@@ -108,4 +112,13 @@ export abstract class CoreUserModel extends CorePersistenceModel {
     }
     return !roles ? true : roles.every((role) => this.roles.includes(role));
   }
+
+  /**
+   * Initialize instance with default values instead of undefined
+   */
+  public init() {
+    super.init();
+    this.roles = this.roles === undefined ? [] : this.roles;
+    return this;
+  }
 }