rescript-relay 3.0.1 → 3.1.0

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # master
 
+# 3.1.0
+
+- **Upgrade versions**: `react-relay` and `relay-runtime` to `18.2.0`.
+- Add support for `Fragment.waitForFragmentData`, a new API in Relay 18.2 that lets you wait for fragment data outside of React.
+- Experimental: Add a "non React" mode to the PPX, which makes sure only APIs that don't rely on React directly are exposed. This is intended to be a way to simplify using RescriptRelay without React. Activate by passing `-non-react` to the PPX, like `"ppx-flags": [["rescript-relay/ppx", "-non-react"]]`.
+
 # 3.0.1
 
 - Add `Environment.findAllConnectionIds` for finding all IDs of all connection instances for a specific connection, regardless of what configs that connection has been fetched (and cached) with.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "rescript-relay",
-  "version": "3.0.1",
+  "version": "3.1.0",
   "main": "src/RescriptRelay.res",
   "license": "MIT",
   "author": "Gabriel Nordeborn",
@@ -49,14 +49,14 @@
     "node-fetch": "^2.6.0",
     "react": "18.2.0",
     "react-dom": "18.2.0",
-    "react-relay": "17.0.0",
-    "relay-runtime": "17.0.0",
+    "react-relay": "18.2.0",
+    "relay-runtime": "18.2.0",
     "rescript": "11.1.1"
   },
   "peerDependencies": {
     "@rescript/react": ">=0.13.0",
-    "react-relay": "17.0.0",
-    "relay-runtime": "17.0.0",
+    "react-relay": "18.2.0",
+    "relay-runtime": "18.2.0",
     "rescript": "^11.0.0"
   },
   "dependencies": {

package/src/RescriptRelay.bs.js

@@ -10,8 +10,8 @@ var Caml_option = require("rescript/lib/js/caml_option.js");
 var ReactRelay = require("react-relay");
 var RelayRuntime = require("relay-runtime");
 var Caml_exceptions = require("rescript/lib/js/caml_exceptions.js");
-var LiveResolverStore = require("relay-runtime/lib/store/experimental-live-resolvers/LiveResolverStore");
-var LiveResolverStore$1 = require("relay-runtime/lib/store/experimental-live-resolvers/LiveResolverStore").default;
+var LiveResolverStore = require("relay-runtime/lib/store/live-resolvers/LiveResolverStore").default;
+var LiveResolverStore$1 = require("relay-runtime/lib/store/live-resolvers/LiveResolverStore");
 
 var SuspenseSentinel = {};
 
@@ -209,14 +209,14 @@ function make(source, gcReleaseBufferSize, queryCacheExpirationTime) {
 }
 
 function makeLiveStore(source, gcReleaseBufferSize, queryCacheExpirationTime) {
-  return new LiveResolverStore$1(source, {
+  return new LiveResolverStore(source, {
               gcReleaseBufferSize: gcReleaseBufferSize,
               queryCacheExpirationTime: queryCacheExpirationTime
             });
 }
 
 function _makeLiveStoreCjs(source, gcReleaseBufferSize, queryCacheExpirationTime) {
-  return new LiveResolverStore(source, {
+  return new LiveResolverStore$1(source, {
               gcReleaseBufferSize: gcReleaseBufferSize,
               queryCacheExpirationTime: queryCacheExpirationTime
             });

package/src/RescriptRelay.res

@@ -643,9 +643,9 @@ module Store = {
 
   @module @new
   external makeLiveStoreCjs: (RecordSource.t, storeConfig) => t =
-    "relay-runtime/lib/store/experimental-live-resolvers/LiveResolverStore"
+    "relay-runtime/lib/store/live-resolvers/LiveResolverStore"
 
-  @module("relay-runtime/lib/store/experimental-live-resolvers/LiveResolverStore") @new
+  @module("relay-runtime/lib/store/live-resolvers/LiveResolverStore") @new
   external makeLiveStore: (RecordSource.t, storeConfig) => t = "default"
 
   @module("relay-runtime") @new
@@ -686,8 +686,19 @@ module Store = {
 module RelayFieldLogger = {
   @tag("kind")
   type arg =
-    | @as("missing_field.log") MissingFieldLog({owner: string, fieldPath: string})
-    | @as("missing_field.throw") MissingFieldThrow({owner: string, fieldPath: string})
+    | @as("missing_required_field.log") MissingRequiredFieldLog({owner: string, fieldPath: string})
+    | @as("missing_required_field.throw")
+    MissingRequiredFieldThrow({
+        owner: string,
+        fieldPath: string,
+      })
+    | @as("missing_expected_data.log") MissingExpectedData({owner: string, fieldPath: string})
+    | @as("missing_expected_data.throw")
+    MissingExpectedDataThrow({
+        owner: string,
+        fieldPath: string,
+        handled: bool,
+      })
     | @as("relay_resolver.error")
     RelayResolverError({
         owner: string,

package/src/RescriptRelay.resi

@@ -744,8 +744,19 @@ module Disposable: {
 module RelayFieldLogger: {
   @tag("kind")
   type arg =
-    | @as("missing_field.log") MissingFieldLog({owner: string, fieldPath: string})
-    | @as("missing_field.throw") MissingFieldThrow({owner: string, fieldPath: string})
+    | @as("missing_required_field.log") MissingRequiredFieldLog({owner: string, fieldPath: string})
+    | @as("missing_required_field.throw")
+    MissingRequiredFieldThrow({
+        owner: string,
+        fieldPath: string,
+      })
+    | @as("missing_expected_data.log") MissingExpectedData({owner: string, fieldPath: string})
+    | @as("missing_expected_data.throw")
+    MissingExpectedDataThrow({
+        owner: string,
+        fieldPath: string,
+        handled: bool,
+      })
     | @as("relay_resolver.error")
     RelayResolverError({
         owner: string,

package/src/RescriptRelay_Fragment.bs.js

@@ -5,6 +5,7 @@ var React = require("react");
 var Caml_option = require("rescript/lib/js/caml_option.js");
 var ReactRelay = require("react-relay");
 var RescriptRelay_Internal = require("./RescriptRelay_Internal.bs.js");
+var Experimental = require("relay-runtime/experimental");
 var ResolverFragments = require("relay-runtime/lib/store/ResolverFragments");
 var UseBlockingPaginationFragment = require("react-relay/lib/relay-hooks/legacy/useBlockingPaginationFragment").default;
 
@@ -112,6 +113,11 @@ function useRefetchableFragment(node, convertFragment, convertRefetchVariables,
         ];
 }
 
+async function waitForFragmentData(environment, node, convertFragment, fRef) {
+  var fragmentData = await Experimental.waitForFragmentData(environment, node, fRef);
+  return convertFragment(fragmentData);
+}
+
 exports.useFragment = useFragment;
 exports.useFragmentOpt = useFragmentOpt;
 exports.readInlineData = readInlineData;
@@ -119,4 +125,5 @@ exports.read = read;
 exports.usePaginationFragment = usePaginationFragment;
 exports.useBlockingPaginationFragment = useBlockingPaginationFragment;
 exports.useRefetchableFragment = useRefetchableFragment;
+exports.waitForFragmentData = waitForFragmentData;
 /* react Not a pure module */

package/src/RescriptRelay_Fragment.res

@@ -241,3 +241,20 @@ let useRefetchableFragment = (
     ),
   )
 }
+
+@module("relay-runtime/experimental")
+external waitForFragmentData_: (
+  Environment.t,
+  fragmentNode<'node>,
+  'fragmentRef,
+) => promise<'fragment> = "waitForFragmentData"
+
+let waitForFragmentData = async (
+  ~environment,
+  ~node,
+  ~convertFragment: 'fragment => 'fragment,
+  ~fRef,
+) => {
+  let fragmentData = await waitForFragmentData_(environment, node, fRef)
+  convertFragment(fragmentData)
+}

package/src/RescriptRelay_Fragment.resi

@@ -83,3 +83,10 @@ let useRefetchableFragment: (
     ~onComplete: option<Js.Exn.t> => unit=?,
   ) => Disposable.t,
 )
+
+let waitForFragmentData: (
+  ~environment: Environment.t,
+  ~node: fragmentNode<'a>,
+  ~convertFragment: 'fragment => 'fragment,
+  ~fRef: 'b,
+) => promise<'fragment>