actionsdk

type Artifact struct {
	BuildID       string `json:"build_id"`
	JobID         string `json:"job_id"`
	StepSlug      string `json:"step_slug"`
	ArtifactID    string `json:"id"`
	Module        string `json:"module"`
	Type          string `json:"type"`
	Name          string `json:"name"`
	Path          string `json:"path"`
	Format        string `json:"format"`
	FormatVersion string `json:"format_version"`
	SHA256        string `json:"sha256"`
}

type ArtifactDownloadByteArrayRequest struct {
	ID string `json:"id"`
}

type ArtifactDownloadByteArrayResult struct {
	Bytes []byte
	Hash  string
	Size  int64
}

type ArtifactDownloadRequest struct {
	ID         string `json:"id"`
	TargetFile string `json:"target_file"`
}

type ArtifactDownloadResult struct {
	Path string
	Hash string
	Size int64
}

type ArtifactListRequest struct {
	Query string `json:"query"`
}

type ArtifactUploadRequest struct {
	File          string `json:"file"`
	Content       string `json:"content"`
	ContentBytes  []byte `json:"content_bytes"`
	Module        string `json:"module"`
	Type          string `json:"type"`
	Format        string `json:"format"`
	FormatVersion string `json:"format_version"`
	ExtractFile   bool   `json:"extract_file"`
}

type ConfigV1Response struct {
	Debug        bool              `json:"debug,omitempty"`
	Log          map[string]string `json:"log,omitempty"`
	ProjectDir   string            `json:"project_dir,omitempty"`
	TempDir      string            `json:"temp_dir,omitempty"`
	ArtifactDir  string            `json:"artifact_dir,omitempty"`
	HostName     string            `json:"host_name,omitempty"`
	HostUserId   string            `json:"host_user_id,omitempty"`
	HostUserName string            `json:"host_user_name,omitempty"`
	HostGroupId  string            `json:"host_group_id,omitempty"`
	Config       string            `json:"config,omitempty"`
}

type DeploymentV1Response struct {
	DeploymentType        string            `json:"deployment_type"`
	DeploymentSpec        string            `json:"deployment_spec"`
	DeploymentEnvironment string            `json:"deployment_environment"`
	DeploymentFile        string            `json:"deployment_file"`
	Properties            map[string]string `json:"properties"`
}

type EnvironmentV1Response struct {
	Env map[string]string `json:"env"`
}

type ExecuteCommandV1Request struct {
	CaptureOutput      bool              `json:"capture_output,omitempty"`       // CaptureOutput capture and return both stdout and stderr
	HideStdout         bool              `json:"hide_stdout,omitempty"`          // HideStdout hide the stdout output
	HideStderr         bool              `json:"hide_stderr,omitempty"`          // HideStderr hide the stderr output
	Command            string            `json:"command,omitempty"`              // Command
	WorkDir            string            `json:"work_dir,omitempty"`             // WorkDir directory to execute the command in (default = project root)
	Env                map[string]string `json:"env,omitempty"`                  // Env contains additional env properties
	Ports              []int             `json:"ports,omitempty"`                // Ports that will be exposed
	Constraint         string            `json:"constraint,omitempty"`           // A version Constraint for the binary used in command
	HideStandardOutput bool              `json:"hide_standard_output,omitempty"` // HideStandardOutput hide the standard output (stdout)
	HideStandardError  bool              `json:"hide_standard_error,omitempty"`  // HideStandardError hide the standard error (stderr)
}

type ExecuteCommandV1Response struct {
	// Code command exit code
	Code int `json:"code,omitempty"`

	// Command the command being executed
	Command string `json:"command,omitempty"`

	// Dir directory the command is executed in
	Dir string `json:"dir,omitempty"`

	// Error error message
	Error string `json:"error,omitempty"`

	// Stderr error output (if capture-output was request, empty otherwise)
	Stderr string `json:"stderr,omitempty"`

	// Stdout standard output (if capture-output was request, empty otherwise)
	Stdout string `json:"stdout,omitempty"`
}

type File struct {
	Path      string `json:"path"`
	Directory string `json:"dir"`
	Name      string `json:"name"`
	NameShort string `json:"name_short"`
	Extension string `json:"ext"`
}

type FileV1Request struct {
	Directory  string   `json:"dir"`
	Extensions []string `json:"ext"`
}

type HealthV1Response struct {
	Status string `json:"status"`
}

type LogV1Request struct {
	Level   string                 `json:"level"`
	Message string                 `json:"message"`
	Context map[string]interface{} `json:"context"`
}

type MockSDKClient struct {
	mock.Mock
}

type MockSDKClient_ArtifactByIdV1_Call struct {
	*mock.Call
}

type MockSDKClient_ArtifactDownloadByteArrayV1_Call struct {
	*mock.Call
}

type MockSDKClient_ArtifactDownloadV1_Call struct {
	*mock.Call
}

type MockSDKClient_ArtifactListV1_Call struct {
	*mock.Call
}

type MockSDKClient_ArtifactUploadV1_Call struct {
	*mock.Call
}

type MockSDKClient_ConfigV1_Call struct {
	*mock.Call
}

type MockSDKClient_DeploymentV1_Call struct {
	*mock.Call
}

type MockSDKClient_EnvironmentV1_Call struct {
	*mock.Call
}

type MockSDKClient_ExecuteCommandV1_Call struct {
	*mock.Call
}

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

type MockSDKClient_FileCopyV1_Call struct {
	*mock.Call
}

type MockSDKClient_FileExistsV1_Call struct {
	*mock.Call
}

type MockSDKClient_FileListV1_Call struct {
	*mock.Call
}

type MockSDKClient_FileReadV1_Call struct {
	*mock.Call
}

type MockSDKClient_FileRemoveV1_Call struct {
	*mock.Call
}

type MockSDKClient_FileRenameV1_Call struct {
	*mock.Call
}

type MockSDKClient_FileWriteV1_Call struct {
	*mock.Call
}

type MockSDKClient_HealthV1_Call struct {
	*mock.Call
}

type MockSDKClient_LogV1_Call struct {
	*mock.Call
}

type MockSDKClient_ModuleCurrentV1_Call struct {
	*mock.Call
}

type MockSDKClient_ModuleExecutionContextV1_Call struct {
	*mock.Call
}

type MockSDKClient_ModuleListV1_Call struct {
	*mock.Call
}

type MockSDKClient_ProjectExecutionContextV1_Call struct {
	*mock.Call
}

type MockSDKClient_TARCreateV1_Call struct {
	*mock.Call
}

type MockSDKClient_TARExtractV1_Call struct {
	*mock.Call
}

type MockSDKClient_UUIDV4_Call struct {
	*mock.Call
}

type MockSDKClient_VCSCommitByHashV1_Call struct {
	*mock.Call
}

type MockSDKClient_VCSCommitsV1_Call struct {
	*mock.Call
}

type MockSDKClient_VCSDiffV1_Call struct {
	*mock.Call
}

type MockSDKClient_VCSReleasesV1_Call struct {
	*mock.Call
}

type MockSDKClient_VCSTagsV1_Call struct {
	*mock.Call
}

type MockSDKClient_ZIPCreateV1_Call struct {
	*mock.Call
}

type MockSDKClient_ZIPExtractV1_Call struct {
	*mock.Call
}

type ModuleExecutionContextV1Response struct {
	ProjectDir string            `json:"project-dir"`
	Config     *ConfigV1Response `json:"config"`
	Env        map[string]string `json:"env"`
	Module     *ProjectModule
	Deployment *DeploymentV1Response
}

type ProjectDependency struct {
	Id      string `json:"id,omitempty"`
	Type    string `json:"type,omitempty"`
	Version string `json:"version,omitempty"`
	Scope   string `json:"scope,omitempty"`
}

type ProjectExecutionContextV1Response struct {
	ProjectDir string            `json:"project-dir"`
	Config     *ConfigV1Response `json:"config"`
	Env        map[string]string `json:"env"`
	Modules    []*ProjectModule  `json:"modules"`
}

type ProjectModule struct {
	ProjectDir            string                   `json:"project_dir,omitempty"`            // ProjectDir project root directory
	ModuleDir             string                   `json:"module_dir,omitempty"`             // ModuleDir module root directory
	Discovery             []ProjectModuleDiscovery `json:"discovery,omitempty"`              // Discovery module detected based on
	Name                  string                   `json:"name,omitempty"`                   // Name module name
	Slug                  string                   `json:"slug,omitempty"`                   // Slug module name
	Type                  string                   `json:"type,omitempty"`                   // Type is the module type
	BuildSystem           string                   `json:"build_system,omitempty"`           // BuildSystem module name
	BuildSystemSyntax     string                   `json:"build_system_syntax,omitempty"`    // BuildSystemSyntax module name
	SpecificationType     string                   `json:"specification_type,omitempty"`     // SpecificationType is the type of the specification
	ConfigType            string                   `json:"config_type,omitempty"`            // ConfigType is the type of the configuration
	DeploymentSpec        string                   `json:"deployment_spec,omitempty"`        // DeploymentSpec is the kind of deployment specification
	DeploymentType        string                   `json:"deployment_type,omitempty"`        // DeploymentType is the type of the deployment
	DeploymentEnvironment string                   `json:"deployment_environment,omitempty"` // DeploymentEnvironment is the environment the deployment is for, e.g. staging, production, ...
	Language              map[string]string        `json:"language,omitempty"`               // Language module name
	Dependencies          []*ProjectDependency     `json:"dependencies,omitempty"`           // Dependencies module name
	Files                 []string                 `json:"files,omitempty"`                  // Files all files in the project directory
	Submodules            []*ProjectModule         `json:"submodules,omitempty"`             // Submodules submodules
}

type ProjectModuleDiscovery struct {
	File string `json:"file"`
}

type SDKClient interface {
	HealthV1() (HealthV1Response, error) // simple health check to verify connectivity and basic functionality of the SDK
	LogV1(req LogV1Request) error        // log a message with the given level and context (context is optional key-value pairs that can be included in the log)
	UUIDV4() string                      // UUID generates a new UUID string (useful for generating unique IDs for things like temporary files, correlation IDs, etc.)

	ConfigV1() (*ConfigV1Response, error)
	ProjectExecutionContextV1() (*ProjectExecutionContextV1Response, error)
	ModuleExecutionContextV1() (*ModuleExecutionContextV1Response, error)
	EnvironmentV1() (*EnvironmentV1Response, error)
	DeploymentV1() (*DeploymentV1Response, error)
	ModuleListV1() ([]*ProjectModule, error)
	ModuleCurrentV1() (*ProjectModule, error)

	ExecuteCommandV1(req ExecuteCommandV1Request) (*ExecuteCommandV1Response, error)

	VCSCommitsV1(request VCSCommitsRequest) ([]*VCSCommit, error)
	VCSCommitByHashV1(request VCSCommitByHashRequest) (*VCSCommit, error)
	VCSTagsV1() ([]VCSTag, error)
	VCSReleasesV1(request VCSReleasesRequest) ([]VCSRelease, error)
	VCSDiffV1(request VCSDiffRequest) ([]VCSDiff, error) // VCSDiff generates a diff between two VCS references (like commits or tags) and returns a list of changed files with their change types (added, modified, deleted).

	FileReadV1(file string) (string, error)                 // FileRead reads the content of the specified file and returns it as a string. It returns an error if the operation fails.
	FileWriteV1(file string, content []byte) error          // FileWrite writes the given content to the specified file. It returns an error if the operation fails.
	FileRemoveV1(file string) error                         // FileRemove removes the specified file. It returns an error if the operation fails.
	FileCopyV1(old string, new string) error                // FileCopy copies a file from old path to new path. It returns an error if the operation fails.
	FileRenameV1(old string, new string) error              // FileRename renames a file from old path to new path. It returns an error if the operation fails.
	FileListV1(req FileV1Request) (files []File, err error) // FileList lists files in a directory based on the given request parameters (like directory path and optional extensions filter). It returns a slice of files and an error if the operation fails.
	FileExistsV1(file string) bool                          // FileExists checks if the specified file exists and returns true if it does, false otherwise.

	ArtifactListV1(request ArtifactListRequest) ([]*Artifact, error)                                                // ArtifactList lists artifacts based on the given query expression (which can filter artifacts by their metadata). It returns a slice of artifacts that match the query and an error if the operation fails.
	ArtifactByIdV1(id string) (*Artifact, error)                                                                    // ArtifactById retrieves the artifact with the specified ID. It returns the artifact and an error if the operation fails or if the artifact is not found.
	ArtifactUploadV1(request ArtifactUploadRequest) (filePath string, fileHash string, err error)                   // ArtifactUpload uploads a file as an artifact with the specified metadata (like module, type, format, etc.). It returns the path of the stored artifact, its hash, and an error if the operation fails.
	ArtifactDownloadV1(request ArtifactDownloadRequest) (*ArtifactDownloadResult, error)                            // ArtifactDownload downloads the artifact with the specified ID to the target file path. It returns the path of the downloaded file, its hash, and size, or an error if the operation fails.
	ArtifactDownloadByteArrayV1(request ArtifactDownloadByteArrayRequest) (*ArtifactDownloadByteArrayResult, error) // ArtifactDownloadByteArray downloads the artifact with the specified ID and returns its content as a byte array along with its hash and size. It returns an error if the operation fails.

	ZIPCreateV1(inputDirectory string, outputFile string) error    // ZIPCreate creates a zip archive of the directory at the given path. It takes the input directory and the output file path for the zip archive. It returns an error if the operation fails.
	ZIPExtractV1(archiveFile string, outputDirectory string) error // ZIPExtract unzips the zip archive at the given path into the given directory. It takes the path of the zip archive and the target output directory. It returns an error if the operation fails.
	TARCreateV1(inputDirectory string, outputFile string) error    // TARCreate creates a tar archive of the directory at the given path. It takes the input directory and the output file path for the tar archive. It returns an error if the operation fails.
	TARExtractV1(archiveFile string, outputDirectory string) error // TARExtract extracts a tar archive at the given path into the given directory. It takes the path of the tar archive and the target output directory. It returns an error if the operation fails.
}

type VCSAuthor struct {
	Name  string `json:"name,omitempty"`
	Email string `json:"email,omitempty"`
}

type VCSChange struct {
	ChangeType string  `json:"type,omitempty"`
	FileFrom   VCSFile `json:"file_from,omitempty"`
	FileTo     VCSFile `json:"file_to,omitempty"`
	Patch      string  `json:"patch,omitempty"`
}

type VCSCommit struct {
	HashShort   string            `json:"hash_short,omitempty"`
	Hash        string            `json:"hash,omitempty"`
	Message     string            `json:"message,omitempty"`
	Description string            `json:"description,omitempty"`
	Author      VCSAuthor         `json:"author,omitempty"`
	Committer   VCSAuthor         `json:"committer,omitempty"`
	Tags        []*VCSTag         `json:"tags,omitempty"`
	AuthoredAt  time.Time         `json:"authored_at,omitempty"`
	CommittedAt time.Time         `json:"committed_at,omitempty"`
	Changes     []*VCSChange      `json:"changes,omitempty"`
	Context     map[string]string `json:"context,omitempty"`
}

type VCSCommitByHashRequest struct {
	Hash           string `json:"hash"`
	IncludeChanges bool   `json:"changes"`
}

type VCSCommitsRequest struct {
	FromHash       string `json:"from"`
	ToHash         string `json:"to"`
	IncludeChanges bool   `json:"changes"`
	Limit          int    `json:"limit"`
}

type VCSDiff struct {
	FileFrom VCSFile       `json:"file_from"`
	FileTo   VCSFile       `json:"file_to"`
	Lines    []VCSDiffLine `json:"lines,omitempty"`
}

type VCSDiffLine struct {
	Operation int    `json:"operation"`
	Content   string `json:"content"`
}

type VCSDiffRequest struct {
	FromHash string `json:"from"`
	ToHash   string `json:"to"`
}

type VCSFile struct {
	Name string `json:"name,omitempty"`
	Size int    `json:"size,omitempty"`
	Hash string `json:"hash,omitempty"`
}

type VCSRelease struct {
	Version string        `json:"version,omitempty"`
	Ref     vcsapi.VCSRef `json:"ref,omitempty"`
}

type VCSReleasesRequest struct {
	Type string `json:"type"` // Type of the release: stable, unstable
}

type VCSTag struct {
	RefType string `json:"type,omitempty"`
	Value   string `json:"value,omitempty"`
	Hash    string `json:"hash,omitempty"`
}