Select full record in variable dropdown (#8851)

Output schema is now separated in two sections:
- object, that gather all informations on the selectable object
- fields, that display object fields in a record context, or simply the
available fields from the previous steps

The dropdown variable has now a new mode:
- if objectNameSingularToSelect is defined, it goes into an object mode.
Only objects of the right type will be shown
- if not set, it will use the already existing mode, to select a field

When an object is selected, it actually set the id of the object



https://github.com/user-attachments/assets/1c95f8fd-10f0-4c1c-aeb7-c7d847e89536

packages/twenty-server/src/modules/workflow/common/workspace-services/workflow-version-step.workspace-service.ts

@@ -6,25 +6,25 @@ import { join } from 'path';
 import { Repository } from 'typeorm';
 import { v4 } from 'uuid';
 
-import { TwentyORMManager } from 'src/engine/twenty-orm/twenty-orm.manager';
-import { WorkflowVersionWorkspaceEntity } from 'src/modules/workflow/common/standard-objects/workflow-version.workspace-entity';
-import {
-  WorkflowAction,
-  WorkflowActionType,
-} from 'src/modules/workflow/workflow-executor/workflow-actions/types/workflow-action.type';
-import { isDefined } from 'src/utils/is-defined';
-import { ObjectMetadataEntity } from 'src/engine/metadata-modules/object-metadata/object-metadata.entity';
-import { WorkflowBuilderWorkspaceService } from 'src/modules/workflow/workflow-builder/workflow-builder.workspace-service';
-import { ServerlessFunctionService } from 'src/engine/metadata-modules/serverless-function/serverless-function.service';
-import { WorkflowRecordCRUDType } from 'src/modules/workflow/workflow-executor/workflow-actions/record-crud/types/workflow-record-crud-action-input.type';
-import { WorkflowActionDTO } from 'src/engine/core-modules/workflow/dtos/workflow-step.dto';
 import { INDEX_FILE_NAME } from 'src/engine/core-modules/serverless/drivers/constants/index-file-name';
+import { WorkflowActionDTO } from 'src/engine/core-modules/workflow/dtos/workflow-step.dto';
+import { ObjectMetadataEntity } from 'src/engine/metadata-modules/object-metadata/object-metadata.entity';
+import { ServerlessFunctionService } from 'src/engine/metadata-modules/serverless-function/serverless-function.service';
+import { TwentyORMManager } from 'src/engine/twenty-orm/twenty-orm.manager';
 import { CodeIntrospectionService } from 'src/modules/code-introspection/code-introspection.service';
 import {
   WorkflowVersionStepException,
   WorkflowVersionStepExceptionCode,
 } from 'src/modules/workflow/common/exceptions/workflow-version-step.exception';
+import { WorkflowVersionWorkspaceEntity } from 'src/modules/workflow/common/standard-objects/workflow-version.workspace-entity';
+import { WorkflowBuilderWorkspaceService } from 'src/modules/workflow/workflow-builder/workflow-builder.workspace-service';
+import { WorkflowRecordCRUDType } from 'src/modules/workflow/workflow-executor/workflow-actions/record-crud/types/workflow-record-crud-action-input.type';
 import { BaseWorkflowActionSettings } from 'src/modules/workflow/workflow-executor/workflow-actions/types/workflow-action-settings.type';
+import {
+  WorkflowAction,
+  WorkflowActionType,
+} from 'src/modules/workflow/workflow-executor/workflow-actions/types/workflow-action.type';
+import { isDefined } from 'src/utils/is-defined';
 
 const TRIGGER_STEP_ID = 'trigger';
 

packages/twenty-server/src/modules/workflow/workflow-builder/types/output-schema.type.ts

@@ -1,16 +1,26 @@
 import { InputSchemaPropertyType } from 'src/modules/code-introspection/types/input-schema.type';
 
-type Leaf = {
+export type Leaf = {
   isLeaf: true;
   icon?: string;
   type?: InputSchemaPropertyType;
+  label?: string;
   value: any;
 };
 
-type Node = {
+export type Node = {
   isLeaf: false;
   icon?: string;
+  label?: string;
   value: OutputSchema;
 };
 
-export type OutputSchema = Record<string, Leaf | Node>;
+export type BaseOutputSchema = Record<string, Leaf | Node>;
+
+export type RecordOutputSchema = {
+  object: { nameSingular: string; fieldIdName: string } & Leaf;
+  fields: BaseOutputSchema;
+  _outputSchemaType: 'RECORD';
+};
+
+export type OutputSchema = BaseOutputSchema | RecordOutputSchema;

packages/twenty-server/src/modules/workflow/workflow-builder/utils/generate-fake-object-record-event.ts

@@ -2,13 +2,13 @@ import { v4 } from 'uuid';
 
 import { DatabaseEventAction } from 'src/engine/api/graphql/graphql-query-runner/enums/database-event-action';
 import { ObjectMetadataEntity } from 'src/engine/metadata-modules/object-metadata/object-metadata.entity';
+import { BaseOutputSchema } from 'src/modules/workflow/workflow-builder/types/output-schema.type';
 import { generateFakeObjectRecord } from 'src/modules/workflow/workflow-builder/utils/generate-fake-object-record';
-import { OutputSchema } from 'src/modules/workflow/workflow-builder/types/output-schema.type';
 
 export const generateFakeObjectRecordEvent = (
   objectMetadataEntity: ObjectMetadataEntity,
   action: DatabaseEventAction,
-): OutputSchema => {
+): BaseOutputSchema => {
   const recordId = v4();
   const userId = v4();
   const workspaceMemberId = v4();
@@ -16,23 +16,30 @@ export const generateFakeObjectRecordEvent = (
   const after = generateFakeObjectRecord(objectMetadataEntity);
   const formattedObjectMetadataEntity = Object.entries(
     objectMetadataEntity,
-  ).reduce((acc: OutputSchema, [key, value]) => {
+  ).reduce((acc: BaseOutputSchema, [key, value]) => {
     acc[key] = { isLeaf: true, value };
 
     return acc;
   }, {});
 
-  const baseResult: OutputSchema = {
-    recordId: { isLeaf: true, type: 'string', value: recordId },
-    userId: { isLeaf: true, type: 'string', value: userId },
+  const baseResult: BaseOutputSchema = {
+    recordId: {
+      isLeaf: true,
+      type: 'string',
+      value: recordId,
+      label: 'Record ID',
+    },
+    userId: { isLeaf: true, type: 'string', value: userId, label: 'User ID' },
     workspaceMemberId: {
       isLeaf: true,
       type: 'string',
       value: workspaceMemberId,
+      label: 'Workspace Member ID',
     },
     objectMetadata: {
       isLeaf: false,
       value: formattedObjectMetadataEntity,
+      label: 'Object Metadata',
     },
   };
 
@@ -41,7 +48,8 @@ export const generateFakeObjectRecordEvent = (
       ...baseResult,
       properties: {
         isLeaf: false,
-        value: { after: { isLeaf: false, value: after } },
+        value: { after: { isLeaf: false, value: after, label: 'After' } },
+        label: 'Properties',
       },
     };
   }
@@ -54,9 +62,10 @@ export const generateFakeObjectRecordEvent = (
       properties: {
         isLeaf: false,
         value: {
-          before: { isLeaf: false, value: before },
-          after: { isLeaf: false, value: after },
+          before: { isLeaf: false, value: before, label: 'Before' },
+          after: { isLeaf: false, value: after, label: 'After' },
         },
+        label: 'Properties',
       },
     };
   }
@@ -67,8 +76,9 @@ export const generateFakeObjectRecordEvent = (
       properties: {
         isLeaf: false,
         value: {
-          before: { isLeaf: false, value: before },
+          before: { isLeaf: false, value: before, label: 'Before' },
         },
+        label: 'Properties',
       },
     };
   }
@@ -79,8 +89,9 @@ export const generateFakeObjectRecordEvent = (
       properties: {
         isLeaf: false,
         value: {
-          before: { isLeaf: false, value: before },
+          before: { isLeaf: false, value: before, label: 'Before' },
         },
+        label: 'Properties',
       },
     };
   }

packages/twenty-server/src/modules/workflow/workflow-builder/utils/generate-fake-object-record.ts

@@ -1,40 +1,66 @@
+import { compositeTypeDefinitions } from 'src/engine/metadata-modules/field-metadata/composite-types';
 import { ObjectMetadataEntity } from 'src/engine/metadata-modules/object-metadata/object-metadata.entity';
 import { generateFakeValue } from 'src/engine/utils/generate-fake-value';
+import {
+  Leaf,
+  Node,
+  RecordOutputSchema,
+} from 'src/modules/workflow/workflow-builder/types/output-schema.type';
 import { shouldGenerateFieldFakeValue } from 'src/modules/workflow/workflow-builder/utils/should-generate-field-fake-value';
-import { OutputSchema } from 'src/modules/workflow/workflow-builder/types/output-schema.type';
-import { compositeTypeDefinitions } from 'src/engine/metadata-modules/field-metadata/composite-types';
+import { camelToTitleCase } from 'src/utils/camel-to-title-case';
+
+const generateObjectRecordFields = (
+  objectMetadataEntity: ObjectMetadataEntity,
+) =>
+  objectMetadataEntity.fields.reduce(
+    (acc: Record<string, Leaf | Node>, field) => {
+      if (!shouldGenerateFieldFakeValue(field)) {
+        return acc;
+      }
+      const compositeType = compositeTypeDefinitions.get(field.type);
+
+      if (!compositeType) {
+        acc[field.name] = {
+          isLeaf: true,
+          type: field.type,
+          icon: field.icon,
+          label: field.label,
+          value: generateFakeValue(field.type),
+        };
+      } else {
+        acc[field.name] = {
+          isLeaf: false,
+          icon: field.icon,
+          label: field.label,
+          value: compositeType.properties.reduce((acc, property) => {
+            acc[property.name] = {
+              isLeaf: true,
+              type: property.type,
+              label: camelToTitleCase(property.name),
+              value: generateFakeValue(property.type),
+            };
+
+            return acc;
+          }, {}),
+        };
+      }
+
+      return acc;
+    },
+    {},
+  );
 
 export const generateFakeObjectRecord = (
   objectMetadataEntity: ObjectMetadataEntity,
-): OutputSchema =>
-  objectMetadataEntity.fields.reduce((acc: OutputSchema, field) => {
-    if (!shouldGenerateFieldFakeValue(field)) {
-      return acc;
-    }
-    const compositeType = compositeTypeDefinitions.get(field.type);
-
-    if (!compositeType) {
-      acc[field.name] = {
-        isLeaf: true,
-        type: field.type,
-        icon: field.icon,
-        value: generateFakeValue(field.type),
-      };
-    } else {
-      acc[field.name] = {
-        isLeaf: false,
-        icon: field.icon,
-        value: compositeType.properties.reduce((acc, property) => {
-          acc[property.name] = {
-            isLeaf: true,
-            type: property.type,
-            value: generateFakeValue(property.type),
-          };
-
-          return acc;
-        }, {}),
-      };
-    }
-
-    return acc;
-  }, {});
+): RecordOutputSchema => ({
+  object: {
+    isLeaf: true,
+    icon: objectMetadataEntity.icon,
+    label: objectMetadataEntity.labelSingular,
+    value: objectMetadataEntity.description,
+    nameSingular: objectMetadataEntity.nameSingular,
+    fieldIdName: 'id',
+  },
+  fields: generateObjectRecordFields(objectMetadataEntity),
+  _outputSchemaType: 'RECORD',
+});

packages/twenty-server/src/modules/workflow/workflow-builder/utils/should-generate-field-fake-value.ts

@@ -5,7 +5,7 @@ import {
 
 export const shouldGenerateFieldFakeValue = (field: FieldMetadataEntity) => {
   return (
-    !field.isSystem &&
+    (!field.isSystem || field.name === 'id') &&
     field.isActive &&
     field.type !== FieldMetadataType.RELATION
   );

packages/twenty-server/src/modules/workflow/workflow-builder/workflow-builder.workspace-service.ts

@@ -12,6 +12,12 @@ import { ObjectMetadataEntity } from 'src/engine/metadata-modules/object-metadat
 import { ServerlessFunctionService } from 'src/engine/metadata-modules/serverless-function/serverless-function.service';
 import { generateFakeValue } from 'src/engine/utils/generate-fake-value';
 import { CodeIntrospectionService } from 'src/modules/code-introspection/code-introspection.service';
+import { InputSchemaPropertyType } from 'src/modules/code-introspection/types/input-schema.type';
+import {
+  Leaf,
+  Node,
+  OutputSchema,
+} from 'src/modules/workflow/workflow-builder/types/output-schema.type';
 import { generateFakeObjectRecord } from 'src/modules/workflow/workflow-builder/utils/generate-fake-object-record';
 import { generateFakeObjectRecordEvent } from 'src/modules/workflow/workflow-builder/utils/generate-fake-object-record-event';
 import { WorkflowRecordCRUDType } from 'src/modules/workflow/workflow-executor/workflow-actions/record-crud/types/workflow-record-crud-action-input.type';
@@ -24,8 +30,6 @@ import {
   WorkflowTriggerType,
 } from 'src/modules/workflow/workflow-trigger/types/workflow-trigger.type';
 import { isDefined } from 'src/utils/is-defined';
-import { OutputSchema } from 'src/modules/workflow/workflow-builder/types/output-schema.type';
-import { InputSchemaPropertyType } from 'src/modules/code-introspection/types/input-schema.type';
 
 @Injectable()
 export class WorkflowBuilderWorkspaceService {
@@ -145,7 +149,11 @@ export class WorkflowBuilderWorkspaceService {
 
     if (operationType === WorkflowRecordCRUDType.READ) {
       return {
-        first: { isLeaf: false, icon: 'IconAlpha', value: recordOutputSchema },
+        first: {
+          isLeaf: false,
+          icon: 'IconAlpha',
+          value: recordOutputSchema,
+        },
         last: { isLeaf: false, icon: 'IconOmega', value: recordOutputSchema },
         totalCount: {
           isLeaf: true,
@@ -231,7 +239,7 @@ export class WorkflowBuilderWorkspaceService {
 
     return resultFromFakeInput.data
       ? Object.entries(resultFromFakeInput.data).reduce(
-          (acc: OutputSchema, [key, value]) => {
+          (acc: Record<string, Leaf | Node>, [key, value]) => {
             acc[key] = {
               isLeaf: true,
               value,