Skip to content

Realm Consumer Projection

When a Nimi app reads Realm data, what it receives through the SDK is a typed local view of that data. That view is not a second source of Realm truth, and it is not a local copy of Realm's domain model.

Apps, Runtime, Desktop, and Web all read Realm through the SDK's typed clients. Local state may cache or display what Realm returned, but it can never become the truth itself.

Consumer Rules

ConcernBoundary
Generated API inputComes from the configured external Realm OpenAPI source
SDK facadeMay wrap generated operations with typed fail-closed behavior
Runtime/Desktop projectionMay present Realm output, but cannot synthesize Realm success
App wrappersMay adapt SDK output for product UI, but cannot redefine Realm semantics

When Realm API drift appears, regenerate the SDK core from the configured Realm input and update consumer contracts/tests. Do not patch drift by copying Realm spec text into this repository or by freezing handwritten DTOs.

Source Basis

Documentation for Nimi — the installable, open-source, local-first personal AI product.