protocol

type AnchorConfidence string

type CancelParams struct {
	// ID is a request id, which JSON-RPC allows to be a number or a string.
	ID json.RawMessage `json:"id"`
}

type Client struct {
	Name    string `json:"name"`
	Version string `json:"version,omitempty"`
}

type ClientCaps struct {
	Workspace struct {
		Configuration          bool `json:"configuration,omitempty"`
		WorkspaceFolders       bool `json:"workspaceFolders,omitempty"`
		DidChangeConfiguration struct {
			DynamicRegistration bool `json:"dynamicRegistration,omitempty"`
		} `json:"didChangeConfiguration"`
	} `json:"workspace"`
	TextDocument struct {
		PublishDiagnostics struct {
			RelatedInformation bool `json:"relatedInformation,omitempty"`
			DataSupport        bool `json:"dataSupport,omitempty"`
			TagSupport         struct {
				ValueSet []int `json:"valueSet,omitempty"`
			} `json:"tagSupport"`
		} `json:"publishDiagnostics"`
	} `json:"textDocument"`
	Window struct {
		WorkDoneProgress bool `json:"workDoneProgress,omitempty"`
	} `json:"window"`
	General struct {
		// PositionEncodings is the client's preference order. The server
		// advertises utf-16 regardless, because that is what rangefix produces.
		PositionEncodings []string `json:"positionEncodings,omitempty"`
	} `json:"general"`
}

type CodeDescription struct {
	Href string `json:"href"`
}

type ConfigurationItem struct {
	// ScopeURI is the folder the setting is being asked about. Requesting per
	// folder rather than once at startup is what makes a folder-scoped
	// vulnetix.scan.exclude take effect in a multi-root workspace.
	ScopeURI string `json:"scopeUri,omitempty"`
	Section  string `json:"section,omitempty"`
}

type ConfigurationParams struct {
	Items []ConfigurationItem `json:"items"`
}

type ContentChange struct {
	Range       *Range `json:"range,omitempty"`
	RangeLength *int   `json:"rangeLength,omitempty"`
	Text        string `json:"text"`
}

type Diagnostic struct {
	Range    Range  `json:"range"`
	Severity int    `json:"severity,omitempty"`
	Code     string `json:"code,omitempty"`
	// CodeDescription turns Code into a link. Omitted when the rule has no
	// documentation page rather than pointing at a 404.
	CodeDescription *CodeDescription `json:"codeDescription,omitempty"`
	// Source names the scanner family, which is what the Problems panel groups
	// and filters by: vulnetix-sca, vulnetix-sast, vulnetix-secrets and so on.
	Source             string                         `json:"source,omitempty"`
	Message            string                         `json:"message"`
	Tags               []int                          `json:"tags,omitempty"`
	RelatedInformation []DiagnosticRelatedInformation `json:"relatedInformation,omitempty"`
	// Data round-trips to the client untouched. Carries the finding id, the
	// anchor confidence and whether a fix exists, so a code action can be
	// resolved without a second lookup.
	Data json.RawMessage `json:"data,omitempty"`
}

type DiagnosticRelatedInformation struct {
	Location Location `json:"location"`
	Message  string   `json:"message"`
}

type DidChangeConfigurationParams struct {
	Settings json.RawMessage `json:"settings"`
}

type DidChangeParams struct {
	TextDocument   VersionedTextDocumentIdentifier `json:"textDocument"`
	ContentChanges []ContentChange                 `json:"contentChanges"`
}

type DidChangeWatchedFilesParams struct {
	Changes []FileEvent `json:"changes"`
}

type DidCloseParams struct {
	TextDocument TextDocumentIdentifier `json:"textDocument"`
}

type DidOpenParams struct {
	TextDocument TextDocumentItem `json:"textDocument"`
}

type DidSaveParams struct {
	TextDocument TextDocumentIdentifier `json:"textDocument"`
	Text         *string                `json:"text,omitempty"`
}

type ExecuteCommandOptions struct {
	Commands []string `json:"commands"`
}

type FileEvent struct {
	URI  string `json:"uri"`
	Type int    `json:"type"`
}

type Finding struct {
	// ID is the fingerprint for a code finding, or tool:vuln:purl for a
	// dependency one. Stable across scans, which is what lets a client keep
	// selection and expansion state through a rescan.
	ID   string `json:"id"`
	Tool string `json:"tool"`

	RuleID   string `json:"ruleId,omitempty"`
	RuleName string `json:"ruleName,omitempty"`
	Title    string `json:"title,omitempty"`
	Message  string `json:"message"`

	Severity string `json:"severity"`
	Level    string `json:"level,omitempty"`

	Location         FindingLocation   `json:"location"`
	RelatedLocations []RelatedLocation `json:"relatedLocations,omitempty"`

	Package *PackageInfo `json:"package,omitempty"`
	Vuln    *VulnInfo    `json:"vuln,omitempty"`

	Status      string           `json:"status,omitempty"`
	Vex         *VexInfo         `json:"vex,omitempty"`
	Suppression *SuppressionInfo `json:"suppression,omitempty"`

	HelpURI      string `json:"helpUri,omitempty"`
	FixAvailable bool   `json:"fixAvailable,omitempty"`
	Snippet      string `json:"snippet,omitempty"`
}

type FindingLocation struct {
	URI              string           `json:"uri"`
	Range            Range            `json:"range"`
	AnchorConfidence AnchorConfidence `json:"anchorConfidence,omitempty"`
}

type FindingsFilter struct {
	Tools      []string `json:"tools,omitempty"`
	Severities []string `json:"severities,omitempty"`
	Statuses   []string `json:"statuses,omitempty"`
	Path       string   `json:"path,omitempty"`
	Query      string   `json:"query,omitempty"`
}

type FindingsParams struct {
	Folder  string          `json:"folder,omitempty"`
	Filter  *FindingsFilter `json:"filter,omitempty"`
	GroupBy string          `json:"groupBy,omitempty"`
	Cursor  string          `json:"cursor,omitempty"`
	Limit   int             `json:"limit,omitempty"`
}

type FindingsResult struct {
	ProtocolVersion int       `json:"protocolVersion"`
	Items           []Finding `json:"items"`
	Total           int       `json:"total"`
	// NextCursor is empty on the last page.
	NextCursor string `json:"nextCursor,omitempty"`
}

type Folder struct {
	URI  string `json:"uri"`
	Name string `json:"name"`
}

type GateResult struct {
	Breached bool     `json:"breached"`
	Reasons  []string `json:"reasons,omitempty"`
}

type InitializeParams struct {
	ProcessID  *int    `json:"processId"`
	RootURI    string  `json:"rootUri,omitempty"`
	ClientInfo *Client `json:"clientInfo,omitempty"`
	// InitializationOptions carries settings the client wants applied before
	// the first workspace/configuration round trip.
	InitializationOptions json.RawMessage `json:"initializationOptions,omitempty"`
	Capabilities          ClientCaps      `json:"capabilities"`
	WorkspaceFolders      []Folder        `json:"workspaceFolders,omitempty"`
	Trace                 string          `json:"trace,omitempty"`
}

type InitializeResult struct {
	Capabilities ServerCaps  `json:"capabilities"`
	ServerInfo   *ServerInfo `json:"serverInfo,omitempty"`
}

type Location struct {
	URI   string `json:"uri"`
	Range Range  `json:"range"`
}

type LogMessageParams struct {
	Type    int    `json:"type"`
	Message string `json:"message"`
}

type PackageInfo struct {
	Purl        string `json:"purl"`
	Name        string `json:"name"`
	Version     string `json:"version"`
	Ecosystem   string `json:"ecosystem"`
	Direct      bool   `json:"direct"`
	Scope       string `json:"scope,omitempty"`
	IsEOL       bool   `json:"isEol,omitempty"`
	IsMalicious bool   `json:"isMalicious,omitempty"`
	// PathCount is how many dependency paths introduce this package. More than
	// one is the usual reason a transitive cannot simply be upgraded.
	PathCount int `json:"pathCount,omitempty"`
}

type Position struct {
	Line      int `json:"line"`
	Character int `json:"character"`
}

type ProgressParams struct {
	Token string          `json:"token"`
	Value json.RawMessage `json:"value"`
}

type PublishDiagnosticsParams struct {
	URI     string       `json:"uri"`
	Version *int         `json:"version,omitempty"`
	Diags   []Diagnostic `json:"diagnostics"`
}

type Range struct {
	Start Position `json:"start"`
	End   Position `json:"end"`
}

type RelatedLocation struct {
	URI     string `json:"uri"`
	Range   Range  `json:"range"`
	Message string `json:"message,omitempty"`
}

type SaveOptions struct {
	IncludeText bool `json:"includeText"`
}

type ScanArtifacts struct {
	SBOM   string `json:"sbom,omitempty"`
	SARIF  string `json:"sarif,omitempty"`
	Memory string `json:"memory,omitempty"`
}

type ScanCounts struct {
	BySeverity map[string]int `json:"bySeverity,omitempty"`
	ByTool     map[string]int `json:"byTool,omitempty"`
	Total      int            `json:"total"`
}

type ScanFeatures struct {
	SCA        *bool `json:"sca,omitempty"`
	SAST       *bool `json:"sast,omitempty"`
	Secrets    *bool `json:"secrets,omitempty"`
	IAC        *bool `json:"iac,omitempty"`
	Containers *bool `json:"containers,omitempty"`
	License    *bool `json:"license,omitempty"`
	Malscan    *bool `json:"malscan,omitempty"`
}

type ScanStatusParams struct {
	ScanID      string `json:"scanId"`
	Phase       string `json:"phase"`
	Stage       string `json:"stage,omitempty"`
	Percent     *int   `json:"percent,omitempty"`
	Cancellable bool   `json:"cancellable"`
}

type ScanWorkspaceParams struct {
	// Folders to scan. Empty means every folder the client has registered.
	Folders  []string      `json:"folders,omitempty"`
	Features *ScanFeatures `json:"features,omitempty"`
	// Refresh bypasses the vulnerability-data disk cache.
	Refresh bool `json:"refresh,omitempty"`
	// GitHistory walks git history for secrets. Defaults to false in the
	// server even though the CLI defaults it true, because it walks hundreds
	// of commits and thousands of file versions: a CI job, not an editor one.
	GitHistory bool `json:"gitHistory,omitempty"`
}

type ScanWorkspaceResult struct {
	ProtocolVersion int           `json:"protocolVersion"`
	ScanID          string        `json:"scanId"`
	DurationMS      int64         `json:"durationMs"`
	Counts          ScanCounts    `json:"counts"`
	Artifacts       ScanArtifacts `json:"artifacts,omitempty"`
	Gate            *GateResult   `json:"gate,omitempty"`

	// Degradations names what did not run to completion. Always populated when
	// something was skipped, because "no findings" and "did not look" must
	// never be indistinguishable to the person reading the result.
	Degradations []string `json:"degradations,omitempty"`
}

type ServerCaps struct {
	PositionEncoding string                   `json:"positionEncoding,omitempty"`
	TextDocumentSync *TextDocumentSyncOptions `json:"textDocumentSync,omitempty"`
	Workspace        *WorkspaceCaps           `json:"workspace"`
	ExecuteCommand   *ExecuteCommandOptions   `json:"executeCommandProvider,omitempty"`
}

type ServerInfo struct {
	Name    string `json:"name"`
	Version string `json:"version,omitempty"`
}

type ServerInfoResult struct {
	ProtocolVersion int    `json:"protocolVersion"`
	CLIVersion      string `json:"cliVersion"`
	Commit          string `json:"commit,omitempty"`
	BuildDate       string `json:"buildDate,omitempty"`
	GoVersion       string `json:"goVersion,omitempty"`
	Platform        string `json:"platform,omitempty"`

	// Capabilities names the analysis families this build supports.
	Capabilities []string `json:"capabilities"`

	// RulesEmbedded and RuleKinds describe the compiled-in corpus, which is
	// what the client shows as "evaluated N rules" instead of an opaque wait.
	RulesEmbedded int            `json:"rulesEmbedded"`
	RuleKinds     map[string]int `json:"ruleKinds,omitempty"`
}

type SetTraceParams struct {
	Value string `json:"value"`
}

type ShowMessageParams struct {
	Type    int    `json:"type"`
	Message string `json:"message"`
}

type SuppressionInfo struct {
	// Kind is nosec, cli or console: an inline comment, a recorded local
	// suppression, or one synced from the organisation.
	Kind      string `json:"kind,omitempty"`
	Reason    string `json:"reason,omitempty"`
	ExpiresAt string `json:"expiresAt,omitempty"`
}

type TextDocumentIdentifier struct {
	URI string `json:"uri"`
}

type TextDocumentItem struct {
	URI        string `json:"uri"`
	LanguageID string `json:"languageId"`
	Version    int    `json:"version"`
	Text       string `json:"text"`
}

type TextDocumentSyncOptions struct {
	OpenClose bool         `json:"openClose"`
	Change    int          `json:"change"`
	Save      *SaveOptions `json:"save,omitempty"`
}

type VersionedTextDocumentIdentifier struct {
	URI     string `json:"uri"`
	Version int    `json:"version"`
}

type VexInfo struct {
	Status          string `json:"status,omitempty"`
	Justification   string `json:"justification,omitempty"`
	ActionStatement string `json:"actionStatement,omitempty"`
}

type VulnInfo struct {
	ID      string   `json:"id"`
	Aliases []string `json:"aliases,omitempty"`

	CVSS *float64 `json:"cvss,omitempty"`
	EPSS *float64 `json:"epss,omitempty"`
	SSVC string   `json:"ssvc,omitempty"`
	CWSS *float64 `json:"cwss,omitempty"`

	InCisaKev bool `json:"inCisaKev,omitempty"`
	InEuKev   bool `json:"inEuKev,omitempty"`
	// ExploitMaturity is none, poc, functional or weaponized.
	ExploitMaturity string `json:"exploitMaturity,omitempty"`

	CWEs []int `json:"cwes,omitempty"`
	// Reachability is reachable, not_reachable, not_assessable or unassessed.
	// The distinction between not_reachable and unassessed matters: one is an
	// answer and the other is the absence of one.
	Reachability string `json:"reachability,omitempty"`
}

type WorkDoneProgressBegin struct {
	Kind        string `json:"kind"` // "begin"
	Title       string `json:"title"`
	Cancellable bool   `json:"cancellable,omitempty"`
	Message     string `json:"message,omitempty"`
	Percentage  *int   `json:"percentage,omitempty"`
}

type WorkDoneProgressCreateParams struct {
	Token string `json:"token"`
}

type WorkDoneProgressEnd struct {
	Kind    string `json:"kind"` // "end"
	Message string `json:"message,omitempty"`
}

type WorkDoneProgressReport struct {
	Kind        string `json:"kind"` // "report"
	Cancellable bool   `json:"cancellable,omitempty"`
	Message     string `json:"message,omitempty"`
	Percentage  *int   `json:"percentage,omitempty"`
}

type WorkspaceCaps struct {
	WorkspaceFolders *WorkspaceFoldersCaps `json:"workspaceFolders,omitempty"`
}

type WorkspaceFoldersCaps struct {
	Supported           bool `json:"supported"`
	ChangeNotifications bool `json:"changeNotifications,omitempty"`
}