@dirayaah/assessment-module 1.0.0

package/src/constants/predefined-assessments/leadership.ts

@@ -0,0 +1,242 @@
+import { PredefinedAssessmentEntity } from '../../entities/predefined-assessment.entity';
+import {
+  AssessmentDetailsLanguage,
+  PredefinedAssessmentType,
+} from '../../enums';
+
+const LEADERSHIP_ASSESSMENT: PredefinedAssessmentEntity[] = [
+  {
+    title: 'تقييم مستوى القيادة',
+    description:
+      'تقييم مستوى القيادة هو أداة تهدف إلى قياس قدرات الفرد القيادية وتحديد مستواه في القيادة من خلال تحليل السلوكيات والمهارات القيادية الأساسية، مما يساعد على تطوير الأداء القيادي وتعزيز نقاط القوة.',
+    language: AssessmentDetailsLanguage.AR,
+    category: 'قيادة',
+    type: PredefinedAssessmentType.LEADERSHIP,
+    backgroundImageUrl: null,
+    details: {
+      overview: {
+        title: 'تقييم مستوى القيادة',
+        description:
+          'يهدف تقييم مستوى القيادة إلى قياس مدى امتلاك الفرد للمهارات والسلوكيات القيادية الأساسية، مثل اتخاذ القرار، التواصل، التأثير، وإدارة الفرق، وذلك لتحديد المستوى القيادي الحالي وفرص التطوير.',
+      },
+      behavioralPatterns: {
+        title: 'المجالات القيادية في التقييم',
+        patterns: [
+          {
+            title: 'القيادة الذاتية',
+            description:
+              'تقيس قدرة الفرد على إدارة ذاته، وتحمل المسؤولية، والانضباط الذاتي، والالتزام بالأهداف الشخصية والمهنية.',
+          },
+          {
+            title: 'اتخاذ القرار',
+            description:
+              'تركز على قدرة الفرد على تحليل المواقف، اتخاذ قرارات فعالة في الوقت المناسب، وتحمل مسؤولية نتائج القرارات.',
+          },
+          {
+            title: 'التواصل والتأثير',
+            description:
+              'تقيس مهارات التواصل الواضح، والاستماع الفعّال، والقدرة على التأثير الإيجابي في الآخرين وبناء علاقات عمل قوية.',
+          },
+          {
+            title: 'إدارة الفرق',
+            description:
+              'تقيم قدرة الفرد على توجيه الفرق، توزيع المهام، تحفيز الأعضاء، وبناء بيئة عمل تعاونية ومنتجة.',
+          },
+          {
+            title: 'الذكاء العاطفي',
+            description:
+              'تركز على وعي الفرد بمشاعره ومشاعر الآخرين، وإدارة الانفعالات، والتعامل بمرونة مع الضغوط والتحديات.',
+          },
+          {
+            title: 'الرؤية والتخطيط',
+            description:
+              'تقيس قدرة الفرد على وضع رؤية واضحة، تحديد الأهداف طويلة المدى، والتخطيط الاستراتيجي لتحقيقها.',
+          },
+        ],
+      },
+      howItWorks: {
+        title: 'كيف يعمل تقييم القيادة',
+        description:
+          'يتضمن التقييم مجموعة من الأسئلة السلوكية والمواقف العملية التي تقيس المهارات القيادية المختلفة. يتم تحليل الإجابات لتحديد المستوى القيادي الحالي ونقاط القوة ومجالات التحسين.',
+      },
+      outputs: {
+        title: 'مخرجات التقييم',
+        items: [
+          'تحديد المستوى القيادي الحالي',
+          'تحليل نقاط القوة القيادية',
+          'تحديد مجالات التطوير والتحسين',
+          'توصيات لتطوير المهارات القيادية',
+          'خطة تطوير قيادي مبدئية',
+        ],
+      },
+      useCases: {
+        title: 'استخدامات تقييم القيادة',
+        items: [
+          'تطوير القيادات',
+          'تقييم المرشحين للمناصب القيادية',
+          'بناء خطط التطوير الفردية',
+          'تحسين أداء المدراء',
+          'برامج التدريب والتأهيل القيادي',
+        ],
+      },
+    },
+    configuration: undefined,
+  },
+  {
+    title: 'Leadership Level Assessment',
+    description:
+      'The Leadership Level Assessment is a tool designed to measure an individual’s leadership capabilities and determine their leadership level by analyzing key leadership behaviors and skills, helping to improve leadership performance and strengthen strengths.',
+    language: AssessmentDetailsLanguage.EN,
+    category: 'Leadership',
+    type: PredefinedAssessmentType.LEADERSHIP,
+    backgroundImageUrl: null,
+    details: {
+      overview: {
+        title: 'Leadership Level Assessment',
+        description:
+          'The Leadership Level Assessment aims to measure how well an individual possesses core leadership skills and behaviors such as decision-making, communication, influence, and team management, in order to identify the current leadership level and development opportunities.',
+      },
+      behavioralPatterns: {
+        title: 'Leadership Competency Areas',
+        patterns: [
+          {
+            title: 'Self-Leadership',
+            description:
+              'Measures an individual’s ability to manage themselves, take responsibility, maintain self-discipline, and stay committed to personal and professional goals.',
+          },
+          {
+            title: 'Decision Making',
+            description:
+              'Focuses on the individual’s ability to analyze situations, make effective decisions in a timely manner, and take responsibility for decision outcomes.',
+          },
+          {
+            title: 'Communication and Influence',
+            description:
+              'Measures clear communication skills, active listening, and the ability to positively influence others and build strong working relationships.',
+          },
+          {
+            title: 'Team Management',
+            description:
+              'Evaluates the individual’s ability to lead teams, delegate tasks, motivate team members, and build a collaborative and productive work environment.',
+          },
+          {
+            title: 'Emotional Intelligence',
+            description:
+              'Focuses on awareness of one’s own emotions and the emotions of others, managing reactions, and dealing flexibly with pressure and challenges.',
+          },
+          {
+            title: 'Vision and Planning',
+            description:
+              'Measures the ability to set a clear vision, define long-term goals, and plan strategically to achieve them.',
+          },
+        ],
+      },
+      howItWorks: {
+        title: 'How the Leadership Assessment Works',
+        description:
+          'The assessment consists of a set of behavioral questions and situational scenarios that evaluate different leadership skills. Responses are analyzed to determine the current leadership level, strengths, and areas for improvement.',
+      },
+      outputs: {
+        title: 'Assessment Outputs',
+        items: [
+          'Identification of the current leadership level',
+          'Analysis of leadership strengths',
+          'Identification of development and improvement areas',
+          'Recommendations for leadership skill development',
+          'Initial leadership development plan',
+        ],
+      },
+      useCases: {
+        title: 'Leadership Assessment Use Cases',
+        items: [
+          'Leadership development',
+          'Evaluation of candidates for leadership roles',
+          'Building individual development plans',
+          'Improving managers’ performance',
+          'Leadership training and development programs',
+        ],
+      },
+    },
+    configuration: null,
+  },
+
+  {
+    title: 'Evaluación del Nivel de Liderazgo',
+    description:
+      'La Evaluación del Nivel de Liderazgo es una herramienta diseñada para medir las capacidades de liderazgo de una persona y determinar su nivel de liderazgo mediante el análisis de comportamientos y habilidades clave, ayudando a mejorar el desempeño y fortalecer los puntos fuertes.',
+    language: AssessmentDetailsLanguage.ES,
+    category: 'Liderazgo',
+    type: PredefinedAssessmentType.LEADERSHIP,
+    backgroundImageUrl: null,
+    details: {
+      overview: {
+        title: 'Evaluación del Nivel de Liderazgo',
+        description:
+          'La Evaluación del Nivel de Liderazgo tiene como objetivo medir el grado en que una persona posee habilidades y comportamientos clave de liderazgo, como la toma de decisiones, la comunicación, la influencia y la gestión de equipos, para identificar el nivel actual de liderazgo y las oportunidades de desarrollo.',
+      },
+      behavioralPatterns: {
+        title: 'Áreas de Competencia en Liderazgo',
+        patterns: [
+          {
+            title: 'Autoliderazgo',
+            description:
+              'Mide la capacidad de la persona para gestionarse a sí misma, asumir responsabilidades, mantener la autodisciplina y comprometerse con objetivos personales y profesionales.',
+          },
+          {
+            title: 'Toma de Decisiones',
+            description:
+              'Se centra en la capacidad de analizar situaciones, tomar decisiones eficaces de manera oportuna y asumir la responsabilidad de los resultados.',
+          },
+          {
+            title: 'Comunicación e Influencia',
+            description:
+              'Mide las habilidades de comunicación clara, la escucha activa y la capacidad de influir positivamente en los demás y construir relaciones laborales sólidas.',
+          },
+          {
+            title: 'Gestión de Equipos',
+            description:
+              'Evalúa la capacidad de liderar equipos, delegar tareas, motivar a los miembros y crear un entorno de trabajo colaborativo y productivo.',
+          },
+          {
+            title: 'Inteligencia Emocional',
+            description:
+              'Se centra en la conciencia de las propias emociones y las de los demás, la gestión de las reacciones y la adaptación flexible a la presión y los desafíos.',
+          },
+          {
+            title: 'Visión y Planificación',
+            description:
+              'Mide la capacidad de establecer una visión clara, definir objetivos a largo plazo y planificar estratégicamente para alcanzarlos.',
+          },
+        ],
+      },
+      howItWorks: {
+        title: 'Cómo Funciona la Evaluación de Liderazgo',
+        description:
+          'La evaluación incluye un conjunto de preguntas conductuales y escenarios situacionales que miden distintas habilidades de liderazgo. Las respuestas se analizan para determinar el nivel actual de liderazgo, las fortalezas y las áreas de mejora.',
+      },
+      outputs: {
+        title: 'Resultados de la Evaluación',
+        items: [
+          'Identificación del nivel actual de liderazgo',
+          'Análisis de fortalezas de liderazgo',
+          'Identificación de áreas de desarrollo y mejora',
+          'Recomendaciones para el desarrollo de habilidades de liderazgo',
+          'Plan inicial de desarrollo de liderazgo',
+        ],
+      },
+      useCases: {
+        title: 'Casos de Uso de la Evaluación de Liderazgo',
+        items: [
+          'Desarrollo de liderazgo',
+          'Evaluación de candidatos a puestos de liderazgo',
+          'Creación de planes de desarrollo individual',
+          'Mejora del desempeño de los gerentes',
+          'Programas de formación y desarrollo de liderazgo',
+        ],
+      },
+    },
+    configuration: null,
+  },
+];
+
+export default LEADERSHIP_ASSESSMENT;

package/src/dto/assessment.dto.ts

@@ -0,0 +1,69 @@
+import { ApiProperty, ApiPropertyOptional } from '@nestjs/swagger';
+import {
+  IsNumber,
+  IsOptional,
+  IsString,
+  IsNotEmpty,
+  IsObject,
+} from 'class-validator';
+import { BaseDTO } from './base.dto';
+
+export class AssessmentDto extends BaseDTO {
+  @ApiProperty({ example: 'DISC' })
+  @IsString()
+  @IsNotEmpty()
+  title: string;
+
+  @ApiProperty({ example: 'disc-assessment' })
+  @IsString()
+  @IsNotEmpty()
+  slug: string;
+
+  @ApiProperty({ example: 'online' })
+  @IsString()
+  @IsNotEmpty()
+  type: string;
+
+  @ApiPropertyOptional({ example: 'A detailed Personality assessment' })
+  @IsOptional()
+  @IsString()
+  description?: string;
+
+  @ApiPropertyOptional({ example: 'https://example.com/bg.png' })
+  @IsOptional()
+  @IsString()
+  backgroundImageUrl?: string;
+
+  @ApiPropertyOptional({ example: 100 })
+  @IsOptional()
+  @IsNumber()
+  price?: number;
+
+  @ApiPropertyOptional({ example: 80 })
+  @IsOptional()
+  @IsNumber()
+  discountPrice?: number;
+
+  @ApiPropertyOptional({ example: 'draft' })
+  @IsOptional()
+  @IsString()
+  status?: string;
+
+  @ApiPropertyOptional({
+    example: { duration: 60, language: 'en' },
+    type: Object,
+  })
+  @IsOptional()
+  @IsObject()
+  configuration?: Record<string, any>;
+
+  @ApiPropertyOptional({ example: 'admin' })
+  @IsOptional()
+  @IsString()
+  publishedBy?: string;
+
+  @ApiPropertyOptional({ example: 'SEO meta description for the assessment' })
+  @IsOptional()
+  @IsString()
+  metaDescription?: string;
+}

package/src/dto/base.dto.ts

@@ -0,0 +1,11 @@
+export class BaseDTO {
+  id?: number;
+
+  createdBy?: string;
+
+  createdDate?: Date;
+
+  lastModifiedBy?: string;
+
+  lastModifiedDate?: Date;
+}

package/src/dto/index.ts

@@ -0,0 +1,4 @@
+import { AssessmentDto } from './assessment.dto';
+import { PredefinedAssessmentDto } from './predefined-assessment.dto';
+
+export { AssessmentDto, PredefinedAssessmentDto };

package/src/dto/predefined-assessment.dto.ts

@@ -0,0 +1,59 @@
+import { ApiProperty, ApiPropertyOptional } from '@nestjs/swagger';
+import {
+  IsNumber,
+  IsOptional,
+  IsString,
+  IsNotEmpty,
+  IsObject,
+  IsEnum,
+} from 'class-validator';
+import { BaseDTO } from './base.dto';
+import { AssessmentDetailsLanguage, PredefinedAssessmentType } from '../enums';
+
+export class PredefinedAssessmentDto extends BaseDTO {
+  @ApiProperty({ example: 'DISC' })
+  @IsString()
+  @IsNotEmpty()
+  title: string;
+
+  @ApiPropertyOptional()
+  @IsOptional()
+  @IsEnum(PredefinedAssessmentType)
+  type?: PredefinedAssessmentType;
+
+  @ApiPropertyOptional({ example: 'A detailed Personality assessment' })
+  @IsOptional()
+  @IsString()
+  description?: string;
+
+  @ApiPropertyOptional({ example: 'https://example.com/bg.png' })
+  @IsOptional()
+  @IsString()
+  backgroundImageUrl?: string;
+
+  @ApiPropertyOptional()
+  @IsOptional()
+  @IsEnum(AssessmentDetailsLanguage)
+  language?: AssessmentDetailsLanguage;
+
+  @ApiPropertyOptional({ example: 'Leadership' })
+  @IsOptional()
+  @IsString()
+  category?: string;
+
+  @ApiPropertyOptional({
+    example: { duration: 60, language: 'en' },
+    type: Object,
+  })
+  @IsOptional()
+  @IsObject()
+  configuration?: Record<string, any>;
+
+  @ApiPropertyOptional({
+    example: { duration: 60, language: 'en' },
+    type: Object,
+  })
+  @IsOptional()
+  @IsObject()
+  details?: Record<string, any>;
+}

package/src/entities/assessment.entity.ts

@@ -0,0 +1,41 @@
+import { Column, Entity } from 'typeorm/index.js';
+import { BaseEntity } from './base.entity';
+
+@Entity('assessment')
+export class AssessmentEntity extends BaseEntity {
+  @Column({ nullable: false })
+  title: string;
+
+  @Column({ nullable: false, unique: true })
+  slug: string;
+
+  @Column({ nullable: false })
+  type: string;
+
+  @Column({ nullable: true })
+  description?: string;
+
+  @Column({ nullable: true, name: 'background_image_url' })
+  backgroundImageUrl?: string;
+
+  @Column({ nullable: true })
+  price?: number;
+
+  @Column({ nullable: true, name: 'discount_price' })
+  discountPrice?: number;
+
+  @Column({ nullable: true })
+  status?: string;
+
+  @Column({ nullable: true, name: 'configuration', type: 'json' })
+  configuration?: Record<string, any>;
+
+  @Column({ nullable: true, name: 'published_by' })
+  publishedBy?: string;
+
+  @Column({ default: false, name: 'is_private' })
+  isPrivate?: boolean;
+
+  @Column({ nullable: true, name: 'meta_description' })
+  metaDescription?: string;
+}

package/src/entities/base.entity.ts

@@ -0,0 +1,23 @@
+import {
+  Column,
+  CreateDateColumn,
+  PrimaryGeneratedColumn,
+  UpdateDateColumn,
+} from 'typeorm/index.js';
+
+export abstract class BaseEntity {
+  @PrimaryGeneratedColumn()
+  id?: number;
+
+  @Column({ nullable: true })
+  createdBy?: string;
+
+  @CreateDateColumn({ nullable: true })
+  createdDate?: Date;
+
+  @Column({ nullable: true })
+  lastModifiedBy?: string;
+
+  @UpdateDateColumn({ nullable: true })
+  lastModifiedDate?: Date;
+}

package/src/entities/index.ts

@@ -0,0 +1,4 @@
+import { AssessmentEntity } from './assessment.entity';
+
+import { PredefinedAssessmentEntity } from './predefined-assessment.entity';
+export { AssessmentEntity, PredefinedAssessmentEntity };

package/src/entities/pagination.ts

@@ -0,0 +1,42 @@
+/* eslint-disable max-classes-per-file */
+import { Type, Expose as JsonProperty } from 'class-transformer';
+import { BaseEntity } from './base.entity';
+
+export class Sort {
+  public property: string;
+  public direction: 'ASC' | 'DESC' | string;
+  constructor(sort: string) {
+    if (sort) {
+      [this.property, this.direction] = sort.split(',');
+    }
+  }
+
+  asOrder(): any {
+    const order = {};
+    order[this.property] = this.direction;
+    return order;
+  }
+}
+
+export class PageRequest {
+  @JsonProperty()
+  page: number = 0;
+  @JsonProperty()
+  size: number = 20;
+  @Type(() => Sort)
+  sort: Sort = new Sort('id,ASC');
+
+  constructor(page: number | string, size: number | string, sort: string) {
+    this.page = +page || this.page;
+    this.size = +size || this.size;
+    this.sort = sort ? new Sort(sort) : this.sort;
+  }
+}
+
+export class Page<T extends BaseEntity> {
+  constructor(
+    public content: T[],
+    public total: number,
+    public pageable: PageRequest,
+  ) {}
+}

package/src/entities/predefined-assessment.entity.ts

@@ -0,0 +1,31 @@
+import { Column, Entity, OneToMany } from 'typeorm/index.js';
+import { BaseEntity } from './base.entity';
+import { AssessmentDetailsLanguage } from '../enums/language';
+import { PredefinedAssessmentType } from '../enums/predefined-assessment-type';
+
+@Entity('predefined_assessment')
+export class PredefinedAssessmentEntity extends BaseEntity {
+  @Column({ nullable: false })
+  title: string;
+
+  @Column({ nullable: false, enum: PredefinedAssessmentType })
+  type: PredefinedAssessmentType;
+
+  @Column({ nullable: false })
+  description: string;
+
+  @Column({ nullable: true, name: 'background_image_url' })
+  backgroundImageUrl: string;
+
+  @Column({ nullable: false, enum: AssessmentDetailsLanguage })
+  language: AssessmentDetailsLanguage;
+
+  @Column({ nullable: true })
+  category: string;
+
+  @Column({ nullable: false, type: 'json' })
+  details: Record<string, any>;
+
+  @Column({ nullable: false, type: 'json' })
+  configuration: Record<string, any>;
+}

package/src/enums/index.ts

@@ -0,0 +1,4 @@
+import { AssessmentDetailsLanguage } from '../enums/language';
+import { PredefinedAssessmentType } from '../enums/predefined-assessment-type';
+
+export { AssessmentDetailsLanguage, PredefinedAssessmentType };

package/src/enums/language.ts

@@ -0,0 +1,5 @@
+export enum AssessmentDetailsLanguage {
+  AR = 'AR',
+  EN = 'EN',
+  ES = 'ES',
+}

package/src/enums/predefined-assessment-type.ts

@@ -0,0 +1,5 @@
+export enum PredefinedAssessmentType {
+  HOLLAND = 'HOLLAND',
+  DISC = 'DISC',
+  LEADERSHIP = 'LEADERSHIP',
+}

package/src/interfaces/assessments-options.interface.ts

@@ -0,0 +1,6 @@
+export interface AssessmentModuleOptions {
+  connectionProvider: {
+    getTenantConnection(tenantId: string): Promise<any>;
+    getConnection(): Promise<any>;
+  };
+}

package/src/mappers/assessment.mapper.ts

@@ -0,0 +1,34 @@
+import { AssessmentDto } from '../dto';
+import { AssessmentEntity } from '../entities';
+
+export class AssessmentMapper {
+  static fromDTOToEntity(assessmentDto: AssessmentDto): AssessmentEntity {
+    if (!assessmentDto) {
+      return;
+    }
+    let assessmentEntity = new AssessmentEntity();
+
+    const fields = Object.getOwnPropertyNames(assessmentDto);
+
+    fields.forEach((field) => {
+      assessmentEntity[field] = assessmentDto[field];
+    });
+
+    return assessmentEntity;
+  }
+
+  static fromEntityToDTO(entity: AssessmentEntity): AssessmentDto {
+    if (!entity) {
+      return;
+    }
+    let entityDTO = new AssessmentDto();
+
+    const fields = Object.getOwnPropertyNames(entity);
+
+    fields.forEach((field) => {
+      entityDTO[field] = entity[field];
+    });
+
+    return entityDTO;
+  }
+}

package/src/mappers/predefined-assessment.mapper.ts

@@ -0,0 +1,36 @@
+import { PredefinedAssessmentDto } from "../dto/predefined-assessment.dto";
+import { PredefinedAssessmentEntity } from "../entities/predefined-assessment.entity";
+
+
+export class PredefinedAssessmentMapper {
+  static fromDTOToEntity(predefinedAssessmentDto: PredefinedAssessmentDto): PredefinedAssessmentEntity {
+    if (!predefinedAssessmentDto) {
+      return;
+    }
+
+    let predefinedAssessmentEntity = new PredefinedAssessmentEntity();
+
+    const fields = Object.getOwnPropertyNames(predefinedAssessmentDto);
+
+    fields.forEach((field) => {
+      predefinedAssessmentEntity[field] = predefinedAssessmentDto[field];
+    });
+
+    return predefinedAssessmentEntity;
+  }
+
+  static fromEntityToDTO(entity: PredefinedAssessmentEntity): PredefinedAssessmentDto {
+    if (!entity) {
+      return;
+    }
+    let entityDTO = new PredefinedAssessmentDto();
+
+    const fields = Object.getOwnPropertyNames(entity);
+
+    fields.forEach((field) => {
+      entityDTO[field] = entity[field];
+    });
+
+    return entityDTO;
+  }
+}