Patterns

Reference for every r.{pattern}(…) call the framework provides. Listed alphabetically.

Pattern	What it does
`r.authClaims(...)`	Inject identity facts into the JWT
`r.claimKey(...)`	Declare a claim key for auth claims
`r.config(...)`	Declare per-tenant config keys
`r.defineEvent(...)`	Define an event type for event sourcing
`r.describe(...)`	Describe a feature’s purpose and contracts
`r.entity(...)`	Declare an event-sourced entity
`r.entityHook(...)`	Hook into entity lifecycle events
`r.envSchema(...)`	Declare env-var schema for a feature
`r.eventMigration(...)`	Migrate event schemas over time
`r.exposesApi(...)`	Expose an API for other features
`r.extendsRegistrar(...)`	Extend the registrar with custom methods
`r.hook(...)`	Register lifecycle hooks
`r.httpRoute(...)`	Mount an HTTP route outside the dispatcher
`r.job(...)`	Declare a background job
`r.metric(...)`	Declare a metric
`r.multiStreamProjection(...)`	Project across multiple event streams
`r.nav(...)`	Register navigation items
`r.notification(...)`	Declare a notification template
`r.optionalRequires(...)`	Optional feature dependency
`r.projection(...)`	Declare a single-stream projection
`r.queryHandler(...)`	Register a query handler
`r.readsConfig(...)`	Declare config key access
`r.referenceData(...)`	Declare reference data
`r.relation(...)`	Declare a relation between entities
`r.requires(...)`	Declare a required feature dependency
`r.screen(...)`	Register a UI screen
`r.secret(...)`	Declare a secret key
`r.systemScope(...)`	Scope a feature to system identity
`r.toggleable(...)`	Make a feature toggleable
`r.translations(...)`	Declare i18n translations
`r.tree(...)`	Declare a tree structure entity
`r.treeActions(...)`	Register tree-specific actions
`r.unknown(...)`	Handle unknown patterns
`r.useExtension(...)`	Use a framework extension
`r.usesApi(...)`	Consume another feature’s API
`r.workspace(...)`	Declare a workspace
`r.writeHandler(...)`	Register a write handler