@tryghost/content-api 1.9.8 → 1.11.0

package/cjs/content-api.js

@@ -3,7 +3,7 @@
 var axios = require('axios');
 
 var name$1 = "@tryghost/content-api";
-var version = "1.9.8";
+var version = "1.11.0";
 var repository = "https://github.com/TryGhost/SDK/tree/master/packages/content-api";
 var author = "Ghost Foundation";
 var license = "MIT";
@@ -32,18 +32,19 @@ var publishConfig = {
 	access: "public"
 };
 var devDependencies = {
-	"@babel/core": "7.17.10",
+	"@babel/core": "7.18.2",
 	"@babel/polyfill": "7.12.1",
-	"@babel/preset-env": "7.17.10",
+	"@babel/preset-env": "7.18.2",
 	"@rollup/plugin-json": "4.1.0",
 	c8: "7.11.3",
-	"core-js": "3.22.5",
+	"core-js": "3.22.7",
 	"eslint-plugin-ghost": "2.14.0",
 	mocha: "10.0.0",
-	rollup: "2.73.0",
+	rollup: "2.75.4",
 	"rollup-plugin-babel": "4.4.0",
 	"rollup-plugin-commonjs": "10.1.0",
 	"rollup-plugin-node-resolve": "5.2.0",
+	"rollup-plugin-polyfill-node": "0.9.0",
 	"rollup-plugin-replace": "2.2.0",
 	"rollup-plugin-terser": "7.0.2",
 	should: "13.2.3",
@@ -52,7 +53,7 @@ var devDependencies = {
 var dependencies = {
 	axios: "^0.27.0"
 };
-var gitHead = "31e2a37039377b1c785be278a78085cbf0a494f1";
+var gitHead = "a1f560e288bf67886483f9b5d483eecd749c09cc";
 var packageInfo = {
 	name: name$1,
 	version: version,
@@ -72,10 +73,12 @@ var packageInfo = {
 	gitHead: gitHead
 };
 
+// @NOTE: this value is dynamically replaced based on browser/node environment
+const USER_AGENT_DEFAULT = true;
+
 const packageVersion = packageInfo.version;
 
-// NOTE: bump this default when Ghost v5 is released
-const defaultAcceptVersionHeader = 'v4.0';
+const defaultAcceptVersionHeader = 'v5.0';
 const supportedVersions = ['v2', 'v3', 'v4', 'v5', 'canary'];
 const name = '@tryghost/content-api';
 
@@ -122,10 +125,11 @@ const defaultMakeRequest = ({url, method, params, headers}) => {
  * @param {String} options.key
  * @param {String} [options.ghostPath]
  * @param {String|Boolean} options.version - a version string like v3, v4, v5 or boolean value identifying presence of Accept-Version header
+ * @param {String|Boolean} [options.userAgent] - value controlling the 'User-Agent' header should be sent with a request
  * @param {Function} [options.makeRequest]
  * @param {String} [options.host] Deprecated
  */
-function GhostContentAPI({url, key, host, version, ghostPath = 'ghost', makeRequest = defaultMakeRequest}) {
+function GhostContentAPI({url, key, host, version, userAgent, ghostPath = 'ghost', makeRequest = defaultMakeRequest}) {
     /**
      * host parameter is deprecated
      * @deprecated use "url" instead
@@ -139,7 +143,7 @@ function GhostContentAPI({url, key, host, version, ghostPath = 'ghost', makeRequ
     }
 
     if (this instanceof GhostContentAPI) {
-        return GhostContentAPI({url, key, version, ghostPath, makeRequest});
+        return GhostContentAPI({url, key, version, userAgent, ghostPath, makeRequest});
     }
 
     if (version === undefined) {
@@ -185,7 +189,12 @@ function GhostContentAPI({url, key, host, version, ghostPath = 'ghost', makeRequ
     if (key && !/[0-9a-f]{26}/.test(key)) {
         throw new Error(`${name} Config Invalid: 'key' ${key} must have 26 hex characters`);
     }
-    const api = ['posts', 'authors', 'tags', 'pages', 'settings'].reduce((apiObject, resourceType) => {
+
+    if (userAgent === undefined) {
+        userAgent = USER_AGENT_DEFAULT;
+    }
+
+    const api = ['posts', 'authors', 'tags', 'pages', 'settings', 'tiers', 'newsletters', 'offers'].reduce((apiObject, resourceType) => {
         function browse(options = {}, memberToken) {
             return makeApiRequest(resourceType, options, null, memberToken);
         }
@@ -207,7 +216,11 @@ function GhostContentAPI({url, key, host, version, ghostPath = 'ghost', makeRequ
         });
     }, {});
 
+    // Settings, tiers & newsletters only have browse methods, offers only has read
     delete api.settings.read;
+    delete api.tiers.read;
+    delete api.newsletters.read;
+    delete api.offers.browse;
 
     return api;
 
@@ -223,7 +236,14 @@ function GhostContentAPI({url, key, host, version, ghostPath = 'ghost', makeRequ
             Authorization: `GhostMembers ${membersToken}`
         } : {};
 
-        headers['User-Agent'] = `GhostContentSDK/${packageVersion}`;
+        if (userAgent) {
+            if (typeof userAgent === 'boolean') {
+                headers['User-Agent'] = `GhostContentSDK/${packageVersion}`;
+            } else {
+                headers['User-Agent'] = userAgent;
+            }
+        }
+
         if (acceptVersionHeader) {
             headers['Accept-Version'] = acceptVersionHeader;
         }