@smartive/datocms-utils 3.0.0 → 3.1.0

package/README.md

@@ -44,7 +44,7 @@ Utilities for managing [DatoCMS cache tags](https://www.datocms.com/docs/content
 import { generateQueryId, parseXCacheTagsResponseHeader } from '@smartive/datocms-utils/cache-tags';
 
 // Generate a unique ID for a GraphQL query
-const queryId = generateQueryId(document, variables);
+const queryId = generateQueryId(document, variables, headers);
 
 // Parse DatoCMS's X-Cache-Tags header
 const tags = parseXCacheTagsResponseHeader('tag-a tag-2 other-tag');
@@ -168,7 +168,7 @@ const provider = new RedisCacheTagsProvider({
 });
 
 // After making a DatoCMS query
-const queryId = generateQueryId(document, variables);
+const queryId = generateQueryId(document, variables, request.headers);
 const cacheTags = parseXCacheTagsResponseHeader(response.headers['x-cache-tags']);
 await provider.storeQueryCacheTags(queryId, cacheTags);
 

package/dist/cache-tags/utils.d.ts

@@ -9,10 +9,11 @@ import { type CacheTag } from './types.js';
  */
 export declare const parseXCacheTagsResponseHeader: (string?: null | string) => CacheTag[];
 /**
- * Generates a unique query ID based on the query document and its variables.
+ * Generates a unique query ID based on the query document, its variables, and optional HTTP headers.
  *
  * @param {DocumentNode} document Query document
- * @param {TVariables} variables Query variables
+ * @param {TVariables} variables Optional query variables
+ * @param {HeadersInit} headers Optional HTTP headers that might affect the query result (e.g., for authentication)
  * @returns Unique query ID
  */
-export declare const generateQueryId: <TVariables = unknown>(document: DocumentNode, variables?: TVariables) => string;
+export declare const generateQueryId: <TVariables = unknown>(document: DocumentNode, variables?: TVariables, headers?: HeadersInit) => string;

package/dist/cache-tags/utils.js

@@ -9,16 +9,18 @@ import { createHash } from 'node:crypto';
  */
 export const parseXCacheTagsResponseHeader = (string) => (string?.split(' ') ?? []).map((tag) => tag);
 /**
- * Generates a unique query ID based on the query document and its variables.
+ * Generates a unique query ID based on the query document, its variables, and optional HTTP headers.
  *
  * @param {DocumentNode} document Query document
- * @param {TVariables} variables Query variables
+ * @param {TVariables} variables Optional query variables
+ * @param {HeadersInit} headers Optional HTTP headers that might affect the query result (e.g., for authentication)
  * @returns Unique query ID
  */
-export const generateQueryId = (document, variables) => {
+export const generateQueryId = (document, variables, headers) => {
     return createHash('sha1')
         .update(print(document))
         .update(JSON.stringify(variables) || '')
+        .update(JSON.stringify(headers) || '')
         .digest('hex');
 };
 //# sourceMappingURL=utils.js.map

package/dist/cache-tags/utils.js.map

@@ -1 +1 @@
-{"version":3,"file":"utils.js","sourceRoot":"","sources":["../../src/cache-tags/utils.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAqB,MAAM,SAAS,CAAC;AACnD,OAAO,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AAGzC;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,6BAA6B,GAAG,CAAC,MAAsB,EAAE,EAAE,CACtE,CAAC,MAAM,EAAE,KAAK,CAAC,GAAG,CAAC,IAAI,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAe,CAAC,CAAC;AAE3D;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,eAAe,GAAG,CAAuB,QAAsB,EAAE,SAAsB,EAAU,EAAE;IAC9G,OAAO,UAAU,CAAC,MAAM,CAAC;SACtB,MAAM,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;SACvB,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,IAAI,EAAE,CAAC;SACvC,MAAM,CAAC,KAAK,CAAC,CAAC;AACnB,CAAC,CAAC"}
+{"version":3,"file":"utils.js","sourceRoot":"","sources":["../../src/cache-tags/utils.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAqB,MAAM,SAAS,CAAC;AACnD,OAAO,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AAGzC;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,6BAA6B,GAAG,CAAC,MAAsB,EAAE,EAAE,CACtE,CAAC,MAAM,EAAE,KAAK,CAAC,GAAG,CAAC,IAAI,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAe,CAAC,CAAC;AAE3D;;;;;;;GAOG;AACH,MAAM,CAAC,MAAM,eAAe,GAAG,CAC7B,QAAsB,EACtB,SAAsB,EACtB,OAAqB,EACb,EAAE;IACV,OAAO,UAAU,CAAC,MAAM,CAAC;SACtB,MAAM,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;SACvB,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,IAAI,EAAE,CAAC;SACvC,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC;SACrC,MAAM,CAAC,KAAK,CAAC,CAAC;AACnB,CAAC,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@smartive/datocms-utils",
-  "version": "3.0.0",
+  "version": "3.1.0",
   "description": "A set of utilities and helpers to work with DatoCMS in a Next.js project.",
   "type": "module",
   "source": "./src/index.ts",

package/src/cache-tags/utils.ts

@@ -13,15 +13,21 @@ export const parseXCacheTagsResponseHeader = (string?: null | string) =>
   (string?.split(' ') ?? []).map((tag) => tag as CacheTag);
 
 /**
- * Generates a unique query ID based on the query document and its variables.
+ * Generates a unique query ID based on the query document, its variables, and optional HTTP headers.
  *
  * @param {DocumentNode} document Query document
- * @param {TVariables} variables Query variables
+ * @param {TVariables} variables Optional query variables
+ * @param {HeadersInit} headers Optional HTTP headers that might affect the query result (e.g., for authentication)
  * @returns Unique query ID
  */
-export const generateQueryId = <TVariables = unknown>(document: DocumentNode, variables?: TVariables): string => {
+export const generateQueryId = <TVariables = unknown>(
+  document: DocumentNode,
+  variables?: TVariables,
+  headers?: HeadersInit,
+): string => {
   return createHash('sha1')
     .update(print(document))
     .update(JSON.stringify(variables) || '')
+    .update(JSON.stringify(headers) || '')
     .digest('hex');
 };