rescript-relay 3.0.0-rc.7 → 3.0.0-rc.8

package/CHANGELOG.md

@@ -6,6 +6,12 @@
 
 # Unreleased
 
+# 3.0.0-rc.8
+
+- Initial implementation of more advanced Relay resolvers. More to come. https://github.com/zth/rescript-relay/pull/515
+- BREAKING: Relay resolvers using fragments should now be exported with a function name that matches the field name for the resolver, and not `default` like before.
+- BREAKING: Client extension enums are now (correctly) not emitted with a `FutureAddedValue` case.
+
 # 3.0.0-rc.7
 
 - Fix for not deleting removed artifacts.

package/package.json

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

package/src/RescriptRelay.bs.js

@@ -8,6 +8,10 @@ var Caml_option = require("rescript/lib/js/caml_option.js");
 var ReactRelay = require("react-relay");
 var RelayRuntime = require("relay-runtime");
 var Caml_exceptions = require("rescript/lib/js/caml_exceptions.js");
+var LiveResolverStore = require("relay-runtime/lib/store/experimental-live-resolvers/LiveResolverStore");
+var LiveResolverStore$1 = require("relay-runtime/lib/store/experimental-live-resolvers/LiveResolverStore").default;
+
+var SuspenseSentinel = {};
 
 function convertObj(prim0, prim1, prim2, prim3) {
   return Utils.traverser(prim0, prim1, prim2, prim3);
@@ -124,8 +128,24 @@ function make(source, gcReleaseBufferSize, queryCacheExpirationTime) {
             });
 }
 
+function makeLiveStore(source, gcReleaseBufferSize, queryCacheExpirationTime) {
+  return new LiveResolverStore$1(source, {
+              gcReleaseBufferSize: gcReleaseBufferSize,
+              queryCacheExpirationTime: queryCacheExpirationTime
+            });
+}
+
+function _makeLiveStoreCjs(source, gcReleaseBufferSize, queryCacheExpirationTime) {
+  return new LiveResolverStore(source, {
+              gcReleaseBufferSize: gcReleaseBufferSize,
+              queryCacheExpirationTime: queryCacheExpirationTime
+            });
+}
+
 var Store = {
-  make: make
+  make: make,
+  makeLiveStore: makeLiveStore,
+  _makeLiveStoreCjs: _makeLiveStoreCjs
 };
 
 var RelayFieldLogger = {};
@@ -218,6 +238,7 @@ function MakeLoadQuery(C) {
 
 var Mutation_failed = /* @__PURE__ */Caml_exceptions.create("RescriptRelay.Mutation_failed");
 
+exports.SuspenseSentinel = SuspenseSentinel;
 exports.convertObj = convertObj;
 exports.RecordProxy = RecordProxy;
 exports.RecordSourceSelectorProxy = RecordSourceSelectorProxy;

package/src/RescriptRelay.res

@@ -12,15 +12,33 @@ type fragmentRefs<'fragments>
 type updatableFragmentRefs<'fragments>
 
 type dataId
+type dataIdObject = {id: dataId}
 type recordSourceRecords = Js.Json.t
 type uploadables
 
+module SuspenseSentinel = {
+  type t
+
+  @module("relay-runtime") external suspend: t => 'any = "suspenseSentinel"
+}
+
+type liveStateCallback = unit => unit
+type liveStateUnsubscribeCallback = unit => unit
+
+type liveState<'value> = {
+  read: SuspenseSentinel.t => 'value,
+  subscribe: liveStateCallback => liveStateUnsubscribeCallback,
+}
+
 external dataIdToString: dataId => string = "%identity"
 external makeDataId: string => dataId = "%identity"
 external makeArguments: {..} => arguments = "%identity"
 external makeUploadables: Js.Dict.t<'file> => uploadables = "%identity"
 external unwrapUploadables: uploadables => Js.Dict.t<'file> = "%identity"
 
+@module("relay-runtime/experimental")
+external resolverDataInjector: ('a, 'b, 'c, 'd) => 'return = "resolverDataInjector"
+
 @module("relay-runtime")
 external generateClientID: (~dataId: dataId, ~storageKey: string, ~index: int=?) => dataId =
   "generateClientID"
@@ -267,6 +285,9 @@ module RecordProxy = {
 module RecordSourceSelectorProxy = {
   type t
 
+  @send
+  external batchLiveStateUpdates: (t, unit => unit) => unit = "batchLiveStateUpdates"
+
   @send
   external create: (t, ~dataId: dataId, ~typeName: string) => RecordProxy.t = "create"
 
@@ -535,6 +556,13 @@ module Store = {
     queryCacheExpirationTime: option<int>,
   }
 
+  @module @new
+  external makeLiveStoreCjs: (RecordSource.t, storeConfig) => t =
+    "relay-runtime/lib/store/experimental-live-resolvers/LiveResolverStore"
+
+  @module("relay-runtime/lib/store/experimental-live-resolvers/LiveResolverStore") @new
+  external makeLiveStore: (RecordSource.t, storeConfig) => t = "default"
+
   @module("relay-runtime") @new
   external make: (RecordSource.t, storeConfig) => t = "Store"
 
@@ -547,6 +575,24 @@ module Store = {
       },
     )
 
+  let makeLiveStore = (~source, ~gcReleaseBufferSize=?, ~queryCacheExpirationTime=?) =>
+    makeLiveStore(
+      source,
+      {
+        gcReleaseBufferSize,
+        queryCacheExpirationTime,
+      },
+    )
+
+  let _makeLiveStoreCjs = (~source, ~gcReleaseBufferSize=?, ~queryCacheExpirationTime=?) =>
+    makeLiveStoreCjs(
+      source,
+      {
+        gcReleaseBufferSize,
+        queryCacheExpirationTime,
+      },
+    )
+
   @send external getSource: t => RecordSource.t = "getSource"
   @send external publish: (t, RecordSource.t) => unit = "publish"
   @send external holdGC: t => unit = "holdGC"

package/src/RescriptRelay.resi

@@ -36,6 +36,25 @@ type updatableFragmentRefs<'fragments>
 /**The type of the id Relay uses to identify records in its store.*/
 type dataId
 
+type dataIdObject = {id: dataId}
+
+module SuspenseSentinel: {
+  type t
+
+  @module("relay-runtime") external suspend: t => 'any = "suspenseSentinel"
+}
+
+type liveStateCallback = unit => unit
+type liveStateUnsubscribeCallback = unit => unit
+
+type liveState<'value> = {
+  read: SuspenseSentinel.t => 'value,
+  subscribe: liveStateCallback => liveStateUnsubscribeCallback,
+}
+
+@module("relay-runtime/experimental")
+external resolverDataInjector: ('a, 'b, 'c, 'd) => 'return = "resolverDataInjector"
+
 /**Turns a `dataId` into a `string`.*/
 external dataIdToString: dataId => string = "%identity"
 
@@ -346,6 +365,9 @@ module RecordSourceSelectorProxy: {
   /**Type type representing a `RecordSourceSelectorProxy`.*/
   type t
 
+  @send
+  external batchLiveStateUpdates: (t, unit => unit) => unit = "batchLiveStateUpdates"
+
   /**Creates a new `RecordProxy`.*/
   @send
   external create: (t, ~dataId: dataId, ~typeName: string) => RecordProxy.t = "create"
@@ -662,6 +684,21 @@ module Store: {
   ) => /* `queryCacheExpirationTime` sets a TTL (time to live) for all queries. If that time passes, the data is considered stale and is evicted from the store. Default is no TTL. */
   t
 
+  /**Creates a new `LiveStore`.*/
+  let makeLiveStore: (
+    ~source: RecordSource.t,
+    ~gcReleaseBufferSize: /* `gcReleaseBufferSize` controls how many queries are allowed to be cached by default. Increase this to increase the size of the cache. */
+    int=?,
+    ~queryCacheExpirationTime: int=?,
+  ) => /* `queryCacheExpirationTime` sets a TTL (time to live) for all queries. If that time passes, the data is considered stale and is evicted from the store. Default is no TTL. */
+  t
+
+  let _makeLiveStoreCjs: (
+    ~source: RecordSource.t,
+    ~gcReleaseBufferSize: int=?,
+    ~queryCacheExpirationTime: int=?,
+  ) => t
+
   /**Gets the `RecordSource` for this `Store`.*/
   @send
   external getSource: t => RecordSource.t = "getSource"