rescript-relay 0.22.0 → 1.0.0-beta.3

package/CHANGELOG.md

@@ -1,5 +1,78 @@
 # master
 
+# 1.0.0-beta.3
+
+_[Here's a commit showing a project being upgraded to this version](https://github.com/zth/rescript-relay/commit/5831c2f1f0f13eedc1cb60468c32fd32b2dc01d3)_
+
+The time has finally come - RescriptRelay `1.0.0` is in beta! The one, big major thing this release brings is that the ReScript type generation for the Relay compiler has been completely rewritten, and fully integrated into the new Relay Rust compiler. The RescriptRelay fork of the compiler is available and maintained [here])(https://github.com/zth/relay/tree/rescript-relay).
+
+## Remove Packages
+
+You can go ahead and remove these packages, that are no longer needed, as the compiler is now shipped in the main package:
+
+- `relay-config`
+- `relay-compiler`
+- `graphql` (if you don't use it for anything else)
+
+## Breaking Changes
+
+- The compiler expects the `__generated__` folder to always exist, so if you're not committing your artifacts to source control, make sure you add a `.gitkeep` to the generated folder so git keeps it around.
+
+## Improvements
+
+- The compiler itself should be _much_ faster than the old one. An order of magnitude faster. Especially for incremental compilation in watch mode.
+- There's no longer any need to manually select `__typename` on interfaces and unions for RescriptRelay's sake, unless you actually want to use it yourself.
+- We now support the `@required` directive from Relay, which is a new directive that lets you force non-nullability for nullable fields on the client side. You can then choose to throw an error if null values are encountered, or let the null value bubble up. Docs are coming soon, and you'll need to do `RescriptRelay.relayFeatureFlags.enableRequiredDirective = true` somewhere in your code to enable it for now.
+- The errors reported by the compiler is now quite a lot better.
+
+## Beta fix changelog
+
+### beta.3
+
+- Fix issue with duplicate keys being printed in the conversion instructions.
+- Get rid of the need of nullability conversion instructions, and infer them instead.
+
+### beta.2
+
+- Fix issue with recursive input objects not being converted correctly.
+
+# 0.23.0
+
+_[Here's a commit showing a project being upgraded to this version](https://github.com/zth/rescript-relay/commit/6e96dfafaec918b1d4e9519d3fcbf5e5c46be6c0)_
+
+Finally, a new release! This brings the Relay version to 12, and the React version to 18 (in rc.0 at the time of writing). This release has a few breaking changes which are necessary as we're slowly approaching version 1.0.0 of RescriptRelay. Check the new "Migrations" section below for a few scripts you can run to help the migration.
+
+## Upgrade versions
+
+- `react-relay` to `12.0.0`
+- `relay-compiler` to `12.0.0`
+- `relay-config` to `12.0.0`
+- `relay-runtime` to `12.0.0`
+
+React to React 18 rc:
+
+- `react` to `rc` (`yarn add react@rc`)
+- `react-dom` to `rc`(`yarn add react-dom@rc`)
+
+## Migrations
+
+Want help migrating most of the changes in this release? Install [comby](https://comby.dev) and run the migrations below (paste them into your terminal at the root of your project). Comby will guide you through the proposed changes.
+
+- `comby 'ReactExperimental.unstable_useDeferredValue(:[1])' 'ReactExperimental.useDeferredValue(:[1])' .res -matcher .re -exclude-dir node_modules -review`
+- `comby 'ReactExperimental.renderConcurrentRootAtElementWithId' 'ReactDOMExperimental.renderConcurrentRootAtElementWithId' .res -matcher .re -exclude-dir node_modules -review`
+- `comby 'let (:[1], :[2]) = ReactExperimental.unstable_useTransition()' 'let (:[2], :[1]) = ReactExperimental.useTransition()' .res -matcher .re -exclude-dir node_modules -review`
+
+## Breaking changes
+
+- Remove `reason-promise` (unless you're using it for something else yourself and want to keep it). We're waiting for the official new Promise bindings, but since they seem to be quite far away, we'll have to revert back to stock `Js.Promise` for now. This is because `reason-promise` clashes with other Promise bindings that people might want to use before the new official ones are actually shipped.
+- `ReactExperimental.unstable_useTransition` is now called `ReactExperimental.useTransition`, and the order of the tuple that's returned has been reversed to align with the underlying API. This means that what was before `let (startTransition, isTransitioning) = ReactExperimental.unstable_useTransition()` is now `let (isTransitioning, startTransition) = ReactExperimental.useTransition()` (migration available above).
+- `ReactExperimental.unstable_useDeferredValue` is now called `ReactExperimental.useDeferredValue` (migration available above).
+- `ReactExperimental.renderConcurrentRootAtElementWithId` has moved to `ReactDOMExperimental`: `ReactDOMExperimental.renderConcurrentRootAtElementWithId` (migration available above).
+
+## Fixes & misc
+
+- You're now allowed to configure Relay via `package.json`.
+
 # 0.22.0
 
 This release brings a few `rescript-relay-cli` improvements under the hood, as well as the breaking (but very easily fixable) change of uncurrying the `sink` methods received back from `RescriptRelay.Observable.make`.

package/bsconfig.json

@@ -14,7 +14,7 @@
     "module": "commonjs",
     "in-source": true
   },
-  "bs-dependencies": ["@rescript/react", "reason-promise"],
+  "bs-dependencies": ["@rescript/react"],
   "suffix": ".bs.js",
   "warnings": {
     "error": "+101"