Merge pull request #13 from agility/dev

0.2.1

Author: James Vidler

README.md

@@ -40,13 +40,13 @@ import agility from '@agility/content-fetch'
 //initialize the api client
 const api = agility.getApi({
   instanceID: '1234-1234',
-  accessToken: 'fEpTcRnWO3EahHbojDCeY3PwGwAzpw2gveDuPn2l0nuqFbQYVcWrQ+a3/DHcWgCgn7UL2tgbSOS0AqrEOiXkTg==',
-  languageCode: 'en-us'
+  accessToken: 'fEpTcRnWO3EahHbojDCeY3PwGwAzpw2gveDuPn2l0nuqFbQYVcWrQ+a3/DHcWgCgn7UL2tgbSOS0AqrEOiXkTg=='
 });
 
 //make the request: get a content item with the ID '22'
 api.getContentItem({
-    contentID: 22
+    contentID: 22,
+    languageCode: 'en-us'
 })
 .then(function(contentItem) {
     //on success

package.json

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

src/content-fetch.js

@@ -23,10 +23,10 @@ import createClient from './api-client'
  * @name getApi
  * @memberof AgilityFetch
  * @param {Object} config - API intialization params
- * @param {string} config.instanceID - The guid that represents your instance
- * @param {string} config.accessToken - The secret token that represents your application
- * @param {string} config.languageCode - The language you want to retreive content for
- * @param {boolean} [config.isPreview] - If your access token is for preview, then set this to true
+ * @param {string} config.instanceID - The guid that represents your instance.
+ * @param {string} config.accessToken - The secret token that represents your application.
+ * @param {string} config.languageCode - The language you want to retreive content for.
+ * @param {boolean} [config.isPreview] - If your access token is for preview, then set this to true.
  * @return {AgilityFetch.Client}
  * @example
  * 

src/methods/getContentItem.js

@@ -5,6 +5,7 @@ import utils from '../utils'
  * @memberof AgilityFetch.Client
  * @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.
  * @returns {Promise<AgilityFetch.Types.ContentItem>} - Returns a content item object.
  * @example
  * 
@@ -13,11 +14,11 @@ import utils from '../utils'
  * const api = agility.getApi({
  *   instanceID: '1234-1234',
  *   accessToken: 'fEpTcRnWO3EahHbojDCeY3PwGwAzpw2gveDuPn2l0nuqFbQYVcWrQ+a3/DHcWgCgn7UL2tgbSOS0AqrEOiXkTg==',
- *   languageCode: 'en-us'
  * });
  * 
  * api.getContentItem({
- *     contentID: 22
+ *     contentID: 22,
+ *     languageCode: 'en-us'
  * })
  * .then(function(contentItem) {
  *     console.log(contentItem);
@@ -35,7 +36,7 @@ function getContentItem(requestParams) {
     const req = {
         url: `/item/${requestParams.contentID}`,
         method: 'get',
-        baseURL: utils.buildRequestUrlPath(this.config),
+        baseURL: utils.buildRequestUrlPath(this.config, requestParams.languageCode),
         headers: utils.buildAuthHeader(this.config),
         params:{}
     };
@@ -44,7 +45,10 @@ function getContentItem(requestParams) {
 }
 
 function validateRequestParams(requestParams) {
-    if(!requestParams.contentID) {
+    if(!requestParams.languageCode) {
+        throw new TypeError('You must include a languageCode in your request params.')
+    }
+    else if(!requestParams.contentID) {
         throw new TypeError('You must include a contentID number in your request params.');
     } else {
         return;

src/methods/getContentList.js

@@ -4,7 +4,8 @@ import utils from '../utils'
  * Retrieves a list of content items by reference name.
  * @memberof AgilityFetch.Client
  * @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 current language.
+ * @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.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 {number} [requestParams.sort] - The field to sort the results by. Example *fields.title* or *properties.created*. 
@@ -17,16 +18,16 @@ import utils from '../utils'
  * 
  * const api = agility.getApi({
  *   instanceID: '1234-1234',
- *   accessToken: 'fEpTcRnWO3EahHbojDCeY3PwGwAzpw2gveDuPn2l0nuqFbQYVcWrQ+a3/DHcWgCgn7UL2tgbSOS0AqrEOiXkTg==',
- *   languageCode: 'en-us'
+ *   accessToken: 'fEpTcRnWO3EahHbojDCeY3PwGwAzpw2gveDuPn2l0nuqFbQYVcWrQ+a3/DHcWgCgn7UL2tgbSOS0AqrEOiXkTg=='
  * });
  * 
  * api.getContentList({
  *     referenceName: 'posts',
+ *     languageCode: 'en-us',
  *     take: 50,
  *     skip: 0,
  *     sort: 'properties.created',
- *     direction: 'asc' 
+ *     direction: 'asc'
  * })
  * .then(function(contentList) {
  *     console.log(contentList);
@@ -44,7 +45,7 @@ function getContentList(requestParams) {
     const req = {
         url: `/list/${requestParams.referenceName}`,
         method: 'get',
-        baseURL: utils.buildRequestUrlPath(this.config),
+        baseURL: utils.buildRequestUrlPath(this.config, requestParams.languageCode),
         headers: utils.buildAuthHeader(this.config),
         params:{}
     };
@@ -53,7 +54,10 @@ function getContentList(requestParams) {
 }
 
 function validateRequestParams(requestParams) {
-    if(!requestParams.referenceName) {
+    if(!requestParams.languageCode) {
+        throw new TypeError('You must include a languageCode in your request params.')
+    }
+    else if(!requestParams.referenceName) {
         //must have a referenceName
         throw new TypeError('You must include a content referenceName in your request params.');
     } else if(requestParams.take && isNaN(requestParams.take)) {

src/methods/getPage.js

@@ -5,19 +5,20 @@ import utils from '../utils'
  * @memberof AgilityFetch.Client
  * @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.
  * @returns {Promise<AgilityFetch.Types.Page>} - Returns a page item object.
  * @example
  * 
  * import agility from '@agility/content-fetch'
  * 
  * var api = agility.getApi({
  *   instanceID: '1234-1234',
- *   accessToken: 'fEpTcRnWO3EahHbojDCeY3PwGwAzpw2gveDuPn2l0nuqFbQYVcWrQ+a3/DHcWgCgn7UL2tgbSOS0AqrEOiXkTg==',
- *   languageCode: 'en-us'
+ *   accessToken: 'fEpTcRnWO3EahHbojDCeY3PwGwAzpw2gveDuPn2l0nuqFbQYVcWrQ+a3/DHcWgCgn7UL2tgbSOS0AqrEOiXkTg=='
  * });
  * 
  * api.getPage({
- *     pageID: 1
+ *     pageID: 1,
+ *     languageCode: 'en-us'
  * })
  * .then(function(page) {
  *     console.log(page);
@@ -35,7 +36,7 @@ function getPage(requestParams) {
     const req = {
         url: `/page/${requestParams.pageID}`,
         method: 'get',
-        baseURL: utils.buildRequestUrlPath(this.config),
+        baseURL: utils.buildRequestUrlPath(this.config, requestParams.languageCode),
         headers: utils.buildAuthHeader(this.config),
         params:{}
     };
@@ -44,7 +45,9 @@ function getPage(requestParams) {
 }
 
 function validateRequestParams(requestParams) {
-    if(!requestParams.pageID) {
+    if(!requestParams.languageCode) {
+        throw new TypeError('You must include a languageCode in your request params.')
+    } else if(!requestParams.pageID) {
         throw new TypeError('You must include a pageID in your request params.');
     } else {
         return;

src/methods/getSitemapFlat.js

@@ -5,25 +5,26 @@ import utils from '../utils'
  * @memberof AgilityFetch.Client
  * @param {Object} requestParams - The parameters for the API request.
  * @param {number} requestParams.channelName - The reference name of the digital channel of the sitemap to return. If you only have one channel, your channel reference name is likely *website*.
+ * @param {string} requestParams.languageCode - The language code of the content you want to retrieve.
  * @returns {Promise<AgilityFetch.Types.SitemapFlat>} - The sitemap response in a flat format.
  * @example
  * 
  * import agility from '@agility/content-fetch'
  * 
  * var api = agility.getApi({
  *   instanceID: '1234-1234',
- *   accessToken: 'fEpTcRnWO3EahHbojDCeY3PwGwAzpw2gveDuPn2l0nuqFbQYVcWrQ+a3/DHcWgCgn7UL2tgbSOS0AqrEOiXkTg==',
- *   languageCode: 'en-us'
+ *   accessToken: 'fEpTcRnWO3EahHbojDCeY3PwGwAzpw2gveDuPn2l0nuqFbQYVcWrQ+a3/DHcWgCgn7UL2tgbSOS0AqrEOiXkTg=='
  * });
  * 
  * api.getSitemapFlat({
- *     channelName: 'website'
+ *      channelName: 'website',
+ *      languageCode: 'en-us'
  * })
  * .then(function(sitemap) {
- *   console.log(sitemap);
+ *      console.log(sitemap);
  * })
  * .catch(function(error) {
- *     console.log(error);
+ *      console.log(error);
  * });
 */
 
@@ -34,7 +35,7 @@ function getSitemapFlat(requestParams) {
     const req = {
         url: `/Sitemap/Flat/${requestParams.channelName}`,
         method: 'get',
-        baseURL: utils.buildRequestUrlPath(this.config),
+        baseURL: utils.buildRequestUrlPath(this.config, requestParams.languageCode),
         headers: utils.buildAuthHeader(this.config),
         params:{}
     };
@@ -43,7 +44,9 @@ function getSitemapFlat(requestParams) {
 }
 
 function validateRequestParams(requestParams) {
-    if(!requestParams.channelName) {
+    if(!requestParams.languageCode) {
+        throw new TypeError('You must include a languageCode in your request params.')
+    } else if(!requestParams.channelName) {
         throw new TypeError('You must include a channelName in your request params.');
     } else {
         return;

src/methods/getSitemapNested.js

@@ -5,25 +5,26 @@ import utils from '../utils'
  * @memberof AgilityFetch.Client
  * @param {Object} requestParams - The parameters for the API request.
  * @param {number} requestParams.channelName - The reference name of the digital channel of the sitemap to return. If you only have one channel, your channel reference name is likely *website*.
+ * @param {string} requestParams.languageCode - The language code of the content you want to retrieve.
  * @returns {Promise<AgilityFetch.Types.SitemapNested>} - The array of sitemap items returned.
  * @example
  * 
  * import agility from '@agility/content-fetch'
  * 
  * var api = agility.getApi({
  *   instanceID: '1234-1234',
- *   accessToken: 'fEpTcRnWO3EahHbojDCeY3PwGwAzpw2gveDuPn2l0nuqFbQYVcWrQ+a3/DHcWgCgn7UL2tgbSOS0AqrEOiXkTg==',
- *   languageCode: 'en-us'
+ *   accessToken: 'fEpTcRnWO3EahHbojDCeY3PwGwAzpw2gveDuPn2l0nuqFbQYVcWrQ+a3/DHcWgCgn7UL2tgbSOS0AqrEOiXkTg=='
  * });
  * 
  * api.getSitemapNested({
- *   channelName: 'website'
+ *      channelName: 'website',
+ *      languageCode: 'en-us'
  * })
  * .then(function(sitemap) {
- *   console.log(sitemap);
+ *      console.log(sitemap);
  * })
  * .catch(function(error) {
- *     console.log(error);
+ *      console.log(error);
  * });
 */
 
@@ -34,7 +35,7 @@ function getSitemapNested(requestParams) {
     const req = {
         url: `/Sitemap/Nested/${requestParams.channelName}`,
         method: 'get',
-        baseURL: utils.buildRequestUrlPath(this.config),
+        baseURL: utils.buildRequestUrlPath(this.config, requestParams.languageCode),
         headers: utils.buildAuthHeader(this.config),
         params:{}
     };
@@ -43,7 +44,9 @@ function getSitemapNested(requestParams) {
 }
 
 function validateRequestParams(requestParams) {
-    if(!requestParams.channelName) {
+    if(!requestParams.languageCode) {
+        throw new TypeError('You must include a languageCode in your request params.')
+    } else if(!requestParams.channelName) {
         throw new TypeError('You must include a channelName in your request params.');
     }
 }

src/utils.js

@@ -1,11 +1,11 @@
-function buildRequestUrlPath(config) {
+function buildRequestUrlPath(config, languageCode) {
     let urlPath = null;
     if(config.isPreview) {
         urlPath = config.previewBaseUrl
     } else {
         urlPath = config.fetchBaseUrl
     }
-    urlPath = `${urlPath}/${config.instanceID}/${config.languageCode}`;
+    urlPath = `${urlPath}/${config.instanceID}/${languageCode}`;
     return urlPath;
 }