@sitecore-cloudsdk/search 0.5.0-rc.0

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

@@ -0,0 +1,353 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SearchWidgetItem = 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 results_widget_item_1 = require("./results-widget-item");
+const utils_1 = require("./utils");
+class SearchWidgetItem extends results_widget_item_1.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.
+     *
+     */
+    constructor(entity, widgetId, searchOptions) {
+        super(entity, widgetId, {
+            content: searchOptions?.content,
+            filter: searchOptions?.filter,
+            groupBy: searchOptions?.groupBy,
+            limit: searchOptions?.limit,
+            rule: searchOptions?.rule
+        });
+        if (!searchOptions)
+            return;
+        if (searchOptions.facet && Object.keys(searchOptions.facet).length) {
+            this._validateNumberInRange1To100(consts_1.ErrorMessages.IV_0014, searchOptions.facet.max);
+            this._validateFacetTypes(searchOptions.facet.types);
+            this._facet = searchOptions.facet;
+        }
+        if (searchOptions.query) {
+            this._validateQuery(searchOptions.query);
+            this._query = searchOptions.query;
+        }
+        this._validatePositiveInteger(consts_1.ErrorMessages.IV_0008, searchOptions.offset);
+        this._offset = searchOptions.offset;
+        this._validatePersonalization(searchOptions.personalization);
+        this._personalization = searchOptions.personalization;
+        this._validateRanking(searchOptions.ranking);
+        this._ranking = searchOptions.ranking;
+        this._validateSort(searchOptions.sort);
+        this._sort = searchOptions.sort;
+        this._validateSuggestion(searchOptions.suggestion);
+        this._suggestion = searchOptions.suggestion;
+    }
+    /**
+     * @param personalization - the object of the `personalization` param
+     */
+    set personalization(personalization) {
+        this._validatePersonalization(personalization);
+        this._personalization = personalization;
+    }
+    /**
+     * @returns the `personalization` property of the SearchWidgetItem
+     */
+    get personalization() {
+        return this._personalization;
+    }
+    /**
+     * sets the `personalization` property to undefined of the SearchWidgetItem
+     */
+    resetPersonalization() {
+        this._personalization = undefined;
+    }
+    /**
+     *
+     * @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
+     */
+    _validatePersonalization(personalization) {
+        if (!personalization)
+            return;
+        personalization.attributes.forEach((attribute) => {
+            this._validateNonEmptyNoWhitespaceString(consts_1.ErrorMessages.IV_0030, attribute);
+        });
+        if (personalization.algorithm === 'mlt')
+            personalization.ids.forEach((id) => {
+                this._validateNonEmptyString(consts_1.ErrorMessages.IV_0031, id);
+            });
+    }
+    /**
+     *
+     * @returns The personalization property in its DTO format.
+     */
+    _personalizationToDTO() {
+        if (!this._personalization)
+            return undefined;
+        const { attributes, ...rest } = this._personalization;
+        return { fields: attributes, ...rest };
+    }
+    /**
+     * @param ranking - the object of the `ranking` param
+     */
+    set ranking(ranking) {
+        this._validateRanking(ranking);
+        this._ranking = ranking;
+    }
+    /**
+     * @returns the `ranking` property of the SearchWidgetItem
+     */
+    get ranking() {
+        return this._ranking;
+    }
+    /**
+     * sets the `ranking` property to undefined of the SearchWidgetItem
+     */
+    resetRanking() {
+        this._ranking = undefined;
+    }
+    /**
+     *
+     * @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
+     */
+    _validateRanking(ranking) {
+        ranking?.forEach((rank) => {
+            this._validateNumberInRange(consts_1.ErrorMessages.IV_0029, { max: 100, min: 0.1 }, rank.weight);
+            this._validateNonEmptyNoWhitespaceString(consts_1.ErrorMessages.IV_0016, rank.name);
+        });
+    }
+    /**
+     * 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) {
+        this._validateQuery(query);
+        this._query = query;
+    }
+    /**
+     * @returns The query property of the SearchWidgetItem.
+     */
+    get query() {
+        return this._query;
+    }
+    _validateQuery(query) {
+        this._validateStringLengthInRange1To100(consts_1.ErrorMessages.IV_0009, query.keyphrase);
+    }
+    /**
+     * Sets the query data to undefined
+     */
+    resetQuery() {
+        this._query = undefined;
+    }
+    /**
+     * 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) {
+        this._validateNumberInRange1To100(consts_1.ErrorMessages.IV_0014, facet.max);
+        this._validateFacetTypes(facet.types);
+        this._facet = facet;
+    }
+    /**
+     * @returns The facet property of the SearchWidgetItem.
+     */
+    get facet() {
+        return this._facet;
+    }
+    /**
+     * Sets the facet data to undefined
+     */
+    resetFacet() {
+        this._facet = undefined;
+    }
+    /**
+     * 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) {
+        this._validatePositiveInteger(consts_1.ErrorMessages.IV_0008, offset);
+        this._offset = offset;
+    }
+    /**
+     * @returns The offset property of the SearchWidgetItem.
+     */
+    get offset() {
+        return this._offset;
+    }
+    /**
+     * Sets the offset value to undefined
+     */
+    resetOffset() {
+        this._offset = 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
+     */
+    set suggestion(suggestion) {
+        this._validateSuggestion(suggestion);
+        this._suggestion = suggestion;
+    }
+    /**
+     * @returns The suggestion property of the SearchWidgetItem.
+     */
+    get suggestion() {
+        return this._suggestion;
+    }
+    /**
+     * Sets the suggestion property to undefined.
+     */
+    resetSuggestion() {
+        this._suggestion = undefined;
+    }
+    _suggestionToDTO() {
+        if (!this._suggestion)
+            return undefined;
+        return this._suggestion.map((item) => {
+            const { keyphraseFallback, ...rest } = item;
+            return { ...rest, keyphrase_fallback: keyphraseFallback };
+        });
+    }
+    /**
+     * Validates the suggestion property. Throws error if provided with incorrect values.
+     * @param suggestion - the <array> of objects for the suggestion param
+     */
+    _validateSuggestion(suggestion) {
+        suggestion?.forEach((suggestionItem) => {
+            this._validateNumberInRange1To100(consts_1.ErrorMessages.IV_0014, suggestionItem.max);
+            this._validateNonEmptyNoWhitespaceString(consts_1.ErrorMessages.IV_0016, suggestionItem.name);
+        });
+    }
+    /**
+     * 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) {
+        this._validateSort(sort);
+        this._sort = sort;
+    }
+    /**
+     * @returns The sort property of the SearchWidgetItem.
+     */
+    get sort() {
+        return this._sort;
+    }
+    /**
+     * Sets the sort data to undefined
+     */
+    resetSort() {
+        this._sort = undefined;
+    }
+    /**
+     * Validates the sort field. Throws an error if incorrect values are provided.
+     */
+    _validateSort(sort) {
+        sort?.value?.forEach((sortValueItem) => {
+            this._validateNonEmptyString(consts_1.ErrorMessages.IV_0026, sortValueItem.name);
+        });
+    }
+    /**
+     * Validates the facet type fields. Throws an errors if incorrect values are provided.
+     */
+    _validateFacetTypes(types) {
+        if (!types)
+            return;
+        types.forEach((type) => {
+            if (!type.name || type.name.includes(' '))
+                throw new Error(consts_1.ErrorMessages.IV_0016);
+            this._validateStringLengthInRange1To100(consts_1.ErrorMessages.IV_0018, type.keyphrase);
+            this._validateNumberInRange1To100(consts_1.ErrorMessages.IV_0017, type.max);
+            this._validateNumberInRange1To100(consts_1.ErrorMessages.IV_0019, type.minCount);
+            if (typeof type.sort === 'object' && typeof type.sort.after === 'string') {
+                this._validateNonEmptyNoWhitespaceString(consts_1.ErrorMessages.IV_0020, type.sort.after);
+                if (type.sort.name !== 'text')
+                    throw new Error(consts_1.ErrorMessages.IV_0021);
+            }
+        });
+    }
+    _filterToDTO(type) {
+        if (!type.filter)
+            return undefined;
+        if (!(0, utils_1.isFacetFilter)(type.filter.values))
+            return type.filter;
+        return { type: type.filter.type, values: type.filter.values.map((filter) => filter.toDTO()) };
+    }
+    /**
+     * Builds the sort piece of the DTO.
+     */
+    _facetSortToDTO(type) {
+        if (type.sort)
+            return {
+                after: type.sort.after,
+                sort: { name: type.sort.name, order: type.sort.order }
+            };
+        return {};
+    }
+    /**
+     * Builds the filtering options array.
+     */
+    _filteringOptionsToDTO(filteringOptions) {
+        if (!filteringOptions)
+            return undefined;
+        if (filteringOptions === 'Dynamic AND')
+            return ['hard_filters', 'other_facet_values', 'own_values'];
+        if (filteringOptions === 'Dynamic OR')
+            return ['hard_filters', 'other_facet_values'];
+        return ['hard_filters'];
+    }
+    /**
+     * Maps the search widget item to its DTO format.
+     */
+    toDTO() {
+        const baseDTO = super.toDTO();
+        const resultsDTO = this._resultsToDTO();
+        const facet = {
+            all: this._facet?.all,
+            coverage: this._facet?.coverage,
+            max: this._facet?.max,
+            sort: this._facet?.sort
+        };
+        if (this._facet?.types)
+            facet.types = this._facet.types.map((type) => ({
+                exclude: type.exclude,
+                filter: this._filterToDTO(type),
+                filtering_options: this._filteringOptionsToDTO(type.filteringOptions),
+                keyphrase: type.keyphrase,
+                max: type.max,
+                min_count: type.minCount,
+                name: type.name,
+                ...this._facetSortToDTO(type)
+            }));
+        const search = {
+            ...{ offset: this._offset },
+            ...(this._query && { query: this._query }),
+            ...(Object.values(facet).filter((value) => value !== undefined).length && { facet }),
+            ...{ personalization: this._personalizationToDTO() },
+            ...{ ranking: this._ranking },
+            ...{ suggestion: this._suggestionToDTO() },
+            ...{ sort: this._sort },
+            ...resultsDTO
+        };
+        const dto = {
+            ...baseDTO,
+            search: Object.values(search).filter((value) => value !== undefined).length ? search : undefined
+        };
+        return dto;
+    }
+}
+exports.SearchWidgetItem = SearchWidgetItem;

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

@@ -0,0 +1,8 @@
+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.
+ * @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/cjs/src/lib/request-entities/widgets/utils.js

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isFacetFilter = void 0;
+/**
+ * Checks if the provided filters are facet filters.
+ * @param filters - The filters to check.
+ * @returns True if the filters are facet filters, false otherwise.
+ */
+function isFacetFilter(filters) {
+    if (typeof filters[0] === 'string')
+        return false;
+    return true;
+}
+exports.isFacetFilter = isFacetFilter;

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

@@ -0,0 +1,64 @@
+import { ErrorMessages } from '../../consts';
+import type { WidgetItemDTO } from './interfaces';
+export declare class WidgetItem {
+    protected _entity: string;
+    protected _widgetId: string;
+    /**
+     * Creates and holds the functionality of a widget item.
+     * @param entity - The widget's item entity.
+     * @param widgetId - The widget's item id.
+     *
+     */
+    constructor(entity: string, widgetId: string);
+    /**
+     * Sets the entity for the WidgetItem.
+     * This method updates the `entity` property of WidgetItem instance.
+     *
+     * @param entity - The entity to set.
+     */
+    set entity(entity: string);
+    /**
+     * @returns The entity property of the WidgetItem.
+     */
+    get entity(): string;
+    private _validateEntity;
+    /**
+     * Sets the id for the WidgetItem.
+     * This method updates the `widgetId` property of WidgetItem instance.
+     *
+     * @param widgetId - The entity to set.
+     */
+    set widgetId(widgetId: string);
+    /**
+     * @returns The id property of the WidgetItem.
+     */
+    get widgetId(): string;
+    private _validateWidgetId;
+    protected _validateNumberInRange1To100(errorMessage: ErrorMessages, num?: number): void;
+    /**
+     *
+     * @param errorMessage - The error message
+     * @param range - min and max range
+     * @param num - number to test
+     * @returns void
+     */
+    protected _validateNumberInRange(errorMessage: ErrorMessages, range: {
+        min: number;
+        max: number;
+    }, num?: number): void;
+    protected _validateStringLengthInRange1To100(errorMessage: ErrorMessages, str?: string): void;
+    protected _validatePositiveInteger(error: ErrorMessages, num?: number): void;
+    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 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.
+     */
+    toDTO(): WidgetItemDTO;
+}

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

@@ -0,0 +1,114 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.WidgetItem = void 0;
+// © Sitecore Corporation A/S. All rights reserved. Sitecore® is a registered trademark of Sitecore Corporation A/S.
+const consts_1 = require("../../consts");
+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.
+     *
+     */
+    constructor(entity, widgetId) {
+        this._validateWidgetId(widgetId);
+        this._validateEntity(entity);
+        this._entity = entity;
+        this._widgetId = widgetId;
+    }
+    /**
+     * Sets the entity for the WidgetItem.
+     * This method updates the `entity` property of WidgetItem instance.
+     *
+     * @param entity - The entity to set.
+     */
+    set entity(entity) {
+        this._validateEntity(entity);
+        this._entity = entity;
+    }
+    /**
+     * @returns The entity property of the WidgetItem.
+     */
+    get entity() {
+        return this._entity;
+    }
+    _validateEntity(entity) {
+        if (!entity || entity.trim().length === 0)
+            throw new Error(consts_1.ErrorMessages.MV_0010);
+    }
+    /**
+     * Sets the id for the WidgetItem.
+     * This method updates the `widgetId` property of WidgetItem instance.
+     *
+     * @param widgetId - The entity to set.
+     */
+    set widgetId(widgetId) {
+        this._validateWidgetId(widgetId);
+        this._widgetId = widgetId;
+    }
+    /**
+     * @returns The id property of the WidgetItem.
+     */
+    get widgetId() {
+        return this._widgetId;
+    }
+    _validateWidgetId(widgetId) {
+        if (!widgetId || widgetId.trim().length === 0)
+            throw new Error(consts_1.ErrorMessages.MV_0011);
+    }
+    _validateNumberInRange1To100(errorMessage, num) {
+        if (num === undefined || (num >= 1 && num <= 100))
+            return;
+        throw new Error(errorMessage);
+    }
+    /**
+     *
+     * @param errorMessage - The error message
+     * @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))
+            return;
+        throw new Error(errorMessage);
+    }
+    _validateStringLengthInRange1To100(errorMessage, str) {
+        if (str === undefined || (str.trim().length >= 1 && str.length <= 100))
+            return;
+        throw new Error(errorMessage);
+    }
+    _validatePositiveInteger(error, num) {
+        if (num === undefined || num >= 0)
+            return;
+        throw new Error(error);
+    }
+    _validateNonEmptyString(errorMessage, str) {
+        if (str === undefined || str.trim().length >= 1)
+            return;
+        throw new Error(errorMessage);
+    }
+    /**
+     * Tests if passed string is defined, is not empty string and does not contain whitespaces.
+     * @param errorMessage - Error Message
+     * @param string - the string to test
+     * @returns void
+     * @throws Error when failed
+     */
+    _validateNonEmptyNoWhitespaceString(errorMessage, string) {
+        if (string && !string.includes(' '))
+            return;
+        throw new Error(errorMessage);
+    }
+    /**
+     * Maps the widget item to its DTO format.
+     */
+    toDTO() {
+        return {
+            entity: this._entity,
+            // eslint-disable-next-line @typescript-eslint/naming-convention
+            rfk_id: this._widgetId
+        };
+    }
+}
+exports.WidgetItem = WidgetItem;

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

@@ -0,0 +1,15 @@
+import type { WidgetDTO } from './interfaces';
+import type { WidgetItem } from './widget-item';
+export declare class WidgetRequestData {
+    private _widgetItems;
+    /**
+     * Creates and holds the functionality of the widget request data.
+     * @param widgetItems - Array of {@link WidgetItem} instances.
+     */
+    constructor(widgetItems: WidgetItem[]);
+    private _validateWidgetItems;
+    /**
+     * Maps the widget items to their DTO format.
+     */
+    toDTO(): WidgetDTO;
+}

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

@@ -0,0 +1,30 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.WidgetRequestData = void 0;
+// © Sitecore Corporation A/S. All rights reserved. Sitecore® is a registered trademark of Sitecore Corporation A/S.
+const consts_1 = require("../../consts");
+class WidgetRequestData {
+    /**
+     * Creates and holds the functionality of the widget request data.
+     * @param widgetItems - Array of {@link WidgetItem} instances.
+     */
+    constructor(widgetItems) {
+        this._validateWidgetItems(widgetItems);
+        this._widgetItems = widgetItems;
+    }
+    _validateWidgetItems(widgetItems) {
+        if (widgetItems.length === 0)
+            throw new Error(consts_1.ErrorMessages.MV_0012);
+    }
+    /**
+     * Maps the widget items to their DTO format.
+     */
+    toDTO() {
+        return {
+            widget: {
+                items: this._widgetItems.map((widgetItem) => widgetItem.toDTO())
+            }
+        };
+    }
+}
+exports.WidgetRequestData = WidgetRequestData;

package/dist/cjs/src/lib/requests/browser/entity-view-event.d.ts

@@ -0,0 +1,6 @@
+import type { EntityViewEventParams } from '../../events/interfaces';
+/**
+ * This function sends an entity view event from browser.
+ * @param entityViewEventParams - An object containing conversion event params from {@link EntityViewEventParams}
+ */
+export declare function entityView(entityViewEventParams: EntityViewEventParams): Promise<import("@sitecore-cloudsdk/core/internal").EPResponse | null>;

package/dist/cjs/src/lib/requests/browser/entity-view-event.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.entityView = void 0;
+// © Sitecore Corporation A/S. All rights reserved. Sitecore® is a registered trademark of Sitecore Corporation A/S.
+const browser_1 = require("@sitecore-cloudsdk/events/browser");
+const entity_view_event_1 = require("../../events/entity-view-event");
+const initializer_1 = require("../../initializer/browser/initializer");
+/**
+ * This function sends an entity view event from browser.
+ * @param entityViewEventParams - An object containing conversion event params from {@link EntityViewEventParams}
+ */
+async function entityView(entityViewEventParams) {
+    await (0, initializer_1.awaitInit)();
+    const conversionEventDTO = new entity_view_event_1.EntityViewEvent(entityViewEventParams).toDTO();
+    return await (0, browser_1.event)(conversionEventDTO);
+}
+exports.entityView = entityView;

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

@@ -0,0 +1,15 @@
+import { Context } from '../../request-entities/context/context';
+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.
+ */
+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.
+ */
+export declare function getPageWidgetData(context: Context): Promise<SearchEndpointResponse | null>;

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

@@ -0,0 +1,25 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getPageWidgetData = void 0;
+// © Sitecore Corporation A/S. All rights reserved. Sitecore® is a registered trademark of Sitecore Corporation A/S.
+const internal_1 = require("@sitecore-cloudsdk/core/internal");
+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");
+async function getPageWidgetData(param) {
+    await (0, initializer_1.awaitInit)();
+    const settings = (0, internal_1.getCloudSDKSettingsBrowser)();
+    let context;
+    if (param instanceof context_1.Context) {
+        if (!param.page)
+            throw new Error(consts_1.ErrorMessages.MV_0006);
+        context = param;
+    }
+    else
+        context = new context_1.Context({ page: { uri: param } });
+    const contextRequestBody = context.toDTO();
+    const body = JSON.stringify({ ...contextRequestBody });
+    return await (0, post_request_1.sendPostRequest)(body, settings);
+}
+exports.getPageWidgetData = getPageWidgetData;

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

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