Paul Rastoin
44202668fd
# Introduction
In this PR we're introducing mainly two branded type signatures for both
`JsonbProperty` entities properties and `SerializedRelation` (jsonb
serialized property storing another entity id).
Allowing to dynamically map over them later in order to build universal
`jsonb` `serialized` relations.
## `JsonbProperty`
A branded wrapper type that marks entity properties stored as PostgreSQL
JSONB columns. It adds a phantom brand `__JsonbPropertyBrand__` to
object types while leaving primitives unchanged. The branded key is
optional and typed as never, also omitted when transpiled to
`UniversalFlat`
**Should be used at entities lvl only:**
```typescript
@Column({ type: 'jsonb', nullable: false })
gridPosition: JsonbProperty<GridPosition>;
@Column({ nullable: false, type: 'jsonb', default: [] })
publishedVersions: JsonbProperty<string[]>;
```
## `SerializedRelation`
A branded string type that marks foreign key IDs stored inside JSONB
objects. These are entity references serialized within a JSONB column
rather than being a regular database foreign key.
**Usage in jsonb property generic***
```ts
type FieldMetadataRelationSettings = {
relationType: RelationType;
onDelete?: RelationOnDeleteAction;
joinColumnName?: string | null;
junctionTargetFieldId?: SerializedRelation;
};
```
## `FormatJsonbSerializedRelation<T>`
A transformation type that processes JSONB properties for universal
entity mapping. It:
1. Detects properties with the `JsonbProperty` brand
2. Finds `SerializedRelation` properties
3. Renames them from `*Id` to `*UniversalIdentifier`
4. Removes the brand from the output type ( optional though )
```typescript
// Input: JsonbProperty<{ targetFieldMetadataId: SerializedRelation }>
// Output: { targetFieldMetadataUniversalIdentifier: SerializedRelation }
```
## Result
An example of the dynamic type mapping, through a type-test example
```ts
type SettingsTestCase = UniversalFlatFieldMetadata<
| FieldMetadataType.RELATION
| FieldMetadataType.NUMBER
| FieldMetadataType.TEXT
>['settings']
type SettingsExpectedResult =
| {
relationType: RelationType;
onDelete?: RelationOnDeleteAction | undefined;
joinColumnName?: string | null | undefined;
junctionTargetFieldUniversalIdentifier?: SerializedRelation | undefined;
}
| {
dataType?: NumberDataType | undefined;
decimals?: number | undefined;
type?: FieldNumberVariant | undefined;
}
| {
displayedMaxRows?: number | undefined;
}
| null;
type Assertions = [
Expect<Equal<SettingsTestCase, SettingsExpectedResult>>,
]
```
## Remarks
- Removed duplicated twenty-server and twenty-shared typed
- Removed class validator instances for default value that were not used
at runtime, we will refactor that to add validation across all entities
following a same pattern
246 lines
7.0 KiB
TypeScript
246 lines
7.0 KiB
TypeScript
import {
|
|
type FieldMetadataTypesToTestForCreateInputValidation,
|
|
type FieldMetadataTypesToTestForFilterInputValidation,
|
|
} from 'test/integration/graphql/suites/inputs-validation/types/field-metadata-type-to-test';
|
|
import {
|
|
type FieldMetadataSettingsMapping,
|
|
FieldMetadataType,
|
|
RelationType,
|
|
type FieldMetadataMultiItemSettings,
|
|
type RelationCreationPayload,
|
|
} from 'twenty-shared/types';
|
|
|
|
import { type FieldMetadataComplexOption } from 'src/engine/metadata-modules/field-metadata/dtos/options.input';
|
|
|
|
type FieldMetadataCreationInput = {
|
|
name: string;
|
|
label: string;
|
|
type: FieldMetadataType;
|
|
objectMetadataId: string;
|
|
options?: FieldMetadataComplexOption[];
|
|
relationCreationPayload?: RelationCreationPayload;
|
|
morphRelationsCreationPayload?: RelationCreationPayload[];
|
|
settings?:
|
|
| FieldMetadataMultiItemSettings
|
|
| FieldMetadataSettingsMapping['FILES'];
|
|
};
|
|
|
|
export const getFieldMetadataCreationInputs = (
|
|
objectMetadataId: string,
|
|
targetObjectMetadata1Id: string,
|
|
targetObjectMetadata2Id: string,
|
|
) => {
|
|
const fieldInputsMap: {
|
|
[K in Exclude<
|
|
| FieldMetadataTypesToTestForCreateInputValidation
|
|
| FieldMetadataTypesToTestForFilterInputValidation,
|
|
'ACTOR' | 'POSITION'
|
|
>]: FieldMetadataCreationInput | FieldMetadataCreationInput[];
|
|
} = {
|
|
[FieldMetadataType.RICH_TEXT]: {
|
|
name: 'richTextField',
|
|
label: 'richTextField',
|
|
type: FieldMetadataType.RICH_TEXT,
|
|
objectMetadataId,
|
|
},
|
|
[FieldMetadataType.RICH_TEXT_V2]: {
|
|
name: 'richTextV2Field',
|
|
label: 'richTextV2Field',
|
|
type: FieldMetadataType.RICH_TEXT_V2,
|
|
objectMetadataId,
|
|
},
|
|
[FieldMetadataType.TEXT]: {
|
|
name: 'textField',
|
|
label: 'textField',
|
|
type: FieldMetadataType.TEXT,
|
|
objectMetadataId,
|
|
},
|
|
[FieldMetadataType.PHONES]: {
|
|
name: 'phonesField',
|
|
label: 'phonesField',
|
|
type: FieldMetadataType.PHONES,
|
|
objectMetadataId,
|
|
},
|
|
[FieldMetadataType.EMAILS]: {
|
|
name: 'emailsField',
|
|
label: 'emailsField',
|
|
type: FieldMetadataType.EMAILS,
|
|
objectMetadataId,
|
|
},
|
|
[FieldMetadataType.DATE_TIME]: {
|
|
name: 'dateTimeField',
|
|
label: 'dateTimeField',
|
|
type: FieldMetadataType.DATE_TIME,
|
|
objectMetadataId,
|
|
},
|
|
[FieldMetadataType.DATE]: {
|
|
name: 'dateField',
|
|
label: 'dateField',
|
|
type: FieldMetadataType.DATE,
|
|
objectMetadataId,
|
|
},
|
|
[FieldMetadataType.BOOLEAN]: {
|
|
name: 'booleanField',
|
|
label: 'booleanField',
|
|
type: FieldMetadataType.BOOLEAN,
|
|
objectMetadataId,
|
|
},
|
|
[FieldMetadataType.NUMBER]: {
|
|
name: 'numberField',
|
|
label: 'numberField',
|
|
type: FieldMetadataType.NUMBER,
|
|
objectMetadataId,
|
|
},
|
|
[FieldMetadataType.LINKS]: {
|
|
name: 'linksField',
|
|
label: 'linksField',
|
|
type: FieldMetadataType.LINKS,
|
|
objectMetadataId,
|
|
},
|
|
[FieldMetadataType.CURRENCY]: {
|
|
name: 'currencyField',
|
|
label: 'currencyField',
|
|
type: FieldMetadataType.CURRENCY,
|
|
objectMetadataId,
|
|
},
|
|
[FieldMetadataType.FULL_NAME]: {
|
|
name: 'fullNameField',
|
|
label: 'fullNameField',
|
|
type: FieldMetadataType.FULL_NAME,
|
|
objectMetadataId,
|
|
},
|
|
[FieldMetadataType.RATING]: {
|
|
name: 'ratingField',
|
|
label: 'ratingField',
|
|
type: FieldMetadataType.RATING,
|
|
objectMetadataId,
|
|
},
|
|
[FieldMetadataType.SELECT]: {
|
|
name: 'selectField',
|
|
label: 'selectField',
|
|
type: FieldMetadataType.SELECT,
|
|
options: [
|
|
{
|
|
label: 'Option 1',
|
|
value: 'OPTION_1',
|
|
color: 'green',
|
|
position: 1,
|
|
id: '26c602c3-cba9-4d83-92d4-4ba7dbae2f31',
|
|
},
|
|
],
|
|
objectMetadataId,
|
|
},
|
|
[FieldMetadataType.MULTI_SELECT]: {
|
|
name: 'multiSelectField',
|
|
label: 'multiSelectField',
|
|
type: FieldMetadataType.MULTI_SELECT,
|
|
options: [
|
|
{
|
|
label: 'Option 1',
|
|
value: 'OPTION_1',
|
|
color: 'green',
|
|
position: 1,
|
|
id: '26c602c3-cba9-4d83-92d4-4ba7dbae2f31',
|
|
},
|
|
],
|
|
objectMetadataId,
|
|
},
|
|
|
|
[FieldMetadataType.ADDRESS]: {
|
|
name: 'addressField',
|
|
label: 'addressField',
|
|
type: FieldMetadataType.ADDRESS,
|
|
objectMetadataId,
|
|
},
|
|
[FieldMetadataType.RAW_JSON]: {
|
|
name: 'rawJsonField',
|
|
label: 'rawJsonField',
|
|
type: FieldMetadataType.RAW_JSON,
|
|
objectMetadataId,
|
|
},
|
|
[FieldMetadataType.ARRAY]: {
|
|
name: 'arrayField',
|
|
label: 'arrayField',
|
|
type: FieldMetadataType.ARRAY,
|
|
objectMetadataId,
|
|
},
|
|
[FieldMetadataType.FILES]: {
|
|
name: 'filesField',
|
|
label: 'filesField',
|
|
type: FieldMetadataType.FILES,
|
|
objectMetadataId,
|
|
settings: {
|
|
maxNumberOfValues: 2,
|
|
},
|
|
},
|
|
[FieldMetadataType.UUID]: {
|
|
name: 'uuidField',
|
|
label: 'uuidField',
|
|
type: FieldMetadataType.UUID,
|
|
objectMetadataId,
|
|
},
|
|
[FieldMetadataType.RELATION]: [
|
|
{
|
|
name: 'manyToOneRelationField',
|
|
label: 'manyToOneRelationField',
|
|
type: FieldMetadataType.RELATION,
|
|
objectMetadataId,
|
|
relationCreationPayload: {
|
|
targetObjectMetadataId: targetObjectMetadata1Id,
|
|
targetFieldLabel: 'oneToManyTargetRelationField',
|
|
targetFieldIcon: 'IconListOpportunity',
|
|
type: RelationType.MANY_TO_ONE,
|
|
},
|
|
},
|
|
{
|
|
name: 'oneToManyRelationField',
|
|
label: 'oneToManyRelationField',
|
|
type: FieldMetadataType.RELATION,
|
|
objectMetadataId,
|
|
relationCreationPayload: {
|
|
targetObjectMetadataId: targetObjectMetadata1Id,
|
|
targetFieldLabel: 'manyToOneTargetRelationField',
|
|
targetFieldIcon: 'IconListOpportunity',
|
|
type: RelationType.ONE_TO_MANY,
|
|
},
|
|
},
|
|
],
|
|
[FieldMetadataType.MORPH_RELATION]: [
|
|
{
|
|
name: 'manyToOneMorphRelationField',
|
|
label: 'manyToOneMorphRelationField',
|
|
type: FieldMetadataType.MORPH_RELATION,
|
|
objectMetadataId,
|
|
morphRelationsCreationPayload: [
|
|
{
|
|
targetObjectMetadataId: targetObjectMetadata1Id,
|
|
targetFieldLabel: 'oneToManyTarget1MorphRelationField',
|
|
targetFieldIcon: 'IconListOpportunity',
|
|
type: RelationType.MANY_TO_ONE,
|
|
},
|
|
{
|
|
targetObjectMetadataId: targetObjectMetadata2Id,
|
|
targetFieldLabel: 'oneToManyTarget2MorphRelationField',
|
|
targetFieldIcon: 'IconListOpportunity',
|
|
type: RelationType.MANY_TO_ONE,
|
|
},
|
|
],
|
|
},
|
|
// {
|
|
// name: 'oneToManyRelationField',
|
|
// label: 'oneToManyRelationField',
|
|
// type: FieldMetadataType.RELATION,
|
|
// objectMetadataId,
|
|
// relationCreationPayload: {
|
|
// targetObjectMetadataId: targetObjectMetadata1Id,
|
|
// targetFieldLabel: 'manyToOneTargetRelationField',
|
|
// targetFieldIcon: 'IconListOpportunity',
|
|
// type: RelationType.ONE_TO_MANY,
|
|
// },
|
|
// },
|
|
],
|
|
};
|
|
|
|
return Object.values(fieldInputsMap).flat();
|
|
};
|