botswizard

type Step struct {
	// Key is the wizard-param key the parsed value is stored under and the key
	// it is later read from in Values. Must not start with "_wz".
	Key string
	// Prompt is the question shown when the step is entered (HTML allowed).
	Prompt string
	// Parse validates and normalizes the raw user text into the value to store.
	// Returning an error re-prompts the SAME step with the error text shown
	// above the prompt. A nil Parse stores the trimmed text as-is.
	Parse func(raw string) (stored string, err error)
}

type Values map[string]string

type Wizard struct {
	// Code is the command code (also the AwaitingReplyTo path). Unique per bot.
	Code botsfw.CommandCode
	// Steps are asked in order.
	Steps []Step
	// OnComplete runs after the last step with all collected values. Its
	// message is returned to the user. State is already cleared when it runs.
	OnComplete func(whc botsfw.WebhookContext, v Values) (botmsg.MessageFromBot, error)
	// Intro is optional text prepended to the first prompt.
	Intro string
	// TTL, if > 0, abandons the wizard when this long passes since Start.
	TTL time.Duration
	// CancelText / TimeoutText override the default end messages.
	CancelText  string
	TimeoutText string
	// Now overrides the clock for TTL (tests); nil = time.Now.
	Now func() time.Time
}