flowable

type DB interface {
	// ExecContext 执行 SQL。
	// @param ctx 上下文
	// @param query SQL
	// @param args 参数
	// @return 结果
	// @return 错误
	ExecContext(ctx context.Context, query string, args ...any) (Result, error)
}

type HistoricActivityInstanceQuery struct {
	ID                   string     // 历史活动 ID
	ProcessInstanceID    string     // 流程实例 ID
	ProcessDefinitionID  string     // 流程定义 ID
	ProcessDefinitionKey string     // 流程定义 Key
	ActivityID           string     // 活动 ID
	ActivityName         string     // 活动名称
	ActivityType         string     // 活动类型
	Assignee             string     // 处理人
	TenantID             string     // 租户，空表示不过滤
	StartedAfter         *time.Time // 开始时间下界，含边界
	StartedBefore        *time.Time // 开始时间上界，含边界
	FinishedAfter        *time.Time // 结束时间下界，含边界
	FinishedBefore       *time.Time // 结束时间上界，含边界
	Finished             *bool      // 是否已结束，空表示不过滤
	Start                int        // 偏移量
	Size                 int        // 每页数量
}

type HistoricProcessInstanceQuery struct {
	ID                   string     // 流程实例 ID
	ProcessDefinitionID  string     // 流程定义 ID
	ProcessDefinitionKey string     // 流程定义 Key
	BusinessKey          string     // 业务键
	TenantID             string     // 租户，空表示不过滤
	StartedAfter         *time.Time // 开始时间下界，含边界
	StartedBefore        *time.Time // 开始时间上界，含边界
	FinishedAfter        *time.Time // 结束时间下界，含边界
	FinishedBefore       *time.Time // 结束时间上界，含边界
	Finished             *bool      // 是否已结束，空表示不过滤
	Start                int        // 偏移量
	Size                 int        // 每页数量
}

type HistoricSnapshot struct {
	Processes   []api.HistoricProcessInstance  // 历史流程
	Activities  []api.HistoricActivityInstance // 历史活动
	Tasks       []api.HistoricTaskInstance     // 历史任务
	Variables   []api.HistoricVariableInstance // 历史变量
	Comments    []api.Comment                  // 评论
	Attachments []api.Attachment               // 附件
	Links       []api.IdentityLink             // 身份链接
	Details     []api.HistoricDetail           // 变量明细
	TaskLogs    []api.HistoricTaskLog          // 任务日志
}

type HistoricTaskInstanceQuery struct {
	ID                   string     // 历史/任务 ID
	Name                 string     // 任务名称
	Assignee             string     // 处理人
	TaskDefinitionKey    string     // 任务定义 Key
	ProcessInstanceID    string     // 流程实例 ID
	ProcessDefinitionID  string     // 流程定义 ID
	ProcessDefinitionKey string     // 流程定义 Key
	TenantID             string     // 租户，空表示不过滤
	StartedAfter         *time.Time // 开始时间下界，含边界
	StartedBefore        *time.Time // 开始时间上界，含边界
	FinishedAfter        *time.Time // 结束时间下界，含边界
	FinishedBefore       *time.Time // 结束时间上界，含边界
	Finished             *bool      // 是否已结束，空表示不过滤
	Start                int        // 偏移量
	Size                 int        // 每页数量
}

type HistoricVariableInstanceQuery struct {
	ID                string // 历史/变量 ID
	Name              string // 变量名
	ProcessInstanceID string // 流程实例 ID
	ExecutionID       string // 执行 ID
	TaskID            string // 任务 ID
	VariableType      string // 变量类型
	Start             int    // 偏移量
	Size              int    // 每页数量
}

type IdentityBytes struct {
	ID   string // 字节行标识
	Name string // 媒体类型或控制名称
	Data []byte // 原始字节
}

type IdentityInfo struct {
	ID              string  // 标准信息行标识
	UserID          string  // 用户标识
	Type            string  // 信息类型
	Key             string  // 信息键
	Value           *string // 可空信息值
	Password        []byte  // 账户密码数据
	PasswordPresent bool    // 密码列是否非空，包括零长度字节
	ParentID        string  // 父信息标识
}

type IdentityMembership struct {
	UserID  string // 用户标识
	GroupID string // 组标识
}

type IdentitySnapshot struct {
	Users       []IdentityUser           // 用户
	Groups      []api.Group              // 组
	Memberships []IdentityMembership     // 成员关系
	Infos       []IdentityInfo           // 信息
	Bytes       map[string]IdentityBytes // 字节行
}

type IdentityUser struct {
	User      api.User // 用户资料及密码编码
	PictureID string   // 头像字节行标识
}

type ModelRecord struct {
	Info        api.Model // 模型元数据
	Source      []byte    // 编辑源
	SourceExtra []byte    // 扩展源码
}

type Operation struct {
	Kind        string // 类型
	Row         Row    // 行
	OldRevision int64  // 更新时旧版本
}

type ProcessInstanceQuery struct {
	ID                   string     // 流程实例 ID
	ProcessDefinitionID  string     // 流程定义 ID
	ProcessDefinitionKey string     // 流程定义 Key
	BusinessKey          string     // 业务键
	TenantID             string     // 租户，空表示不过滤
	Suspended            *bool      // 是否挂起，空表示不过滤
	StartedAfter         *time.Time // 开始时间下界，含边界
	StartedBefore        *time.Time // 开始时间上界，含边界
	Start                int        // 偏移量
	Size                 int        // 每页数量
}

type QueryDB interface {
	DB
	// QueryContext 执行查询。
	// @param ctx 上下文
	// @param query SQL
	// @param args 参数
	// @return 结果集
	// @return 错误
	QueryContext(ctx context.Context, query string, args ...any) (Rows, error)
}

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

type Result interface {
	// RowsAffected 返回影响行数。
	// @return 影响行数
	// @return 错误
	RowsAffected() (int64, error)
}

type Row struct {
	Table         string         // 表名
	Values        map[string]any // 列值
	InsertColumns []string       // 可选的自定义插入列
}

type Rows interface {
	// Next 前进到下一行。
	// @return 是否有下一行
	Next() bool
	// Scan 扫描当前行。
	// @param dest 目标
	// @return 扫描错误
	Scan(dest ...any) error
	// Close 关闭结果集。
	// @return 关闭错误
	Close() error
	// Err 返回遍历错误。
	// @return 遍历错误
	Err() error
}

type RuntimeExecution struct {
	Name                      string     // 实例根名称
	StartUserID               string     // 实例发起人
	BusinessStatus            string     // 业务状态
	DueDate                   *time.Time // 实例截止时间
	ClaimTime                 *time.Time // 实例签收时间
	ClaimedBy                 string     // 实例签收人
	SuperExecutionID          string     // 父调用执行标识
	CallbackID                string     // 回调标识
	CallbackType              string     // 回调类型
	ReferenceID               string     // 关联标识
	ReferenceType             string     // 关联类型
	PropagatedStageInstanceID string     // 传播阶段标识
	ID                        string     // 执行 ID
	ProcessInstanceID         string     // 流程实例 ID
	DefinitionID              string     // 流程定义 ID
	ParentID                  string     // 父执行 ID
	ActivityID                string     // 当前活动 ID
	BusinessKey               string     // 业务键
	TenantID                  string     // 租户
	StartTime                 time.Time  // 开始时间
	Active                    bool       // 是否活跃
	Concurrent                bool       // 是否并发
	Scope                     bool       // 是否作用域
	EventScope                bool       // 是否事件作用域
	MIRoot                    bool       // 是否多实例根
	Suspended                 bool       // 是否挂起
}

type RuntimeIdentityLink struct {
	ID                  string // 链接 ID
	GroupID             string // 组 ID
	Type                string // 类型
	UserID              string // 用户 ID
	TaskID              string // 任务 ID
	ProcessInstanceID   string // 实例 ID
	ProcessDefinitionID string // 定义 ID
}

type RuntimeJob struct {
	ID                string     // 作业 ID
	Type              string     // 作业类型
	ExecutionID       string     // 执行 ID
	ProcessInstanceID string     // 实例 ID
	DefinitionID      string     // 定义 ID
	ActivityID        string     // 活动 ID
	Retries           int        // 重试次数
	Exception         string     // 异常
	DueDate           *time.Time // 到期时间
	CreatedAt         time.Time  // 创建时间
	TenantID          string     // 租户
	RepeatRemaining   int        // 剩余重复次数
	RepeatInfinite    bool       // 是否无限重复
	IntervalMillis    int64      // 重复间隔
	DeadLetter        bool       // 是否死信
	VariablePayload   []byte     // 异步变量作业的外置类型化载荷
}

type RuntimeSnapshot struct {
	Executions    []RuntimeExecution    // 执行
	Tasks         []RuntimeTask         // 任务
	Variables     []RuntimeVariable     // 变量
	Jobs          []RuntimeJob          // 作业
	DeadLetters   []RuntimeJob          // 死信作业
	Subscriptions []RuntimeSubscription // 订阅
	Links         []RuntimeIdentityLink // 身份链接
}

type RuntimeSubscription struct {
	ID                 string    // 订阅 ID
	EventType          string    // 事件类型
	EventName          string    // 事件名
	Condition          string    // 条件表达式（条件事件）
	ExecutionID        string    // 执行 ID
	ProcessInstanceID  string    // 实例 ID
	ActivityID         string    // 活动 ID
	CreatedAt          time.Time // 创建时间
	DefinitionID       string    // 定义 ID
	ScopeType          string    // 作用域类型
	ScopeDefinitionID  string    // 作用域定义 ID
	ScopeDefinitionKey string    // 作用域定义 Key
	ScopeID            string    // 作用域执行 ID
	SubScopeID         string    // 子作用域 ID
	TenantID           string    // 租户
}

type RuntimeTask struct {
	ClaimTime         *time.Time // 签收时间
	DelegationState   string     // 委派状态
	ID                string     // 任务 ID
	ExecutionID       string     // 执行 ID
	ProcessInstanceID string     // 流程实例 ID
	DefinitionID      string     // 流程定义 ID
	Name              string     // 名称
	Description       string     // 描述
	TaskDefinitionKey string     // 任务定义 Key
	ParentTaskID      string     // 父任务 ID
	Owner             string     // 所有者
	Assignee          string     // 处理人
	Category          string     // 分类
	FormKey           string     // 表单 Key
	TenantID          string     // 租户
	Priority          int        // 优先级
	CreateTime        time.Time  // 创建时间
	DueDate           *time.Time // 到期时间
	Suspended         bool       // 是否挂起
}

type RuntimeVariable struct {
	Bytes             []byte   // 外置字节数据
	ByteArrayID       string   // 字节行引用
	ID                string   // 变量 ID
	Type              string   // 类型
	Name              string   // 名称
	ExecutionID       string   // 执行 ID
	ProcessInstanceID string   // 实例 ID
	TaskID            string   // 任务 ID
	Long              *int64   // 长整型
	Double            *float64 // 浮点
	Text              *string  // 文本
}

type SQLDB struct {
	DB *sql.DB // 数据库连接池
}

type Snapshot struct {
	Deployments        []api.Deployment             // 部署
	Resources          map[string]map[string][]byte // 部署 ID 到资源
	Definitions        []api.ProcessDefinition      // 流程定义
	Models             []ModelRecord                // 流程模型
	Properties         map[string]string            // 自定义属性
	AttachmentContents map[string][]byte            // 附件内容
}

type Table struct {
	PrimaryKeys []string // 复合主键列，非空时优先于单列主键
	Name        string   // 表名
	Columns     []string // 列顺序
	PrimaryKey  string   // 主键列，缺省为 ID_
}

type TaskQuery struct {
	Assignee             string   // 处理人
	Owner                string   // 所有者
	DelegationState      string   // 委派状态
	ProcessInstanceID    string   // 流程实例 ID
	ProcessDefinitionKey string   // 流程定义 Key
	ParentTaskID         string   // 父任务 ID
	TenantID             string   // 租户，空表示不过滤
	CandidateUser        string   // 候选人
	CandidateGroups      []string // 候选组
	Start                int      // 偏移量
	Size                 int      // 每页数量
}

type Transaction interface {
	DB
	// Commit 提交事务。
	// @return 提交错误
	Commit() error
	// Rollback 回滚事务。
	// @return 回滚错误
	Rollback() error
}

type TransactionalDB interface {
	DB
	// BeginTx 开始事务。
	// @param ctx 上下文
	// @return 事务
	// @return 错误
	BeginTx(ctx context.Context) (Transaction, error)
}