rescript-relay 3.0.0-rc.8 → 3.0.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "rescript-relay",
-  "version": "3.0.0-rc.8",
+  "version": "3.0.0",
   "main": "src/RescriptRelay.res",
   "license": "MIT",
   "author": "Gabriel Nordeborn",
@@ -35,8 +35,8 @@
     "build": "rescript",
     "build:test": "./build-compiler-dev.sh && ./rescript-relay-compiler",
     "postinstall": "node postinstall.js",
-    "test": "jest",
-    "test:ci": "jest --ci --runInBand"
+    "test": "NODE_OPTIONS=\"$NODE_OPTIONS --experimental-vm-modules\" jest",
+    "test:ci": "NODE_OPTIONS=\"$NODE_OPTIONS --experimental-vm-modules\" jest --ci --runInBand"
   },
   "devDependencies": {
     "@glennsl/rescript-fetch": "^0.2.0",

package/src/RescriptRelay.bs.js

@@ -117,7 +117,76 @@ var Disposable = {};
 
 var Observable = {};
 
-var Network = {};
+var preloadResources = (function preloadResources(operation, variables, response) {
+  let metadata = operation.metadata;
+  if (metadata == null) return;
+  let codesplits = metadata.codesplits;
+  if (codesplits == null) return;
+  let data = response.data;
+
+  function pathExists(obj, path) {
+    let current = obj;
+
+    for (let i = 0; i < path.length; i++) {
+      let segment = path[i];
+
+      if (Array.isArray(current)) {
+        return current.some((item) => pathExists(item, path.slice(i)));
+      } else if (current != null && current.hasOwnProperty(segment)) {
+        current = current[segment];
+      } else if (current != null && (segment.startsWith("$$u$$") || segment.startsWith("$$i$$"))) {
+        let isInterface = segment.startsWith("$$i$$");
+        let expectedTypename = segment.slice(5);
+        if (
+          (
+            !isInterface &&
+            current.hasOwnProperty("__typename") &&
+            current.__typename === expectedTypename) || 
+          (
+            isInterface &&
+            current.hasOwnProperty("__is" + expectedTypename) &&
+            current["__is" + expectedTypename] != null
+          )
+        ) {
+          if (i + 1 === path.length) {
+            // End
+            return true;
+          } else {
+            continue;
+          }
+        } else {
+          return false;
+        }
+      } else {
+        return false;
+      }
+    }
+
+    return current != null;
+  }
+
+  function run() {
+    for (let instruction of codesplits) {
+      let path = instruction[0];
+      let func = instruction[1];
+      if (pathExists(data, path.split("."))) {
+        func(variables);
+      }
+    }
+  }
+
+  if ("requestIdleCallback" in window) {
+    requestIdleCallback(run);
+  } else {
+    setTimeout(() => {
+      Promise.resolve().then(run);
+    }, 1);
+  }
+});
+
+var Network = {
+  preloadResources: preloadResources
+};
 
 var RecordSource = {};
 

package/src/RescriptRelay.res

@@ -9,6 +9,7 @@ type mutationNode<'node>
 type subscriptionNode<'node>
 
 type fragmentRefs<'fragments>
+type resolverFragmentRefs<'fragments>
 type updatableFragmentRefs<'fragments>
 
 type dataId
@@ -503,11 +504,16 @@ module Observable = {
 module Network = {
   type t
 
+  type codesplitsMetadata = (string, unit => unit)
+
+  type operationMetadata = {codesplits?: array<codesplitsMetadata>}
+
   type operation = {
     id: string,
     text: string,
     name: string,
     operationKind: string,
+    metadata: Js.Nullable.t<operationMetadata>,
   }
 
   type subscribeFn = (operation, Js.Json.t, cacheConfig) => Observable.t<Js.Json.t>
@@ -537,6 +543,79 @@ module Network = {
     ~observableFunction: fetchFunctionObservable,
     ~subscriptionFunction: subscribeFn=?,
   ) => t = "create"
+
+  let preloadResources: (
+    ~operation: operation,
+    ~variables: Js.Json.t,
+    ~response: Js.Json.t,
+  ) => unit = %raw(`
+function preloadResources(operation, variables, response) {
+  let metadata = operation.metadata;
+  if (metadata == null) return;
+  let codesplits = metadata.codesplits;
+  if (codesplits == null) return;
+  let data = response.data;
+
+  function pathExists(obj, path) {
+    let current = obj;
+
+    for (let i = 0; i < path.length; i++) {
+      let segment = path[i];
+
+      if (Array.isArray(current)) {
+        return current.some((item) => pathExists(item, path.slice(i)));
+      } else if (current != null && current.hasOwnProperty(segment)) {
+        current = current[segment];
+      } else if (current != null && (segment.startsWith("$$u$$") || segment.startsWith("$$i$$"))) {
+        let isInterface = segment.startsWith("$$i$$");
+        let expectedTypename = segment.slice(5);
+        if (
+          (
+            !isInterface &&
+            current.hasOwnProperty("__typename") &&
+            current.__typename === expectedTypename) || 
+          (
+            isInterface &&
+            current.hasOwnProperty("__is" + expectedTypename) &&
+            current["__is" + expectedTypename] != null
+          )
+        ) {
+          if (i + 1 === path.length) {
+            // End
+            return true;
+          } else {
+            continue;
+          }
+        } else {
+          return false;
+        }
+      } else {
+        return false;
+      }
+    }
+
+    return current != null;
+  }
+
+  function run() {
+    for (let instruction of codesplits) {
+      let path = instruction[0];
+      let func = instruction[1];
+      if (pathExists(data, path.split("."))) {
+        func(variables);
+      }
+    }
+  }
+
+  if ("requestIdleCallback" in window) {
+    requestIdleCallback(run);
+  } else {
+    setTimeout(() => {
+      Promise.resolve().then(run);
+    }, 1);
+  }
+}
+`)
 }
 
 module RecordSource = {

package/src/RescriptRelay.resi

@@ -30,6 +30,9 @@ type subscriptionNode<'node>
 /**This type shows all of the fragments that has been spread on this particular object.*/
 type fragmentRefs<'fragments>
 
+/**This type shows the Relay resolver fragment that has been spread on this particular object.*/
+type resolverFragmentRefs<'fragments>
+
 /**This type shows all of the updatable fragments that has been spread on this particular object.*/
 type updatableFragmentRefs<'fragments>
 
@@ -608,6 +611,10 @@ module Observable: {
 
 /**Represents the network layer.*/
 module Network: {
+  type codesplitsMetadata = (string, unit => unit)
+
+  type operationMetadata = {codesplits?: array<codesplitsMetadata>}
+
   /**The type representing an instantiated `NetworkLayer`.*/
   type t
 
@@ -617,6 +624,7 @@ module Network: {
     text: string,
     name: string,
     operationKind: string,
+    metadata: Js.Nullable.t<operationMetadata>,
   }
 
   /**The shape of the function Relay expects for creating a subscription.*/
@@ -653,6 +661,8 @@ module Network: {
     ~observableFunction: fetchFunctionObservable,
     ~subscriptionFunction: subscribeFn=?,
   ) => t = "create"
+
+  let preloadResources: (~operation: operation, ~variables: Js.Json.t, ~response: Js.Json.t) => unit
 }
 
 /**RecordSource is the source of records used by the store. Can be initiated with or without prior records; eg. hydrating the store with prior data.*/

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 ResolverFragments = require("relay-runtime/lib/store/ResolverFragments");
 var UseBlockingPaginationFragment = require("react-relay/lib/relay-hooks/legacy/useBlockingPaginationFragment").default;
 
 function useFragment(node, convertFragment, fRef) {
@@ -26,6 +27,10 @@ function readInlineData(node, convertFragment, fRef) {
   return convertFragment(ReactRelay.readInlineData(node, fRef));
 }
 
+function read(node, convertFragment, fRef) {
+  return convertFragment(ResolverFragments.readFragment(node, fRef));
+}
+
 function internal_makeRefetchableFnOpts(fetchPolicy, onComplete, param) {
   return {
           fetchPolicy: fetchPolicy,
@@ -110,6 +115,7 @@ function useRefetchableFragment(node, convertFragment, convertRefetchVariables,
 exports.useFragment = useFragment;
 exports.useFragmentOpt = useFragmentOpt;
 exports.readInlineData = readInlineData;
+exports.read = read;
 exports.usePaginationFragment = usePaginationFragment;
 exports.useBlockingPaginationFragment = useBlockingPaginationFragment;
 exports.useRefetchableFragment = useRefetchableFragment;

package/src/RescriptRelay_Fragment.res

@@ -52,6 +52,16 @@ let readInlineData = (~node, ~convertFragment: 'fragment => 'fragment, ~fRef) =>
   (readInlineData_(node, fRef)->convertFragment)
 }
 
+@module("relay-runtime/lib/store/ResolverFragments")
+external read_: (fragmentNode<'node>, 'fragmentRef) => 'fragment = "readFragment"
+
+let read = (~node, ~convertFragment: 'fragment => 'fragment, ~fRef) => {
+  /** This lets you get the data for this fragment _outside \
+                       of React's render_. Useful for letting functions with \
+                       with fragments too, for things like logging etc.*/
+  (read_(node, fRef)->convertFragment)
+}
+
 type refetchableFnOpts = {
   fetchPolicy?: fetchPolicy,
   onComplete?: Js.Nullable.t<Js.Exn.t> => unit,

package/src/RescriptRelay_Fragment.resi

@@ -18,6 +18,12 @@ let readInlineData: (
   ~fRef: 'b,
 ) => 'fragment
 
+let read: (
+  ~node: fragmentNode<'a>,
+  ~convertFragment: 'fragment => 'fragment,
+  ~fRef: 'b,
+) => 'fragment
+
 type paginationLoadMoreOptions = {onComplete?: Js.Nullable.t<Js.Exn.t> => unit}
 
 type paginationLoadMoreFn = (~count: int, ~onComplete: option<Js.Exn.t> => unit=?) => Disposable.t

package/src/RescriptRelay_Internal.bs.js

@@ -80,10 +80,23 @@ function wrapUnion(union) {
   return union;
 }
 
+var applyCodesplitMetadata = (function applyCodesplitMetadata(node, meta) {
+    if (node != null && node.params != null) {
+      let metadata = node.params.metadata;
+      if (metadata == null) {
+        node.params.metadata = {codesplits: meta}
+      } else if (typeof metadata === "object") {
+        node.params.metadata.codesplits = meta
+      }
+    }
+    return node;
+  });
+
 exports.internal_useConvertedValue = internal_useConvertedValue;
 exports.internal_cleanObjectFromUndefinedRaw = internal_cleanObjectFromUndefinedRaw;
 exports.internal_removeUndefinedAndConvertNullsRaw = internal_removeUndefinedAndConvertNullsRaw;
 exports.internal_nullableToOptionalExnHandler = internal_nullableToOptionalExnHandler;
 exports.unwrapUnion = unwrapUnion;
 exports.wrapUnion = wrapUnion;
+exports.applyCodesplitMetadata = applyCodesplitMetadata;
 /* react Not a pure module */

package/src/RescriptRelay_Internal.res

@@ -47,3 +47,25 @@ let unwrapUnion: ('a, array<string>) => 'a = %raw(`
 `)
 
 let wrapUnion = union => union
+
+external internal_resolverFragmentRefsToFragmentRefs: RescriptRelay.resolverFragmentRefs<
+  'a,
+> => RescriptRelay.fragmentRefs<'a> = "%identity"
+
+external internal_resolverFragmentRefsToFragmentRefsPlural: RescriptRelay.resolverFragmentRefs<
+  'a,
+> => array<RescriptRelay.fragmentRefs<'a>> = "%identity"
+
+let applyCodesplitMetadata: ('node, array<(string, dict<Js.Json.t> => unit)>) => 'node = %raw(`
+  function applyCodesplitMetadata(node, meta) {
+    if (node != null && node.params != null) {
+      let metadata = node.params.metadata;
+      if (metadata == null) {
+        node.params.metadata = {codesplits: meta}
+      } else if (typeof metadata === "object") {
+        node.params.metadata.codesplits = meta
+      }
+    }
+    return node;
+  }
+`)

package/src/RescriptRelay_Internal.resi

@@ -8,3 +8,13 @@ let internal_nullableToOptionalExnHandler: option<option<'b> => 'a> => option<
 
 let unwrapUnion: ('a, array<string>) => 'a
 let wrapUnion: 'a => 'a
+
+external internal_resolverFragmentRefsToFragmentRefs: RescriptRelay.resolverFragmentRefs<
+  'a,
+> => RescriptRelay.fragmentRefs<'a> = "%identity"
+
+external internal_resolverFragmentRefsToFragmentRefsPlural: RescriptRelay.resolverFragmentRefs<
+  'a,
+> => array<RescriptRelay.fragmentRefs<'a>> = "%identity"
+
+let applyCodesplitMetadata: ('node, array<(string, dict<Js.Json.t> => unit)>) => 'node

package/src/ReactExperimental.bs.js

@@ -1,23 +0,0 @@
-// Generated by ReScript, PLEASE EDIT WITH CARE
-'use strict';
-
-var React = require("react");
-
-function useTransition() {
-  var match = React.useTransition();
-  var startTransition = match[1];
-  return [
-          match[0],
-          React.useMemo((function () {
-                  return function (cb) {
-                    startTransition(cb, undefined);
-                  };
-                }), [startTransition])
-        ];
-}
-
-var SuspenseList = {};
-
-exports.useTransition = useTransition;
-exports.SuspenseList = SuspenseList;
-/* react Not a pure module */

package/src/ReactExperimental.res

@@ -1,21 +0,0 @@
-@module("react")
-external useDeferredValue: 'value => 'value = "useDeferredValue"
-
-@module("react")
-external useTransitionWithOptions: unit => (
-  bool,
-  (unit => unit, option<{"name": option<string>}>) => unit,
-) = "useTransition"
-
-let useTransition = () => {
-  let (isPending, startTransition) = useTransitionWithOptions()
-  (isPending, React.useMemo1(() => cb => startTransition(cb, None), [startTransition]))
-}
-
-module SuspenseList = {
-  @module("react") @react.component
-  external make: (
-    ~children: React.element,
-    ~revealOrder: [#forwards | #backwards | #together]=?,
-  ) => React.element = "SuspenseList"
-}

package/src/ReactExperimental.resi

@@ -1,18 +0,0 @@
-@module("react")
-external useDeferredValue: 'value => 'value = "useDeferredValue"
-
-@module("react")
-external useTransitionWithOptions: unit => (
-  bool,
-  (unit => unit, option<{"name": option<string>}>) => unit,
-) = "useTransition"
-
-let useTransition: unit => (bool, (unit => unit) => unit)
-
-module SuspenseList: {
-  @module("react") @react.component
-  external make: (
-    ~children: React.element,
-    ~revealOrder: [#forwards | #backwards | #together]=?,
-  ) => React.element = "SuspenseList"
-}