browser-extension-utils 0.1.3 → 0.1.5

package/lib/index.d.ts

@@ -1,5 +1,7 @@
 export const doc: Document
 
+export const win: Window
+
 export function uniq(array: any[]): any[]
 
 export function toCamelCase(text: string): string
@@ -111,6 +113,7 @@ export function createSetStyle(styleText: string): SetStyle
 
 export function isUrl(text: string): boolean
 
+// eslint-disable-next-line @typescript-eslint/ban-types
 export function throttle(func: Function, interval: number): Function
 
 export type MenuCallback = (event?: MouseEvent | KeyboardEvent) => void
@@ -131,3 +134,22 @@ export function getOffsetPosition(
   top: number
   left: number
 }
+
+// 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 runWhenBodyExists(func: Function): void
+
+export async function sleep(time: number): void
+
+export type Cache = {
+  get: (key: string | any[]) => any
+  add: (key: string | any[], value: any) => void
+}
+
+export const cache: Cache
+
+export function isVisible(element: HTMLElement): boolean
+
+export function parseInt10(number: string, defaultValue?: number): number

package/lib/index.js

@@ -1,5 +1,7 @@
 export const doc = document
 
+export const win = window
+
 export const uniq = (array) => [...new Set(array)]
 
 export const toCamelCase = function (text) {
@@ -122,7 +124,7 @@ export const addAttribute = (element, name, value) => {
 }
 
 export const addClass = (element, className) => {
-  if (!element) {
+  if (!element || !element.classList) {
     return
   }
 
@@ -130,7 +132,7 @@ export const addClass = (element, className) => {
 }
 
 export const removeClass = (element, className) => {
-  if (!element) {
+  if (!element || !element.classList) {
     return
   }
 
@@ -138,7 +140,7 @@ export const removeClass = (element, className) => {
 }
 
 export const hasClass = (element, className) => {
-  if (!element) {
+  if (!element || !element.classList) {
     return false
   }
 
@@ -170,6 +172,7 @@ export const setStyle = (element, values, overwrite) => {
 }
 
 // convert `font-size: 12px; color: red` to `{"fontSize": "12px"; "color": "red"}`
+// eslint-disable-next-line no-unused-vars
 const toStyleKeyValues = (styleText) => {
   const result = {}
   const keyValues = styleText.split(/\s*;\s*/)
@@ -294,3 +297,66 @@ export const getOffsetPosition = (element, referElement) => {
 
   return position
 }
+
+const runOnceCache = {}
+export const runOnce = (key, func) => {
+  if (!key) {
+    return func()
+  }
+
+  if (Object.hasOwn(runOnceCache, key)) {
+    return runOnceCache[key]
+  }
+
+  const result = func()
+  runOnceCache[key] = result
+  return result
+}
+
+const cacheStore = {}
+const makeKey = (key /* string | any[] */) =>
+  Array.isArray(key) ? key.join(":") : key
+export const cache = {
+  get: (key /* string | any[] */) => cacheStore[makeKey(key)],
+  add(key /* string | any[] */, value /* any */) {
+    cacheStore[makeKey(key)] = value
+  },
+}
+
+export const sleep = async (time) => {
+  return new Promise((resolve) => {
+    setTimeout(() => {
+      resolve(1)
+    }, time)
+  })
+}
+
+export const parseInt10 = (number, defaultValue) => {
+  if (!number) {
+    number = ""
+  }
+
+  return Number.parseInt(number, 10) || defaultValue || Number.NaN
+}
+
+/**
+ * Run function when document.body exsits. The function may be executed before DOMContentLoaded.
+ */
+export const runWhenBodyExists = (func) => {
+  if (!doc.body) {
+    setTimeout(() => {
+      runWhenBodyExists(func)
+    }, 10)
+    return
+  }
+
+  func()
+}
+
+export const isVisible = (element) => {
+  if (typeof element.checkVisibility === "function") {
+    return element.checkVisibility()
+  }
+
+  return element.offsetParent !== null
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "browser-extension-utils",
-  "version": "0.1.3",
+  "version": "0.1.5",
   "description": "Utilities for developing browser extensions and userscripts",
   "type": "module",
   "main": "./lib/index.js",