fix: multiple twenty orm issues & show an example of use (#5439)

This PR is fixing some issues and adding enhancement in TwentyORM: - [x] Composite fields in nested relations are not formatted properly - [x] Passing operators like `Any` in `where` condition is breaking the query - [x] Ability to auto load workspace-entities based on a regex path I've also introduced an example of use for `CalendarEventService`: https://github.com/twentyhq/twenty/pull/5439/files#diff-3a7dffc0dea57345d10e70c648e911f98fe237248bcea124dafa9c8deb1db748R15
2024-05-20 11:01:47 +02:00
parent 81e8f49033
commit 8b5f79ddbf
147 changed files with 1108 additions and 1101 deletions
@@ -0,0 +1,90 @@
+import { FeatureFlagKeys } from 'src/engine/core-modules/feature-flag/feature-flag.entity';
+import { FieldMetadataType } from 'src/engine/metadata-modules/field-metadata/field-metadata.entity';
+import { BaseWorkspaceEntity } from 'src/engine/twenty-orm/base.workspace-entity';
+import { WorkspaceField } from 'src/engine/twenty-orm/decorators/workspace-field.decorator';
+import { WorkspaceGate } from 'src/engine/twenty-orm/decorators/workspace-gate.decorator';
+import { WorkspaceIsNullable } from 'src/engine/twenty-orm/decorators/workspace-is-nullable.decorator';
+import { WorkspaceIsSystem } from 'src/engine/twenty-orm/decorators/workspace-is-system.decorator';
+import { WorkspaceEntity } from 'src/engine/twenty-orm/decorators/workspace-entity.decorator';
+import { BEHAVIORAL_EVENT_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';
+
+@WorkspaceEntity({
+  standardId: STANDARD_OBJECT_IDS.behavioralEvent,
+  namePlural: 'behavioralEvents',
+  labelSingular: 'Behavioral Event',
+  labelPlural: 'Behavioral Events',
+  description: 'An event related to user behavior',
+  icon: 'IconIconTimelineEvent',
+})
+@WorkspaceIsSystem()
+@WorkspaceGate({
+  featureFlag: FeatureFlagKeys.IsEventObjectEnabled,
+})
+export class BehavioralEventWorkspaceEntity extends BaseWorkspaceEntity {
+  /** 
+   * 
+   * Common in Segment, Rudderstack, etc.
+   * = Track, Screen, Page...
+   * But doesn't feel that useful. 
+   * Let's try living without it.
+   * 
+  @WorkspaceField({
+    standardId: behavioralEventStandardFieldIds.type,
+    type: FieldMetadataType.TEXT,
+    label: 'Event type',
+    description: 'Event type',
+    icon: 'IconAbc',
+  })
+  type: string;
+  */
+
+  @WorkspaceField({
+    standardId: BEHAVIORAL_EVENT_STANDARD_FIELD_IDS.name,
+    type: FieldMetadataType.TEXT,
+    label: 'Event name',
+    description: 'Event name',
+    icon: 'IconAbc',
+  })
+  name: string;
+
+  @WorkspaceField({
+    standardId: BEHAVIORAL_EVENT_STANDARD_FIELD_IDS.properties,
+    type: FieldMetadataType.RAW_JSON,
+    label: 'Event details',
+    description: 'Json value for event details',
+    icon: 'IconListDetails',
+  })
+  @WorkspaceIsNullable()
+  properties: JSON;
+
+  @WorkspaceField({
+    standardId: BEHAVIORAL_EVENT_STANDARD_FIELD_IDS.context,
+    type: FieldMetadataType.RAW_JSON,
+    label: 'Event context',
+    description:
+      'Json object to provide context (user, device, workspace, etc.)',
+    icon: 'IconListDetails',
+  })
+  @WorkspaceIsNullable()
+  context: JSON;
+
+  @WorkspaceField({
+    standardId: BEHAVIORAL_EVENT_STANDARD_FIELD_IDS.objectName,
+    type: FieldMetadataType.TEXT,
+    label: 'Object name',
+    description: 'If the event is related to a particular object',
+    icon: 'IconAbc',
+  })
+  objectName: string;
+
+  @WorkspaceField({
+    standardId: BEHAVIORAL_EVENT_STANDARD_FIELD_IDS.recordId,
+    type: FieldMetadataType.UUID,
+    label: 'Object id',
+    description: 'Event name/type',
+    icon: 'IconAbc',
+  })
+  @WorkspaceIsNullable()
+  recordId: string;
+}