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

package database

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

type OtterSpace interface {
	// Connect establishes a connection to the database.
	Connect(ctx context.Context, endpoint string, username string, password string, database string, port int, ssl string, timezone string) error

	// AddUserWithRelationToSource adds a user with a relation to a source.
	AddUserWithRelationToSource(ctx context.Context, anthroveUserID models.AnthroveUserID, sourceDomain string, userID string, username string) error

	// AddSource adds a new source to the database.
	AddSource(ctx context.Context, anthroveSource *models.Source) error

	// AddPost adds a new post to the database.
	AddPost(ctx context.Context, anthrovePost *models.Post) error

	// AddTagWithRelationToPost adds a tag with a relation to a post.
	AddTagWithRelationToPost(ctx context.Context, anthrovePostID models.AnthrovePostID, anthroveTag *models.Tag) error

	// LinkPostWithSource links a post with a source.
	LinkPostWithSource(ctx context.Context, anthrovePostID models.AnthrovePostID, anthroveSourceDomain string, anthrovePostRelationship *models.PostReference) error

	// LinkUserWithPost links a user with a post.
	LinkUserWithPost(ctx context.Context, anthroveUser *models.User, anthrovePost *models.Post) error

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

	// GetPostByAnthroveID retrieves a post by its Anthrove ID.
	GetPostByAnthroveID(ctx context.Context, anthrovePost *models.Post) (*models.Post, error)

	// GetPostBySourceURL retrieves a post by its source URL.
	GetPostBySourceURL(ctx context.Context, sourceUrl string) (*models.Post, error)

	// GetPostBySourceID retrieves a post by its source ID.
	GetPostBySourceID(ctx context.Context, sourcePostID string) (*models.Post, error)

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

	// GetUserSourceLinks retrieves the source links of a user.
	GetUserSourceLinks(ctx context.Context, anthroveUserID models.AnthroveUserID) (map[string]models.UserSource, error)

	// GetSpecifiedUserSourceLink retrieves a specified source link of a user.
	GetSpecifiedUserSourceLink(ctx context.Context, anthroveUserID models.AnthroveUserID, sourceDisplayName string) (map[string]models.UserSource, error)

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

	// GetUserFavoritePostsWithPagination retrieves a user's favorite posts with pagination.
	GetUserFavoritePostsWithPagination(ctx context.Context, anthroveUserID models.AnthroveUserID, skip int, limit int) (*models.FavoriteList, error)

	// GetUserTagsTroughFavedPosts retrieves a user's tags through their favorited posts.
	GetUserTagsTroughFavedPosts(ctx context.Context, anthroveUserID models.AnthroveUserID) ([]models.TagsWithFrequency, error)

	// GetAllTags retrieves all tags.
	GetAllTags(ctx context.Context) ([]models.TagsWithFrequency, error)

	// GetAllSources retrieves all sources.
	GetAllSources(ctx context.Context) ([]models.Source, error)

	// GetSourceByURL retrieves a source by its URL.
	GetSourceByURL(ctx context.Context, sourceUrl string) (*models.Source, error)
}