    {-# LANGUAGE DataKinds #-}
    -- |
    -- Module       : Data.ByteString.Short.Base64.URL
    -- Copyright    : (c) 2019-2023 Emily Pillmore
    -- License      : BSD-style
    --
    -- Maintainer   : Emily Pillmore <emilypi@cohomolo.gy>
    -- Stability    : stable
    -- Portability  : non-portable
    --
    -- This module contains 'Data.ByteString.Short.ShortByteString'-valued combinators for
    -- implementing the RFC 4648 specification of the Base64url
    -- encoding format. This includes strictly padded/unpadded and lenient decoding
    -- variants, as well as internal and external validation for canonicity.
    --
    module Data.ByteString.Short.Base64.URL
    ( -- * Encoding
      encodeBase64
    , encodeBase64'
    , encodeBase64Unpadded
    , encodeBase64Unpadded'
      -- * Decoding
    , decodeBase64
    , decodeBase64Untyped
    , decodeBase64Unpadded
    , decodeBase64UnpaddedUntyped
    , decodeBase64Padded
    , decodeBase64PaddedUntyped
    , decodeBase64Lenient
      -- * Validation
    , isBase64Url
    , isValidBase64Url
    ) where

    import Data.Base64.Types

    import qualified Data.ByteString.Base64.URL as B64U
    import Data.ByteString.Short (ShortByteString, fromShort, toShort)
    import Data.Text (Text)
    import Data.Text.Short (ShortText)
    import Data.Text.Short.Unsafe (fromShortByteStringUnsafe)

    -- $setup
    --
    -- >>> import Data.Base64.Types
    -- >>> :set -XOverloadedStrings
    -- >>> :set -XTypeApplications
    -- >>> :set -XDataKinds
    --

    -- | Encode a 'ShortByteString' value as a Base64url 'Text' value with padding.
    --
    -- See: <https://tools.ietf.org/html/rfc4648#section-5 RFC-4648 section 5>
    --
    -- === __Examples__:
    --
    -- >>> encodeBase64 "<<?>>"
    -- "PDw_Pj4="
    --
    encodeBase64 :: ShortByteString -> Base64 'UrlPadded ShortText
    encodeBase64 :: ShortByteString -> Base64 'UrlPadded ShortText
    encodeBase64 = (ShortByteString -> ShortText)
    -> Base64 'UrlPadded ShortByteString -> Base64 'UrlPadded ShortText
    forall a b. (a -> b) -> Base64 'UrlPadded a -> Base64 'UrlPadded b
    forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
    fmap ShortByteString -> ShortText
    fromShortByteStringUnsafe (Base64 'UrlPadded ShortByteString -> Base64 'UrlPadded ShortText)
    -> (ShortByteString -> Base64 'UrlPadded ShortByteString)
    -> ShortByteString
    -> Base64 'UrlPadded ShortText
    forall b c a. (b -> c) -> (a -> b) -> a -> c
    . ShortByteString -> Base64 'UrlPadded ShortByteString
    encodeBase64'
    {-# INLINE encodeBase64 #-}

    -- | Encode a 'ShortByteString' as a Base64url 'ShortByteString' value with padding.
    --
    -- See: <https://tools.ietf.org/html/rfc4648#section-5 RFC-4648 section 5>
    --
    -- === __Examples__:
    --
    -- >>> encodeBase64' "<<?>>"
    -- "PDw_Pj4="
    --
    encodeBase64' :: ShortByteString -> Base64 'UrlPadded ShortByteString
    encodeBase64' :: ShortByteString -> Base64 'UrlPadded ShortByteString
    encodeBase64' = (ByteString -> ShortByteString)
    -> Base64 'UrlPadded ByteString
    -> Base64 'UrlPadded ShortByteString
    forall a b. (a -> b) -> Base64 'UrlPadded a -> Base64 'UrlPadded b
    forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
    fmap ByteString -> ShortByteString
    toShort (Base64 'UrlPadded ByteString -> Base64 'UrlPadded ShortByteString)
    -> (ShortByteString -> Base64 'UrlPadded ByteString)
    -> ShortByteString
    -> Base64 'UrlPadded ShortByteString
    forall b c a. (b -> c) -> (a -> b) -> a -> c
    . ByteString -> Base64 'UrlPadded ByteString
    B64U.encodeBase64' (ByteString -> Base64 'UrlPadded ByteString)
    -> (ShortByteString -> ByteString)
    -> ShortByteString
    -> Base64 'UrlPadded ByteString
    forall b c a. (b -> c) -> (a -> b) -> a -> c
    . ShortByteString -> ByteString
    fromShort

    -- | Decode a Base64url encoded 'ShortByteString' value, either padded or unpadded.
    -- The correct decoding function is dispatched based on the existence of padding.
    --
    -- For typed values:
    --   - If a padded value is required, use 'decodeBase64Padded'
    --   - If an unpadded value is required, use 'decodeBase64Unpadded'
    --
    -- See: <https://tools.ietf.org/html/rfc4648#section-4 RFC-4648 section 4>
    --
    -- === __Examples__:
    --
    -- >>> decodeBase64 $ assertBase64 @'UrlPadded "PDw_Pj4="
    -- "<<?>>"
    --
    -- >>> decodeBase64 $ assertBase64 @'UrlUnpadded "PDw_Pj4"
    -- "<<?>>"
    --
    decodeBase64
      :: UrlAlphabet k
      => Base64 k ShortByteString
      -> ShortByteString
    decodeBase64 :: forall (k :: Alphabet).
    UrlAlphabet k =>
    Base64 k ShortByteString -> ShortByteString
    decodeBase64 = ByteString -> ShortByteString
    toShort (ByteString -> ShortByteString)
    -> (Base64 k ShortByteString -> ByteString)
    -> Base64 k ShortByteString
    -> ShortByteString
    forall b c a. (b -> c) -> (a -> b) -> a -> c
    . Base64 k ByteString -> ByteString
    forall (k :: Alphabet).
    UrlAlphabet k =>
    Base64 k ByteString -> ByteString
    B64U.decodeBase64 (Base64 k ByteString -> ByteString)
    -> (Base64 k ShortByteString -> Base64 k ByteString)
    -> Base64 k ShortByteString
    -> ByteString
    forall b c a. (b -> c) -> (a -> b) -> a -> c
    . (ShortByteString -> ByteString)
    -> Base64 k ShortByteString -> Base64 k ByteString
    forall a b. (a -> b) -> Base64 k a -> Base64 k b
    forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
    fmap ShortByteString -> ByteString
    fromShort

    -- | Decode an untyped Base64url encoded 'ByteString' value. If its length is not a multiple
    -- of 4, then padding chars will be added to fill out the input to a multiple of
    -- 4 for safe decoding as Base64url-encoded values are optionally padded.
    --
    -- For a decoder that fails to decode untyped values of incorrect size:
    --   - If a padded value is required, use 'decodeBase64PaddedUntyped'
    --   - If an unpadded value is required, use 'decodeBase64UnpaddedUntyped'
    --
    -- See: <https://tools.ietf.org/html/rfc4648#section-4 RFC-4648 section 4>
    --
    -- === __Examples__:
    --
    -- >>> decodeBase64Untyped "PDw_Pj4="
    -- Right "<<?>>"
    --
    -- >>> decodeBase64Untyped "PDw_Pj4"
    -- Right "<<?>>"
    --
    -- >>> decodeBase64Untyped "PDw-Pg="
    -- Left "Base64-encoded bytestring has invalid padding"
    --
    -- >>> decodeBase64Untyped "PDw-Pg"
    -- Right "<<>>"
    --
    decodeBase64Untyped :: ShortByteString -> Either Text ShortByteString
    decodeBase64Untyped :: ShortByteString -> Either Text ShortByteString
    decodeBase64Untyped = (ByteString -> ShortByteString)
    -> Either Text ByteString -> Either Text ShortByteString
    forall a b. (a -> b) -> Either Text a -> Either Text b
    forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
    fmap ByteString -> ShortByteString
    toShort (Either Text ByteString -> Either Text ShortByteString)
    -> (ShortByteString -> Either Text ByteString)
    -> ShortByteString
    -> Either Text ShortByteString
    forall b c a. (b -> c) -> (a -> b) -> a -> c
    . ByteString -> Either Text ByteString
    B64U.decodeBase64Untyped (ByteString -> Either Text ByteString)
    -> (ShortByteString -> ByteString)
    -> ShortByteString
    -> Either Text ByteString
    forall b c a. (b -> c) -> (a -> b) -> a -> c
    . ShortByteString -> ByteString
    fromShort
    {-# inline decodeBase64Untyped #-}

    -- | Encode a 'ShortByteString' value as Base64url 'Text' without padding.
    --
    -- See: <https://tools.ietf.org/html/rfc4648#section-3.2 RFC-4648 section 3.2>
    --
    -- === __Examples__:
    --
    -- >>> encodeBase64Unpadded "<<?>>"
    -- "PDw_Pj4"
    --
    encodeBase64Unpadded :: ShortByteString -> Base64 'UrlUnpadded ShortText
    encodeBase64Unpadded :: ShortByteString -> Base64 'UrlUnpadded ShortText
    encodeBase64Unpadded = (ShortByteString -> ShortText)
    -> Base64 'UrlUnpadded ShortByteString
    -> Base64 'UrlUnpadded ShortText
    forall a b.
    (a -> b) -> Base64 'UrlUnpadded a -> Base64 'UrlUnpadded b
    forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
    fmap ShortByteString -> ShortText
    fromShortByteStringUnsafe (Base64 'UrlUnpadded ShortByteString
     -> Base64 'UrlUnpadded ShortText)
    -> (ShortByteString -> Base64 'UrlUnpadded ShortByteString)
    -> ShortByteString
    -> Base64 'UrlUnpadded ShortText
    forall b c a. (b -> c) -> (a -> b) -> a -> c
    . ShortByteString -> Base64 'UrlUnpadded ShortByteString
    encodeBase64Unpadded'
    {-# INLINE encodeBase64Unpadded #-}

    -- | Encode a 'ShortByteString' value as Base64url without padding.
    --
    -- See: <https://tools.ietf.org/html/rfc4648#section-3.2 RFC-4648 section 3.2>
    --
    -- === __Examples__:
    --
    -- >>> encodeBase64Unpadded' "<<?>>"
    -- "PDw_Pj4"
    --
    encodeBase64Unpadded' :: ShortByteString -> Base64 'UrlUnpadded ShortByteString
    encodeBase64Unpadded' :: ShortByteString -> Base64 'UrlUnpadded ShortByteString
    encodeBase64Unpadded' = (ByteString -> ShortByteString)
    -> Base64 'UrlUnpadded ByteString
    -> Base64 'UrlUnpadded ShortByteString
    forall a b.
    (a -> b) -> Base64 'UrlUnpadded a -> Base64 'UrlUnpadded b
    forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
    fmap ByteString -> ShortByteString
    toShort (Base64 'UrlUnpadded ByteString
     -> Base64 'UrlUnpadded ShortByteString)
    -> (ShortByteString -> Base64 'UrlUnpadded ByteString)
    -> ShortByteString
    -> Base64 'UrlUnpadded ShortByteString
    forall b c a. (b -> c) -> (a -> b) -> a -> c
    . ByteString -> Base64 'UrlUnpadded ByteString
    B64U.encodeBase64Unpadded' (ByteString -> Base64 'UrlUnpadded ByteString)
    -> (ShortByteString -> ByteString)
    -> ShortByteString
    -> Base64 'UrlUnpadded ByteString
    forall b c a. (b -> c) -> (a -> b) -> a -> c
    . ShortByteString -> ByteString
    fromShort

    -- | Decode an unpadded Base64url-encoded 'ShortByteString' value.
    --
    -- See: <https://tools.ietf.org/html/rfc4648#section-4 RFC-4648 section 4>
    --
    -- === __Examples__:
    --
    -- >>> decodeBase64Unpadded $ assertBase64 @'UrlUnpadded "PDw_Pj4"
    -- "<<?>>"
    --
    decodeBase64Unpadded :: Base64 'UrlUnpadded ShortByteString -> ShortByteString
    decodeBase64Unpadded :: Base64 'UrlUnpadded ShortByteString -> ShortByteString
    decodeBase64Unpadded = ByteString -> ShortByteString
    toShort (ByteString -> ShortByteString)
    -> (Base64 'UrlUnpadded ShortByteString -> ByteString)
    -> Base64 'UrlUnpadded ShortByteString
    -> ShortByteString
    forall b c a. (b -> c) -> (a -> b) -> a -> c
    . Base64 'UrlUnpadded ByteString -> ByteString
    B64U.decodeBase64Unpadded (Base64 'UrlUnpadded ByteString -> ByteString)
    -> (Base64 'UrlUnpadded ShortByteString
        -> Base64 'UrlUnpadded ByteString)
    -> Base64 'UrlUnpadded ShortByteString
    -> ByteString
    forall b c a. (b -> c) -> (a -> b) -> a -> c
    . (ShortByteString -> ByteString)
    -> Base64 'UrlUnpadded ShortByteString
    -> Base64 'UrlUnpadded ByteString
    forall a b.
    (a -> b) -> Base64 'UrlUnpadded a -> Base64 'UrlUnpadded b
    forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
    fmap ShortByteString -> ByteString
    fromShort
    {-# INLINE decodeBase64Unpadded #-}

    -- | Decode an unpadded, untyped Base64url encoded 'ByteString' value.
    -- If its length is not a multiple of 4, then padding chars will be added
    -- to fill out the input to a multiple of 4 for safe decoding as
    -- Base64url-encoded values are optionally padded.
    --
    -- In general, unless unpadded Base64url is explicitly required, it is
    -- safer to call 'decodeBase64'.
    --
    -- See: <https://tools.ietf.org/html/rfc4648#section-4 RFC-4648 section 4>
    --
    -- === __Examples__:
    --
    -- >>> decodeBase64UnpaddedUntyped "PDw_Pj4"
    -- Right "<<?>>"
    --
    -- >>> decodeBase64UnpaddedUntyped "PDw-Pg="
    -- Left "Base64-encoded bytestring has invalid padding"
    --
    -- >>> decodeBase64UnpaddedUntyped "PDw-Pg"
    -- Right "<<>>"
    --
    decodeBase64UnpaddedUntyped :: ShortByteString -> Either Text ShortByteString
    decodeBase64UnpaddedUntyped :: ShortByteString -> Either Text ShortByteString
    decodeBase64UnpaddedUntyped = (ByteString -> ShortByteString)
    -> Either Text ByteString -> Either Text ShortByteString
    forall a b. (a -> b) -> Either Text a -> Either Text b
    forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
    fmap ByteString -> ShortByteString
    toShort
      (Either Text ByteString -> Either Text ShortByteString)
    -> (ShortByteString -> Either Text ByteString)
    -> ShortByteString
    -> Either Text ShortByteString
    forall b c a. (b -> c) -> (a -> b) -> a -> c
    . ByteString -> Either Text ByteString
    B64U.decodeBase64UnpaddedUntyped
      (ByteString -> Either Text ByteString)
    -> (ShortByteString -> ByteString)
    -> ShortByteString
    -> Either Text ByteString
    forall b c a. (b -> c) -> (a -> b) -> a -> c
    . ShortByteString -> ByteString
    fromShort
    {-# inline decodeBase64UnpaddedUntyped #-}

    -- | Decode a padded Base64url-encoded 'ShortByteString' value.
    --
    -- See: <https://tools.ietf.org/html/rfc4648#section-4 RFC-4648 section 4>
    --
    -- === __Examples__:
    --
    -- >>> decodeBase64Padded $ assertBase64 @'UrlPadded "PDw_Pj4="
    -- "<<?>>"
    --
    decodeBase64Padded :: Base64 'UrlPadded ShortByteString -> ShortByteString
    decodeBase64Padded :: Base64 'UrlPadded ShortByteString -> ShortByteString
    decodeBase64Padded = ByteString -> ShortByteString
    toShort (ByteString -> ShortByteString)
    -> (Base64 'UrlPadded ShortByteString -> ByteString)
    -> Base64 'UrlPadded ShortByteString
    -> ShortByteString
    forall b c a. (b -> c) -> (a -> b) -> a -> c
    . Base64 'UrlPadded ByteString -> ByteString
    B64U.decodeBase64Padded (Base64 'UrlPadded ByteString -> ByteString)
    -> (Base64 'UrlPadded ShortByteString
        -> Base64 'UrlPadded ByteString)
    -> Base64 'UrlPadded ShortByteString
    -> ByteString
    forall b c a. (b -> c) -> (a -> b) -> a -> c
    . (ShortByteString -> ByteString)
    -> Base64 'UrlPadded ShortByteString
    -> Base64 'UrlPadded ByteString
    forall a b. (a -> b) -> Base64 'UrlPadded a -> Base64 'UrlPadded b
    forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
    fmap ShortByteString -> ByteString
    fromShort
    {-# INLINE decodeBase64Padded #-}

    -- | Decode a padded, untyped Base64url encoded 'ByteString' value.
    --
    -- For a decoder that fails on unpadded input of incorrect size,
    -- use 'decodeBase64UnpaddedUntyped'.
    --
    -- See: <https://tools.ietf.org/html/rfc4648#section-4 RFC-4648 section 4>
    --
    -- === __Examples__:
    --
    -- >>> decodeBase64PaddedUntyped "PDw_Pj4="
    -- Right "<<?>>"
    --
    -- >>> decodeBase64PaddedUntyped "PDw_Pj4"
    -- Left "Base64-encoded bytestring requires padding"
    --
    decodeBase64PaddedUntyped :: ShortByteString -> Either Text ShortByteString
    decodeBase64PaddedUntyped :: ShortByteString -> Either Text ShortByteString
    decodeBase64PaddedUntyped = (ByteString -> ShortByteString)
    -> Either Text ByteString -> Either Text ShortByteString
    forall a b. (a -> b) -> Either Text a -> Either Text b
    forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
    fmap ByteString -> ShortByteString
    toShort
      (Either Text ByteString -> Either Text ShortByteString)
    -> (ShortByteString -> Either Text ByteString)
    -> ShortByteString
    -> Either Text ShortByteString
    forall b c a. (b -> c) -> (a -> b) -> a -> c
    . ByteString -> Either Text ByteString
    B64U.decodeBase64PaddedUntyped
      (ByteString -> Either Text ByteString)
    -> (ShortByteString -> ByteString)
    -> ShortByteString
    -> Either Text ByteString
    forall b c a. (b -> c) -> (a -> b) -> a -> c
    . ShortByteString -> ByteString
    fromShort
    {-# inline decodeBase64PaddedUntyped #-}

    -- | Leniently decode an unpadded, untyped Base64url-encoded 'ShortByteString'. This function
    -- will not generate parse errors. If input data contains padding chars,
    -- then the input will be parsed up until the first pad character.
    --
    -- __Note:__ This is not RFC 4648-compliant.
    --
    -- === __Examples__:
    --
    -- >>> decodeBase64Lenient "PDw_Pj4="
    -- "<<?>>"
    --
    -- >>> decodeBase64Lenient "PDw_%%%$}Pj4"
    -- "<<?>>"
    --
    decodeBase64Lenient :: ShortByteString -> ShortByteString
    decodeBase64Lenient :: ShortByteString -> ShortByteString
    decodeBase64Lenient = ByteString -> ShortByteString
    toShort (ByteString -> ShortByteString)
    -> (ShortByteString -> ByteString)
    -> ShortByteString
    -> ShortByteString
    forall b c a. (b -> c) -> (a -> b) -> a -> c
    . ByteString -> ByteString
    B64U.decodeBase64Lenient (ByteString -> ByteString)
    -> (ShortByteString -> ByteString) -> ShortByteString -> ByteString
    forall b c a. (b -> c) -> (a -> b) -> a -> c
    . ShortByteString -> ByteString
    fromShort
    {-# INLINE decodeBase64Lenient #-}

    -- | Tell whether an untyped 'ShortByteString' is Base64url-encoded.
    --
    -- === __Examples__:
    --
    -- >>> isBase64Url "PDw_Pj4="
    -- True
    --
    -- >>> isBase64Url "PDw_Pj4"
    -- True
    --
    -- >>> isBase64Url "PDw_Pj"
    -- False
    --
    isBase64Url :: ShortByteString -> Bool
    isBase64Url :: ShortByteString -> Bool
    isBase64Url = ByteString -> Bool
    B64U.isBase64Url (ByteString -> Bool)
    -> (ShortByteString -> ByteString) -> ShortByteString -> Bool
    forall b c a. (b -> c) -> (a -> b) -> a -> c
    . ShortByteString -> ByteString
    fromShort
    {-# INLINE isBase64Url #-}

    -- | Tell whether an untyped 'ShortByteString' is a valid Base64url format.
    --
    -- This will not tell you whether or not this is a correct Base64url representation,
    -- only that it conforms to the correct shape. To check whether it is a true
    -- Base64 encoded 'ShortByteString' value, use 'isBase64Url'.
    --
    -- === __Examples__:
    --
    -- >>> isValidBase64Url "PDw_Pj4="
    -- True
    --
    -- >>> isValidBase64Url "PDw_Pj"
    -- True
    --
    -- >>> isValidBase64Url "%"
    -- False
    --
    isValidBase64Url :: ShortByteString -> Bool
    isValidBase64Url :: ShortByteString -> Bool
    isValidBase64Url = ByteString -> Bool
    B64U.isValidBase64Url (ByteString -> Bool)
    -> (ShortByteString -> ByteString) -> ShortByteString -> Bool
    forall b c a. (b -> c) -> (a -> b) -> a -> c
    . ShortByteString -> ByteString
    fromShort
    {-# INLINE isValidBase64Url #-}