admin/twenty
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

Favorite folders (#7998)

Browse Source 
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>
This commit is contained in:
nitin
2024-11-18 19:52:19 +05:30
committed by GitHub
parent 5115022355
commit 0125d58ba8
100 changed files with 24033 additions and 21488 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
packages/twenty-server/src/database/typeorm-seeds/core/feature-flags.ts
View File

@ -85,6 +85,16 @@ export const seedFeatureFlags = async (
workspaceId: workspaceId,
value: false,
},
{
key: FeatureFlagKey.IsFavoriteFolderEnabled,
workspaceId: workspaceId,
value: true,
},
{
key: FeatureFlagKey.IsFavoriteFolderEntityEnabled,
workspaceId: workspaceId,
value: true,
},
])
.execute();
};

2
packages/twenty-server/src/engine/core-modules/feature-flag/enums/feature-flag-key.enum.ts
View File

@ -15,4 +15,6 @@ export enum FeatureFlagKey {
IsMicrosoftSyncEnabled = 'IS_MICROSOFT_SYNC_ENABLED',
IsAdvancedFiltersEnabled = 'IS_ADVANCED_FILTERS_ENABLED',
IsAggregateQueryEnabled = 'IS_AGGREGATE_QUERY_ENABLED',
IsFavoriteFolderEnabled = 'IS_FAVORITE_FOLDER_ENABLED',
IsFavoriteFolderEntityEnabled = 'IS_FAVORITE_FOLDER_ENTITY_ENABLED',
}

7
packages/twenty-server/src/engine/workspace-manager/workspace-sync-metadata/constants/standard-field-ids.ts
View File

@ -217,6 +217,13 @@ export const FAVORITE_STANDARD_FIELD_IDS = {
note: '20202020-1f25-43fe-8b00-af212fdde824',
view: '20202020-5a93-4fa9-acce-e73481a0bbdf',
custom: '20202020-855a-4bc8-9861-79deef37011f',
favoriteFolder: '20202020-f658-4d12-8b4d-248356aa4bd9',
};
export const FAVORITE_FOLDER_STANDARD_FIELD_IDS = {
position: '20202020-5278-4bde-8909-2cec74d43744',
name: '20202020-82a3-4537-8ff0-dbce7eec35d6',
favorites: '20202020-b5e3-4b42-8af2-03cd4fd2e4d2',
};
export const MESSAGE_CHANNEL_MESSAGE_ASSOCIATION_STANDARD_FIELD_IDS = {

1
packages/twenty-server/src/engine/workspace-manager/workspace-sync-metadata/constants/standard-object-ids.ts
View File

@ -21,6 +21,7 @@ export const STANDARD_OBJECT_IDS = {
company: '20202020-b374-4779-a561-80086cb2e17f',
connectedAccount: '20202020-977e-46b2-890b-c3002ddfd5c5',
favorite: '20202020-ab56-4e05-92a3-e2414a499860',
favoriteFolder: '20202020-7cf8-401f-8211-a9587d27fd2d',
auditLog: '20202020-0566-476a-b4c4-a0f9781bd80a',
messageChannelMessageAssociation: '20202020-ad1e-4127-bccb-d83ae04d2ccb',
messageChannel: '20202020-fe8c-40bc-a681-b80b771449b7',

2
packages/twenty-server/src/engine/workspace-manager/workspace-sync-metadata/standard-objects/index.ts
View File

@ -7,6 +7,7 @@ import { CalendarEventParticipantWorkspaceEntity } from 'src/modules/calendar/co
import { CalendarEventWorkspaceEntity } from 'src/modules/calendar/common/standard-objects/calendar-event.workspace-entity';
import { CompanyWorkspaceEntity } from 'src/modules/company/standard-objects/company.workspace-entity';
import { ConnectedAccountWorkspaceEntity } from 'src/modules/connected-account/standard-objects/connected-account.workspace-entity';
import { FavoriteFolderWorkspaceEntity } from 'src/modules/favorite-folder/standard-objects/favorite-folder.workspace-entity';
import { FavoriteWorkspaceEntity } from 'src/modules/favorite/standard-objects/favorite.workspace-entity';
import { MessageChannelMessageAssociationWorkspaceEntity } from 'src/modules/messaging/common/standard-objects/message-channel-message-association.workspace-entity';
import { MessageChannelWorkspaceEntity } from 'src/modules/messaging/common/standard-objects/message-channel.workspace-entity';
@ -50,6 +51,7 @@ export const standardObjectMetadataDefinitions = [
CompanyWorkspaceEntity,
ConnectedAccountWorkspaceEntity,
FavoriteWorkspaceEntity,
FavoriteFolderWorkspaceEntity,
TimelineActivityWorkspaceEntity,
ViewFieldWorkspaceEntity,
ViewGroupWorkspaceEntity,

11
packages/twenty-server/src/modules/favorite-folder/favorite-folder.module.ts Normal file
View File

@ -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 {}

48
packages/twenty-server/src/modules/favorite-folder/listeners/favorite-folder.listener.ts Normal file
View File

@ -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() },
);
}
}
}

58
packages/twenty-server/src/modules/favorite-folder/standard-objects/favorite-folder.workspace-entity.ts Normal file
View File

@ -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[]>;
}

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

@ -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,

2
packages/twenty-server/src/modules/modules.module.ts
View File

@ -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: [],