feat: Enhance Taxonomy and TermQuery classes with detailed documentation and fetch methods

Author: harshitha-cstk

src/lib/taxonomy.ts

@@ -2,19 +2,43 @@ import { AxiosInstance, getData } from '@contentstack/core';
 import { TermQuery } from './term-query';
 import { Term } from './term';
 
+/**
+ * @class Taxonomy
+ * @description Represents a taxonomy with methods to fetch taxonomy data and manage terms
+ */
 export class Taxonomy {
   private _client: AxiosInstance;
   private _taxonomyUid: string;
   private _urlPath: string;
 
   _queryParams: { [key: string]: string | number } = {};
 
+  /**
+   * @constructor
+   * @param {AxiosInstance} client - The HTTP client instance
+   * @param {string} taxonomyUid - The taxonomy UID
+   */
   constructor(client: AxiosInstance, taxonomyUid: string) {
     this._client = client;
     this._taxonomyUid = taxonomyUid;
     this._urlPath = `/taxonomy-manager/${this._taxonomyUid}`; // TODO: change to /taxonomies/${this._taxonomyUid}
   }
 
+  /**
+   * @method term
+   * @memberof Taxonomy
+   * @description Gets a specific term or creates a term query
+   * @param {string} [uid] - Optional term UID. If provided, returns a Term instance. If not provided, returns a TermQuery instance.
+   * @returns {Term | TermQuery}
+   * @example
+   * import contentstack from '@contentstack/delivery-sdk'
+   *
+   * const stack = contentstack.stack({ apiKey: "apiKey", deliveryToken: "deliveryToken", environment: "environment" });
+   * // Get a specific term
+   * const term = stack.taxonomy('taxonomy_uid').term('term_uid');
+   * // Get all terms
+   * const termQuery = stack.taxonomy('taxonomy_uid').term();
+   */
   term(uid: string): Term;
   term(): TermQuery;
   term(uid?: string): Term | TermQuery {
@@ -23,6 +47,17 @@ export class Taxonomy {
     return new TermQuery(this._client, this._taxonomyUid);
   }
 
+  /**
+   * @method fetch
+   * @memberof Taxonomy
+   * @description Fetches the taxonomy data by UID
+   * @returns {Promise<T>}
+   * @example
+   * import contentstack from '@contentstack/delivery-sdk'
+   *
+   * const stack = contentstack.stack({ apiKey: "apiKey", deliveryToken: "deliveryToken", environment: "environment" });
+   * const result = await stack.taxonomy('taxonomy_uid').fetch();
+   */
   async fetch<T>(): Promise<T> {
     const response = await getData(this._client, this._urlPath);
 

src/lib/term-query.ts

@@ -1,18 +1,38 @@
 import { AxiosInstance, getData } from '@contentstack/core';
 import { FindResponse } from './types';
 
+/**
+ * @class TermQuery
+ * @description Represents a query for fetching multiple terms from a taxonomy
+ */
 export class TermQuery {
   private _taxonomyUid: string;
   private _client: AxiosInstance;
   private _urlPath: string;
   _queryParams: { [key: string]: string | number } = {};
 
+  /**
+   * @constructor
+   * @param {AxiosInstance} client - The HTTP client instance
+   * @param {string} taxonomyUid - The taxonomy UID
+   */
   constructor(client: AxiosInstance, taxonomyUid: string) {
     this._client = client;
     this._taxonomyUid = taxonomyUid;
     this._urlPath = `/taxonomy-manager/${this._taxonomyUid}/terms`;
   }
 
+  /**
+   * @method find
+   * @memberof TermQuery
+   * @description Fetches all terms from the taxonomy
+   * @returns {Promise<FindResponse<T>>}
+   * @example
+   * import contentstack from '@contentstack/delivery-sdk'
+   *
+   * const stack = contentstack.stack({ apiKey: "apiKey", deliveryToken: "deliveryToken", environment: "environment" });
+   * const result = await stack.taxonomy('taxonomy_uid').term().find();
+   */
   async find<T>(): Promise<FindResponse<T>> {
     const response = await getData(this._client, this._urlPath, { params: this._queryParams });
     return response as FindResponse<T>;

src/lib/term.ts

@@ -1,11 +1,21 @@
 import { AxiosInstance, getData } from "@contentstack/core";
 
+/**
+ * @class Term
+ * @description Represents a taxonomy term with methods to fetch term data, locales, ancestors, and descendants
+ */
 export class Term {
   protected _client: AxiosInstance;
   private _taxonomyUid: string;
   private _termUid: string;
   private _urlPath: string;
 
+  /**
+   * @constructor
+   * @param {AxiosInstance} client - The HTTP client instance
+   * @param {string} taxonomyUid - The taxonomy UID
+   * @param {string} termUid - The term UID
+   */
   constructor(client: AxiosInstance, taxonomyUid: string, termUid: string) {
     this._client = client;
     this._taxonomyUid = taxonomyUid;
@@ -64,6 +74,17 @@ export class Term {
     return response;
   }
 
+  /**
+   * @method fetch
+   * @memberof Term
+   * @description Fetches the term data by UID
+   * @returns {Promise<T>}
+   * @example
+   * import contentstack from '@contentstack/delivery-sdk'
+   *
+   * const stack = contentstack.stack({ apiKey: "apiKey", deliveryToken: "deliveryToken", environment: "environment" });
+   * const result = await stack.taxonomy('taxonomy_uid').term('term_uid').fetch();
+   */
   async fetch<T>(): Promise<T> {
     const response = await getData(this._client, this._urlPath);
     if (response.term) return response.term as T;