syncable-entity-runner-and-actions
Syncable Entity: Runner & Actions (Step 4/6)
Purpose: Execute migration actions against the database with proper transpilation from universal to flat entities.
When to use: After completing Steps 1-3 (Types, Cache, Builder). Required before integration.
Quick Start
This step creates:
- Create action handler
- Update action handler
- Delete action handler
- Universal-to-flat conversion utilities
Key pattern: Each handler has two phases:
- Transpilation: Universal action → Flat action
- Execution: Flat action → Database operation
More from twentyhq/twenty
syncable-entity-cache-and-transform
Create cache services and transformation utilities for syncable entities in Twenty. Use when implementing entity-to-flat conversions, input DTO transpilation to universal flat entities, or cache recomputation for syncable entities.
39syncable-entity-testing
Create comprehensive integration tests for syncable entities in Twenty. Use when writing integration tests for metadata entities, covering validator exceptions, input transpilation errors, and CRUD operations. Tests are MANDATORY for all syncable entities.
38syncable-entity-types-and-constants
Define types, entities, and central constant registrations for syncable entities in Twenty's workspace migration system. Use when creating new syncable entities, defining TypeORM entities, flat entity types, or registering in central constants (ALL_ENTITY_PROPERTIES_CONFIGURATION_BY_METADATA_NAME, ALL_ONE_TO_MANY_METADATA_RELATIONS, ALL_MANY_TO_ONE_METADATA_FOREIGN_KEY, ALL_MANY_TO_ONE_METADATA_RELATIONS).
38syncable-entity-integration
Wire syncable entity services into NestJS modules, create service layer and resolvers for Twenty entities. Use when registering builders, validators, and action handlers in modules, creating business services, or exposing entities via GraphQL API with proper exception handling.
37syncable-entity-builder-and-validation
Create validation logic and migration action builders for syncable entities in Twenty. Use when implementing business rule validation, uniqueness checks, foreign key validation, or building workspace migration actions for syncable entities. Validators never throw and never mutate.
36