@sitecore-cloudsdk/search 0.5.0 → 0.5.1

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

@@ -1,27 +1,20 @@
-import { ErrorMessages } from '../consts';
-export class WidgetFacetClickEvent {
+import { BaseSearchEvent } from './base-widget-event';
+export class WidgetFacetClickEvent extends BaseSearchEvent {
     /**
      * 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);
+    constructor({ request, widgetId, filters, ...rest }) {
+        super(rest);
         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);
-    }
+    /**
+     *
+     * @returns - {@link FacetFilterEventParamsDTO}[] | {@link RangeFacetFilterEventParamsDTO}[]
+     */
     _mapFiltersToDTO() {
         return this.filters.map((filter) => {
             if (this._rangeFacetFilterTypeGuard(filter))
@@ -45,6 +38,9 @@ export class WidgetFacetClickEvent {
             };
         });
     }
+    /**
+     * @returns a search event request in DTO format {@link SearchEventRequestDTO}.
+     */
     _mapRequestToDTO() {
         return {
             advanced_query_text: this.request.advancedQueryText,
@@ -58,9 +54,16 @@ export class WidgetFacetClickEvent {
             total_results: this.request.totalResults
         };
     }
+    /**
+     * @param filter - {@link FacetFilterEventParams} | {@link RangeFacetFilterEventParams}
+     * @returns true if `filter` is {@link RangeFacetFilterEventParams}
+     */
     _rangeFacetFilterTypeGuard(filter) {
         return 'startValue' in filter;
     }
+    /**
+     * @returns map of WidgetFacetClickEvent in its DTO format.
+     */
     toDTO() {
         const filtersDTO = this._mapFiltersToDTO();
         const requestDTO = this._mapRequestToDTO();
@@ -72,11 +75,7 @@ export class WidgetFacetClickEvent {
             searchData: {
                 action_cause: 'filter',
                 value: {
-                    context: {
-                        page: {
-                            uri: this.pathname
-                        }
-                    },
+                    ...this._searchContextToDTO(),
                     filters: filtersDTO,
                     request: requestDTO,
                     rfk_id: this.widgetId

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

@@ -1,22 +1,21 @@
 import type { NestedObject } from '@sitecore-cloudsdk/utils';
+import { BaseSearchEvent } from './base-widget-event';
 import type { SearchEventEntity, SearchEventRequest, WidgetItemClickEventParams } from './interfaces';
-export declare class WidgetItemClickEvent {
+export declare class WidgetItemClickEvent extends BaseSearchEvent {
     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;
+    constructor({ request, entity, itemPosition, widgetId, ...rest }: WidgetItemClickEventParams);
+    /**
+     *
+     * @returns a map of WidgetItemClickEvent in its DTO format.
+     */
     toDTO(): {
         channel: string | undefined;
         currency: string | undefined;

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

@@ -1,28 +1,21 @@
-import { ErrorMessages } from '../consts';
-export class WidgetItemClickEvent {
+import { BaseSearchEvent } from './base-widget-event';
+export class WidgetItemClickEvent extends BaseSearchEvent {
     /**
      * 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);
+    constructor({ request, entity, itemPosition, widgetId, ...rest }) {
+        super(rest);
         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);
     }
+    /**
+     *
+     * @returns a map of WidgetItemClickEvent in its DTO format.
+     */
     toDTO() {
         const eventRequestDTO = {
             advanced_query_text: this.request.advancedQueryText,
@@ -51,11 +44,7 @@ export class WidgetItemClickEvent {
             searchData: {
                 action_cause: 'entity',
                 value: {
-                    context: {
-                        page: {
-                            uri: this.pathname
-                        }
-                    },
+                    ...this._searchContextToDTO(),
                     entities: [eventEntityDTO],
                     index: this.itemPosition,
                     request: eventRequestDTO,

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

@@ -1,20 +1,19 @@
 import type { NestedObject } from '@sitecore-cloudsdk/utils';
+import { BaseSearchEvent } from './base-widget-event';
 import type { WidgetNavigationClickEventParams } from './interfaces';
-export declare class WidgetNavigationClickEvent {
+export declare class WidgetNavigationClickEvent extends BaseSearchEvent {
     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;
+    constructor({ itemPosition, widgetId, ...rest }: WidgetNavigationClickEventParams);
+    /**
+     *
+     * @returns map of WidgetNavigationClickEvent in its DTO format.
+     */
     toDTO(): {
         channel: string | undefined;
         currency: string | undefined;

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

@@ -1,26 +1,19 @@
-import { ErrorMessages } from '../consts';
-export class WidgetNavigationClickEvent {
+import { BaseSearchEvent } from './base-widget-event';
+export class WidgetNavigationClickEvent extends BaseSearchEvent {
     /**
      * 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);
+    constructor({ itemPosition, widgetId, ...rest }) {
+        super(rest);
         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);
     }
+    /**
+     *
+     * @returns map of WidgetNavigationClickEvent in its DTO format.
+     */
     toDTO() {
         return {
             channel: this.channel,
@@ -30,11 +23,7 @@ export class WidgetNavigationClickEvent {
             searchData: {
                 action_cause: 'navigation',
                 value: {
-                    context: {
-                        page: {
-                            uri: this.pathname
-                        }
-                    },
+                    ...this._searchContextToDTO(),
                     index: this.itemPosition,
                     rfk_id: this.widgetIdentifier
                 }

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

@@ -1,23 +1,30 @@
 import type { NestedObject } from '@sitecore-cloudsdk/utils';
+import { BaseSearchEvent } from './base-widget-event';
 import type { SearchEventRequest, SuggestionFilterEventParams, WidgetSuggestionClickEventParams } from './interfaces';
-export declare class WidgetSuggestionClickEvent {
+export declare class WidgetSuggestionClickEvent extends BaseSearchEvent {
     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;
+    constructor({ request, filters, widgetId, ...rest }: WidgetSuggestionClickEventParams);
+    /**
+     *
+     * @returns the filters property in its DTO format {@link SuggestionFilterEventParamsDTO}[].
+     */
     private _mapFiltersToDTO;
+    /**
+     *
+     * @returns the request property in its DTO format {@link SearchEventRequestDTO}.
+     */
     private _mapRequestToDTO;
+    /**
+     *
+     * @returns WidgetSuggestionClickEvent in its DTO format.
+     */
     toDTO(): {
         channel: string | undefined;
         currency: string | undefined;

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

@@ -1,27 +1,20 @@
-import { ErrorMessages } from '../consts';
-export class WidgetSuggestionClickEvent {
+import { BaseSearchEvent } from './base-widget-event';
+export class WidgetSuggestionClickEvent extends BaseSearchEvent {
     /**
      * 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);
+    constructor({ request, filters, widgetId, ...rest }) {
+        super(rest);
         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);
     }
+    /**
+     *
+     * @returns the filters property in its DTO format {@link SuggestionFilterEventParamsDTO}[].
+     */
     _mapFiltersToDTO() {
         return this.filters?.map((filter) => ({
             display_name: [filter.displayName],
@@ -31,6 +24,10 @@ export class WidgetSuggestionClickEvent {
             value_position: [filter.valuePosition]
         }));
     }
+    /**
+     *
+     * @returns the request property in its DTO format {@link SearchEventRequestDTO}.
+     */
     _mapRequestToDTO() {
         return {
             advanced_query_text: this.request.advancedQueryText,
@@ -44,6 +41,10 @@ export class WidgetSuggestionClickEvent {
             total_results: this.request.totalResults
         };
     }
+    /**
+     *
+     * @returns WidgetSuggestionClickEvent in its DTO format.
+     */
     toDTO() {
         const filtersDTO = this._mapFiltersToDTO();
         const requestDTO = this._mapRequestToDTO();
@@ -55,11 +56,7 @@ export class WidgetSuggestionClickEvent {
             searchData: {
                 action_cause: 'suggestion',
                 value: {
-                    context: {
-                        page: {
-                            uri: this.pathname
-                        }
-                    },
+                    ...this._searchContextToDTO(),
                     filters: filtersDTO,
                     request: requestDTO,
                     rfk_id: this.widgetIdentifier

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

@@ -1,22 +1,29 @@
 import type { NestedObject } from '@sitecore-cloudsdk/utils';
+import { BaseSearchEvent } from './base-widget-event';
 import type { SearchEventEntity, SearchEventRequest, WidgetViewEventParams } from './interfaces';
-export declare class WidgetViewEvent {
+export declare class WidgetViewEvent extends BaseSearchEvent {
     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;
+    constructor({ request, entities, widgetId, ...rest }: WidgetViewEventParams);
+    /**
+     *
+     * @returns the property entities in its DTO format {@link SearchEventEntityDTO}[].
+     */
     private _mapEntitiesToDTO;
+    /**
+     *
+     * @returns the request property in its DTO format {@link SearchEventRequestDTO}.
+     */
     private _mapRequestToDTO;
+    /**
+     *
+     * @returns the WidgetViewEvent in its DTO format.
+     */
     toDTO(): {
         channel: string | undefined;
         currency: string | undefined;

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

@@ -1,26 +1,19 @@
-import { ErrorMessages } from '../consts';
-export class WidgetViewEvent {
+import { BaseSearchEvent } from './base-widget-event';
+export class WidgetViewEvent extends BaseSearchEvent {
     /**
      * 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);
+    constructor({ request, entities, widgetId, ...rest }) {
+        super(rest);
         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);
     }
+    /**
+     *
+     * @returns the property entities in its DTO format {@link SearchEventEntityDTO}[].
+     */
     _mapEntitiesToDTO() {
         return this.entities.map((entity) => ({
             attributes: entity.attributes,
@@ -31,6 +24,10 @@ export class WidgetViewEvent {
             uri: entity.uri
         }));
     }
+    /**
+     *
+     * @returns the request property in its DTO format {@link SearchEventRequestDTO}.
+     */
     _mapRequestToDTO() {
         return {
             advanced_query_text: this.request.advancedQueryText,
@@ -44,6 +41,10 @@ export class WidgetViewEvent {
             total_results: this.request.totalResults
         };
     }
+    /**
+     *
+     * @returns the WidgetViewEvent in its DTO format.
+     */
     toDTO() {
         const entitiesDTO = this._mapEntitiesToDTO();
         const requestDTO = this._mapRequestToDTO();
@@ -55,11 +56,7 @@ export class WidgetViewEvent {
             searchData: {
                 action_cause: 'entity',
                 value: {
-                    context: {
-                        page: {
-                            uri: this.pathname
-                        }
-                    },
+                    ...this._searchContextToDTO(),
                     entities: entitiesDTO,
                     request: requestDTO,
                     rfk_id: this.widgetIdentifier

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

@@ -17,7 +17,13 @@ declare module '@sitecore-cloudsdk/core/browser' {
         addSearch: typeof addSearch;
     }
 }
+declare global {
+    interface Search {
+        version: string;
+    }
+}
 /**
  * A function that handles the async browser init logic. Throws an error or awaits the promise.
+ * @throws - {@link ErrorMessages.IE_0018}
  */
 export declare function awaitInit(): Promise<void>;

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

@@ -2,9 +2,15 @@
 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';
+import { ErrorMessages, PACKAGE_NAME, PACKAGE_VERSION, SEARCH_NAMESPACE } from '../../consts';
 // eslint-disable-next-line no-empty-function, @typescript-eslint/no-empty-function
 export async function sideEffects() {
+    window.scCloudSDK = {
+        ...window.scCloudSDK,
+        search: {
+            version: PACKAGE_VERSION
+        }
+    };
     debug(SEARCH_NAMESPACE)('searchClient library initialized');
 }
 /**
@@ -29,6 +35,7 @@ export function addSearch() {
 CloudSDKBrowserInitializer.prototype.addSearch = addSearch;
 /**
  * A function that handles the async browser init logic. Throws an error or awaits the promise.
+ * @throws - {@link ErrorMessages.IE_0018}
  */
 export async function awaitInit() {
     const initState = getEnabledPackage(PACKAGE_NAME)?.initState;

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

@@ -18,4 +18,8 @@ declare module '@sitecore-cloudsdk/core/server' {
         addSearch: typeof addSearch;
     }
 }
+/**
+ * verifies if the search packages exists.
+ * @throws - {@link ErrorMessages.IE_0019}
+ */
 export declare function verifySearchPackageExistence(): void;

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

@@ -27,6 +27,10 @@ export function addSearch() {
     return this;
 }
 CloudSDKServerInitializer.prototype.addSearch = addSearch;
+/**
+ * verifies if the search packages exists.
+ * @throws - {@link ErrorMessages.IE_0019}
+ */
 export function verifySearchPackageExistence() {
     if (!getEnabledPackage(PACKAGE_NAME))
         throw Error(ErrorMessages.IE_0019);

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

@@ -1,9 +1,4 @@
 import type { BrowserData, CampaignData, ContextData, ContextDTO, GeoData, LocaleData, PageData, StoreData, UserData } from './interfaces';
-/**
- * Create context object.
- * @param context - The context object.
- * @returns the validated and mapped context object
- */
 export declare class Context {
     private _campaign?;
     private _locale?;
@@ -13,18 +8,16 @@ export declare class Context {
     private _user?;
     private _browser?;
     /**
-     * @param context - The context object.
-     * @returns the validated and mapped context object
+     * @param context - {@link ContextData} The context object.
      */
     constructor(context: ContextData);
     /**
      * Sets the campaign data.
-     * @param campaign - The new value to set.
-     *
+     * @param campaign - {@link CampaignData} The new value to set.
      */
     set campaign(campaign: CampaignData);
     /**
-     * @returns The campaign data.
+     * @returns The campaign data {@link CampaignData}.
      */
     get campaign(): CampaignData | undefined;
     /**
@@ -33,12 +26,12 @@ export declare class Context {
     removeCampaign(): void;
     /**
      * Sets the locale data.
-     * @param locale - The new value to set.
+     * @param locale - The new value to set. {@link LocaleData}
      *
      */
     set locale(locale: LocaleData);
     /**
-     * @returns The locale data.
+     * @returns the locale data. {@link LocaleData}
      */
     get locale(): LocaleData | undefined;
     /**
@@ -47,12 +40,11 @@ export declare class Context {
     removeLocale(): void;
     /**
      * Sets the page data.
-     * @param page - The new value to set.
-     *
+     * @param page - The new value to set {@link PageData}.
      */
     set page(page: PageData);
     /**
-     * @returns The page data.
+     * @returns The page data {@link PageData}.
      */
     get page(): PageData | undefined;
     /**
@@ -61,6 +53,9 @@ export declare class Context {
     removePage(): void;
     /**
      * Validate context locale object.
+     *
+     * @param locale - the locale object {@link LocaleData}.
+     * @throws - {@link ErrorMessages.IV_0010} | {@link ErrorMessages.IV_0011}.
      */
     private _validateContextLocale;
     /**
@@ -70,7 +65,7 @@ export declare class Context {
      */
     set store(store: StoreData);
     /**
-     * @returns The store data.
+     * @returns The store data {@link StoreData}.
      */
     get store(): StoreData | undefined;
     /**
@@ -79,7 +74,7 @@ export declare class Context {
     removeStore(): void;
     /**
      * Sets the geo data.
-     * @param geo - The new value to set.
+     * @param geo - The new value to set {@link GeoData}.
      *
      */
     set geo(geo: GeoData);
@@ -93,15 +88,18 @@ export declare class Context {
     removeGeo(): void;
     /**
      * Validate location object.
+     *
+     * @param location - the location object {@link LocationData}.
+     * @throws - {@link ErrorMessages.IV_0012} | {@link ErrorMessages.IV_0013}.
      */
     private _validateLocation;
     /**
      * Sets the user data.
-     * @param user - The new value to set.
+     * @param user - The new value to set {@link UserData}.
      */
     set user(user: UserData | undefined);
     /**
-     * @returns The user data.
+     * @returns The user data {@link UserData}.
      */
     get user(): UserData | undefined;
     /** Simply removes the user data from the context */
@@ -109,7 +107,7 @@ export declare 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}.
      */
     private _validateUser;
     /**
@@ -117,7 +115,7 @@ export declare class Context {
      */
     set browser(browser: BrowserData);
     /**
-     * @returns The browser data.
+     * @returns The browser data {@link BrowserData}.
      */
     get browser(): BrowserData | undefined;
     /**
@@ -125,17 +123,19 @@ export declare class Context {
      */
     removeBrowser(): void;
     /**
-     * Validate context object.
+     * Validate context object {@link ContextData}.
+     * @throws - {@link ErrorMessages.MV_0009} | {@link ErrorMessages.IV_0012} | {@link ErrorMessages.IV_0013}
      */
     private _validateContext;
     /**
      * 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}.
      */
     private _validatePage;
     /**
      * Map context object to DTO.
-     * @returns The DTO representation of the filter.
+     * @returns The DTO representation of the filter {@link ContextDTO}.
      */
     toDTO(): ContextDTO;
 }