@websline/cms-view-utils 1.9.0 → 1.10.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@websline/cms-view-utils",
-  "version": "1.9.0",
+  "version": "1.10.0",
   "type": "module",
   "files": [
     "src",

package/src/ads/createAdRunner.js

@@ -208,17 +208,19 @@ const createAdRunner = ({
 
 		/**
 		 * Following the ad ends it too: a visitor who acted on it has seen what it
-		 * had to say, and meeting it again on the next page reads as nagging.
+		 * had to say, and meeting it again on the next page reads as nagging. A
+		 * persistent ad stays until the visitor closes it.
 		 */
 		click(ad) {
 			if (!ad) return;
 
 			track(ad.uuid, "click");
-			release(ad);
+			if (!ad.persistent) release(ad);
 		},
 
+		/** An ad that is not closable has no close button, so nothing to dismiss. */
 		dismiss(ad) {
-			if (!ad) return;
+			if (!ad || ad.closable === false) return;
 
 			track(ad.uuid, "close");
 			release(ad);

package/src/ads/selectAd.js

@@ -98,8 +98,12 @@ const filterEligibleAds = ({
 	candidates.filter((ad) => {
 		if (!hasConsent(ad, isConsentGiven)) return false;
 		// Once per visit is the floor; a reload must not put it back on the screen.
-		if (wasSeenThisVisit(ad, seenAt(ad.uuid))) return false;
-		if (isSuppressed(ad, dismissedAt(ad.uuid), now)) return false;
+		// A persistent ad has no such floor: it stays on every page until closed.
+		if (!ad.persistent && wasSeenThisVisit(ad, seenAt(ad.uuid))) return false;
+		// `closable: false` has no close button, so no dismissal can hold it back.
+		if (ad.closable !== false && isSuppressed(ad, dismissedAt(ad.uuid), now)) {
+			return false;
+		}
 
 		const { cookieName, cookieValue, paramName, paramValue } = ad.conditions ?? {};
 

package/src/ads/triggers.js

@@ -40,15 +40,40 @@ const afterDelay = (seconds, fire, timers) => {
 };
 
 /**
- * Keeps listening until the page has really moved. `once` would drop the listener
- * on the first scroll event even when it arrived back at the top — an overscroll
- * bounce or a sideways scroll — and the ad would never appear for that visit.
+ * How far down the visitor is, in percent of what the page can scroll. A page
+ * that fits the window cannot be scrolled and so never reaches any share.
  */
-const onFirstScroll = (fire, target) => {
+const scrolledPercent = (target, doc) => {
+	const scrollable =
+		(doc?.documentElement?.scrollHeight ?? 0) - (target.innerHeight ?? 0);
+
+	return scrollable > 0 ? (target.scrollY / scrollable) * 100 : 0;
+};
+
+/**
+ * Fixed rather than set per ad: far enough to mean interest, early enough that
+ * most visitors get there. Not offered in the CMS, since no editor tunes it.
+ */
+const SCROLL_SHARE_PERCENT = 30;
+
+/**
+ * Keeps listening until the share is reached: `once` would drop the listener on
+ * an overscroll bounce back at the top and lose the ad for that visit.
+ */
+const onScrolledPast = (fire, target, doc) => {
+	const reached = () =>
+		target.scrollY > 0 && scrolledPercent(target, doc) >= SCROLL_SHARE_PERCENT;
+
+	// Already that far when the ad arrived — no further event may come.
+	if (reached()) {
+		fire();
+		return () => {};
+	}
+
 	const stop = () => target.removeEventListener("scroll", handler);
 
 	function handler() {
-		if (target.scrollY <= 0) return;
+		if (!reached()) return;
 
 		stop();
 		fire();
@@ -120,14 +145,7 @@ const watchTrigger = (trigger, onFire, env = {}) => {
 		}
 
 		case "scroll":
-			if (!target) return never();
-			// Already scrolled when the ad arrived — the event will not come again.
-			if (target.scrollY > 0) {
-				fire();
-				return never();
-			}
-
-			return onFirstScroll(fire, target);
+			return target ? onScrolledPast(fire, target, doc) : never();
 
 		case "exit_intent":
 			return doc ? onExitIntent(fire, doc) : never();
@@ -138,4 +156,4 @@ const watchTrigger = (trigger, onFire, env = {}) => {
 	}
 };
 
-export { countPageView, PAGE_VIEWS_KEY, watchTrigger };
+export { countPageView, PAGE_VIEWS_KEY, SCROLL_SHARE_PERCENT, watchTrigger };