types

type Component struct{}

type Expr struct {
	// Variable name to set results of the expression to
	Target string `json:"target"`

	// Source of the value / name of the variable from scope; if set value is copied target
	//
	// Takes precedence to value
	//
	Source string `json:"source,omitempty"`

	// Expression to evaluate over the input variables; results will be set to target
	//
	Expr string `json:"expr,omitempty"`

	// Raw value to be set to target
	//
	// If expression is set and fails, evaluation defaults to value and suppresses the error
	Value interface{} `json:"value,omitempty"`

	// Expected type of the input value
	Type string `json:"type,omitempty"`

	// Set of tests that can be run before input is evaluated and result copied to scope
	Tests TestSet `json:"tests,omitempty"`
	// contains filtered or unexported fields
}

type ExprSet []*Expr

type Function struct {
	Ref        string        `json:"ref,omitempty"`
	Kind       string        `json:"kind,omitempty"`
	Meta       *FunctionMeta `json:"meta,omitempty"`
	Parameters ParamSet      `json:"parameters,omitempty"`
	Results    ParamSet      `json:"results,omitempty"`

	Handler  FunctionHandler `json:"-"`
	Iterator IteratorHandler `json:"-"`

	Labels   map[string]string `json:"labels,omitempty"`
	Disabled bool              `json:"disabled,omitempty"`
}

type FunctionHandler func(ctx context.Context, in *expr.Vars) (*expr.Vars, error)

type FunctionMeta struct {
	Short       string                 `json:"short,omitempty"`
	Description string                 `json:"description,omitempty"`
	Visual      map[string]interface{} `json:"visual,omitempty"`
}

type IteratorHandler func(ctx context.Context, in *expr.Vars) (wfexec.IteratorHandler, error)

type LocaleKey struct {
	Name          string
	Resource      string
	Path          string
	CustomHandler string
}

type Param struct {
	Name     string     `json:"name,omitempty"`
	Types    []string   `json:"types,omitempty"`
	Required bool       `json:"required,omitempty"`
	IsArray  bool       `json:"isArray,omitempty"`
	Meta     *ParamMeta `json:"meta,omitempty"`
}

type ParamMeta struct {
	Label       string                 `json:"label,omitempty"`
	Description string                 `json:"description,omitempty"`
	Visual      map[string]interface{} `json:"visual,omitempty"`
}

type ParamSet []*Param

type Session struct {
	ID         uint64 `json:"sessionID,string"`
	WorkflowID uint64 `json:"workflowID,string"`

	Status SessionStatus `json:"status,string"`

	EventType    string `json:"eventType"`
	ResourceType string `json:"resourceType"`

	Input  *expr.Vars `json:"input"`
	Output *expr.Vars `json:"output"`

	// Stacktrace that gets stored (if/when configured)
	Stacktrace Stacktrace `json:"stacktrace"`

	CreatedAt time.Time  `json:"createdAt,omitempty"`
	CreatedBy uint64     `json:"createdBy,string"`
	PurgeAt   *time.Time `json:"purgeAt,omitempty"`

	// here we join suspended & prompted state;
	// we treat both states as suspended
	SuspendedAt *time.Time `json:"suspendedAt,omitempty"`
	CompletedAt *time.Time `json:"completedAt,omitempty"`
	Error       string     `json:"error,omitempty"`

	// For keeping runtime stacktrace,
	// even if we do not want to store it on every update
	//
	// This will aid us when session fails and we can access
	// the whole stacktrace
	RuntimeStacktrace Stacktrace `json:"-"`

	// FlushCounter helps us keep track of when we should forcefully flush
	// the session to the database.
	//
	// This is required due to the change in exec stack traces.
	FlushCounter int `json:"-"`
	// contains filtered or unexported fields
}

type SessionFilter struct {
	SessionID    []string `json:"sessionID"`
	WorkflowID   []string `json:"workflowID"`
	CreatedBy    []string `json:"createdBy"`
	EventType    string   `json:"eventType"`
	ResourceType string   `json:"resourceType"`

	Completed filter.State `json:"deleted"`
	Status    []uint       `json:"status"`

	// Check fn is called by store backend for each resource found function can
	// modify the resource and return false if store should not return it
	//
	// Store then loads additional resources to satisfy the paging parameters
	Check func(*Session) (bool, error) `json:"-"`

	// Standard helpers for paging and sorting
	filter.Sorting
	filter.Paging
}

type SessionSet []*Session

type SessionStartParams struct {
	// Always set, users that invoked/started the workflow session
	Invoker auth.Identifiable

	// Optional, (alternative) user that is running the workflow
	Runner auth.Identifiable

	WorkflowID   uint64
	KeepFor      int
	Trace        bool
	Input        *expr.Vars
	StepID       uint64
	EventType    string
	ResourceType string

	CallStack []uint64
}

type SessionStatus uint

type Stacktrace []*wfexec.Frame

type State struct {
	ID        uint64 `json:"stateID,string"`
	SessionID uint64 `json:"sessionID,string"`

	ResumeAt        *time.Time `json:"resumeAt"`
	WaitingForInput bool       `json:"waitingForInput"`

	CreatedAt time.Time `json:"createdAt,omitempty"`
	CreatedBy uint64    `json:"createdBy,string"`

	CallerID uint64     `json:"callerID,string"`
	StepID   uint64     `json:"stepID,string"`
	Scope    *expr.Vars `json:"scope"`
}

type StateSet []*State

type Test struct {
	// Expression to evaluate over the input variables; results will be set to scope under variable Name
	Expr string `json:"expr,omitempty"`

	// Error to be   if test fails
	Error string `json:"error"`
	// contains filtered or unexported fields
}

type TestSet []*Test

type Trigger struct {
	ID      uint64 `json:"triggerID,string"`
	Enabled bool   `json:"enabled"`

	WorkflowID uint64 `json:"workflowID,string"`
	// Start workflow on this step. If 0, find first (only) orphan
	StepID uint64 `json:"stepID,string"`

	// Resource type that can trigger the workflow
	ResourceType string `json:"resourceType"`

	// Event type that can trigger the workflow
	EventType string `json:"eventType"`

	// Trigger constraints
	Constraints TriggerConstraintSet `json:"constraints"`

	// Initial input scope,
	// will be merged merged with workflow variables
	Input *expr.Vars `json:"input"`

	Labels map[string]string `json:"labels,omitempty"`
	Meta   *TriggerMeta      `json:"meta,omitempty"`

	OwnedBy   uint64     `json:"ownedBy,string"`
	CreatedAt time.Time  `json:"createdAt,omitempty"`
	CreatedBy uint64     `json:"createdBy,string" `
	UpdatedAt *time.Time `json:"updatedAt,omitempty"`
	UpdatedBy uint64     `json:"updatedBy,string,omitempty"`
	DeletedAt *time.Time `json:"deletedAt,omitempty"`
	DeletedBy uint64     `json:"deletedBy,string,omitempty"`
}

type TriggerConstraint struct {
	Name   string   `json:"name"`
	Op     string   `json:"op,omitempty"`
	Values []string `json:"values,omitempty"`
}

type TriggerConstraintSet []*TriggerConstraint

type TriggerFilter struct {
	TriggerID  []string `json:"triggerID"`
	WorkflowID []string `json:"workflowID"`

	EventType    string `json:"eventType"`
	ResourceType string `json:"resourceType"`

	Deleted  filter.State `json:"deleted"`
	Disabled filter.State `json:"disabled"`

	LabeledIDs []uint64          `json:"-"`
	Labels     map[string]string `json:"labels,omitempty"`

	// Check fn is called by store backend for each resource found function can
	// modify the resource and return false if store should not return it
	//
	// Store then loads additional resources to satisfy the paging parameters
	Check func(*Trigger) (bool, error) `json:"-"`

	// Standard helpers for paging and sorting
	filter.Sorting
	filter.Paging
}

type TriggerMeta struct {
	Description string                 `json:"description"`
	Visual      map[string]interface{} `json:"visual"`
}

type TriggerSet []*Trigger

type Workflow struct {
	ID      uint64            `json:"workflowID,string"`
	Handle  string            `json:"handle"`
	Labels  map[string]string `json:"labels,omitempty"`
	Meta    *WorkflowMeta     `json:"meta,omitempty"`
	Enabled bool              `json:"enabled"`

	Trace bool `json:"trace"`

	// how much time do we keep completed sessions (in sec)
	KeepSessions int `json:"keepSessions"`

	// Initial input scope
	Scope *expr.Vars `json:"scope"`

	Steps WorkflowStepSet `json:"steps"`
	Paths WorkflowPathSet `json:"paths"`

	// Collection of issues from the last parse
	Issues WorkflowIssueSet `json:"issues,omitempty"`

	RunAs uint64 `json:"runAs,string"`

	OwnedBy   uint64     `json:"ownedBy,string"`
	CreatedAt time.Time  `json:"createdAt,omitempty"`
	CreatedBy uint64     `json:"createdBy,string" `
	UpdatedAt *time.Time `json:"updatedAt,omitempty"`
	UpdatedBy uint64     `json:"updatedBy,string,omitempty"`
	DeletedAt *time.Time `json:"deletedAt,omitempty"`
	DeletedBy uint64     `json:"deletedBy,string,omitempty"`
}

type WorkflowExecParams struct {
	// When executed as a sub-workflow
	CallerWorkflowID uint64

	// When executed as a sub-workflow
	CallerSessionID uint64

	// When executed as a sub-workflow
	CallerStepID uint64

	// Start with this specific step
	StepID uint64

	EventType    string
	ResourceType string

	// Enable execution tracing
	Trace bool

	// Do not wait for workflow to be finished
	Async bool

	// Wait for workflow to be executed even if it's deferred
	Wait bool

	Input *expr.Vars
}

type WorkflowFilter struct {
	WorkflowID []string `json:"workflowID"`

	Handle string `json:"handle"`

	Query string `json:"query"`

	Deleted  filter.State `json:"deleted"`
	Disabled filter.State `json:"disabled"`

	// include sub-workflows
	SubWorkflow filter.State `json:"subWorkflow"`

	LabeledIDs []uint64          `json:"-"`
	Labels     map[string]string `json:"labels,omitempty"`

	// Check fn is called by store backend for each resource found function can
	// modify the resource and return false if store should not return it
	//
	// Store then loads additional resources to satisfy the paging parameters
	Check func(*Workflow) (bool, error) `json:"-"`

	// Standard helpers for paging and sorting
	filter.Sorting
	filter.Paging
}

type WorkflowIssue struct {
	// url encoded location of the error:
	Culprit     map[string]int `json:"culprit"`
	Description string         `json:"description"`
}

type WorkflowIssueSet []*WorkflowIssue

type WorkflowMeta struct {
	Name        string                 `json:"name"`
	Description string                 `json:"description"`
	Visual      map[string]interface{} `json:"visual"`

	// list as one of the sub-workflows, when set to true
	// there should be no enabled triggers on this workflow
	SubWorkflow bool `json:"subWorkflow,omitempty"`
}

type WorkflowPath struct {
	// Expression to evaluate over the input variables; results will be set to scope under variable Name
	Expr string `json:"expr,omitempty"`

	ParentID uint64           `json:"parentID,string"`
	ChildID  uint64           `json:"childID,string"`
	Meta     WorkflowPathMeta `json:"meta,omitempty"`
	// contains filtered or unexported fields
}

type WorkflowPathMeta struct {
	Name        string                 `json:"name"`
	Description string                 `json:"description"`
	Visual      map[string]interface{} `json:"visual"`
}

type WorkflowPathSet []*WorkflowPath

type WorkflowSet []*Workflow

type WorkflowStep struct {
	ID   uint64           `json:"stepID,string"`
	Kind WorkflowStepKind `json:"kind"`

	// reference to function or subprocess (workflow)
	Ref string `json:"ref"`

	// set of expressions to evaluate, test or pass to function
	// invalid for for kind=~gateway:*
	Arguments []*Expr `json:"arguments"`

	// only valid when kind=function
	Results []*Expr `json:"results"`

	Meta WorkflowStepMeta `json:"meta,omitempty"`

	Labels map[string]string `json:"labels,omitempty"`
}

type WorkflowStepKind string

type WorkflowStepMeta struct {
	Name        string                 `json:"name"`
	Description string                 `json:"description"`
	Visual      map[string]interface{} `json:"visual"`
}

type WorkflowStepSet []*WorkflowStep