browser-extension-utils 0.1.2 → 0.1.4

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
@@ -85,6 +87,12 @@ export function addAttribute(
   value: string
 ): void
 
+export function addClass(element: HTMLElement, className: string): void
+
+export function removeClass(element: HTMLElement, className: string): void
+
+export function hasClass(element: HTMLElement, className: string): boolean
+
 export type SetStyle = (
   element: HTMLElement,
   style: string | Record<string, unknown>,
@@ -105,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
@@ -115,3 +124,16 @@ export function registerMenuCommand(
 ): void
 
 export function extendHistoryApi(): void
+
+export const actionHref: string
+
+export function getOffsetPosition(
+  element: HTMLElement | undefined,
+  referElement?: HTMLElement | undefined
+): {
+  top: number
+  left: number
+}
+
+// eslint-disable-next-line @typescript-eslint/ban-types
+export function runOnce(key: string, func: Function): any

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) {
@@ -121,6 +123,30 @@ export const addAttribute = (element, name, value) => {
   }
 }
 
+export const addClass = (element, className) => {
+  if (!element || !element.classList) {
+    return
+  }
+
+  element.classList.add(className)
+}
+
+export const removeClass = (element, className) => {
+  if (!element || !element.classList) {
+    return
+  }
+
+  element.classList.remove(className)
+}
+
+export const hasClass = (element, className) => {
+  if (!element || !element.classList) {
+    return false
+  }
+
+  return element.classList.contains(className)
+}
+
 export const setStyle = (element, values, overwrite) => {
   if (!element) {
     return
@@ -146,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*/)
@@ -254,3 +281,34 @@ export const extendHistoryApi = () => {
   //   console.log("onlocationchange event occurred!")
   // })
 }
+
+// eslint-disable-next-line no-script-url
+export const actionHref = "javascript:;"
+
+export const getOffsetPosition = (element, referElement) => {
+  const position = { top: 0, left: 0 }
+  referElement = referElement || doc.body
+
+  while (element && element !== referElement) {
+    position.top += element.offsetTop
+    position.left += element.offsetLeft
+    element = element.offsetParent
+  }
+
+  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
+}

package/package.json

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