Add shortcut metadata to data models & CommandMenu (twentyhq#7977)

Resolves twentyhq#7503 --------- Co-authored-by: Félix Malfait <[email protected]>
BOHEUS · Oct 25, 2024 · bf2ba25 · bf2ba25
1 parent 7edfa61
commit bf2ba25
Show file tree

Hide file tree

Showing 21 changed files with 80 additions and 13 deletions.
diff --git a/packages/twenty-front/src/generated-metadata/gql.ts b/packages/twenty-front/src/generated-metadata/gql.ts
diff --git a/packages/twenty-front/src/generated-metadata/graphql.ts b/packages/twenty-front/src/generated-metadata/graphql.ts
diff --git a/packages/twenty-front/src/modules/app/effect-components/GotoHotkeysEffectsProvider.tsx b/packages/twenty-front/src/modules/app/effect-components/GotoHotkeysEffectsProvider.tsx
@@ -27,11 +27,17 @@ export const GotoHotkeysEffectsProvider = () => {
     ),
   });
 
-  return nonSystemActiveObjectMetadataItems.map((objectMetadataItem) => (
-    <GoToHotkeyItemEffect
-      key={`go-to-hokey-item-${objectMetadataItem.id}`}
-      hotkey={objectMetadataItem.namePlural[0]}
-      pathToNavigateTo={`/objects/${objectMetadataItem.namePlural}`}
-    />
-  ));
+  return nonSystemActiveObjectMetadataItems.map((objectMetadataItem) => {
+    if (!objectMetadataItem.shortcut) {
+      return null;
+    }
+
+    return (
+      <GoToHotkeyItemEffect
+        key={`go-to-hokey-item-${objectMetadataItem.id}`}
+        hotkey={objectMetadataItem.shortcut}
+        pathToNavigateTo={`/objects/${objectMetadataItem.namePlural}`}
+      />
+    );
+  });
 };
diff --git a/packages/twenty-front/src/modules/command-menu/hooks/__tests__/useCommandMenu.test.tsx b/packages/twenty-front/src/modules/command-menu/hooks/__tests__/useCommandMenu.test.tsx
@@ -125,6 +125,7 @@ describe('useCommandMenu', () => {
           labelSingular: 'Task',
           labelPlural: 'Tasks',
           shouldSyncLabelAndName: true,
+          shortcut: 'T',
           description: 'A task',
           icon: 'IconCheckbox',
           isCustom: false,

diff --git a/packages/twenty-front/src/modules/command-menu/hooks/useCommandMenu.ts b/packages/twenty-front/src/modules/command-menu/hooks/useCommandMenu.ts
@@ -83,8 +83,8 @@ export const useCommandMenu = () => {
               to: `/objects/${item.namePlural}`,
               label: `Go to ${item.labelPlural}`,
               type: CommandType.Navigate,
-              firstHotKey: 'G',
-              secondHotKey: item.labelPlural[0],
+              firstHotKey: item.shortcut ? 'G' : undefined,
+              secondHotKey: item.shortcut,
               Icon: ALL_ICONS[
                 (item?.icon as keyof typeof ALL_ICONS) ?? 'IconArrowUpRight'
               ],

diff --git a/packages/twenty-front/src/modules/object-metadata/graphql/queries.ts b/packages/twenty-front/src/modules/object-metadata/graphql/queries.ts
@@ -24,6 +24,7 @@ export const FIND_MANY_OBJECT_METADATA_ITEMS = gql`
           updatedAt
           labelIdentifierFieldMetadataId
           imageIdentifierFieldMetadataId
+          shortcut
           shouldSyncLabelAndName
           indexMetadatas(paging: { first: 100 }) {
             edges {

diff --git a/...wenty-front/src/modules/object-metadata/hooks/__mocks__/useFindManyObjectMetadataItems.ts b/...wenty-front/src/modules/object-metadata/hooks/__mocks__/useFindManyObjectMetadataItems.ts
@@ -24,6 +24,8 @@ export const query = gql`
           updatedAt
           labelIdentifierFieldMetadataId
           imageIdentifierFieldMetadataId
+          shortcut
+          shouldSyncLabelAndName
           fields(paging: { first: 1000 }, filter: $fieldFilter) {
             edges {
               node {

diff --git a/...s/twenty-front/src/modules/object-metadata/validation-schemas/objectMetadataItemSchema.ts b/...s/twenty-front/src/modules/object-metadata/validation-schemas/objectMetadataItemSchema.ts
@@ -26,5 +26,6 @@ export const objectMetadataItemSchema = z.object({
   namePlural: camelCaseStringSchema,
   nameSingular: camelCaseStringSchema,
   updatedAt: z.string().datetime(),
+  shortcut: z.string().nullable().optional(),
   shouldSyncLabelAndName: z.boolean(),
 }) satisfies z.ZodType<ObjectMetadataItem>;
diff --git a/...enty-server/src/database/typeorm/metadata/migrations/1729676165199-add-object-shortcut.ts b/...enty-server/src/database/typeorm/metadata/migrations/1729676165199-add-object-shortcut.ts
@@ -0,0 +1,24 @@
+import { MigrationInterface, QueryRunner } from 'typeorm';
+
+export class AddObjectShortcut1729676165199 implements MigrationInterface {
+  name = 'AddObjectShortcut1729676165199';
+
+  public async up(queryRunner: QueryRunner): Promise<void> {
+    await queryRunner.query(
+      `ALTER TABLE "metadata"."objectMetadata" ADD "shortcut" character varying`,
+    );
+    await queryRunner.query(
+      `CREATE UNIQUE INDEX "IDX_objectMetadata_shortcut_upper_workspace" ON "metadata"."objectMetadata" (UPPER("shortcut"), "workspaceId")`,
+    );
+  }
+
+  public async down(queryRunner: QueryRunner): Promise<void> {
+    await queryRunner.query(
+      `DROP INDEX "metadata"."IDX_objectMetadata_shortcut_upper_workspace"`,
+    );
+
+    await queryRunner.query(
+      `ALTER TABLE "metadata"."objectMetadata" DROP COLUMN "shortcut"`,
+    );
+  }
+}
diff --git a/...ges/twenty-server/src/engine/metadata-modules/object-metadata/dtos/create-object.input.ts b/...ges/twenty-server/src/engine/metadata-modules/object-metadata/dtos/create-object.input.ts
@@ -51,6 +51,11 @@ export class CreateObjectInput {
   @Field({ nullable: true })
   icon?: string;
 
+  @IsString()
+  @IsOptional()
+  @Field({ nullable: true })
+  shortcut?: string;
+
   @HideField()
   dataSourceId: string;
 

diff --git a/...ges/twenty-server/src/engine/metadata-modules/object-metadata/dtos/object-metadata.dto.ts b/...ges/twenty-server/src/engine/metadata-modules/object-metadata/dtos/object-metadata.dto.ts
@@ -53,6 +53,9 @@ export class ObjectMetadataDTO {
   @Field({ nullable: true })
   icon: string;
 
+  @Field({ nullable: true })
+  shortcut: string;
+
   @FilterableField()
   isCustom: boolean;
 

diff --git a/...ges/twenty-server/src/engine/metadata-modules/object-metadata/dtos/update-object.input.ts b/...ges/twenty-server/src/engine/metadata-modules/object-metadata/dtos/update-object.input.ts
@@ -47,6 +47,11 @@ export class UpdateObjectPayload {
   @Field({ nullable: true })
   icon?: string;
 
+  @IsString()
+  @IsOptional()
+  @Field({ nullable: true })
+  shortcut?: string;
+
   @IsBoolean()
   @IsOptional()
   @Field({ nullable: true })

diff --git a/packages/twenty-server/src/engine/metadata-modules/object-metadata/object-metadata.entity.ts b/packages/twenty-server/src/engine/metadata-modules/object-metadata/object-metadata.entity.ts
@@ -69,6 +69,9 @@ export class ObjectMetadataEntity implements ObjectMetadataInterface {
   @Column({ default: true })
   isAuditLogged: boolean;
 
+  @Column({ nullable: true })
+  shortcut: string;
+
   @Column({ nullable: true, type: 'uuid' })
   labelIdentifierFieldMetadataId?: string | null;
 

diff --git a/packages/twenty-server/src/engine/twenty-orm/decorators/workspace-entity.decorator.ts b/packages/twenty-server/src/engine/twenty-orm/decorators/workspace-entity.decorator.ts
@@ -10,6 +10,7 @@ interface WorkspaceEntityOptions {
   labelPlural: string;
   description?: string;
   icon?: string;
+  shortcut?: string;
   labelIdentifierStandardId?: string;
   imageIdentifierStandardId?: string;
 }
@@ -44,6 +45,7 @@ export function WorkspaceEntity(
         options.labelIdentifierStandardId ?? BASE_OBJECT_STANDARD_FIELD_IDS.id,
       imageIdentifierStandardId: options.imageIdentifierStandardId ?? null,
       icon: options.icon,
+      shortcut: options.shortcut,
       isAuditLogged,
       isSystem,
       gate,

diff --git a/...wenty-server/src/engine/twenty-orm/interfaces/workspace-entity-metadata-args.interface.ts b/...wenty-server/src/engine/twenty-orm/interfaces/workspace-entity-metadata-args.interface.ts
@@ -36,6 +36,11 @@ export interface WorkspaceEntityMetadataArgs {
    */
   readonly icon?: string;
 
+  /**
+   * Entity shortcut.
+   */
+  readonly shortcut?: string;
+
   /**
    * Is audit logged.
    */

diff --git a/packages/twenty-server/src/modules/company/standard-objects/company.workspace-entity.ts b/packages/twenty-server/src/modules/company/standard-objects/company.workspace-entity.ts
@@ -54,6 +54,7 @@ export const SEARCH_FIELDS_FOR_COMPANY: FieldTypeAndNameMetadata[] = [
   labelPlural: 'Companies',
   description: 'A company',
   icon: 'IconBuildingSkyscraper',
+  shortcut: 'C',
   labelIdentifierStandardId: COMPANY_STANDARD_FIELD_IDS.name,
 })
 export class CompanyWorkspaceEntity extends BaseWorkspaceEntity {

diff --git a/packages/twenty-server/src/modules/note/standard-objects/note.workspace-entity.ts b/packages/twenty-server/src/modules/note/standard-objects/note.workspace-entity.ts
@@ -44,6 +44,7 @@ export const SEARCH_FIELDS_FOR_NOTES: FieldTypeAndNameMetadata[] = [
   labelPlural: 'Notes',
   description: 'A note',
   icon: 'IconNotes',
+  shortcut: 'N',
   labelIdentifierStandardId: NOTE_STANDARD_FIELD_IDS.title,
 })
 export class NoteWorkspaceEntity extends BaseWorkspaceEntity {

diff --git a/...es/twenty-server/src/modules/opportunity/standard-objects/opportunity.workspace-entity.ts b/...es/twenty-server/src/modules/opportunity/standard-objects/opportunity.workspace-entity.ts
@@ -50,6 +50,7 @@ export const SEARCH_FIELDS_FOR_OPPORTUNITY: FieldTypeAndNameMetadata[] = [
   labelPlural: 'Opportunities',
   description: 'An opportunity',
   icon: 'IconTargetArrow',
+  shortcut: 'O',
   labelIdentifierStandardId: OPPORTUNITY_STANDARD_FIELD_IDS.name,
 })
 @WorkspaceIsNotAuditLogged()

diff --git a/packages/twenty-server/src/modules/person/standard-objects/person.workspace-entity.ts b/packages/twenty-server/src/modules/person/standard-objects/person.workspace-entity.ts
@@ -59,6 +59,7 @@ export const SEARCH_FIELDS_FOR_PERSON: FieldTypeAndNameMetadata[] = [
   labelPlural: 'People',
   description: 'A person',
   icon: 'IconUser',
+  shortcut: 'P',
   labelIdentifierStandardId: PERSON_STANDARD_FIELD_IDS.name,
   imageIdentifierStandardId: PERSON_STANDARD_FIELD_IDS.avatarUrl,
 })

diff --git a/packages/twenty-server/src/modules/task/standard-objects/task.workspace-entity.ts b/packages/twenty-server/src/modules/task/standard-objects/task.workspace-entity.ts
@@ -31,6 +31,7 @@ import { WorkspaceMemberWorkspaceEntity } from 'src/modules/workspace-member/sta
   labelPlural: 'Tasks',
   description: 'A task',
   icon: 'IconCheckbox',
+  shortcut: 'T',
   labelIdentifierStandardId: TASK_STANDARD_FIELD_IDS.title,
 })
 export class TaskWorkspaceEntity extends BaseWorkspaceEntity {

diff --git a/...s/twenty-server/src/modules/workflow/common/standard-objects/workflow.workspace-entity.ts b/...s/twenty-server/src/modules/workflow/common/standard-objects/workflow.workspace-entity.ts
@@ -55,6 +55,7 @@ const WorkflowStatusOptions = [
   labelPlural: 'Workflows',
   description: 'A workflow',
   icon: 'IconSettingsAutomation',
+  shortcut: 'W',
   labelIdentifierStandardId: WORKFLOW_STANDARD_FIELD_IDS.name,
 })
 @WorkspaceGate({