feat(timeline): move Timeline Preview out of alpha (#2605)

Author: z0al

README.md

@@ -70,15 +70,17 @@ JavaScript library for the Contentful [Content Delivery API](https://www.content
   - [Authentication](#authentication)
 - [Documentation \& References](#documentation--references)
   - [Configuration](#configuration)
-    - [Request configuration options](#request-configuration-options)
-    - [Response configuration options](#response-configuration-options)
+      - [Request configuration options](#request-configuration-options)
+      - [Response configuration options](#response-configuration-options)
+  - [Timeline Preview](#timeline-preview)
+      - [Example](#example)
   - [Client chain modifiers](#client-chain-modifiers)
     - [Entries](#entries)
-      - [Example](#example)
-    - [Assets](#assets)
       - [Example](#example-1)
-    - [Sync](#sync)
+    - [Assets](#assets)
       - [Example](#example-2)
+    - [Sync](#sync)
+      - [Example](#example-3)
   - [Reference documentation](#reference-documentation)
   - [Tutorials \& other resources](#tutorials--other-resources)
   - [Troubleshooting](#troubleshooting)
@@ -292,11 +294,9 @@ const client = contentful.createClient({
   accessToken: 'preview_0b7f6x59a0',
   host: 'preview.contentful.com',
   // either release or timestamp or both can be passed as a valid config
-  alphaFeatures: {
-    timelinePreview: {
-      release: { lte: 'black-friday' },
-      timestamp: { lte: '2025-11-29T08:46:15Z' },
-    },
+  timelinePreview: {
+    release: { lte: 'black-friday' },
+    timestamp: { lte: '2025-11-29T08:46:15Z' },
   },
 })
 ```

lib/contentful.ts

@@ -121,6 +121,14 @@ export interface CreateClientParams {
    */
   includeContentSourceMaps?: boolean
 
+  /**
+   * Enable Timeline Preview.
+   *
+   * @remarks
+   * This feature is only available when using the Content Preview API.
+   */
+  timelinePreview?: TimelinePreview
+
   /**
    * Enable alpha features.
    */
@@ -132,8 +140,11 @@ export interface CreateClientParams {
 
     /**
      * Enable Timeline Preview.
+     *
      * @remarks
-     * This feature is only available in private beta when using the Content Preview API.
+     * This feature is only available when using the Content Preview API.
+     *
+     * @deprecated Use the `timelinePreview` option directly instead.
      */
     timelinePreview?: TimelinePreview
   }

lib/utils/timeline-preview-helpers.ts

@@ -42,7 +42,8 @@ export const isValidTimelinePreviewConfig = (timelinePreview: TimelinePreview) =
 
 export const getTimelinePreviewParams = (params: CreateClientParams) => {
   const host = params?.host as string
-  const timelinePreview = params?.alphaFeatures?.timelinePreview as TimelinePreview
+  const timelinePreview =
+    params?.timelinePreview ?? (params?.alphaFeatures?.timelinePreview as TimelinePreview)
   const enabled = checkEnableTimelinePreviewIsAllowed(host, timelinePreview)
   return { enabled, timelinePreview }
 }

test/integration/getEntry.test.ts

@@ -357,9 +357,8 @@ test('Gets entry with attached metadata and field called "metadata" on preview',
 test('can make calls to TimelinePreview API on preview', async () => {
   const timelinePreviewClient = contentful.createClient({
     ...previewParamsWithCSM,
-    alphaFeatures: {
-      timelinePreview: { release: { lte: 'black-friday' } },
-    },
+
+    timelinePreview: { release: { lte: 'black-friday' } },
   })
 
   const entryWithMetadataFieldAndMetadata = '1NnAC4eF9IRMpHtFB1NleW'

test/unit/timeline-preview.test.ts

@@ -9,11 +9,10 @@ describe('Timeline Preview path and query', () => {
       get: mockGet,
       httpClientParams: {
         host: 'preview.contentful.com',
-        alphaFeatures: {
-          timelinePreview: {
-            release: { lte: 'black-friday' },
-            timestamp: { lte: '2023-11-30T23:59:59Z' },
-          },
+
+        timelinePreview: {
+          release: { lte: 'black-friday' },
+          timestamp: { lte: '2023-11-30T23:59:59Z' },
         },
       },
     } as unknown as AxiosInstance