api

type APIControllerDefinitions map[string]APIControllerMaker

type APIControllerMaker func(
	config map[string]interface{},
	baseController kodex.Controller,
	definitions *Definitions) (Controller, error)

type APIPlugin interface {
	InitializeAPI(*gin.RouterGroup, Controller, kodex.Meter) error
	InitializeAdaptors(map[string]ObjectAdaptor) error
}

type AccessToken struct {
	Scopes []string `json:"scopes"`
	Token  []byte   `json:"-" coerce:"name:token"`
}

type AssociateAdaptor interface {
	Associate(c *gin.Context, left, right kodex.Model) bool
	Dissociate(c *gin.Context, left, right kodex.Model) bool
	Get(c *gin.Context, left kodex.Model) interface{}
	LeftType() string
	RightType() string
}

type BaseChangeRequest struct {
	Self     ChangeRequest
	Creator_ User
}

type BaseChangeRequestReview struct {
	Self     ChangeRequestReview
	Project_ kodex.Project
	Creator_ User
}

type BaseComment struct {
	Self     Comment
	Creator_ User
}

type BaseController struct {
	Definitions_  *Definitions
	UserProvider_ UserProvider
	Self          Controller
}

type BaseDefaultObjectRole struct {
	Self DefaultObjectRole
}

type BaseObjectRole struct {
	Self ObjectRole
}

type BaseOrganization struct {
	Self        Organization
	Controller_ Controller
}

type BaseUser struct {
	Self        User
	Controller_ Controller
}

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

type BlueprintSpec struct {
	Users []*ExternalUser   `json:"users"`
	Roles []*ObjectRoleSpec `json:"roles"`
}

type Change struct {
	Op          Op            `json:"op"`
	Value       any           `json:"value"`
	Path        []PathElement `json:"path"`
	Description string        `json:"description"`
}

type ChangeRequest interface {
	kodex.Model
	Title() string
	SetTitle(string) error
	Description() string
	SetDescription(string) error
	SetData(interface{}) error
	Data() interface{}
	Changes() []ChangeSet
	SetChanges([]ChangeSet) error
	SetStatus(ChangeRequestStatus) error
	Status() ChangeRequestStatus
	Reviews() ([]ChangeRequestReview, error)
	MakeReview(User) (ChangeRequestReview, error)
	Review([]byte) (ChangeRequestReview, error)
	Creator() User
	ObjectID() []byte
	ObjectType() string
}

type ChangeRequestReview interface {
	kodex.Model
	Description() string
	SetDescription(string) error
	SetData(interface{}) error
	Data() interface{}
	SetStatus(ChangeRequestReviewStatus) error
	Status() ChangeRequestReviewStatus
	ChangeRequest() ChangeRequest
	Creator() User
}

type ChangeRequestReviewStatus string

type ChangeRequestStatus string

type ChangeSet struct {
	Description string   `json:"description"`
	Changes     []Change `json:"changes"`
	Data        any      `json:"data"`
}

type Comment interface {
	kodex.Model
	Text() string
	SetText(string) error
	SetData(interface{}) error
	Data() interface{}
	SetStatus(CommentStatus) error
	Status() CommentStatus
	Creator() User
	ObjectID() []byte
	ObjectType() string
}

type CommentStatus string

type Controller interface {
	kodex.Controller

	// Clone the controller
	ApiClone() (Controller, error)

	KodexController() kodex.Controller
	RegisterAPIPlugin(APIPlugin) error
	APIDefinitions() *Definitions

	// User provider
	UserProvider() (UserProvider, error)

	// Object roles
	CanAccess(user *ExternalUser, object kodex.Model, objectRoles []string) (bool, error)
	ObjectRole(id []byte) (ObjectRole, error)
	RolesForObject(object kodex.Model) ([]ObjectRole, error)
	ObjectRolesForUser(objectType string, user *ExternalUser) ([]ObjectRole, error)
	ObjectRolesForOrganizationRoles(objectType string, organizationRoles []string, organizationID []byte) ([]ObjectRole, error)
	MakeObjectRole(object kodex.Model, organization Organization) ObjectRole

	// Default object roles
	DefaultObjectRoles(organizationID []byte) ([]DefaultObjectRole, error)
	DefaultObjectRole(id []byte) (DefaultObjectRole, error)
	MakeDefaultObjectRole(objectType string, organization Organization) DefaultObjectRole

	// Change request
	ChangeRequests(object kodex.Model) ([]ChangeRequest, error)
	ChangeRequest(id []byte) (ChangeRequest, error)
	MakeChangeRequest(id []byte, object kodex.Model, user User) (ChangeRequest, error)

	// Users
	MakeUser() User
	User(source string, sourceID []byte) (User, error)
	Users(filters map[string]interface{}) ([]User, error)

	// Organizations
	MakeOrganization() Organization
	Organization(source string, sourceID []byte) (Organization, error)
	Organizations(filters map[string]interface{}) ([]Organization, error)
}

type Copyable interface {
	Copy() any
}

type CreateObjectAdaptor interface {
	MakeObject(*gin.Context) kodex.Model
}

type CreateUserProvider interface {
	Create(user *ExternalUser) error
}

type DefaultObjectRole interface {
	kodex.Model
	OrganizationID() []byte
	OrganizationRole() string
	SetOrganizationRole(string) error
	ObjectRole() string
	SetObjectRole(string) error
	ObjectType() string
}

type Definitions struct {
	kodex.Definitions
	Routes                   []Routes
	APIControllerDefinitions APIControllerDefinitions
	ObjectAdaptors           map[string]ObjectAdaptor
	AssociateAdaptors        map[string]AssociateAdaptor
	UserProviders            map[string]UserProviderDefinition
}

type DiffOptions struct {
	Identifiers []string
}

type ExternalUser struct {
	Source      string                 `json:"source"`
	SourceID    []byte                 `json:"sourceID"`
	Email       string                 `json:"email"`
	DisplayName string                 `json:"displayName"`
	Superuser   bool                   `json:"superuser"`
	AccessToken *AccessToken           `json:"accessToken"`
	Roles       []*OrganizationRoles   `json:"roles"`
	Limits      map[string]interface{} `json:"limits"`
	// contains filtered or unexported fields
}

type IsChangeRequestReviewStatus struct{}

type IsChangeRequestStatus struct{}

type IsCommentStatus struct{}

type ListAllObjectAdaptor interface {
	AllObjects(*gin.Context) []kodex.Model
}

type ObjectAdaptor interface {
	// Returns the object for the given ID and its role object, if possible
	Get(Controller, *gin.Context, []byte) (kodex.Model, kodex.Model, error)
	Initialize(Controller, *gin.RouterGroup) error
	Objects(*gin.Context) []kodex.Model
	Type() string
	DependsOn() string
}

type ObjectRole interface {
	kodex.Model
	OrganizationID() []byte
	ObjectID() []byte
	OrganizationRole() string
	SetOrganizationRole(string) error
	ObjectRole() string
	SetObjectRole(string) error
	ObjectType() string
}

type ObjectRoleSpec struct {
	ObjectRole         string `json:"objectRole"`
	OrganizationRole   string `json:"organizationRole"`
	OrganizationID     []byte `json:"organizationID"`
	OrganizationSource string `json:"organizationSource"`
	ObjectID           []byte `json:"objectID"`
	ObjectType         string `json:"objectType"`
}

type Op int

type Organization interface {
	kodex.Model
	Source() string
	SourceID() []byte
	Name() string
	SetName(string) error
	Description() string
	SetDescription(string) error
	SetSource(string) error
	SetSourceID([]byte) error
	Data() interface{}
	SetData(interface{}) error
}

type OrganizationRoles struct {
	Roles        []string          `json:"roles"`
	Organization *UserOrganization `json:"organization"`
}

type PathElement struct {
	PathType   PathType `json:"pathType"`
	Name       string   `json:"name"`
	Index      int      `json:"index"`
	Identifier string   `json:"identifier"`
	Value      any      `json:"value"`
}

type PathType int

type Routes func(*gin.RouterGroup, Controller, kodex.Meter) error

type Settings struct {
	UserProvider *UserProviderSettings `json:"userProvider"`
}

type SettingsValidator func(settings map[string]interface{}) (interface{}, error)

type UpdateObjectAdaptor interface {
	UpdateObject(kodex.Model, map[string]interface{}) (kodex.Model, error)
	SaveUpdated(updatedObject, object kodex.Model) error
}

type User interface {
	kodex.Model
	Source() string
	SourceID() []byte
	Email() string
	DisplayName() string
	Superuser() bool
	SetDisplayName(string) error
	SetEmail(string) error
	SetSuperuser(bool) error
	SetSource(string) error
	SetSourceID([]byte) error
	Data() interface{}
	SetData(interface{}) error
}

type UserOrganization struct {
	Source      string `json:"source"`
	Name        string `json:"name"`
	Default     bool   `json:"default"`
	Description string `json:"description"`
	ID          []byte `json:"id"`
	// contains filtered or unexported fields
}

type UserProvider interface {
	Initialize(controller Controller, group *gin.RouterGroup) error
	Logout(controller Controller, request *http.Request, writer http.ResponseWriter) error
	Get(controller Controller, request *http.Request) (*ExternalUser, error)
}

type UserProviderDefinition struct {
	Name              string            `json:"name"`
	Description       string            `json:"description"`
	Maker             UserProviderMaker `json:"-"`
	SettingsValidator SettingsValidator `json:"-"`
}

type UserProviderDefinitions map[string]UserProviderDefinition

type UserProviderMaker func(settings kodex.Settings) (UserProvider, error)

type UserProviderPlugin interface {
	InitializeUserProviders(map[string]UserProviderDefinition) error
}

type UserProviderSettings struct {
	Type     string      `json:"type"`
	Settings interface{} `json:"settings"`
}