safe-json

Automatic JSON format versioning

https://github.com/Vlix/safe-json#readme

Version on this page:1.1.4.0@rev:2
LTS Haskell 23.24:1.2.1.0
Stackage Nightly 2025-06-15:1.2.1.0
Latest on Hackage:1.2.1.0

See all snapshots safe-json appears in

MIT licensed by Felix Paulusma
Maintained by [email protected]
This version can be pinned in stack with:safe-json-1.1.4.0@sha256:7a2fe969016d5d1511a43168bd87aa91c17eb5df3107de99352c8ac7300d082b,4158

Module documentation for 1.1.4.0

This library aims to make the updating of JSON formats or contents, while keeping backward compatibility, as painless as possible. The way this is achieved is through versioning and defined migration functions to migrate older (or newer) versions to the one used.

The library mainly consists of two classes:

  • SafeJSON a: Defines the version of a and if (and how) it is migratable.

  • Migrate a: Defines the data type (MigrateFrom a) that can be migrated to a and how to migrate from that type.

Using these two classes, JSON serialized data types will stay parsable, even after format changes.

For a more in-depth explanation and examples, please see the README at https://github.com/Vlix/safe-json#readme

Changes

Changelog for safe-json

1.1.4.0

  • Compatibility with GHC 9.4.*, and aeson < 2.3

1.1.3.1

  • Compatibility with GHC 9.2.*, and time < 0.13

1.1.3.0

  • Compatibility with aeson < 2.1 and text < 2.1 #33 Thanks to @ysangkok
  • Compatibility with bytestring < 0.12.

1.1.2.0

  • Aeson <= 2.0.2.0 compatibility (https://cs-syd.eu/posts/2021-09-11-json-vulnerability)
    • Fix internal code to work with new Key and KeyMap from aeson-2.0.0.0 #28 Thanks to @dysinger
    • Added SafeJSON instances for Key and KeyMap #29
    • Added SafeJSON instances for Compose, Product and Sum #29

1.1.1.1

  • loosened dependecy restriction on tasty
  • fixed some documentation

1.1.1

  • Fix clash in test/Instances.hs of Ord instance for Data.Aeson.Value #23

1.1.0

  • update for GHC 8.8.1 #15
    • loosened dependency restriction on time
    • fixed instance for IntMap
  • DRY-er TestMigrate and TestReverseMigrate type synonyms #17 Thanks to @blinkytoy
  • fixed documentation #17 Thanks to @blinkytoy
    • broken links to modules
    • setVersion’s documentation only showing half

1.0.0

  • Removed FromJSON/ToJSON dependecy on SafeJSON
    • Default implementation of safeFrom and safeTo unchanged, still require FromJSON and ToJSON
  • Added unsafe setVersion and removeVersion functions.
  • Integrated Data.SafeJSON.Instances into Data.SafeJSON.Internal
  • Some documentation cleanup/fixes
  • Added convenience functions for defining safeFrom and safeTo
    • e.g. containWithObject, (.:$), (.=$), etc.

0.1.0

  • First release. Includes:
    • Data.Aeson.Safe
    • Data.SafeJSON
    • Data.SafeJSON.Instances
    • Data.SafeJSON.Internal
    • Data.SafeJSON.Test