@tellahq/rescript 10.1.0-alpha.1

package/lib/ocaml/js_types.ml

@@ -0,0 +1,118 @@
+(* 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 symbol
+(** Js symbol type only available in ES6 *)
+
+type bigint_val = Js_bigint.t
+(** Js bigint type only available in ES2020 *)
+
+type obj_val
+type undefined_val
+(** This type has only one value `undefined` *)
+
+type null_val
+(** This type has only one value `null` *)
+
+type function_val
+
+type _ t =
+  | Undefined :  undefined_val t
+  | Null : null_val t
+  | Boolean : bool t
+  | Number : float t
+  | String : string t
+  | Function : function_val t
+  | Object : obj_val t
+  | Symbol : symbol t
+  | BigInt : bigint_val t
+
+
+
+type tagged_t =
+  | JSFalse
+  | JSTrue
+  | JSNull
+  | JSUndefined
+  | JSNumber of float
+  | JSString of string
+  | JSFunction of function_val
+  | JSObject of obj_val
+  | JSSymbol of symbol
+  | JSBigInt of bigint_val
+
+let classify (x : 'a) : tagged_t =
+  let ty = Js.typeof x in
+  if ty = "undefined" then
+    JSUndefined else
+  if x == (Obj.magic Js_null.empty)  then
+    JSNull else
+  if ty = "number" then
+    JSNumber (Obj.magic x) else
+  if ty = "bigint" then
+    JSBigInt (Obj.magic x) else
+  if ty = "string" then
+    JSString (Obj.magic x) else
+  if ty = "boolean" then
+    if (Obj.magic x) = true then JSTrue
+    else JSFalse else
+  if ty = "symbol" then
+    JSSymbol (Obj.magic x) else
+  if ty = "function" then
+    JSFunction (Obj.magic x)
+  else
+    JSObject (Obj.magic x)
+
+
+let test (type a) (x : 'a) (v : a t) : bool =
+  match v with
+  | Number
+    ->
+     Js.typeof x = "number"
+  | Boolean
+    ->
+     Js.typeof x = "boolean"
+  | Undefined
+    ->
+    Js.typeof x = "undefined"
+  | Null
+    ->
+    x == (Obj.magic Js_null.empty)
+  | String
+    ->
+    Js.typeof x = "string"
+  | Function
+    ->
+    Js.typeof x = "function"
+  | Object
+    ->
+    Js.typeof x = "object"
+  | Symbol
+    ->
+    Js.typeof x = "symbol"
+  | BigInt
+    ->
+    Js.typeof x = "bigint"

package/lib/ocaml/js_types.mli

@@ -0,0 +1,78 @@
+(* 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 manipulating JS types. *)
+
+type symbol
+(** Js symbol type (only available in ES6) *)
+
+type bigint_val
+(** Js bigint type only available in ES2020 *)
+
+type obj_val
+
+type undefined_val
+(** This type has only one value `undefined` *)
+
+type null_val
+(** This type has only one value `null` *)
+
+type function_val
+
+type _ t =
+  | Undefined : undefined_val t
+  | Null : null_val t
+  | Boolean : bool t
+  | Number : float t
+  | String : string t
+  | Function : function_val t
+  | Object : obj_val t
+  | Symbol : symbol t
+  | BigInt : bigint_val t
+
+val test : 'a -> 'b t -> bool
+(**
+   `test(value, t)` returns `true` if `value` is `typeof t`, otherwise `false`.
+   This is useful for doing runtime reflection on any given value.
+
+   ```res example
+   test("test", String) == true
+   test(() => true, Function) == true
+   test("test", Boolean) == false
+   ```
+*)
+
+type tagged_t =
+  | JSFalse
+  | JSTrue
+  | JSNull
+  | JSUndefined
+  | JSNumber of float
+  | JSString of string
+  | JSFunction of function_val
+  | JSObject of obj_val
+  | JSSymbol of symbol
+  | JSBigInt of bigint_val
+
+val classify : 'a -> tagged_t

package/lib/ocaml/js_undefined.ml

@@ -0,0 +1,59 @@
+(* 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 functionality for dealing with the `'a Js.undefined` type *)
+
+type + 'a t = 'a Js.undefined
+external to_opt : 'a t -> 'a option = "#undefined_to_opt"
+external toOption : 'a t -> 'a option = "#undefined_to_opt"
+external return : 'a -> 'a t = "%identity"
+
+
+  
+external empty : 'a t = "#undefined"
+let test : 'a t -> bool =  fun x -> x = empty
+let testAny : 'a -> bool = fun x -> Obj.magic x = empty 
+external getUnsafe : 'a t -> 'a = "%identity"
+
+let getExn f =
+  match toOption f with 
+  | None -> Js_exn.raiseError "Js.Undefined.getExn"
+  | Some x -> x 
+
+let bind x f =
+  match to_opt x with
+  | None -> empty
+  | Some x -> return (f  x [@bs])
+
+let iter x f =
+  match to_opt x with
+  | None ->  ()
+  | Some x -> f x [@bs]
+
+let fromOption x =
+  match x with
+  | None -> empty
+  | Some x -> return x
+
+let from_opt = fromOption

package/lib/ocaml/js_undefined.mli

@@ -0,0 +1,92 @@
+(* 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 functionality for dealing with the `Js.undefined('a)` type *)
+
+type +'a t = 'a Js.undefined
+(** Local alias for `Js.undefined('a)` *)
+
+external return : 'a -> 'a t = "%identity"
+(** Constructs a value of `Js.undefined('a)` containing a value of `'a`. *)
+
+val test : 'a t -> bool
+  [@@deprecated "Use = Js.undefined directly"]
+(** Returns `true` if the given value is empty (undefined), `false` otherwise. *)
+
+val testAny : 'a -> bool
+(**
+Returns `true` if the given value is empty (undefined).
+
+**since 1.6.1**
+*)
+
+external empty : 'a t = "#undefined"
+(** The empty value, `undefined` *)
+
+external getUnsafe : 'a t -> 'a = "%identity"
+val getExn : 'a t -> 'a
+
+val bind : 'a t -> (('a -> 'b)[@bs]) -> 'b t
+(**
+Maps the contained value using the given function.
+If `Js.undefined('a)` contains a value, that value is unwrapped, mapped to a
+`'b` using the given function `a' => 'b`, then wrapped back up and returned as
+`Js.undefined('b)`.
+
+```res example
+let maybeGreetWorld = (maybeGreeting: Js.undefined<string>) =>
+  Js.Undefined.bind(maybeGreeting, (. greeting) => greeting ++ " world!")
+```
+*)
+
+val iter : 'a t -> (('a -> unit)[@bs]) -> unit
+(**
+Iterates over the contained value with the given function. If
+`Js.undefined('a)` contains a value, that value is unwrapped and applied to the
+given function.
+
+```res example
+let maybeSay = (maybeMessage: Js.undefined<string>) =>
+  Js.Undefined.iter(maybeMessage, (. message) => Js.log(message))
+```
+*)
+
+val fromOption : 'a option -> 'a t
+(**
+Maps `option('a)` to `Js.undefined('a)`.
+`Some(a)` => `a`
+`None` => `empty`
+*)
+
+val from_opt : 'a option -> 'a t [@@deprecated "Use fromOption instead"]
+
+external toOption : 'a t -> 'a option = "#undefined_to_opt"
+(**
+Maps `Js.undefined('a)` to `option('a)`
+`a` => `Some(a)`
+`empty` => `None`
+*)
+
+external to_opt : 'a t -> 'a option = "#undefined_to_opt"
+  [@@deprecated "use toOption instead"]

package/lib/ocaml/js_vector.ml

@@ -0,0 +1,143 @@
+(* 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 'a t = 'a array
+
+external length : 'a array -> int = "%array_length"
+external get : 'a array -> int -> 'a = "%array_safe_get"
+external set : 'a array -> int -> 'a -> unit = "%array_safe_set"
+external make: int -> 'a -> 'a array = "?make_vect"
+external unsafe_get : 'a t -> int -> 'a = "%array_unsafe_get"
+external unsafe_set : 'a t -> int -> 'a -> unit = "%array_unsafe_set"
+
+(** **param** a array
+
+    **param** p predicate
+*)
+let filterInPlace p a =
+  let  i = ref 0 in
+  let j = ref 0 in
+  while i.contents < Js_array2.length a do
+    let v = Js_array2.unsafe_get a i.contents in
+    if p v   [@bs] then
+      begin
+        Js_array2.unsafe_set a j.contents v ;
+        j.contents <- j.contents + 1
+      end;
+    i.contents <- i.contents + 1
+  done;
+  Js_array2.removeFromInPlace a ~pos:j.contents |. ignore
+
+let empty a  =
+  Js_array2.removeFromInPlace a ~pos:0 |. ignore
+
+let pushBack x xs =
+  Js_array2.push xs x |. ignore
+
+(** Find by JS (===)  equality *)
+let memByRef x xs =
+  Js_array2.indexOf xs x >= 0
+
+let iter f  xs =
+  for i = 0 to Js_array2.length xs - 1 do
+    f (Js_array2.unsafe_get xs i) [@bs]
+  done
+
+let iteri f a =
+  for i = 0 to length a - 1 do f i (unsafe_get a i) [@bs] done
+
+
+
+external createUnsafe : int -> 'a t = "Array" [@@bs.new]
+
+(* let ofList xs =  *)
+(*   match xs with  *)
+(*   | [] -> [||] *)
+(*   | l -> *)
+(*     let a = createUnsafe (Js_list.length l) in  *)
+(*     let rec fill i = function *)
+(*         | [] -> a *)
+(*         | hd::tl -> Array.unsafe_set a i hd; fill (i+1) tl in *)
+(*     fill 0 l *)
+
+let toList a =
+  let rec tolist i res =
+    if i < 0 then res else tolist (i - 1) (unsafe_get a i :: res) in
+  tolist (length a - 1) []
+
+
+let init n f  =
+  let v = createUnsafe n in
+  for i = 0 to n - 1 do
+    unsafe_set v i (f i [@bs])
+  done ;
+  v
+
+let copy x =
+  let len = length x in
+  let b = createUnsafe len in
+  for i = 0 to len - 1 do
+    unsafe_set b i (unsafe_get x i)
+  done  ;
+  b
+
+let map f a =
+  let l = Js_array2.length a in
+  let r = createUnsafe l in
+  for i = 0 to l - 1 do
+      unsafe_set r i (f(unsafe_get a i) [@bs])
+  done;
+  r
+
+
+let foldLeft f x a =
+  let r = ref x in
+  for i = 0 to length a - 1 do
+    r.contents<- f r.contents (unsafe_get a i) [@bs]
+  done;
+  r.contents
+
+
+let foldRight f a x =
+  let r = ref x in
+  for i = length a - 1 downto 0 do
+    r.contents<- f (unsafe_get a i) r.contents [@bs]
+  done;
+  r.contents
+
+
+let mapi f a =
+  let l = length a in
+  if l = 0 then [||] else begin
+    let r= createUnsafe l in
+    for i = 0 to l - 1 do
+      unsafe_set r i (f i (unsafe_get a i) [@bs])
+    done;
+    r
+  end
+
+let append x a =
+  Js_array2.concat a [|x|]
+
+(* TODO: add `append` *)

package/lib/ocaml/js_vector.mli

@@ -0,0 +1,92 @@
+(* 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. *)
+
+[@@@deprecated "Use Belt.Array instead"]
+
+type 'a t = 'a array
+
+val filterInPlace : (('a -> bool)[@bs]) -> 'a t -> unit
+val empty : 'a t -> unit
+val pushBack : 'a -> 'a t -> unit
+
+val copy : 'a t -> 'a t
+(** shallow copy *)
+
+val memByRef : 'a -> 'a t -> bool
+val iter : (('a -> unit)[@bs]) -> 'a t -> unit
+val iteri : ((int -> 'a -> unit)[@bs]) -> 'a t -> unit
+
+(* [@@deprecated "Use Js.List.toVector instead"] *)
+(* val ofList : 'a list -> 'a t   *)
+(* removed, we choose that [`Js.List`]() depends on Vector to avoid cylic dependency
+*)
+
+val toList : 'a t -> 'a list
+val map : (('a -> 'b)[@bs]) -> 'a t -> 'b t
+val mapi : ((int -> 'a -> 'b)[@bs]) -> 'a t -> 'b t
+val foldLeft : (('a -> 'b -> 'a)[@bs]) -> 'a -> 'b t -> 'a
+val foldRight : (('b -> 'a -> 'a)[@bs]) -> 'b t -> 'a -> 'a
+
+external length : 'a t -> int = "%array_length"
+(** Return the length (number of elements) of the given array. *)
+
+external get : 'a t -> int -> 'a = "%array_safe_get"
+(**
+`Vector.get(a, n)` returns the element number `n` of vector `a`. The first
+element has number 0. The last element has number `Vector.length(a) - 1`. You
+can also write `a[n]` instead of `Vector.get(a, n)`. Raise `Invalid_argument
+"index out of bounds"` if `n` is outside the range 0 to (`Array.length(a) -
+1`).
+*)
+
+external set : 'a t -> int -> 'a -> unit = "%array_safe_set"
+(**
+`Vector.set(a, n, x)` modifies vector `a` in place, replacing element number
+`n` with `x`. Raise `Invalid_argument "index out of bounds"` if `n` is outside
+the range 0 to `Array.length(a) - 1`.
+*)
+
+external make : int -> 'a -> 'a t = "?make_vect"
+(**
+`Vector.make(n, x)` returns a fresh vector of length `n`, initialized with `x`.
+All the elements of this new vector are initially physically equal to `x` (in
+the sense of the `==` predicate). Consequently, if `x` is mutable, it is shared
+among all elements of the array, and modifying `x` through one of the array
+entries will modify all other entries at the same time. Raise
+`Invalid_argument` if `n < 0` or `n > Sys.max_array_length`. If the value of
+`x` is a floating-point number, then the maximum size is only
+`Sys.max_array_length / 2`.
+*)
+
+val init : int -> ((int -> 'a)[@bs]) -> 'a t
+(**
+Raises `RangeError` when n is negative.
+n : size
+*)
+
+val append : 'a -> 'a t -> 'a t
+(** `append(x, a)` returns a fresh vector with `x` appended to `a`. *)
+
+external unsafe_get : 'a t -> int -> 'a = "%array_unsafe_get"
+external unsafe_set : 'a t -> int -> 'a -> unit = "%array_unsafe_set"

package/lib/ocaml/js_weakmap.ml

@@ -0,0 +1,3 @@
+(** ES6 WeakMap API *)
+
+type ('k, 'v) t

package/lib/ocaml/js_weakset.ml

@@ -0,0 +1,3 @@
+(** ES6 WeakSet API *)
+
+type 'a t

package/lib/ocaml/jsx.ml

@@ -0,0 +1,39 @@
+(* 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 element
+type ref
+
+external null : element = "null" [@@bs.val]
+external float : float -> element = "%identity"
+external int : int -> element = "%identity"
+external string : string -> element = "%identity"
+external array : element array -> element = "%identity"
+
+type ('props, 'return) componentLike = 'props -> 'return
+type 'props component = ('props, element) componentLike
+
+(* this function exists to prepare for making `component` abstract *)
+external component : ('props, element) componentLike -> 'props component
+  = "%identity"