    {-# LANGUAGE DataKinds #-}
    -- |
    -- Module       : Data.Text.Short.Encoding.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.Text.Short.ShortText'-valued combinators
    -- implementing the RFC 4648 specification for the Base64url
    -- encoding format. This includes strictly padded/unpadded and lenient
    -- decoding variants, and external + internal validations for canonicity.
    --
    module Data.Text.Short.Encoding.Base64.URL
    ( -- * Encoding
      encodeBase64
    , encodeBase64Unpadded
      -- * Decoding
    , decodeBase64
    , decodeBase64Untyped
    , decodeBase64UntypedWith
    , decodeBase64Unpadded
    , decodeBase64UnpaddedUntyped
    , decodeBase64UnpaddedUntypedWith
    , decodeBase64Padded
    , decodeBase64PaddedUntyped
    , decodeBase64PaddedUntypedWith
    , decodeBase64Lenient
      -- * Validation
    , isBase64Url
    , isValidBase64Url
    ) where

    import Data.Base64.Types

    import Data.Bifunctor (first)
    import qualified Data.ByteString.Base64.URL as B64U
    import Data.ByteString.Short (ShortByteString)
    import qualified Data.ByteString.Short.Base64.URL as BS64U
    import Data.Text (Text)
    import qualified Data.Text.Encoding.Base64.URL as B64TU
    import Data.Text.Encoding.Base64.Error
    import Data.Text.Short
    import Data.Text.Short.Unsafe

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

    -- | Encode a 'ShortText' value in Base64url with padding.
    --
    -- See: <https://tools.ietf.org/html/rfc4648#section-5 RFC-4648 section 5>
    --
    -- === __Examples__:
    --
    -- >>> encodeBase64 "<<?>>"
    -- "PDw_Pj4="
    --
    encodeBase64 :: ShortText -> Base64 'UrlPadded ShortText
    encodeBase64 :: ShortText -> Base64 'UrlPadded ShortText
    encodeBase64 = (ByteString -> ShortText)
    -> Base64 'UrlPadded ByteString -> 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 ByteString -> ShortText
    fromByteStringUnsafe
      (Base64 'UrlPadded ByteString -> Base64 'UrlPadded ShortText)
    -> (ShortText -> Base64 'UrlPadded ByteString)
    -> ShortText
    -> Base64 'UrlPadded ShortText
    forall b c a. (b -> c) -> (a -> b) -> a -> c
    . ByteString -> Base64 'UrlPadded ByteString
    B64U.encodeBase64'
      (ByteString -> Base64 'UrlPadded ByteString)
    -> (ShortText -> ByteString)
    -> ShortText
    -> Base64 'UrlPadded ByteString
    forall b c a. (b -> c) -> (a -> b) -> a -> c
    . ShortText -> ByteString
    toByteString
    {-# INLINE encodeBase64 #-}

    -- | Decode an arbitrarily padded Base64url-encoded 'ShortText' value.
    --
    -- 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 ShortText -> ShortText
    decodeBase64 :: forall (k :: Alphabet).
    UrlAlphabet k =>
    Base64 k ShortText -> ShortText
    decodeBase64 = Text -> ShortText
    fromText (Text -> ShortText)
    -> (Base64 k ShortText -> Text) -> Base64 k ShortText -> ShortText
    forall b c a. (b -> c) -> (a -> b) -> a -> c
    . Base64 k Text -> Text
    forall (k :: Alphabet). UrlAlphabet k => Base64 k Text -> Text
    B64TU.decodeBase64 (Base64 k Text -> Text)
    -> (Base64 k ShortText -> Base64 k Text)
    -> Base64 k ShortText
    -> Text
    forall b c a. (b -> c) -> (a -> b) -> a -> c
    . (ShortText -> Text) -> Base64 k ShortText -> Base64 k Text
    forall a b. (a -> b) -> Base64 k a -> Base64 k b
    forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
    fmap ShortText -> Text
    toText
    {-# INLINE decodeBase64 #-}

    -- | Decode an untyped padded Base64url-encoded 'ShortText' 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 encodings are optionally padded.
    --
    -- For a decoder that fails on unpadded input, use 'decodeBase64Unpadded'.
    --
    -- /Note:/ This function makes sure that decoding is total by deferring to
    -- 'T.decodeUtf8'. This will always round trip for any valid Base64-encoded
    -- text value, but it may not round trip for bad inputs. The onus is on the
    -- caller to make sure inputs are valid. If unsure, defer to `decodeBase64With`
    -- and pass in a custom decode function.
    --
    -- 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 :: ShortText -> Either Text ShortText
    decodeBase64Untyped :: ShortText -> Either Text ShortText
    decodeBase64Untyped = (Text -> ShortText) -> Either Text Text -> Either Text ShortText
    forall a b. (a -> b) -> Either Text a -> Either Text b
    forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
    fmap Text -> ShortText
    fromText (Either Text Text -> Either Text ShortText)
    -> (ShortText -> Either Text Text)
    -> ShortText
    -> Either Text ShortText
    forall b c a. (b -> c) -> (a -> b) -> a -> c
    . Text -> Either Text Text
    B64TU.decodeBase64Untyped (Text -> Either Text Text)
    -> (ShortText -> Text) -> ShortText -> Either Text Text
    forall b c a. (b -> c) -> (a -> b) -> a -> c
    . ShortText -> Text
    toText
    {-# INLINE decodeBase64Untyped #-}

    -- | Attempt to decode an untyped 'ShortByteString' value as Base64url, converting from
    -- 'ByteString' to 'ShortText' according to some encoding function. In practice,
    -- This is something like 'decodeUtf8'', which may produce an error.
    --
    -- See: <https://tools.ietf.org/html/rfc4648#section-4 RFC-4648 section 4>
    --
    -- === __Examples__:
    --
    -- @
    -- 'decodeBase64With' 'T.decodeUtf8''
    --   :: 'ShortByteString' -> 'Either' ('Base64Error' 'UnicodeException') 'ShortText'
    -- @
    --
    decodeBase64UntypedWith
        :: (ShortByteString -> Either err ShortText)
          -- ^ convert a bytestring to text (e.g. 'T.decodeUtf8'')
        -> ShortByteString
          -- ^ Input text to decode
        -> Either (Base64Error err) ShortText
    decodeBase64UntypedWith :: forall err.
    (ShortByteString -> Either err ShortText)
    -> ShortByteString -> Either (Base64Error err) ShortText
    decodeBase64UntypedWith ShortByteString -> Either err ShortText
    f ShortByteString
    t = case ShortByteString -> Either Text ShortByteString
    BS64U.decodeBase64Untyped ShortByteString
    t of
      Left Text
    de -> Base64Error err -> Either (Base64Error err) ShortText
    forall a b. a -> Either a b
    Left (Base64Error err -> Either (Base64Error err) ShortText)
    -> Base64Error err -> Either (Base64Error err) ShortText
    forall a b. (a -> b) -> a -> b
    $ Text -> Base64Error err
    forall e. Text -> Base64Error e
    DecodeError Text
    de
      Right ShortByteString
    a -> (err -> Base64Error err)
    -> Either err ShortText -> Either (Base64Error err) ShortText
    forall a b c. (a -> b) -> Either a c -> Either b c
    forall (p :: * -> * -> *) a b c.
    Bifunctor p =>
    (a -> b) -> p a c -> p b c
    first err -> Base64Error err
    forall e. e -> Base64Error e
    ConversionError (ShortByteString -> Either err ShortText
    f ShortByteString
    a)
    {-# INLINE decodeBase64UntypedWith #-}

    -- | Encode a 'ShortText' value in Base64url without padding.
    --
    -- See: <https://tools.ietf.org/html/rfc4648#section-3.2 RFC-4648 section 3.2>
    --
    -- === __Examples__:
    --
    -- >>> encodeBase64Unpadded "<<?>>"
    -- "PDw_Pj4"
    --
    encodeBase64Unpadded :: ShortText -> Base64 'UrlUnpadded ShortText
    encodeBase64Unpadded :: ShortText -> Base64 'UrlUnpadded ShortText
    encodeBase64Unpadded = (ByteString -> ShortText)
    -> Base64 'UrlUnpadded ByteString -> 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 ByteString -> ShortText
    fromByteStringUnsafe
      (Base64 'UrlUnpadded ByteString -> Base64 'UrlUnpadded ShortText)
    -> (ShortText -> Base64 'UrlUnpadded ByteString)
    -> ShortText
    -> Base64 'UrlUnpadded ShortText
    forall b c a. (b -> c) -> (a -> b) -> a -> c
    . ByteString -> Base64 'UrlUnpadded ByteString
    B64U.encodeBase64Unpadded'
      (ByteString -> Base64 'UrlUnpadded ByteString)
    -> (ShortText -> ByteString)
    -> ShortText
    -> Base64 'UrlUnpadded ByteString
    forall b c a. (b -> c) -> (a -> b) -> a -> c
    . ShortText -> ByteString
    toByteString
    {-# INLINE encodeBase64Unpadded #-}

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

    -- | Decode an untyped, unpadded Base64url encoded 'ShortText' value.
    --
    -- See: <https://tools.ietf.org/html/rfc4648#section-4 RFC-4648 section 4>
    --
    -- === __Examples__:
    --
    -- >>> decodeBase64UnpaddedUntyped "PDw_Pj4"
    -- Right "<<?>>"
    --
    -- >>> decodeBase64UnpaddedUntyped "PDw_Pj4="
    -- Left "Base64-encoded bytestring has invalid padding"
    --
    decodeBase64UnpaddedUntyped :: ShortText -> Either Text ShortText
    decodeBase64UnpaddedUntyped :: ShortText -> Either Text ShortText
    decodeBase64UnpaddedUntyped = (Text -> ShortText) -> Either Text Text -> Either Text ShortText
    forall a b. (a -> b) -> Either Text a -> Either Text b
    forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
    fmap Text -> ShortText
    fromText
      (Either Text Text -> Either Text ShortText)
    -> (ShortText -> Either Text Text)
    -> ShortText
    -> Either Text ShortText
    forall b c a. (b -> c) -> (a -> b) -> a -> c
    . Text -> Either Text Text
    B64TU.decodeBase64UnpaddedUntyped
      (Text -> Either Text Text)
    -> (ShortText -> Text) -> ShortText -> Either Text Text
    forall b c a. (b -> c) -> (a -> b) -> a -> c
    . ShortText -> Text
    toText
    {-# INLINE decodeBase64UnpaddedUntyped #-}

    -- | Attempt to decode an untyped, unpadded 'ShortByteString' value as Base64url, converting from
    -- 'ShortByteString' to 'ShortText' according to some encoding function. In practice,
    -- This is something like 'decodeUtf8'', which may produce an error.
    --
    -- See: <https://tools.ietf.org/html/rfc4648#section-4 RFC-4648 section 4>
    --
    -- === __Examples__:
    --
    -- @
    -- 'decodeBase64UnpaddedWith' 'T.decodeUtf8''
    --   :: 'ShortByteString' -> 'Either' ('Base64Error' 'UnicodeException') 'ShortText'
    -- @
    --
    decodeBase64UnpaddedUntypedWith
        :: (ShortByteString -> Either err ShortText)
          -- ^ convert a bytestring to text (e.g. 'T.decodeUtf8'')
        -> ShortByteString
          -- ^ Input text to decode
        -> Either (Base64Error err) ShortText
    decodeBase64UnpaddedUntypedWith :: forall err.
    (ShortByteString -> Either err ShortText)
    -> ShortByteString -> Either (Base64Error err) ShortText
    decodeBase64UnpaddedUntypedWith ShortByteString -> Either err ShortText
    f ShortByteString
    t = case ShortByteString -> Either Text ShortByteString
    BS64U.decodeBase64UnpaddedUntyped ShortByteString
    t of
      Left Text
    de -> Base64Error err -> Either (Base64Error err) ShortText
    forall a b. a -> Either a b
    Left (Base64Error err -> Either (Base64Error err) ShortText)
    -> Base64Error err -> Either (Base64Error err) ShortText
    forall a b. (a -> b) -> a -> b
    $ Text -> Base64Error err
    forall e. Text -> Base64Error e
    DecodeError Text
    de
      Right ShortByteString
    a -> (err -> Base64Error err)
    -> Either err ShortText -> Either (Base64Error err) ShortText
    forall a b c. (a -> b) -> Either a c -> Either b c
    forall (p :: * -> * -> *) a b c.
    Bifunctor p =>
    (a -> b) -> p a c -> p b c
    first err -> Base64Error err
    forall e. e -> Base64Error e
    ConversionError (ShortByteString -> Either err ShortText
    f ShortByteString
    a)
    {-# INLINE decodeBase64UnpaddedUntypedWith #-}

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

    -- | Decode an untyped, padded Base64url encoded 'ShortText' value
    --
    -- 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 :: ShortText -> Either Text ShortText
    decodeBase64PaddedUntyped :: ShortText -> Either Text ShortText
    decodeBase64PaddedUntyped = (Text -> ShortText) -> Either Text Text -> Either Text ShortText
    forall a b. (a -> b) -> Either Text a -> Either Text b
    forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
    fmap Text -> ShortText
    fromText (Either Text Text -> Either Text ShortText)
    -> (ShortText -> Either Text Text)
    -> ShortText
    -> Either Text ShortText
    forall b c a. (b -> c) -> (a -> b) -> a -> c
    . Text -> Either Text Text
    B64TU.decodeBase64PaddedUntyped (Text -> Either Text Text)
    -> (ShortText -> Text) -> ShortText -> Either Text Text
    forall b c a. (b -> c) -> (a -> b) -> a -> c
    . ShortText -> Text
    toText
    {-# INLINE decodeBase64PaddedUntyped #-}

    -- | Attempt to decode an untyped, padded 'ShortByteString' value as Base64url, converting from
    -- 'ByteString' to 'ShortText' according to some encoding function. In practice,
    -- This is something like 'decodeUtf8'', which may produce an error.
    --
    -- See: <https://tools.ietf.org/html/rfc4648#section-4 RFC-4648 section 4>
    --
    -- === __Examples__:
    --
    -- @
    -- 'decodeBase64With' 'T.decodeUtf8''
    --   :: 'ShortByteString' -> 'Either' ('Base64Error' 'UnicodeException') 'ShortText'
    -- @
    --
    decodeBase64PaddedUntypedWith
        :: (ShortByteString -> Either err ShortText)
          -- ^ convert a bytestring to text (e.g. 'T.decodeUtf8'')
        -> ShortByteString
          -- ^ Input text to decode
        -> Either (Base64Error err) ShortText
    decodeBase64PaddedUntypedWith :: forall err.
    (ShortByteString -> Either err ShortText)
    -> ShortByteString -> Either (Base64Error err) ShortText
    decodeBase64PaddedUntypedWith ShortByteString -> Either err ShortText
    f ShortByteString
    t = case ShortByteString -> Either Text ShortByteString
    BS64U.decodeBase64PaddedUntyped ShortByteString
    t of
      Left Text
    de -> Base64Error err -> Either (Base64Error err) ShortText
    forall a b. a -> Either a b
    Left (Base64Error err -> Either (Base64Error err) ShortText)
    -> Base64Error err -> Either (Base64Error err) ShortText
    forall a b. (a -> b) -> a -> b
    $ Text -> Base64Error err
    forall e. Text -> Base64Error e
    DecodeError Text
    de
      Right ShortByteString
    a -> (err -> Base64Error err)
    -> Either err ShortText -> Either (Base64Error err) ShortText
    forall a b c. (a -> b) -> Either a c -> Either b c
    forall (p :: * -> * -> *) a b c.
    Bifunctor p =>
    (a -> b) -> p a c -> p b c
    first err -> Base64Error err
    forall e. e -> Base64Error e
    ConversionError (ShortByteString -> Either err ShortText
    f ShortByteString
    a)
    {-# INLINE decodeBase64PaddedUntypedWith #-}

    -- | Leniently decode an untyped, unpadded Base64url-encoded 'ShortText'. 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 :: ShortText -> ShortText
    decodeBase64Lenient :: ShortText -> ShortText
    decodeBase64Lenient = Text -> ShortText
    fromText (Text -> ShortText)
    -> (ShortText -> Text) -> ShortText -> ShortText
    forall b c a. (b -> c) -> (a -> b) -> a -> c
    . Text -> Text
    B64TU.decodeBase64Lenient (Text -> Text) -> (ShortText -> Text) -> ShortText -> Text
    forall b c a. (b -> c) -> (a -> b) -> a -> c
    . ShortText -> Text
    toText
    {-# INLINE decodeBase64Lenient #-}

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

    -- | Tell whether an untyped 'ShortText' value 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 'ShortText' value, use 'isBase64Url'.
    --
    -- === __Examples__:
    --
    -- >>> isValidBase64Url "PDw_Pj4="
    -- True
    --
    -- >>> isValidBase64Url "PDw_Pj"
    -- True
    --
    -- >>> isValidBase64Url "%"
    -- False
    --
    isValidBase64Url :: ShortText -> Bool
    isValidBase64Url :: ShortText -> Bool
    isValidBase64Url = ByteString -> Bool
    B64U.isValidBase64Url (ByteString -> Bool)
    -> (ShortText -> ByteString) -> ShortText -> Bool
    forall b c a. (b -> c) -> (a -> b) -> a -> c
    . ShortText -> ByteString
    toByteString
    {-# INLINE isValidBase64Url #-}