blocks

type Assertion struct {
	// RelationshipWithContextString is the string form of the assertion, including optional context.
	// Forms:
	// `document:firstdoc#view@user:tom`
	// `document:seconddoc#view@user:sarah with {"some":"contexthere"}`
	RelationshipWithContextString string

	// Relationship is the parsed relationship on which the assertion is being
	// run.
	Relationship tuple.Relationship

	// CaveatContext is the caveat context for the assertion, if any.
	CaveatContext map[string]any

	// SourcePosition is the position of the assertion in the file.
	SourcePosition spiceerrors.SourcePosition
}

type Assertions struct {
	// AssertTrue is the set of relationships to assert true.
	AssertTrue []Assertion `yaml:"assertTrue"`

	// AssertCaveated is the set of relationships to assert that are caveated.
	AssertCaveated []Assertion `yaml:"assertCaveated"`

	// AssertFalse is the set of relationships to assert false.
	AssertFalse []Assertion `yaml:"assertFalse"`

	// SourcePosition is the position of the assertions in the file.
	SourcePosition spiceerrors.SourcePosition
}

type ExpectedSubject struct {
	// ValidationString holds a validation string containing a Subject and one or
	// more Relations to the parent Object.
	// Example: `[tenant/user:someuser#...] is <tenant/document:example#viewer>`
	ValidationString ValidationString

	// Subject is the subject expected. May be nil if not defined in the line.
	SubjectWithExceptions *SubjectWithExceptions

	// Resources are the resources under which the subject is found.
	Resources []tuple.ObjectAndRelation

	// SourcePosition is the position of the expected subject in the file.
	SourcePosition spiceerrors.SourcePosition
}

type ObjectRelation struct {
	// ObjectRelationString is the string form of the object relation.
	ObjectRelationString string

	// ObjectAndRelation is the parsed object and relation.
	ObjectAndRelation tuple.ObjectAndRelation

	// SourcePosition is the position of the expected relations in the file.
	SourcePosition spiceerrors.SourcePosition
}

type ParsedExpectedRelations struct {
	// ValidationMap is the parsed expected relations validation map.
	ValidationMap ValidationMap

	// SourcePosition is the position of the expected relations in the file.
	SourcePosition spiceerrors.SourcePosition
}

type ParsedRelationships struct {
	// RelationshipsString is the found string of newline-separated relationships.
	RelationshipsString string

	// SourcePosition is the position of the schema in the file.
	SourcePosition spiceerrors.SourcePosition

	// Relationships are the fully parsed relationships.
	Relationships []tuple.Relationship
}

type SchemaWithPosition struct {
	// Schema is the schema found.
	Schema string

	// SourcePosition is the position of the schema in the file.
	SourcePosition spiceerrors.SourcePosition
}

type SubjectAndCaveat struct {
	// Subject is the subject found.
	Subject tuple.ObjectAndRelation

	// IsCaveated indicates whether the subject is caveated.
	IsCaveated bool
}

type SubjectWithExceptions struct {
	// Subject is the subject found.
	Subject SubjectAndCaveat

	// Exceptions are those subjects removed from the subject, if it is a wildcard.
	Exceptions []SubjectAndCaveat
}

type ValidationMap map[ObjectRelation][]ExpectedSubject

type ValidationString string