@envelop/response-cache 3.0.0-alpha-e8a9318.0 → 3.0.0-alpha-0d610c4.0

package/README.md

@@ -44,7 +44,10 @@ import { useResponseCache } from '@envelop/response-cache';
 const getEnveloped = envelop({
   plugins: [
     // ... other plugins ...
-    useResponseCache(),
+    useResponseCache({
+      // use global cache for all operations
+      session: () => null,
+    }),
   ],
 });
 ```
@@ -61,12 +64,31 @@ const getEnveloped = envelop({
   plugins: [
     // ... other plugins ...
     useResponseCache({ cache }),
+    session: () => null, // use global cache for all operations
   ],
 });
 ```
 
 > Note: The in-memory LRU cache is not suitable for serverless deployments. Instead, consider the Redis cache provided by `@envelop/response-cache-redis`.
 
+### Cache based on session/user
+
+```ts
+import { envelop } from '@envelop/core';
+import { useResponseCache } from '@envelop/response-cache';
+
+const getEnveloped = envelop({
+  plugins: [
+    // ... other plugins ...
+    useResponseCache({
+      ttl: 2000,
+      // context is the GraphQL context used for execution
+      session: context => String(context.user?.id),
+    }),
+  ],
+});
+```
+
 ### Redis Cache
 
 ```bash
@@ -93,14 +115,17 @@ const redis = new Redis({
   password: '1234567890',
 });
 
-const redis = new Redis("rediss://:1234567890@my-redis-db.example.com:30652");
+const redis = new Redis('rediss://:1234567890@my-redis-db.example.com:30652');
 
 const cache = createRedisCache({ redis });
 
 const getEnveloped = envelop({
   plugins: [
     // ... other plugins ...
-    useResponseCache({ cache }),
+    useResponseCache({
+      cache,
+      session: () => null, // use global cache for all operations
+    }),
   ],
 });
 ```
@@ -120,6 +145,7 @@ const getEnveloped = envelop({
     // ... other plugins ...
     useResponseCache({
       ttl: 2000, // cached execution results become stale after 2 seconds
+      session: () => null, // use global cache for all operations
     }),
   ],
 });
@@ -167,24 +193,6 @@ const getEnveloped = envelop({
 });
 ```
 
-### Cache based on session/user
-
-```ts
-import { envelop } from '@envelop/core';
-import { useResponseCache } from '@envelop/response-cache';
-
-const getEnveloped = envelop({
-  plugins: [
-    // ... other plugins ...
-    useResponseCache({
-      ttl: 2000,
-      // context is the GraphQL context used for execution
-      session: context => String(context.user?.id),
-    }),
-  ],
-});
-```
-
 ### Disable cache based on session/user
 
 ```ts
@@ -198,6 +206,7 @@ const getEnveloped = envelop({
       ttl: 2000,
       // context is the GraphQL context used for execution
       enabled: context => context.user?.role !== 'admin',
+      session: () => null,
     }),
   ],
 });
@@ -231,6 +240,7 @@ const getEnveloped = envelop({
     // ... other plugins ...
     useResponseCache({
       shouldCacheResult = myCustomShouldCacheResult,
+      session: () => null,
     }),
   ],
 });
@@ -253,6 +263,7 @@ const getEnveloped = envelop({
       ttlPerSchemaCoordinate: {
         'Query.__schema': undefined, // cache infinitely
       },
+      session: () => null,
     }),
   ],
 });
@@ -271,6 +282,7 @@ const getEnveloped = envelop({
       ttlPerSchemaCoordinate: {
         'Query.__schema': 10_000, // cache for 10 seconds
       },
+      session: () => null,
     }),
   ],
 });
@@ -287,6 +299,7 @@ const getEnveloped = envelop({
     // ... other plugins ...
     useResponseCache({
       ttl: 2000, // cached execution results become stale after 2 seconds
+      session: () => null,
     }),
   ],
 });
@@ -305,6 +318,7 @@ const getEnveloped = envelop({
       ttl: 2000,
       // use the `_id` instead of `id` field.
       idFields: ['_id'],
+      session: () => null,
     }),
   ],
 });
@@ -323,6 +337,7 @@ const getEnveloped = envelop({
       ttl: 2000,
       // some might prefer invalidating based on a database write log
       invalidateViaMutation: false,
+      session: () => null,
     }),
   ],
 });
@@ -345,6 +360,7 @@ const getEnveloped = envelop({
       ttl: 2000,
       // we pass the cache instance to the request.
       cache,
+      session: () => null,
     }),
   ],
 });
@@ -379,6 +395,7 @@ const getEnveloped = envelop({
       ttl: 2000,
       // we pass the cache instance to the request.
       cache,
+      session: () => null,
     }),
   ],
 });
@@ -395,6 +412,7 @@ const getEnveloped = envelop({
     useResponseCache({
       ttl: 2000,
       includeExtensionMetadata: true,
+      session: () => null,
     }),
   ],
 });

package/cjs/plugin.js

@@ -41,9 +41,9 @@ const defaultShouldCacheResult = (params) => {
     return true;
 };
 exports.defaultShouldCacheResult = defaultShouldCacheResult;
-function useResponseCache({ cache = (0, in_memory_cache_js_1.createInMemoryCache)(), ttl: globalTtl = Infinity, session = () => null, enabled, ignoredTypes = [], ttlPerType = {}, ttlPerSchemaCoordinate = {}, idFields = ['id'], invalidateViaMutation = true, buildResponseCacheKey = exports.defaultBuildResponseCacheKey, getDocumentString = cache_document_str_js_1.defaultGetDocumentString, shouldCacheResult = exports.defaultShouldCacheResult, 
+function useResponseCache({ cache = (0, in_memory_cache_js_1.createInMemoryCache)(), ttl: globalTtl = Infinity, session, enabled, ignoredTypes = [], ttlPerType = {}, ttlPerSchemaCoordinate = {}, idFields = ['id'], invalidateViaMutation = true, buildResponseCacheKey = exports.defaultBuildResponseCacheKey, getDocumentString = cache_document_str_js_1.defaultGetDocumentString, shouldCacheResult = exports.defaultShouldCacheResult, 
 // eslint-disable-next-line dot-notation
-includeExtensionMetadata = typeof process !== 'undefined' ? process.env['NODE_ENV'] === 'development' : false, } = {}) {
+includeExtensionMetadata = typeof process !== 'undefined' ? process.env['NODE_ENV'] === 'development' : false, }) {
     const appliedTransform = Symbol('responseCache.appliedTransform');
     const ignoredTypesMap = new Set(ignoredTypes);
     // never cache Introspections

package/esm/plugin.js

@@ -35,9 +35,9 @@ export const defaultShouldCacheResult = (params) => {
     }
     return true;
 };
-export function useResponseCache({ cache = createInMemoryCache(), ttl: globalTtl = Infinity, session = () => null, enabled, ignoredTypes = [], ttlPerType = {}, ttlPerSchemaCoordinate = {}, idFields = ['id'], invalidateViaMutation = true, buildResponseCacheKey = defaultBuildResponseCacheKey, getDocumentString = defaultGetDocumentString, shouldCacheResult = defaultShouldCacheResult, 
+export function useResponseCache({ cache = createInMemoryCache(), ttl: globalTtl = Infinity, session, enabled, ignoredTypes = [], ttlPerType = {}, ttlPerSchemaCoordinate = {}, idFields = ['id'], invalidateViaMutation = true, buildResponseCacheKey = defaultBuildResponseCacheKey, getDocumentString = defaultGetDocumentString, shouldCacheResult = defaultShouldCacheResult, 
 // eslint-disable-next-line dot-notation
-includeExtensionMetadata = typeof process !== 'undefined' ? process.env['NODE_ENV'] === 'development' : false, } = {}) {
+includeExtensionMetadata = typeof process !== 'undefined' ? process.env['NODE_ENV'] === 'development' : false, }) {
     const appliedTransform = Symbol('responseCache.appliedTransform');
     const ignoredTypesMap = new Set(ignoredTypes);
     // never cache Introspections

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@envelop/response-cache",
-  "version": "3.0.0-alpha-e8a9318.0",
+  "version": "3.0.0-alpha-0d610c4.0",
   "sideEffects": false,
   "peerDependencies": {
     "@envelop/core": "^2.4.0",

package/typings/plugin.d.ts

@@ -12,7 +12,7 @@ export declare type BuildResponseCacheKeyFunction = (params: {
     /** The name of the GraphQL operation that should be executed from within the document. */
     operationName?: Maybe<string>;
     /** optional sessionId for make unique cache keys based on the session.  */
-    sessionId?: Maybe<string>;
+    sessionId: Maybe<string>;
 }) => Promise<string>;
 export declare type GetDocumentStringFunction = (executionArgs: ExecutionArgs) => string;
 export declare type ShouldCacheResultFunction = (params: {
@@ -45,8 +45,22 @@ export declare type UseResponseCacheParameter<C = any> = {
      * Return `null` or `undefined` to mark the session as public/global.
      * Creates a global session by default.
      * @param context GraphQL Context
+     *
+     * **Global Example:**
+     * ```ts
+     * useResponseCache({
+     *   session: () => null,
+     * });
+     * ```
+     *
+     * **User Specific with global fallback example:**
+     * ```ts
+     * useResponseCache({
+     *   session: (context) => context.user?.id ?? null,
+     * });
+     * ```
      */
-    session?(context: C): string | undefined | null;
+    session(context: C): string | undefined | null;
     /**
      * Specify whether the cache should be used based on the context.
      * By default any request uses the cache.
@@ -105,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({ cache, ttl: globalTtl, session, enabled, ignoredTypes, ttlPerType, ttlPerSchemaCoordinate, idFields, invalidateViaMutation, buildResponseCacheKey, getDocumentString, shouldCacheResult, includeExtensionMetadata, }: UseResponseCacheParameter): Plugin;