@sitecore-content-sdk/events 2.1.0-canary.1 → 2.1.0-canary.3

package/dist/cjs/package.json

@@ -7,8 +7,8 @@
         "url": "https://github.com/Sitecore/content-sdk/issues"
     },
     "dependencies": {
-        "@sitecore-content-sdk/analytics-core": "2.1.0-canary.1",
-        "@sitecore-content-sdk/core": "2.1.0-canary.1",
+        "@sitecore-content-sdk/analytics-core": "2.1.0-canary.3",
+        "@sitecore-content-sdk/core": "2.1.0-canary.3",
         "debug": "^4.4.3",
         "isbot": "^5.1.36"
     },
@@ -76,6 +76,6 @@
         "api-extractor": "npm run build && api-extractor run --local --verbose",
         "api-extractor:verify": "api-extractor run"
     },
-    "version": "2.1.0-canary.1",
-    "gitHead": "59794666566c6d47740b8e505ad8186c09363d64"
+    "version": "2.1.0-canary.3",
+    "gitHead": "b48df0b60fd04e0b05a92ea28201617daa622eac"
 }

package/dist/cjs/src/events/page-view/bot-page-view.js

@@ -11,10 +11,11 @@ const bot_detection_1 = require("./bot-detection");
  * Sends a VIEW event for server-side bot tracking (e.g. Next.js proxy / Edge).
  * Uses a synthetic per-invocation client id and defaults `channel` to `bot`.
  * Returns `null` in browser environments.
+ * @param {BotPageView} [pageViewData] - The optional attributes to be sent to the SitecoreCloud API
  * @returns The response from Sitecore Edge Proxy, or `null` if skipped (browser).
  * @public
  */
-async function botPageView() {
+async function botPageView(pageViewData) {
     if ((0, bot_detection_1.isBrowserEnvironment)()) {
         return null;
     }
@@ -27,6 +28,8 @@ async function botPageView() {
         id,
         pageViewData: {
             channel: bot_detection_1.BOT_CHANNEL,
+            page: pageViewData.page,
+            language: pageViewData.language,
         },
         searchParams: adapter.location.getSearchParams(),
         sendEvent: sendEvent_1.sendEvent,

package/dist/esm/package.json

@@ -7,8 +7,8 @@
         "url": "https://github.com/Sitecore/content-sdk/issues"
     },
     "dependencies": {
-        "@sitecore-content-sdk/analytics-core": "2.1.0-canary.1",
-        "@sitecore-content-sdk/core": "2.1.0-canary.1",
+        "@sitecore-content-sdk/analytics-core": "2.1.0-canary.3",
+        "@sitecore-content-sdk/core": "2.1.0-canary.3",
         "debug": "^4.4.3",
         "isbot": "^5.1.36"
     },
@@ -76,6 +76,6 @@
         "api-extractor": "npm run build && api-extractor run --local --verbose",
         "api-extractor:verify": "api-extractor run"
     },
-    "version": "2.1.0-canary.1",
-    "gitHead": "59794666566c6d47740b8e505ad8186c09363d64"
+    "version": "2.1.0-canary.3",
+    "gitHead": "b48df0b60fd04e0b05a92ea28201617daa622eac"
 }

package/dist/esm/src/events/page-view/bot-page-view.js

@@ -1,17 +1,18 @@
-import { getAnalyticsPlugin } from "@sitecore-content-sdk/analytics-core/internal";
-import { getCoreContext } from "@sitecore-content-sdk/core";
-import { getEventsPlugin } from "../../initialization/plugin";
-import { sendEvent } from "../send-event/sendEvent";
-import { PageViewEvent } from "./page-view-event";
-import { BOT_CHANNEL, isBrowserEnvironment } from "./bot-detection";
+import { getAnalyticsPlugin } from '@sitecore-content-sdk/analytics-core/internal';
+import { getCoreContext } from '@sitecore-content-sdk/core';
+import { getEventsPlugin } from '../../initialization/plugin';
+import { sendEvent } from '../send-event/sendEvent';
+import { PageViewEvent } from './page-view-event';
+import { BOT_CHANNEL, isBrowserEnvironment } from './bot-detection';
 /**
  * Sends a VIEW event for server-side bot tracking (e.g. Next.js proxy / Edge).
  * Uses a synthetic per-invocation client id and defaults `channel` to `bot`.
  * Returns `null` in browser environments.
+ * @param {BotPageView} [pageViewData] - The optional attributes to be sent to the SitecoreCloud API
  * @returns The response from Sitecore Edge Proxy, or `null` if skipped (browser).
  * @public
  */
-export async function botPageView() {
+export async function botPageView(pageViewData) {
     if (isBrowserEnvironment()) {
         return null;
     }
@@ -24,6 +25,8 @@ export async function botPageView() {
         id,
         pageViewData: {
             channel: BOT_CHANNEL,
+            page: pageViewData.page,
+            language: pageViewData.language,
         },
         searchParams: adapter.location.getSearchParams(),
         sendEvent,

package/package.json

@@ -7,8 +7,8 @@
     "url": "https://github.com/Sitecore/content-sdk/issues"
   },
   "dependencies": {
-    "@sitecore-content-sdk/analytics-core": "2.1.0-canary.1",
-    "@sitecore-content-sdk/core": "2.1.0-canary.1",
+    "@sitecore-content-sdk/analytics-core": "2.1.0-canary.3",
+    "@sitecore-content-sdk/core": "2.1.0-canary.3",
     "debug": "^4.4.3",
     "isbot": "^5.1.36"
   },
@@ -76,6 +76,6 @@
     "api-extractor": "npm run build && api-extractor run --local --verbose",
     "api-extractor:verify": "api-extractor run"
   },
-  "version": "2.1.0-canary.1",
-  "gitHead": "59794666566c6d47740b8e505ad8186c09363d64"
+  "version": "2.1.0-canary.3",
+  "gitHead": "b48df0b60fd04e0b05a92ea28201617daa622eac"
 }

package/types/src/events/index.d.ts

@@ -1,6 +1,7 @@
 export { BaseEvent } from './base-event';
 export type { BasePayload } from './base-event';
 export { PageViewEvent } from './page-view/page-view-event';
+export type { BotPageViewData } from './page-view/bot-page-view';
 export type { PageViewData, PageViewEventPayload } from './page-view/page-view-event';
 export { CustomEvent } from './custom-event/custom-event';
 export type { EventData, CustomEventPayload, CustomEventArguments, } from './custom-event/custom-event';

package/types/src/events/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/events/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,cAAc,CAAC;AACzC,YAAY,EAAE,WAAW,EAAE,MAAM,cAAc,CAAC;AAEhD,OAAO,EAAE,aAAa,EAAE,MAAM,6BAA6B,CAAC;AAC5D,YAAY,EAAE,YAAY,EAAE,oBAAoB,EAAE,MAAM,6BAA6B,CAAC;AAEtF,OAAO,EAAE,WAAW,EAAE,MAAM,6BAA6B,CAAC;AAC1D,YAAY,EACV,SAAS,EACT,kBAAkB,EAClB,oBAAoB,GACrB,MAAM,6BAA6B,CAAC;AAErC,OAAO,EAAE,aAAa,EAAE,MAAM,2BAA2B,CAAC;AAC1D,YAAY,EAAE,YAAY,EAAE,oBAAoB,EAAE,MAAM,2BAA2B,CAAC;AAEpF,YAAY,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/events/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,cAAc,CAAC;AACzC,YAAY,EAAE,WAAW,EAAE,MAAM,cAAc,CAAC;AAEhD,OAAO,EAAE,aAAa,EAAE,MAAM,6BAA6B,CAAC;AAC5D,YAAY,EAAE,eAAe,EAAE,MAAM,2BAA2B,CAAC;AACjE,YAAY,EAAE,YAAY,EAAE,oBAAoB,EAAE,MAAM,6BAA6B,CAAC;AAEtF,OAAO,EAAE,WAAW,EAAE,MAAM,6BAA6B,CAAC;AAC1D,YAAY,EACV,SAAS,EACT,kBAAkB,EAClB,oBAAoB,GACrB,MAAM,6BAA6B,CAAC;AAErC,OAAO,EAAE,aAAa,EAAE,MAAM,2BAA2B,CAAC;AAC1D,YAAY,EAAE,YAAY,EAAE,oBAAoB,EAAE,MAAM,2BAA2B,CAAC;AAEpF,YAAY,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC"}

package/types/src/events/page-view/bot-page-view.d.ts

@@ -1,10 +1,27 @@
-import { type EPResponse } from "@sitecore-content-sdk/analytics-core/internal";
+import { type EPResponse } from '@sitecore-content-sdk/analytics-core/internal';
+/**
+ * The data to be sent for bot tracking.
+ * @public
+ */
+export type BotPageViewData = {
+    /**
+     * The name of the webpage where the interaction with your brand takes place.
+     */
+    page: string;
+    /**
+     * The language the site visitor interacts with your brand in.
+     * For example, if the site visitor selects the Japanese language in your app, the language is "JA".
+     * Format: uppercase ISO 639.
+     */
+    language: string;
+};
 /**
  * Sends a VIEW event for server-side bot tracking (e.g. Next.js proxy / Edge).
  * Uses a synthetic per-invocation client id and defaults `channel` to `bot`.
  * Returns `null` in browser environments.
+ * @param {BotPageView} [pageViewData] - The optional attributes to be sent to the SitecoreCloud API
  * @returns The response from Sitecore Edge Proxy, or `null` if skipped (browser).
  * @public
  */
-export declare function botPageView(): Promise<EPResponse | null>;
+export declare function botPageView(pageViewData: BotPageViewData): Promise<EPResponse | null>;
 //# sourceMappingURL=bot-page-view.d.ts.map

package/types/src/events/page-view/bot-page-view.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"bot-page-view.d.ts","sourceRoot":"","sources":["../../../../src/events/page-view/bot-page-view.ts"],"names":[],"mappings":"AAAA,OAAO,EAAsB,KAAK,UAAU,EAAE,MAAM,+CAA+C,CAAC;AAOpG;;;;;;GAMG;AACH,wBAAsB,WAAW,IAAI,OAAO,CAAC,UAAU,GAAG,IAAI,CAAC,CAqB9D"}
+{"version":3,"file":"bot-page-view.d.ts","sourceRoot":"","sources":["../../../../src/events/page-view/bot-page-view.ts"],"names":[],"mappings":"AAAA,OAAO,EAAsB,KAAK,UAAU,EAAE,MAAM,+CAA+C,CAAC;AAOpG;;;GAGG;AACH,MAAM,MAAM,eAAe,GAAG;IAC5B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;;;OAIG;IACH,QAAQ,EAAE,MAAM,CAAC;CAClB,CAAC;AAEF;;;;;;;GAOG;AACH,wBAAsB,WAAW,CAAC,YAAY,EAAE,eAAe,GAAG,OAAO,CAAC,UAAU,GAAG,IAAI,CAAC,CAuB3F"}

package/types/src/index.d.ts

@@ -1,4 +1,4 @@
-export type { PageViewData, EventData, IdentityData } from './events';
+export type { PageViewData, BotPageViewData, EventData, IdentityData } from './events';
 export type { Identifier } from './events/identity/identity-event';
 export type { EventAttributesInput, ExtensionData } from './events/common-interfaces';
 export { form } from './events/custom-event/form';

package/types/src/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,YAAY,EAAE,YAAY,EAAE,SAAS,EAAE,YAAY,EAAE,MAAM,UAAU,CAAC;AACtE,YAAY,EAAE,UAAU,EAAE,MAAM,kCAAkC,CAAC;AACnE,YAAY,EAAE,oBAAoB,EAAE,aAAa,EAAE,MAAM,4BAA4B,CAAC;AACtF,OAAO,EAAE,IAAI,EAAE,MAAM,4BAA4B,CAAC;AAClD,OAAO,EAAE,KAAK,EAAE,MAAM,6BAA6B,CAAC;AACpD,OAAO,EAAE,QAAQ,EAAE,MAAM,4BAA4B,CAAC;AACtD,OAAO,EAAE,QAAQ,EAAE,MAAM,8BAA8B,CAAC;AACxD,OAAO,EAAE,WAAW,EAAE,MAAM,kCAAkC,CAAC;AAC/D,YAAY,EAAE,YAAY,EAAE,MAAM,wBAAwB,CAAC;AAC3D,OAAO,EAAE,YAAY,EAAE,MAAM,yBAAyB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,YAAY,EAAE,YAAY,EAAE,eAAe,EAAE,SAAS,EAAE,YAAY,EAAE,MAAM,UAAU,CAAC;AACvF,YAAY,EAAE,UAAU,EAAE,MAAM,kCAAkC,CAAC;AACnE,YAAY,EAAE,oBAAoB,EAAE,aAAa,EAAE,MAAM,4BAA4B,CAAC;AACtF,OAAO,EAAE,IAAI,EAAE,MAAM,4BAA4B,CAAC;AAClD,OAAO,EAAE,KAAK,EAAE,MAAM,6BAA6B,CAAC;AACpD,OAAO,EAAE,QAAQ,EAAE,MAAM,4BAA4B,CAAC;AACtD,OAAO,EAAE,QAAQ,EAAE,MAAM,8BAA8B,CAAC;AACxD,OAAO,EAAE,WAAW,EAAE,MAAM,kCAAkC,CAAC;AAC/D,YAAY,EAAE,YAAY,EAAE,MAAM,wBAAwB,CAAC;AAC3D,OAAO,EAAE,YAAY,EAAE,MAAM,yBAAyB,CAAC"}