@sitecore-cloudsdk/search 0.5.0 → 0.5.1

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

@@ -1,30 +1,23 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.WidgetSuggestionClickEvent = void 0;
-const consts_1 = require("../consts");
-class WidgetSuggestionClickEvent {
+const base_widget_event_1 = require("./base-widget-event");
+class WidgetSuggestionClickEvent extends base_widget_event_1.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(consts_1.ErrorMessages.IV_0015);
-        if (language !== undefined && language.length !== 2)
-            throw new Error(consts_1.ErrorMessages.IV_0011);
     }
+    /**
+     *
+     * @returns the filters property in its DTO format {@link SuggestionFilterEventParamsDTO}[].
+     */
     _mapFiltersToDTO() {
         return this.filters?.map((filter) => ({
             display_name: [filter.displayName],
@@ -34,6 +27,10 @@ class WidgetSuggestionClickEvent {
             value_position: [filter.valuePosition]
         }));
     }
+    /**
+     *
+     * @returns the request property in its DTO format {@link SearchEventRequestDTO}.
+     */
     _mapRequestToDTO() {
         return {
             advanced_query_text: this.request.advancedQueryText,
@@ -47,6 +44,10 @@ class WidgetSuggestionClickEvent {
             total_results: this.request.totalResults
         };
     }
+    /**
+     *
+     * @returns WidgetSuggestionClickEvent in its DTO format.
+     */
     toDTO() {
         const filtersDTO = this._mapFiltersToDTO();
         const requestDTO = this._mapRequestToDTO();
@@ -58,11 +59,7 @@ class WidgetSuggestionClickEvent {
             searchData: {
                 action_cause: 'suggestion',
                 value: {
-                    context: {
-                        page: {
-                            uri: this.pathname
-                        }
-                    },
+                    ...this._searchContextToDTO(),
                     filters: filtersDTO,
                     request: requestDTO,
                     rfk_id: this.widgetIdentifier

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

@@ -1,29 +1,22 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.WidgetViewEvent = void 0;
-const consts_1 = require("../consts");
-class WidgetViewEvent {
+const base_widget_event_1 = require("./base-widget-event");
+class WidgetViewEvent extends base_widget_event_1.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(consts_1.ErrorMessages.IV_0015);
-        if (language !== undefined && language.length !== 2)
-            throw new Error(consts_1.ErrorMessages.IV_0011);
     }
+    /**
+     *
+     * @returns the property entities in its DTO format {@link SearchEventEntityDTO}[].
+     */
     _mapEntitiesToDTO() {
         return this.entities.map((entity) => ({
             attributes: entity.attributes,
@@ -34,6 +27,10 @@ class WidgetViewEvent {
             uri: entity.uri
         }));
     }
+    /**
+     *
+     * @returns the request property in its DTO format {@link SearchEventRequestDTO}.
+     */
     _mapRequestToDTO() {
         return {
             advanced_query_text: this.request.advancedQueryText,
@@ -47,6 +44,10 @@ class WidgetViewEvent {
             total_results: this.request.totalResults
         };
     }
+    /**
+     *
+     * @returns the WidgetViewEvent in its DTO format.
+     */
     toDTO() {
         const entitiesDTO = this._mapEntitiesToDTO();
         const requestDTO = this._mapRequestToDTO();
@@ -58,11 +59,7 @@ class WidgetViewEvent {
             searchData: {
                 action_cause: 'entity',
                 value: {
-                    context: {
-                        page: {
-                            uri: this.pathname
-                        }
-                    },
+                    ...this._searchContextToDTO(),
                     entities: entitiesDTO,
                     request: requestDTO,
                     rfk_id: this.widgetIdentifier

package/dist/cjs/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/cjs/src/lib/initializer/browser/initializer.js

@@ -8,6 +8,12 @@ const browser_2 = require("@sitecore-cloudsdk/events/browser");
 const consts_1 = require("../../consts");
 // eslint-disable-next-line no-empty-function, @typescript-eslint/no-empty-function
 async function sideEffects() {
+    window.scCloudSDK = {
+        ...window.scCloudSDK,
+        search: {
+            version: consts_1.PACKAGE_VERSION
+        }
+    };
     (0, internal_1.debug)(consts_1.SEARCH_NAMESPACE)('searchClient library initialized');
 }
 exports.sideEffects = sideEffects;
@@ -34,6 +40,7 @@ exports.addSearch = addSearch;
 browser_1.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}
  */
 async function awaitInit() {
     const initState = (0, internal_1.getEnabledPackageBrowser)(consts_1.PACKAGE_NAME)?.initState;

package/dist/cjs/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/cjs/src/lib/initializer/server/initializer.js

@@ -32,6 +32,10 @@ function addSearch() {
 }
 exports.addSearch = addSearch;
 server_1.CloudSDKServerInitializer.prototype.addSearch = addSearch;
+/**
+ * verifies if the search packages exists.
+ * @throws - {@link ErrorMessages.IE_0019}
+ */
 function verifySearchPackageExistence() {
     if (!(0, internal_1.getEnabledPackageServer)(consts_1.PACKAGE_NAME))
         throw Error(consts_1.ErrorMessages.IE_0019);

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

package/dist/cjs/src/lib/request-entities/context/context.js

@@ -4,15 +4,9 @@ exports.Context = void 0;
 // © Sitecore Corporation A/S. All rights reserved. Sitecore® is a registered trademark of Sitecore Corporation A/S.
 const utils_1 = require("@sitecore-cloudsdk/utils");
 const consts_1 = require("../../consts");
-/**
- * Create context object.
- * @param context - The context object.
- * @returns the validated and mapped context object
- */
 class Context {
     /**
-     * @param context - The context object.
-     * @returns the validated and mapped context object
+     * @param context - {@link ContextData} The context object.
      */
     constructor(context) {
         this._validateContext(context);
@@ -26,14 +20,13 @@ class Context {
     }
     /**
      * Sets the campaign data.
-     * @param campaign - The new value to set.
-     *
+     * @param campaign - {@link CampaignData} The new value to set.
      */
     set campaign(campaign) {
         this._campaign = campaign;
     }
     /**
-     * @returns The campaign data.
+     * @returns The campaign data {@link CampaignData}.
      */
     get campaign() {
         return this._campaign;
@@ -46,7 +39,7 @@ class Context {
     }
     /**
      * Sets the locale data.
-     * @param locale - The new value to set.
+     * @param locale - The new value to set. {@link LocaleData}
      *
      */
     set locale(locale) {
@@ -54,7 +47,7 @@ class Context {
         this._locale = locale;
     }
     /**
-     * @returns The locale data.
+     * @returns the locale data. {@link LocaleData}
      */
     get locale() {
         return this._locale;
@@ -67,15 +60,14 @@ class Context {
     }
     /**
      * Sets the page data.
-     * @param page - The new value to set.
-     *
+     * @param page - The new value to set {@link PageData}.
      */
     set page(page) {
         this._validatePage(page);
         this._page = page;
     }
     /**
-     * @returns The page data.
+     * @returns The page data {@link PageData}.
      */
     get page() {
         return this._page;
@@ -88,6 +80,9 @@ class Context {
     }
     /**
      * Validate context locale object.
+     *
+     * @param locale - the locale object {@link LocaleData}.
+     * @throws - {@link ErrorMessages.IV_0010} | {@link ErrorMessages.IV_0011}.
      */
     _validateContextLocale(locale) {
         if (!locale)
@@ -106,7 +101,7 @@ class Context {
         this._store = store;
     }
     /**
-     * @returns The store data.
+     * @returns The store data {@link StoreData}.
      */
     get store() {
         return this._store;
@@ -119,7 +114,7 @@ class Context {
     }
     /**
      * Sets the geo data.
-     * @param geo - The new value to set.
+     * @param geo - The new value to set {@link GeoData}.
      *
      */
     set geo(geo) {
@@ -141,6 +136,9 @@ class Context {
     }
     /**
      * Validate location object.
+     *
+     * @param location - the location object {@link LocationData}.
+     * @throws - {@link ErrorMessages.IV_0012} | {@link ErrorMessages.IV_0013}.
      */
     _validateLocation(location) {
         const result = (0, utils_1.isValidLocation)(location);
@@ -151,14 +149,14 @@ class Context {
     }
     /**
      * Sets the user data.
-     * @param user - The new value to set.
+     * @param user - The new value to set {@link UserData}.
      */
     set user(user) {
         this._validateUser(user);
         this._user = user;
     }
     /**
-     * @returns The user data.
+     * @returns The user data {@link UserData}.
      */
     get user() {
         return this._user;
@@ -170,7 +168,7 @@ 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}.
      */
     _validateUser(user) {
         if (typeof user !== 'undefined' && !user.userId && !user.uuid)
@@ -183,7 +181,7 @@ class Context {
         this._browser = browser;
     }
     /**
-     * @returns The browser data.
+     * @returns The browser data {@link BrowserData}.
      */
     get browser() {
         return this._browser;
@@ -195,7 +193,8 @@ class Context {
         this._browser = undefined;
     }
     /**
-     * Validate context object.
+     * Validate context object {@link ContextData}.
+     * @throws - {@link ErrorMessages.MV_0009} | {@link ErrorMessages.IV_0012} | {@link ErrorMessages.IV_0013}
      */
     _validateContext(context) {
         this._validateContextLocale(context.locale);
@@ -208,7 +207,8 @@ class Context {
     }
     /**
      * 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}.
      */
     _validatePage(page) {
         if (!page)
@@ -218,7 +218,7 @@ class Context {
     }
     /**
      * Map context object to DTO.
-     * @returns The DTO representation of the filter.
+     * @returns The DTO representation of the filter {@link ContextDTO}.
      */
     toDTO() {
         /* eslint-disable @typescript-eslint/naming-convention */

package/dist/cjs/src/lib/request-entities/filters/base-filter.d.ts

@@ -6,7 +6,7 @@ export declare abstract class BaseFilter {
     protected operator: Operators;
     protected value: unknown;
     /**
-     * @param operator - The operator to be applied on attribute.
+     * @param operator - The {@link Operators} to be applied on attribute.
      * @param value - The value to check against of.
      */
     constructor(operator: Operators, value: unknown);

package/dist/cjs/src/lib/request-entities/filters/base-filter.js

@@ -6,7 +6,7 @@ exports.BaseFilter = void 0;
  */
 class BaseFilter {
     /**
-     * @param operator - The operator to be applied on attribute.
+     * @param operator - The {@link Operators} to be applied on attribute.
      * @param value - The value to check against of.
      */
     constructor(operator, value) {

package/dist/cjs/src/lib/request-entities/filters/comparison-filter.d.ts

@@ -7,12 +7,12 @@ export declare class ComparisonFilter extends BaseFilter {
     private _attributeName;
     /**
      * @param attributeName - The name of the attribute to filter.
-     * @param operator - The operator to be applied on attribute.
+     * @param operator - The {@link ComparisonOperators} to be applied on attribute.
      * @param value - The value to check against of.
      */
     constructor(attributeName: string, operator: ComparisonOperators, value: unknown);
     /**
-     * @returns The DTO representation of the filter.
+     * @returns The DTO representation of the filter {@link ComparisonFilterDTO}.
      */
     toDTO(): ComparisonFilterDTO;
 }

package/dist/cjs/src/lib/request-entities/filters/comparison-filter.js

@@ -9,7 +9,7 @@ const base_filter_1 = require("./base-filter");
 class ComparisonFilter extends base_filter_1.BaseFilter {
     /**
      * @param attributeName - The name of the attribute to filter.
-     * @param operator - The operator to be applied on attribute.
+     * @param operator - The {@link ComparisonOperators} to be applied on attribute.
      * @param value - The value to check against of.
      */
     constructor(attributeName, operator, value) {
@@ -17,7 +17,7 @@ class ComparisonFilter extends base_filter_1.BaseFilter {
         this._attributeName = attributeName;
     }
     /**
-     * @returns The DTO representation of the filter.
+     * @returns The DTO representation of the filter {@link ComparisonFilterDTO}.
      */
     toDTO() {
         return {

package/dist/cjs/src/lib/request-entities/filters/facet/comparison-facet-filter.d.ts

@@ -7,12 +7,12 @@ export declare class ComparisonFacetFilter implements FacetFilterBase {
     private _operator;
     private _value;
     /**
-     * @param operator - The operator to be applied on attribute.
+     * @param operator - The {@link ComparisonOperators} to be applied on attribute.
      * @param value - The value to check against of.
      */
     constructor(operator: ComparisonOperators, value: string);
     /**
-     * @returns The DTO representation of the filter.
+     * @returns The DTO representation of the filter {@link ComparisonFacetFilterDTO}.
      */
     toDTO(): ComparisonFacetFilterDTO;
 }

package/dist/cjs/src/lib/request-entities/filters/facet/comparison-facet-filter.js

@@ -6,7 +6,7 @@ exports.ComparisonFacetFilter = void 0;
  */
 class ComparisonFacetFilter {
     /**
-     * @param operator - The operator to be applied on attribute.
+     * @param operator - The {@link ComparisonOperators} to be applied on attribute.
      * @param value - The value to check against of.
      */
     constructor(operator, value) {
@@ -14,7 +14,7 @@ class ComparisonFacetFilter {
         this._value = value;
     }
     /**
-     * @returns The DTO representation of the filter.
+     * @returns The DTO representation of the filter {@link ComparisonFacetFilterDTO}.
      */
     toDTO() {
         return {

package/dist/cjs/src/lib/request-entities/filters/facet/list-facet-filter.d.ts

@@ -7,12 +7,12 @@ export declare class ListFacetFilter implements FacetFilterBase {
     private _operator;
     private _values;
     /**
-     * @param operator - The operator to be applied on attribute.
-     * @param values - The values to check against of.
+     * @param operator - The {@link ListOperators} to be applied on attribute.
+     * @param values - The values[] to check against of.
      */
     constructor(operator: ListOperators, values: ArrayOfAtLeastOne<string>);
     /**
-     * @returns The DTO representation of the filter.
+     * @returns The DTO representation of the filter {@link ListFacetFilterDTO}.
      */
     toDTO(): ListFacetFilterDTO;
 }