@schibsted/pulse-sdk 8.0.0-alpha.16 → 8.0.0-alpha.18

package/dist/cjs/getPulseTracker.js

@@ -0,0 +1,74 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getPulseTracker = getPulseTracker;
+/**
+ * Event name dispatched when the Pulse Tracker instance is ready.
+ * It includes the "pulse:" namespace to avoid potential conflicts with other libraries.
+ */
+const PULSE_TRACKER_READY_EVENT = 'pulse:tracker:ready';
+/**
+ * Flags whether the code is running in a browser environment.
+ * Required to safely access the `window` object.
+ * @privateRemarks
+ * Reimplemented here to avoid dependencies on other parts of the SDK.
+ */
+const isBrowser = typeof window !== 'undefined' && typeof window.document !== 'undefined';
+/**
+ * Timeout for getting the Pulse Tracker instance.
+ * Arbitrarily defined to avoid hanging indefinitely, which would be a sign of misconfiguration.
+ */
+const GET_PULSE_TRACKER_TIMEOUT_MS = 3000;
+/**
+ * Returns the singleton Pulse Tracker instance.
+ * @throws - If the Pulse Tracker creation did not resolve within the timeout limit.
+ * @throws - If called outside a browser environment.
+ *
+ * @example
+ *
+ * ```ts
+ * import { getPulseTracker, type Tracker } from '@schibsted/pulse-sdk-js';
+ *
+ * let pulseTracker: Promise<Tracker>;
+ *
+ * try {
+ *  pulseTracker = await getPulseTracker();
+ * } catch(error) {
+ *   // not in browser environment
+ *   // or
+ *   // tracker not resolved within time limit
+ * }
+ *
+ * if (pulseTracker) {
+ *   pulseTracker.trackViewPage({ ... });
+ * }
+ * ```
+ */
+async function getPulseTracker() {
+    if (!isBrowser) {
+        throw new Error('getPulseTracker is only available in browser environments');
+    }
+    const singleton = window.__pulseTracker;
+    if (!(singleton instanceof Promise)) {
+        return new Promise((resolve, reject) => {
+            let timeoutId;
+            function trackerReadyHandler(event) {
+                clearTimeout(timeoutId);
+                window.removeEventListener(PULSE_TRACKER_READY_EVENT, trackerReadyHandler);
+                resolve(event.detail.payload.tracker);
+            }
+            timeoutId = setTimeout(() => {
+                window.removeEventListener(PULSE_TRACKER_READY_EVENT, trackerReadyHandler);
+                reject(new Error(`Pulse Tracker did not resolve within ${GET_PULSE_TRACKER_TIMEOUT_MS}ms`));
+            }, GET_PULSE_TRACKER_TIMEOUT_MS);
+            window.addEventListener(PULSE_TRACKER_READY_EVENT, trackerReadyHandler);
+        });
+    }
+    return Promise.race([
+        singleton,
+        new Promise((_, reject) => {
+            setTimeout(() => {
+                reject(new Error(`Pulse Tracker did not resolve within ${GET_PULSE_TRACKER_TIMEOUT_MS}ms`));
+            }, GET_PULSE_TRACKER_TIMEOUT_MS);
+        }),
+    ]);
+}

package/dist/cjs/identity/actor.js

@@ -0,0 +1,60 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.evaluateActor = exports.userIsLoggedIn = exports.getActor = exports.getUserId = exports.WARN_CIS_SYNC_LOGIN_UNDEFINED = void 0;
+const pulse_utils_1 = require("@schibsted/pulse-utils");
+const actor_1 = require("../builders/actor");
+const warnOnce_1 = __importDefault(require("../warnOnce"));
+/**
+ * @internal exported for testing
+ */
+exports.WARN_CIS_SYNC_LOGIN_UNDEFINED = 'Cis sync initiated with no actor builder and no event available. If you do not use a login system, please indicate' +
+    ' this using tracker.update({ actor: undefined }), otherwise do tracker.update({ actor: somePromise }) with a' +
+    ' promise that resolves to the login state.';
+/**
+ * Get the actor id (userId) from the current browser. A promise is returned
+ * because a call may be made to complete the login process.
+ *
+ * *Note*: This method will return a Promise that is always rejected on node
+ environments.
+ @category Identifiers
+ */
+const getUserId = async (builders) => {
+    const { id } = await getActor(builders);
+    return id;
+};
+exports.getUserId = getUserId;
+/**
+ * @category Identifiers
+ */
+const getActor = async (builders) => {
+    return await evaluateActor(builders);
+};
+exports.getActor = getActor;
+const userIsLoggedIn = async (builders) => {
+    const actor = await getActor(builders);
+    return !!actor?.id;
+};
+exports.userIsLoggedIn = userIsLoggedIn;
+/**
+ * Evaluate actor input given to the sdk/this method and pass it through the
+ * Actor event formatter.
+ * @category Tracker
+ * @private
+ */
+const evaluateActor = async (eventInput = {}, builders = {}) => {
+    if ((0, actor_1.isActorInput)(eventInput) || (0, actor_1.isActorInput)(builders)) {
+        const evaluatedActor = await (0, pulse_utils_1.evaluateAndFlatten)(eventInput.actor || builders.actor);
+        if (evaluatedActor) {
+            return evaluatedActor;
+        }
+    }
+    // We allow an empty actor object, because it is a sign that the application is not setting nor updating Actor correctly.
+    // Inferring "id: undefined" as a fallback would mask that bug.
+    // Hence, the warning below.
+    (0, warnOnce_1.default)('no-actor-builder-and-no-event-present', exports.WARN_CIS_SYNC_LOGIN_UNDEFINED);
+    return {};
+};
+exports.evaluateActor = evaluateActor;

package/dist/cjs/identity/advertising.js

@@ -0,0 +1,62 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getAdvertisingIdentifiers = exports.getIncludeAdvertising = exports.getAdId = void 0;
+const actor_1 = require("./actor");
+const cis_1 = require("./cis");
+/**
+ * Get the includeAdvertising flag, set on initialisation.
+ * @private
+ * @see constructor
+ * @category Identifiers
+ * @deprecated Advertising Identifiers methods will be removed in the next major version.
+ */
+const getIncludeAdvertising = (sdkState) => {
+    return sdkState.includeAdvertising;
+};
+exports.getIncludeAdvertising = getIncludeAdvertising;
+/**
+ * Get the advertisement id (adId) from the current browser. A promise is returned
+ * because a CIS call is done to generate a new adId if no cookie is
+ * found.
+ *
+ * *Note*: This method will return a Promise that is always rejected on node
+ * environments.
+ * @category Identifiers
+ * @deprecated Advertising Identifiers methods will be removed in the next major version.
+ */
+const getAdId = async (builders, sdkState) => {
+    const { adId } = await (0, cis_1.cisSync)({ actor: (0, actor_1.getActor)(builders) }, builders, sdkState);
+    return adId;
+};
+exports.getAdId = getAdId;
+/**
+ * Get the Advertisement Identifiers for a Vendor or all Vendors.
+ * @param builders
+ * @param sdkState
+ * @category Identifiers
+ * @deprecated Advertising Identifiers methods will be removed in the next major version.
+ */
+const getAdvertisingIdentifiers = async (builders, sdkState) => {
+    const { vendors } = sdkState;
+    if (!Array.isArray(vendors)) {
+        throw new Error("'vendors' given is not an array as expected");
+    }
+    const { adId, ppId } = await (0, cis_1.cisSync)({ actor: (0, actor_1.getActor)(builders) }, builders, sdkState);
+    const identifiers = {};
+    if (!ppId) {
+        return {};
+    }
+    for (const vendorName of vendors) {
+        const vendor = ppId[vendorName];
+        if (vendor) {
+            if (vendorName === 'xandr' && adId) {
+                identifiers[vendorName] = { ...vendor, adId };
+            }
+            else {
+                identifiers[vendorName] = vendor;
+            }
+        }
+    }
+    return identifiers;
+};
+exports.getAdvertisingIdentifiers = getAdvertisingIdentifiers;

package/dist/cjs/identity/cis.js

@@ -0,0 +1,66 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.requireCisSyncCallForAdvertisingIds = exports.cisSync = exports.clearCookieJweIfStale = void 0;
+const pulse_cis_sync_1 = require("@schibsted/pulse-cis-sync");
+Object.defineProperty(exports, "clearCookieJweIfStale", { enumerable: true, get: function () { return pulse_cis_sync_1.clearCookieJweIfStale; } });
+const version_json_1 = __importDefault(require("../version.json"));
+const actor_1 = require("./actor");
+const requireCisSyncCallForAdvertisingIds = () => {
+    (0, pulse_cis_sync_1.resetRefreshAfter)(new Date());
+};
+exports.requireCisSyncCallForAdvertisingIds = requireCisSyncCallForAdvertisingIds;
+/**
+ * Sync our ids with cis given the userId from the event or builders.
+ * @param data the event parameters (the data passed to `.track()`),
+ * if called in a context where an event is being sent.
+ *
+ * @param builders
+ * @param config
+ * @returns the parsed pulse cookie after syncing with cis.
+ * @category Identifiers
+ */
+const cisSync = async (data, builders, config) => {
+    // At this point, neither this.builders nor data have been
+    // evaluated through evaluateAndFlatten (this happens in `.track`),
+    // so in the rare and weird case where `.actor` is a function or
+    // a promise, or contains functions or promises, we will evaluate
+    // these twice.
+    // Note that this evaluation isn't 100% correct in that it ignores
+    // things like eventDefaults, doesn't call the event builder associated
+    // with the event type etc., but this shouldn't affect `.actor.{id,realm}`
+    // in cases I can imagine (of course, my imagination is limited)
+    //
+    // we need an event, or at least this.builders.actor
+    // to know the correct login/logout state for the user.
+    // In some implementations (video plugin) the client will
+    // populate the full event only on `.track` and not ever
+    // call `.update(...)` with the login status.
+    // Arguably this is incorrect, and `.update(...)` should be
+    // called when login state changes, but we try to make
+    // the API as fail-proof as possibly by handling the situation
+    // here.
+    //
+    // However, we do cis syncs without access to an event, so
+    // for this case, we need to just reuse the userId from the existing
+    // _pulse2data cookie, or just not do the sync.
+    //
+    const actorPromise = (0, actor_1.evaluateActor)(data, builders);
+    const { cisBaseUrl, cisEnabled, includeAdvertising: includeAdvertisingPromise, isHybrid, nativeJwe, providerId, trackerId, vendors, } = config || {};
+    const [includeAdvertising, actor] = await Promise.all([includeAdvertisingPromise, actorPromise]);
+    const { id, realm } = actor;
+    if (cisEnabled) {
+        // @ts-expect-error
+        return (0, pulse_cis_sync_1.syncWithCis)(
+        // @ts-expect-error
+        id, nativeJwe, cisBaseUrl, realm, providerId, isHybrid ? 'Hybrid' : 'Web', version_json_1.default.SDK_VERSION, {
+            includeAdvertising,
+            vendors,
+            trackerId,
+        });
+    }
+    return { doTracking: true };
+};
+exports.cisSync = cisSync;

package/dist/cjs/identity/device.js

@@ -0,0 +1,20 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getEnvironmentId = void 0;
+const actor_1 = require("./actor");
+const cis_1 = require("./cis");
+/**
+ * Get the environment id from the current browser. A promise is returned
+ * because a CIS call is done to generate a new environmentId if no cookie is
+ * found.
+ *
+ * *Note*: This method will return a Promise that is always rejected on node
+ * environments.
+ * @category Identifiers
+ */
+const getEnvironmentId = async (builders, sdkState) => {
+    const actor = await (0, actor_1.getActor)(builders);
+    const { environmentId } = await (0, cis_1.cisSync)({ actor }, builders, sdkState);
+    return environmentId;
+};
+exports.getEnvironmentId = getEnvironmentId;

package/dist/cjs/identity/index.js

@@ -0,0 +1,20 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./actor"), exports);
+__exportStar(require("./advertising"), exports);
+__exportStar(require("./cis"), exports);
+__exportStar(require("./device"), exports);

package/dist/cjs/index.js

@@ -0,0 +1,57 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.unsubscribe = exports.subscribeWithState = exports.subscribeOnce = exports.subscribe = exports.getPulseTracker = exports.createPulseTracker = exports.Tracker = exports.EventBuilders = void 0;
+const Tracker_1 = __importDefault(require("./Tracker"));
+exports.Tracker = Tracker_1.default;
+exports.default = Tracker_1.default;
+exports.EventBuilders = __importStar(require("./builders"));
+__exportStar(require("./Tracker"), exports);
+__exportStar(require("@schibsted/tpaas-schemas"), exports);
+var createPulseTracker_1 = require("./createPulseTracker");
+Object.defineProperty(exports, "createPulseTracker", { enumerable: true, get: function () { return createPulseTracker_1.createPulseTracker; } });
+var getPulseTracker_1 = require("./getPulseTracker");
+Object.defineProperty(exports, "getPulseTracker", { enumerable: true, get: function () { return getPulseTracker_1.getPulseTracker; } });
+var Tracker_2 = require("./Tracker");
+Object.defineProperty(exports, "subscribe", { enumerable: true, get: function () { return Tracker_2.subscribe; } });
+Object.defineProperty(exports, "subscribeOnce", { enumerable: true, get: function () { return Tracker_2.subscribeOnce; } });
+Object.defineProperty(exports, "subscribeWithState", { enumerable: true, get: function () { return Tracker_2.subscribeWithState; } });
+Object.defineProperty(exports, "unsubscribe", { enumerable: true, get: function () { return Tracker_2.unsubscribe; } });

package/dist/cjs/leaveTracking/constants.js

@@ -0,0 +1,26 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DEFAULT_LEAVE_EVENT_BUILDER = exports.DEFAULT_PAGE_LEAVE_EVENT = exports.DEFAULT_VIEWED_CONTENT = exports.DEFAULT_ACTIVITY_DURATION = void 0;
+const LEAVE_EVENT_TYPE = 'Leave';
+const DEFAULT_ACTIVITY_DURATION = () => ({
+    value: 0,
+    interval: undefined,
+    timeSinceLastActivity: 0,
+});
+exports.DEFAULT_ACTIVITY_DURATION = DEFAULT_ACTIVITY_DURATION;
+const DEFAULT_VIEWED_CONTENT = () => ({
+    objectViewPercentage: 0,
+    maxObjectViewPercentage: 0,
+    pageViewPercentage: 0,
+    maxPageViewPercentage: 0,
+    pageScrollPosition: 0,
+    maxPageScrollPosition: 0,
+});
+exports.DEFAULT_VIEWED_CONTENT = DEFAULT_VIEWED_CONTENT;
+const DEFAULT_PAGE_LEAVE_EVENT = () => ({
+    type: LEAVE_EVENT_TYPE,
+    engagement: (0, exports.DEFAULT_VIEWED_CONTENT)(),
+});
+exports.DEFAULT_PAGE_LEAVE_EVENT = DEFAULT_PAGE_LEAVE_EVENT;
+const DEFAULT_LEAVE_EVENT_BUILDER = () => () => ({});
+exports.DEFAULT_LEAVE_EVENT_BUILDER = DEFAULT_LEAVE_EVENT_BUILDER;