rescript-relay 2.0.0 → 3.0.0-alpha.1

package/CHANGELOG.md

@@ -1,5 +1,38 @@
 # master
 
+# **Version 3**
+
+# 3.0.0-alpha.1
+
+Below is a series of releases for version 3 of RescriptRelay, which contain a large amount of breaking changes. The releases are cut up with a few breaking changes for each, to make them slightly less hard to migrate to. You're encouraged to start from the bottom and work your way up through the versions.
+
+Dedicated tooling for migrating is coming, as well as docs.
+
+# 0.0.0-version-3-8b552902
+
+## Breaking changes
+
+- Unions are now represented as regular variants. Commit showing how this is migrated to in the tests: https://github.com/zth/rescript-relay/commit/3b5df51b80a0e1222b376fcfc730bb5dd0de099a
+
+# 0.0.0-version-3-3504d777
+
+## Breaking changes
+
+- All trailing unit arguments are removed. Commit showing how this is migrated to in the tests: https://github.com/zth/rescript-relay/commit/2a16791268afb29d106362d0cf17915f69d5b4ff
+
+# 0.0.0-version-3-aeebeaab
+
+## Breaking changes
+
+- Object maker functions are removed, and leverage optional fields for all variables/input objects. Also a large change, tooling upcoming. Commit showing how this is migrated to in the tests: https://github.com/zth/rescript-relay/commit/fd6b07a1b26620c91e5de61f930235c35517da6a
+
+# 0.0.0-version-3-89bccc22
+
+## Breaking changes
+
+- Remove "top level node field" transform. Previously, a single selection on the top level `node` field (like `node(id: $id) { ... on User { id, name }}`) would skip the union mechanism and automatically collapse the generated types to `option<user>`. This has now changed and the top level node field behaves just like any union. Commit showing how this is migrated to in the tests: https://github.com/zth/rescript-relay/commit/9ce73196794dbc6eba435414fcff708e7c53df78
+- Enums are now (unboxed) regular variants rather than polyvariants. This is a large change, but we're going to provide some tools for easing the transition. Commit showing how this is migrated to in the tests: https://github.com/zth/rescript-relay/commit/9da425a3e65ce3e9403168af421522028424a4f0
+
 # 2.0.0
 
 RescriptRelay `2.0.0` is here! This isn't a large release really, but it's a major release just because it relies on functionality from ReScript `v11`. Meaning the lower bound of the required ReScript version is `>=11.0.0-beta.2`.

package/package.json

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

package/src/ReactExperimental.res

@@ -4,12 +4,12 @@ external useDeferredValue: 'value => 'value = "useDeferredValue"
 @module("react")
 external useTransitionWithOptions: unit => (
   bool,
-  (. unit => unit, option<{"name": option<string>}>) => unit,
+  (unit => unit, option<{"name": option<string>}>) => unit,
 ) = "useTransition"
 
 let useTransition = () => {
   let (isPending, startTransition) = useTransitionWithOptions()
-  (isPending, React.useMemo1(() => cb => startTransition(. cb, None), [startTransition]))
+  (isPending, React.useMemo1(() => cb => startTransition(cb, None), [startTransition]))
 }
 
 module SuspenseList = {

package/src/ReactExperimental.resi

@@ -4,7 +4,7 @@ external useDeferredValue: 'value => 'value = "useDeferredValue"
 @module("react")
 external useTransitionWithOptions: unit => (
   bool,
-  (. unit => unit, option<{"name": option<string>}>) => unit,
+  (unit => unit, option<{"name": option<string>}>) => unit,
 ) = "useTransition"
 
 let useTransition: unit => (bool, (unit => unit) => unit)

package/src/RescriptRelay.bs.js

@@ -27,7 +27,7 @@ function optArrayOfNullableToOptArrayOfOpt(x) {
   
 }
 
-function getLinkedRecords(t, name, $$arguments, param) {
+function getLinkedRecords(t, name, $$arguments) {
   return optArrayOfNullableToOptArrayOfOpt(Caml_option.nullable_to_opt(t.getLinkedRecords(name, $$arguments)));
 }
 
@@ -118,7 +118,7 @@ var Network = {};
 
 var RecordSource = {};
 
-function make(source, gcReleaseBufferSize, queryCacheExpirationTime, param) {
+function make(source, gcReleaseBufferSize, queryCacheExpirationTime) {
   return new RelayRuntime.Store(source, {
               gcReleaseBufferSize: gcReleaseBufferSize,
               queryCacheExpirationTime: queryCacheExpirationTime
@@ -135,26 +135,16 @@ function toJs(f) {
   };
 }
 
-function make$1(network, store, getDataID, treatMissingFieldsAsNull, missingFieldHandlers, requiredFieldLogger, isServer, param) {
-  var tmp = {
-    network: network,
-    store: store,
-    missingFieldHandlers: missingFieldHandlers !== undefined ? Belt_Array.concat(missingFieldHandlers, [nodeInterfaceMissingFieldHandler]) : [nodeInterfaceMissingFieldHandler]
-  };
-  if (getDataID !== undefined) {
-    tmp.getDataID = Caml_option.valFromOption(getDataID);
-  }
-  if (treatMissingFieldsAsNull !== undefined) {
-    tmp.treatMissingFieldsAsNull = Caml_option.valFromOption(treatMissingFieldsAsNull);
-  }
-  var tmp$1 = Belt_Option.map(requiredFieldLogger, toJs);
-  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);
+function make$1(network, store, getDataID, treatMissingFieldsAsNull, missingFieldHandlers, requiredFieldLogger, isServer) {
+  return new RelayRuntime.Environment({
+              network: network,
+              store: store,
+              getDataID: getDataID,
+              treatMissingFieldsAsNull: treatMissingFieldsAsNull,
+              missingFieldHandlers: missingFieldHandlers !== undefined ? Belt_Array.concat(missingFieldHandlers, [nodeInterfaceMissingFieldHandler]) : [nodeInterfaceMissingFieldHandler],
+              requiredFieldLogger: Belt_Option.map(requiredFieldLogger, toJs),
+              isServer: isServer
+            });
 }
 
 var Environment = {
@@ -193,7 +183,7 @@ function useEnvironmentFromContext() {
 }
 
 function MakeLoadQuery(C) {
-  var load = function (environment, variables, fetchPolicy, fetchKey, networkCacheConfig, param) {
+  var load = function (environment, variables, fetchPolicy, fetchKey, networkCacheConfig) {
     return ReactRelay.loadQuery(environment, C.query, C.convertVariables(variables), {
                 fetchKey: fetchKey,
                 fetchPolicy: fetchPolicy,

package/src/RescriptRelay.res

@@ -21,7 +21,7 @@ external makeUploadables: Js.Dict.t<'file> => uploadables = "%identity"
 external unwrapUploadables: uploadables => Js.Dict.t<'file> = "%identity"
 
 @module("relay-runtime")
-external generateClientID: (~dataId: dataId, ~storageKey: string, ~index: int=?, unit) => dataId =
+external generateClientID: (~dataId: dataId, ~storageKey: string, ~index: int=?) => dataId =
   "generateClientID"
 
 @module("relay-runtime")
@@ -93,14 +93,14 @@ module RecordProxy = {
   @send external getDataId: t => dataId = "getDataID"
 
   @send @return(nullable)
-  external getLinkedRecord: (t, ~name: string, ~arguments: arguments=?, unit) => option<t> =
+  external getLinkedRecord: (t, ~name: string, ~arguments: arguments=?) => option<t> =
     "getLinkedRecord"
 
   @send @return(nullable)
   external getLinkedRecords: (t, string, option<arguments>) => option<array<Js.Nullable.t<t>>> =
     "getLinkedRecords"
 
-  let getLinkedRecords = (t, ~name, ~arguments=?, ()): option<array<option<t>>> =>
+  let getLinkedRecords = (t, ~name, ~arguments=?): option<array<option<t>>> =>
     getLinkedRecords(t, name, arguments)->optArrayOfNullableToOptArrayOfOpt
 
   @send
@@ -109,13 +109,12 @@ module RecordProxy = {
     ~name: string,
     ~typeName: string,
     ~arguments: arguments=?,
-    unit,
   ) => t = "getOrCreateLinkedRecord"
 
   @send external getType: t => string = "getType"
 
   @send @return(nullable)
-  external getValueString: (t, ~name: string, ~arguments: arguments=?, unit) => option<string> =
+  external getValueString: (t, ~name: string, ~arguments: arguments=?) => option<string> =
     "getValue"
 
   @send @return(nullable)
@@ -123,47 +122,40 @@ module RecordProxy = {
     t,
     ~name: string,
     ~arguments: arguments=?,
-    unit,
   ) => option<array<option<string>>> = "getValue"
 
   @send @return(nullable)
-  external getValueInt: (t, ~name: string, ~arguments: arguments=?, unit) => option<int> =
-    "getValue"
+  external getValueInt: (t, ~name: string, ~arguments: arguments=?) => option<int> = "getValue"
 
   @send @return(nullable)
   external getValueIntArray: (
     t,
     ~name: string,
     ~arguments: arguments=?,
-    unit,
   ) => option<array<option<int>>> = "getValue"
 
   @send @return(nullable)
-  external getValueFloat: (t, ~name: string, ~arguments: arguments=?, unit) => option<float> =
-    "getValue"
+  external getValueFloat: (t, ~name: string, ~arguments: arguments=?) => option<float> = "getValue"
 
   @send @return(nullable)
   external getValueFloatArray: (
     t,
     ~name: string,
     ~arguments: arguments=?,
-    unit,
   ) => option<array<option<float>>> = "getValue"
 
   @send @return(nullable)
-  external getValueBool: (t, ~name: string, ~arguments: arguments=?, unit) => option<bool> =
-    "getValue"
+  external getValueBool: (t, ~name: string, ~arguments: arguments=?) => option<bool> = "getValue"
 
   @send @return(nullable)
   external getValueBoolArray: (
     t,
     ~name: string,
     ~arguments: arguments=?,
-    unit,
   ) => option<array<option<bool>>> = "getValue"
 
   @send
-  external setLinkedRecord: (t, ~record: t, ~name: string, ~arguments: arguments=?, unit) => t =
+  external setLinkedRecord: (t, ~record: t, ~name: string, ~arguments: arguments=?) => t =
     "setLinkedRecord"
 
   // `setLinkedRecord` can't be used for "deleting" linked record fields.
@@ -176,7 +168,6 @@ module RecordProxy = {
     @as(json`undefined`) _,
     ~name: string,
     ~arguments: arguments=?,
-    unit,
   ) => t = "setValue"
 
   @send
@@ -185,7 +176,6 @@ module RecordProxy = {
     @as(json`null`) _,
     ~name: string,
     ~arguments: arguments=?,
-    unit,
   ) => t = "setValue"
 
   @send
@@ -194,7 +184,6 @@ module RecordProxy = {
     ~records: array<option<t>>,
     ~name: string,
     ~arguments: arguments=?,
-    unit,
   ) => t = "setLinkedRecords"
 
   // `setLinkedRecords` can't be used for "deleting" linked records.
@@ -207,7 +196,6 @@ module RecordProxy = {
     @as(json`undefined`) _,
     ~name: string,
     ~arguments: arguments=?,
-    unit,
   ) => t = "setValue"
 
   @send
@@ -216,7 +204,6 @@ module RecordProxy = {
     @as(json`null`) _,
     ~name: string,
     ~arguments: arguments=?,
-    unit,
   ) => t = "setValue"
 
   @send
@@ -225,20 +212,14 @@ module RecordProxy = {
     @as(json`undefined`) _,
     ~name: string,
     ~arguments: arguments=?,
-    unit,
   ) => t = "setValue"
 
   @send
-  external setValueToNull: (
-    t,
-    @as(json`null`) _,
-    ~name: string,
-    ~arguments: arguments=?,
-    unit,
-  ) => t = "setValue"
+  external setValueToNull: (t, @as(json`null`) _, ~name: string, ~arguments: arguments=?) => t =
+    "setValue"
 
   @send
-  external setValueString: (t, ~value: string, ~name: string, ~arguments: arguments=?, unit) => t =
+  external setValueString: (t, ~value: string, ~name: string, ~arguments: arguments=?) => t =
     "setValue"
 
   @send
@@ -247,24 +228,17 @@ module RecordProxy = {
     ~value: array<string>,
     ~name: string,
     ~arguments: arguments=?,
-    unit,
   ) => t = "setValue"
 
   @send
-  external setValueInt: (t, ~value: int, ~name: string, ~arguments: arguments=?, unit) => t =
-    "setValue"
+  external setValueInt: (t, ~value: int, ~name: string, ~arguments: arguments=?) => t = "setValue"
 
   @send
-  external setValueIntArray: (
-    t,
-    ~value: array<int>,
-    ~name: string,
-    ~arguments: arguments=?,
-    unit,
-  ) => t = "setValue"
+  external setValueIntArray: (t, ~value: array<int>, ~name: string, ~arguments: arguments=?) => t =
+    "setValue"
 
   @send
-  external setValueFloat: (t, ~value: float, ~name: string, ~arguments: arguments=?, unit) => t =
+  external setValueFloat: (t, ~value: float, ~name: string, ~arguments: arguments=?) => t =
     "setValue"
 
   @send
@@ -273,12 +247,10 @@ module RecordProxy = {
     ~value: array<float>,
     ~name: string,
     ~arguments: arguments=?,
-    unit,
   ) => t = "setValue"
 
   @send
-  external setValueBool: (t, ~value: bool, ~name: string, ~arguments: arguments=?, unit) => t =
-    "setValue"
+  external setValueBool: (t, ~value: bool, ~name: string, ~arguments: arguments=?) => t = "setValue"
 
   @send
   external setValueBoolArray: (
@@ -286,7 +258,6 @@ module RecordProxy = {
     ~value: array<bool>,
     ~name: string,
     ~arguments: arguments=?,
-    unit,
   ) => t = "setValue"
 
   @send external invalidateRecord: t => unit = "invalidateRecord"
@@ -423,7 +394,6 @@ module ConnectionHandler = {
     ~record: RecordProxy.t,
     ~key: string,
     ~filters: arguments=?,
-    unit,
   ) => option<RecordProxy.t> = "getConnection"
 
   @module("relay-runtime") @scope("ConnectionHandler")
@@ -439,7 +409,6 @@ module ConnectionHandler = {
     ~connection: RecordProxy.t,
     ~newEdge: RecordProxy.t,
     ~cursor: string=?,
-    unit,
   ) => unit = "insertEdgeBefore"
 
   @module("relay-runtime") @scope("ConnectionHandler")
@@ -447,7 +416,6 @@ module ConnectionHandler = {
     ~connection: RecordProxy.t,
     ~newEdge: RecordProxy.t,
     ~cursor: string=?,
-    unit,
   ) => unit = "insertEdgeAfter"
 
   @module("relay-runtime") @scope("ConnectionHandler")
@@ -497,7 +465,6 @@ module Observable = {
     ~error: Js.Exn.t => unit=?,
     ~complete: unit => unit=?,
     ~unsubscribe: subscription => unit=?,
-    unit,
   ) => observer<'response> = ""
 
   @module("relay-runtime") @scope("Observable")
@@ -541,14 +508,12 @@ module Network = {
   external makePromiseBased: (
     ~fetchFunction: fetchFunctionPromise,
     ~subscriptionFunction: subscribeFn=?,
-    unit,
   ) => t = "create"
 
   @module("relay-runtime") @scope("Network")
   external makeObservableBased: (
     ~observableFunction: fetchFunctionObservable,
     ~subscriptionFunction: subscribeFn=?,
-    unit,
   ) => t = "create"
 }
 
@@ -556,7 +521,7 @@ module RecordSource = {
   type t
 
   @module("relay-runtime") @new
-  external make: (~records: recordSourceRecords=?, unit) => t = "RecordSource"
+  external make: (~records: recordSourceRecords=?) => t = "RecordSource"
 
   @send external toJSON: t => recordSourceRecords = "toJSON"
 }
@@ -572,7 +537,7 @@ module Store = {
   @module("relay-runtime") @new
   external make: (RecordSource.t, storeConfig) => t = "Store"
 
-  let make = (~source, ~gcReleaseBufferSize=?, ~queryCacheExpirationTime=?, ()) =>
+  let make = (~source, ~gcReleaseBufferSize=?, ~queryCacheExpirationTime=?) =>
     make(
       source,
       {
@@ -602,19 +567,14 @@ module RequiredFieldLogger = {
 module Environment = {
   type t
 
-  @deriving(abstract)
   type environmentConfig<'a> = {
     network: Network.t,
     store: Store.t,
-    @optional
-    getDataID: (~nodeObj: 'a, ~typeName: string) => string,
-    @optional
-    treatMissingFieldsAsNull: bool,
+    getDataID?: (~nodeObj: 'a, ~typeName: string) => string,
+    treatMissingFieldsAsNull?: bool,
     missingFieldHandlers: array<MissingFieldHandler.t>,
-    @optional
-    requiredFieldLogger: RequiredFieldLogger.js,
-    @optional
-    isServer: bool,
+    requiredFieldLogger?: RequiredFieldLogger.js,
+    isServer?: bool,
   }
 
   @module("relay-runtime") @new
@@ -628,23 +588,19 @@ module Environment = {
     ~missingFieldHandlers=?,
     ~requiredFieldLogger=?,
     ~isServer=?,
-    (),
   ) =>
-    make(
-      environmentConfig(
-        ~network,
-        ~store,
-        ~getDataID?,
-        ~treatMissingFieldsAsNull?,
-        ~missingFieldHandlers=switch missingFieldHandlers {
-        | Some(handlers) => handlers->Belt.Array.concat([nodeInterfaceMissingFieldHandler])
-        | None => [nodeInterfaceMissingFieldHandler]
-        },
-        ~requiredFieldLogger=?requiredFieldLogger->Belt.Option.map(RequiredFieldLogger.toJs),
-        ~isServer?,
-        (),
-      ),
-    )
+    make({
+      network,
+      store,
+      ?getDataID,
+      ?treatMissingFieldsAsNull,
+      missingFieldHandlers: switch missingFieldHandlers {
+      | Some(handlers) => handlers->Belt.Array.concat([nodeInterfaceMissingFieldHandler])
+      | None => [nodeInterfaceMissingFieldHandler]
+      },
+      requiredFieldLogger: ?requiredFieldLogger->Belt.Option.map(RequiredFieldLogger.toJs),
+      ?isServer,
+    })
 
   @send external getStore: t => Store.t = "getStore"
   @send
@@ -721,14 +677,12 @@ module MakeLoadQuery = (C: MakeLoadQueryConfig) => {
     ~fetchPolicy: fetchPolicy=?,
     ~fetchKey: string=?,
     ~networkCacheConfig: cacheConfig=?,
-    unit,
   ) => C.loadedQueryRef = (
     ~environment,
     ~variables,
     ~fetchPolicy=?,
     ~fetchKey=?,
     ~networkCacheConfig=?,
-    (),
   ) =>
     loadQuery(
       environment,
@@ -755,7 +709,7 @@ module MakeLoadQuery = (C: MakeLoadQueryConfig) => {
       | None => resolve(Error())
       | Some(o) =>
         open Observable
-        let _: subscription = o->subscribe(makeObserver(~complete=() => resolve(Ok()), ()))
+        let _: subscription = o->subscribe(makeObserver(~complete=() => resolve(Ok())))
       }
     })
   }