rescript-relay 1.0.0-beta.2 → 1.0.0-beta.20

package/CHANGELOG.md

@@ -1,11 +1,16 @@
 # master
 
-# 1.0.0-beta.2
+# 1.0.0-beta.20
 
 _[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).
 
+## Upgrade versions
+
+- `react-relay` and `relay-runtime` to `13.2.0`
+- `react` and `react-dom` to `18.0.0`
+
 ## 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:
@@ -14,19 +19,119 @@ You can go ahead and remove these packages, that are no longer needed, as the co
 - `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.
+- 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.
 - The errors reported by the compiler is now quite a lot better.
+- Full support for `reanalyze` as all false positive dead code results from generated code are now suppressed.
+- Bindings for `requiredFieldLogger` for logging when missing fields are encountered (kudos [Emilios1995](https://github.com/Emilios1995)).
+- Improved utils for [dealing with enums](https://rescript-relay-documentation.vercel.app/docs/enums).
+- `recordSourceRecords` is now typed as `Js.Json.t` rather than being abstract.
+
+## Breaking changes
+
+- The list of disallowed field names has been adapted to ReScript (it was never properly updated for ReScript when moving from ReasonML). This means that _some of your variable prop names might be renamed_. One example - if you previously had a variable in GraphQL called `$to`, you'd interact with that as `to_` in ReScript. This is because RescriptRelay would pin `to` as a reserved word, and rename it for you. But, `to` _isn't_ actually a keyword in ReScript (it was in ReasonML), so with this release, that `to_` in ReScript will be renamed to `to`. The fix is to just update all `to_` to `to` - let the compiler guide you!
+- Using variable names that are reserved words in ReScript is now _disallowed at the Relay compiler level_. This means that Relay won't compile your project if you have variables whose names are reserved words. The fix is to simply rename the variables.
+- `refetchVariables` now works as intended with regards to supplying only the variables you want _changed_ when refetching, as [detailed under `variables` here](https://relay.dev/docs/next/api-reference/use-refetchable-fragment/#return-value). This means that what was previously `makeRefetchVariables(~someValue=123, ())` should now be `makeRefetchVariables(~someValue=Some(123), ())`.
+  Crash course:
+
+  - `makeRefetchVariables(~someValue=Some(123), ())` means _refetch, use the same values for all variables that was used in the last fetch, but change `someValue` to `123`_.
+  - `makeRefetchVariables(~someValue=None, ())` means _refetch, use the same values for all variables that was used in the last fetch, but change `someValue` to `null` (unsetting it)_.
+  - `makeRefetchVariables()` means _refetch, use the same values for all variables that was used in the last fetch, change nothing_.
+
+  This way you can surgically change only certain values when refetching, without having to keep track of the current values for the other values.
+
+  More details on this [in the docs](https://rescript-relay-documentation.vercel.app/docs/refetching-and-loading-more-data#makerefetchvariables). Thanks to [@tsnobip](https://github.com/tsnobip) for fixing this!
 
 ## Beta fix changelog
 
+### unreleased
+
+### beta.20
+
+- Fix enums appearing in `@raw_response_type` (local query updates, optimistic responses) to be input enums.
+
+### beta.19
+
+- Fix top level node interface issue.
+
+### beta.18
+
+- Fix `useTransition` bindings, where `startTransition` broke after going to React 18. Kudos to [Emilios1995](https://github.com/Emilios1995) for researching and finding the issue!
+
+### beta.17
+
+- Upgrade to stable React 18
+
+### beta.16
+
+- Fix bug that caused issues when using unions in optimistic responses and `commitLocalPayload`.
+- Add support for experimental [Relay Resolvers](https://relay.dev/docs/next/guides/relay-resolvers). Undocumented so far, but looking at the [test](https://github.com/zth/rescript-relay/blob/master/packages/rescript-relay/__tests__/Test_relayResolvers.res) and [definition file](https://github.com/zth/rescript-relay/blob/master/packages/rescript-relay/__tests__/TestRelayUserResolver.res) should give you a hint of how it works.
+
+### beta.15
+
+- Fixes for input objects.
+
+### beta.14
+
+- Fixes a few issues introduced in `beta.13`.
+- The list of disallowed field names has been adapted to ReScript. This means that _some of your variable prop names might be renamed_. Check out the Breaking Changes section above for details.
+
+### beta.13
+
+- `refetchVariables` now works as intended with regards to supplying only the variables you want _changed_ when refetching, as [detailed under `variables` here](https://relay.dev/docs/next/api-reference/use-refetchable-fragment/#return-value). Check out the [docs](https://rescript-relay-documentation.vercel.app/docs/refetching-and-loading-more-data#makerefetchvariables).
+- Make all object makers inlined. This should improve bundle size some.
+- Support more Linux versions in CI (like the images Vercel uses).
+
+### beta.12
+
+- Make CLI work with `relay.config.cjs`.
+
+### beta.11
+
+- Another batch of experimental stuff... Nothing new in this version compared to `beta.9`.
+
+### beta.10
+
+- Sneaking out some experimental stuff... Nothing new in this version compared to `beta.9`.
+
+### beta.9
+
+- `recordSourceRecords` is now typed as `Js.Json.t` rather than being abstract.
+- The field name of the `id` field of the `Node` interface is now configurable via `schemaConfig: {nodeInterfaceIdField: "idNameHere"}`.
+
+### beta.8
+
+- More fixes for conversion instructions in variables and input objects.
+- Project now works in `"type": "module"` mode in `package.json` (kudos [cometkim](https://github.com/cometkim))
+
+### beta.7
+
+- Full support for `reanalyze` as all false positive dead code results from generated code are now suppressed.
+- Bindings for `requiredFieldLogger` for logging when missing fields are encountered (kudos [Emilios1995](https://github.com/Emilios1995)).
+- Fix bug with conversion instructions in variables with input instructions.
+
+### beta.6
+
+- Fix wrong enum type being printed in input objects
+- Fix `__typename` not being automatically selected (and by that forcing a manual select) in some cases, even though it's not supposed to be required to select manually anymore
+
+### beta.5
+
+- Generate helpers for moving between unsafe enums coming from the server, and safe enums. Also, provide a "fromString" function for each enum used, that can be used to turn any string into your enum.
+- Suppress dead code warnings _in most places_ when running `reanalyze` on a `rescript-relay` code base. Still a few things left to fix, that requires changes to reanalyze. But this should be much better than before.
+
+### beta.4
+
+- Revert JSON.parse micro optimization experiment.
+
+### 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.

package/README.md

@@ -6,11 +6,11 @@ Use Relay with ReScript.
 
 ## Getting started
 
-> Are you using version `>= 0.13.0` and ReScript syntax with VSCode? Make sure you install our [decicated VSCode extension](https://marketplace.visualstudio.com/items?itemName=GabrielNordeborn.vscode-rescript-relay). Note: It only works with ReScript syntax.
+> Are you using version `>= 0.13.0` and ReScript syntax with VSCode? Make sure you install our [dedicated VSCode extension](https://marketplace.visualstudio.com/items?itemName=GabrielNordeborn.vscode-rescript-relay). Note: It only works with ReScript syntax.
 
 Check out the [documentation](https://rescript-relay-documentation.vercel.app).
 
-Also, check out the [changelog](CHANGELOG.md) - things will continue change some between versions (including breaking changes, although we'll try and keep them to a minimum) as we iterate and reach a stable version.
+Also, check out the [changelog](CHANGELOG.md) - things will continue to change between versions (including breaking changes, although we'll try and keep them to a minimum) as we iterate and reach a stable version.
 
 ## What it looks like
 
@@ -18,15 +18,13 @@ Your components define what data they need through `%relay()`.
 
 ```rescript
 /* Avatar.res */
-module UserFragment = %relay(
-  `
+module UserFragment = %relay(`
   fragment Avatar_user on User {
     firstName
     lastName
     avatarUrl
   }
-`
-)
+`)
 
 @react.component
 let make = (~user) => {
@@ -52,16 +50,14 @@ Hooks to use your fragments are autogenerated for you. The hook needs a _fragmen
 
 ```rescript
 /* UserProfile.res */
-module UserFragment = %relay(
-  `
+module UserFragment = %relay(`
   fragment UserProfile_user on User {
     firstName
     lastName
     friendCount
     ...Avatar_user
   }
-`
-)
+`)
 
 @react.component
 let make = (~user) => {