@sitecore-cloudsdk/search 0.5.0-rc.0

package/dist/esm/src/lib/events/widget-facet-click-event.d.ts

@@ -0,0 +1,30 @@
+import type { NestedObject } from '@sitecore-cloudsdk/utils';
+import type { FacetFilterEventParams, RangeFacetFilterEventParams, SearchEventRequest, WidgetFacetClickEventParams } from './interfaces';
+export declare class WidgetFacetClickEvent {
+    protected request: SearchEventRequest;
+    protected pathname: string;
+    protected widgetId: string;
+    protected page?: string;
+    protected currency?: string;
+    protected language?: string;
+    protected channel?: string;
+    protected filters: Array<FacetFilterEventParams | RangeFacetFilterEventParams>;
+    /**
+     * Creates a search widget facet click event.
+     * @param widgetFacetClickEventParams - An object with the widget facet click params
+     *   {@link WidgetFacetClickEventParams}
+     */
+    constructor({ request, pathname, widgetId, page, currency, language, channel, filters }: WidgetFacetClickEventParams);
+    private _validate;
+    private _mapFiltersToDTO;
+    private _mapRequestToDTO;
+    private _rangeFacetFilterTypeGuard;
+    toDTO(): {
+        channel: string | undefined;
+        currency: string | undefined;
+        language: string | undefined;
+        page: string | undefined;
+        searchData: NestedObject;
+        type: string;
+    };
+}

package/dist/esm/src/lib/events/widget-facet-click-event.js

@@ -0,0 +1,88 @@
+import { ErrorMessages } from '../consts';
+export class WidgetFacetClickEvent {
+    /**
+     * Creates a search widget facet click event.
+     * @param widgetFacetClickEventParams - An object with the widget facet click params
+     *   {@link WidgetFacetClickEventParams}
+     */
+    constructor({ request, pathname, widgetId, page, currency, language, channel, filters }) {
+        this._validate(currency, language);
+        this.request = request;
+        this.currency = currency;
+        this.language = language;
+        this.channel = channel;
+        this.filters = filters;
+        this.page = page;
+        this.pathname = pathname;
+        this.widgetId = widgetId;
+    }
+    _validate(currency, language) {
+        if (currency !== undefined && currency.length !== 3)
+            throw new Error(ErrorMessages.IV_0015);
+        if (language !== undefined && language.length !== 2)
+            throw new Error(ErrorMessages.IV_0011);
+    }
+    _mapFiltersToDTO() {
+        return this.filters.map((filter) => {
+            if (this._rangeFacetFilterTypeGuard(filter))
+                return {
+                    display_name: [filter.displayName],
+                    end_value: filter.endValue,
+                    facet_position: 0,
+                    name: filter.name,
+                    start_value: filter.startValue,
+                    title: filter.title,
+                    value: [filter.value],
+                    value_position: [filter.valuePosition]
+                };
+            return {
+                display_name: [filter.displayName],
+                facet_position: filter.facetPosition,
+                name: filter.name,
+                title: filter.title,
+                value: [filter.value],
+                value_position: [filter.valuePosition]
+            };
+        });
+    }
+    _mapRequestToDTO() {
+        return {
+            advanced_query_text: this.request.advancedQueryText,
+            keyword: this.request.keyword,
+            modified_keyword: this.request.modifiedKeyword,
+            num_requested: this.request.numRequested,
+            num_results: this.request.numResults,
+            page_number: this.request.pageNumber,
+            page_size: this.request.pageSize,
+            redirect_url: this.request.redirectUrl,
+            total_results: this.request.totalResults
+        };
+    }
+    _rangeFacetFilterTypeGuard(filter) {
+        return 'startValue' in filter;
+    }
+    toDTO() {
+        const filtersDTO = this._mapFiltersToDTO();
+        const requestDTO = this._mapRequestToDTO();
+        return {
+            channel: this.channel,
+            currency: this.currency,
+            language: this.language,
+            page: this.page,
+            searchData: {
+                action_cause: 'filter',
+                value: {
+                    context: {
+                        page: {
+                            uri: this.pathname
+                        }
+                    },
+                    filters: filtersDTO,
+                    request: requestDTO,
+                    rfk_id: this.widgetId
+                }
+            },
+            type: 'SC_SEARCH_WIDGET_CLICK'
+        };
+    }
+}

package/dist/esm/src/lib/events/widget-item-click-event.d.ts

@@ -0,0 +1,28 @@
+import type { NestedObject } from '@sitecore-cloudsdk/utils';
+import type { SearchEventEntity, SearchEventRequest, WidgetItemClickEventParams } from './interfaces';
+export declare class WidgetItemClickEvent {
+    protected request: SearchEventRequest;
+    protected entity: SearchEventEntity;
+    protected itemPosition: number;
+    protected pathname: string;
+    protected widgetId: string;
+    protected page?: string;
+    protected currency?: string;
+    protected language?: string;
+    protected channel?: string;
+    /**
+     * Creates a search widget item event.
+     * @param widgetItemClickEventParams - An object with the widget item click params
+     * {@link WidgetItemClickEventParams}
+     */
+    constructor({ request, entity, itemPosition, pathname, widgetId, page, currency, language, channel }: WidgetItemClickEventParams);
+    private _validate;
+    toDTO(): {
+        channel: string | undefined;
+        currency: string | undefined;
+        language: string | undefined;
+        page: string | undefined;
+        searchData: NestedObject;
+        type: string;
+    };
+}

package/dist/esm/src/lib/events/widget-item-click-event.js

@@ -0,0 +1,68 @@
+import { ErrorMessages } from '../consts';
+export class WidgetItemClickEvent {
+    /**
+     * Creates a search widget item event.
+     * @param widgetItemClickEventParams - An object with the widget item click params
+     * {@link WidgetItemClickEventParams}
+     */
+    constructor({ request, entity, itemPosition, pathname, widgetId, page, currency, language, channel }) {
+        this._validate(currency, language);
+        this.entity = entity;
+        this.itemPosition = itemPosition;
+        this.page = page;
+        this.request = request;
+        this.pathname = pathname;
+        this.widgetId = widgetId;
+        this.currency = currency;
+        this.language = language;
+        this.channel = channel;
+    }
+    _validate(currency, language) {
+        if (currency !== undefined && currency.length !== 3)
+            throw new Error(ErrorMessages.IV_0015);
+        if (language !== undefined && language.length !== 2)
+            throw new Error(ErrorMessages.IV_0011);
+    }
+    toDTO() {
+        const eventRequestDTO = {
+            advanced_query_text: this.request.advancedQueryText,
+            keyword: this.request.keyword,
+            modified_keyword: this.request.modifiedKeyword,
+            num_requested: this.request.numRequested,
+            num_results: this.request.numResults,
+            page_number: this.request.pageNumber,
+            page_size: this.request.pageSize,
+            redirect_url: this.request.redirectUrl,
+            total_results: this.request.totalResults
+        };
+        const eventEntityDTO = {
+            attributes: this.entity.attributes,
+            entity_subtype: this.entity.entityType,
+            entity_type: this.entity.entity,
+            id: this.entity.id,
+            source_id: this.entity.sourceId,
+            uri: this.entity.uri
+        };
+        return {
+            channel: this.channel,
+            currency: this.currency,
+            language: this.language,
+            page: this.page,
+            searchData: {
+                action_cause: 'entity',
+                value: {
+                    context: {
+                        page: {
+                            uri: this.pathname
+                        }
+                    },
+                    entities: [eventEntityDTO],
+                    index: this.itemPosition,
+                    request: eventRequestDTO,
+                    rfk_id: this.widgetId
+                }
+            },
+            type: 'SC_SEARCH_WIDGET_CLICK'
+        };
+    }
+}

package/dist/esm/src/lib/events/widget-navigation-click-event.d.ts

@@ -0,0 +1,26 @@
+import type { NestedObject } from '@sitecore-cloudsdk/utils';
+import type { WidgetNavigationClickEventParams } from './interfaces';
+export declare class WidgetNavigationClickEvent {
+    protected itemPosition: number;
+    protected pathname: string;
+    protected widgetIdentifier: string;
+    protected page?: string;
+    protected currency?: string;
+    protected language?: string;
+    protected channel?: string;
+    /**
+     * Creates a search widget navigation event.
+     * @param widgetNavigationClickEventParams - an object containing navigation click params
+     *   {@link WidgetNavigationClickEventParams}
+     */
+    constructor({ itemPosition, pathname, widgetId, page, currency, language, channel }: WidgetNavigationClickEventParams);
+    private _validate;
+    toDTO(): {
+        channel: string | undefined;
+        currency: string | undefined;
+        language: string | undefined;
+        page: string | undefined;
+        searchData: NestedObject;
+        type: string;
+    };
+}

package/dist/esm/src/lib/events/widget-navigation-click-event.js

@@ -0,0 +1,45 @@
+import { ErrorMessages } from '../consts';
+export class WidgetNavigationClickEvent {
+    /**
+     * Creates a search widget navigation event.
+     * @param widgetNavigationClickEventParams - an object containing navigation click params
+     *   {@link WidgetNavigationClickEventParams}
+     */
+    constructor({ itemPosition, pathname, widgetId, page, currency, language, channel }) {
+        this._validate(currency, language);
+        this.itemPosition = itemPosition;
+        this.page = page;
+        this.pathname = pathname;
+        this.widgetIdentifier = widgetId;
+        this.currency = currency;
+        this.language = language;
+        this.channel = channel;
+    }
+    _validate(currency, language) {
+        if (currency !== undefined && currency.length !== 3)
+            throw new Error(ErrorMessages.IV_0015);
+        if (language !== undefined && language.length !== 2)
+            throw new Error(ErrorMessages.IV_0011);
+    }
+    toDTO() {
+        return {
+            channel: this.channel,
+            currency: this.currency,
+            language: this.language,
+            page: this.page,
+            searchData: {
+                action_cause: 'navigation',
+                value: {
+                    context: {
+                        page: {
+                            uri: this.pathname
+                        }
+                    },
+                    index: this.itemPosition,
+                    rfk_id: this.widgetIdentifier
+                }
+            },
+            type: 'SC_SEARCH_WIDGET_NAVIGATION_CLICK'
+        };
+    }
+}

package/dist/esm/src/lib/events/widget-suggestion-click-event.d.ts

@@ -0,0 +1,29 @@
+import type { NestedObject } from '@sitecore-cloudsdk/utils';
+import type { SearchEventRequest, SuggestionFilterEventParams, WidgetSuggestionClickEventParams } from './interfaces';
+export declare class WidgetSuggestionClickEvent {
+    protected request: SearchEventRequest;
+    protected filters?: Array<SuggestionFilterEventParams>;
+    protected pathname: string;
+    protected page?: string;
+    protected widgetIdentifier: string;
+    protected currency?: string;
+    protected language?: string;
+    protected channel?: string;
+    /**
+     * Creates a widget suggestion click event.
+     * @param widgetSuggestionClickEventParams - An object with the widget suggestion click event params
+     *  {@link WidgetSuggestionClickEventParams}
+     */
+    constructor({ request, filters, pathname, page, widgetId, currency, language, channel }: WidgetSuggestionClickEventParams);
+    private _validate;
+    private _mapFiltersToDTO;
+    private _mapRequestToDTO;
+    toDTO(): {
+        channel: string | undefined;
+        currency: string | undefined;
+        language: string | undefined;
+        page: string | undefined;
+        searchData: NestedObject;
+        type: string;
+    };
+}

package/dist/esm/src/lib/events/widget-suggestion-click-event.js

@@ -0,0 +1,71 @@
+import { ErrorMessages } from '../consts';
+export class WidgetSuggestionClickEvent {
+    /**
+     * Creates a widget suggestion click event.
+     * @param widgetSuggestionClickEventParams - An object with the widget suggestion click event params
+     *  {@link WidgetSuggestionClickEventParams}
+     */
+    constructor({ request, filters, pathname, page, widgetId, currency, language, channel }) {
+        this._validate(currency, language);
+        this.request = request;
+        this.filters = filters;
+        this.pathname = pathname;
+        this.page = page;
+        this.widgetIdentifier = widgetId;
+        this.currency = currency;
+        this.language = language;
+        this.channel = channel;
+    }
+    _validate(currency, language) {
+        if (currency !== undefined && currency.length !== 3)
+            throw new Error(ErrorMessages.IV_0015);
+        if (language !== undefined && language.length !== 2)
+            throw new Error(ErrorMessages.IV_0011);
+    }
+    _mapFiltersToDTO() {
+        return this.filters?.map((filter) => ({
+            display_name: [filter.displayName],
+            name: filter.name,
+            title: filter.title,
+            value: [filter.value],
+            value_position: [filter.valuePosition]
+        }));
+    }
+    _mapRequestToDTO() {
+        return {
+            advanced_query_text: this.request.advancedQueryText,
+            keyword: this.request.keyword,
+            modified_keyword: this.request.modifiedKeyword,
+            num_requested: this.request.numRequested,
+            num_results: this.request.numResults,
+            page_number: this.request.pageNumber,
+            page_size: this.request.pageSize,
+            redirect_url: this.request.redirectUrl,
+            total_results: this.request.totalResults
+        };
+    }
+    toDTO() {
+        const filtersDTO = this._mapFiltersToDTO();
+        const requestDTO = this._mapRequestToDTO();
+        return {
+            channel: this.channel,
+            currency: this.currency,
+            language: this.language,
+            page: this.page,
+            searchData: {
+                action_cause: 'suggestion',
+                value: {
+                    context: {
+                        page: {
+                            uri: this.pathname
+                        }
+                    },
+                    filters: filtersDTO,
+                    request: requestDTO,
+                    rfk_id: this.widgetIdentifier
+                }
+            },
+            type: 'SC_SEARCH_WIDGET_CLICK'
+        };
+    }
+}

package/dist/esm/src/lib/events/widget-view-event.d.ts

@@ -0,0 +1,28 @@
+import type { NestedObject } from '@sitecore-cloudsdk/utils';
+import type { SearchEventEntity, SearchEventRequest, WidgetViewEventParams } from './interfaces';
+export declare class WidgetViewEvent {
+    protected request: SearchEventRequest;
+    protected entities: SearchEventEntity[];
+    protected pathname: string;
+    protected widgetIdentifier: string;
+    protected page?: string;
+    protected currency?: string;
+    protected language?: string;
+    protected channel?: string;
+    /**
+     * Creates a search widget view event.
+     * @param widgetViewEventParams - An object with the widget view events params {@link WidgetViewEventParams}
+     */
+    constructor({ request, entities, pathname, widgetId, page, currency, language, channel }: WidgetViewEventParams);
+    private _validate;
+    private _mapEntitiesToDTO;
+    private _mapRequestToDTO;
+    toDTO(): {
+        channel: string | undefined;
+        currency: string | undefined;
+        language: string | undefined;
+        page: string | undefined;
+        searchData: NestedObject;
+        type: string;
+    };
+}

package/dist/esm/src/lib/events/widget-view-event.js

@@ -0,0 +1,71 @@
+import { ErrorMessages } from '../consts';
+export class WidgetViewEvent {
+    /**
+     * Creates a search widget view event.
+     * @param widgetViewEventParams - An object with the widget view events params {@link WidgetViewEventParams}
+     */
+    constructor({ request, entities, pathname, widgetId, page, currency, language, channel }) {
+        this._validate(currency, language);
+        this.entities = entities;
+        this.page = page;
+        this.request = request;
+        this.pathname = pathname;
+        this.widgetIdentifier = widgetId;
+        this.currency = currency;
+        this.language = language;
+        this.channel = channel;
+    }
+    _validate(currency, language) {
+        if (currency !== undefined && currency.length !== 3)
+            throw new Error(ErrorMessages.IV_0015);
+        if (language !== undefined && language.length !== 2)
+            throw new Error(ErrorMessages.IV_0011);
+    }
+    _mapEntitiesToDTO() {
+        return this.entities.map((entity) => ({
+            attributes: entity.attributes,
+            entity_subtype: entity.entityType,
+            entity_type: entity.entity,
+            id: entity.id,
+            source_id: entity.sourceId,
+            uri: entity.uri
+        }));
+    }
+    _mapRequestToDTO() {
+        return {
+            advanced_query_text: this.request.advancedQueryText,
+            keyword: this.request.keyword,
+            modified_keyword: this.request.modifiedKeyword,
+            num_requested: this.request.numRequested,
+            num_results: this.request.numResults,
+            page_number: this.request.pageNumber,
+            page_size: this.request.pageSize,
+            redirect_url: this.request.redirectUrl,
+            total_results: this.request.totalResults
+        };
+    }
+    toDTO() {
+        const entitiesDTO = this._mapEntitiesToDTO();
+        const requestDTO = this._mapRequestToDTO();
+        return {
+            channel: this.channel,
+            currency: this.currency,
+            language: this.language,
+            page: this.page,
+            searchData: {
+                action_cause: 'entity',
+                value: {
+                    context: {
+                        page: {
+                            uri: this.pathname
+                        }
+                    },
+                    entities: entitiesDTO,
+                    request: requestDTO,
+                    rfk_id: this.widgetIdentifier
+                }
+            },
+            type: 'SC_SEARCH_WIDGET_VIEW'
+        };
+    }
+}

package/dist/esm/src/lib/initializer/browser/initializer.d.ts

@@ -0,0 +1,23 @@
+import { CloudSDKBrowserInitializer } from '@sitecore-cloudsdk/core/browser';
+export declare function sideEffects(): Promise<void>;
+/**
+ * Makes the functionality of the search package available.
+ *  This functionality also requires the events package.
+ *
+ * @returns An instance of {@link CloudSDKBrowserInitializer}
+ *
+ * @example
+ * ```
+ * CloudSDK().addEvents().addSearch().initialize()
+ * ```
+ */
+export declare function addSearch(this: CloudSDKBrowserInitializer): CloudSDKBrowserInitializer;
+declare module '@sitecore-cloudsdk/core/browser' {
+    interface CloudSDKBrowserInitializer {
+        addSearch: typeof addSearch;
+    }
+}
+/**
+ * A function that handles the async browser init logic. Throws an error or awaits the promise.
+ */
+export declare function awaitInit(): Promise<void>;

package/dist/esm/src/lib/initializer/browser/initializer.js

@@ -0,0 +1,38 @@
+// © Sitecore Corporation A/S. All rights reserved. Sitecore® is a registered trademark of Sitecore Corporation A/S.
+import { CloudSDKBrowserInitializer } from '@sitecore-cloudsdk/core/browser';
+import { debug, enabledPackagesBrowser as enabledPackages, getEnabledPackageBrowser as getEnabledPackage, PackageInitializer } from '@sitecore-cloudsdk/core/internal';
+import { PACKAGE_NAME as EVENTS_PACKAGE_NAME, PACKAGE_INITIALIZER_METHOD_NAME } from '@sitecore-cloudsdk/events/browser';
+import { ErrorMessages, PACKAGE_NAME, SEARCH_NAMESPACE } from '../../consts';
+// eslint-disable-next-line no-empty-function, @typescript-eslint/no-empty-function
+export async function sideEffects() {
+    debug(SEARCH_NAMESPACE)('searchClient library initialized');
+}
+/**
+ * Makes the functionality of the search package available.
+ *  This functionality also requires the events package.
+ *
+ * @returns An instance of {@link CloudSDKBrowserInitializer}
+ *
+ * @example
+ * ```
+ * CloudSDK().addEvents().addSearch().initialize()
+ * ```
+ */
+export function addSearch() {
+    const searchInitializer = new PackageInitializer({
+        dependencies: [{ method: PACKAGE_INITIALIZER_METHOD_NAME, name: EVENTS_PACKAGE_NAME }],
+        sideEffects
+    });
+    enabledPackages.set(PACKAGE_NAME, searchInitializer);
+    return this;
+}
+CloudSDKBrowserInitializer.prototype.addSearch = addSearch;
+/**
+ * A function that handles the async browser init logic. Throws an error or awaits the promise.
+ */
+export async function awaitInit() {
+    const initState = getEnabledPackage(PACKAGE_NAME)?.initState;
+    if (!initState)
+        throw new Error(ErrorMessages.IE_0018);
+    await initState;
+}

package/dist/esm/src/lib/initializer/server/initializer.d.ts

@@ -0,0 +1,21 @@
+import { CloudSDKServerInitializer } from '@sitecore-cloudsdk/core/server';
+export declare function sideEffects(): Promise<void>;
+/**
+ * Makes the functionality of the search package available.
+ *  This functionality also requires the events package.
+ *
+ * @param settings - The optional settings to initialize the search
+ * @returns An instance of {@link CloudSDKServerInitializer}
+ *
+ * @example
+ * ```
+ * CloudSDK().addEvents().addSearch().initialize()
+ * ```
+ */
+export declare function addSearch(this: CloudSDKServerInitializer): CloudSDKServerInitializer;
+declare module '@sitecore-cloudsdk/core/server' {
+    interface CloudSDKServerInitializer {
+        addSearch: typeof addSearch;
+    }
+}
+export declare function verifySearchPackageExistence(): void;

package/dist/esm/src/lib/initializer/server/initializer.js

@@ -0,0 +1,33 @@
+// © Sitecore Corporation A/S. All rights reserved. Sitecore® is a registered trademark of Sitecore Corporation A/S.
+import { debug, enabledPackagesServer as enabledPackages, getEnabledPackageServer as getEnabledPackage, PackageInitializerServer } from '@sitecore-cloudsdk/core/internal';
+import { CloudSDKServerInitializer } from '@sitecore-cloudsdk/core/server';
+import { PACKAGE_NAME as EVENTS_PACKAGE_NAME, PACKAGE_INITIALIZER_METHOD_NAME } from '@sitecore-cloudsdk/events/server';
+import { ErrorMessages, PACKAGE_NAME, SEARCH_NAMESPACE } from '../../consts';
+export async function sideEffects() {
+    debug(SEARCH_NAMESPACE)('searchServer library initialized');
+}
+/**
+ * Makes the functionality of the search package available.
+ *  This functionality also requires the events package.
+ *
+ * @param settings - The optional settings to initialize the search
+ * @returns An instance of {@link CloudSDKServerInitializer}
+ *
+ * @example
+ * ```
+ * CloudSDK().addEvents().addSearch().initialize()
+ * ```
+ */
+export function addSearch() {
+    const searchInitializer = new PackageInitializerServer({
+        dependencies: [{ method: PACKAGE_INITIALIZER_METHOD_NAME, name: EVENTS_PACKAGE_NAME }],
+        sideEffects
+    });
+    enabledPackages.set(PACKAGE_NAME, searchInitializer);
+    return this;
+}
+CloudSDKServerInitializer.prototype.addSearch = addSearch;
+export function verifySearchPackageExistence() {
+    if (!getEnabledPackage(PACKAGE_NAME))
+        throw Error(ErrorMessages.IE_0019);
+}