PromptRunner.Plan (PromptRunnerSDK v0.6.1)

Copy Markdown View Source

Fully resolved execution plan used by the PromptRunner runtime.

Summary

Types

callbacks()

@type callbacks() :: %{
  optional(:on_event) => (map() -> term()) | nil,
  optional(:on_prompt_started) => (map() -> term()) | nil,
  optional(:on_prompt_completed) => (map() -> term()) | nil,
  optional(:on_prompt_failed) => (map() -> term()) | nil,
  optional(:on_run_completed) => (map() -> term()) | nil
}

t()

@type t() :: %PromptRunner.Plan{
  callbacks: callbacks(),
  commit_messages: %{optional({String.t(), String.t() | nil}) => String.t()},
  committer: {module(), keyword()},
  config: PromptRunner.Config.t(),
  input_type: PromptRunner.RunSpec.input_type(),
  interface: :api | :cli | :legacy,
  prompts: [PromptRunner.Prompt.t()],
  runtime_store: {module(), term()},
  source: module(),
  source_input: term(),
  source_root: String.t() | nil,
  state_dir: String.t() | nil
}

Functions

build(run_spec)

@spec build(PromptRunner.RunSpec.t()) :: {:ok, t()} | {:error, term()}

with_overrides(plan, opts)

@spec with_overrides(
  t(),
  keyword()
) :: t()