rescript-relay 0.0.0-cli-b8d52924 → 0.0.0-linux-musl-d5435e23

package/CHANGELOG.md

@@ -1,5 +1,146 @@
 # master
 
+# 1.0.0-beta.12
+
+_[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.1.1`
+
+## 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.
+
+## Beta fix changelog
+
+### unreleased
+
+### 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.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`.
+
+## Breaking changes
+
+- Uncurry `sink` methods. What was previously `sink => sink.error(err)` etc should now instead be `sink => sink.error(. err)`.
+
+## Fixes & misc
+
+- Improvements to the `remove-unused-fields` CLI.
+
+# 0.21.1
+
+- A few bug fixes to the `remove-unused-fields` command in the CLI.
+
+# 0.21.0
+
+- Adds `rescript-relay-cli`, a CLI for removing unused fields and formatting GraphQL in your project. Read more [here](https://github.com/zth/rescript-relay/blob/master/packages/rescript-relay-cli/README.md) (especially look at `remove-unused-fields`).
+
 # 0.20.1
 
 Quick patch release fixing the Linux binaries that broke with the last release.

package/README.md

@@ -1,16 +1,16 @@
 # rescript-relay
 
-Use Relay with ReScript/ReasonML.
+Use Relay with ReScript.
 
 [**Join our Discord**](https://discord.gg/wzj4EN8XDc)
 
 ## 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) => {

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"