@envelop/response-cache 5.2.0 → 5.3.0-alpha-20230908093945-02e7e8ad

package/cjs/plugin.js

@@ -12,7 +12,7 @@ const in_memory_cache_js_1 = require("./in-memory-cache.js");
  * Default function used for building the response cache key.
  * It is exported here for advanced use-cases. E.g. if you want to short circuit and serve responses from the cache on a global level in order to completely by-pass the GraphQL flow.
  */
-const defaultBuildResponseCacheKey = params => (0, hash_sha256_js_1.hashSHA256)([
+const defaultBuildResponseCacheKey = (params) => (0, hash_sha256_js_1.hashSHA256)([
     params.documentString,
     params.operationName ?? '',
     (0, fast_json_stable_stringify_1.default)(params.variableValues ?? {}),
@@ -219,6 +219,7 @@ function useResponseCache({ cache = (0, in_memory_cache_js_1.createInMemoryCache
                 variableValues: onExecuteParams.args.variableValues,
                 operationName: onExecuteParams.args.operationName,
                 sessionId,
+                context: onExecuteParams.args.contextValue,
             });
             if ((enabled?.(onExecuteParams.args.contextValue) ?? true) === true) {
                 const cachedResponse = (await cache.get(cacheKey));

package/esm/plugin.js

@@ -8,7 +8,7 @@ import { createInMemoryCache } from './in-memory-cache.js';
  * Default function used for building the response cache key.
  * It is exported here for advanced use-cases. E.g. if you want to short circuit and serve responses from the cache on a global level in order to completely by-pass the GraphQL flow.
  */
-export const defaultBuildResponseCacheKey = params => hashSHA256([
+export const defaultBuildResponseCacheKey = (params) => hashSHA256([
     params.documentString,
     params.operationName ?? '',
     jsonStableStringify(params.variableValues ?? {}),
@@ -212,6 +212,7 @@ export function useResponseCache({ cache = createInMemoryCache(), ttl: globalTtl
                 variableValues: onExecuteParams.args.variableValues,
                 operationName: onExecuteParams.args.operationName,
                 sessionId,
+                context: onExecuteParams.args.contextValue,
             });
             if ((enabled?.(onExecuteParams.args.contextValue) ?? true) === true) {
                 const cachedResponse = (await cache.get(cacheKey));

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@envelop/response-cache",
-  "version": "5.2.0",
+  "version": "5.3.0-alpha-20230908093945-02e7e8ad",
   "sideEffects": false,
   "peerDependencies": {
     "@envelop/core": "^4.0.1",

package/typings/plugin.d.cts

@@ -13,6 +13,8 @@ export type BuildResponseCacheKeyFunction = (params: {
     operationName?: Maybe<string>;
     /** optional sessionId for make unique cache keys based on the session.  */
     sessionId: Maybe<string>;
+    /** GraphQL Context */
+    context: ExecutionArgs['contextValue'];
 }) => Promise<string>;
 export type GetDocumentStringFunction = (executionArgs: ExecutionArgs) => string;
 export type ShouldCacheResultFunction = (params: {
@@ -111,7 +113,12 @@ export type UseResponseCacheParameter<PluginContext extends Record<string, any>
  * Default function used for building the response cache key.
  * It is exported here for advanced use-cases. E.g. if you want to short circuit and serve responses from the cache on a global level in order to completely by-pass the GraphQL flow.
  */
-export declare const defaultBuildResponseCacheKey: BuildResponseCacheKeyFunction;
+export declare const defaultBuildResponseCacheKey: (params: {
+    documentString: string;
+    variableValues: ExecutionArgs['variableValues'];
+    operationName?: Maybe<string>;
+    sessionId: Maybe<string>;
+}) => Promise<string>;
 /**
  * Default function used to check if the result should be cached.
  *

package/typings/plugin.d.ts

@@ -13,6 +13,8 @@ export type BuildResponseCacheKeyFunction = (params: {
     operationName?: Maybe<string>;
     /** optional sessionId for make unique cache keys based on the session.  */
     sessionId: Maybe<string>;
+    /** GraphQL Context */
+    context: ExecutionArgs['contextValue'];
 }) => Promise<string>;
 export type GetDocumentStringFunction = (executionArgs: ExecutionArgs) => string;
 export type ShouldCacheResultFunction = (params: {
@@ -111,7 +113,12 @@ export type UseResponseCacheParameter<PluginContext extends Record<string, any>
  * Default function used for building the response cache key.
  * It is exported here for advanced use-cases. E.g. if you want to short circuit and serve responses from the cache on a global level in order to completely by-pass the GraphQL flow.
  */
-export declare const defaultBuildResponseCacheKey: BuildResponseCacheKeyFunction;
+export declare const defaultBuildResponseCacheKey: (params: {
+    documentString: string;
+    variableValues: ExecutionArgs['variableValues'];
+    operationName?: Maybe<string>;
+    sessionId: Maybe<string>;
+}) => Promise<string>;
 /**
  * Default function used to check if the result should be cached.
  *