atlasexec

type AppliedFile struct {
	File
	Start   time.Time
	End     time.Time
	Skipped int           // Amount of skipped SQL statements in a partially applied file.
	Applied []string      // SQL statements applied with success
	Checks  []*FileChecks // Assertion checks
	Error   *struct {
		Stmt string // SQL statement that failed.
		Text string // Error returned by the database.
	}
}

type Changes struct {
	Applied []string   `json:"Applied,omitempty"` // SQL changes applied with success
	Pending []string   `json:"Pending,omitempty"` // SQL changes that were not applied
	Error   *StmtError `json:"Error,omitempty"`   // Error that occurred during applying
}

type Check struct {
	Stmt  string  `json:"Stmt,omitempty"`  // Assertion statement.
	Error *string `json:"Error,omitempty"` // Assertion error, if any.
}

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

type Copilot []*CopilotMessage

type CopilotMessage struct {
	// Session ID for the Copilot session.
	SessionID string `json:"sessionID,omitempty"`

	// Type of the message. Can be "message", "tool_call", or "tool_output".
	Type string `json:"type"`

	// Content, ToolCall and ToolOutput are mutually exclusive.
	Content    string             `json:"content,omitempty"`
	ToolCall   *ToolCallMessage   `json:"toolCall,omitempty"`
	ToolOutput *ToolOutputMessage `json:"toolOutput,omitempty"`
}

type CopilotParams struct {
	Prompt, Session string
	// FSWrite and FSDelete glob patterns to specify file permissions.
	FSWrite, FSDelete string
}

type DeployRunContext struct {
	TriggerType    TriggerType `json:"triggerType,omitempty"`
	TriggerVersion string      `json:"triggerVersion,omitempty"`
}

type Diagnostic struct {
	Pos  *schema.Pos `json:"Pos,omitempty"`  // Element position.
	Text string      `json:"Text"`           // Diagnostic text.
	Code string      `json:"Code,omitempty"` // Code describes the check (optional).
}

type Env struct {
	Driver string         `json:"Driver,omitempty"` // Driver name.
	URL    *sqlclient.URL `json:"URL,omitempty"`    // URL to dev database.
	Dir    string         `json:"Dir,omitempty"`    // Path to migration directory.
}

type Environ map[string]string

type Error struct {
	Stdout string // Stdout of the command.
	Stderr string // Stderr of the command.
	// contains filtered or unexported fields
}

type File struct {
	Name        string `json:"Name,omitempty"`
	Version     string `json:"Version,omitempty"`
	Description string `json:"Description,omitempty"`
	Content     string `json:"Content,omitempty"`
}

type FileChecks struct {
	Name  string     `json:"Name,omitempty"`  // File/group name.
	Stmts []*Check   `json:"Stmts,omitempty"` // Checks statements executed.
	Error *StmtError `json:"Error,omitempty"` // Assertion error.
	Start time.Time  `json:"Start,omitempty"` // Start assertion time.
	End   time.Time  `json:"End,omitempty"`   // End assertion time.
}

type FileReport struct {
	Name    string            `json:"Name,omitempty"`    // Name of the file.
	Text    string            `json:"Text,omitempty"`    // Contents of the file.
	Reports []sqlcheck.Report `json:"Reports,omitempty"` // List of reports.
	Error   string            `json:"Error,omitempty"`   // File specific error.
}

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

type LoginParams struct {
	Token string
}

type MigrateApply struct {
	Env
	Pending []File         `json:"Pending,omitempty"` // Pending migration files
	Applied []*AppliedFile `json:"Applied,omitempty"` // Applied files
	Current string         `json:"Current,omitempty"` // Current migration version
	Target  string         `json:"Target,omitempty"`  // Target migration version
	Start   time.Time
	End     time.Time
	// Error is set even then, if it was not caused by a statement in a migration file,
	// but by Atlas, e.g. when committing or rolling back a transaction.
	Error string `json:"Error,omitempty"`
}

type MigrateApplyError struct {
	Result []*MigrateApply
	Stderr string
}

type MigrateApplyParams struct {
	ConfigURL string
	Env       string
	Vars      VarArgs
	Context   *DeployRunContext
	DirURL    string

	URL             string
	RevisionsSchema string
	BaselineVersion string
	TxMode          string
	ExecOrder       MigrateExecOrder
	Amount          uint64
	ToVersion       string
	AllowDirty      bool
	DryRun          bool
}

type MigrateDiff struct {
	Files []File `json:"Files,omitempty"` // Generated migration files
	Dir   string `json:"Dir,omitempty"`   // Path to migration directory
}

type MigrateDiffParams struct {
	ConfigURL string
	Env       string
	Vars      VarArgs

	Name        string
	ToURL       string
	DevURL      string
	DirURL      string
	DirFormat   string
	Schema      []string
	LockTimeout string
	Format      string
	Qualifier   string
}

type MigrateDown struct {
	Planned  []File          `json:"Planned,omitempty"`  // Planned migration files
	Reverted []*RevertedFile `json:"Reverted,omitempty"` // Reverted files
	Current  string          `json:"Current,omitempty"`  // Current migration version
	Target   string          `json:"Target,omitempty"`   // Target migration version
	Total    int             `json:"Total,omitempty"`    // Total number of migrations to revert
	Start    time.Time
	End      time.Time
	// URL and Status are set only when the migration is planned or executed in the cloud.
	URL    string `json:"URL,omitempty"`
	Status string `json:"Status,omitempty"`
	// Error is set even then, if it was not caused by a statement in a migration file,
	// but by Atlas, e.g. when committing or rolling back a transaction.
	Error string `json:"Error,omitempty"`
}

type MigrateDownParams struct {
	ConfigURL string
	Env       string
	Vars      VarArgs
	Context   *DeployRunContext
	DevURL    string

	DirURL          string
	URL             string
	RevisionsSchema string
	Amount          uint64
	ToVersion       string
	ToTag           string
}

type MigrateExecOrder string

type MigrateHashParams struct {
	ConfigURL string
	Env       string
	Vars      VarArgs

	DirURL    string
	DirFormat string
}

type MigrateLintParams struct {
	ConfigURL string
	Env       string
	Vars      VarArgs
	Context   *RunContext
	Format    string
	DevURL    string
	GitBase   string
	GitDir    string

	DirURL string
	Latest uint64
	Writer io.Writer
	Base   string
	Web    bool
}

type MigratePushParams struct {
	ConfigURL string
	Env       string
	Vars      VarArgs
	Context   *RunContext
	DevURL    string

	Name        string
	Tag         string
	DirURL      string
	DirFormat   string
	LockTimeout string
}

type MigrateRebaseParams struct {
	ConfigURL string
	Env       string
	Vars      VarArgs

	DirURL string
	Files  []string
}

type MigrateStatus struct {
	Env       Env         `json:"Env,omitempty"`       // Environment info.
	Available []File      `json:"Available,omitempty"` // Available migration files
	Pending   []File      `json:"Pending,omitempty"`   // Pending migration files
	Applied   []*Revision `json:"Applied,omitempty"`   // Applied migration files
	Current   string      `json:"Current,omitempty"`   // Current migration version
	Next      string      `json:"Next,omitempty"`      // Next migration version
	Count     int         `json:"Count,omitempty"`     // Count of applied statements of the last revision
	Total     int         `json:"Total,omitempty"`     // Total statements of the last migration
	Status    string      `json:"Status,omitempty"`    // Status of migration (OK, PENDING)
	Error     string      `json:"Error,omitempty"`     // Last Error that occurred
	SQL       string      `json:"SQL,omitempty"`       // SQL that caused the last Error
}

type MigrateStatusParams struct {
	ConfigURL string
	Env       string
	Vars      VarArgs

	DirURL          string
	URL             string
	RevisionsSchema string
}

type MigrateTestParams struct {
	ConfigURL string
	Env       string
	Vars      VarArgs
	Context   *RunContext
	DevURL    string

	DirURL          string
	DirFormat       string
	Run             string
	RevisionsSchema string
	Paths           []string
}

type Option func(ce *WorkingDir) error

type Report struct {
	Text        string       `json:"Text"`                  // Report text.
	Desc        string       `json:"Desc,omitempty"`        // Optional description (secondary text).
	Error       bool         `json:"Error,omitempty"`       // Report is an error report.
	Diagnostics []Diagnostic `json:"Diagnostics,omitempty"` // Report diagnostics.
}

type RevertedFile struct {
	File
	Start   time.Time
	End     time.Time
	Skipped int      // Amount of skipped SQL statements in a partially applied file.
	Applied []string // SQL statements applied with success
	Scope   string   // Scope of the revert. e.g., statement, versions, etc.
	Error   *struct {
		Stmt string // SQL statement that failed.
		Text string // Error returned by the database.
	}
}

type Revision struct {
	Version         string        `json:"Version"`             // Version of the migration.
	Description     string        `json:"Description"`         // Description of this migration.
	Type            string        `json:"Type"`                // Type of the migration.
	Applied         int           `json:"Applied"`             // Applied amount of statements in the migration.
	Total           int           `json:"Total"`               // Total amount of statements in the migration.
	ExecutedAt      time.Time     `json:"ExecutedAt"`          // ExecutedAt is the starting point of execution.
	ExecutionTime   time.Duration `json:"ExecutionTime"`       // ExecutionTime of the migration.
	Error           string        `json:"Error,omitempty"`     // Error of the migration, if any occurred.
	ErrorStmt       string        `json:"ErrorStmt,omitempty"` // ErrorStmt is the statement that raised Error.
	OperatorVersion string        `json:"OperatorVersion"`     // OperatorVersion that executed this migration.
}

type RunContext struct {
	Repo     string  `json:"repo,omitempty"`
	Path     string  `json:"path,omitempty"`
	Branch   string  `json:"branch,omitempty"`
	Commit   string  `json:"commit,omitempty"`
	URL      string  `json:"url,omitempty"`
	Username string  `json:"username,omitempty"` // The username that triggered the event that initiated the command.
	UserID   string  `json:"userID,omitempty"`   // The user ID that triggered the event that initiated the command.
	SCMType  SCMType `json:"scmType,omitempty"`  // Source control management system type.
}

type SCMType string

type SchemaApply struct {
	Env
	// Changes holds the changes applied to the database.
	// Exists for backward compatibility with the old schema
	// apply structure as old SDK versions rely on it.
	Changes Changes      `json:"Changes,omitempty"`
	Error   string       `json:"Error,omitempty"`   // Any error that occurred during execution.
	Start   time.Time    `json:"Start,omitempty"`   // When apply (including plan) started.
	End     time.Time    `json:"End,omitempty"`     // When apply ended.
	Applied *AppliedFile `json:"Applied,omitempty"` // Applied migration file (pre-planned or computed).
	// Plan information might be partially filled. For example, if lint is done
	// during plan-stage, the linting report is available in the Plan field. If
	// the migration is pre-planned migration, the File.URL is set, etc.
	Plan *SchemaPlan `json:"Plan,omitempty"`
}

type SchemaApplyError struct {
	Result []*SchemaApply
	Stderr string
}

type SchemaApplyParams struct {
	ConfigURL string
	Env       string
	Vars      VarArgs
	DevURL    string

	URL         string
	To          string // TODO: change to []string
	TxMode      string
	Exclude     []string
	Include     []string
	Schema      []string
	DryRun      bool   // If true, --dry-run is set.
	AutoApprove bool   // If true, --auto-approve is set.
	PlanURL     string // URL of the plan in Atlas format (atlas://<repo>/plans/<id>). (optional)
}

type SchemaClean struct {
	Env
	Start   time.Time    `json:"Start,omitempty"`   // When clean started.
	End     time.Time    `json:"End,omitempty"`     // When clean ended.
	Applied *AppliedFile `json:"Applied,omitempty"` // Applied migration file.
	Error   string       `json:"Error,omitempty"`   // Any error that occurred during execution.
}

type SchemaCleanParams struct {
	ConfigURL string
	Env       string
	Vars      VarArgs

	URL         string // URL of the schema to clean. (required)
	DryRun      bool   // If true, --dry-run is set.
	AutoApprove bool   // If true, --auto-approve is set.
}

type SchemaInspectParams struct {
	ConfigURL string
	Env       string
	Vars      VarArgs
	Format    string
	DevURL    string

	URL     string
	Exclude []string
	Include []string
	Schema  []string
}

type SchemaLintParams struct {
	ConfigURL string
	Env       string
	Vars      VarArgs

	URL    []string // Schema URL(s) to lint
	Schema []string // If set, only the specified schemas are linted.
	Format string
	DevURL string
}

type SchemaLintReport struct {
	Steps []Report `json:"Steps,omitempty"`
}

type SchemaPlan struct {
	Env   Env             `json:"Env,omitempty"`   // Environment info.
	Repo  string          `json:"Repo,omitempty"`  // Repository name.
	Lint  *SummaryReport  `json:"Lint,omitempty"`  // Lint report.
	File  *SchemaPlanFile `json:"File,omitempty"`  // Plan file.
	Error string          `json:"Error,omitempty"` // Any error occurred during planning.
}

type SchemaPlanApprove struct {
	URL    string `json:"URL,omitempty"`    // URL of the plan in Atlas format.
	Link   string `json:"Link,omitempty"`   // Link to the plan in the registry.
	Status string `json:"Status,omitempty"` // Status of the plan in the registry.
}

type SchemaPlanApproveParams struct {
	ConfigURL string
	Env       string
	Vars      VarArgs

	URL string
}

type SchemaPlanFile struct {
	Name      string          `json:"Name,omitempty"`      // Name of the plan.
	FromHash  string          `json:"FromHash,omitempty"`  // Hash of the 'from' realm.
	FromDesc  string          `json:"FromDesc,omitempty"`  // Optional description of the 'from' state.
	ToHash    string          `json:"ToHash,omitempty"`    // Hash of the 'to' realm.
	ToDesc    string          `json:"ToDesc,omitempty"`    // Optional description of the 'to' state.
	Migration string          `json:"Migration,omitempty"` // Migration SQL.
	Stmts     []*migrate.Stmt `json:"Stmts,omitempty"`     // Statements in the migration (available only in the JSON output).
	// registry only fields.
	URL    string `json:"URL,omitempty"`    // URL of the plan in Atlas format.
	Link   string `json:"Link,omitempty"`   // Link to the plan in the registry.
	Status string `json:"Status,omitempty"` // Status of the plan in the registry.
}

type SchemaPlanLintParams struct {
	ConfigURL string
	Env       string
	Vars      VarArgs
	Context   *RunContext
	DevURL    string
	Schema    []string
	Exclude   []string
	Include   []string

	From, To []string
	Repo     string
	File     string
}

type SchemaPlanListParams struct {
	ConfigURL string
	Env       string
	Vars      VarArgs
	Context   *RunContext
	DevURL    string
	Schema    []string
	Exclude   []string
	Include   []string

	From, To []string
	Repo     string
	Pending  bool // If true, only pending plans are listed.
}

type SchemaPlanParams struct {
	ConfigURL string
	Env       string
	Vars      VarArgs
	Context   *RunContext
	DevURL    string
	Exclude   []string
	Include   []string
	Schema    []string

	From, To   []string
	Repo       string
	Name       string
	Directives []string
	// The below are mutually exclusive and can be replaced
	// with the 'schema plan' sub-commands instead.
	DryRun     bool // If false, --auto-approve is set.
	Pending    bool
	Push, Save bool
}

type SchemaPlanPullParams struct {
	ConfigURL string
	Env       string
	Vars      VarArgs
	URL       string // URL to the plan in Atlas format. (required)
}

type SchemaPlanPushParams struct {
	ConfigURL string
	Env       string
	Vars      VarArgs
	Context   *RunContext
	DevURL    string
	Schema    []string
	Exclude   []string
	Include   []string

	From, To []string
	Repo     string
	Pending  bool   // Push plan in pending state.
	File     string // File to push. (optional)
}

type SchemaPlanValidateParams struct {
	ConfigURL string
	Env       string
	Vars      VarArgs
	Context   *RunContext
	DevURL    string
	Schema    []string
	Exclude   []string
	Include   []string

	From, To []string
	Repo     string
	Name     string
	File     string
}

type SchemaPush struct {
	Link string
	Slug string
	URL  string
}

type SchemaPushParams struct {
	ConfigURL string
	Env       string
	Vars      VarArgs
	Context   *RunContext
	DevURL    string

	URL         []string // Desired schema URL(s) to push
	Schema      []string // If set, only the specified schemas are pushed.
	Name        string   // Name of the schema (repo) to push to.
	Tag         string   // Tag to push the schema with
	Version     string   // Version of the schema to push. Defaults to the current timestamp.
	Description string   // Description of the schema changes.
}

type SchemaTestParams struct {
	ConfigURL string
	Env       string
	Vars      VarArgs
	DevURL    string

	URL   string
	Run   string
	Paths []string
}

type StepReport struct {
	Name   string      `json:"Name,omitempty"`   // Step name.
	Text   string      `json:"Text,omitempty"`   // Step description.
	Error  string      `json:"Error,omitempty"`  // Error that cause the execution to halt.
	Result *FileReport `json:"Result,omitempty"` // Result of the step. For example, a diagnostic.
}

type StmtError struct {
	Stmt string `json:"Stmt,omitempty"` // SQL statement that failed.
	Text string `json:"Text,omitempty"` // Error message as returned by the database.
}

type Stream[T any] interface {
	// Next reads the next item from the stream, making it available by calling Current.
	// It returns false if there are no more items and the stream is closed.
	Next() bool
	// Current returns the current item from the stream.
	Current() (T, error)
	// Err returns the error, if any, that occurred while reading the stream.
	Err() error
}

type SummaryReport struct {
	URL string `json:"URL,omitempty"` // URL of the report, if exists.
	// Env holds the environment information.
	Env struct {
		Driver string         `json:"Driver,omitempty"` // Driver name.
		URL    *sqlclient.URL `json:"URL,omitempty"`    // URL to dev database.
		Dir    string         `json:"Dir,omitempty"`    // Path to migration directory.
	}
	// Schema versions found by the runner.
	Schema struct {
		Current string `json:"Current,omitempty"` // Current schema.
		Desired string `json:"Desired,omitempty"` // Desired schema.
	}
	// Steps of the analysis. Added in verbose mode.
	Steps []*StepReport `json:"Steps,omitempty"`
	// Files reports. Non-empty in case there are findings.
	Files []*FileReport `json:"Files,omitempty"`
}

type ToolCallMessage struct {
	CallID    string `json:"callID"`
	Function  string `json:"function"`
	Arguments string `json:"arguments"`
}

type ToolOutputMessage struct {
	CallID  string `json:"callID"`
	Content string `json:"content"`
}

type TriggerType string

type VarArgs interface {
	// AsArgs returns the variables as arguments.
	AsArgs() []string
}

type Vars2 map[string]any

type Version struct {
	Version string `json:"Version"`
	SHA     string `json:"SHA,omitempty"`
	Canary  bool   `json:"Canary,omitempty"`
}

type WhoAmI struct {
	Org string `json:"Org,omitempty"`
}

type WhoAmIParams struct {
	ConfigURL string
	Env       string
	Vars      VarArgs
}

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