@sitecore-cloudsdk/search 0.5.0-rc.0

package/README.md

@@ -0,0 +1,95 @@
+# search
+
+This package provides browser- and server-side functions to ​build search experiences and capture events that occur inside them. Search experiences include search results pages, content and product recommendations, search suggestions, and more. The events that occur inside them are sent to Sitecore, and they help track the performance of your search experiences so you can refine and improve them.
+
+## Installation
+
+```bash
+npm install @sitecore-cloudsdk/search
+```
+
+## Usage
+
+1. Initialize the package using the `CloudSDK` function, available in the `core` package.
+2. Request search content using the `getWidgetData` function.
+3. Send events using the following functions:
+   - `widgetView` - send a widget view event.
+   - `widgetItemClick` - send widget item click event.
+   - `widgetFacetClick` - send a facet click event.
+   - `widgetNavigationClick` - send a navigation click event.
+   - `widgetSuggestionClick` - send a suggestion click event.
+   - `entityView` - send an entity view event.
+
+The `search` package also requires that you install and initialize the `events` package.
+
+## Code examples
+
+Request search content on the browser side:
+
+```tsx
+import { Context, getWidgetData, SearchWidgetItem, WidgetRequestData } from '@sitecore-cloudsdk/search/browser';
+
+const context = new Context({
+  language: 'en',
+  country: 'us'
+});
+
+// Create a widget request with the entity "product" and widget ID "rfkid_7":
+const searchWidget = new SearchWidgetItem('product', 'rfkid_7', {
+  query: {
+    keyphrase: 'shoes'
+  },
+  content: {
+    fields: ['name', 'price', 'brand', 'image_url']
+  },
+  limit: 10
+});
+
+// Call the getWidgetData function with the widget request and the context to retrieve the data:
+const apiData = await getWidgetData(new WidgetRequestData([searchWidget]), context);
+```
+
+Request search content on the server side:
+
+```ts
+import type { NextRequest } from 'next/server';
+import { NextResponse } from 'next/server';
+import { CloudSDK } from '@sitecore-cloudsdk/core/server';
+import { Context, getWidgetData, SearchWidgetItem, WidgetRequestData } from '@sitecore-cloudsdk/search/server';
+
+export default async function middleware(request: NextRequest) {
+  const response = NextResponse.next();
+
+  await CloudSDK(request, response, {
+    /* Initialization settings. See `core` package code examples. */
+  })
+    .addEvents()
+    .addSearch()
+    .initialize();
+
+  const context = new Context({
+    language: 'en',
+    country: 'us'
+  });
+
+  // Create a widget request with the entity "product" and widget ID "rfkid_7":
+  const searchWidget = new SearchWidgetItem('product', 'rfkid_7', {
+    query: {
+      keyphrase: 'shoes'
+    },
+    content: {
+      fields: ['name', 'price', 'brand', 'image_url']
+    },
+    limit: 10
+  });
+
+  // Call the getWidgetData function with the widget request and the context to retrieve the data:
+  const apiData = await getWidgetData(new WidgetRequestData([searchWidget]), context);
+
+  return response;
+}
+```
+
+## Documentation
+
+[Official Sitecore Cloud SDK documentation](https://doc.sitecore.com/xmc/en/developers/sdk/latest/cloud-sdk/index.html)

package/browser.cjs

@@ -0,0 +1,3 @@
+// © Sitecore Corporation A/S. All rights reserved. Sitecore® is a registered trademark of Sitecore Corporation A/S.
+'use strict';
+module.exports = require('./dist/cjs/src/browser');

package/browser.d.ts

@@ -0,0 +1,2 @@
+// © Sitecore Corporation A/S. All rights reserved. Sitecore® is a registered trademark of Sitecore Corporation A/S.
+export * from './dist/esm/src/browser';

package/browser.js

@@ -0,0 +1,3 @@
+// © Sitecore Corporation A/S. All rights reserved. Sitecore® is a registered trademark of Sitecore Corporation A/S.
+'use strict';
+export * from './dist/esm/src/browser';

package/dist/cjs/package.json

@@ -0,0 +1,40 @@
+{
+    "name": "@sitecore-cloudsdk/search",
+    "version": "0.5.0-rc.0",
+    "license": "Apache-2.0",
+    "exports": {
+        "./server": {
+            "import": "./server.js",
+            "require": "./server.cjs",
+            "types": "./server.d.ts"
+        },
+        "./browser": {
+            "import": "./browser.js",
+            "require": "./browser.cjs",
+            "types": "./browser.d.ts"
+        }
+    },
+    "scripts": {
+        "build": "npm run build:cjs && npm run build:es",
+        "build:cjs": "tsc -b tsconfig.cjs.json",
+        "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"
+    },
+    "files": [
+        "dist",
+        "README.md",
+        "browser.js",
+        "browser.cjs",
+        "browser.d.ts",
+        "server.cjs",
+        "server.js",
+        "server.d.ts"
+    ],
+    "engines": {
+        "node": ">=18"
+    }
+}

package/dist/cjs/src/browser.d.ts

@@ -0,0 +1,32 @@
+import './lib/initializer/browser/initializer';
+export { WidgetRequestData } from './lib/request-entities/widgets/widget-request-data';
+export { SearchWidgetItem } from './lib/request-entities/widgets/search-widget-item';
+export { RecommendationWidgetItem } from './lib/request-entities/widgets/recommendation-widget-item';
+export { QuestionsAnswersWidgetItem } from './lib/request-entities/widgets/questions-answers-widget-item';
+export { RuleWidgetItem } from './lib/request-entities/widgets/rule-widget-item';
+export { LogicalFilter } from './lib/request-entities/filters/logical-filter';
+export { ComparisonFilter } from './lib/request-entities/filters/comparison-filter';
+export { ComparisonFacetFilter } from './lib/request-entities/filters/facet/comparison-facet-filter';
+export { ListFacetFilter } from './lib/request-entities/filters/facet/list-facet-filter';
+export { GeoFilter } from './lib/request-entities/filters/geo-filter';
+export { ListFilter } from './lib/request-entities/filters/list-filter';
+export { GeoWithinFilter } from './lib/request-entities/filters/geo-within-filter';
+export { Context } from './lib/request-entities/context/context';
+export { LogicalFacetFilter } from './lib/request-entities/filters/facet/logical-facet-filter';
+export { NotFacetFilter } from './lib/request-entities/filters/facet/not-facet-filter';
+export type { BrowserSettings } from './lib/types';
+export type { GeoData, BrowserData, LocaleData, PageData, UserData, StoreData, ContextData, CampaignData } from './lib/request-entities/context/interfaces';
+export type { FacetOptions, QueryOptions, ContentOptions, Recipe, SearchOptions, RecommendationOptions, QuestionsAnswersOptions, ExactAnswerOptions, RelatedQuestionsOptions, FacetSort, SortValue, SearchRankingOptions, SearchPersonalizationOptions, SearchSortOptions, SearchSuggestionOptions, SearchRuleOptions } from './lib/request-entities/widgets/interfaces';
+export type { WidgetItem } from './lib/request-entities/widgets/widget-item';
+export { getWidgetData } from './lib/requests/browser/get-widget-data';
+export { getPageWidgetData } from './lib/requests/browser/get-page-widget-data';
+export { widgetNavigationClick } from './lib/requests/browser/widget-navigation-click-event';
+export { widgetItemClick } from './lib/requests/browser/widget-item-click-event';
+export { widgetSuggestionClick } from './lib/requests/browser/widget-suggestion-click-event';
+export { widgetFacetClick } from './lib/requests/browser/widget-facet-click-event';
+export { widgetView } from './lib/requests/browser/widget-view-event';
+export { entityView } from './lib/requests/browser/entity-view-event';
+export { SEARCH_NAMESPACE } from './lib/consts';
+export type { SearchEventEntity, SearchEventRequest, SuggestionFilterEventParams, FacetFilterEventParams, RangeFacetFilterEventParams, EventFilter, WidgetNavigationClickEventParams, WidgetItemClickEventParams, WidgetSuggestionClickEventParams, WidgetFacetClickEventParams, WidgetViewEventParams, EntityViewEventParams } from './lib/events/interfaces';
+export type { Filter, GeoFilterData, ComparisonOperators, LogicalOperators, ListOperators, GeoOperator, GeoWithinOperator, Operators, LogicalFilterValues, DistanceString, GeoWithinFilterData } from './lib/request-entities/filters/interfaces';
+export type { SearchEndpointResponse } from './lib/requests/post-request';

package/dist/cjs/src/browser.js

@@ -0,0 +1,53 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SEARCH_NAMESPACE = exports.entityView = exports.widgetView = exports.widgetFacetClick = exports.widgetSuggestionClick = exports.widgetItemClick = exports.widgetNavigationClick = exports.getPageWidgetData = exports.getWidgetData = exports.NotFacetFilter = exports.LogicalFacetFilter = exports.Context = exports.GeoWithinFilter = exports.ListFilter = exports.GeoFilter = exports.ListFacetFilter = exports.ComparisonFacetFilter = exports.ComparisonFilter = exports.LogicalFilter = exports.RuleWidgetItem = exports.QuestionsAnswersWidgetItem = exports.RecommendationWidgetItem = exports.SearchWidgetItem = exports.WidgetRequestData = void 0;
+// © Sitecore Corporation A/S. All rights reserved. Sitecore® is a registered trademark of Sitecore Corporation A/S.
+require("./lib/initializer/browser/initializer");
+var widget_request_data_1 = require("./lib/request-entities/widgets/widget-request-data");
+Object.defineProperty(exports, "WidgetRequestData", { enumerable: true, get: function () { return widget_request_data_1.WidgetRequestData; } });
+var search_widget_item_1 = require("./lib/request-entities/widgets/search-widget-item");
+Object.defineProperty(exports, "SearchWidgetItem", { enumerable: true, get: function () { return search_widget_item_1.SearchWidgetItem; } });
+var recommendation_widget_item_1 = require("./lib/request-entities/widgets/recommendation-widget-item");
+Object.defineProperty(exports, "RecommendationWidgetItem", { enumerable: true, get: function () { return recommendation_widget_item_1.RecommendationWidgetItem; } });
+var questions_answers_widget_item_1 = require("./lib/request-entities/widgets/questions-answers-widget-item");
+Object.defineProperty(exports, "QuestionsAnswersWidgetItem", { enumerable: true, get: function () { return questions_answers_widget_item_1.QuestionsAnswersWidgetItem; } });
+var rule_widget_item_1 = require("./lib/request-entities/widgets/rule-widget-item");
+Object.defineProperty(exports, "RuleWidgetItem", { enumerable: true, get: function () { return rule_widget_item_1.RuleWidgetItem; } });
+var logical_filter_1 = require("./lib/request-entities/filters/logical-filter");
+Object.defineProperty(exports, "LogicalFilter", { enumerable: true, get: function () { return logical_filter_1.LogicalFilter; } });
+var comparison_filter_1 = require("./lib/request-entities/filters/comparison-filter");
+Object.defineProperty(exports, "ComparisonFilter", { enumerable: true, get: function () { return comparison_filter_1.ComparisonFilter; } });
+var comparison_facet_filter_1 = require("./lib/request-entities/filters/facet/comparison-facet-filter");
+Object.defineProperty(exports, "ComparisonFacetFilter", { enumerable: true, get: function () { return comparison_facet_filter_1.ComparisonFacetFilter; } });
+var list_facet_filter_1 = require("./lib/request-entities/filters/facet/list-facet-filter");
+Object.defineProperty(exports, "ListFacetFilter", { enumerable: true, get: function () { return list_facet_filter_1.ListFacetFilter; } });
+var geo_filter_1 = require("./lib/request-entities/filters/geo-filter");
+Object.defineProperty(exports, "GeoFilter", { enumerable: true, get: function () { return geo_filter_1.GeoFilter; } });
+var list_filter_1 = require("./lib/request-entities/filters/list-filter");
+Object.defineProperty(exports, "ListFilter", { enumerable: true, get: function () { return list_filter_1.ListFilter; } });
+var geo_within_filter_1 = require("./lib/request-entities/filters/geo-within-filter");
+Object.defineProperty(exports, "GeoWithinFilter", { enumerable: true, get: function () { return geo_within_filter_1.GeoWithinFilter; } });
+var context_1 = require("./lib/request-entities/context/context");
+Object.defineProperty(exports, "Context", { enumerable: true, get: function () { return context_1.Context; } });
+var logical_facet_filter_1 = require("./lib/request-entities/filters/facet/logical-facet-filter");
+Object.defineProperty(exports, "LogicalFacetFilter", { enumerable: true, get: function () { return logical_facet_filter_1.LogicalFacetFilter; } });
+var not_facet_filter_1 = require("./lib/request-entities/filters/facet/not-facet-filter");
+Object.defineProperty(exports, "NotFacetFilter", { enumerable: true, get: function () { return not_facet_filter_1.NotFacetFilter; } });
+var get_widget_data_1 = require("./lib/requests/browser/get-widget-data");
+Object.defineProperty(exports, "getWidgetData", { enumerable: true, get: function () { return get_widget_data_1.getWidgetData; } });
+var get_page_widget_data_1 = require("./lib/requests/browser/get-page-widget-data");
+Object.defineProperty(exports, "getPageWidgetData", { enumerable: true, get: function () { return get_page_widget_data_1.getPageWidgetData; } });
+var widget_navigation_click_event_1 = require("./lib/requests/browser/widget-navigation-click-event");
+Object.defineProperty(exports, "widgetNavigationClick", { enumerable: true, get: function () { return widget_navigation_click_event_1.widgetNavigationClick; } });
+var widget_item_click_event_1 = require("./lib/requests/browser/widget-item-click-event");
+Object.defineProperty(exports, "widgetItemClick", { enumerable: true, get: function () { return widget_item_click_event_1.widgetItemClick; } });
+var widget_suggestion_click_event_1 = require("./lib/requests/browser/widget-suggestion-click-event");
+Object.defineProperty(exports, "widgetSuggestionClick", { enumerable: true, get: function () { return widget_suggestion_click_event_1.widgetSuggestionClick; } });
+var widget_facet_click_event_1 = require("./lib/requests/browser/widget-facet-click-event");
+Object.defineProperty(exports, "widgetFacetClick", { enumerable: true, get: function () { return widget_facet_click_event_1.widgetFacetClick; } });
+var widget_view_event_1 = require("./lib/requests/browser/widget-view-event");
+Object.defineProperty(exports, "widgetView", { enumerable: true, get: function () { return widget_view_event_1.widgetView; } });
+var entity_view_event_1 = require("./lib/requests/browser/entity-view-event");
+Object.defineProperty(exports, "entityView", { enumerable: true, get: function () { return entity_view_event_1.entityView; } });
+var consts_1 = require("./lib/consts");
+Object.defineProperty(exports, "SEARCH_NAMESPACE", { enumerable: true, get: function () { return consts_1.SEARCH_NAMESPACE; } });

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

@@ -0,0 +1,38 @@
+export declare const PACKAGE_NAME: string;
+export declare const SEARCH_NAMESPACE = "sitecore-cloudsdk:search";
+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()\".",
+    IE_0019 = "[IE-0019] You must first initialize the Cloud SDK and the \"search\" package. First, import \"CloudSDK\" from \"@sitecore-cloudsdk/core/server\", and import \"@sitecore-cloudsdk/search/server\". Then, run \"await CloudSDK().addEvents().addSearch().initialize()\".",
+    IV_0007 = "[IV-0007] Incorrect value for \"limit\". Set the value to an integer between 1 and 100 inclusive.",
+    IV_0008 = "[IV-0008] Incorrect value for \"offset\". Set the value to an integer greater than or equal to 0.",
+    IV_0009 = "[IV-0009] Incorrect value for \"\u200Bkeyphrase\"\u200B\u200B. Set the value to a string between 1 and 100 characters inclusive.",
+    IV_0010 = "[IV-0010] Incorrect value for \"country\". Format the value according to ISO 3166-1 alpha-2.",
+    IV_0011 = "[IV-0011] Incorrect value for \"language\". Format the value according to ISO 639.",
+    IV_0012 = "[IV-0012] Incorrect value for \"latitude\". Set the value to an integer or decimal between -90.000000 and 90.000000 inclusive.",
+    IV_0013 = "[IV-0013] Incorrect value for \"longitude\". Set the value to an integer or decimal between -180.000000 and 180.000000 inclusive.",
+    IV_0014 = "[IV-0014] Incorrect value for \"max\"\u200B\u200B. Set the value to an integer between 1 and 100 inclusive.",
+    IV_0015 = "[IV-0015] Incorrect value for \"currency\". Format the value according to ISO 4217.",
+    IV_0016 = "[IV-0016] Incorrect value for \"name\". Set the value to a non-empty string, and do not include spaces.",
+    IV_0017 = "[IV-0017] Incorrect value for \"max\" in \"facet.types\". Set the value to an integer between 1 and 100 inclusive.",
+    IV_0018 = "[IV-0018] Incorrect value for \"keyphrase\" in \"facet.types\". Set the value to a string between 1 and 100 inclusive.",
+    IV_0019 = "[IV-0019] Incorrect value for \"minCount\" in \"facet.types\". Set the value to an integer between 1 and 100 inclusive.",
+    IV_0020 = "[IV-0020] Incorrect value for \"after\" in \"facet.types\". Set the value to a non-empty string, and do not include spaces.",
+    IV_0021 = "[IV-0021] You must set \u200B\"sort.name\"\u200B\u200B to \u200B\"text\"\u200B\u200B if you use \"\u200Bafter\"\u200B\u200B. ",
+    IV_0022 = "[IV-0022] Incorrect value for \"groupBy\". Set the value to a non-empty string.",
+    IV_0023 = "[IV-0023] Incorrect value for recipe \"id\". Set the value to a non-empty string.",
+    IV_0024 = "[IV-0024] Incorrect value for recipe \"version\". Set the value to an integer greater than or equal to 1.",
+    IV_0025 = "[IV-0025] Incorrect value for \"uri\" in \"page\". Set the value to a relative or absolute path. Examples: \"/products\", \"https://www.example.com/products\".",
+    IV_0026 = "[IV-0026] Incorrect value for \"name\" in \"sortValue\". Set the value to a non-empty string.",
+    IV_0027 = "[IV-0027] Incorrect value for pin item \"id\". Set the value to a non-empty string.",
+    IV_0028 = "[IV-0028] Incorrect value for \"slot\". Set the value to an integer greater than or equal to 0.",
+    IV_0029 = "[IV-0029] Incorrect value for \"ranking.weight\". Set the value to an integer or float between 0.1 and 100 inclusive.",
+    IV_0030 = "[IV-0030] Incorrect value in \"personalization.attributes\". Set the value to a non-empty string, and do not include spaces.",
+    IV_0031 = "[IV-0031] Incorrect value in \"personalization.ids\". Set the value to a non-empty string.",
+    MV_0006 = "[MV-0006] \"context.page.uri\" is required.",
+    MV_0009 = "[MV-0009] You must set values for both \"groupId\" and \"id\" if you set a value for one of them.",
+    MV_0010 = "[MV-0010] \"entity\" is required.",
+    MV_0011 = "[MV-0011] \"widgetId\" is required.",
+    MV_0012 = "[MV-0012] The \"widgetItems\" array must contain a minimum of 1 item.",
+    MV_0013 = "[MV-0013] You must set a value for \"userId\" or \"uuid\"."
+}

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

@@ -0,0 +1,49 @@
+"use strict";
+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;
+// © 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';
+/* eslint-disable max-len */
+var ErrorMessages;
+(function (ErrorMessages) {
+    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.";
+    ErrorMessages["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()\".";
+    ErrorMessages["IE_0019"] = "[IE-0019] You must first initialize the Cloud SDK and the \"search\" package. First, import \"CloudSDK\" from \"@sitecore-cloudsdk/core/server\", and import \"@sitecore-cloudsdk/search/server\". Then, run \"await CloudSDK().addEvents().addSearch().initialize()\".";
+    ErrorMessages["IV_0007"] = "[IV-0007] Incorrect value for \"limit\". Set the value to an integer between 1 and 100 inclusive.";
+    ErrorMessages["IV_0008"] = "[IV-0008] Incorrect value for \"offset\". Set the value to an integer greater than or equal to 0.";
+    ErrorMessages["IV_0009"] = "[IV-0009] Incorrect value for \"\u200Bkeyphrase\"\u200B\u200B. Set the value to a string between 1 and 100 characters inclusive.";
+    ErrorMessages["IV_0010"] = "[IV-0010] Incorrect value for \"country\". Format the value according to ISO 3166-1 alpha-2.";
+    ErrorMessages["IV_0011"] = "[IV-0011] Incorrect value for \"language\". Format the value according to ISO 639.";
+    ErrorMessages["IV_0012"] = "[IV-0012] Incorrect value for \"latitude\". Set the value to an integer or decimal between -90.000000 and 90.000000 inclusive.";
+    ErrorMessages["IV_0013"] = "[IV-0013] Incorrect value for \"longitude\". Set the value to an integer or decimal between -180.000000 and 180.000000 inclusive.";
+    ErrorMessages["IV_0014"] = "[IV-0014] Incorrect value for \"max\"\u200B\u200B. Set the value to an integer between 1 and 100 inclusive.";
+    ErrorMessages["IV_0015"] = "[IV-0015] Incorrect value for \"currency\". Format the value according to ISO 4217.";
+    ErrorMessages["IV_0016"] = "[IV-0016] Incorrect value for \"name\". Set the value to a non-empty string, and do not include spaces.";
+    ErrorMessages["IV_0017"] = "[IV-0017] Incorrect value for \"max\" in \"facet.types\". Set the value to an integer between 1 and 100 inclusive.";
+    ErrorMessages["IV_0018"] = "[IV-0018] Incorrect value for \"keyphrase\" in \"facet.types\". Set the value to a string between 1 and 100 inclusive.";
+    ErrorMessages["IV_0019"] = "[IV-0019] Incorrect value for \"minCount\" in \"facet.types\". Set the value to an integer between 1 and 100 inclusive.";
+    ErrorMessages["IV_0020"] = "[IV-0020] Incorrect value for \"after\" in \"facet.types\". Set the value to a non-empty string, and do not include spaces.";
+    ErrorMessages["IV_0021"] = "[IV-0021] You must set \u200B\"sort.name\"\u200B\u200B to \u200B\"text\"\u200B\u200B if you use \"\u200Bafter\"\u200B\u200B. ";
+    ErrorMessages["IV_0022"] = "[IV-0022] Incorrect value for \"groupBy\". Set the value to a non-empty string.";
+    ErrorMessages["IV_0023"] = "[IV-0023] Incorrect value for recipe \"id\". Set the value to a non-empty string.";
+    ErrorMessages["IV_0024"] = "[IV-0024] Incorrect value for recipe \"version\". Set the value to an integer greater than or equal to 1.";
+    ErrorMessages["IV_0025"] = "[IV-0025] Incorrect value for \"uri\" in \"page\". Set the value to a relative or absolute path. Examples: \"/products\", \"https://www.example.com/products\".";
+    ErrorMessages["IV_0026"] = "[IV-0026] Incorrect value for \"name\" in \"sortValue\". Set the value to a non-empty string.";
+    ErrorMessages["IV_0027"] = "[IV-0027] Incorrect value for pin item \"id\". Set the value to a non-empty string.";
+    ErrorMessages["IV_0028"] = "[IV-0028] Incorrect value for \"slot\". Set the value to an integer greater than or equal to 0.";
+    ErrorMessages["IV_0029"] = "[IV-0029] Incorrect value for \"ranking.weight\". Set the value to an integer or float between 0.1 and 100 inclusive.";
+    ErrorMessages["IV_0030"] = "[IV-0030] Incorrect value in \"personalization.attributes\". Set the value to a non-empty string, and do not include spaces.";
+    ErrorMessages["IV_0031"] = "[IV-0031] Incorrect value in \"personalization.ids\". Set the value to a non-empty string.";
+    ErrorMessages["MV_0006"] = "[MV-0006] \"context.page.uri\" is required.";
+    ErrorMessages["MV_0009"] = "[MV-0009] You must set values for both \"groupId\" and \"id\" if you set a value for one of them.";
+    ErrorMessages["MV_0010"] = "[MV-0010] \"entity\" is required.";
+    ErrorMessages["MV_0011"] = "[MV-0011] \"widgetId\" is required.";
+    ErrorMessages["MV_0012"] = "[MV-0012] The \"widgetItems\" array must contain a minimum of 1 item.";
+    ErrorMessages["MV_0013"] = "[MV-0013] You must set a value for \"userId\" or \"uuid\".";
+})(ErrorMessages || (exports.ErrorMessages = ErrorMessages = {}));
+/* eslint-enable max-len */

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

@@ -0,0 +1,22 @@
+import type { NestedObject } from '@sitecore-cloudsdk/utils';
+import type { EntityViewEventParams, SearchEventEntity } from './interfaces';
+export declare class EntityViewEvent {
+    protected page?: string;
+    protected currency?: string;
+    protected language?: string;
+    protected pathname: string;
+    protected entity: SearchEventEntity;
+    /**
+     * Creates an entity view event.
+     * @param entityViewEventParams - An object with the entity view event params {@link EntityViewEventParams}
+     */
+    constructor({ page, currency, language, pathname, entity }: EntityViewEventParams);
+    private _validate;
+    toDTO(): {
+        currency: string | undefined;
+        language: string | undefined;
+        page: string | undefined;
+        searchData: NestedObject;
+        type: string;
+    };
+}

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

@@ -0,0 +1,51 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.EntityViewEvent = void 0;
+const consts_1 = require("../consts");
+class EntityViewEvent {
+    /**
+     * Creates an entity view event.
+     * @param entityViewEventParams - An object with the entity view event params {@link EntityViewEventParams}
+     */
+    constructor({ page, currency, language, pathname, entity }) {
+        this._validate(currency, language);
+        this.page = page;
+        this.currency = currency;
+        this.language = language;
+        this.pathname = pathname;
+        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);
+    }
+    toDTO() {
+        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 {
+            currency: this.currency,
+            language: this.language,
+            page: this.page,
+            searchData: {
+                value: {
+                    context: {
+                        page: {
+                            uri: this.pathname
+                        }
+                    },
+                    entities: [eventEntityDTO]
+                }
+            },
+            type: 'VIEW'
+        };
+    }
+}
+exports.EntityViewEvent = EntityViewEvent;

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

@@ -0,0 +1,135 @@
+export interface SearchEventEntityDTO {
+    id: string;
+    entity_type: string;
+    entity_subtype?: string;
+    uri?: string;
+    attributes?: Record<string, string>;
+    source_id?: string;
+}
+export interface SearchEventEntity {
+    id: string;
+    entity: string;
+    entityType?: string;
+    uri?: string;
+    attributes?: Record<string, string>;
+    sourceId?: string;
+}
+export interface SearchEventRequestDTO {
+    keyword?: string;
+    advanced_query_text?: string;
+    modified_keyword?: string;
+    num_results?: number;
+    total_results?: number;
+    num_requested?: number;
+    page_size?: number;
+    page_number?: number;
+    redirect_url?: string;
+}
+export interface SearchEventRequest {
+    keyword?: string;
+    advancedQueryText?: string;
+    modifiedKeyword?: string;
+    numResults?: number;
+    totalResults?: number;
+    numRequested?: number;
+    pageSize?: number;
+    pageNumber?: number;
+    redirectUrl?: string;
+}
+export interface EventFilterDTO {
+    display_name?: Array<string>;
+    start_value?: string;
+    end_value?: string;
+    facet_position?: string;
+    name?: string;
+    title?: string;
+    value?: Array<string>;
+    value_position?: Array<string>;
+}
+export interface SuggestionFilterEventParams {
+    name: string;
+    title: string;
+    value: string;
+    valuePosition: number;
+    displayName: string;
+}
+export interface SuggestionFilterEventParamsDTO {
+    name: string;
+    title: string;
+    value: string[];
+    value_position: number[];
+    display_name: string[];
+}
+export interface FacetFilterEventParams extends SuggestionFilterEventParams {
+    facetPosition: number;
+}
+export interface FacetFilterEventParamsDTO extends SuggestionFilterEventParamsDTO {
+    facet_position: number;
+}
+export interface RangeFacetFilterEventParams extends SuggestionFilterEventParams {
+    startValue: string;
+    endValue: string;
+}
+export interface RangeFacetFilterEventParamsDTO extends SuggestionFilterEventParamsDTO {
+    start_value: string;
+    end_value: string;
+    facet_position: 0;
+}
+export type EventFilter = SuggestionFilterEventParams | FacetFilterEventParams | RangeFacetFilterEventParams;
+export interface WidgetNavigationClickEventParams {
+    pathname: string;
+    page?: string;
+    itemPosition: number;
+    currency?: string;
+    language?: string;
+    channel?: string;
+    widgetId: string;
+}
+export interface WidgetItemClickEventParams {
+    request: SearchEventRequest;
+    entity: SearchEventEntity;
+    itemPosition: number;
+    pathname: string;
+    widgetId: string;
+    page?: string;
+    currency?: string;
+    language?: string;
+    channel?: string;
+}
+export interface WidgetSuggestionClickEventParams {
+    request: SearchEventRequest;
+    filters?: Array<SuggestionFilterEventParams>;
+    pathname: string;
+    widgetId: string;
+    page?: string;
+    currency?: string;
+    language?: string;
+    channel?: string;
+}
+export interface WidgetFacetClickEventParams {
+    request: SearchEventRequest;
+    filters: Array<FacetFilterEventParams | RangeFacetFilterEventParams>;
+    pathname: string;
+    widgetId: string;
+    page?: string;
+    currency?: string;
+    language?: string;
+    channel?: string;
+}
+export interface WidgetViewEventParams {
+    request: SearchEventRequest;
+    entities: Array<SearchEventEntity>;
+    pathname: string;
+    widgetId: string;
+    page?: string;
+    currency?: string;
+    language?: string;
+    channel?: string;
+}
+export interface EntityViewEventParams {
+    page?: string;
+    currency?: string;
+    language?: string;
+    pathname: string;
+    entity: SearchEventEntity;
+}

package/dist/cjs/src/lib/events/interfaces.js

@@ -0,0 +1,3 @@
+"use strict";
+// © Sitecore Corporation A/S. All rights reserved. Sitecore® is a registered trademark of Sitecore Corporation A/S.
+Object.defineProperty(exports, "__esModule", { value: true });

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