A2UI

Convert A2UI surface operations into generative UI specs.

API Reference

A2uiOperation

A2uiOperation
version"v0.9"

A2uiOperationResult

A2uiOperationResult
stateA2uiState

A2uiState
forEach(callbackfn: (value: A2uiSurfaceState, key: string, map: ReadonlyMap<string, A2uiSurfaceState>) => void, thisArg?: any) => void

get(key: string) => A2uiSurfaceState

has(key: string) => boolean

sizenumber

entries() => MapIterator<[string, A2uiSurfaceState]>

keys() => MapIterator<string>

values() => MapIterator<A2uiSurfaceState>

warningsstring[]

A2uiState

A2uiState
forEach(callbackfn: (value: A2uiSurfaceState, key: string, map: ReadonlyMap<string, A2uiSurfaceState>) => void, thisArg?: any) => void

get(key: string) => A2uiSurfaceState

has(key: string) => boolean

sizenumber

entries() => MapIterator<[string, A2uiSurfaceState]>

keys() => MapIterator<string>

values() => MapIterator<A2uiSurfaceState>

A2uiSurfaceState

A2uiSurfaceState
componentsMap<string, Record<string, unknown>>

Map
clear() => void

delete(key: string) => boolean

forEach(callbackfn: (value: Record<string, unknown>, key: string, map: Map<string, Record<string, unknown>>) => void, thisArg?: any) => void

get(key: string) => Record<string, unknown>

has(key: string) => boolean

set(key: string, value: Record<string, unknown>) => Map<string, Record<string, unknown>>

sizenumber

entries() => MapIterator<[string, Record<string, unknown>]>

keys() => MapIterator<string>

values() => MapIterator<Record<string, unknown>>

dataModelunknown

applyA2uiOperations

applyA2uiOperations
stateA2uiState

A2uiState
forEach(callbackfn: (value: A2uiSurfaceState, key: string, map: ReadonlyMap<string, A2uiSurfaceState>) => void, thisArg?: any) => void

get(key: string) => A2uiSurfaceState

has(key: string) => boolean

sizenumber

entries() => MapIterator<[string, A2uiSurfaceState]>

keys() => MapIterator<string>

values() => MapIterator<A2uiSurfaceState>

operationsunknown

convertSurfaceToUISpec

convertSurfaceToUISpec
surfaceA2uiSurfaceState

A2uiSurfaceState
componentsMap<string, Record<string, unknown>>

Map
clear() => void

delete(key: string) => boolean

forEach(callbackfn: (value: Record<string, unknown>, key: string, map: Map<string, Record<string, unknown>>) => void, thisArg?: any) => void

get(key: string) => Record<string, unknown>

has(key: string) => boolean

set(key: string, value: Record<string, unknown>) => Map<string, Record<string, unknown>>

sizenumber

entries() => MapIterator<[string, Record<string, unknown>]>

keys() => MapIterator<string>

values() => MapIterator<Record<string, unknown>>

dataModelunknown