Favorite folders (#7998)

closes - #5755

---------

Co-authored-by: martmull <martmull@hotmail.fr>
Co-authored-by: Lucas Bordeau <bordeau.lucas@gmail.com>
Co-authored-by: Charles Bochet <charles@twenty.com>

packages/twenty-server/src/modules/favorite-folder/favorite-folder.module.ts

@@ -0,0 +1,11 @@
+import { Module } from '@nestjs/common';
+
+import { FeatureFlagModule } from 'src/engine/core-modules/feature-flag/feature-flag.module';
+import { TwentyORMModule } from 'src/engine/twenty-orm/twenty-orm.module';
+import { FavoriteFolderDeletionListener } from 'src/modules/favorite-folder/listeners/favorite-folder.listener';
+
+@Module({
+  imports: [TwentyORMModule, FeatureFlagModule],
+  providers: [FavoriteFolderDeletionListener],
+})
+export class FavoriteFolderModule {}

packages/twenty-server/src/modules/favorite-folder/listeners/favorite-folder.listener.ts

@@ -0,0 +1,48 @@
+import { Injectable } from '@nestjs/common';
+import { OnEvent } from '@nestjs/event-emitter';
+
+import { ObjectRecordDeleteEvent } from 'src/engine/core-modules/event-emitter/types/object-record-delete.event';
+import { FeatureFlagKey } from 'src/engine/core-modules/feature-flag/enums/feature-flag-key.enum';
+import { FeatureFlagService } from 'src/engine/core-modules/feature-flag/services/feature-flag.service';
+import { TwentyORMGlobalManager } from 'src/engine/twenty-orm/twenty-orm-global.manager';
+import { WorkspaceEventBatch } from 'src/engine/workspace-event-emitter/workspace-event.type';
+import { FavoriteFolderWorkspaceEntity } from 'src/modules/favorite-folder/standard-objects/favorite-folder.workspace-entity';
+import { FavoriteWorkspaceEntity } from 'src/modules/favorite/standard-objects/favorite.workspace-entity';
+
+@Injectable()
+export class FavoriteFolderDeletionListener {
+  constructor(
+    private readonly twentyORMGlobalManager: TwentyORMGlobalManager,
+    private readonly featureFlagService: FeatureFlagService,
+  ) {}
+
+  @OnEvent('favoriteFolder.deleted')
+  async handleDelete(
+    payload: WorkspaceEventBatch<
+      ObjectRecordDeleteEvent<FavoriteFolderWorkspaceEntity>
+    >,
+  ) {
+    const isFavoriteFolderEntityEnabled =
+      await this.featureFlagService.isFeatureEnabled(
+        FeatureFlagKey.IsFavoriteFolderEntityEnabled,
+        payload.workspaceId,
+      );
+
+    if (!isFavoriteFolderEntityEnabled) {
+      return;
+    }
+
+    for (const eventPayload of payload.events) {
+      const favoriteRepository =
+        await this.twentyORMGlobalManager.getRepositoryForWorkspace<FavoriteWorkspaceEntity>(
+          payload.workspaceId,
+          'favorite',
+        );
+
+      await favoriteRepository.update(
+        { favoriteFolderId: eventPayload.recordId },
+        { deletedAt: new Date().toISOString() },
+      );
+    }
+  }
+}

packages/twenty-server/src/modules/favorite-folder/standard-objects/favorite-folder.workspace-entity.ts

@@ -0,0 +1,58 @@
+import { Relation } from 'src/engine/workspace-manager/workspace-sync-metadata/interfaces/relation.interface';
+
+import { FeatureFlagKey } from 'src/engine/core-modules/feature-flag/enums/feature-flag-key.enum';
+import { FieldMetadataType } from 'src/engine/metadata-modules/field-metadata/field-metadata.entity';
+import { RelationMetadataType } from 'src/engine/metadata-modules/relation-metadata/relation-metadata.entity';
+import { BaseWorkspaceEntity } from 'src/engine/twenty-orm/base.workspace-entity';
+import { WorkspaceEntity } from 'src/engine/twenty-orm/decorators/workspace-entity.decorator';
+import { WorkspaceField } from 'src/engine/twenty-orm/decorators/workspace-field.decorator';
+import { WorkspaceGate } from 'src/engine/twenty-orm/decorators/workspace-gate.decorator';
+import { WorkspaceIsSystem } from 'src/engine/twenty-orm/decorators/workspace-is-system.decorator';
+import { WorkspaceRelation } from 'src/engine/twenty-orm/decorators/workspace-relation.decorator';
+import { FAVORITE_FOLDER_STANDARD_FIELD_IDS } from 'src/engine/workspace-manager/workspace-sync-metadata/constants/standard-field-ids';
+import { STANDARD_OBJECT_IDS } from 'src/engine/workspace-manager/workspace-sync-metadata/constants/standard-object-ids';
+import { FavoriteWorkspaceEntity } from 'src/modules/favorite/standard-objects/favorite.workspace-entity';
+
+@WorkspaceEntity({
+  standardId: STANDARD_OBJECT_IDS.favoriteFolder,
+  namePlural: 'favoriteFolders',
+  labelSingular: 'Favorite Folder',
+  labelPlural: 'Favorite Folders',
+  description: 'A Folder of favorites',
+  icon: 'IconFolder',
+})
+@WorkspaceIsSystem()
+@WorkspaceGate({
+  featureFlag: FeatureFlagKey.IsFavoriteFolderEntityEnabled,
+})
+export class FavoriteFolderWorkspaceEntity extends BaseWorkspaceEntity {
+  @WorkspaceField({
+    standardId: FAVORITE_FOLDER_STANDARD_FIELD_IDS.position,
+    type: FieldMetadataType.NUMBER,
+    label: 'Position',
+    description: 'Favorite folder position',
+    icon: 'IconList',
+    defaultValue: 0,
+  })
+  position: number;
+
+  @WorkspaceField({
+    standardId: FAVORITE_FOLDER_STANDARD_FIELD_IDS.name,
+    type: FieldMetadataType.TEXT,
+    label: 'Name',
+    description: 'Name of the favorite folder',
+    icon: 'IconText',
+  })
+  name: string;
+
+  @WorkspaceRelation({
+    standardId: FAVORITE_FOLDER_STANDARD_FIELD_IDS.favorites,
+    type: RelationMetadataType.ONE_TO_MANY,
+    label: 'Favorites',
+    description: 'Favorites in this folder',
+    icon: 'IconHeart',
+    inverseSideFieldKey: 'favoriteFolder',
+    inverseSideTarget: () => FavoriteWorkspaceEntity,
+  })
+  favorites: Relation<FavoriteWorkspaceEntity[]>;
+}

packages/twenty-server/src/modules/favorite/standard-objects/favorite.workspace-entity.ts

@@ -18,6 +18,7 @@ import { FAVORITE_STANDARD_FIELD_IDS } from 'src/engine/workspace-manager/worksp
 import { STANDARD_OBJECT_ICONS } from 'src/engine/workspace-manager/workspace-sync-metadata/constants/standard-object-icons';
 import { STANDARD_OBJECT_IDS } from 'src/engine/workspace-manager/workspace-sync-metadata/constants/standard-object-ids';
 import { CompanyWorkspaceEntity } from 'src/modules/company/standard-objects/company.workspace-entity';
+import { FavoriteFolderWorkspaceEntity } from 'src/modules/favorite-folder/standard-objects/favorite-folder.workspace-entity';
 import { NoteWorkspaceEntity } from 'src/modules/note/standard-objects/note.workspace-entity';
 import { OpportunityWorkspaceEntity } from 'src/modules/opportunity/standard-objects/opportunity.workspace-entity';
 import { PersonWorkspaceEntity } from 'src/modules/person/standard-objects/person.workspace-entity';
@@ -95,6 +96,27 @@ export class FavoriteWorkspaceEntity extends BaseWorkspaceEntity {
   @WorkspaceJoinColumn('company')
   companyId: string;
 
+  @WorkspaceRelation({
+    standardId: FAVORITE_STANDARD_FIELD_IDS.favoriteFolder,
+    type: RelationMetadataType.MANY_TO_ONE,
+    label: 'Favorite Folder',
+    description: 'The folder this favorite belongs to',
+    icon: 'IconFolder',
+    inverseSideTarget: () => FavoriteFolderWorkspaceEntity,
+    inverseSideFieldKey: 'favorites',
+  })
+  @WorkspaceGate({
+    featureFlag: FeatureFlagKey.IsFavoriteFolderEntityEnabled,
+  })
+  @WorkspaceIsNullable()
+  favoriteFolder: Relation<FavoriteFolderWorkspaceEntity> | null;
+
+  @WorkspaceJoinColumn('favoriteFolder')
+  @WorkspaceGate({
+    featureFlag: FeatureFlagKey.IsFavoriteFolderEntityEnabled,
+  })
+  favoriteFolderId: string;
+
   @WorkspaceRelation({
     standardId: FAVORITE_STANDARD_FIELD_IDS.opportunity,
     type: RelationMetadataType.MANY_TO_ONE,

packages/twenty-server/src/modules/modules.module.ts

@@ -2,6 +2,7 @@ import { Module } from '@nestjs/common';
 
 import { CalendarModule } from 'src/modules/calendar/calendar.module';
 import { ConnectedAccountModule } from 'src/modules/connected-account/connected-account.module';
+import { FavoriteFolderModule } from 'src/modules/favorite-folder/favorite-folder.module';
 import { MessagingModule } from 'src/modules/messaging/messaging.module';
 import { ViewModule } from 'src/modules/view/view.module';
 import { WorkflowModule } from 'src/modules/workflow/workflow.module';
@@ -13,6 +14,7 @@ import { WorkflowModule } from 'src/modules/workflow/workflow.module';
     ConnectedAccountModule,
     ViewModule,
     WorkflowModule,
+    FavoriteFolderModule,
   ],
   providers: [],
   exports: [],