@dotcms/client 0.0.1-alpha.37 → 0.0.1-alpha.38

package/index.esm.js

@@ -35,25 +35,34 @@ typeof SuppressedError === "function" ? SuppressedError : function (error, suppr
 
 var _Field_query;
 /**
- * 'Field' class is used to build a query with a field.
+ * The `Field` class is used to build a query with a specific field.
  * A Lucene Field is a key used to search for a specific value in a document.
  *
  * @export
  * @class Field
  */
 class Field {
+    /**
+     * Creates an instance of the `Field` class.
+     *
+     * @param {string} query - The initial query string.
+     */
     constructor(query) {
         this.query = query;
         _Field_query.set(this, '');
         __classPrivateFieldSet(this, _Field_query, this.query, "f");
     }
     /**
-     * This method appends to the query a term that should be included in the search..
+     * Appends a term to the query that should be included in the search.
      *
-     * Ex: myValue or "My value"
+     * @example
+     * ```typescript
+     * const field = new Field("+myField");
+     * field.equals("myValue");
+     * ```
      *
      * @param {string} term - The term that should be included in the search.
-     * @return {*}  {Equals} - An instance of Equals.
+     * @return {Equals} - An instance of `Equals`.
      * @memberof Field
      */
     equals(term) {
@@ -78,7 +87,11 @@ class NotOperand {
     /**
      * This method appends to the query a term that should be included in the search.
      *
-     * Ex: myValue or "My value"
+     * @example
+     * ```typescript
+     * const notOperand = new NotOperand("+myField");
+     * notOperand.equals("myValue");
+     * ```
      *
      * @param {string} term - The term that should be included in the search.
      * @return {*}  {Equals} - An instance of Equals.
@@ -158,6 +171,11 @@ var OPERAND;
 /**
  * This function removes extra spaces from a string.
  *
+ * @example
+ * ```ts
+ * sanitizeQuery("  my query  "); // Output: "my query"
+ * ```
+ *
  * @export
  * @param {string} str
  * @return {*}  {string}
@@ -169,6 +187,12 @@ function sanitizeQuery(str) {
  * This function sanitizes a term by adding quotes if it contains spaces.
  * In lucene, a term with spaces should be enclosed in quotes.
  *
+ * @example
+ * ```ts
+ * sanitizePhrases(`my term`); // Output: `"my term"`
+ * sanitizePhrases(`myterm`); // Output: `myterm`
+ * ```
+ *
  * @export
  * @param {string} term
  * @return {*}  {string}
@@ -180,6 +204,11 @@ function sanitizePhrases(term) {
  * This function builds a term to be used in a lucene query.
  * We need to sanitize the term before adding it to the query.
  *
+ * @example
+ * ```ts
+ * const equals = buildEquals("+myField: ", "myValue"); // Current query: "+myField: myValue"
+ * ```
+ *
  * @export
  * @param {string} query
  * @param {string} term
@@ -193,6 +222,12 @@ function buildEquals(query, term) {
  * This function builds a term to be used in a lucene query.
  * We need to sanitize the raw query before adding it to the query.
  *
+ * @example
+ * ```ts
+ * const query = "+myField: myValue";
+ * const field = buildRawEquals(query, "-myField2: myValue2"); // Current query: "+myField: myValue -myField2: myValue"
+ * ```
+ *
  * @export
  * @param {string} query
  * @param {string} raw
@@ -206,6 +241,11 @@ function buildRawEquals(query, raw) {
  * This function builds a field to be used in a lucene query.
  * We need to format the field before adding it to the query.
  *
+ * @example
+ * ```ts
+ * const field = buildField("+myField: ", "myValue"); // Current query: "+myField: myValue"
+ * ```
+ *
  * @export
  * @param {string} query
  * @param {string} field
@@ -219,6 +259,12 @@ function buildField(query, field) {
  * This function builds an exclude field to be used in a lucene query.
  * We need to format the field before adding it to the query.
  *
+ * @example
+ * ```ts
+ * const query = "+myField: myValue";
+ * const field = buildExcludeField(query, "myField2"); // Current query: "+myField: myValue -myField2:"
+ * ```
+ *
  * @export
  * @param {string} query
  * @param {string} field
@@ -232,6 +278,18 @@ function buildExcludeField(query, field) {
  * This function builds an operand to be used in a lucene query.
  * We need to format the operand before adding it to the query.
  *
+ * @example
+ * <caption>E.g. Using the AND operand</caption>
+ * ```ts
+ * const query = "+myField: myValue";
+ * const field = buildOperand(query, OPERAND.AND); // Current query: "+myField: myValue AND"
+ * ```
+ * @example
+ * <caption>E.g. Using the OR operand</caption>
+ * ```ts
+ * const query = "+myField: myValue";
+ * const field = buildOperand(query, OPERAND.OR); // Current query: "+myField: myValue OR"
+ * ```
  * @export
  * @param {string} query
  * @param {OPERAND} operand
@@ -245,6 +303,12 @@ function buildOperand(query, operand) {
  * This function builds a NOT operand to be used in a lucene query.
  * We need to format the operand before adding it to the query.
  *
+ * @example
+ * ```ts
+ * const query = "+myField: myValue";
+ * const field = buildNotOperand(query); // Current query: "+myField: myValue NOT"
+ * ```
+ *
  * @export
  * @param {string} query
  * @return {*}  {NotOperand}
@@ -273,7 +337,11 @@ class Equals {
     /**
      * This method appends to the query a term that should be excluded in the search.
      *
-     * Ex: "-myValue"
+     * @example
+     * ```ts
+     * const equals = new Equals("+myField: myValue");
+     * equals.excludeField("myField2").equals("myValue2"); // Current query: "+myField: myValue -myField2: myValue2"
+     * ```
      *
      * @param {string} field - The field that should be excluded in the search.
      * @return {*}  {Field} - An instance of a Lucene Field. A field is a key used to search for a specific value in a document.
@@ -285,8 +353,11 @@ class Equals {
     /**
      * This method appends to the query a field that should be included in the search.
      *
-     * Ex: "+myField:"
-     *
+     * @example
+     * ```ts
+     * const equals = new Equals("+myField: myValue");
+     * equals.field("myField2").equals("myValue2");  // Current query: "+myField: myValue +myField2: myValue2"
+     *```
      * @param {string} field - The field that should be included in the search.
      * @return {*}  {Field} - An instance of a Lucene Field. A field is a key used to search for a specific value in a document.
      * @memberof Equal
@@ -297,7 +368,12 @@ class Equals {
     /**
      * This method appends to the query an operand to use logic operators in the query.
      *
-     * Ex: "OR"
+     * @example
+     * @example
+     * ```ts
+     * const equals = new Equals("+myField: myValue");
+     * equals.or().field("myField2").equals("myValue2"); // Current query: "+myField: myValue OR +myField2: myValue2"
+     * ```
      *
      * @return {*}  {Operand} - An instance of a Lucene Operand. An operand is a logical operator used to combine terms or phrases in a query.
      * @memberof Equal
@@ -308,7 +384,11 @@ class Equals {
     /**
      * This method appends to the query an operand to use logic operators in the query.
      *
-     * Ex: "AND"
+     * @example
+     * ```ts
+     * const equals = new Equals("+myField: myValue");
+     * equals.and().field("myField2").equals("myValue2"); // Current query: "+myField: myValue AND +myField2: myValue2"
+     * ```
      *
      * @return {*}  {Operand} - An instance of a Lucene Operand. An operand is a logical operator used to combine terms or phrases in a query.
      * @memberof Equal
@@ -319,7 +399,11 @@ class Equals {
     /**
      * This method appends to the query an operand to use logic operators in the query.
      *
-     * Ex: "NOT"
+     * @example
+     * ```ts
+     * const equals = new Equals("+myField: myValue");
+     * equals.not().field("myField").equals("myValue2"); // Current query: "+myField: myValue NOT +myField: myValue2"
+     * ```
      *
      * @return {*}  {NotOperand} - An instance of a Lucene Not Operand. A not operand is a logical operator used to exclude terms or phrases in a query.
      * @memberof Equal
@@ -332,7 +416,12 @@ class Equals {
      * This raw query should end in a Lucene Equal.
      * This method is useful when you want to append a complex query or an already written query to the query builder.
      *
-     * Ex: "+myField: value AND (someOtherValue OR anotherValue)"
+     * @example
+     * ```ts
+     * // This builds the follow raw query "+myField: value AND (someOtherValue OR anotherValue)"
+     * const equals = new Equals("+myField: value");
+     * equals.raw("+myField2: value2"); // Current query: "+myField: value +myField2: anotherValue"
+     * ```
      *
      * @param {string} query - A raw query string.
      * @return {*}  {Equal} - An instance of a Lucene Equal. A term is a value used to search for a specific value in a document.
@@ -344,6 +433,12 @@ class Equals {
     /**
      * This method returns the final query string.
      *
+     * @example
+     * ```ts
+     * const equals = new Equals("+myField: myValue");
+     * equals.field("myField2").equals("myValue2").build(); // Returns "+myField: myValue +myField2: myValue2"
+     * ```
+     *
      * @return {*}  {string} - The final query string.
      * @memberof Equal
      */
@@ -356,7 +451,29 @@ _Equals_query = new WeakMap();
 var _QueryBuilder_query;
 /**
  * 'QueryBuilder' Is a Typescript class that provides the ability to build a query string using the Lucene syntax in a more readable way.
+ * @example
+ * ```ts
+ *  const qb = new QueryBuilder();
+ *  const query = qb
+ *          .field('contentType')
+ *          .equals('Blog')
+ *          .field('conhost')
+ *          .equals('my-super-cool-site')
+ *          .build(); // Output: `+contentType:Blog +conhost:my-super-cool-site"`
+ * ```
  *
+ * @example
+ * ```ts
+ *  const qb = new QueryBuilder();
+ *  const query = qb
+ *          .field('contentType')
+ *          .equals('Blog')
+ *          .field('title')
+ *          .equals('Football')
+ *          .excludeField('summary')
+ *          .equals('Lionel Messi')
+ *          .build(); // Output: `+contentType:Blog +title:Football -summary:"Lionel Messi"`
+ * ```
  * @export
  * @class QueryBuilder
  */
@@ -367,7 +484,11 @@ class QueryBuilder {
     /**
      * This method appends to the query a field that should be included in the search.
      *
-     * Ex: "+myField:"
+     * @example
+     * ```ts
+     * const qb = new QueryBuilder();
+     * qb.field("+myField: ", "myValue"); // Current query: "+myField: myValue"
+     * ```
      *
      * @param {string} field - The field that should be included in the search.
      * @return {*}  {Field} -  An instance of a Lucene Field. A field is a key used to search for a specific value in a document.
@@ -379,7 +500,11 @@ class QueryBuilder {
     /**
      * This method appends to the query a field that should be excluded from the search.
      *
-     * Ex: "-myField:"
+     * @example
+     * ```ts
+     * const qb = new QueryBuilder();
+     * qb.excludeField("myField").equals("myValue"); // Current query: "-myField: myValue"
+     * ```
      *
      * @param {string} field - The field that should be excluded from the search.
      * @return {*}  {Field} -  An instance of a Lucene Exclude Field. An exclude field is a key used to exclude for a specific value in a document.
@@ -393,7 +518,11 @@ class QueryBuilder {
      * This raw query should end in Equals.
      * This method is useful when you want to append a complex query or an already written query to the query builder.
      *
-     * Ex: "+myField: value AND (someOtherValue OR anotherValue)"
+     * @example
+     * ```ts
+     * const qb = new QueryBuilder();
+     * qb.raw("+myField: value AND (someOtherValue OR anotherValue)"); // Current query: "+myField: value AND (someOtherValue OR anotherValue)"
+     * ```
      *
      * @param {string} query - A raw query string.
      * @return {*}  {Equals} - An instance of Equals. A term is a value used to search for a specific value in a document.
@@ -405,38 +534,62 @@ class QueryBuilder {
 }
 _QueryBuilder_query = new WeakMap();
 
-// Fields that we don't want to format when sanitizing the query
+/**
+ * Default variant identifier used in the application.
+ */
+/**
+ * Fields that should not be formatted when sanitizing the query.
+ * These fields are essential for maintaining the integrity of the content type.
+ */
 const CONTENT_TYPE_MAIN_FIELDS = ['live', 'variant', 'contentType', 'languageId'];
+/**
+ * URL endpoint for the content API search functionality.
+ */
 const CONTENT_API_URL = '/api/content/_search';
 
 /**
+ * @description
  * Sanitizes the query for the given content type.
- * It replaces the fields that are not contentType fields with the correct format.
+ * It replaces the fields that are not content type fields with the correct format.
  * Example: +field: -> +contentTypeVar.field:
  *
+ * @example
+ *
+ * ```ts
+ * const query = '+field: value';
+ * const contentType = 'contentTypeVar';
+ * const sanitizedQuery = sanitizeQueryForContentType(query, contentType); // Output: '+contentTypeVar.field: value'
+ * ```
  *
  * @export
- * @param {string} query
- * @param {string} contentType
- * @return {*}  {string}
+ * @param {string} query - The query string to be sanitized.
+ * @param {string} contentType - The content type to be used for formatting the fields.
+ * @returns {string} The sanitized query string.
  */
 function sanitizeQueryForContentType(query, contentType) {
     return query.replace(/\+([^+:]*?):/g, (original, field) => {
-        return !CONTENT_TYPE_MAIN_FIELDS.includes(field) // Fields that are not contentType fields
+        return !CONTENT_TYPE_MAIN_FIELDS.includes(field) // Fields that are not content type fields
             ? `+${contentType}.${field}:` // Should have this format: +contentTypeVar.field:
-            : original; // Return the field if it is a contentType field
+            : original; // Return the field if it is a content type field
     });
 }
 
 var _CollectionBuilder_page, _CollectionBuilder_limit, _CollectionBuilder_depth, _CollectionBuilder_render, _CollectionBuilder_sortBy, _CollectionBuilder_contentType, _CollectionBuilder_defaultQuery, _CollectionBuilder_query, _CollectionBuilder_rawQuery, _CollectionBuilder_languageId, _CollectionBuilder_draft, _CollectionBuilder_serverUrl, _CollectionBuilder_requestOptions;
 /**
- * Creates a Builder to filter and fetch content from the content API for an specific content type
+ * Creates a Builder to filter and fetch content from the content API for a specific content type.
  *
  * @export
  * @class CollectionBuilder
- * @template T Represents the type of the content type to fetch. Defaults to unknown
+ * @template T Represents the type of the content type to fetch. Defaults to unknown.
  */
 class CollectionBuilder {
+    /**
+     * Creates an instance of CollectionBuilder.
+     * @param {ClientOptions} requestOptions Options for the client request.
+     * @param {string} serverUrl The server URL.
+     * @param {string} contentType The content type to fetch.
+     * @memberof CollectionBuilder
+     */
     constructor(requestOptions, serverUrl, contentType) {
         _CollectionBuilder_page.set(this, 1);
         _CollectionBuilder_limit.set(this, 10);
@@ -454,11 +607,11 @@ class CollectionBuilder {
         __classPrivateFieldSet(this, _CollectionBuilder_requestOptions, requestOptions, "f");
         __classPrivateFieldSet(this, _CollectionBuilder_serverUrl, serverUrl, "f");
         __classPrivateFieldSet(this, _CollectionBuilder_contentType, contentType, "f");
-        // We need to build the default query with the contentType field
+        // Build the default query with the contentType field
         __classPrivateFieldSet(this, _CollectionBuilder_defaultQuery, new QueryBuilder().field('contentType').equals(__classPrivateFieldGet(this, _CollectionBuilder_contentType, "f")), "f");
     }
     /**
-     * This method returns the sort query in this format: field order, field order, ...
+     * Returns the sort query in the format: field order, field order, ...
      *
      * @readonly
      * @private
@@ -467,15 +620,28 @@ class CollectionBuilder {
     get sort() {
         return __classPrivateFieldGet(this, _CollectionBuilder_sortBy, "f")?.map((sort) => `${sort.field} ${sort.order}`).join(',');
     }
+    /**
+     * Returns the offset for pagination.
+     *
+     * @readonly
+     * @private
+     * @memberof CollectionBuilder
+     */
     get offset() {
-        // This could end in an empty response
         return __classPrivateFieldGet(this, _CollectionBuilder_limit, "f") * (__classPrivateFieldGet(this, _CollectionBuilder_page, "f") - 1);
     }
+    /**
+     * Returns the full URL for the content API.
+     *
+     * @readonly
+     * @private
+     * @memberof CollectionBuilder
+     */
     get url() {
         return `${__classPrivateFieldGet(this, _CollectionBuilder_serverUrl, "f")}${CONTENT_API_URL}`;
     }
     /**
-     * This method returns the current query built
+     * Returns the current query built.
      *
      * @readonly
      * @private
@@ -485,13 +651,17 @@ class CollectionBuilder {
         return __classPrivateFieldGet(this, _CollectionBuilder_query, "f") ?? __classPrivateFieldGet(this, _CollectionBuilder_defaultQuery, "f");
     }
     /**
-     * Takes a language id and filters the content by that language.
-     *
-     * The language id defaults to 1
+     * Filters the content by the specified language ID.
      *
+     * @example
+     * ```typescript
+     * const client = new DotCMSClient(config);
+     * const collectionBuilder = client.content.getCollection("Blog");
+     * collectionBuilder.language(1);
+     * ```
      *
-     * @param {number | string} languageId The language id to filter the content by
-     * @return {CollectionBuilder} CollectionBuilder - A CollectionBuilder instance
+     * @param {number | string} languageId The language ID to filter the content by.
+     * @return {CollectionBuilder} A CollectionBuilder instance.
      * @memberof CollectionBuilder
      */
     language(languageId) {
@@ -499,9 +669,11 @@ class CollectionBuilder {
         return this;
     }
     /**
-     * The retrieved content will have the rendered HTML
+     * Setting this to true will server side render (using velocity) any widgets that are returned by the content query.
      *
-     * @return {CollectionBuilder} CollectionBuilder - A CollectionBuilder instance
+     * More information here: {@link https://www.dotcms.com/docs/latest/content-api-retrieval-and-querying#ParamsOptional}
+     *
+     * @return {CollectionBuilder} A CollectionBuilder instance.
      * @memberof CollectionBuilder
      */
     render() {
@@ -509,19 +681,18 @@ class CollectionBuilder {
         return this;
     }
     /**
-     * Takes an array of constrains to sort the content by field an specific order
+     * Sorts the content by the specified fields and orders.
      *
      * @example
-     * ```javascript
-     * // This will sort the content by title in ascending order
-     * // and by modDate in descending order
-     *  const sortBy = [{ field: 'title', order: 'asc' }, { field: 'modDate', order: 'desc' }]
-     *
-     *  client.content.getCollection("Blog").sortBy(sortBy)
-     *```
+     * ```typescript
+     * const client = new DotCMSClient(config);
+     * const collectionBuilder = client.content.getCollection("Blog");
+     * const sortBy = [{ field: 'title', order: 'asc' }, { field: 'modDate', order: 'desc' }];
+     * collectionBuilder("Blog").sortBy(sortBy);
+     * ```
      *
-     * @param {SortBy[]} sortBy Array of constrains to sort the content by
-     * @return {CollectionBuilder} CollectionBuilder - A CollectionBuilder instance
+     * @param {SortBy[]} sortBy Array of constraints to sort the content by.
+     * @return {CollectionBuilder} A CollectionBuilder instance.
      * @memberof CollectionBuilder
      */
     sortBy(sortBy) {
@@ -529,12 +700,10 @@ class CollectionBuilder {
         return this;
     }
     /**
-     * Takes a number that represents the max amount of content to fetch
-     *
-     * `limit` is set to 10 by default
+     * Sets the maximum amount of content to fetch.
      *
-     * @param {number} limit The max amount of content to fetch
-     * @return {CollectionBuilder} CollectionBuilder - A CollectionBuilder instance
+     * @param {number} limit The maximum amount of content to fetch.
+     * @return {CollectionBuilder} A CollectionBuilder instance.
      * @memberof CollectionBuilder
      */
     limit(limit) {
@@ -542,10 +711,10 @@ class CollectionBuilder {
         return this;
     }
     /**
-     * Takes a number that represents the page to fetch
+     * Sets the page number to fetch.
      *
-     * @param {number} page The page to fetch
-     * @return {CollectionBuilder} CollectionBuilder - A CollectionBuilder instance
+     * @param {number} page The page number to fetch.
+     * @return {CollectionBuilder} A CollectionBuilder instance.
      * @memberof CollectionBuilder
      */
     page(page) {
@@ -571,11 +740,18 @@ class CollectionBuilder {
         return this;
     }
     /**
-     * The retrieved content will be draft content
-     *
-     * The default value is false to fetch content that is not on draft
+     * Retrieves draft content.
+     * @example
+     * ```ts
+     * const client = new DotCMSClient(config);
+     * const collectionBuilder = client.content.getCollection("Blog");
+     * collectionBuilder
+     *      .draft() // This will retrieve draft/working content
+     *      .then((response) => // Your code here })
+     *      .catch((error) => // Your code here })
+     * ```
      *
-     * @return {CollectionBuilder} CollectionBuilder - A CollectionBuilder instance
+     * @return {CollectionBuilder} A CollectionBuilder instance.
      * @memberof CollectionBuilder
      */
     draft() {
@@ -583,12 +759,22 @@ class CollectionBuilder {
         return this;
     }
     /**
-     * Takes a string that represents a variant ID of content created with the {@link https://www.dotcms.com/docs/latest/experiments-and-a-b-testing A/B Testing} feature
+     * Filters the content by a variant ID for [Experiments](https://www.dotcms.com/docs/latest/experiments-and-a-b-testing)
      *
-     * `variantId` defaults to "DEFAULT" to fetch content that is not part of an A/B test
+     * More information here: {@link https://www.dotcms.com/docs/latest/content-api-retrieval-and-querying#ParamsOptional}
      *
-     * @param {string} variantId A string that represents a variant ID
-     * @return {CollectionBuilder} CollectionBuilder - A CollectionBuilder instance
+     * @example
+     * ```ts
+     * const client = new DotCMSClient(config);
+     * const collectionBuilder = client.content.getCollection("Blog");
+     * collectionBuilder
+     *      .variant("YOUR_VARIANT_ID")
+     *      .then((response) => // Your code here })
+     *      .catch((error) => // Your code here })
+     * ```
+     *
+     * @param {string} variantId A string that represents a variant ID.
+     * @return {CollectionBuilder} A CollectionBuilder instance.
      * @memberof CollectionBuilder
      */
     variant(variantId) {
@@ -596,12 +782,23 @@ class CollectionBuilder {
         return this;
     }
     /**
-     * Takes a number that represents the depth of the relationships of a content
+     * Sets the depth of the relationships of the content.
+     * Specifies the depth of related content to return in the results.
      *
-     * The `depth` is set to 0 by default and the max supported value is 3.
+     * More information here: {@link https://www.dotcms.com/docs/latest/content-api-retrieval-and-querying#ParamsOptional}
      *
-     * @param {number} depth The depth of the relationships of a content
-     * @return {CollectionBuilder} CollectionBuilder - A CollectionBuilder instance
+     * @example
+     * ```ts
+     * const client = new DotCMSClient(config);
+     * const collectionBuilder = client.content.getCollection("Blog");
+     * collectionBuilder
+     *      .depth(1)
+     *      .then((response) => // Your code here })
+     *      .catch((error) => // Your code here })
+     * ```
+     *
+     * @param {number} depth The depth of the relationships of the content.
+     * @return {CollectionBuilder} A CollectionBuilder instance.
      * @memberof CollectionBuilder
      */
     depth(depth) {
@@ -612,11 +809,21 @@ class CollectionBuilder {
         return this;
     }
     /**
-     * Executes the fetch and returns a promise that resolves to the content or rejects to an error
+     * Executes the fetch and returns a promise that resolves to the content or rejects with an error.
+     *
+     * @example
+     * ```ts
+     * const client = new DotCMSClient(config);
+     * const collectionBuilder = client.content.getCollection("Blog");
+     * collectionBuilder
+     *      .limit(10)
+     *      .then((response) => // Your code here })
+     *      .catch((error) => // Your code here })
+     * ```
      *
-     * @param {OnFullfilled} [onfulfilled] A callback that is called when the fetch is successful
-     * @param {OnRejected} [onrejected] A callback that is called when the fetch fails
-     * @return {Promise<GetCollectionResponse<T> | GetCollectionError>} A promise that resolves to the content or rejects to an error
+     * @param {OnFullfilled} [onfulfilled] A callback that is called when the fetch is successful.
+     * @param {OnRejected} [onrejected] A callback that is called when the fetch fails.
+     * @return {Promise<GetCollectionResponse<T> | GetCollectionError>} A promise that resolves to the content or rejects with an error.
      * @memberof CollectionBuilder
      */
     then(onfulfilled, onrejected) {
@@ -630,7 +837,6 @@ class CollectionBuilder {
                 return finalResponse;
             }
             else {
-                // Fetch does not reject on server errors, so we only have to bubble up the error as a normal fetch
                 return {
                     status: response.status,
                     ...data
@@ -638,7 +844,14 @@ class CollectionBuilder {
             }
         }, onrejected);
     }
-    // Formats the response to the desired format
+    /**
+     * Formats the response to the desired format.
+     *
+     * @private
+     * @param {GetCollectionRawResponse<T>} data The raw response data.
+     * @return {GetCollectionResponse<T>} The formatted response.
+     * @memberof CollectionBuilder
+     */
     formatResponse(data) {
         const contentlets = data.entity.jsonObjectView.contentlets;
         const total = data.entity.resultsSize;
@@ -655,7 +868,13 @@ class CollectionBuilder {
             }
             : mappedResponse;
     }
-    // Calls the content API to fetch the content
+    /**
+     * Calls the content API to fetch the content.
+     *
+     * @private
+     * @return {Promise<Response>} The fetch response.
+     * @memberof CollectionBuilder
+     */
     fetch() {
         const finalQuery = this.currentQuery
             .field('languageId')
@@ -689,12 +908,63 @@ _CollectionBuilder_page = new WeakMap(), _CollectionBuilder_limit = new WeakMap(
 
 var _Content_requestOptions, _Content_serverUrl;
 /**
- * Content classs exposes the content api methods
+ * Creates a builder to filter and fetch a collection of content items.
+ * @param contentType - The content type to retrieve.
+ * @returns A CollectionBuilder instance for chaining filters and executing the query.
+ * @template T - The type of the content items (defaults to unknown).
  *
- * @export
- * @class Content
+ * @example Fetch blog posts with async/await
+ * ```typescript
+ * const response = await client.content
+ *     .getCollection<BlogPost>('Blog')
+ *     .limit(10)
+ *     .page(2)
+ *     .sortBy([{ field: 'title', order: 'asc' }])
+ *     .query(q => q.field('author').equals('John Doe'))
+ *     .depth(1)
+ *     .fetch();
+ *
+ * console.log(response.contentlets);
+ * ```
+ *
+ * @example Fetch blog posts with Promise chain
+ * ```typescript
+ * client.content
+ *     .getCollection<BlogPost>('Blog')
+ *     .limit(10)
+ *     .page(2)
+ *     .sortBy([{ field: 'title', order: 'asc' }])
+ *     .query(q => q.field('author').equals('John Doe'))
+ *     .depth(1)
+ *     .fetch()
+ *     .then(response => console.log(response.contentlets))
+ *     .catch(error => console.error(error));
+ * ```
+ *
+ * @example Using a custom type
+ * ```typescript
+ * interface BlogPost {
+ *     summary: string;
+ *     author: string;
+ *     title: string;
+ * }
+ *
+ * const posts = await client.content
+ *     .getCollection<BlogPost>('Blog')
+ *     .limit(10)
+ *     .fetch();
+ *
+ * posts.contentlets.forEach(post => {
+ *     console.log(post.title, post.author, post.summary);
+ * });
+ * ```
  */
 class Content {
+    /**
+     * Creates an instance of Content.
+     * @param {ClientOptions} requestOptions - The options for the client request.
+     * @param {string} serverUrl - The server URL.
+     */
     constructor(requestOptions, serverUrl) {
         _Content_requestOptions.set(this, void 0);
         _Content_serverUrl.set(this, void 0);
@@ -702,7 +972,11 @@ class Content {
         __classPrivateFieldSet(this, _Content_serverUrl, serverUrl, "f");
     }
     /**
-     * Takes a content type and returns a builder to filter and fetch the collection
+     * Takes a content type and returns a builder to filter and fetch the collection.
+     * @param {string} contentType - The content type to get the collection.
+     * @return {CollectionBuilder<T>} CollectionBuilder to filter and fetch the collection.
+     * @template T - Represents the type of the content type to fetch. Defaults to unknown.
+     * @memberof Content
      *
      * @example
      * ```javascript
@@ -734,7 +1008,7 @@ class Content {
      * ```
      * @example
      * ```typescript
-     * // Using an specific type for your content
+     * // Using a specific type for your content
      *
      * type Blog = {
      *     summary: string;
@@ -761,10 +1035,6 @@ class Content {
      *     });
      * ```
      *
-     * @param {string} contentType The content type to get the collection
-     * @return {CollectionBuilder} CollectionBuilder to filter and fetch the collection
-     * @template T Represents the type of the content type to fetch. Defaults to unknown
-     * @memberof Content
      */
     getCollection(contentType) {
         return new CollectionBuilder(__classPrivateFieldGet(this, _Content_requestOptions, "f"), __classPrivateFieldGet(this, _Content_serverUrl, "f"), contentType);
@@ -772,6 +1042,17 @@ class Content {
 }
 _Content_requestOptions = new WeakMap(), _Content_serverUrl = new WeakMap();
 
+/**
+ * A record of HTTP status codes and their corresponding error messages.
+ *
+ * @type {Record<number, string>}
+ * @property {string} 401 - Unauthorized. Check the token and try again.
+ * @property {string} 403 - Forbidden. Check the permissions and try again.
+ * @property {string} 404 - Not Found. Check the URL and try again.
+ * @property {string} 500 - Internal Server Error. Try again later.
+ * @property {string} 502 - Bad Gateway. Try again later.
+ * @property {string} 503 - Service Unavailable. Try again later.
+ */
 const ErrorMessages = {
     401: 'Unauthorized. Check the token and try again.',
     403: 'Forbidden. Check the permissions and try again.',
@@ -884,8 +1165,14 @@ var NOTIFY_CUSTOMER;
  * Calculates the bounding information for each page element within the given containers.
  *
  * @export
- * @param {HTMLDivElement[]} containers
- * @return {*} An array of objects containing the bounding information for each page element.
+ * @param {HTMLDivElement[]} containers - An array of HTMLDivElement representing the containers.
+ * @return {ContainerBound[]} An array of objects containing the bounding information for each page element.
+ * @example
+ * ```ts
+ * const containers = document.querySelectorAll('.container');
+ * const bounds = getPageElementBound(containers);
+ * console.log(bounds);
+ * ```
  */
 function getPageElementBound(containers) {
     return containers.map((container) => {
@@ -904,12 +1191,19 @@ function getPageElementBound(containers) {
     });
 }
 /**
- * An array of objects containing the bounding information for each contentlet inside a container.
+ * Calculates the bounding information for each contentlet inside a container.
  *
  * @export
- * @param {DOMRect} containerRect
- * @param {HTMLDivElement[]} contentlets
- * @return {*}
+ * @param {DOMRect} containerRect - The bounding rectangle of the container.
+ * @param {HTMLDivElement[]} contentlets - An array of HTMLDivElement representing the contentlets.
+ * @return {ContentletBound[]} An array of objects containing the bounding information for each contentlet.
+ * @example
+ * ```ts
+ * const containerRect = container.getBoundingClientRect();
+ * const contentlets = container.querySelectorAll('.contentlet');
+ * const bounds = getContentletsBound(containerRect, contentlets);
+ * console.log(bounds); // Element bounds within the container
+ * ```
  */
 function getContentletsBound(containerRect, contentlets) {
     return contentlets.map((contentlet) => {
@@ -937,8 +1231,14 @@ function getContentletsBound(containerRect, contentlets) {
  * Get container data from VTLS.
  *
  * @export
- * @param {HTMLElement} container
- * @return {*}
+ * @param {HTMLElement} container - The container element.
+ * @return {object} An object containing the container data.
+ * @example
+ * ```ts
+ * const container = document.querySelector('.container');
+ * const data = getContainerData(container);
+ * console.log(data);
+ * ```
  */
 function getContainerData(container) {
     return {
@@ -952,8 +1252,14 @@ function getContainerData(container) {
  * Get the closest container data from the contentlet.
  *
  * @export
- * @param {Element} element
- * @return {*}
+ * @param {Element} element - The contentlet element.
+ * @return {object | null} An object containing the closest container data or null if no container is found.
+ * @example
+ * ```ts
+ * const contentlet = document.querySelector('.contentlet');
+ * const data = getClosestContainerData(contentlet);
+ * console.log(data);
+ * ```
  */
 function getClosestContainerData(element) {
     // Find the closest ancestor element with data-dot-object="container" attribute
@@ -973,8 +1279,12 @@ function getClosestContainerData(element) {
  * Find the closest contentlet element based on HTMLElement.
  *
  * @export
- * @param {(HTMLElement | null)} element
- * @return {*}
+ * @param {HTMLElement | null} element - The starting element.
+ * @return {HTMLElement | null} The closest contentlet element or null if not found.
+ * @example
+ * const element = document.querySelector('.some-element');
+ * const contentlet = findDotElement(element);
+ * console.log(contentlet);
  */
 function findDotElement(element) {
     if (!element)
@@ -985,6 +1295,19 @@ function findDotElement(element) {
     }
     return findDotElement(element?.['parentElement']);
 }
+/**
+ * Find VTL data within a target element.
+ *
+ * @export
+ * @param {HTMLElement} target - The target element to search within.
+ * @return {Array<{ inode: string, name: string }> | null} An array of objects containing VTL data or null if none found.
+ * @example
+ * ```ts
+ * const target = document.querySelector('.target-element');
+ * const vtlData = findVTLData(target);
+ * console.log(vtlData);
+ * ```
+ */
 function findVTLData(target) {
     const vltElements = target.querySelectorAll('[data-dot-object="vtl-file"]');
     if (!vltElements.length) {
@@ -997,6 +1320,18 @@ function findVTLData(target) {
         };
     });
 }
+/**
+ * Check if the scroll position is at the bottom of the page.
+ *
+ * @export
+ * @return {boolean} True if the scroll position is at the bottom, otherwise false.
+ * @example
+ * ```ts
+ * if (scrollIsInBottom()) {
+ *     console.log('Scrolled to the bottom');
+ * }
+ * ```
+ */
 function scrollIsInBottom() {
     const documentHeight = document.documentElement.scrollHeight;
     const viewportHeight = window.innerHeight;
@@ -1024,7 +1359,7 @@ function setBounds() {
     });
 }
 /**
- * Listens for editor messages and performs corresding actions based on the received message.
+ * Listens for editor messages and performs corresponding actions based on the received message.
  *
  * @private
  * @memberof DotCMSPageEditor
@@ -1041,10 +1376,8 @@ function listenEditorMessages() {
             const direction = event.data.direction;
             if ((window.scrollY === 0 && direction === 'up') ||
                 (scrollIsInBottom() && direction === 'down')) {
-                /**
-                 * If the iframe scroll is in the top of bottom, we dont send anything.
-                 * This to avoid the lost of scrollend event
-                 **/
+                // If the iframe scroll is at the top or bottom, do not send anything.
+                // This avoids losing the scrollend event.
                 return;
             }
             const scrollY = direction === 'up' ? -120 : 120;
@@ -1092,8 +1425,8 @@ function listenHoveredContentlet() {
         const vtlFiles = findVTLData(foundElement);
         const contentletPayload = {
             container: 
-            // Here extract dot-container from contentlet if is Headless
-            // or search in parent container if is VTL
+            // Here extract dot-container from contentlet if it is Headless
+            // or search in parent container if it is VTL
             foundElement.dataset?.['dotContainer']
                 ? JSON.parse(foundElement.dataset?.['dotContainer'])
                 : getClosestContainerData(foundElement),
@@ -1166,10 +1499,12 @@ function fetchPageDataFromInsideUVE(pathname) {
 }
 
 /**
- *
  * Updates the navigation in the editor.
+ *
  * @param {string} pathname - The pathname to update the navigation with.
  * @memberof DotCMSPageEditor
+ * @example
+ * updateNavigation('/home'); // Sends a message to the editor to update the navigation to '/home'
  */
 function updateNavigation(pathname) {
     postMessageToEditor({
@@ -1181,7 +1516,16 @@ function updateNavigation(pathname) {
 }
 /**
  * Checks if the code is running inside an editor.
+ *
  * @returns {boolean} Returns true if the code is running inside an editor, otherwise false.
+ * @example
+ * ```ts
+ * if (isInsideEditor()) {
+ *     console.log('Running inside the editor');
+ * } else {
+ *     console.log('Running outside the editor');
+ * }
+ * ```
  */
 function isInsideEditor() {
     if (typeof window === 'undefined') {
@@ -1192,7 +1536,12 @@ function isInsideEditor() {
 /**
  * Initializes the DotCMS page editor.
  *
- * @param conf - Optional configuration for the editor.
+ * @param {DotCMSPageEditorConfig} config - Optional configuration for the editor.
+ * @example
+ * ```ts
+ * const config = { pathname: '/home' };
+ * initEditor(config); // Initializes the editor with the provided configuration
+ * ```
  */
 function initEditor(config) {
     fetchPageDataFromInsideUVE(config.pathname);
@@ -1202,6 +1551,11 @@ function initEditor(config) {
 }
 /**
  * Destroys the editor by removing event listeners and disconnecting observers.
+ *
+ * @example
+ * ```ts
+ * destroyEditor(); // Cleans up the editor by removing all event listeners and disconnecting observers
+ * ```
  */
 function destroyEditor() {
     subscriptions.forEach((subscription) => {
@@ -1225,18 +1579,49 @@ function getHostURL(url) {
 }
 /**
  * `DotCmsClient` is a TypeScript class that provides methods to interact with the DotCMS REST API.
- * It requires a configuration object on instantiation, which includes the DotCMS URL, site ID, and authentication token.
+ * DotCMS is a hybrid-headless CMS and digital experience platform.
  *
  * @class DotCmsClient
- *
  * @property {ClientConfig} config - The configuration object for the DotCMS client.
+ * @property {Content} content - Provides methods to interact with content in DotCMS.
  *
  * @method constructor(config: ClientConfig) - Constructs a new instance of the DotCmsClient class.
  *
- * @method page.get(options: PageApiOptions): Promise<unknown> - Retrieves all the elements of any Page in your dotCMS system in JSON format.
+ * @method page.get(options: PageApiOptions): Promise<PageApiResponse> - Retrieves all the elements of any Page in your dotCMS system in JSON format.
+ * The Page API enables you to retrieve page information, layout, template, content blocks, and more.
+ * @see {@link https://www.dotcms.com/docs/latest/page-rest-api-layout-as-a-service-laas}
+ *
+ * @method nav.get(options: NavApiOptions = { depth: 0, path: '/', languageId: 1 }): Promise<NavApiResponse> - Retrieves information about the dotCMS file and folder tree.
+ * The Navigation API allows you to fetch the site structure and menu items.
+ * @see {@link https://www.dotcms.com/docs/latest/navigation-rest-api}
+ *
+ * @method content.get(options: ContentApiOptions): Promise<ContentApiResponse> - Retrieves content items based on specified criteria.
+ * The Content API allows you to query and retrieve content by ID, inode, or using Lucene queries.
+ * @see {@link https://www.dotcms.com/docs/latest/content-api-retrieval-and-querying}
+ *
+ * @method editor.on(action: string, callbackFn: (payload: unknown) => void) - Allows you to react to actions issued by the Universal Visual Editor (UVE).
+ * @method editor.off(action: string) - Stops listening to an action issued by UVE.
+ *
+ * @static
+ * @method init(config: ClientConfig): DotCmsClient - Initializes and returns a DotCmsClient instance.
+ * @method dotcmsUrl: string - Retrieves the DotCMS URL from the instance configuration.
+ *
+ * @example <caption>Basic usage</caption>
+ * ```javascript
+ * const client = DotCmsClient.init({ dotcmsUrl: 'https://demo.dotcms.com', authToken: 'your-auth-token' });
  *
- * @method nav.get(options: NavApiOptions = { depth: 0, path: '/', languageId: 1 }): Promise<unknown> - Retrieves information about the dotCMS file and folder tree.
+ * // Get a page
+ * client.page.get({ path: '/about-us' }).then(response => console.log(response));
  *
+ * // Get navigation
+ * client.nav.get({ path: '/about-us', depth: 2 }).then(response => console.log(response));
+ *
+ * // Get content
+ * client.content.get({ query: '+contentType:Blog +languageId:1', limit: 10 }).then(response => console.log(response));
+ *
+ * // Listen to editor changes
+ * client.editor.on('changes', (payload) => console.log('Changes detected:', payload));
+ * ```
  */
 class DotCmsClient {
     constructor(config = { dotcmsUrl: '', authToken: '', requestOptions: {}, siteId: '' }) {
@@ -1256,6 +1641,11 @@ class DotCmsClient {
              * @param {PageApiOptions} options - The options for the Page API call.
              * @returns {Promise<unknown>} - A Promise that resolves to the response from the DotCMS API.
              * @throws {Error} - Throws an error if the options are not valid.
+             * @example
+             * ```ts
+             * const client = new DotCmsClient({ dotcmsUrl: 'https://your.dotcms.com', authToken: 'your-auth-token', siteId: 'your-site-id' });
+             * client.page.get({ path: '/about-us' }).then(response => console.log(response));
+             * ```
              */
             get: async (options) => {
                 this.validatePageOptions(options);
@@ -1297,8 +1687,14 @@ class DotCmsClient {
              * `editor.on` is an asynchronous method of the `DotCmsClient` class that allows you to react to actions issued by the UVE.
              *
              *  NOTE: This is being used by the development team - This logic is probably varied or moved to another function/object.
-             * @param action - The name of the name emitted by UVE
-             * @param callbackFn - The function to execute when the UVE emits the action
+             * @param {string} action - The name of the action emitted by UVE.
+             * @param {function} callbackFn - The function to execute when the UVE emits the action.
+             * @example
+             * ```ts
+             * client.editor.on('changes', (payload) => {
+             *     console.log('Changes detected:', payload);
+             * });
+             * ```
              */
             on: (action, callbackFn) => {
                 if (!isInsideEditor()) {
@@ -1315,10 +1711,14 @@ class DotCmsClient {
                 }
             },
             /**
-             * `editor.off` is an synchronous method of the `DotCmsClient` class that allows you to stop listening and reacting to an action issued by UVE.
+             * `editor.off` is a synchronous method of the `DotCmsClient` class that allows you to stop listening and reacting to an action issued by UVE.
              *
-             *  NOTE: This is being used by the development team - This logic is probably varied or moved to another function/object.
-             * @param action
+             * NOTE: This is being used by the development team - This logic is probably varied or moved to another function/object.
+             * @param {string} action - The name of the action to stop listening to.
+             * @example
+             * ```ts
+             * client.editor.off('changes');
+             * ```
              */
             off: (action) => {
                 const listenerIndex = __classPrivateFieldGet(this, _DotCmsClient_listeners, "f").findIndex((listener) => listener.action === action);
@@ -1340,6 +1740,11 @@ class DotCmsClient {
              * @param {NavApiOptions} options - The options for the Nav API call. Defaults to `{ depth: 0, path: '/', languageId: 1 }`.
              * @returns {Promise<unknown>} - A Promise that resolves to the response from the DotCMS API.
              * @throws {Error} - Throws an error if the options are not valid.
+             * @example
+             * ```ts
+             * const client = new DotCmsClient({ dotcmsUrl: 'https://your.dotcms.com', authToken: 'your-auth-token', siteId: 'your-site-id' }});
+             * client.nav.get({ path: '/about-us', depth: 2 }).then(response => console.log(response));
+             * ```
              */
             get: async (options = { depth: 0, path: '/', languageId: 1 }) => {
                 this.validateNavOptions(options);
@@ -1382,20 +1787,46 @@ class DotCmsClient {
         }, "f");
         this.content = new Content(__classPrivateFieldGet(this, _DotCmsClient_requestOptions, "f"), __classPrivateFieldGet(this, _DotCmsClient_config, "f").dotcmsUrl);
     }
+    /**
+     * Initializes the DotCmsClient instance with the provided configuration.
+     * If an instance already exists, it returns the existing instance.
+     *
+     * @param {ClientConfig} config - The configuration object for the DotCMS client.
+     * @returns {DotCmsClient} - The initialized DotCmsClient instance.
+     * @example
+     * ```ts
+     * const client = DotCmsClient.init({ dotcmsUrl: 'https://demo.dotcms.com', authToken: 'your-auth-token' });
+     * ```
+     */
     static init(config) {
         if (this.instance) {
             console.warn('DotCmsClient has already been initialized. Please use the instance to interact with the DotCMS API.');
         }
         return this.instance ?? (this.instance = new DotCmsClient(config));
     }
+    /**
+     * Retrieves the DotCMS URL from the instance configuration.
+     *
+     * @returns {string} - The DotCMS URL.
+     */
     static get dotcmsUrl() {
         return (this.instance && __classPrivateFieldGet(this.instance, _DotCmsClient_config, "f").dotcmsUrl) || '';
     }
+    /**
+     * Throws an error if the path is not valid.
+     *
+     * @returns {string} - The authentication token.
+     */
     validatePageOptions(options) {
         if (!options.path) {
             throw new Error("The 'path' parameter is required for the Page API");
         }
     }
+    /**
+     * Throws an error if the path is not valid.
+     *
+     *  @returns {string} - The authentication token.
+     */
     validateNavOptions(options) {
         if (!options.path) {
             throw new Error("The 'path' parameter is required for the Nav API");
@@ -1404,15 +1835,25 @@ class DotCmsClient {
 }
 _DotCmsClient_config = new WeakMap(), _DotCmsClient_requestOptions = new WeakMap(), _DotCmsClient_listeners = new WeakMap();
 
-// For now, we are not typing the functions in this file
-/* eslint-disable @typescript-eslint/no-explicit-any */
-const graphqlToPageEntity = ({ page }) => {
+/**
+ * Transforms a GraphQL Page response to a Page Entity.
+ *
+ * @param {GraphQLPageResponse} graphQLPageResponse - The GraphQL Page response object.
+ * @returns {object|null} The transformed Page Entity or null if the page is not present.
+ *
+ * @example
+ * ```ts
+ * const pageEntity = graphqlToPageEntity(graphQLPageResponse);
+ * ```
+ */
+const graphqlToPageEntity = (graphQLPageResponse) => {
+    const { page } = graphQLPageResponse;
     // If there is no page, return null
     if (!page) {
         return null;
     }
     const { layout, template, containers, urlContentMap, viewAs, site, _map, ...pageAsset } = page;
-    const data = _map || {};
+    const data = (_map || {});
     return {
         layout,
         template,
@@ -1426,6 +1867,12 @@ const graphqlToPageEntity = ({ page }) => {
         containers: parseContainers(containers)
     };
 };
+/**
+ * Parses the containers from the GraphQL response.
+ *
+ * @param {Array<Record<string, unknown>>} [containers=[]] - The containers array from the GraphQL response.
+ * @returns {Record<string, unknown>} The parsed containers.
+ */
 const parseContainers = (containers = []) => {
     return containers.reduce((acc, container) => {
         const { path, identifier, containerStructures, containerContentlets, ...rest } = container;
@@ -1442,7 +1889,13 @@ const parseContainers = (containers = []) => {
         return acc;
     }, {});
 };
-const parseContentletsToUuidMap = (containerContentlets) => {
+/**
+ * Parses the contentlets from the GraphQL response.
+ *
+ * @param {Array<Record<string, unknown>>} containerContentlets - The contentlets array from the GraphQL response.
+ * @returns {Record<string, Array<Record<string, unknown>>>} The parsed contentlets mapped by UUID.
+ */
+const parseContentletsToUuidMap = (containerContentlets = []) => {
     return containerContentlets.reduce((acc, containerContentlet) => {
         const { uuid, contentlets } = containerContentlet;
         // TODO: This is a temporary solution, we need to find a better way to handle this.
@@ -1456,6 +1909,16 @@ const parseContentletsToUuidMap = (containerContentlets) => {
     }, {});
 };
 
+/**
+ * Generates the page request parameters to be used in the API call.
+ *
+ * @param {PageRequestParamsProps} PageRequestParamsProps - The properties for the page request.
+ * @returns {PageApiOptions} The options for the page API.
+ * @example
+ * ```ts
+ * const pageApiOptions = getPageRequestParams({ path: '/api/v1/page', params: queryParams });
+ * ```
+ */
 const getPageRequestParams = ({ path = '', params = {} }) => {
     const copiedParams = params instanceof URLSearchParams ? Object.fromEntries(params.entries()) : { ...params };
     const finalParams = {};