syncable-entity-types-and-constants

; } ; export type UniversalDeleteMyEntityAction = { type : 'delete' ; metadataName : 'myEntity' ; universalFlatEntity : UniversalFlatMyEntity ; } ; // Flat actions (internal to runner) export type FlatCreateMyEntityAction = { type : 'create' ; metadataName : 'myEntity' ; flatEntity : FlatMyEntity ; } ; export type FlatUpdateMyEntityAction = { type : 'update' ; metadataName : 'myEntity' ; flatEntity : FlatMyEntity ; updates : Partial < FlatMyEntity

; } ; export type FlatDeleteMyEntityAction = { type : 'delete' ; metadataName : 'myEntity' ; flatEntity : FlatMyEntity ; } ; Step 6: Register in Central Constants 6a. AllFlatEntityTypesByMetadataName File : src/engine/metadata-modules/flat-entity/types/all-flat-entity-types-by-metadata-name.ts export type AllFlatEntityTypesByMetadataName = { // ... existing entries myEntity : { flatEntityMaps : FlatMyEntityMaps ; universalActions : { create : UniversalCreateMyEntityAction ; update : UniversalUpdateMyEntityAction ; delete : UniversalDeleteMyEntityAction ; } ; flatActions : { create : FlatCreateMyEntityAction ; update : FlatUpdateMyEntityAction ; delete : FlatDeleteMyEntityAction ; } ; flatEntity : FlatMyEntity ; universalFlatEntity : UniversalFlatMyEntity ; entity : MyEntityEntity ; } ; } ; 6b. ALL_ENTITY_PROPERTIES_CONFIGURATION_BY_METADATA_NAME File : src/engine/metadata-modules/flat-entity/constant/all-entity-properties-configuration-by-metadata-name.constant.ts export const ALL_ENTITY_PROPERTIES_CONFIGURATION_BY_METADATA_NAME = { // ... existing entries myEntity : { name : { toCompare : true } , label : { toCompare : true } , description : { toCompare : true } , parentEntityId : { toCompare : true , universalProperty : 'parentEntityUniversalIdentifier' , } , settings : { toCompare : true , toStringify : true , universalProperty : 'universalSettings' , } , } , } as const ; Rules : toCompare: true → Editable property (checked for changes) toStringify: true → JSONB/object property (needs JSON serialization) universalProperty → Maps to universal version (for foreign keys & JSONB with SerializedRelation ) 6c. ALL_ONE_TO_MANY_METADATA_RELATIONS File : src/engine/metadata-modules/flat-entity/constant/all-one-to-many-metadata-relations.constant.ts This constant is type-checked — values for metadataName , flatEntityForeignKeyAggregator , and universalFlatEntityForeignKeyAggregator are derived from entity type definitions. The aggregator names follow the pattern: remove trailing 's' from the relation property name, then append Ids or UniversalIdentifiers . export const ALL_ONE_TO_MANY_METADATA_RELATIONS = { // ... existing entries myEntity : { // If myEntity has a childEntities: ChildEntityEntity[] property: childEntities : { metadataName : 'childEntity' , flatEntityForeignKeyAggregator : 'childEntityIds' , universalFlatEntityForeignKeyAggregator : 'childEntityUniversalIdentifiers' , } , // null for relations to non-syncable entities someNonSyncableRelation : null , } , } as const ; 6d. ALL_MANY_TO_ONE_METADATA_FOREIGN_KEY File : src/engine/metadata-modules/flat-entity/constant/all-many-to-one-metadata-foreign-key.constant.ts Low-level primitive constant. Only contains foreignKey — the column name ending in Id that stores the foreign key. Type-checked against entity properties. export const ALL_MANY_TO_ONE_METADATA_FOREIGN_KEY = { // ... existing entries myEntity : { workspace : null , application : null , parentEntity : { foreignKey : 'parentEntityId' , } , } , } as const ; 6e. ALL_MANY_TO_ONE_METADATA_RELATIONS File : src/engine/metadata-modules/flat-entity/constant/all-many-to-one-metadata-relations.constant.ts Derived from both ALL_MANY_TO_ONE_METADATA_FOREIGN_KEY (for foreignKey type and universalForeignKey derivation) and ALL_ONE_TO_MANY_METADATA_RELATIONS (for inverseOneToManyProperty key constraint). This is the main constant consumed by utils and optimistic tooling. export const ALL_MANY_TO_ONE_METADATA_RELATIONS = { // ... existing entries myEntity : { workspace : null , application : null , parentEntity : { metadataName : 'parentEntity' , foreignKey : 'parentEntityId' , inverseOneToManyProperty : 'myEntities' , // key in ALL_ONE_TO_MANY_METADATA_RELATIONS['parentEntity'], or null if no inverse isNullable : false , universalForeignKey : 'parentEntityUniversalIdentifier' , } , } , } as const ; Derivation dependency graph : ALL_MANY_TO_ONE_METADATA_FOREIGN_KEY ALL_ONE_TO_MANY_METADATA_RELATIONS (foreignKey only) (metadataName, aggregators) │ │ │ FK type + universalFK derivation │ inverseOneToManyProperty keys │ │ └────────────────┬───────────────────────┘ ▼ ALL_MANY_TO_ONE_METADATA_RELATIONS (metadataName, foreignKey, inverseOneToManyProperty, isNullable, universalForeignKey) Rules : workspace: null , application: null — always present, always null (non-syncable relations) inverseOneToManyProperty — must be a key in ALL_ONE_TO_MANY_METADATA_RELATIONS[targetMetadataName] , or null if the target entity doesn't expose an inverse one-to-many relation universalForeignKey — derived from foreignKey by replacing the Id suffix with UniversalIdentifier Optimistic utils resolve flatEntityForeignKeyAggregator / universalFlatEntityForeignKeyAggregator at runtime by looking up inverseOneToManyProperty in ALL_ONE_TO_MANY_METADATA_RELATIONS Checklist Before moving to Step 2: Metadata name added to ALL_METADATA_NAME TypeORM entity created (extends SyncableEntity ) isCustom column added Flat entity type defined Flat entity maps type defined (if needed) Editable properties constant defined Universal and flat action types defined Registered in AllFlatEntityTypesByMetadataName Registered in ALL_ENTITY_PROPERTIES_CONFIGURATION_BY_METADATA_NAME Registered in ALL_ONE_TO_MANY_METADATA_RELATIONS (if entity has one-to-many relations) Registered in ALL_MANY_TO_ONE_METADATA_FOREIGN_KEY Registered in ALL_MANY_TO_ONE_METADATA_RELATIONS TypeScript compiles without errors Next Step Once all types and constants are defined, proceed to: Syncable Entity: Cache & Transform (Step 2/6) For complete workflow, see @creating-syncable-entity rule.