@tryghost/content-api 1.7.3 → 1.9.1

package/cjs/content-api.js

@@ -2,9 +2,106 @@
 
 var axios = require('axios');
 
+var name$1 = "@tryghost/content-api";
+var version = "1.9.1";
+var repository = "https://github.com/TryGhost/SDK/tree/master/packages/content-api";
+var author = "Ghost Foundation";
+var license = "MIT";
+var main = "cjs/content-api.js";
+var unpkg = "umd/content-api.min.js";
+var module$1 = "es/content-api.js";
+var source = "lib/index.js";
+var files = [
+	"LICENSE",
+	"README.md",
+	"cjs/",
+	"lib/",
+	"umd/",
+	"es/"
+];
+var scripts = {
+	dev: "echo \"Implement me!\"",
+	pretest: "yarn build",
+	test: "NODE_ENV=testing c8 --all --reporter text --reporter cobertura mocha './test/**/*.test.js'",
+	build: "rollup -c",
+	lint: "eslint . --ext .js --cache",
+	prepare: "NODE_ENV=production yarn build",
+	posttest: "yarn lint"
+};
+var publishConfig = {
+	access: "public"
+};
+var devDependencies = {
+	"@babel/core": "7.17.9",
+	"@babel/polyfill": "7.12.1",
+	"@babel/preset-env": "7.16.11",
+	"@rollup/plugin-json": "4.1.0",
+	c8: "7.11.0",
+	"core-js": "3.22.0",
+	"eslint-plugin-ghost": "1.5.0",
+	mocha: "7.2.0",
+	rollup: "2.70.2",
+	"rollup-plugin-babel": "4.4.0",
+	"rollup-plugin-commonjs": "10.1.0",
+	"rollup-plugin-node-resolve": "5.2.0",
+	"rollup-plugin-replace": "2.2.0",
+	"rollup-plugin-terser": "7.0.2",
+	should: "13.2.3",
+	sinon: "9.2.4"
+};
+var dependencies = {
+	axios: "^0.21.1"
+};
+var gitHead = "6c0165f2588537f0e00e76567c2ed2f526f7faff";
+var packageInfo = {
+	name: name$1,
+	version: version,
+	repository: repository,
+	author: author,
+	license: license,
+	main: main,
+	"umd:main": "umd/content-api.min.js",
+	unpkg: unpkg,
+	module: module$1,
+	source: source,
+	files: files,
+	scripts: scripts,
+	publishConfig: publishConfig,
+	devDependencies: devDependencies,
+	dependencies: dependencies,
+	gitHead: gitHead
+};
+
+const packageVersion = packageInfo.version;
+
+// 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';
 
+/**
+ * This method can go away in favor of only sending 'Accept-Version` headers
+ * once the Ghost API removes a concept of version from it's URLS (with Ghost v5)
+ *
+ * @param {string} [version] version in `v{major}` format
+ * @returns {string}
+ */
+const resolveAPIPrefix = (version) => {
+    let prefix;
+
+    // NOTE: the "version.match(/^v5\.\d+/)" expression should be changed to "version.match(/^v\d+\.\d+/)" once Ghost v5 is out
+    if (version === 'v5' || version === undefined || version.match(/^v5\.\d+/)) {
+        prefix = `/content/`;
+    } else if (version.match(/^v\d+\.\d+/)) {
+        const versionPrefix = /^(v\d+)\.\d+/.exec(version)[1];
+        prefix = `/${versionPrefix}/content/`;
+    } else {
+        prefix = `/${version}/content/`;
+    }
+
+    return prefix;
+};
+
 const defaultMakeRequest = ({url, method, params, headers}) => {
     return axios[method](url, {
         params,
@@ -24,7 +121,7 @@ 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
  */
@@ -45,9 +142,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'`);
     }
@@ -101,14 +223,13 @@ function GhostContentAPI({url, key, host, version, ghostPath = 'ghost', makeRequ
             Authorization: `GhostMembers ${membersToken}`
         } : {};
 
-        if (!version || ['v4', 'v5', 'canary'].includes(version)) {
-            headers['Accept-Version'] = version || 'v5';
+        headers['User-Agent'] = `GhostContentSDK/${packageVersion}`;
+        if (acceptVersionHeader) {
+            headers['Accept-Version'] = acceptVersionHeader;
         }
 
         params = Object.assign({key}, params);
-        const apiUrl = version
-            ? `${url}/${ghostPath}/api/${version}/content/${resourceType}/${id ? id + '/' : ''}`
-            : `${url}/${ghostPath}/api/content/${resourceType}/${id ? id + '/' : ''}`;
+        const apiUrl = `${url}/${ghostPath}/api${resolveAPIPrefix(version)}${resourceType}/${id ? id + '/' : ''}`;
 
         return makeRequest({
             url: apiUrl,