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

package/dist/ejs/config-browser.js

@@ -0,0 +1,23 @@
+export const collectorEndpoints = {
+    dev: 'https://collector.pulse-internal-dev.schibsted.io',
+    pre: 'https://collector.pulse-internal-pre.schibsted.io',
+    pro: 'https://dc.schibsted.io',
+};
+export const CISEndpoints = {
+    dev: 'https://cis.pulse-internal-dev.schibsted.io',
+    pre: 'https://cis.pulse-internal-pre.schibsted.io',
+    pro: 'https://ncis.schibsted.com',
+};
+export const remoteConfig = {
+    dev: 'https://sdkconfig.pulse-internal-dev.schibsted.io/js/config.json',
+    pre: 'https://sdkconfig.pulse-internal-pre.schibsted.io/js/config.json',
+    pro: 'https://sdkconfig.pulse.schibsted.io/js/config.json',
+};
+export const baseConfig = {
+    cisEnabled: true,
+    deployStage: 'pro',
+    eventDebounce: 200,
+    environment: 'browser',
+    collectorPath: '/api/v1/track',
+    useBeaconWhenAvailable: true,
+};

package/dist/ejs/config.js

@@ -0,0 +1,6 @@
+export const baseConfig = {
+    eventDebounce: 10,
+    environment: 'node',
+    cisEnabled: true,
+    collectorPath: '/api/v1/content',
+};

package/dist/ejs/createPulseTracker.js

@@ -0,0 +1,44 @@
+/**
+ * @module createPulseTracker
+ * This module is part of the Pulse SDK implementation of Schibsted's Mandatory Building Blocks (MBB) specification.
+ * It is intended to simplify the creation and management of a singleton Pulse Tracker instance in browser environments.
+ * Note that this module should only be used in browser environments, as it relies on the global `window` object.
+ */
+import { isBrowser } from '@schibsted/pulse-utils/';
+import Tracker from './Tracker';
+/**
+ * Flags whether the Pulse Tracker creation process has been started.
+ */
+function isTrackerCreated() {
+    return isBrowser && !!window.__pulseTracker;
+}
+/**
+ * Make the given tracker instance globally accessible
+ * @param singleton
+ */
+function attachTrackerToWindow(singleton) {
+    if (isBrowser) {
+        window.__pulseTracker = singleton;
+    }
+}
+/**
+ * Creates and returns the singleton Pulse Tracker instance.
+ * @param clientId
+ * @param config
+ * @param builders
+ * @throws - If called outside a browser environment.
+ * @throws - If the Pulse Tracker has already been created (or creation is already in progress).
+ */
+export async function createPulseTracker({ clientId, config, builders }) {
+    if (!isBrowser) {
+        throw new Error('createPulseTracker is only available in browser environments');
+    }
+    if (isTrackerCreated()) {
+        throw new Error('Pulse Tracker is already created (or creation already started)');
+    }
+    const singleton = (async () => {
+        return new Tracker(clientId, config, builders);
+    })();
+    attachTrackerToWindow(singleton);
+    return singleton;
+}

package/dist/ejs/defer.js

@@ -0,0 +1,17 @@
+const emptyFn = () => {
+    void 0;
+};
+export default function (value) {
+    let res = emptyFn;
+    let rej = emptyFn;
+    const promise = new Promise((resolve, reject) => {
+        res = resolve;
+        rej = reject;
+    });
+    return {
+        promise,
+        resolve: res,
+        reject: rej,
+        inputValue: value,
+    };
+}

package/dist/ejs/getPulseTracker.js

@@ -0,0 +1,71 @@
+/**
+ * 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({ ... });
+ * }
+ * ```
+ */
+export 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/ejs/identity/actor.js

@@ -0,0 +1,51 @@
+import { evaluateAndFlatten } from '@schibsted/pulse-utils';
+import { isActorInput } from '../builders/actor';
+import warnOnce from '../warnOnce';
+/**
+ * @internal exported for testing
+ */
+export const 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;
+};
+/**
+ * @category Identifiers
+ */
+const getActor = async (builders) => {
+    return await evaluateActor(builders);
+};
+const userIsLoggedIn = async (builders) => {
+    const actor = await getActor(builders);
+    return !!actor?.id;
+};
+/**
+ * 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 (isActorInput(eventInput) || isActorInput(builders)) {
+        const evaluatedActor = await 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.
+    warnOnce('no-actor-builder-and-no-event-present', WARN_CIS_SYNC_LOGIN_UNDEFINED);
+    return {};
+};
+export { getUserId, getActor, userIsLoggedIn, evaluateActor };

package/dist/ejs/identity/advertising.js

@@ -0,0 +1,57 @@
+import { getActor } from './actor';
+import { cisSync } from './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;
+};
+/**
+ * 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 cisSync({ actor: getActor(builders) }, builders, sdkState);
+    return adId;
+};
+/**
+ * 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 cisSync({ actor: 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;
+};
+export { getAdId, getIncludeAdvertising, getAdvertisingIdentifiers };

package/dist/ejs/identity/cis.js

@@ -0,0 +1,58 @@
+import { clearCookieJweIfStale, resetRefreshAfter, syncWithCis } from '@schibsted/pulse-cis-sync';
+import version from '../version.json';
+import { evaluateActor } from './actor';
+const requireCisSyncCallForAdvertisingIds = () => {
+    resetRefreshAfter(new Date());
+};
+/**
+ * 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 = 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 syncWithCis(
+        // @ts-expect-error
+        id, nativeJwe, cisBaseUrl, realm, providerId, isHybrid ? 'Hybrid' : 'Web', version.SDK_VERSION, {
+            includeAdvertising,
+            vendors,
+            trackerId,
+        });
+    }
+    return { doTracking: true };
+};
+export { clearCookieJweIfStale, cisSync, requireCisSyncCallForAdvertisingIds };

package/dist/ejs/identity/device.js

@@ -0,0 +1,17 @@
+import { getActor } from './actor';
+import { cisSync } from './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 getActor(builders);
+    const { environmentId } = await cisSync({ actor }, builders, sdkState);
+    return environmentId;
+};
+export { getEnvironmentId };

package/dist/ejs/identity/index.js

@@ -0,0 +1,4 @@
+export * from './actor';
+export * from './advertising';
+export * from './cis';
+export * from './device';

package/dist/ejs/index.js

@@ -0,0 +1,9 @@
+import T from './Tracker';
+export default T;
+export * as EventBuilders from './builders';
+export * from './Tracker';
+export { T as Tracker };
+export * from '@schibsted/tpaas-schemas';
+export { createPulseTracker } from './createPulseTracker';
+export { getPulseTracker } from './getPulseTracker';
+export { subscribe, subscribeOnce, subscribeWithState, unsubscribe } from './Tracker';

package/dist/ejs/leaveTracking/constants.js

@@ -0,0 +1,19 @@
+const LEAVE_EVENT_TYPE = 'Leave';
+export const DEFAULT_ACTIVITY_DURATION = () => ({
+    value: 0,
+    interval: undefined,
+    timeSinceLastActivity: 0,
+});
+export const DEFAULT_VIEWED_CONTENT = () => ({
+    objectViewPercentage: 0,
+    maxObjectViewPercentage: 0,
+    pageViewPercentage: 0,
+    maxPageViewPercentage: 0,
+    pageScrollPosition: 0,
+    maxPageScrollPosition: 0,
+});
+export const DEFAULT_PAGE_LEAVE_EVENT = () => ({
+    type: LEAVE_EVENT_TYPE,
+    engagement: DEFAULT_VIEWED_CONTENT(),
+});
+export const DEFAULT_LEAVE_EVENT_BUILDER = () => () => ({});