otter-space-sdk/pkg/graph/graph.go

package graph

import (
	"context"

	"git.dragse.it/anthrove/otter-space-sdk/pkg/models"
)

type OtterSpace interface {
	// Connect sets up a connection to the endpoint using the provided username and password
	Connect(ctx context.Context, endpoint string, username string, password string) error

	// AddUserWithRelationToSource uploads an Anthrove user to the graph
	AddUserWithRelationToSource(ctx context.Context, anthroveUserID models.AnthroveUserID, sourceDomain string, userID string, username string) (*models.AnthroveUser, error)

	// AddSource uploads an Anthrove source to the graph
	AddSource(ctx context.Context, anthroveSource *models.AnthroveSource) error

	// AddPost uploads an Anthrove post to the graph
	AddPost(ctx context.Context, anthrovePost *models.AnthrovePost) error

	// AddTagWithRelationToPost uploads a tag associated with an Anthrove post to the graph
	AddTagWithRelationToPost(ctx context.Context, anthrovePostID models.AnthrovePostID, anthroveTag *models.AnthroveTag) error

	// LinkPostWithSource establishes a link between a post and a source in the graph
	LinkPostWithSource(ctx context.Context, anthrovePostID models.AnthrovePostID, anthroveSourceDomain string, anthrovePostRelationship *models.AnthrovePostRelationship) error

	// LinkUserWithPost establishes a link between a user and a post in the graph
	LinkUserWithPost(ctx context.Context, anthroveUser *models.AnthroveUser, anthrovePost *models.AnthrovePost) error

	// CheckUserPostLink checks if a link between a user and a post exists in the graph
	CheckUserPostLink(ctx context.Context, anthroveUserID models.AnthroveUserID, sourcePostID string, sourceUrl string) (bool, error)

	// CheckPostNodeExistsByAnthroveID checks if an Anthrove post node exists in the graph by its Anthrove ID
	CheckPostNodeExistsByAnthroveID(ctx context.Context, anthrovePost *models.AnthrovePost) (*models.AnthrovePost, bool, error)

	// CheckPostNodeExistsBySourceURL checks if an Anthrove post node exists in the graph by its source URL
	CheckPostNodeExistsBySourceURL(ctx context.Context, sourceUrl string) (*models.AnthrovePost, bool, error)

	// CheckPostNodeExistsBySourceID checks if an Anthrove post node exists in the graph by its source ID
	CheckPostNodeExistsBySourceID(ctx context.Context, sourcePostID string) (*models.AnthrovePost, bool, error)

	// GetUserFavoriteCount retrieves the count of user's favorite posts
	GetUserFavoriteCount(ctx context.Context, anthroveUserID models.AnthroveUserID) (int64, error)

	// GetUserSourceLinks retrieves the links between a user and sources in the graph
	GetUserSourceLinks(ctx context.Context, anthroveUserID models.AnthroveUserID) (map[string]models.AnthroveUserRelationship, error)

	// GetAnthroveUser retrieves an Anthrove user from the graph by their ID
	GetAnthroveUser(ctx context.Context, anthroveUserID models.AnthroveUserID) (*models.AnthroveUser, error)

	// GetAllAnthroveUserIDs retrieves all Anthrove user IDs from the graph
	GetAllAnthroveUserIDs(ctx context.Context) ([]models.AnthroveUserID, error)
}