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

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

@@ -6,7 +6,8 @@ export 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, widgetId, questionsAnswersOptions) {
         super(entity, widgetId, questionsAnswersOptions.rule);
@@ -18,6 +19,11 @@ export class QuestionsAnswersWidgetItem extends 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(ErrorMessages.IV_0007, relatedQuestions.limit);
         this._validatePositiveInteger(ErrorMessages.IV_0008, relatedQuestions.offset);
@@ -27,6 +33,7 @@ export class QuestionsAnswersWidgetItem extends 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(ErrorMessages.IV_0009, keyphrase);
@@ -42,13 +49,13 @@ export 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) {
         this._exactAnswer = exactAnswer;
     }
     /**
-     * @returns The exactAnswer property of the QuestionsAnswersWidgetItem.
+     * @returns The {@link ExactAnswerOptions} `exactAnswer` property of the QuestionsAnswersWidgetItem.
      */
     get exactAnswer() {
         return this._exactAnswer;
@@ -63,14 +70,15 @@ export 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) {
         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;
@@ -81,11 +89,19 @@ export class QuestionsAnswersWidgetItem extends 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;
@@ -98,7 +114,7 @@ export class QuestionsAnswersWidgetItem extends 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/esm/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/esm/src/lib/request-entities/widgets/recommendation-widget-item.js

@@ -6,7 +6,8 @@ export 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, widgetId, recommendationOptions) {
         const { recipe, ...rest } = recommendationOptions || {};
@@ -33,7 +34,7 @@ export 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) {
         this._validateRecipe(recipe);
@@ -43,7 +44,7 @@ export class RecommendationWidgetItem extends ResultsWidgetItem {
         };
     }
     /**
-     * @returns The recipe property of the RecommendationWidgetItem.
+     * @returns The {@link Recipe} recipe property of the RecommendationWidgetItem.
      */
     get recipe() {
         return this._recommendation?.recipe;
@@ -54,6 +55,11 @@ export class RecommendationWidgetItem extends 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;
@@ -62,7 +68,7 @@ export class RecommendationWidgetItem extends ResultsWidgetItem {
             throw new Error(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/esm/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/esm/src/lib/request-entities/widgets/results-widget-item.js

@@ -6,7 +6,8 @@ export 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, widgetId, resultOptions) {
         super(entity, widgetId, resultOptions?.rule);
@@ -45,7 +46,7 @@ export 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) {
         this._content = contentOptions;
@@ -81,6 +82,11 @@ export class ResultsWidgetItem extends 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(ErrorMessages.IV_0022);
@@ -89,7 +95,7 @@ export class ResultsWidgetItem extends 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;
     }
@@ -99,7 +105,7 @@ export class ResultsWidgetItem extends RuleWidgetItem {
     }
     /**
      *
-     * @returns The content property in its DTO format.
+     * @returns The content property in its DTO format {@link ContentOptionsDto}.
      */
     _contentToDTO() {
         if (!this._content)
@@ -108,7 +114,7 @@ export class ResultsWidgetItem extends 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 {

package/dist/esm/src/lib/request-entities/widgets/rule-widget-item.d.ts

@@ -3,12 +3,47 @@ import { WidgetItem } from './widget-item';
 /** Base class for widgets that support rules functionality */
 export declare class RuleWidgetItem extends WidgetItem {
     protected _rule?: SearchRuleOptions;
+    /**
+     *
+     * @param entity - the entity value of the RuleWidgetItem.
+     * @param widgetId - the widgetId value of the RuleWidgetItem.
+     * @param rule - the {@link SearchRuleOptions} of the RuleWidgetItem.
+     * @throws - {@link ErrorMessages.IV_0027} | {@link ErrorMessages.IV_0028}
+     */
     constructor(entity: string, widgetId: string, rule?: SearchRuleOptions);
+    /**
+     * Sets the `rule` property
+     * @param rule - the {@link SearchRuleOptions} value to be applied.
+     * @throws - {@link ErrorMessages.IV_0027} | {@link ErrorMessages.IV_0028}
+     */
     set rule(rule: SearchRuleOptions);
+    /**
+     * @returns the {@link SearchRuleOptions} `rule` property of the RuleWidgetItem.
+     */
     get rule(): SearchRuleOptions | undefined;
     resetRule(): void;
+    /**
+     * Throws error if on of the rule properties has invalid data.
+     * @param rule - {@link SearchRuleOptions}
+     * @throws - {@link ErrorMessages.IV_0027} | {@link ErrorMessages.IV_0028}
+     */
     protected _validateRule(rule?: SearchRuleOptions): void;
+    /**
+     *
+     * @param rules - array of {@link ArrayOfAtLeastOne} object with properties `filter` `slots` `weight`
+     * @returns the rule property in a boost rule DTO format {@link BoostRuleDTO}[].
+     */
     private _convertToBoostRuleDTO;
+    /**
+     *
+     * @param rules - array of {@link ArrayOfAtLeastOne} object with properties `filter` `slots`
+     * @returns the rule property in IncludeRuleDTO format {@link IncludeRuleDTO}[].
+     */
     private _convertToIncludeRuleDTO;
+    /**
+     *
+     * @param rule - {@link SearchRuleOptions}
+     * @returns - returns RuleWidgetItem in its DTO format {@link SearchRuleDTO}.
+     */
     protected _ruleToDTO(rule?: SearchRuleOptions): SearchRuleDTO | undefined;
 }

package/dist/esm/src/lib/request-entities/widgets/rule-widget-item.js

@@ -3,6 +3,13 @@ import { ErrorMessages } from '../../consts';
 import { WidgetItem } from './widget-item';
 /** Base class for widgets that support rules functionality */
 export class RuleWidgetItem extends WidgetItem {
+    /**
+     *
+     * @param entity - the entity value of the RuleWidgetItem.
+     * @param widgetId - the widgetId value of the RuleWidgetItem.
+     * @param rule - the {@link SearchRuleOptions} of the RuleWidgetItem.
+     * @throws - {@link ErrorMessages.IV_0027} | {@link ErrorMessages.IV_0028}
+     */
     constructor(entity, widgetId, rule) {
         super(entity, widgetId);
         if (rule) {
@@ -10,16 +17,29 @@ export class RuleWidgetItem extends WidgetItem {
             this._rule = rule;
         }
     }
+    /**
+     * Sets the `rule` property
+     * @param rule - the {@link SearchRuleOptions} value to be applied.
+     * @throws - {@link ErrorMessages.IV_0027} | {@link ErrorMessages.IV_0028}
+     */
     set rule(rule) {
         this._validateRule(rule);
         this._rule = rule;
     }
+    /**
+     * @returns the {@link SearchRuleOptions} `rule` property of the RuleWidgetItem.
+     */
     get rule() {
         return this._rule;
     }
     resetRule() {
         this._rule = undefined;
     }
+    /**
+     * Throws error if on of the rule properties has invalid data.
+     * @param rule - {@link SearchRuleOptions}
+     * @throws - {@link ErrorMessages.IV_0027} | {@link ErrorMessages.IV_0028}
+     */
     _validateRule(rule) {
         if (!rule)
             return;
@@ -33,6 +53,11 @@ export class RuleWidgetItem extends WidgetItem {
         // Validate include rules
         rule.include?.forEach((item) => item.slots.forEach((slot) => this._validatePositiveInteger(ErrorMessages.IV_0028, slot)));
     }
+    /**
+     *
+     * @param rules - array of {@link ArrayOfAtLeastOne} object with properties `filter` `slots` `weight`
+     * @returns the rule property in a boost rule DTO format {@link BoostRuleDTO}[].
+     */
     _convertToBoostRuleDTO(rules) {
         return rules.map((rule) => ({
             filter: rule.filter.toDTO(),
@@ -40,12 +65,22 @@ export class RuleWidgetItem extends WidgetItem {
             weight: rule.weight
         }));
     }
+    /**
+     *
+     * @param rules - array of {@link ArrayOfAtLeastOne} object with properties `filter` `slots`
+     * @returns the rule property in IncludeRuleDTO format {@link IncludeRuleDTO}[].
+     */
     _convertToIncludeRuleDTO(rules) {
         return rules.map((rule) => ({
             filter: rule.filter.toDTO(),
             slots: rule.slots
         }));
     }
+    /**
+     *
+     * @param rule - {@link SearchRuleOptions}
+     * @returns - returns RuleWidgetItem in its DTO format {@link SearchRuleDTO}.
+     */
     _ruleToDTO(rule) {
         if (!rule)
             return undefined;

package/dist/esm/src/lib/request-entities/widgets/search-widget-item.d.ts

@@ -9,20 +9,27 @@ export declare class SearchWidgetItem extends ResultsWidgetItem {
     private _suggestion?;
     private _ranking?;
     private _personalization?;
+    private _disableGrouping?;
     /**
      * Creates and holds the functionality of a search widget item.
      * @param entity - The widget's item entity.
      * @param widgetId - The widget's item id.
-     * @param searchOptions - The widget's search options object.
-     *
+     * @param searchOptions - The widget's {@link SearchOptions} object.
+     * @throws - {@link ErrorMessages.IV_0008} | {@link ErrorMessages.IV_0009};
+     * @throws - {@link ErrorMessages.IV_0014} | {@link ErrorMessages.IV_0016};
+     * @throws - {@link ErrorMessages.IV_0017} | {@link ErrorMessages.IV_0018};
+     * @throws - {@link ErrorMessages.IV_0019} | {@link ErrorMessages.IV_0020};
+     * @throws - {@link ErrorMessages.IV_0021} | {@link ErrorMessages.IV_0026};
+     * @throws - {@link ErrorMessages.IV_0029} | {@link ErrorMessages.IV_0030};
+     * @throws - {@link ErrorMessages.IV_0031}
      */
     constructor(entity: string, widgetId: string, searchOptions?: SearchOptions);
     /**
-     * @param personalization - the object of the `personalization` param
+     * @param personalization - the object {@link SearchPersonalizationOptions} of the `personalization` param
      */
     set personalization(personalization: SearchPersonalizationOptions);
     /**
-     * @returns the `personalization` property of the SearchWidgetItem
+     * @returns the {@link SearchPersonalizationOptions} `personalization` property of the SearchWidgetItem
      */
     get personalization(): SearchPersonalizationOptions | undefined;
     /**
@@ -32,21 +39,20 @@ export declare class SearchWidgetItem extends ResultsWidgetItem {
     /**
      *
      * @param personalization - the object of the `personalization` property
-     * @throws IV_0030 if `personalization.attributes` contains an empty or whitespace string
-     * @throws IV_0031 if `personalization.ids` contains an empty string
+     * @throws - {@link ErrorMessages.IV_0030} | {@link ErrorMessages.IV_0031};
      */
     private _validatePersonalization;
     /**
      *
-     * @returns The personalization property in its DTO format.
+     * @returns The personalization property in its DTO format {@link SearchPersonalizationOptionsDto}.
      */
     private _personalizationToDTO;
     /**
-     * @param ranking - the object of the `ranking` param
+     * @param ranking - the object {@link SearchRankingOptions}[] of the `ranking` param
      */
     set ranking(ranking: ArrayOfAtLeastOne<SearchRankingOptions>);
     /**
-     * @returns the `ranking` property of the SearchWidgetItem
+     * @returns the {@link SearchRankingOptions}[] `ranking` property of the SearchWidgetItem
      */
     get ranking(): ArrayOfAtLeastOne<SearchRankingOptions> | undefined;
     /**
@@ -55,22 +61,27 @@ export declare class SearchWidgetItem extends ResultsWidgetItem {
     resetRanking(): void;
     /**
      *
-     * @param ranking - the object of the `ranking` property
-     * @throws IV_0016 if `ranking.name` contains an empty string
-     * @throws IV_0016 if `ranking.weight` is outside of range 1 ~ 100
+     * @param ranking - the object {@link SearchRankingOptions}[] of the `ranking` property
+     * @throws - {@link ErrorMessages.IV_0016} | {@link ErrorMessages.IV_0029};
      */
     private _validateRanking;
     /**
      * Sets the search query for the SearchWidgetItem.
      * This method updates the `query` property of the search configuration within the SearchWidgetItem instance.
      * The query is used to define specific search criteria.
-     * @param query - The operator that specifies the search criteria.
+     * @param query - The {@link QueryOptions} operator that specifies the search criteria.
+     * @throws - {@link ErrorMessages.IV_0008}
      */
     set query(query: QueryOptions);
     /**
-     * @returns The query property of the SearchWidgetItem.
+     * @returns The {@link QueryOptions} `query` property of the SearchWidgetItem.
      */
     get query(): QueryOptions | undefined;
+    /**
+     *
+     * @param query - {@link QueryOptions}
+     * @throws - {@link ErrorMessages.IV_0009}
+     */
     private _validateQuery;
     /**
      * Sets the query data to undefined
@@ -81,11 +92,11 @@ export declare class SearchWidgetItem extends ResultsWidgetItem {
      * This method updates the `facet` property of the search configuration within the SearchWidgetItem instance.
      *
      * @param facet - The object to set as the search facet.
-     * @throws Error If the max is less than 1 or greater than 100, indicating an invalid range.
+     * @throws - {@link ErrorMessages.IV_0014}
      */
     set facet(facet: FacetOptions);
     /**
-     * @returns The facet property of the SearchWidgetItem.
+     * @returns The {@link FacetOptions} `facet` property of the SearchWidgetItem.
      */
     get facet(): FacetOptions | undefined;
     /**
@@ -96,7 +107,7 @@ export declare class SearchWidgetItem extends ResultsWidgetItem {
      * Sets the search offset for the WidgetItem.
      * Updates the offset property to manage pagination. Throws an error if the offset value is less than 0.
      * @param offset - The non-negative integer to set as the search offset.
-     * @throws Error If the offset is less than 0.
+     * @throws - {@link ErrorMessages.IV_0008}
      */
     set offset(offset: number);
     /**
@@ -107,61 +118,92 @@ export declare class SearchWidgetItem extends ResultsWidgetItem {
      * Sets the offset value to undefined
      */
     resetOffset(): void;
+    /**
+     * Sets the disable grouping property of the SearchWidgetItem.
+     * @param disableGrouping - A boolean indicating if grouping has been enabled in Sitecore Search.
+     */
+    set disableGrouping(disableGrouping: boolean);
+    /**
+     * @returns The disableGrouping property of the SearchWidgetItem.
+     */
+    get disableGrouping(): boolean | undefined;
+    /**
+     * Sets the `disableGrouping` property to undefined.
+     */
+    resetDisableGrouping(): void;
     /**
      * Sets the suggestion property for SearchWidgetItem
-     * @param suggestion - the <array>array of objects for the suggestion param
-     * @throws error if <SearchSuggestionOptions>.<suggestion>.name property is an empty string or contains spaces
-     * @throws error if <SearchSuggestionOptions>.<suggestion>.max property is not between the range 1 ~ 100
+     * @param suggestion - the {@link SearchSuggestionOptions}[] of objects for the suggestion param
+     * @throws - {@link ErrorMessages.IV_0014} | {@link ErrorMessages.IV_0016}
      */
     set suggestion(suggestion: ArrayOfAtLeastOne<SearchSuggestionOptions>);
     /**
-     * @returns The suggestion property of the SearchWidgetItem.
+     * @returns The {@link SearchSuggestionOptions} `suggestion` property of the SearchWidgetItem.
      */
     get suggestion(): ArrayOfAtLeastOne<SearchSuggestionOptions> | undefined;
     /**
-     * Sets the suggestion property to undefined.
+     * Sets the `suggestion` property to undefined.
      */
     resetSuggestion(): void;
+    /**
+     *
+     * @returns the `suggestion` property in its DTO format. {@link SearchSuggestionOptionsDTO}[]
+     */
     private _suggestionToDTO;
     /**
-     * Validates the suggestion property. Throws error if provided with incorrect values.
-     * @param suggestion - the <array> of objects for the suggestion param
+     * Validates the `suggestion` property. Throws error if provided with incorrect values.
+     * @param suggestion - the {@link SearchSuggestionOptions}[] of objects for the `suggestion` param
+     * @throws - {@link ErrorMessages.IV_0014} | {@link ErrorMessages.IV_0016}
      */
     private _validateSuggestion;
     /**
      * Sets the search sort property for SearchWidgetItem
      * Throws an error if one of the values under sort have an empty `name`
-     * @param sort - the object for the sort param
+     * @param sort - the object {@link SearchSortOptions} for the `sort` param
      * @throws error if <SearchSortOptions>.<SortValue>.name(s) property is an empty string
      */
     set sort(sort: SearchSortOptions);
     /**
-     * @returns The sort property of the SearchWidgetItem.
+     * @returns The sort {@link SearchSortOptions} `property` of the SearchWidgetItem.
      */
     get sort(): SearchSortOptions | undefined;
     /**
-     * Sets the sort data to undefined
+     * Sets the `sort` property to undefined
      */
     resetSort(): void;
     /**
      * Validates the sort field. Throws an error if incorrect values are provided.
+     * @param sort - {@link SearchSortOptions}
+     * @throws - {@link ErrorMessages.IV_0026}
      */
     private _validateSort;
     /**
      * Validates the facet type fields. Throws an errors if incorrect values are provided.
+     * @param types - {@link FacetTypeOptions}[]
+     * @throws - {@link ErrorMessages.IV_0016} | {@link ErrorMessages.IV_0017}
+     * @throws - {@link ErrorMessages.IV_0018} | {@link ErrorMessages.IV_0019}
+     * @throws - {@link ErrorMessages.IV_0020} | {@link ErrorMessages.IV_0021}
      */
     private _validateFacetTypes;
+    /**
+     * @param type - {@link FacetTypeOptions}
+     * @returns the `filter` property in a DTO format.
+     */
     private _filterToDTO;
     /**
      * Builds the sort piece of the DTO.
+     * @param type - {@link FacetTypeOptions}
      */
     private _facetSortToDTO;
     /**
-     * Builds the filtering options array.
+     * Builds the filtering options array in its DTO format.
+     * @param filteringOptions - {@link FilteringOptions}
+     * @returns - {@link FilteringOptionsDTO}
      */
     private _filteringOptionsToDTO;
     /**
      * Maps the search widget item to its DTO format.
+     * @returns - {@link SearchWidgetItemDTO}
      */
     toDTO(): SearchWidgetItemDTO;
 }