plugin_entities

type AgentStrategyDeclaration struct {
	Identity     AgentStrategyIdentity     `json:"identity" yaml:"identity" validate:"required"`
	Description  I18nObject                `json:"description" yaml:"description" validate:"required"`
	Parameters   []AgentStrategyParameter  `json:"parameters" yaml:"parameters" validate:"omitempty,dive"`
	OutputSchema AgentStrategyOutputSchema `json:"output_schema" yaml:"output_schema" validate:"omitempty"`
	Features     []string                  `json:"features" yaml:"features" validate:"omitempty,dive,lt=256"`
}

type AgentStrategyIdentity struct {
	ToolIdentity `json:",inline" yaml:",inline"`
}

type AgentStrategyOutputSchema map[string]any

type AgentStrategyParameter struct {
	Name         string                     `json:"name" yaml:"name" validate:"required,gt=0,lt=1024"`
	Label        I18nObject                 `json:"label" yaml:"label" validate:"required"`
	Help         I18nObject                 `json:"help" yaml:"help" validate:"omitempty"`
	Type         AgentStrategyParameterType `json:"type" yaml:"type" validate:"required,agent_strategy_parameter_type"`
	AutoGenerate *ParameterAutoGenerate     `json:"auto_generate" yaml:"auto_generate" validate:"omitempty"`
	Template     *ParameterTemplate         `json:"template" yaml:"template" validate:"omitempty"`
	Scope        *string                    `json:"scope" yaml:"scope" validate:"omitempty,max=1024,is_scope"`
	Required     bool                       `json:"required" yaml:"required"`
	Default      any                        `json:"default" yaml:"default" validate:"omitempty,is_basic_type"`
	Min          *float64                   `json:"min" yaml:"min" validate:"omitempty"`
	Max          *float64                   `json:"max" yaml:"max" validate:"omitempty"`
	Precision    *int                       `json:"precision" yaml:"precision" validate:"omitempty"`
	Options      []ParameterOption          `json:"options" yaml:"options" validate:"omitempty,dive"`
}

type AgentStrategyParameterType string

type AgentStrategyProviderDeclaration struct {
	Identity      AgentStrategyProviderIdentity `json:"identity" yaml:"identity" validate:"required"`
	Strategies    []AgentStrategyDeclaration    `json:"strategies" yaml:"strategies" validate:"required,dive"`
	StrategyFiles []string                      `json:"-" yaml:"-"`
}

type AgentStrategyProviderIdentity struct {
	ToolProviderIdentity `json:",inline" yaml:",inline"`
}

type AnyScope string

type AppSelectorScope string

type BasePluginIdentifier struct {
	PluginID string `json:"plugin_id"`
}

type ConfigOption struct {
	Value string     `json:"value" validate:"required,lt=128"`
	Label I18nObject `json:"label" validate:"required"`
}

type ConfigType string

type DatasourceDeclaration struct {
	Identity     DatasourceIdentity     `json:"identity" yaml:"identity" validate:"required"`
	Parameters   []DatasourceParameter  `json:"parameters" yaml:"parameters" validate:"required,dive"`
	Description  I18nObject             `json:"description" yaml:"description" validate:"required"`
	OutputSchema DatasourceOutputSchema `json:"output_schema,omitempty" yaml:"output_schema,omitempty"`
}

type DatasourceIdentity struct {
	Author string     `json:"author" yaml:"author" validate:"required"`
	Name   string     `json:"name" yaml:"name" validate:"required"`
	Label  I18nObject `json:"label" yaml:"label" validate:"required"`
	Icon   string     `json:"icon" yaml:"icon" validate:"omitempty"`
}

type DatasourceOutputSchema map[string]any

type DatasourceParameter struct {
	Name         string                  `json:"name" yaml:"name" validate:"required,gt=0,lt=1024"`
	Label        I18nObject              `json:"label" yaml:"label" validate:"required"`
	Type         DatasourceParameterType `json:"type" yaml:"type" validate:"required,datasource_parameter_type"`
	Scope        *string                 `json:"scope" yaml:"scope" validate:"omitempty,max=1024,is_scope"`
	Required     bool                    `json:"required" yaml:"required"`
	AutoGenerate *ParameterAutoGenerate  `json:"auto_generate" yaml:"auto_generate" validate:"omitempty"`
	Template     *ParameterTemplate      `json:"template" yaml:"template" validate:"omitempty"`
	Default      any                     `json:"default" yaml:"default" validate:"omitempty,is_basic_type"`
	Min          *float64                `json:"min" yaml:"min" validate:"omitempty"`
	Max          *float64                `json:"max" yaml:"max" validate:"omitempty"`
	Precision    *int                    `json:"precision" yaml:"precision" validate:"omitempty"`
	Options      []ParameterOption       `json:"options" yaml:"options" validate:"omitempty,dive"`
	Description  I18nObject              `json:"description" yaml:"description" validate:"required"`
}

type DatasourceParameterType string

type DatasourceProviderDeclaration struct {
	Identity          DatasourceProviderIdentity `json:"identity" yaml:"identity" validate:"required"`
	CredentialsSchema []ProviderConfig           `json:"credentials_schema" yaml:"credentials_schema" validate:"omitempty,dive"`
	OAuthSchema       *OAuthSchema               `json:"oauth_schema" yaml:"oauth_schema" validate:"omitempty"`
	ProviderType      DatasourceType             `json:"provider_type" yaml:"provider_type" validate:"required,datasource_provider_type"`
	Datasources       []DatasourceDeclaration    `json:"datasources" yaml:"datasources" validate:"required,dive"`
	DatasourceFiles   []string                   `json:"-" yaml:"-"`
}

type DatasourceProviderIdentity struct {
	Author      string                        `json:"author" yaml:"author" validate:"required"`
	Name        string                        `json:"name" yaml:"name" validate:"required"`
	Description I18nObject                    `json:"description" yaml:"description" validate:"required"`
	Icon        string                        `json:"icon" yaml:"icon" validate:"required"`
	Label       I18nObject                    `json:"label" yaml:"label" validate:"required"`
	Tags        []manifest_entities.PluginTag `json:"tags" yaml:"tags" validate:"omitempty,dive,plugin_tag"`
}

type DatasourceType string

type DefaultParameterName string

type EndpointDeclaration struct {
	Path   string         `json:"path" yaml:"path" validate:"required"`
	Method EndpointMethod `json:"method" yaml:"method" validate:"required,is_available_endpoint_method"`
	Hidden bool           `json:"hidden" yaml:"hidden" validate:"omitempty"`
}

type EndpointMethod string

type EndpointProviderDeclaration struct {
	Settings      []ProviderConfig      `json:"settings" yaml:"settings" validate:"omitempty,dive"`
	Endpoints     []EndpointDeclaration `json:"endpoints" yaml:"endpoint_declarations" validate:"omitempty,dive"`
	EndpointFiles []string              `json:"-" yaml:"-"`
}

type ErrorResponse struct {
	Message   string         `json:"message"`
	ErrorType string         `json:"error_type"`
	Args      map[string]any `json:"args" validate:"omitempty,max=10"` // max 10 args
}

type EventDeclaration struct {
	Identity     EventIdentity    `json:"identity" yaml:"identity" validate:"required"`
	Parameters   []EventParameter `json:"parameters" yaml:"parameters" validate:"omitempty,dive"`
	Description  I18nObject       `json:"description" yaml:"description" validate:"required"`
	OutputSchema map[string]any   `json:"output_schema,omitempty" yaml:"output_schema,omitempty"`
}

type EventIdentity struct {
	Author string     `json:"author" yaml:"author" validate:"required"`
	Name   string     `json:"name" yaml:"name" validate:"required,event_identity_name"`
	Label  I18nObject `json:"label" yaml:"label" validate:"required"`
}

type EventParameter struct {
	Name         string                 `json:"name" yaml:"name" validate:"required"`
	Label        I18nObject             `json:"label" yaml:"label" validate:"required"`
	Type         EventParameterType     `json:"type" yaml:"type" validate:"required,event_parameter_type"`
	AutoGenerate *ParameterAutoGenerate `json:"auto_generate,omitempty" yaml:"auto_generate,omitempty"`
	Template     *ParameterTemplate     `json:"template,omitempty" yaml:"template,omitempty"`
	Scope        *string                `json:"scope,omitempty" yaml:"scope,omitempty"`
	Required     bool                   `json:"required" yaml:"required"`
	Multiple     bool                   `json:"multiple,omitempty" yaml:"multiple,omitempty"`
	Default      any                    `json:"default,omitempty" yaml:"default,omitempty"`
	Min          *float64               `json:"min,omitempty" yaml:"min,omitempty"`
	Max          *float64               `json:"max,omitempty" yaml:"max,omitempty"`
	Precision    *int                   `json:"precision,omitempty" yaml:"precision,omitempty"`
	Options      []EventParameterOption `json:"options,omitempty" yaml:"options,omitempty" validate:"omitempty,dive"`
	Description  *I18nObject            `json:"description,omitempty" yaml:"description,omitempty"`
}

type EventParameterOption struct {
	Label I18nObject `json:"label" yaml:"label" validate:"required"`
	Value any        `json:"value" yaml:"value" validate:"required"`
}

type EventParameterType string

type FieldModelSchema struct {
	Label       I18nObject  `json:"label" yaml:"label" validate:"required"`
	Placeholder *I18nObject `json:"placeholder" yaml:"placeholder" validate:"omitempty"`
}

type I18nObject struct {
	EnUS   string `json:"en_US" yaml:"en_US" validate:"required,gt=0,lt=1024"`
	JaJp   string `json:"ja_JP,omitempty" yaml:"ja_JP,omitempty" validate:"lt=1024"`
	ZhHans string `json:"zh_Hans,omitempty" yaml:"zh_Hans,omitempty" validate:"lt=1024"`
	PtBr   string `json:"pt_BR,omitempty" yaml:"pt_BR,omitempty" validate:"lt=1024"`
}

type InvokePluginRequest[T any] struct {
	InvokePluginUserIdentity
	BasePluginIdentifier

	UniqueIdentifier PluginUniqueIdentifier `json:"unique_identifier"`
	ConversationID   *string                `json:"conversation_id"`
	MessageID        *string                `json:"message_id"`
	AppID            *string                `json:"app_id"`
	EndpointID       *string                `json:"endpoint_id"`
	Context          map[string]any         `json:"context"`

	Data T `json:"data" validate:"required"`
}

type InvokePluginUserIdentity struct {
	TenantId string `json:"tenant_id" validate:"required" uri:"tenant_id"`
	UserId   string `json:"user_id"`
}

type ModelConfigScope string

type ModelCredentialSchema struct {
	Model                 FieldModelSchema                    `json:"model" yaml:"model" validate:"required"`
	CredentialFormSchemas []ModelProviderCredentialFormSchema `json:"credential_form_schemas" yaml:"credential_form_schemas" validate:"omitempty,lte=32,dive"`
}

type ModelDeclaration struct {
	Model           string                         `json:"model" yaml:"model" validate:"required,lt=256"`
	Label           I18nObject                     `json:"label" yaml:"label" validate:"required"`
	ModelType       ModelType                      `json:"model_type" yaml:"model_type" validate:"required,model_type"`
	Features        []string                       `json:"features" yaml:"features" validate:"omitempty,lte=256,dive,lt=256"`
	FetchFrom       ModelProviderConfigurateMethod `json:"fetch_from" yaml:"fetch_from" validate:"omitempty,model_provider_configurate_method"`
	ModelProperties map[string]any                 `json:"model_properties" yaml:"model_properties" validate:"omitempty"`
	Deprecated      bool                           `json:"deprecated" yaml:"deprecated"`
	ParameterRules  []ModelParameterRule           `json:"parameter_rules" yaml:"parameter_rules" validate:"omitempty,lte=128,dive,parameter_rule"`
	PriceConfig     *ModelPriceConfig              `json:"pricing" yaml:"pricing" validate:"omitempty"`
}

type ModelParameterRule struct {
	Name        string              `json:"name" yaml:"name" validate:"required,lt=256"`
	UseTemplate *string             `json:"use_template" yaml:"use_template" validate:"omitempty,lt=256"`
	Label       *I18nObject         `json:"label" yaml:"label" validate:"omitempty"`
	Type        *ModelParameterType `json:"type" yaml:"type" validate:"omitempty,model_parameter_type"`
	Help        *I18nObject         `json:"help" yaml:"help" validate:"omitempty"`
	Required    bool                `json:"required" yaml:"required"`
	Default     *any                `json:"default" yaml:"default" validate:"omitempty,is_basic_type"`
	Min         *float64            `json:"min" yaml:"min" validate:"omitempty"`
	Max         *float64            `json:"max" yaml:"max" validate:"omitempty"`
	Precision   *int                `json:"precision" yaml:"precision" validate:"omitempty"`
	Options     []string            `json:"options" yaml:"options" validate:"omitempty,dive,lt=256"`
}

type ModelParameterType string

type ModelPosition struct {
	LLM           *[]string `json:"llm,omitempty" yaml:"llm,omitempty"`
	TextEmbedding *[]string `json:"text_embedding,omitempty" yaml:"text_embedding,omitempty"`
	Rerank        *[]string `json:"rerank,omitempty" yaml:"rerank,omitempty"`
	TTS           *[]string `json:"tts,omitempty" yaml:"tts,omitempty"`
	Speech2text   *[]string `json:"speech2text,omitempty" yaml:"speech2text,omitempty"`
	Moderation    *[]string `json:"moderation,omitempty" yaml:"moderation,omitempty"`
}

type ModelPriceConfig struct {
	Input    decimal.Decimal  `json:"input" yaml:"input" validate:"required"`
	Output   *decimal.Decimal `json:"output" yaml:"output" validate:"omitempty"`
	Unit     decimal.Decimal  `json:"unit" yaml:"unit" validate:"required"`
	Currency string           `json:"currency" yaml:"currency" validate:"required"`
}

type ModelProviderConfigurateMethod string

type ModelProviderCredentialFormSchema struct {
	Variable    string                          `json:"variable" yaml:"variable" validate:"required,lt=256"`
	Label       I18nObject                      `json:"label" yaml:"label" validate:"required"`
	Type        ModelProviderFormType           `json:"type" yaml:"type" validate:"required,model_provider_form_type"`
	Required    bool                            `json:"required" yaml:"required"`
	Default     *string                         `json:"default" yaml:"default" validate:"omitempty,lt=256"`
	Options     []ModelProviderFormOption       `json:"options" yaml:"options" validate:"omitempty,lte=128,dive"`
	Placeholder *I18nObject                     `json:"placeholder" yaml:"placeholder" validate:"omitempty"`
	MaxLength   int                             `json:"max_length" yaml:"max_length"`
	ShowOn      []ModelProviderFormShowOnObject `json:"show_on" yaml:"show_on" validate:"omitempty,lte=16,dive"`
}

type ModelProviderCredentialSchema struct {
	CredentialFormSchemas []ModelProviderCredentialFormSchema `json:"credential_form_schemas" yaml:"credential_form_schemas" validate:"omitempty,lte=32,dive"`
}

type ModelProviderDeclaration struct {
	Provider                 string                           `json:"provider" yaml:"provider" validate:"required,lt=256"`
	Label                    I18nObject                       `json:"label" yaml:"label" validate:"required"`
	Description              *I18nObject                      `json:"description" yaml:"description,omitempty" validate:"omitempty"`
	IconSmall                *I18nObject                      `json:"icon_small" yaml:"icon_small,omitempty" validate:"omitempty"`
	IconLarge                *I18nObject                      `json:"icon_large" yaml:"icon_large,omitempty" validate:"omitempty"`
	IconSmallDark            *I18nObject                      `json:"icon_small_dark" yaml:"icon_small_dark,omitempty" validate:"omitempty"`
	IconLargeDark            *I18nObject                      `json:"icon_large_dark" yaml:"icon_large_dark,omitempty" validate:"omitempty"`
	Background               *string                          `json:"background" yaml:"background,omitempty" validate:"omitempty"`
	Help                     *ModelProviderHelpEntity         `json:"help" yaml:"help,omitempty" validate:"omitempty"`
	SupportedModelTypes      []ModelType                      `json:"supported_model_types" yaml:"supported_model_types" validate:"required,lte=16,dive,model_type"`
	ConfigurateMethods       []ModelProviderConfigurateMethod `json:"configurate_methods" yaml:"configurate_methods" validate:"required,lte=16,dive,model_provider_configurate_method"`
	ProviderCredentialSchema *ModelProviderCredentialSchema   `json:"provider_credential_schema" yaml:"provider_credential_schema,omitempty" validate:"omitempty"`
	ModelCredentialSchema    *ModelCredentialSchema           `json:"model_credential_schema" yaml:"model_credential_schema,omitempty" validate:"omitempty"`
	Position                 *ModelPosition                   `json:"position,omitempty" yaml:"position,omitempty"`
	Models                   []ModelDeclaration               `json:"models" yaml:"model_declarations,omitempty"`
	ModelFiles               []string                         `json:"-" yaml:"-"`
	PositionFiles            map[string]string                `json:"-" yaml:"-"`
}

type ModelProviderFormOption struct {
	Label  I18nObject                      `json:"label" yaml:"label" validate:"required"`
	Value  string                          `json:"value" yaml:"value" validate:"required,lt=256"`
	ShowOn []ModelProviderFormShowOnObject `json:"show_on" yaml:"show_on" validate:"omitempty,lte=16,dive"`
}

type ModelProviderFormShowOnObject struct {
	Variable string `json:"variable" yaml:"variable" validate:"required,lt=256"`
	Value    string `json:"value" yaml:"value" validate:"required,lt=256"`
}

type ModelProviderFormType string

type ModelProviderHelpEntity struct {
	Title I18nObject `json:"title" yaml:"title" validate:"required"`
	URL   I18nObject `json:"url" yaml:"url" validate:"required"`
}

type ModelType string

type OAuthSchema struct {
	// ClientSchema contains client_id, client_secret, redirect_uri, etc. which are required to be set by system admin
	ClientSchema []ProviderConfig `json:"client_schema" yaml:"client_schema" validate:"omitempty,dive"`

	// CredentialsSchema contains schema of access_token, refresh_token, etc.
	CredentialsSchema []ProviderConfig `json:"credentials_schema" yaml:"credentials_schema" validate:"omitempty,dive"`
}

type ParameterAutoGenerate struct {
	Type ParameterAutoGenerateType `json:"type" yaml:"type" validate:"required,parameter_auto_generate_type"`
}

type ParameterAutoGenerateType string

type ParameterOption struct {
	Value string     `json:"value" yaml:"value" validate:"required"`
	Label I18nObject `json:"label" yaml:"label" validate:"required"`
	Icon  string     `json:"icon" yaml:"icon" validate:"omitempty"`
}

type ParameterTemplate struct {
	Enabled bool `json:"enabled" yaml:"enabled"`
}

type PluginBasicInfoInterface interface {
	// returns the runtime type of the plugin
	Type() PluginRuntimeType
	// returns the plugin configuration
	Configuration() *PluginDeclaration
	// unique identity of the plugin
	Identity() (PluginUniqueIdentifier, error)
	// hashed identity of the plugin
	HashedIdentity() (string, error)
	// returns the checksum of the plugin
	Checksum() (string, error)
}

type PluginCategory string

type PluginClusterLifetime interface {
	// returns the runtime state of the plugin
	RuntimeState() PluginRuntimeState
}

type PluginDeclaration struct {
	PluginDeclarationWithoutAdvancedFields `yaml:",inline"`
	Verified                               bool                              `json:"verified" yaml:"verified"`
	Endpoint                               *EndpointProviderDeclaration      `json:"endpoint,omitempty" yaml:"endpoint,omitempty" validate:"omitempty"`
	Model                                  *ModelProviderDeclaration         `json:"model,omitempty" yaml:"model,omitempty" validate:"omitempty"`
	Tool                                   *ToolProviderDeclaration          `json:"tool,omitempty" yaml:"tool,omitempty" validate:"omitempty"`
	AgentStrategy                          *AgentStrategyProviderDeclaration `json:"agent_strategy,omitempty" yaml:"agent_strategy,omitempty" validate:"omitempty"`
	Datasource                             *DatasourceProviderDeclaration    `json:"datasource,omitempty" yaml:"datasource,omitempty" validate:"omitempty"`
	Trigger                                *TriggerProviderDeclaration       `json:"trigger,omitempty" yaml:"trigger,omitempty" validate:"omitempty"`
}

type PluginDeclarationPlatformArch string

type PluginDeclarationWithoutAdvancedFields struct {
	Version     manifest_entities.Version          `json:"version" yaml:"version,omitempty" validate:"required,version"`
	Type        manifest_entities.DifyManifestType `json:"type" yaml:"type,omitempty" validate:"required,eq=plugin"`
	Author      string                             `json:"author" yaml:"author,omitempty" validate:"omitempty,max=64"`
	Name        string                             `json:"name" yaml:"name,omitempty" validate:"required,max=128"`
	Label       I18nObject                         `json:"label" yaml:"label" validate:"required"`
	Description I18nObject                         `json:"description" yaml:"description" validate:"required"`
	Icon        string                             `json:"icon" yaml:"icon,omitempty" validate:"required,max=128"`
	IconDark    string                             `json:"icon_dark" yaml:"icon_dark,omitempty" validate:"omitempty,max=128"`
	Resource    PluginResourceRequirement          `json:"resource" yaml:"resource,omitempty" validate:"required"`
	Plugins     PluginExtensions                   `json:"plugins" yaml:"plugins,omitempty" validate:"required"`
	Meta        PluginMeta                         `json:"meta" yaml:"meta,omitempty" validate:"required"`
	Tags        []manifest_entities.PluginTag      `json:"tags" yaml:"tags,omitempty" validate:"omitempty,dive,plugin_tag,max=128"`
	CreatedAt   time.Time                          `json:"created_at" yaml:"created_at,omitempty" validate:"required"`
	Privacy     *string                            `json:"privacy,omitempty" yaml:"privacy,omitempty" validate:"omitempty"`
	Repo        *string                            `json:"repo,omitempty" yaml:"repo,omitempty" validate:"omitempty,url"`
}

type PluginEventType string

type PluginExtensions struct {
	Tools           []string `json:"tools" yaml:"tools,omitempty" validate:"omitempty,dive,max=128"`
	Models          []string `json:"models" yaml:"models,omitempty" validate:"omitempty,dive,max=128"`
	Endpoints       []string `json:"endpoints" yaml:"endpoints,omitempty" validate:"omitempty,dive,max=128"`
	AgentStrategies []string `json:"agent_strategies" yaml:"agent_strategies,omitempty" validate:"omitempty,dive,max=128"`
	Datasources     []string `json:"datasources" yaml:"datasources,omitempty" validate:"omitempty,dive,max=128"`
	Triggers        []string `json:"triggers" yaml:"triggers,omitempty" validate:"omitempty,dive,max=128"`
}

type PluginFullDuplexLifetime interface {
	PluginLifetime

	// before the plugin starts, it will call this method to initialize the environment
	InitEnvironment() error
	// Cleanup the plugin runtime
	Cleanup()
	// set the plugin to active
	SetActive()
	// set the plugin to launching
	SetLaunching()
	// set the plugin to restarting
	SetRestarting()
	// set the plugin to pending
	SetPending()
	// set the active time of the plugin
	SetActiveAt(t time.Time)
	// set the scheduled time of the plugin
	SetScheduledAt(t time.Time)
}

type PluginLifetime interface {
	PluginBasicInfoInterface
	PluginRuntimeSessionIOInterface
	PluginClusterLifetime
}

type PluginLogEvent struct {
	Level     string  `json:"level"`
	Message   string  `json:"message"`
	Timestamp float64 `json:"timestamp"`
}

type PluginMeta struct {
	Version            string           `json:"version" yaml:"version" validate:"required,version"`
	Arch               []constants.Arch `json:"arch" yaml:"arch" validate:"required,dive,is_available_arch"`
	Runner             PluginRunner     `json:"runner" yaml:"runner" validate:"required"`
	MinimumDifyVersion *string          `json:"minimum_dify_version" yaml:"minimum_dify_version"`
}

type PluginPermissionAppRequirement struct {
	Enabled bool `json:"enabled" yaml:"enabled"`
}

type PluginPermissionEndpointRequirement struct {
	Enabled bool `json:"enabled" yaml:"enabled"`
}

type PluginPermissionModelRequirement struct {
	Enabled       bool `json:"enabled" yaml:"enabled"`
	LLM           bool `json:"llm" yaml:"llm"`
	TextEmbedding bool `json:"text_embedding" yaml:"text_embedding"`
	Rerank        bool `json:"rerank" yaml:"rerank"`
	TTS           bool `json:"tts" yaml:"tts"`
	Speech2text   bool `json:"speech2text" yaml:"speech2text"`
	Moderation    bool `json:"moderation" yaml:"moderation"`
}

type PluginPermissionNodeRequirement struct {
	Enabled bool `json:"enabled" yaml:"enabled"`
}

type PluginPermissionRequirement struct {
	Tool     *PluginPermissionToolRequirement     `json:"tool,omitempty" yaml:"tool,omitempty" validate:"omitempty"`
	Model    *PluginPermissionModelRequirement    `json:"model,omitempty" yaml:"model,omitempty" validate:"omitempty"`
	Node     *PluginPermissionNodeRequirement     `json:"node,omitempty" yaml:"node,omitempty" validate:"omitempty"`
	Endpoint *PluginPermissionEndpointRequirement `json:"endpoint,omitempty" yaml:"endpoint,omitempty" validate:"omitempty"`
	App      *PluginPermissionAppRequirement      `json:"app,omitempty" yaml:"app,omitempty" validate:"omitempty"`
	Storage  *PluginPermissionStorageRequirement  `json:"storage,omitempty" yaml:"storage,omitempty" validate:"omitempty"`
}

type PluginPermissionStorageRequirement struct {
	Enabled bool   `json:"enabled" yaml:"enabled"`
	Size    uint64 `json:"size" yaml:"size" validate:"min=1024,max=1073741824"` // min 1024 bytes, max 1G
}

type PluginPermissionToolRequirement struct {
	Enabled bool `json:"enabled" yaml:"enabled"`
}

type PluginResourceRequirement struct {
	// Memory in bytes
	Memory int64 `json:"memory" yaml:"memory" validate:"required"`
	// Permission requirements
	Permission *PluginPermissionRequirement `json:"permission,omitempty" yaml:"permission,omitempty" validate:"omitempty"`
}

type PluginRunner struct {
	Language   constants.Language `json:"language" yaml:"language" validate:"required,is_available_language"`
	Version    string             `json:"version" yaml:"version" validate:"required,max=128"`
	Entrypoint string             `json:"entrypoint" yaml:"entrypoint" validate:"required,max=256"`
}

type PluginRuntime struct {
	State  PluginRuntimeState `json:"state"`
	Config PluginDeclaration  `json:"config"`
}

type PluginRuntimeSessionIOInterface interface {
	PluginBasicInfoInterface
	// Listen listens for messages from the plugin
	Listen(session_id string) (*entities.Broadcast[SessionMessage], error)
	// Write writes a message to the plugin
	Write(session_id string, action access_types.PluginAccessAction, data []byte) error
}

type PluginRuntimeState struct {
	Restarts    int        `json:"restarts"`
	Status      string     `json:"status"`
	WorkingPath string     `json:"working_path"`
	ActiveAt    *time.Time `json:"active_at"`
	StoppedAt   *time.Time `json:"stopped_at"`
	Verified    bool       `json:"verified"`
	ScheduledAt *time.Time `json:"scheduled_at"`
	Logs        []string   `json:"logs"`
}

type PluginRuntimeType string

type PluginServerlessLifetime interface {
	PluginLifetime

	// before the plugin starts, it will call this method to initialize the environment
	InitEnvironment() error
	// UploadPlugin uploads the plugin to the AWS Lambda
	UploadPlugin() error
}

type PluginUniqueIdentifier string

type PluginUniversalEvent struct {
	SessionId string          `json:"session_id"`
	Event     PluginEventType `json:"event"`
	Data      json.RawMessage `json:"data"`
}

type ProviderConfig struct {
	Name        string         `json:"name" validate:"omitempty,gt=0,lt=1024"`
	Type        ConfigType     `json:"type" validate:"required,credential_type"`
	Scope       *string        `json:"scope" validate:"omitempty,is_scope"`
	Required    bool           `json:"required"`
	Default     any            `json:"default" validate:"omitempty,is_basic_type"`
	Options     []ConfigOption `json:"options" validate:"omitempty,lt=128,dive"`
	Multiple    bool           `json:"multiple" validate:"omitempty"`
	Label       I18nObject     `json:"label" validate:"required"`
	Help        *I18nObject    `json:"help" validate:"omitempty"`
	URL         *string        `json:"url" validate:"omitempty"`
	Placeholder *I18nObject    `json:"placeholder" validate:"omitempty"`
}

type RemoteAssetPayload struct {
	Filename string `json:"filename" validate:"required"`
	Data     string `json:"data" validate:"required"`
}

type RemotePluginRegisterAssetChunk struct {
	Filename string `json:"filename" validate:"required"`
	Data     string `json:"data" validate:"required"`
	End      bool   `json:"end"` // if true, it's the last chunk of the file
}

type RemotePluginRegisterEventType string

type RemotePluginRegisterHandshake struct {
	Key string `json:"key" validate:"required"`
}

type RemotePluginRegisterPayload struct {
	Type RemotePluginRegisterEventType `json:"type" validate:"required"`
	Data json.RawMessage               `json:"data" validate:"required"`
}

type SESSION_MESSAGE_TYPE string

type SessionMessage struct {
	Type SESSION_MESSAGE_TYPE `json:"type" validate:"required"`
	Data json.RawMessage      `json:"data" validate:"required"`
}

type SubscriptionConstructor struct {
	Parameters        []EventParameter `json:"parameters" yaml:"parameters" validate:"omitempty,dive"`
	CredentialsSchema []ProviderConfig `json:"credentials_schema" yaml:"credentials_schema" validate:"omitempty,dive"`
	OAuthSchema       *OAuthSchema     `json:"oauth_schema,omitempty" yaml:"oauth_schema,omitempty" validate:"omitempty"`
}

type ToolDeclaration struct {
	Identity             ToolIdentity     `json:"identity" yaml:"identity" validate:"required"`
	Description          ToolDescription  `json:"description" yaml:"description" validate:"required"`
	Parameters           []ToolParameter  `json:"parameters" yaml:"parameters" validate:"omitempty,dive"`
	OutputSchema         ToolOutputSchema `json:"output_schema,omitempty" yaml:"output_schema,omitempty"`
	HasRuntimeParameters bool             `json:"has_runtime_parameters" yaml:"has_runtime_parameters"`
}

type ToolDescription struct {
	Human I18nObject `json:"human" validate:"required"`
	LLM   string     `json:"llm" validate:"required"`
}

type ToolIdentity struct {
	Author string     `json:"author" yaml:"author" validate:"required"`
	Name   string     `json:"name" yaml:"name" validate:"required,tool_identity_name"`
	Label  I18nObject `json:"label" yaml:"label" validate:"required"`
}

type ToolOutputSchema map[string]any

type ToolParameter struct {
	Name             string                 `json:"name" yaml:"name" validate:"required,gt=0,lt=1024"`
	Label            I18nObject             `json:"label" yaml:"label" validate:"required"`
	HumanDescription I18nObject             `json:"human_description" yaml:"human_description" validate:"required"`
	Type             ToolParameterType      `json:"type" yaml:"type" validate:"required,tool_parameter_type"`
	Scope            *string                `json:"scope" yaml:"scope" validate:"omitempty,max=1024,is_scope"`
	Form             ToolParameterForm      `json:"form" yaml:"form" validate:"required,tool_parameter_form"`
	LLMDescription   string                 `json:"llm_description" yaml:"llm_description" validate:"omitempty"`
	Required         bool                   `json:"required" yaml:"required"`
	AutoGenerate     *ParameterAutoGenerate `json:"auto_generate" yaml:"auto_generate" validate:"omitempty"`
	Template         *ParameterTemplate     `json:"template" yaml:"template" validate:"omitempty"`
	Default          any                    `json:"default" yaml:"default" validate:"omitempty"`
	Min              *float64               `json:"min" yaml:"min" validate:"omitempty"`
	Max              *float64               `json:"max" yaml:"max" validate:"omitempty"`
	Multiple         bool                   `json:"multiple" yaml:"multiple" validate:"omitempty"`
	Precision        *int                   `json:"precision" yaml:"precision" validate:"omitempty"`
	Options          []ParameterOption      `json:"options" yaml:"options" validate:"omitempty,dive"`
}

type ToolParameterForm string

type ToolParameterType string

type ToolProviderDeclaration struct {
	Identity          ToolProviderIdentity `json:"identity" yaml:"identity" validate:"required"`
	CredentialsSchema []ProviderConfig     `json:"credentials_schema" yaml:"credentials_schema" validate:"omitempty,dive"`
	OAuthSchema       *OAuthSchema         `json:"oauth_schema" yaml:"oauth_schema" validate:"omitempty"`
	Tools             []ToolDeclaration    `json:"tools" yaml:"tools" validate:"required,dive"`
	ToolFiles         []string             `json:"-" yaml:"-"`
}

type ToolProviderIdentity struct {
	Author      string                        `json:"author" validate:"required"`
	Name        string                        `json:"name" validate:"required,tool_provider_identity_name"`
	Description I18nObject                    `json:"description"`
	Icon        string                        `json:"icon" validate:"required"`
	IconDark    string                        `json:"icon_dark" yaml:"icon_dark" validate:"omitempty"`
	Label       I18nObject                    `json:"label" validate:"required"`
	Tags        []manifest_entities.PluginTag `json:"tags" validate:"omitempty,dive,plugin_tag"`
}

type ToolSelectorScope string

type TriggerProviderDeclaration struct {
	Identity                TriggerProviderIdentity  `json:"identity" yaml:"identity" validate:"required"`
	SubscriptionSchema      []ProviderConfig         `json:"subscription_schema" yaml:"subscription_schema" validate:"required"`
	SubscriptionConstructor *SubscriptionConstructor `json:"subscription_constructor" yaml:"subscription_constructor" validate:"omitempty"`
	Events                  []EventDeclaration       `json:"events" yaml:"events" validate:"omitempty,dive"`
	EventFiles              []string                 `json:"-" yaml:"-"`
}

type TriggerProviderIdentity struct {
	Author      string                        `json:"author" validate:"required"`
	Name        string                        `json:"name" validate:"required,tool_provider_identity_name"`
	Description I18nObject                    `json:"description"`
	Icon        string                        `json:"icon" validate:"required"`
	IconDark    string                        `json:"icon_dark" yaml:"icon_dark" validate:"omitempty"`
	Label       I18nObject                    `json:"label" validate:"required"`
	Tags        []manifest_entities.PluginTag `json:"tags" validate:"omitempty,dive,plugin_tag"`
}

type TriggerRuntime struct {
	Credentials map[string]any `json:"credentials" yaml:"credentials"`
	SessionID   *string        `json:"session_id" yaml:"session_id"`
}

type Unsubscription struct {
	Success bool    `json:"success" yaml:"success" validate:"required"`
	Message *string `json:"message,omitempty" yaml:"message,omitempty"`
}