rescript-relay 1.1.1 → 2.0.0-alpha.0

package/CHANGELOG.md

@@ -1,5 +1,35 @@
 # master
 
+# 2.0.0-alpha.0
+
+First alpha of the `2.x` series of releases. `2.x` focuses on compat with ReScript `v11`, including uncurried mode.
+
+## Upgrade versions
+
+- `rescript` to `>=11.0.0-beta.0`
+- `@rescript/react` to `>=0.12.0-alpha.2`
+
+## Improvements
+
+- Leverage variant's new `string` representation + `@as()` to get rid of `mapFetchPolicy`. This was internal so it should not affect you as an end user.
+
+# 1.2.0
+
+This release mainly makes preparations under the hood for the upcoming `2.0` (ReScript v11 + uncurried mode support) and `3.0` (lots of changes, full uncurried mode only).
+
+## Breaking changes
+
+- A trailing unit `()` arg is no longer needed in `Query.usePreloaded()`. What was previously `Query.usePreloaded(~queryRef, ())` is now just `Query.usePreloaded(~queryRef)`.
+
+## Improvements
+
+- Add `@live` annotations to generated JSXv4 dynamic import compat modules, so they don't show up in dead code analysis (which they shouldn't).
+- Preparations under the hood for ReScript v11 + uncurried mode.
+
+# 1.1.1
+
+- Fix M1 binary to include new JSXv4 dynamic import compat changes.
+
 # 1.1.0
 
 Notable changes:

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "rescript-relay",
-  "version": "1.1.1",
+  "version": "2.0.0-alpha.0",
   "main": "src/RescriptRelay.res",
   "license": "MIT",
   "author": "Gabriel Nordeborn",
@@ -39,11 +39,10 @@
     "test:ci": "jest --ci --runInBand"
   },
   "devDependencies": {
-    "rescript": "^10.1.3",
-    "@rescript/react": "0.11.0",
+    "@glennsl/rescript-fetch": "^0.2.0",
+    "@rescript/react": "0.12.0-alpha.2",
     "@testing-library/jest-dom": "^5.16.3",
     "@testing-library/react": "^13.0.0-alpha.6",
-    "bs-fetch": "^0.5.0",
     "graphql-query-test-mock": "^0.12.1",
     "jest": "^27.2.4",
     "nock": "^11.7.0",
@@ -51,13 +50,14 @@
     "react": "18.2.0",
     "react-dom": "18.2.0",
     "react-relay": "15.0.0",
-    "relay-runtime": "15.0.0"
+    "relay-runtime": "15.0.0",
+    "rescript": "^11.0.0-beta.2"
   },
   "peerDependencies": {
-    "@rescript/react": "*",
+    "@rescript/react": "^0.12.0-alpha.2 || next",
     "react-relay": ">=15.0.0",
     "relay-runtime": "*",
-    "rescript": ">=10.1.0"
+    "rescript": "^11.0.0-alpha.0 || next"
   },
   "dependencies": {
     "detect-libc": "^2.0.1"

package/postinstall.js

@@ -152,6 +152,10 @@ function removeInitialBinaries() {
     recursive: true,
     force: true,
   });
+  fs.rmSync(path.join(__dirname, "relay-compiler-win-x64"), {
+    recursive: true,
+    force: true,
+  });
 }
 
 switch (platform) {

package/src/ReactExperimental.bs.js

@@ -3,13 +3,15 @@
 
 var React = require("react");
 
-function useTransition(param) {
+function useTransition() {
   var match = React.useTransition();
   var startTransition = match[1];
   return [
           match[0],
-          React.useCallback((function (cb) {
-                  startTransition(cb, undefined);
+          React.useMemo((function () {
+                  return function (cb) {
+                    startTransition(cb, undefined);
+                  };
                 }), [startTransition])
         ];
 }

package/src/ReactExperimental.res

@@ -9,7 +9,7 @@ external useTransitionWithOptions: unit => (
 
 let useTransition = () => {
   let (isPending, startTransition) = useTransitionWithOptions()
-  (isPending, React.useCallback1(cb => startTransition(. cb, None), [startTransition]))
+  (isPending, React.useMemo1(() => cb => startTransition(. cb, None), [startTransition]))
 }
 
 module SuspenseList = {

package/src/ReactExperimental.resi

@@ -7,7 +7,7 @@ external useTransitionWithOptions: unit => (
   (. unit => unit, option<{"name": option<string>}>) => unit,
 ) = "useTransition"
 
-let useTransition: unit => (bool, React.callback<unit => unit, unit>)
+let useTransition: unit => (bool, (unit => unit) => unit)
 
 module SuspenseList: {
   @module("react") @react.component

package/src/RescriptRelay.bs.js

@@ -1,7 +1,6 @@
 // Generated by ReScript, PLEASE EDIT WITH CARE
 'use strict';
 
-var Curry = require("rescript/lib/js/curry.js");
 var React = require("react");
 var Utils = require("./utils");
 var Belt_Array = require("rescript/lib/js/belt_Array.js");
@@ -50,22 +49,22 @@ function unwrapNormalizationArgument(wrapped) {
   var match = wrapped.kind;
   if (match === "Literal") {
     return {
-            TAG: /* Literal */1,
+            TAG: "Literal",
             _0: wrapped
           };
   } else if (match === "ListValue") {
     return {
-            TAG: /* ListValue */0,
+            TAG: "ListValue",
             _0: wrapped
           };
   } else if (match === "ObjectValue") {
     return {
-            TAG: /* ObjectValue */2,
+            TAG: "ObjectValue",
             _0: wrapped
           };
   } else {
     return {
-            TAG: /* Variable */3,
+            TAG: "Variable",
             _0: wrapped
           };
   }
@@ -130,8 +129,10 @@ var Store = {
   make: make
 };
 
-function toJs(f, arg) {
-  Curry._3(f, arg.kind, arg.owner, arg.fieldPath);
+function toJs(f) {
+  return function (arg) {
+    f(arg.kind, arg.owner, arg.fieldPath);
+  };
 }
 
 function make$1(network, store, getDataID, treatMissingFieldsAsNull, missingFieldHandlers, requiredFieldLogger, isServer, param) {
@@ -180,7 +181,7 @@ var Context = {
 
 var EnvironmentNotFoundInContext = /* @__PURE__ */Caml_exceptions.create("RescriptRelay.EnvironmentNotFoundInContext");
 
-function useEnvironmentFromContext(param) {
+function useEnvironmentFromContext() {
   var context = React.useContext(ReactRelay.ReactRelayContext);
   if (context !== undefined) {
     return Caml_option.valFromOption(context).environment;
@@ -191,39 +192,11 @@ function useEnvironmentFromContext(param) {
       };
 }
 
-function mapFetchPolicy(x) {
-  if (x === undefined) {
-    return ;
-  }
-  switch (x) {
-    case /* StoreOnly */0 :
-        return "store-only";
-    case /* StoreOrNetwork */1 :
-        return "store-or-network";
-    case /* StoreAndNetwork */2 :
-        return "store-and-network";
-    case /* NetworkOnly */3 :
-        return "network-only";
-    
-  }
-}
-
-function mapFetchQueryFetchPolicy(x) {
-  if (x !== undefined) {
-    if (x) {
-      return "store-or-network";
-    } else {
-      return "network-only";
-    }
-  }
-  
-}
-
 function MakeLoadQuery(C) {
   var load = function (environment, variables, fetchPolicy, fetchKey, networkCacheConfig, param) {
-    return ReactRelay.loadQuery(environment, C.query, Curry._1(C.convertVariables, variables), {
+    return ReactRelay.loadQuery(environment, C.query, C.convertVariables(variables), {
                 fetchKey: fetchKey,
-                fetchPolicy: mapFetchPolicy(fetchPolicy),
+                fetchPolicy: fetchPolicy,
                 networkCacheConfig: networkCacheConfig
               });
   };
@@ -235,9 +208,9 @@ function MakeLoadQuery(C) {
                   var o = queryRefToObservable(token);
                   if (o !== undefined) {
                     Caml_option.valFromOption(o).subscribe({
-                          complete: (function (param) {
+                          complete: (function () {
                               resolve({
-                                    TAG: /* Ok */0,
+                                    TAG: "Ok",
                                     _0: undefined
                                   });
                             })
@@ -245,7 +218,7 @@ function MakeLoadQuery(C) {
                     return ;
                   } else {
                     return resolve({
-                                TAG: /* Error */1,
+                                TAG: "Error",
                                 _0: undefined
                               });
                   }
@@ -275,8 +248,6 @@ exports.Store = Store;
 exports.Disposable = Disposable;
 exports.RequiredFieldLogger = RequiredFieldLogger;
 exports.Environment = Environment;
-exports.mapFetchPolicy = mapFetchPolicy;
-exports.mapFetchQueryFetchPolicy = mapFetchQueryFetchPolicy;
 exports.Context = Context;
 exports.EnvironmentNotFoundInContext = EnvironmentNotFoundInContext;
 exports.useEnvironmentFromContext = useEnvironmentFromContext;

package/src/RescriptRelay.res

@@ -482,9 +482,9 @@ module Observable = {
   }
 
   type sink<'response> = {
-    next: (. 'response) => unit,
-    error: (. Js.Exn.t) => unit,
-    complete: (. unit) => unit,
+    next: 'response => unit,
+    error: Js.Exn.t => unit,
+    complete: unit => unit,
     closed: bool,
   }
 
@@ -492,11 +492,11 @@ module Observable = {
 
   @obj
   external makeObserver: (
-    ~start: @uncurry subscription => unit=?,
-    ~next: @uncurry 'response => unit=?,
-    ~error: @uncurry Js.Exn.t => unit=?,
-    ~complete: @uncurry unit => unit=?,
-    ~unsubscribe: @uncurry subscription => unit=?,
+    ~start: subscription => unit=?,
+    ~next: 'response => unit=?,
+    ~error: Js.Exn.t => unit=?,
+    ~complete: unit => unit=?,
+    ~unsubscribe: subscription => unit=?,
     unit,
   ) => observer<'response> = ""
 
@@ -507,6 +507,8 @@ module Observable = {
   external subscribe: (t<'response>, observer<'response>) => subscription = "subscribe"
 
   @send external toPromise: t<'t> => Js.Promise.t<'t> = "toPromise"
+
+  external ignoreSubscription: subscription => unit = "%ignore"
 }
 
 module Network = {
@@ -593,7 +595,7 @@ module RequiredFieldLogger = {
 
   type t = (~kind: kind, ~owner: string, ~fieldPath: string) => unit
 
-  let toJs: t => js = (f, arg) =>
+  let toJs: t => js = f => arg =>
     f(~kind=arg["kind"], ~owner=arg["owner"], ~fieldPath=arg["fieldPath"])
 }
 
@@ -679,39 +681,23 @@ let useEnvironmentFromContext = () => {
 }
 
 type fetchPolicy =
-  | StoreOnly
-  | StoreOrNetwork
-  | StoreAndNetwork
-  | NetworkOnly
-
-let mapFetchPolicy = x =>
-  switch x {
-  | Some(StoreOnly) => Some("store-only")
-  | Some(StoreOrNetwork) => Some("store-or-network")
-  | Some(StoreAndNetwork) => Some("store-and-network")
-  | Some(NetworkOnly) => Some("network-only")
-  | None => None
-  }
+  | @as("store-only") StoreOnly
+  | @as("store-or-network") StoreOrNetwork
+  | @as("store-and-network") StoreAndNetwork
+  | @as("network-only") NetworkOnly
 
 type fetchQueryFetchPolicy =
-  | NetworkOnly
-  | StoreOrNetwork
-
-let mapFetchQueryFetchPolicy = x =>
-  switch x {
-  | Some(StoreOrNetwork) => Some("store-or-network")
-  | Some(NetworkOnly) => Some("network-only")
-  | None => None
-  }
+  | @as("network-only") NetworkOnly
+  | @as("store-or-network") StoreOrNetwork
 
 type fetchQueryOptions = {
-  networkCacheConfig: option<cacheConfig>,
-  fetchPolicy: option<string>,
+  networkCacheConfig?: cacheConfig,
+  fetchPolicy?: fetchPolicy,
 }
 
 type loadQueryConfig = {
   fetchKey: option<string>,
-  fetchPolicy: option<string>,
+  fetchPolicy: option<fetchPolicy>,
   networkCacheConfig: option<cacheConfig>,
 }
 
@@ -750,7 +736,7 @@ module MakeLoadQuery = (C: MakeLoadQueryConfig) => {
       variables->C.convertVariables,
       {
         fetchKey,
-        fetchPolicy: fetchPolicy->mapFetchPolicy,
+        fetchPolicy,
         networkCacheConfig,
       },
     )
@@ -766,10 +752,10 @@ module MakeLoadQuery = (C: MakeLoadQueryConfig) => {
   let queryRefToPromise = token => {
     Js.Promise.make((~resolve, ~reject as _) => {
       switch token->queryRefToObservable {
-      | None => resolve(. Error())
+      | None => resolve(Error())
       | Some(o) =>
         open Observable
-        let _: subscription = o->subscribe(makeObserver(~complete=() => resolve(. Ok()), ()))
+        let _: subscription = o->subscribe(makeObserver(~complete=() => resolve(Ok()), ()))
       }
     })
   }

package/src/RescriptRelay.resi

@@ -132,7 +132,7 @@ module RecordProxy: {
   @send
   external copyFieldsFrom: (t, ~sourceRecord: t) => unit = "copyFieldsFrom"
 
-  /**Gets the \`dataId\` for a particular record.*/
+  /**Gets the `dataId` for a particular record.*/
   @send
   external getDataId: t => dataId = "getDataID"
 
@@ -577,9 +577,9 @@ module Observable: {
 
   /**This sink can be used to give the observable new data.*/
   type sink<'response> = {
-    next: (. 'response) => unit,
-    error: (. Js.Exn.t) => unit,
-    complete: (. unit) => unit,
+    next: 'response => unit,
+    error: Js.Exn.t => unit,
+    complete: unit => unit,
     closed: bool,
   }
 
@@ -595,10 +595,10 @@ module Observable: {
   /**Create an observer.*/
   @obj
   external makeObserver: (
-    ~start: @uncurry subscription => unit=?,
-    ~next: @uncurry 'response => unit=?,
-    ~error: @uncurry Js.Exn.t => unit=?,
-    ~complete: @uncurry unit => unit=?,
+    ~start: subscription => unit=?,
+    ~next: 'response => unit=?,
+    ~error: Js.Exn.t => unit=?,
+    ~complete: unit => unit=?,
     ~unsubscribe: subscription => unit=?,
     unit,
   ) => observer<'response> = ""
@@ -615,6 +615,8 @@ module Observable: {
   /**Turns an `Observable` into a promise. _Beware_ that reading the response in the resulting promise is currently _not safe_ due to some internals of how ReScript Relay works. This will be resolved in the future.*/
   @send
   external toPromise: t<'t> => Js.Promise.t<'t> = "toPromise"
+
+  /**Ignore this subscription.*/ external ignoreSubscription: subscription => unit = "%ignore"
 }
 
 /**Represents the network layer.*/
@@ -769,21 +771,27 @@ You should use the generated `Query.retain` function on your queries instead of
 
 /**fetchPolicy controls how you want Relay to resolve your data.*/
 type fetchPolicy =
-  | StoreOnly /* Resolve only from the store */
-  | StoreOrNetwork /* Resolve from the store if all data is there, otherwise make a network request */
-  | StoreAndNetwork /* Like StoreOrNetwork, but always make a request regardless of if the data was there initially or not */
-  | NetworkOnly /* Always make a request, regardless of what's in the store */
-
-/**Internal, do not use.*/
-let mapFetchPolicy: option<fetchPolicy> => option<string>
+  | /** will only reuse locally cached data, and will never send a network request to fetch the query. In this case, the responsibility of fetching the query falls to the caller, but this policy could also be used to read and operate on data that is entirely local. */
+  @as("store-only")
+  StoreOnly
+  | /** (default) will reuse locally cached data, and will only send a network request if any data for the query is missing or stale. If the query is fully cached, a network request will not be made.*/
+  @as("store-or-network")
+  StoreOrNetwork
+  | /** will reuse locally cached data and will always send a network request, regardless of whether any data was missing or stale in the store. */
+  @as("store-and-network")
+  StoreAndNetwork
+  | /** will not reuse locally cached data, and will always send a network request to fetch the query, ignoring any data that might be locally cached and whether it's missing or stale. */
+  @as("network-only")
+  NetworkOnly
 
 /**The fetch policies allowed for fetching a query outside of React's render (as in `Query.fetch`).*/
 type fetchQueryFetchPolicy =
-  | NetworkOnly
-  | StoreOrNetwork
-
-/**Internal, do not use.*/
-let mapFetchQueryFetchPolicy: option<fetchQueryFetchPolicy> => option<string>
+  | /** will not reuse locally cached data, and will always send a network request to fetch the query, ignoring any data that might be locally cached and whether it's missing or stale. */
+  @as("network-only")
+  NetworkOnly
+  | /** (default) will reuse locally cached data, and will only send a network request if any data for the query is missing or stale. If the query is fully cached, a network request will not be made.*/
+  @as("store-or-network")
+  StoreOrNetwork
 
 /**An error from a mutation.*/
 type mutationError = {message: string}
@@ -803,8 +811,11 @@ module Context: {
   /**The context provider you wrap your app in and pass your `Environment` for Relay to work.*/
   module Provider: {
     /**The React component you wrap your app in and pass your `Environment` for Relay to work.*/
-    @react.component
-    let make: (~environment: Environment.t, ~children: React.element) => React.element
+    type props<'environment, 'children> = {
+      environment: 'environment,
+      children: 'children,
+    }
+    let make: props<Environment.t, React.element> => React.element
   }
 }
 
@@ -830,8 +841,8 @@ external useSubscribeToInvalidationState: (array<dataId>, unit => unit) => Dispo
 
 /**Options valid when fetching a query outside of React's render method (like when using `Query.fetch`).*/
 type fetchQueryOptions = {
-  networkCacheConfig: option<cacheConfig>,
-  fetchPolicy: option<string>,
+  networkCacheConfig?: cacheConfig,
+  fetchPolicy?: fetchPolicy,
 }
 
 module type MakeLoadQueryConfig = {

package/src/RescriptRelayUtils.bs.js

@@ -61,11 +61,11 @@ function createAndAddEdgeToConnections(store, node, connections, edgeName, inser
             return ;
           }
           var edge = RelayRuntime.ConnectionHandler.createEdge(store, connection, node, edgeName);
-          if (insertAt) {
-            RelayRuntime.ConnectionHandler.insertEdgeBefore(connection, edge, undefined);
-          } else {
+          if (insertAt === "Start") {
             RelayRuntime.ConnectionHandler.insertEdgeAfter(connection, edge, undefined);
+            return ;
           }
+          RelayRuntime.ConnectionHandler.insertEdgeBefore(connection, edge, undefined);
         }));
 }
 

package/src/RescriptRelay_Fragment.bs.js

@@ -0,0 +1,115 @@
+// Generated by ReScript, PLEASE EDIT WITH CARE
+'use strict';
+
+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");
+
+function useFragment(node, convertFragment, fRef) {
+  var __x = ReactRelay.useFragment(node, fRef);
+  return RescriptRelay_Internal.internal_useConvertedValue(convertFragment, __x);
+}
+
+function useFragmentOpt(fRef, node, convertFragment) {
+  var data = ReactRelay.useFragment(node, fRef);
+  return React.useMemo((function () {
+                if (!(data == null)) {
+                  return Caml_option.some(convertFragment(data));
+                }
+                
+              }), [(data == null) ? undefined : Caml_option.some(data)]);
+}
+
+function readInlineData(node, convertFragment, fRef) {
+  return convertFragment(ReactRelay.readInlineData(node, fRef));
+}
+
+function internal_makeRefetchableFnOpts(fetchPolicy, onComplete, param) {
+  return {
+          fetchPolicy: fetchPolicy,
+          onComplete: RescriptRelay_Internal.internal_nullableToOptionalExnHandler(onComplete)
+        };
+}
+
+function usePaginationFragment(node, fRef, convertFragment, convertRefetchVariables) {
+  var p = ReactRelay.usePaginationFragment(node, fRef);
+  var data = RescriptRelay_Internal.internal_useConvertedValue(convertFragment, p.data);
+  return {
+          data: data,
+          loadNext: React.useMemo((function () {
+                  return function (count, onComplete, param) {
+                    return p.loadNext(count, {
+                                onComplete: RescriptRelay_Internal.internal_nullableToOptionalExnHandler(onComplete)
+                              });
+                  };
+                }), [p.loadNext]),
+          loadPrevious: React.useMemo((function () {
+                  return function (count, onComplete, param) {
+                    return p.loadPrevious(count, {
+                                onComplete: RescriptRelay_Internal.internal_nullableToOptionalExnHandler(onComplete)
+                              });
+                  };
+                }), [p.loadPrevious]),
+          hasNext: p.hasNext,
+          hasPrevious: p.hasPrevious,
+          isLoadingNext: p.isLoadingNext,
+          isLoadingPrevious: p.isLoadingPrevious,
+          refetch: React.useMemo((function () {
+                  return function (variables, fetchPolicy, onComplete, param) {
+                    return p.refetch(RescriptRelay_Internal.internal_cleanObjectFromUndefinedRaw(convertRefetchVariables(variables)), internal_makeRefetchableFnOpts(fetchPolicy, onComplete, undefined));
+                  };
+                }), [p.refetch])
+        };
+}
+
+function useBlockingPaginationFragment(node, fRef, convertFragment, convertRefetchVariables) {
+  var p = ReactRelay.useBlockingPaginationFragment(node, fRef);
+  var data = RescriptRelay_Internal.internal_useConvertedValue(convertFragment, p.data);
+  return {
+          data: data,
+          loadNext: React.useMemo((function () {
+                  return function (count, onComplete, param) {
+                    return p.loadNext(count, {
+                                onComplete: RescriptRelay_Internal.internal_nullableToOptionalExnHandler(onComplete)
+                              });
+                  };
+                }), [p.loadNext]),
+          loadPrevious: React.useMemo((function () {
+                  return function (count, onComplete, param) {
+                    return p.loadPrevious(count, {
+                                onComplete: RescriptRelay_Internal.internal_nullableToOptionalExnHandler(onComplete)
+                              });
+                  };
+                }), [p.loadPrevious]),
+          hasNext: p.hasNext,
+          hasPrevious: p.hasPrevious,
+          refetch: React.useMemo((function () {
+                  return function (variables, fetchPolicy, onComplete, param) {
+                    return p.refetch(RescriptRelay_Internal.internal_cleanObjectFromUndefinedRaw(convertRefetchVariables(variables)), internal_makeRefetchableFnOpts(fetchPolicy, onComplete, undefined));
+                  };
+                }), [p.refetch])
+        };
+}
+
+function useRefetchableFragment(node, convertFragment, convertRefetchVariables, fRef) {
+  var match = ReactRelay.useRefetchableFragment(node, fRef);
+  var refetchFn = match[1];
+  var data = RescriptRelay_Internal.internal_useConvertedValue(convertFragment, match[0]);
+  return [
+          data,
+          React.useMemo((function () {
+                  return function (variables, fetchPolicy, onComplete, param) {
+                    return refetchFn(RescriptRelay_Internal.internal_removeUndefinedAndConvertNullsRaw(convertRefetchVariables(variables)), internal_makeRefetchableFnOpts(fetchPolicy, onComplete, undefined));
+                  };
+                }), [refetchFn])
+        ];
+}
+
+exports.useFragment = useFragment;
+exports.useFragmentOpt = useFragmentOpt;
+exports.readInlineData = readInlineData;
+exports.usePaginationFragment = usePaginationFragment;
+exports.useBlockingPaginationFragment = useBlockingPaginationFragment;
+exports.useRefetchableFragment = useRefetchableFragment;
+/* react Not a pure module */