DomainRegistryClient

Defined in: js-api/src/dapi.ts:1166

Reflection over the client-side domain registry (see DomainsDataSource.registry): schemas → tables → columns → Property metadata, loaded once per session and shared with the built-in domain UI. Tables are addressed as '<schema>.<table>'.

Constructors

Constructor

new DomainRegistryClient(): DomainRegistryClient

Returns

DomainRegistryClient

Methods

resolveNames()

resolveNames(table, ids): Promise<{[id: string]: string | null; }>

Defined in: js-api/src/dapi.ts:1195

Batched display-name resolution for row [ids] of [table] (the standard display identity: name-column value → dash-joined business key → id). Requests coalesce client-side into one narrow fetch per table, and every id is cached afterwards — cheap to call per cell/render. EVERY requested id is present as a key; the unresolvable ones (invisible, unknown, nameless) map to null rather than being omitted, so ids.map((id) => names[id]) is always aligned.

Parameters

Parameter	Type
table	string
ids	string[]

Returns

Promise<{[id: string]: string | null; }>

---

rowProperties()

rowProperties(table): Promise<Property[]>

Defined in: js-api/src/dapi.ts:1175

Property objects describing the table's declared columns — the same runtime metadata (type, semType, choices, min/max, nullable, defaultValue) that drives the built-in row editor and server-side validation, get/set-bound to DomainRow values. friendlyName carries the label the platform renders ('Project' for a project_id reference), so reflective forms label fields like the built-in surfaces do. Treat the objects as read-only — they are shared with the client-side registry. Rejects with a DomainValidationError for unknown tables.

Parameters

Parameter	Type
table	string

Returns

Promise<Property[]>

---

tableInfo()

tableInfo(table): Promise<DomainTableInfo>

Defined in: js-api/src/dapi.ts:1184

Registry metadata of one table: display identity (nameColumn, businessKey, singular/plural names), the schema.json description, security mode, audit flag, and the FK-inverted DomainChildTableRef list that drives detail-table links.

Parameters

Parameter	Type
table	string

Returns

Promise<DomainTableInfo>