@driveup/schema 0.1.0

package/lib/profile/company/course/lesson.entity.js

@@ -0,0 +1,288 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CompanyCourseLessonEntity = void 0;
+const typeorm_1 = require("typeorm");
+const common_1 = require("@driveup/common");
+const course_entity_1 = require("./course.entity");
+const topic_entity_1 = require("./topic.entity");
+const appointment_entity_1 = require("./appointment.entity");
+const instructor_entity_1 = require("../instructor/instructor.entity");
+const lesson_entity_1 = require("../../student/program/training/lesson.entity");
+const utils_1 = require("../../../utils");
+/**
+ * Company Course Lesson Entity
+ *
+ * Represents course lesson which can be interpreted differently depending on course type:
+ *
+ * - Theory Courses: Lessons are classic lesson subdivisions within standard lessons
+ * - Driving Courses: Lessons represent driving learning phases
+ *   (e.g., Basic Vehicle Control, Simple Traffic Situations, Complex Traffic Situations, Special Manoeuvres, Driving on Motorway, Safety & Eco Driving)
+ *   and topics are the specific session topics within those phases
+ */
+let CompanyCourseLessonEntity = class CompanyCourseLessonEntity extends utils_1.TrackableEntity {
+    /**
+     * Company course
+     */
+    courseId;
+    /**
+     * In-charge instructor for the course lesson
+     * Flexible lessons can have their own instructor
+     */
+    instructorId;
+    /****************** Content ******************/
+    /**
+     * Lesson number or sequence identifier
+     */
+    number;
+    /**
+     * Lesson title
+     */
+    title;
+    /**
+     * Lesson description
+     */
+    description;
+    /**
+     * Lesson header image (upcoming)
+     */
+    imageUrl;
+    /**
+     * Lesson gallery images (upcoming)
+     */
+    gallery;
+    /**
+     * Lesson sort order within the course
+     */
+    sort;
+    /****************** Calendar ******************/
+    /**
+     * Lesson start date
+     * Only used in fixed trainings
+     */
+    startDate;
+    /**
+     * Lesson end date
+     * Only used in fixed trainings
+     */
+    endDate;
+    /**
+     * Lesson duration in minutes
+     * Important for flexible courses
+     */
+    duration;
+    /**
+     * Location where the lesson takes place
+     */
+    location;
+    /***************** Tracks *****************/
+    /**
+     * Timestamp when the lesson was canceled
+     */
+    canceledOn;
+    /**
+     * ID of the user who canceled the lesson
+     */
+    canceledBy;
+    /**
+     * Course relation
+     */
+    course;
+    /**
+     * Lesson in-charge instructor
+     */
+    instructor;
+    /**
+     * Company lesson topics
+     */
+    topics;
+    /**
+     * Company lesson appointments
+     */
+    appointments;
+    /**
+     * Student training lessons based on this lesson
+     */
+    studentLessons;
+    /**
+     * Creates a new CompanyCourseLessonEntity instance
+     * @param props - Partial properties to initialize the entity with
+     */
+    constructor(props) {
+        super();
+        Object.assign(this, props);
+    }
+    /**
+     * Converts the entity to a Lesson model instance
+     * @returns Promise resolving to Lesson model with all lesson details including instructor, location, and gallery
+     */
+    async toModel() {
+        const instructor = this.instructorId ? await (await this.instructor).toModel() : null;
+        return common_1.Lesson.toInstance({
+            id: this.id,
+            instructor: instructor,
+            number: this.number,
+            title: this.title,
+            description: this.description,
+            imageUrl: this.imageUrl,
+            gallery: this.gallery ? this.gallery.map(common_1.Picture.toInstance) : null,
+            sort: this.sort,
+            startDate: this.startDate,
+            endDate: this.endDate,
+            duration: this.duration,
+            location: this.location ? common_1.Address.toInstance(this.location) : null
+        });
+    }
+    /**
+     * Returns a summary representation of the lesson with essential information
+     * @returns Lesson model with basic details (id, title, number, dates, duration)
+     */
+    toSummary() {
+        return common_1.Lesson.toInstance({
+            id: this.id,
+            title: this.title,
+            number: this.number,
+            startDate: this.startDate,
+            endDate: this.endDate,
+            duration: this.duration,
+        });
+    }
+    /**
+     * Retrieves all tracked activities for this lesson
+     * Includes creation, update, and cancellation timestamps with associated users
+     * @returns Promise resolving to array of Activity objects filtered to exclude null values
+     */
+    async getActivities() {
+        const activities = [];
+        activities.push(await (0, utils_1.toActivity)(this.createdBy, common_1.ActivityType.createdBy));
+        activities.push(await (0, utils_1.toActivity)(this.createdOn, common_1.ActivityType.createdOn));
+        activities.push(await (0, utils_1.toActivity)(this.updatedBy, common_1.ActivityType.updatedBy));
+        activities.push(await (0, utils_1.toActivity)(this.updatedOn, common_1.ActivityType.updatedOn));
+        activities.push(await (0, utils_1.toActivity)(this.canceledBy, common_1.ActivityType.canceledBy));
+        activities.push(await (0, utils_1.toActivity)(this.canceledOn, common_1.ActivityType.canceledOn));
+        return activities.filter(a => a);
+    }
+};
+exports.CompanyCourseLessonEntity = CompanyCourseLessonEntity;
+__decorate([
+    (0, typeorm_1.Column)(),
+    __metadata("design:type", Number)
+], CompanyCourseLessonEntity.prototype, "courseId", void 0);
+__decorate([
+    (0, typeorm_1.Column)({
+        nullable: true,
+        default: null
+    }),
+    __metadata("design:type", Number)
+], CompanyCourseLessonEntity.prototype, "instructorId", void 0);
+__decorate([
+    (0, typeorm_1.Column)({
+        nullable: true,
+        default: null
+    }),
+    __metadata("design:type", Number)
+], CompanyCourseLessonEntity.prototype, "number", void 0);
+__decorate([
+    (0, typeorm_1.Column)(),
+    __metadata("design:type", String)
+], CompanyCourseLessonEntity.prototype, "title", void 0);
+__decorate([
+    (0, typeorm_1.Column)({
+        nullable: true,
+        default: null
+    }),
+    __metadata("design:type", String)
+], CompanyCourseLessonEntity.prototype, "description", void 0);
+__decorate([
+    (0, typeorm_1.Column)({
+        nullable: true,
+        default: null
+    }),
+    __metadata("design:type", String)
+], CompanyCourseLessonEntity.prototype, "imageUrl", void 0);
+__decorate([
+    (0, typeorm_1.Column)({
+        type: 'simple-json',
+        nullable: true,
+        default: null
+    }),
+    __metadata("design:type", Array)
+], CompanyCourseLessonEntity.prototype, "gallery", void 0);
+__decorate([
+    (0, typeorm_1.Column)({
+        type: 'tinyint',
+        nullable: true,
+        default: null
+    }),
+    __metadata("design:type", Number)
+], CompanyCourseLessonEntity.prototype, "sort", void 0);
+__decorate([
+    (0, typeorm_1.Column)({
+        nullable: true,
+        default: null
+    }),
+    __metadata("design:type", Date)
+], CompanyCourseLessonEntity.prototype, "startDate", void 0);
+__decorate([
+    (0, typeorm_1.Column)({
+        nullable: true,
+        default: null
+    }),
+    __metadata("design:type", Date)
+], CompanyCourseLessonEntity.prototype, "endDate", void 0);
+__decorate([
+    (0, typeorm_1.Column)({
+        nullable: true,
+        default: null
+    }),
+    __metadata("design:type", Number)
+], CompanyCourseLessonEntity.prototype, "duration", void 0);
+__decorate([
+    (0, typeorm_1.Column)({
+        type: 'simple-json',
+        nullable: true,
+        default: null
+    }),
+    __metadata("design:type", common_1.Address)
+], CompanyCourseLessonEntity.prototype, "location", void 0);
+__decorate([
+    (0, typeorm_1.Column)({ nullable: false, default: false }),
+    __metadata("design:type", Date)
+], CompanyCourseLessonEntity.prototype, "canceledOn", void 0);
+__decorate([
+    (0, typeorm_1.Column)({ nullable: false, default: false }),
+    __metadata("design:type", Number)
+], CompanyCourseLessonEntity.prototype, "canceledBy", void 0);
+__decorate([
+    (0, typeorm_1.ManyToOne)(() => course_entity_1.CompanyCourseEntity, product => product.lessons),
+    __metadata("design:type", Promise)
+], CompanyCourseLessonEntity.prototype, "course", void 0);
+__decorate([
+    (0, typeorm_1.ManyToOne)(() => instructor_entity_1.CompanyInstructorEntity, instructor => instructor.companyCourseLessons),
+    __metadata("design:type", Promise)
+], CompanyCourseLessonEntity.prototype, "instructor", void 0);
+__decorate([
+    (0, typeorm_1.OneToMany)(() => topic_entity_1.CompanyCourseTopicEntity, student => student.lesson),
+    __metadata("design:type", Promise)
+], CompanyCourseLessonEntity.prototype, "topics", void 0);
+__decorate([
+    (0, typeorm_1.OneToMany)(() => appointment_entity_1.CompanyCourseAppointmentEntity, student => student.lesson),
+    __metadata("design:type", Promise)
+], CompanyCourseLessonEntity.prototype, "appointments", void 0);
+__decorate([
+    (0, typeorm_1.OneToMany)(() => lesson_entity_1.StudentTrainingLessonEntity, student => student.lesson),
+    __metadata("design:type", Promise)
+], CompanyCourseLessonEntity.prototype, "studentLessons", void 0);
+exports.CompanyCourseLessonEntity = CompanyCourseLessonEntity = __decorate([
+    (0, typeorm_1.Entity)('companyCourseLessons'),
+    __metadata("design:paramtypes", [Object])
+], CompanyCourseLessonEntity);
+//# sourceMappingURL=lesson.entity.js.map

package/lib/profile/company/course/lesson.entity.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"lesson.entity.js","sourceRoot":"","sources":["../../../../src/profile/company/course/lesson.entity.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,qCAAgE;AAChE,4CAAmF;AACnF,mDAAsD;AACtD,iDAA0D;AAC1D,6DAAsE;AACtE,uEAA0E;AAC1E,gFAA2F;AAC3F,0CAA6D;AAE7D;;;;;;;;;GASG;AAEI,IAAM,yBAAyB,GAA/B,MAAM,yBAA0B,SAAQ,uBAAuB;IAErE;;OAEG;IAEH,QAAQ,CAAS;IAEjB;;;OAGG;IAKH,YAAY,CAAS;IAErB,+CAA+C;IAE/C;;OAEG;IAKH,MAAM,CAAS;IAEf;;OAEG;IAEH,KAAK,CAAS;IAEd;;OAEG;IAKH,WAAW,CAAS;IAEpB;;OAEG;IAKH,QAAQ,CAAS;IAEjB;;OAEG;IAMH,OAAO,CAAY;IAEnB;;OAEG;IAMH,IAAI,CAAS;IAEb,gDAAgD;IAEhD;;;OAGG;IAKH,SAAS,CAAO;IAEhB;;;OAGG;IAKH,OAAO,CAAO;IAEd;;;OAGG;IAKH,QAAQ,CAAS;IAEjB;;OAEG;IAMH,QAAQ,CAAU;IAElB,4CAA4C;IAE5C;;OAEG;IAEH,UAAU,CAAO;IAEjB;;OAEG;IAEH,UAAU,CAAS;IAEnB;;OAEG;IAEH,MAAM,CAA+B;IAErC;;OAEG;IAEH,UAAU,CAAmC;IAE7C;;OAEG;IAEH,MAAM,CAAsC;IAE5C;;OAEG;IAEH,YAAY,CAA4C;IAExD;;OAEG;IAEH,cAAc,CAAyC;IAEvD;;;OAGG;IACH,YAAY,KAA0C;QACrD,KAAK,EAAE,CAAC;QACR,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;IAC5B,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,OAAO;QACZ,MAAM,UAAU,GAAG,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC,MAAM,CAAC,MAAM,IAAI,CAAC,UAAU,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC;QACtF,OAAO,eAAM,CAAC,UAAU,CAAC;YACxB,EAAE,EAAE,IAAI,CAAC,EAAE;YACX,UAAU,EAAE,UAAU;YACtB,MAAM,EAAE,IAAI,CAAC,MAAM;YACnB,KAAK,EAAE,IAAI,CAAC,KAAK;YACjB,WAAW,EAAE,IAAI,CAAC,WAAW;YAC7B,QAAQ,EAAE,IAAI,CAAC,QAAQ;YACvB,OAAO,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,gBAAO,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,IAAI;YACnE,IAAI,EAAE,IAAI,CAAC,IAAI;YACf,SAAS,EAAE,IAAI,CAAC,SAAS;YACzB,OAAO,EAAE,IAAI,CAAC,OAAO;YACrB,QAAQ,EAAE,IAAI,CAAC,QAAQ;YACvB,QAAQ,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,gBAAO,CAAC,UAAU,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,IAAI;SAClE,CAAC,CAAC;IACJ,CAAC;IAED;;;OAGG;IACH,SAAS;QACR,OAAO,eAAM,CAAC,UAAU,CAAC;YACxB,EAAE,EAAE,IAAI,CAAC,EAAE;YACX,KAAK,EAAE,IAAI,CAAC,KAAK;YACjB,MAAM,EAAE,IAAI,CAAC,MAAM;YACnB,SAAS,EAAE,IAAI,CAAC,SAAS;YACzB,OAAO,EAAE,IAAI,CAAC,OAAO;YACrB,QAAQ,EAAE,IAAI,CAAC,QAAQ;SACvB,CAAC,CAAC;IACJ,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,aAAa;QAClB,MAAM,UAAU,GAAe,EAAE,CAAC;QAClC,UAAU,CAAC,IAAI,CAAC,MAAM,IAAA,kBAAU,EAAC,IAAI,CAAC,SAAS,EAAE,qBAAY,CAAC,SAAS,CAAC,CAAC,CAAC;QAC1E,UAAU,CAAC,IAAI,CAAC,MAAM,IAAA,kBAAU,EAAC,IAAI,CAAC,SAAS,EAAE,qBAAY,CAAC,SAAS,CAAC,CAAC,CAAC;QAC1E,UAAU,CAAC,IAAI,CAAC,MAAM,IAAA,kBAAU,EAAC,IAAI,CAAC,SAAS,EAAE,qBAAY,CAAC,SAAS,CAAC,CAAC,CAAC;QAC1E,UAAU,CAAC,IAAI,CAAC,MAAM,IAAA,kBAAU,EAAC,IAAI,CAAC,SAAS,EAAE,qBAAY,CAAC,SAAS,CAAC,CAAC,CAAC;QAC1E,UAAU,CAAC,IAAI,CAAC,MAAM,IAAA,kBAAU,EAAC,IAAI,CAAC,UAAU,EAAE,qBAAY,CAAC,UAAU,CAAC,CAAC,CAAC;QAC5E,UAAU,CAAC,IAAI,CAAC,MAAM,IAAA,kBAAU,EAAC,IAAI,CAAC,UAAU,EAAE,qBAAY,CAAC,UAAU,CAAC,CAAC,CAAC;QAC5E,OAAO,UAAU,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;IAClC,CAAC;CACD,CAAA;AA5NY,8DAAyB;AAMrC;IADC,IAAA,gBAAM,GAAE;;2DACQ;AAUjB;IAJC,IAAA,gBAAM,EAAC;QACP,QAAQ,EAAE,IAAI;QACd,OAAO,EAAE,IAAI;KACb,CAAC;;+DACmB;AAWrB;IAJC,IAAA,gBAAM,EAAC;QACP,QAAQ,EAAE,IAAI;QACd,OAAO,EAAE,IAAI;KACb,CAAC;;yDACa;AAMf;IADC,IAAA,gBAAM,GAAE;;wDACK;AASd;IAJC,IAAA,gBAAM,EAAC;QACP,QAAQ,EAAE,IAAI;QACd,OAAO,EAAE,IAAI;KACb,CAAC;;8DACkB;AASpB;IAJC,IAAA,gBAAM,EAAC;QACP,QAAQ,EAAE,IAAI;QACd,OAAO,EAAE,IAAI;KACb,CAAC;;2DACe;AAUjB;IALC,IAAA,gBAAM,EAAC;QACP,IAAI,EAAE,aAAa;QACnB,QAAQ,EAAE,IAAI;QACd,OAAO,EAAE,IAAI;KACb,CAAC;;0DACiB;AAUnB;IALC,IAAA,gBAAM,EAAC;QACP,IAAI,EAAE,SAAS;QACf,QAAQ,EAAE,IAAI;QACd,OAAO,EAAE,IAAI;KACb,CAAC;;uDACW;AAYb;IAJC,IAAA,gBAAM,EAAC;QACP,QAAQ,EAAE,IAAI;QACd,OAAO,EAAE,IAAI;KACb,CAAC;8BACS,IAAI;4DAAC;AAUhB;IAJC,IAAA,gBAAM,EAAC;QACP,QAAQ,EAAE,IAAI;QACd,OAAO,EAAE,IAAI;KACb,CAAC;8BACO,IAAI;0DAAC;AAUd;IAJC,IAAA,gBAAM,EAAC;QACP,QAAQ,EAAE,IAAI;QACd,OAAO,EAAE,IAAI;KACb,CAAC;;2DACe;AAUjB;IALC,IAAA,gBAAM,EAAC;QACP,IAAI,EAAE,aAAa;QACnB,QAAQ,EAAE,IAAI;QACd,OAAO,EAAE,IAAI;KACb,CAAC;8BACQ,gBAAO;2DAAC;AAQlB;IADC,IAAA,gBAAM,EAAC,EAAE,QAAQ,EAAE,KAAK,EAAE,OAAO,EAAE,KAAK,EAAE,CAAC;8BAChC,IAAI;6DAAC;AAMjB;IADC,IAAA,gBAAM,EAAC,EAAE,QAAQ,EAAE,KAAK,EAAE,OAAO,EAAE,KAAK,EAAE,CAAC;;6DACzB;AAMnB;IADC,IAAA,mBAAS,EAAC,GAAG,EAAE,CAAC,mCAAmB,EAAE,OAAO,CAAC,EAAE,CAAC,OAAO,CAAC,OAAO,CAAC;;yDAC5B;AAMrC;IADC,IAAA,mBAAS,EAAC,GAAG,EAAE,CAAC,2CAAuB,EAAE,UAAU,CAAC,EAAE,CAAC,UAAU,CAAC,oBAAoB,CAAC;;6DAC3C;AAM7C;IADC,IAAA,mBAAS,EAAC,GAAG,EAAE,CAAC,uCAAwB,EAAE,OAAO,CAAC,EAAE,CAAC,OAAO,CAAC,MAAM,CAAC;;yDACzB;AAM5C;IADC,IAAA,mBAAS,EAAC,GAAG,EAAE,CAAC,mDAA8B,EAAE,OAAO,CAAC,EAAE,CAAC,OAAO,CAAC,MAAM,CAAC;;+DACnB;AAMxD;IADC,IAAA,mBAAS,EAAC,GAAG,EAAE,CAAC,2CAA2B,EAAE,OAAO,CAAC,EAAE,CAAC,OAAO,CAAC,MAAM,CAAC;;iEACjB;oCA7J3C,yBAAyB;IADrC,IAAA,gBAAM,EAAC,sBAAsB,CAAC;;GAClB,yBAAyB,CA4NrC"}

package/lib/profile/company/course/topic.entity.d.ts

@@ -0,0 +1,55 @@
+import { Activity, Skill, Topic } from '@driveup/common';
+import { CompanyCourseLessonEntity } from './lesson.entity';
+import { StudentTrainingTopicEntity } from '../../student/program/training/topic.entity';
+import { TrackableEntity } from '../../../utils';
+/**
+ * Company Course Topic Entity
+ *
+ * Represents lesson parts (topics) which can be interpreted differently depending on course type:
+ *
+ * - Theory Courses: Topics are classic lesson subdivisions within standard lessons
+ * - Driving Courses: Lessons represent driving learning phases
+ *   (e.g., Basic Vehicle Control, Simple Traffic Situations, Complex Traffic Situations, Special Manoeuvres, Driving on Motorway, Safety & Eco Driving)
+ *   and topics are the specific session topics within those phases
+ */
+export declare class CompanyCourseTopicEntity extends TrackableEntity<Topic> {
+    /**
+     * Reference to the lesson this topic belongs to
+     */
+    lessonId: number;
+    /**
+     * Title of the topic
+     */
+    title: string;
+    /**
+     * Detailed description of the topic content
+     */
+    description: string;
+    /**
+     * URL to the topic's representative image
+     */
+    imageUrl: string;
+    /**
+     * Sort order for displaying topics within a lesson
+     */
+    sort: number;
+    /**
+     * List of skills covered in this topic
+     */
+    skills: Skill[];
+    /**
+     * Reference to the parent lesson
+     */
+    lesson: Promise<CompanyCourseLessonEntity>;
+    /**
+     * Student training lesson topic relations
+     * Keep track to student training topics in case by update or delete the lexxon topic
+     * to handle the student topics accordingly
+     * Only trainings in progress can be uodated or deleted from student lessons
+     */
+    studentTopics: Promise<StudentTrainingTopicEntity[]>;
+    constructor(props?: Partial<CompanyCourseTopicEntity>);
+    toModel(): Topic;
+    toSummary(): Topic;
+    getActivities(): Promise<Activity[]>;
+}

package/lib/profile/company/course/topic.entity.js

@@ -0,0 +1,147 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CompanyCourseTopicEntity = void 0;
+const typeorm_1 = require("typeorm");
+const common_1 = require("@driveup/common");
+const lesson_entity_1 = require("./lesson.entity");
+const topic_entity_1 = require("../../student/program/training/topic.entity");
+const utils_1 = require("../../../utils");
+/**
+ * Company Course Topic Entity
+ *
+ * Represents lesson parts (topics) which can be interpreted differently depending on course type:
+ *
+ * - Theory Courses: Topics are classic lesson subdivisions within standard lessons
+ * - Driving Courses: Lessons represent driving learning phases
+ *   (e.g., Basic Vehicle Control, Simple Traffic Situations, Complex Traffic Situations, Special Manoeuvres, Driving on Motorway, Safety & Eco Driving)
+ *   and topics are the specific session topics within those phases
+ */
+let CompanyCourseTopicEntity = class CompanyCourseTopicEntity extends utils_1.TrackableEntity {
+    /**
+     * Reference to the lesson this topic belongs to
+     */
+    lessonId;
+    /**
+     * Title of the topic
+     */
+    title;
+    /**
+     * Detailed description of the topic content
+     */
+    description;
+    /**
+     * URL to the topic's representative image
+     */
+    imageUrl;
+    /**
+     * Sort order for displaying topics within a lesson
+     */
+    sort;
+    /**
+     * List of skills covered in this topic
+     */
+    skills;
+    /**
+     * Reference to the parent lesson
+     */
+    lesson;
+    /**
+     * Student training lesson topic relations
+     * Keep track to student training topics in case by update or delete the lexxon topic
+     * to handle the student topics accordingly
+     * Only trainings in progress can be uodated or deleted from student lessons
+     */
+    studentTopics;
+    constructor(props) {
+        super();
+        Object.assign(this, props);
+    }
+    toModel() {
+        return new common_1.Topic({
+            id: this.id,
+            title: this.title,
+            description: this.description,
+            imageUrl: this.imageUrl,
+            skills: this.skills ? this.skills.map(common_1.Skill.toInstance) : null,
+            sort: this.sort
+        });
+    }
+    toSummary() {
+        return new common_1.Topic({
+            id: this.id,
+            title: this.title,
+            imageUrl: this.imageUrl,
+            sort: this.sort
+        });
+    }
+    async getActivities() {
+        const activities = [];
+        activities.push(await (0, utils_1.toActivity)(this.createdBy, common_1.ActivityType.createdBy));
+        activities.push(await (0, utils_1.toActivity)(this.createdOn, common_1.ActivityType.createdOn));
+        activities.push(await (0, utils_1.toActivity)(this.updatedBy, common_1.ActivityType.updatedBy));
+        activities.push(await (0, utils_1.toActivity)(this.updatedOn, common_1.ActivityType.updatedOn));
+        return activities.filter(a => a);
+    }
+};
+exports.CompanyCourseTopicEntity = CompanyCourseTopicEntity;
+__decorate([
+    (0, typeorm_1.Column)(),
+    __metadata("design:type", Number)
+], CompanyCourseTopicEntity.prototype, "lessonId", void 0);
+__decorate([
+    (0, typeorm_1.Column)(),
+    __metadata("design:type", String)
+], CompanyCourseTopicEntity.prototype, "title", void 0);
+__decorate([
+    (0, typeorm_1.Column)({
+        type: 'mediumtext',
+        nullable: true,
+        default: null
+    }),
+    __metadata("design:type", String)
+], CompanyCourseTopicEntity.prototype, "description", void 0);
+__decorate([
+    (0, typeorm_1.Column)({
+        nullable: true,
+        default: null
+    }),
+    __metadata("design:type", String)
+], CompanyCourseTopicEntity.prototype, "imageUrl", void 0);
+__decorate([
+    (0, typeorm_1.Column)({
+        type: 'tinyint',
+        nullable: true,
+        default: null
+    }),
+    __metadata("design:type", Number)
+], CompanyCourseTopicEntity.prototype, "sort", void 0);
+__decorate([
+    (0, typeorm_1.Column)({
+        type: 'json',
+        nullable: true,
+        default: null
+    }),
+    __metadata("design:type", Array)
+], CompanyCourseTopicEntity.prototype, "skills", void 0);
+__decorate([
+    (0, typeorm_1.ManyToOne)(() => lesson_entity_1.CompanyCourseLessonEntity, lesson => lesson.topics),
+    __metadata("design:type", Promise)
+], CompanyCourseTopicEntity.prototype, "lesson", void 0);
+__decorate([
+    (0, typeorm_1.OneToMany)(() => topic_entity_1.StudentTrainingTopicEntity, topic => topic.topic),
+    __metadata("design:type", Promise)
+], CompanyCourseTopicEntity.prototype, "studentTopics", void 0);
+exports.CompanyCourseTopicEntity = CompanyCourseTopicEntity = __decorate([
+    (0, typeorm_1.Entity)('companyCourseTopics'),
+    __metadata("design:paramtypes", [Object])
+], CompanyCourseTopicEntity);
+//# sourceMappingURL=topic.entity.js.map

package/lib/profile/company/course/topic.entity.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"topic.entity.js","sourceRoot":"","sources":["../../../../src/profile/company/course/topic.entity.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,qCAAgE;AAChE,4CAAuE;AACvE,mDAA4D;AAC5D,8EAAyF;AACzF,0CAA6D;AAE7D;;;;;;;;;GASG;AAEI,IAAM,wBAAwB,GAA9B,MAAM,wBAAyB,SAAQ,uBAAsB;IAEnE;;OAEG;IAEH,QAAQ,CAAS;IAEjB;;OAEG;IAEH,KAAK,CAAS;IAEd;;OAEG;IAMH,WAAW,CAAS;IAEpB;;OAEG;IAKH,QAAQ,CAAS;IAEjB;;OAEG;IAMH,IAAI,CAAS;IAEb;;OAEG;IAMH,MAAM,CAAU;IAEhB;;OAEG;IAEH,MAAM,CAAqC;IAE3C;;;;;OAKG;IAEH,aAAa,CAAwC;IAErD,YAAY,KAAyC;QACpD,KAAK,EAAE,CAAC;QACR,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;IAC5B,CAAC;IAED,OAAO;QACN,OAAO,IAAI,cAAK,CAAC;YAChB,EAAE,EAAE,IAAI,CAAC,EAAE;YACX,KAAK,EAAE,IAAI,CAAC,KAAK;YACjB,WAAW,EAAE,IAAI,CAAC,WAAW;YAC7B,QAAQ,EAAE,IAAI,CAAC,QAAQ;YACvB,MAAM,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,cAAK,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,IAAI;YAC9D,IAAI,EAAE,IAAI,CAAC,IAAI;SACf,CAAC,CAAC;IACJ,CAAC;IAED,SAAS;QACR,OAAO,IAAI,cAAK,CAAC;YAChB,EAAE,EAAE,IAAI,CAAC,EAAE;YACX,KAAK,EAAE,IAAI,CAAC,KAAK;YACjB,QAAQ,EAAE,IAAI,CAAC,QAAQ;YACvB,IAAI,EAAE,IAAI,CAAC,IAAI;SACf,CAAC,CAAC;IACJ,CAAC;IAED,KAAK,CAAC,aAAa;QAClB,MAAM,UAAU,GAAe,EAAE,CAAC;QAClC,UAAU,CAAC,IAAI,CAAC,MAAM,IAAA,kBAAU,EAAC,IAAI,CAAC,SAAS,EAAE,qBAAY,CAAC,SAAS,CAAC,CAAC,CAAC;QAC1E,UAAU,CAAC,IAAI,CAAC,MAAM,IAAA,kBAAU,EAAC,IAAI,CAAC,SAAS,EAAE,qBAAY,CAAC,SAAS,CAAC,CAAC,CAAC;QAC1E,UAAU,CAAC,IAAI,CAAC,MAAM,IAAA,kBAAU,EAAC,IAAI,CAAC,SAAS,EAAE,qBAAY,CAAC,SAAS,CAAC,CAAC,CAAC;QAC1E,UAAU,CAAC,IAAI,CAAC,MAAM,IAAA,kBAAU,EAAC,IAAI,CAAC,SAAS,EAAE,qBAAY,CAAC,SAAS,CAAC,CAAC,CAAC;QAC1E,OAAO,UAAU,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;IAClC,CAAC;CACD,CAAA;AArGY,4DAAwB;AAMpC;IADC,IAAA,gBAAM,GAAE;;0DACQ;AAMjB;IADC,IAAA,gBAAM,GAAE;;uDACK;AAUd;IALC,IAAA,gBAAM,EAAC;QACP,IAAI,EAAE,YAAY;QAClB,QAAQ,EAAE,IAAI;QACd,OAAO,EAAE,IAAI;KACb,CAAC;;6DACkB;AASpB;IAJC,IAAA,gBAAM,EAAC;QACP,QAAQ,EAAE,IAAI;QACd,OAAO,EAAE,IAAI;KACb,CAAC;;0DACe;AAUjB;IALC,IAAA,gBAAM,EAAC;QACP,IAAI,EAAE,SAAS;QACf,QAAQ,EAAE,IAAI;QACd,OAAO,EAAE,IAAI;KACb,CAAC;;sDACW;AAUb;IALC,IAAA,gBAAM,EAAC;QACP,IAAI,EAAE,MAAM;QACZ,QAAQ,EAAE,IAAI;QACd,OAAO,EAAE,IAAI;KACb,CAAC;;wDACc;AAMhB;IADC,IAAA,mBAAS,EAAC,GAAG,EAAE,CAAC,yCAAyB,EAAE,MAAM,CAAC,EAAE,CAAC,MAAM,CAAC,MAAM,CAAC;;wDACzB;AAS3C;IADC,IAAA,mBAAS,EAAC,GAAG,EAAE,CAAC,yCAA0B,EAAE,KAAK,CAAC,EAAE,CAAC,KAAK,CAAC,KAAK,CAAC;;+DACb;mCAlEzC,wBAAwB;IADpC,IAAA,gBAAM,EAAC,qBAAqB,CAAC;;GACjB,wBAAwB,CAqGpC"}

package/lib/profile/company/finances/billing/bill.entity.d.ts

@@ -0,0 +1,145 @@
+import { BillStatus, Bill, Activity } from '@driveup/common';
+import { CompanyEntity } from '../../company.entity';
+import { CompanyBillTransactionEntity } from './transaction.entity';
+import { CompanyBillItemEntity } from './item.entity';
+import { TrackableEntity } from '../../../../utils';
+/**
+ * Entity representing a company's billing statement for a specific period.
+ *
+ * @extends TrackableEntity<Bill>
+ */
+export declare class CompanyBillEntity extends TrackableEntity<Bill> {
+    /**
+     * The ID of the company this bill belongs to
+     */
+    companyId: number;
+    /**
+     * Current status of the bill
+     * @type {BillStatus}
+     * @default BillStatus.Open
+     */
+    status: BillStatus;
+    /**
+     * Billing period start date
+     */
+    startDate: Date;
+    /**
+     * Billing period end date
+     */
+    endDate: Date;
+    /**
+     * - Total price of all items before promotion code discount, and taxes (excluded the free benefits)
+     *
+     * - If billItem.freeBenefit = true, then that item's price is not included in this subTotalPrice
+     */
+    subtotalPrice: number;
+    /**
+     * - Total price of all items after all discounts (from agent promotion code) and taxes
+     *
+     * - Steps:
+     * As default the totalPrice is equal to subTotalPrice, then we apply the following changes:
+     *
+     * - 1. get available amount from the credit, and store this in creditAmount.
+     * this.creditAmount = company.credit >= this.subTotalPrice ? this.subTotalPrice : company.credit
+     * // TODO: reduce company.credit by this.creditAmount
+     *
+     * - 2. reduce the totalPrice by creditAmount.
+     * this.totalPrice = this.subTotalPrice - this.creditAmount
+     *
+     * - 4. calculate agent payout amount.
+     * this.agentAmount = (this.totalPrice * agentCode.agentPercentage) / 100
+     *
+     * - 6. calculate taxAmount.
+     * this.taxAmount = (this.totalPrice * product.vat) / 100
+     *
+     * - 7. increase totalPrice by taxAmount.
+     * this.totalPrice = this.totalPrice + this.taxAmount
+     *
+     * - 8. if the amount is more than 0, go to stripe and submit the payment
+     */
+    totalPrice: number;
+    /**
+     * The total tax amount for this bill
+     */
+    taxAmount: number;
+    /**
+     * The amount that was taken from company's credit balance for this bill
+     */
+    creditAmount: number;
+    /**
+     * The product balance after this bill is calculated before sending the payment to the provider
+     * @type {number}
+     * @default 0
+     */
+    productBalance: number;
+    /**
+     * Total number of trainings that were covered by free benefits
+     * @type {number | null}
+     * @default null
+     */
+    freeBenefitItems: number;
+    /**
+     * Total amount of the trainings that was covered by free benefits
+     * @type {number | null}
+     * @default null
+     */
+    freeBenefitAmount: number;
+    /**
+     * Total amount that was reducted from credit or was covered by free benefits
+     * @type {number | null}
+     * @default null
+     */
+    fromCreditOrFreeBenefits: number;
+    /**
+     * The amount that goes to the agent for this bill
+     *
+     * - This number is updated after bill's payment is confirmed (25% of totalPrice goes to agent)
+     * @type {number}
+     * @default 0
+     */
+    agentProfit: number;
+    /**
+     * The company this bill belongs to
+     */
+    company: Promise<CompanyEntity>;
+    /**
+     * Line items included in this bill
+     */
+    items: Promise<CompanyBillItemEntity[]>;
+    /**
+     * Payment transactions associated with this bill
+     */
+    transactions: Promise<CompanyBillTransactionEntity[]>;
+    /**
+     * Creates a new CompanyBillEntity instance
+     * @param {Partial<CompanyBillEntity>} [props] - Optional initial properties
+     */
+    constructor(props?: Partial<CompanyBillEntity>);
+    /**
+     * Converts the entity to a Bill model
+     * @returns {Bill} The Bill model representation
+     */
+    toModel(): Bill;
+    /**
+     * Converts the entity to a Bill model
+     * @returns {Bill} The Bill model representation
+     */
+    toSummary(): Bill;
+    /**
+     * Calculates the subtotal price by summing all non-free-benefit items
+     * @returns {Promise<number>} The subtotal price
+     */
+    getSubtotalPrice(): Promise<number>;
+    /**
+     * Calculates the total tax amount for all non-free-benefit items
+     * Tax is calculated on the price after credit is applied
+     * @returns {Promise<number>} The total tax amount
+     */
+    getTotalTaxAmount(): Promise<number>;
+    /**
+     * Retrieves activity log entries for this bill
+     * Includes creation and update timestamps and user information
+     * @returns {Promise<Activity[]>} Array of activity entries (filtered to remove null values)
+     */
+    getActivities(): Promise<Activity[]>;
+}