@sitecore-content-sdk/events 2.0.2-canary.4 → 2.0.2-canary.6
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/cjs/package.json +6 -5
- package/dist/cjs/src/events/page-view/bot-detection.js +47 -0
- package/dist/cjs/src/events/page-view/bot-page-view.js +35 -0
- package/dist/cjs/src/events/page-view/page-view.js +17 -1
- package/dist/cjs/src/index.js +3 -1
- package/dist/cjs/src/internal.js +4 -1
- package/dist/esm/package.json +6 -5
- package/dist/esm/src/events/page-view/bot-detection.js +41 -0
- package/dist/esm/src/events/page-view/bot-page-view.js +32 -0
- package/dist/esm/src/events/page-view/page-view.js +17 -1
- package/dist/esm/src/index.js +1 -0
- package/dist/esm/src/internal.js +1 -0
- package/package.json +6 -5
- package/types/src/events/page-view/bot-detection.d.ts +31 -0
- package/types/src/events/page-view/bot-detection.d.ts.map +1 -0
- package/types/src/events/page-view/bot-page-view.d.ts +10 -0
- package/types/src/events/page-view/bot-page-view.d.ts.map +1 -0
- package/types/src/events/page-view/page-view.d.ts +2 -1
- package/types/src/events/page-view/page-view.d.ts.map +1 -1
- package/types/src/index.d.ts +1 -0
- package/types/src/index.d.ts.map +1 -1
- package/types/src/internal.d.ts +1 -0
- package/types/src/internal.d.ts.map +1 -1
package/dist/cjs/package.json
CHANGED
|
@@ -7,9 +7,10 @@
|
|
|
7
7
|
"url": "https://github.com/Sitecore/content-sdk/issues"
|
|
8
8
|
},
|
|
9
9
|
"dependencies": {
|
|
10
|
-
"@sitecore-content-sdk/analytics-core": "2.0.2-canary.
|
|
11
|
-
"@sitecore-content-sdk/core": "2.0.2-canary.
|
|
12
|
-
"debug": "^4.4.3"
|
|
10
|
+
"@sitecore-content-sdk/analytics-core": "2.0.2-canary.6",
|
|
11
|
+
"@sitecore-content-sdk/core": "2.0.2-canary.6",
|
|
12
|
+
"debug": "^4.4.3",
|
|
13
|
+
"isbot": "^5.1.36"
|
|
13
14
|
},
|
|
14
15
|
"description": "Enables real-time, unified tracking to send events to Sitecore.",
|
|
15
16
|
"devDependencies": {
|
|
@@ -75,6 +76,6 @@
|
|
|
75
76
|
"api-extractor": "npm run build && api-extractor run --local --verbose",
|
|
76
77
|
"api-extractor:verify": "api-extractor run"
|
|
77
78
|
},
|
|
78
|
-
"version": "2.0.2-canary.
|
|
79
|
-
"gitHead": "
|
|
79
|
+
"version": "2.0.2-canary.6",
|
|
80
|
+
"gitHead": "3143d173f156eae8c7aaca5fdf3904d6fdc7c582"
|
|
80
81
|
}
|
|
@@ -0,0 +1,47 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.isBot = exports.BOT_CHANNEL = exports.BOT_DETECTION_COOKIE = void 0;
|
|
4
|
+
exports.isBrowserEnvironment = isBrowserEnvironment;
|
|
5
|
+
exports.getBotCookie = getBotCookie;
|
|
6
|
+
const isbot_1 = require("isbot");
|
|
7
|
+
const utils_1 = require("@sitecore-content-sdk/analytics-core/utils");
|
|
8
|
+
/**
|
|
9
|
+
* The cookie name for bot detection.
|
|
10
|
+
* @internal
|
|
11
|
+
*/
|
|
12
|
+
exports.BOT_DETECTION_COOKIE = 'sc_bot';
|
|
13
|
+
/**
|
|
14
|
+
* The channel name for bot tracking.
|
|
15
|
+
* @internal
|
|
16
|
+
*/
|
|
17
|
+
exports.BOT_CHANNEL = 'bot';
|
|
18
|
+
/**
|
|
19
|
+
* True when a browser `document` global is available (client / jsdom).
|
|
20
|
+
* Used so server-only code paths can be tested without mutating `document`.
|
|
21
|
+
* @internal
|
|
22
|
+
*/
|
|
23
|
+
function isBrowserEnvironment() {
|
|
24
|
+
return typeof document !== 'undefined';
|
|
25
|
+
}
|
|
26
|
+
/**
|
|
27
|
+
* A function that checks if visitor is a bot.
|
|
28
|
+
* @param {string} userAgent - The user agent of the visitor
|
|
29
|
+
* @returns {boolean} True if the visitor is a bot, false otherwise
|
|
30
|
+
* @internal
|
|
31
|
+
*/
|
|
32
|
+
const isBot = (userAgent) => {
|
|
33
|
+
return (0, isbot_1.isbot)(userAgent);
|
|
34
|
+
};
|
|
35
|
+
exports.isBot = isBot;
|
|
36
|
+
/**
|
|
37
|
+
* A function that gets the bot cookie.
|
|
38
|
+
* @returns {string | undefined} The value of the bot cookie, or undefined if the cookie is not found.
|
|
39
|
+
* Only available on the client-side.
|
|
40
|
+
* @internal
|
|
41
|
+
*/
|
|
42
|
+
function getBotCookie() {
|
|
43
|
+
var _a;
|
|
44
|
+
if (!isBrowserEnvironment())
|
|
45
|
+
return undefined;
|
|
46
|
+
return (_a = (0, utils_1.getCookie)(document.cookie, exports.BOT_DETECTION_COOKIE)) === null || _a === void 0 ? void 0 : _a.value;
|
|
47
|
+
}
|
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.botPageView = botPageView;
|
|
4
|
+
const internal_1 = require("@sitecore-content-sdk/analytics-core/internal");
|
|
5
|
+
const core_1 = require("@sitecore-content-sdk/core");
|
|
6
|
+
const plugin_1 = require("../../initialization/plugin");
|
|
7
|
+
const sendEvent_1 = require("../send-event/sendEvent");
|
|
8
|
+
const page_view_event_1 = require("./page-view-event");
|
|
9
|
+
const bot_detection_1 = require("./bot-detection");
|
|
10
|
+
/**
|
|
11
|
+
* Sends a VIEW event for server-side bot tracking (e.g. Next.js proxy / Edge).
|
|
12
|
+
* Uses a synthetic per-invocation client id and defaults `channel` to `bot`.
|
|
13
|
+
* Returns `null` in browser environments.
|
|
14
|
+
* @returns The response from Sitecore Edge Proxy, or `null` if skipped (browser).
|
|
15
|
+
* @public
|
|
16
|
+
*/
|
|
17
|
+
async function botPageView() {
|
|
18
|
+
if ((0, bot_detection_1.isBrowserEnvironment)()) {
|
|
19
|
+
return null;
|
|
20
|
+
}
|
|
21
|
+
const coreContext = (0, core_1.getCoreContext)();
|
|
22
|
+
await coreContext.readyPromise;
|
|
23
|
+
(0, plugin_1.getEventsPlugin)();
|
|
24
|
+
const { options, adapter } = (0, internal_1.getAnalyticsPlugin)();
|
|
25
|
+
const id = globalThis.crypto.randomUUID();
|
|
26
|
+
return new page_view_event_1.PageViewEvent({
|
|
27
|
+
id,
|
|
28
|
+
pageViewData: {
|
|
29
|
+
channel: bot_detection_1.BOT_CHANNEL,
|
|
30
|
+
},
|
|
31
|
+
searchParams: adapter.location.getSearchParams(),
|
|
32
|
+
sendEvent: sendEvent_1.sendEvent,
|
|
33
|
+
config: Object.assign(Object.assign({}, coreContext.config), options),
|
|
34
|
+
}).send();
|
|
35
|
+
}
|
|
@@ -6,14 +6,30 @@ const sendEvent_1 = require("../send-event/sendEvent");
|
|
|
6
6
|
const page_view_event_1 = require("./page-view-event");
|
|
7
7
|
const core_1 = require("@sitecore-content-sdk/core");
|
|
8
8
|
const plugin_1 = require("../../initialization/plugin");
|
|
9
|
+
const bot_detection_1 = require("./bot-detection");
|
|
10
|
+
/**
|
|
11
|
+
* A function that checks if the page view should be skipped.
|
|
12
|
+
* The page view is skipped if the visitor is a bot.
|
|
13
|
+
* @returns {boolean} True if the page view should be skipped, false otherwise
|
|
14
|
+
* @internal
|
|
15
|
+
*/
|
|
16
|
+
const shouldSkipPageView = () => {
|
|
17
|
+
const botCookie = (0, bot_detection_1.getBotCookie)();
|
|
18
|
+
if (botCookie)
|
|
19
|
+
return true;
|
|
20
|
+
return (0, bot_detection_1.isBot)(navigator.userAgent);
|
|
21
|
+
};
|
|
9
22
|
/**
|
|
10
23
|
* A function that sends a VIEW event to the SitecoreCloud API
|
|
11
24
|
* @param {PageViewData} [pageViewData] - The optional attributes to be sent to the SitecoreCloud API
|
|
12
|
-
* This object will be flattened and sent in the ext object of the payload
|
|
25
|
+
* This object will be flattened and sent in the ext object of the payload.
|
|
26
|
+
* The page view will be skipped if the visitor on the client-side is a bot.
|
|
13
27
|
* @returns The response object that Sitecore Edge Proxy returns
|
|
14
28
|
* @public
|
|
15
29
|
*/
|
|
16
30
|
async function pageView(pageViewData) {
|
|
31
|
+
if (shouldSkipPageView())
|
|
32
|
+
return null;
|
|
17
33
|
const coreContext = (0, core_1.getCoreContext)();
|
|
18
34
|
await coreContext.readyPromise;
|
|
19
35
|
(0, plugin_1.getEventsPlugin)();
|
package/dist/cjs/src/index.js
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
-
exports.eventsPlugin = exports.pageView = exports.identity = exports.event = exports.form = void 0;
|
|
3
|
+
exports.eventsPlugin = exports.botPageView = exports.pageView = exports.identity = exports.event = exports.form = void 0;
|
|
4
4
|
var form_1 = require("./events/custom-event/form");
|
|
5
5
|
Object.defineProperty(exports, "form", { enumerable: true, get: function () { return form_1.form; } });
|
|
6
6
|
var event_1 = require("./events/custom-event/event");
|
|
@@ -9,5 +9,7 @@ var identity_1 = require("./events/identity/identity");
|
|
|
9
9
|
Object.defineProperty(exports, "identity", { enumerable: true, get: function () { return identity_1.identity; } });
|
|
10
10
|
var page_view_1 = require("./events/page-view/page-view");
|
|
11
11
|
Object.defineProperty(exports, "pageView", { enumerable: true, get: function () { return page_view_1.pageView; } });
|
|
12
|
+
var bot_page_view_1 = require("./events/page-view/bot-page-view");
|
|
13
|
+
Object.defineProperty(exports, "botPageView", { enumerable: true, get: function () { return bot_page_view_1.botPageView; } });
|
|
12
14
|
var plugin_1 = require("./initialization/plugin");
|
|
13
15
|
Object.defineProperty(exports, "eventsPlugin", { enumerable: true, get: function () { return plugin_1.eventsPlugin; } });
|
package/dist/cjs/src/internal.js
CHANGED
|
@@ -1,8 +1,11 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
-
exports.PACKAGE_NAME = exports.PACKAGE_VERSION = exports.EVENTS_PLUGIN_NAME = void 0;
|
|
3
|
+
exports.BOT_DETECTION_COOKIE = exports.isBot = exports.PACKAGE_NAME = exports.PACKAGE_VERSION = exports.EVENTS_PLUGIN_NAME = void 0;
|
|
4
4
|
var const_1 = require("./initialization/const");
|
|
5
5
|
Object.defineProperty(exports, "EVENTS_PLUGIN_NAME", { enumerable: true, get: function () { return const_1.EVENTS_PLUGIN_NAME; } });
|
|
6
6
|
var consts_1 = require("./consts");
|
|
7
7
|
Object.defineProperty(exports, "PACKAGE_VERSION", { enumerable: true, get: function () { return consts_1.PACKAGE_VERSION; } });
|
|
8
8
|
Object.defineProperty(exports, "PACKAGE_NAME", { enumerable: true, get: function () { return consts_1.PACKAGE_NAME; } });
|
|
9
|
+
var bot_detection_1 = require("./events/page-view/bot-detection");
|
|
10
|
+
Object.defineProperty(exports, "isBot", { enumerable: true, get: function () { return bot_detection_1.isBot; } });
|
|
11
|
+
Object.defineProperty(exports, "BOT_DETECTION_COOKIE", { enumerable: true, get: function () { return bot_detection_1.BOT_DETECTION_COOKIE; } });
|
package/dist/esm/package.json
CHANGED
|
@@ -7,9 +7,10 @@
|
|
|
7
7
|
"url": "https://github.com/Sitecore/content-sdk/issues"
|
|
8
8
|
},
|
|
9
9
|
"dependencies": {
|
|
10
|
-
"@sitecore-content-sdk/analytics-core": "2.0.2-canary.
|
|
11
|
-
"@sitecore-content-sdk/core": "2.0.2-canary.
|
|
12
|
-
"debug": "^4.4.3"
|
|
10
|
+
"@sitecore-content-sdk/analytics-core": "2.0.2-canary.6",
|
|
11
|
+
"@sitecore-content-sdk/core": "2.0.2-canary.6",
|
|
12
|
+
"debug": "^4.4.3",
|
|
13
|
+
"isbot": "^5.1.36"
|
|
13
14
|
},
|
|
14
15
|
"description": "Enables real-time, unified tracking to send events to Sitecore.",
|
|
15
16
|
"devDependencies": {
|
|
@@ -75,6 +76,6 @@
|
|
|
75
76
|
"api-extractor": "npm run build && api-extractor run --local --verbose",
|
|
76
77
|
"api-extractor:verify": "api-extractor run"
|
|
77
78
|
},
|
|
78
|
-
"version": "2.0.2-canary.
|
|
79
|
-
"gitHead": "
|
|
79
|
+
"version": "2.0.2-canary.6",
|
|
80
|
+
"gitHead": "3143d173f156eae8c7aaca5fdf3904d6fdc7c582"
|
|
80
81
|
}
|
|
@@ -0,0 +1,41 @@
|
|
|
1
|
+
import { isbot } from 'isbot';
|
|
2
|
+
import { getCookie } from '@sitecore-content-sdk/analytics-core/utils';
|
|
3
|
+
/**
|
|
4
|
+
* The cookie name for bot detection.
|
|
5
|
+
* @internal
|
|
6
|
+
*/
|
|
7
|
+
export const BOT_DETECTION_COOKIE = 'sc_bot';
|
|
8
|
+
/**
|
|
9
|
+
* The channel name for bot tracking.
|
|
10
|
+
* @internal
|
|
11
|
+
*/
|
|
12
|
+
export const BOT_CHANNEL = 'bot';
|
|
13
|
+
/**
|
|
14
|
+
* True when a browser `document` global is available (client / jsdom).
|
|
15
|
+
* Used so server-only code paths can be tested without mutating `document`.
|
|
16
|
+
* @internal
|
|
17
|
+
*/
|
|
18
|
+
export function isBrowserEnvironment() {
|
|
19
|
+
return typeof document !== 'undefined';
|
|
20
|
+
}
|
|
21
|
+
/**
|
|
22
|
+
* A function that checks if visitor is a bot.
|
|
23
|
+
* @param {string} userAgent - The user agent of the visitor
|
|
24
|
+
* @returns {boolean} True if the visitor is a bot, false otherwise
|
|
25
|
+
* @internal
|
|
26
|
+
*/
|
|
27
|
+
export const isBot = (userAgent) => {
|
|
28
|
+
return isbot(userAgent);
|
|
29
|
+
};
|
|
30
|
+
/**
|
|
31
|
+
* A function that gets the bot cookie.
|
|
32
|
+
* @returns {string | undefined} The value of the bot cookie, or undefined if the cookie is not found.
|
|
33
|
+
* Only available on the client-side.
|
|
34
|
+
* @internal
|
|
35
|
+
*/
|
|
36
|
+
export function getBotCookie() {
|
|
37
|
+
var _a;
|
|
38
|
+
if (!isBrowserEnvironment())
|
|
39
|
+
return undefined;
|
|
40
|
+
return (_a = getCookie(document.cookie, BOT_DETECTION_COOKIE)) === null || _a === void 0 ? void 0 : _a.value;
|
|
41
|
+
}
|
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
import { getAnalyticsPlugin } from "@sitecore-content-sdk/analytics-core/internal";
|
|
2
|
+
import { getCoreContext } from "@sitecore-content-sdk/core";
|
|
3
|
+
import { getEventsPlugin } from "../../initialization/plugin";
|
|
4
|
+
import { sendEvent } from "../send-event/sendEvent";
|
|
5
|
+
import { PageViewEvent } from "./page-view-event";
|
|
6
|
+
import { BOT_CHANNEL, isBrowserEnvironment } from "./bot-detection";
|
|
7
|
+
/**
|
|
8
|
+
* Sends a VIEW event for server-side bot tracking (e.g. Next.js proxy / Edge).
|
|
9
|
+
* Uses a synthetic per-invocation client id and defaults `channel` to `bot`.
|
|
10
|
+
* Returns `null` in browser environments.
|
|
11
|
+
* @returns The response from Sitecore Edge Proxy, or `null` if skipped (browser).
|
|
12
|
+
* @public
|
|
13
|
+
*/
|
|
14
|
+
export async function botPageView() {
|
|
15
|
+
if (isBrowserEnvironment()) {
|
|
16
|
+
return null;
|
|
17
|
+
}
|
|
18
|
+
const coreContext = getCoreContext();
|
|
19
|
+
await coreContext.readyPromise;
|
|
20
|
+
getEventsPlugin();
|
|
21
|
+
const { options, adapter } = getAnalyticsPlugin();
|
|
22
|
+
const id = globalThis.crypto.randomUUID();
|
|
23
|
+
return new PageViewEvent({
|
|
24
|
+
id,
|
|
25
|
+
pageViewData: {
|
|
26
|
+
channel: BOT_CHANNEL,
|
|
27
|
+
},
|
|
28
|
+
searchParams: adapter.location.getSearchParams(),
|
|
29
|
+
sendEvent,
|
|
30
|
+
config: Object.assign(Object.assign({}, coreContext.config), options),
|
|
31
|
+
}).send();
|
|
32
|
+
}
|
|
@@ -3,14 +3,30 @@ import { sendEvent } from '../send-event/sendEvent';
|
|
|
3
3
|
import { PageViewEvent } from './page-view-event';
|
|
4
4
|
import { getCoreContext } from '@sitecore-content-sdk/core';
|
|
5
5
|
import { getEventsPlugin } from '../../initialization/plugin';
|
|
6
|
+
import { getBotCookie, isBot } from './bot-detection';
|
|
7
|
+
/**
|
|
8
|
+
* A function that checks if the page view should be skipped.
|
|
9
|
+
* The page view is skipped if the visitor is a bot.
|
|
10
|
+
* @returns {boolean} True if the page view should be skipped, false otherwise
|
|
11
|
+
* @internal
|
|
12
|
+
*/
|
|
13
|
+
const shouldSkipPageView = () => {
|
|
14
|
+
const botCookie = getBotCookie();
|
|
15
|
+
if (botCookie)
|
|
16
|
+
return true;
|
|
17
|
+
return isBot(navigator.userAgent);
|
|
18
|
+
};
|
|
6
19
|
/**
|
|
7
20
|
* A function that sends a VIEW event to the SitecoreCloud API
|
|
8
21
|
* @param {PageViewData} [pageViewData] - The optional attributes to be sent to the SitecoreCloud API
|
|
9
|
-
* This object will be flattened and sent in the ext object of the payload
|
|
22
|
+
* This object will be flattened and sent in the ext object of the payload.
|
|
23
|
+
* The page view will be skipped if the visitor on the client-side is a bot.
|
|
10
24
|
* @returns The response object that Sitecore Edge Proxy returns
|
|
11
25
|
* @public
|
|
12
26
|
*/
|
|
13
27
|
export async function pageView(pageViewData) {
|
|
28
|
+
if (shouldSkipPageView())
|
|
29
|
+
return null;
|
|
14
30
|
const coreContext = getCoreContext();
|
|
15
31
|
await coreContext.readyPromise;
|
|
16
32
|
getEventsPlugin();
|
package/dist/esm/src/index.js
CHANGED
|
@@ -2,4 +2,5 @@ export { form } from './events/custom-event/form';
|
|
|
2
2
|
export { event } from './events/custom-event/event';
|
|
3
3
|
export { identity } from './events/identity/identity';
|
|
4
4
|
export { pageView } from './events/page-view/page-view';
|
|
5
|
+
export { botPageView } from './events/page-view/bot-page-view';
|
|
5
6
|
export { eventsPlugin } from './initialization/plugin';
|
package/dist/esm/src/internal.js
CHANGED
package/package.json
CHANGED
|
@@ -7,9 +7,10 @@
|
|
|
7
7
|
"url": "https://github.com/Sitecore/content-sdk/issues"
|
|
8
8
|
},
|
|
9
9
|
"dependencies": {
|
|
10
|
-
"@sitecore-content-sdk/analytics-core": "2.0.2-canary.
|
|
11
|
-
"@sitecore-content-sdk/core": "2.0.2-canary.
|
|
12
|
-
"debug": "^4.4.3"
|
|
10
|
+
"@sitecore-content-sdk/analytics-core": "2.0.2-canary.6",
|
|
11
|
+
"@sitecore-content-sdk/core": "2.0.2-canary.6",
|
|
12
|
+
"debug": "^4.4.3",
|
|
13
|
+
"isbot": "^5.1.36"
|
|
13
14
|
},
|
|
14
15
|
"description": "Enables real-time, unified tracking to send events to Sitecore.",
|
|
15
16
|
"devDependencies": {
|
|
@@ -75,6 +76,6 @@
|
|
|
75
76
|
"api-extractor": "npm run build && api-extractor run --local --verbose",
|
|
76
77
|
"api-extractor:verify": "api-extractor run"
|
|
77
78
|
},
|
|
78
|
-
"version": "2.0.2-canary.
|
|
79
|
-
"gitHead": "
|
|
79
|
+
"version": "2.0.2-canary.6",
|
|
80
|
+
"gitHead": "3143d173f156eae8c7aaca5fdf3904d6fdc7c582"
|
|
80
81
|
}
|
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* The cookie name for bot detection.
|
|
3
|
+
* @internal
|
|
4
|
+
*/
|
|
5
|
+
export declare const BOT_DETECTION_COOKIE = "sc_bot";
|
|
6
|
+
/**
|
|
7
|
+
* The channel name for bot tracking.
|
|
8
|
+
* @internal
|
|
9
|
+
*/
|
|
10
|
+
export declare const BOT_CHANNEL = "bot";
|
|
11
|
+
/**
|
|
12
|
+
* True when a browser `document` global is available (client / jsdom).
|
|
13
|
+
* Used so server-only code paths can be tested without mutating `document`.
|
|
14
|
+
* @internal
|
|
15
|
+
*/
|
|
16
|
+
export declare function isBrowserEnvironment(): boolean;
|
|
17
|
+
/**
|
|
18
|
+
* A function that checks if visitor is a bot.
|
|
19
|
+
* @param {string} userAgent - The user agent of the visitor
|
|
20
|
+
* @returns {boolean} True if the visitor is a bot, false otherwise
|
|
21
|
+
* @internal
|
|
22
|
+
*/
|
|
23
|
+
export declare const isBot: (userAgent?: string | null) => boolean;
|
|
24
|
+
/**
|
|
25
|
+
* A function that gets the bot cookie.
|
|
26
|
+
* @returns {string | undefined} The value of the bot cookie, or undefined if the cookie is not found.
|
|
27
|
+
* Only available on the client-side.
|
|
28
|
+
* @internal
|
|
29
|
+
*/
|
|
30
|
+
export declare function getBotCookie(): string | undefined;
|
|
31
|
+
//# sourceMappingURL=bot-detection.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"bot-detection.d.ts","sourceRoot":"","sources":["../../../../src/events/page-view/bot-detection.ts"],"names":[],"mappings":"AAGA;;;GAGG;AACH,eAAO,MAAM,oBAAoB,WAAW,CAAC;AAE7C;;;GAGG;AACH,eAAO,MAAM,WAAW,QAAQ,CAAC;AAEjC;;;;GAIG;AACH,wBAAgB,oBAAoB,IAAI,OAAO,CAE9C;AAED;;;;;GAKG;AACH,eAAO,MAAM,KAAK,GAAI,YAAY,MAAM,GAAG,IAAI,KAAG,OAEjD,CAAC;AAEF;;;;;GAKG;AACH,wBAAgB,YAAY,IAAI,MAAM,GAAG,SAAS,CAIjD"}
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
import { type EPResponse } from "@sitecore-content-sdk/analytics-core/internal";
|
|
2
|
+
/**
|
|
3
|
+
* Sends a VIEW event for server-side bot tracking (e.g. Next.js proxy / Edge).
|
|
4
|
+
* Uses a synthetic per-invocation client id and defaults `channel` to `bot`.
|
|
5
|
+
* Returns `null` in browser environments.
|
|
6
|
+
* @returns The response from Sitecore Edge Proxy, or `null` if skipped (browser).
|
|
7
|
+
* @public
|
|
8
|
+
*/
|
|
9
|
+
export declare function botPageView(): Promise<EPResponse | null>;
|
|
10
|
+
//# sourceMappingURL=bot-page-view.d.ts.map
|
|
@@ -0,0 +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"}
|
|
@@ -3,7 +3,8 @@ import type { PageViewData } from './page-view-event';
|
|
|
3
3
|
/**
|
|
4
4
|
* A function that sends a VIEW event to the SitecoreCloud API
|
|
5
5
|
* @param {PageViewData} [pageViewData] - The optional attributes to be sent to the SitecoreCloud API
|
|
6
|
-
* This object will be flattened and sent in the ext object of the payload
|
|
6
|
+
* This object will be flattened and sent in the ext object of the payload.
|
|
7
|
+
* The page view will be skipped if the visitor on the client-side is a bot.
|
|
7
8
|
* @returns The response object that Sitecore Edge Proxy returns
|
|
8
9
|
* @public
|
|
9
10
|
*/
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"page-view.d.ts","sourceRoot":"","sources":["../../../../src/events/page-view/page-view.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,+CAA+C,CAAC;AAGhF,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;
|
|
1
|
+
{"version":3,"file":"page-view.d.ts","sourceRoot":"","sources":["../../../../src/events/page-view/page-view.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,+CAA+C,CAAC;AAGhF,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AAoBtD;;;;;;;GAOG;AACH,wBAAsB,QAAQ,CAAC,YAAY,CAAC,EAAE,YAAY,GAAG,OAAO,CAAC,UAAU,GAAG,IAAI,CAAC,CAkBtF"}
|
package/types/src/index.d.ts
CHANGED
|
@@ -5,6 +5,7 @@ export { form } from './events/custom-event/form';
|
|
|
5
5
|
export { event } from './events/custom-event/event';
|
|
6
6
|
export { identity } from './events/identity/identity';
|
|
7
7
|
export { pageView } from './events/page-view/page-view';
|
|
8
|
+
export { botPageView } from './events/page-view/bot-page-view';
|
|
8
9
|
export type { EventsPlugin } from './initialization/types';
|
|
9
10
|
export { eventsPlugin } from './initialization/plugin';
|
|
10
11
|
//# sourceMappingURL=index.d.ts.map
|
package/types/src/index.d.ts.map
CHANGED
|
@@ -1 +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,YAAY,EAAE,YAAY,EAAE,MAAM,wBAAwB,CAAC;AAC3D,OAAO,EAAE,YAAY,EAAE,MAAM,yBAAyB,CAAC"}
|
|
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"}
|
package/types/src/internal.d.ts
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"internal.d.ts","sourceRoot":"","sources":["../../src/internal.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAE,MAAM,wBAAwB,CAAC;AAC5D,OAAO,EAAE,eAAe,EAAE,YAAY,EAAE,MAAM,UAAU,CAAC"}
|
|
1
|
+
{"version":3,"file":"internal.d.ts","sourceRoot":"","sources":["../../src/internal.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAE,MAAM,wBAAwB,CAAC;AAC5D,OAAO,EAAE,eAAe,EAAE,YAAY,EAAE,MAAM,UAAU,CAAC;AACzD,OAAO,EAAE,KAAK,EAAE,oBAAoB,EAAE,MAAM,kCAAkC,CAAC"}
|