Codex.Events (Codex SDK v0.6.0)

Copy Markdown View Source

Typed event structs emitted during Codex turn execution.

Provides helpers to parse JSON-decoded maps into strongly typed structs and to convert structs back into protocol maps for encoding.

Summary

Types

t()

Functions

parse!(map)

Parses a JSON-decoded map into a typed event struct, raising on unknown event types.

to_map(event)

Converts a typed event struct back into the JSON-serializable map representation.

Types

t()

@type t() ::
  Codex.Events.ThreadStarted.t()
  | Codex.Events.TurnStarted.t()
  | Codex.Events.TurnContinuation.t()
  | Codex.Events.TurnCompleted.t()
  | Codex.Events.ThreadTokenUsageUpdated.t()
  | Codex.Events.TurnDiffUpdated.t()
  | Codex.Events.TurnPlanUpdated.t()
  | Codex.Events.TurnCompaction.t()
  | Codex.Events.ItemAgentMessageDelta.t()
  | Codex.Events.ItemInputTextDelta.t()
  | Codex.Events.ItemCompleted.t()
  | Codex.Events.ItemStarted.t()
  | Codex.Events.ItemUpdated.t()
  | Codex.Events.CommandOutputDelta.t()
  | Codex.Events.FileChangeOutputDelta.t()
  | Codex.Events.TerminalInteraction.t()
  | Codex.Events.ReasoningDelta.t()
  | Codex.Events.ReasoningSummaryDelta.t()
  | Codex.Events.ReasoningSummaryPartAdded.t()
  | Codex.Events.AppServerNotification.t()
  | Codex.Events.McpToolCallProgress.t()
  | Codex.Events.McpServerOauthLoginCompleted.t()
  | Codex.Events.AccountUpdated.t()
  | Codex.Events.AccountRateLimitsUpdated.t()
  | Codex.Events.AccountLoginCompleted.t()
  | Codex.Events.WindowsWorldWritableWarning.t()
  | Codex.Events.DeprecationNotice.t()
  | Codex.Events.RawResponseItemCompleted.t()
  | Codex.Events.Error.t()
  | Codex.Events.TurnFailed.t()
  | Codex.Events.ToolCallRequested.t()
  | Codex.Events.ToolCallCompleted.t()
  | Codex.Events.SessionConfigured.t()
  | Codex.Events.Warning.t()
  | Codex.Events.ContextCompacted.t()
  | Codex.Events.ThreadRolledBack.t()
  | Codex.Events.RequestUserInput.t()
  | Codex.Events.McpStartupUpdate.t()
  | Codex.Events.McpStartupComplete.t()
  | Codex.Events.ElicitationRequest.t()
  | Codex.Events.UndoStarted.t()
  | Codex.Events.UndoCompleted.t()
  | Codex.Events.TurnAborted.t()
  | Codex.Events.ShutdownComplete.t()
  | Codex.Events.EnteredReviewMode.t()
  | Codex.Events.ExitedReviewMode.t()
  | Codex.Events.ConfigWarning.t()
  | Codex.Events.CollabAgentSpawnBegin.t()
  | Codex.Events.CollabAgentSpawnEnd.t()
  | Codex.Events.CollabAgentInteractionBegin.t()
  | Codex.Events.CollabAgentInteractionEnd.t()
  | Codex.Events.CollabWaitingBegin.t()
  | Codex.Events.CollabWaitingEnd.t()
  | Codex.Events.CollabCloseBegin.t()
  | Codex.Events.CollabCloseEnd.t()

Functions

parse!(map)

@spec parse!(map()) :: t()

Parses a JSON-decoded map into a typed event struct, raising on unknown event types.

to_map(event)

@spec to_map(t()) :: map()

Converts a typed event struct back into the JSON-serializable map representation.