@adobe/helix-rum-enhancer 2.14.1 → 2.15.0

package/.releaserc.cjs

@@ -12,5 +12,5 @@ module.exports = {
     }],
     ["@semantic-release/github", {}]
   ],
-  branches: ['main', '1.x'],
+  branches: ['main'],
 };

package/CHANGELOG.md

@@ -1,3 +1,25 @@
+# [2.15.0](https://github.com/adobe/helix-rum-enhancer/compare/v2.14.2...v2.15.0) (2024-07-01)
+
+
+### Bug Fixes
+
+* use correct token for release ([094f37e](https://github.com/adobe/helix-rum-enhancer/commit/094f37ef2de8ddf5d64ea38c9071c9b1bec6119a))
+
+
+### Features
+
+* add more logic to button selector ([#205](https://github.com/adobe/helix-rum-enhancer/issues/205)) ([c9a5629](https://github.com/adobe/helix-rum-enhancer/commit/c9a5629e7e690397a5f46cbf8db08570f0c4d250))
+* clean up and trigger release ([bfc8d24](https://github.com/adobe/helix-rum-enhancer/commit/bfc8d241cd19b33975ac37be5167783b99fbe54c))
+* switch release token ([0e5b3b0](https://github.com/adobe/helix-rum-enhancer/commit/0e5b3b03d0b96a32118340e7b6f004da8660f0aa))
+* trigger release ([bf26949](https://github.com/adobe/helix-rum-enhancer/commit/bf269492cb330c55d22fd0eeed4aad4cfdac57a3))
+
+## [2.14.2](https://github.com/adobe/helix-rum-enhancer/compare/v2.14.1...v2.14.2) (2024-06-12)
+
+
+### Bug Fixes
+
+* restore original path behavior ([#201](https://github.com/adobe/helix-rum-enhancer/issues/201)) ([f70df99](https://github.com/adobe/helix-rum-enhancer/commit/f70df992da778f5700d9bdc8b4f114ddf272ea77))
+
 ## [2.14.1](https://github.com/adobe/helix-rum-enhancer/compare/v2.14.0...v2.14.1) (2024-06-11)
 
 

package/modules/dom.js

@@ -54,11 +54,25 @@ export const sourceSelector = (element) => {
       return `.${element.getAttribute('data-block-name')}`;
     }
 
-    if (Array.from(element.classList).some((className) => className.match(/button|cta/))) {
-      return blockName ? `.${blockName} .button` : '.button';
+    const classes = Array.from(element.classList);
+    const label = element.tagName.toLowerCase();
+    const firstClass = classes.length > 0 ? `.${classes[0]}` : '';
+    const labelWithClass = `${element.tagName.toLowerCase()}${firstClass}`;
+    if (element.tagName.toLowerCase() === 'button'
+      || element.type === 'button'
+      || classes.some((className) => className.match(/button|cta/))) {
+      let parent = element.parentElement;
+      if (!parent) return labelWithClass;
+      if (parent.id) return `#${parent.id} ${label}`;
+      while (parent.tagName !== 'BODY' && !parent.id) parent = parent.parentElement;
+      if (parent.id) return `#${parent.id} ${labelWithClass}`;
+      return blockName ? `.${blockName} ${labelWithClass}` : labelWithClass;
     }
 
-    return sourceSelector(element.parentElement);
+    const parent = sourceSelector(element.parentElement);
+    if (parent) return parent;
+
+    return labelWithClass;
     /* c8 ignore next 3 */
   } catch (error) {
     return null;

package/modules/utils.js

@@ -11,7 +11,28 @@
  */
 
 export const urlSanitizers = {
+  /**
+   * Returns the full url.
+   * If no url is provided, it defaults to window.location.href.
+   * @param {string} url (default: window.location.href) The url to sanitize
+   * @returns {string} The sanitized url
+   */
   full: (url = window.location.href) => new URL(url).toString(),
+  /**
+   * Returns the origin of the provided url.
+   * If no url is provided, it defaults to window.location.href.
+   * @param {string} url (default: window.location.href) The url to sanitize
+   * @returns {string} The sanitized url
+   */
   origin: (url = window.location.href) => new URL(url).origin,
-  path: (url = window.location.href) => new URL(url).pathname,
+  /**
+   * Returns the sanitized url: the origin and the path (no query params or hash)
+   * If no url is provided, it defaults to window.location.href.
+   * @param {string} url (default: window.location.href) The url to sanitize
+   * @returns {string} The sanitized url
+   */
+  path: (url = window.location.href) => {
+    const u = new URL(url);
+    return `${u.origin}${u.pathname}`;
+  },
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adobe/helix-rum-enhancer",
-  "version": "2.14.1",
+  "version": "2.15.0",
   "description": "Helix RUM Enhancer",
   "main": "src/index.js",
   "type": "module",
@@ -42,7 +42,7 @@
     "@web/test-runner-commands": "0.9.0",
     "@web/test-runner-mocha": "0.9.0",
     "@web/test-runner-playwright": "0.11.0",
-    "c8": "10.0.0",
+    "c8": "10.1.2",
     "codecov": "3.8.3",
     "eslint": "8.57.0",
     "eslint-plugin-header": "3.1.1",
@@ -50,8 +50,8 @@
     "husky": "9.0.11",
     "jsdoc-to-markdown": "8.0.1",
     "junit-report-builder": "3.2.1",
-    "lint-staged": "15.2.5",
-    "mocha": "10.4.0",
+    "lint-staged": "15.2.7",
+    "mocha": "10.5.2",
     "mocha-multi-reporters": "1.5.1",
     "rollup": "4.18.0",
     "rollup-plugin-cleanup": "3.2.1",

package/src/index.js

@@ -30,9 +30,30 @@
   };
 
   const urlSanitizers = {
+    /**
+     * Returns the full url.
+     * If no url is provided, it defaults to window.location.href.
+     * @param {string} url (default: window.location.href) The url to sanitize
+     * @returns {string} The sanitized url
+     */
     full: (url = window.location.href) => new URL(url).toString(),
+    /**
+     * Returns the origin of the provided url.
+     * If no url is provided, it defaults to window.location.href.
+     * @param {string} url (default: window.location.href) The url to sanitize
+     * @returns {string} The sanitized url
+     */
     origin: (url = window.location.href) => new URL(url).origin,
-    path: (url = window.location.href) => new URL(url).pathname,
+    /**
+     * Returns the sanitized url: the origin and the path (no query params or hash)
+     * If no url is provided, it defaults to window.location.href.
+     * @param {string} url (default: window.location.href) The url to sanitize
+     * @returns {string} The sanitized url
+     */
+    path: (url = window.location.href) => {
+      const u = new URL(url);
+      return `${u.origin}${u.pathname}`;
+    },
   };
 
   const getTargetValue = (element) => element.getAttribute('data-rum-target') || element.getAttribute('href')
@@ -79,11 +100,25 @@
         return `.${element.getAttribute('data-block-name')}`;
       }
 
-      if (Array.from(element.classList).some((className) => className.match(/button|cta/))) {
-        return blockName ? `.${blockName} .button` : '.button';
+      const classes = Array.from(element.classList);
+      const label = element.tagName.toLowerCase();
+      const firstClass = classes.length > 0 ? `.${classes[0]}` : '';
+      const labelWithClass = `${element.tagName.toLowerCase()}${firstClass}`;
+      if (element.tagName.toLowerCase() === 'button'
+        || element.type === 'button'
+        || classes.some((className) => className.match(/button|cta/))) {
+        let parent = element.parentElement;
+        if (!parent) return labelWithClass;
+        if (parent.id) return `#${parent.id} ${label}`;
+        while (parent.tagName !== 'BODY' && !parent.id) parent = parent.parentElement;
+        if (parent.id) return `#${parent.id} ${labelWithClass}`;
+        return blockName ? `.${blockName} ${labelWithClass}` : labelWithClass;
       }
 
-      return sourceSelector(element.parentElement);
+      const parent = sourceSelector(element.parentElement);
+      if (parent) return parent;
+
+      return labelWithClass;
     } catch (error) {
       return null;
     }