@envelop/response-cache 4.0.0 → 4.0.2-alpha-20221014125414-4a8038f2

package/README.md

@@ -38,13 +38,13 @@ When configuring the `useResponseCache`, you can choose the type of cache:
 The in-memory LRU cache is used by default.
 
 ```ts
-import { parse, validate, execute, subscribe } from 'graphql'
+import { parse, validate, specifiedRules, execute, subscribe } from 'graphql'
 import { envelop, useEngine } from '@envelop/core'
 import { useResponseCache } from '@envelop/response-cache'
 
 const getEnveloped = envelop({
   plugins: [
-    useEngine({ parse, validate, execute, subscribe }),
+    useEngine({ parse, validate, specifiedRules, execute, subscribe }),
     // ... other plugins ...
     useResponseCache({
       // use global cache for all operations
@@ -57,7 +57,7 @@ const getEnveloped = envelop({
 Or, you may create the in-memory LRU cache explicitly.
 
 ```ts
-import { parse, validate, execute, subscribe } from 'graphql'
+import { parse, validate, specifiedRules, execute, subscribe } from 'graphql'
 import { envelop, useEngine } from '@envelop/core'
 import { useResponseCache, createInMemoryCache } from '@envelop/response-cache'
 
@@ -65,7 +65,7 @@ const cache = createInMemoryCache()
 
 const getEnveloped = envelop({
   plugins: [
-    useEngine({ parse, validate, execute, subscribe }),
+    useEngine({ parse, validate, specifiedRules, execute, subscribe }),
     // ... other plugins ...
     useResponseCache({
       cache,
@@ -80,13 +80,13 @@ const getEnveloped = envelop({
 ### Cache based on session/user
 
 ```ts
-import { parse, validate, execute, subscribe } from 'graphql'
+import { parse, validate, specifiedRules, execute, subscribe } from 'graphql'
 import { envelop, useEngine } from '@envelop/core'
 import { useResponseCache } from '@envelop/response-cache'
 
 const getEnveloped = envelop({
   plugins: [
-    useEngine({ parse, validate, execute, subscribe }),
+    useEngine({ parse, validate, specifiedRules, execute, subscribe }),
     // ... other plugins ...
     useResponseCache({
       ttl: 2000,

package/package.json

@@ -1,9 +1,9 @@
 {
   "name": "@envelop/response-cache",
-  "version": "4.0.0",
+  "version": "4.0.2-alpha-20221014125414-4a8038f2",
   "sideEffects": false,
   "peerDependencies": {
-    "@envelop/core": "^3.0.0",
+    "@envelop/core": "3.0.2-alpha-20221014125414-4a8038f2",
     "graphql": "^14.0.0 || ^15.0.0 || ^16.0.0"
   },
   "dependencies": {

package/typings/cache-document-str.d.cts

@@ -1,4 +1,4 @@
 import { ExecutionArgs } from 'graphql';
 import { Plugin } from '@envelop/core';
-export declare function useCacheDocumentString(): Plugin;
+export declare function useCacheDocumentString<PluginContext extends Record<string, any> = {}>(): Plugin<PluginContext>;
 export declare function defaultGetDocumentString(executionArgs: ExecutionArgs): string;

package/typings/cache-document-str.d.ts

@@ -1,4 +1,4 @@
 import { ExecutionArgs } from 'graphql';
 import { Plugin } from '@envelop/core';
-export declare function useCacheDocumentString(): Plugin;
+export declare function useCacheDocumentString<PluginContext extends Record<string, any> = {}>(): Plugin<PluginContext>;
 export declare function defaultGetDocumentString(executionArgs: ExecutionArgs): string;

package/typings/plugin.d.cts

@@ -18,7 +18,7 @@ export declare type GetDocumentStringFunction = (executionArgs: ExecutionArgs) =
 export declare type ShouldCacheResultFunction = (params: {
     result: ExecutionResult;
 }) => Boolean;
-export declare type UseResponseCacheParameter<C = any> = {
+export declare type UseResponseCacheParameter<PluginContext extends Record<string, any> = {}> = {
     cache?: Cache;
     /**
      * Maximum age in ms. Defaults to `Infinity`. Set it to 0 for disabling the global TTL.
@@ -60,12 +60,12 @@ export declare type UseResponseCacheParameter<C = any> = {
      * });
      * ```
      */
-    session(context: C): string | undefined | null;
+    session(context: PluginContext): string | undefined | null;
     /**
      * Specify whether the cache should be used based on the context.
      * By default any request uses the cache.
      */
-    enabled?(context: C): boolean;
+    enabled?(context: PluginContext): boolean;
     /**
      * Skip caching of following the types.
      */
@@ -119,4 +119,4 @@ export declare const defaultBuildResponseCacheKey: BuildResponseCacheKeyFunction
  * By default, results with errors (unexpected, EnvelopError, or GraphQLError) are not cached.
  */
 export declare const defaultShouldCacheResult: ShouldCacheResultFunction;
-export declare function useResponseCache({ cache, ttl: globalTtl, session, enabled, ignoredTypes, ttlPerType, ttlPerSchemaCoordinate, idFields, invalidateViaMutation, buildResponseCacheKey, getDocumentString, shouldCacheResult, includeExtensionMetadata, }: UseResponseCacheParameter): Plugin;
+export declare function useResponseCache<PluginContext extends Record<string, any> = {}>({ cache, ttl: globalTtl, session, enabled, ignoredTypes, ttlPerType, ttlPerSchemaCoordinate, idFields, invalidateViaMutation, buildResponseCacheKey, getDocumentString, shouldCacheResult, includeExtensionMetadata, }: UseResponseCacheParameter<PluginContext>): Plugin<PluginContext>;

package/typings/plugin.d.ts

@@ -18,7 +18,7 @@ export declare type GetDocumentStringFunction = (executionArgs: ExecutionArgs) =
 export declare type ShouldCacheResultFunction = (params: {
     result: ExecutionResult;
 }) => Boolean;
-export declare type UseResponseCacheParameter<C = any> = {
+export declare type UseResponseCacheParameter<PluginContext extends Record<string, any> = {}> = {
     cache?: Cache;
     /**
      * Maximum age in ms. Defaults to `Infinity`. Set it to 0 for disabling the global TTL.
@@ -60,12 +60,12 @@ export declare type UseResponseCacheParameter<C = any> = {
      * });
      * ```
      */
-    session(context: C): string | undefined | null;
+    session(context: PluginContext): string | undefined | null;
     /**
      * Specify whether the cache should be used based on the context.
      * By default any request uses the cache.
      */
-    enabled?(context: C): boolean;
+    enabled?(context: PluginContext): boolean;
     /**
      * Skip caching of following the types.
      */
@@ -119,4 +119,4 @@ export declare const defaultBuildResponseCacheKey: BuildResponseCacheKeyFunction
  * By default, results with errors (unexpected, EnvelopError, or GraphQLError) are not cached.
  */
 export declare const defaultShouldCacheResult: ShouldCacheResultFunction;
-export declare function useResponseCache({ cache, ttl: globalTtl, session, enabled, ignoredTypes, ttlPerType, ttlPerSchemaCoordinate, idFields, invalidateViaMutation, buildResponseCacheKey, getDocumentString, shouldCacheResult, includeExtensionMetadata, }: UseResponseCacheParameter): Plugin;
+export declare function useResponseCache<PluginContext extends Record<string, any> = {}>({ cache, ttl: globalTtl, session, enabled, ignoredTypes, ttlPerType, ttlPerSchemaCoordinate, idFields, invalidateViaMutation, buildResponseCacheKey, getDocumentString, shouldCacheResult, includeExtensionMetadata, }: UseResponseCacheParameter<PluginContext>): Plugin<PluginContext>;