types

type AppServer interface {
	Start() error                               // 开始
	Stop(forced ...bool) error                  // 默认为优雅关闭, 如果forced为true, 则强制关闭
	HookPreStart(fns ...HookFunction) AppServer // 添加启动前的钩子函数
	HookPreStop(fns ...HookFunction) AppServer  // 添加停止前的钩子函数
}

type BulkOperateObjectRequest[TObjectId ObjectIdentifier] struct {
	Ids []TObjectId `json:"ids"`
}

type Capability struct {
	Category ProviderCategory
	Name     string
	Module   fx.Option
}

type ConfigProvider interface {
	Provider
	Unmarshal(configVar any, key ...string) error // 读取配置到变量configVar
	Get(key string) any                           // 获取配置项的值
}

type CreateObjectResponse[TObjectId ObjectIdentifier] struct {
	Id TObjectId `json:"id"`
}

type CreateRefObjectRequest[TObjectId ObjectIdentifier, TBizObject any] struct {
	Id   TObjectId  `json:"id"`
	Item TBizObject `json:"item"`
}

type DbBulkRetrieve[TObjectId ObjectIdentifier, ModelObject any] interface {
	BulkGet(ids []TObjectId) (map[TObjectId]ModelObject, error) // 批量获取对象
}

type DbClient interface {
	DbExecutor

	Get(dest interface{}, query string, args ...interface{}) error
	Select(dest interface{}, query string, args ...interface{}) error
	Rebind(query string) string
	Close() error
}

type DbCreate[BizObject any, ModelObject any] interface {
	Create(bizObj BizObject) (ModelObject, error) // 创建对象
}

type DbDelete[TObjectId ObjectIdentifier] interface {
	Delete(id TObjectId) error // 删除对象
}

type DbEdit[TBizObject any] interface {
	Edit(bizObj TBizObject) error // 编辑对象
}

type DbExecutor interface {
	Exec(query string, args ...interface{}) (sql.Result, error)
	Query(query string, args ...interface{}) (*sql.Rows, error)
	QueryRow(query string, args ...interface{}) *sql.Row
}

type DbOperation[TObjectId ObjectIdentifier, TBizObject any, TModelObject any, TCondition any] interface {
	DbCreate[TBizObject, TModelObject]
	DbRetrieve[TObjectId, TModelObject, TCondition]
	DbUpdate[TModelObject]
	DbDelete[TObjectId]
}

type DbProvider interface {
	Provider
	My() DbClient
	Master() DbClient
	Slave(i int) DbClient
	By(name string) DbClient
}

type DbRetrieve[TObjectId ObjectIdentifier, TModelObject any, TCondition any] interface {
	Get(id TObjectId) (TModelObject, error)                                              // 获取对象
	Count(filters map[string]string) (int64, error)                                      // 统计对象
	List(filters map[string]string, list ...*protobuf.ListParam) ([]TModelObject, error) // 列出对象, list不传的时候获取所有对象
	GetQueryConditions(filters map[string]string) []TCondition                           // 获取查询条件
}

type DbUpdate[TModelObject any] interface {
	Update(modelObj TModelObject) error // 更新某个字段
}

type DeleteRefObjectRequest[TObjectId ObjectIdentifier] struct {
	Id     TObjectId `json:"id"`
	ItemId TObjectId `json:"itemId"`
}

type EditRefObjectRequest[TObjectId ObjectIdentifier, TBizObject any] struct {
	Id   TObjectId  `json:"id"`
	Item TBizObject `json:"item"`
}

type GetRefObjectRequest[TObjectId ObjectIdentifier] struct {
	Id     TObjectId `json:"id"`
	ItemId TObjectId `json:"itemId"`
}

type HookFunction func() error

type LoggerProvider interface {
	Provider
	GetStdLogger() *log.Logger
	Log(keyvals ...interface{}) error
	Trace(msg string, keyvals ...interface{})
	Debug(msg string, keyvals ...interface{})
	Info(msg string, keyvals ...interface{})
	Warn(msg string, keyvals ...interface{})
	Error(msg string, keyvals ...interface{})
	Fatal(msg string, keyvals ...interface{})
	Panic(msg string, keyvals ...interface{})
}

type Message struct {
	// Payload is the message's payload.
	Payload Payload
	// contains filtered or unexported fields
}

type MessageQueueProvider interface {
	Provider
	NewPublisher(name string, args ...*PublisherOption) (MessageQueuePublisher, error)
	NewSubscriber(name string, args ...*SubscriberOption) (MessageQueueSubscriber, error)
}

type MessageQueuePublisher interface {
	// Publish publishes provided messages to given topic.
	//
	// Publish can be synchronous or asynchronous - it depends on the implementation.
	//
	// Most publishers implementations don't support atomic publishing of messages.
	// This means that if publishing one of the messages fails, the next messages will not be published.
	//
	// Publish must be thread safe.
	Publish(topic string, messages [][]byte, delaySeconds ...int64) error
	// Close should flush unsent messages, if publisher is async.
	Close() error
}

type MessageQueueSubscriber interface {
	// Subscribe returns output channel with messages from provided topic.
	// Channel is closed, when Close() was called on the subscriber.
	//
	// To receive the next message, `Ack()` must be called on the received message.
	// If message processing failed and message should be redelivered `Nack()` should be called.
	//
	// When provided ctx is cancelled, subscriber will close subscribe and close output channel.
	// Provided ctx is set to all produced messages.
	// When Nack or Ack is called on the message, servicectx of the message is canceled.
	Subscribe(ctx context.Context, topic string) (<-chan *Message, error)
	// Close closes all subscriptions with their output channels and flush offsets etc. when needed.
	Close() error
}

type ObjectIdentifier interface {
	int64 | int32 | int | string
}

type OperateObjectRequest[TObjectId ObjectIdentifier] struct {
	Id TObjectId `json:"id"`
}

type OssProvider interface {
	Provider
	WithContentTypes(contentTypes []string) OssProvider                                   // 设置允许的文件类型
	WithMaxFileSize(fileSize int64) OssProvider                                           // 设置允许最大的文件大小
	WithSignExpiresIn(duration time.Duration) OssProvider                                 // 设置签名过期时间
	Upload(dir, filename string, data []byte) (string, error)                             // 上传文件
	GetPresignedURL(dir, filename, contentType string) (string, map[string]string, error) // 生成预签名URL, 返回URL,headers
	GetPostSignature(dir, filename string) (map[string]string, error)                     // 生成POST签名
}

type Payload []byte

type Provider interface {
	GetCapability() Capability // 获取能力
}

type ProviderCategory int

type PublisherOption struct {
	PublishDelayMessage bool
}

type QueryObjectRequest struct {
	Filters map[string]string   `json:"filters,omitempty"`
	List    *protobuf.ListParam `json:"list,omitempty"`
}

type QueryObjectResponse[TBizObject any] struct {
	Total int64        `json:"total"`
	Items []TBizObject `json:"items"`
}

type QueryRefObjectRequest[TObjectId ObjectIdentifier] struct {
	Id      TObjectId           `json:"id"`
	Filters map[string]string   `json:"filters,omitempty"`
	List    *protobuf.ListParam `json:"list,omitempty"`
}

type QueryRefObjectResponse[TBizObject any] struct {
	Total int64        `json:"total"`
	Items []TBizObject `json:"items"`
}

type RedisClient interface {
	// general purpose
	Del(key string) error
	Dels(keys []string) error
	Exists(key string) (bool, error)
	Expire(key string, expire int) error
	Incr(key string) error
	IncrBy(key string, number int) error
	DecrBy(key string, number int) error
	Ttl(key string) (int64, error)
	Pipeline(commands []*RedisCommand) (reply interface{}, err error)
	Ping() error

	// Set operations
	Set(key string, value interface{}) error
	SetEx(key string, value interface{}, expire int) error

	// Get operations
	Get(key string) ([]byte, error)
	GetInt(key string) (int, error)
	GetInt64(key string) (int64, error)
	GetFloat64(key string) (float64, error)
	GetString(key string) (string, error)

	// HashMap operations
	HGetAll(key string) (map[string]string, error)
	HGet(key string, field any) ([]byte, error)
	HGetInt(key string, field string) (int, error)
	HGetInt64(key string, field string) (int64, error)
	HGetFloat64(key string, field string) (float64, error)
	HGetString(key string, field string) (string, error)
	HMGet(key string, fields []string) ([][]byte, error)
	HSet(key string, field interface{}, value interface{}) (int, error)
	HMSet(key string, args map[string]interface{}) error
	HDel(key string, field interface{}) (int, error)
	HDels(key string, fields []interface{}) (int, error)
	HLen(key string) (int, error)

	// set
	SIsMember(key string, member interface{}) (bool, error)
	SAdd(key string, members interface{}) error
	SRem(key string, members interface{}) error
	SInter(keys []string) ([]string, error)
	SUnion(keys []string) ([]string, error)
	SDiff(keys []string) ([]string, error)
	SMembers(key string) ([]string, error)

	// zset
	ZAdd(key string, score int64, member interface{}) error
	ZCard(key string) (int, error)
	ZRange(key string, min, max int64) ([]string, error)
	ZRemRangeByScore(key string, min, max interface{}) error
	ZRangeByScore(key string, min, max interface{}, withScores bool, list *protobuf.ListParam) ([]string, error)
	ZScore(key string, member interface{}) (int64, error)
	ZInterstore(newKey string, keys ...interface{}) (int64, error)
	ZIncrBy(key string, increment int64, member interface{}) error
	ZRem(destKey string, members ...interface{}) (int64, error)

	// list
	LPush(key string, values ...any) error
	RPush(key string, values ...any) error
	RPop(key string) ([]byte, error)
	LRangeInt64(key string, start, end int64) ([]int64, error)
	LRangeString(key string, start, end int64) ([]string, error)
	LLen(key string) (int64, error)
	Eval(scriptContent string, keys []interface{}, args []interface{}) (interface{}, error)

	// redis bloom
	BfExists(key string, item string) (exists bool, err error)
	BfAdd(key string, item string) (exists bool, err error)
	BfReserve(key string, errorRate float64, capacity uint64) (err error)
	BfAddMulti(key string, items []interface{}) ([]int64, error)
	BfExistsMulti(key string, items []interface{}) ([]int64, error)
}

type RedisCommand struct {
	Name string
	Args []interface{}
}

type RedisProvider interface {
	Provider
	My() RedisClient
	By(string) RedisClient
}

type RefDbBulkRetrieve[TObjectId ObjectIdentifier, TRefModelObject any] interface {
	BulkGet(id TObjectId, refIds []TObjectId) (map[TObjectId]TRefModelObject, error) // 批量获取对象
}

type RefDbCreate[TObjectId ObjectIdentifier, TRefBizObject any, TRefModelObject any] interface {
	Create(id TObjectId, refBizObj TRefBizObject) (TRefModelObject, error) // 创建关联对象DAO
}

type RefDbDelete[TObjectId ObjectIdentifier] interface {
	Delete(id, refId TObjectId) error // 删除关联对象DAO
}

type RefDbEdit[TObjectId ObjectIdentifier, TRefBizObject any] interface {
	Edit(id TObjectId, refBizObj TRefBizObject) error // 编辑数据库关联对象DAO
}

type RefDbOperation[TObjectId ObjectIdentifier, TRefBizObject any, TRefModelObject any, TCondition any] interface {
	RefDbCreate[TObjectId, TRefBizObject, TRefModelObject]
	RefDbRetrieve[TObjectId, TRefModelObject, TCondition]
	RefDbUpdate[TRefModelObject]
	RefDbDelete[TObjectId]
}

type RefDbRetrieve[TObjectId ObjectIdentifier, TRefModelObject any, Condition any] interface {
	Get(id, refId TObjectId) (TRefModelObject, error)                                                           // 获取关联对象DAO
	Count(id TObjectId, refObjFilters map[string]string) (int64, error)                                         // 统计关联对象DAO
	List(id TObjectId, refObjFilters map[string]string, list ...*protobuf.ListParam) ([]TRefModelObject, error) // 列出关联对象DAO
	GetQueryConditions(id TObjectId, refObjFilters map[string]string) []Condition                               // 获取关联对象DAO
}

type RefDbUpdate[TRefObjectModel any] interface {
	Update(refObjModel TRefObjectModel) error // 更新数据库关联对象
}

type ServiceCreate[TBizObject any] interface {
	Create(ctx biz.Context, object TBizObject) (int64, error) // 创建业务对象
}

type ServiceDelete[TObjectId ObjectIdentifier] interface {
	Delete(ctx biz.Context, id TObjectId) error // 删除业务对象
}

type ServiceOperation[TObjectId ObjectIdentifier, TBizObject any] interface {
	ServiceCreate[TBizObject]
	ServiceRetrieve[TObjectId, TBizObject]
	ServiceUpdate[TBizObject]
	ServiceDelete[TObjectId]
}

type ServiceRetrieve[TObjectId ObjectIdentifier, TBizObject any] interface {
	Get(ctx biz.Context, id TObjectId) (TBizObject, error)                                                      // 获取业务对象
	Query(ctx biz.Context, filters map[string]string, list ...*protobuf.ListParam) (int64, []TBizObject, error) // 查询业务对象
}

type ServiceUpdate[TBizObject any] interface {
	Edit(ctx biz.Context, bizObject TBizObject) error // 编辑业务对象
}

type SubscriberOption struct {
	SubscribeDelayMessage bool
}