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, config models.DatabaseConfig) error

	// CreateUserWithRelationToSource adds a user with a relation to a source.
	CreateUserWithRelationToSource(ctx context.Context, anthroveUserID models.AnthroveUserID, sourceID models.AnthroveSourceID, accountId string, accountUsername string) error

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

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

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

	// CreateReferenceBetweenPostAndSource links a post with a source.
	CreateReferenceBetweenPostAndSource(ctx context.Context, anthrovePostID models.AnthrovePostID, sourceDomain models.AnthroveSourceDomain) error

	// CreateReferenceBetweenUserAndPost links a user with a post.
	CreateReferenceBetweenUserAndPost(ctx context.Context, anthroveUserID models.AnthroveUserID, anthrovePostID models.AnthrovePostID) error

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

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

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

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

	// GetUserFavoritesCount retrieves the count of a user's favorites.
	GetUserFavoritesCount(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)

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

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

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

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

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

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

	// GetSourceByDomain retrieves a source by its URL.
	GetSourceByDomain(ctx context.Context, sourceDomain models.AnthroveSourceDomain) (*models.Source, error)
}