Prometheus Entity Management API
    Preparing search index...

    The React runtime: the shared core with the official React catalog as its default. Behavior is the core's; only the default catalog is added here.

    Hierarchy

    Index
    getSurfaces: () => readonly SurfaceModel<
        PrometheusA2uiComponentImplementation,
        FunctionImplementation,
    >[]
    processor: MessageProcessor<PrometheusA2uiComponentImplementation>
    subscribe: (listener: () => void) => () => void
    • Apply what a server returned when it rejected an action as stale: the operations since the version the client held, with the versions they bring each surface to. They go through the same ordering and limits as any activity, so a repeated rejection changes nothing. A rejection that carries no operations cannot repair the surface, so it requests a resync. The wire shape is documented in stale-action.ts.

      Parameters

      • input: unknown

      Returns void

    • Returns void

    • Export a surface as messages that rebuild it in a fresh runtime: catalog, theme, sendDataModel, every component (with its own catalog where it differs), the data model and, for a v1.0 surface, its wantResponse and responsePath action metadata. Components unreachable from root are pruned and reported in orphans; pass { pruneOrphans: false } to keep them. Exporting the rebuilt surface again yields the same messages.

      Parameters

      • surfaceId: string
      • Optionaloptions: SurfaceExportOptions

      Returns PrometheusA2uiSurfaceExport

    • Parameters

      • Optionaloptions: { includeInlineCatalogs?: boolean }

      Returns A2uiClientCapabilities

    • Returns
          | {
              surfaces: Record<string, Record<string, any>>;
              version: "v0.9" | "v0.9.1";
          }
          | undefined

    • The version held for each surface with versioned state. A host that reconnects reports these upstream so the agent resends only what is missing.

      Returns PrometheusA2uiHeldVersions

    • Held usage against each state limit, for hosts that show how close they are.

      Returns PrometheusA2uiLimitUsage

    • forwardedProps for the next run input, reporting the held versions.

      Returns PrometheusA2uiForwardedProps

    • Consume the AG-UI A2UI activity convention: ACTIVITY_SNAPSHOT, activity type a2ui-surface, operations in content.a2ui_operations. Delivery is idempotent: a redelivered activity changes nothing, and a surface is only ever deleted by an explicit deleteSurface operation.

      Parameters

      • input: unknown

      Returns boolean

    • Validate and process official v0.9.1 or v1.0 RC messages in order.

      Parameters

      Returns void

    • Resend an executed action under the same actionId. The runtime owns the retry: a host that resent on its own would mint a new id and defeat the server's idempotency. The resent envelope is the original, so its heldVersion and data model are those from when the action fired. Returns false when the id is unknown (never emitted here, or forgotten past the retained-action bound) or no onActionEnvelope handler is installed.

      Parameters

      • actionId: string

      Returns Promise<boolean>

    • Change some limits while the runtime is running. Applies to future calls only and never evicts a surface already held. A cap lowered below what is held refuses calls that would grow past it, but still allows calls that shrink or hold steady, so the host can get back under the cap.

      Parameters

      Returns void