@sitecore-cloudsdk/search 0.5.0-rc.0

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

@@ -0,0 +1,76 @@
+import type { Filter } from '../filters/interfaces';
+import type { ContentOptions, ResultsItemDTO, ResultsOptions } from './interfaces';
+import { RuleWidgetItem } from './rule-widget-item';
+export declare class ResultsWidgetItem extends RuleWidgetItem {
+    protected _limit?: number;
+    protected _content?: ContentOptions;
+    protected _groupBy?: string;
+    protected _filter?: Filter;
+    /**
+     * Creates and holds the functionality of a widget item.
+     * @param entity - The widget's item entity.
+     * @param widgetId - The widget's item id.
+     * @param resultOptions - The widget's results options object.
+     */
+    constructor(entity: string, widgetId: string, resultOptions?: ResultsOptions);
+    /**
+     * Sets the search limit for the WidgetItem.
+     * This method updates the `limit` property of the search configuration within the WidgetItem instance.
+     * The limit is used to specify the maximum number of results to be returned, useful for controlling pagination.
+     *
+     * @param limit - The number to set as the search limit, which must be between 1 and 100, inclusive.
+     * @throws Error If the limit is less than 1 or greater than 100, indicating an invalid range.
+     */
+    set limit(limit: number);
+    /**
+     * @returns The limit property of the WidgetItem.
+     */
+    get limit(): number | undefined;
+    /**
+     * Sets the limit to undefined
+     */
+    resetLimit(): void;
+    /**
+     * Sets the search content for the ResultsItem.
+     * This method updates the `content` property within the ResultsItem instance.
+     * The attributes is used to define specific search criteria or filters.
+     * @param contentOptions - The array attributes that specifies the search criteria.
+     */
+    set content(contentOptions: ContentOptions);
+    /**
+     * @returns The content property of the WidgetItem.
+     */
+    get content(): ContentOptions | undefined;
+    /**
+     * Sets the content to undefined
+     */
+    resetContent(): void;
+    /**
+     * Sets the group_by operator for search object of the WidgetItem.
+     * This method updates the `attribute` property of the search configuration within the WidgetItem instance.
+     * @param groupBy - The attribute that specifies what search results are grouped by.
+     */
+    set groupBy(groupBy: string);
+    /**
+     * @returns The groupBy property of the WidgetItem.
+     */
+    get groupBy(): string | undefined;
+    /** Sets the groupBy to undefined */
+    resetGroupBy(): void;
+    private _validateGroupBy;
+    /** Set the search filter */
+    set filter(filter: Filter);
+    /** @returns The filter property of the WidgetItem */
+    get filter(): Filter | undefined;
+    /** Sets the filter to undefined */
+    resetFilter(): void;
+    /**
+     *
+     * @returns The content property in its DTO format.
+     */
+    private _contentToDTO;
+    /**
+     * Maps the results item to its DTO format.
+     */
+    protected _resultsToDTO(): ResultsItemDTO;
+}

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

@@ -0,0 +1,126 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ResultsWidgetItem = void 0;
+// © Sitecore Corporation A/S. All rights reserved. Sitecore® is a registered trademark of Sitecore Corporation A/S.
+const consts_1 = require("../../consts");
+const rule_widget_item_1 = require("./rule-widget-item");
+class ResultsWidgetItem extends rule_widget_item_1.RuleWidgetItem {
+    /**
+     * Creates and holds the functionality of a widget item.
+     * @param entity - The widget's item entity.
+     * @param widgetId - The widget's item id.
+     * @param resultOptions - The widget's results options object.
+     */
+    constructor(entity, widgetId, resultOptions) {
+        super(entity, widgetId, resultOptions?.rule);
+        this._validateNumberInRange1To100(consts_1.ErrorMessages.IV_0007, resultOptions?.limit);
+        this._validateGroupBy(resultOptions?.groupBy);
+        this._limit = resultOptions?.limit;
+        this._content = resultOptions?.content;
+        this._groupBy = resultOptions?.groupBy;
+        this._filter = resultOptions?.filter;
+    }
+    /**
+     * Sets the search limit for the WidgetItem.
+     * This method updates the `limit` property of the search configuration within the WidgetItem instance.
+     * The limit is used to specify the maximum number of results to be returned, useful for controlling pagination.
+     *
+     * @param limit - The number to set as the search limit, which must be between 1 and 100, inclusive.
+     * @throws Error If the limit is less than 1 or greater than 100, indicating an invalid range.
+     */
+    set limit(limit) {
+        this._validateNumberInRange1To100(consts_1.ErrorMessages.IV_0007, limit);
+        this._limit = limit;
+    }
+    /**
+     * @returns The limit property of the WidgetItem.
+     */
+    get limit() {
+        return this._limit;
+    }
+    /**
+     * Sets the limit to undefined
+     */
+    resetLimit() {
+        this._limit = undefined;
+    }
+    /**
+     * Sets the search content for the ResultsItem.
+     * This method updates the `content` property within the ResultsItem instance.
+     * The attributes is used to define specific search criteria or filters.
+     * @param contentOptions - The array attributes that specifies the search criteria.
+     */
+    set content(contentOptions) {
+        this._content = contentOptions;
+    }
+    /**
+     * @returns The content property of the WidgetItem.
+     */
+    get content() {
+        return this._content;
+    }
+    /**
+     * Sets the content to undefined
+     */
+    resetContent() {
+        this._content = undefined;
+    }
+    /**
+     * Sets the group_by operator for search object of the WidgetItem.
+     * This method updates the `attribute` property of the search configuration within the WidgetItem instance.
+     * @param groupBy - The attribute that specifies what search results are grouped by.
+     */
+    set groupBy(groupBy) {
+        this._validateGroupBy(groupBy);
+        this._groupBy = groupBy;
+    }
+    /**
+     * @returns The groupBy property of the WidgetItem.
+     */
+    get groupBy() {
+        return this._groupBy;
+    }
+    /** Sets the groupBy to undefined */
+    resetGroupBy() {
+        this._groupBy = undefined;
+    }
+    _validateGroupBy(groupBy) {
+        if (typeof groupBy === 'string' && groupBy.trim().length === 0)
+            throw new Error(consts_1.ErrorMessages.IV_0022);
+    }
+    /** Set the search filter */
+    set filter(filter) {
+        this._filter = filter;
+    }
+    /** @returns The filter property of the WidgetItem */
+    get filter() {
+        return this._filter;
+    }
+    /** Sets the filter to undefined */
+    resetFilter() {
+        this._filter = undefined;
+    }
+    /**
+     *
+     * @returns The content property in its DTO format.
+     */
+    _contentToDTO() {
+        if (!this._content)
+            return undefined;
+        const { attributes, ...rest } = this._content;
+        return { fields: attributes, ...rest };
+    }
+    /**
+     * Maps the results item to its DTO format.
+     */
+    _resultsToDTO() {
+        return {
+            ...(this._limit && { limit: this._limit }),
+            ...(this._filter && { filter: this._filter.toDTO() }),
+            ...(this._groupBy && { group_by: this._groupBy }),
+            ...(this._content && { content: this._contentToDTO() }),
+            ...(this._rule && { rule: this._ruleToDTO(this._rule) })
+        };
+    }
+}
+exports.ResultsWidgetItem = ResultsWidgetItem;

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

@@ -0,0 +1,14 @@
+import type { SearchRuleDTO, SearchRuleOptions } from './interfaces';
+import { WidgetItem } from './widget-item';
+/** Base class for widgets that support rules functionality */
+export declare class RuleWidgetItem extends WidgetItem {
+    protected _rule?: SearchRuleOptions;
+    constructor(entity: string, widgetId: string, rule?: SearchRuleOptions);
+    set rule(rule: SearchRuleOptions);
+    get rule(): SearchRuleOptions | undefined;
+    resetRule(): void;
+    protected _validateRule(rule?: SearchRuleOptions): void;
+    private _convertToBoostRuleDTO;
+    private _convertToIncludeRuleDTO;
+    protected _ruleToDTO(rule?: SearchRuleOptions): SearchRuleDTO | undefined;
+}

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

@@ -0,0 +1,71 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RuleWidgetItem = void 0;
+// © Sitecore Corporation A/S. All rights reserved. Sitecore® is a registered trademark of Sitecore Corporation A/S.
+const consts_1 = require("../../consts");
+const widget_item_1 = require("./widget-item");
+/** Base class for widgets that support rules functionality */
+class RuleWidgetItem extends widget_item_1.WidgetItem {
+    constructor(entity, widgetId, rule) {
+        super(entity, widgetId);
+        if (rule) {
+            this._validateRule(rule);
+            this._rule = rule;
+        }
+    }
+    set rule(rule) {
+        this._validateRule(rule);
+        this._rule = rule;
+    }
+    get rule() {
+        return this._rule;
+    }
+    resetRule() {
+        this._rule = undefined;
+    }
+    _validateRule(rule) {
+        if (!rule)
+            return;
+        // Validate pin rules
+        rule.pin?.forEach((pin) => {
+            this._validateNonEmptyString(consts_1.ErrorMessages.IV_0027, pin.id);
+            this._validatePositiveInteger(consts_1.ErrorMessages.IV_0028, pin.slot);
+        });
+        // Validate boost rules
+        rule.boost?.forEach((item) => item.slots?.forEach((slot) => this._validatePositiveInteger(consts_1.ErrorMessages.IV_0028, slot)));
+        // Validate include rules
+        rule.include?.forEach((item) => item.slots.forEach((slot) => this._validatePositiveInteger(consts_1.ErrorMessages.IV_0028, slot)));
+    }
+    _convertToBoostRuleDTO(rules) {
+        return rules.map((rule) => ({
+            filter: rule.filter.toDTO(),
+            slots: rule.slots,
+            weight: rule.weight
+        }));
+    }
+    _convertToIncludeRuleDTO(rules) {
+        return rules.map((rule) => ({
+            filter: rule.filter.toDTO(),
+            slots: rule.slots
+        }));
+    }
+    _ruleToDTO(rule) {
+        if (!rule)
+            return undefined;
+        const dto = {
+            behaviors: rule.behaviors
+        };
+        if (rule.blacklist)
+            dto.blacklist = { filter: rule.blacklist.filter.toDTO() };
+        if (rule.boost)
+            dto.boost = this._convertToBoostRuleDTO(rule.boost);
+        if (rule.bury)
+            dto.bury = { filter: rule.bury.filter.toDTO() };
+        if (rule.include)
+            dto.include = this._convertToIncludeRuleDTO(rule.include);
+        if (rule.pin)
+            dto.pin = rule.pin;
+        return dto;
+    }
+}
+exports.RuleWidgetItem = RuleWidgetItem;

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

@@ -0,0 +1,167 @@
+import type { ArrayOfAtLeastOne } from '../filters/interfaces';
+import type { FacetOptions, QueryOptions, SearchOptions, SearchPersonalizationOptions, SearchRankingOptions, SearchSortOptions, SearchSuggestionOptions, SearchWidgetItemDTO } from './interfaces';
+import { ResultsWidgetItem } from './results-widget-item';
+export declare class SearchWidgetItem extends ResultsWidgetItem {
+    private _query?;
+    private _offset?;
+    private _facet?;
+    private _sort?;
+    private _suggestion?;
+    private _ranking?;
+    private _personalization?;
+    /**
+     * 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.
+     *
+     */
+    constructor(entity: string, widgetId: string, searchOptions?: SearchOptions);
+    /**
+     * @param personalization - the object of the `personalization` param
+     */
+    set personalization(personalization: SearchPersonalizationOptions);
+    /**
+     * @returns the `personalization` property of the SearchWidgetItem
+     */
+    get personalization(): SearchPersonalizationOptions | undefined;
+    /**
+     * sets the `personalization` property to undefined of the SearchWidgetItem
+     */
+    resetPersonalization(): void;
+    /**
+     *
+     * @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
+     */
+    private _validatePersonalization;
+    /**
+     *
+     * @returns The personalization property in its DTO format.
+     */
+    private _personalizationToDTO;
+    /**
+     * @param ranking - the object of the `ranking` param
+     */
+    set ranking(ranking: ArrayOfAtLeastOne<SearchRankingOptions>);
+    /**
+     * @returns the `ranking` property of the SearchWidgetItem
+     */
+    get ranking(): ArrayOfAtLeastOne<SearchRankingOptions> | undefined;
+    /**
+     * sets the `ranking` property to undefined of the SearchWidgetItem
+     */
+    resetRanking(): void;
+    /**
+     *
+     * @param ranking - the object of the `ranking` property
+     * @throws IV_0016 if `ranking.name` contains an empty string
+     * @throws IV_0016 if `ranking.weight` is outside of range 1 ~ 100
+     */
+    private _validateRanking;
+    /**
+     * Sets the search query for the SearchWidgetItem.
+     * This method updates the `query` property of the search configuration within the SearchWidgetItem instance.
+     * The query is used to define specific search criteria.
+     * @param query - The operator that specifies the search criteria.
+     */
+    set query(query: QueryOptions);
+    /**
+     * @returns The query property of the SearchWidgetItem.
+     */
+    get query(): QueryOptions | undefined;
+    private _validateQuery;
+    /**
+     * Sets the query data to undefined
+     */
+    resetQuery(): void;
+    /**
+     * Sets the search facet for the SearchWidgetItem.
+     * 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.
+     */
+    set facet(facet: FacetOptions);
+    /**
+     * @returns The facet property of the SearchWidgetItem.
+     */
+    get facet(): FacetOptions | undefined;
+    /**
+     * Sets the facet data to undefined
+     */
+    resetFacet(): void;
+    /**
+     * 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.
+     */
+    set offset(offset: number);
+    /**
+     * @returns The offset property of the SearchWidgetItem.
+     */
+    get offset(): number | undefined;
+    /**
+     * Sets the offset value to undefined
+     */
+    resetOffset(): void;
+    /**
+     * Sets the suggestion property for SearchWidgetItem
+     * @param suggestion - the <array>array of objects for the suggestion param
+     * @throws error if <SearchSuggestionOptions>.<suggestion>.name property is an empty string or contains spaces
+     * @throws error if <SearchSuggestionOptions>.<suggestion>.max property is not between the range 1 ~ 100
+     */
+    set suggestion(suggestion: ArrayOfAtLeastOne<SearchSuggestionOptions>);
+    /**
+     * @returns The suggestion property of the SearchWidgetItem.
+     */
+    get suggestion(): ArrayOfAtLeastOne<SearchSuggestionOptions> | undefined;
+    /**
+     * Sets the suggestion property to undefined.
+     */
+    resetSuggestion(): void;
+    private _suggestionToDTO;
+    /**
+     * Validates the suggestion property. Throws error if provided with incorrect values.
+     * @param suggestion - the <array> of objects for the suggestion param
+     */
+    private _validateSuggestion;
+    /**
+     * Sets the search sort property for SearchWidgetItem
+     * Throws an error if one of the values under sort have an empty `name`
+     * @param sort - the object for the sort param
+     * @throws error if <SearchSortOptions>.<SortValue>.name(s) property is an empty string
+     */
+    set sort(sort: SearchSortOptions);
+    /**
+     * @returns The sort property of the SearchWidgetItem.
+     */
+    get sort(): SearchSortOptions | undefined;
+    /**
+     * Sets the sort data to undefined
+     */
+    resetSort(): void;
+    /**
+     * Validates the sort field. Throws an error if incorrect values are provided.
+     */
+    private _validateSort;
+    /**
+     * Validates the facet type fields. Throws an errors if incorrect values are provided.
+     */
+    private _validateFacetTypes;
+    private _filterToDTO;
+    /**
+     * Builds the sort piece of the DTO.
+     */
+    private _facetSortToDTO;
+    /**
+     * Builds the filtering options array.
+     */
+    private _filteringOptionsToDTO;
+    /**
+     * Maps the search widget item to its DTO format.
+     */
+    toDTO(): SearchWidgetItemDTO;
+}