contentful 11.5.25 → 11.7.0

package/dist/contentful.cjs

@@ -22545,6 +22545,34 @@ function validateTimestamp(name, timestamp, options) {
   }
 }
 
+function isValidRelease(release) {
+  return !!(release && typeof release === 'object' && typeof release.lte === 'string');
+}
+function isValidTimestamp(timestamp) {
+  return !!(timestamp && typeof timestamp === 'object' && (typeof timestamp.lte === 'string' || timestamp.lte instanceof Date));
+}
+const isValidTimelinePreviewConfig = timelinePreview => {
+  if (typeof timelinePreview !== 'object' || timelinePreview === null || Array.isArray(timelinePreview)) {
+    throw new ValidationError('timelinePreview', `The 'timelinePreview' parameter must be an object.`);
+  }
+  const hasRelease = isValidRelease(timelinePreview.release);
+  const 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;
+};
+const getTimelinePreviewParams = params => {
+  var _a;
+  const host = params === null || params === void 0 ? void 0 : params.host;
+  const timelinePreview = (_a = params === null || params === void 0 ? void 0 : params.alphaFeatures) === null || _a === void 0 ? void 0 : _a.timelinePreview;
+  const enabled = checkEnableTimelinePreviewIsAllowed(host, timelinePreview);
+  return {
+    enabled,
+    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,
@@ -22592,6 +22620,18 @@ function checkIncludeContentSourceMapsParamIsAllowed(host, includeContentSourceM
   }
   return includeContentSourceMaps;
 }
+function checkEnableTimelinePreviewIsAllowed(host, timelinePreview) {
+  if (timelinePreview === undefined) {
+    return false;
+  }
+  const isValidConfig = isValidTimelinePreviewConfig(timelinePreview);
+  const 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.
+      `);
+  }
+  return true;
+}
 
 function validateSearchParameters(query) {
   for (const key in query) {
@@ -22657,6 +22697,27 @@ function createContentfulApi({
     }
     return query;
   }
+  function maybeEnableTimelinePreview(path) {
+    const {
+      enabled
+    } = getTimelinePreviewParams(http.httpClientParams);
+    return enabled ? `timeline/${path}` : path;
+  }
+  function maybeAddTimelinePreviewConfigToQuery(query) {
+    const {
+      enabled,
+      timelinePreview
+    } = getTimelinePreviewParams(http.httpClientParams);
+    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;
     const includeContentSourceMaps = (_a = config === null || config === void 0 ? void 0 : config.params) === null || _a === void 0 ? void 0 : _a.includeContentSourceMaps;
@@ -22768,6 +22829,12 @@ function createContentfulApi({
       locale: '*'
     }) : query, options);
   }
+  function prepareQuery(query) {
+    // First, add timeline preview config if enabled
+    const withTimelinePreview = maybeAddTimelinePreviewConfigToQuery(Object.assign({}, query));
+    // Then, apply source maps and other normalizations
+    return maybeEnableSourceMaps(normalizeSearchParameters(normalizeSelect(withTimelinePreview)));
+  }
   async function internalGetEntries(query, options) {
     const {
       withoutLinkResolution,
@@ -22776,9 +22843,9 @@ function createContentfulApi({
     try {
       const entries = await get({
         context: 'environment',
-        path: 'entries',
+        path: maybeEnableTimelinePreview('entries'),
         config: createRequestConfig({
-          query: maybeEnableSourceMaps(normalizeSearchParameters(normalizeSelect(query)))
+          query: prepareQuery(query)
         })
       });
       return resolveCircular(entries, {
@@ -22814,9 +22881,9 @@ function createContentfulApi({
     try {
       return get({
         context: 'environment',
-        path: `assets/${id}`,
+        path: maybeEnableTimelinePreview(`assets/${id}`),
         config: createRequestConfig({
-          query: maybeEnableSourceMaps(normalizeSelect(query))
+          query: prepareQuery(query)
         })
       });
     } catch (error) {
@@ -22842,9 +22909,9 @@ function createContentfulApi({
     try {
       return get({
         context: 'environment',
-        path: 'assets',
+        path: maybeEnableTimelinePreview('assets'),
         config: createRequestConfig({
-          query: maybeEnableSourceMaps(normalizeSearchParameters(normalizeSelect(query)))
+          query: prepareQuery(query)
         })
       });
     } catch (error) {
@@ -23003,7 +23070,7 @@ function createContentfulApi({
     http.defaults.baseURL = getGlobalOptions().environmentBaseUrl;
   }
   return {
-    version: "11.5.25",
+    version: "11.7.0",
     getSpace,
     getContentType,
     getContentTypes,
@@ -23126,7 +23193,7 @@ function createClient(params) {
     environment: 'master'
   };
   const config = Object.assign(Object.assign({}, defaultConfig), params);
-  const userAgentHeader = getUserAgentHeader(`contentful.js/${"11.5.25"}`, config.application, config.integration);
+  const userAgentHeader = getUserAgentHeader(`contentful.js/${"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

package/dist/esm/contentful.js

@@ -37,7 +37,7 @@ function createClient(params) {
         environment: 'master',
     };
     const config = Object.assign(Object.assign({}, defaultConfig), params);
-    const userAgentHeader = getUserAgentHeader(`contentful.js/${"11.5.25"}`, config.application, config.integration);
+    const userAgentHeader = getUserAgentHeader(`contentful.js/${"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 });
     const http = createHttpClient(axios, config);
     if (!http.defaults.baseURL) {

package/dist/esm/create-contentful-api.js

@@ -8,6 +8,7 @@ import getQuerySelectionSet from './utils/query-selection-set.js';
 import validateTimestamp from './utils/validate-timestamp.js';
 import { validateLocaleParam, validateResolveLinksParam, validateRemoveUnresolvedParam, checkIncludeContentSourceMapsParamIsAllowed } from './utils/validate-params.js';
 import validateSearchParameters from './utils/validate-search-parameters.js';
+import { getTimelinePreviewParams } from './utils/timeline-preview-helpers.js';
 
 /**
  * Contentful Delivery API Client. Contains methods which allow access to the
@@ -60,6 +61,22 @@ function createContentfulApi({ http, getGlobalOptions }, options) {
         }
         return query;
     }
+    function maybeEnableTimelinePreview(path) {
+        const { enabled } = getTimelinePreviewParams(http.httpClientParams);
+        return enabled ? `timeline/${path}` : path;
+    }
+    function maybeAddTimelinePreviewConfigToQuery(query) {
+        const { enabled, timelinePreview } = getTimelinePreviewParams(http.httpClientParams);
+        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;
         const includeContentSourceMaps = (_a = config === null || config === void 0 ? void 0 : config.params) === null || _a === void 0 ? void 0 : _a.includeContentSourceMaps;
@@ -152,14 +169,20 @@ function createContentfulApi({ http, getGlobalOptions }, options) {
         return internalGetEntries(withAllLocales
             ? Object.assign(Object.assign({}, query), { locale: '*' }) : query, options);
     }
+    function prepareQuery(query) {
+        // First, add timeline preview config if enabled
+        const withTimelinePreview = maybeAddTimelinePreviewConfigToQuery(Object.assign({}, query));
+        // Then, apply source maps and other normalizations
+        return maybeEnableSourceMaps(normalizeSearchParameters(normalizeSelect(withTimelinePreview)));
+    }
     async function internalGetEntries(query, options) {
         const { withoutLinkResolution, withoutUnresolvableLinks } = options;
         try {
             const entries = await get({
                 context: 'environment',
-                path: 'entries',
+                path: maybeEnableTimelinePreview('entries'),
                 config: createRequestConfig({
-                    query: maybeEnableSourceMaps(normalizeSearchParameters(normalizeSelect(query))),
+                    query: prepareQuery(query),
                 }),
             });
             return resolveCircular(entries, {
@@ -192,8 +215,8 @@ function createContentfulApi({ http, getGlobalOptions }, options) {
         try {
             return get({
                 context: 'environment',
-                path: `assets/${id}`,
-                config: createRequestConfig({ query: maybeEnableSourceMaps(normalizeSelect(query)) }),
+                path: maybeEnableTimelinePreview(`assets/${id}`),
+                config: createRequestConfig({ query: prepareQuery(query) }),
             });
         }
         catch (error) {
@@ -215,9 +238,9 @@ function createContentfulApi({ http, getGlobalOptions }, options) {
         try {
             return get({
                 context: 'environment',
-                path: 'assets',
+                path: maybeEnableTimelinePreview('assets'),
                 config: createRequestConfig({
-                    query: maybeEnableSourceMaps(normalizeSearchParameters(normalizeSelect(query))),
+                    query: prepareQuery(query),
                 }),
             });
         }
@@ -368,7 +391,7 @@ function createContentfulApi({ http, getGlobalOptions }, options) {
         http.defaults.baseURL = getGlobalOptions().environmentBaseUrl;
     }
     return {
-        version: "11.5.25",
+        version: "11.7.0",
         getSpace,
         getContentType,
         getContentTypes,

package/dist/esm/utils/timeline-preview-helpers.js

@@ -0,0 +1,33 @@
+import { checkEnableTimelinePreviewIsAllowed } from './validate-params.js';
+import { ValidationError } from './validation-error.js';
+
+function isValidRelease(release) {
+    return !!(release && typeof release === 'object' && typeof release.lte === 'string');
+}
+function isValidTimestamp(timestamp) {
+    return !!(timestamp &&
+        typeof timestamp === 'object' &&
+        (typeof timestamp.lte === 'string' || timestamp.lte instanceof Date));
+}
+const isValidTimelinePreviewConfig = (timelinePreview) => {
+    if (typeof timelinePreview !== 'object' ||
+        timelinePreview === null ||
+        Array.isArray(timelinePreview)) {
+        throw new ValidationError('timelinePreview', `The 'timelinePreview' parameter must be an object.`);
+    }
+    const hasRelease = isValidRelease(timelinePreview.release);
+    const 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;
+};
+const getTimelinePreviewParams = (params) => {
+    var _a;
+    const host = params === null || params === void 0 ? void 0 : params.host;
+    const timelinePreview = (_a = params === null || params === void 0 ? void 0 : params.alphaFeatures) === null || _a === void 0 ? void 0 : _a.timelinePreview;
+    const enabled = checkEnableTimelinePreviewIsAllowed(host, timelinePreview);
+    return { enabled, timelinePreview };
+};
+
+export { getTimelinePreviewParams, isValidTimelinePreviewConfig };

package/dist/esm/utils/validate-params.js

@@ -1,3 +1,4 @@
+import { isValidTimelinePreviewConfig } from './timeline-preview-helpers.js';
 import { ValidationError } from './validation-error.js';
 
 function checkLocaleParamIsAll(query) {
@@ -48,5 +49,17 @@ function checkIncludeContentSourceMapsParamIsAllowed(host, includeContentSourceM
     }
     return includeContentSourceMaps;
 }
+function checkEnableTimelinePreviewIsAllowed(host, timelinePreview) {
+    if (timelinePreview === undefined) {
+        return false;
+    }
+    const isValidConfig = isValidTimelinePreviewConfig(timelinePreview);
+    const 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.
+      `);
+    }
+    return true;
+}
 
-export { checkIncludeContentSourceMapsParamIsAllowed, validateLocaleParam, validateRemoveUnresolvedParam, validateResolveLinksParam };
+export { checkEnableTimelinePreviewIsAllowed, checkIncludeContentSourceMapsParamIsAllowed, validateLocaleParam, validateRemoveUnresolvedParam, validateResolveLinksParam };