api

type Api interface {
	// Login signs the client into either an administrator or a user account
	// creating a session
	Login(
		ctx context.Context,
		params LoginParams,
	) error

	// Logout signs the client out making him a guest
	Logout(
		ctx context.Context,
	) error

	// CreateUser creates a new user account
	CreateUser(
		ctx context.Context,
		params CreateUserParams,
	) (Identifier, error)

	// GetUser finds and returns the user associated with the given identifier
	GetUser(
		ctx context.Context,
		params GetUserParams,
	) (*User, error)

	// GetPost finds a specific post by the given identifier
	GetPost(
		ctx context.Context,
		params GetPostParams,
	) (*Post, error)

	// GetPostReaction finds a specific post reaction by `params.ReactionIdent`
	GetPostReaction(
		ctx context.Context,
		params GetPostReactionParams,
	) (*PostReaction, error)

	// GetReactionsOfPost returns the reactions to a specific post
	GetReactionsOfPost(
		ctx context.Context,
		params GetReactionsOfPostParams,
	) ([]*PostReaction, error)

	// GetPosts looks for n posts (n = 'limit') after
	// the post identified by the given identifier.
	// After is set to the latest post if not explicitly specified
	GetPosts(
		ctx context.Context,
		params GetPostsParams,
	) ([]*Post, error)

	// CreatePost creates a new post.
	// Requires
	CreatePost(
		ctx context.Context,
		params CreatePostParams,
	) (Identifier, error)

	// EditPost permanently changes the contents of a post.
	// Requires post author permissions
	EditPost(
		ctx context.Context,
		params EditPostParams,
	) error

	// RemovePost removes a post.
	// Requires either post author or administrator permissions
	RemovePost(
		ctx context.Context,
		params RemovePostParams,
	) error

	// CreatePostReaction creates a new reaction on the post
	CreatePostReaction(
		ctx context.Context,
		params CreatePostReactionParams,
	) (Identifier, error)

	// RemovePostReaction removes a post reaction.
	// Requires either reaction author or administrator permissions
	RemovePostReaction(
		ctx context.Context,
		params RemovePostReactionParams,
	) error
}

type CreatePostParams struct {
	Contents string `json:"contents"`
}

type CreatePostReactionParams struct {
	PostIdent   Identifier       `json:"postId"`
	Type        PostReactionType `json:"type"`
	Description string           `json:"description"`
}

type CreatePostReactionReturn struct {
	PostReactionIdent Identifier `json:"id"`
}

type CreatePostReturn struct {
	PostIdent Identifier `json:"id"`
}

type CreateUserParams struct {
	FirstName string   `json:"firstName"`
	LastName  string   `json:"lastName"`
	Username  string   `json:"username"`
	Password  string   `json:"password"`
	Type      UserType `json:"type"`
}

type CreateUserReturn struct {
	UserIdent Identifier `json:"id"`
}

type EditPostParams struct {
	PostIdent   Identifier `json:"postId"`
	NewContents string     `json:"newContents"`
}

type GetPostParams struct {
	Ident Identifier `json:"id"`
}

type GetPostReactionParams struct {
	ReactionIdent Identifier `json:"reactionId"`
}

type GetPostsParams struct {
	After *Identifier `json:"after"`
	Limit uint32      `json:"limit"`
}

type GetReactionsOfPostParams struct {
	PostIdent Identifier `json:"postId"`
}

type GetUserParams struct {
	Ident Identifier `json:"id"`
}

type Identifier struct {
	// contains filtered or unexported fields
}

type LoginParams struct {
	Username string `json:"username"`
	Password string `json:"password"`
}

type Method string

type Post struct {
	Ident       Identifier `json:"id"`
	Author      Identifier `json:"author"`
	Publication time.Time  `json:"publication"`
	Contents    string     `json:"contents"`
	LastEdit    *time.Time `json:"lastEdit"`
}

type PostReaction struct {
	Ident       Identifier       `json:"id"`
	Author      Identifier       `json:"author"`
	Type        PostReactionType `json:"type"`
	Description string           `json:"description"`
	Creation    time.Time        `json:"creation"`
}

type PostReactionType int

type RemovePostParams struct {
	PostIdent Identifier `json:"postId"`
}

type RemovePostReactionParams struct {
	ReactionIdent Identifier `json:"reactionId"`
}

type User struct {
	Identifier Identifier `json:"id"`
	FirstName  string     `json:"firstName"`
	LastName   string     `json:"lastName"`

	// Username uniquely identifies the user in the system,
	// it's also used as the login username
	Username string `json:"Username"`

	// Registration defines when this account was created
	Registration time.Time `json:"registration"`

	// Reputation defines the amount of upvotes
	// on posts and reactions by this user
	Reputation float64 `json:"reputation"`

	// Type defines whether this user is an admin, a regular user or a guest
	Type UserType `json:"type"`
}

type UserType int