serialization_types.ts

Declarations
#

JSON-serializable types for command output formats.
Gitops commands support --format json and --format markdown output modes in addition to styled terminal output. These types define the JSON schema for: - Dependency graph structures (SerializedGraph) - Publishing plan predictions (SerializedPublishingPlan)
Used by gitops_analyze, gitops_plan, and gitops_publish --dry_run when --format json or --outfile is specified.

4 declarations

view source

serialize_graph
#

serialization_types.ts view source

(graph: DependencyGraph): SerializedGraph

Serializes a dependency graph to a JSON-safe format.

`graph`

type DependencyGraph

returns

SerializedGraph

SerializedGraph
#

serialization_types.ts view source

SerializedGraph

`nodes`

type Array<SerializedNode>

`edges`

type Array<[string, string]>

SerializedNode
#

serialization_types.ts view source

SerializedNode

`name`

type string

`version`

type string

`dependencies`

type

Array<{
		name: string;
		type: string;
		version: string;
	}>

`dependents`

type Array<string>

`publishable`

type boolean

SerializedPublishingPlan
#

serialization_types.ts view source

SerializedPublishingPlan

`publishing_order`

type Array<string>

`version_changes`

type

Array<{
		package_name: string;
		from: string;
		to: string;
		bump_type: string;
		breaking: boolean;
		has_changesets: boolean;
		will_generate_changeset?: boolean;
		needs_bump_escalation?: boolean;
		existing_bump?: string;
		required_bump?: string;
	}>

`dependency_updates`

type

Array<{
		dependent_package: string;
		updated_dependency: string;
		new_version: string;
		type: string;
		causes_republish: boolean;
	}>

`breaking_cascades`

type Record<string, Array<string>>

`warnings`

type Array<string>

`errors`

type Array<string>