rescript-relay 0.0.0-pre-10692c05 → 0.0.0-pre-e1235447

package/CHANGELOG.md

@@ -1,5 +1,298 @@
 # master
 
+# 1.1.0
+
+Notable changes:
+
+- _JSX v4 is now required_
+- Relay and @rescript/react upgraded
+- M1 support for the PPX (should speed up builds for anyone on an M1)
+
+## Upgrade versions
+
+- `react-relay` and `relay-runtime` to `>=15.0.0`
+- `@rescript/react` to `>=0.11.0`
+
+## Breaking changes
+
+- The signature for missing field handlers has changed. Previously you got an open type `{..}` as record, now instead you get a proper `RecordProxy.t` from the store. Check out [the changelog for Relay 15](https://github.com/facebook/relay/releases/tag/v15.0.0).
+- ReScript `>=10.1` and JSX v4 is now required.
+- Work around issue with JSX v4 and `%relay.deferredComponent`. You now need to annotate any component you want to use with `%relay.deferredComponent` with `@relay.deferredComponent`. https://github.com/zth/rescript-relay/pull/439
+
+## Improvements
+
+- Experimental support for allowing `null` in operation variables. Add `@rescriptRelayNullableVariables` to your operation (query, mutation, subscription) and you'll be allowed to pass `Js.null` (via the `Js.Null` module) to your server. https://github.com/zth/rescript-relay/pull/426
+- :tada: M1 support for the PPX! This should speed up builds some. https://github.com/zth/rescript-relay/pull/435
+
+## Bug Fixes
+
+- Fix issue with conversion of custom scalars, where custom scalars represented as arrays would get converted "internally" although they should've really just been left alone. https://github.com/zth/rescript-relay/pull/433
+
+# 1.0.5
+
+## Bug Fixes
+
+- Fix fairly large performance issue with runtime conversion. This should give a large speedup in certain cases.
+
+# 1.0.4
+
+## Improvements
+
+- Improved autocomplete for fragments etc (pulled from upstream Relay compiler). https://github.com/facebook/relay/pull/4134
+
+# 1.0.3
+
+## Improvements
+
+- Add `RescriptRelay.Disposable.ignore` for more ergonomic handling of ignoring disposables.
+
+## Bug Fixes
+
+- Fix the `remove-unused-fields` script for CI with Node.js version >14 in [#409](https://github.com/zth/rescript-relay/pull/409)
+
+# 1.0.2
+
+## Bug Fixes
+
+- `private` is now correctly marked as a reserved word.
+
+## Improvements
+
+- Add ReScript 10 compat in peerDependencies https://github.com/zth/rescript-relay/pull/397 @MoOx
+- `makeConnectionId` helpers are now marked as `@live` to not trigger the dead code analysis.
+
+# 1.0.1
+
+## Bug Fixes
+
+- Fix issue with custom scalar of JSON values being accidentally mangled https://github.com/zth/rescript-relay/pull/395 @tsnobip
+
+# 1.0.0
+
+_[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 released! This version brings a ton of new features and improvements. One of the the big major things 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 `>=14.1.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:
+
+- `relay-config`
+- `relay-compiler`
+- `graphql` (if you don't use it for anything else)
+
+## 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.
+- 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.
+- Project now works in `"type": "module"` mode in `package.json` (kudos [cometkim](https://github.com/cometkim))
+- The field name of the `id` field of the `Node` interface is now configurable via `schemaConfig: {nodeInterfaceIdField: "idNameHere"}`.
+- 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.
+- 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).
+- Support [provided variables](https://relay.dev/docs/api-reference/graphql-and-directives/#provided-variables). More info in the docs.
+- Windows support! :tada:
+- 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 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!
+
+- All enum type definitions now reside in `RelaySchemaAssets_graphql.enum_<yourEnumName>`, and are _not_ generated on the operation itself anymore. So, if you previously referred to the actual enum _type_, like `Fragment.Types.enum_MyFineEnum`, you'll now need to refer to that enum type as `RelaySchemaAssets_graphql.enum_MyFineEnum`.
+- 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.
+
+## Assorted Changes and Fixes
+
+- Add Environment isServer option @MoOx
+- Remove rescript from dependencies @anmonteiro
+- Add undocumented holdGC method on relay store @MoOx
+- 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)
+- Fix long standing bug that would make whether connection helpers were emitted or not unreliable.
+
+## 1.0.0 development changelog
+
+- Fix bug in the new type safe connection ID makers where null default values wouldn't turn the variable into a `Js.Null.t<t>`, leading to type errors.
+- Fix bug with connection handling where connections behind a `@include` or `@skip` directive would not be found.
+- Move `getConnectionNodes` back into generated and auto included `Utils` module. This means that failing to generate `getConnectionNodes`, which can happen for various reasons, won't break the build, but rather not just emit the helper.
+
+### rc.5
+
+- Fix compat with `rescript@10.1.0-alpha.1`.
+
+### rc.4
+
+- _potentially breaking_ All enum type definitions now reside in `RelaySchemaAssets_graphql.enum_<yourEnumName>`, and are _not_ generated on the operation itself anymore. So, if you previously referred to the actual enum _type_, like `Fragment.Types.enum_MyFineEnum`, you'll now need to refer to that enum type as `RelaySchemaAssets_graphql.enum_MyFineEnum`.
+- Fix bug in the new type safe connection ID makers where different types could end up in the same array, yielding type errors in ReScript.
+
+### rc.3
+
+- Fix bug in the new type safe connection ID makers where constant value `null` couldn't be used.
+
+### rc.2
+
+- Fix long standing bug that would make whether connection helpers were emitted or not unreliable.
+
+### rc.1
+
+- Restore half-broken connection helper function inlining.
+
+### rc.0
+
+- _potentially breaking_ `getConnectionNodes` and `connectionKey` is now located directly in the generated module, and not in a nested `Utils` module. `connectionKey` is also no longer exposed on the `Fragment` module, but only via the generated module for that fragment (`WhateverYourFragmentIsCalled_whatever_graphql.res`)
+- 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
+
+- `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.
+
+# 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.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
 
 - `react-relay` to `12.0.0`
@@ -12,12 +305,24 @@ 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`. 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()`.
-- `ReactExperimental.unstable_useDeferredValue` is now called `ReactExperimental.useDeferredValue`.
-- `ReactExperimental.renderConcurrentRootAtElementWithId` has moved to `ReactDOMExperimental`: `ReactDOMExperimental.renderConcurrentRootAtElementWithId`.
+- 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
 

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