Skip to content
ppx rewriter for [@@deriving jsobject]
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
other_tests
runtime
src
src_test
.gitignore
.merlin
LICENSE.txt
Makefile
Readme.md
TODO
descr
dune
dune-project
ppx_jsobject_conv.opam

Readme.md

Ppx_jsobject_conv

Ppx plugin for Typeconv to derive conversion from ocaml types to js objects to use with js_of_ocaml.

For types annotated with [@@deriving jsobject], plugin will generate pair of functions: *_of_jsobject/jsobject_of_* to convert from/to JavaScript objects. This allows one to use clean OCaml types to describe their logic, while having ability to easy go down to js types. Easy conversion from js objects to OCaml types means also, one can use fast native JSON.parse to convert JSON to OCaml types.

MIT License.

Installation

opam install ppx_jsobject_conv

Example usage

See expample of exported ocaml module or src_test for more info.

Short guide

module Stuff = struct
  type t = int * string * float [@@deriving jsobject]
end

type status = Created | Registered of int | Deleted of Stuff.t [@@deriving jsobject]

type user = {
    name: string;
    age: int;
    status: status
} [@@deriving jsobject]

This will generate functions Stuff.of_jsobject/Stuff.jsobject_of, status_of_jsobject/jsobject_of_status, user_of_jsobject/jsobject_of_user.

More details

Given type t = ... [@@deriving jsobject], signatures for functions will be:

val jsobject_of : t -> 'a Js.t
val of_jsobject : 'a Js.t -> (t, string) result

One can derive only one function from the pair using [@@deriving jsobject_of] or [@@deriving of_jsobject], and define complementary function manually, following signatures above.

For types named t generated functions have names without any prefixes, otherwise <typename_of_jsobject/jsobject_of_<typename> used.

Error reporting

If conversion from JS type to OCaml was unsuccessful, Error constructor of result type will be returned with the description of error. If error happened somewhere deep in the structure, error description will have prefix with path to errorneus field: message.1.query.condition.0.

Options

Option attribute names may be prefixed with jsobject. to avoid conflicts with other derivers.

[@key]

If the javascript object keys differ from OCaml conventions, lexical or otherwise, it is possible to specify the corresponding object key explicitly using [@key "field"], e.g.:

type geo = {
  lat : float [@jsobject.key "Latitude"];
  lon : float [@jsobject.key "Longitude"];
} [@@deriving jsobject]

[@name]

If the javascript object variant names differ from OCaml conventions, it is possible to specify the corresponding javascript string explicitly using [@name "constr"], e.g.:

type units =
  | Metric   [@jsobject.name "metric"]
  | Imperial [@jsobject.name "imperial"]
  [@@deriving jsobject]

[@sum_type_as]

By default, sum types are converted to javascript as arrays with first element being name of constructor: ["Constructor", A1, ... An]. This plugin supports alternative conversion of sum types to javascript as objects: {"Constructor": A}. Note, that only sum types, where all constructors are unary can be converted this way. One must use tuple explictily instead of multi-arity.

To use this option one can assign attribute [@jsobject.sum_type_as "object"] to any of the constructors of target sum type:

type query = Gt of int | Lt of int | Eq of int [@jsobject.sum_type_as "object"] [@@deriving jsobject]

Plugin can also treat sum types with null-ar constructors only as enum, e.g. treat type a = A | B as "A" or "B". To use this feature, assign [@jsobject.sum_type_as "enum"] to one of the constructors of target type. Note, one can only use one of the sum_type conversions per type, error will be raised otherwise.

Another option is to convert sum type without any tags, e.g. treat type a = A of string | B of int as "arg" or 42. In this case, parser will try to parse input as arguments one by one (starting from the last one). Note, that this option can lead to assimetric results, like for this type: type a = A of string | B of string. For type a, plugin will always generate javascript string, that will be converted to B arg.

[@default]

[@default expr] allows one to specify value to be used in case field value is missing/undefined in the input object:

type rec = {name: string; kind: string [@default "human"]} [@@deriving jsobject]
rec_of_jsobject (JSON.parse {|{"name": "jack"}|})
Ok({name="jack"; kind="human"})
rec_of_jsobject (JSON.parse {|{"name": "jack", "kind":null}|})
Error("kind: expected string got null")

[@drop_none]

[@drop_none] allows one to skip the field of option type from the record, if it holds None value:

type with_drops = {field: string option [@jsobject.drop_none]} [@@deriving jsobject]
type without_drops = {field: string option} [@@deriving jsobject]
jsobject_of_with_drops {field = None} (* {} *)
jsobject_of_without_drops {field = None} (* {"field": null} *)

Adding ppx_jsobject_conv to your project

Easiest way to use [@@deriving jsobject] is to link againts ppx_jsobject_conv (ppx_jsobject_conv in BuildDepents for _oasis or package(ppx_jsobject_conv) in _tags if you use ocamlbuild directly). This will add all necessary dependencies and will rewrite your source files. This, however, currently leads to inclusion of full ppx_type_conv, ppx_core and other stuff, so js_of_ocaml produces HUGE js file. You will also have to add +weak.js and +toplevel.js, since some functions from there are referenced by ppx_type_conv.

To overcome this issue, you will have to use different set of packages for compiling and linking: for compile phase you only need ppx_jsobject_conv, that will rewrite source code to include conversion routines. For linking, you don't need ppx_jsobject_conv with all that stuff ppx_type_conv brings on board. You will only need to add ppx_jsobject_conv.runtime that contains all necessary functions, used by generated code. To achieve this, add something like this to your _tags:

"src/core.byte": package(ppx_jsobject_conv.runtime)
<src/*.ml{,i,y}>: package(ppx_jsobject_conv)

If you're using _oasis, the best way is to not list ppx_jsobject_conv in BuildDepends at all, and just add two lines above after # OASIS STOP. Note that oasis will not check for library in that case, but I don't know better way to do this, yet %)

And, btw, I think smth like this should be done by default -- using ppx_type_conv, or any of its plugins, should not incur such penalty, and libraris, acting as shell for ppx rewriters should only be used at compile phase.

Standalone rewriter

Package also installs ppx-driver ppx_jsobject.byte that is useful for testing.

Build

make

You can’t perform that action at this time.