rescript-relay 3.1.0 → 3.3.0

package/CHANGELOG.md

@@ -1,7 +1,24 @@
 # master
 
+# 3.3.0
+
+- Add support for top level `@catch` on fragments on unions.
+- Add parameter `excludedIds: array<dataId>` to `invalidateRecordsByIds` to allow excluding a list of connection IDs from invalidation.
+- **BREAKING:** `operation.text` and `operation.id` are now nullable, which better reflects what values they can actually have in runtime.
+- fix bug where custom scalars would error when set to null in refetch variables.
+
+# 3.2.0
+
+- Add support for the new Relay `@catch` directive. https://github.com/zth/rescript-relay/pull/549
+- Add support for `usePrefetchableForwardPagination`. https://github.com/zth/rescript-relay/pull/551
+- Remove `useBlockingPagination` since it's being removed from Relay.
+
 # 3.1.0
 
+This brings the Relay version to `18.2.0`.
+
+If you have enabled the feature flags in `relay.config.js` for aliased fragments or Relay resolvers you'll need to remove them from the config file as they are now on by default, and not removing them will cause the compiler to fail with a non super helpful error message.
+
 - **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"]]`.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "rescript-relay",
-  "version": "3.1.0",
+  "version": "3.3.0",
   "main": "src/RescriptRelay.res",
   "license": "MIT",
   "author": "Gabriel Nordeborn",

package/src/RescriptRelay.bs.js

@@ -13,6 +13,32 @@ var Caml_exceptions = require("rescript/lib/js/caml_exceptions.js");
 var LiveResolverStore = require("relay-runtime/lib/store/live-resolvers/LiveResolverStore").default;
 var LiveResolverStore$1 = require("relay-runtime/lib/store/live-resolvers/LiveResolverStore");
 
+function toOption(t) {
+  if (t.ok === true) {
+    return Caml_option.some(t.value);
+  }
+  
+}
+
+function toResult(t) {
+  if (t.ok === true) {
+    return {
+            TAG: "Ok",
+            _0: t.value
+          };
+  } else {
+    return {
+            TAG: "Error",
+            _0: t.errors
+          };
+  }
+}
+
+var CatchResult = {
+  toOption: toOption,
+  toResult: toResult
+};
+
 var SuspenseSentinel = {};
 
 function convertObj(prim0, prim1, prim2, prim3) {
@@ -257,12 +283,16 @@ function findAllConnectionIds(environment, connectionKey, parentId) {
   return ids;
 }
 
-function invalidateAllOfConnection(environment, connectionKey, parentId) {
+function invalidateAllOfConnection(environment, connectionKey, parentId, excludedIdsOpt) {
+  var excludedIds = excludedIdsOpt !== undefined ? excludedIdsOpt : [];
   RelayRuntime.commitLocalUpdate(environment, (function (store) {
           findAllConnectionIds(environment, connectionKey, parentId).forEach(function (dataId) {
-                Belt_Option.forEach(Caml_option.nullable_to_opt(store.get(dataId)), (function (r) {
-                        r.invalidateRecord();
-                      }));
+                if (!excludedIds.includes(dataId)) {
+                  return Belt_Option.forEach(Caml_option.nullable_to_opt(store.get(dataId)), (function (r) {
+                                r.invalidateRecord();
+                              }));
+                }
+                
               });
         }));
 }
@@ -345,6 +375,7 @@ function MakeLoadQuery(C) {
 
 var Mutation_failed = /* @__PURE__ */Caml_exceptions.create("RescriptRelay.Mutation_failed");
 
+exports.CatchResult = CatchResult;
 exports.SuspenseSentinel = SuspenseSentinel;
 exports.convertObj = convertObj;
 exports.RecordProxy = RecordProxy;

package/src/RescriptRelay.res

@@ -17,6 +17,25 @@ type dataIdObject = {id: dataId}
 type recordSourceRecords = Js.Json.t
 type uploadables
 
+module CatchResult = {
+  type catchError = Js.Json.t
+
+  @tag("ok")
+  type t<'value> = | @as(true) Ok({value: 'value}) | @as(false) Error({errors: array<catchError>})
+
+  let toOption = (t: t<'value>) =>
+    switch t {
+    | Ok({value}) => Some(value)
+    | Error(_) => None
+    }
+
+  let toResult = (t: t<'value>): result<'value, array<catchError>> =>
+    switch t {
+    | Ok({value}) => Ok(value)
+    | Error({errors}) => Error(errors)
+    }
+}
+
 module SuspenseSentinel = {
   type t
 
@@ -515,8 +534,8 @@ module Network = {
   type operationMetadata = {codesplits?: array<codesplitsMetadata>}
 
   type operation = {
-    id: string,
-    text: string,
+    id: Js.Nullable.t<string>,
+    text: Js.Nullable.t<string>,
     name: string,
     operationKind: string,
     metadata: Js.Nullable.t<operationMetadata>,
@@ -777,14 +796,21 @@ module Environment = {
     ids
   }
 
-  let invalidateAllOfConnection = (environment: t, ~connectionKey: string, ~parentId: dataId) => {
+  let invalidateAllOfConnection = (
+    environment: t,
+    ~connectionKey: string,
+    ~parentId: dataId,
+    ~excludedIds=[],
+  ) => {
     environment->commitLocalUpdate(~updater=store => {
       environment
       ->findAllConnectionIds(~connectionKey, ~parentId)
       ->Js.Array2.forEach(dataId => {
-        store
-        ->RecordSourceSelectorProxy.get(~dataId)
-        ->Belt.Option.forEach(r => r->RecordProxy.invalidateRecord)
+        if !(excludedIds->Js.Array2.includes(dataId)) {
+          store
+          ->RecordSourceSelectorProxy.get(~dataId)
+          ->Belt.Option.forEach(r => r->RecordProxy.invalidateRecord)
+        }
       })
     })
   }