@sitecore-cloudsdk/search 0.5.0 → 0.5.1

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

@@ -32,6 +32,11 @@ 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(consts_1.ErrorMessages.MV_0010);
@@ -40,7 +45,8 @@ 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);
@@ -52,10 +58,20 @@ 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(consts_1.ErrorMessages.MV_0011);
     }
+    /**
+     *
+     * @param errorMessage - {@link ErrorMessages}
+     * @param num - the number to validate
+     */
     _validateNumberInRange1To100(errorMessage, num) {
         if (num === undefined || (num >= 1 && num <= 100))
             return;
@@ -63,10 +79,9 @@ 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))
@@ -90,7 +105,7 @@ 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
@@ -101,7 +116,7 @@ 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/cjs/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/cjs/src/lib/request-entities/widgets/widget-request-data.js

@@ -12,12 +12,17 @@ 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(consts_1.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/cjs/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/cjs/src/lib/requests/browser/get-page-widget-data.js

@@ -7,6 +7,11 @@ const consts_1 = require("../../consts");
 const initializer_1 = require("../../initializer/browser/initializer");
 const context_1 = require("../../request-entities/context/context");
 const post_request_1 = require("../post-request");
+/**
+ *
+ * @param param - {@link Pathname} | {@link Context}
+ * @returns The response object promise:{@link SearchEndpointResponse} | null.
+ */
 async function getPageWidgetData(param) {
     await (0, initializer_1.awaitInit)();
     const settings = (0, internal_1.getCloudSDKSettingsBrowser)();

package/dist/cjs/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/cjs/src/lib/requests/browser/get-widget-data.js

@@ -8,7 +8,7 @@ const post_request_1 = require("../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.
  */
 async function getWidgetData(widgetRequestData, contextRequestData) {
     await (0, initializer_1.awaitInit)();

package/dist/cjs/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/cjs/src/lib/requests/post-request.js

@@ -4,7 +4,8 @@ exports.sendPostRequest = void 0;
 /**
  * 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}
  */
 async function sendPostRequest(body, settings) {
     const url = `${settings.sitecoreEdgeUrl}/v1/search?sitecoreContextId=${settings.sitecoreEdgeContextId}`;

package/dist/cjs/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/cjs/src/lib/requests/server/entity-view-event-server.js

@@ -7,7 +7,7 @@ const entity_view_event_1 = require("../../events/entity-view-event");
 const initializer_1 = require("../../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}
  */
 async function entityViewServer(httpRequest, entityViewEventParams) {

package/dist/cjs/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/cjs/src/lib/requests/server/get-page-widget-data-server.js

@@ -7,6 +7,11 @@ const consts_1 = require("../../consts");
 const initializer_1 = require("../../initializer/server/initializer");
 const context_1 = require("../../request-entities/context/context");
 const post_request_1 = require("../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.
+ */
 async function getPageWidgetDataServer(param) {
     (0, initializer_1.verifySearchPackageExistence)();
     const settings = (0, internal_1.getCloudSDKSettingsServer)();

package/dist/cjs/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/cjs/src/lib/requests/server/get-widget-data-server.js

@@ -8,7 +8,7 @@ const post_request_1 = require("../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.
  */
 async function getWidgetDataServer(widgetRequestData) {
     (0, initializer_1.verifySearchPackageExistence)();

package/dist/cjs/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}
  */

package/dist/cjs/src/lib/requests/server/widget-facet-click-event-server.js

@@ -7,7 +7,7 @@ const widget_facet_click_event_1 = require("../../events/widget-facet-click-even
 const initializer_1 = require("../../initializer/server/initializer");
 /**
  * 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}
  */

package/dist/cjs/src/lib/requests/server/widget-item-click-event-server.d.ts

@@ -2,7 +2,7 @@ import type { Request } from '@sitecore-cloudsdk/utils';
 import type { WidgetItemClickEventParams } from '../../events/interfaces';
 /**
  * This function sends a widget 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 widgetItemClickEventParams - An object containing widget click event params
  * from {@link WidgetItemClickEventParams}
  */

package/dist/cjs/src/lib/requests/server/widget-item-click-event-server.js

@@ -7,7 +7,7 @@ const widget_item_click_event_1 = require("../../events/widget-item-click-event"
 const initializer_1 = require("../../initializer/server/initializer");
 /**
  * This function sends a widget 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 widgetItemClickEventParams - An object containing widget click event params
  * from {@link WidgetItemClickEventParams}
  */

package/dist/cjs/src/lib/requests/server/widget-navigation-click-event-server.d.ts

@@ -2,7 +2,7 @@ import type { Request } from '@sitecore-cloudsdk/utils';
 import type { WidgetNavigationClickEventParams } from '../../events/interfaces';
 /**
  * This function sends a widget navigation 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 WidgetNavigationClickEventParams - An object containing widget click event params
  * from {@link WidgetNavigationClickEventParams}
  */

package/dist/cjs/src/lib/requests/server/widget-navigation-click-event-server.js

@@ -7,7 +7,7 @@ const widget_navigation_click_event_1 = require("../../events/widget-navigation-
 const initializer_1 = require("../../initializer/server/initializer");
 /**
  * This function sends a widget navigation 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 WidgetNavigationClickEventParams - An object containing widget click event params
  * from {@link WidgetNavigationClickEventParams}
  */

package/dist/cjs/src/lib/requests/server/widget-suggestion-click-event-server.d.ts

@@ -2,7 +2,7 @@ import type { Request } from '@sitecore-cloudsdk/utils';
 import type { WidgetSuggestionClickEventParams } from '../../events/interfaces';
 /**
  * This function sends a suggestion 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 widgetSuggestionClickEventParams - An object containing widget click event params
  * from {@link WidgetSuggestionClickEventParams}
  */

package/dist/cjs/src/lib/requests/server/widget-suggestion-click-event-server.js

@@ -7,7 +7,7 @@ const widget_suggestion_click_event_1 = require("../../events/widget-suggestion-
 const initializer_1 = require("../../initializer/server/initializer");
 /**
  * This function sends a suggestion 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 widgetSuggestionClickEventParams - An object containing widget click event params
  * from {@link WidgetSuggestionClickEventParams}
  */

package/dist/cjs/src/lib/requests/server/widget-view-event-server.d.ts

@@ -2,7 +2,7 @@ import type { Request } from '@sitecore-cloudsdk/utils';
 import type { WidgetViewEventParams } from '../../events/interfaces';
 /**
  * This function sends a widget 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 widgetViewEventParams - An object containing widget view event params
  * from {@link WidgetViewEventParams}
  */

package/dist/cjs/src/lib/requests/server/widget-view-event-server.js

@@ -7,7 +7,7 @@ const widget_view_event_1 = require("../../events/widget-view-event");
 const initializer_1 = require("../../initializer/server/initializer");
 /**
  * This function sends a widget 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 widgetViewEventParams - An object containing widget view event params
  * from {@link WidgetViewEventParams}
  */