added contentLinkDepth parameter to item, list, page calls

Author: jamesvidler

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "@agility/content-fetch",
-  "version": "0.5.1",
+  "version": "0.5.2",
   "description": "JavaScript library for the Agility Fetch API (node and browser)",
   "main": "dist/agility-content-fetch.node.js",
   "scripts": {

package.json

@@ -41,11 +41,12 @@ export default function createClient(userConfig) {
     }
 
     let adapter = null;
-
+    
     //should we turn on caching?
     if(config.caching.maxAge > 0) {
         const cache = setupCache({
-            maxAge: config.caching.maxAge
+            maxAge: config.caching.maxAge,
+            exclude: { query: false }
         });
         adapter = cache.adapter;
     }
@@ -65,7 +66,7 @@ export default function createClient(userConfig) {
                 data['fromCache'] = true;
             }
             return data;
-        });   
+        }); 
     }
 
     //export only these properties:

src/api-client.js

@@ -6,14 +6,15 @@ import { buildRequestUrlPath, buildAuthHeader } from '../utils'
  * @param {Object} requestParams - The paramters for the API request.
  * @param {number} requestParams.contentID - The contentID of the requested item in this language.
  * @param {string} requestParams.languageCode - The language code of the content you want to retrieve.
+ * @param {number} [requestParams.contentLinkDepth] - The depth, representing the levels in which you want linked content auto-resolved. Default is 1.
  * @returns {Promise<AgilityFetch.Types.ContentItem>} - Returns a content item object.
  * @example
  * 
  * import agility from '@agility/content-fetch'
  * 
  * const api = agility.getApi({
- *   guid: '191309ca-e675-4be2-bb29-351879528707',
- *   apiKey: 'aGd13M.fa30c36e553a36f871860407e902da9a7375322457acd6bcda038e60af699411',
+ *   guid: 'ade6cf3c',
+ *   apiKey: 'defaultlive.201ffdd0841cacad5bb647e76547e918b0c9ecdb8b5ddb3cf92e9a79b03623cb',
  * });
  * 
  * api.getContentItem({
@@ -29,12 +30,19 @@ import { buildRequestUrlPath, buildAuthHeader } from '../utils'
  * 
 */
 
+const defaultParams = {
+    contentLinkDepth: 1
+}
+
 function getContentItem(requestParams) {
 
     validateRequestParams(requestParams);
 
+    //merge default params with request params
+    requestParams = {...defaultParams, ...requestParams};
+
     const req = {
-        url: `/item/${requestParams.contentID}`,
+        url: `/item/${requestParams.contentID}?contentLinkDepth=${requestParams.contentLinkDepth}`,
         method: 'get',
         baseURL: buildRequestUrlPath(this.config, requestParams.languageCode),
         headers: buildAuthHeader(this.config),
@@ -50,6 +58,8 @@ function validateRequestParams(requestParams) {
     }
     else if(!requestParams.contentID) {
         throw new TypeError('You must include a contentID number in your request params.');
+    } else if(requestParams.contentLinkDepth && (isNaN(requestParams.contentLinkDepth) || request.contentLinkDepth < 0)) {
+        throw new TypeError('When specifying contentLinkDepth, it must be a number greater than 0.');
     } else {
         return;
     }

src/methods/getContentItem.js

@@ -6,6 +6,7 @@ import {buildPathUrl, buildRequestUrlPath, buildAuthHeader } from '../utils'
  * @param {Object} requestParams - The parameters for the API request.
  * @param {string} requestParams.referenceName - The unique reference name of the content list you wish to retrieve in the specified language.
  * @param {string} requestParams.languageCode - The language code of the content you want to retrieve.
+ * @param {number} [requestParams.contentLinkDepth] - The depth, representing the levels in which you want linked content auto-resolved. Default is 1.
  * @param {number} [requestParams.take] - The maximum number of items to retrieve in this request. Default is **10**. Maximum allowed is **50**.
  * @param {number} [requestParams.skip] - The number of items to skip from the list. Default is **0**. Used for implementing pagination.
  * @param {string} [requestParams.sort] - The field to sort the results by. Example *fields.title* or *properties.created*.
@@ -18,8 +19,8 @@ import {buildPathUrl, buildRequestUrlPath, buildAuthHeader } from '../utils'
  * import agility from '@agility/content-fetch'
  * 
  * const api = agility.getApi({
- *   guid: '191309ca-e675-4be2-bb29-351879528707',
- *   apiKey: 'aGd13M.fa30c36e553a36f871860407e902da9a7375322457acd6bcda038e60af699411',
+ *   guid: 'ade6cf3c',
+ *   apiKey: 'defaultlive.201ffdd0841cacad5bb647e76547e918b0c9ecdb8b5ddb3cf92e9a79b03623cb',
  * });
  * 
  * api.getContentList({
@@ -56,13 +57,20 @@ import {buildPathUrl, buildRequestUrlPath, buildAuthHeader } from '../utils'
  * });
 */
 
+const defaultParams = {
+    contentLinkDepth: 1
+}
+
 
 function getContentList(requestParams) {
 
     validateRequestParams(requestParams);
 
+    //merge default params with request params
+    requestParams = {...defaultParams, ...requestParams};
+
     const req = {
-        url: buildPathUrl("list", requestParams.referenceName, requestParams.sort, requestParams.direction, requestParams.filters, requestParams.filtersLogicOperator),
+        url: buildPathUrl("list", requestParams.referenceName, requestParams.sort, requestParams.direction, requestParams.filters, requestParams.filtersLogicOperator, requestParams.contentLinkDepth),
         method: 'get',
         baseURL: buildRequestUrlPath(this.config, requestParams.languageCode),
         headers: buildAuthHeader(this.config),

src/methods/getContentList.js

@@ -6,14 +6,15 @@ import { buildRequestUrlPath, buildAuthHeader } from '../utils'
  * @param {Object} requestParams - The parameters for the API request.
  * @param {number} requestParams.pageID - The unique page ID of the page you wish to retrieve in the current language.
  * @param {string} requestParams.languageCode - The language code of the content you want to retrieve.
+ * @param {number} [requestParams.contentLinkDepth] - The depth, representing the levels in which you want linked content auto-resolved. Default is 2.
  * @returns {Promise<AgilityFetch.Types.Page>} - Returns a page item object.
  * @example
  * 
  * import agility from '@agility/content-fetch'
  * 
  * const api = agility.getApi({
- *   guid: '191309ca-e675-4be2-bb29-351879528707',
- *   apiKey: 'aGd13M.fa30c36e553a36f871860407e902da9a7375322457acd6bcda038e60af699411',
+ *   guid: 'ade6cf3c',
+ *   apiKey: 'defaultlive.201ffdd0841cacad5bb647e76547e918b0c9ecdb8b5ddb3cf92e9a79b03623cb',
  * });
  * 
  * api.getPage({
@@ -28,13 +29,20 @@ import { buildRequestUrlPath, buildAuthHeader } from '../utils'
  * });
 */
 
+const defaultParams = {
+    contentLinkDepth: 2
+}
+
 
 function getPage(requestParams) {
 
     validateRequestParams(requestParams);
 
+    //merge default params with request params
+    requestParams = {...defaultParams, ...requestParams};
+
     const req = {
-        url: `/page/${requestParams.pageID}`,
+        url: `/page/${requestParams.pageID}?contentLinkDepth=${requestParams.contentLinkDepth}`,
         method: 'get',
         baseURL: buildRequestUrlPath(this.config, requestParams.languageCode),
         headers: buildAuthHeader(this.config),

src/methods/getPage.js

@@ -12,8 +12,8 @@ import { buildRequestUrlPath, buildAuthHeader } from '../utils'
  * import agility from '@agility/content-fetch'
  * 
  * const api = agility.getApi({
- *   guid: '191309ca-e675-4be2-bb29-351879528707',
- *   apiKey: 'aGd13M.fa30c36e553a36f871860407e902da9a7375322457acd6bcda038e60af699411',
+ *   guid: 'ade6cf3c',
+ *   apiKey: 'defaultlive.201ffdd0841cacad5bb647e76547e918b0c9ecdb8b5ddb3cf92e9a79b03623cb',
  * });
  * 
  * api.getSitemapFlat({

src/methods/getSitemapFlat.js

@@ -12,8 +12,8 @@ import { buildRequestUrlPath, buildAuthHeader } from '../utils'
  * import agility from '@agility/content-fetch'
  * 
  * const api = agility.getApi({
- *   guid: '191309ca-e675-4be2-bb29-351879528707',
- *   apiKey: 'aGd13M.fa30c36e553a36f871860407e902da9a7375322457acd6bcda038e60af699411',
+ *   guid: 'ade6cf3c',
+ *   apiKey: 'defaultlive.201ffdd0841cacad5bb647e76547e918b0c9ecdb8b5ddb3cf92e9a79b03623cb',
  * });
  * 
  * api.getSitemapNested({

src/methods/getSitemapNested.js

@@ -12,11 +12,12 @@ function buildRequestUrlPath(config, languageCode) {
     return urlPath;
 }
 
-function buildPathUrl(contentType, referenceName, sort, direction, filters, filtersLogicOperator) {
-    let url = `/${contentType}/${referenceName}?`;
+function buildPathUrl(contentType, referenceName, sort, direction, filters, filtersLogicOperator, contentLinkDepth) {
+    let url = `/${contentType}/${referenceName}?contentLinkDepth=${contentLinkDepth}&`;
     filtersLogicOperator = filtersLogicOperator ? ` ${filtersLogicOperator} ` : ' AND ';
 
     if (sort) {
+
         url += `sort=${sort}&`;
 
         if (direction) {