rbac

type AuthDTO struct {
	BaseDTO

	Action    string      `json:"action"` // 如果为空，表示这条信息仅用于认证
	Mechanism string      `json:"mechanism"`
	Account   string      `json:"account"`
	Secret    lang.Base64 `json:"secret"`

	Parameters map[string]string `json:"parameters"` // 其它扩展属性
}

type AuthService interface {
	Handle(c context.Context, a []*AuthDTO) error
}

type AuthVO struct {
	BaseVO

	Auth []*AuthDTO `json:"auth"` // 用于验证的信息
}

type BaseDTO struct {
	UUID lang.UUID `json:"uuid"`

	CreatedAt lang.Time `json:"created_at"`
	UpdatedAt lang.Time `json:"updated_at"`
	DeletedAt lang.Time `json:"deleted_at"`

	Owner   UserID `json:"owner"`
	Creator UserID `json:"creator"`
	Updater UserID `json:"updater"`
}

type BaseVO struct {
	Status     int         `json:"status"`
	Message    string      `json:"message"`
	Error      string      `json:"error"`
	Time       time.Time   `json:"time"`
	Timestamp  lang.Time   `json:"timestamp"`
	Pagination *Pagination `json:"pagination"`
}

type EmailAddress string

type EmailAddressDTO struct {
	ID EmailAddressID `json:"id"`

	BaseDTO

	Address EmailAddress `json:"address"`
}

type EmailAddressID int64

type EmailAddressQuery struct {
	Pagination Pagination
	Conditions map[string]string
	All        bool // 查询全部条目
}

type EmailAddressService interface {
	Insert(c context.Context, o *EmailAddressDTO) (*EmailAddressDTO, error)
	Update(c context.Context, id EmailAddressID, o *EmailAddressDTO) (*EmailAddressDTO, error)
	Delete(c context.Context, id EmailAddressID) error

	Find(c context.Context, id EmailAddressID) (*EmailAddressDTO, error)
	List(c context.Context, q *EmailAddressQuery) ([]*EmailAddressDTO, error)
}

type FullPhoneNumber PhoneNumber

type Pagination struct {
	Page  int64 `json:"page"`  // 页码, first=1
	Size  int   `json:"size"`  // 页大小
	Total int64 `json:"total"` // 所有页面的条目总数
}

type PermissionCache interface {
	Clear()
	Find(c context.Context, want *PermissionDTO) (*PermissionDTO, error)
}

type PermissionDTO struct {
	ID PermissionID `json:"id"`

	BaseDTO

	Method      string       `json:"method"`
	Path        string       `json:"path"`
	AcceptRoles RoleNameList `json:"accept_roles"`
	Enabled     bool         `json:"enabled"`
}

type PermissionID int64

type PermissionQuery struct {
	Pagination Pagination
	Conditions map[string]string
	All        bool // 查询全部条目
}

type PermissionService interface {
	Insert(c context.Context, o *PermissionDTO) (*PermissionDTO, error)
	Update(c context.Context, id PermissionID, o *PermissionDTO) (*PermissionDTO, error)
	Delete(c context.Context, id PermissionID) error

	Find(c context.Context, id PermissionID) (*PermissionDTO, error)
	List(c context.Context, q *PermissionQuery) ([]*PermissionDTO, error)
	ListAll(c context.Context) ([]*PermissionDTO, error)

	GetCache() PermissionCache
}

type PermissionVO struct {
	BaseVO

	Permissions []*PermissionDTO `json:"permissions"`
}

type PhoneNumber string

type PhoneNumberDTO struct {
	ID PhoneNumberID `json:"id"`

	BaseDTO

	RegionCode2  RegionPhoneCode   `json:"region"`
	SimpleNumber SimplePhoneNumber `json:"simple_number"`
	FullNumber   FullPhoneNumber   `json:"full_number"`
}

type PhoneNumberID int64

type PhoneNumberQuery struct {
	Pagination Pagination
	Conditions map[string]string
	All        bool // 查询全部条目
}

type PhoneNumberService interface {
	Insert(c context.Context, o *PhoneNumberDTO) (*PhoneNumberDTO, error)
	Update(c context.Context, id PhoneNumberID, o *PhoneNumberDTO) (*PhoneNumberDTO, error)
	Delete(c context.Context, id PhoneNumberID) error

	Find(c context.Context, id PhoneNumberID) (*PhoneNumberDTO, error)
	List(c context.Context, q *PhoneNumberQuery) ([]*PhoneNumberDTO, error)
}

type RegionCode2 string

type RegionCode3 string

type RegionDTO struct {
	ID RegionID `json:"id"`

	BaseDTO

	SimpleName string          // 区域简称，例如：chn(中国), fra(France), usa(United States)
	Code2      RegionCode2     // 二字符区域码
	Code3      RegionCode3     // 三字符区域码
	PhoneCode  RegionPhoneCode // 电话区域码
}

type RegionID int

type RegionPhoneCode string

type RegionQuery struct {
	Pagination Pagination
	Conditions map[string]string
	All        bool // 查询全部条目
}

type RegionService interface {
	Insert(c context.Context, o *RegionDTO) (*RegionDTO, error)
	Update(c context.Context, id RegionID, o *RegionDTO) (*RegionDTO, error)
	Delete(c context.Context, id RegionID) error

	Find(c context.Context, id RegionID) (*RegionDTO, error)
	List(c context.Context, q *RegionQuery) ([]*RegionDTO, error)
}

type RoleDTO struct {
	ID RoleID `json:"id"`

	BaseDTO

	Name        RoleName `json:"name"`
	Description string   `json:"description"`
}

type RoleID int64

type RoleName string

type RoleNameList string

type RoleQuery struct {
	Pagination Pagination
	Conditions map[string]string
	All        bool // 查询全部条目
}

type RoleService interface {
	Insert(c context.Context, o *RoleDTO) (*RoleDTO, error)
	Update(c context.Context, id RoleID, o *RoleDTO) (*RoleDTO, error)
	Delete(c context.Context, id RoleID) error

	Find(c context.Context, id RoleID) (*RoleDTO, error)
	List(c context.Context, q *RoleQuery) ([]*RoleDTO, error)
}

type RoleVO struct {
	BaseVO

	Roles []*RoleDTO `json:"roles"`
}

type SessionDTO struct {
	BaseDTO

	ExpiredAt     lang.Time `json:"expired_at"`    // 会话的过期时间
	User          UserDTO   `json:"user"`          // 用户信息
	Authenticated bool      `json:"authenticated"` // 是否已验证

	Properties map[string]string `json:"properties"`
}

type SessionVO struct {
	BaseVO

	Sessions []*SessionDTO `json:"sessions"`
}

type SimplePhoneNumber PhoneNumber

type TokenDTO struct {
	BaseDTO

	ExpiredAt lang.Time   `json:"expired_at"` // 令牌的过期时间
	Session   *SessionDTO `json:"session"`    // 会话信息

	Properties map[string]string `json:"properties"`
}

type UserDTO struct {
	ID UserID `json:"id"`

	BaseDTO

	Name     UserName     `json:"name"`
	NickName string       `json:"nickname"`
	Avatar   string       `json:"avatar"`
	Phone    string       `json:"phone"`
	Email    string       `json:"email"`
	Roles    RoleNameList `json:"roles"`
	Enabled  bool         `json:"enabled"`
}

type UserID int64

type UserInfo struct {
	UserDTO
}

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

type UserName string

type UserQuery struct {
	Pagination Pagination
	Conditions map[string]string
	All        bool // 查询全部条目
}

type UserService interface {
	Insert(c context.Context, o *UserDTO) (*UserDTO, error)
	Update(c context.Context, id UserID, o *UserDTO) (*UserDTO, error)
	Delete(c context.Context, id UserID) error

	Find(c context.Context, id UserID) (*UserDTO, error)
	List(c context.Context, q *UserQuery) ([]*UserDTO, error)
}

type UserVO struct {
	BaseVO

	Users []*UserDTO `json:"users"`
}

type VOGetter interface {
	GetVO() *BaseVO
}