Introduce UniversalFlatEntityFrom (#17367)

# Introduction

Creating a `UniversalFlatEntityFrom` that strips out all the relation
and foreignKey properties in order to replace them with
`UniversalIdentifier` suffix

This data type will be major for the workspace migration workspace
agnostic refactor

## Chore
- renamed `flat-entity.type` to `flat-entity-from.type.ts` ( more
accurate to exported module )
- create static test type over the field metadata entity on quite
complex utils as both coverage and documentation

## Example
Here's an example of a `UniversalFlatEntityFrom<FieldMetadataEntity>`

```ts
const universalFlatFieldMetadata: UniversalFlatFieldMetadata<FieldMetadataType.RELATION> = {
  // Base properties (from FieldMetadataEntity, excluding relations and applicationId)
  universalIdentifier: '550e8400-e29b-41d4-a716-446655440001',
  applicationUniversalIdentifier: '5800681c-088e-4e2b-9fc3-bcf6e8ec2051',
  type: FieldMetadataType.RELATION,
  name: 'firstName',
  label: 'First Name',
  defaultValue: null,
  description: 'The first name of the person',
  icon: 'IconUser',
  standardOverrides: null,
  options: null,
  settings: {
    relationType: RelationType.ONE_TO_MANY,
  },
  isCustom: false,
  isActive: true,
  isSystem: false,
  isUIReadOnly: false,
  isNullable: true,
  isUnique: false,
  isLabelSyncedWithName: true,
  morphId: null,

  // Date properties cast to string
  createdAt: '2024-01-15T10:30:00.000Z',
  updatedAt: '2024-01-15T10:30:00.000Z',

  // ManyToOne relation universal identifiers (from FieldMetadataEntity relations)
  relationTargetFieldMetadataUniversalIdentifier:
    '550e8400-e29b-41d4-a716-446655440012',
  relationTargetObjectMetadataUniversalIdentifier:
    '550e8400-e29b-41d4-a716-446655440013',

  // Join column universal identifiers (foreignKey -> universalIdentifier)
  objectMetadataUniversalIdentifier: '550e8400-e29b-41d4-a716-446655440010',

  // OneToMany relation universal identifiers (array of related entity identifiers)
  viewFieldUniversalIdentifiers: [
    '550e8400-e29b-41d4-a716-446655440020',
    '550e8400-e29b-41d4-a716-446655440021',
  ],
  viewFilterUniversalIdentifiers: ['550e8400-e29b-41d4-a716-446655440030'],
  kanbanAggregateOperationViewUniversalIdentifiers: [],
  calendarViewUniversalIdentifiers: [],
  mainGroupByFieldMetadataViewUniversalIdentifiers: [],
};
```

## Settings
Will hop on the settings typing next. Might not be dynamic but
declarative though
This commit is contained in:
Paul Rastoin
2026-01-22 19:30:19 +01:00
committed by GitHub
parent fd43eeda41
commit 4c93ab5259
60 changed files with 408 additions and 52 deletions
@@ -1,4 +1,4 @@
import { type ApplicationVariableEntity } from 'src/engine/core-modules/applicationVariable/application-variable.entity';
import { type FlatEntityFrom } from 'src/engine/metadata-modules/flat-entity/types/flat-entity.type';
import { type FlatEntityFrom } from 'src/engine/metadata-modules/flat-entity/types/flat-entity-from.type';
export type FlatApplicationVariable = FlatEntityFrom<ApplicationVariableEntity>;
@@ -1,4 +1,4 @@
import { type FlatEntityFrom } from 'src/engine/metadata-modules/flat-entity/types/flat-entity.type';
import { type FlatEntityFrom } from 'src/engine/metadata-modules/flat-entity/types/flat-entity-from.type';
import { type WorkspaceMemberWorkspaceEntity } from 'src/modules/workspace-member/standard-objects/workspace-member.workspace-entity';
export type FlatWorkspaceMember =
@@ -1,4 +1,4 @@
import { type CronTriggerEntity } from 'src/engine/metadata-modules/cron-trigger/entities/cron-trigger.entity';
import { type FlatEntityFrom } from 'src/engine/metadata-modules/flat-entity/types/flat-entity.type';
import { type FlatEntityFrom } from 'src/engine/metadata-modules/flat-entity/types/flat-entity-from.type';
export type FlatCronTrigger = FlatEntityFrom<CronTriggerEntity>;
@@ -1,5 +1,5 @@
import { type DatabaseEventTriggerEntity } from 'src/engine/metadata-modules/database-event-trigger/entities/database-event-trigger.entity';
import { type FlatEntityFrom } from 'src/engine/metadata-modules/flat-entity/types/flat-entity.type';
import { type FlatEntityFrom } from 'src/engine/metadata-modules/flat-entity/types/flat-entity-from.type';
export type FlatDatabaseEventTrigger =
FlatEntityFrom<DatabaseEventTriggerEntity>;
@@ -32,6 +32,8 @@ import { ViewFilterEntity } from 'src/engine/metadata-modules/view-filter/entiti
import { ViewEntity } from 'src/engine/metadata-modules/view/entities/view.entity';
import { SyncableEntity } from 'src/engine/workspace-manager/types/syncable-entity.interface';
// This entity is used as a reference test case for type utilities in:
// Modifying relations or properties may require updating type test expectations for Typecheck to pass.
@Entity('fieldMetadata')
@Check(
'CHK_FIELD_METADATA_MORPH_RELATION_REQUIRES_MORPH_ID',
@@ -1,5 +1,5 @@
import { type AgentEntity } from 'src/engine/metadata-modules/ai/ai-agent/entities/agent.entity';
import { type FlatEntityFrom } from 'src/engine/metadata-modules/flat-entity/types/flat-entity.type';
import { type FlatEntityFrom } from 'src/engine/metadata-modules/flat-entity/types/flat-entity-from.type';
export type FlatAgent = FlatEntityFrom<AgentEntity>;
@@ -1,4 +1,4 @@
import { type CommandMenuItemEntity } from 'src/engine/metadata-modules/command-menu-item/entities/command-menu-item.entity';
import { type FlatEntityFrom } from 'src/engine/metadata-modules/flat-entity/types/flat-entity.type';
import { type FlatEntityFrom } from 'src/engine/metadata-modules/flat-entity/types/flat-entity-from.type';
export type FlatCommandMenuItem = FlatEntityFrom<CommandMenuItemEntity>;
@@ -1,5 +1,5 @@
import { type SyncableFlatEntity } from 'src/engine/metadata-modules/flat-entity/types/flat-entity-from.type';
import { type FlatEntityMaps } from 'src/engine/metadata-modules/flat-entity/types/flat-entity-maps.type';
import { type SyncableFlatEntity } from 'src/engine/metadata-modules/flat-entity/types/flat-entity.type';
export const createEmptyFlatEntityMaps = () =>
({
@@ -2,7 +2,7 @@ import { type AllMetadataName } from 'twenty-shared/metadata';
import { type Expect } from 'twenty-shared/testing';
import { type AllFlatEntityTypesByMetadataName } from 'src/engine/metadata-modules/flat-entity/types/all-flat-entity-types-by-metadata-name';
import { type SyncableFlatEntity } from 'src/engine/metadata-modules/flat-entity/types/flat-entity.type';
import { type SyncableFlatEntity } from 'src/engine/metadata-modules/flat-entity/types/flat-entity-from.type';
import { type WorkspaceMigrationActionType } from 'src/engine/metadata-modules/flat-entity/types/metadata-workspace-migration-action.type';
import { type WorkspaceMigrationAction } from 'src/engine/workspace-manager/workspace-migration/workspace-migration-builder/types/workspace-migration-action-common';
@@ -0,0 +1,21 @@
import { type Expect, type Equal } from 'twenty-shared/testing';
import { type FieldMetadataEntity } from 'src/engine/metadata-modules/field-metadata/field-metadata.entity';
import { type CastRecordTypeOrmDatePropertiesToString } from 'src/engine/metadata-modules/flat-entity/types/cast-record-typeorm-date-properties-to-string.type';
type FieldMetadataDateProperties =
CastRecordTypeOrmDatePropertiesToString<FieldMetadataEntity>;
// eslint-disable-next-line unused-imports/no-unused-vars
type Assertions = [
// FieldMetadataEntity has createdAt and updatedAt Date properties
Expect<
Equal<
FieldMetadataDateProperties,
{
createdAt: string;
updatedAt: string;
}
>
>,
];
@@ -0,0 +1,27 @@
import { type Expect, type Equal } from 'twenty-shared/testing';
import { type FieldMetadataEntity } from 'src/engine/metadata-modules/field-metadata/field-metadata.entity';
import { type ExtractEntityManyToOneEntityRelationProperties } from 'src/engine/metadata-modules/flat-entity/types/extract-entity-many-to-one-entity-relation-properties.type';
type FieldMetadataManyToOneRelations =
ExtractEntityManyToOneEntityRelationProperties<FieldMetadataEntity>;
// eslint-disable-next-line unused-imports/no-unused-vars
type Assertions = [
// FieldMetadataEntity ManyToOne relations:
// - object (ObjectMetadataEntity)
// - workspace (WorkspaceEntity)
// - application (ApplicationEntity)
// - relationTargetFieldMetadata (FieldMetadataEntity)
// - relationTargetObjectMetadata (ObjectMetadataEntity)
Expect<
Equal<
FieldMetadataManyToOneRelations,
| 'object'
| 'workspace'
| 'application'
| 'relationTargetFieldMetadata'
| 'relationTargetObjectMetadata'
>
>,
];
@@ -0,0 +1,45 @@
import { type Equal, type Expect } from 'twenty-shared/testing';
import { type FieldMetadataEntity } from 'src/engine/metadata-modules/field-metadata/field-metadata.entity';
import { type ExtractEntityOneToManyEntityRelationProperties } from 'src/engine/metadata-modules/flat-entity/types/extract-entity-one-to-many-entity-relation-properties.type';
import { type SyncableEntity } from 'src/engine/workspace-manager/types/syncable-entity.interface';
type FieldMetadataOneToManyRelations =
ExtractEntityOneToManyEntityRelationProperties<FieldMetadataEntity>;
type FieldMetadataOneToManySyncableRelations =
ExtractEntityOneToManyEntityRelationProperties<
FieldMetadataEntity,
SyncableEntity
>;
// eslint-disable-next-line unused-imports/no-unused-vars
type Assertions = [
// FieldMetadataEntity OneToMany relations (all targets):
// - indexFieldMetadatas, fieldPermissions, viewFields, viewFilters,
// - kanbanAggregateOperationViews, calendarViews, mainGroupByFieldMetadataViews
Expect<
Equal<
FieldMetadataOneToManyRelations,
| 'indexFieldMetadatas'
| 'fieldPermissions'
| 'viewFields'
| 'viewFilters'
| 'kanbanAggregateOperationViews'
| 'calendarViews'
| 'mainGroupByFieldMetadataViews'
>
>,
// When filtered by SyncableEntity target, only syncable relations are included
Expect<
Equal<
FieldMetadataOneToManySyncableRelations,
| 'viewFields'
| 'viewFilters'
| 'kanbanAggregateOperationViews'
| 'calendarViews'
| 'mainGroupByFieldMetadataViews'
>
>,
];
@@ -0,0 +1,31 @@
import { type Expect, type Equal } from 'twenty-shared/testing';
import { type FieldMetadataEntity } from 'src/engine/metadata-modules/field-metadata/field-metadata.entity';
import { type ExtractEntityRelatedEntityProperties } from 'src/engine/metadata-modules/flat-entity/types/extract-entity-related-entity-properties.type';
type FieldMetadataRelatedProperties =
ExtractEntityRelatedEntityProperties<FieldMetadataEntity>;
// eslint-disable-next-line unused-imports/no-unused-vars
type Assertions = [
// FieldMetadataEntity has both ManyToOne and OneToMany relations
// ManyToOne: object, workspace, application, relationTargetFieldMetadata, relationTargetObjectMetadata
// OneToMany: indexFieldMetadatas, fieldPermissions, viewFields, viewFilters, kanbanAggregateOperationViews, calendarViews, mainGroupByFieldMetadataViews
Expect<
Equal<
FieldMetadataRelatedProperties,
| 'object'
| 'workspace'
| 'application'
| 'relationTargetFieldMetadata'
| 'relationTargetObjectMetadata'
| 'indexFieldMetadatas'
| 'fieldPermissions'
| 'viewFields'
| 'viewFilters'
| 'kanbanAggregateOperationViews'
| 'calendarViews'
| 'mainGroupByFieldMetadataViews'
>
>,
];
@@ -0,0 +1,18 @@
import { type Equal, type Expect } from 'twenty-shared/testing';
import { type MetadataManyToOneJoinColumn } from 'src/engine/metadata-modules/flat-entity/types/metadata-many-to-one-join-column.type';
type FieldMetadataJoinColumns = MetadataManyToOneJoinColumn<'fieldMetadata'>;
// eslint-disable-next-line unused-imports/no-unused-vars
type Assertions = [
// fieldMetadata foreign keys from ALL_METADATA_RELATIONS
Expect<
Equal<
FieldMetadataJoinColumns,
| 'objectMetadataId'
| 'relationTargetFieldMetadataId'
| 'relationTargetObjectMetadataId'
>
>,
];
@@ -15,8 +15,6 @@ export type SyncableFlatEntity = NonNullableProperties<
export type FlatEntityFrom<TEntity> = Omit<
TEntity,
| ExtractEntityRelatedEntityProperties<TEntity>
| 'application'
| 'workspace'
| keyof CastRecordTypeOrmDatePropertiesToString<TEntity>
> &
CastRecordTypeOrmDatePropertiesToString<TEntity> & {
@@ -1,4 +1,4 @@
import { type SyncableFlatEntity } from 'src/engine/metadata-modules/flat-entity/types/flat-entity.type';
import { type SyncableFlatEntity } from 'src/engine/metadata-modules/flat-entity/types/flat-entity-from.type';
export type FlatEntityMaps<T extends SyncableFlatEntity> = {
byId: Partial<Record<string, T>>;
@@ -1,5 +1,8 @@
import { type AllMetadataName } from 'twenty-shared/metadata';
import { type Expect } from 'twenty-shared/testing';
import { type FieldMetadataType } from 'twenty-shared/types';
import { type FieldMetadataEntity } from 'src/engine/metadata-modules/field-metadata/field-metadata.entity';
import { type AllFlatEntityTypesByMetadataName } from 'src/engine/metadata-modules/flat-entity/types/all-flat-entity-types-by-metadata-name';
import { type SyncableEntity } from 'src/engine/workspace-manager/types/syncable-entity.interface';
@@ -10,3 +13,17 @@ export type FromMetadataEntityToMetadataName<T extends SyncableEntity> = {
? P
: never;
}[AllMetadataName];
// metadata name lookups works with the base entity type, not with narrowed variants.
// eslint-disable-next-line unused-imports/no-unused-vars
type Assertions = [
Expect<
[never] extends [
FromMetadataEntityToMetadataName<
FieldMetadataEntity<FieldMetadataType.RELATION>
>,
]
? true
: false
>,
];
@@ -4,8 +4,8 @@ import {
FlatEntityMapsException,
FlatEntityMapsExceptionCode,
} from 'src/engine/metadata-modules/flat-entity/exceptions/flat-entity-maps.exception';
import { type SyncableFlatEntity } from 'src/engine/metadata-modules/flat-entity/types/flat-entity-from.type';
import { type FlatEntityMaps } from 'src/engine/metadata-modules/flat-entity/types/flat-entity-maps.type';
import { type SyncableFlatEntity } from 'src/engine/metadata-modules/flat-entity/types/flat-entity.type';
type AddFlatEntityToFlatEntityMapsOrThrowArgs<T extends SyncableFlatEntity> = {
flatEntity: T;
@@ -5,8 +5,8 @@ import {
FlatEntityMapsException,
FlatEntityMapsExceptionCode,
} from 'src/engine/metadata-modules/flat-entity/exceptions/flat-entity-maps.exception';
import { type SyncableFlatEntity } from 'src/engine/metadata-modules/flat-entity/types/flat-entity-from.type';
import { type FlatEntityMaps } from 'src/engine/metadata-modules/flat-entity/types/flat-entity-maps.type';
import { type SyncableFlatEntity } from 'src/engine/metadata-modules/flat-entity/types/flat-entity.type';
export type DeleteFlatEntityFromFlatEntityMapsOrThrowArgs<
T extends SyncableFlatEntity,
@@ -1,7 +1,7 @@
import { isDefined } from 'twenty-shared/utils';
import { type SyncableFlatEntity } from 'src/engine/metadata-modules/flat-entity/types/flat-entity-from.type';
import { type FlatEntityMaps } from 'src/engine/metadata-modules/flat-entity/types/flat-entity-maps.type';
import { type SyncableFlatEntity } from 'src/engine/metadata-modules/flat-entity/types/flat-entity.type';
export const findFlatEntitiesByApplicationId = <T extends SyncableFlatEntity>({
applicationId,
@@ -5,8 +5,8 @@ import {
FlatEntityMapsException,
FlatEntityMapsExceptionCode,
} from 'src/engine/metadata-modules/flat-entity/exceptions/flat-entity-maps.exception';
import { type SyncableFlatEntity } from 'src/engine/metadata-modules/flat-entity/types/flat-entity-from.type';
import { type FlatEntityMaps } from 'src/engine/metadata-modules/flat-entity/types/flat-entity-maps.type';
import { type SyncableFlatEntity } from 'src/engine/metadata-modules/flat-entity/types/flat-entity.type';
export type FindFlatEntityByIdInFlatEntityMapsOrThrowArgs<
T extends SyncableFlatEntity,
@@ -1,4 +1,4 @@
import { type SyncableFlatEntity } from 'src/engine/metadata-modules/flat-entity/types/flat-entity.type';
import { type SyncableFlatEntity } from 'src/engine/metadata-modules/flat-entity/types/flat-entity-from.type';
import {
findFlatEntityByIdInFlatEntityMapsOrThrow,
type FindFlatEntityByIdInFlatEntityMapsOrThrowArgs,
@@ -4,8 +4,8 @@ import {
FlatEntityMapsException,
FlatEntityMapsExceptionCode,
} from 'src/engine/metadata-modules/flat-entity/exceptions/flat-entity-maps.exception';
import { type SyncableFlatEntity } from 'src/engine/metadata-modules/flat-entity/types/flat-entity-from.type';
import { type FlatEntityMaps } from 'src/engine/metadata-modules/flat-entity/types/flat-entity-maps.type';
import { type SyncableFlatEntity } from 'src/engine/metadata-modules/flat-entity/types/flat-entity.type';
import { findFlatEntityByUniversalIdentifier } from 'src/engine/metadata-modules/flat-entity/utils/find-flat-entity-by-universal-identifier.util';
export type FindFlatEntityByUniversalIdentifierOrThrowArgs<
@@ -1,7 +1,7 @@
import { isDefined } from 'twenty-shared/utils';
import { type SyncableFlatEntity } from 'src/engine/metadata-modules/flat-entity/types/flat-entity-from.type';
import { type FlatEntityMaps } from 'src/engine/metadata-modules/flat-entity/types/flat-entity-maps.type';
import { type SyncableFlatEntity } from 'src/engine/metadata-modules/flat-entity/types/flat-entity.type';
export const findFlatEntityByUniversalIdentifier = <
T extends SyncableFlatEntity,
@@ -1,7 +1,7 @@
import { isDefined } from 'twenty-shared/utils';
import { type SyncableFlatEntity } from 'src/engine/metadata-modules/flat-entity/types/flat-entity-from.type';
import { type FlatEntityMaps } from 'src/engine/metadata-modules/flat-entity/types/flat-entity-maps.type';
import { type SyncableFlatEntity } from 'src/engine/metadata-modules/flat-entity/types/flat-entity.type';
import { getSubFlatEntityMapsOrThrow } from 'src/engine/metadata-modules/flat-entity/utils/get-sub-flat-entity-maps-or-throw.util';
export type FindManyFlatEntityByIdInFlatEntityMapsOrThrowArgs<
@@ -1,5 +1,5 @@
import { type SyncableFlatEntity } from 'src/engine/metadata-modules/flat-entity/types/flat-entity-from.type';
import { type FlatEntityMaps } from 'src/engine/metadata-modules/flat-entity/types/flat-entity-maps.type';
import { type SyncableFlatEntity } from 'src/engine/metadata-modules/flat-entity/types/flat-entity.type';
import { findFlatEntitiesByApplicationId } from 'src/engine/metadata-modules/flat-entity/utils/find-flat-entities-by-application-id.util';
import { getSubFlatEntityMapsOrThrow } from 'src/engine/metadata-modules/flat-entity/utils/get-sub-flat-entity-maps-or-throw.util';
@@ -1,6 +1,6 @@
import { createEmptyFlatEntityMaps } from 'src/engine/metadata-modules/flat-entity/constant/create-empty-flat-entity-maps.constant';
import { type SyncableFlatEntity } from 'src/engine/metadata-modules/flat-entity/types/flat-entity-from.type';
import { type FlatEntityMaps } from 'src/engine/metadata-modules/flat-entity/types/flat-entity-maps.type';
import { type SyncableFlatEntity } from 'src/engine/metadata-modules/flat-entity/types/flat-entity.type';
import { addFlatEntityToFlatEntityMapsOrThrow } from 'src/engine/metadata-modules/flat-entity/utils/add-flat-entity-to-flat-entity-maps-or-throw.util';
import { findFlatEntityByIdInFlatEntityMapsOrThrow } from 'src/engine/metadata-modules/flat-entity/utils/find-flat-entity-by-id-in-flat-entity-maps-or-throw.util';
@@ -1,5 +1,5 @@
import { type SyncableFlatEntity } from 'src/engine/metadata-modules/flat-entity/types/flat-entity-from.type';
import { type FlatEntityMaps } from 'src/engine/metadata-modules/flat-entity/types/flat-entity-maps.type';
import { type SyncableFlatEntity } from 'src/engine/metadata-modules/flat-entity/types/flat-entity.type';
import { addFlatEntityToFlatEntityMapsOrThrow } from 'src/engine/metadata-modules/flat-entity/utils/add-flat-entity-to-flat-entity-maps-or-throw.util';
import { deleteFlatEntityFromFlatEntityMapsOrThrow } from 'src/engine/metadata-modules/flat-entity/utils/delete-flat-entity-from-flat-entity-maps-or-throw.util';
@@ -1,4 +1,4 @@
import { type SyncableFlatEntity } from 'src/engine/metadata-modules/flat-entity/types/flat-entity.type';
import { type SyncableFlatEntity } from 'src/engine/metadata-modules/flat-entity/types/flat-entity-from.type';
import { orderObjectProperties } from 'src/engine/metadata-modules/flat-entity/utils/order-object-properties.util';
export function transformFlatEntityForComparison<
@@ -0,0 +1,73 @@
import { type Expect, type HasAllProperties } from 'twenty-shared/testing';
import {
type FieldMetadataType,
type NullablePartial,
} from 'twenty-shared/types';
import { type FlatFieldMetadata } from 'src/engine/metadata-modules/flat-field-metadata/types/flat-field-metadata.type';
// Relation field types have defined relation IDs
type DefinedRelationIdRecord = {
relationTargetFieldMetadataId: string;
relationTargetObjectMetadataId: string;
};
// Non-relation field types have never | null relation IDs
type NotDefinedRelationIdRecord = {
relationTargetFieldMetadataId: never | null;
relationTargetObjectMetadataId: never | null;
};
// Date properties are cast to strings
type DatePropertiesCastToString = {
createdAt: string;
updatedAt: string;
};
// OneToMany relations become ...Ids arrays
type OneToManyRelationIdArrays = {
viewFieldIds: string[];
viewFilterIds: string[];
kanbanAggregateOperationViewIds: string[];
calendarViewIds: string[];
mainGroupByFieldMetadataViewIds: string[];
};
// eslint-disable-next-line unused-imports/no-unused-vars
type RelationIdAssertions = [
// Non-relation types have undefined relation IDs
Expect<
HasAllProperties<
FlatFieldMetadata<FieldMetadataType.UUID>,
NotDefinedRelationIdRecord
>
>,
// Relation types have defined relation IDs
Expect<
HasAllProperties<
FlatFieldMetadata<FieldMetadataType.RELATION>,
DefinedRelationIdRecord
>
>,
Expect<
HasAllProperties<
FlatFieldMetadata<FieldMetadataType.MORPH_RELATION>,
DefinedRelationIdRecord
>
>,
// Abstract type has nullable partial relation IDs
Expect<
HasAllProperties<
FlatFieldMetadata,
NullablePartial<DefinedRelationIdRecord>
>
>,
];
// eslint-disable-next-line unused-imports/no-unused-vars
type FlatTransformationAssertions = [
Expect<HasAllProperties<FlatFieldMetadata, DatePropertiesCastToString>>,
Expect<HasAllProperties<FlatFieldMetadata, OneToManyRelationIdArrays>>,
];
@@ -1,7 +1,7 @@
import { type FieldMetadataType } from 'twenty-shared/types';
import { type FieldMetadataEntity } from 'src/engine/metadata-modules/field-metadata/field-metadata.entity';
import { type FlatEntityFrom } from 'src/engine/metadata-modules/flat-entity/types/flat-entity.type';
import { type FlatEntityFrom } from 'src/engine/metadata-modules/flat-entity/types/flat-entity-from.type';
export type FlatFieldMetadata<T extends FieldMetadataType = FieldMetadataType> =
FlatEntityFrom<
@@ -9,6 +9,4 @@ export type FlatFieldMetadata<T extends FieldMetadataType = FieldMetadataType> =
FieldMetadataEntity<T>,
'relationTargetFieldMetadata' | 'relationTargetObjectMetadata'
>
> & {
universalIdentifier: string; // TODO remove once universalIdentifier is required on entity directly
};
>;
@@ -1,4 +1,4 @@
import { type FlatEntityFrom } from 'src/engine/metadata-modules/flat-entity/types/flat-entity.type';
import { type FlatEntityFrom } from 'src/engine/metadata-modules/flat-entity/types/flat-entity-from.type';
import { type FrontComponentEntity } from 'src/engine/metadata-modules/front-component/entities/front-component.entity';
export type FlatFrontComponent = FlatEntityFrom<FrontComponentEntity>;
@@ -1,4 +1,4 @@
import { type FlatEntityFrom } from 'src/engine/metadata-modules/flat-entity/types/flat-entity.type';
import { type FlatEntityFrom } from 'src/engine/metadata-modules/flat-entity/types/flat-entity-from.type';
import { type IndexFieldMetadataEntity } from 'src/engine/metadata-modules/index-metadata/index-field-metadata.entity';
import { type IndexMetadataEntity } from 'src/engine/metadata-modules/index-metadata/index-metadata.entity';
@@ -1,4 +1,4 @@
import { type FlatEntityFrom } from 'src/engine/metadata-modules/flat-entity/types/flat-entity.type';
import { type FlatEntityFrom } from 'src/engine/metadata-modules/flat-entity/types/flat-entity-from.type';
import { type NavigationMenuItemEntity } from 'src/engine/metadata-modules/navigation-menu-item/entities/navigation-menu-item.entity';
export type FlatNavigationMenuItem = FlatEntityFrom<NavigationMenuItemEntity>;
@@ -1,4 +1,4 @@
import { type FlatEntityFrom } from 'src/engine/metadata-modules/flat-entity/types/flat-entity.type';
import { type FlatEntityFrom } from 'src/engine/metadata-modules/flat-entity/types/flat-entity-from.type';
import { type ObjectMetadataEntity } from 'src/engine/metadata-modules/object-metadata/object-metadata.entity';
export type FlatObjectMetadata = FlatEntityFrom<
@@ -1,4 +1,4 @@
import { type FlatEntityFrom } from 'src/engine/metadata-modules/flat-entity/types/flat-entity.type';
import { type FlatEntityFrom } from 'src/engine/metadata-modules/flat-entity/types/flat-entity-from.type';
import { type PageLayoutTabEntity } from 'src/engine/metadata-modules/page-layout-tab/entities/page-layout-tab.entity';
export type FlatPageLayoutTab = FlatEntityFrom<PageLayoutTabEntity>;
@@ -1,4 +1,4 @@
import { type FlatEntityFrom } from 'src/engine/metadata-modules/flat-entity/types/flat-entity.type';
import { type FlatEntityFrom } from 'src/engine/metadata-modules/flat-entity/types/flat-entity-from.type';
import { type PageLayoutWidgetEntity } from 'src/engine/metadata-modules/page-layout-widget/entities/page-layout-widget.entity';
import { type WidgetConfigurationType } from 'src/engine/metadata-modules/page-layout-widget/enums/widget-configuration-type.type';
@@ -1,4 +1,4 @@
import { type FlatEntityFrom } from 'src/engine/metadata-modules/flat-entity/types/flat-entity.type';
import { type FlatEntityFrom } from 'src/engine/metadata-modules/flat-entity/types/flat-entity-from.type';
import { type PageLayoutEntity } from 'src/engine/metadata-modules/page-layout/entities/page-layout.entity';
export type FlatPageLayout = FlatEntityFrom<PageLayoutEntity>;
@@ -1,4 +1,4 @@
import { type FlatEntityFrom } from 'src/engine/metadata-modules/flat-entity/types/flat-entity.type';
import { type FlatEntityFrom } from 'src/engine/metadata-modules/flat-entity/types/flat-entity-from.type';
import { type RoleTargetEntity } from 'src/engine/metadata-modules/role-target/role-target.entity';
export type FlatRoleTarget = FlatEntityFrom<RoleTargetEntity>;
@@ -1,4 +1,4 @@
import { type FlatEntityFrom } from 'src/engine/metadata-modules/flat-entity/types/flat-entity.type';
import { type FlatEntityFrom } from 'src/engine/metadata-modules/flat-entity/types/flat-entity-from.type';
import { type RoleEntity } from 'src/engine/metadata-modules/role/role.entity';
export type FlatRole = FlatEntityFrom<RoleEntity> & {
@@ -1,4 +1,4 @@
import { type FlatEntityFrom } from 'src/engine/metadata-modules/flat-entity/types/flat-entity-from.type';
import { type SkillEntity } from 'src/engine/metadata-modules/skill/entities/skill.entity';
import { type FlatEntityFrom } from 'src/engine/metadata-modules/flat-entity/types/flat-entity.type';
export type FlatSkill = FlatEntityFrom<SkillEntity>;
@@ -1,4 +1,4 @@
import { type FlatEntityFrom } from 'src/engine/metadata-modules/flat-entity/types/flat-entity.type';
import { type FlatEntityFrom } from 'src/engine/metadata-modules/flat-entity/types/flat-entity-from.type';
import { type ViewFieldEntity } from 'src/engine/metadata-modules/view-field/entities/view-field.entity';
export type FlatViewField = FlatEntityFrom<ViewFieldEntity>;
@@ -1,4 +1,4 @@
import { type FlatEntityFrom } from 'src/engine/metadata-modules/flat-entity/types/flat-entity.type';
import { type FlatEntityFrom } from 'src/engine/metadata-modules/flat-entity/types/flat-entity-from.type';
import { type ViewFilterGroupEntity } from 'src/engine/metadata-modules/view-filter-group/entities/view-filter-group.entity';
export type FlatViewFilterGroup = FlatEntityFrom<ViewFilterGroupEntity>;
@@ -1,4 +1,4 @@
import { type FlatEntityFrom } from 'src/engine/metadata-modules/flat-entity/types/flat-entity.type';
import { type FlatEntityFrom } from 'src/engine/metadata-modules/flat-entity/types/flat-entity-from.type';
import { type ViewFilterEntity } from 'src/engine/metadata-modules/view-filter/entities/view-filter.entity';
export type FlatViewFilter = FlatEntityFrom<ViewFilterEntity>;
@@ -1,4 +1,4 @@
import { type FlatEntityFrom } from 'src/engine/metadata-modules/flat-entity/types/flat-entity.type';
import { type FlatEntityFrom } from 'src/engine/metadata-modules/flat-entity/types/flat-entity-from.type';
import { type ViewGroupEntity } from 'src/engine/metadata-modules/view-group/entities/view-group.entity';
export type FlatViewGroup = FlatEntityFrom<ViewGroupEntity>;
@@ -1,4 +1,4 @@
import { type FlatEntityFrom } from 'src/engine/metadata-modules/flat-entity/types/flat-entity.type';
import { type FlatEntityFrom } from 'src/engine/metadata-modules/flat-entity/types/flat-entity-from.type';
import { type ViewEntity } from 'src/engine/metadata-modules/view/entities/view.entity';
export type FlatView = FlatEntityFrom<
@@ -1,4 +1,4 @@
import { type FlatEntityFrom } from 'src/engine/metadata-modules/flat-entity/types/flat-entity.type';
import { type FlatEntityFrom } from 'src/engine/metadata-modules/flat-entity/types/flat-entity-from.type';
import { type RouteTriggerEntity } from 'src/engine/metadata-modules/route-trigger/route-trigger.entity';
export type FlatRouteTrigger = FlatEntityFrom<RouteTriggerEntity>;
@@ -1,6 +1,6 @@
/* @license Enterprise */
import { type FlatEntityFrom } from 'src/engine/metadata-modules/flat-entity/types/flat-entity.type';
import { type FlatEntityFrom } from 'src/engine/metadata-modules/flat-entity/types/flat-entity-from.type';
import { type RowLevelPermissionPredicateGroupEntity } from 'src/engine/metadata-modules/row-level-permission-predicate/entities/row-level-permission-predicate-group.entity';
export type FlatRowLevelPermissionPredicateGroup =
@@ -1,6 +1,6 @@
/* @license Enterprise */
import { type FlatEntityFrom } from 'src/engine/metadata-modules/flat-entity/types/flat-entity.type';
import { type FlatEntityFrom } from 'src/engine/metadata-modules/flat-entity/types/flat-entity-from.type';
import { type RowLevelPermissionPredicateEntity } from 'src/engine/metadata-modules/row-level-permission-predicate/entities/row-level-permission-predicate.entity';
export type FlatRowLevelPermissionPredicate =
@@ -1,4 +1,4 @@
import { type FlatEntityFrom } from 'src/engine/metadata-modules/flat-entity/types/flat-entity.type';
import { type FlatEntityFrom } from 'src/engine/metadata-modules/flat-entity/types/flat-entity-from.type';
import { type ServerlessFunctionLayerEntity } from 'src/engine/metadata-modules/serverless-function-layer/serverless-function-layer.entity';
export type FlatServerlessFunctionLayer =
@@ -1,6 +1,6 @@
import { type Sources } from 'twenty-shared/types';
import { type FlatEntityFrom } from 'src/engine/metadata-modules/flat-entity/types/flat-entity.type';
import { type FlatEntityFrom } from 'src/engine/metadata-modules/flat-entity/types/flat-entity-from.type';
import { type ServerlessFunctionEntity } from 'src/engine/metadata-modules/serverless-function/serverless-function.entity';
export type FlatServerlessFunction =
@@ -0,0 +1,81 @@
import { type Expect, type HasAllProperties } from 'twenty-shared/testing';
import {
type FieldMetadataType,
type NullablePartial,
} from 'twenty-shared/types';
import { type UniversalFlatFieldMetadata } from 'src/engine/workspace-manager/workspace-migration/universal-flat-entity/types/universal-flat-field-metadata.type';
// Relation field types have defined relation universal identifiers
type DefinedRelationUniversalIdentifierRecord = {
relationTargetFieldMetadataUniversalIdentifier: string;
relationTargetObjectMetadataUniversalIdentifier: string;
};
// Non-relation field types have never | null relation universal identifiers
type NotDefinedRelationUniversalIdentifierRecord = {
relationTargetFieldMetadataUniversalIdentifier: never | null;
relationTargetObjectMetadataUniversalIdentifier: never | null;
};
// Date properties are cast to strings
type DatePropertiesCastToString = {
createdAt: string;
updatedAt: string;
};
// OneToMany relations become ...UniversalIdentifiers arrays
type OneToManyUniversalIdentifierArrays = {
viewFieldUniversalIdentifiers: string[];
viewFilterUniversalIdentifiers: string[];
kanbanAggregateOperationViewUniversalIdentifiers: string[];
calendarViewUniversalIdentifiers: string[];
mainGroupByFieldMetadataViewUniversalIdentifiers: string[];
};
// Narrowed relation universal identifier assertions - verifies conditional typing is preserved
// eslint-disable-next-line unused-imports/no-unused-vars
type RelationUniversalIdentifierAssertions = [
// Non-relation types have undefined relation universal identifiers
Expect<
HasAllProperties<
UniversalFlatFieldMetadata<FieldMetadataType.UUID>,
NotDefinedRelationUniversalIdentifierRecord
>
>,
// Relation types have defined relation universal identifiers
Expect<
HasAllProperties<
UniversalFlatFieldMetadata<FieldMetadataType.RELATION>,
DefinedRelationUniversalIdentifierRecord
>
>,
Expect<
HasAllProperties<
UniversalFlatFieldMetadata<FieldMetadataType.MORPH_RELATION>,
DefinedRelationUniversalIdentifierRecord
>
>,
// Abstract type has nullable partial relation universal identifiers
Expect<
HasAllProperties<
UniversalFlatFieldMetadata,
NullablePartial<DefinedRelationUniversalIdentifierRecord>
>
>,
];
// eslint-disable-next-line unused-imports/no-unused-vars
type UniversalFlatTransformationAssertions = [
Expect<
HasAllProperties<UniversalFlatFieldMetadata, DatePropertiesCastToString>
>,
Expect<
HasAllProperties<
UniversalFlatFieldMetadata,
OneToManyUniversalIdentifierArrays
>
>,
];
@@ -0,0 +1,37 @@
import { type AllMetadataName } from 'twenty-shared/metadata';
import { type CastRecordTypeOrmDatePropertiesToString } from 'src/engine/metadata-modules/flat-entity/types/cast-record-typeorm-date-properties-to-string.type';
import { type ExtractEntityOneToManyEntityRelationProperties } from 'src/engine/metadata-modules/flat-entity/types/extract-entity-one-to-many-entity-relation-properties.type';
import { type ExtractEntityRelatedEntityProperties } from 'src/engine/metadata-modules/flat-entity/types/extract-entity-related-entity-properties.type';
import { type FromMetadataEntityToMetadataName } from 'src/engine/metadata-modules/flat-entity/types/from-metadata-entity-to-metadata-name.type';
import { type MetadataManyToOneJoinColumn } from 'src/engine/metadata-modules/flat-entity/types/metadata-many-to-one-join-column.type';
import { type SyncableEntity } from 'src/engine/workspace-manager/types/syncable-entity.interface';
import { type RemoveSuffix } from 'src/engine/workspace-manager/workspace-migration/workspace-migration-builder/types/remove-suffix.type';
// TODO Handle universal settings
export type UniversalFlatEntityFrom<
TEntity extends SyncableEntity,
TMetadataName extends
AllMetadataName = FromMetadataEntityToMetadataName<TEntity>,
> = Omit<
TEntity,
| 'applicationId'
| 'workspaceId'
| 'standardId'
| 'id'
| ExtractEntityRelatedEntityProperties<TEntity>
| Extract<MetadataManyToOneJoinColumn<TMetadataName>, keyof TEntity>
| keyof CastRecordTypeOrmDatePropertiesToString<TEntity>
> &
CastRecordTypeOrmDatePropertiesToString<TEntity> & {
[P in ExtractEntityOneToManyEntityRelationProperties<
TEntity,
SyncableEntity
> &
string as `${RemoveSuffix<P, 's'>}UniversalIdentifiers`]: string[];
} & {
[P in Extract<MetadataManyToOneJoinColumn<TMetadataName>, keyof TEntity> &
string as `${RemoveSuffix<P, 'Id'>}UniversalIdentifier`]: TEntity[P];
} & {
applicationUniversalIdentifier: string;
};
@@ -0,0 +1,8 @@
import { type FieldMetadataType } from 'twenty-shared/types';
import { type FieldMetadataEntity } from 'src/engine/metadata-modules/field-metadata/field-metadata.entity';
import { type UniversalFlatEntityFrom } from 'src/engine/workspace-manager/workspace-migration/universal-flat-entity/types/universal-flat-entity-from.type';
export type UniversalFlatFieldMetadata<
T extends FieldMetadataType = FieldMetadataType,
> = UniversalFlatEntityFrom<FieldMetadataEntity<T>, 'fieldMetadata'>;
@@ -1,7 +1,7 @@
import { type EachTestingContext } from 'twenty-shared/testing';
import { type SyncableFlatEntity } from 'src/engine/metadata-modules/flat-entity/types/flat-entity-from.type';
import { type FlatEntityMaps } from 'src/engine/metadata-modules/flat-entity/types/flat-entity-maps.type';
import { type SyncableFlatEntity } from 'src/engine/metadata-modules/flat-entity/types/flat-entity.type';
import {
type CircularDependencyValidationResult,
validateFlatEntityCircularDependency,
@@ -4,8 +4,8 @@ import {
FlatEntityMapsException,
FlatEntityMapsExceptionCode,
} from 'src/engine/metadata-modules/flat-entity/exceptions/flat-entity-maps.exception';
import { type SyncableFlatEntity } from 'src/engine/metadata-modules/flat-entity/types/flat-entity-from.type';
import { type FlatEntityMaps } from 'src/engine/metadata-modules/flat-entity/types/flat-entity-maps.type';
import { type SyncableFlatEntity } from 'src/engine/metadata-modules/flat-entity/types/flat-entity.type';
type AddFlatEntityToFlatEntityMapsThroughMutationOrThrowArgs<
T extends SyncableFlatEntity,
@@ -4,8 +4,8 @@ import {
FlatEntityMapsException,
FlatEntityMapsExceptionCode,
} from 'src/engine/metadata-modules/flat-entity/exceptions/flat-entity-maps.exception';
import { type SyncableFlatEntity } from 'src/engine/metadata-modules/flat-entity/types/flat-entity-from.type';
import { type FlatEntityMaps } from 'src/engine/metadata-modules/flat-entity/types/flat-entity-maps.type';
import { type SyncableFlatEntity } from 'src/engine/metadata-modules/flat-entity/types/flat-entity.type';
export type DeleteFlatEntityFromFlatEntityMapsThroughMutationOrThrowArgs<
T extends SyncableFlatEntity,
@@ -1,5 +1,5 @@
import { type SyncableFlatEntity } from 'src/engine/metadata-modules/flat-entity/types/flat-entity-from.type';
import { type FlatEntityMaps } from 'src/engine/metadata-modules/flat-entity/types/flat-entity-maps.type';
import { type SyncableFlatEntity } from 'src/engine/metadata-modules/flat-entity/types/flat-entity.type';
import { addFlatEntityToFlatEntityMapsThroughMutationOrThrow } from 'src/engine/workspace-manager/workspace-migration/utils/add-flat-entity-to-flat-entity-maps-through-mutation-or-throw.util';
import { deleteFlatEntityFromFlatEntityMapsThroughMutationOrThrow } from 'src/engine/workspace-manager/workspace-migration/utils/delete-flat-entity-from-flat-entity-maps-through-mutation-or-throw.util';
@@ -1,7 +1,7 @@
import { isDefined } from 'twenty-shared/utils';
import { type SyncableFlatEntity } from 'src/engine/metadata-modules/flat-entity/types/flat-entity-from.type';
import { type FlatEntityMaps } from 'src/engine/metadata-modules/flat-entity/types/flat-entity-maps.type';
import { type SyncableFlatEntity } from 'src/engine/metadata-modules/flat-entity/types/flat-entity.type';
export type CircularDependencyValidationSuccess = {
status: 'success';