@tellahq/rescript 10.1.4-republish-2 → 10.1.4-republish-3

package/lib/ocaml/js_dict.ml

@@ -0,0 +1,114 @@
+(* Copyright (C) 2015-2016 Bloomberg Finance L.P.
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Lesser General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * In addition to the permissions granted to you by the LGPL, you may combine
+ * or link a "work that uses the Library" with a publicly distributed version
+ * of this file to produce a combined library or application, then distribute
+ * that combined work under the terms of your choosing, with no requirement
+ * to comply with the obligations normally placed on you by section 4 of the
+ * LGPL version 3 (or the corresponding section of a later version of the LGPL
+ * should you choose to use a later version).
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. *)
+
+(** Provides a simple key-value dictionary abstraction over native JavaScript objects *)
+
+(** The dict type *)
+type 'a t
+
+(** The key type, an alias of string *)
+type key = string
+
+(**
+  `unsafeGet dict key` returns the value associated with `key` in `dict`
+
+  This function will return an invalid value (`undefined`) if `key` does not exist in `dict`. It
+  will not throw an error.
+*)
+external unsafeGet : 'a t -> key -> 'a = "" [@@bs.get_index]
+let (.!()) = unsafeGet
+
+(** `get dict key` returns the value associated with `key` in `dict` *)
+let get (type u) (dict : u t) (k : key) : u option =
+  if [%raw {|k in dict|}] then
+    Some dict.!(k)
+  else None
+
+(** `set dict key value` sets the value of `key` in `dict` to `value` *)
+external set : 'a t -> key -> 'a -> unit = "" [@@bs.set_index]
+
+(** `keys dict` returns an array of all the keys in `dict` *)
+external keys : 'a t -> key array = "Object.keys" [@@bs.val]
+
+(** `empty ()` creates an empty dictionary *)
+external empty : unit -> 'a t = "" [@@bs.obj]
+
+
+let unsafeDeleteKey : string t -> string -> unit [@bs] =
+  [%raw {| function (dict,key){
+      delete dict[key];
+     }
+  |}]
+
+
+external unsafeCreate : int -> 'a array = "Array" [@@bs.new]
+(* external entries : 'a t -> (key * 'a) array = "Object.entries" [@@bs.val] (* ES2017 *) *)
+let entries dict =
+  let keys = keys dict in
+  let l = Js_array2.length keys in
+  let values = unsafeCreate l in
+  for i = 0 to l - 1 do
+    let key = Js_array2.unsafe_get keys i in
+    Js_array2.unsafe_set values i (key, dict.!(key))
+  done;
+  values
+
+(* external values : 'a t -> 'a array = "Object.values" [@@bs.val] (* ES2017 *) *)
+let values dict =
+  let keys = keys dict in
+  let l = Js_array2.length keys in
+  let values = unsafeCreate l in
+  for i = 0 to l - 1 do
+    Js_array2.unsafe_set values i  dict.!(Js_array2.unsafe_get keys i)
+  done;
+  values
+
+let fromList entries =
+  let dict = empty () in
+  let rec loop = function
+  | [] -> dict
+  | (key, value) :: rest ->
+    set dict key value;
+    loop rest
+  in
+  loop entries
+
+let fromArray entries =
+  let dict = empty () in
+  let l = Js_array2.length entries in
+  for i = 0 to l - 1 do
+    let (key, value) = Js_array2.unsafe_get entries i in
+    set dict key value
+  done;
+  dict
+
+let map f source =
+  let target = empty () in
+  let keys = keys source in
+  let l = Js_array2.length keys in
+  for i = 0 to l - 1 do
+    let key = Js_array2.unsafe_get keys i in
+    set target key (f (unsafeGet source key) [@bs])
+  done;
+  target

package/lib/ocaml/js_dict.mli

@@ -0,0 +1,152 @@
+(* Copyright (C) 2015-2016 Bloomberg Finance L.P.
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Lesser General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * In addition to the permissions granted to you by the LGPL, you may combine
+ * or link a "work that uses the Library" with a publicly distributed version
+ * of this file to produce a combined library or application, then distribute
+ * that combined work under the terms of your choosing, with no requirement
+ * to comply with the obligations normally placed on you by section 4 of the
+ * LGPL version 3 (or the corresponding section of a later version of the LGPL
+ * should you choose to use a later version).
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. *)
+
+(**
+Provide utilities for JS dictionary object.
+
+**Note:** This module's examples will assume this predeclared dictionary:
+
+```res prelude
+let ages = Js.Dict.fromList(list{("Maria", 30), ("Vinh", 22), ("Fred", 49)})
+```
+*)
+
+type 'a t
+(**
+Dictionary type (ie an '{ }' JS object). However it is restricted to hold a
+single type; therefore values must have the same type. This Dictionary type is
+mostly used with the Js_json.t type.
+*)
+
+type key = string
+(** The type for dictionary keys. This means that dictionaries *must* use `string`s as their keys. *)
+
+val get : 'a t -> key -> 'a option
+(**
+`Js.Dict.get(key)` returns `None` if the key is not found in the dictionary,
+`Some(value)` otherwise.
+
+```res example
+Js.Dict.get(ages, "Vinh") == Some(22)
+Js.Dict.get(ages, "Paul") == None
+```
+*)
+
+external unsafeGet : 'a t -> key -> 'a = ""
+  [@@bs.get_index]
+(**
+`Js.Dict.unsafeGet(key)` returns the value if the key exists, otherwise an `undefined` value is returned. Use this only when you are sure the key exists (i.e. when having used the `keys()` function to check that the key is valid).
+
+```res example
+Js.Dict.unsafeGet(ages, "Fred") == 49
+Js.Dict.unsafeGet(ages, "Paul") // returns undefined
+```
+*)
+
+external set : 'a t -> key -> 'a -> unit = ""
+  [@@bs.set_index]
+(**
+`Js.Dict.set(dict, key, value)` sets the key/value in the dictionary `dict`. If
+the key does not exist, and entry will be created for it.
+
+*This function modifies the original dictionary.*
+
+```res example
+Js.Dict.set(ages, "Maria", 31)
+Js.log(ages == Js.Dict.fromList(list{("Maria", 31), ("Vinh", 22), ("Fred", 49)}))
+
+Js.Dict.set(ages, "David", 66)
+Js.log(ages == Js.Dict.fromList(list{("Maria", 31), ("Vinh", 22), ("Fred", 49), ("David", 66)}))
+```
+*)
+
+external keys : 'a t -> string array = "Object.keys"
+  [@@bs.val]
+(**
+Returns all the keys in the dictionary `dict`.
+
+```res example
+Js.Dict.keys(ages) == ["Maria", "Vinh", "Fred"]
+```
+*)
+
+external empty : unit -> 'a t = ""
+  [@@bs.obj]
+(** Returns an empty dictionary. *)
+
+val unsafeDeleteKey : (string t -> string -> unit[@bs])
+(** Experimental internal function *)
+
+val entries : 'a t -> (key * 'a) array
+(**
+Returns an array of key/value pairs in the given dictionary (ES2017).
+
+```res example
+Js.Dict.entries(ages) == [("Maria", 30), ("Vinh", 22), ("Fred", 49)]
+```
+*)
+
+val values : 'a t -> 'a array
+(**
+Returns the values in the given dictionary (ES2017).
+
+```res example
+Js.Dict.values(ages) == [30, 22, 49]
+```
+*)
+
+val fromList : (key * 'a) list -> 'a t
+(**
+Creates a new dictionary containing each (key, value) pair in its list
+argument.
+
+```res example
+let capitals = Js.Dict.fromList(list{("Japan", "Tokyo"), ("France", "Paris"), ("Egypt", "Cairo")})
+```
+*)
+
+val fromArray : (key * 'a) array -> 'a t
+(**
+Creates a new dictionary containing each (key, value) pair in its array
+argument.
+
+```res example
+let capitals2 = Js.Dict.fromArray([("Germany", "Berlin"), ("Burkina Faso", "Ouagadougou")])
+```
+*)
+
+val map : (('a -> 'b)[@bs]) -> 'a t -> 'b t
+(**
+`map(f, dict)` maps `dict` to a new dictionary with the same keys, using the
+function `f` to map each value.
+
+```res example
+let prices = Js.Dict.fromList(list{("pen", 1.00), ("book", 5.00), ("stapler", 7.00)})
+
+let discount = (. price) => price *. 0.90
+let salePrices = Js.Dict.map(discount, prices)
+
+salePrices == Js.Dict.fromList(list{("pen", 0.90), ("book", 4.50), ("stapler", 6.30)})
+```
+*)

package/lib/ocaml/js_exn.ml

@@ -0,0 +1,102 @@
+(* Copyright (C) 2015-2016 Bloomberg Finance L.P.
+ * 
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Lesser General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * In addition to the permissions granted to you by the LGPL, you may combine
+ * or link a "work that uses the Library" with a publicly distributed version
+ * of this file to produce a combined library or application, then distribute
+ * that combined work under the terms of your choosing, with no requirement
+ * to comply with the obligations normally placed on you by section 4 of the
+ * LGPL version 3 (or the corresponding section of a later version of the LGPL
+ * should you choose to use a later version).
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Lesser General Public License for more details.
+ * 
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. *)
+
+
+type t = unknown 
+
+[@@@warning "-38"] (* unused extension constructor*)
+exception Error = JsError
+
+external asJsExn : exn -> t option = 
+  "?as_js_exn"
+
+external stack : t -> string option = "stack"
+  [@@bs.get] 
+external message : t -> string option = "message"
+  [@@bs.get] 
+external name : t -> string option = "name"
+  [@@bs.get] 
+external fileName : t -> string option = "fileName"
+  [@@bs.get] 
+
+type error
+external makeError : string -> error = "Error" [@@bs.new]
+external isCamlExceptionOrOpenVariant : 
+  'a -> bool = "?is_extension"
+
+external anyToExnInternal : 'a -> exn = "#wrap_exn"
+  
+
+let raiseError str = 
+  raise (Obj.magic (makeError str : error) : exn)
+
+type eval_error
+external makeEvalError : string -> eval_error = "EvalError" [@@bs.new]
+
+let raiseEvalError str = 
+  raise (Obj.magic (makeEvalError str : eval_error) : exn)
+
+type range_error 
+external makeRangeError : string -> range_error = "RangeError" [@@bs.new]
+
+let raiseRangeError str = 
+  raise (Obj.magic (makeRangeError str : range_error) : exn)
+
+type reference_error 
+
+external makeReferenceError : string  -> reference_error = "ReferenceError" [@@bs.new]
+
+let raiseReferenceError str = 
+  raise (Obj.magic (makeReferenceError str))
+
+type syntax_error 
+external makeSyntaxError : string -> syntax_error = "SyntaxError" [@@bs.new]
+
+let raiseSyntaxError str = 
+  raise (Obj.magic (makeSyntaxError str))
+
+type type_error
+external makeTypeError : string -> type_error = "TypeError" [@@bs.new]
+
+let raiseTypeError str = 
+  raise (Obj.magic (makeTypeError str))
+
+type uri_error
+external makeURIError : string -> uri_error = "URIError" [@@bs.new]
+
+let raiseUriError str = 
+  raise (Obj.magic (makeURIError str))
+
+(** TODO add predicate to tell which error is which *)
+(*
+exception EvalError of error
+exception RangeError of error
+exception ReferenceError of error
+exception SyntaxError of error
+exception TypeError of error
+
+ The URIError object represents an error when a global URI handling function was used in a wrong way. 
+exception URIError of error    
+*)
+

package/lib/ocaml/js_exn.mli

@@ -0,0 +1,79 @@
+(* Copyright (C) 2015-2016 Bloomberg Finance L.P.
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Lesser General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * In addition to the permissions granted to you by the LGPL, you may combine
+ * or link a "work that uses the Library" with a publicly distributed version
+ * of this file to produce a combined library or application, then distribute
+ * that combined work under the terms of your choosing, with no requirement
+ * to comply with the obligations normally placed on you by section 4 of the
+ * LGPL version 3 (or the corresponding section of a later version of the LGPL
+ * should you choose to use a later version).
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. *)
+
+(** Provide utilities for dealing with JS exceptions. *)
+
+type t
+(** Represents a JS exception *)
+
+type exn += private Error of t
+
+external asJsExn : exn -> t option =
+  "?as_js_exn"
+
+external stack : t -> string option = "stack"
+[@@bs.get]
+external message : t -> string option = "message"
+[@@bs.get]
+external name : t -> string option = "name"
+[@@bs.get]
+external fileName : t -> string option = "fileName"
+[@@bs.get]
+
+
+external isCamlExceptionOrOpenVariant:
+  'a -> bool = "?is_extension"
+(** internal use only *)
+
+external anyToExnInternal : 'a -> exn = "#wrap_exn"
+(**
+  `anyToExnInternal obj` will take any value `obj` and wrap it
+  in a Js.Exn.Error if given value is not an exn already. If
+  `obj` is an exn, it will return `obj` without any changes.
+
+  This function is mostly useful for cases where you want to unify a type of a value
+  that potentially is either exn, a JS error, or any other JS value really (e.g. for
+  a value passed to a Promise.catch callback)
+
+  **IMPORTANT**: This is an internal API and may be changed / removed any time in the future.
+
+  ```
+  switch (Js.Exn.unsafeAnyToExn("test")) {
+  | Js.Exn.Error(v) =>
+    switch(Js.Exn.message(v)) {
+    | Some(str) => Js.log("We won't end up here")
+    | None => Js.log2("We will land here: ", v)
+    }
+  }
+  ```
+*)
+
+(** Raise Js exception Error object with stacktrace *)
+val raiseError : string -> 'a
+val raiseEvalError : string -> 'a
+val raiseRangeError : string -> 'a
+val raiseReferenceError :  string -> 'a
+val raiseSyntaxError : string -> 'a
+val raiseTypeError : string -> 'a
+val raiseUriError :  string -> 'a