Add default relation to standard object on custom object in manifest

packages/twenty-sdk/src/cli/utilities/build/manifest/manifest-build.ts

@@ -5,7 +5,6 @@ import {
   TARGET_FUNCTION_TO_ENTITY_KEY_MAPPING,
 } from '@/cli/utilities/build/manifest/manifest-extract-config';
 import { extractManifestFromFile } from '@/cli/utilities/build/manifest/manifest-extract-config-from-file';
-import { injectDefaultFieldsInObjectFields } from '@/cli/utilities/build/manifest/utils/inject-default-fields-in-object-fields';
 import {
   type ApplicationConfig,
   type FrontComponentConfig,
@@ -33,6 +32,7 @@ import {
 } from 'twenty-shared/application';
 import { getInputSchemaFromSourceCode } from 'twenty-shared/logic-function';
 import { assertUnreachable } from 'twenty-shared/utils';
+import { getDefaultFieldsInObjectFields } from '@/cli/utilities/build/manifest/utils/get-default-fields-in-object-fields';
 
 const loadSources = async (appPath: string): Promise<string[]> => {
   return await glob(['**/*.ts', '**/*.tsx'], {
@@ -117,13 +117,14 @@ export const buildManifest = async (
           filePath,
         });
 
-        const objectFieldsWithDefaultFields = injectDefaultFieldsInObjectFields(
-          extract.config,
-        );
+        const {
+          objectFields: objectFieldsWithDefaults,
+          fields: reverseRelationFields,
+        } = getDefaultFieldsInObjectFields(extract.config);
 
         const labelIdentifierFieldMetadataUniversalIdentifier =
           extract.config.labelIdentifierFieldMetadataUniversalIdentifier ??
-          objectFieldsWithDefaultFields.find((field) => field.name === 'name')
+          objectFieldsWithDefaults.find((field) => field.name === 'name')
             ?.universalIdentifier;
 
         if (!labelIdentifierFieldMetadataUniversalIdentifier) {
@@ -135,11 +136,12 @@ export const buildManifest = async (
 
         const objectManifest: ObjectManifest = {
           ...extract.config,
-          fields: objectFieldsWithDefaultFields,
+          fields: objectFieldsWithDefaults,
           labelIdentifierFieldMetadataUniversalIdentifier,
         };
 
         objects.push(objectManifest);
+        fields.push(...reverseRelationFields);
 
         errors.push(...extract.errors);
         objectsFilePaths.push(relativePath);

packages/twenty-sdk/src/cli/utilities/build/manifest/utils/__tests__/inject-default-fields-in-object-fields.spec.ts → packages/twenty-sdk/src/cli/utilities/build/manifest/utils/__tests__/get-default-fields-in-object-fields.spec.ts

@@ -1,7 +1,9 @@
 import { FieldMetadataType } from 'twenty-shared/types';
-import { injectDefaultFieldsInObjectFields } from '@/cli/utilities/build/manifest/utils/inject-default-fields-in-object-fields';
+import { getDefaultFieldsInObjectFields } from '@/cli/utilities/build/manifest/utils/get-default-fields-in-object-fields';
 import { getDefaultObjectFields } from '@/cli/utilities/build/manifest/utils/get-default-object-fields';
 import type { ObjectConfig } from '@/sdk/objects/object-config';
+import { getDefaultRelationObjectFields } from '@/cli/utilities/build/manifest/utils/get-default-relation-object-fields';
+import { type ObjectFieldManifest } from 'twenty-shared/application';
 
 const baseObjectConfig: ObjectConfig = {
   universalIdentifier: 'a1b2c3d4-e5f6-7890-abcd-ef1234567890',
@@ -12,16 +14,25 @@
   fields: [],
 };
 
-describe('injectDefaultFieldsInObjectFields', () => {
+describe('getDefaultFieldsInObjectFields', () => {
   it('should return all default fields when objectConfig has no fields', () => {
-    const result = injectDefaultFieldsInObjectFields(baseObjectConfig);
+    const { objectFields, fields } =
+      getDefaultFieldsInObjectFields(baseObjectConfig);
     const defaultFields = getDefaultObjectFields(baseObjectConfig);
-
-    expect(result).toEqual(defaultFields);
+    const {
+      objectFields: defaultRelationObjectFields,
+      fields: expectedReverseFields,
+    } = getDefaultRelationObjectFields(baseObjectConfig);
+
+    expect(objectFields).toEqual([
+      ...defaultFields,
+      ...defaultRelationObjectFields,
+    ]);
+    expect(fields).toEqual(expectedReverseFields);
   });
 
   it('should preserve custom fields and append missing default fields', () => {
-    const customField = {
+    const customField: ObjectFieldManifest = {
       universalIdentifier: '11111111-1111-1111-1111-111111111111',
       name: 'customField',
       label: 'Custom Field',
@@ -33,15 +44,19 @@
       fields: [customField],
     };
 
-    const result = injectDefaultFieldsInObjectFields(objectConfig);
+    const { objectFields } = getDefaultFieldsInObjectFields(objectConfig);
     const defaultFields = getDefaultObjectFields(objectConfig);
+    const { objectFields: defaultRelationObjectFields } =
+      getDefaultRelationObjectFields(objectConfig);
 
-    expect(result[0]).toEqual(customField);
-    expect(result).toHaveLength(1 + defaultFields.length);
+    expect(objectFields[0]).toEqual(customField);
+    expect(objectFields).toHaveLength(
+      1 + defaultFields.length + defaultRelationObjectFields.length,
+    );
   });
 
   it('should not inject a default field when a field with the same name exists', () => {
-    const customIdField = {
+    const customIdField: ObjectFieldManifest = {
       universalIdentifier: '22222222-2222-2222-2222-222222222222',
       name: 'id',
       label: 'Custom Id',
@@ -53,16 +68,16 @@
       fields: [customIdField],
     };
 
-    const result = injectDefaultFieldsInObjectFields(objectConfig);
+    const { objectFields } = getDefaultFieldsInObjectFields(objectConfig);
 
-    const idFields = result.filter((f) => f.name === 'id');
+    const idFields = objectFields.filter((f) => f.name === 'id');
 
     expect(idFields).toHaveLength(1);
     expect(idFields[0]).toEqual(customIdField);
   });
 
   it('should skip multiple default fields when overridden by custom fields', () => {
-    const customFields = [
+    const customFields: ObjectFieldManifest[] = [
       {
         universalIdentifier: '33333333-3333-3333-3333-333333333333',
         name: 'id',
@@ -88,23 +103,28 @@
       fields: customFields,
     };
 
-    const result = injectDefaultFieldsInObjectFields(objectConfig);
+    const { objectFields } = getDefaultFieldsInObjectFields(objectConfig);
     const defaultFields = getDefaultObjectFields(objectConfig);
+    const { objectFields: defaultRelationObjectFields } =
+      getDefaultRelationObjectFields(objectConfig);
     const overriddenCount = defaultFields.filter((df) =>
       customFields.some((cf) => cf.name === df.name),
     ).length;
 
-    expect(result).toHaveLength(
-      customFields.length + defaultFields.length - overriddenCount,
+    expect(objectFields).toHaveLength(
+      customFields.length +
+        defaultFields.length +
+        defaultRelationObjectFields.length -
+        overriddenCount,
     );
 
-    expect(result.filter((f) => f.name === 'id')).toHaveLength(1);
-    expect(result.filter((f) => f.name === 'name')).toHaveLength(1);
-    expect(result.filter((f) => f.name === 'position')).toHaveLength(1);
+    expect(objectFields.filter((f) => f.name === 'id')).toHaveLength(1);
+    expect(objectFields.filter((f) => f.name === 'name')).toHaveLength(1);
+    expect(objectFields.filter((f) => f.name === 'position')).toHaveLength(1);
   });
 
   it('should place custom fields before default fields in the result', () => {
-    const customField = {
+    const customField: ObjectFieldManifest = {
       universalIdentifier: '66666666-6666-6666-6666-666666666666',
       name: 'customField',
       label: 'Custom Field',
@@ -116,13 +136,13 @@
       fields: [customField],
     };
 
-    const result = injectDefaultFieldsInObjectFields(objectConfig);
+    const { objectFields } = getDefaultFieldsInObjectFields(objectConfig);
 
-    expect(result[0]).toEqual(customField);
+    expect(objectFields[0]).toEqual(customField);
   });
 
   it('should not mutate the original objectConfig fields array', () => {
-    const customField = {
+    const customField: ObjectFieldManifest = {
       universalIdentifier: '77777777-7777-7777-7777-777777777777',
       name: 'customField',
       label: 'Custom Field',
@@ -136,8 +156,19 @@
 
     const originalLength = objectConfig.fields.length;
 
-    injectDefaultFieldsInObjectFields(objectConfig);
+    getDefaultFieldsInObjectFields(objectConfig);
 
     expect(objectConfig.fields).toHaveLength(originalLength);
   });
+
+  it('should return reverse relation fields for each default relation', () => {
+    const { fields } = getDefaultFieldsInObjectFields(baseObjectConfig);
+
+    expect(fields).toHaveLength(5);
+
+    const fieldNames = fields.map((f) => f.name);
+
+    expect(fieldNames).toContain('targetTestObject');
+    expect(fieldNames).toContain('testObject');
+  });
 });

packages/twenty-sdk/src/cli/utilities/build/manifest/utils/__tests__/get-default-object-fields.spec.ts

@@ -22,7 +22,7 @@ describe('getDefaultObjectFields', () => {
   it('should return an array of 9 default fields', () => {
     const fields = getDefaultObjectFields(mockObjectConfig);
 
-    expect(fields).toHaveLength(7);
+    expect(fields).toHaveLength(9);
   });
 
   it('should include an id field with UUID type', () => {
@@ -59,15 +59,26 @@ describe('getDefaultObjectFields', () => {
     });
   });
 
-  it('should include updatedAt and deletedAt fields with DATE_TIME type', () => {
+  it('should include createdAt, updatedAt and deletedAt fields with DATE_TIME type', () => {
     const fields = getDefaultObjectFields(mockObjectConfig);
-    const updatedAtFields = fields.filter(
-      (field) => field.name === 'updatedAt',
-    );
+    const createdAtField = fields.find((field) => field.name === 'createdAt');
+    const updatedAtField = fields.find((field) => field.name === 'updatedAt');
     const deletedAtField = fields.find((field) => field.name === 'deletedAt');
 
-    expect(updatedAtFields).toHaveLength(1);
-    expect(updatedAtFields[0]).toEqual({
+    expect(createdAtField).toBeDefined();
+    expect(createdAtField).toEqual({
+      name: 'createdAt',
+      label: 'Creation date',
+      description: 'Creation date',
+      icon: 'IconCalendar',
+      isNullable: false,
+      defaultValue: 'now',
+      type: FieldMetadataType.DATE_TIME,
+      universalIdentifier: expectedUniversalId('createdAt'),
+    });
+
+    expect(updatedAtField).toBeDefined();
+    expect(updatedAtField).toEqual({
       name: 'updatedAt',
       label: 'Last update',
       description: 'Last time the record was changed',
@@ -121,6 +132,42 @@ describe('getDefaultObjectFields', () => {
     });
   });
 
+  it('should include a position field with POSITION type', () => {
+    const fields = getDefaultObjectFields(mockObjectConfig);
+    const positionField = fields.find((field) => field.name === 'position');
+
+    expect(positionField).toBeDefined();
+    expect(positionField).toEqual({
+      name: 'position',
+      label: 'Position',
+      description: 'Position',
+      icon: 'IconHierarchy2',
+      isNullable: false,
+      defaultValue: 0,
+      type: FieldMetadataType.POSITION,
+      universalIdentifier: expectedUniversalId('position'),
+    });
+  });
+
+  it('should include a searchVector field with TS_VECTOR type', () => {
+    const fields = getDefaultObjectFields(mockObjectConfig);
+    const searchVectorField = fields.find(
+      (field) => field.name === 'searchVector',
+    );
+
+    expect(searchVectorField).toBeDefined();
+    expect(searchVectorField).toEqual({
+      name: 'searchVector',
+      label: 'Search vector',
+      description: 'Search vector',
+      icon: 'IconSearch',
+      isNullable: true,
+      defaultValue: null,
+      type: FieldMetadataType.TS_VECTOR,
+      universalIdentifier: expectedUniversalId('searchVector'),
+    });
+  });
+
   it('should generate deterministic universalIdentifiers based on objectConfig', () => {
     const firstResult = getDefaultObjectFields(mockObjectConfig);
     const secondResult = getDefaultObjectFields(mockObjectConfig);
@@ -160,6 +207,8 @@ describe('getDefaultObjectFields', () => {
       'deletedAt',
       'createdBy',
       'updatedBy',
+      'position',
+      'searchVector',
     ]);
   });
 });

packages/twenty-sdk/src/cli/utilities/build/manifest/utils/get-default-fields-in-object-fields.ts

@@ -0,0 +1,33 @@
+import type { ObjectConfig } from '@/sdk/objects/object-config';
+import { getDefaultObjectFields } from '@/cli/utilities/build/manifest/utils/get-default-object-fields';
+import { getDefaultRelationObjectFields } from '@/cli/utilities/build/manifest/utils/get-default-relation-object-fields';
+import {
+  type FieldManifest,
+  type ObjectFieldManifest,
+} from 'twenty-shared/application';
+
+export const getDefaultFieldsInObjectFields = (
+  objectConfig: ObjectConfig,
+): { objectFields: ObjectFieldManifest[]; fields: FieldManifest[] } => {
+  const defaultObjectFields = getDefaultObjectFields(objectConfig);
+  const { objectFields: defaultRelationObjectFields, fields: reverseFields } =
+    getDefaultRelationObjectFields(objectConfig);
+
+  const objectConfigFieldNames = (objectConfig.fields ?? []).map((f) => f.name);
+
+  const objectFieldsWithDefaults = [...objectConfig.fields];
+
+  for (const defaultField of defaultObjectFields) {
+    if (!objectConfigFieldNames.includes(defaultField.name)) {
+      objectFieldsWithDefaults.push(defaultField);
+    }
+  }
+
+  for (const defaultRelationField of defaultRelationObjectFields) {
+    if (!objectConfigFieldNames.includes(defaultRelationField.name)) {
+      objectFieldsWithDefaults.push(defaultRelationField);
+    }
+  }
+
+  return { objectFields: objectFieldsWithDefaults, fields: reverseFields };
+};