#Module: routes/authoring

#Type Aliases

#EventContext

EventContext<Event> = AgentEventRouteProps<Event> & Pick<AgentRequestContext, "provider" | "process"> & object

#Type Declaration

#render

readonly render: (module, data) => Extract<EventHandlerResult, { outcome: "render"; }>

#Parameters

#module

string

#data

JsonValue

#Returns

Extract<EventHandlerResult, { outcome: "render"; }>

#Type Parameters

#Event

Event extends CanonicalAgentEvent = CanonicalAgentEvent

---

#EventHandler

EventHandler<Event> = (context) => EventResult<Event> | Promise<EventResult<Event>>

#Type Parameters

#Event

Event extends CanonicalAgentEvent = CanonicalAgentEvent

#Parameters

#context

EventContext<Event>

#Returns

EventResult<Event> | Promise<EventResult<Event>>

---

#EventResult

EventResult<Event> = Extract<EventHandlerResult, { outcome: "render"; }> | void | Extract<EventHandlerResult<JsonValue, Event>, { outcome: "continue"; }> | Event extends DenyingEvent ? Extract<EventHandlerResult, { outcome: "deny"; }> : never

#Type Parameters

#Event

Event extends CanonicalAgentEvent = CanonicalAgentEvent

#Variables

#defineTool

const defineTool: <Input, Result>(config, handler) => (props) => Promise<ReactNode> & ToolConfig & object

One inferred handler; the generated projections own parsing and result validation.

#Type Parameters

#Input

Input extends RouteSchema

#Result

Result extends RouteSchema

#Parameters

#config

ToolConfig & object

#handler

(input, context) => ReactNode | Promise<ReactNode>

#Returns

(props) => Promise<ReactNode> & ToolConfig & object

---

#events

const events: Events

Canonical event families, inferred from the same catalog the adapters project.

#References

#AgentEventCanonicalIdentity

Re-exports AgentEventCanonicalIdentity

---

#AgentEventDelivery

Re-exports AgentEventDelivery

---

#AgentEventFallbackMode

Re-exports AgentEventFallbackMode

---

#AgentEventNativePayload

Re-exports AgentEventNativePayload

---

#AgentEventPayload

Re-exports AgentEventPayload

---

#AgentEventPayloadField

Re-exports AgentEventPayloadField

---

#AgentEventPayloadFieldKind

Re-exports AgentEventPayloadFieldKind

---

#agentEventPayloadFieldKinds

Re-exports agentEventPayloadFieldKinds

---

#AgentEventPayloadFieldName

Re-exports AgentEventPayloadFieldName

---

#agentEventPayloadFields

Re-exports agentEventPayloadFields

---

#AgentEventPayloadFields

Re-exports AgentEventPayloadFields

---

#AgentEventPayloadFieldTypes

Re-exports AgentEventPayloadFieldTypes

---

#AgentEventPayloadHost

Re-exports AgentEventPayloadHost

---

#AgentEventPayloadNativeKey

Re-exports AgentEventPayloadNativeKey

---

#agentEventPayloadNativeKeys

Re-exports agentEventPayloadNativeKeys

---

#AgentEventProvenance

Re-exports AgentEventProvenance

---

#AgentEventRouteConfig

Re-exports AgentEventRouteConfig

---

#AgentEventRouteProps

Re-exports AgentEventRouteProps

---

#AgentEventRuntimeMode

Re-exports AgentEventRuntimeMode

---

#AgentLayoutRoute

Re-exports AgentLayoutRoute

---

#AgentLayoutRouteKind

Re-exports AgentLayoutRouteKind

---

#AgentProviderContext

Re-exports AgentProviderContext

---

#AgentProviderFactory

Re-exports AgentProviderFactory

---

#AgentProviderHostIdentity

Re-exports AgentProviderHostIdentity

---

#AgentProviderLineage

Re-exports AgentProviderLineage

---

#AgentProviderLineagePeer

Re-exports AgentProviderLineagePeer

---

#AgentProviderLineageResolution

Re-exports AgentProviderLineageResolution

---

#AgentProviderLineageSubagent

Re-exports AgentProviderLineageSubagent

---

#AgentProviderLineageTree

Re-exports AgentProviderLineageTree

---

#AgentProviderNotice

Re-exports AgentProviderNotice

---

#AgentProviderNoticeAttempt

Re-exports AgentProviderNoticeAttempt

---

#AgentProviderNoticePublisher

Re-exports AgentProviderNoticePublisher

---

#AgentProviderNoticeRecipient

Re-exports AgentProviderNoticeRecipient

---

#AgentProviderNoticesHandle

Re-exports AgentProviderNoticesHandle

---

#AgentProviderNoticeState

Re-exports AgentProviderNoticeState

---

#AgentProviderNoticeWithholding

Re-exports AgentProviderNoticeWithholding

---

#AgentProviderObserved

Re-exports AgentProviderObserved

---

#AgentProviderObservedPluginRoot

Re-exports AgentProviderObservedPluginRoot

---

#AgentProviderPluginRoot

Re-exports AgentProviderPluginRoot

---

#AgentProviderSessionIdentity

Re-exports AgentProviderSessionIdentity

---

#AgentProviderStateHandle

Re-exports AgentProviderStateHandle

---

#AgentProviderStateSnapshot

Re-exports AgentProviderStateSnapshot

---

#AgentProviderWorkspaceIdentity

Re-exports AgentProviderWorkspaceIdentity

---

#AgentTerminal

Re-exports AgentTerminal

---

#AgentTerminalColor

Re-exports AgentTerminalColor

---

#AgentTerminalStream

Re-exports AgentTerminalStream

---

#AgentTerminalStreamKind

Re-exports AgentTerminalStreamKind

---

#AgentTerminalSurface

Re-exports AgentTerminalSurface

---

#appResourceUri

Re-exports appResourceUri

---

#AppRouteConfig

Re-exports AppRouteConfig

---

#CanonicalAgentEvent

Re-exports CanonicalAgentEvent

---

#canonicalAgentEvents

Re-exports canonicalAgentEvents

---

#CliProjectionConfig

Re-exports CliProjectionConfig

---

#CliProjectionFlagConfig

Re-exports CliProjectionFlagConfig

---

#CliProjectionFlagDefault

Re-exports CliProjectionFlagDefault

---

#CliRouteConfig

Re-exports CliRouteConfig

---

#CliRouteProps

Re-exports CliRouteProps

---

#ExecutableMainContext

Re-exports ExecutableMainContext

---

#MAX_ROUTE_RENDER_ELAPSED_MS

Re-exports MAX_ROUTE_RENDER_ELAPSED_MS

---

#PromptConfig

Re-exports PromptConfig

---

#ResourceConfig

Re-exports ResourceConfig

---

#RouteMeta

Re-exports RouteMeta

---

#RouteRenderConfig

Re-exports RouteRenderConfig

---

#RouteSchema

Re-exports RouteSchema

---

#RouteSchemaInputKey

Re-exports RouteSchemaInputKey

---

#RouteSchemaOutput

Re-exports RouteSchemaOutput

---

#RouteUiMeta

Re-exports RouteUiMeta

---

#ScriptRouteProps

Re-exports ScriptRouteProps

---

#ToolConfig

Re-exports ToolConfig

---

#ToolExecutionConfig

Re-exports ToolExecutionConfig

---

#ToolRouteProps

Re-exports ToolRouteProps

---

#ToolTaskSupport

Re-exports ToolTaskSupport