@envelop/persisted-operations 2.1.0 → 2.2.0

package/README.md

@@ -103,6 +103,23 @@ const getEnveloped = envelop({
 const proxyFns = getEnveloped({ req });
 ```
 
+## Additional options
+
+### onlyPersisted
+
+You can pass `onlyPersisted: true` when you want to allow persisted operations only in your server. In this case the plugin will issue a GraphQL error when it does not receive an operation Id, or when the received operation id is not available in your store/s.
+
+### onMissingMatch
+
+You might want to perform some actions, such as logging custom events, when your operation Id is not matched in your store/s; in this case you can use the `onMissingMatch` callback function.  
+The function receives the context and operationId as arguments, so you can use it like so:
+
+```js
+onMissingMatch: (context, operationId) => {
+  myEventPool.add(`Missing match for operation "${operationId}" from agent "${context.req.headers['user-agent']}"`);
+};
+```
+
 ## With Relay
 
 If you are using Relay, you can leverage `relay-compiler` feature for hashing and and creating the store for you, during build.

package/index.js

@@ -92,6 +92,8 @@ const usePersistedOperations = (rawOptions) => {
                 setParsedDocument(document);
                 return;
             }
+            if (options.onMissingMatch)
+                options.onMissingMatch(context, operationId);
             if (options.onlyPersisted) {
                 // we want to throw an error only when "onlyPersisted" is true, otherwise we let execution continue normally
                 throw new graphql.GraphQLError(`Unable to match operation with id '${operationId}'`);

package/index.mjs

@@ -88,6 +88,8 @@ const usePersistedOperations = (rawOptions) => {
                 setParsedDocument(document);
                 return;
             }
+            if (options.onMissingMatch)
+                options.onMissingMatch(context, operationId);
             if (options.onlyPersisted) {
                 // we want to throw an error only when "onlyPersisted" is true, otherwise we let execution continue normally
                 throw new GraphQLError(`Unable to match operation with id '${operationId}'`);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@envelop/persisted-operations",
-  "version": "2.1.0",
+  "version": "2.2.0",
   "sideEffects": false,
   "peerDependencies": {
     "graphql": "^14.0.0 || ^15.0.0 || ^16.0.0"

package/plugin.d.ts

@@ -15,6 +15,10 @@ export declare type UsePersistedOperationsOptions<ContextType = DefaultContext>
      * Function that returns the operation id, e.g. by retrieving it from cusotm properties within context
      */
     extractOperationId?: (context: Readonly<ContextType>) => string | undefined;
+    /**
+     * Callback function to notify consumer of missing hash match, f.i. to log, monitor and/or analise these events
+     */
+    onMissingMatch?: (context: Readonly<ContextType>, operationId: string) => void;
 };
 declare const contextProperty: unique symbol;
 export declare type PersistedOperationPluginContext = {