@sitecore-content-sdk/analytics-core 2.1.0-canary.10 → 2.1.0-canary.11

package/dist/cjs/package.json

@@ -7,7 +7,7 @@
         "url": "https://github.com/sitecore/content-sdk/issues"
     },
     "dependencies": {
-        "@sitecore-content-sdk/core": "2.1.0-canary.10",
+        "@sitecore-content-sdk/core": "2.1.0-canary.11",
         "debug": "^4.4.3",
         "isbot": "^5.1.39"
     },
@@ -74,6 +74,6 @@
         "api-extractor": "npm run build && api-extractor run --local --verbose",
         "api-extractor:verify": "api-extractor run"
     },
-    "version": "2.1.0-canary.10",
-    "gitHead": "f4f6bb8a4ac09e5d721e8a4a361c8ad980997e6c"
+    "version": "2.1.0-canary.11",
+    "gitHead": "c9e3b397b4f0402f6044dafd3dfd300070cd9dc1"
 }

package/dist/cjs/src/bot-detection/bot-detection.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.isBot = exports.BOT_DETECTION_COOKIE = void 0;
+exports.isBotServerSide = exports.isBotClientSide = exports.isBot = exports.BOT_DETECTION_COOKIE = void 0;
 exports.getBotCookieClientSide = getBotCookieClientSide;
 exports.getBotCookieServerSide = getBotCookieServerSide;
 const isbot_1 = require("isbot");
@@ -12,6 +12,7 @@ const utils_1 = require("../utils");
 exports.BOT_DETECTION_COOKIE = 'sc_bot';
 /**
  * A function that checks if visitor is a bot.
+ * Performs a check based on the user agent.
  * @param {string} userAgent - The user agent of the visitor
  * @returns {boolean} True if the visitor is a bot, false otherwise
  * @internal
@@ -20,6 +21,30 @@ const isBot = (userAgent) => {
     return (0, isbot_1.isbot)(userAgent);
 };
 exports.isBot = isBot;
+/**
+ * A function that checks if visitor is a bot.
+ * Performs a check based on the bot cookie and the user agent.
+ * Only available on the client-side.
+ * @returns {boolean} True if the visitor is a bot, false otherwise
+ * @internal
+ */
+const isBotClientSide = () => {
+    return !!getBotCookieClientSide() || (0, isbot_1.isbot)(navigator.userAgent);
+};
+exports.isBotClientSide = isBotClientSide;
+/**
+ * A function that checks if visitor is a bot.
+ * Performs a check based on the bot cookie and the user agent.
+ * Only available on the server-side.
+ * @param {string} cookie - The cookie string.
+ * @param {string} userAgent - The user agent of the visitor
+ * @returns {boolean} True if the visitor is a bot, false otherwise
+ * @internal
+ */
+const isBotServerSide = (cookie, userAgent) => {
+    return !!getBotCookieServerSide(cookie) || (0, isbot_1.isbot)(userAgent);
+};
+exports.isBotServerSide = isBotServerSide;
 /**
  * A function that gets the bot cookie.
  * @returns {string | undefined} The value of the bot cookie, or undefined if the cookie is not found.

package/dist/cjs/src/initialization/browser-adapter.js

@@ -18,8 +18,7 @@ function analyticsBrowserAdapter() {
     return {
         type: 'browser',
         isBot: () => {
-            const botCookie = (0, bot_detection_1.getBotCookieClientSide)();
-            return !!botCookie || (0, bot_detection_1.isBot)(navigator.userAgent);
+            return (0, bot_detection_1.isBotClientSide)();
         },
         getClientId: () => {
             return (0, utils_1.getCookieValueClientSide)((0, plugin_1.getAnalyticsPlugin)().options.cookies.name);

package/dist/cjs/src/initialization/server-adapter.js

@@ -21,8 +21,7 @@ function analyticsServerAdapter(request, response) {
     return {
         type: 'server',
         isBot: () => {
-            const botCookie = (0, bot_detection_1.getBotCookieServerSide)(request.headers.cookie);
-            return !!botCookie || (0, bot_detection_1.isBot)(request.headers['user-agent']);
+            return (0, bot_detection_1.isBotServerSide)(request.headers.cookie, request.headers['user-agent']);
         },
         getClientId: () => {
             return getClientId(request);

package/dist/cjs/src/internal.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.BOT_DETECTION_COOKIE = exports.getBotCookieClientSide = exports.getBotCookieServerSide = exports.isBot = exports.ANALYTICS_PLUGIN_NAME = exports.getAnalyticsPlugin = exports.fetchClientIdFromEdgeProxy = exports.CLIENT_ID_COOKIE_NAME = exports.CORRELATION_ID_HEADER = exports.LIBRARY_VERSION = exports.DEFAULT_COOKIE_EXPIRY_DAYS = exports.DAILY_SECONDS = exports.COOKIE_NAME_PREFIX = exports.API_VERSION = exports.generateCorrelationId = exports.pageName = exports.language = exports.getDefaultCookieAttributes = void 0;
+exports.BOT_DETECTION_COOKIE = exports.isBotServerSide = exports.isBotClientSide = exports.isBot = exports.ANALYTICS_PLUGIN_NAME = exports.getAnalyticsPlugin = exports.fetchClientIdFromEdgeProxy = exports.CLIENT_ID_COOKIE_NAME = exports.CORRELATION_ID_HEADER = exports.LIBRARY_VERSION = exports.DEFAULT_COOKIE_EXPIRY_DAYS = exports.DAILY_SECONDS = exports.COOKIE_NAME_PREFIX = exports.API_VERSION = exports.generateCorrelationId = exports.pageName = exports.language = exports.getDefaultCookieAttributes = void 0;
 var get_default_cookie_attributes_1 = require("./cookie/get-default-cookie-attributes");
 Object.defineProperty(exports, "getDefaultCookieAttributes", { enumerable: true, get: function () { return get_default_cookie_attributes_1.getDefaultCookieAttributes; } });
 var infer_1 = require("./infer/infer");
@@ -24,6 +24,6 @@ var const_1 = require("./initialization/const");
 Object.defineProperty(exports, "ANALYTICS_PLUGIN_NAME", { enumerable: true, get: function () { return const_1.ANALYTICS_PLUGIN_NAME; } });
 var bot_detection_1 = require("./bot-detection/bot-detection");
 Object.defineProperty(exports, "isBot", { enumerable: true, get: function () { return bot_detection_1.isBot; } });
-Object.defineProperty(exports, "getBotCookieServerSide", { enumerable: true, get: function () { return bot_detection_1.getBotCookieServerSide; } });
-Object.defineProperty(exports, "getBotCookieClientSide", { enumerable: true, get: function () { return bot_detection_1.getBotCookieClientSide; } });
+Object.defineProperty(exports, "isBotClientSide", { enumerable: true, get: function () { return bot_detection_1.isBotClientSide; } });
+Object.defineProperty(exports, "isBotServerSide", { enumerable: true, get: function () { return bot_detection_1.isBotServerSide; } });
 Object.defineProperty(exports, "BOT_DETECTION_COOKIE", { enumerable: true, get: function () { return bot_detection_1.BOT_DETECTION_COOKIE; } });

package/dist/esm/package.json

@@ -7,7 +7,7 @@
         "url": "https://github.com/sitecore/content-sdk/issues"
     },
     "dependencies": {
-        "@sitecore-content-sdk/core": "2.1.0-canary.10",
+        "@sitecore-content-sdk/core": "2.1.0-canary.11",
         "debug": "^4.4.3",
         "isbot": "^5.1.39"
     },
@@ -74,6 +74,6 @@
         "api-extractor": "npm run build && api-extractor run --local --verbose",
         "api-extractor:verify": "api-extractor run"
     },
-    "version": "2.1.0-canary.10",
-    "gitHead": "f4f6bb8a4ac09e5d721e8a4a361c8ad980997e6c"
+    "version": "2.1.0-canary.11",
+    "gitHead": "c9e3b397b4f0402f6044dafd3dfd300070cd9dc1"
 }

package/dist/esm/src/bot-detection/bot-detection.js

@@ -7,6 +7,7 @@ import { getCookieServerSide, getCookieValueClientSide } from '../utils';
 export const BOT_DETECTION_COOKIE = 'sc_bot';
 /**
  * A function that checks if visitor is a bot.
+ * Performs a check based on the user agent.
  * @param {string} userAgent - The user agent of the visitor
  * @returns {boolean} True if the visitor is a bot, false otherwise
  * @internal
@@ -14,6 +15,28 @@ export const BOT_DETECTION_COOKIE = 'sc_bot';
 export const isBot = (userAgent) => {
     return isbot(userAgent);
 };
+/**
+ * A function that checks if visitor is a bot.
+ * Performs a check based on the bot cookie and the user agent.
+ * Only available on the client-side.
+ * @returns {boolean} True if the visitor is a bot, false otherwise
+ * @internal
+ */
+export const isBotClientSide = () => {
+    return !!getBotCookieClientSide() || isbot(navigator.userAgent);
+};
+/**
+ * A function that checks if visitor is a bot.
+ * Performs a check based on the bot cookie and the user agent.
+ * Only available on the server-side.
+ * @param {string} cookie - The cookie string.
+ * @param {string} userAgent - The user agent of the visitor
+ * @returns {boolean} True if the visitor is a bot, false otherwise
+ * @internal
+ */
+export const isBotServerSide = (cookie, userAgent) => {
+    return !!getBotCookieServerSide(cookie) || isbot(userAgent);
+};
 /**
  * A function that gets the bot cookie.
  * @returns {string | undefined} The value of the bot cookie, or undefined if the cookie is not found.

package/dist/esm/src/initialization/browser-adapter.js

@@ -1,4 +1,4 @@
-import { getBotCookieClientSide, isBot } from '../bot-detection/bot-detection';
+import { isBotClientSide } from '../bot-detection/bot-detection';
 import { COOKIE_NAME_PREFIX, fetchClientIdFromEdgeProxy, getDefaultCookieAttributes, } from '../internal';
 import { createCookieString, getCookieValueClientSide } from '../utils';
 import { deleteCookie } from '../utils/cookies/delete-cookie';
@@ -15,8 +15,7 @@ export function analyticsBrowserAdapter() {
     return {
         type: 'browser',
         isBot: () => {
-            const botCookie = getBotCookieClientSide();
-            return !!botCookie || isBot(navigator.userAgent);
+            return isBotClientSide();
         },
         getClientId: () => {
             return getCookieValueClientSide(getAnalyticsPlugin().options.cookies.name);

package/dist/esm/src/initialization/server-adapter.js

@@ -1,4 +1,4 @@
-import { getBotCookieServerSide, isBot } from '../bot-detection/bot-detection';
+import { isBotServerSide } from '../bot-detection/bot-detection';
 import { COOKIE_NAME_PREFIX, fetchClientIdFromEdgeProxy, getDefaultCookieAttributes, } from '../internal';
 import { createCookieString, getCookieServerSide } from '../utils';
 import { getAnalyticsPlugin } from './plugin';
@@ -18,8 +18,7 @@ export function analyticsServerAdapter(request, response) {
     return {
         type: 'server',
         isBot: () => {
-            const botCookie = getBotCookieServerSide(request.headers.cookie);
-            return !!botCookie || isBot(request.headers['user-agent']);
+            return isBotServerSide(request.headers.cookie, request.headers['user-agent']);
         },
         getClientId: () => {
             return getClientId(request);

package/dist/esm/src/internal.js

@@ -5,4 +5,4 @@ export { API_VERSION, COOKIE_NAME_PREFIX, DAILY_SECONDS, DEFAULT_COOKIE_EXPIRY_D
 export { fetchClientIdFromEdgeProxy } from './client-id/fetch-client-id-from-edge-proxy';
 export { getAnalyticsPlugin } from './initialization/plugin';
 export { ANALYTICS_PLUGIN_NAME } from './initialization/const';
-export { isBot, getBotCookieServerSide, getBotCookieClientSide, BOT_DETECTION_COOKIE } from './bot-detection/bot-detection';
+export { isBot, isBotClientSide, isBotServerSide, BOT_DETECTION_COOKIE } from './bot-detection/bot-detection';

package/package.json

@@ -7,7 +7,7 @@
     "url": "https://github.com/sitecore/content-sdk/issues"
   },
   "dependencies": {
-    "@sitecore-content-sdk/core": "2.1.0-canary.10",
+    "@sitecore-content-sdk/core": "2.1.0-canary.11",
     "debug": "^4.4.3",
     "isbot": "^5.1.39"
   },
@@ -74,6 +74,6 @@
     "api-extractor": "npm run build && api-extractor run --local --verbose",
     "api-extractor:verify": "api-extractor run"
   },
-  "version": "2.1.0-canary.10",
-  "gitHead": "f4f6bb8a4ac09e5d721e8a4a361c8ad980997e6c"
+  "version": "2.1.0-canary.11",
+  "gitHead": "c9e3b397b4f0402f6044dafd3dfd300070cd9dc1"
 }

package/types/src/bot-detection/bot-detection.d.ts

@@ -5,11 +5,30 @@
 export declare const BOT_DETECTION_COOKIE = "sc_bot";
 /**
  * A function that checks if visitor is a bot.
+ * Performs a check based on the user agent.
  * @param {string} userAgent - The user agent of the visitor
  * @returns {boolean} True if the visitor is a bot, false otherwise
  * @internal
  */
 export declare const isBot: (userAgent?: string | null) => boolean;
+/**
+ * A function that checks if visitor is a bot.
+ * Performs a check based on the bot cookie and the user agent.
+ * Only available on the client-side.
+ * @returns {boolean} True if the visitor is a bot, false otherwise
+ * @internal
+ */
+export declare const isBotClientSide: () => boolean;
+/**
+ * A function that checks if visitor is a bot.
+ * Performs a check based on the bot cookie and the user agent.
+ * Only available on the server-side.
+ * @param {string} cookie - The cookie string.
+ * @param {string} userAgent - The user agent of the visitor
+ * @returns {boolean} True if the visitor is a bot, false otherwise
+ * @internal
+ */
+export declare const isBotServerSide: (cookie?: string, userAgent?: string | null) => boolean;
 /**
  * A function that gets the bot cookie.
  * @returns {string | undefined} The value of the bot cookie, or undefined if the cookie is not found.

package/types/src/bot-detection/bot-detection.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"bot-detection.d.ts","sourceRoot":"","sources":["../../../src/bot-detection/bot-detection.ts"],"names":[],"mappings":"AAGA;;;GAGG;AACH,eAAO,MAAM,oBAAoB,WAAW,CAAC;AAE7C;;;;;GAKG;AACH,eAAO,MAAM,KAAK,GAAI,YAAY,MAAM,GAAG,IAAI,KAAG,OAEjD,CAAC;AAEF;;;;;GAKG;AACH,wBAAgB,sBAAsB,IAAI,MAAM,GAAG,SAAS,CAE3D;AAED;;;;;GAKG;AACH,wBAAgB,sBAAsB,CAAC,MAAM,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAE1E"}
+{"version":3,"file":"bot-detection.d.ts","sourceRoot":"","sources":["../../../src/bot-detection/bot-detection.ts"],"names":[],"mappings":"AAGA;;;GAGG;AACH,eAAO,MAAM,oBAAoB,WAAW,CAAC;AAE7C;;;;;;GAMG;AACH,eAAO,MAAM,KAAK,GAAI,YAAY,MAAM,GAAG,IAAI,KAAG,OAEjD,CAAC;AAEF;;;;;;GAMG;AACH,eAAO,MAAM,eAAe,QAAO,OAElC,CAAC;AAEF;;;;;;;;GAQG;AACH,eAAO,MAAM,eAAe,GAAI,SAAS,MAAM,EAAE,YAAY,MAAM,GAAG,IAAI,KAAG,OAE5E,CAAC;AAEF;;;;;GAKG;AACH,wBAAgB,sBAAsB,IAAI,MAAM,GAAG,SAAS,CAE3D;AAED;;;;;GAKG;AACH,wBAAgB,sBAAsB,CAAC,MAAM,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAE1E"}

package/types/src/initialization/browser-adapter.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"browser-adapter.d.ts","sourceRoot":"","sources":["../../../src/initialization/browser-adapter.ts"],"names":[],"mappings":"AASA,OAAO,EAAE,gBAAgB,EAAE,MAAM,SAAS,CAAC;AAG3C;;;GAGG;AACH,MAAM,WAAW,uBAAwB,SAAQ,gBAAgB;IAC/D;;OAEG;IACH,IAAI,EAAE,SAAS,CAAC;CACjB;AAED;;;;;;GAMG;AACH,wBAAgB,uBAAuB,IAAI,uBAAuB,CAkDjE"}
+{"version":3,"file":"browser-adapter.d.ts","sourceRoot":"","sources":["../../../src/initialization/browser-adapter.ts"],"names":[],"mappings":"AASA,OAAO,EAAE,gBAAgB,EAAE,MAAM,SAAS,CAAC;AAG3C;;;GAGG;AACH,MAAM,WAAW,uBAAwB,SAAQ,gBAAgB;IAC/D;;OAEG;IACH,IAAI,EAAE,SAAS,CAAC;CACjB;AAED;;;;;;GAMG;AACH,wBAAgB,uBAAuB,IAAI,uBAAuB,CAiDjE"}

package/types/src/initialization/server-adapter.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"server-adapter.d.ts","sourceRoot":"","sources":["../../../src/initialization/server-adapter.ts"],"names":[],"mappings":"AAQA,OAAO,EAAE,gBAAgB,EAAE,MAAM,SAAS,CAAC;AAE3C,OAAO,KAAK,EAAE,eAAe,EAAE,eAAe,EAAE,MAAM,MAAM,CAAC;AAE7D;;;GAGG;AACH,MAAM,WAAW,sBAAuB,SAAQ,gBAAgB;IAC9D;;OAEG;IACH,IAAI,EAAE,QAAQ,CAAC;CAChB;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,sBAAsB,CACpC,OAAO,SAAS,eAAe,EAC/B,QAAQ,SAAS,eAAe,EAChC,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,QAAQ,GAAG,sBAAsB,CAqF9D"}
+{"version":3,"file":"server-adapter.d.ts","sourceRoot":"","sources":["../../../src/initialization/server-adapter.ts"],"names":[],"mappings":"AAQA,OAAO,EAAE,gBAAgB,EAAE,MAAM,SAAS,CAAC;AAE3C,OAAO,KAAK,EAAE,eAAe,EAAE,eAAe,EAAE,MAAM,MAAM,CAAC;AAE7D;;;GAGG;AACH,MAAM,WAAW,sBAAuB,SAAQ,gBAAgB;IAC9D;;OAEG;IACH,IAAI,EAAE,QAAQ,CAAC;CAChB;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,sBAAsB,CACpC,OAAO,SAAS,eAAe,EAC/B,QAAQ,SAAS,eAAe,EAChC,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,QAAQ,GAAG,sBAAsB,CAoF9D"}

package/types/src/internal.d.ts

@@ -9,5 +9,5 @@ export { ANALYTICS_PLUGIN_NAME } from './initialization/const';
 export type { AnalyticsPlugin } from './initialization/types';
 export { AnalyticsAdapter, AnalyticsOptions } from './initialization/types';
 export type { VisitorIds } from './interfaces';
-export { isBot, getBotCookieServerSide, getBotCookieClientSide, BOT_DETECTION_COOKIE } from './bot-detection/bot-detection';
+export { isBot, isBotClientSide, isBotServerSide, BOT_DETECTION_COOKIE } from './bot-detection/bot-detection';
 //# sourceMappingURL=internal.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"internal.d.ts","sourceRoot":"","sources":["../../src/internal.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,0BAA0B,EAAE,MAAM,wCAAwC,CAAC;AAEpF,OAAO,EAAE,QAAQ,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AACnD,OAAO,EAAE,qBAAqB,EAAE,MAAM,0CAA0C,CAAC;AAEjF,OAAO,EACL,WAAW,EACX,kBAAkB,EAClB,aAAa,EACb,0BAA0B,EAC1B,eAAe,EACf,qBAAqB,EACrB,qBAAqB,GACtB,MAAM,UAAU,CAAC;AAGlB,YAAY,EAAE,UAAU,EAAE,KAAK,EAAE,MAAM,cAAc,CAAC;AAEtD,OAAO,EAAE,0BAA0B,EAAE,MAAM,6CAA6C,CAAC;AACzF,OAAO,EAAE,kBAAkB,EAAE,MAAM,yBAAyB,CAAC;AAC7D,OAAO,EAAE,qBAAqB,EAAE,MAAM,wBAAwB,CAAC;AAC/D,YAAY,EAAE,eAAe,EAAE,MAAM,wBAAwB,CAAC;AAC9D,OAAO,EAAE,gBAAgB,EAAE,gBAAgB,EAAE,MAAM,wBAAwB,CAAC;AAC5E,YAAY,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAE/C,OAAO,EAAE,KAAK,EAAE,sBAAsB,EAAE,sBAAsB,EAAE,oBAAoB,EAAE,MAAM,+BAA+B,CAAC"}
+{"version":3,"file":"internal.d.ts","sourceRoot":"","sources":["../../src/internal.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,0BAA0B,EAAE,MAAM,wCAAwC,CAAC;AAEpF,OAAO,EAAE,QAAQ,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AACnD,OAAO,EAAE,qBAAqB,EAAE,MAAM,0CAA0C,CAAC;AAEjF,OAAO,EACL,WAAW,EACX,kBAAkB,EAClB,aAAa,EACb,0BAA0B,EAC1B,eAAe,EACf,qBAAqB,EACrB,qBAAqB,GACtB,MAAM,UAAU,CAAC;AAGlB,YAAY,EAAE,UAAU,EAAE,KAAK,EAAE,MAAM,cAAc,CAAC;AAEtD,OAAO,EAAE,0BAA0B,EAAE,MAAM,6CAA6C,CAAC;AACzF,OAAO,EAAE,kBAAkB,EAAE,MAAM,yBAAyB,CAAC;AAC7D,OAAO,EAAE,qBAAqB,EAAE,MAAM,wBAAwB,CAAC;AAC/D,YAAY,EAAE,eAAe,EAAE,MAAM,wBAAwB,CAAC;AAC9D,OAAO,EAAE,gBAAgB,EAAE,gBAAgB,EAAE,MAAM,wBAAwB,CAAC;AAC5E,YAAY,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAE/C,OAAO,EAAE,KAAK,EAAE,eAAe,EAAE,eAAe,EAAE,oBAAoB,EAAE,MAAM,+BAA+B,CAAC"}