comparing 15e3a1dfdc0562b0073c3e4edd2eb45785725d1c and main on anil.recoil.org/ocaml-jsonfeed

.ocamlformat

···

       0

···

       1
       +
       version=0.27.0

.tangled/workflows/build.yml

···

       26
        
           - bzip2

     

       27
        
           - gcc

     

       28
        
           - ocaml

     

       0
        
       
     

       29
        
       

     

       30
        
       steps:

     

       31
        
         - name: opam

···

       26
        
           - bzip2

     

       27
        
           - gcc

     

       28
        
           - ocaml

     

       29
       +
           - pkg-config

     

       30
        
       

     

       31
        
       steps:

     

       32
        
         - name: opam

+11

CHANGES.md

···

       1
       +
       v1.1.0 (2025-11-12)

     

       2
       +
       -------------------

     

       3
       +
       

     

       4
       +
       - Simplify round trip processing of unknown messages using Jsont combinators (@avsm).

     

       5
       +
       - Relax alcotest version constraints (@avsm).

     

       6
       +
       

     

       7
       +
       v1.0.0 (2025-11-12)

     

       8
       +
       -------------------

     

       9
       +
       

     

       10
       +
       - Initial public release (@avsm)

     

       11
       +

+11 -1

README.md

···

       133
        
       - **feed_example.ml** - Creating and serializing feeds (blog and podcast)

     

       134
        
       - **feed_parser.ml** - Parsing and analyzing feeds from files

     

       135
        
       - **feed_validator.ml** - Validating feeds and demonstrating various feed types

     

       0
        
       
     

       136
        
       

     

       137
        
       Run examples:

     

       138
        
       

     

       139
        
       ```bash

     

       140
       -
       opam exec -- dune exec -- ./example/feed_parser.exe

     

       141
        
       opam exec -- dune exec -- ./example/feed_example.exe

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       142
        
       ```

     

       143
        
       

     

       144
        
       ## API Documentation

···

       133
        
       - **feed_example.ml** - Creating and serializing feeds (blog and podcast)

     

       134
        
       - **feed_parser.ml** - Parsing and analyzing feeds from files

     

       135
        
       - **feed_validator.ml** - Validating feeds and demonstrating various feed types

     

       136
       +
       - **feed_echo.ml** - Round-trip parsing: reads a feed from stdin and outputs to stdout

     

       137
        
       

     

       138
        
       Run examples:

     

       139
        
       

     

       140
        
       ```bash

     

       141
       +
       # Create and display sample feeds

     

       142
        
       opam exec -- dune exec -- ./example/feed_example.exe

     

       143
       +
       

     

       144
       +
       # Parse and analyze a feed file

     

       145
       +
       opam exec -- dune exec -- ./example/feed_parser.exe path/to/feed.json

     

       146
       +
       

     

       147
       +
       # Validate feeds

     

       148
       +
       opam exec -- dune exec -- ./example/feed_validator.exe

     

       149
       +
       

     

       150
       +
       # Test round-trip parsing

     

       151
       +
       cat feed.json | opam exec -- dune exec -- ./example/feed_echo.exe

     

       152
        
       ```

     

       153
        
       

     

       154
        
       ## API Documentation

+3 -3

dune-project

···

       21
        
          and serialization using Jsonm and Ptime.")

     

       22
        
        (depends

     

       23
        
         (ocaml (>= 5.2.0))

     

       24
       -
         (jsonm (>= 1.0.0))

     

       25
        
         (ptime (>= 1.2.0))

     

       26
       -
         (fmt (>= 0.11.0))

     

       27
        
         (odoc :with-doc)

     

       28
       -
         (alcotest (and :with-test (>= 1.9.0)))))

···

       21
        
          and serialization using Jsonm and Ptime.")

     

       22
        
        (depends

     

       23
        
         (ocaml (>= 5.2.0))

     

       24
       +
         (jsont (>= 0.2.0))

     

       25
        
         (ptime (>= 1.2.0))

     

       26
       +
         bytesrw

     

       27
        
         (odoc :with-doc)

     

       28
       +
         (alcotest (and :with-test (>= 1.5.0)))))

+4 -3

jsonfeed.opam

···

       11
        
       depends: [

     

       12
        
         "dune" {>= "3.18"}

     

       13
        
         "ocaml" {>= "5.2.0"}

     

       14
       -
         "jsonm" {>= "1.0.0"}

     

       15
        
         "ptime" {>= "1.2.0"}

     

       16
       -
         "fmt" {>= "0.11.0"}

     

       17
        
         "odoc" {with-doc}

     

       18
       -
         "alcotest" {with-test & >= "1.9.0"}

     

       19
        
       ]

     

       20
        
       build: [

     

       21
        
         ["dune" "subst"] {dev}

     
···

       32
        
         ]

     

       33
        
       ]

     

       34
        
       x-maintenance-intent: ["(latest)"]

     

       0

···

       11
        
       depends: [

     

       12
        
         "dune" {>= "3.18"}

     

       13
        
         "ocaml" {>= "5.2.0"}

     

       14
       +
         "jsont" {>= "0.2.0"}

     

       15
        
         "ptime" {>= "1.2.0"}

     

       16
       +
         "bytesrw"

     

       17
        
         "odoc" {with-doc}

     

       18
       +
         "alcotest" {with-test & >= "1.5.0"}

     

       19
        
       ]

     

       20
        
       build: [

     

       21
        
         ["dune" "subst"] {dev}

     
···

       32
        
         ]

     

       33
        
       ]

     

       34
        
       x-maintenance-intent: ["(latest)"]

     

       35
       +
       dev-repo: "git+https://tangled.sh/@anil.recoil.org/ocaml-jsonfeed"

jsonfeed.opam.template

···

       0

···

       1
       +
       dev-repo: "git+https://tangled.sh/@anil.recoil.org/ocaml-jsonfeed"

+12 -37

lib/attachment.ml

···

       4
        
         ---------------------------------------------------------------------------*)

     

       5
        
       

     

       6
        
       module Unknown = struct

     

       7
       -
         type t = (string * Jsont.json) list

     

       8
        
       

     

       9
       -
         let empty = []

     

       10
       -
         let is_empty = function [] -> true | _ -> false

     

       11
        
       end

     

       12
        
       

     

       13
        
       type t = {

     
···

       46
        
       

     

       47
        
         Format.fprintf ppf "%s (%s" filename t.mime_type;

     

       48
        
       

     

       49
       -
         (match t.size_in_bytes with

     

       50
       -
         | Some size ->

     

       51
        
             let mb = Int64.to_float size /. (1024. *. 1024.) in

     

       52
       -
             Format.fprintf ppf ", %.1f MB" mb

     

       53
       -
         | None -> ());

     

       54
        
       

     

       55
       -
         (match t.duration_in_seconds with

     

       56
       -
         | Some duration ->

     

       57
        
             let mins = duration / 60 in

     

       58
        
             let secs = duration mod 60 in

     

       59
       -
             Format.fprintf ppf ", %dm%ds" mins secs

     

       60
       -
         | None -> ());

     

       61
        
       

     

       62
        
         Format.fprintf ppf ")"

     

       63
        
       

     

       64
        
       let jsont =

     

       65
        
         let kind = "Attachment" in

     

       66
        
         let doc = "An attachment object" in

     

       67
       -
         let unknown_mems :

     

       68
       -
             (Unknown.t, Jsont.json, Jsont.mem list) Jsont.Object.Mems.map =

     

       69
       -
           let open Jsont.Object.Mems in

     

       70
       -
           let dec_empty () = [] in

     

       71
       -
           let dec_add _meta (name : string) value acc =

     

       72
       -
             ((name, Jsont.Meta.none), value) :: acc

     

       73
       -
           in

     

       74
       -
           let dec_finish _meta mems =

     

       75
       -
             List.rev_map (fun ((name, _meta), value) -> (name, value)) mems

     

       76
       -
           in

     

       77
       -
           let enc =

     

       78
       -
             {

     

       79
       -
               enc =

     

       80
       -
                 (fun (type acc)

     

       81
       -
                   (f : Jsont.Meta.t -> string -> Jsont.json -> acc -> acc)

     

       82
       -
                   unknown

     

       83
       -
                   (acc : acc)

     

       84
       -
                 ->

     

       85
       -
                   List.fold_left

     

       86
       -
                     (fun acc (name, value) -> f Jsont.Meta.none name value acc)

     

       87
       -
                     acc unknown);

     

       88
       -
             }

     

       89
       -
           in

     

       90
       -
           map ~kind:"Unknown members" Jsont.json ~dec_empty ~dec_add ~dec_finish ~enc

     

       91
       -
         in

     

       92
        
         let create_obj url mime_type title size_in_bytes duration_in_seconds unknown =

     

       93
        
           create ~url ~mime_type ?title ?size_in_bytes ?duration_in_seconds ~unknown

     

       94
        
             ()

     
···

       100
        
         |> Jsont.Object.opt_mem "size_in_bytes" Jsont.int64 ~enc:size_in_bytes

     

       101
        
         |> Jsont.Object.opt_mem "duration_in_seconds" Jsont.int

     

       102
        
              ~enc:duration_in_seconds

     

       103
       -
         |> Jsont.Object.keep_unknown unknown_mems ~enc:unknown

     

       104
        
         |> Jsont.Object.finish

···

       4
        
         ---------------------------------------------------------------------------*)

     

       5
        
       

     

       6
        
       module Unknown = struct

     

       7
       +
         type t = Jsont.json

     

       8
        
       

     

       9
       +
         let empty = Jsont.Object ([], Jsont.Meta.none)

     

       10
       +
         let is_empty = function Jsont.Object ([], _) -> true | _ -> false

     

       11
        
       end

     

       12
        
       

     

       13
        
       type t = {

     
···

       46
        
       

     

       47
        
         Format.fprintf ppf "%s (%s" filename t.mime_type;

     

       48
        
       

     

       49
       +
         Option.iter

     

       50
       +
           (fun size ->

     

       51
        
             let mb = Int64.to_float size /. (1024. *. 1024.) in

     

       52
       +
             Format.fprintf ppf ", %.1f MB" mb)

     

       53
       +
           t.size_in_bytes;

     

       54
        
       

     

       55
       +
         Option.iter

     

       56
       +
           (fun duration ->

     

       57
        
             let mins = duration / 60 in

     

       58
        
             let secs = duration mod 60 in

     

       59
       +
             Format.fprintf ppf ", %dm%ds" mins secs)

     

       60
       +
           t.duration_in_seconds;

     

       61
        
       

     

       62
        
         Format.fprintf ppf ")"

     

       63
        
       

     

       64
        
       let jsont =

     

       65
        
         let kind = "Attachment" in

     

       66
        
         let doc = "An attachment object" in

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       67
        
         let create_obj url mime_type title size_in_bytes duration_in_seconds unknown =

     

       68
        
           create ~url ~mime_type ?title ?size_in_bytes ?duration_in_seconds ~unknown

     

       69
        
             ()

     
···

       75
        
         |> Jsont.Object.opt_mem "size_in_bytes" Jsont.int64 ~enc:size_in_bytes

     

       76
        
         |> Jsont.Object.opt_mem "duration_in_seconds" Jsont.int

     

       77
        
              ~enc:duration_in_seconds

     

       78
       +
         |> Jsont.Object.keep_unknown Jsont.json_mems ~enc:unknown

     

       79
        
         |> Jsont.Object.finish

+4 -4

lib/attachment.mli

···

       1
        
       (*---------------------------------------------------------------------------

     

       2
       -
          Copyright (c) 2024 Anil Madhavapeddy. All rights reserved.

     

       3
        
          SPDX-License-Identifier: ISC

     

       4
        
         ---------------------------------------------------------------------------*)

     

       5
        
       

     
···

       18
        
       (** {1 Unknown Fields} *)

     

       19
        
       

     

       20
        
       module Unknown : sig

     

       21
       -
         type t = (string * Jsont.json) list

     

       22
       -
         (** Unknown/unrecognized JSON object members. Useful for preserving fields

     

       23
       -
             from custom extensions or future spec versions. *)

     

       24
        
       

     

       25
        
         val empty : t

     

       26
        
         (** [empty] is the empty list of unknown fields. *)

···

       1
        
       (*---------------------------------------------------------------------------

     

       2
       +
          Copyright (c) 2025 Anil Madhavapeddy. All rights reserved.

     

       3
        
          SPDX-License-Identifier: ISC

     

       4
        
         ---------------------------------------------------------------------------*)

     

       5
        
       

     
···

       18
        
       (** {1 Unknown Fields} *)

     

       19
        
       

     

       20
        
       module Unknown : sig

     

       21
       +
         type t = Jsont.json

     

       22
       +
         (** Unknown/unrecognized JSON object members as a generic JSON object. Useful

     

       23
       +
             for preserving fields from custom extensions or future spec versions. *)

     

       24
        
       

     

       25
        
         val empty : t

     

       26
        
         (** [empty] is the empty list of unknown fields. *)

+4 -30

lib/author.ml

···

       4
        
         ---------------------------------------------------------------------------*)

     

       5
        
       

     

       6
        
       module Unknown = struct

     

       7
       -
         type t = (string * Jsont.json) list

     

       8
        
       

     

       9
       -
         let empty = []

     

       10
       -
         let is_empty = function [] -> true | _ -> false

     

       11
        
       end

     

       12
        
       

     

       13
        
       type t = {

     
···

       44
        
       let jsont =

     

       45
        
         let kind = "Author" in

     

       46
        
         let doc = "An author object with at least one field set" in

     

       47
       -
         (* Custom mems map for Unknown.t that strips metadata from names *)

     

       48
       -
         let unknown_mems :

     

       49
       -
             (Unknown.t, Jsont.json, Jsont.mem list) Jsont.Object.Mems.map =

     

       50
       -
           let open Jsont.Object.Mems in

     

       51
       -
           let dec_empty () = [] in

     

       52
       -
           let dec_add _meta (name : string) value acc =

     

       53
       -
             ((name, Jsont.Meta.none), value) :: acc

     

       54
       -
           in

     

       55
       -
           let dec_finish _meta mems =

     

       56
       -
             List.rev_map (fun ((name, _meta), value) -> (name, value)) mems

     

       57
       -
           in

     

       58
       -
           let enc =

     

       59
       -
             {

     

       60
       -
               enc =

     

       61
       -
                 (fun (type acc)

     

       62
       -
                   (f : Jsont.Meta.t -> string -> Jsont.json -> acc -> acc)

     

       63
       -
                   unknown

     

       64
       -
                   (acc : acc)

     

       65
       -
                 ->

     

       66
       -
                   List.fold_left

     

       67
       -
                     (fun acc (name, value) -> f Jsont.Meta.none name value acc)

     

       68
       -
                     acc unknown);

     

       69
       -
             }

     

       70
       -
           in

     

       71
       -
           map ~kind:"Unknown members" Jsont.json ~dec_empty ~dec_add ~dec_finish ~enc

     

       72
       -
         in

     

       73
        
         (* Constructor that matches the jsont object map pattern *)

     

       74
        
         let create_obj name url avatar unknown =

     

       75
        
           create ?name ?url ?avatar ~unknown ()

     
···

       78
        
         |> Jsont.Object.opt_mem "name" Jsont.string ~enc:name

     

       79
        
         |> Jsont.Object.opt_mem "url" Jsont.string ~enc:url

     

       80
        
         |> Jsont.Object.opt_mem "avatar" Jsont.string ~enc:avatar

     

       81
       -
         |> Jsont.Object.keep_unknown unknown_mems ~enc:unknown

     

       82
        
         |> Jsont.Object.finish

···

       4
        
         ---------------------------------------------------------------------------*)

     

       5
        
       

     

       6
        
       module Unknown = struct

     

       7
       +
         type t = Jsont.json

     

       8
        
       

     

       9
       +
         let empty = Jsont.Object ([], Jsont.Meta.none)

     

       10
       +
         let is_empty = function Jsont.Object ([], _) -> true | _ -> false

     

       11
        
       end

     

       12
        
       

     

       13
        
       type t = {

     
···

       44
        
       let jsont =

     

       45
        
         let kind = "Author" in

     

       46
        
         let doc = "An author object with at least one field set" in

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       47
        
         (* Constructor that matches the jsont object map pattern *)

     

       48
        
         let create_obj name url avatar unknown =

     

       49
        
           create ?name ?url ?avatar ~unknown ()

     
···

       52
        
         |> Jsont.Object.opt_mem "name" Jsont.string ~enc:name

     

       53
        
         |> Jsont.Object.opt_mem "url" Jsont.string ~enc:url

     

       54
        
         |> Jsont.Object.opt_mem "avatar" Jsont.string ~enc:avatar

     

       55
       +
         |> Jsont.Object.keep_unknown Jsont.json_mems ~enc:unknown

     

       56
        
         |> Jsont.Object.finish

+4 -4

lib/author.mli

···

       1
        
       (*---------------------------------------------------------------------------

     

       2
       -
          Copyright (c) 2024 Anil Madhavapeddy. All rights reserved.

     

       3
        
          SPDX-License-Identifier: ISC

     

       4
        
         ---------------------------------------------------------------------------*)

     

       5
        
       

     
···

       17
        
       (** {1 Unknown Fields} *)

     

       18
        
       

     

       19
        
       module Unknown : sig

     

       20
       -
         type t = (string * Jsont.json) list

     

       21
       -
         (** Unknown/unrecognized JSON object members. Useful for preserving fields

     

       22
       -
             from custom extensions or future spec versions. *)

     

       23
        
       

     

       24
        
         val empty : t

     

       25
        
         (** [empty] is the empty list of unknown fields. *)

···

       1
        
       (*---------------------------------------------------------------------------

     

       2
       +
          Copyright (c) 2025 Anil Madhavapeddy. All rights reserved.

     

       3
        
          SPDX-License-Identifier: ISC

     

       4
        
         ---------------------------------------------------------------------------*)

     

       5
        
       

     
···

       17
        
       (** {1 Unknown Fields} *)

     

       18
        
       

     

       19
        
       module Unknown : sig

     

       20
       +
         type t = Jsont.json

     

       21
       +
         (** Unknown/unrecognized JSON object members as a generic JSON object. Useful

     

       22
       +
             for preserving fields from custom extensions or future spec versions. *)

     

       23
        
       

     

       24
        
         val empty : t

     

       25
        
         (** [empty] is the empty list of unknown fields. *)

+1 -3

lib/cito.ml

···

       158
        
       let jsont =

     

       159
        
         let kind = "CiTO intent" in

     

       160
        
         let doc = "A Citation Typing Ontology intent annotation" in

     

       161
       -
         let dec = of_string in

     

       162
       -
         let enc = to_string in

     

       163
       -
         Jsont.map ~kind ~doc ~dec ~enc Jsont.string

···

       158
        
       let jsont =

     

       159
        
         let kind = "CiTO intent" in

     

       160
        
         let doc = "A Citation Typing Ontology intent annotation" in

     

       161
       +
         Jsont.map ~kind ~doc ~dec:of_string ~enc:to_string Jsont.string

     

       0
        
       
     

       0

lib/cito.mli

···

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       1
        
       (** Citation Typing Ontology (CiTO) intent annotations.

     

       2
        
       

     

       3
        
           CiTO provides a structured vocabulary for describing the nature of

···

       1
       +
       (*---------------------------------------------------------------------------

     

       2
       +
          Copyright (c) 2025 Anil Madhavapeddy. All rights reserved.

     

       3
       +
          SPDX-License-Identifier: ISC

     

       4
       +
         ---------------------------------------------------------------------------*)

     

       5
       +
       

     

       6
        
       (** Citation Typing Ontology (CiTO) intent annotations.

     

       7
        
       

     

       8
        
           CiTO provides a structured vocabulary for describing the nature of

+4 -29

lib/hub.ml

···

       4
        
         ---------------------------------------------------------------------------*)

     

       5
        
       

     

       6
        
       module Unknown = struct

     

       7
       -
         type t = (string * Jsont.json) list

     

       8
        
       

     

       9
       -
         let empty = []

     

       10
       -
         let is_empty = function [] -> true | _ -> false

     

       11
        
       end

     

       12
        
       

     

       13
        
       type t = { type_ : string; url : string; unknown : Unknown.t }

     
···

       22
        
       let jsont =

     

       23
        
         let kind = "Hub" in

     

       24
        
         let doc = "A hub endpoint" in

     

       25
       -
         let unknown_mems :

     

       26
       -
             (Unknown.t, Jsont.json, Jsont.mem list) Jsont.Object.Mems.map =

     

       27
       -
           let open Jsont.Object.Mems in

     

       28
       -
           let dec_empty () = [] in

     

       29
       -
           let dec_add _meta (name : string) value acc =

     

       30
       -
             ((name, Jsont.Meta.none), value) :: acc

     

       31
       -
           in

     

       32
       -
           let dec_finish _meta mems =

     

       33
       -
             List.rev_map (fun ((name, _meta), value) -> (name, value)) mems

     

       34
       -
           in

     

       35
       -
           let enc =

     

       36
       -
             {

     

       37
       -
               enc =

     

       38
       -
                 (fun (type acc)

     

       39
       -
                   (f : Jsont.Meta.t -> string -> Jsont.json -> acc -> acc)

     

       40
       -
                   unknown

     

       41
       -
                   (acc : acc)

     

       42
       -
                 ->

     

       43
       -
                   List.fold_left

     

       44
       -
                     (fun acc (name, value) -> f Jsont.Meta.none name value acc)

     

       45
       -
                     acc unknown);

     

       46
       -
             }

     

       47
       -
           in

     

       48
       -
           map ~kind:"Unknown members" Jsont.json ~dec_empty ~dec_add ~dec_finish ~enc

     

       49
       -
         in

     

       50
        
         let create_obj type_ url unknown = create ~type_ ~url ~unknown () in

     

       51
        
         Jsont.Object.map ~kind ~doc create_obj

     

       52
        
         |> Jsont.Object.mem "type" Jsont.string ~enc:type_

     

       53
        
         |> Jsont.Object.mem "url" Jsont.string ~enc:url

     

       54
       -
         |> Jsont.Object.keep_unknown unknown_mems ~enc:unknown

     

       55
        
         |> Jsont.Object.finish

···

       4
        
         ---------------------------------------------------------------------------*)

     

       5
        
       

     

       6
        
       module Unknown = struct

     

       7
       +
         type t = Jsont.json

     

       8
        
       

     

       9
       +
         let empty = Jsont.Object ([], Jsont.Meta.none)

     

       10
       +
         let is_empty = function Jsont.Object ([], _) -> true | _ -> false

     

       11
        
       end

     

       12
        
       

     

       13
        
       type t = { type_ : string; url : string; unknown : Unknown.t }

     
···

       22
        
       let jsont =

     

       23
        
         let kind = "Hub" in

     

       24
        
         let doc = "A hub endpoint" in

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       25
        
         let create_obj type_ url unknown = create ~type_ ~url ~unknown () in

     

       26
        
         Jsont.Object.map ~kind ~doc create_obj

     

       27
        
         |> Jsont.Object.mem "type" Jsont.string ~enc:type_

     

       28
        
         |> Jsont.Object.mem "url" Jsont.string ~enc:url

     

       29
       +
         |> Jsont.Object.keep_unknown Jsont.json_mems ~enc:unknown

     

       30
        
         |> Jsont.Object.finish

+3 -3

lib/hub.mli

···

       17
        
       (** {1 Unknown Fields} *)

     

       18
        
       

     

       19
        
       module Unknown : sig

     

       20
       -
         type t = (string * Jsont.json) list

     

       21
       -
         (** Unknown/unrecognized JSON object members. Useful for preserving fields

     

       22
       -
             from custom extensions or future spec versions. *)

     

       23
        
       

     

       24
        
         val empty : t

     

       25
        
         (** [empty] is the empty list of unknown fields. *)

···

       17
        
       (** {1 Unknown Fields} *)

     

       18
        
       

     

       19
        
       module Unknown : sig

     

       20
       +
         type t = Jsont.json

     

       21
       +
         (** Unknown/unrecognized JSON object members as a generic JSON object. Useful

     

       22
       +
             for preserving fields from custom extensions or future spec versions. *)

     

       23
        
       

     

       24
        
         val empty : t

     

       25
        
         (** [empty] is the empty list of unknown fields. *)

+22 -75

lib/item.ml

···

       4
        
         ---------------------------------------------------------------------------*)

     

       5
        
       

     

       6
        
       module Unknown = struct

     

       7
       -
         type t = (string * Jsont.json) list

     

       8
        
       

     

       9
       -
         let empty = []

     

       10
       -
         let is_empty = function [] -> true | _ -> false

     

       11
        
       end

     

       12
        
       

     

       13
        
       type content = [ `Html of string | `Text of string | `Both of string * string ]

     
···

       83
        
         | `Both (_, text) -> Some text

     

       84
        
       

     

       85
        
       let equal a b = a.id = b.id

     

       86
       -
       

     

       87
       -
       let compare a b =

     

       88
       -
         match (a.date_published, b.date_published) with

     

       89
       -
         | None, None -> 0

     

       90
       -
         | None, Some _ -> -1

     

       91
       -
         | Some _, None -> 1

     

       92
       -
         | Some da, Some db -> Ptime.compare da db

     

       93
        
       

     

       94
        
       let pp ppf t =

     

       95
        
         match (t.date_published, t.title) with

     
···

       103
        
         | None, None -> Format.fprintf ppf "%s" t.id

     

       104
        
       

     

       105
        
       let pp_summary ppf t =

     

       106
       -
         match t.title with

     

       107
       -
         | Some title -> Format.fprintf ppf "%s" title

     

       108
       -
         | None -> Format.fprintf ppf "%s" t.id

     

       109
        
       

     

       110
        
       (* Jsont type *)

     

       111
        
       

     
···

       147
        
           }

     

       148
        
         in

     

       149
        
       

     

       150
       -
         (* Encoders to extract fields from item *)

     

       151
       -
         let enc_id t = t.id in

     

       152
       -
         let enc_content_html t = content_html t in

     

       153
       -
         let enc_content_text t = content_text t in

     

       154
       -
         let enc_url t = t.url in

     

       155
       -
         let enc_external_url t = t.external_url in

     

       156
       -
         let enc_title t = t.title in

     

       157
       -
         let enc_summary t = t.summary in

     

       158
       -
         let enc_image t = t.image in

     

       159
       -
         let enc_banner_image t = t.banner_image in

     

       160
       -
         let enc_date_published t = t.date_published in

     

       161
       -
         let enc_date_modified t = t.date_modified in

     

       162
       -
         let enc_authors t = t.authors in

     

       163
       -
         let enc_tags t = t.tags in

     

       164
       -
         let enc_language t = t.language in

     

       165
       -
         let enc_attachments t = t.attachments in

     

       166
       -
         let enc_references t = t.references in

     

       167
       -
         let enc_unknown t = t.unknown in

     

       168
       -
       

     

       169
       -
         let unknown_mems :

     

       170
       -
             (Unknown.t, Jsont.json, Jsont.mem list) Jsont.Object.Mems.map =

     

       171
       -
           let open Jsont.Object.Mems in

     

       172
       -
           let dec_empty () = [] in

     

       173
       -
           let dec_add _meta (name : string) value acc =

     

       174
       -
             ((name, Jsont.Meta.none), value) :: acc

     

       175
       -
           in

     

       176
       -
           let dec_finish _meta mems =

     

       177
       -
             List.rev_map (fun ((name, _meta), value) -> (name, value)) mems

     

       178
       -
           in

     

       179
       -
           let enc =

     

       180
       -
             {

     

       181
       -
               enc =

     

       182
       -
                 (fun (type acc)

     

       183
       -
                   (f : Jsont.Meta.t -> string -> Jsont.json -> acc -> acc)

     

       184
       -
                   unknown

     

       185
       -
                   (acc : acc)

     

       186
       -
                 ->

     

       187
       -
                   List.fold_left

     

       188
       -
                     (fun acc (name, value) -> f Jsont.Meta.none name value acc)

     

       189
       -
                     acc unknown);

     

       190
       -
             }

     

       191
       -
           in

     

       192
       -
           map ~kind:"Unknown members" Jsont.json ~dec_empty ~dec_add ~dec_finish ~enc

     

       193
       -
         in

     

       194
       -
       

     

       195
        
         Jsont.Object.map ~kind ~doc make_from_json

     

       196
       -
         |> Jsont.Object.mem "id" Jsont.string ~enc:enc_id

     

       197
       -
         |> Jsont.Object.opt_mem "content_html" Jsont.string ~enc:enc_content_html

     

       198
       -
         |> Jsont.Object.opt_mem "content_text" Jsont.string ~enc:enc_content_text

     

       199
       -
         |> Jsont.Object.opt_mem "url" Jsont.string ~enc:enc_url

     

       200
       -
         |> Jsont.Object.opt_mem "external_url" Jsont.string ~enc:enc_external_url

     

       201
       -
         |> Jsont.Object.opt_mem "title" Jsont.string ~enc:enc_title

     

       202
       -
         |> Jsont.Object.opt_mem "summary" Jsont.string ~enc:enc_summary

     

       203
       -
         |> Jsont.Object.opt_mem "image" Jsont.string ~enc:enc_image

     

       204
       -
         |> Jsont.Object.opt_mem "banner_image" Jsont.string ~enc:enc_banner_image

     

       205
       -
         |> Jsont.Object.opt_mem "date_published" Rfc3339.jsont ~enc:enc_date_published

     

       206
       -
         |> Jsont.Object.opt_mem "date_modified" Rfc3339.jsont ~enc:enc_date_modified

     

       207
       -
         |> Jsont.Object.opt_mem "authors" (Jsont.list Author.jsont) ~enc:enc_authors

     

       208
       -
         |> Jsont.Object.opt_mem "tags" (Jsont.list Jsont.string) ~enc:enc_tags

     

       209
       -
         |> Jsont.Object.opt_mem "language" Jsont.string ~enc:enc_language

     

       210
        
         |> Jsont.Object.opt_mem "attachments"

     

       211
        
              (Jsont.list Attachment.jsont)

     

       212
       -
              ~enc:enc_attachments

     

       213
        
         |> Jsont.Object.opt_mem "_references"

     

       214
        
              (Jsont.list Reference.jsont)

     

       215
       -
              ~enc:enc_references

     

       216
        
         |> Jsont.Object.opt_mem "_extensions" Jsont.json_object ~enc:(fun _t -> None)

     

       217
       -
         |> Jsont.Object.keep_unknown unknown_mems ~enc:enc_unknown

     

       218
        
         |> Jsont.Object.finish

···

       4
        
         ---------------------------------------------------------------------------*)

     

       5
        
       

     

       6
        
       module Unknown = struct

     

       7
       +
         type t = Jsont.json

     

       8
        
       

     

       9
       +
         let empty = Jsont.Object ([], Jsont.Meta.none)

     

       10
       +
         let is_empty = function Jsont.Object ([], _) -> true | _ -> false

     

       11
        
       end

     

       12
        
       

     

       13
        
       type content = [ `Html of string | `Text of string | `Both of string * string ]

     
···

       83
        
         | `Both (_, text) -> Some text

     

       84
        
       

     

       85
        
       let equal a b = a.id = b.id

     

       86
       +
       let compare a b = Option.compare Ptime.compare a.date_published b.date_published

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       87
        
       

     

       88
        
       let pp ppf t =

     

       89
        
         match (t.date_published, t.title) with

     
···

       97
        
         | None, None -> Format.fprintf ppf "%s" t.id

     

       98
        
       

     

       99
        
       let pp_summary ppf t =

     

       100
       +
         Format.fprintf ppf "%s" (Option.value ~default:t.id t.title)

     

       0
        
       
     

       0
        
       
     

       101
        
       

     

       102
        
       (* Jsont type *)

     

       103
        
       

     
···

       139
        
           }

     

       140
        
         in

     

       141
        
       

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       142
        
         Jsont.Object.map ~kind ~doc make_from_json

     

       143
       +
         |> Jsont.Object.mem "id" Jsont.string ~enc:id

     

       144
       +
         |> Jsont.Object.opt_mem "content_html" Jsont.string ~enc:content_html

     

       145
       +
         |> Jsont.Object.opt_mem "content_text" Jsont.string ~enc:content_text

     

       146
       +
         |> Jsont.Object.opt_mem "url" Jsont.string ~enc:url

     

       147
       +
         |> Jsont.Object.opt_mem "external_url" Jsont.string ~enc:external_url

     

       148
       +
         |> Jsont.Object.opt_mem "title" Jsont.string ~enc:title

     

       149
       +
         |> Jsont.Object.opt_mem "summary" Jsont.string ~enc:summary

     

       150
       +
         |> Jsont.Object.opt_mem "image" Jsont.string ~enc:image

     

       151
       +
         |> Jsont.Object.opt_mem "banner_image" Jsont.string ~enc:banner_image

     

       152
       +
         |> Jsont.Object.opt_mem "date_published" Rfc3339.jsont ~enc:date_published

     

       153
       +
         |> Jsont.Object.opt_mem "date_modified" Rfc3339.jsont ~enc:date_modified

     

       154
       +
         |> Jsont.Object.opt_mem "authors" (Jsont.list Author.jsont) ~enc:authors

     

       155
       +
         |> Jsont.Object.opt_mem "tags" (Jsont.list Jsont.string) ~enc:tags

     

       156
       +
         |> Jsont.Object.opt_mem "language" Jsont.string ~enc:language

     

       157
        
         |> Jsont.Object.opt_mem "attachments"

     

       158
        
              (Jsont.list Attachment.jsont)

     

       159
       +
              ~enc:attachments

     

       160
        
         |> Jsont.Object.opt_mem "_references"

     

       161
        
              (Jsont.list Reference.jsont)

     

       162
       +
              ~enc:references

     

       163
        
         |> Jsont.Object.opt_mem "_extensions" Jsont.json_object ~enc:(fun _t -> None)

     

       164
       +
         |> Jsont.Object.keep_unknown Jsont.json_mems ~enc:unknown

     

       165
        
         |> Jsont.Object.finish

+4 -4

lib/item.mli

···

       1
        
       (*---------------------------------------------------------------------------

     

       2
       -
          Copyright (c) 2024 Anil Madhavapeddy. All rights reserved.

     

       3
        
          SPDX-License-Identifier: ISC

     

       4
        
         ---------------------------------------------------------------------------*)

     

       5
        
       

     
···

       27
        
       (** {1 Unknown Fields} *)

     

       28
        
       

     

       29
        
       module Unknown : sig

     

       30
       -
         type t = (string * Jsont.json) list

     

       31
       -
         (** Unknown/unrecognized JSON object members. Useful for preserving fields

     

       32
       -
             from custom extensions or future spec versions. *)

     

       33
        
       

     

       34
        
         val empty : t

     

       35
        
         (** [empty] is the empty list of unknown fields. *)

···

       1
        
       (*---------------------------------------------------------------------------

     

       2
       +
          Copyright (c) 2025 Anil Madhavapeddy. All rights reserved.

     

       3
        
          SPDX-License-Identifier: ISC

     

       4
        
         ---------------------------------------------------------------------------*)

     

       5
        
       

     
···

       27
        
       (** {1 Unknown Fields} *)

     

       28
        
       

     

       29
        
       module Unknown : sig

     

       30
       +
         type t = Jsont.json

     

       31
       +
         (** Unknown/unrecognized JSON object members as a generic JSON object. Useful

     

       32
       +
             for preserving fields from custom extensions or future spec versions. *)

     

       33
        
       

     

       34
        
         val empty : t

     

       35
        
         (** [empty] is the empty list of unknown fields. *)

+16 -47

lib/jsonfeed.ml

···

       12
        
       module Item = Item

     

       13
        
       

     

       14
        
       module Unknown = struct

     

       15
       -
         type t = (string * Jsont.json) list

     

       16
        
       

     

       17
       -
         let empty = []

     

       18
       -
         let is_empty = function [] -> true | _ -> false

     

       19
        
       end

     

       20
        
       

     

       21
        
       type t = {

     
···

       85
        
       let jsont =

     

       86
        
         let kind = "JSON Feed" in

     

       87
        
         let doc = "A JSON Feed document" in

     

       88
       -
         let unknown_mems :

     

       89
       -
             (Unknown.t, Jsont.json, Jsont.mem list) Jsont.Object.Mems.map =

     

       90
       -
           let open Jsont.Object.Mems in

     

       91
       -
           let dec_empty () = [] in

     

       92
       -
           let dec_add _meta (name : string) value acc =

     

       93
       -
             ((name, Jsont.Meta.none), value) :: acc

     

       94
       -
           in

     

       95
       -
           let dec_finish _meta mems =

     

       96
       -
             List.rev_map (fun ((name, _meta), value) -> (name, value)) mems

     

       97
       -
           in

     

       98
       -
           let enc =

     

       99
       -
             {

     

       100
       -
               enc =

     

       101
       -
                 (fun (type acc)

     

       102
       -
                   (f : Jsont.Meta.t -> string -> Jsont.json -> acc -> acc)

     

       103
       -
                   unknown

     

       104
       -
                   (acc : acc)

     

       105
       -
                 ->

     

       106
       -
                   List.fold_left

     

       107
       -
                     (fun acc (name, value) -> f Jsont.Meta.none name value acc)

     

       108
       -
                     acc unknown);

     

       109
       -
             }

     

       110
       -
           in

     

       111
       -
           map ~kind:"Unknown members" Jsont.json ~dec_empty ~dec_add ~dec_finish ~enc

     

       112
       -
         in

     

       113
        
       

     

       114
        
         (* Helper constructor that sets version automatically *)

     

       115
        
         let make_from_json _version title home_page_url feed_url description

     
···

       149
        
         |> Jsont.Object.opt_mem "expired" Jsont.bool ~enc:expired

     

       150
        
         |> Jsont.Object.opt_mem "hubs" (Jsont.list Hub.jsont) ~enc:hubs

     

       151
        
         |> Jsont.Object.mem "items" (Jsont.list Item.jsont) ~enc:items

     

       152
       -
         |> Jsont.Object.keep_unknown unknown_mems ~enc:unknown

     

       153
        
         |> Jsont.Object.finish

     

       154
        
       

     

       155
        
       (* Encoding and Decoding *)

     
···

       188
        
           add_error "items must have unique IDs";

     

       189
        
       

     

       190
        
         (* Validate authors *)

     

       191
       -
         (match feed.authors with

     

       192
       -
         | Some authors ->

     

       193
       -
             List.iteri

     

       194
       -
               (fun i author ->

     

       195
       -
                 if not (Author.is_valid author) then

     

       196
       -
                   add_error

     

       197
       -
                     (Printf.sprintf

     

       198
       -
                        "feed author %d is invalid (needs at least one field)" i))

     

       199
       -
               authors

     

       200
       -
         | None -> ());

     

       201
        
       

     

       202
        
         (* Validate items *)

     

       203
        
         List.iteri

     
···

       206
        
               add_error (Printf.sprintf "item %d has empty ID" i);

     

       207
        
       

     

       208
        
             (* Validate item authors *)

     

       209
       -
             match Item.authors item with

     

       210
       -
             | Some authors ->

     

       211
       -
                 List.iteri

     

       212
       -
                   (fun j author ->

     

       213
       -
                     if not (Author.is_valid author) then

     

       214
       -
                       add_error (Printf.sprintf "item %d author %d is invalid" i j))

     

       215
       -
                   authors

     

       216
       -
             | None -> ())

     

       217
        
           feed.items;

     

       218
        
       

     

       219
        
         match !errors with [] -> Ok () | errs -> Error (List.rev errs)

···

       12
        
       module Item = Item

     

       13
        
       

     

       14
        
       module Unknown = struct

     

       15
       +
         type t = Jsont.json

     

       16
        
       

     

       17
       +
         let empty = Jsont.Object ([], Jsont.Meta.none)

     

       18
       +
         let is_empty = function Jsont.Object ([], _) -> true | _ -> false

     

       19
        
       end

     

       20
        
       

     

       21
        
       type t = {

     
···

       85
        
       let jsont =

     

       86
        
         let kind = "JSON Feed" in

     

       87
        
         let doc = "A JSON Feed document" in

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       88
        
       

     

       89
        
         (* Helper constructor that sets version automatically *)

     

       90
        
         let make_from_json _version title home_page_url feed_url description

     
···

       124
        
         |> Jsont.Object.opt_mem "expired" Jsont.bool ~enc:expired

     

       125
        
         |> Jsont.Object.opt_mem "hubs" (Jsont.list Hub.jsont) ~enc:hubs

     

       126
        
         |> Jsont.Object.mem "items" (Jsont.list Item.jsont) ~enc:items

     

       127
       +
         |> Jsont.Object.keep_unknown Jsont.json_mems ~enc:unknown

     

       128
        
         |> Jsont.Object.finish

     

       129
        
       

     

       130
        
       (* Encoding and Decoding *)

     
···

       163
        
           add_error "items must have unique IDs";

     

       164
        
       

     

       165
        
         (* Validate authors *)

     

       166
       +
         Option.iter

     

       167
       +
           (List.iteri (fun i author ->

     

       168
       +
                if not (Author.is_valid author) then

     

       169
       +
                  add_error

     

       170
       +
                    (Printf.sprintf

     

       171
       +
                       "feed author %d is invalid (needs at least one field)" i)))

     

       172
       +
           feed.authors;

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       173
        
       

     

       174
        
         (* Validate items *)

     

       175
        
         List.iteri

     
···

       178
        
               add_error (Printf.sprintf "item %d has empty ID" i);

     

       179
        
       

     

       180
        
             (* Validate item authors *)

     

       181
       +
             Option.iter

     

       182
       +
               (List.iteri (fun j author ->

     

       183
       +
                    if not (Author.is_valid author) then

     

       184
       +
                      add_error (Printf.sprintf "item %d author %d is invalid" i j)))

     

       185
       +
               (Item.authors item))

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       186
        
           feed.items;

     

       187
        
       

     

       188
        
         match !errors with [] -> Ok () | errs -> Error (List.rev errs)

+130 -8

lib/jsonfeed.mli

···

       1
        
       (*---------------------------------------------------------------------------

     

       2
       -
          Copyright (c) 2024 Anil Madhavapeddy. All rights reserved.

     

       3
        
          SPDX-License-Identifier: ISC

     

       4
        
         ---------------------------------------------------------------------------*)

     

       5
        
       

     

       6
       -
       (** JSON Feed format parser and serializer using Jsont and Bytesrw.

     

       7
        
       

     

       8
        
           @see <https://www.jsonfeed.org/version/1.1/> JSON Feed Specification *)

     

       9
        
       

     

       10
        
       type t

     

       11
        
       (** The type representing a complete JSON Feed. *)

     

       12
        
       

     

       13
       -
       (** {1 Jsont Type} *)

     

       14
       -
       

     

       15
        
       val jsont : t Jsont.t

     

       16
       -
       (** Declarative JSON type for JSON feeds.

     

       17
        
       

     

       18
        
           Maps the complete JSON Feed 1.1 specification including all required and

     

       19
        
           optional fields. *)

     

       20
        
       

     

       21
        
       module Unknown : sig

     

       22
       -
         type t = (string * Jsont.json) list

     

       23
       -
         (** Unknown/unrecognized JSON object members. Useful for preserving fields

     

       24
       -
             from custom extensions or future spec versions. *)

     

       0
        
       
     

       25
        
       

     

       26
        
         val empty : t

     

       27
        
         (** [empty] is the empty list of unknown fields. *)

     
···

       29
        
         val is_empty : t -> bool

     

       30
        
         (** [is_empty u] returns [true] if there are no unknown fields. *)

     

       31
        
       end

     

       0
        
       
     

       0
        
       
     

       32
        
       

     

       33
        
       val create :

     

       34
        
         title:string ->

     
···

       47
        
         ?unknown:Unknown.t ->

     

       48
        
         unit ->

     

       49
        
         t

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       50
        
       

     

       51
        
       val version : t -> string

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       52
        
       val title : t -> string

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       53
        
       val home_page_url : t -> string option

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       54
        
       val feed_url : t -> string option

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       55
        
       val description : t -> string option

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       56
        
       val user_comment : t -> string option

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       57
        
       val next_url : t -> string option

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       58
        
       val icon : t -> string option

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       59
        
       val favicon : t -> string option

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       60
        
       val authors : t -> Author.t list option

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       61
        
       val language : t -> string option

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       62
        
       val expired : t -> bool option

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       63
        
       val hubs : t -> Hub.t list option

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       64
        
       val items : t -> Item.t list

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       65
        
       val unknown : t -> Unknown.t

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       66
        
       

     

       67
        
       (** {1 Encoding and Decoding} *)

     

       68

···

       1
        
       (*---------------------------------------------------------------------------

     

       2
       +
          Copyright (c) 2025 Anil Madhavapeddy. All rights reserved.

     

       3
        
          SPDX-License-Identifier: ISC

     

       4
        
         ---------------------------------------------------------------------------*)

     

       5
        
       

     

       6
       +
       (** JSON Feed format parser and serializer.

     

       7
        
       

     

       8
        
           @see <https://www.jsonfeed.org/version/1.1/> JSON Feed Specification *)

     

       9
        
       

     

       10
        
       type t

     

       11
        
       (** The type representing a complete JSON Feed. *)

     

       12
        
       

     

       0
        
       
     

       0
        
       
     

       13
        
       val jsont : t Jsont.t

     

       14
       +
       (** Declarative type that describes the structure of JSON Feeds.

     

       15
        
       

     

       16
        
           Maps the complete JSON Feed 1.1 specification including all required and

     

       17
        
           optional fields. *)

     

       18
        
       

     

       19
        
       module Unknown : sig

     

       20
       +
         type t = Jsont.json

     

       21
       +
         (** Unknown or unrecognized JSON object members as a generic JSON object.

     

       22
       +
             Useful for preserving fields from custom extensions or future spec

     

       23
       +
             versions. *)

     

       24
        
       

     

       25
        
         val empty : t

     

       26
        
         (** [empty] is the empty list of unknown fields. *)

     
···

       28
        
         val is_empty : t -> bool

     

       29
        
         (** [is_empty u] returns [true] if there are no unknown fields. *)

     

       30
        
       end

     

       31
       +
       

     

       32
       +
       (** {1 Construction} *)

     

       33
        
       

     

       34
        
       val create :

     

       35
        
         title:string ->

     
···

       48
        
         ?unknown:Unknown.t ->

     

       49
        
         unit ->

     

       50
        
         t

     

       51
       +
       (** [create ~title ~items ()] creates a new JSON Feed.

     

       52
       +
       

     

       53
       +
           @param title

     

       54
       +
             The name of the feed. Required field that should be plain text, not HTML.

     

       55
       +
           @param home_page_url

     

       56
       +
             The URL of the resource that the feed describes. This resource may or may

     

       57
       +
             not actually be a "home" page, but it should be an HTML page. If a feed is

     

       58
       +
             for a podcast, for instance, the home_page_url would be the URL for the

     

       59
       +
             podcast's website.

     

       60
       +
           @param feed_url

     

       61
       +
             The URL of the feed itself. This is the URL that was requested to get this

     

       62
       +
             JSON Feed response. Helps feed readers to determine when they're being

     

       63
       +
             redirected. Strongly recommended for feeds.

     

       64
       +
           @param description

     

       65
       +
             A plain text description of the feed, for human consumption. May contain

     

       66
       +
             some formatting (like newlines).

     

       67
       +
           @param user_comment

     

       68
       +
             A description of the purpose of the feed, for a person looking at the raw

     

       69
       +
             JSON. This is for the publisher's use only, not intended to be displayed

     

       70
       +
             to the user.

     

       71
       +
           @param next_url

     

       72
       +
             The URL of a feed that provides the next n items, where n is determined by

     

       73
       +
             the publisher. Used for pagination. A feed reader may continue to request

     

       74
       +
             the URLs in next_url until it reaches a feed without a next_url.

     

       75
       +
           @param icon

     

       76
       +
             The URL of an image for the feed suitable to be used in a timeline, much

     

       77
       +
             the way an avatar might be used. Should be square and relatively large -

     

       78
       +
             such as 512 x 512 pixels - and may be cropped to a circle or rounded

     

       79
       +
             corners. Should not be transparent.

     

       80
       +
           @param favicon

     

       81
       +
             The URL of an image for the feed suitable to be used in a source list.

     

       82
       +
             Should be square and relatively small - such as 64 x 64 pixels. Should not

     

       83
       +
             be transparent.

     

       84
       +
           @param authors

     

       85
       +
             Specifies one or more feed authors. The author object has several members

     

       86
       +
             (name, url, avatar) which are all optional, but at least one must be

     

       87
       +
             present for the object to be valid.

     

       88
       +
           @param language

     

       89
       +
             The primary language for the feed in RFC 5646 format. The value can be a

     

       90
       +
             language tag such as "en" or "en-US", or a language-region combination.

     

       91
       +
           @param expired

     

       92
       +
             Whether or not the feed is finished - that is, whether or not it will ever

     

       93
       +
             update again. A feed for a temporary event, like an instance of a

     

       94
       +
             conference, may expire. If the value is [true], feed readers may stop

     

       95
       +
             checking for updates.

     

       96
       +
           @param hubs

     

       97
       +
             Endpoints that can be used to subscribe to real-time notifications from

     

       98
       +
             the publisher of this feed. Each hub object has a type (such as "rssCloud"

     

       99
       +
             or "WebSub") and url.

     

       100
       +
           @param items

     

       101
       +
             The items in the feed. Required field, though it may be an empty array.

     

       102
       +
           @param unknown

     

       103
       +
             Unknown JSON object members preserved from parsing. Useful for custom

     

       104
       +
             extensions. *)

     

       105
       +
       

     

       106
       +
       (** {1 Accessors} *)

     

       107
        
       

     

       108
        
       val version : t -> string

     

       109
       +
       (** [version feed] returns the URL of the version of the format the feed uses.

     

       110
       +
           This will always be "https://jsonfeed.org/version/1.1" for feeds created

     

       111
       +
           with this library. This is a required field in the JSON Feed spec. *)

     

       112
       +
       

     

       113
        
       val title : t -> string

     

       114
       +
       (** [title feed] returns the name of the feed. This is plain text and should not

     

       115
       +
           contain HTML. This is a required field. *)

     

       116
       +
       

     

       117
        
       val home_page_url : t -> string option

     

       118
       +
       (** [home_page_url feed] returns the URL of the resource that the feed

     

       119
       +
           describes. This resource may or may not actually be a "home" page, but it

     

       120
       +
           should be an HTML page. For instance, if a feed is for a podcast, the

     

       121
       +
           home_page_url would be the URL for the podcast's website. *)

     

       122
       +
       

     

       123
        
       val feed_url : t -> string option

     

       124
       +
       (** [feed_url feed] returns the URL of the feed itself. This should be the URL

     

       125
       +
           that was requested to get this JSON Feed response. It helps feed readers

     

       126
       +
           determine when they're being redirected. This is strongly recommended for

     

       127
       +
           feeds. *)

     

       128
       +
       

     

       129
        
       val description : t -> string option

     

       130
       +
       (** [description feed] returns a plain text description of the feed, for human

     

       131
       +
           consumption. This field may contain some formatting such as newlines. *)

     

       132
       +
       

     

       133
        
       val user_comment : t -> string option

     

       134
       +
       (** [user_comment feed] returns a description of the purpose of the feed, for a

     

       135
       +
           person looking at the raw JSON. This is for the publisher's use only and is

     

       136
       +
           not intended to be displayed to end users. *)

     

       137
       +
       

     

       138
        
       val next_url : t -> string option

     

       139
       +
       (** [next_url feed] returns the URL of a feed that provides the next n items,

     

       140
       +
           where n is determined by the publisher. This is used for pagination. A feed

     

       141
       +
           reader may continue to request the URLs in next_url until it reaches a feed

     

       142
       +
           without a next_url. *)

     

       143
       +
       

     

       144
        
       val icon : t -> string option

     

       145
       +
       (** [icon feed] returns the URL of an image for the feed suitable to be used in

     

       146
       +
           a timeline, much the way an avatar might be used. It should be square and

     

       147
       +
           relatively large (such as 512 x 512 pixels) and may be cropped to a circle

     

       148
       +
           or rounded corners by feed readers. It should not be transparent. *)

     

       149
       +
       

     

       150
        
       val favicon : t -> string option

     

       151
       +
       (** [favicon feed] returns the URL of an image for the feed suitable to be used

     

       152
       +
           in a source list. It should be square and relatively small (such as 64 x 64

     

       153
       +
           pixels) and should not be transparent. *)

     

       154
       +
       

     

       155
        
       val authors : t -> Author.t list option

     

       156
       +
       (** [authors feed] returns the feed authors. Each author object has several

     

       157
       +
           members (name, url, avatar) which are all optional, but at least one must be

     

       158
       +
           present for the object to be valid. If a feed has multiple authors, they

     

       159
       +
           should all be listed here. *)

     

       160
       +
       

     

       161
        
       val language : t -> string option

     

       162
       +
       (** [language feed] returns the primary language for the feed in RFC 5646

     

       163
       +
           format. The value can be a language tag such as "en" or "en-US", or a

     

       164
       +
           language-region combination. This field helps feed readers present the feed

     

       165
       +
           in the appropriate language. *)

     

       166
       +
       

     

       167
        
       val expired : t -> bool option

     

       168
       +
       (** [expired feed] returns whether the feed is finished - that is, whether it

     

       169
       +
           will ever update again. A feed for a temporary event, like an instance of a

     

       170
       +
           conference, may expire. If the value is [Some true], feed readers may stop

     

       171
       +
           checking for updates. *)

     

       172
       +
       

     

       173
        
       val hubs : t -> Hub.t list option

     

       174
       +
       (** [hubs feed] returns endpoints that can be used to subscribe to real-time

     

       175
       +
           notifications from the publisher of this feed. Each hub object has a type

     

       176
       +
           (such as "rssCloud" or "WebSub") and a url. Feed readers can use these to

     

       177
       +
           get immediate updates when new items are published. *)

     

       178
       +
       

     

       179
        
       val items : t -> Item.t list

     

       180
       +
       (** [items feed] returns the array of items in the feed. This is a required

     

       181
       +
           field, though it may be an empty list. Items represent the individual

     

       182
       +
           entries in the feed - blog posts, podcast episodes, microblog posts, etc. *)

     

       183
       +
       

     

       184
        
       val unknown : t -> Unknown.t

     

       185
       +
       (** [unknown feed] returns any unknown JSON object members that were preserved

     

       186
       +
           during parsing. This is useful for custom extensions or fields from future

     

       187
       +
           versions of the spec. *)

     

       188
        
       

     

       189
        
       (** {1 Encoding and Decoding} *)

     

       190

+5 -30

lib/reference.ml

···

       4
        
         ---------------------------------------------------------------------------*)

     

       5
        
       

     

       6
        
       module Unknown = struct

     

       7
       -
         type t = (string * Jsont.json) list

     

       8
        
       

     

       9
       -
         let empty = []

     

       10
       -
         let is_empty = function [] -> true | _ -> false

     

       11
        
       end

     

       12
        
       

     

       13
        
       type t = {

     
···

       29
        
       let pp ppf t =

     

       30
        
         let open Format in

     

       31
        
         fprintf ppf "%s" t.url;

     

       32
       -
         match t.doi with Some d -> fprintf ppf " [DOI: %s]" d | None -> ()

     

       33
        
       

     

       34
        
       let jsont =

     

       35
        
         let kind = "Reference" in

     

       36
        
         let doc = "A reference to a cited source" in

     

       37
       -
         let unknown_mems :

     

       38
       -
             (Unknown.t, Jsont.json, Jsont.mem list) Jsont.Object.Mems.map =

     

       39
       -
           let open Jsont.Object.Mems in

     

       40
       -
           let dec_empty () = [] in

     

       41
       -
           let dec_add _meta (name : string) value acc =

     

       42
       -
             ((name, Jsont.Meta.none), value) :: acc

     

       43
       -
           in

     

       44
       -
           let dec_finish _meta mems =

     

       45
       -
             List.rev_map (fun ((name, _meta), value) -> (name, value)) mems

     

       46
       -
           in

     

       47
       -
           let enc =

     

       48
       -
             {

     

       49
       -
               enc =

     

       50
       -
                 (fun (type acc)

     

       51
       -
                   (f : Jsont.Meta.t -> string -> Jsont.json -> acc -> acc)

     

       52
       -
                   unknown

     

       53
       -
                   (acc : acc)

     

       54
       -
                 ->

     

       55
       -
                   List.fold_left

     

       56
       -
                     (fun acc (name, value) -> f Jsont.Meta.none name value acc)

     

       57
       -
                     acc unknown);

     

       58
       -
             }

     

       59
       -
           in

     

       60
       -
           map ~kind:"Unknown members" Jsont.json ~dec_empty ~dec_add ~dec_finish ~enc

     

       61
       -
         in

     

       62
        
         let create_obj url doi cito unknown = create ~url ?doi ?cito ~unknown () in

     

       63
        
         Jsont.Object.map ~kind ~doc create_obj

     

       64
        
         |> Jsont.Object.mem "url" Jsont.string ~enc:url

     

       65
        
         |> Jsont.Object.opt_mem "doi" Jsont.string ~enc:doi

     

       66
        
         |> Jsont.Object.opt_mem "cito" (Jsont.list Cito.jsont) ~enc:cito

     

       67
       -
         |> Jsont.Object.keep_unknown unknown_mems ~enc:unknown

     

       68
        
         |> Jsont.Object.finish

···

       4
        
         ---------------------------------------------------------------------------*)

     

       5
        
       

     

       6
        
       module Unknown = struct

     

       7
       +
         type t = Jsont.json

     

       8
        
       

     

       9
       +
         let empty = Jsont.Object ([], Jsont.Meta.none)

     

       10
       +
         let is_empty = function Jsont.Object ([], _) -> true | _ -> false

     

       11
        
       end

     

       12
        
       

     

       13
        
       type t = {

     
···

       29
        
       let pp ppf t =

     

       30
        
         let open Format in

     

       31
        
         fprintf ppf "%s" t.url;

     

       32
       +
         Option.iter (fprintf ppf " [DOI: %s]") t.doi

     

       33
        
       

     

       34
        
       let jsont =

     

       35
        
         let kind = "Reference" in

     

       36
        
         let doc = "A reference to a cited source" in

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       37
        
         let create_obj url doi cito unknown = create ~url ?doi ?cito ~unknown () in

     

       38
        
         Jsont.Object.map ~kind ~doc create_obj

     

       39
        
         |> Jsont.Object.mem "url" Jsont.string ~enc:url

     

       40
        
         |> Jsont.Object.opt_mem "doi" Jsont.string ~enc:doi

     

       41
        
         |> Jsont.Object.opt_mem "cito" (Jsont.list Cito.jsont) ~enc:cito

     

       42
       +
         |> Jsont.Object.keep_unknown Jsont.json_mems ~enc:unknown

     

       43
        
         |> Jsont.Object.finish

+3 -3

lib/reference.mli

···

       19
        
       (** {1 Unknown Fields} *)

     

       20
        
       

     

       21
        
       module Unknown : sig

     

       22
       -
         type t = (string * Jsont.json) list

     

       23
       -
         (** Unknown/unrecognized JSON object members. Useful for preserving fields

     

       24
       -
             from custom extensions or future spec versions. *)

     

       25
        
       

     

       26
        
         val empty : t

     

       27
        
         (** [empty] is the empty list of unknown fields. *)

···

       19
        
       (** {1 Unknown Fields} *)

     

       20
        
       

     

       21
        
       module Unknown : sig

     

       22
       +
         type t = Jsont.json

     

       23
       +
         (** Unknown/unrecognized JSON object members as a generic JSON object. Useful

     

       24
       +
             for preserving fields from custom extensions or future spec versions. *)

     

       25
        
       

     

       26
        
         val empty : t

     

       27
        
         (** [empty] is the empty list of unknown fields. *)

+1 -1

lib/rfc3339.ml

···

       4
        
         ---------------------------------------------------------------------------*)

     

       5
        
       

     

       6
        
       let parse s =

     

       7
       -
         match Ptime.of_rfc3339 s with Ok (t, _, _) -> Some t | Error _ -> None

     

       8
        
       

     

       9
        
       let format t = Ptime.to_rfc3339 ~frac_s:6 ~tz_offset_s:0 t

     

       10
        
       let pp ppf t = Format.pp_print_string ppf (format t)

···

       4
        
         ---------------------------------------------------------------------------*)

     

       5
        
       

     

       6
        
       let parse s =

     

       7
       +
         Ptime.of_rfc3339 s |> Result.to_option |> Option.map (fun (t, _, _) -> t)

     

       8
        
       

     

       9
        
       let format t = Ptime.to_rfc3339 ~frac_s:6 ~tz_offset_s:0 t

     

       10
        
       let pp ppf t = Format.pp_print_string ppf (format t)

+182

test/test_jsonfeed.ml

···

       370
        
             test_feed_parse_invalid_missing_content );

     

       371
        
         ]

     

       372
        
       

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       373
        
       (* Main test suite *)

     

       374
        
       

     

       375
        
       let () =

     
···

       380
        
             ("Hub", hub_tests);

     

       381
        
             ("Item", item_tests);

     

       382
        
             ("Jsonfeed", jsonfeed_tests);

     

       0
        
       
     

       383
        
           ]

···

       370
        
             test_feed_parse_invalid_missing_content );

     

       371
        
         ]

     

       372
        
       

     

       373
       +
       (* Unknown fields preservation tests *)

     

       374
       +
       

     

       375
       +
       let test_author_unknown_roundtrip () =

     

       376
       +
         let json =

     

       377
       +
           {|{

     

       378
       +
           "name": "Test Author",

     

       379
       +
           "custom_field": "custom value",

     

       380
       +
           "another_extension": 42

     

       381
       +
         }|}

     

       382
       +
         in

     

       383
       +
         match Jsont_bytesrw.decode_string' Author.jsont json with

     

       384
       +
         | Error e ->

     

       385
       +
             Alcotest.fail

     

       386
       +
               (Printf.sprintf "Parse failed: %s" (Jsont.Error.to_string e))

     

       387
       +
         | Ok author -> (

     

       388
       +
             (* Check that unknown fields are preserved *)

     

       389
       +
             let unknown = Author.unknown author in

     

       390
       +
             Alcotest.(check bool)

     

       391
       +
               "has unknown fields" false

     

       392
       +
               (Jsonfeed.Unknown.is_empty unknown);

     

       393
       +
             (* Encode and decode again *)

     

       394
       +
             match Jsont_bytesrw.encode_string' Author.jsont author with

     

       395
       +
             | Error e ->

     

       396
       +
                 Alcotest.fail

     

       397
       +
                   (Printf.sprintf "Encode failed: %s" (Jsont.Error.to_string e))

     

       398
       +
             | Ok json2 -> (

     

       399
       +
                 match Jsont_bytesrw.decode_string' Author.jsont json2 with

     

       400
       +
                 | Error e ->

     

       401
       +
                     Alcotest.fail

     

       402
       +
                       (Printf.sprintf "Re-parse failed: %s" (Jsont.Error.to_string e))

     

       403
       +
                 | Ok author2 ->

     

       404
       +
                     (* Verify unknown fields survive roundtrip *)

     

       405
       +
                     let unknown2 = Author.unknown author2 in

     

       406
       +
                     Alcotest.(check bool)

     

       407
       +
                       "unknown fields preserved" false

     

       408
       +
                       (Jsonfeed.Unknown.is_empty unknown2)))

     

       409
       +
       

     

       410
       +
       let test_item_unknown_roundtrip () =

     

       411
       +
         let json =

     

       412
       +
           {|{

     

       413
       +
           "id": "https://example.com/1",

     

       414
       +
           "content_html": "<p>Test</p>",

     

       415
       +
           "custom_metadata": "some custom data",

     

       416
       +
           "x_custom_number": 123.45

     

       417
       +
         }|}

     

       418
       +
         in

     

       419
       +
         match Jsont_bytesrw.decode_string' Item.jsont json with

     

       420
       +
         | Error e ->

     

       421
       +
             Alcotest.fail

     

       422
       +
               (Printf.sprintf "Parse failed: %s" (Jsont.Error.to_string e))

     

       423
       +
         | Ok item -> (

     

       424
       +
             (* Check that unknown fields are preserved *)

     

       425
       +
             let unknown = Item.unknown item in

     

       426
       +
             Alcotest.(check bool)

     

       427
       +
               "has unknown fields" false

     

       428
       +
               (Jsonfeed.Unknown.is_empty unknown);

     

       429
       +
             (* Encode and decode again *)

     

       430
       +
             match Jsont_bytesrw.encode_string' Item.jsont item with

     

       431
       +
             | Error e ->

     

       432
       +
                 Alcotest.fail

     

       433
       +
                   (Printf.sprintf "Encode failed: %s" (Jsont.Error.to_string e))

     

       434
       +
             | Ok json2 -> (

     

       435
       +
                 match Jsont_bytesrw.decode_string' Item.jsont json2 with

     

       436
       +
                 | Error e ->

     

       437
       +
                     Alcotest.fail

     

       438
       +
                       (Printf.sprintf "Re-parse failed: %s" (Jsont.Error.to_string e))

     

       439
       +
                 | Ok item2 ->

     

       440
       +
                     let unknown2 = Item.unknown item2 in

     

       441
       +
                     Alcotest.(check bool)

     

       442
       +
                       "unknown fields preserved" false

     

       443
       +
                       (Jsonfeed.Unknown.is_empty unknown2)))

     

       444
       +
       

     

       445
       +
       let test_feed_unknown_roundtrip () =

     

       446
       +
         let json =

     

       447
       +
           {|{

     

       448
       +
           "version": "https://jsonfeed.org/version/1.1",

     

       449
       +
           "title": "Test Feed",

     

       450
       +
           "items": [],

     

       451
       +
           "custom_extension": "custom value",

     

       452
       +
           "x_another_field": {"nested": "data"}

     

       453
       +
         }|}

     

       454
       +
         in

     

       455
       +
         match Jsonfeed.of_string json with

     

       456
       +
         | Error e ->

     

       457
       +
             Alcotest.fail

     

       458
       +
               (Printf.sprintf "Parse failed: %s" (Jsont.Error.to_string e))

     

       459
       +
         | Ok feed -> (

     

       460
       +
             (* Check that unknown fields are preserved *)

     

       461
       +
             let unknown = Jsonfeed.unknown feed in

     

       462
       +
             Alcotest.(check bool)

     

       463
       +
               "has unknown fields" false

     

       464
       +
               (Jsonfeed.Unknown.is_empty unknown);

     

       465
       +
             (* Encode and decode again *)

     

       466
       +
             match Jsonfeed.to_string feed with

     

       467
       +
             | Error e ->

     

       468
       +
                 Alcotest.fail

     

       469
       +
                   (Printf.sprintf "Encode failed: %s" (Jsont.Error.to_string e))

     

       470
       +
             | Ok json2 -> (

     

       471
       +
                 match Jsonfeed.of_string json2 with

     

       472
       +
                 | Error e ->

     

       473
       +
                     Alcotest.fail

     

       474
       +
                       (Printf.sprintf "Re-parse failed: %s" (Jsont.Error.to_string e))

     

       475
       +
                 | Ok feed2 ->

     

       476
       +
                     let unknown2 = Jsonfeed.unknown feed2 in

     

       477
       +
                     Alcotest.(check bool)

     

       478
       +
                       "unknown fields preserved" false

     

       479
       +
                       (Jsonfeed.Unknown.is_empty unknown2)))

     

       480
       +
       

     

       481
       +
       let test_hub_unknown_roundtrip () =

     

       482
       +
         let json =

     

       483
       +
           {|{

     

       484
       +
           "type": "WebSub",

     

       485
       +
           "url": "https://example.com/hub",

     

       486
       +
           "custom_field": "test"

     

       487
       +
         }|}

     

       488
       +
         in

     

       489
       +
         match Jsont_bytesrw.decode_string' Hub.jsont json with

     

       490
       +
         | Error e ->

     

       491
       +
             Alcotest.fail

     

       492
       +
               (Printf.sprintf "Parse failed: %s" (Jsont.Error.to_string e))

     

       493
       +
         | Ok hub -> (

     

       494
       +
             let unknown = Hub.unknown hub in

     

       495
       +
             Alcotest.(check bool)

     

       496
       +
               "has unknown fields" false

     

       497
       +
               (Jsonfeed.Unknown.is_empty unknown);

     

       498
       +
             match Jsont_bytesrw.encode_string' Hub.jsont hub with

     

       499
       +
             | Error e ->

     

       500
       +
                 Alcotest.fail

     

       501
       +
                   (Printf.sprintf "Encode failed: %s" (Jsont.Error.to_string e))

     

       502
       +
             | Ok json2 -> (

     

       503
       +
                 match Jsont_bytesrw.decode_string' Hub.jsont json2 with

     

       504
       +
                 | Error e ->

     

       505
       +
                     Alcotest.fail

     

       506
       +
                       (Printf.sprintf "Re-parse failed: %s" (Jsont.Error.to_string e))

     

       507
       +
                 | Ok hub2 ->

     

       508
       +
                     let unknown2 = Hub.unknown hub2 in

     

       509
       +
                     Alcotest.(check bool)

     

       510
       +
                       "unknown fields preserved" false

     

       511
       +
                       (Jsonfeed.Unknown.is_empty unknown2)))

     

       512
       +
       

     

       513
       +
       let test_attachment_unknown_roundtrip () =

     

       514
       +
         let json =

     

       515
       +
           {|{

     

       516
       +
           "url": "https://example.com/file.mp3",

     

       517
       +
           "mime_type": "audio/mpeg",

     

       518
       +
           "x_custom": "value"

     

       519
       +
         }|}

     

       520
       +
         in

     

       521
       +
         match Jsont_bytesrw.decode_string' Attachment.jsont json with

     

       522
       +
         | Error e ->

     

       523
       +
             Alcotest.fail

     

       524
       +
               (Printf.sprintf "Parse failed: %s" (Jsont.Error.to_string e))

     

       525
       +
         | Ok att -> (

     

       526
       +
             let unknown = Attachment.unknown att in

     

       527
       +
             Alcotest.(check bool)

     

       528
       +
               "has unknown fields" false

     

       529
       +
               (Jsonfeed.Unknown.is_empty unknown);

     

       530
       +
             match Jsont_bytesrw.encode_string' Attachment.jsont att with

     

       531
       +
             | Error e ->

     

       532
       +
                 Alcotest.fail

     

       533
       +
                   (Printf.sprintf "Encode failed: %s" (Jsont.Error.to_string e))

     

       534
       +
             | Ok json2 -> (

     

       535
       +
                 match Jsont_bytesrw.decode_string' Attachment.jsont json2 with

     

       536
       +
                 | Error e ->

     

       537
       +
                     Alcotest.fail

     

       538
       +
                       (Printf.sprintf "Re-parse failed: %s" (Jsont.Error.to_string e))

     

       539
       +
                 | Ok att2 ->

     

       540
       +
                     let unknown2 = Attachment.unknown att2 in

     

       541
       +
                     Alcotest.(check bool)

     

       542
       +
                       "unknown fields preserved" false

     

       543
       +
                       (Jsonfeed.Unknown.is_empty unknown2)))

     

       544
       +
       

     

       545
       +
       let unknown_fields_tests =

     

       546
       +
         [

     

       547
       +
           ("author unknown roundtrip", `Quick, test_author_unknown_roundtrip);

     

       548
       +
           ("item unknown roundtrip", `Quick, test_item_unknown_roundtrip);

     

       549
       +
           ("feed unknown roundtrip", `Quick, test_feed_unknown_roundtrip);

     

       550
       +
           ("hub unknown roundtrip", `Quick, test_hub_unknown_roundtrip);

     

       551
       +
           ("attachment unknown roundtrip", `Quick, test_attachment_unknown_roundtrip);

     

       552
       +
         ]

     

       553
       +
       

     

       554
        
       (* Main test suite *)

     

       555
        
       

     

       556
        
       let () =

     
···

       561
        
             ("Hub", hub_tests);

     

       562
        
             ("Item", item_tests);

     

       563
        
             ("Jsonfeed", jsonfeed_tests);

     

       564
       +
             ("Unknown Fields", unknown_fields_tests);

     

       565
        
           ]

Compare changes