feat: twenty orm sync (#5266)

This PR is updating all object metadata entities with the new decorators, and deleting the old ones. This way we can use the new TwentyORM with all the standard objects. --------- Co-authored-by: Weiko <corentin@twenty.com>
2024-05-15 16:58:47 +02:00
parent 6898c1e4d8
commit f0383e3147
81 changed files with 1721 additions and 2060 deletions
--- a/packages/twenty-server/src/modules/activity/standard-objects/activity-target.object-metadata.ts
+++ b/packages/twenty-server/src/modules/activity/standard-objects/activity-target.object-metadata.ts
@ -1,22 +1,22 @@
 import { Relation } from 'src/engine/workspace-manager/workspace-sync-metadata/interfaces/relation.interface';

-import { FieldMetadataType } from 'src/engine/metadata-modules/field-metadata/field-metadata.entity';
 import { ACTIVITY_TARGET_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 { CustomObjectMetadata } from 'src/engine/workspace-manager/workspace-sync-metadata/custom-objects/custom.object-metadata';
-import { DynamicRelationFieldMetadata } from 'src/engine/workspace-manager/workspace-sync-metadata/decorators/dynamic-field-metadata.interface';
-import { FieldMetadata } from 'src/engine/workspace-manager/workspace-sync-metadata/decorators/field-metadata.decorator';
-import { IsNullable } from 'src/engine/workspace-manager/workspace-sync-metadata/decorators/is-nullable.decorator';
-import { IsSystem } from 'src/engine/workspace-manager/workspace-sync-metadata/decorators/is-system.decorator';
-import { ObjectMetadata } from 'src/engine/workspace-manager/workspace-sync-metadata/decorators/object-metadata.decorator';
+import { CustomWorkspaceEntity } from 'src/engine/twenty-orm/custom.workspace-entity';
 import { ActivityObjectMetadata } from 'src/modules/activity/standard-objects/activity.object-metadata';
-import { BaseObjectMetadata } from 'src/engine/workspace-manager/workspace-sync-metadata/standard-objects/base.object-metadata';
 import { CompanyObjectMetadata } from 'src/modules/company/standard-objects/company.object-metadata';
 import { OpportunityObjectMetadata } from 'src/modules/opportunity/standard-objects/opportunity.object-metadata';
 import { PersonObjectMetadata } from 'src/modules/person/standard-objects/person.object-metadata';
-import { IsNotAuditLogged } from 'src/engine/workspace-manager/workspace-sync-metadata/decorators/is-not-audit-logged.decorator';
+import { WorkspaceEntity } from 'src/engine/twenty-orm/decorators/workspace-object.decorator';
+import { WorkspaceIsSystem } from 'src/engine/twenty-orm/decorators/workspace-is-system.decorator';
+import { WorkspaceIsNotAuditLogged } from 'src/engine/twenty-orm/decorators/workspace-is-not-audit-logged.decorator';
+import { WorkspaceIsNullable } from 'src/engine/twenty-orm/decorators/workspace-is-nullable.decorator';
+import { WorkspaceDynamicRelation } from 'src/engine/twenty-orm/decorators/workspace-dynamic-relation.decorator';
+import { RelationMetadataType } from 'src/engine/metadata-modules/relation-metadata/relation-metadata.entity';
+import { WorkspaceRelation } from 'src/engine/twenty-orm/decorators/workspace-relation.decorator';
+import { BaseWorkspaceEntity } from 'src/engine/twenty-orm/base.workspace-entity';

-@ObjectMetadata({
+@WorkspaceEntity({
  standardId: STANDARD_OBJECT_IDS.activityTarget,
  namePlural: 'activityTargets',
  labelSingular: 'Activity Target',
@ -24,60 +24,73 @@ import { IsNotAuditLogged } from 'src/engine/workspace-manager/workspace-sync-me
  description: 'An activity target',
  icon: 'IconCheckbox',
 })
-@IsSystem()
-@IsNotAuditLogged()
-export class ActivityTargetObjectMetadata extends BaseObjectMetadata {
-  @FieldMetadata({
+@WorkspaceIsSystem()
+@WorkspaceIsNotAuditLogged()
+export class ActivityTargetObjectMetadata extends BaseWorkspaceEntity {
+  @WorkspaceRelation({
    standardId: ACTIVITY_TARGET_STANDARD_FIELD_IDS.activity,
-    type: FieldMetadataType.RELATION,
+    type: RelationMetadataType.MANY_TO_ONE,
    label: 'Activity',
    description: 'ActivityTarget activity',
    icon: 'IconNotes',
    joinColumn: 'activityId',
+    inverseSideTarget: () => ActivityObjectMetadata,
+    inverseSideFieldKey: 'activityTargets',
  })
-  @IsNullable()
+  @WorkspaceIsNullable()
  activity: Relation<ActivityObjectMetadata>;

-  @FieldMetadata({
+  @WorkspaceRelation({
    standardId: ACTIVITY_TARGET_STANDARD_FIELD_IDS.person,
-    type: FieldMetadataType.RELATION,
+    type: RelationMetadataType.MANY_TO_ONE,
    label: 'Person',
    description: 'ActivityTarget person',
    icon: 'IconUser',
    joinColumn: 'personId',
+    inverseSideTarget: () => PersonObjectMetadata,
+    inverseSideFieldKey: 'activityTargets',
  })
-  @IsNullable()
+  @WorkspaceIsNullable()
  person: Relation<PersonObjectMetadata>;

-  @FieldMetadata({
+  @WorkspaceRelation({
    standardId: ACTIVITY_TARGET_STANDARD_FIELD_IDS.company,
-    type: FieldMetadataType.RELATION,
+    type: RelationMetadataType.MANY_TO_ONE,
    label: 'Company',
    description: 'ActivityTarget company',
    icon: 'IconBuildingSkyscraper',
    joinColumn: 'companyId',
+    inverseSideTarget: () => CompanyObjectMetadata,
+    inverseSideFieldKey: 'activityTargets',
  })
-  @IsNullable()
+  @WorkspaceIsNullable()
  company: Relation<CompanyObjectMetadata>;

-  @FieldMetadata({
+  @WorkspaceRelation({
    standardId: ACTIVITY_TARGET_STANDARD_FIELD_IDS.opportunity,
-    type: FieldMetadataType.RELATION,
+    type: RelationMetadataType.MANY_TO_ONE,
    label: 'Opportunity',
    description: 'ActivityTarget opportunity',
    icon: 'IconTargetArrow',
    joinColumn: 'opportunityId',
+    inverseSideTarget: () => OpportunityObjectMetadata,
+    inverseSideFieldKey: 'activityTargets',
  })
-  @IsNullable()
+  @WorkspaceIsNullable()
  opportunity: Relation<OpportunityObjectMetadata>;

-  @DynamicRelationFieldMetadata((oppositeObjectMetadata) => ({
-    standardId: ACTIVITY_TARGET_STANDARD_FIELD_IDS.custom,
-    name: oppositeObjectMetadata.nameSingular,
-    label: oppositeObjectMetadata.labelSingular,
-    description: `ActivityTarget ${oppositeObjectMetadata.labelSingular}`,
-    joinColumn: `${oppositeObjectMetadata.nameSingular}Id`,
-    icon: 'IconBuildingSkyscraper',
-  }))
-  custom: Relation<CustomObjectMetadata>;
+  @WorkspaceDynamicRelation({
+    type: RelationMetadataType.MANY_TO_ONE,
+    argsFactory: (oppositeObjectMetadata) => ({
+      standardId: ACTIVITY_TARGET_STANDARD_FIELD_IDS.custom,
+      name: oppositeObjectMetadata.nameSingular,
+      label: oppositeObjectMetadata.labelSingular,
+      description: `ActivityTarget ${oppositeObjectMetadata.labelSingular}`,
+      joinColumn: `${oppositeObjectMetadata.nameSingular}Id`,
+      icon: 'IconBuildingSkyscraper',
+    }),
+    inverseSideTarget: () => CustomWorkspaceEntity,
+    inverseSideFieldKey: 'activityTargets',
+  })
+  custom: Relation<CustomWorkspaceEntity>;
 }
--- a/packages/twenty-server/src/modules/activity/standard-objects/activity.object-metadata.ts
+++ b/packages/twenty-server/src/modules/activity/standard-objects/activity.object-metadata.ts
@ -7,19 +7,19 @@ import {
 } from 'src/engine/metadata-modules/relation-metadata/relation-metadata.entity';
 import { ACTIVITY_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 { FieldMetadata } from 'src/engine/workspace-manager/workspace-sync-metadata/decorators/field-metadata.decorator';
-import { IsNullable } from 'src/engine/workspace-manager/workspace-sync-metadata/decorators/is-nullable.decorator';
-import { IsSystem } from 'src/engine/workspace-manager/workspace-sync-metadata/decorators/is-system.decorator';
-import { ObjectMetadata } from 'src/engine/workspace-manager/workspace-sync-metadata/decorators/object-metadata.decorator';
-import { RelationMetadata } from 'src/engine/workspace-manager/workspace-sync-metadata/decorators/relation-metadata.decorator';
 import { ActivityTargetObjectMetadata } from 'src/modules/activity/standard-objects/activity-target.object-metadata';
 import { AttachmentObjectMetadata } from 'src/modules/attachment/standard-objects/attachment.object-metadata';
-import { BaseObjectMetadata } from 'src/engine/workspace-manager/workspace-sync-metadata/standard-objects/base.object-metadata';
 import { CommentObjectMetadata } from 'src/modules/activity/standard-objects/comment.object-metadata';
 import { WorkspaceMemberObjectMetadata } from 'src/modules/workspace-member/standard-objects/workspace-member.object-metadata';
-import { IsNotAuditLogged } from 'src/engine/workspace-manager/workspace-sync-metadata/decorators/is-not-audit-logged.decorator';
+import { WorkspaceEntity } from 'src/engine/twenty-orm/decorators/workspace-object.decorator';
+import { WorkspaceIsNotAuditLogged } from 'src/engine/twenty-orm/decorators/workspace-is-not-audit-logged.decorator';
+import { WorkspaceIsSystem } from 'src/engine/twenty-orm/decorators/workspace-is-system.decorator';
+import { WorkspaceField } from 'src/engine/twenty-orm/decorators/workspace-field.decorator';
+import { WorkspaceRelation } from 'src/engine/twenty-orm/decorators/workspace-relation.decorator';
+import { WorkspaceIsNullable } from 'src/engine/twenty-orm/decorators/workspace-is-nullable.decorator';
+import { BaseWorkspaceEntity } from 'src/engine/twenty-orm/base.workspace-entity';

-@ObjectMetadata({
+@WorkspaceEntity({
  standardId: STANDARD_OBJECT_IDS.activity,
  namePlural: 'activities',
  labelSingular: 'Activity',
@ -27,10 +27,10 @@ import { IsNotAuditLogged } from 'src/engine/workspace-manager/workspace-sync-me
  description: 'An activity',
  icon: 'IconCheckbox',
 })
-@IsNotAuditLogged()
-@IsSystem()
-export class ActivityObjectMetadata extends BaseObjectMetadata {
-  @FieldMetadata({
+@WorkspaceIsNotAuditLogged()
+@WorkspaceIsSystem()
+export class ActivityObjectMetadata extends BaseWorkspaceEntity {
+  @WorkspaceField({
    standardId: ACTIVITY_STANDARD_FIELD_IDS.title,
    type: FieldMetadataType.TEXT,
    label: 'Title',
@ -39,7 +39,7 @@ export class ActivityObjectMetadata extends BaseObjectMetadata {
  })
  title: string;

-  @FieldMetadata({
+  @WorkspaceField({
    standardId: ACTIVITY_STANDARD_FIELD_IDS.body,
    type: FieldMetadataType.TEXT,
    label: 'Body',
@ -48,7 +48,7 @@ export class ActivityObjectMetadata extends BaseObjectMetadata {
  })
  body: string;

-  @FieldMetadata({
+  @WorkspaceField({
    standardId: ACTIVITY_STANDARD_FIELD_IDS.type,
    type: FieldMetadataType.TEXT,
    label: 'Type',
@ -58,100 +58,97 @@ export class ActivityObjectMetadata extends BaseObjectMetadata {
  })
  type: string;

-  @FieldMetadata({
+  @WorkspaceField({
    standardId: ACTIVITY_STANDARD_FIELD_IDS.reminderAt,
    type: FieldMetadataType.DATE_TIME,
    label: 'Reminder Date',
    description: 'Activity reminder date',
    icon: 'IconCalendarEvent',
  })
-  @IsNullable()
+  @WorkspaceIsNullable()
  reminderAt: Date;

-  @FieldMetadata({
+  @WorkspaceField({
    standardId: ACTIVITY_STANDARD_FIELD_IDS.dueAt,
    type: FieldMetadataType.DATE_TIME,
    label: 'Due Date',
    description: 'Activity due date',
    icon: 'IconCalendarEvent',
  })
-  @IsNullable()
+  @WorkspaceIsNullable()
  dueAt: Date;

-  @FieldMetadata({
+  @WorkspaceField({
    standardId: ACTIVITY_STANDARD_FIELD_IDS.completedAt,
    type: FieldMetadataType.DATE_TIME,
    label: 'Completion Date',
    description: 'Activity completion date',
    icon: 'IconCheck',
  })
-  @IsNullable()
+  @WorkspaceIsNullable()
  completedAt: Date;

-  @FieldMetadata({
+  @WorkspaceRelation({
    standardId: ACTIVITY_STANDARD_FIELD_IDS.activityTargets,
-    type: FieldMetadataType.RELATION,
    label: 'Targets',
    description: 'Activity targets',
    icon: 'IconCheckbox',
-  })
-  @RelationMetadata({
    type: RelationMetadataType.ONE_TO_MANY,
    inverseSideTarget: () => ActivityTargetObjectMetadata,
    onDelete: RelationOnDeleteAction.SET_NULL,
  })
-  @IsNullable()
+  @WorkspaceIsNullable()
  activityTargets: Relation<ActivityTargetObjectMetadata[]>;

-  @FieldMetadata({
+  @WorkspaceRelation({
    standardId: ACTIVITY_STANDARD_FIELD_IDS.attachments,
-    type: FieldMetadataType.RELATION,
    label: 'Attachments',
    description: 'Activity attachments',
    icon: 'IconFileImport',
-  })
-  @RelationMetadata({
    type: RelationMetadataType.ONE_TO_MANY,
    inverseSideTarget: () => AttachmentObjectMetadata,
    onDelete: RelationOnDeleteAction.SET_NULL,
  })
-  @IsNullable()
+  @WorkspaceIsNullable()
  attachments: Relation<AttachmentObjectMetadata[]>;

-  @FieldMetadata({
+  @WorkspaceRelation({
    standardId: ACTIVITY_STANDARD_FIELD_IDS.comments,
-    type: FieldMetadataType.RELATION,
    label: 'Comments',
    description: 'Activity comments',
    icon: 'IconComment',
-  })
-  @RelationMetadata({
    type: RelationMetadataType.ONE_TO_MANY,
    inverseSideTarget: () => CommentObjectMetadata,
    onDelete: RelationOnDeleteAction.CASCADE,
  })
-  @IsNullable()
+  @WorkspaceIsNullable()
  comments: Relation<CommentObjectMetadata[]>;

-  @FieldMetadata({
+  @WorkspaceRelation({
    standardId: ACTIVITY_STANDARD_FIELD_IDS.author,
-    type: FieldMetadataType.RELATION,
    label: 'Author',
    description: 'Activity author',
    icon: 'IconUserCircle',
+    type: RelationMetadataType.MANY_TO_ONE,
+    inverseSideTarget: () => WorkspaceMemberObjectMetadata,
+    inverseSideFieldKey: 'authoredActivities',
+    onDelete: RelationOnDeleteAction.SET_NULL,
    joinColumn: 'authorId',
  })
-  @IsNullable()
+  @WorkspaceIsNullable()
  author: Relation<WorkspaceMemberObjectMetadata>;

-  @FieldMetadata({
+  @WorkspaceRelation({
    standardId: ACTIVITY_STANDARD_FIELD_IDS.assignee,
-    type: FieldMetadataType.RELATION,
    label: 'Assignee',
    description: 'Activity assignee',
    icon: 'IconUserCircle',
+    type: RelationMetadataType.MANY_TO_ONE,
+    inverseSideTarget: () => WorkspaceMemberObjectMetadata,
+    inverseSideFieldKey: 'assignedActivities',
+    onDelete: RelationOnDeleteAction.SET_NULL,
    joinColumn: 'assigneeId',
  })
-  @IsNullable()
+  @WorkspaceIsNullable()
  assignee: Relation<WorkspaceMemberObjectMetadata>;
 }
--- a/packages/twenty-server/src/modules/activity/standard-objects/comment.object-metadata.ts
+++ b/packages/twenty-server/src/modules/activity/standard-objects/comment.object-metadata.ts
@ -3,15 +3,17 @@ import { Relation } from 'src/engine/workspace-manager/workspace-sync-metadata/i
 import { FieldMetadataType } from 'src/engine/metadata-modules/field-metadata/field-metadata.entity';
 import { COMMENT_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 { FieldMetadata } from 'src/engine/workspace-manager/workspace-sync-metadata/decorators/field-metadata.decorator';
-import { IsSystem } from 'src/engine/workspace-manager/workspace-sync-metadata/decorators/is-system.decorator';
-import { ObjectMetadata } from 'src/engine/workspace-manager/workspace-sync-metadata/decorators/object-metadata.decorator';
 import { ActivityObjectMetadata } from 'src/modules/activity/standard-objects/activity.object-metadata';
-import { BaseObjectMetadata } from 'src/engine/workspace-manager/workspace-sync-metadata/standard-objects/base.object-metadata';
 import { WorkspaceMemberObjectMetadata } from 'src/modules/workspace-member/standard-objects/workspace-member.object-metadata';
-import { IsNotAuditLogged } from 'src/engine/workspace-manager/workspace-sync-metadata/decorators/is-not-audit-logged.decorator';
+import { WorkspaceEntity } from 'src/engine/twenty-orm/decorators/workspace-object.decorator';
+import { WorkspaceIsSystem } from 'src/engine/twenty-orm/decorators/workspace-is-system.decorator';
+import { WorkspaceIsNotAuditLogged } from 'src/engine/twenty-orm/decorators/workspace-is-not-audit-logged.decorator';
+import { WorkspaceField } from 'src/engine/twenty-orm/decorators/workspace-field.decorator';
+import { WorkspaceRelation } from 'src/engine/twenty-orm/decorators/workspace-relation.decorator';
+import { RelationMetadataType } from 'src/engine/metadata-modules/relation-metadata/relation-metadata.entity';
+import { BaseWorkspaceEntity } from 'src/engine/twenty-orm/base.workspace-entity';

-@ObjectMetadata({
+@WorkspaceEntity({
  standardId: STANDARD_OBJECT_IDS.comment,
  namePlural: 'comments',
  labelSingular: 'Comment',
@ -19,10 +21,10 @@ import { IsNotAuditLogged } from 'src/engine/workspace-manager/workspace-sync-me
  description: 'A comment',
  icon: 'IconMessageCircle',
 })
-@IsSystem()
-@IsNotAuditLogged()
-export class CommentObjectMetadata extends BaseObjectMetadata {
-  @FieldMetadata({
+@WorkspaceIsSystem()
+@WorkspaceIsNotAuditLogged()
+export class CommentObjectMetadata extends BaseWorkspaceEntity {
+  @WorkspaceField({
    standardId: COMMENT_STANDARD_FIELD_IDS.body,
    type: FieldMetadataType.TEXT,
    label: 'Body',
@ -31,23 +33,27 @@ export class CommentObjectMetadata extends BaseObjectMetadata {
  })
  body: string;

-  @FieldMetadata({
+  @WorkspaceRelation({
    standardId: COMMENT_STANDARD_FIELD_IDS.author,
-    type: FieldMetadataType.RELATION,
+    type: RelationMetadataType.MANY_TO_ONE,
    label: 'Author',
    description: 'Comment author',
    icon: 'IconCircleUser',
    joinColumn: 'authorId',
+    inverseSideTarget: () => WorkspaceMemberObjectMetadata,
+    inverseSideFieldKey: 'authoredComments',
  })
  author: Relation<WorkspaceMemberObjectMetadata>;

-  @FieldMetadata({
+  @WorkspaceRelation({
    standardId: COMMENT_STANDARD_FIELD_IDS.activity,
-    type: FieldMetadataType.RELATION,
+    type: RelationMetadataType.MANY_TO_ONE,
    label: 'Activity',
    description: 'Comment activity',
    icon: 'IconNotes',
    joinColumn: 'activityId',
+    inverseSideTarget: () => ActivityObjectMetadata,
+    inverseSideFieldKey: 'comments',
  })
  activity: Relation<ActivityObjectMetadata>;
 }