walkthrough

type ActiveWait struct {
	Project               ProjectIdentity
	AuthorityGeneration   Integer
	ContentPin            ContentPin
	DeclarationSHA256     string
	NarrativeSHA256       string
	TrainingPackageSHA256 string
	WalkthroughID         string
	ChapterID             string
	ChallengeStepID       string
	ChallengeID           string
	ChallengeRevision     Integer
	CheckpointID          string
	AttemptID             string
	SubmissionGeneration  Integer
	Dialogue              DialogueChallengeBinding
}

type AdmittedChallengeStep struct {
	ChapterID    string
	StepID       string
	ChallengeID  string
	Revision     Integer
	CheckpointID string
}

type AdmittedNarrative struct {
	Sidecar    *NarrativeSidecar
	Package    PackageReference
	Locale     NarrativeLocaleChoice
	TextBytes  Integer
	Catalogues []NarrativeCatalogues
	Events     []ResolvedNarrativeEvent
}

type AdmittedTraining struct {
	Declaration           *TrainingDeclaration
	Project               ProjectIdentity
	ContentPin            ContentPin
	DeclarationSHA256     string
	Narrative             AssetReference
	NarrativeSHA256       string
	Package               PackageReference
	TrainingPackageSHA256 string
	WalkthroughID         string
	Chapters              []string
	ChallengeSteps        []AdmittedChallengeStep
	Cases                 []string
}

type AssetExistsCondition struct {
	Asset string
	ID    string
}

type AssetReference struct {
	Path   string
	SHA256 string
	Bytes  Integer
}

type BoardTarget struct {
	BoardID    string
	Parameters []NamedValue
	Tutorial   bool
}

type BoardTutorialCondition struct {
	UntilCard string
}

type BranchPayload struct {
	StepID        string
	CheckpointID  string
	Outcome       string
	Assisted      bool
	TargetEventID string
}

type CameraFocusPayload struct {
	TargetID string
}

type CardTarget struct {
	CardID     string
	Parameters []NamedValue
}

type CatalogueReference struct {
	Locale string
	Path   string
	SHA256 string
	Bytes  Integer
}

type CatalogueResult struct {
	Accepted  bool
	Digest    string
	Catalogue *MessageCatalogue
	Issues    []Issue
}

type ChallengeAwaitValidationPayload struct {
	StepID       string
	CheckpointID string
}

type ChallengeBinding struct {
	ChallengeID string
	Revision    Integer
}

type ChallengePassedCondition struct {
	Checkpoints []CheckpointMapping
}

type ChallengePromptPayload struct {
	StepID string
}

type ChallengeTarget struct {
	ChallengeID string
	Revision    Integer
}

type Chapter struct {
	ID             string
	FormerIDs      []string
	Title          string
	Why            string
	Requires       string
	RequiresReason string
	ContinuesFrom  string
	Readiness      *Condition
	Steps          []Step
	EntryStepID    string
}

type ChatMessagePayload struct {
	ActorID       string
	MessageKey    string
	AttachmentIDs []string
}

type CheckBinding struct {
	Binding           OwnerBindingKey
	CheckID           string
	DefinitionAssetID string
}

type CheckRunCondition struct {
	Outcome string
}

type CheckRunPayload struct {
	CheckID           string
	ReferenceOutcome  string
	ReferenceAssisted bool
}

type CheckTarget struct {
	CheckID string
}

type CheckpointEnvelope struct {
	Project ProjectIdentity
	EnvelopeDraft
}

type CheckpointMapping struct {
	ID         string
	Completion string
}

type CheckpointPayload struct {
	StateKey string
}

type Code string

type CompletionRecord struct {
	Project               ProjectIdentity
	AuthorityGeneration   Integer
	ContentPin            ContentPin
	DeclarationSHA256     string
	NarrativeSHA256       string
	TrainingPackageSHA256 string
	WalkthroughID         string
	ChapterID             string
	ChallengeStepID       string
	ChallengeID           string
	ChallengeRevision     Integer
	CheckpointID          string
	Outcome               string
	Complete              bool
}

type Condition struct {
	Kind             string
	Supported        bool
	ParameterValue   *ParameterValueCondition
	RecordSelected   *RecordSelectedCondition
	QueryRun         *QueryRunCondition
	PanelOpen        *PanelOpenCondition
	FilterApplied    *FilterAppliedCondition
	CheckRun         *CheckRunCondition
	AssetExists      *AssetExistsCondition
	BoardTutorial    *BoardTutorialCondition
	DialogueFinished *DialogueFinishedCondition
	ChallengePassed  *ChallengePassedCondition
}

type ContentPin struct {
	Kind   string
	Commit string
	SHA256 string
}

type Declaration struct {
	Schema   string
	ID       string
	Version  Integer
	Title    string
	Summary  string
	Chapters []Chapter
	Finish   Exit
	Revision string
}

type DeclaredWalkthrough struct {
	ID       string
	Revision string
	Chapters []string
}

type DetectivePayload struct {
	ManifestCaseID string
}

type DialogueChallengeBinding struct {
	Validated       bool
	SegmentID       string
	ChapterID       string
	DialogueStepID  string
	ChallengeStepID string
}

type DialogueFinishedCondition struct{}

type EnvelopeAdmission struct {
	Envelope *CheckpointEnvelope
	Issues   []Issue
}

type EnvelopeDraft struct {
	ProjectRaw            []byte
	AuthorityGeneration   Integer
	ContentPin            ContentPin
	DeclarationSHA256     string
	NarrativeSHA256       string
	TrainingPackageSHA256 string
	WalkthroughID         string
	ChapterID             string
	StepID                string
	ChallengeID           string
	ChallengeRevision     Integer
	CheckpointID          string
	AttemptID             string
	SubmissionGeneration  Integer
	Outcome               string
	Complete              bool
	Assisted              bool
}

type EnvelopeResult struct {
	Draft  *EnvelopeDraft
	Issues []Issue
}

type Error struct {
	Issues []Issue `json:"issues"`
}

type EvidenceRevealPayload struct {
	AssetID string
}

type Exit struct {
	Kind        string
	Chapter     string
	Walkthrough string
	Target      *Target
}

type FilterAppliedCondition struct {
	Field  string
	Equals *Scalar
}

type IncidentTarget struct {
	Incident *Value
}

type Integer string

type Issue struct {
	Code    Code   `json:"code"`
	Path    string `json:"path"`
	Message string `json:"message"`
}

type LocaleCode string

type LocaleError struct {
	Issues []LocaleIssue `json:"issues"`
}

type LocaleIssue struct {
	Code     LocaleCode `json:"code"`
	Subtag   string     `json:"subtag,omitempty"`
	Snapshot string     `json:"snapshot,omitempty"`
	Message  string     `json:"message"`
}

type LocaleResult struct {
	Accepted        bool          `json:"accepted"`
	Tag             string        `json:"tag,omitempty"`
	PrimaryLanguage string        `json:"primaryLanguage,omitempty"`
	Issues          []LocaleIssue `json:"issues,omitempty"`
}

type LogSourceTarget struct {
	Source string
	Stream string
	Filter []NamedValue
}

type MatchDecision struct {
	Verdict MatchVerdict
	Reason  string
}

type MatchVerdict string

type MessageCatalogue struct {
	SchemaVersion Integer
	Locale        string
	Values        map[string]string
}

type NamedValue struct {
	Name  string
	Value Value
}

type NarrativeActor struct {
	ID   string
	Name string
}

type NarrativeAdmissionInput struct {
	Sidecar    NarrativeAssetBytes
	Catalogues []NarrativeAssetBytes
	Request    *string
}

type NarrativeAsset struct {
	ID        string
	MediaType string
	Path      string
	SHA256    string
	Bytes     Integer
}

type NarrativeAssetBytes struct {
	Reference AssetReference
	Bytes     []byte
}

type NarrativeCatalogues struct {
	Locale string
	Values map[string]string
}

type NarrativeEvent struct {
	ID                       string
	ChapterID                string
	Type                     string
	ChatMessage              *ChatMessagePayload
	Detective                *DetectivePayload
	EvidenceReveal           *EvidenceRevealPayload
	ChallengePrompt          *ChallengePromptPayload
	ChallengeAwaitValidation *ChallengeAwaitValidationPayload
	CheckRun                 *CheckRunPayload
	PostmortemRecommend      *PostmortemRecommendPayload
	CameraFocus              *CameraFocusPayload
	Branch                   *BranchPayload
	Checkpoint               *CheckpointPayload
	Presentation             *Presentation
}

type NarrativeInventory struct {
	Binding             OwnerBindingKey
	Assets              []PackageAssetBinding
	Cases               []string
	Incidents           []string
	Checks              []string
	Queries             []string
	Proposals           []string
	PresentationTargets []string
}

type NarrativeLocaleChoice struct {
	RequestedLocale string
	SelectedLocale  string
	Matched         string // exact, primary or fallback
	FallbackLocale  string
}

type NarrativeLocaleResult struct {
	Accepted bool
	Choice   NarrativeLocaleChoice
	Issues   []Issue
}

type NarrativeOwnerContext interface {
	TrainingOwnerContext
	// AdmitNarrativeInventory returns one coherent package snapshot for the
	// current admission. The caller must keep it stable for the whole call;
	// a changed reread refuses rather than mixing inventories.
	AdmitNarrativeInventory(ref PackageReference) (NarrativeInventory, error)
	// AdmitCheck resolves an owner-valid package Check within the exact
	// admitted package binding.
	AdmitCheck(ref PackageReference, checkID string) (CheckBinding, error)
	// AdmitProposal resolves one package proposal within the exact admitted
	// package binding.
	AdmitProposal(ref PackageReference, proposalID string) (ProposalBinding, error)
	// AdmitPresentationTarget resolves one registered presentation target and
	// its already-validated typed closure.
	AdmitPresentationTarget(ref PackageReference, targetID string) (PresentationTargetBinding, error)
}

type NarrativeResolution struct {
	Admitted  bool
	Narrative *AdmittedNarrative
	Issues    []Issue
}

type NarrativeResult struct {
	Accepted bool
	Digest   string
	Sidecar  *NarrativeSidecar
	Issues   []Issue
}

type NarrativeSegment struct {
	ID                          string
	ChapterID                   string
	StepID                      string
	EventIDs                    []string
	PrerequisiteContextEventIDs []string
}

type NarrativeSidecar struct {
	SchemaVersion     Integer
	ScenarioID        string
	Revision          Integer
	Locale            string
	FallbackLocale    string
	MessageCatalogues []CatalogueReference
	ChapterRefs       []string
	Actors            []NarrativeActor
	Assets            []NarrativeAsset
	Segments          []NarrativeSegment
	Events            []NarrativeEvent
}

type OwnerBindingKey struct {
	Project           ProjectIdentity
	ContentPin        ContentPin
	DeclarationSHA256 string
	Package           PackageReference
}

type PackageAssetBinding struct {
	AssetID   string
	Kind      string
	Reference AssetReference
	Bytes     Integer
}

type PackageInventory struct {
	Ref    PackageReference
	Assets []AssetReference
	Cases  []string
}

type PackageReference struct {
	ID       string
	Revision Integer
	Path     string
	SHA256   string
	Bytes    Integer
}

type PanelOpenCondition struct {
	Panel string
}

type ParameterValueCondition struct {
	Name   string
	Equals *Scalar
}

type PostmortemRecommendPayload struct {
	ProposalID string
}

type Presentation struct {
	DelayBeforeMs             int
	PauseAfterMs              int
	TypingSpeedPreset         string
	TypingSpeedCharsPerSecond int
	TypingIndicator           bool
	Transition                string
	CameraTargetID            string
}

type PresentationClosure struct {
	Kind     string
	ID       string
	Check    *CheckBinding
	Proposal *ProposalBinding
}

type PresentationTargetBinding struct {
	Binding  OwnerBindingKey
	TargetID string
	Kind     string
	RefID    string
	Closure  *PresentationClosure
}

type ProjectAuthority interface {
	// BindProject admits a canonical project URL or reference spelling and
	// reports the owner's verdicts.
	BindProject(raw string) (ProjectBinding, error)
	// AdmitProject admits an opaque project-reference JSON value, as carried by
	// an external checkpoint envelope, and returns only its snapshot.
	AdmitProject(raw []byte) (ProjectIdentity, error)
	// EqualProject is the owner's full identity equality; this package never
	// compares opaque identities by itself.
	EqualProject(a, b ProjectIdentity) bool
}

type ProjectBinding struct {
	Identity ProjectIdentity
	// CanonicalURL is the owner's one canonical address of the project.
	CanonicalURL string
	// Public is the owner-established public-scope verdict. A URL spelling never
	// implies it.
	Public bool
	// Commit is the exact lowercase 40-hex commit the reference pins, or "" when
	// the reference does not name an immutable Git commit (a branch, HEAD, the
	// default branch or a non-Git source).
	Commit string
	// DigestAddressed reports whether the source serves exact bytes by content
	// digest (cloud/local), which is the only valid content pin for it.
	DigestAddressed bool
}

type ProjectIdentity struct {
	Value any
}

type ProposalBinding struct {
	Binding      OwnerBindingKey
	ProposalID   string
	Kind         string
	DefinitionID string
	EvidenceIDs  []string
	Rationale    string
}

type PublicDataProviderTarget struct {
	Provider string
}

type QueryRunCondition struct {
	MinRows *Integer
}

type QueryTarget struct {
	QueryID    string
	Parameters []NamedValue
}

type RecordSelectedCondition struct {
	Field  string
	Equals *Scalar
}

type RegistryAdmission struct {
	Route  *RouteDescriptor
	Issues []Issue
}

type RelatedTarget struct {
	Source  string
	Table   string
	Key     []NamedValue
	Meaning string
}

type Resolution struct {
	Admitted bool
	Bundle   *AdmittedTraining
	Issues   []Issue
}

type ResolvedMessage struct {
	Key          string
	Text         string
	Locale       string
	FromFallback bool
}

type ResolvedNarrativeEvent struct {
	ID                 string
	ChapterID          string
	Type               string
	Message            *ResolvedMessage
	Check              *CheckBinding
	Proposal           *ProposalBinding
	PresentationTarget *PresentationTargetBinding
}

type Result struct {
	Accepted    bool         `json:"accepted"`
	NewerClient bool         `json:"newerClient"`
	Digest      string       `json:"digest"`
	Definition  *Declaration `json:"definition,omitempty"`
	Issues      []Issue      `json:"issues,omitempty"`
}

type RouteDescriptor struct {
	StoryID           string
	Revision          Integer
	ProjectURL        string
	WalkthroughID     string
	ChapterID         string
	ContentPin        ContentPin
	DeclarationSHA256 string
}

type Scalar struct {
	Kind   ScalarKind
	Bool   bool
	Number string
	Text   string
}

type ScalarKind string

type SourceContext struct {
	Project           ProjectIdentity
	ContentPin        ContentPin
	DeclarationSHA256 string
}

type Step struct {
	ID        string
	Kind      string
	SegmentID string
	Title     string
	Why       string
	Hint      string
	Modes     []string
	Target    Target
	Done      Condition
	Capture   string
	Needs     string
	Support   Support
}

type StoryRegistryEntry struct {
	StoryID           string
	Revision          Integer
	ProjectURL        string
	WalkthroughID     string
	ContentPin        ContentPin
	DeclarationSHA256 string
}

type StoryRegistryResult struct {
	Entry  *StoryRegistryEntry
	Issues []Issue
}

type Support string

type TableRecordTarget struct {
	Source string
	Table  string
	Key    []NamedValue
}

type Target struct {
	Kind               string
	Supported          bool
	TableRecord        *TableRecordTarget
	Query              *QueryTarget
	Board              *BoardTarget
	Card               *CardTarget
	Related            *RelatedTarget
	LogSource          *LogSourceTarget
	PublicDataProvider *PublicDataProviderTarget
	Incident           *IncidentTarget
	Check              *CheckTarget
	None               *struct{}
	Challenge          *ChallengeTarget
	TrainingCase       *TrainingCaseTarget
}

type TrainingCaseTarget struct {
	ManifestCaseID  string
	TrainingPackage PackageReference
}

type TrainingDeclaration struct {
	Schema          string
	ID              string
	Version         Integer
	Title           string
	Summary         string
	TrainingPackage PackageReference
	Narrative       AssetReference
	Chapters        []Chapter
	Finish          Exit
	Revision        string
}

type TrainingOwnerContext interface {
	// AdmitPackage returns the exact admitted package and its declared asset and
	// Case inventory.
	AdmitPackage(ref PackageReference) (PackageInventory, error)
	// AdmitAsset admits one exact project-relative asset reference.
	AdmitAsset(ref AssetReference) error
	// AdmitChallenge resolves the exact challenge manifest through the challenge
	// owner. A manifest that has not passed the owning validator is not admitted.
	AdmitChallenge(challengeID string, revision Integer) (ChallengeBinding, error)
}

type TrainingResult struct {
	Accepted    bool                 `json:"accepted"`
	NewerClient bool                 `json:"newerClient"`
	Digest      string               `json:"digest"`
	Definition  *TrainingDeclaration `json:"definition,omitempty"`
	Issues      []Issue              `json:"issues,omitempty"`
}

type Value struct {
	Captured string
	Literal  *Scalar
	Default  *Scalar
}