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

package/dist/cjs/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@sitecore-cloudsdk/search",
-    "version": "0.5.1-rc.0",
+    "version": "0.5.2-rc.0",
     "license": "Apache-2.0",
     "exports": {
         "./server": {
@@ -20,9 +20,9 @@
         "build:es": "tsc -b ."
     },
     "dependencies": {
-        "@sitecore-cloudsdk/core": "^0.5.1-rc.0",
-        "@sitecore-cloudsdk/events": "^0.5.1-rc.0",
-        "@sitecore-cloudsdk/utils": "^0.5.1-rc.0"
+        "@sitecore-cloudsdk/core": "^0.5.2-rc.0",
+        "@sitecore-cloudsdk/events": "^0.5.2-rc.0",
+        "@sitecore-cloudsdk/utils": "^0.5.2-rc.0"
     },
     "files": [
         "dist",

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

@@ -10,6 +10,7 @@ import type { ArrayOfAtLeastOne, Filter, FilterDTO, LogicalOperators } from '../
 export interface WidgetItemDTO {
     entity: string;
     rfk_id: string;
+    sources?: ArrayOfAtLeastOne<string>;
 }
 /**
  * Represents the content options property of the results widget item.
@@ -145,6 +146,7 @@ export interface SearchOptions extends ResultsOptions {
     ranking?: ArrayOfAtLeastOne<SearchRankingOptions>;
     personalization?: SearchPersonalizationOptions;
     disableGrouping?: boolean;
+    responseContext?: boolean;
 }
 /**
  * Represents the search object of the search widget item in its DTO format.
@@ -158,6 +160,7 @@ export interface SearchDTO extends ResultsItemDTO {
     ranking?: ArrayOfAtLeastOne<SearchRankingOptionsDto>;
     personalization?: SearchPersonalizationOptionsDto;
     disable_grouping?: boolean;
+    response_context?: Record<string, never>;
 }
 /**
  * Represents the search widget item object in its DTO format.

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

@@ -1,3 +1,4 @@
+import type { ArrayOfAtLeastOne } from '../filters/interfaces';
 import type { ExactAnswerOptions, QuestionsAnswersOptions, QuestionsAnswersWidgetItemDTO, RelatedQuestionsOptions } from './interfaces';
 import { RuleWidgetItem } from './rule-widget-item';
 export declare class QuestionsAnswersWidgetItem extends RuleWidgetItem {
@@ -9,9 +10,10 @@ export declare class QuestionsAnswersWidgetItem extends RuleWidgetItem {
      * @param entity - The widget's item entity.
      * @param widgetId - The widget's item id.
      * @param questionsAnswersOptions - The widget's {@link QuestionsAnswersOptions} object.
+     * @param sources - The widget's sources.
      * @throws - {@link ErrorMessages.IV_0007} | {@link ErrorMessages.IV_0008} | {@link ErrorMessages.IV_0009}
      */
-    constructor(entity: string, widgetId: string, questionsAnswersOptions: QuestionsAnswersOptions);
+    constructor(entity: string, widgetId: string, questionsAnswersOptions: QuestionsAnswersOptions, sources?: ArrayOfAtLeastOne<string>);
     /**
      * Throws an error if limit is outside of range of 1 ~ 100 or offset is not a positive integer
      * @param relatedQuestions - {@link RelatedQuestionsOptions}

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

@@ -10,10 +10,11 @@ class QuestionsAnswersWidgetItem extends rule_widget_item_1.RuleWidgetItem {
      * @param entity - The widget's item entity.
      * @param widgetId - The widget's item id.
      * @param questionsAnswersOptions - The widget's {@link QuestionsAnswersOptions} object.
+     * @param sources - The widget's sources.
      * @throws - {@link ErrorMessages.IV_0007} | {@link ErrorMessages.IV_0008} | {@link ErrorMessages.IV_0009}
      */
-    constructor(entity, widgetId, questionsAnswersOptions) {
-        super(entity, widgetId, questionsAnswersOptions.rule);
+    constructor(entity, widgetId, questionsAnswersOptions, sources) {
+        super(entity, widgetId, questionsAnswersOptions.rule, sources);
         this._validateStringLengthInRange1To100(consts_1.ErrorMessages.IV_0009, questionsAnswersOptions.keyphrase);
         this._keyphrase = questionsAnswersOptions.keyphrase;
         this._exactAnswer = questionsAnswersOptions.exactAnswer;

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

@@ -1,3 +1,4 @@
+import type { ArrayOfAtLeastOne } from '../filters/interfaces';
 import type { Recipe, Recommendation, RecommendationOptions, WidgetItemRecommendationDTO } from './interfaces';
 import { ResultsWidgetItem } from './results-widget-item';
 export declare class RecommendationWidgetItem extends ResultsWidgetItem {
@@ -7,9 +8,10 @@ export declare class RecommendationWidgetItem extends ResultsWidgetItem {
      * @param entity - The widget's item entity.
      * @param widgetId - The widget's item id.
      * @param recommendationOptions - The widget's {@link RecommendationOptions} object.
+     * @param sources - The widget's sources.
      * @throws - {@link ErrorMessages.IV_0023} | {@link ErrorMessages.IV_0024}
      */
-    constructor(entity: string, widgetId: string, recommendationOptions?: RecommendationOptions);
+    constructor(entity: string, widgetId: string, recommendationOptions?: RecommendationOptions, sources?: ArrayOfAtLeastOne<string>);
     /**
      * Sets the recommendations to an empty object.
      */

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

@@ -10,11 +10,12 @@ class RecommendationWidgetItem extends results_widget_item_1.ResultsWidgetItem {
      * @param entity - The widget's item entity.
      * @param widgetId - The widget's item id.
      * @param recommendationOptions - The widget's {@link RecommendationOptions} object.
+     * @param sources - The widget's sources.
      * @throws - {@link ErrorMessages.IV_0023} | {@link ErrorMessages.IV_0024}
      */
-    constructor(entity, widgetId, recommendationOptions) {
+    constructor(entity, widgetId, recommendationOptions, sources) {
         const { recipe, ...rest } = recommendationOptions || {};
-        super(entity, widgetId, rest);
+        super(entity, widgetId, rest, sources);
         if (!recommendationOptions)
             return;
         if (!Object.keys(recommendationOptions).length) {

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

@@ -1,4 +1,4 @@
-import type { Filter } from '../filters/interfaces';
+import type { ArrayOfAtLeastOne, Filter } from '../filters/interfaces';
 import type { ContentOptions, ResultsItemDTO, ResultsOptions } from './interfaces';
 import { RuleWidgetItem } from './rule-widget-item';
 export declare class ResultsWidgetItem extends RuleWidgetItem {
@@ -11,9 +11,10 @@ export declare class ResultsWidgetItem extends RuleWidgetItem {
      * @param entity - The widget's item entity.
      * @param widgetId - The widget's item id.
      * @param resultOptions - The widget's {@link ResultsOptions} object.
+     * @param sources - The widget's sources.
      * @throws - {@link ErrorMessages.IV_0007} | {@link ErrorMessages.IV_0022}
      */
-    constructor(entity: string, widgetId: string, resultOptions?: ResultsOptions);
+    constructor(entity: string, widgetId: string, resultOptions?: ResultsOptions, sources?: ArrayOfAtLeastOne<string>);
     /**
      * Sets the search limit for the WidgetItem.
      * This method updates the `limit` property of the search configuration within the WidgetItem instance.

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

@@ -10,10 +10,11 @@ class ResultsWidgetItem extends rule_widget_item_1.RuleWidgetItem {
      * @param entity - The widget's item entity.
      * @param widgetId - The widget's item id.
      * @param resultOptions - The widget's {@link ResultsOptions} object.
+     * @param sources - The widget's sources.
      * @throws - {@link ErrorMessages.IV_0007} | {@link ErrorMessages.IV_0022}
      */
-    constructor(entity, widgetId, resultOptions) {
-        super(entity, widgetId, resultOptions?.rule);
+    constructor(entity, widgetId, resultOptions, sources) {
+        super(entity, widgetId, resultOptions?.rule, sources);
         this._validateNumberInRange1To100(consts_1.ErrorMessages.IV_0007, resultOptions?.limit);
         this._validateGroupBy(resultOptions?.groupBy);
         this._limit = resultOptions?.limit;

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

@@ -1,3 +1,4 @@
+import type { ArrayOfAtLeastOne } from '../filters/interfaces';
 import type { SearchRuleDTO, SearchRuleOptions } from './interfaces';
 import { WidgetItem } from './widget-item';
 /** Base class for widgets that support rules functionality */
@@ -8,9 +9,10 @@ export declare class RuleWidgetItem extends WidgetItem {
      * @param entity - the entity value of the RuleWidgetItem.
      * @param widgetId - the widgetId value of the RuleWidgetItem.
      * @param rule - the {@link SearchRuleOptions} of the RuleWidgetItem.
+     * @param sources - The widget's sources.
      * @throws - {@link ErrorMessages.IV_0027} | {@link ErrorMessages.IV_0028}
      */
-    constructor(entity: string, widgetId: string, rule?: SearchRuleOptions);
+    constructor(entity: string, widgetId: string, rule?: SearchRuleOptions, sources?: ArrayOfAtLeastOne<string>);
     /**
      * Sets the `rule` property
      * @param rule - the {@link SearchRuleOptions} value to be applied.

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

@@ -11,10 +11,11 @@ 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.
+     * @param sources - The widget's sources.
      * @throws - {@link ErrorMessages.IV_0027} | {@link ErrorMessages.IV_0028}
      */
-    constructor(entity, widgetId, rule) {
-        super(entity, widgetId);
+    constructor(entity, widgetId, rule, sources) {
+        super(entity, widgetId, sources);
         if (rule) {
             this._validateRule(rule);
             this._rule = rule;

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

@@ -10,11 +10,13 @@ export declare class SearchWidgetItem extends ResultsWidgetItem {
     private _ranking?;
     private _personalization?;
     private _disableGrouping?;
+    private _responseContext?;
     /**
      * 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 {@link SearchOptions} object.
+     * @param sources - The widget's sources.
      * @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};
@@ -23,7 +25,7 @@ export declare class SearchWidgetItem extends ResultsWidgetItem {
      * @throws - {@link ErrorMessages.IV_0029} | {@link ErrorMessages.IV_0030};
      * @throws - {@link ErrorMessages.IV_0031}
      */
-    constructor(entity: string, widgetId: string, searchOptions?: SearchOptions);
+    constructor(entity: string, widgetId: string, searchOptions?: SearchOptions, sources?: ArrayOfAtLeastOne<string>);
     /**
      * @param personalization - the object {@link SearchPersonalizationOptions} of the `personalization` param
      */
@@ -131,6 +133,19 @@ export declare class SearchWidgetItem extends ResultsWidgetItem {
      * Sets the `disableGrouping` property to undefined.
      */
     resetDisableGrouping(): void;
+    /**
+     * Sets the `responseContext` property of the SearchWidgetItem.
+     * @param responseContext - A boolean indicating if response context has been enabled in Sitecore Search.
+     */
+    set responseContext(responseContext: boolean);
+    /**
+     * @returns The `responseContext` property of the SearchWidgetItem.
+     */
+    get responseContext(): boolean | undefined;
+    /**
+     * Resets the `responseContext` property to undefined.
+     */
+    resetResponseContext(): void;
     /**
      * Sets the suggestion property for SearchWidgetItem
      * @param suggestion - the {@link SearchSuggestionOptions}[] of objects for the suggestion param

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

@@ -11,6 +11,7 @@ class SearchWidgetItem extends results_widget_item_1.ResultsWidgetItem {
      * @param entity - The widget's item entity.
      * @param widgetId - The widget's item id.
      * @param searchOptions - The widget's {@link SearchOptions} object.
+     * @param sources - The widget's sources.
      * @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};
@@ -19,14 +20,14 @@ class SearchWidgetItem extends results_widget_item_1.ResultsWidgetItem {
      * @throws - {@link ErrorMessages.IV_0029} | {@link ErrorMessages.IV_0030};
      * @throws - {@link ErrorMessages.IV_0031}
      */
-    constructor(entity, widgetId, searchOptions) {
+    constructor(entity, widgetId, searchOptions, sources) {
         super(entity, widgetId, {
             content: searchOptions?.content,
             filter: searchOptions?.filter,
             groupBy: searchOptions?.groupBy,
             limit: searchOptions?.limit,
             rule: searchOptions?.rule
-        });
+        }, sources);
         if (!searchOptions)
             return;
         if (searchOptions.facet && Object.keys(searchOptions.facet).length) {
@@ -49,6 +50,7 @@ class SearchWidgetItem extends results_widget_item_1.ResultsWidgetItem {
         this._validateSuggestion(searchOptions.suggestion);
         this._suggestion = searchOptions.suggestion;
         this._disableGrouping = searchOptions.disableGrouping;
+        this._responseContext = searchOptions.responseContext;
     }
     /**
      * @param personalization - the object {@link SearchPersonalizationOptions} of the `personalization` param
@@ -221,6 +223,25 @@ class SearchWidgetItem extends results_widget_item_1.ResultsWidgetItem {
     resetDisableGrouping() {
         this._disableGrouping = undefined;
     }
+    /**
+     * Sets the `responseContext` property of the SearchWidgetItem.
+     * @param responseContext - A boolean indicating if response context has been enabled in Sitecore Search.
+     */
+    set responseContext(responseContext) {
+        this._responseContext = responseContext;
+    }
+    /**
+     * @returns The `responseContext` property of the SearchWidgetItem.
+     */
+    get responseContext() {
+        return this._responseContext;
+    }
+    /**
+     * Resets the `responseContext` property to undefined.
+     */
+    resetResponseContext() {
+        this._responseContext = undefined;
+    }
     /**
      * Sets the suggestion property for SearchWidgetItem
      * @param suggestion - the {@link SearchSuggestionOptions}[] of objects for the suggestion param
@@ -390,6 +411,7 @@ class SearchWidgetItem extends results_widget_item_1.ResultsWidgetItem {
             ...{ suggestion: this._suggestionToDTO() },
             ...{ sort: this._sort },
             ...{ disable_grouping: this._disableGrouping },
+            ...(this._responseContext ? { response_context: {} } : undefined),
             ...resultsDTO
         };
         const dto = {

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

@@ -1,15 +1,17 @@
 import { ErrorMessages } from '../../consts';
+import type { ArrayOfAtLeastOne } from '../filters/interfaces';
 import type { WidgetItemDTO } from './interfaces';
 export declare class WidgetItem {
     protected _entity: string;
     protected _widgetId: string;
+    protected _sources?: ArrayOfAtLeastOne<string>;
     /**
      * Creates and holds the functionality of a widget item.
      * @param entity - The widget's item entity.
      * @param widgetId - The widget's item id.
-     *
+     * @param sources - The widget's sources.
      */
-    constructor(entity: string, widgetId: string);
+    constructor(entity: string, widgetId: string, sources?: ArrayOfAtLeastOne<string>);
     /**
      * Sets the entity for the WidgetItem.
      * This method updates the `entity` property of WidgetItem instance.
@@ -21,6 +23,18 @@ export declare class WidgetItem {
      * @returns The entity property of the WidgetItem.
      */
     get entity(): string;
+    /**
+     * @returns The sources property of the WidgetItem.
+     */
+    get sources(): ArrayOfAtLeastOne<string> | undefined;
+    /**
+     * Sets the sources for the WidgetItem.
+     * This method updates the `sources` property within the WidgetItem instance.
+     * The sources are used to define specific search criteria or filters.
+     * @param sources - The array of sources {@link ArrayOfAtLeastOne} that specifies the search criteria.
+     */
+    set sources(sources: ArrayOfAtLeastOne<string>);
+    resetSources(): void;
     /**
      *
      * @param entity - the string to validate

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

@@ -8,13 +8,14 @@ class WidgetItem {
      * Creates and holds the functionality of a widget item.
      * @param entity - The widget's item entity.
      * @param widgetId - The widget's item id.
-     *
+     * @param sources - The widget's sources.
      */
-    constructor(entity, widgetId) {
+    constructor(entity, widgetId, sources) {
         this._validateWidgetId(widgetId);
         this._validateEntity(entity);
         this._entity = entity;
         this._widgetId = widgetId;
+        this._sources = sources;
     }
     /**
      * Sets the entity for the WidgetItem.
@@ -32,6 +33,24 @@ class WidgetItem {
     get entity() {
         return this._entity;
     }
+    /**
+     * @returns The sources property of the WidgetItem.
+     */
+    get sources() {
+        return this._sources;
+    }
+    /**
+     * Sets the sources for the WidgetItem.
+     * This method updates the `sources` property within the WidgetItem instance.
+     * The sources are used to define specific search criteria or filters.
+     * @param sources - The array of sources {@link ArrayOfAtLeastOne} that specifies the search criteria.
+     */
+    set sources(sources) {
+        this._sources = sources;
+    }
+    resetSources() {
+        this._sources = undefined;
+    }
     /**
      *
      * @param entity - the string to validate
@@ -122,7 +141,8 @@ class WidgetItem {
         return {
             entity: this._entity,
             // eslint-disable-next-line @typescript-eslint/naming-convention
-            rfk_id: this._widgetId
+            rfk_id: this._widgetId,
+            ...(this._sources && { sources: this._sources })
         };
     }
 }