Changelog for base64-1.0

Revision history for base64

New epoch time! lots of changes to the API. Please see MIGRATION.md for more info:

Add support for GHC 9.x
Bumped bounds to more modern dependency set
Introduced Base64 newtype, located in Data.Base64.Types, as well as ADT for associated alphabets.
Signature for encodeBase64 has changed so that it produces a Base64 wrapped value.
decodeBase64 and its URLsafe variants now consume a value of type Base64 and produces a decoded value of the underlying type.
The old decodeBase64 and its URLsafe variants is now renamed to decodeBase64Untyped*.
Fix for 32-bit systems in which memory barriers were not respected in the encoe loop (see: #56)
Optimize encode and decode loops to achieve significant speedup across the board.

Thanks to everyone who contributed (especially @sofia-m-a!).

Support for GHC 9.2.x
Remove dependency on ghc-byteorder
Bump base lower bound to GHC 8.10.x to make sure endianness is properly support (see: https://gitlab.haskell.org/ghc/ghc/-/issues/20338)
Bump upper bound for deepseq

Add NFData, Exception, and Generic instances for Base64Error + @since annotations for new instances. (#28)
Doc improvements and add -XTrustworty and -XSafe annotations where needed. (#27)
Improve URL canonicity validation and correctness checking (now supports correct checking for unpadded Base64url) (#26)
Fixed perf regressions in decode
Test coverage is at 98%

Added support for Data.ByteString.Short, Data.ByteString.Lazy, Data.Text.Short, and Data.Text.Lazy. (#17)
Optimize decode algorithm (now beats base64-bytestring in every category!) - (#13)
Use decodeLatin1 when decoding to text, so that functions are total - (#13)
Added decodeWith* variants and a Base64Error type to handle decoding errors when decoding base64 values - (#13)
Improved error reporting: all offsets are now precisely accurate. - (#13)
Validations added to head, rejecting invalid corner cases (such as bytestrings of length l == 1 mod 4, which are never correct) - (#16)
Added decodeBase64Padded for symmetry - (#13)

With this major version release, we remove the redundant encodeBase64Unpadded and decodeBase64Unpadded functions from Base64.hs. This is for two reasons:
1. There is no reason for them to exist, since all std base64 is expected to be padded (in contrast to base64url)
2. it was literally redundant with decodeBase64.
Use a specialized Bool type to give better visual cues regarding which functions add padding

Bug fix for isBase64 and isBase64Url - wrong alphabet was used
Added isValidBase64 and isValidBase64Url for alphabet conformity. The isBase64* functions now tell if it's correct base64 now in the sense that it's decodable and valid.
Dropped Cabal version to 2.0 for backcompat with Stack
Better documentation

After a discussion with lexilambda, we're making 'encodeBase64' be ByteString -> Text by default, offering ByteString -> ByteString as a secondary format.
Add decodeBase64Lenient to the API for phadej
Fix unpadded decoding bug where garbage was appended to the end of garbage inputs. A cleaner way to do this is to simply encode as Base64 with padding and then strip padding chars until I come up with a workflow specific to unpadded inputs (I used to have this, so I'll have to dig it up)
Added isBase64 and isBase64Url to the API
Performance is stable

After a discussion with phadej, we're doing away with the flags, and splitting the optics out into their own separate library
Removed unnecessary inline pragmas