@lenne.tech/nest-server 8.3.1 → 8.6.0

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

@@ -1,6 +1,7 @@
-import { Model, Types } from 'mongoose';
+import { Model } from 'mongoose';
 import { FieldSelection } from '../types/field-selection.type';
-import { IdsType } from '../types/ids.type';
+import { PrepareInputOptions } from './prepare-input-options.interface';
+import { PrepareOutputOptions } from './prepare-output-options.interface';
 
 /**
  * General service options
@@ -14,7 +15,7 @@ export interface ServiceOptions {
   // If truly (default): input data will be checked
   checkRights?: boolean;
 
-  // Current user to set ownership, check roles and other things
+  // Current user to set ownership, check rights and other things
   currentUser?: {
     [key: string]: any;
     id: string;
@@ -27,8 +28,8 @@ export interface ServiceOptions {
   // Overwrites type of input (array items)
   inputType?: new (...params: any[]) => any;
 
-  // Owner IDs
-  ownerIds?: IdsType;
+  // Overwrites type of output (array items)
+  outputType?: new (...params: any[]) => any;
 
   // Process field selection
   // If {} or not set, then the field selection runs with defaults
@@ -41,31 +42,16 @@ export interface ServiceOptions {
   // Prepare input configuration:
   // If {} or not set, then the prepareInput function will run with defaults
   // If falsy, then the prepareInput function is not executed
-  prepareInput?: {
-    [key: string]: any;
-    create?: boolean;
-    clone?: boolean;
-    getNewArray?: boolean;
-    removeUndefined?: boolean;
-  };
+  prepareInput?: PrepareInputOptions;
 
   // Prepare output configuration:
   // If {} or not set, then the prepareInput function will run with defaults
   // If falsy, then the prepareInput function is not executed
-  prepareOutput?: {
-    [key: string]: any;
-    clone?: boolean;
-    getNewArray?: boolean;
-    removeUndefined?: boolean;
-    targetModel?: new (...args: any[]) => any;
-  };
+  prepareOutput?: PrepareOutputOptions;
 
   // Whether to publish action via GraphQL subscription
   pubSub?: boolean;
 
-  // Overwrites type of result (array items)
-  resultType?: new (...params: any[]) => any;
-
   // Roles (as string) to check
   roles?: string | string[];
 }

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

@@ -59,16 +59,6 @@ export abstract class CorePersistenceModel extends CoreModel {
   @Prop([String])
   labels: string[] = undefined;
 
-  /**
-   * IDs of the Owners
-   */
-  @Field((type) => [String], {
-    description: 'Users who own the object',
-    nullable: true,
-  })
-  @Prop([String])
-  ownerIds: string[] = undefined;
-
   /**
    * Tags for the object
    */
@@ -97,7 +87,6 @@ export abstract class CorePersistenceModel extends CoreModel {
     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;

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

@@ -1,11 +1,11 @@
 import { Document, Model, Types } from 'mongoose';
+import { ProcessType } from '../enums/process-type.enum';
 import { getStringIds, popAndMap } from '../helpers/db.helper';
 import { check } from '../helpers/input.helper';
 import { prepareInput, prepareOutput } from '../helpers/service.helper';
 import { ServiceOptions } from '../interfaces/service-options.interface';
 import { CoreModel } from '../models/core-model.model';
 import { FieldSelection } from '../types/field-selection.type';
-import { IdsType } from '../types/ids.type';
 
 /**
  * Module service class to be extended by concrete module services
@@ -39,9 +39,9 @@ export abstract class ModuleService<T extends CoreModel = any> {
     input: any,
     currentUser: { id: any; hasRole: (roles: string[]) => boolean },
     options?: {
-      creator?: IdsType;
+      dbObject?: any;
       metatype?: any;
-      ownerIds?: IdsType;
+      processType?: ProcessType;
       roles?: string | string[];
       throwError?: boolean;
     }
@@ -84,36 +84,28 @@ export abstract class ModuleService<T extends CoreModel = any> {
 
     // Prepare input
     if (config.prepareInput && this.prepareInput) {
-      await this.prepareInput(config.input, config.prepareInput);
+      const opts = config.prepareInput;
+      if (!opts.targetModel && config.inputType) {
+        opts.targetModel = config.inputType;
+      }
+      await this.prepareInput(config.input, opts);
     }
 
     // Get DB object
-    const getDbObject = async () => {
-      if (config.dbObject) {
-        if (typeof config.dbObject === 'string' || config.dbObject instanceof Types.ObjectId) {
-          const dbObject = await this.get(getStringIds(config.dbObject));
-          if (dbObject) {
-            config.dbObject = dbObject;
-          }
+    if (config.dbObject && config.checkRights && this.checkRights) {
+      if (typeof config.dbObject === 'string' || config.dbObject instanceof Types.ObjectId) {
+        const dbObject = await this.get(getStringIds(config.dbObject));
+        if (dbObject) {
+          config.dbObject = dbObject;
         }
       }
-      return config.dbObject;
-    };
-
-    // Get owner IDs
-    let ownerIds = undefined;
-    if (config.checkRights && this.checkRights) {
-      ownerIds = getStringIds(config.ownerIds);
-      if (!ownerIds?.length) {
-        ownerIds = (await getDbObject())?.ownerIds;
-      }
     }
 
     // Check rights for input
     if (config.input && config.checkRights && this.checkRights) {
-      const opts: any = { creator: (await getDbObject())?.createdBy, ownerIds, roles: config.roles };
+      const opts: any = { dbObject: config.dbObject, processType: ProcessType.INPUT, roles: config.roles };
       if (config.inputType) {
-        opts.metatype = config.resultType;
+        opts.metatype = config.inputType;
       }
       config.input = await this.checkRights(config.input, config.currentUser as any, opts);
     }
@@ -128,18 +120,23 @@ export abstract class ModuleService<T extends CoreModel = any> {
 
     // Prepare output
     if (config.prepareOutput && this.prepareOutput) {
-      // Check if mapping is already done by processFieldSelection
-      if (config.processFieldSelection && config.fieldSelection && this.processFieldSelection) {
-        config.prepareOutput.targetModel = null;
+      const opts = config.prepareOutput;
+      if (!opts.targetModel && config.outputType) {
+        opts.targetModel = config.outputType;
       }
-      result = await this.prepareOutput(result, config.prepareOutput);
+      result = await this.prepareOutput(result, opts);
     }
 
     // Check output rights
     if (config.checkRights && this.checkRights) {
-      const opts: any = { creator: (await getDbObject())?.createdBy, ownerIds, roles: config.roles, throwError: false };
-      if (config.resultType) {
-        opts.metatype = config.resultType;
+      const opts: any = {
+        dbObject: config.dbObject,
+        processType: ProcessType.OUTPUT,
+        roles: config.roles,
+        throwError: false,
+      };
+      if (config.outputType) {
+        opts.metatype = config.outputType;
       }
       result = await this.checkRights(result, config.currentUser as any, opts);
     }
@@ -152,7 +149,11 @@ export abstract class ModuleService<T extends CoreModel = any> {
    * Prepare input before save
    */
   async prepareInput(input: Record<string, any>, options: ServiceOptions = {}) {
-    return prepareInput(input, options.currentUser, options.prepareInput);
+    const config = {
+      targetModel: this.mainModelConstructor,
+      ...options?.prepareInput,
+    };
+    return prepareInput(input, options.currentUser, config);
   }
 
   /**

package/src/core/common/types/require-only-one.type.ts

@@ -0,0 +1,6 @@
+/**
+ * Require only one of the optional properties
+ * See https://stackoverflow.com/a/49725198
+ */
+export type RequireOnlyOne<T, Keys extends keyof T = keyof T> = Pick<T, Exclude<keyof T, Keys>> &
+  { [K in Keys]-?: Required<Pick<T, K>> & Partial<Record<Exclude<Keys, K>, undefined>> }[Keys];

package/src/core/common/types/required-at-least-one.type.ts

@@ -0,0 +1,6 @@
+/**
+ * Require at least on of optional properties
+ * See https://stackoverflow.com/a/49725198
+ */
+export type RequireAtLeastOne<T, Keys extends keyof T = keyof T> = Pick<T, Exclude<keyof T, Keys>> &
+  { [K in Keys]-?: Required<Pick<T, K>> & Partial<Pick<T, Exclude<Keys, K>>> }[Keys];

package/src/core/modules/auth/inputs/core-auth-sign-in.input.ts

@@ -0,0 +1,18 @@
+import { Field, InputType } from '@nestjs/graphql';
+import { CoreInput } from '../../../common/inputs/core-input.input';
+
+/**
+ * SignIn input
+ */
+@InputType({ description: 'Sign-in input' })
+export class CoreAuthSignInInput extends CoreInput {
+  // ===================================================================================================================
+  // Properties
+  // ===================================================================================================================
+
+  @Field({ description: 'Email', nullable: false })
+  email: string = undefined;
+
+  @Field({ description: 'Password', nullable: false })
+  password: string = undefined;
+}

package/src/core/modules/auth/inputs/core-auth-sign-up.input.ts

@@ -0,0 +1,18 @@
+import { Field, InputType } from '@nestjs/graphql';
+import { CoreInput } from '../../../common/inputs/core-input.input';
+
+/**
+ * SignUp input
+ */
+@InputType({ description: 'Sign-up input' })
+export class CoreAuthSignUpInput extends CoreInput {
+  // ===================================================================================================================
+  // Properties
+  // ===================================================================================================================
+
+  @Field({ description: 'Email', nullable: false })
+  email: string = undefined;
+
+  @Field({ description: 'Password', nullable: false })
+  password: string = undefined;
+}

package/src/core.module.ts

@@ -1,8 +1,7 @@
 import { DynamicModule, Global, Module, UnauthorizedException } from '@nestjs/common';
-import { APP_INTERCEPTOR, APP_PIPE } from '@nestjs/core';
+import { APP_PIPE } from '@nestjs/core';
 import { GraphQLModule } from '@nestjs/graphql';
 import { merge } from './core/common/helpers/config.helper';
-import { CheckResponseInterceptor } from './core/common/interceptors/check-response.interceptor';
 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';
@@ -19,8 +18,6 @@ import { ApolloDriver, ApolloDriverConfig } from '@nestjs/apollo';
  * - MongooseModule
  * - GraphQL
  * - ConfigService
- * - CheckInput
- * - CheckResponse
  *
  * and sets the following services as globals:
  * - ConfigService
@@ -99,21 +96,6 @@ export class CoreModule {
         useValue: new ConfigService(config),
       },
 
-      // [Global] The CheckResponseInterceptor restricts the response to the properties
-      // that are permitted for the current user
-      {
-        provide: APP_INTERCEPTOR,
-        useClass: CheckResponseInterceptor,
-      },
-
-      // [Global] The CheckInputPipe checks the permissibility of individual properties of inputs for the resolvers
-      // in relation to the current user, replaces MapAndValidatePipe
-      // Does not work yet, because context is missing: https://github.com/nestjs/graphql/issues/325
-      // {
-      //   provide: APP_PIPE,
-      //   useClass: CheckInputPipe,
-      // },
-
       // [Global] Map plain objects to metatype and validate
       {
         provide: APP_PIPE,

package/src/index.ts

@@ -15,6 +15,7 @@ export * from './core/common/decorators/restricted.decorator';
 export * from './core/common/decorators/roles.decorator';
 export * from './core/common/enums/comparison-operator.enum';
 export * from './core/common/enums/logical-operator.enum';
+export * from './core/common/enums/process-type.enum';
 export * from './core/common/enums/role.enum';
 export * from './core/common/enums/sort-order.emum';
 export * from './core/common/helpers/config.helper';
@@ -34,6 +35,8 @@ export * from './core/common/inputs/sort.input';
 export * from './core/common/interceptors/check-response.interceptor';
 export * from './core/common/interfaces/core-persistence-model.interface';
 export * from './core/common/interfaces/mailjet-options.interface';
+export * from './core/common/interfaces/prepare-input-options.interface';
+export * from './core/common/interfaces/prepare-output-options.interface';
 export * from './core/common/interfaces/resolve-selector.interface';
 export * from './core/common/interfaces/server-options.interface';
 export * from './core/common/interfaces/service-options.interface';
@@ -54,6 +57,8 @@ export * from './core/common/types/core-model-constructor.type';
 export * from './core/common/types/field-selection.type';
 export * from './core/common/types/ids.type';
 export * from './core/common/types/plain-input.type';
+export * from './core/common/types/require-only-one.type';
+export * from './core/common/types/required-at-least-one.type';
 export * from './core/common/types/string-or-object-id.type';
 
 // =====================================================================================================================

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

@@ -3,22 +3,22 @@ import { CoreAuthModel } from '../../../core/modules/auth/core-auth.model';
 import { User } from '../user/user.model';
 
 /**
- * CoreAuthModel model for the response after the sign in
+ * Authentication data
  */
-@ObjectType({ description: 'Auth' })
+@ObjectType({ description: 'Authentication data' })
 export class Auth extends CoreAuthModel {
   // ===================================================================================================================
   // Properties
   // ===================================================================================================================
 
   /**
-   * Signed in user
+   * Signed-in user
    */
-  @Field((type) => User, { description: 'User who signed in' })
+  @Field(() => User, { description: 'User who signed in' })
   user: User = undefined;
 
   // ===================================================================================================================
-  // Properties
+  // Methods
   // ===================================================================================================================
 
   /**

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

@@ -1,9 +1,11 @@
 import { DynamicModule, Module } from '@nestjs/common';
 import { JwtModuleOptions } from '@nestjs/jwt';
+import { EmailService } from '../../../core/common/services/email.service';
 import { CoreAuthModule } from '../../../core/modules/auth/core-auth.module';
 import { UserModule } from '../user/user.module';
 import { UserService } from '../user/user.service';
 import { AuthResolver } from './auth.resolver';
+import { AuthService } from './auth.service';
 
 /**
  * CoreAuthModule to handle user authentication
@@ -17,8 +19,17 @@ export class AuthModule {
   static forRoot(options: JwtModuleOptions): DynamicModule {
     return {
       module: AuthModule,
-      imports: [CoreAuthModule.forRoot(UserModule, UserService, options)],
-      providers: [AuthResolver],
+      imports: [
+        CoreAuthModule.forRoot(UserModule, UserService, {
+          ...options,
+          ...{
+            // imports: [], // Integrate additional Services here to resolve dependencies
+            // providers: [] // Integrate additional Providers here to resolve dependencies
+          },
+        }),
+        EmailService,
+      ],
+      providers: [AuthResolver, AuthService],
       exports: [AuthResolver, CoreAuthModule],
     };
   }

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

@@ -1,22 +1,40 @@
-import { Args, Info, Query, Resolver } from '@nestjs/graphql';
+import { Args, Info, Mutation, Query, Resolver } from '@nestjs/graphql';
 import { GraphQLResolveInfo } from 'graphql';
-import { CoreAuthResolver } from '../../../core/modules/auth/core-auth.resolver';
 import { Auth } from './auth.model';
+import { AuthService } from './auth.service';
+import { AuthSignInInput } from './inputs/auth-sign-in.input';
+import { AuthSignUpInput } from './inputs/auth-sign-up.input';
 
 /**
  * Authentication resolver for the sign in
  */
-@Resolver((of) => Auth)
-export class AuthResolver extends CoreAuthResolver {
+@Resolver(() => Auth)
+export class AuthResolver {
   /**
-   * Get user via ID
+   * Integrate services
    */
-  @Query((returns) => Auth, { description: 'Get JWT token' })
-  async signIn(
-    @Args('email') email: string,
-    @Args('password') password: string,
-    @Info() info: GraphQLResolveInfo
-  ): Promise<Auth> {
-    return (await this.authService.signIn(email, password, { fieldSelection: { info, select: 'signIn' } })) as Auth;
+  constructor(private readonly authService: AuthService) {}
+
+  /**
+   * SignIn for User
+   */
+  @Query(() => Auth, { description: 'Sign in and get JWT token' })
+  async signIn(@Info() info: GraphQLResolveInfo, @Args('input') input: AuthSignInInput): Promise<Auth> {
+    return this.authService.signIn(input, {
+      fieldSelection: { info, select: 'signIn' },
+      inputType: AuthSignInInput,
+    });
+  }
+
+  /**
+   * Sign up for user
+   */
+  @Mutation(() => Auth, {
+    description: 'Sign up user and get JWT token',
+  })
+  async signUp(@Info() info: GraphQLResolveInfo, @Args('input') input: AuthSignUpInput): Promise<Auth> {
+    return this.authService.signUp(input, {
+      fieldSelection: { info, select: 'signUp' },
+    });
   }
 }

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

@@ -0,0 +1,84 @@
+import { Injectable, UnauthorizedException } from '@nestjs/common';
+import { JwtService } from '@nestjs/jwt';
+import * as bcrypt from 'bcrypt';
+import envConfig from '../../../config.env';
+import { prepareServiceOptions } from '../../../core/common/helpers/service.helper';
+import { ResolveSelector } from '../../../core/common/interfaces/resolve-selector.interface';
+import { ServiceOptions } from '../../../core/common/interfaces/service-options.interface';
+import { EmailService } from '../../../core/common/services/email.service';
+import { JwtPayload } from '../../../core/modules/auth/interfaces/jwt-payload.interface';
+import { UserService } from '../user/user.service';
+import { Auth } from './auth.model';
+import { AuthSignInInput } from './inputs/auth-sign-in.input';
+import { AuthSignUpInput } from './inputs/auth-sign-up.input';
+
+@Injectable()
+export class AuthService {
+  constructor(
+    protected readonly jwtService: JwtService,
+    protected readonly emailService: EmailService,
+    protected readonly userService: UserService
+  ) {}
+
+  /**
+   * Sign in for user
+   */
+  async signIn(input: AuthSignInInput, serviceOptions?: ServiceOptions): Promise<Auth> {
+    // Prepare service options
+    const serviceOptionsForUserService = prepareServiceOptions(serviceOptions, {
+      // We need password, so we can't use prepare output handling and have to deactivate it
+      prepareOutput: null,
+
+      // Select user field for automatic populate handling via user service
+      subFieldSelection: 'user',
+    });
+
+    // Get and check user
+    const user = await this.userService.getViaEmail(input.email, serviceOptionsForUserService);
+    if (!user) {
+      throw new UnauthorizedException();
+    }
+
+    // Check password
+    if (!(await bcrypt.compare(input.password, user.password))) {
+      throw new UnauthorizedException();
+    }
+
+    // Create JWT and return sign-in data
+    const payload: JwtPayload = { email: user.email };
+    return Auth.map({
+      token: this.jwtService.sign(payload),
+      user,
+    });
+  }
+
+  /**
+   * Register a new user Account
+   */
+  async signUp(input: AuthSignUpInput, serviceOptions?: ServiceOptions): Promise<Auth> {
+    // Prepare service options
+    const serviceOptionsForUserService = prepareServiceOptions(serviceOptions, {
+      // Select user field for automatic populate handling via user service
+      subFieldSelection: 'user',
+    });
+
+    // Get and check user
+    const user = await this.userService.create(input, serviceOptionsForUserService);
+    if (!user) {
+      throw Error('Email Address already in use');
+    }
+
+    // Send email
+    await this.emailService.sendMail(user.email, 'Welcome', {
+      htmlTemplate: 'welcome',
+      templateData: { name: user.username, link: envConfig.email.verificationLink + '/' + user.verificationToken },
+    });
+
+    // Create JWT and return sign-in data
+    const payload: JwtPayload = { email: user.email };
+    return Auth.map({
+      token: this.jwtService.sign(payload),
+      user: user,
+    });
+  }
+}

package/src/server/modules/auth/inputs/auth-sign-in.input.ts

@@ -0,0 +1,10 @@
+import { InputType } from '@nestjs/graphql';
+import { CoreAuthSignInInput } from '../../../../core/modules/auth/inputs/core-auth-sign-in.input';
+
+/**
+ * SignIn input
+ */
+@InputType({ description: 'Description for AuthSignInInput' })
+export class AuthSignInInput extends CoreAuthSignInInput {
+  // Extend UserInput here
+}

package/src/server/modules/auth/inputs/auth-sign-up.input.ts

@@ -0,0 +1,18 @@
+import { Field, InputType } from '@nestjs/graphql';
+import { CoreAuthSignUpInput } from '../../../../core/modules/auth/inputs/core-auth-sign-up.input';
+
+/**
+ * SignUp input
+ */
+@InputType({ description: 'Description for AuthSignUpInput' })
+export class AuthSignUpInput extends CoreAuthSignUpInput {
+  // ===================================================================================================================
+  // Properties
+  // ===================================================================================================================
+
+  @Field({ description: 'firstName', nullable: true })
+  firstName: string = undefined;
+
+  @Field({ description: 'lastName', nullable: true })
+  lastName: string = undefined;
+}

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

@@ -1,8 +1,8 @@
 import { Field, ObjectType } from '@nestjs/graphql';
+import { Prop, Schema as MongooseSchema, SchemaFactory } from '@nestjs/mongoose';
+import { Document, Schema } from 'mongoose';
 import { CoreUserModel } from '../../../core/modules/user/core-user.model';
 import { PersistenceModel } from '../../common/models/persistence.model';
-import { Prop, Schema as MongooseSchema, SchemaFactory } from '@nestjs/mongoose';
-import { Schema, Document } from 'mongoose';
 
 export type UserDocument = User & Document;