mihistory

type BodiesResponse struct {
	InstanceKey uint64 `json:"instanceKey"`
	// ProcessDefinitionKey and InstanceState describe the instance itself, so a
	// client can draw its diagram and state without the full timeline.
	ProcessDefinitionKey uint64     `json:"processDefinitionKey"`
	InstanceState        string     `json:"instanceState"`
	ParentIterationKey   uint64     `json:"parentIterationKey,omitempty"`
	HighWaterPosition    uint64     `json:"highWaterPosition"`
	Bodies               []BodyView `json:"bodies"`
	NextCursor           string     `json:"nextCursor,omitempty"`
}

type BodyResponse struct {
	InstanceKey uint64   `json:"instanceKey"`
	Body        BodyView `json:"body"`
}

type BodyView struct {
	BodyElementInstanceKey uint64 `json:"bodyElementInstanceKey"`
	ElementID              string `json:"elementId"`
	ProcessDefinitionKey   uint64 `json:"processDefinitionKey"`
	// Mode is "parallel", "sequential" or "loop" (a standard loop) as the
	// definition version that ran the body declares, "unknown" when that
	// version is no longer deployed.
	Mode               string `json:"mode"`
	State              string `json:"state"`
	ActivationPosition uint64 `json:"activationPosition"`
	EndPosition        uint64 `json:"endPosition,omitempty"`
	ParentIterationKey uint64 `json:"parentIterationKey,omitempty"`
	TokenID            uint64 `json:"tokenId"`
	ParentTokenID      uint64 `json:"parentTokenId"`
	// Iterations counts the iterations seeded so far. A sequential body seeds
	// one at a time, so while it runs this is not its planned total; the
	// planned total is not a recorded fact and is not reported.
	Iterations              uint64 `json:"iterations"`
	Active                  uint64 `json:"active"`
	Completed               uint64 `json:"completed"`
	Terminated              uint64 `json:"terminated"`
	IncidentsRaised         uint64 `json:"incidentsRaised"`
	IterationsWithIncidents uint64 `json:"iterationsWithIncidents"`
	// OpenIncidents is set on the single-body route only: incidents attributed
	// to this body that are open now. OpenIncidentsExact is false when more
	// were attributed than one request verifies.
	OpenIncidents      *int  `json:"openIncidents,omitempty"`
	OpenIncidentsExact *bool `json:"openIncidentsExact,omitempty"`
}

type DecisionView struct {
	DecisionID         string          `json:"decisionId"`
	ElementInstanceKey uint64          `json:"elementInstanceKey"`
	Position           uint64          `json:"position"`
	At                 int64           `json:"at"`
	DecisionKey        uint64          `json:"decisionKey,omitempty"`
	Inputs             json.RawMessage `json:"inputs"`
	Outputs            json.RawMessage `json:"outputs"`
	// Trace is the rule trace, only with ?technical=true: it is detail for the
	// person who asks for it, not the default reading.
	Trace json.RawMessage `json:"trace,omitempty"`
}

type Definitions func(processDefKey uint64) *compiler.CompiledProcess

type IncidentView struct {
	ElementInstanceKey uint64 `json:"elementInstanceKey"`
	RaisedPosition     uint64 `json:"raisedPosition"`
	EndPosition        uint64 `json:"endPosition,omitempty"`
	// Status: "open" (recorded now), "resolved" (an operator resolved it),
	// "superseded" (a later incident replaced it on the same element), or
	// "cleared" (its element ended while it was open; no resolution recorded).
	Status string `json:"status"`
}

type IterationResponse struct {
	InstanceKey        uint64         `json:"instanceKey"`
	Body               BodyView       `json:"body"`
	Iteration          IterationView  `json:"iteration"`
	Incidents          []IncidentView `json:"incidents"`
	IncidentsTruncated bool           `json:"incidentsTruncated"`
	NestedBodies       []BodyView     `json:"nestedBodies"`
	NestedTruncated    bool           `json:"nestedBodiesTruncated"`
	// Variables are the recorded changes of the iteration's own scope, oldest
	// first: its loopCounter and input item as the engine bound them, and what it
	// wrote locally. A contribution to the body's output collection is recorded
	// on the body's collection, not per iteration, and does not appear here.
	Variables          []VariableChange `json:"variables"`
	VariablesTruncated bool             `json:"variablesTruncated"`
	// Decisions are the DMN evaluations attributed to the iteration, with the
	// inputs and outputs the worker froze into the log — never re-evaluated.
	// DecisionsAvailable is false when this store's history predates decision
	// attribution: then an empty list means "not known", not "none".
	Decisions          []DecisionView `json:"decisions"`
	DecisionsAvailable bool           `json:"decisionsAvailable"`
	DecisionsTruncated bool           `json:"decisionsTruncated"`
}

type IterationStepsResponse struct {
	InstanceKey       uint64            `json:"instanceKey"`
	Body              BodyView          `json:"body"`
	Iteration         IterationView     `json:"iteration"`
	HighWaterPosition uint64            `json:"highWaterPosition"`
	Steps             []OutlineStepView `json:"steps"`
	NextCursor        string            `json:"nextCursor,omitempty"`
}

type IterationVariablesResponse struct {
	InstanceKey uint64        `json:"instanceKey"`
	Iteration   IterationView `json:"iteration"`
	At          uint64        `json:"at"`
	Scopes      []StepScope   `json:"scopes"`
	// ScopesTruncated means the iteration ran more steps up to this position than
	// were read to find the scopes open at it.
	ScopesTruncated bool `json:"scopesTruncated,omitempty"`
}

type IterationView struct {
	ElementInstanceKey uint64 `json:"elementInstanceKey"`
	// Iteration is the iteration's loopCounter, null when none was recorded.
	Iteration          *uint64 `json:"iteration"`
	State              string  `json:"state"`
	ActivationPosition uint64  `json:"activationPosition"`
	EndPosition        uint64  `json:"endPosition,omitempty"`
	IncidentsRaised    uint64  `json:"incidentsRaised"`
	OpenIncidents      int     `json:"openIncidents"`
	OpenIncidentsExact bool    `json:"openIncidentsExact"`
}

type IterationsResponse struct {
	InstanceKey       uint64          `json:"instanceKey"`
	Body              BodyView        `json:"body"`
	HighWaterPosition uint64          `json:"highWaterPosition"`
	Iterations        []IterationView `json:"iterations"`
	// NextCursor is set while more matching iterations may follow. A page cut
	// short by the server's per-request work bound can hold fewer rows than
	// the limit, even none, and still carry a cursor.
	NextCursor string `json:"nextCursor,omitempty"`
}

type OutlineResponse struct {
	InstanceKey          uint64            `json:"instanceKey"`
	ProcessDefinitionKey uint64            `json:"processDefinitionKey"`
	InstanceState        string            `json:"instanceState"`
	HighWaterPosition    uint64            `json:"highWaterPosition"`
	Steps                []OutlineStepView `json:"steps"`
	NextCursor           string            `json:"nextCursor,omitempty"`
}

type OutlineStepView struct {
	Position           uint64 `json:"position"`
	At                 int64  `json:"at"`
	Action             string `json:"action"` // activated, completed, terminated
	ElementID          string `json:"elementId"`
	Type               string `json:"type,omitempty"`
	ElementInstanceKey uint64 `json:"elementInstanceKey"`
	TokenID            uint64 `json:"tokenId"`
	ParentTokenID      uint64 `json:"parentTokenId"`
	// ProcessDefinitionKey is the version the element ran under, as its event
	// recorded it — after a migration not necessarily the instance's current one.
	ProcessDefinitionKey uint64 `json:"processDefinitionKey"`
	// MultiInstanceBody marks a body execution: its iterations are behind it,
	// in the iterations route.
	MultiInstanceBody bool `json:"multiInstanceBody,omitempty"`
	// MultiInstanceIteration marks an iteration's own activation or end, the
	// first and last of its steps.
	MultiInstanceIteration bool `json:"multiInstanceIteration,omitempty"`
}

type RenderVariable func(v *model.VariableValue) (kind, value string)

type Service struct {
	// contains filtered or unexported fields
}

type StepScope struct {
	ElementInstanceKey uint64         `json:"elementInstanceKey"`
	ElementID          string         `json:"elementId,omitempty"`
	Iteration          bool           `json:"iteration,omitempty"`
	Variables          []StepVariable `json:"variables"`
	// Truncated means the scope holds more changes up to this step than were read,
	// so a variable unchanged since an early change may be missing.
	Truncated bool `json:"truncated,omitempty"`
}

type StepVariable struct {
	Name     string `json:"name"`
	Kind     string `json:"kind"`
	Value    string `json:"value"`
	Position uint64 `json:"position"` // where this value was written
	At       int64  `json:"at"`
	// ValueTruncated means Value holds only the first bytes of a larger value.
	ValueTruncated bool `json:"valueTruncated,omitempty"`
}

type VariableChange struct {
	Name        string `json:"name"`
	Kind        string `json:"kind"`
	Value       string `json:"value"`
	Position    uint64 `json:"position"`
	At          int64  `json:"at"`
	ProducerKey uint64 `json:"producerKey,omitempty"`
}

type View func(fn func(rv *state.ReadView, defs Definitions) error) error