@lenne.tech/nest-server 11.1.4 → 11.1.6

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lenne.tech/nest-server",
-  "version": "11.1.4",
+  "version": "11.1.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",
@@ -39,7 +39,7 @@
     "start:dev:swc": "nest start -b swc -w --type-check",
     "start:local": "NODE_ENV=local nodemon",
     "start:local:swc": "NODE_ENV=local nest start -b swc -w --type-check",
-    "test": "NODE_ENV=local jest",
+    "test": "npm run test:e2e",
     "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",

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

@@ -22,3 +22,28 @@ export function Translatable(): PropertyDecorator {
     Reflect.defineMetadata(TRANSLATABLE_KEY, [...existingProperties, propertyKey], target.constructor);
   };
 }
+
+export function updateLanguage<T extends Record<string, any>, K extends readonly (keyof T)[]>(
+  language: string,
+  input: any,
+  oldValue: T,
+  translatableFields: string[],
+): T {
+  const changedFields: Partial<Pick<T, K[number]>> = {};
+
+  for (const key of translatableFields) {
+    const k = key as keyof T;
+
+    if (input[k] !== oldValue[k] && input[k] !== undefined) {
+      changedFields[k] = input[k];
+      input[k] = oldValue[k] as T[typeof k];
+    }
+  }
+
+  input._translations = input._translations ?? {};
+  input._translations[language] = {
+    ...(input._translations[language] ?? {}),
+    ...changedFields,
+  };
+  return input;
+}

package/src/core/common/decorators/unified-field.decorator.ts

@@ -36,7 +36,7 @@ export interface UnifiedFieldOptions {
   /** Description used for both Swagger & Gql */
   description?: string;
   /** Enum for class-validator */
-  enum?: { enum: EnumAllowedTypes; options?: ValidationOptions };
+  enum?: { enum: EnumAllowedTypes; enumName?: string; options?: ValidationOptions };
   /** Example value for swagger api documentation */
   example?: any;
   /** Options for graphql */
@@ -82,31 +82,26 @@ export function UnifiedField(opts: UnifiedFieldOptions = {}): PropertyDecorator
       throw new Error(`Array field '${String(propertyKey)}' of '${String(target)}' must have an explicit type`);
     }
 
-    if (opts.enum && userType) {
-      throw new Error(`Can't set both enum and type of ${String(propertyKey)} in ${target.constructor.name}`);
-    }
-
     const resolvedTypeFn = (): any => {
-        if (opts.enum?.enum) {
-          return opts.enum.enum; // Ensure enums are handled directly
-        }
       if (userType) {
-        if (userType instanceof GraphQLScalarType) { // Case if it's a scalar
+        if (userType instanceof GraphQLScalarType) {
+          // Case if it's a scalar
           return userType;
         }
-        if (
-          typeof userType === 'function'
-          && userType.prototype
-          && userType.prototype.constructor === userType
-        ) { // Case if it's a function
+
+        if (typeof userType === 'function' && userType.prototype && userType.prototype.constructor === userType) {
+          // Case if it's a function
           return userType;
         }
-        try { // case if its a factory
+
+        try {
+          // case if its a factory
           return (userType as () => any)();
         } catch {
           return userType;
         }
       }
+
       return metadataType;
     };
 
@@ -114,16 +109,24 @@ export function UnifiedField(opts: UnifiedFieldOptions = {}): PropertyDecorator
 
     // Prepare merged options
     const gqlOpts: FieldOptions = { ...opts.gqlOptions };
-    const swaggerOpts: ApiPropertyOptions = { ...opts.swaggerApiOptions };
+    const swaggerOpts: ApiPropertyOptions & { enumName?: string } = { ...opts.swaggerApiOptions };
     const valOpts: ValidationOptions = { ...opts.validationOptions };
 
     // Optionality
     if (opts.isOptional) {
+      IsOptional(valOpts)(target, propertyKey);
+
       gqlOpts.nullable = true;
+
       swaggerOpts.nullable = true;
+      swaggerOpts.required = false;
     } else {
+      IsNotEmpty()(target, propertyKey);
+
       gqlOpts.nullable = false;
+
       swaggerOpts.nullable = false;
+      swaggerOpts.required = true;
     }
 
     // Description
@@ -136,18 +139,25 @@ export function UnifiedField(opts: UnifiedFieldOptions = {}): PropertyDecorator
       swaggerOpts.example = swaggerOpts.example ?? opts.example;
     }
 
+    // Set enum options
     if (opts.enum && opts.enum.enum) {
       swaggerOpts.enum = opts.enum.enum;
+
+      if (opts.enum.enumName) {
+        swaggerOpts.enumName = opts.enum.enumName;
+      }
+
+      IsEnum(opts.enum.enum, opts.enum.options)(target, propertyKey);
     }
+
     // Array handling
     if (isArrayField) {
       swaggerOpts.isArray = true;
       IsArray(valOpts)(target, propertyKey);
       valOpts.each = true;
-    }
-
-    if (opts.isOptional) {
-      IsOptional(valOpts)(target, propertyKey);
+    } else {
+      swaggerOpts.isArray = false;
+      valOpts.each = false;
     }
 
     // Type function for gql
@@ -158,54 +168,14 @@ export function UnifiedField(opts: UnifiedFieldOptions = {}): PropertyDecorator
     // Gql decorator
     Field(gqlTypeFn, gqlOpts)(target, propertyKey);
 
-    // Trims keys with 'undefined' properties.
-    function trimUndefined<T>(obj: T): Partial<T> {
-      if (typeof obj !== 'object' || obj === null) {
-        return obj;
-      }
-      const result: any = Array.isArray(obj) ? [] : {};
-      for (const key in obj) {
-        if (Object.prototype.hasOwnProperty.call(obj, key)) {
-          const value = (obj as any)[key];
-
-          if (typeof value === 'object' && value !== null) {
-            const cleaned = trimUndefined(value);
-            if (Array.isArray(cleaned) ? cleaned.length > 0 : Object.keys(cleaned).length > 0) {
-              result[key] = cleaned;
-            }
-          } else if (value !== undefined) {
-            result[key] = value;
-          }
-        }
-      }
-
-      return result;
-    }
-
-    ApiProperty(trimUndefined({
-      deprecated: swaggerOpts.deprecated,
-      description: swaggerOpts.description,
-      enum: swaggerOpts.enum,
-      example: swaggerOpts.example,
-      examples: swaggerOpts.examples,
-      isArray: swaggerOpts.isArray,
-      nullable: swaggerOpts.nullable,
-      pattern: swaggerOpts.pattern,
-      type: () => resolvedTypeFn(),
-    }))(target, propertyKey);
+    // Swagger decorator
+    ApiProperty(swaggerOpts)(target, propertyKey);
 
     // Conditional validation
     if (opts.validateIf) {
       ValidateIf(opts.validateIf)(target, propertyKey);
     }
 
-    // isOptional validation
-    if (opts.isOptional) {
-      IsOptional()(target, propertyKey);
-    } else {
-      IsNotEmpty()(target, propertyKey);
-    }
-
     // Completely skip validation if its any
     if (opts.validator) {
       opts.validator(valOpts).forEach(d => d(target, propertyKey));
@@ -216,13 +186,8 @@ export function UnifiedField(opts: UnifiedFieldOptions = {}): PropertyDecorator
       }
     }
 
-    // Enum validation
-    if (opts.enum) {
-      IsEnum(opts.enum.enum, opts.enum.options)(target, propertyKey);
-    }
-
     if (!opts.isAny) {
-    // Check if it's a primitive, if not apply transform
+      // Check if it's a primitive, if not apply transform
       if (!isPrimitive(baseType) && !opts.enum && !isGraphQLScalar(baseType)) {
         Type(() => baseType)(target, propertyKey);
         ValidateNested({ each: isArrayField })(target, propertyKey);
@@ -262,12 +227,14 @@ function getBuiltInValidator(
 
 function isGraphQLScalar(type: any): boolean {
   // CustomScalar check (The CustomScalar interface implements these functions below)
-  return type
-    && typeof type === 'function'
-    && typeof type.prototype?.serialize === 'function'
-    && typeof type.prototype?.parseValue === 'function'
-    && typeof type.prototype?.parseLiteral === 'function'
-    || type instanceof GraphQLScalarType;
+  return (
+    (type
+      && typeof type === 'function'
+      && typeof type.prototype?.serialize === 'function'
+      && typeof type.prototype?.parseValue === 'function'
+      && typeof type.prototype?.parseLiteral === 'function')
+    || type instanceof GraphQLScalarType
+  );
 }
 
 function isPrimitive(fn: any): boolean {

package/src/server/modules/user/inputs/user-create.input.ts

@@ -1,4 +1,5 @@
-import { InputType } from '@nestjs/graphql';
+import { Field, InputType } from '@nestjs/graphql';
+import { IsOptional } from 'class-validator';
 
 import { Restricted } from '../../../../core/common/decorators/restricted.decorator';
 import { RoleEnum } from '../../../../core/common/enums/role.enum';
@@ -11,4 +12,11 @@ import { CoreUserCreateInput } from '../../../../core/modules/user/inputs/core-u
 @Restricted(RoleEnum.ADMIN)
 export class UserCreateInput extends CoreUserCreateInput {
   // Extend UserCreateInput here
+  @Field(() => String, {
+    description: 'Job Title of the user',
+    nullable: true,
+  })
+  @IsOptional()
+  @Restricted(RoleEnum.ADMIN)
+  jobTitle?: string = undefined;
 }

package/src/server/modules/user/inputs/user.input.ts

@@ -1,4 +1,5 @@
-import { InputType } from '@nestjs/graphql';
+import { Field, InputType } from '@nestjs/graphql';
+import { IsOptional } from 'class-validator';
 
 import { Restricted } from '../../../../core/common/decorators/restricted.decorator';
 import { RoleEnum } from '../../../../core/common/enums/role.enum';
@@ -11,4 +12,11 @@ import { CoreUserInput } from '../../../../core/modules/user/inputs/core-user.in
 @Restricted(RoleEnum.ADMIN)
 export class UserInput extends CoreUserInput {
   // Extend UserInput here
+  @Field(() => String, {
+    description: 'Job Title of the user',
+    nullable: true,
+  })
+  @IsOptional()
+  @Restricted(RoleEnum.ADMIN)
+  jobTitle?: string = undefined;
 }

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

@@ -4,6 +4,7 @@ import { IsEmail, IsOptional } from 'class-validator';
 import { Document, Schema } from 'mongoose';
 
 import { Restricted } from '../../../core/common/decorators/restricted.decorator';
+import { Translatable } from '../../../core/common/decorators/translatable.decorator';
 import { RoleEnum } from '../../../core/common/enums/role.enum';
 import { CoreUserModel } from '../../../core/modules/user/core-user.model';
 import { PersistenceModel } from '../../common/models/persistence.model';
@@ -60,6 +61,15 @@ export class User extends CoreUserModel implements PersistenceModel {
   @Restricted(RoleEnum.S_EVERYONE)
   override roles: string[] = undefined;
 
+  @Field(() => String, {
+    description: 'Job title of user',
+    nullable: true,
+  })
+  @Prop()
+  @Restricted(RoleEnum.S_EVERYONE)
+  @Translatable()
+  jobTitle?: string = undefined;
+
   /**
    * ID of the user who updated the object
    *
@@ -73,6 +83,10 @@ export class User extends CoreUserModel implements PersistenceModel {
   @Restricted(RoleEnum.S_USER)
   updatedBy: string = undefined;
 
+  @Prop({ default: {}, type: Schema.Types.Mixed })
+  @Restricted(RoleEnum.S_EVERYONE)
+  _translations?: Record<string, Partial<User>> = undefined;
+
   // ===================================================================================================================
   // Methods
   // ===================================================================================================================

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

@@ -4,6 +4,7 @@ import fs = require('fs');
 import { PubSub } from 'graphql-subscriptions';
 import { Model } from 'mongoose';
 
+import { getTranslatablePropertyKeys, updateLanguage } from '../../../core/common/decorators/translatable.decorator';
 import { ServiceOptions } from '../../../core/common/interfaces/service-options.interface';
 import { ConfigService } from '../../../core/common/services/config.service';
 import { EmailService } from '../../../core/common/services/email.service';
@@ -62,6 +63,14 @@ export class UserService extends CoreUserService<User, UserInput, UserCreateInpu
     return user;
   }
 
+  override async update(id: string, input: UserInput, serviceOptions?: ServiceOptions): Promise<User> {
+    const dbObject = await super.get(id, serviceOptions);
+    if (serviceOptions.language && serviceOptions.language !== 'de') {
+      input = updateLanguage(serviceOptions.language, input, dbObject as UserInput, getTranslatablePropertyKeys(User));
+    }
+    return super.update(id, input, serviceOptions);
+  }
+
   /**
    * Request password reset mail
    */

package/src/test/test.helper.ts

@@ -83,6 +83,11 @@ export interface TestGraphQLOptions {
    */
   countOfSubscriptionMessages?: number;
 
+  /**
+   * Language selected by user
+   */
+  language?: string;
+
   /**
    * Output information in the console
    */
@@ -225,6 +230,7 @@ export class TestHelper {
     const config = {
       convertEnums: true,
       countOfSubscriptionMessages: 1,
+      language: null,
       log: false,
       logError: false,
       prepareArguments: true,
@@ -234,7 +240,7 @@ export class TestHelper {
     };
 
     // Init vars
-    const { log, logError, statusCode, token, variables } = config;
+    const { language, log, logError, statusCode, token, variables } = config;
 
     // Init
     let query = '';
@@ -337,6 +343,10 @@ export class TestHelper {
       requestConfig.headers = { authorization: `Bearer ${token}` };
     }
 
+    if (language) {
+      requestConfig.headers = { ...requestConfig.headers, 'accept-language': language };
+    }
+
     // Get response
     const response = await this.getResponse(token, requestConfig, statusCode, log, logError, variables);