fck-honey 0.3.0 → 0.3.2

package/README.md

@@ -9,7 +9,7 @@ Open source lib for Merchants to detect if a customer has Honey browser extensio
 ## Usage (Browser Global)
 
 ```html
-<script src="https://cdn.jsdelivr.net/npm/fck-honey/dist/honey-detect.min.js"></script>
+<script src="https://cdn.jsdelivr.net/npm/fck-honey@0/dist/honey-detect.js"></script>
 <script>
 window.fckHoney.listen((warn) => {
     // Decide how you want to handle this. Native warn function allows you to tell the user to disable Honey.
@@ -41,3 +41,9 @@ window.fckHoney.listen((warn, el) => {
   // Set removeHoney to false if you want to keep the Honey element for some reason.
 }, { removeHoney: false });
 ```
+
+```js
+window.fckHoney.listen((warn) => {
+  // Stop observing if nothing is detected within 10 seconds.
+}, { unbindAfterSeconds: 10 });
+```

package/dist/bundle-tmp/core.js

@@ -9,6 +9,8 @@ var __assign = (this && this.__assign) || function () {
     };
     return __assign.apply(this, arguments);
 };
+import { VERSION } from "./version";
+export var version = VERSION;
 var DEFAULT_Z_NEAR_MAX = 2147480000;
 var UUIDISH_RE = /^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$/i;
 var TARGET_SELECTOR = "div[id]";
@@ -81,19 +83,12 @@ function looksLikeTargetDiv(el, zNearMax, uuidGate, debug) {
         console.log("+++ match", el);
     return true;
 }
-function scanElement(el, seen, zNearMax, uuidGate, debug, removeHoney, onMatch, warn) {
+function scanElement(el, seen, zNearMax, uuidGate, debug, handleMatch) {
     var _a;
     if (el instanceof HTMLDivElement && el.matches(TARGET_SELECTOR)) {
         if (seen.indexOf(el) === -1 && looksLikeTargetDiv(el, zNearMax, uuidGate, debug)) {
             seen.push(el);
-            if (removeHoney && el.parentNode)
-                el.parentNode.removeChild(el);
-            if (removeHoney) {
-                onMatch(warn);
-            }
-            else {
-                onMatch(warn, el);
-            }
+            handleMatch(el);
         }
     }
     var divs = (_a = el.querySelectorAll) === null || _a === void 0 ? void 0 : _a.call(el, TARGET_SELECTOR);
@@ -103,14 +98,7 @@ function scanElement(el, seen, zNearMax, uuidGate, debug, removeHoney, onMatch,
         var d = divs[i];
         if (seen.indexOf(d) === -1 && looksLikeTargetDiv(d, zNearMax, uuidGate, debug)) {
             seen.push(d);
-            if (removeHoney && d.parentNode)
-                d.parentNode.removeChild(d);
-            if (removeHoney) {
-                onMatch(warn);
-            }
-            else {
-                onMatch(warn, d);
-            }
+            handleMatch(d);
         }
     }
 }
@@ -122,8 +110,29 @@ export function startHoneyOverlayObserver(options) {
     var uuidGate = (_b = options.uuidGate) !== null && _b !== void 0 ? _b : true;
     var debug = (_c = options.debug) !== null && _c !== void 0 ? _c : false;
     var removeHoney = (_d = options.removeHoney) !== null && _d !== void 0 ? _d : true;
+    var unbindAfterSeconds = options.unbindAfterSeconds;
     var warn = function (message) { return showOverlay(message); };
     var onMatch = (_e = options.onMatch) !== null && _e !== void 0 ? _e : (function () { });
+    var matched = false;
+    var unbindTimer;
+    var handleMatch = function (el) {
+        matched = true;
+        if (typeof unbindTimer === "number") {
+            clearTimeout(unbindTimer);
+            unbindTimer = undefined;
+        }
+        if (removeHoney && el.parentNode)
+            el.parentNode.removeChild(el);
+        if (removeHoney) {
+            onMatch(warn);
+        }
+        else {
+            onMatch(warn, el);
+        }
+    };
+    // Greedy, page-wide observer: Honey overlays can be inserted late, moved,
+    // or have z-index applied after insertion. We watch all DOM changes so we
+    // can catch the element no matter when it appears or how it's styled.
     var mo = new MutationObserver(function (mutations) {
         for (var _i = 0, mutations_1 = mutations; _i < mutations_1.length; _i++) {
             var m = mutations_1[_i];
@@ -140,17 +149,17 @@ export function startHoneyOverlayObserver(options) {
                     for (var i = 0; i < m.addedNodes.length; i += 1) {
                         var node = m.addedNodes[i];
                         if (node.nodeType === Node.ELEMENT_NODE) {
-                            scanElement(node, seen, zNearMax, uuidGate, debug, removeHoney, onMatch, warn);
+                            scanElement(node, seen, zNearMax, uuidGate, debug, handleMatch);
                         }
                     }
                 }
                 if (m.target instanceof Element) {
-                    scanElement(m.target, seen, zNearMax, uuidGate, debug, removeHoney, onMatch, warn);
+                    scanElement(m.target, seen, zNearMax, uuidGate, debug, handleMatch);
                 }
             }
             else if (m.type === "attributes") {
                 if (m.target instanceof Element) {
-                    scanElement(m.target, seen, zNearMax, uuidGate, debug, removeHoney, onMatch, warn);
+                    scanElement(m.target, seen, zNearMax, uuidGate, debug, handleMatch);
                 }
             }
         }
@@ -161,9 +170,21 @@ export function startHoneyOverlayObserver(options) {
         attributes: true,
         attributeFilter: ["style", "class", "id"]
     });
-    scanElement(document.documentElement, seen, zNearMax, uuidGate, debug, removeHoney, onMatch, warn);
+    scanElement(document.documentElement, seen, zNearMax, uuidGate, debug, handleMatch);
+    if (typeof unbindAfterSeconds === "number" && unbindAfterSeconds > 0) {
+        unbindTimer = window.setTimeout(function () {
+            if (!matched) {
+                mo.disconnect();
+            }
+        }, unbindAfterSeconds * 1000);
+    }
     return {
-        stop: function () { return mo.disconnect(); }
+        stop: function () {
+            mo.disconnect();
+            if (typeof unbindTimer === "number") {
+                clearTimeout(unbindTimer);
+            }
+        }
     };
 }
 export function listen(onMatch, options) {

package/dist/bundle-tmp/global.js

@@ -1,6 +1,6 @@
-import { listen, startHoneyOverlayObserver } from "./core";
+import { listen, version } from "./core";
 if (typeof window !== "undefined") {
     window.fckHoney = window.fckHoney || {};
-    window.fckHoney.startHoneyOverlayObserver = startHoneyOverlayObserver;
     window.fckHoney.listen = listen;
+    window.fckHoney.version = version;
 }

package/dist/bundle-tmp/version.js

@@ -0,0 +1,2 @@
+// Auto-generated from package.json. Do not edit by hand.
+export var VERSION = "0.3.2";

package/dist/esm/core.js

@@ -9,6 +9,8 @@ var __assign = (this && this.__assign) || function () {
     };
     return __assign.apply(this, arguments);
 };
+import { VERSION } from "./version";
+export var version = VERSION;
 var DEFAULT_Z_NEAR_MAX = 2147480000;
 var UUIDISH_RE = /^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$/i;
 var TARGET_SELECTOR = "div[id]";
@@ -81,19 +83,12 @@ function looksLikeTargetDiv(el, zNearMax, uuidGate, debug) {
         console.log("+++ match", el);
     return true;
 }
-function scanElement(el, seen, zNearMax, uuidGate, debug, removeHoney, onMatch, warn) {
+function scanElement(el, seen, zNearMax, uuidGate, debug, handleMatch) {
     var _a;
     if (el instanceof HTMLDivElement && el.matches(TARGET_SELECTOR)) {
         if (seen.indexOf(el) === -1 && looksLikeTargetDiv(el, zNearMax, uuidGate, debug)) {
             seen.push(el);
-            if (removeHoney && el.parentNode)
-                el.parentNode.removeChild(el);
-            if (removeHoney) {
-                onMatch(warn);
-            }
-            else {
-                onMatch(warn, el);
-            }
+            handleMatch(el);
         }
     }
     var divs = (_a = el.querySelectorAll) === null || _a === void 0 ? void 0 : _a.call(el, TARGET_SELECTOR);
@@ -103,14 +98,7 @@ function scanElement(el, seen, zNearMax, uuidGate, debug, removeHoney, onMatch,
         var d = divs[i];
         if (seen.indexOf(d) === -1 && looksLikeTargetDiv(d, zNearMax, uuidGate, debug)) {
             seen.push(d);
-            if (removeHoney && d.parentNode)
-                d.parentNode.removeChild(d);
-            if (removeHoney) {
-                onMatch(warn);
-            }
-            else {
-                onMatch(warn, d);
-            }
+            handleMatch(d);
         }
     }
 }
@@ -122,8 +110,29 @@ export function startHoneyOverlayObserver(options) {
     var uuidGate = (_b = options.uuidGate) !== null && _b !== void 0 ? _b : true;
     var debug = (_c = options.debug) !== null && _c !== void 0 ? _c : false;
     var removeHoney = (_d = options.removeHoney) !== null && _d !== void 0 ? _d : true;
+    var unbindAfterSeconds = options.unbindAfterSeconds;
     var warn = function (message) { return showOverlay(message); };
     var onMatch = (_e = options.onMatch) !== null && _e !== void 0 ? _e : (function () { });
+    var matched = false;
+    var unbindTimer;
+    var handleMatch = function (el) {
+        matched = true;
+        if (typeof unbindTimer === "number") {
+            clearTimeout(unbindTimer);
+            unbindTimer = undefined;
+        }
+        if (removeHoney && el.parentNode)
+            el.parentNode.removeChild(el);
+        if (removeHoney) {
+            onMatch(warn);
+        }
+        else {
+            onMatch(warn, el);
+        }
+    };
+    // Greedy, page-wide observer: Honey overlays can be inserted late, moved,
+    // or have z-index applied after insertion. We watch all DOM changes so we
+    // can catch the element no matter when it appears or how it's styled.
     var mo = new MutationObserver(function (mutations) {
         for (var _i = 0, mutations_1 = mutations; _i < mutations_1.length; _i++) {
             var m = mutations_1[_i];
@@ -140,17 +149,17 @@ export function startHoneyOverlayObserver(options) {
                     for (var i = 0; i < m.addedNodes.length; i += 1) {
                         var node = m.addedNodes[i];
                         if (node.nodeType === Node.ELEMENT_NODE) {
-                            scanElement(node, seen, zNearMax, uuidGate, debug, removeHoney, onMatch, warn);
+                            scanElement(node, seen, zNearMax, uuidGate, debug, handleMatch);
                         }
                     }
                 }
                 if (m.target instanceof Element) {
-                    scanElement(m.target, seen, zNearMax, uuidGate, debug, removeHoney, onMatch, warn);
+                    scanElement(m.target, seen, zNearMax, uuidGate, debug, handleMatch);
                 }
             }
             else if (m.type === "attributes") {
                 if (m.target instanceof Element) {
-                    scanElement(m.target, seen, zNearMax, uuidGate, debug, removeHoney, onMatch, warn);
+                    scanElement(m.target, seen, zNearMax, uuidGate, debug, handleMatch);
                 }
             }
         }
@@ -161,9 +170,21 @@ export function startHoneyOverlayObserver(options) {
         attributes: true,
         attributeFilter: ["style", "class", "id"]
     });
-    scanElement(document.documentElement, seen, zNearMax, uuidGate, debug, removeHoney, onMatch, warn);
+    scanElement(document.documentElement, seen, zNearMax, uuidGate, debug, handleMatch);
+    if (typeof unbindAfterSeconds === "number" && unbindAfterSeconds > 0) {
+        unbindTimer = window.setTimeout(function () {
+            if (!matched) {
+                mo.disconnect();
+            }
+        }, unbindAfterSeconds * 1000);
+    }
     return {
-        stop: function () { return mo.disconnect(); }
+        stop: function () {
+            mo.disconnect();
+            if (typeof unbindTimer === "number") {
+                clearTimeout(unbindTimer);
+            }
+        }
     };
 }
 export function listen(onMatch, options) {

package/dist/esm/version.js

@@ -0,0 +1,2 @@
+// Auto-generated from package.json. Do not edit by hand.
+export var VERSION = "0.3.2";

package/dist/honey-detect.js

@@ -1,4 +1,7 @@
 (function() {
+  // dist/bundle-tmp/version.js
+  var VERSION = "0.3.2";
+
   // dist/bundle-tmp/core.js
   var __assign = function() {
     __assign = Object.assign || function(t) {
@@ -11,6 +14,7 @@
     };
     return __assign.apply(this, arguments);
   };
+  var version = VERSION;
   var DEFAULT_Z_NEAR_MAX = 214748e4;
   var UUIDISH_RE = /^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$/i;
   var TARGET_SELECTOR = "div[id]";
@@ -82,18 +86,12 @@
       console.log("+++ match", el);
     return true;
   }
-  function scanElement(el, seen, zNearMax, uuidGate, debug, removeHoney, onMatch, warn) {
+  function scanElement(el, seen, zNearMax, uuidGate, debug, handleMatch) {
     var _a;
     if (el instanceof HTMLDivElement && el.matches(TARGET_SELECTOR)) {
       if (seen.indexOf(el) === -1 && looksLikeTargetDiv(el, zNearMax, uuidGate, debug)) {
         seen.push(el);
-        if (removeHoney && el.parentNode)
-          el.parentNode.removeChild(el);
-        if (removeHoney) {
-          onMatch(warn);
-        } else {
-          onMatch(warn, el);
-        }
+        handleMatch(el);
       }
     }
     var divs = (_a = el.querySelectorAll) === null || _a === void 0 ? void 0 : _a.call(el, TARGET_SELECTOR);
@@ -103,13 +101,7 @@
       var d = divs[i];
       if (seen.indexOf(d) === -1 && looksLikeTargetDiv(d, zNearMax, uuidGate, debug)) {
         seen.push(d);
-        if (removeHoney && d.parentNode)
-          d.parentNode.removeChild(d);
-        if (removeHoney) {
-          onMatch(warn);
-        } else {
-          onMatch(warn, d);
-        }
+        handleMatch(d);
       }
     }
   }
@@ -123,11 +115,28 @@
     var uuidGate = (_b = options.uuidGate) !== null && _b !== void 0 ? _b : true;
     var debug = (_c = options.debug) !== null && _c !== void 0 ? _c : false;
     var removeHoney = (_d = options.removeHoney) !== null && _d !== void 0 ? _d : true;
+    var unbindAfterSeconds = options.unbindAfterSeconds;
     var warn = function(message) {
       return showOverlay(message);
     };
     var onMatch = (_e = options.onMatch) !== null && _e !== void 0 ? _e : (function() {
     });
+    var matched = false;
+    var unbindTimer;
+    var handleMatch = function(el) {
+      matched = true;
+      if (typeof unbindTimer === "number") {
+        clearTimeout(unbindTimer);
+        unbindTimer = void 0;
+      }
+      if (removeHoney && el.parentNode)
+        el.parentNode.removeChild(el);
+      if (removeHoney) {
+        onMatch(warn);
+      } else {
+        onMatch(warn, el);
+      }
+    };
     var mo = new MutationObserver(function(mutations) {
       for (var _i = 0, mutations_1 = mutations; _i < mutations_1.length; _i++) {
         var m = mutations_1[_i];
@@ -142,16 +151,16 @@
             for (var i = 0; i < m.addedNodes.length; i += 1) {
               var node = m.addedNodes[i];
               if (node.nodeType === Node.ELEMENT_NODE) {
-                scanElement(node, seen, zNearMax, uuidGate, debug, removeHoney, onMatch, warn);
+                scanElement(node, seen, zNearMax, uuidGate, debug, handleMatch);
               }
             }
           }
           if (m.target instanceof Element) {
-            scanElement(m.target, seen, zNearMax, uuidGate, debug, removeHoney, onMatch, warn);
+            scanElement(m.target, seen, zNearMax, uuidGate, debug, handleMatch);
           }
         } else if (m.type === "attributes") {
           if (m.target instanceof Element) {
-            scanElement(m.target, seen, zNearMax, uuidGate, debug, removeHoney, onMatch, warn);
+            scanElement(m.target, seen, zNearMax, uuidGate, debug, handleMatch);
           }
         }
       }
@@ -162,10 +171,20 @@
       attributes: true,
       attributeFilter: ["style", "class", "id"]
     });
-    scanElement(document.documentElement, seen, zNearMax, uuidGate, debug, removeHoney, onMatch, warn);
+    scanElement(document.documentElement, seen, zNearMax, uuidGate, debug, handleMatch);
+    if (typeof unbindAfterSeconds === "number" && unbindAfterSeconds > 0) {
+      unbindTimer = window.setTimeout(function() {
+        if (!matched) {
+          mo.disconnect();
+        }
+      }, unbindAfterSeconds * 1e3);
+    }
     return {
       stop: function() {
-        return mo.disconnect();
+        mo.disconnect();
+        if (typeof unbindTimer === "number") {
+          clearTimeout(unbindTimer);
+        }
       }
     };
   }
@@ -179,7 +198,7 @@
   // dist/bundle-tmp/global.js
   if (typeof window !== "undefined") {
     window.fckHoney = window.fckHoney || {};
-    window.fckHoney.startHoneyOverlayObserver = startHoneyOverlayObserver;
     window.fckHoney.listen = listen;
+    window.fckHoney.version = version;
   }
 })();

package/dist/types/core.d.ts

@@ -1,3 +1,4 @@
+export declare const version = "0.3.2";
 export type WarnCallback = (message: string) => () => void;
 export type MatchCallback = (warn: WarnCallback, el?: HTMLDivElement) => void;
 export interface ObserverOptions {
@@ -6,6 +7,7 @@ export interface ObserverOptions {
     zNearMax?: number;
     debug?: boolean;
     removeHoney?: boolean;
+    unbindAfterSeconds?: number;
 }
 export interface ObserverHandle {
     stop: () => void;

package/dist/types/version.d.ts

@@ -0,0 +1 @@
+export declare const VERSION = "0.3.2";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "fck-honey",
-  "version": "0.3.0",
+  "version": "0.3.2",
   "description": "Detects Honey browser extension overlays for merchants.",
   "license": "MIT",
   "main": "dist/honey-detect.js",
@@ -17,6 +17,7 @@
     "dist"
   ],
   "scripts": {
+    "prebuild": "node scripts/write-version.cjs",
     "build": "tsc -p tsconfig.esm.json && tsc -p tsconfig.bundle.json && esbuild dist/bundle-tmp/global.js --bundle --format=iife --platform=browser --target=es5 --outfile=dist/honey-detect.js",
     "prepublishOnly": "npm run build",
     "clean": "rm -rf dist"