@kubun/with-relay 0.17.0 → 0.17.1

package/lib/index.d.ts

@@ -1,10 +1,25 @@
 import type { GraphQLSource } from '@kubun/protocol';
-import { Environment, type INetwork, Store } from 'relay-runtime';
+import { type CacheConfig, Environment, type INetwork, Store } from 'relay-runtime';
 export type NetworkParams = {
     source: GraphQLSource;
 };
 export type EnvironmentParams = NetworkParams & {
     store?: Store;
 };
+/**
+ * The connector operation-envelope ids a mutation carries (see
+ * `GraphQLOperationParams.operationID`): required on a connector action
+ * mutation, the same pair on every retry of one user intent, a new pair for a
+ * new intent.
+ */
+export type OperationEnvelope = {
+    operationID: string;
+    deterministicEventID: string;
+};
+/**
+ * The Relay `cacheConfig` that carries an operation envelope to the network
+ * layer, for a mutation commit (`commitMutation` / `useMutation`).
+ */
+export declare function operationEnvelopeCacheConfig(envelope: OperationEnvelope): CacheConfig;
 export declare function createNetwork(params: NetworkParams): INetwork;
 export declare function createEnvironment(params: EnvironmentParams): Environment;

package/lib/index.js

@@ -1,7 +1,33 @@
 import { Environment, Network, Observable, RecordSource, Store } from 'relay-runtime';
+/**
+ * The Relay `cacheConfig` that carries an operation envelope to the network
+ * layer, for a mutation commit (`commitMutation` / `useMutation`).
+ */ export function operationEnvelopeCacheConfig(envelope) {
+    return {
+        metadata: {
+            operationID: envelope.operationID,
+            deterministicEventID: envelope.deterministicEventID
+        }
+    };
+}
+// The operation envelope a mutation's `cacheConfig` carries, each id only
+// when it is a string.
+function operationEnvelopeFrom(cacheConfig) {
+    const metadata = cacheConfig?.metadata;
+    const operationID = metadata?.operationID;
+    const deterministicEventID = metadata?.deterministicEventID;
+    return {
+        ...typeof operationID === 'string' ? {
+            operationID
+        } : {},
+        ...typeof deterministicEventID === 'string' ? {
+            deterministicEventID
+        } : {}
+    };
+}
 export function createNetwork(params) {
     const { source } = params;
-    return Network.create((request, variables)=>{
+    return Network.create((request, variables, cacheConfig)=>{
         const text = request.text;
         if (text == null) {
             return Observable.create((sink)=>{
@@ -12,7 +38,10 @@ export function createNetwork(params) {
             text,
             variables: variables
         };
-        const promise = request.operationKind === 'mutation' ? source.mutate(params) : source.query(params);
+        const promise = request.operationKind === 'mutation' ? source.mutate({
+            ...params,
+            ...operationEnvelopeFrom(cacheConfig)
+        }) : source.query(params);
         return Observable.from(promise);
     }, (request, variables)=>{
         const text = request.text;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kubun/with-relay",
-  "version": "0.17.0",
+  "version": "0.17.1",
   "keywords": [],
   "license": "see LICENSE.md",
   "sideEffects": false,
@@ -19,14 +19,14 @@
   },
   "devDependencies": {
     "@enkaku/transport": "^0.21.0",
-    "@kubun/client": "^0.17.0",
-    "@kubun/engine": "^0.17.0",
+    "@kubun/client": "^0.17.2",
+    "@kubun/engine": "^0.17.2",
     "@kubun/models": "^0.17.0",
-    "@kubun/plugin-service-server": "^0.17.0",
-    "@kubun/protocol": "^0.17.0",
-    "@kubun/service-graph-api": "^0.17.0",
+    "@kubun/plugin-service-server": "^0.17.1",
+    "@kubun/protocol": "^0.17.1",
+    "@kubun/service-graph-api": "^0.17.2",
     "@kubun/test-utils": "^0.0.0",
-    "graphql": "^16.14.2"
+    "graphql": "^17.0.2"
   },
   "publishConfig": {
     "access": "public"