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
118 lines
1.9 KiB
TypeScript
118 lines
1.9 KiB
TypeScript
import {
|
|
type FieldMetadataOptions,
|
|
type FieldMetadataSettings,
|
|
type FieldMetadataType,
|
|
type FieldMetadataDefaultValue,
|
|
} from 'twenty-shared/types';
|
|
|
|
import { type Gate } from 'src/engine/twenty-orm/interfaces/gate.interface';
|
|
|
|
import { type ObjectMetadataEntity } from 'src/engine/metadata-modules/object-metadata/object-metadata.entity';
|
|
|
|
export interface WorkspaceFieldMetadataArgs {
|
|
/**
|
|
* Standard id.
|
|
*/
|
|
readonly standardId: string;
|
|
|
|
/**
|
|
* Class to which field is applied.
|
|
*/
|
|
|
|
readonly target: Function;
|
|
|
|
/**
|
|
* Field name.
|
|
*/
|
|
readonly name: string;
|
|
|
|
/**
|
|
* Field label.
|
|
*/
|
|
readonly label: string | ((objectMetadata: ObjectMetadataEntity) => string);
|
|
|
|
/**
|
|
* Field type.
|
|
*/
|
|
readonly type: FieldMetadataType;
|
|
|
|
/**
|
|
* Field description.
|
|
*/
|
|
readonly description?:
|
|
| string
|
|
| ((objectMetadata: ObjectMetadataEntity) => string);
|
|
|
|
/**
|
|
* Field icon.
|
|
*/
|
|
readonly icon?: string;
|
|
|
|
/**
|
|
* Field default value.
|
|
*/
|
|
readonly defaultValue?: FieldMetadataDefaultValue;
|
|
|
|
/**
|
|
* Field options.
|
|
*/
|
|
readonly options?: FieldMetadataOptions;
|
|
|
|
/**
|
|
* Field settings.
|
|
*/
|
|
readonly settings?: FieldMetadataSettings;
|
|
|
|
/**
|
|
* Is primary field.
|
|
*/
|
|
readonly isPrimary: boolean;
|
|
|
|
/**
|
|
* Is system field.
|
|
*/
|
|
readonly isSystem: boolean;
|
|
|
|
/**
|
|
* Is UI read-only field.
|
|
*/
|
|
readonly isUIReadOnly: boolean;
|
|
|
|
/**
|
|
* Is nullable field.
|
|
*/
|
|
readonly isNullable: boolean;
|
|
|
|
/**
|
|
* Is unique field.
|
|
*/
|
|
readonly isUnique: boolean;
|
|
|
|
/**
|
|
* Field gate.
|
|
*/
|
|
readonly gate?: Gate;
|
|
|
|
/**
|
|
* Is deprecated field.
|
|
*/
|
|
readonly isDeprecated?: boolean;
|
|
|
|
/**
|
|
* Is active field.
|
|
*/
|
|
readonly isActive?: boolean;
|
|
|
|
/**
|
|
* Is active field.
|
|
*/
|
|
readonly generatedType?: 'STORED' | 'VIRTUAL';
|
|
|
|
/**
|
|
* Is active field.
|
|
*/
|
|
readonly asExpression?: string;
|
|
|
|
readonly isLabelSyncedWithName: boolean;
|
|
}
|