Merge branch 'main' into add-examples-tests

Author: aspeddro

CHANGELOG.md

@@ -2,6 +2,12 @@
 
 ## Next version
 
+## 1.0.0
+
+- Up ReScript dependency to 11+.
+- `JSON`, `Null` and `Nullable` untagged variants are now properly exposed.
+- BREAKING: Duplicated definition of `result` in `Result` module removed, as `result` is now a built in. Switch out any `Result.t` type annotations to point to the built in `result` instead.
+
 ## 0.7.0
 
 - Add `Dict.getUnsafe` https://github.com/rescript-association/rescript-core/pull/167

README.md

@@ -6,7 +6,7 @@ In ReScript 11, it is shipped as a separate npm package @rescript/core that is a
 
 ## Versioning
 
-- Versions `0.x` targets ReScript v10.1 and below.
+- Versions [`0.x`](https://github.com/rescript-association/rescript-core/tree/0.x) targets ReScript v10.1 and below.
 - Versions `1.x` targets ReScript v11 and above, and contains code that will not work with v10.1 and below.
 
 ## Background

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "@rescript/core",
-  "version": "0.7.0",
+  "version": "1.0.0",
   "scripts": {
     "clean": "rescript clean",
     "build": "rescript",
@@ -24,11 +24,10 @@
     "src/**/*.mjs"
   ],
   "peerDependencies": {
-    "rescript": "^10.1.0 || ^11.0.0"
+    "rescript": ">=11.0.0 || ^11.1.0-rc.2"
   },
   "devDependencies": {
-    "@babel/code-frame": "7.18.6",
-    "@rescript/tools": "^0.5.0",
-    "rescript": "^11.1.0-rc.2"
+    "rescript": "11.1.0-rc.2",
+    "@babel/code-frame": "7.18.6"
   }
 }

package.json

@@ -1,4 +1,11 @@
-type t = Js.Json.t
+@unboxed
+type rec t = Js.Json.t =
+  | Boolean(bool)
+  | @as(null) Null
+  | String(string)
+  | Number(float)
+  | Object(Core__Dict.t<t>)
+  | Array(array<t>)
 
 @raises @val external parseExn: string => t = "JSON.parse"
 @raises @val external parseExnWithReviver: (string, (string, t) => t) => t = "JSON.parse"

src/Core__JSON.res

@@ -5,7 +5,14 @@ Functions for interacting with JSON.
 /** 
 A type representing a JSON object.
 */
-type t = Js.Json.t
+@unboxed
+type rec t = Js.Json.t =
+  | Boolean(bool)
+  | @as(null) Null
+  | String(string)
+  | Number(float)
+  | Object(Core__Dict.t<t>)
+  | Array(array<t>)
 
 /** 
 `parseExn(string)` 

src/Core__JSON.resi

@@ -1,4 +1,7 @@
-type t<'a> = Js.Null.t<'a>
+@unboxed
+type t<'a> = Js.Null.t<'a> =
+  | Value('a)
+  | @as(null) Null
 
 external asNullable: t<'a> => Core__Nullable.t<'a> = "%identity"
 

src/Core__Null.res

@@ -7,7 +7,10 @@ If you also need to cover `undefined`, check out `Nullable` instead.
 /**
 A type representing a value that can be either `'a` or `null`.
 */
-type t<'a> = Js.Null.t<'a>
+@unboxed
+type t<'a> = Js.Null.t<'a> =
+  | Value('a)
+  | @as(null) Null
 
 /**
 Converts a `Null.t` into a `Nullable.t`.

src/Core__Null.resi

@@ -1,4 +1,7 @@
-type t<'a> = Js.Nullable.t<'a>
+type t<'a> = Js.Nullable.t<'a> =
+  | Value('a)
+  | @as(null) Null
+  | @as(undefined) Undefined
 
 external null: t<'a> = "#null"
 

src/Core__Nullable.res

@@ -8,7 +8,11 @@ Primarily useful when interoping with JavaScript when you don't know whether you
 Type representing a nullable value.
 A nullable value can be the value `'a`, `null` or `undefined`.
 */
-type t<'a> = Js.Nullable.t<'a>
+@unboxed
+type t<'a> = Js.Nullable.t<'a> =
+  | Value('a)
+  | @as(null) Null
+  | @as(undefined) Undefined
 
 /**
 The value `null`.

src/Core__Nullable.resi

@@ -1,15 +1,15 @@
 type t<+'a> = promise<'a>
 
 @new
-external make: ((@uncurry 'a => unit, 'e => unit) => unit) => t<'a> = "Promise"
+external make: (('a => unit, 'e => unit) => unit) => t<'a> = "Promise"
 
 @val @scope("Promise")
 external resolve: 'a => t<'a> = "resolve"
 
-@send external then: (t<'a>, @uncurry 'a => t<'b>) => t<'b> = "then"
+@send external then: (t<'a>, 'a => t<'b>) => t<'b> = "then"
 
 @send
-external thenResolve: (t<'a>, @uncurry 'a => 'b) => t<'b> = "then"
+external thenResolve: (t<'a>, 'a => 'b) => t<'b> = "then"
 
 @send external finally: (t<'a>, unit => unit) => t<'a> = "finally"
 
@@ -35,7 +35,7 @@ external all5: ((t<'a>, t<'b>, t<'c>, t<'d>, t<'e>)) => t<('a, 'b, 'c, 'd, 'e)>
 external all6: ((t<'a>, t<'b>, t<'c>, t<'d>, t<'e>, t<'f>)) => t<('a, 'b, 'c, 'd, 'e, 'f)> = "all"
 
 @send
-external _catch: (t<'a>, @uncurry exn => t<'a>) => t<'a> = "catch"
+external _catch: (t<'a>, exn => t<'a>) => t<'a> = "catch"
 
 let catch = (promise: promise<'a>, callback: exn => promise<'a>): promise<'a> => {
   _catch(promise, err => {

src/Core__Promise.res

@@ -73,7 +73,7 @@ Promise.make((resolve, reject) => {
 ```
 */
 @new
-external make: ((@uncurry 'a => unit, 'e => unit) => unit) => t<'a> = "Promise"
+external make: (('a => unit, 'e => unit) => unit) => t<'a> = "Promise"
 
 /**
 `catch(promise, errorCallback)` registers an exception handler in a promise chain.
@@ -139,7 +139,7 @@ Promise.resolve(5)
 ```
 */
 @send
-external then: (t<'a>, @uncurry 'a => t<'b>) => t<'b> = "then"
+external then: (t<'a>, 'a => t<'b>) => t<'b> = "then"
 
 /**
 `thenResolve(promise, callback)` converts an encapsulated value of a promise
@@ -163,7 +163,7 @@ In case you want to return another promise in your `callback`, consider using
 `then` instead.
 */
 @send
-external thenResolve: (t<'a>, @uncurry 'a => 'b) => t<'b> = "then"
+external thenResolve: (t<'a>, 'a => 'b) => t<'b> = "then"
 
 /**
 `finally(promise, callback)` is used to execute a function that is called no

src/Core__Promise.resi

@@ -22,8 +22,6 @@
  * 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<'a, 'b> = result<'a, 'b> = Ok('a) | Error('b)
-
 let getExn = x =>
   switch x {
   | Ok(x) => x

src/Core__Result.res

@@ -38,15 +38,13 @@
 
   ```res example
   type responseError = NotAvailable | NotFound
-  type queryResult = t<string, responseError>
+  type queryResult = result<string, responseError>
 
   let failQueryUser = (username: string): queryResult => {
     Error(NotAvailable)
   }
 ```
 */
-type t<'a, 'b> = result<'a, 'b> = Ok('a) | Error('b)
-
 /**
   `getExn(res)`: when `res` is `Ok(n)`, returns `n` when `res` is `Error(m)`, raise an exception
 
@@ -56,7 +54,7 @@ type t<'a, 'b> = result<'a, 'b> = Ok('a) | Error('b)
   Result.getExn(Result.Error("Invalid data")) /* raises exception */
   ```
 */
-let getExn: t<'a, 'b> => 'a
+let getExn: result<'a, 'b> => 'a
 
 /**
   `mapOr(res, default, f)`: When res is `Ok(n)`, returns `f(n)`,
@@ -70,10 +68,10 @@ let getExn: t<'a, 'b> => 'a
   Result.mapOr(error, 0, (x) => x / 2) == 0
   ```
 */
-let mapOr: (t<'a, 'c>, 'b, 'a => 'b) => 'b
+let mapOr: (result<'a, 'c>, 'b, 'a => 'b) => 'b
 
 @deprecated("Use mapOr instead")
-let mapWithDefault: (t<'a, 'c>, 'b, 'a => 'b) => 'b
+let mapWithDefault: (result<'a, 'c>, 'b, 'a => 'b) => 'b
 
 /**
   `map(res, f)`: When res is `Ok(n)`, returns `Ok(f(n))`. Otherwise returns res
@@ -88,7 +86,7 @@ let mapWithDefault: (t<'a, 'c>, 'b, 'a => 'b) => 'b
   Result.map(Error("Invalid data"), f) == Error("Invalid data")
   ```
 */
-let map: (t<'a, 'c>, 'a => 'b) => t<'b, 'c>
+let map: (result<'a, 'c>, 'a => 'b) => result<'b, 'c>
 
 /**
   `flatMap(res, f)`: When res is `Ok(n)`, returns `f(n)`. Otherwise, returns res
@@ -110,7 +108,7 @@ let map: (t<'a, 'c>, 'a => 'b) => t<'b, 'c>
   Result.flatMap(Error("Already bad"), recip) == Error("Already bad")
   ```
 */
-let flatMap: (t<'a, 'c>, 'a => t<'b, 'c>) => t<'b, 'c>
+let flatMap: (result<'a, 'c>, 'a => result<'b, 'c>) => result<'b, 'c>
 
 /**
   `getOr(res, defaultValue)`: If `res` is `Ok(n)`, returns `n`,
@@ -122,22 +120,22 @@ let flatMap: (t<'a, 'c>, 'a => t<'b, 'c>) => t<'b, 'c>
   Result.getOr(Error("Invalid Data"), 0) == 0
   ```
 */
-let getOr: (t<'a, 'b>, 'a) => 'a
+let getOr: (result<'a, 'b>, 'a) => 'a
 
 @deprecated("Use getOr instead")
-let getWithDefault: (t<'a, 'b>, 'a) => 'a
+let getWithDefault: (result<'a, 'b>, 'a) => 'a
 
 /**
   `isOk(res)`: Returns `true` if `res` is of the form `Ok(n)`, `false` if it is
   the `Error(e)` variant.
 */
-let isOk: t<'a, 'b> => bool
+let isOk: result<'a, 'b> => bool
 
 /**
   `isError(res)`: Returns `true` if `res` is of the form `Error(e)`, `false` if
   it is the `Ok(n)` variant.
 */
-let isError: t<'a, 'b> => bool
+let isError: result<'a, 'b> => bool
 
 /**
   `equal(res1, res2, f)`: Determine if two `Result` variables are equal with
@@ -166,7 +164,7 @@ let isError: t<'a, 'b> => bool
   Result.equal(bad1, bad2, mod10equal) == true
   ```
 */
-let equal: (t<'a, 'c>, t<'b, 'd>, ('a, 'b) => bool) => bool
+let equal: (result<'a, 'c>, result<'b, 'd>, ('a, 'b) => bool) => bool
 
 /**
   `compare(res1, res2, f)`: Compare two `Result` variables with respect to a
@@ -202,7 +200,7 @@ let equal: (t<'a, 'c>, t<'b, 'd>, ('a, 'b) => bool) => bool
   Result.compare(Error("x"), Error("y"), mod10cmp) == 0.
   ```
 */
-let compare: (t<'a, 'c>, t<'b, 'd>, ('a, 'b) => Core__Ordering.t) => Core__Ordering.t
+let compare: (result<'a, 'c>, result<'b, 'd>, ('a, 'b) => Core__Ordering.t) => Core__Ordering.t
 
 /**
 `forEach(res, f)` runs the provided function `f` on the `Ok` value. If `res` is `Error`, nothing happens.
@@ -214,7 +212,7 @@ Result.forEach(Ok(3), Console.log) // Logs "3", returns ()
 Result.forEach(Error("x"), Console.log) // Does nothing, returns ()
 ```
 */
-let forEach: (t<'a, 'b>, 'a => unit) => unit
+let forEach: (result<'a, 'b>, 'a => unit) => unit
 
 /**
 `mapError(r, f)` generates a new `result` by applying the function `f` to the `Error` value. If the source is `Ok`, return it as-is.

src/Core__Result.resi

@@ -61,35 +61,29 @@ type normalizeForm = [#NFC | #NFD | #NFKC | #NFKD]
 external unsafeReplaceRegExpBy0: (
   string,
   Core__RegExp.t,
-  (@uncurry ~match: string, ~offset: int, ~input: string) => string,
+  (~match: string, ~offset: int, ~input: string) => string,
 ) => string = "replace"
 
 @send
 external unsafeReplaceRegExpBy1: (
   string,
   Core__RegExp.t,
-  (@uncurry ~match: string, ~group1: string, ~offset: int, ~input: string) => string,
+  (~match: string, ~group1: string, ~offset: int, ~input: string) => string,
 ) => string = "replace"
 
 @send
 external unsafeReplaceRegExpBy2: (
   string,
   Core__RegExp.t,
-  (
-    @uncurry ~match: string,
-    ~group1: string,
-    ~group2: string,
-    ~offset: int,
-    ~input: string,
-  ) => string,
+  (~match: string, ~group1: string, ~group2: string, ~offset: int, ~input: string) => string,
 ) => string = "replace"
 
 @send
 external unsafeReplaceRegExpBy3: (
   string,
   Core__RegExp.t,
   (
-    @uncurry ~match: string,
+    ~match: string,
     ~group1: string,
     ~group2: string,
     ~group3: string,

src/Core__String.res

@@ -579,7 +579,7 @@ String.unsafeReplaceRegExpBy0(str, re, matchFn) == "bEAUtIfUl vOwEls"
 external unsafeReplaceRegExpBy0: (
   string,
   Core__RegExp.t,
-  (@uncurry ~match: string, ~offset: int, ~input: string) => string,
+  (~match: string, ~offset: int, ~input: string) => string,
 ) => string = "replace"
 
 /**
@@ -602,7 +602,7 @@ String.unsafeReplaceRegExpBy1(str, re, matchFn) == "Jony is 41"
 external unsafeReplaceRegExpBy1: (
   string,
   Core__RegExp.t,
-  (@uncurry ~match: string, ~group1: string, ~offset: int, ~input: string) => string,
+  (~match: string, ~group1: string, ~offset: int, ~input: string) => string,
 ) => string = "replace"
 
 /**
@@ -628,13 +628,7 @@ String.unsafeReplaceRegExpBy2(str, re, matchFn) == "42"
 external unsafeReplaceRegExpBy2: (
   string,
   Core__RegExp.t,
-  (
-    @uncurry ~match: string,
-    ~group1: string,
-    ~group2: string,
-    ~offset: int,
-    ~input: string,
-  ) => string,
+  (~match: string, ~group1: string, ~group2: string, ~offset: int, ~input: string) => string,
 ) => string = "replace"
 
 /**
@@ -647,7 +641,7 @@ external unsafeReplaceRegExpBy3: (
   string,
   Core__RegExp.t,
   (
-    @uncurry ~match: string,
+    ~match: string,
     ~group1: string,
     ~group2: string,
     ~group3: string,