Safe Haskell	None
Language	Haskell2010

Servant.Seo.Sitemap

Contents

Sitemap

Synopsis

data SitemapInfo = SitemapInfo {
- _sitemapInfoEntries :: [SitemapEntry]
- _sitemapInfoPresent :: Maybe ()
}
data SitemapEntry = SitemapEntry {
- _sitemapPathPieces :: [PathPiece]
- _sitemapQueryParts :: [(ParamName, [ParamValue])]
- _sitemapFrequency :: Maybe Period
- _sitemapPriority :: Maybe Text
}
newtype ParamName = ParamName Text
newtype ParamValue = ParamValue Text
data PathPiece
- = UrlPathPiece Text
- | CaptureValues [Text]
isEmpty :: PathPiece -> Bool
class ToHttpApiData a => ToSitemapParamPart a where
- getParamsForIndexing :: MonadIO m => Proxy a -> app -> m [a]
- toParamPart :: MonadIO m => Proxy a -> env -> m [ParamValue]
class ToHttpApiData a => ToSitemapPathPiece a where
- getPathPiecesForIndexing :: MonadIO m => Proxy a -> app -> m [a]
- toPathPiece :: MonadIO m => Proxy a -> env -> m PathPiece
sitemapInfoPresent :: Lens' SitemapInfo (Maybe ())
sitemapInfoEntries :: Lens' SitemapInfo [SitemapEntry]
sitemapQueryParts :: Lens' SitemapEntry [(ParamName, [ParamValue])]
sitemapPriority :: Lens' SitemapEntry (Maybe Text)
sitemapPathPieces :: Lens' SitemapEntry [PathPiece]
sitemapFrequency :: Lens' SitemapEntry (Maybe Period)
class HasSitemap a where
- toSitemapInfo :: MonadIO m => Proxy a -> m SitemapInfo
- toSitemapInfoWith :: MonadIO m => env -> Proxy a -> m SitemapInfo
data SitemapUrl = SitemapUrl {
- _sitemapUrlLoc :: [SitemapLoc]
- _sitemapUrlFrequency :: Maybe Period
- _sitemapUrlPriority :: Maybe Text
}
newtype SitemapLoc = SitemapLoc Text
newtype ServerUrl = ServerUrl Text
type SitemapIndex = (Int, [SitemapUrl])
newtype SitemapIx = SitemapIx Int
sitemapUrlPriority :: Lens' SitemapUrl (Maybe Text)
sitemapUrlLoc :: Lens' SitemapUrl [SitemapLoc]
sitemapUrlFrequency :: Lens' SitemapUrl (Maybe Period)
sitemapEntryToUrlList :: ServerUrl -> SitemapEntry -> SitemapUrl
sitemapUrlToNodes :: SitemapUrl -> [Node]
mkNode :: Name -> [Node] -> Node
mkNodeWithContent :: Name -> Text -> Node
mkUrlNode :: Name -> [Node] -> SitemapLoc -> Node
sitemapIndexUrlToNodes :: SitemapUrl -> [Node]
sitemapUrlsToDocument :: ServerUrl -> [SitemapUrl] -> Document
sitemapIndexToDocument :: ServerUrl -> [SitemapUrl] -> Document
sitemapUrlsToRootLBS :: ServerUrl -> [SitemapUrl] -> ByteString
sitemapUrlsToSitemapMap :: ServerUrl -> [SitemapUrl] -> Map Int ByteString
renderSitemapWith :: (ServerUrl -> [SitemapUrl] -> Document) -> ServerUrl -> [SitemapUrl] -> ByteString

Sitemap

SitemapInfo

data SitemapInfo Source #

Intermediate structure representing sitemap.xml file. During compilation API analysis performed. All HTML pages with Get verb would be populated into SitemapInfo and then updated to list of URLs, unless Disallow happened in the path to page. It consists of list of API branches and internal flag.

Constructors

SitemapInfo
Fields _sitemapInfoEntries :: [SitemapEntry] _sitemapInfoPresent :: Maybe ()

Instances

Eq SitemapInfo Source #
Instance details Defined in Servant.Seo.Sitemap Methods (==) :: SitemapInfo -> SitemapInfo -> Bool # (/=) :: SitemapInfo -> SitemapInfo -> Bool #
Ord SitemapInfo Source #
Instance details Defined in Servant.Seo.Sitemap Methods compare :: SitemapInfo -> SitemapInfo -> Ordering # (<) :: SitemapInfo -> SitemapInfo -> Bool # (<=) :: SitemapInfo -> SitemapInfo -> Bool # (>) :: SitemapInfo -> SitemapInfo -> Bool # (>=) :: SitemapInfo -> SitemapInfo -> Bool # max :: SitemapInfo -> SitemapInfo -> SitemapInfo # min :: SitemapInfo -> SitemapInfo -> SitemapInfo #
Show SitemapInfo Source #
Instance details Defined in Servant.Seo.Sitemap Methods showsPrec :: Int -> SitemapInfo -> ShowS # show :: SitemapInfo -> String # showList :: [SitemapInfo] -> ShowS #
Generic SitemapInfo Source #
Instance details Defined in Servant.Seo.Sitemap Associated Types type Rep SitemapInfo :: Type -> Type # Methods from :: SitemapInfo -> Rep SitemapInfo x # to :: Rep SitemapInfo x -> SitemapInfo #
Semigroup SitemapInfo Source #
Instance details Defined in Servant.Seo.Sitemap Methods (<>) :: SitemapInfo -> SitemapInfo -> SitemapInfo # sconcat :: NonEmpty SitemapInfo -> SitemapInfo # stimes :: Integral b => b -> SitemapInfo -> SitemapInfo #
Monoid SitemapInfo Source #
Instance details Defined in Servant.Seo.Sitemap Methods mempty :: SitemapInfo # mappend :: SitemapInfo -> SitemapInfo -> SitemapInfo # mconcat :: [SitemapInfo] -> SitemapInfo #
type Rep SitemapInfo Source #
Instance details Defined in Servant.Seo.Sitemap type Rep SitemapInfo = D1 (MetaData "SitemapInfo" "Servant.Seo.Sitemap" "servant-seo-0.1.2-inplace" False) (C1 (MetaCons "SitemapInfo" PrefixI True) (S1 (MetaSel (Just "_sitemapInfoEntries") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [SitemapEntry]) :*: S1 (MetaSel (Just "_sitemapInfoPresent") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe ()))))

data SitemapEntry Source #

Represents single API branch. Could contain multiple values based on user decision. See ToSitemapParamPart or ToSitemapPathPiece for more details. Also contain optional Frequency and Priority.

Constructors

SitemapEntry
Fields _sitemapPathPieces :: [PathPiece] _sitemapQueryParts :: [(ParamName, [ParamValue])] _sitemapFrequency :: Maybe Period _sitemapPriority :: Maybe Text

Instances

Eq SitemapEntry Source #
Instance details Defined in Servant.Seo.Sitemap Methods (==) :: SitemapEntry -> SitemapEntry -> Bool # (/=) :: SitemapEntry -> SitemapEntry -> Bool #
Ord SitemapEntry Source #
Instance details Defined in Servant.Seo.Sitemap Methods compare :: SitemapEntry -> SitemapEntry -> Ordering # (<) :: SitemapEntry -> SitemapEntry -> Bool # (<=) :: SitemapEntry -> SitemapEntry -> Bool # (>) :: SitemapEntry -> SitemapEntry -> Bool # (>=) :: SitemapEntry -> SitemapEntry -> Bool # max :: SitemapEntry -> SitemapEntry -> SitemapEntry # min :: SitemapEntry -> SitemapEntry -> SitemapEntry #
Show SitemapEntry Source #
Instance details Defined in Servant.Seo.Sitemap Methods showsPrec :: Int -> SitemapEntry -> ShowS # show :: SitemapEntry -> String # showList :: [SitemapEntry] -> ShowS #
Generic SitemapEntry Source #
Instance details Defined in Servant.Seo.Sitemap Associated Types type Rep SitemapEntry :: Type -> Type # Methods from :: SitemapEntry -> Rep SitemapEntry x # to :: Rep SitemapEntry x -> SitemapEntry #
Semigroup SitemapEntry Source #
Instance details Defined in Servant.Seo.Sitemap Methods (<>) :: SitemapEntry -> SitemapEntry -> SitemapEntry # sconcat :: NonEmpty SitemapEntry -> SitemapEntry # stimes :: Integral b => b -> SitemapEntry -> SitemapEntry #
Monoid SitemapEntry Source #
Instance details Defined in Servant.Seo.Sitemap Methods mempty :: SitemapEntry # mappend :: SitemapEntry -> SitemapEntry -> SitemapEntry # mconcat :: [SitemapEntry] -> SitemapEntry #
type Rep SitemapEntry Source #
Instance details Defined in Servant.Seo.Sitemap type Rep SitemapEntry = D1 (MetaData "SitemapEntry" "Servant.Seo.Sitemap" "servant-seo-0.1.2-inplace" False) (C1 (MetaCons "SitemapEntry" PrefixI True) ((S1 (MetaSel (Just "_sitemapPathPieces") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [PathPiece]) :: S1 (MetaSel (Just "_sitemapQueryParts") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [(ParamName, [ParamValue])])) :: (S1 (MetaSel (Just "_sitemapFrequency") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Period)) :*: S1 (MetaSel (Just "_sitemapPriority") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Text)))))

newtype ParamName Source #

Constructors

ParamName Text

Instances

Eq ParamName Source #
Instance details Defined in Servant.Seo.Sitemap Methods (==) :: ParamName -> ParamName -> Bool # (/=) :: ParamName -> ParamName -> Bool #
Ord ParamName Source #
Instance details Defined in Servant.Seo.Sitemap Methods compare :: ParamName -> ParamName -> Ordering # (<) :: ParamName -> ParamName -> Bool # (<=) :: ParamName -> ParamName -> Bool # (>) :: ParamName -> ParamName -> Bool # (>=) :: ParamName -> ParamName -> Bool # max :: ParamName -> ParamName -> ParamName # min :: ParamName -> ParamName -> ParamName #
Show ParamName Source #
Instance details Defined in Servant.Seo.Sitemap Methods showsPrec :: Int -> ParamName -> ShowS # show :: ParamName -> String # showList :: [ParamName] -> ShowS #
Generic ParamName Source #
Instance details Defined in Servant.Seo.Sitemap Associated Types type Rep ParamName :: Type -> Type # Methods from :: ParamName -> Rep ParamName x # to :: Rep ParamName x -> ParamName #
ToHttpApiData ParamName Source #
Instance details Defined in Servant.Seo.Sitemap Methods toUrlPiece :: ParamName -> Text toEncodedUrlPiece :: ParamName -> Builder toHeader :: ParamName -> ByteString toQueryParam :: ParamName -> Text
ToMarkup ParamName Source #
Instance details Defined in Servant.Seo.Sitemap Methods toMarkup :: ParamName -> Markup preEscapedToMarkup :: ParamName -> Markup
type Rep ParamName Source #
Instance details Defined in Servant.Seo.Sitemap type Rep ParamName = D1 (MetaData "ParamName" "Servant.Seo.Sitemap" "servant-seo-0.1.2-inplace" True) (C1 (MetaCons "ParamName" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text)))

newtype ParamValue Source #

Constructors

ParamValue Text

Instances

Eq ParamValue Source #
Instance details Defined in Servant.Seo.Sitemap Methods (==) :: ParamValue -> ParamValue -> Bool # (/=) :: ParamValue -> ParamValue -> Bool #
Ord ParamValue Source #
Instance details Defined in Servant.Seo.Sitemap Methods compare :: ParamValue -> ParamValue -> Ordering # (<) :: ParamValue -> ParamValue -> Bool # (<=) :: ParamValue -> ParamValue -> Bool # (>) :: ParamValue -> ParamValue -> Bool # (>=) :: ParamValue -> ParamValue -> Bool # max :: ParamValue -> ParamValue -> ParamValue # min :: ParamValue -> ParamValue -> ParamValue #
Show ParamValue Source #
Instance details Defined in Servant.Seo.Sitemap Methods showsPrec :: Int -> ParamValue -> ShowS # show :: ParamValue -> String # showList :: [ParamValue] -> ShowS #
Generic ParamValue Source #
Instance details Defined in Servant.Seo.Sitemap Associated Types type Rep ParamValue :: Type -> Type # Methods from :: ParamValue -> Rep ParamValue x # to :: Rep ParamValue x -> ParamValue #
ToHttpApiData ParamValue Source #
Instance details Defined in Servant.Seo.Sitemap Methods toUrlPiece :: ParamValue -> Text toEncodedUrlPiece :: ParamValue -> Builder toHeader :: ParamValue -> ByteString toQueryParam :: ParamValue -> Text
ToMarkup ParamValue Source #
Instance details Defined in Servant.Seo.Sitemap Methods toMarkup :: ParamValue -> Markup preEscapedToMarkup :: ParamValue -> Markup
type Rep ParamValue Source #
Instance details Defined in Servant.Seo.Sitemap type Rep ParamValue = D1 (MetaData "ParamValue" "Servant.Seo.Sitemap" "servant-seo-0.1.2-inplace" True) (C1 (MetaCons "ParamValue" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text)))

data PathPiece Source #

Could be either path piece obtained from path :: Symbol or list of possible captured values provided by user.

Constructors

UrlPathPiece Text
CaptureValues [Text]

Instances

Eq PathPiece Source #
Instance details Defined in Servant.Seo.Sitemap Methods (==) :: PathPiece -> PathPiece -> Bool # (/=) :: PathPiece -> PathPiece -> Bool #
Ord PathPiece Source #
Instance details Defined in Servant.Seo.Sitemap Methods compare :: PathPiece -> PathPiece -> Ordering # (<) :: PathPiece -> PathPiece -> Bool # (<=) :: PathPiece -> PathPiece -> Bool # (>) :: PathPiece -> PathPiece -> Bool # (>=) :: PathPiece -> PathPiece -> Bool # max :: PathPiece -> PathPiece -> PathPiece # min :: PathPiece -> PathPiece -> PathPiece #
Show PathPiece Source #
Instance details Defined in Servant.Seo.Sitemap Methods showsPrec :: Int -> PathPiece -> ShowS # show :: PathPiece -> String # showList :: [PathPiece] -> ShowS #
Generic PathPiece Source #
Instance details Defined in Servant.Seo.Sitemap Associated Types type Rep PathPiece :: Type -> Type # Methods from :: PathPiece -> Rep PathPiece x # to :: Rep PathPiece x -> PathPiece #
type Rep PathPiece Source #
Instance details Defined in Servant.Seo.Sitemap type Rep PathPiece = D1 (MetaData "PathPiece" "Servant.Seo.Sitemap" "servant-seo-0.1.2-inplace" False) (C1 (MetaCons "UrlPathPiece" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text)) :+: C1 (MetaCons "CaptureValues" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [Text])))

isEmpty :: PathPiece -> Bool Source #

Checks that path piece is contained.

User dependent decisions for sitemap.

class ToHttpApiData a => ToSitemapParamPart a where Source #

How to get all possible values that should (or should not) be the parts of sitemap from query parameter values.

Example (in combination with Get '[HTML] will produce sitemap URLs):

>>> newtype ArticleId = ArticleId Int deriving newtype (Show, Eq, Enum, Ord, Num, ToHttpApiData)
>>> instance ToSitemapParamPart ArticleId where getParamsForIndexing _ _ = pure [0..100500]

Another example (params that have no affect on sitemap):

>>> newtype SortBy = SortBy Text deriving newtype (Show, Eq, ToHttpApiData)
>>> instance ToSitemapParamPart SortBy where getParamsForIndexing _ _ = pure mempty

Minimal complete definition

Nothing

Methods

getParamsForIndexing :: MonadIO m => Proxy a -> app -> m [a] Source #

Should be provided by user.

toParamPart :: MonadIO m => Proxy a -> env -> m [ParamValue] Source #

class ToHttpApiData a => ToSitemapPathPiece a where Source #

How to get all possible captured values that should (or should not) be the parts of sitemap.

Example (in combination with Get '[HTML] will produce sitemap URLs):

>>> newtype UserId = UserId Int deriving newtype (Show, Eq, Enum, Ord, Num, ToHttpApiData)
>>> instance ToSitemapPathPiece UserId where getPathPiecesForIndexing _ _ = pure [1..200000]

Another example (captured values that have no affect on sitemap):

>>> newtype Username = Username Text deriving newtype (Show, Eq, ToHttpApiData)
>>> instance ToSitemapPathPiece Username where getPathPiecesForIndexing _ _ = pure mempty

Minimal complete definition

Nothing

Methods

getPathPiecesForIndexing :: MonadIO m => Proxy a -> app -> m [a] Source #

Should be provided by user.

toPathPiece :: MonadIO m => Proxy a -> env -> m PathPiece Source #

Instances

ToSitemapPathPiece SitemapIx Source #
Instance details Defined in Servant.Seo.Sitemap Methods getPathPiecesForIndexing :: MonadIO m => Proxy SitemapIx -> app -> m [SitemapIx] Source # toPathPiece :: MonadIO m => Proxy SitemapIx -> env -> m PathPiece Source #

sitemapInfoPresent :: Lens' SitemapInfo (Maybe ()) Source #

sitemapInfoEntries :: Lens' SitemapInfo [SitemapEntry] Source #

sitemapQueryParts :: Lens' SitemapEntry [(ParamName, [ParamValue])] Source #

sitemapPriority :: Lens' SitemapEntry (Maybe Text) Source #

sitemapPathPieces :: Lens' SitemapEntry [PathPiece] Source #

sitemapFrequency :: Lens' SitemapEntry (Maybe Period) Source #

Transforming API to `SitemapInfo`

class HasSitemap a where Source #

Servant API extension. It describes how to build SitemapInfo representation from servant API. There are plenty of types that add nothing to it.

WARNING: Do not derive this using DeriveAnyClass as the generated instance will loop indefinitely.

Minimal complete definition

toSitemapInfo | toSitemapInfoWith

Methods

toSitemapInfo :: MonadIO m => Proxy a -> m SitemapInfo Source #

toSitemapInfoWith :: MonadIO m => env -> Proxy a -> m SitemapInfo Source #

Instances

HasSitemap EmptyAPI Source #
Instance details Defined in Servant.Seo.Sitemap Methods toSitemapInfo :: MonadIO m => Proxy EmptyAPI -> m SitemapInfo Source # toSitemapInfoWith :: MonadIO m => env -> Proxy EmptyAPI -> m SitemapInfo Source #
HasSitemap Raw Source #
Instance details Defined in Servant.Seo.Sitemap Methods toSitemapInfo :: MonadIO m => Proxy Raw -> m SitemapInfo Source # toSitemapInfoWith :: MonadIO m => env -> Proxy Raw -> m SitemapInfo Source #
(HasSitemap a, HasSitemap b) => HasSitemap (a :<\|> b :: Type) Source #	Collect multiple API branches together.
Instance details Defined in Servant.Seo.Sitemap Methods toSitemapInfo :: MonadIO m => Proxy (a :<\|> b) -> m SitemapInfo Source # toSitemapInfoWith :: MonadIO m => env -> Proxy (a :<\|> b) -> m SitemapInfo Source #
ToMarkup a => HasSitemap (Get (HTML ': ([] :: [Type])) a :: Type) Source #	`Get '[HTML]` enables sitemap for particular API branch.
Instance details Defined in Servant.Seo.Sitemap Methods toSitemapInfo :: MonadIO m => Proxy (Get (HTML ': []) a) -> m SitemapInfo Source # toSitemapInfoWith :: MonadIO m => env -> Proxy (Get (HTML ': []) a) -> m SitemapInfo Source #
ToMarkup a => HasSitemap (Get (HTML ': ([] :: [Type])) (Headers headers a) :: Type) Source #
Instance details Defined in Servant.Seo.Sitemap Methods toSitemapInfo :: MonadIO m => Proxy (Get (HTML ': []) (Headers headers a)) -> m SitemapInfo Source # toSitemapInfoWith :: MonadIO m => env -> Proxy (Get (HTML ': []) (Headers headers a)) -> m SitemapInfo Source #
HasSitemap sub => HasSitemap (HttpVersion :> sub :: Type) Source #
Instance details Defined in Servant.Seo.Sitemap Methods toSitemapInfo :: MonadIO m => Proxy (HttpVersion :> sub) -> m SitemapInfo Source # toSitemapInfoWith :: MonadIO m => env -> Proxy (HttpVersion :> sub) -> m SitemapInfo Source #
(HasSitemap sub, ToSitemapPathPiece a) => HasSitemap (Capture' mods sym a :> sub :: Type) Source #	Extract all possible values under `Capture'` and append them if sitemap is present for this particular branch.
Instance details Defined in Servant.Seo.Sitemap Methods toSitemapInfo :: MonadIO m => Proxy (Capture' mods sym a :> sub) -> m SitemapInfo Source # toSitemapInfoWith :: MonadIO m => env -> Proxy (Capture' mods sym a :> sub) -> m SitemapInfo Source #
HasSitemap sub => HasSitemap (CaptureAll sym a :> sub :: Type) Source #
Instance details Defined in Servant.Seo.Sitemap Methods toSitemapInfo :: MonadIO m => Proxy (CaptureAll sym a :> sub) -> m SitemapInfo Source # toSitemapInfoWith :: MonadIO m => env -> Proxy (CaptureAll sym a :> sub) -> m SitemapInfo Source #
HasSitemap api => HasSitemap (Description desc :> api :: Type) Source #
Instance details Defined in Servant.Seo.Sitemap Methods toSitemapInfo :: MonadIO m => Proxy (Description desc :> api) -> m SitemapInfo Source # toSitemapInfoWith :: MonadIO m => env -> Proxy (Description desc :> api) -> m SitemapInfo Source #
HasSitemap api => HasSitemap (Summary desc :> api :: Type) Source #
Instance details Defined in Servant.Seo.Sitemap Methods toSitemapInfo :: MonadIO m => Proxy (Summary desc :> api) -> m SitemapInfo Source # toSitemapInfoWith :: MonadIO m => env -> Proxy (Summary desc :> api) -> m SitemapInfo Source #
HasSitemap sub => HasSitemap (Header' mods sym a :> sub :: Type) Source #
Instance details Defined in Servant.Seo.Sitemap Methods toSitemapInfo :: MonadIO m => Proxy (Header' mods sym a :> sub) -> m SitemapInfo Source # toSitemapInfoWith :: MonadIO m => env -> Proxy (Header' mods sym a :> sub) -> m SitemapInfo Source #
HasSitemap sub => HasSitemap (IsSecure :> sub :: Type) Source #
Instance details Defined in Servant.Seo.Sitemap Methods toSitemapInfo :: MonadIO m => Proxy (IsSecure :> sub) -> m SitemapInfo Source # toSitemapInfoWith :: MonadIO m => env -> Proxy (IsSecure :> sub) -> m SitemapInfo Source #
HasSitemap sub => HasSitemap (QueryFlag sym :> sub :: Type) Source #
Instance details Defined in Servant.Seo.Sitemap Methods toSitemapInfo :: MonadIO m => Proxy (QueryFlag sym :> sub) -> m SitemapInfo Source # toSitemapInfoWith :: MonadIO m => env -> Proxy (QueryFlag sym :> sub) -> m SitemapInfo Source #
(ToSitemapParamPart a, HasSitemap sub, KnownSymbol sym) => HasSitemap (QueryParam' mods sym a :> sub :: Type) Source #	Extract all possible values under `QueryParam'` and append them if sitemap is present for this particular branch.
Instance details Defined in Servant.Seo.Sitemap Methods toSitemapInfo :: MonadIO m => Proxy (QueryParam' mods sym a :> sub) -> m SitemapInfo Source # toSitemapInfoWith :: MonadIO m => env -> Proxy (QueryParam' mods sym a :> sub) -> m SitemapInfo Source #
HasSitemap sub => HasSitemap (RemoteHost :> sub :: Type) Source #
Instance details Defined in Servant.Seo.Sitemap Methods toSitemapInfo :: MonadIO m => Proxy (RemoteHost :> sub) -> m SitemapInfo Source # toSitemapInfoWith :: MonadIO m => env -> Proxy (RemoteHost :> sub) -> m SitemapInfo Source #
HasSitemap sub => HasSitemap (ReqBody' mods cs a :> sub :: Type) Source #
Instance details Defined in Servant.Seo.Sitemap Methods toSitemapInfo :: MonadIO m => Proxy (ReqBody' mods cs a :> sub) -> m SitemapInfo Source # toSitemapInfoWith :: MonadIO m => env -> Proxy (ReqBody' mods cs a :> sub) -> m SitemapInfo Source #
HasSitemap sub => HasSitemap (StreamBody' mods fr ct a :> sub :: Type) Source #
Instance details Defined in Servant.Seo.Sitemap Methods toSitemapInfo :: MonadIO m => Proxy (StreamBody' mods fr ct a :> sub) -> m SitemapInfo Source # toSitemapInfoWith :: MonadIO m => env -> Proxy (StreamBody' mods fr ct a :> sub) -> m SitemapInfo Source #
HasSitemap sub => HasSitemap (Vault :> sub :: Type) Source #
Instance details Defined in Servant.Seo.Sitemap Methods toSitemapInfo :: MonadIO m => Proxy (Vault :> sub) -> m SitemapInfo Source # toSitemapInfoWith :: MonadIO m => env -> Proxy (Vault :> sub) -> m SitemapInfo Source #
(KnownNat n, KnownNat m, HasSitemap api) => HasSitemap (Priority ((,) n m) :> api :: Type) Source #	Extracts `Priority` from API branch.
Instance details Defined in Servant.Seo.Sitemap Methods toSitemapInfo :: MonadIO m0 => Proxy (Priority (n, m) :> api) -> m0 SitemapInfo Source # toSitemapInfoWith :: MonadIO m0 => env -> Proxy (Priority (n, m) :> api) -> m0 SitemapInfo Source #
(HasPeriod period, HasSitemap api) => HasSitemap (Frequency period :> api :: Type) Source #	Extracts `Frequency` from API branch.
Instance details Defined in Servant.Seo.Sitemap Methods toSitemapInfo :: MonadIO m => Proxy (Frequency period :> api) -> m SitemapInfo Source # toSitemapInfoWith :: MonadIO m => env -> Proxy (Frequency period :> api) -> m SitemapInfo Source #
(HasSitemap sub, KnownSymbol sym) => HasSitemap (Disallow sym :> sub :: Type) Source #	`Disallow` combinator invalidates sitemap for particular API branch.
Instance details Defined in Servant.Seo.Sitemap Methods toSitemapInfo :: MonadIO m => Proxy (Disallow sym :> sub) -> m SitemapInfo Source # toSitemapInfoWith :: MonadIO m => env -> Proxy (Disallow sym :> sub) -> m SitemapInfo Source #
(HasSitemap sub, KnownSymbol sym) => HasSitemap (sym :> sub :: Type) Source #
Instance details Defined in Servant.Seo.Sitemap Methods toSitemapInfo :: MonadIO m => Proxy (sym :> sub) -> m SitemapInfo Source # toSitemapInfoWith :: MonadIO m => env -> Proxy (sym :> sub) -> m SitemapInfo Source #
HasSitemap sub => HasSitemap (WithNamedContext x c sub :: Type) Source #
Instance details Defined in Servant.Seo.Sitemap Methods toSitemapInfo :: MonadIO m => Proxy (WithNamedContext x c sub) -> m SitemapInfo Source # toSitemapInfoWith :: MonadIO m => env -> Proxy (WithNamedContext x c sub) -> m SitemapInfo Source #
KnownNat status => HasSitemap (Verb method status cs a :: Type) Source #
Instance details Defined in Servant.Seo.Sitemap Methods toSitemapInfo :: MonadIO m => Proxy (Verb method status cs a) -> m SitemapInfo Source # toSitemapInfoWith :: MonadIO m => env -> Proxy (Verb method status cs a) -> m SitemapInfo Source #

Rendering

data SitemapUrl Source #

Populated during SitemapInfo processing. SitemapUrl would be rendered in XML node in runtime.

Example: <url><loc>https://example.com/some/url</loc>.

Constructors

SitemapUrl
Fields _sitemapUrlLoc :: [SitemapLoc] _sitemapUrlFrequency :: Maybe Period _sitemapUrlPriority :: Maybe Text

Instances

Eq SitemapUrl Source #
Instance details Defined in Servant.Seo.Sitemap Methods (==) :: SitemapUrl -> SitemapUrl -> Bool # (/=) :: SitemapUrl -> SitemapUrl -> Bool #
Ord SitemapUrl Source #
Instance details Defined in Servant.Seo.Sitemap Methods compare :: SitemapUrl -> SitemapUrl -> Ordering # (<) :: SitemapUrl -> SitemapUrl -> Bool # (<=) :: SitemapUrl -> SitemapUrl -> Bool # (>) :: SitemapUrl -> SitemapUrl -> Bool # (>=) :: SitemapUrl -> SitemapUrl -> Bool # max :: SitemapUrl -> SitemapUrl -> SitemapUrl # min :: SitemapUrl -> SitemapUrl -> SitemapUrl #
Show SitemapUrl Source #
Instance details Defined in Servant.Seo.Sitemap Methods showsPrec :: Int -> SitemapUrl -> ShowS # show :: SitemapUrl -> String # showList :: [SitemapUrl] -> ShowS #
Generic SitemapUrl Source #
Instance details Defined in Servant.Seo.Sitemap Associated Types type Rep SitemapUrl :: Type -> Type # Methods from :: SitemapUrl -> Rep SitemapUrl x # to :: Rep SitemapUrl x -> SitemapUrl #
type Rep SitemapUrl Source #
Instance details Defined in Servant.Seo.Sitemap type Rep SitemapUrl = D1 (MetaData "SitemapUrl" "Servant.Seo.Sitemap" "servant-seo-0.1.2-inplace" False) (C1 (MetaCons "SitemapUrl" PrefixI True) (S1 (MetaSel (Just "_sitemapUrlLoc") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [SitemapLoc]) :: (S1 (MetaSel (Just "_sitemapUrlFrequency") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Period)) :: S1 (MetaSel (Just "_sitemapUrlPriority") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Text)))))

newtype SitemapLoc Source #

Represents single URL listed in sitemap.xml.

Constructors

SitemapLoc Text

Instances

Eq SitemapLoc Source #
Instance details Defined in Servant.Seo.Sitemap Methods (==) :: SitemapLoc -> SitemapLoc -> Bool # (/=) :: SitemapLoc -> SitemapLoc -> Bool #
Ord SitemapLoc Source #
Instance details Defined in Servant.Seo.Sitemap Methods compare :: SitemapLoc -> SitemapLoc -> Ordering # (<) :: SitemapLoc -> SitemapLoc -> Bool # (<=) :: SitemapLoc -> SitemapLoc -> Bool # (>) :: SitemapLoc -> SitemapLoc -> Bool # (>=) :: SitemapLoc -> SitemapLoc -> Bool # max :: SitemapLoc -> SitemapLoc -> SitemapLoc # min :: SitemapLoc -> SitemapLoc -> SitemapLoc #
Show SitemapLoc Source #
Instance details Defined in Servant.Seo.Sitemap Methods showsPrec :: Int -> SitemapLoc -> ShowS # show :: SitemapLoc -> String # showList :: [SitemapLoc] -> ShowS #
Generic SitemapLoc Source #
Instance details Defined in Servant.Seo.Sitemap Associated Types type Rep SitemapLoc :: Type -> Type # Methods from :: SitemapLoc -> Rep SitemapLoc x # to :: Rep SitemapLoc x -> SitemapLoc #
ToMarkup SitemapLoc Source #
Instance details Defined in Servant.Seo.Sitemap Methods toMarkup :: SitemapLoc -> Markup preEscapedToMarkup :: SitemapLoc -> Markup
type Rep SitemapLoc Source #
Instance details Defined in Servant.Seo.Sitemap type Rep SitemapLoc = D1 (MetaData "SitemapLoc" "Servant.Seo.Sitemap" "servant-seo-0.1.2-inplace" True) (C1 (MetaCons "SitemapLoc" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text)))

newtype ServerUrl Source #

Server prefix without trailing slash.

Constructors

ServerUrl Text

Instances

Eq ServerUrl Source #
Instance details Defined in Servant.Seo.Sitemap Methods (==) :: ServerUrl -> ServerUrl -> Bool # (/=) :: ServerUrl -> ServerUrl -> Bool #
Ord ServerUrl Source #
Instance details Defined in Servant.Seo.Sitemap Methods compare :: ServerUrl -> ServerUrl -> Ordering # (<) :: ServerUrl -> ServerUrl -> Bool # (<=) :: ServerUrl -> ServerUrl -> Bool # (>) :: ServerUrl -> ServerUrl -> Bool # (>=) :: ServerUrl -> ServerUrl -> Bool # max :: ServerUrl -> ServerUrl -> ServerUrl # min :: ServerUrl -> ServerUrl -> ServerUrl #
Show ServerUrl Source #
Instance details Defined in Servant.Seo.Sitemap Methods showsPrec :: Int -> ServerUrl -> ShowS # show :: ServerUrl -> String # showList :: [ServerUrl] -> ShowS #
IsString ServerUrl Source #
Instance details Defined in Servant.Seo.Sitemap Methods fromString :: String -> ServerUrl #
Generic ServerUrl Source #
Instance details Defined in Servant.Seo.Sitemap Associated Types type Rep ServerUrl :: Type -> Type # Methods from :: ServerUrl -> Rep ServerUrl x # to :: Rep ServerUrl x -> ServerUrl #
ToMarkup ServerUrl Source #
Instance details Defined in Servant.Seo.Sitemap Methods toMarkup :: ServerUrl -> Markup preEscapedToMarkup :: ServerUrl -> Markup
type Rep ServerUrl Source #
Instance details Defined in Servant.Seo.Sitemap type Rep ServerUrl = D1 (MetaData "ServerUrl" "Servant.Seo.Sitemap" "servant-seo-0.1.2-inplace" True) (C1 (MetaCons "ServerUrl" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text)))

type SitemapIndex = (Int, [SitemapUrl]) Source #

If sitemap consists of more than 50000 URLs, it should be indexed.

newtype SitemapIx Source #

Constructors

SitemapIx Int

Instances

Eq SitemapIx Source #
Instance details Defined in Servant.Seo.Sitemap Methods (==) :: SitemapIx -> SitemapIx -> Bool # (/=) :: SitemapIx -> SitemapIx -> Bool #
Ord SitemapIx Source #
Instance details Defined in Servant.Seo.Sitemap Methods compare :: SitemapIx -> SitemapIx -> Ordering # (<) :: SitemapIx -> SitemapIx -> Bool # (<=) :: SitemapIx -> SitemapIx -> Bool # (>) :: SitemapIx -> SitemapIx -> Bool # (>=) :: SitemapIx -> SitemapIx -> Bool # max :: SitemapIx -> SitemapIx -> SitemapIx # min :: SitemapIx -> SitemapIx -> SitemapIx #
Show SitemapIx Source #
Instance details Defined in Servant.Seo.Sitemap Methods showsPrec :: Int -> SitemapIx -> ShowS # show :: SitemapIx -> String # showList :: [SitemapIx] -> ShowS #
Generic SitemapIx Source #
Instance details Defined in Servant.Seo.Sitemap Associated Types type Rep SitemapIx :: Type -> Type # Methods from :: SitemapIx -> Rep SitemapIx x # to :: Rep SitemapIx x -> SitemapIx #
FromHttpApiData SitemapIx Source #
Instance details Defined in Servant.Seo.Sitemap Methods parseUrlPiece :: Text -> Either Text SitemapIx parseHeader :: ByteString -> Either Text SitemapIx parseQueryParam :: Text -> Either Text SitemapIx
ToHttpApiData SitemapIx Source #
Instance details Defined in Servant.Seo.Sitemap Methods toUrlPiece :: SitemapIx -> Text toEncodedUrlPiece :: SitemapIx -> Builder toHeader :: SitemapIx -> ByteString toQueryParam :: SitemapIx -> Text
ToSitemapPathPiece SitemapIx Source #
Instance details Defined in Servant.Seo.Sitemap Methods getPathPiecesForIndexing :: MonadIO m => Proxy SitemapIx -> app -> m [SitemapIx] Source # toPathPiece :: MonadIO m => Proxy SitemapIx -> env -> m PathPiece Source #
type Rep SitemapIx Source #
Instance details Defined in Servant.Seo.Sitemap type Rep SitemapIx = D1 (MetaData "SitemapIx" "Servant.Seo.Sitemap" "servant-seo-0.1.2-inplace" True) (C1 (MetaCons "SitemapIx" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Int)))

sitemapUrlPriority :: Lens' SitemapUrl (Maybe Text) Source #

sitemapUrlLoc :: Lens' SitemapUrl [SitemapLoc] Source #

sitemapUrlFrequency :: Lens' SitemapUrl (Maybe Period) Source #

sitemapEntryToUrlList :: ServerUrl -> SitemapEntry -> SitemapUrl Source #

Transform single sitemap entry to list of URLs.

sitemapUrlToNodes :: SitemapUrl -> [Node] Source #

Transform list of URLs to list of XML nodes.

mkNode :: Name -> [Node] -> Node Source #

Several XML rendering helpers.

mkNodeWithContent :: Name -> Text -> Node Source #

mkUrlNode :: Name -> [Node] -> SitemapLoc -> Node Source #

sitemapIndexUrlToNodes :: SitemapUrl -> [Node] Source #

Transform list of URLs to sitemap index XML nodes.

sitemapUrlsToDocument :: ServerUrl -> [SitemapUrl] -> Document Source #

Transform bunch of list of URLs to XML document.

sitemapIndexToDocument :: ServerUrl -> [SitemapUrl] -> Document Source #

Transform list of sitemap index URLs to XML document.

sitemapUrlsToRootLBS :: ServerUrl -> [SitemapUrl] -> ByteString Source #

sitemapUrlsToSitemapMap :: ServerUrl -> [SitemapUrl] -> Map Int ByteString Source #

renderSitemapWith :: (ServerUrl -> [SitemapUrl] -> Document) -> ServerUrl -> [SitemapUrl] -> ByteString Source #

>>> :set -XDerivingStrategies -XGeneralizedNewtypeDeriving
>>>

Sitemap

SitemapInfo

User dependent decisions for sitemap.

Transforming API to SitemapInfo

Rendering

Transforming API to `SitemapInfo`