added documentation for all types and enums

Author: Ali Tahir

src/methods/getContentList.js

@@ -9,13 +9,14 @@ import {buildPathUrl, buildRequestUrlPath, buildAuthHeader } from '../utils'
  * @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*.
- * @param {string} [requestParams.direction] - The direction to sort the results by. Default is **asc**. Valid values are **asc**, **desc**.
- * @param {Array}  [requestParams.filters] - The collection of filters to filter the results by. A filter object contains properties called **property**, **operator**, **value**. Operators can be **eq** Equal To, **ne** Not Equal To, **gt** Greater Than, **gte** Greater Than or Equal To, **lt * @param {Array} [requestParams.filters] - The collection of filters to filter the results by. A filter object contains properties called **property**, **operator**, **value**. Operators can be **eq** Equal To, **ne** Not Equal To, **gt** Greater Than, **gte** Greater Than or Equal To, **lt** Less Than, **lte** Less Than or Equal To, **like** Like (string only)
- * @param (string) [requestParams.filtersLogicOperator] - The logic operator to combine multiple filters. **AND** (default), **OR**.
+ * @param {AgilityFetch.Types.SortDirection} [requestParams.direction] - The direction to sort the results by.
+ * @param {Array.<AgilityFetch.Types.Filter>}  [requestParams.filters] - The collection of filters to filter the results by.
+ * @param {AgilityFetch.Types.FilterLogicOperator} [requestParams.filtersLogicOperator] - The logic operator to combine multiple filters.
  * @returns {Promise<AgilityFetch.Types.ContentList>} - Returns a list of content items.
  * @example
  * 
  * import agility from '@agility/content-fetch'
+ * import types from ''
  * 
  * const api = agility.getApi({
  *   guid: '191309ca-e675-4be2-bb29-351879528707',
@@ -28,7 +29,7 @@ import {buildPathUrl, buildRequestUrlPath, buildAuthHeader } from '../utils'
  *     take: 50,
  *     skip: 0,
  *     sort: 'properties.created',
- *     direction: 'asc'
+ *     direction: SortDirections.Asc
  * })
  * .then(function(contentList) {
  *     console.log(contentList);

src/types/Filter.js

@@ -0,0 +1,13 @@
+/**
+ * Defines a **Filter** for filtering lists.
+ * @typedef Filter
+ * @memberof AgilityFetch.Types
+ * @property {string} property - The property to filter the request on.
+ * @property {AgilityFetch.Types.FilterOperator} operator - The operator to use for the filter.
+ * @property {string} value - The value to compare for the property.
+ */
+
+
+
+
+

src/types/FilterLogicOperator.js

@@ -0,0 +1,21 @@
+/**
+ * Defines a FilterLogicOperator - Refer to {@link AgilityFetch.Types.FilterLogicOperators} Enum for available Logic Operators.
+ * @typedef {string} FilterLogicOperator
+ * @memberOf AgilityFetch.Types
+ */
+
+/**
+ * Enum of FilterLogicOperators.
+ * @enum {FilterLogicOperator} FilterLogicOperators
+ * @memberOf AgilityFetch.Types
+ * @default AND
+ * @readonly
+ */
+const FilterLogicOperators = {
+    /** And */
+    AND: "and",
+    /** Or */
+    OR: "or"
+};
+
+export default FilterLogicOperators;

src/types/FilterOperator.js

@@ -0,0 +1,30 @@
+/**
+ * Defines a FilterOperator - Refer to {@link AgilityFetch.Types.FilterOperators} Enum for available Operators.
+ * @typedef {string} FilterOperator
+ * @memberOf AgilityFetch.Types
+ */
+
+/**
+ * Enum of FilterOperators.
+ * @enum {FilterOperator} FilterOperators
+ * @memberOf AgilityFetch.Types
+ * @readonly
+ */
+const FilterOperators = {
+    /** Equal To */
+    EQUAL_TO: "eq",
+    /** Not Equal To */
+    NOT_EQUAL_TO: "ne",
+    /** Less Than */
+    LESS_THAN: "lt",
+    /** Less Than or Equal To */
+    LESS_THAN_OR_EQUAL_TO: "lte",
+    /** Greater Than */
+    GREATER_THAN: "gt",
+    /** Greater Than or Equal To */
+    GREATER_THAN_OR_EQUAL_TO: "gte",
+    /** Like (string only) */
+    LIKE: "like"
+};
+
+export default FilterOperators;

src/types/SortDirection.js

@@ -0,0 +1,21 @@
+/**
+ * Defines a Sort Direction - Refer to {@link AgilityFetch.Types.SortDirections} Enum for available Sort Directions.
+ * @typedef {string} SortDirection
+ * @memberOf AgilityFetch.Types
+ */
+
+/**
+ * Enum of SortDirections.
+ * @enum {SortDirection} SortDirections
+ * @memberOf AgilityFetch.Types
+ * @default ASC
+ * @readonly
+ */
+const SortDirections = {
+    /** Ascending */
+    ASC: "asc",
+    /** Descending */
+    DESC: "desc",
+};
+
+export default SortDirections;

test/getContentList.tests.js

@@ -1,7 +1,9 @@
 import chai from 'chai'
 const assert = chai.assert;
 const expect = chai.expect;
-
+import { FilterOperators } from '../src/types/FilterOperator';
+import { SortDirections } from '../src/types/SortDirection';
+import { FilterLogicOperators } from '../src/types/FilterLogicOperator';
 import { createApiClient, createPreviewApiClient, createCatchedApiClient } from './apiClients.config'
 
 /* 
@@ -190,7 +192,7 @@ describe('getContentList:', function() {
             referenceName: 'posts',
             languageCode: 'en-us',
             sort: 'properties.versionID',
-            direction: 'desc'
+            direction: SortDirections.DESC
         })
         .then(function(contentList) {
             assert.strictEqual(contentList.items[0].contentID, 16);
@@ -206,7 +208,7 @@ describe('getContentList:', function() {
             api.getContentList({
                 referenceName: 'posts',
                 languageCode: 'en-us',
-                filters: [{operator: 'eq', value: '40'}]
+                filters: [{operator: FilterOperators.EQUAL_TO, value: '40'}]
             })
                 .then(function(contentList) {
                     done();
@@ -238,7 +240,7 @@ describe('getContentList:', function() {
             api.getContentList({
                 referenceName: 'posts',
                 languageCode: 'en-us',
-                filters: [{property: 'properties.versionID', operator: 'eq'}]
+                filters: [{property: 'properties.versionID', operator: FilterOperators.EQUAL_TO}]
             })
                 .then(function(contentList) {
                     done();
@@ -285,8 +287,8 @@ describe('getContentList:', function() {
         api.getContentList({
             referenceName: 'posts',
             languageCode: 'en-us',
-            filters: [{property: 'properties.versionID', operator: 'eq', value: '40'}, {property: 'properties.referenceName', operator: 'like', value: 'posts'}],
-            filtersLogicOperator: 'OR'
+            filters: [{property: 'properties.versionID', operator: FilterOperators.EQUAL_TO, value: '40'}, {property: 'properties.referenceName', operator: FilterOperators.LIKE, value: 'posts'}],
+            filtersLogicOperator: FilterLogicOperators.OR
         })
         .then(function(contentList) {
             assert.strictEqual(contentList.items[0].contentID, 15);
@@ -301,7 +303,7 @@ describe('getContentList:', function() {
         api.getContentList({
             referenceName: 'posts',
             languageCode: 'en-us',
-            filters: [{property: 'properties.versionID', operator: 'eq', value: '40'}, {property: 'properties.referenceName', operator: 'like', value: 'posts'}]
+            filters: [{property: 'properties.versionID', operator: FilterOperators.EQUAL_TO, value: '40'}, {property: 'properties.referenceName', operator: FilterOperators.LIKE, value: 'posts'}]
         })
             .then(function(contentList) {
                 assert.strictEqual(contentList.items[0].contentID, 16);