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

package/dist/cjs/package.json

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

package/dist/cjs/src/lib/consts.d.ts

@@ -1,5 +1,6 @@
 export declare const PACKAGE_NAME: string;
 export declare const SEARCH_NAMESPACE = "sitecore-cloudsdk:search";
+export declare const PACKAGE_VERSION: string;
 export declare enum ErrorMessages {
     IE_0001 = "[IE-0001] You are trying to run a browser-side function on the server side. On the server side, run the server-side equivalent of the function, available in \"server\" modules.",
     IE_0018 = "[IE-0018] You must first initialize the Cloud SDK and the \"search\" package. First, import \"CloudSDK\" from \"@sitecore-cloudsdk/core/browser\", and import \"@sitecore-cloudsdk/search/browser\". Then, run \"CloudSDK().addEvents().addSearch().initialize()\".",

package/dist/cjs/src/lib/consts.js

@@ -3,11 +3,12 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ErrorMessages = exports.SEARCH_NAMESPACE = exports.PACKAGE_NAME = void 0;
+exports.ErrorMessages = exports.PACKAGE_VERSION = exports.SEARCH_NAMESPACE = exports.PACKAGE_NAME = void 0;
 // © Sitecore Corporation A/S. All rights reserved. Sitecore® is a registered trademark of Sitecore Corporation A/S.
 const package_json_1 = __importDefault(require("../../package.json"));
 exports.PACKAGE_NAME = package_json_1.default.name;
 exports.SEARCH_NAMESPACE = 'sitecore-cloudsdk:search';
+exports.PACKAGE_VERSION = package_json_1.default.version;
 /* eslint-disable max-len */
 var ErrorMessages;
 (function (ErrorMessages) {

package/dist/cjs/src/lib/events/base-widget-event.d.ts

@@ -0,0 +1,38 @@
+import type { NestedObject } from '@sitecore-cloudsdk/utils';
+import type { BaseSearchEventParams } from './interfaces';
+export declare abstract class BaseSearchEvent {
+    protected page?: string;
+    protected currency?: string;
+    protected language?: string;
+    protected channel?: string;
+    protected country?: string;
+    protected referrer?: string;
+    protected pathname: string;
+    constructor({ page, currency, language, channel, pathname, referrer, country }: BaseSearchEventParams);
+    /**
+     * @returns search context object in its DTO format.
+     */
+    protected _searchContextToDTO(): {
+        context: {
+            page: {
+                uri: string;
+                referrer?: string | undefined;
+                locale_language?: string | undefined;
+                locale_currency?: string | undefined;
+                locale_country?: string | undefined;
+            };
+        };
+    };
+    /**
+     * Validates currency and language codes.
+     * @param currency - three-letter currency code in the ISO 4217 format.
+     * @param language - two-letter language code in the ISO 639-1 format.
+     * @param country - two-letter country code in the ISO 639-1 format.
+     * @throws - {@link ErrorMessages.IV_0015} | {@link ErrorMessages.IV_0011} | {@link ErrorMessages.IV_0010}
+     */
+    private _validate;
+    /**
+     * Abstract method to be implemented by subclasses for specific DTO mappings.
+     */
+    abstract toDTO(): NestedObject;
+}

package/dist/cjs/src/lib/events/base-widget-event.js

@@ -0,0 +1,48 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BaseSearchEvent = void 0;
+const consts_1 = require("../consts");
+class BaseSearchEvent {
+    constructor({ page, currency, language, channel, pathname, referrer, country }) {
+        this._validate(currency, language, country);
+        this.page = page;
+        this.currency = currency;
+        this.language = language;
+        this.country = country;
+        this.channel = channel;
+        this.pathname = pathname;
+        this.referrer = referrer;
+    }
+    /**
+     * @returns search context object in its DTO format.
+     */
+    _searchContextToDTO() {
+        return {
+            context: {
+                page: {
+                    ...(this.country && { locale_country: this.country.toLowerCase() }),
+                    ...(this.currency && { locale_currency: this.currency.toLowerCase() }),
+                    ...(this.language && { locale_language: this.language.toLowerCase() }),
+                    ...(this.referrer && { referrer: this.referrer }),
+                    uri: this.pathname
+                }
+            }
+        };
+    }
+    /**
+     * Validates currency and language codes.
+     * @param currency - three-letter currency code in the ISO 4217 format.
+     * @param language - two-letter language code in the ISO 639-1 format.
+     * @param country - two-letter country code in the ISO 639-1 format.
+     * @throws - {@link ErrorMessages.IV_0015} | {@link ErrorMessages.IV_0011} | {@link ErrorMessages.IV_0010}
+     */
+    _validate(currency, language, country) {
+        if (currency !== undefined && currency.length !== 3)
+            throw new Error(consts_1.ErrorMessages.IV_0015);
+        if (country !== undefined && country.length !== 2)
+            throw new Error(consts_1.ErrorMessages.IV_0010);
+        if (language !== undefined && language.length !== 2)
+            throw new Error(consts_1.ErrorMessages.IV_0011);
+    }
+}
+exports.BaseSearchEvent = BaseSearchEvent;

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

@@ -1,17 +1,17 @@
 import type { NestedObject } from '@sitecore-cloudsdk/utils';
+import { BaseSearchEvent } from './base-widget-event';
 import type { EntityViewEventParams, SearchEventEntity } from './interfaces';
-export declare class EntityViewEvent {
-    protected page?: string;
-    protected currency?: string;
-    protected language?: string;
-    protected pathname: string;
+export declare class EntityViewEvent extends BaseSearchEvent {
     protected entity: SearchEventEntity;
     /**
      * Creates an entity view event.
-     * @param entityViewEventParams - An object with the entity view event params {@link EntityViewEventParams}
+     * @param entityViewEventParams - {@link EntityViewEventParams} An object with the entity view event params
+     */
+    constructor({ entity, ...rest }: EntityViewEventParams);
+    /**
+     *
+     * @returns - map of EntityViewEvent in its DTO format.
      */
-    constructor({ page, currency, language, pathname, entity }: EntityViewEventParams);
-    private _validate;
     toDTO(): {
         currency: string | undefined;
         language: string | undefined;

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

@@ -1,26 +1,20 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.EntityViewEvent = void 0;
-const consts_1 = require("../consts");
-class EntityViewEvent {
+const base_widget_event_1 = require("./base-widget-event");
+class EntityViewEvent extends base_widget_event_1.BaseSearchEvent {
     /**
      * Creates an entity view event.
-     * @param entityViewEventParams - An object with the entity view event params {@link EntityViewEventParams}
+     * @param entityViewEventParams - {@link EntityViewEventParams} An object with the entity view event params
      */
-    constructor({ page, currency, language, pathname, entity }) {
-        this._validate(currency, language);
-        this.page = page;
-        this.currency = currency;
-        this.language = language;
-        this.pathname = pathname;
+    constructor({ entity, ...rest }) {
+        super(rest);
         this.entity = entity;
     }
-    _validate(currency, language) {
-        if (currency !== undefined && currency.length !== 3)
-            throw new Error(consts_1.ErrorMessages.IV_0015);
-        if (language !== undefined && language.length !== 2)
-            throw new Error(consts_1.ErrorMessages.IV_0011);
-    }
+    /**
+     *
+     * @returns - map of EntityViewEvent in its DTO format.
+     */
     toDTO() {
         const eventEntityDTO = {
             attributes: this.entity.attributes,
@@ -36,11 +30,7 @@ class EntityViewEvent {
             page: this.page,
             searchData: {
                 value: {
-                    context: {
-                        page: {
-                            uri: this.pathname
-                        }
-                    },
+                    ...this._searchContextToDTO(),
                     entities: [eventEntityDTO]
                 }
             },

package/dist/cjs/src/lib/events/interfaces.d.ts

@@ -76,60 +76,40 @@ export interface RangeFacetFilterEventParamsDTO extends SuggestionFilterEventPar
     facet_position: 0;
 }
 export type EventFilter = SuggestionFilterEventParams | FacetFilterEventParams | RangeFacetFilterEventParams;
-export interface WidgetNavigationClickEventParams {
-    pathname: string;
+export interface BaseSearchEventParams {
     page?: string;
-    itemPosition: number;
     currency?: string;
     language?: string;
     channel?: string;
-    widgetId: string;
-}
-export interface WidgetItemClickEventParams {
-    request: SearchEventRequest;
-    entity: SearchEventEntity;
-    itemPosition: number;
+    country?: string;
+    referrer?: string;
     pathname: string;
-    widgetId: string;
-    page?: string;
-    currency?: string;
-    language?: string;
-    channel?: string;
 }
-export interface WidgetSuggestionClickEventParams {
+export interface WidgetViewEventParams extends BaseSearchEventParams {
     request: SearchEventRequest;
-    filters?: Array<SuggestionFilterEventParams>;
-    pathname: string;
+    entities: Array<SearchEventEntity>;
     widgetId: string;
-    page?: string;
-    currency?: string;
-    language?: string;
-    channel?: string;
 }
-export interface WidgetFacetClickEventParams {
+export interface EntityViewEventParams extends BaseSearchEventParams {
+    entity: SearchEventEntity;
+}
+export interface WidgetFacetClickEventParams extends BaseSearchEventParams {
     request: SearchEventRequest;
     filters: Array<FacetFilterEventParams | RangeFacetFilterEventParams>;
-    pathname: string;
     widgetId: string;
-    page?: string;
-    currency?: string;
-    language?: string;
-    channel?: string;
 }
-export interface WidgetViewEventParams {
+export interface WidgetItemClickEventParams extends BaseSearchEventParams {
     request: SearchEventRequest;
-    entities: Array<SearchEventEntity>;
-    pathname: string;
+    entity: SearchEventEntity;
+    itemPosition: number;
     widgetId: string;
-    page?: string;
-    currency?: string;
-    language?: string;
-    channel?: string;
 }
-export interface EntityViewEventParams {
-    page?: string;
-    currency?: string;
-    language?: string;
-    pathname: string;
-    entity: SearchEventEntity;
+export interface WidgetNavigationClickEventParams extends BaseSearchEventParams {
+    itemPosition: number;
+    widgetId: string;
+}
+export interface WidgetSuggestionClickEventParams extends BaseSearchEventParams {
+    request: SearchEventRequest;
+    filters?: Array<SuggestionFilterEventParams>;
+    widgetId: string;
 }

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

@@ -1,24 +1,33 @@
 import type { NestedObject } from '@sitecore-cloudsdk/utils';
+import { BaseSearchEvent } from './base-widget-event';
 import type { FacetFilterEventParams, RangeFacetFilterEventParams, SearchEventRequest, WidgetFacetClickEventParams } from './interfaces';
-export declare class WidgetFacetClickEvent {
+export declare class WidgetFacetClickEvent extends BaseSearchEvent {
     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;
+    constructor({ request, widgetId, filters, ...rest }: WidgetFacetClickEventParams);
+    /**
+     *
+     * @returns - {@link FacetFilterEventParamsDTO}[] | {@link RangeFacetFilterEventParamsDTO}[]
+     */
     private _mapFiltersToDTO;
+    /**
+     * @returns a search event request in DTO format {@link SearchEventRequestDTO}.
+     */
     private _mapRequestToDTO;
+    /**
+     * @param filter - {@link FacetFilterEventParams} | {@link RangeFacetFilterEventParams}
+     * @returns true if `filter` is {@link RangeFacetFilterEventParams}
+     */
     private _rangeFacetFilterTypeGuard;
+    /**
+     * @returns map of WidgetFacetClickEvent in its DTO format.
+     */
     toDTO(): {
         channel: string | undefined;
         currency: string | undefined;

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

@@ -1,30 +1,23 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.WidgetFacetClickEvent = void 0;
-const consts_1 = require("../consts");
-class WidgetFacetClickEvent {
+const base_widget_event_1 = require("./base-widget-event");
+class WidgetFacetClickEvent extends base_widget_event_1.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(consts_1.ErrorMessages.IV_0015);
-        if (language !== undefined && language.length !== 2)
-            throw new Error(consts_1.ErrorMessages.IV_0011);
-    }
+    /**
+     *
+     * @returns - {@link FacetFilterEventParamsDTO}[] | {@link RangeFacetFilterEventParamsDTO}[]
+     */
     _mapFiltersToDTO() {
         return this.filters.map((filter) => {
             if (this._rangeFacetFilterTypeGuard(filter))
@@ -48,6 +41,9 @@ class WidgetFacetClickEvent {
             };
         });
     }
+    /**
+     * @returns a search event request in DTO format {@link SearchEventRequestDTO}.
+     */
     _mapRequestToDTO() {
         return {
             advanced_query_text: this.request.advancedQueryText,
@@ -61,9 +57,16 @@ 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();
@@ -75,11 +78,7 @@ class WidgetFacetClickEvent {
             searchData: {
                 action_cause: 'filter',
                 value: {
-                    context: {
-                        page: {
-                            uri: this.pathname
-                        }
-                    },
+                    ...this._searchContextToDTO(),
                     filters: filtersDTO,
                     request: requestDTO,
                     rfk_id: this.widgetId

package/dist/cjs/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/cjs/src/lib/events/widget-item-click-event.js

@@ -1,31 +1,24 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.WidgetItemClickEvent = void 0;
-const consts_1 = require("../consts");
-class WidgetItemClickEvent {
+const base_widget_event_1 = require("./base-widget-event");
+class WidgetItemClickEvent extends base_widget_event_1.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(consts_1.ErrorMessages.IV_0015);
-        if (language !== undefined && language.length !== 2)
-            throw new Error(consts_1.ErrorMessages.IV_0011);
     }
+    /**
+     *
+     * @returns a map of WidgetItemClickEvent in its DTO format.
+     */
     toDTO() {
         const eventRequestDTO = {
             advanced_query_text: this.request.advancedQueryText,
@@ -54,11 +47,7 @@ class WidgetItemClickEvent {
             searchData: {
                 action_cause: 'entity',
                 value: {
-                    context: {
-                        page: {
-                            uri: this.pathname
-                        }
-                    },
+                    ...this._searchContextToDTO(),
                     entities: [eventEntityDTO],
                     index: this.itemPosition,
                     request: eventRequestDTO,

package/dist/cjs/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/cjs/src/lib/events/widget-navigation-click-event.js

@@ -1,29 +1,22 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.WidgetNavigationClickEvent = void 0;
-const consts_1 = require("../consts");
-class WidgetNavigationClickEvent {
+const base_widget_event_1 = require("./base-widget-event");
+class WidgetNavigationClickEvent extends base_widget_event_1.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(consts_1.ErrorMessages.IV_0015);
-        if (language !== undefined && language.length !== 2)
-            throw new Error(consts_1.ErrorMessages.IV_0011);
     }
+    /**
+     *
+     * @returns map of WidgetNavigationClickEvent in its DTO format.
+     */
     toDTO() {
         return {
             channel: this.channel,
@@ -33,11 +26,7 @@ class WidgetNavigationClickEvent {
             searchData: {
                 action_cause: 'navigation',
                 value: {
-                    context: {
-                        page: {
-                            uri: this.pathname
-                        }
-                    },
+                    ...this._searchContextToDTO(),
                     index: this.itemPosition,
                     rfk_id: this.widgetIdentifier
                 }

package/dist/cjs/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;