@sitecore-cloudsdk/search 0.5.0 → 0.5.1

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

@@ -7,8 +7,14 @@ export class SearchWidgetItem extends 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, {
@@ -39,16 +45,17 @@ export class SearchWidgetItem extends 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;
@@ -62,8 +69,7 @@ export 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};
      */
     _validatePersonalization(personalization) {
         if (!personalization)
@@ -78,7 +84,7 @@ export class SearchWidgetItem extends ResultsWidgetItem {
     }
     /**
      *
-     * @returns The personalization property in its DTO format.
+     * @returns The personalization property in its DTO format {@link SearchPersonalizationOptionsDto}.
      */
     _personalizationToDTO() {
         if (!this._personalization)
@@ -87,14 +93,14 @@ export class SearchWidgetItem extends 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;
@@ -107,9 +113,8 @@ export class SearchWidgetItem extends 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) => {
@@ -121,18 +126,24 @@ export class SearchWidgetItem extends 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(ErrorMessages.IV_0009, query.keyphrase);
     }
@@ -147,7 +158,7 @@ export 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) {
         this._validateNumberInRange1To100(ErrorMessages.IV_0014, facet.max);
@@ -155,7 +166,7 @@ export class SearchWidgetItem extends 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;
@@ -170,7 +181,7 @@ export 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) {
         this._validatePositiveInteger(ErrorMessages.IV_0008, offset);
@@ -188,28 +199,50 @@ export class SearchWidgetItem extends 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;
@@ -219,8 +252,9 @@ export class SearchWidgetItem extends 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) => {
@@ -231,7 +265,7 @@ export class SearchWidgetItem extends 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) {
@@ -239,19 +273,21 @@ export class SearchWidgetItem extends 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) => {
@@ -260,6 +296,10 @@ export class SearchWidgetItem extends 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)
@@ -277,6 +317,10 @@ export class SearchWidgetItem extends ResultsWidgetItem {
             }
         });
     }
+    /**
+     * @param type - {@link FacetTypeOptions}
+     * @returns the `filter` property in a DTO format.
+     */
     _filterToDTO(type) {
         if (!type.filter)
             return undefined;
@@ -286,6 +330,7 @@ export class SearchWidgetItem extends ResultsWidgetItem {
     }
     /**
      * Builds the sort piece of the DTO.
+     * @param type - {@link FacetTypeOptions}
      */
     _facetSortToDTO(type) {
         if (type.sort)
@@ -296,7 +341,9 @@ export class SearchWidgetItem extends 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)
@@ -309,6 +356,7 @@ export class SearchWidgetItem extends ResultsWidgetItem {
     }
     /**
      * Maps the search widget item to its DTO format.
+     * @returns - {@link SearchWidgetItemDTO}
      */
     toDTO() {
         const baseDTO = super.toDTO();
@@ -338,6 +386,7 @@ export class SearchWidgetItem extends ResultsWidgetItem {
             ...{ ranking: this._ranking },
             ...{ suggestion: this._suggestionToDTO() },
             ...{ sort: this._sort },
+            ...{ disable_grouping: this._disableGrouping },
             ...resultsDTO
         };
         const dto = {

package/dist/esm/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/esm/src/lib/request-entities/widgets/utils.js

@@ -1,6 +1,6 @@
 /**
  * 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 function isFacetFilter(filters) {

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

@@ -21,26 +21,41 @@ export declare class WidgetItem {
      * @returns The entity property of the WidgetItem.
      */
     get entity(): string;
+    /**
+     *
+     * @param entity - the string to validate
+     * @throws - {@link ErrorMessages.MV_0010}
+     */
     private _validateEntity;
     /**
      * Sets the id for the WidgetItem.
      * This method updates the `widgetId` property of WidgetItem instance.
      *
-     * @param widgetId - The entity to set.
+     * @param widgetId - The widgetId to set.
+     * @throws - {@link ErrorMessages.MV_0011}
      */
     set widgetId(widgetId: string);
     /**
      * @returns The id property of the WidgetItem.
      */
     get widgetId(): string;
+    /**
+     *
+     * @param widgetId - the string to validate
+     * @throws - {@link ErrorMessages.MV_0011}
+     */
     private _validateWidgetId;
+    /**
+     *
+     * @param errorMessage - {@link ErrorMessages}
+     * @param num - the number to validate
+     */
     protected _validateNumberInRange1To100(errorMessage: ErrorMessages, num?: number): void;
     /**
      *
-     * @param errorMessage - The error message
+     * @param errorMessage - The error message {@link ErrorMessages}
      * @param range - min and max range
      * @param num - number to test
-     * @returns void
      */
     protected _validateNumberInRange(errorMessage: ErrorMessages, range: {
         min: number;
@@ -51,14 +66,14 @@ export declare class WidgetItem {
     protected _validateNonEmptyString(errorMessage: ErrorMessages, str?: string): void;
     /**
      * Tests if passed string is defined, is not empty string and does not contain whitespaces.
-     * @param errorMessage - Error Message
+     * @param errorMessage - Error Message {@link ErrorMessages}
      * @param string - the string to test
      * @returns void
      * @throws Error when failed
      */
     protected _validateNonEmptyNoWhitespaceString(errorMessage: ErrorMessages, string?: string): void;
     /**
-     * Maps the widget item to its DTO format.
+     * Maps the widget item to its DTO format {@link WidgetItemDTO}.
      */
     toDTO(): WidgetItemDTO;
 }

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

@@ -29,6 +29,11 @@ export class WidgetItem {
     get entity() {
         return this._entity;
     }
+    /**
+     *
+     * @param entity - the string to validate
+     * @throws - {@link ErrorMessages.MV_0010}
+     */
     _validateEntity(entity) {
         if (!entity || entity.trim().length === 0)
             throw new Error(ErrorMessages.MV_0010);
@@ -37,7 +42,8 @@ export class WidgetItem {
      * Sets the id for the WidgetItem.
      * This method updates the `widgetId` property of WidgetItem instance.
      *
-     * @param widgetId - The entity to set.
+     * @param widgetId - The widgetId to set.
+     * @throws - {@link ErrorMessages.MV_0011}
      */
     set widgetId(widgetId) {
         this._validateWidgetId(widgetId);
@@ -49,10 +55,20 @@ export class WidgetItem {
     get widgetId() {
         return this._widgetId;
     }
+    /**
+     *
+     * @param widgetId - the string to validate
+     * @throws - {@link ErrorMessages.MV_0011}
+     */
     _validateWidgetId(widgetId) {
         if (!widgetId || widgetId.trim().length === 0)
             throw new Error(ErrorMessages.MV_0011);
     }
+    /**
+     *
+     * @param errorMessage - {@link ErrorMessages}
+     * @param num - the number to validate
+     */
     _validateNumberInRange1To100(errorMessage, num) {
         if (num === undefined || (num >= 1 && num <= 100))
             return;
@@ -60,10 +76,9 @@ export class WidgetItem {
     }
     /**
      *
-     * @param errorMessage - The error message
+     * @param errorMessage - The error message {@link ErrorMessages}
      * @param range - min and max range
      * @param num - number to test
-     * @returns void
      */
     _validateNumberInRange(errorMessage, range, num) {
         if (num === undefined || (num >= range.min && num <= range.max))
@@ -87,7 +102,7 @@ export class WidgetItem {
     }
     /**
      * Tests if passed string is defined, is not empty string and does not contain whitespaces.
-     * @param errorMessage - Error Message
+     * @param errorMessage - Error Message {@link ErrorMessages}
      * @param string - the string to test
      * @returns void
      * @throws Error when failed
@@ -98,7 +113,7 @@ export class WidgetItem {
         throw new Error(errorMessage);
     }
     /**
-     * Maps the widget item to its DTO format.
+     * Maps the widget item to its DTO format {@link WidgetItemDTO}.
      */
     toDTO() {
         return {

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

@@ -7,9 +7,14 @@ export declare class WidgetRequestData {
      * @param widgetItems - Array of {@link WidgetItem} instances.
      */
     constructor(widgetItems: WidgetItem[]);
+    /**
+     *
+     * @param widgetItems - the widget items.
+     * @throws - {@link ErrorMessages.MV_0012}
+     */
     private _validateWidgetItems;
     /**
-     * Maps the widget items to their DTO format.
+     * Maps the widget items to their DTO format {@link WidgetDTO}.
      */
     toDTO(): WidgetDTO;
 }

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

@@ -9,12 +9,17 @@ export class WidgetRequestData {
         this._validateWidgetItems(widgetItems);
         this._widgetItems = widgetItems;
     }
+    /**
+     *
+     * @param widgetItems - the widget items.
+     * @throws - {@link ErrorMessages.MV_0012}
+     */
     _validateWidgetItems(widgetItems) {
         if (widgetItems.length === 0)
             throw new Error(ErrorMessages.MV_0012);
     }
     /**
-     * Maps the widget items to their DTO format.
+     * Maps the widget items to their DTO format {@link WidgetDTO}.
      */
     toDTO() {
         return {

package/dist/esm/src/lib/requests/browser/get-page-widget-data.d.ts

@@ -3,13 +3,14 @@ import type { Pathname } from '../../types';
 import type { SearchEndpointResponse } from '../post-request';
 /**
  * This function requests widget data for a page.
- * @param pathname - The path of the URL.
- * @returns The response object.
+ * @param pathname - The {@link Pathname} of the URL.
+ * @returns The response object promise:{@link SearchEndpointResponse} | null.
  */
 export declare function getPageWidgetData(pathname: Pathname): Promise<SearchEndpointResponse | null>;
 /**
  * This function requests widget data for a page.
- * @param context - The context.
- * @returns The response object.
+ * @param context - The {@link Context}.
+ * @returns The response object promise:{@link SearchEndpointResponse} | null.
+ *
  */
 export declare function getPageWidgetData(context: Context): Promise<SearchEndpointResponse | null>;

package/dist/esm/src/lib/requests/browser/get-page-widget-data.js

@@ -4,6 +4,11 @@ import { ErrorMessages } from '../../consts';
 import { awaitInit } from '../../initializer/browser/initializer';
 import { Context } from '../../request-entities/context/context';
 import { sendPostRequest } from '../post-request';
+/**
+ *
+ * @param param - {@link Pathname} | {@link Context}
+ * @returns The response object promise:{@link SearchEndpointResponse} | null.
+ */
 export async function getPageWidgetData(param) {
     await awaitInit();
     const settings = getCloudSDKSettings();

package/dist/esm/src/lib/requests/browser/get-widget-data.d.ts

@@ -4,6 +4,6 @@ import type { SearchEndpointResponse } from '../post-request';
 /**
  * This function requests widget data.
  * @param widgetRequestData - An instance of {@link WidgetRequestData}.
- * @returns The response object.
+ * @returns The response object promise: {@link SearchEndpointResponse} | null.
  */
 export declare function getWidgetData(widgetRequestData: WidgetRequestData, contextRequestData?: Context): Promise<SearchEndpointResponse | null>;

package/dist/esm/src/lib/requests/browser/get-widget-data.js

@@ -6,7 +6,7 @@ import { sendPostRequest } from '../post-request';
 /**
  * This function requests widget data.
  * @param widgetRequestData - An instance of {@link WidgetRequestData}.
- * @returns The response object.
+ * @returns The response object promise: {@link SearchEndpointResponse} | null.
  */
 export async function getWidgetData(widgetRequestData, contextRequestData) {
     await awaitInit();

package/dist/esm/src/lib/requests/post-request.d.ts

@@ -2,13 +2,21 @@ import type { BrowserSettings, ServerSettings } from '../types';
 /**
  * This function sends a post request to Sitecore EP
  * @param body - A stringified version of the body to send
- * @param settings - The global settings
+ * @param settings - The global settings {@link BrowserSettings} | {@link ServerSettings}
+ * @returns promise: {@link SearchEndpointResponse}
  */
 export declare function sendPostRequest(body: string, settings: BrowserSettings | ServerSettings): Promise<SearchEndpointResponse | null>;
+interface FacetResponse {
+    name: string;
+    label: string;
+    value: FacetValueResponse[];
+}
 interface FacetValueResponse {
     id: string;
     text: string;
     count: number;
+    min?: number;
+    max?: number;
 }
 interface SortingResponse {
     choices: Array<{
@@ -39,11 +47,7 @@ export interface SearchEndpointResponse {
         type: string;
         used_in: string;
         entity: string;
-        facet?: {
-            name: string;
-            label: string;
-            value: FacetValueResponse[];
-        };
+        facet?: FacetResponse[];
         content?: Array<unknown>;
         sort?: SortingResponse;
         total_item?: number;

package/dist/esm/src/lib/requests/post-request.js

@@ -1,7 +1,8 @@
 /**
  * This function sends a post request to Sitecore EP
  * @param body - A stringified version of the body to send
- * @param settings - The global settings
+ * @param settings - The global settings {@link BrowserSettings} | {@link ServerSettings}
+ * @returns promise: {@link SearchEndpointResponse}
  */
 export async function sendPostRequest(body, settings) {
     const url = `${settings.sitecoreEdgeUrl}/v1/search?sitecoreContextId=${settings.sitecoreEdgeContextId}`;

package/dist/esm/src/lib/requests/server/entity-view-event-server.d.ts

@@ -2,7 +2,7 @@ import type { Request } from '@sitecore-cloudsdk/utils';
 import type { EntityViewEventParams } from '../../events/interfaces';
 /**
  * This function sends an entity view event from server.
- * @param httpRequest - An  http request object. Either HttpRequest or MiddlewareRequest.
+ * @param httpRequest - An  http {@link Request} object. Either HttpRequest or MiddlewareRequest.
  * @param entityViewEventParams - An object containing conversion event params from {@link EntityViewEventParams}
  */
 export declare function entityViewServer(httpRequest: Request, entityViewEventParams: EntityViewEventParams): Promise<import("@sitecore-cloudsdk/core/internal").EPResponse | null>;

package/dist/esm/src/lib/requests/server/entity-view-event-server.js

@@ -4,7 +4,7 @@ import { EntityViewEvent } from '../../events/entity-view-event';
 import { verifySearchPackageExistence } from '../../initializer/server/initializer';
 /**
  * This function sends an entity view event from server.
- * @param httpRequest - An  http request object. Either HttpRequest or MiddlewareRequest.
+ * @param httpRequest - An  http {@link Request} object. Either HttpRequest or MiddlewareRequest.
  * @param entityViewEventParams - An object containing conversion event params from {@link EntityViewEventParams}
  */
 export async function entityViewServer(httpRequest, entityViewEventParams) {

package/dist/esm/src/lib/requests/server/get-page-widget-data-server.d.ts

@@ -3,13 +3,13 @@ import type { Pathname } from '../../types';
 import type { SearchEndpointResponse } from '../post-request';
 /**
  * This function requests widget data for a page from server side.
- * @param pathname - The path of the URL.
+ * @param pathname - The {@link Pathname} of the URL.
  * @returns The response object.
  */
 export declare function getPageWidgetDataServer(pathname: Pathname): Promise<SearchEndpointResponse | null>;
 /**
  * This function requests widget data for a page from server side.
- * @param context - The context.
- * @returns The response object.
+ * @param context - The {@link Context}.
+ * @returns The response object promise: {@link SearchEndpointResponse} | null.
  */
 export declare function getPageWidgetDataServer(context: Context): Promise<SearchEndpointResponse | null>;

package/dist/esm/src/lib/requests/server/get-page-widget-data-server.js

@@ -4,6 +4,11 @@ import { ErrorMessages } from '../../consts';
 import { verifySearchPackageExistence } from '../../initializer/server/initializer';
 import { Context } from '../../request-entities/context/context';
 import { sendPostRequest } from '../post-request';
+/**
+ * This function requests widget data for a page from server side.
+ * @param param - The {@link Context} | {@link Context}
+ * @returns The response object promise: {@link SearchEndpointResponse} | null.
+ */
 export async function getPageWidgetDataServer(param) {
     verifySearchPackageExistence();
     const settings = getCloudSDKSettings();

package/dist/esm/src/lib/requests/server/get-widget-data-server.d.ts

@@ -3,6 +3,6 @@ import type { SearchEndpointResponse } from '../post-request';
 /**
  * This function requests widget data from server side.
  * @param widgetRequestData - An instance of {@link WidgetRequestData}.
- * @returns The response object.
+ * @returns The response object promise: {@link SearchEndpointResponse} | null.
  */
 export declare function getWidgetDataServer(widgetRequestData: WidgetRequestData): Promise<SearchEndpointResponse | null>;

package/dist/esm/src/lib/requests/server/get-widget-data-server.js

@@ -5,7 +5,7 @@ import { sendPostRequest } from '../post-request';
 /**
  * This function requests widget data from server side.
  * @param widgetRequestData - An instance of {@link WidgetRequestData}.
- * @returns The response object.
+ * @returns The response object promise: {@link SearchEndpointResponse} | null.
  */
 export async function getWidgetDataServer(widgetRequestData) {
     verifySearchPackageExistence();

package/dist/esm/src/lib/requests/server/widget-facet-click-event-server.d.ts

@@ -2,7 +2,7 @@ import type { Request } from '@sitecore-cloudsdk/utils';
 import type { WidgetFacetClickEventParams } from '../../events/interfaces';
 /**
  * This function sends a widget facet click event from server.
- * @param httpRequest - An  http request object. Either HttpRequest or MiddlewareRequest.
+ * @param httpRequest - An  http {@link Request} object. Either HttpRequest or MiddlewareRequest.
  * @param widgetFacetClickEventParams - An object containing widget facet click event params
  * from {@link WidgetFacetClickEventParams}
  */