modelauthz

type API struct {
	model.Empty
}

type APIRsp = []string

type Button struct {
	Name string // button display name
	Code string // unique button code/identifier
	Icon string // icon name from backend

	Status   int   // 0: disabled, 1: enabled
	Visiable *bool // whether the button is rendered in UI

	MenuID string // parent menu id

	model.Base
}

type CasbinRule struct {
	// ID uint64 `json:"id" gorm:"primaryKey"`
	ID    uint64 `json:"id" gorm:"primaryKey;autoIncrement:true"`
	Ptype string `json:"ptype" gorm:"size:100" schema:"ptype"`
	V0    string `json:"v0,omitempty" gorm:"size:100" schema:"v0"`
	V1    string `json:"v1,omitempty" gorm:"size:100" schema:"v1"`
	V2    string `json:"v2,omitempty" gorm:"size:100" schema:"v2"`
	V3    string `json:"v3,omitempty" gorm:"size:100" schema:"v3"`
	V4    string `json:"v4,omitempty" gorm:"size:100" schema:"v4"`
	V5    string `json:"v5,omitempty" gorm:"size:100" schema:"v5"`

	User string `json:"user,omitempty" schema:"user"` // 只是用来记录一些信息, V0 为 user_id
	Role string `json:"role,omitempty" schema:"role"` // 只是用来记录一些信息, V1 为 role code

	model.Base
}

type Menu struct {
	API   datatypes.JSONSlice[string] `json:"api,omitempty" schema:"api"`     // 后端路由, 如果为空则使用 "/api" + Path
	Path  string                      `json:"path,omitempty" schema:"path"`   // path should not add `omitempty` tag, empty value means default router in react route6.x.
	Label string                      `json:"label,omitempty" schema:"label"` // 页面组件左侧的菜单名
	Icon  string                      `json:"icon,omitempty" schema:"icon"`   // 页面组件左侧的菜单图标

	Visiable *bool  `json:"visiable,omitempty" schema:"visiable" gorm:"default:1"`                                                   // 前端页面路由是否可见
	Default  string `json:"default,omitempty" schema:"default"`                                                                      // 子路由中的默认路由, 如果有 Children, Default 才可能存在
	Status   *uint  `json:"status,omitempty" gorm:"type:smallint;default:1;comment:status(0: disabled, 1: enabled)" schema:"status"` // 该路由是否启用

	ParentID string  `json:"parent_id,omitempty" gorm:"size:191" schema:"parent_id"`
	Children []*Menu `json:"children,omitempty" gorm:"foreignKey:ParentID"`             // 子路由
	Parent   *Menu   `json:"parent,omitempty" gorm:"foreignKey:ParentID;references:ID"` // 父路由

	// the empty value of `Platform` means all.
	Platform MenuPlatform `json:"platform,omitempty" schema:"platform"`

	DomainPattern string `json:"domain_pattern,omitempty" schema:"domain_pattern" gorm:"default:.*"`

	model.Base
}

type MenuPlatform string

type Permission struct {
	Resource string `json:"resource,omitempty" schema:"resource"`
	Action   string `json:"action,omitempty" schema:"action"`

	model.Base
}

type Role struct {
	Name    string `json:"name,omitempty" schema:"name" gorm:"size:191;unique"`
	Code    string `json:"code,omitempty" schema:"code" gorm:"size:191;unique"`
	Default *bool  `json:"default,omitempty" schema:"default"`

	// Scope holds generic constraints for regional roles.
	// Keys and values are user-defined and framework-agnostic.
	Scope datatypes.JSONMap `json:"scope,omitempty"`

	// Menu permissions owned by this role
	MenuIDs        datatypes.JSONSlice[string] `json:"menu_ids,omitempty"`
	MenuPartialIDs datatypes.JSONSlice[string] `json:"menu_partial_ids,omitempty"`
	ButtonIDs      datatypes.JSONSlice[string] `json:"button_ids,omitempty"`

	Menus        []*Menu `json:"menus,omitempty" gorm:"-"`
	MenuPartials []*Menu `json:"menu_partials,omitempty" gorm:"-"`

	model.Base
}

type RolePermission struct {
	Role string `json:"role" schema:"role"`

	Resource string        `json:"resource" schema:"resource"`
	Action   string        `json:"action" schema:"action"`
	Effect   consts.Effect `json:"effect" schema:"effect"`

	model.Base
}

type UserRole struct {
	UserID string `json:"user_id,omitempty" schema:"user_id"`
	RoleID string `json:"role_id,omitempty" schema:"role_id"`

	RoleCode string `json:"rolecode,omitempty" schema:"rolecode"` // 角色Code, 用于 RBAC 角色控制和前端查询
	Username string `json:"username,omitempty" schema:"username"` // 用户名, 用于 RBAC 用户控制和前端查询

	User *modeliamuser.User `json:"user,omitempty" gorm:"-"`
	Role *Role              `json:"role,omitempty" gorm:"-"`

	model.Base
}