pkgsite

type APIError struct {
	Code       int         `json:"code"` // HTTP status code
	Message    string      `json:"message"`
	Fixes      []string    `json:"fixes,omitempty"`      // suggestions for how to fix
	Candidates []Candidate `json:"candidates,omitempty"` // for ambiguous paths
}

type Candidate struct {
	ModulePath  string `json:"modulePath"`
	PackagePath string `json:"packagePath"`
}

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

type ImportedByOptions struct {
	Module string
	PaginationOptions
}

type License struct {
	Types    []string `json:"types"`
	FilePath string   `json:"filePath"`
	Contents string   `json:"contents,omitempty"`
}

type Module struct {
	Path    string `json:"path"`
	Version string `json:"version"`
	// CommitTime is the time the version was created, as reported by the
	// module proxy's .info endpoint.
	CommitTime        time.Time `json:"commitTime"`
	IsLatest          bool      `json:"isLatest"`
	IsRedistributable bool      `json:"isRedistributable"`
	IsStandardLibrary bool      `json:"isStandardLibrary"`
	HasGoMod          bool      `json:"hasGoMod"`
	RepoURL           string    `json:"repoUrl"`
	GoModContents     string    `json:"goModContents,omitempty"`
	Readme            *Readme   `json:"readme,omitempty"`
	Licenses          []License `json:"licenses,omitempty"`
}

type ModuleOptions struct {
	Readme   bool // include the README contents
	Licenses bool // include license information
}

type ModulePackageResponse struct {
	Path     string `json:"path"`
	Name     string `json:"name"`
	Synopsis string `json:"synopsis"`
}

type Option func(*Client)

type Package struct {
	ModulePath        string    `json:"modulePath"`
	Version           string    `json:"version"`
	IsLatest          bool      `json:"isLatest"`
	IsStandardLibrary bool      `json:"isStandardLibrary"`
	GOOS              string    `json:"goos"`
	GOARCH            string    `json:"goarch"`
	Docs              string    `json:"docs,omitempty"`
	Imports           []string  `json:"imports,omitempty"`
	Licenses          []License `json:"licenses,omitempty"`
	PackageInfo
}

type PackageImportedBy struct {
	ModulePath string                    `json:"modulePath"`
	Version    string                    `json:"version"`
	ImportedBy PaginatedResponse[string] `json:"importedBy"`
}

type PackageInfo struct {
	Path     string `json:"path"`
	Name     string `json:"name"`
	Synopsis string `json:"synopsis"`
	// IsRedistributable reports whether the license allows distribution.
	IsRedistributable bool `json:"isRedistributable"`
}

type PackageOptions struct {
	Module   string // disambiguate the module path for an ambiguous package path
	Doc      string // render docs in this format: "text", "md", or "html"
	Examples bool   // include examples (requires Doc)
	Imports  bool   // list imported packages
	Licenses bool   // include license information
	GOOS     string // target GOOS
	GOARCH   string // target GOARCH
}

type PackageSymbols struct {
	ModulePath string                    `json:"modulePath"`
	Version    string                    `json:"version"`
	Symbols    PaginatedResponse[Symbol] `json:"symbols"`
}

type PackagesResponse struct {
	ModulePath        string                         `json:"modulePath"`
	Version           string                         `json:"version"`
	IsStandardLibrary bool                           `json:"isStandardLibrary"`
	Packages          PaginatedResponse[PackageInfo] `json:"packages"`
}

type PaginatedResponse[T any] struct {
	Items         []T    `json:"items"`
	Total         int    `json:"total"`
	NextPageToken string `json:"nextPageToken,omitempty"`
}

type PaginationOptions struct {
	Limit int    // maximum items per page; 0 means the server default
	Token string // page token from a previous response's NextPageToken
}

type Readme struct {
	Filepath string `json:"filepath"`
	Contents string `json:"contents"`
}

type SearchOptions struct {
	Symbol string // restrict results to packages exporting this symbol
	PaginationOptions
}

type SearchResult struct {
	PackagePath string `json:"packagePath"`
	ModulePath  string `json:"modulePath"`
	Version     string `json:"version"`
	Synopsis    string `json:"synopsis"`
}

type Symbol struct {
	Name     string `json:"name"`
	Kind     string `json:"kind"`
	Synopsis string `json:"synopsis"`
	Parent   string `json:"parent,omitempty"`
}

type SymbolsOptions struct {
	Module string
	GOOS   string
	GOARCH string
	PaginationOptions
}

type VersionResponse struct {
	Version string `json:"version"`
}

type Vulnerability struct {
	ID           string `json:"id"`
	Summary      string `json:"summary"`
	Details      string `json:"details"`
	FixedVersion string `json:"fixedVersion"`
}