@dirayaah/assessment-module 1.0.7 → 1.1.0

package/package.json

@@ -3,7 +3,7 @@
   "publishConfig": {
     "access": "public"
   },
-  "version": "1.0.7",
+  "version": "1.1.0",
   "description": "A reusable module for handling assessments in nestjs applications",
   "main": "dist/index.js",
   "type": "commonjs",

package/src/dto/assessment.dto.ts

@@ -68,6 +68,11 @@ export class AssessmentDto extends BaseDTO {
   @IsString()
   metaDescription?: string;
 
+  @ApiPropertyOptional({ example: 'Url of assessment analyzer helper' })
+  @IsOptional()
+  @IsString()
+  analyzerHelperUrl?: string;
+
   @ApiPropertyOptional({ example: 'SEO meta description for the assessment' })
   @IsOptional()
   @IsObject()

package/src/entities/assessment-report-section.ts

@@ -0,0 +1,36 @@
+/* eslint-disable @typescript-eslint/no-unused-vars */
+import { Entity, Column, ManyToOne, JoinColumn } from 'typeorm';
+import { BaseEntity } from './base.entity';
+import { AssessmentEntity } from './assessment.entity';
+import { AssessmentReportTemplateEntity } from './assessment-report-template';
+
+/**
+ * An Assessment Report Section.
+ */
+@Entity('assessment_report_section')
+export class AssessmentReportSectionEntity extends BaseEntity {
+  @Column({ name: 'title', nullable: true })
+  title?: string;
+
+  @Column({ name: 'content', nullable: true })
+  content?: string;
+
+  @Column({ name: 'type' })
+  type!: string;
+
+  @Column({ name: 'order', type: 'int' })
+  order!: number;
+
+  @Column({ type: 'jsonb', name: 'configuration', nullable: true })
+  configuration?: Record<string, string> | null;
+
+  @ManyToOne(
+    () => AssessmentReportTemplateEntity,
+    (report) => report.sections,
+    {
+      onDelete: 'CASCADE',
+    },
+  )
+  @JoinColumn({ name: 'reportId' })
+  report!: AssessmentReportTemplateEntity;
+}

package/src/entities/assessment-report-template.ts

@@ -0,0 +1,30 @@
+/* eslint-disable @typescript-eslint/no-unused-vars */
+import {
+  Entity,
+  Column,
+  ManyToOne,
+  JoinColumn,
+  OneToOne,
+  OneToMany,
+} from 'typeorm';
+import { BaseEntity } from './base.entity';
+import { AssessmentEntity } from './assessment.entity';
+import { AssessmentReportSectionEntity } from './assessment-report-section';
+
+/**
+ * An Assessment Report Template.
+ */
+@Entity('assessment_report_template')
+export class AssessmentReportTemplateEntity extends BaseEntity {
+  @Column({ name: 'title', nullable: true })
+  title?: string;
+
+  @OneToOne(() => AssessmentEntity, (assessment) => assessment.report, {
+    onDelete: 'CASCADE',
+  })
+  @JoinColumn({ name: 'assessmentId' })
+  assessment!: AssessmentEntity;
+
+  @OneToMany(() => AssessmentReportSectionEntity, (section) => section.report)
+  sections!: AssessmentReportSectionEntity[];
+}

package/src/entities/assessment.entity.ts

@@ -1,6 +1,8 @@
-import { Column, Entity, OneToMany } from 'typeorm/index.js';
+import { Column, Entity, OneToMany, OneToOne } from 'typeorm/index.js';
 import { BaseEntity } from './base.entity';
 import { AssessmentResponseEntity } from './assessment-response.entity';
+import { AssessmentReportSectionEntity } from './assessment-report-section';
+import { AssessmentReportTemplateEntity } from './assessment-report-template';
 
 @Entity('assessment')
 export class AssessmentEntity extends BaseEntity {
@@ -40,9 +42,15 @@ export class AssessmentEntity extends BaseEntity {
   @Column({ nullable: true, name: 'meta_description' })
   metaDescription?: string;
 
+  @Column({ nullable: true, name: 'analyzer_helper_url' })
+  analyzerHelperUrl?: string;
+
   @OneToMany(
     () => AssessmentResponseEntity,
     (assessmentResponse) => assessmentResponse.assessment,
   )
   responses?: AssessmentResponseEntity[];
+
+  @OneToOne(() => AssessmentReportTemplateEntity, (report) => report.assessment)
+  report?: AssessmentReportTemplateEntity;
 }

package/src/entities/index.ts

@@ -1,9 +1,13 @@
 import { AssessmentEntity } from './assessment.entity';
 import { PredefinedAssessmentEntity } from './predefined-assessment.entity';
 import { AssessmentResponseEntity } from './assessment-response.entity';
+import { AssessmentReportSectionEntity } from './assessment-report-section';
+import { AssessmentReportTemplateEntity } from './assessment-report-template';
 
 export {
   AssessmentEntity,
   PredefinedAssessmentEntity,
   AssessmentResponseEntity,
+  AssessmentReportSectionEntity,
+  AssessmentReportTemplateEntity,
 };

package/src/migrations/1771928046729-AlterAssessmentsAddAnalyzerHelperUrl.ts

@@ -0,0 +1,25 @@
+import { MigrationInterface, QueryRunner, TableColumn } from 'typeorm';
+
+export class AlterAssessmentsAddAnalyzerHelperUrl1771928046729 implements MigrationInterface {
+  private tableName = 'assessment';
+  private columnName = 'analyzer_helper_url';
+
+  public async up(queryRunner: QueryRunner): Promise<void> {
+    if (!(await queryRunner.hasColumn(this.tableName, this.columnName))) {
+      await queryRunner.addColumn(
+        this.tableName,
+        new TableColumn({
+          name: this.columnName,
+          type: 'varchar',
+          isNullable: true,
+        }),
+      );
+    }
+  }
+
+  public async down(queryRunner: QueryRunner): Promise<void> {
+    if (await queryRunner.hasColumn(this.tableName, this.columnName)) {
+      await queryRunner.dropColumn(this.tableName, this.columnName);
+    }
+  }
+}

package/src/migrations/1772483026912-CreateAssessmentReportTemplate.ts

@@ -0,0 +1,49 @@
+import { baseColumns } from '../utilities/migrations/get-base-columns';
+import { MigrationInterface, QueryRunner, Table } from 'typeorm';
+
+export class CreateAssessmentReportTemplate1772483026912 implements MigrationInterface {
+  private tableName = 'assessment_report_template';
+
+  public async up(queryRunner: QueryRunner): Promise<void> {
+    const [idColumn, ...otherBaseColumns] = baseColumns;
+
+    await queryRunner.createTable(
+      new Table({
+        name: this.tableName,
+        columns: [
+          idColumn,
+          {
+            name: 'title',
+            type: 'varchar',
+            isNullable: true,
+          },
+          {
+            name: 'assessmentId',
+            type: 'int4',
+          },
+          ...otherBaseColumns,
+        ],
+        foreignKeys: [
+          {
+            columnNames: ['assessmentId'],
+            referencedColumnNames: ['id'],
+            referencedTableName: 'assessment',
+            onDelete: 'CASCADE',
+            name: `${this.tableName}_assessment_id_fk`,
+          },
+        ],
+        indices: [
+          {
+            columnNames: ['assessmentId'],
+            name: `IDX_${this.tableName}_assessment_id`,
+          },
+        ],
+      }),
+      false,
+    );
+  }
+
+  public async down(queryRunner: QueryRunner): Promise<void> {
+    await queryRunner.dropTable(this.tableName, true, true, true);
+  }
+}

package/src/migrations/1772497129497-CreateAssessmentReportSectionTable.ts

@@ -0,0 +1,70 @@
+import { baseColumns } from '../utilities/migrations/get-base-columns';
+import { MigrationInterface, QueryRunner, Table } from 'typeorm';
+
+export class CreateAssessmentReportSectionTable1772497129497 implements MigrationInterface {
+  private tableName = 'assessment_report_section';
+
+  public async up(queryRunner: QueryRunner): Promise<void> {
+    const [idColumn, ...otherBaseColumns] = baseColumns;
+
+    await queryRunner.createTable(
+      new Table({
+        name: this.tableName,
+        columns: [
+          idColumn,
+          {
+            name: 'title',
+            type: 'varchar',
+            isNullable: true,
+          },
+          {
+            name: 'content',
+            type: 'varchar',
+            isNullable: true,
+          },
+          {
+            name: 'type',
+            type: 'varchar',
+            isNullable: false,
+          },
+          {
+            name: 'order',
+            type: 'int4',
+            isNullable: false,
+          },
+          {
+            name: 'reportId',
+            type: 'int4',
+            isNullable: false,
+          },
+          {
+            name: 'configuration',
+            type: 'jsonb',
+            isNullable: true,
+          },
+          ...otherBaseColumns,
+        ],
+        foreignKeys: [
+          {
+            columnNames: ['reportId'],
+            referencedColumnNames: ['id'],
+            referencedTableName: 'assessment_report_template',
+            onDelete: 'CASCADE',
+            name: `${this.tableName}_report_id_fk`,
+          },
+        ],
+        indices: [
+          {
+            columnNames: ['reportId'],
+            name: `IDX_${this.tableName}_report_id`,
+          },
+        ],
+      }),
+      false,
+    );
+  }
+
+  public async down(queryRunner: QueryRunner): Promise<void> {
+    await queryRunner.dropTable(this.tableName, true, true, true);
+  }
+}

package/src/migrations/index.ts

@@ -8,6 +8,9 @@ import { AddMetaFieldsToAssessmentTable1767651698587 } from './1767651698587-Add
 import { CreateAssessmentResponseTable1769428739895 } from './1769428739895-CreateAssessmentResponseTable';
 import { AlterAssessmentResponseTable1771110620466 } from './1771110620466-AlterAssessmentResponseTable';
 import { AlterAssessmentResponseAddSummary1771247066741 } from './1771247066741-AlterAssessmentResponseAddSummary';
+import { AlterAssessmentsAddAnalyzerHelperUrl1771928046729 } from './1771928046729-AlterAssessmentsAddAnalyzerHelperUrl';
+import { CreateAssessmentReportSectionTable1772497129497 } from './1772497129497-createAssessmentReportSectionTable';
+import { CreateAssessmentReportTemplate1772483026912 } from './1772483026912-CreateAssessmentReportTemplate';
 export const AssessmentMigrations = [
   CreateAssessmentTable1767108782301,
   CreatePredefinedAssessmentTable1767200020161,
@@ -16,6 +19,9 @@ export const AssessmentMigrations = [
   CreateAssessmentResponseTable1769428739895,
   AlterAssessmentResponseTable1771110620466,
   AlterAssessmentResponseAddSummary1771247066741,
+  AlterAssessmentsAddAnalyzerHelperUrl1771928046729,
+  CreateAssessmentReportSectionTable1772497129497,
+  CreateAssessmentReportTemplate1772483026912,
 ];
 
 export {
@@ -26,4 +32,7 @@ export {
   CreateAssessmentResponseTable1769428739895,
   AlterAssessmentResponseTable1771110620466,
   AlterAssessmentResponseAddSummary1771247066741,
+  AlterAssessmentsAddAnalyzerHelperUrl1771928046729,
+  CreateAssessmentReportSectionTable1772497129497,
+  CreateAssessmentReportTemplate1772483026912,
 };

package/src/repositories/assessment-report-section.repository.ts

@@ -0,0 +1,6 @@
+import { EntityRepository } from 'typeorm';
+import { AssessmentReportSectionEntity } from '../entities';
+import { BaseRepository } from './base.repository';
+
+@EntityRepository(AssessmentReportSectionEntity)
+export class AssessmentReportSectionRepository extends BaseRepository<AssessmentReportSectionEntity> {}

package/src/repositories/assessment-report-template.repository.ts

@@ -0,0 +1,6 @@
+import { EntityRepository } from 'typeorm';
+import { AssessmentReportTemplateEntity } from '../entities';
+import { BaseRepository } from './base.repository';
+
+@EntityRepository(AssessmentReportTemplateEntity)
+export class AssessmentReportTemplateRepository extends BaseRepository<AssessmentReportTemplateEntity> {}

package/src/repositories/index.ts

@@ -1,9 +1,12 @@
 import { AssessmentRepository } from './assessment.repository';
 import { PredefinedAssessmentRepository } from './predefined-assessment.repository';
 import { AssessmentResponseRepository } from './assessment-response.repository';
-
+import { AssessmentReportSectionRepository } from './assessment-report-section.repository';
+import { AssessmentReportTemplateRepository } from './assessment-report-template.repository';
 export {
   AssessmentRepository,
   PredefinedAssessmentRepository,
   AssessmentResponseRepository,
+  AssessmentReportSectionRepository,
+  AssessmentReportTemplateRepository,
 };