plugin

type APIMetadata struct {
	EndPoint string   `json:"api_endpoint" yaml:"api_endpoint"`   // API endpoint for the plugin
	Methods  []string `json:"api_methods" yaml:"api_methods"`     // API method for the plugin
	Auth     string   `json:"api_auth" yaml:"api_auth"`           // API authentication: required, optional, none
	AuthType string   `json:"api_auth_type" yaml:"api_auth_type"` // API authentication type for the plugin: jwt, apikey

	// OpenAPI spec for the plugin's API. This is optional but can be used to generate API documentation and client code.
	OpenAPIQueryJSON    string `json:"api_openapi_query_json,omitempty" yaml:"api_openapi_query_json,omitempty"`
	OpenAPIRequestJSON  string `json:"api_openapi_request_json,omitempty" yaml:"api_openapi_request_json,omitempty"`
	OpenAPIResponseJSON string `json:"api_openapi_response_json,omitempty" yaml:"api_openapi_response_json,omitempty"`
	OpenAPIHeadersJSON  string `json:"api_openapi_headers_json,omitempty" yaml:"api_openapi_headers_json,omitempty"` // optional
}

type EventSubscription struct {
	ID     string
	Ch     <-chan cdb.Event
	Cancel func()
}

type JSPlugin struct {
	Name        string       `json:"name" yaml:"name"`                                     // Name of the plugin
	Description string       `json:"description" yaml:"description"`                       // Description of the plugin
	Version     string       `json:"version" yaml:"version"`                               // Version of the plugin
	PType       string       `json:"type" yaml:"type"`                                     // Type of the plugin
	Async       bool         `json:"async" yaml:"async"`                                   // Is the plugin asynchronous
	Script      string       `json:"script" yaml:"script"`                                 // Script for the plugin
	EventType   string       `json:"event_type" yaml:"event_type"`                         // Event type for the plugin. Plugins can register to handle an event.
	API         *APIMetadata `json:"api_metadata,omitempty" yaml:"api_metadata,omitempty"` // API metadata for api_plugin type
	InRegisters []*JSPluginRegister
}

type JSPluginRegister struct {
	Registry map[string]JSPlugin // Registry of JS plugins
	Order    []string            // Order of the plugins in registration order
}

type TestFile struct {
	// Path is the original path to the test file, used for debugging and error messages
	Path string
	// Name is the test name, parsed from the first non-empty line of the file, expected to be in the format: // name: <test name>
	Name string // parsed from first non-empty line: // name: ...
	// Body is the content of the test file, which should be a JavaScript code string containing calls to the test harness functions (test(), assertEqual(), etc.)
	Body string
}

type TestOptions struct {
	// Timeout is the maximum execution time for the test in seconds. If the test exceeds this time, it will be terminated and marked as failed due to timeout.
	Timeout int
	// Params is a map of parameters to be passed to the plugin during test execution. These parameters will be available in the plugin's JavaScript code as a global variable named `params`.
	Params map[string]any
}

type TestResult struct {
	// Name is the name of the test, as defined in the test file (parsed from the first non-empty line in the format: // name: <test name>)
	Name string
	// Passed indicates whether the test passed or failed. A test is considered passed if all assertions in the test code succeeded without throwing exceptions and the execution completed within the specified timeout.
	Passed bool
	// Error contains the error message if the test failed. This could be due to an assertion failure, an uncaught exception in the test code, or a timeout. If the test passed successfully, this field will be empty.
	Error string
}