Notable changes to this project are documented in this file. The format is based on Keep a Changelog and this project adheres to Semantic Versioning.

Breaking changes:

New features:

Bugfixes:

Other improvements:

Breaking changes:

• Migrate FFI to ES modules (#86 by @kl0tl and @JordanMartinez)

New features:

Bugfixes:

Other improvements:

• Replace all usages of F and FT with Except/ExceptT (NonEmptyList ForeignError) (#87 by @JordanMartinez)

  Often times, the F and FT aliases did more to hinder usage of this library than help. These aliases haven't been deprecated, but usage of them is now discouraged. All code in the library now uses the full type that is aliased by F and FT.

Other improvements:

• Fix warnings revealed by v0.14.1 PureScript release (#85 by @JordanMartinez)

Breaking changes:

• Added support for PureScript 0.14 and dropped support for all previous versions (#80)

Other improvements:

• Migrated CI to GitHub Actions and updated installation instructions to use Spago (#81)
• Added a CHANGELOG.md file and pull request template (#82, #83)
• Replaced unsafeToForeign and unsafeFromForeign with unsafeCoerce (#72)

• Updated for PureScript 0.12
• renderForeignError now renders nested errors correcty (@abhin4v)
• The namespace is now Foreign rather than Data.Foreign
• The JSONError constructor was removed. This library is not for JSON, it was a bad name - use ForeignError instead.
• toForeign has been renamed as unsafeToForeign with a comment explaining its intended usage and potential risks

Fix Show instance for ForeignError (@rightfold)

• Updated for PureScript 0.11
• The library has been drastically simplified to focus on its core use; validating and extracting data from foreign values. This involves changes such as:
  • Removal of IsForeign / AsForeign classes
  • Removal of parseJSON as this library is not intended for general JSON parsing
• New functions were added for readNull, readUndefined, readNullOrUndefined rather than using the newtypes to direct IsForeign choice as it was before
• The (!) index/property reading operator has been enhanced to work with Foreign or F Foreign on the left hand side, allowing for chained property reads

Add instances for Null, Undefined and NullOrUndefined (@felixSchl)

• Fixed shadowed name warning

• Updated lists dependency

• Updated dependecies
• F now uses Except and allows for the accumulation of multiple errors when using <|> in parsing

• Added AsForeign class and combinators for writing values as Foreign (@puffnfresh)

This release is intended for the PureScript 0.9.1 compiler and newer.

Note: The v1.0.0 tag is not meant to indicate the library is “finished”, the core libraries are all being bumped to this for the 0.9 compiler release so as to use semver more correctly.

• Release candidate for the psc 0.8+ core libraries

• Fixed shadowed type variable warnings (@tfausak)

Fix a type error.

• Updated dependencies

• Updated dependencies

• Added IsForeign instances for Int and Char (@anttih)

This release works with versions 0.7.* of the PureScript compiler. It will not work with older versions. If you are using an older version, you should require an older, compatible version of this library.

Rename ! operator to ix.

Initial release candidate of the library intended for the 0.7 compiler.

• unsafeReadTagged is now exposed (@garyb)

Updated docs

This release requires PureScript v0.6.8 or later

• Updated dependencies

• Made dependency versions explicit (@garyb)

• Added ES3 fallbacks for Array.isArray and Object.keys (@davidchambers)

• IsForeign instance for Foreign. (@MichaelXavier)

Quite a few breaking changes to both names and types:

• A type for errors instead of using string concatenation.
• Breaking a few functions out into their own submodules.
• Adding types and instances to handle null-like values.
• Use the Either monad instead of the ForeignParser monad.

• Removed unused dependency on purescript-globals (@garyb)

• Removed ReadForeign Error instance after Error was removed from Global (@AitorATuin)

• Added index (@philopon)
• Rewrote some calls to runFnX to trigger inlining optimisation (@garyb)

• Updated FFI code to work for changes in codegen (@garyb)
• Added keys to read a list of key names from an object (@andreypopp)
• Fixed bug in prop that may have resulted in runtime errors when the object is null (@andreypopp)

• Added ReadForeign Error instance (garyb)