core

type File struct {
	Source
	Header Header
	Spec   *Spec
	// contains filtered or unexported fields
}

type Header struct {
	Diagram      string
	DesignSystem string
	Theme        string
	// Orientation applies to swimlanes: vertical (default; lanes are columns)
	// or horizontal (lanes are rows).
	Orientation string
}

type Source struct {
	// Path is the file's path. Imports resolve against its directory within
	// FS, or on disk when FS is nil.
	Path string
	FS   fs.FS
	Text string
}

type Spec struct {
	Name       string
	Nodes      []string
	Containers []string
	Edges      []string
	// TopLevelOnly limits object roles to top-level objects, for diagrams whose
	// nested keys are not objects (class fields, table columns, sequence spans).
	TopLevelOnly bool
	// Layout is the layout engine used unless the file or design system says otherwise.
	Layout string
	// AnalysisShape is given to every top-level object while the core compiles the
	// source to find its objects. Diagrams whose keys only compile inside a
	// structural shape (sql_table columns with constraints) need it; the final
	// shape comes from the role's class.
	AnalysisShape string
	// DefaultRole, when set, overrides the default-role rule for objects.
	DefaultRole func(obj *d2graph.Object) string
	// Transform expands the diagram's shorthand, writing the D2 to compile.
	// Nil writes the source as it is.
	Transform func(ast *d2ast.Map, b *body) error
	// Settings is D2 that applies to the diagram as a whole.
	Settings string
	// Skip reports objects that take no role.
	Skip func(obj *d2graph.Object) bool
	// Annotate returns further D2 for an object, given its key and role.
	Annotate func(obj *d2graph.Object, id, role string) string
	// Lanes lays the diagram out as a matrix of lanes and ranks (see
	// laneLayout); its connections need the lane router.
	Lanes bool
}