browser-extension-utils 0.1.9 → 0.1.11

package/lib/index.d.ts

@@ -76,6 +76,8 @@ export function setAttribute(
   value: string
 ): void
 
+export function removeAttribute(element: HTMLElement, name: string): void
+
 export function setAttributes(
   element: HTMLElement,
   attributes: Record<string, unknown>
@@ -111,7 +113,7 @@ export function noStyleSpace(text: string): string
 
 export function createSetStyle(styleText: string): SetStyle
 
-export function isUrl(text: string): boolean
+export function isUrl(text: string | undefined): boolean
 
 // eslint-disable-next-line @typescript-eslint/ban-types
 export function throttle(func: Function, interval: number): Function
@@ -138,6 +140,9 @@ export function getOffsetPosition(
 // eslint-disable-next-line @typescript-eslint/ban-types
 export function runOnce(key: string, func: Function): any
 
+// eslint-disable-next-line @typescript-eslint/ban-types
+export function runWhenHeadExists(func: Function): void
+
 // eslint-disable-next-line @typescript-eslint/ban-types
 export function runWhenBodyExists(func: Function): void
 
@@ -158,3 +163,6 @@ export function parseInt10(
   number: string | undefined,
   defaultValue?: number
 ): number
+
+// eslint-disable-next-line @typescript-eslint/naming-convention, @typescript-eslint/no-redundant-type-constituents
+export function createHTML(html: string): TrustedHTML | string

package/lib/index.js

@@ -87,6 +87,8 @@ export const getAttribute = (element, name) =>
   element ? element.getAttribute(name) : null
 export const setAttribute = (element, name, value) =>
   element ? element.setAttribute(name, value) : undefined
+export const removeAttribute = (element, name) =>
+  element ? element.removeAttribute(name) : undefined
 
 export const setAttributes = (element, attributes) => {
   if (element && attributes) {
@@ -348,14 +350,63 @@ export const parseInt10 = (number, defaultValue) => {
   return Number.isNaN(result) ? defaultValue : result
 }
 
+const headFuncArray = []
+const bodyFuncArray = []
+let headBodyObserver
+
+const startObserveHeadBodyExists = () => {
+  if (headBodyObserver) {
+    return
+  }
+
+  headBodyObserver = new MutationObserver(() => {
+    if (doc.head && doc.body) {
+      headBodyObserver.disconnect()
+    }
+
+    if (doc.head && headFuncArray.length > 0) {
+      for (const func of headFuncArray) {
+        func()
+      }
+
+      headFuncArray.length = 0
+    }
+
+    if (doc.body && bodyFuncArray.length > 0) {
+      for (const func of bodyFuncArray) {
+        func()
+      }
+
+      bodyFuncArray.length = 0
+    }
+  })
+
+  headBodyObserver.observe(doc, {
+    childList: true,
+    subtree: true,
+  })
+}
+
 /**
- * Run function when document.body exsits. The function may be executed before DOMContentLoaded.
+ * Run function when document.head exsits.
+ */
+export const runWhenHeadExists = (func) => {
+  if (!doc.head) {
+    headFuncArray.push(func)
+    startObserveHeadBodyExists()
+    return
+  }
+
+  func()
+}
+
+/**
+ * Run function when document.body exsits. The function executed before DOMContentLoaded.
  */
 export const runWhenBodyExists = (func) => {
   if (!doc.body) {
-    setTimeout(() => {
-      runWhenBodyExists(func)
-    }, 10)
+    bodyFuncArray.push(func)
+    startObserveHeadBodyExists()
     return
   }
 
@@ -371,3 +422,15 @@ export const isVisible = (element) => {
 }
 
 export const isTouchScreen = () => "ontouchstart" in win
+
+const escapeHTMLPolicy =
+  typeof trustedTypes !== "undefined" &&
+  typeof trustedTypes.createPolicy === "function"
+    ? trustedTypes.createPolicy("beuEscapePolicy", {
+        createHTML: (string) => string,
+      })
+    : undefined
+
+export const createHTML = (html) => {
+  return escapeHTMLPolicy ? escapeHTMLPolicy.createHTML(html) : html
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "browser-extension-utils",
-  "version": "0.1.9",
+  "version": "0.1.11",
   "description": "Utilities for developing browser extensions and userscripts",
   "type": "module",
   "main": "./lib/index.js",
@@ -48,6 +48,8 @@
       "GM_addElement",
       "GM_addStyle",
       "GM_registerMenuCommand",
+      "trustedTypes",
+      "MutationObserver",
       "history",
       "window",
       "top",