@driveup/schema 0.1.0

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

@@ -0,0 +1,240 @@
+"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.CompanyCourseAppointmentEntity = void 0;
+const typeorm_1 = require("typeorm");
+const common_1 = require("@driveup/common");
+const lesson_entity_1 = require("./lesson.entity");
+const appointment_entity_1 = require("../../student/program/training/appointment.entity");
+const instructor_entity_1 = require("../instructor/instructor.entity");
+const utils_1 = require("../../../utils");
+/**
+ * Represents a series of training appointment offers managed by the company.
+ *
+ * This entity defines appointment templates that serve as available time slots
+ * for student training sessions. Companies manage these appointments to organize
+ * their course training schedules, which students can then book.
+ *
+ * Supports both single and recurring appointments with flexible scheduling options
+ * including:
+ * - Weekly repetitions on specific weekdays
+ * - Custom date ranges for recurring appointments
+ * - Exception handling for skipped dates
+ * - Per-date overrides for time, instructor, and duration
+ *
+ * @remarks
+ * This is a company-managed entity that creates the foundation for student
+ * training bookings. Each appointment definition can generate multiple actual
+ * student appointments based on its repetition settings.
+ *
+ * @see {@link CompanyCourseLessonEntity} for the associated course lesson
+ * @see {@link StudentTrainingEntity} for student bookings
+ */
+let CompanyCourseAppointmentEntity = class CompanyCourseAppointmentEntity extends utils_1.TrackableEntity {
+    /**
+     * Company course lesson
+     */
+    lessonId;
+    /**
+     * In-charge instructor for the appointment
+     * For driving courses, can be empty
+     */
+    instructorId;
+    /**
+     * Represents the lesson start date for single appointments by student trainings.
+     * @remarks By recurring appoitmnets this field represents start of sierie
+     */
+    startDate;
+    /**
+     * Represents the lesson end date for single appointments by student trainings.
+     * @remarks By recurring appoitmnets this field represents end of sierie (repeat until this date)
+     */
+    endDate;
+    /**
+     * Duration of the appointment in minutes
+     * By fix courses this value is inherited from lesson
+     */
+    duration;
+    /**
+     * Indicates if the appointment is recurring
+     */
+    repetition;
+    /**
+     * Weekdays on which the appointment recurs
+     */
+    weekdays;
+    /**
+     * Skipped dates for this recurring appointment
+     */
+    skippedDates;
+    /**
+     * Changed dates for this recurring appointment
+     */
+    updates;
+    /**
+     * Different instructors for specific dates
+     */
+    instructors;
+    /**
+     * Different durations for specific dates
+     */
+    durations;
+    /**
+     * Course lesson
+     */
+    lesson;
+    /**
+     * Company instructor relation
+     */
+    instructor;
+    /**
+     * Student training appointments relation
+     */
+    studentAppointments;
+    /**
+     * Creates a new CompanyCourseAppointmentEntity instance
+     * @param props - Partial properties to initialize the entity with
+     */
+    constructor(props) {
+        super();
+        Object.assign(this, props);
+    }
+    /**
+     * Converts the entity to a RecurringAppointment model instance
+     * @returns Promise resolving to RecurringAppointment model with lesson, instructor, and scheduling details
+     */
+    async toModel() {
+        const lesson = this.lessonId ? (await this.lesson).toSummary() : null;
+        const instructor = this.instructorId ? await (await this.instructor).toSummary() : null;
+        return new common_1.RecurringAppointment({
+            id: this.id,
+            lesson: lesson,
+            instructor: instructor,
+            startDate: this.startDate,
+            endDate: this.endDate,
+            duration: this.duration,
+            repetition: this.repetition,
+            weekdays: this.weekdays,
+            skippedDates: this.skippedDates,
+            updates: this.updates,
+            instructors: this.instructors,
+            durations: this.durations
+        });
+    }
+    /**
+     * Returns a summary representation of the appointment
+     * @returns Promise resolving to RecurringAppointment model (same as toModel())
+     */
+    async toSummary() {
+        return await this.toModel();
+    }
+    /**
+     * Retrieves all tracked activities for this appointment
+     * Includes creation and update timestamps and 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));
+        return activities.filter(a => a);
+    }
+};
+exports.CompanyCourseAppointmentEntity = CompanyCourseAppointmentEntity;
+__decorate([
+    (0, typeorm_1.Column)(),
+    __metadata("design:type", Number)
+], CompanyCourseAppointmentEntity.prototype, "lessonId", void 0);
+__decorate([
+    (0, typeorm_1.Column)({
+        nullable: true,
+        default: null
+    }),
+    __metadata("design:type", Number)
+], CompanyCourseAppointmentEntity.prototype, "instructorId", void 0);
+__decorate([
+    (0, typeorm_1.Column)(),
+    __metadata("design:type", Date)
+], CompanyCourseAppointmentEntity.prototype, "startDate", void 0);
+__decorate([
+    (0, typeorm_1.Column)({
+        nullable: true,
+        default: null
+    }),
+    __metadata("design:type", Date)
+], CompanyCourseAppointmentEntity.prototype, "endDate", void 0);
+__decorate([
+    (0, typeorm_1.Column)({ default: 60 }),
+    __metadata("design:type", Number)
+], CompanyCourseAppointmentEntity.prototype, "duration", void 0);
+__decorate([
+    (0, typeorm_1.Column)({ default: false }),
+    __metadata("design:type", Boolean)
+], CompanyCourseAppointmentEntity.prototype, "repetition", void 0);
+__decorate([
+    (0, typeorm_1.Column)({
+        type: 'simple-json',
+        nullable: true,
+        default: null
+    }),
+    __metadata("design:type", Array)
+], CompanyCourseAppointmentEntity.prototype, "weekdays", void 0);
+__decorate([
+    (0, typeorm_1.Column)({
+        type: 'simple-json',
+        nullable: true,
+        default: null
+    }),
+    __metadata("design:type", Array)
+], CompanyCourseAppointmentEntity.prototype, "skippedDates", void 0);
+__decorate([
+    (0, typeorm_1.Column)({
+        type: 'simple-json',
+        nullable: true,
+        default: null
+    }),
+    __metadata("design:type", Array)
+], CompanyCourseAppointmentEntity.prototype, "updates", void 0);
+__decorate([
+    (0, typeorm_1.Column)({
+        type: 'simple-json',
+        nullable: true,
+        default: null
+    }),
+    __metadata("design:type", Array)
+], CompanyCourseAppointmentEntity.prototype, "instructors", void 0);
+__decorate([
+    (0, typeorm_1.Column)({
+        type: 'simple-json',
+        nullable: true,
+        default: null
+    }),
+    __metadata("design:type", Array)
+], CompanyCourseAppointmentEntity.prototype, "durations", void 0);
+__decorate([
+    (0, typeorm_1.ManyToOne)(() => lesson_entity_1.CompanyCourseLessonEntity, lesson => lesson.appointments),
+    __metadata("design:type", Promise)
+], CompanyCourseAppointmentEntity.prototype, "lesson", void 0);
+__decorate([
+    (0, typeorm_1.ManyToOne)(() => instructor_entity_1.CompanyInstructorEntity, lesson => lesson.companyCourseAppointments),
+    __metadata("design:type", Promise)
+], CompanyCourseAppointmentEntity.prototype, "instructor", void 0);
+__decorate([
+    (0, typeorm_1.OneToMany)(() => appointment_entity_1.StudentTrainingAppointmentEntity, appointment => appointment.definition),
+    __metadata("design:type", Promise)
+], CompanyCourseAppointmentEntity.prototype, "studentAppointments", void 0);
+exports.CompanyCourseAppointmentEntity = CompanyCourseAppointmentEntity = __decorate([
+    (0, typeorm_1.Entity)('companyCourseAppointments'),
+    __metadata("design:paramtypes", [Object])
+], CompanyCourseAppointmentEntity);
+//# sourceMappingURL=appointment.entity.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"appointment.entity.js","sourceRoot":"","sources":["../../../../src/profile/company/course/appointment.entity.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,qCAA+D;AAC/D,4CAAwF;AAExF,mDAA4D;AAC5D,0FAAqG;AACrG,uEAA0E;AAC1E,0CAA6D;AAE7D;;;;;;;;;;;;;;;;;;;;;GAqBG;AAEI,IAAM,8BAA8B,GAApC,MAAM,8BAA+B,SAAQ,uBAAqC;IAExF;;OAEG;IAEH,QAAQ,CAAS;IAEjB;;;OAGG;IAKH,YAAY,CAAS;IAErB;;;OAGG;IAEH,SAAS,CAAO;IAEhB;;;OAGG;IAKH,OAAO,CAAO;IAEd;;;OAGG;IAEH,QAAQ,CAAS;IAEjB;;OAEG;IAEH,UAAU,CAAU;IAEpB;;OAEG;IAMH,QAAQ,CAAY;IAEpB;;OAEG;IAMH,YAAY,CAAS;IAErB;;OAEG;IAMH,OAAO,CAAgB;IAEvB;;OAEG;IAMH,WAAW,CAAoB;IAE/B;;OAEG;IAMH,SAAS,CAAkB;IAE3B;;OAEG;IAEH,MAAM,CAAqC;IAE3C;;OAEG;IAEH,UAAU,CAAmC;IAE7C;;OAEG;IAEH,mBAAmB,CAA8C;IAEjE;;;OAGG;IACH,YAAY,KAA+C;QAC1D,KAAK,EAAE,CAAC;QACR,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;IAC5B,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,OAAO;QACZ,MAAM,MAAM,GAAG,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,MAAM,IAAI,CAAC,MAAM,CAAC,CAAC,SAAS,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC;QACtE,MAAM,UAAU,GAAG,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC,MAAM,CAAC,MAAM,IAAI,CAAC,UAAU,CAAC,CAAC,SAAS,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC;QACxF,OAAO,IAAI,6BAAoB,CAAC;YAC/B,EAAE,EAAE,IAAI,CAAC,EAAE;YACX,MAAM,EAAE,MAAM;YACd,UAAU,EAAE,UAAU;YACtB,SAAS,EAAE,IAAI,CAAC,SAAS;YACzB,OAAO,EAAE,IAAI,CAAC,OAAO;YACrB,QAAQ,EAAE,IAAI,CAAC,QAAQ;YACvB,UAAU,EAAE,IAAI,CAAC,UAAU;YAC3B,QAAQ,EAAE,IAAI,CAAC,QAAQ;YACvB,YAAY,EAAE,IAAI,CAAC,YAAY;YAC/B,OAAO,EAAE,IAAI,CAAC,OAAO;YACrB,WAAW,EAAE,IAAI,CAAC,WAAW;YAC7B,SAAS,EAAE,IAAI,CAAC,SAAS;SACzB,CAAC,CAAC;IACJ,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,SAAS;QACd,OAAO,MAAM,IAAI,CAAC,OAAO,EAAE,CAAC;IAC7B,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,OAAO,UAAU,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;IAClC,CAAC;CACD,CAAA;AAzKY,wEAA8B;AAM1C;IADC,IAAA,gBAAM,GAAE;;gEACQ;AAUjB;IAJC,IAAA,gBAAM,EAAC;QACP,QAAQ,EAAE,IAAI;QACd,OAAO,EAAE,IAAI;KACb,CAAC;;oEACmB;AAOrB;IADC,IAAA,gBAAM,GAAE;8BACE,IAAI;iEAAC;AAUhB;IAJC,IAAA,gBAAM,EAAC;QACP,QAAQ,EAAE,IAAI;QACd,OAAO,EAAE,IAAI;KACb,CAAC;8BACO,IAAI;+DAAC;AAOd;IADC,IAAA,gBAAM,EAAC,EAAE,OAAO,EAAE,EAAE,EAAE,CAAC;;gEACP;AAMjB;IADC,IAAA,gBAAM,EAAC,EAAE,OAAO,EAAE,KAAK,EAAE,CAAC;;kEACP;AAUpB;IALC,IAAA,gBAAM,EAAC;QACP,IAAI,EAAE,aAAa;QACnB,QAAQ,EAAE,IAAI;QACd,OAAO,EAAE,IAAI;KACb,CAAC;;gEACkB;AAUpB;IALC,IAAA,gBAAM,EAAC;QACP,IAAI,EAAE,aAAa;QACnB,QAAQ,EAAE,IAAI;QACd,OAAO,EAAE,IAAI;KACb,CAAC;;oEACmB;AAUrB;IALC,IAAA,gBAAM,EAAC;QACP,IAAI,EAAE,aAAa;QACnB,QAAQ,EAAE,IAAI;QACd,OAAO,EAAE,IAAI;KACb,CAAC;;+DACqB;AAUvB;IALC,IAAA,gBAAM,EAAC;QACP,IAAI,EAAE,aAAa;QACnB,QAAQ,EAAE,IAAI;QACd,OAAO,EAAE,IAAI;KACb,CAAC;;mEAC6B;AAU/B;IALC,IAAA,gBAAM,EAAC;QACP,IAAI,EAAE,aAAa;QACnB,QAAQ,EAAE,IAAI;QACd,OAAO,EAAE,IAAI;KACb,CAAC;;iEACyB;AAM3B;IADC,IAAA,mBAAS,EAAC,GAAG,EAAE,CAAC,yCAAyB,EAAE,MAAM,CAAC,EAAE,CAAC,MAAM,CAAC,YAAY,CAAC;;8DAC/B;AAM3C;IADC,IAAA,mBAAS,EAAC,GAAG,EAAE,CAAC,2CAAuB,EAAE,MAAM,CAAC,EAAE,CAAC,MAAM,CAAC,yBAAyB,CAAC;;kEACxC;AAM7C;IADC,IAAA,mBAAS,EAAC,GAAG,EAAE,CAAC,qDAAgC,EAAE,WAAW,CAAC,EAAE,CAAC,WAAW,CAAC,UAAU,CAAC;;2EACxB;yCAlHrD,8BAA8B;IAD1C,IAAA,gBAAM,EAAC,2BAA2B,CAAC;;GACvB,8BAA8B,CAyK1C"}

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

@@ -0,0 +1,156 @@
+import { StatusType, Course, Address } from '@driveup/common';
+import { AddonUsage, Activity } from '@driveup/common';
+import { CompanyProductEntity } from '../product/product.entity';
+import { DrivingCategoryEntity } from '../../../system/driving/category.entity';
+import { CompanyCourseLessonEntity } from './lesson.entity';
+import { CompanyInstructorEntity } from '../instructor/instructor.entity';
+import { StudentTrainingEntity } from '../../student/program/training/training.entity';
+import { StudentTrainingRequestEntity } from '../../student/program/training/request.entity';
+import { CompanyBillItemEntity } from '../finances/billing/item.entity';
+import { TrackableEntity } from '../../../utils';
+/**
+ * Represents a company-managed training course.
+ * Courses define training programs that can be offered to students,
+ * including theory classes, practical driving lessons, and specialized trainings.
+ * Each course has lessons, appointments, pricing, and capacity settings.
+ *
+ * Supports both fixed schedule courses (with predefined times) and flexible courses
+ * (where students book individual appointments).
+ *
+ * @extends TrackableEntity
+ */
+export declare class CompanyCourseEntity extends TrackableEntity<Course> {
+    /**
+     * Company product
+     * Medical and Licence product must be excluded.
+     * This two products will be offered via dedicated entities.
+     */
+    productId: number;
+    /**
+     * Driveup driving catregory
+     */
+    categoryId: number;
+    /**
+     * In-charge innstructor for the course
+     */
+    instructorId: number;
+    /**
+     * Allow booking only if the course is published
+     */
+    status: StatusType;
+    /******************* Content *******************/
+    /**
+     * Course name
+     * (e.g. First Aid, Category B, etc..)
+     */
+    title: string;
+    /**
+     * Company course description
+     */
+    description: string;
+    /**
+     * Promotion image URL for search engine visibility
+     */
+    imageUrl: string;
+    /******************* Finances ******************/
+    /**
+     * Course price for trainings
+     */
+    price: number;
+    /**
+     * Administration fee for the course
+     */
+    administrationFee: number;
+    /******************* Settings *******************/
+    /**
+     * Maximum number of students for each appointment
+     * Used only by course tranings
+     */
+    maxStudents: number;
+    /**
+     * Indicate if the training is fixed schedule or flexible
+     */
+    isFixed: boolean;
+    /**
+     * Course location
+     */
+    location: Address;
+    /**
+     * Activate addons for this course
+     */
+    addons: AddonUsage[];
+    /******************* Tracks *******************/
+    /**
+     * ID of the user who published the course
+     */
+    publishedBy: number;
+    /**
+     * Timestamp when the course was published
+     */
+    publishedOn: Date;
+    /**
+     * ID of the user who ended the course
+     */
+    endedBy: number;
+    /**
+     * Timestamp when the course was ended
+     */
+    endedOn: Date;
+    /**
+     * Company product
+     * E.g. Theory Study, Driving Lessons, First Aid, etc..
+     */
+    product: Promise<CompanyProductEntity>;
+    /**
+     * Course driving category
+     * Some courses may require specific driving category.
+     * E.g. Theory Study and Driving Category B
+     */
+    category: Promise<DrivingCategoryEntity>;
+    /**
+     * Course in-charge instructor
+     */
+    instructor: Promise<CompanyInstructorEntity>;
+    /**
+     * Course lessons
+     */
+    lessons: Promise<CompanyCourseLessonEntity[]>;
+    /**
+     * Student tranings related to this course
+     */
+    students: Promise<StudentTrainingEntity[]>;
+    /**
+     * Student requestes related to this course
+     */
+    studentRequestes: Promise<StudentTrainingRequestEntity[]>;
+    /**
+     * Bill items related to this course
+     */
+    billItems: Promise<CompanyBillItemEntity[]>;
+    /**
+     * Creates a new CompanyCourseEntity instance
+     * @param props - Partial properties to initialize the entity with
+     */
+    constructor(props?: Partial<CompanyCourseEntity>);
+    /**
+     * Converts the entity to a Course model instance
+     * @returns Promise resolving to Course model with category, instructor, and all course details
+     */
+    toModel(): Promise<Course>;
+    /**
+     * Returns a summary representation of the course with essential information
+     * @returns Promise resolving to Course model with basic details (id, instructor, status, title, image, price)
+     */
+    toSummary(): Promise<Course>;
+    /**
+     * Converts the entity to a Course model instance including all associated lessons
+     * @returns Promise resolving to Course model with complete lesson information
+     */
+    toModelWithLessons(): Promise<Course>;
+    /**
+     * Retrieves all tracked activities for this course
+     * Includes creation, update, publication, and ending timestamps with associated users
+     * @returns Promise resolving to array of Activity objects filtered to exclude null values
+     */
+    getActivities(): Promise<Activity[]>;
+}