Skip to main content

Glossary

TermDefinition
ModuleSelf-contained package delivering pages, APIs, entities, subscribers, and DI registrations. Resides under packages/*/src/modules/<module> or src/modules/<module>.
OverlayApp-level override for a module file. Any file in src/modules/<module> replaces the package implementation with the same relative path.
GeneratorScript invoked by npm run modules:prepare that scans modules and emits modules.generated.ts, entities.generated.ts, and di.generated.ts.
Query EngineService that retrieves records and custom fields via a unified API. Lives inside the DI container as queryEngine.
Data EngineService that persists writes (especially custom fields) and emits events after successful operations.
Custom EntityRuntime-defined entity managed by the entities module, often backed by EAV tables.
Feature flagString identifier declared in acl.ts that can be required by pages, APIs, and widgets.
SubscriberModule-defined function that reacts to events emitted through the event bus. Discovered automatically and executed asynchronously.
Tenant / OrganizationContext objects attached to each request to preserve data isolation in multi-tenant deployments.
Dashboard widgetClient component discovered from modules and rendered on the admin dashboard.

Refer back to this glossary when onboarding teammates or writing documentation for your own modules.