browser-extension-utils 0.1.19 → 0.2.1

package/lib/index.d.ts

@@ -68,15 +68,24 @@ export function removeEventListener(
   type: string | Record<string, unknown>
 ): void
 
-export function getAttribute(element: HTMLElement, name: string): string
+export function getAttribute(
+  // eslint-disable-next-line @typescript-eslint/ban-types
+  element: HTMLElement | null | undefined,
+  name: string
+): string | undefined
 
 export function setAttribute(
-  element: HTMLElement,
+  // eslint-disable-next-line @typescript-eslint/ban-types
+  element: HTMLElement | null | undefined,
   name: string,
   value: string
 ): void
 
-export function removeAttribute(element: HTMLElement, name: string): void
+export function removeAttribute(
+  // eslint-disable-next-line @typescript-eslint/ban-types
+  element: HTMLElement | null | undefined,
+  name: string
+): void
 
 export function setAttributes(
   element: HTMLElement,
@@ -89,20 +98,34 @@ export function addAttribute(
   value: string
 ): void
 
-export function addClass(element: HTMLElement, className: string): void
+export function addClass(
+  // eslint-disable-next-line @typescript-eslint/ban-types
+  element: HTMLElement | null | undefined,
+  className: string
+): void
 
-export function removeClass(element: HTMLElement, className: string): void
+export function removeClass(
+  // eslint-disable-next-line @typescript-eslint/ban-types
+  element: HTMLElement | null | undefined,
+  className: string
+): void
 
-export function hasClass(element: HTMLElement, className: string): boolean
+export function hasClass(
+  // eslint-disable-next-line @typescript-eslint/ban-types
+  element: HTMLElement | null | undefined,
+  className: string
+): boolean
 
 export type SetStyle = (
-  element: HTMLElement,
+  // eslint-disable-next-line @typescript-eslint/ban-types
+  element: HTMLElement | null | undefined,
   style: string | Record<string, unknown>,
   overwrite?: boolean
 ) => void
 
 export function setStyle(
-  element: HTMLElement,
+  // eslint-disable-next-line @typescript-eslint/ban-types
+  element: HTMLElement | null | undefined,
   style: string | Record<string, unknown>,
   overwrite?: boolean
 ): void
@@ -119,11 +142,19 @@ export function isUrl(text: string | undefined): boolean
 export function throttle(func: Function, interval: number): Function
 
 export type MenuCallback = (event?: MouseEvent | KeyboardEvent) => void
+export type RegisterMenuCommandOptions = {
+  id?: string
+  title?: string
+  autoClose?: boolean
+  // O - Tampermonkey
+  // X - Violentmonkey
+  accessKey?: string
+}
 export function registerMenuCommand(
   name: string,
   callback: MenuCallback,
-  accessKey?: string
-): void
+  options?: RegisterMenuCommandOptions
+): string | undefined
 
 export function extendHistoryApi(): void
 
@@ -172,3 +203,5 @@ export function parseInt10(
 
 // eslint-disable-next-line @typescript-eslint/naming-convention
 export function createHTML(html: string): string
+
+export function compareVersions(v1: string, v2: string): number

package/lib/index.js

@@ -1,6 +1,6 @@
 export const doc = document
 
-export const win = window
+export const win = globalThis
 
 export const uniq = (array) => [...new Set(array)]
 
@@ -19,7 +19,7 @@ export const toCamelCase = function (text) {
 }
 
 export const $ = (selectors, element) =>
-  (element || doc).querySelector(selectors)
+  (element || doc).querySelector(selectors) || undefined
 export const $$ = (selectors, element) => [
   ...(element || doc).querySelectorAll(selectors),
 ]
@@ -30,8 +30,8 @@ export const getRootElement = (type) =>
   type === 1
     ? doc.head || doc.body || doc.documentElement
     : type === 2
-    ? doc.body || doc.documentElement
-    : doc.documentElement
+      ? doc.body || doc.documentElement
+      : doc.documentElement
 
 export const createElement = (tagName, attributes) =>
   setAttributes(doc.createElement(tagName), attributes)
@@ -102,7 +102,7 @@ export const removeEventListener = (element, type, listener, options) => {
 }
 
 export const getAttribute = (element, name) =>
-  element && element.getAttribute ? element.getAttribute(name) : null
+  element && element.getAttribute ? element.getAttribute(name) : undefined
 export const setAttribute = (element, name, value) =>
   element && element.setAttribute
     ? element.setAttribute(name, value)
@@ -274,6 +274,7 @@ export const throttle = (func, interval) => {
 // Polyfill for Object.hasOwn()
 if (typeof Object.hasOwn !== "function") {
   Object.hasOwn = (instance, prop) =>
+    // eslint-disable-next-line prefer-object-has-own
     Object.prototype.hasOwnProperty.call(instance, prop)
 }
 
@@ -287,19 +288,19 @@ export const extendHistoryApi = () => {
   history.pushState = function () {
     // eslint-disable-next-line prefer-rest-params
     pushState.apply(history, arguments)
-    window.dispatchEvent(new Event("pushstate"))
-    window.dispatchEvent(new Event("locationchange"))
+    globalThis.dispatchEvent(new Event("pushstate"))
+    globalThis.dispatchEvent(new Event("locationchange"))
   }
 
   history.replaceState = function () {
     // eslint-disable-next-line prefer-rest-params
     replaceState.apply(history, arguments)
-    window.dispatchEvent(new Event("replacestate"))
-    window.dispatchEvent(new Event("locationchange"))
+    globalThis.dispatchEvent(new Event("replacestate"))
+    globalThis.dispatchEvent(new Event("locationchange"))
   }
 
-  window.addEventListener("popstate", function () {
-    window.dispatchEvent(new Event("locationchange"))
+  globalThis.addEventListener("popstate", function () {
+    globalThis.dispatchEvent(new Event("locationchange"))
   })
 
   // Usage example:
@@ -498,3 +499,50 @@ const escapeHTMLPolicy =
 export const createHTML = (html) => {
   return escapeHTMLPolicy ? escapeHTMLPolicy.createHTML(html) : html
 }
+
+/**
+ * Compare two semantic version strings
+ * @param {string} v1 - First version string (e.g., "1.2.0")
+ * @param {string} v2 - Second version string (e.g., "1.1.5")
+ * @returns {number} - Returns 1 if v1 > v2, -1 if v1 < v2, 0 if equal
+ * @throws {Error} - Throws error for invalid version strings
+ */
+export function compareVersions(v1, v2) {
+  // Input validation
+  if (typeof v1 !== "string" || typeof v2 !== "string") {
+    throw new TypeError("Version strings must be of type string")
+  }
+
+  if (!v1.trim() || !v2.trim()) {
+    throw new Error("Version strings cannot be empty")
+  }
+
+  // Validate version format (basic semantic versioning)
+  const versionRegex = /^\d+(\.\d+)*$/
+  if (!versionRegex.test(v1) || !versionRegex.test(v2)) {
+    throw new Error(
+      "Invalid version format. Use semantic versioning (e.g., '1.2.3')"
+    )
+  }
+
+  const v1Parts = v1.split(".").map(Number)
+  const v2Parts = v2.split(".").map(Number)
+  const maxLength = Math.max(v1Parts.length, v2Parts.length)
+
+  for (let i = 0; i < maxLength; i++) {
+    const num1 = v1Parts[i] || 0 // Use logical OR for cleaner default assignment
+    const num2 = v2Parts[i] || 0
+
+    if (num1 !== num2) {
+      return num1 > num2 ? 1 : -1 // Simplified comparison
+    }
+  }
+
+  return 0 // Versions are equal
+}
+
+// Usage:
+// console.log(compareVersions("1.2.0", "1.1.5")); // Output: 1
+// console.log(compareVersions("1.0", "1.0.0"));   // Output: 0
+// console.log(compareVersions("2.0", "1.5.10"));  // Output: 1
+// console.log(compareVersions("1.0.0", "1.0.0.1")); // Output: -1

package/lib/userscript.js

@@ -71,8 +71,8 @@ export const addStyle = (styleText) =>
   addElement(null, "style", { textContent: styleText })
 
 // Only register menu on top frame
-export const registerMenuCommand = (name, callback, accessKey) => {
-  if (window !== top) {
+export const registerMenuCommand = (name, callback, options) => {
+  if (globalThis !== top) {
     return
   }
 
@@ -81,6 +81,6 @@ export const registerMenuCommand = (name, callback, accessKey) => {
     return
   }
 
-  GM.registerMenuCommand(name, callback, accessKey)
+  return GM.registerMenuCommand(name, callback, options)
 }
 /* eslint-enable new-cap, camelcase */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "browser-extension-utils",
-  "version": "0.1.19",
+  "version": "0.2.1",
   "description": "Utilities for developing browser extensions and userscripts",
   "type": "module",
   "main": "./lib/index.js",
@@ -29,8 +29,8 @@
   },
   "homepage": "https://github.com/utags/browser-extension-utils#readme",
   "devDependencies": {
-    "prettier": "^3.0.2",
-    "xo": "^0.56.0"
+    "prettier": "^3.5.3",
+    "xo": "^0.60.0"
   },
   "files": [
     "lib/",
@@ -38,7 +38,7 @@
     "README.md"
   ],
   "engines": {
-    "node": "^12.20.0 || ^14.13.1 || >=16.0.0"
+    "node": ">=16.9.0"
   },
   "xo": {
     "space": 2,
@@ -56,7 +56,9 @@
       "document"
     ],
     "rules": {
+      "logical-assignment-operators": 0,
       "prefer-destructuring": 0,
+      "unicorn/prevent-abbreviations": 0,
       "capitalized-comments": 0
     }
   }