fix: fixed taxonomies url, levels param and added doc

Author: abhinav-from-contentstack

config.js

@@ -9,7 +9,7 @@ const config = {
         entries: "/entries/",
         assets: "/assets/",
         environments: "/environments/",
-        taxonomies: "/taxonomies/"
+        taxonomies: "/taxonomies/entries"
     },
     live_preview: {
         enable: false,

index.d.ts

@@ -125,6 +125,7 @@ export class Stack {
     ContentType(uid: string): ContentType;
     Assets(uid: string): Asset;
     Assets(): Assets;
+    Taxonomies(): Taxonomies;
 
     setPort(port: number): Stack;
     setProtocol(protocol: string): Stack;
@@ -152,7 +153,14 @@ export class ContentType {
     constructor();
     content_type_uid: string
 
-    Query(): Query;
+    Query(): TaxonomyQuery;
+    Entry(uid: string): Entry;
+    fetch(fetchOptions?: object): Promise<any>;
+}
+
+export class Taxonomies {
+    constructor();
+    Query(): TaxonomyQuery;
     Entry(uid: string): Entry;
     fetch(fetchOptions?: object): Promise<any>;
 }
@@ -277,3 +285,11 @@ export class Query extends Entry {
     find(fetchOptions?: object): Promise<any>;
     findOne(): Promise<any>;
 }
+
+export class TaxonomyQuery extends Query {
+    constructor();
+    above(key: string, value: string, levels?: number): Query;
+    equalAndAbove(key: string, value: string, levels?: number): Query;
+    below(key: string, value: string, levels?: number): Query;
+    equalAndBelow(key: string, value: string, levels?: number): Query;
+}

src/core/modules/query.js

@@ -90,7 +90,7 @@ function getRequestUrl(type, config, content_type_uid, baseURL) {
             url = baseURL + config.urls.assets;
             break;
         case 'taxonomy':
-            url = baseURL + config.urls.taxonomies + config.urls.entries;
+            url = baseURL + config.urls.taxonomies;
             break;
         case 'contentType':
         default:

src/core/modules/taxonomy.js

@@ -3,12 +3,12 @@ import Query from "./query";
 // Overrideing compare function to include level
 const _extend = {
   compare: function(type) {
-    return function(key, value, level=0) {
+    return function(key, value, levels) {
         if (key && value && typeof key === 'string' && typeof value !== 'undefined') {
             this._query['query'][key] = this._query['query']['file_size'] || {};
             this._query['query'][key][type] = value;
-            if (level > 0 && level <= 10) {
-              this._query['query'][key]['level'] = level
+            if (levels && typeof levels === "number") {
+              this._query['query'][key]['levels'] = levels
             }
             return this;
         } else {
@@ -21,9 +21,84 @@ const _extend = {
 export default class TaxonomyQuery extends Query {
   constructor() {
     super();
+    /**
+     * @method above
+     * @memberOf Query
+     * @description Get all entries for a specific taxonomy that match only the parent term(s) of a specified target term, excluding the target term itself. You can also specify a specific level.
+     * @param {String} key - uid of the taxonomy, specified as `taxonomies.<taxonomy_uid>`
+     * @param {*} value - uid of the term to be matched
+     * @example For taxonomy_uid = taxonomy1, and term_uid = term1
+     * let blogQuery = Stack().ContentType('example').Query();
+     *          let data = blogQuery.above("taxonomies.taxonomy1", "term1").toJSON().find() // without levels
+     *          let data = blogQuery.above("taxonomies.taxonomy1", "term1", 4).toJSON().find() // with levels
+     *          data.then(function (result) {
+     *          // result = the data which matches only the parent term(s) of the specified term, excluding the term itself
+     *       },function (error) {
+     *          // error function
+     *      })
+     * @returns {Query}
+     * @instance
+     */
     this.above = _extend.compare('$above')
+
+    /**
+     * @method equalAndAbove
+     * @memberOf Query
+     * @description Get all entries for a specific taxonomy that match a specific term and all its ancestor terms, requiring only the target term and a specified level.
+     * @param {String} key - uid of the taxonomy, specified as `taxonomies.<taxonomy_uid>`
+     * @param {*} value - uid of the term to be matched
+     * @example For taxonomy_uid = taxonomy1, and term_uid = term1
+     * let blogQuery = Stack().ContentType('example').Query();
+     *          let data = blogQuery.equalAndAbove("taxonomies.taxonomy1", "term1").toJSON().find() // without levels
+     *          let data = blogQuery.equalAndAbove("taxonomies.taxonomy1", "term1", 4).toJSON().find() // with levels
+     *          data.then(function (result) {
+     *          // result = the data which matches a specific term and all its ancestor terms
+     *       },function (error) {
+     *          // error function
+     *      })
+     * @returns {Query}
+     * @instance
+     */
     this.equalAndAbove = _extend.compare('$eq_above')
+    
+    /**
+     * @method below
+     * @memberOf Query
+     * @description Get all entries for a specific taxonomy that match all of their descendant terms by specifying only the target term and a specific level.
+     * @param {String} key - uid of the taxonomy, specified as `taxonomies.<taxonomy_uid>`
+     * @param {*} value - uid of the term to be matched
+     * @example For taxonomy_uid = taxonomy1, and term_uid = term1
+     * let blogQuery = Stack().ContentType('example').Query();
+     *          let data = blogQuery.below("taxonomies.taxonomy1", "term1").toJSON().find() // without levels
+     *          let data = blogQuery.below("taxonomies.taxonomy1", "term1", 4).toJSON().find() // with levels
+     *          data.then(function (result) {
+     *          // result = the data which matches all of the descendant terms.
+     *       },function (error) {
+     *          // error function
+     *      })
+     * @returns {Query}
+     * @instance
+     */
     this.below = _extend.compare('$below')
+    
+    /**
+     * @method equalAndBelow
+     * @memberOf Query
+     * @description Get all entries for a specific taxonomy that match a specific term and all its descendant terms, requiring only the target term and a specified level.
+     * @param {String} key - uid of the taxonomy, specified as `taxonomies.<taxonomy_uid>`
+     * @param {*} value - uid of the term to be matched
+     * @example For taxonomy_uid = taxonomy1, and term_uid = term1
+     * let blogQuery = Stack().ContentType('example').Query();
+     *          let data = blogQuery.equalAndBelow("taxonomies.taxonomy1", "term1").toJSON().find() // without levels
+     *          let data = blogQuery.equalAndBelow("taxonomies.taxonomy1", "term1", 4).toJSON().find() // with levels
+     *          data.then(function (result) {
+     *          // result = the data which matches a specific term and all its descendant terms.
+     *       },function (error) {
+     *          // error function
+     *      })
+     * @returns {Query}
+     * @instance
+     */
     this.equalAndBelow = _extend.compare('$eq_below')
   }
 }