sdk

type Action interface {
	BaseOperation

	// Perform executes the action with the given input schema and returns a result or an error.
	Perform(ctx PerformContext) (core.JSON, error)

	// GetType returns the trigger type (e.g., BRANCH, BOOLEAN, FLOW, STEP).
	GetType() core.ActionType

	// Settings provides operation-specific configuration details necessary for executing the action.
	Settings() core.ActionSettings
}

type Auth = core.OperationAuth

type BaseContext struct {
	Auth *sdkcore.AuthContext `json:"auth"`

	Files         FileManager
	ExecutionMode ExecutionMode `json:"execution_mode"`
	// contains filtered or unexported fields
}

type BaseOperation interface {
	// Name returns the human-readable name for the sdk (e.g., "Slack", "Stripe").
	Name() string

	// The Description returns a detailed explanation or summary of the trigger or action being executed.
	Description() string

	// Documentation returns an OperationDocumentation instance, providing optional detailed documentation for the operation.
	Documentation() *OperationDocumentation

	// Icon returns a pointer to a string representing the icon for the sdk or operation.
	Icon() *string

	// SampleData retrieves example or mock data related to the operation, often used for testing or sdk scenarios.
	// Returns a pointer to the JSON data and an error if the retrieval fails.
	SampleData() core.JSON

	// Properties returns a map of property names to their corresponding AutoFormSchema definitions.
	Properties() map[string]*core.AutoFormSchema

	// Auth returns the authentication schema required for the operation, defined as an AutoFormSchema.
	Auth() *Auth
}

type DerivedDocumentation struct {
	Documentation string
	Actions       map[string]OperationDocumentation
	Triggers      map[string]OperationDocumentation
}

type ExecuteContext struct {
	BaseContext
}

type ExecuteMetadata struct {
	FlowVersionID uuid.UUID `json:"flowVersionId,omitempty"`
	// FlowID holds the value of the "flow_id" field.
	FlowID uuid.UUID  `json:"flowId"`
	RunID  *uuid.UUID `json:"runId,omitempty"`
	// Name holds the value of the "name" field.
	StepName string `json:"stepName,omitempty"`
	// LastRun field stores the timestamp of the last run of a flow version.
	LastRun *time.Time `json:"last_run,omitempty"`
	// Status indicates the current state of the flow version, represented by the FlowVersionState enumeration.
	FlowStatus core.FlowVersionState `json:"flowStatus"`
	// ProjectID holds the value of the "project_id" field.
	ProjectID uuid.UUID `json:"projectId"`
	// Mode specifies the mode of execution, represented by the ExecutionMode type, and serialized as "mode" in JSON.
	Mode ExecutionMode `json:"mode"`
}

type ExecutionMode = sdkcore.ExecutionMode

type FileManager interface {
	Put(name string, data io.Reader) (*string, error)
	PutFlow(metadata *ExecuteMetadata, name string, data io.Reader) (*string, error)
	ReadFlow(metadata *ExecuteMetadata, name string) ([]byte, error)
	Read(name string) ([]byte, error)
}

type Integration interface {
	// Auth returns the authentication schema configuration required by the sdk.
	Auth() *Auth

	// Triggers returns all triggers supported by this sdk.
	Triggers() []Trigger

	// Actions returns all actions supported by this sdk.
	Actions() []Action
}

type IntegrationSchemaModel struct {
	Name        string   `json:"name" toml:"name" yaml:"name" validate:"required"`
	Description string   `json:"description" toml:"description"  yaml:"description" validate:"required"`
	Version     string   `json:"version" toml:"version" yaml:"version" validate:"required"`
	Authors     []string `json:"authors" toml:"authors" yaml:"authors" validate:"required"`
	Website     *string  `json:"website" toml:"website" yaml:"website"`
	Categories  []string `json:"categories" toml:"categories" yaml:"categories" validate:"required"`
	Icon        string   `json:"icon" toml:"icon" yaml:"icon" validate:"required"`
}

type JSON = core.JSON

type JSONOutput any

type LifecycleContext struct {
	BaseContext
	Ack  func(output sdkcore.JSON) error
	Nack func(err error) error
}

type OperationContextFn = func() (*JSONOutput, error)

type OperationDocumentation struct {
	Documentation *string `json:"documentation,omitempty"`
}

type OperationMetadata struct {
	// Description holds the value of the "description" field.
	Description string `json:"description,omitempty" validate:"required"`
	// HelpText holds the value of the "helpText" field.
	HelpText *string `json:"helpText,omitempty"`
	// SampleOutput holds the value of the "sampleOutput" field.
	SampleOutput map[string]any `json:"sampleOutput,omitempty"`
	// Auth holds the value of the "auth" field.
	Auth *core.AutoFormSchema `json:"auth,omitempty"`
}

type PerformContext struct {
	BaseContext
}

type Registration struct {
	Version Integration
	Info    RegistrationInfo
}

type RegistrationFn = []func() (Registration, error)

type RegistrationInfo struct {
	IntegrationSchemaModel
	DisplayName   string               `json:"displayName"`
	Documentation DerivedDocumentation `json:"documentation"`
}

type RegistrationMap struct {
	Versions map[string]Registration
	Info     RegistrationInfo
}

type ScheduledOutput = core.ScheduleTriggerCriteria

type SchemaConfig struct {
	Integration IntegrationSchemaModel `json:"integration" toml:"integration" yaml:"integration" validate:"required"`
}

type StepRunState struct {
	// ID of the ent.
	ID uuid.UUID `json:"id,omitempty"`
	// CreatedAt holds the value of the "created_at" field.
	CreatedAt time.Time `json:"created_at,omitempty"`
	// UpdatedAt holds the value of the "updated_at" field.
	UpdatedAt time.Time `json:"updated_at,omitempty"`
	// ProjectID holds the value of the "team_id" field.
	ProjectID uuid.UUID `json:"project_id,omitempty"`
	// Status holds the value of the "status" field.
	Status core.StepRunStatus `json:"status,omitempty"`
	// Order holds the value of the "order" field.
	Order int `json:"order,omitempty"`
	// FlowID holds the value of the "flow_id" field.
	FlowID uuid.UUID `json:"flow_id,omitempty"`
	// FlowVersionID holds the value of the "flow_version_id" field.
	FlowVersionID uuid.UUID `json:"flow_version_id,omitempty"`
	// RunID holds the value of the "run_id" field.
	RunID uuid.UUID `json:"run_id,omitempty"`
	// ConnectorName holds the value of the "connector_name" field.
	ConnectorName string `json:"connector_name,omitempty"`
	// ConnectorVersion holds the value of the "connector_version" field.
	ConnectorVersion string `json:"connector_version,omitempty"`
	// Name holds the value of the "name" field.
	Name string `json:"name,omitempty"`
	// Input holds the value of the "input" field.
	Input map[string]interface{} `json:"input,omitempty"`
	// Errors holds the value of the "errors" field.
	Errors []core.StateError `json:"errors,omitempty"`
	// Output holds the value of the "output" field.
	Output core.JSON `json:"output,omitempty"`
	// StartTime represents the start time of a step run.
	StartTime *time.Time `json:"start_time,omitempty"`
	// EndTime represents the end time of a step run.
	// It is a pointer to a time.Time value and can be nil.
	Duration *int64 `json:"duration,omitempty"`
	// EndTime represents the end time of a step run.
	// It is a pointer to a time.Time value and can be nil.
	EndTime *time.Time `json:"end_time,omitempty"`
	// Type represents the type of the flow step, defined by the FlowStepType enumeration, such as STEP, LOOP, or ROUTER.
	Type          core.FlowStepType `json:"type,omitempty"`
	ExecutionMode ExecutionMode     `json:"mode,omitempty"`
}

type Trigger interface {
	BaseOperation

	// Start prepares and activates the trigger (e.g., start polling, event listening, cron schedules, etc.).
	Start(ctx LifecycleContext) error

	// Stop gracefully stops or disables the trigger (e.g., unsubscribe or clean up resources).
	Stop(ctx LifecycleContext) error

	// Execute handles the trigger's action when manually invoked with an input schema.
	Execute(ctx ExecuteContext) (core.JSON, error)

	// GetType returns the trigger type (e.g., POLLING, EVENT, WEBHOOK, MANUAL, SCHEDULED).
	GetType() core.TriggerType

	// Criteria Additional criteria or filter rules required to activate the trigger.
	Criteria(ctx context.Context) core.TriggerCriteria
}

type WebhookOutput = core.WebhookTriggerCriteria