feat: ensure relevant content source maps fields are selected

Author: z0al

lib/create-contentful-api.ts

@@ -36,6 +36,7 @@ import {
 } from './utils/validate-params'
 import validateSearchParameters from './utils/validate-search-parameters'
 import validateTimestamp from './utils/validate-timestamp'
+import getQuerySelectionSet from './utils/query-selection-set'
 
 const ASSET_KEY_MAX_LIFETIME = 48 * 60 * 60
 
@@ -107,6 +108,18 @@ export default function createContentfulApi<OptionType extends ChainOptions>(
 
     if (areAllowed) {
       query.includeContentSourceMaps = true
+
+      // Ensure that content source maps related attributes are selected
+      if (query.select) {
+        const selection = getQuerySelectionSet(query)
+
+        if (!selection.has('sys')) {
+          selection.add('sys.contentSourceMaps')
+          selection.add('sys.contentSourceMapsLookup')
+        }
+
+        query.select = [...selection].join(',')
+      }
     }
 
     return query

lib/utils/normalize-select.ts

@@ -1,3 +1,5 @@
+import getQuerySelectionSet from './query-selection-set'
+
 /*
  * sdk relies heavily on sys metadata
  * so we cannot omit the sys property on sdk level entirely
@@ -9,13 +11,7 @@ export default function normalizeSelect(query) {
     return query
   }
 
-  // The selection of fields for the query is limited
-  // Get the different parts that are listed for selection
-  const allSelects = Array.isArray(query.select)
-    ? query.select
-    : query.select.split(',').map((q) => q.trim())
-  // Move the parts into a set for easy access and deduplication
-  const selectedSet = new Set(allSelects)
+  const selectedSet = getQuerySelectionSet(query)
 
   // If we already select all of `sys` we can just return
   // since we're anyway fetching everything that is needed

lib/utils/query-selection-set.ts

@@ -0,0 +1,14 @@
+export default function getQuerySelectionSet(query: Record<string, any>): Set<string> {
+  if (!query.select) {
+    return new Set()
+  }
+
+  // The selection of fields for the query is limited
+  // Get the different parts that are listed for selection
+  const allSelects = Array.isArray(query.select)
+    ? query.select
+    : query.select.split(',').map((q) => q.trim())
+
+  // Move the parts into a set for easy access and deduplication
+  return new Set(allSelects)
+}