@mocanvas/editor · interface

UserSchemaInfo

interface UserSchemaInfo

What a schema is told about the user record type.

Attribution is the reason this exists: an app that shows "created by" on a shape has to store *something* about the person, and what that something is differs per app — an email here, a tenant-scoped id there, a display name and an avatar url somewhere else. Rather than guess, the schema takes the app's own fields and validates them.

Purely local: nothing here talks to a service. The host app resolves ids to people however it already does.


Properties · 2

readonly migrations?: PropsMigrations | MigrationSequence | undefined

Migrations for those fields, as user records already in documents change.

readonly props?: UnknownRecordProps | undefined

One validator per user field the app wants persisted.

mocanvas is built by Symbio. Free for non-commercial, non-profit and development use; commercial use needs an agreement. Not affiliated with or endorsed by tldraw.