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

package/dist/cjs/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/cjs/src/lib/request-entities/widgets/rule-widget-item.js

@@ -6,6 +6,13 @@ const consts_1 = require("../../consts");
 const widget_item_1 = require("./widget-item");
 /** Base class for widgets that support rules functionality */
 class RuleWidgetItem extends widget_item_1.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) {
@@ -13,16 +20,29 @@ class RuleWidgetItem extends widget_item_1.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;
@@ -36,6 +56,11 @@ class RuleWidgetItem extends widget_item_1.WidgetItem {
         // Validate include rules
         rule.include?.forEach((item) => item.slots.forEach((slot) => this._validatePositiveInteger(consts_1.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(),
@@ -43,12 +68,22 @@ class RuleWidgetItem extends widget_item_1.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/cjs/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;
 }

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

@@ -10,8 +10,14 @@ class SearchWidgetItem extends results_widget_item_1.ResultsWidgetItem {
      * 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, widgetId, searchOptions) {
         super(entity, widgetId, {
@@ -42,16 +48,17 @@ class SearchWidgetItem extends results_widget_item_1.ResultsWidgetItem {
         this._sort = searchOptions.sort;
         this._validateSuggestion(searchOptions.suggestion);
         this._suggestion = searchOptions.suggestion;
+        this._disableGrouping = searchOptions.disableGrouping;
     }
     /**
-     * @param personalization - the object of the `personalization` param
+     * @param personalization - the object {@link SearchPersonalizationOptions} of the `personalization` param
      */
     set personalization(personalization) {
         this._validatePersonalization(personalization);
         this._personalization = personalization;
     }
     /**
-     * @returns the `personalization` property of the SearchWidgetItem
+     * @returns the {@link SearchPersonalizationOptions} `personalization` property of the SearchWidgetItem
      */
     get personalization() {
         return this._personalization;
@@ -65,8 +72,7 @@ class SearchWidgetItem extends results_widget_item_1.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};
      */
     _validatePersonalization(personalization) {
         if (!personalization)
@@ -81,7 +87,7 @@ class SearchWidgetItem extends results_widget_item_1.ResultsWidgetItem {
     }
     /**
      *
-     * @returns The personalization property in its DTO format.
+     * @returns The personalization property in its DTO format {@link SearchPersonalizationOptionsDto}.
      */
     _personalizationToDTO() {
         if (!this._personalization)
@@ -90,14 +96,14 @@ class SearchWidgetItem extends results_widget_item_1.ResultsWidgetItem {
         return { fields: attributes, ...rest };
     }
     /**
-     * @param ranking - the object of the `ranking` param
+     * @param ranking - the object {@link SearchRankingOptions}[] of the `ranking` param
      */
     set ranking(ranking) {
         this._validateRanking(ranking);
         this._ranking = ranking;
     }
     /**
-     * @returns the `ranking` property of the SearchWidgetItem
+     * @returns the {@link SearchRankingOptions}[] `ranking` property of the SearchWidgetItem
      */
     get ranking() {
         return this._ranking;
@@ -110,9 +116,8 @@ class SearchWidgetItem extends results_widget_item_1.ResultsWidgetItem {
     }
     /**
      *
-     * @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};
      */
     _validateRanking(ranking) {
         ranking?.forEach((rank) => {
@@ -124,18 +129,24 @@ class SearchWidgetItem extends results_widget_item_1.ResultsWidgetItem {
      * 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) {
         this._validateQuery(query);
         this._query = query;
     }
     /**
-     * @returns The query property of the SearchWidgetItem.
+     * @returns The {@link QueryOptions} `query` property of the SearchWidgetItem.
      */
     get query() {
         return this._query;
     }
+    /**
+     *
+     * @param query - {@link QueryOptions}
+     * @throws - {@link ErrorMessages.IV_0009}
+     */
     _validateQuery(query) {
         this._validateStringLengthInRange1To100(consts_1.ErrorMessages.IV_0009, query.keyphrase);
     }
@@ -150,7 +161,7 @@ class SearchWidgetItem extends results_widget_item_1.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) {
         this._validateNumberInRange1To100(consts_1.ErrorMessages.IV_0014, facet.max);
@@ -158,7 +169,7 @@ class SearchWidgetItem extends results_widget_item_1.ResultsWidgetItem {
         this._facet = facet;
     }
     /**
-     * @returns The facet property of the SearchWidgetItem.
+     * @returns The {@link FacetOptions} `facet` property of the SearchWidgetItem.
      */
     get facet() {
         return this._facet;
@@ -173,7 +184,7 @@ class SearchWidgetItem extends results_widget_item_1.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) {
         this._validatePositiveInteger(consts_1.ErrorMessages.IV_0008, offset);
@@ -191,28 +202,50 @@ class SearchWidgetItem extends results_widget_item_1.ResultsWidgetItem {
     resetOffset() {
         this._offset = undefined;
     }
+    /**
+     * Sets the disable grouping property of the SearchWidgetItem.
+     * @param disableGrouping - A boolean indicating if grouping has been enabled in Sitecore Search.
+     */
+    set disableGrouping(disableGrouping) {
+        this._disableGrouping = disableGrouping;
+    }
+    /**
+     * @returns The disableGrouping property of the SearchWidgetItem.
+     */
+    get disableGrouping() {
+        return this._disableGrouping;
+    }
+    /**
+     * Sets the `disableGrouping` property to undefined.
+     */
+    resetDisableGrouping() {
+        this._disableGrouping = undefined;
+    }
     /**
      * 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) {
         this._validateSuggestion(suggestion);
         this._suggestion = suggestion;
     }
     /**
-     * @returns The suggestion property of the SearchWidgetItem.
+     * @returns The {@link SearchSuggestionOptions} `suggestion` property of the SearchWidgetItem.
      */
     get suggestion() {
         return this._suggestion;
     }
     /**
-     * Sets the suggestion property to undefined.
+     * Sets the `suggestion` property to undefined.
      */
     resetSuggestion() {
         this._suggestion = undefined;
     }
+    /**
+     *
+     * @returns the `suggestion` property in its DTO format. {@link SearchSuggestionOptionsDTO}[]
+     */
     _suggestionToDTO() {
         if (!this._suggestion)
             return undefined;
@@ -222,8 +255,9 @@ class SearchWidgetItem extends results_widget_item_1.ResultsWidgetItem {
         });
     }
     /**
-     * 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}
      */
     _validateSuggestion(suggestion) {
         suggestion?.forEach((suggestionItem) => {
@@ -234,7 +268,7 @@ class SearchWidgetItem extends results_widget_item_1.ResultsWidgetItem {
     /**
      * 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) {
@@ -242,19 +276,21 @@ class SearchWidgetItem extends results_widget_item_1.ResultsWidgetItem {
         this._sort = sort;
     }
     /**
-     * @returns The sort property of the SearchWidgetItem.
+     * @returns The sort {@link SearchSortOptions} `property` of the SearchWidgetItem.
      */
     get sort() {
         return this._sort;
     }
     /**
-     * Sets the sort data to undefined
+     * Sets the `sort` property to undefined
      */
     resetSort() {
         this._sort = undefined;
     }
     /**
      * Validates the sort field. Throws an error if incorrect values are provided.
+     * @param sort - {@link SearchSortOptions}
+     * @throws - {@link ErrorMessages.IV_0026}
      */
     _validateSort(sort) {
         sort?.value?.forEach((sortValueItem) => {
@@ -263,6 +299,10 @@ class SearchWidgetItem extends results_widget_item_1.ResultsWidgetItem {
     }
     /**
      * 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}
      */
     _validateFacetTypes(types) {
         if (!types)
@@ -280,6 +320,10 @@ class SearchWidgetItem extends results_widget_item_1.ResultsWidgetItem {
             }
         });
     }
+    /**
+     * @param type - {@link FacetTypeOptions}
+     * @returns the `filter` property in a DTO format.
+     */
     _filterToDTO(type) {
         if (!type.filter)
             return undefined;
@@ -289,6 +333,7 @@ class SearchWidgetItem extends results_widget_item_1.ResultsWidgetItem {
     }
     /**
      * Builds the sort piece of the DTO.
+     * @param type - {@link FacetTypeOptions}
      */
     _facetSortToDTO(type) {
         if (type.sort)
@@ -299,7 +344,9 @@ class SearchWidgetItem extends results_widget_item_1.ResultsWidgetItem {
         return {};
     }
     /**
-     * Builds the filtering options array.
+     * Builds the filtering options array in its DTO format.
+     * @param filteringOptions - {@link FilteringOptions}
+     * @returns - {@link FilteringOptionsDTO}
      */
     _filteringOptionsToDTO(filteringOptions) {
         if (!filteringOptions)
@@ -312,6 +359,7 @@ class SearchWidgetItem extends results_widget_item_1.ResultsWidgetItem {
     }
     /**
      * Maps the search widget item to its DTO format.
+     * @returns - {@link SearchWidgetItemDTO}
      */
     toDTO() {
         const baseDTO = super.toDTO();
@@ -341,6 +389,7 @@ class SearchWidgetItem extends results_widget_item_1.ResultsWidgetItem {
             ...{ ranking: this._ranking },
             ...{ suggestion: this._suggestionToDTO() },
             ...{ sort: this._sort },
+            ...{ disable_grouping: this._disableGrouping },
             ...resultsDTO
         };
         const dto = {

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

@@ -2,7 +2,7 @@ import type { ArrayOfAtLeastOne } from '../filters/interfaces';
 import type { FacetFilter } from './interfaces';
 /**
  * Checks if the provided filters are facet filters.
- * @param filters - The filters to check.
+ * @param filters - The {@link FacetFilter}[] | string[] to check.
  * @returns True if the filters are facet filters, false otherwise.
  */
 export declare function isFacetFilter(filters: ArrayOfAtLeastOne<string> | ArrayOfAtLeastOne<FacetFilter>): filters is ArrayOfAtLeastOne<FacetFilter>;

package/dist/cjs/src/lib/request-entities/widgets/utils.js

@@ -3,7 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.isFacetFilter = void 0;
 /**
  * Checks if the provided filters are facet filters.
- * @param filters - The filters to check.
+ * @param filters - The {@link FacetFilter}[] | string[] to check.
  * @returns True if the filters are facet filters, false otherwise.
  */
 function isFacetFilter(filters) {