rescript-relay 1.0.0-beta.8 → 1.0.0-rc.1

package/CHANGELOG.md

@@ -1,6 +1,6 @@
 # master
 
-# 1.0.0-beta.8
+# 1.0.0-rc.1
 
 _[Here's a commit showing a project being upgraded to this version](https://github.com/zth/rescript-relay/commit/5831c2f1f0f13eedc1cb60468c32fd32b2dc01d3)_
 
@@ -8,7 +8,8 @@ The time has finally come - RescriptRelay `1.0.0` is in beta! The one, big major
 
 ## Upgrade versions
 
-- `react-relay` and `relay-runtime` to `13.0.1`
+- `react-relay` and `relay-runtime` to `14.1.0`
+- `react` and `react-dom` to `18.0.0`
 
 ## Remove Packages
 
@@ -27,10 +28,122 @@ You can go ahead and remove these packages, that are no longer needed, as the co
 - 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.
 
-## Beta fix changelog
+## 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!
+
+## 1.0.0 development changelog
+
+### rc.1
+
+- Restore half-broken connection helper function inlining.
+
+### rc.0
+
+- _potentially breaking_ `getConnectionNodes` is now located directly in the generated module, and not in a nested `Utils` module.
+- Support [provided variables](https://relay.dev/docs/api-reference/graphql-and-directives/#provided-variables). More info in the docs.
+- Windows support! :tada:
+- Fixed `setLinkedRecordToNull`, `setLinkedRecordToUndefined`, `setLinkedRecordsToNull` and `setLinkedRecordsToUndefined` methods by binding them to `setValue` instead of `setLinkedRecord/s`. Previously they were throwing an error because `setLinkedRecord/s` did not support "deleting" values using them. (@reck753)
+- A `RelaySchemaAssets_graphql.res` is now emitted, containing type definitions for all enums and all input objects. This is designed to help with accessing and using enums and input objects outside of Relay's context. This means it'll be much easier to share makers for input objects, pass enums around, etc.
+- Each fragment with a `@connection` now emits a `makeConnectionId` function that allows you to generate _type safe_ connection IDs. More on why this is useful in the documentation.
+- _breaking_ Input object fields with illegal names in ReScript previously had their maker function argument names suffixed with `_`, like `~type_: string`. This is now instead _prefixed_, like `~_type: string`. Prefixing like this instead of suffixing means we can ship fully zero cost maker functions, which we couldn't before for input objects with illegal field names.
+
+## beta.26
+
+- Upgrade Relay packages to version `14.1.0`.
+
+## beta.25
+
+- Change signature of preload function (router related).
+
+## beta.24
+
+- Fix compatibility with ReScript v10
+
+## beta.23
+
+- Add Environment isServer option @MoOx
+- Fix incorrect react-relay peerDependencies version @MoOx
+- Remove rescript from dependencies @anmonteiro
+- Fix instantiation of Relay context @vikfroberg
+- Add undocumented holdGC method on relay store @MoOx
+
+### beta.22
+
+- Fix locations for `%relay.deferredComponent` so jump-to-definition, hover etc works as expected (pointing to the dynamically imported module rather than what the PPX produces).
+- Add links for `Operation` module in `Query`, `Mutation`, `Subscription` and `Fragment` ([XiNiHa](https://github.com/XiNiHa))
+
+### beta.21
+
+- Support formatting commented out operations in the CLI ([reck753](https://github.com/reck753)).
+- Support `@rescriptRelayIgnoreUnused` directive on fragment definitions to insert annotations that makes `reanalyze` consider all fields in the fragment used, even if they aren't.
+- Support `@rescriptRelayAllowUnsafeEnum` directive on fields selecting enums, which will ignore safety measures for enums, meaning you won't need to add a catch all clause, etc. It'll essentially output the enum as an _input_ enum (as desribed in the docs).
+
+### 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
 
-### unreleased
+- `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
 
@@ -70,7 +183,7 @@ You can go ahead and remove these packages, that are no longer needed, as the co
 
 _[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.
+Finally, a new release! This brings the Relay version to 12, and the React version to 18 (in rc.1 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
 

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) => {