browser-extension-utils 0.1.18 → 0.2.0

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

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,11 +102,13 @@ export const removeEventListener = (element, type, listener, options) => {
 }
 
 export const getAttribute = (element, name) =>
-  element ? element.getAttribute(name) : null
+  element && element.getAttribute ? element.getAttribute(name) : undefined
 export const setAttribute = (element, name, value) =>
-  element ? element.setAttribute(name, value) : undefined
+  element && element.setAttribute
+    ? element.setAttribute(name, value)
+    : undefined
 export const removeAttribute = (element, name) =>
-  element ? element.removeAttribute(name) : undefined
+  element && element.removeAttribute ? element.removeAttribute(name) : undefined
 
 export const setAttributes = (element, attributes) => {
   if (element && attributes) {
@@ -272,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)
 }
 
@@ -285,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:

package/lib/userscript.js

@@ -72,7 +72,7 @@ export const addStyle = (styleText) =>
 
 // Only register menu on top frame
 export const registerMenuCommand = (name, callback, accessKey) => {
-  if (window !== top) {
+  if (globalThis !== top) {
     return
   }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "browser-extension-utils",
-  "version": "0.1.18",
+  "version": "0.2.0",
   "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
     }
   }