Deprecate FieldMetadataInterface (#13264)
# Introduction
From the moment replaced the FieldMetadataInterface definition to:
```ts
import { FieldMetadataType } from 'twenty-shared/types';
import { FieldMetadataEntity } from 'src/engine/metadata-modules/field-metadata/field-metadata.entity';
export type FieldMetadataInterface<
T extends FieldMetadataType = FieldMetadataType,
> = FieldMetadataEntity<T>;
```
After this PR merge will create a new one removing the type and
replacing it to `FieldMetadataEntity`.
Did not renamed it here to avoid conflicts on naming + type issues fixs
within the same PR
## Field metadata entity RELATION or MORPH
Relations fields cannot be null for those field metadata entity instance
anymore, but are never for the others see
`packages/twenty-server/src/engine/metadata-modules/field-metadata/types/field-metadata-entity-test.type.ts`
( introduced TypeScript tests )
## Concerns
- TS_VECTOR is the most at risk with the `generatedType` and
`asExpression` removal from interface
## What's next
- `FielMetadataInterface` removal and rename ( see introduction )
- Depcrecating `ObjectMetadataInterface`
- Refactor `FieldMetadataEntity` optional fiels to be nullable only
- TO DIG `never` occurences on settings, defaultValue etc
- Some interfaces will be replaced by the `FlatFieldMetadata` when
deprecating the current sync and comparators tools
This commit is contained in:
+1
-1
@@ -7,7 +7,7 @@ export const assertDoesNotNullifyDefaultValueForNonNullableField = ({
|
||||
isNullable,
|
||||
defaultValueFromUpdate,
|
||||
}: {
|
||||
isNullable: boolean;
|
||||
isNullable: boolean | null;
|
||||
// eslint-disable-next-line @typescript-eslint/no-explicit-any
|
||||
defaultValueFromUpdate?: any;
|
||||
}) => {
|
||||
|
||||
+31
@@ -0,0 +1,31 @@
|
||||
import { FieldMetadataDTO } from 'src/engine/metadata-modules/field-metadata/dtos/field-metadata.dto';
|
||||
import { FieldMetadataEntity } from 'src/engine/metadata-modules/field-metadata/field-metadata.entity';
|
||||
|
||||
export const fromFieldMetadataEntityToFieldMetadataDto = (
|
||||
fieldMetadataEntity: FieldMetadataEntity,
|
||||
): FieldMetadataDTO => {
|
||||
const {
|
||||
createdAt,
|
||||
updatedAt,
|
||||
description,
|
||||
icon,
|
||||
standardOverrides,
|
||||
isNullable,
|
||||
isUnique,
|
||||
settings,
|
||||
...rest
|
||||
} = fieldMetadataEntity;
|
||||
|
||||
return {
|
||||
...rest,
|
||||
// Should we ? seems to be typed a dateString from classValidator, should be typed as string in TypeScript ?
|
||||
createdAt: new Date(createdAt),
|
||||
updatedAt: new Date(updatedAt),
|
||||
description: description ?? undefined,
|
||||
icon: icon ?? undefined,
|
||||
standardOverrides: standardOverrides ?? undefined,
|
||||
isNullable: isNullable ?? false,
|
||||
isUnique: isUnique ?? false,
|
||||
settings: settings ?? undefined,
|
||||
};
|
||||
};
|
||||
+2
-1
@@ -9,7 +9,8 @@ export type SelectOrMultiSelectFieldMetadataEntity = FieldMetadataEntity<
|
||||
>;
|
||||
export const isSelectOrMultiSelectFieldMetadata = (
|
||||
fieldMetadata: FieldMetadataInterface,
|
||||
): fieldMetadata is SelectOrMultiSelectFieldMetadataEntity => {
|
||||
): fieldMetadata is FieldMetadataInterface &
|
||||
SelectOrMultiSelectFieldMetadataEntity => {
|
||||
return [FieldMetadataType.SELECT, FieldMetadataType.MULTI_SELECT].includes(
|
||||
fieldMetadata.type,
|
||||
);
|
||||
|
||||
Reference in New Issue
Block a user