Merge pull request #7727 from ever-co/fix/mikro-orm-support

[Fix] Support Virtual Column & Organization Team API
ever-co · Apr 5, 2024 · ac1565c · ac1565c
2 parents 17d8b5a + 6eb8dc7
commit ac1565c
Show file tree

Hide file tree

Showing 32 changed files with 197 additions and 115 deletions.
diff --git a/packages/contracts/src/date-picker.model.ts b/packages/contracts/src/date-picker.model.ts
@@ -2,4 +2,10 @@ export interface IDateRangePicker {
 	startDate: Date;
 	endDate: Date;
 	isCustomDate?: boolean;
-}
+}
+
+//
+export type DateRange = {
+	start: string | Date;
+	end: string | Date;
+};
diff --git a/packages/core/src/candidate/candidate.entity.ts b/packages/core/src/candidate/candidate.entity.ts
@@ -44,7 +44,8 @@ import {
 	MultiORMManyToMany,
 	MultiORMManyToOne,
 	MultiORMOneToMany,
-	MultiORMOneToOne
+	MultiORMOneToOne,
+	VirtualMultiOrmColumn
 } from './../core/decorators/entity';
 import { MikroOrmCandidateRepository } from './repository/mikro-orm-candidate.repository';
 
@@ -106,7 +107,11 @@ export class Candidate extends TenantOrganizationBaseEntity implements ICandidat
 	@MultiORMColumn({ nullable: true })
 	cvUrl?: string;
 
+	/** Additional virtual columns */
+	@VirtualMultiOrmColumn()
 	ratings?: number;
+
+	@VirtualMultiOrmColumn()
 	alreadyHired?: boolean;
 
 	/*

diff --git a/packages/core/src/core/decorators/entity/index.ts b/packages/core/src/core/decorators/entity/index.ts
@@ -2,3 +2,4 @@ export * from './entity.decorator';
 export * from './column.decorator';
 export * from './column-index.decorator';
 export * from './relations';
+export * from './virtual-column.decorator';
diff --git a/packages/core/src/core/decorators/entity/virtual-column.decorator.ts b/packages/core/src/core/decorators/entity/virtual-column.decorator.ts
@@ -0,0 +1,17 @@
+import { Property as MikroORMColumn, PropertyOptions as MikroORMPropertyOptions } from '@mikro-orm/core';
+
+/**
+ * Custom decorator to define a non-persistent (virtual) column in a MikroORM entity.
+ *
+ * @param options Additional options for the property. Defaults to { persist: false }.
+ * @returns A property decorator function.
+ */
+export function VirtualMultiOrmColumn<T extends object>(
+    options: MikroORMPropertyOptions<T> = {
+        persist: false
+    }
+): PropertyDecorator {
+    return (target: any, propertyKey: string) => {
+        MikroORMColumn(options)(target, propertyKey);
+    };
+}
diff --git a/packages/core/src/core/utils.ts b/packages/core/src/core/utils.ts
@@ -10,7 +10,7 @@ import { sample } from 'underscore';
 import * as path from 'path';
 import * as fs from 'fs';
 import * as os from 'os';
-import { IDateRange, IUser } from '@gauzy/contracts';
+import { DateRange, IDateRange, IUser } from '@gauzy/contracts';
 import { IDBConnectionOptions } from '@gauzy/common';
 import { getConfig, DatabaseTypeEnum } from '@gauzy/config';
 import { moment } from './../core/moment-extend';
@@ -214,10 +214,7 @@ export function mergeOverlappingDateRanges(ranges: IDateRange[]): IDateRange[] {
 export function getDateRangeFormat(
 	startDate: moment.Moment,
 	endDate: moment.Moment
-): {
-	start: string | Date;
-	end: string | Date;
-} {
+): DateRange {
 	let start = moment(startDate);
 	let end = moment(endDate);
 
@@ -494,6 +491,23 @@ export function concatIdToWhere<T>(id: any, where: MikroFilterQuery<T>): MikroFi
 	return where;
 }
 
+/**
+ * Adds 'tenantId' to a 'where' clause, supporting both objects and arrays.
+ *
+ * @param tenantId - The tenant ID to add.
+ * @param where - The current 'where' clause.
+ * @returns An updated 'where' clause including the 'tenantId'.
+ */
+export function enhanceWhereWithTenantId<T>(tenantId: any, where: MikroFilterQuery<T>): MikroFilterQuery<T> {
+	if (Array.isArray(where)) {
+		// Merge tenantId into each object of the array
+		return where.map(condition => ({ ...condition, tenantId }));
+	} else {
+		// Merge where with tenantId if where is an object
+		return { ...where, tenantId };
+	}
+}
+
 /**
  * Convert TypeORM's FindManyOptions to MikroORM's equivalent options.
  *

diff --git a/packages/core/src/email-reset/email-reset.entity.ts b/packages/core/src/email-reset/email-reset.entity.ts
@@ -7,7 +7,7 @@ import { IsEmail, IsOptional, IsUUID } from 'class-validator';
 import { Exclude } from 'class-transformer';
 import { IEmailReset, IUser } from '@gauzy/contracts';
 import { TenantBaseEntity, User } from '../core/entities/internal';
-import { ColumnIndex, MultiORMColumn, MultiORMEntity, MultiORMManyToOne } from './../core/decorators/entity';
+import { ColumnIndex, MultiORMColumn, MultiORMEntity, MultiORMManyToOne, VirtualMultiOrmColumn } from './../core/decorators/entity';
 import { MikroOrmEmailResetRepository } from './repository/mikro-orm-email-reset.repository';
 
 @MultiORMEntity('email_reset', { mikroOrmRepository: () => MikroOrmEmailResetRepository })
@@ -39,6 +39,8 @@ export class EmailReset extends TenantBaseEntity implements IEmailReset {
 	@MultiORMColumn({ nullable: true })
 	expiredAt: Date;
 
+	/** Additional virtual columns */
+	@VirtualMultiOrmColumn()
 	isExpired: boolean;
 
 	/*

diff --git a/packages/core/src/email-template/email-template.entity.ts b/packages/core/src/email-template/email-template.entity.ts
@@ -2,7 +2,7 @@ import { ApiProperty } from '@nestjs/swagger';
 import { IEmailTemplate } from '@gauzy/contracts';
 import { isMySQL } from "@gauzy/config";
 import { TenantOrganizationBaseEntity } from '../core/entities/internal';
-import { ColumnIndex, MultiORMColumn, MultiORMEntity } from './../core/decorators/entity';
+import { ColumnIndex, MultiORMColumn, MultiORMEntity, VirtualMultiOrmColumn } from './../core/decorators/entity';
 import { MikroOrmEmailTemplateRepository } from './repository/mikro-orm-email-template.repository';
 
 @MultiORMEntity('email_template', { mikroOrmRepository: () => MikroOrmEmailTemplateRepository })
@@ -27,6 +27,8 @@ export class EmailTemplate extends TenantOrganizationBaseEntity
 	@MultiORMColumn({ ...(isMySQL() ? { type: "longtext" } : {}) })
 	hbs: string;
 
+	/** Additional virtual columns */
+	@VirtualMultiOrmColumn()
 	title?: string;
 
 	/*

diff --git a/packages/core/src/employee/employee.entity.ts b/packages/core/src/employee/employee.entity.ts
@@ -9,7 +9,8 @@ import {
 	MultiORMManyToMany,
 	MultiORMManyToOne,
 	MultiORMOneToMany,
-	MultiORMOneToOne
+	MultiORMOneToOne,
+	VirtualMultiOrmColumn
 } from './../core/decorators/entity';
 import {
 	CurrenciesEnum,
@@ -326,10 +327,11 @@ export class Employee extends TenantOrganizationBaseEntity implements IEmployee
 	@MultiORMColumn({ nullable: true })
 	linkedInId?: string;
 
-	/**
-	 * Additional Property
-	 */
+	/** Additional virtual columns */
+	@VirtualMultiOrmColumn()
 	fullName?: string;
+
+	@VirtualMultiOrmColumn()
 	isDeleted?: boolean;
 
 	/*

diff --git a/packages/core/src/export-import/import-history/import-history.entity.ts b/packages/core/src/export-import/import-history/import-history.entity.ts
@@ -3,7 +3,7 @@ import { IsDate, IsEnum, IsNotEmpty, IsNumber, IsOptional } from 'class-validato
 import { Exclude } from 'class-transformer';
 import { IImportHistory, ImportStatusEnum } from '@gauzy/contracts';
 import { TenantBaseEntity } from '../../core/entities/internal';
-import { MultiORMColumn, MultiORMEntity } from '../../core/decorators/entity';
+import { MultiORMColumn, MultiORMEntity, VirtualMultiOrmColumn } from '../../core/decorators/entity';
 import { MikroOrmImportHistoryRepository } from './repository/mikro-orm-import-history.repository';
 
 @MultiORMEntity('import-history', { mikroOrmRepository: () => MikroOrmImportHistoryRepository })
@@ -38,5 +38,7 @@ export class ImportHistory extends TenantBaseEntity implements IImportHistory {
 	@MultiORMColumn({ default: () => 'CURRENT_TIMESTAMP' })
 	importDate?: Date;
 
+	/** Additional virtual columns */
+	@VirtualMultiOrmColumn()
 	public fullUrl?: string;
 }
diff --git a/packages/core/src/export-import/import-record/import-record.entity.ts b/packages/core/src/export-import/import-record/import-record.entity.ts
@@ -1,7 +1,7 @@
 import { ApiProperty } from '@nestjs/swagger';
 import { IsDate } from 'class-validator';
 import { IImportRecord } from '@gauzy/contracts';
-import { MultiORMColumn, MultiORMEntity } from './../../core/decorators/entity';
+import { MultiORMColumn, MultiORMEntity, VirtualMultiOrmColumn } from './../../core/decorators/entity';
 import { TenantBaseEntity } from '../../core/entities/internal';
 import { MikroOrmImportRecordRepository } from './repository/mikro-orm-import-record.repository';
 
@@ -25,5 +25,7 @@ export class ImportRecord extends TenantBaseEntity implements IImportRecord {
 	@MultiORMColumn({ nullable: false, default: () => 'CURRENT_TIMESTAMP' })
 	importDate?: Date;
 
+	/** Additional virtual columns */
+	@VirtualMultiOrmColumn()
 	wasCreated?: boolean;
 }
diff --git a/packages/core/src/feature/feature.entity.ts b/packages/core/src/feature/feature.entity.ts
@@ -9,7 +9,7 @@ import {
 	IFeatureOrganization
 } from '@gauzy/contracts';
 import { BaseEntity, FeatureOrganization } from '../core/entities/internal';
-import { ColumnIndex, MultiORMColumn, MultiORMEntity, MultiORMManyToOne, MultiORMOneToMany } from './../core/decorators/entity';
+import { ColumnIndex, MultiORMColumn, MultiORMEntity, MultiORMManyToOne, MultiORMOneToMany, VirtualMultiOrmColumn } from './../core/decorators/entity';
 import { MikroOrmFeatureRepository } from './repository/mikro-orm-feature.repository';
 
 @MultiORMEntity('feature', { mikroOrmRepository: () => MikroOrmFeatureRepository })
@@ -49,7 +49,11 @@ export class Feature extends BaseEntity implements IFeature {
 	@MultiORMColumn({ nullable: true })
 	icon: string;
 
+	/** Additional virtual columns */
+	@VirtualMultiOrmColumn()
 	isEnabled?: boolean;
+
+	@VirtualMultiOrmColumn()
 	imageUrl?: string;
 
 	/*

diff --git a/packages/core/src/image-asset/image-asset.entity.ts b/packages/core/src/image-asset/image-asset.entity.ts
@@ -9,7 +9,7 @@ import {
 	Equipment,
 	Warehouse
 } from './../core/entities/internal';
-import { MultiORMColumn, MultiORMEntity, MultiORMManyToMany, MultiORMOneToMany } from './../core/decorators/entity';
+import { MultiORMColumn, MultiORMEntity, MultiORMManyToMany, MultiORMOneToMany, VirtualMultiOrmColumn } from './../core/decorators/entity';
 import { MikroOrmImageAssetRepository } from './repository/mikro-orm-image-asset.repository';
 
 @MultiORMEntity('image_asset', { mikroOrmRepository: () => MikroOrmImageAssetRepository })
@@ -75,9 +75,11 @@ export class ImageAsset extends TenantOrganizationBaseEntity implements IImageAs
 	})
 	storageProvider?: FileStorageProviderEnum;
 
-
-	/** Additional fields */
+	/** Additional virtual columns */
+	@VirtualMultiOrmColumn()
 	fullUrl?: string;
+
+	@VirtualMultiOrmColumn()
 	thumbUrl?: string;
 
 	/*

diff --git a/packages/core/src/integration/integration.entity.ts b/packages/core/src/integration/integration.entity.ts
@@ -5,7 +5,7 @@ import { IIntegration, IIntegrationType, ITag } from '@gauzy/contracts';
 import { ColumnNumericTransformerPipe } from './../shared/pipes';
 import { BaseEntity, Tag } from '../core/entities/internal';
 import { IntegrationType } from './integration-type.entity';
-import { MultiORMColumn, MultiORMEntity, MultiORMManyToMany } from './../core/decorators/entity';
+import { MultiORMColumn, MultiORMEntity, MultiORMManyToMany, VirtualMultiOrmColumn } from './../core/decorators/entity';
 import { MikroOrmIntegrationRepository } from './repository/mikro-orm-integration.repository';
 
 @MultiORMEntity('integration', { mikroOrmRepository: () => MikroOrmIntegrationRepository })
@@ -77,7 +77,8 @@ export class Integration extends BaseEntity implements IIntegration {
 	@MultiORMColumn({ nullable: true })
 	order: number;
 
-	/** Additional fields */
+	/** Additional virtual columns */
+	@VirtualMultiOrmColumn()
 	fullImgUrl?: string;
 	/*
 	|--------------------------------------------------------------------------

diff --git a/packages/core/src/organization-team-join-request/organization-team-join-request.entity.ts b/packages/core/src/organization-team-join-request/organization-team-join-request.entity.ts
@@ -9,7 +9,7 @@ import {
 	OrganizationTeamJoinRequestStatusEnum
 } from '@gauzy/contracts';
 import { OrganizationTeam, TenantOrganizationBaseEntity, User } from '../core/entities/internal';
-import { ColumnIndex, MultiORMColumn, MultiORMEntity, MultiORMManyToOne } from './../core/decorators/entity';
+import { ColumnIndex, MultiORMColumn, MultiORMEntity, MultiORMManyToOne, VirtualMultiOrmColumn } from './../core/decorators/entity';
 import { MikroOrmOrganizationTeamJoinRequestRepository } from './repository/mikro-orm-organization-team-join-request.repository';
 
 @MultiORMEntity('organization_team_join_request', { mikroOrmRepository: () => MikroOrmOrganizationTeamJoinRequestRepository })
@@ -58,7 +58,8 @@ export class OrganizationTeamJoinRequest extends TenantOrganizationBaseEntity
 	@MultiORMColumn({ nullable: true })
 	expiredAt: Date;
 
-	/** Additional fields */
+	/** Additional virtual columns */
+	@VirtualMultiOrmColumn()
 	isExpired: boolean;
 
 	/*