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`.