What problem does it solve?
Use when defining or editing schema.graphql. Entity types, scalar types, enums, relationships, @derivedFrom, @index, @config directives, array rules, naming conventions, and schema-to-TypeScript type mapping.
Core Features & Use Cases
- Schema rules for entity definitions: every type is an entity; no @entity decorator; id: ID! must be first; relationships use the entity type directly; codegen appends _id to reference fields.
- Scalar and enum mappings: support ID!, String!, Int!, Float!, Boolean!, BigInt!, BigDecimal!, Bytes!, Timestamp!, Json! and enum declarations; mapping to TypeScript types is handled via codegen.
- Directives and indexing: @derivedFrom, @index, and @config directives to model relationships, query optimization, and numeric precision.
- Array and relationship rules: guidelines for arrays like [Type!]! and proper derivedFrom usage to enable correct codegen.
- Deep documentation: reference to HyperIndex docs for comprehensive behavior.
Quick Start
Create or update your schema.graphql to define entities with proper id placement, correct relationships, and mappings to TypeScript types via codegen.