objinterface

type Collection interface {
	// DeserializeRootObject deserializes a root object's data.
	DeserializeRootObject(ctx context.Context, data []byte) (RootObject, error)
	// DiffRootObjects returns a RootObjectDiff for each change made from the ancestor that is not reflected on both
	// "ours" and "theirs".
	DiffRootObjects(ctx context.Context, fromHash string, ours RootObject, theirs RootObject, ancestor RootObject) ([]RootObjectDiff, RootObject, error)
	// DropRootObject removes the given root object from the collection.
	DropRootObject(ctx context.Context, identifier id.Id) error
	// GetFieldType returns the type associated with the given diff field name. Returns nil if the name is invalid.
	GetFieldType(ctx context.Context, fieldName string) *pgtypes.DoltgresType
	// GetID returns the identifying ID for the Collection.
	GetID() RootObjectID
	// GetRootObject returns the root object matching the given ID. Returns false if it cannot be found.
	GetRootObject(ctx context.Context, identifier id.Id) (RootObject, bool, error)
	// HasRootObject returns whether a root object exactly matching the given ID was found.
	HasRootObject(ctx context.Context, identifier id.Id) (bool, error)
	// IDToTableName converts the given ID to a table name. The table name will be empty for invalid IDs.
	IDToTableName(identifier id.Id) doltdb.TableName
	// IterAll iterates over all root objects in the Collection.
	IterAll(ctx context.Context, callback func(rootObj RootObject) (stop bool, err error)) error
	// IterIDs iterates over all IDs in the Collection.
	IterIDs(ctx context.Context, callback func(identifier id.Id) (stop bool, err error)) error
	// PutRootObject updates the Collection with the given root object. This may error if the root object already exists.
	PutRootObject(ctx context.Context, rootObj RootObject) error
	// RenameRootObject changes the ID for a root object matching the old ID.
	RenameRootObject(ctx context.Context, oldID id.Id, newID id.Id) error
	// ResolveName finds the closest matching (or exact) ID for the given name. If an exact match is not found, then
	// this may error if the name is ambiguous.
	ResolveName(ctx context.Context, name doltdb.TableName) (doltdb.TableName, id.Id, error)
	// TableNameToID converts the given name to an ID. The ID will be invalid for empty/malformed names.
	TableNameToID(name doltdb.TableName) id.Id
	// UpdateField updates the field on the given root object with the new value. Returns a new root object with the
	// updated field.
	UpdateField(ctx context.Context, rootObject RootObject, fieldName string, newValue any) (RootObject, error)

	// HandleMerge handles merging of two objects. It is guaranteed that "ours" and "theirs" will not be nil, however
	// "ancestor" may or may not be nil.
	HandleMerge(ctx context.Context, mro merge.MergeRootObject) (doltdb.RootObject, *merge.MergeStats, error)
	// LoadCollection loads the Collection from the given root.
	LoadCollection(ctx context.Context, root RootValue) (Collection, error)
	// LoadCollectionHash loads the Collection hash from the given root. This does not load the entire collection from
	// the root, and is therefore a bit more performant if only the hash is needed.
	LoadCollectionHash(ctx context.Context, root RootValue) (hash.Hash, error)
	// ResolveNameFromObjects finds the closest matching (or exact) ID for the given name. If an exact match is not
	// found, then this may error if the name is ambiguous. This searches through the given root objects rather than the
	// ones stored in the collection itself.
	ResolveNameFromObjects(ctx context.Context, name doltdb.TableName, rootObjects []RootObject) (doltdb.TableName, id.Id, error)
	// Serializer returns the serializer associated with this Collection.
	Serializer() RootObjectSerializer
	// UpdateRoot updates the Collection in the given root, returning the updated root.
	UpdateRoot(ctx context.Context, root RootValue) (RootValue, error)
}

type Conflict interface {
	RootObject
	doltdb.ConflictRootObject
	// GetContainedRootObjectID returns the root object ID of the contained items.
	GetContainedRootObjectID() RootObjectID
	// Diffs returns the diffs for the conflict, along with the merged root object if there are no diffs.
	Diffs(ctx context.Context) ([]RootObjectDiff, RootObject, error)
	// FieldType returns the type associated with the given field name. Returns nil if the name does not match a field.
	FieldType(ctx context.Context, name string) *pgtypes.DoltgresType
}

type RootObject interface {
	doltdb.RootObject
	// GetID returns the root object ID.
	GetID() id.Id
	// GetRootObjectID returns the root object ID.
	GetRootObjectID() RootObjectID
	// Serialize returns the byte representation of the root object.
	Serialize(ctx context.Context) ([]byte, error)
}

type RootObjectDiff struct {
	Type          *pgtypes.DoltgresType
	FromHash      string
	FieldName     string
	AncestorValue any
	OurValue      any
	TheirValue    any
	OurChange     RootObjectDiffChange
	TheirChange   RootObjectDiffChange
}

type RootObjectDiffChange uint8

type RootObjectID int64

type RootObjectSerializer struct {
	Bytes        func(*serial.RootValue) []byte
	RootValueAdd func(builder *flatbuffers.Builder, sequences flatbuffers.UOffsetT)
}

type RootValue interface {
	doltdb.RootValue
	// GetStorage returns the storage contained in the root.
	GetStorage(context.Context) storage.RootStorage
	// WithStorage returns an updated RootValue with the given storage.
	WithStorage(context.Context, storage.RootStorage) RootValue
}