rescript-relay 0.0.0-up-lsp-2731c9ea → 0.0.0-version-3-89bccc22

package/CHANGELOG.md

@@ -1,5 +1,86 @@
 # master
 
+## Breaking changes
+
+- Remove "top level node field" transform. Previously, a single selection on the top level `node` field (like `node(id: $id) { ... on User { id, name }}`) would skip the union mechanism and automatically collapse the generated types to `option<user>`. This has now changed and the top level node field behaves just like any union. Commit showing how this is migrated to in the tests: https://github.com/zth/rescript-relay/commit/9ce73196794dbc6eba435414fcff708e7c53df78
+- Enums are now (unboxed) regular variants rather than polyvariants. This is a large change, but we're going to provide some tools for easing the transition. Commit showing how this is migrated to in the tests: https://github.com/zth/rescript-relay/commit/9da425a3e65ce3e9403168af421522028424a4f0
+
+# 2.0.0-alpha.1
+
+## Improvements
+
+- `%relay.deferredComponent` now works with uncurried mode.
+
+# 2.0.0-alpha.0
+
+First alpha of the `2.x` series of releases. `2.x` focuses on compat with ReScript `v11`, including uncurried mode.
+
+### Uncurried mode
+
+You can activate uncurried mode with `RescriptRelay` by setting `"uncurried": true` in your `bsconfig.json`, and then ensuring that you pass `-uncurried` to `rescript-relay/ppx` in `ppx-flags`: `"ppx-flags": [["rescript-relay/ppx", "-uncurried"]]`.
+
+## Upgrade versions
+
+- `rescript` to `>=11.0.0-beta.0`
+- `@rescript/react` to `>=0.12.0-alpha.2`
+
+## Improvements
+
+- Leverage variant's new `string` representation + `@as()` to get rid of `mapFetchPolicy`. This was internal so it should not affect you as an end user.
+
+# 1.2.0
+
+This release mainly makes preparations under the hood for the upcoming `2.0` (ReScript v11 + uncurried mode support) and `3.0` (lots of changes, full uncurried mode only).
+
+## Breaking changes
+
+- A trailing unit `()` arg is no longer needed in `Query.usePreloaded()`. What was previously `Query.usePreloaded(~queryRef, ())` is now just `Query.usePreloaded(~queryRef)`.
+
+## Improvements
+
+- Add `@live` annotations to generated JSXv4 dynamic import compat modules, so they don't show up in dead code analysis (which they shouldn't).
+- Preparations under the hood for ReScript v11 + uncurried mode.
+
+# 1.1.1
+
+- Fix M1 binary to include new JSXv4 dynamic import compat changes.
+
+# 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

package/README.md

@@ -98,6 +98,14 @@ let make = () => {
 
 ```
 
+## Note about versioning
+
+There's plenty of work ongoing to bring RescriptRelay to full ReScript v11 support, including uncurried mode. Here's the versioning scheme that'll be followed going forward:
+
+- 1.x will receive critical bug fixes etc, but new features won't be added
+- 2.x will soon ship, and it'll focus on compatibility with ReScript v11, and uncurried mode (uncurried mode will be optional). This is intended to make the transition to v11+ smooth
+- 3.x will also soon ship, and that'll fully embrace uncurried mode (no curried mode available), and add a bunch of new stuff + change existing APIs to make them better and more ergonomic
+
 ## Examples
 
 - A general example showcasing most available features: https://github.com/zth/rescript-relay/tree/master/example

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "rescript-relay",
-  "version": "0.0.0-up-lsp-2731c9ea",
+  "version": "0.0.0-version-3-89bccc22",
   "main": "src/RescriptRelay.res",
   "license": "MIT",
   "author": "Gabriel Nordeborn",
@@ -39,31 +39,31 @@
     "test:ci": "jest --ci --runInBand"
   },
   "devDependencies": {
-    "rescript": "^10.0.0",
-    "@rescript/react": "0.10.3",
+    "@glennsl/rescript-fetch": "^0.2.0",
+    "@rescript/react": "0.12.0-alpha.2",
     "@testing-library/jest-dom": "^5.16.3",
     "@testing-library/react": "^13.0.0-alpha.6",
-    "bs-fetch": "^0.5.0",
     "graphql-query-test-mock": "^0.12.1",
     "jest": "^27.2.4",
     "nock": "^11.7.0",
     "node-fetch": "^2.6.0",
-    "react": "18.0.0",
-    "react-dom": "18.0.0",
-    "react-relay": "14.1.0",
-    "relay-runtime": "14.1.0"
+    "react": "18.2.0",
+    "react-dom": "18.2.0",
+    "react-relay": "15.0.0",
+    "relay-runtime": "15.0.0",
+    "rescript": "^11.0.0-beta.2"
   },
   "peerDependencies": {
-    "@rescript/react": "*",
-    "react-relay": ">=11.0.0",
+    "@rescript/react": "^0.12.0-alpha.2 || next",
+    "react-relay": ">=15.0.0",
     "relay-runtime": "*",
-    "rescript": ">=9.1.2"
+    "rescript": "^11.0.0-alpha.0 || next"
   },
   "dependencies": {
     "detect-libc": "^2.0.1"
   },
   "resolutions": {
-    "react": "18.0.0",
-    "react-dom": "18.0.0"
+    "react": "18.2.0",
+    "react-dom": "18.2.0"
   }
 }

package/postinstall.js

@@ -40,7 +40,7 @@ function ppxArch() {
    * Use Rosetta for ARM on macOS
    */
   if (platform === "darwin" && process.arch === "arm64") {
-    return "x64";
+    return "arm64";
   }
 
   /**
@@ -132,6 +132,7 @@ function copyPlatformBinaries(platform) {
 }
 
 function removeInitialBinaries() {
+  fs.unlinkSync(path.join(__dirname, "ppx-macos-arm64"));
   fs.unlinkSync(path.join(__dirname, "ppx-macos-latest"));
   fs.unlinkSync(path.join(__dirname, "ppx-windows-latest"));
   fs.unlinkSync(path.join(__dirname, "ppx-linux"));
@@ -151,6 +152,10 @@ function removeInitialBinaries() {
     recursive: true,
     force: true,
   });
+  fs.rmSync(path.join(__dirname, "relay-compiler-win-x64"), {
+    recursive: true,
+    force: true,
+  });
 }
 
 switch (platform) {
@@ -165,9 +170,14 @@ switch (platform) {
   case "linux":
     copyPlatformBinaries(platform);
     break;
-  case "darwin":
-    copyPlatformBinaries("macos-latest");
+  case "darwin": {
+    if (ppxArch() === "arm64") {
+      copyPlatformBinaries("macos-arm64");
+    } else {
+      copyPlatformBinaries("macos-latest");
+    }
     break;
+  }
   default:
     console.warn("error: no release built for the " + platform + " platform");
     process.exit(1);

package/src/ReactDOMExperimental.bs.js

@@ -1,6 +1,7 @@
 // Generated by ReScript, PLEASE EDIT WITH CARE
 'use strict';
 
+var ReactDOM = require("@rescript/react/src/ReactDOM.bs.js");
 var Client = require("react-dom/client");
 
 function renderConcurrentRootAtElementWithId(content, id) {
@@ -15,5 +16,8 @@ function renderConcurrentRootAtElementWithId(content, id) {
   Client.createRoot(element).render(content);
 }
 
+var Root = ReactDOM.Client.Root;
+
+exports.Root = Root;
 exports.renderConcurrentRootAtElementWithId = renderConcurrentRootAtElementWithId;
 /* react-dom/client Not a pure module */

package/src/ReactDOMExperimental.res

@@ -1,7 +1,4 @@
-include ReactDOM.Experimental
-
-@module("react-dom/client")
-external createRoot: Dom.element => root = "createRoot"
+include ReactDOM.Client
 
 @val @return(nullable)
 external getElementById: string => option<Dom.element> = "document.getElementById"
@@ -15,5 +12,5 @@ let renderConcurrentRootAtElementWithId: (React.element, string) => unit = (cont
         id ++ " found in the HTML.",
       ),
     )
-  | Some(element) => createRoot(element)->render(content)
+  | Some(element) => createRoot(element)->Root.render(content)
   }

package/src/ReactExperimental.bs.js

@@ -3,13 +3,15 @@
 
 var React = require("react");
 
-function useTransition(param) {
+function useTransition() {
   var match = React.useTransition();
   var startTransition = match[1];
   return [
           match[0],
-          React.useCallback((function (cb) {
-                  startTransition(cb, undefined);
+          React.useMemo((function () {
+                  return function (cb) {
+                    startTransition(cb, undefined);
+                  };
                 }), [startTransition])
         ];
 }

package/src/ReactExperimental.res

@@ -4,12 +4,12 @@ external useDeferredValue: 'value => 'value = "useDeferredValue"
 @module("react")
 external useTransitionWithOptions: unit => (
   bool,
-  (. unit => unit, option<{"name": option<string>}>) => unit,
+  (unit => unit, option<{"name": option<string>}>) => unit,
 ) = "useTransition"
 
 let useTransition = () => {
   let (isPending, startTransition) = useTransitionWithOptions()
-  (isPending, React.useCallback1(cb => startTransition(. cb, None), [startTransition]))
+  (isPending, React.useMemo1(() => cb => startTransition(cb, None), [startTransition]))
 }
 
 module SuspenseList = {

package/src/ReactExperimental.resi

@@ -4,10 +4,10 @@ external useDeferredValue: 'value => 'value = "useDeferredValue"
 @module("react")
 external useTransitionWithOptions: unit => (
   bool,
-  (. unit => unit, option<{"name": option<string>}>) => unit,
+  (unit => unit, option<{"name": option<string>}>) => unit,
 ) = "useTransition"
 
-let useTransition: unit => (bool, React.callback<unit => unit, unit>)
+let useTransition: unit => (bool, (unit => unit) => unit)
 
 module SuspenseList: {
   @module("react") @react.component

package/src/RescriptRelay.bs.js

@@ -1,7 +1,6 @@
 // Generated by ReScript, PLEASE EDIT WITH CARE
 'use strict';
 
-var Curry = require("rescript/lib/js/curry.js");
 var React = require("react");
 var Utils = require("./utils");
 var Belt_Array = require("rescript/lib/js/belt_Array.js");
@@ -50,22 +49,22 @@ function unwrapNormalizationArgument(wrapped) {
   var match = wrapped.kind;
   if (match === "Literal") {
     return {
-            TAG: /* Literal */1,
+            TAG: "Literal",
             _0: wrapped
           };
   } else if (match === "ListValue") {
     return {
-            TAG: /* ListValue */0,
+            TAG: "ListValue",
             _0: wrapped
           };
   } else if (match === "ObjectValue") {
     return {
-            TAG: /* ObjectValue */2,
+            TAG: "ObjectValue",
             _0: wrapped
           };
   } else {
     return {
-            TAG: /* Variable */3,
+            TAG: "Variable",
             _0: wrapped
           };
   }
@@ -102,7 +101,7 @@ var MissingFieldHandler = {
 var nodeInterfaceMissingFieldHandler = makeLinkedMissingFieldHandler(function (field, record, args, _store) {
       var match = field.name;
       var match$1 = args.id;
-      if ((record == null) || !(match === "node" && record.__typename === RelayRuntime.ROOT_TYPE && !(match$1 == null))) {
+      if ((record == null) || !(match === "node" && record.getType() === RelayRuntime.ROOT_TYPE && !(match$1 == null))) {
         return ;
       } else {
         return Caml_option.some(match$1);
@@ -130,8 +129,10 @@ var Store = {
   make: make
 };
 
-function toJs(f, arg) {
-  Curry._3(f, arg.kind, arg.owner, arg.fieldPath);
+function toJs(f) {
+  return function (arg) {
+    f(arg.kind, arg.owner, arg.fieldPath);
+  };
 }
 
 function make$1(network, store, getDataID, treatMissingFieldsAsNull, missingFieldHandlers, requiredFieldLogger, isServer, param) {
@@ -160,15 +161,13 @@ var Environment = {
   make: make$1
 };
 
-function RescriptRelay$Context$Provider(Props) {
-  var environment = Props.environment;
-  var children = Props.children;
+function RescriptRelay$Context$Provider(props) {
   var provider = ReactRelay.ReactRelayContext.Provider;
   return React.createElement(provider, {
               value: {
-                environment: environment
+                environment: props.environment
               },
-              children: children
+              children: props.children
             });
 }
 
@@ -182,7 +181,7 @@ var Context = {
 
 var EnvironmentNotFoundInContext = /* @__PURE__ */Caml_exceptions.create("RescriptRelay.EnvironmentNotFoundInContext");
 
-function useEnvironmentFromContext(param) {
+function useEnvironmentFromContext() {
   var context = React.useContext(ReactRelay.ReactRelayContext);
   if (context !== undefined) {
     return Caml_option.valFromOption(context).environment;
@@ -193,39 +192,11 @@ function useEnvironmentFromContext(param) {
       };
 }
 
-function mapFetchPolicy(x) {
-  if (x === undefined) {
-    return ;
-  }
-  switch (x) {
-    case /* StoreOnly */0 :
-        return "store-only";
-    case /* StoreOrNetwork */1 :
-        return "store-or-network";
-    case /* StoreAndNetwork */2 :
-        return "store-and-network";
-    case /* NetworkOnly */3 :
-        return "network-only";
-    
-  }
-}
-
-function mapFetchQueryFetchPolicy(x) {
-  if (x !== undefined) {
-    if (x) {
-      return "store-or-network";
-    } else {
-      return "network-only";
-    }
-  }
-  
-}
-
 function MakeLoadQuery(C) {
   var load = function (environment, variables, fetchPolicy, fetchKey, networkCacheConfig, param) {
-    return ReactRelay.loadQuery(environment, C.query, Curry._1(C.convertVariables, variables), {
+    return ReactRelay.loadQuery(environment, C.query, C.convertVariables(variables), {
                 fetchKey: fetchKey,
-                fetchPolicy: mapFetchPolicy(fetchPolicy),
+                fetchPolicy: fetchPolicy,
                 networkCacheConfig: networkCacheConfig
               });
   };
@@ -237,9 +208,9 @@ function MakeLoadQuery(C) {
                   var o = queryRefToObservable(token);
                   if (o !== undefined) {
                     Caml_option.valFromOption(o).subscribe({
-                          complete: (function (param) {
+                          complete: (function () {
                               resolve({
-                                    TAG: /* Ok */0,
+                                    TAG: "Ok",
                                     _0: undefined
                                   });
                             })
@@ -247,7 +218,7 @@ function MakeLoadQuery(C) {
                     return ;
                   } else {
                     return resolve({
-                                TAG: /* Error */1,
+                                TAG: "Error",
                                 _0: undefined
                               });
                   }
@@ -277,8 +248,6 @@ exports.Store = Store;
 exports.Disposable = Disposable;
 exports.RequiredFieldLogger = RequiredFieldLogger;
 exports.Environment = Environment;
-exports.mapFetchPolicy = mapFetchPolicy;
-exports.mapFetchQueryFetchPolicy = mapFetchQueryFetchPolicy;
 exports.Context = Context;
 exports.EnvironmentNotFoundInContext = EnvironmentNotFoundInContext;
 exports.useEnvironmentFromContext = useEnvironmentFromContext;

package/src/RescriptRelay.res

@@ -330,7 +330,7 @@ module ReadOnlyRecordSourceProxy = {
 }
 
 module MissingFieldHandler = {
-  @@ocaml.warning("-30")
+  @@warning("-30")
   type t
 
   type normalizationArgumentWrapped = {kind: [#ListValue | #Literal | #ObjectValue | #Variable]}
@@ -412,7 +412,7 @@ let nodeInterfaceMissingFieldHandler = MissingFieldHandler.makeLinkedMissingFiel
   _store,
 ) =>
   switch (Js.Nullable.toOption(record), field["name"], Js.Nullable.toOption(args["id"])) {
-  | (Some(record), "node", argsId) if record["__typename"] == storeRootType => argsId
+  | (Some(record), "node", argsId) if record->RecordProxy.getType == storeRootType => argsId
   | _ => None
   }
 )
@@ -482,9 +482,9 @@ module Observable = {
   }
 
   type sink<'response> = {
-    next: (. 'response) => unit,
-    error: (. Js.Exn.t) => unit,
-    complete: (. unit) => unit,
+    next: 'response => unit,
+    error: Js.Exn.t => unit,
+    complete: unit => unit,
     closed: bool,
   }
 
@@ -492,11 +492,11 @@ module Observable = {
 
   @obj
   external makeObserver: (
-    ~start: @uncurry subscription => unit=?,
-    ~next: @uncurry 'response => unit=?,
-    ~error: @uncurry Js.Exn.t => unit=?,
-    ~complete: @uncurry unit => unit=?,
-    ~unsubscribe: @uncurry subscription => unit=?,
+    ~start: subscription => unit=?,
+    ~next: 'response => unit=?,
+    ~error: Js.Exn.t => unit=?,
+    ~complete: unit => unit=?,
+    ~unsubscribe: subscription => unit=?,
     unit,
   ) => observer<'response> = ""
 
@@ -507,6 +507,8 @@ module Observable = {
   external subscribe: (t<'response>, observer<'response>) => subscription = "subscribe"
 
   @send external toPromise: t<'t> => Js.Promise.t<'t> = "toPromise"
+
+  external ignoreSubscription: subscription => unit = "%ignore"
 }
 
 module Network = {
@@ -574,8 +576,8 @@ module Store = {
     make(
       source,
       {
-        gcReleaseBufferSize: gcReleaseBufferSize,
-        queryCacheExpirationTime: queryCacheExpirationTime,
+        gcReleaseBufferSize,
+        queryCacheExpirationTime,
       },
     )
 
@@ -593,7 +595,7 @@ module RequiredFieldLogger = {
 
   type t = (~kind: kind, ~owner: string, ~fieldPath: string) => unit
 
-  let toJs: t => js = (f, arg) =>
+  let toJs: t => js = f => arg =>
     f(~kind=arg["kind"], ~owner=arg["owner"], ~fieldPath=arg["fieldPath"])
 }
 
@@ -662,10 +664,7 @@ module Context = {
     @react.component
     let make = (~environment: Environment.t, ~children) => {
       let provider = React.Context.provider(context)
-      React.createElement(
-        provider,
-        {"value": Some({"environment": environment}), "children": children},
-      )
+      React.createElement(provider, {value: Some({"environment": environment}), children})
     }
   }
 }
@@ -682,39 +681,23 @@ let useEnvironmentFromContext = () => {
 }
 
 type fetchPolicy =
-  | StoreOnly
-  | StoreOrNetwork
-  | StoreAndNetwork
-  | NetworkOnly
-
-let mapFetchPolicy = x =>
-  switch x {
-  | Some(StoreOnly) => Some("store-only")
-  | Some(StoreOrNetwork) => Some("store-or-network")
-  | Some(StoreAndNetwork) => Some("store-and-network")
-  | Some(NetworkOnly) => Some("network-only")
-  | None => None
-  }
+  | @as("store-only") StoreOnly
+  | @as("store-or-network") StoreOrNetwork
+  | @as("store-and-network") StoreAndNetwork
+  | @as("network-only") NetworkOnly
 
 type fetchQueryFetchPolicy =
-  | NetworkOnly
-  | StoreOrNetwork
-
-let mapFetchQueryFetchPolicy = x =>
-  switch x {
-  | Some(StoreOrNetwork) => Some("store-or-network")
-  | Some(NetworkOnly) => Some("network-only")
-  | None => None
-  }
+  | @as("network-only") NetworkOnly
+  | @as("store-or-network") StoreOrNetwork
 
 type fetchQueryOptions = {
-  networkCacheConfig: option<cacheConfig>,
-  fetchPolicy: option<string>,
+  networkCacheConfig?: cacheConfig,
+  fetchPolicy?: fetchPolicy,
 }
 
 type loadQueryConfig = {
   fetchKey: option<string>,
-  fetchPolicy: option<string>,
+  fetchPolicy: option<fetchPolicy>,
   networkCacheConfig: option<cacheConfig>,
 }
 
@@ -752,9 +735,9 @@ module MakeLoadQuery = (C: MakeLoadQueryConfig) => {
       C.query,
       variables->C.convertVariables,
       {
-        fetchKey: fetchKey,
-        fetchPolicy: fetchPolicy->mapFetchPolicy,
-        networkCacheConfig: networkCacheConfig,
+        fetchKey,
+        fetchPolicy,
+        networkCacheConfig,
       },
     )
 
@@ -769,10 +752,10 @@ module MakeLoadQuery = (C: MakeLoadQueryConfig) => {
   let queryRefToPromise = token => {
     Js.Promise.make((~resolve, ~reject as _) => {
       switch token->queryRefToObservable {
-      | None => resolve(. Error())
+      | None => resolve(Error())
       | Some(o) =>
         open Observable
-        let _: subscription = o->subscribe(makeObserver(~complete=() => resolve(. Ok()), ()))
+        let _: subscription = o->subscribe(makeObserver(~complete=() => resolve(Ok()), ()))
       }
     })
   }