Skip to content

Latest commit

 

History

History
383 lines (252 loc) · 6.43 KB

CHANGELOG.md

File metadata and controls

383 lines (252 loc) · 6.43 KB
Raw

Changelog

v4.0.1 (2024-07-23)

Changed

Cbor.Decode

  • Fix maybe / oneOf combination not properly detecting Nothing branch.

v4.0.0 (2024-07-19)

Changed

Cbor

  • CborItem's variant CborInt has been split in two variants:

    • CborInt32 for ints that fits in an int32.
    • CborInt64 for larger integers.

    This change comes mainly as a fix to Cbor.Decode.any which would otherwise choke on integers in the range [2^53+1; 2^64-1] which is generally unsafe to manipulate in JavaScript (and by extension, Elm). Instead, we now represent large ints as two smallers 32-bit values when decoding.

v3.5.0 (2024-02-18)

Added

Cbor.Decode

  • New primitive fold, as an alternative for decoding record out of order.

    fold : Decoder k -> (k -> Decoder (state -> state)) -> state -> Decoder state

Changed

Cbor.Decode

  • record, fields and field are now properly working with out-of-order records. The API is identical, but the internal implementation has been fixed to support that case.

v3.4.0 (2023-12-11)

Added

Cbor.Decode

  • New primitive associativeList

    associativeList : Decoder k -> Decoder v -> Decoder (List ( k, v ))

v3.3.0 (2023-12-10)

Added

Cbor.Decode

  • New primitives keep and ignore to manually decode a data-structure.

     keep : Decoder a -> Decoder (a -> b) -> Decoder b

ignore : Decoder ignore -> Decoder keep -> Decoder keep

v3.2.0 (2023-12-03)

Added

Cbor

  • New data-type Sign to represent signed big integer values.

Cbor.Decode

  • New primitive oneOf to alternatively try decoders:

    oneOf : List (Decoder a) -> Decoder a

  • New primitive bigInt:

    bigint : Decoder (Sign, Bytes)

Changed

N/A

Removed

N/A

v3.1.0 (2023-12-03)

Added

Cbor.Decode

  • New primitive optionalElem for decoding tuples of variable length.

    optionalElem :
  Decoder field
  -> Decoder (Step Never (Maybe field -> steps))
  -> Decoder (Step Never steps)

Changed

Cbor.Decode

  • fail no longer fails eagerly, but at a later stage when needed. This fixes the use of partial decoder in conjunction with maybe.

Removed

N/A

v3.0.0 (2023-10-27)

Changed

Cbor

  • CborItem.CborTag now necessarily carries another tagged CborItem.

v2.1.0 (2023-10-27)

Added

Cbor.Decode

  • New primitive traverse:

    traverse :
    (a -> Decoder b)
    -> List a
    -> Decoder (List b)

Cbor.Encode

  • New primitive indefiniteList:

    indefiniteList :
    (a -> Encoder) -> List a -> Encoder

  • New primitive optionalElem:

    optionalElem :
    (elem -> Encoder)
    -> (tuple -> Maybe elem)
    -> Step Never tuple
    -> Step Never tuple

Fixed

  • Reviewed internal implementation of Cbor.Decode to, in particular, fix an issue with Cbor.Decode.andThen sometimes decoding more bytes than expected and causing decoder to fail prematurely.

v2.0.0 (2023-10-22)

Added

Cbor.Decode

  • New primitives for decoding tuples:

    tuple :
    steps
    -> (Step Never steps -> Decoder (Step Never tuple))
    -> Decoder tuple

elems :
    Step Never steps
    -> Decoder (Step Never steps)

elem :
    Decoder field
    -> Decoder (Step Never (field -> steps))
    -> Decoder (Step Never steps)

  • New primitives for decoding records:

    record :
    Decoder k
    -> steps
    -> (Step k steps -> Decoder (Step k record))
    -> Decoder record

fields :
    Step k steps
    -> Decoder (Step k steps)

field :
    k
    -> Decoder field
    -> Decoder (Step k (field -> steps))
    -> Decoder (Step k steps)

optionalField :
    k
    -> Decoder field
    -> Decoder (Step k (Maybe field -> steps))
    -> Decoder (Step k steps)

  • New primitives for manually decoding definite & indefinite structures:

    length : Decoder Int
size : Decoder Int

beginBytes : Decoder ()
beginDict : Decoder ()
beginList : Decoder ()
beginString : Decoder ()
break : Decoder ()

  • New helpers for combining decoders:

    ignoreThen : Decoder a -> Decoder ignored -> Decoder a
thenIgnore : Decoder ignored -> Decoder a -> Decoder a

Cbor.Encode

  • New primitives for encoding tuples:

    tuple :
    (Step Never tuple
    -> Step Never tuple)
    -> tuple
    -> Encoder

elems :
    Step Never tuple
    -> Step Never tuple
elem :
    (elem -> Encoder)
    -> (tuple -> elem)
    -> Step Never tuple
    -> Step Never tuple

  • New primitives for encoding records:

    record :
    (k -> Encoder)
    -> (Step k record -> Step k record)
    -> record
    -> Encoder


fields :
    Step k record
    -> Step k record

field :
    k
    -> (field -> Encoder)
    -> (record -> field)
    -> Step k record
    -> Step k record

optionalField :
    k
    -> (field -> Encoder)
    -> (record -> Maybe field)
    -> Step k record
    -> Step k record

  • New primitives for manually encoding definite structures:

    size : Int -> Encoder
length : Int -> Encoder

  • New helper for optionally encoding values:

    maybe : (a -> Encoder) -> Maybe a -> Encoder

Changed

Cbor.Decode

  • Changed record as described in the previous section.

Cbor.Encode

  • Renamed beginStrings into beginString.
  • Renamed pair into keyValue.
  • Renamed keyValueMap into associativeList.

Removed

Cbor.Decode

  • Removed array, made obsolete by the new (more flexible) additions.

v1.1.0 (2021-08-03)

Added

Cbor

  • New module Cbor exposing a generic CborItem sum-type.

Cbor.Decode

  • New primitives added (see #1):

    keyValueMap : Decoder k -> Decoder v -> Decoder (List ( k, v ))

array : Decoder a -> Decoder a
record : Decoder a -> Decoder a

any : Decoder CborItem
raw : Decoder Bytes

Cbor.Encode

  • New primitives added:

    keyValueMap : (k -> Encoder) -> (v -> Encoder) -> List ( k, v ) -> Encoder

undefined : Encoder

any : CborItem -> Encoder
raw : Bytes -> Encoder

Changed

N/A

Removed

N/A

v1.0.0 (2019-05-07)

Added

  • Initial RFC-7049 implementation
  • Provide unit & fuzz tests
  • Initial README with example usage

Changed

N/A

Removed

N/A