@tryghost/content-api 1.6.1 → 1.7.0

package/cjs/content-api.js

@@ -2,11 +2,38 @@
 
 var axios = require('axios');
 
-const supportedVersions = ['v2', 'v3', 'v4', 'canary'];
+const supportedVersions = ['v2', 'v3', 'v4', 'v5', 'canary'];
 const name = '@tryghost/content-api';
 
-function GhostContentAPI({url, host, ghostPath = 'ghost', version, key}) {
-    // host parameter is deprecated
+const defaultMakeRequest = ({url, method, params, headers}) => {
+    return axios[method](url, {
+        params,
+        paramsSerializer: (parameters) => {
+            return Object.keys(parameters).reduce((parts, k) => {
+                const val = encodeURIComponent([].concat(parameters[k]).join(','));
+                return parts.concat(`${k}=${val}`);
+            }, []).join('&');
+        },
+        headers
+    });
+};
+
+/**
+ *
+ * @param {Object} options
+ * @param {String} options.url
+ * @param {String} options.key
+ * @param {String} [options.ghostPath]
+ * @param {String} [options.version]
+ * @param {Function} [options.makeRequest]
+ * @param {String} [options.host] Deprecated
+ * @returns
+ */
+function GhostContentAPI({url, key, host, version, ghostPath = 'ghost', makeRequest = defaultMakeRequest}) {
+    /**
+     * host parameter is deprecated
+     * @deprecated use "url" instead
+     */
     if (host) {
         // eslint-disable-next-line
         console.warn(`${name}: The 'host' parameter is deprecated, please use 'url' instead`);
@@ -16,13 +43,10 @@ function GhostContentAPI({url, host, ghostPath = 'ghost', version, key}) {
     }
 
     if (this instanceof GhostContentAPI) {
-        return GhostContentAPI({url, version, key});
+        return GhostContentAPI({url, key, version, ghostPath, makeRequest});
     }
 
-    if (!version) {
-        throw new Error(`${name} Config Missing: 'version' is required. E.g. ${supportedVersions.join(',')}`);
-    }
-    if (!supportedVersions.includes(version)) {
+    if (version && !supportedVersions.includes(version)) {
         throw new Error(`${name} Config Invalid: 'version' ${version} is not supported`);
     }
     if (!url) {
@@ -42,7 +66,7 @@ function GhostContentAPI({url, host, ghostPath = 'ghost', version, key}) {
     }
     const api = ['posts', 'authors', 'tags', 'pages', 'settings'].reduce((apiObject, resourceType) => {
         function browse(options = {}, memberToken) {
-            return makeRequest(resourceType, options, null, memberToken);
+            return makeApiRequest(resourceType, options, null, memberToken);
         }
         function read(data, options = {}, memberToken) {
             if (!data || !data.id && !data.slug) {
@@ -51,7 +75,7 @@ function GhostContentAPI({url, host, ghostPath = 'ghost', version, key}) {
 
             const params = Object.assign({}, data, options);
 
-            return makeRequest(resourceType, params, data.id || `slug/${data.slug}`, memberToken);
+            return makeApiRequest(resourceType, params, data.id || `slug/${data.slug}`, memberToken);
         }
 
         return Object.assign(apiObject, {
@@ -66,7 +90,7 @@ function GhostContentAPI({url, host, ghostPath = 'ghost', version, key}) {
 
     return api;
 
-    function makeRequest(resourceType, params, id, membersToken = null) {
+    function makeApiRequest(resourceType, params, id, membersToken = null) {
         if (!membersToken && !key) {
             return Promise.reject(
                 new Error(`${name} Config Missing: 'key' is required.`)
@@ -76,48 +100,54 @@ function GhostContentAPI({url, host, ghostPath = 'ghost', version, key}) {
 
         const headers = membersToken ? {
             Authorization: `GhostMembers ${membersToken}`
-        } : undefined;
-
-        return axios.get(`${url}/${ghostPath}/api/${version}/content/${resourceType}/${id ? id + '/' : ''}`, {
-            params: Object.assign({key}, params),
-            paramsSerializer: (parameters) => {
-                return Object.keys(parameters).reduce((parts, k) => {
-                    const val = encodeURIComponent([].concat(parameters[k]).join(','));
-                    return parts.concat(`${k}=${val}`);
-                }, []).join('&');
-            },
-            headers
-        }).then((res) => {
-            if (!Array.isArray(res.data[resourceType])) {
-                return res.data[resourceType];
-            }
-            if (res.data[resourceType].length === 1 && !res.data.meta) {
-                return res.data[resourceType][0];
-            }
-            return Object.assign(res.data[resourceType], {meta: res.data.meta});
-        }).catch((err) => {
-            if (err.response && err.response.data && err.response.data.errors) {
-                const props = err.response.data.errors[0];
-                const toThrow = new Error(props.message);
-                const keys = Object.keys(props);
-
-                toThrow.name = props.type;
+        } : {};
 
-                keys.forEach((k) => {
-                    toThrow[k] = props[k];
-                });
-
-                toThrow.response = err.response;
+        if (!version || ['v4', 'v5', 'canary'].includes(version)) {
+            headers['Accept-Version'] = version || 'v5';
+        }
 
-                // @TODO: remove in 2.0. We have enhanced the error handling, but we don't want to break existing implementations.
-                toThrow.request = err.request;
-                toThrow.config = err.config;
+        params = Object.assign({key}, params);
+        const apiUrl = version
+            ? `${url}/${ghostPath}/api/${version}/content/${resourceType}/${id ? id + '/' : ''}`
+            : `${url}/${ghostPath}/api/content/${resourceType}/${id ? id + '/' : ''}`;
 
-                throw toThrow;
-            } else {
-                throw err;
-            }
-        });
+        return makeRequest({
+            url: apiUrl,
+            method: 'get',
+            params,
+            headers
+        })
+            .then((res) => {
+                if (!Array.isArray(res.data[resourceType])) {
+                    return res.data[resourceType];
+                }
+                if (res.data[resourceType].length === 1 && !res.data.meta) {
+                    return res.data[resourceType][0];
+                }
+                return Object.assign(res.data[resourceType], {meta: res.data.meta});
+            }).catch((err) => {
+                if (err.response && err.response.data && err.response.data.errors) {
+                    const props = err.response.data.errors[0];
+                    const toThrow = new Error(props.message);
+                    const keys = Object.keys(props);
+
+                    toThrow.name = props.type;
+
+                    keys.forEach((k) => {
+                        toThrow[k] = props[k];
+                    });
+
+                    toThrow.response = err.response;
+
+                    // @TODO: remove in 2.0. We have enhanced the error handling, but we don't want to break existing implementations.
+                    toThrow.request = err.request;
+                    toThrow.config = err.config;
+
+                    throw toThrow;
+                } else {
+                    throw err;
+                }
+            });
     }
 }