feat: CommandMenuItem entity and FrontComponent support in command menu (#17555)

https://github.com/user-attachments/assets/6f172ffc-d43d-42fd-a26b-94f591fb767e
2026-01-30 22:05:06 +05:30
parent 6462ff6c5f
commit 51a2a90b0a
45 changed files with 899 additions and 34 deletions
@@ -5,6 +5,7 @@ import { ApplicationEntity } from 'src/engine/core-modules/application/applicati
 import { CommandMenuItemEntity } from 'src/engine/metadata-modules/command-menu-item/entities/command-menu-item.entity';
 import { WorkspaceFlatCommandMenuItemMapCacheService } from 'src/engine/metadata-modules/flat-command-menu-item/services/workspace-flat-command-menu-item-map-cache.service';
 import { WorkspaceManyOrAllFlatEntityMapsCacheModule } from 'src/engine/metadata-modules/flat-entity/services/workspace-many-or-all-flat-entity-maps-cache.module';
+import { FrontComponentEntity } from 'src/engine/metadata-modules/front-component/entities/front-component.entity';
 import { ObjectMetadataEntity } from 'src/engine/metadata-modules/object-metadata/object-metadata.entity';

@Module({
@@ -13,6 +14,7 @@ import { ObjectMetadataEntity } from 'src/engine/metadata-modules/object-metadat
      CommandMenuItemEntity,
      ApplicationEntity,
      ObjectMetadataEntity,
+      FrontComponentEntity,
    ]),
    WorkspaceManyOrAllFlatEntityMapsCacheModule,
  ],
@@ -10,6 +10,7 @@ import { CommandMenuItemEntity } from 'src/engine/metadata-modules/command-menu-
 import { type FlatCommandMenuItemMaps } from 'src/engine/metadata-modules/flat-command-menu-item/types/flat-command-menu-item-maps.type';
 import { fromCommandMenuItemEntityToFlatCommandMenuItem } from 'src/engine/metadata-modules/flat-command-menu-item/utils/from-command-menu-item-entity-to-flat-command-menu-item.util';
 import { createEmptyFlatEntityMaps } from 'src/engine/metadata-modules/flat-entity/constant/create-empty-flat-entity-maps.constant';
+import { FrontComponentEntity } from 'src/engine/metadata-modules/front-component/entities/front-component.entity';
 import { ObjectMetadataEntity } from 'src/engine/metadata-modules/object-metadata/object-metadata.entity';
 import { WorkspaceCache } from 'src/engine/workspace-cache/decorators/workspace-cache.decorator';
 import { createIdToUniversalIdentifierMap } from 'src/engine/workspace-cache/utils/create-id-to-universal-identifier-map.util';
@@ -25,13 +26,15 @@ export class WorkspaceFlatCommandMenuItemMapCacheService extends WorkspaceCacheP
    private readonly applicationRepository: Repository<ApplicationEntity>,
    @InjectRepository(ObjectMetadataEntity)
    private readonly objectMetadataRepository: Repository<ObjectMetadataEntity>,
+    @InjectRepository(FrontComponentEntity)
+    private readonly frontComponentRepository: Repository<FrontComponentEntity>,
  ) {
    super();
  }

  async computeForCache(workspaceId: string): Promise<FlatCommandMenuItemMaps> {
-    const [commandMenuItems, applications, objectMetadatas] = await Promise.all(
-      [
+    const [commandMenuItems, applications, objectMetadatas, frontComponents] =
+      await Promise.all([
        this.commandMenuItemRepository.find({
          where: { workspaceId },
          withDeleted: true,
@@ -46,13 +49,19 @@ export class WorkspaceFlatCommandMenuItemMapCacheService extends WorkspaceCacheP
          select: ['id', 'universalIdentifier'],
          withDeleted: true,
        }),
-      ],
-    );
+        this.frontComponentRepository.find({
+          where: { workspaceId },
+          select: ['id', 'universalIdentifier'],
+          withDeleted: true,
+        }),
+      ]);

    const applicationIdToUniversalIdentifierMap =
      createIdToUniversalIdentifierMap(applications);
    const objectMetadataIdToUniversalIdentifierMap =
      createIdToUniversalIdentifierMap(objectMetadatas);
+    const frontComponentIdToUniversalIdentifierMap =
+      createIdToUniversalIdentifierMap(frontComponents);

    const flatCommandMenuItemMaps = createEmptyFlatEntityMaps();

@@ -62,6 +71,7 @@ export class WorkspaceFlatCommandMenuItemMapCacheService extends WorkspaceCacheP
          entity: commandMenuItemEntity,
          applicationIdToUniversalIdentifierMap,
          objectMetadataIdToUniversalIdentifierMap,
+          frontComponentIdToUniversalIdentifierMap,
        });

      addFlatEntityToFlatEntityMapsThroughMutationOrThrow({
@@ -11,6 +11,7 @@ export const fromCommandMenuItemEntityToFlatCommandMenuItem = ({
  entity: commandMenuItemEntity,
  applicationIdToUniversalIdentifierMap,
  objectMetadataIdToUniversalIdentifierMap,
+  frontComponentIdToUniversalIdentifierMap,
 }: FromEntityToFlatEntityArgs<'commandMenuItem'>): FlatCommandMenuItem => {
  const applicationUniversalIdentifier =
    applicationIdToUniversalIdentifierMap.get(
@@ -40,9 +41,26 @@ export const fromCommandMenuItemEntityToFlatCommandMenuItem = ({
    }
  }

+  let frontComponentUniversalIdentifier: string | null = null;
+
+  if (isDefined(commandMenuItemEntity.frontComponentId)) {
+    frontComponentUniversalIdentifier =
+      frontComponentIdToUniversalIdentifierMap.get(
+        commandMenuItemEntity.frontComponentId,
+      ) ?? null;
+
+    if (!isDefined(frontComponentUniversalIdentifier)) {
+      throw new FlatEntityMapsException(
+        `FrontComponent with id ${commandMenuItemEntity.frontComponentId} not found for commandMenuItem ${commandMenuItemEntity.id}`,
+        FlatEntityMapsExceptionCode.ENTITY_NOT_FOUND,
+      );
+    }
+  }
+
  return {
    id: commandMenuItemEntity.id,
    workflowVersionId: commandMenuItemEntity.workflowVersionId,
+    frontComponentId: commandMenuItemEntity.frontComponentId,
    label: commandMenuItemEntity.label,
    icon: commandMenuItemEntity.icon,
    isPinned: commandMenuItemEntity.isPinned,
@@ -58,6 +76,7 @@ export const fromCommandMenuItemEntityToFlatCommandMenuItem = ({
      universalIdentifier: commandMenuItemEntity.universalIdentifier,
      applicationUniversalIdentifier,
      availabilityObjectMetadataUniversalIdentifier,
+      frontComponentUniversalIdentifier,
    },
  };
 };
@@ -1,5 +1,10 @@
+import { isDefined } from 'twenty-shared/utils';
 import { v4 as uuidv4 } from 'uuid';

+import {
+  CommandMenuItemException,
+  CommandMenuItemExceptionCode,
+} from 'src/engine/metadata-modules/command-menu-item/command-menu-item.exception';
 import { type CreateCommandMenuItemInput } from 'src/engine/metadata-modules/command-menu-item/dtos/create-command-menu-item.input';
 import { CommandMenuItemAvailabilityType } from 'src/engine/metadata-modules/command-menu-item/entities/command-menu-item.entity';
 import { type FlatCommandMenuItem } from 'src/engine/metadata-modules/flat-command-menu-item/types/flat-command-menu-item.type';
@@ -13,13 +18,28 @@ export const fromCreateCommandMenuItemInputToFlatCommandMenuItemToCreate = ({
  workspaceId: string;
  applicationId: string;
 }): FlatCommandMenuItem => {
+  const hasWorkflowVersionId = isDefined(
+    createCommandMenuItemInput.workflowVersionId,
+  );
+  const hasFrontComponentId = isDefined(
+    createCommandMenuItemInput.frontComponentId,
+  );
+
+  if (hasWorkflowVersionId === hasFrontComponentId) {
+    throw new CommandMenuItemException(
+      'Exactly one of workflowVersionId or frontComponentId is required',
+      CommandMenuItemExceptionCode.WORKFLOW_OR_FRONT_COMPONENT_REQUIRED,
+    );
+  }
+
  const id = uuidv4();
  const now = new Date().toISOString();

  return {
    id,
    universalIdentifier: id,
-    workflowVersionId: createCommandMenuItemInput.workflowVersionId,
+    workflowVersionId: createCommandMenuItemInput.workflowVersionId ?? null,
+    frontComponentId: createCommandMenuItemInput.frontComponentId ?? null,
    label: createCommandMenuItemInput.label,
    icon: createCommandMenuItemInput.icon ?? null,
    isPinned: createCommandMenuItemInput.isPinned ?? false,
@@ -5,7 +5,8 @@ export const fromFlatCommandMenuItemToCommandMenuItemDto = (
  flatCommandMenuItem: FlatCommandMenuItem,
 ): CommandMenuItemDTO => ({
  id: flatCommandMenuItem.id,
-  workflowVersionId: flatCommandMenuItem.workflowVersionId,
+  workflowVersionId: flatCommandMenuItem.workflowVersionId ?? undefined,
+  frontComponentId: flatCommandMenuItem.frontComponentId ?? undefined,
  label: flatCommandMenuItem.label,
  icon: flatCommandMenuItem.icon ?? undefined,
  isPinned: flatCommandMenuItem.isPinned,