rescript-relay 1.0.0-rc.4 → 1.0.0

package/CHANGELOG.md

@@ -1,15 +1,15 @@
 # master
 
-# 1.0.0-rc.4
+# 1.0.0
 
 _[Here's a commit showing a project being upgraded to this version](https://github.com/zth/rescript-relay/commit/5831c2f1f0f13eedc1cb60468c32fd32b2dc01d3)_
 
-The time has finally come - RescriptRelay `1.0.0` is in beta! The one, big major thing this release brings is that the ReScript type generation for the Relay compiler has been completely rewritten, and fully integrated into the new Relay Rust compiler. The RescriptRelay fork of the compiler is available and maintained [here])(https://github.com/zth/relay/tree/rescript-relay).
+The time has finally come - RescriptRelay `1.0.0` is released! This version brings a ton of new features and improvements. One of the the big major things this release brings is that the ReScript type generation for the Relay compiler has been completely rewritten, and fully integrated into the new Relay Rust compiler. The RescriptRelay fork of the compiler is available and maintained [here])(https://github.com/zth/relay/tree/rescript-relay).
 
 ## Upgrade versions
 
-- `react-relay` and `relay-runtime` to `14.1.0`
-- `react` and `react-dom` to `18.0.0`
+- `react-relay` and `relay-runtime` to `>=14.1.0`
+- `react` and `react-dom` to `>=18.0.0`
 
 ## Remove Packages
 
@@ -29,6 +29,15 @@ You can go ahead and remove these packages, that are no longer needed, as the co
 - Bindings for `requiredFieldLogger` for logging when missing fields are encountered (kudos [Emilios1995](https://github.com/Emilios1995)).
 - Improved utils for [dealing with enums](https://rescript-relay-documentation.vercel.app/docs/enums).
 - `recordSourceRecords` is now typed as `Js.Json.t` rather than being abstract.
+- Project now works in `"type": "module"` mode in `package.json` (kudos [cometkim](https://github.com/cometkim))
+- The field name of the `id` field of the `Node` interface is now configurable via `schemaConfig: {nodeInterfaceIdField: "idNameHere"}`.
+- Add support for experimental [Relay Resolvers](https://relay.dev/docs/next/guides/relay-resolvers). Undocumented so far, but looking at the [test](https://github.com/zth/rescript-relay/blob/master/packages/rescript-relay/__tests__/Test_relayResolvers.res) and [definition file](https://github.com/zth/rescript-relay/blob/master/packages/rescript-relay/__tests__/TestRelayUserResolver.res) should give you a hint of how it works.
+- Support `@rescriptRelayIgnoreUnused` directive on fragment definitions to insert annotations that makes `reanalyze` consider all fields in the fragment used, even if they aren't.
+- Support `@rescriptRelayAllowUnsafeEnum` directive on fields selecting enums, which will ignore safety measures for enums, meaning you won't need to add a catch all clause, etc. It'll essentially output the enum as an _input_ enum (as desribed in the docs).
+- Support [provided variables](https://relay.dev/docs/api-reference/graphql-and-directives/#provided-variables). More info in the docs.
+- Windows support! :tada:
+- A `RelaySchemaAssets_graphql.res` is now emitted, containing type definitions for all enums and all input objects. This is designed to help with accessing and using enums and input objects outside of Relay's context. This means it'll be much easier to share makers for input objects, pass enums around, etc.
+- Each fragment with a `@connection` now emits a `makeConnectionId` function that allows you to generate _type safe_ connection IDs. More on why this is useful in the documentation.
 
 ## Breaking changes
 
@@ -45,8 +54,27 @@ You can go ahead and remove these packages, that are no longer needed, as the co
 
   More details on this [in the docs](https://rescript-relay-documentation.vercel.app/docs/refetching-and-loading-more-data#makerefetchvariables). Thanks to [@tsnobip](https://github.com/tsnobip) for fixing this!
 
+- All enum type definitions now reside in `RelaySchemaAssets_graphql.enum_<yourEnumName>`, and are _not_ generated on the operation itself anymore. So, if you previously referred to the actual enum _type_, like `Fragment.Types.enum_MyFineEnum`, you'll now need to refer to that enum type as `RelaySchemaAssets_graphql.enum_MyFineEnum`.
+- Input object fields with illegal names in ReScript previously had their maker function argument names suffixed with `_`, like `~type_: string`. This is now instead _prefixed_, like `~_type: string`. Prefixing like this instead of suffixing means we can ship fully zero cost maker functions, which we couldn't before for input objects with illegal field names.
+
+## Assorted Changes and Fixes
+
+- Add Environment isServer option @MoOx
+- Remove rescript from dependencies @anmonteiro
+- Add undocumented holdGC method on relay store @MoOx
+- Fixed `setLinkedRecordToNull`, `setLinkedRecordToUndefined`, `setLinkedRecordsToNull` and `setLinkedRecordsToUndefined` methods by binding them to `setValue` instead of `setLinkedRecord/s`. Previously they were throwing an error because `setLinkedRecord/s` did not support "deleting" values using them. (@reck753)
+- Fix long standing bug that would make whether connection helpers were emitted or not unreliable.
+
 ## 1.0.0 development changelog
 
+- Fix bug in the new type safe connection ID makers where null default values wouldn't turn the variable into a `Js.Null.t<t>`, leading to type errors.
+- Fix bug with connection handling where connections behind a `@include` or `@skip` directive would not be found.
+- Move `getConnectionNodes` back into generated and auto included `Utils` module. This means that failing to generate `getConnectionNodes`, which can happen for various reasons, won't break the build, but rather not just emit the helper.
+
+### rc.5
+
+- Fix compat with `rescript@10.1.0-alpha.1`.
+
 ### rc.4
 
 - _potentially breaking_ All enum type definitions now reside in `RelaySchemaAssets_graphql.enum_<yourEnumName>`, and are _not_ generated on the operation itself anymore. So, if you previously referred to the actual enum _type_, like `Fragment.Types.enum_MyFineEnum`, you'll now need to refer to that enum type as `RelaySchemaAssets_graphql.enum_MyFineEnum`.
@@ -63,7 +91,6 @@ You can go ahead and remove these packages, that are no longer needed, as the co
 ### rc.1
 
 - Restore half-broken connection helper function inlining.
--
 
 ### rc.0
 

package/package.json

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

package/src/RescriptRelay.res

@@ -573,8 +573,8 @@ module Store = {
     make(
       source,
       {
-        gcReleaseBufferSize: gcReleaseBufferSize,
-        queryCacheExpirationTime: queryCacheExpirationTime,
+        gcReleaseBufferSize,
+        queryCacheExpirationTime,
       },
     )
 
@@ -751,9 +751,9 @@ module MakeLoadQuery = (C: MakeLoadQueryConfig) => {
       C.query,
       variables->C.convertVariables,
       {
-        fetchKey: fetchKey,
+        fetchKey,
         fetchPolicy: fetchPolicy->mapFetchPolicy,
-        networkCacheConfig: networkCacheConfig,
+        networkCacheConfig,
       },
     )
 
@@ -770,10 +770,8 @@ module MakeLoadQuery = (C: MakeLoadQueryConfig) => {
       switch token->queryRefToObservable {
       | None => resolve(. Error())
       | Some(o) =>
-        let _: Observable.subscription = o->{
-          open Observable
-          subscribe(makeObserver(~complete=() => resolve(. Ok()), ()))
-        }
+        open Observable
+        let _: subscription = o->subscribe(makeObserver(~complete=() => resolve(. Ok()), ()))
       }
     })
   }

package/src/experimental-router/RescriptRelayRouter.bs.js

@@ -1,424 +0,0 @@
-// Generated by ReScript, PLEASE EDIT WITH CARE
-'use strict';
-
-var Curry = require("rescript/lib/js/curry.js");
-var React = require("react");
-var Js_dict = require("rescript/lib/js/js_dict.js");
-var Caml_obj = require("rescript/lib/js/caml_obj.js");
-var Belt_Array = require("rescript/lib/js/belt_Array.js");
-var Belt_Option = require("rescript/lib/js/belt_Option.js");
-var Caml_option = require("rescript/lib/js/caml_option.js");
-var Caml_exceptions = require("rescript/lib/js/caml_exceptions.js");
-var ReactExperimental = require("../ReactExperimental.bs.js");
-var RescriptReactRouter = require("@rescript/react/src/RescriptReactRouter.bs.js");
-
-function matchesUrl(t, url) {
-  return Curry._1(t.matchesUrl, url);
-}
-
-function preload(t, url) {
-  return Curry._1(t.preload, url);
-}
-
-function render(t, url) {
-  return Curry._1(t.render, url);
-}
-
-function make(matchUrl, prepare, render) {
-  return {
-          preload: (function (url) {
-              var params = Curry._1(matchUrl, url);
-              if (params !== undefined) {
-                Curry._1(prepare, Caml_option.valFromOption(params));
-                return ;
-              }
-              
-            }),
-          matchesUrl: (function (url) {
-              return Curry._1(matchUrl, url) !== undefined;
-            }),
-          render: (function (url) {
-              var params = Curry._1(matchUrl, url);
-              if (params !== undefined) {
-                return Curry._1(render, Curry._1(prepare, Caml_option.valFromOption(params)));
-              } else {
-                return null;
-              }
-            })
-        };
-}
-
-var RouteFamily = {
-  matchesUrl: matchesUrl,
-  preload: preload,
-  render: render,
-  make: make
-};
-
-function getHash(url) {
-  var index = url.indexOf("#");
-  if (index >= 0) {
-    return url.slice(index + 1 | 0);
-  } else {
-    return String("");
-  }
-}
-
-function pathParse(str) {
-  switch (str) {
-    case "" :
-    case "/" :
-        return /* [] */0;
-    default:
-      var raw = str.slice(1);
-      var match = raw[raw.length - 1 | 0];
-      var raw$1 = match === "/" ? raw.slice(0, -1) : raw;
-      var match$1 = raw$1.split("?", 2);
-      var raw$2 = match$1.length !== 2 ? raw$1 : match$1[0];
-      var a = raw$2.split("/").filter(function (item) {
-            return item.length !== 0;
-          });
-      var _i = a.length - 1 | 0;
-      var _res = /* [] */0;
-      while(true) {
-        var res = _res;
-        var i = _i;
-        if (i < 0) {
-          return res;
-        }
-        _res = {
-          hd: a[i],
-          tl: res
-        };
-        _i = i - 1 | 0;
-        continue ;
-      };
-  }
-}
-
-function searchParse(str) {
-  switch (str) {
-    case "" :
-    case "?" :
-        return "";
-    default:
-      var match = str.split("?", 2);
-      if (match.length !== 2) {
-        return "";
-      } else {
-        return match[1];
-      }
-  }
-}
-
-function parseUrl(url) {
-  return {
-          path: pathParse(url),
-          hash: getHash(url),
-          search: searchParse(url)
-        };
-}
-
-var context = React.createContext(undefined);
-
-var make$1 = context.Provider;
-
-function makeProps(value, children, param) {
-  return {
-          value: value,
-          children: children
-        };
-}
-
-var No_router_in_context = /* @__PURE__ */Caml_exceptions.create("RescriptRelayRouter.No_router_in_context");
-
-function replaceShallow(path) {
-  var match = typeof history === "undefined" ? undefined : history;
-  var match$1 = typeof window === "undefined" ? undefined : window;
-  if (match !== undefined && match$1 !== undefined) {
-    match.replaceState(null, "", path);
-    return ;
-  }
-  
-}
-
-function pushShallow(path) {
-  var match = typeof history === "undefined" ? undefined : history;
-  var match$1 = typeof window === "undefined" ? undefined : window;
-  if (match !== undefined && match$1 !== undefined) {
-    match.pushState(null, "", path);
-    return ;
-  }
-  
-}
-
-var NavigationUtils = {
-  replaceShallow: replaceShallow,
-  pushShallow: pushShallow
-};
-
-function make$2(routes) {
-  var initialUrl = RescriptReactRouter.dangerouslyGetInitialUrl(undefined, undefined);
-  var matchRoutes = function (routes, url) {
-    return Belt_Array.getBy(routes, (function (r) {
-                  return Curry._1(r.matchesUrl, url);
-                }));
-  };
-  var currentRoute = {
-    contents: {
-      route: matchRoutes(routes, initialUrl),
-      url: initialUrl
-    }
-  };
-  var subscribers = {};
-  var subId = {
-    contents: 0
-  };
-  var getNextId = function (param) {
-    subId.contents = subId.contents + 1 | 0;
-    return String(subId.contents);
-  };
-  RescriptReactRouter.watchUrl(function (url) {
-        if (!Caml_obj.caml_notequal(url.path, currentRoute.contents.url.path)) {
-          return ;
-        }
-        var route = matchRoutes(routes, url);
-        if (route !== undefined) {
-          Curry._1(route.preload, url);
-        }
-        var nextEntry = {
-          route: route,
-          url: url
-        };
-        currentRoute.contents = nextEntry;
-        return Belt_Array.forEach(Js_dict.values(subscribers), (function (x) {
-                      if (x !== undefined) {
-                        return Curry._1(x, nextEntry);
-                      }
-                      
-                    }));
-      });
-  return {
-          get: (function (param) {
-              return currentRoute.contents;
-            }),
-          preload: (function (url) {
-              var asRouterUrl = parseUrl(url);
-              var r = matchRoutes(routes, asRouterUrl);
-              if (r !== undefined) {
-                return Curry._1(r.preload, asRouterUrl);
-              }
-              
-            }),
-          subscribe: (function (cb) {
-              var id = getNextId(undefined);
-              subscribers[id] = cb;
-              return function (param) {
-                subscribers[id] = undefined;
-                
-              };
-            })
-        };
-}
-
-function useRouter(param) {
-  var router = React.useContext(context);
-  return React.useMemo((function () {
-                return {
-                        push: RescriptReactRouter.push,
-                        pushShallow: pushShallow,
-                        replace: RescriptReactRouter.replace,
-                        replaceShallow: pushShallow,
-                        preload: router.preload
-                      };
-              }), [router.preload]);
-}
-
-function RescriptRelayRouter$RouteRenderer(Props) {
-  var renderPending = Props.renderPending;
-  var renderFallback = Props.renderFallback;
-  var renderNotFound = Props.renderNotFound;
-  var match = React.useState(function () {
-        return false;
-      });
-  var initialized = match[0];
-  var router = React.useContext(context);
-  var match$1 = ReactExperimental.useTransition(undefined);
-  var startTransition = match$1[1];
-  var match$2 = React.useState(function () {
-        return Curry._1(router.get, undefined);
-      });
-  var setRouteEntry = match$2[1];
-  var routeEntry = match$2[0];
-  var match$3 = routeEntry.route;
-  if (initialized || match$3 === undefined) {
-    
-  } else {
-    Curry._1(match$3.preload, routeEntry.url);
-    Curry._1(match[1], (function (param) {
-            return true;
-          }));
-  }
-  React.useEffect((function () {
-          var currentEntry = Curry._1(router.get, undefined);
-          if (Caml_obj.caml_notequal(routeEntry.url, currentEntry.url)) {
-            Curry._1(setRouteEntry, (function (param) {
-                    return currentEntry;
-                  }));
-            return ;
-          } else {
-            return Curry._1(router.subscribe, (function (nextRoute) {
-                          return Curry._1(startTransition, (function (param) {
-                                        return Curry._1(setRouteEntry, (function (param) {
-                                                      return nextRoute;
-                                                    }));
-                                      }));
-                        }));
-          }
-        }), [
-        router,
-        startTransition
-      ]);
-  var match$4 = routeEntry.route;
-  var renderedContent = initialized && match$4 !== undefined ? Caml_option.some(Curry._1(match$4.render, routeEntry.url)) : undefined;
-  if (initialized) {
-    return React.createElement(React.Fragment, undefined, renderPending !== undefined ? Curry._1(renderPending, match$1[0]) : null, React.createElement(React.Suspense, {
-                    children: renderedContent !== undefined ? Caml_option.valFromOption(renderedContent) : (
-                        renderNotFound !== undefined ? Curry._1(renderNotFound, routeEntry.url) : null
-                      ),
-                    fallback: renderFallback !== undefined ? Curry._1(renderFallback, undefined) : null
-                  }));
-  } else {
-    return null;
-  }
-}
-
-var RouteRenderer = {
-  make: RescriptRelayRouter$RouteRenderer
-};
-
-function isModifiedEvent(e) {
-  var match = e.metaKey;
-  var match$1 = e.altKey;
-  var match$2 = e.ctrlKey;
-  var match$3 = e.shiftKey;
-  if (match$2 || match$3 || match$1 || match) {
-    return true;
-  } else {
-    return false;
-  }
-}
-
-function RescriptRelayRouter$Link(Props) {
-  var to_ = Props.to_;
-  var title = Props.title;
-  var id = Props.id;
-  var className = Props.className;
-  var classNameDynamic = Props.classNameDynamic;
-  var browserTarget = Props.target;
-  var tabIndex = Props.tabIndex;
-  var mode = Props.mode;
-  var render = Props.render;
-  var preloadOnHover = Props.preloadOnHover;
-  var children = Props.children;
-  var onClick = Props.onClick;
-  var router = React.useContext(context);
-  var url = RescriptReactRouter.useUrl(undefined, undefined);
-  var changeRoute = React.useCallback((function (e) {
-          var match = e.isDefaultPrevented();
-          var match$1 = e.button;
-          var match$2 = isModifiedEvent(e);
-          if (match) {
-            return ;
-          }
-          if (match$1 !== 0) {
-            return ;
-          }
-          if (browserTarget !== undefined && browserTarget !== "self") {
-            return ;
-          }
-          if (match$2) {
-            return ;
-          }
-          e.preventDefault();
-          var navigate = function (param) {
-            if (mode === "replace") {
-              return RescriptReactRouter.replace(to_);
-            } else {
-              return RescriptReactRouter.push(to_);
-            }
-          };
-          navigate(undefined);
-          
-        }), [
-        to_,
-        router
-      ]);
-  var preload = React.useCallback((function (param) {
-          return Curry._1(router.preload, to_);
-        }), [
-        to_,
-        router
-      ]);
-  if (render !== undefined) {
-    var linkUrl = parseUrl(to_);
-    return Curry._4(render, preload, changeRoute, url, linkUrl);
-  }
-  var tmp = {
-    className: Belt_Option.getWithDefault(className, "") + (
-      classNameDynamic !== undefined ? " " + Curry._2(classNameDynamic, url, parseUrl(to_)) : ""
-    ),
-    href: to_,
-    target: browserTarget !== undefined ? (
-        browserTarget === "blank" ? "_blank" : "_self"
-      ) : "",
-    onClick: (function (e) {
-        Curry._1(changeRoute, e);
-        if (onClick !== undefined) {
-          return Curry._1(onClick, undefined);
-        }
-        
-      }),
-    onMouseDown: (function (param) {
-        return Curry._1(preload, undefined);
-      }),
-    onMouseEnter: (function (param) {
-        if (preloadOnHover !== undefined && preloadOnHover) {
-          return Curry._1(preload, undefined);
-        }
-        
-      }),
-    onTouchStart: (function (param) {
-        return Curry._1(preload, undefined);
-      })
-  };
-  if (id !== undefined) {
-    tmp.id = Caml_option.valFromOption(id);
-  }
-  if (tabIndex !== undefined) {
-    tmp.tabIndex = Caml_option.valFromOption(tabIndex);
-  }
-  if (title !== undefined) {
-    tmp.title = Caml_option.valFromOption(title);
-  }
-  return React.createElement("a", tmp, children);
-}
-
-var Link = {
-  make: RescriptRelayRouter$Link
-};
-
-var Provider = {
-  makeProps: makeProps,
-  make: make$1
-};
-
-exports.RouteFamily = RouteFamily;
-exports.Provider = Provider;
-exports.No_router_in_context = No_router_in_context;
-exports.useRouter = useRouter;
-exports.make = make$2;
-exports.RouteRenderer = RouteRenderer;
-exports.Link = Link;
-exports.NavigationUtils = NavigationUtils;
-/* context Not a pure module */

package/src/experimental-router/RescriptRelayRouter.res

@@ -1,379 +0,0 @@
-module RouteFamily = {
-  type t = {
-    preload: RescriptReactRouter.url => unit,
-    matchesUrl: RescriptReactRouter.url => bool,
-    render: RescriptReactRouter.url => React.element,
-  }
-
-  let matchesUrl = (t, url) => t.matchesUrl(url)
-  let preload = (t, url) => t.preload(url)
-  let render = (t, url) => t.render(url)
-
-  let make = (~matchUrl, ~prepare, ~render) => {
-    preload: url =>
-      switch matchUrl(url) {
-      | Some(params) =>
-        let _ = prepare(params)
-      | None => ()
-      },
-    matchesUrl: url =>
-      switch matchUrl(url) {
-      | Some(_) => true
-      | None => false
-      },
-    render: url =>
-      switch matchUrl(url) {
-      | Some(params) => params->prepare->render
-      | None => React.null
-      },
-  }
-}
-
-module Url = {
-  type t = RescriptReactRouter.url
-
-  let getHash = url => {
-    switch url->Js.String2.indexOf("#") {
-    | index if index >= 0 => url->Js.String2.sliceToEnd(~from=index + 1)
-    | _ => Js.String2.make("")
-    }
-  }
-
-  // Start - taken from RescriptReactRouter
-  let arrayToList = a => {
-    let rec tolist = (i, res) =>
-      if i < 0 {
-        res
-      } else {
-        tolist(i - 1, list{Js.Array.unsafe_get(a, i), ...res})
-      }
-    tolist(Js.Array.length(a) - 1, list{})
-  }
-  let pathParse = str =>
-    switch str {
-    | ""
-    | "/" => list{}
-    | raw =>
-      /* remove the preceeding /, which every pathname seems to have */
-      let raw = Js.String.sliceToEnd(~from=1, raw)
-      /* remove the trailing /, which some pathnames might have. Ugh */
-      let raw = switch Js.String.get(raw, Js.String.length(raw) - 1) {
-      | "/" => Js.String.slice(~from=0, ~to_=-1, raw)
-      | _ => raw
-      }
-      /* remove search portion if present in string */
-      let raw = switch raw |> Js.String.splitAtMost("?", ~limit=2) {
-      | [path, _] => path
-      | _ => raw
-      }
-
-      raw
-      |> Js.String.split("/")
-      |> Js.Array.filter(item => String.length(item) != 0)
-      |> arrayToList
-    }
-
-  let searchParse = str =>
-    switch str {
-    | ""
-    | "?" => ""
-    | raw =>
-      switch raw |> Js.String.splitAtMost("?", ~limit=2) {
-      | [_, search] => search
-      | _ => ""
-      }
-    }
-  // End - taken from RescriptReactRouter
-
-  let parseUrl = (url: string): t => {
-    path: url->pathParse,
-    hash: url->getHash,
-    search: url->searchParse,
-  }
-
-  let make = url => url->parseUrl
-}
-
-type routeEntry = {
-  route: option<RouteFamily.t>,
-  url: RescriptReactRouter.url,
-}
-
-type subscriberCallback = routeEntry => unit
-type disposeSubscriber = unit => unit
-
-type routerContext = {
-  get: unit => routeEntry,
-  preload: string => unit,
-  subscribe: subscriberCallback => disposeSubscriber,
-}
-
-let context = React.createContext(Obj.magic())
-
-module Provider = {
-  let make = React.Context.provider(context)
-
-  let makeProps = (~value, ~children, ()) =>
-    {
-      "value": value,
-      "children": children,
-    }
-}
-
-exception No_router_in_context
-
-module NavigationUtils = {
-  @send
-  external replaceShallow: (Dom.history, @as(json`null`) _, @as("") _, ~href: string) => unit =
-    "replaceState"
-
-  let replaceShallow = path =>
-    switch (%external(history), %external(window)) {
-    | (None, _)
-    | (_, None) => ()
-    | (Some(history: Dom.history), Some(_window: Dom.window)) => replaceShallow(history, ~href=path)
-    }
-
-  @send
-  external pushShallow: (Dom.history, @as(json`null`) _, @as("") _, ~href: string) => unit =
-    "pushState"
-
-  let pushShallow = path =>
-    switch (%external(history), %external(window)) {
-    | (None, _)
-    | (_, None) => ()
-    | (Some(history: Dom.history), Some(_window: Dom.window)) => pushShallow(history, ~href=path)
-    }
-}
-
-let use = (): routerContext => React.useContext(context)
-
-let make = routes => {
-  let initialUrl = RescriptReactRouter.dangerouslyGetInitialUrl()
-
-  let matchRoutes = (routes, url): option<RouteFamily.t> =>
-    routes->Belt.Array.getBy(r => r->RouteFamily.matchesUrl(url))
-
-  let currentRoute: ref<routeEntry> = ref({url: initialUrl, route: matchRoutes(routes, initialUrl)})
-
-  let subscribers: Js.Dict.t<option<subscriberCallback>> = Js.Dict.empty()
-  let subId = ref(0)
-
-  let getNextId = () => {
-    subId := subId.contents + 1
-    subId.contents->string_of_int
-  }
-
-  let _ = RescriptReactRouter.watchUrl(url =>
-    if url.path != currentRoute.contents.url.path {
-      let route = matchRoutes(routes, url)
-
-      switch route {
-      | Some(r) => r->RouteFamily.preload(url)
-      | None => ()
-      }
-
-      let nextEntry = {route: route, url: url}
-
-      currentRoute := nextEntry
-      subscribers
-      ->Js.Dict.values
-      ->Belt.Array.forEach(x =>
-        switch x {
-        | Some(cb) => cb(nextEntry)
-        | None => ()
-        }
-      )
-    }
-  )
-
-  let router = {
-    get: () => currentRoute.contents,
-    preload: url => {
-      let asRouterUrl = url->Url.make
-
-      switch routes->matchRoutes(asRouterUrl) {
-      | Some(r) => r->RouteFamily.preload(asRouterUrl)
-      | None => ()
-      }
-    },
-    subscribe: cb => {
-      let id = getNextId()
-      subscribers->Js.Dict.set(id, Some(cb))
-      () => subscribers->Js.Dict.set(id, None)
-    },
-  }
-
-  router
-}
-
-type router = {
-  push: string => unit,
-  pushShallow: string => unit,
-  replace: string => unit,
-  replaceShallow: string => unit,
-  preload: string => unit,
-}
-
-let useRouter = () => {
-  let router = use()
-
-  React.useMemo1(() => {
-    push: RescriptReactRouter.push,
-    pushShallow: NavigationUtils.pushShallow,
-    replace: RescriptReactRouter.replace,
-    replaceShallow: NavigationUtils.pushShallow,
-    preload: router.preload,
-  }, [router.preload])
-}
-
-module RouteRenderer = {
-  @react.component
-  let make = (~renderPending=?, ~renderFallback=?, ~renderNotFound=?, ()) => {
-    let (initialized, setInitialized) = React.useState(() => false)
-    let router = use()
-
-    let (isPending, startTransition) = ReactExperimental.useTransition()
-
-    let (routeEntry, setRouteEntry) = React.useState(() => router.get())
-
-    switch (initialized, routeEntry.route) {
-    | (false, Some(r)) =>
-      r->RouteFamily.preload(routeEntry.url)
-      setInitialized(_ => true)
-    | _ => ()
-    }
-
-    React.useEffect2(() => {
-      let currentEntry = router.get()
-      if routeEntry.url != currentEntry.url {
-        setRouteEntry(_ => currentEntry)
-        None
-      } else {
-        let dispose = router.subscribe(nextRoute =>
-          startTransition(() => setRouteEntry(_ => nextRoute))
-        )
-
-        Some(dispose)
-      }
-    }, (router, startTransition))
-
-    let renderedContent = switch (initialized, routeEntry.route) {
-    | (false, Some(_) | None) => None
-    | (true, Some(r)) => Some(r->RouteFamily.render(routeEntry.url))
-    | (true, None) => None
-    }
-
-    initialized
-      ? <>
-          {switch renderPending {
-          | Some(renderPending) => renderPending(isPending)
-          | None => React.null
-          }}
-          <React.Suspense
-            fallback={switch renderFallback {
-            | Some(renderFallback) => renderFallback()
-            | None => React.null
-            }}>
-            {switch (renderedContent, renderNotFound) {
-            | (Some(content), _) => content
-            | (None, Some(renderNotFound)) => renderNotFound(routeEntry.url)
-            | (None, None) => React.null
-            }}
-          </React.Suspense>
-        </>
-      : React.null
-  }
-}
-
-let isModifiedEvent = e => {
-  open ReactEvent.Mouse
-  switch (e->metaKey, e->altKey, e->ctrlKey, e->shiftKey) {
-  | (true, _, _, _)
-  | (_, true, _, _) => true
-  | (_, _, true, _) => true
-  | (_, _, _, true) => true
-  | _ => false
-  }
-}
-
-module Link = {
-  @react.component
-  let make = (
-    ~to_,
-    ~title=?,
-    ~id=?,
-    ~className=?,
-    ~classNameDynamic=?,
-    ~target as browserTarget=?,
-    ~tabIndex=?,
-    ~mode=?,
-    ~render=?,
-    ~preloadOnHover=?,
-    ~children,
-    ~onClick=?,
-    (),
-  ) => {
-    let router = use()
-    let url = RescriptReactRouter.useUrl()
-
-    let changeRoute = React.useCallback2(e => {
-      open ReactEvent.Mouse
-      switch (e->isDefaultPrevented, e->button, browserTarget, e->isModifiedEvent) {
-      | (false, 0, None | Some(#self), false) =>
-        e->preventDefault
-        let navigate = () =>
-          switch mode {
-          | None
-          | Some(#push) =>
-            RescriptReactRouter.push(to_)
-          | Some(#replace) => RescriptReactRouter.replace(to_)
-          }
-
-        navigate()
-        ()
-      | _ => ()
-      }
-    }, (to_, router))
-
-    let preload = React.useCallback2(() => router.preload(to_), (to_, router))
-
-    switch render {
-    | Some(render) =>
-      let linkUrl = to_->Url.make
-      render(~preload, ~changeRoute, ~currentUrl=url, ~linkUrl)
-    | None =>
-      <a
-        href=to_
-        target={switch browserTarget {
-        | Some(#self) => "_self"
-        | Some(#blank) => "_blank"
-        | None => ""
-        }}
-        ?title
-        ?id
-        ?tabIndex
-        className={className->Belt.Option.getWithDefault("") ++
-          switch classNameDynamic {
-          | Some(f) => " " ++ f(url, to_->Url.make)
-          | None => ""
-          }}
-        onClick={e => {
-          changeRoute(e)
-          switch onClick {
-          | None => ()
-          | Some(onClick) => onClick()
-          }
-        }}
-        onMouseDown={_ => preload()}
-        onTouchStart={_ => preload()}
-        onMouseEnter={_ =>
-          switch preloadOnHover {
-          | Some(true) => preload()
-          | Some(false) | None => ()
-          }}>
-        children
-      </a>
-    }
-  }
-}

package/src/experimental-router/RescriptRelayRouter.resi

@@ -1,77 +0,0 @@
-module RouteFamily: {
-  type t
-
-  let matchesUrl: (t, RescriptReactRouter.url) => bool
-  let preload: (t, RescriptReactRouter.url) => unit
-  let render: (t, RescriptReactRouter.url) => React.element
-  let make: (
-    ~matchUrl: RescriptReactRouter.url => option<'routeVariables>,
-    ~prepare: 'routeVariables => 'prepared,
-    ~render: 'prepared => React.element,
-  ) => t
-}
-
-type routerContext
-
-module Provider: {
-  let makeProps: (
-    ~value: routerContext,
-    ~children: React.element,
-    unit,
-  ) => {"value": routerContext, "children": React.element}
-
-  let make: React.component<{"value": routerContext, "children": React.element}>
-}
-
-exception No_router_in_context
-
-type router = {
-  push: string => unit,
-  pushShallow: string => unit,
-  replace: string => unit,
-  replaceShallow: string => unit,
-  preload: string => unit,
-}
-
-let useRouter: unit => router
-
-let make: array<RouteFamily.t> => routerContext
-
-module RouteRenderer: {
-  @react.component
-  let make: (
-    ~renderPending: bool => React.element=?,
-    ~renderFallback: unit => React.element=?,
-    ~renderNotFound: RescriptReactRouter.url => React.element=?,
-    unit,
-  ) => React.element
-}
-
-module Link: {
-  @react.component
-  let make: (
-    ~to_: string,
-    ~title: string=?,
-    ~id: string=?,
-    ~className: string=?,
-    ~classNameDynamic: (RescriptReactRouter.url, RescriptReactRouter.url) => string=?,
-    ~target: [#self | #blank]=?,
-    ~tabIndex: int=?,
-    ~mode: [#push | #replace]=?,
-    ~render: (
-      ~preload: unit => unit,
-      ~changeRoute: ReactEvent.Mouse.t => unit,
-      ~currentUrl: RescriptReactRouter.url,
-      ~linkUrl: RescriptReactRouter.url,
-    ) => React.element=?,
-    ~preloadOnHover: bool=?,
-    ~children: React.element,
-    ~onClick: unit => unit=?,
-    unit,
-  ) => React.element
-}
-
-module NavigationUtils: {
-  let replaceShallow: string => unit
-  let pushShallow: string => unit
-}