rescript-relay 1.0.0-beta.21 → 1.0.0-beta.24

package/CHANGELOG.md

@@ -1,6 +1,6 @@
 # master
 
-# 1.0.0-beta.21
+# 1.0.0-beta.24
 
 _[Here's a commit showing a project being upgraded to this version](https://github.com/zth/rescript-relay/commit/5831c2f1f0f13eedc1cb60468c32fd32b2dc01d3)_
 
@@ -49,6 +49,23 @@ You can go ahead and remove these packages, that are no longer needed, as the co
 
 ### unreleased
 
+## 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)).

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "rescript-relay",
-  "version": "1.0.0-beta.21",
+  "version": "1.0.0-beta.24",
   "main": "src/RescriptRelay.res",
   "license": "MIT",
   "author": "Gabriel Nordeborn",
@@ -39,6 +39,7 @@
     "test:ci": "jest --ci --runInBand"
   },
   "devDependencies": {
+    "rescript": "^9.1.2",
     "@rescript/react": "0.10.3",
     "@testing-library/jest-dom": "^5.16.3",
     "@testing-library/react": "^13.0.0-alpha.6",
@@ -54,13 +55,12 @@
   },
   "peerDependencies": {
     "@rescript/react": "*",
-    "react-relay": "*",
+    "react-relay": ">=11.0.0",
     "relay-runtime": "*",
     "rescript": "^9.1.2"
   },
   "dependencies": {
-    "detect-libc": "^2.0.1",
-    "rescript": "^9.1.2"
+    "detect-libc": "^2.0.1"
   },
   "resolutions": {
     "react": "18.0.0",

package/src/RescriptRelay.bs.js

@@ -10,7 +10,6 @@ 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 Hooks = require("react-relay/hooks");
 
 function convertObj(prim0, prim1, prim2, prim3) {
   return Utils.traverser(prim0, prim1, prim2, prim3);
@@ -135,7 +134,7 @@ function toJs(f, arg) {
   return Curry._3(f, arg.kind, arg.owner, arg.fieldPath);
 }
 
-function make$1(network, store, getDataID, treatMissingFieldsAsNull, missingFieldHandlers, requiredFieldLogger, param) {
+function make$1(network, store, getDataID, treatMissingFieldsAsNull, missingFieldHandlers, requiredFieldLogger, isServer, param) {
   var tmp = {
     network: network,
     store: store,
@@ -151,6 +150,9 @@ function make$1(network, store, getDataID, treatMissingFieldsAsNull, missingFiel
   if (tmp$1 !== undefined) {
     tmp.requiredFieldLogger = Caml_option.valFromOption(tmp$1);
   }
+  if (isServer !== undefined) {
+    tmp.isServer = Caml_option.valFromOption(isServer);
+  }
   return new RelayRuntime.Environment(tmp);
 }
 
@@ -158,11 +160,10 @@ var Environment = {
   make: make$1
 };
 
-var provider = ReactRelay.ReactRelayContext.Provider;
-
 function RescriptRelay$Context$Provider(Props) {
   var environment = Props.environment;
   var children = Props.children;
+  var provider = ReactRelay.ReactRelayContext.Provider;
   return React.createElement(provider, {
               value: {
                 environment: environment
@@ -175,6 +176,10 @@ var Provider = {
   make: RescriptRelay$Context$Provider
 };
 
+var Context = {
+  Provider: Provider
+};
+
 var EnvironmentNotFoundInContext = /* @__PURE__ */Caml_exceptions.create("RescriptRelay.EnvironmentNotFoundInContext");
 
 function useEnvironmentFromContext(param) {
@@ -218,7 +223,7 @@ function mapFetchQueryFetchPolicy(x) {
 
 function MakeLoadQuery(C) {
   var load = function (environment, variables, fetchPolicy, fetchKey, networkCacheConfig, param) {
-    return Hooks.loadQuery(environment, C.query, Curry._1(C.convertVariables, variables), {
+    return ReactRelay.loadQuery(environment, C.query, Curry._1(C.convertVariables, variables), {
                 fetchKey: fetchKey,
                 fetchPolicy: mapFetchPolicy(fetchPolicy),
                 networkCacheConfig: networkCacheConfig
@@ -259,10 +264,6 @@ var Mutation_failed = /* @__PURE__ */Caml_exceptions.create("RescriptRelay.Mutat
 
 var RequiredFieldLogger = {};
 
-var Context = {
-  Provider: Provider
-};
-
 exports.convertObj = convertObj;
 exports.RecordProxy = RecordProxy;
 exports.RecordSourceSelectorProxy = RecordSourceSelectorProxy;

package/src/RescriptRelay.res

@@ -572,6 +572,7 @@ module Store = {
 
   @send external getSource: t => RecordSource.t = "getSource"
   @send external publish: (t, RecordSource.t) => unit = "publish"
+  @send external holdGC: t => unit = "holdGC"
 }
 
 module RequiredFieldLogger = {
@@ -601,6 +602,8 @@ module Environment = {
     missingFieldHandlers: array<MissingFieldHandler.t>,
     @optional
     requiredFieldLogger: RequiredFieldLogger.js,
+    @optional
+    isServer: bool,
   }
 
   @module("relay-runtime") @new
@@ -613,6 +616,7 @@ module Environment = {
     ~treatMissingFieldsAsNull=?,
     ~missingFieldHandlers=?,
     ~requiredFieldLogger=?,
+    ~isServer=?,
     (),
   ) =>
     make(
@@ -626,6 +630,7 @@ module Environment = {
         | None => [nodeInterfaceMissingFieldHandler]
         },
         ~requiredFieldLogger=?requiredFieldLogger->Belt.Option.map(RequiredFieldLogger.toJs),
+        ~isServer?,
         (),
       ),
     )
@@ -643,15 +648,16 @@ module Context = {
 
   @module("react-relay")
   external context: React.Context.t<option<contextShape>> = "ReactRelayContext"
-  let provider = React.Context.provider(context)
 
   module Provider = {
     @react.component
-    let make = (~environment: Environment.t, ~children) =>
+    let make = (~environment: Environment.t, ~children) => {
+      let provider = React.Context.provider(context)
       React.createElement(
         provider,
         {"value": Some({"environment": environment}), "children": children},
       )
+    }
   }
 }
 
@@ -703,7 +709,7 @@ type loadQueryConfig = {
   networkCacheConfig: option<cacheConfig>,
 }
 
-@module("react-relay/hooks")
+@module("react-relay")
 external loadQuery: (Environment.t, queryNode<'a>, 'variables, loadQueryConfig) => 'queryResponse =
   "loadQuery"
 
@@ -775,6 +781,6 @@ external commitLocalUpdate: (
   ~updater: RecordSourceSelectorProxy.t => unit,
 ) => unit = "commitLocalUpdate"
 
-@module("react-relay/hooks")
+@module("react-relay")
 external useSubscribeToInvalidationState: (array<dataId>, unit => unit) => Disposable.t =
   "useSubscribeToInvalidationState"

package/src/RescriptRelay.resi

@@ -765,6 +765,12 @@ module Store: {
   )
   @send
   external publish: (t, RecordSource.t) => unit = "publish"
+
+  @ocaml.doc(
+    "Informes the store to stop its normal garbage collection processes. This prevents data being lost between calling relay's `fetchQuery` any serialization process (eg: toJSON)"
+  )
+  @send
+  external holdGC: t => unit = "holdGC"
 }
 
 @ocaml.doc("Internal, do not use.")
@@ -810,6 +816,7 @@ module Environment: {
     ~treatMissingFieldsAsNull: bool=?,
     ~missingFieldHandlers: array<MissingFieldHandler.t>=?,
     ~requiredFieldLogger: RequiredFieldLogger.t=?,
+    ~isServer: bool=?,
     unit,
   ) => t
 
@@ -891,7 +898,7 @@ external commitLocalUpdate: (
 @ocaml.doc(
   "Allows you to subscribe to when a record, connection, or even the store itself is invalidated, and then react to that."
 )
-@module("react-relay/hooks")
+@module("react-relay")
 external useSubscribeToInvalidationState: (array<dataId>, unit => unit) => Disposable.t =
   "useSubscribeToInvalidationState"