jsonschema

type AddResponse struct {
	// DriverListPath is the filesystem path of the driver list that was modified.
	DriverListPath string `json:"driver_list_path"`
	// Drivers lists every driver entry that was added or updated.
	Drivers []AddResponseDriver `json:"drivers"`
}

type AddResponseDriver struct {
	// Name is the driver identifier.
	Name string `json:"name"`
	// VersionConstraint is the optional semver constraint that was recorded.
	VersionConstraint string `json:"version_constraint,omitempty"`
}

type AuthDeviceCodeEvent struct {
	// VerificationURI is the URL the user should visit to authorise the device.
	VerificationURI string `json:"verification_uri"`
	// VerificationURIComplete is the URL with the user code pre-filled.
	VerificationURIComplete string `json:"verification_uri_complete"`
	// UserCode is the short code the user must enter at the verification URI.
	UserCode string `json:"user_code"`
	// ExpiresIn is the number of seconds until the code expires.
	ExpiresIn int `json:"expires_in"`
	// Interval is the minimum polling interval in seconds.
	Interval int `json:"interval"`
}

type AuthLicenseInstallResponse struct {
	// Status is the outcome: "success" or "error".
	Status string `json:"status"`
	// LicensePath is the filesystem path where the license was written.
	LicensePath string `json:"license_path"`
}

type AuthLoginResponse struct {
	// Status is the outcome: "success" or "failed".
	Status string `json:"status"`
	// Registry is the registry URL that was authenticated against.
	Registry string `json:"registry"`
	// Message is an optional detail string (e.g. failure reason).
	Message string `json:"message,omitempty"`
}

type AuthLogoutResponse struct {
	// Status is the outcome: "success" or "error".
	Status string `json:"status"`
	// Registry is the registry URL from which credentials were removed.
	Registry string `json:"registry"`
}

type AuthRegistryStatus struct {
	// URL is the registry URL.
	URL string `json:"url"`
	// Authenticated indicates whether valid credentials exist for this registry.
	Authenticated bool `json:"authenticated"`
	// AuthType is the credential type in use: "oauth" or "api_key". Empty when not authenticated.
	AuthType string `json:"auth_type,omitempty"`
	// LicenseValid indicates whether a valid Columnar license is present.
	LicenseValid bool `json:"license_valid"`
}

type AuthStatus struct {
	// Registries lists the status for each known registry.
	Registries []AuthRegistryStatus `json:"registries"`
}

type DriverInfo struct {
	// Driver is the driver identifier path.
	Driver string `json:"driver"`
	// Version is the latest version string.
	Version string `json:"version"`
	// Title is the human-readable display name of the driver.
	Title string `json:"title"`
	// License is the SPDX license identifier.
	License string `json:"license"`
	// Description is a detailed description of the driver.
	Description string `json:"description"`
	// Packages lists the supported platform tuples.
	Packages []string `json:"packages"`
}

type Envelope struct {
	// SchemaVersion identifies the schema revision for forward-compatibility checks.
	SchemaVersion int `json:"schema_version"`
	// Kind names the payload type (e.g. "install.status", "search.response").
	Kind string `json:"kind"`
	// Payload is the raw JSON-encoded type-specific data.
	Payload json.RawMessage `json:"payload"`
}

type ErrorResponse struct {
	// Code is a machine-readable error identifier (e.g. "not_found", "permission_denied").
	Code string `json:"code"`
	// Message is a human-readable error description.
	Message string `json:"message"`
	// OwnerPID is the PID of the process holding a lock, when applicable.
	OwnerPID int `json:"owner_pid,omitempty"`
}

type InitResponse struct {
	// DriverListPath is the filesystem path of the created or existing driver list.
	DriverListPath string `json:"driver_list_path"`
	// Created is true when the file was newly created, false if it already existed.
	Created bool `json:"created"`
}

type InstallProgressEvent struct {
	// Event identifies the progress step. Valid values:
	// "download.start", "download.progress", "download.complete",
	// "extract.start", "extract.complete",
	// "verify.start", "verify.complete", "verify.checksum.ok", "verify.checksum.mismatch",
	// "manifest.create", "install.complete".
	Event string `json:"event"`
	// Driver is the driver identifier being installed.
	Driver string `json:"driver"`
	// Bytes is the number of bytes transferred so far (download events only).
	Bytes int64 `json:"bytes,omitempty"`
	// Total is the expected total byte count (download events only).
	Total int64 `json:"total,omitempty"`
	// Checksum is the computed or expected checksum value (verify events only).
	Checksum string `json:"checksum,omitempty"`
}

type InstallStatus struct {
	// Status is the outcome: "installed", "already installed", or "error".
	Status string `json:"status"`
	// Driver is the driver identifier (e.g. "snowflake").
	Driver string `json:"driver"`
	// Version is the installed driver version string.
	Version string `json:"version"`
	// Location is the filesystem path where the driver was installed.
	Location string `json:"location"`
	// Message is an optional post-install notice provided by the driver manifest.
	Message string `json:"message,omitempty"`
	// Conflict describes any pre-existing driver that was replaced, if applicable.
	Conflict string `json:"conflict,omitempty"`
	// Checksum is the hex-encoded checksum of the installed artifact (added for T7).
	Checksum string `json:"checksum,omitempty"`
}

type ListDriverEntry struct {
	// Driver is the driver identifier path.
	Driver string `json:"driver"`
	// Name is the human-readable driver name from its manifest.
	Name string `json:"name"`
	// Version is the installed driver version string.
	Version string `json:"version"`
	// Level is the config level where the driver is installed: "system", "user", or "env".
	Level string `json:"level"`
	// Location is the filesystem path containing the driver's manifest.
	Location string `json:"location"`
}

type ListResponse struct {
	// Drivers is the list of installed drivers across all inspected config levels.
	Drivers []ListDriverEntry `json:"drivers"`
}

type RemoveResponse struct {
	// DriverListPath is the filesystem path of the driver list that was modified.
	DriverListPath string `json:"driver_list_path"`
	// Driver is the entry that was removed.
	Driver RemoveResponseDriver `json:"driver"`
}

type RemoveResponseDriver struct {
	// Name is the driver identifier.
	Name string `json:"name"`
}

type SearchDriverBasic struct {
	// Driver is the driver identifier path.
	Driver string `json:"driver"`
	// Description is a human-readable summary of the driver.
	Description string `json:"description"`
	// Installed lists the installed versions of this driver, if any.
	Installed []string `json:"installed,omitempty"`
	// Registry is the source registry name, if not the default.
	Registry string `json:"registry,omitempty"`
}

type SearchDriverVerbose struct {
	// Driver is the driver identifier path.
	Driver string `json:"driver"`
	// Description is a human-readable summary of the driver.
	Description string `json:"description"`
	// License is the SPDX license identifier for the driver.
	License string `json:"license"`
	// Registry is the source registry name, if not the default.
	Registry string `json:"registry,omitempty"`
	// InstalledVersions maps platform tuple to a list of installed versions.
	InstalledVersions map[string][]string `json:"installed_versions,omitempty"`
	// AvailableVersions lists all versions available for the current platform.
	AvailableVersions []string `json:"available_versions,omitempty"`
}

type SearchResponse struct {
	// Drivers is the raw JSON array of driver entries (basic or verbose).
	Drivers json.RawMessage `json:"drivers"`
	// Warning is an optional message when some registries were unavailable.
	Warning string `json:"warning,omitempty"`
}

type SyncError struct {
	// Name is the driver identifier.
	Name string `json:"name"`
	// Error is a human-readable description of the failure.
	Error string `json:"error"`
}

type SyncProgressEvent struct {
	// Phase is the current sync step: "resolving", "downloading", "verifying", or "installed".
	Phase string `json:"phase"`
	// Driver is the driver identifier being synced.
	Driver string `json:"driver"`
	// Bytes is the number of bytes transferred so far (downloading phase only).
	Bytes int64 `json:"bytes,omitempty"`
	// Total is the expected total byte count (downloading phase only).
	Total int64 `json:"total,omitempty"`
	// Version is the resolved version string (available after resolving phase).
	Version string `json:"version,omitempty"`
}

type SyncStatus struct {
	// Installed lists drivers that were newly installed.
	Installed []SyncedDriver `json:"installed"`
	// Skipped lists drivers that were already present and required no action.
	Skipped []SyncedDriver `json:"skipped"`
	// Errors lists drivers that failed to install.
	Errors []SyncError `json:"errors"`
}

type SyncedDriver struct {
	// Name is the driver identifier.
	Name string `json:"name"`
	// Version is the version that was installed or already present.
	Version string `json:"version"`
}

type UninstallStatus struct {
	// Status is the outcome: "success" or "error".
	Status string `json:"status"`
	// Driver is the driver identifier that was uninstalled.
	Driver string `json:"driver"`
}