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

package/dist/esm/src/lib/request-entities/context/context.js

@@ -1,15 +1,9 @@
 // © Sitecore Corporation A/S. All rights reserved. Sitecore® is a registered trademark of Sitecore Corporation A/S.
 import { isValidLocation } from '@sitecore-cloudsdk/utils';
 import { ErrorMessages } from '../../consts';
-/**
- * Create context object.
- * @param context - The context object.
- * @returns the validated and mapped context object
- */
 export class Context {
     /**
-     * @param context - The context object.
-     * @returns the validated and mapped context object
+     * @param context - {@link ContextData} The context object.
      */
     constructor(context) {
         this._validateContext(context);
@@ -23,14 +17,13 @@ export class Context {
     }
     /**
      * Sets the campaign data.
-     * @param campaign - The new value to set.
-     *
+     * @param campaign - {@link CampaignData} The new value to set.
      */
     set campaign(campaign) {
         this._campaign = campaign;
     }
     /**
-     * @returns The campaign data.
+     * @returns The campaign data {@link CampaignData}.
      */
     get campaign() {
         return this._campaign;
@@ -43,7 +36,7 @@ export class Context {
     }
     /**
      * Sets the locale data.
-     * @param locale - The new value to set.
+     * @param locale - The new value to set. {@link LocaleData}
      *
      */
     set locale(locale) {
@@ -51,7 +44,7 @@ export class Context {
         this._locale = locale;
     }
     /**
-     * @returns The locale data.
+     * @returns the locale data. {@link LocaleData}
      */
     get locale() {
         return this._locale;
@@ -64,15 +57,14 @@ export class Context {
     }
     /**
      * Sets the page data.
-     * @param page - The new value to set.
-     *
+     * @param page - The new value to set {@link PageData}.
      */
     set page(page) {
         this._validatePage(page);
         this._page = page;
     }
     /**
-     * @returns The page data.
+     * @returns The page data {@link PageData}.
      */
     get page() {
         return this._page;
@@ -85,6 +77,9 @@ export class Context {
     }
     /**
      * Validate context locale object.
+     *
+     * @param locale - the locale object {@link LocaleData}.
+     * @throws - {@link ErrorMessages.IV_0010} | {@link ErrorMessages.IV_0011}.
      */
     _validateContextLocale(locale) {
         if (!locale)
@@ -103,7 +98,7 @@ export class Context {
         this._store = store;
     }
     /**
-     * @returns The store data.
+     * @returns The store data {@link StoreData}.
      */
     get store() {
         return this._store;
@@ -116,7 +111,7 @@ export class Context {
     }
     /**
      * Sets the geo data.
-     * @param geo - The new value to set.
+     * @param geo - The new value to set {@link GeoData}.
      *
      */
     set geo(geo) {
@@ -138,6 +133,9 @@ export class Context {
     }
     /**
      * Validate location object.
+     *
+     * @param location - the location object {@link LocationData}.
+     * @throws - {@link ErrorMessages.IV_0012} | {@link ErrorMessages.IV_0013}.
      */
     _validateLocation(location) {
         const result = isValidLocation(location);
@@ -148,14 +146,14 @@ export class Context {
     }
     /**
      * Sets the user data.
-     * @param user - The new value to set.
+     * @param user - The new value to set {@link UserData}.
      */
     set user(user) {
         this._validateUser(user);
         this._user = user;
     }
     /**
-     * @returns The user data.
+     * @returns The user data {@link UserData}.
      */
     get user() {
         return this._user;
@@ -167,7 +165,7 @@ export class Context {
     /**
      * Validate user object, which is part of the context object.
      * We need to ensure that the user object has `userId` or `uuid`, but not neither.
-     * @param user - The user object to validate.
+     * @param user - The user object to validate {@link UserData}.
      */
     _validateUser(user) {
         if (typeof user !== 'undefined' && !user.userId && !user.uuid)
@@ -180,7 +178,7 @@ export class Context {
         this._browser = browser;
     }
     /**
-     * @returns The browser data.
+     * @returns The browser data {@link BrowserData}.
      */
     get browser() {
         return this._browser;
@@ -192,7 +190,8 @@ export class Context {
         this._browser = undefined;
     }
     /**
-     * Validate context object.
+     * Validate context object {@link ContextData}.
+     * @throws - {@link ErrorMessages.MV_0009} | {@link ErrorMessages.IV_0012} | {@link ErrorMessages.IV_0013}
      */
     _validateContext(context) {
         this._validateContextLocale(context.locale);
@@ -205,7 +204,8 @@ export class Context {
     }
     /**
      * Validate the `page` object which required a `uri` property.
-     * @param page - The page object to validate.
+     * @param page - The page object to validate {@link PageData}.
+     * @throws - {@link ErrorMessages.IV_0025}.
      */
     _validatePage(page) {
         if (!page)
@@ -215,7 +215,7 @@ export class Context {
     }
     /**
      * Map context object to DTO.
-     * @returns The DTO representation of the filter.
+     * @returns The DTO representation of the filter {@link ContextDTO}.
      */
     toDTO() {
         /* eslint-disable @typescript-eslint/naming-convention */

package/dist/esm/src/lib/request-entities/filters/base-filter.d.ts

@@ -6,7 +6,7 @@ export declare abstract class BaseFilter {
     protected operator: Operators;
     protected value: unknown;
     /**
-     * @param operator - The operator to be applied on attribute.
+     * @param operator - The {@link Operators} to be applied on attribute.
      * @param value - The value to check against of.
      */
     constructor(operator: Operators, value: unknown);

package/dist/esm/src/lib/request-entities/filters/base-filter.js

@@ -3,7 +3,7 @@
  */
 export class BaseFilter {
     /**
-     * @param operator - The operator to be applied on attribute.
+     * @param operator - The {@link Operators} to be applied on attribute.
      * @param value - The value to check against of.
      */
     constructor(operator, value) {

package/dist/esm/src/lib/request-entities/filters/comparison-filter.d.ts

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

package/dist/esm/src/lib/request-entities/filters/comparison-filter.js

@@ -6,7 +6,7 @@ import { BaseFilter } from './base-filter';
 export class ComparisonFilter extends BaseFilter {
     /**
      * @param attributeName - The name of the attribute to filter.
-     * @param operator - The operator to be applied on attribute.
+     * @param operator - The {@link ComparisonOperators} to be applied on attribute.
      * @param value - The value to check against of.
      */
     constructor(attributeName, operator, value) {
@@ -14,7 +14,7 @@ export class ComparisonFilter extends BaseFilter {
         this._attributeName = attributeName;
     }
     /**
-     * @returns The DTO representation of the filter.
+     * @returns The DTO representation of the filter {@link ComparisonFilterDTO}.
      */
     toDTO() {
         return {

package/dist/esm/src/lib/request-entities/filters/facet/comparison-facet-filter.d.ts

@@ -7,12 +7,12 @@ export declare class ComparisonFacetFilter implements FacetFilterBase {
     private _operator;
     private _value;
     /**
-     * @param operator - The operator to be applied on attribute.
+     * @param operator - The {@link ComparisonOperators} to be applied on attribute.
      * @param value - The value to check against of.
      */
     constructor(operator: ComparisonOperators, value: string);
     /**
-     * @returns The DTO representation of the filter.
+     * @returns The DTO representation of the filter {@link ComparisonFacetFilterDTO}.
      */
     toDTO(): ComparisonFacetFilterDTO;
 }

package/dist/esm/src/lib/request-entities/filters/facet/comparison-facet-filter.js

@@ -3,7 +3,7 @@
  */
 export class ComparisonFacetFilter {
     /**
-     * @param operator - The operator to be applied on attribute.
+     * @param operator - The {@link ComparisonOperators} to be applied on attribute.
      * @param value - The value to check against of.
      */
     constructor(operator, value) {
@@ -11,7 +11,7 @@ export class ComparisonFacetFilter {
         this._value = value;
     }
     /**
-     * @returns The DTO representation of the filter.
+     * @returns The DTO representation of the filter {@link ComparisonFacetFilterDTO}.
      */
     toDTO() {
         return {

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

@@ -7,12 +7,12 @@ export declare class ListFacetFilter implements FacetFilterBase {
     private _operator;
     private _values;
     /**
-     * @param operator - The operator to be applied on attribute.
-     * @param values - The values to check against of.
+     * @param operator - The {@link ListOperators} to be applied on attribute.
+     * @param values - The values[] to check against of.
      */
     constructor(operator: ListOperators, values: ArrayOfAtLeastOne<string>);
     /**
-     * @returns The DTO representation of the filter.
+     * @returns The DTO representation of the filter {@link ListFacetFilterDTO}.
      */
     toDTO(): ListFacetFilterDTO;
 }

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

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

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

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

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

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

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

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

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

@@ -1,7 +1,14 @@
 export class NotFacetFilter {
+    /**
+     * @param value - the {@link FacetFilter} | string to check against to.
+     */
     constructor(value) {
         this._value = value;
     }
+    /**
+     *
+     * @returns the DTO represantation of notFacetFilter {@link NotFacetFilterDTO}.
+     */
     toDTO() {
         /**
          * If the value is a string, it probably means that it is a facet filter id.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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