integration

type Artifact struct {
	// ID is the artifact identifier, unique within the integration.
	ID string `json:"id" yaml:"id" jsonschema:"required,description=Artifact identifier"`

	// Path is the path or glob relative to the project root
	// (e.g., "specs/<feature>/spec.md"). Angle-bracket segments denote variables.
	Path string `json:"path" yaml:"path" jsonschema:"required,description=Path or glob relative to project root"`

	// Role classifies the artifact.
	Role ArtifactRole `` /* 189-byte string literal not displayed */

	// Description explains the artifact's purpose.
	Description string `json:"description,omitempty" yaml:"description,omitempty" jsonschema:"description=Artifact purpose"`

	// Phase is the lifecycle phase ID that produces this artifact.
	Phase string `json:"phase,omitempty" yaml:"phase,omitempty" jsonschema:"description=Lifecycle phase ID that produces this artifact"`

	// SpecType optionally maps this artifact to a specification-workflow-spec
	// spec type ID (e.g., "trd", "prd"), enabling cross-tool alignment.
	SpecType string `` /* 126-byte string literal not displayed */

	// Produced is true if the tool writes this artifact, false if it only
	// consumes it.
	Produced bool `json:"produced,omitempty" yaml:"produced,omitempty" jsonschema:"description=True if the tool writes this artifact"`
}

type ArtifactRole string

type Detection struct {
	// RootMarkers are paths (relative to a project root) whose presence
	// indicates the tool. Any match is sufficient (e.g., "openspec/", ".specify/").
	RootMarkers []string `` /* 136-byte string literal not displayed */

	// Globs are additional file globs that corroborate detection.
	Globs []string `json:"globs,omitempty" yaml:"globs,omitempty" jsonschema:"description=Additional corroborating file globs"`
}

type Integration struct {
	// ID is the canonical identifier (e.g., "spec-kit", "ai-dlc", "openspec").
	ID string `json:"id" yaml:"id" jsonschema:"required,description=Canonical identifier for the integration"`

	// Name is the human-readable name (e.g., "GitHub Spec-Kit").
	Name string `json:"name" yaml:"name" jsonschema:"required,description=Human-readable name"`

	// ShortName is an abbreviated name for compact UI display.
	ShortName string `json:"short_name,omitempty" yaml:"short_name,omitempty" jsonschema:"description=Abbreviated name for compact display"`

	// Vendor is the owning organization or project (e.g., "GitHub", "AWS Labs").
	Vendor string `json:"vendor,omitempty" yaml:"vendor,omitempty" jsonschema:"description=Owning organization or project"`

	// Description explains the tool's purpose in one or two sentences.
	Description string `json:"description,omitempty" yaml:"description,omitempty" jsonschema:"description=Purpose of the tool"`

	// Kind classifies the tool as definition, execution, or hybrid.
	Kind Kind `json:"kind" yaml:"kind" jsonschema:"required,enum=definition,enum=execution,enum=hybrid"`

	// Source indicates whether the descriptor was modeled from a repository or
	// from documentation only.
	Source SourceKind `json:"source,omitempty" yaml:"source,omitempty" jsonschema:"enum=repo,enum=docs,description=How this descriptor was modeled"`

	// Homepage is the tool's homepage URL.
	Homepage string `json:"homepage,omitempty" yaml:"homepage,omitempty" jsonschema:"format=uri,description=Homepage URL"`

	// Repo is the tool's source repository URL.
	Repo string `json:"repo,omitempty" yaml:"repo,omitempty" jsonschema:"format=uri,description=Source repository URL"`

	// Reference is a URL to the tool's canonical documentation.
	Reference string `json:"reference,omitempty" yaml:"reference,omitempty" jsonschema:"format=uri,description=Canonical documentation URL"`

	// License is the SPDX license identifier or name (e.g., "MIT").
	License string `json:"license,omitempty" yaml:"license,omitempty" jsonschema:"description=License identifier"`

	// Invocations lists the modes by which the tool is driven.
	Invocations []Invocation `json:"invocations,omitempty" yaml:"invocations,omitempty" jsonschema:"description=How the tool is driven"`

	// CLICommand is the primary CLI entrypoint, if any (e.g., "specify", "openspec").
	CLICommand string `json:"cli_command,omitempty" yaml:"cli_command,omitempty" jsonschema:"description=Primary CLI command name"`

	// Agents lists supported AI agents or runtimes (e.g., "Claude Code", "Cursor").
	Agents []string `json:"agents,omitempty" yaml:"agents,omitempty" jsonschema:"description=Supported AI agents or runtimes"`

	// Detection describes how to recognize a project using this tool on disk.
	Detection Detection `json:"detection" yaml:"detection" jsonschema:"required,description=How to detect the tool on disk"`

	// Artifacts are the files the tool reads or writes.
	Artifacts []Artifact `json:"artifacts,omitempty" yaml:"artifacts,omitempty" jsonschema:"description=Files the tool reads or writes"`

	// Lifecycle is the ordered list of phases the tool moves through.
	Lifecycle []Phase `json:"lifecycle,omitempty" yaml:"lifecycle,omitempty" jsonschema:"description=Ordered lifecycle phases"`

	// Status declares how a viewer computes progress from artifacts.
	Status *StatusModel `json:"status,omitempty" yaml:"status,omitempty" jsonschema:"description=How to compute progress from artifacts"`

	// Inputs are the seams where upstream specs feed into the tool.
	Inputs []Port `json:"inputs,omitempty" yaml:"inputs,omitempty" jsonschema:"description=Input seams (what feeds in)"`

	// Outputs are the seams where the tool emits its results.
	Outputs []Port `json:"outputs,omitempty" yaml:"outputs,omitempty" jsonschema:"description=Output seams (what it emits)"`
}

type Invocation string

type Kind string

type Phase struct {
	// ID is the phase identifier.
	ID string `json:"id" yaml:"id" jsonschema:"required,description=Phase identifier"`

	// Name is the human-readable phase name.
	Name string `json:"name" yaml:"name" jsonschema:"required,description=Phase name"`

	// Description explains the phase.
	Description string `json:"description,omitempty" yaml:"description,omitempty" jsonschema:"description=Phase purpose"`

	// Command is the CLI command or slash command that drives the phase
	// (e.g., "/specify", "openspec archive").
	Command string `json:"command,omitempty" yaml:"command,omitempty" jsonschema:"description=Command or slash command that drives the phase"`

	// Produces lists artifact IDs emitted by this phase.
	Produces []string `json:"produces,omitempty" yaml:"produces,omitempty" jsonschema:"description=Artifact IDs emitted by this phase"`

	// Consumes lists artifact IDs required by this phase.
	Consumes []string `json:"consumes,omitempty" yaml:"consumes,omitempty" jsonschema:"description=Artifact IDs required by this phase"`
}

type Port struct {
	// ID is the port identifier, unique within the integration.
	ID string `json:"id" yaml:"id" jsonschema:"required,description=Port identifier"`

	// Medium classifies what flows across the seam.
	Medium PortMedium `json:"medium" yaml:"medium" jsonschema:"required,enum=spec-file,enum=code,enum=tests,enum=prompt,enum=export"`

	// Description explains the seam.
	Description string `json:"description,omitempty" yaml:"description,omitempty" jsonschema:"description=Seam explanation"`

	// SpecTypes lists specification-workflow-spec spec type IDs that map to this
	// port, used primarily for inputs (e.g., an execution tool that accepts a
	// "trd" and a "prd").
	SpecTypes []string `json:"spec_types,omitempty" yaml:"spec_types,omitempty" jsonschema:"description=Mapped spec type IDs (for inputs)"`

	// Artifacts lists artifact IDs associated with this port, used primarily for
	// outputs.
	Artifacts []string `json:"artifacts,omitempty" yaml:"artifacts,omitempty" jsonschema:"description=Associated artifact IDs (for outputs)"`
}

type PortMedium string

type SourceKind string

type StatusMethod string

type StatusModel struct {
	// Method is the progress-computation strategy.
	Method StatusMethod `json:"method" yaml:"method" jsonschema:"required,enum=task-checkboxes,enum=phase-files,enum=dir-state,enum=frontmatter"`

	// Source is the artifact ID or glob the method reads.
	Source string `json:"source,omitempty" yaml:"source,omitempty" jsonschema:"description=Artifact ID or glob the method reads"`

	// Description explains how status is derived.
	Description string `json:"description,omitempty" yaml:"description,omitempty" jsonschema:"description=How status is derived"`
}