@sitecore-cloudsdk/search 0.5.0-rc.0 → 0.5.1-rc.0

package/dist/cjs/src/lib/request-entities/filters/facet/list-facet-filter.js

@@ -6,15 +6,15 @@ exports.ListFacetFilter = void 0;
  */
 class ListFacetFilter {
     /**
-     * @param operator - The operator to be applied on attribute.
-     * @param values - The values to check against of.
+     * @param operator - The {@link ListOperators} to be applied on attribute.
+     * @param values - The values[] to check against of.
      */
     constructor(operator, values) {
         this._operator = operator;
         this._values = values;
     }
     /**
-     * @returns The DTO representation of the filter.
+     * @returns The DTO representation of the filter {@link ListFacetFilterDTO}.
      */
     toDTO() {
         return {

package/dist/cjs/src/lib/request-entities/filters/facet/logical-facet-filter.d.ts

@@ -8,12 +8,12 @@ export declare class LogicalFacetFilter implements FacetFilterBase {
     private _operator;
     private _value;
     /**
-     * @param operator - The operator to be applied on attribute.
-     * @param value - The value to check against of.
+     * @param operator - The {@link LogicalOperators} to be applied on attribute excluding `not`.
+     * @param value - The {@link FacetFilter}[] to check against of.
      */
     constructor(operator: Exclude<LogicalOperators, 'not'>, value: Array<FacetFilter>);
     /**
-     * @returns The DTO representation of the filter.
+     * @returns The DTO representation of the filter {@link LogicalFacetFilterDTO}.
      */
     toDTO(): LogicalFacetFilterDTO;
 }

package/dist/cjs/src/lib/request-entities/filters/facet/logical-facet-filter.js

@@ -6,15 +6,15 @@ exports.LogicalFacetFilter = void 0;
  */
 class LogicalFacetFilter {
     /**
-     * @param operator - The operator to be applied on attribute.
-     * @param value - The value to check against of.
+     * @param operator - The {@link LogicalOperators} to be applied on attribute excluding `not`.
+     * @param value - The {@link FacetFilter}[] to check against of.
      */
     constructor(operator, value) {
         this._operator = operator;
         this._value = value;
     }
     /**
-     * @returns The DTO representation of the filter.
+     * @returns The DTO representation of the filter {@link LogicalFacetFilterDTO}.
      */
     toDTO() {
         return {

package/dist/cjs/src/lib/request-entities/filters/facet/not-facet-filter.d.ts

@@ -2,6 +2,13 @@ import type { FacetFilter } from '../../widgets/interfaces';
 import type { FacetFilterBase, NotFacetFilterDTO } from './interfaces';
 export declare class NotFacetFilter implements FacetFilterBase {
     private _value;
+    /**
+     * @param value - the {@link FacetFilter} | string to check against to.
+     */
     constructor(value: string | FacetFilter);
+    /**
+     *
+     * @returns the DTO represantation of notFacetFilter {@link NotFacetFilterDTO}.
+     */
     toDTO(): NotFacetFilterDTO;
 }

package/dist/cjs/src/lib/request-entities/filters/facet/not-facet-filter.js

@@ -2,9 +2,16 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.NotFacetFilter = void 0;
 class NotFacetFilter {
+    /**
+     * @param value - the {@link FacetFilter} | string to check against to.
+     */
     constructor(value) {
         this._value = value;
     }
+    /**
+     *
+     * @returns the DTO represantation of notFacetFilter {@link NotFacetFilterDTO}.
+     */
     toDTO() {
         /**
          * If the value is a string, it probably means that it is a facet filter id.

package/dist/cjs/src/lib/request-entities/filters/geo-filter.d.ts

@@ -8,12 +8,17 @@ export declare class GeoFilter extends BaseFilter {
     private _attributeName;
     /**
      * @param attributeName - The name of the attribute to filter.
-     * @param geoFilterData - The geo filter data like location and distance.
+     * @param geoFilterData - The {@link GeoFilterData} like location and distance.
      */
     constructor(attributeName: string, geoFilterData?: GeoFilterData);
+    /**
+     * Throws an error if latitude or longitude are not present.
+     * @param location - {@link LocationData}
+     * @throws - {@link ErrorMessages.IV_0012} | {@link ErrorMessages.IV_0013}
+     */
     private _validateLocation;
     /**
-     * @returns The DTO representation of the filter.
+     * @returns The DTO representation of the filter {@link GeoFilterDTO}.
      */
     toDTO(): GeoFilterDTO;
 }

package/dist/cjs/src/lib/request-entities/filters/geo-filter.js

@@ -12,7 +12,7 @@ exports.GEO_FILTER_TYPE = 'geoDistance';
 class GeoFilter extends base_filter_1.BaseFilter {
     /**
      * @param attributeName - The name of the attribute to filter.
-     * @param geoFilterData - The geo filter data like location and distance.
+     * @param geoFilterData - The {@link GeoFilterData} like location and distance.
      */
     constructor(attributeName, geoFilterData) {
         super(exports.GEO_FILTER_TYPE, geoFilterData);
@@ -20,6 +20,11 @@ class GeoFilter extends base_filter_1.BaseFilter {
             this._validateLocation(geoFilterData.location);
         this._attributeName = attributeName;
     }
+    /**
+     * Throws an error if latitude or longitude are not present.
+     * @param location - {@link LocationData}
+     * @throws - {@link ErrorMessages.IV_0012} | {@link ErrorMessages.IV_0013}
+     */
     _validateLocation(location) {
         const result = (0, utils_1.isValidLocation)(location);
         if (!result.latitude)
@@ -28,7 +33,7 @@ class GeoFilter extends base_filter_1.BaseFilter {
             throw new Error(consts_1.ErrorMessages.IV_0013);
     }
     /**
-     * @returns The DTO representation of the filter.
+     * @returns The DTO representation of the filter {@link GeoFilterDTO}.
      */
     toDTO() {
         const dto = {

package/dist/cjs/src/lib/request-entities/filters/geo-within-filter.d.ts

@@ -8,12 +8,18 @@ export declare class GeoWithinFilter extends BaseFilter {
     private _attributeName;
     /**
      * @param attributeName - The name of the attribute to filter.
-     * @param geoWithinFilterData - The geo within filter data. Array of location objects.
+     * @param geoWithinFilterData - The {@link GeoWithinFilterData}. Array of location objects.
      */
     constructor(attributeName: string, geoWithinFilterData: GeoWithinFilterData);
+    /**
+     * Throws an error if latitude or longitude are not present.
+     *
+     * @param location - {@link LocationData}
+     * @throws - {@link ErrorMessages.IV_0012} | {@link ErrorMessages.IV_0013}
+     */
     private _validateLocation;
     /**
-     * @returns The DTO representation of the filter.
+     * @returns The DTO representation of the filter {@link GeoWithinFilterDTO}.
      */
     toDTO(): GeoWithinFilterDTO;
 }

package/dist/cjs/src/lib/request-entities/filters/geo-within-filter.js

@@ -12,13 +12,19 @@ exports.GEO_FILTER_TYPE = 'geoWithin';
 class GeoWithinFilter extends base_filter_1.BaseFilter {
     /**
      * @param attributeName - The name of the attribute to filter.
-     * @param geoWithinFilterData - The geo within filter data. Array of location objects.
+     * @param geoWithinFilterData - The {@link GeoWithinFilterData}. Array of location objects.
      */
     constructor(attributeName, geoWithinFilterData) {
         super(exports.GEO_FILTER_TYPE, geoWithinFilterData);
         geoWithinFilterData.forEach((location) => this._validateLocation(location));
         this._attributeName = attributeName;
     }
+    /**
+     * Throws an error if latitude or longitude are not present.
+     *
+     * @param location - {@link LocationData}
+     * @throws - {@link ErrorMessages.IV_0012} | {@link ErrorMessages.IV_0013}
+     */
     _validateLocation(location) {
         const result = (0, utils_1.isValidLocation)(location);
         if (!result.latitude)
@@ -27,7 +33,7 @@ class GeoWithinFilter extends base_filter_1.BaseFilter {
             throw new Error(consts_1.ErrorMessages.IV_0013);
     }
     /**
-     * @returns The DTO representation of the filter.
+     * @returns The DTO representation of the filter {@link GeoWithinFilterDTO}.
      */
     toDTO() {
         const dto = {

package/dist/cjs/src/lib/request-entities/filters/list-filter.d.ts

@@ -7,12 +7,12 @@ export declare class ListFilter extends BaseFilter {
     private _attributeName;
     /**
      * @param attributeName - The name of the attribute to filter.
-     * @param operator - The operator to be applied on attribute.
-     * @param value - The value to check against of.
+     * @param operator - The {@link ListOperators} to be applied on attribute.
+     * @param value - The value[] to check against of.
      */
     constructor(attributeName: string, operator: ListOperators, value: unknown[]);
     /**
-     * @returns The DTO representation of the filter.
+     * @returns The DTO representation of the filter {@link ListFilterDTO}.
      */
     toDTO(): ListFilterDTO;
 }

package/dist/cjs/src/lib/request-entities/filters/list-filter.js

@@ -9,15 +9,15 @@ const base_filter_1 = require("./base-filter");
 class ListFilter extends base_filter_1.BaseFilter {
     /**
      * @param attributeName - The name of the attribute to filter.
-     * @param operator - The operator to be applied on attribute.
-     * @param value - The value to check against of.
+     * @param operator - The {@link ListOperators} to be applied on attribute.
+     * @param value - The value[] to check against of.
      */
     constructor(attributeName, operator, value) {
         super(operator, value);
         this._attributeName = attributeName;
     }
     /**
-     * @returns The DTO representation of the filter.
+     * @returns The DTO representation of the filter {@link ListFilterDTO}.
      */
     toDTO() {
         return {

package/dist/cjs/src/lib/request-entities/filters/logical-filter.d.ts

@@ -6,11 +6,12 @@ import type { LogicalFilterValues, PickLogicalDTO } from './interfaces';
 export declare class LogicalFilter<T extends keyof LogicalFilterValues> extends BaseFilter {
     /**
      * @param operator - The operator to be applied on attribute.
-     * @param value - The value to check against. Using "and" or the "or" filter, you must include minimum 2 filters.
+     * @param value - The {@link LogicalFilterValues} to check against.
+     * Using "and" or the "or" filter, you must include minimum 2 filters.
      */
     constructor(operator: T, value: LogicalFilterValues[T]);
     /**
-     * @returns The DTO representation of the filter.
+     * @returns The DTO representation of the filter {@link PickLogicalDTO}.
      */
     toDTO(): PickLogicalDTO<T>;
 }

package/dist/cjs/src/lib/request-entities/filters/logical-filter.js

@@ -9,13 +9,14 @@ const base_filter_1 = require("./base-filter");
 class LogicalFilter extends base_filter_1.BaseFilter {
     /**
      * @param operator - The operator to be applied on attribute.
-     * @param value - The value to check against. Using "and" or the "or" filter, you must include minimum 2 filters.
+     * @param value - The {@link LogicalFilterValues} to check against.
+     * Using "and" or the "or" filter, you must include minimum 2 filters.
      */
     constructor(operator, value) {
         super(operator, value);
     }
     /**
-     * @returns The DTO representation of the filter.
+     * @returns The DTO representation of the filter {@link PickLogicalDTO}.
      */
     toDTO() {
         if (this.operator === 'not')

package/dist/cjs/src/lib/request-entities/widgets/interfaces.d.ts

@@ -144,6 +144,7 @@ export interface SearchOptions extends ResultsOptions {
     suggestion?: ArrayOfAtLeastOne<SearchSuggestionOptions>;
     ranking?: ArrayOfAtLeastOne<SearchRankingOptions>;
     personalization?: SearchPersonalizationOptions;
+    disableGrouping?: boolean;
 }
 /**
  * Represents the search object of the search widget item in its DTO format.
@@ -156,6 +157,7 @@ export interface SearchDTO extends ResultsItemDTO {
     suggestion?: ArrayOfAtLeastOne<SearchSuggestionOptionsDTO>;
     ranking?: ArrayOfAtLeastOne<SearchRankingOptionsDto>;
     personalization?: SearchPersonalizationOptionsDto;
+    disable_grouping?: boolean;
 }
 /**
  * Represents the search widget item object in its DTO format.

package/dist/cjs/src/lib/request-entities/widgets/questions-answers-widget-item.d.ts

@@ -8,15 +8,22 @@ export declare class QuestionsAnswersWidgetItem extends RuleWidgetItem {
      * Creates and holds the functionality of a questions answers widget item.
      * @param entity - The widget's item entity.
      * @param widgetId - The widget's item id.
-     * @param questionsAnswersOptions - The widget's questions answers options object.
+     * @param questionsAnswersOptions - The widget's {@link QuestionsAnswersOptions} object.
+     * @throws - {@link ErrorMessages.IV_0007} | {@link ErrorMessages.IV_0008} | {@link ErrorMessages.IV_0009}
      */
     constructor(entity: string, widgetId: string, questionsAnswersOptions: QuestionsAnswersOptions);
+    /**
+     * Throws an error if limit is outside of range of 1 ~ 100 or offset is not a positive integer
+     * @param relatedQuestions - {@link RelatedQuestionsOptions}
+     * @throws - {@link ErrorMessages.IV_0007} | {@link ErrorMessages.IV_0008}
+     */
     private _validateRelatedQuestions;
     /**
      * Sets the keyphrase for the QuestionsAnswersWidgetItem.
      * This method updates the `keyphrase` property of the questions answers configuration.
      *
      * @param keyphrase - The keyphrase that the visitor enters to search for relevant content.
+     * @throws - {@link ErrorMessages.IV_0009}
      */
     set keyphrase(keyphrase: string);
     /**
@@ -27,11 +34,11 @@ export declare class QuestionsAnswersWidgetItem extends RuleWidgetItem {
      * Sets the exactAnswer for the QuestionsAnswersWidgetItem.
      * This method updates the `exactAnswer` property of the questions answers configuration.
      *
-     * @param exactAnswer - The exactAnswer that the visitor enters to search for relevant content.
+     * @param exactAnswer - The {@link ExactAnswerOptions} that the visitor enters to search for relevant content.
      */
     set exactAnswer(exactAnswer: ExactAnswerOptions);
     /**
-     * @returns The exactAnswer property of the QuestionsAnswersWidgetItem.
+     * @returns The {@link ExactAnswerOptions} `exactAnswer` property of the QuestionsAnswersWidgetItem.
      */
     get exactAnswer(): ExactAnswerOptions | undefined;
     /**
@@ -42,21 +49,30 @@ export declare class QuestionsAnswersWidgetItem extends RuleWidgetItem {
      * Sets the relatedQuestions for the QuestionsAnswersWidgetItem.
      * This method updates the `relatedQuestions` property of the questions answers configuration.
      *
-     * @param relatedQuestions - The relatedQuestions that the visitor enters to search for relevant content.
+     * @param relatedQuestions - {@link RelatedQuestionsOptions} that the visitor enters to search for relevant content.
+     * @throws - {@link ErrorMessages.IV_0007} | {@link ErrorMessages.IV_0008}
      */
     set relatedQuestions(relatedQuestions: RelatedQuestionsOptions);
     /**
-     * @returns The relatedQuestions property of the QuestionsAnswersWidgetItem.
+     * @returns The {@link RelatedQuestionsOptions} `relatedQuestions` property of the QuestionsAnswersWidgetItem.
      */
     get relatedQuestions(): RelatedQuestionsOptions | undefined;
     /**
      * Sets the relatedQuestions to undefined
      */
     resetRelatedQuestions(): void;
+    /**
+     *
+     * @returns exactAnswer property in its DTO format.
+     */
     private _exactAnswerToDTO;
+    /**
+     *
+     * @returns relatedQuestions property in its DTO format.
+     */
     private _relatedQuestionsToDTO;
     /**
-     * Maps the questions answers widget item to its DTO format.
+     * Maps the questions answers widget item to its DTO format {@link QuestionsAnswersWidgetItemDTO}.
      */
     toDTO(): QuestionsAnswersWidgetItemDTO;
 }

package/dist/cjs/src/lib/request-entities/widgets/questions-answers-widget-item.js

@@ -9,7 +9,8 @@ class QuestionsAnswersWidgetItem extends rule_widget_item_1.RuleWidgetItem {
      * Creates and holds the functionality of a questions answers widget item.
      * @param entity - The widget's item entity.
      * @param widgetId - The widget's item id.
-     * @param questionsAnswersOptions - The widget's questions answers options object.
+     * @param questionsAnswersOptions - The widget's {@link QuestionsAnswersOptions} object.
+     * @throws - {@link ErrorMessages.IV_0007} | {@link ErrorMessages.IV_0008} | {@link ErrorMessages.IV_0009}
      */
     constructor(entity, widgetId, questionsAnswersOptions) {
         super(entity, widgetId, questionsAnswersOptions.rule);
@@ -21,6 +22,11 @@ class QuestionsAnswersWidgetItem extends rule_widget_item_1.RuleWidgetItem {
             this._relatedQuestions = questionsAnswersOptions.relatedQuestions;
         }
     }
+    /**
+     * Throws an error if limit is outside of range of 1 ~ 100 or offset is not a positive integer
+     * @param relatedQuestions - {@link RelatedQuestionsOptions}
+     * @throws - {@link ErrorMessages.IV_0007} | {@link ErrorMessages.IV_0008}
+     */
     _validateRelatedQuestions(relatedQuestions) {
         this._validateNumberInRange1To100(consts_1.ErrorMessages.IV_0007, relatedQuestions.limit);
         this._validatePositiveInteger(consts_1.ErrorMessages.IV_0008, relatedQuestions.offset);
@@ -30,6 +36,7 @@ class QuestionsAnswersWidgetItem extends rule_widget_item_1.RuleWidgetItem {
      * This method updates the `keyphrase` property of the questions answers configuration.
      *
      * @param keyphrase - The keyphrase that the visitor enters to search for relevant content.
+     * @throws - {@link ErrorMessages.IV_0009}
      */
     set keyphrase(keyphrase) {
         this._validateStringLengthInRange1To100(consts_1.ErrorMessages.IV_0009, keyphrase);
@@ -45,13 +52,13 @@ class QuestionsAnswersWidgetItem extends rule_widget_item_1.RuleWidgetItem {
      * Sets the exactAnswer for the QuestionsAnswersWidgetItem.
      * This method updates the `exactAnswer` property of the questions answers configuration.
      *
-     * @param exactAnswer - The exactAnswer that the visitor enters to search for relevant content.
+     * @param exactAnswer - The {@link ExactAnswerOptions} that the visitor enters to search for relevant content.
      */
     set exactAnswer(exactAnswer) {
         this._exactAnswer = exactAnswer;
     }
     /**
-     * @returns The exactAnswer property of the QuestionsAnswersWidgetItem.
+     * @returns The {@link ExactAnswerOptions} `exactAnswer` property of the QuestionsAnswersWidgetItem.
      */
     get exactAnswer() {
         return this._exactAnswer;
@@ -66,14 +73,15 @@ class QuestionsAnswersWidgetItem extends rule_widget_item_1.RuleWidgetItem {
      * Sets the relatedQuestions for the QuestionsAnswersWidgetItem.
      * This method updates the `relatedQuestions` property of the questions answers configuration.
      *
-     * @param relatedQuestions - The relatedQuestions that the visitor enters to search for relevant content.
+     * @param relatedQuestions - {@link RelatedQuestionsOptions} that the visitor enters to search for relevant content.
+     * @throws - {@link ErrorMessages.IV_0007} | {@link ErrorMessages.IV_0008}
      */
     set relatedQuestions(relatedQuestions) {
         this._validateRelatedQuestions(relatedQuestions);
         this._relatedQuestions = relatedQuestions;
     }
     /**
-     * @returns The relatedQuestions property of the QuestionsAnswersWidgetItem.
+     * @returns The {@link RelatedQuestionsOptions} `relatedQuestions` property of the QuestionsAnswersWidgetItem.
      */
     get relatedQuestions() {
         return this._relatedQuestions;
@@ -84,11 +92,19 @@ class QuestionsAnswersWidgetItem extends rule_widget_item_1.RuleWidgetItem {
     resetRelatedQuestions() {
         this._relatedQuestions = undefined;
     }
+    /**
+     *
+     * @returns exactAnswer property in its DTO format.
+     */
     _exactAnswerToDTO() {
         if (!this._exactAnswer)
             return;
         return { include_sources: this._exactAnswer.includeSources, query_types: this._exactAnswer.queryTypes };
     }
+    /**
+     *
+     * @returns relatedQuestions property in its DTO format.
+     */
     _relatedQuestionsToDTO() {
         if (!this._relatedQuestions)
             return;
@@ -101,7 +117,7 @@ class QuestionsAnswersWidgetItem extends rule_widget_item_1.RuleWidgetItem {
         };
     }
     /**
-     * Maps the questions answers widget item to its DTO format.
+     * Maps the questions answers widget item to its DTO format {@link QuestionsAnswersWidgetItemDTO}.
      */
     toDTO() {
         return {

package/dist/cjs/src/lib/request-entities/widgets/recommendation-widget-item.d.ts

@@ -6,7 +6,8 @@ export declare class RecommendationWidgetItem extends ResultsWidgetItem {
      * Creates and holds the functionality of a recommendation widget item.
      * @param entity - The widget's item entity.
      * @param widgetId - The widget's item id.
-     * @param recommendationOptions - The widget's recommendation options object.
+     * @param recommendationOptions - The widget's {@link RecommendationOptions} object.
+     * @throws - {@link ErrorMessages.IV_0023} | {@link ErrorMessages.IV_0024}
      */
     constructor(entity: string, widgetId: string, recommendationOptions?: RecommendationOptions);
     /**
@@ -20,20 +21,25 @@ export declare class RecommendationWidgetItem extends ResultsWidgetItem {
      * If not provided, the API uses the recipe specified in CEC.
      *
      * @param recipe - {@link Recipe} The recipe configuration with id and version.
-     * @throws Error If the recipe id is empty or version is less than 1.
+     * @throws - {@link ErrorMessages.IV_0023} | {@link ErrorMessages.IV_0024}
      */
     set recipe(recipe: Recipe);
     /**
-     * @returns The recipe property of the RecommendationWidgetItem.
+     * @returns The {@link Recipe} recipe property of the RecommendationWidgetItem.
      */
     get recipe(): Recipe | undefined;
     /**
      * Sets the recipe to undefined
      */
     resetRecipe(): void;
+    /**
+     * Throws an error if recipe exists but is an empty string or has wrong version.
+     * @param recipe - {@link Recipe}
+     * @throws - {@link ErrorMessages.IV_0023} | {@link ErrorMessages.IV_0024}
+     */
     private _validateRecipe;
     /**
-     * Maps the recommendation widget item to its DTO format.
+     * Maps the recommendation widget item to its DTO format {@link WidgetItemRecommendationDTO}.
      */
     toDTO(): WidgetItemRecommendationDTO;
 }

package/dist/cjs/src/lib/request-entities/widgets/recommendation-widget-item.js

@@ -9,7 +9,8 @@ class RecommendationWidgetItem extends results_widget_item_1.ResultsWidgetItem {
      * Creates and holds the functionality of a recommendation widget item.
      * @param entity - The widget's item entity.
      * @param widgetId - The widget's item id.
-     * @param recommendationOptions - The widget's recommendation options object.
+     * @param recommendationOptions - The widget's {@link RecommendationOptions} object.
+     * @throws - {@link ErrorMessages.IV_0023} | {@link ErrorMessages.IV_0024}
      */
     constructor(entity, widgetId, recommendationOptions) {
         const { recipe, ...rest } = recommendationOptions || {};
@@ -36,7 +37,7 @@ class RecommendationWidgetItem extends results_widget_item_1.ResultsWidgetItem {
      * If not provided, the API uses the recipe specified in CEC.
      *
      * @param recipe - {@link Recipe} The recipe configuration with id and version.
-     * @throws Error If the recipe id is empty or version is less than 1.
+     * @throws - {@link ErrorMessages.IV_0023} | {@link ErrorMessages.IV_0024}
      */
     set recipe(recipe) {
         this._validateRecipe(recipe);
@@ -46,7 +47,7 @@ class RecommendationWidgetItem extends results_widget_item_1.ResultsWidgetItem {
         };
     }
     /**
-     * @returns The recipe property of the RecommendationWidgetItem.
+     * @returns The {@link Recipe} recipe property of the RecommendationWidgetItem.
      */
     get recipe() {
         return this._recommendation?.recipe;
@@ -57,6 +58,11 @@ class RecommendationWidgetItem extends results_widget_item_1.ResultsWidgetItem {
     resetRecipe() {
         this._recommendation = undefined;
     }
+    /**
+     * Throws an error if recipe exists but is an empty string or has wrong version.
+     * @param recipe - {@link Recipe}
+     * @throws - {@link ErrorMessages.IV_0023} | {@link ErrorMessages.IV_0024}
+     */
     _validateRecipe(recipe) {
         if (!recipe)
             return;
@@ -65,7 +71,7 @@ class RecommendationWidgetItem extends results_widget_item_1.ResultsWidgetItem {
             throw new Error(consts_1.ErrorMessages.IV_0024);
     }
     /**
-     * Maps the recommendation widget item to its DTO format.
+     * Maps the recommendation widget item to its DTO format {@link WidgetItemRecommendationDTO}.
      */
     toDTO() {
         const baseDTO = super.toDTO();

package/dist/cjs/src/lib/request-entities/widgets/results-widget-item.d.ts

@@ -10,7 +10,8 @@ export declare class ResultsWidgetItem extends RuleWidgetItem {
      * Creates and holds the functionality of a widget item.
      * @param entity - The widget's item entity.
      * @param widgetId - The widget's item id.
-     * @param resultOptions - The widget's results options object.
+     * @param resultOptions - The widget's {@link ResultsOptions} object.
+     * @throws - {@link ErrorMessages.IV_0007} | {@link ErrorMessages.IV_0022}
      */
     constructor(entity: string, widgetId: string, resultOptions?: ResultsOptions);
     /**
@@ -34,7 +35,7 @@ export declare class ResultsWidgetItem extends RuleWidgetItem {
      * Sets the search content for the ResultsItem.
      * This method updates the `content` property within the ResultsItem instance.
      * The attributes is used to define specific search criteria or filters.
-     * @param contentOptions - The array attributes that specifies the search criteria.
+     * @param contentOptions - The array attributes {@link ContentOptions} that specifies the search criteria.
      */
     set content(contentOptions: ContentOptions);
     /**
@@ -57,20 +58,25 @@ export declare class ResultsWidgetItem extends RuleWidgetItem {
     get groupBy(): string | undefined;
     /** Sets the groupBy to undefined */
     resetGroupBy(): void;
+    /**
+     *
+     * @param groupBy - the groupBy string.
+     * @throws - {@link ErrorMessages.IV_0022}
+     */
     private _validateGroupBy;
     /** Set the search filter */
     set filter(filter: Filter);
-    /** @returns The filter property of the WidgetItem */
+    /** @returns The {@link Filter} filter property of the WidgetItem */
     get filter(): Filter | undefined;
     /** Sets the filter to undefined */
     resetFilter(): void;
     /**
      *
-     * @returns The content property in its DTO format.
+     * @returns The content property in its DTO format {@link ContentOptionsDto}.
      */
     private _contentToDTO;
     /**
-     * Maps the results item to its DTO format.
+     * Maps the results item to its DTO format {@link ResultsItemDTO}.
      */
     protected _resultsToDTO(): ResultsItemDTO;
 }

package/dist/cjs/src/lib/request-entities/widgets/results-widget-item.js

@@ -9,7 +9,8 @@ class ResultsWidgetItem extends rule_widget_item_1.RuleWidgetItem {
      * Creates and holds the functionality of a widget item.
      * @param entity - The widget's item entity.
      * @param widgetId - The widget's item id.
-     * @param resultOptions - The widget's results options object.
+     * @param resultOptions - The widget's {@link ResultsOptions} object.
+     * @throws - {@link ErrorMessages.IV_0007} | {@link ErrorMessages.IV_0022}
      */
     constructor(entity, widgetId, resultOptions) {
         super(entity, widgetId, resultOptions?.rule);
@@ -48,7 +49,7 @@ class ResultsWidgetItem extends rule_widget_item_1.RuleWidgetItem {
      * Sets the search content for the ResultsItem.
      * This method updates the `content` property within the ResultsItem instance.
      * The attributes is used to define specific search criteria or filters.
-     * @param contentOptions - The array attributes that specifies the search criteria.
+     * @param contentOptions - The array attributes {@link ContentOptions} that specifies the search criteria.
      */
     set content(contentOptions) {
         this._content = contentOptions;
@@ -84,6 +85,11 @@ class ResultsWidgetItem extends rule_widget_item_1.RuleWidgetItem {
     resetGroupBy() {
         this._groupBy = undefined;
     }
+    /**
+     *
+     * @param groupBy - the groupBy string.
+     * @throws - {@link ErrorMessages.IV_0022}
+     */
     _validateGroupBy(groupBy) {
         if (typeof groupBy === 'string' && groupBy.trim().length === 0)
             throw new Error(consts_1.ErrorMessages.IV_0022);
@@ -92,7 +98,7 @@ class ResultsWidgetItem extends rule_widget_item_1.RuleWidgetItem {
     set filter(filter) {
         this._filter = filter;
     }
-    /** @returns The filter property of the WidgetItem */
+    /** @returns The {@link Filter} filter property of the WidgetItem */
     get filter() {
         return this._filter;
     }
@@ -102,7 +108,7 @@ class ResultsWidgetItem extends rule_widget_item_1.RuleWidgetItem {
     }
     /**
      *
-     * @returns The content property in its DTO format.
+     * @returns The content property in its DTO format {@link ContentOptionsDto}.
      */
     _contentToDTO() {
         if (!this._content)
@@ -111,7 +117,7 @@ class ResultsWidgetItem extends rule_widget_item_1.RuleWidgetItem {
         return { fields: attributes, ...rest };
     }
     /**
-     * Maps the results item to its DTO format.
+     * Maps the results item to its DTO format {@link ResultsItemDTO}.
      */
     _resultsToDTO() {
         return {