myWebLog/src/MyWebLog.Data/Interfaces.fs

namespace MyWebLog.Data

open System
open System.Threading.Tasks
open MyWebLog
open MyWebLog.ViewModels

/// Data functions to support manipulating categories
type ICategoryData =
    
    /// Add a category
    abstract member Add : Category -> Task<unit>
    
    /// Count all categories for the given web log
    abstract member CountAll : WebLogId -> Task<int>
    
    /// Count all top-level categories for the given web log
    abstract member CountTopLevel : WebLogId -> Task<int>
    
    /// Delete a category (also removes it from posts)
    abstract member Delete : CategoryId -> WebLogId -> Task<bool>
    
    /// Find all categories for a web log, sorted alphabetically and grouped by hierarchy
    abstract member FindAllForView : WebLogId -> Task<DisplayCategory[]>
    
    /// Find a category by its ID
    abstract member FindById : CategoryId -> WebLogId -> Task<Category option>
    
    /// Find all categories for the given web log
    abstract member FindByWebLog : WebLogId -> Task<Category list>
    
    /// Restore categories from a backup
    abstract member Restore : Category list -> Task<unit>
    
    /// Update a category (slug, name, description, and parent ID)
    abstract member Update : Category -> Task<unit>


/// Data functions to support manipulating pages
type IPageData =
    
    /// Add a page
    abstract member Add : Page -> Task<unit>
    
    /// Get all pages for the web log (excluding meta items, text, revisions, and prior permalinks)
    abstract member All : WebLogId -> Task<Page list>
    
    /// Count all pages for the given web log
    abstract member CountAll : WebLogId -> Task<int>
    
    /// Count pages marked as "show in page list" for the given web log
    abstract member CountListed : WebLogId -> Task<int>
    
    /// Delete a page
    abstract member Delete : PageId -> WebLogId -> Task<bool>
    
    /// Find a page by its ID (excluding revisions and prior permalinks)
    abstract member FindById : PageId -> WebLogId -> Task<Page option>
    
    /// Find a page by its permalink (excluding revisions and prior permalinks)
    abstract member FindByPermalink : Permalink -> WebLogId -> Task<Page option>
    
    /// Find the current permalink for a page from a list of prior permalinks
    abstract member FindCurrentPermalink : Permalink list -> WebLogId -> Task<Permalink option>
    
    /// Find a page by its ID (including revisions and prior permalinks)
    abstract member FindFullById : PageId -> WebLogId -> Task<Page option>
    
    /// Find all pages for the given web log (including revisions and prior permalinks)
    abstract member FindFullByWebLog : WebLogId -> Task<Page list>
    
    /// Find pages marked as "show in page list" for the given web log (excluding text, revisions, and prior permalinks)
    abstract member FindListed : WebLogId -> Task<Page list>
    
    /// Find a page of pages (displayed in admin section) (excluding meta items, revisions and prior permalinks)
    abstract member FindPageOfPages : WebLogId -> pageNbr : int -> Task<Page list>
    
    /// Restore pages from a backup
    abstract member Restore : Page list -> Task<unit>
    
    /// Update a page
    abstract member Update : Page -> Task<unit>
    
    /// Update the prior permalinks for the given page
    abstract member UpdatePriorPermalinks : PageId -> WebLogId -> Permalink list -> Task<bool>


/// Data functions to support manipulating posts
type IPostData =
    
    /// Add a post
    abstract member Add : Post -> Task<unit>
    
    /// Count posts by their status
    abstract member CountByStatus : PostStatus -> WebLogId -> Task<int>
    
    /// Delete a post
    abstract member Delete : PostId -> WebLogId -> Task<bool>
    
    /// Find a post by its ID (excluding revisions and prior permalinks)
    abstract member FindById : PostId -> WebLogId -> Task<Post option>
    
    /// Find a post by its permalink (excluding revisions and prior permalinks)
    abstract member FindByPermalink : Permalink -> WebLogId -> Task<Post option>
    
    /// Find the current permalink for a post from a list of prior permalinks
    abstract member FindCurrentPermalink : Permalink list -> WebLogId -> Task<Permalink option>
    
    /// Find a post by its ID (including revisions and prior permalinks)
    abstract member FindFullById : PostId -> WebLogId -> Task<Post option>
    
    /// Find all posts for the given web log (including revisions and prior permalinks)
    abstract member FindFullByWebLog : WebLogId -> Task<Post list>
    
    /// Find posts to be displayed on a category list page (excluding revisions and prior permalinks)
    abstract member FindPageOfCategorizedPosts :
        WebLogId -> CategoryId list -> pageNbr : int -> postsPerPage : int -> Task<Post list>
    
    /// Find posts to be displayed on an admin page (excluding revisions and prior permalinks)
    abstract member FindPageOfPosts : WebLogId -> pageNbr : int -> postsPerPage : int -> Task<Post list>
    
    /// Find posts to be displayed on a page (excluding revisions and prior permalinks)
    abstract member FindPageOfPublishedPosts : WebLogId -> pageNbr : int -> postsPerPage : int -> Task<Post list>
    
    /// Find posts to be displayed on a tag list page (excluding revisions and prior permalinks)
    abstract member FindPageOfTaggedPosts :
        WebLogId -> tag : string -> pageNbr : int -> postsPerPage : int -> Task<Post list>
    
    /// Find the next older and newer post for the given published date/time (excluding revisions and prior permalinks)
    abstract member FindSurroundingPosts : WebLogId -> publishedOn : DateTime -> Task<Post option * Post option>
    
    /// Restore posts from a backup
    abstract member Restore : Post list -> Task<unit>
    
    /// Update a post
    abstract member Update : Post -> Task<unit>
    
    /// Update the prior permalinks for a post
    abstract member UpdatePriorPermalinks : PostId -> WebLogId -> Permalink list -> Task<bool>


/// Functions to manipulate tag mappings
type ITagMapData =
    
    /// Delete a tag mapping
    abstract member Delete : TagMapId -> WebLogId -> Task<bool>
    
    /// Find a tag mapping by its ID
    abstract member FindById : TagMapId -> WebLogId -> Task<TagMap option>
    
    /// Find a tag mapping by its URL value
    abstract member FindByUrlValue : string -> WebLogId -> Task<TagMap option>
    
    /// Retrieve all tag mappings for the given web log
    abstract member FindByWebLog : WebLogId -> Task<TagMap list>
    
    /// Find tag mappings for the given tags
    abstract member FindMappingForTags : tags : string list -> WebLogId -> Task<TagMap list>
    
    /// Restore tag mappings from a backup
    abstract member Restore : TagMap list -> Task<unit>
    
    /// Save a tag mapping (insert or update)
    abstract member Save : TagMap -> Task<unit>


/// Functions to manipulate themes
type IThemeData =
    
    /// Retrieve all themes (except "admin") (excluding the text of templates)
    abstract member All : unit -> Task<Theme list>
    
    /// Delete a theme
    abstract member Delete : ThemeId -> Task<bool>
    
    /// Determine if a theme exists
    abstract member Exists : ThemeId -> Task<bool>
    
    /// Find a theme by its ID
    abstract member FindById : ThemeId -> Task<Theme option>
    
    /// Find a theme by its ID (excluding the text of its templates)
    abstract member FindByIdWithoutText : ThemeId -> Task<Theme option>
    
    /// Save a theme (insert or update)
    abstract member Save : Theme -> Task<unit>


/// Functions to manipulate theme assets
type IThemeAssetData =
    
    /// Retrieve all theme assets (excluding data)
    abstract member All : unit -> Task<ThemeAsset list>
    
    /// Delete all theme assets for the given theme
    abstract member DeleteByTheme : ThemeId -> Task<unit>
    
    /// Find a theme asset by its ID
    abstract member FindById : ThemeAssetId -> Task<ThemeAsset option>
    
    /// Find all assets for the given theme (excludes data)
    abstract member FindByTheme : ThemeId -> Task<ThemeAsset list>
    
    /// Find all assets for the given theme (includes data)
    abstract member FindByThemeWithData : ThemeId -> Task<ThemeAsset list>
    
    /// Save a theme asset (insert or update)
    abstract member Save : ThemeAsset -> Task<unit>


/// Functions to manipulate uploaded files
type IUploadData =
    
    /// Add an uploaded file
    abstract member Add : Upload -> Task<unit>
    
    /// Delete an uploaded file
    abstract member Delete : UploadId -> WebLogId -> Task<Result<string, string>>
    
    /// Find an uploaded file by its path for the given web log
    abstract member FindByPath : string -> WebLogId -> Task<Upload option>
    
    /// Find all uploaded files for a web log (excludes data)
    abstract member FindByWebLog : WebLogId -> Task<Upload list>
    
    /// Find all uploaded files for a web log
    abstract member FindByWebLogWithData : WebLogId -> Task<Upload list>
    
    /// Restore uploaded files from a backup
    abstract member Restore : Upload list -> Task<unit>


/// Functions to manipulate web logs
type IWebLogData =
    
    /// Add a web log
    abstract member Add : WebLog -> Task<unit>
    
    /// Retrieve all web logs
    abstract member All : unit -> Task<WebLog list>
    
    /// Delete a web log, including categories, tag mappings, posts/comments, and pages
    abstract member Delete : WebLogId -> Task<unit>
    
    /// Find a web log by its host (URL base)
    abstract member FindByHost : string -> Task<WebLog option>
    
    /// Find a web log by its ID
    abstract member FindById : WebLogId -> Task<WebLog option>
    
    /// Update RSS options for a web log
    abstract member UpdateRssOptions : WebLog -> Task<unit>
    
    /// Update web log settings (from the settings page)
    abstract member UpdateSettings : WebLog -> Task<unit>


/// Functions to manipulate web log users
type IWebLogUserData =
    
    /// Add a web log user
    abstract member Add : WebLogUser -> Task<unit>
    
    /// Delete a web log user
    abstract member Delete : WebLogUserId -> WebLogId -> Task<Result<bool, string>>
    
    /// Find a web log user by their e-mail address
    abstract member FindByEmail : email : string -> WebLogId -> Task<WebLogUser option>
    
    /// Find a web log user by their ID
    abstract member FindById : WebLogUserId -> WebLogId -> Task<WebLogUser option>
    
    /// Find all web log users for the given web log
    abstract member FindByWebLog : WebLogId -> Task<WebLogUser list>
    
    /// Get a user ID -> name dictionary for the given user IDs
    abstract member FindNames : WebLogId -> WebLogUserId list -> Task<MetaItem list>
    
    /// Restore users from a backup
    abstract member Restore : WebLogUser list -> Task<unit>
    
    /// Set a user's last seen date/time to now
    abstract member SetLastSeen : WebLogUserId -> WebLogId -> Task<unit>
    
    /// Update a web log user
    abstract member Update : WebLogUser -> Task<unit>


/// Data interface required for a myWebLog data implementation
type IData =
    
    /// Category data functions
    abstract member Category : ICategoryData
    
    /// Page data functions
    abstract member Page : IPageData
    
    /// Post data functions
    abstract member Post : IPostData
    
    /// Tag map data functions
    abstract member TagMap : ITagMapData
    
    /// Theme data functions
    abstract member Theme : IThemeData
    
    /// Theme asset data functions
    abstract member ThemeAsset : IThemeAssetData
    
    /// Uploaded file functions
    abstract member Upload : IUploadData
    
    /// Web log data functions
    abstract member WebLog : IWebLogData
    
    /// Web log user data functions
    abstract member WebLogUser : IWebLogUserData
    
    /// Do any required start up data checks
    abstract member StartUp : unit -> Task<unit>