otter-space-sdk/pkg/graph.go

55 lines
2.9 KiB
Go

package pkg
import (
"context"
"git.dragse.it/anthrove/anthrove-graph-sdk.git/pkg/models"
)
type Graph 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, anthrovePost *models.AnthrovePost, anthrovePostRelationship *models.AnthrovePostRelationship, anthroveSource *models.AnthroveSource) 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
// VerifyUserPostLink checks if a link between a user and a post exists in the graph
VerifyUserPostLink(ctx context.Context, anthrovePost *models.AnthrovePost, anthroveUser *models.AnthroveUser) (bool, error)
// CheckPostNodeExistsByAnthroveID checks if an Anthrove post node exists in the graph by its Anthrove ID
CheckPostNodeExistsByAnthroveID(ctx context.Context, anthrovePost *models.AnthrovePost) (bool, error)
// CheckPostNodeExistsBySourceURL checks if an Anthrove post node exists in the graph by its source URL
CheckPostNodeExistsBySourceURL(ctx context.Context, anthroveSource *models.AnthroveSource) (bool, error)
// CheckPostNodeExistsBySourceID checks if an Anthrove post node exists in the graph by its source ID
CheckPostNodeExistsBySourceID(ctx context.Context, anthroveSource *models.AnthroveSource) (bool, error)
// GetUserFavoriteCount retrieves the count of user's favorite posts
GetUserFavoriteCount(ctx context.Context, anthroveUser *models.AnthroveUser) (int64, error)
// GetUserSourceLinks retrieves the links between a user and sources in the graph
GetUserSourceLinks(ctx context.Context, anthroveUser *models.AnthroveUser) (map[string]models.AnthroveUserRelationship, error)
// GetAnthroveUser retrieves an Anthrove user from the graph by their ID
GetAnthroveUser(ctx context.Context, anthroveUser *models.AnthroveUser) (*models.AnthroveUser, error)
// GetAllAnthroveUserIDs retrieves all Anthrove user IDs from the graph
GetAllAnthroveUserIDs(ctx context.Context) ([]models.AnthroveUserID, error)
}