contentful 11.5.25 → 11.7.0

package/README.md

@@ -11,10 +11,10 @@
 <h3 align="center">Javascript</h3>
 
 <p align="center">
-  <a href="README.md">Readme</a> · 
-  <a href="MIGRATION.md">Migration</a> · 
-  <a href="ADVANCED.md">Advanced</a> · 
-  <a href="TYPESCRIPT.md">TypeScript</a> · 
+  <a href="README.md">Readme</a> ·
+  <a href="MIGRATION.md">Migration</a> ·
+  <a href="ADVANCED.md">Advanced</a> ·
+  <a href="TYPESCRIPT.md">TypeScript</a> ·
   <a href="CONTRIBUTING.md">Contributing</a>
 </p>
 
@@ -70,8 +70,8 @@ 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)
   - [Client chain modifiers](#client-chain-modifiers)
     - [Entries](#entries)
       - [Example](#example)
@@ -186,7 +186,7 @@ Check the [releases](https://github.com/contentful/contentful.js/releases) page
 The following code snippet is the most basic one you can use to get some content from Contentful with this library:
 
 ```js
-import * as contentful from "contentful"
+import * as contentful from 'contentful'
 const client = contentful.createClient({
   // This is the space ID. A space is like a project folder in Contentful terms
   space: 'developer_bookshelf',
@@ -207,7 +207,7 @@ Check out this [JSFiddle](https://jsfiddle.net/contentful/kefaj4s8/) version of
 This library can also be used with the Preview API. In order to do so, you need to use the Preview API Access token, available on the same page where you get the Delivery API token, and specify the host of the preview API, such as:
 
 ```js
-import * as contentful from "contentful"
+import * as contentful from 'contentful'
 const client = contentful.createClient({
   space: 'developer_bookshelf',
   accessToken: 'preview_0b7f6x59a0',
@@ -279,6 +279,28 @@ The configuration options belong to two categories: request config and response
 
 > :warning: **Response config options** have been **removed** in `v10.0.0` in favor of the new [client chain modifiers](#client-chain-modifiers) approach.
 
+### Timeline Preview
+
+The Timeline Preview API provides the ability to query content by future date or specific release
+
+##### Example
+
+```js
+import * as contentful from 'contentful'
+const client = contentful.createClient({
+  space: 'developer_bookshelf',
+  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' },
+    },
+  },
+})
+```
+
 ### Client chain modifiers
 
 > Introduced in `v10.0.0`.
@@ -332,24 +354,18 @@ const localizedData = {
     {
       metadata: { tags: [] },
       sys: {
-        space: {
-          sys: { type: 'Link', linkType: 'Space', id: 'my-space-id' },
-        },
+        space: { sys: { type: 'Link', linkType: 'Space', id: 'my-space-id' } },
         id: 'my-zoo',
         type: 'Entry',
         createdAt: '2020-01-01T00:00:00.000Z',
         updatedAt: '2020-01-01T00:00:00.000Z',
-        environment: {
-          sys: { id: 'master', type: 'Link', linkType: 'Environment' },
-        },
+        environment: { sys: { id: 'master', type: 'Link', linkType: 'Environment' } },
         revision: 1,
         contentType: { sys: { type: 'Link', linkType: 'ContentType', id: 'zoo' } },
         locale: 'en-US',
       },
       fields: {
-        animal: {
-          'en-US': { sys: { type: 'Link', linkType: 'Entry', id: 'oink' } },
-        },
+        animal: { 'en-US': { sys: { type: 'Link', linkType: 'Entry', id: 'oink' } } },
         anotheranimal: {
           'en-US': { sys: { type: 'Link', linkType: 'Entry', id: 'middle-parrot' } },
         },
@@ -361,28 +377,19 @@ const localizedData = {
       {
         metadata: { tags: [] },
         sys: {
-          space: {
-            sys: { type: 'Link', linkType: 'Space', id: 'my-space-id' },
-          },
+          space: { sys: { type: 'Link', linkType: 'Space', id: 'my-space-id' } },
           id: 'oink',
           type: 'Entry',
           createdAt: '2020-01-01T00:00:00.000Z',
           updatedAt: '2020-02-01T00:00:00.000Z',
-          environment: {
-            sys: { id: 'master', type: 'Link', linkType: 'Environment' },
-          },
+          environment: { sys: { id: 'master', type: 'Link', linkType: 'Environment' } },
           revision: 2,
           contentType: { sys: { type: 'Link', linkType: 'ContentType', id: 'animal' } },
           locale: 'en-US',
         },
         fields: {
-          name: {
-            'en-US': 'Pig',
-            de: 'Schwein',
-          },
-          friend: {
-            'en-US': { sys: { type: 'Link', linkType: 'Entry', id: 'groundhog' } },
-          },
+          name: { 'en-US': 'Pig', de: 'Schwein' },
+          friend: { 'en-US': { sys: { type: 'Link', linkType: 'Entry', id: 'groundhog' } } },
         },
       },
     ],

package/dist/contentful.browser.js

@@ -9204,6 +9204,34 @@ var contentful = (function (exports) {
     }
   }
 
+  function isValidRelease(release) {
+    return !!(release && _typeof$2(release) === 'object' && typeof release.lte === 'string');
+  }
+  function isValidTimestamp(timestamp) {
+    return !!(timestamp && _typeof$2(timestamp) === 'object' && (typeof timestamp.lte === 'string' || timestamp.lte instanceof Date));
+  }
+  var isValidTimelinePreviewConfig = function isValidTimelinePreviewConfig(timelinePreview) {
+    if (_typeof$2(timelinePreview) !== 'object' || timelinePreview === null || Array.isArray(timelinePreview)) {
+      throw new ValidationError('timelinePreview', "The 'timelinePreview' parameter must be an object.");
+    }
+    var hasRelease = isValidRelease(timelinePreview.release);
+    var hasTimestamp = isValidTimestamp(timelinePreview.timestamp);
+    if (!hasRelease && !hasTimestamp) {
+      throw new ValidationError('timelinePreview', "The 'timelinePreview' object must have at least one of 'release' or 'timestamp' with a valid 'lte' property.");
+    }
+    return hasRelease || hasTimestamp;
+  };
+  var getTimelinePreviewParams = function getTimelinePreviewParams(params) {
+    var _a;
+    var host = params === null || params === void 0 ? void 0 : params.host;
+    var timelinePreview = (_a = params === null || params === void 0 ? void 0 : params.alphaFeatures) === null || _a === void 0 ? void 0 : _a.timelinePreview;
+    var enabled = checkEnableTimelinePreviewIsAllowed(host, timelinePreview);
+    return {
+      enabled: enabled,
+      timelinePreview: timelinePreview
+    };
+  };
+
   function checkLocaleParamIsAll(query) {
     if (query.locale === '*') {
       throw new ValidationError('locale', "The use of locale='*' is no longer supported.To fetch an entry in all existing locales,\n      use client.withAllLocales instead of the locale='*' parameter.");
@@ -9247,6 +9275,17 @@ var contentful = (function (exports) {
     }
     return includeContentSourceMaps;
   }
+  function checkEnableTimelinePreviewIsAllowed(host, timelinePreview) {
+    if (timelinePreview === undefined) {
+      return false;
+    }
+    var isValidConfig = isValidTimelinePreviewConfig(timelinePreview);
+    var isValidHost = typeof host === 'string' && host.startsWith('preview');
+    if (isValidConfig && !isValidHost) {
+      throw new ValidationError('timelinePreview', "The 'timelinePreview' parameter can only be used with the CPA. Please set host to 'preview.contentful.com' to enable Timeline Preview.\n      ");
+    }
+    return true;
+  }
 
   function validateSearchParameters(query) {
     for (var key in query) {
@@ -9316,6 +9355,25 @@ var contentful = (function (exports) {
       }
       return query;
     }
+    function maybeEnableTimelinePreview(path) {
+      var _getTimelinePreviewPa = getTimelinePreviewParams(http.httpClientParams),
+        enabled = _getTimelinePreviewPa.enabled;
+      return enabled ? "timeline/".concat(path) : path;
+    }
+    function maybeAddTimelinePreviewConfigToQuery(query) {
+      var _getTimelinePreviewPa2 = getTimelinePreviewParams(http.httpClientParams),
+        enabled = _getTimelinePreviewPa2.enabled,
+        timelinePreview = _getTimelinePreviewPa2.timelinePreview;
+      if (enabled) {
+        if (timelinePreview === null || timelinePreview === void 0 ? void 0 : timelinePreview.release) {
+          query.release = timelinePreview.release;
+        }
+        if (timelinePreview === null || timelinePreview === void 0 ? void 0 : timelinePreview.timestamp) {
+          query.timestamp = timelinePreview.timestamp;
+        }
+      }
+      return query;
+    }
     function maybeEncodeCPAResponse(data, config) {
       var _a;
       var includeContentSourceMaps = (_a = config === null || config === void 0 ? void 0 : config.params) === null || _a === void 0 ? void 0 : _a.includeContentSourceMaps;
@@ -9596,6 +9654,12 @@ var contentful = (function (exports) {
       }));
       return _makeGetEntries.apply(this, arguments);
     }
+    function prepareQuery(query) {
+      // First, add timeline preview config if enabled
+      var withTimelinePreview = maybeAddTimelinePreviewConfigToQuery(Object.assign({}, query));
+      // Then, apply source maps and other normalizations
+      return maybeEnableSourceMaps(normalizeSearchParameters(normalizeSelect(withTimelinePreview)));
+    }
     function internalGetEntries(_x11, _x12) {
       return _internalGetEntries.apply(this, arguments);
     }
@@ -9610,9 +9674,9 @@ var contentful = (function (exports) {
               _context11.next = 4;
               return get({
                 context: 'environment',
-                path: 'entries',
+                path: maybeEnableTimelinePreview('entries'),
                 config: createRequestConfig({
-                  query: maybeEnableSourceMaps(normalizeSearchParameters(normalizeSelect(query)))
+                  query: prepareQuery(query)
                 })
               });
             case 4:
@@ -9716,9 +9780,9 @@ var contentful = (function (exports) {
               _context15.prev = 0;
               return _context15.abrupt("return", get({
                 context: 'environment',
-                path: "assets/".concat(id),
+                path: maybeEnableTimelinePreview("assets/".concat(id)),
                 config: createRequestConfig({
-                  query: maybeEnableSourceMaps(normalizeSelect(query))
+                  query: prepareQuery(query)
                 })
               }));
             case 4:
@@ -9776,9 +9840,9 @@ var contentful = (function (exports) {
               _context17.prev = 0;
               return _context17.abrupt("return", get({
                 context: 'environment',
-                path: 'assets',
+                path: maybeEnableTimelinePreview('assets'),
                 config: createRequestConfig({
-                  query: maybeEnableSourceMaps(normalizeSearchParameters(normalizeSelect(query)))
+                  query: prepareQuery(query)
                 })
               }));
             case 4:
@@ -10117,7 +10181,7 @@ var contentful = (function (exports) {
       http.defaults.baseURL = getGlobalOptions().environmentBaseUrl;
     }
     return {
-      version: "11.5.25",
+      version: "11.7.0",
       getSpace: getSpace,
       getContentType: getContentType,
       getContentTypes: getContentTypes,
@@ -10244,7 +10308,7 @@ var contentful = (function (exports) {
       environment: 'master'
     };
     var config = Object.assign(Object.assign({}, defaultConfig), params);
-    var userAgentHeader = getUserAgentHeader("contentful.js/".concat("11.5.25"), config.application, config.integration);
+    var userAgentHeader = getUserAgentHeader("contentful.js/".concat("11.7.0"), config.application, config.integration);
     config.headers = Object.assign(Object.assign({}, config.headers), {
       'Content-Type': 'application/vnd.contentful.delivery.v1+json',
       'X-Contentful-User-Agent': userAgentHeader