Servant.Seo.Combinators

XML

data XML

Content-Type representing text/xml. Used for serving /sitemap.xml.

Instances

Accept XML

text/xml

Defined in Servant.Seo.Combinators

Methods

contentType :: Proxy XML -> MediaType

contentTypes :: Proxy XML -> NonEmpty MediaType

MimeRender XML ByteString

id

Defined in Servant.Seo.Combinators

Methods

mimeRender :: Proxy XML -> ByteString -> ByteString

MimeRender XML ByteString

BSL.fromStrict

Defined in Servant.Seo.Combinators

Methods

mimeRender :: Proxy XML -> ByteString -> ByteString0

MimeRender XML Text

BSL.fromStrict . Text.encodeUtf8

Defined in Servant.Seo.Combinators

Methods

mimeRender :: Proxy XML -> Text -> ByteString

Disallow

data Disallow (sym :: Symbol)

Mark path as disallowed for indexing.

Example:

>>> -- GET /admin/crm
>>> type API = Disallow "admin" :> "crm" :> Get '[HTML] CrmPage

Code above will be transformed into Disallow /admin.

Note: Disallow impacts sitemap.xml excluding underlying URLs from resulted sitemap.

Instances

(HasRobots sub, KnownSymbol sym) => HasRobots (Disallow sym :> sub :: Type)

Generate new DisallowedPathPiece from path piece marked as Disallow.

Defined in Servant.Seo.Robots

Methods

toRobots :: Proxy (Disallow sym :> sub) -> RobotsInfo

(HasSitemap sub, KnownSymbol sym) => HasSitemap (Disallow sym :> sub :: Type)

Disallow combinator invalidates sitemap for particular API branch.

Defined in Servant.Seo.Sitemap

Methods

toSitemapInfo :: MonadIO m => Proxy (Disallow sym :> sub) -> m SitemapInfo

toSitemapInfoWith :: MonadIO m => env -> Proxy (Disallow sym :> sub) -> m SitemapInfo

(KnownSymbol sym, HasServer api context) => HasServer (Disallow sym :> api :: Type) context

Disallow does not change specification at all.

Defined in Servant.Seo.Combinators

Associated Types

type ServerT (Disallow sym :> api) m :: Type

Methods

route :: Proxy (Disallow sym :> api) -> Context context -> Delayed env (Server (Disallow sym :> api)) -> Router env

hoistServerWithContext :: Proxy (Disallow sym :> api) -> Proxy context -> (forall x. m x -> n x) -> ServerT (Disallow sym :> api) m -> ServerT (Disallow sym :> api) n

type ServerT (Disallow sym :> api :: Type) m

Defined in Servant.Seo.Combinators

type ServerT (Disallow sym :> api :: Type) m = ServerT (sym :> api) m

Frequency

data Frequency (period :: Period)

Frequency optional parameter for sitemap.xml. Shows to bots how often page will be changed. Used with Period.

>>> type API = Frequency 'Yearly :> "about.php" :> Get '[HTML] AboutPage

Code above will be transformed in corresponding XML: <url><loc>https://example.com/about.php</loc><freq>yearly</freq></url>.

Instances

(HasPeriod period, HasRobots api) => HasRobots (Frequency period :> api :: Type)

Frequency as part of sitemap.xml spec has no impact on robots.txt.

Defined in Servant.Seo.Robots

Methods

toRobots :: Proxy (Frequency period :> api) -> RobotsInfo

(HasPeriod period, HasSitemap api) => HasSitemap (Frequency period :> api :: Type)

Extracts Frequency from API branch.

Defined in Servant.Seo.Sitemap

Methods

toSitemapInfo :: MonadIO m => Proxy (Frequency period :> api) -> m SitemapInfo

toSitemapInfoWith :: MonadIO m => env -> Proxy (Frequency period :> api) -> m SitemapInfo

(HasPeriod period, HasServer api context) => HasServer (Frequency period :> api :: Type) context

Frequency does not change specification at all.

Defined in Servant.Seo.Combinators

Associated Types

type ServerT (Frequency period :> api) m :: Type

Methods

route :: Proxy (Frequency period :> api) -> Context context -> Delayed env (Server (Frequency period :> api)) -> Router env

hoistServerWithContext :: Proxy (Frequency period :> api) -> Proxy context -> (forall x. m x -> n x) -> ServerT (Frequency period :> api) m -> ServerT (Frequency period :> api) n

type ServerT (Frequency period :> api :: Type) m

Defined in Servant.Seo.Combinators

type ServerT (Frequency period :> api :: Type) m = ServerT api m

Period

data Period

Period is a type parameter for Frequency.

Constructors

Never

Yearly

Monthly

Weekly

Daily

Hourly

Always

Instances

Enum Period

Defined in Servant.Seo.Combinators

Methods

succ :: Period -> Period

pred :: Period -> Period

toEnum :: Int -> Period

fromEnum :: Period -> Int

enumFrom :: Period -> [Period]

enumFromThen :: Period -> Period -> [Period]

enumFromTo :: Period -> Period -> [Period]

enumFromThenTo :: Period -> Period -> Period -> [Period]

Eq Period

Defined in Servant.Seo.Combinators

Methods

(==) :: Period -> Period -> Bool

(/=) :: Period -> Period -> Bool

Ord Period

Defined in Servant.Seo.Combinators

Methods

compare :: Period -> Period -> Ordering

(<) :: Period -> Period -> Bool

(<=) :: Period -> Period -> Bool

(>) :: Period -> Period -> Bool

(>=) :: Period -> Period -> Bool

max :: Period -> Period -> Period

min :: Period -> Period -> Period

Show Period

Defined in Servant.Seo.Combinators

Methods

showsPrec :: Int -> Period -> ShowS

show :: Period -> String

showList :: [Period] -> ShowS

Generic Period

Defined in Servant.Seo.Combinators

Associated Types

type Rep Period :: Type -> Type

Methods

from :: Period -> Rep Period x

to :: Rep Period x -> Period

HasPeriod Never

Defined in Servant.Seo.Combinators

Methods

getPeriod :: Proxy Never -> Period

HasPeriod Yearly

Defined in Servant.Seo.Combinators

Methods

getPeriod :: Proxy Yearly -> Period

HasPeriod Monthly

Defined in Servant.Seo.Combinators

Methods

getPeriod :: Proxy Monthly -> Period

HasPeriod Weekly

Defined in Servant.Seo.Combinators

Methods

getPeriod :: Proxy Weekly -> Period

HasPeriod Daily

Defined in Servant.Seo.Combinators

Methods

getPeriod :: Proxy Daily -> Period

HasPeriod Hourly

Defined in Servant.Seo.Combinators

Methods

getPeriod :: Proxy Hourly -> Period

HasPeriod Always

Defined in Servant.Seo.Combinators

Methods

getPeriod :: Proxy Always -> Period

type Rep Period

Defined in Servant.Seo.Combinators

type Rep Period = D1 (MetaData "Period" "Servant.Seo.Combinators" "servant-seo-0.1.0-inplace" False) ((C1 (MetaCons "Never" PrefixI False) (U1 :: Type -> Type) :+: (C1 (MetaCons "Yearly" PrefixI False) (U1 :: Type -> Type) :+: C1 (MetaCons "Monthly" PrefixI False) (U1 :: Type -> Type))) :+: ((C1 (MetaCons "Weekly" PrefixI False) (U1 :: Type -> Type) :+: C1 (MetaCons "Daily" PrefixI False) (U1 :: Type -> Type)) :+: (C1 (MetaCons "Hourly" PrefixI False) (U1 :: Type -> Type) :+: C1 (MetaCons "Always" PrefixI False) (U1 :: Type -> Type))))

class HasPeriod a where

Methods

getPeriod :: Proxy a -> Period

Instances

HasPeriod Never

Defined in Servant.Seo.Combinators

Methods

getPeriod :: Proxy Never -> Period

HasPeriod Yearly

Defined in Servant.Seo.Combinators

Methods

getPeriod :: Proxy Yearly -> Period

HasPeriod Monthly

Defined in Servant.Seo.Combinators

Methods

getPeriod :: Proxy Monthly -> Period

HasPeriod Weekly

Defined in Servant.Seo.Combinators

Methods

getPeriod :: Proxy Weekly -> Period

HasPeriod Daily

Defined in Servant.Seo.Combinators

Methods

getPeriod :: Proxy Daily -> Period

HasPeriod Hourly

Defined in Servant.Seo.Combinators

Methods

getPeriod :: Proxy Hourly -> Period

HasPeriod Always

Defined in Servant.Seo.Combinators

Methods

getPeriod :: Proxy Always -> Period

Priority

data Priority (priority :: (Nat, Nat))

Priority optional parameter for sitemap.xml. Set priority on listed page to bots. Possible values are between '(0,0) and '(1,0).

>>> type API = Priority '(1,0) :> "news.php" :> Get '[HTML] NewsPage

Code above will be transformed in corresponding XML: <url><loc>https://example.com/news.php</loc><priority>1.0</priority></url>.

Instances

HasRobots api => HasRobots (Priority priority :> api :: Type)

Priority as part of sitemap.xml spec has no impact on robots.txt.

Defined in Servant.Seo.Robots

Methods

toRobots :: Proxy (Priority priority :> api) -> RobotsInfo

(KnownNat n, KnownNat m, HasSitemap api) => HasSitemap (Priority ((,) n m) :> api :: Type)

Extracts Priority from API branch.

Defined in Servant.Seo.Sitemap

Methods

toSitemapInfo :: MonadIO m0 => Proxy (Priority (n, m) :> api) -> m0 SitemapInfo

toSitemapInfoWith :: MonadIO m0 => env -> Proxy (Priority (n, m) :> api) -> m0 SitemapInfo

HasServer api context => HasServer (Priority priority :> api :: Type) context

Defined in Servant.Seo.Combinators

Associated Types

type ServerT (Priority priority :> api) m :: Type

Methods

route :: Proxy (Priority priority :> api) -> Context context -> Delayed env (Server (Priority priority :> api)) -> Router env

hoistServerWithContext :: Proxy (Priority priority :> api) -> Proxy context -> (forall x. m x -> n x) -> ServerT (Priority priority :> api) m -> ServerT (Priority priority :> api) n

type ServerT (Priority priority :> api :: Type) m

Defined in Servant.Seo.Combinators

type ServerT (Priority priority :> api :: Type) m = ServerT api m

>>> :set -XDerivingStrategies -XGeneralizedNewtypeDeriving
>>> import Servant.HTML.Blaze (HTML)
>>> import Text.Blaze (ToMarkup)
>>> newtype CrmPage = CrmPage Text deriving newtype (ToMarkup)
>>> newtype AboutPage = AboutPage Text deriving newtype (ToMarkup)
>>> newtype NewsPage = NewsPage Text deriving newtype (ToMarkup)