studyengine

type ActionData struct {
	PState          studyTypes.Participant
	ReportsToCreate []studyTypes.Report
}

type EvalContext struct {
	Event            StudyEvent
	ParticipantState studyTypes.Participant
}

type ExternalEventPayload struct {
	ParticipantState studyTypes.Participant    `json:"participantState"`
	EventType        string                    `json:"eventType"`
	StudyKey         string                    `json:"studyKey"`
	InstanceID       string                    `json:"instanceID"`
	Response         studyTypes.SurveyResponse `json:"surveyResponses"`
	EventKey         string                    `json:"eventKey"`
	Payload          map[string]interface{}    `json:"payload"`
}

type ExternalService struct {
	Name            string           `yaml:"name"`
	URL             string           `yaml:"url"`
	APIKey          string           `yaml:"apiKey"`
	Timeout         int              `yaml:"timeout"`
	MutualTLSConfig *MutualTLSConfig `yaml:"mTLSConfig"`
}

type MutualTLSConfig struct {
	CertFile string `yaml:"certFile"`
	KeyFile  string `yaml:"keyFile"`
	CAFile   string `yaml:"caFile"`
}

type SendOptions struct {
	ExpiresAt        int64 // if message could not sent until this time, it will be discarded
	LanguageOverride string
}

type StudyDBService interface {
	GetResponses(instanceID string, studyKey string, filter bson.M, sort bson.M, page int64, limit int64) (responses []studyTypes.SurveyResponse, paginationInfo *studyDB.PaginationInfos, err error)
	DeleteConfidentialResponses(instanceID string, studyKey string, participantID string, key string) (count int64, err error)
	SaveResearcherMessage(instanceID string, studyKey string, message studyTypes.StudyMessage) error
	// Study code lists:
	StudyCodeListEntryExists(instanceID string, studyKey string, listKey string, code string) (bool, error)
	DeleteStudyCodeListEntry(instanceID string, studyKey string, listKey string, code string) error
	DrawStudyCode(instanceID string, studyKey string, listKey string) (string, error)
	// Study counters:
	GetCurrentStudyCounterValue(instanceID string, studyKey string, scope string) (int64, error)
	IncrementAndGetStudyCounterValue(instanceID string, studyKey string, scope string) (int64, error)
	RemoveStudyCounterValue(instanceID string, studyKey string, scope string) error

	// Study variables:
	GetStudyVariableByStudyKeyAndKey(instanceID string, studyKey string, key string, onlyValue bool) (studyTypes.StudyVariables, error)
	UpdateStudyVariableValue(instanceID string, studyKey string, key string, value any) (studyTypes.StudyVariables, error)
}

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

type StudyEvent struct {
	InstanceID                            string
	StudyKey                              string
	Type                                  string                    // what kind of event (TIMER, SUBMISSION, ENTER etc.)
	Response                              studyTypes.SurveyResponse // if something is submitted during the event is added here
	Payload                               map[string]interface{}    // additional data
	EventKey                              string                    // key of the event	(for custom events)
	MergeWithParticipant                  studyTypes.Participant    // if need to merge with other participant state, is added here
	ParticipantIDForConfidentialResponses string
}

type StudyMessageSender interface {
	SendInstantStudyEmail(
		instanceID string,
		studyKey string,
		confidentialPID string,
		messageType string,
		extraPayload map[string]string,
		opts SendOptions,
	) error
}