backend-0.1.0.0
LicenseAGPL-3
Maintainerstu235271@mail.uni-kiel.de stu236925@mail.uni-kiel.de
Safe HaskellNone
LanguageHaskell2010

Docs.TextRevision

Description

This module contains definitions for revisions of TextElements.

Synopsis

Documentation

newtype TextRevisionID Source #

ID for a text revision

Constructors

TextRevisionID 

Instances

Instances details
FromJSON TextRevisionID Source # 
Instance details

Defined in Docs.TextRevision

Methods

parseJSON :: Value -> Parser TextRevisionID

parseJSONList :: Value -> Parser [TextRevisionID]

omittedField :: Maybe TextRevisionID

ToJSON TextRevisionID Source # 
Instance details

Defined in Docs.TextRevision

Show TextRevisionID Source # 
Instance details

Defined in Docs.TextRevision

Eq TextRevisionID Source # 
Instance details

Defined in Docs.TextRevision

Ord TextRevisionID Source # 
Instance details

Defined in Docs.TextRevision

FromHttpApiData TextRevisionID Source # 
Instance details

Defined in Docs.TextRevision

ToParamSchema TextRevisionID Source # 
Instance details

Defined in Docs.TextRevision

Methods

toParamSchema :: Proxy TextRevisionID -> Schema

ToSchema TextRevisionID Source # 
Instance details

Defined in Docs.TextRevision

Methods

declareNamedSchema :: Proxy TextRevisionID -> Declare (Definitions Schema) NamedSchema

data TextRevisionSelector Source #

Selector for a text revision

Instances

Instances details
FromJSON TextRevisionSelector Source # 
Instance details

Defined in Docs.TextRevision

ToJSON TextRevisionSelector Source # 
Instance details

Defined in Docs.TextRevision

FromHttpApiData TextRevisionSelector Source # 
Instance details

Defined in Docs.TextRevision

ToParamSchema TextRevisionSelector Source # 
Instance details

Defined in Docs.TextRevision

ToSchema TextRevisionSelector Source # 
Instance details

Defined in Docs.TextRevision

Methods

declareNamedSchema :: Proxy TextRevisionSelector -> Declare (Definitions Schema) NamedSchema

data TextRevision Source #

A text revision.

Constructors

TextRevision 

Fields

Instances

Instances details
FromJSON TextRevision Source # 
Instance details

Defined in Docs.TextRevision

Methods

parseJSON :: Value -> Parser TextRevision

parseJSONList :: Value -> Parser [TextRevision]

omittedField :: Maybe TextRevision

ToJSON TextRevision Source # 
Instance details

Defined in Docs.TextRevision

Methods

toJSON :: TextRevision -> Value

toEncoding :: TextRevision -> Encoding

toJSONList :: [TextRevision] -> Value

toEncodingList :: [TextRevision] -> Encoding

omitField :: TextRevision -> Bool

Generic TextRevision Source # 
Instance details

Defined in Docs.TextRevision

Associated Types

type Rep TextRevision 
Instance details

Defined in Docs.TextRevision

type Rep TextRevision = D1 ('MetaData "TextRevision" "Docs.TextRevision" "backend-0.1.0.0-2H73EnUlGVcEtlIi2XNQz3" 'False) (C1 ('MetaCons "TextRevision" 'PrefixI 'True) (S1 ('MetaSel ('Just "header") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 TextRevisionHeader) :*: (S1 ('MetaSel ('Just "content") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: S1 ('MetaSel ('Just "commentAnchors") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Vector CommentAnchor)))))
ToSchema TextRevision Source # 
Instance details

Defined in Docs.TextRevision

Methods

declareNamedSchema :: Proxy TextRevision -> Declare (Definitions Schema) NamedSchema

type Rep TextRevision Source # 
Instance details

Defined in Docs.TextRevision

type Rep TextRevision = D1 ('MetaData "TextRevision" "Docs.TextRevision" "backend-0.1.0.0-2H73EnUlGVcEtlIi2XNQz3" 'False) (C1 ('MetaCons "TextRevision" 'PrefixI 'True) (S1 ('MetaSel ('Just "header") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 TextRevisionHeader) :*: (S1 ('MetaSel ('Just "content") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: S1 ('MetaSel ('Just "commentAnchors") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Vector CommentAnchor)))))

data TextRevisionHeader Source #

Header of a text revision. Contains metadata for a text revision.

Constructors

TextRevisionHeader 

Fields

Instances

Instances details
FromJSON TextRevisionHeader Source # 
Instance details

Defined in Docs.TextRevision

ToJSON TextRevisionHeader Source # 
Instance details

Defined in Docs.TextRevision

Generic TextRevisionHeader Source # 
Instance details

Defined in Docs.TextRevision

Associated Types

type Rep TextRevisionHeader 
Instance details

Defined in Docs.TextRevision

type Rep TextRevisionHeader = D1 ('MetaData "TextRevisionHeader" "Docs.TextRevision" "backend-0.1.0.0-2H73EnUlGVcEtlIi2XNQz3" 'False) (C1 ('MetaCons "TextRevisionHeader" 'PrefixI 'True) (S1 ('MetaSel ('Just "identifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 TextRevisionID) :*: (S1 ('MetaSel ('Just "timestamp") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 UTCTime) :*: S1 ('MetaSel ('Just "author") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 UserRef))))
Show TextRevisionHeader Source # 
Instance details

Defined in Docs.TextRevision

ToSchema TextRevisionHeader Source # 
Instance details

Defined in Docs.TextRevision

Methods

declareNamedSchema :: Proxy TextRevisionHeader -> Declare (Definitions Schema) NamedSchema

type Rep TextRevisionHeader Source # 
Instance details

Defined in Docs.TextRevision

type Rep TextRevisionHeader = D1 ('MetaData "TextRevisionHeader" "Docs.TextRevision" "backend-0.1.0.0-2H73EnUlGVcEtlIi2XNQz3" 'False) (C1 ('MetaCons "TextRevisionHeader" 'PrefixI 'True) (S1 ('MetaSel ('Just "identifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 TextRevisionID) :*: (S1 ('MetaSel ('Just "timestamp") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 UTCTime) :*: S1 ('MetaSel ('Just "author") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 UserRef))))

data TextElementRevision Source #

A text revision with the text element it belongs to.

Instances

Instances details
FromJSON TextElementRevision Source # 
Instance details

Defined in Docs.TextRevision

ToJSON TextElementRevision Source # 
Instance details

Defined in Docs.TextRevision

Renderable TextElementRevision Source # 
Instance details

Defined in Docs.Renderable

Generic TextElementRevision Source # 
Instance details

Defined in Docs.TextRevision

Associated Types

type Rep TextElementRevision 
Instance details

Defined in Docs.TextRevision

type Rep TextElementRevision = D1 ('MetaData "TextElementRevision" "Docs.TextRevision" "backend-0.1.0.0-2H73EnUlGVcEtlIi2XNQz3" 'False) (C1 ('MetaCons "TextElementRevision" 'PrefixI 'True) (S1 ('MetaSel ('Just "textElement") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 TextElement) :*: S1 ('MetaSel ('Just "revision") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe TextRevision))))
ToSchema TextElementRevision Source # 
Instance details

Defined in Docs.TextRevision

Methods

declareNamedSchema :: Proxy TextElementRevision -> Declare (Definitions Schema) NamedSchema

type Rep TextElementRevision Source # 
Instance details

Defined in Docs.TextRevision

type Rep TextElementRevision = D1 ('MetaData "TextElementRevision" "Docs.TextRevision" "backend-0.1.0.0-2H73EnUlGVcEtlIi2XNQz3" 'False) (C1 ('MetaCons "TextElementRevision" 'PrefixI 'True) (S1 ('MetaSel ('Just "textElement") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 TextElement) :*: S1 ('MetaSel ('Just "revision") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe TextRevision))))

data ConflictStatus Source #

A conflict with another text revision.

Constructors

Conflict TextRevisionID 
NoConflict TextRevision 
DraftCreated DraftRevision TextRevisionID

created draft and conflicting revision ID

Instances

Instances details
FromJSON ConflictStatus Source # 
Instance details

Defined in Docs.TextRevision

Methods

parseJSON :: Value -> Parser ConflictStatus

parseJSONList :: Value -> Parser [ConflictStatus]

omittedField :: Maybe ConflictStatus

ToJSON ConflictStatus Source # 
Instance details

Defined in Docs.TextRevision

ToSchema ConflictStatus Source # 
Instance details

Defined in Docs.TextRevision

Methods

declareNamedSchema :: Proxy ConflictStatus -> Declare (Definitions Schema) NamedSchema

data TextRevisionHistory Source #

A sequence of revisions for a text element

Instances

Instances details
FromJSON TextRevisionHistory Source # 
Instance details

Defined in Docs.TextRevision

ToJSON TextRevisionHistory Source # 
Instance details

Defined in Docs.TextRevision

ToSchema TextRevisionHistory Source # 
Instance details

Defined in Docs.TextRevision

Methods

declareNamedSchema :: Proxy TextRevisionHistory -> Declare (Definitions Schema) NamedSchema

data TextRevisionRef Source #

A reference to a TextRevision

Instances

Instances details
FromJSON TextRevisionRef Source # 
Instance details

Defined in Docs.TextRevision

ToJSON TextRevisionRef Source # 
Instance details

Defined in Docs.TextRevision

Generic TextRevisionRef Source # 
Instance details

Defined in Docs.TextRevision

Associated Types

type Rep TextRevisionRef 
Instance details

Defined in Docs.TextRevision

type Rep TextRevisionRef = D1 ('MetaData "TextRevisionRef" "Docs.TextRevision" "backend-0.1.0.0-2H73EnUlGVcEtlIi2XNQz3" 'False) (C1 ('MetaCons "TextRevisionRef" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 TextElementRef) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 TextRevisionSelector)))
ToSchema TextRevisionRef Source # 
Instance details

Defined in Docs.TextRevision

Methods

declareNamedSchema :: Proxy TextRevisionRef -> Declare (Definitions Schema) NamedSchema

type Rep TextRevisionRef Source # 
Instance details

Defined in Docs.TextRevision

type Rep TextRevisionRef = D1 ('MetaData "TextRevisionRef" "Docs.TextRevision" "backend-0.1.0.0-2H73EnUlGVcEtlIi2XNQz3" 'False) (C1 ('MetaCons "TextRevisionRef" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 TextElementRef) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 TextRevisionSelector)))

newtype DraftRevisionID Source #

ID for a draft text revision

Constructors

DraftRevisionID 

Instances

Instances details
FromJSON DraftRevisionID Source # 
Instance details

Defined in Docs.TextRevision

ToJSON DraftRevisionID Source # 
Instance details

Defined in Docs.TextRevision

Show DraftRevisionID Source # 
Instance details

Defined in Docs.TextRevision

Eq DraftRevisionID Source # 
Instance details

Defined in Docs.TextRevision

Ord DraftRevisionID Source # 
Instance details

Defined in Docs.TextRevision

ToSchema DraftRevisionID Source # 
Instance details

Defined in Docs.TextRevision

Methods

declareNamedSchema :: Proxy DraftRevisionID -> Declare (Definitions Schema) NamedSchema

data DraftRevision Source #

A draft text revision.

Instances

Instances details
FromJSON DraftRevision Source # 
Instance details

Defined in Docs.TextRevision

Methods

parseJSON :: Value -> Parser DraftRevision

parseJSONList :: Value -> Parser [DraftRevision]

omittedField :: Maybe DraftRevision

ToJSON DraftRevision Source # 
Instance details

Defined in Docs.TextRevision

Generic DraftRevision Source # 
Instance details

Defined in Docs.TextRevision

Associated Types

type Rep DraftRevision 
Instance details

Defined in Docs.TextRevision

type Rep DraftRevision = D1 ('MetaData "DraftRevision" "Docs.TextRevision" "backend-0.1.0.0-2H73EnUlGVcEtlIi2XNQz3" 'False) (C1 ('MetaCons "DraftRevision" 'PrefixI 'True) (S1 ('MetaSel ('Just "draftHeader") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 DraftRevisionHeader) :*: (S1 ('MetaSel ('Just "draftContent") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: S1 ('MetaSel ('Just "draftCommentAnchors") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Vector CommentAnchor)))))
ToSchema DraftRevision Source # 
Instance details

Defined in Docs.TextRevision

Methods

declareNamedSchema :: Proxy DraftRevision -> Declare (Definitions Schema) NamedSchema

type Rep DraftRevision Source # 
Instance details

Defined in Docs.TextRevision

type Rep DraftRevision = D1 ('MetaData "DraftRevision" "Docs.TextRevision" "backend-0.1.0.0-2H73EnUlGVcEtlIi2XNQz3" 'False) (C1 ('MetaCons "DraftRevision" 'PrefixI 'True) (S1 ('MetaSel ('Just "draftHeader") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 DraftRevisionHeader) :*: (S1 ('MetaSel ('Just "draftContent") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: S1 ('MetaSel ('Just "draftCommentAnchors") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Vector CommentAnchor)))))

data DraftRevisionHeader Source #

Header of a draft text revision.

Instances

Instances details
FromJSON DraftRevisionHeader Source # 
Instance details

Defined in Docs.TextRevision

ToJSON DraftRevisionHeader Source # 
Instance details

Defined in Docs.TextRevision

Generic DraftRevisionHeader Source # 
Instance details

Defined in Docs.TextRevision

Associated Types

type Rep DraftRevisionHeader 
Instance details

Defined in Docs.TextRevision

type Rep DraftRevisionHeader = D1 ('MetaData "DraftRevisionHeader" "Docs.TextRevision" "backend-0.1.0.0-2H73EnUlGVcEtlIi2XNQz3" 'False) (C1 ('MetaCons "DraftRevisionHeader" 'PrefixI 'True) ((S1 ('MetaSel ('Just "draftIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 DraftRevisionID) :*: S1 ('MetaSel ('Just "basedOnRevision") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 TextRevisionID)) :*: (S1 ('MetaSel ('Just "creationTimestamp") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 UTCTime) :*: (S1 ('MetaSel ('Just "lastUpdatedTimestamp") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 UTCTime) :*: S1 ('MetaSel ('Just "draftAuthor") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 UserRef)))))
Show DraftRevisionHeader Source # 
Instance details

Defined in Docs.TextRevision

ToSchema DraftRevisionHeader Source # 
Instance details

Defined in Docs.TextRevision

Methods

declareNamedSchema :: Proxy DraftRevisionHeader -> Declare (Definitions Schema) NamedSchema

type Rep DraftRevisionHeader Source # 
Instance details

Defined in Docs.TextRevision

type Rep DraftRevisionHeader = D1 ('MetaData "DraftRevisionHeader" "Docs.TextRevision" "backend-0.1.0.0-2H73EnUlGVcEtlIi2XNQz3" 'False) (C1 ('MetaCons "DraftRevisionHeader" 'PrefixI 'True) ((S1 ('MetaSel ('Just "draftIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 DraftRevisionID) :*: S1 ('MetaSel ('Just "basedOnRevision") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 TextRevisionID)) :*: (S1 ('MetaSel ('Just "creationTimestamp") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 UTCTime) :*: (S1 ('MetaSel ('Just "lastUpdatedTimestamp") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 UTCTime) :*: S1 ('MetaSel ('Just "draftAuthor") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 UserRef)))))

data Rendered a Source #

A element together with its rendered html representation.

Constructors

Rendered 

Fields

  • element :: a

    the element itself

  • html :: Text

    the html representation of the element. TODO: ByteString might be better suited!

Instances

Instances details
FromJSON a => FromJSON (Rendered a) Source # 
Instance details

Defined in Docs.TextRevision

Methods

parseJSON :: Value -> Parser (Rendered a)

parseJSONList :: Value -> Parser [Rendered a]

omittedField :: Maybe (Rendered a)

ToJSON a => ToJSON (Rendered a) Source # 
Instance details

Defined in Docs.TextRevision

Methods

toJSON :: Rendered a -> Value

toEncoding :: Rendered a -> Encoding

toJSONList :: [Rendered a] -> Value

toEncodingList :: [Rendered a] -> Encoding

omitField :: Rendered a -> Bool

Generic (Rendered a) Source # 
Instance details

Defined in Docs.TextRevision

Associated Types

type Rep (Rendered a) 
Instance details

Defined in Docs.TextRevision

type Rep (Rendered a) = D1 ('MetaData "Rendered" "Docs.TextRevision" "backend-0.1.0.0-2H73EnUlGVcEtlIi2XNQz3" 'False) (C1 ('MetaCons "Rendered" 'PrefixI 'True) (S1 ('MetaSel ('Just "element") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 a) :*: S1 ('MetaSel ('Just "html") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

Methods

from :: Rendered a -> Rep (Rendered a) x #

to :: Rep (Rendered a) x -> Rendered a #

ToSchema a => ToSchema (Rendered a) Source # 
Instance details

Defined in Docs.TextRevision

Methods

declareNamedSchema :: Proxy (Rendered a) -> Declare (Definitions Schema) NamedSchema

type Rep (Rendered a) Source # 
Instance details

Defined in Docs.TextRevision

type Rep (Rendered a) = D1 ('MetaData "Rendered" "Docs.TextRevision" "backend-0.1.0.0-2H73EnUlGVcEtlIi2XNQz3" 'False) (C1 ('MetaCons "Rendered" 'PrefixI 'True) (S1 ('MetaSel ('Just "element") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 a) :*: S1 ('MetaSel ('Just "html") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

contentsNotChanged :: TextRevision -> NewTextRevision -> Bool Source #

Check if a new revisions contents changed from an existing one.

prettyPrintTextRevisionRef :: TextRevisionRef -> String Source #

Ein Schmackofatz für die Augen