@tryghost/content-api 1.10.1 → 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.10.1";
+var version = "1.11.0";
 var repository = "https://github.com/TryGhost/SDK/tree/master/packages/content-api";
 var author = "Ghost Foundation";
 var license = "MIT";
@@ -40,11 +40,11 @@ var devDependencies = {
 	"core-js": "3.22.7",
 	"eslint-plugin-ghost": "2.14.0",
 	mocha: "10.0.0",
-	rollup: "2.74.1",
+	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-polyfill-node": "0.9.0",
 	"rollup-plugin-replace": "2.2.0",
 	"rollup-plugin-terser": "7.0.2",
 	should: "13.2.3",
@@ -53,7 +53,7 @@ var devDependencies = {
 var dependencies = {
 	axios: "^0.27.0"
 };
-var gitHead = "ce790579ad1f191b24c05733d8a0a56f0b9f96d2";
+var gitHead = "a1f560e288bf67886483f9b5d483eecd749c09cc";
 var packageInfo = {
 	name: name$1,
 	version: version,
@@ -73,6 +73,9 @@ var packageInfo = {
 	gitHead: gitHead
 };
 
+// @NOTE: this value is dynamically replaced based on browser/node environment
+const USER_AGENT_DEFAULT = true;
+
 const packageVersion = packageInfo.version;
 
 const defaultAcceptVersionHeader = 'v5.0';
@@ -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,6 +189,11 @@ 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`);
     }
+
+    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);
@@ -227,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;
         }

package/es/content-api.js

@@ -6008,7 +6008,7 @@ axios_1.default = default_1;
 var axios = axios_1;
 
 var name$1 = "@tryghost/content-api";
-var version = "1.10.1";
+var version = "1.11.0";
 var repository = "https://github.com/TryGhost/SDK/tree/master/packages/content-api";
 var author = "Ghost Foundation";
 var license = "MIT";
@@ -6045,11 +6045,11 @@ var devDependencies = {
 	"core-js": "3.22.7",
 	"eslint-plugin-ghost": "2.14.0",
 	mocha: "10.0.0",
-	rollup: "2.74.1",
+	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-polyfill-node": "0.9.0",
 	"rollup-plugin-replace": "2.2.0",
 	"rollup-plugin-terser": "7.0.2",
 	should: "13.2.3",
@@ -6058,7 +6058,7 @@ var devDependencies = {
 var dependencies = {
 	axios: "^0.27.0"
 };
-var gitHead = "ce790579ad1f191b24c05733d8a0a56f0b9f96d2";
+var gitHead = "a1f560e288bf67886483f9b5d483eecd749c09cc";
 var packageInfo = {
 	name: name$1,
 	version: version,
@@ -6078,6 +6078,7 @@ var packageInfo = {
 	gitHead: gitHead
 };
 
+var USER_AGENT_DEFAULT = false;
 var packageVersion = packageInfo.version;
 var defaultAcceptVersionHeader = 'v5.0';
 var supportedVersions = ['v2', 'v3', 'v4', 'v5', 'canary'];
@@ -6128,6 +6129,7 @@ var defaultMakeRequest = function defaultMakeRequest(_ref) {
  * @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
  */
@@ -6138,6 +6140,7 @@ function GhostContentAPI(_ref2) {
       key = _ref2.key,
       host = _ref2.host,
       version = _ref2.version,
+      userAgent = _ref2.userAgent,
       _ref2$ghostPath = _ref2.ghostPath,
       ghostPath = _ref2$ghostPath === void 0 ? 'ghost' : _ref2$ghostPath,
       _ref2$makeRequest = _ref2.makeRequest,
@@ -6161,6 +6164,7 @@ function GhostContentAPI(_ref2) {
       url: url,
       key: key,
       version: version,
+      userAgent: userAgent,
       ghostPath: ghostPath,
       makeRequest: makeRequest
     });
@@ -6214,6 +6218,10 @@ function GhostContentAPI(_ref2) {
     throw new Error("".concat(name, " Config Invalid: 'key' ").concat(key, " must have 26 hex characters"));
   }
 
+  if (userAgent === undefined) {
+    userAgent = USER_AGENT_DEFAULT;
+  }
+
   var api = ['posts', 'authors', 'tags', 'pages', 'settings', 'tiers', 'newsletters', 'offers'].reduce(function (apiObject, resourceType) {
     function browse() {
       var options = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
@@ -6256,7 +6264,14 @@ function GhostContentAPI(_ref2) {
     var headers = membersToken ? {
       Authorization: "GhostMembers ".concat(membersToken)
     } : {};
-    headers['User-Agent'] = "GhostContentSDK/".concat(packageVersion);
+
+    if (userAgent) {
+      if (typeof userAgent === 'boolean') {
+        headers['User-Agent'] = "GhostContentSDK/".concat(packageVersion);
+      } else {
+        headers['User-Agent'] = userAgent;
+      }
+    }
 
     if (acceptVersionHeader) {
       headers['Accept-Version'] = acceptVersionHeader;