@tryghost/content-api 1.7.1 → 1.8.0

package/cjs/content-api.js

@@ -2,6 +2,8 @@
 
 var axios = require('axios');
 
+// NOTE: bump this default when Ghost v5 is released
+const defaultAcceptVersionHeader = 'v4.0';
 const supportedVersions = ['v2', 'v3', 'v4', 'v5', 'canary'];
 const name = '@tryghost/content-api';
 
@@ -24,10 +26,9 @@ const defaultMakeRequest = ({url, method, params, headers}) => {
  * @param {String} options.url
  * @param {String} options.key
  * @param {String} [options.ghostPath]
- * @param {String} [options.version]
+ * @param {String|Boolean} options.version - a version string like v3, v4, v5 or boolean value identifying presence of Accept-Version header
  * @param {Function} [options.makeRequest]
  * @param {String} [options.host] Deprecated
- * @returns
  */
 function GhostContentAPI({url, key, host, version, ghostPath = 'ghost', makeRequest = defaultMakeRequest}) {
     /**
@@ -46,9 +47,34 @@ function GhostContentAPI({url, key, host, version, ghostPath = 'ghost', makeRequ
         return GhostContentAPI({url, key, version, ghostPath, makeRequest});
     }
 
-    if (version && !supportedVersions.includes(version)) {
+    if (version === undefined) {
+        throw new Error(`${name} Config Missing: 'version' is required. E.g. ${supportedVersions.join(',')}`);
+    }
+
+    let acceptVersionHeader;
+    if (typeof version === 'boolean') {
+        if (version === true) {
+            acceptVersionHeader = defaultAcceptVersionHeader;
+        }
+        version = undefined;
+    } else if (version && !supportedVersions.includes(version) && !(version.match(/^v\d+\.\d+/))) {
         throw new Error(`${name} Config Invalid: 'version' ${version} is not supported`);
+    } else {
+        if (version === 'canary') {
+            // eslint-disable-next-line
+            console.warn(`${name}: The 'version' parameter has a deprecated format 'canary', please use 'v{major}.{minor}' format instead`);
+
+            acceptVersionHeader = defaultAcceptVersionHeader;
+        } else if (version.match(/^v\d+$/)) {
+            // eslint-disable-next-line
+            console.warn(`${name}: The 'version' parameter has a deprecated format 'v{major}', please use 'v{major}.{minor}' format instead`);
+
+            acceptVersionHeader = `${version}.0`;
+        } else {
+            acceptVersionHeader = version;
+        }
     }
+
     if (!url) {
         throw new Error(`${name} Config Missing: 'url' is required. E.g. 'https://site.com'`);
     }
@@ -102,8 +128,8 @@ function GhostContentAPI({url, key, host, version, ghostPath = 'ghost', makeRequ
             Authorization: `GhostMembers ${membersToken}`
         } : {};
 
-        if (!version || ['v4', 'v5', 'canary'].includes(version)) {
-            headers['Accept-Version'] = version || 'v5';
+        if (acceptVersionHeader) {
+            headers['Accept-Version'] = acceptVersionHeader;
         }
 
         params = Object.assign({key}, params);