contentful 11.11.1 → 11.12.0

package/README.md

@@ -340,12 +340,13 @@ When initialising a client, you will receive an instance of the [`ContentfulClie
 
 #### Entries
 
-| Chain                      | Modifier                                                                                                                                                                                         |
-| -------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| _none (default)_           | Returns entries in a single locale. Resolvable linked entries will be inlined while unresolvable links will be kept as link objects. [Read more on link resolution](ADVANCED.md#link-resolution) |
-| `withAllLocales`           | Returns entries in all locales.                                                                                                                                                                  |
-| `withoutLinkResolution`    | All linked entries will be rendered as link objects. [Read more on link resolution](ADVANCED.md#link-resolution)                                                                                 |
-| `withoutUnresolvableLinks` | If linked entries are not resolvable, the corresponding link objects are removed from the response.                                                                                              |
+| Chain                       | Modifier                                                                                                                                                                                         |
+| --------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| _none (default)_            | Returns entries in a single locale. Resolvable linked entries will be inlined while unresolvable links will be kept as link objects. [Read more on link resolution](ADVANCED.md#link-resolution) |
+| `withAllLocales`            | Returns entries in all locales.                                                                                                                                                                  |
+| `withoutLinkResolution`     | All linked entries will be rendered as link objects. [Read more on link resolution](ADVANCED.md#link-resolution)                                                                                 |
+| `withoutUnresolvableLinks`  | If linked entries are not resolvable, the corresponding link objects are removed from the response.                                                                                              |
+| `withLocaleBasedPublishing` | Fetched entries & assets will be returned with only content from published locales.                                                                                                              |
 
 ##### Example
 

package/dist/contentful.browser.js

@@ -10009,7 +10009,8 @@ var contentful = (function (exports) {
               options = _args9.length > 2 && _args9[2] !== undefined ? _args9[2] : {
                 withAllLocales: false,
                 withoutLinkResolution: false,
-                withoutUnresolvableLinks: false
+                withoutUnresolvableLinks: false,
+                withLocaleBasedPublishing: false
               };
               withAllLocales = options.withAllLocales;
               validateLocaleParam(query, withAllLocales);
@@ -10085,7 +10086,8 @@ var contentful = (function (exports) {
               options = _args11.length > 1 && _args11[1] !== undefined ? _args11[1] : {
                 withAllLocales: false,
                 withoutLinkResolution: false,
-                withoutUnresolvableLinks: false
+                withoutUnresolvableLinks: false,
+                withLocaleBasedPublishing: false
               };
               withAllLocales = options.withAllLocales;
               validateLocaleParam(query, withAllLocales);
@@ -10114,35 +10116,42 @@ var contentful = (function (exports) {
     }
     function _internalGetEntries() {
       _internalGetEntries = _asyncToGenerator(/*#__PURE__*/_regeneratorRuntime.mark(function _callee12(query, options) {
-        var withoutLinkResolution, withoutUnresolvableLinks, entries;
+        var withoutLinkResolution, withoutUnresolvableLinks, withLocaleBasedPublishing, baseConfig, config, entries;
         return _regeneratorRuntime.wrap(function _callee12$(_context12) {
           while (1) switch (_context12.prev = _context12.next) {
             case 0:
-              withoutLinkResolution = options.withoutLinkResolution, withoutUnresolvableLinks = options.withoutUnresolvableLinks;
+              withoutLinkResolution = options.withoutLinkResolution, withoutUnresolvableLinks = options.withoutUnresolvableLinks, withLocaleBasedPublishing = options.withLocaleBasedPublishing;
               _context12.prev = 1;
-              _context12.next = 4;
+              baseConfig = createRequestConfig({
+                query: prepareQuery(query)
+              });
+              config = baseConfig;
+              if (withLocaleBasedPublishing) {
+                config.headers = Object.assign(Object.assign({}, config.headers), {
+                  'X-Contentful-Locale-Based-Publishing': true
+                });
+              }
+              _context12.next = 7;
               return get({
                 context: 'environment',
                 path: maybeEnableTimelinePreview('entries'),
-                config: createRequestConfig({
-                  query: prepareQuery(query)
-                })
+                config: config
               });
-            case 4:
+            case 7:
               entries = _context12.sent;
               return _context12.abrupt("return", resolveCircular(entries, {
                 resolveLinks: !withoutLinkResolution,
                 removeUnresolved: withoutUnresolvableLinks !== null && withoutUnresolvableLinks !== void 0 ? withoutUnresolvableLinks : false
               }));
-            case 8:
-              _context12.prev = 8;
+            case 11:
+              _context12.prev = 11;
               _context12.t0 = _context12["catch"](1);
               errorHandler(_context12.t0);
-            case 11:
+            case 14:
             case "end":
               return _context12.stop();
           }
-        }, _callee12, null, [[1, 8]]);
+        }, _callee12, null, [[1, 11]]);
       }));
       return _internalGetEntries.apply(this, arguments);
     }
@@ -10226,7 +10235,8 @@ var contentful = (function (exports) {
               options = _args16.length > 1 && _args16[1] !== undefined ? _args16[1] : {
                 withAllLocales: false,
                 withoutLinkResolution: false,
-                withoutUnresolvableLinks: false
+                withoutUnresolvableLinks: false,
+                withLocaleBasedPublishing: false
               };
               withAllLocales = options.withAllLocales;
               validateLocaleParam(query, withAllLocales);
@@ -10234,7 +10244,7 @@ var contentful = (function (exports) {
               localeSpecificQuery = withAllLocales ? Object.assign(Object.assign({}, query), {
                 locale: '*'
               }) : query;
-              return _context16.abrupt("return", internalGetAssets(localeSpecificQuery));
+              return _context16.abrupt("return", internalGetAssets(localeSpecificQuery, options));
             case 6:
             case "end":
               return _context16.stop();
@@ -10243,35 +10253,44 @@ var contentful = (function (exports) {
       }));
       return _makeGetAssets.apply(this, arguments);
     }
-    function internalGetAsset(_x15, _x16) {
+    function internalGetAsset(_x15, _x16, _x17) {
       return _internalGetAsset.apply(this, arguments);
     }
     function _internalGetAsset() {
-      _internalGetAsset = _asyncToGenerator(/*#__PURE__*/_regeneratorRuntime.mark(function _callee17(id, query) {
+      _internalGetAsset = _asyncToGenerator(/*#__PURE__*/_regeneratorRuntime.mark(function _callee17(id, query, options) {
+        var withLocaleBasedPublishing, baseConfig, config;
         return _regeneratorRuntime.wrap(function _callee17$(_context17) {
           while (1) switch (_context17.prev = _context17.next) {
             case 0:
-              _context17.prev = 0;
+              withLocaleBasedPublishing = options.withLocaleBasedPublishing;
+              _context17.prev = 1;
+              baseConfig = createRequestConfig({
+                query: prepareQuery(query)
+              });
+              config = baseConfig;
+              if (withLocaleBasedPublishing) {
+                config.headers = Object.assign(Object.assign({}, config.headers), {
+                  'X-Contentful-Locale-Based-Publishing': true
+                });
+              }
               return _context17.abrupt("return", get({
                 context: 'environment',
                 path: maybeEnableTimelinePreview("assets/".concat(id)),
-                config: createRequestConfig({
-                  query: prepareQuery(query)
-                })
+                config: config
               }));
-            case 4:
-              _context17.prev = 4;
-              _context17.t0 = _context17["catch"](0);
+            case 8:
+              _context17.prev = 8;
+              _context17.t0 = _context17["catch"](1);
               errorHandler(_context17.t0);
-            case 7:
+            case 11:
             case "end":
               return _context17.stop();
           }
-        }, _callee17, null, [[0, 4]]);
+        }, _callee17, null, [[1, 8]]);
       }));
       return _internalGetAsset.apply(this, arguments);
     }
-    function makeGetAsset(_x17, _x18) {
+    function makeGetAsset(_x18, _x19) {
       return _makeGetAsset.apply(this, arguments);
     }
     function _makeGetAsset() {
@@ -10286,7 +10305,8 @@ var contentful = (function (exports) {
               options = _args18.length > 2 && _args18[2] !== undefined ? _args18[2] : {
                 withAllLocales: false,
                 withoutLinkResolution: false,
-                withoutUnresolvableLinks: false
+                withoutUnresolvableLinks: false,
+                withLocaleBasedPublishing: false
               };
               withAllLocales = options.withAllLocales;
               validateLocaleParam(query, withAllLocales);
@@ -10294,7 +10314,7 @@ var contentful = (function (exports) {
               localeSpecificQuery = withAllLocales ? Object.assign(Object.assign({}, query), {
                 locale: '*'
               }) : query;
-              return _context18.abrupt("return", internalGetAsset(id, localeSpecificQuery));
+              return _context18.abrupt("return", internalGetAsset(id, localeSpecificQuery, options));
             case 6:
             case "end":
               return _context18.stop();
@@ -10303,35 +10323,44 @@ var contentful = (function (exports) {
       }));
       return _makeGetAsset.apply(this, arguments);
     }
-    function internalGetAssets(_x19) {
+    function internalGetAssets(_x20, _x21) {
       return _internalGetAssets.apply(this, arguments);
     }
     function _internalGetAssets() {
-      _internalGetAssets = _asyncToGenerator(/*#__PURE__*/_regeneratorRuntime.mark(function _callee19(query) {
+      _internalGetAssets = _asyncToGenerator(/*#__PURE__*/_regeneratorRuntime.mark(function _callee19(query, options) {
+        var withLocaleBasedPublishing, baseConfig, config;
         return _regeneratorRuntime.wrap(function _callee19$(_context19) {
           while (1) switch (_context19.prev = _context19.next) {
             case 0:
-              _context19.prev = 0;
+              withLocaleBasedPublishing = options.withLocaleBasedPublishing;
+              _context19.prev = 1;
+              baseConfig = createRequestConfig({
+                query: prepareQuery(query)
+              });
+              config = baseConfig;
+              if (withLocaleBasedPublishing) {
+                config.headers = Object.assign(Object.assign({}, config.headers), {
+                  'X-Contentful-Locale-Based-Publishing': true
+                });
+              }
               return _context19.abrupt("return", get({
                 context: 'environment',
                 path: maybeEnableTimelinePreview('assets'),
-                config: createRequestConfig({
-                  query: prepareQuery(query)
-                })
+                config: config
               }));
-            case 4:
-              _context19.prev = 4;
-              _context19.t0 = _context19["catch"](0);
+            case 8:
+              _context19.prev = 8;
+              _context19.t0 = _context19["catch"](1);
               errorHandler(_context19.t0);
-            case 7:
+            case 11:
             case "end":
               return _context19.stop();
           }
-        }, _callee19, null, [[0, 4]]);
+        }, _callee19, null, [[1, 8]]);
       }));
       return _internalGetAssets.apply(this, arguments);
     }
-    function getTag(_x20) {
+    function getTag(_x22) {
       return _getTag.apply(this, arguments);
     }
     function _getTag() {
@@ -10378,7 +10407,7 @@ var contentful = (function (exports) {
       }));
       return _getTags.apply(this, arguments);
     }
-    function createAssetKey(_x21) {
+    function createAssetKey(_x23) {
       return _createAssetKey.apply(this, arguments);
     }
     function _createAssetKey() {
@@ -10439,7 +10468,7 @@ var contentful = (function (exports) {
       }));
       return _getLocales.apply(this, arguments);
     }
-    function sync(_x22) {
+    function sync(_x24) {
       return _sync.apply(this, arguments);
     }
     function _sync() {
@@ -10461,7 +10490,7 @@ var contentful = (function (exports) {
       }));
       return _sync.apply(this, arguments);
     }
-    function makePagedSync(_x23, _x24) {
+    function makePagedSync(_x25, _x26) {
       return _makePagedSync.apply(this, arguments);
     }
     function _makePagedSync() {
@@ -10475,7 +10504,8 @@ var contentful = (function (exports) {
               options = _args25.length > 2 && _args25[2] !== undefined ? _args25[2] : {
                 withAllLocales: false,
                 withoutLinkResolution: false,
-                withoutUnresolvableLinks: false
+                withoutUnresolvableLinks: false,
+                withLocaleBasedPublishing: false
               };
               validateResolveLinksParam(query);
               validateRemoveUnresolvedParam(query);
@@ -10496,8 +10526,7 @@ var contentful = (function (exports) {
     function makeParseEntries(data) {
       var options = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {
         withoutLinkResolution: false,
-        withoutUnresolvableLinks: false
-      };
+        withoutUnresolvableLinks: false};
       return internalParseEntries(data, options);
     }
     function internalParseEntries(data, options) {
@@ -10512,7 +10541,7 @@ var contentful = (function (exports) {
       var query = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
       return internalGetConceptScheme(id, query);
     }
-    function internalGetConceptScheme(_x25) {
+    function internalGetConceptScheme(_x27) {
       return _internalGetConceptScheme.apply(this, arguments);
     }
     function _internalGetConceptScheme() {
@@ -10582,7 +10611,7 @@ var contentful = (function (exports) {
       var query = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
       return internalGetConcept(id, query);
     }
-    function internalGetConcept(_x26) {
+    function internalGetConcept(_x28) {
       return _internalGetConcept.apply(this, arguments);
     }
     function _internalGetConcept() {
@@ -10652,7 +10681,7 @@ var contentful = (function (exports) {
       var query = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
       return internalGetConceptAncestors(id, query);
     }
-    function internalGetConceptAncestors(_x27) {
+    function internalGetConceptAncestors(_x29) {
       return _internalGetConceptAncestors.apply(this, arguments);
     }
     function _internalGetConceptAncestors() {
@@ -10687,7 +10716,7 @@ var contentful = (function (exports) {
       var query = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
       return internalGetConceptDescendants(id, query);
     }
-    function internalGetConceptDescendants(_x28) {
+    function internalGetConceptDescendants(_x30) {
       return _internalGetConceptDescendants.apply(this, arguments);
     }
     /*
@@ -10779,6 +10808,13 @@ var contentful = (function (exports) {
         }));
       }
     });
+    Object.defineProperty(response, 'withLocaleBasedPublishing', {
+      get: function get() {
+        return makeInnerClient(Object.assign(Object.assign({}, options), {
+          withLocaleBasedPublishing: true
+        }));
+      }
+    });
     return Object.create(response);
   }
   var makeClient = function makeClient(_ref2) {
@@ -10796,28 +10832,40 @@ var contentful = (function (exports) {
     }, {
       withoutLinkResolution: false,
       withAllLocales: false,
-      withoutUnresolvableLinks: false
+      withoutUnresolvableLinks: false,
+      withLocaleBasedPublishing: false
     });
     return Object.assign(Object.assign({}, client), {
       get withAllLocales() {
         return makeInnerClient({
           withAllLocales: true,
           withoutLinkResolution: false,
-          withoutUnresolvableLinks: false
+          withoutUnresolvableLinks: false,
+          withLocaleBasedPublishing: false
         });
       },
       get withoutLinkResolution() {
         return makeInnerClient({
           withAllLocales: false,
           withoutLinkResolution: true,
-          withoutUnresolvableLinks: false
+          withoutUnresolvableLinks: false,
+          withLocaleBasedPublishing: false
         });
       },
       get withoutUnresolvableLinks() {
         return makeInnerClient({
           withAllLocales: false,
           withoutLinkResolution: false,
-          withoutUnresolvableLinks: true
+          withoutUnresolvableLinks: true,
+          withLocaleBasedPublishing: false
+        });
+      },
+      get withLocaleBasedPublishing() {
+        return makeInnerClient({
+          withAllLocales: false,
+          withoutLinkResolution: false,
+          withoutUnresolvableLinks: false,
+          withLocaleBasedPublishing: true
         });
       }
     });