@dotcms/events 0.0.0-stage → 26.10.5-1-alpha.0

package/decision.esm.js

@@ -0,0 +1,92 @@
+/**
+ * Attribute on the element that wraps what an experiment varies, with the experiment's id.
+ * `DotCMSExperiment` and `experimentMarkup` put it there; the engine reads it.
+ */
+const EXPERIMENT_ATTRIBUTE = 'data-dot-experiment';
+/** Attribute with the variant the server rendered in that element. */
+const VARIANT_ATTRIBUTE = 'data-dot-variant';
+/** Name dotCMS gives the original variant. */
+const DEFAULT_VARIANT = 'DEFAULT';
+/** Query parameter the page API reads to render a variant. */
+const VARIANT_QUERY_PARAM = 'variantName';
+/** Endpoint that assigns the visitor to the running experiments. */
+const IS_USER_INCLUDED_PATH = '/api/v1/experiments/isUserIncluded';
+/**
+ * How long an experiment's content may stay hidden while its variant is decided. Past it the
+ * hiding rule shows the content, the boot script no longer redirects, and the engine's default
+ * wait ends.
+ */
+const DECISION_TIMEOUT_MS = 3000;
+/** Default wait for the assignment on the pages the engine decides itself. */
+const DEFAULT_ASSIGNMENT_TIMEOUT_MS = DECISION_TIMEOUT_MS;
+/** The request itself may run longer than the wait, so the next page can use its answer. */
+const IS_USER_INCLUDED_REQUEST_TIMEOUT_MS = 10000;
+const ONE_DAY_MS = 24 * 60 * 60 * 1000;
+/** How long the page being replaced keeps its new requests waiting. */
+const QUIET_MS = 5000;
+/**
+ * Rule printed before an experiment's content: the marked element stays hidden until the
+ * variant is decided, and shows on its own after `DECISION_TIMEOUT_MS` if nothing decides it
+ * (JavaScript off, SDK missing).
+ */
+const HIDING_RULE = `[${EXPERIMENT_ATTRIBUTE}]{visibility:hidden;animation:dotcms-experiment-timeout 0s linear ${DECISION_TIMEOUT_MS / 1000}s forwards}` +
+    `@keyframes dotcms-experiment-timeout{to{visibility:visible}}`;
+const STORAGE_KEYS = {
+    /** localStorage: assignments and the experiment ids already evaluated. */
+    assignments: 'dot_events_experiments',
+    /** localStorage: until when the site answered 403 (Experiments off). */
+    disabledUntil: 'dot_events_experiments_off_until',
+    /** sessionStorage: this tab already asked `isUserIncluded`. */
+    checkedThisTab: 'dot_events_experiments_checked',
+    /** sessionStorage: the cumulative `context.experiments` of the analytics session. */
+    sessionExperiments: 'dot_events_session_experiments'
+};
+/** Window property where the boot script leaves its decision on the page it ran on. */
+const BOOT_STATE_KEY = '__dotEventsExperimentBoot';
+/** Id of the style element that reveals decided content. */
+const REVEAL_STYLE_ID = 'dotcms-experiment-reveal';
+
+/**
+ * Decides an experiment's content from what is stored. It is pure, and the boot script prints
+ * it with `Function.prototype.toString`, so it must not reference anything outside itself:
+ * the engine and the boot script run this same function.
+ *
+ * @param input - The page's experiment, the URL, the stored assignments and the shared names
+ * @returns What to do with the content
+ */
+function decideVariant(input) {
+    if (input.disabled) {
+        return { kind: 'excluded' };
+    }
+    const stored = (input.stored || {});
+    const experiments = Array.isArray(stored.experiments)
+        ? stored.experiments
+        : [];
+    const evaluated = Array.isArray(stored.evaluatedIds) ? stored.evaluatedIds : [];
+    const assigned = experiments.find((experiment) => !!experiment &&
+        experiment.id === input.experimentId &&
+        (experiment.expiresAt || 0) > input.now);
+    const variant = assigned && assigned.variant && assigned.variant.name;
+    if (!variant) {
+        return evaluated.indexOf(input.experimentId) >= 0
+            ? { kind: 'excluded' }
+            : { kind: 'unknown' };
+    }
+    if (variant === input.rendered) {
+        return { kind: 'assigned', variant };
+    }
+    const url = new URL(input.href);
+    const requested = variant === input.defaultVariant ? null : variant;
+    if (url.searchParams.get(input.param) === requested) {
+        return { kind: 'ignored', variant };
+    }
+    if (requested) {
+        url.searchParams.set(input.param, requested);
+    }
+    else {
+        url.searchParams.delete(input.param);
+    }
+    return { kind: 'redirect', variant, url: url.toString() };
+}
+
+export { BOOT_STATE_KEY as B, DEFAULT_VARIANT as D, EXPERIMENT_ATTRIBUTE as E, HIDING_RULE as H, IS_USER_INCLUDED_REQUEST_TIMEOUT_MS as I, ONE_DAY_MS as O, QUIET_MS as Q, REVEAL_STYLE_ID as R, STORAGE_KEYS as S, VARIANT_ATTRIBUTE as V, DECISION_TIMEOUT_MS as a, VARIANT_QUERY_PARAM as b, IS_USER_INCLUDED_PATH as c, decideVariant as d, DEFAULT_ASSIGNMENT_TIMEOUT_MS as e };

package/index.cjs.default.js

@@ -0,0 +1 @@
+exports._default = require('./index.cjs.js').default;