report

type Detail struct {
	// Type is the type of detail: info, warning or error.
	Type DetailType `json:"type"`

	// Message is the message of the detail.
	Message string `json:"msg"`
}

type DetailType = string

type Detailer interface {

	// Add adds a Detail to the Detailer.
	Add(d Detail)

	// GetAll gets all Details stored by the Detailer.
	GetAll() []Detail
}

type JSONTime time.Time

type Record struct {
	// Type is the type of record, currently TypeDeploy and TypeLoad.
	Type RecordType `json:"type"`

	// Time is the time associated with the Record.
	Time JSONTime `json:"time"`

	// Config provides the config ID, project and type of the config associated with the Record.
	Config *coordinate.Coordinate `json:"config,omitempty"`

	ObjectID string `json:"objectId,omitempty"`

	// State is the result of the deployment of the config, currently StateSuccess, StateInfo, StateError, StateExcluded, StateSkipped.
	State RecordState `json:"state"`

	// Details optionally provides Detail log entries associated with the record.
	Details []Detail `json:"details,omitempty"`

	// Error optionally provides the string representation of any error associated with the Record.
	Error string `json:"error,omitempty"`

	// Message optionally info message
	Message string `json:"message,omitempty"`
}

type RecordState = string

type RecordType = string

type Reporter interface {
	// ReportSuccessfulDeployment reports the successful result of deploying a config.
	ReportSuccessfulDeployment(config coordinate.Coordinate, objectID string, details []Detail)

	// ReportExcludedDeployment reports that a config was excluded from deployment.
	ReportExcludedDeployment(config coordinate.Coordinate, details []Detail)

	// ReportSkippedDeployment reports that a config was skipped from deployment.
	ReportSkippedDeployment(config coordinate.Coordinate, details []Detail)

	// ReportFailedDeployment reports that a config failed to deploy.
	ReportFailedDeployment(config coordinate.Coordinate, details []Detail, err error)

	// ReportLoading reports the result of a load config
	ReportLoading(state RecordState, err error, message string, config *coordinate.Coordinate)

	// ReportCaching reports the result of caching actions, like settings.
	ReportCaching(state RecordState, message string)

	// ReportInfo reports info messages like monaco version or that the deployment succeeded
	ReportInfo(message string)

	// GetSummary returns a summary of all seen events as a string.
	GetSummary() string

	// Stop shuts down the Reporter, writing out all records.
	Stop()
}