nuggit

type Adjacency struct {
	// Key describes the src Node.
	Key NodeKey `json:"key,omitempty"`
	// Edges lists all adjacent edges by EdgeKey.
	Edges []EdgeKey `json:"edges,omitempty"`
}

type BaseResource struct {
	// APIVersion specifies the version of the Nuggit API to use when evaluating the Spec.
	//
	// Examples:
	//
	//	* v1alpha
	//	* v1
	//
	APIVersion string `json:"api_version,omitempty"`
	// Kind describes the type of the attached Spec.
	//
	// Examples:
	//
	//	* Graph
	//
	Kind string `json:"kind,omitempty"`
	// Metadata describes additional data to associate with the Spec.
	Metadata *Metadata `json:"metadata,omitempty"`
}

type Edge struct {
	// Key is a unique id for the Edge.
	Key EdgeKey `json:"key,omitempty"`
	// Src describes the starting Node.
	Src NodeKey `json:"src,omitempty"`
	// Dst describes the terminal Node.
	Dst NodeKey `json:"dst,omitempty"`
	// SrcField describes the field within Src, if set.
	//
	// See the doc for specific Ops to see which fields are defined.
	SrcField FieldKey `json:"src_field,omitempty"`
	// DstField describes the field within Dst, if set.
	//
	// See the doc for specific Ops to see which fields are defined.
	DstField FieldKey `json:"dst_field,omitempty"`
	// Data specifies arbitrary JSON data to attach to this Edge.
	//
	// The Op runtime may use Data to change the semantics of the connection.
	Data json.RawMessage `json:"data,omitempty"`
}

type EdgeKey = Key

type Exchange struct {
	SrcStage StageKey `json:"src_stage,omitempty"`
	// DstGraph
	DstStage StageKey `json:"dst_stage,omitempty"`
	// Edge represents the logical connection where Src is a Node in SrcGraph
	// and Dst is a Node in DstGraph.
	Edge `json:",omitempty"`
}

type FieldKey = Key

type Graph struct {
	// Stage is the name of the stage for this Graph.
	Stage StageKey `json:"stage,omitempty"`
	// Adjacency describes the adjacency list for the Graph.
	// Adjacencies relate NodeKeys to the ordered lists of EdgeKeys sourced there.
	//
	// See Adjacency.
	Adjacency []Adjacency `json:"adjacency,omitempty"`
	// Edges describe the edge list for the Graph.
	//
	// See Edge.
	Edges []Edge `json:"edges,omitempty"`
	// Nodes describe the vertex list for the Graph.
	//
	// See Node.
	Nodes []Node `json:"nodes,omitempty"`
}

type Key = string

type Metadata struct {
	// Name is a human name for a Resource.
	Name string `json:"name,omitempty"`
	// Description is human text describing a Resource.
	Description string `json:"description,omitempty"`
	// Version is an opaque version ID for a Resource.
	//
	// Examples:
	//
	//	* v1
	//	* v1.1.0-release
	//
	Version string `json:"version,omitempty"`
	// Encoding describes the encoding of a Resource Spec.
	// For instance, if the Spec is a GZip encoded JSON blob
	// "gzip" can be used.
	// An empty string typically means JSON encoded.
	//
	// Examples:
	//
	//	* gzip
	//
	Encoding string `json:"encoding,omitempty"`
	// Labels are opaque strings to describe a Resource.
	// These are usually simple string tags.
	Labels []string `json:"labels,omitempty"`
}

type Node struct {
	Key NodeKey `json:"key,omitempty"`
	// Op specifies
	Op OpKey `json:"op,omitempty"`
	// Data specifies arbitrary data to attach to this Edge.
	//
	// Data can be used to alter the behavior of the Op.
	Data any `json:"data,omitempty"`
}

type NodeKey = Key

type OpKey = Key

type Plan struct {
	Graphs    []Graph    `json:"graphs,omitempty"`
	Exchanges []Exchange `json:"exchanges,omitempty"`
}

type RawResource struct {
	BaseResource `json:",omitempty"`
	// Spec is arbitrary data that this Resource describes.
	Spec json.RawMessage `json:"spec,omitempty"`
}

type Resource struct {
	BaseResource `json:",omitempty"`
	// Spec is arbitrary data that this Resource describes.
	Spec any `json:"spec,omitempty"`
}

type ResourceDecoder struct {
	// Sums defines checksums to use on the encoded byte data of a Resource.
	// Only those checksums that are nonempty are validated.
	Sums *Sums
}

type ResourceEncoder struct {
	Gzip bool
}

type Stage struct {
	// Key is a unique id for the Stage.
	Key StageKey `json:"key,omitempty"`
	// Nodes is an ordered list of the Nodes in this stage.
	Nodes []NodeKey `json:"nodes,omitempty"`
}

type StageKey = Key

type SumTest struct {
	Sum      string
	Expected string
	Actual   string
}

type SumTests []SumTest

type Sums struct {
	// CRC32 hex encoded checksum.
	CRC32 string `json:"crc32,omitempty"`
	// SHA1 hex encoded hash.
	SHA1 string `json:"sha1,omitempty"`
	// SHA2 hex encoded hash.
	SHA2 string `json:"sha2,omitempty"`
}

type Type string