-- Hoogle documentation, generated by Haddock
-- See Hoogle, http://www.haskell.org/hoogle/

-- | Extract and apply patches to JSON documents.
--   
--   This is a small library for working with changes to JSON documents. It
--   includes a library and two command-line executables in the style of
--   the diff(1) and patch(1) commands available on many systems.
@package aeson-diff
@version 1.1.0.13

module Data.Aeson.Pointer

-- | Pointer to a location in a JSON document.
--   
--   Defined in RFC 6901 http://tools.ietf.org/html/rfc6901
newtype Pointer
Pointer :: Path -> Pointer
[pointerPath] :: Pointer -> Path

-- | Path components to traverse a single layer of a JSON document.
data Key

-- | Traverse a Value with an Object constructor.
OKey :: Key -> Key

-- | Traverse a Value with an Array constructor.
AKey :: Int -> Key

-- | A sequence of Keys forms a path through a JSON document.
type Path = [Key]

-- | Format a Pointer as described in RFC 6901.
--   
--   
--   >>> formatPointer (Pointer [])
--   ""
--   
--   >>> formatPointer (Pointer [OKey ""])
--   "/"
--   
--   >>> formatPointer (Pointer [OKey " "])
--   "/ "
--   
--   >>> formatPointer (Pointer [OKey "foo"])
--   "/foo"
--   
--   >>> formatPointer (Pointer [OKey "foo", AKey 0])
--   "/foo/0"
--   
--   >>> formatPointer (Pointer [OKey "a/b"])
--   "/a~1b"
--   
--   >>> formatPointer (Pointer [OKey "c%d"])
--   "/c%d"
--   
--   >>> formatPointer (Pointer [OKey "e^f"])
--   "/e^f"
--   
--   >>> formatPointer (Pointer [OKey "g|h"])
--   "/g|h"
--   
--   >>> formatPointer (Pointer [OKey "i\\j"])
--   "/i\\j"
--   
--   >>> formatPointer (Pointer [OKey "k\"l"])
--   "/k\"l"
--   
--   >>> formatPointer (Pointer [OKey "m~n"])
--   "/m~0n"
--   
formatPointer :: Pointer -> Text

-- | Parse a Pointer as described in RFC 6901.
parsePointer :: Text -> Parser Pointer

-- | Follow a Pointer through a JSON document as described in RFC
--   6901.
get :: Pointer -> Value -> Result Value

-- | Report an error while following a pointer.
pointerFailure :: Pointer -> Value -> Result a
instance GHC.Classes.Eq Data.Aeson.Pointer.Key
instance GHC.Classes.Eq Data.Aeson.Pointer.Pointer
instance Data.Aeson.Types.FromJSON.FromJSON Data.Aeson.Pointer.Key
instance Data.Aeson.Types.FromJSON.FromJSON Data.Aeson.Pointer.Pointer
instance GHC.Internal.Generics.Generic Data.Aeson.Pointer.Key
instance GHC.Internal.Generics.Generic Data.Aeson.Pointer.Pointer
instance GHC.Internal.Base.Monoid Data.Aeson.Pointer.Pointer
instance GHC.Classes.Ord Data.Aeson.Pointer.Key
instance GHC.Classes.Ord Data.Aeson.Pointer.Pointer
instance GHC.Internal.Base.Semigroup Data.Aeson.Pointer.Pointer
instance GHC.Internal.Show.Show Data.Aeson.Pointer.Key
instance GHC.Internal.Show.Show Data.Aeson.Pointer.Pointer
instance Data.Aeson.Types.ToJSON.ToJSON Data.Aeson.Pointer.Key
instance Data.Aeson.Types.ToJSON.ToJSON Data.Aeson.Pointer.Pointer

module Data.Aeson.Patch

-- | Describes the changes between two JSON documents.
newtype Patch
Patch :: [Operation] -> Patch
[patchOperations] :: Patch -> [Operation]

-- | An Operation describes the operations which can appear as part
--   of a JSON Patch.
--   
--   See RFC 6902 Section 4
--   http://tools.ietf.org/html/rfc6902#section-4.
data Operation

-- | http://tools.ietf.org/html/rfc6902#section-4.1
Add :: Pointer -> Value -> Operation
[changePointer] :: Operation -> Pointer
[changeValue] :: Operation -> Value

-- | http://tools.ietf.org/html/rfc6902#section-4.5
Cpy :: Pointer -> Pointer -> Operation
[changePointer] :: Operation -> Pointer
[fromPointer] :: Operation -> Pointer

-- | http://tools.ietf.org/html/rfc6902#section-4.4
Mov :: Pointer -> Pointer -> Operation
[changePointer] :: Operation -> Pointer
[fromPointer] :: Operation -> Pointer

-- | http://tools.ietf.org/html/rfc6902#section-4.2
Rem :: Pointer -> Operation
[changePointer] :: Operation -> Pointer

-- | http://tools.ietf.org/html/rfc6902#section-4.3
Rep :: Pointer -> Value -> Operation
[changePointer] :: Operation -> Pointer
[changeValue] :: Operation -> Value

-- | http://tools.ietf.org/html/rfc6902#section-4.6
Tst :: Pointer -> Value -> Operation
[changePointer] :: Operation -> Pointer
[changeValue] :: Operation -> Value

-- | Modify the Pointers in an Operation.
--   
--   If the operation contains multiple pointers (i.e. a Mov or
--   Cpy) then both will be modified.
modifyPointer :: (Pointer -> Pointer) -> Operation -> Operation

-- | Modify the pointers in the Operations of a Patch.
--   
--   See modifyPointer for details.
modifyPointers :: (Pointer -> Pointer) -> Patch -> Patch
isAdd :: Operation -> Bool
isRem :: Operation -> Bool
isRep :: Operation -> Bool
isMov :: Operation -> Bool
isCpy :: Operation -> Bool
isTst :: Operation -> Bool
instance GHC.Classes.Eq Data.Aeson.Patch.Operation
instance GHC.Classes.Eq Data.Aeson.Patch.Patch
instance Data.Aeson.Types.FromJSON.FromJSON Data.Aeson.Patch.Operation
instance Data.Aeson.Types.FromJSON.FromJSON Data.Aeson.Patch.Patch
instance GHC.Internal.Generics.Generic Data.Aeson.Patch.Operation
instance GHC.Internal.Generics.Generic Data.Aeson.Patch.Patch
instance GHC.Internal.Base.Monoid Data.Aeson.Patch.Patch
instance GHC.Internal.Base.Semigroup Data.Aeson.Patch.Patch
instance GHC.Internal.Show.Show Data.Aeson.Patch.Operation
instance GHC.Internal.Show.Show Data.Aeson.Patch.Patch
instance Data.Aeson.Types.ToJSON.ToJSON Data.Aeson.Patch.Operation
instance Data.Aeson.Types.ToJSON.ToJSON Data.Aeson.Patch.Patch

-- | This module implements data types and operations to represent the
--   differences between JSON documents (i.e. a patch), to compare JSON
--   documents and extract such a patch, and to apply such a patch to a
--   JSON document.
module Data.Aeson.Diff

-- | Describes the changes between two JSON documents.
newtype Patch
Patch :: [Operation] -> Patch

-- | Pointer to a location in a JSON document.
--   
--   Defined in RFC 6901 http://tools.ietf.org/html/rfc6901
data Pointer

-- | Path components to traverse a single layer of a JSON document.
data Key

-- | Traverse a Value with an Object constructor.
OKey :: Key -> Key

-- | Traverse a Value with an Array constructor.
AKey :: Int -> Key

-- | An Operation describes the operations which can appear as part
--   of a JSON Patch.
--   
--   See RFC 6902 Section 4
--   http://tools.ietf.org/html/rfc6902#section-4.
data Operation

-- | http://tools.ietf.org/html/rfc6902#section-4.1
Add :: Pointer -> Value -> Operation
[changePointer] :: Operation -> Pointer
[changeValue] :: Operation -> Value

-- | http://tools.ietf.org/html/rfc6902#section-4.5
Cpy :: Pointer -> Pointer -> Operation

-- | http://tools.ietf.org/html/rfc6902#section-4.4
Mov :: Pointer -> Pointer -> Operation

-- | http://tools.ietf.org/html/rfc6902#section-4.2
Rem :: Pointer -> Operation
[changePointer] :: Operation -> Pointer

-- | http://tools.ietf.org/html/rfc6902#section-4.3
Rep :: Pointer -> Value -> Operation
[changePointer] :: Operation -> Pointer
[changeValue] :: Operation -> Value

-- | http://tools.ietf.org/html/rfc6902#section-4.6
Tst :: Pointer -> Value -> Operation
[changePointer] :: Operation -> Pointer
[changeValue] :: Operation -> Value

-- | Configuration for the diff algorithm.
newtype Config
Config :: Bool -> Config
[configTstBeforeRem] :: Config -> Bool

-- | Compare two JSON documents and generate a patch describing the
--   differences.
--   
--   Uses the defaultConfig.
diff :: Value -> Value -> Patch

-- | Compare two JSON documents and generate a patch describing the
--   differences.
diff' :: Config -> Value -> Value -> Patch

-- | Apply a patch to a JSON document.
patch :: Patch -> Value -> Result Value

-- | Apply an Operation to a Value.
applyOperation :: Operation -> Value -> Result Value
