@driveup/schema 0.1.0

package/lib/profile/student/program/training/transaction.entity.js

@@ -0,0 +1,266 @@
+"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);
+};
+var StudentTrainingTransactionEntity_1;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.StudentTrainingTransactionEntity = void 0;
+const typeorm_1 = require("typeorm");
+const common_1 = require("@driveup/common");
+const common_2 = require("@driveup/common");
+const invoice_entity_1 = require("../../../company/finances/invoice/invoice.entity");
+const training_entity_1 = require("./training.entity");
+const utils_1 = require("../../../../utils");
+/**
+ * Student training transaction entity representing financial transactions for training sessions.
+ * Handles payments, cancellations, and refunds related to student training programs.
+ * Extends TrackableEntity to track creation and update information.
+ */
+let StudentTrainingTransactionEntity = StudentTrainingTransactionEntity_1 = class StudentTrainingTransactionEntity extends utils_1.TrackableEntity {
+    /**
+     * The ID of the training this transaction belongs to
+     */
+    trainingId;
+    /**
+     * Type of transaction (Payment, Cancellation, Refund, etc.)
+     */
+    type;
+    /**
+     * Payment method used for this transaction
+     * Members: Cash, Online, Invoice
+     * For caancalellation transactions, this field will be null
+     */
+    paymentType;
+    /**
+     * Indicate the status of this transaction
+     */
+    status;
+    /**
+     * Invoice reference for this transaction, if applicable.
+     * When an invoice status is marked as 'Paid', a transaction entry is created with reference to the invoice.
+     */
+    invoiceId;
+    /**
+     * Transaction amount in the system's base currency
+     * Precision: 8 digits, Scale: 2 decimal places
+     */
+    amount;
+    /**
+     * Optional description or notes about this transaction
+     */
+    description;
+    /**
+     * Reference to a related transaction (typically used for cancellations).
+     * When an approved transaction is canceled, a new cancellation transaction is created,
+     * and this field points to that cancellation transaction.
+     * The original approved transaction's status remains Approved.
+     */
+    refTransactionId;
+    /**
+     * Bank account information used for this transaction
+     */
+    bankAccount;
+    /**
+     * ID of the user who approved this transaction
+     */
+    approvedBy;
+    /**
+     * Timestamp when this transaction was approved
+     */
+    approvedOn;
+    /**
+     * ID of the user who canceled this transaction
+     */
+    canceledBy;
+    /**
+     * Timestamp when this transaction was canceled
+     */
+    canceledOn;
+    /**
+     * Student training related to this transaction
+     */
+    training;
+    /**
+     * Invoice related to this transaction, if applicable
+     */
+    invoice;
+    /**
+     * Creates a new StudentTrainingTransactionEntity instance
+     * @param props - Partial properties to initialize the entity with
+     */
+    constructor(props) {
+        super();
+        Object.assign(this, props);
+    }
+    /**
+     * Converts the entity to a Transaction model instance
+     * @returns Transaction model with transaction details
+     */
+    toModel() {
+        return new common_1.Transaction({
+            id: this.id,
+            type: this.type,
+            paymentType: this.paymentType,
+            status: this.status,
+            amount: this.amount,
+            description: this.description,
+            bank: this.bankAccount ? common_1.BankAccount.toInstance(this.bankAccount) : null,
+        });
+    }
+    /**
+     * Returns a summary representation of the transaction
+     * @returns Transaction model instance (same as toModel())
+     */
+    toSummary() {
+        return this.toModel();
+    }
+    /**
+     * Retrieves the referenced transaction (typically a cancellation transaction)
+     * @returns The related transaction entity or undefined if no reference exists
+     */
+    async getRefTransaction() {
+        if (!this.refTransactionId)
+            return;
+        return await StudentTrainingTransactionEntity_1.findOneBy({
+            id: this.refTransactionId
+        });
+    }
+    /**
+     * Retrieves the original transaction that was canceled by this cancellation transaction
+     * Only applicable if this is a cancellation transaction
+     * @returns The original transaction entity that was canceled
+     */
+    async getByRefTransaction() {
+        return await StudentTrainingTransactionEntity_1.findOneBy({
+            refTransactionId: this.id
+        });
+    }
+    /**
+     * Retrieves all tracked activities for this transaction
+     * Includes creation and update timestamps and associated users
+     * @returns Array of Activity objects filtered to exclude null values
+     */
+    async getActivities() {
+        const activities = [];
+        activities.push(await (0, utils_1.toActivity)(this.createdBy, common_2.ActivityType.createdBy));
+        activities.push(await (0, utils_1.toActivity)(this.createdOn, common_2.ActivityType.createdOn));
+        activities.push(await (0, utils_1.toActivity)(this.updatedBy, common_2.ActivityType.updatedBy));
+        activities.push(await (0, utils_1.toActivity)(this.updatedOn, common_2.ActivityType.updatedOn));
+        return activities.filter(a => a);
+    }
+};
+exports.StudentTrainingTransactionEntity = StudentTrainingTransactionEntity;
+__decorate([
+    (0, typeorm_1.Column)(),
+    __metadata("design:type", Number)
+], StudentTrainingTransactionEntity.prototype, "trainingId", void 0);
+__decorate([
+    (0, typeorm_1.Column)({
+        type: 'enum',
+        name: 'transactionType',
+        enum: common_1.TransactionType,
+        default: common_1.TransactionType.Payment,
+        nullable: false
+    }),
+    __metadata("design:type", String)
+], StudentTrainingTransactionEntity.prototype, "type", void 0);
+__decorate([
+    (0, typeorm_1.Column)({
+        type: 'enum',
+        enum: common_1.PaymentType,
+        default: common_1.PaymentType.Online,
+        nullable: true
+    }),
+    __metadata("design:type", String)
+], StudentTrainingTransactionEntity.prototype, "paymentType", void 0);
+__decorate([
+    (0, typeorm_1.Column)({
+        type: 'enum',
+        nullable: false,
+        enum: [
+            common_2.StatusType.Pending,
+            common_2.StatusType.Approved,
+            common_2.StatusType.Rejected,
+            common_2.StatusType.Canceled,
+        ],
+        default: common_2.StatusType.Pending
+    }),
+    __metadata("design:type", String)
+], StudentTrainingTransactionEntity.prototype, "status", void 0);
+__decorate([
+    (0, typeorm_1.Column)({
+        nullable: true,
+        default: null
+    }),
+    __metadata("design:type", Number)
+], StudentTrainingTransactionEntity.prototype, "invoiceId", void 0);
+__decorate([
+    (0, typeorm_1.Column)({
+        type: 'decimal',
+        precision: 8,
+        scale: 2,
+        nullable: false,
+        default: 0
+    }),
+    __metadata("design:type", Number)
+], StudentTrainingTransactionEntity.prototype, "amount", void 0);
+__decorate([
+    (0, typeorm_1.Column)({
+        type: 'mediumtext',
+        nullable: true,
+        default: null
+    }),
+    __metadata("design:type", String)
+], StudentTrainingTransactionEntity.prototype, "description", void 0);
+__decorate([
+    (0, typeorm_1.Column)({
+        unique: true,
+        nullable: true,
+        default: null
+    }),
+    __metadata("design:type", Number)
+], StudentTrainingTransactionEntity.prototype, "refTransactionId", void 0);
+__decorate([
+    (0, typeorm_1.Column)({
+        type: 'simple-json',
+        nullable: true,
+        default: null
+    }),
+    __metadata("design:type", common_1.BankAccount)
+], StudentTrainingTransactionEntity.prototype, "bankAccount", void 0);
+__decorate([
+    (0, typeorm_1.Column)({ nullable: true, default: null }),
+    __metadata("design:type", Number)
+], StudentTrainingTransactionEntity.prototype, "approvedBy", void 0);
+__decorate([
+    (0, typeorm_1.Column)({ nullable: true, default: null }),
+    __metadata("design:type", Date)
+], StudentTrainingTransactionEntity.prototype, "approvedOn", void 0);
+__decorate([
+    (0, typeorm_1.Column)({ nullable: true, default: null }),
+    __metadata("design:type", Number)
+], StudentTrainingTransactionEntity.prototype, "canceledBy", void 0);
+__decorate([
+    (0, typeorm_1.Column)({ nullable: true, default: null }),
+    __metadata("design:type", Date)
+], StudentTrainingTransactionEntity.prototype, "canceledOn", void 0);
+__decorate([
+    (0, typeorm_1.ManyToOne)(() => training_entity_1.StudentTrainingEntity, training => training.transactions),
+    __metadata("design:type", Promise)
+], StudentTrainingTransactionEntity.prototype, "training", void 0);
+__decorate([
+    (0, typeorm_1.OneToOne)(() => invoice_entity_1.CompanyInvoiceEntity, invoice => invoice.training),
+    (0, typeorm_1.JoinColumn)(),
+    __metadata("design:type", Promise)
+], StudentTrainingTransactionEntity.prototype, "invoice", void 0);
+exports.StudentTrainingTransactionEntity = StudentTrainingTransactionEntity = StudentTrainingTransactionEntity_1 = __decorate([
+    (0, typeorm_1.Entity)('studentTrainingTransactions'),
+    __metadata("design:paramtypes", [Object])
+], StudentTrainingTransactionEntity);
+//# sourceMappingURL=transaction.entity.js.map

package/lib/profile/student/program/training/transaction.entity.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"transaction.entity.js","sourceRoot":"","sources":["../../../../../src/profile/student/program/training/transaction.entity.ts"],"names":[],"mappings":";;;;;;;;;;;;;AAAA,qCAA0E;AAC1E,4CAAmG;AACnG,4CAAqE;AACrE,qFAAwF;AACxF,uDAA0D;AAC1D,6CAAgE;AAEhE;;;;GAIG;AAEI,IAAM,gCAAgC,wCAAtC,MAAM,gCAAiC,SAAQ,uBAA4B;IAEjF;;OAEG;IAEH,UAAU,CAAS;IAEnB;;OAEG;IAQH,IAAI,CAAkB;IAEtB;;;;OAIG;IAOH,WAAW,CAAa;IAExB;;OAEG;IAYH,MAAM,CAAa;IAEnB;;;OAGG;IAKH,SAAS,CAAS;IAElB;;;OAGG;IAQH,MAAM,CAAS;IAEf;;OAEG;IAMH,WAAW,CAAS;IAEpB;;;;;OAKG;IAMH,gBAAgB,CAAS;IAEzB;;OAEG;IAMH,WAAW,CAAc;IAEzB;;OAEG;IAEH,UAAU,CAAS;IAEnB;;OAEG;IAEH,UAAU,CAAO;IAEjB;;OAEG;IAEH,UAAU,CAAS;IAEnB;;OAEG;IAEH,UAAU,CAAO;IAEjB;;OAEG;IAEH,QAAQ,CAAiC;IAEzC;;OAEG;IAGH,OAAO,CAAgC;IAEvC;;;OAGG;IACH,YAAY,KAAiD;QAC5D,KAAK,EAAE,CAAC;QACR,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;IAC5B,CAAC;IAED;;;OAGG;IACH,OAAO;QACN,OAAO,IAAI,oBAAW,CAAC;YACtB,EAAE,EAAE,IAAI,CAAC,EAAE;YACX,IAAI,EAAE,IAAI,CAAC,IAAI;YACf,WAAW,EAAE,IAAI,CAAC,WAAW;YAC7B,MAAM,EAAE,IAAI,CAAC,MAAM;YACnB,MAAM,EAAE,IAAI,CAAC,MAAM;YACnB,WAAW,EAAE,IAAI,CAAC,WAAW;YAC7B,IAAI,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,oBAAW,CAAC,UAAU,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,IAAI;SACxE,CAAC,CAAC;IACJ,CAAC;IAED;;;OAGG;IACH,SAAS;QACR,OAAO,IAAI,CAAC,OAAO,EAAE,CAAC;IACvB,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,iBAAiB;QACtB,IAAI,CAAC,IAAI,CAAC,gBAAgB;YAAE,OAAO;QACnC,OAAO,MAAM,kCAAgC,CAAC,SAAS,CAAC;YACvD,EAAE,EAAE,IAAI,CAAC,gBAAgB;SACzB,CAAC,CAAC;IACJ,CAAC;IACD;;;;OAIG;IACH,KAAK,CAAC,mBAAmB;QACxB,OAAO,MAAM,kCAAgC,CAAC,SAAS,CAAC;YACvD,gBAAgB,EAAE,IAAI,CAAC,EAAE;SACzB,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,OAAO,UAAU,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;IAClC,CAAC;CACD,CAAA;AAjNY,4EAAgC;AAM5C;IADC,IAAA,gBAAM,GAAE;;oEACU;AAYnB;IAPC,IAAA,gBAAM,EAAC;QACP,IAAI,EAAE,MAAM;QACZ,IAAI,EAAE,iBAAiB;QACvB,IAAI,EAAE,wBAAe;QACrB,OAAO,EAAE,wBAAe,CAAC,OAAO;QAChC,QAAQ,EAAE,KAAK;KACf,CAAC;;8DACoB;AAatB;IANC,IAAA,gBAAM,EAAC;QACP,IAAI,EAAE,MAAM;QACZ,IAAI,EAAE,oBAAW;QACjB,OAAO,EAAE,oBAAW,CAAC,MAAM;QAC3B,QAAQ,EAAE,IAAI;KACd,CAAC;;qEACsB;AAgBxB;IAXC,IAAA,gBAAM,EAAC;QACP,IAAI,EAAE,MAAM;QACZ,QAAQ,EAAE,KAAK;QACf,IAAI,EAAE;YACL,mBAAU,CAAC,OAAO;YAClB,mBAAU,CAAC,QAAQ;YACnB,mBAAU,CAAC,QAAQ;YACnB,mBAAU,CAAC,QAAQ;SACnB;QACD,OAAO,EAAE,mBAAU,CAAC,OAAO;KAC3B,CAAC;;gEACiB;AAUnB;IAJC,IAAA,gBAAM,EAAC;QACP,QAAQ,EAAE,IAAI;QACd,OAAO,EAAE,IAAI;KACb,CAAC;;mEACgB;AAalB;IAPC,IAAA,gBAAM,EAAC;QACP,IAAI,EAAE,SAAS;QACf,SAAS,EAAE,CAAC;QACZ,KAAK,EAAE,CAAC;QACR,QAAQ,EAAE,KAAK;QACf,OAAO,EAAE,CAAC;KACV,CAAC;;gEACa;AAUf;IALC,IAAA,gBAAM,EAAC;QACP,IAAI,EAAE,YAAY;QAClB,QAAQ,EAAE,IAAI;QACd,OAAO,EAAE,IAAI;KACb,CAAC;;qEACkB;AAapB;IALC,IAAA,gBAAM,EAAC;QACP,MAAM,EAAE,IAAI;QACZ,QAAQ,EAAE,IAAI;QACd,OAAO,EAAE,IAAI;KACb,CAAC;;0EACuB;AAUzB;IALC,IAAA,gBAAM,EAAC;QACP,IAAI,EAAE,aAAa;QACnB,QAAQ,EAAE,IAAI;QACd,OAAO,EAAE,IAAI;KACb,CAAC;8BACW,oBAAW;qEAAC;AAMzB;IADC,IAAA,gBAAM,EAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC;;oEACvB;AAMnB;IADC,IAAA,gBAAM,EAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC;8BAC9B,IAAI;oEAAC;AAMjB;IADC,IAAA,gBAAM,EAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC;;oEACvB;AAMnB;IADC,IAAA,gBAAM,EAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC;8BAC9B,IAAI;oEAAC;AAMjB;IADC,IAAA,mBAAS,EAAC,GAAG,EAAE,CAAC,uCAAqB,EAAE,QAAQ,CAAC,EAAE,CAAC,QAAQ,CAAC,YAAY,CAAC;;kEACjC;AAOzC;IAFC,IAAA,kBAAQ,EAAC,GAAG,EAAE,CAAC,qCAAoB,EAAE,OAAO,CAAC,EAAE,CAAC,OAAO,CAAC,QAAQ,CAAC;IACjE,IAAA,oBAAU,GAAE;;iEAC0B;2CA5I3B,gCAAgC;IAD5C,IAAA,gBAAM,EAAC,6BAA6B,CAAC;;GACzB,gCAAgC,CAiN5C"}

package/lib/profile/student/student.entity.d.ts

@@ -0,0 +1,89 @@
+import { AccountStatus, Language, Preference, Activity, Student } from '@driveup/common';
+import { UserEntity } from '../../user/user.entity';
+import { StudentLicenceEntity } from './program/licence/licence.entity';
+import { StudentMedicalExaminationEntity } from './program/medical/examination.model';
+import { StudentProgramEntity } from './program/program.entity';
+import { StudentMedicalCertificateEntity } from './program/medical/certificate.entity';
+import { TrackableEntity } from '../../utils';
+export declare class StudentEntity extends TrackableEntity<Student> {
+    /**
+     * Reference to the user account associated with this student profile
+     */
+    userId: number;
+    /**
+     * Student profile name
+     * By default is set from user account name
+     * Usefull when the student wants to have a different name on his profile
+     */
+    name: string;
+    /**
+     * Student profile language
+     * By default is set from user account name
+     * Usefull when the student wants to have a different language on his profile
+     */
+    language: Language;
+    /**
+     * Student account status
+     * When company invites a student, the status is set to Pending
+     * Only student onbording can change the status to Active
+     */
+    status: AccountStatus;
+    /**
+     * Student prefered settings
+     * E.g. Notifications, reminders etc.
+     */
+    preferences: Preference[];
+    /**
+     * Reference to the user account
+     * This is a many-to-one relation where userId is not unique at DB level
+     * to allow soft-deleted students to be recreated with the same userId
+     */
+    user: Promise<UserEntity>;
+    /**
+     * Student medical certificates
+     * The student can register certificates without linking them to an examination
+     * This is the case where the student already has a valid medical certificate
+     */
+    medicalCertificates: Promise<StudentMedicalCertificateEntity[]>;
+    /**
+     * Student medical examinations
+     * The student examination to obtaining medical certificates
+     * This is the case where the student certificates are linked to examinations
+     */
+    medicalExaminations: Promise<StudentMedicalExaminationEntity[]>;
+    /**
+     * Student licences
+     * The licences obtained by the student after completing product programs
+     * Currently driveup has't state authority integration for licence management
+     * So the licences are managed directly by the student profile manually
+     */
+    licences: Promise<StudentLicenceEntity[]>;
+    /**
+     * All programs linked to this student profile
+     * The programs are created when the student enrolls to a driving category
+     * The program is palette of trainings and preperation trainings
+     */
+    programs: Promise<StudentProgramEntity[]>;
+    /**
+     * Creates an instance of StudentEntity
+     * @param props - Partial properties to initialize the entity
+     */
+    constructor(props?: Partial<StudentEntity>);
+    /**
+     * Converts the entity to a Student model instance
+     * Falls back to user data if student-specific data is not set
+     * @returns Promise resolving to Student model
+     */
+    toModel(): Promise<Student>;
+    /**
+     * Converts the entity to a Student model instance
+     * @returns Promise resolving to Student model
+     */
+    toSummary(): Promise<Student>;
+    /**
+     * Retrieves all activity records for this student
+     * Includes creation and update actions
+     * @returns Array of Activity objects
+     */
+    getActivities(): Promise<Activity[]>;
+}

package/lib/profile/student/student.entity.js

@@ -0,0 +1,183 @@
+"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.StudentEntity = void 0;
+const typeorm_1 = require("typeorm");
+const common_1 = require("@driveup/common");
+const user_entity_1 = require("../../user/user.entity");
+const licence_entity_1 = require("./program/licence/licence.entity");
+const examination_model_1 = require("./program/medical/examination.model");
+const program_entity_1 = require("./program/program.entity");
+const certificate_entity_1 = require("./program/medical/certificate.entity");
+const utils_1 = require("../../utils");
+let StudentEntity = class StudentEntity extends utils_1.TrackableEntity {
+    /**
+     * Reference to the user account associated with this student profile
+     */
+    userId;
+    /**
+     * Student profile name
+     * By default is set from user account name
+     * Usefull when the student wants to have a different name on his profile
+     */
+    name;
+    /**
+     * Student profile language
+     * By default is set from user account name
+     * Usefull when the student wants to have a different language on his profile
+     */
+    language;
+    /**
+     * Student account status
+     * When company invites a student, the status is set to Pending
+     * Only student onbording can change the status to Active
+     */
+    status;
+    /**
+     * Student prefered settings
+     * E.g. Notifications, reminders etc.
+     */
+    preferences;
+    /**
+     * Reference to the user account
+     * This is a many-to-one relation where userId is not unique at DB level
+     * to allow soft-deleted students to be recreated with the same userId
+     */
+    user;
+    /**
+     * Student medical certificates
+     * The student can register certificates without linking them to an examination
+     * This is the case where the student already has a valid medical certificate
+     */
+    medicalCertificates;
+    /**
+     * Student medical examinations
+     * The student examination to obtaining medical certificates
+     * This is the case where the student certificates are linked to examinations
+     */
+    medicalExaminations;
+    /**
+     * Student licences
+     * The licences obtained by the student after completing product programs
+     * Currently driveup has't state authority integration for licence management
+     * So the licences are managed directly by the student profile manually
+     */
+    licences;
+    /**
+     * All programs linked to this student profile
+     * The programs are created when the student enrolls to a driving category
+     * The program is palette of trainings and preperation trainings
+     */
+    programs;
+    /**
+     * Creates an instance of StudentEntity
+     * @param props - Partial properties to initialize the entity
+     */
+    constructor(props) {
+        super();
+        Object.assign(this, props);
+    }
+    /**
+     * Converts the entity to a Student model instance
+     * Falls back to user data if student-specific data is not set
+     * @returns Promise resolving to Student model
+     */
+    async toModel() {
+        const user = await this.user;
+        return new common_1.Student({
+            id: this.id,
+            status: this.status,
+            name: this.name || user.name,
+            language: this.language || user.language,
+            imageUrl: user.imageUrl
+        });
+    }
+    /**
+     * Converts the entity to a Student model instance
+     * @returns Promise resolving to Student model
+     */
+    async toSummary() {
+        return await this.toModel();
+    }
+    /**
+     * Retrieves all activity records for this student
+     * Includes creation and update actions
+     * @returns Array of Activity objects
+     */
+    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.StudentEntity = StudentEntity;
+__decorate([
+    (0, typeorm_1.Column)(),
+    __metadata("design:type", Number)
+], StudentEntity.prototype, "userId", void 0);
+__decorate([
+    (0, typeorm_1.Column)(),
+    __metadata("design:type", String)
+], StudentEntity.prototype, "name", void 0);
+__decorate([
+    (0, typeorm_1.Column)({
+        type: 'enum',
+        enum: common_1.Language,
+        default: common_1.Language.En,
+        nullable: true
+    }),
+    __metadata("design:type", String)
+], StudentEntity.prototype, "language", void 0);
+__decorate([
+    (0, typeorm_1.Column)({
+        type: 'enum',
+        enum: common_1.AccountStatus,
+        default: common_1.AccountStatus.Pending,
+        nullable: false
+    }),
+    __metadata("design:type", String)
+], StudentEntity.prototype, "status", void 0);
+__decorate([
+    (0, typeorm_1.Column)({
+        type: 'simple-json',
+        nullable: true,
+        default: null
+    }),
+    __metadata("design:type", Array)
+], StudentEntity.prototype, "preferences", void 0);
+__decorate([
+    (0, typeorm_1.ManyToOne)(() => user_entity_1.UserEntity, user => user.studentProfiles),
+    __metadata("design:type", Promise)
+], StudentEntity.prototype, "user", void 0);
+__decorate([
+    (0, typeorm_1.OneToMany)(() => certificate_entity_1.StudentMedicalCertificateEntity, certificate => certificate.student),
+    __metadata("design:type", Promise)
+], StudentEntity.prototype, "medicalCertificates", void 0);
+__decorate([
+    (0, typeorm_1.OneToMany)(() => examination_model_1.StudentMedicalExaminationEntity, certificate => certificate.student),
+    __metadata("design:type", Promise)
+], StudentEntity.prototype, "medicalExaminations", void 0);
+__decorate([
+    (0, typeorm_1.OneToMany)(() => licence_entity_1.StudentLicenceEntity, licence => licence.student),
+    __metadata("design:type", Promise)
+], StudentEntity.prototype, "licences", void 0);
+__decorate([
+    (0, typeorm_1.OneToMany)(() => program_entity_1.StudentProgramEntity, program => program.student),
+    __metadata("design:type", Promise)
+], StudentEntity.prototype, "programs", void 0);
+exports.StudentEntity = StudentEntity = __decorate([
+    (0, typeorm_1.Entity)('students'),
+    __metadata("design:paramtypes", [Object])
+], StudentEntity);
+//# sourceMappingURL=student.entity.js.map

package/lib/profile/student/student.entity.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"student.entity.js","sourceRoot":"","sources":["../../../src/profile/student/student.entity.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,qCAA+D;AAC/D,4CAAuG;AACvG,wDAAoD;AACpD,qEAAwE;AACxE,2EAAsF;AACtF,6DAAgE;AAChE,6EAAuF;AACvF,uCAA0D;AAGnD,IAAM,aAAa,GAAnB,MAAM,aAAc,SAAQ,uBAAwB;IAE1D;;OAEG;IAEH,MAAM,CAAS;IAEf;;;;OAIG;IAEH,IAAI,CAAS;IAEb;;;;OAIG;IAOH,QAAQ,CAAW;IAEnB;;;;OAIG;IAOH,MAAM,CAAgB;IAEtB;;;OAGG;IAMH,WAAW,CAAe;IAE1B;;;;OAIG;IAEH,IAAI,CAAsB;IAE1B;;;;OAIG;IAEH,mBAAmB,CAA6C;IAEhE;;;;OAIG;IAEH,mBAAmB,CAA6C;IAEhE;;;;;OAKG;IAEH,QAAQ,CAAkC;IAE1C;;;;OAIG;IAEH,QAAQ,CAAkC;IAE1C;;;OAGG;IACH,YAAY,KAA8B;QACzC,KAAK,EAAE,CAAC;QACR,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;IAC5B,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,OAAO;QACZ,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC;QAC7B,OAAO,IAAI,gBAAO,CAAC;YAClB,EAAE,EAAE,IAAI,CAAC,EAAE;YACX,MAAM,EAAE,IAAI,CAAC,MAAM;YACnB,IAAI,EAAE,IAAI,CAAC,IAAI,IAAI,IAAI,CAAC,IAAI;YAC5B,QAAQ,EAAE,IAAI,CAAC,QAAQ,IAAI,IAAI,CAAC,QAAQ;YACxC,QAAQ,EAAE,IAAI,CAAC,QAAQ;SACvB,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;AA5IY,sCAAa;AAMzB;IADC,IAAA,gBAAM,GAAE;;6CACM;AAQf;IADC,IAAA,gBAAM,GAAE;;2CACI;AAab;IANC,IAAA,gBAAM,EAAC;QACP,IAAI,EAAE,MAAM;QACZ,IAAI,EAAE,iBAAQ;QACd,OAAO,EAAE,iBAAQ,CAAC,EAAE;QACpB,QAAQ,EAAE,IAAI;KACd,CAAC;;+CACiB;AAanB;IANC,IAAA,gBAAM,EAAC;QACP,IAAI,EAAE,MAAM;QACZ,IAAI,EAAE,sBAAa;QACnB,OAAO,EAAE,sBAAa,CAAC,OAAO;QAC9B,QAAQ,EAAE,KAAK;KACf,CAAC;;6CACoB;AAWtB;IALC,IAAA,gBAAM,EAAC;QACP,IAAI,EAAE,aAAa;QACnB,QAAQ,EAAE,IAAI;QACd,OAAO,EAAE,IAAI;KACb,CAAC;;kDACwB;AAQ1B;IADC,IAAA,mBAAS,EAAC,GAAG,EAAE,CAAC,wBAAU,EAAE,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,eAAe,CAAC;;2CAChC;AAQ1B;IADC,IAAA,mBAAS,EAAC,GAAG,EAAE,CAAC,oDAA+B,EAAE,WAAW,CAAC,EAAE,CAAC,WAAW,CAAC,OAAO,CAAC;;0DACrB;AAQhE;IADC,IAAA,mBAAS,EAAC,GAAG,EAAE,CAAC,mDAA+B,EAAE,WAAW,CAAC,EAAE,CAAC,WAAW,CAAC,OAAO,CAAC;;0DACrB;AAShE;IADC,IAAA,mBAAS,EAAC,GAAG,EAAE,CAAC,qCAAoB,EAAE,OAAO,CAAC,EAAE,CAAC,OAAO,CAAC,OAAO,CAAC;;+CACxB;AAQ1C;IADC,IAAA,mBAAS,EAAC,GAAG,EAAE,CAAC,qCAAoB,EAAE,OAAO,CAAC,EAAE,CAAC,OAAO,CAAC,OAAO,CAAC;;+CACxB;wBA5F9B,aAAa;IADzB,IAAA,gBAAM,EAAC,UAAU,CAAC;;GACN,aAAa,CA4IzB"}

package/lib/system/campaign/campaign.entity.d.ts

@@ -0,0 +1,68 @@
+import { Activity, Campaigne, Content, IContent, Language } from '@driveup/common';
+import { CampaignGiftCodeEntity } from './gifcode.entity';
+import { ProductType } from '@driveup/common';
+import { TrackableEntity } from '../../utils';
+/**
+ * Represents a marketing campaign in the system.
+ * Campaigns offer promotional discounts through gift codes that users can redeem.
+ * Each campaign targets specific products and has an expiration date.
+ * Gift amounts are credited to the user's product wallet upon redemption.
+ *
+ * @extends TrackableEntity
+ */
+export declare class CampaignEntity extends TrackableEntity {
+    /**
+     * Product types this campaign applies to
+     * @default []
+     */
+    products: ProductType[];
+    /**
+     * Localized content for the campaign (title, description, etc.)
+     */
+    translations: IContent[];
+    /**
+     * URL to the campaign's promotional image
+     */
+    imageUrl: string;
+    /**
+     * Campaign discount amount
+     * This amount will be stored on product credit
+     */
+    giftAmount: number;
+    /**
+     * Campaign expiration date - after this date, codes cannot be redeemed
+     */
+    exipryDate: Date;
+    /**
+     * Gift codes associated with this campaign
+     */
+    giftCodes: Promise<CampaignGiftCodeEntity[]>;
+    /**
+     * Creates a new CampaignEntity instance
+     * @param props - Partial properties to initialize the entity
+     */
+    constructor(props?: Partial<CampaignEntity>);
+    /**
+     * Converts the entity to a Campaigne model instance
+     * @param lang - Optional language for translations
+     * @returns Campaigne model with localized content
+     */
+    toModel(lang?: Language): Campaigne;
+    /**
+     * Retrieves all gift codes for this campaign
+     * @returns Promise resolving to array of GiftCode models
+     */
+    getCodes(): Promise<import("@driveup/common").GiftCode[]>;
+    /**
+     * Gets the localized translation for the campaign
+     * @param lang - Optional language code; defaults to current i18n context
+     * @returns Content instance with translated title and description
+     */
+    getTranslation(lang?: Language): Content;
+    /**
+     * Gets all available translations for the campaign
+     * @returns Array of Content instances for all languages
+     */
+    getTranslations(): Content[];
+    getActivities(): Promise<Activity[]>;
+}