Add JSON field type and Event object (#4566)

* Add JSON field type and Event object * Simplify code * Adress PR comments and add featureFlag
2024-03-19 21:54:08 +01:00
parent 4ab426c52a
commit 4bfb90657f
51 changed files with 575 additions and 117 deletions
--- a/packages/twenty-server/src/modules/event/standard-objects/event.object-metadata.ts
+++ b/packages/twenty-server/src/modules/event/standard-objects/event.object-metadata.ts
@ -0,0 +1,103 @@
+import { FieldMetadataType } from 'src/engine-metadata/field-metadata/field-metadata.entity';
+import { FeatureFlagKeys } from 'src/engine/modules/feature-flag/feature-flag.entity';
+import { eventStandardFieldIds } from 'src/engine/workspace-manager/workspace-sync-metadata/constants/standard-field-ids';
+import { standardObjectIds } 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 { Gate } from 'src/engine/workspace-manager/workspace-sync-metadata/decorators/gate.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 { 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 { WorkspaceMemberObjectMetadata } from 'src/modules/workspace-member/standard-objects/workspace-member.object-metadata';
+
+@ObjectMetadata({
+  standardId: standardObjectIds.event,
+  namePlural: 'events',
+  labelSingular: 'Event',
+  labelPlural: 'Events',
+  description: 'An event',
+  icon: 'IconJson',
+})
+@IsSystem()
+@Gate({
+  featureFlag: FeatureFlagKeys.IsEventObjectEnabled,
+})
+export class EventObjectMetadata extends BaseObjectMetadata {
+  @FieldMetadata({
+    standardId: eventStandardFieldIds.properties,
+    type: FieldMetadataType.TEXT,
+    label: 'Event name',
+    description: 'Event name/type',
+    icon: 'IconAbc',
+  })
+  name: string;
+
+  @FieldMetadata({
+    standardId: eventStandardFieldIds.properties,
+    type: FieldMetadataType.JSON,
+    label: 'Event details',
+    description: 'Json value for event details',
+    icon: 'IconListDetails',
+  })
+  @IsNullable()
+  properties: JSON;
+
+  @FieldMetadata({
+    standardId: eventStandardFieldIds.workspaceMember,
+    type: FieldMetadataType.RELATION,
+    label: 'Workspace Member',
+    description: 'Event workspace member',
+    icon: 'IconCircleUser',
+    joinColumn: 'workspaceMemberId',
+  })
+  @IsNullable()
+  workspaceMember: WorkspaceMemberObjectMetadata;
+
+  @FieldMetadata({
+    standardId: eventStandardFieldIds.person,
+    type: FieldMetadataType.RELATION,
+    label: 'Person',
+    description: 'Event person',
+    icon: 'IconUser',
+    joinColumn: 'personId',
+  })
+  @IsNullable()
+  person: PersonObjectMetadata;
+
+  @FieldMetadata({
+    standardId: eventStandardFieldIds.company,
+    type: FieldMetadataType.RELATION,
+    label: 'Company',
+    description: 'Event company',
+    icon: 'IconBuildingSkyscraper',
+    joinColumn: 'companyId',
+  })
+  @IsNullable()
+  company: CompanyObjectMetadata;
+
+  @FieldMetadata({
+    standardId: eventStandardFieldIds.opportunity,
+    type: FieldMetadataType.RELATION,
+    label: 'Opportunity',
+    description: 'Events opportunity',
+    icon: 'IconTargetArrow',
+    joinColumn: 'opportunityId',
+  })
+  @IsNullable()
+  opportunity: OpportunityObjectMetadata;
+
+  @DynamicRelationFieldMetadata((oppositeObjectMetadata) => ({
+    standardId: eventStandardFieldIds.custom,
+    name: oppositeObjectMetadata.nameSingular,
+    label: oppositeObjectMetadata.labelSingular,
+    description: `Favorite ${oppositeObjectMetadata.labelSingular}`,
+    joinColumn: `${oppositeObjectMetadata.nameSingular}Id`,
+    icon: 'IconBuildingSkyscraper',
+  }))
+  custom: CustomObjectMetadata;
+}