feat: add alpha modifier [TOL-2043]

2wce · 2wce · commit 0bd54a958de2 · 2024-04-23T09:39:51.000+02:00
diff --git a/lib/create-contentful-api.ts b/lib/create-contentful-api.ts
@@ -13,27 +13,27 @@ import {
   ContentfulClientApi,
   ContentType,
   ContentTypeCollection,
-  LocaleCollection,
+  EntryCollection,
+  EntrySkeletonType,
   LocaleCode,
+  LocaleCollection,
   Space,
+  SyncOptions,
+  SyncQuery,
   Tag,
   TagCollection,
-  EntryCollection,
-  SyncQuery,
-  SyncOptions,
-  EntrySkeletonType,
 } from './types'
+import { ChainOptions, ModifiersFromOptions } from './utils/client-helpers'
 import normalizeSearchParameters from './utils/normalize-search-parameters'
 import normalizeSelect from './utils/normalize-select'
 import resolveCircular from './utils/resolve-circular'
-import validateTimestamp from './utils/validate-timestamp'
-import { ChainOptions, ModifiersFromOptions } from './utils/client-helpers'
 import {
   validateLocaleParam,
   validateRemoveUnresolvedParam,
   validateResolveLinksParam,
 } from './utils/validate-params'
 import validateSearchParameters from './utils/validate-search-parameters'
+import validateTimestamp from './utils/validate-timestamp'
 
 const ASSET_KEY_MAX_LIFETIME = 48 * 60 * 60
 
@@ -75,6 +75,7 @@ export default function createContentfulApi<OptionType extends ChainOptions>(
     context: Context
     path: string
     config?: any
+    queryParams?: string
   }
 
   interface PostConfig extends GetConfig {
@@ -96,11 +97,14 @@ export default function createContentfulApi<OptionType extends ChainOptions>(
     return baseUrl
   }
 
-  async function get<T>({ context, path, config }: GetConfig): Promise<T> {
+  async function get<T>({ context, path, config, queryParams }: GetConfig): Promise<T> {
     const baseUrl = getBaseUrl(context)
 
+    const url = baseUrl + path + (queryParams ?? '')
+
+    console.log('get', { url, queryParams, config })
     try {
-      const response = await http.get(baseUrl + path, config)
+      const response = await http.get(url, config)
       return response.data
     } catch (error) {
       errorHandler(error)
@@ -148,6 +152,7 @@ export default function createContentfulApi<OptionType extends ChainOptions>(
     id: string,
     query,
     options: ChainOptions = {
+      alpha_withContentSourceMaps: false,
       withAllLocales: false,
       withoutLinkResolution: false,
       withoutUnresolvableLinks: false,
@@ -193,6 +198,7 @@ export default function createContentfulApi<OptionType extends ChainOptions>(
   async function makeGetEntries<EntrySkeleton extends EntrySkeletonType>(
     query,
     options: ChainOptions = {
+      alpha_withContentSourceMaps: false,
       withAllLocales: false,
       withoutLinkResolution: false,
       withoutUnresolvableLinks: false,
@@ -224,13 +230,14 @@ export default function createContentfulApi<OptionType extends ChainOptions>(
     query: Record<string, any>,
     options: Options,
   ): Promise<EntryCollection<EntrySkeleton, ModifiersFromOptions<Options>, Locales>> {
-    const { withoutLinkResolution, withoutUnresolvableLinks } = options
+    const { withoutLinkResolution, withoutUnresolvableLinks, alpha_withContentSourceMaps } = options
 
     try {
       const entries = await get({
         context: 'environment',
         path: 'entries',
         config: createRequestConfig({ query: normalizeSearchParameters(normalizeSelect(query)) }),
+        queryParams: alpha_withContentSourceMaps ? '?includeContentSourceMaps=true' : undefined,
       })
 
       return resolveCircular(entries, {
@@ -253,6 +260,7 @@ export default function createContentfulApi<OptionType extends ChainOptions>(
   async function makeGetAssets(
     query: Record<string, any>,
     options: ChainOptions = {
+      alpha_withContentSourceMaps: false,
       withAllLocales: false,
       withoutLinkResolution: false,
       withoutUnresolvableLinks: false,
@@ -287,6 +295,7 @@ export default function createContentfulApi<OptionType extends ChainOptions>(
     id: string,
     query: Record<string, any>,
     options: ChainOptions = {
+      alpha_withContentSourceMaps: false,
       withAllLocales: false,
       withoutLinkResolution: false,
       withoutUnresolvableLinks: false,
@@ -369,7 +378,7 @@ export default function createContentfulApi<OptionType extends ChainOptions>(
   async function makePagedSync<EntrySkeleton extends EntrySkeletonType = EntrySkeletonType>(
     query: SyncQuery,
     syncOptions: SyncOptions,
-    options: ChainOptions = {
+    options: Omit<ChainOptions, 'alpha_withContentSourceMaps'> = {
       withAllLocales: false,
       withoutLinkResolution: false,
       withoutUnresolvableLinks: false,
@@ -397,6 +406,7 @@ export default function createContentfulApi<OptionType extends ChainOptions>(
   function makeParseEntries<EntrySkeleton extends EntrySkeletonType>(
     data,
     options: ChainOptions = {
+      alpha_withContentSourceMaps: false,
       withAllLocales: false,
       withoutLinkResolution: false,
       withoutUnresolvableLinks: false,
diff --git a/lib/make-client.ts b/lib/make-client.ts
@@ -1,11 +1,11 @@
 import createContentfulApi, { CreateContentfulApiParams } from './create-contentful-api'
+import { ContentfulClientApi } from './types'
 import {
+  ChainOption,
   ChainOptions,
   DefaultChainOption,
-  ChainOption,
   ModifiersFromOptions,
 } from './utils/client-helpers'
-import { ContentfulClientApi } from './types'
 
 function create<OptionsType extends ChainOptions>(
   { http, getGlobalOptions }: CreateContentfulApiParams,
@@ -29,6 +29,9 @@ function create<OptionsType extends ChainOptions>(
   Object.defineProperty(response, 'withoutUnresolvableLinks', {
     get: () => makeInnerClient({ ...options, withoutUnresolvableLinks: true }),
   })
+  Object.defineProperty(response, 'alpha_withContentSourceMaps', {
+    get: () => makeInnerClient({ ...options, alpha_withContentSourceMaps: true }),
+  })
   return Object.create(response) as ContentfulClientApi<ModifiersFromOptions<OptionsType>>
 }
 
@@ -48,6 +51,7 @@ export const makeClient = ({
       withoutLinkResolution: false,
       withAllLocales: false,
       withoutUnresolvableLinks: false,
+      alpha_withContentSourceMaps: false,
     },
   )
 
@@ -58,20 +62,32 @@ export const makeClient = ({
         withAllLocales: true,
         withoutLinkResolution: false,
         withoutUnresolvableLinks: false,
+        alpha_withContentSourceMaps: false,
       })
     },
     get withoutLinkResolution() {
       return makeInnerClient<ChainOption<'WITHOUT_LINK_RESOLUTION'>>({
         withAllLocales: false,
         withoutLinkResolution: true,
         withoutUnresolvableLinks: false,
+        alpha_withContentSourceMaps: false,
       })
     },
     get withoutUnresolvableLinks() {
       return makeInnerClient<ChainOption<'WITHOUT_UNRESOLVABLE_LINKS'>>({
         withAllLocales: false,
         withoutLinkResolution: false,
         withoutUnresolvableLinks: true,
+        alpha_withContentSourceMaps: false,
+      })
+    },
+    get alpha_withContentSourceMaps() {
+      console.log('alpha_withContentSourceMaps')
+      return makeInnerClient<ChainOption<'ALPHA_WITH_CONTENT_SOURCE_MAPS'>>({
+        withAllLocales: false,
+        withoutLinkResolution: false,
+        withoutUnresolvableLinks: false,
+        alpha_withContentSourceMaps: true,
       })
     },
   }
diff --git a/lib/types/client.ts b/lib/types/client.ts
@@ -1,5 +1,7 @@
+import { Asset, AssetCollection, AssetFields } from './asset'
+import { AssetKey } from './asset-key'
 import { ContentType, ContentTypeCollection } from './content-type'
-import { Space } from './space'
+import { Entry, EntryCollection } from './entry'
 import { LocaleCode, LocaleCollection } from './locale'
 import {
   AssetQueries,
@@ -9,18 +11,17 @@ import {
   EntrySkeletonType,
   TagQueries,
 } from './query'
+import { Space } from './space'
 import { SyncCollection, SyncOptions, SyncQuery } from './sync'
 import { Tag, TagCollection } from './tag'
-import { AssetKey } from './asset-key'
-import { Entry, EntryCollection } from './entry'
-import { Asset, AssetCollection, AssetFields } from './asset'
 
 /**
  * Client chain modifiers used in all types that depend on the client configuration.
  * @category Client
  * @internal
  */
 export type ChainModifiers =
+  | 'ALPHA_WITH_CONTENT_SOURCE_MAPS'
   | 'WITH_ALL_LOCALES'
   | 'WITHOUT_LINK_RESOLUTION'
   | 'WITHOUT_UNRESOLVABLE_LINKS'
@@ -364,6 +365,13 @@ export interface ContentfulClientApi<Modifiers extends ChainModifiers> {
     query?: AssetsQueries<AssetFields, Modifiers>,
   ): Promise<AssetCollection<Modifiers, Locales>>
 
+  /**
+   * A client that will fetch assets and entries with Content Source Maps. Only available if not already enabled.
+   */
+  alpha_withContentSourceMaps: 'ALPHA_WITH_CONTENT_SOURCE_MAPS' extends Modifiers
+    ? never
+    : ContentfulClientApi<AddChainModifier<Modifiers, 'ALPHA_WITH_CONTENT_SOURCE_MAPS'>>
+
   /**
    * A client that will fetch assets and entries with all locales. Only available if not already enabled.
    */
diff --git a/lib/types/sys.ts b/lib/types/sys.ts
@@ -1,5 +1,5 @@
 import { EntryFields } from './entry'
-import { SpaceLink, EnvironmentLink } from './link'
+import { EnvironmentLink, SpaceLink } from './link'
 
 /**
  * Definition of common part of system managed metadata
@@ -21,4 +21,20 @@ export interface EntitySys extends BaseSys {
   space: { sys: SpaceLink }
   environment: { sys: EnvironmentLink }
   locale?: string
+  contentSourceMaps?: ContentSourceMaps
+}
+
+export type ContentSourceMaps = {
+  sys: {
+    type: 'ContentSourceMaps'
+  }
+  mappings: Record<
+    string,
+    {
+      source: {
+        fieldType: number
+        editorInterface: number
+      }
+    }
+  >
 }
diff --git a/lib/utils/client-helpers.ts b/lib/utils/client-helpers.ts
@@ -16,6 +16,11 @@ export type ChainOption<Modifiers extends ChainModifiers = ChainModifiers> = {
     : 'WITHOUT_UNRESOLVABLE_LINKS' extends Modifiers
       ? true
       : false
+  alpha_withContentSourceMaps: ChainModifiers extends Modifiers
+    ? boolean
+    : 'ALPHA_WITH_CONTENT_SOURCE_MAPS' extends Modifiers
+      ? true
+      : false
 }
 
 export type DefaultChainOption = ChainOption<undefined>
diff --git a/test/integration/getEntry.test.ts b/test/integration/getEntry.test.ts
@@ -1,6 +1,6 @@
+import { EntryFields, EntrySkeletonType } from '../../lib'
 import * as contentful from '../../lib/contentful'
 import { localeSpaceParams, params, previewParams } from './utils'
-import { EntryFields, EntrySkeletonType } from '../../lib'
 
 if (process.env.API_INTEGRATION_TESTS) {
   params.host = '127.0.0.1:5000'
@@ -148,6 +148,41 @@ describe('getEntry via client chain modifiers', () => {
     })
   })
 
+  describe('client has alpha_withContentSourceMaps modifier', () => {
+    test.only('client.alpha_withContentSourceMaps', async () => {
+      const response = await client.alpha_withContentSourceMaps.getEntry(entryWithResolvableLink, {
+        include: 2,
+      })
+
+      console.log({ response })
+      expect(response.fields.color).toHaveProperty('en-US')
+      expect(response.fields.bestFriend).not.toHaveProperty('[en-US].sys.type', 'Link')
+    })
+
+    test('client.alpha_withContentSourceMaps.withoutLinkResolution', async () => {
+      const response = await client.alpha_withContentSourceMaps.withoutLinkResolution.getEntry(
+        entryWithResolvableLink,
+        {
+          include: 2,
+        },
+      )
+      expect(response.fields.color).toHaveProperty('en-US')
+      expect(response.fields.bestFriend).toHaveProperty('[en-US].sys.type', 'Link')
+    })
+
+    test('client.alpha_withContentSourceMaps.withoutUnresolvableLinks', async () => {
+      const response = await client.alpha_withContentSourceMaps.withoutUnresolvableLinks.getEntry(
+        entryWithUnresolvableLink,
+        {
+          include: 2,
+        },
+      )
+
+      expect(response.fields.color).toHaveProperty('en-US')
+      expect(response.fields.bestFriend).toEqual({})
+    })
+  })
+
   describe('client has withoutLinkResolution modifier', () => {
     test('client.withoutLinkResolution', async () => {
       const response = await client.withoutLinkResolution.getEntry(entryWithResolvableLink)
diff --git a/test/types/chain-options.test-d.ts b/test/types/chain-options.test-d.ts
